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