1 /****************************************************************************
2 * Copyright 2018-2020,2021 Thomas E. Dickey *
3 * Copyright 1998-2013,2017 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
32 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
33 * and: Thomas E. Dickey 1996-on *
34 ****************************************************************************/
37 * toe.c --- table of entries report generator
40 #include <progs.priv.h>
45 #include <hashed_db.h>
48 MODULE_ID("$Id: toe.c,v 1.86 2021/10/10 00:55:32 tom Exp $")
50 #define isDotname(name) (!strcmp(name, ".") || !strcmp(name, ".."))
54 unsigned long checksum;
59 const char *_nc_progname;
61 static TERMDATA *ptr_termdata; /* array of terminal data */
62 static size_t use_termdata; /* actual usage in ptr_termdata[] */
63 static size_t len_termdata; /* allocated size of ptr_termdata[] */
67 static GCC_NORETURN void ExitProgram(int code);
71 _nc_free_entries(_nc_head);
76 static GCC_NORETURN void failed(const char *);
79 failed(const char *msg)
82 ExitProgram(EXIT_FAILURE);
86 strmalloc(const char *value)
88 char *result = strdup(value);
98 size_t want = use_termdata + 1;
100 if (want >= len_termdata) {
101 len_termdata = (2 * want) + 10;
102 ptr_termdata = typeRealloc(TERMDATA, len_termdata, ptr_termdata);
103 if (ptr_termdata == 0)
104 failed("ptr_termdata");
107 return ptr_termdata + use_termdata++;
111 compare_termdata(const void *a, const void *b)
113 const TERMDATA *p = (const TERMDATA *) a;
114 const TERMDATA *q = (const TERMDATA *) b;
115 int result = strcmp(p->term_name, q->term_name);
118 result = (p->db_index - q->db_index);
124 * Sort the array of TERMDATA and print it. If more than one database is being
125 * reported, add a column to show which database has a given entry.
128 show_termdata(int eargc, char **eargv)
136 for (j = 0; j < eargc; ++j) {
139 for (k = 0; k <= j; ++k) {
143 printf("%s\n", eargv[j]);
146 if (use_termdata > 1)
147 qsort(ptr_termdata, use_termdata, sizeof(TERMDATA), compare_termdata);
148 for (n = 0; n < use_termdata; ++n) {
152 * If there is more than one database, show how they differ.
155 unsigned long check = 0;
158 char mark = ((check == 0
159 || (check != ptr_termdata[n].checksum))
163 for (; k < ptr_termdata[n].db_index; ++k) {
168 * If this is the first entry, or its checksum differs
169 * from the first entry's checksum, print "*". Otherwise
170 * it looks enough like a duplicate to print "+".
173 check = ptr_termdata[n].checksum;
174 if (mark == '*' && nk < 0)
178 if ((n + 1) >= use_termdata
179 || strcmp(ptr_termdata[n].term_name,
180 ptr_termdata[n + 1].term_name)) {
185 for (; k < eargc; ++k) {
193 (void) printf("%-10s\t%s\n",
194 ptr_termdata[n].term_name,
195 ptr_termdata[nk].description);
203 if (ptr_termdata != 0) {
204 while (use_termdata != 0) {
206 free(ptr_termdata[use_termdata].term_name);
207 free(ptr_termdata[use_termdata].description);
217 allocArgv(size_t count)
219 char **result = typeCalloc(char *, count + 1);
221 failed("realloc eargv");
228 freeArgv(char **argv)
232 while (argv[count]) {
241 make_db_name(char *dst, const char *src, unsigned limit)
243 static const char suffix[] = DBM_SUFFIX;
246 size_t lens = sizeof(suffix) - 1;
247 size_t size = strlen(src);
248 size_t need = lens + size;
252 && !strcmp(src + size - lens, suffix)) {
253 _nc_STRCPY(dst, src, PATH_MAX);
255 _nc_SPRINTF(dst, _nc_SLIMIT(PATH_MAX) "%.*s%s",
256 (int) (PATH_MAX - sizeof(suffix)),
265 typedef void (DescHook) (int /* db_index */ ,
267 const char * /* term_name */ ,
268 TERMTYPE2 * /* term */ );
271 term_description(TERMTYPE2 *tp)
275 if (tp->term_names == 0
276 || (desc = strrchr(tp->term_names, '|')) == 0
277 || (*++desc == '\0')) {
278 desc = "(No description)";
284 /* display a description for the type */
286 deschook(int db_index, int db_limit, const char *term_name, TERMTYPE2 *tp)
290 (void) printf("%-10s\t%s\n", term_name, term_description(tp));
294 string_sum(const char *value)
296 unsigned long result = 0;
298 if ((intptr_t) value == (intptr_t) (-1)) {
302 result += UChar(*value);
310 checksum_of(TERMTYPE2 *tp)
312 unsigned long result = string_sum(tp->term_names);
315 for (i = 0; i < NUM_BOOLEANS(tp); i++) {
316 result += (unsigned long) (tp->Booleans[i]);
318 for (i = 0; i < NUM_NUMBERS(tp); i++) {
319 result += (unsigned long) (tp->Numbers[i]);
321 for (i = 0; i < NUM_STRINGS(tp); i++) {
322 result += string_sum(tp->Strings[i]);
327 /* collect data, to sort before display */
329 sorthook(int db_index, int db_limit, const char *term_name, TERMTYPE2 *tp)
331 TERMDATA *data = new_termdata();
333 data->db_index = db_index;
334 data->checksum = ((db_limit > 1) ? checksum_of(tp) : 0);
335 data->term_name = strmalloc(term_name);
336 data->description = strmalloc(term_description(tp));
339 #if NCURSES_USE_TERMCAP
341 * Check if the buffer contents are printable ASCII, ensuring that we do not
342 * accidentally pick up incompatible binary content from a hashed database.
345 is_termcap(char *buffer)
348 while (*buffer != '\0') {
349 int ch = UChar(*buffer++);
352 if (ch < ' ' || ch > '~') {
361 show_termcap(int db_index, int db_limit, char *buffer, DescHook hook)
364 char *next = strchr(buffer, ':');
371 last = strrchr(buffer, '|');
375 memset(&data, 0, sizeof(data));
376 data.term_names = strmalloc(buffer);
377 while ((next = strtok(list, "|")) != 0) {
379 hook(db_index, db_limit, next, &data);
382 free(data.term_names);
386 #if NCURSES_USE_DATABASE
388 copy_entryname(DIRENT * src)
390 size_t len = NAMLEN(src);
391 char *result = malloc(len + 1);
393 failed("copy entryname");
394 memcpy(result, src->d_name, len);
402 typelist(int eargc, char *eargv[],
405 /* apply a function to each entry in given terminfo directories */
409 for (i = 0; i < eargc; i++) {
410 #if NCURSES_USE_DATABASE
411 if (_nc_is_dir_path(eargv[i])) {
416 if ((termdir = opendir(eargv[i])) == 0) {
417 (void) fflush(stdout);
418 (void) fprintf(stderr,
419 "%s: can't open terminfo directory %s\n",
420 _nc_progname, eargv[i]);
425 (void) printf("#\n#%s:\n#\n", eargv[i]);
427 while ((subdir = readdir(termdir)) != 0) {
433 name_1 = copy_entryname(subdir);
434 if (isDotname(name_1)) {
439 cwd_len = NAMLEN(subdir) + strlen(eargv[i]) + 3;
440 cwd_buf = typeRealloc(char, cwd_len, cwd_buf);
442 failed("realloc cwd_buf");
444 assert(cwd_buf != 0);
446 _nc_SPRINTF(cwd_buf, _nc_SLIMIT(cwd_len)
447 "%s/%s/", eargv[i], name_1);
450 if (chdir(cwd_buf) != 0)
453 entrydir = opendir(".");
458 while ((entry = readdir(entrydir)) != 0) {
464 name_2 = copy_entryname(entry);
465 if (isDotname(name_2) || !_nc_is_file_path(name_2)) {
470 status = _nc_read_file_entry(name_2, <erm);
472 (void) fflush(stdout);
473 (void) fprintf(stderr,
474 "%s: couldn't open terminfo file %s.\n",
475 _nc_progname, name_2);
480 /* only visit things once, by primary name */
481 cn = _nc_first_name(lterm.term_names);
482 if (!strcmp(cn, name_2)) {
483 /* apply the selected hook function */
484 hook(i, eargc, cn, <erm);
486 _nc_free_termtype2(<erm);
499 char filename[PATH_MAX];
502 (void) printf("#\n#%s:\n#\n", eargv[i]);
504 if (make_db_name(filename, eargv[i], sizeof(filename))) {
505 if ((capdbp = _nc_db_open(filename, FALSE)) != 0) {
509 code = _nc_db_first(capdbp, &key, &data);
516 if (_nc_db_have_data(&key, &data, &have, &used)) {
517 if (_nc_read_termtype(<erm, have, used) > 0) {
518 /* only visit things once, by primary name */
519 cn = _nc_first_name(lterm.term_names);
520 /* apply the selected hook function */
521 hook(i, eargc, cn, <erm);
522 _nc_free_termtype2(<erm);
525 code = _nc_db_next(capdbp, &key, &data);
528 _nc_db_close(capdbp);
533 #endif /* USE_HASHED_DB */
534 #endif /* NCURSES_USE_DATABASE */
535 #if NCURSES_USE_TERMCAP
538 CGETENT_CONST char *db_array[2];
542 (void) printf("#\n#%s:\n#\n", eargv[i]);
544 db_array[0] = eargv[i];
547 if (cgetfirst(&buffer, db_array) > 0) {
548 if (is_termcap(buffer)) {
549 show_termcap(i, eargc, buffer, hook);
551 while (cgetnext(&buffer, db_array) > 0) {
552 show_termcap(i, eargc, buffer, hook);
561 /* scan termcap text-file only */
562 if (_nc_is_file_path(eargv[i])) {
567 (void) printf("#\n#%s:\n#\n", eargv[i]);
569 if ((fp = safe_fopen(eargv[i], "r")) != 0) {
570 while (fgets(buffer, sizeof(buffer), fp) != 0) {
571 if (!is_termcap(buffer))
575 if (isspace(*buffer))
577 show_termcap(i, eargc, buffer, hook);
586 if (hook == sorthook) {
587 show_termdata(eargc, eargv);
591 return (EXIT_SUCCESS);
597 (void) fprintf(stderr, "usage: %s [-ahsuUV] [-v n] [file...]\n", _nc_progname);
598 ExitProgram(EXIT_FAILURE);
602 main(int argc, char *argv[])
604 bool all_dirs = FALSE;
605 bool direct_dependencies = FALSE;
606 bool invert_dependencies = FALSE;
608 char *report_file = 0;
610 int this_opt, last_opt = '?';
612 DescHook *hook = deschook;
614 _nc_progname = _nc_rootname(argv[0]);
616 while ((this_opt = getopt(argc, argv, "0123456789ahsu:vU:V")) != -1) {
617 /* handle optional parameter */
618 if (isdigit(this_opt)) {
621 v_opt = (unsigned) (this_opt - '0');
624 if (isdigit(last_opt))
628 v_opt += (unsigned) (this_opt - '0');
644 direct_dependencies = TRUE;
645 report_file = optarg;
651 invert_dependencies = TRUE;
652 report_file = optarg;
655 puts(curses_version());
656 ExitProgram(EXIT_SUCCESS);
661 set_trace_level(v_opt);
663 if (report_file != 0) {
664 if (freopen(report_file, "r", stdin) == 0) {
665 (void) fflush(stdout);
666 fprintf(stderr, "%s: can't open %s\n", _nc_progname, report_file);
667 ExitProgram(EXIT_FAILURE);
670 /* parse entries out of the source file */
671 _nc_set_source(report_file);
672 _nc_read_entry_source(stdin, 0, FALSE, FALSE, NULLHOOK);
675 /* maybe we want a direct-dependency listing? */
676 if (direct_dependencies) {
683 (void) printf("%s:", _nc_first_name(qp->tterm.term_names));
684 for (j = 0; j < qp->nuses; j++)
685 (void) printf(" %s", qp->uses[j].name);
690 ExitProgram(EXIT_SUCCESS);
693 /* maybe we want a reverse-dependency listing? */
694 if (invert_dependencies) {
706 for (i = 0; i < rp->nuses; i++)
707 if (_nc_name_match(qp->tterm.term_names,
708 rp->uses[i].name, "|")) {
709 if (matchcount++ == 0)
711 _nc_first_name(qp->tterm.term_names));
713 _nc_first_name(rp->tterm.term_names));
720 ExitProgram(EXIT_SUCCESS);
724 * If we get this far, user wants a simple terminal type listing.
727 code = typelist(argc - optind, argv + optind, header, hook);
728 } else if (all_dirs) {
735 for (pass = 0; pass < 2; ++pass) {
739 _nc_first_db(&state, &offset);
740 while ((path = _nc_next_db(&state, &offset)) != 0) {
741 if (quick_prefix(path))
744 eargv[count] = strmalloc(path);
749 eargv = allocArgv(count);
753 code = typelist((int) count, eargv, header, hook);
761 char **eargv = allocArgv((size_t) 2);
766 _nc_first_db(&state, &offset);
767 if ((path = _nc_next_db(&state, &offset)) != 0) {
768 if (!quick_prefix(path))
769 eargv[count++] = strmalloc(path);
772 code = typelist((int) count, eargv, header, hook);