ncurses 6.2 - patch 20200321
[ncurses.git] / test / list_keys.c
index b43dd37ab73f324ff5cecbc77937b329e68337ff..cdad60e928b6a92a9a77ce4cce74e9d3ff53234f 100644 (file)
@@ -1,5 +1,6 @@
 /****************************************************************************
- * Copyright (c) 2016 Free Software Foundation, Inc.                        *
+ * Copyright 2018-2019,2020 Thomas E. Dickey                                *
+ * Copyright 2016,2017 Free Software Foundation, Inc.                       *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
@@ -26,7 +27,7 @@
  * authorization.                                                           *
  ****************************************************************************/
 /*
- * $Id: list_keys.c,v 1.9 2016/06/18 22:18:30 tom Exp $
+ * $Id: list_keys.c,v 1.26 2020/02/02 23:34:34 tom Exp $
  *
  * Author: Thomas E Dickey
  *
@@ -49,6 +50,7 @@
 #if defined(HAVE_CURSES_DATA_BOOLNAMES) || defined(DECL_CURSES_DATA_BOOLNAMES)
 
 static bool f_opt = FALSE;
+static bool m_opt = FALSE;
 static bool t_opt = FALSE;
 static bool x_opt = FALSE;
 
@@ -87,58 +89,61 @@ static int
 show_key(const char *name, bool show)
 {
     int width = 0;
-    char buffer[10];
-    char *value = tigetstr(name);
+    NCURSES_CONST char *value = tigetstr((NCURSES_CONST char *) name);
 
     if (show && t_opt)
        fputc('"', stdout);
 
     if (value != 0 && value != (char *) -1) {
        while (*value != 0) {
+           char buffer[10];
            int ch = UChar(*value++);
            switch (ch) {
            case '\177':
-               strcpy(buffer, "^?");
+               _nc_STRCPY(buffer, "^?", sizeof(buffer));
                break;
            case '\033':
-               strcpy(buffer, "\\E");
+               _nc_STRCPY(buffer, "\\E", sizeof(buffer));
                break;
            case '\b':
-               strcpy(buffer, "\\b");
+               _nc_STRCPY(buffer, "\\b", sizeof(buffer));
                break;
            case '\f':
-               strcpy(buffer, "\\f");
+               _nc_STRCPY(buffer, "\\f", sizeof(buffer));
                break;
            case '\n':
-               strcpy(buffer, "\\n");
+               _nc_STRCPY(buffer, "\\n", sizeof(buffer));
                break;
            case '\r':
-               strcpy(buffer, "\\r");
+               _nc_STRCPY(buffer, "\\r", sizeof(buffer));
                break;
            case ' ':
-               strcpy(buffer, "\\s");
+               _nc_STRCPY(buffer, "\\s", sizeof(buffer));
                break;
            case '\t':
-               strcpy(buffer, "\\t");
+               _nc_STRCPY(buffer, "\\t", sizeof(buffer));
                break;
            case '^':
-               strcpy(buffer, "\\^");
+               _nc_STRCPY(buffer, "\\^", sizeof(buffer));
                break;
            case ':':
-               strcpy(buffer, "\\072");
+               _nc_STRCPY(buffer, "\\072", sizeof(buffer));
                break;
            case '\\':
-               strcpy(buffer, "\\\\");
+               _nc_STRCPY(buffer, "\\\\", sizeof(buffer));
                break;
            default:
                if (t_opt && ch == '"') {
-                   strcpy(buffer, "\"\"");
+                   _nc_STRCPY(buffer, "\"\"", sizeof(buffer));
                } else if (isgraph(ch)) {
-                   sprintf(buffer, "%c", ch);
+                   _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
+                               "%c", ch);
                } else if (ch < 32) {
-                   sprintf(buffer, "^%c", ch + '@');
+                   _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
+                               "^%c", ch + '@');
                } else {
-                   sprintf(buffer, "\\%03o", ch);
+                   _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
+                               "\\%03o", ch);
                }
                break;
            }
@@ -155,7 +160,7 @@ show_key(const char *name, bool show)
 }
 
 static bool
-valid_key(const char *name, TERMINAL ** terms, int count)
+valid_key(const char *name, TERMINAL **terms, int count)
 {
     bool result = FALSE;
     if (*name == 'k') {
@@ -193,8 +198,8 @@ compare_keys(const void *a, const void *b)
 static void
 draw_line(int width)
 {
-    int j;
     if (!t_opt) {
+       int j;
        for (j = 0; j < width; ++j) {
            printf("-");
        }
@@ -202,17 +207,78 @@ draw_line(int width)
     }
 }
 
+static const char *
+modified_key(const char *name)
+{
+    static char result[100];
+    char buffer[sizeof(result) - 10];
+    int value;
+    char chr;
+    static const char *modifiers[][2] =
+    {
+       {"", ""},
+       {"s-", "shift-"},
+       {"a-", "alt-"},
+       {"as-", "alt-shift-"},
+       {"c-", "ctrl-"},
+       {"sc-", "ctrl-shift-"},
+       {"ac-", "alt-ctrl-"},
+       {"acs-" "alt-ctrl-shift-"},
+    };
+
+    if (strlen(name) > (sizeof(result) - 3)) {
+       *result = '\0';
+    } else if (sscanf(name, "kf%d%c", &value, &chr) == 1 &&
+              value >= 1 &&
+              value <= 63) {
+       /* map 1,2,3,4,5,6,7 to 1,2,5,... */
+       int map = ((value - 1) / 12);
+       int key = ((value - 1) % 12);
+       int bit1 = (map & 2);
+       int bit2 = (map & 4);
+       map &= ~6;
+       map |= (bit1 << 1) | (bit2 >> 1);
+       _nc_SPRINTF(result, _nc_SLIMIT(sizeof(result))
+                   "%sF%d", modifiers[map][(unsigned) f_opt], 1 + key);
+    } else if (sscanf(name, "k%[A-Z]%d%c", buffer, &value, &chr) == 2 &&
+              (value > 1 &&
+               value <= 8) &&
+              (!strcmp(buffer, "UP") ||
+               !strcmp(buffer, "DN") ||
+               !strcmp(buffer, "LFT") ||
+               !strcmp(buffer, "RIT") ||
+               !strcmp(buffer, "IC") ||
+               !strcmp(buffer, "DC") ||
+               !strcmp(buffer, "HOM") ||
+               !strcmp(buffer, "END") ||
+               !strcmp(buffer, "NXT") ||
+               !strcmp(buffer, "PRV"))) {
+       _nc_SPRINTF(result, _nc_SLIMIT(sizeof(result))
+                   "%sk%s", modifiers[value - 1][(unsigned) f_opt], buffer);
+    } else if (sscanf(name, "k%[A-Z]%c", buffer, &chr) == 1 &&
+              (!strcmp(buffer, "UP") ||
+               !strcmp(buffer, "DN"))) {
+       _nc_SPRINTF(result, _nc_SLIMIT(sizeof(result))
+                   "%sk%s", modifiers[1][(unsigned) f_opt], buffer);
+    } else {
+       *result = '\0';
+    }
+    return result;
+}
+
 static void
-list_keys(TERMINAL ** terms, int count)
+list_keys(TERMINAL **terms, int count)
 {
     int j, k;
     int widths0 = 0;
     int widths1 = 0;
+    int widths2 = 0;
     int widthsx;
     int check;
     size_t total = 0;
     size_t actual = 0;
     const char *name = f_opt ? "strfname" : "strname";
+    const char *modifier = "extended";
     KEYNAMES *list;
 
     for (total = 0; strnames[total]; ++total) {
@@ -220,10 +286,10 @@ list_keys(TERMINAL ** terms, int count)
     }
 #if NCURSES_XNAMES
     if (x_opt) {
-       TERMTYPE *term;
        for (k = 0; k < count; ++k) {
+           TERMTYPE *term;
            set_curterm(terms[k]);
-           term = &(cur_term->type);
+           term = (TERMTYPE *) cur_term;
            total += (size_t) (NUM_STRINGS(term) - STRCOUNT);
        }
     }
@@ -233,18 +299,20 @@ list_keys(TERMINAL ** terms, int count)
        Type(j) = ktOther;
        if (sscanf(strnames[j], "kf%d", &k) == 1) {
            Type(j) = ktFunction;
-       } else if (!strncmp(strnames[j], "kcu", 3)) {
+       } else if (!(strncmp) (strnames[j], "kcu", 3)) {
            Type(j) = ktCursor;
        }
        Name(j) = strnames[j];
     }
 #if NCURSES_XNAMES
     if (x_opt) {
-       TERMTYPE *term;
        int m, n;
+
        for (k = 0; k < count; ++k) {
+           TERMTYPE *term;
+
            set_curterm(terms[k]);
-           term = &(cur_term->type);
+           term = (TERMTYPE *) cur_term;
            for (n = STRCOUNT; n < NUM_STRINGS(term); ++n) {
                bool found = FALSE;
                const char *estr = ExtStrname(term, (int) n, strnames);
@@ -266,11 +334,14 @@ list_keys(TERMINAL ** terms, int count)
     qsort(list, actual, sizeof(KEYNAMES), compare_keys);
 
     widths0 = (int) strlen(name);
+    if (m_opt)
+       widths1 = (int) strlen(modifier);
+
     for (k = 0; k < count; ++k) {
        set_curterm(terms[k]);
        check = (int) strlen(termname());
-       if (widths1 < check)
-           widths1 = check;
+       if (widths2 < check)
+           widths2 = check;
     }
     for (j = 0; Name(j) != 0; ++j) {
        if (valid_key(Name(j), terms, count)) {
@@ -280,17 +351,26 @@ list_keys(TERMINAL ** terms, int count)
                widths0 = check;
            for (k = 0; k < count; ++k) {
                set_curterm(terms[k]);
-               check = show_key(Name(j), FALSE);
-               if (widths1 < check)
-                   widths1 = check;
+               check = show_key(Name(j), FALSE) + 1;
+               if (widths2 < check)
+                   widths2 = check;
+               if (m_opt) {
+                   check = (int) strlen(modified_key(Name(j)));
+                   if (widths1 < check)
+                       widths1 = check;
+               }
            }
        }
     }
 
     if (t_opt) {
        printf("\"%s\"", name);
+       if (m_opt)
+           printf(",\"%s\"", modifier);
     } else {
        printf("%-*s", widths0, name);
+       if (m_opt)
+           printf(" %-*s", widths1, modifier);
     }
     for (k = 0; k < count; ++k) {
        set_curterm(terms[k]);
@@ -299,12 +379,12 @@ list_keys(TERMINAL ** terms, int count)
        } else if (k + 1 >= count) {
            printf(" %s", termname());
        } else {
-           printf(" %-*s", widths1, termname());
+           printf(" %-*s", widths2, termname());
        }
     }
     printf("\n");
 
-    widthsx = widths0 + ((count + 1) * widths1);
+    widthsx = widths0 + ((count + 1) * widths2);
 
     for (j = 0; Name(j) != 0; ++j) {
        if (j == 0 || (Type(j) != Type(j - 1)))
@@ -313,8 +393,12 @@ list_keys(TERMINAL ** terms, int count)
            const char *label = f_opt ? full_name(Name(j)) : Name(j);
            if (t_opt) {
                printf("\"%s\"", label);
+               if (m_opt)
+                   printf(",\"%s\"", modified_key(Name(j)));
            } else {
                printf("%-*s", widths0, label);
+               if (m_opt)
+                   printf(" %-*s", widths1, modified_key(Name(j)));
            }
            for (k = 0; k < count; ++k) {
                printf(t_opt ? "," : " ");
@@ -322,13 +406,14 @@ list_keys(TERMINAL ** terms, int count)
                check = show_key(Name(j), TRUE);
                if (!t_opt) {
                    if (k + 1 < count) {
-                       printf("%*s", widths1 - check, " ");
+                       printf("%*s", widths2 - check, " ");
                    }
                }
            }
            printf("\n");
        }
     }
+    free(list);
 }
 
 static void
@@ -342,6 +427,7 @@ usage(void)
        "",
        "Options:",
        " -f       print full names",
+       " -m       print modifier-column for shift/control keys",
        " -t       print result as CSV table",
 #ifdef NCURSES_VERSION
        " -x       print extended capabilities",
@@ -358,13 +444,16 @@ int
 main(int argc, char *argv[])
 {
     int n;
-    TERMINAL **terms = typeCalloc(TERMINAL *, argc);
+    TERMINAL **terms = typeCalloc(TERMINAL *, argc + 1);
 
-    while ((n = getopt(argc, argv, "ftx")) != -1) {
+    while ((n = getopt(argc, argv, "fmtx")) != -1) {
        switch (n) {
        case 'f':
            f_opt = TRUE;
            break;
+       case 'm':
+           m_opt = TRUE;
+           break;
        case 't':
            t_opt = TRUE;
            break;
@@ -383,11 +472,24 @@ main(int argc, char *argv[])
     use_extended_names(x_opt);
 #endif
 
-    for (n = optind; n < argc; ++n) {
-       setupterm((NCURSES_CONST char *) argv[n], 1, (int *) 0);
-       terms[n - optind] = cur_term;
+    if (optind < argc) {
+       int found = 0;
+       int status;
+       for (n = optind; n < argc; ++n) {
+           setupterm((NCURSES_CONST char *) argv[n], 1, &status);
+           if (status > 0 && cur_term != 0) {
+               terms[found++] = cur_term;
+           }
+       }
+       if (found)
+           list_keys(terms, found);
+    } else {
+       setupterm(NULL, 1, (int *) 0);
+       terms[0] = cur_term;
+       list_keys(terms, 1);
     }
-    list_keys(terms, argc - optind);
+
+    free(terms);
 
     ExitProgram(EXIT_SUCCESS);
 }