1 /****************************************************************************
2 * Copyright 2018-2021,2022 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.55 2022/12/04 00:40:55 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 */
106 failed(const char *s)
109 ExitProgram(EXIT_FAILURE);
112 /* Add to the head of the fifo, checking for overflow. */
114 put_fifo(FIFO * fifo, int value)
116 int next = NEXT_FIFO(fifo->head);
117 if (next == fifo->tail)
118 fifo->tail = NEXT_FIFO(fifo->tail);
119 fifo->data[next] = value;
124 /* Get data from the tail (oldest part) of the fifo, returning -1 if no data.
125 * Since each screen can peek into the fifo, we do not update the tail index,
126 * but modify the peek-index.
128 * FIXME - test/workaround for case where fifo gets more than a buffer
132 peek_fifo(FIFO * fifo, PEEK * peek)
135 if (peek->sequence < fifo->sequence) {
136 result = fifo->data[THIS_FIFO(peek->sequence)];
149 char slave_name[1024];
150 char s_option[sizeof(slave_name) + 80];
151 const char *xterm_prog = 0;
153 if ((xterm_prog = getenv("XTERM_PROG")) == 0)
154 xterm_prog = "xterm";
156 if (openpty(&amaster, &aslave, slave_name, 0, 0) != 0
157 || strlen(slave_name) > sizeof(slave_name) - 1)
159 if (strrchr(slave_name, '/') == 0) {
163 _nc_SPRINTF(s_option, _nc_SLIMIT(sizeof(s_option))
164 "-S%s/%d", slave_name, aslave);
166 execlp(xterm_prog, xterm_prog, s_option, "-title", path, (char *) 0);
169 fp = fdopen(amaster, "r+");
175 if (stat(path, &sb) == -1)
177 if ((sb.st_mode & S_IFMT) != S_IFCHR) {
181 fp = fopen(path, "r+");
184 printf("opened %s\n", path);
193 SCREEN *sp GCC_UNUSED,
197 DITTO *target = (DITTO *) arg;
203 scrollok(stdscr, TRUE);
206 target->parents = typeCalloc(WINDOW *, (size_t) target->length);
207 target->windows = typeCalloc(WINDOW *, (size_t) target->length);
208 target->peeks = typeCalloc(PEEK, (size_t) target->length);
210 high = (LINES - 2) / target->length;
212 for (k = 0; k < target->length; ++k) {
213 WINDOW *outer = newwin(high, wide, 1 + (high * k), 1);
214 WINDOW *inner = derwin(outer, high - 2, wide - 2, 1, 1);
217 MvWAddStr(outer, 0, 2, target->titles[k]);
220 scrollok(inner, TRUE);
223 nodelay(inner, TRUE);
226 target->parents[k] = outer;
227 target->windows[k] = inner;
234 open_screen(DITTO * target, char **source, int length, int which1)
238 target->output = open_tty(source[which1]);
240 target->input = stdin;
241 target->output = stdout;
244 target->which1 = which1;
245 target->titles = source;
246 target->length = length;
247 target->fifo.head = -1;
248 target->screen = newterm((char *) 0, /* assume $TERM is the same */
252 if (target->screen == 0)
255 (void) USING_SCREEN(target->screen, init_screen, target);
261 SCREEN *sp GCC_UNUSED,
263 void *arg GCC_UNUSED)
273 * Read data from the 'source' screen.
278 SCREEN *sp GCC_UNUSED,
282 DDATA *data = (DDATA *) arg;
283 DITTO *ditto = &(data->ditto[data->source]);
284 WINDOW *win = ditto->windows[data->source];
285 int ch = wgetch(win);
287 if (ch > 0 && ch < 256)
288 put_fifo(&(ditto->fifo), ch);
296 * Write all of the data that's in fifos for the 'target' screen.
301 SCREEN *sp GCC_UNUSED,
303 void *arg GCC_UNUSED)
305 DDATA *data = (DDATA *) arg;
306 DITTO *ditto = &(data->ditto[data->target]);
307 bool changed = FALSE;
310 for (which = 0; which < ditto->length; ++which) {
311 WINDOW *win = ditto->windows[which];
312 FIFO *fifo = &(data->ditto[which].fifo);
313 PEEK *peek = &(ditto->peeks[which]);
316 while ((ch = peek_fifo(fifo, peek)) > 0) {
319 waddch(win, (chtype) ch);
330 show_ditto(DITTO * data, int count, DDATA * ddata)
335 for (n = 0; n < count; n++) {
337 USING_SCREEN(data[n].screen, write_screen, (void *) ddata);
343 handle_screen(void *arg)
347 memset(&ddata, 0, sizeof(ddata));
348 ddata.ditto = (DITTO *) arg;
349 ddata.source = ddata.ditto->which1;
350 ddata.ditto -= ddata.source; /* -> base of array */
353 int ch = read_screen(ddata.ditto->screen, &ddata);
354 if (ch == CTRL('D')) {
355 int later = (ddata.source ? ddata.source : -1);
358 for (j = ddata.ditto->length - 1; j > 0; --j) {
360 pthread_cancel(ddata.ditto[j].thread);
364 pthread_cancel(ddata.ditto[later].thread);
368 show_ditto(ddata.ditto, ddata.ditto->length, &ddata);
377 static const char *msg[] =
379 "Usage: ditto [terminal [terminal2 ...]]"
385 for (n = 0; n < SIZEOF(msg); n++)
386 fprintf(stderr, "%s\n", msg[n]);
388 ExitProgram(ok ? EXIT_SUCCESS : EXIT_FAILURE);
394 main(int argc, char *argv[]) {
402 while ((ch = getopt(argc, argv, OPTS_COMMON)) != -1) {
406 ExitProgram(EXIT_SUCCESS);
408 usage(ch == OPTS_USAGE);
414 if ((data = typeCalloc(DITTO, (size_t) argc)) == 0)
415 failed("calloc data");
419 for (j = 0; j < argc; j++) {
420 open_screen(&data[j], argv, argc, j);
425 * For multi-threaded operation, set up a reader for each of the screens.
426 * That uses blocking I/O rather than polling for input, so no calls to
427 * napms() are needed.
429 for (j = 0; j < argc; j++) {
430 (void) pthread_create(&(data[j].thread), NULL, handle_screen,
433 pthread_join(data[1].thread, NULL);
436 * Loop, reading characters from any of the inputs and writing to all
439 for (count = 0;; ++count) {
441 int which = (count % argc);
445 ddata.source = which;
448 ch = USING_SCREEN(data[which].screen, read_screen, &ddata);
449 if (ch == CTRL('D')) {
451 } else if (ch != ERR) {
452 show_ditto(data, argc, &ddata);
460 for (j = argc - 1; j >= 0; j--) {
461 USING_SCREEN(data[j].screen, close_screen, 0);
462 fprintf(data[j].output, "**Closed\r\n");
465 * Closing before a delscreen() helps ncurses determine that there
466 * is no valid output buffer, and can remove the setbuf() data.
468 fflush(data[j].output);
469 fclose(data[j].output);
470 delscreen(data[j].screen);
472 ExitProgram(EXIT_SUCCESS);
478 printf("This program requires the curses delscreen function\n");
479 ExitProgram(EXIT_FAILURE);