1 /****************************************************************************
2 * Copyright (c) 2009-2016,2017 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
30 * Author: Thomas E. Dickey
32 * $Id: demo_terminfo.c,v 1.48 2017/11/24 20:49:11 tom Exp $
34 * A simple demo of the terminfo interface.
37 #include <test.priv.h>
42 #include <term_entry.h>
45 #define NCURSES_XNAMES 0
49 static void failed(const char *) GCC_NORETURN;
52 failed(const char *msg)
54 fprintf(stderr, "%s\n", msg);
55 ExitProgram(EXIT_FAILURE);
60 #if defined(HAVE_CURSES_DATA_BOOLNAMES) || defined(DECL_CURSES_DATA_BOOLNAMES)
61 #define USE_CODE_LISTS 1
63 #define USE_CODE_LISTS 0
66 static bool a_opt = FALSE;
67 static bool b_opt = FALSE;
68 static bool f_opt = FALSE;
69 static bool n_opt = FALSE;
70 static bool q_opt = FALSE;
71 static bool s_opt = FALSE;
72 #ifdef NCURSES_VERSION
73 static bool x_opt = FALSE;
74 static bool y_opt = FALSE;
79 static char **db_list;
83 static char **my_boolcodes;
84 static char **my_numcodes;
85 static char **my_numvalues;
86 static char **my_strcodes;
87 static char **my_strvalues;
89 static long total_values;
90 static long total_b_values;
91 static long total_n_values;
92 static long total_s_values;
95 #define FNAME(type) "%s %-*s = ", #type, f_opt ? 24 : FCOLS
98 make_dbitem(char *p, char *q)
100 size_t need = strlen(e_opt) + 2 + (size_t) (p - q);
101 char *result = malloc(need);
102 _nc_SPRINTF(result, _nc_SLIMIT(need) "%s=%.*s", e_opt, (int) (p - q), q);
109 if (d_opt && e_opt) {
112 for (pass = 0; pass < 2; ++pass) {
116 for (p = q = d_opt; *p != '\0'; ++p) {
120 db_list[count] = make_dbitem(p, q);
129 db_list[count] = make_dbitem(p, q);
134 db_list = typeCalloc(char *, count + 1);
146 if ((result = db_list[db_item]) == 0) {
153 printf("** %s\n", result);
163 for (n = 0; db_list[n]; ++n)
172 dumpit(NCURSES_CONST char *cap, const char *show)
177 if ((str = tigetstr(cap)) != 0 && (str != (char *) -1)) {
181 printf(FNAME(str), show ? show : cap);
183 int ch = UChar(*str++);
189 fputs("\\E", stdout);
192 fputs("\\b", stdout);
195 fputs("\\f", stdout);
198 fputs("\\n", stdout);
201 fputs("\\r", stdout);
204 fputs("\\s", stdout);
207 fputs("\\t", stdout);
210 fputs("\\^", stdout);
213 fputs("\\072", stdout);
216 fputs("\\\\", stdout);
222 printf("^%c", ch + '@');
224 printf("\\%03o", ch);
230 } else if ((num = tigetnum(cap)) >= 0) {
234 printf(FNAME(num), show ? show : cap);
235 printf(" %d\n", num);
237 } else if ((num = tigetflag(cap)) >= 0) {
241 printf(FNAME(flg), show ? show : cap);
242 printf("%s\n", num ? "true" : "false");
250 #define isCapName(c) (isalnum(UChar(c)) || ((c) == '_'))
251 #define LegalItem(c,n) (n)
254 brute_force(const char *name)
256 #define MAX_FORCE 5 /* omit "colors", since CPU-time is a problem */
257 static const char legal[] = "\
259 ABCDEFGHIJKLMNOPQRSTUVWXYZ\
260 abcdefghijklmnopqrstuvwxyz_";
265 char cap[MAX_FORCE + 1];
266 int item[MAX_FORCE + 1];
269 putenv(next_dbitem());
272 printf("Terminal type \"%s\"\n", name);
273 setupterm((NCURSES_CONST char *) name, 1, (int *) 0);
275 if (strcmp(name, ttytype))
276 printf("... actual \"%s\"\n", ttytype);
279 for (length = 1; length <= MAX_FORCE; ++length) {
280 /* set all digits to zeros */
281 for (j = 0; j < length; ++j) {
282 item[j] = LegalItem(j, 0);
287 /* copy digits to cap-name */
288 for (j = 0; j < length; ++j) {
289 cap[j] = legal[item[j]];
297 for (; k >= 0; --k) {
299 if (legal[item[k]]) {
304 legal[item[k - 1] + 1]) {
305 for (j = k; j < length; ++j) {
306 item[j] = LegalItem(j, 0);
315 del_curterm(cur_term);
319 #define fullname(type,n) f_opt ? type##fnames[n] : cap
321 #define fullname(type,n) cap
325 demo_terminfo(char *name)
328 NCURSES_CONST char *cap;
331 putenv(next_dbitem());
334 printf("Terminal type \"%s\"\n", name);
335 setupterm(name, 1, (int *) 0);
339 cap = my_boolcodes[n];
342 dumpit(cap, fullname(bool, n));
348 cap = my_numcodes[n];
351 dumpit(cap, fullname(num, n));
357 cap = my_strcodes[n];
360 dumpit(cap, fullname(str, n));
363 #ifdef NCURSES_VERSION
364 if (x_opt && (my_blob == 0)) {
368 TERMTYPE *term = (TERMTYPE *) cur_term;
370 && ((NUM_BOOLEANS(term) != BOOLCOUNT)
371 || (NUM_NUMBERS(term) != NUMCOUNT)
372 || (NUM_STRINGS(term) != STRCOUNT))) {
373 for (n = BOOLCOUNT; n < NUM_BOOLEANS(term); ++n) {
374 dumpit(ExtBoolname(term, (int) n, boolnames), NULL);
376 for (n = NUMCOUNT; n < NUM_NUMBERS(term); ++n) {
377 dumpit(ExtNumname(term, (int) n, numnames), NULL);
379 for (n = STRCOUNT; n < NUM_STRINGS(term); ++n) {
380 dumpit(ExtStrname(term, (int) n, strnames), NULL);
386 static const char *xterm_keys[] =
388 "kDC", "kDN", "kEND", "kHOM", "kIC",
389 "kLFT", "kNXT", "kPRV", "kRIT", "kUP",
391 for (n = 0; n < SIZEOF(xterm_keys); ++n) {
392 for (mod = 0; mod < 8; ++mod) {
394 /* these happen to be standard - avoid duplicates */
395 if (!strcmp(xterm_keys[n], "kDC") ||
396 !strcmp(xterm_keys[n], "kEND") ||
397 !strcmp(xterm_keys[n], "kHOM") ||
398 !strcmp(xterm_keys[n], "kLFT") ||
399 !strcmp(xterm_keys[n], "kRIT")) {
402 _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
403 "%.*s", 8, xterm_keys[n]);
405 _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
406 "%.*s%d", 8, xterm_keys[n], mod);
414 del_curterm(cur_term);
429 parse_description(const char *input_name)
431 static char empty[1];
435 size_t count_bools = 0;
436 size_t count_nums = 0;
437 size_t count_strs = 0;
442 if (stat(input_name, &sb) != 0
443 || (sb.st_mode & S_IFMT) != S_IFREG) {
444 failed("input is not a file");
447 if (sb.st_size == 0) {
448 failed("input is empty");
452 * None of the arrays could be larger than the input-file, and since it
453 * is small, just allocate the maximum for simplicity.
455 if ((my_blob = malloc((size_t) sb.st_size + 1)) == 0 ||
456 (my_boolcodes = typeCalloc(char *, sb.st_size)) == 0 ||
457 (my_numcodes = typeCalloc(char *, sb.st_size)) == 0 ||
458 (my_numvalues = typeCalloc(char *, sb.st_size)) == 0 ||
459 (my_strcodes = typeCalloc(char *, sb.st_size)) == 0 ||
460 (my_strvalues = typeCalloc(char *, sb.st_size)) == 0) {
461 failed("cannot allocate memory for input-file");
464 if ((fp = fopen(input_name, "r")) == 0)
465 failed("cannot open input-file");
466 len = fread(my_blob, sizeof(char), (size_t) sb.st_size, fp);
467 my_blob[sb.st_size] = '\0';
471 * First, get rid of comments and escaped newlines, as well as repeated
472 * colons to construct a canonical entry.
475 for (j = k = 0; j < len; ++j) {
494 state = pDescription;
505 my_blob[k++] = (char) ch;
508 if (isalpha(UChar(ch)))
511 fprintf(stderr, "OOPS @%d:%.20s\n", __LINE__, my_blob + j);
512 my_blob[k++] = (char) ch;
532 my_blob[k++] = (char) ch;
554 state = pDescription;
557 my_blob[k++] = (char) ch;
571 my_blob[k++] = (char) ch;
580 my_blob[k++] = (char) ch;
583 my_blob[k++] = (char) ch;
595 * Then, parse what's left, making indexes of the names and values.
598 for (j = 0; my_blob[j] != '\0'; ++j) {
601 switch (my_blob[j]) {
607 if (my_blob[j + 1] != '\0' && my_blob[j + 1] != ',')
619 if (isalpha(UChar(my_blob[j]))) {
620 for (jl = 1; isalnum(UChar(my_blob[j + jl])); ++jl) {
627 switch (my_blob[j + jl]) {
629 my_numvalues[count_nums] = &my_blob[j + jl + 1];
630 my_numcodes[count_nums++] = &my_blob[j];
631 my_blob[j + jl] = '\0';
636 my_strvalues[count_strs] = &my_blob[j + jl + 1];
637 my_strcodes[count_strs++] = &my_blob[j];
638 my_blob[j + jl] = '\0';
643 if (my_blob[j + jl] == '@') {
645 * We cannot get the type for a cancelled item
646 * directly, but can infer it assuming the input
647 * came from infocmp, which puts the data in a
651 my_strvalues[count_strs] = empty;
652 my_strcodes[count_strs++] = &my_blob[j];
653 } else if (count_nums) {
654 my_numvalues[count_nums] = empty;
655 my_numcodes[count_nums++] = &my_blob[j];
657 my_boolcodes[count_bools++] = &my_blob[j];
659 my_blob[j + jl] = '\0';
662 my_boolcodes[count_bools++] = &my_blob[j];
663 my_blob[j + jl] = '\0';
666 state = (isCapName(my_blob[j + 1])
674 if (!isdigit(UChar(my_blob[j]))) {
680 switch (my_blob[j]) {
682 if (my_blob[j + 1] != '\0') {
702 my_boolcodes[count_bools] = 0;
703 my_numcodes[count_nums] = 0;
704 my_numvalues[count_nums] = 0;
705 my_strcodes[count_strs] = 0;
706 my_strvalues[count_strs] = 0;
709 printf("# bools:%d\n", (int) count_bools);
710 for (j = 0; my_boolcodes[j]; ++j)
711 printf("\t%s,\n", my_boolcodes[j]);
713 printf("# numbers:%d\n", (int) count_nums);
714 for (j = 0; my_numcodes[j]; ++j)
715 printf("\t%s#%s,\n", my_numcodes[j], my_numvalues[j]);
717 printf("# strings:%d\n", (int) count_strs);
718 for (j = 0; my_strcodes[j]; ++j)
719 printf("\t%s=%s,\n", my_strcodes[j], my_strvalues[j]);
725 copy_code_list(NCURSES_CONST char *const *list)
734 for (pass = 0; pass < 2; ++pass) {
735 for (count = 0; list[count] != 0; ++count) {
736 size_t chunk = strlen(list[count]) + 1;
740 result[count] = unused;
741 _nc_STRCPY(unused, list[count], length);
746 blob = malloc(length);
747 result = typeCalloc(char *, count + 1);
749 if (blob == 0 || result == 0)
750 failed("copy_code_list failed");
759 free_code_list(char **list)
767 #endif /* USE_CODE_LISTS */
772 static const char *msg[] =
774 "Usage: demo_terminfo [options] [terminal]",
776 "If no options are given, print all (boolean, numeric, string)",
777 "capabilities for the given terminal, using short names.",
780 " -a try all names, print capabilities found",
781 " -b print boolean-capabilities",
782 " -d LIST colon-separated list of databases to use",
783 " -e NAME environment variable to set with -d option",
784 " -f print full names",
785 " -i NAME terminal description to use as names for \"-a\" option",
786 " -n print numeric-capabilities",
787 " -q quiet (prints only counts)",
788 " -r COUNT repeat for given count",
789 " -s print string-capabilities",
790 #ifdef NCURSES_VERSION
791 " -x print extended capabilities",
792 " -y direct-lookup names of extended capabilities",
796 for (n = 0; n < SIZEOF(msg); ++n) {
797 fprintf(stderr, "%s\n", msg[n]);
799 ExitProgram(EXIT_FAILURE);
803 main(int argc, char *argv[])
809 char *input_name = 0;
811 while ((n = getopt(argc, argv, "abd:e:fi:nqr:sxy")) != -1) {
838 if ((r_opt = atoi(optarg)) <= 0)
844 #ifdef NCURSES_VERSION
859 #if HAVE_USE_EXTENDED_NAMES
860 use_extended_names(x_opt);
863 if (!(b_opt || n_opt || s_opt)) {
872 for (repeat = 0; repeat < r_opt; ++repeat) {
874 for (n = optind; n < argc; ++n) {
875 brute_force(argv[n]);
877 } else if ((name = getenv("TERM")) != 0) {
880 static char dumb[] = "dumb";
885 if (input_name != 0) {
886 parse_description(input_name);
890 my_boolcodes = copy_code_list(boolnames);
891 my_numcodes = copy_code_list(numnames);
892 my_strcodes = copy_code_list(strnames);
896 failed("no capability-lists available (use -i option)");
898 #endif /* USE_CODE_LISTS */
899 for (repeat = 0; repeat < r_opt; ++repeat) {
901 for (n = optind; n < argc; ++n) {
902 demo_terminfo(argv[n]);
904 } else if ((name = getenv("TERM")) != 0) {
907 static char dumb[] = "dumb";
913 #define PLURAL(n) n, (n != 1) ? "s" : ""
914 printf("%ld value%s (%ld boolean%s, %ld number%s, %ld string%s)\n",
915 PLURAL(total_values),
916 PLURAL(total_b_values),
917 PLURAL(total_n_values),
918 PLURAL(total_s_values));
922 if (input_name != 0) {
934 free_code_list(my_boolcodes);
935 free_code_list(my_numcodes);
936 free_code_list(my_strcodes);
939 #endif /* NO_LEAKS */
941 ExitProgram(EXIT_SUCCESS);
944 #else /* !HAVE_TIGETSTR */
946 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
948 failed("This program requires the terminfo functions such as tigetstr");
949 ExitProgram(EXIT_FAILURE);
951 #endif /* HAVE_TIGETSTR */