ncurses 6.1 - patch 20181027
[ncurses.git] / test / test_sgr.c
1 /****************************************************************************
2  * Copyright (c) 2015-2016,2017 Free Software Foundation, Inc.              *
3  *                                                                          *
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:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
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.                               *
22  *                                                                          *
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       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /*
30  * Author: Thomas E. Dickey
31  *
32  * $Id: test_sgr.c,v 1.11 2017/06/24 18:35:25 tom Exp $
33  *
34  * A simple demo of the sgr/sgr0 terminal capabilities.
35  */
36 #define USE_TINFO
37 #include <test.priv.h>
38
39 #if !HAVE_TIGETSTR
40 static void failed(const char *) GCC_NORETURN;
41
42 static void
43 failed(const char *msg)
44 {
45     fprintf(stderr, "%s\n", msg);
46     ExitProgram(EXIT_FAILURE);
47 }
48 #endif
49
50 #if HAVE_TIGETSTR
51
52 static bool no_init = FALSE;
53 static bool q_opt = FALSE;
54
55 static char *d_opt;
56 static char *e_opt;
57 static char **db_list;
58 static int db_item;
59
60 static long total_values;
61
62 static char *
63 make_dbitem(char *p, char *q)
64 {
65     size_t need = strlen(e_opt) + 2 + (size_t) (p - q);
66     char *result = malloc(need);
67     _nc_SPRINTF(result, _nc_SLIMIT(need) "%s=%.*s", e_opt, (int) (p - q), q);
68     return result;
69 }
70
71 static void
72 make_dblist(void)
73 {
74     if (d_opt && e_opt) {
75         int pass;
76
77         for (pass = 0; pass < 2; ++pass) {
78             char *p, *q;
79             size_t count = 0;
80
81             for (p = q = d_opt; *p != '\0'; ++p) {
82                 if (*p == ':') {
83                     if (p != q + 1) {
84                         if (pass) {
85                             db_list[count] = make_dbitem(p, q);
86                         }
87                         count++;
88                     }
89                     q = p + 1;
90                 }
91             }
92             if (p != q + 1) {
93                 if (pass) {
94                     db_list[count] = make_dbitem(p, q);
95                 }
96                 count++;
97             }
98             if (!pass) {
99                 db_list = typeCalloc(char *, count + 1);
100             }
101         }
102     }
103 }
104
105 static char *
106 next_dbitem(void)
107 {
108     char *result = 0;
109
110     if (db_list) {
111         if ((result = db_list[db_item]) == 0) {
112             db_item = 0;
113             result = db_list[0];
114         } else {
115             db_item++;
116         }
117     }
118     printf("** %s\n", result);
119     return result;
120 }
121
122 #if NO_LEAKS
123 static void
124 free_dblist(void)
125 {
126     if (db_list) {
127         int n;
128         for (n = 0; db_list[n]; ++n)
129             free(db_list[n]);
130         free(db_list);
131         db_list = 0;
132     }
133 }
134 #endif
135
136 #define MAXPAR    9
137 #define MAXSGR    (1 << MAXPAR)
138 #define BITS2P(n) (count & (1 << (n - 1)))
139 #define MASK_SMSO (1 << 0)
140 #define MASK_BOLD (1 << 5)
141 #define MASK_REV  (1 << 2)
142
143 static void
144 dumpit(unsigned bits, unsigned ignore, const char *sgr, const char *sgr0)
145 {
146     static const char sample[] = "abcdefghijklm";
147     static char params[] = "SURBDBIPA";
148     unsigned n;
149
150     printf("%4d ", bits);
151     bits &= ~ignore;
152     for (n = 0; n < MAXPAR; ++n) {
153         putchar((int) ((bits & (unsigned) (1 << n)) ? params[n] : '-'));
154     }
155     putchar(' ');
156     putp(sgr);
157     putp(sample);
158     putp(sgr0);
159     putchar('\n');
160 }
161
162 static bool
163 one_bit(unsigned a, unsigned b)
164 {
165     unsigned c = (a ^ b);
166     bool result = FALSE;
167     if (c) {
168         while (!(c & 1)) {
169             c >>= 1;
170         }
171         result = (c == 1);
172     }
173     return result;
174 }
175
176 static void
177 brute_force(const char *name)
178 {
179     unsigned count;
180     char *my_sgr;
181     char *my_sgr0;
182     char *my_bold;
183     char *my_revs;
184     char *my_smso;
185
186     if (db_list) {
187         putenv(next_dbitem());
188     }
189
190     if (!q_opt)
191         printf("Terminal type \"%s\"\n", name);
192
193     if (no_init) {
194         START_TRACE();
195     } else {
196         setupterm((NCURSES_CONST char *) name, 1, (int *) 0);
197     }
198
199     if (!q_opt) {
200         if (strcmp(name, ttytype))
201             printf("... actual \"%s\"\n", ttytype);
202     }
203
204     my_sgr = tigetstr("sgr");
205     my_sgr0 = tigetstr("sgr0");
206     my_bold = tigetstr("bold");
207     my_revs = tigetstr("rev");
208     my_smso = tigetstr("smso");
209
210     if (!VALID_STRING(my_sgr)) {
211         fprintf(stderr, "no \"sgr\" capability found\n");
212     } else if (!VALID_STRING(my_sgr0)) {
213         fprintf(stderr, "no \"sgr0\" capability found\n");
214     } else {
215         char *values[MAXSGR + MAXPAR];
216         unsigned j;
217         unsigned ignore = 0;
218         unsigned reason = 0;
219         unsigned repeat = 0;
220         for (count = 0; count < MAXSGR; ++count) {
221             values[count] = tparm(my_sgr,
222                                   BITS2P(1),
223                                   BITS2P(2),
224                                   BITS2P(3),
225                                   BITS2P(4),
226                                   BITS2P(5),
227                                   BITS2P(6),
228                                   BITS2P(7),
229                                   BITS2P(8),
230                                   BITS2P(9));
231             if (values[count] != 0) {
232                 values[count] = strdup(values[count]);
233             }
234         }
235         for (count = 0; count < MAXSGR; ++count) {
236             if (values[count] != 0) {
237                 for (j = count + 1; j < MAXSGR; ++j) {
238                     if (values[j] == 0)
239                         continue;
240                     if (strcmp(values[count], values[j]))
241                         continue;
242                     if (one_bit(count, j)) {
243                         free(values[j]);
244                         values[j] = 0;
245                     }
246                 }
247             }
248         }
249         for (j = 0; j < MAXPAR; ++j) {
250             unsigned mask = (unsigned) (1 << j);
251             for (count = 0; count < MAXSGR; ++count) {
252                 if ((count & mask) != 0)
253                     continue;
254                 if (values[count] != 0 && values[count + mask] != 0) {
255                     mask = 0;
256                     break;
257                 }
258             }
259             ignore |= mask;
260         }
261         /* smso is tested first, but often duplicates bold or reverse. */
262         if (VALID_STRING(my_smso)) {
263             if (VALID_STRING(my_bold) && !strcmp(my_bold, my_smso)) {
264                 repeat |= MASK_SMSO;
265                 reason = MASK_BOLD;
266             }
267             if (VALID_STRING(my_revs) && !strcmp(my_revs, my_smso)) {
268                 repeat |= MASK_SMSO;
269                 reason = MASK_REV;
270             }
271         }
272         for (count = 0; count < MAXSGR; ++count) {
273             if (values[count] != 0) {
274                 bool found = FALSE;
275                 if ((repeat & MASK_SMSO) != 0
276                     && (count & MASK_SMSO) != 0) {
277                     found = TRUE;
278                 } else {
279                     for (j = 0; j < count; ++j) {
280                         if (values[j] != 0 && !strcmp(values[j], values[count])) {
281                             if ((repeat & MASK_SMSO) != 0
282                                 && (j & MASK_SMSO) != 0
283                                 && (count & reason) != 0) {
284                                 continue;
285                             }
286                             found = TRUE;
287                             break;
288                         }
289                     }
290                 }
291                 if (!found) {
292                     dumpit(count, ignore, values[count], my_sgr0);
293                     ++total_values;
294                 }
295             }
296         }
297         for (count = 0; count < MAXSGR; ++count) {
298             free(values[count]);
299         }
300     }
301     del_curterm(cur_term);
302 }
303
304 static void
305 usage(void)
306 {
307     static const char *msg[] =
308     {
309         "Usage: test_sgr [options] [terminal]",
310         "",
311         "Print all distinct combinations of sgr capability.",
312         "",
313         "Options:",
314         " -d LIST  colon-separated list of databases to use",
315         " -e NAME  environment variable to set with -d option",
316         " -n       do not initialize terminal, to test error-checking",
317         " -q       quiet (prints only counts)",
318     };
319     unsigned n;
320     for (n = 0; n < SIZEOF(msg); ++n) {
321         fprintf(stderr, "%s\n", msg[n]);
322     }
323     ExitProgram(EXIT_FAILURE);
324 }
325
326 int
327 main(int argc, char *argv[])
328 {
329     int n;
330     char *name;
331
332     while ((n = getopt(argc, argv, "d:e:nq")) != -1) {
333         switch (n) {
334         case 'd':
335             d_opt = optarg;
336             break;
337         case 'e':
338             e_opt = optarg;
339             break;
340         case 'n':
341             no_init = TRUE;
342             break;
343         case 'q':
344             q_opt = TRUE;
345             break;
346         default:
347             usage();
348             break;
349         }
350     }
351
352     make_dblist();
353
354     if (optind < argc) {
355         for (n = optind; n < argc; ++n) {
356             brute_force(argv[n]);
357         }
358     } else if ((name = getenv("TERM")) != 0) {
359         brute_force(name);
360     } else {
361         static char dumb[] = "dumb";
362         brute_force(dumb);
363     }
364
365     printf("%ld distinct values\n", total_values);
366
367 #if NO_LEAKS
368     free_dblist();
369 #endif
370
371     ExitProgram(EXIT_SUCCESS);
372 }
373
374 #else /* !HAVE_TIGETSTR */
375 int
376 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
377 {
378     failed("This program requires the terminfo functions such as tigetstr");
379     ExitProgram(EXIT_FAILURE);
380 }
381 #endif /* HAVE_TIGETSTR */