Coverage Report

Created: 2023-06-07 06:04

/src/tmux/tty-term.c
Line
Count
Source (jump to first uncovered line)
1
/* $OpenBSD$ */
2
3
/*
4
 * Copyright (c) 2008 Nicholas Marriott <nicholas.marriott@gmail.com>
5
 *
6
 * Permission to use, copy, modify, and distribute this software for any
7
 * purpose with or without fee is hereby granted, provided that the above
8
 * copyright notice and this permission notice appear in all copies.
9
 *
10
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17
 */
18
19
#include <sys/types.h>
20
21
#if defined(HAVE_CURSES_H)
22
#include <curses.h>
23
#elif defined(HAVE_NCURSES_H)
24
#include <ncurses.h>
25
#endif
26
#include <fnmatch.h>
27
#include <stdlib.h>
28
#include <string.h>
29
#include <term.h>
30
31
#include "tmux.h"
32
33
static char *tty_term_strip(const char *);
34
35
struct tty_terms tty_terms = LIST_HEAD_INITIALIZER(tty_terms);
36
37
enum tty_code_type {
38
  TTYCODE_NONE = 0,
39
  TTYCODE_STRING,
40
  TTYCODE_NUMBER,
41
  TTYCODE_FLAG,
42
};
43
44
struct tty_code {
45
  enum tty_code_type  type;
46
  union {
47
    char         *string;
48
    int   number;
49
    int   flag;
50
  } value;
51
};
52
53
struct tty_term_code_entry {
54
  enum tty_code_type  type;
55
  const char         *name;
56
};
57
58
static const struct tty_term_code_entry tty_term_codes[] = {
59
  [TTYC_ACSC] = { TTYCODE_STRING, "acsc" },
60
  [TTYC_AM] = { TTYCODE_FLAG, "am" },
61
  [TTYC_AX] = { TTYCODE_FLAG, "AX" },
62
  [TTYC_BCE] = { TTYCODE_FLAG, "bce" },
63
  [TTYC_BEL] = { TTYCODE_STRING, "bel" },
64
  [TTYC_BIDI] = { TTYCODE_STRING, "Bidi" },
65
  [TTYC_BLINK] = { TTYCODE_STRING, "blink" },
66
  [TTYC_BOLD] = { TTYCODE_STRING, "bold" },
67
  [TTYC_CIVIS] = { TTYCODE_STRING, "civis" },
68
  [TTYC_CLEAR] = { TTYCODE_STRING, "clear" },
69
  [TTYC_CLMG] = { TTYCODE_STRING, "Clmg" },
70
  [TTYC_CMG] = { TTYCODE_STRING, "Cmg" },
71
  [TTYC_CNORM] = { TTYCODE_STRING, "cnorm" },
72
  [TTYC_COLORS] = { TTYCODE_NUMBER, "colors" },
73
  [TTYC_CR] = { TTYCODE_STRING, "Cr" },
74
  [TTYC_CSR] = { TTYCODE_STRING, "csr" },
75
  [TTYC_CS] = { TTYCODE_STRING, "Cs" },
76
  [TTYC_CUB1] = { TTYCODE_STRING, "cub1" },
77
  [TTYC_CUB] = { TTYCODE_STRING, "cub" },
78
  [TTYC_CUD1] = { TTYCODE_STRING, "cud1" },
79
  [TTYC_CUD] = { TTYCODE_STRING, "cud" },
80
  [TTYC_CUF1] = { TTYCODE_STRING, "cuf1" },
81
  [TTYC_CUF] = { TTYCODE_STRING, "cuf" },
82
  [TTYC_CUP] = { TTYCODE_STRING, "cup" },
83
  [TTYC_CUU1] = { TTYCODE_STRING, "cuu1" },
84
  [TTYC_CUU] = { TTYCODE_STRING, "cuu" },
85
  [TTYC_CVVIS] = { TTYCODE_STRING, "cvvis" },
86
  [TTYC_DCH1] = { TTYCODE_STRING, "dch1" },
87
  [TTYC_DCH] = { TTYCODE_STRING, "dch" },
88
  [TTYC_DIM] = { TTYCODE_STRING, "dim" },
89
  [TTYC_DL1] = { TTYCODE_STRING, "dl1" },
90
  [TTYC_DL] = { TTYCODE_STRING, "dl" },
91
  [TTYC_DSEKS] = { TTYCODE_STRING, "Dseks" },
92
  [TTYC_DSFCS] = { TTYCODE_STRING, "Dsfcs" },
93
  [TTYC_DSBP] = { TTYCODE_STRING, "Dsbp" },
94
  [TTYC_DSMG] = { TTYCODE_STRING, "Dsmg" },
95
  [TTYC_E3] = { TTYCODE_STRING, "E3" },
96
  [TTYC_ECH] = { TTYCODE_STRING, "ech" },
97
  [TTYC_ED] = { TTYCODE_STRING, "ed" },
98
  [TTYC_EL1] = { TTYCODE_STRING, "el1" },
99
  [TTYC_EL] = { TTYCODE_STRING, "el" },
100
  [TTYC_ENACS] = { TTYCODE_STRING, "enacs" },
101
  [TTYC_ENBP] = { TTYCODE_STRING, "Enbp" },
102
  [TTYC_ENEKS] = { TTYCODE_STRING, "Eneks" },
103
  [TTYC_ENFCS] = { TTYCODE_STRING, "Enfcs" },
104
  [TTYC_ENMG] = { TTYCODE_STRING, "Enmg" },
105
  [TTYC_FSL] = { TTYCODE_STRING, "fsl" },
106
  [TTYC_HLS] = { TTYCODE_STRING, "Hls" },
107
  [TTYC_HOME] = { TTYCODE_STRING, "home" },
108
  [TTYC_HPA] = { TTYCODE_STRING, "hpa" },
109
  [TTYC_ICH1] = { TTYCODE_STRING, "ich1" },
110
  [TTYC_ICH] = { TTYCODE_STRING, "ich" },
111
  [TTYC_IL1] = { TTYCODE_STRING, "il1" },
112
  [TTYC_IL] = { TTYCODE_STRING, "il" },
113
  [TTYC_INDN] = { TTYCODE_STRING, "indn" },
114
  [TTYC_INVIS] = { TTYCODE_STRING, "invis" },
115
  [TTYC_KCBT] = { TTYCODE_STRING, "kcbt" },
116
  [TTYC_KCUB1] = { TTYCODE_STRING, "kcub1" },
117
  [TTYC_KCUD1] = { TTYCODE_STRING, "kcud1" },
118
  [TTYC_KCUF1] = { TTYCODE_STRING, "kcuf1" },
119
  [TTYC_KCUU1] = { TTYCODE_STRING, "kcuu1" },
120
  [TTYC_KDC2] = { TTYCODE_STRING, "kDC" },
121
  [TTYC_KDC3] = { TTYCODE_STRING, "kDC3" },
122
  [TTYC_KDC4] = { TTYCODE_STRING, "kDC4" },
123
  [TTYC_KDC5] = { TTYCODE_STRING, "kDC5" },
124
  [TTYC_KDC6] = { TTYCODE_STRING, "kDC6" },
125
  [TTYC_KDC7] = { TTYCODE_STRING, "kDC7" },
126
  [TTYC_KDCH1] = { TTYCODE_STRING, "kdch1" },
127
  [TTYC_KDN2] = { TTYCODE_STRING, "kDN" }, /* not kDN2 */
128
  [TTYC_KDN3] = { TTYCODE_STRING, "kDN3" },
129
  [TTYC_KDN4] = { TTYCODE_STRING, "kDN4" },
130
  [TTYC_KDN5] = { TTYCODE_STRING, "kDN5" },
131
  [TTYC_KDN6] = { TTYCODE_STRING, "kDN6" },
132
  [TTYC_KDN7] = { TTYCODE_STRING, "kDN7" },
133
  [TTYC_KEND2] = { TTYCODE_STRING, "kEND" },
134
  [TTYC_KEND3] = { TTYCODE_STRING, "kEND3" },
135
  [TTYC_KEND4] = { TTYCODE_STRING, "kEND4" },
136
  [TTYC_KEND5] = { TTYCODE_STRING, "kEND5" },
137
  [TTYC_KEND6] = { TTYCODE_STRING, "kEND6" },
138
  [TTYC_KEND7] = { TTYCODE_STRING, "kEND7" },
139
  [TTYC_KEND] = { TTYCODE_STRING, "kend" },
140
  [TTYC_KF10] = { TTYCODE_STRING, "kf10" },
141
  [TTYC_KF11] = { TTYCODE_STRING, "kf11" },
142
  [TTYC_KF12] = { TTYCODE_STRING, "kf12" },
143
  [TTYC_KF13] = { TTYCODE_STRING, "kf13" },
144
  [TTYC_KF14] = { TTYCODE_STRING, "kf14" },
145
  [TTYC_KF15] = { TTYCODE_STRING, "kf15" },
146
  [TTYC_KF16] = { TTYCODE_STRING, "kf16" },
147
  [TTYC_KF17] = { TTYCODE_STRING, "kf17" },
148
  [TTYC_KF18] = { TTYCODE_STRING, "kf18" },
149
  [TTYC_KF19] = { TTYCODE_STRING, "kf19" },
150
  [TTYC_KF1] = { TTYCODE_STRING, "kf1" },
151
  [TTYC_KF20] = { TTYCODE_STRING, "kf20" },
152
  [TTYC_KF21] = { TTYCODE_STRING, "kf21" },
153
  [TTYC_KF22] = { TTYCODE_STRING, "kf22" },
154
  [TTYC_KF23] = { TTYCODE_STRING, "kf23" },
155
  [TTYC_KF24] = { TTYCODE_STRING, "kf24" },
156
  [TTYC_KF25] = { TTYCODE_STRING, "kf25" },
157
  [TTYC_KF26] = { TTYCODE_STRING, "kf26" },
158
  [TTYC_KF27] = { TTYCODE_STRING, "kf27" },
159
  [TTYC_KF28] = { TTYCODE_STRING, "kf28" },
160
  [TTYC_KF29] = { TTYCODE_STRING, "kf29" },
161
  [TTYC_KF2] = { TTYCODE_STRING, "kf2" },
162
  [TTYC_KF30] = { TTYCODE_STRING, "kf30" },
163
  [TTYC_KF31] = { TTYCODE_STRING, "kf31" },
164
  [TTYC_KF32] = { TTYCODE_STRING, "kf32" },
165
  [TTYC_KF33] = { TTYCODE_STRING, "kf33" },
166
  [TTYC_KF34] = { TTYCODE_STRING, "kf34" },
167
  [TTYC_KF35] = { TTYCODE_STRING, "kf35" },
168
  [TTYC_KF36] = { TTYCODE_STRING, "kf36" },
169
  [TTYC_KF37] = { TTYCODE_STRING, "kf37" },
170
  [TTYC_KF38] = { TTYCODE_STRING, "kf38" },
171
  [TTYC_KF39] = { TTYCODE_STRING, "kf39" },
172
  [TTYC_KF3] = { TTYCODE_STRING, "kf3" },
173
  [TTYC_KF40] = { TTYCODE_STRING, "kf40" },
174
  [TTYC_KF41] = { TTYCODE_STRING, "kf41" },
175
  [TTYC_KF42] = { TTYCODE_STRING, "kf42" },
176
  [TTYC_KF43] = { TTYCODE_STRING, "kf43" },
177
  [TTYC_KF44] = { TTYCODE_STRING, "kf44" },
178
  [TTYC_KF45] = { TTYCODE_STRING, "kf45" },
179
  [TTYC_KF46] = { TTYCODE_STRING, "kf46" },
180
  [TTYC_KF47] = { TTYCODE_STRING, "kf47" },
181
  [TTYC_KF48] = { TTYCODE_STRING, "kf48" },
182
  [TTYC_KF49] = { TTYCODE_STRING, "kf49" },
183
  [TTYC_KF4] = { TTYCODE_STRING, "kf4" },
184
  [TTYC_KF50] = { TTYCODE_STRING, "kf50" },
185
  [TTYC_KF51] = { TTYCODE_STRING, "kf51" },
186
  [TTYC_KF52] = { TTYCODE_STRING, "kf52" },
187
  [TTYC_KF53] = { TTYCODE_STRING, "kf53" },
188
  [TTYC_KF54] = { TTYCODE_STRING, "kf54" },
189
  [TTYC_KF55] = { TTYCODE_STRING, "kf55" },
190
  [TTYC_KF56] = { TTYCODE_STRING, "kf56" },
191
  [TTYC_KF57] = { TTYCODE_STRING, "kf57" },
192
  [TTYC_KF58] = { TTYCODE_STRING, "kf58" },
193
  [TTYC_KF59] = { TTYCODE_STRING, "kf59" },
194
  [TTYC_KF5] = { TTYCODE_STRING, "kf5" },
195
  [TTYC_KF60] = { TTYCODE_STRING, "kf60" },
196
  [TTYC_KF61] = { TTYCODE_STRING, "kf61" },
197
  [TTYC_KF62] = { TTYCODE_STRING, "kf62" },
198
  [TTYC_KF63] = { TTYCODE_STRING, "kf63" },
199
  [TTYC_KF6] = { TTYCODE_STRING, "kf6" },
200
  [TTYC_KF7] = { TTYCODE_STRING, "kf7" },
201
  [TTYC_KF8] = { TTYCODE_STRING, "kf8" },
202
  [TTYC_KF9] = { TTYCODE_STRING, "kf9" },
203
  [TTYC_KHOM2] = { TTYCODE_STRING, "kHOM" },
204
  [TTYC_KHOM3] = { TTYCODE_STRING, "kHOM3" },
205
  [TTYC_KHOM4] = { TTYCODE_STRING, "kHOM4" },
206
  [TTYC_KHOM5] = { TTYCODE_STRING, "kHOM5" },
207
  [TTYC_KHOM6] = { TTYCODE_STRING, "kHOM6" },
208
  [TTYC_KHOM7] = { TTYCODE_STRING, "kHOM7" },
209
  [TTYC_KHOME] = { TTYCODE_STRING, "khome" },
210
  [TTYC_KIC2] = { TTYCODE_STRING, "kIC" },
211
  [TTYC_KIC3] = { TTYCODE_STRING, "kIC3" },
212
  [TTYC_KIC4] = { TTYCODE_STRING, "kIC4" },
213
  [TTYC_KIC5] = { TTYCODE_STRING, "kIC5" },
214
  [TTYC_KIC6] = { TTYCODE_STRING, "kIC6" },
215
  [TTYC_KIC7] = { TTYCODE_STRING, "kIC7" },
216
  [TTYC_KICH1] = { TTYCODE_STRING, "kich1" },
217
  [TTYC_KIND] = { TTYCODE_STRING, "kind" },
218
  [TTYC_KLFT2] = { TTYCODE_STRING, "kLFT" },
219
  [TTYC_KLFT3] = { TTYCODE_STRING, "kLFT3" },
220
  [TTYC_KLFT4] = { TTYCODE_STRING, "kLFT4" },
221
  [TTYC_KLFT5] = { TTYCODE_STRING, "kLFT5" },
222
  [TTYC_KLFT6] = { TTYCODE_STRING, "kLFT6" },
223
  [TTYC_KLFT7] = { TTYCODE_STRING, "kLFT7" },
224
  [TTYC_KMOUS] = { TTYCODE_STRING, "kmous" },
225
  [TTYC_KNP] = { TTYCODE_STRING, "knp" },
226
  [TTYC_KNXT2] = { TTYCODE_STRING, "kNXT" },
227
  [TTYC_KNXT3] = { TTYCODE_STRING, "kNXT3" },
228
  [TTYC_KNXT4] = { TTYCODE_STRING, "kNXT4" },
229
  [TTYC_KNXT5] = { TTYCODE_STRING, "kNXT5" },
230
  [TTYC_KNXT6] = { TTYCODE_STRING, "kNXT6" },
231
  [TTYC_KNXT7] = { TTYCODE_STRING, "kNXT7" },
232
  [TTYC_KPP] = { TTYCODE_STRING, "kpp" },
233
  [TTYC_KPRV2] = { TTYCODE_STRING, "kPRV" },
234
  [TTYC_KPRV3] = { TTYCODE_STRING, "kPRV3" },
235
  [TTYC_KPRV4] = { TTYCODE_STRING, "kPRV4" },
236
  [TTYC_KPRV5] = { TTYCODE_STRING, "kPRV5" },
237
  [TTYC_KPRV6] = { TTYCODE_STRING, "kPRV6" },
238
  [TTYC_KPRV7] = { TTYCODE_STRING, "kPRV7" },
239
  [TTYC_KRIT2] = { TTYCODE_STRING, "kRIT" },
240
  [TTYC_KRIT3] = { TTYCODE_STRING, "kRIT3" },
241
  [TTYC_KRIT4] = { TTYCODE_STRING, "kRIT4" },
242
  [TTYC_KRIT5] = { TTYCODE_STRING, "kRIT5" },
243
  [TTYC_KRIT6] = { TTYCODE_STRING, "kRIT6" },
244
  [TTYC_KRIT7] = { TTYCODE_STRING, "kRIT7" },
245
  [TTYC_KRI] = { TTYCODE_STRING, "kri" },
246
  [TTYC_KUP2] = { TTYCODE_STRING, "kUP" }, /* not kUP2 */
247
  [TTYC_KUP3] = { TTYCODE_STRING, "kUP3" },
248
  [TTYC_KUP4] = { TTYCODE_STRING, "kUP4" },
249
  [TTYC_KUP5] = { TTYCODE_STRING, "kUP5" },
250
  [TTYC_KUP6] = { TTYCODE_STRING, "kUP6" },
251
  [TTYC_KUP7] = { TTYCODE_STRING, "kUP7" },
252
  [TTYC_MS] = { TTYCODE_STRING, "Ms" },
253
  [TTYC_NOBR] = { TTYCODE_STRING, "Nobr" },
254
  [TTYC_OL] = { TTYCODE_STRING, "ol" },
255
  [TTYC_OP] = { TTYCODE_STRING, "op" },
256
  [TTYC_RECT] = { TTYCODE_STRING, "Rect" },
257
  [TTYC_REV] = { TTYCODE_STRING, "rev" },
258
  [TTYC_RGB] = { TTYCODE_FLAG, "RGB" },
259
  [TTYC_RIN] = { TTYCODE_STRING, "rin" },
260
  [TTYC_RI] = { TTYCODE_STRING, "ri" },
261
  [TTYC_RMACS] = { TTYCODE_STRING, "rmacs" },
262
  [TTYC_RMCUP] = { TTYCODE_STRING, "rmcup" },
263
  [TTYC_RMKX] = { TTYCODE_STRING, "rmkx" },
264
  [TTYC_SETAB] = { TTYCODE_STRING, "setab" },
265
  [TTYC_SETAF] = { TTYCODE_STRING, "setaf" },
266
  [TTYC_SETAL] = { TTYCODE_STRING, "setal" },
267
  [TTYC_SETRGBB] = { TTYCODE_STRING, "setrgbb" },
268
  [TTYC_SETRGBF] = { TTYCODE_STRING, "setrgbf" },
269
  [TTYC_SETULC] = { TTYCODE_STRING, "Setulc" },
270
  [TTYC_SE] = { TTYCODE_STRING, "Se" },
271
  [TTYC_SXL] =  { TTYCODE_FLAG, "Sxl" },
272
  [TTYC_SGR0] = { TTYCODE_STRING, "sgr0" },
273
  [TTYC_SITM] = { TTYCODE_STRING, "sitm" },
274
  [TTYC_SMACS] = { TTYCODE_STRING, "smacs" },
275
  [TTYC_SMCUP] = { TTYCODE_STRING, "smcup" },
276
  [TTYC_SMKX] = { TTYCODE_STRING, "smkx" },
277
  [TTYC_SMOL] = { TTYCODE_STRING, "Smol" },
278
  [TTYC_SMSO] = { TTYCODE_STRING, "smso" },
279
  [TTYC_SMULX] = { TTYCODE_STRING, "Smulx" },
280
  [TTYC_SMUL] = { TTYCODE_STRING, "smul" },
281
  [TTYC_SMXX] =  { TTYCODE_STRING, "smxx" },
282
  [TTYC_SS] = { TTYCODE_STRING, "Ss" },
283
  [TTYC_SWD] = { TTYCODE_STRING, "Swd" },
284
  [TTYC_SYNC] = { TTYCODE_STRING, "Sync" },
285
  [TTYC_TC] = { TTYCODE_FLAG, "Tc" },
286
  [TTYC_TSL] = { TTYCODE_STRING, "tsl" },
287
  [TTYC_U8] = { TTYCODE_NUMBER, "U8" },
288
  [TTYC_VPA] = { TTYCODE_STRING, "vpa" },
289
  [TTYC_XT] = { TTYCODE_FLAG, "XT" }
290
};
291
292
u_int
293
tty_term_ncodes(void)
294
0
{
295
0
  return (nitems(tty_term_codes));
296
0
}
297
298
static char *
299
tty_term_strip(const char *s)
300
0
{
301
0
  const char     *ptr;
302
0
  static char buf[8192];
303
0
  size_t    len;
304
305
  /* Ignore strings with no padding. */
306
0
  if (strchr(s, '$') == NULL)
307
0
    return (xstrdup(s));
308
309
0
  len = 0;
310
0
  for (ptr = s; *ptr != '\0'; ptr++) {
311
0
    if (*ptr == '$' && *(ptr + 1) == '<') {
312
0
      while (*ptr != '\0' && *ptr != '>')
313
0
        ptr++;
314
0
      if (*ptr == '>')
315
0
        ptr++;
316
0
      if (*ptr == '\0')
317
0
        break;
318
0
    }
319
320
0
    buf[len++] = *ptr;
321
0
    if (len == (sizeof buf) - 1)
322
0
      break;
323
0
  }
324
0
  buf[len] = '\0';
325
326
0
  return (xstrdup(buf));
327
0
}
328
329
static char *
330
tty_term_override_next(const char *s, size_t *offset)
331
0
{
332
0
  static char value[8192];
333
0
  size_t    n = 0, at = *offset;
334
335
0
  if (s[at] == '\0')
336
0
    return (NULL);
337
338
0
  while (s[at] != '\0') {
339
0
    if (s[at] == ':') {
340
0
      if (s[at + 1] == ':') {
341
0
        value[n++] = ':';
342
0
        at += 2;
343
0
      } else
344
0
        break;
345
0
    } else {
346
0
      value[n++] = s[at];
347
0
      at++;
348
0
    }
349
0
    if (n == (sizeof value) - 1)
350
0
      return (NULL);
351
0
  }
352
0
  if (s[at] != '\0')
353
0
    *offset = at + 1;
354
0
  else
355
0
    *offset = at;
356
0
  value[n] = '\0';
357
0
  return (value);
358
0
}
359
360
void
361
tty_term_apply(struct tty_term *term, const char *capabilities, int quiet)
362
0
{
363
0
  const struct tty_term_code_entry  *ent;
364
0
  struct tty_code       *code;
365
0
  size_t                                   offset = 0;
366
0
  char          *cp, *value, *s;
367
0
  const char        *errstr, *name = term->name;
368
0
  u_int          i;
369
0
  int          n, remove;
370
371
0
  while ((s = tty_term_override_next(capabilities, &offset)) != NULL) {
372
0
    if (*s == '\0')
373
0
      continue;
374
0
    value = NULL;
375
376
0
    remove = 0;
377
0
    if ((cp = strchr(s, '=')) != NULL) {
378
0
      *cp++ = '\0';
379
0
      value = xstrdup(cp);
380
0
      if (strunvis(value, cp) == -1) {
381
0
        free(value);
382
0
        value = xstrdup(cp);
383
0
      }
384
0
    } else if (s[strlen(s) - 1] == '@') {
385
0
      s[strlen(s) - 1] = '\0';
386
0
      remove = 1;
387
0
    } else
388
0
      value = xstrdup("");
389
390
0
    if (!quiet) {
391
0
      if (remove)
392
0
        log_debug("%s override: %s@", name, s);
393
0
      else if (*value == '\0')
394
0
        log_debug("%s override: %s", name, s);
395
0
      else
396
0
        log_debug("%s override: %s=%s", name, s, value);
397
0
    }
398
399
0
    for (i = 0; i < tty_term_ncodes(); i++) {
400
0
      ent = &tty_term_codes[i];
401
0
      if (strcmp(s, ent->name) != 0)
402
0
        continue;
403
0
      code = &term->codes[i];
404
405
0
      if (remove) {
406
0
        code->type = TTYCODE_NONE;
407
0
        continue;
408
0
      }
409
0
      switch (ent->type) {
410
0
      case TTYCODE_NONE:
411
0
        break;
412
0
      case TTYCODE_STRING:
413
0
        if (code->type == TTYCODE_STRING)
414
0
          free(code->value.string);
415
0
        code->value.string = xstrdup(value);
416
0
        code->type = ent->type;
417
0
        break;
418
0
      case TTYCODE_NUMBER:
419
0
        n = strtonum(value, 0, INT_MAX, &errstr);
420
0
        if (errstr != NULL)
421
0
          break;
422
0
        code->value.number = n;
423
0
        code->type = ent->type;
424
0
        break;
425
0
      case TTYCODE_FLAG:
426
0
        code->value.flag = 1;
427
0
        code->type = ent->type;
428
0
        break;
429
0
      }
430
0
    }
431
432
0
    free(value);
433
0
  }
434
0
}
435
436
void
437
tty_term_apply_overrides(struct tty_term *term)
438
0
{
439
0
  struct options_entry    *o;
440
0
  struct options_array_item *a;
441
0
  union options_value   *ov;
442
0
  const char      *s, *acs;
443
0
  size_t         offset;
444
0
  char        *first;
445
446
  /* Update capabilities from the option. */
447
0
  o = options_get_only(global_options, "terminal-overrides");
448
0
  a = options_array_first(o);
449
0
  while (a != NULL) {
450
0
    ov = options_array_item_value(a);
451
0
    s = ov->string;
452
453
0
    offset = 0;
454
0
    first = tty_term_override_next(s, &offset);
455
0
    if (first != NULL && fnmatch(first, term->name, 0) == 0)
456
0
      tty_term_apply(term, s + offset, 0);
457
0
    a = options_array_next(a);
458
0
  }
459
460
  /* Log the SIXEL flag. */
461
0
  log_debug("SIXEL flag is %d", !!(term->flags & TERM_SIXEL));
462
463
  /* Update the RGB flag if the terminal has RGB colours. */
464
0
  if (tty_term_has(term, TTYC_SETRGBF) &&
465
0
      tty_term_has(term, TTYC_SETRGBB))
466
0
    term->flags |= TERM_RGBCOLOURS;
467
0
  else
468
0
    term->flags &= ~TERM_RGBCOLOURS;
469
0
  log_debug("RGBCOLOURS flag is %d", !!(term->flags & TERM_RGBCOLOURS));
470
471
  /*
472
   * Set or clear the DECSLRM flag if the terminal has the margin
473
   * capabilities.
474
   */
475
0
  if (tty_term_has(term, TTYC_CMG) && tty_term_has(term, TTYC_CLMG))
476
0
    term->flags |= TERM_DECSLRM;
477
0
  else
478
0
    term->flags &= ~TERM_DECSLRM;
479
0
  log_debug("DECSLRM flag is %d", !!(term->flags & TERM_DECSLRM));
480
481
  /*
482
   * Set or clear the DECFRA flag if the terminal has the rectangle
483
   * capability.
484
   */
485
0
  if (tty_term_has(term, TTYC_RECT))
486
0
    term->flags |= TERM_DECFRA;
487
0
  else
488
0
    term->flags &= ~TERM_DECFRA;
489
0
  log_debug("DECFRA flag is %d", !!(term->flags & TERM_DECFRA));
490
491
  /*
492
   * Terminals without am (auto right margin) wrap at at $COLUMNS - 1
493
   * rather than $COLUMNS (the cursor can never be beyond $COLUMNS - 1).
494
   *
495
   * Terminals without xenl (eat newline glitch) ignore a newline beyond
496
   * the right edge of the terminal, but tmux doesn't care about this -
497
   * it always uses absolute only moves the cursor with a newline when
498
   * also sending a linefeed.
499
   *
500
   * This is irritating, most notably because it is painful to write to
501
   * the very bottom-right of the screen without scrolling.
502
   *
503
   * Flag the terminal here and apply some workarounds in other places to
504
   * do the best possible.
505
   */
506
0
  if (!tty_term_flag(term, TTYC_AM))
507
0
    term->flags |= TERM_NOAM;
508
0
  else
509
0
    term->flags &= ~TERM_NOAM;
510
0
  log_debug("NOAM flag is %d", !!(term->flags & TERM_NOAM));
511
512
  /* Generate ACS table. If none is present, use nearest ASCII. */
513
0
  memset(term->acs, 0, sizeof term->acs);
514
0
  if (tty_term_has(term, TTYC_ACSC))
515
0
    acs = tty_term_string(term, TTYC_ACSC);
516
0
  else
517
0
    acs = "a#j+k+l+m+n+o-p-q-r-s-t+u+v+w+x|y<z>~.";
518
0
  for (; acs[0] != '\0' && acs[1] != '\0'; acs += 2)
519
0
    term->acs[(u_char) acs[0]][0] = acs[1];
520
0
}
521
522
struct tty_term *
523
tty_term_create(struct tty *tty, char *name, char **caps, u_int ncaps,
524
    int *feat, char **cause)
525
0
{
526
0
  struct tty_term       *term;
527
0
  const struct tty_term_code_entry  *ent;
528
0
  struct tty_code       *code;
529
0
  struct options_entry      *o;
530
0
  struct options_array_item   *a;
531
0
  union options_value     *ov;
532
0
  u_int          i, j;
533
0
  const char        *s, *value;
534
0
  size_t           offset, namelen;
535
0
  char          *first;
536
537
0
  log_debug("adding term %s", name);
538
539
0
  term = xcalloc(1, sizeof *term);
540
0
  term->tty = tty;
541
0
  term->name = xstrdup(name);
542
0
  term->codes = xcalloc(tty_term_ncodes(), sizeof *term->codes);
543
0
  LIST_INSERT_HEAD(&tty_terms, term, entry);
544
545
  /* Fill in codes. */
546
0
  for (i = 0; i < ncaps; i++) {
547
0
    namelen = strcspn(caps[i], "=");
548
0
    if (namelen == 0)
549
0
      continue;
550
0
    value = caps[i] + namelen + 1;
551
552
0
    for (j = 0; j < tty_term_ncodes(); j++) {
553
0
      ent = &tty_term_codes[j];
554
0
      if (strncmp(ent->name, caps[i], namelen) != 0)
555
0
        continue;
556
0
      if (ent->name[namelen] != '\0')
557
0
        continue;
558
559
0
      code = &term->codes[j];
560
0
      code->type = TTYCODE_NONE;
561
0
      switch (ent->type) {
562
0
      case TTYCODE_NONE:
563
0
        break;
564
0
      case TTYCODE_STRING:
565
0
        code->type = TTYCODE_STRING;
566
0
        code->value.string = tty_term_strip(value);
567
0
        break;
568
0
      case TTYCODE_NUMBER:
569
0
        code->type = TTYCODE_NUMBER;
570
0
        code->value.number = atoi(value);
571
0
        break;
572
0
      case TTYCODE_FLAG:
573
0
        code->type = TTYCODE_FLAG;
574
0
        code->value.flag = (*value == '1');
575
0
        break;
576
0
      }
577
0
    }
578
0
  }
579
580
  /* Apply terminal features. */
581
0
  o = options_get_only(global_options, "terminal-features");
582
0
  a = options_array_first(o);
583
0
  while (a != NULL) {
584
0
    ov = options_array_item_value(a);
585
0
    s = ov->string;
586
587
0
    offset = 0;
588
0
    first = tty_term_override_next(s, &offset);
589
0
    if (first != NULL && fnmatch(first, term->name, 0) == 0)
590
0
      tty_add_features(feat, s + offset, ":");
591
0
    a = options_array_next(a);
592
0
  }
593
594
  /* Delete curses data. */
595
0
#if !defined(NCURSES_VERSION_MAJOR) || NCURSES_VERSION_MAJOR > 5 || \
596
0
    (NCURSES_VERSION_MAJOR == 5 && NCURSES_VERSION_MINOR > 6)
597
0
  del_curterm(cur_term);
598
0
#endif
599
600
  /* Apply overrides so any capabilities used for features are changed. */
601
0
  tty_term_apply_overrides(term);
602
603
  /* These are always required. */
604
0
  if (!tty_term_has(term, TTYC_CLEAR)) {
605
0
    xasprintf(cause, "terminal does not support clear");
606
0
    goto error;
607
0
  }
608
0
  if (!tty_term_has(term, TTYC_CUP)) {
609
0
    xasprintf(cause, "terminal does not support cup");
610
0
    goto error;
611
0
  }
612
613
  /*
614
   * If TERM has XT or clear starts with CSI then it is safe to assume
615
   * the terminal is derived from the VT100. This controls whether device
616
   * attributes requests are sent to get more information.
617
   *
618
   * This is a bit of a hack but there aren't that many alternatives.
619
   * Worst case tmux will just fall back to using whatever terminfo(5)
620
   * says without trying to correct anything that is missing.
621
   *
622
   * Also add few features that VT100-like terminals should either
623
   * support or safely ignore.
624
   */
625
0
  s = tty_term_string(term, TTYC_CLEAR);
626
0
  if (tty_term_flag(term, TTYC_XT) || strncmp(s, "\033[", 2) == 0) {
627
0
    term->flags |= TERM_VT100LIKE;
628
0
    tty_add_features(feat, "bpaste,focus,title", ",");
629
0
  }
630
631
  /* Add RGB feature if terminal has RGB colours. */
632
0
  if ((tty_term_flag(term, TTYC_TC) || tty_term_has(term, TTYC_RGB)) &&
633
0
      (!tty_term_has(term, TTYC_SETRGBF) ||
634
0
      !tty_term_has(term, TTYC_SETRGBB)))
635
0
    tty_add_features(feat, "RGB", ",");
636
637
  /* Apply the features and overrides again. */
638
0
  if (tty_apply_features(term, *feat))
639
0
    tty_term_apply_overrides(term);
640
641
  /* Log the capabilities. */
642
0
  for (i = 0; i < tty_term_ncodes(); i++)
643
0
    log_debug("%s%s", name, tty_term_describe(term, i));
644
645
0
  return (term);
646
647
0
error:
648
0
  tty_term_free(term);
649
0
  return (NULL);
650
0
}
651
652
void
653
tty_term_free(struct tty_term *term)
654
0
{
655
0
  u_int i;
656
657
0
  log_debug("removing term %s", term->name);
658
659
0
  for (i = 0; i < tty_term_ncodes(); i++) {
660
0
    if (term->codes[i].type == TTYCODE_STRING)
661
0
      free(term->codes[i].value.string);
662
0
  }
663
0
  free(term->codes);
664
665
0
  LIST_REMOVE(term, entry);
666
0
  free(term->name);
667
0
  free(term);
668
0
}
669
670
int
671
tty_term_read_list(const char *name, int fd, char ***caps, u_int *ncaps,
672
    char **cause)
673
0
{
674
0
  const struct tty_term_code_entry  *ent;
675
0
  int          error, n;
676
0
  u_int          i;
677
0
  const char        *s;
678
0
  char           tmp[11];
679
680
0
  if (setupterm((char *)name, fd, &error) != OK) {
681
0
    switch (error) {
682
0
    case 1:
683
0
      xasprintf(cause, "can't use hardcopy terminal: %s",
684
0
          name);
685
0
      break;
686
0
    case 0:
687
0
      xasprintf(cause, "missing or unsuitable terminal: %s",
688
0
          name);
689
0
      break;
690
0
    case -1:
691
0
      xasprintf(cause, "can't find terminfo database");
692
0
      break;
693
0
    default:
694
0
      xasprintf(cause, "unknown error");
695
0
      break;
696
0
    }
697
0
    return (-1);
698
0
  }
699
700
0
  *ncaps = 0;
701
0
  *caps = NULL;
702
703
0
  for (i = 0; i < tty_term_ncodes(); i++) {
704
0
    ent = &tty_term_codes[i];
705
0
    switch (ent->type) {
706
0
    case TTYCODE_NONE:
707
0
      continue;
708
0
    case TTYCODE_STRING:
709
0
      s = tigetstr((char *)ent->name);
710
0
      if (s == NULL || s == (char *)-1)
711
0
        continue;
712
0
      break;
713
0
    case TTYCODE_NUMBER:
714
0
      n = tigetnum((char *)ent->name);
715
0
      if (n == -1 || n == -2)
716
0
        continue;
717
0
      xsnprintf(tmp, sizeof tmp, "%d", n);
718
0
      s = tmp;
719
0
      break;
720
0
    case TTYCODE_FLAG:
721
0
      n = tigetflag((char *) ent->name);
722
0
      if (n == -1)
723
0
        continue;
724
0
      if (n)
725
0
        s = "1";
726
0
      else
727
0
        s = "0";
728
0
      break;
729
0
    }
730
0
    *caps = xreallocarray(*caps, (*ncaps) + 1, sizeof **caps);
731
0
    xasprintf(&(*caps)[*ncaps], "%s=%s", ent->name, s);
732
0
    (*ncaps)++;
733
0
  }
734
735
0
#if !defined(NCURSES_VERSION_MAJOR) || NCURSES_VERSION_MAJOR > 5 || \
736
0
    (NCURSES_VERSION_MAJOR == 5 && NCURSES_VERSION_MINOR > 6)
737
0
  del_curterm(cur_term);
738
0
#endif
739
0
  return (0);
740
0
}
741
742
void
743
tty_term_free_list(char **caps, u_int ncaps)
744
0
{
745
0
  u_int i;
746
747
0
  for (i = 0; i < ncaps; i++)
748
0
    free(caps[i]);
749
0
  free(caps);
750
0
}
751
752
int
753
tty_term_has(struct tty_term *term, enum tty_code_code code)
754
0
{
755
0
  return (term->codes[code].type != TTYCODE_NONE);
756
0
}
757
758
const char *
759
tty_term_string(struct tty_term *term, enum tty_code_code code)
760
0
{
761
0
  if (!tty_term_has(term, code))
762
0
    return ("");
763
0
  if (term->codes[code].type != TTYCODE_STRING)
764
0
    fatalx("not a string: %d", code);
765
0
  return (term->codes[code].value.string);
766
0
}
767
768
const char *
769
tty_term_string_i(struct tty_term *term, enum tty_code_code code, int a)
770
0
{
771
0
  const char  *x = tty_term_string(term, code), *s;
772
773
#if defined(HAVE_TIPARM_S)
774
  s = tiparm_s(1, 0, x, a);
775
#elif defined(HAVE_TIPARM)
776
0
  s = tiparm(x, a);
777
#else
778
  s = tparm((char *)x, a, 0, 0, 0, 0, 0, 0, 0, 0);
779
#endif
780
0
  if (s == NULL) {
781
0
    log_debug("could not expand %s", tty_term_codes[code].name);
782
0
    return ("");
783
0
  }
784
0
  return (s);
785
0
}
786
787
const char *
788
tty_term_string_ii(struct tty_term *term, enum tty_code_code code, int a, int b)
789
0
{
790
0
  const char  *x = tty_term_string(term, code), *s;
791
792
#if defined(HAVE_TIPARM_S)
793
  s = tiparm_s(2, 0, x, a, b);
794
#elif defined(HAVE_TIPARM)
795
0
  s = tiparm(x, a, b);
796
#else
797
  s = tparm((char *)x, a, b, 0, 0, 0, 0, 0, 0, 0);
798
#endif
799
0
  if (s == NULL) {
800
0
    log_debug("could not expand %s", tty_term_codes[code].name);
801
0
    return ("");
802
0
  }
803
0
  return (s);
804
0
}
805
806
const char *
807
tty_term_string_iii(struct tty_term *term, enum tty_code_code code, int a,
808
    int b, int c)
809
0
{
810
0
  const char  *x = tty_term_string(term, code), *s;
811
812
#if defined(HAVE_TIPARM_S)
813
  s = tiparm_s(3, 0, x, a, b, c);
814
#elif defined(HAVE_TIPARM)
815
0
  s = tiparm(x, a, b, c);
816
#else
817
  s = tparm((char *)x, a, b, c, 0, 0, 0, 0, 0, 0);
818
#endif
819
0
  if (s == NULL) {
820
0
    log_debug("could not expand %s", tty_term_codes[code].name);
821
0
    return ("");
822
0
  }
823
0
  return (s);
824
0
}
825
826
const char *
827
tty_term_string_s(struct tty_term *term, enum tty_code_code code, const char *a)
828
0
{
829
0
  const char  *x = tty_term_string(term, code), *s;
830
831
#if defined(HAVE_TIPARM_S)
832
  s = tiparm_s(1, 1, x, a);
833
#elif defined(HAVE_TIPARM)
834
0
  s = tiparm(x, a);
835
#else
836
  s = tparm((char *)x, (long)a, 0, 0, 0, 0, 0, 0, 0, 0);
837
#endif
838
0
  if (s == NULL) {
839
0
    log_debug("could not expand %s", tty_term_codes[code].name);
840
0
    return ("");
841
0
  }
842
0
  return (s);
843
0
}
844
845
const char *
846
tty_term_string_ss(struct tty_term *term, enum tty_code_code code,
847
    const char *a, const char *b)
848
0
{
849
0
  const char  *x = tty_term_string(term, code), *s;
850
851
#if defined(HAVE_TIPARM_S)
852
  s = tiparm_s(2, 3, x, a, b);
853
#elif defined(HAVE_TIPARM)
854
0
  s = tiparm(x, a, b);
855
#else
856
  s = tparm((char *)x, (long)a, (long)b, 0, 0, 0, 0, 0, 0, 0);
857
#endif
858
0
  if (s == NULL) {
859
0
    log_debug("could not expand %s", tty_term_codes[code].name);
860
0
    return ("");
861
0
  }
862
0
  return (s);
863
0
}
864
865
int
866
tty_term_number(struct tty_term *term, enum tty_code_code code)
867
0
{
868
0
  if (!tty_term_has(term, code))
869
0
    return (0);
870
0
  if (term->codes[code].type != TTYCODE_NUMBER)
871
0
    fatalx("not a number: %d", code);
872
0
  return (term->codes[code].value.number);
873
0
}
874
875
int
876
tty_term_flag(struct tty_term *term, enum tty_code_code code)
877
0
{
878
0
  if (!tty_term_has(term, code))
879
0
    return (0);
880
0
  if (term->codes[code].type != TTYCODE_FLAG)
881
0
    fatalx("not a flag: %d", code);
882
0
  return (term->codes[code].value.flag);
883
0
}
884
885
const char *
886
tty_term_describe(struct tty_term *term, enum tty_code_code code)
887
0
{
888
0
  static char  s[256];
889
0
  char     out[128];
890
891
0
  switch (term->codes[code].type) {
892
0
  case TTYCODE_NONE:
893
0
    xsnprintf(s, sizeof s, "%4u: %s: [missing]",
894
0
        code, tty_term_codes[code].name);
895
0
    break;
896
0
  case TTYCODE_STRING:
897
0
    strnvis(out, term->codes[code].value.string, sizeof out,
898
0
        VIS_OCTAL|VIS_CSTYLE|VIS_TAB|VIS_NL);
899
0
    xsnprintf(s, sizeof s, "%4u: %s: (string) %s",
900
0
        code, tty_term_codes[code].name,
901
0
        out);
902
0
    break;
903
0
  case TTYCODE_NUMBER:
904
0
    xsnprintf(s, sizeof s, "%4u: %s: (number) %d",
905
0
        code, tty_term_codes[code].name,
906
0
        term->codes[code].value.number);
907
0
    break;
908
0
  case TTYCODE_FLAG:
909
0
    xsnprintf(s, sizeof s, "%4u: %s: (flag) %s",
910
0
        code, tty_term_codes[code].name,
911
0
        term->codes[code].value.flag ? "true" : "false");
912
0
    break;
913
0
  }
914
0
  return (s);
915
0
}