xtermcap.c revision d522f475 
1/* $XTermId: xtermcap.c,v 1.12 2007/12/31 17:27:42 tom Exp $ */
2
3/*
4 * Copyright 2007 by Thomas E. Dickey
5 *
6 *                         All Rights Reserved
7 *
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:
15 *
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
18 *
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.
26 *
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
30 * authorization.
31 */
32
33#include <xtermcap.h>
34
35#include <X11/keysym.h>
36
37#ifdef VMS
38#include <X11/keysymdef.h>
39#endif
40
41#include <xstrings.h>
42
43#ifndef HAVE_TIGETSTR
44#undef USE_TERMINFO
45#endif
46
47#ifndef USE_TERMINFO
48#define USE_TERMINFO 0
49#endif
50
51#if OPT_TCAP_QUERY || OPT_TCAP_FKEYS
52
53typedef struct {
54    char *tc;
55    char *ti;
56    int code;
57    unsigned state;
58} TCAPINFO;
59/* *INDENT-OFF* */
60#define DATA(tc,ti,x,y) { tc, ti, x, y }
61static TCAPINFO table[] = {
62	/*	tcap	terminfo	code		param */
63	DATA(	"%1",	"khlp",		XK_Help,	0	),
64	DATA(	"#1",	"kHLP",		XK_Help,	2	),
65	DATA(	"@0",	"kfnd",		XK_Find,	0	),
66	DATA(	"*0",	"kFND",		XK_Find,	2	),
67	DATA(	"*6",	"kslt",		XK_Select,	0	),
68	DATA(	"#6",	"kSLT",		XK_Select,	2	),
69
70	DATA(	"kh",	"khome",	XK_Home,	0	),
71	DATA(	"#2",	"kHOM",		XK_Home,	2	),
72	DATA(	"@7",	"kend",		XK_End,		0	),
73	DATA(	"*7",	"kEND",		XK_End,		2	),
74
75	DATA(	"kl",	"kcub1",	XK_Left,	0	),
76	DATA(	"kr",	"kcuf1",	XK_Right,	0	),
77	DATA(	"ku",	"kcuu1",	XK_Up,		0	),
78	DATA(	"kd",	"kcud1",	XK_Down,	0	),
79
80	DATA(	"#4",	"kLFT",		XK_Left,	2	),
81	DATA(	"%i",	"kRIT",		XK_Right,	2	),
82	DATA(	"%e",	"kPRV",		XK_Up,		2	),
83	DATA(	"%c",	"kNXT",		XK_Down,	2	),
84
85	DATA(	"k1",	"kf1",		XK_Fn(1),	0	),
86	DATA(	"k2",	"kf2",		XK_Fn(2),	0	),
87	DATA(	"k3",	"kf3",		XK_Fn(3),	0	),
88	DATA(	"k4",	"kf4",		XK_Fn(4),	0	),
89	DATA(	"k5",	"kf5",		XK_Fn(5),	0	),
90	DATA(	"k6",	"kf6",		XK_Fn(6),	0	),
91	DATA(	"k7",	"kf7",		XK_Fn(7),	0	),
92	DATA(	"k8",	"kf8",		XK_Fn(8),	0	),
93	DATA(	"k9",	"kf9",		XK_Fn(9),	0	),
94	DATA(	"k;",	"kf10",		XK_Fn(10),	0	),
95
96	DATA(	"F1",	"kf11",		XK_Fn(11),	0	),
97	DATA(	"F2",	"kf12",		XK_Fn(12),	0	),
98	DATA(	"F3",	"kf13",		XK_Fn(13),	0	),
99	DATA(	"F4",	"kf14",		XK_Fn(14),	0	),
100	DATA(	"F5",	"kf15",		XK_Fn(15),	0	),
101	DATA(	"F6",	"kf16",		XK_Fn(16),	0	),
102	DATA(	"F7",	"kf17",		XK_Fn(17),	0	),
103	DATA(	"F8",	"kf18",		XK_Fn(18),	0	),
104	DATA(	"F9",	"kf19",		XK_Fn(19),	0	),
105	DATA(	"FA",	"kf20",		XK_Fn(20),	0	),
106	DATA(	"FB",	"kf21",		XK_Fn(21),	0	),
107	DATA(	"FC",	"kf22",		XK_Fn(22),	0	),
108	DATA(	"FD",	"kf23",		XK_Fn(23),	0	),
109	DATA(	"FE",	"kf24",		XK_Fn(24),	0	),
110	DATA(	"FF",	"kf25",		XK_Fn(25),	0	),
111	DATA(	"FG",	"kf26",		XK_Fn(26),	0	),
112	DATA(	"FH",	"kf27",		XK_Fn(27),	0	),
113	DATA(	"FI",	"kf28",		XK_Fn(28),	0	),
114	DATA(	"FJ",	"kf29",		XK_Fn(29),	0	),
115	DATA(	"FK",	"kf30",		XK_Fn(30),	0	),
116	DATA(	"FL",	"kf31",		XK_Fn(31),	0	),
117	DATA(	"FM",	"kf32",		XK_Fn(32),	0	),
118	DATA(	"FN",	"kf33",		XK_Fn(33),	0	),
119	DATA(	"FO",	"kf34",		XK_Fn(34),	0	),
120	DATA(	"FP",	"kf35",		XK_Fn(35),	0	),
121
122	DATA(	"FQ",	"kf36",		-36,		0	),
123	DATA(	"FR",	"kf37",		-37,		0	),
124	DATA(	"FS",	"kf38",		-38,		0	),
125	DATA(	"FT",	"kf39",		-39,		0	),
126	DATA(	"FU",	"kf40",		-40,		0	),
127	DATA(	"FV",	"kf41",		-41,		0	),
128	DATA(	"FW",	"kf42",		-42,		0	),
129	DATA(	"FX",	"kf43",		-43,		0	),
130	DATA(	"FY",	"kf44",		-44,		0	),
131	DATA(	"FZ",	"kf45",		-45,		0	),
132	DATA(	"Fa",	"kf46",		-46,		0	),
133	DATA(	"Fb",	"kf47",		-47,		0	),
134	DATA(	"Fc",	"kf48",		-48,		0	),
135	DATA(	"Fd",	"kf49",		-49,		0	),
136	DATA(	"Fe",	"kf50",		-50,		0	),
137	DATA(	"Ff",	"kf51",		-51,		0	),
138	DATA(	"Fg",	"kf52",		-52,		0	),
139	DATA(	"Fh",	"kf53",		-53,		0	),
140	DATA(	"Fi",	"kf54",		-54,		0	),
141	DATA(	"Fj",	"kf55",		-55,		0	),
142	DATA(	"Fk",	"kf56",		-56,		0	),
143	DATA(	"Fl",	"kf57",		-57,		0	),
144	DATA(	"Fm",	"kf58",		-58,		0	),
145	DATA(	"Fn",	"kf59",		-59,		0	),
146	DATA(	"Fo",	"kf60",		-60,		0	),
147	DATA(	"Fp",	"kf61",		-61,		0	),
148	DATA(	"Fq",	"kf62",		-62,		0	),
149	DATA(	"Fr",	"kf63",		-63,		0	),
150
151	DATA(	"K1",	"ka1",		XK_KP_Home,	0	),
152	DATA(	"K4",	"kc1",		XK_KP_End,	0	),
153
154#ifdef XK_ISO_Left_Tab
155	DATA(	"kB",	"kcbt",		XK_ISO_Left_Tab, 0	),
156#endif
157	DATA(	"kC",	"kclr",		XK_Clear,	0	),
158	DATA(	"kD",	"kdch1",	XK_Delete,	0	),
159	DATA(	"kI",	"kich1",	XK_Insert,	0	),
160	DATA(	"kN",	"knp",		XK_Next,	0	),
161	DATA(	"kP",	"kpp",		XK_Prior,	0	),
162	DATA(	"kb",	"kbs",		XK_BackSpace,	0	),
163# if OPT_TCAP_QUERY && OPT_ISO_COLORS
164	/* XK_COLORS is a fake code. */
165	DATA(	"Co",	"colors",	XK_COLORS,	0	),
166# endif
167#if USE_TERMINFO && defined(NCURSES_VERSION)
168#define DEXT(name, parm, code) DATA("", name, code, parm)
169#define D1ST(name, parm, code) DEXT("k" #name, parm, code)
170#define DMOD(name, parm, code) DEXT("k" #name #parm, parm, code)
171
172#define DGRP(name, code) \
173	D1ST(name, 2, code), \
174	DMOD(name, 3, code), \
175	DMOD(name, 4, code), \
176	DMOD(name, 5, code), \
177	DMOD(name, 6, code), \
178	DMOD(name, 7, code), \
179	DMOD(name, 8, code)
180
181	DGRP(DN,   XK_Down),
182	DGRP(LFT,  XK_Left),
183	DGRP(RIT,  XK_Right),
184	DGRP(UP,   XK_Up),
185	DGRP(DC,   XK_Delete),
186	DGRP(END,  XK_End),
187	DGRP(HOM,  XK_Home),
188	DGRP(IC,   XK_Insert),
189	DGRP(NXT,  XK_Next),
190	DGRP(PRV,  XK_Prior),
191#endif
192};
193#undef DATA
194/* *INDENT-ON* */
195
196#if OPT_TCAP_QUERY
197static int
198hex2int(int c)
199{
200    if (c >= '0' && c <= '9')
201	return c - '0';
202    if (c >= 'a' && c <= 'f')
203	return c - 'a' + 10;
204    if (c >= 'A' && c <= 'F')
205	return c - 'A' + 10;
206    return -1;
207}
208
209static TCAPINFO *
210lookupTcapByName(const char *name)
211{
212    TCAPINFO *result = 0;
213    Cardinal n;
214
215    if (name != 0 && *name != '\0') {
216	for (n = 0; n < XtNumber(table); n++) {
217	    if (!strcmp(table[n].ti, name) || !strcmp(table[n].tc, name)) {
218		result = table + n;
219		break;
220	    }
221	}
222    }
223    return result;
224}
225
226/*
227 * Parse the termcap/terminfo name from the string, returning a positive number
228 * (the keysym) if found, otherwise -1.  Update the string pointer.
229 * Returns the (shift, control) state in *state.
230 *
231 * This does not attempt to construct control/shift modifiers to construct
232 * function-key values.  Instead, it sets the *fkey flag to pass to Input()
233 * and bypass the lookup of keysym altogether.
234 */
235int
236xtermcapKeycode(XtermWidget xw, char **params, unsigned *state, Bool * fkey)
237{
238    TCAPINFO *data;
239    unsigned len = 0;
240    int code = -1;
241#define MAX_TNAME_LEN 6
242    char name[MAX_TNAME_LEN + 1];
243    char *p;
244
245    TRACE(("xtermcapKeycode(%s)\n", *params));
246
247    /* Convert hex encoded name to ascii */
248    for (p = *params; hex2int(p[0]) >= 0 && hex2int(p[1]) >= 0; p += 2) {
249	if (len >= MAX_TNAME_LEN)
250	    break;
251	name[len++] = (hex2int(p[0]) << 4) + hex2int(p[1]);
252    }
253    name[len] = 0;
254    *params = p;
255
256    *state = 0;
257    *fkey = False;
258
259    if (*p == 0 || *p == ';') {
260	if ((data = lookupTcapByName(name)) != 0) {
261	    code = data->code;
262	    *state = xtermParamToState(xw, data->state);
263	    if (IsFunctionKey(code)) {
264		*fkey = True;
265	    } else if (code < 0) {
266		*fkey = True;
267		code = XK_Fn((-code));
268	    }
269#if OPT_SUN_FUNC_KEYS
270	    if (*fkey && xw->keyboard.type == keyboardIsSun) {
271		int num = code - XK_Fn(0);
272
273		/* match function-key case in sunfuncvalue() */
274		if (num > 20) {
275		    if (num <= 30 || num > 47) {
276			code = -1;
277		    } else {
278			code -= 10;
279			switch (num) {
280			case 37:	/* khome */
281			case 39:	/* kpp */
282			case 41:	/* kb2 */
283			case 43:	/* kend */
284			case 45:	/* knp */
285			    code = -1;
286			    break;
287			}
288		    }
289		}
290	    }
291#endif
292	}
293    }
294
295    TRACE(("... xtermcapKeycode(%s, %u, %d) -> %#06x\n",
296	   name, *state, *fkey, code));
297    return code;
298}
299#endif /* OPT_TCAP_QUERY */
300
301#if OPT_TCAP_FKEYS
302static TCAPINFO *
303lookupTcapByCode(int code, unsigned mask)
304{
305    TCAPINFO *result = 0;
306    Cardinal n;
307
308    TRACE(("lookupTcapByCode %d:%#x\n", code, mask));
309    for (n = 0; n < XtNumber(table); n++) {
310	if (table[n].code == code &&
311	    table[n].state == mask) {
312	    TRACE(("lookupTcapByCode %d:%s\n", n, table[n].ti));
313	    result = table + n;
314	    break;
315	}
316    }
317    return result;
318}
319
320#define NO_STRING (char *)(-1)
321
322int
323xtermcapString(XtermWidget xw, int keycode, unsigned mask)
324{
325    int result = 0;
326    TCAPINFO *data;
327    unsigned param = xtermStateToParam(xw, mask);
328
329    if ((data = lookupTcapByCode(keycode, param)) != 0) {
330	TScreen *screen = TScreenOf(xw);
331	Cardinal which = data - table;
332	char *fkey;
333
334	if (screen->tcap_fkeys == 0) {
335	    Cardinal want = XtNumber(table);
336	    Cardinal have;
337#if !(USE_TERMINFO && defined(HAVE_TIGETSTR))
338	    char *area = screen->tcap_area;
339#endif
340
341	    if ((screen->tcap_fkeys = TypeCallocN(char *, want)) != 0) {
342		for (have = 0; have < want; ++have) {
343#if USE_TERMINFO && defined(HAVE_TIGETSTR)
344		    fkey = tigetstr(table[have].ti);
345#else
346		    fkey = tgetstr(table[have].tc, &area);
347#endif
348		    if (fkey != 0 && fkey != NO_STRING) {
349			screen->tcap_fkeys[have] = x_strdup(fkey);
350		    } else {
351			screen->tcap_fkeys[have] = NO_STRING;
352		    }
353		}
354	    }
355	}
356	if (screen->tcap_fkeys != 0) {
357	    if ((fkey = screen->tcap_fkeys[which]) != NO_STRING) {
358		StringInput(xw, (Char *) fkey, strlen(fkey));
359		result = 1;
360	    }
361	}
362    }
363
364    TRACE(("xtermcapString(keycode=%#x, mask=%#x) ->%d\n",
365	   keycode, mask, result));
366
367    return result;
368}
369#endif /* OPT_TCAP_FKEYS */
370
371#endif /* OPT_TCAP_QUERY || OPT_TCAP_FKEYS */
372/*
373 * If we're linked to terminfo, tgetent() will return an empty buffer.  We
374 * cannot use that to adjust the $TERMCAP variable.
375 */
376Bool
377get_termcap(char *name, char *buffer)
378{
379    *buffer = 0;		/* initialize, in case we're using terminfo's tgetent */
380
381#if USE_TERMINFO && defined(NCURSES_VERSION)
382    use_extended_names(TRUE);
383#endif
384    if (name != 0) {
385	if (tgetent(buffer, name) == 1) {
386	    TRACE(("get_termcap(%s) succeeded (%s)\n", name,
387		   (*buffer
388		    ? "ok:termcap, we can update $TERMCAP"
389		    : "assuming this is terminfo")));
390	    return True;
391	} else {
392	    *buffer = 0;	/* just in case */
393	}
394    }
395    return False;
396}
397