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