1 /****************************************************************************
2 * Copyright 2019-2020,2021 Thomas E. Dickey *
3 * Copyright 2009-2016,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 ****************************************************************************/
31 * Author: Thomas E. Dickey
33 * $Id: demo_terminfo.c,v 1.52 2021/03/20 16:07:29 tom Exp $
35 * A simple demo of the terminfo interface.
38 #include <test.priv.h>
43 #include <term_entry.h>
46 #define NCURSES_XNAMES 0
50 static GCC_NORETURN void failed(const char *);
53 failed(const char *msg)
55 fprintf(stderr, "%s\n", msg);
56 ExitProgram(EXIT_FAILURE);
61 #if defined(HAVE_CURSES_DATA_BOOLNAMES) || defined(DECL_CURSES_DATA_BOOLNAMES)
62 #define USE_CODE_LISTS 1
64 #define USE_CODE_LISTS 0
67 static bool a_opt = FALSE;
68 static bool b_opt = FALSE;
69 static bool f_opt = FALSE;
70 static bool n_opt = FALSE;
71 static bool q_opt = FALSE;
72 static bool s_opt = FALSE;
73 #ifdef NCURSES_VERSION
74 static bool x_opt = FALSE;
75 static bool y_opt = FALSE;
80 static char **db_list;
84 static char **my_boolcodes;
85 static char **my_numcodes;
86 static char **my_numvalues;
87 static char **my_strcodes;
88 static char **my_strvalues;
90 static long total_values;
91 static long total_b_values;
92 static long total_n_values;
93 static long total_s_values;
96 #define FNAME(type) "%s %-*s = ", #type, f_opt ? 24 : FCOLS
99 make_dbitem(char *p, char *q)
101 size_t need = strlen(e_opt) + 2 + (size_t) (p - q);
102 char *result = malloc(need);
103 _nc_SPRINTF(result, _nc_SLIMIT(need) "%s=%.*s", e_opt, (int) (p - q), q);
110 if (d_opt && e_opt) {
113 for (pass = 0; pass < 2; ++pass) {
117 for (p = q = d_opt; *p != '\0'; ++p) {
121 db_list[count] = make_dbitem(p, q);
130 db_list[count] = make_dbitem(p, q);
135 db_list = typeCalloc(char *, count + 1);
147 if ((result = db_list[db_item]) == 0) {
155 printf("** %s\n", result);
165 for (n = 0; db_list[n]; ++n)
174 dumpit(NCURSES_CONST char *cap, const char *show)
179 if ((str = tigetstr(cap)) != 0 && (str != (char *) -1)) {
183 printf(FNAME(str), show ? show : cap);
185 int ch = UChar(*str++);
191 fputs("\\E", stdout);
194 fputs("\\b", stdout);
197 fputs("\\f", stdout);
200 fputs("\\n", stdout);
203 fputs("\\r", stdout);
206 fputs("\\s", stdout);
209 fputs("\\t", stdout);
212 fputs("\\^", stdout);
215 fputs("\\072", stdout);
218 fputs("\\\\", stdout);
224 printf("^%c", ch + '@');
226 printf("\\%03o", ch);
232 } else if ((num = tigetnum(cap)) >= 0) {
236 printf(FNAME(num), show ? show : cap);
237 printf(" %d\n", num);
239 } else if ((num = tigetflag(cap)) >= 0) {
243 printf(FNAME(flg), show ? show : cap);
244 printf("%s\n", num ? "true" : "false");
252 #define isCapName(c) (isalnum(UChar(c)) || ((c) == '_'))
253 #define LegalItem(c,n) (n)
256 brute_force(const char *name)
258 #define MAX_FORCE 5 /* omit "colors", since CPU-time is a problem */
259 static const char legal[] = "\
261 ABCDEFGHIJKLMNOPQRSTUVWXYZ\
262 abcdefghijklmnopqrstuvwxyz_";
267 char cap[MAX_FORCE + 1];
268 int item[MAX_FORCE + 1];
271 putenv(next_dbitem());
274 printf("Terminal type \"%s\"\n", name);
275 setupterm((NCURSES_CONST char *) name, 1, (int *) 0);
277 if (strcmp(name, ttytype))
278 printf("... actual \"%s\"\n", ttytype);
281 for (length = 1; length <= MAX_FORCE; ++length) {
282 /* set all digits to zeros */
283 for (j = 0; j < length; ++j) {
284 item[j] = LegalItem(j, 0);
289 /* copy digits to cap-name */
290 for (j = 0; j < length; ++j) {
291 cap[j] = legal[item[j]];
299 for (; k >= 0; --k) {
301 if (legal[item[k]]) {
306 legal[item[k - 1] + 1]) {
307 for (j = k; j < length; ++j) {
308 item[j] = LegalItem(j, 0);
317 del_curterm(cur_term);
321 #define fullname(type,n) f_opt ? type##fnames[n] : cap
323 #define fullname(type,n) cap
327 demo_terminfo(char *name)
330 NCURSES_CONST char *cap;
333 putenv(next_dbitem());
336 printf("Terminal type \"%s\"\n", name);
337 setupterm(name, 1, (int *) 0);
341 cap = my_boolcodes[n];
344 dumpit(cap, fullname(bool, n));
350 cap = my_numcodes[n];
353 dumpit(cap, fullname(num, n));
359 cap = my_strcodes[n];
362 dumpit(cap, fullname(str, n));
365 #ifdef NCURSES_VERSION
366 if (x_opt && (my_blob == 0)) {
369 TERMTYPE *term = (TERMTYPE *) cur_term;
371 && ((NUM_BOOLEANS(term) != BOOLCOUNT)
372 || (NUM_NUMBERS(term) != NUMCOUNT)
373 || (NUM_STRINGS(term) != STRCOUNT))) {
374 for (n = BOOLCOUNT; n < NUM_BOOLEANS(term); ++n) {
375 dumpit(ExtBoolname(term, (int) n, boolnames), NULL);
377 for (n = NUMCOUNT; n < NUM_NUMBERS(term); ++n) {
378 dumpit(ExtNumname(term, (int) n, numnames), NULL);
380 for (n = STRCOUNT; n < NUM_STRINGS(term); ++n) {
381 dumpit(ExtStrname(term, (int) n, strnames), NULL);
387 static const char *xterm_keys[] =
389 "kDC", "kDN", "kEND", "kHOM", "kIC",
390 "kLFT", "kNXT", "kPRV", "kRIT", "kUP",
392 for (n = 0; n < SIZEOF(xterm_keys); ++n) {
394 for (mod = 0; mod < 8; ++mod) {
396 /* these happen to be standard - avoid duplicates */
397 if (!strcmp(xterm_keys[n], "kDC") ||
398 !strcmp(xterm_keys[n], "kEND") ||
399 !strcmp(xterm_keys[n], "kHOM") ||
400 !strcmp(xterm_keys[n], "kLFT") ||
401 !strcmp(xterm_keys[n], "kRIT")) {
404 _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
405 "%.*s", 8, xterm_keys[n]);
407 _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
408 "%.*s%d", 8, xterm_keys[n], mod);
416 del_curterm(cur_term);
431 parse_description(const char *input_name)
433 static char empty[1];
437 size_t count_bools = 0;
438 size_t count_nums = 0;
439 size_t count_strs = 0;
444 if (stat(input_name, &sb) != 0
445 || (sb.st_mode & S_IFMT) != S_IFREG) {
446 failed("input is not a file");
449 if (sb.st_size == 0) {
450 failed("input is empty");
454 * None of the arrays could be larger than the input-file, and since it
455 * is small, just allocate the maximum for simplicity.
457 if ((my_blob = malloc((size_t) sb.st_size + 1)) == 0 ||
458 (my_boolcodes = typeCalloc(char *, sb.st_size)) == 0 ||
459 (my_numcodes = typeCalloc(char *, sb.st_size)) == 0 ||
460 (my_numvalues = typeCalloc(char *, sb.st_size)) == 0 ||
461 (my_strcodes = typeCalloc(char *, sb.st_size)) == 0 ||
462 (my_strvalues = typeCalloc(char *, sb.st_size)) == 0) {
463 failed("cannot allocate memory for input-file");
466 if ((fp = fopen(input_name, "r")) == 0)
467 failed("cannot open input-file");
468 len = fread(my_blob, sizeof(char), (size_t) sb.st_size, fp);
469 my_blob[sb.st_size] = '\0';
473 * First, get rid of comments and escaped newlines, as well as repeated
474 * colons to construct a canonical entry.
477 for (j = k = 0; j < len; ++j) {
496 state = pDescription;
507 my_blob[k++] = (char) ch;
510 if (isalpha(UChar(ch)))
513 fprintf(stderr, "OOPS @%d:%.20s\n", __LINE__, my_blob + j);
514 my_blob[k++] = (char) ch;
534 my_blob[k++] = (char) ch;
556 state = pDescription;
559 my_blob[k++] = (char) ch;
573 my_blob[k++] = (char) ch;
582 my_blob[k++] = (char) ch;
585 my_blob[k++] = (char) ch;
597 * Then, parse what's left, making indexes of the names and values.
600 for (j = 0; my_blob[j] != '\0'; ++j) {
603 switch (my_blob[j]) {
609 if (my_blob[j + 1] != '\0' && my_blob[j + 1] != ',')
621 if (isalpha(UChar(my_blob[j]))) {
622 for (jl = 1; isalnum(UChar(my_blob[j + jl])); ++jl) {
629 switch (my_blob[j + jl]) {
631 my_numvalues[count_nums] = &my_blob[j + jl + 1];
632 my_numcodes[count_nums++] = &my_blob[j];
633 my_blob[j + jl] = '\0';
638 my_strvalues[count_strs] = &my_blob[j + jl + 1];
639 my_strcodes[count_strs++] = &my_blob[j];
640 my_blob[j + jl] = '\0';
645 if (my_blob[j + jl] == '@') {
647 * We cannot get the type for a cancelled item
648 * directly, but can infer it assuming the input
649 * came from infocmp, which puts the data in a
653 my_strvalues[count_strs] = empty;
654 my_strcodes[count_strs++] = &my_blob[j];
655 } else if (count_nums) {
656 my_numvalues[count_nums] = empty;
657 my_numcodes[count_nums++] = &my_blob[j];
659 my_boolcodes[count_bools++] = &my_blob[j];
661 my_blob[j + jl] = '\0';
664 my_boolcodes[count_bools++] = &my_blob[j];
665 my_blob[j + jl] = '\0';
668 state = (isCapName(my_blob[j + 1])
676 if (!isdigit(UChar(my_blob[j]))) {
682 switch (my_blob[j]) {
684 if (my_blob[j + 1] != '\0') {
704 my_boolcodes[count_bools] = 0;
705 my_numcodes[count_nums] = 0;
706 my_numvalues[count_nums] = 0;
707 my_strcodes[count_strs] = 0;
708 my_strvalues[count_strs] = 0;
711 printf("# bools:%d\n", (int) count_bools);
712 for (j = 0; my_boolcodes[j]; ++j)
713 printf("\t%s,\n", my_boolcodes[j]);
715 printf("# numbers:%d\n", (int) count_nums);
716 for (j = 0; my_numcodes[j]; ++j)
717 printf("\t%s#%s,\n", my_numcodes[j], my_numvalues[j]);
719 printf("# strings:%d\n", (int) count_strs);
720 for (j = 0; my_strcodes[j]; ++j)
721 printf("\t%s=%s,\n", my_strcodes[j], my_strvalues[j]);
727 copy_code_list(NCURSES_CONST char *const *list)
735 for (pass = 0; pass < 2; ++pass) {
736 for (count = 0; list[count] != 0; ++count) {
737 size_t chunk = strlen(list[count]) + 1;
741 result[count] = unused;
742 _nc_STRCPY(unused, list[count], length);
747 char *blob = malloc(length);
748 result = typeCalloc(char *, count + 1);
750 if (blob == 0 || result == 0)
751 failed("copy_code_list failed");
760 free_code_list(char **list)
768 #endif /* USE_CODE_LISTS */
773 static const char *msg[] =
775 "Usage: demo_terminfo [options] [terminal]",
777 "If no options are given, print all (boolean, numeric, string)",
778 "capabilities for the given terminal, using short names.",
781 " -a try all names, print capabilities found",
782 " -b print boolean-capabilities",
783 " -d LIST colon-separated list of databases to use",
784 " -e NAME environment variable to set with -d option",
785 " -f print full names",
786 " -i NAME terminal description to use as names for \"-a\" option",
787 " -n print numeric-capabilities",
788 " -q quiet (prints only counts)",
789 " -r COUNT repeat for given count",
790 " -s print string-capabilities",
791 #ifdef NCURSES_VERSION
792 " -x print extended capabilities",
793 " -y direct-lookup names of extended capabilities",
797 for (n = 0; n < SIZEOF(msg); ++n) {
798 fprintf(stderr, "%s\n", msg[n]);
800 ExitProgram(EXIT_FAILURE);
804 main(int argc, char *argv[])
810 char *input_name = 0;
812 while ((n = getopt(argc, argv, "abd:e:fi:nqr:sxy")) != -1) {
839 if ((r_opt = atoi(optarg)) <= 0)
846 #ifdef NCURSES_VERSION
850 #ifdef NCURSES_VERSION
862 #if HAVE_USE_EXTENDED_NAMES
863 use_extended_names(x_opt);
866 if (!(b_opt || n_opt || s_opt)) {
875 for (repeat = 0; repeat < r_opt; ++repeat) {
877 for (n = optind; n < argc; ++n) {
878 brute_force(argv[n]);
880 } else if ((name = getenv("TERM")) != 0) {
883 static char dumb[] = "dumb";
888 if (input_name != 0) {
889 parse_description(input_name);
893 my_boolcodes = copy_code_list(boolnames);
894 my_numcodes = copy_code_list(numnames);
895 my_strcodes = copy_code_list(strnames);
899 failed("no capability-lists available (use -i option)");
901 #endif /* USE_CODE_LISTS */
902 for (repeat = 0; repeat < r_opt; ++repeat) {
904 for (n = optind; n < argc; ++n) {
905 demo_terminfo(argv[n]);
907 } else if ((name = getenv("TERM")) != 0) {
910 static char dumb[] = "dumb";
916 #define PLURAL(n) n, (n != 1) ? "s" : ""
917 printf("%ld value%s (%ld boolean%s, %ld number%s, %ld string%s)\n",
918 PLURAL(total_values),
919 PLURAL(total_b_values),
920 PLURAL(total_n_values),
921 PLURAL(total_s_values));
925 if (input_name != 0) {
937 free_code_list(my_boolcodes);
938 free_code_list(my_numcodes);
939 free_code_list(my_strcodes);
942 #endif /* NO_LEAKS */
944 ExitProgram(EXIT_SUCCESS);
947 #else /* !HAVE_TIGETSTR */
949 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
951 failed("This program requires the terminfo functions such as tigetstr");
952 ExitProgram(EXIT_FAILURE);
954 #endif /* HAVE_TIGETSTR */