1 /* $XTermId: xtermcap.c,v 1.44 2010/06/13 17:46:27 tom Exp $ */
4 * Copyright 2007-2009,2010 by Thomas E. Dickey
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 * IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
23 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
24 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
25 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 * Except as contained in this notice, the name(s) of the above copyright
28 * holders shall not be used in advertising or otherwise to promote the
29 * sale, use or other dealings in this Software without prior written
36 #include <X11/keysym.h>
40 #include <X11/keysymdef.h>
45 #if USE_TERMINFO && defined(NCURSES_VERSION) && defined(HAVE_USE_EXTENDED_NAMES)
46 #define USE_EXTENDED_NAMES 1
48 #define USE_EXTENDED_NAMES 0
52 #define TcapInit(buffer, name) (setupterm(name, fileno(stdout), &ignored) == OK)
54 #define TcapInit(buffer, name) (tgetent(buffer, name) == 1)
57 #define NO_STRING (char *)(-1)
59 #if OPT_TCAP_QUERY || OPT_TCAP_FKEYS
61 #define SHIFT (MOD_NONE + MOD_SHIFT)
67 unsigned param; /* see xtermStateToParam() */
70 #define DATA(tc,ti,x,y) { tc, ti, x, y }
71 static TCAPINFO table[] = {
72 /* tcap terminfo code state */
73 DATA( "%1", "khlp", XK_Help, 0 ),
74 DATA( "#1", "kHLP", XK_Help, SHIFT ),
75 DATA( "@0", "kfnd", XK_Find, 0 ),
76 DATA( "*0", "kFND", XK_Find, SHIFT ),
77 DATA( "*6", "kslt", XK_Select, 0 ),
78 DATA( "#6", "kSLT", XK_Select, SHIFT ),
80 DATA( "kh", "khome", XK_Home, 0 ),
81 DATA( "#2", "kHOM", XK_Home, SHIFT ),
82 DATA( "@7", "kend", XK_End, 0 ),
83 DATA( "*7", "kEND", XK_End, SHIFT ),
85 DATA( "kl", "kcub1", XK_Left, 0 ),
86 DATA( "kr", "kcuf1", XK_Right, 0 ),
87 DATA( "ku", "kcuu1", XK_Up, 0 ),
88 DATA( "kd", "kcud1", XK_Down, 0 ),
90 DATA( "#4", "kLFT", XK_Left, SHIFT ),
91 DATA( "%i", "kRIT", XK_Right, SHIFT ),
92 DATA( "kF", "kind", XK_Up, SHIFT ),
93 DATA( "kR", "kri", XK_Down, SHIFT ),
95 DATA( "k1", "kf1", XK_Fn(1), 0 ),
96 DATA( "k2", "kf2", XK_Fn(2), 0 ),
97 DATA( "k3", "kf3", XK_Fn(3), 0 ),
98 DATA( "k4", "kf4", XK_Fn(4), 0 ),
99 DATA( "k5", "kf5", XK_Fn(5), 0 ),
100 DATA( "k6", "kf6", XK_Fn(6), 0 ),
101 DATA( "k7", "kf7", XK_Fn(7), 0 ),
102 DATA( "k8", "kf8", XK_Fn(8), 0 ),
103 DATA( "k9", "kf9", XK_Fn(9), 0 ),
104 DATA( "k;", "kf10", XK_Fn(10), 0 ),
106 DATA( "F1", "kf11", XK_Fn(11), 0 ),
107 DATA( "F2", "kf12", XK_Fn(12), 0 ),
108 DATA( "F3", "kf13", XK_Fn(13), 0 ),
109 DATA( "F4", "kf14", XK_Fn(14), 0 ),
110 DATA( "F5", "kf15", XK_Fn(15), 0 ),
111 DATA( "F6", "kf16", XK_Fn(16), 0 ),
112 DATA( "F7", "kf17", XK_Fn(17), 0 ),
113 DATA( "F8", "kf18", XK_Fn(18), 0 ),
114 DATA( "F9", "kf19", XK_Fn(19), 0 ),
115 DATA( "FA", "kf20", XK_Fn(20), 0 ),
116 DATA( "FB", "kf21", XK_Fn(21), 0 ),
117 DATA( "FC", "kf22", XK_Fn(22), 0 ),
118 DATA( "FD", "kf23", XK_Fn(23), 0 ),
119 DATA( "FE", "kf24", XK_Fn(24), 0 ),
120 DATA( "FF", "kf25", XK_Fn(25), 0 ),
121 DATA( "FG", "kf26", XK_Fn(26), 0 ),
122 DATA( "FH", "kf27", XK_Fn(27), 0 ),
123 DATA( "FI", "kf28", XK_Fn(28), 0 ),
124 DATA( "FJ", "kf29", XK_Fn(29), 0 ),
125 DATA( "FK", "kf30", XK_Fn(30), 0 ),
126 DATA( "FL", "kf31", XK_Fn(31), 0 ),
127 DATA( "FM", "kf32", XK_Fn(32), 0 ),
128 DATA( "FN", "kf33", XK_Fn(33), 0 ),
129 DATA( "FO", "kf34", XK_Fn(34), 0 ),
130 DATA( "FP", "kf35", XK_Fn(35), 0 ),
132 DATA( "FQ", "kf36", -36, 0 ),
133 DATA( "FR", "kf37", -37, 0 ),
134 DATA( "FS", "kf38", -38, 0 ),
135 DATA( "FT", "kf39", -39, 0 ),
136 DATA( "FU", "kf40", -40, 0 ),
137 DATA( "FV", "kf41", -41, 0 ),
138 DATA( "FW", "kf42", -42, 0 ),
139 DATA( "FX", "kf43", -43, 0 ),
140 DATA( "FY", "kf44", -44, 0 ),
141 DATA( "FZ", "kf45", -45, 0 ),
142 DATA( "Fa", "kf46", -46, 0 ),
143 DATA( "Fb", "kf47", -47, 0 ),
144 DATA( "Fc", "kf48", -48, 0 ),
145 DATA( "Fd", "kf49", -49, 0 ),
146 DATA( "Fe", "kf50", -50, 0 ),
147 DATA( "Ff", "kf51", -51, 0 ),
148 DATA( "Fg", "kf52", -52, 0 ),
149 DATA( "Fh", "kf53", -53, 0 ),
150 DATA( "Fi", "kf54", -54, 0 ),
151 DATA( "Fj", "kf55", -55, 0 ),
152 DATA( "Fk", "kf56", -56, 0 ),
153 DATA( "Fl", "kf57", -57, 0 ),
154 DATA( "Fm", "kf58", -58, 0 ),
155 DATA( "Fn", "kf59", -59, 0 ),
156 DATA( "Fo", "kf60", -60, 0 ),
157 DATA( "Fp", "kf61", -61, 0 ),
158 DATA( "Fq", "kf62", -62, 0 ),
159 DATA( "Fr", "kf63", -63, 0 ),
161 DATA( "K1", "ka1", XK_KP_Home, 0 ),
162 DATA( "K4", "kc1", XK_KP_End, 0 ),
163 DATA( "K3", "ka3", XK_KP_Prior, 0 ),
164 DATA( "K5", "kc3", XK_KP_Next, 0 ),
166 #ifdef XK_ISO_Left_Tab
167 DATA( "kB", "kcbt", XK_ISO_Left_Tab, 0 ),
169 DATA( "kC", "kclr", XK_Clear, 0 ),
170 DATA( "kD", "kdch1", XK_Delete, 0 ),
171 DATA( "kI", "kich1", XK_Insert, 0 ),
173 DATA( "kN", "knp", XK_Next, 0 ),
174 DATA( "kP", "kpp", XK_Prior, 0 ),
175 DATA( "%c", "kNXT", XK_Next, SHIFT ),
176 DATA( "%e", "kPRV", XK_Prior, SHIFT ),
178 DATA( "&8", "kund", XK_Undo, 0 ),
179 DATA( "kb", "kbs", XK_BackSpace, 0 ),
180 # if OPT_TCAP_QUERY && OPT_ISO_COLORS
181 /* XK_COLORS is a fake code. */
182 DATA( "Co", "colors", XK_COLORS, 0 ),
184 DATA( "TN", "name", XK_TCAPNAME, 0 ),
185 #if USE_EXTENDED_NAMES
186 #define DEXT(name, parm, code) DATA("", name, code, parm)
187 #define D1ST(name, parm, code) DEXT("k" #name, parm, code)
188 #define DMOD(name, parm, code) DEXT("k" #name #parm, parm, code)
190 #define DGRP(name, code) \
191 D1ST(name, 2, code), \
192 DMOD(name, 3, code), \
193 DMOD(name, 4, code), \
194 DMOD(name, 5, code), \
195 DMOD(name, 6, code), \
196 DMOD(name, 7, code), \
199 /* the terminfo codes here are ncurses extensions */
200 /* ignore the termcap names, which are empty */
201 DATA( "", "kUP", XK_Up, SHIFT ),
202 DATA( "", "kDN", XK_Up, SHIFT ),
221 loadTermcapStrings(TScreen * screen)
223 if (screen->tcap_fkeys == 0) {
225 Cardinal want = XtNumber(table);
229 char *area = screen->tcap_area;
232 TRACE(("loadTermcapStrings\n"));
233 if ((screen->tcap_fkeys = TypeCallocN(char *, want)) != 0) {
234 for (have = 0; have < want; ++have) {
236 fkey = tigetstr(strcpy(name, table[have].ti));
238 fkey = tgetstr(strcpy(name, table[have].tc), &area);
240 if (fkey != 0 && fkey != NO_STRING) {
241 screen->tcap_fkeys[have] = x_strdup(fkey);
243 screen->tcap_fkeys[have] = NO_STRING;
253 keyIsDistinct(XtermWidget xw, int which)
255 Boolean result = True;
257 switch (xw->keyboard.type) {
258 case keyboardIsTermcap:
260 if (table[which].param == SHIFT) {
261 TScreen *screen = TScreenOf(xw);
265 loadTermcapStrings(screen);
266 if (screen->tcap_fkeys[which] != NO_STRING) {
267 for (k = 0; k < XtNumber(table); k++) {
268 if (table[k].code == table[which].code
269 && table[k].param == 0) {
270 if ((fkey = screen->tcap_fkeys[k]) != NO_STRING
271 && !strcmp(fkey, screen->tcap_fkeys[which])) {
272 TRACE(("shifted/unshifted keys do not differ\n"));
279 /* there is no data for the shifted key */
286 * The vt220-keyboard will not return distinct key sequences for
287 * shifted cursor-keys. Just pretend they do not exist, since some
288 * programs may be confused if we return the same data for
289 * shifted/unshifted keys.
291 case keyboardIsVT220:
292 if (table[which].param == SHIFT) {
293 TRACE(("shifted/unshifted keys do not differ\n"));
297 case keyboardIsLegacy:
298 case keyboardIsDefault:
309 lookupTcapByName(const char *name)
314 if (!IsEmpty(name)) {
315 for (j = 0; j < XtNumber(table); j++) {
316 if (!strcmp(table[j].ti, name) || !strcmp(table[j].tc, name)) {
324 TRACE(("lookupTcapByName(%s) tc=%s, ti=%s code %#x, param %#x\n",
329 table[result].param));
331 TRACE(("lookupTcapByName(%s) FAIL\n", name));
337 * Parse the termcap/terminfo name from the string, returning a positive number
338 * (the keysym) if found, otherwise -1. Update the string pointer.
339 * Returns the (shift, control) state in *state.
341 * This does not attempt to construct control/shift modifiers to construct
342 * function-key values. Instead, it sets the *fkey flag to pass to Input()
343 * and bypass the lookup of keysym altogether.
346 xtermcapKeycode(XtermWidget xw, const char **params, unsigned *state, Bool * fkey)
354 TRACE(("xtermcapKeycode(%s)\n", *params));
356 /* Convert hex encoded name to ascii */
357 name = x_decode_hex(*params, &p);
363 if (!IsEmpty(name) && (*p == 0 || *p == ';')) {
364 if ((which = lookupTcapByName(name)) >= 0) {
365 if (keyIsDistinct(xw, which)) {
366 data = table + which;
368 *state = xtermParamToState(xw, data->param);
369 if (IsFunctionKey(code)) {
371 } else if (code < 0) {
373 code = XK_Fn((-code));
375 #if OPT_SUN_FUNC_KEYS
376 if (*fkey && xw->keyboard.type == keyboardIsSun) {
377 int num = code - XK_Fn(0);
379 /* match function-key case in sunfuncvalue() */
381 if (num <= 30 || num > 47) {
399 TRACE(("... name ok, data not ok\n"));
403 TRACE(("... name not ok\n"));
407 TRACE(("... name not ok\n"));
411 TRACE(("... xtermcapKeycode(%s, %u, %d) -> %#06x\n",
412 name, *state, *fkey, code));
416 #endif /* OPT_TCAP_QUERY */
420 nextTcapByCode(int code, unsigned param, int last)
425 TRACE(("lookupTcapByCode %#x:%#x\n", code, param));
426 for (n = last + 1; n < (int) XtNumber(table); n++) {
427 if (table[n].code == code &&
428 table[n].param == param) {
429 TRACE(("->lookupTcapByCode %d:%s\n", n, table[n].ti));
438 firstTcapByCode(int code, unsigned param)
440 return nextTcapByCode(code, param, -1);
444 xtermcapString(XtermWidget xw, int keycode, unsigned mask)
447 unsigned param = xtermStateToParam(xw, mask);
450 if ((which = firstTcapByCode(keycode, param)) >= 0) {
451 TScreen *screen = TScreenOf(xw);
454 loadTermcapStrings(screen);
455 if (screen->tcap_fkeys != 0) {
457 if ((fkey = screen->tcap_fkeys[which]) != NO_STRING) {
458 StringInput(xw, (Char *) fkey, strlen(fkey));
462 } while ((which = nextTcapByCode(keycode, param, which)) >= 0);
466 TRACE(("xtermcapString(keycode=%#x, mask=%#x) ->%d\n",
467 keycode, mask, result));
471 #endif /* OPT_TCAP_FKEYS */
473 #endif /* OPT_TCAP_QUERY || OPT_TCAP_FKEYS */
476 * If we're linked to terminfo, tgetent() will return an empty buffer. We
477 * cannot use that to adjust the $TERMCAP variable.
480 get_termcap(XtermWidget xw, char *name)
485 char *buffer = get_tcap_buffer(xw);
487 *buffer = 0; /* initialize, in case we're using terminfo's tgetent */
489 #if USE_EXTENDED_NAMES
490 use_extended_names(TRUE);
492 if (!IsEmpty(name)) {
493 if (TcapInit(buffer, name)) {
494 TRACE(("get_termcap(%s) succeeded (%s)\n", name,
496 ? "ok:termcap, we can update $TERMCAP"
497 : "assuming this is terminfo")));
500 *buffer = 0; /* just in case */
507 * Retrieve the termcap-buffer.
510 get_tcap_buffer(XtermWidget xw)
512 TScreen *screen = TScreenOf(xw);
516 if (TEK4014_ACTIVE(xw)) {
517 buffer = TekScreenOf(tekWidget)->tcapbuf;
521 buffer = screen->tcapbuf;
527 * Retrieve the erase-key, for initialization in main program.
530 get_tcap_erase(XtermWidget xw GCC_UNUSED)
533 char *area = TScreenOf(xw)->tcap_area;
538 fkey = tigetstr("kbs");
540 fkey = tgetstr("kb", &area);
543 if (fkey == NO_STRING)
546 fkey = x_strdup(fkey);
551 * A legal termcap (or terminfo) name consists solely of graphic characters,
552 * excluding the punctuation used to delimit fields of the source description.
555 isLegalTcapName(const char *name)
561 while (*name != '\0') {
562 if (isgraph(CharOf(*name))) {
563 if (strchr("\\|,:'\"", *name) != 0) {
579 set_termcap(XtermWidget xw, const char *name)
581 Boolean success = False;
585 TScreen *screen = TScreenOf(xw);
586 char buffer[sizeof(screen->tcapbuf)];
589 TRACE(("set_termcap(%s)\n", NonNull(name)));
591 Bell(xw, XkbBI_MinorError, 0);
596 if ((value = x_decode_hex(name, &temp)) != 0) {
597 if (*temp == '\0' && isLegalTcapName(value)) {
598 if (TcapInit(buffer, value)) {
600 memcpy(screen->tcapbuf, buffer, sizeof(buffer));
610 Bell(xw, XkbBI_MinorError, 0);
614 free_termcap(XtermWidget xw)
616 TScreen *screen = TScreenOf(xw);
618 if (screen->tcap_fkeys != 0) {
619 Cardinal want = XtNumber(table);
623 for (have = 0; have < want; ++have) {
624 fkey = screen->tcap_fkeys[have];
625 if (fkey != 0 && fkey != NO_STRING) {
629 free(screen->tcap_fkeys);
630 screen->tcap_fkeys = 0;