ncurses 5.9 - patch 20120721
[ncurses.git] / progs / toe.c
index 91777db724247f0de89d5e6c803fa63ceb7efe48..4924d2c1cccf32da6266f958d49c028aae7965a8 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2002,2005 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2011,2012 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            *
 
 /*
  *     toe.c --- table of entries report generator
- *
  */
 
 #include <progs.priv.h>
 
 #include <sys/stat.h>
 
-#include <dump_entry.h>
+#if USE_HASHED_DB
+#include <hashed_db.h>
+#endif
 
-MODULE_ID("$Id: toe.c,v 1.29 2005/09/25 00:39:43 tom Exp $")
+MODULE_ID("$Id: toe.c,v 1.68 2012/07/21 22:55:59 tom Exp $")
 
 #define isDotname(name) (!strcmp(name, ".") || !strcmp(name, ".."))
 
+typedef struct {
+    int db_index;
+    unsigned long checksum;
+    char *term_name;
+    char *description;
+} TERMDATA;
+
 const char *_nc_progname;
 
-static int typelist(int eargc, char *eargv[], bool,
-                   void (*)(const char *, TERMTYPE *));
-static void deschook(const char *, TERMTYPE *);
+static TERMDATA *ptr_termdata; /* array of terminal data */
+static size_t use_termdata;    /* actual usage in ptr_termdata[] */
+static size_t len_termdata;    /* allocated size of ptr_termdata[] */
 
 #if NO_LEAKS
 #undef ExitProgram
+static void ExitProgram(int code) GCC_NORETURN;
 static void
-ExitProgram(int code) GCC_NORETURN;
-     static void ExitProgram(int code)
+ExitProgram(int code)
 {
     _nc_free_entries(_nc_head);
-    _nc_leaks_dump_entry();
-    _nc_free_and_exit(code);
+    _nc_free_tic(code);
 }
 #endif
 
-static bool
-is_a_file(char *path)
+static void failed(const char *) GCC_NORETURN;
+
+static void
+failed(const char *msg)
+{
+    perror(msg);
+    ExitProgram(EXIT_FAILURE);
+}
+
+static char *
+strmalloc(const char *value)
 {
-    struct stat sb;
-    return (stat(path, &sb) == 0
-           && (sb.st_mode & S_IFMT) == S_IFREG);
+    char *result = strdup(value);
+    if (result == 0) {
+       failed("strmalloc");
+    }
+    return result;
 }
 
+static TERMDATA *
+new_termdata(void)
+{
+    size_t want = use_termdata + 1;
+
+    if (want >= len_termdata) {
+       len_termdata = (2 * want) + 10;
+       ptr_termdata = typeRealloc(TERMDATA, len_termdata, ptr_termdata);
+    }
+
+    return ptr_termdata + use_termdata++;
+}
+
+static int
+compare_termdata(const void *a, const void *b)
+{
+    const TERMDATA *p = (const TERMDATA *) a;
+    const TERMDATA *q = (const TERMDATA *) b;
+    int result = strcmp(p->term_name, q->term_name);
+
+    if (result == 0) {
+       result = (p->db_index - q->db_index);
+    }
+    return result;
+}
+
+/*
+ * Sort the array of TERMDATA and print it.  If more than one database is being
+ * reported, add a column to show which database has a given entry.
+ */
+static void
+show_termdata(int eargc, char **eargv)
+{
+    int j, k;
+    size_t n;
+
+    if (use_termdata) {
+       if (eargc > 1) {
+           for (j = 0; j < eargc; ++j) {
+               for (k = 0; k <= j; ++k) {
+                   printf("--");
+               }
+               printf("> ");
+               printf("%s\n", eargv[j]);
+           }
+       }
+       if (use_termdata > 1)
+           qsort(ptr_termdata, use_termdata, sizeof(TERMDATA), compare_termdata);
+       for (n = 0; n < use_termdata; ++n) {
+
+           /*
+            * If there is more than one database, show how they differ.
+            */
+           if (eargc > 1) {
+               unsigned long check = 0;
+               k = 0;
+               for (;;) {
+                   for (; k < ptr_termdata[n].db_index; ++k) {
+                       printf("--");
+                   }
+
+                   /*
+                    * If this is the first entry, or its checksum differs
+                    * from the first entry's checksum, print "*". Otherwise
+                    * it looks enough like a duplicate to print "+".
+                    */
+                   printf("%c-", ((check == 0
+                                   || (check != ptr_termdata[n].checksum))
+                                  ? '*'
+                                  : '+'));
+                   check = ptr_termdata[n].checksum;
+
+                   ++k;
+                   if ((n + 1) >= use_termdata
+                       || strcmp(ptr_termdata[n].term_name,
+                                 ptr_termdata[n + 1].term_name)) {
+                       break;
+                   }
+                   ++n;
+               }
+               for (; k < eargc; ++k) {
+                   printf("--");
+               }
+               printf(":\t");
+           }
+
+           (void) printf("%-10s\t%s\n",
+                         ptr_termdata[n].term_name,
+                         ptr_termdata[n].description);
+       }
+    }
+}
+
+static void
+free_termdata(void)
+{
+    if (ptr_termdata != 0) {
+       while (use_termdata != 0) {
+           --use_termdata;
+           free(ptr_termdata[use_termdata].term_name);
+           free(ptr_termdata[use_termdata].description);
+       }
+       free(ptr_termdata);
+       ptr_termdata = 0;
+    }
+    use_termdata = 0;
+    len_termdata = 0;
+}
+
+static char **
+allocArgv(size_t count)
+{
+    char **result = typeCalloc(char *, count + 1);
+    if (result == 0)
+       failed("realloc eargv");
+
+    assert(result != 0);
+    return result;
+}
+
+static void
+freeArgv(char **argv)
+{
+    if (argv) {
+       int count = 0;
+       while (argv[count]) {
+           free(argv[count++]);
+       }
+       free(argv);
+    }
+}
+
+#if USE_HASHED_DB
 static bool
-is_a_directory(char *path)
+make_db_name(char *dst, const char *src, unsigned limit)
+{
+    static const char suffix[] = DBM_SUFFIX;
+
+    bool result = FALSE;
+    unsigned lens = sizeof(suffix) - 1;
+    unsigned size = strlen(src);
+    unsigned need = lens + size;
+
+    if (need <= limit) {
+       if (size >= lens
+           && !strcmp(src + size - lens, suffix)) {
+           _nc_STRCPY(dst, src, PATH_MAX);
+       } else {
+           _nc_SPRINTF(dst, _nc_SLIMIT(PATH_MAX) "%s%s", src, suffix);
+       }
+       result = TRUE;
+    }
+    return result;
+}
+#endif
+
+typedef void (DescHook) (int /* db_index */ ,
+                        int /* db_limit */ ,
+                        const char * /* term_name */ ,
+                        TERMTYPE * /* term */ );
+
+static const char *
+term_description(TERMTYPE *tp)
+{
+    const char *desc;
+
+    if ((desc = strrchr(tp->term_names, '|')) == 0 || *++desc == '\0')
+       desc = "(No description)";
+
+    return desc;
+}
+
+/* display a description for the type */
+static void
+deschook(int db_index, int db_limit, const char *term_name, TERMTYPE *tp)
+{
+    (void) db_index;
+    (void) db_limit;
+    (void) printf("%-10s\t%s\n", term_name, term_description(tp));
+}
+
+static unsigned long
+string_sum(const char *value)
+{
+    unsigned long result = 0;
+
+    if ((intptr_t) value == (intptr_t) (-1)) {
+       result = ~result;
+    } else if (value) {
+       while (*value) {
+           result += UChar(*value);
+           ++value;
+       }
+    }
+    return result;
+}
+
+static unsigned long
+checksum_of(TERMTYPE *tp)
+{
+    unsigned long result = string_sum(tp->term_names);
+    unsigned i;
+
+    for (i = 0; i < NUM_BOOLEANS(tp); i++) {
+       result += (unsigned long) (tp->Booleans[i]);
+    }
+    for (i = 0; i < NUM_NUMBERS(tp); i++) {
+       result += (unsigned long) (tp->Numbers[i]);
+    }
+    for (i = 0; i < NUM_STRINGS(tp); i++) {
+       result += string_sum(tp->Strings[i]);
+    }
+    return result;
+}
+
+/* collect data, to sort before display */
+static void
+sorthook(int db_index, int db_limit, const char *term_name, TERMTYPE *tp)
+{
+    TERMDATA *data = new_termdata();
+
+    data->db_index = db_index;
+    data->checksum = ((db_limit > 1) ? checksum_of(tp) : 0);
+    data->term_name = strmalloc(term_name);
+    data->description = strmalloc(term_description(tp));
+}
+
+#if USE_TERMCAP
+static void
+show_termcap(int db_index, int db_limit, char *buffer, DescHook hook)
 {
-    struct stat sb;
-    return (stat(path, &sb) == 0
-           && (sb.st_mode & S_IFMT) == S_IFDIR);
+    TERMTYPE data;
+    char *next = strchr(buffer, ':');
+    char *last;
+    char *list = buffer;
+
+    if (next)
+       *next = '\0';
+
+    last = strrchr(buffer, '|');
+    if (last)
+       ++last;
+
+    memset(&data, 0, sizeof(data));
+    data.term_names = strmalloc(buffer);
+    while ((next = strtok(list, "|")) != 0) {
+       if (next != last)
+           hook(db_index, db_limit, next, &data);
+       list = 0;
+    }
+    free(data.term_names);
 }
+#endif
 
+#if USE_DATABASE
 static char *
-get_directory(char *path)
+copy_entryname(DIRENT * src)
 {
-    if (path != 0) {
-       if (!is_a_directory(path)
-           || access(path, R_OK | X_OK) != 0)
-           path = 0;
+    size_t len = NAMLEN(src);
+    char *result = malloc(len + 1);
+    if (result == 0)
+       failed("copy entryname");
+    memcpy(result, src->d_name, len);
+    result[len] = '\0';
+
+    return result;
+}
+#endif
+
+static int
+typelist(int eargc, char *eargv[],
+        bool verbosity,
+        DescHook hook)
+/* apply a function to each entry in given terminfo directories */
+{
+    int i;
+
+    for (i = 0; i < eargc; i++) {
+#if USE_DATABASE
+       if (_nc_is_dir_path(eargv[i])) {
+           char *cwd_buf = 0;
+           DIR *termdir;
+           DIRENT *subdir;
+
+           if ((termdir = opendir(eargv[i])) == 0) {
+               (void) fflush(stdout);
+               (void) fprintf(stderr,
+                              "%s: can't open terminfo directory %s\n",
+                              _nc_progname, eargv[i]);
+               continue;
+           }
+
+           if (verbosity)
+               (void) printf("#\n#%s:\n#\n", eargv[i]);
+
+           while ((subdir = readdir(termdir)) != 0) {
+               size_t cwd_len;
+               char *name_1;
+               DIR *entrydir;
+               DIRENT *entry;
+
+               name_1 = copy_entryname(subdir);
+               if (isDotname(name_1)) {
+                   free(name_1);
+                   continue;
+               }
+
+               cwd_len = NAMLEN(subdir) + strlen(eargv[i]) + 3;
+               cwd_buf = typeRealloc(char, cwd_len, cwd_buf);
+               if (cwd_buf == 0)
+                   failed("realloc cwd_buf");
+
+               assert(cwd_buf != 0);
+
+               _nc_SPRINTF(cwd_buf, _nc_SLIMIT(cwd_len)
+                           "%s/%s/", eargv[i], name_1);
+               free(name_1);
+
+               if (chdir(cwd_buf) != 0)
+                   continue;
+
+               entrydir = opendir(".");
+               if (entrydir == 0) {
+                   perror(cwd_buf);
+                   continue;
+               }
+               while ((entry = readdir(entrydir)) != 0) {
+                   char *name_2;
+                   TERMTYPE lterm;
+                   char *cn;
+                   int status;
+
+                   name_2 = copy_entryname(entry);
+                   if (isDotname(name_2) || !_nc_is_file_path(name_2)) {
+                       free(name_2);
+                       continue;
+                   }
+
+                   status = _nc_read_file_entry(name_2, &lterm);
+                   if (status <= 0) {
+                       (void) fflush(stdout);
+                       (void) fprintf(stderr,
+                                      "%s: couldn't open terminfo file %s.\n",
+                                      _nc_progname, name_2);
+                       free(name_2);
+                       return (EXIT_FAILURE);
+                   }
+
+                   /* only visit things once, by primary name */
+                   cn = _nc_first_name(lterm.term_names);
+                   if (!strcmp(cn, name_2)) {
+                       /* apply the selected hook function */
+                       hook(i, eargc, cn, &lterm);
+                   }
+                   _nc_free_termtype(&lterm);
+                   free(name_2);
+               }
+               closedir(entrydir);
+           }
+           closedir(termdir);
+           if (cwd_buf != 0)
+               free(cwd_buf);
+           continue;
+       }
+#if USE_HASHED_DB
+       else {
+           DB *capdbp;
+           char filename[PATH_MAX];
+
+           if (verbosity)
+               (void) printf("#\n#%s:\n#\n", eargv[i]);
+
+           if (make_db_name(filename, eargv[i], sizeof(filename))) {
+               if ((capdbp = _nc_db_open(filename, FALSE)) != 0) {
+                   DBT key, data;
+                   int code;
+
+                   code = _nc_db_first(capdbp, &key, &data);
+                   while (code == 0) {
+                       TERMTYPE lterm;
+                       int used;
+                       char *have;
+                       char *cn;
+
+                       if (_nc_db_have_data(&key, &data, &have, &used)) {
+                           if (_nc_read_termtype(&lterm, have, used) > 0) {
+                               /* only visit things once, by primary name */
+                               cn = _nc_first_name(lterm.term_names);
+                               /* apply the selected hook function */
+                               hook(i, eargc, cn, &lterm);
+                               _nc_free_termtype(&lterm);
+                           }
+                       }
+                       code = _nc_db_next(capdbp, &key, &data);
+                   }
+
+                   _nc_db_close(capdbp);
+                   continue;
+               }
+           }
+       }
+#endif
+#endif
+#if USE_TERMCAP
+#if HAVE_BSD_CGETENT
+       {
+           CGETENT_CONST char *db_array[2];
+           char *buffer = 0;
+
+           if (verbosity)
+               (void) printf("#\n#%s:\n#\n", eargv[i]);
+
+           db_array[0] = eargv[i];
+           db_array[1] = 0;
+
+           if (cgetfirst(&buffer, db_array) > 0) {
+               show_termcap(i, eargc, buffer, hook);
+               free(buffer);
+               while (cgetnext(&buffer, db_array) > 0) {
+                   show_termcap(i, eargc, buffer, hook);
+                   free(buffer);
+               }
+               cgetclose();
+               continue;
+           }
+       }
+#else
+       /* scan termcap text-file only */
+       if (_nc_is_file_path(eargv[i])) {
+           char buffer[2048];
+           FILE *fp;
+
+           if (verbosity)
+               (void) printf("#\n#%s:\n#\n", eargv[i]);
+
+           if ((fp = fopen(eargv[i], "r")) != 0) {
+               while (fgets(buffer, sizeof(buffer), fp) != 0) {
+                   if (*buffer == '#')
+                       continue;
+                   if (isspace(*buffer))
+                       continue;
+                   show_termcap(i, eargc, buffer, hook);
+               }
+               fclose(fp);
+           }
+       }
+#endif
+#endif
+    }
+
+    if (hook == sorthook) {
+       show_termdata(eargc, eargv);
+       free_termdata();
     }
-    return path;
+
+    return (EXIT_SUCCESS);
+}
+
+static void
+usage(void)
+{
+    (void) fprintf(stderr, "usage: %s [-ahsuUV] [-v n] [file...]\n", _nc_progname);
+    ExitProgram(EXIT_FAILURE);
 }
 
 int
 main(int argc, char *argv[])
 {
+    bool all_dirs = FALSE;
     bool direct_dependencies = FALSE;
     bool invert_dependencies = FALSE;
     bool header = FALSE;
-    int i, c;
+    char *report_file = 0;
+    unsigned i;
     int code;
+    int this_opt, last_opt = '?';
+    unsigned v_opt = 0;
+    DescHook *hook = deschook;
 
     _nc_progname = _nc_rootname(argv[0]);
 
-    while ((c = getopt(argc, argv, "huv:UV")) != EOF)
-       switch (c) {
+    while ((this_opt = getopt(argc, argv, "0123456789ahsu:vU:V")) != -1) {
+       /* handle optional parameter */
+       if (isdigit(this_opt)) {
+           switch (last_opt) {
+           case 'v':
+               v_opt = (unsigned) (this_opt - '0');
+               break;
+           default:
+               if (isdigit(last_opt))
+                   v_opt *= 10;
+               else
+                   v_opt = 0;
+               v_opt += (unsigned) (this_opt - '0');
+               last_opt = this_opt;
+           }
+           continue;
+       }
+       switch (this_opt) {
+       case 'a':
+           all_dirs = TRUE;
+           break;
        case 'h':
            header = TRUE;
            break;
+       case 's':
+           hook = sorthook;
+           break;
        case 'u':
            direct_dependencies = TRUE;
+           report_file = optarg;
            break;
        case 'v':
-           set_trace_level(atoi(optarg));
+           v_opt = 1;
            break;
        case 'U':
            invert_dependencies = TRUE;
+           report_file = optarg;
            break;
        case 'V':
            puts(curses_version());
            ExitProgram(EXIT_SUCCESS);
        default:
-           (void) fprintf(stderr, "usage: toe [-huUV] [-v n] [file...]\n");
-           ExitProgram(EXIT_FAILURE);
+           usage();
        }
+    }
+    set_trace_level(v_opt);
 
-    if (direct_dependencies || invert_dependencies) {
-       if (freopen(argv[optind], "r", stdin) == 0) {
+    if (report_file != 0) {
+       if (freopen(report_file, "r", stdin) == 0) {
            (void) fflush(stdout);
-           fprintf(stderr, "%s: can't open %s\n", _nc_progname, argv[optind]);
+           fprintf(stderr, "%s: can't open %s\n", _nc_progname, report_file);
            ExitProgram(EXIT_FAILURE);
        }
 
        /* parse entries out of the source file */
-       _nc_set_source(argv[optind]);
+       _nc_set_source(report_file);
        _nc_read_entry_source(stdin, 0, FALSE, FALSE, NULLHOOK);
     }
 
@@ -143,7 +637,7 @@ main(int argc, char *argv[])
 
        for_entry_list(qp) {
            if (qp->nuses) {
-               int j;
+               unsigned j;
 
                (void) printf("%s:", _nc_first_name(qp->tterm.term_names));
                for (j = 0; j < qp->nuses; j++)
@@ -187,122 +681,49 @@ main(int argc, char *argv[])
      * If we get this far, user wants a simple terminal type listing.
      */
     if (optind < argc) {
-       code = typelist(argc - optind, argv + optind, header, deschook);
-    } else {
-       char *home, *eargv[3];
-       char personal[PATH_MAX];
-       int j;
-
-       j = 0;
-       if ((eargv[j] = get_directory(getenv("TERMINFO"))) != 0) {
-           j++;
-       } else {
-           if ((home = getenv("HOME")) != 0) {
-               (void) sprintf(personal, PRIVATE_INFO, home);
-               if ((eargv[j] = get_directory(personal)) != 0)
-                   j++;
+       code = typelist(argc - optind, argv + optind, header, hook);
+    } else if (all_dirs) {
+       DBDIRS state;
+       int offset;
+       int pass;
+       const char *path;
+       char **eargv = 0;
+
+       code = EXIT_FAILURE;
+       for (pass = 0; pass < 2; ++pass) {
+           size_t count = 0;
+
+           _nc_first_db(&state, &offset);
+           while ((path = _nc_next_db(&state, &offset)) != 0) {
+               if (pass) {
+                   eargv[count] = strmalloc(path);
+               }
+               ++count;
+           }
+           if (!pass) {
+               eargv = allocArgv(count);
+           } else {
+               code = typelist((int) count, eargv, header, hook);
+               freeArgv(eargv);
            }
-           if ((eargv[j] = get_directory(strcpy(personal, TERMINFO))) != 0)
-               j++;
        }
-       eargv[j] = 0;
-
-       code = typelist(j, eargv, header, deschook);
-    }
-
-    ExitProgram(code);
-}
-
-static void
-deschook(const char *cn, TERMTYPE * tp)
-/* display a description for the type */
-{
-    const char *desc;
-
-    if ((desc = strrchr(tp->term_names, '|')) == 0)
-       desc = "(No description)";
-    else
-       ++desc;
-
-    (void) printf("%-10s\t%s\n", cn, desc);
-}
-
-static int
-typelist(int eargc, char *eargv[],
-        bool verbosity,
-        void (*hook) (const char *, TERMTYPE * tp))
-/* apply a function to each entry in given terminfo directories */
-{
-    int i;
-
-    for (i = 0; i < eargc; i++) {
-       DIR *termdir;
-       DIRENT *subdir;
-
-       if ((termdir = opendir(eargv[i])) == 0) {
-           (void) fflush(stdout);
-           (void) fprintf(stderr,
-                          "%s: can't open terminfo directory %s\n",
-                          _nc_progname, eargv[i]);
-           return (EXIT_FAILURE);
-       } else if (verbosity)
-           (void) printf("#\n#%s:\n#\n", eargv[i]);
-
-       while ((subdir = readdir(termdir)) != 0) {
-           size_t len = NAMLEN(subdir);
-           char buf[PATH_MAX];
-           char name_1[PATH_MAX];
-           DIR *entrydir;
-           DIRENT *entry;
-
-           strncpy(name_1, subdir->d_name, len)[len] = '\0';
-           if (isDotname(name_1))
-               continue;
-
-           (void) sprintf(buf, "%s/%s/", eargv[i], name_1);
-           if (chdir(buf) != 0)
-               continue;
-
-           entrydir = opendir(".");
-           while ((entry = readdir(entrydir)) != 0) {
-               char name_2[PATH_MAX];
-               TERMTYPE lterm;
-               char *cn;
-               int status;
-
-               len = NAMLEN(entry);
-               strncpy(name_2, entry->d_name, len)[len] = '\0';
-               if (isDotname(name_2) || !is_a_file(name_2))
-                   continue;
+    } else {
+       DBDIRS state;
+       int offset;
+       const char *path;
+       char **eargv = allocArgv(2);
+       size_t count = 0;
+
+       _nc_first_db(&state, &offset);
+       if ((path = _nc_next_db(&state, &offset)) != 0) {
+           eargv[count++] = strmalloc(path);
+       }
 
-               status = _nc_read_file_entry(name_2, &lterm);
-               if (status <= 0) {
-                   (void) fflush(stdout);
-                   (void) fprintf(stderr,
-                                  "toe: couldn't open terminfo file %s.\n",
-                                  name_2);
-                   return (EXIT_FAILURE);
-               }
+       code = typelist((int) count, eargv, header, hook);
 
-               /* only visit things once, by primary name */
-               cn = _nc_first_name(lterm.term_names);
-               if (!strcmp(cn, name_2)) {
-                   /* apply the selected hook function */
-                   (*hook) (cn, &lterm);
-               }
-               if (lterm.term_names) {
-                   free(lterm.term_names);
-                   lterm.term_names = 0;
-               }
-               if (lterm.str_table) {
-                   free(lterm.str_table);
-                   lterm.str_table = 0;
-               }
-           }
-           closedir(entrydir);
-       }
-       closedir(termdir);
+       freeArgv(eargv);
     }
+    _nc_last_db();
 
-    return (EXIT_SUCCESS);
+    ExitProgram(code);
 }