]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - ncurses/tinfo/read_entry.c
ncurses 5.9 - patch 20130831
[ncurses.git] / ncurses / tinfo / read_entry.c
index 532e5a35ac94d9a891a0c633a619ee72bd800f75..0c825d537e4c6e8106515b001fccf4e8547a5c3d 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2007,2008 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2012,2013 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            *
 #include <hashed_db.h>
 
 #include <tic.h>
-#include <term_entry.h>
 
-MODULE_ID("$Id: read_entry.c,v 1.101 2008/07/12 20:23:13 tom Exp $")
+MODULE_ID("$Id: read_entry.c,v 1.125 2013/08/17 19:06:59 tom Exp $")
 
 #define TYPE_CALLOC(type,elts) typeCalloc(type, (unsigned)(elts))
 
-#if USE_DATABASE
+#if NCURSES_USE_DATABASE
 static void
 convert_shorts(char *buf, short *Numbers, int count)
 {
@@ -57,7 +56,7 @@ convert_shorts(char *buf, short *Numbers, int count)
        else if (IS_NEG2(buf + 2 * i))
            Numbers[i] = CANCELLED_NUMERIC;
        else
-           Numbers[i] = LOW_MSB(buf + 2 * i);
+           Numbers[i] = (short) LOW_MSB(buf + 2 * i);
        TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
     }
 }
@@ -99,31 +98,63 @@ fake_read(char *src, int *offset, int limit, char *dst, unsigned want)
 
     if (have > 0) {
        if ((int) want > have)
-           want = have;
-       memcpy(dst, src + *offset, want);
-       *offset += want;
+           want = (unsigned) have;
+       memcpy(dst, src + *offset, (size_t) want);
+       *offset += (int) want;
     } else {
        want = 0;
     }
     return (int) want;
 }
 
-#define Read(buf, count) fake_read(buffer, &offset, limit, buf, count)
+#define Read(buf, count) fake_read(buffer, &offset, limit, (char *) buf, (unsigned) count)
 
 #define read_shorts(buf, count) \
-       (Read(buf, (unsigned) (count)*2) == (int) (count)*2)
+       (Read(buf, (count)*2) == (int) (count)*2)
 
 #define even_boundary(value) \
     if ((value) % 2 != 0) Read(buf, 1)
 
+NCURSES_EXPORT(void)
+_nc_init_termtype(TERMTYPE *const tp)
+{
+    unsigned i;
+
+#if NCURSES_XNAMES
+    tp->num_Booleans = BOOLCOUNT;
+    tp->num_Numbers = NUMCOUNT;
+    tp->num_Strings = STRCOUNT;
+    tp->ext_Booleans = 0;
+    tp->ext_Numbers = 0;
+    tp->ext_Strings = 0;
+#endif
+    if (tp->Booleans == 0)
+       TYPE_MALLOC(NCURSES_SBOOL, BOOLCOUNT, tp->Booleans);
+    if (tp->Numbers == 0)
+       TYPE_MALLOC(short, NUMCOUNT, tp->Numbers);
+    if (tp->Strings == 0)
+       TYPE_MALLOC(char *, STRCOUNT, tp->Strings);
+
+    for_each_boolean(i, tp)
+       tp->Booleans[i] = FALSE;
+
+    for_each_number(i, tp)
+       tp->Numbers[i] = ABSENT_NUMERIC;
+
+    for_each_string(i, tp)
+       tp->Strings[i] = ABSENT_STRING;
+}
+
+/*
+ * Return TGETENT_YES if read, TGETENT_NO if not found or garbled.
+ */
 NCURSES_EXPORT(int)
 _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
-/* return 1 if read, 0 if not found or garbled */
 {
     int offset = 0;
     int name_size, bool_count, num_count, str_count, str_size;
     int i;
-    char buf[MAX_ENTRY_SIZE + 1];
+    char buf[MAX_ENTRY_SIZE + 2];
     char *string_table;
     unsigned want, have;
 
@@ -155,10 +186,10 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
        return (TGETENT_NO);
     }
 
-    want = str_size + name_size + 1;
+    want = (unsigned) (str_size + name_size + 1);
     if (str_size) {
        /* try to allocate space for the string table */
-       if (str_count * 2 >= (int) sizeof(buf)
+       if (str_count * 2 >= MAX_ENTRY_SIZE
            || (string_table = typeMalloc(char, want)) == 0) {
            return (TGETENT_NO);
        }
@@ -173,14 +204,14 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
     want = min(MAX_NAME_SIZE, (unsigned) name_size);
     ptr->str_table = string_table;
     ptr->term_names = string_table;
-    if ((have = Read(ptr->term_names, want)) != want) {
-       memset(ptr->term_names + have, 0, want - have);
+    if ((have = (unsigned) Read(ptr->term_names, want)) != want) {
+       memset(ptr->term_names + have, 0, (size_t) (want - have));
     }
     ptr->term_names[want] = '\0';
     string_table += (want + 1);
 
     if (have > MAX_NAME_SIZE)
-       offset = (have - MAX_NAME_SIZE);
+       offset = (int) (have - MAX_NAME_SIZE);
 
     /* grab the booleans */
     if ((ptr->Booleans = TYPE_CALLOC(NCURSES_SBOOL,
@@ -234,12 +265,12 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
        int ext_str_count = LOW_MSB(buf + 4);
        int ext_str_size = LOW_MSB(buf + 6);
        int ext_str_limit = LOW_MSB(buf + 8);
-       unsigned need = (ext_bool_count + ext_num_count + ext_str_count);
+       unsigned need = (unsigned) (ext_bool_count + ext_num_count + ext_str_count);
        int base = 0;
 
-       if (need >= sizeof(buf)
-           || ext_str_size >= (int) sizeof(buf)
-           || ext_str_limit >= (int) sizeof(buf)
+       if (need >= (MAX_ENTRY_SIZE / 2)
+           || ext_str_size >= MAX_ENTRY_SIZE
+           || ext_str_limit >= MAX_ENTRY_SIZE
            || ext_bool_count < 0
            || ext_num_count < 0
            || ext_str_count < 0
@@ -247,13 +278,13 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
            || ext_str_limit < 0)
            return (TGETENT_NO);
 
-       ptr->num_Booleans = BOOLCOUNT + ext_bool_count;
-       ptr->num_Numbers = NUMCOUNT + ext_num_count;
-       ptr->num_Strings = STRCOUNT + ext_str_count;
+       ptr->num_Booleans = UShort(BOOLCOUNT + ext_bool_count);
+       ptr->num_Numbers = UShort(NUMCOUNT + ext_num_count);
+       ptr->num_Strings = UShort(STRCOUNT + ext_str_count);
 
-       ptr->Booleans = typeRealloc(NCURSES_SBOOL, ptr->num_Booleans, ptr->Booleans);
-       ptr->Numbers = typeRealloc(short, ptr->num_Numbers, ptr->Numbers);
-       ptr->Strings = typeRealloc(char *, ptr->num_Strings, ptr->Strings);
+       TYPE_REALLOC(NCURSES_SBOOL, ptr->num_Booleans, ptr->Booleans);
+       TYPE_REALLOC(short, ptr->num_Numbers, ptr->Numbers);
+       TYPE_REALLOC(char *, ptr->num_Strings, ptr->Strings);
 
        TR(TRACE_DATABASE, ("extended header is %d/%d/%d(%d:%d)",
                            ext_bool_count, ext_num_count, ext_str_count,
@@ -261,7 +292,7 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
 
        TR(TRACE_DATABASE, ("READ %d extended-booleans @%d",
                            ext_bool_count, offset));
-       if ((ptr->ext_Booleans = ext_bool_count) != 0) {
+       if ((ptr->ext_Booleans = UShort(ext_bool_count)) != 0) {
            if (Read(ptr->Booleans + BOOLCOUNT, (unsigned)
                     ext_bool_count) != ext_bool_count)
                return (TGETENT_NO);
@@ -270,7 +301,7 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
 
        TR(TRACE_DATABASE, ("READ %d extended-numbers @%d",
                            ext_num_count, offset));
-       if ((ptr->ext_Numbers = ext_num_count) != 0) {
+       if ((ptr->ext_Numbers = UShort(ext_num_count)) != 0) {
            if (!read_shorts(buf, ext_num_count))
                return (TGETENT_NO);
            TR(TRACE_DATABASE, ("Before converting extended-numbers"));
@@ -278,22 +309,25 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
        }
 
        TR(TRACE_DATABASE, ("READ extended-offsets @%d", offset));
+       if ((unsigned) (ext_str_count + (int) need) >= (MAX_ENTRY_SIZE / 2))
+           return (TGETENT_NO);
        if ((ext_str_count || need)
-           && !read_shorts(buf, ext_str_count + need))
+           && !read_shorts(buf, ext_str_count + (int) need))
            return (TGETENT_NO);
 
        TR(TRACE_DATABASE, ("READ %d bytes of extended-strings @%d",
                            ext_str_limit, offset));
 
        if (ext_str_limit) {
-           if ((ptr->ext_str_table = typeMalloc(char, ext_str_limit)) == 0)
-                 return (TGETENT_NO);
+           ptr->ext_str_table = typeMalloc(char, (size_t) ext_str_limit);
+           if (ptr->ext_str_table == 0)
+               return (TGETENT_NO);
            if (Read(ptr->ext_str_table, (unsigned) ext_str_limit) != ext_str_limit)
                return (TGETENT_NO);
            TR(TRACE_DATABASE, ("first extended-string is %s", _nc_visbuf(ptr->ext_str_table)));
        }
 
-       if ((ptr->ext_Strings = ext_str_count) != 0) {
+       if ((ptr->ext_Strings = UShort(ext_str_count)) != 0) {
            TR(TRACE_DATABASE,
               ("Before computing extended-string capabilities str_count=%d, ext_str_count=%d",
                str_count, ext_str_count));
@@ -305,7 +339,7 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
                                    _nc_visbuf(ptr->Strings[i + str_count])));
                ptr->Strings[i + STRCOUNT] = ptr->Strings[i + str_count];
                if (VALID_STRING(ptr->Strings[i + STRCOUNT]))
-                   base += (strlen(ptr->Strings[i + STRCOUNT]) + 1);
+                   base += (int) (strlen(ptr->Strings[i + STRCOUNT]) + 1);
                TR(TRACE_DATABASE, ("... to    [%d] %s",
                                    i + STRCOUNT,
                                    _nc_visbuf(ptr->Strings[i + STRCOUNT])));
@@ -313,6 +347,8 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
        }
 
        if (need) {
+           if (ext_str_count >= (MAX_ENTRY_SIZE / 2))
+               return (TGETENT_NO);
            if ((ptr->ext_Names = TYPE_CALLOC(char *, need)) == 0)
                  return (TGETENT_NO);
            TR(TRACE_DATABASE,
@@ -324,17 +360,18 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
                            ext_str_limit, ptr->ext_str_table + base);
        }
 
-       T(("...done reading terminfo bool %d(%d) num %d(%d) str %d(%d)",
-          ptr->num_Booleans, ptr->ext_Booleans,
-          ptr->num_Numbers, ptr->ext_Numbers,
-          ptr->num_Strings, ptr->ext_Strings));
+       TR(TRACE_DATABASE,
+          ("...done reading terminfo bool %d(%d) num %d(%d) str %d(%d)",
+           ptr->num_Booleans, ptr->ext_Booleans,
+           ptr->num_Numbers, ptr->ext_Numbers,
+           ptr->num_Strings, ptr->ext_Strings));
 
        TR(TRACE_DATABASE, ("extend: num_Booleans:%d", ptr->num_Booleans));
     } else
 #endif /* NCURSES_XNAMES */
     {
-       T(("...done reading terminfo bool %d num %d str %d",
-          bool_count, num_count, str_count));
+       TR(TRACE_DATABASE, ("...done reading terminfo bool %d num %d str %d",
+                           bool_count, num_count, str_count));
 #if NCURSES_XNAMES
        TR(TRACE_DATABASE, ("normal: num_Booleans:%d", ptr->num_Booleans));
 #endif
@@ -362,30 +399,84 @@ NCURSES_EXPORT(int)
 _nc_read_file_entry(const char *const filename, TERMTYPE *ptr)
 /* return 1 if read, 0 if not found or garbled */
 {
-    int code, fd = -1;
+    FILE *fp = 0;
+    int code;
     int limit;
     char buffer[MAX_ENTRY_SIZE + 1];
 
     if (_nc_access(filename, R_OK) < 0
-       || (fd = open(filename, O_RDONLY | O_BINARY)) < 0) {
-       T(("cannot open terminfo %s (errno=%d)", filename, errno));
+       || (fp = fopen(filename, "rb")) == 0) {
+       TR(TRACE_DATABASE, ("cannot open terminfo %s (errno=%d)", filename, errno));
        code = TGETENT_NO;
     } else {
-       if ((limit = read(fd, buffer, sizeof(buffer))) > 0) {
+       if ((limit = (int) fread(buffer, sizeof(char), sizeof(buffer), fp))
+           > 0) {
 
-           T(("read terminfo %s", filename));
+           TR(TRACE_DATABASE, ("read terminfo %s", filename));
            if ((code = _nc_read_termtype(ptr, buffer, limit)) == TGETENT_NO) {
                _nc_free_termtype(ptr);
            }
        } else {
            code = TGETENT_NO;
        }
-       close(fd);
+       fclose(fp);
     }
 
     return (code);
 }
 
+#if USE_HASHED_DB
+/*
+ * Return if if we can build the filename of a ".db" file.
+ */
+static bool
+make_db_filename(char *filename, unsigned limit, const char *const path)
+{
+    static const char suffix[] = DBM_SUFFIX;
+
+    unsigned lens = sizeof(suffix) - 1;
+    unsigned size = strlen(path);
+    unsigned test = lens + size;
+    bool result = FALSE;
+
+    if (test < limit) {
+       if (size >= lens
+           && !strcmp(path + size - lens, suffix))
+           _nc_STRCPY(filename, path, limit);
+       else
+           _nc_SPRINTF(filename, _nc_SLIMIT(limit) "%s%s", path, suffix);
+       result = TRUE;
+    }
+    return result;
+}
+#endif
+
+/*
+ * Return true if we can build the name of a filesystem entry.
+ */
+static bool
+make_dir_filename(char *filename,
+                 unsigned limit,
+                 const char *const path,
+                 const char *name)
+{
+    bool result = FALSE;
+
+#if NCURSES_USE_TERMCAP
+    if (_nc_is_dir_path(path))
+#endif
+    {
+       unsigned need = (unsigned) (LEAF_LEN + 3 + strlen(path) + strlen(name));
+
+       if (need <= limit) {
+           _nc_SPRINTF(filename, _nc_SLIMIT(limit)
+                       "%s/" LEAF_FMT "/%s", path, *name, name);
+           result = TRUE;
+       }
+    }
+    return result;
+}
+
 /*
  * Build a terminfo pathname and try to read the data.  Returns TGETENT_YES on
  * success, TGETENT_NO on failure.
@@ -397,107 +488,82 @@ _nc_read_tic_entry(char *filename,
                   const char *name,
                   TERMTYPE *const tp)
 {
-    int result = TGETENT_NO;
-
-    /*
-     * If we are looking in a directory, assume the entry is a file under that,
-     * according to the normal rules.
-     *
-     * FIXME - add caseless-filename fixup.
-     */
-    if (_nc_is_dir_path(path)) {
-       unsigned need = 4 + strlen(path) + strlen(name);
+    int code = TGETENT_NO;
 
-       if (need <= limit) {
-           (void) sprintf(filename, "%s/" LEAF_FMT "/%s", path, *name, name);
-           result = _nc_read_file_entry(filename, tp);
-       }
-    }
 #if USE_HASHED_DB
-    else {
-       static const char suffix[] = DBM_SUFFIX;
-       DB *capdbp;
-       unsigned lens = sizeof(suffix) - 1;
-       unsigned size = strlen(path);
-       unsigned need = lens + size;
-
-       if (need <= limit) {
-           if (size >= lens
-               && !strcmp(path + size - lens, suffix))
-               (void) strcpy(filename, path);
-           else
-               (void) sprintf(filename, "%s%s", path, suffix);
+    DB *capdbp;
+
+    if (make_db_filename(filename, limit, path)
+       && (capdbp = _nc_db_open(filename, FALSE)) != 0) {
+
+       DBT key, data;
+       int reccnt = 0;
+       char *save = strdup(name);
+
+       memset(&key, 0, sizeof(key));
+       key.data = save;
+       key.size = strlen(save);
+
+       /*
+        * This lookup could return termcap data, which we do not want.  We are
+        * looking for compiled (binary) terminfo data.
+        *
+        * cgetent uses a two-level lookup.  On the first it uses the given
+        * name to return a record containing only the aliases for an entry. 
+        * On the second (using that list of aliases as a key), it returns the
+        * content of the terminal description.  We expect second lookup to
+        * return data beginning with the same set of aliases.
+        *
+        * For compiled terminfo, the list of aliases in the second case will
+        * be null-terminated.  A termcap entry will not be, and will run on
+        * into the description.  So we can easily distinguish between the two
+        * (source/binary) by checking the lengths.
+        */
+       while (_nc_db_get(capdbp, &key, &data) == 0) {
+           int used = data.size - 1;
+           char *have = (char *) data.data;
+
+           if (*have++ == 0) {
+               if (data.size > key.size
+                   && IS_TIC_MAGIC(have)) {
+                   code = _nc_read_termtype(tp, have, used);
+                   if (code == TGETENT_NO) {
+                       _nc_free_termtype(tp);
+                   }
+               }
+               break;
+           }
 
            /*
-            * It would be nice to optimize the dbopen/close activity, as
-            * done in the cgetent implementation for tc= clauses.  However,
-            * since we support multiple database locations, we cannot do
-            * that.
+            * Just in case we have a corrupt database, do not waste time with
+            * it.
             */
-           if ((capdbp = _nc_db_open(filename, FALSE)) != 0) {
-               DBT key, data;
-               int reccnt = 0;
-               char *save = strdup(name);
-
-               memset(&key, 0, sizeof(key));
-               key.data = save;
-               key.size = strlen(save);
-
-               /*
-                * This lookup could return termcap data, which we do not want. 
-                * We are looking for compiled (binary) terminfo data.
-                *
-                * cgetent uses a two-level lookup.  On the first it uses the
-                * given name to return a record containing only the aliases
-                * for an entry.  On the second (using that list of aliases as
-                * a key), it returns the content of the terminal description. 
-                * We expect second lookup to return data beginning with the
-                * same set of aliases.
-                *
-                * For compiled terminfo, the list of aliases in the second
-                * case will be null-terminated.  A termcap entry will not be,
-                * and will run on into the description.  So we can easily
-                * distinguish between the two (source/binary) by checking the
-                * lengths.
-                */
-               while (_nc_db_get(capdbp, &key, &data) == 0) {
-                   int used = data.size - 1;
-                   char *have = (char *) data.data;
-
-                   if (*have++ == 0) {
-                       if (data.size > key.size
-                           && IS_TIC_MAGIC(have)) {
-                           result = _nc_read_termtype(tp, have, used);
-                           if (result == TGETENT_NO) {
-                               _nc_free_termtype(tp);
-                           }
-                       }
-                       break;
-                   }
-
-                   /*
-                    * Just in case we have a corrupt database, do not waste
-                    * time with it.
-                    */
-                   if (++reccnt >= 3)
-                       break;
-
-                   /*
-                    * Prepare for the second level.
-                    */
-                   key.data = have;
-                   key.size = used;
-               }
+           if (++reccnt >= 3)
+               break;
 
-               _nc_db_close(capdbp);
-               free(save);
-           }
+           /*
+            * Prepare for the second level.
+            */
+           key.data = have;
+           key.size = used;
        }
+
+       free(save);
+    } else                     /* may be either filesystem or flat file */
+#endif
+    if (make_dir_filename(filename, limit, path, name)) {
+       code = _nc_read_file_entry(filename, tp);
+    }
+#if NCURSES_USE_TERMCAP
+    else if (code != TGETENT_YES) {
+       code = _nc_read_termcap_entry(name, tp);
+       _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
+                   "%.*s", PATH_MAX - 1, _nc_get_source());
     }
 #endif
-    return result;
+    return code;
 }
-#endif /* USE_DATABASE */
+#endif /* NCURSES_USE_DATABASE */
 
 /*
  *     _nc_read_entry(char *name, char *filename, TERMTYPE *tp)
@@ -513,30 +579,35 @@ _nc_read_entry(const char *const name, char *const filename, TERMTYPE *const tp)
 {
     int code = TGETENT_NO;
 
+    _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
+               "%.*s", PATH_MAX - 1, name);
+
     if (strlen(name) == 0
        || strcmp(name, ".") == 0
        || strcmp(name, "..") == 0
        || _nc_pathlast(name) != 0
        || strchr(name, NCURSES_PATHSEP) != 0) {
-       T(("illegal or missing entry name '%s'", name));
+       TR(TRACE_DATABASE, ("illegal or missing entry name '%s'", name));
     } else {
-#if USE_DATABASE
-       DBDIRS state = dbdTIC;
-       int offset = 0;
+#if NCURSES_USE_DATABASE
+       DBDIRS state;
+       int offset;
        const char *path;
 
+       _nc_first_db(&state, &offset);
        while ((path = _nc_next_db(&state, &offset)) != 0) {
+           TR(TRACE_DATABASE, ("_nc_read_tic_entry path=%s, name=%s", path, name));
            code = _nc_read_tic_entry(filename, PATH_MAX, path, name, tp);
            if (code == TGETENT_YES) {
                _nc_last_db();
                break;
            }
        }
-#endif
-#if USE_TERMCAP
+#elif NCURSES_USE_TERMCAP
        if (code != TGETENT_YES) {
            code = _nc_read_termcap_entry(name, tp);
-           sprintf(filename, "%.*s", PATH_MAX - 1, _nc_get_source());
+           _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
+                       "%.*s", PATH_MAX - 1, _nc_get_source());
        }
 #endif
     }