ncurses 6.0 - patch 20170415
[ncurses.git] / ncurses / tinfo / lib_termcap.c
1 /****************************************************************************
2  * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
3  *                                                                          *
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:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
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.                               *
22  *                                                                          *
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       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
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                                                 *
34  *                                                                          *
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  ****************************************************************************/
39
40 #define __INTERNAL_CAPS_VISIBLE
41 #include <curses.priv.h>
42
43 #include <termcap.h>
44 #include <tic.h>
45 #include <ctype.h>
46
47 #ifndef CUR
48 #define CUR SP_TERMTYPE
49 #endif
50
51 MODULE_ID("$Id: lib_termcap.c,v 1.84 2017/04/11 01:15:11 tom Exp $")
52
53 NCURSES_EXPORT_VAR(char *) UP = 0;
54 NCURSES_EXPORT_VAR(char *) BC = 0;
55
56 #define MyCache  _nc_globals.tgetent_cache
57 #define CacheInx _nc_globals.tgetent_index
58 #define CacheSeq _nc_globals.tgetent_sequence
59
60 #define FIX_SGR0 MyCache[CacheInx].fix_sgr0
61 #define LAST_TRM MyCache[CacheInx].last_term
62 #define LAST_BUF MyCache[CacheInx].last_bufp
63 #define LAST_USE MyCache[CacheInx].last_used
64 #define LAST_SEQ MyCache[CacheInx].sequence
65
66 /*
67  * Termcap names are matched only using the first two bytes.
68  * Ignore any extended names longer than two bytes, to avoid problems
69  * with legacy code which passes in parameters whose use is long forgotten.
70  */
71 #define ValidCap(cap) (((cap)[0] != '\0') && ((cap)[1] != '\0'))
72 #define SameCap(a,b)  (((a)[0] == (b)[0]) && ((a)[1] == (b)[1]))
73 #define ValidExt(ext) (ValidCap(ext) && (ext)[2] == '\0')
74
75 /***************************************************************************
76  *
77  * tgetent(bufp, term)
78  *
79  * In termcap, this function reads in the entry for terminal `term' into the
80  * buffer pointed to by bufp. It must be called before any of the functions
81  * below are called.
82  * In this terminfo emulation, tgetent() simply calls setupterm() (which
83  * does a bit more than tgetent() in termcap does), and returns its return
84  * value (1 if successful, 0 if no terminal with the given name could be
85  * found, or -1 if no terminal descriptions have been installed on the
86  * system).  The bufp argument is ignored.
87  *
88  ***************************************************************************/
89
90 NCURSES_EXPORT(int)
91 NCURSES_SP_NAME(tgetent) (NCURSES_SP_DCLx char *bufp, const char *name)
92 {
93     int rc = ERR;
94     int n;
95     bool found_cache = FALSE;
96 #ifdef USE_TERM_DRIVER
97     TERMINAL *termp = 0;
98 #endif
99
100     START_TRACE();
101     T((T_CALLED("tgetent()")));
102
103     TINFO_SETUP_TERM(&termp, (NCURSES_CONST char *) name,
104                      STDOUT_FILENO, &rc, TRUE);
105
106 #ifdef USE_TERM_DRIVER
107     if (termp == 0 ||
108         !((TERMINAL_CONTROL_BLOCK *) termp)->drv->isTerminfo)
109         returnCode(rc);
110 #endif
111
112     /*
113      * In general we cannot tell if the fixed sgr0 is still used by the
114      * caller, but if tgetent() is called with the same buffer, that is
115      * good enough, since the previous data would be invalidated by the
116      * current call.
117      *
118      * bufp may be a null pointer, e.g., GNU termcap.  That allocates data,
119      * which is good until the next tgetent() call.  The conventional termcap
120      * is inconvenient because of the fixed buffer size, but because it uses
121      * caller-supplied buffers, can have multiple terminal descriptions in
122      * use at a given time.
123      */
124     for (n = 0; n < TGETENT_MAX; ++n) {
125         bool same_result = (MyCache[n].last_used && MyCache[n].last_bufp == bufp);
126         if (same_result) {
127             CacheInx = n;
128             if (FIX_SGR0 != 0) {
129                 FreeAndNull(FIX_SGR0);
130             }
131             /*
132              * Also free the terminfo data that we loaded (much bigger leak).
133              */
134             if (LAST_TRM != 0 && LAST_TRM != TerminalOf(SP_PARM)) {
135                 TERMINAL *trm = LAST_TRM;
136                 NCURSES_SP_NAME(del_curterm) (NCURSES_SP_ARGx LAST_TRM);
137                 for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx)
138                     if (LAST_TRM == trm)
139                         LAST_TRM = 0;
140                 CacheInx = n;
141             }
142             found_cache = TRUE;
143             break;
144         }
145     }
146     if (!found_cache) {
147         int best = 0;
148
149         for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx) {
150             if (LAST_SEQ < MyCache[best].sequence) {
151                 best = CacheInx;
152             }
153         }
154         CacheInx = best;
155     }
156     LAST_TRM = TerminalOf(SP_PARM);
157     LAST_SEQ = ++CacheSeq;
158
159     PC = 0;
160     UP = 0;
161     BC = 0;
162     FIX_SGR0 = 0;               /* don't free it - application may still use */
163
164     if (rc == 1) {
165
166         if (cursor_left)
167             if ((backspaces_with_bs = (char) !strcmp(cursor_left, "\b")) == 0)
168                 backspace_if_not_bs = cursor_left;
169
170         /* we're required to export these */
171         if (pad_char != NULL)
172             PC = pad_char[0];
173         if (cursor_up != NULL)
174             UP = cursor_up;
175         if (backspace_if_not_bs != NULL)
176             BC = backspace_if_not_bs;
177
178         if ((FIX_SGR0 = _nc_trim_sgr0(&TerminalType(TerminalOf(SP_PARM))))
179             != 0) {
180             if (!strcmp(FIX_SGR0, exit_attribute_mode)) {
181                 if (FIX_SGR0 != exit_attribute_mode) {
182                     free(FIX_SGR0);
183                 }
184                 FIX_SGR0 = 0;
185             }
186         }
187         LAST_BUF = bufp;
188         LAST_USE = TRUE;
189
190         SetNoPadding(SP_PARM);
191         (void) NCURSES_SP_NAME(baudrate) (NCURSES_SP_ARG);      /* sets ospeed as a side-effect */
192
193 /* LINT_PREPRO
194 #if 0*/
195 #include <capdefaults.c>
196 /* LINT_PREPRO
197 #endif*/
198
199     }
200     returnCode(rc);
201 }
202
203 #if NCURSES_SP_FUNCS
204 NCURSES_EXPORT(int)
205 tgetent(char *bufp, const char *name)
206 {
207     return NCURSES_SP_NAME(tgetent) (CURRENT_SCREEN, bufp, name);
208 }
209 #endif
210
211 #if 0
212 static bool
213 same_tcname(const char *a, const char *b)
214 {
215     bool code = SameCap(a, b);
216     fprintf(stderr, "compare(%s,%s) %s\n", a, b, code ? "same" : "diff");
217     return code;
218 }
219
220 #else
221 #define same_tcname(a,b) SameCap(a,b)
222 #endif
223
224 /***************************************************************************
225  *
226  * tgetflag(str)
227  *
228  * Look up boolean termcap capability str and return its value (TRUE=1 if
229  * present, FALSE=0 if not).
230  *
231  ***************************************************************************/
232
233 NCURSES_EXPORT(int)
234 NCURSES_SP_NAME(tgetflag) (NCURSES_SP_DCLx NCURSES_CONST char *id)
235 {
236     int result = 0;             /* Solaris returns zero for missing flag */
237
238     T((T_CALLED("tgetflag(%p, %s)"), (void *) SP_PARM, id));
239     if (HasTInfoTerminal(SP_PARM) && ValidCap(id)) {
240         TERMTYPE2 *tp = &TerminalType(TerminalOf(SP_PARM));
241         struct name_table_entry const *entry_ptr;
242         int j = -1;
243
244         entry_ptr = _nc_find_type_entry(id, BOOLEAN, TRUE);
245         if (entry_ptr != 0) {
246             j = entry_ptr->nte_index;
247         }
248 #if NCURSES_XNAMES
249         else {
250             int i;
251             for_each_ext_boolean(i, tp) {
252                 const char *capname = ExtBoolname(tp, i, boolcodes);
253                 if (same_tcname(id, capname) && ValidExt(capname)) {
254                     j = i;
255                     break;
256                 }
257             }
258         }
259 #endif
260         if (j >= 0) {
261             /* note: setupterm forces invalid booleans to false */
262             result = tp->Booleans[j];
263         }
264     }
265     returnCode(result);
266 }
267
268 #if NCURSES_SP_FUNCS
269 NCURSES_EXPORT(int)
270 tgetflag(NCURSES_CONST char *id)
271 {
272     return NCURSES_SP_NAME(tgetflag) (CURRENT_SCREEN, id);
273 }
274 #endif
275
276 /***************************************************************************
277  *
278  * tgetnum(str)
279  *
280  * Look up numeric termcap capability str and return its value, or -1 if
281  * not given.
282  *
283  ***************************************************************************/
284
285 NCURSES_EXPORT(int)
286 NCURSES_SP_NAME(tgetnum) (NCURSES_SP_DCLx NCURSES_CONST char *id)
287 {
288     int result = ABSENT_NUMERIC;
289
290     T((T_CALLED("tgetnum(%p, %s)"), (void *) SP_PARM, id));
291     if (HasTInfoTerminal(SP_PARM) && ValidCap(id)) {
292         TERMTYPE2 *tp = &TerminalType(TerminalOf(SP_PARM));
293         struct name_table_entry const *entry_ptr;
294         int j = -1;
295
296         entry_ptr = _nc_find_type_entry(id, NUMBER, TRUE);
297         if (entry_ptr != 0) {
298             j = entry_ptr->nte_index;
299         }
300 #if NCURSES_XNAMES
301         else {
302             int i;
303             for_each_ext_number(i, tp) {
304                 const char *capname = ExtNumname(tp, i, numcodes);
305                 if (same_tcname(id, capname) && ValidExt(capname)) {
306                     j = i;
307                     break;
308                 }
309             }
310         }
311 #endif
312         if (j >= 0) {
313             if (VALID_NUMERIC(tp->Numbers[j]))
314                 result = tp->Numbers[j];
315         }
316     }
317     returnCode(result);
318 }
319
320 #if NCURSES_SP_FUNCS
321 NCURSES_EXPORT(int)
322 tgetnum(NCURSES_CONST char *id)
323 {
324     return NCURSES_SP_NAME(tgetnum) (CURRENT_SCREEN, id);
325 }
326 #endif
327
328 /***************************************************************************
329  *
330  * tgetstr(str, area)
331  *
332  * Look up string termcap capability str and return a pointer to its value,
333  * or NULL if not given.
334  *
335  ***************************************************************************/
336
337 NCURSES_EXPORT(char *)
338 NCURSES_SP_NAME(tgetstr) (NCURSES_SP_DCLx NCURSES_CONST char *id, char **area)
339 {
340     char *result = NULL;
341
342     T((T_CALLED("tgetstr(%s,%p)"), id, (void *) area));
343     if (HasTInfoTerminal(SP_PARM) && ValidCap(id)) {
344         TERMTYPE2 *tp = &TerminalType(TerminalOf(SP_PARM));
345         struct name_table_entry const *entry_ptr;
346         int j = -1;
347
348         entry_ptr = _nc_find_type_entry(id, STRING, TRUE);
349         if (entry_ptr != 0) {
350             j = entry_ptr->nte_index;
351         }
352 #if NCURSES_XNAMES
353         else {
354             int i;
355             for_each_ext_string(i, tp) {
356                 const char *capname = ExtStrname(tp, i, strcodes);
357                 if (same_tcname(id, capname) && ValidExt(capname)) {
358                     j = i;
359                     break;
360                 }
361             }
362         }
363 #endif
364         if (j >= 0) {
365             result = tp->Strings[j];
366             TR(TRACE_DATABASE, ("found match %d: %s", j, _nc_visbuf(result)));
367             /* setupterm forces canceled strings to null */
368             if (VALID_STRING(result)) {
369                 if (result == exit_attribute_mode
370                     && FIX_SGR0 != 0) {
371                     result = FIX_SGR0;
372                     TR(TRACE_DATABASE, ("altered to : %s", _nc_visbuf(result)));
373                 }
374                 if (area != 0
375                     && *area != 0) {
376                     _nc_STRCPY(*area, result, 1024);
377                     result = *area;
378                     *area += strlen(*area) + 1;
379                 }
380             }
381         }
382     }
383     returnPtr(result);
384 }
385
386 #if NCURSES_SP_FUNCS
387 NCURSES_EXPORT(char *)
388 tgetstr(NCURSES_CONST char *id, char **area)
389 {
390     return NCURSES_SP_NAME(tgetstr) (CURRENT_SCREEN, id, area);
391 }
392 #endif
393
394 #if NO_LEAKS
395 #undef CacheInx
396 #define CacheInx num
397 NCURSES_EXPORT(void)
398 _nc_tgetent_leak(TERMINAL *termp)
399 {
400     if (termp != 0) {
401         int num;
402         for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx) {
403             if (LAST_TRM == termp) {
404                 FreeIfNeeded(FIX_SGR0);
405                 if (LAST_TRM != 0) {
406                     LAST_TRM = 0;
407                 }
408                 break;
409             }
410         }
411     }
412 }
413
414 NCURSES_EXPORT(void)
415 _nc_tgetent_leaks(void)
416 {
417     int num;
418     for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx) {
419         if (LAST_TRM != 0) {
420             del_curterm(LAST_TRM);
421             _nc_tgetent_leak(LAST_TRM);
422         }
423     }
424 }
425 #endif