1 /****************************************************************************
2 * Copyright 2018,2020 Thomas E. Dickey *
3 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************/
31 * Author: Thomas E. Dickey (1998-on)
33 * $Id: ditto.c,v 1.49 2020/02/02 23:34:34 tom Exp $
35 * The program illustrates how to set up multiple screens from a single
38 * If openpty() is supported, the command line parameters are titles for
39 * the windows showing each screen's data.
41 * If openpty() is not supported, you must invoke the program by specifying
42 * another terminal on the same machine by specifying its device, e.g.,
45 #include <test.priv.h>
55 #include USE_OPENPTY_HEADER
60 #define THIS_FIFO(n) ((n) % MAX_FIFO)
61 #define NEXT_FIFO(n) THIS_FIFO((n) + 1)
64 unsigned long sequence;
71 unsigned long sequence;
75 * Data "owned" for a single screen. Each screen is divided into windows that
76 * show the text read from each terminal. Input from a given screen will also
77 * be read into one window per screen.
82 SCREEN *screen; /* this screen - curses internal data */
83 int which1; /* this screen's index in DITTO[] array */
84 int length; /* length of windows[] and peeks[] */
85 char **titles; /* per-window titles */
86 WINDOW **parents; /* display boxes around each screen's data */
87 WINDOW **windows; /* display data from each screen */
88 PEEK *peeks; /* indices for each screen's fifo */
89 FIFO fifo; /* fifo for this screen */
96 * Structure used to pass multiple parameters via the use_screen()
97 * single-parameter interface.
100 int source; /* which screen did character come from */
101 int target; /* which screen is character going to */
102 DITTO *ditto; /* data for all screens */
105 static void failed(const char *) GCC_NORETURN;
106 static void usage(void) GCC_NORETURN;
109 failed(const char *s)
112 ExitProgram(EXIT_FAILURE);
118 fprintf(stderr, "Usage: ditto [terminal1 ...]\n");
119 ExitProgram(EXIT_FAILURE);
122 /* Add to the head of the fifo, checking for overflow. */
124 put_fifo(FIFO * fifo, int value)
126 int next = NEXT_FIFO(fifo->head);
127 if (next == fifo->tail)
128 fifo->tail = NEXT_FIFO(fifo->tail);
129 fifo->data[next] = value;
134 /* Get data from the tail (oldest part) of the fifo, returning -1 if no data.
135 * Since each screen can peek into the fifo, we do not update the tail index,
136 * but modify the peek-index.
138 * FIXME - test/workaround for case where fifo gets more than a buffer
142 peek_fifo(FIFO * fifo, PEEK * peek)
145 if (peek->sequence < fifo->sequence) {
146 result = fifo->data[THIS_FIFO(peek->sequence)];
159 char slave_name[1024];
160 char s_option[sizeof(slave_name) + 80];
161 const char *xterm_prog = 0;
163 if ((xterm_prog = getenv("XTERM_PROG")) == 0)
164 xterm_prog = "xterm";
166 if (openpty(&amaster, &aslave, slave_name, 0, 0) != 0
167 || strlen(slave_name) > sizeof(slave_name) - 1)
169 if (strrchr(slave_name, '/') == 0) {
173 _nc_SPRINTF(s_option, _nc_SLIMIT(sizeof(s_option))
174 "-S%s/%d", slave_name, aslave);
176 execlp(xterm_prog, xterm_prog, s_option, "-title", path, (char *) 0);
179 fp = fdopen(amaster, "r+");
185 if (stat(path, &sb) < 0)
187 if ((sb.st_mode & S_IFMT) != S_IFCHR) {
191 fp = fopen(path, "r+");
194 printf("opened %s\n", path);
203 SCREEN *sp GCC_UNUSED,
207 DITTO *target = (DITTO *) arg;
213 scrollok(stdscr, TRUE);
216 target->parents = typeCalloc(WINDOW *, (size_t) target->length);
217 target->windows = typeCalloc(WINDOW *, (size_t) target->length);
218 target->peeks = typeCalloc(PEEK, (size_t) target->length);
220 high = (LINES - 2) / target->length;
222 for (k = 0; k < target->length; ++k) {
223 WINDOW *outer = newwin(high, wide, 1 + (high * k), 1);
224 WINDOW *inner = derwin(outer, high - 2, wide - 2, 1, 1);
227 MvWAddStr(outer, 0, 2, target->titles[k]);
230 scrollok(inner, TRUE);
233 nodelay(inner, TRUE);
236 target->parents[k] = outer;
237 target->windows[k] = inner;
244 open_screen(DITTO * target, char **source, int length, int which1)
248 target->output = open_tty(source[which1]);
250 target->input = stdin;
251 target->output = stdout;
254 target->which1 = which1;
255 target->titles = source;
256 target->length = length;
257 target->fifo.head = -1;
258 target->screen = newterm((char *) 0, /* assume $TERM is the same */
262 if (target->screen == 0)
265 (void) USING_SCREEN(target->screen, init_screen, target);
271 SCREEN *sp GCC_UNUSED,
273 void *arg GCC_UNUSED)
283 * Read data from the 'source' screen.
288 SCREEN *sp GCC_UNUSED,
292 DDATA *data = (DDATA *) arg;
293 DITTO *ditto = &(data->ditto[data->source]);
294 WINDOW *win = ditto->windows[data->source];
295 int ch = wgetch(win);
297 if (ch > 0 && ch < 256)
298 put_fifo(&(ditto->fifo), ch);
306 * Write all of the data that's in fifos for the 'target' screen.
311 SCREEN *sp GCC_UNUSED,
313 void *arg GCC_UNUSED)
315 DDATA *data = (DDATA *) arg;
316 DITTO *ditto = &(data->ditto[data->target]);
317 bool changed = FALSE;
320 for (which = 0; which < ditto->length; ++which) {
321 WINDOW *win = ditto->windows[which];
322 FIFO *fifo = &(data->ditto[which].fifo);
323 PEEK *peek = &(ditto->peeks[which]);
326 while ((ch = peek_fifo(fifo, peek)) > 0) {
329 waddch(win, (chtype) ch);
340 show_ditto(DITTO * data, int count, DDATA * ddata)
345 for (n = 0; n < count; n++) {
347 USING_SCREEN(data[n].screen, write_screen, (void *) ddata);
353 handle_screen(void *arg)
358 memset(&ddata, 0, sizeof(ddata));
359 ddata.ditto = (DITTO *) arg;
360 ddata.source = ddata.ditto->which1;
361 ddata.ditto -= ddata.source; /* -> base of array */
364 ch = read_screen(ddata.ditto->screen, &ddata);
365 if (ch == CTRL('D')) {
366 int later = (ddata.source ? ddata.source : -1);
369 for (j = ddata.ditto->length - 1; j > 0; --j) {
371 pthread_cancel(ddata.ditto[j].thread);
375 pthread_cancel(ddata.ditto[later].thread);
379 show_ditto(ddata.ditto, ddata.ditto->length, &ddata);
386 main(int argc, char *argv[])
397 if ((data = typeCalloc(DITTO, (size_t) argc)) == 0)
398 failed("calloc data");
402 for (j = 0; j < argc; j++) {
403 open_screen(&data[j], argv, argc, j);
408 * For multi-threaded operation, set up a reader for each of the screens.
409 * That uses blocking I/O rather than polling for input, so no calls to
410 * napms() are needed.
412 for (j = 0; j < argc; j++) {
413 (void) pthread_create(&(data[j].thread), NULL, handle_screen, &data[j]);
415 pthread_join(data[1].thread, NULL);
418 * Loop, reading characters from any of the inputs and writing to all
421 for (count = 0;; ++count) {
424 int which = (count % argc);
428 ddata.source = which;
431 ch = USING_SCREEN(data[which].screen, read_screen, &ddata);
432 if (ch == CTRL('D')) {
434 } else if (ch != ERR) {
435 show_ditto(data, argc, &ddata);
443 for (j = argc - 1; j >= 0; j--) {
444 USING_SCREEN(data[j].screen, close_screen, 0);
445 fprintf(data[j].output, "**Closed\r\n");
448 * Closing before a delscreen() helps ncurses determine that there
449 * is no valid output buffer, and can remove the setbuf() data.
451 fflush(data[j].output);
452 fclose(data[j].output);
453 delscreen(data[j].screen);
455 ExitProgram(EXIT_SUCCESS);
461 printf("This program requires the curses delscreen function\n");
462 ExitProgram(EXIT_FAILURE);