ncurses 5.9 - patch 20121026
[ncurses.git] / progs / toe.c
1 /****************************************************************************
2  * Copyright (c) 1998-2011,2012 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  ****************************************************************************/
34
35 /*
36  *      toe.c --- table of entries report generator
37  */
38
39 #include <progs.priv.h>
40
41 #include <sys/stat.h>
42
43 #if USE_HASHED_DB
44 #include <hashed_db.h>
45 #endif
46
47 MODULE_ID("$Id: toe.c,v 1.69 2012/10/27 20:01:20 tom Exp $")
48
49 #define isDotname(name) (!strcmp(name, ".") || !strcmp(name, ".."))
50
51 typedef struct {
52     int db_index;
53     unsigned long checksum;
54     char *term_name;
55     char *description;
56 } TERMDATA;
57
58 const char *_nc_progname;
59
60 static TERMDATA *ptr_termdata;  /* array of terminal data */
61 static size_t use_termdata;     /* actual usage in ptr_termdata[] */
62 static size_t len_termdata;     /* allocated size of ptr_termdata[] */
63
64 #if NO_LEAKS
65 #undef ExitProgram
66 static void ExitProgram(int code) GCC_NORETURN;
67 static void
68 ExitProgram(int code)
69 {
70     _nc_free_entries(_nc_head);
71     _nc_free_tic(code);
72 }
73 #endif
74
75 static void failed(const char *) GCC_NORETURN;
76
77 static void
78 failed(const char *msg)
79 {
80     perror(msg);
81     ExitProgram(EXIT_FAILURE);
82 }
83
84 static char *
85 strmalloc(const char *value)
86 {
87     char *result = strdup(value);
88     if (result == 0) {
89         failed("strmalloc");
90     }
91     return result;
92 }
93
94 static TERMDATA *
95 new_termdata(void)
96 {
97     size_t want = use_termdata + 1;
98
99     if (want >= len_termdata) {
100         len_termdata = (2 * want) + 10;
101         ptr_termdata = typeRealloc(TERMDATA, len_termdata, ptr_termdata);
102         if (ptr_termdata == 0)
103             failed("ptr_termdata");
104     }
105
106     return ptr_termdata + use_termdata++;
107 }
108
109 static int
110 compare_termdata(const void *a, const void *b)
111 {
112     const TERMDATA *p = (const TERMDATA *) a;
113     const TERMDATA *q = (const TERMDATA *) b;
114     int result = strcmp(p->term_name, q->term_name);
115
116     if (result == 0) {
117         result = (p->db_index - q->db_index);
118     }
119     return result;
120 }
121
122 /*
123  * Sort the array of TERMDATA and print it.  If more than one database is being
124  * reported, add a column to show which database has a given entry.
125  */
126 static void
127 show_termdata(int eargc, char **eargv)
128 {
129     int j, k;
130     size_t n;
131
132     if (use_termdata) {
133         if (eargc > 1) {
134             for (j = 0; j < eargc; ++j) {
135                 for (k = 0; k <= j; ++k) {
136                     printf("--");
137                 }
138                 printf("> ");
139                 printf("%s\n", eargv[j]);
140             }
141         }
142         if (use_termdata > 1)
143             qsort(ptr_termdata, use_termdata, sizeof(TERMDATA), compare_termdata);
144         for (n = 0; n < use_termdata; ++n) {
145
146             /*
147              * If there is more than one database, show how they differ.
148              */
149             if (eargc > 1) {
150                 unsigned long check = 0;
151                 k = 0;
152                 for (;;) {
153                     for (; k < ptr_termdata[n].db_index; ++k) {
154                         printf("--");
155                     }
156
157                     /*
158                      * If this is the first entry, or its checksum differs
159                      * from the first entry's checksum, print "*". Otherwise
160                      * it looks enough like a duplicate to print "+".
161                      */
162                     printf("%c-", ((check == 0
163                                     || (check != ptr_termdata[n].checksum))
164                                    ? '*'
165                                    : '+'));
166                     check = ptr_termdata[n].checksum;
167
168                     ++k;
169                     if ((n + 1) >= use_termdata
170                         || strcmp(ptr_termdata[n].term_name,
171                                   ptr_termdata[n + 1].term_name)) {
172                         break;
173                     }
174                     ++n;
175                 }
176                 for (; k < eargc; ++k) {
177                     printf("--");
178                 }
179                 printf(":\t");
180             }
181
182             (void) printf("%-10s\t%s\n",
183                           ptr_termdata[n].term_name,
184                           ptr_termdata[n].description);
185         }
186     }
187 }
188
189 static void
190 free_termdata(void)
191 {
192     if (ptr_termdata != 0) {
193         while (use_termdata != 0) {
194             --use_termdata;
195             free(ptr_termdata[use_termdata].term_name);
196             free(ptr_termdata[use_termdata].description);
197         }
198         free(ptr_termdata);
199         ptr_termdata = 0;
200     }
201     use_termdata = 0;
202     len_termdata = 0;
203 }
204
205 static char **
206 allocArgv(size_t count)
207 {
208     char **result = typeCalloc(char *, count + 1);
209     if (result == 0)
210         failed("realloc eargv");
211
212     assert(result != 0);
213     return result;
214 }
215
216 static void
217 freeArgv(char **argv)
218 {
219     if (argv) {
220         int count = 0;
221         while (argv[count]) {
222             free(argv[count++]);
223         }
224         free(argv);
225     }
226 }
227
228 #if USE_HASHED_DB
229 static bool
230 make_db_name(char *dst, const char *src, unsigned limit)
231 {
232     static const char suffix[] = DBM_SUFFIX;
233
234     bool result = FALSE;
235     unsigned lens = sizeof(suffix) - 1;
236     unsigned size = strlen(src);
237     unsigned need = lens + size;
238
239     if (need <= limit) {
240         if (size >= lens
241             && !strcmp(src + size - lens, suffix)) {
242             _nc_STRCPY(dst, src, PATH_MAX);
243         } else {
244             _nc_SPRINTF(dst, _nc_SLIMIT(PATH_MAX) "%s%s", src, suffix);
245         }
246         result = TRUE;
247     }
248     return result;
249 }
250 #endif
251
252 typedef void (DescHook) (int /* db_index */ ,
253                          int /* db_limit */ ,
254                          const char * /* term_name */ ,
255                          TERMTYPE * /* term */ );
256
257 static const char *
258 term_description(TERMTYPE *tp)
259 {
260     const char *desc;
261
262     if ((desc = strrchr(tp->term_names, '|')) == 0 || *++desc == '\0')
263         desc = "(No description)";
264
265     return desc;
266 }
267
268 /* display a description for the type */
269 static void
270 deschook(int db_index, int db_limit, const char *term_name, TERMTYPE *tp)
271 {
272     (void) db_index;
273     (void) db_limit;
274     (void) printf("%-10s\t%s\n", term_name, term_description(tp));
275 }
276
277 static unsigned long
278 string_sum(const char *value)
279 {
280     unsigned long result = 0;
281
282     if ((intptr_t) value == (intptr_t) (-1)) {
283         result = ~result;
284     } else if (value) {
285         while (*value) {
286             result += UChar(*value);
287             ++value;
288         }
289     }
290     return result;
291 }
292
293 static unsigned long
294 checksum_of(TERMTYPE *tp)
295 {
296     unsigned long result = string_sum(tp->term_names);
297     unsigned i;
298
299     for (i = 0; i < NUM_BOOLEANS(tp); i++) {
300         result += (unsigned long) (tp->Booleans[i]);
301     }
302     for (i = 0; i < NUM_NUMBERS(tp); i++) {
303         result += (unsigned long) (tp->Numbers[i]);
304     }
305     for (i = 0; i < NUM_STRINGS(tp); i++) {
306         result += string_sum(tp->Strings[i]);
307     }
308     return result;
309 }
310
311 /* collect data, to sort before display */
312 static void
313 sorthook(int db_index, int db_limit, const char *term_name, TERMTYPE *tp)
314 {
315     TERMDATA *data = new_termdata();
316
317     data->db_index = db_index;
318     data->checksum = ((db_limit > 1) ? checksum_of(tp) : 0);
319     data->term_name = strmalloc(term_name);
320     data->description = strmalloc(term_description(tp));
321 }
322
323 #if USE_TERMCAP
324 static void
325 show_termcap(int db_index, int db_limit, char *buffer, DescHook hook)
326 {
327     TERMTYPE data;
328     char *next = strchr(buffer, ':');
329     char *last;
330     char *list = buffer;
331
332     if (next)
333         *next = '\0';
334
335     last = strrchr(buffer, '|');
336     if (last)
337         ++last;
338
339     memset(&data, 0, sizeof(data));
340     data.term_names = strmalloc(buffer);
341     while ((next = strtok(list, "|")) != 0) {
342         if (next != last)
343             hook(db_index, db_limit, next, &data);
344         list = 0;
345     }
346     free(data.term_names);
347 }
348 #endif
349
350 #if USE_DATABASE
351 static char *
352 copy_entryname(DIRENT * src)
353 {
354     size_t len = NAMLEN(src);
355     char *result = malloc(len + 1);
356     if (result == 0)
357         failed("copy entryname");
358     memcpy(result, src->d_name, len);
359     result[len] = '\0';
360
361     return result;
362 }
363 #endif
364
365 static int
366 typelist(int eargc, char *eargv[],
367          bool verbosity,
368          DescHook hook)
369 /* apply a function to each entry in given terminfo directories */
370 {
371     int i;
372
373     for (i = 0; i < eargc; i++) {
374 #if USE_DATABASE
375         if (_nc_is_dir_path(eargv[i])) {
376             char *cwd_buf = 0;
377             DIR *termdir;
378             DIRENT *subdir;
379
380             if ((termdir = opendir(eargv[i])) == 0) {
381                 (void) fflush(stdout);
382                 (void) fprintf(stderr,
383                                "%s: can't open terminfo directory %s\n",
384                                _nc_progname, eargv[i]);
385                 continue;
386             }
387
388             if (verbosity)
389                 (void) printf("#\n#%s:\n#\n", eargv[i]);
390
391             while ((subdir = readdir(termdir)) != 0) {
392                 size_t cwd_len;
393                 char *name_1;
394                 DIR *entrydir;
395                 DIRENT *entry;
396
397                 name_1 = copy_entryname(subdir);
398                 if (isDotname(name_1)) {
399                     free(name_1);
400                     continue;
401                 }
402
403                 cwd_len = NAMLEN(subdir) + strlen(eargv[i]) + 3;
404                 cwd_buf = typeRealloc(char, cwd_len, cwd_buf);
405                 if (cwd_buf == 0)
406                     failed("realloc cwd_buf");
407
408                 assert(cwd_buf != 0);
409
410                 _nc_SPRINTF(cwd_buf, _nc_SLIMIT(cwd_len)
411                             "%s/%s/", eargv[i], name_1);
412                 free(name_1);
413
414                 if (chdir(cwd_buf) != 0)
415                     continue;
416
417                 entrydir = opendir(".");
418                 if (entrydir == 0) {
419                     perror(cwd_buf);
420                     continue;
421                 }
422                 while ((entry = readdir(entrydir)) != 0) {
423                     char *name_2;
424                     TERMTYPE lterm;
425                     char *cn;
426                     int status;
427
428                     name_2 = copy_entryname(entry);
429                     if (isDotname(name_2) || !_nc_is_file_path(name_2)) {
430                         free(name_2);
431                         continue;
432                     }
433
434                     status = _nc_read_file_entry(name_2, &lterm);
435                     if (status <= 0) {
436                         (void) fflush(stdout);
437                         (void) fprintf(stderr,
438                                        "%s: couldn't open terminfo file %s.\n",
439                                        _nc_progname, name_2);
440                         free(name_2);
441                         return (EXIT_FAILURE);
442                     }
443
444                     /* only visit things once, by primary name */
445                     cn = _nc_first_name(lterm.term_names);
446                     if (!strcmp(cn, name_2)) {
447                         /* apply the selected hook function */
448                         hook(i, eargc, cn, &lterm);
449                     }
450                     _nc_free_termtype(&lterm);
451                     free(name_2);
452                 }
453                 closedir(entrydir);
454             }
455             closedir(termdir);
456             if (cwd_buf != 0)
457                 free(cwd_buf);
458             continue;
459         }
460 #if USE_HASHED_DB
461         else {
462             DB *capdbp;
463             char filename[PATH_MAX];
464
465             if (verbosity)
466                 (void) printf("#\n#%s:\n#\n", eargv[i]);
467
468             if (make_db_name(filename, eargv[i], sizeof(filename))) {
469                 if ((capdbp = _nc_db_open(filename, FALSE)) != 0) {
470                     DBT key, data;
471                     int code;
472
473                     code = _nc_db_first(capdbp, &key, &data);
474                     while (code == 0) {
475                         TERMTYPE lterm;
476                         int used;
477                         char *have;
478                         char *cn;
479
480                         if (_nc_db_have_data(&key, &data, &have, &used)) {
481                             if (_nc_read_termtype(&lterm, have, used) > 0) {
482                                 /* only visit things once, by primary name */
483                                 cn = _nc_first_name(lterm.term_names);
484                                 /* apply the selected hook function */
485                                 hook(i, eargc, cn, &lterm);
486                                 _nc_free_termtype(&lterm);
487                             }
488                         }
489                         code = _nc_db_next(capdbp, &key, &data);
490                     }
491
492                     _nc_db_close(capdbp);
493                     continue;
494                 }
495             }
496         }
497 #endif
498 #endif
499 #if USE_TERMCAP
500 #if HAVE_BSD_CGETENT
501         {
502             CGETENT_CONST char *db_array[2];
503             char *buffer = 0;
504
505             if (verbosity)
506                 (void) printf("#\n#%s:\n#\n", eargv[i]);
507
508             db_array[0] = eargv[i];
509             db_array[1] = 0;
510
511             if (cgetfirst(&buffer, db_array) > 0) {
512                 show_termcap(i, eargc, buffer, hook);
513                 free(buffer);
514                 while (cgetnext(&buffer, db_array) > 0) {
515                     show_termcap(i, eargc, buffer, hook);
516                     free(buffer);
517                 }
518                 cgetclose();
519                 continue;
520             }
521         }
522 #else
523         /* scan termcap text-file only */
524         if (_nc_is_file_path(eargv[i])) {
525             char buffer[2048];
526             FILE *fp;
527
528             if (verbosity)
529                 (void) printf("#\n#%s:\n#\n", eargv[i]);
530
531             if ((fp = fopen(eargv[i], "r")) != 0) {
532                 while (fgets(buffer, sizeof(buffer), fp) != 0) {
533                     if (*buffer == '#')
534                         continue;
535                     if (isspace(*buffer))
536                         continue;
537                     show_termcap(i, eargc, buffer, hook);
538                 }
539                 fclose(fp);
540             }
541         }
542 #endif
543 #endif
544     }
545
546     if (hook == sorthook) {
547         show_termdata(eargc, eargv);
548         free_termdata();
549     }
550
551     return (EXIT_SUCCESS);
552 }
553
554 static void
555 usage(void)
556 {
557     (void) fprintf(stderr, "usage: %s [-ahsuUV] [-v n] [file...]\n", _nc_progname);
558     ExitProgram(EXIT_FAILURE);
559 }
560
561 int
562 main(int argc, char *argv[])
563 {
564     bool all_dirs = FALSE;
565     bool direct_dependencies = FALSE;
566     bool invert_dependencies = FALSE;
567     bool header = FALSE;
568     char *report_file = 0;
569     unsigned i;
570     int code;
571     int this_opt, last_opt = '?';
572     unsigned v_opt = 0;
573     DescHook *hook = deschook;
574
575     _nc_progname = _nc_rootname(argv[0]);
576
577     while ((this_opt = getopt(argc, argv, "0123456789ahsu:vU:V")) != -1) {
578         /* handle optional parameter */
579         if (isdigit(this_opt)) {
580             switch (last_opt) {
581             case 'v':
582                 v_opt = (unsigned) (this_opt - '0');
583                 break;
584             default:
585                 if (isdigit(last_opt))
586                     v_opt *= 10;
587                 else
588                     v_opt = 0;
589                 v_opt += (unsigned) (this_opt - '0');
590                 last_opt = this_opt;
591             }
592             continue;
593         }
594         switch (this_opt) {
595         case 'a':
596             all_dirs = TRUE;
597             break;
598         case 'h':
599             header = TRUE;
600             break;
601         case 's':
602             hook = sorthook;
603             break;
604         case 'u':
605             direct_dependencies = TRUE;
606             report_file = optarg;
607             break;
608         case 'v':
609             v_opt = 1;
610             break;
611         case 'U':
612             invert_dependencies = TRUE;
613             report_file = optarg;
614             break;
615         case 'V':
616             puts(curses_version());
617             ExitProgram(EXIT_SUCCESS);
618         default:
619             usage();
620         }
621     }
622     set_trace_level(v_opt);
623
624     if (report_file != 0) {
625         if (freopen(report_file, "r", stdin) == 0) {
626             (void) fflush(stdout);
627             fprintf(stderr, "%s: can't open %s\n", _nc_progname, report_file);
628             ExitProgram(EXIT_FAILURE);
629         }
630
631         /* parse entries out of the source file */
632         _nc_set_source(report_file);
633         _nc_read_entry_source(stdin, 0, FALSE, FALSE, NULLHOOK);
634     }
635
636     /* maybe we want a direct-dependency listing? */
637     if (direct_dependencies) {
638         ENTRY *qp;
639
640         for_entry_list(qp) {
641             if (qp->nuses) {
642                 unsigned j;
643
644                 (void) printf("%s:", _nc_first_name(qp->tterm.term_names));
645                 for (j = 0; j < qp->nuses; j++)
646                     (void) printf(" %s", qp->uses[j].name);
647                 putchar('\n');
648             }
649         }
650
651         ExitProgram(EXIT_SUCCESS);
652     }
653
654     /* maybe we want a reverse-dependency listing? */
655     if (invert_dependencies) {
656         ENTRY *qp, *rp;
657         int matchcount;
658
659         for_entry_list(qp) {
660             matchcount = 0;
661             for_entry_list(rp) {
662                 if (rp->nuses == 0)
663                     continue;
664
665                 for (i = 0; i < rp->nuses; i++)
666                     if (_nc_name_match(qp->tterm.term_names,
667                                        rp->uses[i].name, "|")) {
668                         if (matchcount++ == 0)
669                             (void) printf("%s:",
670                                           _nc_first_name(qp->tterm.term_names));
671                         (void) printf(" %s",
672                                       _nc_first_name(rp->tterm.term_names));
673                     }
674             }
675             if (matchcount)
676                 putchar('\n');
677         }
678
679         ExitProgram(EXIT_SUCCESS);
680     }
681
682     /*
683      * If we get this far, user wants a simple terminal type listing.
684      */
685     if (optind < argc) {
686         code = typelist(argc - optind, argv + optind, header, hook);
687     } else if (all_dirs) {
688         DBDIRS state;
689         int offset;
690         int pass;
691         const char *path;
692         char **eargv = 0;
693
694         code = EXIT_FAILURE;
695         for (pass = 0; pass < 2; ++pass) {
696             size_t count = 0;
697
698             _nc_first_db(&state, &offset);
699             while ((path = _nc_next_db(&state, &offset)) != 0) {
700                 if (pass) {
701                     eargv[count] = strmalloc(path);
702                 }
703                 ++count;
704             }
705             if (!pass) {
706                 eargv = allocArgv(count);
707                 if (eargv == 0)
708                     failed("eargv");
709             } else {
710                 code = typelist((int) count, eargv, header, hook);
711                 freeArgv(eargv);
712             }
713         }
714     } else {
715         DBDIRS state;
716         int offset;
717         const char *path;
718         char **eargv = allocArgv(2);
719         size_t count = 0;
720
721         if (eargv == 0)
722             failed("eargv");
723         _nc_first_db(&state, &offset);
724         if ((path = _nc_next_db(&state, &offset)) != 0) {
725             eargv[count++] = strmalloc(path);
726         }
727
728         code = typelist((int) count, eargv, header, hook);
729
730         freeArgv(eargv);
731     }
732     _nc_last_db();
733
734     ExitProgram(code);
735 }