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