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.
10 /* Definition of a vi "word". */
11 #define inword(ch) ((ch) == '_' || (ISGRAPH(ch) && !ISPUNCT(ch)))
13 typedef struct _vikeys VIKEYS
;
15 /* Structure passed around to functions implementing vi commands. */
16 typedef struct _vicmd
{
17 CHAR_T key
; /* Command key. */
18 CHAR_T buffer
; /* Buffer. */
19 CHAR_T character
; /* Character. */
20 u_long count
; /* Count. */
21 u_long count2
; /* Second count (only used by z). */
22 EVENT ev
; /* Associated event. */
24 #define ISCMD(p, key) ((p) == &vikeys[key])
25 VIKEYS
const *kp
; /* Command/Motion VIKEYS entry. */
26 #define ISMOTION(vp) (vp->rkp != NULL && F_ISSET(vp->rkp, V_MOTION))
27 VIKEYS
const *rkp
; /* Related C/M VIKEYS entry. */
30 * Historic vi allowed "dl" when the cursor was on the last column,
31 * deleting the last character, and similarly allowed "dw" when
32 * the cursor was on the last column of the file. It didn't allow
33 * "dh" when the cursor was on column 1, although these cases are
34 * not strictly analogous. The point is that some movements would
35 * succeed if they were associated with a motion command, and fail
36 * otherwise. This is part of the off-by-1 schizophrenia that
37 * plagued vi. Other examples are that "dfb" deleted everything
38 * up to and including the next 'b' character, while "d/b" deleted
39 * everything up to the next 'b' character. While this implementation
40 * regularizes the interface to the extent possible, there are many
41 * special cases that can't be fixed. The special cases are handled
42 * by setting flags per command so that the underlying command and
43 * motion routines know what's really going on.
45 * The VM_* flags are set in the vikeys array and by the underlying
46 * functions (motion component or command) as well. For this reason,
47 * the flags in the VICMD and VIKEYS structures live in the same name
50 #define VM_CMDFAILED 0x00000001 /* Command failed. */
51 #define VM_CUTREQ 0x00000002 /* Always cut into numeric buffers. */
52 #define VM_LDOUBLE 0x00000004 /* Doubled command for line mode. */
53 #define VM_LMODE 0x00000008 /* Motion is line oriented. */
54 #define VM_COMMASK 0x0000000f /* Mask for VM flags. */
57 * The VM_RCM_* flags are single usage, i.e. if you set one, you have
58 * to clear the others.
60 #define VM_RCM 0x00000010 /* Use relative cursor movment (RCM). */
61 #define VM_RCM_SET 0x00000020 /* RCM: set to current position. */
62 #define VM_RCM_SETFNB 0x00000040 /* RCM: set to first non-blank (FNB). */
63 #define VM_RCM_SETLAST 0x00000080 /* RCM: set to last character. */
64 #define VM_RCM_SETNNB 0x00000100 /* RCM: set to next non-blank. */
65 #define VM_RCM_MASK 0x000001f0 /* Mask for RCM flags. */
67 /* Flags for the underlying function. */
68 #define VC_BUFFER 0x00000200 /* The buffer was set. */
69 #define VC_C1RESET 0x00000400 /* Reset C1SET flag for dot commands. */
70 #define VC_C1SET 0x00000800 /* Count 1 was set. */
71 #define VC_C2SET 0x00001000 /* Count 2 was set. */
72 #define VC_ISDOT 0x00002000 /* Command was the dot command. */
76 * There are four cursor locations that we worry about: the initial
77 * cursor position, the start of the range, the end of the range,
78 * and the final cursor position. The initial cursor position and
79 * the start of the range are both m_start, and are always the same.
80 * All locations are initialized to the starting cursor position by
81 * the main vi routines, and the underlying functions depend on this.
83 * Commands that can be motion components set the end of the range
84 * cursor position, m_stop. All commands must set the ending cursor
85 * position, m_final. The reason that m_stop isn't the same as m_final
86 * is that there are situations where the final position of the cursor
87 * is outside of the cut/delete range (e.g. 'd[[' from the first column
88 * of a line). The final cursor position often varies based on the
89 * direction of the movement, as well as the command. The only special
90 * case that the delete code handles is that it will make adjustments
91 * if the final cursor position is deleted.
93 * The reason for all of this is that the historic vi semantics were
94 * defined command-by-command. Every function has to roll its own
95 * starting and stopping positions, and adjust them if it's being used
96 * as a motion component. The general rules are as follows:
98 * 1: If not a motion component, the final cursor is at the end
100 * 2: If moving backward in the file, delete and yank move the
101 * final cursor to the end of the range.
102 * 3: If moving forward in the file, delete and yank leave the
103 * final cursor at the start of the range.
105 * Usually, if moving backward in the file and it's a motion component,
106 * the starting cursor is decremented by a single character (or, in a
107 * few cases, to the end of the previous line) so that the starting
108 * cursor character isn't cut or deleted. No cursor adjustment is
109 * needed for moving forward, because the cut/delete routines handle
110 * m_stop inclusively, i.e. the last character in the range is cut or
111 * deleted. This makes cutting to the EOF/EOL reasonable.
113 * The 'c', '<', '>', and '!' commands are special cases. We ignore
114 * the final cursor position for all of them: for 'c', the text input
115 * routines set the cursor to the last character inserted; for '<',
116 * '>' and '!', the underlying ex commands that do the operation will
117 * set the cursor for us, usually to something related to the first
120 MARK m_start
; /* mark: initial cursor, range start. */
121 MARK m_stop
; /* mark: range end. */
122 MARK m_final
; /* mark: final cursor position. */
125 /* Vi command table structure. */
126 struct _vikeys
{ /* Underlying function. */
127 int (*func
)(SCR
*, VICMD
*);
128 #define V_ABS 0x00004000 /* Absolute movement, set '' mark. */
129 #define V_ABS_C 0x00008000 /* V_ABS: if the line/column changed. */
130 #define V_ABS_L 0x00010000 /* V_ABS: if the line changed. */
131 #define V_CHAR 0x00020000 /* Character (required, trailing). */
132 #define V_CNT 0x00040000 /* Count (optional, leading). */
133 #define V_DOT 0x00080000 /* On success, sets dot command. */
134 #define V_KEYW 0x00100000 /* Cursor referenced word. */
135 #define V_MOTION 0x00200000 /* Motion (required, trailing). */
136 #define V_MOVE 0x00400000 /* Command defines movement. */
137 #define V_OBUF 0x00800000 /* Buffer (optional, leading). */
138 #define V_RBUF 0x01000000 /* Buffer (required, trailing). */
139 #define V_SECURE 0x02000000 /* Permission denied if O_SECURE set. */
141 char *usage
; /* Usage line. */
142 char *help
; /* Help line. */
144 #define MAXVIKEY 126 /* List of vi commands. */
145 extern VIKEYS
const vikeys
[MAXVIKEY
+ 1];
146 extern VIKEYS
const tmotion
; /* XXX Hacked ~ command. */
148 /* Character stream structure, prototypes. */
149 typedef struct _vcs
{
150 recno_t cs_lno
; /* Line. */
151 size_t cs_cno
; /* Column. */
152 CHAR_T
*cs_bp
; /* Buffer. */
153 size_t cs_len
; /* Length. */
154 CHAR_T cs_ch
; /* Character. */
155 #define CS_EMP 1 /* Empty line. */
156 #define CS_EOF 2 /* End-of-file. */
157 #define CS_EOL 3 /* End-of-line. */
158 #define CS_SOF 4 /* Start-of-file. */
159 int cs_flags
; /* Return flags. */
162 int cs_bblank(SCR
*, VCS
*);
163 int cs_fblank(SCR
*, VCS
*);
164 int cs_fspace(SCR
*, VCS
*);
165 int cs_init(SCR
*, VCS
*);
166 int cs_next(SCR
*, VCS
*);
167 int cs_prev(SCR
*, VCS
*);
170 * We use a single "window" for each set of vi screens. The model would be
171 * simpler with two windows (one for the text, and one for the modeline)
172 * because scrolling the text window down would work correctly then, not
173 * affecting the mode line. As it is we have to play games to make it look
174 * right. The reason for this choice is that it would be difficult for
175 * curses to optimize the movement, i.e. detect that the downward scroll
176 * isn't going to change the modeline, set the scrolling region on the
177 * terminal and only scroll the first part of the text window.
179 * Structure for mapping lines to the screen. An SMAP is an array, with one
180 * structure element per screen line, which holds information describing the
181 * physical line which is displayed in the screen line. The first two fields
182 * (lno and off) are all that are necessary to describe a line. The rest of
183 * the information is useful to keep information from being re-calculated.
185 * The SMAP always has an entry for each line of the physical screen, plus a
186 * slot for the colon command line, so there is room to add any screen into
187 * another one at screen exit.
189 * Lno is the line number. If doing the historic vi long line folding, soff
190 * is the screen offset into the line. For example, the pair 2:1 would be
191 * the first screen of line 2, and 2:2 would be the second. In the case of
192 * long lines, the screen map will tend to be staggered, e.g., 1:1, 1:2, 1:3,
193 * 2:1, 3:1, etc. If doing left-right scrolling, the coff field is the screen
194 * column offset into the lines, and can take on any value, as it's adjusted
195 * by the user set value O_SIDESCROLL.
197 typedef struct _smap
{
198 recno_t lno
; /* 1-N: Physical file line number. */
199 size_t coff
; /* 0-N: Column offset in the line. */
200 size_t soff
; /* 1-N: Screen offset in the line. */
202 /* vs_line() cache information. */
203 size_t c_sboff
; /* 0-N: offset of first character on screen. */
204 size_t c_eboff
; /* 0-N: offset of last character on screen. */
205 u_int8_t c_scoff
; /* 0-N: offset into the first character. */
206 /* 255: no character of line visible. */
207 u_int8_t c_eclen
; /* 1-N: columns from the last character. */
208 u_int8_t c_ecsize
; /* 1-N: size of the last character. */
210 /* Macros to flush/test cached information. */
211 #define SMAP_CACHE(smp) ((smp)->c_ecsize != 0)
212 #define SMAP_FLUSH(smp) ((smp)->c_ecsize = 0)
214 /* Character search information. */
215 typedef enum { CNOTSET
, FSEARCH
, fSEARCH
, TSEARCH
, tSEARCH
} cdir_t
;
217 typedef enum { AB_NOTSET
, AB_NOTWORD
, AB_INWORD
} abb_t
;
218 typedef enum { Q_NOTSET
, Q_VNEXT
, Q_VTHIS
} quote_t
;
220 /* Vi private, per-screen memory. */
221 typedef struct _vi_private
{
222 VICMD cmd
; /* Current command, motion. */
227 * The saved command structure can be modified by the underlying
228 * vi functions, see v_Put() and v_put().
230 VICMD sdot
; /* Saved dot, motion command. */
233 CHAR_T
*keyw
; /* Keyword buffer. */
234 size_t klen
; /* Keyword length. */
235 size_t keywlen
; /* Keyword buffer length. */
237 CHAR_T rlast
; /* Last 'r' replacement character. */
238 e_key_t rvalue
; /* Value of last replacement character. */
240 EVENT
*rep
; /* Input replay buffer. */
241 size_t rep_len
; /* Input replay buffer length. */
242 size_t rep_cnt
; /* Input replay buffer characters. */
244 mtype_t mtype
; /* Last displayed message type. */
245 size_t linecount
; /* 1-N: Output overwrite count. */
246 size_t lcontinue
; /* 1-N: Output line continue value. */
247 size_t totalcount
; /* 1-N: Output overwrite count. */
250 int busy_ref
; /* Busy reference count. */
251 int busy_ch
; /* Busy character. */
252 size_t busy_fx
; /* Busy character x coordinate. */
253 size_t busy_oldy
; /* Saved y coordinate. */
254 size_t busy_oldx
; /* Saved x coordinate. */
255 struct timespec busy_ts
;/* Busy timer. */
257 MARK sel
; /* Select start position. */
259 CHAR_T
*mcs
; /* Match character list. */
260 char *ps
; /* Paragraph plus section list. */
262 u_long u_ccnt
; /* Undo command count. */
264 CHAR_T lastckey
; /* Last search character. */
265 cdir_t csearchdir
; /* Character search direction. */
267 SMAP
*h_smap
; /* First slot of the line map. */
268 SMAP
*t_smap
; /* Last slot of the line map. */
271 * One extra slot is always allocated for the map so that we can use
272 * it to do vi :colon command input; see v_tcmd().
274 recno_t sv_tm_lno
; /* tcmd: saved TMAP lno field. */
275 size_t sv_tm_coff
; /* tcmd: saved TMAP coff field. */
276 size_t sv_tm_soff
; /* tcmd: saved TMAP soff field. */
277 size_t sv_t_maxrows
; /* tcmd: saved t_maxrows. */
278 size_t sv_t_minrows
; /* tcmd: saved t_minrows. */
279 size_t sv_t_rows
; /* tcmd: saved t_rows. */
280 #define SIZE_HMAP(sp) (VIP(sp)->srows + 1)
283 * Macros to get to the head/tail of the smap. If the screen only has
284 * one line, HMAP can be equal to TMAP, so the code has to understand
285 * the off-by-one errors that can result. If stepping through an SMAP
286 * and operating on each entry, use sp->t_rows as the count of slots,
287 * don't use a loop that compares <= TMAP.
289 #define _HMAP(sp) (VIP(sp)->h_smap)
290 #define HMAP _HMAP(sp)
291 #define _TMAP(sp) (VIP(sp)->t_smap)
292 #define TMAP _TMAP(sp)
294 recno_t ss_lno
; /* 1-N: vi_opt_screens cached line number. */
295 size_t ss_screens
; /* vi_opt_screens cached return value. */
296 #define VI_SCR_CFLUSH(vip) vip->ss_lno = OOBLNO
298 size_t srows
; /* 1-N: rows in the terminal/window. */
299 recno_t olno
; /* 1-N: old cursor file line. */
300 size_t ocno
; /* 0-N: old file cursor column. */
301 size_t sc_col
; /* 0-N: LOGICAL screen column. */
302 SMAP
*sc_smap
; /* SMAP entry where sc_col occurs. */
304 #define VIP_CUR_INVALID 0x0001 /* Cursor position is unknown. */
305 #define VIP_DIVIDER 0x0002 /* Divider line was displayed. */
306 #define VIP_N_EX_PAINT 0x0004 /* Clear and repaint when ex finishes. */
307 #define VIP_N_EX_REDRAW 0x0008 /* Schedule SC_SCR_REDRAW when ex finishes. */
308 #define VIP_N_REFRESH 0x0010 /* Repaint (from SMAP) on the next refresh. */
309 #define VIP_N_RENUMBER 0x0020 /* Renumber screen on the next refresh. */
310 #define VIP_RCM_LAST 0x0040 /* Cursor drawn to the last column. */
311 #define VIP_S_MODELINE 0x0080 /* Skip next modeline refresh. */
312 #define VIP_S_REFRESH 0x0100 /* Skip next refresh. */
316 /* Vi private area. */
317 #define VIP(sp) ((VI_PRIVATE *)((sp)->vi_private))
319 #define O_NUMBER_FMT "%7lu " /* O_NUMBER format, length. */
320 #define O_NUMBER_LENGTH 8
321 #define SCREEN_COLS(sp) /* Screen columns. */ \
322 ((O_ISSET(sp, O_NUMBER) ? (sp)->cols - O_NUMBER_LENGTH : (sp)->cols))
325 * LASTLINE is the zero-based, last line in the screen. Note that it is correct
326 * regardless of the changes in the screen to permit text input on the last line
327 * of the screen, or the existence of small screens.
329 #define LASTLINE(sp) \
330 ((sp)->t_maxrows < (sp)->rows ? (sp)->t_maxrows : (sp)->rows - 1)
333 * Small screen (see vs_refresh.c, section 6a) and one-line screen test.
334 * Note, both cannot be true for the same screen.
336 #define IS_SMALL(sp) ((sp)->t_minrows != (sp)->t_maxrows)
337 #define IS_ONELINE(sp) ((sp)->rows == 1)
339 #define HALFTEXT(sp) /* Half text. */ \
340 ((sp)->t_rows == 1 ? 1 : (sp)->t_rows / 2)
341 #define HALFSCREEN(sp) /* Half text screen. */ \
342 ((sp)->t_maxrows == 1 ? 1 : (sp)->t_maxrows / 2)
348 * There are problems with how the historical vi handled tabs. For example,
349 * by doing "set ts=3" and building lines that fold, you can get it to step
350 * through tabs as if they were spaces and move inserted characters to new
351 * positions when <esc> is entered. I believe that nvi does tabs correctly,
352 * but there are some historical incompatibilities.
354 #define TAB_OFF(c) COL_OFF((c), O_VAL(sp, O_TABSTOP))
356 /* If more than one horizontal screen being shown. */
357 #define IS_HSPLIT(sp) \
358 ((sp)->rows != O_VAL(sp, O_LINES))
359 /* If more than one vertical screen being shown. */
360 #define IS_VSPLIT(sp) \
361 ((sp)->cols != O_VAL(sp, O_COLUMNS))
362 /* If more than one screen being shown. */
363 #define IS_SPLIT(sp) \
364 (IS_HSPLIT(sp) || IS_VSPLIT(sp))
366 /* Screen adjustment operations. */
367 typedef enum { A_DECREASE
, A_INCREASE
, A_SET
} adj_t
;
369 /* Screen position operations. */
370 typedef enum { P_BOTTOM
, P_FILL
, P_MIDDLE
, P_TOP
} pos_t
;
372 /* Scrolling operations. */
374 CNTRL_B
, CNTRL_D
, CNTRL_E
, CNTRL_F
,
375 CNTRL_U
, CNTRL_Y
, Z_CARAT
, Z_PLUS
378 /* Vi common error messages. */
380 VIM_COMBUF
, VIM_EMPTY
, VIM_EOF
, VIM_EOL
,
381 VIM_NOCOM
, VIM_NOCOM_B
, VIM_USAGE
, VIM_WRESIZE
384 #include "vi_extern.h"