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