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