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.
7 * See the LICENSE file for redistribution information.
9 * $Id: key.h,v 10.39 2001/04/27 19:57:32 skimo Exp $ (Berkeley) $Date: 2001/04/27 19:57:32 $
12 #include "multibyte.h"
15 * Fundamental character types.
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
22 * MAX_CHAR_T The maximum value of any character.
24 * If no integral type can hold a character, don't even try the port.
26 typedef u_int ARG_CHAR_T
;
29 #define FILE2INT(sp,n,nlen,w,wlen) \
30 sp->conv->file2int(sp, n, nlen, &sp->wp->cw, &wlen), \
32 #define INT2FILE(sp,w,wlen,n,nlen) \
33 sp->conv->int2file(sp, w, wlen, &sp->wp->cw, &nlen), \
35 #define CHAR2INTB(sp,n,nlen,w,wlen,buf) \
36 sp->conv->char2int(sp, n, nlen, &buf, &wlen), \
38 #define INT2CHAR(sp,w,wlen,n,nlen) \
39 sp->conv->int2char(sp, w, wlen, &sp->wp->cw, &nlen), \
41 #define INT2DISP(sp,w,wlen,n,nlen) \
42 sp->conv->int2disp(sp, w, wlen, &sp->wp->cw, &nlen), \
51 #define CHAR_WIDTH(sp, ch) wcwidth(ch)
52 #define INTISWIDE(c) (!!(c >> 8)) /* XXX wrong name */
55 #define FILE2INT(sp,n,nlen,w,wlen) \
57 #define INT2FILE(sp,w,wlen,n,nlen) \
59 #define CHAR2INTB(sp,n,nlen,w,wlen,buf) \
61 #define INT2CHAR(sp,w,wlen,n,nlen) \
63 #define INT2DISP(sp,w,wlen,n,nlen) \
72 #define INTISWIDE(c) 0
73 #define CHAR_WIDTH(sp, ch) 1
76 #define CHAR2INT(sp,n,nlen,w,wlen) \
77 CHAR2INTB(sp,n,nlen,w,wlen,sp->wp->cw)
79 #define MEMCPYW(to, from, n) \
80 memcpy(to, from, (n) * sizeof(CHAR_T))
81 #define MEMMOVEW(to, from, n) \
82 memmove(to, from, (n) * sizeof(CHAR_T))
84 /* The maximum number of columns any character can take up on a screen. */
85 #define MAX_CHARACTER_COLUMNS 4
90 * The program structure depends on the event loop being able to return
91 * E_EOF/E_ERR multiple times -- eventually enough things will end due
92 * to the events that vi will reach the command level for the screen, at
93 * which point the exit flags will be set and vi will exit.
96 E_NOTUSED
= 0, /* Not set. */
97 E_CHARACTER
, /* Input character: e_c set. */
98 E_EOF
, /* End of input (NOT ^D). */
99 E_ERR
, /* Input error. */
100 E_INTERRUPT
, /* Interrupt. */
101 E_IPCOMMAND
, /* IP command: e_ipcom set. */
102 E_REPAINT
, /* Repaint: e_flno, e_tlno set. */
103 E_SIGHUP
, /* SIGHUP. */
104 E_SIGTERM
, /* SIGTERM. */
105 E_STRING
, /* Input string: e_csp, e_len set. */
106 E_TIMEOUT
, /* Timeout. */
107 E_WRESIZE
, /* Window resize. */
115 K_NOTUSED
= 0, /* Not set. */
128 K_RIGHTBRACE
, /* } */
129 K_RIGHTPAREN
, /* ) */
131 K_VERASE
, /* set from tty: default ^H */
132 K_VKILL
, /* set from tty: default ^U */
133 K_VLNEXT
, /* set from tty: default ^V */
134 K_VWERASE
, /* set from tty: default ^W */
139 TAILQ_ENTRY(_event
) q
; /* Linked list of events. */
140 e_event_t e_event
; /* Event type. */
141 int e_ipcom
; /* IP command. */
143 #define CH_ABBREVIATED 0x01 /* Character is from an abbreviation. */
144 #define CH_MAPPED 0x02 /* Character is from a map. */
145 #define CH_NOMAP 0x04 /* Do not map the character. */
146 #define CH_QUOTED 0x08 /* Character is already quoted. */
147 CHAR_T e_c
; /* Character. */
148 e_key_t e_value
; /* Key type. */
150 #define e_flags e_val1 /* Flags. */
151 #define e_lno e_val1 /* Single location. */
153 #define e_flno e_val1 /* Text region. */
154 #define e_fcno e_val2
155 #define e_tlno e_val3
156 #define e_tcno e_val4
157 size_t e_val1
; /* Value #1. */
158 size_t e_val2
; /* Value #2. */
159 size_t e_val3
; /* Value #3. */
160 size_t e_val4
; /* Value #4. */
164 CHAR_T
*e_str1
; /* String #1. */
165 size_t e_len1
; /* String #1 length. */
166 CHAR_T
*e_str2
; /* String #2. */
167 size_t e_len2
; /* String #2 length. */
170 typedef struct _keylist
{
171 e_key_t value
; /* Special value. */
172 CHAR_T ch
; /* Key. */
174 extern KEYLIST keylist
[];
176 /* Return if more keys in queue. */
177 #define KEYS_WAITING(sp) ((sp)->wp->i_cnt != 0)
178 #define MAPPED_KEYS_WAITING(sp) \
179 (KEYS_WAITING(sp) && \
180 FL_ISSET((sp)->wp->i_event[(sp)->wp->i_next].e_flags, CH_MAPPED))
183 * Ex/vi commands are generally separated by whitespace characters. We
184 * can't use the standard isspace(3) macro because it returns true for
185 * characters like ^K in the ASCII character set. The 4.4BSD isblank(3)
186 * macro does exactly what we want, but it's not portable yet.
189 * Note side effect, ch is evaluated multiple times.
192 #define isblank(ch) ((ch) == ' ' || (ch) == '\t')
195 /* The "standard" tab width, for displaying things to users. */
196 #define STANDARD_TAB 6
198 /* Various special characters, messages. */
199 #define CH_BSEARCH '?' /* Backward search prompt. */
200 #define CH_CURSOR ' ' /* Cursor character. */
201 #define CH_ENDMARK '$' /* End of a range. */
202 #define CH_EXPROMPT ':' /* Ex prompt. */
203 #define CH_FSEARCH '/' /* Forward search prompt. */
204 #define CH_HEX '\030' /* Leading hex character. */
205 #define CH_LITERAL '\026' /* ASCII ^V. */
206 #define CH_NO 'n' /* No. */
207 #define CH_NOT_DIGIT 'a' /* A non-isdigit() character. */
208 #define CH_QUIT 'q' /* Quit. */
209 #define CH_YES 'y' /* Yes. */
212 * Checking for interrupts means that we look at the bit that gets set if the
213 * screen code supports asynchronous events, and call back into the event code
214 * so that non-asynchronous screens get a chance to post the interrupt.
216 * INTERRUPT_CHECK is the number of lines "operated" on before checking for
219 #define INTERRUPT_CHECK 100
220 #define INTERRUPTED(sp) \
221 (F_ISSET((sp)->gp, G_INTERRUPTED) || \
222 (!v_event_get(sp, NULL, 0, EC_INTERRUPT) && \
223 F_ISSET((sp)->gp, G_INTERRUPTED)))
224 #define CLR_INTERRUPT(sp) \
225 F_CLR((sp)->gp, G_INTERRUPTED)
227 /* Flags describing types of characters being requested. */
228 #define EC_INTERRUPT 0x001 /* Checking for interrupts. */
229 #define EC_MAPCOMMAND 0x002 /* Apply the command map. */
230 #define EC_MAPINPUT 0x004 /* Apply the input map. */
231 #define EC_MAPNODIGIT 0x008 /* Return to a digit. */
232 #define EC_QUOTED 0x010 /* Try to quote next character */
233 #define EC_RAW 0x020 /* Any next character. XXX: not used. */
234 #define EC_TIMEOUT 0x040 /* Timeout to next character. */
236 /* Flags describing text input special cases. */
237 #define TXT_ADDNEWLINE 0x00000001 /* Replay starts on a new line. */
238 #define TXT_AICHARS 0x00000002 /* Leading autoindent chars. */
239 #define TXT_ALTWERASE 0x00000004 /* Option: altwerase. */
240 #define TXT_APPENDEOL 0x00000008 /* Appending after EOL. */
241 #define TXT_AUTOINDENT 0x00000010 /* Autoindent set this line. */
242 #define TXT_BACKSLASH 0x00000020 /* Backslashes escape characters. */
243 #define TXT_BEAUTIFY 0x00000040 /* Only printable characters. */
244 #define TXT_BS 0x00000080 /* Backspace returns the buffer. */
245 #define TXT_CEDIT 0x00000100 /* Can return TERM_CEDIT. */
246 #define TXT_CNTRLD 0x00000200 /* Control-D is a command. */
247 #define TXT_CNTRLT 0x00000400 /* Control-T is an indent special. */
248 #define TXT_CR 0x00000800 /* CR returns the buffer. */
249 #define TXT_DOTTERM 0x00001000 /* Leading '.' terminates the input. */
250 #define TXT_EMARK 0x00002000 /* End of replacement mark. */
251 #define TXT_EOFCHAR 0x00004000 /* ICANON set, return EOF character. */
252 #define TXT_ESCAPE 0x00008000 /* Escape returns the buffer. */
253 #define TXT_FILEC 0x00010000 /* Option: filec. */
254 #define TXT_INFOLINE 0x00020000 /* Editing the info line. */
255 #define TXT_MAPINPUT 0x00040000 /* Apply the input map. */
256 #define TXT_NLECHO 0x00080000 /* Echo the newline. */
257 #define TXT_NUMBER 0x00100000 /* Number the line. */
258 #define TXT_OVERWRITE 0x00200000 /* Overwrite characters. */
259 #define TXT_PROMPT 0x00400000 /* Display a prompt. */
260 #define TXT_RECORD 0x00800000 /* Record for replay. */
261 #define TXT_REPLACE 0x01000000 /* Replace; don't delete overwrite. */
262 #define TXT_REPLAY 0x02000000 /* Replay the last input. */
263 #define TXT_RESOLVE 0x04000000 /* Resolve the text into the file. */
264 #define TXT_SEARCHINCR 0x08000000 /* Incremental search. */
265 #define TXT_SHOWMATCH 0x10000000 /* Option: showmatch. */
266 #define TXT_TTYWERASE 0x20000000 /* Option: ttywerase. */
267 #define TXT_WRAPMARGIN 0x40000000 /* Option: wrapmargin. */