include <term.h> for setupterm(), tputs() and tgoto()
[nvi.git] / cl / cl_screen.c
blob978aa7d5f5de3b84a1059580d629f8910e1286c4
1 /*-
2 * Copyright (c) 1993, 1994
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1993, 1994, 1995, 1996
5 * Keith Bostic. All rights reserved.
7 * See the LICENSE file for redistribution information.
8 */
10 #include "config.h"
12 #ifndef lint
13 static const char sccsid[] = "$Id: cl_screen.c,v 10.56 2002/05/03 19:59:44 skimo Exp $ (Berkeley) $Date: 2002/05/03 19:59:44 $";
14 #endif /* not lint */
16 #include <sys/types.h>
17 #include <sys/queue.h>
19 #include <bitstring.h>
20 #include <errno.h>
21 #include <signal.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <term.h>
26 #include <termios.h>
27 #include <unistd.h>
29 #include "../common/common.h"
30 #include "cl.h"
32 static int cl_ex_end __P((GS *));
33 static int cl_ex_init __P((SCR *));
34 static void cl_freecap __P((CL_PRIVATE *));
35 static int cl_vi_end __P((GS *));
36 static int cl_vi_init __P((SCR *));
37 static int cl_putenv __P((SCR *sp, char *, char *, u_long));
40 * cl_screen --
41 * Switch screen types.
43 * PUBLIC: int cl_screen __P((SCR *, u_int32_t));
45 int
46 cl_screen(SCR *sp, u_int32_t flags)
48 CL_PRIVATE *clp;
49 WINDOW *win;
50 GS *gp;
52 gp = sp->gp;
53 clp = CLP(sp);
54 win = CLSP(sp) ? CLSP(sp) : stdscr;
56 /* See if the current information is incorrect. */
57 if (F_ISSET(gp, G_SRESTART)) {
58 if (CLSP(sp)) {
59 delwin(CLSP(sp));
60 sp->cl_private = NULL;
62 if (cl_quit(gp))
63 return (1);
64 F_CLR(gp, G_SRESTART);
67 /* See if we're already in the right mode. */
68 if ((LF_ISSET(SC_EX) && F_ISSET(sp, SC_SCR_EX)) ||
69 (LF_ISSET(SC_VI) && F_ISSET(sp, SC_SCR_VI)))
70 return (0);
73 * Fake leaving ex mode.
75 * We don't actually exit ex or vi mode unless forced (e.g. by a window
76 * size change). This is because many curses implementations can't be
77 * called twice in a single program. Plus, it's faster. If the editor
78 * "leaves" vi to enter ex, when it exits ex we'll just fall back into
79 * vi.
81 if (F_ISSET(sp, SC_SCR_EX))
82 F_CLR(sp, SC_SCR_EX);
85 * Fake leaving vi mode.
87 * Clear out the rest of the screen if we're in the middle of a split
88 * screen. Move to the last line in the current screen -- this makes
89 * terminal scrolling happen naturally. Note: *don't* move past the
90 * end of the screen, as there are ex commands (e.g., :read ! cat file)
91 * that don't want to. Don't clear the info line, its contents may be
92 * valid, e.g. :file|append.
94 if (F_ISSET(sp, SC_SCR_VI)) {
95 F_CLR(sp, SC_SCR_VI);
97 if (sp->q.cqe_next != (void *)&sp->wp->scrq) {
98 (void)wmove(win, RLNO(sp, sp->rows), 0);
99 wclrtobot(win);
101 (void)wmove(win, RLNO(sp, sp->rows) - 1, 0);
102 wrefresh(win);
105 /* Enter the requested mode. */
106 if (LF_ISSET(SC_EX)) {
107 if (cl_ex_init(sp))
108 return (1);
109 F_SET(clp, CL_IN_EX | CL_SCR_EX_INIT);
112 * If doing an ex screen for ex mode, move to the last line
113 * on the screen.
115 if (F_ISSET(sp, SC_EX) && clp->cup != NULL)
116 tputs(tgoto(clp->cup,
117 0, O_VAL(sp, O_LINES) - 1), 1, cl_putchar);
118 } else {
119 if (cl_vi_init(sp))
120 return (1);
121 F_CLR(clp, CL_IN_EX);
122 F_SET(clp, CL_SCR_VI_INIT);
124 return (0);
128 * cl_quit --
129 * Shutdown the screens.
131 * PUBLIC: int cl_quit __P((GS *));
134 cl_quit(GS *gp)
136 CL_PRIVATE *clp;
137 int rval;
139 rval = 0;
140 clp = GCLP(gp);
143 * If we weren't really running, ignore it. This happens if the
144 * screen changes size before we've called curses.
146 if (!F_ISSET(clp, CL_SCR_EX_INIT | CL_SCR_VI_INIT))
147 return (0);
149 /* Clean up the terminal mappings. */
150 if (cl_term_end(gp))
151 rval = 1;
153 /* Really leave vi mode. */
154 if (F_ISSET(clp, CL_STDIN_TTY) &&
155 F_ISSET(clp, CL_SCR_VI_INIT) && cl_vi_end(gp))
156 rval = 1;
158 /* Really leave ex mode. */
159 if (F_ISSET(clp, CL_STDIN_TTY) &&
160 F_ISSET(clp, CL_SCR_EX_INIT) && cl_ex_end(gp))
161 rval = 1;
164 * If we were running ex when we quit, or we're using an implementation
165 * of curses where endwin() doesn't get this right, restore the original
166 * terminal modes.
168 * XXX
169 * We always do this because it's too hard to figure out what curses
170 * implementations get it wrong. It may discard type-ahead characters
171 * from the tty queue.
173 (void)tcsetattr(STDIN_FILENO, TCSADRAIN | TCSASOFT, &clp->orig);
175 F_CLR(clp, CL_SCR_EX_INIT | CL_SCR_VI_INIT);
176 return (rval);
180 * cl_vi_init --
181 * Initialize the curses vi screen.
183 static int
184 cl_vi_init(SCR *sp)
186 CL_PRIVATE *clp;
187 GS *gp;
188 char *o_cols, *o_lines, *o_term, *ttype;
190 gp = sp->gp;
191 clp = CLP(sp);
193 /* If already initialized, just set the terminal modes. */
194 if (F_ISSET(clp, CL_SCR_VI_INIT))
195 goto fast;
197 /* Curses vi always reads from (and writes to) a terminal. */
198 if (!F_ISSET(clp, CL_STDIN_TTY) || !isatty(STDOUT_FILENO)) {
199 msgq(sp, M_ERR,
200 "016|Vi's standard input and output must be a terminal");
201 return (1);
204 /* We'll need a terminal type. */
205 if (opts_empty(sp, O_TERM, 0))
206 return (1);
207 ttype = O_STR(sp, O_TERM);
210 * XXX
211 * Changing the row/column and terminal values is done by putting them
212 * into the environment, which is then read by curses. What this loses
213 * in ugliness, it makes up for in stupidity. We can't simply put the
214 * values into the environment ourselves, because in the presence of a
215 * kernel mechanism for returning the window size, entering values into
216 * the environment will screw up future screen resizing events, e.g. if
217 * the user enters a :shell command and then resizes their window. So,
218 * if they weren't already in the environment, we make sure to delete
219 * them immediately after setting them.
221 * XXX
222 * Putting the TERM variable into the environment is necessary, even
223 * though we're using newterm() here. We may be using initscr() as
224 * the underlying function.
226 o_term = getenv("TERM");
227 cl_putenv(sp, "TERM", ttype, 0);
228 o_lines = getenv("LINES");
229 cl_putenv(sp, "LINES", NULL, (u_long)O_VAL(sp, O_LINES));
230 o_cols = getenv("COLUMNS");
231 cl_putenv(sp, "COLUMNS", NULL, (u_long)O_VAL(sp, O_COLUMNS));
234 * We don't care about the SCREEN reference returned by newterm, we
235 * never have more than one SCREEN at a time.
237 * XXX
238 * The SunOS initscr() can't be called twice. Don't even think about
239 * using it. It fails in subtle ways (e.g. select(2) on fileno(stdin)
240 * stops working). (The SVID notes that applications should only call
241 * initscr() once.)
243 * XXX
244 * The HP/UX newterm doesn't support the NULL first argument, so we
245 * have to specify the terminal type.
247 errno = 0;
248 if (newterm(ttype, stdout, stdin) == NULL) {
249 if (errno)
250 msgq(sp, M_SYSERR, "%s", ttype);
251 else
252 msgq(sp, M_ERR, "%s: unknown terminal type", ttype);
253 return (1);
256 if (o_term == NULL)
257 cl_unsetenv(sp, "TERM");
258 if (o_lines == NULL)
259 cl_unsetenv(sp, "LINES");
260 if (o_cols == NULL)
261 cl_unsetenv(sp, "COLUMNS");
264 * XXX
265 * Someone got let out alone without adult supervision -- the SunOS
266 * newterm resets the signal handlers. There's a race, but it's not
267 * worth closing.
269 (void)sig_init(sp->gp, sp);
272 * We use raw mode. What we want is 8-bit clean, however, signals
273 * and flow control should continue to work. Admittedly, it sounds
274 * like cbreak, but it isn't. Using cbreak() can get you additional
275 * things like IEXTEN, which turns on flags like DISCARD and LNEXT.
277 * !!!
278 * If raw isn't turning off echo and newlines, something's wrong.
279 * However, it shouldn't hurt.
281 noecho(); /* No character echo. */
282 nonl(); /* No CR/NL translation. */
283 raw(); /* 8-bit clean. */
284 idlok(stdscr, 1); /* Use hardware insert/delete line. */
286 /* Put the cursor keys into application mode. */
287 (void)keypad(stdscr, TRUE);
290 * XXX
291 * The screen TI sequence just got sent. See the comment in
292 * cl_funcs.c:cl_attr().
294 clp->ti_te = TI_SENT;
297 * XXX
298 * Historic implementations of curses handled SIGTSTP signals
299 * in one of three ways. They either:
301 * 1: Set their own handler, regardless.
302 * 2: Did not set a handler if a handler was already installed.
303 * 3: Set their own handler, but then called any previously set
304 * handler after completing their own cleanup.
306 * We don't try and figure out which behavior is in place, we force
307 * it to SIG_DFL after initializing the curses interface, which means
308 * that curses isn't going to take the signal. Since curses isn't
309 * reentrant (i.e., the whole curses SIGTSTP interface is a fantasy),
310 * we're doing The Right Thing.
312 (void)signal(SIGTSTP, SIG_DFL);
315 * If flow control was on, turn it back on. Turn signals on. ISIG
316 * turns on VINTR, VQUIT, VDSUSP and VSUSP. The main curses code
317 * already installed a handler for VINTR. We're going to disable the
318 * other three.
320 * XXX
321 * We want to use ^Y as a vi scrolling command. If the user has the
322 * DSUSP character set to ^Y (common practice) clean it up. As it's
323 * equally possible that the user has VDSUSP set to 'a', we disable
324 * it regardless. It doesn't make much sense to suspend vi at read,
325 * so I don't think anyone will care. Alternatively, we could look
326 * it up in the table of legal command characters and turn it off if
327 * it matches one. VDSUSP wasn't in POSIX 1003.1-1990, so we test for
328 * it.
330 * XXX
331 * We don't check to see if the user had signals enabled originally.
332 * If they didn't, it's unclear what we're supposed to do here, but
333 * it's also pretty unlikely.
335 if (tcgetattr(STDIN_FILENO, &clp->vi_enter)) {
336 msgq(sp, M_SYSERR, "tcgetattr");
337 goto err;
339 if (clp->orig.c_iflag & IXON)
340 clp->vi_enter.c_iflag |= IXON;
341 if (clp->orig.c_iflag & IXOFF)
342 clp->vi_enter.c_iflag |= IXOFF;
344 clp->vi_enter.c_lflag |= ISIG;
345 #ifdef VDSUSP
346 clp->vi_enter.c_cc[VDSUSP] = _POSIX_VDISABLE;
347 #endif
348 clp->vi_enter.c_cc[VQUIT] = _POSIX_VDISABLE;
349 clp->vi_enter.c_cc[VSUSP] = _POSIX_VDISABLE;
352 * XXX
353 * OSF/1 doesn't turn off the <discard>, <literal-next> or <status>
354 * characters when curses switches into raw mode. It should be OK
355 * to do it explicitly for everyone.
357 #ifdef VDISCARD
358 clp->vi_enter.c_cc[VDISCARD] = _POSIX_VDISABLE;
359 #endif
360 #ifdef VLNEXT
361 clp->vi_enter.c_cc[VLNEXT] = _POSIX_VDISABLE;
362 #endif
363 #ifdef VSTATUS
364 clp->vi_enter.c_cc[VSTATUS] = _POSIX_VDISABLE;
365 #endif
367 /* Initialize terminal based information. */
368 if (cl_term_init(sp))
369 goto err;
371 fast: /* Set the terminal modes. */
372 if (tcsetattr(STDIN_FILENO, TCSASOFT | TCSADRAIN, &clp->vi_enter)) {
373 if (errno == EINTR)
374 goto fast;
375 msgq(sp, M_SYSERR, "tcsetattr");
376 err: (void)cl_vi_end(sp->gp);
377 return (1);
379 return (0);
383 * cl_vi_end --
384 * Shutdown the vi screen.
386 static int
387 cl_vi_end(GS *gp)
389 CL_PRIVATE *clp;
391 clp = GCLP(gp);
393 /* Restore the cursor keys to normal mode. */
394 (void)keypad(stdscr, FALSE);
397 * If we were running vi when we quit, scroll the screen up a single
398 * line so we don't lose any information.
400 * Move to the bottom of the window (some endwin implementations don't
401 * do this for you).
403 if (!F_ISSET(clp, CL_IN_EX)) {
404 (void)move(0, 0);
405 (void)deleteln();
406 (void)move(LINES - 1, 0);
407 (void)refresh();
410 cl_freecap(clp);
412 /* End curses window. */
413 (void)endwin();
416 * XXX
417 * The screen TE sequence just got sent. See the comment in
418 * cl_funcs.c:cl_attr().
420 clp->ti_te = TE_SENT;
422 return (0);
426 * cl_ex_init --
427 * Initialize the ex screen.
429 static int
430 cl_ex_init(SCR *sp)
432 CL_PRIVATE *clp;
434 clp = CLP(sp);
436 /* If already initialized, just set the terminal modes. */
437 if (F_ISSET(clp, CL_SCR_EX_INIT))
438 goto fast;
440 /* If not reading from a file, we're done. */
441 if (!F_ISSET(clp, CL_STDIN_TTY))
442 return (0);
444 /* Get the ex termcap/terminfo strings. */
445 (void)cl_getcap(sp, "cup", &clp->cup);
446 (void)cl_getcap(sp, "smso", &clp->smso);
447 (void)cl_getcap(sp, "rmso", &clp->rmso);
448 (void)cl_getcap(sp, "el", &clp->el);
449 (void)cl_getcap(sp, "cuu1", &clp->cuu1);
451 /* Enter_standout_mode and exit_standout_mode are paired. */
452 if (clp->smso == NULL || clp->rmso == NULL) {
453 if (clp->smso != NULL) {
454 free(clp->smso);
455 clp->smso = NULL;
457 if (clp->rmso != NULL) {
458 free(clp->rmso);
459 clp->rmso = NULL;
464 * Turn on canonical mode, with normal input and output processing.
465 * Start with the original terminal settings as the user probably
466 * had them (including any local extensions) set correctly for the
467 * current terminal.
469 * !!!
470 * We can't get everything that we need portably; for example, ONLCR,
471 * mapping <newline> to <carriage-return> on output isn't required
472 * by POSIX 1003.1b-1993. If this turns out to be a problem, then
473 * we'll either have to play some games on the mapping, or we'll have
474 * to make all ex printf's output \r\n instead of \n.
476 clp->ex_enter = clp->orig;
477 clp->ex_enter.c_lflag |= ECHO | ECHOE | ECHOK | ICANON | IEXTEN | ISIG;
478 #ifdef ECHOCTL
479 clp->ex_enter.c_lflag |= ECHOCTL;
480 #endif
481 #ifdef ECHOKE
482 clp->ex_enter.c_lflag |= ECHOKE;
483 #endif
484 clp->ex_enter.c_iflag |= ICRNL;
485 clp->ex_enter.c_oflag |= OPOST;
486 #ifdef ONLCR
487 clp->ex_enter.c_oflag |= ONLCR;
488 #endif
490 fast: if (tcsetattr(STDIN_FILENO, TCSADRAIN | TCSASOFT, &clp->ex_enter)) {
491 if (errno == EINTR)
492 goto fast;
493 msgq(sp, M_SYSERR, "tcsetattr");
494 return (1);
496 return (0);
500 * cl_ex_end --
501 * Shutdown the ex screen.
503 static int
504 cl_ex_end(GS *gp)
506 CL_PRIVATE *clp;
508 clp = GCLP(gp);
510 cl_freecap(clp);
512 return (0);
516 * cl_getcap --
517 * Retrieve termcap/terminfo strings.
519 * PUBLIC: int cl_getcap __P((SCR *, char *, char **));
522 cl_getcap(SCR *sp, char *name, char **elementp)
524 size_t len;
525 char *t;
527 if ((t = tigetstr(name)) != NULL &&
528 t != (char *)-1 && (len = strlen(t)) != 0) {
529 MALLOC_RET(sp, *elementp, char *, len + 1);
530 memmove(*elementp, t, len + 1);
532 return (0);
536 * cl_freecap --
537 * Free any allocated termcap/terminfo strings.
539 static void
540 cl_freecap(CL_PRIVATE *clp)
542 if (clp->el != NULL) {
543 free(clp->el);
544 clp->el = NULL;
546 if (clp->cup != NULL) {
547 free(clp->cup);
548 clp->cup = NULL;
550 if (clp->cuu1 != NULL) {
551 free(clp->cuu1);
552 clp->cuu1 = NULL;
554 if (clp->rmso != NULL) {
555 free(clp->rmso);
556 clp->rmso = NULL;
558 if (clp->smso != NULL) {
559 free(clp->smso);
560 clp->smso = NULL;
565 * cl_putenv --
566 * Put a value into the environment.
568 static int
569 cl_putenv(SCR *sp, char *name, char *str, u_long value)
571 char buf[40];
573 if (str == NULL) {
574 (void)snprintf(buf, sizeof(buf), "%lu", value);
575 return (cl_setenv(sp, name, buf));
576 } else
577 return (cl_setenv(sp, name, str));