NotCurses Class Reference

#include <NotCurses.hh>

Inheritance diagram for NotCurses:

Collaboration diagram for NotCurses:

Public Member Functions
	NotCurses (FILE *fp=nullptr)
	NotCurses (const notcurses_options &nc_opts, FILE *fp=nullptr)
	NotCurses (const NotCurses &other)=delete
	NotCurses (NotCurses &&other)=delete
	~NotCurses ()
	operator notcurses * () noexcept
	operator notcurses const * () const noexcept
bool	stop ()
bool	can_sextant () const noexcept
bool	can_octant () const noexcept
bool	can_utf8 () const noexcept
bool	can_fade () const noexcept
bool	can_open_images () const noexcept
bool	can_open_videos () const noexcept
bool	can_change_color () const noexcept
bool	can_truecolor () const noexcept
int	cursor_enable (int y, int x) const NOEXCEPT_MAYBE
int	cursor_disable () const NOEXCEPT_MAYBE
void	get_stats (ncstats *stats) const noexcept
void	reset_stats (ncstats *stats) const
bool	use (const Palette *p) const
bool	use (const Palette &p) const NOEXCEPT_MAYBE
bool	render () const NOEXCEPT_MAYBE
void	get_term_dim (unsigned *rows, unsigned *cols) const noexcept
void	get_term_dim (unsigned &rows, unsigned &cols) const noexcept
bool	refresh (unsigned *rows, unsigned *cols) const NOEXCEPT_MAYBE
bool	refresh (unsigned &rows, unsigned &cols) const NOEXCEPT_MAYBE
unsigned	get_palette_size () const noexcept
bool	mouse_enable (unsigned eventmask) const NOEXCEPT_MAYBE
bool	mouse_disable () const NOEXCEPT_MAYBE
CellStyle	get_supported_styles () const noexcept
uint32_t	get (const timespec *ts, ncinput *ni=nullptr) const noexcept
uint32_t	get (bool blocking=false, ncinput *ni=nullptr) const noexcept
char *	get_at (int yoff, int xoff, uint16_t *attr, uint64_t *channels) const noexcept
int	get_inputready_fd () const noexcept
void	drop_planes () const noexcept
void	debug (FILE *debugfp) const noexcept
bool	align (int availcols, ncalign_e align, int cols) const NOEXCEPT_MAYBE
bool	linesigs_enable () const NOEXCEPT_MAYBE
bool	linesigs_disable () const NOEXCEPT_MAYBE
ncstats *	stats_alloc () const noexcept
ncblitter_e	get_media_defblitter (ncscale_e scale) noexcept
Plane *	get_stdplane () noexcept
Plane *	get_stdplane (unsigned *y, unsigned *x)
Plane *	get_stdplane (unsigned &y, unsigned &x) noexcept
Plane *	get_top () noexcept
Plane *	get_bottom () noexcept
Public Member Functions inherited from Root
notcurses *	get_notcurses () const
NotCurses *	get_notcurses_cpp () const

Static Public Member Functions
static NotCurses &	get_instance ()
static bool	is_notcurses_stopped (const NotCurses *ncinst=nullptr)
static const char *	ncmetric (uintmax_t val, uintmax_t decimal, char *buf, int omitdec, unsigned mult, int uprefix) noexcept
static const char *	ncqprefix (uintmax_t val, uintmax_t decimal, char *buf, int omitdec) noexcept
static const char *	nciprefix (uintmax_t val, uintmax_t decimal, char *buf, int omitdec) noexcept
static const char *	ncbprefix (uintmax_t val, uintmax_t decimal, char *buf, int omitdec) noexcept
static const char *	version () noexcept
static void	version_components (int *major, int *minor, int *patch, int *tweak) noexcept
static const char *	str_blitter (ncblitter_e blitter) noexcept
static const char *	str_scalemode (ncscale_e scalemode) noexcept
static bool	lex_margins (const char *op, notcurses_options *opts) NOEXCEPT_MAYBE
static bool	lex_blitter (const char *op, ncblitter_e *blitter) NOEXCEPT_MAYBE
static bool	lex_scalemode (const char *op, ncscale_e *scalemode) NOEXCEPT_MAYBE
static bool	ucs32_to_utf8 (const uint32_t *ucs32, unsigned ucs32count, unsigned char *resultbuf, size_t buflen) NOEXCEPT_MAYBE

Static Public Attributes
static notcurses_options	default_notcurses_options

Additional Inherited Members
Protected Member Functions inherited from Root
	Root (NotCurses *ncinst)
bool	is_notcurses_stopped () const noexcept
Static Protected Member Functions inherited from Root
template<typename TRet = bool, typename TValue = int>
static TRet	error_guard (TValue ret, TValue error_value)
template<typename TRet = bool, typename TValue = int>
static TRet	error_guard_cond (TValue ret, bool error_value)
Static Protected Attributes inherited from Root
static constexpr char	ncpp_invalid_state_message [] = "notcurses++ is in an invalid state (already stopped?)"

Detailed Description

Definition at line 21 of file NotCurses.hh.

Constructor & Destructor Documentation

NotCurses() [1/4]

NotCurses ( FILE *  fp = nullptr )

inlineexplicit

Definition at line 27 of file NotCurses.hh.

            : NotCurses (default_notcurses_options, fp)
        {}

NotCurses() [2/4]

NotCurses ( const notcurses_options &  nc_opts, FILE *  fp = nullptr  )

explicit

NotCurses() [3/4]

NotCurses ( const NotCurses &  other )

delete

NotCurses() [4/4]

NotCurses ( NotCurses &&  other )

delete

~NotCurses()

~NotCurses

(

)

Member Function Documentation

align()

bool align ( int  availcols, ncalign_e  align, int  cols  ) const

inline

Definition at line 281 of file NotCurses.hh.

        {
            return error_guard (notcurses_align (availcols, align, cols), -INT_MAX);
        }

can_change_color()

bool can_change_color ( ) const

inlinenoexcept

Definition at line 154 of file NotCurses.hh.

        {
            return notcurses_canchangecolor (nc);
        }

can_fade()

bool can_fade ( ) const

inlinenoexcept

Definition at line 139 of file NotCurses.hh.

        {
            return notcurses_canfade (nc);
        }

can_octant()

bool can_octant ( ) const

inlinenoexcept

Definition at line 129 of file NotCurses.hh.

        {
            return notcurses_canoctant (nc);
        }

can_open_images()

bool can_open_images ( ) const

inlinenoexcept

Definition at line 144 of file NotCurses.hh.

        {
            return notcurses_canopen_images (nc);
        }

Here is the call graph for this function:

can_open_videos()

bool can_open_videos ( ) const

inlinenoexcept

Definition at line 149 of file NotCurses.hh.

        {
            return notcurses_canopen_videos (nc);
        }

Here is the call graph for this function:

can_sextant()

bool can_sextant ( ) const

inlinenoexcept

Definition at line 124 of file NotCurses.hh.

        {
            return notcurses_cansextant (nc);
        }

can_truecolor()

bool can_truecolor ( ) const

inlinenoexcept

Definition at line 159 of file NotCurses.hh.

        {
            return notcurses_cantruecolor (nc);
        }

can_utf8()

bool can_utf8 ( ) const

inlinenoexcept

Definition at line 134 of file NotCurses.hh.

        {
            return notcurses_canutf8 (nc);
        }

cursor_disable()

int cursor_disable ( ) const

inline

Definition at line 169 of file NotCurses.hh.

        {
            return error_guard (notcurses_cursor_disable (nc), -1);
        }

Here is the call graph for this function:

cursor_enable()

int cursor_enable ( int  y, int  x  ) const

inline

Definition at line 164 of file NotCurses.hh.

        {
            return error_guard (notcurses_cursor_enable (nc, y, x), -1);
        }

Here is the call graph for this function:

debug()

void debug ( FILE *  debugfp ) const

inlinenoexcept

Definition at line 276 of file NotCurses.hh.

        {
            notcurses_debug (nc, debugfp);
        }

Here is the call graph for this function:

drop_planes()

void drop_planes ( ) const

inlinenoexcept

Definition at line 271 of file NotCurses.hh.

        {
            notcurses_drop_planes (nc);
        }

Here is the call graph for this function:

get() [1/2]

uint32_t get ( bool  blocking = false, ncinput *  ni = nullptr  ) const

inlinenoexcept

Definition at line 253 of file NotCurses.hh.

        {
            if (blocking)
                return notcurses_get_blocking (nc, ni);
 
            return notcurses_get_nblock (nc, ni);
        }

get() [2/2]

uint32_t get ( const timespec *  ts, ncinput *  ni = nullptr  ) const

inlinenoexcept

Definition at line 248 of file NotCurses.hh.

        {
            return notcurses_get (nc, ts, ni);
        }

Here is the call graph for this function:

get_at()

char * get_at ( int  yoff, int  xoff, uint16_t *  attr, uint64_t *  channels  ) const

inlinenoexcept

Definition at line 261 of file NotCurses.hh.

        {
            return notcurses_at_yx (nc, yoff, xoff, attr, channels);
        }

Here is the call graph for this function:

get_bottom()

Plane * get_bottom ( )

noexcept

get_inputready_fd()

int get_inputready_fd ( ) const

inlinenoexcept

Definition at line 266 of file NotCurses.hh.

        {
            return notcurses_inputready_fd (nc);
        }

Here is the call graph for this function:

get_instance()

static NotCurses & get_instance ( )

inlinestatic

Definition at line 49 of file NotCurses.hh.

        {
            if (_instance == nullptr)
                throw invalid_state_error ("NotCurses instance not found.");
            if (_instance->nc == nullptr)
                throw invalid_state_error (ncpp_invalid_state_message);
 
            return *_instance;
        }

get_media_defblitter()

ncblitter_e get_media_defblitter ( ncscale_e  scale )

inlinenoexcept

Definition at line 306 of file NotCurses.hh.

        {
            return ncvisual_media_defblitter (nc, scale);
        }

Here is the call graph for this function:

get_palette_size()

unsigned get_palette_size ( ) const

inlinenoexcept

Definition at line 228 of file NotCurses.hh.

        {
            return notcurses_palette_size (static_cast<const notcurses*> (nc));
        }

Here is the call graph for this function:

get_stats()

void get_stats ( ncstats *  stats ) const

inlinenoexcept

Definition at line 174 of file NotCurses.hh.

        {
            if (stats == nullptr)
                return;
 
            notcurses_stats (nc, stats);
        }

Here is the call graph for this function:

get_stdplane() [1/3]

Plane * get_stdplane ( )

inlinenoexcept

Definition at line 311 of file NotCurses.hh.

        {
            return new Plane (notcurses_stdplane (nc), true);
        }

Here is the call graph for this function:

get_stdplane() [2/3]

Plane * get_stdplane ( unsigned &  y, unsigned &  x  )

inlinenoexcept

Definition at line 326 of file NotCurses.hh.

        {
            return new Plane (notcurses_stddim_yx (nc, &y, &x));
        }

get_stdplane() [3/3]

Plane * get_stdplane ( unsigned *  y, unsigned *  x  )

inline

Definition at line 316 of file NotCurses.hh.

        {
            if (y == nullptr)
                throw invalid_argument ("'y' must be a valid pointer");
            if (x == nullptr)
                throw invalid_argument ("'x' must be a valid pointer");
 
            return get_stdplane (*y, *x);
        }

get_supported_styles()

CellStyle get_supported_styles ( ) const

inlinenoexcept

Definition at line 243 of file NotCurses.hh.

        {
            return static_cast<CellStyle>(notcurses_supported_styles (nc));
        }

Here is the call graph for this function:

get_term_dim() [1/2]

void get_term_dim ( unsigned &  rows, unsigned &  cols  ) const

inlinenoexcept

Definition at line 213 of file NotCurses.hh.

        {
            get_term_dim (&rows, &cols);
        }

get_term_dim() [2/2]

void get_term_dim ( unsigned *  rows, unsigned *  cols  ) const

inlinenoexcept

Definition at line 208 of file NotCurses.hh.

        {
            notcurses_term_dim_yx (nc, rows, cols);
        }

get_top()

Plane * get_top ( )

noexcept

is_notcurses_stopped()

static bool is_notcurses_stopped ( const NotCurses *  ncinst = nullptr )

inlinestatic

Definition at line 59 of file NotCurses.hh.

        {
            if (ncinst != nullptr)
                return ncinst->nc == nullptr;
 
            return *_instance == nullptr || _instance->nc == nullptr;
        }

lex_blitter()

static bool lex_blitter ( const char *  op, ncblitter_e *  blitter  )

inlinestatic

Definition at line 112 of file NotCurses.hh.

        {
            return error_guard (notcurses_lex_blitter (op, blitter), -1);
        }

Here is the call graph for this function:

lex_margins()

static bool lex_margins ( const char *  op, notcurses_options *  opts  )

inlinestatic

Definition at line 107 of file NotCurses.hh.

        {
            return error_guard (notcurses_lex_margins (op, opts), -1);
        }

Here is the call graph for this function:

lex_scalemode()

static bool lex_scalemode ( const char *  op, ncscale_e *  scalemode  )

inlinestatic

Definition at line 117 of file NotCurses.hh.

        {
            return error_guard (notcurses_lex_scalemode (op, scalemode), -1);
        }

Here is the call graph for this function:

linesigs_disable()

bool linesigs_disable ( ) const

inline

Definition at line 291 of file NotCurses.hh.

        {
            return error_guard (notcurses_linesigs_disable (nc), -1);
        }

Here is the call graph for this function:

linesigs_enable()

bool linesigs_enable ( ) const

inline

Definition at line 286 of file NotCurses.hh.

        {
            return error_guard (notcurses_linesigs_enable (nc), -1);
        }

Here is the call graph for this function:

mouse_disable()

bool mouse_disable ( ) const

inline

Definition at line 238 of file NotCurses.hh.

        {
            return error_guard (notcurses_mice_disable (nc), -1);
        }

mouse_enable()

bool mouse_enable ( unsigned  eventmask ) const

inline

Definition at line 233 of file NotCurses.hh.

        {
            return error_guard (notcurses_mice_enable (nc, eventmask), -1);
        }

Here is the call graph for this function:

ncbprefix()

static const char * ncbprefix ( uintmax_t  val, uintmax_t  decimal, char *  buf, int  omitdec  )

inlinestaticnoexcept

Definition at line 82 of file NotCurses.hh.

        {
            return ::ncbprefix (val, decimal, buf, omitdec);
        }

nciprefix()

static const char * nciprefix ( uintmax_t  val, uintmax_t  decimal, char *  buf, int  omitdec  )

inlinestaticnoexcept

Definition at line 77 of file NotCurses.hh.

        {
            return ::nciprefix (val, decimal, buf, omitdec);
        }

ncmetric()

static const char * ncmetric ( uintmax_t  val, uintmax_t  decimal, char *  buf, int  omitdec, unsigned  mult, int  uprefix  )

inlinestaticnoexcept

Definition at line 67 of file NotCurses.hh.

        {
            return ::ncnmetric (val, INT_MAX, decimal, buf, omitdec, mult, uprefix);
        }

ncqprefix()

static const char * ncqprefix ( uintmax_t  val, uintmax_t  decimal, char *  buf, int  omitdec  )

inlinestaticnoexcept

Definition at line 72 of file NotCurses.hh.

        {
            return ::ncqprefix (val, decimal, buf, omitdec);
        }

operator notcurses *()

operator notcurses * ( )

inlinenoexcept

Definition at line 39 of file NotCurses.hh.

        {
            return nc;
        }

operator notcurses const *()

operator notcurses const * ( ) const

inlinenoexcept

Definition at line 44 of file NotCurses.hh.

        {
            return nc;
        }

refresh() [1/2]

bool refresh ( unsigned &  rows, unsigned &  cols  ) const

inline

Definition at line 223 of file NotCurses.hh.

        {
            return refresh (&rows, &cols);
        }

refresh() [2/2]

bool refresh ( unsigned *  rows, unsigned *  cols  ) const

inline

Definition at line 218 of file NotCurses.hh.

        {
            return error_guard (notcurses_refresh (nc, rows, cols), -1);
        }

Here is the call graph for this function:

render()

bool render ( ) const

inline

Definition at line 203 of file NotCurses.hh.

        {
            return error_guard (notcurses_render (nc), -1);
        }

reset_stats()

void reset_stats ( ncstats *  stats ) const

inline

Definition at line 182 of file NotCurses.hh.

        {
            if (stats == nullptr)
                throw invalid_argument ("'stats' must be a valid pointer");
 
            notcurses_stats_reset (nc, stats);
        }

Here is the call graph for this function:

stats_alloc()

ncstats * stats_alloc ( ) const

inlinenoexcept

Definition at line 296 of file NotCurses.hh.

        {
            return notcurses_stats_alloc (nc);
        }

Here is the call graph for this function:

stop()

bool stop

(

)

str_blitter()

static const char * str_blitter ( ncblitter_e  blitter )

inlinestaticnoexcept

Definition at line 97 of file NotCurses.hh.

        {
            return notcurses_str_blitter (blitter);
        }

Here is the call graph for this function:

str_scalemode()

static const char * str_scalemode ( ncscale_e  scalemode )

inlinestaticnoexcept

Definition at line 102 of file NotCurses.hh.

        {
            return notcurses_str_scalemode (scalemode);
        }

Here is the call graph for this function:

ucs32_to_utf8()

static bool ucs32_to_utf8 ( const uint32_t *  ucs32, unsigned  ucs32count, unsigned char *  resultbuf, size_t  buflen  )

inlinestatic

Definition at line 301 of file NotCurses.hh.

        {
            return error_guard (notcurses_ucs32_to_utf8 (ucs32, ucs32count, resultbuf, buflen), -1);
        }

Here is the call graph for this function:

use() [1/2]

bool use ( const Palette &  p ) const

inline

Definition at line 198 of file NotCurses.hh.

        {
            return error_guard (ncpalette_use (nc, reinterpret_cast<const ncpalette*>(&p)), -1);
        }

Here is the call graph for this function:

use() [2/2]

bool use ( const Palette *  p ) const

inline

Definition at line 190 of file NotCurses.hh.

        {
            if (p == nullptr)
                throw invalid_argument ("'p' must be a valid pointer");
 
            return use (*p);
        }

version()

static const char * version ( )

inlinestaticnoexcept

Definition at line 87 of file NotCurses.hh.

        {
            return notcurses_version ();
        }

Here is the call graph for this function:

version_components()

static void version_components ( int *  major, int *  minor, int *  patch, int *  tweak  )

inlinestaticnoexcept

Definition at line 92 of file NotCurses.hh.

        {
            notcurses_version_components (major, minor, patch, tweak);
        }

Here is the call graph for this function:

Field Documentation

default_notcurses_options

notcurses_options default_notcurses_options

static

Definition at line 24 of file NotCurses.hh.

---

The documentation for this class was generated from the following file:

• /home/dank/src/dankamongmen/notcurses/include/ncpp/NotCurses.hh