1 /****************************************************************************
2 * Copyright 2019-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 ****************************************************************************/
30 * view.c -- a silly little viewer program
32 * written by Eric S. Raymond <esr@snark.thyrsus.com> December 1994
33 * to test the scrolling code in ncurses.
35 * modified by Thomas Dickey <dickey@clark.net> July 1995 to demonstrate
36 * the use of 'resizeterm()', and May 2000 to illustrate wide-character
37 * handling. This program intentionally does not use pads, to allow testing
38 * with less-capable implementations of curses.
40 * Takes a filename argument. It's a simple file-viewer with various
41 * scroll-up and scroll-down commands.
43 * n -- scroll one line forward
44 * p -- scroll one line back
46 * Either command accepts a numeric prefix interpreted as a repeat count.
47 * Thus, typing `5n' should scroll forward 5 lines in the file.
49 * The way you can tell this is working OK is that, in the trace file,
50 * there should be one scroll operation plus a small number of line
51 * updates, as opposed to a whole-page update. This means the physical
52 * scroll operation worked, and the refresh() code only had to do a
55 * $Id: view.c,v 1.145 2022/12/04 00:40:11 tom Exp $
58 #include <test.priv.h>
59 #include <widechars.h>
60 #include <popup_msg.h>
65 static GCC_NORETURN void finish(int sig);
70 static bool try_color = FALSE;
73 static NCURSES_CH_T **vec_lines;
74 static NCURSES_CH_T **lptr;
78 static bool n_option = FALSE;
81 static GCC_NORETURN void
82 failed(const char *msg)
85 fprintf(stderr, "%s\n", msg);
86 ExitProgram(EXIT_FAILURE);
90 ch_len(NCURSES_CH_T *src)
97 TEST_CCHAR(src, count, {
98 int len = wcwidth(test_wch[0]);
99 result += (len > 0) ? len : 1;
118 if (vec_lines != 0) {
120 for (n = 0; n < num_lines; ++n) {
126 ExitProgram(sig != 0 ? EXIT_FAILURE : EXIT_SUCCESS);
130 show_all(const char *tag)
137 for (digits = 1, i = num_lines; i > 0; i /= 10) {
141 _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
142 "view %.*s", (int) strlen(tag), tag);
143 i = (int) strlen(temp);
144 _nc_SPRINTF(temp + i, _nc_SLIMIT(sizeof(temp) - (size_t) i)
145 " %.*s", (int) sizeof(temp) - i - 2, fname);
147 printw("%.*s", COLS, temp);
149 this_time = time((time_t *) 0);
150 _nc_STRNCPY(temp, ctime(&this_time), (size_t) 30);
151 if ((i = (int) strlen(temp)) != 0) {
153 if (move(0, COLS - i - 2) != ERR)
157 scrollok(stdscr, FALSE); /* prevent screen from moving */
158 for (i = 1; i < LINES; i++) {
161 int actual = (int) (lptr + i - vec_lines);
163 if (actual > num_lines) {
174 printw("%*d:", digits, actual);
176 if ((s = lptr[i - 1]) == 0) {
181 #if USE_WIDEC_SUPPORT
183 * An index into an array of cchar_t's is not necessarily the same
184 * as the column-offset. A pad would do this directly. Here we
185 * must translate (or compute a table of offsets).
191 for (j = actual = 0; j < shift; ++j) {
194 TEST_CCHAR(s + j, count, {
195 width = wcwidth(test_wch[0]);
201 if (actual > shift) {
203 } else if (actual == shift) {
211 add_wchstr(s + j + (actual > shift));
218 #if defined(NCURSES_VERSION) || defined(HAVE_WCHGAT)
220 wchgat(stdscr, -1, WA_NORMAL, my_pair, NULL);
223 setscrreg(1, LINES - 1);
224 scrollok(stdscr, TRUE);
229 read_file(const char *filename)
242 if (stat(filename, &sb) != 0
243 || (sb.st_mode & S_IFMT) != S_IFREG) {
244 failed("input is not a file");
247 if (sb.st_size == 0) {
248 failed("input is empty");
251 if ((fp = fopen(filename, "r")) == 0) {
252 failed("cannot open input-file");
255 if ((my_blob = malloc((size_t) sb.st_size + 1)) == 0) {
256 failed("cannot allocate memory for input-file");
259 len = fread(my_blob, sizeof(char), (size_t) sb.st_size, fp);
262 if (len > (size_t) sb.st_size)
263 len = (size_t) sb.st_size;
266 for (pass = 0; pass < 2; ++pass) {
267 char *base = my_blob;
269 for (j = 0; j < len; ++j) {
270 if (my_blob[j] == '\n') {
275 base = my_blob + j + 1;
279 if (base != (my_blob + j)) {
286 if (((my_vec = typeCalloc(char *, (size_t) k + 2)) == 0)) {
287 failed("cannot allocate line-vector #1");
290 if (my_vec[0] == NULL)
295 #if USE_WIDEC_SUPPORT
296 if (!memcmp("\357\273\277", my_blob, 3)) {
297 char *s = my_blob + 3;
301 } while ((*d++ = *s++) != '\0');
305 width = (int) strlen(my_vec[0]);
306 for (k = 1; my_vec[k]; ++k) {
307 int check = (int) (my_vec[k] - my_vec[k - 1]);
311 width = (width + 1) * 5;
312 my_win = newwin(2, width, 0, 0);
314 failed("cannot allocate temporary window");
317 if ((vec_lines = typeCalloc(NCURSES_CH_T *, (size_t) num_lines + 2)) == 0) {
318 failed("cannot allocate line-vector #2");
322 * Use the curses library for rendering, including tab-conversion. This
323 * will not make the resulting array's indices correspond to column for
324 * lines containing double-width cells because the "in_wch" functions will
325 * ignore the skipped cells. Use pads for that sort of thing.
327 Trace(("slurp the file"));
328 for (k = 0; my_vec[k]; ++k) {
331 #if USE_WIDEC_SUPPORT
332 char *last = my_vec[k] + (int) strlen(my_vec[k]);
338 #endif /* USE_WIDEC_SUPPORT */
342 #if USE_WIDEC_SUPPORT
346 for (s = my_vec[k]; *s != '\0'; ++s) {
347 #if USE_WIDEC_SUPPORT
349 rc = (size_t) check_mbytes(wch[0], s, (size_t) (last - s), state);
350 if ((long) rc == -1 || (long) rc == -2) {
354 waddwstr(my_win, wch);
357 waddch(my_win, *s & 0xff);
363 /* "x + 1" works with standard curses; some implementations are buggy */
364 if ((vec_lines[k] = typeCalloc(NCURSES_CH_T, x + width + 1)) == 0) {
365 failed("cannot allocate line-vector #3");
367 #if USE_WIDEC_SUPPORT
368 win_wchnstr(my_win, vec_lines[k], x);
370 winchnstr(my_win, vec_lines[k], x);
379 static GCC_NORETURN void
382 static const char *msg[] =
384 "Usage: view [options] file"
388 ," -c use color if terminal supports it"
389 ," -i ignore INT, QUIT, TERM signals"
390 #if USE_WIDEC_SUPPORT
391 ," -n use waddch (bytes) rather then wadd_wch (wide-chars)"
393 ," -s start in single-step mode, waiting for input"
395 ," -t trace screen updates"
396 ," -T NUM specify trace mask"
400 for (n = 0; n < SIZEOF(msg); n++)
401 fprintf(stderr, "%s\n", msg[n]);
402 ExitProgram(ok ? EXIT_SUCCESS : EXIT_FAILURE);
409 main(int argc, char *argv[])
411 static const char *help[] =
414 " q,^Q,ESC - quit this program",
416 " p,<Up> - scroll the viewport up by one row",
417 " n,<Down> - scroll the viewport down by one row",
418 " l,<Left> - scroll the viewport left by one column",
419 " r,<Right> - scroll the viewport right by one column",
420 " <,> - scroll the viewport left/right by 8 columns",
422 " h,<Home> - scroll the viewport to top of file",
423 " ^F,<PageDn> - scroll to the next page",
424 " ^B,<PageUp> - scroll to the previous page",
425 " e,<End> - scroll the viewport to end of file",
427 " ^L - repaint using redrawwin()",
429 " 0 through 9 - enter digits for count",
430 " s - use entered count for halfdelay() parameter",
431 " - if no entered count, stop nodelay()",
432 " <space> - begin nodelay()",
439 NCURSES_CH_T **olptr;
442 bool got_number = FALSE;
443 bool ignore_sigs = FALSE;
444 bool single_step = FALSE;
445 const char *my_label = "Input";
447 setlocale(LC_ALL, "");
449 while ((ch = getopt(argc, argv, OPTS_COMMON "cinstT:")) != -1) {
457 #if USE_WIDEC_SUPPORT
469 int tvalue = (int) strtol(optarg, &next, 0);
470 if (tvalue < 0 || (next != 0 && *next != 0))
472 curses_trace((unsigned) tvalue);
476 curses_trace(TRACE_CALLS);
481 ExitProgram(EXIT_SUCCESS);
483 usage(ch == OPTS_USAGE);
487 if (optind + 1 != argc)
490 InitAndCatch(initscr(), ignore_sigs ? SIG_IGN : finish);
491 keypad(stdscr, TRUE); /* enable keyboard mapping */
492 (void) nonl(); /* tell curses not to do NL->CR/NL on output */
493 (void) cbreak(); /* take input chars one at a time, no wait for \n */
494 (void) noecho(); /* don't echo input */
496 nodelay(stdscr, TRUE);
497 idlok(stdscr, TRUE); /* allow use of insert/delete line */
499 read_file(fname = argv[optind]);
504 init_pair(my_pair, COLOR_WHITE, COLOR_BLUE);
505 bkgd((chtype) COLOR_PAIR(my_pair));
520 if ((c < 127) && isdigit(c)) {
522 MvPrintw(0, 0, "Count: ");
526 value = 10 * value + (c - '0');
531 if (got_number && value) {
538 my_label = keyname(c);
543 for (i = 0; i < n; i++)
544 if ((lptr - vec_lines) < (num_lines - LINES + 1))
548 scrl((int) (lptr - olptr));
554 for (i = 0; i < n; i++)
555 if (lptr > vec_lines)
559 scrl((int) (lptr - olptr));
569 if ((shift -= 8) < 0)
579 if (num_lines > LINES)
580 lptr = (vec_lines + num_lines - LINES + 1);
582 lptr = (vec_lines + (num_lines - 2));
588 for (i = 0; i < n; i++) {
589 if ((lptr - vec_lines) < (num_lines - 5))
592 lptr = (vec_lines + num_lines - 2);
599 for (i = 0; i < n; i++) {
600 if ((lptr - vec_lines) >= LINES)
628 case KEY_RESIZE: /* ignore this; ncurses will repaint */
634 halfdelay(my_delay = n);
636 nodelay(stdscr, FALSE);
640 nodelay(stdscr, FALSE);
645 nodelay(stdscr, TRUE);
656 popup_msg(stdscr, help);
662 if (c >= KEY_MIN || (c > 0 && !isdigit(c))) {
668 finish(0); /* we're done */