Annotation of src/usr.bin/tmux/tty-features.c, Revision 1.21
1.21 ! nicm 1: /* $OpenBSD: tty-features.c,v 1.20 2021/06/10 07:59:08 nicm Exp $ */
1.1 nicm 2:
3: /*
4: * Copyright (c) 2020 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: #include <stdlib.h>
22: #include <string.h>
23:
24: #include "tmux.h"
25:
26: /*
27: * Still hardcoded:
28: * - default colours (under AX or op capabilities);
29: * - AIX colours (under colors >= 16);
1.13 nicm 30: * - alternate escape (if terminal is VT100-like).
1.1 nicm 31: *
32: * Also:
1.7 nicm 33: * - DECFRA uses a flag instead of capabilities;
1.1 nicm 34: * - UTF-8 is a separate flag on the client; needed for unattached clients.
35: */
36:
37: /* A named terminal feature. */
38: struct tty_feature {
39: const char *name;
40: const char **capabilities;
41: int flags;
42: };
43:
44: /* Terminal has xterm(1) title setting. */
45: static const char *tty_feature_title_capabilities[] = {
46: "tsl=\\E]0;", /* should be using TS really */
47: "fsl=\\a",
48: NULL
49: };
1.12 nicm 50: static const struct tty_feature tty_feature_title = {
1.1 nicm 51: "title",
52: tty_feature_title_capabilities,
53: 0
54: };
55:
1.20 nicm 56: /* Terminal has mouse support. */
57: static const char *tty_feature_mouse_capabilities[] = {
58: "kmous=\\E[M",
59: NULL
60: };
61: static const struct tty_feature tty_feature_mouse = {
62: "mouse",
63: tty_feature_mouse_capabilities,
64: 0
65: };
66:
1.1 nicm 67: /* Terminal can set the clipboard with OSC 52. */
68: static const char *tty_feature_clipboard_capabilities[] = {
69: "Ms=\\E]52;%p1%s;%p2%s\\a",
70: NULL
71: };
1.12 nicm 72: static const struct tty_feature tty_feature_clipboard = {
1.1 nicm 73: "clipboard",
74: tty_feature_clipboard_capabilities,
75: 0
76: };
77:
78: /*
79: * Terminal supports RGB colour. This replaces setab and setaf also since
80: * terminals with RGB have versions that do not allow setting colours from the
81: * 256 palette.
82: */
83: static const char *tty_feature_rgb_capabilities[] = {
1.4 nicm 84: "AX",
1.1 nicm 85: "setrgbf=\\E[38;2;%p1%d;%p2%d;%p3%dm",
86: "setrgbb=\\E[48;2;%p1%d;%p2%d;%p3%dm",
87: "setab=\\E[%?%p1%{8}%<%t4%p1%d%e%p1%{16}%<%t10%p1%{8}%-%d%e48;5;%p1%d%;m",
88: "setaf=\\E[%?%p1%{8}%<%t3%p1%d%e%p1%{16}%<%t9%p1%{8}%-%d%e38;5;%p1%d%;m",
89: NULL
90: };
1.12 nicm 91: static const struct tty_feature tty_feature_rgb = {
1.1 nicm 92: "RGB",
93: tty_feature_rgb_capabilities,
1.7 nicm 94: TERM_256COLOURS|TERM_RGBCOLOURS
1.1 nicm 95: };
96:
97: /* Terminal supports 256 colours. */
98: static const char *tty_feature_256_capabilities[] = {
1.4 nicm 99: "AX",
1.1 nicm 100: "setab=\\E[%?%p1%{8}%<%t4%p1%d%e%p1%{16}%<%t10%p1%{8}%-%d%e48;5;%p1%d%;m",
101: "setaf=\\E[%?%p1%{8}%<%t3%p1%d%e%p1%{16}%<%t9%p1%{8}%-%d%e38;5;%p1%d%;m",
102: NULL
103: };
1.12 nicm 104: static const struct tty_feature tty_feature_256 = {
1.1 nicm 105: "256",
106: tty_feature_256_capabilities,
107: TERM_256COLOURS
108: };
109:
110: /* Terminal supports overline. */
111: static const char *tty_feature_overline_capabilities[] = {
112: "Smol=\\E[53m",
113: NULL
114: };
1.12 nicm 115: static const struct tty_feature tty_feature_overline = {
1.1 nicm 116: "overline",
117: tty_feature_overline_capabilities,
118: 0
119: };
120:
121: /* Terminal supports underscore styles. */
122: static const char *tty_feature_usstyle_capabilities[] = {
1.17 daniel 123: "Smulx=\\E[4::%p1%dm",
124: "Setulc=\\E[58::2::%p1%{65536}%/%d::%p1%{256}%/%{255}%&%d::%p1%{255}%&%d%;m",
1.18 nicm 125: "ol=\\E[59m",
1.1 nicm 126: NULL
127: };
1.12 nicm 128: static const struct tty_feature tty_feature_usstyle = {
1.1 nicm 129: "usstyle",
130: tty_feature_usstyle_capabilities,
131: 0
132: };
133:
1.12 nicm 134: /* Terminal supports bracketed paste. */
1.11 nicm 135: static const char *tty_feature_bpaste_capabilities[] = {
1.12 nicm 136: "Enbp=\\E[?2004h",
1.11 nicm 137: "Dsbp=\\E[?2004l",
138: NULL
139: };
1.12 nicm 140: static const struct tty_feature tty_feature_bpaste = {
1.11 nicm 141: "bpaste",
142: tty_feature_bpaste_capabilities,
143: 0
144: };
145:
1.12 nicm 146: /* Terminal supports focus reporting. */
147: static const char *tty_feature_focus_capabilities[] = {
148: "Enfcs=\\E[?1004h",
149: "Dsfcs=\\E[?1004l",
150: NULL
151: };
152: static const struct tty_feature tty_feature_focus = {
153: "focus",
154: tty_feature_focus_capabilities,
155: 0
156: };
157:
1.1 nicm 158: /* Terminal supports cursor styles. */
159: static const char *tty_feature_cstyle_capabilities[] = {
160: "Ss=\\E[%p1%d q",
161: "Se=\\E[2 q",
162: NULL
163: };
1.12 nicm 164: static const struct tty_feature tty_feature_cstyle = {
1.1 nicm 165: "cstyle",
166: tty_feature_cstyle_capabilities,
167: 0
168: };
169:
170: /* Terminal supports cursor colours. */
171: static const char *tty_feature_ccolour_capabilities[] = {
172: "Cs=\\E]12;%p1%s\\a",
173: "Cr=\\E]112\\a",
174: NULL
175: };
1.12 nicm 176: static const struct tty_feature tty_feature_ccolour = {
1.1 nicm 177: "ccolour",
178: tty_feature_ccolour_capabilities,
179: 0
180: };
181:
1.10 nicm 182: /* Terminal supports strikethrough. */
183: static const char *tty_feature_strikethrough_capabilities[] = {
184: "smxx=\\E[9m",
185: NULL
186: };
1.12 nicm 187: static const struct tty_feature tty_feature_strikethrough = {
1.10 nicm 188: "strikethrough",
189: tty_feature_strikethrough_capabilities,
190: 0
191: };
192:
1.1 nicm 193: /* Terminal supports synchronized updates. */
194: static const char *tty_feature_sync_capabilities[] = {
1.2 nicm 195: "Sync=\\EP=%p1%ds\\E\\\\",
1.1 nicm 196: NULL
197: };
1.12 nicm 198: static const struct tty_feature tty_feature_sync = {
1.1 nicm 199: "sync",
200: tty_feature_sync_capabilities,
201: 0
202: };
203:
1.14 nicm 204: /* Terminal supports extended keys. */
205: static const char *tty_feature_extkeys_capabilities[] = {
206: "Eneks=\\E[>4;1m",
207: "Dseks=\\E[>4m",
208: NULL
209: };
210: static const struct tty_feature tty_feature_extkeys = {
211: "extkeys",
212: tty_feature_extkeys_capabilities,
213: 0
214: };
215:
1.1 nicm 216: /* Terminal supports DECSLRM margins. */
1.7 nicm 217: static const char *tty_feature_margins_capabilities[] = {
218: "Enmg=\\E[?69h",
219: "Dsmg=\\E[?69l",
220: "Clmg=\\E[s",
221: "Cmg=\\E[%i%p1%d;%p2%ds",
222: NULL
223: };
1.12 nicm 224: static const struct tty_feature tty_feature_margins = {
1.1 nicm 225: "margins",
1.7 nicm 226: tty_feature_margins_capabilities,
1.1 nicm 227: TERM_DECSLRM
228: };
229:
230: /* Terminal supports DECFRA rectangle fill. */
1.19 nicm 231: static const char *tty_feature_rectfill_capabilities[] = {
232: "Rect",
233: NULL
234: };
1.12 nicm 235: static const struct tty_feature tty_feature_rectfill = {
1.1 nicm 236: "rectfill",
1.19 nicm 237: tty_feature_rectfill_capabilities,
1.1 nicm 238: TERM_DECFRA
239: };
240:
241: /* Available terminal features. */
242: static const struct tty_feature *tty_features[] = {
243: &tty_feature_256,
1.11 nicm 244: &tty_feature_bpaste,
1.12 nicm 245: &tty_feature_ccolour,
1.1 nicm 246: &tty_feature_clipboard,
247: &tty_feature_cstyle,
1.14 nicm 248: &tty_feature_extkeys,
1.12 nicm 249: &tty_feature_focus,
1.1 nicm 250: &tty_feature_margins,
1.20 nicm 251: &tty_feature_mouse,
1.1 nicm 252: &tty_feature_overline,
253: &tty_feature_rectfill,
254: &tty_feature_rgb,
1.10 nicm 255: &tty_feature_strikethrough,
1.1 nicm 256: &tty_feature_sync,
257: &tty_feature_title,
258: &tty_feature_usstyle
259: };
260:
261: void
262: tty_add_features(int *feat, const char *s, const char *separators)
263: {
264: const struct tty_feature *tf;
265: char *next, *loop, *copy;
266: u_int i;
1.7 nicm 267:
1.9 nicm 268: log_debug("adding terminal features %s", s);
1.1 nicm 269:
270: loop = copy = xstrdup(s);
271: while ((next = strsep(&loop, separators)) != NULL) {
272: for (i = 0; i < nitems(tty_features); i++) {
273: tf = tty_features[i];
274: if (strcasecmp(tf->name, next) == 0)
275: break;
276: }
277: if (i == nitems(tty_features)) {
278: log_debug("unknown terminal feature: %s", next);
279: break;
280: }
281: if (~(*feat) & (1 << i)) {
282: log_debug("adding terminal feature: %s", tf->name);
283: (*feat) |= (1 << i);
284: }
285: }
286: free(copy);
287: }
288:
289: const char *
290: tty_get_features(int feat)
291: {
292: const struct tty_feature *tf;
293: static char s[512];
294: u_int i;
295:
296: *s = '\0';
297: for (i = 0; i < nitems(tty_features); i++) {
298: if (~feat & (1 << i))
299: continue;
300: tf = tty_features[i];
301:
302: strlcat(s, tf->name, sizeof s);
303: strlcat(s, ",", sizeof s);
304: }
305: if (*s != '\0')
306: s[strlen(s) - 1] = '\0';
307: return (s);
308: }
309:
1.3 nicm 310: int
1.1 nicm 311: tty_apply_features(struct tty_term *term, int feat)
312: {
313: const struct tty_feature *tf;
314: const char **capability;
315: u_int i;
316:
317: if (feat == 0)
1.3 nicm 318: return (0);
1.1 nicm 319: log_debug("applying terminal features: %s", tty_get_features(feat));
320:
321: for (i = 0; i < nitems(tty_features); i++) {
322: if ((term->features & (1 << i)) || (~feat & (1 << i)))
323: continue;
324: tf = tty_features[i];
325:
326: log_debug("applying terminal feature: %s", tf->name);
327: if (tf->capabilities != NULL) {
328: capability = tf->capabilities;
329: while (*capability != NULL) {
330: log_debug("adding capability: %s", *capability);
331: tty_term_apply(term, *capability, 1);
332: capability++;
333: }
334: }
335: term->flags |= tf->flags;
336: }
1.3 nicm 337: if ((term->features | feat) == term->features)
338: return (0);
1.1 nicm 339: term->features |= feat;
1.3 nicm 340: return (1);
1.9 nicm 341: }
342:
343: void
344: tty_default_features(int *feat, const char *name, u_int version)
345: {
346: static struct {
347: const char *name;
348: u_int version;
349: const char *features;
350: } table[] = {
1.16 nicm 351: #define TTY_FEATURES_BASE_MODERN_XTERM \
1.20 nicm 352: "256,RGB,bpaste,clipboard,mouse,strikethrough,title"
1.9 nicm 353: { .name = "mintty",
1.16 nicm 354: .features = TTY_FEATURES_BASE_MODERN_XTERM
1.18 nicm 355: ",ccolour,cstyle,extkeys,margins,overline,usstyle"
1.9 nicm 356: },
357: { .name = "tmux",
1.16 nicm 358: .features = TTY_FEATURES_BASE_MODERN_XTERM
359: ",ccolour,cstyle,focus,overline,usstyle"
1.9 nicm 360: },
361: { .name = "rxvt-unicode",
1.20 nicm 362: .features = "256,bpaste,ccolour,cstyle,mouse,title"
1.9 nicm 363: },
364: { .name = "iTerm2",
1.16 nicm 365: .features = TTY_FEATURES_BASE_MODERN_XTERM
1.21 ! nicm 366: ",cstyle,extkeys,margins,usstyle,sync"
1.9 nicm 367: },
368: { .name = "XTerm",
1.19 nicm 369: /*
370: * xterm also supports DECSLRM and DECFRA, but they can be
371: * disabled so not set it here - they will be added if
372: * secondary DA shows VT420.
373: */
1.16 nicm 374: .features = TTY_FEATURES_BASE_MODERN_XTERM
1.19 nicm 375: ",ccolour,cstyle,extkeys,focus"
1.9 nicm 376: }
377: };
378: u_int i;
379:
380: for (i = 0; i < nitems(table); i++) {
381: if (strcmp(table[i].name, name) != 0)
382: continue;
383: if (version != 0 && version < table[i].version)
384: continue;
385: tty_add_features(feat, table[i].features, ",");
386: }
1.1 nicm 387: }
![[BACK]](/icons/back.gif){kind=icon}
Return to tty-features.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / tmux