1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
31 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
32 * and: Thomas E. Dickey 1996-on *
33 * and: Juergen Pfeifer *
35 * some of the code in here was contributed by: *
36 * Magnus Bengtsson, d6mbeng@dtek.chalmers.se (Nov'93) *
37 * (but it has changed a lot) *
38 ****************************************************************************/
40 #define __INTERNAL_CAPS_VISIBLE
41 #include <curses.priv.h>
47 #include <term_entry.h>
50 #define CUR SP_TERMTYPE
53 MODULE_ID("$Id: lib_termcap.c,v 1.70 2009/08/30 17:16:00 tom Exp $")
55 NCURSES_EXPORT_VAR(char *) UP = 0;
56 NCURSES_EXPORT_VAR(char *) BC = 0;
58 #define MyCache _nc_globals.tgetent_cache
59 #define CacheInx _nc_globals.tgetent_index
60 #define CacheSeq _nc_globals.tgetent_sequence
62 #define FIX_SGR0 MyCache[CacheInx].fix_sgr0
63 #define LAST_TRM MyCache[CacheInx].last_term
64 #define LAST_BUF MyCache[CacheInx].last_bufp
65 #define LAST_USE MyCache[CacheInx].last_used
66 #define LAST_SEQ MyCache[CacheInx].sequence
68 /***************************************************************************
72 * In termcap, this function reads in the entry for terminal `term' into the
73 * buffer pointed to by bufp. It must be called before any of the functions
75 * In this terminfo emulation, tgetent() simply calls setupterm() (which
76 * does a bit more than tgetent() in termcap does), and returns its return
77 * value (1 if successful, 0 if no terminal with the given name could be
78 * found, or -1 if no terminal descriptions have been installed on the
79 * system). The bufp argument is ignored.
81 ***************************************************************************/
84 NCURSES_SP_NAME(tgetent) (NCURSES_SP_DCLx char *bufp, const char *name)
88 bool found_cache = FALSE;
89 #ifdef USE_TERM_DRIVER
94 T((T_CALLED("tgetent()")));
96 TINFO_SETUP_TERM(&termp, (NCURSES_CONST char *) name,
97 STDOUT_FILENO, &errcode, TRUE);
99 #ifdef USE_TERM_DRIVER
101 !((TERMINAL_CONTROL_BLOCK *) termp)->drv->isTerminfo)
106 * In general we cannot tell if the fixed sgr0 is still used by the
107 * caller, but if tgetent() is called with the same buffer, that is
108 * good enough, since the previous data would be invalidated by the
111 * bufp may be a null pointer, e.g., GNU termcap. That allocates data,
112 * which is good until the next tgetent() call. The conventional termcap
113 * is inconvenient because of the fixed buffer size, but because it uses
114 * caller-supplied buffers, can have multiple terminal descriptions in
115 * use at a given time.
117 for (n = 0; n < TGETENT_MAX; ++n) {
118 bool same_result = (MyCache[n].last_used && MyCache[n].last_bufp == bufp);
122 FreeAndNull(FIX_SGR0);
125 * Also free the terminfo data that we loaded (much bigger leak).
127 if (LAST_TRM != 0 && LAST_TRM != TerminalOf(SP_PARM)) {
128 TERMINAL *trm = LAST_TRM;
129 NCURSES_SP_NAME(del_curterm) (NCURSES_SP_ARGx LAST_TRM);
130 for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx)
142 for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx) {
143 if (LAST_SEQ < MyCache[best].sequence) {
149 LAST_TRM = TerminalOf(SP_PARM);
150 LAST_SEQ = ++CacheSeq;
155 FIX_SGR0 = 0; /* don't free it - application may still use */
160 if ((backspaces_with_bs = (char) !strcmp(cursor_left, "\b")) == 0)
161 backspace_if_not_bs = cursor_left;
163 /* we're required to export these */
164 if (pad_char != NULL)
166 if (cursor_up != NULL)
168 if (backspace_if_not_bs != NULL)
169 BC = backspace_if_not_bs;
171 if ((FIX_SGR0 = _nc_trim_sgr0(&(TerminalOf(SP_PARM)->type))) != 0) {
172 if (!strcmp(FIX_SGR0, exit_attribute_mode)) {
173 if (FIX_SGR0 != exit_attribute_mode) {
182 SetNoPadding(SP_PARM);
183 (void) NCURSES_SP_NAME(baudrate) (NCURSES_SP_ARG); /* sets ospeed as a side-effect */
187 #include <capdefaults.c>
197 tgetent(char *bufp, const char *name)
199 return NCURSES_SP_NAME(tgetent) (CURRENT_SCREEN, bufp, name);
205 same_tcname(const char *a, const char *b)
207 fprintf(stderr, "compare(%s,%s)\n", a, b);
208 return !strncmp(a, b, 2);
211 #define same_tcname(a,b) !strncmp(a,b,2)
214 /***************************************************************************
218 * Look up boolean termcap capability str and return its value (TRUE=1 if
219 * present, FALSE=0 if not).
221 ***************************************************************************/
224 NCURSES_SP_NAME(tgetflag) (NCURSES_SP_DCLx NCURSES_CONST char *id)
226 int result = 0; /* Solaris returns zero for missing flag */
229 T((T_CALLED("tgetflag(%p, %s)"), SP_PARM, id));
230 if (HasTInfoTerminal(SP_PARM)) {
231 TERMTYPE *tp = &(TerminalOf(SP_PARM)->type);
232 struct name_table_entry const *entry_ptr;
234 entry_ptr = _nc_find_type_entry(id, BOOLEAN, TRUE);
235 if (entry_ptr != 0) {
236 j = entry_ptr->nte_index;
241 for_each_ext_boolean(i, tp) {
242 const char *capname = ExtBoolname(tp, i, boolcodes);
243 if (same_tcname(id, capname)) {
251 /* note: setupterm forces invalid booleans to false */
252 result = tp->Booleans[j];
260 tgetflag(NCURSES_CONST char *id)
262 return NCURSES_SP_NAME(tgetflag) (CURRENT_SCREEN, id);
266 /***************************************************************************
270 * Look up numeric termcap capability str and return its value, or -1 if
273 ***************************************************************************/
276 NCURSES_SP_NAME(tgetnum) (NCURSES_SP_DCLx NCURSES_CONST char *id)
278 int result = ABSENT_NUMERIC;
281 T((T_CALLED("tgetnum(%p, %s)"), SP_PARM, id));
282 if (HasTInfoTerminal(SP_PARM)) {
283 TERMTYPE *tp = &(TerminalOf(SP_PARM)->type);
284 struct name_table_entry const *entry_ptr;
286 entry_ptr = _nc_find_type_entry(id, NUMBER, TRUE);
287 if (entry_ptr != 0) {
288 j = entry_ptr->nte_index;
293 for_each_ext_number(i, tp) {
294 const char *capname = ExtNumname(tp, i, numcodes);
295 if (same_tcname(id, capname)) {
303 if (VALID_NUMERIC(tp->Numbers[j]))
304 result = tp->Numbers[j];
312 tgetnum(NCURSES_CONST char *id)
314 return NCURSES_SP_NAME(tgetnum) (CURRENT_SCREEN, id);
318 /***************************************************************************
322 * Look up string termcap capability str and return a pointer to its value,
323 * or NULL if not given.
325 ***************************************************************************/
327 NCURSES_EXPORT(char *)
328 NCURSES_SP_NAME(tgetstr) (NCURSES_SP_DCLx NCURSES_CONST char *id, char **area)
333 T((T_CALLED("tgetstr(%s,%p)"), id, area));
334 if (HasTInfoTerminal(SP_PARM)) {
335 TERMTYPE *tp = &(TerminalOf(SP_PARM)->type);
336 struct name_table_entry const *entry_ptr;
338 entry_ptr = _nc_find_type_entry(id, STRING, TRUE);
339 if (entry_ptr != 0) {
340 j = entry_ptr->nte_index;
345 for_each_ext_string(i, tp) {
346 const char *capname = ExtStrname(tp, i, strcodes);
347 if (same_tcname(id, capname)) {
355 result = tp->Strings[j];
356 TR(TRACE_DATABASE, ("found match : %s", _nc_visbuf(result)));
357 /* setupterm forces canceled strings to null */
358 if (VALID_STRING(result)) {
359 if (result == exit_attribute_mode
362 TR(TRACE_DATABASE, ("altered to : %s", _nc_visbuf(result)));
366 (void) strcpy(*area, result);
368 *area += strlen(*area) + 1;
377 NCURSES_EXPORT(char *)
378 tgetstr(NCURSES_CONST char *id, char **area)
380 return NCURSES_SP_NAME(tgetstr) (CURRENT_SCREEN, id, area);
386 _nc_tgetent_leaks(void)
388 for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx) {
389 FreeIfNeeded(FIX_SGR0);
391 del_curterm(LAST_TRM);