ncurses 6.0 - patch 20160903
[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.43 2016/02/06 21:19:28 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     sprintf(s_option, "-S%s/%d", slave_name, aslave);
171     if (fork()) {
172         execlp(xterm_prog, xterm_prog, s_option, "-title", path, (char *) 0);
173         _exit(0);
174     }
175     fp = fdopen(amaster, "r+");
176     if (fp == 0)
177         failed(path);
178 #else
179     struct stat sb;
180
181     if (stat(path, &sb) < 0)
182         failed(path);
183     if ((sb.st_mode & S_IFMT) != S_IFCHR) {
184         errno = ENOTTY;
185         failed(path);
186     }
187     fp = fopen(path, "r+");
188     if (fp == 0)
189         failed(path);
190     printf("opened %s\n", path);
191 #endif
192     assert(fp != 0);
193     return fp;
194 }
195
196 static void
197 init_screen(
198 #if HAVE_USE_WINDOW
199                SCREEN *sp GCC_UNUSED,
200 #endif
201                void *arg)
202 {
203     DITTO *target = (DITTO *) arg;
204     int high, wide;
205     int k;
206
207     cbreak();
208     noecho();
209     scrollok(stdscr, TRUE);
210     box(stdscr, 0, 0);
211
212     target->parents = typeCalloc(WINDOW *, (size_t) target->length);
213     target->windows = typeCalloc(WINDOW *, (size_t) target->length);
214     target->peeks = typeCalloc(PEEK, (size_t) target->length);
215
216     high = (LINES - 2) / target->length;
217     wide = (COLS - 2);
218     for (k = 0; k < target->length; ++k) {
219         WINDOW *outer = newwin(high, wide, 1 + (high * k), 1);
220         WINDOW *inner = derwin(outer, high - 2, wide - 2, 1, 1);
221
222         box(outer, 0, 0);
223         MvWAddStr(outer, 0, 2, target->titles[k]);
224         wnoutrefresh(outer);
225
226         scrollok(inner, TRUE);
227         keypad(inner, TRUE);
228 #ifndef USE_PTHREADS
229         nodelay(inner, TRUE);
230 #endif
231
232         target->parents[k] = outer;
233         target->windows[k] = inner;
234     }
235     doupdate();
236 }
237
238 static void
239 open_screen(DITTO * target, char **source, int length, int which1)
240 {
241     if (which1 != 0) {
242         target->input =
243             target->output = open_tty(source[which1]);
244     } else {
245         target->input = stdin;
246         target->output = stdout;
247     }
248
249     target->which1 = which1;
250     target->titles = source;
251     target->length = length;
252     target->fifo.head = -1;
253     target->screen = newterm((char *) 0,        /* assume $TERM is the same */
254                              target->output,
255                              target->input);
256
257     if (target->screen == 0)
258         failed("newterm");
259
260     (void) USING_SCREEN(target->screen, init_screen, target);
261 }
262
263 static int
264 close_screen(
265 #if HAVE_USE_WINDOW
266                 SCREEN *sp GCC_UNUSED,
267 #endif
268                 void *arg GCC_UNUSED)
269 {
270 #if HAVE_USE_WINDOW
271     (void) sp;
272 #endif
273     (void) arg;
274     return endwin();
275 }
276
277 /*
278  * Read data from the 'source' screen.
279  */
280 static int
281 read_screen(
282 #if HAVE_USE_WINDOW
283                SCREEN *sp GCC_UNUSED,
284 #endif
285                void *arg)
286 {
287     DDATA *data = (DDATA *) arg;
288     DITTO *ditto = &(data->ditto[data->source]);
289     WINDOW *win = ditto->windows[data->source];
290     int ch = wgetch(win);
291
292     if (ch > 0 && ch < 256)
293         put_fifo(&(ditto->fifo), ch);
294     else
295         ch = ERR;
296
297     return ch;
298 }
299
300 /*
301  * Write all of the data that's in fifos for the 'target' screen.
302  */
303 static int
304 write_screen(
305 #if HAVE_USE_WINDOW
306                 SCREEN *sp GCC_UNUSED,
307 #endif
308                 void *arg GCC_UNUSED)
309 {
310     DDATA *data = (DDATA *) arg;
311     DITTO *ditto = &(data->ditto[data->target]);
312     bool changed = FALSE;
313     int which;
314
315     for (which = 0; which < ditto->length; ++which) {
316         WINDOW *win = ditto->windows[which];
317         FIFO *fifo = &(data->ditto[which].fifo);
318         PEEK *peek = &(ditto->peeks[which]);
319         int ch;
320
321         while ((ch = peek_fifo(fifo, peek)) > 0) {
322             changed = TRUE;
323
324             waddch(win, (chtype) ch);
325             wnoutrefresh(win);
326         }
327     }
328
329     if (changed)
330         doupdate();
331     return OK;
332 }
333
334 static void
335 show_ditto(DITTO * data, int count, DDATA * ddata)
336 {
337     int n;
338
339     (void) data;
340     for (n = 0; n < count; n++) {
341         ddata->target = n;
342         USING_SCREEN(data[n].screen, write_screen, (void *) ddata);
343     }
344 }
345
346 #ifdef USE_PTHREADS
347 static void *
348 handle_screen(void *arg)
349 {
350     DDATA ddata;
351     int ch;
352
353     memset(&ddata, 0, sizeof(ddata));
354     ddata.ditto = (DITTO *) arg;
355     ddata.source = ddata.ditto->which1;
356     ddata.ditto -= ddata.source;        /* -> base of array */
357
358     for (;;) {
359         ch = read_screen(ddata.ditto->screen, &ddata);
360         if (ch == CTRL('D')) {
361             int later = (ddata.source ? ddata.source : -1);
362             int j;
363
364             for (j = ddata.ditto->length - 1; j > 0; --j) {
365                 if (j != later) {
366                     pthread_cancel(ddata.ditto[j].thread);
367                 }
368             }
369             if (later > 0) {
370                 pthread_cancel(ddata.ditto[later].thread);
371             }
372             break;
373         }
374         show_ditto(ddata.ditto, ddata.ditto->length, &ddata);
375     }
376     return NULL;
377 }
378 #endif
379
380 int
381 main(int argc, char *argv[])
382 {
383     int j;
384     DITTO *data;
385 #ifndef USE_PTHREADS
386     int count;
387 #endif
388
389     if (argc <= 1)
390         usage();
391
392     if ((data = typeCalloc(DITTO, (size_t) argc)) == 0)
393         failed("calloc data");
394
395     assert(data != 0);
396
397     for (j = 0; j < argc; j++) {
398         open_screen(&data[j], argv, argc, j);
399     }
400
401 #ifdef USE_PTHREADS
402     /*
403      * For multi-threaded operation, set up a reader for each of the screens.
404      * That uses blocking I/O rather than polling for input, so no calls to
405      * napms() are needed.
406      */
407     for (j = 0; j < argc; j++) {
408         (void) pthread_create(&(data[j].thread), NULL, handle_screen, &data[j]);
409     }
410     pthread_join(data[1].thread, NULL);
411 #else
412     /*
413      * Loop, reading characters from any of the inputs and writing to all
414      * of the screens.
415      */
416     for (count = 0;; ++count) {
417         DDATA ddata;
418         int ch;
419         int which = (count % argc);
420
421         napms(20);
422
423         ddata.source = which;
424         ddata.ditto = data;
425
426         ch = USING_SCREEN(data[which].screen, read_screen, &ddata);
427         if (ch == CTRL('D')) {
428             break;
429         } else if (ch != ERR) {
430             show_ditto(data, argc, &ddata);
431         }
432     }
433 #endif
434
435     /*
436      * Cleanup and exit
437      */
438     for (j = argc - 1; j >= 0; j--) {
439         USING_SCREEN(data[j].screen, close_screen, 0);
440         fprintf(data[j].output, "**Closed\r\n");
441
442         /*
443          * Closing before a delscreen() helps ncurses determine that there
444          * is no valid output buffer, and can remove the setbuf() data.
445          */
446         fflush(data[j].output);
447         fclose(data[j].output);
448         delscreen(data[j].screen);
449     }
450     ExitProgram(EXIT_SUCCESS);
451 }