direct.h File Reference

#include <notcurses/notcurses.h>

Include dependency graph for direct.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	API   __attribute__((visibility("default")))
#define	ALLOC   __attribute__((malloc)) __attribute__((warn_unused_result))
#define	NCDIRECT_OPTION_INHIBIT_SETLOCALE   0x0001ull
#define	NCDIRECT_OPTION_INHIBIT_CBREAK   0x0002ull
#define	NCDIRECT_OPTION_DRAIN_INPUT   0x0004ull
#define	NCDIRECT_OPTION_NO_QUIT_SIGHANDLERS   0x0008ull
#define	NCDIRECT_OPTION_VERBOSE   0x0010ull
#define	NCDIRECT_OPTION_VERY_VERBOSE   0x0020ull

Typedefs
typedef struct ncplane	ncdirectv
typedef struct ncvisual	ncdirectf

Functions
API ALLOC struct ncdirect *	ncdirect_init (const char *termtype, FILE *fp, uint64_t flags)
API ALLOC struct ncdirect *	ncdirect_core_init (const char *termtype, FILE *fp, uint64_t flags)
	__attribute__ ((nonnull(1))) API ALLOC char *ncdirect_readline(struct ncdirect *nc
API int	ncdirect_set_fg_rgb (struct ncdirect *nc, unsigned rgb) __attribute__((nonnull(1)))
API int	ncdirect_set_bg_rgb (struct ncdirect *nc, unsigned rgb) __attribute__((nonnull(1)))
API int	ncdirect_set_fg_palindex (struct ncdirect *nc, int pidx) __attribute__((nonnull(1)))
API int	ncdirect_set_bg_palindex (struct ncdirect *nc, int pidx) __attribute__((nonnull(1)))
API unsigned	ncdirect_palette_size (const struct ncdirect *nc) __attribute__((nonnull(1)))
API int	ncdirect_putstr (struct ncdirect *nc, uint64_t channels, const char *utf8) __attribute__((nonnull(1
API int API int	ncdirect_putegc (struct ncdirect *nc, uint64_t channels, const char *utf8, int *sbytes) __attribute__((nonnull(1
API int API int API int	ncdirect_printf_aligned (struct ncdirect *n, int y, ncalign_e align, const char *fmt,...) __attribute__((nonnull(1
API int API int API int	__attribute__ ((format(printf, 4, 5)))
API int	ncdirect_flush (const struct ncdirect *nc) __attribute__((nonnull(1)))
API int	ncdirect_set_fg_default (struct ncdirect *nc) __attribute__((nonnull(1)))
API int	ncdirect_set_bg_default (struct ncdirect *nc) __attribute__((nonnull(1)))
API unsigned	ncdirect_dim_x (struct ncdirect *nc) __attribute__((nonnull(1)))
API unsigned	ncdirect_dim_y (struct ncdirect *nc) __attribute__((nonnull(1)))
API uint16_t	ncdirect_supported_styles (const struct ncdirect *nc) __attribute__((nonnull(1)))
API int	ncdirect_set_styles (struct ncdirect *n, unsigned stylebits) __attribute__((nonnull(1)))
API int	ncdirect_on_styles (struct ncdirect *n, unsigned stylebits) __attribute__((nonnull(1)))
API int	ncdirect_off_styles (struct ncdirect *n, unsigned stylebits) __attribute__((nonnull(1)))
API uint16_t	ncdirect_styles (const struct ncdirect *n) __attribute__((nonnull(1)))
API int	ncdirect_cursor_move_yx (struct ncdirect *n, int y, int x) __attribute__((nonnull(1)))
API int	ncdirect_cursor_enable (struct ncdirect *nc) __attribute__((nonnull(1)))
API int	ncdirect_cursor_disable (struct ncdirect *nc) __attribute__((nonnull(1)))
API int	ncdirect_cursor_up (struct ncdirect *nc, int num) __attribute__((nonnull(1)))
API int	ncdirect_cursor_left (struct ncdirect *nc, int num) __attribute__((nonnull(1)))
API int	ncdirect_cursor_right (struct ncdirect *nc, int num) __attribute__((nonnull(1)))
API int	ncdirect_cursor_down (struct ncdirect *nc, int num) __attribute__((nonnull(1)))
API int	ncdirect_cursor_yx (struct ncdirect *n, unsigned *y, unsigned *x) __attribute__((nonnull(1)))
API int	ncdirect_cursor_push (struct ncdirect *n) __attribute__((nonnull(1)))
API int	ncdirect_cursor_pop (struct ncdirect *n) __attribute__((nonnull(1)))
API int	ncdirect_clear (struct ncdirect *nc) __attribute__((nonnull(1)))
API const nccapabilities *	ncdirect_capabilities (const struct ncdirect *n) __attribute__((nonnull(1)))
API int	ncdirect_hline_interp (struct ncdirect *n, const char *egc, unsigned len, uint64_t h1, uint64_t h2) __attribute__((nonnull(1
API int API int	ncdirect_vline_interp (struct ncdirect *n, const char *egc, unsigned len, uint64_t h1, uint64_t h2) __attribute__((nonnull(1
API int API int API int	ncdirect_box (struct ncdirect *n, uint64_t ul, uint64_t ur, uint64_t ll, uint64_t lr, const wchar_t *wchars, unsigned ylen, unsigned xlen, unsigned ctlword) __attribute__((nonnull(1
API int	ncdirect_rounded_box (struct ncdirect *n, uint64_t ul, uint64_t ur, uint64_t ll, uint64_t lr, unsigned ylen, unsigned xlen, unsigned ctlword) __attribute__((nonnull(1)))
API int	ncdirect_double_box (struct ncdirect *n, uint64_t ul, uint64_t ur, uint64_t ll, uint64_t lr, unsigned ylen, unsigned xlen, unsigned ctlword) __attribute__((nonnull(1)))
API uint32_t	ncdirect_get (struct ncdirect *n, const struct timespec *absdl, ncinput *ni) __attribute__((nonnull(1)))
API int	ncdirect_inputready_fd (struct ncdirect *n) __attribute__((nonnull(1)))
API int	ncdirect_stop (struct ncdirect *nc)
API int	ncdirect_render_image (struct ncdirect *n, const char *filename, ncalign_e align, ncblitter_e blitter, ncscale_e scale) __attribute__((nonnull(1
API int API ALLOC ncdirectv *	ncdirect_render_frame (struct ncdirect *n, const char *filename, ncblitter_e blitter, ncscale_e scale, int maxy, int maxx) __attribute__((nonnull(1
API int API ALLOC ncdirectv API int	ncdirect_raster_frame (struct ncdirect *n, ncdirectv *ncdv, ncalign_e align) __attribute__((nonnull(1
API int API ALLOC ncdirectv API int API ALLOC ncdirectf *	ncdirectf_from_file (struct ncdirect *n, const char *filename) __attribute__((nonnull(1
API int API ALLOC ncdirectv API int API ALLOC ncdirectf API void	ncdirectf_free (ncdirectf *frame)
API ALLOC ncdirectv *	ncdirectf_render (struct ncdirect *n, ncdirectf *frame, const struct ncvisual_options *vopts) __attribute__((nonnull(1
API ALLOC ncdirectv API int	ncdirectf_geom (struct ncdirect *n, ncdirectf *frame, const struct ncvisual_options *vopts, ncvgeom *geom) __attribute__((nonnull(1
API ALLOC ncdirectv API int API int	ncdirect_stream (struct ncdirect *n, const char *filename, ncstreamcb streamer, struct ncvisual_options *vopts, void *curry) __attribute__((nonnull(1
API ALLOC ncdirectv API int API int ALLOC API char *	ncdirect_detected_terminal (const struct ncdirect *n) __attribute__((nonnull(1)))
API bool	ncdirect_canutf8 (const struct ncdirect *n) __attribute__((nonnull(1)))
API int	ncdirect_check_pixel_support (const struct ncdirect *n) __attribute__((nonnull(1)))
API bool	ncdirect_canget_cursor (const struct ncdirect *nc) __attribute__((nonnull(1)))

Variables
const char *	prompt
API int API int API int uint64_t	ul
API int API int API int uint64_t uint64_t	ur
API int API int API int uint64_t uint64_t uint64_t	ll
API int API int API int uint64_t uint64_t uint64_t uint64_t	lr
API int API int API int uint64_t uint64_t uint64_t uint64_t unsigned	ylen
API int API int API int uint64_t uint64_t uint64_t uint64_t unsigned unsigned	xlen
API int API int API int uint64_t uint64_t uint64_t uint64_t unsigned unsigned unsigned	ctlword

Macro Definition Documentation

ALLOC

#define ALLOC   __attribute__((malloc)) __attribute__((warn_unused_result))

Definition at line 19 of file direct.h.

API

#define API   __attribute__((visibility("default")))

Definition at line 15 of file direct.h.

NCDIRECT_OPTION_DRAIN_INPUT

#define NCDIRECT_OPTION_DRAIN_INPUT   0x0004ull

Definition at line 38 of file direct.h.

NCDIRECT_OPTION_INHIBIT_CBREAK

#define NCDIRECT_OPTION_INHIBIT_CBREAK   0x0002ull

Definition at line 33 of file direct.h.

NCDIRECT_OPTION_INHIBIT_SETLOCALE

#define NCDIRECT_OPTION_INHIBIT_SETLOCALE   0x0001ull

Definition at line 29 of file direct.h.

NCDIRECT_OPTION_NO_QUIT_SIGHANDLERS

#define NCDIRECT_OPTION_NO_QUIT_SIGHANDLERS   0x0008ull

Definition at line 43 of file direct.h.

NCDIRECT_OPTION_VERBOSE

#define NCDIRECT_OPTION_VERBOSE   0x0010ull

Definition at line 46 of file direct.h.

NCDIRECT_OPTION_VERY_VERBOSE

#define NCDIRECT_OPTION_VERY_VERBOSE   0x0020ull

Definition at line 50 of file direct.h.

Typedef Documentation

ncdirectf

typedef struct ncvisual ncdirectf

Definition at line 282 of file direct.h.

ncdirectv

typedef struct ncplane ncdirectv

Definition at line 281 of file direct.h.

Function Documentation

__attribute__() [1/2]

static int __attribute__

(

(format(printf, 4, 5))

)

__attribute__() [2/2]

__attribute__

(

(nonnull(1))

)

ncdirect_box()

API int API int API int ncdirect_box	(	struct ncdirect *	n,
		uint64_t	ul,
		uint64_t	ur,
		uint64_t	ll,
		uint64_t	lr,
		const wchar_t *	wchars,
		unsigned	ylen,
		unsigned	xlen,
		unsigned	ctlword
	)

ncdirect_canget_cursor()

API bool ncdirect_canget_cursor

(

const struct ncdirect *

nc

)

ncdirect_canutf8()

API bool ncdirect_canutf8

(

const struct ncdirect *

n

)

ncdirect_capabilities()

API const nccapabilities * ncdirect_capabilities

(

const struct ncdirect *

n

)

ncdirect_check_pixel_support()

API int ncdirect_check_pixel_support

(

const struct ncdirect *

n

)

ncdirect_clear()

API int ncdirect_clear

(

struct ncdirect *

nc

)

Definition at line 140 of file direct.c.

                                {
  const char* clearscr = get_escape(&nc->tcache, ESCAPE_CLEAR);
  if(clearscr){
    return term_emit(clearscr, nc->ttyfp, true);
  }
  return -1;
}

Here is the caller graph for this function:

ncdirect_core_init()

API ALLOC struct ncdirect * ncdirect_core_init	(	const char *	termtype,
		FILE *	fp,
		uint64_t	flags
	)

Definition at line 871 of file direct.c.

                                                                               {
  if(outfp == NULL){
    outfp = stdout;
  }
  if(flags > (NCDIRECT_OPTION_DRAIN_INPUT << 1)){ // allow them through with warning
    logwarn("Passed unsupported flags 0x%016" PRIx64 "\n", flags);
  }
  if(termtype){
    if(putenv_term(termtype)){
      return NULL;
    }
  }
  ncdirect* ret = malloc(sizeof(ncdirect));
  if(ret == NULL){
    return ret;
  }
  memset(ret, 0, sizeof(*ret));
  if(pthread_mutex_init(&ret->stats.lock, NULL)){
    free(ret);
    return NULL;
  }
  ret->flags = flags;
  ret->ttyfp = outfp;
  if(!(flags & NCDIRECT_OPTION_INHIBIT_SETLOCALE)){
    init_lang();
  }
  const char* encoding = nl_langinfo(CODESET);
  bool utf8 = false;
  if(encoding && encoding_is_utf8(encoding)){
    utf8 = true;
    ncmetric_use_utf8();
  }
  if(setup_signals(ret, (flags & NCDIRECT_OPTION_NO_QUIT_SIGHANDLERS),
                   true, ncdirect_stop_minimal)){
    pthread_mutex_destroy(&ret->stats.lock);
    free(ret);
    return NULL;
  }
  // don't set the loglevel until we've locked in signal handling, lest we
  // change the loglevel out from under a running instance.
  if(flags & NCDIRECT_OPTION_VERY_VERBOSE){
    loglevel = NCLOGLEVEL_TRACE;
  }else if(flags & NCDIRECT_OPTION_VERBOSE){
    loglevel = NCLOGLEVEL_WARNING;
  }else{
    loglevel = NCLOGLEVEL_SILENT;
  }
  set_loglevel_from_env(&loglevel);
  int cursor_y = -1;
  int cursor_x = -1;
  if(interrogate_terminfo(&ret->tcache, ret->ttyfp, utf8, 1,
                          flags & NCDIRECT_OPTION_INHIBIT_CBREAK,
                          0, &cursor_y, &cursor_x, &ret->stats, 0, 0, 0, 0,
                          flags & NCDIRECT_OPTION_DRAIN_INPUT)){
    goto err;
  }
  if(cursor_y >= 0){
    // the u7 led the queries so that we would get a cursor position
    // unaffected by any query spill (unconsumed control sequences). move
    // us back to that location, in case there was any such spillage.
    if(ncdirect_cursor_move_yx(ret, cursor_y, cursor_x)){
      free_terminfo_cache(&ret->tcache);
      goto err;
    }
  }
  if(ncvisual_init(loglevel)){
    free_terminfo_cache(&ret->tcache);
    goto err;
  }
  unsigned cgeo, pgeo; // both are don't-cares
  update_term_dimensions(NULL, NULL, &ret->tcache, 0, &cgeo, &pgeo);
  ncdirect_set_styles(ret, 0);
  return ret;
 
err:{
    void* altstack;
    if(ret->tcache.ttyfd >= 0){
      (void)tcsetattr(ret->tcache.ttyfd, TCSANOW, ret->tcache.tpreserved);
    }
    drop_signals(ret, &altstack);
    pthread_mutex_destroy(&ret->stats.lock);
    free(ret);
  }
  return NULL;
}

Here is the call graph for this function:

ncdirect_cursor_disable()

API int ncdirect_cursor_disable

(

struct ncdirect *

nc

)

Definition at line 182 of file direct.c.

                                         {
  const char* cinvis = get_escape(&nc->tcache, ESCAPE_CIVIS);
  if(cinvis){
    return term_emit(cinvis, nc->ttyfp, true);
  }
  return -1;
}

Here is the caller graph for this function:

ncdirect_cursor_down()

API int ncdirect_cursor_down	(	struct ncdirect *	nc,
		int	num
	)

Definition at line 117 of file direct.c.

                                               {
  if(num < 0){
    logerror("requested negative move %d\n", num);
    return -1;
  }
  if(num == 0){
    return 0;
  }
  int ret = 0;
  while(num--){
    if(ncfputc('\v', nc->ttyfp) == EOF){
      ret = -1;
      break;
    }
  }
  return ret;
}

Here is the caller graph for this function:

ncdirect_cursor_enable()

API int ncdirect_cursor_enable

(

struct ncdirect *

nc

)

Definition at line 174 of file direct.c.

                                        {
  const char* cnorm = get_escape(&nc->tcache, ESCAPE_CNORM);
  if(cnorm){
    return term_emit(cnorm, nc->ttyfp, true);
  }
  return -1;
}

Here is the caller graph for this function:

ncdirect_cursor_left()

API int ncdirect_cursor_left	(	struct ncdirect *	nc,
		int	num
	)

Definition at line 83 of file direct.c.

                                               {
  if(num < 0){
    logerror("requested negative move %d\n", num);
    return -1;
  }
  if(num == 0){
    return 0;
  }
  const char* cub = get_escape(&nc->tcache, ESCAPE_CUB);
  if(cub){
    return term_emit(tiparm(cub, num), nc->ttyfp, false);
  }
  return -1;
}

Here is the caller graph for this function:

ncdirect_cursor_move_yx()

API int ncdirect_cursor_move_yx	(	struct ncdirect *	n,
		int	y,
		int	x
	)

Definition at line 216 of file direct.c.

                                                      {
  const char* hpa = get_escape(&n->tcache, ESCAPE_HPA);
  const char* vpa = get_escape(&n->tcache, ESCAPE_VPA);
  const char* u7 = get_escape(&n->tcache, ESCAPE_U7);
  if(y == -1){ // keep row the same, horizontal move only
    if(hpa){
      return term_emit(tiparm(hpa, x), n->ttyfp, false);
    }else if(n->tcache.ttyfd >= 0 && u7){
      unsigned yprime;
      if(cursor_yx_get(n, u7, &yprime, NULL)){
        return -1;
      }
      y = yprime;
    }else{
      y = 0;
    }
  }else if(x == -1){ // keep column the same, vertical move only
    if(!vpa){
      return term_emit(tiparm(vpa, y), n->ttyfp, false);
    }else if(n->tcache.ttyfd >= 0 && u7){
      unsigned xprime;
      if(cursor_yx_get(n, u7, NULL, &xprime)){
        return -1;
      }
      x = xprime;
    }else{
      x = 0;
    }
  }
  const char* cup = get_escape(&n->tcache, ESCAPE_CUP);
  if(cup){
    return term_emit(tiparm(cup, y, x), n->ttyfp, false);
  }else if(vpa && hpa){
    if(term_emit(tiparm(hpa, x), n->ttyfp, false) == 0 &&
       term_emit(tiparm(vpa, y), n->ttyfp, false) == 0){
      return 0;
    }
  }
  return -1; // we will not be moving the cursor today
}

Here is the caller graph for this function:

ncdirect_cursor_pop()

API int ncdirect_cursor_pop

(

struct ncdirect *

n

)

Definition at line 403 of file direct.c.

                                    {
  const char* rc = get_escape(&n->tcache, ESCAPE_RC);
  if(rc){
    return term_emit(rc, n->ttyfp, false);
  }
  return -1;
}

ncdirect_cursor_push()

API int ncdirect_cursor_push

(

struct ncdirect *

n

)

Definition at line 395 of file direct.c.

                                     {
  const char* sc = get_escape(&n->tcache, ESCAPE_SC);
  if(sc){
    return term_emit(sc, n->ttyfp, false);
  }
  return -1;
}

ncdirect_cursor_right()

API int ncdirect_cursor_right	(	struct ncdirect *	nc,
		int	num
	)

Definition at line 98 of file direct.c.

                                                {
  if(num < 0){
    logerror("requested negative move %d\n", num);
    return -1;
  }
  if(num == 0){
    return 0;
  }
  const char* cuf = get_escape(&nc->tcache, ESCAPE_CUF);
  if(cuf){
    return term_emit(tiparm(cuf, num), nc->ttyfp, false);
  }
  return -1; // FIXME fall back to cuf1?
}

Here is the caller graph for this function:

ncdirect_cursor_up()

API int ncdirect_cursor_up	(	struct ncdirect *	nc,
		int	num
	)

Definition at line 68 of file direct.c.

                                             {
  if(num < 0){
    logerror("requested negative move %d\n", num);
    return -1;
  }
  if(num == 0){
    return 0;
  }
  const char* cuu = get_escape(&nc->tcache, ESCAPE_CUU);
  if(cuu){
    return term_emit(tiparm(cuu, num), nc->ttyfp, false);
  }
  return -1;
}

Here is the caller graph for this function:

ncdirect_cursor_yx()

API int ncdirect_cursor_yx	(	struct ncdirect *	n,
		unsigned *	y,
		unsigned *	x
	)

Definition at line 375 of file direct.c.

                                                             {
  // this is only meaningful for real terminals
  if(n->tcache.ttyfd < 0){
    return -1;
  }
  const char* u7 = get_escape(&n->tcache, ESCAPE_U7);
  if(u7 == NULL){
    fprintf(stderr, "Terminal doesn't support cursor reporting\n");
    return -1;
  }
  unsigned yval, xval;
  if(!y){
    y = &yval;
  }
  if(!x){
    x = &xval;
  }
  return cursor_yx_get(n, u7, y, x);
}

Here is the caller graph for this function:

ncdirect_detected_terminal()

API ALLOC ncdirectv API int API int ALLOC API char * ncdirect_detected_terminal

(

const struct ncdirect *

n

)

ncdirect_dim_x()

API unsigned ncdirect_dim_x

(

struct ncdirect *

nc

)

Definition at line 148 of file direct.c.

                                     {
  unsigned x;
  if(nc->tcache.ttyfd >= 0){
    unsigned cgeo, pgeo; // don't care about either
    if(update_term_dimensions(NULL, &x, &nc->tcache, 0, &cgeo, &pgeo) == 0){
      return x;
    }
  }else{
    return 80; // lol
  }
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ncdirect_dim_y()

API unsigned ncdirect_dim_y

(

struct ncdirect *

nc

)

Definition at line 161 of file direct.c.

                                     {
  unsigned y;
  if(nc->tcache.ttyfd >= 0){
    unsigned cgeo, pgeo; // don't care about either
    if(update_term_dimensions(&y, NULL, &nc->tcache, 0, &cgeo, &pgeo) == 0){
      return y;
    }
  }else{
    return 24; // lol
  }
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ncdirect_double_box()

API int ncdirect_double_box	(	struct ncdirect *	n,
		uint64_t	ul,
		uint64_t	ur,
		uint64_t	ll,
		uint64_t	lr,
		unsigned	ylen,
		unsigned	xlen,
		unsigned	ctlword
	)

Definition at line 1515 of file direct.c.

                                                                       {
  return ncdirect_box(n, ul, ur, ll, lr, NCBOXDOUBLEW, ylen, xlen, ctlword);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ncdirect_flush()

API int ncdirect_flush

(

const struct ncdirect *

nc

)

Here is the call graph for this function:

ncdirect_get()

API uint32_t ncdirect_get	(	struct ncdirect *	n,
		const struct timespec *	absdl,
		ncinput *	ni
	)

Definition at line 2798 of file in.c.

                                                                             {
  if(n->eof){
    logerror("already got EOF");
    return -1;
  }
  uint32_t r = internal_get(n->tcache.ictx, absdl, ni);
  if(r == NCKEY_EOF){
    n->eof = 1;
  }
  return r;
}

Here is the caller graph for this function:

ncdirect_hline_interp()

API int ncdirect_hline_interp	(	struct ncdirect *	n,
		const char *	egc,
		unsigned	len,
		uint64_t	h1,
		uint64_t	h2
	)

ncdirect_init()

API ALLOC struct ncdirect * ncdirect_init	(	const char *	termtype,
		FILE *	fp,
		uint64_t	flags
	)

Here is the caller graph for this function:

ncdirect_inputready_fd()

API int ncdirect_inputready_fd

(

struct ncdirect *

n

)

Definition at line 3100 of file notcurses.c.

                                       {
  return inputready_fd(n->tcache.ictx);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ncdirect_off_styles()

API int ncdirect_off_styles	(	struct ncdirect *	n,
		unsigned	stylebits
	)

Definition at line 1189 of file direct.c.

                                                        {
  uint32_t stylemask = n->stylemask & ~stylebits;
  fbuf f = {0};
  if(fbuf_init_small(&f)){
    return -1;
  }
  if(ncdirect_style_emit(n, stylemask, &f)){
    fbuf_free(&f);
    return -1;
  }
  if(fbuf_finalize(&f, n->ttyfp)){
    return -1;
  }
  return 0;
}

Here is the caller graph for this function:

ncdirect_on_styles()

API int ncdirect_on_styles	(	struct ncdirect *	n,
		unsigned	stylebits
	)

Definition at line 1165 of file direct.c.

                                                       {
  if((stylebits & n->tcache.supported_styles) < stylebits){ // unsupported styles
    return -1;
  }
  uint32_t stylemask = n->stylemask | stylebits;
  fbuf f = {0};
  if(fbuf_init_small(&f)){
    return -1;
  }
  if(ncdirect_style_emit(n, stylemask, &f)){
    fbuf_free(&f);
    return -1;
  }
  if(fbuf_finalize(&f, n->ttyfp)){
    return -1;
  }
  return 0;
}

Here is the caller graph for this function:

ncdirect_palette_size()

API unsigned ncdirect_palette_size

(

const struct ncdirect *

nc

)

ncdirect_printf_aligned()

API int API int API int ncdirect_printf_aligned	(	struct ncdirect *	n,
		int	y,
		ncalign_e	align,
		const char *	fmt,
			...
	)

ncdirect_putegc()

API int API int ncdirect_putegc	(	struct ncdirect *	nc,
		uint64_t	channels,
		const char *	utf8,
		int *	sbytes
	)

ncdirect_putstr()

API int ncdirect_putstr	(	struct ncdirect *	nc,
		uint64_t	channels,
		const char *	utf8
	)

ncdirect_raster_frame()

API int API ALLOC ncdirectv API int ncdirect_raster_frame	(	struct ncdirect *	n,
		ncdirectv *	ncdv,
		ncalign_e	align
	)

ncdirect_render_frame()

API int API ALLOC ncdirectv * ncdirect_render_frame	(	struct ncdirect *	n,
		const char *	filename,
		ncblitter_e	blitter,
		ncscale_e	scale,
		int	maxy,
		int	maxx
	)

ncdirect_render_image()

API int ncdirect_render_image	(	struct ncdirect *	n,
		const char *	filename,
		ncalign_e	align,
		ncblitter_e	blitter,
		ncscale_e	scale
	)

ncdirect_rounded_box()

API int ncdirect_rounded_box	(	struct ncdirect *	n,
		uint64_t	ul,
		uint64_t	ur,
		uint64_t	ll,
		uint64_t	lr,
		unsigned	ylen,
		unsigned	xlen,
		unsigned	ctlword
	)

Definition at line 1509 of file direct.c.

                                                                        {
  return ncdirect_box(n, ul, ur, ll, lr, NCBOXROUNDW, ylen, xlen, ctlword);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ncdirect_set_bg_default()

API int ncdirect_set_bg_default

(

struct ncdirect *

nc

)

Definition at line 1252 of file direct.c.

                                         {
  if(ncdirect_bg_default_p(nc)){
    return 0;
  }
  const char* esc;
  if((esc = get_escape(&nc->tcache, ESCAPE_BGOP)) != NULL){
    if(term_emit(esc, nc->ttyfp, false)){
      return -1;
    }
  }else if((esc = get_escape(&nc->tcache, ESCAPE_OP)) != NULL){
    if(term_emit(esc, nc->ttyfp, false)){
      return -1;
    }
    if(!ncdirect_fg_default_p(nc)){
      if(ncdirect_set_fg_rgb(nc, ncchannels_fg_rgb(nc->channels))){
        return -1;
      }
    }
  }
  ncchannels_set_bg_default(&nc->channels);
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ncdirect_set_bg_palindex()

API int ncdirect_set_bg_palindex	(	struct ncdirect *	nc,
		int	pidx
	)

Definition at line 792 of file direct.c.

                                                    {
  const char* setab = get_escape(&nc->tcache, ESCAPE_SETAB);
  if(!setab){
    return -1;
  }
  if(ncchannels_set_bg_palindex(&nc->channels, pidx) < 0){
    return -1;
  }
  return term_emit(tiparm(setab, pidx), nc->ttyfp, false);
}

Here is the caller graph for this function:

ncdirect_set_bg_rgb()

API int ncdirect_set_bg_rgb	(	struct ncdirect *	nc,
		unsigned	rgb
	)

Definition at line 1667 of file render.c.

                                                   {
  fbuf f = {0};
  if(fbuf_init_small(&f)){
    return -1;
  }
  if(ncdirect_set_bg_rgb_f(nc, rgb, &f)){
    fbuf_free(&f);
    return -1;
  }
  if(fbuf_finalize(&f, nc->ttyfp) < 0){
    return -1;
  }
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ncdirect_set_fg_default()

API int ncdirect_set_fg_default

(

struct ncdirect *

nc

)

Definition at line 1229 of file direct.c.

                                         {
  if(ncdirect_fg_default_p(nc)){
    return 0;
  }
  const char* esc;
  if((esc = get_escape(&nc->tcache, ESCAPE_FGOP)) != NULL){
    if(term_emit(esc, nc->ttyfp, false)){
      return -1;
    }
  }else if((esc = get_escape(&nc->tcache, ESCAPE_OP)) != NULL){
    if(term_emit(esc, nc->ttyfp, false)){
      return -1;
    }
    if(!ncdirect_bg_default_p(nc)){
      if(ncdirect_set_bg_rgb(nc, ncchannels_bg_rgb(nc->channels))){
        return -1;
      }
    }
  }
  ncchannels_set_fg_default(&nc->channels);
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ncdirect_set_fg_palindex()

API int ncdirect_set_fg_palindex	(	struct ncdirect *	nc,
		int	pidx
	)

Definition at line 781 of file direct.c.

                                                    {
  const char* setaf = get_escape(&nc->tcache, ESCAPE_SETAF);
  if(!setaf){
    return -1;
  }
  if(ncchannels_set_fg_palindex(&nc->channels, pidx) < 0){
    return -1;
  }
  return term_emit(tiparm(setaf, pidx), nc->ttyfp, false);
}

Here is the caller graph for this function:

ncdirect_set_fg_rgb()

API int ncdirect_set_fg_rgb	(	struct ncdirect *	nc,
		unsigned	rgb
	)

Definition at line 1697 of file render.c.

                                                   {
  fbuf f = {0};
  if(fbuf_init_small(&f)){
    return -1;
  }
  if(ncdirect_set_fg_rgb_f(nc, rgb, &f)){
    fbuf_free(&f);
    return -1;
  }
  if(fbuf_finalize(&f, nc->ttyfp) < 0){
    return -1;
  }
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ncdirect_set_styles()

API int ncdirect_set_styles	(	struct ncdirect *	n,
		unsigned	stylebits
	)

Definition at line 1206 of file direct.c.

                                                        {
  if((stylebits & n->tcache.supported_styles) < stylebits){ // unsupported styles
    return -1;
  }
  uint32_t stylemask = stylebits;
  fbuf f = {0};
  if(fbuf_init_small(&f)){
    return -1;
  }
  if(ncdirect_style_emit(n, stylemask, &f)){
    fbuf_free(&f);
    return -1;
  }
  if(fbuf_finalize(&f, n->ttyfp)){
    return -1;
  }
  return 0;
}

Here is the caller graph for this function:

ncdirect_stop()

API int ncdirect_stop

(

struct ncdirect *

nc

)

Definition at line 957 of file direct.c.

                               {
  int ret = 0;
  if(nc){
    void* altstack;
    ret |= ncdirect_stop_minimal(nc, &altstack, 0);
    free_terminfo_cache(&nc->tcache);
    if(nc->tcache.ttyfd >= 0){
      ret |= close(nc->tcache.ttyfd);
    }
    pthread_mutex_destroy(&nc->stats.lock);
    free(nc);
    free(altstack);
  }
  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ncdirect_stream()

API ALLOC ncdirectv API int API int ncdirect_stream	(	struct ncdirect *	n,
		const char *	filename,
		ncstreamcb	streamer,
		struct ncvisual_options *	vopts,
		void *	curry
	)

ncdirect_styles()

API uint16_t ncdirect_styles

(

const struct ncdirect *

n

)

ncdirect_supported_styles()

API uint16_t ncdirect_supported_styles

(

const struct ncdirect *

nc

)

ncdirect_vline_interp()

API int API int ncdirect_vline_interp	(	struct ncdirect *	n,
		const char *	egc,
		unsigned	len,
		uint64_t	h1,
		uint64_t	h2
	)

ncdirectf_free()

API int API ALLOC ncdirectv API int API ALLOC ncdirectf API void ncdirectf_free

(

ncdirectf *

frame

)

Definition at line 1600 of file direct.c.

                                     {
  ncvisual_destroy(frame);
}

Here is the call graph for this function:

ncdirectf_from_file()

API int API ALLOC ncdirectv API int API ALLOC ncdirectf * ncdirectf_from_file	(	struct ncdirect *	n,
		const char *	filename
	)

ncdirectf_geom()

API ALLOC ncdirectv API int ncdirectf_geom	(	struct ncdirect *	n,
		ncdirectf *	frame,
		const struct ncvisual_options *	vopts,
		ncvgeom *	geom
	)

ncdirectf_render()

API ALLOC ncdirectv * ncdirectf_render	(	struct ncdirect *	n,
		ncdirectf *	frame,
		const struct ncvisual_options *	vopts
	)

Variable Documentation

ctlword

uint64_t uint64_t uint64_t uint64_t unsigned unsigned unsigned ctlword

Initial value:

{
  return ncdirect_box(n, ul, ur, ll, lr, NCBOXLIGHTW, ylen, xlen, ctlword)

Definition at line 217 of file direct.h.

ll

uint64_t uint64_t uint64_t ll

Definition at line 216 of file direct.h.

lr

uint64_t uint64_t uint64_t uint64_t lr

Definition at line 216 of file direct.h.

prompt

const char* prompt

Definition at line 68 of file direct.h.

ul

uint64_t ul

Definition at line 215 of file direct.h.

ur

uint64_t uint64_t ur

Definition at line 215 of file direct.h.

xlen

uint64_t uint64_t uint64_t uint64_t unsigned unsigned xlen

Definition at line 217 of file direct.h.

ylen

uint64_t uint64_t uint64_t uint64_t unsigned ylen

Definition at line 217 of file direct.h.