ncurses 6.1 - patch 20190810
[ncurses.git] / ncurses / tinfo / lib_termcap.c
index 8238b368eea3e581a2e6b23bda576ea9434e8005..07d73b689726b5e33468087a3cda49e2829d156c 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998 Free Software Foundation, Inc.                        *
+ * Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
 /****************************************************************************
  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
+ *     and: Thomas E. Dickey                        1996-on                 *
+ *     and: Juergen Pfeifer                                                 *
+ *                                                                          *
+ * some of the code in here was contributed by:                             *
+ * Magnus Bengtsson, d6mbeng@dtek.chalmers.se (Nov'93)                      *
+ * (but it has changed a lot)                                               *
  ****************************************************************************/
 
+#define __INTERNAL_CAPS_VISIBLE
 #include <curses.priv.h>
 
 #include <termcap.h>
 #include <tic.h>
+#include <ctype.h>
 
-#define __INTERNAL_CAPS_VISIBLE
-#include <term_entry.h>
+#ifndef CUR
+#define CUR SP_TERMTYPE
+#endif
 
-MODULE_ID("$Id: lib_termcap.c,v 1.29 1999/09/05 01:06:43 tom Exp $")
+MODULE_ID("$Id: lib_termcap.c,v 1.87 2018/04/07 21:11:15 tom Exp $")
 
-/*
-   some of the code in here was contributed by:
-   Magnus Bengtsson, d6mbeng@dtek.chalmers.se
-*/
+NCURSES_EXPORT_VAR(char *) UP = 0;
+NCURSES_EXPORT_VAR(char *) BC = 0;
 
-char *UP;
-char *BC;
+#define MyCache  _nc_globals.tgetent_cache
+#define CacheInx _nc_globals.tgetent_index
+#define CacheSeq _nc_globals.tgetent_sequence
+
+#define FIX_SGR0 MyCache[CacheInx].fix_sgr0
+#define LAST_TRM MyCache[CacheInx].last_term
+#define LAST_BUF MyCache[CacheInx].last_bufp
+#define LAST_USE MyCache[CacheInx].last_used
+#define LAST_SEQ MyCache[CacheInx].sequence
+
+/*
+ * Termcap names are matched only using the first two bytes.
+ * Ignore any extended names longer than two bytes, to avoid problems
+ * with legacy code which passes in parameters whose use is long forgotten.
+ */
+#define ValidCap(cap) (((cap)[0] != '\0') && ((cap)[1] != '\0'))
+#define SameCap(a,b)  (((a)[0] == (b)[0]) && ((a)[1] == (b)[1]))
+#define ValidExt(ext) (ValidCap(ext) && (ext)[2] == '\0')
 
 /***************************************************************************
  *
@@ -64,29 +87,111 @@ char *BC;
  *
  ***************************************************************************/
 
-int tgetent(char *bufp GCC_UNUSED, const char *name)
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(tgetent) (NCURSES_SP_DCLx char *bufp, const char *name)
 {
-int errcode;
+    int rc = ERR;
+    int n;
+    bool found_cache = FALSE;
+#ifdef USE_TERM_DRIVER
+    TERMINAL *termp = 0;
+#endif
+
+    START_TRACE();
+    T((T_CALLED("tgetent()")));
+
+    TINFO_SETUP_TERM(&termp, name, STDOUT_FILENO, &rc, TRUE);
+
+#ifdef USE_TERM_DRIVER
+    if (termp == 0 ||
+       !((TERMINAL_CONTROL_BLOCK *) termp)->drv->isTerminfo)
+       returnCode(rc);
+#endif
+
+    /*
+     * In general we cannot tell if the fixed sgr0 is still used by the
+     * caller, but if tgetent() is called with the same buffer, that is
+     * good enough, since the previous data would be invalidated by the
+     * current call.
+     *
+     * bufp may be a null pointer, e.g., GNU termcap.  That allocates data,
+     * which is good until the next tgetent() call.  The conventional termcap
+     * is inconvenient because of the fixed buffer size, but because it uses
+     * caller-supplied buffers, can have multiple terminal descriptions in
+     * use at a given time.
+     */
+    for (n = 0; n < TGETENT_MAX; ++n) {
+       bool same_result = (MyCache[n].last_used && MyCache[n].last_bufp == bufp);
+       if (same_result) {
+           CacheInx = n;
+           if (FIX_SGR0 != 0) {
+               FreeAndNull(FIX_SGR0);
+           }
+           /*
+            * Also free the terminfo data that we loaded (much bigger leak).
+            */
+           if (LAST_TRM != 0 && LAST_TRM != TerminalOf(SP_PARM)) {
+               TERMINAL *trm = LAST_TRM;
+               NCURSES_SP_NAME(del_curterm) (NCURSES_SP_ARGx LAST_TRM);
+               for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx)
+                   if (LAST_TRM == trm)
+                       LAST_TRM = 0;
+               CacheInx = n;
+           }
+           found_cache = TRUE;
+           break;
+       }
+    }
+    if (!found_cache) {
+       int best = 0;
 
-       T((T_CALLED("tgetent()")));
+       for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx) {
+           if (LAST_SEQ < MyCache[best].sequence) {
+               best = CacheInx;
+           }
+       }
+       CacheInx = best;
+    }
+    if (rc == 1) {
+       LAST_TRM = TerminalOf(SP_PARM);
+       LAST_SEQ = ++CacheSeq;
+    } else {
+       LAST_TRM = 0;
+    }
 
-       setupterm((NCURSES_CONST char *)name, STDOUT_FILENO, &errcode);
+    PC = 0;
+    UP = 0;
+    BC = 0;
+    FIX_SGR0 = 0;              /* don't free it - application may still use */
 
-       if (errcode == 1) {
+    if (rc == 1) {
 
-               if (cursor_left)
-                   if ((backspaces_with_bs = !strcmp(cursor_left, "\b")) == 0)
-                       backspace_if_not_bs = cursor_left;
+       if (cursor_left)
+           if ((backspaces_with_bs = (char) !strcmp(cursor_left, "\b")) == 0)
+               backspace_if_not_bs = cursor_left;
 
-               /* we're required to export these */
-               if (pad_char != NULL)
-                       PC = pad_char[0];
-               if (cursor_up != NULL)
-                       UP = cursor_up;
-               if (backspace_if_not_bs != NULL)
-                       BC = backspace_if_not_bs;
+       /* we're required to export these */
+       if (pad_char != NULL)
+           PC = pad_char[0];
+       if (cursor_up != NULL)
+           UP = cursor_up;
+       if (backspace_if_not_bs != NULL)
+           BC = backspace_if_not_bs;
+
+       if ((FIX_SGR0 = _nc_trim_sgr0(&TerminalType(TerminalOf(SP_PARM))))
+           != 0) {
+           if (!strcmp(FIX_SGR0, exit_attribute_mode)) {
+               if (FIX_SGR0 != exit_attribute_mode) {
+                   free(FIX_SGR0);
+               }
+               FIX_SGR0 = 0;
+           }
+       }
+       LAST_BUF = bufp;
+       LAST_USE = TRUE;
 
-               (void) baudrate();      /* sets ospeed as a side-effect */
+       SetNoPadding(SP_PARM);
+       (void) NCURSES_SP_NAME(baudrate) (NCURSES_SP_ARG);      /* sets ospeed as a side-effect */
 
 /* LINT_PREPRO
 #if 0*/
@@ -94,10 +199,31 @@ int errcode;
 /* LINT_PREPRO
 #endif*/
 
-       }
-       returnCode(errcode);
+    }
+    returnCode(rc);
 }
 
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+tgetent(char *bufp, const char *name)
+{
+    return NCURSES_SP_NAME(tgetent) (CURRENT_SCREEN, bufp, name);
+}
+#endif
+
+#if 0
+static bool
+same_tcname(const char *a, const char *b)
+{
+    bool code = SameCap(a, b);
+    fprintf(stderr, "compare(%s,%s) %s\n", a, b, code ? "same" : "diff");
+    return code;
+}
+
+#else
+#define same_tcname(a,b) SameCap(a,b)
+#endif
+
 /***************************************************************************
  *
  * tgetflag(str)
@@ -107,23 +233,48 @@ int errcode;
  *
  ***************************************************************************/
 
-int tgetflag(NCURSES_CONST char *id)
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(tgetflag) (NCURSES_SP_DCLx const char *id)
 {
-int i;
+    int result = 0;            /* Solaris returns zero for missing flag */
+
+    T((T_CALLED("tgetflag(%p, %s)"), (void *) SP_PARM, id));
+    if (HasTInfoTerminal(SP_PARM) && ValidCap(id)) {
+       TERMTYPE2 *tp = &TerminalType(TerminalOf(SP_PARM));
+       struct name_table_entry const *entry_ptr;
+       int j = -1;
 
-       T((T_CALLED("tgetflag(%s)"), id));
-       if (cur_term != 0) {
-           TERMTYPE *tp = &(cur_term->type);
-           for_each_boolean(i, tp) {
+       entry_ptr = _nc_find_type_entry(id, BOOLEAN, TRUE);
+       if (entry_ptr != 0) {
+           j = entry_ptr->nte_index;
+       }
+#if NCURSES_XNAMES
+       else {
+           int i;
+           for_each_ext_boolean(i, tp) {
                const char *capname = ExtBoolname(tp, i, boolcodes);
-               if (!strncmp(id, capname, 2)) {
-                   /* setupterm forces invalid booleans to false */
-                   returnCode(tp->Booleans[i]);
+               if (same_tcname(id, capname) && ValidExt(capname)) {
+                   j = i;
+                   break;
                }
            }
        }
-       returnCode(0);  /* Solaris does this */
+#endif
+       if (j >= 0) {
+           /* note: setupterm forces invalid booleans to false */
+           result = tp->Booleans[j];
+       }
+    }
+    returnCode(result);
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+tgetflag(const char *id)
+{
+    return NCURSES_SP_NAME(tgetflag) (CURRENT_SCREEN, id);
 }
+#endif
 
 /***************************************************************************
  *
@@ -134,25 +285,49 @@ int i;
  *
  ***************************************************************************/
 
-int tgetnum(NCURSES_CONST char *id)
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(tgetnum) (NCURSES_SP_DCLx const char *id)
 {
-int i;
+    int result = ABSENT_NUMERIC;
+
+    T((T_CALLED("tgetnum(%p, %s)"), (void *) SP_PARM, id));
+    if (HasTInfoTerminal(SP_PARM) && ValidCap(id)) {
+       TERMTYPE2 *tp = &TerminalType(TerminalOf(SP_PARM));
+       struct name_table_entry const *entry_ptr;
+       int j = -1;
 
-       T((T_CALLED("tgetnum(%s)"), id));
-       if (cur_term != 0) {
-           TERMTYPE *tp = &(cur_term->type);
-           for_each_number(i, tp) {
+       entry_ptr = _nc_find_type_entry(id, NUMBER, TRUE);
+       if (entry_ptr != 0) {
+           j = entry_ptr->nte_index;
+       }
+#if NCURSES_XNAMES
+       else {
+           int i;
+           for_each_ext_number(i, tp) {
                const char *capname = ExtNumname(tp, i, numcodes);
-               if (!strncmp(id, capname, 2)) {
-                   if (!VALID_NUMERIC(tp->Numbers[i]))
-                       return -1;
-                   returnCode(tp->Numbers[i]);
+               if (same_tcname(id, capname) && ValidExt(capname)) {
+                   j = i;
+                   break;
                }
            }
        }
-       returnCode(ERR);
+#endif
+       if (j >= 0) {
+           if (VALID_NUMERIC(tp->Numbers[j]))
+               result = tp->Numbers[j];
+       }
+    }
+    returnCode(result);
 }
 
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+tgetnum(const char *id)
+{
+    return NCURSES_SP_NAME(tgetnum) (CURRENT_SCREEN, id);
+}
+#endif
+
 /***************************************************************************
  *
  * tgetstr(str, area)
@@ -162,43 +337,92 @@ int i;
  *
  ***************************************************************************/
 
-char *tgetstr(NCURSES_CONST char *id, char **area)
+NCURSES_EXPORT(char *)
+NCURSES_SP_NAME(tgetstr) (NCURSES_SP_DCLx const char *id, char **area)
 {
-int i;
+    char *result = NULL;
+
+    T((T_CALLED("tgetstr(%s,%p)"), id, (void *) area));
+    if (HasTInfoTerminal(SP_PARM) && ValidCap(id)) {
+       TERMTYPE2 *tp = &TerminalType(TerminalOf(SP_PARM));
+       struct name_table_entry const *entry_ptr;
+       int j = -1;
 
-       T((T_CALLED("tgetstr(%s,%p)"), id, area));
-       if (cur_term != 0) {
-           TERMTYPE *tp = &(cur_term->type);
-           for_each_string(i, tp) {
+       entry_ptr = _nc_find_type_entry(id, STRING, TRUE);
+       if (entry_ptr != 0) {
+           j = entry_ptr->nte_index;
+       }
+#if NCURSES_XNAMES
+       else {
+           int i;
+           for_each_ext_string(i, tp) {
                const char *capname = ExtStrname(tp, i, strcodes);
-               T(("trying %s", capname));
-               if (!strncmp(id, capname, 2)) {
-                   T(("found match : %s", _nc_visbuf(tp->Strings[i])));
-                   /* setupterm forces cancelled strings to null */
-                   if (area != 0
-                    && *area != 0
-                    && VALID_STRING(tp->Strings[i])) {
-                       (void) strcpy(*area, tp->Strings[i]);
-                       *area += strlen(*area) + 1;
-                   }
-                   returnPtr(tp->Strings[i]);
+               if (same_tcname(id, capname) && ValidExt(capname)) {
+                   j = i;
+                   break;
+               }
+           }
+       }
+#endif
+       if (j >= 0) {
+           result = tp->Strings[j];
+           TR(TRACE_DATABASE, ("found match %d: %s", j, _nc_visbuf(result)));
+           /* setupterm forces canceled strings to null */
+           if (VALID_STRING(result)) {
+               if (result == exit_attribute_mode
+                   && FIX_SGR0 != 0) {
+                   result = FIX_SGR0;
+                   TR(TRACE_DATABASE, ("altered to : %s", _nc_visbuf(result)));
+               }
+               if (area != 0
+                   && *area != 0) {
+                   _nc_STRCPY(*area, result, 1024);
+                   result = *area;
+                   *area += strlen(*area) + 1;
                }
            }
        }
-       returnPtr(NULL);
+    }
+    returnPtr(result);
 }
 
-/*
- *     char *
- *     tgoto(string, x, y)
- *
- *     Retained solely for upward compatibility.  Note the intentional
- *     reversing of the last two arguments.
- *
- */
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(char *)
+tgetstr(const char *id, char **area)
+{
+    return NCURSES_SP_NAME(tgetstr) (CURRENT_SCREEN, id, area);
+}
+#endif
 
-char *tgoto(const char *string, int x, int y)
+#if NO_LEAKS
+#undef CacheInx
+#define CacheInx num
+NCURSES_EXPORT(void)
+_nc_tgetent_leak(TERMINAL *termp)
 {
-       T((T_CALLED("tgoto(%s,%d,%d)"), string, x, y));
-       returnPtr(tparm((NCURSES_CONST char *)string, y, x));
+    if (termp != 0) {
+       int num;
+       for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx) {
+           if (LAST_TRM == termp) {
+               FreeAndNull(FIX_SGR0);
+               if (LAST_TRM != 0) {
+                   LAST_TRM = 0;
+               }
+               break;
+           }
+       }
+    }
+}
+
+NCURSES_EXPORT(void)
+_nc_tgetent_leaks(void)
+{
+    int num;
+    for (CacheInx = 0; CacheInx < TGETENT_MAX; ++CacheInx) {
+       if (LAST_TRM != 0) {
+           del_curterm(LAST_TRM);
+           _nc_tgetent_leak(LAST_TRM);
+       }
+    }
 }
+#endif