[7.2.216] Two error messages have the same number E812.
[vim_extended.git] / src / structs.h
blob6d6c1d838ab33c299e785e2a18f982319946eb61
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.
7 */
9 /*
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;
19 typedef int colnr_T;
20 typedef unsigned short short_u;
21 #endif
24 * position in file or buffer
26 typedef struct
28 linenr_T lnum; /* line number */
29 colnr_T col; /* column number */
30 #ifdef FEAT_VIRTUALEDIT
31 colnr_T coladd;
32 #endif
33 } pos_T;
35 #ifdef FEAT_VIRTUALEDIT
36 # define INIT_POS_T(l, c, ca) {l, c, ca}
37 #else
38 # define INIT_POS_T(l, c, ca) {l, c}
39 #endif
42 * Same, but without coladd.
44 typedef struct
46 linenr_T lnum; /* line number */
47 colnr_T col; /* column number */
48 } lpos_T;
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 */
62 } garray_T;
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.
69 #include "regexp.h"
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
78 * for scrollbar_T.
80 #ifdef FEAT_GUI
81 # include "gui.h"
82 #else
83 # ifdef FEAT_XCLIPBOARD
84 # include <X11/Intrinsic.h>
85 # endif
86 # define guicolor_T int /* avoid error in prototypes */
87 #endif
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 */
105 } fmark_T;
107 /* Xtended file mark: also has a file name */
108 typedef struct xfilemark
110 fmark_T fmark;
111 char_u *fname; /* file name, used when fnum == 0 */
112 } xfmark_T;
115 * The taggy struct is used to store the information about a :tag command.
117 typedef struct taggy
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 */
123 } taggy_T;
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.
130 typedef struct
132 #ifdef FEAT_ARABIC
133 int wo_arab;
134 # define w_p_arab w_onebuf_opt.wo_arab /* 'arabic' */
135 #endif
136 #ifdef FEAT_DIFF
137 int wo_diff;
138 # define w_p_diff w_onebuf_opt.wo_diff /* 'diff' */
139 #endif
140 #ifdef FEAT_FOLDING
141 long wo_fdc;
142 # define w_p_fdc w_onebuf_opt.wo_fdc /* 'foldcolumn' */
143 int wo_fen;
144 # define w_p_fen w_onebuf_opt.wo_fen /* 'foldenable' */
145 char_u *wo_fdi;
146 # define w_p_fdi w_onebuf_opt.wo_fdi /* 'foldignore' */
147 long wo_fdl;
148 # define w_p_fdl w_onebuf_opt.wo_fdl /* 'foldlevel' */
149 char_u *wo_fdm;
150 # define w_p_fdm w_onebuf_opt.wo_fdm /* 'foldmethod' */
151 long wo_fml;
152 # define w_p_fml w_onebuf_opt.wo_fml /* 'foldminlines' */
153 long wo_fdn;
154 # define w_p_fdn w_onebuf_opt.wo_fdn /* 'foldnestmax' */
155 # ifdef FEAT_EVAL
156 char_u *wo_fde;
157 # define w_p_fde w_onebuf_opt.wo_fde /* 'foldexpr' */
158 char_u *wo_fdt;
159 # define w_p_fdt w_onebuf_opt.wo_fdt /* 'foldtext' */
160 # endif
161 char_u *wo_fmr;
162 # define w_p_fmr w_onebuf_opt.wo_fmr /* 'foldmarker' */
163 #endif
164 #ifdef FEAT_LINEBREAK
165 int wo_lbr;
166 # define w_p_lbr w_onebuf_opt.wo_lbr /* 'linebreak' */
167 #endif
168 int wo_list;
169 #define w_p_list w_onebuf_opt.wo_list /* 'list' */
170 int wo_nu;
171 #define w_p_nu w_onebuf_opt.wo_nu /* 'number' */
172 #ifdef FEAT_LINEBREAK
173 long wo_nuw;
174 # define w_p_nuw w_onebuf_opt.wo_nuw /* 'numberwidth' */
175 #endif
176 #if defined(FEAT_WINDOWS)
177 int wo_wfh;
178 # define w_p_wfh w_onebuf_opt.wo_wfh /* 'winfixheight' */
179 int wo_wfw;
180 # define w_p_wfw w_onebuf_opt.wo_wfw /* 'winfixwidth' */
181 #endif
182 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
183 int wo_pvw;
184 # define w_p_pvw w_onebuf_opt.wo_pvw /* 'previewwindow' */
185 #endif
186 #ifdef FEAT_RIGHTLEFT
187 int wo_rl;
188 # define w_p_rl w_onebuf_opt.wo_rl /* 'rightleft' */
189 char_u *wo_rlc;
190 # define w_p_rlc w_onebuf_opt.wo_rlc /* 'rightleftcmd' */
191 #endif
192 long wo_scr;
193 #define w_p_scr w_onebuf_opt.wo_scr /* 'scroll' */
194 #ifdef FEAT_SPELL
195 int wo_spell;
196 # define w_p_spell w_onebuf_opt.wo_spell /* 'spell' */
197 #endif
198 #ifdef FEAT_SYN_HL
199 int wo_cuc;
200 # define w_p_cuc w_onebuf_opt.wo_cuc /* 'cursorcolumn' */
201 int wo_cul;
202 # define w_p_cul w_onebuf_opt.wo_cul /* 'cursorline' */
203 #endif
204 #ifdef FEAT_STL_OPT
205 char_u *wo_stl;
206 #define w_p_stl w_onebuf_opt.wo_stl /* 'statusline' */
207 #endif
208 #ifdef FEAT_SCROLLBIND
209 int wo_scb;
210 # define w_p_scb w_onebuf_opt.wo_scb /* 'scrollbind' */
211 #endif
212 int wo_wrap;
213 #define w_p_wrap w_onebuf_opt.wo_wrap /* 'wrap' */
215 #ifdef FEAT_EVAL
216 int wo_scriptID[WV_COUNT]; /* SIDs for window-local options */
217 # define w_p_scriptID w_onebuf_opt.wo_scriptID
218 #endif
219 } winopt_T;
222 * Window info stored with a buffer.
224 * Two types of info are kept for a buffer which are associated with a
225 * specific window:
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.
231 struct wininfo_S
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 */
239 #ifdef FEAT_FOLDING
240 int wi_fold_manual; /* copy of w_fold_manual */
241 garray_T wi_folds; /* clone of w_folds */
242 #endif
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
255 line */
256 } foldinfo_T;
258 /* Structure to store info about the Visual area. */
259 typedef struct
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 */
265 } visualinfo_T;
268 * structures used for undo
271 typedef struct u_entry u_entry_T;
272 typedef struct u_header u_header_T;
273 struct u_entry
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 */
281 #ifdef U_DEBUG
282 int ue_magic; /* magic number to check allocation */
283 #endif
286 struct u_header
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
298 long uh_cursor_vcol;
299 #endif
300 int uh_flags; /* see below */
301 pos_T uh_namedm[NMARKS]; /* marks before undo/after redo */
302 #ifdef FEAT_VISUAL
303 visualinfo_T uh_visual; /* Visual areas before undo/after redo */
304 #endif
305 time_t uh_time; /* timestamp when the change was made */
306 #ifdef U_DEBUG
307 int uh_magic; /* magic number to check allocation */
308 #endif
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
318 #if SIZEOF_INT > 2
319 # define ALIGN_LONG /* longword alignment and use filler byte */
320 # define ALIGN_SIZE (sizeof(long))
321 #else
322 # define ALIGN_SIZE (sizeof(short))
323 #endif
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.
332 struct m_info
334 #ifdef ALIGN_LONG
335 long_u m_size; /* size of the chunk (including m_info) */
336 #else
337 short_u m_size; /* size of the chunk (including m_info) */
338 #endif
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;
346 struct m_block
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.
377 struct block_hdr
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 */
387 #define BH_DIRTY 1
388 #define BH_LOCKED 2
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;
400 struct 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
411 struct buffblock
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
420 struct buffheader
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 #if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
436 char_u *xp_arg; /* completion function */
437 int xp_scriptID; /* SID for completion function */
438 #endif
439 int xp_backslash; /* one of the XP_BS_ values */
440 #ifndef BACKSLASH_IN_FILENAME
441 int xp_shell; /* for a shell command more characters
442 need to be escaped */
443 #endif
444 int xp_numfiles; /* number of files found by
445 file name completion */
446 char_u **xp_files; /* list of files */
447 } expand_T;
449 /* values for xp_backslash */
450 #define XP_BS_NONE 0 /* nothing special for backslashes */
451 #define XP_BS_ONE 1 /* uses one backslash before a space */
452 #define XP_BS_THREE 2 /* uses three backslashes before a space */
455 * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
456 * This needs to be saved for recursive commands, put them in a structure for
457 * easy manipulation.
459 typedef struct
461 int hide; /* TRUE when ":hide" was used */
462 # ifdef FEAT_BROWSE_CMD
463 int browse; /* TRUE to invoke file dialog */
464 # endif
465 # ifdef FEAT_WINDOWS
466 int split; /* flags for win_split() */
467 int tab; /* > 0 when ":tab" was used */
468 # endif
469 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
470 int confirm; /* TRUE to invoke yes/no dialog */
471 # endif
472 int keepalt; /* TRUE when ":keepalt" was used */
473 int keepmarks; /* TRUE when ":keepmarks" was used */
474 int keepjumps; /* TRUE when ":keepjumps" was used */
475 int lockmarks; /* TRUE when ":lockmarks" was used */
476 # ifdef FEAT_AUTOCMD
477 char_u *save_ei; /* saved value of 'eventignore' */
478 # endif
479 } cmdmod_T;
482 * Simplistic hashing scheme to quickly locate the blocks in the used list.
483 * 64 blocks are found directly (64 * 4K = 256K, most files are smaller).
485 #define MEMHASHSIZE 64
486 #define MEMHASH(nr) ((nr) & (MEMHASHSIZE - 1))
488 struct memfile
490 char_u *mf_fname; /* name of the file */
491 char_u *mf_ffname; /* idem, full path */
492 int mf_fd; /* file descriptor */
493 bhdr_T *mf_free_first; /* first block_hdr in free list */
494 bhdr_T *mf_used_first; /* mru block_hdr in used list */
495 bhdr_T *mf_used_last; /* lru block_hdr in used list */
496 unsigned mf_used_count; /* number of pages in used list */
497 unsigned mf_used_count_max; /* maximum number of pages in memory */
498 bhdr_T *mf_hash[MEMHASHSIZE]; /* array of hash lists */
499 NR_TRANS *mf_trans[MEMHASHSIZE]; /* array of trans lists */
500 blocknr_T mf_blocknr_max; /* highest positive block number + 1*/
501 blocknr_T mf_blocknr_min; /* lowest negative block number - 1 */
502 blocknr_T mf_neg_count; /* number of negative blocks numbers */
503 blocknr_T mf_infile_count; /* number of pages in the file */
504 unsigned mf_page_size; /* number of bytes in a page */
505 int mf_dirty; /* TRUE if there are dirty blocks */
509 * things used in memline.c
512 * When searching for a specific line, we remember what blocks in the tree
513 * are the branches leading to that block. This is stored in ml_stack. Each
514 * entry is a pointer to info in a block (may be data block or pointer block)
516 typedef struct info_pointer
518 blocknr_T ip_bnum; /* block number */
519 linenr_T ip_low; /* lowest lnum in this block */
520 linenr_T ip_high; /* highest lnum in this block */
521 int ip_index; /* index for block with current lnum */
522 } infoptr_T; /* block/index pair */
524 #ifdef FEAT_BYTEOFF
525 typedef struct ml_chunksize
527 int mlcs_numlines;
528 long mlcs_totalsize;
529 } chunksize_T;
531 /* Flags when calling ml_updatechunk() */
533 #define ML_CHNK_ADDLINE 1
534 #define ML_CHNK_DELLINE 2
535 #define ML_CHNK_UPDLINE 3
536 #endif
539 * the memline structure holds all the information about a memline
541 typedef struct memline
543 linenr_T ml_line_count; /* number of lines in the buffer */
545 memfile_T *ml_mfp; /* pointer to associated memfile */
547 #define ML_EMPTY 1 /* empty buffer */
548 #define ML_LINE_DIRTY 2 /* cached line was changed and allocated */
549 #define ML_LOCKED_DIRTY 4 /* ml_locked was changed */
550 #define ML_LOCKED_POS 8 /* ml_locked needs positive block number */
551 int ml_flags;
553 infoptr_T *ml_stack; /* stack of pointer blocks (array of IPTRs) */
554 int ml_stack_top; /* current top if ml_stack */
555 int ml_stack_size; /* total number of entries in ml_stack */
557 linenr_T ml_line_lnum; /* line number of cached line, 0 if not valid */
558 char_u *ml_line_ptr; /* pointer to cached line */
560 bhdr_T *ml_locked; /* block used by last ml_get */
561 linenr_T ml_locked_low; /* first line in ml_locked */
562 linenr_T ml_locked_high; /* last line in ml_locked */
563 int ml_locked_lineadd; /* number of lines inserted in ml_locked */
564 #ifdef FEAT_BYTEOFF
565 chunksize_T *ml_chunksize;
566 int ml_numchunks;
567 int ml_usedchunks;
568 #endif
569 } memline_T;
571 #if defined(FEAT_SIGNS) || defined(PROTO)
572 typedef struct signlist signlist_T;
574 struct signlist
576 int id; /* unique identifier for each placed sign */
577 linenr_T lnum; /* line number which has this sign */
578 int typenr; /* typenr of sign */
579 signlist_T *next; /* next signlist entry */
580 # ifdef FEAT_NETBEANS_INTG
581 signlist_T *prev; /* previous entry -- for easy reordering */
582 # endif
585 /* type argument for buf_getsigntype() */
586 #define SIGN_ANY 0
587 #define SIGN_LINEHL 1
588 #define SIGN_ICON 2
589 #define SIGN_TEXT 3
590 #endif
593 * Argument list: Array of file names.
594 * Used for the global argument list and the argument lists local to a window.
596 typedef struct arglist
598 garray_T al_ga; /* growarray with the array of file names */
599 int al_refcount; /* number of windows using this arglist */
600 } alist_T;
603 * For each argument remember the file name as it was given, and the buffer
604 * number that contains the expanded file name (required for when ":cd" is
605 * used.
607 typedef struct argentry
609 char_u *ae_fname; /* file name as specified */
610 int ae_fnum; /* buffer number with expanded file name */
611 } aentry_T;
613 #ifdef FEAT_WINDOWS
614 # define ALIST(win) (win)->w_alist
615 #else
616 # define ALIST(win) (&global_alist)
617 #endif
618 #define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data)
619 #define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data)
620 #define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data)
621 #define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data))
622 #define GARGCOUNT (global_alist.al_ga.ga_len)
623 #define ARGCOUNT (ALIST(curwin)->al_ga.ga_len)
624 #define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len)
627 * A list used for saving values of "emsg_silent". Used by ex_try() to save the
628 * value of "emsg_silent" if it was non-zero. When this is done, the CSF_SILENT
629 * flag below is set.
632 typedef struct eslist_elem eslist_T;
633 struct eslist_elem
635 int saved_emsg_silent; /* saved value of "emsg_silent" */
636 eslist_T *next; /* next element on the list */
640 * For conditional commands a stack is kept of nested conditionals.
641 * When cs_idx < 0, there is no conditional command.
643 #define CSTACK_LEN 50
645 struct condstack
647 short cs_flags[CSTACK_LEN]; /* CSF_ flags */
648 char cs_pending[CSTACK_LEN]; /* CSTP_: what's pending in ":finally"*/
649 union {
650 void *csp_rv[CSTACK_LEN]; /* return typeval for pending return */
651 void *csp_ex[CSTACK_LEN]; /* exception for pending throw */
652 } cs_pend;
653 void *cs_forinfo[CSTACK_LEN]; /* info used by ":for" */
654 int cs_line[CSTACK_LEN]; /* line nr of ":while"/":for" line */
655 int cs_idx; /* current entry, or -1 if none */
656 int cs_looplevel; /* nr of nested ":while"s and ":for"s */
657 int cs_trylevel; /* nr of nested ":try"s */
658 eslist_T *cs_emsg_silent_list; /* saved values of "emsg_silent" */
659 char cs_lflags; /* loop flags: CSL_ flags */
661 # define cs_rettv cs_pend.csp_rv
662 # define cs_exception cs_pend.csp_ex
664 /* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
665 * was used. */
666 # define CSF_TRUE 0x0001 /* condition was TRUE */
667 # define CSF_ACTIVE 0x0002 /* current state is active */
668 # define CSF_ELSE 0x0004 /* ":else" has been passed */
669 # define CSF_WHILE 0x0008 /* is a ":while" */
670 # define CSF_FOR 0x0010 /* is a ":for" */
672 # define CSF_TRY 0x0100 /* is a ":try" */
673 # define CSF_FINALLY 0x0200 /* ":finally" has been passed */
674 # define CSF_THROWN 0x0400 /* exception thrown to this try conditional */
675 # define CSF_CAUGHT 0x0800 /* exception caught by this try conditional */
676 # define CSF_SILENT 0x1000 /* "emsg_silent" reset by ":try" */
677 /* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
678 * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
681 * What's pending for being reactivated at the ":endtry" of this try
682 * conditional:
684 # define CSTP_NONE 0 /* nothing pending in ":finally" clause */
685 # define CSTP_ERROR 1 /* an error is pending */
686 # define CSTP_INTERRUPT 2 /* an interrupt is pending */
687 # define CSTP_THROW 4 /* a throw is pending */
688 # define CSTP_BREAK 8 /* ":break" is pending */
689 # define CSTP_CONTINUE 16 /* ":continue" is pending */
690 # define CSTP_RETURN 24 /* ":return" is pending */
691 # define CSTP_FINISH 32 /* ":finish" is pending */
694 * Flags for the cs_lflags item in struct condstack.
696 # define CSL_HAD_LOOP 1 /* just found ":while" or ":for" */
697 # define CSL_HAD_ENDLOOP 2 /* just found ":endwhile" or ":endfor" */
698 # define CSL_HAD_CONT 4 /* just found ":continue" */
699 # define CSL_HAD_FINA 8 /* just found ":finally" */
702 * A list of error messages that can be converted to an exception. "throw_msg"
703 * is only set in the first element of the list. Usually, it points to the
704 * original message stored in that element, but sometimes it points to a later
705 * message in the list. See cause_errthrow() below.
707 struct msglist
709 char_u *msg; /* original message */
710 char_u *throw_msg; /* msg to throw: usually original one */
711 struct msglist *next; /* next of several messages in a row */
715 * Structure describing an exception.
716 * (don't use "struct exception", it's used by the math library).
718 typedef struct vim_exception except_T;
719 struct vim_exception
721 int type; /* exception type */
722 char_u *value; /* exception value */
723 struct msglist *messages; /* message(s) causing error exception */
724 char_u *throw_name; /* name of the throw point */
725 linenr_T throw_lnum; /* line number of the throw point */
726 except_T *caught; /* next exception on the caught stack */
730 * The exception types.
732 #define ET_USER 0 /* exception caused by ":throw" command */
733 #define ET_ERROR 1 /* error exception */
734 #define ET_INTERRUPT 2 /* interrupt exception triggered by Ctrl-C */
737 * Structure to save the error/interrupt/exception state between calls to
738 * enter_cleanup() and leave_cleanup(). Must be allocated as an automatic
739 * variable by the (common) caller of these functions.
741 typedef struct cleanup_stuff cleanup_T;
742 struct cleanup_stuff
744 int pending; /* error/interrupt/exception state */
745 except_T *exception; /* exception value */
748 #ifdef FEAT_SYN_HL
749 /* struct passed to in_id_list() */
750 struct sp_syn
752 int inc_tag; /* ":syn include" unique tag */
753 short id; /* highlight group ID of item */
754 short *cont_in_list; /* cont.in group IDs, if non-zero */
758 * Each keyword has one keyentry, which is linked in a hash list.
760 typedef struct keyentry keyentry_T;
762 struct keyentry
764 keyentry_T *ke_next; /* next entry with identical "keyword[]" */
765 struct sp_syn k_syn; /* struct passed to in_id_list() */
766 short *next_list; /* ID list for next match (if non-zero) */
767 short flags; /* see syntax.c */
768 char_u keyword[1]; /* actually longer */
772 * Struct used to store one state of the state stack.
774 typedef struct buf_state
776 int bs_idx; /* index of pattern */
777 long bs_flags; /* flags for pattern */
778 reg_extmatch_T *bs_extmatch; /* external matches from start pattern */
779 } bufstate_T;
782 * syn_state contains the syntax state stack for the start of one line.
783 * Used by b_sst_array[].
785 typedef struct syn_state synstate_T;
787 struct syn_state
789 synstate_T *sst_next; /* next entry in used or free list */
790 linenr_T sst_lnum; /* line number for this state */
791 union
793 bufstate_T sst_stack[SST_FIX_STATES]; /* short state stack */
794 garray_T sst_ga; /* growarray for long state stack */
795 } sst_union;
796 int sst_next_flags; /* flags for sst_next_list */
797 short *sst_next_list; /* "nextgroup" list in this state
798 * (this is a copy, don't free it! */
799 short sst_stacksize; /* number of states on the stack */
800 disptick_T sst_tick; /* tick when last displayed */
801 linenr_T sst_change_lnum;/* when non-zero, change in this line
802 * may have made the state invalid */
804 #endif /* FEAT_SYN_HL */
807 * Structure shared between syntax.c, screen.c and gui_x11.c.
809 typedef struct attr_entry
811 short ae_attr; /* HL_BOLD, etc. */
812 union
814 struct
816 char_u *start; /* start escape sequence */
817 char_u *stop; /* stop escape sequence */
818 } term;
819 struct
821 /* These colors need to be > 8 bits to hold 256. */
822 short_u fg_color; /* foreground color number */
823 short_u bg_color; /* background color number */
824 } cterm;
825 # ifdef FEAT_GUI
826 struct
828 guicolor_T fg_color; /* foreground color handle */
829 guicolor_T bg_color; /* background color handle */
830 guicolor_T sp_color; /* special color handle */
831 GuiFont font; /* font handle */
832 # ifdef FEAT_XFONTSET
833 GuiFontset fontset; /* fontset handle */
834 # endif
835 } gui;
836 # endif
837 } ae_u;
838 } attrentry_T;
840 #ifdef USE_ICONV
841 # ifdef HAVE_ICONV_H
842 # include <iconv.h>
843 # else
844 # if defined(MACOS_X)
845 # include <sys/errno.h>
846 # define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
847 typedef struct _iconv_t *iconv_t;
848 # else
849 # if defined(MACOS_CLASSIC)
850 typedef struct _iconv_t *iconv_t;
851 # define EINVAL 22
852 # define E2BIG 7
853 # define ENOENT 2
854 # define EFAULT 14
855 # define EILSEQ 123
856 # else
857 # include <errno.h>
858 # endif
859 # endif
860 typedef void *iconv_t;
861 # endif
862 #endif
865 * Used for the typeahead buffer: typebuf.
867 typedef struct
869 char_u *tb_buf; /* buffer for typed characters */
870 char_u *tb_noremap; /* mapping flags for characters in tb_buf[] */
871 int tb_buflen; /* size of tb_buf[] */
872 int tb_off; /* current position in tb_buf[] */
873 int tb_len; /* number of valid bytes in tb_buf[] */
874 int tb_maplen; /* nr of mapped bytes in tb_buf[] */
875 int tb_silent; /* nr of silently mapped bytes in tb_buf[] */
876 int tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */
877 int tb_change_cnt; /* nr of time tb_buf was changed; never zero */
878 } typebuf_T;
880 /* Struct to hold the saved typeahead for save_typeahead(). */
881 typedef struct
883 typebuf_T save_typebuf;
884 int typebuf_valid; /* TRUE when save_typebuf valid */
885 struct buffheader save_stuffbuff;
886 #ifdef USE_INPUT_BUF
887 char_u *save_inputbuf;
888 #endif
889 } tasave_T;
892 * Used for conversion of terminal I/O and script files.
894 typedef struct
896 int vc_type; /* zero or one of the CONV_ values */
897 int vc_factor; /* max. expansion factor */
898 # ifdef WIN3264
899 int vc_cpfrom; /* codepage to convert from (CONV_CODEPAGE) */
900 int vc_cpto; /* codepage to convert to (CONV_CODEPAGE) */
901 # endif
902 # ifdef USE_ICONV
903 iconv_t vc_fd; /* for CONV_ICONV */
904 # endif
905 int vc_fail; /* fail for invalid char, don't use '?' */
906 } vimconv_T;
909 * Structure used for reading from the viminfo file.
911 typedef struct
913 char_u *vir_line; /* text of the current line */
914 FILE *vir_fd; /* file descriptor */
915 #ifdef FEAT_MBYTE
916 vimconv_T vir_conv; /* encoding conversion */
917 #endif
918 } vir_T;
920 #define CONV_NONE 0
921 #define CONV_TO_UTF8 1
922 #define CONV_9_TO_UTF8 2
923 #define CONV_TO_LATIN1 3
924 #define CONV_TO_LATIN9 4
925 #define CONV_ICONV 5
926 #ifdef WIN3264
927 # define CONV_CODEPAGE 10 /* codepage -> codepage */
928 #endif
929 #ifdef MACOS_X
930 # define CONV_MAC_LATIN1 20
931 # define CONV_LATIN1_MAC 21
932 # define CONV_MAC_UTF8 22
933 # define CONV_UTF8_MAC 23
934 #endif
937 * Structure used for mappings and abbreviations.
939 typedef struct mapblock mapblock_T;
940 struct mapblock
942 mapblock_T *m_next; /* next mapblock in list */
943 char_u *m_keys; /* mapped from */
944 int m_keylen; /* strlen(m_keys) */
945 char_u *m_str; /* mapped to */
946 int m_mode; /* valid mode */
947 int m_noremap; /* if non-zero no re-mapping for m_str */
948 char m_silent; /* <silent> used, don't echo commands */
949 #ifdef FEAT_EVAL
950 char m_expr; /* <expr> used, m_str is an expression */
951 scid_T m_script_ID; /* ID of script where map was defined */
952 #endif
956 * Used for highlighting in the status line.
958 struct stl_hlrec
960 char_u *start;
961 int userhl; /* 0: no HL, 1-9: User HL, < 0 for syn ID */
964 /* Item for a hashtable. "hi_key" can be one of three values:
965 * NULL: Never been used
966 * HI_KEY_REMOVED: Entry was removed
967 * Otherwise: Used item, pointer to the actual key; this usually is
968 * inside the item, subtract an offset to locate the item.
969 * This reduces the size of hashitem by 1/3.
971 typedef struct hashitem_S
973 long_u hi_hash; /* cached hash number of hi_key */
974 char_u *hi_key;
975 } hashitem_T;
977 /* The address of "hash_removed" is used as a magic number for hi_key to
978 * indicate a removed item. */
979 #define HI_KEY_REMOVED &hash_removed
980 #define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
982 /* Initial size for a hashtable. Our items are relatively small and growing
983 * is expensive, thus use 16 as a start. Must be a power of 2. */
984 #define HT_INIT_SIZE 16
986 typedef struct hashtable_S
988 long_u ht_mask; /* mask used for hash value (nr of items in
989 * array is "ht_mask" + 1) */
990 long_u ht_used; /* number of items used */
991 long_u ht_filled; /* number of items used + removed */
992 int ht_locked; /* counter for hash_lock() */
993 int ht_error; /* when set growing failed, can't add more
994 items before growing works */
995 hashitem_T *ht_array; /* points to the array, allocated when it's
996 not "ht_smallarray" */
997 hashitem_T ht_smallarray[HT_INIT_SIZE]; /* initial array */
998 } hashtab_T;
1000 typedef long_u hash_T; /* Type for hi_hash */
1003 #if SIZEOF_INT <= 3 /* use long if int is smaller than 32 bits */
1004 typedef long varnumber_T;
1005 #else
1006 typedef int varnumber_T;
1007 #endif
1008 typedef double float_T;
1010 typedef struct listvar_S list_T;
1011 typedef struct dictvar_S dict_T;
1014 * Structure to hold an internal variable without a name.
1016 typedef struct
1018 char v_type; /* see below: VAR_NUMBER, VAR_STRING, etc. */
1019 char v_lock; /* see below: VAR_LOCKED, VAR_FIXED */
1020 union
1022 varnumber_T v_number; /* number value */
1023 #ifdef FEAT_FLOAT
1024 float_T v_float; /* floating number value */
1025 #endif
1026 char_u *v_string; /* string value (can be NULL!) */
1027 list_T *v_list; /* list value (can be NULL!) */
1028 dict_T *v_dict; /* dict value (can be NULL!) */
1029 } vval;
1030 } typval_T;
1032 /* Values for "v_type". */
1033 #define VAR_UNKNOWN 0
1034 #define VAR_NUMBER 1 /* "v_number" is used */
1035 #define VAR_STRING 2 /* "v_string" is used */
1036 #define VAR_FUNC 3 /* "v_string" is function name */
1037 #define VAR_LIST 4 /* "v_list" is used */
1038 #define VAR_DICT 5 /* "v_dict" is used */
1039 #define VAR_FLOAT 6 /* "v_float" is used */
1041 /* Values for "v_lock". */
1042 #define VAR_LOCKED 1 /* locked with lock(), can use unlock() */
1043 #define VAR_FIXED 2 /* locked forever */
1046 * Structure to hold an item of a list: an internal variable without a name.
1048 typedef struct listitem_S listitem_T;
1050 struct listitem_S
1052 listitem_T *li_next; /* next item in list */
1053 listitem_T *li_prev; /* previous item in list */
1054 typval_T li_tv; /* type and value of the variable */
1058 * Struct used by those that are using an item in a list.
1060 typedef struct listwatch_S listwatch_T;
1062 struct listwatch_S
1064 listitem_T *lw_item; /* item being watched */
1065 listwatch_T *lw_next; /* next watcher */
1069 * Structure to hold info about a list.
1071 struct listvar_S
1073 listitem_T *lv_first; /* first item, NULL if none */
1074 listitem_T *lv_last; /* last item, NULL if none */
1075 int lv_refcount; /* reference count */
1076 int lv_len; /* number of items */
1077 listwatch_T *lv_watch; /* first watcher, NULL if none */
1078 int lv_idx; /* cached index of an item */
1079 listitem_T *lv_idx_item; /* when not NULL item at index "lv_idx" */
1080 int lv_copyID; /* ID used by deepcopy() */
1081 list_T *lv_copylist; /* copied list used by deepcopy() */
1082 char lv_lock; /* zero, VAR_LOCKED, VAR_FIXED */
1083 list_T *lv_used_next; /* next list in used lists list */
1084 list_T *lv_used_prev; /* previous list in used lists list */
1088 * Structure to hold an item of a Dictionary.
1089 * Also used for a variable.
1090 * The key is copied into "di_key" to avoid an extra alloc/free for it.
1092 struct dictitem_S
1094 typval_T di_tv; /* type and value of the variable */
1095 char_u di_flags; /* flags (only used for variable) */
1096 char_u di_key[1]; /* key (actually longer!) */
1099 typedef struct dictitem_S dictitem_T;
1101 #define DI_FLAGS_RO 1 /* "di_flags" value: read-only variable */
1102 #define DI_FLAGS_RO_SBX 2 /* "di_flags" value: read-only in the sandbox */
1103 #define DI_FLAGS_FIX 4 /* "di_flags" value: fixed variable, not allocated */
1104 #define DI_FLAGS_LOCK 8 /* "di_flags" value: locked variable */
1107 * Structure to hold info about a Dictionary.
1109 struct dictvar_S
1111 int dv_refcount; /* reference count */
1112 hashtab_T dv_hashtab; /* hashtab that refers to the items */
1113 int dv_copyID; /* ID used by deepcopy() */
1114 dict_T *dv_copydict; /* copied dict used by deepcopy() */
1115 char dv_lock; /* zero, VAR_LOCKED, VAR_FIXED */
1116 dict_T *dv_used_next; /* next dict in used dicts list */
1117 dict_T *dv_used_prev; /* previous dict in used dicts list */
1120 /* values for b_syn_spell: what to do with toplevel text */
1121 #define SYNSPL_DEFAULT 0 /* spell check if @Spell not defined */
1122 #define SYNSPL_TOP 1 /* spell check toplevel text */
1123 #define SYNSPL_NOTOP 2 /* don't spell check toplevel text */
1125 /* avoid #ifdefs for when b_spell is not available */
1126 #ifdef FEAT_SPELL
1127 # define B_SPELL(buf) ((buf)->b_spell)
1128 #else
1129 # define B_SPELL(buf) (0)
1130 #endif
1132 #ifdef FEAT_QUICKFIX
1133 typedef struct qf_info_S qf_info_T;
1134 #endif
1137 * buffer: structure that holds information about one file
1139 * Several windows can share a single Buffer
1140 * A buffer is unallocated if there is no memfile for it.
1141 * A buffer is new if the associated file has never been loaded yet.
1144 typedef struct file_buffer buf_T;
1146 struct file_buffer
1148 memline_T b_ml; /* associated memline (also contains line
1149 count) */
1151 buf_T *b_next; /* links in list of buffers */
1152 buf_T *b_prev;
1154 int b_nwindows; /* nr of windows open on this buffer */
1156 int b_flags; /* various BF_ flags */
1159 * b_ffname has the full path of the file (NULL for no name).
1160 * b_sfname is the name as the user typed it (or NULL).
1161 * b_fname is the same as b_sfname, unless ":cd" has been done,
1162 * then it is the same as b_ffname (NULL for no name).
1164 char_u *b_ffname; /* full path file name */
1165 char_u *b_sfname; /* short file name */
1166 char_u *b_fname; /* current file name */
1168 #ifdef UNIX
1169 int b_dev_valid; /* TRUE when b_dev has a valid number */
1170 dev_t b_dev; /* device number */
1171 ino_t b_ino; /* inode number */
1172 #endif
1173 #ifdef FEAT_CW_EDITOR
1174 FSSpec b_FSSpec; /* MacOS File Identification */
1175 #endif
1176 #ifdef VMS
1177 char b_fab_rfm; /* Record format */
1178 char b_fab_rat; /* Record attribute */
1179 unsigned int b_fab_mrs; /* Max record size */
1180 #endif
1181 #ifdef FEAT_SNIFF
1182 int b_sniff; /* file was loaded through Sniff */
1183 #endif
1185 int b_fnum; /* buffer number for this file. */
1187 int b_changed; /* 'modified': Set to TRUE if something in the
1188 file has been changed and not written out. */
1189 int b_changedtick; /* incremented for each change, also for undo */
1191 int b_saving; /* Set to TRUE if we are in the middle of
1192 saving the buffer. */
1195 * Changes to a buffer require updating of the display. To minimize the
1196 * work, remember changes made and update everything at once.
1198 int b_mod_set; /* TRUE when there are changes since the last
1199 time the display was updated */
1200 linenr_T b_mod_top; /* topmost lnum that was changed */
1201 linenr_T b_mod_bot; /* lnum below last changed line, AFTER the
1202 change */
1203 long b_mod_xlines; /* number of extra buffer lines inserted;
1204 negative when lines were deleted */
1206 wininfo_T *b_wininfo; /* list of last used info for each window */
1208 long b_mtime; /* last change time of original file */
1209 long b_mtime_read; /* last change time when reading */
1210 size_t b_orig_size; /* size of original file in bytes */
1211 int b_orig_mode; /* mode of original file */
1213 pos_T b_namedm[NMARKS]; /* current named marks (mark.c) */
1215 #ifdef FEAT_VISUAL
1216 /* These variables are set when VIsual_active becomes FALSE */
1217 visualinfo_T b_visual;
1218 # ifdef FEAT_EVAL
1219 int b_visual_mode_eval; /* b_visual.vi_mode for visualmode() */
1220 # endif
1221 #endif
1223 pos_T b_last_cursor; /* cursor position when last unloading this
1224 buffer */
1225 pos_T b_last_insert; /* where Insert mode was left */
1226 pos_T b_last_change; /* position of last change: '. mark */
1228 #ifdef FEAT_JUMPLIST
1230 * the changelist contains old change positions
1232 pos_T b_changelist[JUMPLISTSIZE];
1233 int b_changelistlen; /* number of active entries */
1234 int b_new_change; /* set by u_savecommon() */
1235 #endif
1238 * Character table, only used in charset.c for 'iskeyword'
1239 * 32 bytes of 8 bits: 1 bit per character 0-255.
1241 char_u b_chartab[32];
1243 #ifdef FEAT_LOCALMAP
1244 /* Table used for mappings local to a buffer. */
1245 mapblock_T *(b_maphash[256]);
1247 /* First abbreviation local to a buffer. */
1248 mapblock_T *b_first_abbr;
1249 #endif
1250 #ifdef FEAT_USR_CMDS
1251 /* User commands local to the buffer. */
1252 garray_T b_ucmds;
1253 #endif
1255 * start and end of an operator, also used for '[ and ']
1257 pos_T b_op_start;
1258 pos_T b_op_end;
1260 #ifdef FEAT_VIMINFO
1261 int b_marks_read; /* Have we read viminfo marks yet? */
1262 #endif
1265 * The following only used in undo.c.
1267 u_header_T *b_u_oldhead; /* pointer to oldest header */
1268 u_header_T *b_u_newhead; /* pointer to newest header; may not be valid
1269 if b_u_curhead is not NULL */
1270 u_header_T *b_u_curhead; /* pointer to current header */
1271 int b_u_numhead; /* current number of headers */
1272 int b_u_synced; /* entry lists are synced */
1273 long b_u_seq_last; /* last used undo sequence number */
1274 long b_u_seq_cur; /* hu_seq of header below which we are now */
1275 time_t b_u_seq_time; /* uh_time of header below which we are now */
1278 * variables for "U" command in undo.c
1280 char_u *b_u_line_ptr; /* saved line for "U" command */
1281 linenr_T b_u_line_lnum; /* line number of line in u_line */
1282 colnr_T b_u_line_colnr; /* optional column number */
1285 * The following only used in undo.c
1287 mblock_T b_block_head; /* head of allocated memory block list */
1288 minfo_T *b_m_search; /* pointer to chunk before previously
1289 allocated/freed chunk */
1290 mblock_T *b_mb_current; /* block where m_search points in */
1292 #ifdef FEAT_INS_EXPAND
1293 int b_scanned; /* ^N/^P have scanned this buffer */
1294 #endif
1296 /* flags for use of ":lmap" and IM control */
1297 long b_p_iminsert; /* input mode for insert */
1298 long b_p_imsearch; /* input mode for search */
1299 #define B_IMODE_USE_INSERT -1 /* Use b_p_iminsert value for search */
1300 #define B_IMODE_NONE 0 /* Input via none */
1301 #define B_IMODE_LMAP 1 /* Input via langmap */
1302 #ifndef USE_IM_CONTROL
1303 # define B_IMODE_LAST 1
1304 #else
1305 # define B_IMODE_IM 2 /* Input via input method */
1306 # define B_IMODE_LAST 2
1307 #endif
1309 #ifdef FEAT_KEYMAP
1310 short b_kmap_state; /* using "lmap" mappings */
1311 # define KEYMAP_INIT 1 /* 'keymap' was set, call keymap_init() */
1312 # define KEYMAP_LOADED 2 /* 'keymap' mappings have been loaded */
1313 garray_T b_kmap_ga; /* the keymap table */
1314 #endif
1317 * Options local to a buffer.
1318 * They are here because their value depends on the type of file
1319 * or contents of the file being edited.
1321 int b_p_initialized; /* set when options initialized */
1323 #ifdef FEAT_EVAL
1324 int b_p_scriptID[BV_COUNT]; /* SIDs for buffer-local options */
1325 #endif
1327 int b_p_ai; /* 'autoindent' */
1328 int b_p_ai_nopaste; /* b_p_ai saved for paste mode */
1329 int b_p_ci; /* 'copyindent' */
1330 int b_p_bin; /* 'binary' */
1331 #ifdef FEAT_MBYTE
1332 int b_p_bomb; /* 'bomb' */
1333 #endif
1334 #if defined(FEAT_QUICKFIX)
1335 char_u *b_p_bh; /* 'bufhidden' */
1336 char_u *b_p_bt; /* 'buftype' */
1337 #endif
1338 int b_p_bl; /* 'buflisted' */
1339 #ifdef FEAT_CINDENT
1340 int b_p_cin; /* 'cindent' */
1341 char_u *b_p_cino; /* 'cinoptions' */
1342 char_u *b_p_cink; /* 'cinkeys' */
1343 #endif
1344 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
1345 char_u *b_p_cinw; /* 'cinwords' */
1346 #endif
1347 #ifdef FEAT_COMMENTS
1348 char_u *b_p_com; /* 'comments' */
1349 #endif
1350 #ifdef FEAT_FOLDING
1351 char_u *b_p_cms; /* 'commentstring' */
1352 #endif
1353 #ifdef FEAT_INS_EXPAND
1354 char_u *b_p_cpt; /* 'complete' */
1355 #endif
1356 #ifdef FEAT_COMPL_FUNC
1357 char_u *b_p_cfu; /* 'completefunc' */
1358 char_u *b_p_ofu; /* 'omnifunc' */
1359 #endif
1360 int b_p_eol; /* 'endofline' */
1361 int b_p_et; /* 'expandtab' */
1362 int b_p_et_nobin; /* b_p_et saved for binary mode */
1363 #ifdef FEAT_MBYTE
1364 char_u *b_p_fenc; /* 'fileencoding' */
1365 #endif
1366 char_u *b_p_ff; /* 'fileformat' */
1367 #ifdef FEAT_AUTOCMD
1368 char_u *b_p_ft; /* 'filetype' */
1369 #endif
1370 char_u *b_p_fo; /* 'formatoptions' */
1371 char_u *b_p_flp; /* 'formatlistpat' */
1372 int b_p_inf; /* 'infercase' */
1373 char_u *b_p_isk; /* 'iskeyword' */
1374 #ifdef FEAT_FIND_ID
1375 char_u *b_p_def; /* 'define' local value */
1376 char_u *b_p_inc; /* 'include' */
1377 # ifdef FEAT_EVAL
1378 char_u *b_p_inex; /* 'includeexpr' */
1379 long_u b_p_inex_flags; /* flags for 'includeexpr' */
1380 # endif
1381 #endif
1382 #if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
1383 char_u *b_p_inde; /* 'indentexpr' */
1384 long_u b_p_inde_flags; /* flags for 'indentexpr' */
1385 char_u *b_p_indk; /* 'indentkeys' */
1386 #endif
1387 #if defined(FEAT_EVAL)
1388 char_u *b_p_fex; /* 'formatexpr' */
1389 long_u b_p_fex_flags; /* flags for 'formatexpr' */
1390 #endif
1391 #ifdef FEAT_CRYPT
1392 char_u *b_p_key; /* 'key' */
1393 #endif
1394 char_u *b_p_kp; /* 'keywordprg' */
1395 #ifdef FEAT_LISP
1396 int b_p_lisp; /* 'lisp' */
1397 #endif
1398 char_u *b_p_mps; /* 'matchpairs' */
1399 int b_p_ml; /* 'modeline' */
1400 int b_p_ml_nobin; /* b_p_ml saved for binary mode */
1401 int b_p_ma; /* 'modifiable' */
1402 char_u *b_p_nf; /* 'nrformats' */
1403 #ifdef FEAT_OSFILETYPE
1404 char_u *b_p_oft; /* 'osfiletype' */
1405 #endif
1406 int b_p_pi; /* 'preserveindent' */
1407 #ifdef FEAT_TEXTOBJ
1408 char_u *b_p_qe; /* 'quoteescape' */
1409 #endif
1410 int b_p_ro; /* 'readonly' */
1411 long b_p_sw; /* 'shiftwidth' */
1412 #ifndef SHORT_FNAME
1413 int b_p_sn; /* 'shortname' */
1414 #endif
1415 #ifdef FEAT_SMARTINDENT
1416 int b_p_si; /* 'smartindent' */
1417 #endif
1418 long b_p_sts; /* 'softtabstop' */
1419 long b_p_sts_nopaste; /* b_p_sts saved for paste mode */
1420 #ifdef FEAT_SEARCHPATH
1421 char_u *b_p_sua; /* 'suffixesadd' */
1422 #endif
1423 int b_p_swf; /* 'swapfile' */
1424 #ifdef FEAT_SYN_HL
1425 long b_p_smc; /* 'synmaxcol' */
1426 char_u *b_p_syn; /* 'syntax' */
1427 #endif
1428 #ifdef FEAT_SPELL
1429 char_u *b_p_spc; /* 'spellcapcheck' */
1430 regprog_T *b_cap_prog; /* program for 'spellcapcheck' */
1431 char_u *b_p_spf; /* 'spellfile' */
1432 char_u *b_p_spl; /* 'spelllang' */
1433 #endif
1434 long b_p_ts; /* 'tabstop' */
1435 int b_p_tx; /* 'textmode' */
1436 long b_p_tw; /* 'textwidth' */
1437 long b_p_tw_nobin; /* b_p_tw saved for binary mode */
1438 long b_p_tw_nopaste; /* b_p_tw saved for paste mode */
1439 long b_p_wm; /* 'wrapmargin' */
1440 long b_p_wm_nobin; /* b_p_wm saved for binary mode */
1441 long b_p_wm_nopaste; /* b_p_wm saved for paste mode */
1442 #ifdef FEAT_KEYMAP
1443 char_u *b_p_keymap; /* 'keymap' */
1444 #endif
1446 /* local values for options which are normally global */
1447 #ifdef FEAT_QUICKFIX
1448 char_u *b_p_gp; /* 'grepprg' local value */
1449 char_u *b_p_mp; /* 'makeprg' local value */
1450 char_u *b_p_efm; /* 'errorformat' local value */
1451 #endif
1452 char_u *b_p_ep; /* 'equalprg' local value */
1453 char_u *b_p_path; /* 'path' local value */
1454 int b_p_ar; /* 'autoread' local value */
1455 char_u *b_p_tags; /* 'tags' local value */
1456 #ifdef FEAT_INS_EXPAND
1457 char_u *b_p_dict; /* 'dictionary' local value */
1458 char_u *b_p_tsr; /* 'thesaurus' local value */
1459 #endif
1461 /* end of buffer options */
1463 int b_start_eol; /* last line had eol when it was read */
1464 int b_start_ffc; /* first char of 'ff' when edit started */
1465 #ifdef FEAT_MBYTE
1466 char_u *b_start_fenc; /* 'fileencoding' when edit started or NULL */
1467 int b_bad_char; /* "++bad=" argument when edit started or 0 */
1468 int b_start_bomb; /* 'bomb' when it was read */
1469 #endif
1471 #ifdef FEAT_EVAL
1472 dictitem_T b_bufvar; /* variable for "b:" Dictionary */
1473 dict_T b_vars; /* internal variables, local to buffer */
1474 #endif
1476 #if defined(FEAT_BEVAL) && defined(FEAT_EVAL)
1477 char_u *b_p_bexpr; /* 'balloonexpr' local value */
1478 long_u b_p_bexpr_flags;/* flags for 'balloonexpr' */
1479 #endif
1481 /* When a buffer is created, it starts without a swap file. b_may_swap is
1482 * then set to indicate that a swap file may be opened later. It is reset
1483 * if a swap file could not be opened.
1485 int b_may_swap;
1486 int b_did_warn; /* Set to 1 if user has been warned on first
1487 change of a read-only file */
1489 /* Two special kinds of buffers:
1490 * help buffer - used for help files, won't use a swap file.
1491 * spell buffer - used for spell info, never displayed and doesn't have a
1492 * file name.
1494 int b_help; /* TRUE for help file buffer (when set b_p_bt
1495 is "help") */
1496 #ifdef FEAT_SPELL
1497 int b_spell; /* TRUE for a spell file buffer, most fields
1498 are not used! Use the B_SPELL macro to
1499 access b_spell without #ifdef. */
1500 #endif
1502 #ifndef SHORT_FNAME
1503 int b_shortname; /* this file has an 8.3 file name */
1504 #endif
1506 #ifdef FEAT_MZSCHEME
1507 void *b_mzscheme_ref; /* The MzScheme reference to this buffer */
1508 #endif
1510 #ifdef FEAT_PERL
1511 void *b_perl_private;
1512 #endif
1514 #ifdef FEAT_PYTHON
1515 void *b_python_ref; /* The Python reference to this buffer */
1516 #endif
1518 #ifdef FEAT_TCL
1519 void *b_tcl_ref;
1520 #endif
1522 #ifdef FEAT_RUBY
1523 void *b_ruby_ref;
1524 #endif
1526 #ifdef FEAT_SYN_HL
1527 hashtab_T b_keywtab; /* syntax keywords hash table */
1528 hashtab_T b_keywtab_ic; /* idem, ignore case */
1529 int b_syn_error; /* TRUE when error occured in HL */
1530 int b_syn_ic; /* ignore case for :syn cmds */
1531 int b_syn_spell; /* SYNSPL_ values */
1532 garray_T b_syn_patterns; /* table for syntax patterns */
1533 garray_T b_syn_clusters; /* table for syntax clusters */
1534 int b_spell_cluster_id; /* @Spell cluster ID or 0 */
1535 int b_nospell_cluster_id; /* @NoSpell cluster ID or 0 */
1536 int b_syn_containedin; /* TRUE when there is an item with a
1537 "containedin" argument */
1538 int b_syn_sync_flags; /* flags about how to sync */
1539 short b_syn_sync_id; /* group to sync on */
1540 long b_syn_sync_minlines; /* minimal sync lines offset */
1541 long b_syn_sync_maxlines; /* maximal sync lines offset */
1542 long b_syn_sync_linebreaks; /* offset for multi-line pattern */
1543 char_u *b_syn_linecont_pat; /* line continuation pattern */
1544 regprog_T *b_syn_linecont_prog; /* line continuation program */
1545 int b_syn_linecont_ic; /* ignore-case flag for above */
1546 int b_syn_topgrp; /* for ":syntax include" */
1547 # ifdef FEAT_FOLDING
1548 int b_syn_folditems; /* number of patterns with the HL_FOLD
1549 flag set */
1550 # endif
1552 * b_sst_array[] contains the state stack for a number of lines, for the start
1553 * of that line (col == 0). This avoids having to recompute the syntax state
1554 * too often.
1555 * b_sst_array[] is allocated to hold the state for all displayed lines, and
1556 * states for 1 out of about 20 other lines.
1557 * b_sst_array pointer to an array of synstate_T
1558 * b_sst_len number of entries in b_sst_array[]
1559 * b_sst_first pointer to first used entry in b_sst_array[] or NULL
1560 * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL
1561 * b_sst_freecount number of free entries in b_sst_array[]
1562 * b_sst_check_lnum entries after this lnum need to be checked for
1563 * validity (MAXLNUM means no check needed)
1565 synstate_T *b_sst_array;
1566 int b_sst_len;
1567 synstate_T *b_sst_first;
1568 synstate_T *b_sst_firstfree;
1569 int b_sst_freecount;
1570 linenr_T b_sst_check_lnum;
1571 short_u b_sst_lasttick; /* last display tick */
1572 #endif /* FEAT_SYN_HL */
1574 #ifdef FEAT_SPELL
1575 /* for spell checking */
1576 garray_T b_langp; /* list of pointers to slang_T, see spell.c */
1577 char_u b_spell_ismw[256];/* flags: is midword char */
1578 # ifdef FEAT_MBYTE
1579 char_u *b_spell_ismw_mb; /* multi-byte midword chars */
1580 # endif
1581 #endif
1583 #ifdef FEAT_SIGNS
1584 signlist_T *b_signlist; /* list of signs to draw */
1585 #endif
1587 #ifdef FEAT_NETBEANS_INTG
1588 int b_netbeans_file; /* TRUE when buffer is owned by NetBeans */
1589 int b_was_netbeans_file;/* TRUE if b_netbeans_file was once set */
1590 #endif
1595 #ifdef FEAT_DIFF
1597 * Stuff for diff mode.
1599 # define DB_COUNT 4 /* up to four buffers can be diff'ed */
1602 * Each diffblock defines where a block of lines starts in each of the buffers
1603 * and how many lines it occupies in that buffer. When the lines are missing
1604 * in the buffer the df_count[] is zero. This is all counted in
1605 * buffer lines.
1606 * There is always at least one unchanged line in between the diffs.
1607 * Otherwise it would have been included in the diff above or below it.
1608 * df_lnum[] + df_count[] is the lnum below the change. When in one buffer
1609 * lines have been inserted, in the other buffer df_lnum[] is the line below
1610 * the insertion and df_count[] is zero. When appending lines at the end of
1611 * the buffer, df_lnum[] is one beyond the end!
1612 * This is using a linked list, because the number of differences is expected
1613 * to be reasonable small. The list is sorted on lnum.
1615 typedef struct diffblock_S diff_T;
1616 struct diffblock_S
1618 diff_T *df_next;
1619 linenr_T df_lnum[DB_COUNT]; /* line number in buffer */
1620 linenr_T df_count[DB_COUNT]; /* nr of inserted/changed lines */
1622 #endif
1624 #define SNAP_HELP_IDX 0
1625 #ifdef FEAT_AUTOCMD
1626 # define SNAP_AUCMD_IDX 1
1627 # define SNAP_COUNT 2
1628 #else
1629 # define SNAP_COUNT 1
1630 #endif
1633 * Tab pages point to the top frame of each tab page.
1634 * Note: Most values are NOT valid for the current tab page! Use "curwin",
1635 * "firstwin", etc. for that. "tp_topframe" is always valid and can be
1636 * compared against "topframe" to find the current tab page.
1638 typedef struct tabpage_S tabpage_T;
1639 struct tabpage_S
1641 tabpage_T *tp_next; /* next tabpage or NULL */
1642 frame_T *tp_topframe; /* topframe for the windows */
1643 win_T *tp_curwin; /* current window in this Tab page */
1644 win_T *tp_prevwin; /* previous window in this Tab page */
1645 win_T *tp_firstwin; /* first window in this Tab page */
1646 win_T *tp_lastwin; /* last window in this Tab page */
1647 long tp_old_Rows; /* Rows when Tab page was left */
1648 long tp_old_Columns; /* Columns when Tab page was left */
1649 long tp_ch_used; /* value of 'cmdheight' when frame size
1650 was set */
1651 #ifdef FEAT_GUI
1652 int tp_prev_which_scrollbars[3];
1653 /* previous value of which_scrollbars */
1654 #endif
1655 #ifdef FEAT_DIFF
1656 diff_T *tp_first_diff;
1657 buf_T *(tp_diffbuf[DB_COUNT]);
1658 int tp_diff_invalid; /* list of diffs is outdated */
1659 #endif
1660 frame_T *(tp_snapshot[SNAP_COUNT]); /* window layout snapshots */
1661 #ifdef FEAT_EVAL
1662 dictitem_T tp_winvar; /* variable for "t:" Dictionary */
1663 dict_T tp_vars; /* internal variables, local to tab page */
1664 #endif
1668 * Structure to cache info for displayed lines in w_lines[].
1669 * Each logical line has one entry.
1670 * The entry tells how the logical line is currently displayed in the window.
1671 * This is updated when displaying the window.
1672 * When the display is changed (e.g., when clearing the screen) w_lines_valid
1673 * is changed to exclude invalid entries.
1674 * When making changes to the buffer, wl_valid is reset to indicate wl_size
1675 * may not reflect what is actually in the buffer. When wl_valid is FALSE,
1676 * the entries can only be used to count the number of displayed lines used.
1677 * wl_lnum and wl_lastlnum are invalid too.
1679 typedef struct w_line
1681 linenr_T wl_lnum; /* buffer line number for logical line */
1682 short_u wl_size; /* height in screen lines */
1683 char wl_valid; /* TRUE values are valid for text in buffer */
1684 #ifdef FEAT_FOLDING
1685 char wl_folded; /* TRUE when this is a range of folded lines */
1686 linenr_T wl_lastlnum; /* last buffer line number for logical line */
1687 #endif
1688 } wline_T;
1691 * Windows are kept in a tree of frames. Each frame has a column (FR_COL)
1692 * or row (FR_ROW) layout or is a leaf, which has a window.
1694 struct frame_S
1696 char fr_layout; /* FR_LEAF, FR_COL or FR_ROW */
1697 #ifdef FEAT_VERTSPLIT
1698 int fr_width;
1699 int fr_newwidth; /* new width used in win_equal_rec() */
1700 #endif
1701 int fr_height;
1702 int fr_newheight; /* new height used in win_equal_rec() */
1703 frame_T *fr_parent; /* containing frame or NULL */
1704 frame_T *fr_next; /* frame right or below in same parent, NULL
1705 for first */
1706 frame_T *fr_prev; /* frame left or above in same parent, NULL
1707 for last */
1708 /* fr_child and fr_win are mutually exclusive */
1709 frame_T *fr_child; /* first contained frame */
1710 win_T *fr_win; /* window that fills this frame */
1713 #define FR_LEAF 0 /* frame is a leaf */
1714 #define FR_ROW 1 /* frame with a row of windows */
1715 #define FR_COL 2 /* frame with a column of windows */
1718 * Struct used for highlighting 'hlsearch' matches, matches defined by
1719 * ":match" and matches defined by match functions.
1720 * For 'hlsearch' there is one pattern for all windows. For ":match" and the
1721 * match functions there is a different pattern for each window.
1723 typedef struct
1725 regmmatch_T rm; /* points to the regexp program; contains last found
1726 match (may continue in next line) */
1727 buf_T *buf; /* the buffer to search for a match */
1728 linenr_T lnum; /* the line to search for a match */
1729 int attr; /* attributes to be used for a match */
1730 int attr_cur; /* attributes currently active in win_line() */
1731 linenr_T first_lnum; /* first lnum to search for multi-line pat */
1732 colnr_T startcol; /* in win_line() points to char where HL starts */
1733 colnr_T endcol; /* in win_line() points to char where HL ends */
1734 #ifdef FEAT_RELTIME
1735 proftime_T tm; /* for a time limit */
1736 #endif
1737 } match_T;
1740 * matchitem_T provides a linked list for storing match items for ":match" and
1741 * the match functions.
1743 typedef struct matchitem matchitem_T;
1744 struct matchitem
1746 matchitem_T *next;
1747 int id; /* match ID */
1748 int priority; /* match priority */
1749 char_u *pattern; /* pattern to highlight */
1750 int hlg_id; /* highlight group ID */
1751 regmmatch_T match; /* regexp program for pattern */
1752 match_T hl; /* struct for doing the actual highlighting */
1756 * Structure which contains all information that belongs to a window
1758 * All row numbers are relative to the start of the window, except w_winrow.
1760 struct window_S
1762 buf_T *w_buffer; /* buffer we are a window into (used
1763 often, keep it the first item!) */
1765 #ifdef FEAT_WINDOWS
1766 win_T *w_prev; /* link to previous window */
1767 win_T *w_next; /* link to next window */
1768 #endif
1770 frame_T *w_frame; /* frame containing this window */
1772 pos_T w_cursor; /* cursor position in buffer */
1774 colnr_T w_curswant; /* The column we'd like to be at. This is
1775 used to try to stay in the same column
1776 for up/down cursor motions. */
1778 int w_set_curswant; /* If set, then update w_curswant the next
1779 time through cursupdate() to the
1780 current virtual column */
1782 #ifdef FEAT_VISUAL
1784 * the next six are used to update the visual part
1786 char w_old_visual_mode; /* last known VIsual_mode */
1787 linenr_T w_old_cursor_lnum; /* last known end of visual part */
1788 colnr_T w_old_cursor_fcol; /* first column for block visual part */
1789 colnr_T w_old_cursor_lcol; /* last column for block visual part */
1790 linenr_T w_old_visual_lnum; /* last known start of visual part */
1791 colnr_T w_old_visual_col; /* last known start of visual part */
1792 colnr_T w_old_curswant; /* last known value of Curswant */
1793 #endif
1796 * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for
1797 * displaying the buffer.
1799 linenr_T w_topline; /* buffer line number of the line at the
1800 top of the window */
1801 #ifdef FEAT_AUTOCMD
1802 char w_topline_was_set; /* flag set to TRUE when topline is set,
1803 e.g. by winrestview() */
1804 #endif
1805 #ifdef FEAT_DIFF
1806 int w_topfill; /* number of filler lines above w_topline */
1807 int w_old_topfill; /* w_topfill at last redraw */
1808 int w_botfill; /* TRUE when filler lines are actually
1809 below w_topline (at end of file) */
1810 int w_old_botfill; /* w_botfill at last redraw */
1811 #endif
1812 colnr_T w_leftcol; /* window column number of the left most
1813 character in the window; used when
1814 'wrap' is off */
1815 colnr_T w_skipcol; /* starting column when a single line
1816 doesn't fit in the window */
1819 * Layout of the window in the screen.
1820 * May need to add "msg_scrolled" to "w_winrow" in rare situations.
1822 #ifdef FEAT_WINDOWS
1823 int w_winrow; /* first row of window in screen */
1824 #endif
1825 int w_height; /* number of rows in window, excluding
1826 status/command line(s) */
1827 #ifdef FEAT_WINDOWS
1828 int w_status_height; /* number of status lines (0 or 1) */
1829 #endif
1830 #ifdef FEAT_VERTSPLIT
1831 int w_wincol; /* Leftmost column of window in screen.
1832 use W_WINCOL() */
1833 int w_width; /* Width of window, excluding separation.
1834 use W_WIDTH() */
1835 int w_vsep_width; /* Number of separator columns (0 or 1).
1836 use W_VSEP_WIDTH() */
1837 #endif
1840 * === start of cached values ====
1843 * Recomputing is minimized by storing the result of computations.
1844 * Use functions in screen.c to check if they are valid and to update.
1845 * w_valid is a bitfield of flags, which indicate if specific values are
1846 * valid or need to be recomputed. See screen.c for values.
1848 int w_valid;
1849 pos_T w_valid_cursor; /* last known position of w_cursor, used
1850 to adjust w_valid */
1851 colnr_T w_valid_leftcol; /* last known w_leftcol */
1854 * w_cline_height is the number of physical lines taken by the buffer line
1855 * that the cursor is on. We use this to avoid extra calls to plines().
1857 int w_cline_height; /* current size of cursor line */
1858 #ifdef FEAT_FOLDING
1859 int w_cline_folded; /* cursor line is folded */
1860 #endif
1862 int w_cline_row; /* starting row of the cursor line */
1864 colnr_T w_virtcol; /* column number of the cursor in the
1865 buffer line, as opposed to the column
1866 number we're at on the screen. This
1867 makes a difference on lines which span
1868 more than one screen line or when
1869 w_leftcol is non-zero */
1872 * w_wrow and w_wcol specify the cursor position in the window.
1873 * This is related to positions in the window, not in the display or
1874 * buffer, thus w_wrow is relative to w_winrow.
1876 int w_wrow, w_wcol; /* cursor position in window */
1878 linenr_T w_botline; /* number of the line below the bottom of
1879 the screen */
1880 int w_empty_rows; /* number of ~ rows in window */
1881 #ifdef FEAT_DIFF
1882 int w_filler_rows; /* number of filler rows at the end of the
1883 window */
1884 #endif
1887 * Info about the lines currently in the window is remembered to avoid
1888 * recomputing it every time. The allocated size of w_lines[] is Rows.
1889 * Only the w_lines_valid entries are actually valid.
1890 * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
1891 * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
1892 * Between changing text and updating the display w_lines[] represents
1893 * what is currently displayed. wl_valid is reset to indicated this.
1894 * This is used for efficient redrawing.
1896 int w_lines_valid; /* number of valid entries */
1897 wline_T *w_lines;
1899 #ifdef FEAT_FOLDING
1900 garray_T w_folds; /* array of nested folds */
1901 char w_fold_manual; /* when TRUE: some folds are opened/closed
1902 manually */
1903 char w_foldinvalid; /* when TRUE: folding needs to be
1904 recomputed */
1905 #endif
1906 #ifdef FEAT_LINEBREAK
1907 int w_nrwidth; /* width of 'number' column being used */
1908 #endif
1911 * === end of cached values ===
1914 int w_redr_type; /* type of redraw to be performed on win */
1915 int w_upd_rows; /* number of window lines to update when
1916 w_redr_type is REDRAW_TOP */
1917 linenr_T w_redraw_top; /* when != 0: first line needing redraw */
1918 linenr_T w_redraw_bot; /* when != 0: last line needing redraw */
1919 #ifdef FEAT_WINDOWS
1920 int w_redr_status; /* if TRUE status line must be redrawn */
1921 #endif
1923 #ifdef FEAT_CMDL_INFO
1924 /* remember what is shown in the ruler for this window (if 'ruler' set) */
1925 pos_T w_ru_cursor; /* cursor position shown in ruler */
1926 colnr_T w_ru_virtcol; /* virtcol shown in ruler */
1927 linenr_T w_ru_topline; /* topline shown in ruler */
1928 linenr_T w_ru_line_count; /* line count used for ruler */
1929 # ifdef FEAT_DIFF
1930 int w_ru_topfill; /* topfill shown in ruler */
1931 # endif
1932 char w_ru_empty; /* TRUE if ruler shows 0-1 (empty line) */
1933 #endif
1935 int w_alt_fnum; /* alternate file (for # and CTRL-^) */
1937 #ifdef FEAT_WINDOWS
1938 alist_T *w_alist; /* pointer to arglist for this window */
1939 #endif
1940 int w_arg_idx; /* current index in argument list (can be
1941 out of range!) */
1942 int w_arg_idx_invalid; /* editing another file than w_arg_idx */
1944 char_u *w_localdir; /* absolute path of local directory or
1945 NULL */
1947 * Options local to a window.
1948 * They are local because they influence the layout of the window or
1949 * depend on the window layout.
1950 * There are two values: w_onebuf_opt is local to the buffer currently in
1951 * this window, w_allbuf_opt is for all buffers in this window.
1953 winopt_T w_onebuf_opt;
1954 winopt_T w_allbuf_opt;
1956 /* A few options have local flags for P_INSECURE. */
1957 #ifdef FEAT_STL_OPT
1958 long_u w_p_stl_flags; /* flags for 'statusline' */
1959 #endif
1960 #ifdef FEAT_EVAL
1961 long_u w_p_fde_flags; /* flags for 'foldexpr' */
1962 long_u w_p_fdt_flags; /* flags for 'foldtext' */
1963 #endif
1965 /* transform a pointer to a "onebuf" option into a "allbuf" option */
1966 #define GLOBAL_WO(p) ((char *)p + sizeof(winopt_T))
1968 #ifdef FEAT_SCROLLBIND
1969 long w_scbind_pos;
1970 #endif
1972 #ifdef FEAT_EVAL
1973 dictitem_T w_winvar; /* variable for "w:" Dictionary */
1974 dict_T w_vars; /* internal variables, local to window */
1975 #endif
1977 #if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
1978 int w_farsi; /* for the window dependent Farsi functions */
1979 #endif
1982 * The w_prev_pcmark field is used to check whether we really did jump to
1983 * a new line after setting the w_pcmark. If not, then we revert to
1984 * using the previous w_pcmark.
1986 pos_T w_pcmark; /* previous context mark */
1987 pos_T w_prev_pcmark; /* previous w_pcmark */
1989 #ifdef FEAT_JUMPLIST
1991 * the jumplist contains old cursor positions
1993 xfmark_T w_jumplist[JUMPLISTSIZE];
1994 int w_jumplistlen; /* number of active entries */
1995 int w_jumplistidx; /* current position */
1997 int w_changelistidx; /* current position in b_changelist */
1998 #endif
2000 #ifdef FEAT_SEARCH_EXTRA
2001 matchitem_T *w_match_head; /* head of match list */
2002 int w_next_match_id; /* next match ID */
2003 #endif
2006 * the tagstack grows from 0 upwards:
2007 * entry 0: older
2008 * entry 1: newer
2009 * entry 2: newest
2011 taggy_T w_tagstack[TAGSTACKSIZE]; /* the tag stack */
2012 int w_tagstackidx; /* idx just below active entry */
2013 int w_tagstacklen; /* number of tags on stack */
2016 * w_fraction is the fractional row of the cursor within the window, from
2017 * 0 at the top row to FRACTION_MULT at the last row.
2018 * w_prev_fraction_row was the actual cursor row when w_fraction was last
2019 * calculated.
2021 int w_fraction;
2022 int w_prev_fraction_row;
2024 #ifdef FEAT_GUI
2025 scrollbar_T w_scrollbars[2]; /* vert. Scrollbars for this window */
2026 #endif
2027 #ifdef FEAT_LINEBREAK
2028 linenr_T w_nrwidth_line_count; /* line count when ml_nrwidth_width
2029 * was computed. */
2030 int w_nrwidth_width; /* nr of chars to print line count. */
2031 #endif
2033 #ifdef FEAT_QUICKFIX
2034 qf_info_T *w_llist; /* Location list for this window */
2036 * Location list reference used in the location list window.
2037 * In a non-location list window, w_llist_ref is NULL.
2039 qf_info_T *w_llist_ref;
2040 #endif
2043 #ifdef FEAT_MZSCHEME
2044 void *w_mzscheme_ref; /* The MzScheme value for this window */
2045 #endif
2047 #ifdef FEAT_PERL
2048 void *w_perl_private;
2049 #endif
2051 #ifdef FEAT_PYTHON
2052 void *w_python_ref; /* The Python value for this window */
2053 #endif
2055 #ifdef FEAT_TCL
2056 void *w_tcl_ref;
2057 #endif
2059 #ifdef FEAT_RUBY
2060 void *w_ruby_ref;
2061 #endif
2065 * Arguments for operators.
2067 typedef struct oparg_S
2069 int op_type; /* current pending operator type */
2070 int regname; /* register to use for the operator */
2071 int motion_type; /* type of the current cursor motion */
2072 int motion_force; /* force motion type: 'v', 'V' or CTRL-V */
2073 int use_reg_one; /* TRUE if delete uses reg 1 even when not
2074 linewise */
2075 int inclusive; /* TRUE if char motion is inclusive (only
2076 valid when motion_type is MCHAR */
2077 int end_adjusted; /* backuped b_op_end one char (only used by
2078 do_format()) */
2079 pos_T start; /* start of the operator */
2080 pos_T end; /* end of the operator */
2081 pos_T cursor_start; /* cursor position before motion for "gw" */
2083 long line_count; /* number of lines from op_start to op_end
2084 (inclusive) */
2085 int empty; /* op_start and op_end the same (only used by
2086 do_change()) */
2087 #ifdef FEAT_VISUAL
2088 int is_VIsual; /* operator on Visual area */
2089 int block_mode; /* current operator is Visual block mode */
2090 #endif
2091 colnr_T start_vcol; /* start col for block mode operator */
2092 colnr_T end_vcol; /* end col for block mode operator */
2093 #ifdef FEAT_AUTOCMD
2094 long prev_opcount; /* ca.opcount saved for K_CURSORHOLD */
2095 long prev_count0; /* ca.count0 saved for K_CURSORHOLD */
2096 #endif
2097 } oparg_T;
2100 * Arguments for Normal mode commands.
2102 typedef struct cmdarg_S
2104 oparg_T *oap; /* Operator arguments */
2105 int prechar; /* prefix character (optional, always 'g') */
2106 int cmdchar; /* command character */
2107 int nchar; /* next command character (optional) */
2108 #ifdef FEAT_MBYTE
2109 int ncharC1; /* first composing character (optional) */
2110 int ncharC2; /* second composing character (optional) */
2111 #endif
2112 int extra_char; /* yet another character (optional) */
2113 long opcount; /* count before an operator */
2114 long count0; /* count before command, default 0 */
2115 long count1; /* count before command, default 1 */
2116 int arg; /* extra argument from nv_cmds[] */
2117 int retval; /* return: CA_* values */
2118 char_u *searchbuf; /* return: pointer to search pattern or NULL */
2119 } cmdarg_T;
2121 /* values for retval: */
2122 #define CA_COMMAND_BUSY 1 /* skip restarting edit() once */
2123 #define CA_NO_ADJ_OP_END 2 /* don't adjust operator end */
2125 #ifdef CURSOR_SHAPE
2127 * struct to store values from 'guicursor' and 'mouseshape'
2129 /* Indexes in shape_table[] */
2130 #define SHAPE_IDX_N 0 /* Normal mode */
2131 #define SHAPE_IDX_V 1 /* Visual mode */
2132 #define SHAPE_IDX_I 2 /* Insert mode */
2133 #define SHAPE_IDX_R 3 /* Replace mode */
2134 #define SHAPE_IDX_C 4 /* Command line Normal mode */
2135 #define SHAPE_IDX_CI 5 /* Command line Insert mode */
2136 #define SHAPE_IDX_CR 6 /* Command line Replace mode */
2137 #define SHAPE_IDX_O 7 /* Operator-pending mode */
2138 #define SHAPE_IDX_VE 8 /* Visual mode with 'seleciton' exclusive */
2139 #define SHAPE_IDX_CLINE 9 /* On command line */
2140 #define SHAPE_IDX_STATUS 10 /* A status line */
2141 #define SHAPE_IDX_SDRAG 11 /* dragging a status line */
2142 #define SHAPE_IDX_VSEP 12 /* A vertical separator line */
2143 #define SHAPE_IDX_VDRAG 13 /* dragging a vertical separator line */
2144 #define SHAPE_IDX_MORE 14 /* Hit-return or More */
2145 #define SHAPE_IDX_MOREL 15 /* Hit-return or More in last line */
2146 #define SHAPE_IDX_SM 16 /* showing matching paren */
2147 #define SHAPE_IDX_COUNT 17
2149 #define SHAPE_BLOCK 0 /* block cursor */
2150 #define SHAPE_HOR 1 /* horizontal bar cursor */
2151 #define SHAPE_VER 2 /* vertical bar cursor */
2153 #define MSHAPE_NUMBERED 1000 /* offset for shapes identified by number */
2154 #define MSHAPE_HIDE 1 /* hide mouse pointer */
2156 #define SHAPE_MOUSE 1 /* used for mouse pointer shape */
2157 #define SHAPE_CURSOR 2 /* used for text cursor shape */
2159 typedef struct cursor_entry
2161 int shape; /* one of the SHAPE_ defines */
2162 int mshape; /* one of the MSHAPE defines */
2163 int percentage; /* percentage of cell for bar */
2164 long blinkwait; /* blinking, wait time before blinking starts */
2165 long blinkon; /* blinking, on time */
2166 long blinkoff; /* blinking, off time */
2167 int id; /* highlight group ID */
2168 int id_lm; /* highlight group ID for :lmap mode */
2169 char *name; /* mode name (fixed) */
2170 char used_for; /* SHAPE_MOUSE and/or SHAPE_CURSOR */
2171 } cursorentry_T;
2172 #endif /* CURSOR_SHAPE */
2174 #ifdef FEAT_MENU
2176 /* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
2177 #define MENU_INDEX_INVALID -1
2178 #define MENU_INDEX_NORMAL 0
2179 #define MENU_INDEX_VISUAL 1
2180 #define MENU_INDEX_SELECT 2
2181 #define MENU_INDEX_OP_PENDING 3
2182 #define MENU_INDEX_INSERT 4
2183 #define MENU_INDEX_CMDLINE 5
2184 #define MENU_INDEX_TIP 6
2185 #define MENU_MODES 7
2187 /* Menu modes */
2188 #define MENU_NORMAL_MODE (1 << MENU_INDEX_NORMAL)
2189 #define MENU_VISUAL_MODE (1 << MENU_INDEX_VISUAL)
2190 #define MENU_SELECT_MODE (1 << MENU_INDEX_SELECT)
2191 #define MENU_OP_PENDING_MODE (1 << MENU_INDEX_OP_PENDING)
2192 #define MENU_INSERT_MODE (1 << MENU_INDEX_INSERT)
2193 #define MENU_CMDLINE_MODE (1 << MENU_INDEX_CMDLINE)
2194 #define MENU_TIP_MODE (1 << MENU_INDEX_TIP)
2195 #define MENU_ALL_MODES ((1 << MENU_INDEX_TIP) - 1)
2196 /*note MENU_INDEX_TIP is not a 'real' mode*/
2198 /* Start a menu name with this to not include it on the main menu bar */
2199 #define MNU_HIDDEN_CHAR ']'
2201 typedef struct VimMenu vimmenu_T;
2203 struct VimMenu
2205 int modes; /* Which modes is this menu visible for? */
2206 int enabled; /* for which modes the menu is enabled */
2207 char_u *name; /* Name of menu */
2208 char_u *dname; /* Displayed Name (without '&') */
2209 int mnemonic; /* mnemonic key (after '&') */
2210 char_u *actext; /* accelerator text (after TAB) */
2211 int priority; /* Menu order priority */
2212 #ifdef FEAT_GUI
2213 void (*cb) __ARGS((vimmenu_T *)); /* Call-back routine */
2214 #endif
2215 #ifdef FEAT_TOOLBAR
2216 char_u *iconfile; /* name of file for icon or NULL */
2217 int iconidx; /* icon index (-1 if not set) */
2218 int icon_builtin; /* icon names is BuiltIn{nr} */
2219 #endif
2220 char_u *strings[MENU_MODES]; /* Mapped string for each mode */
2221 int noremap[MENU_MODES]; /* A REMAP_ flag for each mode */
2222 char silent[MENU_MODES]; /* A silent flag for each mode */
2223 vimmenu_T *children; /* Children of sub-menu */
2224 vimmenu_T *parent; /* Parent of menu */
2225 vimmenu_T *next; /* Next item in menu */
2226 #ifdef FEAT_GUI_X11
2227 Widget id; /* Manage this to enable item */
2228 Widget submenu_id; /* If this is submenu, add children here */
2229 #endif
2230 #ifdef FEAT_GUI_GTK
2231 GtkWidget *id; /* Manage this to enable item */
2232 GtkWidget *submenu_id; /* If this is submenu, add children here */
2233 GtkWidget *tearoff_handle;
2234 GtkWidget *label; /* Used by "set wak=" code. */
2235 #endif
2236 #ifdef FEAT_GUI_MOTIF
2237 int sensitive; /* turn button on/off */
2238 char **xpm; /* pixmap data */
2239 char *xpm_fname; /* file with pixmap data */
2240 #endif
2241 #ifdef FEAT_GUI_ATHENA
2242 Pixmap image; /* Toolbar image */
2243 #endif
2244 #ifdef FEAT_BEVAL_TIP
2245 BalloonEval *tip; /* tooltip for this menu item */
2246 #endif
2247 #ifdef FEAT_GUI_W16
2248 UINT id; /* Id of menu item */
2249 HMENU submenu_id; /* If this is submenu, add children here */
2250 #endif
2251 #ifdef FEAT_GUI_W32
2252 UINT id; /* Id of menu item */
2253 HMENU submenu_id; /* If this is submenu, add children here */
2254 HWND tearoff_handle; /* hWnd of tearoff if created */
2255 #endif
2256 #ifdef FEAT_GUI_MAC
2257 /* MenuHandle id; */
2258 /* short index; */ /* the item index within the father menu */
2259 short menu_id; /* the menu id to which this item belong */
2260 short submenu_id; /* the menu id of the children (could be
2261 get throught some tricks) */
2262 MenuHandle menu_handle;
2263 MenuHandle submenu_handle;
2264 #endif
2265 #ifdef RISCOS
2266 int *id; /* Not used, but gui.c needs it */
2267 int greyed_out; /* Flag */
2268 int hidden;
2269 #endif
2270 #ifdef FEAT_GUI_PHOTON
2271 PtWidget_t *id;
2272 PtWidget_t *submenu_id;
2273 #endif
2275 #else
2276 /* For generating prototypes when FEAT_MENU isn't defined. */
2277 typedef int vimmenu_T;
2279 #endif /* FEAT_MENU */
2282 * Struct to save values in before executing autocommands for a buffer that is
2283 * not the current buffer. Without FEAT_AUTOCMD only "curbuf" is remembered.
2285 typedef struct
2287 buf_T *save_curbuf; /* saved curbuf */
2288 #ifdef FEAT_AUTOCMD
2289 win_T *save_curwin; /* saved curwin */
2290 win_T *new_curwin; /* new curwin */
2291 buf_T *new_curbuf; /* new curbuf */
2292 #endif
2293 } aco_save_T;
2296 * Generic option table item, only used for printer at the moment.
2298 typedef struct
2300 const char *name;
2301 int hasnum;
2302 long number;
2303 char_u *string; /* points into option string */
2304 int strlen;
2305 int present;
2306 } option_table_T;
2309 * Structure to hold printing color and font attributes.
2311 typedef struct
2313 long_u fg_color;
2314 long_u bg_color;
2315 int bold;
2316 int italic;
2317 int underline;
2318 int undercurl;
2319 } prt_text_attr_T;
2322 * Structure passed back to the generic printer code.
2324 typedef struct
2326 int n_collated_copies;
2327 int n_uncollated_copies;
2328 int duplex;
2329 int chars_per_line;
2330 int lines_per_page;
2331 int has_color;
2332 prt_text_attr_T number;
2333 #ifdef FEAT_SYN_HL
2334 int modec;
2335 int do_syntax;
2336 #endif
2337 int user_abort;
2338 char_u *jobname;
2339 #ifdef FEAT_POSTSCRIPT
2340 char_u *outfile;
2341 char_u *arguments;
2342 #endif
2343 } prt_settings_T;
2345 #define PRINT_NUMBER_WIDTH 8
2348 * Used for popup menu items.
2350 typedef struct
2352 char_u *pum_text; /* main menu text */
2353 char_u *pum_kind; /* extra kind text (may be truncated) */
2354 char_u *pum_extra; /* extra menu text (may be truncated) */
2355 char_u *pum_info; /* extra info */
2356 } pumitem_T;
2359 * Structure used for get_tagfname().
2361 typedef struct
2363 char_u *tn_tags; /* value of 'tags' when starting */
2364 char_u *tn_np; /* current position in tn_tags */
2365 int tn_did_filefind_init;
2366 int tn_hf_idx;
2367 void *tn_search_ctx;
2368 } tagname_T;
2371 * Array indexes used for cptext argument of ins_compl_add().
2373 #define CPT_ABBR 0 /* "abbr" */
2374 #define CPT_MENU 1 /* "menu" */
2375 #define CPT_KIND 2 /* "kind" */
2376 #define CPT_INFO 3 /* "info" */
2377 #define CPT_COUNT 4 /* Number of entries */