ncurses 5.7 - patch 20110115
[ncurses.git] / test / view.c
1 /****************************************************************************
2  * Copyright (c) 1998-2009,2010 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  * view.c -- a silly little viewer program
30  *
31  * written by Eric S. Raymond <esr@snark.thyrsus.com> December 1994
32  * to test the scrolling code in ncurses.
33  *
34  * modified by Thomas Dickey <dickey@clark.net> July 1995 to demonstrate
35  * the use of 'resizeterm()', and May 2000 to illustrate wide-character
36  * handling.
37  *
38  * Takes a filename argument.  It's a simple file-viewer with various
39  * scroll-up and scroll-down commands.
40  *
41  * n    -- scroll one line forward
42  * p    -- scroll one line back
43  *
44  * Either command accepts a numeric prefix interpreted as a repeat count.
45  * Thus, typing `5n' should scroll forward 5 lines in the file.
46  *
47  * The way you can tell this is working OK is that, in the trace file,
48  * there should be one scroll operation plus a small number of line
49  * updates, as opposed to a whole-page update.  This means the physical
50  * scroll operation worked, and the refresh() code only had to do a
51  * partial repaint.
52  *
53  * $Id: view.c,v 1.81 2010/11/14 01:06:02 tom Exp $
54  */
55
56 #include <test.priv.h>
57
58 #include <time.h>
59
60 #undef CTRL                     /* conflict on AIX 5.2 with <sys/ioctl.h> */
61
62 #if HAVE_TERMIOS_H
63 # include <termios.h>
64 #else
65 #if !defined(__MINGW32__)
66 # include <sgtty.h>
67 #endif
68 #endif
69
70 #if !defined(sun) || !HAVE_TERMIOS_H
71 # if HAVE_SYS_IOCTL_H
72 #  include <sys/ioctl.h>
73 # endif
74 #endif
75
76 #define my_pair 1
77
78 /* This is needed to compile 'struct winsize' */
79 #if NEED_PTEM_H
80 #include <sys/stream.h>
81 #include <sys/ptem.h>
82 #endif
83
84 #if USE_WIDEC_SUPPORT
85 #if HAVE_MBTOWC && HAVE_MBLEN
86 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, 0)), IGNORE_RC(mbtowc(NULL, NULL, 0))
87 #define count_mbytes(buffer,length,state) mblen(buffer,length)
88 #define check_mbytes(wch,buffer,length,state) \
89         (int) mbtowc(&wch, buffer, length)
90 #define state_unused
91 #elif HAVE_MBRTOWC && HAVE_MBRLEN
92 #define reset_mbytes(state) init_mb(state)
93 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
94 #define check_mbytes(wch,buffer,length,state) \
95         (int) mbrtowc(&wch, buffer, length, &state)
96 #else
97 make an error
98 #endif
99 #endif                          /* USE_WIDEC_SUPPORT */
100
101 static RETSIGTYPE finish(int sig) GCC_NORETURN;
102 static void show_all(const char *tag);
103
104 #if defined(SIGWINCH) && defined(TIOCGWINSZ) && HAVE_RESIZE_TERM
105 #define CAN_RESIZE 1
106 #else
107 #define CAN_RESIZE 0
108 #endif
109
110 #if CAN_RESIZE
111 static RETSIGTYPE adjust(int sig);
112 static int interrupted;
113 #endif
114
115 static bool waiting = FALSE;
116 static int shift = 0;
117 static bool try_color = FALSE;
118
119 static char *fname;
120 static NCURSES_CH_T **vec_lines;
121 static NCURSES_CH_T **lptr;
122 static int num_lines;
123
124 static void
125 usage(void)
126 {
127     static const char *msg[] =
128     {
129         "Usage: view [options] file"
130         ,""
131         ,"Options:"
132         ," -c       use color if terminal supports it"
133         ," -i       ignore INT, QUIT, TERM signals"
134         ," -n NUM   specify maximum number of lines (default 1000)"
135 #if defined(KEY_RESIZE)
136         ," -r       use old-style sigwinch handler rather than KEY_RESIZE"
137 #endif
138 #ifdef TRACE
139         ," -t       trace screen updates"
140         ," -T NUM   specify trace mask"
141 #endif
142     };
143     size_t n;
144     for (n = 0; n < SIZEOF(msg); n++)
145         fprintf(stderr, "%s\n", msg[n]);
146     ExitProgram(EXIT_FAILURE);
147 }
148
149 static int
150 ch_len(NCURSES_CH_T * src)
151 {
152     int result = 0;
153 #if USE_WIDEC_SUPPORT
154     int count;
155 #endif
156
157 #if USE_WIDEC_SUPPORT
158     for (;;) {
159         TEST_CCHAR(src, count, {
160             ++result;
161             ++src;
162         }
163         , {
164             break;
165         })
166     }
167 #else
168     while (*src++)
169         result++;
170 #endif
171     return result;
172 }
173
174 /*
175  * Allocate a string into an array of chtype's.  If UTF-8 mode is
176  * active, translate the string accordingly.
177  */
178 static NCURSES_CH_T *
179 ch_dup(char *src)
180 {
181     unsigned len = (unsigned) strlen(src);
182     NCURSES_CH_T *dst = typeMalloc(NCURSES_CH_T, len + 1);
183     unsigned j, k;
184 #if USE_WIDEC_SUPPORT
185     wchar_t wstr[CCHARW_MAX + 1];
186     wchar_t wch;
187     int l = 0;
188     size_t rc;
189     int width;
190 #ifndef state_unused
191     mbstate_t state;
192 #endif
193 #endif /* USE_WIDEC_SUPPORT */
194
195 #if USE_WIDEC_SUPPORT
196     reset_mbytes(state);
197 #endif
198     for (j = k = 0; j < len; j++) {
199 #if USE_WIDEC_SUPPORT
200         rc = (size_t) check_mbytes(wch, src + j, len - j, state);
201         if (rc == (size_t) -1 || rc == (size_t) -2)
202             break;
203         j += rc - 1;
204         if ((width = wcwidth(wch)) < 0)
205             break;
206         if ((width > 0 && l > 0) || l == CCHARW_MAX) {
207             wstr[l] = L'\0';
208             l = 0;
209             if (setcchar(dst + k, wstr, 0, 0, NULL) != OK)
210                 break;
211             ++k;
212         }
213         if (width == 0 && l == 0)
214             wstr[l++] = L' ';
215         wstr[l++] = wch;
216 #else
217         dst[k++] = (chtype) UChar(src[j]);
218 #endif
219     }
220 #if USE_WIDEC_SUPPORT
221     if (l > 0) {
222         wstr[l] = L'\0';
223         if (setcchar(dst + k, wstr, 0, 0, NULL) == OK)
224             ++k;
225     }
226     wstr[0] = L'\0';
227     setcchar(dst + k, wstr, 0, 0, NULL);
228 #else
229     dst[k] = 0;
230 #endif
231     return dst;
232 }
233
234 int
235 main(int argc, char *argv[])
236 {
237     int MAXLINES = 1000;
238     FILE *fp;
239     char buf[BUFSIZ];
240     int i;
241     int my_delay = 0;
242     NCURSES_CH_T **olptr;
243     int value = 0;
244     bool done = FALSE;
245     bool got_number = FALSE;
246 #if CAN_RESIZE
247     bool nonposix_resize = FALSE;
248 #endif
249     const char *my_label = "Input";
250
251     setlocale(LC_ALL, "");
252
253 #ifndef NCURSES_VERSION
254     /*
255      * We know ncurses will catch SIGINT if we don't establish our own handler.
256      * Other versions of curses may/may not catch it.
257      */
258     (void) signal(SIGINT, finish);      /* arrange interrupts to terminate */
259 #endif
260
261     while ((i = getopt(argc, argv, "cin:rtT:")) != -1) {
262         switch (i) {
263         case 'c':
264             try_color = TRUE;
265             break;
266         case 'i':
267             CATCHALL(SIG_IGN);
268             break;
269         case 'n':
270             if ((MAXLINES = atoi(optarg)) < 1 ||
271                 (MAXLINES + 2) <= 1)
272                 usage();
273             break;
274 #if CAN_RESIZE
275         case 'r':
276             nonposix_resize = TRUE;
277             break;
278 #endif
279 #ifdef TRACE
280         case 'T':
281             trace((unsigned) atoi(optarg));
282             break;
283         case 't':
284             trace(TRACE_CALLS);
285             break;
286 #endif
287         default:
288             usage();
289         }
290     }
291     if (optind + 1 != argc)
292         usage();
293
294     if ((vec_lines = typeCalloc(NCURSES_CH_T *, (size_t) MAXLINES + 2)) == 0)
295         usage();
296
297     assert(vec_lines != 0);
298
299     fname = argv[optind];
300     if ((fp = fopen(fname, "r")) == 0) {
301         perror(fname);
302         ExitProgram(EXIT_FAILURE);
303     }
304 #if CAN_RESIZE
305     if (nonposix_resize)
306         (void) signal(SIGWINCH, adjust);        /* arrange interrupts to resize */
307 #endif
308
309     /* slurp the file */
310     for (lptr = &vec_lines[0]; (lptr - vec_lines) < MAXLINES; lptr++) {
311         char temp[BUFSIZ], *s, *d;
312         int col;
313
314         if (fgets(buf, sizeof(buf), fp) == 0)
315             break;
316
317         /* convert tabs so that shift will work properly */
318         for (s = buf, d = temp, col = 0; (*d = *s) != '\0'; s++) {
319             if (*d == '\n') {
320                 *d = '\0';
321                 break;
322             } else if (*d == '\t') {
323                 col = (col | 7) + 1;
324                 while ((d - temp) != col)
325                     *d++ = ' ';
326             } else
327 #if USE_WIDEC_SUPPORT
328                 col++, d++;
329 #else
330             if (isprint(UChar(*d))) {
331                 col++;
332                 d++;
333             } else {
334                 sprintf(d, "\\%03o", UChar(*s));
335                 d += strlen(d);
336                 col = (int) (d - temp);
337             }
338 #endif
339         }
340         *lptr = ch_dup(temp);
341     }
342     (void) fclose(fp);
343     num_lines = (int) (lptr - vec_lines);
344
345     (void) initscr();           /* initialize the curses library */
346     keypad(stdscr, TRUE);       /* enable keyboard mapping */
347     (void) nonl();              /* tell curses not to do NL->CR/NL on output */
348     (void) cbreak();            /* take input chars one at a time, no wait for \n */
349     (void) noecho();            /* don't echo input */
350     nodelay(stdscr, TRUE);
351     idlok(stdscr, TRUE);        /* allow use of insert/delete line */
352
353     if (try_color) {
354         if (has_colors()) {
355             start_color();
356             init_pair(my_pair, COLOR_WHITE, COLOR_BLUE);
357             bkgd(COLOR_PAIR(my_pair));
358         } else {
359             try_color = FALSE;
360         }
361     }
362
363     lptr = vec_lines;
364     while (!done) {
365         int n, c;
366
367         if (!got_number)
368             show_all(my_label);
369
370         for (;;) {
371 #if CAN_RESIZE
372             if (interrupted) {
373                 adjust(0);
374                 my_label = "interrupt";
375             }
376 #endif
377             waiting = TRUE;
378             c = getch();
379             waiting = FALSE;
380             if ((c < 127) && isdigit(c)) {
381                 if (!got_number) {
382                     MvPrintw(0, 0, "Count: ");
383                     clrtoeol();
384                 }
385                 addch(UChar(c));
386                 value = 10 * value + (c - '0');
387                 got_number = TRUE;
388             } else
389                 break;
390         }
391         if (got_number && value) {
392             n = value;
393         } else {
394             n = 1;
395         }
396
397         if (c != ERR)
398             my_label = keyname(c);
399         switch (c) {
400         case KEY_DOWN:
401         case 'n':
402             olptr = lptr;
403             for (i = 0; i < n; i++)
404                 if ((lptr - vec_lines) < (num_lines - LINES + 1))
405                     lptr++;
406                 else
407                     break;
408             scrl((int) (lptr - olptr));
409             break;
410
411         case KEY_UP:
412         case 'p':
413             olptr = lptr;
414             for (i = 0; i < n; i++)
415                 if (lptr > vec_lines)
416                     lptr--;
417                 else
418                     break;
419             scrl((int) (lptr - olptr));
420             break;
421
422         case 'h':
423         case KEY_HOME:
424             lptr = vec_lines;
425             break;
426
427         case 'e':
428         case KEY_END:
429             if (num_lines > LINES)
430                 lptr = vec_lines + num_lines - LINES + 1;
431             else
432                 lptr = vec_lines;
433             break;
434
435         case 'r':
436         case KEY_RIGHT:
437             shift += n;
438             break;
439
440         case 'l':
441         case KEY_LEFT:
442             shift -= n;
443             if (shift < 0) {
444                 shift = 0;
445                 beep();
446             }
447             break;
448
449         case 'q':
450             done = TRUE;
451             break;
452
453 #ifdef KEY_RESIZE
454         case KEY_RESIZE:        /* ignore this; ncurses will repaint */
455             break;
456 #endif
457         case 's':
458             if (got_number) {
459                 halfdelay(my_delay = n);
460             } else {
461                 nodelay(stdscr, FALSE);
462                 my_delay = -1;
463             }
464             break;
465         case ' ':
466             nodelay(stdscr, TRUE);
467             my_delay = 0;
468             break;
469         case ERR:
470             if (!my_delay)
471                 napms(50);
472             break;
473         default:
474             beep();
475             break;
476         }
477         if (c >= KEY_MIN || (c > 0 && !isdigit(c))) {
478             got_number = FALSE;
479             value = 0;
480         }
481     }
482
483     finish(0);                  /* we're done */
484 }
485
486 static RETSIGTYPE
487 finish(int sig)
488 {
489     endwin();
490 #if NO_LEAKS
491     if (vec_lines != 0) {
492         int n;
493         for (n = 0; n < num_lines; ++n) {
494             free(vec_lines[n]);
495         }
496         free(vec_lines);
497     }
498 #endif
499     ExitProgram(sig != 0 ? EXIT_FAILURE : EXIT_SUCCESS);
500 }
501
502 #if CAN_RESIZE
503 /*
504  * This uses functions that are "unsafe", but it seems to work on SunOS. 
505  * Usually: the "unsafe" refers to the functions that POSIX lists which may be
506  * called from a signal handler.  Those do not include buffered I/O, which is
507  * used for instance in wrefresh().  To be really portable, you should use the
508  * KEY_RESIZE return (which relies on ncurses' sigwinch handler).
509  *
510  * The 'wrefresh(curscr)' is needed to force the refresh to start from the top
511  * of the screen -- some xterms mangle the bitmap while resizing.
512  */
513 static RETSIGTYPE
514 adjust(int sig)
515 {
516     if (waiting || sig == 0) {
517         struct winsize size;
518
519         if (ioctl(fileno(stdout), TIOCGWINSZ, &size) == 0) {
520             resize_term(size.ws_row, size.ws_col);
521             wrefresh(curscr);
522             show_all(sig ? "SIGWINCH" : "interrupt");
523         }
524         interrupted = FALSE;
525     } else {
526         interrupted = TRUE;
527     }
528     (void) signal(SIGWINCH, adjust);    /* some systems need this */
529 }
530 #endif /* CAN_RESIZE */
531
532 static void
533 show_all(const char *tag)
534 {
535     int i;
536     char temp[BUFSIZ];
537     NCURSES_CH_T *s;
538     time_t this_time;
539
540 #if CAN_RESIZE
541     sprintf(temp, "%.20s (%3dx%3d) col %d ", tag, LINES, COLS, shift);
542     i = (int) strlen(temp);
543     if ((i + 7) < (int) sizeof(temp)) {
544         sprintf(temp + i, "view %.*s",
545                 (int) (sizeof(temp) - 7 - (size_t) i),
546                 fname);
547     }
548 #else
549     (void) tag;
550     sprintf(temp, "view %.*s", (int) sizeof(temp) - 7, fname);
551 #endif
552     move(0, 0);
553     printw("%.*s", COLS, temp);
554     clrtoeol();
555     this_time = time((time_t *) 0);
556     strcpy(temp, ctime(&this_time));
557     if ((i = (int) strlen(temp)) != 0) {
558         temp[--i] = 0;
559         if (move(0, COLS - i - 2) != ERR)
560             printw("  %s", temp);
561     }
562
563     scrollok(stdscr, FALSE);    /* prevent screen from moving */
564     for (i = 1; i < LINES; i++) {
565         move(i, 0);
566         printw("%3ld:", (long) (lptr + i - vec_lines));
567         clrtoeol();
568         if ((s = lptr[i - 1]) != 0) {
569             int len = ch_len(s);
570             if (len > shift) {
571 #if USE_WIDEC_SUPPORT
572                 add_wchstr(s + shift);
573 #else
574                 addchstr(s + shift);
575 #endif
576             }
577 #if defined(NCURSES_VERSION) || defined(HAVE_WCHGAT)
578             if (try_color)
579                 wchgat(stdscr, -1, A_NORMAL, my_pair, NULL);
580 #endif
581         }
582     }
583     setscrreg(1, LINES - 1);
584     scrollok(stdscr, TRUE);
585     refresh();
586 }