blob: 82b1126e7e4cf7f390c9971d88ef96156ee3f09b [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
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 *
Bram Moolenaar48e330a2016-02-23 14:53:34 +010013 * primitive termcap support for Amiga and Win32 included
Bram Moolenaar071d4272004-06-13 20:20:40 +000014 *
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 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000024#define tgetstr tgetstr_defined_wrong
Bram Moolenaarad3ec762019-04-21 00:00:13 +020025
Bram Moolenaar071d4272004-06-13 20:20:40 +000026#include "vim.h"
27
28#ifdef HAVE_TGETENT
29# ifdef HAVE_TERMIOS_H
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +010030# include <termios.h> // seems to be required for some Linux
Bram Moolenaar071d4272004-06-13 20:20:40 +000031# endif
32# ifdef HAVE_TERMCAP_H
33# include <termcap.h>
34# endif
35
36/*
37 * A few linux systems define outfuntype in termcap.h to be used as the third
38 * argument for tputs().
39 */
40# ifdef VMS
41# define TPUTSFUNCAST
42# else
43# ifdef HAVE_OUTFUNTYPE
44# define TPUTSFUNCAST (outfuntype)
45# else
46# define TPUTSFUNCAST (int (*)())
47# endif
48# endif
49#endif
50
51#undef tgetstr
52
53/*
54 * Here are the builtin termcap entries. They are not stored as complete
Bram Moolenaare60acc12011-05-10 16:41:25 +020055 * structures with all entries, as such a structure is too big.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056 *
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 */
68struct builtin_term
69{
70 int bt_entry;
71 char *bt_string;
72};
73
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +010074// start of keys that are not directly used by Vim but can be mapped
Bram Moolenaar071d4272004-06-13 20:20:40 +000075#define BT_EXTRA_KEYS 0x101
76
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010077static void parse_builtin_tcap(char_u *s);
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010078static void gather_termleader(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000079#ifdef FEAT_TERMRESPONSE
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010080static void req_codes_from_term(void);
81static void req_more_codes_from_term(void);
82static void got_code_from_term(char_u *code, int len);
83static void check_for_codes_from_term(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000084#endif
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010085static void del_termcode_idx(int idx);
Bram Moolenaar5843f5f2019-08-20 20:13:45 +020086static int find_term_bykeys(char_u *src);
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010087static int term_is_builtin(char_u *name);
88static int term_7to8bit(char_u *p);
Bram Moolenaar071d4272004-06-13 20:20:40 +000089
90#ifdef HAVE_TGETENT
Bram Moolenaarf9e3e092019-01-13 23:38:42 +010091static char *tgetent_error(char_u *, char_u *);
Bram Moolenaar071d4272004-06-13 20:20:40 +000092
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 */
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010097char *tgetstr(char *, char **);
Bram Moolenaar071d4272004-06-13 20:20:40 +000098
99# ifdef FEAT_TERMRESPONSE
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100100 // Change this to "if 1" to debug what happens with termresponse.
Bram Moolenaar2951b772013-07-03 12:45:31 +0200101# if 0
102# define DEBUG_TERMRESPONSE
Bram Moolenaarb255b902018-04-24 21:40:10 +0200103static void log_tr(const char *fmt, ...);
104# define LOG_TR(msg) log_tr msg
Bram Moolenaar2951b772013-07-03 12:45:31 +0200105# else
Bram Moolenaarb255b902018-04-24 21:40:10 +0200106# define LOG_TR(msg) do { /**/ } while (0)
Bram Moolenaar2951b772013-07-03 12:45:31 +0200107# endif
Bram Moolenaar3eee06e2017-08-19 19:40:50 +0200108
Bram Moolenaarafd78262019-05-10 23:10:31 +0200109typedef 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;
Bram Moolenaar3eee06e2017-08-19 19:40:50 +0200115
Bram Moolenaarafd78262019-05-10 23:10:31 +0200116typedef struct {
117 request_progress_T tr_progress;
118 time_t tr_start; // when request was sent, -1 for never
119} termrequest_T;
Bram Moolenaar3eee06e2017-08-19 19:40:50 +0200120
Bram Moolenaarafd78262019-05-10 23:10:31 +0200121# define TERMREQUEST_INIT {STATUS_GET, -1}
122
123// Request Terminal Version status:
124static termrequest_T crv_status = TERMREQUEST_INIT;
125
126// Request Cursor position report:
127static termrequest_T u7_status = TERMREQUEST_INIT;
Bram Moolenaar3eee06e2017-08-19 19:40:50 +0200128
Bram Moolenaara45551a2020-06-09 15:57:37 +0200129// Request xterm compatibility check:
130static termrequest_T xcc_status = TERMREQUEST_INIT;
131
Bram Moolenaar9377df32017-10-15 13:22:01 +0200132# ifdef FEAT_TERMINAL
Bram Moolenaarafd78262019-05-10 23:10:31 +0200133// Request foreground color report:
134static termrequest_T rfg_status = TERMREQUEST_INIT;
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +0200135static int fg_r = 0;
136static int fg_g = 0;
137static int fg_b = 0;
138static int bg_r = 255;
139static int bg_g = 255;
140static int bg_b = 255;
Bram Moolenaar9377df32017-10-15 13:22:01 +0200141# endif
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +0200142
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100143// Request background color report:
Bram Moolenaarafd78262019-05-10 23:10:31 +0200144static termrequest_T rbg_status = TERMREQUEST_INIT;
Bram Moolenaar3eee06e2017-08-19 19:40:50 +0200145
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100146// Request cursor blinking mode report:
Bram Moolenaarafd78262019-05-10 23:10:31 +0200147static termrequest_T rbm_status = TERMREQUEST_INIT;
Bram Moolenaar4db25542017-08-28 22:43:05 +0200148
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100149// Request cursor style report:
Bram Moolenaarafd78262019-05-10 23:10:31 +0200150static termrequest_T rcs_status = TERMREQUEST_INIT;
Bram Moolenaar89894aa2018-03-05 22:43:10 +0100151
Bram Moolenaar4b96df52020-01-26 22:00:26 +0100152// Request window's position report:
Bram Moolenaarafd78262019-05-10 23:10:31 +0200153static termrequest_T winpos_status = TERMREQUEST_INIT;
154
155static termrequest_T *all_termrequests[] = {
156 &crv_status,
157 &u7_status,
Bram Moolenaara45551a2020-06-09 15:57:37 +0200158 &xcc_status,
Bram Moolenaarafd78262019-05-10 23:10:31 +0200159# ifdef FEAT_TERMINAL
160 &rfg_status,
161# endif
162 &rbg_status,
163 &rbm_status,
164 &rcs_status,
165 &winpos_status,
166 NULL
167};
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168# 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
179extern short ospeed;
180# else
181short ospeed;
182# endif
183# endif
184# ifndef HAVE_UP_BC_PC
185# ifdef UP_BC_PC_EXTERN
186extern char *UP, *BC, PC;
187# else
188char *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))
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100194static char_u *vim_tgetstr(char *s, char_u **pp);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100195#endif // HAVE_TGETENT
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100197static int detected_8bit = FALSE; // detected 8-bit terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198
Bram Moolenaar37b9b812017-08-19 23:23:43 +0200199#ifdef FEAT_TERMRESPONSE
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100200// When the cursor shape was detected these values are used:
201// 1: block, 2: underline, 3: vertical bar
Bram Moolenaar3eee06e2017-08-19 19:40:50 +0200202static int initial_cursor_shape = 0;
Bram Moolenaar4db25542017-08-28 22:43:05 +0200203
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100204// The blink flag from the style response may be inverted from the actual
205// blinking state, xterm XORs the flags.
Bram Moolenaar4db25542017-08-28 22:43:05 +0200206static int initial_cursor_shape_blink = FALSE;
207
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100208// The blink flag from the blinking-cursor mode response
Bram Moolenaar3eee06e2017-08-19 19:40:50 +0200209static int initial_cursor_blink = FALSE;
Bram Moolenaar37b9b812017-08-19 23:23:43 +0200210#endif
Bram Moolenaar3eee06e2017-08-19 19:40:50 +0200211
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000212static struct builtin_term builtin_termcaps[] =
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213{
214
215#if defined(FEAT_GUI)
216/*
217 * GUI pseudo term-cap.
218 */
219 {(int)KS_NAME, "gui"},
220 {(int)KS_CE, IF_EB("\033|$", ESC_STR "|$")},
221 {(int)KS_AL, IF_EB("\033|i", ESC_STR "|i")},
222# ifdef TERMINFO
223 {(int)KS_CAL, IF_EB("\033|%p1%dI", ESC_STR "|%p1%dI")},
224# else
225 {(int)KS_CAL, IF_EB("\033|%dI", ESC_STR "|%dI")},
226# endif
227 {(int)KS_DL, IF_EB("\033|d", ESC_STR "|d")},
228# ifdef TERMINFO
229 {(int)KS_CDL, IF_EB("\033|%p1%dD", ESC_STR "|%p1%dD")},
230 {(int)KS_CS, IF_EB("\033|%p1%d;%p2%dR", ESC_STR "|%p1%d;%p2%dR")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 {(int)KS_CSV, IF_EB("\033|%p1%d;%p2%dV", ESC_STR "|%p1%d;%p2%dV")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232# else
233 {(int)KS_CDL, IF_EB("\033|%dD", ESC_STR "|%dD")},
234 {(int)KS_CS, IF_EB("\033|%d;%dR", ESC_STR "|%d;%dR")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235 {(int)KS_CSV, IF_EB("\033|%d;%dV", ESC_STR "|%d;%dV")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236# endif
237 {(int)KS_CL, IF_EB("\033|C", ESC_STR "|C")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100238 // attributes switched on with 'h', off with * 'H'
239 {(int)KS_ME, IF_EB("\033|31H", ESC_STR "|31H")}, // HL_ALL
240 {(int)KS_MR, IF_EB("\033|1h", ESC_STR "|1h")}, // HL_INVERSE
241 {(int)KS_MD, IF_EB("\033|2h", ESC_STR "|2h")}, // HL_BOLD
242 {(int)KS_SE, IF_EB("\033|16H", ESC_STR "|16H")}, // HL_STANDOUT
243 {(int)KS_SO, IF_EB("\033|16h", ESC_STR "|16h")}, // HL_STANDOUT
244 {(int)KS_UE, IF_EB("\033|8H", ESC_STR "|8H")}, // HL_UNDERLINE
245 {(int)KS_US, IF_EB("\033|8h", ESC_STR "|8h")}, // HL_UNDERLINE
246 {(int)KS_UCE, IF_EB("\033|8C", ESC_STR "|8C")}, // HL_UNDERCURL
247 {(int)KS_UCS, IF_EB("\033|8c", ESC_STR "|8c")}, // HL_UNDERCURL
248 {(int)KS_STE, IF_EB("\033|4C", ESC_STR "|4C")}, // HL_STRIKETHROUGH
249 {(int)KS_STS, IF_EB("\033|4c", ESC_STR "|4c")}, // HL_STRIKETHROUGH
250 {(int)KS_CZR, IF_EB("\033|4H", ESC_STR "|4H")}, // HL_ITALIC
251 {(int)KS_CZH, IF_EB("\033|4h", ESC_STR "|4h")}, // HL_ITALIC
Bram Moolenaar071d4272004-06-13 20:20:40 +0000252 {(int)KS_VB, IF_EB("\033|f", ESC_STR "|f")},
253 {(int)KS_MS, "y"},
254 {(int)KS_UT, "y"},
Bram Moolenaar494838a2015-02-10 19:20:37 +0100255 {(int)KS_XN, "y"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100256 {(int)KS_LE, "\b"}, // cursor-left = BS
257 {(int)KS_ND, "\014"}, // cursor-right = CTRL-L
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258# ifdef TERMINFO
259 {(int)KS_CM, IF_EB("\033|%p1%d;%p2%dM", ESC_STR "|%p1%d;%p2%dM")},
260# else
261 {(int)KS_CM, IF_EB("\033|%d;%dM", ESC_STR "|%d;%dM")},
262# endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100263 // there are no key sequences here, the GUI sequences are recognized
264 // in check_termcode()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265#endif
266
267#ifndef NO_BUILTIN_TCAPS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269# if defined(AMIGA) || defined(ALL_BUILTIN_TCAPS)
270/*
271 * Amiga console window, default for Amiga
272 */
273 {(int)KS_NAME, "amiga"},
274 {(int)KS_CE, "\033[K"},
275 {(int)KS_CD, "\033[J"},
276 {(int)KS_AL, "\033[L"},
277# ifdef TERMINFO
278 {(int)KS_CAL, "\033[%p1%dL"},
279# else
280 {(int)KS_CAL, "\033[%dL"},
281# endif
282 {(int)KS_DL, "\033[M"},
283# ifdef TERMINFO
284 {(int)KS_CDL, "\033[%p1%dM"},
285# else
286 {(int)KS_CDL, "\033[%dM"},
287# endif
288 {(int)KS_CL, "\014"},
289 {(int)KS_VI, "\033[0 p"},
290 {(int)KS_VE, "\033[1 p"},
291 {(int)KS_ME, "\033[0m"},
292 {(int)KS_MR, "\033[7m"},
293 {(int)KS_MD, "\033[1m"},
294 {(int)KS_SE, "\033[0m"},
295 {(int)KS_SO, "\033[33m"},
296 {(int)KS_US, "\033[4m"},
297 {(int)KS_UE, "\033[0m"},
298 {(int)KS_CZH, "\033[3m"},
299 {(int)KS_CZR, "\033[0m"},
300#if defined(__MORPHOS__) || defined(__AROS__)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100301 {(int)KS_CCO, "8"}, // allow 8 colors
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302# ifdef TERMINFO
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100303 {(int)KS_CAB, "\033[4%p1%dm"},// set background color
304 {(int)KS_CAF, "\033[3%p1%dm"},// set foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305# else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100306 {(int)KS_CAB, "\033[4%dm"}, // set background color
307 {(int)KS_CAF, "\033[3%dm"}, // set foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308# endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100309 {(int)KS_OP, "\033[m"}, // reset colors
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310#endif
311 {(int)KS_MS, "y"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100312 {(int)KS_UT, "y"}, // guessed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 {(int)KS_LE, "\b"},
314# ifdef TERMINFO
315 {(int)KS_CM, "\033[%i%p1%d;%p2%dH"},
316# else
317 {(int)KS_CM, "\033[%i%d;%dH"},
318# endif
319#if defined(__MORPHOS__)
320 {(int)KS_SR, "\033M"},
321#endif
322# ifdef TERMINFO
323 {(int)KS_CRI, "\033[%p1%dC"},
324# else
325 {(int)KS_CRI, "\033[%dC"},
326# endif
327 {K_UP, "\233A"},
328 {K_DOWN, "\233B"},
329 {K_LEFT, "\233D"},
330 {K_RIGHT, "\233C"},
331 {K_S_UP, "\233T"},
332 {K_S_DOWN, "\233S"},
333 {K_S_LEFT, "\233 A"},
334 {K_S_RIGHT, "\233 @"},
335 {K_S_TAB, "\233Z"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100336 {K_F1, "\233\060~"},// some compilers don't dig "\2330"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337 {K_F2, "\233\061~"},
338 {K_F3, "\233\062~"},
339 {K_F4, "\233\063~"},
340 {K_F5, "\233\064~"},
341 {K_F6, "\233\065~"},
342 {K_F7, "\233\066~"},
343 {K_F8, "\233\067~"},
344 {K_F9, "\233\070~"},
345 {K_F10, "\233\071~"},
346 {K_S_F1, "\233\061\060~"},
347 {K_S_F2, "\233\061\061~"},
348 {K_S_F3, "\233\061\062~"},
349 {K_S_F4, "\233\061\063~"},
350 {K_S_F5, "\233\061\064~"},
351 {K_S_F6, "\233\061\065~"},
352 {K_S_F7, "\233\061\066~"},
353 {K_S_F8, "\233\061\067~"},
354 {K_S_F9, "\233\061\070~"},
355 {K_S_F10, "\233\061\071~"},
356 {K_HELP, "\233?~"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100357 {K_INS, "\233\064\060~"}, // 101 key keyboard
358 {K_PAGEUP, "\233\064\061~"}, // 101 key keyboard
359 {K_PAGEDOWN, "\233\064\062~"}, // 101 key keyboard
360 {K_HOME, "\233\064\064~"}, // 101 key keyboard
361 {K_END, "\233\064\065~"}, // 101 key keyboard
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362
363 {BT_EXTRA_KEYS, ""},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100364 {TERMCAP2KEY('#', '2'), "\233\065\064~"}, // shifted home key
365 {TERMCAP2KEY('#', '3'), "\233\065\060~"}, // shifted insert key
366 {TERMCAP2KEY('*', '7'), "\233\065\065~"}, // shifted end key
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367# endif
368
Bram Moolenaar041c7102020-05-30 18:14:57 +0200369# ifdef ALL_BUILTIN_TCAPS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370/*
Bram Moolenaar041c7102020-05-30 18:14:57 +0200371 * almost standard ANSI terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373 {(int)KS_CE, "\033[K"},
374 {(int)KS_CD, "\033[J"},
375 {(int)KS_AL, "\033[L"},
376# ifdef TERMINFO
377 {(int)KS_CAL, "\033[%p1%dL"},
378# else
379 {(int)KS_CAL, "\033[%dL"},
380# endif
381 {(int)KS_DL, "\033[M"},
382# ifdef TERMINFO
383 {(int)KS_CDL, "\033[%p1%dM"},
384# else
385 {(int)KS_CDL, "\033[%dM"},
386# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387 {(int)KS_CL, "\033[H\033[2J"},
388#ifdef notyet
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100389 {(int)KS_VI, "[VI]"}, // cursor invisible, VT320: CSI ? 25 l
390 {(int)KS_VE, "[VE]"}, // cursor visible, VT320: CSI ? 25 h
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391#endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100392 {(int)KS_ME, "\033[m"}, // normal mode
393 {(int)KS_MR, "\033[7m"}, // reverse
394 {(int)KS_MD, "\033[1m"}, // bold
395 {(int)KS_SO, "\033[31m"}, // standout mode: red
396 {(int)KS_SE, "\033[m"}, // standout end
397 {(int)KS_CZH, "\033[35m"}, // italic: purple
398 {(int)KS_CZR, "\033[m"}, // italic end
399 {(int)KS_US, "\033[4m"}, // underscore mode
400 {(int)KS_UE, "\033[m"}, // underscore end
401 {(int)KS_CCO, "8"}, // allow 8 colors
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402# ifdef TERMINFO
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100403 {(int)KS_CAB, "\033[4%p1%dm"},// set background color
404 {(int)KS_CAF, "\033[3%p1%dm"},// set foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405# else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100406 {(int)KS_CAB, "\033[4%dm"}, // set background color
407 {(int)KS_CAF, "\033[3%dm"}, // set foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408# endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100409 {(int)KS_OP, "\033[m"}, // reset colors
410 {(int)KS_MS, "y"}, // safe to move cur in reverse mode
411 {(int)KS_UT, "y"}, // guessed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412 {(int)KS_LE, "\b"},
413# ifdef TERMINFO
414 {(int)KS_CM, "\033[%i%p1%d;%p2%dH"},
415# else
416 {(int)KS_CM, "\033[%i%d;%dH"},
417# endif
418 {(int)KS_SR, "\033M"},
419# ifdef TERMINFO
420 {(int)KS_CRI, "\033[%p1%dC"},
421# else
422 {(int)KS_CRI, "\033[%dC"},
423# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000424
425 {K_UP, "\033[A"},
426 {K_DOWN, "\033[B"},
427 {K_LEFT, "\033[D"},
428 {K_RIGHT, "\033[C"},
429# endif
430
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200431# if defined(UNIX) || defined(ALL_BUILTIN_TCAPS) || defined(SOME_BUILTIN_TCAPS)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432/*
433 * standard ANSI terminal, default for unix
434 */
435 {(int)KS_NAME, "ansi"},
436 {(int)KS_CE, IF_EB("\033[K", ESC_STR "[K")},
437 {(int)KS_AL, IF_EB("\033[L", ESC_STR "[L")},
438# ifdef TERMINFO
439 {(int)KS_CAL, IF_EB("\033[%p1%dL", ESC_STR "[%p1%dL")},
440# else
441 {(int)KS_CAL, IF_EB("\033[%dL", ESC_STR "[%dL")},
442# endif
443 {(int)KS_DL, IF_EB("\033[M", ESC_STR "[M")},
444# ifdef TERMINFO
445 {(int)KS_CDL, IF_EB("\033[%p1%dM", ESC_STR "[%p1%dM")},
446# else
447 {(int)KS_CDL, IF_EB("\033[%dM", ESC_STR "[%dM")},
448# endif
449 {(int)KS_CL, IF_EB("\033[H\033[2J", ESC_STR "[H" ESC_STR_nc "[2J")},
450 {(int)KS_ME, IF_EB("\033[0m", ESC_STR "[0m")},
451 {(int)KS_MR, IF_EB("\033[7m", ESC_STR "[7m")},
452 {(int)KS_MS, "y"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100453 {(int)KS_UT, "y"}, // guessed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 {(int)KS_LE, "\b"},
455# ifdef TERMINFO
456 {(int)KS_CM, IF_EB("\033[%i%p1%d;%p2%dH", ESC_STR "[%i%p1%d;%p2%dH")},
457# else
458 {(int)KS_CM, IF_EB("\033[%i%d;%dH", ESC_STR "[%i%d;%dH")},
459# endif
460# ifdef TERMINFO
461 {(int)KS_CRI, IF_EB("\033[%p1%dC", ESC_STR "[%p1%dC")},
462# else
463 {(int)KS_CRI, IF_EB("\033[%dC", ESC_STR "[%dC")},
464# endif
465# endif
466
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200467# if defined(ALL_BUILTIN_TCAPS)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000468/*
469 * These codes are valid when nansi.sys or equivalent has been installed.
470 * Function keys on a PC are preceded with a NUL. These are converted into
471 * K_NUL '\316' in mch_inchar(), because we cannot handle NULs in key codes.
472 * CTRL-arrow is used instead of SHIFT-arrow.
473 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474 {(int)KS_NAME, "pcansi"},
475 {(int)KS_DL, "\033[M"},
476 {(int)KS_AL, "\033[L"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477 {(int)KS_CE, "\033[K"},
478 {(int)KS_CL, "\033[2J"},
479 {(int)KS_ME, "\033[0m"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100480 {(int)KS_MR, "\033[5m"}, // reverse: black on lightgrey
481 {(int)KS_MD, "\033[1m"}, // bold: white text
482 {(int)KS_SE, "\033[0m"}, // standout end
483 {(int)KS_SO, "\033[31m"}, // standout: white on blue
484 {(int)KS_CZH, "\033[34;43m"}, // italic mode: blue text on yellow
485 {(int)KS_CZR, "\033[0m"}, // italic mode end
486 {(int)KS_US, "\033[36;41m"}, // underscore mode: cyan text on red
487 {(int)KS_UE, "\033[0m"}, // underscore mode end
488 {(int)KS_CCO, "8"}, // allow 8 colors
Bram Moolenaar071d4272004-06-13 20:20:40 +0000489# ifdef TERMINFO
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100490 {(int)KS_CAB, "\033[4%p1%dm"},// set background color
491 {(int)KS_CAF, "\033[3%p1%dm"},// set foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492# else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100493 {(int)KS_CAB, "\033[4%dm"}, // set background color
494 {(int)KS_CAF, "\033[3%dm"}, // set foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495# endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100496 {(int)KS_OP, "\033[0m"}, // reset colors
Bram Moolenaar071d4272004-06-13 20:20:40 +0000497 {(int)KS_MS, "y"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100498 {(int)KS_UT, "y"}, // guessed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000499 {(int)KS_LE, "\b"},
500# ifdef TERMINFO
501 {(int)KS_CM, "\033[%i%p1%d;%p2%dH"},
502# else
503 {(int)KS_CM, "\033[%i%d;%dH"},
504# endif
505# ifdef TERMINFO
506 {(int)KS_CRI, "\033[%p1%dC"},
507# else
508 {(int)KS_CRI, "\033[%dC"},
509# endif
510 {K_UP, "\316H"},
511 {K_DOWN, "\316P"},
512 {K_LEFT, "\316K"},
513 {K_RIGHT, "\316M"},
514 {K_S_LEFT, "\316s"},
515 {K_S_RIGHT, "\316t"},
516 {K_F1, "\316;"},
517 {K_F2, "\316<"},
518 {K_F3, "\316="},
519 {K_F4, "\316>"},
520 {K_F5, "\316?"},
521 {K_F6, "\316@"},
522 {K_F7, "\316A"},
523 {K_F8, "\316B"},
524 {K_F9, "\316C"},
525 {K_F10, "\316D"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100526 {K_F11, "\316\205"}, // guessed
527 {K_F12, "\316\206"}, // guessed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528 {K_S_F1, "\316T"},
529 {K_S_F2, "\316U"},
530 {K_S_F3, "\316V"},
531 {K_S_F4, "\316W"},
532 {K_S_F5, "\316X"},
533 {K_S_F6, "\316Y"},
534 {K_S_F7, "\316Z"},
535 {K_S_F8, "\316["},
536 {K_S_F9, "\316\\"},
537 {K_S_F10, "\316]"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100538 {K_S_F11, "\316\207"}, // guessed
539 {K_S_F12, "\316\210"}, // guessed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540 {K_INS, "\316R"},
541 {K_DEL, "\316S"},
542 {K_HOME, "\316G"},
543 {K_END, "\316O"},
544 {K_PAGEDOWN, "\316Q"},
545 {K_PAGEUP, "\316I"},
546# endif
547
Bram Moolenaar4f974752019-02-17 17:44:42 +0100548# if defined(MSWIN) || defined(ALL_BUILTIN_TCAPS)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549/*
550 * These codes are valid for the Win32 Console . The entries that start with
551 * ESC | are translated into console calls in os_win32.c. The function keys
552 * are also translated in os_win32.c.
553 */
554 {(int)KS_NAME, "win32"},
Bram Moolenaar6982f422019-02-16 16:48:01 +0100555 {(int)KS_CE, "\033|K"}, // clear to end of line
556 {(int)KS_AL, "\033|L"}, // add new blank line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557# ifdef TERMINFO
Bram Moolenaar6982f422019-02-16 16:48:01 +0100558 {(int)KS_CAL, "\033|%p1%dL"}, // add number of new blank lines
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559# else
Bram Moolenaar6982f422019-02-16 16:48:01 +0100560 {(int)KS_CAL, "\033|%dL"}, // add number of new blank lines
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561# endif
Bram Moolenaar6982f422019-02-16 16:48:01 +0100562 {(int)KS_DL, "\033|M"}, // delete line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563# ifdef TERMINFO
Bram Moolenaar6982f422019-02-16 16:48:01 +0100564 {(int)KS_CDL, "\033|%p1%dM"}, // delete number of lines
565 {(int)KS_CSV, "\033|%p1%d;%p2%dV"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566# else
Bram Moolenaar6982f422019-02-16 16:48:01 +0100567 {(int)KS_CDL, "\033|%dM"}, // delete number of lines
568 {(int)KS_CSV, "\033|%d;%dV"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000569# endif
Bram Moolenaar6982f422019-02-16 16:48:01 +0100570 {(int)KS_CL, "\033|J"}, // clear screen
571 {(int)KS_CD, "\033|j"}, // clear to end of display
572 {(int)KS_VI, "\033|v"}, // cursor invisible
573 {(int)KS_VE, "\033|V"}, // cursor visible
Bram Moolenaar071d4272004-06-13 20:20:40 +0000574
Bram Moolenaar6982f422019-02-16 16:48:01 +0100575 {(int)KS_ME, "\033|0m"}, // normal
576 {(int)KS_MR, "\033|112m"}, // reverse: black on lightgray
577 {(int)KS_MD, "\033|15m"}, // bold: white on black
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578#if 1
Bram Moolenaar6982f422019-02-16 16:48:01 +0100579 {(int)KS_SO, "\033|31m"}, // standout: white on blue
580 {(int)KS_SE, "\033|0m"}, // standout end
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581#else
Bram Moolenaar6982f422019-02-16 16:48:01 +0100582 {(int)KS_SO, "\033|F"}, // standout: high intensity
583 {(int)KS_SE, "\033|f"}, // standout end
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584#endif
Bram Moolenaar6982f422019-02-16 16:48:01 +0100585 {(int)KS_CZH, "\033|225m"}, // italic: blue text on yellow
586 {(int)KS_CZR, "\033|0m"}, // italic end
587 {(int)KS_US, "\033|67m"}, // underscore: cyan text on red
588 {(int)KS_UE, "\033|0m"}, // underscore end
589 {(int)KS_CCO, "16"}, // allow 16 colors
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590# ifdef TERMINFO
Bram Moolenaar6982f422019-02-16 16:48:01 +0100591 {(int)KS_CAB, "\033|%p1%db"}, // set background color
592 {(int)KS_CAF, "\033|%p1%df"}, // set foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593# else
Bram Moolenaar6982f422019-02-16 16:48:01 +0100594 {(int)KS_CAB, "\033|%db"}, // set background color
595 {(int)KS_CAF, "\033|%df"}, // set foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596# endif
597
Bram Moolenaar6982f422019-02-16 16:48:01 +0100598 {(int)KS_MS, "y"}, // save to move cur in reverse mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599 {(int)KS_UT, "y"},
Bram Moolenaar494838a2015-02-10 19:20:37 +0100600 {(int)KS_XN, "y"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601 {(int)KS_LE, "\b"},
602# ifdef TERMINFO
Bram Moolenaar6982f422019-02-16 16:48:01 +0100603 {(int)KS_CM, "\033|%i%p1%d;%p2%dH"}, // cursor motion
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604# else
Bram Moolenaar6982f422019-02-16 16:48:01 +0100605 {(int)KS_CM, "\033|%i%d;%dH"}, // cursor motion
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606# endif
Bram Moolenaar6982f422019-02-16 16:48:01 +0100607 {(int)KS_VB, "\033|B"}, // visual bell
608 {(int)KS_TI, "\033|S"}, // put terminal in termcap mode
609 {(int)KS_TE, "\033|E"}, // out of termcap mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610# ifdef TERMINFO
Bram Moolenaar6982f422019-02-16 16:48:01 +0100611 {(int)KS_CS, "\033|%i%p1%d;%p2%dr"}, // scroll region
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612# else
Bram Moolenaar6982f422019-02-16 16:48:01 +0100613 {(int)KS_CS, "\033|%i%d;%dr"}, // scroll region
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614# endif
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100615# ifdef FEAT_TERMGUICOLORS
616 {(int)KS_8F, "\033|38;2;%lu;%lu;%lum"},
617 {(int)KS_8B, "\033|48;2;%lu;%lu;%lum"},
618# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619
620 {K_UP, "\316H"},
621 {K_DOWN, "\316P"},
622 {K_LEFT, "\316K"},
623 {K_RIGHT, "\316M"},
624 {K_S_UP, "\316\304"},
625 {K_S_DOWN, "\316\317"},
626 {K_S_LEFT, "\316\311"},
627 {K_C_LEFT, "\316s"},
628 {K_S_RIGHT, "\316\313"},
629 {K_C_RIGHT, "\316t"},
630 {K_S_TAB, "\316\017"},
631 {K_F1, "\316;"},
632 {K_F2, "\316<"},
633 {K_F3, "\316="},
634 {K_F4, "\316>"},
635 {K_F5, "\316?"},
636 {K_F6, "\316@"},
637 {K_F7, "\316A"},
638 {K_F8, "\316B"},
639 {K_F9, "\316C"},
640 {K_F10, "\316D"},
641 {K_F11, "\316\205"},
642 {K_F12, "\316\206"},
643 {K_S_F1, "\316T"},
644 {K_S_F2, "\316U"},
645 {K_S_F3, "\316V"},
646 {K_S_F4, "\316W"},
647 {K_S_F5, "\316X"},
648 {K_S_F6, "\316Y"},
649 {K_S_F7, "\316Z"},
650 {K_S_F8, "\316["},
651 {K_S_F9, "\316\\"},
652 {K_S_F10, "\316]"},
653 {K_S_F11, "\316\207"},
654 {K_S_F12, "\316\210"},
655 {K_INS, "\316R"},
656 {K_DEL, "\316S"},
657 {K_HOME, "\316G"},
658 {K_S_HOME, "\316\302"},
659 {K_C_HOME, "\316w"},
660 {K_END, "\316O"},
661 {K_S_END, "\316\315"},
662 {K_C_END, "\316u"},
663 {K_PAGEDOWN, "\316Q"},
664 {K_PAGEUP, "\316I"},
665 {K_KPLUS, "\316N"},
666 {K_KMINUS, "\316J"},
667 {K_KMULTIPLY, "\316\067"},
668 {K_K0, "\316\332"},
669 {K_K1, "\316\336"},
670 {K_K2, "\316\342"},
671 {K_K3, "\316\346"},
672 {K_K4, "\316\352"},
673 {K_K5, "\316\356"},
674 {K_K6, "\316\362"},
675 {K_K7, "\316\366"},
676 {K_K8, "\316\372"},
677 {K_K9, "\316\376"},
Bram Moolenaarb70a47b2019-03-30 22:11:21 +0100678 {K_BS, "\316x"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679# endif
680
681# if defined(VMS) || defined(ALL_BUILTIN_TCAPS)
682/*
683 * VT320 is working as an ANSI terminal compatible DEC terminal.
684 * (it covers VT1x0, VT2x0 and VT3x0 up to VT320 on VMS as well)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 * TODO:- rewrite ESC[ codes to CSI
686 * - keyboard languages (CSI ? 26 n)
687 */
688 {(int)KS_NAME, "vt320"},
689 {(int)KS_CE, IF_EB("\033[K", ESC_STR "[K")},
690 {(int)KS_AL, IF_EB("\033[L", ESC_STR "[L")},
691# ifdef TERMINFO
692 {(int)KS_CAL, IF_EB("\033[%p1%dL", ESC_STR "[%p1%dL")},
693# else
694 {(int)KS_CAL, IF_EB("\033[%dL", ESC_STR "[%dL")},
695# endif
696 {(int)KS_DL, IF_EB("\033[M", ESC_STR "[M")},
697# ifdef TERMINFO
698 {(int)KS_CDL, IF_EB("\033[%p1%dM", ESC_STR "[%p1%dM")},
699# else
700 {(int)KS_CDL, IF_EB("\033[%dM", ESC_STR "[%dM")},
701# endif
702 {(int)KS_CL, IF_EB("\033[H\033[2J", ESC_STR "[H" ESC_STR_nc "[2J")},
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000703 {(int)KS_CD, IF_EB("\033[J", ESC_STR "[J")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100704 {(int)KS_CCO, "8"}, // allow 8 colors
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 {(int)KS_ME, IF_EB("\033[0m", ESC_STR "[0m")},
706 {(int)KS_MR, IF_EB("\033[7m", ESC_STR "[7m")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100707 {(int)KS_MD, IF_EB("\033[1m", ESC_STR "[1m")}, // bold mode
708 {(int)KS_SE, IF_EB("\033[22m", ESC_STR "[22m")},// normal mode
709 {(int)KS_UE, IF_EB("\033[24m", ESC_STR "[24m")},// exit underscore mode
710 {(int)KS_US, IF_EB("\033[4m", ESC_STR "[4m")}, // underscore mode
711 {(int)KS_CZH, IF_EB("\033[34;43m", ESC_STR "[34;43m")}, // italic mode: blue text on yellow
712 {(int)KS_CZR, IF_EB("\033[0m", ESC_STR "[0m")}, // italic mode end
713 {(int)KS_CAB, IF_EB("\033[4%dm", ESC_STR "[4%dm")}, // set background color (ANSI)
714 {(int)KS_CAF, IF_EB("\033[3%dm", ESC_STR "[3%dm")}, // set foreground color (ANSI)
715 {(int)KS_CSB, IF_EB("\033[102;%dm", ESC_STR "[102;%dm")}, // set screen background color
716 {(int)KS_CSF, IF_EB("\033[101;%dm", ESC_STR "[101;%dm")}, // set screen foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717 {(int)KS_MS, "y"},
718 {(int)KS_UT, "y"},
Bram Moolenaar494838a2015-02-10 19:20:37 +0100719 {(int)KS_XN, "y"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 {(int)KS_LE, "\b"},
721# ifdef TERMINFO
722 {(int)KS_CM, IF_EB("\033[%i%p1%d;%p2%dH",
723 ESC_STR "[%i%p1%d;%p2%dH")},
724# else
725 {(int)KS_CM, IF_EB("\033[%i%d;%dH", ESC_STR "[%i%d;%dH")},
726# endif
727# ifdef TERMINFO
728 {(int)KS_CRI, IF_EB("\033[%p1%dC", ESC_STR "[%p1%dC")},
729# else
730 {(int)KS_CRI, IF_EB("\033[%dC", ESC_STR "[%dC")},
731# endif
732 {K_UP, IF_EB("\033[A", ESC_STR "[A")},
733 {K_DOWN, IF_EB("\033[B", ESC_STR "[B")},
734 {K_RIGHT, IF_EB("\033[C", ESC_STR "[C")},
735 {K_LEFT, IF_EB("\033[D", ESC_STR "[D")},
Bram Moolenaare6882bd2018-07-03 17:16:59 +0200736 // Note: cursor key sequences for application cursor mode are omitted,
737 // because they interfere with typed commands: <Esc>OA.
Bram Moolenaard857f0e2005-06-21 22:37:39 +0000738 {K_F1, IF_EB("\033[11~", ESC_STR "[11~")},
739 {K_F2, IF_EB("\033[12~", ESC_STR "[12~")},
740 {K_F3, IF_EB("\033[13~", ESC_STR "[13~")},
741 {K_F4, IF_EB("\033[14~", ESC_STR "[14~")},
742 {K_F5, IF_EB("\033[15~", ESC_STR "[15~")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 {K_F6, IF_EB("\033[17~", ESC_STR "[17~")},
744 {K_F7, IF_EB("\033[18~", ESC_STR "[18~")},
745 {K_F8, IF_EB("\033[19~", ESC_STR "[19~")},
746 {K_F9, IF_EB("\033[20~", ESC_STR "[20~")},
747 {K_F10, IF_EB("\033[21~", ESC_STR "[21~")},
Bram Moolenaard857f0e2005-06-21 22:37:39 +0000748 {K_F11, IF_EB("\033[23~", ESC_STR "[23~")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 {K_F12, IF_EB("\033[24~", ESC_STR "[24~")},
750 {K_F13, IF_EB("\033[25~", ESC_STR "[25~")},
751 {K_F14, IF_EB("\033[26~", ESC_STR "[26~")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100752 {K_F15, IF_EB("\033[28~", ESC_STR "[28~")}, // Help
753 {K_F16, IF_EB("\033[29~", ESC_STR "[29~")}, // Select
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 {K_F17, IF_EB("\033[31~", ESC_STR "[31~")},
755 {K_F18, IF_EB("\033[32~", ESC_STR "[32~")},
756 {K_F19, IF_EB("\033[33~", ESC_STR "[33~")},
757 {K_F20, IF_EB("\033[34~", ESC_STR "[34~")},
758 {K_INS, IF_EB("\033[2~", ESC_STR "[2~")},
759 {K_DEL, IF_EB("\033[3~", ESC_STR "[3~")},
760 {K_HOME, IF_EB("\033[1~", ESC_STR "[1~")},
761 {K_END, IF_EB("\033[4~", ESC_STR "[4~")},
762 {K_PAGEUP, IF_EB("\033[5~", ESC_STR "[5~")},
763 {K_PAGEDOWN, IF_EB("\033[6~", ESC_STR "[6~")},
Bram Moolenaare6882bd2018-07-03 17:16:59 +0200764 // These sequences starting with <Esc> O may interfere with what the user
765 // is typing. Remove these if that bothers you.
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100766 {K_KPLUS, IF_EB("\033Ok", ESC_STR "Ok")}, // keypad plus
767 {K_KMINUS, IF_EB("\033Om", ESC_STR "Om")}, // keypad minus
768 {K_KDIVIDE, IF_EB("\033Oo", ESC_STR "Oo")}, // keypad /
769 {K_KMULTIPLY, IF_EB("\033Oj", ESC_STR "Oj")}, // keypad *
770 {K_KENTER, IF_EB("\033OM", ESC_STR "OM")}, // keypad Enter
771 {K_K0, IF_EB("\033Op", ESC_STR "Op")}, // keypad 0
772 {K_K1, IF_EB("\033Oq", ESC_STR "Oq")}, // keypad 1
773 {K_K2, IF_EB("\033Or", ESC_STR "Or")}, // keypad 2
774 {K_K3, IF_EB("\033Os", ESC_STR "Os")}, // keypad 3
775 {K_K4, IF_EB("\033Ot", ESC_STR "Ot")}, // keypad 4
776 {K_K5, IF_EB("\033Ou", ESC_STR "Ou")}, // keypad 5
777 {K_K6, IF_EB("\033Ov", ESC_STR "Ov")}, // keypad 6
778 {K_K7, IF_EB("\033Ow", ESC_STR "Ow")}, // keypad 7
779 {K_K8, IF_EB("\033Ox", ESC_STR "Ox")}, // keypad 8
780 {K_K9, IF_EB("\033Oy", ESC_STR "Oy")}, // keypad 9
781 {K_BS, "\x7f"}, // for some reason 0177 doesn't work
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782# endif
783
784# if defined(ALL_BUILTIN_TCAPS) || defined(__MINT__)
785/*
786 * Ordinary vt52
787 */
788 {(int)KS_NAME, "vt52"},
789 {(int)KS_CE, IF_EB("\033K", ESC_STR "K")},
790 {(int)KS_CD, IF_EB("\033J", ESC_STR "J")},
Bram Moolenaar2a1b4742015-11-24 18:15:51 +0100791# ifdef TERMINFO
792 {(int)KS_CM, IF_EB("\033Y%p1%' '%+%c%p2%' '%+%c",
793 ESC_STR "Y%p1%' '%+%c%p2%' '%+%c")},
794# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795 {(int)KS_CM, IF_EB("\033Y%+ %+ ", ESC_STR "Y%+ %+ ")},
Bram Moolenaar2a1b4742015-11-24 18:15:51 +0100796# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 {(int)KS_LE, "\b"},
Bram Moolenaar2a1b4742015-11-24 18:15:51 +0100798 {(int)KS_SR, IF_EB("\033I", ESC_STR "I")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799 {(int)KS_AL, IF_EB("\033L", ESC_STR "L")},
800 {(int)KS_DL, IF_EB("\033M", ESC_STR "M")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 {K_UP, IF_EB("\033A", ESC_STR "A")},
802 {K_DOWN, IF_EB("\033B", ESC_STR "B")},
803 {K_LEFT, IF_EB("\033D", ESC_STR "D")},
804 {K_RIGHT, IF_EB("\033C", ESC_STR "C")},
Bram Moolenaar2a1b4742015-11-24 18:15:51 +0100805 {K_F1, IF_EB("\033P", ESC_STR "P")},
806 {K_F2, IF_EB("\033Q", ESC_STR "Q")},
807 {K_F3, IF_EB("\033R", ESC_STR "R")},
808# ifdef __MINT__
809 {(int)KS_CL, IF_EB("\033E", ESC_STR "E")},
810 {(int)KS_VE, IF_EB("\033e", ESC_STR "e")},
811 {(int)KS_VI, IF_EB("\033f", ESC_STR "f")},
812 {(int)KS_SO, IF_EB("\033p", ESC_STR "p")},
813 {(int)KS_SE, IF_EB("\033q", ESC_STR "q")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 {K_S_UP, IF_EB("\033a", ESC_STR "a")},
815 {K_S_DOWN, IF_EB("\033b", ESC_STR "b")},
816 {K_S_LEFT, IF_EB("\033d", ESC_STR "d")},
817 {K_S_RIGHT, IF_EB("\033c", ESC_STR "c")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 {K_F4, IF_EB("\033S", ESC_STR "S")},
819 {K_F5, IF_EB("\033T", ESC_STR "T")},
820 {K_F6, IF_EB("\033U", ESC_STR "U")},
821 {K_F7, IF_EB("\033V", ESC_STR "V")},
822 {K_F8, IF_EB("\033W", ESC_STR "W")},
823 {K_F9, IF_EB("\033X", ESC_STR "X")},
824 {K_F10, IF_EB("\033Y", ESC_STR "Y")},
825 {K_S_F1, IF_EB("\033p", ESC_STR "p")},
826 {K_S_F2, IF_EB("\033q", ESC_STR "q")},
827 {K_S_F3, IF_EB("\033r", ESC_STR "r")},
828 {K_S_F4, IF_EB("\033s", ESC_STR "s")},
829 {K_S_F5, IF_EB("\033t", ESC_STR "t")},
830 {K_S_F6, IF_EB("\033u", ESC_STR "u")},
831 {K_S_F7, IF_EB("\033v", ESC_STR "v")},
832 {K_S_F8, IF_EB("\033w", ESC_STR "w")},
833 {K_S_F9, IF_EB("\033x", ESC_STR "x")},
834 {K_S_F10, IF_EB("\033y", ESC_STR "y")},
835 {K_INS, IF_EB("\033I", ESC_STR "I")},
836 {K_HOME, IF_EB("\033E", ESC_STR "E")},
837 {K_PAGEDOWN, IF_EB("\033b", ESC_STR "b")},
838 {K_PAGEUP, IF_EB("\033a", ESC_STR "a")},
839# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 {(int)KS_CL, IF_EB("\033H\033J", ESC_STR "H" ESC_STR_nc "J")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 {(int)KS_MS, "y"},
842# endif
843# endif
844
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200845# if defined(UNIX) || defined(ALL_BUILTIN_TCAPS) || defined(SOME_BUILTIN_TCAPS)
Bram Moolenaarb2fa54a2016-04-22 21:11:09 +0200846 {(int)KS_NAME, "xterm"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 {(int)KS_CE, IF_EB("\033[K", ESC_STR "[K")},
848 {(int)KS_AL, IF_EB("\033[L", ESC_STR "[L")},
849# ifdef TERMINFO
850 {(int)KS_CAL, IF_EB("\033[%p1%dL", ESC_STR "[%p1%dL")},
851# else
852 {(int)KS_CAL, IF_EB("\033[%dL", ESC_STR "[%dL")},
853# endif
854 {(int)KS_DL, IF_EB("\033[M", ESC_STR "[M")},
855# ifdef TERMINFO
856 {(int)KS_CDL, IF_EB("\033[%p1%dM", ESC_STR "[%p1%dM")},
857# else
858 {(int)KS_CDL, IF_EB("\033[%dM", ESC_STR "[%dM")},
859# endif
860# ifdef TERMINFO
861 {(int)KS_CS, IF_EB("\033[%i%p1%d;%p2%dr",
862 ESC_STR "[%i%p1%d;%p2%dr")},
863# else
864 {(int)KS_CS, IF_EB("\033[%i%d;%dr", ESC_STR "[%i%d;%dr")},
865# endif
866 {(int)KS_CL, IF_EB("\033[H\033[2J", ESC_STR "[H" ESC_STR_nc "[2J")},
867 {(int)KS_CD, IF_EB("\033[J", ESC_STR "[J")},
868 {(int)KS_ME, IF_EB("\033[m", ESC_STR "[m")},
869 {(int)KS_MR, IF_EB("\033[7m", ESC_STR "[7m")},
870 {(int)KS_MD, IF_EB("\033[1m", ESC_STR "[1m")},
871 {(int)KS_UE, IF_EB("\033[m", ESC_STR "[m")},
872 {(int)KS_US, IF_EB("\033[4m", ESC_STR "[4m")},
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +0200873 {(int)KS_STE, IF_EB("\033[29m", ESC_STR "[29m")},
874 {(int)KS_STS, IF_EB("\033[9m", ESC_STR "[9m")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 {(int)KS_MS, "y"},
876 {(int)KS_UT, "y"},
877 {(int)KS_LE, "\b"},
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +0200878 {(int)KS_VI, IF_EB("\033[?25l", ESC_STR "[?25l")},
879 {(int)KS_VE, IF_EB("\033[?25h", ESC_STR "[?25h")},
Bram Moolenaar93c92ef2017-08-19 21:11:57 +0200880 {(int)KS_VS, IF_EB("\033[?12h", ESC_STR "[?12h")},
Bram Moolenaarce1c3272017-08-20 15:05:15 +0200881 {(int)KS_CVS, IF_EB("\033[?12l", ESC_STR "[?12l")},
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +0200882# ifdef TERMINFO
883 {(int)KS_CSH, IF_EB("\033[%p1%d q", ESC_STR "[%p1%d q")},
884# else
885 {(int)KS_CSH, IF_EB("\033[%d q", ESC_STR "[%d q")},
886# endif
Bram Moolenaar4db25542017-08-28 22:43:05 +0200887 {(int)KS_CRC, IF_EB("\033[?12$p", ESC_STR "[?12$p")},
Bram Moolenaar3eee06e2017-08-19 19:40:50 +0200888 {(int)KS_CRS, IF_EB("\033P$q q\033\\", ESC_STR "P$q q" ESC_STR "\\")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889# ifdef TERMINFO
890 {(int)KS_CM, IF_EB("\033[%i%p1%d;%p2%dH",
891 ESC_STR "[%i%p1%d;%p2%dH")},
892# else
893 {(int)KS_CM, IF_EB("\033[%i%d;%dH", ESC_STR "[%i%d;%dH")},
894# endif
895 {(int)KS_SR, IF_EB("\033M", ESC_STR "M")},
896# ifdef TERMINFO
897 {(int)KS_CRI, IF_EB("\033[%p1%dC", ESC_STR "[%p1%dC")},
898# else
899 {(int)KS_CRI, IF_EB("\033[%dC", ESC_STR "[%dC")},
900# endif
901 {(int)KS_KS, IF_EB("\033[?1h\033=", ESC_STR "[?1h" ESC_STR_nc "=")},
902 {(int)KS_KE, IF_EB("\033[?1l\033>", ESC_STR "[?1l" ESC_STR_nc ">")},
903# ifdef FEAT_XTERM_SAVE
904 {(int)KS_TI, IF_EB("\0337\033[?47h", ESC_STR "7" ESC_STR_nc "[?47h")},
Bram Moolenaard02e5082020-02-08 14:22:53 +0100905 {(int)KS_TE, IF_EB("\033[?47l\0338",
906 ESC_STR_nc "[?47l" ESC_STR_nc "8")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907# endif
Bram Moolenaar4b570182019-10-20 19:53:22 +0200908 {(int)KS_CTI, IF_EB("\033[>4;2m", ESC_STR_nc "[>4;2m")},
909 {(int)KS_CTE, IF_EB("\033[>4;m", ESC_STR_nc "[>4;m")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 {(int)KS_CIS, IF_EB("\033]1;", ESC_STR "]1;")},
911 {(int)KS_CIE, "\007"},
912 {(int)KS_TS, IF_EB("\033]2;", ESC_STR "]2;")},
913 {(int)KS_FS, "\007"},
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +0200914 {(int)KS_CSC, IF_EB("\033]12;", ESC_STR "]12;")},
915 {(int)KS_CEC, "\007"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916# ifdef TERMINFO
917 {(int)KS_CWS, IF_EB("\033[8;%p1%d;%p2%dt",
918 ESC_STR "[8;%p1%d;%p2%dt")},
919 {(int)KS_CWP, IF_EB("\033[3;%p1%d;%p2%dt",
920 ESC_STR "[3;%p1%d;%p2%dt")},
Bram Moolenaarba6ec182017-04-04 22:41:10 +0200921 {(int)KS_CGP, IF_EB("\033[13t", ESC_STR "[13t")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922# else
923 {(int)KS_CWS, IF_EB("\033[8;%d;%dt", ESC_STR "[8;%d;%dt")},
924 {(int)KS_CWP, IF_EB("\033[3;%d;%dt", ESC_STR "[3;%d;%dt")},
Bram Moolenaarba6ec182017-04-04 22:41:10 +0200925 {(int)KS_CGP, IF_EB("\033[13t", ESC_STR "[13t")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926# endif
927 {(int)KS_CRV, IF_EB("\033[>c", ESC_STR "[>c")},
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +0200928 {(int)KS_RFG, IF_EB("\033]10;?\007", ESC_STR "]10;?\007")},
Bram Moolenaarb5c32652015-06-25 17:03:36 +0200929 {(int)KS_RBG, IF_EB("\033]11;?\007", ESC_STR "]11;?\007")},
Bram Moolenaar9584b312013-03-13 19:29:28 +0100930 {(int)KS_U7, IF_EB("\033[6n", ESC_STR "[6n")},
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200931# ifdef FEAT_TERMGUICOLORS
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100932 // These are printf strings, not terminal codes.
Bram Moolenaarb2fa54a2016-04-22 21:11:09 +0200933 {(int)KS_8F, IF_EB("\033[38;2;%lu;%lu;%lum", ESC_STR "[38;2;%lu;%lu;%lum")},
934 {(int)KS_8B, IF_EB("\033[48;2;%lu;%lu;%lum", ESC_STR "[48;2;%lu;%lu;%lum")},
Bram Moolenaare023e882020-05-31 16:42:30 +0200935 {(int)KS_8U, IF_EB("\033[58;2;%lu;%lu;%lum", ESC_STR "[58;2;%lu;%lu;%lum")},
Bram Moolenaarb2fa54a2016-04-22 21:11:09 +0200936# endif
Bram Moolenaare023e882020-05-31 16:42:30 +0200937 {(int)KS_CAU, IF_EB("\033[58;5;%dm", ESC_STR "[58;5;%dm")},
Bram Moolenaarec2da362017-01-21 20:04:22 +0100938 {(int)KS_CBE, IF_EB("\033[?2004h", ESC_STR "[?2004h")},
939 {(int)KS_CBD, IF_EB("\033[?2004l", ESC_STR "[?2004l")},
Bram Moolenaar40385db2018-08-07 22:31:44 +0200940 {(int)KS_CST, IF_EB("\033[22;2t", ESC_STR "[22;2t")},
941 {(int)KS_CRT, IF_EB("\033[23;2t", ESC_STR "[23;2t")},
942 {(int)KS_SSI, IF_EB("\033[22;1t", ESC_STR "[22;1t")},
943 {(int)KS_SRI, IF_EB("\033[23;1t", ESC_STR "[23;1t")},
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000944
945 {K_UP, IF_EB("\033O*A", ESC_STR "O*A")},
946 {K_DOWN, IF_EB("\033O*B", ESC_STR "O*B")},
947 {K_RIGHT, IF_EB("\033O*C", ESC_STR "O*C")},
948 {K_LEFT, IF_EB("\033O*D", ESC_STR "O*D")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100949 // An extra set of cursor keys for vt100 mode
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000950 {K_XUP, IF_EB("\033[1;*A", ESC_STR "[1;*A")},
951 {K_XDOWN, IF_EB("\033[1;*B", ESC_STR "[1;*B")},
952 {K_XRIGHT, IF_EB("\033[1;*C", ESC_STR "[1;*C")},
953 {K_XLEFT, IF_EB("\033[1;*D", ESC_STR "[1;*D")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100954 // An extra set of function keys for vt100 mode
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000955 {K_XF1, IF_EB("\033O*P", ESC_STR "O*P")},
956 {K_XF2, IF_EB("\033O*Q", ESC_STR "O*Q")},
957 {K_XF3, IF_EB("\033O*R", ESC_STR "O*R")},
958 {K_XF4, IF_EB("\033O*S", ESC_STR "O*S")},
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000959 {K_F1, IF_EB("\033[11;*~", ESC_STR "[11;*~")},
960 {K_F2, IF_EB("\033[12;*~", ESC_STR "[12;*~")},
961 {K_F3, IF_EB("\033[13;*~", ESC_STR "[13;*~")},
962 {K_F4, IF_EB("\033[14;*~", ESC_STR "[14;*~")},
963 {K_F5, IF_EB("\033[15;*~", ESC_STR "[15;*~")},
964 {K_F6, IF_EB("\033[17;*~", ESC_STR "[17;*~")},
965 {K_F7, IF_EB("\033[18;*~", ESC_STR "[18;*~")},
966 {K_F8, IF_EB("\033[19;*~", ESC_STR "[19;*~")},
967 {K_F9, IF_EB("\033[20;*~", ESC_STR "[20;*~")},
968 {K_F10, IF_EB("\033[21;*~", ESC_STR "[21;*~")},
969 {K_F11, IF_EB("\033[23;*~", ESC_STR "[23;*~")},
970 {K_F12, IF_EB("\033[24;*~", ESC_STR "[24;*~")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971 {K_S_TAB, IF_EB("\033[Z", ESC_STR "[Z")},
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000972 {K_HELP, IF_EB("\033[28;*~", ESC_STR "[28;*~")},
973 {K_UNDO, IF_EB("\033[26;*~", ESC_STR "[26;*~")},
974 {K_INS, IF_EB("\033[2;*~", ESC_STR "[2;*~")},
975 {K_HOME, IF_EB("\033[1;*H", ESC_STR "[1;*H")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100976 // {K_S_HOME, IF_EB("\033O2H", ESC_STR "O2H")},
977 // {K_C_HOME, IF_EB("\033O5H", ESC_STR "O5H")},
Bram Moolenaar68b76a62005-03-25 21:53:48 +0000978 {K_KHOME, IF_EB("\033[1;*~", ESC_STR "[1;*~")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100979 {K_XHOME, IF_EB("\033O*H", ESC_STR "O*H")}, // other Home
980 {K_ZHOME, IF_EB("\033[7;*~", ESC_STR "[7;*~")}, // other Home
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000981 {K_END, IF_EB("\033[1;*F", ESC_STR "[1;*F")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100982 // {K_S_END, IF_EB("\033O2F", ESC_STR "O2F")},
983 // {K_C_END, IF_EB("\033O5F", ESC_STR "O5F")},
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000984 {K_KEND, IF_EB("\033[4;*~", ESC_STR "[4;*~")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100985 {K_XEND, IF_EB("\033O*F", ESC_STR "O*F")}, // other End
Bram Moolenaar68b76a62005-03-25 21:53:48 +0000986 {K_ZEND, IF_EB("\033[8;*~", ESC_STR "[8;*~")},
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000987 {K_PAGEUP, IF_EB("\033[5;*~", ESC_STR "[5;*~")},
988 {K_PAGEDOWN, IF_EB("\033[6;*~", ESC_STR "[6;*~")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100989 {K_KPLUS, IF_EB("\033O*k", ESC_STR "O*k")}, // keypad plus
990 {K_KMINUS, IF_EB("\033O*m", ESC_STR "O*m")}, // keypad minus
991 {K_KDIVIDE, IF_EB("\033O*o", ESC_STR "O*o")}, // keypad /
992 {K_KMULTIPLY, IF_EB("\033O*j", ESC_STR "O*j")}, // keypad *
993 {K_KENTER, IF_EB("\033O*M", ESC_STR "O*M")}, // keypad Enter
994 {K_KPOINT, IF_EB("\033O*n", ESC_STR "O*n")}, // keypad .
995 {K_K0, IF_EB("\033O*p", ESC_STR "O*p")}, // keypad 0
996 {K_K1, IF_EB("\033O*q", ESC_STR "O*q")}, // keypad 1
997 {K_K2, IF_EB("\033O*r", ESC_STR "O*r")}, // keypad 2
998 {K_K3, IF_EB("\033O*s", ESC_STR "O*s")}, // keypad 3
999 {K_K4, IF_EB("\033O*t", ESC_STR "O*t")}, // keypad 4
1000 {K_K5, IF_EB("\033O*u", ESC_STR "O*u")}, // keypad 5
1001 {K_K6, IF_EB("\033O*v", ESC_STR "O*v")}, // keypad 6
1002 {K_K7, IF_EB("\033O*w", ESC_STR "O*w")}, // keypad 7
1003 {K_K8, IF_EB("\033O*x", ESC_STR "O*x")}, // keypad 8
1004 {K_K9, IF_EB("\033O*y", ESC_STR "O*y")}, // keypad 9
1005 {K_KDEL, IF_EB("\033[3;*~", ESC_STR "[3;*~")}, // keypad Del
1006 {K_PS, IF_EB("\033[200~", ESC_STR "[200~")}, // paste start
1007 {K_PE, IF_EB("\033[201~", ESC_STR "[201~")}, // paste end
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008
1009 {BT_EXTRA_KEYS, ""},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001010 {TERMCAP2KEY('k', '0'), IF_EB("\033[10;*~", ESC_STR "[10;*~")}, // F0
1011 {TERMCAP2KEY('F', '3'), IF_EB("\033[25;*~", ESC_STR "[25;*~")}, // F13
1012 // F14 and F15 are missing, because they send the same codes as the undo
1013 // and help key, although they don't work on all keyboards.
1014 {TERMCAP2KEY('F', '6'), IF_EB("\033[29;*~", ESC_STR "[29;*~")}, // F16
1015 {TERMCAP2KEY('F', '7'), IF_EB("\033[31;*~", ESC_STR "[31;*~")}, // F17
1016 {TERMCAP2KEY('F', '8'), IF_EB("\033[32;*~", ESC_STR "[32;*~")}, // F18
1017 {TERMCAP2KEY('F', '9'), IF_EB("\033[33;*~", ESC_STR "[33;*~")}, // F19
1018 {TERMCAP2KEY('F', 'A'), IF_EB("\033[34;*~", ESC_STR "[34;*~")}, // F20
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001019
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001020 {TERMCAP2KEY('F', 'B'), IF_EB("\033[42;*~", ESC_STR "[42;*~")}, // F21
1021 {TERMCAP2KEY('F', 'C'), IF_EB("\033[43;*~", ESC_STR "[43;*~")}, // F22
1022 {TERMCAP2KEY('F', 'D'), IF_EB("\033[44;*~", ESC_STR "[44;*~")}, // F23
1023 {TERMCAP2KEY('F', 'E'), IF_EB("\033[45;*~", ESC_STR "[45;*~")}, // F24
1024 {TERMCAP2KEY('F', 'F'), IF_EB("\033[46;*~", ESC_STR "[46;*~")}, // F25
1025 {TERMCAP2KEY('F', 'G'), IF_EB("\033[47;*~", ESC_STR "[47;*~")}, // F26
1026 {TERMCAP2KEY('F', 'H'), IF_EB("\033[48;*~", ESC_STR "[48;*~")}, // F27
1027 {TERMCAP2KEY('F', 'I'), IF_EB("\033[49;*~", ESC_STR "[49;*~")}, // F28
1028 {TERMCAP2KEY('F', 'J'), IF_EB("\033[50;*~", ESC_STR "[50;*~")}, // F29
1029 {TERMCAP2KEY('F', 'K'), IF_EB("\033[51;*~", ESC_STR "[51;*~")}, // F30
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001030
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001031 {TERMCAP2KEY('F', 'L'), IF_EB("\033[52;*~", ESC_STR "[52;*~")}, // F31
1032 {TERMCAP2KEY('F', 'M'), IF_EB("\033[53;*~", ESC_STR "[53;*~")}, // F32
1033 {TERMCAP2KEY('F', 'N'), IF_EB("\033[54;*~", ESC_STR "[54;*~")}, // F33
1034 {TERMCAP2KEY('F', 'O'), IF_EB("\033[55;*~", ESC_STR "[55;*~")}, // F34
1035 {TERMCAP2KEY('F', 'P'), IF_EB("\033[56;*~", ESC_STR "[56;*~")}, // F35
1036 {TERMCAP2KEY('F', 'Q'), IF_EB("\033[57;*~", ESC_STR "[57;*~")}, // F36
1037 {TERMCAP2KEY('F', 'R'), IF_EB("\033[58;*~", ESC_STR "[58;*~")}, // F37
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038# endif
1039
1040# if defined(UNIX) || defined(ALL_BUILTIN_TCAPS)
1041/*
1042 * iris-ansi for Silicon Graphics machines.
1043 */
1044 {(int)KS_NAME, "iris-ansi"},
1045 {(int)KS_CE, "\033[K"},
1046 {(int)KS_CD, "\033[J"},
1047 {(int)KS_AL, "\033[L"},
1048# ifdef TERMINFO
1049 {(int)KS_CAL, "\033[%p1%dL"},
1050# else
1051 {(int)KS_CAL, "\033[%dL"},
1052# endif
1053 {(int)KS_DL, "\033[M"},
1054# ifdef TERMINFO
1055 {(int)KS_CDL, "\033[%p1%dM"},
1056# else
1057 {(int)KS_CDL, "\033[%dM"},
1058# endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001059#if 0 // The scroll region is not working as Vim expects.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060# ifdef TERMINFO
1061 {(int)KS_CS, "\033[%i%p1%d;%p2%dr"},
1062# else
1063 {(int)KS_CS, "\033[%i%d;%dr"},
1064# endif
1065#endif
1066 {(int)KS_CL, "\033[H\033[2J"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001067 {(int)KS_VE, "\033[9/y\033[12/y"}, // These aren't documented
1068 {(int)KS_VS, "\033[10/y\033[=1h\033[=2l"}, // These aren't documented
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 {(int)KS_TI, "\033[=6h"},
1070 {(int)KS_TE, "\033[=6l"},
1071 {(int)KS_SE, "\033[21;27m"},
1072 {(int)KS_SO, "\033[1;7m"},
1073 {(int)KS_ME, "\033[m"},
1074 {(int)KS_MR, "\033[7m"},
1075 {(int)KS_MD, "\033[1m"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001076 {(int)KS_CCO, "8"}, // allow 8 colors
1077 {(int)KS_CZH, "\033[3m"}, // italic mode on
1078 {(int)KS_CZR, "\033[23m"}, // italic mode off
1079 {(int)KS_US, "\033[4m"}, // underline on
1080 {(int)KS_UE, "\033[24m"}, // underline off
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081# ifdef TERMINFO
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001082 {(int)KS_CAB, "\033[4%p1%dm"}, // set background color (ANSI)
1083 {(int)KS_CAF, "\033[3%p1%dm"}, // set foreground color (ANSI)
1084 {(int)KS_CSB, "\033[102;%p1%dm"}, // set screen background color
1085 {(int)KS_CSF, "\033[101;%p1%dm"}, // set screen foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086# else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001087 {(int)KS_CAB, "\033[4%dm"}, // set background color (ANSI)
1088 {(int)KS_CAF, "\033[3%dm"}, // set foreground color (ANSI)
1089 {(int)KS_CSB, "\033[102;%dm"}, // set screen background color
1090 {(int)KS_CSF, "\033[101;%dm"}, // set screen foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091# endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001092 {(int)KS_MS, "y"}, // guessed
1093 {(int)KS_UT, "y"}, // guessed
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094 {(int)KS_LE, "\b"},
1095# ifdef TERMINFO
1096 {(int)KS_CM, "\033[%i%p1%d;%p2%dH"},
1097# else
1098 {(int)KS_CM, "\033[%i%d;%dH"},
1099# endif
1100 {(int)KS_SR, "\033M"},
1101# ifdef TERMINFO
1102 {(int)KS_CRI, "\033[%p1%dC"},
1103# else
1104 {(int)KS_CRI, "\033[%dC"},
1105# endif
1106 {(int)KS_CIS, "\033P3.y"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001107 {(int)KS_CIE, "\234"}, // ST "String Terminator"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 {(int)KS_TS, "\033P1.y"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001109 {(int)KS_FS, "\234"}, // ST "String Terminator"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110# ifdef TERMINFO
1111 {(int)KS_CWS, "\033[203;%p1%d;%p2%d/y"},
1112 {(int)KS_CWP, "\033[205;%p1%d;%p2%d/y"},
1113# else
1114 {(int)KS_CWS, "\033[203;%d;%d/y"},
1115 {(int)KS_CWP, "\033[205;%d;%d/y"},
1116# endif
1117 {K_UP, "\033[A"},
1118 {K_DOWN, "\033[B"},
1119 {K_LEFT, "\033[D"},
1120 {K_RIGHT, "\033[C"},
1121 {K_S_UP, "\033[161q"},
1122 {K_S_DOWN, "\033[164q"},
1123 {K_S_LEFT, "\033[158q"},
1124 {K_S_RIGHT, "\033[167q"},
1125 {K_F1, "\033[001q"},
1126 {K_F2, "\033[002q"},
1127 {K_F3, "\033[003q"},
1128 {K_F4, "\033[004q"},
1129 {K_F5, "\033[005q"},
1130 {K_F6, "\033[006q"},
1131 {K_F7, "\033[007q"},
1132 {K_F8, "\033[008q"},
1133 {K_F9, "\033[009q"},
1134 {K_F10, "\033[010q"},
1135 {K_F11, "\033[011q"},
1136 {K_F12, "\033[012q"},
1137 {K_S_F1, "\033[013q"},
1138 {K_S_F2, "\033[014q"},
1139 {K_S_F3, "\033[015q"},
1140 {K_S_F4, "\033[016q"},
1141 {K_S_F5, "\033[017q"},
1142 {K_S_F6, "\033[018q"},
1143 {K_S_F7, "\033[019q"},
1144 {K_S_F8, "\033[020q"},
1145 {K_S_F9, "\033[021q"},
1146 {K_S_F10, "\033[022q"},
1147 {K_S_F11, "\033[023q"},
1148 {K_S_F12, "\033[024q"},
1149 {K_INS, "\033[139q"},
1150 {K_HOME, "\033[H"},
1151 {K_END, "\033[146q"},
1152 {K_PAGEUP, "\033[150q"},
1153 {K_PAGEDOWN, "\033[154q"},
1154# endif
1155
1156# if defined(DEBUG) || defined(ALL_BUILTIN_TCAPS)
1157/*
1158 * for debugging
1159 */
1160 {(int)KS_NAME, "debug"},
1161 {(int)KS_CE, "[CE]"},
1162 {(int)KS_CD, "[CD]"},
1163 {(int)KS_AL, "[AL]"},
1164# ifdef TERMINFO
1165 {(int)KS_CAL, "[CAL%p1%d]"},
1166# else
1167 {(int)KS_CAL, "[CAL%d]"},
1168# endif
1169 {(int)KS_DL, "[DL]"},
1170# ifdef TERMINFO
1171 {(int)KS_CDL, "[CDL%p1%d]"},
1172# else
1173 {(int)KS_CDL, "[CDL%d]"},
1174# endif
1175# ifdef TERMINFO
1176 {(int)KS_CS, "[%p1%dCS%p2%d]"},
1177# else
1178 {(int)KS_CS, "[%dCS%d]"},
1179# endif
Bram Moolenaar4033c552017-09-16 20:54:51 +02001180# ifdef TERMINFO
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 {(int)KS_CSV, "[%p1%dCSV%p2%d]"},
Bram Moolenaar4033c552017-09-16 20:54:51 +02001182# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 {(int)KS_CSV, "[%dCSV%d]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184# endif
1185# ifdef TERMINFO
1186 {(int)KS_CAB, "[CAB%p1%d]"},
1187 {(int)KS_CAF, "[CAF%p1%d]"},
1188 {(int)KS_CSB, "[CSB%p1%d]"},
1189 {(int)KS_CSF, "[CSF%p1%d]"},
1190# else
1191 {(int)KS_CAB, "[CAB%d]"},
1192 {(int)KS_CAF, "[CAF%d]"},
1193 {(int)KS_CSB, "[CSB%d]"},
1194 {(int)KS_CSF, "[CSF%d]"},
1195# endif
Bram Moolenaare023e882020-05-31 16:42:30 +02001196 {(int)KS_CAU, "[CAU%d]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 {(int)KS_OP, "[OP]"},
1198 {(int)KS_LE, "[LE]"},
1199 {(int)KS_CL, "[CL]"},
1200 {(int)KS_VI, "[VI]"},
1201 {(int)KS_VE, "[VE]"},
1202 {(int)KS_VS, "[VS]"},
1203 {(int)KS_ME, "[ME]"},
1204 {(int)KS_MR, "[MR]"},
1205 {(int)KS_MB, "[MB]"},
1206 {(int)KS_MD, "[MD]"},
1207 {(int)KS_SE, "[SE]"},
1208 {(int)KS_SO, "[SO]"},
1209 {(int)KS_UE, "[UE]"},
1210 {(int)KS_US, "[US]"},
Bram Moolenaare2cc9702005-03-15 22:43:58 +00001211 {(int)KS_UCE, "[UCE]"},
1212 {(int)KS_UCS, "[UCS]"},
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02001213 {(int)KS_STE, "[STE]"},
1214 {(int)KS_STS, "[STS]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 {(int)KS_MS, "[MS]"},
1216 {(int)KS_UT, "[UT]"},
Bram Moolenaar494838a2015-02-10 19:20:37 +01001217 {(int)KS_XN, "[XN]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218# ifdef TERMINFO
1219 {(int)KS_CM, "[%p1%dCM%p2%d]"},
1220# else
1221 {(int)KS_CM, "[%dCM%d]"},
1222# endif
1223 {(int)KS_SR, "[SR]"},
1224# ifdef TERMINFO
1225 {(int)KS_CRI, "[CRI%p1%d]"},
1226# else
1227 {(int)KS_CRI, "[CRI%d]"},
1228# endif
1229 {(int)KS_VB, "[VB]"},
1230 {(int)KS_KS, "[KS]"},
1231 {(int)KS_KE, "[KE]"},
1232 {(int)KS_TI, "[TI]"},
1233 {(int)KS_TE, "[TE]"},
1234 {(int)KS_CIS, "[CIS]"},
1235 {(int)KS_CIE, "[CIE]"},
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02001236 {(int)KS_CSC, "[CSC]"},
1237 {(int)KS_CEC, "[CEC]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238 {(int)KS_TS, "[TS]"},
1239 {(int)KS_FS, "[FS]"},
1240# ifdef TERMINFO
1241 {(int)KS_CWS, "[%p1%dCWS%p2%d]"},
1242 {(int)KS_CWP, "[%p1%dCWP%p2%d]"},
1243# else
1244 {(int)KS_CWS, "[%dCWS%d]"},
1245 {(int)KS_CWP, "[%dCWP%d]"},
1246# endif
1247 {(int)KS_CRV, "[CRV]"},
Bram Moolenaar9584b312013-03-13 19:29:28 +01001248 {(int)KS_U7, "[U7]"},
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02001249 {(int)KS_RFG, "[RFG]"},
Bram Moolenaarb5c32652015-06-25 17:03:36 +02001250 {(int)KS_RBG, "[RBG]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 {K_UP, "[KU]"},
1252 {K_DOWN, "[KD]"},
1253 {K_LEFT, "[KL]"},
1254 {K_RIGHT, "[KR]"},
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00001255 {K_XUP, "[xKU]"},
1256 {K_XDOWN, "[xKD]"},
1257 {K_XLEFT, "[xKL]"},
1258 {K_XRIGHT, "[xKR]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259 {K_S_UP, "[S-KU]"},
1260 {K_S_DOWN, "[S-KD]"},
1261 {K_S_LEFT, "[S-KL]"},
1262 {K_C_LEFT, "[C-KL]"},
1263 {K_S_RIGHT, "[S-KR]"},
1264 {K_C_RIGHT, "[C-KR]"},
1265 {K_F1, "[F1]"},
1266 {K_XF1, "[xF1]"},
1267 {K_F2, "[F2]"},
1268 {K_XF2, "[xF2]"},
1269 {K_F3, "[F3]"},
1270 {K_XF3, "[xF3]"},
1271 {K_F4, "[F4]"},
1272 {K_XF4, "[xF4]"},
1273 {K_F5, "[F5]"},
1274 {K_F6, "[F6]"},
1275 {K_F7, "[F7]"},
1276 {K_F8, "[F8]"},
1277 {K_F9, "[F9]"},
1278 {K_F10, "[F10]"},
1279 {K_F11, "[F11]"},
1280 {K_F12, "[F12]"},
1281 {K_S_F1, "[S-F1]"},
1282 {K_S_XF1, "[S-xF1]"},
1283 {K_S_F2, "[S-F2]"},
1284 {K_S_XF2, "[S-xF2]"},
1285 {K_S_F3, "[S-F3]"},
1286 {K_S_XF3, "[S-xF3]"},
1287 {K_S_F4, "[S-F4]"},
1288 {K_S_XF4, "[S-xF4]"},
1289 {K_S_F5, "[S-F5]"},
1290 {K_S_F6, "[S-F6]"},
1291 {K_S_F7, "[S-F7]"},
1292 {K_S_F8, "[S-F8]"},
1293 {K_S_F9, "[S-F9]"},
1294 {K_S_F10, "[S-F10]"},
1295 {K_S_F11, "[S-F11]"},
1296 {K_S_F12, "[S-F12]"},
1297 {K_HELP, "[HELP]"},
1298 {K_UNDO, "[UNDO]"},
1299 {K_BS, "[BS]"},
1300 {K_INS, "[INS]"},
1301 {K_KINS, "[KINS]"},
1302 {K_DEL, "[DEL]"},
1303 {K_KDEL, "[KDEL]"},
1304 {K_HOME, "[HOME]"},
1305 {K_S_HOME, "[C-HOME]"},
1306 {K_C_HOME, "[C-HOME]"},
1307 {K_KHOME, "[KHOME]"},
1308 {K_XHOME, "[XHOME]"},
Bram Moolenaar68b76a62005-03-25 21:53:48 +00001309 {K_ZHOME, "[ZHOME]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310 {K_END, "[END]"},
1311 {K_S_END, "[C-END]"},
1312 {K_C_END, "[C-END]"},
1313 {K_KEND, "[KEND]"},
1314 {K_XEND, "[XEND]"},
Bram Moolenaar68b76a62005-03-25 21:53:48 +00001315 {K_ZEND, "[ZEND]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 {K_PAGEUP, "[PAGEUP]"},
1317 {K_PAGEDOWN, "[PAGEDOWN]"},
1318 {K_KPAGEUP, "[KPAGEUP]"},
1319 {K_KPAGEDOWN, "[KPAGEDOWN]"},
1320 {K_MOUSE, "[MOUSE]"},
1321 {K_KPLUS, "[KPLUS]"},
1322 {K_KMINUS, "[KMINUS]"},
1323 {K_KDIVIDE, "[KDIVIDE]"},
1324 {K_KMULTIPLY, "[KMULTIPLY]"},
1325 {K_KENTER, "[KENTER]"},
1326 {K_KPOINT, "[KPOINT]"},
Bram Moolenaarec2da362017-01-21 20:04:22 +01001327 {K_PS, "[PASTE-START]"},
1328 {K_PE, "[PASTE-END]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 {K_K0, "[K0]"},
1330 {K_K1, "[K1]"},
1331 {K_K2, "[K2]"},
1332 {K_K3, "[K3]"},
1333 {K_K4, "[K4]"},
1334 {K_K5, "[K5]"},
1335 {K_K6, "[K6]"},
1336 {K_K7, "[K7]"},
1337 {K_K8, "[K8]"},
1338 {K_K9, "[K9]"},
1339# endif
1340
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001341#endif // NO_BUILTIN_TCAPS
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342
1343/*
1344 * The most minimal terminal: only clear screen and cursor positioning
1345 * Always included.
1346 */
1347 {(int)KS_NAME, "dumb"},
1348 {(int)KS_CL, "\014"},
1349#ifdef TERMINFO
1350 {(int)KS_CM, IF_EB("\033[%i%p1%d;%p2%dH",
1351 ESC_STR "[%i%p1%d;%p2%dH")},
1352#else
1353 {(int)KS_CM, IF_EB("\033[%i%d;%dH", ESC_STR "[%i%d;%dH")},
1354#endif
1355
1356/*
1357 * end marker
1358 */
1359 {(int)KS_NAME, NULL}
1360
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001361}; // end of builtin_termcaps
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001363#if defined(FEAT_TERMGUICOLORS) || defined(PROTO)
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001364 static guicolor_T
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001365termgui_mch_get_color(char_u *name)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001366{
Bram Moolenaarab302212016-04-26 20:59:29 +02001367 return gui_get_color_cmn(name);
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001368}
1369
1370 guicolor_T
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001371termgui_get_color(char_u *name)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001372{
1373 guicolor_T t;
1374
1375 if (*name == NUL)
1376 return INVALCOLOR;
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001377 t = termgui_mch_get_color(name);
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001378
1379 if (t == INVALCOLOR)
Bram Moolenaar87202262020-05-24 17:23:45 +02001380 semsg(_(e_alloc_color), name);
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001381 return t;
1382}
1383
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +02001384 guicolor_T
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001385termgui_mch_get_rgb(guicolor_T color)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001386{
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +02001387 return color;
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001388}
1389#endif
1390
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391/*
1392 * DEFAULT_TERM is used, when no terminal is specified with -T option or $TERM.
1393 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394#ifdef AMIGA
1395# define DEFAULT_TERM (char_u *)"amiga"
1396#endif
1397
1398#ifdef MSWIN
1399# define DEFAULT_TERM (char_u *)"win32"
1400#endif
1401
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402#if defined(UNIX) && !defined(__MINT__)
1403# define DEFAULT_TERM (char_u *)"ansi"
1404#endif
1405
1406#ifdef __MINT__
1407# define DEFAULT_TERM (char_u *)"vt52"
1408#endif
1409
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410#ifdef VMS
1411# define DEFAULT_TERM (char_u *)"vt320"
1412#endif
1413
Bram Moolenaarb3f74062020-02-26 16:16:53 +01001414#ifdef __HAIKU__
1415# undef DEFAULT_TERM
1416# define DEFAULT_TERM (char_u *)"xterm"
1417#endif
1418
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419#ifndef DEFAULT_TERM
1420# define DEFAULT_TERM (char_u *)"dumb"
1421#endif
1422
1423/*
1424 * Term_strings contains currently used terminal output strings.
1425 * It is initialized with the default values by parse_builtin_tcap().
1426 * The values can be changed by setting the option with the same name.
1427 */
1428char_u *(term_strings[(int)KS_LAST + 1]);
1429
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001430static int need_gather = FALSE; // need to fill termleader[]
1431static char_u termleader[256 + 1]; // for check_termcode()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432#ifdef FEAT_TERMRESPONSE
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001433static int check_for_codes = FALSE; // check for key code response
Bram Moolenaar517f00f2020-06-10 12:15:51 +02001434
1435/*
1436 * Structure and table to store terminal features that can be detected by
1437 * querying the terminal. Either by inspecting the termresponse or a more
1438 * specific request. Besides this there are:
1439 * t_colors - number of colors supported
1440 */
1441typedef struct {
1442 char *tpr_name;
1443 int tpr_set_by_termresponse;
1444 int tpr_status;
1445} termprop_T;
1446
1447// Values for tpr_status.
1448#define TPR_UNKNOWN 'u'
1449#define TPR_YES 'y'
1450#define TPR_NO 'n'
1451#define TPR_MOUSE_XTERM 'x' // use "xterm" for 'ttymouse'
1452#define TPR_MOUSE_XTERM2 '2' // use "xterm2" for 'ttymouse'
1453#define TPR_MOUSE_SGR 's' // use "sgr" for 'ttymouse'
1454
1455// can request the cursor style without messing up the display
1456#define TPR_CURSOR_STYLE 0
1457// can request the cursor blink mode without messing up the display
1458#define TPR_CURSOR_BLINK 1
1459// can set the underline color with t_8u without resetting other colors
1460#define TPR_UNDERLINE_RGB 2
1461// mouse support - TPR_MOUSE_XTERM, TPR_MOUSE_XTERM2 or TPR_MOUSE_SGR
1462#define TPR_MOUSE 3
1463// table size
1464#define TPR_COUNT 4
1465
1466static termprop_T term_props[TPR_COUNT];
1467
1468/*
1469 * Initialize the term_props table.
1470 * When "all" is FALSE only set those that are detected from the version
1471 * response.
1472 */
1473 static void
1474init_term_props(int all)
1475{
1476 int i;
1477
1478 term_props[TPR_CURSOR_STYLE].tpr_name = "cursor_style";
1479 term_props[TPR_CURSOR_STYLE].tpr_set_by_termresponse = FALSE;
1480 term_props[TPR_CURSOR_BLINK].tpr_name = "cursor_blink_mode";
1481 term_props[TPR_CURSOR_BLINK].tpr_set_by_termresponse = FALSE;
1482 term_props[TPR_UNDERLINE_RGB].tpr_name = "underline_rgb";
1483 term_props[TPR_UNDERLINE_RGB].tpr_set_by_termresponse = TRUE;
1484 term_props[TPR_MOUSE].tpr_name = "mouse";
1485 term_props[TPR_MOUSE].tpr_set_by_termresponse = TRUE;
1486
1487 for (i = 0; i < TPR_COUNT; ++i)
1488 if (all || term_props[i].tpr_set_by_termresponse)
1489 term_props[i].tpr_status = TPR_UNKNOWN;
1490}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491#endif
1492
1493 static struct builtin_term *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01001494find_builtin_term(char_u *term)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495{
1496 struct builtin_term *p;
1497
1498 p = builtin_termcaps;
1499 while (p->bt_string != NULL)
1500 {
1501 if (p->bt_entry == (int)KS_NAME)
1502 {
1503#ifdef UNIX
1504 if (STRCMP(p->bt_string, "iris-ansi") == 0 && vim_is_iris(term))
1505 return p;
1506 else if (STRCMP(p->bt_string, "xterm") == 0 && vim_is_xterm(term))
1507 return p;
1508 else
1509#endif
1510#ifdef VMS
1511 if (STRCMP(p->bt_string, "vt320") == 0 && vim_is_vt300(term))
1512 return p;
1513 else
1514#endif
1515 if (STRCMP(term, p->bt_string) == 0)
1516 return p;
1517 }
1518 ++p;
1519 }
1520 return p;
1521}
1522
1523/*
1524 * Parsing of the builtin termcap entries.
1525 * Caller should check if 'name' is a valid builtin term.
1526 * The terminal's name is not set, as this is already done in termcapinit().
1527 */
1528 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01001529parse_builtin_tcap(char_u *term)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530{
1531 struct builtin_term *p;
1532 char_u name[2];
1533 int term_8bit;
1534
1535 p = find_builtin_term(term);
1536 term_8bit = term_is_8bit(term);
1537
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001538 // Do not parse if builtin term not found
Bram Moolenaar071d4272004-06-13 20:20:40 +00001539 if (p->bt_string == NULL)
1540 return;
1541
1542 for (++p; p->bt_entry != (int)KS_NAME && p->bt_entry != BT_EXTRA_KEYS; ++p)
1543 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001544 if ((int)p->bt_entry >= 0) // KS_xx entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001546 // Only set the value if it wasn't set yet.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 if (term_strings[p->bt_entry] == NULL
1548 || term_strings[p->bt_entry] == empty_option)
1549 {
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001550#ifdef FEAT_EVAL
1551 int opt_idx = -1;
1552#endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001553 // 8bit terminal: use CSI instead of <Esc>[
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 if (term_8bit && term_7to8bit((char_u *)p->bt_string) != 0)
1555 {
1556 char_u *s, *t;
1557
1558 s = vim_strsave((char_u *)p->bt_string);
1559 if (s != NULL)
1560 {
1561 for (t = s; *t; ++t)
1562 if (term_7to8bit(t))
1563 {
1564 *t = term_7to8bit(t);
Bram Moolenaar18085fa2018-07-10 17:33:45 +02001565 STRMOVE(t + 1, t + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 }
1567 term_strings[p->bt_entry] = s;
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001568#ifdef FEAT_EVAL
1569 opt_idx =
1570#endif
1571 set_term_option_alloced(
1572 &term_strings[p->bt_entry]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573 }
1574 }
1575 else
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001576 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 term_strings[p->bt_entry] = (char_u *)p->bt_string;
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001578#ifdef FEAT_EVAL
1579 opt_idx = get_term_opt_idx(&term_strings[p->bt_entry]);
1580#endif
1581 }
1582#ifdef FEAT_EVAL
1583 set_term_option_sctx_idx(NULL, opt_idx);
1584#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585 }
1586 }
1587 else
1588 {
1589 name[0] = KEY2TERMCAP0((int)p->bt_entry);
1590 name[1] = KEY2TERMCAP1((int)p->bt_entry);
1591 if (find_termcode(name) == NULL)
1592 add_termcode(name, (char_u *)p->bt_string, term_8bit);
1593 }
1594 }
1595}
Bram Moolenaard7d3cbe2017-07-22 21:15:42 +02001596
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597/*
1598 * Set number of colors.
1599 * Store it as a number in t_colors.
1600 * Store it as a string in T_CCO (using nr_colors[]).
1601 */
Bram Moolenaaracc770a2020-04-12 15:11:06 +02001602 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01001603set_color_count(int nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001605 char_u nr_colors[20]; // string for number of colors
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606
1607 t_colors = nr;
1608 if (t_colors > 1)
1609 sprintf((char *)nr_colors, "%d", t_colors);
1610 else
1611 *nr_colors = NUL;
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001612 set_string_option_direct((char_u *)"t_Co", -1, nr_colors, OPT_FREE, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613}
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001614
Bram Moolenaard7d3cbe2017-07-22 21:15:42 +02001615#if defined(FEAT_TERMRESPONSE)
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001616/*
1617 * Set the color count to "val" and redraw if it changed.
1618 */
1619 static void
1620may_adjust_color_count(int val)
1621{
1622 if (val != t_colors)
1623 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001624 // Nr of colors changed, initialize highlighting and
1625 // redraw everything. This causes a redraw, which usually
1626 // clears the message. Try keeping the message if it
1627 // might work.
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001628 set_keep_msg_from_hist();
1629 set_color_count(val);
1630 init_highlight(TRUE, FALSE);
1631# ifdef DEBUG_TERMRESPONSE
1632 {
Bram Moolenaarb255b902018-04-24 21:40:10 +02001633 int r = redraw_asap(CLEAR);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001634
Bram Moolenaarb255b902018-04-24 21:40:10 +02001635 log_tr("Received t_Co, redraw_asap(): %d", r);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001636 }
Bram Moolenaar87202262020-05-24 17:23:45 +02001637# else
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001638 redraw_asap(CLEAR);
Bram Moolenaar87202262020-05-24 17:23:45 +02001639# endif
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001640 }
1641}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642#endif
1643
1644#ifdef HAVE_TGETENT
1645static char *(key_names[]) =
1646{
Bram Moolenaar87202262020-05-24 17:23:45 +02001647# ifdef FEAT_TERMRESPONSE
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001648 // Do this one first, it may cause a screen redraw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 "Co",
Bram Moolenaar87202262020-05-24 17:23:45 +02001650# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 "ku", "kd", "kr", "kl",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 "#2", "#4", "%i", "*7",
1653 "k1", "k2", "k3", "k4", "k5", "k6",
1654 "k7", "k8", "k9", "k;", "F1", "F2",
1655 "%1", "&8", "kb", "kI", "kD", "kh",
1656 "@7", "kP", "kN", "K1", "K3", "K4", "K5", "kB",
1657 NULL
1658};
1659#endif
1660
Bram Moolenaar9289df52018-05-10 14:40:57 +02001661#ifdef HAVE_TGETENT
Bram Moolenaar69e05692018-05-10 14:11:52 +02001662 static void
1663get_term_entries(int *height, int *width)
1664{
1665 static struct {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001666 enum SpecialKey dest; // index in term_strings[]
1667 char *name; // termcap name for string
Bram Moolenaar69e05692018-05-10 14:11:52 +02001668 } string_names[] =
1669 { {KS_CE, "ce"}, {KS_AL, "al"}, {KS_CAL,"AL"},
1670 {KS_DL, "dl"}, {KS_CDL,"DL"}, {KS_CS, "cs"},
1671 {KS_CL, "cl"}, {KS_CD, "cd"},
1672 {KS_VI, "vi"}, {KS_VE, "ve"}, {KS_MB, "mb"},
1673 {KS_ME, "me"}, {KS_MR, "mr"},
1674 {KS_MD, "md"}, {KS_SE, "se"}, {KS_SO, "so"},
1675 {KS_CZH,"ZH"}, {KS_CZR,"ZR"}, {KS_UE, "ue"},
1676 {KS_US, "us"}, {KS_UCE, "Ce"}, {KS_UCS, "Cs"},
1677 {KS_STE,"Te"}, {KS_STS,"Ts"},
1678 {KS_CM, "cm"}, {KS_SR, "sr"},
1679 {KS_CRI,"RI"}, {KS_VB, "vb"}, {KS_KS, "ks"},
1680 {KS_KE, "ke"}, {KS_TI, "ti"}, {KS_TE, "te"},
Bram Moolenaar171a9212019-10-12 21:08:59 +02001681 {KS_CTI, "TI"}, {KS_CTE, "TE"},
Bram Moolenaar69e05692018-05-10 14:11:52 +02001682 {KS_BC, "bc"}, {KS_CSB,"Sb"}, {KS_CSF,"Sf"},
Bram Moolenaare023e882020-05-31 16:42:30 +02001683 {KS_CAB,"AB"}, {KS_CAF,"AF"}, {KS_CAU,"AU"},
1684 {KS_LE, "le"},
Bram Moolenaar69e05692018-05-10 14:11:52 +02001685 {KS_ND, "nd"}, {KS_OP, "op"}, {KS_CRV, "RV"},
1686 {KS_VS, "vs"}, {KS_CVS, "VS"},
1687 {KS_CIS, "IS"}, {KS_CIE, "IE"},
1688 {KS_CSC, "SC"}, {KS_CEC, "EC"},
1689 {KS_TS, "ts"}, {KS_FS, "fs"},
1690 {KS_CWP, "WP"}, {KS_CWS, "WS"},
1691 {KS_CSI, "SI"}, {KS_CEI, "EI"},
1692 {KS_U7, "u7"}, {KS_RFG, "RF"}, {KS_RBG, "RB"},
Bram Moolenaare023e882020-05-31 16:42:30 +02001693 {KS_8F, "8f"}, {KS_8B, "8b"}, {KS_8U, "8u"},
Bram Moolenaar69e05692018-05-10 14:11:52 +02001694 {KS_CBE, "BE"}, {KS_CBD, "BD"},
1695 {KS_CPS, "PS"}, {KS_CPE, "PE"},
Bram Moolenaar40385db2018-08-07 22:31:44 +02001696 {KS_CST, "ST"}, {KS_CRT, "RT"},
1697 {KS_SSI, "Si"}, {KS_SRI, "Ri"},
Bram Moolenaar69e05692018-05-10 14:11:52 +02001698 {(enum SpecialKey)0, NULL}
1699 };
1700 int i;
1701 char_u *p;
1702 static char_u tstrbuf[TBUFSZ];
1703 char_u *tp = tstrbuf;
1704
1705 /*
1706 * get output strings
1707 */
1708 for (i = 0; string_names[i].name != NULL; ++i)
1709 {
1710 if (TERM_STR(string_names[i].dest) == NULL
1711 || TERM_STR(string_names[i].dest) == empty_option)
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001712 {
Bram Moolenaar69e05692018-05-10 14:11:52 +02001713 TERM_STR(string_names[i].dest) = TGETSTR(string_names[i].name, &tp);
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001714#ifdef FEAT_EVAL
1715 set_term_option_sctx_idx(string_names[i].name, -1);
1716#endif
1717 }
Bram Moolenaar69e05692018-05-10 14:11:52 +02001718 }
1719
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001720 // tgetflag() returns 1 if the flag is present, 0 if not and
1721 // possibly -1 if the flag doesn't exist.
Bram Moolenaar69e05692018-05-10 14:11:52 +02001722 if ((T_MS == NULL || T_MS == empty_option) && tgetflag("ms") > 0)
1723 T_MS = (char_u *)"y";
1724 if ((T_XS == NULL || T_XS == empty_option) && tgetflag("xs") > 0)
1725 T_XS = (char_u *)"y";
1726 if ((T_XN == NULL || T_XN == empty_option) && tgetflag("xn") > 0)
1727 T_XN = (char_u *)"y";
1728 if ((T_DB == NULL || T_DB == empty_option) && tgetflag("db") > 0)
1729 T_DB = (char_u *)"y";
1730 if ((T_DA == NULL || T_DA == empty_option) && tgetflag("da") > 0)
1731 T_DA = (char_u *)"y";
1732 if ((T_UT == NULL || T_UT == empty_option) && tgetflag("ut") > 0)
1733 T_UT = (char_u *)"y";
1734
1735 /*
1736 * get key codes
1737 */
1738 for (i = 0; key_names[i] != NULL; ++i)
1739 if (find_termcode((char_u *)key_names[i]) == NULL)
1740 {
1741 p = TGETSTR(key_names[i], &tp);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001742 // if cursor-left == backspace, ignore it (televideo 925)
Bram Moolenaar69e05692018-05-10 14:11:52 +02001743 if (p != NULL
1744 && (*p != Ctrl_H
1745 || key_names[i][0] != 'k'
1746 || key_names[i][1] != 'l'))
1747 add_termcode((char_u *)key_names[i], p, FALSE);
1748 }
1749
1750 if (*height == 0)
1751 *height = tgetnum("li");
1752 if (*width == 0)
1753 *width = tgetnum("co");
1754
1755 /*
1756 * Get number of colors (if not done already).
1757 */
1758 if (TERM_STR(KS_CCO) == NULL || TERM_STR(KS_CCO) == empty_option)
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001759 {
Bram Moolenaar69e05692018-05-10 14:11:52 +02001760 set_color_count(tgetnum("Co"));
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001761#ifdef FEAT_EVAL
1762 set_term_option_sctx_idx("Co", -1);
1763#endif
1764 }
Bram Moolenaar69e05692018-05-10 14:11:52 +02001765
1766# ifndef hpux
1767 BC = (char *)TGETSTR("bc", &tp);
1768 UP = (char *)TGETSTR("up", &tp);
1769 p = TGETSTR("pc", &tp);
1770 if (p)
1771 PC = *p;
1772# endif
1773}
Bram Moolenaar9289df52018-05-10 14:40:57 +02001774#endif
Bram Moolenaar69e05692018-05-10 14:11:52 +02001775
1776 static void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001777report_term_error(char *error_msg, char_u *term)
Bram Moolenaar69e05692018-05-10 14:11:52 +02001778{
1779 struct builtin_term *termp;
1780
1781 mch_errmsg("\r\n");
1782 if (error_msg != NULL)
1783 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001784 mch_errmsg(error_msg);
Bram Moolenaar69e05692018-05-10 14:11:52 +02001785 mch_errmsg("\r\n");
1786 }
1787 mch_errmsg("'");
1788 mch_errmsg((char *)term);
1789 mch_errmsg(_("' not known. Available builtin terminals are:"));
1790 mch_errmsg("\r\n");
1791 for (termp = &(builtin_termcaps[0]); termp->bt_string != NULL; ++termp)
1792 {
1793 if (termp->bt_entry == (int)KS_NAME)
1794 {
1795#ifdef HAVE_TGETENT
1796 mch_errmsg(" builtin_");
1797#else
1798 mch_errmsg(" ");
1799#endif
1800 mch_errmsg(termp->bt_string);
1801 mch_errmsg("\r\n");
1802 }
1803 }
1804}
1805
1806 static void
1807report_default_term(char_u *term)
1808{
1809 mch_errmsg(_("defaulting to '"));
1810 mch_errmsg((char *)term);
1811 mch_errmsg("'\r\n");
1812 if (emsg_silent == 0)
1813 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001814 screen_start(); // don't know where cursor is now
Bram Moolenaar69e05692018-05-10 14:11:52 +02001815 out_flush();
1816 if (!is_not_a_term())
Bram Moolenaareda1da02019-11-17 17:06:33 +01001817 ui_delay(2007L, TRUE);
Bram Moolenaar69e05692018-05-10 14:11:52 +02001818 }
1819}
1820
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821/*
1822 * Set terminal options for terminal "term".
1823 * Return OK if terminal 'term' was found in a termcap, FAIL otherwise.
1824 *
1825 * While doing this, until ttest(), some options may be NULL, be careful.
1826 */
1827 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01001828set_termname(char_u *term)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829{
1830 struct builtin_term *termp;
1831#ifdef HAVE_TGETENT
1832 int builtin_first = p_tbi;
1833 int try;
1834 int termcap_cleared = FALSE;
1835#endif
1836 int width = 0, height = 0;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001837 char *error_msg = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 char_u *bs_p, *del_p;
1839
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001840 // In silect mode (ex -s) we don't use the 'term' option.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001841 if (silent_mode)
1842 return OK;
1843
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001844 detected_8bit = FALSE; // reset 8-bit detection
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845
1846 if (term_is_builtin(term))
1847 {
1848 term += 8;
1849#ifdef HAVE_TGETENT
1850 builtin_first = 1;
1851#endif
1852 }
1853
1854/*
1855 * If HAVE_TGETENT is not defined, only the builtin termcap is used, otherwise:
1856 * If builtin_first is TRUE:
1857 * 0. try builtin termcap
1858 * 1. try external termcap
1859 * 2. if both fail default to a builtin terminal
1860 * If builtin_first is FALSE:
1861 * 1. try external termcap
1862 * 2. try builtin termcap, if both fail default to a builtin terminal
1863 */
1864#ifdef HAVE_TGETENT
1865 for (try = builtin_first ? 0 : 1; try < 3; ++try)
1866 {
1867 /*
1868 * Use external termcap
1869 */
1870 if (try == 1)
1871 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 char_u tbuf[TBUFSZ];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873
1874 /*
1875 * If the external termcap does not have a matching entry, try the
1876 * builtin ones.
1877 */
1878 if ((error_msg = tgetent_error(tbuf, term)) == NULL)
1879 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 if (!termcap_cleared)
1881 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001882 clear_termoptions(); // clear old options
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 termcap_cleared = TRUE;
1884 }
1885
Bram Moolenaar69e05692018-05-10 14:11:52 +02001886 get_term_entries(&height, &width);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001887 }
1888 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001889 else // try == 0 || try == 2
1890#endif // HAVE_TGETENT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 /*
1892 * Use builtin termcap
1893 */
1894 {
1895#ifdef HAVE_TGETENT
1896 /*
1897 * If builtin termcap was already used, there is no need to search
1898 * for the builtin termcap again, quit now.
1899 */
1900 if (try == 2 && builtin_first && termcap_cleared)
1901 break;
1902#endif
1903 /*
1904 * search for 'term' in builtin_termcaps[]
1905 */
1906 termp = find_builtin_term(term);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001907 if (termp->bt_string == NULL) // did not find it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 {
1909#ifdef HAVE_TGETENT
1910 /*
1911 * If try == 0, first try the external termcap. If that is not
1912 * found we'll get back here with try == 2.
1913 * If termcap_cleared is set we used the external termcap,
1914 * don't complain about not finding the term in the builtin
1915 * termcap.
1916 */
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001917 if (try == 0) // try external one
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 continue;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001919 if (termcap_cleared) // found in external termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 break;
1921#endif
Bram Moolenaar69e05692018-05-10 14:11:52 +02001922 report_term_error(error_msg, term);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001924 // when user typed :set term=xxx, quit here
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 if (starting != NO_SCREEN)
1926 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001927 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 wait_return(TRUE);
1929 return FAIL;
1930 }
1931 term = DEFAULT_TERM;
Bram Moolenaar69e05692018-05-10 14:11:52 +02001932 report_default_term(term);
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001933 set_string_option_direct((char_u *)"term", -1, term,
1934 OPT_FREE, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935 display_errors();
1936 }
1937 out_flush();
1938#ifdef HAVE_TGETENT
1939 if (!termcap_cleared)
1940 {
1941#endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001942 clear_termoptions(); // clear old options
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943#ifdef HAVE_TGETENT
1944 termcap_cleared = TRUE;
1945 }
1946#endif
1947 parse_builtin_tcap(term);
1948#ifdef FEAT_GUI
1949 if (term_is_gui(term))
1950 {
1951 out_flush();
1952 gui_init();
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001953 // If starting the GUI failed, don't do any of the other
1954 // things for this terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 if (!gui.in_use)
1956 return FAIL;
1957#ifdef HAVE_TGETENT
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001958 break; // don't try using external termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959#endif
1960 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001961#endif // FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 }
1963#ifdef HAVE_TGETENT
1964 }
1965#endif
1966
1967/*
1968 * special: There is no info in the termcap about whether the cursor
1969 * positioning is relative to the start of the screen or to the start of the
1970 * scrolling region. We just guess here. Only msdos pcterm is known to do it
1971 * relative.
1972 */
1973 if (STRCMP(term, "pcterm") == 0)
1974 T_CCS = (char_u *)"yes";
1975 else
1976 T_CCS = empty_option;
1977
1978#ifdef UNIX
1979/*
1980 * Any "stty" settings override the default for t_kb from the termcap.
1981 * This is in os_unix.c, because it depends a lot on the version of unix that
1982 * is being used.
1983 * Don't do this when the GUI is active, it uses "t_kb" and "t_kD" directly.
1984 */
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02001985# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 if (!gui.in_use)
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02001987# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 get_stty();
1989#endif
1990
1991/*
1992 * If the termcap has no entry for 'bs' and/or 'del' and the ioctl() also
1993 * didn't work, use the default CTRL-H
1994 * The default for t_kD is DEL, unless t_kb is DEL.
1995 * The vim_strsave'd strings are probably lost forever, well it's only two
1996 * bytes. Don't do this when the GUI is active, it uses "t_kb" and "t_kD"
1997 * directly.
1998 */
1999#ifdef FEAT_GUI
2000 if (!gui.in_use)
2001#endif
2002 {
2003 bs_p = find_termcode((char_u *)"kb");
2004 del_p = find_termcode((char_u *)"kD");
2005 if (bs_p == NULL || *bs_p == NUL)
2006 add_termcode((char_u *)"kb", (bs_p = (char_u *)CTRL_H_STR), FALSE);
2007 if ((del_p == NULL || *del_p == NUL) &&
2008 (bs_p == NULL || *bs_p != DEL))
2009 add_termcode((char_u *)"kD", (char_u *)DEL_STR, FALSE);
2010 }
2011
2012#if defined(UNIX) || defined(VMS)
2013 term_is_xterm = vim_is_xterm(term);
2014#endif
Bram Moolenaar0d2c4bf2019-10-17 22:17:02 +02002015#ifdef FEAT_TERMRESPONSE
Bram Moolenaar517f00f2020-06-10 12:15:51 +02002016 // Reset terminal properties that are set based on the termresponse, which
2017 // will be sent out soon.
2018 init_term_props(FALSE);
Bram Moolenaar0d2c4bf2019-10-17 22:17:02 +02002019#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002021#if defined(UNIX) || defined(VMS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 /*
2023 * For Unix, set the 'ttymouse' option to the type of mouse to be used.
2024 * The termcode for the mouse is added as a side effect in option.c.
2025 */
2026 {
Bram Moolenaar6d006f92017-06-23 22:35:34 +02002027 char_u *p = (char_u *)"";
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002029# ifdef FEAT_MOUSE_XTERM
Bram Moolenaar864207d2008-06-24 22:14:38 +00002030 if (use_xterm_like_mouse(term))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031 {
2032 if (use_xterm_mouse())
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002033 p = NULL; // keep existing value, might be "xterm2"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 else
2035 p = (char_u *)"xterm";
2036 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002037# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 if (p != NULL)
Bram Moolenaar15d55de2012-12-05 14:43:02 +01002039 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 set_option_value((char_u *)"ttym", 0L, p, 0);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002041 // Reset the WAS_SET flag, 'ttymouse' can be set to "sgr" or
2042 // "xterm2" in check_termcode().
Bram Moolenaar15d55de2012-12-05 14:43:02 +01002043 reset_option_was_set((char_u *)"ttym");
2044 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 if (p == NULL
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002046# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 || gui.in_use
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002048# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 )
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002050 check_mouse_termcode(); // set mouse termcode anyway
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002052#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 set_mouse_termcode(KS_MOUSE, (char_u *)"\233M");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002054#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056#ifdef USE_TERM_CONSOLE
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002057 // DEFAULT_TERM indicates that it is the machine console.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 if (STRCMP(term, DEFAULT_TERM) != 0)
2059 term_console = FALSE;
2060 else
2061 {
2062 term_console = TRUE;
2063# ifdef AMIGA
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002064 win_resize_on(); // enable window resizing reports
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065# endif
2066 }
2067#endif
2068
2069#if defined(UNIX) || defined(VMS)
2070 /*
2071 * 'ttyfast' is default on for xterm, iris-ansi and a few others.
2072 */
2073 if (vim_is_fastterm(term))
2074 p_tf = TRUE;
2075#endif
2076#ifdef USE_TERM_CONSOLE
2077 /*
2078 * 'ttyfast' is default on consoles
2079 */
2080 if (term_console)
2081 p_tf = TRUE;
2082#endif
2083
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002084 ttest(TRUE); // make sure we have a valid set of terminal codes
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002086 full_screen = TRUE; // we can use termcap codes from now on
2087 set_term_defaults(); // use current values as defaults
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088#ifdef FEAT_TERMRESPONSE
Bram Moolenaarb255b902018-04-24 21:40:10 +02002089 LOG_TR(("setting crv_status to STATUS_GET"));
Bram Moolenaarafd78262019-05-10 23:10:31 +02002090 crv_status.tr_progress = STATUS_GET; // Get terminal version later
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091#endif
2092
2093 /*
2094 * Initialize the terminal with the appropriate termcap codes.
2095 * Set the mouse and window title if possible.
2096 * Don't do this when starting, need to parse the .vimrc first, because it
2097 * may redefine t_TI etc.
2098 */
2099 if (starting != NO_SCREEN)
2100 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002101 starttermcap(); // may change terminal mode
2102 setmouse(); // may start using the mouse
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103#ifdef FEAT_TITLE
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002104 maketitle(); // may display window title
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105#endif
2106 }
2107
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002108 // display initial screen after ttest() checking. jw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 if (width <= 0 || height <= 0)
2110 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002111 // termcap failed to report size
2112 // set defaults, in case ui_get_shellsize() also fails
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113 width = 80;
Bram Moolenaar4f974752019-02-17 17:44:42 +01002114#if defined(MSWIN)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002115 height = 25; // console is often 25 lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116#else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002117 height = 24; // most terminals are 24 lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118#endif
2119 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002120 set_shellsize(width, height, FALSE); // may change Rows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 if (starting != NO_SCREEN)
2122 {
2123 if (scroll_region)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002124 scroll_region_reset(); // In case Rows changed
2125 check_map_keycodes(); // check mappings for terminal codes used
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 {
Bram Moolenaar0c81d1b2020-02-22 22:45:55 +01002128 buf_T *buf;
2129 aco_save_T aco;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130
2131 /*
2132 * Execute the TermChanged autocommands for each buffer that is
2133 * loaded.
2134 */
Bram Moolenaar0c81d1b2020-02-22 22:45:55 +01002135 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 {
2137 if (curbuf->b_ml.ml_mfp != NULL)
Bram Moolenaar0c81d1b2020-02-22 22:45:55 +01002138 {
2139 aucmd_prepbuf(&aco, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 apply_autocmds(EVENT_TERMCHANGED, NULL, NULL, FALSE,
2141 curbuf);
Bram Moolenaar0c81d1b2020-02-22 22:45:55 +01002142 // restore curwin/curbuf and a few other things
2143 aucmd_restbuf(&aco);
2144 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 }
2148
2149#ifdef FEAT_TERMRESPONSE
2150 may_req_termresponse();
2151#endif
2152
2153 return OK;
2154}
2155
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156#ifdef HAVE_TGETENT
2157/*
2158 * Call tgetent()
2159 * Return error message if it fails, NULL if it's OK.
2160 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002161 static char *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002162tgetent_error(char_u *tbuf, char_u *term)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163{
2164 int i;
2165
Bram Moolenaar6b649ac2019-12-07 17:47:22 +01002166 // Note: Valgrind may report a leak here, because the library keeps one
2167 // buffer around that we can't ever free.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 i = TGETENT(tbuf, term);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002169 if (i < 0 // -1 is always an error
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170# ifdef TGETENT_ZERO_ERR
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002171 || i == 0 // sometimes zero is also an error
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172# endif
2173 )
2174 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002175 // On FreeBSD tputs() gets a SEGV after a tgetent() which fails. Call
2176 // tgetent() with the always existing "dumb" entry to avoid a crash or
2177 // hang.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 (void)TGETENT(tbuf, "dumb");
2179
2180 if (i < 0)
2181# ifdef TGETENT_ZERO_ERR
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002182 return _("E557: Cannot open termcap file");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 if (i == 0)
2184# endif
2185#ifdef TERMINFO
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002186 return _("E558: Terminal entry not found in terminfo");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187#else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002188 return _("E559: Terminal entry not found in termcap");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189#endif
2190 }
2191 return NULL;
2192}
2193
2194/*
2195 * Some versions of tgetstr() have been reported to return -1 instead of NULL.
2196 * Fix that here.
2197 */
2198 static char_u *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002199vim_tgetstr(char *s, char_u **pp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200{
2201 char *p;
2202
2203 p = tgetstr(s, (char **)pp);
2204 if (p == (char *)-1)
2205 p = NULL;
2206 return (char_u *)p;
2207}
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002208#endif // HAVE_TGETENT
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002210#if defined(HAVE_TGETENT) && (defined(UNIX) || defined(VMS) || defined(MACOS_X))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211/*
2212 * Get Columns and Rows from the termcap. Used after a window signal if the
2213 * ioctl() fails. It doesn't make sense to call tgetent each time if the "co"
2214 * and "li" entries never change. But on some systems this works.
2215 * Errors while getting the entries are ignored.
2216 */
2217 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002218getlinecol(
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002219 long *cp, // pointer to columns
2220 long *rp) // pointer to rows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221{
2222 char_u tbuf[TBUFSZ];
2223
2224 if (T_NAME != NULL && *T_NAME != NUL && tgetent_error(tbuf, T_NAME) == NULL)
2225 {
2226 if (*cp == 0)
2227 *cp = tgetnum("co");
2228 if (*rp == 0)
2229 *rp = tgetnum("li");
2230 }
2231}
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002232#endif // defined(HAVE_TGETENT) && defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233
2234/*
2235 * Get a string entry from the termcap and add it to the list of termcodes.
2236 * Used for <t_xx> special keys.
2237 * Give an error message for failure when not sourcing.
2238 * If force given, replace an existing entry.
2239 * Return FAIL if the entry was not found, OK if the entry was added.
2240 */
2241 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002242add_termcap_entry(char_u *name, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243{
2244 char_u *term;
2245 int key;
2246 struct builtin_term *termp;
2247#ifdef HAVE_TGETENT
2248 char_u *string;
2249 int i;
2250 int builtin_first;
2251 char_u tbuf[TBUFSZ];
2252 char_u tstrbuf[TBUFSZ];
2253 char_u *tp = tstrbuf;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002254 char *error_msg = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255#endif
2256
2257/*
2258 * If the GUI is running or will start in a moment, we only support the keys
2259 * that the GUI can produce.
2260 */
2261#ifdef FEAT_GUI
2262 if (gui.in_use || gui.starting)
2263 return gui_mch_haskey(name);
2264#endif
2265
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002266 if (!force && find_termcode(name) != NULL) // it's already there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 return OK;
2268
2269 term = T_NAME;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002270 if (term == NULL || *term == NUL) // 'term' not defined yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 return FAIL;
2272
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002273 if (term_is_builtin(term)) // name starts with "builtin_"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002274 {
2275 term += 8;
2276#ifdef HAVE_TGETENT
2277 builtin_first = TRUE;
2278#endif
2279 }
2280#ifdef HAVE_TGETENT
2281 else
2282 builtin_first = p_tbi;
2283#endif
2284
2285#ifdef HAVE_TGETENT
2286/*
2287 * We can get the entry from the builtin termcap and from the external one.
2288 * If 'ttybuiltin' is on or the terminal name starts with "builtin_", try
2289 * builtin termcap first.
2290 * If 'ttybuiltin' is off, try external termcap first.
2291 */
2292 for (i = 0; i < 2; ++i)
2293 {
Bram Moolenaar98b30a42015-11-10 15:18:02 +01002294 if ((!builtin_first) == i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295#endif
2296 /*
2297 * Search in builtin termcap
2298 */
2299 {
2300 termp = find_builtin_term(term);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002301 if (termp->bt_string != NULL) // found it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 {
2303 key = TERMCAP2KEY(name[0], name[1]);
Bram Moolenaare7808482018-03-06 13:17:23 +01002304 ++termp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305 while (termp->bt_entry != (int)KS_NAME)
2306 {
2307 if ((int)termp->bt_entry == key)
2308 {
2309 add_termcode(name, (char_u *)termp->bt_string,
2310 term_is_8bit(term));
2311 return OK;
2312 }
2313 ++termp;
2314 }
2315 }
2316 }
2317#ifdef HAVE_TGETENT
2318 else
2319 /*
2320 * Search in external termcap
2321 */
2322 {
2323 error_msg = tgetent_error(tbuf, term);
2324 if (error_msg == NULL)
2325 {
2326 string = TGETSTR((char *)name, &tp);
2327 if (string != NULL && *string != NUL)
2328 {
2329 add_termcode(name, string, FALSE);
2330 return OK;
2331 }
2332 }
2333 }
2334 }
2335#endif
2336
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002337 if (SOURCING_NAME == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 {
2339#ifdef HAVE_TGETENT
2340 if (error_msg != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002341 emsg(error_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342 else
2343#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002344 semsg(_("E436: No \"%s\" entry in termcap"), name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 }
2346 return FAIL;
2347}
2348
2349 static int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002350term_is_builtin(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351{
2352 return (STRNCMP(name, "builtin_", (size_t)8) == 0);
2353}
2354
2355/*
2356 * Return TRUE if terminal "name" uses CSI instead of <Esc>[.
2357 * Assume that the terminal is using 8-bit controls when the name contains
2358 * "8bit", like in "xterm-8bit".
2359 */
2360 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002361term_is_8bit(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362{
2363 return (detected_8bit || strstr((char *)name, "8bit") != NULL);
2364}
2365
2366/*
2367 * Translate terminal control chars from 7-bit to 8-bit:
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02002368 * <Esc>[ -> CSI <M_C_[>
2369 * <Esc>] -> OSC <M-C-]>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 * <Esc>O -> <M-C-O>
2371 */
2372 static int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002373term_7to8bit(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374{
2375 if (*p == ESC)
2376 {
2377 if (p[1] == '[')
2378 return CSI;
2379 if (p[1] == ']')
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02002380 return OSC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381 if (p[1] == 'O')
2382 return 0x8f;
2383 }
2384 return 0;
2385}
2386
Bram Moolenaar1c17ffa2018-04-24 15:19:04 +02002387#if defined(FEAT_GUI) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002389term_is_gui(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390{
2391 return (STRCMP(name, "builtin_gui") == 0 || STRCMP(name, "gui") == 0);
2392}
2393#endif
2394
2395#if !defined(HAVE_TGETENT) || defined(AMIGA) || defined(PROTO)
2396
2397 char_u *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002398tltoa(unsigned long i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399{
2400 static char_u buf[16];
2401 char_u *p;
2402
2403 p = buf + 15;
2404 *p = '\0';
2405 do
2406 {
2407 --p;
2408 *p = (char_u) (i % 10 + '0');
2409 i /= 10;
2410 }
2411 while (i > 0 && p > buf);
2412 return p;
2413}
2414#endif
2415
2416#ifndef HAVE_TGETENT
2417
2418/*
2419 * minimal tgoto() implementation.
2420 * no padding and we only parse for %i %d and %+char
2421 */
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +00002422 static char *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002423tgoto(char *cm, int x, int y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424{
2425 static char buf[30];
2426 char *p, *s, *e;
2427
2428 if (!cm)
2429 return "OOPS";
2430 e = buf + 29;
2431 for (s = buf; s < e && *cm; cm++)
2432 {
2433 if (*cm != '%')
2434 {
2435 *s++ = *cm;
2436 continue;
2437 }
2438 switch (*++cm)
2439 {
2440 case 'd':
2441 p = (char *)tltoa((unsigned long)y);
2442 y = x;
2443 while (*p)
2444 *s++ = *p++;
2445 break;
2446 case 'i':
2447 x++;
2448 y++;
2449 break;
2450 case '+':
2451 *s++ = (char)(*++cm + y);
2452 y = x;
2453 break;
2454 case '%':
2455 *s++ = *cm;
2456 break;
2457 default:
2458 return "OOPS";
2459 }
2460 }
2461 *s = '\0';
2462 return buf;
2463}
2464
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002465#endif // HAVE_TGETENT
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466
2467/*
2468 * Set the terminal name and initialize the terminal options.
2469 * If "name" is NULL or empty, get the terminal name from the environment.
2470 * If that fails, use the default terminal name.
2471 */
2472 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002473termcapinit(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474{
2475 char_u *term;
2476
2477 if (name != NULL && *name == NUL)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002478 name = NULL; // empty name is equal to no name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 term = name;
2480
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481#ifndef MSWIN
2482 if (term == NULL)
2483 term = mch_getenv((char_u *)"TERM");
2484#endif
2485 if (term == NULL || *term == NUL)
2486 term = DEFAULT_TERM;
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00002487 set_string_option_direct((char_u *)"term", -1, term, OPT_FREE, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002489 // Set the default terminal name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490 set_string_default("term", term);
2491 set_string_default("ttytype", term);
2492
2493 /*
2494 * Avoid using "term" here, because the next mch_getenv() may overwrite it.
2495 */
2496 set_termname(T_NAME != NULL ? T_NAME : term);
2497}
2498
2499/*
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002500 * The number of calls to ui_write is reduced by using "out_buf".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 */
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002502#define OUT_SIZE 2047
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002503
2504// add one to allow mch_write() in os_win32.c to append a NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505static char_u out_buf[OUT_SIZE + 1];
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002506
2507static int out_pos = 0; // number of chars in out_buf
2508
2509// Since the maximum number of SGR parameters shown as a normal value range is
2510// 16, the escape sequence length can be 4 * 16 + lead + tail.
2511#define MAX_ESC_SEQ_LEN 80
Bram Moolenaar071d4272004-06-13 20:20:40 +00002512
2513/*
2514 * out_flush(): flush the output buffer
2515 */
2516 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002517out_flush(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518{
2519 int len;
2520
2521 if (out_pos != 0)
2522 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002523 // set out_pos to 0 before ui_write, to avoid recursiveness
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 len = out_pos;
2525 out_pos = 0;
2526 ui_write(out_buf, len);
2527 }
2528}
2529
Bram Moolenaara338adc2018-01-31 20:51:47 +01002530/*
Bram Moolenaard23a8232018-02-10 18:45:26 +01002531 * out_flush_cursor(): flush the output buffer and redraw the cursor.
2532 * Does not flush recursively in the GUI to avoid slow drawing.
Bram Moolenaara338adc2018-01-31 20:51:47 +01002533 */
2534 void
2535out_flush_cursor(
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002536 int force UNUSED, // when TRUE, update cursor even when not moved
2537 int clear_selection UNUSED) // clear selection under cursor
Bram Moolenaara338adc2018-01-31 20:51:47 +01002538{
2539 mch_disable_flush();
2540 out_flush();
2541 mch_enable_flush();
2542#ifdef FEAT_GUI
2543 if (gui.in_use)
2544 {
2545 gui_update_cursor(force, clear_selection);
2546 gui_may_flush();
2547 }
2548#endif
2549}
2550
2551
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552/*
2553 * Sometimes a byte out of a multi-byte character is written with out_char().
2554 * To avoid flushing half of the character, call this function first.
2555 */
2556 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002557out_flush_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558{
2559 if (enc_dbcs != 0 && out_pos >= OUT_SIZE - MB_MAXBYTES)
2560 out_flush();
2561}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562
2563#ifdef FEAT_GUI
2564/*
2565 * out_trash(): Throw away the contents of the output buffer
2566 */
2567 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002568out_trash(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569{
2570 out_pos = 0;
2571}
2572#endif
2573
2574/*
2575 * out_char(c): put a byte into the output buffer.
2576 * Flush it if it becomes full.
2577 * This should not be used for outputting text on the screen (use functions
2578 * like msg_puts() and screen_putchar() for that).
2579 */
2580 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002581out_char(unsigned c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582{
Bram Moolenaard0573012017-10-28 21:11:06 +02002583#if defined(UNIX) || defined(VMS) || defined(AMIGA) || defined(MACOS_X)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002584 if (c == '\n') // turn LF into CR-LF (CRMOD doesn't seem to do this)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 out_char('\r');
2586#endif
2587
2588 out_buf[out_pos++] = c;
2589
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002590 // For testing we flush each time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 if (out_pos >= OUT_SIZE || p_wd)
2592 out_flush();
2593}
2594
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595/*
Bram Moolenaarec6f7352019-10-24 17:49:27 +02002596 * Output "c" like out_char(), but don't flush when p_wd is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 */
2598 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002599out_char_nf(unsigned c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601 out_buf[out_pos++] = c;
2602
2603 if (out_pos >= OUT_SIZE)
2604 out_flush();
2605}
2606
2607/*
Bram Moolenaarec6f7352019-10-24 17:49:27 +02002608 * A never-padding out_str().
2609 * Use this whenever you don't want to run the string through tputs().
2610 * tputs() above is harmless, but tputs() from the termcap library
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 * is likely to strip off leading digits, that it mistakes for padding
2612 * information, and "%i", "%d", etc.
2613 * This should only be used for writing terminal codes, not for outputting
2614 * normal text (use functions like msg_puts() and screen_putchar() for that).
2615 */
2616 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002617out_str_nf(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618{
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002619 // avoid terminal strings being split up
2620 if (out_pos > OUT_SIZE - MAX_ESC_SEQ_LEN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 out_flush();
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002622
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 while (*s)
2624 out_char_nf(*s++);
2625
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002626 // For testing we write one string at a time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 if (p_wd)
2628 out_flush();
2629}
2630
2631/*
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002632 * A conditional-flushing out_str, mainly for visualbell.
2633 * Handles a delay internally, because termlib may not respect the delay or do
2634 * it at the wrong time.
2635 * Note: Only for terminal strings.
2636 */
2637 void
2638out_str_cf(char_u *s)
2639{
2640 if (s != NULL && *s)
2641 {
Bram Moolenaarc2226842017-06-29 22:27:24 +02002642#ifdef HAVE_TGETENT
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002643 char_u *p;
Bram Moolenaarc2226842017-06-29 22:27:24 +02002644#endif
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002645
2646#ifdef FEAT_GUI
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002647 // Don't use tputs() when GUI is used, ncurses crashes.
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002648 if (gui.in_use)
2649 {
2650 out_str_nf(s);
2651 return;
2652 }
2653#endif
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002654 if (out_pos > OUT_SIZE - MAX_ESC_SEQ_LEN)
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002655 out_flush();
2656#ifdef HAVE_TGETENT
2657 for (p = s; *s; ++s)
2658 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002659 // flush just before delay command
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002660 if (*s == '$' && *(s + 1) == '<')
2661 {
2662 char_u save_c = *s;
2663 int duration = atoi((char *)s + 2);
2664
2665 *s = NUL;
2666 tputs((char *)p, 1, TPUTSFUNCAST out_char_nf);
2667 *s = save_c;
2668 out_flush();
Bram Moolenaarc2226842017-06-29 22:27:24 +02002669# ifdef ELAPSED_FUNC
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002670 // Only sleep here if we can limit this happening in
2671 // vim_beep().
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002672 p = vim_strchr(s, '>');
2673 if (p == NULL || duration <= 0)
2674 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002675 // can't parse the time, don't sleep here
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002676 p = s;
2677 }
2678 else
2679 {
2680 ++p;
2681 do_sleep(duration);
2682 }
Bram Moolenaarc2226842017-06-29 22:27:24 +02002683# else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002684 // Rely on the terminal library to sleep.
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002685 p = s;
Bram Moolenaarc2226842017-06-29 22:27:24 +02002686# endif
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002687 break;
2688 }
2689 }
2690 tputs((char *)p, 1, TPUTSFUNCAST out_char_nf);
2691#else
2692 while (*s)
2693 out_char_nf(*s++);
2694#endif
2695
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002696 // For testing we write one string at a time.
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02002697 if (p_wd)
2698 out_flush();
2699 }
2700}
2701
2702/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 * out_str(s): Put a character string a byte at a time into the output buffer.
Bram Moolenaarec6f7352019-10-24 17:49:27 +02002704 * If HAVE_TGETENT is defined use tputs(), the termcap parser. (jw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 * This should only be used for writing terminal codes, not for outputting
2706 * normal text (use functions like msg_puts() and screen_putchar() for that).
2707 */
2708 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002709out_str(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710{
2711 if (s != NULL && *s)
2712 {
2713#ifdef FEAT_GUI
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002714 // Don't use tputs() when GUI is used, ncurses crashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 if (gui.in_use)
2716 {
2717 out_str_nf(s);
2718 return;
2719 }
2720#endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002721 // avoid terminal strings being split up
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002722 if (out_pos > OUT_SIZE - MAX_ESC_SEQ_LEN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 out_flush();
2724#ifdef HAVE_TGETENT
2725 tputs((char *)s, 1, TPUTSFUNCAST out_char_nf);
2726#else
2727 while (*s)
2728 out_char_nf(*s++);
2729#endif
2730
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002731 // For testing we write one string at a time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 if (p_wd)
2733 out_flush();
2734 }
2735}
2736
2737/*
2738 * cursor positioning using termcap parser. (jw)
2739 */
2740 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002741term_windgoto(int row, int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742{
2743 OUT_STR(tgoto((char *)T_CM, col, row));
2744}
2745
2746 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002747term_cursor_right(int i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748{
2749 OUT_STR(tgoto((char *)T_CRI, 0, i));
2750}
2751
2752 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002753term_append_lines(int line_count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754{
2755 OUT_STR(tgoto((char *)T_CAL, 0, line_count));
2756}
2757
2758 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002759term_delete_lines(int line_count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760{
2761 OUT_STR(tgoto((char *)T_CDL, 0, line_count));
2762}
2763
2764#if defined(HAVE_TGETENT) || defined(PROTO)
2765 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002766term_set_winpos(int x, int y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002768 // Can't handle a negative value here
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 if (x < 0)
2770 x = 0;
2771 if (y < 0)
2772 y = 0;
2773 OUT_STR(tgoto((char *)T_CWP, y, x));
2774}
2775
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002776# if defined(FEAT_TERMRESPONSE) || defined(PROTO)
2777/*
2778 * Return TRUE if we can request the terminal for a response.
2779 */
2780 static int
2781can_get_termresponse()
2782{
2783 return cur_tmode == TMODE_RAW
2784 && termcap_active
Bram Moolenaarafd78262019-05-10 23:10:31 +02002785# ifdef UNIX
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002786 && (is_not_a_term() || (isatty(1) && isatty(read_cmd_fd)))
Bram Moolenaarafd78262019-05-10 23:10:31 +02002787# endif
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002788 && p_ek;
2789}
2790
Bram Moolenaarafd78262019-05-10 23:10:31 +02002791/*
2792 * Set "status" to STATUS_SENT.
2793 */
2794 static void
2795termrequest_sent(termrequest_T *status)
2796{
2797 status->tr_progress = STATUS_SENT;
2798 status->tr_start = time(NULL);
2799}
2800
2801/*
2802 * Return TRUE if any of the requests are in STATUS_SENT.
2803 */
2804 static int
2805termrequest_any_pending()
2806{
2807 int i;
2808 time_t now = time(NULL);
2809
2810 for (i = 0; all_termrequests[i] != NULL; ++i)
2811 {
2812 if (all_termrequests[i]->tr_progress == STATUS_SENT)
2813 {
2814 if (all_termrequests[i]->tr_start > 0 && now > 0
2815 && all_termrequests[i]->tr_start + 2 < now)
2816 // Sent the request more than 2 seconds ago and didn't get a
2817 // response, assume it failed.
2818 all_termrequests[i]->tr_progress = STATUS_FAIL;
2819 else
2820 return TRUE;
2821 }
2822 }
2823 return FALSE;
2824}
2825
Bram Moolenaar89894aa2018-03-05 22:43:10 +01002826static int winpos_x = -1;
2827static int winpos_y = -1;
2828static int did_request_winpos = 0;
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002829
Bram Moolenaar6bc93052019-04-06 20:00:19 +02002830# if defined(FEAT_EVAL) || defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002831/*
2832 * Try getting the Vim window position from the terminal.
2833 * Returns OK or FAIL.
2834 */
2835 int
Bram Moolenaar3f54fd32018-03-03 21:29:55 +01002836term_get_winpos(int *x, int *y, varnumber_T timeout)
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002837{
2838 int count = 0;
Bram Moolenaar89894aa2018-03-05 22:43:10 +01002839 int prev_winpos_x = winpos_x;
2840 int prev_winpos_y = winpos_y;
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002841
2842 if (*T_CGP == NUL || !can_get_termresponse())
2843 return FAIL;
2844 winpos_x = -1;
2845 winpos_y = -1;
Bram Moolenaar89894aa2018-03-05 22:43:10 +01002846 ++did_request_winpos;
Bram Moolenaarafd78262019-05-10 23:10:31 +02002847 termrequest_sent(&winpos_status);
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002848 OUT_STR(T_CGP);
2849 out_flush();
2850
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002851 // Try reading the result for "timeout" msec.
Bram Moolenaar89894aa2018-03-05 22:43:10 +01002852 while (count++ <= timeout / 10 && !got_int)
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002853 {
2854 (void)vpeekc_nomap();
2855 if (winpos_x >= 0 && winpos_y >= 0)
2856 {
2857 *x = winpos_x;
2858 *y = winpos_y;
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002859 return OK;
2860 }
Bram Moolenaareda1da02019-11-17 17:06:33 +01002861 ui_delay(10L, FALSE);
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002862 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002863 // Do not reset "did_request_winpos", if we timed out the response might
2864 // still come later and we must consume it.
Bram Moolenaar89894aa2018-03-05 22:43:10 +01002865
2866 winpos_x = prev_winpos_x;
2867 winpos_y = prev_winpos_y;
Bram Moolenaar1c17ffa2018-04-24 15:19:04 +02002868 if (timeout < 10 && prev_winpos_y >= 0 && prev_winpos_x >= 0)
Bram Moolenaar89894aa2018-03-05 22:43:10 +01002869 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002870 // Polling: return previous values if we have them.
Bram Moolenaar89894aa2018-03-05 22:43:10 +01002871 *x = winpos_x;
2872 *y = winpos_y;
2873 return OK;
2874 }
2875
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002876 return FALSE;
2877}
Bram Moolenaar113e1072019-01-20 15:30:40 +01002878# endif
Bram Moolenaarba6ec182017-04-04 22:41:10 +02002879# endif
2880
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 void
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02002882term_set_winsize(int height, int width)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883{
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02002884 OUT_STR(tgoto((char *)T_CWS, width, height));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885}
2886#endif
2887
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002889term_color(char_u *s, int n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890{
2891 char buf[20];
Bram Moolenaarcafafb32018-02-22 21:07:09 +01002892 int i = *s == CSI ? 1 : 2;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002893 // index in s[] just after <Esc>[ or CSI
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002895 // Special handling of 16 colors, because termcap can't handle it
2896 // Also accept "\e[3%dm" for TERMINFO, it is sometimes used
2897 // Also accept CSI instead of <Esc>[
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 if (n >= 8 && t_colors >= 16
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02002899 && ((s[0] == ESC && s[1] == '[')
2900#if defined(FEAT_VTP) && defined(FEAT_TERMGUICOLORS)
2901 || (s[0] == ESC && s[1] == '|')
2902#endif
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02002903 || (s[0] == CSI && (i = 1) == 1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 && s[i] != NUL
2905 && (STRCMP(s + i + 1, "%p1%dm") == 0
2906 || STRCMP(s + i + 1, "%dm") == 0)
2907 && (s[i] == '3' || s[i] == '4'))
2908 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909#ifdef TERMINFO
Bram Moolenaar827b1652016-05-05 18:14:03 +02002910 char *format = "%s%s%%p1%%dm";
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911#else
Bram Moolenaar827b1652016-05-05 18:14:03 +02002912 char *format = "%s%s%%dm";
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913#endif
Bram Moolenaard315cf52018-05-23 20:30:56 +02002914 char *lead = i == 2 ? (
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02002915#if defined(FEAT_VTP) && defined(FEAT_TERMGUICOLORS)
Bram Moolenaard315cf52018-05-23 20:30:56 +02002916 s[1] == '|' ? IF_EB("\033|", ESC_STR "|") :
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02002917#endif
Bram Moolenaard315cf52018-05-23 20:30:56 +02002918 IF_EB("\033[", ESC_STR "[")) : "\233";
2919 char *tail = s[i] == '3' ? (n >= 16 ? "38;5;" : "9")
2920 : (n >= 16 ? "48;5;" : "10");
2921
2922 sprintf(buf, format, lead, tail);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 OUT_STR(tgoto(buf, 0, n >= 16 ? n : n - 8));
2924 }
2925 else
2926 OUT_STR(tgoto((char *)s, 0, n));
2927}
2928
Bram Moolenaarcafafb32018-02-22 21:07:09 +01002929 void
2930term_fg_color(int n)
2931{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002932 // Use "AF" termcap entry if present, "Sf" entry otherwise
Bram Moolenaarcafafb32018-02-22 21:07:09 +01002933 if (*T_CAF)
2934 term_color(T_CAF, n);
2935 else if (*T_CSF)
2936 term_color(T_CSF, n);
2937}
2938
2939 void
2940term_bg_color(int n)
2941{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002942 // Use "AB" termcap entry if present, "Sb" entry otherwise
Bram Moolenaarcafafb32018-02-22 21:07:09 +01002943 if (*T_CAB)
2944 term_color(T_CAB, n);
2945 else if (*T_CSB)
2946 term_color(T_CSB, n);
2947}
2948
Bram Moolenaare023e882020-05-31 16:42:30 +02002949 void
2950term_ul_color(int n)
2951{
2952 if (*T_CAU)
2953 term_color(T_CAU, n);
2954}
2955
Bram Moolenaar7bae0b12019-11-21 22:14:18 +01002956/*
2957 * Return "dark" or "light" depending on the kind of terminal.
2958 * This is just guessing! Recognized are:
2959 * "linux" Linux console
2960 * "screen.linux" Linux console with screen
2961 * "cygwin.*" Cygwin shell
2962 * "putty.*" Putty program
2963 * We also check the COLORFGBG environment variable, which is set by
2964 * rxvt and derivatives. This variable contains either two or three
2965 * values separated by semicolons; we want the last value in either
2966 * case. If this value is 0-6 or 8, our background is dark.
2967 */
2968 char_u *
2969term_bg_default(void)
2970{
2971#if defined(MSWIN)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002972 // DOS console is nearly always black
Bram Moolenaar7bae0b12019-11-21 22:14:18 +01002973 return (char_u *)"dark";
2974#else
2975 char_u *p;
2976
2977 if (STRCMP(T_NAME, "linux") == 0
2978 || STRCMP(T_NAME, "screen.linux") == 0
2979 || STRNCMP(T_NAME, "cygwin", 6) == 0
2980 || STRNCMP(T_NAME, "putty", 5) == 0
2981 || ((p = mch_getenv((char_u *)"COLORFGBG")) != NULL
2982 && (p = vim_strrchr(p, ';')) != NULL
2983 && ((p[1] >= '0' && p[1] <= '6') || p[1] == '8')
2984 && p[2] == NUL))
2985 return (char_u *)"dark";
2986 return (char_u *)"light";
2987#endif
2988}
2989
Bram Moolenaar61be73b2016-04-29 22:59:22 +02002990#if defined(FEAT_TERMGUICOLORS) || defined(PROTO)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02002991
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +02002992#define RED(rgb) (((long_u)(rgb) >> 16) & 0xFF)
2993#define GREEN(rgb) (((long_u)(rgb) >> 8) & 0xFF)
2994#define BLUE(rgb) (((long_u)(rgb) ) & 0xFF)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02002995
2996 static void
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +02002997term_rgb_color(char_u *s, guicolor_T rgb)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02002998{
Bram Moolenaar380130f2016-04-22 11:24:43 +02002999#define MAX_COLOR_STR_LEN 100
3000 char buf[MAX_COLOR_STR_LEN];
Bram Moolenaar8a633e32016-04-21 21:10:14 +02003001
Bram Moolenaara1c487e2016-04-22 20:20:19 +02003002 vim_snprintf(buf, MAX_COLOR_STR_LEN,
Bram Moolenaar380130f2016-04-22 11:24:43 +02003003 (char *)s, RED(rgb), GREEN(rgb), BLUE(rgb));
Bram Moolenaar06b7b582020-05-30 17:49:25 +02003004#ifdef FEAT_VTP
3005 if (use_wt())
3006 {
3007 out_flush();
3008 buf[1] = '[';
3009 vtp_printf(buf);
3010 }
3011 else
3012#endif
3013 OUT_STR(buf);
Bram Moolenaar8a633e32016-04-21 21:10:14 +02003014}
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +02003015
3016 void
3017term_fg_rgb_color(guicolor_T rgb)
3018{
3019 term_rgb_color(T_8F, rgb);
3020}
3021
3022 void
3023term_bg_rgb_color(guicolor_T rgb)
3024{
3025 term_rgb_color(T_8B, rgb);
3026}
Bram Moolenaare023e882020-05-31 16:42:30 +02003027
3028 void
3029term_ul_rgb_color(guicolor_T rgb)
3030{
3031 term_rgb_color(T_8U, rgb);
3032}
Bram Moolenaar8a633e32016-04-21 21:10:14 +02003033#endif
3034
Bram Moolenaare7fedb62015-12-31 19:07:19 +01003035#if (defined(FEAT_TITLE) && (defined(UNIX) || defined(VMS) \
3036 || defined(MACOS_X))) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037/*
3038 * Generic function to set window title, using t_ts and t_fs.
3039 */
3040 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003041term_settitle(char_u *title)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042{
Bram Moolenaarec6f7352019-10-24 17:49:27 +02003043 // t_ts takes one argument: column in status line
3044 OUT_STR(tgoto((char *)T_TS, 0, 0)); // set title start
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 out_str_nf(title);
Bram Moolenaarec6f7352019-10-24 17:49:27 +02003046 out_str(T_FS); // set title end
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 out_flush();
3048}
Bram Moolenaar40385db2018-08-07 22:31:44 +02003049
3050/*
3051 * Tell the terminal to push (save) the title and/or icon, so that it can be
3052 * popped (restored) later.
3053 */
3054 void
3055term_push_title(int which)
3056{
Bram Moolenaar27821262019-05-08 16:41:09 +02003057 if ((which & SAVE_RESTORE_TITLE) && T_CST != NULL && *T_CST != NUL)
Bram Moolenaar40385db2018-08-07 22:31:44 +02003058 {
3059 OUT_STR(T_CST);
3060 out_flush();
3061 }
3062
Bram Moolenaar27821262019-05-08 16:41:09 +02003063 if ((which & SAVE_RESTORE_ICON) && T_SSI != NULL && *T_SSI != NUL)
Bram Moolenaar40385db2018-08-07 22:31:44 +02003064 {
3065 OUT_STR(T_SSI);
3066 out_flush();
3067 }
3068}
3069
3070/*
3071 * Tell the terminal to pop the title and/or icon.
3072 */
3073 void
3074term_pop_title(int which)
3075{
Bram Moolenaar27821262019-05-08 16:41:09 +02003076 if ((which & SAVE_RESTORE_TITLE) && T_CRT != NULL && *T_CRT != NUL)
Bram Moolenaar40385db2018-08-07 22:31:44 +02003077 {
3078 OUT_STR(T_CRT);
3079 out_flush();
3080 }
3081
Bram Moolenaar27821262019-05-08 16:41:09 +02003082 if ((which & SAVE_RESTORE_ICON) && T_SRI != NULL && *T_SRI != NUL)
Bram Moolenaar40385db2018-08-07 22:31:44 +02003083 {
3084 OUT_STR(T_SRI);
3085 out_flush();
3086 }
3087}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088#endif
3089
3090/*
3091 * Make sure we have a valid set or terminal options.
3092 * Replace all entries that are NULL by empty_option
3093 */
3094 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003095ttest(int pairs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096{
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02003097 char_u *env_colors;
3098
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003099 check_options(); // make sure no options are NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100
3101 /*
3102 * MUST have "cm": cursor motion.
3103 */
3104 if (*T_CM == NUL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003105 emsg(_("E437: terminal capability \"cm\" required"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106
3107 /*
3108 * if "cs" defined, use a scroll region, it's faster.
3109 */
3110 if (*T_CS != NUL)
3111 scroll_region = TRUE;
3112 else
3113 scroll_region = FALSE;
3114
3115 if (pairs)
3116 {
3117 /*
3118 * optional pairs
3119 */
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003120 // TP goes to normal mode for TI (invert) and TB (bold)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 if (*T_ME == NUL)
3122 T_ME = T_MR = T_MD = T_MB = empty_option;
3123 if (*T_SO == NUL || *T_SE == NUL)
3124 T_SO = T_SE = empty_option;
3125 if (*T_US == NUL || *T_UE == NUL)
3126 T_US = T_UE = empty_option;
3127 if (*T_CZH == NUL || *T_CZR == NUL)
3128 T_CZH = T_CZR = empty_option;
3129
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003130 // T_VE is needed even though T_VI is not defined
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 if (*T_VE == NUL)
3132 T_VI = empty_option;
3133
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003134 // if 'mr' or 'me' is not defined use 'so' and 'se'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 if (*T_ME == NUL)
3136 {
3137 T_ME = T_SE;
3138 T_MR = T_SO;
3139 T_MD = T_SO;
3140 }
3141
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003142 // if 'so' or 'se' is not defined use 'mr' and 'me'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 if (*T_SO == NUL)
3144 {
3145 T_SE = T_ME;
3146 if (*T_MR == NUL)
3147 T_SO = T_MD;
3148 else
3149 T_SO = T_MR;
3150 }
3151
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003152 // if 'ZH' or 'ZR' is not defined use 'mr' and 'me'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 if (*T_CZH == NUL)
3154 {
3155 T_CZR = T_ME;
3156 if (*T_MR == NUL)
3157 T_CZH = T_MD;
3158 else
3159 T_CZH = T_MR;
3160 }
3161
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003162 // "Sb" and "Sf" come in pairs
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 if (*T_CSB == NUL || *T_CSF == NUL)
3164 {
3165 T_CSB = empty_option;
3166 T_CSF = empty_option;
3167 }
3168
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003169 // "AB" and "AF" come in pairs
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 if (*T_CAB == NUL || *T_CAF == NUL)
3171 {
3172 T_CAB = empty_option;
3173 T_CAF = empty_option;
3174 }
3175
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003176 // if 'Sb' and 'AB' are not defined, reset "Co"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 if (*T_CSB == NUL && *T_CAB == NUL)
Bram Moolenaar363cb672009-07-22 12:28:17 +00003178 free_one_termoption(T_CCO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003180 // Set 'weirdinvert' according to value of 't_xs'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 p_wiv = (*T_XS != NUL);
3182 }
3183 need_gather = TRUE;
3184
Bram Moolenaar759d8152020-04-26 16:52:49 +02003185 // Set t_colors to the value of $COLORS or t_Co. Ignore $COLORS in the
3186 // GUI.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 t_colors = atoi((char *)T_CCO);
Bram Moolenaar759d8152020-04-26 16:52:49 +02003188#ifdef FEAT_GUI
3189 if (!gui.in_use)
3190#endif
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02003191 {
Bram Moolenaar759d8152020-04-26 16:52:49 +02003192 env_colors = mch_getenv((char_u *)"COLORS");
3193 if (env_colors != NULL && isdigit(*env_colors))
3194 {
3195 int colors = atoi((char *)env_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02003196
Bram Moolenaar759d8152020-04-26 16:52:49 +02003197 if (colors != t_colors)
3198 set_color_count(colors);
3199 }
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02003200 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201}
3202
3203#if (defined(FEAT_GUI) && (defined(FEAT_MENU) || !defined(USE_ON_FLY_SCROLL))) \
3204 || defined(PROTO)
3205/*
3206 * Represent the given long_u as individual bytes, with the most significant
3207 * byte first, and store them in dst.
3208 */
3209 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003210add_long_to_buf(long_u val, char_u *dst)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211{
3212 int i;
3213 int shift;
3214
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003215 for (i = 1; i <= (int)sizeof(long_u); i++)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 {
3217 shift = 8 * (sizeof(long_u) - i);
3218 dst[i - 1] = (char_u) ((val >> shift) & 0xff);
3219 }
3220}
3221
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222/*
3223 * Interpret the next string of bytes in buf as a long integer, with the most
3224 * significant byte first. Note that it is assumed that buf has been through
3225 * inchar(), so that NUL and K_SPECIAL will be represented as three bytes each.
3226 * Puts result in val, and returns the number of bytes read from buf
3227 * (between sizeof(long_u) and 2 * sizeof(long_u)), or -1 if not enough bytes
3228 * were present.
3229 */
3230 static int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003231get_long_from_buf(char_u *buf, long_u *val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232{
3233 int len;
3234 char_u bytes[sizeof(long_u)];
3235 int i;
3236 int shift;
3237
3238 *val = 0;
3239 len = get_bytes_from_buf(buf, bytes, (int)sizeof(long_u));
3240 if (len != -1)
3241 {
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003242 for (i = 0; i < (int)sizeof(long_u); i++)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 {
3244 shift = 8 * (sizeof(long_u) - 1 - i);
3245 *val += (long_u)bytes[i] << shift;
3246 }
3247 }
3248 return len;
3249}
3250#endif
3251
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252/*
3253 * Read the next num_bytes bytes from buf, and store them in bytes. Assume
3254 * that buf has been through inchar(). Returns the actual number of bytes used
3255 * from buf (between num_bytes and num_bytes*2), or -1 if not enough bytes were
3256 * available.
3257 */
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02003258 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003259get_bytes_from_buf(char_u *buf, char_u *bytes, int num_bytes)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260{
3261 int len = 0;
3262 int i;
3263 char_u c;
3264
3265 for (i = 0; i < num_bytes; i++)
3266 {
3267 if ((c = buf[len++]) == NUL)
3268 return -1;
3269 if (c == K_SPECIAL)
3270 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003271 if (buf[len] == NUL || buf[len + 1] == NUL) // cannot happen?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 return -1;
3273 if (buf[len++] == (int)KS_ZERO)
3274 c = NUL;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003275 // else it should be KS_SPECIAL; when followed by KE_FILLER c is
3276 // K_SPECIAL, or followed by KE_CSI and c must be CSI.
Bram Moolenaar0e710d62013-07-01 20:06:19 +02003277 if (buf[len++] == (int)KE_CSI)
3278 c = CSI;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 }
Bram Moolenaar8d1ab512007-05-06 13:49:21 +00003280 else if (c == CSI && buf[len] == KS_EXTRA
3281 && buf[len + 1] == (int)KE_CSI)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003282 // CSI is stored as CSI KS_SPECIAL KE_CSI to avoid confusion with
3283 // the start of a special key, see add_to_input_buf_csi().
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003284 len += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 bytes[i] = c;
3286 }
3287 return len;
3288}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289
3290/*
Bram Moolenaare057d402013-06-30 17:51:51 +02003291 * Check if the new shell size is valid, correct it if it's too small or way
3292 * too big.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 */
3294 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003295check_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003297 if (Rows < min_rows()) // need room for one window and command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 Rows = min_rows();
Bram Moolenaare057d402013-06-30 17:51:51 +02003299 limit_screen_size();
3300}
3301
3302/*
3303 * Limit Rows and Columns to avoid an overflow in Rows * Columns.
3304 */
3305 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003306limit_screen_size(void)
Bram Moolenaare057d402013-06-30 17:51:51 +02003307{
3308 if (Columns < MIN_COLUMNS)
3309 Columns = MIN_COLUMNS;
3310 else if (Columns > 10000)
3311 Columns = 10000;
3312 if (Rows > 1000)
3313 Rows = 1000;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314}
3315
Bram Moolenaar86b68352004-12-27 21:59:20 +00003316/*
3317 * Invoked just before the screen structures are going to be (re)allocated.
3318 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003320win_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321{
3322 static int old_Rows = 0;
3323 static int old_Columns = 0;
3324
3325 if (old_Rows != Rows || old_Columns != Columns)
3326 ui_new_shellsize();
3327 if (old_Rows != Rows)
3328 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003329 // if 'window' uses the whole screen, keep it using that
Bram Moolenaar19a09a12005-03-04 23:39:37 +00003330 if (p_window == old_Rows - 1 || old_Rows == 0)
Bram Moolenaar4399ef42005-02-12 14:29:27 +00003331 p_window = Rows - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 old_Rows = Rows;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003333 shell_new_rows(); // update window sizes
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 }
3335 if (old_Columns != Columns)
3336 {
3337 old_Columns = Columns;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003338 shell_new_columns(); // update window sizes
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 }
3340}
3341
3342/*
3343 * Call this function when the Vim shell has been resized in any way.
3344 * Will obtain the current size and redraw (also when size didn't change).
3345 */
3346 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003347shell_resized(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348{
3349 set_shellsize(0, 0, FALSE);
3350}
3351
3352/*
3353 * Check if the shell size changed. Handle a resize.
3354 * When the size didn't change, nothing happens.
3355 */
3356 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003357shell_resized_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358{
3359 int old_Rows = Rows;
3360 int old_Columns = Columns;
3361
Bram Moolenaar3633dc02012-08-29 16:26:04 +02003362 if (!exiting
3363#ifdef FEAT_GUI
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003364 // Do not get the size when executing a shell command during
3365 // startup.
Bram Moolenaar3633dc02012-08-29 16:26:04 +02003366 && !gui.starting
3367#endif
3368 )
Bram Moolenaar99808352010-12-30 14:47:36 +01003369 {
3370 (void)ui_get_shellsize();
3371 check_shellsize();
3372 if (old_Rows != Rows || old_Columns != Columns)
3373 shell_resized();
3374 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375}
3376
3377/*
3378 * Set size of the Vim shell.
3379 * If 'mustset' is TRUE, we must set Rows and Columns, do not get the real
3380 * window size (this is used for the :win command).
3381 * If 'mustset' is FALSE, we may try to get the real window size and if
3382 * it fails use 'width' and 'height'.
3383 */
3384 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003385set_shellsize(int width, int height, int mustset)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386{
3387 static int busy = FALSE;
3388
3389 /*
3390 * Avoid recursiveness, can happen when setting the window size causes
3391 * another window-changed signal.
3392 */
3393 if (busy)
3394 return;
3395
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003396 if (width < 0 || height < 0) // just checking...
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 return;
3398
Bram Moolenaara971b822011-09-14 14:43:25 +02003399 if (State == HITRETURN || State == SETWSIZE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 {
Bram Moolenaar847a5d62019-07-12 15:37:13 +02003401 // postpone the resizing
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 State = SETWSIZE;
3403 return;
3404 }
3405
Bram Moolenaar847a5d62019-07-12 15:37:13 +02003406 if (updating_screen)
3407 // resizing while in update_screen() may cause a crash
3408 return;
3409
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003410 // curwin->w_buffer can be NULL when we are closing a window and the
3411 // buffer has already been closed and removing a scrollbar causes a resize
3412 // event. Don't resize then, it will happen after entering another buffer.
Bram Moolenaara971b822011-09-14 14:43:25 +02003413 if (curwin->w_buffer == NULL)
3414 return;
3415
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 ++busy;
3417
3418#ifdef AMIGA
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003419 out_flush(); // must do this before mch_get_shellsize() for
3420 // some obscure reason
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421#endif
3422
3423 if (mustset || (ui_get_shellsize() == FAIL && height != 0))
3424 {
3425 Rows = height;
3426 Columns = width;
3427 check_shellsize();
3428 ui_set_shellsize(mustset);
3429 }
3430 else
3431 check_shellsize();
3432
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003433 // The window layout used to be adjusted here, but it now happens in
3434 // screenalloc() (also invoked from screenclear()). That is because the
3435 // "busy" check above may skip this, but not screenalloc().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436
3437 if (State != ASKMORE && State != EXTERNCMD && State != CONFIRM)
3438 screenclear();
3439 else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003440 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441
3442 if (starting != NO_SCREEN)
3443 {
3444#ifdef FEAT_TITLE
3445 maketitle();
3446#endif
3447 changed_line_abv_curs();
3448 invalidate_botline();
3449
3450 /*
3451 * We only redraw when it's needed:
3452 * - While at the more prompt or executing an external command, don't
3453 * redraw, but position the cursor.
3454 * - While editing the command line, only redraw that.
3455 * - in Ex mode, don't redraw anything.
3456 * - Otherwise, redraw right now, and position the cursor.
3457 * Always need to call update_screen() or screenalloc(), to make
3458 * sure Rows/Columns and the size of ScreenLines[] is correct!
3459 */
3460 if (State == ASKMORE || State == EXTERNCMD || State == CONFIRM
3461 || exmode_active)
3462 {
3463 screenalloc(FALSE);
3464 repeat_message();
3465 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 else
3467 {
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003468 if (curwin->w_p_scb)
3469 do_check_scrollbind(TRUE);
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003470 if (State & CMDLINE)
Bram Moolenaar280f1262006-01-30 00:14:18 +00003471 {
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003472 update_screen(NOT_VALID);
3473 redrawcmdline();
Bram Moolenaar280f1262006-01-30 00:14:18 +00003474 }
3475 else
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003476 {
3477 update_topline();
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003478 if (pum_visible())
3479 {
3480 redraw_later(NOT_VALID);
Bram Moolenaara5e66212017-09-29 22:42:33 +02003481 ins_compl_show_pum();
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003482 }
Bram Moolenaara5e66212017-09-29 22:42:33 +02003483 update_screen(NOT_VALID);
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003484 if (redrawing())
3485 setcursor();
3486 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003488 cursor_on(); // redrawing may have switched it off
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 }
3490 out_flush();
3491 --busy;
3492}
3493
3494/*
3495 * Set the terminal to TMODE_RAW (for Normal mode) or TMODE_COOK (for external
3496 * commands and Ex mode).
3497 */
3498 void
Bram Moolenaarf4e16ae2020-05-17 16:10:11 +02003499settmode(tmode_T tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500{
3501#ifdef FEAT_GUI
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003502 // don't set the term where gvim was started to any mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 if (gui.in_use)
3504 return;
3505#endif
3506
3507 if (full_screen)
3508 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 /*
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02003510 * When returning after calling a shell cur_tmode is TMODE_UNKNOWN,
3511 * set the terminal to raw mode, even though we think it already is,
3512 * because the shell program may have reset the terminal mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 * When we think the terminal is normal, don't try to set it to
3514 * normal again, because that causes problems (logout!) on some
3515 * machines.
3516 */
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02003517 if (tmode != cur_tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 {
3519#ifdef FEAT_TERMRESPONSE
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003520# ifdef FEAT_GUI
3521 if (!gui.in_use && !gui.starting)
3522# endif
3523 {
Bram Moolenaarafd78262019-05-10 23:10:31 +02003524 // May need to check for T_CRV response and termcodes, it
3525 // doesn't work in Cooked mode, an external program may get
3526 // them.
3527 if (tmode != TMODE_RAW && termrequest_any_pending())
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003528 (void)vpeekc_nomap();
3529 check_for_codes_from_term();
3530 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 if (tmode != TMODE_RAW)
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003533 mch_setmouse(FALSE); // switch mouse off
Bram Moolenaar26e86442020-05-17 14:06:16 +02003534
3535 // Disable bracketed paste and modifyOtherKeys in cooked mode.
3536 // Avoid doing this too often, on some terminals the codes are not
3537 // handled properly.
3538 if (termcap_active && tmode != TMODE_SLEEP
3539 && cur_tmode != TMODE_SLEEP)
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003540 {
3541 if (tmode != TMODE_RAW)
Bram Moolenaar645e3fe2020-05-16 15:05:04 +02003542 {
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003543 out_str(T_BD); // disable bracketed paste mode
Bram Moolenaar645e3fe2020-05-16 15:05:04 +02003544 out_str(T_CTE); // possibly disables modifyOtherKeys
3545 }
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003546 else
Bram Moolenaar645e3fe2020-05-16 15:05:04 +02003547 {
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003548 out_str(T_BE); // enable bracketed paste mode (should
3549 // be before mch_settmode().
Bram Moolenaar645e3fe2020-05-16 15:05:04 +02003550 out_str(T_CTI); // possibly enables modifyOtherKeys
3551 }
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003552 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 out_flush();
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003554 mch_settmode(tmode); // machine specific function
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 cur_tmode = tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 if (tmode == TMODE_RAW)
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003557 setmouse(); // may switch mouse on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 out_flush();
3559 }
3560#ifdef FEAT_TERMRESPONSE
3561 may_req_termresponse();
3562#endif
3563 }
3564}
3565
3566 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003567starttermcap(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568{
3569 if (full_screen && !termcap_active)
3570 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003571 out_str(T_TI); // start termcap mode
3572 out_str(T_CTI); // start "raw" mode
3573 out_str(T_KS); // start "keypad transmit" mode
3574 out_str(T_BE); // enable bracketed paste mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 out_flush();
3576 termcap_active = TRUE;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003577 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578#ifdef FEAT_TERMRESPONSE
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003579# ifdef FEAT_GUI
3580 if (!gui.in_use && !gui.starting)
3581# endif
3582 {
3583 may_req_termresponse();
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003584 // Immediately check for a response. If t_Co changes, we don't
3585 // want to redraw with wrong colors first.
Bram Moolenaarafd78262019-05-10 23:10:31 +02003586 if (crv_status.tr_progress == STATUS_SENT)
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003587 check_for_codes_from_term();
3588 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589#endif
3590 }
3591}
3592
3593 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003594stoptermcap(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595{
3596 screen_stop_highlight();
3597 reset_cterm_colors();
3598 if (termcap_active)
3599 {
3600#ifdef FEAT_TERMRESPONSE
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003601# ifdef FEAT_GUI
3602 if (!gui.in_use && !gui.starting)
3603# endif
3604 {
Bram Moolenaarafd78262019-05-10 23:10:31 +02003605 // May need to discard T_CRV, T_U7 or T_RBG response.
3606 if (termrequest_any_pending())
Bram Moolenaar29607ac2013-05-13 20:26:53 +02003607 {
3608# ifdef UNIX
Bram Moolenaarafd78262019-05-10 23:10:31 +02003609 // Give the terminal a chance to respond.
Bram Moolenaar29607ac2013-05-13 20:26:53 +02003610 mch_delay(100L, FALSE);
3611# endif
3612# ifdef TCIFLUSH
Bram Moolenaarafd78262019-05-10 23:10:31 +02003613 // Discard data received but not read.
Bram Moolenaar29607ac2013-05-13 20:26:53 +02003614 if (exiting)
3615 tcflush(fileno(stdin), TCIFLUSH);
3616# endif
3617 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003618 // Check for termcodes first, otherwise an external program may
3619 // get them.
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003620 check_for_codes_from_term();
3621 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622#endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003623 out_str(T_BD); // disable bracketed paste mode
3624 out_str(T_KE); // stop "keypad transmit" mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 out_flush();
3626 termcap_active = FALSE;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003627 cursor_on(); // just in case it is still off
3628 out_str(T_CTE); // stop "raw" mode
3629 out_str(T_TE); // stop termcap mode
3630 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 out_flush();
3632 }
3633}
3634
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003635#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636/*
3637 * Request version string (for xterm) when needed.
3638 * Only do this after switching to raw mode, otherwise the result will be
3639 * echoed.
Bram Moolenaara40ceaf2006-01-13 22:35:40 +00003640 * Only do this after startup has finished, to avoid that the response comes
Bram Moolenaarcf0dfa22007-05-10 18:52:16 +00003641 * while executing "-c !cmd" or even after "-c quit".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 * Only do this after termcap mode has been started, otherwise the codes for
3643 * the cursor keys may be wrong.
Bram Moolenaarebefac62005-12-28 22:39:57 +00003644 * Only do this when 'esckeys' is on, otherwise the response causes trouble in
3645 * Insert mode.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00003646 * On Unix only do it when both output and input are a tty (avoid writing
3647 * request to terminal while reading from a file).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 * The result is caught in check_termcode().
3649 */
Bram Moolenaara40ceaf2006-01-13 22:35:40 +00003650 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003651may_req_termresponse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652{
Bram Moolenaarafd78262019-05-10 23:10:31 +02003653 if (crv_status.tr_progress == STATUS_GET
Bram Moolenaarba6ec182017-04-04 22:41:10 +02003654 && can_get_termresponse()
Bram Moolenaara40ceaf2006-01-13 22:35:40 +00003655 && starting == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 && *T_CRV != NUL)
3657 {
Bram Moolenaarb255b902018-04-24 21:40:10 +02003658 LOG_TR(("Sending CRV request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 out_str(T_CRV);
Bram Moolenaarafd78262019-05-10 23:10:31 +02003660 termrequest_sent(&crv_status);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003661 // check for the characters now, otherwise they might be eaten by
3662 // get_keystroke()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 out_flush();
3664 (void)vpeekc_nomap();
3665 }
3666}
Bram Moolenaar9584b312013-03-13 19:29:28 +01003667
Bram Moolenaar9584b312013-03-13 19:29:28 +01003668/*
Bram Moolenaara45551a2020-06-09 15:57:37 +02003669 * Send sequences to the terminal and check with t_u7 how the cursor moves, to
3670 * find out properties of the terminal.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02003671 * Note that this goes out before T_CRV, so that the result can be used when
3672 * the termresponse arrives.
Bram Moolenaar9584b312013-03-13 19:29:28 +01003673 */
3674 void
Bram Moolenaara45551a2020-06-09 15:57:37 +02003675check_terminal_behavior(void)
Bram Moolenaar9584b312013-03-13 19:29:28 +01003676{
Bram Moolenaara45551a2020-06-09 15:57:37 +02003677 int did_send = FALSE;
3678
Bram Moolenaar517f00f2020-06-10 12:15:51 +02003679 init_term_props(TRUE);
3680
Bram Moolenaara45551a2020-06-09 15:57:37 +02003681 if (!can_get_termresponse() || starting != 0 || *T_U7 == NUL)
3682 return;
3683
Bram Moolenaarafd78262019-05-10 23:10:31 +02003684 if (u7_status.tr_progress == STATUS_GET
Bram Moolenaar9584b312013-03-13 19:29:28 +01003685 && !option_was_set((char_u *)"ambiwidth"))
3686 {
Bram Moolenaarafd78262019-05-10 23:10:31 +02003687 char_u buf[16];
Bram Moolenaar9584b312013-03-13 19:29:28 +01003688
Bram Moolenaara45551a2020-06-09 15:57:37 +02003689 // Ambiguous width check.
3690 // Check how the terminal treats ambiguous character width (UAX #11).
3691 // First, we move the cursor to (1, 0) and print a test ambiguous
3692 // character \u25bd (WHITE DOWN-POINTING TRIANGLE) and then query
3693 // the current cursor position. If the terminal treats \u25bd as
3694 // single width, the position is (1, 1), or if it is treated as double
3695 // width, that will be (1, 2). This function has the side effect that
3696 // changes cursor position, so it must be called immediately after
3697 // entering termcap mode.
3698 LOG_TR(("Sending request for ambiwidth check"));
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003699 // Do this in the second row. In the first row the returned sequence
3700 // may be CSI 1;2R, which is the same as <S-F3>.
Bram Moolenaarafd78262019-05-10 23:10:31 +02003701 term_windgoto(1, 0);
Bram Moolenaara45551a2020-06-09 15:57:37 +02003702 buf[mb_char2bytes(0x25bd, buf)] = NUL;
Bram Moolenaarafd78262019-05-10 23:10:31 +02003703 out_str(buf);
3704 out_str(T_U7);
3705 termrequest_sent(&u7_status);
3706 out_flush();
Bram Moolenaara45551a2020-06-09 15:57:37 +02003707 did_send = TRUE;
Bram Moolenaar976787d2017-06-04 15:45:50 +02003708
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003709 // This overwrites a few characters on the screen, a redraw is needed
3710 // after this. Clear them out for now.
Bram Moolenaar06029a82019-07-24 14:25:26 +02003711 screen_stop_highlight();
Bram Moolenaarafd78262019-05-10 23:10:31 +02003712 term_windgoto(1, 0);
3713 out_str((char_u *)" ");
Bram Moolenaara45551a2020-06-09 15:57:37 +02003714 }
3715
3716 if (xcc_status.tr_progress == STATUS_GET)
3717 {
3718 // 2. Check compatibility with xterm.
3719 // We move the cursor to (2, 0), print a test sequence and then query
3720 // the current cursor position. If the terminal properly handles
3721 // unknown DCS string and CSI sequence with intermediate byte, the test
3722 // sequence is ignored and the cursor does not move. If the terminal
3723 // handles test sequence incorrectly, a garbage string is displayed and
3724 // the cursor does move.
3725 LOG_TR(("Sending xterm compatibility test sequence."));
3726 // Do this in the third row. Second row is used by ambiguous
3727 // chararacter width check.
3728 term_windgoto(2, 0);
3729 // send the test DCS string.
3730 out_str((char_u *)"\033Pzz\033\\");
3731 // send the test CSI sequence with intermediate byte.
3732 out_str((char_u *)"\033[0%m");
3733 out_str(T_U7);
3734 termrequest_sent(&xcc_status);
3735 out_flush();
3736 did_send = TRUE;
3737
3738 // If the terminal handles test sequence incorrectly, garbage text is
3739 // displayed. Clear them out for now.
3740 screen_stop_highlight();
3741 term_windgoto(2, 0);
3742 out_str((char_u *)" ");
3743 }
3744
3745 if (did_send)
3746 {
Bram Moolenaarafd78262019-05-10 23:10:31 +02003747 term_windgoto(0, 0);
Bram Moolenaar976787d2017-06-04 15:45:50 +02003748
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003749 // Need to reset the known cursor position.
Bram Moolenaarafd78262019-05-10 23:10:31 +02003750 screen_start();
Bram Moolenaar05684312017-12-09 15:11:24 +01003751
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003752 // check for the characters now, otherwise they might be eaten by
3753 // get_keystroke()
Bram Moolenaarafd78262019-05-10 23:10:31 +02003754 out_flush();
3755 (void)vpeekc_nomap();
Bram Moolenaar9584b312013-03-13 19:29:28 +01003756 }
3757}
Bram Moolenaar2951b772013-07-03 12:45:31 +02003758
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003759/*
Bram Moolenaar4921c242015-06-27 18:34:24 +02003760 * Similar to requesting the version string: Request the terminal background
3761 * color when it is the right moment.
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003762 */
3763 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003764may_req_bg_color(void)
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003765{
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003766 if (can_get_termresponse() && starting == 0)
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003767 {
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003768 int didit = FALSE;
3769
Bram Moolenaar00ce63d2017-10-15 21:44:45 +02003770# ifdef FEAT_TERMINAL
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003771 // Only request foreground if t_RF is set.
Bram Moolenaarafd78262019-05-10 23:10:31 +02003772 if (rfg_status.tr_progress == STATUS_GET && *T_RFG != NUL)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003773 {
Bram Moolenaarb255b902018-04-24 21:40:10 +02003774 LOG_TR(("Sending FG request"));
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003775 out_str(T_RFG);
Bram Moolenaarafd78262019-05-10 23:10:31 +02003776 termrequest_sent(&rfg_status);
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003777 didit = TRUE;
3778 }
Bram Moolenaar00ce63d2017-10-15 21:44:45 +02003779# endif
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003780
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003781 // Only request background if t_RB is set.
Bram Moolenaarafd78262019-05-10 23:10:31 +02003782 if (rbg_status.tr_progress == STATUS_GET && *T_RBG != NUL)
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003783 {
Bram Moolenaarb255b902018-04-24 21:40:10 +02003784 LOG_TR(("Sending BG request"));
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003785 out_str(T_RBG);
Bram Moolenaarafd78262019-05-10 23:10:31 +02003786 termrequest_sent(&rbg_status);
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003787 didit = TRUE;
3788 }
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003789
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003790 if (didit)
3791 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003792 // check for the characters now, otherwise they might be eaten by
3793 // get_keystroke()
Bram Moolenaar833e0e32017-08-26 15:16:03 +02003794 out_flush();
3795 (void)vpeekc_nomap();
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003796 }
3797 }
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003798}
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003799
Bram Moolenaar2951b772013-07-03 12:45:31 +02003800# ifdef DEBUG_TERMRESPONSE
3801 static void
Bram Moolenaarb255b902018-04-24 21:40:10 +02003802log_tr(const char *fmt, ...)
Bram Moolenaar2951b772013-07-03 12:45:31 +02003803{
3804 static FILE *fd_tr = NULL;
3805 static proftime_T start;
3806 proftime_T now;
Bram Moolenaarb255b902018-04-24 21:40:10 +02003807 va_list ap;
Bram Moolenaar2951b772013-07-03 12:45:31 +02003808
3809 if (fd_tr == NULL)
3810 {
3811 fd_tr = fopen("termresponse.log", "w");
3812 profile_start(&start);
3813 }
3814 now = start;
3815 profile_end(&now);
Bram Moolenaarb255b902018-04-24 21:40:10 +02003816 fprintf(fd_tr, "%s: %s ", profile_msg(&now),
3817 must_redraw == NOT_VALID ? "NV"
3818 : must_redraw == CLEAR ? "CL" : " ");
3819 va_start(ap, fmt);
3820 vfprintf(fd_tr, fmt, ap);
3821 va_end(ap);
3822 fputc('\n', fd_tr);
3823 fflush(fd_tr);
Bram Moolenaar2951b772013-07-03 12:45:31 +02003824}
3825# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826#endif
3827
3828/*
3829 * Return TRUE when saving and restoring the screen.
3830 */
3831 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003832swapping_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833{
3834 return (full_screen && *T_TI != NUL);
3835}
3836
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837/*
3838 * By outputting the 'cursor very visible' termcap code, for some windowed
3839 * terminals this makes the screen scrolled to the correct position.
3840 * Used when starting Vim or returning from a shell.
3841 */
3842 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003843scroll_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844{
Bram Moolenaarce1c3272017-08-20 15:05:15 +02003845 if (*T_VS != NUL && *T_CVS != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 {
3847 out_str(T_VS);
Bram Moolenaarce1c3272017-08-20 15:05:15 +02003848 out_str(T_CVS);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003849 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 }
3851}
3852
3853static int cursor_is_off = FALSE;
3854
3855/*
Bram Moolenaar2e310482018-08-21 13:09:10 +02003856 * Enable the cursor without checking if it's already enabled.
3857 */
3858 void
3859cursor_on_force(void)
3860{
3861 out_str(T_VE);
3862 cursor_is_off = FALSE;
3863}
3864
3865/*
3866 * Enable the cursor if it's currently off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 */
3868 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003869cursor_on(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870{
3871 if (cursor_is_off)
Bram Moolenaar2e310482018-08-21 13:09:10 +02003872 cursor_on_force();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873}
3874
3875/*
3876 * Disable the cursor.
3877 */
3878 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003879cursor_off(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880{
Bram Moolenaarce1c3272017-08-20 15:05:15 +02003881 if (full_screen && !cursor_is_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003883 out_str(T_VI); // disable cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 cursor_is_off = TRUE;
3885 }
3886}
3887
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003888#if defined(CURSOR_SHAPE) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889/*
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003890 * Set cursor shape to match Insert or Replace mode.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003891 */
3892 void
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003893term_cursor_mode(int forced)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003894{
Bram Moolenaarc9770922017-08-12 20:11:53 +02003895 static int showing_mode = -1;
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003896 char_u *p;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003897
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003898 // Only do something when redrawing the screen and we can restore the
3899 // mode.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003900 if (!full_screen || *T_CEI == NUL)
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003901 {
Bram Moolenaar37b9b812017-08-19 23:23:43 +02003902# ifdef FEAT_TERMRESPONSE
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003903 if (forced && initial_cursor_shape > 0)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003904 // Restore to initial values.
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003905 term_cursor_shape(initial_cursor_shape, initial_cursor_blink);
Bram Moolenaar37b9b812017-08-19 23:23:43 +02003906# endif
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003907 return;
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003908 }
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003909
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003910 if ((State & REPLACE) == REPLACE)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003911 {
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003912 if (forced || showing_mode != REPLACE)
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003913 {
3914 if (*T_CSR != NUL)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003915 p = T_CSR; // Replace mode cursor
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003916 else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003917 p = T_CSI; // fall back to Insert mode cursor
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003918 if (*p != NUL)
3919 {
3920 out_str(p);
3921 showing_mode = REPLACE;
3922 }
3923 }
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003924 }
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003925 else if (State & INSERT)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003926 {
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003927 if ((forced || showing_mode != INSERT) && *T_CSI != NUL)
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003928 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003929 out_str(T_CSI); // Insert mode cursor
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003930 showing_mode = INSERT;
3931 }
3932 }
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003933 else if (forced || showing_mode != NORMAL)
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003934 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003935 out_str(T_CEI); // non-Insert mode cursor
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003936 showing_mode = NORMAL;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003937 }
3938}
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003939
3940# if defined(FEAT_TERMINAL) || defined(PROTO)
3941 void
3942term_cursor_color(char_u *color)
3943{
3944 if (*T_CSC != NUL)
3945 {
Bram Moolenaarec6f7352019-10-24 17:49:27 +02003946 out_str(T_CSC); // set cursor color start
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003947 out_str_nf(color);
Bram Moolenaarec6f7352019-10-24 17:49:27 +02003948 out_str(T_CEC); // set cursor color end
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003949 out_flush();
3950 }
3951}
Bram Moolenaarfc8bec02017-08-19 19:57:34 +02003952# endif
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003953
Bram Moolenaar4db25542017-08-28 22:43:05 +02003954 int
3955blink_state_is_inverted()
3956{
Bram Moolenaar3c37a8e2017-08-28 23:00:55 +02003957#ifdef FEAT_TERMRESPONSE
Bram Moolenaar66761db2019-06-05 22:07:51 +02003958 return rbm_status.tr_progress == STATUS_GOT
3959 && rcs_status.tr_progress == STATUS_GOT
Bram Moolenaar4db25542017-08-28 22:43:05 +02003960 && initial_cursor_blink != initial_cursor_shape_blink;
Bram Moolenaar3c37a8e2017-08-28 23:00:55 +02003961#else
3962 return FALSE;
3963#endif
Bram Moolenaar4db25542017-08-28 22:43:05 +02003964}
3965
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003966/*
Bram Moolenaarce1c3272017-08-20 15:05:15 +02003967 * "shape": 1 = block, 2 = underline, 3 = vertical bar
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003968 */
3969 void
3970term_cursor_shape(int shape, int blink)
3971{
3972 if (*T_CSH != NUL)
3973 {
3974 OUT_STR(tgoto((char *)T_CSH, 0, shape * 2 - blink));
3975 out_flush();
3976 }
Bram Moolenaar4db25542017-08-28 22:43:05 +02003977 else
Bram Moolenaarce1c3272017-08-20 15:05:15 +02003978 {
Bram Moolenaar4db25542017-08-28 22:43:05 +02003979 int do_blink = blink;
3980
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003981 // t_SH is empty: try setting just the blink state.
3982 // The blink flags are XORed together, if the initial blinking from
3983 // style and shape differs, we need to invert the flag here.
Bram Moolenaar4db25542017-08-28 22:43:05 +02003984 if (blink_state_is_inverted())
3985 do_blink = !blink;
3986
3987 if (do_blink && *T_VS != NUL)
3988 {
3989 out_str(T_VS);
3990 out_flush();
3991 }
3992 else if (!do_blink && *T_CVS != NUL)
3993 {
3994 out_str(T_CVS);
3995 out_flush();
3996 }
Bram Moolenaarce1c3272017-08-20 15:05:15 +02003997 }
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003998}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003999#endif
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004000
4001/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 * Set scrolling region for window 'wp'.
4003 * The region starts 'off' lines from the start of the window.
4004 * Also set the vertical scroll region for a vertically split window. Always
4005 * the full width of the window, excluding the vertical separator.
4006 */
4007 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004008scroll_region_set(win_T *wp, int off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009{
4010 OUT_STR(tgoto((char *)T_CS, W_WINROW(wp) + wp->w_height - 1,
4011 W_WINROW(wp) + off));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 if (*T_CSV != NUL && wp->w_width != Columns)
Bram Moolenaar53f81742017-09-22 14:35:51 +02004013 OUT_STR(tgoto((char *)T_CSV, wp->w_wincol + wp->w_width - 1,
4014 wp->w_wincol));
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004015 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016}
4017
4018/*
4019 * Reset scrolling region to the whole screen.
4020 */
4021 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004022scroll_region_reset(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023{
4024 OUT_STR(tgoto((char *)T_CS, (int)Rows - 1, 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 if (*T_CSV != NUL)
4026 OUT_STR(tgoto((char *)T_CSV, (int)Columns - 1, 0));
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004027 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028}
4029
4030
4031/*
4032 * List of terminal codes that are currently recognized.
4033 */
4034
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +00004035static struct termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004037 char_u name[2]; // termcap name of entry
4038 char_u *code; // terminal code (in allocated memory)
4039 int len; // STRLEN(code)
4040 int modlen; // length of part before ";*~".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041} *termcodes = NULL;
4042
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004043static int tc_max_len = 0; // number of entries that termcodes[] can hold
4044static int tc_len = 0; // current number of entries in termcodes[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +01004046static int termcode_star(char_u *code, int len);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004047
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004049clear_termcodes(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050{
4051 while (tc_len > 0)
4052 vim_free(termcodes[--tc_len].code);
Bram Moolenaard23a8232018-02-10 18:45:26 +01004053 VIM_CLEAR(termcodes);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 tc_max_len = 0;
4055
4056#ifdef HAVE_TGETENT
4057 BC = (char *)empty_option;
4058 UP = (char *)empty_option;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004059 PC = NUL; // set pad character to NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 ospeed = 0;
4061#endif
4062
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004063 need_gather = TRUE; // need to fill termleader[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064}
4065
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004066#define ATC_FROM_TERM 55
4067
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068/*
4069 * Add a new entry to the list of terminal codes.
4070 * The list is kept alphabetical for ":set termcap"
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004071 * "flags" is TRUE when replacing 7-bit by 8-bit controls is desired.
4072 * "flags" can also be ATC_FROM_TERM for got_code_from_term().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 */
4074 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004075add_termcode(char_u *name, char_u *string, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076{
4077 struct termcode *new_tc;
4078 int i, j;
4079 char_u *s;
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004080 int len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081
4082 if (string == NULL || *string == NUL)
4083 {
4084 del_termcode(name);
4085 return;
4086 }
4087
Bram Moolenaar4f974752019-02-17 17:44:42 +01004088#if defined(MSWIN) && !defined(FEAT_GUI)
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004089 s = vim_strnsave(string, STRLEN(string) + 1);
Bram Moolenaar45500912014-07-09 20:51:07 +02004090#else
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004091# ifdef VIMDLL
4092 if (!gui.in_use)
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004093 s = vim_strnsave(string, STRLEN(string) + 1);
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004094 else
4095# endif
4096 s = vim_strsave(string);
Bram Moolenaar45500912014-07-09 20:51:07 +02004097#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 if (s == NULL)
4099 return;
4100
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004101 // Change leading <Esc>[ to CSI, change <Esc>O to <M-O>.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004102 if (flags != 0 && flags != ATC_FROM_TERM && term_7to8bit(string) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 {
Bram Moolenaar864207d2008-06-24 22:14:38 +00004104 STRMOVE(s, s + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 s[0] = term_7to8bit(string);
4106 }
Bram Moolenaar45500912014-07-09 20:51:07 +02004107
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004108#if defined(MSWIN) && (!defined(FEAT_GUI) || defined(VIMDLL))
4109# ifdef VIMDLL
4110 if (!gui.in_use)
4111# endif
Bram Moolenaar45500912014-07-09 20:51:07 +02004112 {
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004113 if (s[0] == K_NUL)
4114 {
4115 STRMOVE(s + 1, s);
4116 s[1] = 3;
4117 }
Bram Moolenaar45500912014-07-09 20:51:07 +02004118 }
4119#endif
4120
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004121 len = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004123 need_gather = TRUE; // need to fill termleader[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124
4125 /*
4126 * need to make space for more entries
4127 */
4128 if (tc_len == tc_max_len)
4129 {
4130 tc_max_len += 20;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004131 new_tc = ALLOC_MULT(struct termcode, tc_max_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 if (new_tc == NULL)
4133 {
4134 tc_max_len -= 20;
4135 return;
4136 }
4137 for (i = 0; i < tc_len; ++i)
4138 new_tc[i] = termcodes[i];
4139 vim_free(termcodes);
4140 termcodes = new_tc;
4141 }
4142
4143 /*
4144 * Look for existing entry with the same name, it is replaced.
4145 * Look for an existing entry that is alphabetical higher, the new entry
4146 * is inserted in front of it.
4147 */
4148 for (i = 0; i < tc_len; ++i)
4149 {
4150 if (termcodes[i].name[0] < name[0])
4151 continue;
4152 if (termcodes[i].name[0] == name[0])
4153 {
4154 if (termcodes[i].name[1] < name[1])
4155 continue;
4156 /*
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004157 * Exact match: May replace old code.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 */
4159 if (termcodes[i].name[1] == name[1])
4160 {
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004161 if (flags == ATC_FROM_TERM && (j = termcode_star(
4162 termcodes[i].code, termcodes[i].len)) > 0)
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004163 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004164 // Don't replace ESC[123;*X or ESC O*X with another when
4165 // invoked from got_code_from_term().
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004166 if (len == termcodes[i].len - j
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004167 && STRNCMP(s, termcodes[i].code, len - 1) == 0
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004168 && s[len - 1]
4169 == termcodes[i].code[termcodes[i].len - 1])
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004170 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004171 // They are equal but for the ";*": don't add it.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004172 vim_free(s);
4173 return;
4174 }
4175 }
4176 else
4177 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004178 // Replace old code.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004179 vim_free(termcodes[i].code);
4180 --tc_len;
4181 break;
4182 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 }
4184 }
4185 /*
4186 * Found alphabetical larger entry, move rest to insert new entry
4187 */
4188 for (j = tc_len; j > i; --j)
4189 termcodes[j] = termcodes[j - 1];
4190 break;
4191 }
4192
4193 termcodes[i].name[0] = name[0];
4194 termcodes[i].name[1] = name[1];
4195 termcodes[i].code = s;
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004196 termcodes[i].len = len;
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004197
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004198 // For xterm we recognize special codes like "ESC[42;*X" and "ESC O*X" that
4199 // accept modifiers.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004200 termcodes[i].modlen = 0;
4201 j = termcode_star(s, len);
4202 if (j > 0)
4203 termcodes[i].modlen = len - 1 - j;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 ++tc_len;
4205}
4206
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004207/*
Bram Moolenaara529ce02017-06-22 22:37:57 +02004208 * Check termcode "code[len]" for ending in ;*X or *X.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004209 * The "X" can be any character.
Bram Moolenaara529ce02017-06-22 22:37:57 +02004210 * Return 0 if not found, 2 for ;*X and 1 for *X.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004211 */
4212 static int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004213termcode_star(char_u *code, int len)
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004214{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004215 // Shortest is <M-O>*X. With ; shortest is <CSI>1;*X
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004216 if (len >= 3 && code[len - 2] == '*')
4217 {
4218 if (len >= 5 && code[len - 3] == ';')
4219 return 2;
Bram Moolenaara529ce02017-06-22 22:37:57 +02004220 else
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004221 return 1;
4222 }
4223 return 0;
4224}
4225
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 char_u *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004227find_termcode(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228{
4229 int i;
4230
4231 for (i = 0; i < tc_len; ++i)
4232 if (termcodes[i].name[0] == name[0] && termcodes[i].name[1] == name[1])
4233 return termcodes[i].code;
4234 return NULL;
4235}
4236
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 char_u *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004238get_termcode(int i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239{
4240 if (i >= tc_len)
4241 return NULL;
4242 return &termcodes[i].name[0];
4243}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02004245/*
4246 * Returns the length of the terminal code at index 'idx'.
4247 */
4248 int
4249get_termcode_len(int idx)
4250{
4251 return termcodes[idx].len;
4252}
4253
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02004254 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004255del_termcode(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256{
4257 int i;
4258
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004259 if (termcodes == NULL) // nothing there yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 return;
4261
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004262 need_gather = TRUE; // need to fill termleader[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263
4264 for (i = 0; i < tc_len; ++i)
4265 if (termcodes[i].name[0] == name[0] && termcodes[i].name[1] == name[1])
4266 {
4267 del_termcode_idx(i);
4268 return;
4269 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004270 // not found. Give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271}
4272
4273 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004274del_termcode_idx(int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275{
4276 int i;
4277
4278 vim_free(termcodes[idx].code);
4279 --tc_len;
4280 for (i = idx; i < tc_len; ++i)
4281 termcodes[i] = termcodes[i + 1];
4282}
4283
4284#ifdef FEAT_TERMRESPONSE
4285/*
4286 * Called when detected that the terminal sends 8-bit codes.
4287 * Convert all 7-bit codes to their 8-bit equivalent.
4288 */
4289 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004290switch_to_8bit(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291{
4292 int i;
4293 int c;
4294
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004295 // Only need to do something when not already using 8-bit codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 if (!term_is_8bit(T_NAME))
4297 {
4298 for (i = 0; i < tc_len; ++i)
4299 {
4300 c = term_7to8bit(termcodes[i].code);
4301 if (c != 0)
4302 {
Bram Moolenaar864207d2008-06-24 22:14:38 +00004303 STRMOVE(termcodes[i].code + 1, termcodes[i].code + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 termcodes[i].code[0] = c;
4305 }
4306 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004307 need_gather = TRUE; // need to fill termleader[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 }
4309 detected_8bit = TRUE;
Bram Moolenaarb255b902018-04-24 21:40:10 +02004310 LOG_TR(("Switching to 8 bit"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311}
4312#endif
4313
4314#ifdef CHECK_DOUBLE_CLICK
4315static linenr_T orig_topline = 0;
4316# ifdef FEAT_DIFF
4317static int orig_topfill = 0;
4318# endif
4319#endif
Bram Moolenaar4033c552017-09-16 20:54:51 +02004320#if defined(CHECK_DOUBLE_CLICK) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321/*
4322 * Checking for double clicks ourselves.
4323 * "orig_topline" is used to avoid detecting a double-click when the window
4324 * contents scrolled (e.g., when 'scrolloff' is non-zero).
4325 */
4326/*
4327 * Set orig_topline. Used when jumping to another window, so that a double
4328 * click still works.
4329 */
4330 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004331set_mouse_topline(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332{
4333 orig_topline = wp->w_topline;
4334# ifdef FEAT_DIFF
4335 orig_topfill = wp->w_topfill;
4336# endif
4337}
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02004338
4339/*
4340 * Returns TRUE if the top line and top fill of window 'wp' matches the saved
4341 * topline and topfill.
4342 */
4343 int
4344is_mouse_topline(win_T *wp)
4345{
4346 return orig_topline == wp->w_topline
4347#ifdef FEAT_DIFF
4348 && orig_topfill == wp->w_topfill
4349#endif
4350 ;
4351}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352#endif
4353
4354/*
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02004355 * Put "string[new_slen]" in typebuf, or in "buf[bufsize]" if "buf" is not NULL.
4356 * Remove "slen" bytes.
4357 * Returns FAIL for error.
4358 */
Bram Moolenaar975a8802020-06-06 22:36:24 +02004359 int
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02004360put_string_in_typebuf(
4361 int offset,
4362 int slen,
4363 char_u *string,
4364 int new_slen,
4365 char_u *buf,
4366 int bufsize,
4367 int *buflen)
4368{
4369 int extra = new_slen - slen;
4370
4371 string[new_slen] = NUL;
4372 if (buf == NULL)
4373 {
4374 if (extra < 0)
4375 // remove matched chars, taking care of noremap
4376 del_typebuf(-extra, offset);
4377 else if (extra > 0)
4378 // insert the extra space we need
4379 ins_typebuf(string + slen, REMAP_YES, offset, FALSE, FALSE);
4380
4381 // Careful: del_typebuf() and ins_typebuf() may have reallocated
4382 // typebuf.tb_buf[]!
4383 mch_memmove(typebuf.tb_buf + typebuf.tb_off + offset, string,
4384 (size_t)new_slen);
4385 }
4386 else
4387 {
4388 if (extra < 0)
4389 // remove matched characters
4390 mch_memmove(buf + offset, buf + offset - extra,
4391 (size_t)(*buflen + offset + extra));
4392 else if (extra > 0)
4393 {
4394 // Insert the extra space we need. If there is insufficient
4395 // space return -1.
4396 if (*buflen + extra + new_slen >= bufsize)
4397 return FAIL;
4398 mch_memmove(buf + offset + extra, buf + offset,
4399 (size_t)(*buflen - offset));
4400 }
4401 mch_memmove(buf + offset, string, (size_t)new_slen);
4402 *buflen = *buflen + extra + new_slen;
4403 }
4404 return OK;
4405}
4406
4407/*
4408 * Decode a modifier number as xterm provides it into MOD_MASK bits.
4409 */
Bram Moolenaarfc4ea2a2019-11-26 19:33:22 +01004410 int
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02004411decode_modifiers(int n)
4412{
4413 int code = n - 1;
4414 int modifiers = 0;
4415
4416 if (code & 1)
4417 modifiers |= MOD_MASK_SHIFT;
4418 if (code & 2)
4419 modifiers |= MOD_MASK_ALT;
4420 if (code & 4)
4421 modifiers |= MOD_MASK_CTRL;
4422 if (code & 8)
4423 modifiers |= MOD_MASK_META;
4424 return modifiers;
4425}
4426
4427 static int
4428modifiers2keycode(int modifiers, int *key, char_u *string)
4429{
4430 int new_slen = 0;
4431
4432 if (modifiers != 0)
4433 {
4434 // Some keys have the modifier included. Need to handle that here to
4435 // make mappings work.
4436 *key = simplify_key(*key, &modifiers);
4437 if (modifiers != 0)
4438 {
4439 string[new_slen++] = K_SPECIAL;
4440 string[new_slen++] = (int)KS_MODIFIER;
4441 string[new_slen++] = modifiers;
4442 }
4443 }
4444 return new_slen;
4445}
4446
Bram Moolenaar0ca8b5b2020-06-09 21:35:36 +02004447#ifdef FEAT_TERMRESPONSE
4448/*
4449 * Handle a cursor position report.
4450 */
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004451 static void
Bram Moolenaar0ca8b5b2020-06-09 21:35:36 +02004452handle_u7_response(int *arg, char_u *tp UNUSED, int csi_len UNUSED)
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004453{
4454 if (arg[0] == 2 && arg[1] >= 2)
4455 {
4456 char *aw = NULL;
4457
4458 LOG_TR(("Received U7 status: %s", tp));
4459 u7_status.tr_progress = STATUS_GOT;
4460 did_cursorhold = TRUE;
4461 if (arg[1] == 2)
4462 aw = "single";
4463 else if (arg[1] == 3)
4464 aw = "double";
4465 if (aw != NULL && STRCMP(aw, p_ambw) != 0)
4466 {
4467 // Setting the option causes a screen redraw. Do
4468 // that right away if possible, keeping any
4469 // messages.
Bram Moolenaar0ca8b5b2020-06-09 21:35:36 +02004470 set_option_value((char_u *)"ambw", 0L, (char_u *)aw, 0);
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004471# ifdef DEBUG_TERMRESPONSE
4472 {
4473 int r = redraw_asap(CLEAR);
4474
4475 log_tr("set 'ambiwidth', redraw_asap(): %d", r);
4476 }
4477# else
4478 redraw_asap(CLEAR);
4479# endif
4480# ifdef FEAT_EVAL
4481 set_vim_var_string(VV_TERMU7RESP, tp, csi_len);
4482# endif
4483 }
4484 }
4485 else if (arg[0] == 3)
4486 {
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004487 int value;
4488
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004489 LOG_TR(("Received compatibility test result: %s", tp));
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004490 xcc_status.tr_progress = STATUS_GOT;
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004491
4492 // Third row: xterm compatibility test.
4493 // If the cursor is on the first column then the terminal can handle
4494 // the request for cursor style and blinking.
4495 value = arg[1] == 1 ? TPR_YES : TPR_NO;
4496 term_props[TPR_CURSOR_STYLE].tpr_status = value;
4497 term_props[TPR_CURSOR_BLINK].tpr_status = value;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004498 }
4499}
4500
4501/*
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004502 * Handle a response to T_CRV: {lead}{first}{x};{vers};{y}c
4503 * Xterm and alikes use '>' for {first}.
4504 * Rxvt sends "{lead}?1;2c".
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004505 */
4506 static void
4507handle_version_response(int first, int *arg, int argc, char_u *tp)
4508{
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004509 // The xterm version. It is set to zero when it can't be an actual xterm
4510 // version.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004511 int version = arg[1];
4512
4513 LOG_TR(("Received CRV response: %s", tp));
4514 crv_status.tr_progress = STATUS_GOT;
4515 did_cursorhold = TRUE;
4516
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004517 // Reset terminal properties that are set based on the termresponse.
4518 // Mainly useful for tests that send the termresponse multiple times.
4519 init_term_props(FALSE);
4520
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004521 // If this code starts with CSI, you can bet that the
4522 // terminal uses 8-bit codes.
4523 if (tp[0] == CSI)
4524 switch_to_8bit();
4525
4526 // Screen sends 40500.
4527 // rxvt sends its version number: "20703" is 2.7.3.
4528 // Ignore it for when the user has set 'term' to xterm,
4529 // even though it's an rxvt.
4530 if (version > 20000)
4531 version = 0;
4532
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004533 // Figure out more if the reeponse is CSI > 99 ; 99 ; 99 c
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004534 if (first == '>' && argc == 3)
4535 {
4536 int need_flush = FALSE;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004537
4538 // mintty 2.9.5 sends 77;20905;0c.
4539 // (77 is ASCII 'M' for mintty.)
4540 if (arg[0] == 77)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004541 {
4542 // mintty can do SGR mouse reporting
4543 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
4544 }
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004545
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004546 // If xterm version >= 141 try to get termcap codes. For other
4547 // terminals the request should be ignored.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004548 if (version >= 141)
4549 {
4550 LOG_TR(("Enable checking for XT codes"));
4551 check_for_codes = TRUE;
4552 need_gather = TRUE;
4553 req_codes_from_term();
4554 }
4555
4556 // libvterm sends 0;100;0
4557 if (version == 100 && arg[0] == 0 && arg[2] == 0)
4558 {
4559 // If run from Vim $COLORS is set to the number of
4560 // colors the terminal supports. Otherwise assume
4561 // 256, libvterm supports even more.
4562 if (mch_getenv((char_u *)"COLORS") == NULL)
4563 may_adjust_color_count(256);
4564 // Libvterm can handle SGR mouse reporting.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004565 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004566 }
4567
4568 if (version == 95)
4569 {
4570 // Mac Terminal.app sends 1;95;0
4571 if (arg[0] == 1 && arg[2] == 0)
4572 {
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004573 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
4574 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004575 }
4576 // iTerm2 sends 0;95;0
4577 else if (arg[0] == 0 && arg[2] == 0)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004578 {
4579 // iTerm2 can do SGR mouse reporting
4580 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
4581 }
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004582 // old iTerm2 sends 0;95;
4583 else if (arg[0] == 0 && arg[2] == -1)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004584 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004585 }
4586
4587 // screen sends 83;40500;0 83 is 'S' in ASCII.
4588 if (arg[0] == 83)
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004589 {
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004590 // screen supports SGR mouse codes since 4.7.0
4591 if (arg[1] >= 40700)
4592 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
4593 else
4594 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_XTERM;
4595 }
4596
4597 // If no recognized terminal has set mouse behavior, assume xterm.
4598 if (term_props[TPR_MOUSE].tpr_status == TPR_UNKNOWN)
4599 {
4600 // Xterm version 277 supports SGR.
4601 // Xterm version >= 95 supports mouse dragging.
4602 if (version >= 277)
4603 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004604 else if (version >= 95)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004605 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_XTERM2;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004606 }
4607
4608 // Detect terminals that set $TERM to something like
4609 // "xterm-256color" but are not fully xterm compatible.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004610 //
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004611 // Gnome terminal sends 1;3801;0, 1;4402;0 or 1;2501;0.
4612 // xfce4-terminal sends 1;2802;0.
4613 // screen sends 83;40500;0
4614 // Assuming any version number over 2500 is not an
4615 // xterm (without the limit for rxvt and screen).
4616 if (arg[1] >= 2500)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004617 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004618
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004619 else if (version == 136 && arg[2] == 0)
4620 {
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004621 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004622
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004623 // PuTTY sends 0;136;0
4624 if (arg[0] == 0)
4625 {
4626 // supports sgr-like mouse reporting.
4627 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
4628 }
4629 // vandyke SecureCRT sends 1;136;0
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004630 }
4631
4632 // Konsole sends 0;115;0
4633 else if (version == 115 && arg[0] == 0 && arg[2] == 0)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004634 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004635
4636 // GNU screen sends 83;30600;0, 83;40500;0, etc.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004637 // 30600/40500 is a version number of GNU screen. DA2 support is added
4638 // on 3.6. DCS string has a special meaning to GNU screen, but xterm
4639 // compatibility checking does not detect GNU screen.
4640 if (arg[0] == 83 && arg[1] >= 30600)
4641 {
4642 term_props[TPR_CURSOR_STYLE].tpr_status = TPR_NO;
4643 term_props[TPR_CURSOR_BLINK].tpr_status = TPR_NO;
4644 }
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004645
4646 // Xterm first responded to this request at patch level
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004647 // 95, so assume anything below 95 is not xterm and hopefully supports
4648 // the underline RGB color sequence.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004649 if (version < 95)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004650 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004651
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004652 // Getting the cursor style is only supported properly by xterm since
4653 // version 279 (otherwise it returns 0x18).
4654 if (version < 279)
4655 term_props[TPR_CURSOR_STYLE].tpr_status = TPR_NO;
4656
4657 /*
4658 * Take action on the detected properties.
4659 */
4660
4661 // Unless the underline RGB color is expected to work, disable "t_8u".
4662 // It does not work for the real Xterm, it resets the background color.
4663 if (term_props[TPR_UNDERLINE_RGB].tpr_status == TPR_YES && *T_8U != NUL)
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004664 T_8U = empty_option;
4665
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004666 // Only set 'ttymouse' automatically if it was not set
4667 // by the user already.
4668 if (!option_was_set((char_u *)"ttym")
4669 && (term_props[TPR_MOUSE].tpr_status == TPR_MOUSE_XTERM2
4670 || term_props[TPR_MOUSE].tpr_status == TPR_MOUSE_SGR))
4671 {
4672 set_option_value((char_u *)"ttym", 0L,
4673 term_props[TPR_MOUSE].tpr_status == TPR_MOUSE_SGR
4674 ? (char_u *)"sgr" : (char_u *)"xterm2", 0);
4675 }
4676
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004677 // Only request the cursor style if t_SH and t_RS are
4678 // set. Only supported properly by xterm since version
4679 // 279 (otherwise it returns 0x18).
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004680 // Only when getting the cursor style was detected to work.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004681 // Not for Terminal.app, it can't handle t_RS, it
4682 // echoes the characters to the screen.
4683 if (rcs_status.tr_progress == STATUS_GET
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004684 && term_props[TPR_CURSOR_STYLE].tpr_status == TPR_YES
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004685 && *T_CSH != NUL
4686 && *T_CRS != NUL)
4687 {
4688 LOG_TR(("Sending cursor style request"));
4689 out_str(T_CRS);
4690 termrequest_sent(&rcs_status);
4691 need_flush = TRUE;
4692 }
4693
4694 // Only request the cursor blink mode if t_RC set. Not
4695 // for Gnome terminal, it can't handle t_RC, it
4696 // echoes the characters to the screen.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004697 // Only when getting the cursor style was detected to work.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004698 if (rbm_status.tr_progress == STATUS_GET
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004699 && term_props[TPR_CURSOR_BLINK].tpr_status == TPR_YES
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004700 && *T_CRC != NUL)
4701 {
4702 LOG_TR(("Sending cursor blink mode request"));
4703 out_str(T_CRC);
4704 termrequest_sent(&rbm_status);
4705 need_flush = TRUE;
4706 }
4707
4708 if (need_flush)
4709 out_flush();
4710 }
4711}
4712
4713/*
4714 * Handle a sequence with key and modifier, one of:
4715 * {lead}27;{modifier};{key}~
4716 * {lead}{key};{modifier}u
4717 * Returns the difference in length.
4718 */
4719 static int
4720handle_key_with_modifier(
4721 int *arg,
4722 int trail,
4723 int csi_len,
4724 int offset,
4725 char_u *buf,
4726 int bufsize,
4727 int *buflen)
4728{
4729 int key;
4730 int modifiers;
4731 int new_slen;
4732 char_u string[MAX_KEY_CODE_LEN + 1];
4733
4734 seenModifyOtherKeys = TRUE;
4735 if (trail == 'u')
4736 key = arg[0];
4737 else
4738 key = arg[2];
4739
4740 modifiers = decode_modifiers(arg[1]);
4741
4742 // Some keys already have Shift included, pass them as
4743 // normal keys. Not when Ctrl is also used, because <C-H>
4744 // and <C-S-H> are different.
4745 if (modifiers == MOD_MASK_SHIFT
4746 && ((key >= '@' && key <= 'Z')
4747 || key == '^' || key == '_'
4748 || (key >= '{' && key <= '~')))
4749 modifiers = 0;
4750
4751 // When used with Ctrl we always make a letter upper case,
4752 // so that mapping <C-H> and <C-h> are the same. Typing
4753 // <C-S-H> also uses "H" but modifier is different.
4754 if ((modifiers & MOD_MASK_CTRL) && ASCII_ISALPHA(key))
4755 key = TOUPPER_ASC(key);
4756
4757 // insert modifiers with KS_MODIFIER
4758 new_slen = modifiers2keycode(modifiers, &key, string);
4759
4760 if (has_mbyte)
4761 new_slen += (*mb_char2bytes)(key, string + new_slen);
4762 else
4763 string[new_slen++] = key;
4764
4765 if (put_string_in_typebuf(offset, csi_len, string, new_slen,
4766 buf, bufsize, buflen) == FAIL)
4767 return -1;
4768 return new_slen - csi_len + offset;
4769}
4770
4771/*
4772 * Handle a CSI escape sequence.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004773 * - Xterm version string.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004774 *
4775 * - Cursor position report: {lead}{row};{col}R
4776 * The final byte must be 'R'. It is used for checking the
4777 * ambiguous-width character state.
4778 *
4779 * - window position reply: {lead}3;{x};{y}t
4780 *
4781 * - key with modifiers when modifyOtherKeys is enabled:
4782 * {lead}27;{modifier};{key}~
4783 * {lead}{key};{modifier}u
4784 * Return 0 for no match, -1 for partial match, > 0 for full match.
4785 */
4786 static int
4787handle_csi(
4788 char_u *tp,
4789 int len,
4790 char_u *argp,
4791 int offset,
4792 char_u *buf,
4793 int bufsize,
4794 int *buflen,
4795 char_u *key_name,
4796 int *slen)
4797{
4798 int first = -1; // optional char right after {lead}
4799 int trail; // char that ends CSI sequence
4800 int arg[3] = {-1, -1, -1}; // argument numbers
4801 int argc; // number of arguments
4802 char_u *ap = argp;
4803 int csi_len;
4804
4805 // Check for non-digit after CSI.
4806 if (!VIM_ISDIGIT(*ap))
4807 first = *ap++;
4808
4809 // Find up to three argument numbers.
4810 for (argc = 0; argc < 3; )
4811 {
4812 if (ap >= tp + len)
4813 return -1;
4814 if (*ap == ';')
4815 arg[argc++] = -1; // omitted number
4816 else if (VIM_ISDIGIT(*ap))
4817 {
4818 arg[argc] = 0;
4819 for (;;)
4820 {
4821 if (ap >= tp + len)
4822 return -1;
4823 if (!VIM_ISDIGIT(*ap))
4824 break;
4825 arg[argc] = arg[argc] * 10 + (*ap - '0');
4826 ++ap;
4827 }
4828 ++argc;
4829 }
4830 if (*ap == ';')
4831 ++ap;
4832 else
4833 break;
4834 }
4835
4836 // mrxvt has been reported to have "+" in the version. Assume
4837 // the escape sequence ends with a letter or one of "{|}~".
4838 while (ap < tp + len
4839 && !(*ap >= '{' && *ap <= '~')
4840 && !ASCII_ISALPHA(*ap))
4841 ++ap;
4842 if (ap >= tp + len)
4843 return -1;
4844 trail = *ap;
4845 csi_len = (int)(ap - tp) + 1;
4846
4847 // Cursor position report: Eat it when there are 2 arguments
4848 // and it ends in 'R'. Also when u7_status is not "sent", it
4849 // may be from a previous Vim that just exited. But not for
4850 // <S-F3>, it sends something similar, check for row and column
4851 // to make sense.
4852 if (first == -1 && argc == 2 && trail == 'R')
4853 {
4854 handle_u7_response(arg, tp, csi_len);
4855
4856 key_name[0] = (int)KS_EXTRA;
4857 key_name[1] = (int)KE_IGNORE;
4858 *slen = csi_len;
4859 }
4860
4861 // Version string: Eat it when there is at least one digit and
4862 // it ends in 'c'
4863 else if (*T_CRV != NUL && ap > argp + 1 && trail == 'c')
4864 {
4865 handle_version_response(first, arg, argc, tp);
4866
4867 *slen = csi_len;
4868# ifdef FEAT_EVAL
4869 set_vim_var_string(VV_TERMRESPONSE, tp, *slen);
4870# endif
4871 apply_autocmds(EVENT_TERMRESPONSE,
4872 NULL, NULL, FALSE, curbuf);
4873 key_name[0] = (int)KS_EXTRA;
4874 key_name[1] = (int)KE_IGNORE;
4875 }
4876
4877 // Check blinking cursor from xterm:
4878 // {lead}?12;1$y set
4879 // {lead}?12;2$y not set
4880 //
4881 // {lead} can be <Esc>[ or CSI
4882 else if (rbm_status.tr_progress == STATUS_SENT
4883 && first == '?'
4884 && ap == argp + 6
4885 && arg[0] == 12
4886 && ap[-1] == '$'
4887 && trail == 'y')
4888 {
4889 initial_cursor_blink = (arg[1] == '1');
4890 rbm_status.tr_progress = STATUS_GOT;
4891 LOG_TR(("Received cursor blinking mode response: %s", tp));
4892 key_name[0] = (int)KS_EXTRA;
4893 key_name[1] = (int)KE_IGNORE;
4894 *slen = csi_len;
4895# ifdef FEAT_EVAL
4896 set_vim_var_string(VV_TERMBLINKRESP, tp, *slen);
4897# endif
4898 }
4899
4900 // Check for a window position response from the terminal:
4901 // {lead}3;{x};{y}t
4902 else if (did_request_winpos && argc == 3 && arg[0] == 3
4903 && trail == 't')
4904 {
4905 winpos_x = arg[1];
4906 winpos_y = arg[2];
4907 // got finished code: consume it
4908 key_name[0] = (int)KS_EXTRA;
4909 key_name[1] = (int)KE_IGNORE;
4910 *slen = csi_len;
4911
4912 if (--did_request_winpos <= 0)
4913 winpos_status.tr_progress = STATUS_GOT;
4914 }
4915
4916 // Key with modifier:
4917 // {lead}27;{modifier};{key}~
4918 // {lead}{key};{modifier}u
4919 else if ((arg[0] == 27 && argc == 3 && trail == '~')
4920 || (argc == 2 && trail == 'u'))
4921 {
4922 return len + handle_key_with_modifier(arg, trail,
4923 csi_len, offset, buf, bufsize, buflen);
4924 }
4925
4926 // else: Unknown CSI sequence. We could drop it, but then the
4927 // user can't create a map for it.
4928 return 0;
4929}
4930
4931/*
4932 * Handle an OSC sequence, fore/background color response from the terminal:
4933 *
4934 * {lead}{code};rgb:{rrrr}/{gggg}/{bbbb}{tail}
4935 * or {lead}{code};rgb:{rr}/{gg}/{bb}{tail}
4936 *
4937 * {code} is 10 for foreground, 11 for background
4938 * {lead} can be <Esc>] or OSC
4939 * {tail} can be '\007', <Esc>\ or STERM.
4940 *
4941 * Consume any code that starts with "{lead}11;", it's also
4942 * possible that "rgba" is following.
4943 */
4944 static int
4945handle_osc(char_u *tp, char_u *argp, int len, char_u *key_name, int *slen)
4946{
4947 int i, j;
4948
4949 j = 1 + (tp[0] == ESC);
4950 if (len >= j + 3 && (argp[0] != '1'
4951 || (argp[1] != '1' && argp[1] != '0')
4952 || argp[2] != ';'))
4953 i = 0; // no match
4954 else
4955 for (i = j; i < len; ++i)
4956 if (tp[i] == '\007' || (tp[0] == OSC ? tp[i] == STERM
4957 : (tp[i] == ESC && i + 1 < len && tp[i + 1] == '\\')))
4958 {
4959 int is_bg = argp[1] == '1';
4960 int is_4digit = i - j >= 21 && tp[j + 11] == '/'
4961 && tp[j + 16] == '/';
4962
4963 if (i - j >= 15 && STRNCMP(tp + j + 3, "rgb:", 4) == 0
4964 && (is_4digit
4965 || (tp[j + 9] == '/' && tp[i + 12 == '/'])))
4966 {
4967 char_u *tp_r = tp + j + 7;
4968 char_u *tp_g = tp + j + (is_4digit ? 12 : 10);
4969 char_u *tp_b = tp + j + (is_4digit ? 17 : 13);
4970# ifdef FEAT_TERMINAL
4971 int rval, gval, bval;
4972
4973 rval = hexhex2nr(tp_r);
4974 gval = hexhex2nr(tp_b);
4975 bval = hexhex2nr(tp_g);
4976# endif
4977 if (is_bg)
4978 {
4979 char *new_bg_val = (3 * '6' < *tp_r + *tp_g +
4980 *tp_b) ? "light" : "dark";
4981
4982 LOG_TR(("Received RBG response: %s", tp));
4983 rbg_status.tr_progress = STATUS_GOT;
4984# ifdef FEAT_TERMINAL
4985 bg_r = rval;
4986 bg_g = gval;
4987 bg_b = bval;
4988# endif
4989 if (!option_was_set((char_u *)"bg")
4990 && STRCMP(p_bg, new_bg_val) != 0)
4991 {
4992 // value differs, apply it
4993 set_option_value((char_u *)"bg", 0L,
4994 (char_u *)new_bg_val, 0);
4995 reset_option_was_set((char_u *)"bg");
4996 redraw_asap(CLEAR);
4997 }
4998 }
4999# ifdef FEAT_TERMINAL
5000 else
5001 {
5002 LOG_TR(("Received RFG response: %s", tp));
5003 rfg_status.tr_progress = STATUS_GOT;
5004 fg_r = rval;
5005 fg_g = gval;
5006 fg_b = bval;
5007 }
5008# endif
5009 }
5010
5011 // got finished code: consume it
5012 key_name[0] = (int)KS_EXTRA;
5013 key_name[1] = (int)KE_IGNORE;
5014 *slen = i + 1 + (tp[i] == ESC);
5015# ifdef FEAT_EVAL
5016 set_vim_var_string(is_bg ? VV_TERMRBGRESP
5017 : VV_TERMRFGRESP, tp, *slen);
5018# endif
5019 break;
5020 }
5021 if (i == len)
5022 {
5023 LOG_TR(("not enough characters for RB"));
5024 return FAIL;
5025 }
5026 return OK;
5027}
5028
5029/*
5030 * Check for key code response from xterm:
5031 * {lead}{flag}+r<hex bytes><{tail}
5032 *
5033 * {lead} can be <Esc>P or DCS
5034 * {flag} can be '0' or '1'
5035 * {tail} can be Esc>\ or STERM
5036 *
5037 * Check for cursor shape response from xterm:
5038 * {lead}1$r<digit> q{tail}
5039 *
5040 * {lead} can be <Esc>P or DCS
5041 * {tail} can be <Esc>\ or STERM
5042 *
5043 * Consume any code that starts with "{lead}.+r" or "{lead}.$r".
5044 */
5045 static int
5046handle_dcs(char_u *tp, char_u *argp, int len, char_u *key_name, int *slen)
5047{
5048 int i, j;
5049
5050 j = 1 + (tp[0] == ESC);
5051 if (len < j + 3)
5052 i = len; // need more chars
5053 else if ((argp[1] != '+' && argp[1] != '$') || argp[2] != 'r')
5054 i = 0; // no match
5055 else if (argp[1] == '+')
5056 // key code response
5057 for (i = j; i < len; ++i)
5058 {
5059 if ((tp[i] == ESC && i + 1 < len && tp[i + 1] == '\\')
5060 || tp[i] == STERM)
5061 {
5062 if (i - j >= 3)
5063 got_code_from_term(tp + j, i);
5064 key_name[0] = (int)KS_EXTRA;
5065 key_name[1] = (int)KE_IGNORE;
5066 *slen = i + 1 + (tp[i] == ESC);
5067 break;
5068 }
5069 }
5070 else
5071 {
5072 // Probably the cursor shape response. Make sure that "i"
5073 // is equal to "len" when there are not sufficient
5074 // characters.
5075 for (i = j + 3; i < len; ++i)
5076 {
5077 if (i - j == 3 && !isdigit(tp[i]))
5078 break;
5079 if (i - j == 4 && tp[i] != ' ')
5080 break;
5081 if (i - j == 5 && tp[i] != 'q')
5082 break;
5083 if (i - j == 6 && tp[i] != ESC && tp[i] != STERM)
5084 break;
5085 if ((i - j == 6 && tp[i] == STERM)
5086 || (i - j == 7 && tp[i] == '\\'))
5087 {
5088 int number = argp[3] - '0';
5089
5090 // 0, 1 = block blink, 2 = block
5091 // 3 = underline blink, 4 = underline
5092 // 5 = vertical bar blink, 6 = vertical bar
5093 number = number == 0 ? 1 : number;
5094 initial_cursor_shape = (number + 1) / 2;
5095 // The blink flag is actually inverted, compared to
5096 // the value set with T_SH.
5097 initial_cursor_shape_blink =
5098 (number & 1) ? FALSE : TRUE;
5099 rcs_status.tr_progress = STATUS_GOT;
5100 LOG_TR(("Received cursor shape response: %s", tp));
5101
5102 key_name[0] = (int)KS_EXTRA;
5103 key_name[1] = (int)KE_IGNORE;
5104 *slen = i + 1;
5105# ifdef FEAT_EVAL
5106 set_vim_var_string(VV_TERMSTYLERESP, tp, *slen);
5107# endif
5108 break;
5109 }
5110 }
5111 }
5112
5113 if (i == len)
5114 {
5115 // These codes arrive many together, each code can be
5116 // truncated at any point.
5117 LOG_TR(("not enough characters for XT"));
5118 return FAIL;
5119 }
5120 return OK;
5121}
Bram Moolenaar0ca8b5b2020-06-09 21:35:36 +02005122#endif // FEAT_TERMRESPONSE
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005123
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02005124/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 * Check if typebuf.tb_buf[] contains a terminal key code.
5126 * Check from typebuf.tb_buf[typebuf.tb_off] to typebuf.tb_buf[typebuf.tb_off
Bram Moolenaar975a8802020-06-06 22:36:24 +02005127 * + "max_offset"].
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 * Return 0 for no match, -1 for partial match, > 0 for full match.
Bram Moolenaar946ffd42010-12-30 12:30:31 +01005129 * Return KEYLEN_REMOVED when a key code was deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005130 * With a match, the match is removed, the replacement code is inserted in
5131 * typebuf.tb_buf[] and the number of characters in typebuf.tb_buf[] is
5132 * returned.
Bram Moolenaara8c8a682012-02-05 22:05:48 +01005133 * When "buf" is not NULL, buf[bufsize] is used instead of typebuf.tb_buf[].
5134 * "buflen" is then the length of the string in buf[] and is updated for
5135 * inserts and deletes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 */
5137 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01005138check_termcode(
5139 int max_offset,
5140 char_u *buf,
5141 int bufsize,
5142 int *buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143{
5144 char_u *tp;
5145 char_u *p;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005146 int slen = 0; // init for GCC
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005147 int modslen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 int len;
Bram Moolenaar946ffd42010-12-30 12:30:31 +01005149 int retval = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150 int offset;
5151 char_u key_name[2];
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005152 int modifiers;
Bram Moolenaar090209b2017-06-23 22:45:33 +02005153 char_u *modifiers_start = NULL;
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005154 int key;
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02005155 int new_slen; // Length of what will replace the termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 char_u string[MAX_KEY_CODE_LEN + 1];
5157 int i, j;
5158 int idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 int cpo_koffset;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160
5161 cpo_koffset = (vim_strchr(p_cpo, CPO_KOFFSET) != NULL);
5162
5163 /*
5164 * Speed up the checks for terminal codes by gathering all first bytes
5165 * used in termleader[]. Often this is just a single <Esc>.
5166 */
5167 if (need_gather)
5168 gather_termleader();
5169
5170 /*
5171 * Check at several positions in typebuf.tb_buf[], to catch something like
5172 * "x<Up>" that can be mapped. Stop at max_offset, because characters
5173 * after that cannot be used for mapping, and with @r commands
Bram Moolenaare533bbe2013-03-16 14:33:36 +01005174 * typebuf.tb_buf[] can become very long.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 * This is used often, KEEP IT FAST!
5176 */
5177 for (offset = 0; offset < max_offset; ++offset)
5178 {
5179 if (buf == NULL)
5180 {
5181 if (offset >= typebuf.tb_len)
5182 break;
5183 tp = typebuf.tb_buf + typebuf.tb_off + offset;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005184 len = typebuf.tb_len - offset; // length of the input
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 }
5186 else
5187 {
Bram Moolenaara8c8a682012-02-05 22:05:48 +01005188 if (offset >= *buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 break;
5190 tp = buf + offset;
Bram Moolenaara8c8a682012-02-05 22:05:48 +01005191 len = *buflen - offset;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 }
5193
5194 /*
5195 * Don't check characters after K_SPECIAL, those are already
5196 * translated terminal chars (avoid translating ~@^Hx).
5197 */
5198 if (*tp == K_SPECIAL)
5199 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005200 offset += 2; // there are always 2 extra characters
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 continue;
5202 }
5203
5204 /*
5205 * Skip this position if the character does not appear as the first
5206 * character in term_strings. This speeds up a lot, since most
5207 * termcodes start with the same character (ESC or CSI).
5208 */
5209 i = *tp;
5210 for (p = termleader; *p && *p != i; ++p)
5211 ;
5212 if (*p == NUL)
5213 continue;
5214
5215 /*
5216 * Skip this position if p_ek is not set and tp[0] is an ESC and we
5217 * are in Insert mode.
5218 */
5219 if (*tp == ESC && !p_ek && (State & INSERT))
5220 continue;
5221
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005222 key_name[0] = NUL; // no key name found yet
5223 key_name[1] = NUL; // no key name found yet
5224 modifiers = 0; // no modifiers yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225
5226#ifdef FEAT_GUI
5227 if (gui.in_use)
5228 {
5229 /*
5230 * GUI special key codes are all of the form [CSI xx].
5231 */
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005232 if (*tp == CSI) // Special key from GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 {
5234 if (len < 3)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005235 return -1; // Shouldn't happen
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 slen = 3;
5237 key_name[0] = tp[1];
5238 key_name[1] = tp[2];
5239 }
5240 }
5241 else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005242#endif // FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 {
5244 for (idx = 0; idx < tc_len; ++idx)
5245 {
5246 /*
5247 * Ignore the entry if we are not at the start of
5248 * typebuf.tb_buf[]
5249 * and there are not enough characters to make a match.
5250 * But only when the 'K' flag is in 'cpoptions'.
5251 */
5252 slen = termcodes[idx].len;
Bram Moolenaara529ce02017-06-22 22:37:57 +02005253 modifiers_start = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 if (cpo_koffset && offset && len < slen)
5255 continue;
5256 if (STRNCMP(termcodes[idx].code, tp,
5257 (size_t)(slen > len ? len : slen)) == 0)
5258 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005259 if (len < slen) // got a partial sequence
5260 return -1; // need to get more chars
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261
5262 /*
5263 * When found a keypad key, check if there is another key
5264 * that matches and use that one. This makes <Home> to be
5265 * found instead of <kHome> when they produce the same
5266 * key code.
5267 */
5268 if (termcodes[idx].name[0] == 'K'
5269 && VIM_ISDIGIT(termcodes[idx].name[1]))
5270 {
5271 for (j = idx + 1; j < tc_len; ++j)
5272 if (termcodes[j].len == slen &&
5273 STRNCMP(termcodes[idx].code,
5274 termcodes[j].code, slen) == 0)
5275 {
5276 idx = j;
5277 break;
5278 }
5279 }
5280
5281 key_name[0] = termcodes[idx].name[0];
5282 key_name[1] = termcodes[idx].name[1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 break;
5284 }
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005285
5286 /*
5287 * Check for code with modifier, like xterm uses:
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005288 * <Esc>[123;*X (modslen == slen - 3)
5289 * Also <Esc>O*X and <M-O>*X (modslen == slen - 2).
5290 * When there is a modifier the * matches a number.
5291 * When there is no modifier the ;* or * is omitted.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005292 */
5293 if (termcodes[idx].modlen > 0)
5294 {
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005295 modslen = termcodes[idx].modlen;
5296 if (cpo_koffset && offset && len < modslen)
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005297 continue;
5298 if (STRNCMP(termcodes[idx].code, tp,
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005299 (size_t)(modslen > len ? len : modslen)) == 0)
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005300 {
5301 int n;
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005302
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005303 if (len <= modslen) // got a partial sequence
5304 return -1; // need to get more chars
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005305
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005306 if (tp[modslen] == termcodes[idx].code[slen - 1])
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005307 slen = modslen + 1; // no modifiers
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005308 else if (tp[modslen] != ';' && modslen == slen - 3)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005309 continue; // no match
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005310 else
5311 {
Bram Moolenaarbb7e1b42019-05-02 20:24:12 +02005312 // Skip over the digits, the final char must
5313 // follow. URXVT can use a negative value, thus
5314 // also accept '-'.
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02005315 for (j = slen - 2; j < len && (isdigit(tp[j])
Bram Moolenaarbb7e1b42019-05-02 20:24:12 +02005316 || tp[j] == '-' || tp[j] == ';'); ++j)
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005317 ;
5318 ++j;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005319 if (len < j) // got a partial sequence
5320 return -1; // need to get more chars
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005321 if (tp[j - 1] != termcodes[idx].code[slen - 1])
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005322 continue; // no match
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005323
Bram Moolenaara529ce02017-06-22 22:37:57 +02005324 modifiers_start = tp + slen - 2;
5325
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02005326 // Match! Convert modifier bits.
5327 n = atoi((char *)modifiers_start);
5328 modifiers |= decode_modifiers(n);
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005329
5330 slen = j;
5331 }
5332 key_name[0] = termcodes[idx].name[0];
5333 key_name[1] = termcodes[idx].name[1];
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005334 break;
5335 }
5336 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 }
5338 }
5339
5340#ifdef FEAT_TERMRESPONSE
Bram Moolenaar1dff76b2011-10-26 23:48:20 +02005341 if (key_name[0] == NUL
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005342 // Mouse codes of DEC and pterm start with <ESC>[. When
5343 // detecting the start of these mouse codes they might as well be
5344 // another key code or terminal response.
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005345# ifdef FEAT_MOUSE_DEC
5346 || key_name[0] == KS_DEC_MOUSE
Bram Moolenaare533bbe2013-03-16 14:33:36 +01005347# endif
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005348# ifdef FEAT_MOUSE_PTERM
5349 || key_name[0] == KS_PTERM_MOUSE
5350# endif
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005351 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 {
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005353 char_u *argp = tp[0] == ESC ? tp + 2 : tp + 1;
5354
5355 /*
5356 * Check for responses from the terminal starting with {lead}:
5357 * "<Esc>[" or CSI followed by [0-9>?]
Bram Moolenaar9584b312013-03-13 19:29:28 +01005358 *
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005359 * - Xterm version string: {lead}>{x};{vers};{y}c
Bram Moolenaar9584b312013-03-13 19:29:28 +01005360 * Also eat other possible responses to t_RV, rxvt returns
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005361 * "{lead}?1;2c".
Bram Moolenaar9584b312013-03-13 19:29:28 +01005362 *
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005363 * - Cursor position report: {lead}{row};{col}R
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005364 * The final byte must be 'R'. It is used for checking the
Bram Moolenaar9584b312013-03-13 19:29:28 +01005365 * ambiguous-width character state.
Bram Moolenaarba6ec182017-04-04 22:41:10 +02005366 *
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005367 * - window position reply: {lead}3;{x};{y}t
5368 *
5369 * - key with modifiers when modifyOtherKeys is enabled:
5370 * {lead}27;{modifier};{key}~
5371 * {lead}{key};{modifier}u
Bram Moolenaar9584b312013-03-13 19:29:28 +01005372 */
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005373 if (((tp[0] == ESC && len >= 3 && tp[1] == '[')
Bram Moolenaar46a75612013-05-15 14:22:41 +02005374 || (tp[0] == CSI && len >= 2))
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005375 && (VIM_ISDIGIT(*argp) || *argp == '>' || *argp == '?'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 {
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005377 int resp = handle_csi(tp, len, argp, offset, buf,
5378 bufsize, buflen, key_name, &slen);
5379 if (resp != 0)
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005380 {
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005381# ifdef DEBUG_TERMRESPONSE
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005382 if (resp == -1)
5383 LOG_TR(("Not enough characters for CSI sequence"));
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005384# endif
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005385 return resp;
Bram Moolenaar9584b312013-03-13 19:29:28 +01005386 }
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02005387 }
5388
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005389 // Check for fore/background color response from the terminal,
5390 // starting} with <Esc>] or OSC
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005391 else if ((*T_RBG != NUL || *T_RFG != NUL)
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02005392 && ((tp[0] == ESC && len >= 2 && tp[1] == ']')
5393 || tp[0] == OSC))
5394 {
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005395 if (handle_osc(tp, argp, len, key_name, &slen) == FAIL)
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02005396 return -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397 }
5398
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005399 // Check for key code response from xterm,
5400 // starting with <Esc>P or DCS
Bram Moolenaarafd78262019-05-10 23:10:31 +02005401 else if ((check_for_codes || rcs_status.tr_progress == STATUS_SENT)
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02005402 && ((tp[0] == ESC && len >= 2 && tp[1] == 'P')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403 || tp[0] == DCS))
5404 {
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005405 if (handle_dcs(tp, argp, len, key_name, &slen) == FAIL)
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02005406 return -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 }
5408 }
5409#endif
5410
5411 if (key_name[0] == NUL)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005412 continue; // No match at this position, try next one
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005414 // We only get here when we have a complete termcode match
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005416#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 /*
5418 * Only in the GUI: Fetch the pointer coordinates of the scroll event
5419 * so that we know which window to scroll later.
5420 */
5421 if (gui.in_use
5422 && key_name[0] == (int)KS_EXTRA
5423 && (key_name[1] == (int)KE_X1MOUSE
5424 || key_name[1] == (int)KE_X2MOUSE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02005425 || key_name[1] == (int)KE_MOUSELEFT
5426 || key_name[1] == (int)KE_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 || key_name[1] == (int)KE_MOUSEDOWN
5428 || key_name[1] == (int)KE_MOUSEUP))
5429 {
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005430 char_u bytes[6];
5431 int num_bytes = get_bytes_from_buf(tp + slen, bytes, 4);
5432
5433 if (num_bytes == -1) // not enough coordinates
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 return -1;
5435 mouse_col = 128 * (bytes[0] - ' ' - 1) + bytes[1] - ' ' - 1;
5436 mouse_row = 128 * (bytes[2] - ' ' - 1) + bytes[3] - ' ' - 1;
5437 slen += num_bytes;
5438 }
5439 else
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005440#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 /*
5442 * If it is a mouse click, get the coordinates.
5443 */
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005444 if (key_name[0] == KS_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005445#ifdef FEAT_MOUSE_GPM
Bram Moolenaarbedf0912019-05-04 16:58:45 +02005446 || key_name[0] == KS_GPM_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005447#endif
5448#ifdef FEAT_MOUSE_JSB
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005449 || key_name[0] == KS_JSBTERM_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005450#endif
5451#ifdef FEAT_MOUSE_NET
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005452 || key_name[0] == KS_NETTERM_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005453#endif
5454#ifdef FEAT_MOUSE_DEC
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005455 || key_name[0] == KS_DEC_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005456#endif
5457#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005458 || key_name[0] == KS_PTERM_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005459#endif
5460#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005461 || key_name[0] == KS_URXVT_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005462#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005463 || key_name[0] == KS_SGR_MOUSE
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01005464 || key_name[0] == KS_SGR_MOUSE_RELEASE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 {
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005466 if (check_termcode_mouse(tp, &slen, key_name, modifiers_start, idx,
5467 &modifiers) == -1)
5468 return -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470
5471#ifdef FEAT_GUI
5472 /*
5473 * If using the GUI, then we get menu and scrollbar events.
5474 *
5475 * A menu event is encoded as K_SPECIAL, KS_MENU, KE_FILLER followed by
5476 * four bytes which are to be taken as a pointer to the vimmenu_T
5477 * structure.
5478 *
Bram Moolenaarcf0dfa22007-05-10 18:52:16 +00005479 * A tab line event is encoded as K_SPECIAL KS_TABLINE nr, where "nr"
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005480 * is one byte with the tab index.
5481 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 * A scrollbar event is K_SPECIAL, KS_VER_SCROLLBAR, KE_FILLER followed
5483 * by one byte representing the scrollbar number, and then four bytes
5484 * representing a long_u which is the new value of the scrollbar.
5485 *
5486 * A horizontal scrollbar event is K_SPECIAL, KS_HOR_SCROLLBAR,
5487 * KE_FILLER followed by four bytes representing a long_u which is the
5488 * new value of the scrollbar.
5489 */
5490# ifdef FEAT_MENU
5491 else if (key_name[0] == (int)KS_MENU)
5492 {
5493 long_u val;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005494 int num_bytes = get_long_from_buf(tp + slen, &val);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 if (num_bytes == -1)
5497 return -1;
5498 current_menu = (vimmenu_T *)val;
5499 slen += num_bytes;
Bram Moolenaar968bbbe2006-08-16 19:41:08 +00005500
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005501 // The menu may have been deleted right after it was used, check
5502 // for that.
Bram Moolenaar968bbbe2006-08-16 19:41:08 +00005503 if (check_menu_pointer(root_menu, current_menu) == FAIL)
5504 {
5505 key_name[0] = KS_EXTRA;
5506 key_name[1] = (int)KE_IGNORE;
5507 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 }
5509# endif
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005510# ifdef FEAT_GUI_TABLINE
5511 else if (key_name[0] == (int)KS_TABLINE)
5512 {
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005513 // Selecting tabline tab or using its menu.
5514 char_u bytes[6];
5515 int num_bytes = get_bytes_from_buf(tp + slen, bytes, 1);
5516
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005517 if (num_bytes == -1)
5518 return -1;
5519 current_tab = (int)bytes[0];
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005520 if (current_tab == 255) // -1 in a byte gives 255
Bram Moolenaar07354542007-09-15 12:07:46 +00005521 current_tab = -1;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005522 slen += num_bytes;
5523 }
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00005524 else if (key_name[0] == (int)KS_TABMENU)
5525 {
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005526 // Selecting tabline tab or using its menu.
5527 char_u bytes[6];
5528 int num_bytes = get_bytes_from_buf(tp + slen, bytes, 2);
5529
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00005530 if (num_bytes == -1)
5531 return -1;
5532 current_tab = (int)bytes[0];
5533 current_tabmenu = (int)bytes[1];
5534 slen += num_bytes;
5535 }
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005536# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537# ifndef USE_ON_FLY_SCROLL
5538 else if (key_name[0] == (int)KS_VER_SCROLLBAR)
5539 {
5540 long_u val;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005541 char_u bytes[6];
5542 int num_bytes;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005544 // Get the last scrollbar event in the queue of the same type
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 j = 0;
5546 for (i = 0; tp[j] == CSI && tp[j + 1] == KS_VER_SCROLLBAR
5547 && tp[j + 2] != NUL; ++i)
5548 {
5549 j += 3;
5550 num_bytes = get_bytes_from_buf(tp + j, bytes, 1);
5551 if (num_bytes == -1)
5552 break;
5553 if (i == 0)
5554 current_scrollbar = (int)bytes[0];
5555 else if (current_scrollbar != (int)bytes[0])
5556 break;
5557 j += num_bytes;
5558 num_bytes = get_long_from_buf(tp + j, &val);
5559 if (num_bytes == -1)
5560 break;
5561 scrollbar_value = val;
5562 j += num_bytes;
5563 slen = j;
5564 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005565 if (i == 0) // not enough characters to make one
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 return -1;
5567 }
5568 else if (key_name[0] == (int)KS_HOR_SCROLLBAR)
5569 {
5570 long_u val;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005571 int num_bytes;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005573 // Get the last horiz. scrollbar event in the queue
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 j = 0;
5575 for (i = 0; tp[j] == CSI && tp[j + 1] == KS_HOR_SCROLLBAR
5576 && tp[j + 2] != NUL; ++i)
5577 {
5578 j += 3;
5579 num_bytes = get_long_from_buf(tp + j, &val);
5580 if (num_bytes == -1)
5581 break;
5582 scrollbar_value = val;
5583 j += num_bytes;
5584 slen = j;
5585 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005586 if (i == 0) // not enough characters to make one
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 return -1;
5588 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005589# endif // !USE_ON_FLY_SCROLL
5590#endif // FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005592 /*
5593 * Change <xHome> to <Home>, <xUp> to <Up>, etc.
5594 */
5595 key = handle_x_keys(TERMCAP2KEY(key_name[0], key_name[1]));
5596
5597 /*
5598 * Add any modifier codes to our string.
5599 */
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02005600 new_slen = modifiers2keycode(modifiers, &key, string);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005601
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005602 // Finally, add the special key code to our string
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005603 key_name[0] = KEY2TERMCAP0(key);
5604 key_name[1] = KEY2TERMCAP1(key);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 if (key_name[0] == KS_KEY)
Bram Moolenaar6768a332009-01-22 17:33:49 +00005606 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005607 // from ":set <M-b>=xx"
Bram Moolenaar6768a332009-01-22 17:33:49 +00005608 if (has_mbyte)
5609 new_slen += (*mb_char2bytes)(key_name[1], string + new_slen);
5610 else
Bram Moolenaar6768a332009-01-22 17:33:49 +00005611 string[new_slen++] = key_name[1];
5612 }
Bram Moolenaar946ffd42010-12-30 12:30:31 +01005613 else if (new_slen == 0 && key_name[0] == KS_EXTRA
5614 && key_name[1] == KE_IGNORE)
5615 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005616 // Do not put K_IGNORE into the buffer, do return KEYLEN_REMOVED
5617 // to indicate what happened.
Bram Moolenaar946ffd42010-12-30 12:30:31 +01005618 retval = KEYLEN_REMOVED;
5619 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 else
5621 {
5622 string[new_slen++] = K_SPECIAL;
5623 string[new_slen++] = key_name[0];
5624 string[new_slen++] = key_name[1];
5625 }
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02005626 if (put_string_in_typebuf(offset, slen, string, new_slen,
5627 buf, bufsize, buflen) == FAIL)
5628 return -1;
5629 return retval == 0 ? (len + new_slen - slen + offset) : retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 }
5631
Bram Moolenaar2951b772013-07-03 12:45:31 +02005632#ifdef FEAT_TERMRESPONSE
Bram Moolenaarb255b902018-04-24 21:40:10 +02005633 LOG_TR(("normal character"));
Bram Moolenaar2951b772013-07-03 12:45:31 +02005634#endif
5635
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005636 return 0; // no match found
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637}
5638
Bram Moolenaar9377df32017-10-15 13:22:01 +02005639#if (defined(FEAT_TERMINAL) && defined(FEAT_TERMRESPONSE)) || defined(PROTO)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005640/*
5641 * Get the text foreground color, if known.
5642 */
5643 void
Bram Moolenaar00ce63d2017-10-15 21:44:45 +02005644term_get_fg_color(char_u *r, char_u *g, char_u *b)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005645{
Bram Moolenaarafd78262019-05-10 23:10:31 +02005646 if (rfg_status.tr_progress == STATUS_GOT)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005647 {
5648 *r = fg_r;
5649 *g = fg_g;
5650 *b = fg_b;
5651 }
5652}
5653
5654/*
5655 * Get the text background color, if known.
5656 */
5657 void
Bram Moolenaar00ce63d2017-10-15 21:44:45 +02005658term_get_bg_color(char_u *r, char_u *g, char_u *b)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005659{
Bram Moolenaarafd78262019-05-10 23:10:31 +02005660 if (rbg_status.tr_progress == STATUS_GOT)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005661 {
5662 *r = bg_r;
5663 *g = bg_g;
5664 *b = bg_b;
5665 }
5666}
5667#endif
5668
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669/*
5670 * Replace any terminal code strings in from[] with the equivalent internal
5671 * vim representation. This is used for the "from" and "to" part of a
5672 * mapping, and the "to" part of a menu command.
5673 * Any strings like "<C-UP>" are also replaced, unless 'cpoptions' contains
5674 * '<'.
5675 * K_SPECIAL by itself is replaced by K_SPECIAL KS_SPECIAL KE_FILLER.
5676 *
5677 * The replacement is done in result[] and finally copied into allocated
5678 * memory. If this all works well *bufp is set to the allocated memory and a
5679 * pointer to it is returned. If something fails *bufp is set to NULL and from
5680 * is returned.
5681 *
Bram Moolenaar459fd782019-10-13 16:43:39 +02005682 * CTRL-V characters are removed. When "flags" has REPTERM_FROM_PART, a
5683 * trailing CTRL-V is included, otherwise it is removed (for ":map xx ^V", maps
5684 * xx to nothing). When 'cpoptions' does not contain 'B', a backslash can be
5685 * used instead of a CTRL-V.
5686 *
5687 * Flags:
5688 * REPTERM_FROM_PART see above
5689 * REPTERM_DO_LT also translate <lt>
5690 * REPTERM_SPECIAL always accept <key> notation
5691 * REPTERM_NO_SIMPLIFY do not simplify <C-H> to 0x08 and set 8th bit for <A-x>
5692 *
5693 * "did_simplify" is set when some <C-H> or <A-x> code was simplified, unless
5694 * it is NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 */
Bram Moolenaar9c102382006-05-03 21:26:49 +00005696 char_u *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01005697replace_termcodes(
5698 char_u *from,
5699 char_u **bufp,
Bram Moolenaar459fd782019-10-13 16:43:39 +02005700 int flags,
5701 int *did_simplify)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702{
5703 int i;
5704 int slen;
5705 int key;
5706 int dlen = 0;
5707 char_u *src;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005708 int do_backslash; // backslash is a special character
5709 int do_special; // recognize <> key codes
5710 int do_key_code; // recognize raw key codes
5711 char_u *result; // buffer for resulting string
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712
5713 do_backslash = (vim_strchr(p_cpo, CPO_BSLASH) == NULL);
Bram Moolenaar459fd782019-10-13 16:43:39 +02005714 do_special = (vim_strchr(p_cpo, CPO_SPECI) == NULL)
5715 || (flags & REPTERM_SPECIAL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 do_key_code = (vim_strchr(p_cpo, CPO_KEYCODE) == NULL);
5717
5718 /*
5719 * Allocate space for the translation. Worst case a single character is
5720 * replaced by 6 bytes (shifted special key), plus a NUL at the end.
5721 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02005722 result = alloc(STRLEN(from) * 6 + 1);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005723 if (result == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 {
5725 *bufp = NULL;
5726 return from;
5727 }
5728
5729 src = from;
5730
5731 /*
5732 * Check for #n at start only: function key n
5733 */
Bram Moolenaar459fd782019-10-13 16:43:39 +02005734 if ((flags & REPTERM_FROM_PART) && src[0] == '#' && VIM_ISDIGIT(src[1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 {
5736 result[dlen++] = K_SPECIAL;
5737 result[dlen++] = 'k';
5738 if (src[1] == '0')
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005739 result[dlen++] = ';'; // #0 is F10 is "k;"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005741 result[dlen++] = src[1]; // #3 is F3 is "k3"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 src += 2;
5743 }
5744
5745 /*
5746 * Copy each byte from *from to result[dlen]
5747 */
5748 while (*src != NUL)
5749 {
5750 /*
5751 * If 'cpoptions' does not contain '<', check for special key codes,
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02005752 * like "<C-S-LeftMouse>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 */
Bram Moolenaar459fd782019-10-13 16:43:39 +02005754 if (do_special && ((flags & REPTERM_DO_LT)
5755 || STRNCMP(src, "<lt>", 4) != 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 {
5757#ifdef FEAT_EVAL
5758 /*
5759 * Replace <SID> by K_SNR <script-nr> _.
5760 * (room: 5 * 6 = 30 bytes; needed: 3 + <nr> + 1 <= 14)
5761 */
5762 if (STRNICMP(src, "<SID>", 5) == 0)
5763 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02005764 if (current_sctx.sc_sid <= 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005765 emsg(_(e_usingsid));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 else
5767 {
5768 src += 5;
5769 result[dlen++] = K_SPECIAL;
5770 result[dlen++] = (int)KS_EXTRA;
5771 result[dlen++] = (int)KE_SNR;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02005772 sprintf((char *)result + dlen, "%ld",
5773 (long)current_sctx.sc_sid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 dlen += (int)STRLEN(result + dlen);
5775 result[dlen++] = '_';
5776 continue;
5777 }
5778 }
5779#endif
5780
Bram Moolenaarebe9d342020-05-30 21:52:54 +02005781 slen = trans_special(&src, result + dlen, FSK_KEYCODE
5782 | ((flags & REPTERM_NO_SIMPLIFY) ? 0 : FSK_SIMPLIFY),
5783 did_simplify);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 if (slen)
5785 {
5786 dlen += slen;
5787 continue;
5788 }
5789 }
5790
5791 /*
5792 * If 'cpoptions' does not contain 'k', see if it's an actual key-code.
5793 * Note that this is also checked after replacing the <> form.
5794 * Single character codes are NOT replaced (e.g. ^H or DEL), because
5795 * it could be a character in the file.
5796 */
5797 if (do_key_code)
5798 {
5799 i = find_term_bykeys(src);
5800 if (i >= 0)
5801 {
5802 result[dlen++] = K_SPECIAL;
5803 result[dlen++] = termcodes[i].name[0];
5804 result[dlen++] = termcodes[i].name[1];
5805 src += termcodes[i].len;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005806 // If terminal code matched, continue after it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 continue;
5808 }
5809 }
5810
5811#ifdef FEAT_EVAL
5812 if (do_special)
5813 {
5814 char_u *p, *s, len;
5815
5816 /*
5817 * Replace <Leader> by the value of "mapleader".
5818 * Replace <LocalLeader> by the value of "maplocalleader".
5819 * If "mapleader" or "maplocalleader" isn't set use a backslash.
5820 */
5821 if (STRNICMP(src, "<Leader>", 8) == 0)
5822 {
5823 len = 8;
5824 p = get_var_value((char_u *)"g:mapleader");
5825 }
5826 else if (STRNICMP(src, "<LocalLeader>", 13) == 0)
5827 {
5828 len = 13;
5829 p = get_var_value((char_u *)"g:maplocalleader");
5830 }
5831 else
5832 {
5833 len = 0;
5834 p = NULL;
5835 }
5836 if (len != 0)
5837 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005838 // Allow up to 8 * 6 characters for "mapleader".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 if (p == NULL || *p == NUL || STRLEN(p) > 8 * 6)
5840 s = (char_u *)"\\";
5841 else
5842 s = p;
5843 while (*s != NUL)
5844 result[dlen++] = *s++;
5845 src += len;
5846 continue;
5847 }
5848 }
5849#endif
5850
5851 /*
5852 * Remove CTRL-V and ignore the next character.
5853 * For "from" side the CTRL-V at the end is included, for the "to"
5854 * part it is removed.
5855 * If 'cpoptions' does not contain 'B', also accept a backslash.
5856 */
5857 key = *src;
5858 if (key == Ctrl_V || (do_backslash && key == '\\'))
5859 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005860 ++src; // skip CTRL-V or backslash
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861 if (*src == NUL)
5862 {
Bram Moolenaar459fd782019-10-13 16:43:39 +02005863 if (flags & REPTERM_FROM_PART)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 result[dlen++] = key;
5865 break;
5866 }
5867 }
5868
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005869 // skip multibyte char correctly
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005870 for (i = (*mb_ptr2len)(src); i > 0; --i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 {
5872 /*
5873 * If the character is K_SPECIAL, replace it with K_SPECIAL
5874 * KS_SPECIAL KE_FILLER.
5875 * If compiled with the GUI replace CSI with K_CSI.
5876 */
5877 if (*src == K_SPECIAL)
5878 {
5879 result[dlen++] = K_SPECIAL;
5880 result[dlen++] = KS_SPECIAL;
5881 result[dlen++] = KE_FILLER;
5882 }
5883# ifdef FEAT_GUI
5884 else if (*src == CSI)
5885 {
5886 result[dlen++] = K_SPECIAL;
5887 result[dlen++] = KS_EXTRA;
5888 result[dlen++] = (int)KE_CSI;
5889 }
5890# endif
5891 else
5892 result[dlen++] = *src;
5893 ++src;
5894 }
5895 }
5896 result[dlen] = NUL;
5897
5898 /*
5899 * Copy the new string to allocated memory.
5900 * If this fails, just return from.
5901 */
5902 if ((*bufp = vim_strsave(result)) != NULL)
5903 from = *bufp;
5904 vim_free(result);
5905 return from;
5906}
5907
5908/*
5909 * Find a termcode with keys 'src' (must be NUL terminated).
5910 * Return the index in termcodes[], or -1 if not found.
5911 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02005912 static int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01005913find_term_bykeys(char_u *src)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914{
5915 int i;
Bram Moolenaar38f5f952012-01-26 13:01:59 +01005916 int slen = (int)STRLEN(src);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917
5918 for (i = 0; i < tc_len; ++i)
5919 {
Bram Moolenaar5af7d712012-01-20 17:15:51 +01005920 if (slen == termcodes[i].len
5921 && STRNCMP(termcodes[i].code, src, (size_t)slen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 return i;
5923 }
5924 return -1;
5925}
5926
5927/*
5928 * Gather the first characters in the terminal key codes into a string.
5929 * Used to speed up check_termcode().
5930 */
5931 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01005932gather_termleader(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933{
5934 int i;
5935 int len = 0;
5936
5937#ifdef FEAT_GUI
5938 if (gui.in_use)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005939 termleader[len++] = CSI; // the GUI codes are not in termcodes[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940#endif
5941#ifdef FEAT_TERMRESPONSE
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02005942 if (check_for_codes || *T_CRS != NUL)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005943 termleader[len++] = DCS; // the termcode response starts with DCS
5944 // in 8-bit mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945#endif
5946 termleader[len] = NUL;
5947
5948 for (i = 0; i < tc_len; ++i)
5949 if (vim_strchr(termleader, termcodes[i].code[0]) == NULL)
5950 {
5951 termleader[len++] = termcodes[i].code[0];
5952 termleader[len] = NUL;
5953 }
5954
5955 need_gather = FALSE;
5956}
5957
5958/*
5959 * Show all termcodes (for ":set termcap")
5960 * This code looks a lot like showoptions(), but is different.
5961 */
5962 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01005963show_termcodes(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005964{
5965 int col;
5966 int *items;
5967 int item_count;
5968 int run;
5969 int row, rows;
5970 int cols;
5971 int i;
5972 int len;
5973
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005974#define INC3 27 // try to make three columns
5975#define INC2 40 // try to make two columns
5976#define GAP 2 // spaces between columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00005977
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005978 if (tc_len == 0) // no terminal codes (must be GUI)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979 return;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005980 items = ALLOC_MULT(int, tc_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 if (items == NULL)
5982 return;
5983
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005984 // Highlight title
Bram Moolenaar32526b32019-01-19 17:43:09 +01005985 msg_puts_title(_("\n--- Terminal keys ---"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986
5987 /*
5988 * do the loop two times:
5989 * 1. display the short items (non-strings and short strings)
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005990 * 2. display the medium items (medium length strings)
5991 * 3. display the long items (remaining strings)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992 */
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005993 for (run = 1; run <= 3 && !got_int; ++run)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 {
5995 /*
5996 * collect the items in items[]
5997 */
5998 item_count = 0;
5999 for (i = 0; i < tc_len; i++)
6000 {
6001 len = show_one_termcode(termcodes[i].name,
6002 termcodes[i].code, FALSE);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006003 if (len <= INC3 - GAP ? run == 1
6004 : len <= INC2 - GAP ? run == 2
6005 : run == 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006 items[item_count++] = i;
6007 }
6008
6009 /*
6010 * display the items
6011 */
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006012 if (run <= 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 {
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006014 cols = (Columns + GAP) / (run == 1 ? INC3 : INC2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 if (cols == 0)
6016 cols = 1;
6017 rows = (item_count + cols - 1) / cols;
6018 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006019 else // run == 3
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 rows = item_count;
6021 for (row = 0; row < rows && !got_int; ++row)
6022 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006023 msg_putchar('\n'); // go to next line
6024 if (got_int) // 'q' typed in more
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025 break;
6026 col = 0;
6027 for (i = row; i < item_count; i += rows)
6028 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006029 msg_col = col; // make columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 show_one_termcode(termcodes[items[i]].name,
6031 termcodes[items[i]].code, TRUE);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006032 if (run == 2)
6033 col += INC2;
6034 else
6035 col += INC3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 }
6037 out_flush();
6038 ui_breakcheck();
6039 }
6040 }
6041 vim_free(items);
6042}
6043
6044/*
6045 * Show one termcode entry.
6046 * Output goes into IObuff[]
6047 */
6048 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006049show_one_termcode(char_u *name, char_u *code, int printit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050{
6051 char_u *p;
6052 int len;
6053
6054 if (name[0] > '~')
6055 {
6056 IObuff[0] = ' ';
6057 IObuff[1] = ' ';
6058 IObuff[2] = ' ';
6059 IObuff[3] = ' ';
6060 }
6061 else
6062 {
6063 IObuff[0] = 't';
6064 IObuff[1] = '_';
6065 IObuff[2] = name[0];
6066 IObuff[3] = name[1];
6067 }
6068 IObuff[4] = ' ';
6069
6070 p = get_special_key_name(TERMCAP2KEY(name[0], name[1]), 0);
6071 if (p[1] != 't')
6072 STRCPY(IObuff + 5, p);
6073 else
6074 IObuff[5] = NUL;
6075 len = (int)STRLEN(IObuff);
6076 do
6077 IObuff[len++] = ' ';
6078 while (len < 17);
6079 IObuff[len] = NUL;
6080 if (code == NULL)
6081 len += 4;
6082 else
6083 len += vim_strsize(code);
6084
6085 if (printit)
6086 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01006087 msg_puts((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088 if (code == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006089 msg_puts("NULL");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090 else
6091 msg_outtrans(code);
6092 }
6093 return len;
6094}
6095
6096#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
6097/*
6098 * For Xterm >= 140 compiled with OPT_TCAP_QUERY: Obtain the actually used
6099 * termcap codes from the terminal itself.
6100 * We get them one by one to avoid a very long response string.
6101 */
Bram Moolenaar4e067c82014-07-30 17:21:58 +02006102static int xt_index_in = 0;
6103static int xt_index_out = 0;
6104
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006106req_codes_from_term(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107{
6108 xt_index_out = 0;
6109 xt_index_in = 0;
6110 req_more_codes_from_term();
6111}
6112
6113 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006114req_more_codes_from_term(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115{
6116 char buf[11];
6117 int old_idx = xt_index_out;
6118
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006119 // Don't do anything when going to exit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006120 if (exiting)
6121 return;
6122
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006123 // Send up to 10 more requests out than we received. Avoid sending too
6124 // many, there can be a buffer overflow somewhere.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 while (xt_index_out < xt_index_in + 10 && key_names[xt_index_out] != NULL)
6126 {
Bram Moolenaarb255b902018-04-24 21:40:10 +02006127 char *key_name = key_names[xt_index_out];
Bram Moolenaar2951b772013-07-03 12:45:31 +02006128
Bram Moolenaarb255b902018-04-24 21:40:10 +02006129 LOG_TR(("Requesting XT %d: %s", xt_index_out, key_name));
6130 sprintf(buf, "\033P+q%02x%02x\033\\", key_name[0], key_name[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131 out_str_nf((char_u *)buf);
6132 ++xt_index_out;
6133 }
6134
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006135 // Send the codes out right away.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 if (xt_index_out != old_idx)
6137 out_flush();
6138}
6139
6140/*
6141 * Decode key code response from xterm: '<Esc>P1+r<name>=<string><Esc>\'.
6142 * A "0" instead of the "1" indicates a code that isn't supported.
6143 * Both <name> and <string> are encoded in hex.
6144 * "code" points to the "0" or "1".
6145 */
6146 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006147got_code_from_term(char_u *code, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148{
6149#define XT_LEN 100
6150 char_u name[3];
6151 char_u str[XT_LEN];
6152 int i;
6153 int j = 0;
6154 int c;
6155
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006156 // A '1' means the code is supported, a '0' means it isn't.
6157 // When half the length is > XT_LEN we can't use it.
6158 // Our names are currently all 2 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 if (code[0] == '1' && code[7] == '=' && len / 2 < XT_LEN)
6160 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006161 // Get the name from the response and find it in the table.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 name[0] = hexhex2nr(code + 3);
6163 name[1] = hexhex2nr(code + 5);
6164 name[2] = NUL;
6165 for (i = 0; key_names[i] != NULL; ++i)
6166 {
6167 if (STRCMP(key_names[i], name) == 0)
6168 {
6169 xt_index_in = i;
6170 break;
6171 }
6172 }
Bram Moolenaar2951b772013-07-03 12:45:31 +02006173
Bram Moolenaarb255b902018-04-24 21:40:10 +02006174 LOG_TR(("Received XT %d: %s", xt_index_in, (char *)name));
6175
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 if (key_names[i] != NULL)
6177 {
6178 for (i = 8; (c = hexhex2nr(code + i)) >= 0; i += 2)
6179 str[j++] = c;
6180 str[j] = NUL;
6181 if (name[0] == 'C' && name[1] == 'o')
6182 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006183 // Color count is not a key code.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184 i = atoi((char *)str);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02006185 may_adjust_color_count(i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 }
6187 else
6188 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006189 // First delete any existing entry with the same code.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 i = find_term_bykeys(str);
6191 if (i >= 0)
6192 del_termcode_idx(i);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006193 add_termcode(name, str, ATC_FROM_TERM);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 }
6195 }
6196 }
6197
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006198 // May request more codes now that we received one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 ++xt_index_in;
6200 req_more_codes_from_term();
6201}
6202
6203/*
6204 * Check if there are any unanswered requests and deal with them.
6205 * This is called before starting an external program or getting direct
6206 * keyboard input. We don't want responses to be send to that program or
6207 * handled as typed text.
6208 */
6209 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006210check_for_codes_from_term(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211{
6212 int c;
6213
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006214 // If no codes requested or all are answered, no need to wait.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 if (xt_index_out == 0 || xt_index_out == xt_index_in)
6216 return;
6217
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006218 // Vgetc() will check for and handle any response.
6219 // Keep calling vpeekc() until we don't get any responses.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 ++no_mapping;
6221 ++allow_keys;
6222 for (;;)
6223 {
6224 c = vpeekc();
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006225 if (c == NUL) // nothing available
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 break;
6227
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006228 // If a response is recognized it's replaced with K_IGNORE, must read
6229 // it from the input stream. If there is no K_IGNORE we can't do
6230 // anything, break here (there might be some responses further on, but
6231 // we don't want to throw away any typed chars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 if (c != K_SPECIAL && c != K_IGNORE)
6233 break;
6234 c = vgetc();
6235 if (c != K_IGNORE)
6236 {
6237 vungetc(c);
6238 break;
6239 }
6240 }
6241 --no_mapping;
6242 --allow_keys;
6243}
6244#endif
6245
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006246#if (defined(MSWIN) && (!defined(FEAT_GUI) || defined(VIMDLL))) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247static char ksme_str[20];
6248static char ksmr_str[20];
6249static char ksmd_str[20];
6250
6251/*
6252 * For Win32 console: update termcap codes for existing console attributes.
6253 */
6254 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006255update_tcap(int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256{
6257 struct builtin_term *p;
6258
6259 p = find_builtin_term(DEFAULT_TERM);
6260 sprintf(ksme_str, IF_EB("\033|%dm", ESC_STR "|%dm"), attr);
6261 sprintf(ksmd_str, IF_EB("\033|%dm", ESC_STR "|%dm"),
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006262 attr | 0x08); // FOREGROUND_INTENSITY
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 sprintf(ksmr_str, IF_EB("\033|%dm", ESC_STR "|%dm"),
6264 ((attr & 0x0F) << 4) | ((attr & 0xF0) >> 4));
6265
6266 while (p->bt_string != NULL)
6267 {
6268 if (p->bt_entry == (int)KS_ME)
6269 p->bt_string = &ksme_str[0];
6270 else if (p->bt_entry == (int)KS_MR)
6271 p->bt_string = &ksmr_str[0];
6272 else if (p->bt_entry == (int)KS_MD)
6273 p->bt_string = &ksmd_str[0];
6274 ++p;
6275 }
6276}
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006277
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006278# ifdef FEAT_TERMGUICOLORS
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006279# define KSSIZE 20
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006280struct ks_tbl_s
6281{
Bram Moolenaard4f73432018-09-21 12:24:12 +02006282 int code; // value of KS_
6283 char *vtp; // code in vtp mode
6284 char *vtp2; // code in vtp2 mode
6285 char buf[KSSIZE]; // save buffer in non-vtp mode
6286 char vbuf[KSSIZE]; // save buffer in vtp mode
6287 char v2buf[KSSIZE]; // save buffer in vtp2 mode
6288 char arr[KSSIZE]; // real buffer
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006289};
6290
6291static struct ks_tbl_s ks_tbl[] =
6292{
Bram Moolenaard4f73432018-09-21 12:24:12 +02006293 {(int)KS_ME, "\033|0m", "\033|0m"}, // normal
6294 {(int)KS_MR, "\033|7m", "\033|7m"}, // reverse
6295 {(int)KS_MD, "\033|1m", "\033|1m"}, // bold
6296 {(int)KS_SO, "\033|91m", "\033|91m"}, // standout: bright red text
6297 {(int)KS_SE, "\033|39m", "\033|39m"}, // standout end: default color
6298 {(int)KS_CZH, "\033|95m", "\033|95m"}, // italic: bright magenta text
6299 {(int)KS_CZR, "\033|0m", "\033|0m"}, // italic end
6300 {(int)KS_US, "\033|4m", "\033|4m"}, // underscore
6301 {(int)KS_UE, "\033|24m", "\033|24m"}, // underscore end
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006302# ifdef TERMINFO
Bram Moolenaard4f73432018-09-21 12:24:12 +02006303 {(int)KS_CAB, "\033|%p1%db", "\033|%p14%dm"}, // set background color
6304 {(int)KS_CAF, "\033|%p1%df", "\033|%p13%dm"}, // set foreground color
Bram Moolenaar6982f422019-02-16 16:48:01 +01006305 {(int)KS_CS, "\033|%p1%d;%p2%dR", "\033|%p1%d;%p2%dR"},
6306 {(int)KS_CSV, "\033|%p1%d;%p2%dV", "\033|%p1%d;%p2%dV"},
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006307# else
Bram Moolenaard4f73432018-09-21 12:24:12 +02006308 {(int)KS_CAB, "\033|%db", "\033|4%dm"}, // set background color
6309 {(int)KS_CAF, "\033|%df", "\033|3%dm"}, // set foreground color
Bram Moolenaar6982f422019-02-16 16:48:01 +01006310 {(int)KS_CS, "\033|%d;%dR", "\033|%d;%dR"},
6311 {(int)KS_CSV, "\033|%d;%dV", "\033|%d;%dV"},
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006312# endif
Bram Moolenaard4f73432018-09-21 12:24:12 +02006313 {(int)KS_CCO, "256", "256"}, // colors
6314 {(int)KS_NAME} // terminator
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006315};
6316
6317 static struct builtin_term *
6318find_first_tcap(
6319 char_u *name,
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006320 int code)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006321{
6322 struct builtin_term *p;
6323
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006324 for (p = find_builtin_term(name); p->bt_string != NULL; ++p)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006325 if (p->bt_entry == code)
6326 return p;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006327 return NULL;
6328}
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006329# endif
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006330
6331/*
6332 * For Win32 console: replace the sequence immediately after termguicolors.
6333 */
6334 void
6335swap_tcap(void)
6336{
6337# ifdef FEAT_TERMGUICOLORS
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006338 static int init_done = FALSE;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006339 static int curr_mode;
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006340 struct ks_tbl_s *ks;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006341 struct builtin_term *bt;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006342 int mode;
6343 enum
6344 {
6345 CMODEINDEX,
6346 CMODE24,
6347 CMODE256
6348 };
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006349
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006350 // buffer initialization
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006351 if (!init_done)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006352 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006353 for (ks = ks_tbl; ks->code != (int)KS_NAME; ks++)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006354 {
6355 bt = find_first_tcap(DEFAULT_TERM, ks->code);
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006356 if (bt != NULL)
6357 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006358 STRNCPY(ks->buf, bt->bt_string, KSSIZE);
6359 STRNCPY(ks->vbuf, ks->vtp, KSSIZE);
6360 STRNCPY(ks->v2buf, ks->vtp2, KSSIZE);
6361
6362 STRNCPY(ks->arr, bt->bt_string, KSSIZE);
6363 bt->bt_string = &ks->arr[0];
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006364 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006365 }
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006366 init_done = TRUE;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006367 curr_mode = CMODEINDEX;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006368 }
6369
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006370 if (p_tgc)
6371 mode = CMODE24;
6372 else if (t_colors >= 256)
6373 mode = CMODE256;
6374 else
6375 mode = CMODEINDEX;
6376
6377 for (ks = ks_tbl; ks->code != (int)KS_NAME; ks++)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006378 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006379 bt = find_first_tcap(DEFAULT_TERM, ks->code);
6380 if (bt != NULL)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006381 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006382 switch (curr_mode)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006383 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006384 case CMODEINDEX:
6385 STRNCPY(&ks->buf[0], bt->bt_string, KSSIZE);
6386 break;
6387 case CMODE24:
6388 STRNCPY(&ks->vbuf[0], bt->bt_string, KSSIZE);
6389 break;
6390 default:
6391 STRNCPY(&ks->v2buf[0], bt->bt_string, KSSIZE);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006392 }
6393 }
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006394 }
6395
6396 if (mode != curr_mode)
6397 {
6398 for (ks = ks_tbl; ks->code != (int)KS_NAME; ks++)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006399 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006400 bt = find_first_tcap(DEFAULT_TERM, ks->code);
6401 if (bt != NULL)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006402 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006403 switch (mode)
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006404 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006405 case CMODEINDEX:
6406 STRNCPY(bt->bt_string, &ks->buf[0], KSSIZE);
6407 break;
6408 case CMODE24:
6409 STRNCPY(bt->bt_string, &ks->vbuf[0], KSSIZE);
6410 break;
6411 default:
6412 STRNCPY(bt->bt_string, &ks->v2buf[0], KSSIZE);
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006413 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006414 }
6415 }
6416
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006417 curr_mode = mode;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006418 }
6419# endif
6420}
6421
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422#endif
Bram Moolenaarab302212016-04-26 20:59:29 +02006423
Bram Moolenaar61be73b2016-04-29 22:59:22 +02006424#if defined(FEAT_GUI) || defined(FEAT_TERMGUICOLORS) || defined(PROTO)
Bram Moolenaarab302212016-04-26 20:59:29 +02006425 static int
6426hex_digit(int c)
6427{
6428 if (isdigit(c))
6429 return c - '0';
6430 c = TOLOWER_ASC(c);
6431 if (c >= 'a' && c <= 'f')
6432 return c - 'a' + 10;
6433 return 0x1ffffff;
6434}
6435
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006436# ifdef VIMDLL
6437 static guicolor_T
6438gui_adjust_rgb(guicolor_T c)
6439{
6440 if (gui.in_use)
6441 return c;
6442 else
6443 return ((c & 0xff) << 16) | (c & 0x00ff00) | ((c >> 16) & 0xff);
6444}
6445# else
6446# define gui_adjust_rgb(c) (c)
6447# endif
6448
Bram Moolenaarab302212016-04-26 20:59:29 +02006449 guicolor_T
6450gui_get_color_cmn(char_u *name)
6451{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006452 // On MS-Windows an RGB macro is available and it produces 0x00bbggrr color
6453 // values as used by the MS-Windows GDI api. It should be used only for
6454 // MS-Windows GDI builds.
Bram Moolenaar4f974752019-02-17 17:44:42 +01006455# if defined(RGB) && defined(MSWIN) && !defined(FEAT_GUI)
Bram Moolenaar28726652017-01-06 18:16:19 +01006456# undef RGB
6457# endif
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006458# ifndef RGB
6459# define RGB(r, g, b) ((r<<16) | (g<<8) | (b))
6460# endif
6461# define LINE_LEN 100
Bram Moolenaarab302212016-04-26 20:59:29 +02006462 FILE *fd;
6463 char line[LINE_LEN];
6464 char_u *fname;
6465 int r, g, b, i;
6466 guicolor_T color;
6467
6468 struct rgbcolor_table_S {
6469 char_u *color_name;
6470 guicolor_T color;
6471 };
6472
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006473 // Only non X11 colors (not present in rgb.txt) and colors in
6474 // color_names[], useful when $VIMRUNTIME is not found,.
Bram Moolenaarab302212016-04-26 20:59:29 +02006475 static struct rgbcolor_table_S rgb_table[] = {
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006476 {(char_u *)"black", RGB(0x00, 0x00, 0x00)},
6477 {(char_u *)"blue", RGB(0x00, 0x00, 0xFF)},
6478 {(char_u *)"brown", RGB(0xA5, 0x2A, 0x2A)},
6479 {(char_u *)"cyan", RGB(0x00, 0xFF, 0xFF)},
6480 {(char_u *)"darkblue", RGB(0x00, 0x00, 0x8B)},
6481 {(char_u *)"darkcyan", RGB(0x00, 0x8B, 0x8B)},
6482 {(char_u *)"darkgray", RGB(0xA9, 0xA9, 0xA9)},
6483 {(char_u *)"darkgreen", RGB(0x00, 0x64, 0x00)},
6484 {(char_u *)"darkgrey", RGB(0xA9, 0xA9, 0xA9)},
6485 {(char_u *)"darkmagenta", RGB(0x8B, 0x00, 0x8B)},
6486 {(char_u *)"darkred", RGB(0x8B, 0x00, 0x00)},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006487 {(char_u *)"darkyellow", RGB(0x8B, 0x8B, 0x00)}, // No X11
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006488 {(char_u *)"gray", RGB(0xBE, 0xBE, 0xBE)},
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006489 {(char_u *)"green", RGB(0x00, 0xFF, 0x00)},
6490 {(char_u *)"grey", RGB(0xBE, 0xBE, 0xBE)},
Bram Moolenaar21477462016-08-08 20:43:27 +02006491 {(char_u *)"grey40", RGB(0x66, 0x66, 0x66)},
Bram Moolenaarecadf432018-03-20 11:17:04 +01006492 {(char_u *)"grey50", RGB(0x7F, 0x7F, 0x7F)},
Bram Moolenaarca8942c2016-07-19 23:36:31 +02006493 {(char_u *)"grey90", RGB(0xE5, 0xE5, 0xE5)},
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006494 {(char_u *)"lightblue", RGB(0xAD, 0xD8, 0xE6)},
6495 {(char_u *)"lightcyan", RGB(0xE0, 0xFF, 0xFF)},
6496 {(char_u *)"lightgray", RGB(0xD3, 0xD3, 0xD3)},
6497 {(char_u *)"lightgreen", RGB(0x90, 0xEE, 0x90)},
6498 {(char_u *)"lightgrey", RGB(0xD3, 0xD3, 0xD3)},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006499 {(char_u *)"lightmagenta", RGB(0xFF, 0x8B, 0xFF)}, // No X11
6500 {(char_u *)"lightred", RGB(0xFF, 0x8B, 0x8B)}, // No X11
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006501 {(char_u *)"lightyellow", RGB(0xFF, 0xFF, 0xE0)},
6502 {(char_u *)"magenta", RGB(0xFF, 0x00, 0xFF)},
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006503 {(char_u *)"red", RGB(0xFF, 0x00, 0x00)},
Bram Moolenaarca8942c2016-07-19 23:36:31 +02006504 {(char_u *)"seagreen", RGB(0x2E, 0x8B, 0x57)},
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006505 {(char_u *)"white", RGB(0xFF, 0xFF, 0xFF)},
6506 {(char_u *)"yellow", RGB(0xFF, 0xFF, 0x00)},
Bram Moolenaarab302212016-04-26 20:59:29 +02006507 };
6508
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006509 static struct rgbcolor_table_S *colornames_table;
6510 static int size = 0;
Bram Moolenaarab302212016-04-26 20:59:29 +02006511
6512 if (name[0] == '#' && STRLEN(name) == 7)
6513 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006514 // Name is in "#rrggbb" format
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006515 color = RGB(((hex_digit(name[1]) << 4) + hex_digit(name[2])),
Bram Moolenaarab302212016-04-26 20:59:29 +02006516 ((hex_digit(name[3]) << 4) + hex_digit(name[4])),
6517 ((hex_digit(name[5]) << 4) + hex_digit(name[6])));
6518 if (color > 0xffffff)
6519 return INVALCOLOR;
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006520 return gui_adjust_rgb(color);
Bram Moolenaarab302212016-04-26 20:59:29 +02006521 }
6522
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006523 // Check if the name is one of the colors we know
Bram Moolenaarab302212016-04-26 20:59:29 +02006524 for (i = 0; i < (int)(sizeof(rgb_table) / sizeof(rgb_table[0])); i++)
6525 if (STRICMP(name, rgb_table[i].color_name) == 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006526 return gui_adjust_rgb(rgb_table[i].color);
Bram Moolenaarab302212016-04-26 20:59:29 +02006527
6528 /*
Bram Moolenaar0ea21e42019-02-12 20:46:48 +01006529 * Last attempt. Look in the file "$VIMRUNTIME/rgb.txt".
Bram Moolenaarab302212016-04-26 20:59:29 +02006530 */
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006531 if (size == 0)
Bram Moolenaarab302212016-04-26 20:59:29 +02006532 {
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006533 int counting;
Bram Moolenaarab302212016-04-26 20:59:29 +02006534
Bram Moolenaar0ea21e42019-02-12 20:46:48 +01006535 // colornames_table not yet initialized
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006536 fname = expand_env_save((char_u *)"$VIMRUNTIME/rgb.txt");
6537 if (fname == NULL)
6538 return INVALCOLOR;
Bram Moolenaarab302212016-04-26 20:59:29 +02006539
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006540 fd = fopen((char *)fname, "rt");
6541 vim_free(fname);
6542 if (fd == NULL)
Bram Moolenaarab302212016-04-26 20:59:29 +02006543 {
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006544 if (p_verbose > 1)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006545 verb_msg(_("Cannot open $VIMRUNTIME/rgb.txt"));
Bram Moolenaar0ea21e42019-02-12 20:46:48 +01006546 size = -1; // don't try again
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006547 return INVALCOLOR;
Bram Moolenaarab302212016-04-26 20:59:29 +02006548 }
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006549
6550 for (counting = 1; counting >= 0; --counting)
6551 {
6552 if (!counting)
6553 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006554 colornames_table = ALLOC_MULT(struct rgbcolor_table_S, size);
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006555 if (colornames_table == NULL)
6556 {
6557 fclose(fd);
6558 return INVALCOLOR;
6559 }
6560 rewind(fd);
6561 }
6562 size = 0;
6563
6564 while (!feof(fd))
6565 {
6566 size_t len;
6567 int pos;
6568
Bram Moolenaar42335f52018-09-13 15:33:43 +02006569 vim_ignoredp = fgets(line, LINE_LEN, fd);
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006570 len = strlen(line);
6571
6572 if (len <= 1 || line[len - 1] != '\n')
6573 continue;
6574
6575 line[len - 1] = '\0';
6576
6577 i = sscanf(line, "%d %d %d %n", &r, &g, &b, &pos);
6578 if (i != 3)
6579 continue;
6580
6581 if (!counting)
6582 {
6583 char_u *s = vim_strsave((char_u *)line + pos);
6584
6585 if (s == NULL)
Bram Moolenaar2e45d212016-07-22 22:12:38 +02006586 {
6587 fclose(fd);
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006588 return INVALCOLOR;
Bram Moolenaar2e45d212016-07-22 22:12:38 +02006589 }
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006590 colornames_table[size].color_name = s;
6591 colornames_table[size].color = (guicolor_T)RGB(r, g, b);
6592 }
6593 size++;
Bram Moolenaar0ea21e42019-02-12 20:46:48 +01006594
6595 // The distributed rgb.txt has less than 1000 entries. Limit to
6596 // 10000, just in case the file was messed up.
6597 if (size == 10000)
6598 break;
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006599 }
6600 }
6601 fclose(fd);
Bram Moolenaarab302212016-04-26 20:59:29 +02006602 }
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006603
6604 for (i = 0; i < size; i++)
6605 if (STRICMP(name, colornames_table[i].color_name) == 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006606 return gui_adjust_rgb(colornames_table[i].color);
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006607
Bram Moolenaarab302212016-04-26 20:59:29 +02006608 return INVALCOLOR;
6609}
Bram Moolenaar26af85d2017-07-23 16:45:10 +02006610
6611 guicolor_T
6612gui_get_rgb_color_cmn(int r, int g, int b)
6613{
6614 guicolor_T color = RGB(r, g, b);
6615
6616 if (color > 0xffffff)
6617 return INVALCOLOR;
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006618 return gui_adjust_rgb(color);
Bram Moolenaar26af85d2017-07-23 16:45:10 +02006619}
Bram Moolenaarab302212016-04-26 20:59:29 +02006620#endif
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006621
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006622#if (defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))) || defined(FEAT_TERMINAL) \
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006623 || defined(PROTO)
6624static int cube_value[] = {
6625 0x00, 0x5F, 0x87, 0xAF, 0xD7, 0xFF
6626};
6627
6628static int grey_ramp[] = {
6629 0x08, 0x12, 0x1C, 0x26, 0x30, 0x3A, 0x44, 0x4E, 0x58, 0x62, 0x6C, 0x76,
6630 0x80, 0x8A, 0x94, 0x9E, 0xA8, 0xB2, 0xBC, 0xC6, 0xD0, 0xDA, 0xE4, 0xEE
6631};
6632
Bram Moolenaar9894e392018-05-05 14:29:06 +02006633static char_u ansi_table[16][4] = {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006634// R G B idx
6635 { 0, 0, 0, 1}, // black
6636 {224, 0, 0, 2}, // dark red
6637 { 0, 224, 0, 3}, // dark green
6638 {224, 224, 0, 4}, // dark yellow / brown
6639 { 0, 0, 224, 5}, // dark blue
6640 {224, 0, 224, 6}, // dark magenta
6641 { 0, 224, 224, 7}, // dark cyan
6642 {224, 224, 224, 8}, // light grey
6643
6644 {128, 128, 128, 9}, // dark grey
6645 {255, 64, 64, 10}, // light red
6646 { 64, 255, 64, 11}, // light green
6647 {255, 255, 64, 12}, // yellow
6648 { 64, 64, 255, 13}, // light blue
6649 {255, 64, 255, 14}, // light magenta
6650 { 64, 255, 255, 15}, // light cyan
6651 {255, 255, 255, 16}, // white
6652};
6653
Bram Moolenaare5886cc2020-05-21 20:10:04 +02006654#define ANSI_INDEX_NONE 0
6655
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006656 void
Bram Moolenaar9894e392018-05-05 14:29:06 +02006657cterm_color2rgb(int nr, char_u *r, char_u *g, char_u *b, char_u *ansi_idx)
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006658{
6659 int idx;
6660
6661 if (nr < 16)
6662 {
6663 *r = ansi_table[nr][0];
6664 *g = ansi_table[nr][1];
6665 *b = ansi_table[nr][2];
6666 *ansi_idx = ansi_table[nr][3];
6667 }
6668 else if (nr < 232)
6669 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006670 // 216 color cube
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006671 idx = nr - 16;
6672 *r = cube_value[idx / 36 % 6];
6673 *g = cube_value[idx / 6 % 6];
6674 *b = cube_value[idx % 6];
Bram Moolenaare5886cc2020-05-21 20:10:04 +02006675 *ansi_idx = ANSI_INDEX_NONE;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006676 }
6677 else if (nr < 256)
6678 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006679 // 24 grey scale ramp
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006680 idx = nr - 232;
6681 *r = grey_ramp[idx];
6682 *g = grey_ramp[idx];
6683 *b = grey_ramp[idx];
Bram Moolenaare5886cc2020-05-21 20:10:04 +02006684 *ansi_idx = ANSI_INDEX_NONE;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006685 }
6686 else
6687 {
6688 *r = 0;
6689 *g = 0;
6690 *b = 0;
Bram Moolenaare5886cc2020-05-21 20:10:04 +02006691 *ansi_idx = ANSI_INDEX_NONE;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006692 }
6693}
6694#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01006695
Bram Moolenaarf4140482020-02-15 23:06:45 +01006696/*
6697 * Replace K_BS by <BS> and K_DEL by <DEL>
6698 */
6699 void
6700term_replace_bs_del_keycode(char_u *ta_buf, int ta_len, int len)
6701{
6702 int i;
6703 int c;
6704
6705 for (i = ta_len; i < ta_len + len; ++i)
6706 {
6707 if (ta_buf[i] == CSI && len - i > 2)
6708 {
6709 c = TERMCAP2KEY(ta_buf[i + 1], ta_buf[i + 2]);
6710 if (c == K_DEL || c == K_KDEL || c == K_BS)
6711 {
6712 mch_memmove(ta_buf + i + 1, ta_buf + i + 3,
6713 (size_t)(len - i - 2));
6714 if (c == K_DEL || c == K_KDEL)
6715 ta_buf[i] = DEL;
6716 else
6717 ta_buf[i] = Ctrl_H;
6718 len -= 2;
6719 }
6720 }
6721 else if (ta_buf[i] == '\r')
6722 ta_buf[i] = '\n';
6723 if (has_mbyte)
6724 i += (*mb_ptr2len_len)(ta_buf + i, ta_len + len - i) - 1;
6725 }
6726}