1 /* $OpenBSD: vi.h,v 1.12 2022/12/26 19:16:04 jmc Exp $ */ 2 3 /*- 4 * Copyright (c) 1992, 1993, 1994 5 * The Regents of the University of California. All rights reserved. 6 * Copyright (c) 1992, 1993, 1994, 1995, 1996 7 * Keith Bostic. All rights reserved. 8 * 9 * See the LICENSE file for redistribution information. 10 * 11 * @(#)vi.h 10.19 (Berkeley) 6/30/96 12 */ 13 14 /* Definition of a vi "word". */ 15 #define inword(ch) (isalnum(ch) || (ch) == '_') 16 17 typedef struct _vikeys VIKEYS; 18 19 /* Structure passed around to functions implementing vi commands. */ 20 typedef struct _vicmd { 21 CHAR_T key; /* Command key. */ 22 CHAR_T buffer; /* Buffer. */ 23 CHAR_T character; /* Character. */ 24 u_long count; /* Count. */ 25 u_long count2; /* Second count (only used by z). */ 26 EVENT ev; /* Associated event. */ 27 28 #define ISCMD(p, key) ((p) == &vikeys[(key)]) 29 VIKEYS const *kp; /* Command/Motion VIKEYS entry. */ 30 #define ISMOTION(vp) ((vp)->rkp != NULL && F_ISSET((vp)->rkp, V_MOTION)) 31 VIKEYS const *rkp; /* Related C/M VIKEYS entry. */ 32 33 /* 34 * Historic vi allowed "dl" when the cursor was on the last column, 35 * deleting the last character, and similarly allowed "dw" when 36 * the cursor was on the last column of the file. It didn't allow 37 * "dh" when the cursor was on column 1, although these cases are 38 * not strictly analogous. The point is that some movements would 39 * succeed if they were associated with a motion command, and fail 40 * otherwise. This is part of the off-by-1 schizophrenia that 41 * plagued vi. Other examples are that "dfb" deleted everything 42 * up to and including the next 'b' character, while "d/b" deleted 43 * everything up to the next 'b' character. While this implementation 44 * regularizes the interface to the extent possible, there are many 45 * special cases that can't be fixed. The special cases are handled 46 * by setting flags per command so that the underlying command and 47 * motion routines know what's really going on. 48 * 49 * The VM_* flags are set in the vikeys array and by the underlying 50 * functions (motion component or command) as well. For this reason, 51 * the flags in the VICMD and VIKEYS structures live in the same name 52 * space. 53 */ 54 #define VM_CMDFAILED 0x00000001 /* Command failed. */ 55 #define VM_CUTREQ 0x00000002 /* Always cut into numeric buffers. */ 56 #define VM_LDOUBLE 0x00000004 /* Doubled command for line mode. */ 57 #define VM_LMODE 0x00000008 /* Motion is line oriented. */ 58 #define VM_COMMASK 0x0000000f /* Mask for VM flags. */ 59 60 /* 61 * The VM_RCM_* flags are single usage, i.e. if you set one, you have 62 * to clear the others. 63 */ 64 #define VM_RCM 0x00000010 /* Use relative cursor movement (RCM). */ 65 #define VM_RCM_SET 0x00000020 /* RCM: set to current position. */ 66 #define VM_RCM_SETFNB 0x00000040 /* RCM: set to first non-blank (FNB). */ 67 #define VM_RCM_SETLAST 0x00000080 /* RCM: set to last character. */ 68 #define VM_RCM_SETNNB 0x00000100 /* RCM: set to next non-blank. */ 69 #define VM_RCM_MASK 0x000001f0 /* Mask for RCM flags. */ 70 71 /* Flags for the underlying function. */ 72 #define VC_BUFFER 0x00000200 /* The buffer was set. */ 73 #define VC_C1RESET 0x00000400 /* Reset C1SET flag for dot commands. */ 74 #define VC_C1SET 0x00000800 /* Count 1 was set. */ 75 #define VC_C2SET 0x00001000 /* Count 2 was set. */ 76 #define VC_ISDOT 0x00002000 /* Command was the dot command. */ 77 u_int32_t flags; 78 79 /* 80 * There are four cursor locations that we worry about: the initial 81 * cursor position, the start of the range, the end of the range, 82 * and the final cursor position. The initial cursor position and 83 * the start of the range are both m_start, and are always the same. 84 * All locations are initialized to the starting cursor position by 85 * the main vi routines, and the underlying functions depend on this. 86 * 87 * Commands that can be motion components set the end of the range 88 * cursor position, m_stop. All commands must set the ending cursor 89 * position, m_final. The reason that m_stop isn't the same as m_final 90 * is that there are situations where the final position of the cursor 91 * is outside of the cut/delete range (e.g. 'd[[' from the first column 92 * of a line). The final cursor position often varies based on the 93 * direction of the movement, as well as the command. The only special 94 * case that the delete code handles is that it will make adjustments 95 * if the final cursor position is deleted. 96 * 97 * The reason for all of this is that the historic vi semantics were 98 * defined command-by-command. Every function has to roll its own 99 * starting and stopping positions, and adjust them if it's being used 100 * as a motion component. The general rules are as follows: 101 * 102 * 1: If not a motion component, the final cursor is at the end 103 * of the range. 104 * 2: If moving backward in the file, delete and yank move the 105 * final cursor to the end of the range. 106 * 3: If moving forward in the file, delete and yank leave the 107 * final cursor at the start of the range. 108 * 109 * Usually, if moving backward in the file and it's a motion component, 110 * the starting cursor is decremented by a single character (or, in a 111 * few cases, to the end of the previous line) so that the starting 112 * cursor character isn't cut or deleted. No cursor adjustment is 113 * needed for moving forward, because the cut/delete routines handle 114 * m_stop inclusively, i.e. the last character in the range is cut or 115 * deleted. This makes cutting to the EOF/EOL reasonable. 116 * 117 * The 'c', '<', '>', and '!' commands are special cases. We ignore 118 * the final cursor position for all of them: for 'c', the text input 119 * routines set the cursor to the last character inserted; for '<', 120 * '>' and '!', the underlying ex commands that do the operation will 121 * set the cursor for us, usually to something related to the first 122 * <nonblank>. 123 */ 124 MARK m_start; /* mark: initial cursor, range start. */ 125 MARK m_stop; /* mark: range end. */ 126 MARK m_final; /* mark: final cursor position. */ 127 } VICMD; 128 129 /* Vi command table structure. */ 130 struct _vikeys { /* Underlying function. */ 131 int (*func)(SCR *, VICMD *); 132 #define V_ABS 0x00004000 /* Absolute movement, set '' mark. */ 133 #define V_ABS_C 0x00008000 /* V_ABS: if the line/column changed. */ 134 #define V_ABS_L 0x00010000 /* V_ABS: if the line changed. */ 135 #define V_CHAR 0x00020000 /* Character (required, trailing). */ 136 #define V_CNT 0x00040000 /* Count (optional, leading). */ 137 #define V_DOT 0x00080000 /* On success, sets dot command. */ 138 #define V_KEYW 0x00100000 /* Cursor referenced word. */ 139 #define V_MOTION 0x00200000 /* Motion (required, trailing). */ 140 #define V_MOVE 0x00400000 /* Command defines movement. */ 141 #define V_OBUF 0x00800000 /* Buffer (optional, leading). */ 142 #define V_RBUF 0x01000000 /* Buffer (required, trailing). */ 143 #define V_SECURE 0x02000000 /* Permission denied if O_SECURE set. */ 144 u_int32_t flags; 145 char *usage; /* Usage line. */ 146 char *help; /* Help line. */ 147 }; 148 #define MAXVIKEY 126 /* List of vi commands. */ 149 extern VIKEYS const vikeys[MAXVIKEY + 1]; 150 extern VIKEYS const tmotion; /* XXX Hacked ~ command. */ 151 152 /* Character stream structure, prototypes. */ 153 typedef struct _vcs { 154 recno_t cs_lno; /* Line. */ 155 size_t cs_cno; /* Column. */ 156 CHAR_T *cs_bp; /* Buffer. */ 157 size_t cs_len; /* Length. */ 158 CHAR_T cs_ch; /* Character. */ 159 #define CS_EMP 1 /* Empty line. */ 160 #define CS_EOF 2 /* End-of-file. */ 161 #define CS_EOL 3 /* End-of-line. */ 162 #define CS_SOF 4 /* Start-of-file. */ 163 int cs_flags; /* Return flags. */ 164 } VCS; 165 166 int cs_bblank(SCR *, VCS *); 167 int cs_fblank(SCR *, VCS *); 168 int cs_fspace(SCR *, VCS *); 169 int cs_init(SCR *, VCS *); 170 int cs_next(SCR *, VCS *); 171 int cs_prev(SCR *, VCS *); 172 173 /* 174 * We use a single "window" for each set of vi screens. The model would be 175 * simpler with two windows (one for the text, and one for the modeline) 176 * because scrolling the text window down would work correctly then, not 177 * affecting the mode line. As it is we have to play games to make it look 178 * right. The reason for this choice is that it would be difficult for 179 * curses to optimize the movement, i.e. detect that the downward scroll 180 * isn't going to change the modeline, set the scrolling region on the 181 * terminal and only scroll the first part of the text window. 182 * 183 * Structure for mapping lines to the screen. An SMAP is an array, with one 184 * structure element per screen line, which holds information describing the 185 * physical line which is displayed in the screen line. The first two fields 186 * (lno and off) are all that are necessary to describe a line. The rest of 187 * the information is useful to keep information from being re-calculated. 188 * 189 * The SMAP always has an entry for each line of the physical screen, plus a 190 * slot for the colon command line, so there is room to add any screen into 191 * another one at screen exit. 192 * 193 * Lno is the line number. If doing the historic vi long line folding, off 194 * is the screen offset into the line. For example, the pair 2:1 would be 195 * the first screen of line 2, and 2:2 would be the second. In the case of 196 * long lines, the screen map will tend to be staggered, e.g., 1:1, 1:2, 1:3, 197 * 2:1, 3:1, etc. If doing left-right scrolling, the off field is the screen 198 * column offset into the lines, and can take on any value, as it's adjusted 199 * by the user set value O_SIDESCROLL. 200 */ 201 typedef struct _smap { 202 recno_t lno; /* 1-N: Physical file line number. */ 203 size_t coff; /* 0-N: Column offset in the line. */ 204 size_t soff; /* 1-N: Screen offset in the line. */ 205 206 /* vs_line() cache information. */ 207 size_t c_sboff; /* 0-N: offset of first character byte. */ 208 size_t c_eboff; /* 0-N: offset of last character byte. */ 209 u_int8_t c_scoff; /* 0-N: offset into the first character. */ 210 u_int8_t c_eclen; /* 1-N: columns from the last character. */ 211 u_int8_t c_ecsize; /* 1-N: size of the last character. */ 212 } SMAP; 213 /* Macros to flush/test cached information. */ 214 #define SMAP_CACHE(smp) ((smp)->c_ecsize != 0) 215 #define SMAP_FLUSH(smp) ((smp)->c_ecsize = 0) 216 217 /* Character search information. */ 218 typedef enum { CNOTSET, FSEARCH, fSEARCH, TSEARCH, tSEARCH } cdir_t; 219 220 typedef enum { AB_NOTSET, AB_NOTWORD, AB_INWORD } abb_t; 221 typedef enum { Q_NOTSET, Q_VNEXT, Q_VTHIS } quote_t; 222 223 /* Vi private, per-screen memory. */ 224 typedef struct _vi_private { 225 VICMD cmd; /* Current command, motion. */ 226 VICMD motion; 227 228 /* 229 * !!! 230 * The saved command structure can be modified by the underlying 231 * vi functions, see v_Put() and v_put(). 232 */ 233 VICMD sdot; /* Saved dot, motion command. */ 234 VICMD sdotmotion; 235 236 CHAR_T *keyw; /* Keyword buffer. */ 237 size_t klen; /* Keyword length. */ 238 size_t keywlen; /* Keyword buffer length. */ 239 240 CHAR_T rlast; /* Last 'r' replacement character. */ 241 e_key_t rvalue; /* Value of last replacement character. */ 242 243 EVENT *rep; /* Input replay buffer. */ 244 size_t rep_len; /* Input replay buffer length. */ 245 size_t rep_cnt; /* Input replay buffer characters. */ 246 247 mtype_t mtype; /* Last displayed message type. */ 248 size_t linecount; /* 1-N: Output overwrite count. */ 249 size_t lcontinue; /* 1-N: Output line continue value. */ 250 size_t totalcount; /* 1-N: Output overwrite count. */ 251 252 /* Busy state. */ 253 int busy_ref; /* Busy reference count. */ 254 int busy_ch; /* Busy character. */ 255 size_t busy_fx; /* Busy character x coordinate. */ 256 size_t busy_oldy; /* Saved y coordinate. */ 257 size_t busy_oldx; /* Saved x coordinate. */ 258 struct timespec busy_ts;/* Busy timer. */ 259 260 char *ps; /* Paragraph plus section list. */ 261 262 u_long u_ccnt; /* Undo command count. */ 263 264 CHAR_T lastckey; /* Last search character. */ 265 cdir_t csearchdir; /* Character search direction. */ 266 267 SMAP *h_smap; /* First slot of the line map. */ 268 SMAP *t_smap; /* Last slot of the line map. */ 269 270 /* 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(). 273 */ 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) 281 282 /* 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. 288 */ 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) 293 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) 297 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. */ 303 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. */ 313 u_int16_t flags; 314 } VI_PRIVATE; 315 316 /* Vi private area. */ 317 #define VIP(sp) ((VI_PRIVATE *)((sp)->vi_private)) 318 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)) 323 324 /* 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. 328 */ 329 #define LASTLINE(sp) \ 330 ((sp)->t_maxrows < (sp)->rows ? (sp)->t_maxrows : (sp)->rows - 1) 331 332 /* 333 * Small screen (see vs_refresh.c, section 6a) and one-line screen test. 334 * Note, both cannot be true for the same screen. 335 */ 336 #define IS_SMALL(sp) ((sp)->t_minrows != (sp)->t_maxrows) 337 #define IS_ONELINE(sp) ((sp)->rows == 1) 338 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) 343 344 /* 345 * Next tab offset. 346 * 347 * !!! 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. 353 */ 354 #define TAB_OFF(c) COL_OFF((c), O_VAL(sp, O_TABSTOP)) 355 356 /* If more than one screen being shown. */ 357 #define IS_SPLIT(sp) (TAILQ_NEXT((sp), q) || TAILQ_PREV((sp), _dqh, q)) 358 359 /* Screen adjustment operations. */ 360 typedef enum { A_DECREASE, A_INCREASE, A_SET } adj_t; 361 362 /* Screen position operations. */ 363 typedef enum { P_BOTTOM, P_FILL, P_MIDDLE, P_TOP } pos_t; 364 365 /* Scrolling operations. */ 366 typedef enum { 367 CNTRL_B, CNTRL_D, CNTRL_E, CNTRL_F, 368 CNTRL_U, CNTRL_Y, Z_CARAT, Z_PLUS 369 } scroll_t; 370 371 /* Vi common error messages. */ 372 typedef enum { 373 VIM_COMBUF, VIM_EMPTY, VIM_EOF, VIM_EOL, 374 VIM_NOCOM, VIM_NOCOM_B, VIM_USAGE, VIM_WRESIZE 375 } vim_t; 376 377 #include "vi_extern.h" 378