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