common/key.h

   1 /*-
   2  * Copyright (c) 1991, 1993, 1994
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1991, 1993, 1994, 1995, 1996
   5  *      Keith Bostic.  All rights reserved.
   6  *
   7  * See the LICENSE file for redistribution information.
   8  *
   9  *      $Id: key.h,v 10.31 2000/07/21 17:35:02 skimo Exp $ (Berkeley) $Date: 2000/07/21 17:35:02 $
  10  */
  11
  12 #include "multibyte.h"
  13
  14 /*
  15  * Fundamental character types.
  16  *
  17  * CHAR_T       An integral type that can hold any character.
  18  * ARG_CHAR_T   The type of a CHAR_T when passed as an argument using
  19  *              traditional promotion rules.  It should also be able
  20  *              to be compared against any CHAR_T for equality without
  21  *              problems.
  22  * MAX_CHAR_T   The maximum value of any character.
  23  *
  24  * If no integral type can hold a character, don't even try the port.
  25  */
  26 typedef u_int           ARG_CHAR_T;
  27 #define MAX_CHAR_T      0xff
  28 #define CHAR_T_BLEN(sp,len)     len
  29 #define ROOM_FOR(name,len)      CHAR_T  name[len]
  30
  31 #ifdef USE_WIDECHAR
  32 #define FILE2INT(sp,n,nlen,w,wlen) \
  33     sp->conv->file2int(sp->conv, n, nlen, &w, &wlen)
  34 #define INT2FILE(sp,w,wlen,n,nlen) \
  35     sp->conv->int2file(sp->conv, w, wlen, &n, &nlen)
  36 #define CHAR2INT(sp,n,nlen,w,wlen) \
  37     sp->conv->char2int(sp->conv, n, nlen, &w, &wlen)
  38 #define INT2CHAR(sp,w,wlen,n,nlen) \
  39     sp->conv->int2char(sp->conv, w, wlen, &n, &nlen)
  40 #define INT2DISP(sp,w,wlen,n,nlen) \
  41     sp->conv->int2disp(sp->conv, w, wlen, &n, &nlen)
  42 #define CONST
  43 #else
  44 #define FILE2INT(sp,n,nlen,w,wlen) \
  45     w = n, wlen = nlen
  46 #define INT2FILE(sp,w,wlen,n,nlen) \
  47     n = w, nlen = wlen
  48 #define CHAR2INT(sp,n,nlen,w,wlen) \
  49     w = n, wlen = nlen
  50 #define INT2CHAR(sp,w,wlen,n,nlen) \
  51     n = w, nlen = wlen
  52 #define INT2DISP(sp,w,wlen,n,nlen) \
  53     n = w, nlen = wlen
  54 #define CONST const
  55 #endif
  56
  57 #define ISCNTRL(ch) \
  58     iscntrl((u_char)(ch))
  59 #define ISDIGIT(ch) \
  60     isdigit((u_char)(ch))
  61 #define ISPRINT(ch) \
  62     isprint((u_char)(ch))
  63 #define MEMCPYW(to, from, n) \
  64     memcpy(to, from, (n) * sizeof(CHAR_T))
  65 #define MEMMOVEW(to, from, n) \
  66     memmove(to, from, (n) * sizeof(CHAR_T))
  67
  68 /* The maximum number of columns any character can take up on a screen. */
  69 #define MAX_CHARACTER_COLUMNS   4
  70
  71 /*
  72  * Event types.
  73  *
  74  * The program structure depends on the event loop being able to return
  75  * E_EOF/E_ERR multiple times -- eventually enough things will end due
  76  * to the events that vi will reach the command level for the screen, at
  77  * which point the exit flags will be set and vi will exit.
  78  */
  79 typedef enum {
  80         E_NOTUSED = 0,                  /* Not set. */
  81         E_CHARACTER,                    /* Input character: e_c set. */
  82         E_EOF,                          /* End of input (NOT ^D). */
  83         E_ERR,                          /* Input error. */
  84         E_INTERRUPT,                    /* Interrupt. */
  85         E_IPCOMMAND,                    /* IP command: e_ipcom set. */
  86         E_REPAINT,                      /* Repaint: e_flno, e_tlno set. */
  87         E_SIGHUP,                       /* SIGHUP. */
  88         E_SIGTERM,                      /* SIGTERM. */
  89         E_STRING,                       /* Input string: e_csp, e_len set. */
  90         E_TIMEOUT,                      /* Timeout. */
  91         E_WRESIZE,                      /* Window resize. */
  92         E_FLAGS                         /* Flags */
  93 } e_event_t;
  94
  95 /*
  96  * Character values.
  97  */
  98 typedef enum {
  99         K_NOTUSED = 0,                  /* Not set. */
 100         K_BACKSLASH,                    /*  \ */
 101         K_CARAT,                        /*  ^ */
 102         K_CNTRLD,                       /* ^D */
 103         K_CNTRLR,                       /* ^R */
 104         K_CNTRLT,                       /* ^T */
 105         K_CNTRLZ,                       /* ^Z */
 106         K_COLON,                        /*  : */
 107         K_CR,                           /* \r */
 108         K_ESCAPE,                       /* ^[ */
 109         K_FORMFEED,                     /* \f */
 110         K_HEXCHAR,                      /* ^X */
 111         K_NL,                           /* \n */
 112         K_RIGHTBRACE,                   /*  } */
 113         K_RIGHTPAREN,                   /*  ) */
 114         K_TAB,                          /* \t */
 115         K_VERASE,                       /* set from tty: default ^H */
 116         K_VKILL,                        /* set from tty: default ^U */
 117         K_VLNEXT,                       /* set from tty: default ^V */
 118         K_VWERASE,                      /* set from tty: default ^W */
 119         K_ZERO                          /*  0 */
 120 } e_key_t;
 121
 122 struct _event {
 123         TAILQ_ENTRY(_event) q;          /* Linked list of events. */
 124         e_event_t e_event;              /* Event type. */
 125         int       e_ipcom;              /* IP command. */
 126
 127 #define CH_ABBREVIATED  0x01            /* Character is from an abbreviation. */
 128 #define CH_MAPPED       0x02            /* Character is from a map. */
 129 #define CH_NOMAP        0x04            /* Do not map the character. */
 130 #define CH_QUOTED       0x08            /* Character is already quoted. */
 131         CHAR_T    e_c;                  /* Character. */
 132         e_key_t   e_value;              /* Key type. */
 133
 134 #define e_flags e_val1                  /* Flags. */
 135 #define e_lno   e_val1                  /* Single location. */
 136 #define e_cno   e_val2
 137 #define e_flno  e_val1                  /* Text region. */
 138 #define e_fcno  e_val2
 139 #define e_tlno  e_val3
 140 #define e_tcno  e_val4
 141         size_t    e_val1;               /* Value #1. */
 142         size_t    e_val2;               /* Value #2. */
 143         size_t    e_val3;               /* Value #3. */
 144         size_t    e_val4;               /* Value #4. */
 145
 146 #define e_csp   e_str1
 147 #define e_len   e_len1
 148         CHAR_T   *e_str1;               /* String #1. */
 149         size_t    e_len1;               /* String #1 length. */
 150         CHAR_T   *e_str2;               /* String #2. */
 151         size_t    e_len2;               /* String #2 length. */
 152 };
 153
 154 typedef struct _keylist {
 155         e_key_t value;                  /* Special value. */
 156         UCHAR_T ch;                     /* Key. */
 157 } KEYLIST;
 158 extern KEYLIST keylist[];
 159
 160                                         /* Return if more keys in queue. */
 161 #define KEYS_WAITING(sp)        ((sp)->gp->i_cnt != 0)
 162 #define MAPPED_KEYS_WAITING(sp)                                         \
 163         (KEYS_WAITING(sp) &&                                            \
 164             FL_ISSET((sp)->gp->i_event[(sp)->gp->i_next].e_flags, CH_MAPPED))
 165
 166 /*
 167  * Ex/vi commands are generally separated by whitespace characters.  We
 168  * can't use the standard isspace(3) macro because it returns true for
 169  * characters like ^K in the ASCII character set.  The 4.4BSD isblank(3)
 170  * macro does exactly what we want, but it's not portable yet.
 171  *
 172  * XXX
 173  * Note side effect, ch is evaluated multiple times.
 174  */
 175 #ifndef isblank
 176 #define isblank(ch)     ((ch) == ' ' || (ch) == '\t')
 177 #endif
 178
 179 /* The "standard" tab width, for displaying things to users. */
 180 #define STANDARD_TAB    6
 181
 182 /* Various special characters, messages. */
 183 #define CH_BSEARCH      '?'             /* Backward search prompt. */
 184 #define CH_CURSOR       ' '             /* Cursor character. */
 185 #define CH_ENDMARK      '$'             /* End of a range. */
 186 #define CH_EXPROMPT     ':'             /* Ex prompt. */
 187 #define CH_FSEARCH      '/'             /* Forward search prompt. */
 188 #define CH_HEX          '\030'          /* Leading hex character. */
 189 #define CH_LITERAL      '\026'          /* ASCII ^V. */
 190 #define CH_NO           'n'             /* No. */
 191 #define CH_NOT_DIGIT    'a'             /* A non-isdigit() character. */
 192 #define CH_QUIT         'q'             /* Quit. */
 193 #define CH_YES          'y'             /* Yes. */
 194
 195 /*
 196  * Checking for interrupts means that we look at the bit that gets set if the
 197  * screen code supports asynchronous events, and call back into the event code
 198  * so that non-asynchronous screens get a chance to post the interrupt.
 199  *
 200  * INTERRUPT_CHECK is the number of lines "operated" on before checking for
 201  * interrupts.
 202  */
 203 #define INTERRUPT_CHECK 100
 204 #define INTERRUPTED(sp)                                                 \
 205         (F_ISSET((sp)->gp, G_INTERRUPTED) ||                            \
 206         (!v_event_get(sp, NULL, 0, EC_INTERRUPT) &&                     \
 207         F_ISSET((sp)->gp, G_INTERRUPTED)))
 208 #define CLR_INTERRUPT(sp)                                               \
 209         F_CLR((sp)->gp, G_INTERRUPTED)
 210
 211 /* Flags describing types of characters being requested. */
 212 #define EC_INTERRUPT    0x001           /* Checking for interrupts. */
 213 #define EC_MAPCOMMAND   0x002           /* Apply the command map. */
 214 #define EC_MAPINPUT     0x004           /* Apply the input map. */
 215 #define EC_MAPNODIGIT   0x008           /* Return to a digit. */
 216 #define EC_QUOTED       0x010           /* Try to quote next character */
 217 #define EC_RAW          0x020           /* Any next character. XXX: not used. */
 218 #define EC_TIMEOUT      0x040           /* Timeout to next character. */
 219
 220 /* Flags describing text input special cases. */
 221 #define TXT_ADDNEWLINE  0x00000001      /* Replay starts on a new line. */
 222 #define TXT_AICHARS     0x00000002      /* Leading autoindent chars. */
 223 #define TXT_ALTWERASE   0x00000004      /* Option: altwerase. */
 224 #define TXT_APPENDEOL   0x00000008      /* Appending after EOL. */
 225 #define TXT_AUTOINDENT  0x00000010      /* Autoindent set this line. */
 226 #define TXT_BACKSLASH   0x00000020      /* Backslashes escape characters. */
 227 #define TXT_BEAUTIFY    0x00000040      /* Only printable characters. */
 228 #define TXT_BS          0x00000080      /* Backspace returns the buffer. */
 229 #define TXT_CEDIT       0x00000100      /* Can return TERM_CEDIT. */
 230 #define TXT_CNTRLD      0x00000200      /* Control-D is a command. */
 231 #define TXT_CNTRLT      0x00000400      /* Control-T is an indent special. */
 232 #define TXT_CR          0x00000800      /* CR returns the buffer. */
 233 #define TXT_DOTTERM     0x00001000      /* Leading '.' terminates the input. */
 234 #define TXT_EMARK       0x00002000      /* End of replacement mark. */
 235 #define TXT_EOFCHAR     0x00004000      /* ICANON set, return EOF character. */
 236 #define TXT_ESCAPE      0x00008000      /* Escape returns the buffer. */
 237 #define TXT_FILEC       0x00010000      /* Option: filec. */
 238 #define TXT_INFOLINE    0x00020000      /* Editing the info line. */
 239 #define TXT_MAPINPUT    0x00040000      /* Apply the input map. */
 240 #define TXT_NLECHO      0x00080000      /* Echo the newline. */
 241 #define TXT_NUMBER      0x00100000      /* Number the line. */
 242 #define TXT_OVERWRITE   0x00200000      /* Overwrite characters. */
 243 #define TXT_PROMPT      0x00400000      /* Display a prompt. */
 244 #define TXT_RECORD      0x00800000      /* Record for replay. */
 245 #define TXT_REPLACE     0x01000000      /* Replace; don't delete overwrite. */
 246 #define TXT_REPLAY      0x02000000      /* Replay the last input. */
 247 #define TXT_RESOLVE     0x04000000      /* Resolve the text into the file. */
 248 #define TXT_SEARCHINCR  0x08000000      /* Incremental search. */
 249 #define TXT_SHOWMATCH   0x10000000      /* Option: showmatch. */
 250 #define TXT_TTYWERASE   0x20000000      /* Option: ttywerase. */
 251 #define TXT_WRAPMARGIN  0x40000000      /* Option: wrapmargin. */