ncurses 6.2 - patch 20211018
[ncurses.git] / test / savescreen.c
1 /****************************************************************************
2  * Copyright 2018-2020,2021 Thomas E. Dickey                                *
3  * Copyright 2006-2017,2018 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  * $Id: savescreen.c,v 1.58 2021/03/27 23:41:21 tom Exp $
31  *
32  * Demonstrate save/restore functions from the curses library.
33  * Thomas Dickey - 2007/7/14
34  */
35
36 #define NEED_TIME_H
37 #include <test.priv.h>
38 #include <popup_msg.h>
39 #include <parse_rgb.h>
40
41 #if HAVE_SCR_DUMP
42
43 #include <sys/types.h>
44 #include <sys/stat.h>
45
46 #if defined(__hpux)
47 #define MyMarker 'X'
48 #else
49 #define MyMarker ACS_DIAMOND
50 #endif
51
52 #define MAX_ANSI 8
53
54 static bool use_init = FALSE;
55 static bool keep_dumps = FALSE;
56
57 #if USE_WIDEC_SUPPORT
58 /* In HPUX curses, cchar_t is opaque; other implementations are not */
59 static wchar_t
60 BaseChar(cchar_t data)
61 {
62     wchar_t my_wchar[CCHARW_MAX];
63     wchar_t result = 0;
64     attr_t my_attr;
65     short my_pair;
66     if (getcchar(&data, my_wchar, &my_attr, &my_pair, NULL) == OK)
67         result = my_wchar[0];
68     return result;
69 }
70 #endif
71
72 static int
73 fexists(const char *name)
74 {
75     struct stat sb;
76     return (stat(name, &sb) == 0 && (sb.st_mode & S_IFMT) == S_IFREG);
77 }
78
79 static void
80 setup_next(void)
81 {
82     curs_set(1);
83     reset_shell_mode();
84 }
85
86 static void
87 cleanup(char *files[])
88 {
89     if (!keep_dumps) {
90         int n;
91
92         for (n = 0; files[n] != 0; ++n) {
93             unlink(files[n]);
94         }
95     }
96 }
97
98 static int
99 load_screen(char *filename)
100 {
101     int result;
102
103     if (use_init) {
104         if ((result = scr_init(filename)) != ERR)
105             result = scr_restore(filename);
106     } else {
107         result = scr_set(filename);
108     }
109     return result;
110 }
111
112 /*
113  * scr_restore() or scr_set() operates on curscr.  If we read a character using
114  * getch() that will refresh stdscr, wiping out the result.  To avoid that,
115  * copy the data back from curscr to stdscr.
116  */
117 static void
118 after_load(void)
119 {
120     overwrite(curscr, stdscr);
121     doupdate();
122 }
123
124 static void
125 show_what(int color, int which, int last)
126 {
127     int y, x, n;
128     time_t now;
129     char *mytime;
130
131     getyx(stdscr, y, x);
132
133     move(0, 0);
134     printw("Color %d.  Saved %d of %d (? for help)", color, which, last + 1);
135
136     now = time((time_t *) 0);
137     mytime = ctime(&now);
138     for (n = (int) strlen(mytime) - 1; n >= 0; --n) {
139         if (isspace(UChar(mytime[n]))) {
140             mytime[n] = '\0';
141         } else {
142             break;
143         }
144     }
145     mvprintw(0, (COLS - n - 2), " %s", mytime);
146
147     move(y, x);
148
149     refresh();
150 }
151
152 static int
153 get_command(int color, int which, int last)
154 {
155     int ch;
156
157     timeout(50);
158
159     do {
160         show_what(color, which, last);
161         ch = getch();
162     } while (ch == ERR);
163
164     return ch;
165 }
166
167 static int
168 dump_screen(char **files, int color, int which, int last, bool use_colors)
169 {
170 #if USE_WIDEC_SUPPORT
171     cchar_t mycc;
172 #endif
173     char *filename = files[which];
174     bool dumped = FALSE;
175
176     if (filename != 0) {
177         dumped = TRUE;
178         show_what(color, ++which, last);
179         if (scr_dump(filename) == ERR) {
180             endwin();
181             printf("Cannot write screen-dump %s\n", filename);
182             cleanup(files);
183             ExitProgram(EXIT_SUCCESS);
184         }
185         if (use_colors) {
186             int cx, cy;
187             int pair = 1 + (which % MAX_ANSI);
188             /*
189              * Change the background color, to make it more obvious.  But that
190              * changes the existing text-color.  Copy the old values from the
191              * currently displayed screen.
192              */
193             bkgd((chtype) COLOR_PAIR(pair));
194             for (cy = 1; cy < LINES; ++cy) {
195                 for (cx = 0; cx < COLS; ++cx) {
196                     wmove(curscr, cy, cx);
197                     wmove(stdscr, cy, cx);
198 #if USE_WIDEC_SUPPORT
199                     if (win_wch(curscr, &mycc) != ERR) {
200                         int myxx = wcwidth(BaseChar(mycc));
201                         if (myxx > 0) {
202                             wadd_wchnstr(stdscr, &mycc, 1);
203                             cx += (myxx - 1);
204                         }
205                     }
206 #else
207                     waddch(stdscr, winch(curscr));
208 #endif
209                 }
210             }
211         }
212     }
213     return dumped;
214 }
215
216 static void
217 editor_help(void)
218 {
219     static const char *msgs[] =
220     {
221         "You are now in the screen-editor, which allows you to make some",
222         "lines on the screen, as well as save copies of the screen to a",
223         "temporary file",
224         "",
225         "Keys:",
226         "   q           quit",
227         "   n           run the screen-loader to show the saved screens",
228         "   <space>     dump a screen",
229         "",
230         "   a           toggle between '#' and graphic symbol for drawing",
231         "   c           change color drawn by line to next in palette",
232         "   h,j,k,l or arrows to move around the screen, drawing",
233         0
234     };
235     popup_msg(stdscr, msgs);
236 }
237
238 static void
239 replay_help(void)
240 {
241     static const char *msgs[] =
242     {
243         "You are now in the screen-loader, which allows you to view",
244         "the dumped/restored screens.",
245         "",
246         "Keys:",
247         "   q           quit",
248         "   <space>     load the next screen",
249         "   <backspace> load the previous screen",
250         0
251     };
252     popup_msg(stdscr, msgs);
253 }
254
255 static void
256 usage(void)
257 {
258     static const char *msg[] =
259     {
260         "Usage: savescreen [-r] files",
261         "",
262         "Options:",
263         " -f file  fill/initialize screen using text from this file",
264         " -i       use scr_init/scr_restore rather than scr_set",
265         " -k       keep the restored dump-files rather than removing them",
266         " -r       replay the screen-dump files"
267     };
268     unsigned n;
269     for (n = 0; n < SIZEOF(msg); ++n) {
270         fprintf(stderr, "%s\n", msg[n]);
271     }
272     ExitProgram(EXIT_FAILURE);
273 }
274
275 int
276 main(int argc, char *argv[])
277 {
278     int ch;
279     int which = 0;
280     int last;
281     bool use_colors = FALSE;
282     bool replaying = FALSE;
283     bool done = FALSE;
284     char **files;
285     char *fill_by = 0;
286 #if USE_WIDEC_SUPPORT
287     cchar_t mycc;
288     static const wchar_t mywc[2] =
289     {L'#', 0};
290 #endif
291
292     setlocale(LC_ALL, "");
293
294     while ((ch = getopt(argc, argv, "f:ikr")) != -1) {
295         switch (ch) {
296         case 'f':
297             fill_by = optarg;
298             break;
299         case 'i':
300             use_init = TRUE;
301             break;
302         case 'k':
303             keep_dumps = TRUE;
304             break;
305         case 'r':
306             replaying = TRUE;
307             break;
308         default:
309             usage();
310             break;
311         }
312     }
313
314     files = argv + optind;
315     last = argc - optind - 1;
316
317     if (replaying) {
318         while (last >= 0 && !fexists(files[last]))
319             --last;
320     }
321
322     initscr();
323     cbreak();
324     noecho();
325     keypad(stdscr, TRUE);
326     curs_set(0);
327
328     if (has_colors() && (start_color() == OK) && COLORS >= MAX_ANSI) {
329 #if USE_WIDEC_SUPPORT
330         bool using_rgb = FALSE;
331 #endif
332         static const struct {
333             int fg, bg;
334         } table[MAX_ANSI] = {
335 #define DATA(fg,bg) { COLOR_##fg, COLOR_##bg }
336             DATA(RED, WHITE),
337                 DATA(GREEN, WHITE),
338                 DATA(YELLOW, BLACK),
339                 DATA(BLUE, WHITE),
340                 DATA(MAGENTA, WHITE),
341                 DATA(MAGENTA, BLACK),
342                 DATA(CYAN, WHITE),
343                 DATA(CYAN, BLACK),
344 #undef DATA
345         };
346         int n;
347         int pair = 1;
348
349         use_colors = TRUE;
350         /*
351          * Discounting color-pair 0 (no color), make the next 8 color pairs
352          * useful for leaving a visually distinct trail of characters on the
353          * screen.
354          */
355         for (n = 0; n < MAX_ANSI; ++n) {
356             init_pair((short) pair++, (short) table[n].fg, (short) table[n].bg);
357         }
358         /*
359          * After that, use color pairs for constructing a test-pattern, e.g.,
360          * imitating xterm's scripts.
361          */
362         if (fill_by == 0) {
363             if (COLORS <= 256) {
364                 for (n = 0; n < COLORS; ++n)
365                     init_pair((short) (n + MAX_ANSI), (short) n, (short) n);
366             }
367 #if HAVE_TIGETSTR && USE_WIDEC_SUPPORT
368             else {
369                 int r_max, g_max, b_max;
370
371                 if (parse_rgb(&r_max, &g_max, &b_max) > 0) {
372                     int rows = LINES - 1;
373                     int cols = COLS - 1;
374                     int b_delta = (b_max / rows);
375                     int r_delta = (r_max / cols);
376                     int g_delta = (g_max / cols);
377                     int row = 0;
378                     int b = 0;
379
380                     using_rgb = TRUE;
381                     while (row++ < rows) {
382                         int col = 0;
383                         int r = 0;
384                         int g = g_max;
385                         while (col++ < cols) {
386                             int color = (((r * (g_max + 1)) + g) * (b_max + 1)
387                                          + b + MAX_ANSI);
388 #if USE_EXTENDED_COLOR
389                             init_extended_pair(pair, color, color);
390 #else
391                             init_pair(pair, color, color);
392 #endif
393                             pair++;
394                             r += r_delta;
395                             g -= g_delta;
396                         }
397                         b += b_delta;
398                     }
399                 }
400             }
401 #endif
402         }
403         if ((fill_by == 0) && !replaying) {
404 #if USE_WIDEC_SUPPORT
405             int cube = 0;
406 #endif
407             /*
408              * Originally (before wide-characters) ncurses supported 16 colors.
409              */
410             if (COLORS >= 16 && COLORS <= 256) {
411                 mvprintw(2, 0, "System colors:\n");
412                 for (n = 0; n < 16; ++n) {
413                     pair = n + MAX_ANSI;
414                     addch((chtype) (' ' | COLOR_PAIR(pair)));
415                     addch((chtype) (' ' | COLOR_PAIR(pair)));
416                     if (((n + 1) % 8) == 0)
417                         addch('\n');
418                 }
419             }
420             /*
421              * Even with ncurses, you need wide-character support to have more
422              * than 16 colors.
423              */
424 #if USE_WIDEC_SUPPORT
425             if (COLORS == 88) {
426                 cube = 4;
427             } else if (COLORS == 256) {
428                 cube = 6;
429             }
430             if (cube != 0) {
431                 int r, g, b;
432                 int cube0 = 16;
433                 int cube1 = cube0 + (cube * cube * cube);
434
435                 addch('\n');
436                 printw("Color cube, %dx%dx%d:\n", cube, cube, cube);
437                 for (g = 0; g < cube; g++) {
438                     for (r = 0; r < cube; r++) {
439                         for (b = 0; b < cube; b++) {
440                             pair = MAX_ANSI
441                                 + 16
442                                 + (r * cube * cube) + (g * cube) + b;
443                             setcchar(&mycc, mywc, 0, (short) pair, NULL);
444                             add_wch(&mycc);
445                             add_wch(&mycc);
446                         }
447                         addch(' ');
448                     }
449                     addch('\n');
450                 }
451                 addch('\n');
452                 printw("Grayscale ramp:\n");
453                 for (n = cube1; n < COLORS; ++n) {
454                     pair = n + MAX_ANSI;
455                     setcchar(&mycc, mywc, 0, (short) pair, NULL);
456                     add_wch(&mycc);
457                     add_wch(&mycc);
458                 }
459             } else if ((COLORS > 256) && using_rgb) {
460                 int rows = LINES - 1;
461                 int cols = COLS - 1;
462                 int row = 0;
463
464                 pair = MAX_ANSI;
465                 while (row++ < rows) {
466                     int col = 0;
467                     while (col++ < cols) {
468                         setcchar(&mycc, mywc, 0, (short) pair, &pair);
469                         add_wch(&mycc);
470                         ++pair;
471                     }
472                     addch('\n');
473                 }
474                 addch('\n');
475             }
476 #endif
477         }
478     }
479
480     if (fill_by != 0) {
481         FILE *fp = fopen(fill_by, "r");
482         if (fp != 0) {
483             bool filled = FALSE;
484             move(1, 0);
485             while ((ch = fgetc(fp)) != EOF) {
486                 if (addch(UChar(ch)) == ERR) {
487                     filled = TRUE;
488                     break;
489                 }
490             }
491             fclose(fp);
492             if (!filled) {
493                 while (addch(' ') != ERR) {
494                     ;
495                 }
496             }
497             move(0, 0);
498         } else {
499             stop_curses();
500             fprintf(stderr, "Cannot open \"%s\"\n", fill_by);
501             ExitProgram(EXIT_FAILURE);
502         }
503     }
504
505     if (replaying) {
506
507         /*
508          * Use the last file as the initial/current screen.
509          */
510         if (last < 0) {
511             stop_curses();
512             printf("No screen-dumps given\n");
513             ExitProgram(EXIT_FAILURE);
514         }
515
516         which = last;
517         if (load_screen(files[which]) == ERR) {
518             stop_curses();
519             printf("Cannot load screen-dump %s\n", files[which]);
520             ExitProgram(EXIT_FAILURE);
521         }
522         after_load();
523
524         while (!done && (ch = getch()) != ERR) {
525             switch (ch) {
526             case 'n':
527                 /*
528                  * If we got a "next" here, skip to the final screen before
529                  * moving to the next process.
530                  */
531                 setup_next();
532                 which = last;
533                 done = TRUE;
534                 break;
535             case 'q':
536                 cleanup(files);
537                 done = TRUE;
538                 break;
539             case KEY_BACKSPACE:
540             case '\b':
541                 if (--which < 0)
542                     which = last;
543                 break;
544             case ' ':
545                 if (++which > last)
546                     which = 0;
547                 break;
548             case HELP_KEY_1:
549                 replay_help();
550                 break;
551             default:
552                 beep();
553                 continue;
554             }
555
556             if (ch == 'q') {
557                 ;
558             } else if (scr_restore(files[which]) == ERR) {
559                 endwin();
560                 printf("Cannot load screen-dump %s\n", files[which]);
561                 cleanup(files);
562                 ExitProgram(EXIT_FAILURE);
563             } else {
564                 wrefresh(curscr);
565             }
566         }
567         endwin();
568     } else {
569         int y = 0;
570         int x = 0;
571         int color = 0;
572         int altchars = 0;
573         bool dirty = use_colors || (fill_by != 0);
574
575         while (!done) {
576             switch (get_command(color, which, last)) {
577             case 'n':
578                 if (dirty && files[which]) {
579                     dump_screen(files, color, which, last, use_colors);
580                 }
581                 setup_next();
582                 done = TRUE;
583                 break;
584             case 'q':
585                 cleanup(files);
586                 done = TRUE;
587                 break;
588             case ' ':
589                 if (dump_screen(files, color, which, last, use_colors)) {
590                     which = (which + 1) % MAX_ANSI;
591                     dirty = FALSE;
592                 } else {
593                     setup_next();
594                     done = TRUE;
595                 }
596                 break;
597             case KEY_LEFT:
598             case 'h':
599                 if (--x < 0)
600                     x = COLS - 1;
601                 break;
602             case KEY_DOWN:
603             case 'j':
604                 if (++y >= LINES)
605                     y = 1;
606                 break;
607             case KEY_UP:
608             case 'k':
609                 if (--y < 1)
610                     y = LINES - 1;
611                 break;
612             case KEY_RIGHT:
613             case 'l':
614                 if (++x >= COLS)
615                     x = 0;
616                 break;
617             case 'a':
618                 altchars = !altchars;
619                 break;
620             case 'c':
621                 if (use_colors) {
622                     color = (color + 1) % MAX_ANSI;
623                 }
624                 break;
625             case HELP_KEY_1:
626                 editor_help();
627                 break;
628             default:
629                 beep();
630                 continue;
631             }
632             if (!done) {
633                 chtype attr = A_REVERSE;
634                 chtype ch2 = (altchars ? MyMarker : '#');
635                 if (use_colors) {
636                     attr |= (chtype) COLOR_PAIR(color);
637                 }
638                 move(y, x);
639                 AddCh(ch2 | attr);
640                 move(y, x);
641                 dirty = TRUE;
642             }
643         }
644         endwin();
645     }
646     ExitProgram(EXIT_SUCCESS);
647 }
648
649 #else
650 int
651 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
652 {
653     printf("This program requires the screen-dump functions\n");
654     ExitProgram(EXIT_FAILURE);
655 }
656 #endif