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