1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
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.
10 * This file contains various definitions of structures that are used by Vim
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.
17 #if defined(SASC) && SASC < 658
18 typedef long linenr_T
;
20 typedef unsigned short short_u
;
24 * position in file or buffer
28 linenr_T lnum
; /* line number */
29 colnr_T col
; /* column number */
30 #ifdef FEAT_VIRTUALEDIT
35 #ifdef FEAT_VIRTUALEDIT
36 # define INIT_POS_T(l, c, ca) {l, c, ca}
38 # define INIT_POS_T(l, c, ca) {l, c}
42 * Same, but without coladd.
46 linenr_T lnum
; /* line number */
47 colnr_T col
; /* column number */
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().
55 typedef struct growarray
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 */
64 #define GA_EMPTY {0, 0, 0, 0, NULL}
67 * This is here because regexp.h needs pos_T and below regprog_T is used.
71 typedef struct window_S win_T
;
72 typedef struct wininfo_S wininfo_T
;
73 typedef struct frame_S frame_T
;
74 typedef int scid_T
; /* script ID */
77 * This is here because gui.h needs the pos_T and win_T, and win_T needs gui.h
83 # ifdef FEAT_XCLIPBOARD
84 # include <X11/Intrinsic.h>
86 # define guicolor_T int /* avoid error in prototypes */
90 * marks: positions in a file
91 * (a normal mark is a lnum/col pair, the same as a file position)
94 /* (Note: for EBCDIC there are more than 26, because there are gaps in the
95 * alphabet coding. To minimize changes to the code, I decided to just
96 * increase the number of possible marks. */
97 #define NMARKS ('z' - 'a' + 1) /* max. # of named marks */
98 #define JUMPLISTSIZE 100 /* max. # of marks in jump list */
99 #define TAGSTACKSIZE 20 /* max. # of tags in tag stack */
101 typedef struct filemark
103 pos_T mark
; /* cursor position */
104 int fnum
; /* file number */
107 /* Xtended file mark: also has a file name */
108 typedef struct xfilemark
111 char_u
*fname
; /* file name, used when fnum == 0 */
115 * The taggy struct is used to store the information about a :tag command.
119 char_u
*tagname
; /* tag name */
120 fmark_T fmark
; /* cursor position BEFORE ":tag" */
121 int cur_match
; /* match number */
122 int cur_fnum
; /* buffer number used for cur_match */
126 * Structure that contains all options that are local to a window.
127 * Used twice in a window: for the current buffer and for all buffers.
128 * Also used in wininfo_T.
134 # define w_p_arab w_onebuf_opt.wo_arab /* 'arabic' */
138 # define w_p_diff w_onebuf_opt.wo_diff /* 'diff' */
142 # define w_p_fdc w_onebuf_opt.wo_fdc /* 'foldcolumn' */
144 # define w_p_fen w_onebuf_opt.wo_fen /* 'foldenable' */
146 # define w_p_fdi w_onebuf_opt.wo_fdi /* 'foldignore' */
148 # define w_p_fdl w_onebuf_opt.wo_fdl /* 'foldlevel' */
150 # define w_p_fdm w_onebuf_opt.wo_fdm /* 'foldmethod' */
152 # define w_p_fml w_onebuf_opt.wo_fml /* 'foldminlines' */
154 # define w_p_fdn w_onebuf_opt.wo_fdn /* 'foldnestmax' */
157 # define w_p_fde w_onebuf_opt.wo_fde /* 'foldexpr' */
159 # define w_p_fdt w_onebuf_opt.wo_fdt /* 'foldtext' */
162 # define w_p_fmr w_onebuf_opt.wo_fmr /* 'foldmarker' */
164 #ifdef FEAT_LINEBREAK
166 # define w_p_lbr w_onebuf_opt.wo_lbr /* 'linebreak' */
169 #define w_p_list w_onebuf_opt.wo_list /* 'list' */
171 #define w_p_nu w_onebuf_opt.wo_nu /* 'number' */
173 #define w_p_rnu w_onebuf_opt.wo_rnu /* 'relativenumber' */
174 #ifdef FEAT_LINEBREAK
176 # define w_p_nuw w_onebuf_opt.wo_nuw /* 'numberwidth' */
178 #if defined(FEAT_WINDOWS)
180 # define w_p_wfh w_onebuf_opt.wo_wfh /* 'winfixheight' */
182 # define w_p_wfw w_onebuf_opt.wo_wfw /* 'winfixwidth' */
184 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
186 # define w_p_pvw w_onebuf_opt.wo_pvw /* 'previewwindow' */
188 #ifdef FEAT_RIGHTLEFT
190 # define w_p_rl w_onebuf_opt.wo_rl /* 'rightleft' */
192 # define w_p_rlc w_onebuf_opt.wo_rlc /* 'rightleftcmd' */
195 #define w_p_scr w_onebuf_opt.wo_scr /* 'scroll' */
198 # define w_p_spell w_onebuf_opt.wo_spell /* 'spell' */
202 # define w_p_cuc w_onebuf_opt.wo_cuc /* 'cursorcolumn' */
204 # define w_p_cul w_onebuf_opt.wo_cul /* 'cursorline' */
208 #define w_p_stl w_onebuf_opt.wo_stl /* 'statusline' */
210 #ifdef FEAT_SCROLLBIND
212 # define w_p_scb w_onebuf_opt.wo_scb /* 'scrollbind' */
215 #define w_p_wrap w_onebuf_opt.wo_wrap /* 'wrap' */
218 int wo_scriptID
[WV_COUNT
]; /* SIDs for window-local options */
219 # define w_p_scriptID w_onebuf_opt.wo_scriptID
224 * Window info stored with a buffer.
226 * Two types of info are kept for a buffer which are associated with a
228 * 1. Each window can have a different line number associated with a buffer.
229 * 2. The window-local options for a buffer work in a similar way.
230 * The window-info is kept in a list at b_wininfo. It is kept in
231 * most-recently-used order.
235 wininfo_T
*wi_next
; /* next entry or NULL for last entry */
236 wininfo_T
*wi_prev
; /* previous entry or NULL for first entry */
237 win_T
*wi_win
; /* pointer to window that did set wi_fpos */
238 pos_T wi_fpos
; /* last cursor position in the file */
239 int wi_optset
; /* TRUE when wi_opt has useful values */
240 winopt_T wi_opt
; /* local window options */
242 int wi_fold_manual
; /* copy of w_fold_manual */
243 garray_T wi_folds
; /* clone of w_folds */
248 * Info used to pass info about a fold from the fold-detection code to the
249 * code that displays the foldcolumn.
251 typedef struct foldinfo
253 int fi_level
; /* level of the fold; when this is zero the
254 other fields are invalid */
255 int fi_lnum
; /* line number where fold starts */
256 int fi_low_level
; /* lowest fold level that starts in the same
260 /* Structure to store info about the Visual area. */
263 pos_T vi_start
; /* start pos of last VIsual */
264 pos_T vi_end
; /* end position of last VIsual */
265 int vi_mode
; /* VIsual_mode of last VIsual */
266 colnr_T vi_curswant
; /* MAXCOL from w_curswant */
270 * structures used for undo
273 typedef struct u_entry u_entry_T
;
274 typedef struct u_header u_header_T
;
277 u_entry_T
*ue_next
; /* pointer to next entry in list */
278 linenr_T ue_top
; /* number of line above undo block */
279 linenr_T ue_bot
; /* number of line below undo block */
280 linenr_T ue_lcount
; /* linecount when u_save called */
281 char_u
**ue_array
; /* array of lines in undo block */
282 long ue_size
; /* number of lines in ue_array */
284 int ue_magic
; /* magic number to check allocation */
290 u_header_T
*uh_next
; /* pointer to next undo header in list */
291 u_header_T
*uh_prev
; /* pointer to previous header in list */
292 u_header_T
*uh_alt_next
; /* pointer to next header for alt. redo */
293 u_header_T
*uh_alt_prev
; /* pointer to previous header for alt. redo */
294 long uh_seq
; /* sequence number, higher == newer undo */
295 int uh_walk
; /* used by undo_time() */
296 u_entry_T
*uh_entry
; /* pointer to first entry */
297 u_entry_T
*uh_getbot_entry
; /* pointer to where ue_bot must be set */
298 pos_T uh_cursor
; /* cursor position before saving */
299 #ifdef FEAT_VIRTUALEDIT
302 int uh_flags
; /* see below */
303 pos_T uh_namedm
[NMARKS
]; /* marks before undo/after redo */
305 visualinfo_T uh_visual
; /* Visual areas before undo/after redo */
307 time_t uh_time
; /* timestamp when the change was made */
309 int uh_magic
; /* magic number to check allocation */
313 /* values for uh_flags */
314 #define UH_CHANGED 0x01 /* b_changed flag before undo/after redo */
315 #define UH_EMPTYBUF 0x02 /* buffer was empty */
318 * structures used in undo.c
321 # define ALIGN_LONG /* longword alignment and use filler byte */
322 # define ALIGN_SIZE (sizeof(long))
324 # define ALIGN_SIZE (sizeof(short))
327 #define ALIGN_MASK (ALIGN_SIZE - 1)
329 typedef struct m_info minfo_T
;
332 * structure used to link chunks in one of the free chunk lists.
337 long_u m_size
; /* size of the chunk (including m_info) */
339 short_u m_size
; /* size of the chunk (including m_info) */
341 minfo_T
*m_next
; /* pointer to next free chunk in the list */
345 * structure used to link blocks in the list of allocated blocks.
347 typedef struct m_block mblock_T
;
350 mblock_T
*mb_next
; /* pointer to next allocated block */
351 size_t mb_size
; /* total size of all chunks in this block */
352 size_t mb_maxsize
; /* size of largest fee chunk */
353 minfo_T mb_info
; /* head of free chunk list for this block */
357 * things used in memfile.c
360 typedef struct block_hdr bhdr_T
;
361 typedef struct memfile memfile_T
;
362 typedef long blocknr_T
;
365 * for each (previously) used block in the memfile there is one block header.
367 * The block may be linked in the used list OR in the free list.
368 * The used blocks are also kept in hash lists.
370 * The used list is a doubly linked list, most recently used block first.
371 * The blocks in the used list have a block of memory allocated.
372 * mf_used_count is the number of pages in the used list.
373 * The hash lists are used to quickly find a block in the used list.
374 * The free list is a single linked list, not sorted.
375 * The blocks in the free list have no block of memory allocated and
376 * the contents of the block in the file (if any) is irrelevant.
381 bhdr_T
*bh_next
; /* next block_hdr in free or used list */
382 bhdr_T
*bh_prev
; /* previous block_hdr in used list */
383 bhdr_T
*bh_hash_next
; /* next block_hdr in hash list */
384 bhdr_T
*bh_hash_prev
; /* previous block_hdr in hash list */
385 blocknr_T bh_bnum
; /* block number */
386 char_u
*bh_data
; /* pointer to memory (for used block) */
387 int bh_page_count
; /* number of pages in this block */
391 char bh_flags
; /* BH_DIRTY or BH_LOCKED */
395 * when a block with a negative number is flushed to the file, it gets
396 * a positive number. Because the reference to the block is still the negative
397 * number, we remember the translation to the new positive number in the
398 * double linked trans lists. The structure is the same as the hash lists.
400 typedef struct nr_trans NR_TRANS
;
404 NR_TRANS
*nt_next
; /* next nr_trans in hash list */
405 NR_TRANS
*nt_prev
; /* previous nr_trans in hash list */
406 blocknr_T nt_old_bnum
; /* old, negative, number */
407 blocknr_T nt_new_bnum
; /* new, positive, number */
411 * structure used to store one block of the stuff/redo/recording buffers
415 struct buffblock
*b_next
; /* pointer to next buffblock */
416 char_u b_str
[1]; /* contents (actually longer) */
420 * header used for the stuff buffer and the redo buffer
424 struct buffblock bh_first
; /* first (dummy) block of list */
425 struct buffblock
*bh_curr
; /* buffblock for appending */
426 int bh_index
; /* index for reading */
427 int bh_space
; /* space in bh_curr for appending */
431 * used for completion on the command line
433 typedef struct expand
435 int xp_context
; /* type of expansion */
436 char_u
*xp_pattern
; /* start of item to expand */
437 int xp_pattern_len
; /* bytes in xp_pattern before cursor */
438 #if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
439 char_u
*xp_arg
; /* completion function */
440 int xp_scriptID
; /* SID for completion function */
442 int xp_backslash
; /* one of the XP_BS_ values */
443 #ifndef BACKSLASH_IN_FILENAME
444 int xp_shell
; /* for a shell command more characters
445 need to be escaped */
447 int xp_numfiles
; /* number of files found by
448 file name completion */
449 char_u
**xp_files
; /* list of files */
452 /* values for xp_backslash */
453 #define XP_BS_NONE 0 /* nothing special for backslashes */
454 #define XP_BS_ONE 1 /* uses one backslash before a space */
455 #define XP_BS_THREE 2 /* uses three backslashes before a space */
458 * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
459 * This needs to be saved for recursive commands, put them in a structure for
464 int hide
; /* TRUE when ":hide" was used */
465 # ifdef FEAT_BROWSE_CMD
466 int browse
; /* TRUE to invoke file dialog */
469 int split
; /* flags for win_split() */
470 int tab
; /* > 0 when ":tab" was used */
472 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
473 int confirm
; /* TRUE to invoke yes/no dialog */
475 int keepalt
; /* TRUE when ":keepalt" was used */
476 int keepmarks
; /* TRUE when ":keepmarks" was used */
477 int keepjumps
; /* TRUE when ":keepjumps" was used */
478 int lockmarks
; /* TRUE when ":lockmarks" was used */
480 char_u
*save_ei
; /* saved value of 'eventignore' */
485 * Simplistic hashing scheme to quickly locate the blocks in the used list.
486 * 64 blocks are found directly (64 * 4K = 256K, most files are smaller).
488 #define MEMHASHSIZE 64
489 #define MEMHASH(nr) ((nr) & (MEMHASHSIZE - 1))
493 char_u
*mf_fname
; /* name of the file */
494 char_u
*mf_ffname
; /* idem, full path */
495 int mf_fd
; /* file descriptor */
496 bhdr_T
*mf_free_first
; /* first block_hdr in free list */
497 bhdr_T
*mf_used_first
; /* mru block_hdr in used list */
498 bhdr_T
*mf_used_last
; /* lru block_hdr in used list */
499 unsigned mf_used_count
; /* number of pages in used list */
500 unsigned mf_used_count_max
; /* maximum number of pages in memory */
501 bhdr_T
*mf_hash
[MEMHASHSIZE
]; /* array of hash lists */
502 NR_TRANS
*mf_trans
[MEMHASHSIZE
]; /* array of trans lists */
503 blocknr_T mf_blocknr_max
; /* highest positive block number + 1*/
504 blocknr_T mf_blocknr_min
; /* lowest negative block number - 1 */
505 blocknr_T mf_neg_count
; /* number of negative blocks numbers */
506 blocknr_T mf_infile_count
; /* number of pages in the file */
507 unsigned mf_page_size
; /* number of bytes in a page */
508 int mf_dirty
; /* TRUE if there are dirty blocks */
512 * things used in memline.c
515 * When searching for a specific line, we remember what blocks in the tree
516 * are the branches leading to that block. This is stored in ml_stack. Each
517 * entry is a pointer to info in a block (may be data block or pointer block)
519 typedef struct info_pointer
521 blocknr_T ip_bnum
; /* block number */
522 linenr_T ip_low
; /* lowest lnum in this block */
523 linenr_T ip_high
; /* highest lnum in this block */
524 int ip_index
; /* index for block with current lnum */
525 } infoptr_T
; /* block/index pair */
528 typedef struct ml_chunksize
534 /* Flags when calling ml_updatechunk() */
536 #define ML_CHNK_ADDLINE 1
537 #define ML_CHNK_DELLINE 2
538 #define ML_CHNK_UPDLINE 3
542 * the memline structure holds all the information about a memline
544 typedef struct memline
546 linenr_T ml_line_count
; /* number of lines in the buffer */
548 memfile_T
*ml_mfp
; /* pointer to associated memfile */
550 #define ML_EMPTY 1 /* empty buffer */
551 #define ML_LINE_DIRTY 2 /* cached line was changed and allocated */
552 #define ML_LOCKED_DIRTY 4 /* ml_locked was changed */
553 #define ML_LOCKED_POS 8 /* ml_locked needs positive block number */
556 infoptr_T
*ml_stack
; /* stack of pointer blocks (array of IPTRs) */
557 int ml_stack_top
; /* current top if ml_stack */
558 int ml_stack_size
; /* total number of entries in ml_stack */
560 linenr_T ml_line_lnum
; /* line number of cached line, 0 if not valid */
561 char_u
*ml_line_ptr
; /* pointer to cached line */
563 bhdr_T
*ml_locked
; /* block used by last ml_get */
564 linenr_T ml_locked_low
; /* first line in ml_locked */
565 linenr_T ml_locked_high
; /* last line in ml_locked */
566 int ml_locked_lineadd
; /* number of lines inserted in ml_locked */
568 chunksize_T
*ml_chunksize
;
574 #if defined(FEAT_SIGNS) || defined(PROTO)
575 typedef struct signlist signlist_T
;
579 int id
; /* unique identifier for each placed sign */
580 linenr_T lnum
; /* line number which has this sign */
581 int typenr
; /* typenr of sign */
582 signlist_T
*next
; /* next signlist entry */
583 # ifdef FEAT_NETBEANS_INTG
584 signlist_T
*prev
; /* previous entry -- for easy reordering */
588 /* type argument for buf_getsigntype() */
590 #define SIGN_LINEHL 1
596 * Argument list: Array of file names.
597 * Used for the global argument list and the argument lists local to a window.
599 typedef struct arglist
601 garray_T al_ga
; /* growarray with the array of file names */
602 int al_refcount
; /* number of windows using this arglist */
606 * For each argument remember the file name as it was given, and the buffer
607 * number that contains the expanded file name (required for when ":cd" is
610 typedef struct argentry
612 char_u
*ae_fname
; /* file name as specified */
613 int ae_fnum
; /* buffer number with expanded file name */
617 # define ALIST(win) (win)->w_alist
619 # define ALIST(win) (&global_alist)
621 #define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data)
622 #define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data)
623 #define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data)
624 #define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data))
625 #define GARGCOUNT (global_alist.al_ga.ga_len)
626 #define ARGCOUNT (ALIST(curwin)->al_ga.ga_len)
627 #define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len)
630 * A list used for saving values of "emsg_silent". Used by ex_try() to save the
631 * value of "emsg_silent" if it was non-zero. When this is done, the CSF_SILENT
635 typedef struct eslist_elem eslist_T
;
638 int saved_emsg_silent
; /* saved value of "emsg_silent" */
639 eslist_T
*next
; /* next element on the list */
643 * For conditional commands a stack is kept of nested conditionals.
644 * When cs_idx < 0, there is no conditional command.
646 #define CSTACK_LEN 50
650 short cs_flags
[CSTACK_LEN
]; /* CSF_ flags */
651 char cs_pending
[CSTACK_LEN
]; /* CSTP_: what's pending in ":finally"*/
653 void *csp_rv
[CSTACK_LEN
]; /* return typeval for pending return */
654 void *csp_ex
[CSTACK_LEN
]; /* exception for pending throw */
656 void *cs_forinfo
[CSTACK_LEN
]; /* info used by ":for" */
657 int cs_line
[CSTACK_LEN
]; /* line nr of ":while"/":for" line */
658 int cs_idx
; /* current entry, or -1 if none */
659 int cs_looplevel
; /* nr of nested ":while"s and ":for"s */
660 int cs_trylevel
; /* nr of nested ":try"s */
661 eslist_T
*cs_emsg_silent_list
; /* saved values of "emsg_silent" */
662 char cs_lflags
; /* loop flags: CSL_ flags */
664 # define cs_rettv cs_pend.csp_rv
665 # define cs_exception cs_pend.csp_ex
667 /* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
669 # define CSF_TRUE 0x0001 /* condition was TRUE */
670 # define CSF_ACTIVE 0x0002 /* current state is active */
671 # define CSF_ELSE 0x0004 /* ":else" has been passed */
672 # define CSF_WHILE 0x0008 /* is a ":while" */
673 # define CSF_FOR 0x0010 /* is a ":for" */
675 # define CSF_TRY 0x0100 /* is a ":try" */
676 # define CSF_FINALLY 0x0200 /* ":finally" has been passed */
677 # define CSF_THROWN 0x0400 /* exception thrown to this try conditional */
678 # define CSF_CAUGHT 0x0800 /* exception caught by this try conditional */
679 # define CSF_SILENT 0x1000 /* "emsg_silent" reset by ":try" */
680 /* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
681 * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
684 * What's pending for being reactivated at the ":endtry" of this try
687 # define CSTP_NONE 0 /* nothing pending in ":finally" clause */
688 # define CSTP_ERROR 1 /* an error is pending */
689 # define CSTP_INTERRUPT 2 /* an interrupt is pending */
690 # define CSTP_THROW 4 /* a throw is pending */
691 # define CSTP_BREAK 8 /* ":break" is pending */
692 # define CSTP_CONTINUE 16 /* ":continue" is pending */
693 # define CSTP_RETURN 24 /* ":return" is pending */
694 # define CSTP_FINISH 32 /* ":finish" is pending */
697 * Flags for the cs_lflags item in struct condstack.
699 # define CSL_HAD_LOOP 1 /* just found ":while" or ":for" */
700 # define CSL_HAD_ENDLOOP 2 /* just found ":endwhile" or ":endfor" */
701 # define CSL_HAD_CONT 4 /* just found ":continue" */
702 # define CSL_HAD_FINA 8 /* just found ":finally" */
705 * A list of error messages that can be converted to an exception. "throw_msg"
706 * is only set in the first element of the list. Usually, it points to the
707 * original message stored in that element, but sometimes it points to a later
708 * message in the list. See cause_errthrow() below.
712 char_u
*msg
; /* original message */
713 char_u
*throw_msg
; /* msg to throw: usually original one */
714 struct msglist
*next
; /* next of several messages in a row */
718 * Structure describing an exception.
719 * (don't use "struct exception", it's used by the math library).
721 typedef struct vim_exception except_T
;
724 int type
; /* exception type */
725 char_u
*value
; /* exception value */
726 struct msglist
*messages
; /* message(s) causing error exception */
727 char_u
*throw_name
; /* name of the throw point */
728 linenr_T throw_lnum
; /* line number of the throw point */
729 except_T
*caught
; /* next exception on the caught stack */
733 * The exception types.
735 #define ET_USER 0 /* exception caused by ":throw" command */
736 #define ET_ERROR 1 /* error exception */
737 #define ET_INTERRUPT 2 /* interrupt exception triggered by Ctrl-C */
740 * Structure to save the error/interrupt/exception state between calls to
741 * enter_cleanup() and leave_cleanup(). Must be allocated as an automatic
742 * variable by the (common) caller of these functions.
744 typedef struct cleanup_stuff cleanup_T
;
747 int pending
; /* error/interrupt/exception state */
748 except_T
*exception
; /* exception value */
752 /* struct passed to in_id_list() */
755 int inc_tag
; /* ":syn include" unique tag */
756 short id
; /* highlight group ID of item */
757 short *cont_in_list
; /* cont.in group IDs, if non-zero */
761 * Each keyword has one keyentry, which is linked in a hash list.
763 typedef struct keyentry keyentry_T
;
767 keyentry_T
*ke_next
; /* next entry with identical "keyword[]" */
768 struct sp_syn k_syn
; /* struct passed to in_id_list() */
769 short *next_list
; /* ID list for next match (if non-zero) */
770 short flags
; /* see syntax.c */
771 char_u keyword
[1]; /* actually longer */
775 * Struct used to store one state of the state stack.
777 typedef struct buf_state
779 int bs_idx
; /* index of pattern */
780 long bs_flags
; /* flags for pattern */
781 reg_extmatch_T
*bs_extmatch
; /* external matches from start pattern */
785 * syn_state contains the syntax state stack for the start of one line.
786 * Used by b_sst_array[].
788 typedef struct syn_state synstate_T
;
792 synstate_T
*sst_next
; /* next entry in used or free list */
793 linenr_T sst_lnum
; /* line number for this state */
796 bufstate_T sst_stack
[SST_FIX_STATES
]; /* short state stack */
797 garray_T sst_ga
; /* growarray for long state stack */
799 int sst_next_flags
; /* flags for sst_next_list */
800 int sst_stacksize
; /* number of states on the stack */
801 short *sst_next_list
; /* "nextgroup" list in this state
802 * (this is a copy, don't free it! */
803 disptick_T sst_tick
; /* tick when last displayed */
804 linenr_T sst_change_lnum
;/* when non-zero, change in this line
805 * may have made the state invalid */
807 #endif /* FEAT_SYN_HL */
810 * Structure shared between syntax.c, screen.c and gui_x11.c.
812 typedef struct attr_entry
814 short ae_attr
; /* HL_BOLD, etc. */
819 char_u
*start
; /* start escape sequence */
820 char_u
*stop
; /* stop escape sequence */
824 /* These colors need to be > 8 bits to hold 256. */
825 short_u fg_color
; /* foreground color number */
826 short_u bg_color
; /* background color number */
831 guicolor_T fg_color
; /* foreground color handle */
832 guicolor_T bg_color
; /* background color handle */
833 guicolor_T sp_color
; /* special color handle */
834 GuiFont font
; /* font handle */
835 # ifdef FEAT_XFONTSET
836 GuiFontset fontset
; /* fontset handle */
847 # if defined(MACOS_X)
848 # include <sys/errno.h>
849 # define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
850 typedef struct _iconv_t
*iconv_t
;
852 # if defined(MACOS_CLASSIC)
853 typedef struct _iconv_t
*iconv_t
;
863 typedef void *iconv_t
;
868 * Used for the typeahead buffer: typebuf.
872 char_u
*tb_buf
; /* buffer for typed characters */
873 char_u
*tb_noremap
; /* mapping flags for characters in tb_buf[] */
874 int tb_buflen
; /* size of tb_buf[] */
875 int tb_off
; /* current position in tb_buf[] */
876 int tb_len
; /* number of valid bytes in tb_buf[] */
877 int tb_maplen
; /* nr of mapped bytes in tb_buf[] */
878 int tb_silent
; /* nr of silently mapped bytes in tb_buf[] */
879 int tb_no_abbr_cnt
; /* nr of bytes without abbrev. in tb_buf[] */
880 int tb_change_cnt
; /* nr of time tb_buf was changed; never zero */
883 /* Struct to hold the saved typeahead for save_typeahead(). */
886 typebuf_T save_typebuf
;
887 int typebuf_valid
; /* TRUE when save_typebuf valid */
890 struct buffheader save_stuffbuff
;
892 char_u
*save_inputbuf
;
897 * Used for conversion of terminal I/O and script files.
901 int vc_type
; /* zero or one of the CONV_ values */
902 int vc_factor
; /* max. expansion factor */
904 int vc_cpfrom
; /* codepage to convert from (CONV_CODEPAGE) */
905 int vc_cpto
; /* codepage to convert to (CONV_CODEPAGE) */
908 iconv_t vc_fd
; /* for CONV_ICONV */
910 int vc_fail
; /* fail for invalid char, don't use '?' */
914 * Structure used for reading from the viminfo file.
918 char_u
*vir_line
; /* text of the current line */
919 FILE *vir_fd
; /* file descriptor */
921 vimconv_T vir_conv
; /* encoding conversion */
926 #define CONV_TO_UTF8 1
927 #define CONV_9_TO_UTF8 2
928 #define CONV_TO_LATIN1 3
929 #define CONV_TO_LATIN9 4
932 # define CONV_CODEPAGE 10 /* codepage -> codepage */
935 # define CONV_MAC_LATIN1 20
936 # define CONV_LATIN1_MAC 21
937 # define CONV_MAC_UTF8 22
938 # define CONV_UTF8_MAC 23
942 * Structure used for mappings and abbreviations.
944 typedef struct mapblock mapblock_T
;
947 mapblock_T
*m_next
; /* next mapblock in list */
948 char_u
*m_keys
; /* mapped from */
949 int m_keylen
; /* strlen(m_keys) */
950 char_u
*m_str
; /* mapped to */
951 int m_mode
; /* valid mode */
952 int m_noremap
; /* if non-zero no re-mapping for m_str */
953 char m_silent
; /* <silent> used, don't echo commands */
955 char m_expr
; /* <expr> used, m_str is an expression */
956 scid_T m_script_ID
; /* ID of script where map was defined */
961 * Used for highlighting in the status line.
966 int userhl
; /* 0: no HL, 1-9: User HL, < 0 for syn ID */
969 /* Item for a hashtable. "hi_key" can be one of three values:
970 * NULL: Never been used
971 * HI_KEY_REMOVED: Entry was removed
972 * Otherwise: Used item, pointer to the actual key; this usually is
973 * inside the item, subtract an offset to locate the item.
974 * This reduces the size of hashitem by 1/3.
976 typedef struct hashitem_S
978 long_u hi_hash
; /* cached hash number of hi_key */
982 /* The address of "hash_removed" is used as a magic number for hi_key to
983 * indicate a removed item. */
984 #define HI_KEY_REMOVED &hash_removed
985 #define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
987 /* Initial size for a hashtable. Our items are relatively small and growing
988 * is expensive, thus use 16 as a start. Must be a power of 2. */
989 #define HT_INIT_SIZE 16
991 typedef struct hashtable_S
993 long_u ht_mask
; /* mask used for hash value (nr of items in
994 * array is "ht_mask" + 1) */
995 long_u ht_used
; /* number of items used */
996 long_u ht_filled
; /* number of items used + removed */
997 int ht_locked
; /* counter for hash_lock() */
998 int ht_error
; /* when set growing failed, can't add more
999 items before growing works */
1000 hashitem_T
*ht_array
; /* points to the array, allocated when it's
1001 not "ht_smallarray" */
1002 hashitem_T ht_smallarray
[HT_INIT_SIZE
]; /* initial array */
1005 typedef long_u hash_T
; /* Type for hi_hash */
1008 #if SIZEOF_INT <= 3 /* use long if int is smaller than 32 bits */
1009 typedef long varnumber_T
;
1011 typedef int varnumber_T
;
1013 typedef double float_T
;
1015 typedef struct listvar_S list_T
;
1016 typedef struct dictvar_S dict_T
;
1019 * Structure to hold an internal variable without a name.
1023 char v_type
; /* see below: VAR_NUMBER, VAR_STRING, etc. */
1024 char v_lock
; /* see below: VAR_LOCKED, VAR_FIXED */
1027 varnumber_T v_number
; /* number value */
1029 float_T v_float
; /* floating number value */
1031 char_u
*v_string
; /* string value (can be NULL!) */
1032 list_T
*v_list
; /* list value (can be NULL!) */
1033 dict_T
*v_dict
; /* dict value (can be NULL!) */
1037 /* Values for "v_type". */
1038 #define VAR_UNKNOWN 0
1039 #define VAR_NUMBER 1 /* "v_number" is used */
1040 #define VAR_STRING 2 /* "v_string" is used */
1041 #define VAR_FUNC 3 /* "v_string" is function name */
1042 #define VAR_LIST 4 /* "v_list" is used */
1043 #define VAR_DICT 5 /* "v_dict" is used */
1044 #define VAR_FLOAT 6 /* "v_float" is used */
1046 /* Values for "v_lock". */
1047 #define VAR_LOCKED 1 /* locked with lock(), can use unlock() */
1048 #define VAR_FIXED 2 /* locked forever */
1051 * Structure to hold an item of a list: an internal variable without a name.
1053 typedef struct listitem_S listitem_T
;
1057 listitem_T
*li_next
; /* next item in list */
1058 listitem_T
*li_prev
; /* previous item in list */
1059 typval_T li_tv
; /* type and value of the variable */
1063 * Struct used by those that are using an item in a list.
1065 typedef struct listwatch_S listwatch_T
;
1069 listitem_T
*lw_item
; /* item being watched */
1070 listwatch_T
*lw_next
; /* next watcher */
1074 * Structure to hold info about a list.
1078 listitem_T
*lv_first
; /* first item, NULL if none */
1079 listitem_T
*lv_last
; /* last item, NULL if none */
1080 int lv_refcount
; /* reference count */
1081 int lv_len
; /* number of items */
1082 listwatch_T
*lv_watch
; /* first watcher, NULL if none */
1083 int lv_idx
; /* cached index of an item */
1084 listitem_T
*lv_idx_item
; /* when not NULL item at index "lv_idx" */
1085 int lv_copyID
; /* ID used by deepcopy() */
1086 list_T
*lv_copylist
; /* copied list used by deepcopy() */
1087 char lv_lock
; /* zero, VAR_LOCKED, VAR_FIXED */
1088 list_T
*lv_used_next
; /* next list in used lists list */
1089 list_T
*lv_used_prev
; /* previous list in used lists list */
1093 * Structure to hold an item of a Dictionary.
1094 * Also used for a variable.
1095 * The key is copied into "di_key" to avoid an extra alloc/free for it.
1099 typval_T di_tv
; /* type and value of the variable */
1100 char_u di_flags
; /* flags (only used for variable) */
1101 char_u di_key
[1]; /* key (actually longer!) */
1104 typedef struct dictitem_S dictitem_T
;
1106 #define DI_FLAGS_RO 1 /* "di_flags" value: read-only variable */
1107 #define DI_FLAGS_RO_SBX 2 /* "di_flags" value: read-only in the sandbox */
1108 #define DI_FLAGS_FIX 4 /* "di_flags" value: fixed variable, not allocated */
1109 #define DI_FLAGS_LOCK 8 /* "di_flags" value: locked variable */
1112 * Structure to hold info about a Dictionary.
1116 int dv_refcount
; /* reference count */
1117 hashtab_T dv_hashtab
; /* hashtab that refers to the items */
1118 int dv_copyID
; /* ID used by deepcopy() */
1119 dict_T
*dv_copydict
; /* copied dict used by deepcopy() */
1120 char dv_lock
; /* zero, VAR_LOCKED, VAR_FIXED */
1121 dict_T
*dv_used_next
; /* next dict in used dicts list */
1122 dict_T
*dv_used_prev
; /* previous dict in used dicts list */
1125 /* values for b_syn_spell: what to do with toplevel text */
1126 #define SYNSPL_DEFAULT 0 /* spell check if @Spell not defined */
1127 #define SYNSPL_TOP 1 /* spell check toplevel text */
1128 #define SYNSPL_NOTOP 2 /* don't spell check toplevel text */
1130 /* avoid #ifdefs for when b_spell is not available */
1132 # define B_SPELL(buf) ((buf)->b_spell)
1134 # define B_SPELL(buf) (0)
1137 #ifdef FEAT_QUICKFIX
1138 typedef struct qf_info_S qf_info_T
;
1142 * buffer: structure that holds information about one file
1144 * Several windows can share a single Buffer
1145 * A buffer is unallocated if there is no memfile for it.
1146 * A buffer is new if the associated file has never been loaded yet.
1149 typedef struct file_buffer buf_T
;
1153 memline_T b_ml
; /* associated memline (also contains line
1156 buf_T
*b_next
; /* links in list of buffers */
1159 int b_nwindows
; /* nr of windows open on this buffer */
1161 int b_flags
; /* various BF_ flags */
1164 * b_ffname has the full path of the file (NULL for no name).
1165 * b_sfname is the name as the user typed it (or NULL).
1166 * b_fname is the same as b_sfname, unless ":cd" has been done,
1167 * then it is the same as b_ffname (NULL for no name).
1169 char_u
*b_ffname
; /* full path file name */
1170 char_u
*b_sfname
; /* short file name */
1171 char_u
*b_fname
; /* current file name */
1174 int b_dev_valid
; /* TRUE when b_dev has a valid number */
1175 dev_t b_dev
; /* device number */
1176 ino_t b_ino
; /* inode number */
1178 #ifdef FEAT_CW_EDITOR
1179 FSSpec b_FSSpec
; /* MacOS File Identification */
1182 char b_fab_rfm
; /* Record format */
1183 char b_fab_rat
; /* Record attribute */
1184 unsigned int b_fab_mrs
; /* Max record size */
1187 int b_sniff
; /* file was loaded through Sniff */
1190 int b_fnum
; /* buffer number for this file. */
1192 int b_changed
; /* 'modified': Set to TRUE if something in the
1193 file has been changed and not written out. */
1194 int b_changedtick
; /* incremented for each change, also for undo */
1196 int b_saving
; /* Set to TRUE if we are in the middle of
1197 saving the buffer. */
1200 * Changes to a buffer require updating of the display. To minimize the
1201 * work, remember changes made and update everything at once.
1203 int b_mod_set
; /* TRUE when there are changes since the last
1204 time the display was updated */
1205 linenr_T b_mod_top
; /* topmost lnum that was changed */
1206 linenr_T b_mod_bot
; /* lnum below last changed line, AFTER the
1208 long b_mod_xlines
; /* number of extra buffer lines inserted;
1209 negative when lines were deleted */
1211 wininfo_T
*b_wininfo
; /* list of last used info for each window */
1213 long b_mtime
; /* last change time of original file */
1214 long b_mtime_read
; /* last change time when reading */
1215 size_t b_orig_size
; /* size of original file in bytes */
1216 int b_orig_mode
; /* mode of original file */
1218 pos_T b_namedm
[NMARKS
]; /* current named marks (mark.c) */
1221 /* These variables are set when VIsual_active becomes FALSE */
1222 visualinfo_T b_visual
;
1224 int b_visual_mode_eval
; /* b_visual.vi_mode for visualmode() */
1228 pos_T b_last_cursor
; /* cursor position when last unloading this
1230 pos_T b_last_insert
; /* where Insert mode was left */
1231 pos_T b_last_change
; /* position of last change: '. mark */
1233 #ifdef FEAT_JUMPLIST
1235 * the changelist contains old change positions
1237 pos_T b_changelist
[JUMPLISTSIZE
];
1238 int b_changelistlen
; /* number of active entries */
1239 int b_new_change
; /* set by u_savecommon() */
1243 * Character table, only used in charset.c for 'iskeyword'
1244 * 32 bytes of 8 bits: 1 bit per character 0-255.
1246 char_u b_chartab
[32];
1248 #ifdef FEAT_LOCALMAP
1249 /* Table used for mappings local to a buffer. */
1250 mapblock_T
*(b_maphash
[256]);
1252 /* First abbreviation local to a buffer. */
1253 mapblock_T
*b_first_abbr
;
1255 #ifdef FEAT_USR_CMDS
1256 /* User commands local to the buffer. */
1260 * start and end of an operator, also used for '[ and ']
1266 int b_marks_read
; /* Have we read viminfo marks yet? */
1270 * The following only used in undo.c.
1272 u_header_T
*b_u_oldhead
; /* pointer to oldest header */
1273 u_header_T
*b_u_newhead
; /* pointer to newest header; may not be valid
1274 if b_u_curhead is not NULL */
1275 u_header_T
*b_u_curhead
; /* pointer to current header */
1276 int b_u_numhead
; /* current number of headers */
1277 int b_u_synced
; /* entry lists are synced */
1278 long b_u_seq_last
; /* last used undo sequence number */
1279 long b_u_seq_cur
; /* hu_seq of header below which we are now */
1280 time_t b_u_seq_time
; /* uh_time of header below which we are now */
1283 * variables for "U" command in undo.c
1285 char_u
*b_u_line_ptr
; /* saved line for "U" command */
1286 linenr_T b_u_line_lnum
; /* line number of line in u_line */
1287 colnr_T b_u_line_colnr
; /* optional column number */
1290 * The following only used in undo.c
1292 mblock_T b_block_head
; /* head of allocated memory block list */
1293 minfo_T
*b_m_search
; /* pointer to chunk before previously
1294 allocated/freed chunk */
1295 mblock_T
*b_mb_current
; /* block where m_search points in */
1297 #ifdef FEAT_INS_EXPAND
1298 int b_scanned
; /* ^N/^P have scanned this buffer */
1301 /* flags for use of ":lmap" and IM control */
1302 long b_p_iminsert
; /* input mode for insert */
1303 long b_p_imsearch
; /* input mode for search */
1304 #define B_IMODE_USE_INSERT -1 /* Use b_p_iminsert value for search */
1305 #define B_IMODE_NONE 0 /* Input via none */
1306 #define B_IMODE_LMAP 1 /* Input via langmap */
1307 #ifndef USE_IM_CONTROL
1308 # define B_IMODE_LAST 1
1310 # define B_IMODE_IM 2 /* Input via input method */
1311 # define B_IMODE_LAST 2
1315 short b_kmap_state
; /* using "lmap" mappings */
1316 # define KEYMAP_INIT 1 /* 'keymap' was set, call keymap_init() */
1317 # define KEYMAP_LOADED 2 /* 'keymap' mappings have been loaded */
1318 garray_T b_kmap_ga
; /* the keymap table */
1322 * Options local to a buffer.
1323 * They are here because their value depends on the type of file
1324 * or contents of the file being edited.
1326 int b_p_initialized
; /* set when options initialized */
1329 int b_p_scriptID
[BV_COUNT
]; /* SIDs for buffer-local options */
1332 int b_p_ai
; /* 'autoindent' */
1333 int b_p_ai_nopaste
; /* b_p_ai saved for paste mode */
1334 int b_p_ci
; /* 'copyindent' */
1335 int b_p_bin
; /* 'binary' */
1337 int b_p_bomb
; /* 'bomb' */
1339 #if defined(FEAT_QUICKFIX)
1340 char_u
*b_p_bh
; /* 'bufhidden' */
1341 char_u
*b_p_bt
; /* 'buftype' */
1343 int b_p_bl
; /* 'buflisted' */
1345 int b_p_cin
; /* 'cindent' */
1346 char_u
*b_p_cino
; /* 'cinoptions' */
1347 char_u
*b_p_cink
; /* 'cinkeys' */
1349 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
1350 char_u
*b_p_cinw
; /* 'cinwords' */
1352 #ifdef FEAT_COMMENTS
1353 char_u
*b_p_com
; /* 'comments' */
1356 char_u
*b_p_cms
; /* 'commentstring' */
1358 #ifdef FEAT_INS_EXPAND
1359 char_u
*b_p_cpt
; /* 'complete' */
1361 #ifdef FEAT_COMPL_FUNC
1362 char_u
*b_p_cfu
; /* 'completefunc' */
1363 char_u
*b_p_ofu
; /* 'omnifunc' */
1365 int b_p_eol
; /* 'endofline' */
1366 int b_p_et
; /* 'expandtab' */
1367 int b_p_et_nobin
; /* b_p_et saved for binary mode */
1369 char_u
*b_p_fenc
; /* 'fileencoding' */
1371 char_u
*b_p_ff
; /* 'fileformat' */
1373 char_u
*b_p_ft
; /* 'filetype' */
1375 char_u
*b_p_fo
; /* 'formatoptions' */
1376 char_u
*b_p_flp
; /* 'formatlistpat' */
1377 int b_p_inf
; /* 'infercase' */
1378 char_u
*b_p_isk
; /* 'iskeyword' */
1380 char_u
*b_p_def
; /* 'define' local value */
1381 char_u
*b_p_inc
; /* 'include' */
1383 char_u
*b_p_inex
; /* 'includeexpr' */
1384 long_u b_p_inex_flags
; /* flags for 'includeexpr' */
1387 #if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
1388 char_u
*b_p_inde
; /* 'indentexpr' */
1389 long_u b_p_inde_flags
; /* flags for 'indentexpr' */
1390 char_u
*b_p_indk
; /* 'indentkeys' */
1392 #if defined(FEAT_EVAL)
1393 char_u
*b_p_fex
; /* 'formatexpr' */
1394 long_u b_p_fex_flags
; /* flags for 'formatexpr' */
1397 char_u
*b_p_key
; /* 'key' */
1399 char_u
*b_p_kp
; /* 'keywordprg' */
1401 int b_p_lisp
; /* 'lisp' */
1403 char_u
*b_p_mps
; /* 'matchpairs' */
1404 int b_p_ml
; /* 'modeline' */
1405 int b_p_ml_nobin
; /* b_p_ml saved for binary mode */
1406 int b_p_ma
; /* 'modifiable' */
1407 char_u
*b_p_nf
; /* 'nrformats' */
1408 #ifdef FEAT_OSFILETYPE
1409 char_u
*b_p_oft
; /* 'osfiletype' */
1411 int b_p_pi
; /* 'preserveindent' */
1413 char_u
*b_p_qe
; /* 'quoteescape' */
1415 int b_p_ro
; /* 'readonly' */
1416 long b_p_sw
; /* 'shiftwidth' */
1418 int b_p_sn
; /* 'shortname' */
1420 #ifdef FEAT_SMARTINDENT
1421 int b_p_si
; /* 'smartindent' */
1423 long b_p_sts
; /* 'softtabstop' */
1424 long b_p_sts_nopaste
; /* b_p_sts saved for paste mode */
1425 #ifdef FEAT_SEARCHPATH
1426 char_u
*b_p_sua
; /* 'suffixesadd' */
1428 int b_p_swf
; /* 'swapfile' */
1430 long b_p_smc
; /* 'synmaxcol' */
1431 char_u
*b_p_syn
; /* 'syntax' */
1434 char_u
*b_p_spc
; /* 'spellcapcheck' */
1435 regprog_T
*b_cap_prog
; /* program for 'spellcapcheck' */
1436 char_u
*b_p_spf
; /* 'spellfile' */
1437 char_u
*b_p_spl
; /* 'spelllang' */
1439 long b_p_ts
; /* 'tabstop' */
1440 int b_p_tx
; /* 'textmode' */
1441 long b_p_tw
; /* 'textwidth' */
1442 long b_p_tw_nobin
; /* b_p_tw saved for binary mode */
1443 long b_p_tw_nopaste
; /* b_p_tw saved for paste mode */
1444 long b_p_wm
; /* 'wrapmargin' */
1445 long b_p_wm_nobin
; /* b_p_wm saved for binary mode */
1446 long b_p_wm_nopaste
; /* b_p_wm saved for paste mode */
1448 char_u
*b_p_keymap
; /* 'keymap' */
1451 /* local values for options which are normally global */
1452 #ifdef FEAT_QUICKFIX
1453 char_u
*b_p_gp
; /* 'grepprg' local value */
1454 char_u
*b_p_mp
; /* 'makeprg' local value */
1455 char_u
*b_p_efm
; /* 'errorformat' local value */
1457 char_u
*b_p_ep
; /* 'equalprg' local value */
1458 char_u
*b_p_path
; /* 'path' local value */
1459 int b_p_ar
; /* 'autoread' local value */
1460 char_u
*b_p_tags
; /* 'tags' local value */
1461 #ifdef FEAT_INS_EXPAND
1462 char_u
*b_p_dict
; /* 'dictionary' local value */
1463 char_u
*b_p_tsr
; /* 'thesaurus' local value */
1466 /* end of buffer options */
1468 int b_start_eol
; /* last line had eol when it was read */
1469 int b_start_ffc
; /* first char of 'ff' when edit started */
1471 char_u
*b_start_fenc
; /* 'fileencoding' when edit started or NULL */
1472 int b_bad_char
; /* "++bad=" argument when edit started or 0 */
1473 int b_start_bomb
; /* 'bomb' when it was read */
1477 dictitem_T b_bufvar
; /* variable for "b:" Dictionary */
1478 dict_T b_vars
; /* internal variables, local to buffer */
1481 #if defined(FEAT_BEVAL) && defined(FEAT_EVAL)
1482 char_u
*b_p_bexpr
; /* 'balloonexpr' local value */
1483 long_u b_p_bexpr_flags
;/* flags for 'balloonexpr' */
1486 /* When a buffer is created, it starts without a swap file. b_may_swap is
1487 * then set to indicate that a swap file may be opened later. It is reset
1488 * if a swap file could not be opened.
1491 int b_did_warn
; /* Set to 1 if user has been warned on first
1492 change of a read-only file */
1494 /* Two special kinds of buffers:
1495 * help buffer - used for help files, won't use a swap file.
1496 * spell buffer - used for spell info, never displayed and doesn't have a
1499 int b_help
; /* TRUE for help file buffer (when set b_p_bt
1502 int b_spell
; /* TRUE for a spell file buffer, most fields
1503 are not used! Use the B_SPELL macro to
1504 access b_spell without #ifdef. */
1508 int b_shortname
; /* this file has an 8.3 file name */
1511 #ifdef FEAT_MZSCHEME
1512 void *b_mzscheme_ref
; /* The MzScheme reference to this buffer */
1516 void *b_perl_private
;
1520 void *b_python_ref
; /* The Python reference to this buffer */
1532 hashtab_T b_keywtab
; /* syntax keywords hash table */
1533 hashtab_T b_keywtab_ic
; /* idem, ignore case */
1534 int b_syn_error
; /* TRUE when error occured in HL */
1535 int b_syn_ic
; /* ignore case for :syn cmds */
1536 int b_syn_spell
; /* SYNSPL_ values */
1537 garray_T b_syn_patterns
; /* table for syntax patterns */
1538 garray_T b_syn_clusters
; /* table for syntax clusters */
1539 int b_spell_cluster_id
; /* @Spell cluster ID or 0 */
1540 int b_nospell_cluster_id
; /* @NoSpell cluster ID or 0 */
1541 int b_syn_containedin
; /* TRUE when there is an item with a
1542 "containedin" argument */
1543 int b_syn_sync_flags
; /* flags about how to sync */
1544 short b_syn_sync_id
; /* group to sync on */
1545 long b_syn_sync_minlines
; /* minimal sync lines offset */
1546 long b_syn_sync_maxlines
; /* maximal sync lines offset */
1547 long b_syn_sync_linebreaks
; /* offset for multi-line pattern */
1548 char_u
*b_syn_linecont_pat
; /* line continuation pattern */
1549 regprog_T
*b_syn_linecont_prog
; /* line continuation program */
1550 int b_syn_linecont_ic
; /* ignore-case flag for above */
1551 int b_syn_topgrp
; /* for ":syntax include" */
1552 # ifdef FEAT_FOLDING
1553 int b_syn_folditems
; /* number of patterns with the HL_FOLD
1557 * b_sst_array[] contains the state stack for a number of lines, for the start
1558 * of that line (col == 0). This avoids having to recompute the syntax state
1560 * b_sst_array[] is allocated to hold the state for all displayed lines, and
1561 * states for 1 out of about 20 other lines.
1562 * b_sst_array pointer to an array of synstate_T
1563 * b_sst_len number of entries in b_sst_array[]
1564 * b_sst_first pointer to first used entry in b_sst_array[] or NULL
1565 * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL
1566 * b_sst_freecount number of free entries in b_sst_array[]
1567 * b_sst_check_lnum entries after this lnum need to be checked for
1568 * validity (MAXLNUM means no check needed)
1570 synstate_T
*b_sst_array
;
1572 synstate_T
*b_sst_first
;
1573 synstate_T
*b_sst_firstfree
;
1574 int b_sst_freecount
;
1575 linenr_T b_sst_check_lnum
;
1576 short_u b_sst_lasttick
; /* last display tick */
1577 #endif /* FEAT_SYN_HL */
1580 /* for spell checking */
1581 garray_T b_langp
; /* list of pointers to slang_T, see spell.c */
1582 char_u b_spell_ismw
[256];/* flags: is midword char */
1584 char_u
*b_spell_ismw_mb
; /* multi-byte midword chars */
1589 signlist_T
*b_signlist
; /* list of signs to draw */
1592 #ifdef FEAT_NETBEANS_INTG
1593 int b_netbeans_file
; /* TRUE when buffer is owned by NetBeans */
1594 int b_was_netbeans_file
;/* TRUE if b_netbeans_file was once set */
1602 * Stuff for diff mode.
1604 # define DB_COUNT 4 /* up to four buffers can be diff'ed */
1607 * Each diffblock defines where a block of lines starts in each of the buffers
1608 * and how many lines it occupies in that buffer. When the lines are missing
1609 * in the buffer the df_count[] is zero. This is all counted in
1611 * There is always at least one unchanged line in between the diffs.
1612 * Otherwise it would have been included in the diff above or below it.
1613 * df_lnum[] + df_count[] is the lnum below the change. When in one buffer
1614 * lines have been inserted, in the other buffer df_lnum[] is the line below
1615 * the insertion and df_count[] is zero. When appending lines at the end of
1616 * the buffer, df_lnum[] is one beyond the end!
1617 * This is using a linked list, because the number of differences is expected
1618 * to be reasonable small. The list is sorted on lnum.
1620 typedef struct diffblock_S diff_T
;
1624 linenr_T df_lnum
[DB_COUNT
]; /* line number in buffer */
1625 linenr_T df_count
[DB_COUNT
]; /* nr of inserted/changed lines */
1629 #define SNAP_HELP_IDX 0
1631 # define SNAP_AUCMD_IDX 1
1632 # define SNAP_COUNT 2
1634 # define SNAP_COUNT 1
1638 * Tab pages point to the top frame of each tab page.
1639 * Note: Most values are NOT valid for the current tab page! Use "curwin",
1640 * "firstwin", etc. for that. "tp_topframe" is always valid and can be
1641 * compared against "topframe" to find the current tab page.
1643 typedef struct tabpage_S tabpage_T
;
1646 tabpage_T
*tp_next
; /* next tabpage or NULL */
1647 frame_T
*tp_topframe
; /* topframe for the windows */
1648 win_T
*tp_curwin
; /* current window in this Tab page */
1649 win_T
*tp_prevwin
; /* previous window in this Tab page */
1650 win_T
*tp_firstwin
; /* first window in this Tab page */
1651 win_T
*tp_lastwin
; /* last window in this Tab page */
1652 long tp_old_Rows
; /* Rows when Tab page was left */
1653 long tp_old_Columns
; /* Columns when Tab page was left */
1654 long tp_ch_used
; /* value of 'cmdheight' when frame size
1657 int tp_prev_which_scrollbars
[3];
1658 /* previous value of which_scrollbars */
1661 diff_T
*tp_first_diff
;
1662 buf_T
*(tp_diffbuf
[DB_COUNT
]);
1663 int tp_diff_invalid
; /* list of diffs is outdated */
1665 frame_T
*(tp_snapshot
[SNAP_COUNT
]); /* window layout snapshots */
1667 dictitem_T tp_winvar
; /* variable for "t:" Dictionary */
1668 dict_T tp_vars
; /* internal variables, local to tab page */
1673 * Structure to cache info for displayed lines in w_lines[].
1674 * Each logical line has one entry.
1675 * The entry tells how the logical line is currently displayed in the window.
1676 * This is updated when displaying the window.
1677 * When the display is changed (e.g., when clearing the screen) w_lines_valid
1678 * is changed to exclude invalid entries.
1679 * When making changes to the buffer, wl_valid is reset to indicate wl_size
1680 * may not reflect what is actually in the buffer. When wl_valid is FALSE,
1681 * the entries can only be used to count the number of displayed lines used.
1682 * wl_lnum and wl_lastlnum are invalid too.
1684 typedef struct w_line
1686 linenr_T wl_lnum
; /* buffer line number for logical line */
1687 short_u wl_size
; /* height in screen lines */
1688 char wl_valid
; /* TRUE values are valid for text in buffer */
1690 char wl_folded
; /* TRUE when this is a range of folded lines */
1691 linenr_T wl_lastlnum
; /* last buffer line number for logical line */
1696 * Windows are kept in a tree of frames. Each frame has a column (FR_COL)
1697 * or row (FR_ROW) layout or is a leaf, which has a window.
1701 char fr_layout
; /* FR_LEAF, FR_COL or FR_ROW */
1702 #ifdef FEAT_VERTSPLIT
1704 int fr_newwidth
; /* new width used in win_equal_rec() */
1707 int fr_newheight
; /* new height used in win_equal_rec() */
1708 frame_T
*fr_parent
; /* containing frame or NULL */
1709 frame_T
*fr_next
; /* frame right or below in same parent, NULL
1711 frame_T
*fr_prev
; /* frame left or above in same parent, NULL
1713 /* fr_child and fr_win are mutually exclusive */
1714 frame_T
*fr_child
; /* first contained frame */
1715 win_T
*fr_win
; /* window that fills this frame */
1718 #define FR_LEAF 0 /* frame is a leaf */
1719 #define FR_ROW 1 /* frame with a row of windows */
1720 #define FR_COL 2 /* frame with a column of windows */
1723 * Struct used for highlighting 'hlsearch' matches, matches defined by
1724 * ":match" and matches defined by match functions.
1725 * For 'hlsearch' there is one pattern for all windows. For ":match" and the
1726 * match functions there is a different pattern for each window.
1730 regmmatch_T rm
; /* points to the regexp program; contains last found
1731 match (may continue in next line) */
1732 buf_T
*buf
; /* the buffer to search for a match */
1733 linenr_T lnum
; /* the line to search for a match */
1734 int attr
; /* attributes to be used for a match */
1735 int attr_cur
; /* attributes currently active in win_line() */
1736 linenr_T first_lnum
; /* first lnum to search for multi-line pat */
1737 colnr_T startcol
; /* in win_line() points to char where HL starts */
1738 colnr_T endcol
; /* in win_line() points to char where HL ends */
1740 proftime_T tm
; /* for a time limit */
1745 * matchitem_T provides a linked list for storing match items for ":match" and
1746 * the match functions.
1748 typedef struct matchitem matchitem_T
;
1752 int id
; /* match ID */
1753 int priority
; /* match priority */
1754 char_u
*pattern
; /* pattern to highlight */
1755 int hlg_id
; /* highlight group ID */
1756 regmmatch_T match
; /* regexp program for pattern */
1757 match_T hl
; /* struct for doing the actual highlighting */
1761 * Structure which contains all information that belongs to a window
1763 * All row numbers are relative to the start of the window, except w_winrow.
1767 buf_T
*w_buffer
; /* buffer we are a window into (used
1768 often, keep it the first item!) */
1771 win_T
*w_prev
; /* link to previous window */
1772 win_T
*w_next
; /* link to next window */
1775 frame_T
*w_frame
; /* frame containing this window */
1777 pos_T w_cursor
; /* cursor position in buffer */
1779 colnr_T w_curswant
; /* The column we'd like to be at. This is
1780 used to try to stay in the same column
1781 for up/down cursor motions. */
1783 int w_set_curswant
; /* If set, then update w_curswant the next
1784 time through cursupdate() to the
1785 current virtual column */
1789 * the next six are used to update the visual part
1791 char w_old_visual_mode
; /* last known VIsual_mode */
1792 linenr_T w_old_cursor_lnum
; /* last known end of visual part */
1793 colnr_T w_old_cursor_fcol
; /* first column for block visual part */
1794 colnr_T w_old_cursor_lcol
; /* last column for block visual part */
1795 linenr_T w_old_visual_lnum
; /* last known start of visual part */
1796 colnr_T w_old_visual_col
; /* last known start of visual part */
1797 colnr_T w_old_curswant
; /* last known value of Curswant */
1801 * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for
1802 * displaying the buffer.
1804 linenr_T w_topline
; /* buffer line number of the line at the
1805 top of the window */
1807 char w_topline_was_set
; /* flag set to TRUE when topline is set,
1808 e.g. by winrestview() */
1811 int w_topfill
; /* number of filler lines above w_topline */
1812 int w_old_topfill
; /* w_topfill at last redraw */
1813 int w_botfill
; /* TRUE when filler lines are actually
1814 below w_topline (at end of file) */
1815 int w_old_botfill
; /* w_botfill at last redraw */
1817 colnr_T w_leftcol
; /* window column number of the left most
1818 character in the window; used when
1820 colnr_T w_skipcol
; /* starting column when a single line
1821 doesn't fit in the window */
1824 * Layout of the window in the screen.
1825 * May need to add "msg_scrolled" to "w_winrow" in rare situations.
1828 int w_winrow
; /* first row of window in screen */
1830 int w_height
; /* number of rows in window, excluding
1831 status/command line(s) */
1833 int w_status_height
; /* number of status lines (0 or 1) */
1835 #ifdef FEAT_VERTSPLIT
1836 int w_wincol
; /* Leftmost column of window in screen.
1838 int w_width
; /* Width of window, excluding separation.
1840 int w_vsep_width
; /* Number of separator columns (0 or 1).
1841 use W_VSEP_WIDTH() */
1845 * === start of cached values ====
1848 * Recomputing is minimized by storing the result of computations.
1849 * Use functions in screen.c to check if they are valid and to update.
1850 * w_valid is a bitfield of flags, which indicate if specific values are
1851 * valid or need to be recomputed. See screen.c for values.
1854 pos_T w_valid_cursor
; /* last known position of w_cursor, used
1855 to adjust w_valid */
1856 colnr_T w_valid_leftcol
; /* last known w_leftcol */
1859 * w_cline_height is the number of physical lines taken by the buffer line
1860 * that the cursor is on. We use this to avoid extra calls to plines().
1862 int w_cline_height
; /* current size of cursor line */
1864 int w_cline_folded
; /* cursor line is folded */
1867 int w_cline_row
; /* starting row of the cursor line */
1869 colnr_T w_virtcol
; /* column number of the cursor in the
1870 buffer line, as opposed to the column
1871 number we're at on the screen. This
1872 makes a difference on lines which span
1873 more than one screen line or when
1874 w_leftcol is non-zero */
1877 * w_wrow and w_wcol specify the cursor position in the window.
1878 * This is related to positions in the window, not in the display or
1879 * buffer, thus w_wrow is relative to w_winrow.
1881 int w_wrow
, w_wcol
; /* cursor position in window */
1883 linenr_T w_botline
; /* number of the line below the bottom of
1885 int w_empty_rows
; /* number of ~ rows in window */
1887 int w_filler_rows
; /* number of filler rows at the end of the
1892 * Info about the lines currently in the window is remembered to avoid
1893 * recomputing it every time. The allocated size of w_lines[] is Rows.
1894 * Only the w_lines_valid entries are actually valid.
1895 * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
1896 * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
1897 * Between changing text and updating the display w_lines[] represents
1898 * what is currently displayed. wl_valid is reset to indicated this.
1899 * This is used for efficient redrawing.
1901 int w_lines_valid
; /* number of valid entries */
1905 garray_T w_folds
; /* array of nested folds */
1906 char w_fold_manual
; /* when TRUE: some folds are opened/closed
1908 char w_foldinvalid
; /* when TRUE: folding needs to be
1911 #ifdef FEAT_LINEBREAK
1912 int w_nrwidth
; /* width of 'number' and 'relativenumber'
1913 column being used */
1917 * === end of cached values ===
1920 int w_redr_type
; /* type of redraw to be performed on win */
1921 int w_upd_rows
; /* number of window lines to update when
1922 w_redr_type is REDRAW_TOP */
1923 linenr_T w_redraw_top
; /* when != 0: first line needing redraw */
1924 linenr_T w_redraw_bot
; /* when != 0: last line needing redraw */
1926 int w_redr_status
; /* if TRUE status line must be redrawn */
1929 #ifdef FEAT_CMDL_INFO
1930 /* remember what is shown in the ruler for this window (if 'ruler' set) */
1931 pos_T w_ru_cursor
; /* cursor position shown in ruler */
1932 colnr_T w_ru_virtcol
; /* virtcol shown in ruler */
1933 linenr_T w_ru_topline
; /* topline shown in ruler */
1934 linenr_T w_ru_line_count
; /* line count used for ruler */
1936 int w_ru_topfill
; /* topfill shown in ruler */
1938 char w_ru_empty
; /* TRUE if ruler shows 0-1 (empty line) */
1941 int w_alt_fnum
; /* alternate file (for # and CTRL-^) */
1944 alist_T
*w_alist
; /* pointer to arglist for this window */
1946 int w_arg_idx
; /* current index in argument list (can be
1948 int w_arg_idx_invalid
; /* editing another file than w_arg_idx */
1950 char_u
*w_localdir
; /* absolute path of local directory or
1953 * Options local to a window.
1954 * They are local because they influence the layout of the window or
1955 * depend on the window layout.
1956 * There are two values: w_onebuf_opt is local to the buffer currently in
1957 * this window, w_allbuf_opt is for all buffers in this window.
1959 winopt_T w_onebuf_opt
;
1960 winopt_T w_allbuf_opt
;
1962 /* A few options have local flags for P_INSECURE. */
1964 long_u w_p_stl_flags
; /* flags for 'statusline' */
1967 long_u w_p_fde_flags
; /* flags for 'foldexpr' */
1968 long_u w_p_fdt_flags
; /* flags for 'foldtext' */
1971 /* transform a pointer to a "onebuf" option into a "allbuf" option */
1972 #define GLOBAL_WO(p) ((char *)p + sizeof(winopt_T))
1974 #ifdef FEAT_SCROLLBIND
1979 dictitem_T w_winvar
; /* variable for "w:" Dictionary */
1980 dict_T w_vars
; /* internal variables, local to window */
1983 #if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
1984 int w_farsi
; /* for the window dependent Farsi functions */
1988 * The w_prev_pcmark field is used to check whether we really did jump to
1989 * a new line after setting the w_pcmark. If not, then we revert to
1990 * using the previous w_pcmark.
1992 pos_T w_pcmark
; /* previous context mark */
1993 pos_T w_prev_pcmark
; /* previous w_pcmark */
1995 #ifdef FEAT_JUMPLIST
1997 * the jumplist contains old cursor positions
1999 xfmark_T w_jumplist
[JUMPLISTSIZE
];
2000 int w_jumplistlen
; /* number of active entries */
2001 int w_jumplistidx
; /* current position */
2003 int w_changelistidx
; /* current position in b_changelist */
2006 #ifdef FEAT_SEARCH_EXTRA
2007 matchitem_T
*w_match_head
; /* head of match list */
2008 int w_next_match_id
; /* next match ID */
2012 * the tagstack grows from 0 upwards:
2017 taggy_T w_tagstack
[TAGSTACKSIZE
]; /* the tag stack */
2018 int w_tagstackidx
; /* idx just below active entry */
2019 int w_tagstacklen
; /* number of tags on stack */
2022 * w_fraction is the fractional row of the cursor within the window, from
2023 * 0 at the top row to FRACTION_MULT at the last row.
2024 * w_prev_fraction_row was the actual cursor row when w_fraction was last
2028 int w_prev_fraction_row
;
2031 scrollbar_T w_scrollbars
[2]; /* vert. Scrollbars for this window */
2033 #ifdef FEAT_LINEBREAK
2034 linenr_T w_nrwidth_line_count
; /* line count when ml_nrwidth_width
2036 int w_nrwidth_width
; /* nr of chars to print line count. */
2039 #ifdef FEAT_QUICKFIX
2040 qf_info_T
*w_llist
; /* Location list for this window */
2042 * Location list reference used in the location list window.
2043 * In a non-location list window, w_llist_ref is NULL.
2045 qf_info_T
*w_llist_ref
;
2049 #ifdef FEAT_MZSCHEME
2050 void *w_mzscheme_ref
; /* The MzScheme value for this window */
2054 void *w_perl_private
;
2058 void *w_python_ref
; /* The Python value for this window */
2071 * Arguments for operators.
2073 typedef struct oparg_S
2075 int op_type
; /* current pending operator type */
2076 int regname
; /* register to use for the operator */
2077 int motion_type
; /* type of the current cursor motion */
2078 int motion_force
; /* force motion type: 'v', 'V' or CTRL-V */
2079 int use_reg_one
; /* TRUE if delete uses reg 1 even when not
2081 int inclusive
; /* TRUE if char motion is inclusive (only
2082 valid when motion_type is MCHAR */
2083 int end_adjusted
; /* backuped b_op_end one char (only used by
2085 pos_T start
; /* start of the operator */
2086 pos_T end
; /* end of the operator */
2087 pos_T cursor_start
; /* cursor position before motion for "gw" */
2089 long line_count
; /* number of lines from op_start to op_end
2091 int empty
; /* op_start and op_end the same (only used by
2094 int is_VIsual
; /* operator on Visual area */
2095 int block_mode
; /* current operator is Visual block mode */
2097 colnr_T start_vcol
; /* start col for block mode operator */
2098 colnr_T end_vcol
; /* end col for block mode operator */
2100 long prev_opcount
; /* ca.opcount saved for K_CURSORHOLD */
2101 long prev_count0
; /* ca.count0 saved for K_CURSORHOLD */
2106 * Arguments for Normal mode commands.
2108 typedef struct cmdarg_S
2110 oparg_T
*oap
; /* Operator arguments */
2111 int prechar
; /* prefix character (optional, always 'g') */
2112 int cmdchar
; /* command character */
2113 int nchar
; /* next command character (optional) */
2115 int ncharC1
; /* first composing character (optional) */
2116 int ncharC2
; /* second composing character (optional) */
2118 int extra_char
; /* yet another character (optional) */
2119 long opcount
; /* count before an operator */
2120 long count0
; /* count before command, default 0 */
2121 long count1
; /* count before command, default 1 */
2122 int arg
; /* extra argument from nv_cmds[] */
2123 int retval
; /* return: CA_* values */
2124 char_u
*searchbuf
; /* return: pointer to search pattern or NULL */
2127 /* values for retval: */
2128 #define CA_COMMAND_BUSY 1 /* skip restarting edit() once */
2129 #define CA_NO_ADJ_OP_END 2 /* don't adjust operator end */
2133 * struct to store values from 'guicursor' and 'mouseshape'
2135 /* Indexes in shape_table[] */
2136 #define SHAPE_IDX_N 0 /* Normal mode */
2137 #define SHAPE_IDX_V 1 /* Visual mode */
2138 #define SHAPE_IDX_I 2 /* Insert mode */
2139 #define SHAPE_IDX_R 3 /* Replace mode */
2140 #define SHAPE_IDX_C 4 /* Command line Normal mode */
2141 #define SHAPE_IDX_CI 5 /* Command line Insert mode */
2142 #define SHAPE_IDX_CR 6 /* Command line Replace mode */
2143 #define SHAPE_IDX_O 7 /* Operator-pending mode */
2144 #define SHAPE_IDX_VE 8 /* Visual mode with 'selection' exclusive */
2145 #define SHAPE_IDX_CLINE 9 /* On command line */
2146 #define SHAPE_IDX_STATUS 10 /* A status line */
2147 #define SHAPE_IDX_SDRAG 11 /* dragging a status line */
2148 #define SHAPE_IDX_VSEP 12 /* A vertical separator line */
2149 #define SHAPE_IDX_VDRAG 13 /* dragging a vertical separator line */
2150 #define SHAPE_IDX_MORE 14 /* Hit-return or More */
2151 #define SHAPE_IDX_MOREL 15 /* Hit-return or More in last line */
2152 #define SHAPE_IDX_SM 16 /* showing matching paren */
2153 #define SHAPE_IDX_COUNT 17
2155 #define SHAPE_BLOCK 0 /* block cursor */
2156 #define SHAPE_HOR 1 /* horizontal bar cursor */
2157 #define SHAPE_VER 2 /* vertical bar cursor */
2159 #define MSHAPE_NUMBERED 1000 /* offset for shapes identified by number */
2160 #define MSHAPE_HIDE 1 /* hide mouse pointer */
2162 #define SHAPE_MOUSE 1 /* used for mouse pointer shape */
2163 #define SHAPE_CURSOR 2 /* used for text cursor shape */
2165 typedef struct cursor_entry
2167 int shape
; /* one of the SHAPE_ defines */
2168 int mshape
; /* one of the MSHAPE defines */
2169 int percentage
; /* percentage of cell for bar */
2170 long blinkwait
; /* blinking, wait time before blinking starts */
2171 long blinkon
; /* blinking, on time */
2172 long blinkoff
; /* blinking, off time */
2173 int id
; /* highlight group ID */
2174 int id_lm
; /* highlight group ID for :lmap mode */
2175 char *name
; /* mode name (fixed) */
2176 char used_for
; /* SHAPE_MOUSE and/or SHAPE_CURSOR */
2178 #endif /* CURSOR_SHAPE */
2182 /* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
2183 #define MENU_INDEX_INVALID -1
2184 #define MENU_INDEX_NORMAL 0
2185 #define MENU_INDEX_VISUAL 1
2186 #define MENU_INDEX_SELECT 2
2187 #define MENU_INDEX_OP_PENDING 3
2188 #define MENU_INDEX_INSERT 4
2189 #define MENU_INDEX_CMDLINE 5
2190 #define MENU_INDEX_TIP 6
2191 #define MENU_MODES 7
2194 #define MENU_NORMAL_MODE (1 << MENU_INDEX_NORMAL)
2195 #define MENU_VISUAL_MODE (1 << MENU_INDEX_VISUAL)
2196 #define MENU_SELECT_MODE (1 << MENU_INDEX_SELECT)
2197 #define MENU_OP_PENDING_MODE (1 << MENU_INDEX_OP_PENDING)
2198 #define MENU_INSERT_MODE (1 << MENU_INDEX_INSERT)
2199 #define MENU_CMDLINE_MODE (1 << MENU_INDEX_CMDLINE)
2200 #define MENU_TIP_MODE (1 << MENU_INDEX_TIP)
2201 #define MENU_ALL_MODES ((1 << MENU_INDEX_TIP) - 1)
2202 /*note MENU_INDEX_TIP is not a 'real' mode*/
2204 /* Start a menu name with this to not include it on the main menu bar */
2205 #define MNU_HIDDEN_CHAR ']'
2207 typedef struct VimMenu vimmenu_T
;
2211 int modes
; /* Which modes is this menu visible for? */
2212 int enabled
; /* for which modes the menu is enabled */
2213 char_u
*name
; /* Name of menu, possibly translated */
2214 char_u
*dname
; /* Displayed Name ("name" without '&') */
2215 #ifdef FEAT_MULTI_LANG
2216 char_u
*en_name
; /* "name" untranslated, NULL when "name"
2217 * was not translated */
2218 char_u
*en_dname
; /* "dname" untranslated, NULL when "dname"
2219 * was not translated */
2221 int mnemonic
; /* mnemonic key (after '&') */
2222 char_u
*actext
; /* accelerator text (after TAB) */
2223 int priority
; /* Menu order priority */
2225 void (*cb
) __ARGS((vimmenu_T
*)); /* Call-back routine */
2228 char_u
*iconfile
; /* name of file for icon or NULL */
2229 int iconidx
; /* icon index (-1 if not set) */
2230 int icon_builtin
; /* icon names is BuiltIn{nr} */
2232 char_u
*strings
[MENU_MODES
]; /* Mapped string for each mode */
2233 int noremap
[MENU_MODES
]; /* A REMAP_ flag for each mode */
2234 char silent
[MENU_MODES
]; /* A silent flag for each mode */
2235 vimmenu_T
*children
; /* Children of sub-menu */
2236 vimmenu_T
*parent
; /* Parent of menu */
2237 vimmenu_T
*next
; /* Next item in menu */
2239 Widget id
; /* Manage this to enable item */
2240 Widget submenu_id
; /* If this is submenu, add children here */
2243 GtkWidget
*id
; /* Manage this to enable item */
2244 GtkWidget
*submenu_id
; /* If this is submenu, add children here */
2245 GtkWidget
*tearoff_handle
;
2246 GtkWidget
*label
; /* Used by "set wak=" code. */
2248 #ifdef FEAT_GUI_MOTIF
2249 int sensitive
; /* turn button on/off */
2250 char **xpm
; /* pixmap data */
2251 char *xpm_fname
; /* file with pixmap data */
2253 #ifdef FEAT_GUI_ATHENA
2254 Pixmap image
; /* Toolbar image */
2256 #ifdef FEAT_BEVAL_TIP
2257 BalloonEval
*tip
; /* tooltip for this menu item */
2260 UINT id
; /* Id of menu item */
2261 HMENU submenu_id
; /* If this is submenu, add children here */
2264 UINT id
; /* Id of menu item */
2265 HMENU submenu_id
; /* If this is submenu, add children here */
2266 HWND tearoff_handle
; /* hWnd of tearoff if created */
2269 /* MenuHandle id; */
2270 /* short index; */ /* the item index within the father menu */
2271 short menu_id
; /* the menu id to which this item belong */
2272 short submenu_id
; /* the menu id of the children (could be
2273 get through some tricks) */
2274 MenuHandle menu_handle
;
2275 MenuHandle submenu_handle
;
2278 int *id
; /* Not used, but gui.c needs it */
2279 int greyed_out
; /* Flag */
2282 #ifdef FEAT_GUI_PHOTON
2284 PtWidget_t
*submenu_id
;
2288 /* For generating prototypes when FEAT_MENU isn't defined. */
2289 typedef int vimmenu_T
;
2291 #endif /* FEAT_MENU */
2294 * Struct to save values in before executing autocommands for a buffer that is
2295 * not the current buffer. Without FEAT_AUTOCMD only "curbuf" is remembered.
2299 buf_T
*save_curbuf
; /* saved curbuf */
2301 int use_aucmd_win
; /* using aucmd_win */
2302 win_T
*save_curwin
; /* saved curwin */
2303 win_T
*new_curwin
; /* new curwin */
2304 buf_T
*new_curbuf
; /* new curbuf */
2305 char_u
*globaldir
; /* saved value of globaldir */
2310 * Generic option table item, only used for printer at the moment.
2317 char_u
*string
; /* points into option string */
2323 * Structure to hold printing color and font attributes.
2336 * Structure passed back to the generic printer code.
2340 int n_collated_copies
;
2341 int n_uncollated_copies
;
2346 prt_text_attr_T number
;
2353 #ifdef FEAT_POSTSCRIPT
2359 #define PRINT_NUMBER_WIDTH 8
2362 * Used for popup menu items.
2366 char_u
*pum_text
; /* main menu text */
2367 char_u
*pum_kind
; /* extra kind text (may be truncated) */
2368 char_u
*pum_extra
; /* extra menu text (may be truncated) */
2369 char_u
*pum_info
; /* extra info */
2373 * Structure used for get_tagfname().
2377 char_u
*tn_tags
; /* value of 'tags' when starting */
2378 char_u
*tn_np
; /* current position in tn_tags */
2379 int tn_did_filefind_init
;
2381 void *tn_search_ctx
;
2385 * Array indexes used for cptext argument of ins_compl_add().
2387 #define CPT_ABBR 0 /* "abbr" */
2388 #define CPT_MENU 1 /* "menu" */
2389 #define CPT_KIND 2 /* "kind" */
2390 #define CPT_INFO 3 /* "info" */
2391 #define CPT_COUNT 4 /* Number of entries */