Annotation of src/usr.bin/tmux/tty-features.c, Revision 1.24
1.24 ! nicm 1: /* $OpenBSD: tty-features.c,v 1.23 2022/05/30 12:57:31 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.22 nicm 56: /* Terminal has OSC 7 working directory. */
57: static const char *tty_feature_osc7_capabilities[] = {
58: "Swd=\\E]7;",
59: "fsl=\\a",
60: NULL
61: };
62: static const struct tty_feature tty_feature_osc7 = {
63: "osc7",
64: tty_feature_osc7_capabilities,
65: 0
66: };
67:
1.20 nicm 68: /* Terminal has mouse support. */
69: static const char *tty_feature_mouse_capabilities[] = {
70: "kmous=\\E[M",
71: NULL
72: };
73: static const struct tty_feature tty_feature_mouse = {
74: "mouse",
75: tty_feature_mouse_capabilities,
76: 0
77: };
78:
1.1 nicm 79: /* Terminal can set the clipboard with OSC 52. */
80: static const char *tty_feature_clipboard_capabilities[] = {
81: "Ms=\\E]52;%p1%s;%p2%s\\a",
82: NULL
83: };
1.12 nicm 84: static const struct tty_feature tty_feature_clipboard = {
1.1 nicm 85: "clipboard",
86: tty_feature_clipboard_capabilities,
87: 0
88: };
89:
90: /*
91: * Terminal supports RGB colour. This replaces setab and setaf also since
92: * terminals with RGB have versions that do not allow setting colours from the
93: * 256 palette.
94: */
95: static const char *tty_feature_rgb_capabilities[] = {
1.4 nicm 96: "AX",
1.1 nicm 97: "setrgbf=\\E[38;2;%p1%d;%p2%d;%p3%dm",
98: "setrgbb=\\E[48;2;%p1%d;%p2%d;%p3%dm",
99: "setab=\\E[%?%p1%{8}%<%t4%p1%d%e%p1%{16}%<%t10%p1%{8}%-%d%e48;5;%p1%d%;m",
100: "setaf=\\E[%?%p1%{8}%<%t3%p1%d%e%p1%{16}%<%t9%p1%{8}%-%d%e38;5;%p1%d%;m",
101: NULL
102: };
1.12 nicm 103: static const struct tty_feature tty_feature_rgb = {
1.1 nicm 104: "RGB",
105: tty_feature_rgb_capabilities,
1.7 nicm 106: TERM_256COLOURS|TERM_RGBCOLOURS
1.1 nicm 107: };
108:
109: /* Terminal supports 256 colours. */
110: static const char *tty_feature_256_capabilities[] = {
1.4 nicm 111: "AX",
1.1 nicm 112: "setab=\\E[%?%p1%{8}%<%t4%p1%d%e%p1%{16}%<%t10%p1%{8}%-%d%e48;5;%p1%d%;m",
113: "setaf=\\E[%?%p1%{8}%<%t3%p1%d%e%p1%{16}%<%t9%p1%{8}%-%d%e38;5;%p1%d%;m",
114: NULL
115: };
1.12 nicm 116: static const struct tty_feature tty_feature_256 = {
1.1 nicm 117: "256",
118: tty_feature_256_capabilities,
119: TERM_256COLOURS
120: };
121:
122: /* Terminal supports overline. */
123: static const char *tty_feature_overline_capabilities[] = {
124: "Smol=\\E[53m",
125: NULL
126: };
1.12 nicm 127: static const struct tty_feature tty_feature_overline = {
1.1 nicm 128: "overline",
129: tty_feature_overline_capabilities,
130: 0
131: };
132:
133: /* Terminal supports underscore styles. */
134: static const char *tty_feature_usstyle_capabilities[] = {
1.17 daniel 135: "Smulx=\\E[4::%p1%dm",
136: "Setulc=\\E[58::2::%p1%{65536}%/%d::%p1%{256}%/%{255}%&%d::%p1%{255}%&%d%;m",
1.18 nicm 137: "ol=\\E[59m",
1.1 nicm 138: NULL
139: };
1.12 nicm 140: static const struct tty_feature tty_feature_usstyle = {
1.1 nicm 141: "usstyle",
142: tty_feature_usstyle_capabilities,
143: 0
144: };
145:
1.12 nicm 146: /* Terminal supports bracketed paste. */
1.11 nicm 147: static const char *tty_feature_bpaste_capabilities[] = {
1.12 nicm 148: "Enbp=\\E[?2004h",
1.11 nicm 149: "Dsbp=\\E[?2004l",
150: NULL
151: };
1.12 nicm 152: static const struct tty_feature tty_feature_bpaste = {
1.11 nicm 153: "bpaste",
154: tty_feature_bpaste_capabilities,
155: 0
156: };
157:
1.12 nicm 158: /* Terminal supports focus reporting. */
159: static const char *tty_feature_focus_capabilities[] = {
160: "Enfcs=\\E[?1004h",
161: "Dsfcs=\\E[?1004l",
162: NULL
163: };
164: static const struct tty_feature tty_feature_focus = {
165: "focus",
166: tty_feature_focus_capabilities,
167: 0
168: };
169:
1.1 nicm 170: /* Terminal supports cursor styles. */
171: static const char *tty_feature_cstyle_capabilities[] = {
172: "Ss=\\E[%p1%d q",
173: "Se=\\E[2 q",
174: NULL
175: };
1.12 nicm 176: static const struct tty_feature tty_feature_cstyle = {
1.1 nicm 177: "cstyle",
178: tty_feature_cstyle_capabilities,
179: 0
180: };
181:
182: /* Terminal supports cursor colours. */
183: static const char *tty_feature_ccolour_capabilities[] = {
184: "Cs=\\E]12;%p1%s\\a",
185: "Cr=\\E]112\\a",
186: NULL
187: };
1.12 nicm 188: static const struct tty_feature tty_feature_ccolour = {
1.1 nicm 189: "ccolour",
190: tty_feature_ccolour_capabilities,
191: 0
192: };
193:
1.10 nicm 194: /* Terminal supports strikethrough. */
195: static const char *tty_feature_strikethrough_capabilities[] = {
196: "smxx=\\E[9m",
197: NULL
198: };
1.12 nicm 199: static const struct tty_feature tty_feature_strikethrough = {
1.10 nicm 200: "strikethrough",
201: tty_feature_strikethrough_capabilities,
202: 0
203: };
204:
1.1 nicm 205: /* Terminal supports synchronized updates. */
206: static const char *tty_feature_sync_capabilities[] = {
1.2 nicm 207: "Sync=\\EP=%p1%ds\\E\\\\",
1.1 nicm 208: NULL
209: };
1.12 nicm 210: static const struct tty_feature tty_feature_sync = {
1.1 nicm 211: "sync",
212: tty_feature_sync_capabilities,
213: 0
214: };
215:
1.14 nicm 216: /* Terminal supports extended keys. */
217: static const char *tty_feature_extkeys_capabilities[] = {
218: "Eneks=\\E[>4;1m",
219: "Dseks=\\E[>4m",
220: NULL
221: };
222: static const struct tty_feature tty_feature_extkeys = {
223: "extkeys",
224: tty_feature_extkeys_capabilities,
225: 0
226: };
227:
1.1 nicm 228: /* Terminal supports DECSLRM margins. */
1.7 nicm 229: static const char *tty_feature_margins_capabilities[] = {
230: "Enmg=\\E[?69h",
231: "Dsmg=\\E[?69l",
232: "Clmg=\\E[s",
233: "Cmg=\\E[%i%p1%d;%p2%ds",
234: NULL
235: };
1.12 nicm 236: static const struct tty_feature tty_feature_margins = {
1.1 nicm 237: "margins",
1.7 nicm 238: tty_feature_margins_capabilities,
1.1 nicm 239: TERM_DECSLRM
240: };
241:
242: /* Terminal supports DECFRA rectangle fill. */
1.19 nicm 243: static const char *tty_feature_rectfill_capabilities[] = {
244: "Rect",
245: NULL
246: };
1.12 nicm 247: static const struct tty_feature tty_feature_rectfill = {
1.1 nicm 248: "rectfill",
1.19 nicm 249: tty_feature_rectfill_capabilities,
1.1 nicm 250: TERM_DECFRA
251: };
252:
1.24 ! nicm 253: /* Use builtin function keys only. */
! 254: static const char *tty_feature_ignorefkeys_capabilities[] = {
! 255: "kf0@",
! 256: "kf1@",
! 257: "kf2@",
! 258: "kf3@",
! 259: "kf4@",
! 260: "kf5@",
! 261: "kf6@",
! 262: "kf7@",
! 263: "kf8@",
! 264: "kf9@",
! 265: "kf10@",
! 266: "kf11@",
! 267: "kf12@",
! 268: "kf13@",
! 269: "kf14@",
! 270: "kf15@",
! 271: "kf16@",
! 272: "kf17@",
! 273: "kf18@",
! 274: "kf19@",
! 275: "kf20@",
! 276: "kf21@",
! 277: "kf22@",
! 278: "kf23@",
! 279: "kf24@",
! 280: "kf25@",
! 281: "kf26@",
! 282: "kf27@",
! 283: "kf28@",
! 284: "kf29@",
! 285: "kf30@",
! 286: "kf31@",
! 287: "kf32@",
! 288: "kf33@",
! 289: "kf34@",
! 290: "kf35@",
! 291: "kf36@",
! 292: "kf37@",
! 293: "kf38@",
! 294: "kf39@",
! 295: "kf40@",
! 296: "kf41@",
! 297: "kf42@",
! 298: "kf43@",
! 299: "kf44@",
! 300: "kf45@",
! 301: "kf46@",
! 302: "kf47@",
! 303: "kf48@",
! 304: "kf49@",
! 305: "kf50@",
! 306: "kf51@",
! 307: "kf52@",
! 308: "kf53@",
! 309: "kf54@",
! 310: "kf55@",
! 311: "kf56@",
! 312: "kf57@",
! 313: "kf58@",
! 314: "kf59@",
! 315: "kf60@",
! 316: "kf61@",
! 317: "kf62@",
! 318: "kf63@",
! 319: NULL
! 320: };
! 321: static const struct tty_feature tty_feature_ignorefkeys = {
! 322: "ignorefkeys",
! 323: tty_feature_ignorefkeys_capabilities,
! 324: 0
! 325: };
! 326:
1.1 nicm 327: /* Available terminal features. */
328: static const struct tty_feature *tty_features[] = {
329: &tty_feature_256,
1.11 nicm 330: &tty_feature_bpaste,
1.12 nicm 331: &tty_feature_ccolour,
1.1 nicm 332: &tty_feature_clipboard,
333: &tty_feature_cstyle,
1.14 nicm 334: &tty_feature_extkeys,
1.12 nicm 335: &tty_feature_focus,
1.24 ! nicm 336: &tty_feature_ignorefkeys,
1.1 nicm 337: &tty_feature_margins,
1.20 nicm 338: &tty_feature_mouse,
1.22 nicm 339: &tty_feature_osc7,
1.1 nicm 340: &tty_feature_overline,
341: &tty_feature_rectfill,
342: &tty_feature_rgb,
1.10 nicm 343: &tty_feature_strikethrough,
1.1 nicm 344: &tty_feature_sync,
345: &tty_feature_title,
346: &tty_feature_usstyle
347: };
348:
349: void
350: tty_add_features(int *feat, const char *s, const char *separators)
351: {
352: const struct tty_feature *tf;
353: char *next, *loop, *copy;
354: u_int i;
1.7 nicm 355:
1.9 nicm 356: log_debug("adding terminal features %s", s);
1.1 nicm 357:
358: loop = copy = xstrdup(s);
359: while ((next = strsep(&loop, separators)) != NULL) {
360: for (i = 0; i < nitems(tty_features); i++) {
361: tf = tty_features[i];
362: if (strcasecmp(tf->name, next) == 0)
363: break;
364: }
365: if (i == nitems(tty_features)) {
366: log_debug("unknown terminal feature: %s", next);
367: break;
368: }
369: if (~(*feat) & (1 << i)) {
370: log_debug("adding terminal feature: %s", tf->name);
371: (*feat) |= (1 << i);
372: }
373: }
374: free(copy);
375: }
376:
377: const char *
378: tty_get_features(int feat)
379: {
380: const struct tty_feature *tf;
381: static char s[512];
382: u_int i;
383:
384: *s = '\0';
385: for (i = 0; i < nitems(tty_features); i++) {
386: if (~feat & (1 << i))
387: continue;
388: tf = tty_features[i];
389:
390: strlcat(s, tf->name, sizeof s);
391: strlcat(s, ",", sizeof s);
392: }
393: if (*s != '\0')
394: s[strlen(s) - 1] = '\0';
395: return (s);
396: }
397:
1.3 nicm 398: int
1.1 nicm 399: tty_apply_features(struct tty_term *term, int feat)
400: {
401: const struct tty_feature *tf;
402: const char **capability;
403: u_int i;
404:
405: if (feat == 0)
1.3 nicm 406: return (0);
1.1 nicm 407: log_debug("applying terminal features: %s", tty_get_features(feat));
408:
409: for (i = 0; i < nitems(tty_features); i++) {
410: if ((term->features & (1 << i)) || (~feat & (1 << i)))
411: continue;
412: tf = tty_features[i];
413:
414: log_debug("applying terminal feature: %s", tf->name);
415: if (tf->capabilities != NULL) {
416: capability = tf->capabilities;
417: while (*capability != NULL) {
418: log_debug("adding capability: %s", *capability);
419: tty_term_apply(term, *capability, 1);
420: capability++;
421: }
422: }
423: term->flags |= tf->flags;
424: }
1.3 nicm 425: if ((term->features | feat) == term->features)
426: return (0);
1.1 nicm 427: term->features |= feat;
1.3 nicm 428: return (1);
1.9 nicm 429: }
430:
431: void
432: tty_default_features(int *feat, const char *name, u_int version)
433: {
434: static struct {
435: const char *name;
436: u_int version;
437: const char *features;
438: } table[] = {
1.16 nicm 439: #define TTY_FEATURES_BASE_MODERN_XTERM \
1.20 nicm 440: "256,RGB,bpaste,clipboard,mouse,strikethrough,title"
1.9 nicm 441: { .name = "mintty",
1.16 nicm 442: .features = TTY_FEATURES_BASE_MODERN_XTERM
1.18 nicm 443: ",ccolour,cstyle,extkeys,margins,overline,usstyle"
1.9 nicm 444: },
445: { .name = "tmux",
1.16 nicm 446: .features = TTY_FEATURES_BASE_MODERN_XTERM
447: ",ccolour,cstyle,focus,overline,usstyle"
1.9 nicm 448: },
449: { .name = "rxvt-unicode",
1.24 ! nicm 450: .features = "256,bpaste,ccolour,cstyle,mouse,title,ignorefkeys"
1.9 nicm 451: },
452: { .name = "iTerm2",
1.16 nicm 453: .features = TTY_FEATURES_BASE_MODERN_XTERM
1.23 nicm 454: ",cstyle,extkeys,margins,usstyle,sync,osc7"
1.9 nicm 455: },
456: { .name = "XTerm",
1.19 nicm 457: /*
458: * xterm also supports DECSLRM and DECFRA, but they can be
459: * disabled so not set it here - they will be added if
460: * secondary DA shows VT420.
461: */
1.16 nicm 462: .features = TTY_FEATURES_BASE_MODERN_XTERM
1.19 nicm 463: ",ccolour,cstyle,extkeys,focus"
1.9 nicm 464: }
465: };
466: u_int i;
467:
468: for (i = 0; i < nitems(table); i++) {
469: if (strcmp(table[i].name, name) != 0)
470: continue;
471: if (version != 0 && version < table[i].version)
472: continue;
473: tty_add_features(feat, table[i].features, ",");
474: }
1.1 nicm 475: }
![[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