blob: 4d32c043a32d3792290f2980f7619c420a90d2e8 [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
Bram Moolenaar86394aa2020-09-05 14:27:24 +020046# define TPUTSFUNCAST (int (*)(int))
Bram Moolenaar071d4272004-06-13 20:20:40 +000047# 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
Bram Moolenaare3f915d2020-07-14 23:02:44 +0200784# if defined(ALL_BUILTIN_TCAPS)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785/*
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")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 {(int)KS_CL, IF_EB("\033H\033J", ESC_STR "H" ESC_STR_nc "J")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809 {(int)KS_MS, "y"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810# endif
811
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200812# if defined(UNIX) || defined(ALL_BUILTIN_TCAPS) || defined(SOME_BUILTIN_TCAPS)
Bram Moolenaarb2fa54a2016-04-22 21:11:09 +0200813 {(int)KS_NAME, "xterm"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 {(int)KS_CE, IF_EB("\033[K", ESC_STR "[K")},
815 {(int)KS_AL, IF_EB("\033[L", ESC_STR "[L")},
816# ifdef TERMINFO
817 {(int)KS_CAL, IF_EB("\033[%p1%dL", ESC_STR "[%p1%dL")},
818# else
819 {(int)KS_CAL, IF_EB("\033[%dL", ESC_STR "[%dL")},
820# endif
821 {(int)KS_DL, IF_EB("\033[M", ESC_STR "[M")},
822# ifdef TERMINFO
823 {(int)KS_CDL, IF_EB("\033[%p1%dM", ESC_STR "[%p1%dM")},
824# else
825 {(int)KS_CDL, IF_EB("\033[%dM", ESC_STR "[%dM")},
826# endif
827# ifdef TERMINFO
828 {(int)KS_CS, IF_EB("\033[%i%p1%d;%p2%dr",
829 ESC_STR "[%i%p1%d;%p2%dr")},
830# else
831 {(int)KS_CS, IF_EB("\033[%i%d;%dr", ESC_STR "[%i%d;%dr")},
832# endif
833 {(int)KS_CL, IF_EB("\033[H\033[2J", ESC_STR "[H" ESC_STR_nc "[2J")},
834 {(int)KS_CD, IF_EB("\033[J", ESC_STR "[J")},
835 {(int)KS_ME, IF_EB("\033[m", ESC_STR "[m")},
836 {(int)KS_MR, IF_EB("\033[7m", ESC_STR "[7m")},
837 {(int)KS_MD, IF_EB("\033[1m", ESC_STR "[1m")},
838 {(int)KS_UE, IF_EB("\033[m", ESC_STR "[m")},
839 {(int)KS_US, IF_EB("\033[4m", ESC_STR "[4m")},
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +0200840 {(int)KS_STE, IF_EB("\033[29m", ESC_STR "[29m")},
841 {(int)KS_STS, IF_EB("\033[9m", ESC_STR "[9m")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 {(int)KS_MS, "y"},
843 {(int)KS_UT, "y"},
844 {(int)KS_LE, "\b"},
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +0200845 {(int)KS_VI, IF_EB("\033[?25l", ESC_STR "[?25l")},
846 {(int)KS_VE, IF_EB("\033[?25h", ESC_STR "[?25h")},
Bram Moolenaar93c92ef2017-08-19 21:11:57 +0200847 {(int)KS_VS, IF_EB("\033[?12h", ESC_STR "[?12h")},
Bram Moolenaarce1c3272017-08-20 15:05:15 +0200848 {(int)KS_CVS, IF_EB("\033[?12l", ESC_STR "[?12l")},
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +0200849# ifdef TERMINFO
850 {(int)KS_CSH, IF_EB("\033[%p1%d q", ESC_STR "[%p1%d q")},
851# else
852 {(int)KS_CSH, IF_EB("\033[%d q", ESC_STR "[%d q")},
853# endif
Bram Moolenaar4db25542017-08-28 22:43:05 +0200854 {(int)KS_CRC, IF_EB("\033[?12$p", ESC_STR "[?12$p")},
Bram Moolenaar3eee06e2017-08-19 19:40:50 +0200855 {(int)KS_CRS, IF_EB("\033P$q q\033\\", ESC_STR "P$q q" ESC_STR "\\")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856# ifdef TERMINFO
857 {(int)KS_CM, IF_EB("\033[%i%p1%d;%p2%dH",
858 ESC_STR "[%i%p1%d;%p2%dH")},
859# else
860 {(int)KS_CM, IF_EB("\033[%i%d;%dH", ESC_STR "[%i%d;%dH")},
861# endif
862 {(int)KS_SR, IF_EB("\033M", ESC_STR "M")},
863# ifdef TERMINFO
864 {(int)KS_CRI, IF_EB("\033[%p1%dC", ESC_STR "[%p1%dC")},
865# else
866 {(int)KS_CRI, IF_EB("\033[%dC", ESC_STR "[%dC")},
867# endif
868 {(int)KS_KS, IF_EB("\033[?1h\033=", ESC_STR "[?1h" ESC_STR_nc "=")},
869 {(int)KS_KE, IF_EB("\033[?1l\033>", ESC_STR "[?1l" ESC_STR_nc ">")},
870# ifdef FEAT_XTERM_SAVE
871 {(int)KS_TI, IF_EB("\0337\033[?47h", ESC_STR "7" ESC_STR_nc "[?47h")},
Bram Moolenaard02e5082020-02-08 14:22:53 +0100872 {(int)KS_TE, IF_EB("\033[?47l\0338",
873 ESC_STR_nc "[?47l" ESC_STR_nc "8")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874# endif
Bram Moolenaar4b570182019-10-20 19:53:22 +0200875 {(int)KS_CTI, IF_EB("\033[>4;2m", ESC_STR_nc "[>4;2m")},
876 {(int)KS_CTE, IF_EB("\033[>4;m", ESC_STR_nc "[>4;m")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 {(int)KS_CIS, IF_EB("\033]1;", ESC_STR "]1;")},
878 {(int)KS_CIE, "\007"},
879 {(int)KS_TS, IF_EB("\033]2;", ESC_STR "]2;")},
880 {(int)KS_FS, "\007"},
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +0200881 {(int)KS_CSC, IF_EB("\033]12;", ESC_STR "]12;")},
882 {(int)KS_CEC, "\007"},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883# ifdef TERMINFO
884 {(int)KS_CWS, IF_EB("\033[8;%p1%d;%p2%dt",
885 ESC_STR "[8;%p1%d;%p2%dt")},
886 {(int)KS_CWP, IF_EB("\033[3;%p1%d;%p2%dt",
887 ESC_STR "[3;%p1%d;%p2%dt")},
Bram Moolenaarba6ec182017-04-04 22:41:10 +0200888 {(int)KS_CGP, IF_EB("\033[13t", ESC_STR "[13t")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889# else
890 {(int)KS_CWS, IF_EB("\033[8;%d;%dt", ESC_STR "[8;%d;%dt")},
891 {(int)KS_CWP, IF_EB("\033[3;%d;%dt", ESC_STR "[3;%d;%dt")},
Bram Moolenaarba6ec182017-04-04 22:41:10 +0200892 {(int)KS_CGP, IF_EB("\033[13t", ESC_STR "[13t")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893# endif
894 {(int)KS_CRV, IF_EB("\033[>c", ESC_STR "[>c")},
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +0200895 {(int)KS_RFG, IF_EB("\033]10;?\007", ESC_STR "]10;?\007")},
Bram Moolenaarb5c32652015-06-25 17:03:36 +0200896 {(int)KS_RBG, IF_EB("\033]11;?\007", ESC_STR "]11;?\007")},
Bram Moolenaar9584b312013-03-13 19:29:28 +0100897 {(int)KS_U7, IF_EB("\033[6n", ESC_STR "[6n")},
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200898# ifdef FEAT_TERMGUICOLORS
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100899 // These are printf strings, not terminal codes.
Bram Moolenaarb2fa54a2016-04-22 21:11:09 +0200900 {(int)KS_8F, IF_EB("\033[38;2;%lu;%lu;%lum", ESC_STR "[38;2;%lu;%lu;%lum")},
901 {(int)KS_8B, IF_EB("\033[48;2;%lu;%lu;%lum", ESC_STR "[48;2;%lu;%lu;%lum")},
Bram Moolenaare023e882020-05-31 16:42:30 +0200902 {(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 +0200903# endif
Bram Moolenaare023e882020-05-31 16:42:30 +0200904 {(int)KS_CAU, IF_EB("\033[58;5;%dm", ESC_STR "[58;5;%dm")},
Bram Moolenaarec2da362017-01-21 20:04:22 +0100905 {(int)KS_CBE, IF_EB("\033[?2004h", ESC_STR "[?2004h")},
906 {(int)KS_CBD, IF_EB("\033[?2004l", ESC_STR "[?2004l")},
Bram Moolenaar40385db2018-08-07 22:31:44 +0200907 {(int)KS_CST, IF_EB("\033[22;2t", ESC_STR "[22;2t")},
908 {(int)KS_CRT, IF_EB("\033[23;2t", ESC_STR "[23;2t")},
909 {(int)KS_SSI, IF_EB("\033[22;1t", ESC_STR "[22;1t")},
910 {(int)KS_SRI, IF_EB("\033[23;1t", ESC_STR "[23;1t")},
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000911
912 {K_UP, IF_EB("\033O*A", ESC_STR "O*A")},
913 {K_DOWN, IF_EB("\033O*B", ESC_STR "O*B")},
914 {K_RIGHT, IF_EB("\033O*C", ESC_STR "O*C")},
915 {K_LEFT, IF_EB("\033O*D", ESC_STR "O*D")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100916 // An extra set of cursor keys for vt100 mode
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000917 {K_XUP, IF_EB("\033[1;*A", ESC_STR "[1;*A")},
918 {K_XDOWN, IF_EB("\033[1;*B", ESC_STR "[1;*B")},
919 {K_XRIGHT, IF_EB("\033[1;*C", ESC_STR "[1;*C")},
920 {K_XLEFT, IF_EB("\033[1;*D", ESC_STR "[1;*D")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100921 // An extra set of function keys for vt100 mode
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000922 {K_XF1, IF_EB("\033O*P", ESC_STR "O*P")},
923 {K_XF2, IF_EB("\033O*Q", ESC_STR "O*Q")},
924 {K_XF3, IF_EB("\033O*R", ESC_STR "O*R")},
925 {K_XF4, IF_EB("\033O*S", ESC_STR "O*S")},
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000926 {K_F1, IF_EB("\033[11;*~", ESC_STR "[11;*~")},
927 {K_F2, IF_EB("\033[12;*~", ESC_STR "[12;*~")},
928 {K_F3, IF_EB("\033[13;*~", ESC_STR "[13;*~")},
929 {K_F4, IF_EB("\033[14;*~", ESC_STR "[14;*~")},
930 {K_F5, IF_EB("\033[15;*~", ESC_STR "[15;*~")},
931 {K_F6, IF_EB("\033[17;*~", ESC_STR "[17;*~")},
932 {K_F7, IF_EB("\033[18;*~", ESC_STR "[18;*~")},
933 {K_F8, IF_EB("\033[19;*~", ESC_STR "[19;*~")},
934 {K_F9, IF_EB("\033[20;*~", ESC_STR "[20;*~")},
935 {K_F10, IF_EB("\033[21;*~", ESC_STR "[21;*~")},
936 {K_F11, IF_EB("\033[23;*~", ESC_STR "[23;*~")},
937 {K_F12, IF_EB("\033[24;*~", ESC_STR "[24;*~")},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 {K_S_TAB, IF_EB("\033[Z", ESC_STR "[Z")},
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000939 {K_HELP, IF_EB("\033[28;*~", ESC_STR "[28;*~")},
940 {K_UNDO, IF_EB("\033[26;*~", ESC_STR "[26;*~")},
941 {K_INS, IF_EB("\033[2;*~", ESC_STR "[2;*~")},
942 {K_HOME, IF_EB("\033[1;*H", ESC_STR "[1;*H")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100943 // {K_S_HOME, IF_EB("\033O2H", ESC_STR "O2H")},
944 // {K_C_HOME, IF_EB("\033O5H", ESC_STR "O5H")},
Bram Moolenaar68b76a62005-03-25 21:53:48 +0000945 {K_KHOME, IF_EB("\033[1;*~", ESC_STR "[1;*~")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100946 {K_XHOME, IF_EB("\033O*H", ESC_STR "O*H")}, // other Home
947 {K_ZHOME, IF_EB("\033[7;*~", ESC_STR "[7;*~")}, // other Home
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000948 {K_END, IF_EB("\033[1;*F", ESC_STR "[1;*F")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100949 // {K_S_END, IF_EB("\033O2F", ESC_STR "O2F")},
950 // {K_C_END, IF_EB("\033O5F", ESC_STR "O5F")},
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000951 {K_KEND, IF_EB("\033[4;*~", ESC_STR "[4;*~")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100952 {K_XEND, IF_EB("\033O*F", ESC_STR "O*F")}, // other End
Bram Moolenaar68b76a62005-03-25 21:53:48 +0000953 {K_ZEND, IF_EB("\033[8;*~", ESC_STR "[8;*~")},
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000954 {K_PAGEUP, IF_EB("\033[5;*~", ESC_STR "[5;*~")},
955 {K_PAGEDOWN, IF_EB("\033[6;*~", ESC_STR "[6;*~")},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100956 {K_KPLUS, IF_EB("\033O*k", ESC_STR "O*k")}, // keypad plus
957 {K_KMINUS, IF_EB("\033O*m", ESC_STR "O*m")}, // keypad minus
958 {K_KDIVIDE, IF_EB("\033O*o", ESC_STR "O*o")}, // keypad /
959 {K_KMULTIPLY, IF_EB("\033O*j", ESC_STR "O*j")}, // keypad *
960 {K_KENTER, IF_EB("\033O*M", ESC_STR "O*M")}, // keypad Enter
961 {K_KPOINT, IF_EB("\033O*n", ESC_STR "O*n")}, // keypad .
962 {K_K0, IF_EB("\033O*p", ESC_STR "O*p")}, // keypad 0
963 {K_K1, IF_EB("\033O*q", ESC_STR "O*q")}, // keypad 1
964 {K_K2, IF_EB("\033O*r", ESC_STR "O*r")}, // keypad 2
965 {K_K3, IF_EB("\033O*s", ESC_STR "O*s")}, // keypad 3
966 {K_K4, IF_EB("\033O*t", ESC_STR "O*t")}, // keypad 4
967 {K_K5, IF_EB("\033O*u", ESC_STR "O*u")}, // keypad 5
968 {K_K6, IF_EB("\033O*v", ESC_STR "O*v")}, // keypad 6
969 {K_K7, IF_EB("\033O*w", ESC_STR "O*w")}, // keypad 7
970 {K_K8, IF_EB("\033O*x", ESC_STR "O*x")}, // keypad 8
971 {K_K9, IF_EB("\033O*y", ESC_STR "O*y")}, // keypad 9
972 {K_KDEL, IF_EB("\033[3;*~", ESC_STR "[3;*~")}, // keypad Del
973 {K_PS, IF_EB("\033[200~", ESC_STR "[200~")}, // paste start
974 {K_PE, IF_EB("\033[201~", ESC_STR "[201~")}, // paste end
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975
976 {BT_EXTRA_KEYS, ""},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100977 {TERMCAP2KEY('k', '0'), IF_EB("\033[10;*~", ESC_STR "[10;*~")}, // F0
978 {TERMCAP2KEY('F', '3'), IF_EB("\033[25;*~", ESC_STR "[25;*~")}, // F13
979 // F14 and F15 are missing, because they send the same codes as the undo
980 // and help key, although they don't work on all keyboards.
981 {TERMCAP2KEY('F', '6'), IF_EB("\033[29;*~", ESC_STR "[29;*~")}, // F16
982 {TERMCAP2KEY('F', '7'), IF_EB("\033[31;*~", ESC_STR "[31;*~")}, // F17
983 {TERMCAP2KEY('F', '8'), IF_EB("\033[32;*~", ESC_STR "[32;*~")}, // F18
984 {TERMCAP2KEY('F', '9'), IF_EB("\033[33;*~", ESC_STR "[33;*~")}, // F19
985 {TERMCAP2KEY('F', 'A'), IF_EB("\033[34;*~", ESC_STR "[34;*~")}, // F20
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000986
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100987 {TERMCAP2KEY('F', 'B'), IF_EB("\033[42;*~", ESC_STR "[42;*~")}, // F21
988 {TERMCAP2KEY('F', 'C'), IF_EB("\033[43;*~", ESC_STR "[43;*~")}, // F22
989 {TERMCAP2KEY('F', 'D'), IF_EB("\033[44;*~", ESC_STR "[44;*~")}, // F23
990 {TERMCAP2KEY('F', 'E'), IF_EB("\033[45;*~", ESC_STR "[45;*~")}, // F24
991 {TERMCAP2KEY('F', 'F'), IF_EB("\033[46;*~", ESC_STR "[46;*~")}, // F25
992 {TERMCAP2KEY('F', 'G'), IF_EB("\033[47;*~", ESC_STR "[47;*~")}, // F26
993 {TERMCAP2KEY('F', 'H'), IF_EB("\033[48;*~", ESC_STR "[48;*~")}, // F27
994 {TERMCAP2KEY('F', 'I'), IF_EB("\033[49;*~", ESC_STR "[49;*~")}, // F28
995 {TERMCAP2KEY('F', 'J'), IF_EB("\033[50;*~", ESC_STR "[50;*~")}, // F29
996 {TERMCAP2KEY('F', 'K'), IF_EB("\033[51;*~", ESC_STR "[51;*~")}, // F30
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000997
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +0100998 {TERMCAP2KEY('F', 'L'), IF_EB("\033[52;*~", ESC_STR "[52;*~")}, // F31
999 {TERMCAP2KEY('F', 'M'), IF_EB("\033[53;*~", ESC_STR "[53;*~")}, // F32
1000 {TERMCAP2KEY('F', 'N'), IF_EB("\033[54;*~", ESC_STR "[54;*~")}, // F33
1001 {TERMCAP2KEY('F', 'O'), IF_EB("\033[55;*~", ESC_STR "[55;*~")}, // F34
1002 {TERMCAP2KEY('F', 'P'), IF_EB("\033[56;*~", ESC_STR "[56;*~")}, // F35
1003 {TERMCAP2KEY('F', 'Q'), IF_EB("\033[57;*~", ESC_STR "[57;*~")}, // F36
1004 {TERMCAP2KEY('F', 'R'), IF_EB("\033[58;*~", ESC_STR "[58;*~")}, // F37
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005# endif
1006
1007# if defined(UNIX) || defined(ALL_BUILTIN_TCAPS)
1008/*
1009 * iris-ansi for Silicon Graphics machines.
1010 */
1011 {(int)KS_NAME, "iris-ansi"},
1012 {(int)KS_CE, "\033[K"},
1013 {(int)KS_CD, "\033[J"},
1014 {(int)KS_AL, "\033[L"},
1015# ifdef TERMINFO
1016 {(int)KS_CAL, "\033[%p1%dL"},
1017# else
1018 {(int)KS_CAL, "\033[%dL"},
1019# endif
1020 {(int)KS_DL, "\033[M"},
1021# ifdef TERMINFO
1022 {(int)KS_CDL, "\033[%p1%dM"},
1023# else
1024 {(int)KS_CDL, "\033[%dM"},
1025# endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001026#if 0 // The scroll region is not working as Vim expects.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027# ifdef TERMINFO
1028 {(int)KS_CS, "\033[%i%p1%d;%p2%dr"},
1029# else
1030 {(int)KS_CS, "\033[%i%d;%dr"},
1031# endif
1032#endif
1033 {(int)KS_CL, "\033[H\033[2J"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001034 {(int)KS_VE, "\033[9/y\033[12/y"}, // These aren't documented
1035 {(int)KS_VS, "\033[10/y\033[=1h\033[=2l"}, // These aren't documented
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036 {(int)KS_TI, "\033[=6h"},
1037 {(int)KS_TE, "\033[=6l"},
1038 {(int)KS_SE, "\033[21;27m"},
1039 {(int)KS_SO, "\033[1;7m"},
1040 {(int)KS_ME, "\033[m"},
1041 {(int)KS_MR, "\033[7m"},
1042 {(int)KS_MD, "\033[1m"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001043 {(int)KS_CCO, "8"}, // allow 8 colors
1044 {(int)KS_CZH, "\033[3m"}, // italic mode on
1045 {(int)KS_CZR, "\033[23m"}, // italic mode off
1046 {(int)KS_US, "\033[4m"}, // underline on
1047 {(int)KS_UE, "\033[24m"}, // underline off
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048# ifdef TERMINFO
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001049 {(int)KS_CAB, "\033[4%p1%dm"}, // set background color (ANSI)
1050 {(int)KS_CAF, "\033[3%p1%dm"}, // set foreground color (ANSI)
1051 {(int)KS_CSB, "\033[102;%p1%dm"}, // set screen background color
1052 {(int)KS_CSF, "\033[101;%p1%dm"}, // set screen foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053# else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001054 {(int)KS_CAB, "\033[4%dm"}, // set background color (ANSI)
1055 {(int)KS_CAF, "\033[3%dm"}, // set foreground color (ANSI)
1056 {(int)KS_CSB, "\033[102;%dm"}, // set screen background color
1057 {(int)KS_CSF, "\033[101;%dm"}, // set screen foreground color
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058# endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001059 {(int)KS_MS, "y"}, // guessed
1060 {(int)KS_UT, "y"}, // guessed
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 {(int)KS_LE, "\b"},
1062# ifdef TERMINFO
1063 {(int)KS_CM, "\033[%i%p1%d;%p2%dH"},
1064# else
1065 {(int)KS_CM, "\033[%i%d;%dH"},
1066# endif
1067 {(int)KS_SR, "\033M"},
1068# ifdef TERMINFO
1069 {(int)KS_CRI, "\033[%p1%dC"},
1070# else
1071 {(int)KS_CRI, "\033[%dC"},
1072# endif
1073 {(int)KS_CIS, "\033P3.y"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001074 {(int)KS_CIE, "\234"}, // ST "String Terminator"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 {(int)KS_TS, "\033P1.y"},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001076 {(int)KS_FS, "\234"}, // ST "String Terminator"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077# ifdef TERMINFO
1078 {(int)KS_CWS, "\033[203;%p1%d;%p2%d/y"},
1079 {(int)KS_CWP, "\033[205;%p1%d;%p2%d/y"},
1080# else
1081 {(int)KS_CWS, "\033[203;%d;%d/y"},
1082 {(int)KS_CWP, "\033[205;%d;%d/y"},
1083# endif
1084 {K_UP, "\033[A"},
1085 {K_DOWN, "\033[B"},
1086 {K_LEFT, "\033[D"},
1087 {K_RIGHT, "\033[C"},
1088 {K_S_UP, "\033[161q"},
1089 {K_S_DOWN, "\033[164q"},
1090 {K_S_LEFT, "\033[158q"},
1091 {K_S_RIGHT, "\033[167q"},
1092 {K_F1, "\033[001q"},
1093 {K_F2, "\033[002q"},
1094 {K_F3, "\033[003q"},
1095 {K_F4, "\033[004q"},
1096 {K_F5, "\033[005q"},
1097 {K_F6, "\033[006q"},
1098 {K_F7, "\033[007q"},
1099 {K_F8, "\033[008q"},
1100 {K_F9, "\033[009q"},
1101 {K_F10, "\033[010q"},
1102 {K_F11, "\033[011q"},
1103 {K_F12, "\033[012q"},
1104 {K_S_F1, "\033[013q"},
1105 {K_S_F2, "\033[014q"},
1106 {K_S_F3, "\033[015q"},
1107 {K_S_F4, "\033[016q"},
1108 {K_S_F5, "\033[017q"},
1109 {K_S_F6, "\033[018q"},
1110 {K_S_F7, "\033[019q"},
1111 {K_S_F8, "\033[020q"},
1112 {K_S_F9, "\033[021q"},
1113 {K_S_F10, "\033[022q"},
1114 {K_S_F11, "\033[023q"},
1115 {K_S_F12, "\033[024q"},
1116 {K_INS, "\033[139q"},
1117 {K_HOME, "\033[H"},
1118 {K_END, "\033[146q"},
1119 {K_PAGEUP, "\033[150q"},
1120 {K_PAGEDOWN, "\033[154q"},
1121# endif
1122
1123# if defined(DEBUG) || defined(ALL_BUILTIN_TCAPS)
1124/*
1125 * for debugging
1126 */
1127 {(int)KS_NAME, "debug"},
1128 {(int)KS_CE, "[CE]"},
1129 {(int)KS_CD, "[CD]"},
1130 {(int)KS_AL, "[AL]"},
1131# ifdef TERMINFO
1132 {(int)KS_CAL, "[CAL%p1%d]"},
1133# else
1134 {(int)KS_CAL, "[CAL%d]"},
1135# endif
1136 {(int)KS_DL, "[DL]"},
1137# ifdef TERMINFO
1138 {(int)KS_CDL, "[CDL%p1%d]"},
1139# else
1140 {(int)KS_CDL, "[CDL%d]"},
1141# endif
1142# ifdef TERMINFO
1143 {(int)KS_CS, "[%p1%dCS%p2%d]"},
1144# else
1145 {(int)KS_CS, "[%dCS%d]"},
1146# endif
Bram Moolenaar4033c552017-09-16 20:54:51 +02001147# ifdef TERMINFO
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 {(int)KS_CSV, "[%p1%dCSV%p2%d]"},
Bram Moolenaar4033c552017-09-16 20:54:51 +02001149# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 {(int)KS_CSV, "[%dCSV%d]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151# endif
1152# ifdef TERMINFO
1153 {(int)KS_CAB, "[CAB%p1%d]"},
1154 {(int)KS_CAF, "[CAF%p1%d]"},
1155 {(int)KS_CSB, "[CSB%p1%d]"},
1156 {(int)KS_CSF, "[CSF%p1%d]"},
1157# else
1158 {(int)KS_CAB, "[CAB%d]"},
1159 {(int)KS_CAF, "[CAF%d]"},
1160 {(int)KS_CSB, "[CSB%d]"},
1161 {(int)KS_CSF, "[CSF%d]"},
1162# endif
Bram Moolenaare023e882020-05-31 16:42:30 +02001163 {(int)KS_CAU, "[CAU%d]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 {(int)KS_OP, "[OP]"},
1165 {(int)KS_LE, "[LE]"},
1166 {(int)KS_CL, "[CL]"},
1167 {(int)KS_VI, "[VI]"},
1168 {(int)KS_VE, "[VE]"},
1169 {(int)KS_VS, "[VS]"},
1170 {(int)KS_ME, "[ME]"},
1171 {(int)KS_MR, "[MR]"},
1172 {(int)KS_MB, "[MB]"},
1173 {(int)KS_MD, "[MD]"},
1174 {(int)KS_SE, "[SE]"},
1175 {(int)KS_SO, "[SO]"},
1176 {(int)KS_UE, "[UE]"},
1177 {(int)KS_US, "[US]"},
Bram Moolenaare2cc9702005-03-15 22:43:58 +00001178 {(int)KS_UCE, "[UCE]"},
1179 {(int)KS_UCS, "[UCS]"},
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02001180 {(int)KS_STE, "[STE]"},
1181 {(int)KS_STS, "[STS]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 {(int)KS_MS, "[MS]"},
1183 {(int)KS_UT, "[UT]"},
Bram Moolenaar494838a2015-02-10 19:20:37 +01001184 {(int)KS_XN, "[XN]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185# ifdef TERMINFO
1186 {(int)KS_CM, "[%p1%dCM%p2%d]"},
1187# else
1188 {(int)KS_CM, "[%dCM%d]"},
1189# endif
1190 {(int)KS_SR, "[SR]"},
1191# ifdef TERMINFO
1192 {(int)KS_CRI, "[CRI%p1%d]"},
1193# else
1194 {(int)KS_CRI, "[CRI%d]"},
1195# endif
1196 {(int)KS_VB, "[VB]"},
1197 {(int)KS_KS, "[KS]"},
1198 {(int)KS_KE, "[KE]"},
1199 {(int)KS_TI, "[TI]"},
1200 {(int)KS_TE, "[TE]"},
1201 {(int)KS_CIS, "[CIS]"},
1202 {(int)KS_CIE, "[CIE]"},
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02001203 {(int)KS_CSC, "[CSC]"},
1204 {(int)KS_CEC, "[CEC]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 {(int)KS_TS, "[TS]"},
1206 {(int)KS_FS, "[FS]"},
1207# ifdef TERMINFO
1208 {(int)KS_CWS, "[%p1%dCWS%p2%d]"},
1209 {(int)KS_CWP, "[%p1%dCWP%p2%d]"},
1210# else
1211 {(int)KS_CWS, "[%dCWS%d]"},
1212 {(int)KS_CWP, "[%dCWP%d]"},
1213# endif
1214 {(int)KS_CRV, "[CRV]"},
Bram Moolenaar9584b312013-03-13 19:29:28 +01001215 {(int)KS_U7, "[U7]"},
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02001216 {(int)KS_RFG, "[RFG]"},
Bram Moolenaarb5c32652015-06-25 17:03:36 +02001217 {(int)KS_RBG, "[RBG]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218 {K_UP, "[KU]"},
1219 {K_DOWN, "[KD]"},
1220 {K_LEFT, "[KL]"},
1221 {K_RIGHT, "[KR]"},
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00001222 {K_XUP, "[xKU]"},
1223 {K_XDOWN, "[xKD]"},
1224 {K_XLEFT, "[xKL]"},
1225 {K_XRIGHT, "[xKR]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 {K_S_UP, "[S-KU]"},
1227 {K_S_DOWN, "[S-KD]"},
1228 {K_S_LEFT, "[S-KL]"},
1229 {K_C_LEFT, "[C-KL]"},
1230 {K_S_RIGHT, "[S-KR]"},
1231 {K_C_RIGHT, "[C-KR]"},
1232 {K_F1, "[F1]"},
1233 {K_XF1, "[xF1]"},
1234 {K_F2, "[F2]"},
1235 {K_XF2, "[xF2]"},
1236 {K_F3, "[F3]"},
1237 {K_XF3, "[xF3]"},
1238 {K_F4, "[F4]"},
1239 {K_XF4, "[xF4]"},
1240 {K_F5, "[F5]"},
1241 {K_F6, "[F6]"},
1242 {K_F7, "[F7]"},
1243 {K_F8, "[F8]"},
1244 {K_F9, "[F9]"},
1245 {K_F10, "[F10]"},
1246 {K_F11, "[F11]"},
1247 {K_F12, "[F12]"},
1248 {K_S_F1, "[S-F1]"},
1249 {K_S_XF1, "[S-xF1]"},
1250 {K_S_F2, "[S-F2]"},
1251 {K_S_XF2, "[S-xF2]"},
1252 {K_S_F3, "[S-F3]"},
1253 {K_S_XF3, "[S-xF3]"},
1254 {K_S_F4, "[S-F4]"},
1255 {K_S_XF4, "[S-xF4]"},
1256 {K_S_F5, "[S-F5]"},
1257 {K_S_F6, "[S-F6]"},
1258 {K_S_F7, "[S-F7]"},
1259 {K_S_F8, "[S-F8]"},
1260 {K_S_F9, "[S-F9]"},
1261 {K_S_F10, "[S-F10]"},
1262 {K_S_F11, "[S-F11]"},
1263 {K_S_F12, "[S-F12]"},
1264 {K_HELP, "[HELP]"},
1265 {K_UNDO, "[UNDO]"},
1266 {K_BS, "[BS]"},
1267 {K_INS, "[INS]"},
1268 {K_KINS, "[KINS]"},
1269 {K_DEL, "[DEL]"},
1270 {K_KDEL, "[KDEL]"},
1271 {K_HOME, "[HOME]"},
1272 {K_S_HOME, "[C-HOME]"},
1273 {K_C_HOME, "[C-HOME]"},
1274 {K_KHOME, "[KHOME]"},
1275 {K_XHOME, "[XHOME]"},
Bram Moolenaar68b76a62005-03-25 21:53:48 +00001276 {K_ZHOME, "[ZHOME]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 {K_END, "[END]"},
1278 {K_S_END, "[C-END]"},
1279 {K_C_END, "[C-END]"},
1280 {K_KEND, "[KEND]"},
1281 {K_XEND, "[XEND]"},
Bram Moolenaar68b76a62005-03-25 21:53:48 +00001282 {K_ZEND, "[ZEND]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 {K_PAGEUP, "[PAGEUP]"},
1284 {K_PAGEDOWN, "[PAGEDOWN]"},
1285 {K_KPAGEUP, "[KPAGEUP]"},
1286 {K_KPAGEDOWN, "[KPAGEDOWN]"},
1287 {K_MOUSE, "[MOUSE]"},
1288 {K_KPLUS, "[KPLUS]"},
1289 {K_KMINUS, "[KMINUS]"},
1290 {K_KDIVIDE, "[KDIVIDE]"},
1291 {K_KMULTIPLY, "[KMULTIPLY]"},
1292 {K_KENTER, "[KENTER]"},
1293 {K_KPOINT, "[KPOINT]"},
Bram Moolenaarec2da362017-01-21 20:04:22 +01001294 {K_PS, "[PASTE-START]"},
1295 {K_PE, "[PASTE-END]"},
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 {K_K0, "[K0]"},
1297 {K_K1, "[K1]"},
1298 {K_K2, "[K2]"},
1299 {K_K3, "[K3]"},
1300 {K_K4, "[K4]"},
1301 {K_K5, "[K5]"},
1302 {K_K6, "[K6]"},
1303 {K_K7, "[K7]"},
1304 {K_K8, "[K8]"},
1305 {K_K9, "[K9]"},
1306# endif
1307
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001308#endif // NO_BUILTIN_TCAPS
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309
1310/*
1311 * The most minimal terminal: only clear screen and cursor positioning
1312 * Always included.
1313 */
1314 {(int)KS_NAME, "dumb"},
1315 {(int)KS_CL, "\014"},
1316#ifdef TERMINFO
1317 {(int)KS_CM, IF_EB("\033[%i%p1%d;%p2%dH",
1318 ESC_STR "[%i%p1%d;%p2%dH")},
1319#else
1320 {(int)KS_CM, IF_EB("\033[%i%d;%dH", ESC_STR "[%i%d;%dH")},
1321#endif
1322
1323/*
1324 * end marker
1325 */
1326 {(int)KS_NAME, NULL}
1327
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001328}; // end of builtin_termcaps
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001330#if defined(FEAT_TERMGUICOLORS) || defined(PROTO)
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001331 static guicolor_T
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001332termgui_mch_get_color(char_u *name)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001333{
Bram Moolenaarab302212016-04-26 20:59:29 +02001334 return gui_get_color_cmn(name);
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001335}
1336
1337 guicolor_T
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001338termgui_get_color(char_u *name)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001339{
1340 guicolor_T t;
1341
1342 if (*name == NUL)
1343 return INVALCOLOR;
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001344 t = termgui_mch_get_color(name);
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001345
1346 if (t == INVALCOLOR)
Bram Moolenaar87202262020-05-24 17:23:45 +02001347 semsg(_(e_alloc_color), name);
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001348 return t;
1349}
1350
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +02001351 guicolor_T
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001352termgui_mch_get_rgb(guicolor_T color)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001353{
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +02001354 return color;
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001355}
1356#endif
1357
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358/*
1359 * DEFAULT_TERM is used, when no terminal is specified with -T option or $TERM.
1360 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361#ifdef AMIGA
1362# define DEFAULT_TERM (char_u *)"amiga"
1363#endif
1364
1365#ifdef MSWIN
1366# define DEFAULT_TERM (char_u *)"win32"
1367#endif
1368
Bram Moolenaare3f915d2020-07-14 23:02:44 +02001369#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370# define DEFAULT_TERM (char_u *)"ansi"
1371#endif
1372
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373#ifdef VMS
1374# define DEFAULT_TERM (char_u *)"vt320"
1375#endif
1376
Bram Moolenaarb3f74062020-02-26 16:16:53 +01001377#ifdef __HAIKU__
1378# undef DEFAULT_TERM
1379# define DEFAULT_TERM (char_u *)"xterm"
1380#endif
1381
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382#ifndef DEFAULT_TERM
1383# define DEFAULT_TERM (char_u *)"dumb"
1384#endif
1385
1386/*
1387 * Term_strings contains currently used terminal output strings.
1388 * It is initialized with the default values by parse_builtin_tcap().
1389 * The values can be changed by setting the option with the same name.
1390 */
1391char_u *(term_strings[(int)KS_LAST + 1]);
1392
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001393static int need_gather = FALSE; // need to fill termleader[]
1394static char_u termleader[256 + 1]; // for check_termcode()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395#ifdef FEAT_TERMRESPONSE
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001396static int check_for_codes = FALSE; // check for key code response
Bram Moolenaar517f00f2020-06-10 12:15:51 +02001397
1398/*
1399 * Structure and table to store terminal features that can be detected by
1400 * querying the terminal. Either by inspecting the termresponse or a more
1401 * specific request. Besides this there are:
1402 * t_colors - number of colors supported
1403 */
1404typedef struct {
1405 char *tpr_name;
1406 int tpr_set_by_termresponse;
1407 int tpr_status;
1408} termprop_T;
1409
1410// Values for tpr_status.
1411#define TPR_UNKNOWN 'u'
1412#define TPR_YES 'y'
1413#define TPR_NO 'n'
1414#define TPR_MOUSE_XTERM 'x' // use "xterm" for 'ttymouse'
1415#define TPR_MOUSE_XTERM2 '2' // use "xterm2" for 'ttymouse'
1416#define TPR_MOUSE_SGR 's' // use "sgr" for 'ttymouse'
1417
1418// can request the cursor style without messing up the display
1419#define TPR_CURSOR_STYLE 0
1420// can request the cursor blink mode without messing up the display
1421#define TPR_CURSOR_BLINK 1
1422// can set the underline color with t_8u without resetting other colors
1423#define TPR_UNDERLINE_RGB 2
1424// mouse support - TPR_MOUSE_XTERM, TPR_MOUSE_XTERM2 or TPR_MOUSE_SGR
1425#define TPR_MOUSE 3
1426// table size
1427#define TPR_COUNT 4
1428
1429static termprop_T term_props[TPR_COUNT];
1430
1431/*
1432 * Initialize the term_props table.
1433 * When "all" is FALSE only set those that are detected from the version
1434 * response.
1435 */
Bram Moolenaar0c0eddd2020-06-13 15:47:25 +02001436 void
Bram Moolenaar517f00f2020-06-10 12:15:51 +02001437init_term_props(int all)
1438{
1439 int i;
1440
1441 term_props[TPR_CURSOR_STYLE].tpr_name = "cursor_style";
1442 term_props[TPR_CURSOR_STYLE].tpr_set_by_termresponse = FALSE;
1443 term_props[TPR_CURSOR_BLINK].tpr_name = "cursor_blink_mode";
1444 term_props[TPR_CURSOR_BLINK].tpr_set_by_termresponse = FALSE;
1445 term_props[TPR_UNDERLINE_RGB].tpr_name = "underline_rgb";
1446 term_props[TPR_UNDERLINE_RGB].tpr_set_by_termresponse = TRUE;
1447 term_props[TPR_MOUSE].tpr_name = "mouse";
1448 term_props[TPR_MOUSE].tpr_set_by_termresponse = TRUE;
1449
1450 for (i = 0; i < TPR_COUNT; ++i)
1451 if (all || term_props[i].tpr_set_by_termresponse)
1452 term_props[i].tpr_status = TPR_UNKNOWN;
1453}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454#endif
1455
Bram Moolenaar0c0eddd2020-06-13 15:47:25 +02001456#if defined(FEAT_EVAL) || defined(PROTO)
1457 void
1458f_terminalprops(typval_T *argvars UNUSED, typval_T *rettv)
1459{
1460# ifdef FEAT_TERMRESPONSE
1461 int i;
1462# endif
1463
1464 if (rettv_dict_alloc(rettv) != OK)
1465 return;
1466# ifdef FEAT_TERMRESPONSE
1467 for (i = 0; i < TPR_COUNT; ++i)
1468 {
1469 char_u value[2];
1470
1471 value[0] = term_props[i].tpr_status;
1472 value[1] = NUL;
1473 dict_add_string(rettv->vval.v_dict, term_props[i].tpr_name, value);
1474 }
1475# endif
1476}
1477#endif
1478
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479 static struct builtin_term *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01001480find_builtin_term(char_u *term)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481{
1482 struct builtin_term *p;
1483
1484 p = builtin_termcaps;
1485 while (p->bt_string != NULL)
1486 {
1487 if (p->bt_entry == (int)KS_NAME)
1488 {
1489#ifdef UNIX
1490 if (STRCMP(p->bt_string, "iris-ansi") == 0 && vim_is_iris(term))
1491 return p;
1492 else if (STRCMP(p->bt_string, "xterm") == 0 && vim_is_xterm(term))
1493 return p;
1494 else
1495#endif
1496#ifdef VMS
1497 if (STRCMP(p->bt_string, "vt320") == 0 && vim_is_vt300(term))
1498 return p;
1499 else
1500#endif
1501 if (STRCMP(term, p->bt_string) == 0)
1502 return p;
1503 }
1504 ++p;
1505 }
1506 return p;
1507}
1508
1509/*
1510 * Parsing of the builtin termcap entries.
1511 * Caller should check if 'name' is a valid builtin term.
1512 * The terminal's name is not set, as this is already done in termcapinit().
1513 */
1514 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01001515parse_builtin_tcap(char_u *term)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516{
1517 struct builtin_term *p;
1518 char_u name[2];
1519 int term_8bit;
1520
1521 p = find_builtin_term(term);
1522 term_8bit = term_is_8bit(term);
1523
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001524 // Do not parse if builtin term not found
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525 if (p->bt_string == NULL)
1526 return;
1527
1528 for (++p; p->bt_entry != (int)KS_NAME && p->bt_entry != BT_EXTRA_KEYS; ++p)
1529 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001530 if ((int)p->bt_entry >= 0) // KS_xx entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001532 // Only set the value if it wasn't set yet.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 if (term_strings[p->bt_entry] == NULL
1534 || term_strings[p->bt_entry] == empty_option)
1535 {
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001536#ifdef FEAT_EVAL
1537 int opt_idx = -1;
1538#endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001539 // 8bit terminal: use CSI instead of <Esc>[
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 if (term_8bit && term_7to8bit((char_u *)p->bt_string) != 0)
1541 {
1542 char_u *s, *t;
1543
1544 s = vim_strsave((char_u *)p->bt_string);
1545 if (s != NULL)
1546 {
1547 for (t = s; *t; ++t)
1548 if (term_7to8bit(t))
1549 {
1550 *t = term_7to8bit(t);
Bram Moolenaar18085fa2018-07-10 17:33:45 +02001551 STRMOVE(t + 1, t + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552 }
1553 term_strings[p->bt_entry] = s;
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001554#ifdef FEAT_EVAL
1555 opt_idx =
1556#endif
1557 set_term_option_alloced(
1558 &term_strings[p->bt_entry]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 }
1560 }
1561 else
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001562 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563 term_strings[p->bt_entry] = (char_u *)p->bt_string;
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001564#ifdef FEAT_EVAL
1565 opt_idx = get_term_opt_idx(&term_strings[p->bt_entry]);
1566#endif
1567 }
1568#ifdef FEAT_EVAL
1569 set_term_option_sctx_idx(NULL, opt_idx);
1570#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 }
1572 }
1573 else
1574 {
1575 name[0] = KEY2TERMCAP0((int)p->bt_entry);
1576 name[1] = KEY2TERMCAP1((int)p->bt_entry);
1577 if (find_termcode(name) == NULL)
1578 add_termcode(name, (char_u *)p->bt_string, term_8bit);
1579 }
1580 }
1581}
Bram Moolenaard7d3cbe2017-07-22 21:15:42 +02001582
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583/*
1584 * Set number of colors.
1585 * Store it as a number in t_colors.
1586 * Store it as a string in T_CCO (using nr_colors[]).
1587 */
Bram Moolenaaracc770a2020-04-12 15:11:06 +02001588 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01001589set_color_count(int nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001591 char_u nr_colors[20]; // string for number of colors
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592
1593 t_colors = nr;
1594 if (t_colors > 1)
1595 sprintf((char *)nr_colors, "%d", t_colors);
1596 else
1597 *nr_colors = NUL;
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001598 set_string_option_direct((char_u *)"t_Co", -1, nr_colors, OPT_FREE, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599}
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001600
Bram Moolenaard7d3cbe2017-07-22 21:15:42 +02001601#if defined(FEAT_TERMRESPONSE)
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001602/*
1603 * Set the color count to "val" and redraw if it changed.
1604 */
1605 static void
1606may_adjust_color_count(int val)
1607{
1608 if (val != t_colors)
1609 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001610 // Nr of colors changed, initialize highlighting and
1611 // redraw everything. This causes a redraw, which usually
1612 // clears the message. Try keeping the message if it
1613 // might work.
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001614 set_keep_msg_from_hist();
1615 set_color_count(val);
1616 init_highlight(TRUE, FALSE);
1617# ifdef DEBUG_TERMRESPONSE
1618 {
Bram Moolenaarb255b902018-04-24 21:40:10 +02001619 int r = redraw_asap(CLEAR);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001620
Bram Moolenaarb255b902018-04-24 21:40:10 +02001621 log_tr("Received t_Co, redraw_asap(): %d", r);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001622 }
Bram Moolenaar87202262020-05-24 17:23:45 +02001623# else
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001624 redraw_asap(CLEAR);
Bram Moolenaar87202262020-05-24 17:23:45 +02001625# endif
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02001626 }
1627}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628#endif
1629
1630#ifdef HAVE_TGETENT
1631static char *(key_names[]) =
1632{
Bram Moolenaar87202262020-05-24 17:23:45 +02001633# ifdef FEAT_TERMRESPONSE
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001634 // Do this one first, it may cause a screen redraw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 "Co",
Bram Moolenaar87202262020-05-24 17:23:45 +02001636# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 "ku", "kd", "kr", "kl",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638 "#2", "#4", "%i", "*7",
1639 "k1", "k2", "k3", "k4", "k5", "k6",
1640 "k7", "k8", "k9", "k;", "F1", "F2",
1641 "%1", "&8", "kb", "kI", "kD", "kh",
1642 "@7", "kP", "kN", "K1", "K3", "K4", "K5", "kB",
1643 NULL
1644};
1645#endif
1646
Bram Moolenaar9289df52018-05-10 14:40:57 +02001647#ifdef HAVE_TGETENT
Bram Moolenaar69e05692018-05-10 14:11:52 +02001648 static void
1649get_term_entries(int *height, int *width)
1650{
1651 static struct {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001652 enum SpecialKey dest; // index in term_strings[]
1653 char *name; // termcap name for string
Bram Moolenaar69e05692018-05-10 14:11:52 +02001654 } string_names[] =
1655 { {KS_CE, "ce"}, {KS_AL, "al"}, {KS_CAL,"AL"},
1656 {KS_DL, "dl"}, {KS_CDL,"DL"}, {KS_CS, "cs"},
1657 {KS_CL, "cl"}, {KS_CD, "cd"},
1658 {KS_VI, "vi"}, {KS_VE, "ve"}, {KS_MB, "mb"},
1659 {KS_ME, "me"}, {KS_MR, "mr"},
1660 {KS_MD, "md"}, {KS_SE, "se"}, {KS_SO, "so"},
1661 {KS_CZH,"ZH"}, {KS_CZR,"ZR"}, {KS_UE, "ue"},
1662 {KS_US, "us"}, {KS_UCE, "Ce"}, {KS_UCS, "Cs"},
1663 {KS_STE,"Te"}, {KS_STS,"Ts"},
1664 {KS_CM, "cm"}, {KS_SR, "sr"},
1665 {KS_CRI,"RI"}, {KS_VB, "vb"}, {KS_KS, "ks"},
1666 {KS_KE, "ke"}, {KS_TI, "ti"}, {KS_TE, "te"},
Bram Moolenaar171a9212019-10-12 21:08:59 +02001667 {KS_CTI, "TI"}, {KS_CTE, "TE"},
Bram Moolenaar69e05692018-05-10 14:11:52 +02001668 {KS_BC, "bc"}, {KS_CSB,"Sb"}, {KS_CSF,"Sf"},
Bram Moolenaare023e882020-05-31 16:42:30 +02001669 {KS_CAB,"AB"}, {KS_CAF,"AF"}, {KS_CAU,"AU"},
1670 {KS_LE, "le"},
Bram Moolenaar69e05692018-05-10 14:11:52 +02001671 {KS_ND, "nd"}, {KS_OP, "op"}, {KS_CRV, "RV"},
1672 {KS_VS, "vs"}, {KS_CVS, "VS"},
1673 {KS_CIS, "IS"}, {KS_CIE, "IE"},
1674 {KS_CSC, "SC"}, {KS_CEC, "EC"},
1675 {KS_TS, "ts"}, {KS_FS, "fs"},
1676 {KS_CWP, "WP"}, {KS_CWS, "WS"},
1677 {KS_CSI, "SI"}, {KS_CEI, "EI"},
1678 {KS_U7, "u7"}, {KS_RFG, "RF"}, {KS_RBG, "RB"},
Bram Moolenaare023e882020-05-31 16:42:30 +02001679 {KS_8F, "8f"}, {KS_8B, "8b"}, {KS_8U, "8u"},
Bram Moolenaar69e05692018-05-10 14:11:52 +02001680 {KS_CBE, "BE"}, {KS_CBD, "BD"},
1681 {KS_CPS, "PS"}, {KS_CPE, "PE"},
Bram Moolenaar40385db2018-08-07 22:31:44 +02001682 {KS_CST, "ST"}, {KS_CRT, "RT"},
1683 {KS_SSI, "Si"}, {KS_SRI, "Ri"},
Bram Moolenaar69e05692018-05-10 14:11:52 +02001684 {(enum SpecialKey)0, NULL}
1685 };
1686 int i;
1687 char_u *p;
1688 static char_u tstrbuf[TBUFSZ];
1689 char_u *tp = tstrbuf;
1690
1691 /*
1692 * get output strings
1693 */
1694 for (i = 0; string_names[i].name != NULL; ++i)
1695 {
1696 if (TERM_STR(string_names[i].dest) == NULL
1697 || TERM_STR(string_names[i].dest) == empty_option)
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001698 {
Bram Moolenaar69e05692018-05-10 14:11:52 +02001699 TERM_STR(string_names[i].dest) = TGETSTR(string_names[i].name, &tp);
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001700#ifdef FEAT_EVAL
1701 set_term_option_sctx_idx(string_names[i].name, -1);
1702#endif
1703 }
Bram Moolenaar69e05692018-05-10 14:11:52 +02001704 }
1705
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001706 // tgetflag() returns 1 if the flag is present, 0 if not and
1707 // possibly -1 if the flag doesn't exist.
Bram Moolenaar69e05692018-05-10 14:11:52 +02001708 if ((T_MS == NULL || T_MS == empty_option) && tgetflag("ms") > 0)
1709 T_MS = (char_u *)"y";
1710 if ((T_XS == NULL || T_XS == empty_option) && tgetflag("xs") > 0)
1711 T_XS = (char_u *)"y";
1712 if ((T_XN == NULL || T_XN == empty_option) && tgetflag("xn") > 0)
1713 T_XN = (char_u *)"y";
1714 if ((T_DB == NULL || T_DB == empty_option) && tgetflag("db") > 0)
1715 T_DB = (char_u *)"y";
1716 if ((T_DA == NULL || T_DA == empty_option) && tgetflag("da") > 0)
1717 T_DA = (char_u *)"y";
1718 if ((T_UT == NULL || T_UT == empty_option) && tgetflag("ut") > 0)
1719 T_UT = (char_u *)"y";
1720
1721 /*
1722 * get key codes
1723 */
1724 for (i = 0; key_names[i] != NULL; ++i)
1725 if (find_termcode((char_u *)key_names[i]) == NULL)
1726 {
1727 p = TGETSTR(key_names[i], &tp);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001728 // if cursor-left == backspace, ignore it (televideo 925)
Bram Moolenaar69e05692018-05-10 14:11:52 +02001729 if (p != NULL
1730 && (*p != Ctrl_H
1731 || key_names[i][0] != 'k'
1732 || key_names[i][1] != 'l'))
1733 add_termcode((char_u *)key_names[i], p, FALSE);
1734 }
1735
1736 if (*height == 0)
1737 *height = tgetnum("li");
1738 if (*width == 0)
1739 *width = tgetnum("co");
1740
1741 /*
1742 * Get number of colors (if not done already).
1743 */
1744 if (TERM_STR(KS_CCO) == NULL || TERM_STR(KS_CCO) == empty_option)
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001745 {
Bram Moolenaar69e05692018-05-10 14:11:52 +02001746 set_color_count(tgetnum("Co"));
Bram Moolenaar35bc7d62018-10-02 14:45:10 +02001747#ifdef FEAT_EVAL
1748 set_term_option_sctx_idx("Co", -1);
1749#endif
1750 }
Bram Moolenaar69e05692018-05-10 14:11:52 +02001751
1752# ifndef hpux
1753 BC = (char *)TGETSTR("bc", &tp);
1754 UP = (char *)TGETSTR("up", &tp);
1755 p = TGETSTR("pc", &tp);
1756 if (p)
1757 PC = *p;
1758# endif
1759}
Bram Moolenaar9289df52018-05-10 14:40:57 +02001760#endif
Bram Moolenaar69e05692018-05-10 14:11:52 +02001761
1762 static void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001763report_term_error(char *error_msg, char_u *term)
Bram Moolenaar69e05692018-05-10 14:11:52 +02001764{
1765 struct builtin_term *termp;
Bram Moolenaarecd34bf2020-08-04 20:17:31 +02001766 int i;
Bram Moolenaar69e05692018-05-10 14:11:52 +02001767
1768 mch_errmsg("\r\n");
1769 if (error_msg != NULL)
1770 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001771 mch_errmsg(error_msg);
Bram Moolenaar69e05692018-05-10 14:11:52 +02001772 mch_errmsg("\r\n");
1773 }
1774 mch_errmsg("'");
1775 mch_errmsg((char *)term);
1776 mch_errmsg(_("' not known. Available builtin terminals are:"));
1777 mch_errmsg("\r\n");
1778 for (termp = &(builtin_termcaps[0]); termp->bt_string != NULL; ++termp)
1779 {
1780 if (termp->bt_entry == (int)KS_NAME)
1781 {
1782#ifdef HAVE_TGETENT
1783 mch_errmsg(" builtin_");
1784#else
1785 mch_errmsg(" ");
1786#endif
1787 mch_errmsg(termp->bt_string);
1788 mch_errmsg("\r\n");
1789 }
1790 }
Bram Moolenaarecd34bf2020-08-04 20:17:31 +02001791 // Output extra 'cmdheight' line breaks to avoid that the following error
1792 // message overwrites the last terminal name.
1793 for (i = 1; i < p_ch; ++i)
1794 mch_errmsg("\r\n");
Bram Moolenaar69e05692018-05-10 14:11:52 +02001795}
1796
1797 static void
1798report_default_term(char_u *term)
1799{
1800 mch_errmsg(_("defaulting to '"));
1801 mch_errmsg((char *)term);
1802 mch_errmsg("'\r\n");
1803 if (emsg_silent == 0)
1804 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001805 screen_start(); // don't know where cursor is now
Bram Moolenaar69e05692018-05-10 14:11:52 +02001806 out_flush();
1807 if (!is_not_a_term())
Bram Moolenaareda1da02019-11-17 17:06:33 +01001808 ui_delay(2007L, TRUE);
Bram Moolenaar69e05692018-05-10 14:11:52 +02001809 }
1810}
1811
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812/*
1813 * Set terminal options for terminal "term".
1814 * Return OK if terminal 'term' was found in a termcap, FAIL otherwise.
1815 *
1816 * While doing this, until ttest(), some options may be NULL, be careful.
1817 */
1818 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01001819set_termname(char_u *term)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820{
1821 struct builtin_term *termp;
1822#ifdef HAVE_TGETENT
1823 int builtin_first = p_tbi;
1824 int try;
1825 int termcap_cleared = FALSE;
1826#endif
1827 int width = 0, height = 0;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001828 char *error_msg = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 char_u *bs_p, *del_p;
1830
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001831 // In silect mode (ex -s) we don't use the 'term' option.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001832 if (silent_mode)
1833 return OK;
1834
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001835 detected_8bit = FALSE; // reset 8-bit detection
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836
1837 if (term_is_builtin(term))
1838 {
1839 term += 8;
1840#ifdef HAVE_TGETENT
1841 builtin_first = 1;
1842#endif
1843 }
1844
1845/*
1846 * If HAVE_TGETENT is not defined, only the builtin termcap is used, otherwise:
1847 * If builtin_first is TRUE:
1848 * 0. try builtin termcap
1849 * 1. try external termcap
1850 * 2. if both fail default to a builtin terminal
1851 * If builtin_first is FALSE:
1852 * 1. try external termcap
1853 * 2. try builtin termcap, if both fail default to a builtin terminal
1854 */
1855#ifdef HAVE_TGETENT
1856 for (try = builtin_first ? 0 : 1; try < 3; ++try)
1857 {
1858 /*
1859 * Use external termcap
1860 */
1861 if (try == 1)
1862 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863 char_u tbuf[TBUFSZ];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864
1865 /*
1866 * If the external termcap does not have a matching entry, try the
1867 * builtin ones.
1868 */
1869 if ((error_msg = tgetent_error(tbuf, term)) == NULL)
1870 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 if (!termcap_cleared)
1872 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001873 clear_termoptions(); // clear old options
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 termcap_cleared = TRUE;
1875 }
1876
Bram Moolenaar69e05692018-05-10 14:11:52 +02001877 get_term_entries(&height, &width);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 }
1879 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001880 else // try == 0 || try == 2
1881#endif // HAVE_TGETENT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882 /*
1883 * Use builtin termcap
1884 */
1885 {
1886#ifdef HAVE_TGETENT
1887 /*
1888 * If builtin termcap was already used, there is no need to search
1889 * for the builtin termcap again, quit now.
1890 */
1891 if (try == 2 && builtin_first && termcap_cleared)
1892 break;
1893#endif
1894 /*
1895 * search for 'term' in builtin_termcaps[]
1896 */
1897 termp = find_builtin_term(term);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001898 if (termp->bt_string == NULL) // did not find it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 {
1900#ifdef HAVE_TGETENT
1901 /*
1902 * If try == 0, first try the external termcap. If that is not
1903 * found we'll get back here with try == 2.
1904 * If termcap_cleared is set we used the external termcap,
1905 * don't complain about not finding the term in the builtin
1906 * termcap.
1907 */
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001908 if (try == 0) // try external one
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 continue;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001910 if (termcap_cleared) // found in external termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 break;
1912#endif
Bram Moolenaar69e05692018-05-10 14:11:52 +02001913 report_term_error(error_msg, term);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001915 // when user typed :set term=xxx, quit here
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 if (starting != NO_SCREEN)
1917 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001918 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 wait_return(TRUE);
1920 return FAIL;
1921 }
1922 term = DEFAULT_TERM;
Bram Moolenaar69e05692018-05-10 14:11:52 +02001923 report_default_term(term);
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001924 set_string_option_direct((char_u *)"term", -1, term,
1925 OPT_FREE, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 display_errors();
1927 }
1928 out_flush();
1929#ifdef HAVE_TGETENT
1930 if (!termcap_cleared)
1931 {
1932#endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001933 clear_termoptions(); // clear old options
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934#ifdef HAVE_TGETENT
1935 termcap_cleared = TRUE;
1936 }
1937#endif
1938 parse_builtin_tcap(term);
1939#ifdef FEAT_GUI
1940 if (term_is_gui(term))
1941 {
1942 out_flush();
1943 gui_init();
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001944 // If starting the GUI failed, don't do any of the other
1945 // things for this terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 if (!gui.in_use)
1947 return FAIL;
1948#ifdef HAVE_TGETENT
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001949 break; // don't try using external termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950#endif
1951 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01001952#endif // FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 }
1954#ifdef HAVE_TGETENT
1955 }
1956#endif
1957
1958/*
1959 * special: There is no info in the termcap about whether the cursor
1960 * positioning is relative to the start of the screen or to the start of the
1961 * scrolling region. We just guess here. Only msdos pcterm is known to do it
1962 * relative.
1963 */
1964 if (STRCMP(term, "pcterm") == 0)
1965 T_CCS = (char_u *)"yes";
1966 else
1967 T_CCS = empty_option;
1968
1969#ifdef UNIX
1970/*
1971 * Any "stty" settings override the default for t_kb from the termcap.
1972 * This is in os_unix.c, because it depends a lot on the version of unix that
1973 * is being used.
1974 * Don't do this when the GUI is active, it uses "t_kb" and "t_kD" directly.
1975 */
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02001976# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 if (!gui.in_use)
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02001978# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 get_stty();
1980#endif
1981
1982/*
1983 * If the termcap has no entry for 'bs' and/or 'del' and the ioctl() also
1984 * didn't work, use the default CTRL-H
1985 * The default for t_kD is DEL, unless t_kb is DEL.
1986 * The vim_strsave'd strings are probably lost forever, well it's only two
1987 * bytes. Don't do this when the GUI is active, it uses "t_kb" and "t_kD"
1988 * directly.
1989 */
1990#ifdef FEAT_GUI
1991 if (!gui.in_use)
1992#endif
1993 {
1994 bs_p = find_termcode((char_u *)"kb");
1995 del_p = find_termcode((char_u *)"kD");
1996 if (bs_p == NULL || *bs_p == NUL)
1997 add_termcode((char_u *)"kb", (bs_p = (char_u *)CTRL_H_STR), FALSE);
1998 if ((del_p == NULL || *del_p == NUL) &&
1999 (bs_p == NULL || *bs_p != DEL))
2000 add_termcode((char_u *)"kD", (char_u *)DEL_STR, FALSE);
2001 }
2002
2003#if defined(UNIX) || defined(VMS)
2004 term_is_xterm = vim_is_xterm(term);
2005#endif
Bram Moolenaar0d2c4bf2019-10-17 22:17:02 +02002006#ifdef FEAT_TERMRESPONSE
Bram Moolenaar517f00f2020-06-10 12:15:51 +02002007 // Reset terminal properties that are set based on the termresponse, which
2008 // will be sent out soon.
2009 init_term_props(FALSE);
Bram Moolenaar0d2c4bf2019-10-17 22:17:02 +02002010#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002012#if defined(UNIX) || defined(VMS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 /*
2014 * For Unix, set the 'ttymouse' option to the type of mouse to be used.
2015 * The termcode for the mouse is added as a side effect in option.c.
2016 */
2017 {
Bram Moolenaar6d006f92017-06-23 22:35:34 +02002018 char_u *p = (char_u *)"";
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002020# ifdef FEAT_MOUSE_XTERM
Bram Moolenaar864207d2008-06-24 22:14:38 +00002021 if (use_xterm_like_mouse(term))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 {
2023 if (use_xterm_mouse())
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002024 p = NULL; // keep existing value, might be "xterm2"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 else
2026 p = (char_u *)"xterm";
2027 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002028# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 if (p != NULL)
Bram Moolenaar15d55de2012-12-05 14:43:02 +01002030 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031 set_option_value((char_u *)"ttym", 0L, p, 0);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002032 // Reset the WAS_SET flag, 'ttymouse' can be set to "sgr" or
2033 // "xterm2" in check_termcode().
Bram Moolenaar15d55de2012-12-05 14:43:02 +01002034 reset_option_was_set((char_u *)"ttym");
2035 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 if (p == NULL
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002037# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 || gui.in_use
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002039# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 )
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002041 check_mouse_termcode(); // set mouse termcode anyway
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002043#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 set_mouse_termcode(KS_MOUSE, (char_u *)"\233M");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002045#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047#ifdef USE_TERM_CONSOLE
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002048 // DEFAULT_TERM indicates that it is the machine console.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 if (STRCMP(term, DEFAULT_TERM) != 0)
2050 term_console = FALSE;
2051 else
2052 {
2053 term_console = TRUE;
2054# ifdef AMIGA
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002055 win_resize_on(); // enable window resizing reports
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056# endif
2057 }
2058#endif
2059
2060#if defined(UNIX) || defined(VMS)
2061 /*
2062 * 'ttyfast' is default on for xterm, iris-ansi and a few others.
2063 */
2064 if (vim_is_fastterm(term))
2065 p_tf = TRUE;
2066#endif
2067#ifdef USE_TERM_CONSOLE
2068 /*
2069 * 'ttyfast' is default on consoles
2070 */
2071 if (term_console)
2072 p_tf = TRUE;
2073#endif
2074
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002075 ttest(TRUE); // make sure we have a valid set of terminal codes
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002077 full_screen = TRUE; // we can use termcap codes from now on
2078 set_term_defaults(); // use current values as defaults
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079#ifdef FEAT_TERMRESPONSE
Bram Moolenaarb255b902018-04-24 21:40:10 +02002080 LOG_TR(("setting crv_status to STATUS_GET"));
Bram Moolenaarafd78262019-05-10 23:10:31 +02002081 crv_status.tr_progress = STATUS_GET; // Get terminal version later
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082#endif
2083
2084 /*
2085 * Initialize the terminal with the appropriate termcap codes.
2086 * Set the mouse and window title if possible.
2087 * Don't do this when starting, need to parse the .vimrc first, because it
2088 * may redefine t_TI etc.
2089 */
2090 if (starting != NO_SCREEN)
2091 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002092 starttermcap(); // may change terminal mode
2093 setmouse(); // may start using the mouse
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094#ifdef FEAT_TITLE
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002095 maketitle(); // may display window title
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096#endif
2097 }
2098
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002099 // display initial screen after ttest() checking. jw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100 if (width <= 0 || height <= 0)
2101 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002102 // termcap failed to report size
2103 // set defaults, in case ui_get_shellsize() also fails
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 width = 80;
Bram Moolenaar4f974752019-02-17 17:44:42 +01002105#if defined(MSWIN)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002106 height = 25; // console is often 25 lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107#else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002108 height = 24; // most terminals are 24 lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109#endif
2110 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002111 set_shellsize(width, height, FALSE); // may change Rows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112 if (starting != NO_SCREEN)
2113 {
2114 if (scroll_region)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002115 scroll_region_reset(); // In case Rows changed
2116 check_map_keycodes(); // check mappings for terminal codes used
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118 {
Bram Moolenaar0c81d1b2020-02-22 22:45:55 +01002119 buf_T *buf;
2120 aco_save_T aco;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121
2122 /*
2123 * Execute the TermChanged autocommands for each buffer that is
2124 * loaded.
2125 */
Bram Moolenaar0c81d1b2020-02-22 22:45:55 +01002126 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 {
2128 if (curbuf->b_ml.ml_mfp != NULL)
Bram Moolenaar0c81d1b2020-02-22 22:45:55 +01002129 {
2130 aucmd_prepbuf(&aco, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 apply_autocmds(EVENT_TERMCHANGED, NULL, NULL, FALSE,
2132 curbuf);
Bram Moolenaar0c81d1b2020-02-22 22:45:55 +01002133 // restore curwin/curbuf and a few other things
2134 aucmd_restbuf(&aco);
2135 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 }
2139
2140#ifdef FEAT_TERMRESPONSE
2141 may_req_termresponse();
2142#endif
2143
2144 return OK;
2145}
2146
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147#ifdef HAVE_TGETENT
2148/*
2149 * Call tgetent()
2150 * Return error message if it fails, NULL if it's OK.
2151 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002152 static char *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002153tgetent_error(char_u *tbuf, char_u *term)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154{
2155 int i;
2156
Bram Moolenaar6b649ac2019-12-07 17:47:22 +01002157 // Note: Valgrind may report a leak here, because the library keeps one
2158 // buffer around that we can't ever free.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 i = TGETENT(tbuf, term);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002160 if (i < 0 // -1 is always an error
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161# ifdef TGETENT_ZERO_ERR
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002162 || i == 0 // sometimes zero is also an error
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163# endif
2164 )
2165 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002166 // On FreeBSD tputs() gets a SEGV after a tgetent() which fails. Call
2167 // tgetent() with the always existing "dumb" entry to avoid a crash or
2168 // hang.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 (void)TGETENT(tbuf, "dumb");
2170
2171 if (i < 0)
2172# ifdef TGETENT_ZERO_ERR
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002173 return _("E557: Cannot open termcap file");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 if (i == 0)
2175# endif
2176#ifdef TERMINFO
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002177 return _("E558: Terminal entry not found in terminfo");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178#else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002179 return _("E559: Terminal entry not found in termcap");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180#endif
2181 }
2182 return NULL;
2183}
2184
2185/*
2186 * Some versions of tgetstr() have been reported to return -1 instead of NULL.
2187 * Fix that here.
2188 */
2189 static char_u *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002190vim_tgetstr(char *s, char_u **pp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191{
2192 char *p;
2193
2194 p = tgetstr(s, (char **)pp);
2195 if (p == (char *)-1)
2196 p = NULL;
2197 return (char_u *)p;
2198}
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002199#endif // HAVE_TGETENT
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002201#if defined(HAVE_TGETENT) && (defined(UNIX) || defined(VMS) || defined(MACOS_X))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202/*
2203 * Get Columns and Rows from the termcap. Used after a window signal if the
2204 * ioctl() fails. It doesn't make sense to call tgetent each time if the "co"
2205 * and "li" entries never change. But on some systems this works.
2206 * Errors while getting the entries are ignored.
2207 */
2208 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002209getlinecol(
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002210 long *cp, // pointer to columns
2211 long *rp) // pointer to rows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212{
2213 char_u tbuf[TBUFSZ];
2214
2215 if (T_NAME != NULL && *T_NAME != NUL && tgetent_error(tbuf, T_NAME) == NULL)
2216 {
2217 if (*cp == 0)
2218 *cp = tgetnum("co");
2219 if (*rp == 0)
2220 *rp = tgetnum("li");
2221 }
2222}
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002223#endif // defined(HAVE_TGETENT) && defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224
2225/*
2226 * Get a string entry from the termcap and add it to the list of termcodes.
2227 * Used for <t_xx> special keys.
2228 * Give an error message for failure when not sourcing.
2229 * If force given, replace an existing entry.
2230 * Return FAIL if the entry was not found, OK if the entry was added.
2231 */
2232 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002233add_termcap_entry(char_u *name, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234{
2235 char_u *term;
2236 int key;
2237 struct builtin_term *termp;
2238#ifdef HAVE_TGETENT
2239 char_u *string;
2240 int i;
2241 int builtin_first;
2242 char_u tbuf[TBUFSZ];
2243 char_u tstrbuf[TBUFSZ];
2244 char_u *tp = tstrbuf;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002245 char *error_msg = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246#endif
2247
2248/*
2249 * If the GUI is running or will start in a moment, we only support the keys
2250 * that the GUI can produce.
2251 */
2252#ifdef FEAT_GUI
2253 if (gui.in_use || gui.starting)
2254 return gui_mch_haskey(name);
2255#endif
2256
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002257 if (!force && find_termcode(name) != NULL) // it's already there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 return OK;
2259
2260 term = T_NAME;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002261 if (term == NULL || *term == NUL) // 'term' not defined yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 return FAIL;
2263
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002264 if (term_is_builtin(term)) // name starts with "builtin_"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 {
2266 term += 8;
2267#ifdef HAVE_TGETENT
2268 builtin_first = TRUE;
2269#endif
2270 }
2271#ifdef HAVE_TGETENT
2272 else
2273 builtin_first = p_tbi;
2274#endif
2275
2276#ifdef HAVE_TGETENT
2277/*
2278 * We can get the entry from the builtin termcap and from the external one.
2279 * If 'ttybuiltin' is on or the terminal name starts with "builtin_", try
2280 * builtin termcap first.
2281 * If 'ttybuiltin' is off, try external termcap first.
2282 */
2283 for (i = 0; i < 2; ++i)
2284 {
Bram Moolenaar98b30a42015-11-10 15:18:02 +01002285 if ((!builtin_first) == i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286#endif
2287 /*
2288 * Search in builtin termcap
2289 */
2290 {
2291 termp = find_builtin_term(term);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002292 if (termp->bt_string != NULL) // found it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 {
2294 key = TERMCAP2KEY(name[0], name[1]);
Bram Moolenaare7808482018-03-06 13:17:23 +01002295 ++termp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 while (termp->bt_entry != (int)KS_NAME)
2297 {
2298 if ((int)termp->bt_entry == key)
2299 {
2300 add_termcode(name, (char_u *)termp->bt_string,
2301 term_is_8bit(term));
2302 return OK;
2303 }
2304 ++termp;
2305 }
2306 }
2307 }
2308#ifdef HAVE_TGETENT
2309 else
2310 /*
2311 * Search in external termcap
2312 */
2313 {
2314 error_msg = tgetent_error(tbuf, term);
2315 if (error_msg == NULL)
2316 {
2317 string = TGETSTR((char *)name, &tp);
2318 if (string != NULL && *string != NUL)
2319 {
2320 add_termcode(name, string, FALSE);
2321 return OK;
2322 }
2323 }
2324 }
2325 }
2326#endif
2327
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002328 if (SOURCING_NAME == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 {
2330#ifdef HAVE_TGETENT
2331 if (error_msg != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002332 emsg(error_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 else
2334#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002335 semsg(_("E436: No \"%s\" entry in termcap"), name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336 }
2337 return FAIL;
2338}
2339
2340 static int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002341term_is_builtin(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342{
2343 return (STRNCMP(name, "builtin_", (size_t)8) == 0);
2344}
2345
2346/*
2347 * Return TRUE if terminal "name" uses CSI instead of <Esc>[.
2348 * Assume that the terminal is using 8-bit controls when the name contains
2349 * "8bit", like in "xterm-8bit".
2350 */
2351 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002352term_is_8bit(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353{
2354 return (detected_8bit || strstr((char *)name, "8bit") != NULL);
2355}
2356
2357/*
2358 * Translate terminal control chars from 7-bit to 8-bit:
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02002359 * <Esc>[ -> CSI <M_C_[>
2360 * <Esc>] -> OSC <M-C-]>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361 * <Esc>O -> <M-C-O>
2362 */
2363 static int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002364term_7to8bit(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365{
2366 if (*p == ESC)
2367 {
2368 if (p[1] == '[')
2369 return CSI;
2370 if (p[1] == ']')
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02002371 return OSC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 if (p[1] == 'O')
2373 return 0x8f;
2374 }
2375 return 0;
2376}
2377
Bram Moolenaar1c17ffa2018-04-24 15:19:04 +02002378#if defined(FEAT_GUI) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002380term_is_gui(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381{
2382 return (STRCMP(name, "builtin_gui") == 0 || STRCMP(name, "gui") == 0);
2383}
2384#endif
2385
2386#if !defined(HAVE_TGETENT) || defined(AMIGA) || defined(PROTO)
2387
2388 char_u *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002389tltoa(unsigned long i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390{
2391 static char_u buf[16];
2392 char_u *p;
2393
2394 p = buf + 15;
2395 *p = '\0';
2396 do
2397 {
2398 --p;
2399 *p = (char_u) (i % 10 + '0');
2400 i /= 10;
2401 }
2402 while (i > 0 && p > buf);
2403 return p;
2404}
2405#endif
2406
2407#ifndef HAVE_TGETENT
2408
2409/*
2410 * minimal tgoto() implementation.
2411 * no padding and we only parse for %i %d and %+char
2412 */
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +00002413 static char *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002414tgoto(char *cm, int x, int y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415{
2416 static char buf[30];
2417 char *p, *s, *e;
2418
2419 if (!cm)
2420 return "OOPS";
2421 e = buf + 29;
2422 for (s = buf; s < e && *cm; cm++)
2423 {
2424 if (*cm != '%')
2425 {
2426 *s++ = *cm;
2427 continue;
2428 }
2429 switch (*++cm)
2430 {
2431 case 'd':
2432 p = (char *)tltoa((unsigned long)y);
2433 y = x;
2434 while (*p)
2435 *s++ = *p++;
2436 break;
2437 case 'i':
2438 x++;
2439 y++;
2440 break;
2441 case '+':
2442 *s++ = (char)(*++cm + y);
2443 y = x;
2444 break;
2445 case '%':
2446 *s++ = *cm;
2447 break;
2448 default:
2449 return "OOPS";
2450 }
2451 }
2452 *s = '\0';
2453 return buf;
2454}
2455
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002456#endif // HAVE_TGETENT
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457
2458/*
2459 * Set the terminal name and initialize the terminal options.
2460 * If "name" is NULL or empty, get the terminal name from the environment.
2461 * If that fails, use the default terminal name.
2462 */
2463 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002464termcapinit(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465{
2466 char_u *term;
2467
2468 if (name != NULL && *name == NUL)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002469 name = NULL; // empty name is equal to no name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470 term = name;
2471
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472#ifndef MSWIN
2473 if (term == NULL)
2474 term = mch_getenv((char_u *)"TERM");
2475#endif
2476 if (term == NULL || *term == NUL)
2477 term = DEFAULT_TERM;
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00002478 set_string_option_direct((char_u *)"term", -1, term, OPT_FREE, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002480 // Set the default terminal name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 set_string_default("term", term);
2482 set_string_default("ttytype", term);
2483
2484 /*
2485 * Avoid using "term" here, because the next mch_getenv() may overwrite it.
2486 */
2487 set_termname(T_NAME != NULL ? T_NAME : term);
2488}
2489
2490/*
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002491 * The number of calls to ui_write is reduced by using "out_buf".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492 */
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002493#define OUT_SIZE 2047
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002494
2495// add one to allow mch_write() in os_win32.c to append a NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496static char_u out_buf[OUT_SIZE + 1];
Bram Moolenaar5da04ef2019-04-03 21:15:58 +02002497
2498static int out_pos = 0; // number of chars in out_buf
2499
2500// Since the maximum number of SGR parameters shown as a normal value range is
2501// 16, the escape sequence length can be 4 * 16 + lead + tail.
2502#define MAX_ESC_SEQ_LEN 80
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503
2504/*
2505 * out_flush(): flush the output buffer
2506 */
2507 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002508out_flush(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509{
2510 int len;
2511
2512 if (out_pos != 0)
2513 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002514 // set out_pos to 0 before ui_write, to avoid recursiveness
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 len = out_pos;
2516 out_pos = 0;
2517 ui_write(out_buf, len);
Bram Moolenaar86394aa2020-09-05 14:27:24 +02002518#ifdef FEAT_JOB_CHANNEL
2519 if (ch_log_output)
2520 {
2521 out_buf[len] = NUL;
2522 ch_log(NULL, "raw terminal output: \"%s\"", out_buf);
2523 ch_log_output = FALSE;
2524 }
2525#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 }
2527}
2528
Bram Moolenaara338adc2018-01-31 20:51:47 +01002529/*
Bram Moolenaard23a8232018-02-10 18:45:26 +01002530 * out_flush_cursor(): flush the output buffer and redraw the cursor.
2531 * Does not flush recursively in the GUI to avoid slow drawing.
Bram Moolenaara338adc2018-01-31 20:51:47 +01002532 */
2533 void
2534out_flush_cursor(
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002535 int force UNUSED, // when TRUE, update cursor even when not moved
2536 int clear_selection UNUSED) // clear selection under cursor
Bram Moolenaara338adc2018-01-31 20:51:47 +01002537{
2538 mch_disable_flush();
2539 out_flush();
2540 mch_enable_flush();
2541#ifdef FEAT_GUI
2542 if (gui.in_use)
2543 {
2544 gui_update_cursor(force, clear_selection);
2545 gui_may_flush();
2546 }
2547#endif
2548}
2549
2550
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551/*
2552 * Sometimes a byte out of a multi-byte character is written with out_char().
2553 * To avoid flushing half of the character, call this function first.
2554 */
2555 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002556out_flush_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557{
2558 if (enc_dbcs != 0 && out_pos >= OUT_SIZE - MB_MAXBYTES)
2559 out_flush();
2560}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561
2562#ifdef FEAT_GUI
2563/*
2564 * out_trash(): Throw away the contents of the output buffer
2565 */
2566 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002567out_trash(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568{
2569 out_pos = 0;
2570}
2571#endif
2572
2573/*
2574 * out_char(c): put a byte into the output buffer.
2575 * Flush it if it becomes full.
2576 * This should not be used for outputting text on the screen (use functions
2577 * like msg_puts() and screen_putchar() for that).
2578 */
2579 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01002580out_char(unsigned c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581{
Bram Moolenaard0573012017-10-28 21:11:06 +02002582#if defined(UNIX) || defined(VMS) || defined(AMIGA) || defined(MACOS_X)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002583 if (c == '\n') // turn LF into CR-LF (CRMOD doesn't seem to do this)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 out_char('\r');
2585#endif
2586
2587 out_buf[out_pos++] = c;
2588
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01002589 // For testing we flush each time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 if (out_pos >= OUT_SIZE || p_wd)
2591 out_flush();
2592}
2593
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594/*
Bram Moolenaarec6f7352019-10-24 17:49:27 +02002595 * Output "c" like out_char(), but don't flush when p_wd is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 */
Bram Moolenaar86394aa2020-09-05 14:27:24 +02002597 static int
2598out_char_nf(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599{
Bram Moolenaar86394aa2020-09-05 14:27:24 +02002600 out_buf[out_pos++] = (unsigned)c;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601
2602 if (out_pos >= OUT_SIZE)
2603 out_flush();
Bram Moolenaar86394aa2020-09-05 14:27:24 +02002604 return (unsigned)c;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605}
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 Moolenaar86394aa2020-09-05 14:27:24 +02003043#ifdef FEAT_JOB_CHANNEL
3044 ch_log_output = TRUE;
3045#endif
Bram Moolenaarec6f7352019-10-24 17:49:27 +02003046 // t_ts takes one argument: column in status line
3047 OUT_STR(tgoto((char *)T_TS, 0, 0)); // set title start
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 out_str_nf(title);
Bram Moolenaarec6f7352019-10-24 17:49:27 +02003049 out_str(T_FS); // set title end
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 out_flush();
3051}
Bram Moolenaar40385db2018-08-07 22:31:44 +02003052
3053/*
3054 * Tell the terminal to push (save) the title and/or icon, so that it can be
3055 * popped (restored) later.
3056 */
3057 void
3058term_push_title(int which)
3059{
Bram Moolenaar27821262019-05-08 16:41:09 +02003060 if ((which & SAVE_RESTORE_TITLE) && T_CST != NULL && *T_CST != NUL)
Bram Moolenaar40385db2018-08-07 22:31:44 +02003061 {
3062 OUT_STR(T_CST);
3063 out_flush();
3064 }
3065
Bram Moolenaar27821262019-05-08 16:41:09 +02003066 if ((which & SAVE_RESTORE_ICON) && T_SSI != NULL && *T_SSI != NUL)
Bram Moolenaar40385db2018-08-07 22:31:44 +02003067 {
3068 OUT_STR(T_SSI);
3069 out_flush();
3070 }
3071}
3072
3073/*
3074 * Tell the terminal to pop the title and/or icon.
3075 */
3076 void
3077term_pop_title(int which)
3078{
Bram Moolenaar27821262019-05-08 16:41:09 +02003079 if ((which & SAVE_RESTORE_TITLE) && T_CRT != NULL && *T_CRT != NUL)
Bram Moolenaar40385db2018-08-07 22:31:44 +02003080 {
3081 OUT_STR(T_CRT);
3082 out_flush();
3083 }
3084
Bram Moolenaar27821262019-05-08 16:41:09 +02003085 if ((which & SAVE_RESTORE_ICON) && T_SRI != NULL && *T_SRI != NUL)
Bram Moolenaar40385db2018-08-07 22:31:44 +02003086 {
3087 OUT_STR(T_SRI);
3088 out_flush();
3089 }
3090}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091#endif
3092
3093/*
3094 * Make sure we have a valid set or terminal options.
3095 * Replace all entries that are NULL by empty_option
3096 */
3097 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003098ttest(int pairs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099{
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02003100 char_u *env_colors;
3101
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003102 check_options(); // make sure no options are NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103
3104 /*
3105 * MUST have "cm": cursor motion.
3106 */
3107 if (*T_CM == NUL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003108 emsg(_("E437: terminal capability \"cm\" required"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109
3110 /*
3111 * if "cs" defined, use a scroll region, it's faster.
3112 */
3113 if (*T_CS != NUL)
3114 scroll_region = TRUE;
3115 else
3116 scroll_region = FALSE;
3117
3118 if (pairs)
3119 {
3120 /*
3121 * optional pairs
3122 */
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003123 // TP goes to normal mode for TI (invert) and TB (bold)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 if (*T_ME == NUL)
3125 T_ME = T_MR = T_MD = T_MB = empty_option;
3126 if (*T_SO == NUL || *T_SE == NUL)
3127 T_SO = T_SE = empty_option;
3128 if (*T_US == NUL || *T_UE == NUL)
3129 T_US = T_UE = empty_option;
3130 if (*T_CZH == NUL || *T_CZR == NUL)
3131 T_CZH = T_CZR = empty_option;
3132
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003133 // T_VE is needed even though T_VI is not defined
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 if (*T_VE == NUL)
3135 T_VI = empty_option;
3136
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003137 // if 'mr' or 'me' is not defined use 'so' and 'se'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 if (*T_ME == NUL)
3139 {
3140 T_ME = T_SE;
3141 T_MR = T_SO;
3142 T_MD = T_SO;
3143 }
3144
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003145 // if 'so' or 'se' is not defined use 'mr' and 'me'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 if (*T_SO == NUL)
3147 {
3148 T_SE = T_ME;
3149 if (*T_MR == NUL)
3150 T_SO = T_MD;
3151 else
3152 T_SO = T_MR;
3153 }
3154
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003155 // if 'ZH' or 'ZR' is not defined use 'mr' and 'me'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 if (*T_CZH == NUL)
3157 {
3158 T_CZR = T_ME;
3159 if (*T_MR == NUL)
3160 T_CZH = T_MD;
3161 else
3162 T_CZH = T_MR;
3163 }
3164
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003165 // "Sb" and "Sf" come in pairs
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 if (*T_CSB == NUL || *T_CSF == NUL)
3167 {
3168 T_CSB = empty_option;
3169 T_CSF = empty_option;
3170 }
3171
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003172 // "AB" and "AF" come in pairs
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 if (*T_CAB == NUL || *T_CAF == NUL)
3174 {
3175 T_CAB = empty_option;
3176 T_CAF = empty_option;
3177 }
3178
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003179 // if 'Sb' and 'AB' are not defined, reset "Co"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 if (*T_CSB == NUL && *T_CAB == NUL)
Bram Moolenaar363cb672009-07-22 12:28:17 +00003181 free_one_termoption(T_CCO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003183 // Set 'weirdinvert' according to value of 't_xs'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 p_wiv = (*T_XS != NUL);
3185 }
3186 need_gather = TRUE;
3187
Bram Moolenaar759d8152020-04-26 16:52:49 +02003188 // Set t_colors to the value of $COLORS or t_Co. Ignore $COLORS in the
3189 // GUI.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 t_colors = atoi((char *)T_CCO);
Bram Moolenaar759d8152020-04-26 16:52:49 +02003191#ifdef FEAT_GUI
3192 if (!gui.in_use)
3193#endif
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02003194 {
Bram Moolenaar759d8152020-04-26 16:52:49 +02003195 env_colors = mch_getenv((char_u *)"COLORS");
3196 if (env_colors != NULL && isdigit(*env_colors))
3197 {
3198 int colors = atoi((char *)env_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02003199
Bram Moolenaar759d8152020-04-26 16:52:49 +02003200 if (colors != t_colors)
3201 set_color_count(colors);
3202 }
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02003203 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204}
3205
3206#if (defined(FEAT_GUI) && (defined(FEAT_MENU) || !defined(USE_ON_FLY_SCROLL))) \
3207 || defined(PROTO)
3208/*
3209 * Represent the given long_u as individual bytes, with the most significant
3210 * byte first, and store them in dst.
3211 */
3212 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003213add_long_to_buf(long_u val, char_u *dst)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214{
3215 int i;
3216 int shift;
3217
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003218 for (i = 1; i <= (int)sizeof(long_u); i++)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 {
3220 shift = 8 * (sizeof(long_u) - i);
3221 dst[i - 1] = (char_u) ((val >> shift) & 0xff);
3222 }
3223}
3224
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225/*
3226 * Interpret the next string of bytes in buf as a long integer, with the most
3227 * significant byte first. Note that it is assumed that buf has been through
3228 * inchar(), so that NUL and K_SPECIAL will be represented as three bytes each.
3229 * Puts result in val, and returns the number of bytes read from buf
3230 * (between sizeof(long_u) and 2 * sizeof(long_u)), or -1 if not enough bytes
3231 * were present.
3232 */
3233 static int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003234get_long_from_buf(char_u *buf, long_u *val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235{
3236 int len;
3237 char_u bytes[sizeof(long_u)];
3238 int i;
3239 int shift;
3240
3241 *val = 0;
3242 len = get_bytes_from_buf(buf, bytes, (int)sizeof(long_u));
3243 if (len != -1)
3244 {
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003245 for (i = 0; i < (int)sizeof(long_u); i++)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 {
3247 shift = 8 * (sizeof(long_u) - 1 - i);
3248 *val += (long_u)bytes[i] << shift;
3249 }
3250 }
3251 return len;
3252}
3253#endif
3254
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255/*
3256 * Read the next num_bytes bytes from buf, and store them in bytes. Assume
3257 * that buf has been through inchar(). Returns the actual number of bytes used
3258 * from buf (between num_bytes and num_bytes*2), or -1 if not enough bytes were
3259 * available.
3260 */
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02003261 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003262get_bytes_from_buf(char_u *buf, char_u *bytes, int num_bytes)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263{
3264 int len = 0;
3265 int i;
3266 char_u c;
3267
3268 for (i = 0; i < num_bytes; i++)
3269 {
3270 if ((c = buf[len++]) == NUL)
3271 return -1;
3272 if (c == K_SPECIAL)
3273 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003274 if (buf[len] == NUL || buf[len + 1] == NUL) // cannot happen?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 return -1;
3276 if (buf[len++] == (int)KS_ZERO)
3277 c = NUL;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003278 // else it should be KS_SPECIAL; when followed by KE_FILLER c is
3279 // K_SPECIAL, or followed by KE_CSI and c must be CSI.
Bram Moolenaar0e710d62013-07-01 20:06:19 +02003280 if (buf[len++] == (int)KE_CSI)
3281 c = CSI;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 }
Bram Moolenaar8d1ab512007-05-06 13:49:21 +00003283 else if (c == CSI && buf[len] == KS_EXTRA
3284 && buf[len + 1] == (int)KE_CSI)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003285 // CSI is stored as CSI KS_SPECIAL KE_CSI to avoid confusion with
3286 // the start of a special key, see add_to_input_buf_csi().
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003287 len += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 bytes[i] = c;
3289 }
3290 return len;
3291}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292
3293/*
Bram Moolenaare057d402013-06-30 17:51:51 +02003294 * Check if the new shell size is valid, correct it if it's too small or way
3295 * too big.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 */
3297 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003298check_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003300 if (Rows < min_rows()) // need room for one window and command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 Rows = min_rows();
Bram Moolenaare057d402013-06-30 17:51:51 +02003302 limit_screen_size();
3303}
3304
3305/*
3306 * Limit Rows and Columns to avoid an overflow in Rows * Columns.
3307 */
3308 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003309limit_screen_size(void)
Bram Moolenaare057d402013-06-30 17:51:51 +02003310{
3311 if (Columns < MIN_COLUMNS)
3312 Columns = MIN_COLUMNS;
3313 else if (Columns > 10000)
3314 Columns = 10000;
3315 if (Rows > 1000)
3316 Rows = 1000;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317}
3318
Bram Moolenaar86b68352004-12-27 21:59:20 +00003319/*
3320 * Invoked just before the screen structures are going to be (re)allocated.
3321 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003323win_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324{
3325 static int old_Rows = 0;
3326 static int old_Columns = 0;
3327
3328 if (old_Rows != Rows || old_Columns != Columns)
3329 ui_new_shellsize();
3330 if (old_Rows != Rows)
3331 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003332 // if 'window' uses the whole screen, keep it using that
Bram Moolenaar19a09a12005-03-04 23:39:37 +00003333 if (p_window == old_Rows - 1 || old_Rows == 0)
Bram Moolenaar4399ef42005-02-12 14:29:27 +00003334 p_window = Rows - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 old_Rows = Rows;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003336 shell_new_rows(); // update window sizes
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 }
3338 if (old_Columns != Columns)
3339 {
3340 old_Columns = Columns;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003341 shell_new_columns(); // update window sizes
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 }
3343}
3344
3345/*
3346 * Call this function when the Vim shell has been resized in any way.
3347 * Will obtain the current size and redraw (also when size didn't change).
3348 */
3349 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003350shell_resized(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351{
3352 set_shellsize(0, 0, FALSE);
3353}
3354
3355/*
3356 * Check if the shell size changed. Handle a resize.
3357 * When the size didn't change, nothing happens.
3358 */
3359 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003360shell_resized_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361{
3362 int old_Rows = Rows;
3363 int old_Columns = Columns;
3364
Bram Moolenaar3633dc02012-08-29 16:26:04 +02003365 if (!exiting
3366#ifdef FEAT_GUI
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003367 // Do not get the size when executing a shell command during
3368 // startup.
Bram Moolenaar3633dc02012-08-29 16:26:04 +02003369 && !gui.starting
3370#endif
3371 )
Bram Moolenaar99808352010-12-30 14:47:36 +01003372 {
3373 (void)ui_get_shellsize();
3374 check_shellsize();
3375 if (old_Rows != Rows || old_Columns != Columns)
3376 shell_resized();
3377 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378}
3379
3380/*
3381 * Set size of the Vim shell.
3382 * If 'mustset' is TRUE, we must set Rows and Columns, do not get the real
3383 * window size (this is used for the :win command).
3384 * If 'mustset' is FALSE, we may try to get the real window size and if
3385 * it fails use 'width' and 'height'.
3386 */
3387 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003388set_shellsize(int width, int height, int mustset)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389{
3390 static int busy = FALSE;
3391
3392 /*
3393 * Avoid recursiveness, can happen when setting the window size causes
3394 * another window-changed signal.
3395 */
3396 if (busy)
3397 return;
3398
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003399 if (width < 0 || height < 0) // just checking...
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 return;
3401
Bram Moolenaara971b822011-09-14 14:43:25 +02003402 if (State == HITRETURN || State == SETWSIZE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 {
Bram Moolenaar847a5d62019-07-12 15:37:13 +02003404 // postpone the resizing
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 State = SETWSIZE;
3406 return;
3407 }
3408
Bram Moolenaar847a5d62019-07-12 15:37:13 +02003409 if (updating_screen)
3410 // resizing while in update_screen() may cause a crash
3411 return;
3412
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003413 // curwin->w_buffer can be NULL when we are closing a window and the
3414 // buffer has already been closed and removing a scrollbar causes a resize
3415 // event. Don't resize then, it will happen after entering another buffer.
Bram Moolenaara971b822011-09-14 14:43:25 +02003416 if (curwin->w_buffer == NULL)
3417 return;
3418
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 ++busy;
3420
3421#ifdef AMIGA
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003422 out_flush(); // must do this before mch_get_shellsize() for
3423 // some obscure reason
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424#endif
3425
3426 if (mustset || (ui_get_shellsize() == FAIL && height != 0))
3427 {
3428 Rows = height;
3429 Columns = width;
3430 check_shellsize();
3431 ui_set_shellsize(mustset);
3432 }
3433 else
3434 check_shellsize();
3435
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003436 // The window layout used to be adjusted here, but it now happens in
3437 // screenalloc() (also invoked from screenclear()). That is because the
3438 // "busy" check above may skip this, but not screenalloc().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439
3440 if (State != ASKMORE && State != EXTERNCMD && State != CONFIRM)
3441 screenclear();
3442 else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003443 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444
3445 if (starting != NO_SCREEN)
3446 {
3447#ifdef FEAT_TITLE
3448 maketitle();
3449#endif
3450 changed_line_abv_curs();
3451 invalidate_botline();
3452
3453 /*
3454 * We only redraw when it's needed:
3455 * - While at the more prompt or executing an external command, don't
3456 * redraw, but position the cursor.
3457 * - While editing the command line, only redraw that.
3458 * - in Ex mode, don't redraw anything.
3459 * - Otherwise, redraw right now, and position the cursor.
3460 * Always need to call update_screen() or screenalloc(), to make
3461 * sure Rows/Columns and the size of ScreenLines[] is correct!
3462 */
3463 if (State == ASKMORE || State == EXTERNCMD || State == CONFIRM
3464 || exmode_active)
3465 {
3466 screenalloc(FALSE);
3467 repeat_message();
3468 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 else
3470 {
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003471 if (curwin->w_p_scb)
3472 do_check_scrollbind(TRUE);
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003473 if (State & CMDLINE)
Bram Moolenaar280f1262006-01-30 00:14:18 +00003474 {
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003475 update_screen(NOT_VALID);
3476 redrawcmdline();
Bram Moolenaar280f1262006-01-30 00:14:18 +00003477 }
3478 else
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003479 {
3480 update_topline();
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003481 if (pum_visible())
3482 {
3483 redraw_later(NOT_VALID);
Bram Moolenaara5e66212017-09-29 22:42:33 +02003484 ins_compl_show_pum();
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003485 }
Bram Moolenaara5e66212017-09-29 22:42:33 +02003486 update_screen(NOT_VALID);
Bram Moolenaar09ef47a2006-10-24 19:36:02 +00003487 if (redrawing())
3488 setcursor();
3489 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003491 cursor_on(); // redrawing may have switched it off
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 }
3493 out_flush();
3494 --busy;
3495}
3496
3497/*
3498 * Set the terminal to TMODE_RAW (for Normal mode) or TMODE_COOK (for external
3499 * commands and Ex mode).
3500 */
3501 void
Bram Moolenaarf4e16ae2020-05-17 16:10:11 +02003502settmode(tmode_T tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503{
3504#ifdef FEAT_GUI
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003505 // don't set the term where gvim was started to any mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 if (gui.in_use)
3507 return;
3508#endif
3509
3510 if (full_screen)
3511 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 /*
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02003513 * When returning after calling a shell cur_tmode is TMODE_UNKNOWN,
3514 * set the terminal to raw mode, even though we think it already is,
3515 * because the shell program may have reset the terminal mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 * When we think the terminal is normal, don't try to set it to
3517 * normal again, because that causes problems (logout!) on some
3518 * machines.
3519 */
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02003520 if (tmode != cur_tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 {
3522#ifdef FEAT_TERMRESPONSE
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003523# ifdef FEAT_GUI
3524 if (!gui.in_use && !gui.starting)
3525# endif
3526 {
Bram Moolenaarafd78262019-05-10 23:10:31 +02003527 // May need to check for T_CRV response and termcodes, it
3528 // doesn't work in Cooked mode, an external program may get
3529 // them.
3530 if (tmode != TMODE_RAW && termrequest_any_pending())
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003531 (void)vpeekc_nomap();
3532 check_for_codes_from_term();
3533 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 if (tmode != TMODE_RAW)
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003536 mch_setmouse(FALSE); // switch mouse off
Bram Moolenaar26e86442020-05-17 14:06:16 +02003537
3538 // Disable bracketed paste and modifyOtherKeys in cooked mode.
3539 // Avoid doing this too often, on some terminals the codes are not
3540 // handled properly.
3541 if (termcap_active && tmode != TMODE_SLEEP
3542 && cur_tmode != TMODE_SLEEP)
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003543 {
Bram Moolenaar86394aa2020-09-05 14:27:24 +02003544#ifdef FEAT_JOB_CHANNEL
3545 ch_log_output = TRUE;
3546#endif
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003547 if (tmode != TMODE_RAW)
Bram Moolenaar645e3fe2020-05-16 15:05:04 +02003548 {
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003549 out_str(T_BD); // disable bracketed paste mode
Bram Moolenaar645e3fe2020-05-16 15:05:04 +02003550 out_str(T_CTE); // possibly disables modifyOtherKeys
3551 }
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003552 else
Bram Moolenaar645e3fe2020-05-16 15:05:04 +02003553 {
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003554 out_str(T_BE); // enable bracketed paste mode (should
3555 // be before mch_settmode().
Bram Moolenaar645e3fe2020-05-16 15:05:04 +02003556 out_str(T_CTI); // possibly enables modifyOtherKeys
3557 }
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003558 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 out_flush();
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003560 mch_settmode(tmode); // machine specific function
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 cur_tmode = tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 if (tmode == TMODE_RAW)
Bram Moolenaar958eabe2019-04-21 17:22:33 +02003563 setmouse(); // may switch mouse on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 out_flush();
3565 }
3566#ifdef FEAT_TERMRESPONSE
3567 may_req_termresponse();
3568#endif
3569 }
3570}
3571
3572 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003573starttermcap(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574{
3575 if (full_screen && !termcap_active)
3576 {
Bram Moolenaar86394aa2020-09-05 14:27:24 +02003577#ifdef FEAT_JOB_CHANNEL
3578 ch_log_output = TRUE;
3579#endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003580 out_str(T_TI); // start termcap mode
3581 out_str(T_CTI); // start "raw" mode
3582 out_str(T_KS); // start "keypad transmit" mode
3583 out_str(T_BE); // enable bracketed paste mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 out_flush();
3585 termcap_active = TRUE;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003586 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587#ifdef FEAT_TERMRESPONSE
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003588# ifdef FEAT_GUI
3589 if (!gui.in_use && !gui.starting)
3590# endif
3591 {
3592 may_req_termresponse();
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003593 // Immediately check for a response. If t_Co changes, we don't
3594 // want to redraw with wrong colors first.
Bram Moolenaarafd78262019-05-10 23:10:31 +02003595 if (crv_status.tr_progress == STATUS_SENT)
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003596 check_for_codes_from_term();
3597 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598#endif
3599 }
3600}
3601
3602 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003603stoptermcap(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604{
3605 screen_stop_highlight();
3606 reset_cterm_colors();
3607 if (termcap_active)
3608 {
3609#ifdef FEAT_TERMRESPONSE
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003610# ifdef FEAT_GUI
3611 if (!gui.in_use && !gui.starting)
3612# endif
3613 {
Bram Moolenaarafd78262019-05-10 23:10:31 +02003614 // May need to discard T_CRV, T_U7 or T_RBG response.
3615 if (termrequest_any_pending())
Bram Moolenaar29607ac2013-05-13 20:26:53 +02003616 {
3617# ifdef UNIX
Bram Moolenaarafd78262019-05-10 23:10:31 +02003618 // Give the terminal a chance to respond.
Bram Moolenaar0981c872020-08-23 14:28:37 +02003619 mch_delay(100L, 0);
Bram Moolenaar29607ac2013-05-13 20:26:53 +02003620# endif
3621# ifdef TCIFLUSH
Bram Moolenaarafd78262019-05-10 23:10:31 +02003622 // Discard data received but not read.
Bram Moolenaar29607ac2013-05-13 20:26:53 +02003623 if (exiting)
3624 tcflush(fileno(stdin), TCIFLUSH);
3625# endif
3626 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003627 // Check for termcodes first, otherwise an external program may
3628 // get them.
Bram Moolenaar2bf6a2d2008-07-29 10:22:12 +00003629 check_for_codes_from_term();
3630 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631#endif
Bram Moolenaar86394aa2020-09-05 14:27:24 +02003632#ifdef FEAT_JOB_CHANNEL
3633 ch_log_output = TRUE;
3634#endif
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003635 out_str(T_BD); // disable bracketed paste mode
3636 out_str(T_KE); // stop "keypad transmit" mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 out_flush();
3638 termcap_active = FALSE;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003639 cursor_on(); // just in case it is still off
3640 out_str(T_CTE); // stop "raw" mode
3641 out_str(T_TE); // stop termcap mode
3642 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 out_flush();
3644 }
3645}
3646
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003647#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648/*
3649 * Request version string (for xterm) when needed.
3650 * Only do this after switching to raw mode, otherwise the result will be
3651 * echoed.
Bram Moolenaara40ceaf2006-01-13 22:35:40 +00003652 * Only do this after startup has finished, to avoid that the response comes
Bram Moolenaarcf0dfa22007-05-10 18:52:16 +00003653 * while executing "-c !cmd" or even after "-c quit".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 * Only do this after termcap mode has been started, otherwise the codes for
3655 * the cursor keys may be wrong.
Bram Moolenaarebefac62005-12-28 22:39:57 +00003656 * Only do this when 'esckeys' is on, otherwise the response causes trouble in
3657 * Insert mode.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00003658 * On Unix only do it when both output and input are a tty (avoid writing
3659 * request to terminal while reading from a file).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 * The result is caught in check_termcode().
3661 */
Bram Moolenaara40ceaf2006-01-13 22:35:40 +00003662 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003663may_req_termresponse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664{
Bram Moolenaarafd78262019-05-10 23:10:31 +02003665 if (crv_status.tr_progress == STATUS_GET
Bram Moolenaarba6ec182017-04-04 22:41:10 +02003666 && can_get_termresponse()
Bram Moolenaara40ceaf2006-01-13 22:35:40 +00003667 && starting == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 && *T_CRV != NUL)
3669 {
Bram Moolenaar86394aa2020-09-05 14:27:24 +02003670#ifdef FEAT_JOB_CHANNEL
3671 ch_log_output = TRUE;
3672#endif
Bram Moolenaarb255b902018-04-24 21:40:10 +02003673 LOG_TR(("Sending CRV request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 out_str(T_CRV);
Bram Moolenaarafd78262019-05-10 23:10:31 +02003675 termrequest_sent(&crv_status);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003676 // check for the characters now, otherwise they might be eaten by
3677 // get_keystroke()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 out_flush();
3679 (void)vpeekc_nomap();
3680 }
3681}
Bram Moolenaar9584b312013-03-13 19:29:28 +01003682
Bram Moolenaar9584b312013-03-13 19:29:28 +01003683/*
Bram Moolenaara45551a2020-06-09 15:57:37 +02003684 * Send sequences to the terminal and check with t_u7 how the cursor moves, to
3685 * find out properties of the terminal.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02003686 * Note that this goes out before T_CRV, so that the result can be used when
3687 * the termresponse arrives.
Bram Moolenaar9584b312013-03-13 19:29:28 +01003688 */
3689 void
Bram Moolenaara45551a2020-06-09 15:57:37 +02003690check_terminal_behavior(void)
Bram Moolenaar9584b312013-03-13 19:29:28 +01003691{
Bram Moolenaara45551a2020-06-09 15:57:37 +02003692 int did_send = FALSE;
3693
3694 if (!can_get_termresponse() || starting != 0 || *T_U7 == NUL)
3695 return;
3696
Bram Moolenaarafd78262019-05-10 23:10:31 +02003697 if (u7_status.tr_progress == STATUS_GET
Bram Moolenaar9584b312013-03-13 19:29:28 +01003698 && !option_was_set((char_u *)"ambiwidth"))
3699 {
Bram Moolenaarafd78262019-05-10 23:10:31 +02003700 char_u buf[16];
Bram Moolenaar9584b312013-03-13 19:29:28 +01003701
Bram Moolenaara45551a2020-06-09 15:57:37 +02003702 // Ambiguous width check.
3703 // Check how the terminal treats ambiguous character width (UAX #11).
3704 // First, we move the cursor to (1, 0) and print a test ambiguous
3705 // character \u25bd (WHITE DOWN-POINTING TRIANGLE) and then query
3706 // the current cursor position. If the terminal treats \u25bd as
3707 // single width, the position is (1, 1), or if it is treated as double
3708 // width, that will be (1, 2). This function has the side effect that
3709 // changes cursor position, so it must be called immediately after
3710 // entering termcap mode.
Bram Moolenaar86394aa2020-09-05 14:27:24 +02003711#ifdef FEAT_JOB_CHANNEL
3712 ch_log_output = TRUE;
3713#endif
Bram Moolenaara45551a2020-06-09 15:57:37 +02003714 LOG_TR(("Sending request for ambiwidth check"));
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003715 // Do this in the second row. In the first row the returned sequence
3716 // may be CSI 1;2R, which is the same as <S-F3>.
Bram Moolenaarafd78262019-05-10 23:10:31 +02003717 term_windgoto(1, 0);
Bram Moolenaara45551a2020-06-09 15:57:37 +02003718 buf[mb_char2bytes(0x25bd, buf)] = NUL;
Bram Moolenaarafd78262019-05-10 23:10:31 +02003719 out_str(buf);
3720 out_str(T_U7);
3721 termrequest_sent(&u7_status);
3722 out_flush();
Bram Moolenaara45551a2020-06-09 15:57:37 +02003723 did_send = TRUE;
Bram Moolenaar976787d2017-06-04 15:45:50 +02003724
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003725 // This overwrites a few characters on the screen, a redraw is needed
3726 // after this. Clear them out for now.
Bram Moolenaar06029a82019-07-24 14:25:26 +02003727 screen_stop_highlight();
Bram Moolenaarafd78262019-05-10 23:10:31 +02003728 term_windgoto(1, 0);
3729 out_str((char_u *)" ");
Bram Moolenaar96916ac2020-07-08 23:09:28 +02003730 line_was_clobbered(1);
Bram Moolenaara45551a2020-06-09 15:57:37 +02003731 }
3732
3733 if (xcc_status.tr_progress == STATUS_GET)
3734 {
3735 // 2. Check compatibility with xterm.
3736 // We move the cursor to (2, 0), print a test sequence and then query
3737 // the current cursor position. If the terminal properly handles
3738 // unknown DCS string and CSI sequence with intermediate byte, the test
3739 // sequence is ignored and the cursor does not move. If the terminal
3740 // handles test sequence incorrectly, a garbage string is displayed and
3741 // the cursor does move.
Bram Moolenaar86394aa2020-09-05 14:27:24 +02003742#ifdef FEAT_JOB_CHANNEL
3743 ch_log_output = TRUE;
3744#endif
Bram Moolenaara45551a2020-06-09 15:57:37 +02003745 LOG_TR(("Sending xterm compatibility test sequence."));
3746 // Do this in the third row. Second row is used by ambiguous
3747 // chararacter width check.
3748 term_windgoto(2, 0);
3749 // send the test DCS string.
3750 out_str((char_u *)"\033Pzz\033\\");
3751 // send the test CSI sequence with intermediate byte.
3752 out_str((char_u *)"\033[0%m");
3753 out_str(T_U7);
3754 termrequest_sent(&xcc_status);
3755 out_flush();
3756 did_send = TRUE;
3757
3758 // If the terminal handles test sequence incorrectly, garbage text is
3759 // displayed. Clear them out for now.
3760 screen_stop_highlight();
3761 term_windgoto(2, 0);
3762 out_str((char_u *)" ");
Bram Moolenaar96916ac2020-07-08 23:09:28 +02003763 line_was_clobbered(2);
Bram Moolenaara45551a2020-06-09 15:57:37 +02003764 }
3765
3766 if (did_send)
3767 {
Bram Moolenaarafd78262019-05-10 23:10:31 +02003768 term_windgoto(0, 0);
Bram Moolenaar976787d2017-06-04 15:45:50 +02003769
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003770 // Need to reset the known cursor position.
Bram Moolenaarafd78262019-05-10 23:10:31 +02003771 screen_start();
Bram Moolenaar05684312017-12-09 15:11:24 +01003772
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003773 // check for the characters now, otherwise they might be eaten by
3774 // get_keystroke()
Bram Moolenaarafd78262019-05-10 23:10:31 +02003775 out_flush();
3776 (void)vpeekc_nomap();
Bram Moolenaar9584b312013-03-13 19:29:28 +01003777 }
3778}
Bram Moolenaar2951b772013-07-03 12:45:31 +02003779
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003780/*
Bram Moolenaar4921c242015-06-27 18:34:24 +02003781 * Similar to requesting the version string: Request the terminal background
3782 * color when it is the right moment.
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003783 */
3784 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003785may_req_bg_color(void)
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003786{
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003787 if (can_get_termresponse() && starting == 0)
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003788 {
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003789 int didit = FALSE;
3790
Bram Moolenaar00ce63d2017-10-15 21:44:45 +02003791# ifdef FEAT_TERMINAL
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003792 // Only request foreground if t_RF is set.
Bram Moolenaarafd78262019-05-10 23:10:31 +02003793 if (rfg_status.tr_progress == STATUS_GET && *T_RFG != NUL)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003794 {
Bram Moolenaar86394aa2020-09-05 14:27:24 +02003795#ifdef FEAT_JOB_CHANNEL
3796 ch_log_output = TRUE;
3797#endif
Bram Moolenaarb255b902018-04-24 21:40:10 +02003798 LOG_TR(("Sending FG request"));
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003799 out_str(T_RFG);
Bram Moolenaarafd78262019-05-10 23:10:31 +02003800 termrequest_sent(&rfg_status);
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003801 didit = TRUE;
3802 }
Bram Moolenaar00ce63d2017-10-15 21:44:45 +02003803# endif
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003804
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003805 // Only request background if t_RB is set.
Bram Moolenaarafd78262019-05-10 23:10:31 +02003806 if (rbg_status.tr_progress == STATUS_GET && *T_RBG != NUL)
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003807 {
Bram Moolenaar86394aa2020-09-05 14:27:24 +02003808#ifdef FEAT_JOB_CHANNEL
3809 ch_log_output = TRUE;
3810#endif
Bram Moolenaarb255b902018-04-24 21:40:10 +02003811 LOG_TR(("Sending BG request"));
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003812 out_str(T_RBG);
Bram Moolenaarafd78262019-05-10 23:10:31 +02003813 termrequest_sent(&rbg_status);
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003814 didit = TRUE;
3815 }
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003816
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02003817 if (didit)
3818 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003819 // check for the characters now, otherwise they might be eaten by
3820 // get_keystroke()
Bram Moolenaar833e0e32017-08-26 15:16:03 +02003821 out_flush();
3822 (void)vpeekc_nomap();
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003823 }
3824 }
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003825}
Bram Moolenaarb5c32652015-06-25 17:03:36 +02003826
Bram Moolenaar2951b772013-07-03 12:45:31 +02003827# ifdef DEBUG_TERMRESPONSE
3828 static void
Bram Moolenaarb255b902018-04-24 21:40:10 +02003829log_tr(const char *fmt, ...)
Bram Moolenaar2951b772013-07-03 12:45:31 +02003830{
3831 static FILE *fd_tr = NULL;
3832 static proftime_T start;
3833 proftime_T now;
Bram Moolenaarb255b902018-04-24 21:40:10 +02003834 va_list ap;
Bram Moolenaar2951b772013-07-03 12:45:31 +02003835
3836 if (fd_tr == NULL)
3837 {
3838 fd_tr = fopen("termresponse.log", "w");
3839 profile_start(&start);
3840 }
3841 now = start;
3842 profile_end(&now);
Bram Moolenaarb255b902018-04-24 21:40:10 +02003843 fprintf(fd_tr, "%s: %s ", profile_msg(&now),
3844 must_redraw == NOT_VALID ? "NV"
3845 : must_redraw == CLEAR ? "CL" : " ");
3846 va_start(ap, fmt);
3847 vfprintf(fd_tr, fmt, ap);
3848 va_end(ap);
3849 fputc('\n', fd_tr);
3850 fflush(fd_tr);
Bram Moolenaar2951b772013-07-03 12:45:31 +02003851}
3852# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853#endif
3854
3855/*
3856 * Return TRUE when saving and restoring the screen.
3857 */
3858 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003859swapping_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860{
3861 return (full_screen && *T_TI != NUL);
3862}
3863
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864/*
3865 * By outputting the 'cursor very visible' termcap code, for some windowed
3866 * terminals this makes the screen scrolled to the correct position.
3867 * Used when starting Vim or returning from a shell.
3868 */
3869 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003870scroll_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871{
Bram Moolenaarce1c3272017-08-20 15:05:15 +02003872 if (*T_VS != NUL && *T_CVS != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 {
Bram Moolenaar86394aa2020-09-05 14:27:24 +02003874#ifdef FEAT_JOB_CHANNEL
3875 ch_log_output = TRUE;
3876#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 out_str(T_VS);
Bram Moolenaarce1c3272017-08-20 15:05:15 +02003878 out_str(T_CVS);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003879 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 }
3881}
3882
3883static int cursor_is_off = FALSE;
3884
3885/*
Bram Moolenaar2e310482018-08-21 13:09:10 +02003886 * Enable the cursor without checking if it's already enabled.
3887 */
3888 void
3889cursor_on_force(void)
3890{
3891 out_str(T_VE);
3892 cursor_is_off = FALSE;
3893}
3894
3895/*
3896 * Enable the cursor if it's currently off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 */
3898 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003899cursor_on(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900{
3901 if (cursor_is_off)
Bram Moolenaar2e310482018-08-21 13:09:10 +02003902 cursor_on_force();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903}
3904
3905/*
3906 * Disable the cursor.
3907 */
3908 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01003909cursor_off(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910{
Bram Moolenaarce1c3272017-08-20 15:05:15 +02003911 if (full_screen && !cursor_is_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003913 out_str(T_VI); // disable cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 cursor_is_off = TRUE;
3915 }
3916}
3917
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003918#if defined(CURSOR_SHAPE) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919/*
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003920 * Set cursor shape to match Insert or Replace mode.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003921 */
3922 void
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003923term_cursor_mode(int forced)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003924{
Bram Moolenaarc9770922017-08-12 20:11:53 +02003925 static int showing_mode = -1;
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003926 char_u *p;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003927
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003928 // Only do something when redrawing the screen and we can restore the
3929 // mode.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003930 if (!full_screen || *T_CEI == NUL)
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003931 {
Bram Moolenaar37b9b812017-08-19 23:23:43 +02003932# ifdef FEAT_TERMRESPONSE
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003933 if (forced && initial_cursor_shape > 0)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003934 // Restore to initial values.
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003935 term_cursor_shape(initial_cursor_shape, initial_cursor_blink);
Bram Moolenaar37b9b812017-08-19 23:23:43 +02003936# endif
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003937 return;
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02003938 }
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003939
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003940 if ((State & REPLACE) == REPLACE)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003941 {
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003942 if (forced || showing_mode != REPLACE)
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003943 {
3944 if (*T_CSR != NUL)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003945 p = T_CSR; // Replace mode cursor
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003946 else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003947 p = T_CSI; // fall back to Insert mode cursor
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003948 if (*p != NUL)
3949 {
3950 out_str(p);
3951 showing_mode = REPLACE;
3952 }
3953 }
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003954 }
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003955 else if (State & INSERT)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003956 {
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003957 if ((forced || showing_mode != INSERT) && *T_CSI != NUL)
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003958 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003959 out_str(T_CSI); // Insert mode cursor
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003960 showing_mode = INSERT;
3961 }
3962 }
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003963 else if (forced || showing_mode != NORMAL)
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003964 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01003965 out_str(T_CEI); // non-Insert mode cursor
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003966 showing_mode = NORMAL;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003967 }
3968}
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003969
3970# if defined(FEAT_TERMINAL) || defined(PROTO)
3971 void
3972term_cursor_color(char_u *color)
3973{
3974 if (*T_CSC != NUL)
3975 {
Bram Moolenaarec6f7352019-10-24 17:49:27 +02003976 out_str(T_CSC); // set cursor color start
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003977 out_str_nf(color);
Bram Moolenaarec6f7352019-10-24 17:49:27 +02003978 out_str(T_CEC); // set cursor color end
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003979 out_flush();
3980 }
3981}
Bram Moolenaarfc8bec02017-08-19 19:57:34 +02003982# endif
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003983
Bram Moolenaar4db25542017-08-28 22:43:05 +02003984 int
3985blink_state_is_inverted()
3986{
Bram Moolenaar3c37a8e2017-08-28 23:00:55 +02003987#ifdef FEAT_TERMRESPONSE
Bram Moolenaar66761db2019-06-05 22:07:51 +02003988 return rbm_status.tr_progress == STATUS_GOT
3989 && rcs_status.tr_progress == STATUS_GOT
Bram Moolenaar4db25542017-08-28 22:43:05 +02003990 && initial_cursor_blink != initial_cursor_shape_blink;
Bram Moolenaar3c37a8e2017-08-28 23:00:55 +02003991#else
3992 return FALSE;
3993#endif
Bram Moolenaar4db25542017-08-28 22:43:05 +02003994}
3995
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003996/*
Bram Moolenaarce1c3272017-08-20 15:05:15 +02003997 * "shape": 1 = block, 2 = underline, 3 = vertical bar
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02003998 */
3999 void
4000term_cursor_shape(int shape, int blink)
4001{
4002 if (*T_CSH != NUL)
4003 {
4004 OUT_STR(tgoto((char *)T_CSH, 0, shape * 2 - blink));
4005 out_flush();
4006 }
Bram Moolenaar4db25542017-08-28 22:43:05 +02004007 else
Bram Moolenaarce1c3272017-08-20 15:05:15 +02004008 {
Bram Moolenaar4db25542017-08-28 22:43:05 +02004009 int do_blink = blink;
4010
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004011 // t_SH is empty: try setting just the blink state.
4012 // The blink flags are XORed together, if the initial blinking from
4013 // style and shape differs, we need to invert the flag here.
Bram Moolenaar4db25542017-08-28 22:43:05 +02004014 if (blink_state_is_inverted())
4015 do_blink = !blink;
4016
4017 if (do_blink && *T_VS != NUL)
4018 {
4019 out_str(T_VS);
4020 out_flush();
4021 }
4022 else if (!do_blink && *T_CVS != NUL)
4023 {
4024 out_str(T_CVS);
4025 out_flush();
4026 }
Bram Moolenaarce1c3272017-08-20 15:05:15 +02004027 }
Bram Moolenaar3cd43cc2017-08-12 19:51:41 +02004028}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004029#endif
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004030
4031/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 * Set scrolling region for window 'wp'.
4033 * The region starts 'off' lines from the start of the window.
4034 * Also set the vertical scroll region for a vertically split window. Always
4035 * the full width of the window, excluding the vertical separator.
4036 */
4037 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004038scroll_region_set(win_T *wp, int off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039{
4040 OUT_STR(tgoto((char *)T_CS, W_WINROW(wp) + wp->w_height - 1,
4041 W_WINROW(wp) + off));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 if (*T_CSV != NUL && wp->w_width != Columns)
Bram Moolenaar53f81742017-09-22 14:35:51 +02004043 OUT_STR(tgoto((char *)T_CSV, wp->w_wincol + wp->w_width - 1,
4044 wp->w_wincol));
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004045 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046}
4047
4048/*
4049 * Reset scrolling region to the whole screen.
4050 */
4051 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004052scroll_region_reset(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053{
4054 OUT_STR(tgoto((char *)T_CS, (int)Rows - 1, 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 if (*T_CSV != NUL)
4056 OUT_STR(tgoto((char *)T_CSV, (int)Columns - 1, 0));
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004057 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058}
4059
4060
4061/*
4062 * List of terminal codes that are currently recognized.
4063 */
4064
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +00004065static struct termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004067 char_u name[2]; // termcap name of entry
4068 char_u *code; // terminal code (in allocated memory)
4069 int len; // STRLEN(code)
4070 int modlen; // length of part before ";*~".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071} *termcodes = NULL;
4072
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004073static int tc_max_len = 0; // number of entries that termcodes[] can hold
4074static int tc_len = 0; // current number of entries in termcodes[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +01004076static int termcode_star(char_u *code, int len);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004077
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004079clear_termcodes(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080{
4081 while (tc_len > 0)
4082 vim_free(termcodes[--tc_len].code);
Bram Moolenaard23a8232018-02-10 18:45:26 +01004083 VIM_CLEAR(termcodes);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 tc_max_len = 0;
4085
4086#ifdef HAVE_TGETENT
4087 BC = (char *)empty_option;
4088 UP = (char *)empty_option;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004089 PC = NUL; // set pad character to NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 ospeed = 0;
4091#endif
4092
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004093 need_gather = TRUE; // need to fill termleader[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094}
4095
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004096#define ATC_FROM_TERM 55
4097
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098/*
4099 * Add a new entry to the list of terminal codes.
4100 * The list is kept alphabetical for ":set termcap"
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004101 * "flags" is TRUE when replacing 7-bit by 8-bit controls is desired.
4102 * "flags" can also be ATC_FROM_TERM for got_code_from_term().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 */
4104 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004105add_termcode(char_u *name, char_u *string, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106{
4107 struct termcode *new_tc;
4108 int i, j;
4109 char_u *s;
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004110 int len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111
4112 if (string == NULL || *string == NUL)
4113 {
4114 del_termcode(name);
4115 return;
4116 }
4117
Bram Moolenaar4f974752019-02-17 17:44:42 +01004118#if defined(MSWIN) && !defined(FEAT_GUI)
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004119 s = vim_strnsave(string, STRLEN(string) + 1);
Bram Moolenaar45500912014-07-09 20:51:07 +02004120#else
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004121# ifdef VIMDLL
4122 if (!gui.in_use)
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004123 s = vim_strnsave(string, STRLEN(string) + 1);
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004124 else
4125# endif
4126 s = vim_strsave(string);
Bram Moolenaar45500912014-07-09 20:51:07 +02004127#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 if (s == NULL)
4129 return;
4130
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004131 // Change leading <Esc>[ to CSI, change <Esc>O to <M-O>.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004132 if (flags != 0 && flags != ATC_FROM_TERM && term_7to8bit(string) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 {
Bram Moolenaar864207d2008-06-24 22:14:38 +00004134 STRMOVE(s, s + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 s[0] = term_7to8bit(string);
4136 }
Bram Moolenaar45500912014-07-09 20:51:07 +02004137
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004138#if defined(MSWIN) && (!defined(FEAT_GUI) || defined(VIMDLL))
4139# ifdef VIMDLL
4140 if (!gui.in_use)
4141# endif
Bram Moolenaar45500912014-07-09 20:51:07 +02004142 {
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004143 if (s[0] == K_NUL)
4144 {
4145 STRMOVE(s + 1, s);
4146 s[1] = 3;
4147 }
Bram Moolenaar45500912014-07-09 20:51:07 +02004148 }
4149#endif
4150
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004151 len = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004153 need_gather = TRUE; // need to fill termleader[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154
4155 /*
4156 * need to make space for more entries
4157 */
4158 if (tc_len == tc_max_len)
4159 {
4160 tc_max_len += 20;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004161 new_tc = ALLOC_MULT(struct termcode, tc_max_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 if (new_tc == NULL)
4163 {
4164 tc_max_len -= 20;
4165 return;
4166 }
4167 for (i = 0; i < tc_len; ++i)
4168 new_tc[i] = termcodes[i];
4169 vim_free(termcodes);
4170 termcodes = new_tc;
4171 }
4172
4173 /*
4174 * Look for existing entry with the same name, it is replaced.
4175 * Look for an existing entry that is alphabetical higher, the new entry
4176 * is inserted in front of it.
4177 */
4178 for (i = 0; i < tc_len; ++i)
4179 {
4180 if (termcodes[i].name[0] < name[0])
4181 continue;
4182 if (termcodes[i].name[0] == name[0])
4183 {
4184 if (termcodes[i].name[1] < name[1])
4185 continue;
4186 /*
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004187 * Exact match: May replace old code.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 */
4189 if (termcodes[i].name[1] == name[1])
4190 {
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004191 if (flags == ATC_FROM_TERM && (j = termcode_star(
4192 termcodes[i].code, termcodes[i].len)) > 0)
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004193 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004194 // Don't replace ESC[123;*X or ESC O*X with another when
4195 // invoked from got_code_from_term().
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004196 if (len == termcodes[i].len - j
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004197 && STRNCMP(s, termcodes[i].code, len - 1) == 0
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004198 && s[len - 1]
4199 == termcodes[i].code[termcodes[i].len - 1])
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004200 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004201 // They are equal but for the ";*": don't add it.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004202 vim_free(s);
4203 return;
4204 }
4205 }
4206 else
4207 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004208 // Replace old code.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004209 vim_free(termcodes[i].code);
4210 --tc_len;
4211 break;
4212 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 }
4214 }
4215 /*
4216 * Found alphabetical larger entry, move rest to insert new entry
4217 */
4218 for (j = tc_len; j > i; --j)
4219 termcodes[j] = termcodes[j - 1];
4220 break;
4221 }
4222
4223 termcodes[i].name[0] = name[0];
4224 termcodes[i].name[1] = name[1];
4225 termcodes[i].code = s;
Bram Moolenaar19a09a12005-03-04 23:39:37 +00004226 termcodes[i].len = len;
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004227
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004228 // For xterm we recognize special codes like "ESC[42;*X" and "ESC O*X" that
4229 // accept modifiers.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004230 termcodes[i].modlen = 0;
4231 j = termcode_star(s, len);
4232 if (j > 0)
4233 termcodes[i].modlen = len - 1 - j;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 ++tc_len;
4235}
4236
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004237/*
Bram Moolenaara529ce02017-06-22 22:37:57 +02004238 * Check termcode "code[len]" for ending in ;*X or *X.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004239 * The "X" can be any character.
Bram Moolenaara529ce02017-06-22 22:37:57 +02004240 * Return 0 if not found, 2 for ;*X and 1 for *X.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004241 */
4242 static int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004243termcode_star(char_u *code, int len)
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004244{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004245 // Shortest is <M-O>*X. With ; shortest is <CSI>1;*X
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004246 if (len >= 3 && code[len - 2] == '*')
4247 {
4248 if (len >= 5 && code[len - 3] == ';')
4249 return 2;
Bram Moolenaara529ce02017-06-22 22:37:57 +02004250 else
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004251 return 1;
4252 }
4253 return 0;
4254}
4255
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 char_u *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004257find_termcode(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258{
4259 int i;
4260
4261 for (i = 0; i < tc_len; ++i)
4262 if (termcodes[i].name[0] == name[0] && termcodes[i].name[1] == name[1])
4263 return termcodes[i].code;
4264 return NULL;
4265}
4266
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 char_u *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004268get_termcode(int i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269{
4270 if (i >= tc_len)
4271 return NULL;
4272 return &termcodes[i].name[0];
4273}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02004275/*
4276 * Returns the length of the terminal code at index 'idx'.
4277 */
4278 int
4279get_termcode_len(int idx)
4280{
4281 return termcodes[idx].len;
4282}
4283
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02004284 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004285del_termcode(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286{
4287 int i;
4288
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004289 if (termcodes == NULL) // nothing there yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 return;
4291
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004292 need_gather = TRUE; // need to fill termleader[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293
4294 for (i = 0; i < tc_len; ++i)
4295 if (termcodes[i].name[0] == name[0] && termcodes[i].name[1] == name[1])
4296 {
4297 del_termcode_idx(i);
4298 return;
4299 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004300 // not found. Give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301}
4302
4303 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004304del_termcode_idx(int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305{
4306 int i;
4307
4308 vim_free(termcodes[idx].code);
4309 --tc_len;
4310 for (i = idx; i < tc_len; ++i)
4311 termcodes[i] = termcodes[i + 1];
4312}
4313
4314#ifdef FEAT_TERMRESPONSE
4315/*
4316 * Called when detected that the terminal sends 8-bit codes.
4317 * Convert all 7-bit codes to their 8-bit equivalent.
4318 */
4319 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004320switch_to_8bit(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321{
4322 int i;
4323 int c;
4324
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004325 // Only need to do something when not already using 8-bit codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 if (!term_is_8bit(T_NAME))
4327 {
4328 for (i = 0; i < tc_len; ++i)
4329 {
4330 c = term_7to8bit(termcodes[i].code);
4331 if (c != 0)
4332 {
Bram Moolenaar864207d2008-06-24 22:14:38 +00004333 STRMOVE(termcodes[i].code + 1, termcodes[i].code + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 termcodes[i].code[0] = c;
4335 }
4336 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01004337 need_gather = TRUE; // need to fill termleader[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 }
4339 detected_8bit = TRUE;
Bram Moolenaarb255b902018-04-24 21:40:10 +02004340 LOG_TR(("Switching to 8 bit"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341}
4342#endif
4343
4344#ifdef CHECK_DOUBLE_CLICK
4345static linenr_T orig_topline = 0;
4346# ifdef FEAT_DIFF
4347static int orig_topfill = 0;
4348# endif
4349#endif
Bram Moolenaar4033c552017-09-16 20:54:51 +02004350#if defined(CHECK_DOUBLE_CLICK) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351/*
4352 * Checking for double clicks ourselves.
4353 * "orig_topline" is used to avoid detecting a double-click when the window
4354 * contents scrolled (e.g., when 'scrolloff' is non-zero).
4355 */
4356/*
4357 * Set orig_topline. Used when jumping to another window, so that a double
4358 * click still works.
4359 */
4360 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01004361set_mouse_topline(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362{
4363 orig_topline = wp->w_topline;
4364# ifdef FEAT_DIFF
4365 orig_topfill = wp->w_topfill;
4366# endif
4367}
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02004368
4369/*
4370 * Returns TRUE if the top line and top fill of window 'wp' matches the saved
4371 * topline and topfill.
4372 */
4373 int
4374is_mouse_topline(win_T *wp)
4375{
4376 return orig_topline == wp->w_topline
4377#ifdef FEAT_DIFF
4378 && orig_topfill == wp->w_topfill
4379#endif
4380 ;
4381}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382#endif
4383
4384/*
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02004385 * Put "string[new_slen]" in typebuf, or in "buf[bufsize]" if "buf" is not NULL.
4386 * Remove "slen" bytes.
4387 * Returns FAIL for error.
4388 */
Bram Moolenaar975a8802020-06-06 22:36:24 +02004389 int
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02004390put_string_in_typebuf(
4391 int offset,
4392 int slen,
4393 char_u *string,
4394 int new_slen,
4395 char_u *buf,
4396 int bufsize,
4397 int *buflen)
4398{
4399 int extra = new_slen - slen;
4400
4401 string[new_slen] = NUL;
4402 if (buf == NULL)
4403 {
4404 if (extra < 0)
4405 // remove matched chars, taking care of noremap
4406 del_typebuf(-extra, offset);
4407 else if (extra > 0)
4408 // insert the extra space we need
4409 ins_typebuf(string + slen, REMAP_YES, offset, FALSE, FALSE);
4410
4411 // Careful: del_typebuf() and ins_typebuf() may have reallocated
4412 // typebuf.tb_buf[]!
4413 mch_memmove(typebuf.tb_buf + typebuf.tb_off + offset, string,
4414 (size_t)new_slen);
4415 }
4416 else
4417 {
4418 if (extra < 0)
4419 // remove matched characters
4420 mch_memmove(buf + offset, buf + offset - extra,
4421 (size_t)(*buflen + offset + extra));
4422 else if (extra > 0)
4423 {
4424 // Insert the extra space we need. If there is insufficient
4425 // space return -1.
4426 if (*buflen + extra + new_slen >= bufsize)
4427 return FAIL;
4428 mch_memmove(buf + offset + extra, buf + offset,
4429 (size_t)(*buflen - offset));
4430 }
4431 mch_memmove(buf + offset, string, (size_t)new_slen);
4432 *buflen = *buflen + extra + new_slen;
4433 }
4434 return OK;
4435}
4436
4437/*
4438 * Decode a modifier number as xterm provides it into MOD_MASK bits.
4439 */
Bram Moolenaarfc4ea2a2019-11-26 19:33:22 +01004440 int
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02004441decode_modifiers(int n)
4442{
4443 int code = n - 1;
4444 int modifiers = 0;
4445
4446 if (code & 1)
4447 modifiers |= MOD_MASK_SHIFT;
4448 if (code & 2)
4449 modifiers |= MOD_MASK_ALT;
4450 if (code & 4)
4451 modifiers |= MOD_MASK_CTRL;
4452 if (code & 8)
4453 modifiers |= MOD_MASK_META;
4454 return modifiers;
4455}
4456
4457 static int
4458modifiers2keycode(int modifiers, int *key, char_u *string)
4459{
4460 int new_slen = 0;
4461
4462 if (modifiers != 0)
4463 {
4464 // Some keys have the modifier included. Need to handle that here to
4465 // make mappings work.
4466 *key = simplify_key(*key, &modifiers);
4467 if (modifiers != 0)
4468 {
4469 string[new_slen++] = K_SPECIAL;
4470 string[new_slen++] = (int)KS_MODIFIER;
4471 string[new_slen++] = modifiers;
4472 }
4473 }
4474 return new_slen;
4475}
4476
Bram Moolenaar0ca8b5b2020-06-09 21:35:36 +02004477#ifdef FEAT_TERMRESPONSE
4478/*
4479 * Handle a cursor position report.
4480 */
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004481 static void
Bram Moolenaar0ca8b5b2020-06-09 21:35:36 +02004482handle_u7_response(int *arg, char_u *tp UNUSED, int csi_len UNUSED)
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004483{
4484 if (arg[0] == 2 && arg[1] >= 2)
4485 {
4486 char *aw = NULL;
4487
4488 LOG_TR(("Received U7 status: %s", tp));
4489 u7_status.tr_progress = STATUS_GOT;
4490 did_cursorhold = TRUE;
4491 if (arg[1] == 2)
4492 aw = "single";
4493 else if (arg[1] == 3)
4494 aw = "double";
4495 if (aw != NULL && STRCMP(aw, p_ambw) != 0)
4496 {
4497 // Setting the option causes a screen redraw. Do
4498 // that right away if possible, keeping any
4499 // messages.
Bram Moolenaar0ca8b5b2020-06-09 21:35:36 +02004500 set_option_value((char_u *)"ambw", 0L, (char_u *)aw, 0);
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004501# ifdef DEBUG_TERMRESPONSE
4502 {
4503 int r = redraw_asap(CLEAR);
4504
4505 log_tr("set 'ambiwidth', redraw_asap(): %d", r);
4506 }
4507# else
4508 redraw_asap(CLEAR);
4509# endif
4510# ifdef FEAT_EVAL
4511 set_vim_var_string(VV_TERMU7RESP, tp, csi_len);
4512# endif
4513 }
4514 }
4515 else if (arg[0] == 3)
4516 {
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004517 int value;
4518
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004519 LOG_TR(("Received compatibility test result: %s", tp));
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004520 xcc_status.tr_progress = STATUS_GOT;
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004521
4522 // Third row: xterm compatibility test.
4523 // If the cursor is on the first column then the terminal can handle
4524 // the request for cursor style and blinking.
4525 value = arg[1] == 1 ? TPR_YES : TPR_NO;
4526 term_props[TPR_CURSOR_STYLE].tpr_status = value;
4527 term_props[TPR_CURSOR_BLINK].tpr_status = value;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004528 }
4529}
4530
4531/*
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004532 * Handle a response to T_CRV: {lead}{first}{x};{vers};{y}c
4533 * Xterm and alikes use '>' for {first}.
4534 * Rxvt sends "{lead}?1;2c".
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004535 */
4536 static void
4537handle_version_response(int first, int *arg, int argc, char_u *tp)
4538{
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004539 // The xterm version. It is set to zero when it can't be an actual xterm
4540 // version.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004541 int version = arg[1];
4542
4543 LOG_TR(("Received CRV response: %s", tp));
4544 crv_status.tr_progress = STATUS_GOT;
4545 did_cursorhold = TRUE;
4546
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004547 // Reset terminal properties that are set based on the termresponse.
4548 // Mainly useful for tests that send the termresponse multiple times.
Bram Moolenaar0c0eddd2020-06-13 15:47:25 +02004549 // For testing all props can be reset.
Bram Moolenaar142499d2020-06-13 16:39:31 +02004550 init_term_props(
4551#ifdef FEAT_EVAL
4552 reset_term_props_on_termresponse
4553#else
4554 FALSE
4555#endif
4556 );
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004557
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004558 // If this code starts with CSI, you can bet that the
4559 // terminal uses 8-bit codes.
4560 if (tp[0] == CSI)
4561 switch_to_8bit();
4562
4563 // Screen sends 40500.
4564 // rxvt sends its version number: "20703" is 2.7.3.
4565 // Ignore it for when the user has set 'term' to xterm,
4566 // even though it's an rxvt.
4567 if (version > 20000)
4568 version = 0;
4569
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004570 // Figure out more if the reeponse is CSI > 99 ; 99 ; 99 c
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004571 if (first == '>' && argc == 3)
4572 {
4573 int need_flush = FALSE;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004574
4575 // mintty 2.9.5 sends 77;20905;0c.
4576 // (77 is ASCII 'M' for mintty.)
4577 if (arg[0] == 77)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004578 {
4579 // mintty can do SGR mouse reporting
4580 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
4581 }
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004582
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004583 // If xterm version >= 141 try to get termcap codes. For other
4584 // terminals the request should be ignored.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004585 if (version >= 141)
4586 {
4587 LOG_TR(("Enable checking for XT codes"));
4588 check_for_codes = TRUE;
4589 need_gather = TRUE;
4590 req_codes_from_term();
4591 }
4592
4593 // libvterm sends 0;100;0
4594 if (version == 100 && arg[0] == 0 && arg[2] == 0)
4595 {
4596 // If run from Vim $COLORS is set to the number of
4597 // colors the terminal supports. Otherwise assume
4598 // 256, libvterm supports even more.
4599 if (mch_getenv((char_u *)"COLORS") == NULL)
4600 may_adjust_color_count(256);
4601 // Libvterm can handle SGR mouse reporting.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004602 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004603 }
4604
4605 if (version == 95)
4606 {
4607 // Mac Terminal.app sends 1;95;0
4608 if (arg[0] == 1 && arg[2] == 0)
4609 {
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004610 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
4611 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004612 }
4613 // iTerm2 sends 0;95;0
4614 else if (arg[0] == 0 && arg[2] == 0)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004615 {
4616 // iTerm2 can do SGR mouse reporting
4617 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
4618 }
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004619 // old iTerm2 sends 0;95;
4620 else if (arg[0] == 0 && arg[2] == -1)
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 }
4623
4624 // screen sends 83;40500;0 83 is 'S' in ASCII.
4625 if (arg[0] == 83)
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004626 {
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004627 // screen supports SGR mouse codes since 4.7.0
4628 if (arg[1] >= 40700)
4629 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
4630 else
4631 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_XTERM;
4632 }
4633
4634 // If no recognized terminal has set mouse behavior, assume xterm.
4635 if (term_props[TPR_MOUSE].tpr_status == TPR_UNKNOWN)
4636 {
4637 // Xterm version 277 supports SGR.
4638 // Xterm version >= 95 supports mouse dragging.
4639 if (version >= 277)
4640 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004641 else if (version >= 95)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004642 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_XTERM2;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004643 }
4644
4645 // Detect terminals that set $TERM to something like
4646 // "xterm-256color" but are not fully xterm compatible.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004647 //
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004648 // Gnome terminal sends 1;3801;0, 1;4402;0 or 1;2501;0.
Bram Moolenaar8dff4cb2020-06-14 14:34:16 +02004649 // Newer Gnome-terminal sends 65;6001;1.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004650 // xfce4-terminal sends 1;2802;0.
4651 // screen sends 83;40500;0
4652 // Assuming any version number over 2500 is not an
4653 // xterm (without the limit for rxvt and screen).
4654 if (arg[1] >= 2500)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004655 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004656
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004657 else if (version == 136 && arg[2] == 0)
4658 {
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004659 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004660
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004661 // PuTTY sends 0;136;0
4662 if (arg[0] == 0)
4663 {
4664 // supports sgr-like mouse reporting.
4665 term_props[TPR_MOUSE].tpr_status = TPR_MOUSE_SGR;
4666 }
4667 // vandyke SecureCRT sends 1;136;0
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004668 }
4669
4670 // Konsole sends 0;115;0
4671 else if (version == 115 && arg[0] == 0 && arg[2] == 0)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004672 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004673
4674 // GNU screen sends 83;30600;0, 83;40500;0, etc.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004675 // 30600/40500 is a version number of GNU screen. DA2 support is added
4676 // on 3.6. DCS string has a special meaning to GNU screen, but xterm
4677 // compatibility checking does not detect GNU screen.
4678 if (arg[0] == 83 && arg[1] >= 30600)
4679 {
4680 term_props[TPR_CURSOR_STYLE].tpr_status = TPR_NO;
4681 term_props[TPR_CURSOR_BLINK].tpr_status = TPR_NO;
4682 }
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004683
4684 // Xterm first responded to this request at patch level
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004685 // 95, so assume anything below 95 is not xterm and hopefully supports
4686 // the underline RGB color sequence.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004687 if (version < 95)
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004688 term_props[TPR_UNDERLINE_RGB].tpr_status = TPR_YES;
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004689
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004690 // Getting the cursor style is only supported properly by xterm since
4691 // version 279 (otherwise it returns 0x18).
4692 if (version < 279)
4693 term_props[TPR_CURSOR_STYLE].tpr_status = TPR_NO;
4694
4695 /*
4696 * Take action on the detected properties.
4697 */
4698
4699 // Unless the underline RGB color is expected to work, disable "t_8u".
4700 // It does not work for the real Xterm, it resets the background color.
Bram Moolenaar8dff4cb2020-06-14 14:34:16 +02004701 if (term_props[TPR_UNDERLINE_RGB].tpr_status != TPR_YES && *T_8U != NUL)
Bram Moolenaar8e20f752020-06-14 16:43:47 +02004702 set_string_option_direct((char_u *)"t_8u", -1, (char_u *)"",
4703 OPT_FREE, 0);
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004704
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004705 // Only set 'ttymouse' automatically if it was not set
4706 // by the user already.
4707 if (!option_was_set((char_u *)"ttym")
4708 && (term_props[TPR_MOUSE].tpr_status == TPR_MOUSE_XTERM2
4709 || term_props[TPR_MOUSE].tpr_status == TPR_MOUSE_SGR))
4710 {
4711 set_option_value((char_u *)"ttym", 0L,
4712 term_props[TPR_MOUSE].tpr_status == TPR_MOUSE_SGR
4713 ? (char_u *)"sgr" : (char_u *)"xterm2", 0);
4714 }
4715
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004716 // Only request the cursor style if t_SH and t_RS are
4717 // set. Only supported properly by xterm since version
4718 // 279 (otherwise it returns 0x18).
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004719 // Only when getting the cursor style was detected to work.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004720 // Not for Terminal.app, it can't handle t_RS, it
4721 // echoes the characters to the screen.
4722 if (rcs_status.tr_progress == STATUS_GET
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004723 && term_props[TPR_CURSOR_STYLE].tpr_status == TPR_YES
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004724 && *T_CSH != NUL
4725 && *T_CRS != NUL)
4726 {
Bram Moolenaar86394aa2020-09-05 14:27:24 +02004727#ifdef FEAT_JOB_CHANNEL
4728 ch_log_output = TRUE;
4729#endif
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004730 LOG_TR(("Sending cursor style request"));
4731 out_str(T_CRS);
4732 termrequest_sent(&rcs_status);
4733 need_flush = TRUE;
4734 }
4735
4736 // Only request the cursor blink mode if t_RC set. Not
4737 // for Gnome terminal, it can't handle t_RC, it
4738 // echoes the characters to the screen.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004739 // Only when getting the cursor style was detected to work.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004740 if (rbm_status.tr_progress == STATUS_GET
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004741 && term_props[TPR_CURSOR_BLINK].tpr_status == TPR_YES
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004742 && *T_CRC != NUL)
4743 {
Bram Moolenaar86394aa2020-09-05 14:27:24 +02004744#ifdef FEAT_JOB_CHANNEL
4745 ch_log_output = TRUE;
4746#endif
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004747 LOG_TR(("Sending cursor blink mode request"));
4748 out_str(T_CRC);
4749 termrequest_sent(&rbm_status);
4750 need_flush = TRUE;
4751 }
4752
4753 if (need_flush)
4754 out_flush();
4755 }
4756}
4757
4758/*
4759 * Handle a sequence with key and modifier, one of:
4760 * {lead}27;{modifier};{key}~
4761 * {lead}{key};{modifier}u
4762 * Returns the difference in length.
4763 */
4764 static int
4765handle_key_with_modifier(
4766 int *arg,
4767 int trail,
4768 int csi_len,
4769 int offset,
4770 char_u *buf,
4771 int bufsize,
4772 int *buflen)
4773{
4774 int key;
4775 int modifiers;
4776 int new_slen;
4777 char_u string[MAX_KEY_CODE_LEN + 1];
4778
4779 seenModifyOtherKeys = TRUE;
4780 if (trail == 'u')
4781 key = arg[0];
4782 else
4783 key = arg[2];
4784
4785 modifiers = decode_modifiers(arg[1]);
4786
Bram Moolenaaref6746f2020-06-20 14:43:23 +02004787 // May remove the shift modifier if it's already included in the key.
4788 modifiers = may_remove_shift_modifier(modifiers, key);
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004789
4790 // When used with Ctrl we always make a letter upper case,
4791 // so that mapping <C-H> and <C-h> are the same. Typing
4792 // <C-S-H> also uses "H" but modifier is different.
4793 if ((modifiers & MOD_MASK_CTRL) && ASCII_ISALPHA(key))
4794 key = TOUPPER_ASC(key);
4795
4796 // insert modifiers with KS_MODIFIER
4797 new_slen = modifiers2keycode(modifiers, &key, string);
4798
4799 if (has_mbyte)
4800 new_slen += (*mb_char2bytes)(key, string + new_slen);
4801 else
4802 string[new_slen++] = key;
4803
4804 if (put_string_in_typebuf(offset, csi_len, string, new_slen,
4805 buf, bufsize, buflen) == FAIL)
4806 return -1;
4807 return new_slen - csi_len + offset;
4808}
4809
4810/*
4811 * Handle a CSI escape sequence.
Bram Moolenaar517f00f2020-06-10 12:15:51 +02004812 * - Xterm version string.
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02004813 *
4814 * - Cursor position report: {lead}{row};{col}R
4815 * The final byte must be 'R'. It is used for checking the
4816 * ambiguous-width character state.
4817 *
4818 * - window position reply: {lead}3;{x};{y}t
4819 *
4820 * - key with modifiers when modifyOtherKeys is enabled:
4821 * {lead}27;{modifier};{key}~
4822 * {lead}{key};{modifier}u
4823 * Return 0 for no match, -1 for partial match, > 0 for full match.
4824 */
4825 static int
4826handle_csi(
4827 char_u *tp,
4828 int len,
4829 char_u *argp,
4830 int offset,
4831 char_u *buf,
4832 int bufsize,
4833 int *buflen,
4834 char_u *key_name,
4835 int *slen)
4836{
4837 int first = -1; // optional char right after {lead}
4838 int trail; // char that ends CSI sequence
4839 int arg[3] = {-1, -1, -1}; // argument numbers
4840 int argc; // number of arguments
4841 char_u *ap = argp;
4842 int csi_len;
4843
4844 // Check for non-digit after CSI.
4845 if (!VIM_ISDIGIT(*ap))
4846 first = *ap++;
4847
4848 // Find up to three argument numbers.
4849 for (argc = 0; argc < 3; )
4850 {
4851 if (ap >= tp + len)
4852 return -1;
4853 if (*ap == ';')
4854 arg[argc++] = -1; // omitted number
4855 else if (VIM_ISDIGIT(*ap))
4856 {
4857 arg[argc] = 0;
4858 for (;;)
4859 {
4860 if (ap >= tp + len)
4861 return -1;
4862 if (!VIM_ISDIGIT(*ap))
4863 break;
4864 arg[argc] = arg[argc] * 10 + (*ap - '0');
4865 ++ap;
4866 }
4867 ++argc;
4868 }
4869 if (*ap == ';')
4870 ++ap;
4871 else
4872 break;
4873 }
4874
4875 // mrxvt has been reported to have "+" in the version. Assume
4876 // the escape sequence ends with a letter or one of "{|}~".
4877 while (ap < tp + len
4878 && !(*ap >= '{' && *ap <= '~')
4879 && !ASCII_ISALPHA(*ap))
4880 ++ap;
4881 if (ap >= tp + len)
4882 return -1;
4883 trail = *ap;
4884 csi_len = (int)(ap - tp) + 1;
4885
4886 // Cursor position report: Eat it when there are 2 arguments
4887 // and it ends in 'R'. Also when u7_status is not "sent", it
4888 // may be from a previous Vim that just exited. But not for
4889 // <S-F3>, it sends something similar, check for row and column
4890 // to make sense.
4891 if (first == -1 && argc == 2 && trail == 'R')
4892 {
4893 handle_u7_response(arg, tp, csi_len);
4894
4895 key_name[0] = (int)KS_EXTRA;
4896 key_name[1] = (int)KE_IGNORE;
4897 *slen = csi_len;
4898 }
4899
4900 // Version string: Eat it when there is at least one digit and
4901 // it ends in 'c'
4902 else if (*T_CRV != NUL && ap > argp + 1 && trail == 'c')
4903 {
4904 handle_version_response(first, arg, argc, tp);
4905
4906 *slen = csi_len;
4907# ifdef FEAT_EVAL
4908 set_vim_var_string(VV_TERMRESPONSE, tp, *slen);
4909# endif
4910 apply_autocmds(EVENT_TERMRESPONSE,
4911 NULL, NULL, FALSE, curbuf);
4912 key_name[0] = (int)KS_EXTRA;
4913 key_name[1] = (int)KE_IGNORE;
4914 }
4915
4916 // Check blinking cursor from xterm:
4917 // {lead}?12;1$y set
4918 // {lead}?12;2$y not set
4919 //
4920 // {lead} can be <Esc>[ or CSI
4921 else if (rbm_status.tr_progress == STATUS_SENT
4922 && first == '?'
4923 && ap == argp + 6
4924 && arg[0] == 12
4925 && ap[-1] == '$'
4926 && trail == 'y')
4927 {
4928 initial_cursor_blink = (arg[1] == '1');
4929 rbm_status.tr_progress = STATUS_GOT;
4930 LOG_TR(("Received cursor blinking mode response: %s", tp));
4931 key_name[0] = (int)KS_EXTRA;
4932 key_name[1] = (int)KE_IGNORE;
4933 *slen = csi_len;
4934# ifdef FEAT_EVAL
4935 set_vim_var_string(VV_TERMBLINKRESP, tp, *slen);
4936# endif
4937 }
4938
4939 // Check for a window position response from the terminal:
4940 // {lead}3;{x};{y}t
4941 else if (did_request_winpos && argc == 3 && arg[0] == 3
4942 && trail == 't')
4943 {
4944 winpos_x = arg[1];
4945 winpos_y = arg[2];
4946 // got finished code: consume it
4947 key_name[0] = (int)KS_EXTRA;
4948 key_name[1] = (int)KE_IGNORE;
4949 *slen = csi_len;
4950
4951 if (--did_request_winpos <= 0)
4952 winpos_status.tr_progress = STATUS_GOT;
4953 }
4954
4955 // Key with modifier:
4956 // {lead}27;{modifier};{key}~
4957 // {lead}{key};{modifier}u
4958 else if ((arg[0] == 27 && argc == 3 && trail == '~')
4959 || (argc == 2 && trail == 'u'))
4960 {
4961 return len + handle_key_with_modifier(arg, trail,
4962 csi_len, offset, buf, bufsize, buflen);
4963 }
4964
4965 // else: Unknown CSI sequence. We could drop it, but then the
4966 // user can't create a map for it.
4967 return 0;
4968}
4969
4970/*
4971 * Handle an OSC sequence, fore/background color response from the terminal:
4972 *
4973 * {lead}{code};rgb:{rrrr}/{gggg}/{bbbb}{tail}
4974 * or {lead}{code};rgb:{rr}/{gg}/{bb}{tail}
4975 *
4976 * {code} is 10 for foreground, 11 for background
4977 * {lead} can be <Esc>] or OSC
4978 * {tail} can be '\007', <Esc>\ or STERM.
4979 *
4980 * Consume any code that starts with "{lead}11;", it's also
4981 * possible that "rgba" is following.
4982 */
4983 static int
4984handle_osc(char_u *tp, char_u *argp, int len, char_u *key_name, int *slen)
4985{
4986 int i, j;
4987
4988 j = 1 + (tp[0] == ESC);
4989 if (len >= j + 3 && (argp[0] != '1'
4990 || (argp[1] != '1' && argp[1] != '0')
4991 || argp[2] != ';'))
4992 i = 0; // no match
4993 else
4994 for (i = j; i < len; ++i)
4995 if (tp[i] == '\007' || (tp[0] == OSC ? tp[i] == STERM
4996 : (tp[i] == ESC && i + 1 < len && tp[i + 1] == '\\')))
4997 {
4998 int is_bg = argp[1] == '1';
4999 int is_4digit = i - j >= 21 && tp[j + 11] == '/'
5000 && tp[j + 16] == '/';
5001
5002 if (i - j >= 15 && STRNCMP(tp + j + 3, "rgb:", 4) == 0
5003 && (is_4digit
5004 || (tp[j + 9] == '/' && tp[i + 12 == '/'])))
5005 {
5006 char_u *tp_r = tp + j + 7;
5007 char_u *tp_g = tp + j + (is_4digit ? 12 : 10);
5008 char_u *tp_b = tp + j + (is_4digit ? 17 : 13);
5009# ifdef FEAT_TERMINAL
5010 int rval, gval, bval;
5011
5012 rval = hexhex2nr(tp_r);
5013 gval = hexhex2nr(tp_b);
5014 bval = hexhex2nr(tp_g);
5015# endif
5016 if (is_bg)
5017 {
5018 char *new_bg_val = (3 * '6' < *tp_r + *tp_g +
5019 *tp_b) ? "light" : "dark";
5020
5021 LOG_TR(("Received RBG response: %s", tp));
5022 rbg_status.tr_progress = STATUS_GOT;
5023# ifdef FEAT_TERMINAL
5024 bg_r = rval;
5025 bg_g = gval;
5026 bg_b = bval;
5027# endif
5028 if (!option_was_set((char_u *)"bg")
5029 && STRCMP(p_bg, new_bg_val) != 0)
5030 {
5031 // value differs, apply it
5032 set_option_value((char_u *)"bg", 0L,
5033 (char_u *)new_bg_val, 0);
5034 reset_option_was_set((char_u *)"bg");
5035 redraw_asap(CLEAR);
5036 }
5037 }
5038# ifdef FEAT_TERMINAL
5039 else
5040 {
5041 LOG_TR(("Received RFG response: %s", tp));
5042 rfg_status.tr_progress = STATUS_GOT;
5043 fg_r = rval;
5044 fg_g = gval;
5045 fg_b = bval;
5046 }
5047# endif
5048 }
5049
5050 // got finished code: consume it
5051 key_name[0] = (int)KS_EXTRA;
5052 key_name[1] = (int)KE_IGNORE;
5053 *slen = i + 1 + (tp[i] == ESC);
5054# ifdef FEAT_EVAL
5055 set_vim_var_string(is_bg ? VV_TERMRBGRESP
5056 : VV_TERMRFGRESP, tp, *slen);
5057# endif
5058 break;
5059 }
5060 if (i == len)
5061 {
5062 LOG_TR(("not enough characters for RB"));
5063 return FAIL;
5064 }
5065 return OK;
5066}
5067
5068/*
5069 * Check for key code response from xterm:
5070 * {lead}{flag}+r<hex bytes><{tail}
5071 *
5072 * {lead} can be <Esc>P or DCS
5073 * {flag} can be '0' or '1'
5074 * {tail} can be Esc>\ or STERM
5075 *
5076 * Check for cursor shape response from xterm:
5077 * {lead}1$r<digit> q{tail}
5078 *
5079 * {lead} can be <Esc>P or DCS
5080 * {tail} can be <Esc>\ or STERM
5081 *
5082 * Consume any code that starts with "{lead}.+r" or "{lead}.$r".
5083 */
5084 static int
5085handle_dcs(char_u *tp, char_u *argp, int len, char_u *key_name, int *slen)
5086{
5087 int i, j;
5088
5089 j = 1 + (tp[0] == ESC);
5090 if (len < j + 3)
5091 i = len; // need more chars
5092 else if ((argp[1] != '+' && argp[1] != '$') || argp[2] != 'r')
5093 i = 0; // no match
5094 else if (argp[1] == '+')
5095 // key code response
5096 for (i = j; i < len; ++i)
5097 {
5098 if ((tp[i] == ESC && i + 1 < len && tp[i + 1] == '\\')
5099 || tp[i] == STERM)
5100 {
5101 if (i - j >= 3)
5102 got_code_from_term(tp + j, i);
5103 key_name[0] = (int)KS_EXTRA;
5104 key_name[1] = (int)KE_IGNORE;
5105 *slen = i + 1 + (tp[i] == ESC);
5106 break;
5107 }
5108 }
5109 else
5110 {
5111 // Probably the cursor shape response. Make sure that "i"
5112 // is equal to "len" when there are not sufficient
5113 // characters.
5114 for (i = j + 3; i < len; ++i)
5115 {
5116 if (i - j == 3 && !isdigit(tp[i]))
5117 break;
5118 if (i - j == 4 && tp[i] != ' ')
5119 break;
5120 if (i - j == 5 && tp[i] != 'q')
5121 break;
5122 if (i - j == 6 && tp[i] != ESC && tp[i] != STERM)
5123 break;
5124 if ((i - j == 6 && tp[i] == STERM)
5125 || (i - j == 7 && tp[i] == '\\'))
5126 {
5127 int number = argp[3] - '0';
5128
5129 // 0, 1 = block blink, 2 = block
5130 // 3 = underline blink, 4 = underline
5131 // 5 = vertical bar blink, 6 = vertical bar
5132 number = number == 0 ? 1 : number;
5133 initial_cursor_shape = (number + 1) / 2;
5134 // The blink flag is actually inverted, compared to
5135 // the value set with T_SH.
5136 initial_cursor_shape_blink =
5137 (number & 1) ? FALSE : TRUE;
5138 rcs_status.tr_progress = STATUS_GOT;
5139 LOG_TR(("Received cursor shape response: %s", tp));
5140
5141 key_name[0] = (int)KS_EXTRA;
5142 key_name[1] = (int)KE_IGNORE;
5143 *slen = i + 1;
5144# ifdef FEAT_EVAL
5145 set_vim_var_string(VV_TERMSTYLERESP, tp, *slen);
5146# endif
5147 break;
5148 }
5149 }
5150 }
5151
5152 if (i == len)
5153 {
5154 // These codes arrive many together, each code can be
5155 // truncated at any point.
5156 LOG_TR(("not enough characters for XT"));
5157 return FAIL;
5158 }
5159 return OK;
5160}
Bram Moolenaar0ca8b5b2020-06-09 21:35:36 +02005161#endif // FEAT_TERMRESPONSE
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005162
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02005163/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 * Check if typebuf.tb_buf[] contains a terminal key code.
5165 * Check from typebuf.tb_buf[typebuf.tb_off] to typebuf.tb_buf[typebuf.tb_off
Bram Moolenaar975a8802020-06-06 22:36:24 +02005166 * + "max_offset"].
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 * Return 0 for no match, -1 for partial match, > 0 for full match.
Bram Moolenaar946ffd42010-12-30 12:30:31 +01005168 * Return KEYLEN_REMOVED when a key code was deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 * With a match, the match is removed, the replacement code is inserted in
5170 * typebuf.tb_buf[] and the number of characters in typebuf.tb_buf[] is
5171 * returned.
Bram Moolenaara8c8a682012-02-05 22:05:48 +01005172 * When "buf" is not NULL, buf[bufsize] is used instead of typebuf.tb_buf[].
5173 * "buflen" is then the length of the string in buf[] and is updated for
5174 * inserts and deletes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 */
5176 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01005177check_termcode(
5178 int max_offset,
5179 char_u *buf,
5180 int bufsize,
5181 int *buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182{
5183 char_u *tp;
5184 char_u *p;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005185 int slen = 0; // init for GCC
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005186 int modslen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187 int len;
Bram Moolenaar946ffd42010-12-30 12:30:31 +01005188 int retval = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 int offset;
5190 char_u key_name[2];
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005191 int modifiers;
Bram Moolenaar090209b2017-06-23 22:45:33 +02005192 char_u *modifiers_start = NULL;
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005193 int key;
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02005194 int new_slen; // Length of what will replace the termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 char_u string[MAX_KEY_CODE_LEN + 1];
5196 int i, j;
5197 int idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 int cpo_koffset;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199
5200 cpo_koffset = (vim_strchr(p_cpo, CPO_KOFFSET) != NULL);
5201
5202 /*
5203 * Speed up the checks for terminal codes by gathering all first bytes
5204 * used in termleader[]. Often this is just a single <Esc>.
5205 */
5206 if (need_gather)
5207 gather_termleader();
5208
5209 /*
5210 * Check at several positions in typebuf.tb_buf[], to catch something like
5211 * "x<Up>" that can be mapped. Stop at max_offset, because characters
5212 * after that cannot be used for mapping, and with @r commands
Bram Moolenaare533bbe2013-03-16 14:33:36 +01005213 * typebuf.tb_buf[] can become very long.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 * This is used often, KEEP IT FAST!
5215 */
5216 for (offset = 0; offset < max_offset; ++offset)
5217 {
5218 if (buf == NULL)
5219 {
5220 if (offset >= typebuf.tb_len)
5221 break;
5222 tp = typebuf.tb_buf + typebuf.tb_off + offset;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005223 len = typebuf.tb_len - offset; // length of the input
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 }
5225 else
5226 {
Bram Moolenaara8c8a682012-02-05 22:05:48 +01005227 if (offset >= *buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 break;
5229 tp = buf + offset;
Bram Moolenaara8c8a682012-02-05 22:05:48 +01005230 len = *buflen - offset;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 }
5232
5233 /*
5234 * Don't check characters after K_SPECIAL, those are already
5235 * translated terminal chars (avoid translating ~@^Hx).
5236 */
5237 if (*tp == K_SPECIAL)
5238 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005239 offset += 2; // there are always 2 extra characters
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 continue;
5241 }
5242
5243 /*
5244 * Skip this position if the character does not appear as the first
5245 * character in term_strings. This speeds up a lot, since most
5246 * termcodes start with the same character (ESC or CSI).
5247 */
5248 i = *tp;
5249 for (p = termleader; *p && *p != i; ++p)
5250 ;
5251 if (*p == NUL)
5252 continue;
5253
5254 /*
5255 * Skip this position if p_ek is not set and tp[0] is an ESC and we
5256 * are in Insert mode.
5257 */
5258 if (*tp == ESC && !p_ek && (State & INSERT))
5259 continue;
5260
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005261 key_name[0] = NUL; // no key name found yet
5262 key_name[1] = NUL; // no key name found yet
5263 modifiers = 0; // no modifiers yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264
5265#ifdef FEAT_GUI
5266 if (gui.in_use)
5267 {
5268 /*
5269 * GUI special key codes are all of the form [CSI xx].
5270 */
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005271 if (*tp == CSI) // Special key from GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 {
5273 if (len < 3)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005274 return -1; // Shouldn't happen
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 slen = 3;
5276 key_name[0] = tp[1];
5277 key_name[1] = tp[2];
5278 }
5279 }
5280 else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005281#endif // FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 {
5283 for (idx = 0; idx < tc_len; ++idx)
5284 {
5285 /*
5286 * Ignore the entry if we are not at the start of
5287 * typebuf.tb_buf[]
5288 * and there are not enough characters to make a match.
5289 * But only when the 'K' flag is in 'cpoptions'.
5290 */
5291 slen = termcodes[idx].len;
Bram Moolenaara529ce02017-06-22 22:37:57 +02005292 modifiers_start = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 if (cpo_koffset && offset && len < slen)
5294 continue;
5295 if (STRNCMP(termcodes[idx].code, tp,
5296 (size_t)(slen > len ? len : slen)) == 0)
5297 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005298 if (len < slen) // got a partial sequence
5299 return -1; // need to get more chars
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300
5301 /*
5302 * When found a keypad key, check if there is another key
5303 * that matches and use that one. This makes <Home> to be
5304 * found instead of <kHome> when they produce the same
5305 * key code.
5306 */
5307 if (termcodes[idx].name[0] == 'K'
5308 && VIM_ISDIGIT(termcodes[idx].name[1]))
5309 {
5310 for (j = idx + 1; j < tc_len; ++j)
5311 if (termcodes[j].len == slen &&
5312 STRNCMP(termcodes[idx].code,
5313 termcodes[j].code, slen) == 0)
5314 {
5315 idx = j;
5316 break;
5317 }
5318 }
5319
5320 key_name[0] = termcodes[idx].name[0];
5321 key_name[1] = termcodes[idx].name[1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322 break;
5323 }
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005324
5325 /*
5326 * Check for code with modifier, like xterm uses:
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005327 * <Esc>[123;*X (modslen == slen - 3)
5328 * Also <Esc>O*X and <M-O>*X (modslen == slen - 2).
5329 * When there is a modifier the * matches a number.
5330 * When there is no modifier the ;* or * is omitted.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005331 */
5332 if (termcodes[idx].modlen > 0)
5333 {
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005334 modslen = termcodes[idx].modlen;
5335 if (cpo_koffset && offset && len < modslen)
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005336 continue;
5337 if (STRNCMP(termcodes[idx].code, tp,
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005338 (size_t)(modslen > len ? len : modslen)) == 0)
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005339 {
5340 int n;
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005341
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005342 if (len <= modslen) // got a partial sequence
5343 return -1; // need to get more chars
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005344
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005345 if (tp[modslen] == termcodes[idx].code[slen - 1])
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005346 slen = modslen + 1; // no modifiers
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005347 else if (tp[modslen] != ';' && modslen == slen - 3)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005348 continue; // no match
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005349 else
5350 {
Bram Moolenaarbb7e1b42019-05-02 20:24:12 +02005351 // Skip over the digits, the final char must
5352 // follow. URXVT can use a negative value, thus
5353 // also accept '-'.
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02005354 for (j = slen - 2; j < len && (isdigit(tp[j])
Bram Moolenaarbb7e1b42019-05-02 20:24:12 +02005355 || tp[j] == '-' || tp[j] == ';'); ++j)
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005356 ;
5357 ++j;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005358 if (len < j) // got a partial sequence
5359 return -1; // need to get more chars
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005360 if (tp[j - 1] != termcodes[idx].code[slen - 1])
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005361 continue; // no match
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005362
Bram Moolenaara529ce02017-06-22 22:37:57 +02005363 modifiers_start = tp + slen - 2;
5364
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02005365 // Match! Convert modifier bits.
5366 n = atoi((char *)modifiers_start);
5367 modifiers |= decode_modifiers(n);
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005368
5369 slen = j;
5370 }
5371 key_name[0] = termcodes[idx].name[0];
5372 key_name[1] = termcodes[idx].name[1];
Bram Moolenaar19a09a12005-03-04 23:39:37 +00005373 break;
5374 }
5375 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 }
5377 }
5378
5379#ifdef FEAT_TERMRESPONSE
Bram Moolenaar1dff76b2011-10-26 23:48:20 +02005380 if (key_name[0] == NUL
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005381 // Mouse codes of DEC and pterm start with <ESC>[. When
5382 // detecting the start of these mouse codes they might as well be
5383 // another key code or terminal response.
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005384# ifdef FEAT_MOUSE_DEC
5385 || key_name[0] == KS_DEC_MOUSE
Bram Moolenaare533bbe2013-03-16 14:33:36 +01005386# endif
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005387# ifdef FEAT_MOUSE_PTERM
5388 || key_name[0] == KS_PTERM_MOUSE
5389# endif
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005390 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391 {
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005392 char_u *argp = tp[0] == ESC ? tp + 2 : tp + 1;
5393
5394 /*
5395 * Check for responses from the terminal starting with {lead}:
5396 * "<Esc>[" or CSI followed by [0-9>?]
Bram Moolenaar9584b312013-03-13 19:29:28 +01005397 *
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005398 * - Xterm version string: {lead}>{x};{vers};{y}c
Bram Moolenaar9584b312013-03-13 19:29:28 +01005399 * Also eat other possible responses to t_RV, rxvt returns
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005400 * "{lead}?1;2c".
Bram Moolenaar9584b312013-03-13 19:29:28 +01005401 *
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005402 * - Cursor position report: {lead}{row};{col}R
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005403 * The final byte must be 'R'. It is used for checking the
Bram Moolenaar9584b312013-03-13 19:29:28 +01005404 * ambiguous-width character state.
Bram Moolenaarba6ec182017-04-04 22:41:10 +02005405 *
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005406 * - window position reply: {lead}3;{x};{y}t
5407 *
5408 * - key with modifiers when modifyOtherKeys is enabled:
5409 * {lead}27;{modifier};{key}~
5410 * {lead}{key};{modifier}u
Bram Moolenaar9584b312013-03-13 19:29:28 +01005411 */
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005412 if (((tp[0] == ESC && len >= 3 && tp[1] == '[')
Bram Moolenaar46a75612013-05-15 14:22:41 +02005413 || (tp[0] == CSI && len >= 2))
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005414 && (VIM_ISDIGIT(*argp) || *argp == '>' || *argp == '?'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 {
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005416 int resp = handle_csi(tp, len, argp, offset, buf,
5417 bufsize, buflen, key_name, &slen);
5418 if (resp != 0)
Bram Moolenaarc3e555b2019-10-08 20:15:39 +02005419 {
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005420# ifdef DEBUG_TERMRESPONSE
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005421 if (resp == -1)
5422 LOG_TR(("Not enough characters for CSI sequence"));
Bram Moolenaar4e067c82014-07-30 17:21:58 +02005423# endif
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005424 return resp;
Bram Moolenaar9584b312013-03-13 19:29:28 +01005425 }
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02005426 }
5427
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005428 // Check for fore/background color response from the terminal,
5429 // starting} with <Esc>] or OSC
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005430 else if ((*T_RBG != NUL || *T_RFG != NUL)
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02005431 && ((tp[0] == ESC && len >= 2 && tp[1] == ']')
5432 || tp[0] == OSC))
5433 {
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005434 if (handle_osc(tp, argp, len, key_name, &slen) == FAIL)
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02005435 return -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 }
5437
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005438 // Check for key code response from xterm,
5439 // starting with <Esc>P or DCS
Bram Moolenaarafd78262019-05-10 23:10:31 +02005440 else if ((check_for_codes || rcs_status.tr_progress == STATUS_SENT)
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02005441 && ((tp[0] == ESC && len >= 2 && tp[1] == 'P')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 || tp[0] == DCS))
5443 {
Bram Moolenaar218cb0f2020-06-09 21:26:36 +02005444 if (handle_dcs(tp, argp, len, key_name, &slen) == FAIL)
Bram Moolenaar46fd4df2015-07-10 14:05:10 +02005445 return -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 }
5447 }
5448#endif
5449
5450 if (key_name[0] == NUL)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005451 continue; // No match at this position, try next one
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005453 // We only get here when we have a complete termcode match
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005455#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 /*
5457 * Only in the GUI: Fetch the pointer coordinates of the scroll event
5458 * so that we know which window to scroll later.
5459 */
5460 if (gui.in_use
5461 && key_name[0] == (int)KS_EXTRA
5462 && (key_name[1] == (int)KE_X1MOUSE
5463 || key_name[1] == (int)KE_X2MOUSE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02005464 || key_name[1] == (int)KE_MOUSELEFT
5465 || key_name[1] == (int)KE_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466 || key_name[1] == (int)KE_MOUSEDOWN
5467 || key_name[1] == (int)KE_MOUSEUP))
5468 {
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005469 char_u bytes[6];
5470 int num_bytes = get_bytes_from_buf(tp + slen, bytes, 4);
5471
5472 if (num_bytes == -1) // not enough coordinates
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 return -1;
5474 mouse_col = 128 * (bytes[0] - ' ' - 1) + bytes[1] - ' ' - 1;
5475 mouse_row = 128 * (bytes[2] - ' ' - 1) + bytes[3] - ' ' - 1;
5476 slen += num_bytes;
5477 }
5478 else
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005479#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 /*
5481 * If it is a mouse click, get the coordinates.
5482 */
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005483 if (key_name[0] == KS_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005484#ifdef FEAT_MOUSE_GPM
Bram Moolenaarbedf0912019-05-04 16:58:45 +02005485 || key_name[0] == KS_GPM_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005486#endif
5487#ifdef FEAT_MOUSE_JSB
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005488 || key_name[0] == KS_JSBTERM_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005489#endif
5490#ifdef FEAT_MOUSE_NET
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005491 || key_name[0] == KS_NETTERM_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005492#endif
5493#ifdef FEAT_MOUSE_DEC
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005494 || key_name[0] == KS_DEC_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005495#endif
5496#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005497 || key_name[0] == KS_PTERM_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005498#endif
5499#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005500 || key_name[0] == KS_URXVT_MOUSE
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02005501#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02005502 || key_name[0] == KS_SGR_MOUSE
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01005503 || key_name[0] == KS_SGR_MOUSE_RELEASE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 {
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005505 if (check_termcode_mouse(tp, &slen, key_name, modifiers_start, idx,
5506 &modifiers) == -1)
5507 return -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509
5510#ifdef FEAT_GUI
5511 /*
5512 * If using the GUI, then we get menu and scrollbar events.
5513 *
5514 * A menu event is encoded as K_SPECIAL, KS_MENU, KE_FILLER followed by
5515 * four bytes which are to be taken as a pointer to the vimmenu_T
5516 * structure.
5517 *
Bram Moolenaarcf0dfa22007-05-10 18:52:16 +00005518 * A tab line event is encoded as K_SPECIAL KS_TABLINE nr, where "nr"
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005519 * is one byte with the tab index.
5520 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 * A scrollbar event is K_SPECIAL, KS_VER_SCROLLBAR, KE_FILLER followed
5522 * by one byte representing the scrollbar number, and then four bytes
5523 * representing a long_u which is the new value of the scrollbar.
5524 *
5525 * A horizontal scrollbar event is K_SPECIAL, KS_HOR_SCROLLBAR,
5526 * KE_FILLER followed by four bytes representing a long_u which is the
5527 * new value of the scrollbar.
5528 */
5529# ifdef FEAT_MENU
5530 else if (key_name[0] == (int)KS_MENU)
5531 {
5532 long_u val;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005533 int num_bytes = get_long_from_buf(tp + slen, &val);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 if (num_bytes == -1)
5536 return -1;
5537 current_menu = (vimmenu_T *)val;
5538 slen += num_bytes;
Bram Moolenaar968bbbe2006-08-16 19:41:08 +00005539
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005540 // The menu may have been deleted right after it was used, check
5541 // for that.
Bram Moolenaar968bbbe2006-08-16 19:41:08 +00005542 if (check_menu_pointer(root_menu, current_menu) == FAIL)
5543 {
5544 key_name[0] = KS_EXTRA;
5545 key_name[1] = (int)KE_IGNORE;
5546 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 }
5548# endif
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005549# ifdef FEAT_GUI_TABLINE
5550 else if (key_name[0] == (int)KS_TABLINE)
5551 {
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005552 // Selecting tabline tab or using its menu.
5553 char_u bytes[6];
5554 int num_bytes = get_bytes_from_buf(tp + slen, bytes, 1);
5555
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005556 if (num_bytes == -1)
5557 return -1;
5558 current_tab = (int)bytes[0];
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005559 if (current_tab == 255) // -1 in a byte gives 255
Bram Moolenaar07354542007-09-15 12:07:46 +00005560 current_tab = -1;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005561 slen += num_bytes;
5562 }
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00005563 else if (key_name[0] == (int)KS_TABMENU)
5564 {
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005565 // Selecting tabline tab or using its menu.
5566 char_u bytes[6];
5567 int num_bytes = get_bytes_from_buf(tp + slen, bytes, 2);
5568
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00005569 if (num_bytes == -1)
5570 return -1;
5571 current_tab = (int)bytes[0];
5572 current_tabmenu = (int)bytes[1];
5573 slen += num_bytes;
5574 }
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005575# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576# ifndef USE_ON_FLY_SCROLL
5577 else if (key_name[0] == (int)KS_VER_SCROLLBAR)
5578 {
5579 long_u val;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005580 char_u bytes[6];
5581 int num_bytes;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005583 // Get the last scrollbar event in the queue of the same type
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584 j = 0;
5585 for (i = 0; tp[j] == CSI && tp[j + 1] == KS_VER_SCROLLBAR
5586 && tp[j + 2] != NUL; ++i)
5587 {
5588 j += 3;
5589 num_bytes = get_bytes_from_buf(tp + j, bytes, 1);
5590 if (num_bytes == -1)
5591 break;
5592 if (i == 0)
5593 current_scrollbar = (int)bytes[0];
5594 else if (current_scrollbar != (int)bytes[0])
5595 break;
5596 j += num_bytes;
5597 num_bytes = get_long_from_buf(tp + j, &val);
5598 if (num_bytes == -1)
5599 break;
5600 scrollbar_value = val;
5601 j += num_bytes;
5602 slen = j;
5603 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005604 if (i == 0) // not enough characters to make one
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 return -1;
5606 }
5607 else if (key_name[0] == (int)KS_HOR_SCROLLBAR)
5608 {
5609 long_u val;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02005610 int num_bytes;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005612 // Get the last horiz. scrollbar event in the queue
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 j = 0;
5614 for (i = 0; tp[j] == CSI && tp[j + 1] == KS_HOR_SCROLLBAR
5615 && tp[j + 2] != NUL; ++i)
5616 {
5617 j += 3;
5618 num_bytes = get_long_from_buf(tp + j, &val);
5619 if (num_bytes == -1)
5620 break;
5621 scrollbar_value = val;
5622 j += num_bytes;
5623 slen = j;
5624 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005625 if (i == 0) // not enough characters to make one
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 return -1;
5627 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005628# endif // !USE_ON_FLY_SCROLL
5629#endif // FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005631 /*
5632 * Change <xHome> to <Home>, <xUp> to <Up>, etc.
5633 */
5634 key = handle_x_keys(TERMCAP2KEY(key_name[0], key_name[1]));
5635
5636 /*
5637 * Add any modifier codes to our string.
5638 */
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02005639 new_slen = modifiers2keycode(modifiers, &key, string);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005640
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005641 // Finally, add the special key code to our string
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005642 key_name[0] = KEY2TERMCAP0(key);
5643 key_name[1] = KEY2TERMCAP1(key);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 if (key_name[0] == KS_KEY)
Bram Moolenaar6768a332009-01-22 17:33:49 +00005645 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005646 // from ":set <M-b>=xx"
Bram Moolenaar6768a332009-01-22 17:33:49 +00005647 if (has_mbyte)
5648 new_slen += (*mb_char2bytes)(key_name[1], string + new_slen);
5649 else
Bram Moolenaar6768a332009-01-22 17:33:49 +00005650 string[new_slen++] = key_name[1];
5651 }
Bram Moolenaar946ffd42010-12-30 12:30:31 +01005652 else if (new_slen == 0 && key_name[0] == KS_EXTRA
5653 && key_name[1] == KE_IGNORE)
5654 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005655 // Do not put K_IGNORE into the buffer, do return KEYLEN_REMOVED
5656 // to indicate what happened.
Bram Moolenaar946ffd42010-12-30 12:30:31 +01005657 retval = KEYLEN_REMOVED;
5658 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 else
5660 {
5661 string[new_slen++] = K_SPECIAL;
5662 string[new_slen++] = key_name[0];
5663 string[new_slen++] = key_name[1];
5664 }
Bram Moolenaar6a0299d2019-10-10 21:14:03 +02005665 if (put_string_in_typebuf(offset, slen, string, new_slen,
5666 buf, bufsize, buflen) == FAIL)
5667 return -1;
5668 return retval == 0 ? (len + new_slen - slen + offset) : retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 }
5670
Bram Moolenaar2951b772013-07-03 12:45:31 +02005671#ifdef FEAT_TERMRESPONSE
Bram Moolenaarb255b902018-04-24 21:40:10 +02005672 LOG_TR(("normal character"));
Bram Moolenaar2951b772013-07-03 12:45:31 +02005673#endif
5674
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005675 return 0; // no match found
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676}
5677
Bram Moolenaar9377df32017-10-15 13:22:01 +02005678#if (defined(FEAT_TERMINAL) && defined(FEAT_TERMRESPONSE)) || defined(PROTO)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005679/*
5680 * Get the text foreground color, if known.
5681 */
5682 void
Bram Moolenaar00ce63d2017-10-15 21:44:45 +02005683term_get_fg_color(char_u *r, char_u *g, char_u *b)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005684{
Bram Moolenaarafd78262019-05-10 23:10:31 +02005685 if (rfg_status.tr_progress == STATUS_GOT)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005686 {
5687 *r = fg_r;
5688 *g = fg_g;
5689 *b = fg_b;
5690 }
5691}
5692
5693/*
5694 * Get the text background color, if known.
5695 */
5696 void
Bram Moolenaar00ce63d2017-10-15 21:44:45 +02005697term_get_bg_color(char_u *r, char_u *g, char_u *b)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005698{
Bram Moolenaarafd78262019-05-10 23:10:31 +02005699 if (rbg_status.tr_progress == STATUS_GOT)
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02005700 {
5701 *r = bg_r;
5702 *g = bg_g;
5703 *b = bg_b;
5704 }
5705}
5706#endif
5707
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708/*
5709 * Replace any terminal code strings in from[] with the equivalent internal
5710 * vim representation. This is used for the "from" and "to" part of a
5711 * mapping, and the "to" part of a menu command.
5712 * Any strings like "<C-UP>" are also replaced, unless 'cpoptions' contains
5713 * '<'.
5714 * K_SPECIAL by itself is replaced by K_SPECIAL KS_SPECIAL KE_FILLER.
5715 *
5716 * The replacement is done in result[] and finally copied into allocated
5717 * memory. If this all works well *bufp is set to the allocated memory and a
5718 * pointer to it is returned. If something fails *bufp is set to NULL and from
5719 * is returned.
5720 *
Bram Moolenaar459fd782019-10-13 16:43:39 +02005721 * CTRL-V characters are removed. When "flags" has REPTERM_FROM_PART, a
5722 * trailing CTRL-V is included, otherwise it is removed (for ":map xx ^V", maps
5723 * xx to nothing). When 'cpoptions' does not contain 'B', a backslash can be
5724 * used instead of a CTRL-V.
5725 *
5726 * Flags:
5727 * REPTERM_FROM_PART see above
5728 * REPTERM_DO_LT also translate <lt>
5729 * REPTERM_SPECIAL always accept <key> notation
5730 * REPTERM_NO_SIMPLIFY do not simplify <C-H> to 0x08 and set 8th bit for <A-x>
5731 *
5732 * "did_simplify" is set when some <C-H> or <A-x> code was simplified, unless
5733 * it is NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 */
Bram Moolenaar9c102382006-05-03 21:26:49 +00005735 char_u *
Bram Moolenaar764b23c2016-01-30 21:10:09 +01005736replace_termcodes(
5737 char_u *from,
5738 char_u **bufp,
Bram Moolenaar459fd782019-10-13 16:43:39 +02005739 int flags,
5740 int *did_simplify)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741{
5742 int i;
5743 int slen;
5744 int key;
5745 int dlen = 0;
5746 char_u *src;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005747 int do_backslash; // backslash is a special character
5748 int do_special; // recognize <> key codes
5749 int do_key_code; // recognize raw key codes
5750 char_u *result; // buffer for resulting string
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751
5752 do_backslash = (vim_strchr(p_cpo, CPO_BSLASH) == NULL);
Bram Moolenaar459fd782019-10-13 16:43:39 +02005753 do_special = (vim_strchr(p_cpo, CPO_SPECI) == NULL)
5754 || (flags & REPTERM_SPECIAL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 do_key_code = (vim_strchr(p_cpo, CPO_KEYCODE) == NULL);
5756
5757 /*
5758 * Allocate space for the translation. Worst case a single character is
5759 * replaced by 6 bytes (shifted special key), plus a NUL at the end.
5760 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02005761 result = alloc(STRLEN(from) * 6 + 1);
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005762 if (result == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 {
5764 *bufp = NULL;
5765 return from;
5766 }
5767
5768 src = from;
5769
5770 /*
5771 * Check for #n at start only: function key n
5772 */
Bram Moolenaar459fd782019-10-13 16:43:39 +02005773 if ((flags & REPTERM_FROM_PART) && src[0] == '#' && VIM_ISDIGIT(src[1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 {
5775 result[dlen++] = K_SPECIAL;
5776 result[dlen++] = 'k';
5777 if (src[1] == '0')
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005778 result[dlen++] = ';'; // #0 is F10 is "k;"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 else
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005780 result[dlen++] = src[1]; // #3 is F3 is "k3"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 src += 2;
5782 }
5783
5784 /*
5785 * Copy each byte from *from to result[dlen]
5786 */
5787 while (*src != NUL)
5788 {
5789 /*
5790 * If 'cpoptions' does not contain '<', check for special key codes,
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02005791 * like "<C-S-LeftMouse>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 */
Bram Moolenaar459fd782019-10-13 16:43:39 +02005793 if (do_special && ((flags & REPTERM_DO_LT)
5794 || STRNCMP(src, "<lt>", 4) != 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 {
5796#ifdef FEAT_EVAL
5797 /*
5798 * Replace <SID> by K_SNR <script-nr> _.
5799 * (room: 5 * 6 = 30 bytes; needed: 3 + <nr> + 1 <= 14)
5800 */
5801 if (STRNICMP(src, "<SID>", 5) == 0)
5802 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02005803 if (current_sctx.sc_sid <= 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005804 emsg(_(e_usingsid));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 else
5806 {
5807 src += 5;
5808 result[dlen++] = K_SPECIAL;
5809 result[dlen++] = (int)KS_EXTRA;
5810 result[dlen++] = (int)KE_SNR;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02005811 sprintf((char *)result + dlen, "%ld",
5812 (long)current_sctx.sc_sid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 dlen += (int)STRLEN(result + dlen);
5814 result[dlen++] = '_';
5815 continue;
5816 }
5817 }
5818#endif
5819
Bram Moolenaarebe9d342020-05-30 21:52:54 +02005820 slen = trans_special(&src, result + dlen, FSK_KEYCODE
5821 | ((flags & REPTERM_NO_SIMPLIFY) ? 0 : FSK_SIMPLIFY),
5822 did_simplify);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 if (slen)
5824 {
5825 dlen += slen;
5826 continue;
5827 }
5828 }
5829
5830 /*
5831 * If 'cpoptions' does not contain 'k', see if it's an actual key-code.
5832 * Note that this is also checked after replacing the <> form.
5833 * Single character codes are NOT replaced (e.g. ^H or DEL), because
5834 * it could be a character in the file.
5835 */
5836 if (do_key_code)
5837 {
5838 i = find_term_bykeys(src);
5839 if (i >= 0)
5840 {
5841 result[dlen++] = K_SPECIAL;
5842 result[dlen++] = termcodes[i].name[0];
5843 result[dlen++] = termcodes[i].name[1];
5844 src += termcodes[i].len;
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005845 // If terminal code matched, continue after it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846 continue;
5847 }
5848 }
5849
5850#ifdef FEAT_EVAL
5851 if (do_special)
5852 {
5853 char_u *p, *s, len;
5854
5855 /*
5856 * Replace <Leader> by the value of "mapleader".
5857 * Replace <LocalLeader> by the value of "maplocalleader".
5858 * If "mapleader" or "maplocalleader" isn't set use a backslash.
5859 */
5860 if (STRNICMP(src, "<Leader>", 8) == 0)
5861 {
5862 len = 8;
5863 p = get_var_value((char_u *)"g:mapleader");
5864 }
5865 else if (STRNICMP(src, "<LocalLeader>", 13) == 0)
5866 {
5867 len = 13;
5868 p = get_var_value((char_u *)"g:maplocalleader");
5869 }
5870 else
5871 {
5872 len = 0;
5873 p = NULL;
5874 }
5875 if (len != 0)
5876 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005877 // Allow up to 8 * 6 characters for "mapleader".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 if (p == NULL || *p == NUL || STRLEN(p) > 8 * 6)
5879 s = (char_u *)"\\";
5880 else
5881 s = p;
5882 while (*s != NUL)
5883 result[dlen++] = *s++;
5884 src += len;
5885 continue;
5886 }
5887 }
5888#endif
5889
5890 /*
5891 * Remove CTRL-V and ignore the next character.
5892 * For "from" side the CTRL-V at the end is included, for the "to"
5893 * part it is removed.
5894 * If 'cpoptions' does not contain 'B', also accept a backslash.
5895 */
5896 key = *src;
5897 if (key == Ctrl_V || (do_backslash && key == '\\'))
5898 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005899 ++src; // skip CTRL-V or backslash
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 if (*src == NUL)
5901 {
Bram Moolenaar459fd782019-10-13 16:43:39 +02005902 if (flags & REPTERM_FROM_PART)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903 result[dlen++] = key;
5904 break;
5905 }
5906 }
5907
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005908 // skip multibyte char correctly
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005909 for (i = (*mb_ptr2len)(src); i > 0; --i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 {
5911 /*
5912 * If the character is K_SPECIAL, replace it with K_SPECIAL
5913 * KS_SPECIAL KE_FILLER.
5914 * If compiled with the GUI replace CSI with K_CSI.
5915 */
5916 if (*src == K_SPECIAL)
5917 {
5918 result[dlen++] = K_SPECIAL;
5919 result[dlen++] = KS_SPECIAL;
5920 result[dlen++] = KE_FILLER;
5921 }
5922# ifdef FEAT_GUI
5923 else if (*src == CSI)
5924 {
5925 result[dlen++] = K_SPECIAL;
5926 result[dlen++] = KS_EXTRA;
5927 result[dlen++] = (int)KE_CSI;
5928 }
5929# endif
5930 else
5931 result[dlen++] = *src;
5932 ++src;
5933 }
5934 }
5935 result[dlen] = NUL;
5936
5937 /*
5938 * Copy the new string to allocated memory.
5939 * If this fails, just return from.
5940 */
5941 if ((*bufp = vim_strsave(result)) != NULL)
5942 from = *bufp;
5943 vim_free(result);
5944 return from;
5945}
5946
5947/*
5948 * Find a termcode with keys 'src' (must be NUL terminated).
5949 * Return the index in termcodes[], or -1 if not found.
5950 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02005951 static int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01005952find_term_bykeys(char_u *src)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005953{
5954 int i;
Bram Moolenaar38f5f952012-01-26 13:01:59 +01005955 int slen = (int)STRLEN(src);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005956
5957 for (i = 0; i < tc_len; ++i)
5958 {
Bram Moolenaar5af7d712012-01-20 17:15:51 +01005959 if (slen == termcodes[i].len
5960 && STRNCMP(termcodes[i].code, src, (size_t)slen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961 return i;
5962 }
5963 return -1;
5964}
5965
5966/*
5967 * Gather the first characters in the terminal key codes into a string.
5968 * Used to speed up check_termcode().
5969 */
5970 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01005971gather_termleader(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972{
5973 int i;
5974 int len = 0;
5975
5976#ifdef FEAT_GUI
5977 if (gui.in_use)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005978 termleader[len++] = CSI; // the GUI codes are not in termcodes[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979#endif
5980#ifdef FEAT_TERMRESPONSE
Bram Moolenaar3eee06e2017-08-19 19:40:50 +02005981 if (check_for_codes || *T_CRS != NUL)
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01005982 termleader[len++] = DCS; // the termcode response starts with DCS
5983 // in 8-bit mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984#endif
5985 termleader[len] = NUL;
5986
5987 for (i = 0; i < tc_len; ++i)
5988 if (vim_strchr(termleader, termcodes[i].code[0]) == NULL)
5989 {
5990 termleader[len++] = termcodes[i].code[0];
5991 termleader[len] = NUL;
5992 }
5993
5994 need_gather = FALSE;
5995}
5996
5997/*
5998 * Show all termcodes (for ":set termcap")
5999 * This code looks a lot like showoptions(), but is different.
6000 */
6001 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006002show_termcodes(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003{
6004 int col;
6005 int *items;
6006 int item_count;
6007 int run;
6008 int row, rows;
6009 int cols;
6010 int i;
6011 int len;
6012
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006013#define INC3 27 // try to make three columns
6014#define INC2 40 // try to make two columns
6015#define GAP 2 // spaces between columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006017 if (tc_len == 0) // no terminal codes (must be GUI)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 return;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006019 items = ALLOC_MULT(int, tc_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 if (items == NULL)
6021 return;
6022
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006023 // Highlight title
Bram Moolenaar32526b32019-01-19 17:43:09 +01006024 msg_puts_title(_("\n--- Terminal keys ---"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025
6026 /*
6027 * do the loop two times:
6028 * 1. display the short items (non-strings and short strings)
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006029 * 2. display the medium items (medium length strings)
6030 * 3. display the long items (remaining strings)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 */
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006032 for (run = 1; run <= 3 && !got_int; ++run)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 {
6034 /*
6035 * collect the items in items[]
6036 */
6037 item_count = 0;
6038 for (i = 0; i < tc_len; i++)
6039 {
6040 len = show_one_termcode(termcodes[i].name,
6041 termcodes[i].code, FALSE);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006042 if (len <= INC3 - GAP ? run == 1
6043 : len <= INC2 - GAP ? run == 2
6044 : run == 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 items[item_count++] = i;
6046 }
6047
6048 /*
6049 * display the items
6050 */
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006051 if (run <= 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052 {
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006053 cols = (Columns + GAP) / (run == 1 ? INC3 : INC2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 if (cols == 0)
6055 cols = 1;
6056 rows = (item_count + cols - 1) / cols;
6057 }
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006058 else // run == 3
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059 rows = item_count;
6060 for (row = 0; row < rows && !got_int; ++row)
6061 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006062 msg_putchar('\n'); // go to next line
6063 if (got_int) // 'q' typed in more
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064 break;
6065 col = 0;
6066 for (i = row; i < item_count; i += rows)
6067 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006068 msg_col = col; // make columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069 show_one_termcode(termcodes[items[i]].name,
6070 termcodes[items[i]].code, TRUE);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006071 if (run == 2)
6072 col += INC2;
6073 else
6074 col += INC3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 }
6076 out_flush();
6077 ui_breakcheck();
6078 }
6079 }
6080 vim_free(items);
6081}
6082
6083/*
6084 * Show one termcode entry.
6085 * Output goes into IObuff[]
6086 */
6087 int
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006088show_one_termcode(char_u *name, char_u *code, int printit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089{
6090 char_u *p;
6091 int len;
6092
6093 if (name[0] > '~')
6094 {
6095 IObuff[0] = ' ';
6096 IObuff[1] = ' ';
6097 IObuff[2] = ' ';
6098 IObuff[3] = ' ';
6099 }
6100 else
6101 {
6102 IObuff[0] = 't';
6103 IObuff[1] = '_';
6104 IObuff[2] = name[0];
6105 IObuff[3] = name[1];
6106 }
6107 IObuff[4] = ' ';
6108
6109 p = get_special_key_name(TERMCAP2KEY(name[0], name[1]), 0);
6110 if (p[1] != 't')
6111 STRCPY(IObuff + 5, p);
6112 else
6113 IObuff[5] = NUL;
6114 len = (int)STRLEN(IObuff);
6115 do
6116 IObuff[len++] = ' ';
6117 while (len < 17);
6118 IObuff[len] = NUL;
6119 if (code == NULL)
6120 len += 4;
6121 else
6122 len += vim_strsize(code);
6123
6124 if (printit)
6125 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01006126 msg_puts((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 if (code == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006128 msg_puts("NULL");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129 else
6130 msg_outtrans(code);
6131 }
6132 return len;
6133}
6134
6135#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
6136/*
6137 * For Xterm >= 140 compiled with OPT_TCAP_QUERY: Obtain the actually used
6138 * termcap codes from the terminal itself.
6139 * We get them one by one to avoid a very long response string.
6140 */
Bram Moolenaar4e067c82014-07-30 17:21:58 +02006141static int xt_index_in = 0;
6142static int xt_index_out = 0;
6143
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006145req_codes_from_term(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146{
6147 xt_index_out = 0;
6148 xt_index_in = 0;
6149 req_more_codes_from_term();
6150}
6151
6152 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006153req_more_codes_from_term(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154{
6155 char buf[11];
6156 int old_idx = xt_index_out;
6157
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006158 // Don't do anything when going to exit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 if (exiting)
6160 return;
6161
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006162 // Send up to 10 more requests out than we received. Avoid sending too
6163 // many, there can be a buffer overflow somewhere.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 while (xt_index_out < xt_index_in + 10 && key_names[xt_index_out] != NULL)
6165 {
Bram Moolenaarb255b902018-04-24 21:40:10 +02006166 char *key_name = key_names[xt_index_out];
Bram Moolenaar2951b772013-07-03 12:45:31 +02006167
Bram Moolenaar86394aa2020-09-05 14:27:24 +02006168#ifdef FEAT_JOB_CHANNEL
6169 ch_log_output = TRUE;
6170#endif
Bram Moolenaarb255b902018-04-24 21:40:10 +02006171 LOG_TR(("Requesting XT %d: %s", xt_index_out, key_name));
6172 sprintf(buf, "\033P+q%02x%02x\033\\", key_name[0], key_name[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006173 out_str_nf((char_u *)buf);
6174 ++xt_index_out;
6175 }
6176
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006177 // Send the codes out right away.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 if (xt_index_out != old_idx)
6179 out_flush();
6180}
6181
6182/*
6183 * Decode key code response from xterm: '<Esc>P1+r<name>=<string><Esc>\'.
6184 * A "0" instead of the "1" indicates a code that isn't supported.
6185 * Both <name> and <string> are encoded in hex.
6186 * "code" points to the "0" or "1".
6187 */
6188 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006189got_code_from_term(char_u *code, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190{
6191#define XT_LEN 100
6192 char_u name[3];
6193 char_u str[XT_LEN];
6194 int i;
6195 int j = 0;
6196 int c;
6197
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006198 // A '1' means the code is supported, a '0' means it isn't.
6199 // When half the length is > XT_LEN we can't use it.
6200 // Our names are currently all 2 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 if (code[0] == '1' && code[7] == '=' && len / 2 < XT_LEN)
6202 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006203 // Get the name from the response and find it in the table.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 name[0] = hexhex2nr(code + 3);
6205 name[1] = hexhex2nr(code + 5);
6206 name[2] = NUL;
6207 for (i = 0; key_names[i] != NULL; ++i)
6208 {
6209 if (STRCMP(key_names[i], name) == 0)
6210 {
6211 xt_index_in = i;
6212 break;
6213 }
6214 }
Bram Moolenaar2951b772013-07-03 12:45:31 +02006215
Bram Moolenaarb255b902018-04-24 21:40:10 +02006216 LOG_TR(("Received XT %d: %s", xt_index_in, (char *)name));
6217
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 if (key_names[i] != NULL)
6219 {
6220 for (i = 8; (c = hexhex2nr(code + i)) >= 0; i += 2)
6221 str[j++] = c;
6222 str[j] = NUL;
6223 if (name[0] == 'C' && name[1] == 'o')
6224 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006225 // Color count is not a key code.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 i = atoi((char *)str);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02006227 may_adjust_color_count(i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228 }
6229 else
6230 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006231 // First delete any existing entry with the same code.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 i = find_term_bykeys(str);
6233 if (i >= 0)
6234 del_termcode_idx(i);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006235 add_termcode(name, str, ATC_FROM_TERM);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 }
6237 }
6238 }
6239
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006240 // May request more codes now that we received one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 ++xt_index_in;
6242 req_more_codes_from_term();
6243}
6244
6245/*
6246 * Check if there are any unanswered requests and deal with them.
6247 * This is called before starting an external program or getting direct
6248 * keyboard input. We don't want responses to be send to that program or
6249 * handled as typed text.
6250 */
6251 static void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006252check_for_codes_from_term(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253{
6254 int c;
6255
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006256 // If no codes requested or all are answered, no need to wait.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 if (xt_index_out == 0 || xt_index_out == xt_index_in)
6258 return;
6259
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006260 // Vgetc() will check for and handle any response.
6261 // Keep calling vpeekc() until we don't get any responses.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 ++no_mapping;
6263 ++allow_keys;
6264 for (;;)
6265 {
6266 c = vpeekc();
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006267 if (c == NUL) // nothing available
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 break;
6269
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006270 // If a response is recognized it's replaced with K_IGNORE, must read
6271 // it from the input stream. If there is no K_IGNORE we can't do
6272 // anything, break here (there might be some responses further on, but
6273 // we don't want to throw away any typed chars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 if (c != K_SPECIAL && c != K_IGNORE)
6275 break;
6276 c = vgetc();
6277 if (c != K_IGNORE)
6278 {
6279 vungetc(c);
6280 break;
6281 }
6282 }
6283 --no_mapping;
6284 --allow_keys;
6285}
6286#endif
6287
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006288#if (defined(MSWIN) && (!defined(FEAT_GUI) || defined(VIMDLL))) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289static char ksme_str[20];
6290static char ksmr_str[20];
6291static char ksmd_str[20];
6292
6293/*
6294 * For Win32 console: update termcap codes for existing console attributes.
6295 */
6296 void
Bram Moolenaar764b23c2016-01-30 21:10:09 +01006297update_tcap(int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298{
6299 struct builtin_term *p;
6300
6301 p = find_builtin_term(DEFAULT_TERM);
6302 sprintf(ksme_str, IF_EB("\033|%dm", ESC_STR "|%dm"), attr);
6303 sprintf(ksmd_str, IF_EB("\033|%dm", ESC_STR "|%dm"),
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006304 attr | 0x08); // FOREGROUND_INTENSITY
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 sprintf(ksmr_str, IF_EB("\033|%dm", ESC_STR "|%dm"),
6306 ((attr & 0x0F) << 4) | ((attr & 0xF0) >> 4));
6307
6308 while (p->bt_string != NULL)
6309 {
6310 if (p->bt_entry == (int)KS_ME)
6311 p->bt_string = &ksme_str[0];
6312 else if (p->bt_entry == (int)KS_MR)
6313 p->bt_string = &ksmr_str[0];
6314 else if (p->bt_entry == (int)KS_MD)
6315 p->bt_string = &ksmd_str[0];
6316 ++p;
6317 }
6318}
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006319
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006320# ifdef FEAT_TERMGUICOLORS
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006321# define KSSIZE 20
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006322struct ks_tbl_s
6323{
Bram Moolenaard4f73432018-09-21 12:24:12 +02006324 int code; // value of KS_
6325 char *vtp; // code in vtp mode
6326 char *vtp2; // code in vtp2 mode
6327 char buf[KSSIZE]; // save buffer in non-vtp mode
6328 char vbuf[KSSIZE]; // save buffer in vtp mode
6329 char v2buf[KSSIZE]; // save buffer in vtp2 mode
6330 char arr[KSSIZE]; // real buffer
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006331};
6332
6333static struct ks_tbl_s ks_tbl[] =
6334{
Bram Moolenaard4f73432018-09-21 12:24:12 +02006335 {(int)KS_ME, "\033|0m", "\033|0m"}, // normal
6336 {(int)KS_MR, "\033|7m", "\033|7m"}, // reverse
6337 {(int)KS_MD, "\033|1m", "\033|1m"}, // bold
6338 {(int)KS_SO, "\033|91m", "\033|91m"}, // standout: bright red text
6339 {(int)KS_SE, "\033|39m", "\033|39m"}, // standout end: default color
6340 {(int)KS_CZH, "\033|95m", "\033|95m"}, // italic: bright magenta text
6341 {(int)KS_CZR, "\033|0m", "\033|0m"}, // italic end
6342 {(int)KS_US, "\033|4m", "\033|4m"}, // underscore
6343 {(int)KS_UE, "\033|24m", "\033|24m"}, // underscore end
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006344# ifdef TERMINFO
Bram Moolenaard4f73432018-09-21 12:24:12 +02006345 {(int)KS_CAB, "\033|%p1%db", "\033|%p14%dm"}, // set background color
6346 {(int)KS_CAF, "\033|%p1%df", "\033|%p13%dm"}, // set foreground color
Bram Moolenaar6982f422019-02-16 16:48:01 +01006347 {(int)KS_CS, "\033|%p1%d;%p2%dR", "\033|%p1%d;%p2%dR"},
6348 {(int)KS_CSV, "\033|%p1%d;%p2%dV", "\033|%p1%d;%p2%dV"},
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006349# else
Bram Moolenaard4f73432018-09-21 12:24:12 +02006350 {(int)KS_CAB, "\033|%db", "\033|4%dm"}, // set background color
6351 {(int)KS_CAF, "\033|%df", "\033|3%dm"}, // set foreground color
Bram Moolenaar6982f422019-02-16 16:48:01 +01006352 {(int)KS_CS, "\033|%d;%dR", "\033|%d;%dR"},
6353 {(int)KS_CSV, "\033|%d;%dV", "\033|%d;%dV"},
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006354# endif
Bram Moolenaard4f73432018-09-21 12:24:12 +02006355 {(int)KS_CCO, "256", "256"}, // colors
6356 {(int)KS_NAME} // terminator
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006357};
6358
6359 static struct builtin_term *
6360find_first_tcap(
6361 char_u *name,
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006362 int code)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006363{
6364 struct builtin_term *p;
6365
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006366 for (p = find_builtin_term(name); p->bt_string != NULL; ++p)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006367 if (p->bt_entry == code)
6368 return p;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006369 return NULL;
6370}
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006371# endif
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006372
6373/*
6374 * For Win32 console: replace the sequence immediately after termguicolors.
6375 */
6376 void
6377swap_tcap(void)
6378{
6379# ifdef FEAT_TERMGUICOLORS
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006380 static int init_done = FALSE;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006381 static int curr_mode;
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006382 struct ks_tbl_s *ks;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006383 struct builtin_term *bt;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006384 int mode;
6385 enum
6386 {
6387 CMODEINDEX,
6388 CMODE24,
6389 CMODE256
6390 };
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006391
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006392 // buffer initialization
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006393 if (!init_done)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006394 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006395 for (ks = ks_tbl; ks->code != (int)KS_NAME; ks++)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006396 {
6397 bt = find_first_tcap(DEFAULT_TERM, ks->code);
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006398 if (bt != NULL)
6399 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006400 STRNCPY(ks->buf, bt->bt_string, KSSIZE);
6401 STRNCPY(ks->vbuf, ks->vtp, KSSIZE);
6402 STRNCPY(ks->v2buf, ks->vtp2, KSSIZE);
6403
6404 STRNCPY(ks->arr, bt->bt_string, KSSIZE);
6405 bt->bt_string = &ks->arr[0];
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006406 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006407 }
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006408 init_done = TRUE;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006409 curr_mode = CMODEINDEX;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006410 }
6411
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006412 if (p_tgc)
6413 mode = CMODE24;
6414 else if (t_colors >= 256)
6415 mode = CMODE256;
6416 else
6417 mode = CMODEINDEX;
6418
6419 for (ks = ks_tbl; ks->code != (int)KS_NAME; ks++)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006420 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006421 bt = find_first_tcap(DEFAULT_TERM, ks->code);
6422 if (bt != NULL)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006423 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006424 switch (curr_mode)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006425 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006426 case CMODEINDEX:
6427 STRNCPY(&ks->buf[0], bt->bt_string, KSSIZE);
6428 break;
6429 case CMODE24:
6430 STRNCPY(&ks->vbuf[0], bt->bt_string, KSSIZE);
6431 break;
6432 default:
6433 STRNCPY(&ks->v2buf[0], bt->bt_string, KSSIZE);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006434 }
6435 }
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006436 }
6437
6438 if (mode != curr_mode)
6439 {
6440 for (ks = ks_tbl; ks->code != (int)KS_NAME; ks++)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006441 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006442 bt = find_first_tcap(DEFAULT_TERM, ks->code);
6443 if (bt != NULL)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006444 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006445 switch (mode)
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006446 {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006447 case CMODEINDEX:
6448 STRNCPY(bt->bt_string, &ks->buf[0], KSSIZE);
6449 break;
6450 case CMODE24:
6451 STRNCPY(bt->bt_string, &ks->vbuf[0], KSSIZE);
6452 break;
6453 default:
6454 STRNCPY(bt->bt_string, &ks->v2buf[0], KSSIZE);
Bram Moolenaarcc0f2be2018-02-23 18:23:30 +01006455 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006456 }
6457 }
6458
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006459 curr_mode = mode;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006460 }
6461# endif
6462}
6463
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464#endif
Bram Moolenaarab302212016-04-26 20:59:29 +02006465
Bram Moolenaar61be73b2016-04-29 22:59:22 +02006466#if defined(FEAT_GUI) || defined(FEAT_TERMGUICOLORS) || defined(PROTO)
Bram Moolenaarab302212016-04-26 20:59:29 +02006467 static int
6468hex_digit(int c)
6469{
6470 if (isdigit(c))
6471 return c - '0';
6472 c = TOLOWER_ASC(c);
6473 if (c >= 'a' && c <= 'f')
6474 return c - 'a' + 10;
6475 return 0x1ffffff;
6476}
6477
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006478# ifdef VIMDLL
6479 static guicolor_T
6480gui_adjust_rgb(guicolor_T c)
6481{
6482 if (gui.in_use)
6483 return c;
6484 else
6485 return ((c & 0xff) << 16) | (c & 0x00ff00) | ((c >> 16) & 0xff);
6486}
6487# else
6488# define gui_adjust_rgb(c) (c)
6489# endif
6490
Bram Moolenaarab302212016-04-26 20:59:29 +02006491 guicolor_T
6492gui_get_color_cmn(char_u *name)
6493{
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006494 // On MS-Windows an RGB macro is available and it produces 0x00bbggrr color
6495 // values as used by the MS-Windows GDI api. It should be used only for
6496 // MS-Windows GDI builds.
Bram Moolenaar4f974752019-02-17 17:44:42 +01006497# if defined(RGB) && defined(MSWIN) && !defined(FEAT_GUI)
Bram Moolenaar28726652017-01-06 18:16:19 +01006498# undef RGB
6499# endif
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006500# ifndef RGB
6501# define RGB(r, g, b) ((r<<16) | (g<<8) | (b))
6502# endif
6503# define LINE_LEN 100
Bram Moolenaarab302212016-04-26 20:59:29 +02006504 FILE *fd;
6505 char line[LINE_LEN];
6506 char_u *fname;
6507 int r, g, b, i;
6508 guicolor_T color;
6509
6510 struct rgbcolor_table_S {
6511 char_u *color_name;
6512 guicolor_T color;
6513 };
6514
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006515 // Only non X11 colors (not present in rgb.txt) and colors in
6516 // color_names[], useful when $VIMRUNTIME is not found,.
Bram Moolenaarab302212016-04-26 20:59:29 +02006517 static struct rgbcolor_table_S rgb_table[] = {
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006518 {(char_u *)"black", RGB(0x00, 0x00, 0x00)},
6519 {(char_u *)"blue", RGB(0x00, 0x00, 0xFF)},
6520 {(char_u *)"brown", RGB(0xA5, 0x2A, 0x2A)},
6521 {(char_u *)"cyan", RGB(0x00, 0xFF, 0xFF)},
6522 {(char_u *)"darkblue", RGB(0x00, 0x00, 0x8B)},
6523 {(char_u *)"darkcyan", RGB(0x00, 0x8B, 0x8B)},
6524 {(char_u *)"darkgray", RGB(0xA9, 0xA9, 0xA9)},
6525 {(char_u *)"darkgreen", RGB(0x00, 0x64, 0x00)},
6526 {(char_u *)"darkgrey", RGB(0xA9, 0xA9, 0xA9)},
6527 {(char_u *)"darkmagenta", RGB(0x8B, 0x00, 0x8B)},
6528 {(char_u *)"darkred", RGB(0x8B, 0x00, 0x00)},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006529 {(char_u *)"darkyellow", RGB(0x8B, 0x8B, 0x00)}, // No X11
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006530 {(char_u *)"gray", RGB(0xBE, 0xBE, 0xBE)},
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006531 {(char_u *)"green", RGB(0x00, 0xFF, 0x00)},
6532 {(char_u *)"grey", RGB(0xBE, 0xBE, 0xBE)},
Bram Moolenaar21477462016-08-08 20:43:27 +02006533 {(char_u *)"grey40", RGB(0x66, 0x66, 0x66)},
Bram Moolenaarecadf432018-03-20 11:17:04 +01006534 {(char_u *)"grey50", RGB(0x7F, 0x7F, 0x7F)},
Bram Moolenaarca8942c2016-07-19 23:36:31 +02006535 {(char_u *)"grey90", RGB(0xE5, 0xE5, 0xE5)},
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006536 {(char_u *)"lightblue", RGB(0xAD, 0xD8, 0xE6)},
6537 {(char_u *)"lightcyan", RGB(0xE0, 0xFF, 0xFF)},
6538 {(char_u *)"lightgray", RGB(0xD3, 0xD3, 0xD3)},
6539 {(char_u *)"lightgreen", RGB(0x90, 0xEE, 0x90)},
6540 {(char_u *)"lightgrey", RGB(0xD3, 0xD3, 0xD3)},
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006541 {(char_u *)"lightmagenta", RGB(0xFF, 0x8B, 0xFF)}, // No X11
6542 {(char_u *)"lightred", RGB(0xFF, 0x8B, 0x8B)}, // No X11
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006543 {(char_u *)"lightyellow", RGB(0xFF, 0xFF, 0xE0)},
6544 {(char_u *)"magenta", RGB(0xFF, 0x00, 0xFF)},
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006545 {(char_u *)"red", RGB(0xFF, 0x00, 0x00)},
Bram Moolenaarca8942c2016-07-19 23:36:31 +02006546 {(char_u *)"seagreen", RGB(0x2E, 0x8B, 0x57)},
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006547 {(char_u *)"white", RGB(0xFF, 0xFF, 0xFF)},
6548 {(char_u *)"yellow", RGB(0xFF, 0xFF, 0x00)},
Bram Moolenaarab302212016-04-26 20:59:29 +02006549 };
6550
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006551 static struct rgbcolor_table_S *colornames_table;
6552 static int size = 0;
Bram Moolenaarab302212016-04-26 20:59:29 +02006553
6554 if (name[0] == '#' && STRLEN(name) == 7)
6555 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006556 // Name is in "#rrggbb" format
Bram Moolenaar283ee8b2016-04-27 20:36:31 +02006557 color = RGB(((hex_digit(name[1]) << 4) + hex_digit(name[2])),
Bram Moolenaarab302212016-04-26 20:59:29 +02006558 ((hex_digit(name[3]) << 4) + hex_digit(name[4])),
6559 ((hex_digit(name[5]) << 4) + hex_digit(name[6])));
6560 if (color > 0xffffff)
6561 return INVALCOLOR;
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006562 return gui_adjust_rgb(color);
Bram Moolenaarab302212016-04-26 20:59:29 +02006563 }
6564
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006565 // Check if the name is one of the colors we know
Bram Moolenaarab302212016-04-26 20:59:29 +02006566 for (i = 0; i < (int)(sizeof(rgb_table) / sizeof(rgb_table[0])); i++)
6567 if (STRICMP(name, rgb_table[i].color_name) == 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006568 return gui_adjust_rgb(rgb_table[i].color);
Bram Moolenaarab302212016-04-26 20:59:29 +02006569
6570 /*
Bram Moolenaar0ea21e42019-02-12 20:46:48 +01006571 * Last attempt. Look in the file "$VIMRUNTIME/rgb.txt".
Bram Moolenaarab302212016-04-26 20:59:29 +02006572 */
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006573 if (size == 0)
Bram Moolenaarab302212016-04-26 20:59:29 +02006574 {
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006575 int counting;
Bram Moolenaarab302212016-04-26 20:59:29 +02006576
Bram Moolenaar0ea21e42019-02-12 20:46:48 +01006577 // colornames_table not yet initialized
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006578 fname = expand_env_save((char_u *)"$VIMRUNTIME/rgb.txt");
6579 if (fname == NULL)
6580 return INVALCOLOR;
Bram Moolenaarab302212016-04-26 20:59:29 +02006581
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006582 fd = fopen((char *)fname, "rt");
6583 vim_free(fname);
6584 if (fd == NULL)
Bram Moolenaarab302212016-04-26 20:59:29 +02006585 {
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006586 if (p_verbose > 1)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006587 verb_msg(_("Cannot open $VIMRUNTIME/rgb.txt"));
Bram Moolenaar0ea21e42019-02-12 20:46:48 +01006588 size = -1; // don't try again
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006589 return INVALCOLOR;
Bram Moolenaarab302212016-04-26 20:59:29 +02006590 }
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006591
6592 for (counting = 1; counting >= 0; --counting)
6593 {
6594 if (!counting)
6595 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006596 colornames_table = ALLOC_MULT(struct rgbcolor_table_S, size);
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006597 if (colornames_table == NULL)
6598 {
6599 fclose(fd);
6600 return INVALCOLOR;
6601 }
6602 rewind(fd);
6603 }
6604 size = 0;
6605
6606 while (!feof(fd))
6607 {
6608 size_t len;
6609 int pos;
6610
Bram Moolenaar42335f52018-09-13 15:33:43 +02006611 vim_ignoredp = fgets(line, LINE_LEN, fd);
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006612 len = strlen(line);
6613
6614 if (len <= 1 || line[len - 1] != '\n')
6615 continue;
6616
6617 line[len - 1] = '\0';
6618
6619 i = sscanf(line, "%d %d %d %n", &r, &g, &b, &pos);
6620 if (i != 3)
6621 continue;
6622
6623 if (!counting)
6624 {
6625 char_u *s = vim_strsave((char_u *)line + pos);
6626
6627 if (s == NULL)
Bram Moolenaar2e45d212016-07-22 22:12:38 +02006628 {
6629 fclose(fd);
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006630 return INVALCOLOR;
Bram Moolenaar2e45d212016-07-22 22:12:38 +02006631 }
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006632 colornames_table[size].color_name = s;
6633 colornames_table[size].color = (guicolor_T)RGB(r, g, b);
6634 }
6635 size++;
Bram Moolenaar0ea21e42019-02-12 20:46:48 +01006636
6637 // The distributed rgb.txt has less than 1000 entries. Limit to
6638 // 10000, just in case the file was messed up.
6639 if (size == 10000)
6640 break;
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006641 }
6642 }
6643 fclose(fd);
Bram Moolenaarab302212016-04-26 20:59:29 +02006644 }
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006645
6646 for (i = 0; i < size; i++)
6647 if (STRICMP(name, colornames_table[i].color_name) == 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006648 return gui_adjust_rgb(colornames_table[i].color);
Bram Moolenaar68015bb2016-07-19 21:05:21 +02006649
Bram Moolenaarab302212016-04-26 20:59:29 +02006650 return INVALCOLOR;
6651}
Bram Moolenaar26af85d2017-07-23 16:45:10 +02006652
6653 guicolor_T
6654gui_get_rgb_color_cmn(int r, int g, int b)
6655{
6656 guicolor_T color = RGB(r, g, b);
6657
6658 if (color > 0xffffff)
6659 return INVALCOLOR;
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006660 return gui_adjust_rgb(color);
Bram Moolenaar26af85d2017-07-23 16:45:10 +02006661}
Bram Moolenaarab302212016-04-26 20:59:29 +02006662#endif
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006663
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006664#if (defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))) || defined(FEAT_TERMINAL) \
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006665 || defined(PROTO)
6666static int cube_value[] = {
6667 0x00, 0x5F, 0x87, 0xAF, 0xD7, 0xFF
6668};
6669
6670static int grey_ramp[] = {
6671 0x08, 0x12, 0x1C, 0x26, 0x30, 0x3A, 0x44, 0x4E, 0x58, 0x62, 0x6C, 0x76,
6672 0x80, 0x8A, 0x94, 0x9E, 0xA8, 0xB2, 0xBC, 0xC6, 0xD0, 0xDA, 0xE4, 0xEE
6673};
6674
Bram Moolenaar9894e392018-05-05 14:29:06 +02006675static char_u ansi_table[16][4] = {
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006676// R G B idx
6677 { 0, 0, 0, 1}, // black
6678 {224, 0, 0, 2}, // dark red
6679 { 0, 224, 0, 3}, // dark green
6680 {224, 224, 0, 4}, // dark yellow / brown
6681 { 0, 0, 224, 5}, // dark blue
6682 {224, 0, 224, 6}, // dark magenta
6683 { 0, 224, 224, 7}, // dark cyan
6684 {224, 224, 224, 8}, // light grey
6685
6686 {128, 128, 128, 9}, // dark grey
6687 {255, 64, 64, 10}, // light red
6688 { 64, 255, 64, 11}, // light green
6689 {255, 255, 64, 12}, // yellow
6690 { 64, 64, 255, 13}, // light blue
6691 {255, 64, 255, 14}, // light magenta
6692 { 64, 255, 255, 15}, // light cyan
6693 {255, 255, 255, 16}, // white
6694};
6695
Bram Moolenaare5886cc2020-05-21 20:10:04 +02006696#define ANSI_INDEX_NONE 0
6697
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006698 void
Bram Moolenaar9894e392018-05-05 14:29:06 +02006699cterm_color2rgb(int nr, char_u *r, char_u *g, char_u *b, char_u *ansi_idx)
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006700{
6701 int idx;
6702
6703 if (nr < 16)
6704 {
6705 *r = ansi_table[nr][0];
6706 *g = ansi_table[nr][1];
6707 *b = ansi_table[nr][2];
6708 *ansi_idx = ansi_table[nr][3];
6709 }
6710 else if (nr < 232)
6711 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006712 // 216 color cube
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006713 idx = nr - 16;
6714 *r = cube_value[idx / 36 % 6];
6715 *g = cube_value[idx / 6 % 6];
6716 *b = cube_value[idx % 6];
Bram Moolenaare5886cc2020-05-21 20:10:04 +02006717 *ansi_idx = ANSI_INDEX_NONE;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006718 }
6719 else if (nr < 256)
6720 {
Bram Moolenaar0d6f5d92019-12-05 21:33:15 +01006721 // 24 grey scale ramp
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006722 idx = nr - 232;
6723 *r = grey_ramp[idx];
6724 *g = grey_ramp[idx];
6725 *b = grey_ramp[idx];
Bram Moolenaare5886cc2020-05-21 20:10:04 +02006726 *ansi_idx = ANSI_INDEX_NONE;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006727 }
6728 else
6729 {
6730 *r = 0;
6731 *g = 0;
6732 *b = 0;
Bram Moolenaare5886cc2020-05-21 20:10:04 +02006733 *ansi_idx = ANSI_INDEX_NONE;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006734 }
6735}
6736#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01006737
Bram Moolenaarf4140482020-02-15 23:06:45 +01006738/*
6739 * Replace K_BS by <BS> and K_DEL by <DEL>
6740 */
6741 void
6742term_replace_bs_del_keycode(char_u *ta_buf, int ta_len, int len)
6743{
6744 int i;
6745 int c;
6746
6747 for (i = ta_len; i < ta_len + len; ++i)
6748 {
6749 if (ta_buf[i] == CSI && len - i > 2)
6750 {
6751 c = TERMCAP2KEY(ta_buf[i + 1], ta_buf[i + 2]);
6752 if (c == K_DEL || c == K_KDEL || c == K_BS)
6753 {
6754 mch_memmove(ta_buf + i + 1, ta_buf + i + 3,
6755 (size_t)(len - i - 2));
6756 if (c == K_DEL || c == K_KDEL)
6757 ta_buf[i] = DEL;
6758 else
6759 ta_buf[i] = Ctrl_H;
6760 len -= 2;
6761 }
6762 }
6763 else if (ta_buf[i] == '\r')
6764 ta_buf[i] = '\n';
6765 if (has_mbyte)
6766 i += (*mb_ptr2len_len)(ta_buf + i, ta_len + len - i) - 1;
6767 }
6768}