src/term.h

   1 /* vi:set ts=8 sts=4 sw=4:
   2  *
   3  * VIM - Vi IMproved    by Bram Moolenaar
   4  *
   5  * Do ":help uganda"  in Vim to read copying and usage conditions.
   6  * Do ":help credits" in Vim to see a list of people who contributed.
   7  */
   8
   9 /*
  10  * This file contains the defines for the machine dependent escape sequences
  11  * that the editor needs to perform various operations. All of the sequences
  12  * here are optional, except "cm" (cursor motion).
  13  */
  14
  15 #if defined(SASC) && SASC < 658
  16 /*
  17  * The SAS C compiler has a bug that makes typedefs being forgot in include
  18  * files.  Has been fixed in version 6.58.
  19  */
  20 typedef unsigned char char_u;
  21 #endif
  22
  23 /*
  24  * Index of the termcap codes in the term_strings array.
  25  */
  26 enum SpecialKey
  27 {
  28     KS_NAME = 0,/* name of this terminal entry */
  29     KS_CE,      /* clear to end of line */
  30     KS_AL,      /* add new blank line */
  31     KS_CAL,     /* add number of blank lines */
  32     KS_DL,      /* delete line */
  33     KS_CDL,     /* delete number of lines */
  34     KS_CS,      /* scroll region */
  35     KS_CL,      /* clear screen */
  36     KS_CD,      /* clear to end of display */
  37     KS_UT,      /* clearing uses current background color */
  38     KS_DA,      /* text may be scrolled down from up */
  39     KS_DB,      /* text may be scrolled up from down */
  40     KS_VI,      /* cursor invisible */
  41     KS_VE,      /* cursor visible */
  42     KS_VS,      /* cursor very visible */
  43     KS_ME,      /* normal mode */
  44     KS_MR,      /* reverse mode */
  45     KS_MD,      /* bold mode */
  46     KS_SE,      /* normal mode */
  47     KS_SO,      /* standout mode */
  48     KS_CZH,     /* italic mode start */
  49     KS_CZR,     /* italic mode end */
  50     KS_UE,      /* exit underscore (underline) mode */
  51     KS_US,      /* underscore (underline) mode */
  52     KS_UCE,     /* exit undercurl mode */
  53     KS_UCS,     /* undercurl mode */
  54     KS_MS,      /* save to move cur in reverse mode */
  55     KS_CM,      /* cursor motion */
  56     KS_SR,      /* scroll reverse (backward) */
  57     KS_CRI,     /* cursor number of chars right */
  58     KS_VB,      /* visual bell */
  59     KS_KS,      /* put term in "keypad transmit" mode */
  60     KS_KE,      /* out of "keypad transmit" mode */
  61     KS_TI,      /* put terminal in termcap mode */
  62     KS_TE,      /* out of termcap mode */
  63     KS_BC,      /* backspace character (cursor left) */
  64     KS_CCS,     /* cur is relative to scroll region */
  65     KS_CCO,     /* number of colors */
  66     KS_CSF,     /* set foreground color */
  67     KS_CSB,     /* set background color */
  68     KS_XS,      /* standout not erased by overwriting (hpterm) */
  69     KS_MB,      /* blink mode */
  70     KS_CAF,     /* set foreground color (ANSI) */
  71     KS_CAB,     /* set background color (ANSI) */
  72     KS_LE,      /* cursor left (mostly backspace) */
  73     KS_ND,      /* cursor right */
  74     KS_CIS,     /* set icon text start */
  75     KS_CIE,     /* set icon text end */
  76     KS_TS,      /* set window title start (to status line)*/
  77     KS_FS,      /* set window title end (from status line) */
  78     KS_CWP,     /* set window position in pixels */
  79     KS_CWS,     /* set window size in characters */
  80     KS_CRV,     /* request version string */
  81     KS_CSI,     /* start insert mode (bar cursor) */
  82     KS_CEI,     /* end insert mode (block cursor) */
  83 #ifdef FEAT_VERTSPLIT
  84     KS_CSV,     /* scroll region vertical */
  85 #endif
  86     KS_OP       /* original color pair */
  87 };
  88
  89 #define KS_LAST     KS_OP
  90
  91 /*
  92  * the terminal capabilities are stored in this array
  93  * IMPORTANT: When making changes, note the following:
  94  * - there should be an entry for each code in the builtin termcaps
  95  * - there should be an option for each code in option.c
  96  * - there should be code in term.c to obtain the value from the termcap
  97  */
  98
  99 extern char_u *(term_strings[]);    /* current terminal strings */
 100
 101 /*
 102  * strings used for terminal
 103  */
 104 #define T_NAME  (term_str(KS_NAME))     /* terminal name */
 105 #define T_CE    (term_str(KS_CE))       /* clear to end of line */
 106 #define T_AL    (term_str(KS_AL))       /* add new blank line */
 107 #define T_CAL   (term_str(KS_CAL))      /* add number of blank lines */
 108 #define T_DL    (term_str(KS_DL))       /* delete line */
 109 #define T_CDL   (term_str(KS_CDL))      /* delete number of lines */
 110 #define T_CS    (term_str(KS_CS))       /* scroll region */
 111 #define T_CSV   (term_str(KS_CSV))      /* scroll region vertical */
 112 #define T_CL    (term_str(KS_CL))       /* clear screen */
 113 #define T_CD    (term_str(KS_CD))       /* clear to end of display */
 114 #define T_UT    (term_str(KS_UT))       /* clearing uses background color */
 115 #define T_DA    (term_str(KS_DA))       /* text may be scrolled down from up */
 116 #define T_DB    (term_str(KS_DB))       /* text may be scrolled up from down */
 117 #define T_VI    (term_str(KS_VI))       /* cursor invisible */
 118 #define T_VE    (term_str(KS_VE))       /* cursor visible */
 119 #define T_VS    (term_str(KS_VS))       /* cursor very visible */
 120 #define T_ME    (term_str(KS_ME))       /* normal mode */
 121 #define T_MR    (term_str(KS_MR))       /* reverse mode */
 122 #define T_MD    (term_str(KS_MD))       /* bold mode */
 123 #define T_SE    (term_str(KS_SE))       /* normal mode */
 124 #define T_SO    (term_str(KS_SO))       /* standout mode */
 125 #define T_CZH   (term_str(KS_CZH))      /* italic mode start */
 126 #define T_CZR   (term_str(KS_CZR))      /* italic mode end */
 127 #define T_UE    (term_str(KS_UE))       /* exit underscore (underline) mode */
 128 #define T_US    (term_str(KS_US))       /* underscore (underline) mode */
 129 #define T_UCE   (term_str(KS_UCE))      /* exit undercurl mode */
 130 #define T_UCS   (term_str(KS_UCS))      /* undercurl mode */
 131 #define T_MS    (term_str(KS_MS))       /* save to move cur in reverse mode */
 132 #define T_CM    (term_str(KS_CM))       /* cursor motion */
 133 #define T_SR    (term_str(KS_SR))       /* scroll reverse (backward) */
 134 #define T_CRI   (term_str(KS_CRI))      /* cursor number of chars right */
 135 #define T_VB    (term_str(KS_VB))       /* visual bell */
 136 #define T_KS    (term_str(KS_KS))       /* put term in "keypad transmit" mode */
 137 #define T_KE    (term_str(KS_KE))       /* out of "keypad transmit" mode */
 138 #define T_TI    (term_str(KS_TI))       /* put terminal in termcap mode */
 139 #define T_TE    (term_str(KS_TE))       /* out of termcap mode */
 140 #define T_BC    (term_str(KS_BC))       /* backspace character */
 141 #define T_CCS   (term_str(KS_CCS))      /* cur is relative to scroll region */
 142 #define T_CCO   (term_str(KS_CCO))      /* number of colors */
 143 #define T_CSF   (term_str(KS_CSF))      /* set foreground color */
 144 #define T_CSB   (term_str(KS_CSB))      /* set background color */
 145 #define T_XS    (term_str(KS_XS))       /* standout not erased by overwriting */
 146 #define T_MB    (term_str(KS_MB))       /* blink mode */
 147 #define T_CAF   (term_str(KS_CAF))      /* set foreground color (ANSI) */
 148 #define T_CAB   (term_str(KS_CAB))      /* set background color (ANSI) */
 149 #define T_LE    (term_str(KS_LE))       /* cursor left */
 150 #define T_ND    (term_str(KS_ND))       /* cursor right */
 151 #define T_CIS   (term_str(KS_CIS))      /* set icon text start */
 152 #define T_CIE   (term_str(KS_CIE))      /* set icon text end */
 153 #define T_TS    (term_str(KS_TS))       /* set window title start */
 154 #define T_FS    (term_str(KS_FS))       /* set window title end */
 155 #define T_CWP   (term_str(KS_CWP))      /* window position */
 156 #define T_CWS   (term_str(KS_CWS))      /* window size */
 157 #define T_CSI   (term_str(KS_CSI))      /* start insert mode */
 158 #define T_CEI   (term_str(KS_CEI))      /* end insert mode */
 159 #define T_CRV   (term_str(KS_CRV))      /* request version string */
 160 #define T_OP    (term_str(KS_OP))       /* original color pair */
 161
 162 #define TMODE_COOK  0   /* terminal mode for external cmds and Ex mode */
 163 #define TMODE_SLEEP 1   /* terminal mode for sleeping (cooked but no echo) */
 164 #define TMODE_RAW   2   /* terminal mode for Normal and Insert mode */