2 * Copyright (c) 1992, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1992, 1993, 1994, 1995, 1996
5 * Keith Bostic. All rights reserved.
7 * See the LICENSE file for redistribution information.
13 static const char sccsid[] = "$Id: vs_refresh.c,v 10.52 2011/12/16 11:06:25 zy Exp $";
16 #include <sys/types.h>
17 #include <sys/queue.h>
20 #include <bitstring.h>
27 #include "../common/common.h"
30 #define UPDATE_CURSOR 0x01 /* Update the cursor. */
31 #define UPDATE_SCREEN 0x02 /* Flush to screen. */
33 static void vs_modeline __P((SCR *));
34 static int vs_paint __P((SCR *, u_int));
38 * Repaint selected lines from the screen.
40 * PUBLIC: int vs_repaint __P((SCR *, EVENT *));
49 for (; evp->e_flno <= evp->e_tlno; ++evp->e_flno) {
50 smp = HMAP + evp->e_flno - 1;
52 if (vs_line(sp, smp, NULL, NULL))
60 * Refresh all screens.
62 * PUBLIC: int vs_refresh __P((SCR *, int));
72 u_int priv_paint, pub_paint;
77 * 1: Refresh the screen.
79 * If SC_SCR_REDRAW is set in the current screen, repaint everything
80 * that we can find, including status lines.
82 if (F_ISSET(sp, SC_SCR_REDRAW))
83 TAILQ_FOREACH(tsp, gp->dq, q)
85 F_SET(tsp, SC_SCR_REDRAW | SC_STATUS);
88 * 2: Related or dirtied screens, or screens with messages.
90 * If related screens share a view into a file, they may have been
91 * modified as well. Refresh any screens that aren't exiting that
92 * have paint or dirty bits set. Always update their screens, we
93 * are not likely to get another chance. Finally, if we refresh any
94 * screens other than the current one, the cursor will be trashed.
96 pub_paint = SC_SCR_REFORMAT | SC_SCR_REDRAW;
97 priv_paint = VIP_CUR_INVALID | VIP_N_REFRESH;
98 if (O_ISSET(sp, O_NUMBER))
99 priv_paint |= VIP_N_RENUMBER;
100 TAILQ_FOREACH(tsp, gp->dq, q)
101 if (tsp != sp && !F_ISSET(tsp, SC_EXIT | SC_EXIT_FORCE) &&
102 (F_ISSET(tsp, pub_paint) ||
103 F_ISSET(VIP(tsp), priv_paint))) {
105 (F_ISSET(VIP(tsp), VIP_CUR_INVALID) ?
106 UPDATE_CURSOR : 0) | UPDATE_SCREEN);
107 F_SET(VIP(sp), VIP_CUR_INVALID);
111 * 3: Refresh the current screen.
113 * Always refresh the current screen, it may be a cursor movement.
114 * Also, always do it last -- that way, SC_SCR_REDRAW can be set
115 * in the current screen only, and the screen won't flash.
117 if (vs_paint(sp, UPDATE_CURSOR | (!forcepaint &&
118 F_ISSET(sp, SC_SCR_VI) && KEYS_WAITING(sp) ? 0 : UPDATE_SCREEN)))
122 * 4: Paint any missing status lines.
125 * This is fairly evil. Status lines are written using the vi message
126 * mechanism, since we have no idea how long they are. Since we may be
127 * painting screens other than the current one, we don't want to make
128 * the user wait. We depend heavily on there not being any other lines
129 * currently waiting to be displayed and the message truncation code in
130 * the msgq_status routine working.
132 * And, finally, if we updated any status lines, make sure the cursor
133 * gets back to where it belongs.
135 TAILQ_FOREACH(tsp, gp->dq, q)
136 if (F_ISSET(tsp, SC_STATUS)) {
138 vs_resolve(tsp, sp, 0);
141 (void)gp->scr_refresh(sp, 0);
144 * A side-effect of refreshing the screen is that it's now ready
145 * for everything else, i.e. messages.
147 F_SET(sp, SC_SCR_VI);
153 * This is the guts of the vi curses screen code. The idea is that
154 * the SCR structure passed in contains the new coordinates of the
155 * screen. What makes this hard is that we don't know how big
156 * characters are, doing input can put the cursor in illegal places,
157 * and we're frantically trying to avoid repainting unless it's
158 * absolutely necessary. If you change this code, you'd better know
159 * what you're doing. It's subtle and quick to anger.
169 recno_t lastline, lcnt;
170 size_t cwtotal, cnt, len, notused, off, y;
171 int ch = 0, didpaint, isempty, leftright_warp;
174 #define LNO sp->lno /* Current file line. */
175 #define OLNO vip->olno /* Remembered file line. */
176 #define CNO sp->cno /* Current file column. */
177 #define OCNO vip->ocno /* Remembered file column. */
178 #define SCNO vip->sc_col /* Current screen column. */
182 didpaint = leftright_warp = 0;
185 * 5: Reformat the lines.
187 * If the lines themselves have changed (:set list, for example),
188 * fill in the map from scratch. Adjust the screen that's being
189 * displayed if the leftright flag is set.
191 if (F_ISSET(sp, SC_SCR_REFORMAT)) {
192 /* Invalidate the line size cache. */
195 /* Toss vs_line() cached information. */
196 if (F_ISSET(sp, SC_SCR_TOP)) {
197 if (vs_sm_fill(sp, LNO, P_TOP))
200 else if (F_ISSET(sp, SC_SCR_CENTER)) {
201 if (vs_sm_fill(sp, LNO, P_MIDDLE))
204 if (vs_sm_fill(sp, OOBLNO, P_TOP))
206 F_SET(sp, SC_SCR_REDRAW);
212 * Line changes can cause the top line to change as well. As
213 * before, if the movement is large, the screen is repainted.
217 * Users can use the window, w300, w1200 and w9600 options to make
218 * the screen artificially small. The behavior of these options
219 * in the historic vi wasn't all that consistent, and, in fact, it
220 * was never documented how various screen movements affected the
221 * screen size. Generally, one of three things would happen:
222 * 1: The screen would expand in size, showing the line
223 * 2: The screen would scroll, showing the line
224 * 3: The screen would compress to its smallest size and
226 * In general, scrolling didn't cause compression (200^D was handled
227 * the same as ^D), movement to a specific line would (:N where N
228 * was 1 line below the screen caused a screen compress), and cursor
229 * movement would scroll if it was 11 lines or less, and compress if
230 * it was more than 11 lines. (And, no, I have no idea where the 11
233 * What we do is try and figure out if the line is less than half of
234 * a full screen away. If it is, we expand the screen if there's
235 * room, and then scroll as necessary. The alternative is to compress
239 * This code is a special case from beginning to end. Unfortunately,
240 * home modems are still slow enough that it's worth having.
243 * If the line a really long one, i.e. part of the line is on the
244 * screen but the column offset is not, we'll end up in the adjust
245 * code, when we should probably have compressed the screen.
248 if (LNO < HMAP->lno) {
249 lcnt = vs_sm_nlines(sp, HMAP, LNO, sp->t_maxrows);
250 if (lcnt <= HALFSCREEN(sp))
251 for (; lcnt && sp->t_rows != sp->t_maxrows;
252 --lcnt, ++sp->t_rows) {
259 } else if (LNO > TMAP->lno) {
260 lcnt = vs_sm_nlines(sp, TMAP, LNO, sp->t_maxrows);
261 if (lcnt <= HALFSCREEN(sp))
262 for (; lcnt && sp->t_rows != sp->t_maxrows;
263 --lcnt, ++sp->t_rows) {
264 if (vs_sm_next(sp, TMAP, TMAP + 1))
267 if (vs_line(sp, TMAP, NULL, NULL))
271 small_fill: (void)gp->scr_move(sp, LASTLINE(sp), 0);
272 (void)gp->scr_clrtoeol(sp);
273 for (; sp->t_rows > sp->t_minrows;
274 --sp->t_rows, --TMAP) {
275 (void)gp->scr_move(sp, TMAP - HMAP, 0);
276 (void)gp->scr_clrtoeol(sp);
278 if (vs_sm_fill(sp, LNO, P_FILL))
280 F_SET(sp, SC_SCR_REDRAW);
286 * 6b: Line down, or current screen.
288 if (LNO >= HMAP->lno) {
289 /* Current screen. */
290 if (LNO <= TMAP->lno)
292 if (F_ISSET(sp, SC_SCR_TOP))
294 if (F_ISSET(sp, SC_SCR_CENTER))
298 * If less than half a screen above the line, scroll down
299 * until the line is on the screen.
301 lcnt = vs_sm_nlines(sp, TMAP, LNO, HALFTEXT(sp));
302 if (lcnt < HALFTEXT(sp)) {
312 * 6c: If not on the current screen, may request center or top.
314 if (F_ISSET(sp, SC_SCR_TOP))
316 if (F_ISSET(sp, SC_SCR_CENTER))
322 lcnt = vs_sm_nlines(sp, HMAP, LNO, HALFTEXT(sp));
323 if (lcnt < HALFTEXT(sp)) {
325 * If less than half a screen below the line, scroll up until
326 * the line is the first line on the screen. Special check so
327 * that if the screen has been emptied, we refill it.
329 if (db_exist(sp, HMAP->lno)) {
337 * If less than a half screen from the bottom of the file,
338 * put the last line of the file on the bottom of the screen.
340 bottom: if (db_last(sp, &lastline))
343 tmp.coff = HMAP->coff;
345 lcnt = vs_sm_nlines(sp, &tmp, lastline, sp->t_rows);
346 if (lcnt < HALFTEXT(sp)) {
347 if (vs_sm_fill(sp, lastline, P_BOTTOM))
349 F_SET(sp, SC_SCR_REDRAW);
352 /* It's not close, just put the line in the middle. */
357 * If less than half a screen from the top of the file, put the first
358 * line of the file at the top of the screen. Otherwise, put the line
359 * in the middle of the screen.
362 tmp.coff = HMAP->coff;
364 lcnt = vs_sm_nlines(sp, &tmp, LNO, HALFTEXT(sp));
365 if (lcnt < HALFTEXT(sp)) {
366 if (vs_sm_fill(sp, 1, P_TOP))
369 middle: if (vs_sm_fill(sp, LNO, P_MIDDLE))
372 top: if (vs_sm_fill(sp, LNO, P_TOP))
375 F_SET(sp, SC_SCR_REDRAW);
378 * At this point we know part of the line is on the screen. Since
379 * scrolling is done using logical lines, not physical, all of the
380 * line may not be on the screen. While that's not necessarily bad,
381 * if the part the cursor is on isn't there, we're going to lose.
382 * This can be tricky; if the line covers the entire screen, lno
383 * may be the same as both ends of the map, that's why we test BOTH
384 * the top and the bottom of the map. This isn't a problem for
385 * left-right scrolling, the cursor movement code handles the problem.
387 * There's a performance issue here if editing *really* long lines.
388 * This gets to the right spot by scrolling, and, in a binary, by
389 * scrolling hundreds of lines. If the adjustment looks like it's
390 * going to be a serious problem, refill the screen and repaint.
392 adjust: if (!O_ISSET(sp, O_LEFTRIGHT) &&
393 (LNO == HMAP->lno || LNO == TMAP->lno)) {
394 cnt = vs_screens(sp, LNO, &CNO);
395 if (LNO == HMAP->lno && cnt < HMAP->soff)
396 if ((HMAP->soff - cnt) > HALFTEXT(sp)) {
398 vs_sm_fill(sp, OOBLNO, P_TOP);
399 F_SET(sp, SC_SCR_REDRAW);
401 while (cnt < HMAP->soff)
404 if (LNO == TMAP->lno && cnt > TMAP->soff)
405 if ((cnt - TMAP->soff) > HALFTEXT(sp)) {
407 vs_sm_fill(sp, OOBLNO, P_BOTTOM);
408 F_SET(sp, SC_SCR_REDRAW);
410 while (cnt > TMAP->soff)
416 * If the screen needs to be repainted, skip cursor optimization.
417 * However, in the code above we skipped leftright scrolling on
418 * the grounds that the cursor code would handle it. Make sure
419 * the right screen is up.
421 if (F_ISSET(sp, SC_SCR_REDRAW)) {
422 if (O_ISSET(sp, O_LEFTRIGHT))
428 * 7: Cursor movements (current screen only).
430 if (!LF_ISSET(UPDATE_CURSOR))
434 * Decide cursor position. If the line has changed, the cursor has
435 * moved over a tab, or don't know where the cursor was, reparse the
436 * line. Otherwise, we've just moved over fixed-width characters,
437 * and can calculate the left/right scrolling and cursor movement
438 * without reparsing the line. Note that we don't know which (if any)
439 * of the characters between the old and new cursor positions changed.
442 * With some work, it should be possible to handle tabs quickly, at
443 * least in obvious situations, like moving right and encountering
444 * a tab, without reparsing the whole line.
446 * If the line we're working with has changed, reread it..
448 if (F_ISSET(vip, VIP_CUR_INVALID) || LNO != OLNO)
451 /* Otherwise, if nothing's changed, ignore the cursor. */
456 * Get the current line. If this fails, we either have an empty
457 * file and can just repaint, or there's a real problem. This
458 * isn't a performance issue because there aren't any ways to get
461 if (db_eget(sp, LNO, &p, &len, &isempty)) {
468 /* Sanity checking. */
469 if (CNO >= len && len != 0) {
470 msgq(sp, M_ERR, "Error: %s/%d: cno (%zu) >= len (%zu)",
471 tail(__FILE__), __LINE__, CNO, len);
476 * The basic scheme here is to look at the characters in between
477 * the old and new positions and decide how big they are on the
478 * screen, and therefore, how many screen positions to move.
482 * 7a: Cursor moved left.
484 * Point to the old character. The old cursor position can
485 * be past EOL if, for example, we just deleted the rest of
486 * the line. In this case, since we don't know the width of
487 * the characters we traversed, we have to do it slowly.
490 cnt = (OCNO - CNO) + 1;
495 * Quick sanity check -- it's hard to figure out exactly when
496 * we cross a screen boundary as we do in the cursor right
497 * movement. If cnt is so large that we're going to cross the
498 * boundary no matter what, stop now.
500 if (SCNO + 1 + MAX_CHARACTER_COLUMNS < cnt)
504 * Count up the widths of the characters. If it's a tab
505 * character, go do it the the slow way.
507 for (cwtotal = 0; cnt--; cwtotal += KEY_COL(sp, ch))
508 if ((ch = *(UCHAR_T *)p--) == '\t')
512 * Decrement the screen cursor by the total width of the
513 * characters minus 1.
518 * If we're moving left, and there's a wide character in the
519 * current position, go to the end of the character.
521 if (KEY_COL(sp, ch) > 1)
522 cwtotal -= KEY_COL(sp, ch) - 1;
525 * If the new column moved us off of the current logical line,
526 * calculate a new one. If doing leftright scrolling, we've
527 * moved off of the current screen, as well.
534 * 7b: Cursor moved right.
536 * Point to the first character to the right.
542 * Count up the widths of the characters. If it's a tab
543 * character, go do it the the slow way. If we cross a
544 * screen boundary, we can quit.
546 for (cwtotal = SCNO; cnt--;) {
547 if ((ch = *(UCHAR_T *)p++) == '\t')
549 if ((cwtotal += KEY_COL(sp, ch)) >= SCREEN_COLS(sp))
554 * Increment the screen cursor by the total width of the
559 /* See screen change comment in section 6a. */
560 if (SCNO >= SCREEN_COLS(sp))
565 * 7c: Fast cursor update.
567 * We have the current column, retrieve the current row.
569 fast: (void)gp->scr_cursor(sp, &y, ¬used);
573 * 7d: Slow cursor update.
575 * Walk through the map and find the current line.
577 slow: for (smp = HMAP; smp->lno != LNO; ++smp);
580 * 7e: Leftright scrolling adjustment.
582 * If doing left-right scrolling and the cursor movement has changed
583 * the displayed screen, scroll the screen left or right, unless we're
584 * updating the info line in which case we just scroll that one line.
585 * We adjust the offset up or down until we have a window that covers
586 * the current column, making sure that we adjust differently for the
587 * first screen as compared to subsequent ones.
589 if (O_ISSET(sp, O_LEFTRIGHT)) {
591 * Get the screen column for this character, and correct
592 * for the number option offset.
594 cnt = vs_columns(sp, NULL, LNO, &CNO, NULL);
595 if (O_ISSET(sp, O_NUMBER) && cnt >= O_NUMBER_LENGTH)
596 cnt -= O_NUMBER_LENGTH;
598 /* Adjust the window towards the beginning of the line. */
602 if (off >= O_VAL(sp, O_SIDESCROLL))
603 off -= O_VAL(sp, O_SIDESCROLL);
608 } while (off >= cnt);
612 /* Adjust the window towards the end of the line. */
613 if ((off == 0 && off + SCREEN_COLS(sp) < cnt) ||
614 (off != 0 && off + sp->cols < cnt)) {
616 off += O_VAL(sp, O_SIDESCROLL);
617 } while (off + sp->cols < cnt);
619 shifted: /* Fill in screen map with the new offset. */
620 if (F_ISSET(sp, SC_TINPUT_INFO))
623 for (smp = HMAP; smp <= TMAP; ++smp)
631 * We may have jumped here to adjust a leftright screen because
632 * redraw was set. If so, we have to paint the entire screen.
634 if (F_ISSET(sp, SC_SCR_REDRAW))
639 * Update the screen lines for this particular file line until we
640 * have a new screen cursor position.
643 vip->sc_smap = NULL; smp <= TMAP && smp->lno == LNO; ++smp) {
644 if (vs_line(sp, smp, &y, &SCNO))
654 * 8: Repaint the entire screen.
656 * Lost big, do what you have to do. We flush the cache, since
657 * SC_SCR_REDRAW gets set when the screen isn't worth fixing, and
658 * it's simpler to repaint. So, don't trust anything that we
659 * think we know about it.
661 paint: for (smp = HMAP; smp <= TMAP; ++smp)
663 for (y = -1, vip->sc_smap = NULL, smp = HMAP; smp <= TMAP; ++smp) {
664 if (vs_line(sp, smp, &y, &SCNO))
666 if (y != -1 && vip->sc_smap == NULL)
670 * If it's a small screen and we're redrawing, clear the unused lines,
671 * ex may have overwritten them.
673 if (F_ISSET(sp, SC_SCR_REDRAW) && IS_SMALL(sp))
674 for (cnt = sp->t_rows; cnt <= sp->t_maxrows; ++cnt) {
675 (void)gp->scr_move(sp, cnt, 0);
676 (void)gp->scr_clrtoeol(sp);
683 * Sanity checking. When the repainting code messes up, the usual
684 * result is we don't repaint the cursor and so sc_smap will be
685 * NULL. If we're debugging, die, otherwise restart from scratch.
688 if (vip->sc_smap == NULL)
691 if (vip->sc_smap == NULL) {
692 F_SET(sp, SC_SCR_REFORMAT);
693 return (vs_paint(sp, flags));
698 * 9: Set the remembered cursor values.
704 * 10: Repaint the line numbers.
706 * If O_NUMBER is set and the VIP_N_RENUMBER bit is set, and we
707 * didn't repaint the screen, repaint all of the line numbers,
710 number: if (O_ISSET(sp, O_NUMBER) &&
711 F_ISSET(vip, VIP_N_RENUMBER) && !didpaint && vs_number(sp))
715 * 11: Update the mode line, position the cursor, and flush changes.
717 * If we warped the screen, we have to refresh everything.
720 LF_SET(UPDATE_CURSOR | UPDATE_SCREEN);
722 if (LF_ISSET(UPDATE_SCREEN) && !IS_ONELINE(sp) &&
723 !F_ISSET(vip, VIP_S_MODELINE) && !F_ISSET(sp, SC_TINPUT_INFO))
726 if (LF_ISSET(UPDATE_CURSOR)) {
727 (void)gp->scr_move(sp, y, SCNO);
731 * If the screen shifted, we recalculate the "most favorite"
732 * cursor position. Vi won't know that we've warped the
733 * screen, so it's going to have a wrong idea about where the
734 * cursor should be. This is vi's problem, and fixing it here
735 * is a gross layering violation.
738 (void)vs_column(sp, &sp->rcm);
741 if (LF_ISSET(UPDATE_SCREEN))
742 (void)gp->scr_refresh(sp, F_ISSET(vip, VIP_N_EX_PAINT));
744 /* 12: Clear the flags that are handled by this routine. */
745 F_CLR(sp, SC_SCR_CENTER | SC_SCR_REDRAW | SC_SCR_REFORMAT | SC_SCR_TOP);
746 F_CLR(vip, VIP_CUR_INVALID |
747 VIP_N_EX_PAINT | VIP_N_REFRESH | VIP_N_RENUMBER | VIP_S_MODELINE);
760 * Update the mode line.
765 static char * const modes[] = {
766 "215|Append", /* SM_APPEND */
767 "216|Change", /* SM_CHANGE */
768 "217|Command", /* SM_COMMAND */
769 "218|Insert", /* SM_INSERT */
770 "219|Replace", /* SM_REPLACE */
773 size_t cols, curcol, curlen, endpoint, len, midpoint;
774 const char *t = NULL;
781 * We put down the file name, the ruler, the mode and the dirty flag.
782 * If there's not enough room, there's not enough room, we don't play
783 * any special games. We try to put the ruler in the middle and the
784 * mode and dirty flag at the end.
787 * Leave the last character blank, in case it's a really dumb terminal
788 * with hardware scroll. Second, don't paint the last character in the
789 * screen, SunOS 4.1.1 and Ultrix 4.2 curses won't let you.
791 * Move to the last line on the screen.
793 (void)gp->scr_move(sp, LASTLINE(sp), 0);
795 /* If more than one screen in the display, show the file name. */
801 CHAR2INT(sp, sp->frp->name, strlen(sp->frp->name) + 1, wp, l);
803 for (ellipsis = 0, cols = sp->cols / 2; --p > wp;) {
808 if ((curlen += KEY_COL(sp, *p)) > cols) {
811 KEY_LEN(sp, '.') * 3 + KEY_LEN(sp, ' ');
812 while (curlen > cols) {
814 curlen -= KEY_COL(sp, *p);
821 (void)gp->scr_addstr(sp,
822 KEY_NAME(sp, '.'), KEY_LEN(sp, '.'));
823 (void)gp->scr_addstr(sp,
824 KEY_NAME(sp, ' '), KEY_LEN(sp, ' '));
826 for (; *p != '\0'; ++p)
827 (void)gp->scr_addstr(sp,
828 KEY_NAME(sp, *p), KEY_COL(sp, *p));
831 /* Clear the rest of the line. */
832 (void)gp->scr_clrtoeol(sp);
835 * Display the ruler. If we're not at the midpoint yet, move there.
836 * Otherwise, add in two extra spaces.
838 * Adjust the current column for the fact that the editor uses it as
839 * a zero-based number.
842 * Assume that numbers, commas, and spaces only take up a single
843 * column on the screen.
846 if (O_ISSET(sp, O_RULER)) {
847 vs_column(sp, &curcol);
848 len = snprintf(buf, sizeof(buf), "%lu,%lu",
849 (u_long)sp->lno, (u_long)(curcol + 1));
851 midpoint = (cols - ((len + 1) / 2)) / 2;
852 if (curlen < midpoint) {
853 (void)gp->scr_move(sp, LASTLINE(sp), midpoint);
855 } else if (curlen + 2 + len < cols) {
856 (void)gp->scr_addstr(sp, " ", 2);
859 (void)gp->scr_addstr(sp, buf, len);
863 * Display the mode and the modified flag, as close to the end of the
864 * line as possible, but guaranteeing at least two spaces between the
865 * ruler and the modified flag.
869 if (O_ISSET(sp, O_SHOWMODE)) {
870 if (F_ISSET(sp->ep, F_MODIFIED))
872 t = msg_cat(sp, modes[sp->showmode], &len);
876 if (endpoint > curlen + 2) {
877 (void)gp->scr_move(sp, LASTLINE(sp), endpoint);
878 if (O_ISSET(sp, O_SHOWMODE)) {
879 if (F_ISSET(sp->ep, F_MODIFIED))
880 (void)gp->scr_addstr(sp,
881 KEY_NAME(sp, '*'), KEY_LEN(sp, '*'));
882 (void)gp->scr_addstr(sp, t, len);