xref: /vim-8.2.3635/src/term.c (revision bb76f24a)
1 /* vi:set ts=8 sts=4 sw=4 noet:
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  * See README.txt for an overview of the Vim source code.
8  */
9 /*
10  *
11  * term.c: functions for controlling the terminal
12  *
13  * primitive termcap support for Amiga and Win32 included
14  *
15  * NOTE: padding and variable substitution is not performed,
16  * when compiling without HAVE_TGETENT, we use tputs() and tgoto() dummies.
17  */
18 
19 /*
20  * Some systems have a prototype for tgetstr() with (char *) instead of
21  * (char **). This define removes that prototype. We include our own prototype
22  * below.
23  */
24 
25 #define tgetstr tgetstr_defined_wrong
26 #include "vim.h"
27 
28 #ifdef HAVE_TGETENT
29 # ifdef HAVE_TERMIOS_H
30 #  include <termios.h>	    /* seems to be required for some Linux */
31 # endif
32 # ifdef HAVE_TERMCAP_H
33 #  include <termcap.h>
34 # endif
35 
36 /*
37  * A few linux systems define outfuntype in termcap.h to be used as the third
38  * argument for tputs().
39  */
40 # ifdef VMS
41 #  define TPUTSFUNCAST
42 # else
43 #  ifdef HAVE_OUTFUNTYPE
44 #   define TPUTSFUNCAST (outfuntype)
45 #  else
46 #   define TPUTSFUNCAST (int (*)())
47 #  endif
48 # endif
49 #endif
50 
51 #undef tgetstr
52 
53 /*
54  * Here are the builtin termcap entries.  They are not stored as complete
55  * structures with all entries, as such a structure is too big.
56  *
57  * The entries are compact, therefore they normally are included even when
58  * HAVE_TGETENT is defined. When HAVE_TGETENT is defined, the builtin entries
59  * can be accessed with "builtin_amiga", "builtin_ansi", "builtin_debug", etc.
60  *
61  * Each termcap is a list of builtin_term structures. It always starts with
62  * KS_NAME, which separates the entries.  See parse_builtin_tcap() for all
63  * details.
64  * bt_entry is either a KS_xxx code (>= 0), or a K_xxx code.
65  *
66  * Entries marked with "guessed" may be wrong.
67  */
68 struct builtin_term
69 {
70     int		bt_entry;
71     char	*bt_string;
72 };
73 
74 /* start of keys that are not directly used by Vim but can be mapped */
75 #define BT_EXTRA_KEYS	0x101
76 
77 static struct builtin_term *find_builtin_term(char_u *name);
78 static void parse_builtin_tcap(char_u *s);
79 static void term_color(char_u *s, int n);
80 static void gather_termleader(void);
81 #ifdef FEAT_TERMRESPONSE
82 static void req_codes_from_term(void);
83 static void req_more_codes_from_term(void);
84 static void got_code_from_term(char_u *code, int len);
85 static void check_for_codes_from_term(void);
86 #endif
87 #if defined(FEAT_GUI) \
88     || (defined(FEAT_MOUSE) && (!defined(UNIX) || defined(FEAT_MOUSE_XTERM) \
89 		|| defined(FEAT_MOUSE_GPM) || defined(FEAT_SYSMOUSE)))
90 static int get_bytes_from_buf(char_u *, char_u *, int);
91 #endif
92 static void del_termcode_idx(int idx);
93 static int term_is_builtin(char_u *name);
94 static int term_7to8bit(char_u *p);
95 #ifdef FEAT_TERMRESPONSE
96 static void switch_to_8bit(void);
97 #endif
98 
99 #ifdef HAVE_TGETENT
100 static char_u *tgetent_error(char_u *, char_u *);
101 
102 /*
103  * Here is our own prototype for tgetstr(), any prototypes from the include
104  * files have been disabled by the define at the start of this file.
105  */
106 char		*tgetstr(char *, char **);
107 
108 # ifdef FEAT_TERMRESPONSE
109     /* Change this to "if 1" to debug what happens with termresponse. */
110 #  if 0
111 #   define DEBUG_TERMRESPONSE
112     static void log_tr(char *msg);
113 #   define LOG_TR(msg) log_tr(msg)
114 #  else
115 #   define LOG_TR(msg)
116 #  endif
117 /* Request Terminal Version status: */
118 #  define CRV_GET	1	/* send T_CRV when switched to RAW mode */
119 #  define CRV_SENT	2	/* did send T_CRV, waiting for answer */
120 #  define CRV_GOT	3	/* received T_CRV response */
121 static int crv_status = CRV_GET;
122 /* Request Cursor position report: */
123 #  define U7_GET	1	/* send T_U7 when switched to RAW mode */
124 #  define U7_SENT	2	/* did send T_U7, waiting for answer */
125 #  define U7_GOT	3	/* received T_U7 response */
126 static int u7_status = U7_GET;
127 /* Request background color report: */
128 #  define RBG_GET	1	/* send T_RBG when switched to RAW mode */
129 #  define RBG_SENT	2	/* did send T_RBG, waiting for answer */
130 #  define RBG_GOT	3	/* received T_RBG response */
131 static int rbg_status = RBG_GET;
132 # endif
133 
134 /*
135  * Don't declare these variables if termcap.h contains them.
136  * Autoconf checks if these variables should be declared extern (not all
137  * systems have them).
138  * Some versions define ospeed to be speed_t, but that is incompatible with
139  * BSD, where ospeed is short and speed_t is long.
140  */
141 # ifndef HAVE_OSPEED
142 #  ifdef OSPEED_EXTERN
143 extern short ospeed;
144 #   else
145 short ospeed;
146 #   endif
147 # endif
148 # ifndef HAVE_UP_BC_PC
149 #  ifdef UP_BC_PC_EXTERN
150 extern char *UP, *BC, PC;
151 #  else
152 char *UP, *BC, PC;
153 #  endif
154 # endif
155 
156 # define TGETSTR(s, p)	vim_tgetstr((s), (p))
157 # define TGETENT(b, t)	tgetent((char *)(b), (char *)(t))
158 static char_u *vim_tgetstr(char *s, char_u **pp);
159 #endif /* HAVE_TGETENT */
160 
161 static int  detected_8bit = FALSE;	/* detected 8-bit terminal */
162 
163 static struct builtin_term builtin_termcaps[] =
164 {
165 
166 #if defined(FEAT_GUI)
167 /*
168  * GUI pseudo term-cap.
169  */
170     {(int)KS_NAME,	"gui"},
171     {(int)KS_CE,	IF_EB("\033|$", ESC_STR "|$")},
172     {(int)KS_AL,	IF_EB("\033|i", ESC_STR "|i")},
173 # ifdef TERMINFO
174     {(int)KS_CAL,	IF_EB("\033|%p1%dI", ESC_STR "|%p1%dI")},
175 # else
176     {(int)KS_CAL,	IF_EB("\033|%dI", ESC_STR "|%dI")},
177 # endif
178     {(int)KS_DL,	IF_EB("\033|d", ESC_STR "|d")},
179 # ifdef TERMINFO
180     {(int)KS_CDL,	IF_EB("\033|%p1%dD", ESC_STR "|%p1%dD")},
181     {(int)KS_CS,	IF_EB("\033|%p1%d;%p2%dR", ESC_STR "|%p1%d;%p2%dR")},
182 #  ifdef FEAT_WINDOWS
183     {(int)KS_CSV,	IF_EB("\033|%p1%d;%p2%dV", ESC_STR "|%p1%d;%p2%dV")},
184 #  endif
185 # else
186     {(int)KS_CDL,	IF_EB("\033|%dD", ESC_STR "|%dD")},
187     {(int)KS_CS,	IF_EB("\033|%d;%dR", ESC_STR "|%d;%dR")},
188 #  ifdef FEAT_WINDOWS
189     {(int)KS_CSV,	IF_EB("\033|%d;%dV", ESC_STR "|%d;%dV")},
190 #  endif
191 # endif
192     {(int)KS_CL,	IF_EB("\033|C", ESC_STR "|C")},
193 			/* attributes switched on with 'h', off with * 'H' */
194     {(int)KS_ME,	IF_EB("\033|31H", ESC_STR "|31H")}, /* HL_ALL */
195     {(int)KS_MR,	IF_EB("\033|1h", ESC_STR "|1h")},   /* HL_INVERSE */
196     {(int)KS_MD,	IF_EB("\033|2h", ESC_STR "|2h")},   /* HL_BOLD */
197     {(int)KS_SE,	IF_EB("\033|16H", ESC_STR "|16H")}, /* HL_STANDOUT */
198     {(int)KS_SO,	IF_EB("\033|16h", ESC_STR "|16h")}, /* HL_STANDOUT */
199     {(int)KS_UE,	IF_EB("\033|8H", ESC_STR "|8H")},   /* HL_UNDERLINE */
200     {(int)KS_US,	IF_EB("\033|8h", ESC_STR "|8h")},   /* HL_UNDERLINE */
201     {(int)KS_UCE,	IF_EB("\033|8C", ESC_STR "|8C")},   /* HL_UNDERCURL */
202     {(int)KS_UCS,	IF_EB("\033|8c", ESC_STR "|8c")},   /* HL_UNDERCURL */
203     {(int)KS_CZR,	IF_EB("\033|4H", ESC_STR "|4H")},   /* HL_ITALIC */
204     {(int)KS_CZH,	IF_EB("\033|4h", ESC_STR "|4h")},   /* HL_ITALIC */
205     {(int)KS_VB,	IF_EB("\033|f", ESC_STR "|f")},
206     {(int)KS_MS,	"y"},
207     {(int)KS_UT,	"y"},
208     {(int)KS_XN,	"y"},
209     {(int)KS_LE,	"\b"},		/* cursor-left = BS */
210     {(int)KS_ND,	"\014"},	/* cursor-right = CTRL-L */
211 # ifdef TERMINFO
212     {(int)KS_CM,	IF_EB("\033|%p1%d;%p2%dM", ESC_STR "|%p1%d;%p2%dM")},
213 # else
214     {(int)KS_CM,	IF_EB("\033|%d;%dM", ESC_STR "|%d;%dM")},
215 # endif
216 	/* there are no key sequences here, the GUI sequences are recognized
217 	 * in check_termcode() */
218 #endif
219 
220 #ifndef NO_BUILTIN_TCAPS
221 
222 # if defined(AMIGA) || defined(ALL_BUILTIN_TCAPS)
223 /*
224  * Amiga console window, default for Amiga
225  */
226     {(int)KS_NAME,	"amiga"},
227     {(int)KS_CE,	"\033[K"},
228     {(int)KS_CD,	"\033[J"},
229     {(int)KS_AL,	"\033[L"},
230 #  ifdef TERMINFO
231     {(int)KS_CAL,	"\033[%p1%dL"},
232 #  else
233     {(int)KS_CAL,	"\033[%dL"},
234 #  endif
235     {(int)KS_DL,	"\033[M"},
236 #  ifdef TERMINFO
237     {(int)KS_CDL,	"\033[%p1%dM"},
238 #  else
239     {(int)KS_CDL,	"\033[%dM"},
240 #  endif
241     {(int)KS_CL,	"\014"},
242     {(int)KS_VI,	"\033[0 p"},
243     {(int)KS_VE,	"\033[1 p"},
244     {(int)KS_ME,	"\033[0m"},
245     {(int)KS_MR,	"\033[7m"},
246     {(int)KS_MD,	"\033[1m"},
247     {(int)KS_SE,	"\033[0m"},
248     {(int)KS_SO,	"\033[33m"},
249     {(int)KS_US,	"\033[4m"},
250     {(int)KS_UE,	"\033[0m"},
251     {(int)KS_CZH,	"\033[3m"},
252     {(int)KS_CZR,	"\033[0m"},
253 #if defined(__MORPHOS__) || defined(__AROS__)
254     {(int)KS_CCO,	"8"},		/* allow 8 colors */
255 #  ifdef TERMINFO
256     {(int)KS_CAB,	"\033[4%p1%dm"},/* set background color */
257     {(int)KS_CAF,	"\033[3%p1%dm"},/* set foreground color */
258 #  else
259     {(int)KS_CAB,	"\033[4%dm"},	/* set background color */
260     {(int)KS_CAF,	"\033[3%dm"},	/* set foreground color */
261 #  endif
262     {(int)KS_OP,	"\033[m"},	/* reset colors */
263 #endif
264     {(int)KS_MS,	"y"},
265     {(int)KS_UT,	"y"},		/* guessed */
266     {(int)KS_LE,	"\b"},
267 #  ifdef TERMINFO
268     {(int)KS_CM,	"\033[%i%p1%d;%p2%dH"},
269 #  else
270     {(int)KS_CM,	"\033[%i%d;%dH"},
271 #  endif
272 #if defined(__MORPHOS__)
273     {(int)KS_SR,	"\033M"},
274 #endif
275 #  ifdef TERMINFO
276     {(int)KS_CRI,	"\033[%p1%dC"},
277 #  else
278     {(int)KS_CRI,	"\033[%dC"},
279 #  endif
280     {K_UP,		"\233A"},
281     {K_DOWN,		"\233B"},
282     {K_LEFT,		"\233D"},
283     {K_RIGHT,		"\233C"},
284     {K_S_UP,		"\233T"},
285     {K_S_DOWN,		"\233S"},
286     {K_S_LEFT,		"\233 A"},
287     {K_S_RIGHT,		"\233 @"},
288     {K_S_TAB,		"\233Z"},
289     {K_F1,		"\233\060~"},/* some compilers don't dig "\2330" */
290     {K_F2,		"\233\061~"},
291     {K_F3,		"\233\062~"},
292     {K_F4,		"\233\063~"},
293     {K_F5,		"\233\064~"},
294     {K_F6,		"\233\065~"},
295     {K_F7,		"\233\066~"},
296     {K_F8,		"\233\067~"},
297     {K_F9,		"\233\070~"},
298     {K_F10,		"\233\071~"},
299     {K_S_F1,		"\233\061\060~"},
300     {K_S_F2,		"\233\061\061~"},
301     {K_S_F3,		"\233\061\062~"},
302     {K_S_F4,		"\233\061\063~"},
303     {K_S_F5,		"\233\061\064~"},
304     {K_S_F6,		"\233\061\065~"},
305     {K_S_F7,		"\233\061\066~"},
306     {K_S_F8,		"\233\061\067~"},
307     {K_S_F9,		"\233\061\070~"},
308     {K_S_F10,		"\233\061\071~"},
309     {K_HELP,		"\233?~"},
310     {K_INS,		"\233\064\060~"},	/* 101 key keyboard */
311     {K_PAGEUP,		"\233\064\061~"},	/* 101 key keyboard */
312     {K_PAGEDOWN,	"\233\064\062~"},	/* 101 key keyboard */
313     {K_HOME,		"\233\064\064~"},	/* 101 key keyboard */
314     {K_END,		"\233\064\065~"},	/* 101 key keyboard */
315 
316     {BT_EXTRA_KEYS,	""},
317     {TERMCAP2KEY('#', '2'), "\233\065\064~"},	/* shifted home key */
318     {TERMCAP2KEY('#', '3'), "\233\065\060~"},	/* shifted insert key */
319     {TERMCAP2KEY('*', '7'), "\233\065\065~"},	/* shifted end key */
320 # endif
321 
322 # if defined(__BEOS__) || defined(ALL_BUILTIN_TCAPS)
323 /*
324  * almost standard ANSI terminal, default for bebox
325  */
326     {(int)KS_NAME,	"beos-ansi"},
327     {(int)KS_CE,	"\033[K"},
328     {(int)KS_CD,	"\033[J"},
329     {(int)KS_AL,	"\033[L"},
330 #  ifdef TERMINFO
331     {(int)KS_CAL,	"\033[%p1%dL"},
332 #  else
333     {(int)KS_CAL,	"\033[%dL"},
334 #  endif
335     {(int)KS_DL,	"\033[M"},
336 #  ifdef TERMINFO
337     {(int)KS_CDL,	"\033[%p1%dM"},
338 #  else
339     {(int)KS_CDL,	"\033[%dM"},
340 #  endif
341 #ifdef BEOS_PR_OR_BETTER
342 #  ifdef TERMINFO
343     {(int)KS_CS,	"\033[%i%p1%d;%p2%dr"},
344 #  else
345     {(int)KS_CS,	"\033[%i%d;%dr"},	/* scroll region */
346 #  endif
347 #endif
348     {(int)KS_CL,	"\033[H\033[2J"},
349 #ifdef notyet
350     {(int)KS_VI,	"[VI]"}, /* cursor invisible, VT320: CSI ? 25 l */
351     {(int)KS_VE,	"[VE]"}, /* cursor visible, VT320: CSI ? 25 h */
352 #endif
353     {(int)KS_ME,	"\033[m"},	/* normal mode */
354     {(int)KS_MR,	"\033[7m"},	/* reverse */
355     {(int)KS_MD,	"\033[1m"},	/* bold */
356     {(int)KS_SO,	"\033[31m"},	/* standout mode: red */
357     {(int)KS_SE,	"\033[m"},	/* standout end */
358     {(int)KS_CZH,	"\033[35m"},	/* italic: purple */
359     {(int)KS_CZR,	"\033[m"},	/* italic end */
360     {(int)KS_US,	"\033[4m"},	/* underscore mode */
361     {(int)KS_UE,	"\033[m"},	/* underscore end */
362     {(int)KS_CCO,	"8"},		/* allow 8 colors */
363 #  ifdef TERMINFO
364     {(int)KS_CAB,	"\033[4%p1%dm"},/* set background color */
365     {(int)KS_CAF,	"\033[3%p1%dm"},/* set foreground color */
366 #  else
367     {(int)KS_CAB,	"\033[4%dm"},	/* set background color */
368     {(int)KS_CAF,	"\033[3%dm"},	/* set foreground color */
369 #  endif
370     {(int)KS_OP,	"\033[m"},	/* reset colors */
371     {(int)KS_MS,	"y"},		/* safe to move cur in reverse mode */
372     {(int)KS_UT,	"y"},		/* guessed */
373     {(int)KS_LE,	"\b"},
374 #  ifdef TERMINFO
375     {(int)KS_CM,	"\033[%i%p1%d;%p2%dH"},
376 #  else
377     {(int)KS_CM,	"\033[%i%d;%dH"},
378 #  endif
379     {(int)KS_SR,	"\033M"},
380 #  ifdef TERMINFO
381     {(int)KS_CRI,	"\033[%p1%dC"},
382 #  else
383     {(int)KS_CRI,	"\033[%dC"},
384 #  endif
385 #  if defined(BEOS_DR8)
386     {(int)KS_DB,	""},		/* hack! see screen.c */
387 #  endif
388 
389     {K_UP,		"\033[A"},
390     {K_DOWN,		"\033[B"},
391     {K_LEFT,		"\033[D"},
392     {K_RIGHT,		"\033[C"},
393 # endif
394 
395 # if defined(UNIX) || defined(ALL_BUILTIN_TCAPS) || defined(SOME_BUILTIN_TCAPS)
396 /*
397  * standard ANSI terminal, default for unix
398  */
399     {(int)KS_NAME,	"ansi"},
400     {(int)KS_CE,	IF_EB("\033[K", ESC_STR "[K")},
401     {(int)KS_AL,	IF_EB("\033[L", ESC_STR "[L")},
402 #  ifdef TERMINFO
403     {(int)KS_CAL,	IF_EB("\033[%p1%dL", ESC_STR "[%p1%dL")},
404 #  else
405     {(int)KS_CAL,	IF_EB("\033[%dL", ESC_STR "[%dL")},
406 #  endif
407     {(int)KS_DL,	IF_EB("\033[M", ESC_STR "[M")},
408 #  ifdef TERMINFO
409     {(int)KS_CDL,	IF_EB("\033[%p1%dM", ESC_STR "[%p1%dM")},
410 #  else
411     {(int)KS_CDL,	IF_EB("\033[%dM", ESC_STR "[%dM")},
412 #  endif
413     {(int)KS_CL,	IF_EB("\033[H\033[2J", ESC_STR "[H" ESC_STR_nc "[2J")},
414     {(int)KS_ME,	IF_EB("\033[0m", ESC_STR "[0m")},
415     {(int)KS_MR,	IF_EB("\033[7m", ESC_STR "[7m")},
416     {(int)KS_MS,	"y"},
417     {(int)KS_UT,	"y"},		/* guessed */
418     {(int)KS_LE,	"\b"},
419 #  ifdef TERMINFO
420     {(int)KS_CM,	IF_EB("\033[%i%p1%d;%p2%dH", ESC_STR "[%i%p1%d;%p2%dH")},
421 #  else
422     {(int)KS_CM,	IF_EB("\033[%i%d;%dH", ESC_STR "[%i%d;%dH")},
423 #  endif
424 #  ifdef TERMINFO
425     {(int)KS_CRI,	IF_EB("\033[%p1%dC", ESC_STR "[%p1%dC")},
426 #  else
427     {(int)KS_CRI,	IF_EB("\033[%dC", ESC_STR "[%dC")},
428 #  endif
429 # endif
430 
431 # if defined(ALL_BUILTIN_TCAPS)
432 /*
433  * These codes are valid when nansi.sys or equivalent has been installed.
434  * Function keys on a PC are preceded with a NUL. These are converted into
435  * K_NUL '\316' in mch_inchar(), because we cannot handle NULs in key codes.
436  * CTRL-arrow is used instead of SHIFT-arrow.
437  */
438     {(int)KS_NAME,	"pcansi"},
439     {(int)KS_DL,	"\033[M"},
440     {(int)KS_AL,	"\033[L"},
441     {(int)KS_CE,	"\033[K"},
442     {(int)KS_CL,	"\033[2J"},
443     {(int)KS_ME,	"\033[0m"},
444     {(int)KS_MR,	"\033[5m"},	/* reverse: black on lightgrey */
445     {(int)KS_MD,	"\033[1m"},	/* bold: white text */
446     {(int)KS_SE,	"\033[0m"},	/* standout end */
447     {(int)KS_SO,	"\033[31m"},	/* standout: white on blue */
448     {(int)KS_CZH,	"\033[34;43m"},	/* italic mode: blue text on yellow */
449     {(int)KS_CZR,	"\033[0m"},	/* italic mode end */
450     {(int)KS_US,	"\033[36;41m"},	/* underscore mode: cyan text on red */
451     {(int)KS_UE,	"\033[0m"},	/* underscore mode end */
452     {(int)KS_CCO,	"8"},		/* allow 8 colors */
453 #  ifdef TERMINFO
454     {(int)KS_CAB,	"\033[4%p1%dm"},/* set background color */
455     {(int)KS_CAF,	"\033[3%p1%dm"},/* set foreground color */
456 #  else
457     {(int)KS_CAB,	"\033[4%dm"},	/* set background color */
458     {(int)KS_CAF,	"\033[3%dm"},	/* set foreground color */
459 #  endif
460     {(int)KS_OP,	"\033[0m"},	/* reset colors */
461     {(int)KS_MS,	"y"},
462     {(int)KS_UT,	"y"},		/* guessed */
463     {(int)KS_LE,	"\b"},
464 #  ifdef TERMINFO
465     {(int)KS_CM,	"\033[%i%p1%d;%p2%dH"},
466 #  else
467     {(int)KS_CM,	"\033[%i%d;%dH"},
468 #  endif
469 #  ifdef TERMINFO
470     {(int)KS_CRI,	"\033[%p1%dC"},
471 #  else
472     {(int)KS_CRI,	"\033[%dC"},
473 #  endif
474     {K_UP,		"\316H"},
475     {K_DOWN,		"\316P"},
476     {K_LEFT,		"\316K"},
477     {K_RIGHT,		"\316M"},
478     {K_S_LEFT,		"\316s"},
479     {K_S_RIGHT,		"\316t"},
480     {K_F1,		"\316;"},
481     {K_F2,		"\316<"},
482     {K_F3,		"\316="},
483     {K_F4,		"\316>"},
484     {K_F5,		"\316?"},
485     {K_F6,		"\316@"},
486     {K_F7,		"\316A"},
487     {K_F8,		"\316B"},
488     {K_F9,		"\316C"},
489     {K_F10,		"\316D"},
490     {K_F11,		"\316\205"},	/* guessed */
491     {K_F12,		"\316\206"},	/* guessed */
492     {K_S_F1,		"\316T"},
493     {K_S_F2,		"\316U"},
494     {K_S_F3,		"\316V"},
495     {K_S_F4,		"\316W"},
496     {K_S_F5,		"\316X"},
497     {K_S_F6,		"\316Y"},
498     {K_S_F7,		"\316Z"},
499     {K_S_F8,		"\316["},
500     {K_S_F9,		"\316\\"},
501     {K_S_F10,		"\316]"},
502     {K_S_F11,		"\316\207"},	/* guessed */
503     {K_S_F12,		"\316\210"},	/* guessed */
504     {K_INS,		"\316R"},
505     {K_DEL,		"\316S"},
506     {K_HOME,		"\316G"},
507     {K_END,		"\316O"},
508     {K_PAGEDOWN,	"\316Q"},
509     {K_PAGEUP,		"\316I"},
510 # endif
511 
512 # if defined(WIN3264) || defined(ALL_BUILTIN_TCAPS)
513 /*
514  * These codes are valid for the Win32 Console .  The entries that start with
515  * ESC | are translated into console calls in os_win32.c.  The function keys
516  * are also translated in os_win32.c.
517  */
518     {(int)KS_NAME,	"win32"},
519     {(int)KS_CE,	"\033|K"},	/* clear to end of line */
520     {(int)KS_AL,	"\033|L"},	/* add new blank line */
521 #  ifdef TERMINFO
522     {(int)KS_CAL,	"\033|%p1%dL"},	/* add number of new blank lines */
523 #  else
524     {(int)KS_CAL,	"\033|%dL"},	/* add number of new blank lines */
525 #  endif
526     {(int)KS_DL,	"\033|M"},	/* delete line */
527 #  ifdef TERMINFO
528     {(int)KS_CDL,	"\033|%p1%dM"},	/* delete number of lines */
529 #  else
530     {(int)KS_CDL,	"\033|%dM"},	/* delete number of lines */
531 #  endif
532     {(int)KS_CL,	"\033|J"},	/* clear screen */
533     {(int)KS_CD,	"\033|j"},	/* clear to end of display */
534     {(int)KS_VI,	"\033|v"},	/* cursor invisible */
535     {(int)KS_VE,	"\033|V"},	/* cursor visible */
536 
537     {(int)KS_ME,	"\033|0m"},	/* normal */
538     {(int)KS_MR,	"\033|112m"},	/* reverse: black on lightgray */
539     {(int)KS_MD,	"\033|15m"},	/* bold: white on black */
540 #if 1
541     {(int)KS_SO,	"\033|31m"},	/* standout: white on blue */
542     {(int)KS_SE,	"\033|0m"},	/* standout end */
543 #else
544     {(int)KS_SO,	"\033|F"},	/* standout: high intensity */
545     {(int)KS_SE,	"\033|f"},	/* standout end */
546 #endif
547     {(int)KS_CZH,	"\033|225m"},	/* italic: blue text on yellow */
548     {(int)KS_CZR,	"\033|0m"},	/* italic end */
549     {(int)KS_US,	"\033|67m"},	/* underscore: cyan text on red */
550     {(int)KS_UE,	"\033|0m"},	/* underscore end */
551     {(int)KS_CCO,	"16"},		/* allow 16 colors */
552 #  ifdef TERMINFO
553     {(int)KS_CAB,	"\033|%p1%db"},	/* set background color */
554     {(int)KS_CAF,	"\033|%p1%df"},	/* set foreground color */
555 #  else
556     {(int)KS_CAB,	"\033|%db"},	/* set background color */
557     {(int)KS_CAF,	"\033|%df"},	/* set foreground color */
558 #  endif
559 
560     {(int)KS_MS,	"y"},		/* save to move cur in reverse mode */
561     {(int)KS_UT,	"y"},
562     {(int)KS_XN,	"y"},
563     {(int)KS_LE,	"\b"},
564 #  ifdef TERMINFO
565     {(int)KS_CM,	"\033|%i%p1%d;%p2%dH"},/* cursor motion */
566 #  else
567     {(int)KS_CM,	"\033|%i%d;%dH"},/* cursor motion */
568 #  endif
569     {(int)KS_VB,	"\033|B"},	/* visual bell */
570     {(int)KS_TI,	"\033|S"},	/* put terminal in termcap mode */
571     {(int)KS_TE,	"\033|E"},	/* out of termcap mode */
572 #  ifdef TERMINFO
573     {(int)KS_CS,	"\033|%i%p1%d;%p2%dr"},/* scroll region */
574 #  else
575     {(int)KS_CS,	"\033|%i%d;%dr"},/* scroll region */
576 #  endif
577 
578     {K_UP,		"\316H"},
579     {K_DOWN,		"\316P"},
580     {K_LEFT,		"\316K"},
581     {K_RIGHT,		"\316M"},
582     {K_S_UP,		"\316\304"},
583     {K_S_DOWN,		"\316\317"},
584     {K_S_LEFT,		"\316\311"},
585     {K_C_LEFT,		"\316s"},
586     {K_S_RIGHT,		"\316\313"},
587     {K_C_RIGHT,		"\316t"},
588     {K_S_TAB,		"\316\017"},
589     {K_F1,		"\316;"},
590     {K_F2,		"\316<"},
591     {K_F3,		"\316="},
592     {K_F4,		"\316>"},
593     {K_F5,		"\316?"},
594     {K_F6,		"\316@"},
595     {K_F7,		"\316A"},
596     {K_F8,		"\316B"},
597     {K_F9,		"\316C"},
598     {K_F10,		"\316D"},
599     {K_F11,		"\316\205"},
600     {K_F12,		"\316\206"},
601     {K_S_F1,		"\316T"},
602     {K_S_F2,		"\316U"},
603     {K_S_F3,		"\316V"},
604     {K_S_F4,		"\316W"},
605     {K_S_F5,		"\316X"},
606     {K_S_F6,		"\316Y"},
607     {K_S_F7,		"\316Z"},
608     {K_S_F8,		"\316["},
609     {K_S_F9,		"\316\\"},
610     {K_S_F10,		"\316]"},
611     {K_S_F11,		"\316\207"},
612     {K_S_F12,		"\316\210"},
613     {K_INS,		"\316R"},
614     {K_DEL,		"\316S"},
615     {K_HOME,		"\316G"},
616     {K_S_HOME,		"\316\302"},
617     {K_C_HOME,		"\316w"},
618     {K_END,		"\316O"},
619     {K_S_END,		"\316\315"},
620     {K_C_END,		"\316u"},
621     {K_PAGEDOWN,	"\316Q"},
622     {K_PAGEUP,		"\316I"},
623     {K_KPLUS,		"\316N"},
624     {K_KMINUS,		"\316J"},
625     {K_KMULTIPLY,	"\316\067"},
626     {K_K0,		"\316\332"},
627     {K_K1,		"\316\336"},
628     {K_K2,		"\316\342"},
629     {K_K3,		"\316\346"},
630     {K_K4,		"\316\352"},
631     {K_K5,		"\316\356"},
632     {K_K6,		"\316\362"},
633     {K_K7,		"\316\366"},
634     {K_K8,		"\316\372"},
635     {K_K9,		"\316\376"},
636 # endif
637 
638 # if defined(VMS) || defined(ALL_BUILTIN_TCAPS)
639 /*
640  * VT320 is working as an ANSI terminal compatible DEC terminal.
641  * (it covers VT1x0, VT2x0 and VT3x0 up to VT320 on VMS as well)
642  * Note: K_F1...K_F5 are for internal use, should not be defined.
643  * TODO:- rewrite ESC[ codes to CSI
644  *      - keyboard languages (CSI ? 26 n)
645  */
646     {(int)KS_NAME,	"vt320"},
647     {(int)KS_CE,	IF_EB("\033[K", ESC_STR "[K")},
648     {(int)KS_AL,	IF_EB("\033[L", ESC_STR "[L")},
649 #  ifdef TERMINFO
650     {(int)KS_CAL,	IF_EB("\033[%p1%dL", ESC_STR "[%p1%dL")},
651 #  else
652     {(int)KS_CAL,	IF_EB("\033[%dL", ESC_STR "[%dL")},
653 #  endif
654     {(int)KS_DL,	IF_EB("\033[M", ESC_STR "[M")},
655 #  ifdef TERMINFO
656     {(int)KS_CDL,	IF_EB("\033[%p1%dM", ESC_STR "[%p1%dM")},
657 #  else
658     {(int)KS_CDL,	IF_EB("\033[%dM", ESC_STR "[%dM")},
659 #  endif
660     {(int)KS_CL,	IF_EB("\033[H\033[2J", ESC_STR "[H" ESC_STR_nc "[2J")},
661     {(int)KS_CD,	IF_EB("\033[J", ESC_STR "[J")},
662     {(int)KS_CCO,	"8"},			/* allow 8 colors */
663     {(int)KS_ME,	IF_EB("\033[0m", ESC_STR "[0m")},
664     {(int)KS_MR,	IF_EB("\033[7m", ESC_STR "[7m")},
665     {(int)KS_MD,	IF_EB("\033[1m", ESC_STR "[1m")},  /* bold mode */
666     {(int)KS_SE,	IF_EB("\033[22m", ESC_STR "[22m")},/* normal mode */
667     {(int)KS_UE,	IF_EB("\033[24m", ESC_STR "[24m")},/* exit underscore mode */
668     {(int)KS_US,	IF_EB("\033[4m", ESC_STR "[4m")},  /* underscore mode */
669     {(int)KS_CZH,	IF_EB("\033[34;43m", ESC_STR "[34;43m")},  /* italic mode: blue text on yellow */
670     {(int)KS_CZR,	IF_EB("\033[0m", ESC_STR "[0m")},	    /* italic mode end */
671     {(int)KS_CAB,	IF_EB("\033[4%dm", ESC_STR "[4%dm")},	    /* set background color (ANSI) */
672     {(int)KS_CAF,	IF_EB("\033[3%dm", ESC_STR "[3%dm")},	    /* set foreground color (ANSI) */
673     {(int)KS_CSB,	IF_EB("\033[102;%dm", ESC_STR "[102;%dm")},	/* set screen background color */
674     {(int)KS_CSF,	IF_EB("\033[101;%dm", ESC_STR "[101;%dm")},	/* set screen foreground color */
675     {(int)KS_MS,	"y"},
676     {(int)KS_UT,	"y"},
677     {(int)KS_XN,	"y"},
678     {(int)KS_LE,	"\b"},
679 #  ifdef TERMINFO
680     {(int)KS_CM,	IF_EB("\033[%i%p1%d;%p2%dH",
681 						  ESC_STR "[%i%p1%d;%p2%dH")},
682 #  else
683     {(int)KS_CM,	IF_EB("\033[%i%d;%dH", ESC_STR "[%i%d;%dH")},
684 #  endif
685 #  ifdef TERMINFO
686     {(int)KS_CRI,	IF_EB("\033[%p1%dC", ESC_STR "[%p1%dC")},
687 #  else
688     {(int)KS_CRI,	IF_EB("\033[%dC", ESC_STR "[%dC")},
689 #  endif
690     {K_UP,		IF_EB("\033[A", ESC_STR "[A")},
691     {K_DOWN,		IF_EB("\033[B", ESC_STR "[B")},
692     {K_RIGHT,		IF_EB("\033[C", ESC_STR "[C")},
693     {K_LEFT,		IF_EB("\033[D", ESC_STR "[D")},
694     {K_F1,		IF_EB("\033[11~", ESC_STR "[11~")},
695     {K_F2,		IF_EB("\033[12~", ESC_STR "[12~")},
696     {K_F3,		IF_EB("\033[13~", ESC_STR "[13~")},
697     {K_F4,		IF_EB("\033[14~", ESC_STR "[14~")},
698     {K_F5,		IF_EB("\033[15~", ESC_STR "[15~")},
699     {K_F6,		IF_EB("\033[17~", ESC_STR "[17~")},
700     {K_F7,		IF_EB("\033[18~", ESC_STR "[18~")},
701     {K_F8,		IF_EB("\033[19~", ESC_STR "[19~")},
702     {K_F9,		IF_EB("\033[20~", ESC_STR "[20~")},
703     {K_F10,		IF_EB("\033[21~", ESC_STR "[21~")},
704     {K_F11,		IF_EB("\033[23~", ESC_STR "[23~")},
705     {K_F12,		IF_EB("\033[24~", ESC_STR "[24~")},
706     {K_F13,		IF_EB("\033[25~", ESC_STR "[25~")},
707     {K_F14,		IF_EB("\033[26~", ESC_STR "[26~")},
708     {K_F15,		IF_EB("\033[28~", ESC_STR "[28~")},	/* Help */
709     {K_F16,		IF_EB("\033[29~", ESC_STR "[29~")},	/* Select */
710     {K_F17,		IF_EB("\033[31~", ESC_STR "[31~")},
711     {K_F18,		IF_EB("\033[32~", ESC_STR "[32~")},
712     {K_F19,		IF_EB("\033[33~", ESC_STR "[33~")},
713     {K_F20,		IF_EB("\033[34~", ESC_STR "[34~")},
714     {K_INS,		IF_EB("\033[2~", ESC_STR "[2~")},
715     {K_DEL,		IF_EB("\033[3~", ESC_STR "[3~")},
716     {K_HOME,		IF_EB("\033[1~", ESC_STR "[1~")},
717     {K_END,		IF_EB("\033[4~", ESC_STR "[4~")},
718     {K_PAGEUP,		IF_EB("\033[5~", ESC_STR "[5~")},
719     {K_PAGEDOWN,	IF_EB("\033[6~", ESC_STR "[6~")},
720     {K_KPLUS,		IF_EB("\033Ok", ESC_STR "Ok")},	/* keypad plus */
721     {K_KMINUS,		IF_EB("\033Om", ESC_STR "Om")},	/* keypad minus */
722     {K_KDIVIDE,		IF_EB("\033Oo", ESC_STR "Oo")},	/* keypad / */
723     {K_KMULTIPLY,	IF_EB("\033Oj", ESC_STR "Oj")},	/* keypad * */
724     {K_KENTER,		IF_EB("\033OM", ESC_STR "OM")},	/* keypad Enter */
725     {K_BS,		"\x7f"},	/* for some reason 0177 doesn't work */
726 # endif
727 
728 # if defined(ALL_BUILTIN_TCAPS) || defined(__MINT__)
729 /*
730  * Ordinary vt52
731  */
732     {(int)KS_NAME,	"vt52"},
733     {(int)KS_CE,	IF_EB("\033K", ESC_STR "K")},
734     {(int)KS_CD,	IF_EB("\033J", ESC_STR "J")},
735 #  ifdef TERMINFO
736     {(int)KS_CM,	IF_EB("\033Y%p1%' '%+%c%p2%' '%+%c",
737 			    ESC_STR "Y%p1%' '%+%c%p2%' '%+%c")},
738 #  else
739     {(int)KS_CM,	IF_EB("\033Y%+ %+ ", ESC_STR "Y%+ %+ ")},
740 #  endif
741     {(int)KS_LE,	"\b"},
742     {(int)KS_SR,	IF_EB("\033I", ESC_STR "I")},
743     {(int)KS_AL,	IF_EB("\033L", ESC_STR "L")},
744     {(int)KS_DL,	IF_EB("\033M", ESC_STR "M")},
745     {K_UP,		IF_EB("\033A", ESC_STR "A")},
746     {K_DOWN,		IF_EB("\033B", ESC_STR "B")},
747     {K_LEFT,		IF_EB("\033D", ESC_STR "D")},
748     {K_RIGHT,		IF_EB("\033C", ESC_STR "C")},
749     {K_F1,		IF_EB("\033P", ESC_STR "P")},
750     {K_F2,		IF_EB("\033Q", ESC_STR "Q")},
751     {K_F3,		IF_EB("\033R", ESC_STR "R")},
752 #  ifdef __MINT__
753     {(int)KS_CL,	IF_EB("\033E", ESC_STR "E")},
754     {(int)KS_VE,	IF_EB("\033e", ESC_STR "e")},
755     {(int)KS_VI,	IF_EB("\033f", ESC_STR "f")},
756     {(int)KS_SO,	IF_EB("\033p", ESC_STR "p")},
757     {(int)KS_SE,	IF_EB("\033q", ESC_STR "q")},
758     {K_S_UP,		IF_EB("\033a", ESC_STR "a")},
759     {K_S_DOWN,		IF_EB("\033b", ESC_STR "b")},
760     {K_S_LEFT,		IF_EB("\033d", ESC_STR "d")},
761     {K_S_RIGHT,		IF_EB("\033c", ESC_STR "c")},
762     {K_F4,		IF_EB("\033S", ESC_STR "S")},
763     {K_F5,		IF_EB("\033T", ESC_STR "T")},
764     {K_F6,		IF_EB("\033U", ESC_STR "U")},
765     {K_F7,		IF_EB("\033V", ESC_STR "V")},
766     {K_F8,		IF_EB("\033W", ESC_STR "W")},
767     {K_F9,		IF_EB("\033X", ESC_STR "X")},
768     {K_F10,		IF_EB("\033Y", ESC_STR "Y")},
769     {K_S_F1,		IF_EB("\033p", ESC_STR "p")},
770     {K_S_F2,		IF_EB("\033q", ESC_STR "q")},
771     {K_S_F3,		IF_EB("\033r", ESC_STR "r")},
772     {K_S_F4,		IF_EB("\033s", ESC_STR "s")},
773     {K_S_F5,		IF_EB("\033t", ESC_STR "t")},
774     {K_S_F6,		IF_EB("\033u", ESC_STR "u")},
775     {K_S_F7,		IF_EB("\033v", ESC_STR "v")},
776     {K_S_F8,		IF_EB("\033w", ESC_STR "w")},
777     {K_S_F9,		IF_EB("\033x", ESC_STR "x")},
778     {K_S_F10,		IF_EB("\033y", ESC_STR "y")},
779     {K_INS,		IF_EB("\033I", ESC_STR "I")},
780     {K_HOME,		IF_EB("\033E", ESC_STR "E")},
781     {K_PAGEDOWN,	IF_EB("\033b", ESC_STR "b")},
782     {K_PAGEUP,		IF_EB("\033a", ESC_STR "a")},
783 #  else
784     {(int)KS_CL,	IF_EB("\033H\033J", ESC_STR "H" ESC_STR_nc "J")},
785     {(int)KS_MS,	"y"},
786 #  endif
787 # endif
788 
789 # if defined(UNIX) || defined(ALL_BUILTIN_TCAPS) || defined(SOME_BUILTIN_TCAPS)
790     {(int)KS_NAME,	"xterm"},
791     {(int)KS_CE,	IF_EB("\033[K", ESC_STR "[K")},
792     {(int)KS_AL,	IF_EB("\033[L", ESC_STR "[L")},
793 #  ifdef TERMINFO
794     {(int)KS_CAL,	IF_EB("\033[%p1%dL", ESC_STR "[%p1%dL")},
795 #  else
796     {(int)KS_CAL,	IF_EB("\033[%dL", ESC_STR "[%dL")},
797 #  endif
798     {(int)KS_DL,	IF_EB("\033[M", ESC_STR "[M")},
799 #  ifdef TERMINFO
800     {(int)KS_CDL,	IF_EB("\033[%p1%dM", ESC_STR "[%p1%dM")},
801 #  else
802     {(int)KS_CDL,	IF_EB("\033[%dM", ESC_STR "[%dM")},
803 #  endif
804 #  ifdef TERMINFO
805     {(int)KS_CS,	IF_EB("\033[%i%p1%d;%p2%dr",
806 						  ESC_STR "[%i%p1%d;%p2%dr")},
807 #  else
808     {(int)KS_CS,	IF_EB("\033[%i%d;%dr", ESC_STR "[%i%d;%dr")},
809 #  endif
810     {(int)KS_CL,	IF_EB("\033[H\033[2J", ESC_STR "[H" ESC_STR_nc "[2J")},
811     {(int)KS_CD,	IF_EB("\033[J", ESC_STR "[J")},
812     {(int)KS_ME,	IF_EB("\033[m", ESC_STR "[m")},
813     {(int)KS_MR,	IF_EB("\033[7m", ESC_STR "[7m")},
814     {(int)KS_MD,	IF_EB("\033[1m", ESC_STR "[1m")},
815     {(int)KS_UE,	IF_EB("\033[m", ESC_STR "[m")},
816     {(int)KS_US,	IF_EB("\033[4m", ESC_STR "[4m")},
817     {(int)KS_MS,	"y"},
818     {(int)KS_UT,	"y"},
819     {(int)KS_LE,	"\b"},
820 #  ifdef TERMINFO
821     {(int)KS_CM,	IF_EB("\033[%i%p1%d;%p2%dH",
822 						  ESC_STR "[%i%p1%d;%p2%dH")},
823 #  else
824     {(int)KS_CM,	IF_EB("\033[%i%d;%dH", ESC_STR "[%i%d;%dH")},
825 #  endif
826     {(int)KS_SR,	IF_EB("\033M", ESC_STR "M")},
827 #  ifdef TERMINFO
828     {(int)KS_CRI,	IF_EB("\033[%p1%dC", ESC_STR "[%p1%dC")},
829 #  else
830     {(int)KS_CRI,	IF_EB("\033[%dC", ESC_STR "[%dC")},
831 #  endif
832     {(int)KS_KS,	IF_EB("\033[?1h\033=", ESC_STR "[?1h" ESC_STR_nc "=")},
833     {(int)KS_KE,	IF_EB("\033[?1l\033>", ESC_STR "[?1l" ESC_STR_nc ">")},
834 #  ifdef FEAT_XTERM_SAVE
835     {(int)KS_TI,	IF_EB("\0337\033[?47h", ESC_STR "7" ESC_STR_nc "[?47h")},
836     {(int)KS_TE,	IF_EB("\033[2J\033[?47l\0338",
837 				  ESC_STR "[2J" ESC_STR_nc "[?47l" ESC_STR_nc "8")},
838 #  endif
839     {(int)KS_CIS,	IF_EB("\033]1;", ESC_STR "]1;")},
840     {(int)KS_CIE,	"\007"},
841     {(int)KS_TS,	IF_EB("\033]2;", ESC_STR "]2;")},
842     {(int)KS_FS,	"\007"},
843 #  ifdef TERMINFO
844     {(int)KS_CWS,	IF_EB("\033[8;%p1%d;%p2%dt",
845 						  ESC_STR "[8;%p1%d;%p2%dt")},
846     {(int)KS_CWP,	IF_EB("\033[3;%p1%d;%p2%dt",
847 						  ESC_STR "[3;%p1%d;%p2%dt")},
848 #  else
849     {(int)KS_CWS,	IF_EB("\033[8;%d;%dt", ESC_STR "[8;%d;%dt")},
850     {(int)KS_CWP,	IF_EB("\033[3;%d;%dt", ESC_STR "[3;%d;%dt")},
851 #  endif
852     {(int)KS_CRV,	IF_EB("\033[>c", ESC_STR "[>c")},
853     {(int)KS_RBG,	IF_EB("\033]11;?\007", ESC_STR "]11;?\007")},
854     {(int)KS_U7,	IF_EB("\033[6n", ESC_STR "[6n")},
855 #  ifdef FEAT_TERMGUICOLORS
856     /* These are printf strings, not terminal codes. */
857     {(int)KS_8F,	IF_EB("\033[38;2;%lu;%lu;%lum", ESC_STR "[38;2;%lu;%lu;%lum")},
858     {(int)KS_8B,	IF_EB("\033[48;2;%lu;%lu;%lum", ESC_STR "[48;2;%lu;%lu;%lum")},
859 #  endif
860 
861     {K_UP,		IF_EB("\033O*A", ESC_STR "O*A")},
862     {K_DOWN,		IF_EB("\033O*B", ESC_STR "O*B")},
863     {K_RIGHT,		IF_EB("\033O*C", ESC_STR "O*C")},
864     {K_LEFT,		IF_EB("\033O*D", ESC_STR "O*D")},
865     /* An extra set of cursor keys for vt100 mode */
866     {K_XUP,		IF_EB("\033[1;*A", ESC_STR "[1;*A")},
867     {K_XDOWN,		IF_EB("\033[1;*B", ESC_STR "[1;*B")},
868     {K_XRIGHT,		IF_EB("\033[1;*C", ESC_STR "[1;*C")},
869     {K_XLEFT,		IF_EB("\033[1;*D", ESC_STR "[1;*D")},
870     /* An extra set of function keys for vt100 mode */
871     {K_XF1,		IF_EB("\033O*P", ESC_STR "O*P")},
872     {K_XF2,		IF_EB("\033O*Q", ESC_STR "O*Q")},
873     {K_XF3,		IF_EB("\033O*R", ESC_STR "O*R")},
874     {K_XF4,		IF_EB("\033O*S", ESC_STR "O*S")},
875     {K_F1,		IF_EB("\033[11;*~", ESC_STR "[11;*~")},
876     {K_F2,		IF_EB("\033[12;*~", ESC_STR "[12;*~")},
877     {K_F3,		IF_EB("\033[13;*~", ESC_STR "[13;*~")},
878     {K_F4,		IF_EB("\033[14;*~", ESC_STR "[14;*~")},
879     {K_F5,		IF_EB("\033[15;*~", ESC_STR "[15;*~")},
880     {K_F6,		IF_EB("\033[17;*~", ESC_STR "[17;*~")},
881     {K_F7,		IF_EB("\033[18;*~", ESC_STR "[18;*~")},
882     {K_F8,		IF_EB("\033[19;*~", ESC_STR "[19;*~")},
883     {K_F9,		IF_EB("\033[20;*~", ESC_STR "[20;*~")},
884     {K_F10,		IF_EB("\033[21;*~", ESC_STR "[21;*~")},
885     {K_F11,		IF_EB("\033[23;*~", ESC_STR "[23;*~")},
886     {K_F12,		IF_EB("\033[24;*~", ESC_STR "[24;*~")},
887     {K_S_TAB,		IF_EB("\033[Z", ESC_STR "[Z")},
888     {K_HELP,		IF_EB("\033[28;*~", ESC_STR "[28;*~")},
889     {K_UNDO,		IF_EB("\033[26;*~", ESC_STR "[26;*~")},
890     {K_INS,		IF_EB("\033[2;*~", ESC_STR "[2;*~")},
891     {K_HOME,		IF_EB("\033[1;*H", ESC_STR "[1;*H")},
892     /* {K_S_HOME,		IF_EB("\033O2H", ESC_STR "O2H")}, */
893     /* {K_C_HOME,		IF_EB("\033O5H", ESC_STR "O5H")}, */
894     {K_KHOME,		IF_EB("\033[1;*~", ESC_STR "[1;*~")},
895     {K_XHOME,		IF_EB("\033O*H", ESC_STR "O*H")},	/* other Home */
896     {K_ZHOME,		IF_EB("\033[7;*~", ESC_STR "[7;*~")},	/* other Home */
897     {K_END,		IF_EB("\033[1;*F", ESC_STR "[1;*F")},
898     /* {K_S_END,		IF_EB("\033O2F", ESC_STR "O2F")}, */
899     /* {K_C_END,		IF_EB("\033O5F", ESC_STR "O5F")}, */
900     {K_KEND,		IF_EB("\033[4;*~", ESC_STR "[4;*~")},
901     {K_XEND,		IF_EB("\033O*F", ESC_STR "O*F")},	/* other End */
902     {K_ZEND,		IF_EB("\033[8;*~", ESC_STR "[8;*~")},
903     {K_PAGEUP,		IF_EB("\033[5;*~", ESC_STR "[5;*~")},
904     {K_PAGEDOWN,	IF_EB("\033[6;*~", ESC_STR "[6;*~")},
905     {K_KPLUS,		IF_EB("\033O*k", ESC_STR "O*k")},	/* keypad plus */
906     {K_KMINUS,		IF_EB("\033O*m", ESC_STR "O*m")},	/* keypad minus */
907     {K_KDIVIDE,		IF_EB("\033O*o", ESC_STR "O*o")},	/* keypad / */
908     {K_KMULTIPLY,	IF_EB("\033O*j", ESC_STR "O*j")},	/* keypad * */
909     {K_KENTER,		IF_EB("\033O*M", ESC_STR "O*M")},	/* keypad Enter */
910     {K_KPOINT,		IF_EB("\033O*n", ESC_STR "O*n")},	/* keypad . */
911     {K_KDEL,		IF_EB("\033[3;*~", ESC_STR "[3;*~")},	/* keypad Del */
912 
913     {BT_EXTRA_KEYS,   ""},
914     {TERMCAP2KEY('k', '0'), IF_EB("\033[10;*~", ESC_STR "[10;*~")}, /* F0 */
915     {TERMCAP2KEY('F', '3'), IF_EB("\033[25;*~", ESC_STR "[25;*~")}, /* F13 */
916     /* F14 and F15 are missing, because they send the same codes as the undo
917      * and help key, although they don't work on all keyboards. */
918     {TERMCAP2KEY('F', '6'), IF_EB("\033[29;*~", ESC_STR "[29;*~")}, /* F16 */
919     {TERMCAP2KEY('F', '7'), IF_EB("\033[31;*~", ESC_STR "[31;*~")}, /* F17 */
920     {TERMCAP2KEY('F', '8'), IF_EB("\033[32;*~", ESC_STR "[32;*~")}, /* F18 */
921     {TERMCAP2KEY('F', '9'), IF_EB("\033[33;*~", ESC_STR "[33;*~")}, /* F19 */
922     {TERMCAP2KEY('F', 'A'), IF_EB("\033[34;*~", ESC_STR "[34;*~")}, /* F20 */
923 
924     {TERMCAP2KEY('F', 'B'), IF_EB("\033[42;*~", ESC_STR "[42;*~")}, /* F21 */
925     {TERMCAP2KEY('F', 'C'), IF_EB("\033[43;*~", ESC_STR "[43;*~")}, /* F22 */
926     {TERMCAP2KEY('F', 'D'), IF_EB("\033[44;*~", ESC_STR "[44;*~")}, /* F23 */
927     {TERMCAP2KEY('F', 'E'), IF_EB("\033[45;*~", ESC_STR "[45;*~")}, /* F24 */
928     {TERMCAP2KEY('F', 'F'), IF_EB("\033[46;*~", ESC_STR "[46;*~")}, /* F25 */
929     {TERMCAP2KEY('F', 'G'), IF_EB("\033[47;*~", ESC_STR "[47;*~")}, /* F26 */
930     {TERMCAP2KEY('F', 'H'), IF_EB("\033[48;*~", ESC_STR "[48;*~")}, /* F27 */
931     {TERMCAP2KEY('F', 'I'), IF_EB("\033[49;*~", ESC_STR "[49;*~")}, /* F28 */
932     {TERMCAP2KEY('F', 'J'), IF_EB("\033[50;*~", ESC_STR "[50;*~")}, /* F29 */
933     {TERMCAP2KEY('F', 'K'), IF_EB("\033[51;*~", ESC_STR "[51;*~")}, /* F30 */
934 
935     {TERMCAP2KEY('F', 'L'), IF_EB("\033[52;*~", ESC_STR "[52;*~")}, /* F31 */
936     {TERMCAP2KEY('F', 'M'), IF_EB("\033[53;*~", ESC_STR "[53;*~")}, /* F32 */
937     {TERMCAP2KEY('F', 'N'), IF_EB("\033[54;*~", ESC_STR "[54;*~")}, /* F33 */
938     {TERMCAP2KEY('F', 'O'), IF_EB("\033[55;*~", ESC_STR "[55;*~")}, /* F34 */
939     {TERMCAP2KEY('F', 'P'), IF_EB("\033[56;*~", ESC_STR "[56;*~")}, /* F35 */
940     {TERMCAP2KEY('F', 'Q'), IF_EB("\033[57;*~", ESC_STR "[57;*~")}, /* F36 */
941     {TERMCAP2KEY('F', 'R'), IF_EB("\033[58;*~", ESC_STR "[58;*~")}, /* F37 */
942 # endif
943 
944 # if defined(UNIX) || defined(ALL_BUILTIN_TCAPS)
945 /*
946  * iris-ansi for Silicon Graphics machines.
947  */
948     {(int)KS_NAME,	"iris-ansi"},
949     {(int)KS_CE,	"\033[K"},
950     {(int)KS_CD,	"\033[J"},
951     {(int)KS_AL,	"\033[L"},
952 #  ifdef TERMINFO
953     {(int)KS_CAL,	"\033[%p1%dL"},
954 #  else
955     {(int)KS_CAL,	"\033[%dL"},
956 #  endif
957     {(int)KS_DL,	"\033[M"},
958 #  ifdef TERMINFO
959     {(int)KS_CDL,	"\033[%p1%dM"},
960 #  else
961     {(int)KS_CDL,	"\033[%dM"},
962 #  endif
963 #if 0	/* The scroll region is not working as Vim expects. */
964 #  ifdef TERMINFO
965     {(int)KS_CS,	"\033[%i%p1%d;%p2%dr"},
966 #  else
967     {(int)KS_CS,	"\033[%i%d;%dr"},
968 #  endif
969 #endif
970     {(int)KS_CL,	"\033[H\033[2J"},
971     {(int)KS_VE,	"\033[9/y\033[12/y"},	/* These aren't documented */
972     {(int)KS_VS,	"\033[10/y\033[=1h\033[=2l"}, /* These aren't documented */
973     {(int)KS_TI,	"\033[=6h"},
974     {(int)KS_TE,	"\033[=6l"},
975     {(int)KS_SE,	"\033[21;27m"},
976     {(int)KS_SO,	"\033[1;7m"},
977     {(int)KS_ME,	"\033[m"},
978     {(int)KS_MR,	"\033[7m"},
979     {(int)KS_MD,	"\033[1m"},
980     {(int)KS_CCO,	"8"},			/* allow 8 colors */
981     {(int)KS_CZH,	"\033[3m"},		/* italic mode on */
982     {(int)KS_CZR,	"\033[23m"},		/* italic mode off */
983     {(int)KS_US,	"\033[4m"},		/* underline on */
984     {(int)KS_UE,	"\033[24m"},		/* underline off */
985 #  ifdef TERMINFO
986     {(int)KS_CAB,	"\033[4%p1%dm"},    /* set background color (ANSI) */
987     {(int)KS_CAF,	"\033[3%p1%dm"},    /* set foreground color (ANSI) */
988     {(int)KS_CSB,	"\033[102;%p1%dm"}, /* set screen background color */
989     {(int)KS_CSF,	"\033[101;%p1%dm"}, /* set screen foreground color */
990 #  else
991     {(int)KS_CAB,	"\033[4%dm"},	    /* set background color (ANSI) */
992     {(int)KS_CAF,	"\033[3%dm"},	    /* set foreground color (ANSI) */
993     {(int)KS_CSB,	"\033[102;%dm"},    /* set screen background color */
994     {(int)KS_CSF,	"\033[101;%dm"},    /* set screen foreground color */
995 #  endif
996     {(int)KS_MS,	"y"},		/* guessed */
997     {(int)KS_UT,	"y"},		/* guessed */
998     {(int)KS_LE,	"\b"},
999 #  ifdef TERMINFO
1000     {(int)KS_CM,	"\033[%i%p1%d;%p2%dH"},
1001 #  else
1002     {(int)KS_CM,	"\033[%i%d;%dH"},
1003 #  endif
1004     {(int)KS_SR,	"\033M"},
1005 #  ifdef TERMINFO
1006     {(int)KS_CRI,	"\033[%p1%dC"},
1007 #  else
1008     {(int)KS_CRI,	"\033[%dC"},
1009 #  endif
1010     {(int)KS_CIS,	"\033P3.y"},
1011     {(int)KS_CIE,	"\234"},    /* ST "String Terminator" */
1012     {(int)KS_TS,	"\033P1.y"},
1013     {(int)KS_FS,	"\234"},    /* ST "String Terminator" */
1014 #  ifdef TERMINFO
1015     {(int)KS_CWS,	"\033[203;%p1%d;%p2%d/y"},
1016     {(int)KS_CWP,	"\033[205;%p1%d;%p2%d/y"},
1017 #  else
1018     {(int)KS_CWS,	"\033[203;%d;%d/y"},
1019     {(int)KS_CWP,	"\033[205;%d;%d/y"},
1020 #  endif
1021     {K_UP,		"\033[A"},
1022     {K_DOWN,		"\033[B"},
1023     {K_LEFT,		"\033[D"},
1024     {K_RIGHT,		"\033[C"},
1025     {K_S_UP,		"\033[161q"},
1026     {K_S_DOWN,		"\033[164q"},
1027     {K_S_LEFT,		"\033[158q"},
1028     {K_S_RIGHT,		"\033[167q"},
1029     {K_F1,		"\033[001q"},
1030     {K_F2,		"\033[002q"},
1031     {K_F3,		"\033[003q"},
1032     {K_F4,		"\033[004q"},
1033     {K_F5,		"\033[005q"},
1034     {K_F6,		"\033[006q"},
1035     {K_F7,		"\033[007q"},
1036     {K_F8,		"\033[008q"},
1037     {K_F9,		"\033[009q"},
1038     {K_F10,		"\033[010q"},
1039     {K_F11,		"\033[011q"},
1040     {K_F12,		"\033[012q"},
1041     {K_S_F1,		"\033[013q"},
1042     {K_S_F2,		"\033[014q"},
1043     {K_S_F3,		"\033[015q"},
1044     {K_S_F4,		"\033[016q"},
1045     {K_S_F5,		"\033[017q"},
1046     {K_S_F6,		"\033[018q"},
1047     {K_S_F7,		"\033[019q"},
1048     {K_S_F8,		"\033[020q"},
1049     {K_S_F9,		"\033[021q"},
1050     {K_S_F10,		"\033[022q"},
1051     {K_S_F11,		"\033[023q"},
1052     {K_S_F12,		"\033[024q"},
1053     {K_INS,		"\033[139q"},
1054     {K_HOME,		"\033[H"},
1055     {K_END,		"\033[146q"},
1056     {K_PAGEUP,		"\033[150q"},
1057     {K_PAGEDOWN,	"\033[154q"},
1058 # endif
1059 
1060 # if defined(DEBUG) || defined(ALL_BUILTIN_TCAPS)
1061 /*
1062  * for debugging
1063  */
1064     {(int)KS_NAME,	"debug"},
1065     {(int)KS_CE,	"[CE]"},
1066     {(int)KS_CD,	"[CD]"},
1067     {(int)KS_AL,	"[AL]"},
1068 #  ifdef TERMINFO
1069     {(int)KS_CAL,	"[CAL%p1%d]"},
1070 #  else
1071     {(int)KS_CAL,	"[CAL%d]"},
1072 #  endif
1073     {(int)KS_DL,	"[DL]"},
1074 #  ifdef TERMINFO
1075     {(int)KS_CDL,	"[CDL%p1%d]"},
1076 #  else
1077     {(int)KS_CDL,	"[CDL%d]"},
1078 #  endif
1079 #  ifdef TERMINFO
1080     {(int)KS_CS,	"[%p1%dCS%p2%d]"},
1081 #  else
1082     {(int)KS_CS,	"[%dCS%d]"},
1083 #  endif
1084 #  ifdef FEAT_WINDOWS
1085 #   ifdef TERMINFO
1086     {(int)KS_CSV,	"[%p1%dCSV%p2%d]"},
1087 #   else
1088     {(int)KS_CSV,	"[%dCSV%d]"},
1089 #   endif
1090 #  endif
1091 #  ifdef TERMINFO
1092     {(int)KS_CAB,	"[CAB%p1%d]"},
1093     {(int)KS_CAF,	"[CAF%p1%d]"},
1094     {(int)KS_CSB,	"[CSB%p1%d]"},
1095     {(int)KS_CSF,	"[CSF%p1%d]"},
1096 #  else
1097     {(int)KS_CAB,	"[CAB%d]"},
1098     {(int)KS_CAF,	"[CAF%d]"},
1099     {(int)KS_CSB,	"[CSB%d]"},
1100     {(int)KS_CSF,	"[CSF%d]"},
1101 #  endif
1102     {(int)KS_OP,	"[OP]"},
1103     {(int)KS_LE,	"[LE]"},
1104     {(int)KS_CL,	"[CL]"},
1105     {(int)KS_VI,	"[VI]"},
1106     {(int)KS_VE,	"[VE]"},
1107     {(int)KS_VS,	"[VS]"},
1108     {(int)KS_ME,	"[ME]"},
1109     {(int)KS_MR,	"[MR]"},
1110     {(int)KS_MB,	"[MB]"},
1111     {(int)KS_MD,	"[MD]"},
1112     {(int)KS_SE,	"[SE]"},
1113     {(int)KS_SO,	"[SO]"},
1114     {(int)KS_UE,	"[UE]"},
1115     {(int)KS_US,	"[US]"},
1116     {(int)KS_UCE,	"[UCE]"},
1117     {(int)KS_UCS,	"[UCS]"},
1118     {(int)KS_MS,	"[MS]"},
1119     {(int)KS_UT,	"[UT]"},
1120     {(int)KS_XN,	"[XN]"},
1121 #  ifdef TERMINFO
1122     {(int)KS_CM,	"[%p1%dCM%p2%d]"},
1123 #  else
1124     {(int)KS_CM,	"[%dCM%d]"},
1125 #  endif
1126     {(int)KS_SR,	"[SR]"},
1127 #  ifdef TERMINFO
1128     {(int)KS_CRI,	"[CRI%p1%d]"},
1129 #  else
1130     {(int)KS_CRI,	"[CRI%d]"},
1131 #  endif
1132     {(int)KS_VB,	"[VB]"},
1133     {(int)KS_KS,	"[KS]"},
1134     {(int)KS_KE,	"[KE]"},
1135     {(int)KS_TI,	"[TI]"},
1136     {(int)KS_TE,	"[TE]"},
1137     {(int)KS_CIS,	"[CIS]"},
1138     {(int)KS_CIE,	"[CIE]"},
1139     {(int)KS_TS,	"[TS]"},
1140     {(int)KS_FS,	"[FS]"},
1141 #  ifdef TERMINFO
1142     {(int)KS_CWS,	"[%p1%dCWS%p2%d]"},
1143     {(int)KS_CWP,	"[%p1%dCWP%p2%d]"},
1144 #  else
1145     {(int)KS_CWS,	"[%dCWS%d]"},
1146     {(int)KS_CWP,	"[%dCWP%d]"},
1147 #  endif
1148     {(int)KS_CRV,	"[CRV]"},
1149     {(int)KS_U7,	"[U7]"},
1150     {(int)KS_RBG,	"[RBG]"},
1151     {K_UP,		"[KU]"},
1152     {K_DOWN,		"[KD]"},
1153     {K_LEFT,		"[KL]"},
1154     {K_RIGHT,		"[KR]"},
1155     {K_XUP,		"[xKU]"},
1156     {K_XDOWN,		"[xKD]"},
1157     {K_XLEFT,		"[xKL]"},
1158     {K_XRIGHT,		"[xKR]"},
1159     {K_S_UP,		"[S-KU]"},
1160     {K_S_DOWN,		"[S-KD]"},
1161     {K_S_LEFT,		"[S-KL]"},
1162     {K_C_LEFT,		"[C-KL]"},
1163     {K_S_RIGHT,		"[S-KR]"},
1164     {K_C_RIGHT,		"[C-KR]"},
1165     {K_F1,		"[F1]"},
1166     {K_XF1,		"[xF1]"},
1167     {K_F2,		"[F2]"},
1168     {K_XF2,		"[xF2]"},
1169     {K_F3,		"[F3]"},
1170     {K_XF3,		"[xF3]"},
1171     {K_F4,		"[F4]"},
1172     {K_XF4,		"[xF4]"},
1173     {K_F5,		"[F5]"},
1174     {K_F6,		"[F6]"},
1175     {K_F7,		"[F7]"},
1176     {K_F8,		"[F8]"},
1177     {K_F9,		"[F9]"},
1178     {K_F10,		"[F10]"},
1179     {K_F11,		"[F11]"},
1180     {K_F12,		"[F12]"},
1181     {K_S_F1,		"[S-F1]"},
1182     {K_S_XF1,		"[S-xF1]"},
1183     {K_S_F2,		"[S-F2]"},
1184     {K_S_XF2,		"[S-xF2]"},
1185     {K_S_F3,		"[S-F3]"},
1186     {K_S_XF3,		"[S-xF3]"},
1187     {K_S_F4,		"[S-F4]"},
1188     {K_S_XF4,		"[S-xF4]"},
1189     {K_S_F5,		"[S-F5]"},
1190     {K_S_F6,		"[S-F6]"},
1191     {K_S_F7,		"[S-F7]"},
1192     {K_S_F8,		"[S-F8]"},
1193     {K_S_F9,		"[S-F9]"},
1194     {K_S_F10,		"[S-F10]"},
1195     {K_S_F11,		"[S-F11]"},
1196     {K_S_F12,		"[S-F12]"},
1197     {K_HELP,		"[HELP]"},
1198     {K_UNDO,		"[UNDO]"},
1199     {K_BS,		"[BS]"},
1200     {K_INS,		"[INS]"},
1201     {K_KINS,		"[KINS]"},
1202     {K_DEL,		"[DEL]"},
1203     {K_KDEL,		"[KDEL]"},
1204     {K_HOME,		"[HOME]"},
1205     {K_S_HOME,		"[C-HOME]"},
1206     {K_C_HOME,		"[C-HOME]"},
1207     {K_KHOME,		"[KHOME]"},
1208     {K_XHOME,		"[XHOME]"},
1209     {K_ZHOME,		"[ZHOME]"},
1210     {K_END,		"[END]"},
1211     {K_S_END,		"[C-END]"},
1212     {K_C_END,		"[C-END]"},
1213     {K_KEND,		"[KEND]"},
1214     {K_XEND,		"[XEND]"},
1215     {K_ZEND,		"[ZEND]"},
1216     {K_PAGEUP,		"[PAGEUP]"},
1217     {K_PAGEDOWN,	"[PAGEDOWN]"},
1218     {K_KPAGEUP,		"[KPAGEUP]"},
1219     {K_KPAGEDOWN,	"[KPAGEDOWN]"},
1220     {K_MOUSE,		"[MOUSE]"},
1221     {K_KPLUS,		"[KPLUS]"},
1222     {K_KMINUS,		"[KMINUS]"},
1223     {K_KDIVIDE,		"[KDIVIDE]"},
1224     {K_KMULTIPLY,	"[KMULTIPLY]"},
1225     {K_KENTER,		"[KENTER]"},
1226     {K_KPOINT,		"[KPOINT]"},
1227     {K_K0,		"[K0]"},
1228     {K_K1,		"[K1]"},
1229     {K_K2,		"[K2]"},
1230     {K_K3,		"[K3]"},
1231     {K_K4,		"[K4]"},
1232     {K_K5,		"[K5]"},
1233     {K_K6,		"[K6]"},
1234     {K_K7,		"[K7]"},
1235     {K_K8,		"[K8]"},
1236     {K_K9,		"[K9]"},
1237 # endif
1238 
1239 #endif /* NO_BUILTIN_TCAPS */
1240 
1241 /*
1242  * The most minimal terminal: only clear screen and cursor positioning
1243  * Always included.
1244  */
1245     {(int)KS_NAME,	"dumb"},
1246     {(int)KS_CL,	"\014"},
1247 #ifdef TERMINFO
1248     {(int)KS_CM,	IF_EB("\033[%i%p1%d;%p2%dH",
1249 						  ESC_STR "[%i%p1%d;%p2%dH")},
1250 #else
1251     {(int)KS_CM,	IF_EB("\033[%i%d;%dH", ESC_STR "[%i%d;%dH")},
1252 #endif
1253 
1254 /*
1255  * end marker
1256  */
1257     {(int)KS_NAME,	NULL}
1258 
1259 };	/* end of builtin_termcaps */
1260 
1261 #if defined(FEAT_TERMGUICOLORS) || defined(PROTO)
1262     guicolor_T
1263 termgui_mch_get_color(char_u *name)
1264 {
1265     return gui_get_color_cmn(name);
1266 }
1267 
1268     guicolor_T
1269 termgui_get_color(char_u *name)
1270 {
1271     guicolor_T	t;
1272 
1273     if (*name == NUL)
1274 	return INVALCOLOR;
1275     t = termgui_mch_get_color(name);
1276 
1277     if (t == INVALCOLOR)
1278 	EMSG2(_("E254: Cannot allocate color %s"), name);
1279     return t;
1280 }
1281 
1282     guicolor_T
1283 termgui_mch_get_rgb(guicolor_T color)
1284 {
1285     return color;
1286 }
1287 #endif
1288 
1289 /*
1290  * DEFAULT_TERM is used, when no terminal is specified with -T option or $TERM.
1291  */
1292 #ifdef AMIGA
1293 # define DEFAULT_TERM	(char_u *)"amiga"
1294 #endif
1295 
1296 #ifdef MSWIN
1297 # define DEFAULT_TERM	(char_u *)"win32"
1298 #endif
1299 
1300 #if defined(UNIX) && !defined(__MINT__)
1301 # define DEFAULT_TERM	(char_u *)"ansi"
1302 #endif
1303 
1304 #ifdef __MINT__
1305 # define DEFAULT_TERM	(char_u *)"vt52"
1306 #endif
1307 
1308 #ifdef VMS
1309 # define DEFAULT_TERM	(char_u *)"vt320"
1310 #endif
1311 
1312 #ifdef __BEOS__
1313 # undef DEFAULT_TERM
1314 # define DEFAULT_TERM	(char_u *)"beos-ansi"
1315 #endif
1316 
1317 #ifndef DEFAULT_TERM
1318 # define DEFAULT_TERM	(char_u *)"dumb"
1319 #endif
1320 
1321 /*
1322  * Term_strings contains currently used terminal output strings.
1323  * It is initialized with the default values by parse_builtin_tcap().
1324  * The values can be changed by setting the option with the same name.
1325  */
1326 char_u *(term_strings[(int)KS_LAST + 1]);
1327 
1328 static int	need_gather = FALSE;	    /* need to fill termleader[] */
1329 static char_u	termleader[256 + 1];	    /* for check_termcode() */
1330 #ifdef FEAT_TERMRESPONSE
1331 static int	check_for_codes = FALSE;    /* check for key code response */
1332 #endif
1333 
1334     static struct builtin_term *
1335 find_builtin_term(char_u *term)
1336 {
1337     struct builtin_term *p;
1338 
1339     p = builtin_termcaps;
1340     while (p->bt_string != NULL)
1341     {
1342 	if (p->bt_entry == (int)KS_NAME)
1343 	{
1344 #ifdef UNIX
1345 	    if (STRCMP(p->bt_string, "iris-ansi") == 0 && vim_is_iris(term))
1346 		return p;
1347 	    else if (STRCMP(p->bt_string, "xterm") == 0 && vim_is_xterm(term))
1348 		return p;
1349 	    else
1350 #endif
1351 #ifdef VMS
1352 		if (STRCMP(p->bt_string, "vt320") == 0 && vim_is_vt300(term))
1353 		    return p;
1354 		else
1355 #endif
1356 		  if (STRCMP(term, p->bt_string) == 0)
1357 		    return p;
1358 	}
1359 	++p;
1360     }
1361     return p;
1362 }
1363 
1364 /*
1365  * Parsing of the builtin termcap entries.
1366  * Caller should check if 'name' is a valid builtin term.
1367  * The terminal's name is not set, as this is already done in termcapinit().
1368  */
1369     static void
1370 parse_builtin_tcap(char_u *term)
1371 {
1372     struct builtin_term	    *p;
1373     char_u		    name[2];
1374     int			    term_8bit;
1375 
1376     p = find_builtin_term(term);
1377     term_8bit = term_is_8bit(term);
1378 
1379     /* Do not parse if builtin term not found */
1380     if (p->bt_string == NULL)
1381 	return;
1382 
1383     for (++p; p->bt_entry != (int)KS_NAME && p->bt_entry != BT_EXTRA_KEYS; ++p)
1384     {
1385 	if ((int)p->bt_entry >= 0)	/* KS_xx entry */
1386 	{
1387 	    /* Only set the value if it wasn't set yet. */
1388 	    if (term_strings[p->bt_entry] == NULL
1389 				 || term_strings[p->bt_entry] == empty_option)
1390 	    {
1391 		/* 8bit terminal: use CSI instead of <Esc>[ */
1392 		if (term_8bit && term_7to8bit((char_u *)p->bt_string) != 0)
1393 		{
1394 		    char_u  *s, *t;
1395 
1396 		    s = vim_strsave((char_u *)p->bt_string);
1397 		    if (s != NULL)
1398 		    {
1399 			for (t = s; *t; ++t)
1400 			    if (term_7to8bit(t))
1401 			    {
1402 				*t = term_7to8bit(t);
1403 				STRCPY(t + 1, t + 2);
1404 			    }
1405 			term_strings[p->bt_entry] = s;
1406 			set_term_option_alloced(&term_strings[p->bt_entry]);
1407 		    }
1408 		}
1409 		else
1410 		    term_strings[p->bt_entry] = (char_u *)p->bt_string;
1411 	    }
1412 	}
1413 	else
1414 	{
1415 	    name[0] = KEY2TERMCAP0((int)p->bt_entry);
1416 	    name[1] = KEY2TERMCAP1((int)p->bt_entry);
1417 	    if (find_termcode(name) == NULL)
1418 		add_termcode(name, (char_u *)p->bt_string, term_8bit);
1419 	}
1420     }
1421 }
1422 #if defined(HAVE_TGETENT) || defined(FEAT_TERMRESPONSE)
1423 static void set_color_count(int nr);
1424 
1425 /*
1426  * Set number of colors.
1427  * Store it as a number in t_colors.
1428  * Store it as a string in T_CCO (using nr_colors[]).
1429  */
1430     static void
1431 set_color_count(int nr)
1432 {
1433     char_u	nr_colors[20];		/* string for number of colors */
1434 
1435     t_colors = nr;
1436     if (t_colors > 1)
1437 	sprintf((char *)nr_colors, "%d", t_colors);
1438     else
1439 	*nr_colors = NUL;
1440     set_string_option_direct((char_u *)"t_Co", -1, nr_colors, OPT_FREE, 0);
1441 }
1442 #endif
1443 
1444 #ifdef HAVE_TGETENT
1445 static char *(key_names[]) =
1446 {
1447 #ifdef FEAT_TERMRESPONSE
1448     /* Do this one first, it may cause a screen redraw. */
1449     "Co",
1450 #endif
1451     "ku", "kd", "kr", "kl",
1452     "#2", "#4", "%i", "*7",
1453     "k1", "k2", "k3", "k4", "k5", "k6",
1454     "k7", "k8", "k9", "k;", "F1", "F2",
1455     "%1", "&8", "kb", "kI", "kD", "kh",
1456     "@7", "kP", "kN", "K1", "K3", "K4", "K5", "kB",
1457     NULL
1458 };
1459 #endif
1460 
1461 /*
1462  * Set terminal options for terminal "term".
1463  * Return OK if terminal 'term' was found in a termcap, FAIL otherwise.
1464  *
1465  * While doing this, until ttest(), some options may be NULL, be careful.
1466  */
1467     int
1468 set_termname(char_u *term)
1469 {
1470     struct builtin_term *termp;
1471 #ifdef HAVE_TGETENT
1472     int		builtin_first = p_tbi;
1473     int		try;
1474     int		termcap_cleared = FALSE;
1475 #endif
1476     int		width = 0, height = 0;
1477     char_u	*error_msg = NULL;
1478     char_u	*bs_p, *del_p;
1479 
1480     /* In silect mode (ex -s) we don't use the 'term' option. */
1481     if (silent_mode)
1482 	return OK;
1483 
1484     detected_8bit = FALSE;		/* reset 8-bit detection */
1485 
1486     if (term_is_builtin(term))
1487     {
1488 	term += 8;
1489 #ifdef HAVE_TGETENT
1490 	builtin_first = 1;
1491 #endif
1492     }
1493 
1494 /*
1495  * If HAVE_TGETENT is not defined, only the builtin termcap is used, otherwise:
1496  *   If builtin_first is TRUE:
1497  *     0. try builtin termcap
1498  *     1. try external termcap
1499  *     2. if both fail default to a builtin terminal
1500  *   If builtin_first is FALSE:
1501  *     1. try external termcap
1502  *     2. try builtin termcap, if both fail default to a builtin terminal
1503  */
1504 #ifdef HAVE_TGETENT
1505     for (try = builtin_first ? 0 : 1; try < 3; ++try)
1506     {
1507 	/*
1508 	 * Use external termcap
1509 	 */
1510 	if (try == 1)
1511 	{
1512 	    char_u	    *p;
1513 	    static char_u   tstrbuf[TBUFSZ];
1514 	    int		    i;
1515 	    char_u	    tbuf[TBUFSZ];
1516 	    char_u	    *tp;
1517 	    static struct {
1518 			    enum SpecialKey dest; /* index in term_strings[] */
1519 			    char *name;		  /* termcap name for string */
1520 			  } string_names[] =
1521 			    {	{KS_CE, "ce"}, {KS_AL, "al"}, {KS_CAL,"AL"},
1522 				{KS_DL, "dl"}, {KS_CDL,"DL"}, {KS_CS, "cs"},
1523 				{KS_CL, "cl"}, {KS_CD, "cd"},
1524 				{KS_VI, "vi"}, {KS_VE, "ve"}, {KS_MB, "mb"},
1525 				{KS_VS, "vs"}, {KS_ME, "me"}, {KS_MR, "mr"},
1526 				{KS_MD, "md"}, {KS_SE, "se"}, {KS_SO, "so"},
1527 				{KS_CZH,"ZH"}, {KS_CZR,"ZR"}, {KS_UE, "ue"},
1528 				{KS_US, "us"}, {KS_UCE, "Ce"}, {KS_UCS, "Cs"},
1529 				{KS_CM, "cm"}, {KS_SR, "sr"},
1530 				{KS_CRI,"RI"}, {KS_VB, "vb"}, {KS_KS, "ks"},
1531 				{KS_KE, "ke"}, {KS_TI, "ti"}, {KS_TE, "te"},
1532 				{KS_BC, "bc"}, {KS_CSB,"Sb"}, {KS_CSF,"Sf"},
1533 				{KS_CAB,"AB"}, {KS_CAF,"AF"}, {KS_LE, "le"},
1534 				{KS_ND, "nd"}, {KS_OP, "op"}, {KS_CRV, "RV"},
1535 				{KS_CIS, "IS"}, {KS_CIE, "IE"},
1536 				{KS_TS, "ts"}, {KS_FS, "fs"},
1537 				{KS_CWP, "WP"}, {KS_CWS, "WS"},
1538 				{KS_CSI, "SI"}, {KS_CEI, "EI"},
1539 				{KS_U7, "u7"}, {KS_RBG, "RB"},
1540 				{KS_8F, "8f"}, {KS_8B, "8b"},
1541 				{(enum SpecialKey)0, NULL}
1542 			    };
1543 
1544 	    /*
1545 	     * If the external termcap does not have a matching entry, try the
1546 	     * builtin ones.
1547 	     */
1548 	    if ((error_msg = tgetent_error(tbuf, term)) == NULL)
1549 	    {
1550 		tp = tstrbuf;
1551 		if (!termcap_cleared)
1552 		{
1553 		    clear_termoptions();	/* clear old options */
1554 		    termcap_cleared = TRUE;
1555 		}
1556 
1557 	    /* get output strings */
1558 		for (i = 0; string_names[i].name != NULL; ++i)
1559 		{
1560 		    if (term_str(string_names[i].dest) == NULL
1561 			    || term_str(string_names[i].dest) == empty_option)
1562 			term_str(string_names[i].dest) =
1563 					   TGETSTR(string_names[i].name, &tp);
1564 		}
1565 
1566 		/* tgetflag() returns 1 if the flag is present, 0 if not and
1567 		 * possibly -1 if the flag doesn't exist. */
1568 		if ((T_MS == NULL || T_MS == empty_option)
1569 							&& tgetflag("ms") > 0)
1570 		    T_MS = (char_u *)"y";
1571 		if ((T_XS == NULL || T_XS == empty_option)
1572 							&& tgetflag("xs") > 0)
1573 		    T_XS = (char_u *)"y";
1574 		if ((T_XN == NULL || T_XN == empty_option)
1575 							&& tgetflag("xn") > 0)
1576 		    T_XN = (char_u *)"y";
1577 		if ((T_DB == NULL || T_DB == empty_option)
1578 							&& tgetflag("db") > 0)
1579 		    T_DB = (char_u *)"y";
1580 		if ((T_DA == NULL || T_DA == empty_option)
1581 							&& tgetflag("da") > 0)
1582 		    T_DA = (char_u *)"y";
1583 		if ((T_UT == NULL || T_UT == empty_option)
1584 							&& tgetflag("ut") > 0)
1585 		    T_UT = (char_u *)"y";
1586 
1587 
1588 		/*
1589 		 * get key codes
1590 		 */
1591 		for (i = 0; key_names[i] != NULL; ++i)
1592 		{
1593 		    if (find_termcode((char_u *)key_names[i]) == NULL)
1594 		    {
1595 			p = TGETSTR(key_names[i], &tp);
1596 			/* if cursor-left == backspace, ignore it (televideo
1597 			 * 925) */
1598 			if (p != NULL
1599 				&& (*p != Ctrl_H
1600 				    || key_names[i][0] != 'k'
1601 				    || key_names[i][1] != 'l'))
1602 			    add_termcode((char_u *)key_names[i], p, FALSE);
1603 		    }
1604 		}
1605 
1606 		if (height == 0)
1607 		    height = tgetnum("li");
1608 		if (width == 0)
1609 		    width = tgetnum("co");
1610 
1611 		/*
1612 		 * Get number of colors (if not done already).
1613 		 */
1614 		if (term_str(KS_CCO) == NULL
1615 			|| term_str(KS_CCO) == empty_option)
1616 		    set_color_count(tgetnum("Co"));
1617 
1618 # ifndef hpux
1619 		BC = (char *)TGETSTR("bc", &tp);
1620 		UP = (char *)TGETSTR("up", &tp);
1621 		p = TGETSTR("pc", &tp);
1622 		if (p)
1623 		    PC = *p;
1624 # endif /* hpux */
1625 	    }
1626 	}
1627 	else	    /* try == 0 || try == 2 */
1628 #endif /* HAVE_TGETENT */
1629 	/*
1630 	 * Use builtin termcap
1631 	 */
1632 	{
1633 #ifdef HAVE_TGETENT
1634 	    /*
1635 	     * If builtin termcap was already used, there is no need to search
1636 	     * for the builtin termcap again, quit now.
1637 	     */
1638 	    if (try == 2 && builtin_first && termcap_cleared)
1639 		break;
1640 #endif
1641 	    /*
1642 	     * search for 'term' in builtin_termcaps[]
1643 	     */
1644 	    termp = find_builtin_term(term);
1645 	    if (termp->bt_string == NULL)	/* did not find it */
1646 	    {
1647 #ifdef HAVE_TGETENT
1648 		/*
1649 		 * If try == 0, first try the external termcap. If that is not
1650 		 * found we'll get back here with try == 2.
1651 		 * If termcap_cleared is set we used the external termcap,
1652 		 * don't complain about not finding the term in the builtin
1653 		 * termcap.
1654 		 */
1655 		if (try == 0)			/* try external one */
1656 		    continue;
1657 		if (termcap_cleared)		/* found in external termcap */
1658 		    break;
1659 #endif
1660 
1661 		mch_errmsg("\r\n");
1662 		if (error_msg != NULL)
1663 		{
1664 		    mch_errmsg((char *)error_msg);
1665 		    mch_errmsg("\r\n");
1666 		}
1667 		mch_errmsg("'");
1668 		mch_errmsg((char *)term);
1669 		mch_errmsg(_("' not known. Available builtin terminals are:"));
1670 		mch_errmsg("\r\n");
1671 		for (termp = &(builtin_termcaps[0]); termp->bt_string != NULL;
1672 								      ++termp)
1673 		{
1674 		    if (termp->bt_entry == (int)KS_NAME)
1675 		    {
1676 #ifdef HAVE_TGETENT
1677 			mch_errmsg("    builtin_");
1678 #else
1679 			mch_errmsg("    ");
1680 #endif
1681 			mch_errmsg(termp->bt_string);
1682 			mch_errmsg("\r\n");
1683 		    }
1684 		}
1685 		/* when user typed :set term=xxx, quit here */
1686 		if (starting != NO_SCREEN)
1687 		{
1688 		    screen_start();	/* don't know where cursor is now */
1689 		    wait_return(TRUE);
1690 		    return FAIL;
1691 		}
1692 		term = DEFAULT_TERM;
1693 		mch_errmsg(_("defaulting to '"));
1694 		mch_errmsg((char *)term);
1695 		mch_errmsg("'\r\n");
1696 		if (emsg_silent == 0)
1697 		{
1698 		    screen_start();	/* don't know where cursor is now */
1699 		    out_flush();
1700 		    ui_delay(2000L, TRUE);
1701 		}
1702 		set_string_option_direct((char_u *)"term", -1, term,
1703 								 OPT_FREE, 0);
1704 		display_errors();
1705 	    }
1706 	    out_flush();
1707 #ifdef HAVE_TGETENT
1708 	    if (!termcap_cleared)
1709 	    {
1710 #endif
1711 		clear_termoptions();	    /* clear old options */
1712 #ifdef HAVE_TGETENT
1713 		termcap_cleared = TRUE;
1714 	    }
1715 #endif
1716 	    parse_builtin_tcap(term);
1717 #ifdef FEAT_GUI
1718 	    if (term_is_gui(term))
1719 	    {
1720 		out_flush();
1721 		gui_init();
1722 		/* If starting the GUI failed, don't do any of the other
1723 		 * things for this terminal */
1724 		if (!gui.in_use)
1725 		    return FAIL;
1726 #ifdef HAVE_TGETENT
1727 		break;		/* don't try using external termcap */
1728 #endif
1729 	    }
1730 #endif /* FEAT_GUI */
1731 	}
1732 #ifdef HAVE_TGETENT
1733     }
1734 #endif
1735 
1736 /*
1737  * special: There is no info in the termcap about whether the cursor
1738  * positioning is relative to the start of the screen or to the start of the
1739  * scrolling region.  We just guess here. Only msdos pcterm is known to do it
1740  * relative.
1741  */
1742     if (STRCMP(term, "pcterm") == 0)
1743 	T_CCS = (char_u *)"yes";
1744     else
1745 	T_CCS = empty_option;
1746 
1747 #ifdef UNIX
1748 /*
1749  * Any "stty" settings override the default for t_kb from the termcap.
1750  * This is in os_unix.c, because it depends a lot on the version of unix that
1751  * is being used.
1752  * Don't do this when the GUI is active, it uses "t_kb" and "t_kD" directly.
1753  */
1754 #ifdef FEAT_GUI
1755     if (!gui.in_use)
1756 #endif
1757 	get_stty();
1758 #endif
1759 
1760 /*
1761  * If the termcap has no entry for 'bs' and/or 'del' and the ioctl() also
1762  * didn't work, use the default CTRL-H
1763  * The default for t_kD is DEL, unless t_kb is DEL.
1764  * The vim_strsave'd strings are probably lost forever, well it's only two
1765  * bytes.  Don't do this when the GUI is active, it uses "t_kb" and "t_kD"
1766  * directly.
1767  */
1768 #ifdef FEAT_GUI
1769     if (!gui.in_use)
1770 #endif
1771     {
1772 	bs_p = find_termcode((char_u *)"kb");
1773 	del_p = find_termcode((char_u *)"kD");
1774 	if (bs_p == NULL || *bs_p == NUL)
1775 	    add_termcode((char_u *)"kb", (bs_p = (char_u *)CTRL_H_STR), FALSE);
1776 	if ((del_p == NULL || *del_p == NUL) &&
1777 					    (bs_p == NULL || *bs_p != DEL))
1778 	    add_termcode((char_u *)"kD", (char_u *)DEL_STR, FALSE);
1779     }
1780 
1781 #if defined(UNIX) || defined(VMS)
1782     term_is_xterm = vim_is_xterm(term);
1783 #endif
1784 
1785 #ifdef FEAT_MOUSE
1786 # if defined(UNIX) || defined(VMS)
1787 #  ifdef FEAT_MOUSE_TTY
1788     /*
1789      * For Unix, set the 'ttymouse' option to the type of mouse to be used.
1790      * The termcode for the mouse is added as a side effect in option.c.
1791      */
1792     {
1793 	char_u	*p;
1794 
1795 	p = (char_u *)"";
1796 #  ifdef FEAT_MOUSE_XTERM
1797 	if (use_xterm_like_mouse(term))
1798 	{
1799 	    if (use_xterm_mouse())
1800 		p = NULL;	/* keep existing value, might be "xterm2" */
1801 	    else
1802 		p = (char_u *)"xterm";
1803 	}
1804 #  endif
1805 	if (p != NULL)
1806 	{
1807 	    set_option_value((char_u *)"ttym", 0L, p, 0);
1808 	    /* Reset the WAS_SET flag, 'ttymouse' can be set to "sgr" or
1809 	     * "xterm2" in check_termcode(). */
1810 	    reset_option_was_set((char_u *)"ttym");
1811 	}
1812 	if (p == NULL
1813 #   ifdef FEAT_GUI
1814 		|| gui.in_use
1815 #   endif
1816 		)
1817 	    check_mouse_termcode();	/* set mouse termcode anyway */
1818     }
1819 #  endif
1820 # else
1821     set_mouse_termcode(KS_MOUSE, (char_u *)"\233M");
1822 # endif
1823 #endif	/* FEAT_MOUSE */
1824 
1825 #ifdef USE_TERM_CONSOLE
1826     /* DEFAULT_TERM indicates that it is the machine console. */
1827     if (STRCMP(term, DEFAULT_TERM) != 0)
1828 	term_console = FALSE;
1829     else
1830     {
1831 	term_console = TRUE;
1832 # ifdef AMIGA
1833 	win_resize_on();	/* enable window resizing reports */
1834 # endif
1835     }
1836 #endif
1837 
1838 #if defined(UNIX) || defined(VMS)
1839     /*
1840      * 'ttyfast' is default on for xterm, iris-ansi and a few others.
1841      */
1842     if (vim_is_fastterm(term))
1843 	p_tf = TRUE;
1844 #endif
1845 #ifdef USE_TERM_CONSOLE
1846     /*
1847      * 'ttyfast' is default on consoles
1848      */
1849     if (term_console)
1850 	p_tf = TRUE;
1851 #endif
1852 
1853     ttest(TRUE);	/* make sure we have a valid set of terminal codes */
1854 
1855     full_screen = TRUE;		/* we can use termcap codes from now on */
1856     set_term_defaults();	/* use current values as defaults */
1857 #ifdef FEAT_TERMRESPONSE
1858     LOG_TR("setting crv_status to CRV_GET");
1859     crv_status = CRV_GET;	/* Get terminal version later */
1860 #endif
1861 
1862     /*
1863      * Initialize the terminal with the appropriate termcap codes.
1864      * Set the mouse and window title if possible.
1865      * Don't do this when starting, need to parse the .vimrc first, because it
1866      * may redefine t_TI etc.
1867      */
1868     if (starting != NO_SCREEN)
1869     {
1870 	starttermcap();		/* may change terminal mode */
1871 #ifdef FEAT_MOUSE
1872 	setmouse();		/* may start using the mouse */
1873 #endif
1874 #ifdef FEAT_TITLE
1875 	maketitle();		/* may display window title */
1876 #endif
1877     }
1878 
1879 	/* display initial screen after ttest() checking. jw. */
1880     if (width <= 0 || height <= 0)
1881     {
1882 	/* termcap failed to report size */
1883 	/* set defaults, in case ui_get_shellsize() also fails */
1884 	width = 80;
1885 #if defined(WIN3264)
1886 	height = 25;	    /* console is often 25 lines */
1887 #else
1888 	height = 24;	    /* most terminals are 24 lines */
1889 #endif
1890     }
1891     set_shellsize(width, height, FALSE);	/* may change Rows */
1892     if (starting != NO_SCREEN)
1893     {
1894 	if (scroll_region)
1895 	    scroll_region_reset();		/* In case Rows changed */
1896 	check_map_keycodes();	/* check mappings for terminal codes used */
1897 
1898 #ifdef FEAT_AUTOCMD
1899 	{
1900 	    bufref_T	old_curbuf;
1901 
1902 	    /*
1903 	     * Execute the TermChanged autocommands for each buffer that is
1904 	     * loaded.
1905 	     */
1906 	    set_bufref(&old_curbuf, curbuf);
1907 	    FOR_ALL_BUFFERS(curbuf)
1908 	    {
1909 		if (curbuf->b_ml.ml_mfp != NULL)
1910 		    apply_autocmds(EVENT_TERMCHANGED, NULL, NULL, FALSE,
1911 								      curbuf);
1912 	    }
1913 	    if (bufref_valid(&old_curbuf))
1914 		curbuf = old_curbuf.br_buf;
1915 	}
1916 #endif
1917     }
1918 
1919 #ifdef FEAT_TERMRESPONSE
1920     may_req_termresponse();
1921 #endif
1922 
1923     return OK;
1924 }
1925 
1926 #if defined(FEAT_MOUSE) || defined(PROTO)
1927 
1928 # ifdef FEAT_MOUSE_TTY
1929 #  define HMT_NORMAL	1
1930 #  define HMT_NETTERM	2
1931 #  define HMT_DEC	4
1932 #  define HMT_JSBTERM	8
1933 #  define HMT_PTERM	16
1934 #  define HMT_URXVT	32
1935 #  define HMT_SGR	64
1936 static int has_mouse_termcode = 0;
1937 # endif
1938 
1939 # if (!defined(UNIX) || defined(FEAT_MOUSE_TTY)) || defined(PROTO)
1940     void
1941 set_mouse_termcode(
1942     int		n,	/* KS_MOUSE, KS_NETTERM_MOUSE or KS_DEC_MOUSE */
1943     char_u	*s)
1944 {
1945     char_u	name[2];
1946 
1947     name[0] = n;
1948     name[1] = KE_FILLER;
1949     add_termcode(name, s, FALSE);
1950 #  ifdef FEAT_MOUSE_TTY
1951 #   ifdef FEAT_MOUSE_JSB
1952     if (n == KS_JSBTERM_MOUSE)
1953 	has_mouse_termcode |= HMT_JSBTERM;
1954     else
1955 #   endif
1956 #   ifdef FEAT_MOUSE_NET
1957     if (n == KS_NETTERM_MOUSE)
1958 	has_mouse_termcode |= HMT_NETTERM;
1959     else
1960 #   endif
1961 #   ifdef FEAT_MOUSE_DEC
1962     if (n == KS_DEC_MOUSE)
1963 	has_mouse_termcode |= HMT_DEC;
1964     else
1965 #   endif
1966 #   ifdef FEAT_MOUSE_PTERM
1967     if (n == KS_PTERM_MOUSE)
1968 	has_mouse_termcode |= HMT_PTERM;
1969     else
1970 #   endif
1971 #   ifdef FEAT_MOUSE_URXVT
1972     if (n == KS_URXVT_MOUSE)
1973 	has_mouse_termcode |= HMT_URXVT;
1974     else
1975 #   endif
1976 #   ifdef FEAT_MOUSE_SGR
1977     if (n == KS_SGR_MOUSE)
1978 	has_mouse_termcode |= HMT_SGR;
1979     else
1980 #   endif
1981 	has_mouse_termcode |= HMT_NORMAL;
1982 #  endif
1983 }
1984 # endif
1985 
1986 # if ((defined(UNIX) || defined(VMS)) \
1987 	&& defined(FEAT_MOUSE_TTY)) || defined(PROTO)
1988     void
1989 del_mouse_termcode(
1990     int		n)	/* KS_MOUSE, KS_NETTERM_MOUSE or KS_DEC_MOUSE */
1991 {
1992     char_u	name[2];
1993 
1994     name[0] = n;
1995     name[1] = KE_FILLER;
1996     del_termcode(name);
1997 #  ifdef FEAT_MOUSE_TTY
1998 #   ifdef FEAT_MOUSE_JSB
1999     if (n == KS_JSBTERM_MOUSE)
2000 	has_mouse_termcode &= ~HMT_JSBTERM;
2001     else
2002 #   endif
2003 #   ifdef FEAT_MOUSE_NET
2004     if (n == KS_NETTERM_MOUSE)
2005 	has_mouse_termcode &= ~HMT_NETTERM;
2006     else
2007 #   endif
2008 #   ifdef FEAT_MOUSE_DEC
2009     if (n == KS_DEC_MOUSE)
2010 	has_mouse_termcode &= ~HMT_DEC;
2011     else
2012 #   endif
2013 #   ifdef FEAT_MOUSE_PTERM
2014     if (n == KS_PTERM_MOUSE)
2015 	has_mouse_termcode &= ~HMT_PTERM;
2016     else
2017 #   endif
2018 #   ifdef FEAT_MOUSE_URXVT
2019     if (n == KS_URXVT_MOUSE)
2020 	has_mouse_termcode &= ~HMT_URXVT;
2021     else
2022 #   endif
2023 #   ifdef FEAT_MOUSE_SGR
2024     if (n == KS_SGR_MOUSE)
2025 	has_mouse_termcode &= ~HMT_SGR;
2026     else
2027 #   endif
2028 	has_mouse_termcode &= ~HMT_NORMAL;
2029 #  endif
2030 }
2031 # endif
2032 #endif
2033 
2034 #ifdef HAVE_TGETENT
2035 /*
2036  * Call tgetent()
2037  * Return error message if it fails, NULL if it's OK.
2038  */
2039     static char_u *
2040 tgetent_error(char_u *tbuf, char_u *term)
2041 {
2042     int	    i;
2043 
2044     i = TGETENT(tbuf, term);
2045     if (i < 0		    /* -1 is always an error */
2046 # ifdef TGETENT_ZERO_ERR
2047 	    || i == 0	    /* sometimes zero is also an error */
2048 # endif
2049        )
2050     {
2051 	/* On FreeBSD tputs() gets a SEGV after a tgetent() which fails.  Call
2052 	 * tgetent() with the always existing "dumb" entry to avoid a crash or
2053 	 * hang. */
2054 	(void)TGETENT(tbuf, "dumb");
2055 
2056 	if (i < 0)
2057 # ifdef TGETENT_ZERO_ERR
2058 	    return (char_u *)_("E557: Cannot open termcap file");
2059 	if (i == 0)
2060 # endif
2061 #ifdef TERMINFO
2062 	    return (char_u *)_("E558: Terminal entry not found in terminfo");
2063 #else
2064 	    return (char_u *)_("E559: Terminal entry not found in termcap");
2065 #endif
2066     }
2067     return NULL;
2068 }
2069 
2070 /*
2071  * Some versions of tgetstr() have been reported to return -1 instead of NULL.
2072  * Fix that here.
2073  */
2074     static char_u *
2075 vim_tgetstr(char *s, char_u **pp)
2076 {
2077     char	*p;
2078 
2079     p = tgetstr(s, (char **)pp);
2080     if (p == (char *)-1)
2081 	p = NULL;
2082     return (char_u *)p;
2083 }
2084 #endif /* HAVE_TGETENT */
2085 
2086 #if defined(HAVE_TGETENT) && (defined(UNIX) || defined(VMS) || defined(MACOS_X))
2087 /*
2088  * Get Columns and Rows from the termcap. Used after a window signal if the
2089  * ioctl() fails. It doesn't make sense to call tgetent each time if the "co"
2090  * and "li" entries never change. But on some systems this works.
2091  * Errors while getting the entries are ignored.
2092  */
2093     void
2094 getlinecol(
2095     long	*cp,	/* pointer to columns */
2096     long	*rp)	/* pointer to rows */
2097 {
2098     char_u	tbuf[TBUFSZ];
2099 
2100     if (T_NAME != NULL && *T_NAME != NUL && tgetent_error(tbuf, T_NAME) == NULL)
2101     {
2102 	if (*cp == 0)
2103 	    *cp = tgetnum("co");
2104 	if (*rp == 0)
2105 	    *rp = tgetnum("li");
2106     }
2107 }
2108 #endif /* defined(HAVE_TGETENT) && defined(UNIX) */
2109 
2110 /*
2111  * Get a string entry from the termcap and add it to the list of termcodes.
2112  * Used for <t_xx> special keys.
2113  * Give an error message for failure when not sourcing.
2114  * If force given, replace an existing entry.
2115  * Return FAIL if the entry was not found, OK if the entry was added.
2116  */
2117     int
2118 add_termcap_entry(char_u *name, int force)
2119 {
2120     char_u  *term;
2121     int	    key;
2122     struct builtin_term *termp;
2123 #ifdef HAVE_TGETENT
2124     char_u  *string;
2125     int	    i;
2126     int	    builtin_first;
2127     char_u  tbuf[TBUFSZ];
2128     char_u  tstrbuf[TBUFSZ];
2129     char_u  *tp = tstrbuf;
2130     char_u  *error_msg = NULL;
2131 #endif
2132 
2133 /*
2134  * If the GUI is running or will start in a moment, we only support the keys
2135  * that the GUI can produce.
2136  */
2137 #ifdef FEAT_GUI
2138     if (gui.in_use || gui.starting)
2139 	return gui_mch_haskey(name);
2140 #endif
2141 
2142     if (!force && find_termcode(name) != NULL)	    /* it's already there */
2143 	return OK;
2144 
2145     term = T_NAME;
2146     if (term == NULL || *term == NUL)	    /* 'term' not defined yet */
2147 	return FAIL;
2148 
2149     if (term_is_builtin(term))		    /* name starts with "builtin_" */
2150     {
2151 	term += 8;
2152 #ifdef HAVE_TGETENT
2153 	builtin_first = TRUE;
2154 #endif
2155     }
2156 #ifdef HAVE_TGETENT
2157     else
2158 	builtin_first = p_tbi;
2159 #endif
2160 
2161 #ifdef HAVE_TGETENT
2162 /*
2163  * We can get the entry from the builtin termcap and from the external one.
2164  * If 'ttybuiltin' is on or the terminal name starts with "builtin_", try
2165  * builtin termcap first.
2166  * If 'ttybuiltin' is off, try external termcap first.
2167  */
2168     for (i = 0; i < 2; ++i)
2169     {
2170 	if ((!builtin_first) == i)
2171 #endif
2172 	/*
2173 	 * Search in builtin termcap
2174 	 */
2175 	{
2176 	    termp = find_builtin_term(term);
2177 	    if (termp->bt_string != NULL)	/* found it */
2178 	    {
2179 		key = TERMCAP2KEY(name[0], name[1]);
2180 		while (termp->bt_entry != (int)KS_NAME)
2181 		{
2182 		    if ((int)termp->bt_entry == key)
2183 		    {
2184 			add_termcode(name, (char_u *)termp->bt_string,
2185 							  term_is_8bit(term));
2186 			return OK;
2187 		    }
2188 		    ++termp;
2189 		}
2190 	    }
2191 	}
2192 #ifdef HAVE_TGETENT
2193 	else
2194 	/*
2195 	 * Search in external termcap
2196 	 */
2197 	{
2198 	    error_msg = tgetent_error(tbuf, term);
2199 	    if (error_msg == NULL)
2200 	    {
2201 		string = TGETSTR((char *)name, &tp);
2202 		if (string != NULL && *string != NUL)
2203 		{
2204 		    add_termcode(name, string, FALSE);
2205 		    return OK;
2206 		}
2207 	    }
2208 	}
2209     }
2210 #endif
2211 
2212     if (sourcing_name == NULL)
2213     {
2214 #ifdef HAVE_TGETENT
2215 	if (error_msg != NULL)
2216 	    EMSG(error_msg);
2217 	else
2218 #endif
2219 	    EMSG2(_("E436: No \"%s\" entry in termcap"), name);
2220     }
2221     return FAIL;
2222 }
2223 
2224     static int
2225 term_is_builtin(char_u *name)
2226 {
2227     return (STRNCMP(name, "builtin_", (size_t)8) == 0);
2228 }
2229 
2230 /*
2231  * Return TRUE if terminal "name" uses CSI instead of <Esc>[.
2232  * Assume that the terminal is using 8-bit controls when the name contains
2233  * "8bit", like in "xterm-8bit".
2234  */
2235     int
2236 term_is_8bit(char_u *name)
2237 {
2238     return (detected_8bit || strstr((char *)name, "8bit") != NULL);
2239 }
2240 
2241 /*
2242  * Translate terminal control chars from 7-bit to 8-bit:
2243  * <Esc>[ -> CSI
2244  * <Esc>] -> <M-C-]>
2245  * <Esc>O -> <M-C-O>
2246  */
2247     static int
2248 term_7to8bit(char_u *p)
2249 {
2250     if (*p == ESC)
2251     {
2252 	if (p[1] == '[')
2253 	    return CSI;
2254 	if (p[1] == ']')
2255 	    return OSC;
2256 	if (p[1] == 'O')
2257 	    return 0x8f;
2258     }
2259     return 0;
2260 }
2261 
2262 #ifdef FEAT_GUI
2263     int
2264 term_is_gui(char_u *name)
2265 {
2266     return (STRCMP(name, "builtin_gui") == 0 || STRCMP(name, "gui") == 0);
2267 }
2268 #endif
2269 
2270 #if !defined(HAVE_TGETENT) || defined(AMIGA) || defined(PROTO)
2271 
2272     char_u *
2273 tltoa(unsigned long i)
2274 {
2275     static char_u buf[16];
2276     char_u	*p;
2277 
2278     p = buf + 15;
2279     *p = '\0';
2280     do
2281     {
2282 	--p;
2283 	*p = (char_u) (i % 10 + '0');
2284 	i /= 10;
2285     }
2286     while (i > 0 && p > buf);
2287     return p;
2288 }
2289 #endif
2290 
2291 #ifndef HAVE_TGETENT
2292 
2293 /*
2294  * minimal tgoto() implementation.
2295  * no padding and we only parse for %i %d and %+char
2296  */
2297 static char *tgoto(char *, int, int);
2298 
2299     static char *
2300 tgoto(char *cm, int x, int y)
2301 {
2302     static char buf[30];
2303     char *p, *s, *e;
2304 
2305     if (!cm)
2306 	return "OOPS";
2307     e = buf + 29;
2308     for (s = buf; s < e && *cm; cm++)
2309     {
2310 	if (*cm != '%')
2311 	{
2312 	    *s++ = *cm;
2313 	    continue;
2314 	}
2315 	switch (*++cm)
2316 	{
2317 	case 'd':
2318 	    p = (char *)tltoa((unsigned long)y);
2319 	    y = x;
2320 	    while (*p)
2321 		*s++ = *p++;
2322 	    break;
2323 	case 'i':
2324 	    x++;
2325 	    y++;
2326 	    break;
2327 	case '+':
2328 	    *s++ = (char)(*++cm + y);
2329 	    y = x;
2330 	    break;
2331 	case '%':
2332 	    *s++ = *cm;
2333 	    break;
2334 	default:
2335 	    return "OOPS";
2336 	}
2337     }
2338     *s = '\0';
2339     return buf;
2340 }
2341 
2342 #endif /* HAVE_TGETENT */
2343 
2344 /*
2345  * Set the terminal name and initialize the terminal options.
2346  * If "name" is NULL or empty, get the terminal name from the environment.
2347  * If that fails, use the default terminal name.
2348  */
2349     void
2350 termcapinit(char_u *name)
2351 {
2352     char_u	*term;
2353 
2354     if (name != NULL && *name == NUL)
2355 	name = NULL;	    /* empty name is equal to no name */
2356     term = name;
2357 
2358 #ifdef __BEOS__
2359     /*
2360      * TERM environment variable is normally set to 'ansi' on the Bebox;
2361      * Since the BeBox doesn't quite support full ANSI yet, we use our
2362      * own custom 'ansi-beos' termcap instead, unless the -T option has
2363      * been given on the command line.
2364      */
2365     if (term == NULL
2366 		 && strcmp((char *)mch_getenv((char_u *)"TERM"), "ansi") == 0)
2367 	term = DEFAULT_TERM;
2368 #endif
2369 #ifndef MSWIN
2370     if (term == NULL)
2371 	term = mch_getenv((char_u *)"TERM");
2372 #endif
2373     if (term == NULL || *term == NUL)
2374 	term = DEFAULT_TERM;
2375     set_string_option_direct((char_u *)"term", -1, term, OPT_FREE, 0);
2376 
2377     /* Set the default terminal name. */
2378     set_string_default("term", term);
2379     set_string_default("ttytype", term);
2380 
2381     /*
2382      * Avoid using "term" here, because the next mch_getenv() may overwrite it.
2383      */
2384     set_termname(T_NAME != NULL ? T_NAME : term);
2385 }
2386 
2387 /*
2388  * the number of calls to ui_write is reduced by using the buffer "out_buf"
2389  */
2390 #define OUT_SIZE	2047
2391 	    /* Add one to allow mch_write() in os_win32.c to append a NUL */
2392 static char_u		out_buf[OUT_SIZE + 1];
2393 static int		out_pos = 0;	/* number of chars in out_buf */
2394 
2395 /*
2396  * out_flush(): flush the output buffer
2397  */
2398     void
2399 out_flush(void)
2400 {
2401     int	    len;
2402 
2403     if (out_pos != 0)
2404     {
2405 	/* set out_pos to 0 before ui_write, to avoid recursiveness */
2406 	len = out_pos;
2407 	out_pos = 0;
2408 	ui_write(out_buf, len);
2409     }
2410 }
2411 
2412 #if defined(FEAT_MBYTE) || defined(PROTO)
2413 /*
2414  * Sometimes a byte out of a multi-byte character is written with out_char().
2415  * To avoid flushing half of the character, call this function first.
2416  */
2417     void
2418 out_flush_check(void)
2419 {
2420     if (enc_dbcs != 0 && out_pos >= OUT_SIZE - MB_MAXBYTES)
2421 	out_flush();
2422 }
2423 #endif
2424 
2425 #ifdef FEAT_GUI
2426 /*
2427  * out_trash(): Throw away the contents of the output buffer
2428  */
2429     void
2430 out_trash(void)
2431 {
2432     out_pos = 0;
2433 }
2434 #endif
2435 
2436 /*
2437  * out_char(c): put a byte into the output buffer.
2438  *		Flush it if it becomes full.
2439  * This should not be used for outputting text on the screen (use functions
2440  * like msg_puts() and screen_putchar() for that).
2441  */
2442     void
2443 out_char(unsigned c)
2444 {
2445 #if defined(UNIX) || defined(VMS) || defined(AMIGA) || defined(MACOS_X_UNIX)
2446     if (c == '\n')	/* turn LF into CR-LF (CRMOD doesn't seem to do this) */
2447 	out_char('\r');
2448 #endif
2449 
2450     out_buf[out_pos++] = c;
2451 
2452     /* For testing we flush each time. */
2453     if (out_pos >= OUT_SIZE || p_wd)
2454 	out_flush();
2455 }
2456 
2457 static void out_char_nf(unsigned);
2458 
2459 /*
2460  * out_char_nf(c): like out_char(), but don't flush when p_wd is set
2461  */
2462     static void
2463 out_char_nf(unsigned c)
2464 {
2465 #if defined(UNIX) || defined(VMS) || defined(AMIGA) || defined(MACOS_X_UNIX)
2466     if (c == '\n')	/* turn LF into CR-LF (CRMOD doesn't seem to do this) */
2467 	out_char_nf('\r');
2468 #endif
2469 
2470     out_buf[out_pos++] = c;
2471 
2472     if (out_pos >= OUT_SIZE)
2473 	out_flush();
2474 }
2475 
2476 #if defined(FEAT_TITLE) || defined(FEAT_MOUSE_TTY) || defined(FEAT_GUI) \
2477     || defined(FEAT_TERMRESPONSE) || defined(PROTO)
2478 /*
2479  * A never-padding out_str.
2480  * use this whenever you don't want to run the string through tputs.
2481  * tputs above is harmless, but tputs from the termcap library
2482  * is likely to strip off leading digits, that it mistakes for padding
2483  * information, and "%i", "%d", etc.
2484  * This should only be used for writing terminal codes, not for outputting
2485  * normal text (use functions like msg_puts() and screen_putchar() for that).
2486  */
2487     void
2488 out_str_nf(char_u *s)
2489 {
2490     if (out_pos > OUT_SIZE - 20)  /* avoid terminal strings being split up */
2491 	out_flush();
2492     while (*s)
2493 	out_char_nf(*s++);
2494 
2495     /* For testing we write one string at a time. */
2496     if (p_wd)
2497 	out_flush();
2498 }
2499 #endif
2500 
2501 /*
2502  * out_str(s): Put a character string a byte at a time into the output buffer.
2503  * If HAVE_TGETENT is defined use the termcap parser. (jw)
2504  * This should only be used for writing terminal codes, not for outputting
2505  * normal text (use functions like msg_puts() and screen_putchar() for that).
2506  */
2507     void
2508 out_str(char_u *s)
2509 {
2510     if (s != NULL && *s)
2511     {
2512 #ifdef FEAT_GUI
2513 	/* Don't use tputs() when GUI is used, ncurses crashes. */
2514 	if (gui.in_use)
2515 	{
2516 	    out_str_nf(s);
2517 	    return;
2518 	}
2519 #endif
2520 	/* avoid terminal strings being split up */
2521 	if (out_pos > OUT_SIZE - 20)
2522 	    out_flush();
2523 #ifdef HAVE_TGETENT
2524 	tputs((char *)s, 1, TPUTSFUNCAST out_char_nf);
2525 #else
2526 	while (*s)
2527 	    out_char_nf(*s++);
2528 #endif
2529 
2530 	/* For testing we write one string at a time. */
2531 	if (p_wd)
2532 	    out_flush();
2533     }
2534 }
2535 
2536 /*
2537  * cursor positioning using termcap parser. (jw)
2538  */
2539     void
2540 term_windgoto(int row, int col)
2541 {
2542     OUT_STR(tgoto((char *)T_CM, col, row));
2543 }
2544 
2545     void
2546 term_cursor_right(int i)
2547 {
2548     OUT_STR(tgoto((char *)T_CRI, 0, i));
2549 }
2550 
2551     void
2552 term_append_lines(int line_count)
2553 {
2554     OUT_STR(tgoto((char *)T_CAL, 0, line_count));
2555 }
2556 
2557     void
2558 term_delete_lines(int line_count)
2559 {
2560     OUT_STR(tgoto((char *)T_CDL, 0, line_count));
2561 }
2562 
2563 #if defined(HAVE_TGETENT) || defined(PROTO)
2564     void
2565 term_set_winpos(int x, int y)
2566 {
2567     /* Can't handle a negative value here */
2568     if (x < 0)
2569 	x = 0;
2570     if (y < 0)
2571 	y = 0;
2572     OUT_STR(tgoto((char *)T_CWP, y, x));
2573 }
2574 
2575     void
2576 term_set_winsize(int width, int height)
2577 {
2578     OUT_STR(tgoto((char *)T_CWS, height, width));
2579 }
2580 #endif
2581 
2582     void
2583 term_fg_color(int n)
2584 {
2585     /* Use "AF" termcap entry if present, "Sf" entry otherwise */
2586     if (*T_CAF)
2587 	term_color(T_CAF, n);
2588     else if (*T_CSF)
2589 	term_color(T_CSF, n);
2590 }
2591 
2592     void
2593 term_bg_color(int n)
2594 {
2595     /* Use "AB" termcap entry if present, "Sb" entry otherwise */
2596     if (*T_CAB)
2597 	term_color(T_CAB, n);
2598     else if (*T_CSB)
2599 	term_color(T_CSB, n);
2600 }
2601 
2602     static void
2603 term_color(char_u *s, int n)
2604 {
2605     char	buf[20];
2606     int i = 2;	/* index in s[] just after <Esc>[ or CSI */
2607 
2608     /* Special handling of 16 colors, because termcap can't handle it */
2609     /* Also accept "\e[3%dm" for TERMINFO, it is sometimes used */
2610     /* Also accept CSI instead of <Esc>[ */
2611     if (n >= 8 && t_colors >= 16
2612 	      && ((s[0] == ESC && s[1] == '[') || (s[0] == CSI && (i = 1) == 1))
2613 	      && s[i] != NUL
2614 	      && (STRCMP(s + i + 1, "%p1%dm") == 0
2615 		  || STRCMP(s + i + 1, "%dm") == 0)
2616 	      && (s[i] == '3' || s[i] == '4'))
2617     {
2618 #ifdef TERMINFO
2619 	char *format = "%s%s%%p1%%dm";
2620 #else
2621 	char *format = "%s%s%%dm";
2622 #endif
2623 	sprintf(buf, format,
2624 		i == 2 ? IF_EB("\033[", ESC_STR "[") : "\233",
2625 		s[i] == '3' ? (n >= 16 ? "38;5;" : "9")
2626 			    : (n >= 16 ? "48;5;" : "10"));
2627 	OUT_STR(tgoto(buf, 0, n >= 16 ? n : n - 8));
2628     }
2629     else
2630 	OUT_STR(tgoto((char *)s, 0, n));
2631 }
2632 
2633 #if defined(FEAT_TERMGUICOLORS) || defined(PROTO)
2634 
2635 #define RED(rgb)   (((long_u)(rgb) >> 16) & 0xFF)
2636 #define GREEN(rgb) (((long_u)(rgb) >>  8) & 0xFF)
2637 #define BLUE(rgb)  (((long_u)(rgb)      ) & 0xFF)
2638 
2639     static void
2640 term_rgb_color(char_u *s, guicolor_T rgb)
2641 {
2642 #define MAX_COLOR_STR_LEN 100
2643     char	buf[MAX_COLOR_STR_LEN];
2644 
2645     vim_snprintf(buf, MAX_COLOR_STR_LEN,
2646 				  (char *)s, RED(rgb), GREEN(rgb), BLUE(rgb));
2647     OUT_STR(buf);
2648 }
2649 
2650     void
2651 term_fg_rgb_color(guicolor_T rgb)
2652 {
2653     term_rgb_color(T_8F, rgb);
2654 }
2655 
2656     void
2657 term_bg_rgb_color(guicolor_T rgb)
2658 {
2659     term_rgb_color(T_8B, rgb);
2660 }
2661 #endif
2662 
2663 #if (defined(FEAT_TITLE) && (defined(UNIX) || defined(VMS) \
2664 	|| defined(MACOS_X))) || defined(PROTO)
2665 /*
2666  * Generic function to set window title, using t_ts and t_fs.
2667  */
2668     void
2669 term_settitle(char_u *title)
2670 {
2671     /* t_ts takes one argument: column in status line */
2672     OUT_STR(tgoto((char *)T_TS, 0, 0));	/* set title start */
2673     out_str_nf(title);
2674     out_str(T_FS);			/* set title end */
2675     out_flush();
2676 }
2677 #endif
2678 
2679 /*
2680  * Make sure we have a valid set or terminal options.
2681  * Replace all entries that are NULL by empty_option
2682  */
2683     void
2684 ttest(int pairs)
2685 {
2686     check_options();		    /* make sure no options are NULL */
2687 
2688     /*
2689      * MUST have "cm": cursor motion.
2690      */
2691     if (*T_CM == NUL)
2692 	EMSG(_("E437: terminal capability \"cm\" required"));
2693 
2694     /*
2695      * if "cs" defined, use a scroll region, it's faster.
2696      */
2697     if (*T_CS != NUL)
2698 	scroll_region = TRUE;
2699     else
2700 	scroll_region = FALSE;
2701 
2702     if (pairs)
2703     {
2704 	/*
2705 	 * optional pairs
2706 	 */
2707 	/* TP goes to normal mode for TI (invert) and TB (bold) */
2708 	if (*T_ME == NUL)
2709 	    T_ME = T_MR = T_MD = T_MB = empty_option;
2710 	if (*T_SO == NUL || *T_SE == NUL)
2711 	    T_SO = T_SE = empty_option;
2712 	if (*T_US == NUL || *T_UE == NUL)
2713 	    T_US = T_UE = empty_option;
2714 	if (*T_CZH == NUL || *T_CZR == NUL)
2715 	    T_CZH = T_CZR = empty_option;
2716 
2717 	/* T_VE is needed even though T_VI is not defined */
2718 	if (*T_VE == NUL)
2719 	    T_VI = empty_option;
2720 
2721 	/* if 'mr' or 'me' is not defined use 'so' and 'se' */
2722 	if (*T_ME == NUL)
2723 	{
2724 	    T_ME = T_SE;
2725 	    T_MR = T_SO;
2726 	    T_MD = T_SO;
2727 	}
2728 
2729 	/* if 'so' or 'se' is not defined use 'mr' and 'me' */
2730 	if (*T_SO == NUL)
2731 	{
2732 	    T_SE = T_ME;
2733 	    if (*T_MR == NUL)
2734 		T_SO = T_MD;
2735 	    else
2736 		T_SO = T_MR;
2737 	}
2738 
2739 	/* if 'ZH' or 'ZR' is not defined use 'mr' and 'me' */
2740 	if (*T_CZH == NUL)
2741 	{
2742 	    T_CZR = T_ME;
2743 	    if (*T_MR == NUL)
2744 		T_CZH = T_MD;
2745 	    else
2746 		T_CZH = T_MR;
2747 	}
2748 
2749 	/* "Sb" and "Sf" come in pairs */
2750 	if (*T_CSB == NUL || *T_CSF == NUL)
2751 	{
2752 	    T_CSB = empty_option;
2753 	    T_CSF = empty_option;
2754 	}
2755 
2756 	/* "AB" and "AF" come in pairs */
2757 	if (*T_CAB == NUL || *T_CAF == NUL)
2758 	{
2759 	    T_CAB = empty_option;
2760 	    T_CAF = empty_option;
2761 	}
2762 
2763 	/* if 'Sb' and 'AB' are not defined, reset "Co" */
2764 	if (*T_CSB == NUL && *T_CAB == NUL)
2765 	    free_one_termoption(T_CCO);
2766 
2767 	/* Set 'weirdinvert' according to value of 't_xs' */
2768 	p_wiv = (*T_XS != NUL);
2769     }
2770     need_gather = TRUE;
2771 
2772     /* Set t_colors to the value of t_Co. */
2773     t_colors = atoi((char *)T_CCO);
2774 }
2775 
2776 #if (defined(FEAT_GUI) && (defined(FEAT_MENU) || !defined(USE_ON_FLY_SCROLL))) \
2777 	|| defined(PROTO)
2778 /*
2779  * Represent the given long_u as individual bytes, with the most significant
2780  * byte first, and store them in dst.
2781  */
2782     void
2783 add_long_to_buf(long_u val, char_u *dst)
2784 {
2785     int	    i;
2786     int	    shift;
2787 
2788     for (i = 1; i <= (int)sizeof(long_u); i++)
2789     {
2790 	shift = 8 * (sizeof(long_u) - i);
2791 	dst[i - 1] = (char_u) ((val >> shift) & 0xff);
2792     }
2793 }
2794 
2795 static int get_long_from_buf(char_u *buf, long_u *val);
2796 
2797 /*
2798  * Interpret the next string of bytes in buf as a long integer, with the most
2799  * significant byte first.  Note that it is assumed that buf has been through
2800  * inchar(), so that NUL and K_SPECIAL will be represented as three bytes each.
2801  * Puts result in val, and returns the number of bytes read from buf
2802  * (between sizeof(long_u) and 2 * sizeof(long_u)), or -1 if not enough bytes
2803  * were present.
2804  */
2805     static int
2806 get_long_from_buf(char_u *buf, long_u *val)
2807 {
2808     int	    len;
2809     char_u  bytes[sizeof(long_u)];
2810     int	    i;
2811     int	    shift;
2812 
2813     *val = 0;
2814     len = get_bytes_from_buf(buf, bytes, (int)sizeof(long_u));
2815     if (len != -1)
2816     {
2817 	for (i = 0; i < (int)sizeof(long_u); i++)
2818 	{
2819 	    shift = 8 * (sizeof(long_u) - 1 - i);
2820 	    *val += (long_u)bytes[i] << shift;
2821 	}
2822     }
2823     return len;
2824 }
2825 #endif
2826 
2827 #if defined(FEAT_GUI) \
2828     || (defined(FEAT_MOUSE) && (!defined(UNIX) || defined(FEAT_MOUSE_XTERM) \
2829 		|| defined(FEAT_MOUSE_GPM) || defined(FEAT_SYSMOUSE)))
2830 /*
2831  * Read the next num_bytes bytes from buf, and store them in bytes.  Assume
2832  * that buf has been through inchar().	Returns the actual number of bytes used
2833  * from buf (between num_bytes and num_bytes*2), or -1 if not enough bytes were
2834  * available.
2835  */
2836     static int
2837 get_bytes_from_buf(char_u *buf, char_u *bytes, int num_bytes)
2838 {
2839     int	    len = 0;
2840     int	    i;
2841     char_u  c;
2842 
2843     for (i = 0; i < num_bytes; i++)
2844     {
2845 	if ((c = buf[len++]) == NUL)
2846 	    return -1;
2847 	if (c == K_SPECIAL)
2848 	{
2849 	    if (buf[len] == NUL || buf[len + 1] == NUL)	    /* cannot happen? */
2850 		return -1;
2851 	    if (buf[len++] == (int)KS_ZERO)
2852 		c = NUL;
2853 	    /* else it should be KS_SPECIAL; when followed by KE_FILLER c is
2854 	     * K_SPECIAL, or followed by KE_CSI and c must be CSI. */
2855 	    if (buf[len++] == (int)KE_CSI)
2856 		c = CSI;
2857 	}
2858 	else if (c == CSI && buf[len] == KS_EXTRA
2859 					       && buf[len + 1] == (int)KE_CSI)
2860 	    /* CSI is stored as CSI KS_SPECIAL KE_CSI to avoid confusion with
2861 	     * the start of a special key, see add_to_input_buf_csi(). */
2862 	    len += 2;
2863 	bytes[i] = c;
2864     }
2865     return len;
2866 }
2867 #endif
2868 
2869 /*
2870  * Check if the new shell size is valid, correct it if it's too small or way
2871  * too big.
2872  */
2873     void
2874 check_shellsize(void)
2875 {
2876     if (Rows < min_rows())	/* need room for one window and command line */
2877 	Rows = min_rows();
2878     limit_screen_size();
2879 }
2880 
2881 /*
2882  * Limit Rows and Columns to avoid an overflow in Rows * Columns.
2883  */
2884     void
2885 limit_screen_size(void)
2886 {
2887     if (Columns < MIN_COLUMNS)
2888 	Columns = MIN_COLUMNS;
2889     else if (Columns > 10000)
2890 	Columns = 10000;
2891     if (Rows > 1000)
2892 	Rows = 1000;
2893 }
2894 
2895 /*
2896  * Invoked just before the screen structures are going to be (re)allocated.
2897  */
2898     void
2899 win_new_shellsize(void)
2900 {
2901     static int	old_Rows = 0;
2902     static int	old_Columns = 0;
2903 
2904     if (old_Rows != Rows || old_Columns != Columns)
2905 	ui_new_shellsize();
2906     if (old_Rows != Rows)
2907     {
2908 	/* if 'window' uses the whole screen, keep it using that */
2909 	if (p_window == old_Rows - 1 || old_Rows == 0)
2910 	    p_window = Rows - 1;
2911 	old_Rows = Rows;
2912 	shell_new_rows();	/* update window sizes */
2913     }
2914     if (old_Columns != Columns)
2915     {
2916 	old_Columns = Columns;
2917 #ifdef FEAT_WINDOWS
2918 	shell_new_columns();	/* update window sizes */
2919 #endif
2920     }
2921 }
2922 
2923 /*
2924  * Call this function when the Vim shell has been resized in any way.
2925  * Will obtain the current size and redraw (also when size didn't change).
2926  */
2927     void
2928 shell_resized(void)
2929 {
2930     set_shellsize(0, 0, FALSE);
2931 }
2932 
2933 /*
2934  * Check if the shell size changed.  Handle a resize.
2935  * When the size didn't change, nothing happens.
2936  */
2937     void
2938 shell_resized_check(void)
2939 {
2940     int		old_Rows = Rows;
2941     int		old_Columns = Columns;
2942 
2943     if (!exiting
2944 #ifdef FEAT_GUI
2945 	    /* Do not get the size when executing a shell command during
2946 	     * startup. */
2947 	    && !gui.starting
2948 #endif
2949 	    )
2950     {
2951 	(void)ui_get_shellsize();
2952 	check_shellsize();
2953 	if (old_Rows != Rows || old_Columns != Columns)
2954 	    shell_resized();
2955     }
2956 }
2957 
2958 /*
2959  * Set size of the Vim shell.
2960  * If 'mustset' is TRUE, we must set Rows and Columns, do not get the real
2961  * window size (this is used for the :win command).
2962  * If 'mustset' is FALSE, we may try to get the real window size and if
2963  * it fails use 'width' and 'height'.
2964  */
2965     void
2966 set_shellsize(int width, int height, int mustset)
2967 {
2968     static int		busy = FALSE;
2969 
2970     /*
2971      * Avoid recursiveness, can happen when setting the window size causes
2972      * another window-changed signal.
2973      */
2974     if (busy)
2975 	return;
2976 
2977     if (width < 0 || height < 0)    /* just checking... */
2978 	return;
2979 
2980     if (State == HITRETURN || State == SETWSIZE)
2981     {
2982 	/* postpone the resizing */
2983 	State = SETWSIZE;
2984 	return;
2985     }
2986 
2987     /* curwin->w_buffer can be NULL when we are closing a window and the
2988      * buffer has already been closed and removing a scrollbar causes a resize
2989      * event. Don't resize then, it will happen after entering another buffer.
2990      */
2991     if (curwin->w_buffer == NULL)
2992 	return;
2993 
2994     ++busy;
2995 
2996 #ifdef AMIGA
2997     out_flush();	    /* must do this before mch_get_shellsize() for
2998 			       some obscure reason */
2999 #endif
3000 
3001     if (mustset || (ui_get_shellsize() == FAIL && height != 0))
3002     {
3003 	Rows = height;
3004 	Columns = width;
3005 	check_shellsize();
3006 	ui_set_shellsize(mustset);
3007     }
3008     else
3009 	check_shellsize();
3010 
3011     /* The window layout used to be adjusted here, but it now happens in
3012      * screenalloc() (also invoked from screenclear()).  That is because the
3013      * "busy" check above may skip this, but not screenalloc(). */
3014 
3015     if (State != ASKMORE && State != EXTERNCMD && State != CONFIRM)
3016 	screenclear();
3017     else
3018 	screen_start();	    /* don't know where cursor is now */
3019 
3020     if (starting != NO_SCREEN)
3021     {
3022 #ifdef FEAT_TITLE
3023 	maketitle();
3024 #endif
3025 	changed_line_abv_curs();
3026 	invalidate_botline();
3027 
3028 	/*
3029 	 * We only redraw when it's needed:
3030 	 * - While at the more prompt or executing an external command, don't
3031 	 *   redraw, but position the cursor.
3032 	 * - While editing the command line, only redraw that.
3033 	 * - in Ex mode, don't redraw anything.
3034 	 * - Otherwise, redraw right now, and position the cursor.
3035 	 * Always need to call update_screen() or screenalloc(), to make
3036 	 * sure Rows/Columns and the size of ScreenLines[] is correct!
3037 	 */
3038 	if (State == ASKMORE || State == EXTERNCMD || State == CONFIRM
3039 							     || exmode_active)
3040 	{
3041 	    screenalloc(FALSE);
3042 	    repeat_message();
3043 	}
3044 	else
3045 	{
3046 #ifdef FEAT_SCROLLBIND
3047 	    if (curwin->w_p_scb)
3048 		do_check_scrollbind(TRUE);
3049 #endif
3050 	    if (State & CMDLINE)
3051 	    {
3052 		update_screen(NOT_VALID);
3053 		redrawcmdline();
3054 	    }
3055 	    else
3056 	    {
3057 		update_topline();
3058 #if defined(FEAT_INS_EXPAND)
3059 		if (pum_visible())
3060 		{
3061 		    redraw_later(NOT_VALID);
3062 		    ins_compl_show_pum(); /* This includes the redraw. */
3063 		}
3064 		else
3065 #endif
3066 		    update_screen(NOT_VALID);
3067 		if (redrawing())
3068 		    setcursor();
3069 	    }
3070 	}
3071 	cursor_on();	    /* redrawing may have switched it off */
3072     }
3073     out_flush();
3074     --busy;
3075 }
3076 
3077 /*
3078  * Set the terminal to TMODE_RAW (for Normal mode) or TMODE_COOK (for external
3079  * commands and Ex mode).
3080  */
3081     void
3082 settmode(int tmode)
3083 {
3084 #ifdef FEAT_GUI
3085     /* don't set the term where gvim was started to any mode */
3086     if (gui.in_use)
3087 	return;
3088 #endif
3089 
3090     if (full_screen)
3091     {
3092 	/*
3093 	 * When returning after calling a shell we want to really set the
3094 	 * terminal to raw mode, even though we think it already is, because
3095 	 * the shell program may have reset the terminal mode.
3096 	 * When we think the terminal is normal, don't try to set it to
3097 	 * normal again, because that causes problems (logout!) on some
3098 	 * machines.
3099 	 */
3100 	if (tmode != TMODE_COOK || cur_tmode != TMODE_COOK)
3101 	{
3102 #ifdef FEAT_TERMRESPONSE
3103 # ifdef FEAT_GUI
3104 	    if (!gui.in_use && !gui.starting)
3105 # endif
3106 	    {
3107 		/* May need to check for T_CRV response and termcodes, it
3108 		 * doesn't work in Cooked mode, an external program may get
3109 		 * them. */
3110 		if (tmode != TMODE_RAW && (crv_status == CRV_SENT
3111 					 || u7_status == U7_SENT
3112 					 || rbg_status == RBG_SENT))
3113 		    (void)vpeekc_nomap();
3114 		check_for_codes_from_term();
3115 	    }
3116 #endif
3117 #ifdef FEAT_MOUSE_TTY
3118 	    if (tmode != TMODE_RAW)
3119 		mch_setmouse(FALSE);		/* switch mouse off */
3120 #endif
3121 	    out_flush();
3122 	    mch_settmode(tmode);    /* machine specific function */
3123 	    cur_tmode = tmode;
3124 #ifdef FEAT_MOUSE
3125 	    if (tmode == TMODE_RAW)
3126 		setmouse();			/* may switch mouse on */
3127 #endif
3128 	    out_flush();
3129 	}
3130 #ifdef FEAT_TERMRESPONSE
3131 	may_req_termresponse();
3132 #endif
3133     }
3134 }
3135 
3136     void
3137 starttermcap(void)
3138 {
3139     if (full_screen && !termcap_active)
3140     {
3141 	out_str(T_TI);			/* start termcap mode */
3142 	out_str(T_KS);			/* start "keypad transmit" mode */
3143 	out_flush();
3144 	termcap_active = TRUE;
3145 	screen_start();			/* don't know where cursor is now */
3146 #ifdef FEAT_TERMRESPONSE
3147 # ifdef FEAT_GUI
3148 	if (!gui.in_use && !gui.starting)
3149 # endif
3150 	{
3151 	    may_req_termresponse();
3152 	    /* Immediately check for a response.  If t_Co changes, we don't
3153 	     * want to redraw with wrong colors first. */
3154 	    if (crv_status == CRV_SENT)
3155 		check_for_codes_from_term();
3156 	}
3157 #endif
3158     }
3159 }
3160 
3161     void
3162 stoptermcap(void)
3163 {
3164     screen_stop_highlight();
3165     reset_cterm_colors();
3166     if (termcap_active)
3167     {
3168 #ifdef FEAT_TERMRESPONSE
3169 # ifdef FEAT_GUI
3170 	if (!gui.in_use && !gui.starting)
3171 # endif
3172 	{
3173 	    /* May need to discard T_CRV, T_U7 or T_RBG response. */
3174 	    if (crv_status == CRV_SENT || u7_status == U7_SENT
3175 						     || rbg_status == RBG_SENT)
3176 	    {
3177 # ifdef UNIX
3178 		/* Give the terminal a chance to respond. */
3179 		mch_delay(100L, FALSE);
3180 # endif
3181 # ifdef TCIFLUSH
3182 		/* Discard data received but not read. */
3183 		if (exiting)
3184 		    tcflush(fileno(stdin), TCIFLUSH);
3185 # endif
3186 	    }
3187 	    /* Check for termcodes first, otherwise an external program may
3188 	     * get them. */
3189 	    check_for_codes_from_term();
3190 	}
3191 #endif
3192 	out_str(T_KE);			/* stop "keypad transmit" mode */
3193 	out_flush();
3194 	termcap_active = FALSE;
3195 	cursor_on();			/* just in case it is still off */
3196 	out_str(T_TE);			/* stop termcap mode */
3197 	screen_start();			/* don't know where cursor is now */
3198 	out_flush();
3199     }
3200 }
3201 
3202 #if defined(FEAT_TERMRESPONSE) || defined(PROTO)
3203 /*
3204  * Request version string (for xterm) when needed.
3205  * Only do this after switching to raw mode, otherwise the result will be
3206  * echoed.
3207  * Only do this after startup has finished, to avoid that the response comes
3208  * while executing "-c !cmd" or even after "-c quit".
3209  * Only do this after termcap mode has been started, otherwise the codes for
3210  * the cursor keys may be wrong.
3211  * Only do this when 'esckeys' is on, otherwise the response causes trouble in
3212  * Insert mode.
3213  * On Unix only do it when both output and input are a tty (avoid writing
3214  * request to terminal while reading from a file).
3215  * The result is caught in check_termcode().
3216  */
3217     void
3218 may_req_termresponse(void)
3219 {
3220     if (crv_status == CRV_GET
3221 	    && cur_tmode == TMODE_RAW
3222 	    && starting == 0
3223 	    && termcap_active
3224 	    && p_ek
3225 # ifdef UNIX
3226 	    && isatty(1)
3227 	    && isatty(read_cmd_fd)
3228 # endif
3229 	    && *T_CRV != NUL)
3230     {
3231 	LOG_TR("Sending CRV");
3232 	out_str(T_CRV);
3233 	crv_status = CRV_SENT;
3234 	/* check for the characters now, otherwise they might be eaten by
3235 	 * get_keystroke() */
3236 	out_flush();
3237 	(void)vpeekc_nomap();
3238     }
3239 }
3240 
3241 # if defined(FEAT_MBYTE) || defined(PROTO)
3242 /*
3243  * Check how the terminal treats ambiguous character width (UAX #11).
3244  * First, we move the cursor to (1, 0) and print a test ambiguous character
3245  * \u25bd (WHITE DOWN-POINTING TRIANGLE) and query current cursor position.
3246  * If the terminal treats \u25bd as single width, the position is (1, 1),
3247  * or if it is treated as double width, that will be (1, 2).
3248  * This function has the side effect that changes cursor position, so
3249  * it must be called immediately after entering termcap mode.
3250  */
3251     void
3252 may_req_ambiguous_char_width(void)
3253 {
3254     if (u7_status == U7_GET
3255 	    && cur_tmode == TMODE_RAW
3256 	    && termcap_active
3257 	    && p_ek
3258 #  ifdef UNIX
3259 	    && isatty(1)
3260 	    && isatty(read_cmd_fd)
3261 #  endif
3262 	    && *T_U7 != NUL
3263 	    && !option_was_set((char_u *)"ambiwidth"))
3264     {
3265 	 char_u	buf[16];
3266 
3267 	 LOG_TR("Sending U7 request");
3268 	 /* Do this in the second row.  In the first row the returned sequence
3269 	  * may be CSI 1;2R, which is the same as <S-F3>. */
3270 	 term_windgoto(1, 0);
3271 	 buf[mb_char2bytes(0x25bd, buf)] = 0;
3272 	 out_str(buf);
3273 	 out_str(T_U7);
3274 	 u7_status = U7_SENT;
3275 	 out_flush();
3276 	 term_windgoto(1, 0);
3277 	 out_str((char_u *)"  ");
3278 	 term_windgoto(0, 0);
3279 	 /* check for the characters now, otherwise they might be eaten by
3280 	  * get_keystroke() */
3281 	 out_flush();
3282 	 (void)vpeekc_nomap();
3283     }
3284 }
3285 # endif
3286 
3287 #if defined(FEAT_TERMRESPONSE) || defined(PROTO)
3288 /*
3289  * Similar to requesting the version string: Request the terminal background
3290  * color when it is the right moment.
3291  */
3292     void
3293 may_req_bg_color(void)
3294 {
3295     if (rbg_status == RBG_GET
3296 	    && cur_tmode == TMODE_RAW
3297 	    && termcap_active
3298 	    && p_ek
3299 #  ifdef UNIX
3300 	    && isatty(1)
3301 	    && isatty(read_cmd_fd)
3302 #  endif
3303 	    && *T_RBG != NUL
3304 	    && !option_was_set((char_u *)"bg"))
3305     {
3306 	LOG_TR("Sending BG request");
3307 	out_str(T_RBG);
3308 	rbg_status = RBG_SENT;
3309 	/* check for the characters now, otherwise they might be eaten by
3310 	 * get_keystroke() */
3311 	out_flush();
3312 	(void)vpeekc_nomap();
3313     }
3314 }
3315 # endif
3316 
3317 # ifdef DEBUG_TERMRESPONSE
3318     static void
3319 log_tr(char *msg)
3320 {
3321     static FILE *fd_tr = NULL;
3322     static proftime_T start;
3323     proftime_T now;
3324 
3325     if (fd_tr == NULL)
3326     {
3327 	fd_tr = fopen("termresponse.log", "w");
3328 	profile_start(&start);
3329     }
3330     now = start;
3331     profile_end(&now);
3332     fprintf(fd_tr, "%s: %s %s\n",
3333 	    profile_msg(&now),
3334 	    must_redraw == NOT_VALID ? "NV"
3335 					 : must_redraw == CLEAR ? "CL" : "  ",
3336 	    msg);
3337 }
3338 # endif
3339 #endif
3340 
3341 /*
3342  * Return TRUE when saving and restoring the screen.
3343  */
3344     int
3345 swapping_screen(void)
3346 {
3347     return (full_screen && *T_TI != NUL);
3348 }
3349 
3350 #ifdef FEAT_MOUSE
3351 /*
3352  * setmouse() - switch mouse on/off depending on current mode and 'mouse'
3353  */
3354     void
3355 setmouse(void)
3356 {
3357 # ifdef FEAT_MOUSE_TTY
3358     int	    checkfor;
3359 # endif
3360 
3361 # ifdef FEAT_MOUSESHAPE
3362     update_mouseshape(-1);
3363 # endif
3364 
3365 # ifdef FEAT_MOUSE_TTY /* Should be outside proc, but may break MOUSESHAPE */
3366 #  ifdef FEAT_GUI
3367     /* In the GUI the mouse is always enabled. */
3368     if (gui.in_use)
3369 	return;
3370 #  endif
3371     /* be quick when mouse is off */
3372     if (*p_mouse == NUL || has_mouse_termcode == 0)
3373 	return;
3374 
3375     /* don't switch mouse on when not in raw mode (Ex mode) */
3376     if (cur_tmode != TMODE_RAW)
3377     {
3378 	mch_setmouse(FALSE);
3379 	return;
3380     }
3381 
3382     if (VIsual_active)
3383 	checkfor = MOUSE_VISUAL;
3384     else if (State == HITRETURN || State == ASKMORE || State == SETWSIZE)
3385 	checkfor = MOUSE_RETURN;
3386     else if (State & INSERT)
3387 	checkfor = MOUSE_INSERT;
3388     else if (State & CMDLINE)
3389 	checkfor = MOUSE_COMMAND;
3390     else if (State == CONFIRM || State == EXTERNCMD)
3391 	checkfor = ' '; /* don't use mouse for ":confirm" or ":!cmd" */
3392     else
3393 	checkfor = MOUSE_NORMAL;    /* assume normal mode */
3394 
3395     if (mouse_has(checkfor))
3396 	mch_setmouse(TRUE);
3397     else
3398 	mch_setmouse(FALSE);
3399 # endif
3400 }
3401 
3402 /*
3403  * Return TRUE if
3404  * - "c" is in 'mouse', or
3405  * - 'a' is in 'mouse' and "c" is in MOUSE_A, or
3406  * - the current buffer is a help file and 'h' is in 'mouse' and we are in a
3407  *   normal editing mode (not at hit-return message).
3408  */
3409     int
3410 mouse_has(int c)
3411 {
3412     char_u	*p;
3413 
3414     for (p = p_mouse; *p; ++p)
3415 	switch (*p)
3416 	{
3417 	    case 'a': if (vim_strchr((char_u *)MOUSE_A, c) != NULL)
3418 			  return TRUE;
3419 		      break;
3420 	    case MOUSE_HELP: if (c != MOUSE_RETURN && curbuf->b_help)
3421 				 return TRUE;
3422 			     break;
3423 	    default: if (c == *p) return TRUE; break;
3424 	}
3425     return FALSE;
3426 }
3427 
3428 /*
3429  * Return TRUE when 'mousemodel' is set to "popup" or "popup_setpos".
3430  */
3431     int
3432 mouse_model_popup(void)
3433 {
3434     return (p_mousem[0] == 'p');
3435 }
3436 #endif
3437 
3438 /*
3439  * By outputting the 'cursor very visible' termcap code, for some windowed
3440  * terminals this makes the screen scrolled to the correct position.
3441  * Used when starting Vim or returning from a shell.
3442  */
3443     void
3444 scroll_start(void)
3445 {
3446     if (*T_VS != NUL)
3447     {
3448 	out_str(T_VS);
3449 	out_str(T_VE);
3450 	screen_start();			/* don't know where cursor is now */
3451     }
3452 }
3453 
3454 static int cursor_is_off = FALSE;
3455 
3456 /*
3457  * Enable the cursor.
3458  */
3459     void
3460 cursor_on(void)
3461 {
3462     if (cursor_is_off)
3463     {
3464 	out_str(T_VE);
3465 	cursor_is_off = FALSE;
3466     }
3467 }
3468 
3469 /*
3470  * Disable the cursor.
3471  */
3472     void
3473 cursor_off(void)
3474 {
3475     if (full_screen)
3476     {
3477 	if (!cursor_is_off)
3478 	    out_str(T_VI);	    /* disable cursor */
3479 	cursor_is_off = TRUE;
3480     }
3481 }
3482 
3483 #if defined(CURSOR_SHAPE) || defined(PROTO)
3484 /*
3485  * Set cursor shape to match Insert or Replace mode.
3486  */
3487     void
3488 term_cursor_shape(void)
3489 {
3490     static int showing_mode = NORMAL;
3491     char_u *p;
3492 
3493     /* Only do something when redrawing the screen and we can restore the
3494      * mode. */
3495     if (!full_screen || *T_CEI == NUL)
3496 	return;
3497 
3498     if ((State & REPLACE) == REPLACE)
3499     {
3500 	if (showing_mode != REPLACE)
3501 	{
3502 	    if (*T_CSR != NUL)
3503 		p = T_CSR;	/* Replace mode cursor */
3504 	    else
3505 		p = T_CSI;	/* fall back to Insert mode cursor */
3506 	    if (*p != NUL)
3507 	    {
3508 		out_str(p);
3509 		showing_mode = REPLACE;
3510 	    }
3511 	}
3512     }
3513     else if (State & INSERT)
3514     {
3515 	if (showing_mode != INSERT && *T_CSI != NUL)
3516 	{
3517 	    out_str(T_CSI);	    /* Insert mode cursor */
3518 	    showing_mode = INSERT;
3519 	}
3520     }
3521     else if (showing_mode != NORMAL)
3522     {
3523 	out_str(T_CEI);		    /* non-Insert mode cursor */
3524 	showing_mode = NORMAL;
3525     }
3526 }
3527 #endif
3528 
3529 /*
3530  * Set scrolling region for window 'wp'.
3531  * The region starts 'off' lines from the start of the window.
3532  * Also set the vertical scroll region for a vertically split window.  Always
3533  * the full width of the window, excluding the vertical separator.
3534  */
3535     void
3536 scroll_region_set(win_T *wp, int off)
3537 {
3538     OUT_STR(tgoto((char *)T_CS, W_WINROW(wp) + wp->w_height - 1,
3539 							 W_WINROW(wp) + off));
3540 #ifdef FEAT_WINDOWS
3541     if (*T_CSV != NUL && wp->w_width != Columns)
3542 	OUT_STR(tgoto((char *)T_CSV, W_WINCOL(wp) + wp->w_width - 1,
3543 							       W_WINCOL(wp)));
3544 #endif
3545     screen_start();		    /* don't know where cursor is now */
3546 }
3547 
3548 /*
3549  * Reset scrolling region to the whole screen.
3550  */
3551     void
3552 scroll_region_reset(void)
3553 {
3554     OUT_STR(tgoto((char *)T_CS, (int)Rows - 1, 0));
3555 #ifdef FEAT_WINDOWS
3556     if (*T_CSV != NUL)
3557 	OUT_STR(tgoto((char *)T_CSV, (int)Columns - 1, 0));
3558 #endif
3559     screen_start();		    /* don't know where cursor is now */
3560 }
3561 
3562 
3563 /*
3564  * List of terminal codes that are currently recognized.
3565  */
3566 
3567 static struct termcode
3568 {
3569     char_u  name[2];	    /* termcap name of entry */
3570     char_u  *code;	    /* terminal code (in allocated memory) */
3571     int	    len;	    /* STRLEN(code) */
3572     int	    modlen;	    /* length of part before ";*~". */
3573 } *termcodes = NULL;
3574 
3575 static int  tc_max_len = 0; /* number of entries that termcodes[] can hold */
3576 static int  tc_len = 0;	    /* current number of entries in termcodes[] */
3577 
3578 static int termcode_star(char_u *code, int len);
3579 
3580     void
3581 clear_termcodes(void)
3582 {
3583     while (tc_len > 0)
3584 	vim_free(termcodes[--tc_len].code);
3585     vim_free(termcodes);
3586     termcodes = NULL;
3587     tc_max_len = 0;
3588 
3589 #ifdef HAVE_TGETENT
3590     BC = (char *)empty_option;
3591     UP = (char *)empty_option;
3592     PC = NUL;			/* set pad character to NUL */
3593     ospeed = 0;
3594 #endif
3595 
3596     need_gather = TRUE;		/* need to fill termleader[] */
3597 }
3598 
3599 #define ATC_FROM_TERM 55
3600 
3601 /*
3602  * Add a new entry to the list of terminal codes.
3603  * The list is kept alphabetical for ":set termcap"
3604  * "flags" is TRUE when replacing 7-bit by 8-bit controls is desired.
3605  * "flags" can also be ATC_FROM_TERM for got_code_from_term().
3606  */
3607     void
3608 add_termcode(char_u *name, char_u *string, int flags)
3609 {
3610     struct termcode *new_tc;
3611     int		    i, j;
3612     char_u	    *s;
3613     int		    len;
3614 
3615     if (string == NULL || *string == NUL)
3616     {
3617 	del_termcode(name);
3618 	return;
3619     }
3620 
3621 #if defined(WIN3264) && !defined(FEAT_GUI)
3622     s = vim_strnsave(string, (int)STRLEN(string) + 1);
3623 #else
3624     s = vim_strsave(string);
3625 #endif
3626     if (s == NULL)
3627 	return;
3628 
3629     /* Change leading <Esc>[ to CSI, change <Esc>O to <M-O>. */
3630     if (flags != 0 && flags != ATC_FROM_TERM && term_7to8bit(string) != 0)
3631     {
3632 	STRMOVE(s, s + 1);
3633 	s[0] = term_7to8bit(string);
3634     }
3635 
3636 #if defined(WIN3264) && !defined(FEAT_GUI)
3637     if (s[0] == K_NUL)
3638     {
3639 	STRMOVE(s + 1, s);
3640 	s[1] = 3;
3641     }
3642 #endif
3643 
3644     len = (int)STRLEN(s);
3645 
3646     need_gather = TRUE;		/* need to fill termleader[] */
3647 
3648     /*
3649      * need to make space for more entries
3650      */
3651     if (tc_len == tc_max_len)
3652     {
3653 	tc_max_len += 20;
3654 	new_tc = (struct termcode *)alloc(
3655 			    (unsigned)(tc_max_len * sizeof(struct termcode)));
3656 	if (new_tc == NULL)
3657 	{
3658 	    tc_max_len -= 20;
3659 	    return;
3660 	}
3661 	for (i = 0; i < tc_len; ++i)
3662 	    new_tc[i] = termcodes[i];
3663 	vim_free(termcodes);
3664 	termcodes = new_tc;
3665     }
3666 
3667     /*
3668      * Look for existing entry with the same name, it is replaced.
3669      * Look for an existing entry that is alphabetical higher, the new entry
3670      * is inserted in front of it.
3671      */
3672     for (i = 0; i < tc_len; ++i)
3673     {
3674 	if (termcodes[i].name[0] < name[0])
3675 	    continue;
3676 	if (termcodes[i].name[0] == name[0])
3677 	{
3678 	    if (termcodes[i].name[1] < name[1])
3679 		continue;
3680 	    /*
3681 	     * Exact match: May replace old code.
3682 	     */
3683 	    if (termcodes[i].name[1] == name[1])
3684 	    {
3685 		if (flags == ATC_FROM_TERM && (j = termcode_star(
3686 				    termcodes[i].code, termcodes[i].len)) > 0)
3687 		{
3688 		    /* Don't replace ESC[123;*X or ESC O*X with another when
3689 		     * invoked from got_code_from_term(). */
3690 		    if (len == termcodes[i].len - j
3691 			    && STRNCMP(s, termcodes[i].code, len - 1) == 0
3692 			    && s[len - 1]
3693 				   == termcodes[i].code[termcodes[i].len - 1])
3694 		    {
3695 			/* They are equal but for the ";*": don't add it. */
3696 			vim_free(s);
3697 			return;
3698 		    }
3699 		}
3700 		else
3701 		{
3702 		    /* Replace old code. */
3703 		    vim_free(termcodes[i].code);
3704 		    --tc_len;
3705 		    break;
3706 		}
3707 	    }
3708 	}
3709 	/*
3710 	 * Found alphabetical larger entry, move rest to insert new entry
3711 	 */
3712 	for (j = tc_len; j > i; --j)
3713 	    termcodes[j] = termcodes[j - 1];
3714 	break;
3715     }
3716 
3717     termcodes[i].name[0] = name[0];
3718     termcodes[i].name[1] = name[1];
3719     termcodes[i].code = s;
3720     termcodes[i].len = len;
3721 
3722     /* For xterm we recognize special codes like "ESC[42;*X" and "ESC O*X" that
3723      * accept modifiers. */
3724     termcodes[i].modlen = 0;
3725     j = termcode_star(s, len);
3726     if (j > 0)
3727 	termcodes[i].modlen = len - 1 - j;
3728     ++tc_len;
3729 }
3730 
3731 /*
3732  * Check termcode "code[len]" for ending in ;*X, <Esc>O*X or <M-O>*X.
3733  * The "X" can be any character.
3734  * Return 0 if not found, 2 for ;*X and 1 for O*X and <M-O>*X.
3735  */
3736     static int
3737 termcode_star(char_u *code, int len)
3738 {
3739     /* Shortest is <M-O>*X.  With ; shortest is <CSI>1;*X */
3740     if (len >= 3 && code[len - 2] == '*')
3741     {
3742 	if (len >= 5 && code[len - 3] == ';')
3743 	    return 2;
3744 	if ((len >= 4 && code[len - 3] == 'O') || code[len - 3] == 'O' + 128)
3745 	    return 1;
3746     }
3747     return 0;
3748 }
3749 
3750     char_u  *
3751 find_termcode(char_u *name)
3752 {
3753     int	    i;
3754 
3755     for (i = 0; i < tc_len; ++i)
3756 	if (termcodes[i].name[0] == name[0] && termcodes[i].name[1] == name[1])
3757 	    return termcodes[i].code;
3758     return NULL;
3759 }
3760 
3761 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3762     char_u *
3763 get_termcode(int i)
3764 {
3765     if (i >= tc_len)
3766 	return NULL;
3767     return &termcodes[i].name[0];
3768 }
3769 #endif
3770 
3771     void
3772 del_termcode(char_u *name)
3773 {
3774     int	    i;
3775 
3776     if (termcodes == NULL)	/* nothing there yet */
3777 	return;
3778 
3779     need_gather = TRUE;		/* need to fill termleader[] */
3780 
3781     for (i = 0; i < tc_len; ++i)
3782 	if (termcodes[i].name[0] == name[0] && termcodes[i].name[1] == name[1])
3783 	{
3784 	    del_termcode_idx(i);
3785 	    return;
3786 	}
3787     /* not found. Give error message? */
3788 }
3789 
3790     static void
3791 del_termcode_idx(int idx)
3792 {
3793     int		i;
3794 
3795     vim_free(termcodes[idx].code);
3796     --tc_len;
3797     for (i = idx; i < tc_len; ++i)
3798 	termcodes[i] = termcodes[i + 1];
3799 }
3800 
3801 #ifdef FEAT_TERMRESPONSE
3802 /*
3803  * Called when detected that the terminal sends 8-bit codes.
3804  * Convert all 7-bit codes to their 8-bit equivalent.
3805  */
3806     static void
3807 switch_to_8bit(void)
3808 {
3809     int		i;
3810     int		c;
3811 
3812     /* Only need to do something when not already using 8-bit codes. */
3813     if (!term_is_8bit(T_NAME))
3814     {
3815 	for (i = 0; i < tc_len; ++i)
3816 	{
3817 	    c = term_7to8bit(termcodes[i].code);
3818 	    if (c != 0)
3819 	    {
3820 		STRMOVE(termcodes[i].code + 1, termcodes[i].code + 2);
3821 		termcodes[i].code[0] = c;
3822 	    }
3823 	}
3824 	need_gather = TRUE;		/* need to fill termleader[] */
3825     }
3826     detected_8bit = TRUE;
3827     LOG_TR("Switching to 8 bit");
3828 }
3829 #endif
3830 
3831 #ifdef CHECK_DOUBLE_CLICK
3832 static linenr_T orig_topline = 0;
3833 # ifdef FEAT_DIFF
3834 static int orig_topfill = 0;
3835 # endif
3836 #endif
3837 #if (defined(FEAT_WINDOWS) && defined(CHECK_DOUBLE_CLICK)) || defined(PROTO)
3838 /*
3839  * Checking for double clicks ourselves.
3840  * "orig_topline" is used to avoid detecting a double-click when the window
3841  * contents scrolled (e.g., when 'scrolloff' is non-zero).
3842  */
3843 /*
3844  * Set orig_topline.  Used when jumping to another window, so that a double
3845  * click still works.
3846  */
3847     void
3848 set_mouse_topline(win_T *wp)
3849 {
3850     orig_topline = wp->w_topline;
3851 # ifdef FEAT_DIFF
3852     orig_topfill = wp->w_topfill;
3853 # endif
3854 }
3855 #endif
3856 
3857 /*
3858  * Check if typebuf.tb_buf[] contains a terminal key code.
3859  * Check from typebuf.tb_buf[typebuf.tb_off] to typebuf.tb_buf[typebuf.tb_off
3860  * + max_offset].
3861  * Return 0 for no match, -1 for partial match, > 0 for full match.
3862  * Return KEYLEN_REMOVED when a key code was deleted.
3863  * With a match, the match is removed, the replacement code is inserted in
3864  * typebuf.tb_buf[] and the number of characters in typebuf.tb_buf[] is
3865  * returned.
3866  * When "buf" is not NULL, buf[bufsize] is used instead of typebuf.tb_buf[].
3867  * "buflen" is then the length of the string in buf[] and is updated for
3868  * inserts and deletes.
3869  */
3870     int
3871 check_termcode(
3872     int		max_offset,
3873     char_u	*buf,
3874     int		bufsize,
3875     int		*buflen)
3876 {
3877     char_u	*tp;
3878     char_u	*p;
3879     int		slen = 0;	/* init for GCC */
3880     int		modslen;
3881     int		len;
3882     int		retval = 0;
3883     int		offset;
3884     char_u	key_name[2];
3885     int		modifiers;
3886     int		key;
3887     int		new_slen;
3888     int		extra;
3889     char_u	string[MAX_KEY_CODE_LEN + 1];
3890     int		i, j;
3891     int		idx = 0;
3892 #ifdef FEAT_MOUSE
3893 # if !defined(UNIX) || defined(FEAT_MOUSE_XTERM) || defined(FEAT_GUI) \
3894     || defined(FEAT_MOUSE_GPM) || defined(FEAT_SYSMOUSE)
3895     char_u	bytes[6];
3896     int		num_bytes;
3897 # endif
3898     int		mouse_code = 0;	    /* init for GCC */
3899     int		is_click, is_drag;
3900     int		wheel_code = 0;
3901     int		current_button;
3902     static int	held_button = MOUSE_RELEASE;
3903     static int	orig_num_clicks = 1;
3904     static int	orig_mouse_code = 0x0;
3905 # ifdef CHECK_DOUBLE_CLICK
3906     static int	orig_mouse_col = 0;
3907     static int	orig_mouse_row = 0;
3908     static struct timeval  orig_mouse_time = {0, 0};
3909 					/* time of previous mouse click */
3910     struct timeval  mouse_time;		/* time of current mouse click */
3911     long	timediff;		/* elapsed time in msec */
3912 # endif
3913 #endif
3914     int		cpo_koffset;
3915 #ifdef FEAT_MOUSE_GPM
3916     extern int	gpm_flag; /* gpm library variable */
3917 #endif
3918 
3919     cpo_koffset = (vim_strchr(p_cpo, CPO_KOFFSET) != NULL);
3920 
3921     /*
3922      * Speed up the checks for terminal codes by gathering all first bytes
3923      * used in termleader[].  Often this is just a single <Esc>.
3924      */
3925     if (need_gather)
3926 	gather_termleader();
3927 
3928     /*
3929      * Check at several positions in typebuf.tb_buf[], to catch something like
3930      * "x<Up>" that can be mapped. Stop at max_offset, because characters
3931      * after that cannot be used for mapping, and with @r commands
3932      * typebuf.tb_buf[] can become very long.
3933      * This is used often, KEEP IT FAST!
3934      */
3935     for (offset = 0; offset < max_offset; ++offset)
3936     {
3937 	if (buf == NULL)
3938 	{
3939 	    if (offset >= typebuf.tb_len)
3940 		break;
3941 	    tp = typebuf.tb_buf + typebuf.tb_off + offset;
3942 	    len = typebuf.tb_len - offset;	/* length of the input */
3943 	}
3944 	else
3945 	{
3946 	    if (offset >= *buflen)
3947 		break;
3948 	    tp = buf + offset;
3949 	    len = *buflen - offset;
3950 	}
3951 
3952 	/*
3953 	 * Don't check characters after K_SPECIAL, those are already
3954 	 * translated terminal chars (avoid translating ~@^Hx).
3955 	 */
3956 	if (*tp == K_SPECIAL)
3957 	{
3958 	    offset += 2;	/* there are always 2 extra characters */
3959 	    continue;
3960 	}
3961 
3962 	/*
3963 	 * Skip this position if the character does not appear as the first
3964 	 * character in term_strings. This speeds up a lot, since most
3965 	 * termcodes start with the same character (ESC or CSI).
3966 	 */
3967 	i = *tp;
3968 	for (p = termleader; *p && *p != i; ++p)
3969 	    ;
3970 	if (*p == NUL)
3971 	    continue;
3972 
3973 	/*
3974 	 * Skip this position if p_ek is not set and tp[0] is an ESC and we
3975 	 * are in Insert mode.
3976 	 */
3977 	if (*tp == ESC && !p_ek && (State & INSERT))
3978 	    continue;
3979 
3980 	key_name[0] = NUL;	/* no key name found yet */
3981 	key_name[1] = NUL;	/* no key name found yet */
3982 	modifiers = 0;		/* no modifiers yet */
3983 
3984 #ifdef FEAT_GUI
3985 	if (gui.in_use)
3986 	{
3987 	    /*
3988 	     * GUI special key codes are all of the form [CSI xx].
3989 	     */
3990 	    if (*tp == CSI)	    /* Special key from GUI */
3991 	    {
3992 		if (len < 3)
3993 		    return -1;	    /* Shouldn't happen */
3994 		slen = 3;
3995 		key_name[0] = tp[1];
3996 		key_name[1] = tp[2];
3997 	    }
3998 	}
3999 	else
4000 #endif /* FEAT_GUI */
4001 	{
4002 	    for (idx = 0; idx < tc_len; ++idx)
4003 	    {
4004 		/*
4005 		 * Ignore the entry if we are not at the start of
4006 		 * typebuf.tb_buf[]
4007 		 * and there are not enough characters to make a match.
4008 		 * But only when the 'K' flag is in 'cpoptions'.
4009 		 */
4010 		slen = termcodes[idx].len;
4011 		if (cpo_koffset && offset && len < slen)
4012 		    continue;
4013 		if (STRNCMP(termcodes[idx].code, tp,
4014 				     (size_t)(slen > len ? len : slen)) == 0)
4015 		{
4016 		    if (len < slen)		/* got a partial sequence */
4017 			return -1;		/* need to get more chars */
4018 
4019 		    /*
4020 		     * When found a keypad key, check if there is another key
4021 		     * that matches and use that one.  This makes <Home> to be
4022 		     * found instead of <kHome> when they produce the same
4023 		     * key code.
4024 		     */
4025 		    if (termcodes[idx].name[0] == 'K'
4026 				       && VIM_ISDIGIT(termcodes[idx].name[1]))
4027 		    {
4028 			for (j = idx + 1; j < tc_len; ++j)
4029 			    if (termcodes[j].len == slen &&
4030 				    STRNCMP(termcodes[idx].code,
4031 					    termcodes[j].code, slen) == 0)
4032 			    {
4033 				idx = j;
4034 				break;
4035 			    }
4036 		    }
4037 
4038 		    key_name[0] = termcodes[idx].name[0];
4039 		    key_name[1] = termcodes[idx].name[1];
4040 		    break;
4041 		}
4042 
4043 		/*
4044 		 * Check for code with modifier, like xterm uses:
4045 		 * <Esc>[123;*X  (modslen == slen - 3)
4046 		 * Also <Esc>O*X and <M-O>*X (modslen == slen - 2).
4047 		 * When there is a modifier the * matches a number.
4048 		 * When there is no modifier the ;* or * is omitted.
4049 		 */
4050 		if (termcodes[idx].modlen > 0)
4051 		{
4052 		    modslen = termcodes[idx].modlen;
4053 		    if (cpo_koffset && offset && len < modslen)
4054 			continue;
4055 		    if (STRNCMP(termcodes[idx].code, tp,
4056 				(size_t)(modslen > len ? len : modslen)) == 0)
4057 		    {
4058 			int	    n;
4059 
4060 			if (len <= modslen)	/* got a partial sequence */
4061 			    return -1;		/* need to get more chars */
4062 
4063 			if (tp[modslen] == termcodes[idx].code[slen - 1])
4064 			    slen = modslen + 1;	/* no modifiers */
4065 			else if (tp[modslen] != ';' && modslen == slen - 3)
4066 			    continue;	/* no match */
4067 			else
4068 			{
4069 			    /* Skip over the digits, the final char must
4070 			     * follow. */
4071 			    for (j = slen - 2; j < len && isdigit(tp[j]); ++j)
4072 				;
4073 			    ++j;
4074 			    if (len < j)	/* got a partial sequence */
4075 				return -1;	/* need to get more chars */
4076 			    if (tp[j - 1] != termcodes[idx].code[slen - 1])
4077 				continue;	/* no match */
4078 
4079 			    /* Match!  Convert modifier bits. */
4080 			    n = atoi((char *)tp + slen - 2) - 1;
4081 			    if (n & 1)
4082 				modifiers |= MOD_MASK_SHIFT;
4083 			    if (n & 2)
4084 				modifiers |= MOD_MASK_ALT;
4085 			    if (n & 4)
4086 				modifiers |= MOD_MASK_CTRL;
4087 			    if (n & 8)
4088 				modifiers |= MOD_MASK_META;
4089 
4090 			    slen = j;
4091 			}
4092 			key_name[0] = termcodes[idx].name[0];
4093 			key_name[1] = termcodes[idx].name[1];
4094 			break;
4095 		    }
4096 		}
4097 	    }
4098 	}
4099 
4100 #ifdef FEAT_TERMRESPONSE
4101 	if (key_name[0] == NUL
4102 	    /* Mouse codes of DEC, pterm, and URXVT start with <ESC>[.  When
4103 	     * detecting the start of these mouse codes they might as well be
4104 	     * another key code or terminal response. */
4105 # ifdef FEAT_MOUSE_DEC
4106 	    || key_name[0] == KS_DEC_MOUSE
4107 # endif
4108 # ifdef FEAT_MOUSE_PTERM
4109 	    || key_name[0] == KS_PTERM_MOUSE
4110 # endif
4111 # ifdef FEAT_MOUSE_URXVT
4112 	    || key_name[0] == KS_URXVT_MOUSE
4113 # endif
4114 	   )
4115 	{
4116 	    /* Check for some responses from the terminal starting with
4117 	     * "<Esc>[" or CSI:
4118 	     *
4119 	     * - Xterm version string: <Esc>[>{x};{vers};{y}c
4120 	     *   Also eat other possible responses to t_RV, rxvt returns
4121 	     *   "<Esc>[?1;2c". Also accept CSI instead of <Esc>[.
4122 	     *   mrxvt has been reported to have "+" in the version. Assume
4123 	     *   the escape sequence ends with a letter or one of "{|}~".
4124 	     *
4125 	     * - Cursor position report: <Esc>[{row};{col}R
4126 	     *   The final byte must be 'R'. It is used for checking the
4127 	     *   ambiguous-width character state.
4128 	     */
4129 	    char_u *argp = tp[0] == ESC ? tp + 2 : tp + 1;
4130 
4131 	    if ((*T_CRV != NUL || *T_U7 != NUL)
4132 			&& ((tp[0] == ESC && len >= 3 && tp[1] == '[')
4133 			    || (tp[0] == CSI && len >= 2))
4134 			&& (VIM_ISDIGIT(*argp) || *argp == '>' || *argp == '?'))
4135 	    {
4136 #ifdef FEAT_MBYTE
4137 		int col;
4138 		int row_char = NUL;
4139 #endif
4140 		j = 0;
4141 		extra = 0;
4142 		for (i = 2 + (tp[0] != CSI); i < len
4143 				&& !(tp[i] >= '{' && tp[i] <= '~')
4144 				&& !ASCII_ISALPHA(tp[i]); ++i)
4145 		    if (tp[i] == ';' && ++j == 1)
4146 		    {
4147 			extra = i + 1;
4148 #ifdef FEAT_MBYTE
4149 			row_char = tp[i - 1];
4150 #endif
4151 		    }
4152 		if (i == len)
4153 		{
4154 		    LOG_TR("Not enough characters for CRV");
4155 		    return -1;
4156 		}
4157 #ifdef FEAT_MBYTE
4158 		if (extra > 0)
4159 		    col = atoi((char *)tp + extra);
4160 		else
4161 		    col = 0;
4162 
4163 		/* Eat it when it has 2 arguments and ends in 'R'. Also when
4164 		 * u7_status is not "sent", it may be from a previous Vim that
4165 		 * just exited.  But not for <S-F3>, it sends something
4166 		 * similar, check for row and column to make sense. */
4167 		if (j == 1 && tp[i] == 'R')
4168 		{
4169 		    if (row_char == '2' && col >= 2)
4170 		    {
4171 			char *aw = NULL;
4172 
4173 			LOG_TR("Received U7 status");
4174 			u7_status = U7_GOT;
4175 # ifdef FEAT_AUTOCMD
4176 			did_cursorhold = TRUE;
4177 # endif
4178 			if (col == 2)
4179 			    aw = "single";
4180 			else if (col == 3)
4181 			    aw = "double";
4182 			if (aw != NULL && STRCMP(aw, p_ambw) != 0)
4183 			{
4184 			    /* Setting the option causes a screen redraw. Do
4185 			     * that right away if possible, keeping any
4186 			     * messages. */
4187 			    set_option_value((char_u *)"ambw", 0L,
4188 					     (char_u *)aw, 0);
4189 # ifdef DEBUG_TERMRESPONSE
4190 			    {
4191 				char buf[100];
4192 				int  r = redraw_asap(CLEAR);
4193 
4194 				sprintf(buf,
4195 					"set 'ambiwidth', redraw_asap(): %d",
4196 					r);
4197 				log_tr(buf);
4198 			    }
4199 # else
4200 			    redraw_asap(CLEAR);
4201 # endif
4202 			}
4203 		    }
4204 		    key_name[0] = (int)KS_EXTRA;
4205 		    key_name[1] = (int)KE_IGNORE;
4206 		    slen = i + 1;
4207 		}
4208 		else
4209 #endif
4210 		/* eat it when at least one digit and ending in 'c' */
4211 		if (*T_CRV != NUL && i > 2 + (tp[0] != CSI) && tp[i] == 'c')
4212 		{
4213 		    LOG_TR("Received CRV");
4214 		    crv_status = CRV_GOT;
4215 # ifdef FEAT_AUTOCMD
4216 		    did_cursorhold = TRUE;
4217 # endif
4218 
4219 		    /* If this code starts with CSI, you can bet that the
4220 		     * terminal uses 8-bit codes. */
4221 		    if (tp[0] == CSI)
4222 			switch_to_8bit();
4223 
4224 		    /* rxvt sends its version number: "20703" is 2.7.3.
4225 		     * Ignore it for when the user has set 'term' to xterm,
4226 		     * even though it's an rxvt. */
4227 		    if (extra > 0)
4228 			extra = atoi((char *)tp + extra);
4229 		    if (extra > 20000)
4230 			extra = 0;
4231 
4232 		    if (tp[1 + (tp[0] != CSI)] == '>' && j == 2)
4233 		    {
4234 			/* Only set 'ttymouse' automatically if it was not set
4235 			 * by the user already. */
4236 			if (!option_was_set((char_u *)"ttym"))
4237 			{
4238 # ifdef TTYM_SGR
4239 			    if (extra >= 277)
4240 				set_option_value((char_u *)"ttym", 0L,
4241 							  (char_u *)"sgr", 0);
4242 			    else
4243 # endif
4244 			    /* if xterm version >= 95 use mouse dragging */
4245 			    if (extra >= 95)
4246 				set_option_value((char_u *)"ttym", 0L,
4247 						       (char_u *)"xterm2", 0);
4248 			}
4249 
4250 			/* if xterm version >= 141 try to get termcap codes */
4251 			if (extra >= 141)
4252 			{
4253 			    LOG_TR("Enable checking for XT codes");
4254 			    check_for_codes = TRUE;
4255 			    need_gather = TRUE;
4256 			    req_codes_from_term();
4257 			}
4258 		    }
4259 # ifdef FEAT_EVAL
4260 		    set_vim_var_string(VV_TERMRESPONSE, tp, i + 1);
4261 # endif
4262 # ifdef FEAT_AUTOCMD
4263 		    apply_autocmds(EVENT_TERMRESPONSE,
4264 						   NULL, NULL, FALSE, curbuf);
4265 # endif
4266 		    key_name[0] = (int)KS_EXTRA;
4267 		    key_name[1] = (int)KE_IGNORE;
4268 		    slen = i + 1;
4269 		}
4270 	    }
4271 
4272 	    /* Check for background color response from the terminal:
4273 	     *
4274 	     *       {lead}11;rgb:{rrrr}/{gggg}/{bbbb}{tail}
4275 	     *
4276 	     * {lead} can be <Esc>] or OSC
4277 	     * {tail} can be '\007', <Esc>\ or STERM.
4278 	     *
4279 	     * Consume any code that starts with "{lead}11;", it's also
4280 	     * possible that "rgba" is following.
4281 	     */
4282 	    else if (*T_RBG != NUL
4283 			&& ((tp[0] == ESC && len >= 2 && tp[1] == ']')
4284 			    || tp[0] == OSC))
4285 	    {
4286 		j = 1 + (tp[0] == ESC);
4287 		if (len >= j + 3 && (argp[0] != '1'
4288 					 || argp[1] != '1' || argp[2] != ';'))
4289 		  i = 0; /* no match */
4290 		else
4291 		  for (i = j; i < len; ++i)
4292 		    if (tp[i] == '\007' || (tp[0] == OSC ? tp[i] == STERM
4293 			: (tp[i] == ESC && i + 1 < len && tp[i + 1] == '\\')))
4294 		    {
4295 			if (i - j >= 21 && STRNCMP(tp + j + 3, "rgb:", 4) == 0
4296 			    && tp[j + 11] == '/' && tp[j + 16] == '/'
4297 			    && !option_was_set((char_u *)"bg"))
4298 			{/* TODO: don't set option when already the right value */
4299 			    LOG_TR("Received RBG");
4300 			    rbg_status = RBG_GOT;
4301 			    set_option_value((char_u *)"bg", 0L, (char_u *)(
4302 				    (3 * '6' < tp[j+7] + tp[j+12] + tp[j+17])
4303 				    ? "light" : "dark"), 0);
4304 			    reset_option_was_set((char_u *)"bg");
4305 			    redraw_asap(CLEAR);
4306 			}
4307 
4308 			/* got finished code: consume it */
4309 			key_name[0] = (int)KS_EXTRA;
4310 			key_name[1] = (int)KE_IGNORE;
4311 			slen = i + 1 + (tp[i] == ESC);
4312 			break;
4313 		    }
4314 		if (i == len)
4315 		{
4316 		    LOG_TR("not enough characters for RB");
4317 		    return -1;
4318 		}
4319 	    }
4320 
4321 	    /* Check for key code response from xterm:
4322 	     *
4323 	     * {lead}{flag}+r<hex bytes><{tail}
4324 	     *
4325 	     * {lead} can be <Esc>P or DCS
4326 	     * {flag} can be '0' or '1'
4327 	     * {tail} can be Esc>\ or STERM
4328 	     *
4329 	     * Consume any code that starts with "{lead}.+r".
4330 	     */
4331 	    else if (check_for_codes
4332 		    && ((tp[0] == ESC && len >= 2 && tp[1] == 'P')
4333 			|| tp[0] == DCS))
4334 	    {
4335 		j = 1 + (tp[0] == ESC);
4336 		if (len >= j + 3 && (argp[1] != '+' || argp[2] != 'r'))
4337 		  i = 0; /* no match */
4338 		else
4339 		  for (i = j; i < len; ++i)
4340 		    if ((tp[i] == ESC && i + 1 < len && tp[i + 1] == '\\')
4341 			    || tp[i] == STERM)
4342 		    {
4343 			if (i - j >= 3)
4344 			    got_code_from_term(tp + j, i);
4345 			key_name[0] = (int)KS_EXTRA;
4346 			key_name[1] = (int)KE_IGNORE;
4347 			slen = i + 1 + (tp[i] == ESC);
4348 			break;
4349 		    }
4350 
4351 		if (i == len)
4352 		{
4353 		    /* These codes arrive many together, each code can be
4354 		     * truncated at any point. */
4355 		    LOG_TR("not enough characters for XT");
4356 		    return -1;
4357 		}
4358 	    }
4359 	}
4360 #endif
4361 
4362 	if (key_name[0] == NUL)
4363 	    continue;	    /* No match at this position, try next one */
4364 
4365 	/* We only get here when we have a complete termcode match */
4366 
4367 #ifdef FEAT_MOUSE
4368 # ifdef FEAT_GUI
4369 	/*
4370 	 * Only in the GUI: Fetch the pointer coordinates of the scroll event
4371 	 * so that we know which window to scroll later.
4372 	 */
4373 	if (gui.in_use
4374 		&& key_name[0] == (int)KS_EXTRA
4375 		&& (key_name[1] == (int)KE_X1MOUSE
4376 		    || key_name[1] == (int)KE_X2MOUSE
4377 		    || key_name[1] == (int)KE_MOUSELEFT
4378 		    || key_name[1] == (int)KE_MOUSERIGHT
4379 		    || key_name[1] == (int)KE_MOUSEDOWN
4380 		    || key_name[1] == (int)KE_MOUSEUP))
4381 	{
4382 	    num_bytes = get_bytes_from_buf(tp + slen, bytes, 4);
4383 	    if (num_bytes == -1)	/* not enough coordinates */
4384 		return -1;
4385 	    mouse_col = 128 * (bytes[0] - ' ' - 1) + bytes[1] - ' ' - 1;
4386 	    mouse_row = 128 * (bytes[2] - ' ' - 1) + bytes[3] - ' ' - 1;
4387 	    slen += num_bytes;
4388 	}
4389 	else
4390 # endif
4391 	/*
4392 	 * If it is a mouse click, get the coordinates.
4393 	 */
4394 	if (key_name[0] == KS_MOUSE
4395 # ifdef FEAT_MOUSE_JSB
4396 		|| key_name[0] == KS_JSBTERM_MOUSE
4397 # endif
4398 # ifdef FEAT_MOUSE_NET
4399 		|| key_name[0] == KS_NETTERM_MOUSE
4400 # endif
4401 # ifdef FEAT_MOUSE_DEC
4402 		|| key_name[0] == KS_DEC_MOUSE
4403 # endif
4404 # ifdef FEAT_MOUSE_PTERM
4405 		|| key_name[0] == KS_PTERM_MOUSE
4406 # endif
4407 # ifdef FEAT_MOUSE_URXVT
4408 		|| key_name[0] == KS_URXVT_MOUSE
4409 # endif
4410 # ifdef FEAT_MOUSE_SGR
4411 		|| key_name[0] == KS_SGR_MOUSE
4412 # endif
4413 		)
4414 	{
4415 	    is_click = is_drag = FALSE;
4416 
4417 # if !defined(UNIX) || defined(FEAT_MOUSE_XTERM) || defined(FEAT_GUI) \
4418 	    || defined(FEAT_MOUSE_GPM) || defined(FEAT_SYSMOUSE)
4419 	    if (key_name[0] == (int)KS_MOUSE)
4420 	    {
4421 		/*
4422 		 * For xterm we get "<t_mouse>scr", where
4423 		 *  s == encoded button state:
4424 		 *	   0x20 = left button down
4425 		 *	   0x21 = middle button down
4426 		 *	   0x22 = right button down
4427 		 *	   0x23 = any button release
4428 		 *	   0x60 = button 4 down (scroll wheel down)
4429 		 *	   0x61 = button 5 down (scroll wheel up)
4430 		 *	add 0x04 for SHIFT
4431 		 *	add 0x08 for ALT
4432 		 *	add 0x10 for CTRL
4433 		 *	add 0x20 for mouse drag (0x40 is drag with left button)
4434 		 *  c == column + ' ' + 1 == column + 33
4435 		 *  r == row + ' ' + 1 == row + 33
4436 		 *
4437 		 * The coordinates are passed on through global variables.
4438 		 * Ugly, but this avoids trouble with mouse clicks at an
4439 		 * unexpected moment and allows for mapping them.
4440 		 */
4441 		for (;;)
4442 		{
4443 #ifdef FEAT_GUI
4444 		    if (gui.in_use)
4445 		    {
4446 			/* GUI uses more bits for columns > 223 */
4447 			num_bytes = get_bytes_from_buf(tp + slen, bytes, 5);
4448 			if (num_bytes == -1)	/* not enough coordinates */
4449 			    return -1;
4450 			mouse_code = bytes[0];
4451 			mouse_col = 128 * (bytes[1] - ' ' - 1)
4452 							 + bytes[2] - ' ' - 1;
4453 			mouse_row = 128 * (bytes[3] - ' ' - 1)
4454 							 + bytes[4] - ' ' - 1;
4455 		    }
4456 		    else
4457 #endif
4458 		    {
4459 			num_bytes = get_bytes_from_buf(tp + slen, bytes, 3);
4460 			if (num_bytes == -1)	/* not enough coordinates */
4461 			    return -1;
4462 			mouse_code = bytes[0];
4463 			mouse_col = bytes[1] - ' ' - 1;
4464 			mouse_row = bytes[2] - ' ' - 1;
4465 		    }
4466 		    slen += num_bytes;
4467 
4468 		    /* If the following bytes is also a mouse code and it has
4469 		     * the same code, dump this one and get the next.  This
4470 		     * makes dragging a whole lot faster. */
4471 #ifdef FEAT_GUI
4472 		    if (gui.in_use)
4473 			j = 3;
4474 		    else
4475 #endif
4476 			j = termcodes[idx].len;
4477 		    if (STRNCMP(tp, tp + slen, (size_t)j) == 0
4478 			    && tp[slen + j] == mouse_code
4479 			    && tp[slen + j + 1] != NUL
4480 			    && tp[slen + j + 2] != NUL
4481 #ifdef FEAT_GUI
4482 			    && (!gui.in_use
4483 				|| (tp[slen + j + 3] != NUL
4484 					&& tp[slen + j + 4] != NUL))
4485 #endif
4486 			    )
4487 			slen += j;
4488 		    else
4489 			break;
4490 		}
4491 	    }
4492 
4493 # if defined(FEAT_MOUSE_URXVT) || defined(FEAT_MOUSE_SGR)
4494 	    if (key_name[0] == KS_URXVT_MOUSE
4495 		|| key_name[0] == KS_SGR_MOUSE)
4496 	    {
4497 		for (;;)
4498 		{
4499 		    /* URXVT 1015 mouse reporting mode:
4500 		     * Almost identical to xterm mouse mode, except the values
4501 		     * are decimal instead of bytes.
4502 		     *
4503 		     * \033[%d;%d;%dM
4504 		     *		  ^-- row
4505 		     *	       ^----- column
4506 		     *	    ^-------- code
4507 		     *
4508 		     * SGR 1006 mouse reporting mode:
4509 		     * Almost identical to xterm mouse mode, except the values
4510 		     * are decimal instead of bytes.
4511 		     *
4512 		     * \033[<%d;%d;%dM
4513 		     *		   ^-- row
4514 		     *	        ^----- column
4515 		     *	     ^-------- code
4516 		     *
4517 		     * \033[<%d;%d;%dm        : mouse release event
4518 		     *		   ^-- row
4519 		     *	        ^----- column
4520 		     *	     ^-------- code
4521 		     */
4522 		    p = tp + slen;
4523 
4524 		    mouse_code = getdigits(&p);
4525 		    if (*p++ != ';')
4526 			return -1;
4527 
4528 		    /* when mouse reporting is SGR, add 32 to mouse code */
4529 		    if (key_name[0] == KS_SGR_MOUSE)
4530 			mouse_code += 32;
4531 
4532 		    mouse_col = getdigits(&p) - 1;
4533 		    if (*p++ != ';')
4534 			return -1;
4535 
4536 		    mouse_row = getdigits(&p) - 1;
4537 		    if (key_name[0] == KS_SGR_MOUSE && *p == 'm')
4538 			mouse_code |= MOUSE_RELEASE;
4539 		    else if (*p != 'M')
4540 			return -1;
4541 		    p++;
4542 
4543 		    slen += (int)(p - (tp + slen));
4544 
4545 		    /* skip this one if next one has same code (like xterm
4546 		     * case) */
4547 		    j = termcodes[idx].len;
4548 		    if (STRNCMP(tp, tp + slen, (size_t)j) == 0)
4549 		    {
4550 			int slen2;
4551 			int cmd_complete = 0;
4552 
4553 			/* check if the command is complete by looking for the
4554 			 * 'M' */
4555 			for (slen2 = slen; slen2 < len; slen2++)
4556 			{
4557 			    if (tp[slen2] == 'M'
4558 				    || (key_name[0] == KS_SGR_MOUSE
4559 							 && tp[slen2] == 'm'))
4560 			    {
4561 				cmd_complete = 1;
4562 				break;
4563 			    }
4564 			}
4565 			p += j;
4566 			if (cmd_complete && getdigits(&p) == mouse_code)
4567 			{
4568 			    slen += j; /* skip the \033[ */
4569 			    continue;
4570 			}
4571 		    }
4572 		    break;
4573 		}
4574 	    }
4575 # endif
4576 
4577 	if (key_name[0] == (int)KS_MOUSE
4578 #ifdef FEAT_MOUSE_URXVT
4579 	    || key_name[0] == (int)KS_URXVT_MOUSE
4580 #endif
4581 #ifdef FEAT_MOUSE_SGR
4582 	    || key_name[0] == KS_SGR_MOUSE
4583 #endif
4584 	    )
4585 	{
4586 #  if !defined(MSWIN)
4587 		/*
4588 		 * Handle mouse events.
4589 		 * Recognize the xterm mouse wheel, but not in the GUI, the
4590 		 * Linux console with GPM and the MS-DOS or Win32 console
4591 		 * (multi-clicks use >= 0x60).
4592 		 */
4593 		if (mouse_code >= MOUSEWHEEL_LOW
4594 #   ifdef FEAT_GUI
4595 			&& !gui.in_use
4596 #   endif
4597 #   ifdef FEAT_MOUSE_GPM
4598 			&& gpm_flag == 0
4599 #   endif
4600 			)
4601 		{
4602 		    /* Keep the mouse_code before it's changed, so that we
4603 		     * remember that it was a mouse wheel click. */
4604 		    wheel_code = mouse_code;
4605 		}
4606 #   ifdef FEAT_MOUSE_XTERM
4607 		else if (held_button == MOUSE_RELEASE
4608 #    ifdef FEAT_GUI
4609 			&& !gui.in_use
4610 #    endif
4611 			&& (mouse_code == 0x23 || mouse_code == 0x24))
4612 		{
4613 		    /* Apparently used by rxvt scroll wheel. */
4614 		    wheel_code = mouse_code - 0x23 + MOUSEWHEEL_LOW;
4615 		}
4616 #   endif
4617 
4618 #   if defined(UNIX) && defined(FEAT_MOUSE_TTY)
4619 		else if (use_xterm_mouse() > 1)
4620 		{
4621 		    if (mouse_code & MOUSE_DRAG_XTERM)
4622 			mouse_code |= MOUSE_DRAG;
4623 		}
4624 #   endif
4625 #   ifdef FEAT_XCLIPBOARD
4626 		else if (!(mouse_code & MOUSE_DRAG & ~MOUSE_CLICK_MASK))
4627 		{
4628 		    if ((mouse_code & MOUSE_RELEASE) == MOUSE_RELEASE)
4629 			stop_xterm_trace();
4630 		    else
4631 			start_xterm_trace(mouse_code);
4632 		}
4633 #   endif
4634 #  endif
4635 	    }
4636 # endif /* !UNIX || FEAT_MOUSE_XTERM */
4637 # ifdef FEAT_MOUSE_NET
4638 	    if (key_name[0] == (int)KS_NETTERM_MOUSE)
4639 	    {
4640 		int mc, mr;
4641 
4642 		/* expect a rather limited sequence like: balancing {
4643 		 * \033}6,45\r
4644 		 * '6' is the row, 45 is the column
4645 		 */
4646 		p = tp + slen;
4647 		mr = getdigits(&p);
4648 		if (*p++ != ',')
4649 		    return -1;
4650 		mc = getdigits(&p);
4651 		if (*p++ != '\r')
4652 		    return -1;
4653 
4654 		mouse_col = mc - 1;
4655 		mouse_row = mr - 1;
4656 		mouse_code = MOUSE_LEFT;
4657 		slen += (int)(p - (tp + slen));
4658 	    }
4659 # endif	/* FEAT_MOUSE_NET */
4660 # ifdef FEAT_MOUSE_JSB
4661 	    if (key_name[0] == (int)KS_JSBTERM_MOUSE)
4662 	    {
4663 		int mult, val, iter, button, status;
4664 
4665 		/* JSBTERM Input Model
4666 		 * \033[0~zw uniq escape sequence
4667 		 * (L-x)  Left button pressed - not pressed x not reporting
4668 		 * (M-x)  Middle button pressed - not pressed x not reporting
4669 		 * (R-x)  Right button pressed - not pressed x not reporting
4670 		 * (SDmdu)  Single , Double click, m mouse move d button down
4671 		 *						   u button up
4672 		 *  ###   X cursor position padded to 3 digits
4673 		 *  ###   Y cursor position padded to 3 digits
4674 		 * (s-x)  SHIFT key pressed - not pressed x not reporting
4675 		 * (c-x)  CTRL key pressed - not pressed x not reporting
4676 		 * \033\\ terminating sequence
4677 		 */
4678 
4679 		p = tp + slen;
4680 		button = mouse_code = 0;
4681 		switch (*p++)
4682 		{
4683 		    case 'L': button = 1; break;
4684 		    case '-': break;
4685 		    case 'x': break; /* ignore sequence */
4686 		    default:  return -1; /* Unknown Result */
4687 		}
4688 		switch (*p++)
4689 		{
4690 		    case 'M': button |= 2; break;
4691 		    case '-': break;
4692 		    case 'x': break; /* ignore sequence */
4693 		    default:  return -1; /* Unknown Result */
4694 		}
4695 		switch (*p++)
4696 		{
4697 		    case 'R': button |= 4; break;
4698 		    case '-': break;
4699 		    case 'x': break; /* ignore sequence */
4700 		    default:  return -1; /* Unknown Result */
4701 		}
4702 		status = *p++;
4703 		for (val = 0, mult = 100, iter = 0; iter < 3; iter++,
4704 							      mult /= 10, p++)
4705 		    if (*p >= '0' && *p <= '9')
4706 			val += (*p - '0') * mult;
4707 		    else
4708 			return -1;
4709 		mouse_col = val;
4710 		for (val = 0, mult = 100, iter = 0; iter < 3; iter++,
4711 							      mult /= 10, p++)
4712 		    if (*p >= '0' && *p <= '9')
4713 			val += (*p - '0') * mult;
4714 		    else
4715 			return -1;
4716 		mouse_row = val;
4717 		switch (*p++)
4718 		{
4719 		    case 's': button |= 8; break;  /* SHIFT key Pressed */
4720 		    case '-': break;  /* Not Pressed */
4721 		    case 'x': break;  /* Not Reporting */
4722 		    default:  return -1; /* Unknown Result */
4723 		}
4724 		switch (*p++)
4725 		{
4726 		    case 'c': button |= 16; break;  /* CTRL key Pressed */
4727 		    case '-': break;  /* Not Pressed */
4728 		    case 'x': break;  /* Not Reporting */
4729 		    default:  return -1; /* Unknown Result */
4730 		}
4731 		if (*p++ != '\033')
4732 		    return -1;
4733 		if (*p++ != '\\')
4734 		    return -1;
4735 		switch (status)
4736 		{
4737 		    case 'D': /* Double Click */
4738 		    case 'S': /* Single Click */
4739 			if (button & 1) mouse_code |= MOUSE_LEFT;
4740 			if (button & 2) mouse_code |= MOUSE_MIDDLE;
4741 			if (button & 4) mouse_code |= MOUSE_RIGHT;
4742 			if (button & 8) mouse_code |= MOUSE_SHIFT;
4743 			if (button & 16) mouse_code |= MOUSE_CTRL;
4744 			break;
4745 		    case 'm': /* Mouse move */
4746 			if (button & 1) mouse_code |= MOUSE_LEFT;
4747 			if (button & 2) mouse_code |= MOUSE_MIDDLE;
4748 			if (button & 4) mouse_code |= MOUSE_RIGHT;
4749 			if (button & 8) mouse_code |= MOUSE_SHIFT;
4750 			if (button & 16) mouse_code |= MOUSE_CTRL;
4751 			if ((button & 7) != 0)
4752 			{
4753 			    held_button = mouse_code;
4754 			    mouse_code |= MOUSE_DRAG;
4755 			}
4756 			is_drag = TRUE;
4757 			showmode();
4758 			break;
4759 		    case 'd': /* Button Down */
4760 			if (button & 1) mouse_code |= MOUSE_LEFT;
4761 			if (button & 2) mouse_code |= MOUSE_MIDDLE;
4762 			if (button & 4) mouse_code |= MOUSE_RIGHT;
4763 			if (button & 8) mouse_code |= MOUSE_SHIFT;
4764 			if (button & 16) mouse_code |= MOUSE_CTRL;
4765 			break;
4766 		    case 'u': /* Button Up */
4767 			if (button & 1)
4768 			    mouse_code |= MOUSE_LEFT | MOUSE_RELEASE;
4769 			if (button & 2)
4770 			    mouse_code |= MOUSE_MIDDLE | MOUSE_RELEASE;
4771 			if (button & 4)
4772 			    mouse_code |= MOUSE_RIGHT | MOUSE_RELEASE;
4773 			if (button & 8)
4774 			    mouse_code |= MOUSE_SHIFT;
4775 			if (button & 16)
4776 			    mouse_code |= MOUSE_CTRL;
4777 			break;
4778 		    default: return -1; /* Unknown Result */
4779 		}
4780 
4781 		slen += (p - (tp + slen));
4782 	    }
4783 # endif /* FEAT_MOUSE_JSB */
4784 # ifdef FEAT_MOUSE_DEC
4785 	    if (key_name[0] == (int)KS_DEC_MOUSE)
4786 	    {
4787 	       /* The DEC Locator Input Model
4788 		* Netterm delivers the code sequence:
4789 		*  \033[2;4;24;80&w  (left button down)
4790 		*  \033[3;0;24;80&w  (left button up)
4791 		*  \033[6;1;24;80&w  (right button down)
4792 		*  \033[7;0;24;80&w  (right button up)
4793 		* CSI Pe ; Pb ; Pr ; Pc ; Pp & w
4794 		* Pe is the event code
4795 		* Pb is the button code
4796 		* Pr is the row coordinate
4797 		* Pc is the column coordinate
4798 		* Pp is the third coordinate (page number)
4799 		* Pe, the event code indicates what event caused this report
4800 		*    The following event codes are defined:
4801 		*    0 - request, the terminal received an explicit request
4802 		*	 for a locator report, but the locator is unavailable
4803 		*    1 - request, the terminal received an explicit request
4804 		*	 for a locator report
4805 		*    2 - left button down
4806 		*    3 - left button up
4807 		*    4 - middle button down
4808 		*    5 - middle button up
4809 		*    6 - right button down
4810 		*    7 - right button up
4811 		*    8 - fourth button down
4812 		*    9 - fourth button up
4813 		*    10 - locator outside filter rectangle
4814 		* Pb, the button code, ASCII decimal 0-15 indicating which
4815 		*   buttons are down if any. The state of the four buttons
4816 		*   on the locator correspond to the low four bits of the
4817 		*   decimal value,
4818 		*   "1" means button depressed
4819 		*   0 - no buttons down,
4820 		*   1 - right,
4821 		*   2 - middle,
4822 		*   4 - left,
4823 		*   8 - fourth
4824 		* Pr is the row coordinate of the locator position in the page,
4825 		*   encoded as an ASCII decimal value.
4826 		*   If Pr is omitted, the locator position is undefined
4827 		*   (outside the terminal window for example).
4828 		* Pc is the column coordinate of the locator position in the
4829 		*   page, encoded as an ASCII decimal value.
4830 		*   If Pc is omitted, the locator position is undefined
4831 		*   (outside the terminal window for example).
4832 		* Pp is the page coordinate of the locator position
4833 		*   encoded as an ASCII decimal value.
4834 		*   The page coordinate may be omitted if the locator is on
4835 		*   page one (the default).  We ignore it anyway.
4836 		*/
4837 		int Pe, Pb, Pr, Pc;
4838 
4839 		p = tp + slen;
4840 
4841 		/* get event status */
4842 		Pe = getdigits(&p);
4843 		if (*p++ != ';')
4844 		    return -1;
4845 
4846 		/* get button status */
4847 		Pb = getdigits(&p);
4848 		if (*p++ != ';')
4849 		    return -1;
4850 
4851 		/* get row status */
4852 		Pr = getdigits(&p);
4853 		if (*p++ != ';')
4854 		    return -1;
4855 
4856 		/* get column status */
4857 		Pc = getdigits(&p);
4858 
4859 		/* the page parameter is optional */
4860 		if (*p == ';')
4861 		{
4862 		    p++;
4863 		    (void)getdigits(&p);
4864 		}
4865 		if (*p++ != '&')
4866 		    return -1;
4867 		if (*p++ != 'w')
4868 		    return -1;
4869 
4870 		mouse_code = 0;
4871 		switch (Pe)
4872 		{
4873 		case  0: return -1; /* position request while unavailable */
4874 		case  1: /* a response to a locator position request includes
4875 			    the status of all buttons */
4876 			 Pb &= 7;   /* mask off and ignore fourth button */
4877 			 if (Pb & 4)
4878 			     mouse_code  = MOUSE_LEFT;
4879 			 if (Pb & 2)
4880 			     mouse_code  = MOUSE_MIDDLE;
4881 			 if (Pb & 1)
4882 			     mouse_code  = MOUSE_RIGHT;
4883 			 if (Pb)
4884 			 {
4885 			     held_button = mouse_code;
4886 			     mouse_code |= MOUSE_DRAG;
4887 			     WantQueryMouse = TRUE;
4888 			 }
4889 			 is_drag = TRUE;
4890 			 showmode();
4891 			 break;
4892 		case  2: mouse_code = MOUSE_LEFT;
4893 			 WantQueryMouse = TRUE;
4894 			 break;
4895 		case  3: mouse_code = MOUSE_RELEASE | MOUSE_LEFT;
4896 			 break;
4897 		case  4: mouse_code = MOUSE_MIDDLE;
4898 			 WantQueryMouse = TRUE;
4899 			 break;
4900 		case  5: mouse_code = MOUSE_RELEASE | MOUSE_MIDDLE;
4901 			 break;
4902 		case  6: mouse_code = MOUSE_RIGHT;
4903 			 WantQueryMouse = TRUE;
4904 			 break;
4905 		case  7: mouse_code = MOUSE_RELEASE | MOUSE_RIGHT;
4906 			 break;
4907 		case  8: return -1; /* fourth button down */
4908 		case  9: return -1; /* fourth button up */
4909 		case 10: return -1; /* mouse outside of filter rectangle */
4910 		default: return -1; /* should never occur */
4911 		}
4912 
4913 		mouse_col = Pc - 1;
4914 		mouse_row = Pr - 1;
4915 
4916 		slen += (int)(p - (tp + slen));
4917 	    }
4918 # endif /* FEAT_MOUSE_DEC */
4919 # ifdef FEAT_MOUSE_PTERM
4920 	    if (key_name[0] == (int)KS_PTERM_MOUSE)
4921 	    {
4922 		int button, num_clicks, action;
4923 
4924 		p = tp + slen;
4925 
4926 		action = getdigits(&p);
4927 		if (*p++ != ';')
4928 		    return -1;
4929 
4930 		mouse_row = getdigits(&p);
4931 		if (*p++ != ';')
4932 		    return -1;
4933 		mouse_col = getdigits(&p);
4934 		if (*p++ != ';')
4935 		    return -1;
4936 
4937 		button = getdigits(&p);
4938 		mouse_code = 0;
4939 
4940 		switch (button)
4941 		{
4942 		    case 4: mouse_code = MOUSE_LEFT; break;
4943 		    case 1: mouse_code = MOUSE_RIGHT; break;
4944 		    case 2: mouse_code = MOUSE_MIDDLE; break;
4945 		    default: return -1;
4946 		}
4947 
4948 		switch (action)
4949 		{
4950 		    case 31: /* Initial press */
4951 			if (*p++ != ';')
4952 			    return -1;
4953 
4954 			num_clicks = getdigits(&p); /* Not used */
4955 			break;
4956 
4957 		    case 32: /* Release */
4958 			mouse_code |= MOUSE_RELEASE;
4959 			break;
4960 
4961 		    case 33: /* Drag */
4962 			held_button = mouse_code;
4963 			mouse_code |= MOUSE_DRAG;
4964 			break;
4965 
4966 		    default:
4967 			return -1;
4968 		}
4969 
4970 		if (*p++ != 't')
4971 		    return -1;
4972 
4973 		slen += (p - (tp + slen));
4974 	    }
4975 # endif /* FEAT_MOUSE_PTERM */
4976 
4977 	    /* Interpret the mouse code */
4978 	    current_button = (mouse_code & MOUSE_CLICK_MASK);
4979 	    if (current_button == MOUSE_RELEASE
4980 # ifdef FEAT_MOUSE_XTERM
4981 		    && wheel_code == 0
4982 # endif
4983 		    )
4984 	    {
4985 		/*
4986 		 * If we get a mouse drag or release event when
4987 		 * there is no mouse button held down (held_button ==
4988 		 * MOUSE_RELEASE), produce a K_IGNORE below.
4989 		 * (can happen when you hold down two buttons
4990 		 * and then let them go, or click in the menu bar, but not
4991 		 * on a menu, and drag into the text).
4992 		 */
4993 		if ((mouse_code & MOUSE_DRAG) == MOUSE_DRAG)
4994 		    is_drag = TRUE;
4995 		current_button = held_button;
4996 	    }
4997 	    else if (wheel_code == 0)
4998 	    {
4999 # ifdef CHECK_DOUBLE_CLICK
5000 #  ifdef FEAT_MOUSE_GPM
5001 #   ifdef FEAT_GUI
5002 		/*
5003 		 * Only for Unix, when GUI or gpm is not active, we handle
5004 		 * multi-clicks here.
5005 		 */
5006 		if (gpm_flag == 0 && !gui.in_use)
5007 #   else
5008 		if (gpm_flag == 0)
5009 #   endif
5010 #  else
5011 #   ifdef FEAT_GUI
5012 		if (!gui.in_use)
5013 #   endif
5014 #  endif
5015 		{
5016 		    /*
5017 		     * Compute the time elapsed since the previous mouse click.
5018 		     */
5019 		    gettimeofday(&mouse_time, NULL);
5020 		    if (orig_mouse_time.tv_sec == 0)
5021 		    {
5022 			/*
5023 			 * Avoid computing the difference between mouse_time
5024 			 * and orig_mouse_time for the first click, as the
5025 			 * difference would be huge and would cause multiplication
5026 			 * overflow.
5027 			 */
5028 			timediff = p_mouset;
5029 		    }
5030 		    else
5031 		    {
5032 			timediff = (mouse_time.tv_usec
5033 						- orig_mouse_time.tv_usec) / 1000;
5034 			if (timediff < 0)
5035 			    --orig_mouse_time.tv_sec;
5036 			timediff += (mouse_time.tv_sec
5037 						 - orig_mouse_time.tv_sec) * 1000;
5038 		    }
5039 		    orig_mouse_time = mouse_time;
5040 		    if (mouse_code == orig_mouse_code
5041 			    && timediff < p_mouset
5042 			    && orig_num_clicks != 4
5043 			    && orig_mouse_col == mouse_col
5044 			    && orig_mouse_row == mouse_row
5045 			    && ((orig_topline == curwin->w_topline
5046 #ifdef FEAT_DIFF
5047 				    && orig_topfill == curwin->w_topfill
5048 #endif
5049 				)
5050 #ifdef FEAT_WINDOWS
5051 				/* Double click in tab pages line also works
5052 				 * when window contents changes. */
5053 				|| (mouse_row == 0 && firstwin->w_winrow > 0)
5054 #endif
5055 			       )
5056 			    )
5057 			++orig_num_clicks;
5058 		    else
5059 			orig_num_clicks = 1;
5060 		    orig_mouse_col = mouse_col;
5061 		    orig_mouse_row = mouse_row;
5062 		    orig_topline = curwin->w_topline;
5063 #ifdef FEAT_DIFF
5064 		    orig_topfill = curwin->w_topfill;
5065 #endif
5066 		}
5067 #  if defined(FEAT_GUI) || defined(FEAT_MOUSE_GPM)
5068 		else
5069 		    orig_num_clicks = NUM_MOUSE_CLICKS(mouse_code);
5070 #  endif
5071 # else
5072 		orig_num_clicks = NUM_MOUSE_CLICKS(mouse_code);
5073 # endif
5074 		is_click = TRUE;
5075 		orig_mouse_code = mouse_code;
5076 	    }
5077 	    if (!is_drag)
5078 		held_button = mouse_code & MOUSE_CLICK_MASK;
5079 
5080 	    /*
5081 	     * Translate the actual mouse event into a pseudo mouse event.
5082 	     * First work out what modifiers are to be used.
5083 	     */
5084 	    if (orig_mouse_code & MOUSE_SHIFT)
5085 		modifiers |= MOD_MASK_SHIFT;
5086 	    if (orig_mouse_code & MOUSE_CTRL)
5087 		modifiers |= MOD_MASK_CTRL;
5088 	    if (orig_mouse_code & MOUSE_ALT)
5089 		modifiers |= MOD_MASK_ALT;
5090 	    if (orig_num_clicks == 2)
5091 		modifiers |= MOD_MASK_2CLICK;
5092 	    else if (orig_num_clicks == 3)
5093 		modifiers |= MOD_MASK_3CLICK;
5094 	    else if (orig_num_clicks == 4)
5095 		modifiers |= MOD_MASK_4CLICK;
5096 
5097 	    /* Work out our pseudo mouse event. Note that MOUSE_RELEASE gets
5098 	     * added, then it's not mouse up/down. */
5099 	    key_name[0] = (int)KS_EXTRA;
5100             if (wheel_code != 0
5101 			      && (wheel_code & MOUSE_RELEASE) != MOUSE_RELEASE)
5102 	    {
5103 		if (wheel_code & MOUSE_CTRL)
5104 		    modifiers |= MOD_MASK_CTRL;
5105 		if (wheel_code & MOUSE_ALT)
5106 		    modifiers |= MOD_MASK_ALT;
5107 		key_name[1] = (wheel_code & 1)
5108 					? (int)KE_MOUSEUP : (int)KE_MOUSEDOWN;
5109 	    }
5110 	    else
5111 		key_name[1] = get_pseudo_mouse_code(current_button,
5112 							   is_click, is_drag);
5113 
5114 	    /* Make sure the mouse position is valid.  Some terminals may
5115 	     * return weird values. */
5116 	    if (mouse_col >= Columns)
5117 		mouse_col = Columns - 1;
5118 	    if (mouse_row >= Rows)
5119 		mouse_row = Rows - 1;
5120 	}
5121 #endif /* FEAT_MOUSE */
5122 
5123 #ifdef FEAT_GUI
5124 	/*
5125 	 * If using the GUI, then we get menu and scrollbar events.
5126 	 *
5127 	 * A menu event is encoded as K_SPECIAL, KS_MENU, KE_FILLER followed by
5128 	 * four bytes which are to be taken as a pointer to the vimmenu_T
5129 	 * structure.
5130 	 *
5131 	 * A tab line event is encoded as K_SPECIAL KS_TABLINE nr, where "nr"
5132 	 * is one byte with the tab index.
5133 	 *
5134 	 * A scrollbar event is K_SPECIAL, KS_VER_SCROLLBAR, KE_FILLER followed
5135 	 * by one byte representing the scrollbar number, and then four bytes
5136 	 * representing a long_u which is the new value of the scrollbar.
5137 	 *
5138 	 * A horizontal scrollbar event is K_SPECIAL, KS_HOR_SCROLLBAR,
5139 	 * KE_FILLER followed by four bytes representing a long_u which is the
5140 	 * new value of the scrollbar.
5141 	 */
5142 # ifdef FEAT_MENU
5143 	else if (key_name[0] == (int)KS_MENU)
5144 	{
5145 	    long_u	val;
5146 
5147 	    num_bytes = get_long_from_buf(tp + slen, &val);
5148 	    if (num_bytes == -1)
5149 		return -1;
5150 	    current_menu = (vimmenu_T *)val;
5151 	    slen += num_bytes;
5152 
5153 	    /* The menu may have been deleted right after it was used, check
5154 	     * for that. */
5155 	    if (check_menu_pointer(root_menu, current_menu) == FAIL)
5156 	    {
5157 		key_name[0] = KS_EXTRA;
5158 		key_name[1] = (int)KE_IGNORE;
5159 	    }
5160 	}
5161 # endif
5162 # ifdef FEAT_GUI_TABLINE
5163 	else if (key_name[0] == (int)KS_TABLINE)
5164 	{
5165 	    /* Selecting tabline tab or using its menu. */
5166 	    num_bytes = get_bytes_from_buf(tp + slen, bytes, 1);
5167 	    if (num_bytes == -1)
5168 		return -1;
5169 	    current_tab = (int)bytes[0];
5170 	    if (current_tab == 255)	/* -1 in a byte gives 255 */
5171 		current_tab = -1;
5172 	    slen += num_bytes;
5173 	}
5174 	else if (key_name[0] == (int)KS_TABMENU)
5175 	{
5176 	    /* Selecting tabline tab or using its menu. */
5177 	    num_bytes = get_bytes_from_buf(tp + slen, bytes, 2);
5178 	    if (num_bytes == -1)
5179 		return -1;
5180 	    current_tab = (int)bytes[0];
5181 	    current_tabmenu = (int)bytes[1];
5182 	    slen += num_bytes;
5183 	}
5184 # endif
5185 # ifndef USE_ON_FLY_SCROLL
5186 	else if (key_name[0] == (int)KS_VER_SCROLLBAR)
5187 	{
5188 	    long_u	val;
5189 
5190 	    /* Get the last scrollbar event in the queue of the same type */
5191 	    j = 0;
5192 	    for (i = 0; tp[j] == CSI && tp[j + 1] == KS_VER_SCROLLBAR
5193 						     && tp[j + 2] != NUL; ++i)
5194 	    {
5195 		j += 3;
5196 		num_bytes = get_bytes_from_buf(tp + j, bytes, 1);
5197 		if (num_bytes == -1)
5198 		    break;
5199 		if (i == 0)
5200 		    current_scrollbar = (int)bytes[0];
5201 		else if (current_scrollbar != (int)bytes[0])
5202 		    break;
5203 		j += num_bytes;
5204 		num_bytes = get_long_from_buf(tp + j, &val);
5205 		if (num_bytes == -1)
5206 		    break;
5207 		scrollbar_value = val;
5208 		j += num_bytes;
5209 		slen = j;
5210 	    }
5211 	    if (i == 0)		/* not enough characters to make one */
5212 		return -1;
5213 	}
5214 	else if (key_name[0] == (int)KS_HOR_SCROLLBAR)
5215 	{
5216 	    long_u	val;
5217 
5218 	    /* Get the last horiz. scrollbar event in the queue */
5219 	    j = 0;
5220 	    for (i = 0; tp[j] == CSI && tp[j + 1] == KS_HOR_SCROLLBAR
5221 						     && tp[j + 2] != NUL; ++i)
5222 	    {
5223 		j += 3;
5224 		num_bytes = get_long_from_buf(tp + j, &val);
5225 		if (num_bytes == -1)
5226 		    break;
5227 		scrollbar_value = val;
5228 		j += num_bytes;
5229 		slen = j;
5230 	    }
5231 	    if (i == 0)		/* not enough characters to make one */
5232 		return -1;
5233 	}
5234 # endif /* !USE_ON_FLY_SCROLL */
5235 #endif /* FEAT_GUI */
5236 
5237 	/*
5238 	 * Change <xHome> to <Home>, <xUp> to <Up>, etc.
5239 	 */
5240 	key = handle_x_keys(TERMCAP2KEY(key_name[0], key_name[1]));
5241 
5242 	/*
5243 	 * Add any modifier codes to our string.
5244 	 */
5245 	new_slen = 0;		/* Length of what will replace the termcode */
5246 	if (modifiers != 0)
5247 	{
5248 	    /* Some keys have the modifier included.  Need to handle that here
5249 	     * to make mappings work. */
5250 	    key = simplify_key(key, &modifiers);
5251 	    if (modifiers != 0)
5252 	    {
5253 		string[new_slen++] = K_SPECIAL;
5254 		string[new_slen++] = (int)KS_MODIFIER;
5255 		string[new_slen++] = modifiers;
5256 	    }
5257 	}
5258 
5259 	/* Finally, add the special key code to our string */
5260 	key_name[0] = KEY2TERMCAP0(key);
5261 	key_name[1] = KEY2TERMCAP1(key);
5262 	if (key_name[0] == KS_KEY)
5263 	{
5264 	    /* from ":set <M-b>=xx" */
5265 #ifdef FEAT_MBYTE
5266 	    if (has_mbyte)
5267 		new_slen += (*mb_char2bytes)(key_name[1], string + new_slen);
5268 	    else
5269 #endif
5270 		string[new_slen++] = key_name[1];
5271 	}
5272 	else if (new_slen == 0 && key_name[0] == KS_EXTRA
5273 						  && key_name[1] == KE_IGNORE)
5274 	{
5275 	    /* Do not put K_IGNORE into the buffer, do return KEYLEN_REMOVED
5276 	     * to indicate what happened. */
5277 	    retval = KEYLEN_REMOVED;
5278 	}
5279 	else
5280 	{
5281 	    string[new_slen++] = K_SPECIAL;
5282 	    string[new_slen++] = key_name[0];
5283 	    string[new_slen++] = key_name[1];
5284 	}
5285 	string[new_slen] = NUL;
5286 	extra = new_slen - slen;
5287 	if (buf == NULL)
5288 	{
5289 	    if (extra < 0)
5290 		/* remove matched chars, taking care of noremap */
5291 		del_typebuf(-extra, offset);
5292 	    else if (extra > 0)
5293 		/* insert the extra space we need */
5294 		ins_typebuf(string + slen, REMAP_YES, offset, FALSE, FALSE);
5295 
5296 	    /*
5297 	     * Careful: del_typebuf() and ins_typebuf() may have reallocated
5298 	     * typebuf.tb_buf[]!
5299 	     */
5300 	    mch_memmove(typebuf.tb_buf + typebuf.tb_off + offset, string,
5301 							    (size_t)new_slen);
5302 	}
5303 	else
5304 	{
5305 	    if (extra < 0)
5306 		/* remove matched characters */
5307 		mch_memmove(buf + offset, buf + offset - extra,
5308 					   (size_t)(*buflen + offset + extra));
5309 	    else if (extra > 0)
5310 	    {
5311 		/* Insert the extra space we need.  If there is insufficient
5312 		 * space return -1. */
5313 		if (*buflen + extra + new_slen >= bufsize)
5314 		    return -1;
5315 		mch_memmove(buf + offset + extra, buf + offset,
5316 						   (size_t)(*buflen - offset));
5317 	    }
5318 	    mch_memmove(buf + offset, string, (size_t)new_slen);
5319 	    *buflen = *buflen + extra + new_slen;
5320 	}
5321 	return retval == 0 ? (len + extra + offset) : retval;
5322     }
5323 
5324 #ifdef FEAT_TERMRESPONSE
5325     LOG_TR("normal character");
5326 #endif
5327 
5328     return 0;			    /* no match found */
5329 }
5330 
5331 /*
5332  * Replace any terminal code strings in from[] with the equivalent internal
5333  * vim representation.	This is used for the "from" and "to" part of a
5334  * mapping, and the "to" part of a menu command.
5335  * Any strings like "<C-UP>" are also replaced, unless 'cpoptions' contains
5336  * '<'.
5337  * K_SPECIAL by itself is replaced by K_SPECIAL KS_SPECIAL KE_FILLER.
5338  *
5339  * The replacement is done in result[] and finally copied into allocated
5340  * memory. If this all works well *bufp is set to the allocated memory and a
5341  * pointer to it is returned. If something fails *bufp is set to NULL and from
5342  * is returned.
5343  *
5344  * CTRL-V characters are removed.  When "from_part" is TRUE, a trailing CTRL-V
5345  * is included, otherwise it is removed (for ":map xx ^V", maps xx to
5346  * nothing).  When 'cpoptions' does not contain 'B', a backslash can be used
5347  * instead of a CTRL-V.
5348  */
5349     char_u *
5350 replace_termcodes(
5351     char_u	*from,
5352     char_u	**bufp,
5353     int		from_part,
5354     int		do_lt,		/* also translate <lt> */
5355     int		special)	/* always accept <key> notation */
5356 {
5357     int		i;
5358     int		slen;
5359     int		key;
5360     int		dlen = 0;
5361     char_u	*src;
5362     int		do_backslash;	/* backslash is a special character */
5363     int		do_special;	/* recognize <> key codes */
5364     int		do_key_code;	/* recognize raw key codes */
5365     char_u	*result;	/* buffer for resulting string */
5366 
5367     do_backslash = (vim_strchr(p_cpo, CPO_BSLASH) == NULL);
5368     do_special = (vim_strchr(p_cpo, CPO_SPECI) == NULL) || special;
5369     do_key_code = (vim_strchr(p_cpo, CPO_KEYCODE) == NULL);
5370 
5371     /*
5372      * Allocate space for the translation.  Worst case a single character is
5373      * replaced by 6 bytes (shifted special key), plus a NUL at the end.
5374      */
5375     result = alloc((unsigned)STRLEN(from) * 6 + 1);
5376     if (result == NULL)		/* out of memory */
5377     {
5378 	*bufp = NULL;
5379 	return from;
5380     }
5381 
5382     src = from;
5383 
5384     /*
5385      * Check for #n at start only: function key n
5386      */
5387     if (from_part && src[0] == '#' && VIM_ISDIGIT(src[1]))  /* function key */
5388     {
5389 	result[dlen++] = K_SPECIAL;
5390 	result[dlen++] = 'k';
5391 	if (src[1] == '0')
5392 	    result[dlen++] = ';';	/* #0 is F10 is "k;" */
5393 	else
5394 	    result[dlen++] = src[1];	/* #3 is F3 is "k3" */
5395 	src += 2;
5396     }
5397 
5398     /*
5399      * Copy each byte from *from to result[dlen]
5400      */
5401     while (*src != NUL)
5402     {
5403 	/*
5404 	 * If 'cpoptions' does not contain '<', check for special key codes,
5405 	 * like "<C-S-LeftMouse>"
5406 	 */
5407 	if (do_special && (do_lt || STRNCMP(src, "<lt>", 4) != 0))
5408 	{
5409 #ifdef FEAT_EVAL
5410 	    /*
5411 	     * Replace <SID> by K_SNR <script-nr> _.
5412 	     * (room: 5 * 6 = 30 bytes; needed: 3 + <nr> + 1 <= 14)
5413 	     */
5414 	    if (STRNICMP(src, "<SID>", 5) == 0)
5415 	    {
5416 		if (current_SID <= 0)
5417 		    EMSG(_(e_usingsid));
5418 		else
5419 		{
5420 		    src += 5;
5421 		    result[dlen++] = K_SPECIAL;
5422 		    result[dlen++] = (int)KS_EXTRA;
5423 		    result[dlen++] = (int)KE_SNR;
5424 		    sprintf((char *)result + dlen, "%ld", (long)current_SID);
5425 		    dlen += (int)STRLEN(result + dlen);
5426 		    result[dlen++] = '_';
5427 		    continue;
5428 		}
5429 	    }
5430 #endif
5431 
5432 	    slen = trans_special(&src, result + dlen, TRUE, FALSE);
5433 	    if (slen)
5434 	    {
5435 		dlen += slen;
5436 		continue;
5437 	    }
5438 	}
5439 
5440 	/*
5441 	 * If 'cpoptions' does not contain 'k', see if it's an actual key-code.
5442 	 * Note that this is also checked after replacing the <> form.
5443 	 * Single character codes are NOT replaced (e.g. ^H or DEL), because
5444 	 * it could be a character in the file.
5445 	 */
5446 	if (do_key_code)
5447 	{
5448 	    i = find_term_bykeys(src);
5449 	    if (i >= 0)
5450 	    {
5451 		result[dlen++] = K_SPECIAL;
5452 		result[dlen++] = termcodes[i].name[0];
5453 		result[dlen++] = termcodes[i].name[1];
5454 		src += termcodes[i].len;
5455 		/* If terminal code matched, continue after it. */
5456 		continue;
5457 	    }
5458 	}
5459 
5460 #ifdef FEAT_EVAL
5461 	if (do_special)
5462 	{
5463 	    char_u	*p, *s, len;
5464 
5465 	    /*
5466 	     * Replace <Leader> by the value of "mapleader".
5467 	     * Replace <LocalLeader> by the value of "maplocalleader".
5468 	     * If "mapleader" or "maplocalleader" isn't set use a backslash.
5469 	     */
5470 	    if (STRNICMP(src, "<Leader>", 8) == 0)
5471 	    {
5472 		len = 8;
5473 		p = get_var_value((char_u *)"g:mapleader");
5474 	    }
5475 	    else if (STRNICMP(src, "<LocalLeader>", 13) == 0)
5476 	    {
5477 		len = 13;
5478 		p = get_var_value((char_u *)"g:maplocalleader");
5479 	    }
5480 	    else
5481 	    {
5482 		len = 0;
5483 		p = NULL;
5484 	    }
5485 	    if (len != 0)
5486 	    {
5487 		/* Allow up to 8 * 6 characters for "mapleader". */
5488 		if (p == NULL || *p == NUL || STRLEN(p) > 8 * 6)
5489 		    s = (char_u *)"\\";
5490 		else
5491 		    s = p;
5492 		while (*s != NUL)
5493 		    result[dlen++] = *s++;
5494 		src += len;
5495 		continue;
5496 	    }
5497 	}
5498 #endif
5499 
5500 	/*
5501 	 * Remove CTRL-V and ignore the next character.
5502 	 * For "from" side the CTRL-V at the end is included, for the "to"
5503 	 * part it is removed.
5504 	 * If 'cpoptions' does not contain 'B', also accept a backslash.
5505 	 */
5506 	key = *src;
5507 	if (key == Ctrl_V || (do_backslash && key == '\\'))
5508 	{
5509 	    ++src;				/* skip CTRL-V or backslash */
5510 	    if (*src == NUL)
5511 	    {
5512 		if (from_part)
5513 		    result[dlen++] = key;
5514 		break;
5515 	    }
5516 	}
5517 
5518 #ifdef FEAT_MBYTE
5519 	/* skip multibyte char correctly */
5520 	for (i = (*mb_ptr2len)(src); i > 0; --i)
5521 #endif
5522 	{
5523 	    /*
5524 	     * If the character is K_SPECIAL, replace it with K_SPECIAL
5525 	     * KS_SPECIAL KE_FILLER.
5526 	     * If compiled with the GUI replace CSI with K_CSI.
5527 	     */
5528 	    if (*src == K_SPECIAL)
5529 	    {
5530 		result[dlen++] = K_SPECIAL;
5531 		result[dlen++] = KS_SPECIAL;
5532 		result[dlen++] = KE_FILLER;
5533 	    }
5534 # ifdef FEAT_GUI
5535 	    else if (*src == CSI)
5536 	    {
5537 		result[dlen++] = K_SPECIAL;
5538 		result[dlen++] = KS_EXTRA;
5539 		result[dlen++] = (int)KE_CSI;
5540 	    }
5541 # endif
5542 	    else
5543 		result[dlen++] = *src;
5544 	    ++src;
5545 	}
5546     }
5547     result[dlen] = NUL;
5548 
5549     /*
5550      * Copy the new string to allocated memory.
5551      * If this fails, just return from.
5552      */
5553     if ((*bufp = vim_strsave(result)) != NULL)
5554 	from = *bufp;
5555     vim_free(result);
5556     return from;
5557 }
5558 
5559 /*
5560  * Find a termcode with keys 'src' (must be NUL terminated).
5561  * Return the index in termcodes[], or -1 if not found.
5562  */
5563     int
5564 find_term_bykeys(char_u *src)
5565 {
5566     int		i;
5567     int		slen = (int)STRLEN(src);
5568 
5569     for (i = 0; i < tc_len; ++i)
5570     {
5571 	if (slen == termcodes[i].len
5572 			&& STRNCMP(termcodes[i].code, src, (size_t)slen) == 0)
5573 	    return i;
5574     }
5575     return -1;
5576 }
5577 
5578 /*
5579  * Gather the first characters in the terminal key codes into a string.
5580  * Used to speed up check_termcode().
5581  */
5582     static void
5583 gather_termleader(void)
5584 {
5585     int	    i;
5586     int	    len = 0;
5587 
5588 #ifdef FEAT_GUI
5589     if (gui.in_use)
5590 	termleader[len++] = CSI;    /* the GUI codes are not in termcodes[] */
5591 #endif
5592 #ifdef FEAT_TERMRESPONSE
5593     if (check_for_codes)
5594 	termleader[len++] = DCS;    /* the termcode response starts with DCS
5595 				       in 8-bit mode */
5596 #endif
5597     termleader[len] = NUL;
5598 
5599     for (i = 0; i < tc_len; ++i)
5600 	if (vim_strchr(termleader, termcodes[i].code[0]) == NULL)
5601 	{
5602 	    termleader[len++] = termcodes[i].code[0];
5603 	    termleader[len] = NUL;
5604 	}
5605 
5606     need_gather = FALSE;
5607 }
5608 
5609 /*
5610  * Show all termcodes (for ":set termcap")
5611  * This code looks a lot like showoptions(), but is different.
5612  */
5613     void
5614 show_termcodes(void)
5615 {
5616     int		col;
5617     int		*items;
5618     int		item_count;
5619     int		run;
5620     int		row, rows;
5621     int		cols;
5622     int		i;
5623     int		len;
5624 
5625 #define INC3 27	    /* try to make three columns */
5626 #define INC2 40	    /* try to make two columns */
5627 #define GAP 2	    /* spaces between columns */
5628 
5629     if (tc_len == 0)	    /* no terminal codes (must be GUI) */
5630 	return;
5631     items = (int *)alloc((unsigned)(sizeof(int) * tc_len));
5632     if (items == NULL)
5633 	return;
5634 
5635     /* Highlight title */
5636     MSG_PUTS_TITLE(_("\n--- Terminal keys ---"));
5637 
5638     /*
5639      * do the loop two times:
5640      * 1. display the short items (non-strings and short strings)
5641      * 2. display the medium items (medium length strings)
5642      * 3. display the long items (remaining strings)
5643      */
5644     for (run = 1; run <= 3 && !got_int; ++run)
5645     {
5646 	/*
5647 	 * collect the items in items[]
5648 	 */
5649 	item_count = 0;
5650 	for (i = 0; i < tc_len; i++)
5651 	{
5652 	    len = show_one_termcode(termcodes[i].name,
5653 						    termcodes[i].code, FALSE);
5654 	    if (len <= INC3 - GAP ? run == 1
5655 			: len <= INC2 - GAP ? run == 2
5656 			: run == 3)
5657 		items[item_count++] = i;
5658 	}
5659 
5660 	/*
5661 	 * display the items
5662 	 */
5663 	if (run <= 2)
5664 	{
5665 	    cols = (Columns + GAP) / (run == 1 ? INC3 : INC2);
5666 	    if (cols == 0)
5667 		cols = 1;
5668 	    rows = (item_count + cols - 1) / cols;
5669 	}
5670 	else	/* run == 3 */
5671 	    rows = item_count;
5672 	for (row = 0; row < rows && !got_int; ++row)
5673 	{
5674 	    msg_putchar('\n');			/* go to next line */
5675 	    if (got_int)			/* 'q' typed in more */
5676 		break;
5677 	    col = 0;
5678 	    for (i = row; i < item_count; i += rows)
5679 	    {
5680 		msg_col = col;			/* make columns */
5681 		show_one_termcode(termcodes[items[i]].name,
5682 					      termcodes[items[i]].code, TRUE);
5683 		if (run == 2)
5684 		    col += INC2;
5685 		else
5686 		    col += INC3;
5687 	    }
5688 	    out_flush();
5689 	    ui_breakcheck();
5690 	}
5691     }
5692     vim_free(items);
5693 }
5694 
5695 /*
5696  * Show one termcode entry.
5697  * Output goes into IObuff[]
5698  */
5699     int
5700 show_one_termcode(char_u *name, char_u *code, int printit)
5701 {
5702     char_u	*p;
5703     int		len;
5704 
5705     if (name[0] > '~')
5706     {
5707 	IObuff[0] = ' ';
5708 	IObuff[1] = ' ';
5709 	IObuff[2] = ' ';
5710 	IObuff[3] = ' ';
5711     }
5712     else
5713     {
5714 	IObuff[0] = 't';
5715 	IObuff[1] = '_';
5716 	IObuff[2] = name[0];
5717 	IObuff[3] = name[1];
5718     }
5719     IObuff[4] = ' ';
5720 
5721     p = get_special_key_name(TERMCAP2KEY(name[0], name[1]), 0);
5722     if (p[1] != 't')
5723 	STRCPY(IObuff + 5, p);
5724     else
5725 	IObuff[5] = NUL;
5726     len = (int)STRLEN(IObuff);
5727     do
5728 	IObuff[len++] = ' ';
5729     while (len < 17);
5730     IObuff[len] = NUL;
5731     if (code == NULL)
5732 	len += 4;
5733     else
5734 	len += vim_strsize(code);
5735 
5736     if (printit)
5737     {
5738 	msg_puts(IObuff);
5739 	if (code == NULL)
5740 	    msg_puts((char_u *)"NULL");
5741 	else
5742 	    msg_outtrans(code);
5743     }
5744     return len;
5745 }
5746 
5747 #if defined(FEAT_TERMRESPONSE) || defined(PROTO)
5748 /*
5749  * For Xterm >= 140 compiled with OPT_TCAP_QUERY: Obtain the actually used
5750  * termcap codes from the terminal itself.
5751  * We get them one by one to avoid a very long response string.
5752  */
5753 static int xt_index_in = 0;
5754 static int xt_index_out = 0;
5755 
5756     static void
5757 req_codes_from_term(void)
5758 {
5759     xt_index_out = 0;
5760     xt_index_in = 0;
5761     req_more_codes_from_term();
5762 }
5763 
5764     static void
5765 req_more_codes_from_term(void)
5766 {
5767     char	buf[11];
5768     int		old_idx = xt_index_out;
5769 
5770     /* Don't do anything when going to exit. */
5771     if (exiting)
5772 	return;
5773 
5774     /* Send up to 10 more requests out than we received.  Avoid sending too
5775      * many, there can be a buffer overflow somewhere. */
5776     while (xt_index_out < xt_index_in + 10 && key_names[xt_index_out] != NULL)
5777     {
5778 # ifdef DEBUG_TERMRESPONSE
5779 	char dbuf[100];
5780 
5781 	sprintf(dbuf, "Requesting XT %d: %s",
5782 				       xt_index_out, key_names[xt_index_out]);
5783 	log_tr(dbuf);
5784 # endif
5785 	sprintf(buf, "\033P+q%02x%02x\033\\",
5786 		      key_names[xt_index_out][0], key_names[xt_index_out][1]);
5787 	out_str_nf((char_u *)buf);
5788 	++xt_index_out;
5789     }
5790 
5791     /* Send the codes out right away. */
5792     if (xt_index_out != old_idx)
5793 	out_flush();
5794 }
5795 
5796 /*
5797  * Decode key code response from xterm: '<Esc>P1+r<name>=<string><Esc>\'.
5798  * A "0" instead of the "1" indicates a code that isn't supported.
5799  * Both <name> and <string> are encoded in hex.
5800  * "code" points to the "0" or "1".
5801  */
5802     static void
5803 got_code_from_term(char_u *code, int len)
5804 {
5805 #define XT_LEN 100
5806     char_u	name[3];
5807     char_u	str[XT_LEN];
5808     int		i;
5809     int		j = 0;
5810     int		c;
5811 
5812     /* A '1' means the code is supported, a '0' means it isn't.
5813      * When half the length is > XT_LEN we can't use it.
5814      * Our names are currently all 2 characters. */
5815     if (code[0] == '1' && code[7] == '=' && len / 2 < XT_LEN)
5816     {
5817 	/* Get the name from the response and find it in the table. */
5818 	name[0] = hexhex2nr(code + 3);
5819 	name[1] = hexhex2nr(code + 5);
5820 	name[2] = NUL;
5821 	for (i = 0; key_names[i] != NULL; ++i)
5822 	{
5823 	    if (STRCMP(key_names[i], name) == 0)
5824 	    {
5825 		xt_index_in = i;
5826 		break;
5827 	    }
5828 	}
5829 # ifdef DEBUG_TERMRESPONSE
5830 	{
5831 	    char buf[100];
5832 
5833 	    sprintf(buf, "Received XT %d: %s", xt_index_in, (char *)name);
5834 	    log_tr(buf);
5835 	}
5836 # endif
5837 	if (key_names[i] != NULL)
5838 	{
5839 	    for (i = 8; (c = hexhex2nr(code + i)) >= 0; i += 2)
5840 		str[j++] = c;
5841 	    str[j] = NUL;
5842 	    if (name[0] == 'C' && name[1] == 'o')
5843 	    {
5844 		/* Color count is not a key code. */
5845 		i = atoi((char *)str);
5846 		if (i != t_colors)
5847 		{
5848 		    /* Nr of colors changed, initialize highlighting and
5849 		     * redraw everything.  This causes a redraw, which usually
5850 		     * clears the message.  Try keeping the message if it
5851 		     * might work. */
5852 		    set_keep_msg_from_hist();
5853 		    set_color_count(i);
5854 		    init_highlight(TRUE, FALSE);
5855 #ifdef DEBUG_TERMRESPONSE
5856 		    {
5857 			char buf[100];
5858 			int  r = redraw_asap(CLEAR);
5859 
5860 			sprintf(buf, "Received t_Co, redraw_asap(): %d", r);
5861 			log_tr(buf);
5862 		    }
5863 #else
5864 		    redraw_asap(CLEAR);
5865 #endif
5866 		}
5867 	    }
5868 	    else
5869 	    {
5870 		/* First delete any existing entry with the same code. */
5871 		i = find_term_bykeys(str);
5872 		if (i >= 0)
5873 		    del_termcode_idx(i);
5874 		add_termcode(name, str, ATC_FROM_TERM);
5875 	    }
5876 	}
5877     }
5878 
5879     /* May request more codes now that we received one. */
5880     ++xt_index_in;
5881     req_more_codes_from_term();
5882 }
5883 
5884 /*
5885  * Check if there are any unanswered requests and deal with them.
5886  * This is called before starting an external program or getting direct
5887  * keyboard input.  We don't want responses to be send to that program or
5888  * handled as typed text.
5889  */
5890     static void
5891 check_for_codes_from_term(void)
5892 {
5893     int		c;
5894 
5895     /* If no codes requested or all are answered, no need to wait. */
5896     if (xt_index_out == 0 || xt_index_out == xt_index_in)
5897 	return;
5898 
5899     /* Vgetc() will check for and handle any response.
5900      * Keep calling vpeekc() until we don't get any responses. */
5901     ++no_mapping;
5902     ++allow_keys;
5903     for (;;)
5904     {
5905 	c = vpeekc();
5906 	if (c == NUL)	    /* nothing available */
5907 	    break;
5908 
5909 	/* If a response is recognized it's replaced with K_IGNORE, must read
5910 	 * it from the input stream.  If there is no K_IGNORE we can't do
5911 	 * anything, break here (there might be some responses further on, but
5912 	 * we don't want to throw away any typed chars). */
5913 	if (c != K_SPECIAL && c != K_IGNORE)
5914 	    break;
5915 	c = vgetc();
5916 	if (c != K_IGNORE)
5917 	{
5918 	    vungetc(c);
5919 	    break;
5920 	}
5921     }
5922     --no_mapping;
5923     --allow_keys;
5924 }
5925 #endif
5926 
5927 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
5928 /*
5929  * Translate an internal mapping/abbreviation representation into the
5930  * corresponding external one recognized by :map/:abbrev commands;
5931  * respects the current B/k/< settings of 'cpoption'.
5932  *
5933  * This function is called when expanding mappings/abbreviations on the
5934  * command-line, and for building the "Ambiguous mapping..." error message.
5935  *
5936  * It uses a growarray to build the translation string since the
5937  * latter can be wider than the original description. The caller has to
5938  * free the string afterwards.
5939  *
5940  * Returns NULL when there is a problem.
5941  */
5942     char_u *
5943 translate_mapping(
5944     char_u	*str,
5945     int		expmap)  /* TRUE when expanding mappings on command-line */
5946 {
5947     garray_T	ga;
5948     int		c;
5949     int		modifiers;
5950     int		cpo_bslash;
5951     int		cpo_special;
5952     int		cpo_keycode;
5953 
5954     ga_init(&ga);
5955     ga.ga_itemsize = 1;
5956     ga.ga_growsize = 40;
5957 
5958     cpo_bslash = (vim_strchr(p_cpo, CPO_BSLASH) != NULL);
5959     cpo_special = (vim_strchr(p_cpo, CPO_SPECI) != NULL);
5960     cpo_keycode = (vim_strchr(p_cpo, CPO_KEYCODE) == NULL);
5961 
5962     for (; *str; ++str)
5963     {
5964 	c = *str;
5965 	if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
5966 	{
5967 	    modifiers = 0;
5968 	    if (str[1] == KS_MODIFIER)
5969 	    {
5970 		str++;
5971 		modifiers = *++str;
5972 		c = *++str;
5973 	    }
5974 	    if (cpo_special && cpo_keycode && c == K_SPECIAL && !modifiers)
5975 	    {
5976 		int	i;
5977 
5978 		/* try to find special key in termcodes */
5979 		for (i = 0; i < tc_len; ++i)
5980 		    if (termcodes[i].name[0] == str[1]
5981 					    && termcodes[i].name[1] == str[2])
5982 			break;
5983 		if (i < tc_len)
5984 		{
5985 		    ga_concat(&ga, termcodes[i].code);
5986 		    str += 2;
5987 		    continue; /* for (str) */
5988 		}
5989 	    }
5990 	    if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
5991 	    {
5992 		if (expmap && cpo_special)
5993 		{
5994 		    ga_clear(&ga);
5995 		    return NULL;
5996 		}
5997 		c = TO_SPECIAL(str[1], str[2]);
5998 		if (c == K_ZERO)	/* display <Nul> as ^@ */
5999 		    c = NUL;
6000 		str += 2;
6001 	    }
6002 	    if (IS_SPECIAL(c) || modifiers)	/* special key */
6003 	    {
6004 		if (expmap && cpo_special)
6005 		{
6006 		    ga_clear(&ga);
6007 		    return NULL;
6008 		}
6009 		ga_concat(&ga, get_special_key_name(c, modifiers));
6010 		continue; /* for (str) */
6011 	    }
6012 	}
6013 	if (c == ' ' || c == '\t' || c == Ctrl_J || c == Ctrl_V
6014 	    || (c == '<' && !cpo_special) || (c == '\\' && !cpo_bslash))
6015 	    ga_append(&ga, cpo_bslash ? Ctrl_V : '\\');
6016 	if (c)
6017 	    ga_append(&ga, c);
6018     }
6019     ga_append(&ga, NUL);
6020     return (char_u *)(ga.ga_data);
6021 }
6022 #endif
6023 
6024 #if (defined(WIN3264) && !defined(FEAT_GUI)) || defined(PROTO)
6025 static char ksme_str[20];
6026 static char ksmr_str[20];
6027 static char ksmd_str[20];
6028 
6029 /*
6030  * For Win32 console: update termcap codes for existing console attributes.
6031  */
6032     void
6033 update_tcap(int attr)
6034 {
6035     struct builtin_term *p;
6036 
6037     p = find_builtin_term(DEFAULT_TERM);
6038     sprintf(ksme_str, IF_EB("\033|%dm", ESC_STR "|%dm"), attr);
6039     sprintf(ksmd_str, IF_EB("\033|%dm", ESC_STR "|%dm"),
6040 				     attr | 0x08);  /* FOREGROUND_INTENSITY */
6041     sprintf(ksmr_str, IF_EB("\033|%dm", ESC_STR "|%dm"),
6042 				 ((attr & 0x0F) << 4) | ((attr & 0xF0) >> 4));
6043 
6044     while (p->bt_string != NULL)
6045     {
6046       if (p->bt_entry == (int)KS_ME)
6047 	  p->bt_string = &ksme_str[0];
6048       else if (p->bt_entry == (int)KS_MR)
6049 	  p->bt_string = &ksmr_str[0];
6050       else if (p->bt_entry == (int)KS_MD)
6051 	  p->bt_string = &ksmd_str[0];
6052       ++p;
6053     }
6054 }
6055 #endif
6056 
6057 #if defined(FEAT_GUI) || defined(FEAT_TERMGUICOLORS) || defined(PROTO)
6058     static int
6059 hex_digit(int c)
6060 {
6061     if (isdigit(c))
6062 	return c - '0';
6063     c = TOLOWER_ASC(c);
6064     if (c >= 'a' && c <= 'f')
6065 	return c - 'a' + 10;
6066     return 0x1ffffff;
6067 }
6068 
6069     guicolor_T
6070 gui_get_color_cmn(char_u *name)
6071 {
6072     /* On MS-Windows an RGB macro is available and it's different from ours,
6073      * but does what is needed. */
6074 # ifndef RGB
6075 #  define RGB(r, g, b)	((r<<16) | (g<<8) | (b))
6076 # endif
6077 # define LINE_LEN 100
6078     FILE	*fd;
6079     char	line[LINE_LEN];
6080     char_u	*fname;
6081     int		r, g, b, i;
6082     guicolor_T  color;
6083 
6084     struct rgbcolor_table_S {
6085 	char_u	    *color_name;
6086 	guicolor_T  color;
6087     };
6088 
6089     /* Only non X11 colors (not present in rgb.txt) and colors in
6090      * color_names[], useful when $VIMRUNTIME is not found,. */
6091     static struct rgbcolor_table_S rgb_table[] = {
6092 	    {(char_u *)"black",		RGB(0x00, 0x00, 0x00)},
6093 	    {(char_u *)"blue",		RGB(0x00, 0x00, 0xFF)},
6094 	    {(char_u *)"brown",		RGB(0xA5, 0x2A, 0x2A)},
6095 	    {(char_u *)"cyan",		RGB(0x00, 0xFF, 0xFF)},
6096 	    {(char_u *)"darkblue",	RGB(0x00, 0x00, 0x8B)},
6097 	    {(char_u *)"darkcyan",	RGB(0x00, 0x8B, 0x8B)},
6098 	    {(char_u *)"darkgray",	RGB(0xA9, 0xA9, 0xA9)},
6099 	    {(char_u *)"darkgreen",	RGB(0x00, 0x64, 0x00)},
6100 	    {(char_u *)"darkgrey",	RGB(0xA9, 0xA9, 0xA9)},
6101 	    {(char_u *)"darkmagenta",	RGB(0x8B, 0x00, 0x8B)},
6102 	    {(char_u *)"darkred",	RGB(0x8B, 0x00, 0x00)},
6103 	    {(char_u *)"darkyellow",	RGB(0x8B, 0x8B, 0x00)}, /* No X11 */
6104 	    {(char_u *)"gray",		RGB(0xBE, 0xBE, 0xBE)},
6105 	    {(char_u *)"green",		RGB(0x00, 0xFF, 0x00)},
6106 	    {(char_u *)"grey",		RGB(0xBE, 0xBE, 0xBE)},
6107 	    {(char_u *)"grey40",	RGB(0x66, 0x66, 0x66)},
6108 	    {(char_u *)"grey90",	RGB(0xE5, 0xE5, 0xE5)},
6109 	    {(char_u *)"lightblue",	RGB(0xAD, 0xD8, 0xE6)},
6110 	    {(char_u *)"lightcyan",	RGB(0xE0, 0xFF, 0xFF)},
6111 	    {(char_u *)"lightgray",	RGB(0xD3, 0xD3, 0xD3)},
6112 	    {(char_u *)"lightgreen",	RGB(0x90, 0xEE, 0x90)},
6113 	    {(char_u *)"lightgrey",	RGB(0xD3, 0xD3, 0xD3)},
6114 	    {(char_u *)"lightmagenta",	RGB(0xFF, 0x8B, 0xFF)}, /* No X11 */
6115 	    {(char_u *)"lightred",	RGB(0xFF, 0x8B, 0x8B)}, /* No X11 */
6116 	    {(char_u *)"lightyellow",	RGB(0xFF, 0xFF, 0xE0)},
6117 	    {(char_u *)"magenta",	RGB(0xFF, 0x00, 0xFF)},
6118 	    {(char_u *)"red",		RGB(0xFF, 0x00, 0x00)},
6119 	    {(char_u *)"seagreen",	RGB(0x2E, 0x8B, 0x57)},
6120 	    {(char_u *)"white",		RGB(0xFF, 0xFF, 0xFF)},
6121 	    {(char_u *)"yellow",	RGB(0xFF, 0xFF, 0x00)},
6122     };
6123 
6124     static struct rgbcolor_table_S *colornames_table;
6125     static int size = 0;
6126 
6127     if (name[0] == '#' && STRLEN(name) == 7)
6128     {
6129 	/* Name is in "#rrggbb" format */
6130 	color = RGB(((hex_digit(name[1]) << 4) + hex_digit(name[2])),
6131 		    ((hex_digit(name[3]) << 4) + hex_digit(name[4])),
6132 		    ((hex_digit(name[5]) << 4) + hex_digit(name[6])));
6133 	if (color > 0xffffff)
6134 	    return INVALCOLOR;
6135 	return color;
6136     }
6137 
6138     /* Check if the name is one of the colors we know */
6139     for (i = 0; i < (int)(sizeof(rgb_table) / sizeof(rgb_table[0])); i++)
6140 	if (STRICMP(name, rgb_table[i].color_name) == 0)
6141 	    return rgb_table[i].color;
6142 
6143     /*
6144      * Last attempt. Look in the file "$VIM/rgb.txt".
6145      */
6146     if (size == 0)
6147     {
6148 	int counting;
6149 
6150 	/* colornames_table not yet initialized */
6151 	fname = expand_env_save((char_u *)"$VIMRUNTIME/rgb.txt");
6152 	if (fname == NULL)
6153 	    return INVALCOLOR;
6154 
6155 	fd = fopen((char *)fname, "rt");
6156 	vim_free(fname);
6157 	if (fd == NULL)
6158 	{
6159 	    if (p_verbose > 1)
6160 		verb_msg((char_u *)_("Cannot open $VIMRUNTIME/rgb.txt"));
6161 	    return INVALCOLOR;
6162 	}
6163 
6164 	for (counting = 1; counting >= 0; --counting)
6165 	{
6166 	    if (!counting)
6167 	    {
6168 		colornames_table = (struct rgbcolor_table_S *)alloc(
6169 			   (unsigned)(sizeof(struct rgbcolor_table_S) * size));
6170 		if (colornames_table == NULL)
6171 		{
6172 		    fclose(fd);
6173 		    return INVALCOLOR;
6174 		}
6175 		rewind(fd);
6176 	    }
6177 	    size = 0;
6178 
6179 	    while (!feof(fd))
6180 	    {
6181 		size_t	len;
6182 		int	pos;
6183 
6184 		ignoredp = fgets(line, LINE_LEN, fd);
6185 		len = strlen(line);
6186 
6187 		if (len <= 1 || line[len - 1] != '\n')
6188 		    continue;
6189 
6190 		line[len - 1] = '\0';
6191 
6192 		i = sscanf(line, "%d %d %d %n", &r, &g, &b, &pos);
6193 		if (i != 3)
6194 		    continue;
6195 
6196 		if (!counting)
6197 		{
6198 		    char_u *s = vim_strsave((char_u *)line + pos);
6199 
6200 		    if (s == NULL)
6201 		    {
6202 			fclose(fd);
6203 			return INVALCOLOR;
6204 		    }
6205 		    colornames_table[size].color_name = s;
6206 		    colornames_table[size].color = (guicolor_T)RGB(r, g, b);
6207 		}
6208 		size++;
6209 	    }
6210 	}
6211 	fclose(fd);
6212     }
6213 
6214     for (i = 0; i < size; i++)
6215 	if (STRICMP(name, colornames_table[i].color_name) == 0)
6216 	    return colornames_table[i].color;
6217 
6218     return INVALCOLOR;
6219 }
6220 #endif
6221