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