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