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