termdesc.h File Reference

#include "version.h"
#include "builddef.h"
#include <stdint.h>
#include <pthread.h>
#include <stdbool.h>
#include <notcurses/notcurses.h>
#include "sprite.h"
#include "blit.h"
#include "fbuf.h"
#include "in.h"

Include dependency graph for termdesc.h:

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

Go to the source code of this file.

Data Structures
struct	cursorreport
struct	tinfo

Macros
#define	KKEYBOARD_POP   "\x1b[<u"
#define	XTMODKEYSUNDO   "\x1b[>2m\x1b[>4m"

Typedefs
typedef struct cursorreport	cursorreport
typedef struct tinfo	tinfo

Enumerations
enum	escape_e {   ESCAPE_CUP , ESCAPE_HPA , ESCAPE_VPA , ESCAPE_SETAF ,   ESCAPE_SETAB , ESCAPE_OP , ESCAPE_FGOP , ESCAPE_BGOP ,   ESCAPE_SGR0 , ESCAPE_CIVIS , ESCAPE_CNORM , ESCAPE_OC ,   ESCAPE_SITM , ESCAPE_RITM , ESCAPE_CUU , ESCAPE_CUB ,   ESCAPE_CUF , ESCAPE_BOLD , ESCAPE_NOBOLD , ESCAPE_CUD ,   ESCAPE_SMKX , ESCAPE_RMKX , ESCAPE_EL , ESCAPE_SMCUP ,   ESCAPE_RMCUP , ESCAPE_SMXX , ESCAPE_SMUL , ESCAPE_RMUL ,   ESCAPE_SMULX , ESCAPE_SMULNOX , ESCAPE_RMXX , ESCAPE_IND ,   ESCAPE_INDN , ESCAPE_SC , ESCAPE_RC , ESCAPE_CLEAR ,   ESCAPE_INITC , ESCAPE_U7 , ESCAPE_BSUM , ESCAPE_ESUM ,   ESCAPE_SAVECOLORS , ESCAPE_RESTORECOLORS , ESCAPE_DECERA , ESCAPE_MAX }

Functions
	if (idx)
int	interrogate_terminfo (tinfo *ti, FILE *out, unsigned utf8, unsigned noaltscreen, unsigned nocbreak, unsigned nonewfonts, int *cursor_y, int *cursor_x, struct ncsharedstats *stats, int lmargin, int tmargin, int rmargin, int bmargin, unsigned draininput) __attribute__((nonnull(1
int void	free_terminfo_cache (tinfo *ti)
char *	termdesc_longterm (const tinfo *ti)
int	locate_cursor (tinfo *ti, unsigned *cursor_y, unsigned *cursor_x)
int	grow_esc_table (tinfo *ti, const char *tstr, escape_e esc, size_t *tlen, size_t *tused)
int	enter_alternate_screen (int ttyfd, FILE *ttyfp, tinfo *ti, unsigned drain)
int	leave_alternate_screen (int ttyfd, FILE *ttyfp, tinfo *ti, unsigned drain)
int	cbreak_mode (tinfo *ti)
int	tiocgwinsz (int fd, struct winsize *ws)

Variables
static escape_e	e
return	NULL

Macro Definition Documentation

KKEYBOARD_POP

#define KKEYBOARD_POP   "\x1b[<u"

Definition at line 22 of file termdesc.h.

XTMODKEYSUNDO

#define XTMODKEYSUNDO   "\x1b[>2m\x1b[>4m"

Definition at line 27 of file termdesc.h.

Typedef Documentation

cursorreport

typedef struct cursorreport cursorreport

tinfo

typedef struct tinfo tinfo

Enumeration Type Documentation

escape_e

enum escape_e

Enumerator
ESCAPE_CUP
ESCAPE_HPA
ESCAPE_VPA
ESCAPE_SETAF
ESCAPE_SETAB
ESCAPE_OP
ESCAPE_FGOP
ESCAPE_BGOP
ESCAPE_SGR0
ESCAPE_CIVIS
ESCAPE_CNORM
ESCAPE_OC
ESCAPE_SITM
ESCAPE_RITM
ESCAPE_CUU
ESCAPE_CUB
ESCAPE_CUF
ESCAPE_BOLD
ESCAPE_NOBOLD
ESCAPE_CUD
ESCAPE_SMKX
ESCAPE_RMKX
ESCAPE_EL
ESCAPE_SMCUP
ESCAPE_RMCUP
ESCAPE_SMXX
ESCAPE_SMUL
ESCAPE_RMUL
ESCAPE_SMULX
ESCAPE_SMULNOX
ESCAPE_RMXX
ESCAPE_IND
ESCAPE_INDN
ESCAPE_SC
ESCAPE_RC
ESCAPE_CLEAR
ESCAPE_INITC
ESCAPE_U7
ESCAPE_BSUM
ESCAPE_ESUM
ESCAPE_SAVECOLORS
ESCAPE_RESTORECOLORS
ESCAPE_DECERA
ESCAPE_MAX

Definition at line 44 of file termdesc.h.

             {
  ESCAPE_CUP,     // "cup" move cursor to absolute x, y position
  ESCAPE_HPA,     // "hpa" move cursor to absolute horizontal position
  ESCAPE_VPA,     // "vpa" move cursor to absolute vertical position
  ESCAPE_SETAF,   // "setaf" set foreground color
  ESCAPE_SETAB,   // "setab" set background color
  ESCAPE_OP,      // "op" set foreground and background color to defaults
  ESCAPE_FGOP,    // set foreground only to default
  ESCAPE_BGOP,    // set background only to default
  ESCAPE_SGR0,    // "sgr0" turn off all styles
  ESCAPE_CIVIS,   // "civis" make the cursor invisiable
  ESCAPE_CNORM,   // "cnorm" restore the cursor to normal
  ESCAPE_OC,      // "oc" restore original colors
  ESCAPE_SITM,    // "sitm" start italics
  ESCAPE_RITM,    // "ritm" end italics
  ESCAPE_CUU,     // "cuu" move n cells up
  ESCAPE_CUB,     // "cub" move n cells back (left)
  ESCAPE_CUF,     // "cuf" move n cells forward (right)
  ESCAPE_BOLD,    // "bold" enter bold mode
  ESCAPE_NOBOLD,  // disable bold (ANSI but not terminfo, SGR 22)
  ESCAPE_CUD,     // "cud" move n cells down
  ESCAPE_SMKX,    // "smkx" keypad_xmit (keypad transmit mode)
  ESCAPE_RMKX,    // "rmkx" keypad_local
  ESCAPE_EL,      // "el" clear to end of line, inclusive
  ESCAPE_SMCUP,   // "smcup" enter alternate screen
  ESCAPE_RMCUP,   // "rmcup" leave alternate screen
  ESCAPE_SMXX,    // "smxx" start struckout
  ESCAPE_SMUL,    // "smul" start underline
  ESCAPE_RMUL,    // "rmul" end underline
  ESCAPE_SMULX,   // "Smulx" deparameterized: start extended underline
  ESCAPE_SMULNOX, // "Smulx" deparameterized: kill underline
  ESCAPE_RMXX,    // "rmxx" end struckout
  ESCAPE_IND,     // "ind" scroll 1 line up
  ESCAPE_INDN,    // "indn" scroll n lines up
  ESCAPE_SC,      // "sc" push the cursor onto the stack
  ESCAPE_RC,      // "rc" pop the cursor off the stack
  ESCAPE_CLEAR,   // "clear" clear screen and home cursor
  ESCAPE_INITC,   // "initc" set up palette entry
  ESCAPE_U7,      // "u7" cursor position report
  // Application synchronized updates, not present in terminfo
  // (https://gitlab.com/gnachman/iterm2/-/wikis/synchronized-updates-spec)
  ESCAPE_BSUM,     // Begin Synchronized Update Mode
  ESCAPE_ESUM,     // End Synchronized Update Mode
  ESCAPE_SAVECOLORS,    // XTPUSHCOLORS (push palette/fg/bg)
  ESCAPE_RESTORECOLORS, // XTPOPCOLORS  (pop palette/fg/bg)
  ESCAPE_DECERA,   // rectangular erase
  ESCAPE_MAX
} escape_e;

Function Documentation

cbreak_mode()

int cbreak_mode

(

tinfo *

ti

)

Definition at line 1595 of file termdesc.c.

                          {
#ifndef __MINGW32__
  int ttyfd = ti->ttyfd;
  if(ttyfd < 0){
    return 0;
  }
  // assume it's not a true terminal (e.g. we might be redirected to a file)
  struct termios modtermios;
  memcpy(&modtermios, ti->tpreserved, sizeof(modtermios));
  // see termios(3). disabling ECHO and ICANON means input will not be echoed
  // to the screen, input is made available without enter-based buffering, and
  // line editing is disabled. since we have not gone into raw mode, ctrl+c
  // etc. still have their typical effects. ICRNL maps return to 13 (Ctrl+M)
  // instead of 10 (Ctrl+J).
  modtermios.c_lflag &= (~ECHO & ~ICANON);
  modtermios.c_iflag &= ~ICRNL;
  if(tcsetattr(ttyfd, TCSANOW, &modtermios)){
    logerror("error disabling echo / canonical on %d (%s)", ttyfd, strerror(errno));
    return -1;
  }
#else
  // we don't yet have a way to take Cygwin/MSYS2 out of canonical mode FIXME.
  DWORD mode;
  if(!GetConsoleMode(ti->inhandle, &mode)){
    logerror("error acquiring input mode");
    return -1;
  }
  mode &= ~(ENABLE_LINE_INPUT | ENABLE_ECHO_INPUT);
  if(!SetConsoleMode(ti->inhandle, mode)){
    logerror("error setting input mode");
    return -1;
  }
#endif
  return 0;
}

Here is the caller graph for this function:

enter_alternate_screen()

int enter_alternate_screen	(	int	ttyfd,
		FILE *	ttyfp,
		tinfo *	ti,
		unsigned	drain
	)

Definition at line 559 of file termdesc.c.

                                                                          {
  if(ti->in_alt_screen){
    return 0;
  }
  const char* popcolors = get_escape(ti, ESCAPE_RESTORECOLORS);
  if(popcolors){
    if(term_emit(popcolors, ttyfp, true)){
      return -1;
    }
  }
  const char* smcup = get_escape(ti, ESCAPE_SMCUP);
  if(smcup == NULL){
    logerror("alternate screen is unavailable");
    return -1;
  }
  if(!drain){
    if(ti->kbdlevel){
      if(tty_emit(KKEYBOARD_POP, fd)){
        return -1;
      }
    }else{
      if(tty_emit(XTMODKEYSUNDO, fd)){
        return -1;
      }
    }
  }
  if(tty_emit(smcup, fd) < 0){
    return -1;
  }
  if(!drain){
    if(ti->kbdlevel){
      if(tty_emit(KKBDENTER, fd)){
        return -1;
      }
    }else{
      if(tty_emit(XTMODKEYS, fd)){
        return -1;
      }
    }
  }
  const char* pushcolors = get_escape(ti, ESCAPE_SAVECOLORS);
  if(pushcolors){
    if(term_emit(pushcolors, ttyfp, true)){
      return -1;
    }
  }
  ti->in_alt_screen = true;
  return 0;
}

Here is the caller graph for this function:

free_terminfo_cache()

int void free_terminfo_cache

(

tinfo *

ti

)

Definition at line 197 of file termdesc.c.

                                   {
  stop_inputlayer(ti);
  loginfo("brought down input layer");
  if(ti->pixel_cleanup){
    ti->pixel_cleanup(ti);
  }
  free(ti->termversion);
  free(ti->esctable);
#ifdef __linux__
  if(ti->linux_fb_fd >= 0){
    close(ti->linux_fb_fd);
  }
  free(ti->linux_fb_dev);
  if(ti->linux_fbuffer != MAP_FAILED){
    munmap(ti->linux_fbuffer, ti->linux_fb_len);
  }
#endif
  free(ti->tpreserved);
  loginfo("destroyed terminfo cache");
}

Here is the call graph for this function:

Here is the caller graph for this function:

grow_esc_table()

int grow_esc_table	(	tinfo *	ti,
		const char *	tstr,
		escape_e	esc,
		size_t *	tlen,
		size_t *	tused
	)

Definition at line 14 of file termdesc.c.

                                               {
  // the actual table can grow past 64KB, but we can't start there, as
  // we only have 16-bit indices.
  if(*tused >= 65535){
    fprintf(stderr, "Can't add escape %d to full table\n", esc);
    return -1;
  }
  if(get_escape(ti, esc)){
    fprintf(stderr, "Already defined escape %d (%s)\n",
            esc, get_escape(ti, esc));
    return -1;
  }
  size_t slen = strlen(tstr) + 1; // count the nul term
  if(*tlen - *tused < slen){
    // guaranteed to give us enough space to add tstr (and then some)
    size_t newsize = *tlen + 4020 + slen; // don't pull two pages ideally
    char* tmp = realloc(ti->esctable, newsize);
    if(tmp == NULL){
      return -1;
    }
    ti->esctable = tmp;
    *tlen = newsize;
  }
  // we now are guaranteed sufficient space to copy tstr
  memcpy(ti->esctable + *tused, tstr, slen);
  ti->escindices[esc] = *tused + 1; // one-bias
  *tused += slen;
  return 0;
}

Here is the caller graph for this function:

if()

if

(

idx

)

Definition at line 226 of file termdesc.h.

         {
    return tdesc->esctable + idx - 1;
  }

interrogate_terminfo()

int interrogate_terminfo	(	tinfo *	ti,
		FILE *	out,
		unsigned	utf8,
		unsigned	noaltscreen,
		unsigned	nocbreak,
		unsigned	nonewfonts,
		int *	cursor_y,
		int *	cursor_x,
		struct ncsharedstats *	stats,
		int	lmargin,
		int	tmargin,
		int	rmargin,
		int	bmargin,
		unsigned	draininput
	)

leave_alternate_screen()

int leave_alternate_screen	(	int	ttyfd,
		FILE *	ttyfp,
		tinfo *	ti,
		unsigned	drain
	)

Definition at line 611 of file termdesc.c.

                                                                       {
  if(!ti->in_alt_screen){
    return 0;
  }
  const char* rmcup = get_escape(ti, ESCAPE_RMCUP);
  if(rmcup == NULL){
    logerror("can't leave alternate screen");
    return -1;
  }
  if(!drain){
    if(ti->kbdlevel){
      if(tty_emit(KKEYBOARD_POP, fd)){
        return -1;
      }
    }else{
      if(tty_emit(XTMODKEYSUNDO, fd)){
        return -1;
      }
    }
  }
  const char* popcolors = get_escape(ti, ESCAPE_RESTORECOLORS);
  if(popcolors){
    if(term_emit(popcolors, fp, true)){
      return -1;
    }
  }
  if(tty_emit(rmcup, fd)){
    return -1;
  }
  if(!drain){
    if(ti->kbdlevel){
      if(tty_emit(KKBDENTER, fd)){
        return -1;
      }
    }else{
      if(tty_emit(XTMODKEYS, fd)){
        return -1;
      }
    }
  }
  const char* pushcolors = get_escape(ti, ESCAPE_SAVECOLORS);
  if(pushcolors){
    if(term_emit(popcolors, fp, true)){
      return -1;
    }
  }
  ti->in_alt_screen = false;
  return 0;
}

Here is the caller graph for this function:

locate_cursor()

int locate_cursor	(	tinfo *	ti,
		unsigned *	cursor_y,
		unsigned *	cursor_x
	)

Definition at line 1558 of file termdesc.c.

                                                                    {
  const char* u7 = get_escape(ti, ESCAPE_U7);
  if(u7 == NULL){
    logwarn("no support in terminfo");
    return -1;
  }
  if(ti->ttyfd < 0){
    logwarn("no valid path for cursor report");
    return -1;
  }
  int fd = ti->ttyfd;
  if(get_cursor_location(ti->ictx, u7, cursor_y, cursor_x)){
    return -1;
  }
  loginfo("got a report from %d %d/%d", fd, *cursor_y, *cursor_x);
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

termdesc_longterm()

char * termdesc_longterm

(

const tinfo *

ti

)

Definition at line 1535 of file termdesc.c.

                                        {
  size_t tlen = strlen(ti->termname) + 1;
  size_t slen = tlen;
  if(ti->termversion){
    slen += strlen(ti->termversion) + 1;
  }
  char* ret = malloc(slen);
  if(ret){
    memcpy(ret, ti->termname, tlen);
    if(ti->termversion){
      ret[tlen - 1] = ' ';
      strcpy(ret + tlen, ti->termversion);
    }
  }
  return ret;
}

Here is the caller graph for this function:

tiocgwinsz()

int tiocgwinsz	(	int	fd,
		struct winsize *	ws
	)

Definition at line 1576 of file termdesc.c.

                                          {
#ifndef __MINGW32__
  int i = ioctl(fd, TIOCGWINSZ, ws);
  if(i < 0){
    logerror("TIOCGWINSZ failed on %d (%s)", fd, strerror(errno));
    return -1;
  }
  if(ws->ws_row <= 0 || ws->ws_col <= 0){
    logerror("bogon from TIOCGWINSZ on %d (%d/%d)",
             fd, ws->ws_row, ws->ws_col);
    return -1;
  }
#else
  (void)fd;
  (void)ws;
#endif
  return 0;
}

Here is the caller graph for this function:

Variable Documentation

e

escape_e e

Initial value:

{
  unsigned idx = tdesc->escindices[e]

Definition at line 224 of file termdesc.h.

NULL

return NULL

Definition at line 229 of file termdesc.h.