ncurses 6.2 - patch 20200627
[ncurses.git] / test / foldkeys.c
1 /****************************************************************************
2  * Copyright 2018-2019,2020 Thomas E. Dickey                                *
3  * Copyright 2006-2016,2017 Free Software Foundation, Inc.                  *
4  *                                                                          *
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:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
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.                               *
23  *                                                                          *
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       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /*
31  * Author: Thomas E. Dickey, 2006
32  *
33  * $Id: foldkeys.c,v 1.9 2020/02/02 23:34:34 tom Exp $
34  *
35  * Demonstrate a method for altering key definitions at runtime.
36  *
37  * This program reads the key definitions, merging those which have xterm-style
38  * modifiers into their equivalents which have no modifiers.  It does this
39  * merging only for the keys which are defined in the terminal description.
40  */
41
42 #define NEED_TIME_H
43 #include <test.priv.h>
44
45 #if defined(NCURSES_VERSION) && NCURSES_EXT_FUNCS
46
47 #define MY_LOGFILE "demo_foldkeys.log"
48 #define MY_KEYS (KEY_MAX + 1)
49
50 /*
51  * Log the most recently-written line to our logfile
52  */
53 static void
54 log_last_line(WINDOW *win)
55 {
56     FILE *fp;
57
58     if ((fp = fopen(MY_LOGFILE, "a")) != 0) {
59         char temp[256];
60         int y, x, n;
61         int need = sizeof(temp) - 1;
62         if (need > COLS)
63             need = COLS;
64         getyx(win, y, x);
65         wmove(win, y - 1, 0);
66         n = winnstr(win, temp, need);
67         while (n-- > 0) {
68             if (isspace(UChar(temp[n])))
69                 temp[n] = '\0';
70             else
71                 break;
72         }
73         wmove(win, y, x);
74         fprintf(fp, "%s\n", temp);
75         fclose(fp);
76     }
77 }
78
79 /*
80  * ncurses has no API for telling what the actual last key-code is.  That is
81  * a secret because the codes past KEY_MAX are computed at run-time and may
82  * differ depending on the previous calls to newterm(), etc.  It is unlikely
83  * that one could have more than a thousand key definitions...
84  */
85 #define MAX_KEYS 2000
86
87 typedef struct {
88     const char *name;
89     const char *value;
90     int code;
91     int state;
92 } KeyInfo;
93
94 static void
95 demo_foldkeys(void)
96 {
97     KeyInfo info[MAX_KEYS];
98     int info_len = 0;
99     int merged = 0;
100     int code;
101     int j, k;
102
103     /*
104      * Tell ncurses that we want to use function keys.  That will make it add
105      * any user-defined keys that appear in the terminfo.
106      */
107     keypad(stdscr, TRUE);
108
109     /*
110      * List the predefined keys using the strnames[] array.
111      */
112     for (code = 0; code < STRCOUNT; ++code) {
113         NCURSES_CONST char *name = strnames[code];
114         NCURSES_CONST char *value = tigetstr(name);
115         if (value != 0 && value != (NCURSES_CONST char *) -1) {
116             info[info_len].name = strnames[code];
117             info[info_len].code = key_defined(value);
118             info[info_len].value = value;
119             info[info_len].state = 0;
120             if (info[info_len].code > 0)
121                 ++info_len;
122         }
123     }
124
125     /*
126      * We can get the names for user-defined keys from keyname().  It returns
127      * a name like KEY_foo for the predefined keys, which tigetstr() does not
128      * understand.
129      */
130     for (code = KEY_MAX; code < MAX_KEYS; ++code) {
131         NCURSES_CONST char *name = keyname(code);
132         if (name != 0) {
133             info[info_len].name = name;
134             info[info_len].code = code;
135             info[info_len].value = tigetstr(name);
136             info[info_len].state = 0;
137             ++info_len;
138         }
139     }
140     printw("Initially %d key definitions\n", info_len);
141
142     /*
143      * Look for keys that have xterm-style modifiers.
144      */
145     for (j = 0; j < info_len; ++j) {
146         int first, second;
147         char final[2];
148         char *value;
149         size_t need = 0;
150         if (info[j].state == 0
151             && sscanf(info[j].value,
152                       "\033[%d;%d%c",
153                       &first,
154                       &second,
155                       final) == 3
156             && *final != ';'
157             && (need = strlen(info[j].value)) != 0
158             && (value = strdup(info[j].value)) != 0) {
159             _nc_SPRINTF(value, _nc_SLIMIT(need) "\033[%d%c", first, *final);
160             for (k = 0; k < info_len; ++k) {
161                 if (info[k].state == 0
162                     && !strcmp(info[k].value, value)) {
163                     info[j].state = 1;
164                     break;
165                 }
166             }
167             if (info[j].state == 0) {
168                 _nc_SPRINTF(value, _nc_SLIMIT(need) "\033O%c", *final);
169                 for (k = 0; k < info_len; ++k) {
170                     if (info[k].state == 0
171                         && !strcmp(info[k].value, value)) {
172                         info[j].state = 1;
173                         break;
174                     }
175                 }
176             }
177             if (info[j].state == 1) {
178                 if ((define_key(info[j].value, info[k].code)) != ERR) {
179                     printw("map %s to %s\n", info[j].value, info[k].value);
180                     keyok(info[j].code, FALSE);
181                     ++merged;
182                 } else {
183                     printw("? cannot define_key %d:%s\n", j, info[j].value);
184                 }
185             } else {
186                 printw("? cannot merge %d:%s\n", j, info[j].value);
187             }
188             free(value);
189         }
190     }
191     printw("Merged to %d key definitions\n", info_len - merged);
192 }
193
194 int
195 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
196 {
197     int ch;
198 #if HAVE_GETTIMEOFDAY
199     struct timeval previous;
200 #endif
201
202     if (newterm(0, stdout, stdin) == 0) {
203         fprintf(stderr, "Cannot initialize terminal\n");
204         ExitProgram(EXIT_FAILURE);
205     }
206
207     unlink(MY_LOGFILE);
208
209     (void) cbreak();            /* take input chars one at a time, no wait for \n */
210     (void) noecho();            /* don't echo input */
211
212     scrollok(stdscr, TRUE);
213     keypad(stdscr, TRUE);
214     move(0, 0);
215
216     demo_foldkeys();
217
218 #if HAVE_GETTIMEOFDAY
219     gettimeofday(&previous, 0);
220 #endif
221
222     while ((ch = getch()) != ERR) {
223         bool escaped = (ch >= MY_KEYS);
224         const char *name = keyname(escaped ? (ch - MY_KEYS) : ch);
225
226 #if HAVE_GETTIMEOFDAY
227         int secs, msecs;
228         struct timeval current;
229
230         gettimeofday(&current, 0);
231         secs = (int) (current.tv_sec - previous.tv_sec);
232         msecs = (int) ((current.tv_usec - previous.tv_usec) / 1000);
233         if (msecs < 0) {
234             msecs += 1000;
235             --secs;
236         }
237         if (msecs >= 1000) {
238             secs += msecs / 1000;
239             msecs %= 1000;
240         }
241         printw("%6d.%03d ", secs, msecs);
242         previous = current;
243 #endif
244         printw("Keycode %d, name %s%s\n",
245                ch,
246                escaped ? "ESC-" : "",
247                name != 0 ? name : "<null>");
248         log_last_line(stdscr);
249         clrtoeol();
250         if (ch == 'q')
251             break;
252     }
253     endwin();
254     ExitProgram(EXIT_SUCCESS);
255 }
256 #else
257 int
258 main(void)
259 {
260     printf("This program requires the ncurses library\n");
261     ExitProgram(EXIT_FAILURE);
262 }
263 #endif