1 /* vi:set ts=8 sts=4 sw=4 noet: 2 * 3 * VIM - Vi IMproved by Bram Moolenaar 4 * 5 * Do ":help uganda" in Vim to read copying and usage conditions. 6 * Do ":help credits" in Vim to see a list of people who contributed. 7 */ 8 9 /* 10 * This file contains various definitions of structures that are used by Vim 11 */ 12 13 /* 14 * There is something wrong in the SAS compiler that makes typedefs not 15 * valid in include files. Has been fixed in version 6.58. 16 */ 17 #if defined(SASC) && SASC < 658 18 typedef long linenr_T; 19 typedef int colnr_T; 20 typedef unsigned short short_u; 21 #endif 22 23 /* 24 * position in file or buffer 25 */ 26 typedef struct 27 { 28 linenr_T lnum; /* line number */ 29 colnr_T col; /* column number */ 30 #ifdef FEAT_VIRTUALEDIT 31 colnr_T coladd; 32 #endif 33 } pos_T; 34 35 #ifdef FEAT_VIRTUALEDIT 36 # define INIT_POS_T(l, c, ca) {l, c, ca} 37 #else 38 # define INIT_POS_T(l, c, ca) {l, c} 39 #endif 40 41 /* 42 * Same, but without coladd. 43 */ 44 typedef struct 45 { 46 linenr_T lnum; /* line number */ 47 colnr_T col; /* column number */ 48 } lpos_T; 49 50 /* 51 * Structure used for growing arrays. 52 * This is used to store information that only grows, is deleted all at 53 * once, and needs to be accessed by index. See ga_clear() and ga_grow(). 54 */ 55 typedef struct growarray 56 { 57 int ga_len; /* current number of items used */ 58 int ga_maxlen; /* maximum number of items possible */ 59 int ga_itemsize; /* sizeof(item) */ 60 int ga_growsize; /* number of items to grow each time */ 61 void *ga_data; /* pointer to the first item */ 62 } garray_T; 63 64 #define GA_EMPTY {0, 0, 0, 0, NULL} 65 66 typedef struct window_S win_T; 67 typedef struct wininfo_S wininfo_T; 68 typedef struct frame_S frame_T; 69 typedef int scid_T; /* script ID */ 70 typedef struct file_buffer buf_T; /* forward declaration */ 71 typedef struct terminal_S term_T; 72 73 #ifdef FEAT_MENU 74 typedef struct VimMenu vimmenu_T; 75 #endif 76 77 /* 78 * Reference to a buffer that stores the value of buf_free_count. 79 * bufref_valid() only needs to check "buf" when the count differs. 80 */ 81 typedef struct { 82 buf_T *br_buf; 83 int br_fnum; 84 int br_buf_free_count; 85 } bufref_T; 86 87 /* 88 * This is here because regexp.h needs pos_T and below regprog_T is used. 89 */ 90 #include "regexp.h" 91 92 /* 93 * This is here because gui.h needs the pos_T and win_T, and win_T needs gui.h 94 * for scrollbar_T. 95 */ 96 #ifdef FEAT_GUI 97 # include "gui.h" 98 #else 99 # ifdef FEAT_XCLIPBOARD 100 # include <X11/Intrinsic.h> 101 # endif 102 # define guicolor_T long 103 # define INVALCOLOR ((guicolor_T)0x1ffffff) 104 /* only used for cterm.bg_rgb and cterm.fg_rgb: use cterm color */ 105 # define CTERMCOLOR ((guicolor_T)0x1fffffe) 106 #endif 107 #define COLOR_INVALID(x) ((x) == INVALCOLOR || (x) == CTERMCOLOR) 108 109 /* 110 * marks: positions in a file 111 * (a normal mark is a lnum/col pair, the same as a file position) 112 */ 113 114 /* (Note: for EBCDIC there are more than 26, because there are gaps in the 115 * alphabet coding. To minimize changes to the code, I decided to just 116 * increase the number of possible marks. */ 117 #define NMARKS ('z' - 'a' + 1) /* max. # of named marks */ 118 #define JUMPLISTSIZE 100 /* max. # of marks in jump list */ 119 #define TAGSTACKSIZE 20 /* max. # of tags in tag stack */ 120 121 typedef struct filemark 122 { 123 pos_T mark; /* cursor position */ 124 int fnum; /* file number */ 125 } fmark_T; 126 127 /* Xtended file mark: also has a file name */ 128 typedef struct xfilemark 129 { 130 fmark_T fmark; 131 char_u *fname; /* file name, used when fnum == 0 */ 132 #ifdef FEAT_VIMINFO 133 time_T time_set; 134 #endif 135 } xfmark_T; 136 137 /* 138 * The taggy struct is used to store the information about a :tag command. 139 */ 140 typedef struct taggy 141 { 142 char_u *tagname; /* tag name */ 143 fmark_T fmark; /* cursor position BEFORE ":tag" */ 144 int cur_match; /* match number */ 145 int cur_fnum; /* buffer number used for cur_match */ 146 } taggy_T; 147 148 /* 149 * Structure that contains all options that are local to a window. 150 * Used twice in a window: for the current buffer and for all buffers. 151 * Also used in wininfo_T. 152 */ 153 typedef struct 154 { 155 #ifdef FEAT_ARABIC 156 int wo_arab; 157 # define w_p_arab w_onebuf_opt.wo_arab /* 'arabic' */ 158 #endif 159 #ifdef FEAT_LINEBREAK 160 int wo_bri; 161 # define w_p_bri w_onebuf_opt.wo_bri /* 'breakindent' */ 162 char_u *wo_briopt; 163 # define w_p_briopt w_onebuf_opt.wo_briopt /* 'breakindentopt' */ 164 #endif 165 #ifdef FEAT_DIFF 166 int wo_diff; 167 # define w_p_diff w_onebuf_opt.wo_diff /* 'diff' */ 168 #endif 169 #ifdef FEAT_FOLDING 170 long wo_fdc; 171 # define w_p_fdc w_onebuf_opt.wo_fdc /* 'foldcolumn' */ 172 int wo_fdc_save; 173 # define w_p_fdc_save w_onebuf_opt.wo_fdc_save /* 'foldenable' saved for diff mode */ 174 int wo_fen; 175 # define w_p_fen w_onebuf_opt.wo_fen /* 'foldenable' */ 176 int wo_fen_save; 177 # define w_p_fen_save w_onebuf_opt.wo_fen_save /* 'foldenable' saved for diff mode */ 178 char_u *wo_fdi; 179 # define w_p_fdi w_onebuf_opt.wo_fdi /* 'foldignore' */ 180 long wo_fdl; 181 # define w_p_fdl w_onebuf_opt.wo_fdl /* 'foldlevel' */ 182 int wo_fdl_save; 183 # define w_p_fdl_save w_onebuf_opt.wo_fdl_save /* 'foldlevel' state saved for diff mode */ 184 char_u *wo_fdm; 185 # define w_p_fdm w_onebuf_opt.wo_fdm /* 'foldmethod' */ 186 char_u *wo_fdm_save; 187 # define w_p_fdm_save w_onebuf_opt.wo_fdm_save /* 'fdm' saved for diff mode */ 188 long wo_fml; 189 # define w_p_fml w_onebuf_opt.wo_fml /* 'foldminlines' */ 190 long wo_fdn; 191 # define w_p_fdn w_onebuf_opt.wo_fdn /* 'foldnestmax' */ 192 # ifdef FEAT_EVAL 193 char_u *wo_fde; 194 # define w_p_fde w_onebuf_opt.wo_fde /* 'foldexpr' */ 195 char_u *wo_fdt; 196 # define w_p_fdt w_onebuf_opt.wo_fdt /* 'foldtext' */ 197 # endif 198 char_u *wo_fmr; 199 # define w_p_fmr w_onebuf_opt.wo_fmr /* 'foldmarker' */ 200 #endif 201 #ifdef FEAT_LINEBREAK 202 int wo_lbr; 203 # define w_p_lbr w_onebuf_opt.wo_lbr /* 'linebreak' */ 204 #endif 205 int wo_list; 206 #define w_p_list w_onebuf_opt.wo_list /* 'list' */ 207 int wo_nu; 208 #define w_p_nu w_onebuf_opt.wo_nu /* 'number' */ 209 int wo_rnu; 210 #define w_p_rnu w_onebuf_opt.wo_rnu /* 'relativenumber' */ 211 #ifdef FEAT_LINEBREAK 212 long wo_nuw; 213 # define w_p_nuw w_onebuf_opt.wo_nuw /* 'numberwidth' */ 214 #endif 215 int wo_wfh; 216 # define w_p_wfh w_onebuf_opt.wo_wfh /* 'winfixheight' */ 217 int wo_wfw; 218 # define w_p_wfw w_onebuf_opt.wo_wfw /* 'winfixwidth' */ 219 #if defined(FEAT_QUICKFIX) 220 int wo_pvw; 221 # define w_p_pvw w_onebuf_opt.wo_pvw /* 'previewwindow' */ 222 #endif 223 #ifdef FEAT_RIGHTLEFT 224 int wo_rl; 225 # define w_p_rl w_onebuf_opt.wo_rl /* 'rightleft' */ 226 char_u *wo_rlc; 227 # define w_p_rlc w_onebuf_opt.wo_rlc /* 'rightleftcmd' */ 228 #endif 229 long wo_scr; 230 #define w_p_scr w_onebuf_opt.wo_scr /* 'scroll' */ 231 #ifdef FEAT_SPELL 232 int wo_spell; 233 # define w_p_spell w_onebuf_opt.wo_spell /* 'spell' */ 234 #endif 235 #ifdef FEAT_SYN_HL 236 int wo_cuc; 237 # define w_p_cuc w_onebuf_opt.wo_cuc /* 'cursorcolumn' */ 238 int wo_cul; 239 # define w_p_cul w_onebuf_opt.wo_cul /* 'cursorline' */ 240 char_u *wo_cc; 241 # define w_p_cc w_onebuf_opt.wo_cc /* 'colorcolumn' */ 242 #endif 243 #ifdef FEAT_STL_OPT 244 char_u *wo_stl; 245 #define w_p_stl w_onebuf_opt.wo_stl /* 'statusline' */ 246 #endif 247 int wo_scb; 248 #define w_p_scb w_onebuf_opt.wo_scb /* 'scrollbind' */ 249 int wo_diff_saved; /* options were saved for starting diff mode */ 250 #define w_p_diff_saved w_onebuf_opt.wo_diff_saved 251 int wo_scb_save; /* 'scrollbind' saved for diff mode*/ 252 #define w_p_scb_save w_onebuf_opt.wo_scb_save 253 int wo_wrap; 254 #define w_p_wrap w_onebuf_opt.wo_wrap /* 'wrap' */ 255 #ifdef FEAT_DIFF 256 int wo_wrap_save; /* 'wrap' state saved for diff mode*/ 257 # define w_p_wrap_save w_onebuf_opt.wo_wrap_save 258 #endif 259 #ifdef FEAT_CONCEAL 260 char_u *wo_cocu; /* 'concealcursor' */ 261 # define w_p_cocu w_onebuf_opt.wo_cocu 262 long wo_cole; /* 'conceallevel' */ 263 # define w_p_cole w_onebuf_opt.wo_cole 264 #endif 265 int wo_crb; 266 #define w_p_crb w_onebuf_opt.wo_crb /* 'cursorbind' */ 267 int wo_crb_save; /* 'cursorbind' state saved for diff mode*/ 268 #define w_p_crb_save w_onebuf_opt.wo_crb_save 269 #ifdef FEAT_SIGNS 270 char_u *wo_scl; 271 # define w_p_scl w_onebuf_opt.wo_scl /* 'signcolumn' */ 272 #endif 273 #ifdef FEAT_TERMINAL 274 char_u *wo_tk; 275 #define w_p_tk w_onebuf_opt.wo_tk /* 'termkey' */ 276 char_u *wo_tms; 277 #define w_p_tms w_onebuf_opt.wo_tms /* 'termsize' */ 278 #endif 279 280 #ifdef FEAT_EVAL 281 int wo_scriptID[WV_COUNT]; /* SIDs for window-local options */ 282 # define w_p_scriptID w_onebuf_opt.wo_scriptID 283 #endif 284 } winopt_T; 285 286 /* 287 * Window info stored with a buffer. 288 * 289 * Two types of info are kept for a buffer which are associated with a 290 * specific window: 291 * 1. Each window can have a different line number associated with a buffer. 292 * 2. The window-local options for a buffer work in a similar way. 293 * The window-info is kept in a list at b_wininfo. It is kept in 294 * most-recently-used order. 295 */ 296 struct wininfo_S 297 { 298 wininfo_T *wi_next; /* next entry or NULL for last entry */ 299 wininfo_T *wi_prev; /* previous entry or NULL for first entry */ 300 win_T *wi_win; /* pointer to window that did set wi_fpos */ 301 pos_T wi_fpos; /* last cursor position in the file */ 302 int wi_optset; /* TRUE when wi_opt has useful values */ 303 winopt_T wi_opt; /* local window options */ 304 #ifdef FEAT_FOLDING 305 int wi_fold_manual; /* copy of w_fold_manual */ 306 garray_T wi_folds; /* clone of w_folds */ 307 #endif 308 }; 309 310 /* 311 * Info used to pass info about a fold from the fold-detection code to the 312 * code that displays the foldcolumn. 313 */ 314 typedef struct foldinfo 315 { 316 int fi_level; /* level of the fold; when this is zero the 317 other fields are invalid */ 318 int fi_lnum; /* line number where fold starts */ 319 int fi_low_level; /* lowest fold level that starts in the same 320 line */ 321 } foldinfo_T; 322 323 /* Structure to store info about the Visual area. */ 324 typedef struct 325 { 326 pos_T vi_start; /* start pos of last VIsual */ 327 pos_T vi_end; /* end position of last VIsual */ 328 int vi_mode; /* VIsual_mode of last VIsual */ 329 colnr_T vi_curswant; /* MAXCOL from w_curswant */ 330 } visualinfo_T; 331 332 /* 333 * structures used for undo 334 */ 335 336 typedef struct u_entry u_entry_T; 337 typedef struct u_header u_header_T; 338 struct u_entry 339 { 340 u_entry_T *ue_next; /* pointer to next entry in list */ 341 linenr_T ue_top; /* number of line above undo block */ 342 linenr_T ue_bot; /* number of line below undo block */ 343 linenr_T ue_lcount; /* linecount when u_save called */ 344 char_u **ue_array; /* array of lines in undo block */ 345 long ue_size; /* number of lines in ue_array */ 346 #ifdef U_DEBUG 347 int ue_magic; /* magic number to check allocation */ 348 #endif 349 }; 350 351 struct u_header 352 { 353 /* The following have a pointer and a number. The number is used when 354 * reading the undo file in u_read_undo() */ 355 union { 356 u_header_T *ptr; /* pointer to next undo header in list */ 357 long seq; 358 } uh_next; 359 union { 360 u_header_T *ptr; /* pointer to previous header in list */ 361 long seq; 362 } uh_prev; 363 union { 364 u_header_T *ptr; /* pointer to next header for alt. redo */ 365 long seq; 366 } uh_alt_next; 367 union { 368 u_header_T *ptr; /* pointer to previous header for alt. redo */ 369 long seq; 370 } uh_alt_prev; 371 long uh_seq; /* sequence number, higher == newer undo */ 372 int uh_walk; /* used by undo_time() */ 373 u_entry_T *uh_entry; /* pointer to first entry */ 374 u_entry_T *uh_getbot_entry; /* pointer to where ue_bot must be set */ 375 pos_T uh_cursor; /* cursor position before saving */ 376 #ifdef FEAT_VIRTUALEDIT 377 long uh_cursor_vcol; 378 #endif 379 int uh_flags; /* see below */ 380 pos_T uh_namedm[NMARKS]; /* marks before undo/after redo */ 381 visualinfo_T uh_visual; /* Visual areas before undo/after redo */ 382 time_T uh_time; /* timestamp when the change was made */ 383 long uh_save_nr; /* set when the file was saved after the 384 changes in this block */ 385 #ifdef U_DEBUG 386 int uh_magic; /* magic number to check allocation */ 387 #endif 388 }; 389 390 /* values for uh_flags */ 391 #define UH_CHANGED 0x01 /* b_changed flag before undo/after redo */ 392 #define UH_EMPTYBUF 0x02 /* buffer was empty */ 393 394 /* 395 * structures used in undo.c 396 */ 397 #if VIM_SIZEOF_INT > 2 398 # define ALIGN_LONG /* longword alignment and use filler byte */ 399 # define ALIGN_SIZE (sizeof(long)) 400 #else 401 # define ALIGN_SIZE (sizeof(short)) 402 #endif 403 404 #define ALIGN_MASK (ALIGN_SIZE - 1) 405 406 typedef struct m_info minfo_T; 407 408 /* 409 * structure used to link chunks in one of the free chunk lists. 410 */ 411 struct m_info 412 { 413 #ifdef ALIGN_LONG 414 long_u m_size; /* size of the chunk (including m_info) */ 415 #else 416 short_u m_size; /* size of the chunk (including m_info) */ 417 #endif 418 minfo_T *m_next; /* pointer to next free chunk in the list */ 419 }; 420 421 /* 422 * things used in memfile.c 423 */ 424 425 typedef struct block_hdr bhdr_T; 426 typedef struct memfile memfile_T; 427 typedef long blocknr_T; 428 429 /* 430 * mf_hashtab_T is a chained hashtable with blocknr_T key and arbitrary 431 * structures as items. This is an intrusive data structure: we require 432 * that items begin with mf_hashitem_T which contains the key and linked 433 * list pointers. List of items in each bucket is doubly-linked. 434 */ 435 436 typedef struct mf_hashitem_S mf_hashitem_T; 437 438 struct mf_hashitem_S 439 { 440 mf_hashitem_T *mhi_next; 441 mf_hashitem_T *mhi_prev; 442 blocknr_T mhi_key; 443 }; 444 445 #define MHT_INIT_SIZE 64 446 447 typedef struct mf_hashtab_S 448 { 449 long_u mht_mask; /* mask used for hash value (nr of items 450 * in array is "mht_mask" + 1) */ 451 long_u mht_count; /* nr of items inserted into hashtable */ 452 mf_hashitem_T **mht_buckets; /* points to mht_small_buckets or 453 *dynamically allocated array */ 454 mf_hashitem_T *mht_small_buckets[MHT_INIT_SIZE]; /* initial buckets */ 455 char mht_fixed; /* non-zero value forbids growth */ 456 } mf_hashtab_T; 457 458 /* 459 * for each (previously) used block in the memfile there is one block header. 460 * 461 * The block may be linked in the used list OR in the free list. 462 * The used blocks are also kept in hash lists. 463 * 464 * The used list is a doubly linked list, most recently used block first. 465 * The blocks in the used list have a block of memory allocated. 466 * mf_used_count is the number of pages in the used list. 467 * The hash lists are used to quickly find a block in the used list. 468 * The free list is a single linked list, not sorted. 469 * The blocks in the free list have no block of memory allocated and 470 * the contents of the block in the file (if any) is irrelevant. 471 */ 472 473 struct block_hdr 474 { 475 mf_hashitem_T bh_hashitem; /* header for hash table and key */ 476 #define bh_bnum bh_hashitem.mhi_key /* block number, part of bh_hashitem */ 477 478 bhdr_T *bh_next; /* next block_hdr in free or used list */ 479 bhdr_T *bh_prev; /* previous block_hdr in used list */ 480 char_u *bh_data; /* pointer to memory (for used block) */ 481 int bh_page_count; /* number of pages in this block */ 482 483 #define BH_DIRTY 1 484 #define BH_LOCKED 2 485 char bh_flags; /* BH_DIRTY or BH_LOCKED */ 486 }; 487 488 /* 489 * when a block with a negative number is flushed to the file, it gets 490 * a positive number. Because the reference to the block is still the negative 491 * number, we remember the translation to the new positive number in the 492 * double linked trans lists. The structure is the same as the hash lists. 493 */ 494 typedef struct nr_trans NR_TRANS; 495 496 struct nr_trans 497 { 498 mf_hashitem_T nt_hashitem; /* header for hash table and key */ 499 #define nt_old_bnum nt_hashitem.mhi_key /* old, negative, number */ 500 501 blocknr_T nt_new_bnum; /* new, positive, number */ 502 }; 503 504 505 typedef struct buffblock buffblock_T; 506 typedef struct buffheader buffheader_T; 507 508 /* 509 * structure used to store one block of the stuff/redo/recording buffers 510 */ 511 struct buffblock 512 { 513 buffblock_T *b_next; /* pointer to next buffblock */ 514 char_u b_str[1]; /* contents (actually longer) */ 515 }; 516 517 /* 518 * header used for the stuff buffer and the redo buffer 519 */ 520 struct buffheader 521 { 522 buffblock_T bh_first; /* first (dummy) block of list */ 523 buffblock_T *bh_curr; /* buffblock for appending */ 524 int bh_index; /* index for reading */ 525 int bh_space; /* space in bh_curr for appending */ 526 }; 527 528 typedef struct 529 { 530 buffheader_T sr_redobuff; 531 buffheader_T sr_old_redobuff; 532 } save_redo_T; 533 534 /* 535 * used for completion on the command line 536 */ 537 typedef struct expand 538 { 539 int xp_context; /* type of expansion */ 540 char_u *xp_pattern; /* start of item to expand */ 541 int xp_pattern_len; /* bytes in xp_pattern before cursor */ 542 #if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL) 543 char_u *xp_arg; /* completion function */ 544 int xp_scriptID; /* SID for completion function */ 545 #endif 546 int xp_backslash; /* one of the XP_BS_ values */ 547 #ifndef BACKSLASH_IN_FILENAME 548 int xp_shell; /* TRUE for a shell command, more 549 characters need to be escaped */ 550 #endif 551 int xp_numfiles; /* number of files found by 552 file name completion */ 553 char_u **xp_files; /* list of files */ 554 char_u *xp_line; /* text being completed */ 555 int xp_col; /* cursor position in line */ 556 } expand_T; 557 558 /* values for xp_backslash */ 559 #define XP_BS_NONE 0 /* nothing special for backslashes */ 560 #define XP_BS_ONE 1 /* uses one backslash before a space */ 561 #define XP_BS_THREE 2 /* uses three backslashes before a space */ 562 563 /* 564 * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag. 565 * This needs to be saved for recursive commands, put them in a structure for 566 * easy manipulation. 567 */ 568 typedef struct 569 { 570 int hide; /* TRUE when ":hide" was used */ 571 # ifdef FEAT_BROWSE_CMD 572 int browse; /* TRUE to invoke file dialog */ 573 # endif 574 int split; /* flags for win_split() */ 575 int tab; /* > 0 when ":tab" was used */ 576 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) 577 int confirm; /* TRUE to invoke yes/no dialog */ 578 # endif 579 int keepalt; /* TRUE when ":keepalt" was used */ 580 int keepmarks; /* TRUE when ":keepmarks" was used */ 581 int keepjumps; /* TRUE when ":keepjumps" was used */ 582 int lockmarks; /* TRUE when ":lockmarks" was used */ 583 int keeppatterns; /* TRUE when ":keeppatterns" was used */ 584 int noswapfile; /* TRUE when ":noswapfile" was used */ 585 char_u *save_ei; /* saved value of 'eventignore' */ 586 regmatch_T filter_regmatch; /* set by :filter /pat/ */ 587 int filter_force; /* set for :filter! */ 588 } cmdmod_T; 589 590 #define MF_SEED_LEN 8 591 592 struct memfile 593 { 594 char_u *mf_fname; /* name of the file */ 595 char_u *mf_ffname; /* idem, full path */ 596 int mf_fd; /* file descriptor */ 597 bhdr_T *mf_free_first; /* first block_hdr in free list */ 598 bhdr_T *mf_used_first; /* mru block_hdr in used list */ 599 bhdr_T *mf_used_last; /* lru block_hdr in used list */ 600 unsigned mf_used_count; /* number of pages in used list */ 601 unsigned mf_used_count_max; /* maximum number of pages in memory */ 602 mf_hashtab_T mf_hash; /* hash lists */ 603 mf_hashtab_T mf_trans; /* trans lists */ 604 blocknr_T mf_blocknr_max; /* highest positive block number + 1*/ 605 blocknr_T mf_blocknr_min; /* lowest negative block number - 1 */ 606 blocknr_T mf_neg_count; /* number of negative blocks numbers */ 607 blocknr_T mf_infile_count; /* number of pages in the file */ 608 unsigned mf_page_size; /* number of bytes in a page */ 609 int mf_dirty; /* TRUE if there are dirty blocks */ 610 #ifdef FEAT_CRYPT 611 buf_T *mf_buffer; /* buffer this memfile is for */ 612 char_u mf_seed[MF_SEED_LEN]; /* seed for encryption */ 613 614 /* Values for key, method and seed used for reading data blocks when 615 * updating for a newly set key or method. Only when mf_old_key != NULL. */ 616 char_u *mf_old_key; 617 int mf_old_cm; 618 char_u mf_old_seed[MF_SEED_LEN]; 619 #endif 620 }; 621 622 /* 623 * things used in memline.c 624 */ 625 /* 626 * When searching for a specific line, we remember what blocks in the tree 627 * are the branches leading to that block. This is stored in ml_stack. Each 628 * entry is a pointer to info in a block (may be data block or pointer block) 629 */ 630 typedef struct info_pointer 631 { 632 blocknr_T ip_bnum; /* block number */ 633 linenr_T ip_low; /* lowest lnum in this block */ 634 linenr_T ip_high; /* highest lnum in this block */ 635 int ip_index; /* index for block with current lnum */ 636 } infoptr_T; /* block/index pair */ 637 638 #ifdef FEAT_BYTEOFF 639 typedef struct ml_chunksize 640 { 641 int mlcs_numlines; 642 long mlcs_totalsize; 643 } chunksize_T; 644 645 /* Flags when calling ml_updatechunk() */ 646 647 #define ML_CHNK_ADDLINE 1 648 #define ML_CHNK_DELLINE 2 649 #define ML_CHNK_UPDLINE 3 650 #endif 651 652 /* 653 * the memline structure holds all the information about a memline 654 */ 655 typedef struct memline 656 { 657 linenr_T ml_line_count; /* number of lines in the buffer */ 658 659 memfile_T *ml_mfp; /* pointer to associated memfile */ 660 661 #define ML_EMPTY 1 /* empty buffer */ 662 #define ML_LINE_DIRTY 2 /* cached line was changed and allocated */ 663 #define ML_LOCKED_DIRTY 4 /* ml_locked was changed */ 664 #define ML_LOCKED_POS 8 /* ml_locked needs positive block number */ 665 int ml_flags; 666 667 infoptr_T *ml_stack; /* stack of pointer blocks (array of IPTRs) */ 668 int ml_stack_top; /* current top of ml_stack */ 669 int ml_stack_size; /* total number of entries in ml_stack */ 670 671 linenr_T ml_line_lnum; /* line number of cached line, 0 if not valid */ 672 char_u *ml_line_ptr; /* pointer to cached line */ 673 674 bhdr_T *ml_locked; /* block used by last ml_get */ 675 linenr_T ml_locked_low; /* first line in ml_locked */ 676 linenr_T ml_locked_high; /* last line in ml_locked */ 677 int ml_locked_lineadd; /* number of lines inserted in ml_locked */ 678 #ifdef FEAT_BYTEOFF 679 chunksize_T *ml_chunksize; 680 int ml_numchunks; 681 int ml_usedchunks; 682 #endif 683 } memline_T; 684 685 #if defined(FEAT_SIGNS) || defined(PROTO) 686 typedef struct signlist signlist_T; 687 688 struct signlist 689 { 690 int id; /* unique identifier for each placed sign */ 691 linenr_T lnum; /* line number which has this sign */ 692 int typenr; /* typenr of sign */ 693 signlist_T *next; /* next signlist entry */ 694 # ifdef FEAT_NETBEANS_INTG 695 signlist_T *prev; /* previous entry -- for easy reordering */ 696 # endif 697 }; 698 699 /* type argument for buf_getsigntype() */ 700 #define SIGN_ANY 0 701 #define SIGN_LINEHL 1 702 #define SIGN_ICON 2 703 #define SIGN_TEXT 3 704 #endif 705 706 /* 707 * Argument list: Array of file names. 708 * Used for the global argument list and the argument lists local to a window. 709 */ 710 typedef struct arglist 711 { 712 garray_T al_ga; /* growarray with the array of file names */ 713 int al_refcount; /* number of windows using this arglist */ 714 int id; /* id of this arglist */ 715 } alist_T; 716 717 /* 718 * For each argument remember the file name as it was given, and the buffer 719 * number that contains the expanded file name (required for when ":cd" is 720 * used. 721 */ 722 typedef struct argentry 723 { 724 char_u *ae_fname; /* file name as specified */ 725 int ae_fnum; /* buffer number with expanded file name */ 726 } aentry_T; 727 728 #define ALIST(win) (win)->w_alist 729 #define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data) 730 #define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data) 731 #define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data) 732 #define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data)) 733 #define GARGCOUNT (global_alist.al_ga.ga_len) 734 #define ARGCOUNT (ALIST(curwin)->al_ga.ga_len) 735 #define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len) 736 737 /* 738 * A list used for saving values of "emsg_silent". Used by ex_try() to save the 739 * value of "emsg_silent" if it was non-zero. When this is done, the CSF_SILENT 740 * flag below is set. 741 */ 742 743 typedef struct eslist_elem eslist_T; 744 struct eslist_elem 745 { 746 int saved_emsg_silent; /* saved value of "emsg_silent" */ 747 eslist_T *next; /* next element on the list */ 748 }; 749 750 /* 751 * For conditional commands a stack is kept of nested conditionals. 752 * When cs_idx < 0, there is no conditional command. 753 */ 754 #define CSTACK_LEN 50 755 756 struct condstack 757 { 758 short cs_flags[CSTACK_LEN]; /* CSF_ flags */ 759 char cs_pending[CSTACK_LEN]; /* CSTP_: what's pending in ":finally"*/ 760 union { 761 void *csp_rv[CSTACK_LEN]; /* return typeval for pending return */ 762 void *csp_ex[CSTACK_LEN]; /* exception for pending throw */ 763 } cs_pend; 764 void *cs_forinfo[CSTACK_LEN]; /* info used by ":for" */ 765 int cs_line[CSTACK_LEN]; /* line nr of ":while"/":for" line */ 766 int cs_idx; /* current entry, or -1 if none */ 767 int cs_looplevel; /* nr of nested ":while"s and ":for"s */ 768 int cs_trylevel; /* nr of nested ":try"s */ 769 eslist_T *cs_emsg_silent_list; /* saved values of "emsg_silent" */ 770 char cs_lflags; /* loop flags: CSL_ flags */ 771 }; 772 # define cs_rettv cs_pend.csp_rv 773 # define cs_exception cs_pend.csp_ex 774 775 /* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if" 776 * was used. */ 777 # define CSF_TRUE 0x0001 /* condition was TRUE */ 778 # define CSF_ACTIVE 0x0002 /* current state is active */ 779 # define CSF_ELSE 0x0004 /* ":else" has been passed */ 780 # define CSF_WHILE 0x0008 /* is a ":while" */ 781 # define CSF_FOR 0x0010 /* is a ":for" */ 782 783 # define CSF_TRY 0x0100 /* is a ":try" */ 784 # define CSF_FINALLY 0x0200 /* ":finally" has been passed */ 785 # define CSF_THROWN 0x0400 /* exception thrown to this try conditional */ 786 # define CSF_CAUGHT 0x0800 /* exception caught by this try conditional */ 787 # define CSF_SILENT 0x1000 /* "emsg_silent" reset by ":try" */ 788 /* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset 789 * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */ 790 791 /* 792 * What's pending for being reactivated at the ":endtry" of this try 793 * conditional: 794 */ 795 # define CSTP_NONE 0 /* nothing pending in ":finally" clause */ 796 # define CSTP_ERROR 1 /* an error is pending */ 797 # define CSTP_INTERRUPT 2 /* an interrupt is pending */ 798 # define CSTP_THROW 4 /* a throw is pending */ 799 # define CSTP_BREAK 8 /* ":break" is pending */ 800 # define CSTP_CONTINUE 16 /* ":continue" is pending */ 801 # define CSTP_RETURN 24 /* ":return" is pending */ 802 # define CSTP_FINISH 32 /* ":finish" is pending */ 803 804 /* 805 * Flags for the cs_lflags item in struct condstack. 806 */ 807 # define CSL_HAD_LOOP 1 /* just found ":while" or ":for" */ 808 # define CSL_HAD_ENDLOOP 2 /* just found ":endwhile" or ":endfor" */ 809 # define CSL_HAD_CONT 4 /* just found ":continue" */ 810 # define CSL_HAD_FINA 8 /* just found ":finally" */ 811 812 /* 813 * A list of error messages that can be converted to an exception. "throw_msg" 814 * is only set in the first element of the list. Usually, it points to the 815 * original message stored in that element, but sometimes it points to a later 816 * message in the list. See cause_errthrow() below. 817 */ 818 struct msglist 819 { 820 char_u *msg; /* original message */ 821 char_u *throw_msg; /* msg to throw: usually original one */ 822 struct msglist *next; /* next of several messages in a row */ 823 }; 824 825 /* 826 * The exception types. 827 */ 828 typedef enum 829 { 830 ET_USER, /* exception caused by ":throw" command */ 831 ET_ERROR, /* error exception */ 832 ET_INTERRUPT /* interrupt exception triggered by Ctrl-C */ 833 } except_type_T; 834 835 /* 836 * Structure describing an exception. 837 * (don't use "struct exception", it's used by the math library). 838 */ 839 typedef struct vim_exception except_T; 840 struct vim_exception 841 { 842 except_type_T type; /* exception type */ 843 char_u *value; /* exception value */ 844 struct msglist *messages; /* message(s) causing error exception */ 845 char_u *throw_name; /* name of the throw point */ 846 linenr_T throw_lnum; /* line number of the throw point */ 847 except_T *caught; /* next exception on the caught stack */ 848 }; 849 850 /* 851 * Structure to save the error/interrupt/exception state between calls to 852 * enter_cleanup() and leave_cleanup(). Must be allocated as an automatic 853 * variable by the (common) caller of these functions. 854 */ 855 typedef struct cleanup_stuff cleanup_T; 856 struct cleanup_stuff 857 { 858 int pending; /* error/interrupt/exception state */ 859 except_T *exception; /* exception value */ 860 }; 861 862 #ifdef FEAT_SYN_HL 863 /* struct passed to in_id_list() */ 864 struct sp_syn 865 { 866 int inc_tag; /* ":syn include" unique tag */ 867 short id; /* highlight group ID of item */ 868 short *cont_in_list; /* cont.in group IDs, if non-zero */ 869 }; 870 871 /* 872 * Each keyword has one keyentry, which is linked in a hash list. 873 */ 874 typedef struct keyentry keyentry_T; 875 876 struct keyentry 877 { 878 keyentry_T *ke_next; /* next entry with identical "keyword[]" */ 879 struct sp_syn k_syn; /* struct passed to in_id_list() */ 880 short *next_list; /* ID list for next match (if non-zero) */ 881 int flags; 882 int k_char; /* conceal substitute character */ 883 char_u keyword[1]; /* actually longer */ 884 }; 885 886 /* 887 * Struct used to store one state of the state stack. 888 */ 889 typedef struct buf_state 890 { 891 int bs_idx; /* index of pattern */ 892 int bs_flags; /* flags for pattern */ 893 #ifdef FEAT_CONCEAL 894 int bs_seqnr; /* stores si_seqnr */ 895 int bs_cchar; /* stores si_cchar */ 896 #endif 897 reg_extmatch_T *bs_extmatch; /* external matches from start pattern */ 898 } bufstate_T; 899 900 /* 901 * syn_state contains the syntax state stack for the start of one line. 902 * Used by b_sst_array[]. 903 */ 904 typedef struct syn_state synstate_T; 905 906 struct syn_state 907 { 908 synstate_T *sst_next; /* next entry in used or free list */ 909 linenr_T sst_lnum; /* line number for this state */ 910 union 911 { 912 bufstate_T sst_stack[SST_FIX_STATES]; /* short state stack */ 913 garray_T sst_ga; /* growarray for long state stack */ 914 } sst_union; 915 int sst_next_flags; /* flags for sst_next_list */ 916 int sst_stacksize; /* number of states on the stack */ 917 short *sst_next_list; /* "nextgroup" list in this state 918 * (this is a copy, don't free it! */ 919 disptick_T sst_tick; /* tick when last displayed */ 920 linenr_T sst_change_lnum;/* when non-zero, change in this line 921 * may have made the state invalid */ 922 }; 923 #endif /* FEAT_SYN_HL */ 924 925 /* 926 * Structure shared between syntax.c, screen.c and gui_x11.c. 927 */ 928 typedef struct attr_entry 929 { 930 short ae_attr; /* HL_BOLD, etc. */ 931 union 932 { 933 struct 934 { 935 char_u *start; /* start escape sequence */ 936 char_u *stop; /* stop escape sequence */ 937 } term; 938 struct 939 { 940 /* These colors need to be > 8 bits to hold 256. */ 941 short_u fg_color; /* foreground color number */ 942 short_u bg_color; /* background color number */ 943 # ifdef FEAT_TERMGUICOLORS 944 guicolor_T fg_rgb; /* foreground color RGB */ 945 guicolor_T bg_rgb; /* background color RGB */ 946 # endif 947 } cterm; 948 # ifdef FEAT_GUI 949 struct 950 { 951 guicolor_T fg_color; /* foreground color handle */ 952 guicolor_T bg_color; /* background color handle */ 953 guicolor_T sp_color; /* special color handle */ 954 GuiFont font; /* font handle */ 955 # ifdef FEAT_XFONTSET 956 GuiFontset fontset; /* fontset handle */ 957 # endif 958 } gui; 959 # endif 960 } ae_u; 961 } attrentry_T; 962 963 #ifdef USE_ICONV 964 # ifdef HAVE_ICONV_H 965 # include <iconv.h> 966 # else 967 # if defined(MACOS_X) 968 # include <sys/errno.h> 969 # ifndef EILSEQ 970 # define EILSEQ ENOENT /* Early MacOS X does not have EILSEQ */ 971 # endif 972 typedef struct _iconv_t *iconv_t; 973 # else 974 # include <errno.h> 975 # endif 976 typedef void *iconv_t; 977 # endif 978 #endif 979 980 /* 981 * Used for the typeahead buffer: typebuf. 982 */ 983 typedef struct 984 { 985 char_u *tb_buf; /* buffer for typed characters */ 986 char_u *tb_noremap; /* mapping flags for characters in tb_buf[] */ 987 int tb_buflen; /* size of tb_buf[] */ 988 int tb_off; /* current position in tb_buf[] */ 989 int tb_len; /* number of valid bytes in tb_buf[] */ 990 int tb_maplen; /* nr of mapped bytes in tb_buf[] */ 991 int tb_silent; /* nr of silently mapped bytes in tb_buf[] */ 992 int tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */ 993 int tb_change_cnt; /* nr of time tb_buf was changed; never zero */ 994 } typebuf_T; 995 996 /* Struct to hold the saved typeahead for save_typeahead(). */ 997 typedef struct 998 { 999 typebuf_T save_typebuf; 1000 int typebuf_valid; /* TRUE when save_typebuf valid */ 1001 int old_char; 1002 int old_mod_mask; 1003 buffheader_T save_readbuf1; 1004 buffheader_T save_readbuf2; 1005 #ifdef USE_INPUT_BUF 1006 char_u *save_inputbuf; 1007 #endif 1008 } tasave_T; 1009 1010 /* 1011 * Used for conversion of terminal I/O and script files. 1012 */ 1013 typedef struct 1014 { 1015 int vc_type; /* zero or one of the CONV_ values */ 1016 int vc_factor; /* max. expansion factor */ 1017 # ifdef WIN3264 1018 int vc_cpfrom; /* codepage to convert from (CONV_CODEPAGE) */ 1019 int vc_cpto; /* codepage to convert to (CONV_CODEPAGE) */ 1020 # endif 1021 # ifdef USE_ICONV 1022 iconv_t vc_fd; /* for CONV_ICONV */ 1023 # endif 1024 int vc_fail; /* fail for invalid char, don't use '?' */ 1025 } vimconv_T; 1026 1027 /* 1028 * Structure used for reading from the viminfo file. 1029 */ 1030 typedef struct 1031 { 1032 char_u *vir_line; /* text of the current line */ 1033 FILE *vir_fd; /* file descriptor */ 1034 #ifdef FEAT_MBYTE 1035 vimconv_T vir_conv; /* encoding conversion */ 1036 #endif 1037 int vir_version; /* viminfo version detected or -1 */ 1038 garray_T vir_barlines; /* lines starting with | */ 1039 } vir_T; 1040 1041 #define CONV_NONE 0 1042 #define CONV_TO_UTF8 1 1043 #define CONV_9_TO_UTF8 2 1044 #define CONV_TO_LATIN1 3 1045 #define CONV_TO_LATIN9 4 1046 #define CONV_ICONV 5 1047 #ifdef WIN3264 1048 # define CONV_CODEPAGE 10 /* codepage -> codepage */ 1049 #endif 1050 #ifdef MACOS_X 1051 # define CONV_MAC_LATIN1 20 1052 # define CONV_LATIN1_MAC 21 1053 # define CONV_MAC_UTF8 22 1054 # define CONV_UTF8_MAC 23 1055 #endif 1056 1057 /* 1058 * Structure used for mappings and abbreviations. 1059 */ 1060 typedef struct mapblock mapblock_T; 1061 struct mapblock 1062 { 1063 mapblock_T *m_next; /* next mapblock in list */ 1064 char_u *m_keys; /* mapped from, lhs */ 1065 char_u *m_str; /* mapped to, rhs */ 1066 char_u *m_orig_str; /* rhs as entered by the user */ 1067 int m_keylen; /* strlen(m_keys) */ 1068 int m_mode; /* valid mode */ 1069 int m_noremap; /* if non-zero no re-mapping for m_str */ 1070 char m_silent; /* <silent> used, don't echo commands */ 1071 char m_nowait; /* <nowait> used */ 1072 #ifdef FEAT_EVAL 1073 char m_expr; /* <expr> used, m_str is an expression */ 1074 scid_T m_script_ID; /* ID of script where map was defined */ 1075 #endif 1076 }; 1077 1078 /* 1079 * Used for highlighting in the status line. 1080 */ 1081 struct stl_hlrec 1082 { 1083 char_u *start; 1084 int userhl; /* 0: no HL, 1-9: User HL, < 0 for syn ID */ 1085 }; 1086 1087 1088 /* 1089 * Syntax items - usually buffer-specific. 1090 */ 1091 1092 /* Item for a hashtable. "hi_key" can be one of three values: 1093 * NULL: Never been used 1094 * HI_KEY_REMOVED: Entry was removed 1095 * Otherwise: Used item, pointer to the actual key; this usually is 1096 * inside the item, subtract an offset to locate the item. 1097 * This reduces the size of hashitem by 1/3. 1098 */ 1099 typedef struct hashitem_S 1100 { 1101 long_u hi_hash; /* cached hash number of hi_key */ 1102 char_u *hi_key; 1103 } hashitem_T; 1104 1105 /* The address of "hash_removed" is used as a magic number for hi_key to 1106 * indicate a removed item. */ 1107 #define HI_KEY_REMOVED &hash_removed 1108 #define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed) 1109 1110 /* Initial size for a hashtable. Our items are relatively small and growing 1111 * is expensive, thus use 16 as a start. Must be a power of 2. */ 1112 #define HT_INIT_SIZE 16 1113 1114 typedef struct hashtable_S 1115 { 1116 long_u ht_mask; /* mask used for hash value (nr of items in 1117 * array is "ht_mask" + 1) */ 1118 long_u ht_used; /* number of items used */ 1119 long_u ht_filled; /* number of items used + removed */ 1120 int ht_locked; /* counter for hash_lock() */ 1121 int ht_error; /* when set growing failed, can't add more 1122 items before growing works */ 1123 hashitem_T *ht_array; /* points to the array, allocated when it's 1124 not "ht_smallarray" */ 1125 hashitem_T ht_smallarray[HT_INIT_SIZE]; /* initial array */ 1126 } hashtab_T; 1127 1128 typedef long_u hash_T; /* Type for hi_hash */ 1129 1130 1131 #ifdef FEAT_NUM64 1132 /* Use 64-bit Number. */ 1133 # ifdef WIN3264 1134 # ifdef PROTO 1135 typedef long varnumber_T; 1136 typedef unsigned long uvarnumber_T; 1137 #define VARNUM_MIN LONG_MIN 1138 #define VARNUM_MAX LONG_MAX 1139 #define UVARNUM_MAX ULONG_MAX 1140 # else 1141 typedef __int64 varnumber_T; 1142 typedef unsigned __int64 uvarnumber_T; 1143 #define VARNUM_MIN _I64_MIN 1144 #define VARNUM_MAX _I64_MAX 1145 #define UVARNUM_MAX _UI64_MAX 1146 # endif 1147 # elif defined(HAVE_STDINT_H) 1148 typedef int64_t varnumber_T; 1149 typedef uint64_t uvarnumber_T; 1150 #define VARNUM_MIN INT64_MIN 1151 #define VARNUM_MAX INT64_MAX 1152 #define UVARNUM_MAX UINT64_MAX 1153 # else 1154 typedef long varnumber_T; 1155 typedef unsigned long uvarnumber_T; 1156 #define VARNUM_MIN LONG_MIN 1157 #define VARNUM_MAX LONG_MAX 1158 #define UVARNUM_MAX ULONG_MAX 1159 # endif 1160 #else 1161 /* Use 32-bit Number. */ 1162 # if VIM_SIZEOF_INT <= 3 /* use long if int is smaller than 32 bits */ 1163 typedef long varnumber_T; 1164 typedef unsigned long uvarnumber_T; 1165 #define VARNUM_MIN LONG_MIN 1166 #define VARNUM_MAX LONG_MAX 1167 #define UVARNUM_MAX ULONG_MAX 1168 # else 1169 typedef int varnumber_T; 1170 typedef unsigned int uvarnumber_T; 1171 #define VARNUM_MIN INT_MIN 1172 #define VARNUM_MAX INT_MAX 1173 #define UVARNUM_MAX UINT_MAX 1174 # endif 1175 #endif 1176 1177 typedef double float_T; 1178 1179 typedef struct listvar_S list_T; 1180 typedef struct dictvar_S dict_T; 1181 typedef struct partial_S partial_T; 1182 1183 typedef struct jobvar_S job_T; 1184 typedef struct readq_S readq_T; 1185 typedef struct writeq_S writeq_T; 1186 typedef struct jsonq_S jsonq_T; 1187 typedef struct cbq_S cbq_T; 1188 typedef struct channel_S channel_T; 1189 1190 typedef enum 1191 { 1192 VAR_UNKNOWN = 0, 1193 VAR_NUMBER, /* "v_number" is used */ 1194 VAR_STRING, /* "v_string" is used */ 1195 VAR_FUNC, /* "v_string" is function name */ 1196 VAR_PARTIAL, /* "v_partial" is used */ 1197 VAR_LIST, /* "v_list" is used */ 1198 VAR_DICT, /* "v_dict" is used */ 1199 VAR_FLOAT, /* "v_float" is used */ 1200 VAR_SPECIAL, /* "v_number" is used */ 1201 VAR_JOB, /* "v_job" is used */ 1202 VAR_CHANNEL /* "v_channel" is used */ 1203 } vartype_T; 1204 1205 /* 1206 * Structure to hold an internal variable without a name. 1207 */ 1208 typedef struct 1209 { 1210 vartype_T v_type; 1211 char v_lock; /* see below: VAR_LOCKED, VAR_FIXED */ 1212 union 1213 { 1214 varnumber_T v_number; /* number value */ 1215 #ifdef FEAT_FLOAT 1216 float_T v_float; /* floating number value */ 1217 #endif 1218 char_u *v_string; /* string value (can be NULL!) */ 1219 list_T *v_list; /* list value (can be NULL!) */ 1220 dict_T *v_dict; /* dict value (can be NULL!) */ 1221 partial_T *v_partial; /* closure: function with args */ 1222 #ifdef FEAT_JOB_CHANNEL 1223 job_T *v_job; /* job value (can be NULL!) */ 1224 channel_T *v_channel; /* channel value (can be NULL!) */ 1225 #endif 1226 } vval; 1227 } typval_T; 1228 1229 /* Values for "dv_scope". */ 1230 #define VAR_SCOPE 1 /* a:, v:, s:, etc. scope dictionaries */ 1231 #define VAR_DEF_SCOPE 2 /* l:, g: scope dictionaries: here funcrefs are not 1232 allowed to mask existing functions */ 1233 1234 /* Values for "v_lock". */ 1235 #define VAR_LOCKED 1 /* locked with lock(), can use unlock() */ 1236 #define VAR_FIXED 2 /* locked forever */ 1237 1238 /* 1239 * Structure to hold an item of a list: an internal variable without a name. 1240 */ 1241 typedef struct listitem_S listitem_T; 1242 1243 struct listitem_S 1244 { 1245 listitem_T *li_next; /* next item in list */ 1246 listitem_T *li_prev; /* previous item in list */ 1247 typval_T li_tv; /* type and value of the variable */ 1248 }; 1249 1250 /* 1251 * Struct used by those that are using an item in a list. 1252 */ 1253 typedef struct listwatch_S listwatch_T; 1254 1255 struct listwatch_S 1256 { 1257 listitem_T *lw_item; /* item being watched */ 1258 listwatch_T *lw_next; /* next watcher */ 1259 }; 1260 1261 /* 1262 * Structure to hold info about a list. 1263 * Order of members is optimized to reduce padding. 1264 */ 1265 struct listvar_S 1266 { 1267 listitem_T *lv_first; /* first item, NULL if none */ 1268 listitem_T *lv_last; /* last item, NULL if none */ 1269 listwatch_T *lv_watch; /* first watcher, NULL if none */ 1270 listitem_T *lv_idx_item; /* when not NULL item at index "lv_idx" */ 1271 list_T *lv_copylist; /* copied list used by deepcopy() */ 1272 list_T *lv_used_next; /* next list in used lists list */ 1273 list_T *lv_used_prev; /* previous list in used lists list */ 1274 int lv_refcount; /* reference count */ 1275 int lv_len; /* number of items */ 1276 int lv_idx; /* cached index of an item */ 1277 int lv_copyID; /* ID used by deepcopy() */ 1278 char lv_lock; /* zero, VAR_LOCKED, VAR_FIXED */ 1279 }; 1280 1281 /* 1282 * Static list with 10 items. Use init_static_list() to initialize. 1283 */ 1284 typedef struct { 1285 list_T sl_list; /* must be first */ 1286 listitem_T sl_items[10]; 1287 } staticList10_T; 1288 1289 /* 1290 * Structure to hold an item of a Dictionary. 1291 * Also used for a variable. 1292 * The key is copied into "di_key" to avoid an extra alloc/free for it. 1293 */ 1294 struct dictitem_S 1295 { 1296 typval_T di_tv; /* type and value of the variable */ 1297 char_u di_flags; /* flags (only used for variable) */ 1298 char_u di_key[1]; /* key (actually longer!) */ 1299 }; 1300 typedef struct dictitem_S dictitem_T; 1301 1302 /* A dictitem with a 16 character key (plus NUL). */ 1303 struct dictitem16_S 1304 { 1305 typval_T di_tv; /* type and value of the variable */ 1306 char_u di_flags; /* flags (only used for variable) */ 1307 char_u di_key[17]; /* key */ 1308 }; 1309 typedef struct dictitem16_S dictitem16_T; 1310 1311 #define DI_FLAGS_RO 1 /* "di_flags" value: read-only variable */ 1312 #define DI_FLAGS_RO_SBX 2 /* "di_flags" value: read-only in the sandbox */ 1313 #define DI_FLAGS_FIX 4 /* "di_flags" value: fixed: no :unlet or remove() */ 1314 #define DI_FLAGS_LOCK 8 /* "di_flags" value: locked variable */ 1315 #define DI_FLAGS_ALLOC 16 /* "di_flags" value: separately allocated */ 1316 1317 /* 1318 * Structure to hold info about a Dictionary. 1319 */ 1320 struct dictvar_S 1321 { 1322 char dv_lock; /* zero, VAR_LOCKED, VAR_FIXED */ 1323 char dv_scope; /* zero, VAR_SCOPE, VAR_DEF_SCOPE */ 1324 int dv_refcount; /* reference count */ 1325 int dv_copyID; /* ID used by deepcopy() */ 1326 hashtab_T dv_hashtab; /* hashtab that refers to the items */ 1327 dict_T *dv_copydict; /* copied dict used by deepcopy() */ 1328 dict_T *dv_used_next; /* next dict in used dicts list */ 1329 dict_T *dv_used_prev; /* previous dict in used dicts list */ 1330 }; 1331 1332 #if defined(FEAT_EVAL) || defined(PROTO) 1333 typedef struct funccall_S funccall_T; 1334 1335 /* 1336 * Structure to hold info for a user function. 1337 */ 1338 typedef struct 1339 { 1340 int uf_varargs; /* variable nr of arguments */ 1341 int uf_flags; 1342 int uf_calls; /* nr of active calls */ 1343 int uf_cleared; /* func_clear() was already called */ 1344 garray_T uf_args; /* arguments */ 1345 garray_T uf_lines; /* function lines */ 1346 #ifdef FEAT_PROFILE 1347 int uf_profiling; /* TRUE when func is being profiled */ 1348 /* profiling the function as a whole */ 1349 int uf_tm_count; /* nr of calls */ 1350 proftime_T uf_tm_total; /* time spent in function + children */ 1351 proftime_T uf_tm_self; /* time spent in function itself */ 1352 proftime_T uf_tm_children; /* time spent in children this call */ 1353 /* profiling the function per line */ 1354 int *uf_tml_count; /* nr of times line was executed */ 1355 proftime_T *uf_tml_total; /* time spent in a line + children */ 1356 proftime_T *uf_tml_self; /* time spent in a line itself */ 1357 proftime_T uf_tml_start; /* start time for current line */ 1358 proftime_T uf_tml_children; /* time spent in children for this line */ 1359 proftime_T uf_tml_wait; /* start wait time for current line */ 1360 int uf_tml_idx; /* index of line being timed; -1 if none */ 1361 int uf_tml_execed; /* line being timed was executed */ 1362 #endif 1363 scid_T uf_script_ID; /* ID of script where function was defined, 1364 used for s: variables */ 1365 int uf_refcount; /* reference count, see func_name_refcount() */ 1366 funccall_T *uf_scoped; /* l: local variables for closure */ 1367 char_u uf_name[1]; /* name of function (actually longer); can 1368 start with <SNR>123_ (<SNR> is K_SPECIAL 1369 KS_EXTRA KE_SNR) */ 1370 } ufunc_T; 1371 1372 #define MAX_FUNC_ARGS 20 /* maximum number of function arguments */ 1373 #define VAR_SHORT_LEN 20 /* short variable name length */ 1374 #define FIXVAR_CNT 12 /* number of fixed variables */ 1375 1376 /* structure to hold info for a function that is currently being executed. */ 1377 struct funccall_S 1378 { 1379 ufunc_T *func; /* function being called */ 1380 int linenr; /* next line to be executed */ 1381 int returned; /* ":return" used */ 1382 struct /* fixed variables for arguments */ 1383 { 1384 dictitem_T var; /* variable (without room for name) */ 1385 char_u room[VAR_SHORT_LEN]; /* room for the name */ 1386 } fixvar[FIXVAR_CNT]; 1387 dict_T l_vars; /* l: local function variables */ 1388 dictitem_T l_vars_var; /* variable for l: scope */ 1389 dict_T l_avars; /* a: argument variables */ 1390 dictitem_T l_avars_var; /* variable for a: scope */ 1391 list_T l_varlist; /* list for a:000 */ 1392 listitem_T l_listitems[MAX_FUNC_ARGS]; /* listitems for a:000 */ 1393 typval_T *rettv; /* return value */ 1394 linenr_T breakpoint; /* next line with breakpoint or zero */ 1395 int dbg_tick; /* debug_tick when breakpoint was set */ 1396 int level; /* top nesting level of executed function */ 1397 #ifdef FEAT_PROFILE 1398 proftime_T prof_child; /* time spent in a child */ 1399 #endif 1400 funccall_T *caller; /* calling function or NULL */ 1401 1402 /* for closure */ 1403 int fc_refcount; /* number of user functions that reference this 1404 * funccal */ 1405 int fc_copyID; /* for garbage collection */ 1406 garray_T fc_funcs; /* list of ufunc_T* which keep a reference to 1407 * "func" */ 1408 }; 1409 1410 /* 1411 * Struct used by trans_function_name() 1412 */ 1413 typedef struct 1414 { 1415 dict_T *fd_dict; /* Dictionary used */ 1416 char_u *fd_newkey; /* new key in "dict" in allocated memory */ 1417 dictitem_T *fd_di; /* Dictionary item used */ 1418 } funcdict_T; 1419 1420 #else 1421 /* dummy typedefs for function prototypes */ 1422 typedef struct 1423 { 1424 int dummy; 1425 } ufunc_T; 1426 typedef struct 1427 { 1428 int dummy; 1429 } funcdict_T; 1430 #endif 1431 1432 struct partial_S 1433 { 1434 int pt_refcount; /* reference count */ 1435 char_u *pt_name; /* function name; when NULL use 1436 * pt_func->uf_name */ 1437 ufunc_T *pt_func; /* function pointer; when NULL lookup function 1438 * with pt_name */ 1439 int pt_auto; /* when TRUE the partial was created for using 1440 dict.member in handle_subscript() */ 1441 int pt_argc; /* number of arguments */ 1442 typval_T *pt_argv; /* arguments in allocated array */ 1443 dict_T *pt_dict; /* dict for "self" */ 1444 }; 1445 1446 /* Information returned by get_tty_info(). */ 1447 typedef struct { 1448 int backspace; /* what the Backspace key produces */ 1449 int enter; /* what the Enter key produces */ 1450 int interrupt; /* interrupt character */ 1451 int nl_does_cr; /* TRUE when a NL is expanded to CR-NL on output */ 1452 } ttyinfo_T; 1453 1454 /* Status of a job. Order matters! */ 1455 typedef enum 1456 { 1457 JOB_FAILED, 1458 JOB_STARTED, 1459 JOB_ENDED, /* detected job done */ 1460 JOB_FINISHED /* job done and cleanup done */ 1461 } jobstatus_T; 1462 1463 /* 1464 * Structure to hold info about a Job. 1465 */ 1466 struct jobvar_S 1467 { 1468 job_T *jv_next; 1469 job_T *jv_prev; 1470 #ifdef UNIX 1471 pid_t jv_pid; 1472 #endif 1473 #ifdef WIN32 1474 PROCESS_INFORMATION jv_proc_info; 1475 HANDLE jv_job_object; 1476 #endif 1477 char_u *jv_tty_in; /* controlling tty input, allocated */ 1478 char_u *jv_tty_out; /* controlling tty output, allocated */ 1479 jobstatus_T jv_status; 1480 char_u *jv_stoponexit; /* allocated */ 1481 int jv_exitval; 1482 char_u *jv_exit_cb; /* allocated */ 1483 partial_T *jv_exit_partial; 1484 1485 buf_T *jv_in_buf; /* buffer from "in-name" */ 1486 1487 int jv_refcount; /* reference count */ 1488 int jv_copyID; 1489 1490 channel_T *jv_channel; /* channel for I/O, reference counted */ 1491 }; 1492 1493 /* 1494 * Structures to hold info about a Channel. 1495 */ 1496 struct readq_S 1497 { 1498 char_u *rq_buffer; 1499 long_u rq_buflen; 1500 readq_T *rq_next; 1501 readq_T *rq_prev; 1502 }; 1503 1504 struct writeq_S 1505 { 1506 garray_T wq_ga; 1507 writeq_T *wq_next; 1508 writeq_T *wq_prev; 1509 }; 1510 1511 struct jsonq_S 1512 { 1513 typval_T *jq_value; 1514 jsonq_T *jq_next; 1515 jsonq_T *jq_prev; 1516 int jq_no_callback; /* TRUE when no callback was found */ 1517 }; 1518 1519 struct cbq_S 1520 { 1521 char_u *cq_callback; 1522 partial_T *cq_partial; 1523 int cq_seq_nr; 1524 cbq_T *cq_next; 1525 cbq_T *cq_prev; 1526 }; 1527 1528 /* mode for a channel */ 1529 typedef enum 1530 { 1531 MODE_NL = 0, 1532 MODE_RAW, 1533 MODE_JSON, 1534 MODE_JS 1535 } ch_mode_T; 1536 1537 typedef enum { 1538 JIO_PIPE, /* default */ 1539 JIO_NULL, 1540 JIO_FILE, 1541 JIO_BUFFER, 1542 JIO_OUT 1543 } job_io_T; 1544 1545 #define CH_PART_FD(part) ch_part[part].ch_fd 1546 1547 /* Ordering matters, it is used in for loops: IN is last, only SOCK/OUT/ERR 1548 * are polled. */ 1549 typedef enum { 1550 PART_SOCK = 0, 1551 #define CH_SOCK_FD CH_PART_FD(PART_SOCK) 1552 #ifdef FEAT_JOB_CHANNEL 1553 PART_OUT, 1554 # define CH_OUT_FD CH_PART_FD(PART_OUT) 1555 PART_ERR, 1556 # define CH_ERR_FD CH_PART_FD(PART_ERR) 1557 PART_IN, 1558 # define CH_IN_FD CH_PART_FD(PART_IN) 1559 #endif 1560 PART_COUNT 1561 } ch_part_T; 1562 1563 #define INVALID_FD (-1) 1564 1565 /* The per-fd info for a channel. */ 1566 typedef struct { 1567 sock_T ch_fd; /* socket/stdin/stdout/stderr, -1 if not used */ 1568 1569 # if defined(UNIX) && !defined(HAVE_SELECT) 1570 int ch_poll_idx; /* used by channel_poll_setup() */ 1571 # endif 1572 1573 #ifdef FEAT_GUI_X11 1574 XtInputId ch_inputHandler; /* Cookie for input */ 1575 #endif 1576 #ifdef FEAT_GUI_GTK 1577 gint ch_inputHandler; /* Cookie for input */ 1578 #endif 1579 1580 ch_mode_T ch_mode; 1581 job_io_T ch_io; 1582 int ch_timeout; /* request timeout in msec */ 1583 1584 readq_T ch_head; /* header for circular raw read queue */ 1585 jsonq_T ch_json_head; /* header for circular json read queue */ 1586 int ch_block_id; /* ID that channel_read_json_block() is 1587 waiting for */ 1588 /* When ch_wait_len is non-zero use ch_deadline to wait for incomplete 1589 * message to be complete. The value is the length of the incomplete 1590 * message when the deadline was set. If it gets longer (something was 1591 * received) the deadline is reset. */ 1592 size_t ch_wait_len; 1593 #ifdef WIN32 1594 DWORD ch_deadline; 1595 #else 1596 struct timeval ch_deadline; 1597 #endif 1598 int ch_block_write; /* for testing: 0 when not used, -1 when write 1599 * does not block, 1 simulate blocking */ 1600 int ch_nonblocking; /* write() is non-blocking */ 1601 writeq_T ch_writeque; /* header for write queue */ 1602 1603 cbq_T ch_cb_head; /* dummy node for per-request callbacks */ 1604 char_u *ch_callback; /* call when a msg is not handled */ 1605 partial_T *ch_partial; 1606 1607 bufref_T ch_bufref; /* buffer to read from or write to */ 1608 int ch_nomodifiable; /* TRUE when buffer can be 'nomodifiable' */ 1609 int ch_nomod_error; /* TRUE when e_modifiable was given */ 1610 int ch_buf_append; /* write appended lines instead top-bot */ 1611 linenr_T ch_buf_top; /* next line to send */ 1612 linenr_T ch_buf_bot; /* last line to send */ 1613 } chanpart_T; 1614 1615 struct channel_S { 1616 channel_T *ch_next; 1617 channel_T *ch_prev; 1618 1619 int ch_id; /* ID of the channel */ 1620 int ch_last_msg_id; /* ID of the last message */ 1621 1622 chanpart_T ch_part[PART_COUNT]; /* info for socket, out, err and in */ 1623 int ch_write_text_mode; /* write buffer lines with CR, not NL */ 1624 1625 char *ch_hostname; /* only for socket, allocated */ 1626 int ch_port; /* only for socket */ 1627 1628 int ch_to_be_closed; /* bitset of readable fds to be closed. 1629 * When all readable fds have been closed, 1630 * set to (1 << PART_COUNT). */ 1631 int ch_to_be_freed; /* When TRUE channel must be freed when it's 1632 * safe to invoke callbacks. */ 1633 int ch_error; /* When TRUE an error was reported. Avoids 1634 * giving pages full of error messages when 1635 * the other side has exited, only mention the 1636 * first error until the connection works 1637 * again. */ 1638 1639 void (*ch_nb_close_cb)(void); 1640 /* callback for Netbeans when channel is 1641 * closed */ 1642 1643 #ifdef WIN32 1644 int ch_named_pipe; /* using named pipe instead of pty */ 1645 #endif 1646 char_u *ch_callback; /* call when any msg is not handled */ 1647 partial_T *ch_partial; 1648 char_u *ch_close_cb; /* call when channel is closed */ 1649 partial_T *ch_close_partial; 1650 int ch_drop_never; 1651 int ch_keep_open; /* do not close on read error */ 1652 1653 job_T *ch_job; /* Job that uses this channel; this does not 1654 * count as a reference to avoid a circular 1655 * reference, the job refers to the channel. */ 1656 int ch_job_killed; /* TRUE when there was a job and it was killed 1657 * or we know it died. */ 1658 1659 int ch_refcount; /* reference count */ 1660 int ch_copyID; 1661 }; 1662 1663 #define JO_MODE 0x0001 /* channel mode */ 1664 #define JO_IN_MODE 0x0002 /* stdin mode */ 1665 #define JO_OUT_MODE 0x0004 /* stdout mode */ 1666 #define JO_ERR_MODE 0x0008 /* stderr mode */ 1667 #define JO_CALLBACK 0x0010 /* channel callback */ 1668 #define JO_OUT_CALLBACK 0x0020 /* stdout callback */ 1669 #define JO_ERR_CALLBACK 0x0040 /* stderr callback */ 1670 #define JO_CLOSE_CALLBACK 0x0080 /* "close_cb" */ 1671 #define JO_WAITTIME 0x0100 /* only for ch_open() */ 1672 #define JO_TIMEOUT 0x0200 /* all timeouts */ 1673 #define JO_OUT_TIMEOUT 0x0400 /* stdout timeouts */ 1674 #define JO_ERR_TIMEOUT 0x0800 /* stderr timeouts */ 1675 #define JO_PART 0x1000 /* "part" */ 1676 #define JO_ID 0x2000 /* "id" */ 1677 #define JO_STOPONEXIT 0x4000 /* "stoponexit" */ 1678 #define JO_EXIT_CB 0x8000 /* "exit_cb" */ 1679 #define JO_OUT_IO 0x10000 /* "out_io" */ 1680 #define JO_ERR_IO 0x20000 /* "err_io" (JO_OUT_IO << 1) */ 1681 #define JO_IN_IO 0x40000 /* "in_io" (JO_OUT_IO << 2) */ 1682 #define JO_OUT_NAME 0x80000 /* "out_name" */ 1683 #define JO_ERR_NAME 0x100000 /* "err_name" (JO_OUT_NAME << 1) */ 1684 #define JO_IN_NAME 0x200000 /* "in_name" (JO_OUT_NAME << 2) */ 1685 #define JO_IN_TOP 0x400000 /* "in_top" */ 1686 #define JO_IN_BOT 0x800000 /* "in_bot" */ 1687 #define JO_OUT_BUF 0x1000000 /* "out_buf" */ 1688 #define JO_ERR_BUF 0x2000000 /* "err_buf" (JO_OUT_BUF << 1) */ 1689 #define JO_IN_BUF 0x4000000 /* "in_buf" (JO_OUT_BUF << 2) */ 1690 #define JO_CHANNEL 0x8000000 /* "channel" */ 1691 #define JO_BLOCK_WRITE 0x10000000 /* "block_write" */ 1692 #define JO_OUT_MODIFIABLE 0x20000000 /* "out_modifiable" */ 1693 #define JO_ERR_MODIFIABLE 0x40000000 /* "err_modifiable" (JO_OUT_ << 1) */ 1694 #define JO_ALL 0x7fffffff 1695 1696 #define JO2_OUT_MSG 0x0001 /* "out_msg" */ 1697 #define JO2_ERR_MSG 0x0002 /* "err_msg" (JO_OUT_ << 1) */ 1698 #define JO2_TERM_NAME 0x0004 /* "term_name" */ 1699 #define JO2_TERM_FINISH 0x0008 /* "term_finish" */ 1700 #define JO2_ENV 0x0010 /* "env" */ 1701 #define JO2_CWD 0x0020 /* "cwd" */ 1702 #define JO2_TERM_ROWS 0x0040 /* "term_rows" */ 1703 #define JO2_TERM_COLS 0x0080 /* "term_cols" */ 1704 #define JO2_VERTICAL 0x0100 /* "vertical" */ 1705 #define JO2_CURWIN 0x0200 /* "curwin" */ 1706 #define JO2_HIDDEN 0x0400 /* "hidden" */ 1707 #define JO2_TERM_OPENCMD 0x0800 /* "term_opencmd" */ 1708 #define JO2_EOF_CHARS 0x1000 /* "eof_chars" */ 1709 #define JO2_NORESTORE 0x2000 /* "norestore" */ 1710 #define JO2_TERM_KILL 0x4000 /* "term_kill" */ 1711 #define JO2_ALL 0x7FFF 1712 1713 #define JO_MODE_ALL (JO_MODE + JO_IN_MODE + JO_OUT_MODE + JO_ERR_MODE) 1714 #define JO_CB_ALL \ 1715 (JO_CALLBACK + JO_OUT_CALLBACK + JO_ERR_CALLBACK + JO_CLOSE_CALLBACK) 1716 #define JO_TIMEOUT_ALL (JO_TIMEOUT + JO_OUT_TIMEOUT + JO_ERR_TIMEOUT) 1717 1718 /* 1719 * Options for job and channel commands. 1720 */ 1721 typedef struct 1722 { 1723 int jo_set; /* JO_ bits for values that were set */ 1724 int jo_set2; /* JO2_ bits for values that were set */ 1725 1726 ch_mode_T jo_mode; 1727 ch_mode_T jo_in_mode; 1728 ch_mode_T jo_out_mode; 1729 ch_mode_T jo_err_mode; 1730 1731 job_io_T jo_io[4]; /* PART_OUT, PART_ERR, PART_IN */ 1732 char_u jo_io_name_buf[4][NUMBUFLEN]; 1733 char_u *jo_io_name[4]; /* not allocated! */ 1734 int jo_io_buf[4]; 1735 int jo_pty; 1736 int jo_modifiable[4]; 1737 int jo_message[4]; 1738 channel_T *jo_channel; 1739 1740 linenr_T jo_in_top; 1741 linenr_T jo_in_bot; 1742 1743 char_u *jo_callback; /* not allocated! */ 1744 partial_T *jo_partial; /* not referenced! */ 1745 char_u *jo_out_cb; /* not allocated! */ 1746 partial_T *jo_out_partial; /* not referenced! */ 1747 char_u *jo_err_cb; /* not allocated! */ 1748 partial_T *jo_err_partial; /* not referenced! */ 1749 char_u *jo_close_cb; /* not allocated! */ 1750 partial_T *jo_close_partial; /* not referenced! */ 1751 char_u *jo_exit_cb; /* not allocated! */ 1752 partial_T *jo_exit_partial; /* not referenced! */ 1753 int jo_drop_never; 1754 int jo_waittime; 1755 int jo_timeout; 1756 int jo_out_timeout; 1757 int jo_err_timeout; 1758 int jo_block_write; /* for testing only */ 1759 int jo_part; 1760 int jo_id; 1761 char_u jo_soe_buf[NUMBUFLEN]; 1762 char_u *jo_stoponexit; 1763 dict_T *jo_env; /* environment variables */ 1764 char_u jo_cwd_buf[NUMBUFLEN]; 1765 char_u *jo_cwd; 1766 1767 #ifdef FEAT_TERMINAL 1768 /* when non-zero run the job in a terminal window of this size */ 1769 int jo_term_rows; 1770 int jo_term_cols; 1771 int jo_vertical; 1772 int jo_curwin; 1773 int jo_hidden; 1774 int jo_term_norestore; 1775 char_u *jo_term_name; 1776 char_u *jo_term_opencmd; 1777 int jo_term_finish; 1778 char_u *jo_eof_chars; 1779 char_u *jo_term_kill; 1780 #endif 1781 } jobopt_T; 1782 1783 1784 /* structure used for explicit stack while garbage collecting hash tables */ 1785 typedef struct ht_stack_S 1786 { 1787 hashtab_T *ht; 1788 struct ht_stack_S *prev; 1789 } ht_stack_T; 1790 1791 /* structure used for explicit stack while garbage collecting lists */ 1792 typedef struct list_stack_S 1793 { 1794 list_T *list; 1795 struct list_stack_S *prev; 1796 } list_stack_T; 1797 1798 /* values for b_syn_spell: what to do with toplevel text */ 1799 #define SYNSPL_DEFAULT 0 /* spell check if @Spell not defined */ 1800 #define SYNSPL_TOP 1 /* spell check toplevel text */ 1801 #define SYNSPL_NOTOP 2 /* don't spell check toplevel text */ 1802 1803 /* avoid #ifdefs for when b_spell is not available */ 1804 #ifdef FEAT_SPELL 1805 # define B_SPELL(buf) ((buf)->b_spell) 1806 #else 1807 # define B_SPELL(buf) (0) 1808 #endif 1809 1810 #ifdef FEAT_QUICKFIX 1811 typedef struct qf_info_S qf_info_T; 1812 #endif 1813 1814 #ifdef FEAT_PROFILE 1815 /* 1816 * Used for :syntime: timing of executing a syntax pattern. 1817 */ 1818 typedef struct { 1819 proftime_T total; /* total time used */ 1820 proftime_T slowest; /* time of slowest call */ 1821 long count; /* nr of times used */ 1822 long match; /* nr of times matched */ 1823 } syn_time_T; 1824 #endif 1825 1826 #ifdef FEAT_CRYPT 1827 /* 1828 * Structure to hold the type of encryption and the state of encryption or 1829 * decryption. 1830 */ 1831 typedef struct { 1832 int method_nr; 1833 void *method_state; /* method-specific state information */ 1834 } cryptstate_T; 1835 1836 /* values for method_nr */ 1837 # define CRYPT_M_ZIP 0 1838 # define CRYPT_M_BF 1 1839 # define CRYPT_M_BF2 2 1840 # define CRYPT_M_COUNT 3 /* number of crypt methods */ 1841 #endif 1842 1843 1844 /* 1845 * These are items normally related to a buffer. But when using ":ownsyntax" 1846 * a window may have its own instance. 1847 */ 1848 typedef struct { 1849 #ifdef FEAT_SYN_HL 1850 hashtab_T b_keywtab; /* syntax keywords hash table */ 1851 hashtab_T b_keywtab_ic; /* idem, ignore case */ 1852 int b_syn_error; /* TRUE when error occurred in HL */ 1853 # ifdef FEAT_RELTIME 1854 int b_syn_slow; /* TRUE when 'redrawtime' reached */ 1855 # endif 1856 int b_syn_ic; /* ignore case for :syn cmds */ 1857 int b_syn_spell; /* SYNSPL_ values */ 1858 garray_T b_syn_patterns; /* table for syntax patterns */ 1859 garray_T b_syn_clusters; /* table for syntax clusters */ 1860 int b_spell_cluster_id; /* @Spell cluster ID or 0 */ 1861 int b_nospell_cluster_id; /* @NoSpell cluster ID or 0 */ 1862 int b_syn_containedin; /* TRUE when there is an item with a 1863 "containedin" argument */ 1864 int b_syn_sync_flags; /* flags about how to sync */ 1865 short b_syn_sync_id; /* group to sync on */ 1866 long b_syn_sync_minlines; /* minimal sync lines offset */ 1867 long b_syn_sync_maxlines; /* maximal sync lines offset */ 1868 long b_syn_sync_linebreaks; /* offset for multi-line pattern */ 1869 char_u *b_syn_linecont_pat; /* line continuation pattern */ 1870 regprog_T *b_syn_linecont_prog; /* line continuation program */ 1871 #ifdef FEAT_PROFILE 1872 syn_time_T b_syn_linecont_time; 1873 #endif 1874 int b_syn_linecont_ic; /* ignore-case flag for above */ 1875 int b_syn_topgrp; /* for ":syntax include" */ 1876 # ifdef FEAT_CONCEAL 1877 int b_syn_conceal; /* auto-conceal for :syn cmds */ 1878 # endif 1879 # ifdef FEAT_FOLDING 1880 int b_syn_folditems; /* number of patterns with the HL_FOLD 1881 flag set */ 1882 # endif 1883 /* 1884 * b_sst_array[] contains the state stack for a number of lines, for the 1885 * start of that line (col == 0). This avoids having to recompute the 1886 * syntax state too often. 1887 * b_sst_array[] is allocated to hold the state for all displayed lines, 1888 * and states for 1 out of about 20 other lines. 1889 * b_sst_array pointer to an array of synstate_T 1890 * b_sst_len number of entries in b_sst_array[] 1891 * b_sst_first pointer to first used entry in b_sst_array[] or NULL 1892 * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL 1893 * b_sst_freecount number of free entries in b_sst_array[] 1894 * b_sst_check_lnum entries after this lnum need to be checked for 1895 * validity (MAXLNUM means no check needed) 1896 */ 1897 synstate_T *b_sst_array; 1898 int b_sst_len; 1899 synstate_T *b_sst_first; 1900 synstate_T *b_sst_firstfree; 1901 int b_sst_freecount; 1902 linenr_T b_sst_check_lnum; 1903 short_u b_sst_lasttick; /* last display tick */ 1904 #endif /* FEAT_SYN_HL */ 1905 1906 #ifdef FEAT_SPELL 1907 /* for spell checking */ 1908 garray_T b_langp; /* list of pointers to slang_T, see spell.c */ 1909 char_u b_spell_ismw[256];/* flags: is midword char */ 1910 # ifdef FEAT_MBYTE 1911 char_u *b_spell_ismw_mb; /* multi-byte midword chars */ 1912 # endif 1913 char_u *b_p_spc; /* 'spellcapcheck' */ 1914 regprog_T *b_cap_prog; /* program for 'spellcapcheck' */ 1915 char_u *b_p_spf; /* 'spellfile' */ 1916 char_u *b_p_spl; /* 'spelllang' */ 1917 # ifdef FEAT_MBYTE 1918 int b_cjk; /* all CJK letters as OK */ 1919 # endif 1920 #endif 1921 #if !defined(FEAT_SYN_HL) && !defined(FEAT_SPELL) 1922 int dummy; 1923 #endif 1924 char_u b_syn_chartab[32]; /* syntax iskeyword option */ 1925 char_u *b_syn_isk; /* iskeyword option */ 1926 } synblock_T; 1927 1928 1929 /* 1930 * buffer: structure that holds information about one file 1931 * 1932 * Several windows can share a single Buffer 1933 * A buffer is unallocated if there is no memfile for it. 1934 * A buffer is new if the associated file has never been loaded yet. 1935 */ 1936 1937 struct file_buffer 1938 { 1939 memline_T b_ml; /* associated memline (also contains line 1940 count) */ 1941 1942 buf_T *b_next; /* links in list of buffers */ 1943 buf_T *b_prev; 1944 1945 int b_nwindows; /* nr of windows open on this buffer */ 1946 1947 int b_flags; /* various BF_ flags */ 1948 int b_locked; /* Buffer is being closed or referenced, don't 1949 let autocommands wipe it out. */ 1950 1951 /* 1952 * b_ffname has the full path of the file (NULL for no name). 1953 * b_sfname is the name as the user typed it (or NULL). 1954 * b_fname is the same as b_sfname, unless ":cd" has been done, 1955 * then it is the same as b_ffname (NULL for no name). 1956 */ 1957 char_u *b_ffname; /* full path file name */ 1958 char_u *b_sfname; /* short file name */ 1959 char_u *b_fname; /* current file name */ 1960 1961 #ifdef UNIX 1962 int b_dev_valid; /* TRUE when b_dev has a valid number */ 1963 dev_t b_dev; /* device number */ 1964 ino_t b_ino; /* inode number */ 1965 #endif 1966 #ifdef FEAT_CW_EDITOR 1967 FSSpec b_FSSpec; /* MacOS File Identification */ 1968 #endif 1969 #ifdef VMS 1970 char b_fab_rfm; /* Record format */ 1971 char b_fab_rat; /* Record attribute */ 1972 unsigned int b_fab_mrs; /* Max record size */ 1973 #endif 1974 int b_fnum; /* buffer number for this file. */ 1975 char_u b_key[VIM_SIZEOF_INT * 2 + 1]; 1976 /* key used for buf_hashtab, holds b_fnum as 1977 hex string */ 1978 1979 int b_changed; /* 'modified': Set to TRUE if something in the 1980 file has been changed and not written out. */ 1981 dictitem16_T b_ct_di; /* holds the b:changedtick value in 1982 b_ct_di.di_tv.vval.v_number; 1983 incremented for each change, also for undo */ 1984 #define CHANGEDTICK(buf) ((buf)->b_ct_di.di_tv.vval.v_number) 1985 1986 varnumber_T b_last_changedtick; /* b:changedtick when TextChanged or 1987 TextChangedI was last triggered. */ 1988 #ifdef FEAT_INS_EXPAND 1989 varnumber_T b_last_changedtick_pum; /* b:changedtick when TextChangedP was 1990 last triggered. */ 1991 #endif 1992 1993 int b_saving; /* Set to TRUE if we are in the middle of 1994 saving the buffer. */ 1995 1996 /* 1997 * Changes to a buffer require updating of the display. To minimize the 1998 * work, remember changes made and update everything at once. 1999 */ 2000 int b_mod_set; /* TRUE when there are changes since the last 2001 time the display was updated */ 2002 linenr_T b_mod_top; /* topmost lnum that was changed */ 2003 linenr_T b_mod_bot; /* lnum below last changed line, AFTER the 2004 change */ 2005 long b_mod_xlines; /* number of extra buffer lines inserted; 2006 negative when lines were deleted */ 2007 2008 wininfo_T *b_wininfo; /* list of last used info for each window */ 2009 2010 long b_mtime; /* last change time of original file */ 2011 long b_mtime_read; /* last change time when reading */ 2012 off_T b_orig_size; /* size of original file in bytes */ 2013 int b_orig_mode; /* mode of original file */ 2014 #ifdef FEAT_VIMINFO 2015 time_T b_last_used; /* time when the buffer was last used; used 2016 * for viminfo */ 2017 #endif 2018 2019 pos_T b_namedm[NMARKS]; /* current named marks (mark.c) */ 2020 2021 /* These variables are set when VIsual_active becomes FALSE */ 2022 visualinfo_T b_visual; 2023 #ifdef FEAT_EVAL 2024 int b_visual_mode_eval; /* b_visual.vi_mode for visualmode() */ 2025 #endif 2026 2027 pos_T b_last_cursor; /* cursor position when last unloading this 2028 buffer */ 2029 pos_T b_last_insert; /* where Insert mode was left */ 2030 pos_T b_last_change; /* position of last change: '. mark */ 2031 2032 #ifdef FEAT_JUMPLIST 2033 /* 2034 * the changelist contains old change positions 2035 */ 2036 pos_T b_changelist[JUMPLISTSIZE]; 2037 int b_changelistlen; /* number of active entries */ 2038 int b_new_change; /* set by u_savecommon() */ 2039 #endif 2040 2041 /* 2042 * Character table, only used in charset.c for 'iskeyword' 2043 * 32 bytes of 8 bits: 1 bit per character 0-255. 2044 */ 2045 char_u b_chartab[32]; 2046 2047 #ifdef FEAT_LOCALMAP 2048 /* Table used for mappings local to a buffer. */ 2049 mapblock_T *(b_maphash[256]); 2050 2051 /* First abbreviation local to a buffer. */ 2052 mapblock_T *b_first_abbr; 2053 #endif 2054 #ifdef FEAT_USR_CMDS 2055 /* User commands local to the buffer. */ 2056 garray_T b_ucmds; 2057 #endif 2058 /* 2059 * start and end of an operator, also used for '[ and '] 2060 */ 2061 pos_T b_op_start; 2062 pos_T b_op_start_orig; /* used for Insstart_orig */ 2063 pos_T b_op_end; 2064 2065 #ifdef FEAT_VIMINFO 2066 int b_marks_read; /* Have we read viminfo marks yet? */ 2067 #endif 2068 2069 /* 2070 * The following only used in undo.c. 2071 */ 2072 u_header_T *b_u_oldhead; /* pointer to oldest header */ 2073 u_header_T *b_u_newhead; /* pointer to newest header; may not be valid 2074 if b_u_curhead is not NULL */ 2075 u_header_T *b_u_curhead; /* pointer to current header */ 2076 int b_u_numhead; /* current number of headers */ 2077 int b_u_synced; /* entry lists are synced */ 2078 long b_u_seq_last; /* last used undo sequence number */ 2079 long b_u_save_nr_last; /* counter for last file write */ 2080 long b_u_seq_cur; /* hu_seq of header below which we are now */ 2081 time_T b_u_time_cur; /* uh_time of header below which we are now */ 2082 long b_u_save_nr_cur; /* file write nr after which we are now */ 2083 2084 /* 2085 * variables for "U" command in undo.c 2086 */ 2087 char_u *b_u_line_ptr; /* saved line for "U" command */ 2088 linenr_T b_u_line_lnum; /* line number of line in u_line */ 2089 colnr_T b_u_line_colnr; /* optional column number */ 2090 2091 #ifdef FEAT_INS_EXPAND 2092 int b_scanned; /* ^N/^P have scanned this buffer */ 2093 #endif 2094 2095 /* flags for use of ":lmap" and IM control */ 2096 long b_p_iminsert; /* input mode for insert */ 2097 long b_p_imsearch; /* input mode for search */ 2098 #define B_IMODE_USE_INSERT -1 /* Use b_p_iminsert value for search */ 2099 #define B_IMODE_NONE 0 /* Input via none */ 2100 #define B_IMODE_LMAP 1 /* Input via langmap */ 2101 #define B_IMODE_IM 2 /* Input via input method */ 2102 #define B_IMODE_LAST 2 2103 2104 #ifdef FEAT_KEYMAP 2105 short b_kmap_state; /* using "lmap" mappings */ 2106 # define KEYMAP_INIT 1 /* 'keymap' was set, call keymap_init() */ 2107 # define KEYMAP_LOADED 2 /* 'keymap' mappings have been loaded */ 2108 garray_T b_kmap_ga; /* the keymap table */ 2109 #endif 2110 2111 /* 2112 * Options local to a buffer. 2113 * They are here because their value depends on the type of file 2114 * or contents of the file being edited. 2115 */ 2116 int b_p_initialized; /* set when options initialized */ 2117 2118 #ifdef FEAT_EVAL 2119 int b_p_scriptID[BV_COUNT]; /* SIDs for buffer-local options */ 2120 #endif 2121 2122 int b_p_ai; /* 'autoindent' */ 2123 int b_p_ai_nopaste; /* b_p_ai saved for paste mode */ 2124 char_u *b_p_bkc; /* 'backupcopy' */ 2125 unsigned b_bkc_flags; /* flags for 'backupcopy' */ 2126 int b_p_ci; /* 'copyindent' */ 2127 int b_p_bin; /* 'binary' */ 2128 #ifdef FEAT_MBYTE 2129 int b_p_bomb; /* 'bomb' */ 2130 #endif 2131 char_u *b_p_bh; /* 'bufhidden' */ 2132 char_u *b_p_bt; /* 'buftype' */ 2133 #ifdef FEAT_QUICKFIX 2134 #define BUF_HAS_QF_ENTRY 1 2135 #define BUF_HAS_LL_ENTRY 2 2136 int b_has_qf_entry; 2137 #endif 2138 int b_p_bl; /* 'buflisted' */ 2139 #ifdef FEAT_CINDENT 2140 int b_p_cin; /* 'cindent' */ 2141 char_u *b_p_cino; /* 'cinoptions' */ 2142 char_u *b_p_cink; /* 'cinkeys' */ 2143 #endif 2144 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT) 2145 char_u *b_p_cinw; /* 'cinwords' */ 2146 #endif 2147 #ifdef FEAT_COMMENTS 2148 char_u *b_p_com; /* 'comments' */ 2149 #endif 2150 #ifdef FEAT_FOLDING 2151 char_u *b_p_cms; /* 'commentstring' */ 2152 #endif 2153 #ifdef FEAT_INS_EXPAND 2154 char_u *b_p_cpt; /* 'complete' */ 2155 #endif 2156 #ifdef FEAT_COMPL_FUNC 2157 char_u *b_p_cfu; /* 'completefunc' */ 2158 char_u *b_p_ofu; /* 'omnifunc' */ 2159 #endif 2160 int b_p_eol; /* 'endofline' */ 2161 int b_p_fixeol; /* 'fixendofline' */ 2162 int b_p_et; /* 'expandtab' */ 2163 int b_p_et_nobin; /* b_p_et saved for binary mode */ 2164 int b_p_et_nopaste; /* b_p_et saved for paste mode */ 2165 #ifdef FEAT_MBYTE 2166 char_u *b_p_fenc; /* 'fileencoding' */ 2167 #endif 2168 char_u *b_p_ff; /* 'fileformat' */ 2169 char_u *b_p_ft; /* 'filetype' */ 2170 char_u *b_p_fo; /* 'formatoptions' */ 2171 char_u *b_p_flp; /* 'formatlistpat' */ 2172 int b_p_inf; /* 'infercase' */ 2173 char_u *b_p_isk; /* 'iskeyword' */ 2174 #ifdef FEAT_FIND_ID 2175 char_u *b_p_def; /* 'define' local value */ 2176 char_u *b_p_inc; /* 'include' */ 2177 # ifdef FEAT_EVAL 2178 char_u *b_p_inex; /* 'includeexpr' */ 2179 long_u b_p_inex_flags; /* flags for 'includeexpr' */ 2180 # endif 2181 #endif 2182 #if defined(FEAT_CINDENT) && defined(FEAT_EVAL) 2183 char_u *b_p_inde; /* 'indentexpr' */ 2184 long_u b_p_inde_flags; /* flags for 'indentexpr' */ 2185 char_u *b_p_indk; /* 'indentkeys' */ 2186 #endif 2187 char_u *b_p_fp; /* 'formatprg' */ 2188 #if defined(FEAT_EVAL) 2189 char_u *b_p_fex; /* 'formatexpr' */ 2190 long_u b_p_fex_flags; /* flags for 'formatexpr' */ 2191 #endif 2192 #ifdef FEAT_CRYPT 2193 char_u *b_p_key; /* 'key' */ 2194 #endif 2195 char_u *b_p_kp; /* 'keywordprg' */ 2196 #ifdef FEAT_LISP 2197 int b_p_lisp; /* 'lisp' */ 2198 #endif 2199 #ifdef FEAT_MBYTE 2200 char_u *b_p_menc; /* 'makeencoding' */ 2201 #endif 2202 char_u *b_p_mps; /* 'matchpairs' */ 2203 int b_p_ml; /* 'modeline' */ 2204 int b_p_ml_nobin; /* b_p_ml saved for binary mode */ 2205 int b_p_ma; /* 'modifiable' */ 2206 char_u *b_p_nf; /* 'nrformats' */ 2207 int b_p_pi; /* 'preserveindent' */ 2208 #ifdef FEAT_TEXTOBJ 2209 char_u *b_p_qe; /* 'quoteescape' */ 2210 #endif 2211 int b_p_ro; /* 'readonly' */ 2212 long b_p_sw; /* 'shiftwidth' */ 2213 int b_p_sn; /* 'shortname' */ 2214 #ifdef FEAT_SMARTINDENT 2215 int b_p_si; /* 'smartindent' */ 2216 #endif 2217 long b_p_sts; /* 'softtabstop' */ 2218 long b_p_sts_nopaste; /* b_p_sts saved for paste mode */ 2219 #ifdef FEAT_SEARCHPATH 2220 char_u *b_p_sua; /* 'suffixesadd' */ 2221 #endif 2222 int b_p_swf; /* 'swapfile' */ 2223 #ifdef FEAT_SYN_HL 2224 long b_p_smc; /* 'synmaxcol' */ 2225 char_u *b_p_syn; /* 'syntax' */ 2226 #endif 2227 long b_p_ts; /* 'tabstop' */ 2228 int b_p_tx; /* 'textmode' */ 2229 long b_p_tw; /* 'textwidth' */ 2230 long b_p_tw_nobin; /* b_p_tw saved for binary mode */ 2231 long b_p_tw_nopaste; /* b_p_tw saved for paste mode */ 2232 long b_p_wm; /* 'wrapmargin' */ 2233 long b_p_wm_nobin; /* b_p_wm saved for binary mode */ 2234 long b_p_wm_nopaste; /* b_p_wm saved for paste mode */ 2235 #ifdef FEAT_KEYMAP 2236 char_u *b_p_keymap; /* 'keymap' */ 2237 #endif 2238 2239 /* local values for options which are normally global */ 2240 #ifdef FEAT_QUICKFIX 2241 char_u *b_p_gp; /* 'grepprg' local value */ 2242 char_u *b_p_mp; /* 'makeprg' local value */ 2243 char_u *b_p_efm; /* 'errorformat' local value */ 2244 #endif 2245 char_u *b_p_ep; /* 'equalprg' local value */ 2246 char_u *b_p_path; /* 'path' local value */ 2247 int b_p_ar; /* 'autoread' local value */ 2248 char_u *b_p_tags; /* 'tags' local value */ 2249 char_u *b_p_tc; /* 'tagcase' local value */ 2250 unsigned b_tc_flags; /* flags for 'tagcase' */ 2251 #ifdef FEAT_INS_EXPAND 2252 char_u *b_p_dict; /* 'dictionary' local value */ 2253 char_u *b_p_tsr; /* 'thesaurus' local value */ 2254 #endif 2255 long b_p_ul; /* 'undolevels' local value */ 2256 #ifdef FEAT_PERSISTENT_UNDO 2257 int b_p_udf; /* 'undofile' */ 2258 #endif 2259 #ifdef FEAT_LISP 2260 char_u *b_p_lw; /* 'lispwords' local value */ 2261 #endif 2262 2263 /* end of buffer options */ 2264 2265 #ifdef FEAT_CINDENT 2266 /* values set from b_p_cino */ 2267 int b_ind_level; 2268 int b_ind_open_imag; 2269 int b_ind_no_brace; 2270 int b_ind_first_open; 2271 int b_ind_open_extra; 2272 int b_ind_close_extra; 2273 int b_ind_open_left_imag; 2274 int b_ind_jump_label; 2275 int b_ind_case; 2276 int b_ind_case_code; 2277 int b_ind_case_break; 2278 int b_ind_param; 2279 int b_ind_func_type; 2280 int b_ind_comment; 2281 int b_ind_in_comment; 2282 int b_ind_in_comment2; 2283 int b_ind_cpp_baseclass; 2284 int b_ind_continuation; 2285 int b_ind_unclosed; 2286 int b_ind_unclosed2; 2287 int b_ind_unclosed_noignore; 2288 int b_ind_unclosed_wrapped; 2289 int b_ind_unclosed_whiteok; 2290 int b_ind_matching_paren; 2291 int b_ind_paren_prev; 2292 int b_ind_maxparen; 2293 int b_ind_maxcomment; 2294 int b_ind_scopedecl; 2295 int b_ind_scopedecl_code; 2296 int b_ind_java; 2297 int b_ind_js; 2298 int b_ind_keep_case_label; 2299 int b_ind_hash_comment; 2300 int b_ind_cpp_namespace; 2301 int b_ind_if_for_while; 2302 int b_ind_cpp_extern_c; 2303 #endif 2304 2305 linenr_T b_no_eol_lnum; /* non-zero lnum when last line of next binary 2306 * write should not have an end-of-line */ 2307 2308 int b_start_eol; /* last line had eol when it was read */ 2309 int b_start_ffc; /* first char of 'ff' when edit started */ 2310 #ifdef FEAT_MBYTE 2311 char_u *b_start_fenc; /* 'fileencoding' when edit started or NULL */ 2312 int b_bad_char; /* "++bad=" argument when edit started or 0 */ 2313 int b_start_bomb; /* 'bomb' when it was read */ 2314 #endif 2315 2316 #ifdef FEAT_EVAL 2317 dictitem_T b_bufvar; /* variable for "b:" Dictionary */ 2318 dict_T *b_vars; /* internal variables, local to buffer */ 2319 #endif 2320 2321 #if defined(FEAT_BEVAL) && defined(FEAT_EVAL) 2322 char_u *b_p_bexpr; /* 'balloonexpr' local value */ 2323 long_u b_p_bexpr_flags;/* flags for 'balloonexpr' */ 2324 #endif 2325 #ifdef FEAT_CRYPT 2326 char_u *b_p_cm; /* 'cryptmethod' */ 2327 #endif 2328 2329 /* When a buffer is created, it starts without a swap file. b_may_swap is 2330 * then set to indicate that a swap file may be opened later. It is reset 2331 * if a swap file could not be opened. 2332 */ 2333 int b_may_swap; 2334 int b_did_warn; /* Set to 1 if user has been warned on first 2335 change of a read-only file */ 2336 2337 /* Two special kinds of buffers: 2338 * help buffer - used for help files, won't use a swap file. 2339 * spell buffer - used for spell info, never displayed and doesn't have a 2340 * file name. 2341 */ 2342 int b_help; /* TRUE for help file buffer (when set b_p_bt 2343 is "help") */ 2344 #ifdef FEAT_SPELL 2345 int b_spell; /* TRUE for a spell file buffer, most fields 2346 are not used! Use the B_SPELL macro to 2347 access b_spell without #ifdef. */ 2348 #endif 2349 2350 int b_shortname; /* this file has an 8.3 file name */ 2351 2352 #ifdef FEAT_MZSCHEME 2353 void *b_mzscheme_ref; /* The MzScheme reference to this buffer */ 2354 #endif 2355 2356 #ifdef FEAT_PERL 2357 void *b_perl_private; 2358 #endif 2359 2360 #ifdef FEAT_PYTHON 2361 void *b_python_ref; /* The Python reference to this buffer */ 2362 #endif 2363 2364 #ifdef FEAT_PYTHON3 2365 void *b_python3_ref; /* The Python3 reference to this buffer */ 2366 #endif 2367 2368 #ifdef FEAT_TCL 2369 void *b_tcl_ref; 2370 #endif 2371 2372 #ifdef FEAT_RUBY 2373 void *b_ruby_ref; 2374 #endif 2375 2376 #if defined(FEAT_SYN_HL) || defined(FEAT_SPELL) 2377 synblock_T b_s; /* Info related to syntax highlighting. w_s 2378 * normally points to this, but some windows 2379 * may use a different synblock_T. */ 2380 #endif 2381 2382 #ifdef FEAT_SIGNS 2383 signlist_T *b_signlist; /* list of signs to draw */ 2384 # ifdef FEAT_NETBEANS_INTG 2385 int b_has_sign_column; /* Flag that is set when a first sign is 2386 * added and remains set until the end of 2387 * the netbeans session. */ 2388 # endif 2389 #endif 2390 2391 #ifdef FEAT_NETBEANS_INTG 2392 int b_netbeans_file; /* TRUE when buffer is owned by NetBeans */ 2393 int b_was_netbeans_file;/* TRUE if b_netbeans_file was once set */ 2394 #endif 2395 #ifdef FEAT_JOB_CHANNEL 2396 int b_write_to_channel; /* TRUE when appended lines are written to 2397 * a channel. */ 2398 #endif 2399 2400 #ifdef FEAT_CRYPT 2401 cryptstate_T *b_cryptstate; /* Encryption state while reading or writing 2402 * the file. NULL when not using encryption. */ 2403 #endif 2404 int b_mapped_ctrl_c; /* modes where CTRL-C is mapped */ 2405 2406 #ifdef FEAT_TERMINAL 2407 term_T *b_term; /* When not NULL this buffer is for a terminal 2408 * window. */ 2409 #endif 2410 2411 }; /* file_buffer */ 2412 2413 2414 #ifdef FEAT_DIFF 2415 /* 2416 * Stuff for diff mode. 2417 */ 2418 # define DB_COUNT 8 /* up to eight buffers can be diff'ed */ 2419 2420 /* 2421 * Each diffblock defines where a block of lines starts in each of the buffers 2422 * and how many lines it occupies in that buffer. When the lines are missing 2423 * in the buffer the df_count[] is zero. This is all counted in 2424 * buffer lines. 2425 * There is always at least one unchanged line in between the diffs. 2426 * Otherwise it would have been included in the diff above or below it. 2427 * df_lnum[] + df_count[] is the lnum below the change. When in one buffer 2428 * lines have been inserted, in the other buffer df_lnum[] is the line below 2429 * the insertion and df_count[] is zero. When appending lines at the end of 2430 * the buffer, df_lnum[] is one beyond the end! 2431 * This is using a linked list, because the number of differences is expected 2432 * to be reasonable small. The list is sorted on lnum. 2433 */ 2434 typedef struct diffblock_S diff_T; 2435 struct diffblock_S 2436 { 2437 diff_T *df_next; 2438 linenr_T df_lnum[DB_COUNT]; /* line number in buffer */ 2439 linenr_T df_count[DB_COUNT]; /* nr of inserted/changed lines */ 2440 }; 2441 #endif 2442 2443 #define SNAP_HELP_IDX 0 2444 #define SNAP_AUCMD_IDX 1 2445 #define SNAP_COUNT 2 2446 2447 /* 2448 * Tab pages point to the top frame of each tab page. 2449 * Note: Most values are NOT valid for the current tab page! Use "curwin", 2450 * "firstwin", etc. for that. "tp_topframe" is always valid and can be 2451 * compared against "topframe" to find the current tab page. 2452 */ 2453 typedef struct tabpage_S tabpage_T; 2454 struct tabpage_S 2455 { 2456 tabpage_T *tp_next; /* next tabpage or NULL */ 2457 frame_T *tp_topframe; /* topframe for the windows */ 2458 win_T *tp_curwin; /* current window in this Tab page */ 2459 win_T *tp_prevwin; /* previous window in this Tab page */ 2460 win_T *tp_firstwin; /* first window in this Tab page */ 2461 win_T *tp_lastwin; /* last window in this Tab page */ 2462 long tp_old_Rows; /* Rows when Tab page was left */ 2463 long tp_old_Columns; /* Columns when Tab page was left */ 2464 long tp_ch_used; /* value of 'cmdheight' when frame size 2465 was set */ 2466 #ifdef FEAT_GUI 2467 int tp_prev_which_scrollbars[3]; 2468 /* previous value of which_scrollbars */ 2469 #endif 2470 #ifdef FEAT_DIFF 2471 diff_T *tp_first_diff; 2472 buf_T *(tp_diffbuf[DB_COUNT]); 2473 int tp_diff_invalid; /* list of diffs is outdated */ 2474 #endif 2475 frame_T *(tp_snapshot[SNAP_COUNT]); /* window layout snapshots */ 2476 #ifdef FEAT_EVAL 2477 dictitem_T tp_winvar; /* variable for "t:" Dictionary */ 2478 dict_T *tp_vars; /* internal variables, local to tab page */ 2479 #endif 2480 2481 #ifdef FEAT_PYTHON 2482 void *tp_python_ref; /* The Python value for this tab page */ 2483 #endif 2484 2485 #ifdef FEAT_PYTHON3 2486 void *tp_python3_ref; /* The Python value for this tab page */ 2487 #endif 2488 }; 2489 2490 /* 2491 * Structure to cache info for displayed lines in w_lines[]. 2492 * Each logical line has one entry. 2493 * The entry tells how the logical line is currently displayed in the window. 2494 * This is updated when displaying the window. 2495 * When the display is changed (e.g., when clearing the screen) w_lines_valid 2496 * is changed to exclude invalid entries. 2497 * When making changes to the buffer, wl_valid is reset to indicate wl_size 2498 * may not reflect what is actually in the buffer. When wl_valid is FALSE, 2499 * the entries can only be used to count the number of displayed lines used. 2500 * wl_lnum and wl_lastlnum are invalid too. 2501 */ 2502 typedef struct w_line 2503 { 2504 linenr_T wl_lnum; /* buffer line number for logical line */ 2505 short_u wl_size; /* height in screen lines */ 2506 char wl_valid; /* TRUE values are valid for text in buffer */ 2507 #ifdef FEAT_FOLDING 2508 char wl_folded; /* TRUE when this is a range of folded lines */ 2509 linenr_T wl_lastlnum; /* last buffer line number for logical line */ 2510 #endif 2511 } wline_T; 2512 2513 /* 2514 * Windows are kept in a tree of frames. Each frame has a column (FR_COL) 2515 * or row (FR_ROW) layout or is a leaf, which has a window. 2516 */ 2517 struct frame_S 2518 { 2519 char fr_layout; /* FR_LEAF, FR_COL or FR_ROW */ 2520 int fr_width; 2521 int fr_newwidth; /* new width used in win_equal_rec() */ 2522 int fr_height; 2523 int fr_newheight; /* new height used in win_equal_rec() */ 2524 frame_T *fr_parent; /* containing frame or NULL */ 2525 frame_T *fr_next; /* frame right or below in same parent, NULL 2526 for first */ 2527 frame_T *fr_prev; /* frame left or above in same parent, NULL 2528 for last */ 2529 /* fr_child and fr_win are mutually exclusive */ 2530 frame_T *fr_child; /* first contained frame */ 2531 win_T *fr_win; /* window that fills this frame */ 2532 }; 2533 2534 #define FR_LEAF 0 /* frame is a leaf */ 2535 #define FR_ROW 1 /* frame with a row of windows */ 2536 #define FR_COL 2 /* frame with a column of windows */ 2537 2538 /* 2539 * Struct used for highlighting 'hlsearch' matches, matches defined by 2540 * ":match" and matches defined by match functions. 2541 * For 'hlsearch' there is one pattern for all windows. For ":match" and the 2542 * match functions there is a different pattern for each window. 2543 */ 2544 typedef struct 2545 { 2546 regmmatch_T rm; /* points to the regexp program; contains last found 2547 match (may continue in next line) */ 2548 buf_T *buf; /* the buffer to search for a match */ 2549 linenr_T lnum; /* the line to search for a match */ 2550 int attr; /* attributes to be used for a match */ 2551 int attr_cur; /* attributes currently active in win_line() */ 2552 linenr_T first_lnum; /* first lnum to search for multi-line pat */ 2553 colnr_T startcol; /* in win_line() points to char where HL starts */ 2554 colnr_T endcol; /* in win_line() points to char where HL ends */ 2555 int is_addpos; /* position specified directly by 2556 matchaddpos(). TRUE/FALSE */ 2557 #ifdef FEAT_RELTIME 2558 proftime_T tm; /* for a time limit */ 2559 #endif 2560 } match_T; 2561 2562 /* number of positions supported by matchaddpos() */ 2563 #define MAXPOSMATCH 8 2564 2565 /* 2566 * Same as lpos_T, but with additional field len. 2567 */ 2568 typedef struct 2569 { 2570 linenr_T lnum; /* line number */ 2571 colnr_T col; /* column number */ 2572 int len; /* length: 0 - to the end of line */ 2573 } llpos_T; 2574 2575 /* 2576 * posmatch_T provides an array for storing match items for matchaddpos() 2577 * function. 2578 */ 2579 typedef struct posmatch posmatch_T; 2580 struct posmatch 2581 { 2582 llpos_T pos[MAXPOSMATCH]; /* array of positions */ 2583 int cur; /* internal position counter */ 2584 linenr_T toplnum; /* top buffer line */ 2585 linenr_T botlnum; /* bottom buffer line */ 2586 }; 2587 2588 /* 2589 * matchitem_T provides a linked list for storing match items for ":match" and 2590 * the match functions. 2591 */ 2592 typedef struct matchitem matchitem_T; 2593 struct matchitem 2594 { 2595 matchitem_T *next; 2596 int id; /* match ID */ 2597 int priority; /* match priority */ 2598 char_u *pattern; /* pattern to highlight */ 2599 int hlg_id; /* highlight group ID */ 2600 regmmatch_T match; /* regexp program for pattern */ 2601 posmatch_T pos; /* position matches */ 2602 match_T hl; /* struct for doing the actual highlighting */ 2603 #ifdef FEAT_CONCEAL 2604 int conceal_char; /* cchar for Conceal highlighting */ 2605 #endif 2606 }; 2607 2608 #ifdef FEAT_MENU 2609 typedef struct { 2610 int wb_startcol; 2611 int wb_endcol; 2612 vimmenu_T *wb_menu; 2613 } winbar_item_T; 2614 #endif 2615 2616 /* 2617 * Structure which contains all information that belongs to a window 2618 * 2619 * All row numbers are relative to the start of the window, except w_winrow. 2620 */ 2621 struct window_S 2622 { 2623 int w_id; /* unique window ID */ 2624 2625 buf_T *w_buffer; /* buffer we are a window into (used 2626 often, keep it the first item!) */ 2627 2628 #if defined(FEAT_SYN_HL) || defined(FEAT_SPELL) 2629 synblock_T *w_s; /* for :ownsyntax */ 2630 #endif 2631 2632 win_T *w_prev; /* link to previous window */ 2633 win_T *w_next; /* link to next window */ 2634 int w_closing; /* window is being closed, don't let 2635 autocommands close it too. */ 2636 2637 frame_T *w_frame; /* frame containing this window */ 2638 2639 pos_T w_cursor; /* cursor position in buffer */ 2640 2641 colnr_T w_curswant; /* The column we'd like to be at. This is 2642 used to try to stay in the same column 2643 for up/down cursor motions. */ 2644 2645 int w_set_curswant; /* If set, then update w_curswant the next 2646 time through cursupdate() to the 2647 current virtual column */ 2648 2649 /* 2650 * the next seven are used to update the visual part 2651 */ 2652 char w_old_visual_mode; /* last known VIsual_mode */ 2653 linenr_T w_old_cursor_lnum; /* last known end of visual part */ 2654 colnr_T w_old_cursor_fcol; /* first column for block visual part */ 2655 colnr_T w_old_cursor_lcol; /* last column for block visual part */ 2656 linenr_T w_old_visual_lnum; /* last known start of visual part */ 2657 colnr_T w_old_visual_col; /* last known start of visual part */ 2658 colnr_T w_old_curswant; /* last known value of Curswant */ 2659 2660 /* 2661 * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for 2662 * displaying the buffer. 2663 */ 2664 linenr_T w_topline; /* buffer line number of the line at the 2665 top of the window */ 2666 char w_topline_was_set; /* flag set to TRUE when topline is set, 2667 e.g. by winrestview() */ 2668 #ifdef FEAT_DIFF 2669 int w_topfill; /* number of filler lines above w_topline */ 2670 int w_old_topfill; /* w_topfill at last redraw */ 2671 int w_botfill; /* TRUE when filler lines are actually 2672 below w_topline (at end of file) */ 2673 int w_old_botfill; /* w_botfill at last redraw */ 2674 #endif 2675 colnr_T w_leftcol; /* window column number of the left most 2676 character in the window; used when 2677 'wrap' is off */ 2678 colnr_T w_skipcol; /* starting column when a single line 2679 doesn't fit in the window */ 2680 2681 /* 2682 * Layout of the window in the screen. 2683 * May need to add "msg_scrolled" to "w_winrow" in rare situations. 2684 */ 2685 int w_winrow; /* first row of window in screen */ 2686 int w_height; /* number of rows in window, excluding 2687 status/command/winbar line(s) */ 2688 int w_status_height; /* number of status lines (0 or 1) */ 2689 int w_wincol; /* Leftmost column of window in screen. */ 2690 int w_width; /* Width of window, excluding separation. */ 2691 int w_vsep_width; /* Number of separator columns (0 or 1). */ 2692 2693 /* 2694 * === start of cached values ==== 2695 */ 2696 /* 2697 * Recomputing is minimized by storing the result of computations. 2698 * Use functions in screen.c to check if they are valid and to update. 2699 * w_valid is a bitfield of flags, which indicate if specific values are 2700 * valid or need to be recomputed. See screen.c for values. 2701 */ 2702 int w_valid; 2703 pos_T w_valid_cursor; /* last known position of w_cursor, used 2704 to adjust w_valid */ 2705 colnr_T w_valid_leftcol; /* last known w_leftcol */ 2706 2707 /* 2708 * w_cline_height is the number of physical lines taken by the buffer line 2709 * that the cursor is on. We use this to avoid extra calls to plines(). 2710 */ 2711 int w_cline_height; /* current size of cursor line */ 2712 #ifdef FEAT_FOLDING 2713 int w_cline_folded; /* cursor line is folded */ 2714 #endif 2715 2716 int w_cline_row; /* starting row of the cursor line */ 2717 2718 colnr_T w_virtcol; /* column number of the cursor in the 2719 buffer line, as opposed to the column 2720 number we're at on the screen. This 2721 makes a difference on lines which span 2722 more than one screen line or when 2723 w_leftcol is non-zero */ 2724 2725 /* 2726 * w_wrow and w_wcol specify the cursor position in the window. 2727 * This is related to positions in the window, not in the display or 2728 * buffer, thus w_wrow is relative to w_winrow. 2729 */ 2730 int w_wrow, w_wcol; /* cursor position in window */ 2731 2732 linenr_T w_botline; /* number of the line below the bottom of 2733 the window */ 2734 int w_empty_rows; /* number of ~ rows in window */ 2735 #ifdef FEAT_DIFF 2736 int w_filler_rows; /* number of filler rows at the end of the 2737 window */ 2738 #endif 2739 2740 /* 2741 * Info about the lines currently in the window is remembered to avoid 2742 * recomputing it every time. The allocated size of w_lines[] is Rows. 2743 * Only the w_lines_valid entries are actually valid. 2744 * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline 2745 * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline. 2746 * Between changing text and updating the display w_lines[] represents 2747 * what is currently displayed. wl_valid is reset to indicated this. 2748 * This is used for efficient redrawing. 2749 */ 2750 int w_lines_valid; /* number of valid entries */ 2751 wline_T *w_lines; 2752 2753 #ifdef FEAT_FOLDING 2754 garray_T w_folds; /* array of nested folds */ 2755 char w_fold_manual; /* when TRUE: some folds are opened/closed 2756 manually */ 2757 char w_foldinvalid; /* when TRUE: folding needs to be 2758 recomputed */ 2759 #endif 2760 #ifdef FEAT_LINEBREAK 2761 int w_nrwidth; /* width of 'number' and 'relativenumber' 2762 column being used */ 2763 #endif 2764 2765 /* 2766 * === end of cached values === 2767 */ 2768 2769 int w_redr_type; /* type of redraw to be performed on win */ 2770 int w_upd_rows; /* number of window lines to update when 2771 w_redr_type is REDRAW_TOP */ 2772 linenr_T w_redraw_top; /* when != 0: first line needing redraw */ 2773 linenr_T w_redraw_bot; /* when != 0: last line needing redraw */ 2774 int w_redr_status; /* if TRUE status line must be redrawn */ 2775 2776 #ifdef FEAT_CMDL_INFO 2777 /* remember what is shown in the ruler for this window (if 'ruler' set) */ 2778 pos_T w_ru_cursor; /* cursor position shown in ruler */ 2779 colnr_T w_ru_virtcol; /* virtcol shown in ruler */ 2780 linenr_T w_ru_topline; /* topline shown in ruler */ 2781 linenr_T w_ru_line_count; /* line count used for ruler */ 2782 # ifdef FEAT_DIFF 2783 int w_ru_topfill; /* topfill shown in ruler */ 2784 # endif 2785 char w_ru_empty; /* TRUE if ruler shows 0-1 (empty line) */ 2786 #endif 2787 2788 int w_alt_fnum; /* alternate file (for # and CTRL-^) */ 2789 2790 alist_T *w_alist; /* pointer to arglist for this window */ 2791 int w_arg_idx; /* current index in argument list (can be 2792 out of range!) */ 2793 int w_arg_idx_invalid; /* editing another file than w_arg_idx */ 2794 2795 char_u *w_localdir; /* absolute path of local directory or 2796 NULL */ 2797 #ifdef FEAT_MENU 2798 vimmenu_T *w_winbar; /* The root of the WinBar menu hierarchy. */ 2799 winbar_item_T *w_winbar_items; /* list of items in the WinBar */ 2800 int w_winbar_height; /* 1 if there is a window toolbar */ 2801 #endif 2802 2803 /* 2804 * Options local to a window. 2805 * They are local because they influence the layout of the window or 2806 * depend on the window layout. 2807 * There are two values: w_onebuf_opt is local to the buffer currently in 2808 * this window, w_allbuf_opt is for all buffers in this window. 2809 */ 2810 winopt_T w_onebuf_opt; 2811 winopt_T w_allbuf_opt; 2812 2813 /* A few options have local flags for P_INSECURE. */ 2814 #ifdef FEAT_STL_OPT 2815 long_u w_p_stl_flags; /* flags for 'statusline' */ 2816 #endif 2817 #ifdef FEAT_EVAL 2818 long_u w_p_fde_flags; /* flags for 'foldexpr' */ 2819 long_u w_p_fdt_flags; /* flags for 'foldtext' */ 2820 #endif 2821 #ifdef FEAT_SYN_HL 2822 int *w_p_cc_cols; /* array of columns to highlight or NULL */ 2823 #endif 2824 #ifdef FEAT_LINEBREAK 2825 int w_p_brimin; /* minimum width for breakindent */ 2826 int w_p_brishift; /* additional shift for breakindent */ 2827 int w_p_brisbr; /* sbr in 'briopt' */ 2828 #endif 2829 2830 /* transform a pointer to a "onebuf" option into a "allbuf" option */ 2831 #define GLOBAL_WO(p) ((char *)p + sizeof(winopt_T)) 2832 2833 long w_scbind_pos; 2834 2835 #ifdef FEAT_EVAL 2836 dictitem_T w_winvar; /* variable for "w:" Dictionary */ 2837 dict_T *w_vars; /* internal variables, local to window */ 2838 #endif 2839 2840 #if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP) 2841 int w_farsi; /* for the window dependent Farsi functions */ 2842 #endif 2843 2844 /* 2845 * The w_prev_pcmark field is used to check whether we really did jump to 2846 * a new line after setting the w_pcmark. If not, then we revert to 2847 * using the previous w_pcmark. 2848 */ 2849 pos_T w_pcmark; /* previous context mark */ 2850 pos_T w_prev_pcmark; /* previous w_pcmark */ 2851 2852 #ifdef FEAT_JUMPLIST 2853 /* 2854 * the jumplist contains old cursor positions 2855 */ 2856 xfmark_T w_jumplist[JUMPLISTSIZE]; 2857 int w_jumplistlen; /* number of active entries */ 2858 int w_jumplistidx; /* current position */ 2859 2860 int w_changelistidx; /* current position in b_changelist */ 2861 #endif 2862 2863 #ifdef FEAT_SEARCH_EXTRA 2864 matchitem_T *w_match_head; /* head of match list */ 2865 int w_next_match_id; /* next match ID */ 2866 #endif 2867 2868 /* 2869 * the tagstack grows from 0 upwards: 2870 * entry 0: older 2871 * entry 1: newer 2872 * entry 2: newest 2873 */ 2874 taggy_T w_tagstack[TAGSTACKSIZE]; /* the tag stack */ 2875 int w_tagstackidx; /* idx just below active entry */ 2876 int w_tagstacklen; /* number of tags on stack */ 2877 2878 /* 2879 * w_fraction is the fractional row of the cursor within the window, from 2880 * 0 at the top row to FRACTION_MULT at the last row. 2881 * w_prev_fraction_row was the actual cursor row when w_fraction was last 2882 * calculated. 2883 */ 2884 int w_fraction; 2885 int w_prev_fraction_row; 2886 2887 #ifdef FEAT_GUI 2888 scrollbar_T w_scrollbars[2]; /* vert. Scrollbars for this window */ 2889 #endif 2890 #ifdef FEAT_LINEBREAK 2891 linenr_T w_nrwidth_line_count; /* line count when ml_nrwidth_width 2892 * was computed. */ 2893 long w_nuw_cached; /* 'numberwidth' option cached */ 2894 int w_nrwidth_width; /* nr of chars to print line count. */ 2895 #endif 2896 2897 #ifdef FEAT_QUICKFIX 2898 qf_info_T *w_llist; /* Location list for this window */ 2899 /* 2900 * Location list reference used in the location list window. 2901 * In a non-location list window, w_llist_ref is NULL. 2902 */ 2903 qf_info_T *w_llist_ref; 2904 #endif 2905 2906 2907 #ifdef FEAT_MZSCHEME 2908 void *w_mzscheme_ref; /* The MzScheme value for this window */ 2909 #endif 2910 2911 #ifdef FEAT_PERL 2912 void *w_perl_private; 2913 #endif 2914 2915 #ifdef FEAT_PYTHON 2916 void *w_python_ref; /* The Python value for this window */ 2917 #endif 2918 2919 #ifdef FEAT_PYTHON3 2920 void *w_python3_ref; /* The Python value for this window */ 2921 #endif 2922 2923 #ifdef FEAT_TCL 2924 void *w_tcl_ref; 2925 #endif 2926 2927 #ifdef FEAT_RUBY 2928 void *w_ruby_ref; 2929 #endif 2930 }; 2931 2932 /* 2933 * Arguments for operators. 2934 */ 2935 typedef struct oparg_S 2936 { 2937 int op_type; /* current pending operator type */ 2938 int regname; /* register to use for the operator */ 2939 int motion_type; /* type of the current cursor motion */ 2940 int motion_force; /* force motion type: 'v', 'V' or CTRL-V */ 2941 int use_reg_one; /* TRUE if delete uses reg 1 even when not 2942 linewise */ 2943 int inclusive; /* TRUE if char motion is inclusive (only 2944 valid when motion_type is MCHAR */ 2945 int end_adjusted; /* backuped b_op_end one char (only used by 2946 do_format()) */ 2947 pos_T start; /* start of the operator */ 2948 pos_T end; /* end of the operator */ 2949 pos_T cursor_start; /* cursor position before motion for "gw" */ 2950 2951 long line_count; /* number of lines from op_start to op_end 2952 (inclusive) */ 2953 int empty; /* op_start and op_end the same (only used by 2954 do_change()) */ 2955 int is_VIsual; /* operator on Visual area */ 2956 int block_mode; /* current operator is Visual block mode */ 2957 colnr_T start_vcol; /* start col for block mode operator */ 2958 colnr_T end_vcol; /* end col for block mode operator */ 2959 long prev_opcount; /* ca.opcount saved for K_CURSORHOLD */ 2960 long prev_count0; /* ca.count0 saved for K_CURSORHOLD */ 2961 } oparg_T; 2962 2963 /* 2964 * Arguments for Normal mode commands. 2965 */ 2966 typedef struct cmdarg_S 2967 { 2968 oparg_T *oap; /* Operator arguments */ 2969 int prechar; /* prefix character (optional, always 'g') */ 2970 int cmdchar; /* command character */ 2971 int nchar; /* next command character (optional) */ 2972 #ifdef FEAT_MBYTE 2973 int ncharC1; /* first composing character (optional) */ 2974 int ncharC2; /* second composing character (optional) */ 2975 #endif 2976 int extra_char; /* yet another character (optional) */ 2977 long opcount; /* count before an operator */ 2978 long count0; /* count before command, default 0 */ 2979 long count1; /* count before command, default 1 */ 2980 int arg; /* extra argument from nv_cmds[] */ 2981 int retval; /* return: CA_* values */ 2982 char_u *searchbuf; /* return: pointer to search pattern or NULL */ 2983 } cmdarg_T; 2984 2985 /* values for retval: */ 2986 #define CA_COMMAND_BUSY 1 /* skip restarting edit() once */ 2987 #define CA_NO_ADJ_OP_END 2 /* don't adjust operator end */ 2988 2989 #ifdef CURSOR_SHAPE 2990 /* 2991 * struct to store values from 'guicursor' and 'mouseshape' 2992 */ 2993 /* Indexes in shape_table[] */ 2994 #define SHAPE_IDX_N 0 /* Normal mode */ 2995 #define SHAPE_IDX_V 1 /* Visual mode */ 2996 #define SHAPE_IDX_I 2 /* Insert mode */ 2997 #define SHAPE_IDX_R 3 /* Replace mode */ 2998 #define SHAPE_IDX_C 4 /* Command line Normal mode */ 2999 #define SHAPE_IDX_CI 5 /* Command line Insert mode */ 3000 #define SHAPE_IDX_CR 6 /* Command line Replace mode */ 3001 #define SHAPE_IDX_O 7 /* Operator-pending mode */ 3002 #define SHAPE_IDX_VE 8 /* Visual mode with 'selection' exclusive */ 3003 #define SHAPE_IDX_CLINE 9 /* On command line */ 3004 #define SHAPE_IDX_STATUS 10 /* A status line */ 3005 #define SHAPE_IDX_SDRAG 11 /* dragging a status line */ 3006 #define SHAPE_IDX_VSEP 12 /* A vertical separator line */ 3007 #define SHAPE_IDX_VDRAG 13 /* dragging a vertical separator line */ 3008 #define SHAPE_IDX_MORE 14 /* Hit-return or More */ 3009 #define SHAPE_IDX_MOREL 15 /* Hit-return or More in last line */ 3010 #define SHAPE_IDX_SM 16 /* showing matching paren */ 3011 #define SHAPE_IDX_COUNT 17 3012 3013 #define SHAPE_BLOCK 0 /* block cursor */ 3014 #define SHAPE_HOR 1 /* horizontal bar cursor */ 3015 #define SHAPE_VER 2 /* vertical bar cursor */ 3016 3017 #define MSHAPE_NUMBERED 1000 /* offset for shapes identified by number */ 3018 #define MSHAPE_HIDE 1 /* hide mouse pointer */ 3019 3020 #define SHAPE_MOUSE 1 /* used for mouse pointer shape */ 3021 #define SHAPE_CURSOR 2 /* used for text cursor shape */ 3022 3023 typedef struct cursor_entry 3024 { 3025 int shape; /* one of the SHAPE_ defines */ 3026 int mshape; /* one of the MSHAPE defines */ 3027 int percentage; /* percentage of cell for bar */ 3028 long blinkwait; /* blinking, wait time before blinking starts */ 3029 long blinkon; /* blinking, on time */ 3030 long blinkoff; /* blinking, off time */ 3031 int id; /* highlight group ID */ 3032 int id_lm; /* highlight group ID for :lmap mode */ 3033 char *name; /* mode name (fixed) */ 3034 char used_for; /* SHAPE_MOUSE and/or SHAPE_CURSOR */ 3035 } cursorentry_T; 3036 #endif /* CURSOR_SHAPE */ 3037 3038 #ifdef FEAT_MENU 3039 3040 /* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */ 3041 #define MENU_INDEX_INVALID -1 3042 #define MENU_INDEX_NORMAL 0 3043 #define MENU_INDEX_VISUAL 1 3044 #define MENU_INDEX_SELECT 2 3045 #define MENU_INDEX_OP_PENDING 3 3046 #define MENU_INDEX_INSERT 4 3047 #define MENU_INDEX_CMDLINE 5 3048 #define MENU_INDEX_TIP 6 3049 #define MENU_MODES 7 3050 3051 /* Menu modes */ 3052 #define MENU_NORMAL_MODE (1 << MENU_INDEX_NORMAL) 3053 #define MENU_VISUAL_MODE (1 << MENU_INDEX_VISUAL) 3054 #define MENU_SELECT_MODE (1 << MENU_INDEX_SELECT) 3055 #define MENU_OP_PENDING_MODE (1 << MENU_INDEX_OP_PENDING) 3056 #define MENU_INSERT_MODE (1 << MENU_INDEX_INSERT) 3057 #define MENU_CMDLINE_MODE (1 << MENU_INDEX_CMDLINE) 3058 #define MENU_TIP_MODE (1 << MENU_INDEX_TIP) 3059 #define MENU_ALL_MODES ((1 << MENU_INDEX_TIP) - 1) 3060 /*note MENU_INDEX_TIP is not a 'real' mode*/ 3061 3062 /* Start a menu name with this to not include it on the main menu bar */ 3063 #define MNU_HIDDEN_CHAR ']' 3064 3065 struct VimMenu 3066 { 3067 int modes; /* Which modes is this menu visible for? */ 3068 int enabled; /* for which modes the menu is enabled */ 3069 char_u *name; /* Name of menu, possibly translated */ 3070 char_u *dname; /* Displayed Name ("name" without '&') */ 3071 #ifdef FEAT_MULTI_LANG 3072 char_u *en_name; /* "name" untranslated, NULL when "name" 3073 * was not translated */ 3074 char_u *en_dname; /* "dname" untranslated, NULL when "dname" 3075 * was not translated */ 3076 #endif 3077 int mnemonic; /* mnemonic key (after '&') */ 3078 char_u *actext; /* accelerator text (after TAB) */ 3079 int priority; /* Menu order priority */ 3080 #ifdef FEAT_GUI 3081 void (*cb)(vimmenu_T *); /* Call-back routine */ 3082 #endif 3083 #ifdef FEAT_TOOLBAR 3084 char_u *iconfile; /* name of file for icon or NULL */ 3085 int iconidx; /* icon index (-1 if not set) */ 3086 int icon_builtin; /* icon names is BuiltIn{nr} */ 3087 #endif 3088 char_u *strings[MENU_MODES]; /* Mapped string for each mode */ 3089 int noremap[MENU_MODES]; /* A REMAP_ flag for each mode */ 3090 char silent[MENU_MODES]; /* A silent flag for each mode */ 3091 vimmenu_T *children; /* Children of sub-menu */ 3092 vimmenu_T *parent; /* Parent of menu */ 3093 vimmenu_T *next; /* Next item in menu */ 3094 #ifdef FEAT_GUI_X11 3095 Widget id; /* Manage this to enable item */ 3096 Widget submenu_id; /* If this is submenu, add children here */ 3097 #endif 3098 #ifdef FEAT_GUI_GTK 3099 GtkWidget *id; /* Manage this to enable item */ 3100 GtkWidget *submenu_id; /* If this is submenu, add children here */ 3101 # if defined(GTK_CHECK_VERSION) && !GTK_CHECK_VERSION(3,4,0) 3102 GtkWidget *tearoff_handle; 3103 # endif 3104 GtkWidget *label; /* Used by "set wak=" code. */ 3105 #endif 3106 #ifdef FEAT_GUI_MOTIF 3107 int sensitive; /* turn button on/off */ 3108 char **xpm; /* pixmap data */ 3109 char *xpm_fname; /* file with pixmap data */ 3110 #endif 3111 #ifdef FEAT_GUI_ATHENA 3112 Pixmap image; /* Toolbar image */ 3113 #endif 3114 #ifdef FEAT_BEVAL_TIP 3115 BalloonEval *tip; /* tooltip for this menu item */ 3116 #endif 3117 #ifdef FEAT_GUI_W32 3118 UINT id; /* Id of menu item */ 3119 HMENU submenu_id; /* If this is submenu, add children here */ 3120 HWND tearoff_handle; /* hWnd of tearoff if created */ 3121 #endif 3122 #ifdef FEAT_GUI_MAC 3123 /* MenuHandle id; */ 3124 /* short index; */ /* the item index within the father menu */ 3125 short menu_id; /* the menu id to which this item belong */ 3126 short submenu_id; /* the menu id of the children (could be 3127 get through some tricks) */ 3128 MenuHandle menu_handle; 3129 MenuHandle submenu_handle; 3130 #endif 3131 #ifdef FEAT_GUI_PHOTON 3132 PtWidget_t *id; 3133 PtWidget_t *submenu_id; 3134 #endif 3135 }; 3136 #else 3137 /* For generating prototypes when FEAT_MENU isn't defined. */ 3138 typedef int vimmenu_T; 3139 3140 #endif /* FEAT_MENU */ 3141 3142 /* 3143 * Struct to save values in before executing autocommands for a buffer that is 3144 * not the current buffer. 3145 */ 3146 typedef struct 3147 { 3148 buf_T *save_curbuf; /* saved curbuf */ 3149 int use_aucmd_win; /* using aucmd_win */ 3150 win_T *save_curwin; /* saved curwin */ 3151 win_T *new_curwin; /* new curwin */ 3152 bufref_T new_curbuf; /* new curbuf */ 3153 char_u *globaldir; /* saved value of globaldir */ 3154 } aco_save_T; 3155 3156 /* 3157 * Generic option table item, only used for printer at the moment. 3158 */ 3159 typedef struct 3160 { 3161 const char *name; 3162 int hasnum; 3163 long number; 3164 char_u *string; /* points into option string */ 3165 int strlen; 3166 int present; 3167 } option_table_T; 3168 3169 /* 3170 * Structure to hold printing color and font attributes. 3171 */ 3172 typedef struct 3173 { 3174 long_u fg_color; 3175 long_u bg_color; 3176 int bold; 3177 int italic; 3178 int underline; 3179 int undercurl; 3180 } prt_text_attr_T; 3181 3182 /* 3183 * Structure passed back to the generic printer code. 3184 */ 3185 typedef struct 3186 { 3187 int n_collated_copies; 3188 int n_uncollated_copies; 3189 int duplex; 3190 int chars_per_line; 3191 int lines_per_page; 3192 int has_color; 3193 prt_text_attr_T number; 3194 #ifdef FEAT_SYN_HL 3195 int modec; 3196 int do_syntax; 3197 #endif 3198 int user_abort; 3199 char_u *jobname; 3200 #ifdef FEAT_POSTSCRIPT 3201 char_u *outfile; 3202 char_u *arguments; 3203 #endif 3204 } prt_settings_T; 3205 3206 #define PRINT_NUMBER_WIDTH 8 3207 3208 /* 3209 * Used for popup menu items. 3210 */ 3211 typedef struct 3212 { 3213 char_u *pum_text; /* main menu text */ 3214 char_u *pum_kind; /* extra kind text (may be truncated) */ 3215 char_u *pum_extra; /* extra menu text (may be truncated) */ 3216 char_u *pum_info; /* extra info */ 3217 } pumitem_T; 3218 3219 /* 3220 * Structure used for get_tagfname(). 3221 */ 3222 typedef struct 3223 { 3224 char_u *tn_tags; /* value of 'tags' when starting */ 3225 char_u *tn_np; /* current position in tn_tags */ 3226 int tn_did_filefind_init; 3227 int tn_hf_idx; 3228 void *tn_search_ctx; 3229 } tagname_T; 3230 3231 /* 3232 * Array indexes used for cptext argument of ins_compl_add(). 3233 */ 3234 #define CPT_ABBR 0 /* "abbr" */ 3235 #define CPT_MENU 1 /* "menu" */ 3236 #define CPT_KIND 2 /* "kind" */ 3237 #define CPT_INFO 3 /* "info" */ 3238 #define CPT_USER_DATA 4 /* "user data" */ 3239 #define CPT_COUNT 5 /* Number of entries */ 3240 3241 typedef struct { 3242 UINT32_T total[2]; 3243 UINT32_T state[8]; 3244 char_u buffer[64]; 3245 } context_sha256_T; 3246 3247 /* 3248 * types for expressions. 3249 */ 3250 typedef enum 3251 { 3252 TYPE_UNKNOWN = 0 3253 , TYPE_EQUAL /* == */ 3254 , TYPE_NEQUAL /* != */ 3255 , TYPE_GREATER /* > */ 3256 , TYPE_GEQUAL /* >= */ 3257 , TYPE_SMALLER /* < */ 3258 , TYPE_SEQUAL /* <= */ 3259 , TYPE_MATCH /* =~ */ 3260 , TYPE_NOMATCH /* !~ */ 3261 } exptype_T; 3262 3263 /* 3264 * Structure used for reading in json_decode(). 3265 */ 3266 struct js_reader 3267 { 3268 char_u *js_buf; /* text to be decoded */ 3269 char_u *js_end; /* NUL in js_buf */ 3270 int js_used; /* bytes used from js_buf */ 3271 int (*js_fill)(struct js_reader *); 3272 /* function to fill the buffer or NULL; 3273 * return TRUE when the buffer was filled */ 3274 void *js_cookie; /* can be used by js_fill */ 3275 int js_cookie_arg; /* can be used by js_fill */ 3276 }; 3277 typedef struct js_reader js_read_T; 3278 3279 typedef struct timer_S timer_T; 3280 struct timer_S 3281 { 3282 long tr_id; 3283 #ifdef FEAT_TIMERS 3284 timer_T *tr_next; 3285 timer_T *tr_prev; 3286 proftime_T tr_due; /* when the callback is to be invoked */ 3287 char tr_firing; /* when TRUE callback is being called */ 3288 char tr_paused; /* when TRUE callback is not invoked */ 3289 int tr_repeat; /* number of times to repeat, -1 forever */ 3290 long tr_interval; /* msec */ 3291 char_u *tr_callback; /* allocated */ 3292 partial_T *tr_partial; 3293 int tr_emsg_count; 3294 #endif 3295 }; 3296 3297 /* Maximum number of commands from + or -c arguments. */ 3298 #define MAX_ARG_CMDS 10 3299 3300 /* values for "window_layout" */ 3301 #define WIN_HOR 1 /* "-o" horizontally split windows */ 3302 #define WIN_VER 2 /* "-O" vertically split windows */ 3303 #define WIN_TABS 3 /* "-p" windows on tab pages */ 3304 3305 /* Struct for various parameters passed between main() and other functions. */ 3306 typedef struct 3307 { 3308 int argc; 3309 char **argv; 3310 3311 char_u *fname; /* first file to edit */ 3312 3313 int evim_mode; /* started as "evim" */ 3314 char_u *use_vimrc; /* vimrc from -u argument */ 3315 int clean; /* --clean argument */ 3316 3317 int n_commands; /* no. of commands from + or -c */ 3318 char_u *commands[MAX_ARG_CMDS]; /* commands from + or -c arg. */ 3319 char_u cmds_tofree[MAX_ARG_CMDS]; /* commands that need free() */ 3320 int n_pre_commands; /* no. of commands from --cmd */ 3321 char_u *pre_commands[MAX_ARG_CMDS]; /* commands from --cmd argument */ 3322 3323 int edit_type; /* type of editing to do */ 3324 char_u *tagname; /* tag from -t argument */ 3325 #ifdef FEAT_QUICKFIX 3326 char_u *use_ef; /* 'errorfile' from -q argument */ 3327 #endif 3328 3329 int want_full_screen; 3330 int not_a_term; /* no warning for missing term? */ 3331 int tty_fail; /* exit if not a tty */ 3332 char_u *term; /* specified terminal name */ 3333 #ifdef FEAT_CRYPT 3334 int ask_for_key; /* -x argument */ 3335 #endif 3336 int no_swap_file; /* "-n" argument used */ 3337 #ifdef FEAT_EVAL 3338 int use_debug_break_level; 3339 #endif 3340 int window_count; /* number of windows to use */ 3341 int window_layout; /* 0, WIN_HOR, WIN_VER or WIN_TABS */ 3342 3343 #ifdef FEAT_CLIENTSERVER 3344 int serverArg; /* TRUE when argument for a server */ 3345 char_u *serverName_arg; /* cmdline arg for server name */ 3346 char_u *serverStr; /* remote server command */ 3347 char_u *serverStrEnc; /* encoding of serverStr */ 3348 char_u *servername; /* allocated name for our server */ 3349 #endif 3350 #if !defined(UNIX) 3351 # define EXPAND_FILENAMES 3352 int literal; /* don't expand file names */ 3353 #endif 3354 #ifdef MSWIN 3355 int full_path; /* file name argument was full path */ 3356 #endif 3357 #ifdef FEAT_DIFF 3358 int diff_mode; /* start with 'diff' set */ 3359 #endif 3360 } mparm_T; 3361 3362 /* 3363 * Structure returned by get_lval() and used by set_var_lval(). 3364 * For a plain name: 3365 * "name" points to the variable name. 3366 * "exp_name" is NULL. 3367 * "tv" is NULL 3368 * For a magic braces name: 3369 * "name" points to the expanded variable name. 3370 * "exp_name" is non-NULL, to be freed later. 3371 * "tv" is NULL 3372 * For an index in a list: 3373 * "name" points to the (expanded) variable name. 3374 * "exp_name" NULL or non-NULL, to be freed later. 3375 * "tv" points to the (first) list item value 3376 * "li" points to the (first) list item 3377 * "range", "n1", "n2" and "empty2" indicate what items are used. 3378 * For an existing Dict item: 3379 * "name" points to the (expanded) variable name. 3380 * "exp_name" NULL or non-NULL, to be freed later. 3381 * "tv" points to the dict item value 3382 * "newkey" is NULL 3383 * For a non-existing Dict item: 3384 * "name" points to the (expanded) variable name. 3385 * "exp_name" NULL or non-NULL, to be freed later. 3386 * "tv" points to the Dictionary typval_T 3387 * "newkey" is the key for the new item. 3388 */ 3389 typedef struct lval_S 3390 { 3391 char_u *ll_name; /* start of variable name (can be NULL) */ 3392 char_u *ll_exp_name; /* NULL or expanded name in allocated memory. */ 3393 typval_T *ll_tv; /* Typeval of item being used. If "newkey" 3394 isn't NULL it's the Dict to which to add 3395 the item. */ 3396 listitem_T *ll_li; /* The list item or NULL. */ 3397 list_T *ll_list; /* The list or NULL. */ 3398 int ll_range; /* TRUE when a [i:j] range was used */ 3399 long ll_n1; /* First index for list */ 3400 long ll_n2; /* Second index for list range */ 3401 int ll_empty2; /* Second index is empty: [i:] */ 3402 dict_T *ll_dict; /* The Dictionary or NULL */ 3403 dictitem_T *ll_di; /* The dictitem or NULL */ 3404 char_u *ll_newkey; /* New key for Dict in alloc. mem or NULL. */ 3405 } lval_T; 3406 3407 /* Structure used to save the current state. Used when executing Normal mode 3408 * commands while in any other mode. */ 3409 typedef struct { 3410 int save_msg_scroll; 3411 int save_restart_edit; 3412 int save_msg_didout; 3413 int save_State; 3414 int save_insertmode; 3415 int save_finish_op; 3416 int save_opcount; 3417 tasave_T tabuf; 3418 } save_state_T; 3419