ncurses 6.0 - patch 20170513
[ncurses.git] / test / ditto.c
1 /****************************************************************************
2  * Copyright (c) 1998-2012,2016 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 (1998-on)
31  *
32  * $Id: ditto.c,v 1.44 2016/09/04 20:43:04 tom Exp $
33  *
34  * The program illustrates how to set up multiple screens from a single
35  * program.
36  *
37  * If openpty() is supported, the command line parameters are titles for
38  * the windows showing each screen's data.
39  *
40  * If openpty() is not supported, you must invoke the program by specifying
41  * another terminal on the same machine by specifying its device, e.g.,
42  *      ditto /dev/ttyp1
43  */
44 #include <test.priv.h>
45 #include <sys/stat.h>
46
47 #ifdef USE_PTHREADS
48 #include <pthread.h>
49 #endif
50
51 #ifdef USE_XTERM_PTY
52 #include USE_OPENPTY_HEADER
53 #endif
54
55 #define MAX_FIFO 256
56
57 #define THIS_FIFO(n) ((n) % MAX_FIFO)
58 #define NEXT_FIFO(n) THIS_FIFO((n) + 1)
59
60 typedef struct {
61     unsigned long sequence;
62     int head;
63     int tail;
64     int data[MAX_FIFO];
65 } FIFO;
66
67 typedef struct {
68     unsigned long sequence;
69 } PEEK;
70
71 /*
72  * Data "owned" for a single screen.  Each screen is divided into windows that
73  * show the text read from each terminal.  Input from a given screen will also
74  * be read into one window per screen.
75  */
76 typedef struct {
77     FILE *input;
78     FILE *output;
79     SCREEN *screen;             /* this screen - curses internal data */
80     int which1;                 /* this screen's index in DITTO[] array */
81     int length;                 /* length of windows[] and peeks[] */
82     char **titles;              /* per-window titles */
83     WINDOW **parents;           /* display boxes around each screen's data */
84     WINDOW **windows;           /* display data from each screen */
85     PEEK *peeks;                /* indices for each screen's fifo */
86     FIFO fifo;                  /* fifo for this screen */
87 #ifdef USE_PTHREADS
88     pthread_t thread;
89 #endif
90 } DITTO;
91
92 /*
93  * Structure used to pass multiple parameters via the use_screen()
94  * single-parameter interface.
95  */
96 typedef struct {
97     int source;                 /* which screen did character come from */
98     int target;                 /* which screen is character going to */
99     DITTO *ditto;               /* data for all screens */
100 } DDATA;
101
102 static void failed(const char *) GCC_NORETURN;
103 static void usage(void) GCC_NORETURN;
104
105 static void
106 failed(const char *s)
107 {
108     perror(s);
109     ExitProgram(EXIT_FAILURE);
110 }
111
112 static void
113 usage(void)
114 {
115     fprintf(stderr, "usage: ditto [terminal1 ...]\n");
116     ExitProgram(EXIT_FAILURE);
117 }
118
119 /* Add to the head of the fifo, checking for overflow. */
120 static void
121 put_fifo(FIFO * fifo, int value)
122 {
123     int next = NEXT_FIFO(fifo->head);
124     if (next == fifo->tail)
125         fifo->tail = NEXT_FIFO(fifo->tail);
126     fifo->data[next] = value;
127     fifo->head = next;
128     fifo->sequence += 1;
129 }
130
131 /* Get data from the tail (oldest part) of the fifo, returning -1 if no data.
132  * Since each screen can peek into the fifo, we do not update the tail index,
133  * but modify the peek-index.
134  *
135  * FIXME - test/workaround for case where fifo gets more than a buffer
136  * ahead of peek.
137  */
138 static int
139 peek_fifo(FIFO * fifo, PEEK * peek)
140 {
141     int result = -1;
142     if (peek->sequence < fifo->sequence) {
143         result = fifo->data[THIS_FIFO(peek->sequence)];
144         peek->sequence += 1;
145     }
146     return result;
147 }
148
149 static FILE *
150 open_tty(char *path)
151 {
152     FILE *fp;
153 #ifdef USE_XTERM_PTY
154     int amaster;
155     int aslave;
156     char slave_name[1024];
157     char s_option[sizeof(slave_name) + 80];
158     const char *xterm_prog = 0;
159
160     if ((xterm_prog = getenv("XTERM_PROG")) == 0)
161         xterm_prog = "xterm";
162
163     if (openpty(&amaster, &aslave, slave_name, 0, 0) != 0
164         || strlen(slave_name) > sizeof(slave_name) - 1)
165         failed("openpty");
166     if (strrchr(slave_name, '/') == 0) {
167         errno = EISDIR;
168         failed(slave_name);
169     }
170     _nc_SPRINTF(s_option, _nc_SLIMIT(sizeof(s_option))
171                 "-S%s/%d", slave_name, aslave);
172     if (fork()) {
173         execlp(xterm_prog, xterm_prog, s_option, "-title", path, (char *) 0);
174         _exit(0);
175     }
176     fp = fdopen(amaster, "r+");
177     if (fp == 0)
178         failed(path);
179 #else
180     struct stat sb;
181
182     if (stat(path, &sb) < 0)
183         failed(path);
184     if ((sb.st_mode & S_IFMT) != S_IFCHR) {
185         errno = ENOTTY;
186         failed(path);
187     }
188     fp = fopen(path, "r+");
189     if (fp == 0)
190         failed(path);
191     printf("opened %s\n", path);
192 #endif
193     assert(fp != 0);
194     return fp;
195 }
196
197 static void
198 init_screen(
199 #if HAVE_USE_WINDOW
200                SCREEN *sp GCC_UNUSED,
201 #endif
202                void *arg)
203 {
204     DITTO *target = (DITTO *) arg;
205     int high, wide;
206     int k;
207
208     cbreak();
209     noecho();
210     scrollok(stdscr, TRUE);
211     box(stdscr, 0, 0);
212
213     target->parents = typeCalloc(WINDOW *, (size_t) target->length);
214     target->windows = typeCalloc(WINDOW *, (size_t) target->length);
215     target->peeks = typeCalloc(PEEK, (size_t) target->length);
216
217     high = (LINES - 2) / target->length;
218     wide = (COLS - 2);
219     for (k = 0; k < target->length; ++k) {
220         WINDOW *outer = newwin(high, wide, 1 + (high * k), 1);
221         WINDOW *inner = derwin(outer, high - 2, wide - 2, 1, 1);
222
223         box(outer, 0, 0);
224         MvWAddStr(outer, 0, 2, target->titles[k]);
225         wnoutrefresh(outer);
226
227         scrollok(inner, TRUE);
228         keypad(inner, TRUE);
229 #ifndef USE_PTHREADS
230         nodelay(inner, TRUE);
231 #endif
232
233         target->parents[k] = outer;
234         target->windows[k] = inner;
235     }
236     doupdate();
237 }
238
239 static void
240 open_screen(DITTO * target, char **source, int length, int which1)
241 {
242     if (which1 != 0) {
243         target->input =
244             target->output = open_tty(source[which1]);
245     } else {
246         target->input = stdin;
247         target->output = stdout;
248     }
249
250     target->which1 = which1;
251     target->titles = source;
252     target->length = length;
253     target->fifo.head = -1;
254     target->screen = newterm((char *) 0,        /* assume $TERM is the same */
255                              target->output,
256                              target->input);
257
258     if (target->screen == 0)
259         failed("newterm");
260
261     (void) USING_SCREEN(target->screen, init_screen, target);
262 }
263
264 static int
265 close_screen(
266 #if HAVE_USE_WINDOW
267                 SCREEN *sp GCC_UNUSED,
268 #endif
269                 void *arg GCC_UNUSED)
270 {
271 #if HAVE_USE_WINDOW
272     (void) sp;
273 #endif
274     (void) arg;
275     return endwin();
276 }
277
278 /*
279  * Read data from the 'source' screen.
280  */
281 static int
282 read_screen(
283 #if HAVE_USE_WINDOW
284                SCREEN *sp GCC_UNUSED,
285 #endif
286                void *arg)
287 {
288     DDATA *data = (DDATA *) arg;
289     DITTO *ditto = &(data->ditto[data->source]);
290     WINDOW *win = ditto->windows[data->source];
291     int ch = wgetch(win);
292
293     if (ch > 0 && ch < 256)
294         put_fifo(&(ditto->fifo), ch);
295     else
296         ch = ERR;
297
298     return ch;
299 }
300
301 /*
302  * Write all of the data that's in fifos for the 'target' screen.
303  */
304 static int
305 write_screen(
306 #if HAVE_USE_WINDOW
307                 SCREEN *sp GCC_UNUSED,
308 #endif
309                 void *arg GCC_UNUSED)
310 {
311     DDATA *data = (DDATA *) arg;
312     DITTO *ditto = &(data->ditto[data->target]);
313     bool changed = FALSE;
314     int which;
315
316     for (which = 0; which < ditto->length; ++which) {
317         WINDOW *win = ditto->windows[which];
318         FIFO *fifo = &(data->ditto[which].fifo);
319         PEEK *peek = &(ditto->peeks[which]);
320         int ch;
321
322         while ((ch = peek_fifo(fifo, peek)) > 0) {
323             changed = TRUE;
324
325             waddch(win, (chtype) ch);
326             wnoutrefresh(win);
327         }
328     }
329
330     if (changed)
331         doupdate();
332     return OK;
333 }
334
335 static void
336 show_ditto(DITTO * data, int count, DDATA * ddata)
337 {
338     int n;
339
340     (void) data;
341     for (n = 0; n < count; n++) {
342         ddata->target = n;
343         USING_SCREEN(data[n].screen, write_screen, (void *) ddata);
344     }
345 }
346
347 #ifdef USE_PTHREADS
348 static void *
349 handle_screen(void *arg)
350 {
351     DDATA ddata;
352     int ch;
353
354     memset(&ddata, 0, sizeof(ddata));
355     ddata.ditto = (DITTO *) arg;
356     ddata.source = ddata.ditto->which1;
357     ddata.ditto -= ddata.source;        /* -> base of array */
358
359     for (;;) {
360         ch = read_screen(ddata.ditto->screen, &ddata);
361         if (ch == CTRL('D')) {
362             int later = (ddata.source ? ddata.source : -1);
363             int j;
364
365             for (j = ddata.ditto->length - 1; j > 0; --j) {
366                 if (j != later) {
367                     pthread_cancel(ddata.ditto[j].thread);
368                 }
369             }
370             if (later > 0) {
371                 pthread_cancel(ddata.ditto[later].thread);
372             }
373             break;
374         }
375         show_ditto(ddata.ditto, ddata.ditto->length, &ddata);
376     }
377     return NULL;
378 }
379 #endif
380
381 int
382 main(int argc, char *argv[])
383 {
384     int j;
385     DITTO *data;
386 #ifndef USE_PTHREADS
387     int count;
388 #endif
389
390     if (argc <= 1)
391         usage();
392
393     if ((data = typeCalloc(DITTO, (size_t) argc)) == 0)
394         failed("calloc data");
395
396     assert(data != 0);
397
398     for (j = 0; j < argc; j++) {
399         open_screen(&data[j], argv, argc, j);
400     }
401
402 #ifdef USE_PTHREADS
403     /*
404      * For multi-threaded operation, set up a reader for each of the screens.
405      * That uses blocking I/O rather than polling for input, so no calls to
406      * napms() are needed.
407      */
408     for (j = 0; j < argc; j++) {
409         (void) pthread_create(&(data[j].thread), NULL, handle_screen, &data[j]);
410     }
411     pthread_join(data[1].thread, NULL);
412 #else
413     /*
414      * Loop, reading characters from any of the inputs and writing to all
415      * of the screens.
416      */
417     for (count = 0;; ++count) {
418         DDATA ddata;
419         int ch;
420         int which = (count % argc);
421
422         napms(20);
423
424         ddata.source = which;
425         ddata.ditto = data;
426
427         ch = USING_SCREEN(data[which].screen, read_screen, &ddata);
428         if (ch == CTRL('D')) {
429             break;
430         } else if (ch != ERR) {
431             show_ditto(data, argc, &ddata);
432         }
433     }
434 #endif
435
436     /*
437      * Cleanup and exit
438      */
439     for (j = argc - 1; j >= 0; j--) {
440         USING_SCREEN(data[j].screen, close_screen, 0);
441         fprintf(data[j].output, "**Closed\r\n");
442
443         /*
444          * Closing before a delscreen() helps ncurses determine that there
445          * is no valid output buffer, and can remove the setbuf() data.
446          */
447         fflush(data[j].output);
448         fclose(data[j].output);
449         delscreen(data[j].screen);
450     }
451     ExitProgram(EXIT_SUCCESS);
452 }