ncurses 6.1 - patch 20191102
[ncurses.git] / test / savescreen.c
index fe8d4e32cbb3e7ef8170c3070c53e2971042defa..408020a6a958f2673794140f3486ff5d86cbc866 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
 /****************************************************************************
- * Copyright (c) 2007,2009 Free Software Foundation, Inc.                   *
+ * Copyright (c) 2007-2018,2019 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            *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
  * authorization.                                                           *
  ****************************************************************************/
 /*
  * authorization.                                                           *
  ****************************************************************************/
 /*
- * $Id: savescreen.c,v 1.11 2009/10/10 19:38:21 tom Exp $
+ * $Id: savescreen.c,v 1.55 2019/01/20 15:59:28 tom Exp $
  *
  * Demonstrate save/restore functions from the curses library.
  * Thomas Dickey - 2007/7/14
  */
 
  *
  * Demonstrate save/restore functions from the curses library.
  * Thomas Dickey - 2007/7/14
  */
 
+#define NEED_TIME_H
 #include <test.priv.h>
 #include <test.priv.h>
+#include <popup_msg.h>
+#include <parse_rgb.h>
+
+#if HAVE_SCR_DUMP
 
 #include <sys/types.h>
 #include <sys/stat.h>
 
 
 #include <sys/types.h>
 #include <sys/stat.h>
 
-#if TIME_WITH_SYS_TIME
-# include <sys/time.h>
-# include <time.h>
+#if defined(__hpux)
+#define MyMarker 'X'
 #else
 #else
-# if HAVE_SYS_TIME_H
-#  include <sys/time.h>
-# else
-#  include <time.h>
-# endif
+#define MyMarker ACS_DIAMOND
 #endif
 
 #endif
 
+#define MAX_ANSI 8
+
 static bool use_init = FALSE;
 static bool use_init = FALSE;
+static bool keep_dumps = FALSE;
+
+#if USE_WIDEC_SUPPORT
+/* In HPUX curses, cchar_t is opaque; other implementations are not */
+static wchar_t
+BaseChar(cchar_t data)
+{
+    wchar_t my_wchar[CCHARW_MAX];
+    wchar_t result = 0;
+    attr_t my_attr;
+    short my_pair;
+    if (getcchar(&data, my_wchar, &my_attr, &my_pair, NULL) == OK)
+       result = my_wchar[0];
+    return result;
+}
+#endif
 
 static int
 fexists(const char *name)
 
 static int
 fexists(const char *name)
@@ -69,8 +87,10 @@ cleanup(char *files[])
 {
     int n;
 
 {
     int n;
 
-    for (n = 0; files[n] != 0; ++n) {
-       unlink(files[n]);
+    if (!keep_dumps) {
+       for (n = 0; files[n] != 0; ++n) {
+           unlink(files[n]);
+       }
     }
 }
 
     }
 }
 
@@ -101,15 +121,27 @@ after_load(void)
 }
 
 static void
 }
 
 static void
-show_what(int which, int last)
+show_what(int color, int which, int last)
 {
 {
-    int y, x;
-    time_t now = time((time_t *) 0);
+    int y, x, n;
+    time_t now;
+    char *mytime;
 
     getyx(stdscr, y, x);
 
     move(0, 0);
 
     getyx(stdscr, y, x);
 
     move(0, 0);
-    printw("Saved %d of %d - %s", which, last + 1, ctime(&now));
+    printw("Color %d.  Saved %d of %d (? for help)", color, which, last + 1);
+
+    now = time((time_t *) 0);
+    mytime = ctime(&now);
+    for (n = (int) strlen(mytime) - 1; n >= 0; --n) {
+       if (isspace(UChar(mytime[n]))) {
+           mytime[n] = '\0';
+       } else {
+           break;
+       }
+    }
+    mvprintw(0, (COLS - n - 2), " %s", mytime);
 
     move(y, x);
 
 
     move(y, x);
 
@@ -117,20 +149,109 @@ show_what(int which, int last)
 }
 
 static int
 }
 
 static int
-get_command(int which, int last)
+get_command(int color, int which, int last)
 {
     int ch;
 
 {
     int ch;
 
-    timeout(100);
+    timeout(50);
 
     do {
 
     do {
-       show_what(which, last);
+       show_what(color, which, last);
        ch = getch();
     } while (ch == ERR);
 
     return ch;
 }
 
        ch = getch();
     } while (ch == ERR);
 
     return ch;
 }
 
+static int
+dump_screen(char **files, int color, int which, int last, bool use_colors)
+{
+#if USE_WIDEC_SUPPORT
+    cchar_t mycc;
+    int myxx;
+#endif
+    char *filename = files[which];
+    bool dumped = FALSE;
+
+    if (filename != 0) {
+       dumped = TRUE;
+       show_what(color, ++which, last);
+       if (scr_dump(filename) == ERR) {
+           endwin();
+           printf("Cannot write screen-dump %s\n", filename);
+           cleanup(files);
+           ExitProgram(EXIT_SUCCESS);
+       }
+       if (use_colors) {
+           int cx, cy;
+           int pair = 1 + (which % MAX_ANSI);
+           /*
+            * Change the background color, to make it more obvious.  But that
+            * changes the existing text-color.  Copy the old values from the
+            * currently displayed screen.
+            */
+           bkgd((chtype) COLOR_PAIR(pair));
+           for (cy = 1; cy < LINES; ++cy) {
+               for (cx = 0; cx < COLS; ++cx) {
+                   wmove(curscr, cy, cx);
+                   wmove(stdscr, cy, cx);
+#if USE_WIDEC_SUPPORT
+                   if (win_wch(curscr, &mycc) != ERR) {
+                       myxx = wcwidth(BaseChar(mycc));
+                       if (myxx > 0) {
+                           wadd_wchnstr(stdscr, &mycc, 1);
+                           cx += (myxx - 1);
+                       }
+                   }
+#else
+                   waddch(stdscr, winch(curscr));
+#endif
+               }
+           }
+       }
+    }
+    return dumped;
+}
+
+static void
+editor_help(void)
+{
+    static const char *msgs[] =
+    {
+       "You are now in the screen-editor, which allows you to make some",
+       "lines on the screen, as well as save copies of the screen to a",
+       "temporary file",
+       "",
+       "Keys:",
+       "   q           quit",
+       "   n           run the screen-loader to show the saved screens",
+       "   <space>     dump a screen",
+       "",
+       "   a           toggle between '#' and graphic symbol for drawing",
+       "   c           change color drawn by line to next in palette",
+       "   h,j,k,l or arrows to move around the screen, drawing",
+       0
+    };
+    popup_msg(stdscr, msgs);
+}
+
+static void
+replay_help(void)
+{
+    static const char *msgs[] =
+    {
+       "You are now in the screen-loader, which allows you to view",
+       "the dumped/restored screens.",
+       "",
+       "Keys:",
+       "   q           quit",
+       "   <space>     load the next screen",
+       "   <backspace> load the previous screen",
+       0
+    };
+    popup_msg(stdscr, msgs);
+}
+
 static void
 usage(void)
 {
 static void
 usage(void)
 {
@@ -139,8 +260,10 @@ usage(void)
        "Usage: savescreen [-r] files",
        "",
        "Options:",
        "Usage: savescreen [-r] files",
        "",
        "Options:",
-       " -i  use scr_init/scr_restore rather than scr_set",
-       " -r  replay the screen-dump files"
+       " -f file  fill/initialize screen using text from this file",
+       " -i       use scr_init/scr_restore rather than scr_set",
+       " -k       keep the restored dump-files rather than removing them",
+       " -r       replay the screen-dump files"
     };
     unsigned n;
     for (n = 0; n < SIZEOF(msg); ++n) {
     };
     unsigned n;
     for (n = 0; n < SIZEOF(msg); ++n) {
@@ -155,15 +278,35 @@ main(int argc, char *argv[])
     int ch;
     int which = 0;
     int last;
     int ch;
     int which = 0;
     int last;
+    bool use_colors = FALSE;
     bool replaying = FALSE;
     bool done = FALSE;
     char **files;
     bool replaying = FALSE;
     bool done = FALSE;
     char **files;
+    char *fill_by = 0;
+#if USE_WIDEC_SUPPORT
+    int r, g, b;
+    int cube = 0;
+    int cube0 = 16;
+    int cube1;
+    cchar_t mycc;
+    static const wchar_t mywc[2] =
+    {L'#', 0};
+    bool using_rgb = FALSE;
+#endif
 
 
-    while ((ch = getopt(argc, argv, "ir")) != -1) {
+    setlocale(LC_ALL, "");
+
+    while ((ch = getopt(argc, argv, "f:ikr")) != -1) {
        switch (ch) {
        switch (ch) {
+       case 'f':
+           fill_by = optarg;
+           break;
        case 'i':
            use_init = TRUE;
            break;
        case 'i':
            use_init = TRUE;
            break;
+       case 'k':
+           keep_dumps = TRUE;
+           break;
        case 'r':
            replaying = TRUE;
            break;
        case 'r':
            replaying = TRUE;
            break;
@@ -186,11 +329,175 @@ main(int argc, char *argv[])
     noecho();
     keypad(stdscr, TRUE);
     curs_set(0);
     noecho();
     keypad(stdscr, TRUE);
     curs_set(0);
-    if (has_colors()) {
-       start_color();
-       for (ch = 0; ch < COLOR_PAIRS; ++ch) {
-           short pair = ch % COLOR_PAIRS;
-           init_pair(pair, COLOR_WHITE, ch % COLORS);
+
+    if (has_colors() && (start_color() == OK) && COLORS >= MAX_ANSI) {
+       static const struct {
+           int fg, bg;
+       } table[MAX_ANSI] = {
+#define DATA(fg,bg) { COLOR_##fg, COLOR_##bg }
+           DATA(RED, WHITE),
+               DATA(GREEN, WHITE),
+               DATA(YELLOW, BLACK),
+               DATA(BLUE, WHITE),
+               DATA(MAGENTA, WHITE),
+               DATA(MAGENTA, BLACK),
+               DATA(CYAN, WHITE),
+               DATA(CYAN, BLACK),
+#undef DATA
+       };
+       int n;
+       int pair = 1;
+
+       use_colors = TRUE;
+       /*
+        * Discounting color-pair 0 (no color), make the next 8 color pairs
+        * useful for leaving a visually distinct trail of characters on the
+        * screen.
+        */
+       for (n = 0; n < MAX_ANSI; ++n) {
+           init_pair((short) pair++, (short) table[n].fg, (short) table[n].bg);
+       }
+       /*
+        * After that, use color pairs for constructing a test-pattern, e.g.,
+        * imitating xterm's scripts.
+        */
+       if (fill_by == 0) {
+           if (COLORS <= 256) {
+               for (n = 0; n < COLORS; ++n)
+                   init_pair((short) (n + MAX_ANSI), (short) n, (short) n);
+           }
+#if HAVE_TIGETSTR && USE_WIDEC_SUPPORT
+           else {
+               int r_max, g_max, b_max;
+
+               if (parse_rgb(&r_max, &g_max, &b_max) > 0) {
+                   int rows = LINES - 1;
+                   int cols = COLS - 1;
+                   int b_delta = (b_max / rows);
+                   int r_delta = (r_max / cols);
+                   int g_delta = (g_max / cols);
+                   int row = 0;
+
+                   b = 0;
+                   using_rgb = TRUE;
+                   while (row++ < rows) {
+                       int col = 0;
+                       r = 0;
+                       g = g_max;
+                       while (col++ < cols) {
+                           int color = (((r * (g_max + 1)) + g) * (b_max + 1)
+                                        + b + MAX_ANSI);
+#if USE_EXTENDED_COLOR
+                           init_extended_pair(pair, color, color);
+#else
+                           init_pair(pair, color, color);
+#endif
+                           pair++;
+                           r += r_delta;
+                           g -= g_delta;
+                       }
+                       b += b_delta;
+                   }
+               }
+           }
+#endif
+       }
+       if ((fill_by == 0) && !replaying) {
+           /*
+            * Originally (before wide-characters) ncurses supported 16 colors.
+            */
+           if (COLORS >= 16 && COLORS <= 256) {
+               mvprintw(2, 0, "System colors:\n");
+               for (n = 0; n < 16; ++n) {
+                   pair = n + MAX_ANSI;
+                   addch((chtype) (' ' | COLOR_PAIR(pair)));
+                   addch((chtype) (' ' | COLOR_PAIR(pair)));
+                   if (((n + 1) % 8) == 0)
+                       addch('\n');
+               }
+           }
+           /*
+            * Even with ncurses, you need wide-character support to have more
+            * than 16 colors.
+            */
+#if USE_WIDEC_SUPPORT
+           if (COLORS == 88) {
+               cube = 4;
+           } else if (COLORS == 256) {
+               cube = 6;
+           }
+           if (cube != 0) {
+               cube0 = 16;
+               cube1 = cube0 + (cube * cube * cube);
+
+               addch('\n');
+               printw("Color cube, %dx%dx%d:\n", cube, cube, cube);
+               for (g = 0; g < cube; g++) {
+                   for (r = 0; r < cube; r++) {
+                       for (b = 0; b < cube; b++) {
+                           pair = MAX_ANSI
+                               + 16
+                               + (r * cube * cube) + (g * cube) + b;
+                           setcchar(&mycc, mywc, 0, (short) pair, NULL);
+                           add_wch(&mycc);
+                           add_wch(&mycc);
+                       }
+                       addch(' ');
+                   }
+                   addch('\n');
+               }
+               addch('\n');
+               printw("Grayscale ramp:\n");
+               for (n = cube1; n < COLORS; ++n) {
+                   pair = n + MAX_ANSI;
+                   setcchar(&mycc, mywc, 0, (short) pair, NULL);
+                   add_wch(&mycc);
+                   add_wch(&mycc);
+               }
+           } else if ((COLORS > 256) && using_rgb) {
+               int rows = LINES - 1;
+               int cols = COLS - 1;
+               int row = 0;
+
+               b = 0;
+               pair = MAX_ANSI;
+               while (row++ < rows) {
+                   int col = 0;
+                   while (col++ < cols) {
+                       setcchar(&mycc, mywc, 0, (short) pair, &pair);
+                       add_wch(&mycc);
+                       ++pair;
+                   }
+                   addch('\n');
+               }
+               addch('\n');
+           }
+#endif
+       }
+    }
+
+    if (fill_by != 0) {
+       FILE *fp = fopen(fill_by, "r");
+       if (fp != 0) {
+           bool filled = FALSE;
+           move(1, 0);
+           while ((ch = fgetc(fp)) != EOF) {
+               if (addch(UChar(ch)) == ERR) {
+                   filled = TRUE;
+                   break;
+               }
+           }
+           fclose(fp);
+           if (!filled) {
+               while (addch(' ') != ERR) {
+                   ;
+               }
+           }
+           move(0, 0);
+       } else {
+           exit_curses();
+           fprintf(stderr, "Cannot open \"%s\"\n", fill_by);
+           ExitProgram(EXIT_FAILURE);
        }
     }
 
        }
     }
 
@@ -200,14 +507,14 @@ main(int argc, char *argv[])
         * Use the last file as the initial/current screen.
         */
        if (last < 0) {
         * Use the last file as the initial/current screen.
         */
        if (last < 0) {
-           endwin();
+           exit_curses();
            printf("No screen-dumps given\n");
            ExitProgram(EXIT_FAILURE);
        }
 
        which = last;
        if (load_screen(files[which]) == ERR) {
            printf("No screen-dumps given\n");
            ExitProgram(EXIT_FAILURE);
        }
 
        which = last;
        if (load_screen(files[which]) == ERR) {
-           endwin();
+           exit_curses();
            printf("Cannot load screen-dump %s\n", files[which]);
            ExitProgram(EXIT_FAILURE);
        }
            printf("Cannot load screen-dump %s\n", files[which]);
            ExitProgram(EXIT_FAILURE);
        }
@@ -225,7 +532,6 @@ main(int argc, char *argv[])
                done = TRUE;
                break;
            case 'q':
                done = TRUE;
                break;
            case 'q':
-               endwin();
                cleanup(files);
                done = TRUE;
                break;
                cleanup(files);
                done = TRUE;
                break;
@@ -238,6 +544,9 @@ main(int argc, char *argv[])
                if (++which > last)
                    which = 0;
                break;
                if (++which > last)
                    which = 0;
                break;
+           case HELP_KEY_1:
+               replay_help();
+               break;
            default:
                beep();
                continue;
            default:
                beep();
                continue;
@@ -254,46 +563,34 @@ main(int argc, char *argv[])
                wrefresh(curscr);
            }
        }
                wrefresh(curscr);
            }
        }
+       endwin();
     } else {
     } else {
-       int y;
-       int x;
-
-       move(2, 0);
-       printw("Use h,j,k,l or arrows to move around the screen\n");
-       printw("Press 'q' to quit, ' ' to dump a screen\n");
-       printw("When the last screen has been dumped, press 'n' to run the\n");
-       printw("screen-loader.  That allows only 'q', backspace and ' ' for\n");
-       printw("stepping through the dumped/restored screens.\n");
-       getyx(stdscr, y, x);
+       int y = 0;
+       int x = 0;
+       int color = 0;
+       int altchars = 0;
+       bool dirty = use_colors || (fill_by != 0);
 
        while (!done) {
 
        while (!done) {
-           switch (ch = get_command(which, last)) {
+           switch (get_command(color, which, last)) {
            case 'n':
            case 'n':
+               if (dirty && files[which]) {
+                   dump_screen(files, color, which, last, use_colors);
+               }
                setup_next();
                done = TRUE;
                break;
            case 'q':
                setup_next();
                done = TRUE;
                break;
            case 'q':
-               endwin();
                cleanup(files);
                done = TRUE;
                break;
            case ' ':
                cleanup(files);
                done = TRUE;
                break;
            case ' ':
-               if (files[which] != 0) {
-                   show_what(which + 1, last);
-                   if (scr_dump(files[which]) == ERR) {
-                       endwin();
-                       printf("Cannot write screen-dump %s\n", files[which]);
-                       cleanup(files);
-                       done = TRUE;
-                       break;
-                   }
-                   ++which;
-                   if (has_colors()) {
-                       short pair = which % COLOR_PAIRS;
-                       bkgd(COLOR_PAIR(pair));
-                   }
+               if (dump_screen(files, color, which, last, use_colors)) {
+                   which = (which + 1) % MAX_ANSI;
+                   dirty = FALSE;
                } else {
                } else {
-                   beep();
+                   setup_next();
+                   done = TRUE;
                }
                break;
            case KEY_LEFT:
                }
                break;
            case KEY_LEFT:
@@ -316,17 +613,43 @@ main(int argc, char *argv[])
                if (++x >= COLS)
                    x = 0;
                break;
                if (++x >= COLS)
                    x = 0;
                break;
+           case 'a':
+               altchars = !altchars;
+               break;
+           case 'c':
+               if (use_colors) {
+                   color = (color + 1) % MAX_ANSI;
+               }
+               break;
+           case HELP_KEY_1:
+               editor_help();
+               break;
+           default:
+               beep();
+               continue;
            }
            if (!done) {
            }
            if (!done) {
-               time_t now = time((time_t *) 0);
-
-               move(0, 0);
-               addstr(ctime(&now));
+               chtype attr = A_REVERSE;
+               chtype ch2 = (altchars ? MyMarker : '#');
+               if (use_colors) {
+                   attr |= (chtype) COLOR_PAIR(color);
+               }
                move(y, x);
                move(y, x);
-               addch('#' | A_REVERSE);
+               AddCh(ch2 | attr);
                move(y, x);
                move(y, x);
+               dirty = TRUE;
            }
        }
            }
        }
+       endwin();
     }
     ExitProgram(EXIT_SUCCESS);
 }
     }
     ExitProgram(EXIT_SUCCESS);
 }
+
+#else
+int
+main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
+{
+    printf("This program requires the screen-dump functions\n");
+    ExitProgram(EXIT_FAILURE);
+}
+#endif