1 /* $NetBSD: cl_funcs.c,v 1.4 2014/01/26 21:43:45 christos Exp $ */
3 * Copyright (c) 1993, 1994
4 * The Regents of the University of California. All rights reserved.
5 * Copyright (c) 1993, 1994, 1995, 1996
6 * Keith Bostic. All rights reserved.
8 * See the LICENSE file for redistribution information.
13 #include <sys/cdefs.h>
16 static const char sccsid
[] = "Id: cl_funcs.c,v 10.72 2002/03/02 23:18:33 skimo Exp (Berkeley) Date: 2002/03/02 23:18:33 ";
19 __RCSID("$NetBSD: cl_funcs.c,v 1.4 2014/01/26 21:43:45 christos Exp $");
22 #include <sys/types.h>
23 #include <sys/queue.h>
26 #include <bitstring.h>
35 #include "../common/common.h"
39 static void cl_rdiv
__P((SCR
*));
42 addstr4(SCR
*sp
, const void *str
, size_t len
, int wide
)
48 win
= CLSP(sp
) ? CLSP(sp
) : stdscr
;
51 * If ex isn't in control, it's the last line of the screen and
52 * it's a split screen, use inverse video.
57 if (!F_ISSET(sp
, SC_SCR_EXWROTE
) &&
58 y
== RLNO(sp
, LASTLINE(sp
)) && IS_SPLIT(sp
)) {
65 if (waddnwstr(win
, str
, len
) == ERR
)
69 if (waddnstr(win
, str
, len
) == ERR
)
79 * Add len bytes from the string at the cursor, advancing the cursor.
81 * PUBLIC: int cl_waddstr __P((SCR *, const CHAR_T *, size_t));
84 cl_waddstr(SCR
*sp
, const CHAR_T
*str
, size_t len
)
86 return addstr4(sp
, (const void *)str
, len
, 1);
91 * Add len bytes from the string at the cursor, advancing the cursor.
93 * PUBLIC: int cl_addstr __P((SCR *, const char *, size_t));
96 cl_addstr(SCR
*sp
, const char *str
, size_t len
)
98 return addstr4(sp
, (const void *)str
, len
, 0);
103 * Toggle a screen attribute on/off.
105 * PUBLIC: int cl_attr __P((SCR *, scr_attr_t, int));
108 cl_attr(SCR
*sp
, scr_attr_t attribute
, int on
)
114 win
= CLSP(sp
) ? CLSP(sp
) : stdscr
;
120 * There's a major layering violation here. The problem is that the
121 * X11 xterm screen has what's known as an "alternate" screen. Some
122 * xterm termcap/terminfo entries include sequences to switch to/from
123 * that alternate screen as part of the ti/te (smcup/rmcup) strings.
124 * Vi runs in the alternate screen, so that you are returned to the
125 * same screen contents on exit from vi that you had when you entered
126 * vi. Further, when you run :shell, or :!date or similar ex commands,
127 * you also see the original screen contents. This wasn't deliberate
128 * on vi's part, it's just that it historically sent terminal init/end
129 * sequences at those times, and the addition of the alternate screen
130 * sequences to the strings changed the behavior of vi. The problem
131 * caused by this is that we don't want to switch back to the alternate
132 * screen while getting a new command from the user, when the user is
133 * continuing to enter ex commands, e.g.:
135 * :!date <<< switch to original screen
136 * [Hit return to continue] <<< prompt user to continue
137 * :command <<< get command from user
139 * Note that the :command input is a true vi input mode, e.g., input
140 * maps and abbreviations are being done. So, we need to be able to
141 * switch back into the vi screen mode, without flashing the screen.
143 * To make matters worse, the curses initscr() and endwin() calls will
144 * do this automatically -- so, this attribute isn't as controlled by
145 * the higher level screen as closely as one might like.
148 if (clp
->ti_te
!= TI_SENT
) {
149 clp
->ti_te
= TI_SENT
;
150 if (clp
->smcup
== NULL
)
151 (void)cl_getcap(sp
, "smcup", &clp
->smcup
);
152 if (clp
->smcup
!= NULL
)
153 (void)tputs(clp
->smcup
, 1, cl_putchar
);
156 if (clp
->ti_te
!= TE_SENT
) {
157 clp
->ti_te
= TE_SENT
;
158 if (clp
->rmcup
== NULL
)
159 (void)cl_getcap(sp
, "rmcup", &clp
->rmcup
);
160 if (clp
->rmcup
!= NULL
)
161 (void)tputs(clp
->rmcup
, 1, cl_putchar
);
162 (void)fflush(stdout
);
164 (void)fflush(stdout
);
167 if (F_ISSET(sp
, SC_EX
| SC_SCR_EXWROTE
)) {
168 if (clp
->smso
== NULL
)
171 (void)tputs(clp
->smso
, 1, cl_putchar
);
173 (void)tputs(clp
->rmso
, 1, cl_putchar
);
174 (void)fflush(stdout
);
177 (void)wstandout(win
);
179 (void)wstandend(win
);
190 * Return the baud rate.
192 * PUBLIC: int cl_baud __P((SCR *, u_long *));
195 cl_baud(SCR
*sp
, u_long
*ratep
)
201 * There's no portable way to get a "baud rate" -- cfgetospeed(3)
202 * returns the value associated with some #define, which we may
203 * never have heard of, or which may be a purely local speed. Vi
204 * only cares if it's SLOW (w300), slow (w1200) or fast (w9600).
205 * Try and detect the slow ones, and default to fast.
208 switch (cfgetospeed(&clp
->orig
)) {
231 * Ring the bell/flash the screen.
233 * PUBLIC: int cl_bell __P((SCR *));
238 if (F_ISSET(sp
, SC_EX
| SC_SCR_EXWROTE
| SC_SCR_EX
))
239 (void)write(STDOUT_FILENO
, "\07", 1); /* \a */
242 * Vi has an edit option which determines if the terminal
243 * should be beeped or the screen flashed.
245 if (O_ISSET(sp
, O_FLASH
))
255 * Clear from the current cursor to the end of the line.
257 * PUBLIC: int cl_clrtoeol __P((SCR *));
267 win
= CLSP(sp
) ? CLSP(sp
) : stdscr
;
271 /* The cursor must be returned to its original position. */
273 for (spcnt
= (sp
->coff
+ sp
->cols
) - x
; spcnt
> 0; --spcnt
)
274 (void)waddch(win
, ' ');
275 (void)wmove(win
, y
, x
);
279 return (wclrtoeol(win
) == ERR
);
284 * Return the current cursor position.
286 * PUBLIC: int cl_cursor __P((SCR *, size_t *, size_t *));
289 cl_cursor(SCR
*sp
, size_t *yp
, size_t *xp
)
292 win
= CLSP(sp
) ? CLSP(sp
) : stdscr
;
294 * The curses screen support splits a single underlying curses screen
295 * into multiple screens to support split screen semantics. For this
296 * reason the returned value must be adjusted to be relative to the
297 * current screen, and not absolute. Screens that implement the split
298 * using physically distinct screens won't need this hack.
300 getyx(win
, *yp
, *xp
);
310 * Delete the current line, scrolling all lines below it.
312 * PUBLIC: int cl_deleteln __P((SCR *));
319 size_t col
, lno
, spcnt
, y
, x
;
321 win
= CLSP(sp
) ? CLSP(sp
) : stdscr
;
324 * This clause is required because the curses screen uses reverse
325 * video to delimit split screens. If the screen does not do this,
326 * this code won't be necessary.
328 * If the bottom line was in reverse video, rewrite it in normal
329 * video before it's scrolled.
331 * Check for the existence of a chgat function; XSI requires it, but
332 * historic implementations of System V curses don't. If it's not
333 * a #define, we'll fall back to doing it by hand, which is slow but
336 * By hand means walking through the line, retrieving and rewriting
337 * each character. Curses has no EOL marker, so track strings of
338 * spaces, and copy the trailing spaces only if there's a non-space
339 * character following.
341 if (!F_ISSET(sp
, SC_SCR_EXWROTE
) && IS_SPLIT(sp
)) {
344 mvwchgat(win
, RLNO(sp
, LASTLINE(sp
)), 0, -1, A_NORMAL
, 0, NULL
);
346 for (lno
= RLNO(sp
, LASTLINE(sp
)), col
= spcnt
= 0;;) {
347 (void)wmove(win
, lno
, col
);
352 (void)wmove(win
, lno
, col
- spcnt
);
353 for (; spcnt
> 0; --spcnt
)
354 (void)waddch(win
, ' ');
355 (void)waddch(win
, ch
);
357 if (++col
>= sp
->cols
)
361 (void)wmove(win
, y
, x
);
365 * The bottom line is expected to be blank after this operation,
366 * and other screens must support that semantic.
368 return (wdeleteln(win
) == ERR
);
375 * PUBLIC: int cl_discard __P((SCR *, SCR **));
378 cl_discard(SCR
*discardp
, SCR
**acquirep
)
385 F_SET(clp
, CL_LAYOUT
);
387 if (CLSP(discardp
)) {
388 delwin(CLSP(discardp
));
389 discardp
->cl_private
= NULL
;
393 /* no screens got a piece; we're done */
397 for (; (tsp
= *acquirep
) != NULL
; ++acquirep
) {
399 F_SET(clp
, CL_LAYOUT
);
403 tsp
->cl_private
= subwin(stdscr
, tsp
->rows
, tsp
->cols
,
404 tsp
->roff
, tsp
->coff
);
407 /* discardp is going away, acquirep is taking up its space. */
413 * Adjust the screen for ex. This routine is purely for standalone
414 * ex programs. All special purpose, all special case.
416 * PUBLIC: int cl_ex_adjust __P((SCR *, exadj_t));
419 cl_ex_adjust(SCR
*sp
, exadj_t action
)
427 /* Move the cursor up one line if that's possible. */
428 if (clp
->cuu1
!= NULL
)
429 (void)tputs(clp
->cuu1
, 1, cl_putchar
);
430 else if (clp
->cup
!= NULL
)
431 (void)tputs(tgoto(clp
->cup
,
432 0, LINES
- 2), 1, cl_putchar
);
437 /* Clear the line. */
438 if (clp
->el
!= NULL
) {
440 (void)tputs(clp
->el
, 1, cl_putchar
);
443 * Historically, ex didn't erase the line, so, if the
444 * displayed line was only a single glyph, and <eof>
445 * was more than one glyph, the output would not fully
446 * overwrite the user's input. To fix this, output
447 * the maxiumum character number of spaces. Note,
448 * this won't help if the user entered extra prompt
449 * or <blank> characters before the command character.
450 * We'd have to do a lot of work to make that work, and
451 * it's almost certainly not worth the effort.
453 for (cnt
= 0; cnt
< MAX_CHARACTER_COLUMNS
; ++cnt
)
455 for (cnt
= 0; cnt
< MAX_CHARACTER_COLUMNS
; ++cnt
)
458 (void)fflush(stdout
);
469 * Push down the current line, discarding the bottom line.
471 * PUBLIC: int cl_insertln __P((SCR *));
477 win
= CLSP(sp
) ? CLSP(sp
) : stdscr
;
479 * The current line is expected to be blank after this operation,
480 * and the screen must support that semantic.
482 return (winsertln(win
) == ERR
);
487 * Return the value for a special key.
489 * PUBLIC: int cl_keyval __P((SCR *, scr_keyval_t, CHAR_T *, int *));
492 cl_keyval(SCR
*sp
, scr_keyval_t val
, CHAR_T
*chp
, int *dnep
)
497 * VEOF, VERASE and VKILL are required by POSIX 1003.1-1990,
498 * VWERASE is a 4BSD extension.
503 *dnep
= (*chp
= clp
->orig
.c_cc
[VEOF
]) == _POSIX_VDISABLE
;
506 *dnep
= (*chp
= clp
->orig
.c_cc
[VERASE
]) == _POSIX_VDISABLE
;
509 *dnep
= (*chp
= clp
->orig
.c_cc
[VKILL
]) == _POSIX_VDISABLE
;
513 *dnep
= (*chp
= clp
->orig
.c_cc
[VWERASE
]) == _POSIX_VDISABLE
;
527 * PUBLIC: int cl_move __P((SCR *, size_t, size_t));
530 cl_move(SCR
*sp
, size_t lno
, size_t cno
)
533 win
= CLSP(sp
) ? CLSP(sp
) : stdscr
;
534 /* See the comment in cl_cursor. */
535 if (wmove(win
, RLNO(sp
, lno
), RCNO(sp
, cno
)) == ERR
) {
536 msgq(sp
, M_ERR
, "Error: move: l(%zu + %zu) c(%zu + %zu)",
537 lno
, sp
->roff
, cno
, sp
->coff
);
545 * Refresh the screen.
547 * PUBLIC: int cl_refresh __P((SCR *, int));
550 cl_refresh(SCR
*sp
, int repaint
)
558 win
= CLSP(sp
) ? CLSP(sp
) : stdscr
;
561 * If we received a killer signal, we're done, there's no point
562 * in refreshing the screen.
568 * If repaint is set, the editor is telling us that we don't know
569 * what's on the screen, so we have to repaint from scratch.
571 * If repaint set or the screen layout changed, we need to redraw
572 * any lines separating vertically split screens. If the horizontal
573 * offsets are the same, then the split was vertical, and need to
574 * draw a dividing line.
576 if (repaint
|| F_ISSET(clp
, CL_LAYOUT
)) {
578 for (psp
= sp
; psp
!= NULL
; psp
= TAILQ_NEXT(psp
, q
))
579 for (tsp
= TAILQ_NEXT(psp
, q
); tsp
!= NULL
;
580 tsp
= TAILQ_NEXT(tsp
, q
))
581 if (psp
->roff
== tsp
->roff
) {
582 if (psp
->coff
+ psp
->cols
+ 1 == tsp
->coff
)
585 if (tsp
->coff
+ tsp
->cols
+ 1 == psp
->coff
)
588 (void)wmove(stdscr
, y
, x
);
589 F_CLR(clp
, CL_LAYOUT
);
593 * In the curses library, doing wrefresh(curscr) is okay, but the
594 * screen flashes when we then apply the refresh() to bring it up
595 * to date. So, use clearok().
600 * Only do an actual refresh, when this is the focus window,
601 * i.e. the one holding the cursor. This assumes that refresh
602 * is called for that window after refreshing the others.
603 * This prevents the cursor being drawn in the other windows.
605 return (wnoutrefresh(stdscr
) == ERR
||
606 wnoutrefresh(win
) == ERR
||
607 (sp
== clp
->focus
&& doupdate() == ERR
));
612 * Draw a dividing line between two vertically split screens.
619 for (cnt
= 0; cnt
< sp
->rows
- 1; ++cnt
) {
620 wmove(stdscr
, sp
->roff
+ cnt
, sp
->cols
+ sp
->coff
);
629 * PUBLIC: int cl_rename __P((SCR *, char *, int));
632 cl_rename(SCR
*sp
, char *name
, int on
)
644 if (!F_ISSET(clp
, CL_RENAME_OK
))
649 * We can only rename windows for xterm.
651 if (strncmp(OG_STR(gp
, GO_TERM
), "xterm", sizeof("xterm") - 1))
656 * Try and figure out the current name of this window. There
657 * are two forms of the xwininfo output I've seen:
659 * Window id: 0x400000d "name"
660 * Window id: 0x140000d (name)
663 "expr \"`xwininfo -id $WINDOWID | grep id:`\" : '.* [\"(]\\(.*\\)[\")]'"
665 if (clp
->oname
== NULL
&&
666 (pfp
= popen(COMMAND
, "r")) != NULL
) {
667 if (fgets(buf
, sizeof(buf
), pfp
) != NULL
&&
668 (p
= strchr(buf
, '\n')) != NULL
) {
670 clp
->oname
= strdup(buf
);
675 cl_setname(gp
, name
);
677 F_SET(clp
, CL_RENAME
);
679 if (F_ISSET(clp
, CL_RENAME
)) {
680 cl_setname(gp
, clp
->oname
);
682 F_CLR(clp
, CL_RENAME
);
689 * Set a X11 icon/window name.
691 * PUBLIC: void cl_setname __P((GS *, char *));
694 cl_setname(GS
*gp
, char *name
)
696 /* X11 xterm escape sequence to rename the icon/window. */
697 #define XTERM_RENAME "\033]0;%s\007"
699 (void)printf(XTERM_RENAME
, name
== NULL
? OG_STR(gp
, GO_TERM
) : name
);
700 (void)fflush(stdout
);
707 * PUBLIC: int cl_split __P((SCR *, SCR *));
710 cl_split(SCR
*origp
, SCR
*newp
)
715 F_SET(clp
, CL_LAYOUT
);
720 origp
->cl_private
= subwin(stdscr
, origp
->rows
, origp
->cols
,
721 origp
->roff
, origp
->coff
);
722 newp
->cl_private
= subwin(stdscr
, newp
->rows
, newp
->cols
,
723 newp
->roff
, newp
->coff
);
725 /* origp is the original screen, giving up space to newp. */
733 * PUBLIC: int cl_suspend __P((SCR *, int *));
736 cl_suspend(SCR
*sp
, int *allowedp
)
745 win
= CLSP(sp
) ? CLSP(sp
) : stdscr
;
749 * The ex implementation of this function isn't needed by screens not
750 * supporting ex commands that require full terminal canonical mode
753 * The vi implementation of this function isn't needed by screens not
754 * supporting vi process suspension, i.e. any screen that isn't backed
757 * Setting allowedp to 0 will cause the editor to reject the command.
759 if (F_ISSET(sp
, SC_EX
)) {
760 /* Save the terminal settings, and restore the original ones. */
761 if (F_ISSET(clp
, CL_STDIN_TTY
)) {
762 (void)tcgetattr(STDIN_FILENO
, &t
);
763 (void)tcsetattr(STDIN_FILENO
,
764 TCSASOFT
| TCSADRAIN
, &clp
->orig
);
767 /* Stop the process group. */
768 (void)kill(0, SIGTSTP
);
770 /* Time passes ... */
772 /* Restore terminal settings. */
773 if (F_ISSET(clp
, CL_STDIN_TTY
))
774 (void)tcsetattr(STDIN_FILENO
, TCSASOFT
| TCSADRAIN
, &t
);
779 * Move to the lower left-hand corner of the screen.
782 * Not sure this is necessary in System V implementations, but it
786 (void)wmove(win
, LINES
- 1, 0);
790 * Temporarily end the screen. System V introduced a semantic where
791 * endwin() could be restarted. We use it because restarting curses
792 * from scratch often fails in System V. 4BSD curses didn't support
793 * restarting after endwin(), so we have to do what clean up we can
794 * without calling it.
796 /* Save the terminal settings. */
797 (void)tcgetattr(STDIN_FILENO
, &t
);
799 /* Restore the cursor keys to normal mode. */
800 (void)keypad(stdscr
, FALSE
);
802 /* Restore the window name. */
803 (void)cl_rename(sp
, NULL
, 0);
805 #ifdef HAVE_BSD_CURSES
806 (void)cl_attr(sp
, SA_ALTERNATE
, 0);
812 * Restore the original terminal settings. This is bad -- the
813 * reset can cause character loss from the tty queue. However,
814 * we can't call endwin() in BSD curses implementations, and too
815 * many System V curses implementations don't get it right.
817 (void)tcsetattr(STDIN_FILENO
, TCSADRAIN
| TCSASOFT
, &clp
->orig
);
819 /* Stop the process group. */
820 (void)kill(0, SIGTSTP
);
822 /* Time passes ... */
825 * If we received a killer signal, we're done. Leave everything
826 * unchanged. In addition, the terminal has already been reset
827 * correctly, so leave it alone.
829 if (clp
->killersig
) {
830 F_CLR(clp
, CL_SCR_EX_INIT
| CL_SCR_VI_INIT
);
834 /* Restore terminal settings. */
835 wrefresh(win
); /* Needed on SunOs/Solaris ? */
836 if (F_ISSET(clp
, CL_STDIN_TTY
))
837 (void)tcsetattr(STDIN_FILENO
, TCSASOFT
| TCSADRAIN
, &t
);
839 #ifdef HAVE_BSD_CURSES
840 (void)cl_attr(sp
, SA_ALTERNATE
, 1);
843 /* Set the window name. */
844 (void)cl_rename(sp
, sp
->frp
->name
, 1);
846 /* Put the cursor keys into application mode. */
847 (void)keypad(stdscr
, TRUE
);
849 /* Refresh and repaint the screen. */
850 (void)wmove(win
, y
, x
);
851 (void)cl_refresh(sp
, 1);
853 /* If the screen changed size, set the SIGWINCH bit. */
854 if (cl_ssize(sp
, 1, NULL
, NULL
, &changed
))
857 F_SET(CLP(sp
), CL_SIGWINCH
);
864 * Print out the curses usage messages.
866 * PUBLIC: void cl_usage __P((void));
872 usage: ex [-eFRrSsv] [-c command] [-t tag] [-w size] [file ...]\n\
873 usage: vi [-eFlRrSv] [-c command] [-t tag] [-w size] [file ...]\n"
874 (void)fprintf(stderr
, "%s", USAGE
);
881 * Stub routine so can flush out curses screen changes using gdb.
887 return (0); /* XXX Convince gdb to run it. */