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