1 /****************************************************************************
2 * Copyright (c) 2009-2015,2016 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.42 2016/06/18 23:57:33 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 static bool x_opt = FALSE;
73 static bool y_opt = FALSE;
77 static char **db_list;
81 static char **my_boolcodes;
82 static char **my_numcodes;
83 static char **my_numvalues;
84 static char **my_strcodes;
85 static char **my_strvalues;
87 static long total_values;
88 static long total_b_values;
89 static long total_n_values;
90 static long total_s_values;
93 #define FNAME(type) "%s %-*s = ", #type, f_opt ? 24 : FCOLS
96 make_dbitem(char *p, char *q)
98 char *result = malloc(strlen(e_opt) + 2 + (size_t) (p - q));
99 sprintf(result, "%s=%.*s", e_opt, (int) (p - q), q);
106 if (d_opt && e_opt) {
109 for (pass = 0; pass < 2; ++pass) {
113 for (p = q = d_opt; *p != '\0'; ++p) {
117 db_list[count] = make_dbitem(p, q);
126 db_list[count] = make_dbitem(p, q);
131 db_list = typeCalloc(char *, count + 1);
143 if ((result = db_list[db_item]) == 0) {
150 printf("** %s\n", result);
160 for (n = 0; db_list[n]; ++n)
169 dumpit(NCURSES_CONST char *cap, const char *show)
174 if ((str = tigetstr(cap)) != 0 && (str != (char *) -1)) {
178 printf(FNAME(str), show ? show : cap);
180 int ch = UChar(*str++);
186 fputs("\\E", stdout);
189 fputs("\\b", stdout);
192 fputs("\\f", stdout);
195 fputs("\\n", stdout);
198 fputs("\\r", stdout);
201 fputs("\\s", stdout);
204 fputs("\\t", stdout);
207 fputs("\\^", stdout);
210 fputs("\\072", stdout);
213 fputs("\\\\", stdout);
219 printf("^%c", ch + '@');
221 printf("\\%03o", ch);
227 } else if ((num = tigetnum(cap)) >= 0) {
231 printf(FNAME(num), show ? show : cap);
232 printf(" %d\n", num);
234 } else if ((num = tigetflag(cap)) >= 0) {
238 printf(FNAME(flg), show ? show : cap);
239 printf("%s\n", num ? "true" : "false");
247 #define isCapName(c) (isalnum(UChar(c)) || ((c) == '_'))
248 #define LegalItem(c,n) (n)
251 brute_force(const char *name)
253 #define MAX_FORCE 5 /* omit "colors", since CPU-time is a problem */
254 static const char legal[] = "\
256 ABCDEFGHIJKLMNOPQRSTUVWXYZ\
257 abcdefghijklmnopqrstuvwxyz_";
262 char cap[MAX_FORCE + 1];
263 int item[MAX_FORCE + 1];
266 putenv(next_dbitem());
269 printf("Terminal type \"%s\"\n", name);
270 setupterm((NCURSES_CONST char *) name, 1, (int *) 0);
272 if (strcmp(name, ttytype))
273 printf("... actual \"%s\"\n", ttytype);
276 for (length = 1; length <= MAX_FORCE; ++length) {
277 /* set all digits to zeros */
278 for (j = 0; j < length; ++j) {
279 item[j] = LegalItem(j, 0);
284 /* copy digits to cap-name */
285 for (j = 0; j < length; ++j) {
286 cap[j] = legal[item[j]];
294 for (; k >= 0; --k) {
296 if (legal[item[k]]) {
301 legal[item[k - 1] + 1]) {
302 for (j = k; j < length; ++j) {
303 item[j] = LegalItem(j, 0);
312 del_curterm(cur_term);
316 #define fullname(type,n) f_opt ? type##fnames[n] : cap
318 #define fullname(type,n) cap
322 demo_terminfo(char *name)
325 NCURSES_CONST char *cap;
328 putenv(next_dbitem());
331 printf("Terminal type \"%s\"\n", name);
332 setupterm(name, 1, (int *) 0);
336 cap = my_boolcodes[n];
339 dumpit(cap, fullname(bool, n));
345 cap = my_numcodes[n];
348 dumpit(cap, fullname(num, n));
354 cap = my_strcodes[n];
357 dumpit(cap, fullname(str, n));
360 #ifdef NCURSES_VERSION
361 if (x_opt && (my_blob == 0)) {
365 TERMTYPE *term = &(cur_term->type);
367 && ((NUM_BOOLEANS(term) != BOOLCOUNT)
368 || (NUM_NUMBERS(term) != NUMCOUNT)
369 || (NUM_STRINGS(term) != STRCOUNT))) {
370 for (n = BOOLCOUNT; n < NUM_BOOLEANS(term); ++n) {
371 dumpit(ExtBoolname(term, (int) n, boolnames), NULL);
373 for (n = NUMCOUNT; n < NUM_NUMBERS(term); ++n) {
374 dumpit(ExtNumname(term, (int) n, numnames), NULL);
376 for (n = STRCOUNT; n < NUM_STRINGS(term); ++n) {
377 dumpit(ExtStrname(term, (int) n, strnames), NULL);
383 static const char *xterm_keys[] =
385 "kDC", "kDN", "kEND", "kHOM", "kIC",
386 "kLFT", "kNXT", "kPRV", "kRIT", "kUP",
388 for (n = 0; n < SIZEOF(xterm_keys); ++n) {
389 for (mod = 0; mod < 8; ++mod) {
391 /* these happen to be standard - avoid duplicates */
392 if (!strcmp(xterm_keys[n], "kDC") ||
393 !strcmp(xterm_keys[n], "kEND") ||
394 !strcmp(xterm_keys[n], "kHOM") ||
395 !strcmp(xterm_keys[n], "kLFT") ||
396 !strcmp(xterm_keys[n], "kRIT")) {
399 sprintf(temp, "%.*s", 8, xterm_keys[n]);
401 sprintf(temp, "%.*s%d", 8, xterm_keys[n], mod);
409 del_curterm(cur_term);
424 parse_description(const char *input_name)
426 static char empty[1];
430 size_t count_bools = 0;
431 size_t count_nums = 0;
432 size_t count_strs = 0;
437 if (stat(input_name, &sb) != 0
438 || (sb.st_mode & S_IFMT) != S_IFREG) {
439 failed("input is not a file");
442 if (sb.st_size == 0) {
443 failed("input is empty");
447 * None of the arrays could be larger than the input-file, and since it
448 * is small, just allocate the maximum for simplicity.
450 if ((my_blob = malloc((size_t) sb.st_size + 1)) == 0 ||
451 (my_boolcodes = typeCalloc(char *, sb.st_size)) == 0 ||
452 (my_numcodes = typeCalloc(char *, sb.st_size)) == 0 ||
453 (my_numvalues = typeCalloc(char *, sb.st_size)) == 0 ||
454 (my_strcodes = typeCalloc(char *, sb.st_size)) == 0 ||
455 (my_strvalues = typeCalloc(char *, sb.st_size)) == 0) {
456 failed("cannot allocate memory for input-file");
459 if ((fp = fopen(input_name, "r")) == 0)
460 failed("cannot open input-file");
461 len = fread(my_blob, sizeof(char), (size_t) sb.st_size, fp);
462 my_blob[sb.st_size] = '\0';
466 * First, get rid of comments and escaped newlines, as well as repeated
467 * colons to construct a canonical entry.
470 for (j = k = 0; j < len; ++j) {
489 state = pDescription;
500 my_blob[k++] = (char) ch;
503 if (isalpha(UChar(ch)))
506 fprintf(stderr, "OOPS @%d:%.20s\n", __LINE__, my_blob + j);
507 my_blob[k++] = (char) ch;
527 my_blob[k++] = (char) ch;
549 state = pDescription;
552 my_blob[k++] = (char) ch;
566 my_blob[k++] = (char) ch;
575 my_blob[k++] = (char) ch;
578 my_blob[k++] = (char) ch;
590 * Then, parse what's left, making indexes of the names and values.
593 for (j = 0; my_blob[j] != '\0'; ++j) {
596 switch (my_blob[j]) {
602 if (my_blob[j + 1] != '\0' && my_blob[j + 1] != ',')
614 if (isalpha(UChar(my_blob[j]))) {
615 for (jl = 1; isalnum(UChar(my_blob[j + jl])); ++jl) {
622 switch (my_blob[j + jl]) {
624 my_numvalues[count_nums] = &my_blob[j + jl + 1];
625 my_numcodes[count_nums++] = &my_blob[j];
626 my_blob[j + jl] = '\0';
631 my_strvalues[count_strs] = &my_blob[j + jl + 1];
632 my_strcodes[count_strs++] = &my_blob[j];
633 my_blob[j + jl] = '\0';
638 if (my_blob[j + jl] == '@') {
640 * We cannot get the type for a cancelled item
641 * directly, but can infer it assuming the input
642 * came from infocmp, which puts the data in a
646 my_strvalues[count_strs] = empty;
647 my_strcodes[count_strs++] = &my_blob[j];
648 } else if (count_nums) {
649 my_numvalues[count_nums] = empty;
650 my_numcodes[count_nums++] = &my_blob[j];
652 my_boolcodes[count_bools++] = &my_blob[j];
654 my_blob[j + jl] = '\0';
657 my_boolcodes[count_bools++] = &my_blob[j];
658 my_blob[j + jl] = '\0';
661 state = (isCapName(my_blob[j + 1])
669 if (!isdigit(UChar(my_blob[j]))) {
675 switch (my_blob[j]) {
677 if (my_blob[j + 1] != '\0') {
697 my_boolcodes[count_bools] = 0;
698 my_numcodes[count_nums] = 0;
699 my_numvalues[count_nums] = 0;
700 my_strcodes[count_strs] = 0;
701 my_strvalues[count_strs] = 0;
704 printf("# bools:%d\n", (int) count_bools);
705 for (j = 0; my_boolcodes[j]; ++j)
706 printf("\t%s,\n", my_boolcodes[j]);
708 printf("# numbers:%d\n", (int) count_nums);
709 for (j = 0; my_numcodes[j]; ++j)
710 printf("\t%s#%s,\n", my_numcodes[j], my_numvalues[j]);
712 printf("# strings:%d\n", (int) count_strs);
713 for (j = 0; my_strcodes[j]; ++j)
714 printf("\t%s=%s,\n", my_strcodes[j], my_strvalues[j]);
720 copy_code_list(NCURSES_CONST char *const *list)
729 for (pass = 0; pass < 2; ++pass) {
730 for (count = 0; list[count] != 0; ++count) {
731 size_t chunk = strlen(list[count]) + 1;
735 result[count] = unused;
736 strcpy(unused, list[count]);
741 blob = malloc(length);
742 result = typeCalloc(char *, count + 1);
744 if (blob == 0 || result == 0)
745 failed("copy_code_list failed");
756 static const char *msg[] =
758 "Usage: demo_terminfo [options] [terminal]",
760 "If no options are given, print all (boolean, numeric, string)",
761 "capabilities for the given terminal, using short names.",
764 " -a try all names, print capabilities found",
765 " -b print boolean-capabilities",
766 " -d LIST colon-separated list of databases to use",
767 " -e NAME environment variable to set with -d option",
768 " -f print full names",
769 " -i NAME terminal description to use as names for \"-a\" option",
770 " -n print numeric-capabilities",
771 " -q quiet (prints only counts)",
772 " -r COUNT repeat for given count",
773 " -s print string-capabilities",
774 #ifdef NCURSES_VERSION
775 " -x print extended capabilities",
776 " -y direct-lookup names of extended capabilities",
780 for (n = 0; n < SIZEOF(msg); ++n) {
781 fprintf(stderr, "%s\n", msg[n]);
783 ExitProgram(EXIT_FAILURE);
787 main(int argc, char *argv[])
793 char *input_name = 0;
795 while ((n = getopt(argc, argv, "abd:e:fi:nqr:sxy")) != -1) {
822 if ((r_opt = atoi(optarg)) <= 0)
828 #ifdef NCURSES_VERSION
843 #if HAVE_USE_EXTENDED_NAMES
844 use_extended_names(x_opt);
847 if (!(b_opt || n_opt || s_opt)) {
856 for (repeat = 0; repeat < r_opt; ++repeat) {
858 for (n = optind; n < argc; ++n) {
859 brute_force(argv[n]);
861 } else if ((name = getenv("TERM")) != 0) {
864 static char dumb[] = "dumb";
869 if (input_name != 0) {
870 parse_description(input_name);
874 my_boolcodes = copy_code_list(boolnames);
875 my_numcodes = copy_code_list(numnames);
876 my_strcodes = copy_code_list(strnames);
880 failed("no capability-lists available (use -i option)");
882 #endif /* USE_CODE_LISTS */
883 for (repeat = 0; repeat < r_opt; ++repeat) {
885 for (n = optind; n < argc; ++n) {
886 demo_terminfo(argv[n]);
888 } else if ((name = getenv("TERM")) != 0) {
891 static char dumb[] = "dumb";
897 #define PLURAL(n) n, (n != 1) ? "s" : ""
898 printf("%ld value%s (%ld boolean%s, %ld number%s, %ld string%s)\n",
899 PLURAL(total_values),
900 PLURAL(total_b_values),
901 PLURAL(total_n_values),
902 PLURAL(total_s_values));
916 ExitProgram(EXIT_SUCCESS);
919 #else /* !HAVE_TIGETSTR */
921 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
923 failed("This program requires the terminfo functions such as tigetstr");
924 ExitProgram(EXIT_FAILURE);
926 #endif /* HAVE_TIGETSTR */