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