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' */
172 #ifdef FEAT_LINEBREAK
174 # define w_p_nuw w_onebuf_opt.wo_nuw /* 'numberwidth' */
176 #if defined(FEAT_WINDOWS)
178 # define w_p_wfh w_onebuf_opt.wo_wfh /* 'winfixheight' */
180 # define w_p_wfw w_onebuf_opt.wo_wfw /* 'winfixwidth' */
182 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
184 # define w_p_pvw w_onebuf_opt.wo_pvw /* 'previewwindow' */
186 #ifdef FEAT_RIGHTLEFT
188 # define w_p_rl w_onebuf_opt.wo_rl /* 'rightleft' */
190 # define w_p_rlc w_onebuf_opt.wo_rlc /* 'rightleftcmd' */
193 #define w_p_scr w_onebuf_opt.wo_scr /* 'scroll' */
196 # define w_p_spell w_onebuf_opt.wo_spell /* 'spell' */
200 # define w_p_cuc w_onebuf_opt.wo_cuc /* 'cursorcolumn' */
202 # define w_p_cul w_onebuf_opt.wo_cul /* 'cursorline' */
206 #define w_p_stl w_onebuf_opt.wo_stl /* 'statusline' */
208 #ifdef FEAT_SCROLLBIND
210 # define w_p_scb w_onebuf_opt.wo_scb /* 'scrollbind' */
213 #define w_p_wrap w_onebuf_opt.wo_wrap /* 'wrap' */
216 int wo_scriptID
[WV_COUNT
]; /* SIDs for window-local options */
217 # define w_p_scriptID w_onebuf_opt.wo_scriptID
222 * Window info stored with a buffer.
224 * Two types of info are kept for a buffer which are associated with a
226 * 1. Each window can have a different line number associated with a buffer.
227 * 2. The window-local options for a buffer work in a similar way.
228 * The window-info is kept in a list at b_wininfo. It is kept in
229 * most-recently-used order.
233 wininfo_T
*wi_next
; /* next entry or NULL for last entry */
234 wininfo_T
*wi_prev
; /* previous entry or NULL for first entry */
235 win_T
*wi_win
; /* pointer to window that did set wi_lnum */
236 pos_T wi_fpos
; /* last cursor position in the file */
237 int wi_optset
; /* TRUE when wi_opt has useful values */
238 winopt_T wi_opt
; /* local window options */
240 int wi_fold_manual
; /* copy of w_fold_manual */
241 garray_T wi_folds
; /* clone of w_folds */
246 * Info used to pass info about a fold from the fold-detection code to the
247 * code that displays the foldcolumn.
249 typedef struct foldinfo
251 int fi_level
; /* level of the fold; when this is zero the
252 other fields are invalid */
253 int fi_lnum
; /* line number where fold starts */
254 int fi_low_level
; /* lowest fold level that starts in the same
258 /* Structure to store info about the Visual area. */
261 pos_T vi_start
; /* start pos of last VIsual */
262 pos_T vi_end
; /* end position of last VIsual */
263 int vi_mode
; /* VIsual_mode of last VIsual */
264 colnr_T vi_curswant
; /* MAXCOL from w_curswant */
268 * structures used for undo
271 typedef struct u_entry u_entry_T
;
272 typedef struct u_header u_header_T
;
275 u_entry_T
*ue_next
; /* pointer to next entry in list */
276 linenr_T ue_top
; /* number of line above undo block */
277 linenr_T ue_bot
; /* number of line below undo block */
278 linenr_T ue_lcount
; /* linecount when u_save called */
279 char_u
**ue_array
; /* array of lines in undo block */
280 long ue_size
; /* number of lines in ue_array */
282 int ue_magic
; /* magic number to check allocation */
288 u_header_T
*uh_next
; /* pointer to next undo header in list */
289 u_header_T
*uh_prev
; /* pointer to previous header in list */
290 u_header_T
*uh_alt_next
; /* pointer to next header for alt. redo */
291 u_header_T
*uh_alt_prev
; /* pointer to previous header for alt. redo */
292 long uh_seq
; /* sequence number, higher == newer undo */
293 int uh_walk
; /* used by undo_time() */
294 u_entry_T
*uh_entry
; /* pointer to first entry */
295 u_entry_T
*uh_getbot_entry
; /* pointer to where ue_bot must be set */
296 pos_T uh_cursor
; /* cursor position before saving */
297 #ifdef FEAT_VIRTUALEDIT
300 int uh_flags
; /* see below */
301 pos_T uh_namedm
[NMARKS
]; /* marks before undo/after redo */
303 visualinfo_T uh_visual
; /* Visual areas before undo/after redo */
305 time_t uh_time
; /* timestamp when the change was made */
307 int uh_magic
; /* magic number to check allocation */
311 /* values for uh_flags */
312 #define UH_CHANGED 0x01 /* b_changed flag before undo/after redo */
313 #define UH_EMPTYBUF 0x02 /* buffer was empty */
316 * structures used in undo.c
319 # define ALIGN_LONG /* longword alignment and use filler byte */
320 # define ALIGN_SIZE (sizeof(long))
322 # define ALIGN_SIZE (sizeof(short))
325 #define ALIGN_MASK (ALIGN_SIZE - 1)
327 typedef struct m_info minfo_T
;
330 * stucture used to link chunks in one of the free chunk lists.
335 long_u m_size
; /* size of the chunk (including m_info) */
337 short_u m_size
; /* size of the chunk (including m_info) */
339 minfo_T
*m_next
; /* pointer to next free chunk in the list */
343 * structure used to link blocks in the list of allocated blocks.
345 typedef struct m_block mblock_T
;
348 mblock_T
*mb_next
; /* pointer to next allocated block */
349 size_t mb_size
; /* total size of all chunks in this block */
350 size_t mb_maxsize
; /* size of largest fee chunk */
351 minfo_T mb_info
; /* head of free chunk list for this block */
355 * things used in memfile.c
358 typedef struct block_hdr bhdr_T
;
359 typedef struct memfile memfile_T
;
360 typedef long blocknr_T
;
363 * for each (previously) used block in the memfile there is one block header.
365 * The block may be linked in the used list OR in the free list.
366 * The used blocks are also kept in hash lists.
368 * The used list is a doubly linked list, most recently used block first.
369 * The blocks in the used list have a block of memory allocated.
370 * mf_used_count is the number of pages in the used list.
371 * The hash lists are used to quickly find a block in the used list.
372 * The free list is a single linked list, not sorted.
373 * The blocks in the free list have no block of memory allocated and
374 * the contents of the block in the file (if any) is irrelevant.
379 bhdr_T
*bh_next
; /* next block_hdr in free or used list */
380 bhdr_T
*bh_prev
; /* previous block_hdr in used list */
381 bhdr_T
*bh_hash_next
; /* next block_hdr in hash list */
382 bhdr_T
*bh_hash_prev
; /* previous block_hdr in hash list */
383 blocknr_T bh_bnum
; /* block number */
384 char_u
*bh_data
; /* pointer to memory (for used block) */
385 int bh_page_count
; /* number of pages in this block */
389 char bh_flags
; /* BH_DIRTY or BH_LOCKED */
393 * when a block with a negative number is flushed to the file, it gets
394 * a positive number. Because the reference to the block is still the negative
395 * number, we remember the translation to the new positive number in the
396 * double linked trans lists. The structure is the same as the hash lists.
398 typedef struct nr_trans NR_TRANS
;
402 NR_TRANS
*nt_next
; /* next nr_trans in hash list */
403 NR_TRANS
*nt_prev
; /* previous nr_trans in hash list */
404 blocknr_T nt_old_bnum
; /* old, negative, number */
405 blocknr_T nt_new_bnum
; /* new, positive, number */
409 * structure used to store one block of the stuff/redo/recording buffers
413 struct buffblock
*b_next
; /* pointer to next buffblock */
414 char_u b_str
[1]; /* contents (actually longer) */
418 * header used for the stuff buffer and the redo buffer
422 struct buffblock bh_first
; /* first (dummy) block of list */
423 struct buffblock
*bh_curr
; /* buffblock for appending */
424 int bh_index
; /* index for reading */
425 int bh_space
; /* space in bh_curr for appending */
429 * used for completion on the command line
431 typedef struct expand
433 int xp_context
; /* type of expansion */
434 char_u
*xp_pattern
; /* start of item to expand */
435 int xp_pattern_len
; /* bytes in xp_pattern before cursor */
436 #if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
437 char_u
*xp_arg
; /* completion function */
438 int xp_scriptID
; /* SID for completion function */
440 int xp_backslash
; /* one of the XP_BS_ values */
441 #ifndef BACKSLASH_IN_FILENAME
442 int xp_shell
; /* for a shell command more characters
443 need to be escaped */
445 int xp_numfiles
; /* number of files found by
446 file name completion */
447 char_u
**xp_files
; /* list of files */
450 /* values for xp_backslash */
451 #define XP_BS_NONE 0 /* nothing special for backslashes */
452 #define XP_BS_ONE 1 /* uses one backslash before a space */
453 #define XP_BS_THREE 2 /* uses three backslashes before a space */
456 * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
457 * This needs to be saved for recursive commands, put them in a structure for
462 int hide
; /* TRUE when ":hide" was used */
463 # ifdef FEAT_BROWSE_CMD
464 int browse
; /* TRUE to invoke file dialog */
467 int split
; /* flags for win_split() */
468 int tab
; /* > 0 when ":tab" was used */
470 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
471 int confirm
; /* TRUE to invoke yes/no dialog */
473 int keepalt
; /* TRUE when ":keepalt" was used */
474 int keepmarks
; /* TRUE when ":keepmarks" was used */
475 int keepjumps
; /* TRUE when ":keepjumps" was used */
476 int lockmarks
; /* TRUE when ":lockmarks" was used */
478 char_u
*save_ei
; /* saved value of 'eventignore' */
483 * Simplistic hashing scheme to quickly locate the blocks in the used list.
484 * 64 blocks are found directly (64 * 4K = 256K, most files are smaller).
486 #define MEMHASHSIZE 64
487 #define MEMHASH(nr) ((nr) & (MEMHASHSIZE - 1))
491 char_u
*mf_fname
; /* name of the file */
492 char_u
*mf_ffname
; /* idem, full path */
493 int mf_fd
; /* file descriptor */
494 bhdr_T
*mf_free_first
; /* first block_hdr in free list */
495 bhdr_T
*mf_used_first
; /* mru block_hdr in used list */
496 bhdr_T
*mf_used_last
; /* lru block_hdr in used list */
497 unsigned mf_used_count
; /* number of pages in used list */
498 unsigned mf_used_count_max
; /* maximum number of pages in memory */
499 bhdr_T
*mf_hash
[MEMHASHSIZE
]; /* array of hash lists */
500 NR_TRANS
*mf_trans
[MEMHASHSIZE
]; /* array of trans lists */
501 blocknr_T mf_blocknr_max
; /* highest positive block number + 1*/
502 blocknr_T mf_blocknr_min
; /* lowest negative block number - 1 */
503 blocknr_T mf_neg_count
; /* number of negative blocks numbers */
504 blocknr_T mf_infile_count
; /* number of pages in the file */
505 unsigned mf_page_size
; /* number of bytes in a page */
506 int mf_dirty
; /* TRUE if there are dirty blocks */
510 * things used in memline.c
513 * When searching for a specific line, we remember what blocks in the tree
514 * are the branches leading to that block. This is stored in ml_stack. Each
515 * entry is a pointer to info in a block (may be data block or pointer block)
517 typedef struct info_pointer
519 blocknr_T ip_bnum
; /* block number */
520 linenr_T ip_low
; /* lowest lnum in this block */
521 linenr_T ip_high
; /* highest lnum in this block */
522 int ip_index
; /* index for block with current lnum */
523 } infoptr_T
; /* block/index pair */
526 typedef struct ml_chunksize
532 /* Flags when calling ml_updatechunk() */
534 #define ML_CHNK_ADDLINE 1
535 #define ML_CHNK_DELLINE 2
536 #define ML_CHNK_UPDLINE 3
540 * the memline structure holds all the information about a memline
542 typedef struct memline
544 linenr_T ml_line_count
; /* number of lines in the buffer */
546 memfile_T
*ml_mfp
; /* pointer to associated memfile */
548 #define ML_EMPTY 1 /* empty buffer */
549 #define ML_LINE_DIRTY 2 /* cached line was changed and allocated */
550 #define ML_LOCKED_DIRTY 4 /* ml_locked was changed */
551 #define ML_LOCKED_POS 8 /* ml_locked needs positive block number */
554 infoptr_T
*ml_stack
; /* stack of pointer blocks (array of IPTRs) */
555 int ml_stack_top
; /* current top if ml_stack */
556 int ml_stack_size
; /* total number of entries in ml_stack */
558 linenr_T ml_line_lnum
; /* line number of cached line, 0 if not valid */
559 char_u
*ml_line_ptr
; /* pointer to cached line */
561 bhdr_T
*ml_locked
; /* block used by last ml_get */
562 linenr_T ml_locked_low
; /* first line in ml_locked */
563 linenr_T ml_locked_high
; /* last line in ml_locked */
564 int ml_locked_lineadd
; /* number of lines inserted in ml_locked */
566 chunksize_T
*ml_chunksize
;
573 #if defined(FEAT_SIGNS) || defined(PROTO)
574 typedef struct signlist signlist_T
;
578 int id
; /* unique identifier for each placed sign */
579 linenr_T lnum
; /* line number which has this sign */
580 int typenr
; /* typenr of sign */
581 signlist_T
*next
; /* next signlist entry */
582 # ifdef FEAT_NETBEANS_INTG
583 signlist_T
*prev
; /* previous entry -- for easy reordering */
587 /* type argument for buf_getsigntype() */
589 #define SIGN_LINEHL 1
595 * Argument list: Array of file names.
596 * Used for the global argument list and the argument lists local to a window.
598 typedef struct arglist
600 garray_T al_ga
; /* growarray with the array of file names */
601 int al_refcount
; /* number of windows using this arglist */
605 * For each argument remember the file name as it was given, and the buffer
606 * number that contains the expanded file name (required for when ":cd" is
609 typedef struct argentry
611 char_u
*ae_fname
; /* file name as specified */
612 int ae_fnum
; /* buffer number with expanded file name */
616 # define ALIST(win) (win)->w_alist
618 # define ALIST(win) (&global_alist)
620 #define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data)
621 #define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data)
622 #define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data)
623 #define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data))
624 #define GARGCOUNT (global_alist.al_ga.ga_len)
625 #define ARGCOUNT (ALIST(curwin)->al_ga.ga_len)
626 #define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len)
629 * A list used for saving values of "emsg_silent". Used by ex_try() to save the
630 * value of "emsg_silent" if it was non-zero. When this is done, the CSF_SILENT
634 typedef struct eslist_elem eslist_T
;
637 int saved_emsg_silent
; /* saved value of "emsg_silent" */
638 eslist_T
*next
; /* next element on the list */
642 * For conditional commands a stack is kept of nested conditionals.
643 * When cs_idx < 0, there is no conditional command.
645 #define CSTACK_LEN 50
649 short cs_flags
[CSTACK_LEN
]; /* CSF_ flags */
650 char cs_pending
[CSTACK_LEN
]; /* CSTP_: what's pending in ":finally"*/
652 void *csp_rv
[CSTACK_LEN
]; /* return typeval for pending return */
653 void *csp_ex
[CSTACK_LEN
]; /* exception for pending throw */
655 void *cs_forinfo
[CSTACK_LEN
]; /* info used by ":for" */
656 int cs_line
[CSTACK_LEN
]; /* line nr of ":while"/":for" line */
657 int cs_idx
; /* current entry, or -1 if none */
658 int cs_looplevel
; /* nr of nested ":while"s and ":for"s */
659 int cs_trylevel
; /* nr of nested ":try"s */
660 eslist_T
*cs_emsg_silent_list
; /* saved values of "emsg_silent" */
661 char cs_lflags
; /* loop flags: CSL_ flags */
663 # define cs_rettv cs_pend.csp_rv
664 # define cs_exception cs_pend.csp_ex
666 /* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
668 # define CSF_TRUE 0x0001 /* condition was TRUE */
669 # define CSF_ACTIVE 0x0002 /* current state is active */
670 # define CSF_ELSE 0x0004 /* ":else" has been passed */
671 # define CSF_WHILE 0x0008 /* is a ":while" */
672 # define CSF_FOR 0x0010 /* is a ":for" */
674 # define CSF_TRY 0x0100 /* is a ":try" */
675 # define CSF_FINALLY 0x0200 /* ":finally" has been passed */
676 # define CSF_THROWN 0x0400 /* exception thrown to this try conditional */
677 # define CSF_CAUGHT 0x0800 /* exception caught by this try conditional */
678 # define CSF_SILENT 0x1000 /* "emsg_silent" reset by ":try" */
679 /* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
680 * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
683 * What's pending for being reactivated at the ":endtry" of this try
686 # define CSTP_NONE 0 /* nothing pending in ":finally" clause */
687 # define CSTP_ERROR 1 /* an error is pending */
688 # define CSTP_INTERRUPT 2 /* an interrupt is pending */
689 # define CSTP_THROW 4 /* a throw is pending */
690 # define CSTP_BREAK 8 /* ":break" is pending */
691 # define CSTP_CONTINUE 16 /* ":continue" is pending */
692 # define CSTP_RETURN 24 /* ":return" is pending */
693 # define CSTP_FINISH 32 /* ":finish" is pending */
696 * Flags for the cs_lflags item in struct condstack.
698 # define CSL_HAD_LOOP 1 /* just found ":while" or ":for" */
699 # define CSL_HAD_ENDLOOP 2 /* just found ":endwhile" or ":endfor" */
700 # define CSL_HAD_CONT 4 /* just found ":continue" */
701 # define CSL_HAD_FINA 8 /* just found ":finally" */
704 * A list of error messages that can be converted to an exception. "throw_msg"
705 * is only set in the first element of the list. Usually, it points to the
706 * original message stored in that element, but sometimes it points to a later
707 * message in the list. See cause_errthrow() below.
711 char_u
*msg
; /* original message */
712 char_u
*throw_msg
; /* msg to throw: usually original one */
713 struct msglist
*next
; /* next of several messages in a row */
717 * Structure describing an exception.
718 * (don't use "struct exception", it's used by the math library).
720 typedef struct vim_exception except_T
;
723 int type
; /* exception type */
724 char_u
*value
; /* exception value */
725 struct msglist
*messages
; /* message(s) causing error exception */
726 char_u
*throw_name
; /* name of the throw point */
727 linenr_T throw_lnum
; /* line number of the throw point */
728 except_T
*caught
; /* next exception on the caught stack */
732 * The exception types.
734 #define ET_USER 0 /* exception caused by ":throw" command */
735 #define ET_ERROR 1 /* error exception */
736 #define ET_INTERRUPT 2 /* interrupt exception triggered by Ctrl-C */
739 * Structure to save the error/interrupt/exception state between calls to
740 * enter_cleanup() and leave_cleanup(). Must be allocated as an automatic
741 * variable by the (common) caller of these functions.
743 typedef struct cleanup_stuff cleanup_T
;
746 int pending
; /* error/interrupt/exception state */
747 except_T
*exception
; /* exception value */
751 /* struct passed to in_id_list() */
754 int inc_tag
; /* ":syn include" unique tag */
755 short id
; /* highlight group ID of item */
756 short *cont_in_list
; /* cont.in group IDs, if non-zero */
760 * Each keyword has one keyentry, which is linked in a hash list.
762 typedef struct keyentry keyentry_T
;
766 keyentry_T
*ke_next
; /* next entry with identical "keyword[]" */
767 struct sp_syn k_syn
; /* struct passed to in_id_list() */
768 short *next_list
; /* ID list for next match (if non-zero) */
769 short flags
; /* see syntax.c */
770 char_u keyword
[1]; /* actually longer */
774 * Struct used to store one state of the state stack.
776 typedef struct buf_state
778 int bs_idx
; /* index of pattern */
779 long bs_flags
; /* flags for pattern */
780 reg_extmatch_T
*bs_extmatch
; /* external matches from start pattern */
784 * syn_state contains the syntax state stack for the start of one line.
785 * Used by b_sst_array[].
787 typedef struct syn_state synstate_T
;
791 synstate_T
*sst_next
; /* next entry in used or free list */
792 linenr_T sst_lnum
; /* line number for this state */
795 bufstate_T sst_stack
[SST_FIX_STATES
]; /* short state stack */
796 garray_T sst_ga
; /* growarray for long state stack */
798 int sst_next_flags
; /* flags for sst_next_list */
799 short *sst_next_list
; /* "nextgroup" list in this state
800 * (this is a copy, don't free it! */
801 short sst_stacksize
; /* number of states on the stack */
802 disptick_T sst_tick
; /* tick when last displayed */
803 linenr_T sst_change_lnum
;/* when non-zero, change in this line
804 * may have made the state invalid */
806 #endif /* FEAT_SYN_HL */
809 * Structure shared between syntax.c, screen.c and gui_x11.c.
811 typedef struct attr_entry
813 short ae_attr
; /* HL_BOLD, etc. */
818 char_u
*start
; /* start escape sequence */
819 char_u
*stop
; /* stop escape sequence */
823 /* These colors need to be > 8 bits to hold 256. */
824 short_u fg_color
; /* foreground color number */
825 short_u bg_color
; /* background color number */
830 guicolor_T fg_color
; /* foreground color handle */
831 guicolor_T bg_color
; /* background color handle */
832 guicolor_T sp_color
; /* special color handle */
833 GuiFont font
; /* font handle */
834 # ifdef FEAT_XFONTSET
835 GuiFontset fontset
; /* fontset handle */
846 # if defined(MACOS_X)
847 # include <sys/errno.h>
848 # define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
849 typedef struct _iconv_t
*iconv_t
;
851 # if defined(MACOS_CLASSIC)
852 typedef struct _iconv_t
*iconv_t
;
862 typedef void *iconv_t
;
867 * Used for the typeahead buffer: typebuf.
871 char_u
*tb_buf
; /* buffer for typed characters */
872 char_u
*tb_noremap
; /* mapping flags for characters in tb_buf[] */
873 int tb_buflen
; /* size of tb_buf[] */
874 int tb_off
; /* current position in tb_buf[] */
875 int tb_len
; /* number of valid bytes in tb_buf[] */
876 int tb_maplen
; /* nr of mapped bytes in tb_buf[] */
877 int tb_silent
; /* nr of silently mapped bytes in tb_buf[] */
878 int tb_no_abbr_cnt
; /* nr of bytes without abbrev. in tb_buf[] */
879 int tb_change_cnt
; /* nr of time tb_buf was changed; never zero */
882 /* Struct to hold the saved typeahead for save_typeahead(). */
885 typebuf_T save_typebuf
;
886 int typebuf_valid
; /* TRUE when save_typebuf valid */
889 struct buffheader save_stuffbuff
;
891 char_u
*save_inputbuf
;
896 * Used for conversion of terminal I/O and script files.
900 int vc_type
; /* zero or one of the CONV_ values */
901 int vc_factor
; /* max. expansion factor */
903 int vc_cpfrom
; /* codepage to convert from (CONV_CODEPAGE) */
904 int vc_cpto
; /* codepage to convert to (CONV_CODEPAGE) */
907 iconv_t vc_fd
; /* for CONV_ICONV */
909 int vc_fail
; /* fail for invalid char, don't use '?' */
913 * Structure used for reading from the viminfo file.
917 char_u
*vir_line
; /* text of the current line */
918 FILE *vir_fd
; /* file descriptor */
920 vimconv_T vir_conv
; /* encoding conversion */
925 #define CONV_TO_UTF8 1
926 #define CONV_9_TO_UTF8 2
927 #define CONV_TO_LATIN1 3
928 #define CONV_TO_LATIN9 4
931 # define CONV_CODEPAGE 10 /* codepage -> codepage */
934 # define CONV_MAC_LATIN1 20
935 # define CONV_LATIN1_MAC 21
936 # define CONV_MAC_UTF8 22
937 # define CONV_UTF8_MAC 23
941 * Structure used for mappings and abbreviations.
943 typedef struct mapblock mapblock_T
;
946 mapblock_T
*m_next
; /* next mapblock in list */
947 char_u
*m_keys
; /* mapped from */
948 int m_keylen
; /* strlen(m_keys) */
949 char_u
*m_str
; /* mapped to */
950 int m_mode
; /* valid mode */
951 int m_noremap
; /* if non-zero no re-mapping for m_str */
952 char m_silent
; /* <silent> used, don't echo commands */
954 char m_expr
; /* <expr> used, m_str is an expression */
955 scid_T m_script_ID
; /* ID of script where map was defined */
960 * Used for highlighting in the status line.
965 int userhl
; /* 0: no HL, 1-9: User HL, < 0 for syn ID */
968 /* Item for a hashtable. "hi_key" can be one of three values:
969 * NULL: Never been used
970 * HI_KEY_REMOVED: Entry was removed
971 * Otherwise: Used item, pointer to the actual key; this usually is
972 * inside the item, subtract an offset to locate the item.
973 * This reduces the size of hashitem by 1/3.
975 typedef struct hashitem_S
977 long_u hi_hash
; /* cached hash number of hi_key */
981 /* The address of "hash_removed" is used as a magic number for hi_key to
982 * indicate a removed item. */
983 #define HI_KEY_REMOVED &hash_removed
984 #define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
986 /* Initial size for a hashtable. Our items are relatively small and growing
987 * is expensive, thus use 16 as a start. Must be a power of 2. */
988 #define HT_INIT_SIZE 16
990 typedef struct hashtable_S
992 long_u ht_mask
; /* mask used for hash value (nr of items in
993 * array is "ht_mask" + 1) */
994 long_u ht_used
; /* number of items used */
995 long_u ht_filled
; /* number of items used + removed */
996 int ht_locked
; /* counter for hash_lock() */
997 int ht_error
; /* when set growing failed, can't add more
998 items before growing works */
999 hashitem_T
*ht_array
; /* points to the array, allocated when it's
1000 not "ht_smallarray" */
1001 hashitem_T ht_smallarray
[HT_INIT_SIZE
]; /* initial array */
1004 typedef long_u hash_T
; /* Type for hi_hash */
1007 #if SIZEOF_INT <= 3 /* use long if int is smaller than 32 bits */
1008 typedef long varnumber_T
;
1010 typedef int varnumber_T
;
1012 typedef double float_T
;
1014 typedef struct listvar_S list_T
;
1015 typedef struct dictvar_S dict_T
;
1018 * Structure to hold an internal variable without a name.
1022 char v_type
; /* see below: VAR_NUMBER, VAR_STRING, etc. */
1023 char v_lock
; /* see below: VAR_LOCKED, VAR_FIXED */
1026 varnumber_T v_number
; /* number value */
1028 float_T v_float
; /* floating number value */
1030 char_u
*v_string
; /* string value (can be NULL!) */
1031 list_T
*v_list
; /* list value (can be NULL!) */
1032 dict_T
*v_dict
; /* dict value (can be NULL!) */
1036 /* Values for "v_type". */
1037 #define VAR_UNKNOWN 0
1038 #define VAR_NUMBER 1 /* "v_number" is used */
1039 #define VAR_STRING 2 /* "v_string" is used */
1040 #define VAR_FUNC 3 /* "v_string" is function name */
1041 #define VAR_LIST 4 /* "v_list" is used */
1042 #define VAR_DICT 5 /* "v_dict" is used */
1043 #define VAR_FLOAT 6 /* "v_float" is used */
1045 /* Values for "v_lock". */
1046 #define VAR_LOCKED 1 /* locked with lock(), can use unlock() */
1047 #define VAR_FIXED 2 /* locked forever */
1050 * Structure to hold an item of a list: an internal variable without a name.
1052 typedef struct listitem_S listitem_T
;
1056 listitem_T
*li_next
; /* next item in list */
1057 listitem_T
*li_prev
; /* previous item in list */
1058 typval_T li_tv
; /* type and value of the variable */
1062 * Struct used by those that are using an item in a list.
1064 typedef struct listwatch_S listwatch_T
;
1068 listitem_T
*lw_item
; /* item being watched */
1069 listwatch_T
*lw_next
; /* next watcher */
1073 * Structure to hold info about a list.
1077 listitem_T
*lv_first
; /* first item, NULL if none */
1078 listitem_T
*lv_last
; /* last item, NULL if none */
1079 int lv_refcount
; /* reference count */
1080 int lv_len
; /* number of items */
1081 listwatch_T
*lv_watch
; /* first watcher, NULL if none */
1082 int lv_idx
; /* cached index of an item */
1083 listitem_T
*lv_idx_item
; /* when not NULL item at index "lv_idx" */
1084 int lv_copyID
; /* ID used by deepcopy() */
1085 list_T
*lv_copylist
; /* copied list used by deepcopy() */
1086 char lv_lock
; /* zero, VAR_LOCKED, VAR_FIXED */
1087 list_T
*lv_used_next
; /* next list in used lists list */
1088 list_T
*lv_used_prev
; /* previous list in used lists list */
1092 * Structure to hold an item of a Dictionary.
1093 * Also used for a variable.
1094 * The key is copied into "di_key" to avoid an extra alloc/free for it.
1098 typval_T di_tv
; /* type and value of the variable */
1099 char_u di_flags
; /* flags (only used for variable) */
1100 char_u di_key
[1]; /* key (actually longer!) */
1103 typedef struct dictitem_S dictitem_T
;
1105 #define DI_FLAGS_RO 1 /* "di_flags" value: read-only variable */
1106 #define DI_FLAGS_RO_SBX 2 /* "di_flags" value: read-only in the sandbox */
1107 #define DI_FLAGS_FIX 4 /* "di_flags" value: fixed variable, not allocated */
1108 #define DI_FLAGS_LOCK 8 /* "di_flags" value: locked variable */
1111 * Structure to hold info about a Dictionary.
1115 int dv_refcount
; /* reference count */
1116 hashtab_T dv_hashtab
; /* hashtab that refers to the items */
1117 int dv_copyID
; /* ID used by deepcopy() */
1118 dict_T
*dv_copydict
; /* copied dict used by deepcopy() */
1119 char dv_lock
; /* zero, VAR_LOCKED, VAR_FIXED */
1120 dict_T
*dv_used_next
; /* next dict in used dicts list */
1121 dict_T
*dv_used_prev
; /* previous dict in used dicts list */
1124 /* values for b_syn_spell: what to do with toplevel text */
1125 #define SYNSPL_DEFAULT 0 /* spell check if @Spell not defined */
1126 #define SYNSPL_TOP 1 /* spell check toplevel text */
1127 #define SYNSPL_NOTOP 2 /* don't spell check toplevel text */
1129 /* avoid #ifdefs for when b_spell is not available */
1131 # define B_SPELL(buf) ((buf)->b_spell)
1133 # define B_SPELL(buf) (0)
1136 #ifdef FEAT_QUICKFIX
1137 typedef struct qf_info_S qf_info_T
;
1141 * buffer: structure that holds information about one file
1143 * Several windows can share a single Buffer
1144 * A buffer is unallocated if there is no memfile for it.
1145 * A buffer is new if the associated file has never been loaded yet.
1148 typedef struct file_buffer buf_T
;
1152 memline_T b_ml
; /* associated memline (also contains line
1155 buf_T
*b_next
; /* links in list of buffers */
1158 int b_nwindows
; /* nr of windows open on this buffer */
1160 int b_flags
; /* various BF_ flags */
1163 * b_ffname has the full path of the file (NULL for no name).
1164 * b_sfname is the name as the user typed it (or NULL).
1165 * b_fname is the same as b_sfname, unless ":cd" has been done,
1166 * then it is the same as b_ffname (NULL for no name).
1168 char_u
*b_ffname
; /* full path file name */
1169 char_u
*b_sfname
; /* short file name */
1170 char_u
*b_fname
; /* current file name */
1173 int b_dev_valid
; /* TRUE when b_dev has a valid number */
1174 dev_t b_dev
; /* device number */
1175 ino_t b_ino
; /* inode number */
1177 #ifdef FEAT_CW_EDITOR
1178 FSSpec b_FSSpec
; /* MacOS File Identification */
1181 char b_fab_rfm
; /* Record format */
1182 char b_fab_rat
; /* Record attribute */
1183 unsigned int b_fab_mrs
; /* Max record size */
1186 int b_sniff
; /* file was loaded through Sniff */
1189 int b_fnum
; /* buffer number for this file. */
1191 int b_changed
; /* 'modified': Set to TRUE if something in the
1192 file has been changed and not written out. */
1193 int b_changedtick
; /* incremented for each change, also for undo */
1195 int b_saving
; /* Set to TRUE if we are in the middle of
1196 saving the buffer. */
1199 * Changes to a buffer require updating of the display. To minimize the
1200 * work, remember changes made and update everything at once.
1202 int b_mod_set
; /* TRUE when there are changes since the last
1203 time the display was updated */
1204 linenr_T b_mod_top
; /* topmost lnum that was changed */
1205 linenr_T b_mod_bot
; /* lnum below last changed line, AFTER the
1207 long b_mod_xlines
; /* number of extra buffer lines inserted;
1208 negative when lines were deleted */
1210 wininfo_T
*b_wininfo
; /* list of last used info for each window */
1212 long b_mtime
; /* last change time of original file */
1213 long b_mtime_read
; /* last change time when reading */
1214 size_t b_orig_size
; /* size of original file in bytes */
1215 int b_orig_mode
; /* mode of original file */
1217 pos_T b_namedm
[NMARKS
]; /* current named marks (mark.c) */
1220 /* These variables are set when VIsual_active becomes FALSE */
1221 visualinfo_T b_visual
;
1223 int b_visual_mode_eval
; /* b_visual.vi_mode for visualmode() */
1227 pos_T b_last_cursor
; /* cursor position when last unloading this
1229 pos_T b_last_insert
; /* where Insert mode was left */
1230 pos_T b_last_change
; /* position of last change: '. mark */
1232 #ifdef FEAT_JUMPLIST
1234 * the changelist contains old change positions
1236 pos_T b_changelist
[JUMPLISTSIZE
];
1237 int b_changelistlen
; /* number of active entries */
1238 int b_new_change
; /* set by u_savecommon() */
1242 * Character table, only used in charset.c for 'iskeyword'
1243 * 32 bytes of 8 bits: 1 bit per character 0-255.
1245 char_u b_chartab
[32];
1247 #ifdef FEAT_LOCALMAP
1248 /* Table used for mappings local to a buffer. */
1249 mapblock_T
*(b_maphash
[256]);
1251 /* First abbreviation local to a buffer. */
1252 mapblock_T
*b_first_abbr
;
1254 #ifdef FEAT_USR_CMDS
1255 /* User commands local to the buffer. */
1259 * start and end of an operator, also used for '[ and ']
1265 int b_marks_read
; /* Have we read viminfo marks yet? */
1269 * The following only used in undo.c.
1271 u_header_T
*b_u_oldhead
; /* pointer to oldest header */
1272 u_header_T
*b_u_newhead
; /* pointer to newest header; may not be valid
1273 if b_u_curhead is not NULL */
1274 u_header_T
*b_u_curhead
; /* pointer to current header */
1275 int b_u_numhead
; /* current number of headers */
1276 int b_u_synced
; /* entry lists are synced */
1277 long b_u_seq_last
; /* last used undo sequence number */
1278 long b_u_seq_cur
; /* hu_seq of header below which we are now */
1279 time_t b_u_seq_time
; /* uh_time of header below which we are now */
1282 * variables for "U" command in undo.c
1284 char_u
*b_u_line_ptr
; /* saved line for "U" command */
1285 linenr_T b_u_line_lnum
; /* line number of line in u_line */
1286 colnr_T b_u_line_colnr
; /* optional column number */
1289 * The following only used in undo.c
1291 mblock_T b_block_head
; /* head of allocated memory block list */
1292 minfo_T
*b_m_search
; /* pointer to chunk before previously
1293 allocated/freed chunk */
1294 mblock_T
*b_mb_current
; /* block where m_search points in */
1296 #ifdef FEAT_INS_EXPAND
1297 int b_scanned
; /* ^N/^P have scanned this buffer */
1300 /* flags for use of ":lmap" and IM control */
1301 long b_p_iminsert
; /* input mode for insert */
1302 long b_p_imsearch
; /* input mode for search */
1303 #define B_IMODE_USE_INSERT -1 /* Use b_p_iminsert value for search */
1304 #define B_IMODE_NONE 0 /* Input via none */
1305 #define B_IMODE_LMAP 1 /* Input via langmap */
1306 #ifndef USE_IM_CONTROL
1307 # define B_IMODE_LAST 1
1309 # define B_IMODE_IM 2 /* Input via input method */
1310 # define B_IMODE_LAST 2
1314 short b_kmap_state
; /* using "lmap" mappings */
1315 # define KEYMAP_INIT 1 /* 'keymap' was set, call keymap_init() */
1316 # define KEYMAP_LOADED 2 /* 'keymap' mappings have been loaded */
1317 garray_T b_kmap_ga
; /* the keymap table */
1321 * Options local to a buffer.
1322 * They are here because their value depends on the type of file
1323 * or contents of the file being edited.
1325 int b_p_initialized
; /* set when options initialized */
1328 int b_p_scriptID
[BV_COUNT
]; /* SIDs for buffer-local options */
1331 int b_p_ai
; /* 'autoindent' */
1332 int b_p_ai_nopaste
; /* b_p_ai saved for paste mode */
1333 int b_p_ci
; /* 'copyindent' */
1334 int b_p_bin
; /* 'binary' */
1336 int b_p_bomb
; /* 'bomb' */
1338 #if defined(FEAT_QUICKFIX)
1339 char_u
*b_p_bh
; /* 'bufhidden' */
1340 char_u
*b_p_bt
; /* 'buftype' */
1342 int b_p_bl
; /* 'buflisted' */
1344 int b_p_cin
; /* 'cindent' */
1345 char_u
*b_p_cino
; /* 'cinoptions' */
1346 char_u
*b_p_cink
; /* 'cinkeys' */
1348 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
1349 char_u
*b_p_cinw
; /* 'cinwords' */
1351 #ifdef FEAT_COMMENTS
1352 char_u
*b_p_com
; /* 'comments' */
1355 char_u
*b_p_cms
; /* 'commentstring' */
1357 #ifdef FEAT_INS_EXPAND
1358 char_u
*b_p_cpt
; /* 'complete' */
1360 #ifdef FEAT_COMPL_FUNC
1361 char_u
*b_p_cfu
; /* 'completefunc' */
1362 char_u
*b_p_ofu
; /* 'omnifunc' */
1364 int b_p_eol
; /* 'endofline' */
1365 int b_p_et
; /* 'expandtab' */
1366 int b_p_et_nobin
; /* b_p_et saved for binary mode */
1368 char_u
*b_p_fenc
; /* 'fileencoding' */
1370 char_u
*b_p_ff
; /* 'fileformat' */
1372 char_u
*b_p_ft
; /* 'filetype' */
1374 char_u
*b_p_fo
; /* 'formatoptions' */
1375 char_u
*b_p_flp
; /* 'formatlistpat' */
1376 int b_p_inf
; /* 'infercase' */
1377 char_u
*b_p_isk
; /* 'iskeyword' */
1379 char_u
*b_p_def
; /* 'define' local value */
1380 char_u
*b_p_inc
; /* 'include' */
1382 char_u
*b_p_inex
; /* 'includeexpr' */
1383 long_u b_p_inex_flags
; /* flags for 'includeexpr' */
1386 #if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
1387 char_u
*b_p_inde
; /* 'indentexpr' */
1388 long_u b_p_inde_flags
; /* flags for 'indentexpr' */
1389 char_u
*b_p_indk
; /* 'indentkeys' */
1391 #if defined(FEAT_EVAL)
1392 char_u
*b_p_fex
; /* 'formatexpr' */
1393 long_u b_p_fex_flags
; /* flags for 'formatexpr' */
1396 char_u
*b_p_key
; /* 'key' */
1398 char_u
*b_p_kp
; /* 'keywordprg' */
1400 int b_p_lisp
; /* 'lisp' */
1402 char_u
*b_p_mps
; /* 'matchpairs' */
1403 int b_p_ml
; /* 'modeline' */
1404 int b_p_ml_nobin
; /* b_p_ml saved for binary mode */
1405 int b_p_ma
; /* 'modifiable' */
1406 char_u
*b_p_nf
; /* 'nrformats' */
1407 #ifdef FEAT_OSFILETYPE
1408 char_u
*b_p_oft
; /* 'osfiletype' */
1410 int b_p_pi
; /* 'preserveindent' */
1412 char_u
*b_p_qe
; /* 'quoteescape' */
1414 int b_p_ro
; /* 'readonly' */
1415 long b_p_sw
; /* 'shiftwidth' */
1417 int b_p_sn
; /* 'shortname' */
1419 #ifdef FEAT_SMARTINDENT
1420 int b_p_si
; /* 'smartindent' */
1422 long b_p_sts
; /* 'softtabstop' */
1423 long b_p_sts_nopaste
; /* b_p_sts saved for paste mode */
1424 #ifdef FEAT_SEARCHPATH
1425 char_u
*b_p_sua
; /* 'suffixesadd' */
1427 int b_p_swf
; /* 'swapfile' */
1429 long b_p_smc
; /* 'synmaxcol' */
1430 char_u
*b_p_syn
; /* 'syntax' */
1433 char_u
*b_p_spc
; /* 'spellcapcheck' */
1434 regprog_T
*b_cap_prog
; /* program for 'spellcapcheck' */
1435 char_u
*b_p_spf
; /* 'spellfile' */
1436 char_u
*b_p_spl
; /* 'spelllang' */
1438 long b_p_ts
; /* 'tabstop' */
1439 int b_p_tx
; /* 'textmode' */
1440 long b_p_tw
; /* 'textwidth' */
1441 long b_p_tw_nobin
; /* b_p_tw saved for binary mode */
1442 long b_p_tw_nopaste
; /* b_p_tw saved for paste mode */
1443 long b_p_wm
; /* 'wrapmargin' */
1444 long b_p_wm_nobin
; /* b_p_wm saved for binary mode */
1445 long b_p_wm_nopaste
; /* b_p_wm saved for paste mode */
1447 char_u
*b_p_keymap
; /* 'keymap' */
1450 /* local values for options which are normally global */
1451 #ifdef FEAT_QUICKFIX
1452 char_u
*b_p_gp
; /* 'grepprg' local value */
1453 char_u
*b_p_mp
; /* 'makeprg' local value */
1454 char_u
*b_p_efm
; /* 'errorformat' local value */
1456 char_u
*b_p_ep
; /* 'equalprg' local value */
1457 char_u
*b_p_path
; /* 'path' local value */
1458 int b_p_ar
; /* 'autoread' local value */
1459 char_u
*b_p_tags
; /* 'tags' local value */
1460 #ifdef FEAT_INS_EXPAND
1461 char_u
*b_p_dict
; /* 'dictionary' local value */
1462 char_u
*b_p_tsr
; /* 'thesaurus' local value */
1465 /* end of buffer options */
1467 int b_start_eol
; /* last line had eol when it was read */
1468 int b_start_ffc
; /* first char of 'ff' when edit started */
1470 char_u
*b_start_fenc
; /* 'fileencoding' when edit started or NULL */
1471 int b_bad_char
; /* "++bad=" argument when edit started or 0 */
1472 int b_start_bomb
; /* 'bomb' when it was read */
1476 dictitem_T b_bufvar
; /* variable for "b:" Dictionary */
1477 dict_T b_vars
; /* internal variables, local to buffer */
1480 #if defined(FEAT_BEVAL) && defined(FEAT_EVAL)
1481 char_u
*b_p_bexpr
; /* 'balloonexpr' local value */
1482 long_u b_p_bexpr_flags
;/* flags for 'balloonexpr' */
1485 /* When a buffer is created, it starts without a swap file. b_may_swap is
1486 * then set to indicate that a swap file may be opened later. It is reset
1487 * if a swap file could not be opened.
1490 int b_did_warn
; /* Set to 1 if user has been warned on first
1491 change of a read-only file */
1493 /* Two special kinds of buffers:
1494 * help buffer - used for help files, won't use a swap file.
1495 * spell buffer - used for spell info, never displayed and doesn't have a
1498 int b_help
; /* TRUE for help file buffer (when set b_p_bt
1501 int b_spell
; /* TRUE for a spell file buffer, most fields
1502 are not used! Use the B_SPELL macro to
1503 access b_spell without #ifdef. */
1507 int b_shortname
; /* this file has an 8.3 file name */
1510 #ifdef FEAT_MZSCHEME
1511 void *b_mzscheme_ref
; /* The MzScheme reference to this buffer */
1515 void *b_perl_private
;
1519 void *b_python_ref
; /* The Python reference to this buffer */
1531 hashtab_T b_keywtab
; /* syntax keywords hash table */
1532 hashtab_T b_keywtab_ic
; /* idem, ignore case */
1533 int b_syn_error
; /* TRUE when error occured in HL */
1534 int b_syn_ic
; /* ignore case for :syn cmds */
1535 int b_syn_spell
; /* SYNSPL_ values */
1536 garray_T b_syn_patterns
; /* table for syntax patterns */
1537 garray_T b_syn_clusters
; /* table for syntax clusters */
1538 int b_spell_cluster_id
; /* @Spell cluster ID or 0 */
1539 int b_nospell_cluster_id
; /* @NoSpell cluster ID or 0 */
1540 int b_syn_containedin
; /* TRUE when there is an item with a
1541 "containedin" argument */
1542 int b_syn_sync_flags
; /* flags about how to sync */
1543 short b_syn_sync_id
; /* group to sync on */
1544 long b_syn_sync_minlines
; /* minimal sync lines offset */
1545 long b_syn_sync_maxlines
; /* maximal sync lines offset */
1546 long b_syn_sync_linebreaks
; /* offset for multi-line pattern */
1547 char_u
*b_syn_linecont_pat
; /* line continuation pattern */
1548 regprog_T
*b_syn_linecont_prog
; /* line continuation program */
1549 int b_syn_linecont_ic
; /* ignore-case flag for above */
1550 int b_syn_topgrp
; /* for ":syntax include" */
1551 # ifdef FEAT_FOLDING
1552 int b_syn_folditems
; /* number of patterns with the HL_FOLD
1556 * b_sst_array[] contains the state stack for a number of lines, for the start
1557 * of that line (col == 0). This avoids having to recompute the syntax state
1559 * b_sst_array[] is allocated to hold the state for all displayed lines, and
1560 * states for 1 out of about 20 other lines.
1561 * b_sst_array pointer to an array of synstate_T
1562 * b_sst_len number of entries in b_sst_array[]
1563 * b_sst_first pointer to first used entry in b_sst_array[] or NULL
1564 * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL
1565 * b_sst_freecount number of free entries in b_sst_array[]
1566 * b_sst_check_lnum entries after this lnum need to be checked for
1567 * validity (MAXLNUM means no check needed)
1569 synstate_T
*b_sst_array
;
1571 synstate_T
*b_sst_first
;
1572 synstate_T
*b_sst_firstfree
;
1573 int b_sst_freecount
;
1574 linenr_T b_sst_check_lnum
;
1575 short_u b_sst_lasttick
; /* last display tick */
1576 #endif /* FEAT_SYN_HL */
1579 /* for spell checking */
1580 garray_T b_langp
; /* list of pointers to slang_T, see spell.c */
1581 char_u b_spell_ismw
[256];/* flags: is midword char */
1583 char_u
*b_spell_ismw_mb
; /* multi-byte midword chars */
1588 signlist_T
*b_signlist
; /* list of signs to draw */
1591 #ifdef FEAT_NETBEANS_INTG
1592 int b_netbeans_file
; /* TRUE when buffer is owned by NetBeans */
1593 int b_was_netbeans_file
;/* TRUE if b_netbeans_file was once set */
1601 * Stuff for diff mode.
1603 # define DB_COUNT 4 /* up to four buffers can be diff'ed */
1606 * Each diffblock defines where a block of lines starts in each of the buffers
1607 * and how many lines it occupies in that buffer. When the lines are missing
1608 * in the buffer the df_count[] is zero. This is all counted in
1610 * There is always at least one unchanged line in between the diffs.
1611 * Otherwise it would have been included in the diff above or below it.
1612 * df_lnum[] + df_count[] is the lnum below the change. When in one buffer
1613 * lines have been inserted, in the other buffer df_lnum[] is the line below
1614 * the insertion and df_count[] is zero. When appending lines at the end of
1615 * the buffer, df_lnum[] is one beyond the end!
1616 * This is using a linked list, because the number of differences is expected
1617 * to be reasonable small. The list is sorted on lnum.
1619 typedef struct diffblock_S diff_T
;
1623 linenr_T df_lnum
[DB_COUNT
]; /* line number in buffer */
1624 linenr_T df_count
[DB_COUNT
]; /* nr of inserted/changed lines */
1628 #define SNAP_HELP_IDX 0
1630 # define SNAP_AUCMD_IDX 1
1631 # define SNAP_COUNT 2
1633 # define SNAP_COUNT 1
1637 * Tab pages point to the top frame of each tab page.
1638 * Note: Most values are NOT valid for the current tab page! Use "curwin",
1639 * "firstwin", etc. for that. "tp_topframe" is always valid and can be
1640 * compared against "topframe" to find the current tab page.
1642 typedef struct tabpage_S tabpage_T
;
1645 tabpage_T
*tp_next
; /* next tabpage or NULL */
1646 frame_T
*tp_topframe
; /* topframe for the windows */
1647 win_T
*tp_curwin
; /* current window in this Tab page */
1648 win_T
*tp_prevwin
; /* previous window in this Tab page */
1649 win_T
*tp_firstwin
; /* first window in this Tab page */
1650 win_T
*tp_lastwin
; /* last window in this Tab page */
1651 long tp_old_Rows
; /* Rows when Tab page was left */
1652 long tp_old_Columns
; /* Columns when Tab page was left */
1653 long tp_ch_used
; /* value of 'cmdheight' when frame size
1656 int tp_prev_which_scrollbars
[3];
1657 /* previous value of which_scrollbars */
1660 diff_T
*tp_first_diff
;
1661 buf_T
*(tp_diffbuf
[DB_COUNT
]);
1662 int tp_diff_invalid
; /* list of diffs is outdated */
1664 frame_T
*(tp_snapshot
[SNAP_COUNT
]); /* window layout snapshots */
1666 dictitem_T tp_winvar
; /* variable for "t:" Dictionary */
1667 dict_T tp_vars
; /* internal variables, local to tab page */
1672 * Structure to cache info for displayed lines in w_lines[].
1673 * Each logical line has one entry.
1674 * The entry tells how the logical line is currently displayed in the window.
1675 * This is updated when displaying the window.
1676 * When the display is changed (e.g., when clearing the screen) w_lines_valid
1677 * is changed to exclude invalid entries.
1678 * When making changes to the buffer, wl_valid is reset to indicate wl_size
1679 * may not reflect what is actually in the buffer. When wl_valid is FALSE,
1680 * the entries can only be used to count the number of displayed lines used.
1681 * wl_lnum and wl_lastlnum are invalid too.
1683 typedef struct w_line
1685 linenr_T wl_lnum
; /* buffer line number for logical line */
1686 short_u wl_size
; /* height in screen lines */
1687 char wl_valid
; /* TRUE values are valid for text in buffer */
1689 char wl_folded
; /* TRUE when this is a range of folded lines */
1690 linenr_T wl_lastlnum
; /* last buffer line number for logical line */
1695 * Windows are kept in a tree of frames. Each frame has a column (FR_COL)
1696 * or row (FR_ROW) layout or is a leaf, which has a window.
1700 char fr_layout
; /* FR_LEAF, FR_COL or FR_ROW */
1701 #ifdef FEAT_VERTSPLIT
1703 int fr_newwidth
; /* new width used in win_equal_rec() */
1706 int fr_newheight
; /* new height used in win_equal_rec() */
1707 frame_T
*fr_parent
; /* containing frame or NULL */
1708 frame_T
*fr_next
; /* frame right or below in same parent, NULL
1710 frame_T
*fr_prev
; /* frame left or above in same parent, NULL
1712 /* fr_child and fr_win are mutually exclusive */
1713 frame_T
*fr_child
; /* first contained frame */
1714 win_T
*fr_win
; /* window that fills this frame */
1717 #define FR_LEAF 0 /* frame is a leaf */
1718 #define FR_ROW 1 /* frame with a row of windows */
1719 #define FR_COL 2 /* frame with a column of windows */
1722 * Struct used for highlighting 'hlsearch' matches, matches defined by
1723 * ":match" and matches defined by match functions.
1724 * For 'hlsearch' there is one pattern for all windows. For ":match" and the
1725 * match functions there is a different pattern for each window.
1729 regmmatch_T rm
; /* points to the regexp program; contains last found
1730 match (may continue in next line) */
1731 buf_T
*buf
; /* the buffer to search for a match */
1732 linenr_T lnum
; /* the line to search for a match */
1733 int attr
; /* attributes to be used for a match */
1734 int attr_cur
; /* attributes currently active in win_line() */
1735 linenr_T first_lnum
; /* first lnum to search for multi-line pat */
1736 colnr_T startcol
; /* in win_line() points to char where HL starts */
1737 colnr_T endcol
; /* in win_line() points to char where HL ends */
1739 proftime_T tm
; /* for a time limit */
1744 * matchitem_T provides a linked list for storing match items for ":match" and
1745 * the match functions.
1747 typedef struct matchitem matchitem_T
;
1751 int id
; /* match ID */
1752 int priority
; /* match priority */
1753 char_u
*pattern
; /* pattern to highlight */
1754 int hlg_id
; /* highlight group ID */
1755 regmmatch_T match
; /* regexp program for pattern */
1756 match_T hl
; /* struct for doing the actual highlighting */
1760 * Structure which contains all information that belongs to a window
1762 * All row numbers are relative to the start of the window, except w_winrow.
1766 buf_T
*w_buffer
; /* buffer we are a window into (used
1767 often, keep it the first item!) */
1770 win_T
*w_prev
; /* link to previous window */
1771 win_T
*w_next
; /* link to next window */
1774 frame_T
*w_frame
; /* frame containing this window */
1776 pos_T w_cursor
; /* cursor position in buffer */
1778 colnr_T w_curswant
; /* The column we'd like to be at. This is
1779 used to try to stay in the same column
1780 for up/down cursor motions. */
1782 int w_set_curswant
; /* If set, then update w_curswant the next
1783 time through cursupdate() to the
1784 current virtual column */
1788 * the next six are used to update the visual part
1790 char w_old_visual_mode
; /* last known VIsual_mode */
1791 linenr_T w_old_cursor_lnum
; /* last known end of visual part */
1792 colnr_T w_old_cursor_fcol
; /* first column for block visual part */
1793 colnr_T w_old_cursor_lcol
; /* last column for block visual part */
1794 linenr_T w_old_visual_lnum
; /* last known start of visual part */
1795 colnr_T w_old_visual_col
; /* last known start of visual part */
1796 colnr_T w_old_curswant
; /* last known value of Curswant */
1800 * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for
1801 * displaying the buffer.
1803 linenr_T w_topline
; /* buffer line number of the line at the
1804 top of the window */
1806 char w_topline_was_set
; /* flag set to TRUE when topline is set,
1807 e.g. by winrestview() */
1810 int w_topfill
; /* number of filler lines above w_topline */
1811 int w_old_topfill
; /* w_topfill at last redraw */
1812 int w_botfill
; /* TRUE when filler lines are actually
1813 below w_topline (at end of file) */
1814 int w_old_botfill
; /* w_botfill at last redraw */
1816 colnr_T w_leftcol
; /* window column number of the left most
1817 character in the window; used when
1819 colnr_T w_skipcol
; /* starting column when a single line
1820 doesn't fit in the window */
1823 * Layout of the window in the screen.
1824 * May need to add "msg_scrolled" to "w_winrow" in rare situations.
1827 int w_winrow
; /* first row of window in screen */
1829 int w_height
; /* number of rows in window, excluding
1830 status/command line(s) */
1832 int w_status_height
; /* number of status lines (0 or 1) */
1834 #ifdef FEAT_VERTSPLIT
1835 int w_wincol
; /* Leftmost column of window in screen.
1837 int w_width
; /* Width of window, excluding separation.
1839 int w_vsep_width
; /* Number of separator columns (0 or 1).
1840 use W_VSEP_WIDTH() */
1844 * === start of cached values ====
1847 * Recomputing is minimized by storing the result of computations.
1848 * Use functions in screen.c to check if they are valid and to update.
1849 * w_valid is a bitfield of flags, which indicate if specific values are
1850 * valid or need to be recomputed. See screen.c for values.
1853 pos_T w_valid_cursor
; /* last known position of w_cursor, used
1854 to adjust w_valid */
1855 colnr_T w_valid_leftcol
; /* last known w_leftcol */
1858 * w_cline_height is the number of physical lines taken by the buffer line
1859 * that the cursor is on. We use this to avoid extra calls to plines().
1861 int w_cline_height
; /* current size of cursor line */
1863 int w_cline_folded
; /* cursor line is folded */
1866 int w_cline_row
; /* starting row of the cursor line */
1868 colnr_T w_virtcol
; /* column number of the cursor in the
1869 buffer line, as opposed to the column
1870 number we're at on the screen. This
1871 makes a difference on lines which span
1872 more than one screen line or when
1873 w_leftcol is non-zero */
1876 * w_wrow and w_wcol specify the cursor position in the window.
1877 * This is related to positions in the window, not in the display or
1878 * buffer, thus w_wrow is relative to w_winrow.
1880 int w_wrow
, w_wcol
; /* cursor position in window */
1882 linenr_T w_botline
; /* number of the line below the bottom of
1884 int w_empty_rows
; /* number of ~ rows in window */
1886 int w_filler_rows
; /* number of filler rows at the end of the
1891 * Info about the lines currently in the window is remembered to avoid
1892 * recomputing it every time. The allocated size of w_lines[] is Rows.
1893 * Only the w_lines_valid entries are actually valid.
1894 * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
1895 * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
1896 * Between changing text and updating the display w_lines[] represents
1897 * what is currently displayed. wl_valid is reset to indicated this.
1898 * This is used for efficient redrawing.
1900 int w_lines_valid
; /* number of valid entries */
1904 garray_T w_folds
; /* array of nested folds */
1905 char w_fold_manual
; /* when TRUE: some folds are opened/closed
1907 char w_foldinvalid
; /* when TRUE: folding needs to be
1910 #ifdef FEAT_LINEBREAK
1911 int w_nrwidth
; /* width of 'number' column being used */
1915 * === end of cached values ===
1918 int w_redr_type
; /* type of redraw to be performed on win */
1919 int w_upd_rows
; /* number of window lines to update when
1920 w_redr_type is REDRAW_TOP */
1921 linenr_T w_redraw_top
; /* when != 0: first line needing redraw */
1922 linenr_T w_redraw_bot
; /* when != 0: last line needing redraw */
1924 int w_redr_status
; /* if TRUE status line must be redrawn */
1927 #ifdef FEAT_CMDL_INFO
1928 /* remember what is shown in the ruler for this window (if 'ruler' set) */
1929 pos_T w_ru_cursor
; /* cursor position shown in ruler */
1930 colnr_T w_ru_virtcol
; /* virtcol shown in ruler */
1931 linenr_T w_ru_topline
; /* topline shown in ruler */
1932 linenr_T w_ru_line_count
; /* line count used for ruler */
1934 int w_ru_topfill
; /* topfill shown in ruler */
1936 char w_ru_empty
; /* TRUE if ruler shows 0-1 (empty line) */
1939 int w_alt_fnum
; /* alternate file (for # and CTRL-^) */
1942 alist_T
*w_alist
; /* pointer to arglist for this window */
1944 int w_arg_idx
; /* current index in argument list (can be
1946 int w_arg_idx_invalid
; /* editing another file than w_arg_idx */
1948 char_u
*w_localdir
; /* absolute path of local directory or
1951 * Options local to a window.
1952 * They are local because they influence the layout of the window or
1953 * depend on the window layout.
1954 * There are two values: w_onebuf_opt is local to the buffer currently in
1955 * this window, w_allbuf_opt is for all buffers in this window.
1957 winopt_T w_onebuf_opt
;
1958 winopt_T w_allbuf_opt
;
1960 /* A few options have local flags for P_INSECURE. */
1962 long_u w_p_stl_flags
; /* flags for 'statusline' */
1965 long_u w_p_fde_flags
; /* flags for 'foldexpr' */
1966 long_u w_p_fdt_flags
; /* flags for 'foldtext' */
1969 /* transform a pointer to a "onebuf" option into a "allbuf" option */
1970 #define GLOBAL_WO(p) ((char *)p + sizeof(winopt_T))
1972 #ifdef FEAT_SCROLLBIND
1977 dictitem_T w_winvar
; /* variable for "w:" Dictionary */
1978 dict_T w_vars
; /* internal variables, local to window */
1981 #if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
1982 int w_farsi
; /* for the window dependent Farsi functions */
1986 * The w_prev_pcmark field is used to check whether we really did jump to
1987 * a new line after setting the w_pcmark. If not, then we revert to
1988 * using the previous w_pcmark.
1990 pos_T w_pcmark
; /* previous context mark */
1991 pos_T w_prev_pcmark
; /* previous w_pcmark */
1993 #ifdef FEAT_JUMPLIST
1995 * the jumplist contains old cursor positions
1997 xfmark_T w_jumplist
[JUMPLISTSIZE
];
1998 int w_jumplistlen
; /* number of active entries */
1999 int w_jumplistidx
; /* current position */
2001 int w_changelistidx
; /* current position in b_changelist */
2004 #ifdef FEAT_SEARCH_EXTRA
2005 matchitem_T
*w_match_head
; /* head of match list */
2006 int w_next_match_id
; /* next match ID */
2010 * the tagstack grows from 0 upwards:
2015 taggy_T w_tagstack
[TAGSTACKSIZE
]; /* the tag stack */
2016 int w_tagstackidx
; /* idx just below active entry */
2017 int w_tagstacklen
; /* number of tags on stack */
2020 * w_fraction is the fractional row of the cursor within the window, from
2021 * 0 at the top row to FRACTION_MULT at the last row.
2022 * w_prev_fraction_row was the actual cursor row when w_fraction was last
2026 int w_prev_fraction_row
;
2029 scrollbar_T w_scrollbars
[2]; /* vert. Scrollbars for this window */
2031 #ifdef FEAT_LINEBREAK
2032 linenr_T w_nrwidth_line_count
; /* line count when ml_nrwidth_width
2034 int w_nrwidth_width
; /* nr of chars to print line count. */
2037 #ifdef FEAT_QUICKFIX
2038 qf_info_T
*w_llist
; /* Location list for this window */
2040 * Location list reference used in the location list window.
2041 * In a non-location list window, w_llist_ref is NULL.
2043 qf_info_T
*w_llist_ref
;
2047 #ifdef FEAT_MZSCHEME
2048 void *w_mzscheme_ref
; /* The MzScheme value for this window */
2052 void *w_perl_private
;
2056 void *w_python_ref
; /* The Python value for this window */
2069 * Arguments for operators.
2071 typedef struct oparg_S
2073 int op_type
; /* current pending operator type */
2074 int regname
; /* register to use for the operator */
2075 int motion_type
; /* type of the current cursor motion */
2076 int motion_force
; /* force motion type: 'v', 'V' or CTRL-V */
2077 int use_reg_one
; /* TRUE if delete uses reg 1 even when not
2079 int inclusive
; /* TRUE if char motion is inclusive (only
2080 valid when motion_type is MCHAR */
2081 int end_adjusted
; /* backuped b_op_end one char (only used by
2083 pos_T start
; /* start of the operator */
2084 pos_T end
; /* end of the operator */
2085 pos_T cursor_start
; /* cursor position before motion for "gw" */
2087 long line_count
; /* number of lines from op_start to op_end
2089 int empty
; /* op_start and op_end the same (only used by
2092 int is_VIsual
; /* operator on Visual area */
2093 int block_mode
; /* current operator is Visual block mode */
2095 colnr_T start_vcol
; /* start col for block mode operator */
2096 colnr_T end_vcol
; /* end col for block mode operator */
2098 long prev_opcount
; /* ca.opcount saved for K_CURSORHOLD */
2099 long prev_count0
; /* ca.count0 saved for K_CURSORHOLD */
2104 * Arguments for Normal mode commands.
2106 typedef struct cmdarg_S
2108 oparg_T
*oap
; /* Operator arguments */
2109 int prechar
; /* prefix character (optional, always 'g') */
2110 int cmdchar
; /* command character */
2111 int nchar
; /* next command character (optional) */
2113 int ncharC1
; /* first composing character (optional) */
2114 int ncharC2
; /* second composing character (optional) */
2116 int extra_char
; /* yet another character (optional) */
2117 long opcount
; /* count before an operator */
2118 long count0
; /* count before command, default 0 */
2119 long count1
; /* count before command, default 1 */
2120 int arg
; /* extra argument from nv_cmds[] */
2121 int retval
; /* return: CA_* values */
2122 char_u
*searchbuf
; /* return: pointer to search pattern or NULL */
2125 /* values for retval: */
2126 #define CA_COMMAND_BUSY 1 /* skip restarting edit() once */
2127 #define CA_NO_ADJ_OP_END 2 /* don't adjust operator end */
2131 * struct to store values from 'guicursor' and 'mouseshape'
2133 /* Indexes in shape_table[] */
2134 #define SHAPE_IDX_N 0 /* Normal mode */
2135 #define SHAPE_IDX_V 1 /* Visual mode */
2136 #define SHAPE_IDX_I 2 /* Insert mode */
2137 #define SHAPE_IDX_R 3 /* Replace mode */
2138 #define SHAPE_IDX_C 4 /* Command line Normal mode */
2139 #define SHAPE_IDX_CI 5 /* Command line Insert mode */
2140 #define SHAPE_IDX_CR 6 /* Command line Replace mode */
2141 #define SHAPE_IDX_O 7 /* Operator-pending mode */
2142 #define SHAPE_IDX_VE 8 /* Visual mode with 'seleciton' exclusive */
2143 #define SHAPE_IDX_CLINE 9 /* On command line */
2144 #define SHAPE_IDX_STATUS 10 /* A status line */
2145 #define SHAPE_IDX_SDRAG 11 /* dragging a status line */
2146 #define SHAPE_IDX_VSEP 12 /* A vertical separator line */
2147 #define SHAPE_IDX_VDRAG 13 /* dragging a vertical separator line */
2148 #define SHAPE_IDX_MORE 14 /* Hit-return or More */
2149 #define SHAPE_IDX_MOREL 15 /* Hit-return or More in last line */
2150 #define SHAPE_IDX_SM 16 /* showing matching paren */
2151 #define SHAPE_IDX_COUNT 17
2153 #define SHAPE_BLOCK 0 /* block cursor */
2154 #define SHAPE_HOR 1 /* horizontal bar cursor */
2155 #define SHAPE_VER 2 /* vertical bar cursor */
2157 #define MSHAPE_NUMBERED 1000 /* offset for shapes identified by number */
2158 #define MSHAPE_HIDE 1 /* hide mouse pointer */
2160 #define SHAPE_MOUSE 1 /* used for mouse pointer shape */
2161 #define SHAPE_CURSOR 2 /* used for text cursor shape */
2163 typedef struct cursor_entry
2165 int shape
; /* one of the SHAPE_ defines */
2166 int mshape
; /* one of the MSHAPE defines */
2167 int percentage
; /* percentage of cell for bar */
2168 long blinkwait
; /* blinking, wait time before blinking starts */
2169 long blinkon
; /* blinking, on time */
2170 long blinkoff
; /* blinking, off time */
2171 int id
; /* highlight group ID */
2172 int id_lm
; /* highlight group ID for :lmap mode */
2173 char *name
; /* mode name (fixed) */
2174 char used_for
; /* SHAPE_MOUSE and/or SHAPE_CURSOR */
2176 #endif /* CURSOR_SHAPE */
2180 /* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
2181 #define MENU_INDEX_INVALID -1
2182 #define MENU_INDEX_NORMAL 0
2183 #define MENU_INDEX_VISUAL 1
2184 #define MENU_INDEX_SELECT 2
2185 #define MENU_INDEX_OP_PENDING 3
2186 #define MENU_INDEX_INSERT 4
2187 #define MENU_INDEX_CMDLINE 5
2188 #define MENU_INDEX_TIP 6
2189 #define MENU_MODES 7
2192 #define MENU_NORMAL_MODE (1 << MENU_INDEX_NORMAL)
2193 #define MENU_VISUAL_MODE (1 << MENU_INDEX_VISUAL)
2194 #define MENU_SELECT_MODE (1 << MENU_INDEX_SELECT)
2195 #define MENU_OP_PENDING_MODE (1 << MENU_INDEX_OP_PENDING)
2196 #define MENU_INSERT_MODE (1 << MENU_INDEX_INSERT)
2197 #define MENU_CMDLINE_MODE (1 << MENU_INDEX_CMDLINE)
2198 #define MENU_TIP_MODE (1 << MENU_INDEX_TIP)
2199 #define MENU_ALL_MODES ((1 << MENU_INDEX_TIP) - 1)
2200 /*note MENU_INDEX_TIP is not a 'real' mode*/
2202 /* Start a menu name with this to not include it on the main menu bar */
2203 #define MNU_HIDDEN_CHAR ']'
2205 typedef struct VimMenu vimmenu_T
;
2209 int modes
; /* Which modes is this menu visible for? */
2210 int enabled
; /* for which modes the menu is enabled */
2211 char_u
*name
; /* Name of menu */
2212 char_u
*dname
; /* Displayed Name (without '&') */
2213 int mnemonic
; /* mnemonic key (after '&') */
2214 char_u
*actext
; /* accelerator text (after TAB) */
2215 int priority
; /* Menu order priority */
2217 void (*cb
) __ARGS((vimmenu_T
*)); /* Call-back routine */
2220 char_u
*iconfile
; /* name of file for icon or NULL */
2221 int iconidx
; /* icon index (-1 if not set) */
2222 int icon_builtin
; /* icon names is BuiltIn{nr} */
2224 char_u
*strings
[MENU_MODES
]; /* Mapped string for each mode */
2225 int noremap
[MENU_MODES
]; /* A REMAP_ flag for each mode */
2226 char silent
[MENU_MODES
]; /* A silent flag for each mode */
2227 vimmenu_T
*children
; /* Children of sub-menu */
2228 vimmenu_T
*parent
; /* Parent of menu */
2229 vimmenu_T
*next
; /* Next item in menu */
2231 Widget id
; /* Manage this to enable item */
2232 Widget submenu_id
; /* If this is submenu, add children here */
2235 GtkWidget
*id
; /* Manage this to enable item */
2236 GtkWidget
*submenu_id
; /* If this is submenu, add children here */
2237 GtkWidget
*tearoff_handle
;
2238 GtkWidget
*label
; /* Used by "set wak=" code. */
2240 #ifdef FEAT_GUI_MOTIF
2241 int sensitive
; /* turn button on/off */
2242 char **xpm
; /* pixmap data */
2243 char *xpm_fname
; /* file with pixmap data */
2245 #ifdef FEAT_GUI_ATHENA
2246 Pixmap image
; /* Toolbar image */
2248 #ifdef FEAT_BEVAL_TIP
2249 BalloonEval
*tip
; /* tooltip for this menu item */
2252 UINT id
; /* Id of menu item */
2253 HMENU submenu_id
; /* If this is submenu, add children here */
2256 UINT id
; /* Id of menu item */
2257 HMENU submenu_id
; /* If this is submenu, add children here */
2258 HWND tearoff_handle
; /* hWnd of tearoff if created */
2261 /* MenuHandle id; */
2262 /* short index; */ /* the item index within the father menu */
2263 short menu_id
; /* the menu id to which this item belong */
2264 short submenu_id
; /* the menu id of the children (could be
2265 get throught some tricks) */
2266 MenuHandle menu_handle
;
2267 MenuHandle submenu_handle
;
2270 int *id
; /* Not used, but gui.c needs it */
2271 int greyed_out
; /* Flag */
2274 #ifdef FEAT_GUI_PHOTON
2276 PtWidget_t
*submenu_id
;
2280 /* For generating prototypes when FEAT_MENU isn't defined. */
2281 typedef int vimmenu_T
;
2283 #endif /* FEAT_MENU */
2286 * Struct to save values in before executing autocommands for a buffer that is
2287 * not the current buffer. Without FEAT_AUTOCMD only "curbuf" is remembered.
2291 buf_T
*save_curbuf
; /* saved curbuf */
2293 int use_aucmd_win
; /* using aucmd_win */
2294 win_T
*save_curwin
; /* saved curwin */
2295 win_T
*new_curwin
; /* new curwin */
2296 buf_T
*new_curbuf
; /* new curbuf */
2297 char_u
*globaldir
; /* saved value of globaldir */
2302 * Generic option table item, only used for printer at the moment.
2309 char_u
*string
; /* points into option string */
2315 * Structure to hold printing color and font attributes.
2328 * Structure passed back to the generic printer code.
2332 int n_collated_copies
;
2333 int n_uncollated_copies
;
2338 prt_text_attr_T number
;
2345 #ifdef FEAT_POSTSCRIPT
2351 #define PRINT_NUMBER_WIDTH 8
2354 * Used for popup menu items.
2358 char_u
*pum_text
; /* main menu text */
2359 char_u
*pum_kind
; /* extra kind text (may be truncated) */
2360 char_u
*pum_extra
; /* extra menu text (may be truncated) */
2361 char_u
*pum_info
; /* extra info */
2365 * Structure used for get_tagfname().
2369 char_u
*tn_tags
; /* value of 'tags' when starting */
2370 char_u
*tn_np
; /* current position in tn_tags */
2371 int tn_did_filefind_init
;
2373 void *tn_search_ctx
;
2377 * Array indexes used for cptext argument of ins_compl_add().
2379 #define CPT_ABBR 0 /* "abbr" */
2380 #define CPT_MENU 1 /* "menu" */
2381 #define CPT_KIND 2 /* "kind" */
2382 #define CPT_INFO 3 /* "info" */
2383 #define CPT_COUNT 4 /* Number of entries */