ncurses 6.0 - patch 20151205
[ncurses.git] / test / filter.c
1 /****************************************************************************
2  * Copyright (c) 1998-2012,2014 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 <dickey@clark.net> 1998
31  *
32  * $Id: filter.c,v 1.16 2014/08/09 22:35:51 tom Exp $
33  */
34 #include <test.priv.h>
35
36 #if HAVE_FILTER
37
38 /*
39  * An example of the 'filter()' function in ncurses, this program prompts
40  * for commands and executes them (like a command shell).  It illustrates
41  * how ncurses can be used to implement programs that are not full-screen.
42  *
43  * Ncurses differs slightly from SVr4 curses.  The latter does not flush its
44  * state when exiting program mode, so the attributes on the command lines of
45  * this program 'bleed' onto the executed commands.  Rather than use the
46  * reset_shell_mode() and reset_prog_mode() functions, we could invoke endwin()
47  * and refresh(), but that does not work any better.
48  */
49
50 static int
51 new_command(char *buffer, int length, int underline)
52 {
53     int code;
54
55     attron(A_BOLD);
56     printw("Command: ");
57     attron(underline);
58     code = getnstr(buffer, length);
59     /*
60      * If this returns anything except ERR/OK, it would be one of ncurses's
61      * extensions.  Fill the buffer with something harmless that the shell
62      * will execute as a comment.
63      */
64 #ifdef KEY_EVENT
65     if (code == KEY_EVENT)
66         strcpy(buffer, "# event!");
67 #endif
68 #ifdef KEY_RESIZE
69     if (code == KEY_RESIZE) {
70         strcpy(buffer, "# resize!");
71         getch();
72     }
73 #endif
74     attroff(underline);
75     attroff(A_BOLD);
76     printw("\n");
77
78     return code;
79 }
80
81 static void
82 usage(void)
83 {
84     static const char *msg[] =
85     {
86         "Usage: filter [options]"
87         ,""
88         ,"Options:"
89         ,"  -i   use initscr() rather than newterm()"
90     };
91     unsigned n;
92     for (n = 0; n < SIZEOF(msg); n++)
93         fprintf(stderr, "%s\n", msg[n]);
94     ExitProgram(EXIT_FAILURE);
95 }
96
97 int
98 main(int argc, char *argv[])
99 {
100     int ch;
101     char buffer[80];
102     int underline;
103     bool i_option = FALSE;
104
105     setlocale(LC_ALL, "");
106
107     while ((ch = getopt(argc, argv, "i")) != -1) {
108         switch (ch) {
109         case 'i':
110             i_option = TRUE;
111             break;
112         default:
113             usage();
114         }
115     }
116
117     printf("starting filter program using %s...\n",
118            i_option ? "initscr" : "newterm");
119     filter();
120     if (i_option) {
121         initscr();
122     } else {
123         (void) newterm((char *) 0, stdout, stdin);
124     }
125     cbreak();
126     keypad(stdscr, TRUE);
127
128     if (has_colors()) {
129         int background = COLOR_BLACK;
130         start_color();
131 #if HAVE_USE_DEFAULT_COLORS
132         if (use_default_colors() != ERR)
133             background = -1;
134 #endif
135         init_pair(1, COLOR_CYAN, (short) background);
136         underline = COLOR_PAIR(1);
137     } else {
138         underline = A_UNDERLINE;
139     }
140
141     while (new_command(buffer, sizeof(buffer) - 1, underline) != ERR
142            && strlen(buffer) != 0) {
143         reset_shell_mode();
144         printf("\n");
145         fflush(stdout);
146         IGNORE_RC(system(buffer));
147         reset_prog_mode();
148         touchwin(stdscr);
149         erase();
150         refresh();
151     }
152     printw("done");
153     refresh();
154     endwin();
155     ExitProgram(EXIT_SUCCESS);
156 }
157 #else
158 int
159 main(void)
160 {
161     printf("This program requires the filter function\n");
162     ExitProgram(EXIT_FAILURE);
163 }
164 #endif /* HAVE_FILTER */