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