xref: /vim-8.2.3635/src/structs.h (revision 592e0a2a)
1 /* vi:set ts=8 sts=4 sw=4:
2  *
3  * VIM - Vi IMproved	by Bram Moolenaar
4  *
5  * Do ":help uganda"  in Vim to read copying and usage conditions.
6  * Do ":help credits" in Vim to see a list of people who contributed.
7  */
8 
9 /*
10  * This file contains various definitions of structures that are used by Vim
11  */
12 
13 /*
14  * There is something wrong in the SAS compiler that makes typedefs not
15  * valid in include files.  Has been fixed in version 6.58.
16  */
17 #if defined(SASC) && SASC < 658
18 typedef long		linenr_T;
19 typedef unsigned	colnr_T;
20 typedef unsigned short	short_u;
21 #endif
22 
23 /*
24  * position in file or buffer
25  */
26 typedef struct
27 {
28     linenr_T	lnum;	/* line number */
29     colnr_T	col;	/* column number */
30 #ifdef FEAT_VIRTUALEDIT
31     colnr_T	coladd;
32 #endif
33 } pos_T;
34 
35 #ifdef FEAT_VIRTUALEDIT
36 # define INIT_POS_T {0, 0, 0}
37 #else
38 # define INIT_POS_T {0, 0}
39 #endif
40 
41 /*
42  * Same, but without coladd.
43  */
44 typedef struct
45 {
46     linenr_T	lnum;	/* line number */
47     colnr_T	col;	/* column number */
48 } lpos_T;
49 
50 /*
51  * Structure used for growing arrays.
52  * This is used to store information that only grows, is deleted all at
53  * once, and needs to be accessed by index.  See ga_clear() and ga_grow().
54  */
55 typedef struct growarray
56 {
57     int	    ga_len;		    /* current number of items used */
58     int	    ga_room;		    /* number of unused items at the end */
59     int	    ga_itemsize;	    /* sizeof(item) */
60     int	    ga_growsize;	    /* number of items to grow each time */
61     void    *ga_data;		    /* pointer to the first item */
62 } garray_T;
63 
64 #define GA_EMPTY    {0, 0, 0, 0, NULL}
65 
66 /*
67  * This is here because regexp.h needs pos_T and below regprog_T is used.
68  */
69 #include "regexp.h"
70 
71 typedef struct window	win_T;
72 typedef struct wininfo	wininfo_T;
73 typedef struct frame	frame_T;
74 typedef int		scid_T;		/* script ID */
75 
76 /*
77  * This is here because gui.h needs the pos_T and win_T, and win_T needs gui.h
78  * for scrollbar_T.
79  */
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
88 
89 /*
90  * marks: positions in a file
91  * (a normal mark is a lnum/col pair, the same as a file position)
92  */
93 
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 */
100 
101 typedef struct filemark
102 {
103     pos_T	mark;		/* cursor position */
104     int		fnum;		/* file number */
105 } fmark_T;
106 
107 /* Xtended file mark: also has a file name */
108 typedef struct xfilemark
109 {
110     fmark_T	fmark;
111     char_u	*fname;		/* file name, used when fnum == 0 */
112 } xfmark_T;
113 
114 /*
115  * The taggy struct is used to store the information about a :tag command.
116  */
117 typedef struct taggy
118 {
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;
124 
125 /*
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.
129  */
130 typedef struct
131 {
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	/* 'foldnextmax' */
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 #endif
180 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
181     int		wo_pvw;
182 # define w_p_pvw w_onebuf_opt.wo_pvw	/* 'previewwindow' */
183 #endif
184 #ifdef FEAT_RIGHTLEFT
185     int		wo_rl;
186 # define w_p_rl w_onebuf_opt.wo_rl	/* 'rightleft' */
187     char_u	*wo_rlc;
188 # define w_p_rlc w_onebuf_opt.wo_rlc	/* 'rightleftcmd' */
189 #endif
190     long	wo_scr;
191 #define w_p_scr w_onebuf_opt.wo_scr	/* 'scroll' */
192 #ifdef FEAT_SCROLLBIND
193     int		wo_scb;
194 # define w_p_scb w_onebuf_opt.wo_scb	/* 'scrollbind' */
195 #endif
196     int		wo_wrap;
197 #define w_p_wrap w_onebuf_opt.wo_wrap	/* 'wrap' */
198 } winopt_T;
199 
200 /*
201  * Window info stored with a buffer.
202  *
203  * Two types of info are kept for a buffer which are associated with a
204  * specific window:
205  * 1. Each window can have a different line number associated with a buffer.
206  * 2. The window-local options for a buffer work in a similar way.
207  * The window-info is kept in a list at b_wininfo.  It is kept in
208  * most-recently-used order.
209  */
210 struct wininfo
211 {
212     wininfo_T	*wi_next;	/* next entry or NULL for last entry */
213     wininfo_T	*wi_prev;	/* previous entry or NULL for first entry */
214     win_T	*wi_win;	/* pointer to window that did set wi_lnum */
215     pos_T	wi_fpos;	/* last cursor position in the file */
216     int		wi_optset;	/* TRUE when wi_opt has useful values */
217     winopt_T	wi_opt;		/* local window options */
218 #ifdef FEAT_FOLDING
219     int		wi_fold_manual;	/* copy of w_fold_manual */
220     garray_T	wi_folds;	/* clone of w_folds */
221 #endif
222 };
223 
224 /*
225  * Info used to pass info about a fold from the fold-detection code to the
226  * code that displays the foldcolumn.
227  */
228 typedef struct foldinfo
229 {
230     int		fi_level;	/* level of the fold; when this is zero the
231 				   other fields are invalid */
232     int		fi_lnum;	/* line number where fold starts */
233     int		fi_low_level;	/* lowest fold level that starts in the same
234 				   line */
235 } foldinfo_T;
236 
237 /*
238  * stuctures used for undo
239  */
240 
241 typedef struct u_entry u_entry_T;
242 typedef struct u_header u_header_T;
243 struct u_entry
244 {
245     u_entry_T	*ue_next;	/* pointer to next entry in list */
246     linenr_T	ue_top;		/* number of line above undo block */
247     linenr_T	ue_bot;		/* number of line below undo block */
248     linenr_T	ue_lcount;	/* linecount when u_save called */
249     char_u	**ue_array;	/* array of lines in undo block */
250     long	ue_size;	/* number of lines in ue_array */
251 };
252 
253 struct u_header
254 {
255     u_header_T	*uh_next;	/* pointer to next header in list */
256     u_header_T	*uh_prev;	/* pointer to previous header in list */
257     u_entry_T	*uh_entry;	/* pointer to first entry */
258     u_entry_T	*uh_getbot_entry; /* pointer to where ue_bot must be set */
259     pos_T	uh_cursor;	/* cursor position before saving */
260 #ifdef FEAT_VIRTUALEDIT
261     long	uh_cursor_vcol;
262 #endif
263     int		uh_flags;	/* see below */
264     pos_T	uh_namedm[NMARKS];	/* marks before undo/after redo */
265 };
266 
267 /* values for uh_flags */
268 #define UH_CHANGED  0x01	/* b_changed flag before undo/after redo */
269 #define UH_EMPTYBUF 0x02	/* buffer was empty */
270 
271 /*
272  * stuctures used in undo.c
273  */
274 #if SIZEOF_INT > 2
275 # define ALIGN_LONG	/* longword alignment and use filler byte */
276 # define ALIGN_SIZE (sizeof(long))
277 #else
278 # define ALIGN_SIZE (sizeof(short))
279 #endif
280 
281 #define ALIGN_MASK (ALIGN_SIZE - 1)
282 
283 typedef struct m_info minfo_T;
284 
285 /*
286  * stucture used to link chunks in one of the free chunk lists.
287  */
288 struct m_info
289 {
290 #ifdef ALIGN_LONG
291     long_u	m_size;		/* size of the chunk (including m_info) */
292 #else
293     short_u	m_size;		/* size of the chunk (including m_info) */
294 #endif
295     minfo_T	*m_next;	/* pointer to next free chunk in the list */
296 };
297 
298 /*
299  * structure used to link blocks in the list of allocated blocks.
300  */
301 typedef struct m_block mblock_T;
302 struct m_block
303 {
304     mblock_T	*mb_next;	/* pointer to next allocated block */
305     size_t	mb_size;	/* total size of all chunks in this block */
306     minfo_T	mb_info;	/* head of free chuck list for this block */
307 };
308 
309 /*
310  * things used in memfile.c
311  */
312 
313 typedef struct block_hdr    bhdr_T;
314 typedef struct memfile	    memfile_T;
315 typedef long		    blocknr_T;
316 
317 /*
318  * for each (previously) used block in the memfile there is one block header.
319  *
320  * The block may be linked in the used list OR in the free list.
321  * The used blocks are also kept in hash lists.
322  *
323  * The used list is a doubly linked list, most recently used block first.
324  *	The blocks in the used list have a block of memory allocated.
325  *	mf_used_count is the number of pages in the used list.
326  * The hash lists are used to quickly find a block in the used list.
327  * The free list is a single linked list, not sorted.
328  *	The blocks in the free list have no block of memory allocated and
329  *	the contents of the block in the file (if any) is irrelevant.
330  */
331 
332 struct block_hdr
333 {
334     bhdr_T	*bh_next;	    /* next block_hdr in free or used list */
335     bhdr_T	*bh_prev;	    /* previous block_hdr in used list */
336     bhdr_T	*bh_hash_next;	    /* next block_hdr in hash list */
337     bhdr_T	*bh_hash_prev;	    /* previous block_hdr in hash list */
338     blocknr_T	bh_bnum;		/* block number */
339     char_u	*bh_data;	    /* pointer to memory (for used block) */
340     int		bh_page_count;	    /* number of pages in this block */
341 
342 #define BH_DIRTY    1
343 #define BH_LOCKED   2
344     char	bh_flags;	    /* BH_DIRTY or BH_LOCKED */
345 };
346 
347 /*
348  * when a block with a negative number is flushed to the file, it gets
349  * a positive number. Because the reference to the block is still the negative
350  * number, we remember the translation to the new positive number in the
351  * double linked trans lists. The structure is the same as the hash lists.
352  */
353 typedef struct nr_trans NR_TRANS;
354 
355 struct nr_trans
356 {
357     NR_TRANS	*nt_next;		/* next nr_trans in hash list */
358     NR_TRANS	*nt_prev;		/* previous nr_trans in hash list */
359     blocknr_T	nt_old_bnum;		/* old, negative, number */
360     blocknr_T	nt_new_bnum;		/* new, positive, number */
361 };
362 
363 /*
364  * structure used to store one block of the stuff/redo/recording buffers
365  */
366 struct buffblock
367 {
368     struct buffblock	*b_next;	/* pointer to next buffblock */
369     char_u		b_str[1];	/* contents (actually longer) */
370 };
371 
372 /*
373  * header used for the stuff buffer and the redo buffer
374  */
375 struct buffheader
376 {
377     struct buffblock	bh_first;	/* first (dummy) block of list */
378     struct buffblock	*bh_curr;	/* buffblock for appending */
379     int			bh_index;	/* index for reading */
380     int			bh_space;	/* space in bh_curr for appending */
381 };
382 
383 /*
384  * used for completion on the command line
385  */
386 typedef struct expand
387 {
388     int		xp_context;		/* type of expansion */
389     char_u	*xp_pattern;		/* start of item to expand */
390 #if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
391     char_u	*xp_arg;		/* completion function */
392     int		xp_scriptID;		/* SID for completion function */
393 #endif
394     int		xp_backslash;		/* one of the XP_BS_ values */
395     int		xp_numfiles;		/* number of files found by
396 						    file name completion */
397     char_u	**xp_files;		/* list of files */
398 } expand_T;
399 
400 /* values for xp_backslash */
401 #define XP_BS_NONE	0	/* nothing special for backslashes */
402 #define XP_BS_ONE	1	/* uses one backslash before a space */
403 #define XP_BS_THREE	2	/* uses three backslashes before a space */
404 
405 /*
406  * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
407  * This needs to be saved for recursive commands, put them in a structure for
408  * easy manipulation.
409  */
410 typedef struct
411 {
412     int		hide;			/* TRUE when ":hide" was used */
413 # ifdef FEAT_BROWSE
414     int		browse;			/* TRUE to invoke file dialog */
415 # endif
416 # ifdef FEAT_WINDOWS
417     int		split;			/* flags for win_split() */
418 # endif
419 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
420     int		confirm;		/* TRUE to invoke yes/no dialog */
421 # endif
422     int		keepmarks;		/* TRUE when ":keepmarks" was used */
423     int		keepjumps;		/* TRUE when ":keepjumps" was used */
424     int		lockmarks;		/* TRUE when ":lockmarks" was used */
425 } cmdmod_T;
426 
427 /*
428  * Simplistic hashing scheme to quickly locate the blocks in the used list.
429  * 64 blocks are found directly (64 * 4K = 256K, most files are smaller).
430  */
431 #define MEMHASHSIZE	64
432 #define MEMHASH(nr)	((nr) & (MEMHASHSIZE - 1))
433 
434 struct memfile
435 {
436     char_u	*mf_fname;		/* name of the file */
437     char_u	*mf_ffname;		/* idem, full path */
438     int		mf_fd;			/* file descriptor */
439     bhdr_T	*mf_free_first;		/* first block_hdr in free list */
440     bhdr_T	*mf_used_first;		/* mru block_hdr in used list */
441     bhdr_T	*mf_used_last;		/* lru block_hdr in used list */
442     unsigned	mf_used_count;		/* number of pages in used list */
443     unsigned	mf_used_count_max;	/* maximum number of pages in memory */
444     bhdr_T	*mf_hash[MEMHASHSIZE];	/* array of hash lists */
445     NR_TRANS	*mf_trans[MEMHASHSIZE];	/* array of trans lists */
446     blocknr_T	mf_blocknr_max;		/* highest positive block number + 1*/
447     blocknr_T	mf_blocknr_min;		/* lowest negative block number - 1 */
448     blocknr_T	mf_neg_count;		/* number of negative blocks numbers */
449     blocknr_T	mf_infile_count;	/* number of pages in the file */
450     unsigned	mf_page_size;		/* number of bytes in a page */
451     int		mf_dirty;		/* TRUE if there are dirty blocks */
452 };
453 
454 /*
455  * things used in memline.c
456  */
457 /*
458  * When searching for a specific line, we remember what blocks in the tree
459  * are the branches leading to that block. This is stored in ml_stack.  Each
460  * entry is a pointer to info in a block (may be data block or pointer block)
461  */
462 typedef struct info_pointer
463 {
464     blocknr_T	ip_bnum;	/* block number */
465     linenr_T	ip_low;		/* lowest lnum in this block */
466     linenr_T	ip_high;	/* highest lnum in this block */
467     int		ip_index;	/* index for block with current lnum */
468 } infoptr_T;	/* block/index pair */
469 
470 #ifdef FEAT_BYTEOFF
471 typedef struct ml_chunksize
472 {
473     int		mlcs_numlines;
474     long	mlcs_totalsize;
475 } chunksize_T;
476 
477  /* Flags when calling ml_updatechunk() */
478 
479 #define ML_CHNK_ADDLINE 1
480 #define ML_CHNK_DELLINE 2
481 #define ML_CHNK_UPDLINE 3
482 #endif
483 
484 /*
485  * the memline structure holds all the information about a memline
486  */
487 typedef struct memline
488 {
489     linenr_T	ml_line_count;	/* number of lines in the buffer */
490 
491     memfile_T	*ml_mfp;	/* pointer to associated memfile */
492 
493 #define ML_EMPTY	1	/* empty buffer */
494 #define ML_LINE_DIRTY	2	/* cached line was changed and allocated */
495 #define ML_LOCKED_DIRTY	4	/* ml_locked was changed */
496 #define ML_LOCKED_POS	8	/* ml_locked needs positive block number */
497     int		ml_flags;
498 
499     infoptr_T	*ml_stack;	/* stack of pointer blocks (array of IPTRs) */
500     int		ml_stack_top;	/* current top if ml_stack */
501     int		ml_stack_size;	/* total number of entries in ml_stack */
502 
503     linenr_T	ml_line_lnum;	/* line number of cached line, 0 if not valid */
504     char_u	*ml_line_ptr;	/* pointer to cached line */
505 
506     bhdr_T	*ml_locked;	/* block used by last ml_get */
507     linenr_T	ml_locked_low;	/* first line in ml_locked */
508     linenr_T	ml_locked_high;	/* last line in ml_locked */
509     int		ml_locked_lineadd;  /* number of lines inserted in ml_locked */
510 #ifdef FEAT_BYTEOFF
511     chunksize_T *ml_chunksize;
512     int		ml_numchunks;
513     int		ml_usedchunks;
514 #endif
515 } memline_T;
516 
517 #if defined(FEAT_SIGNS) || defined(PROTO)
518 typedef struct signlist signlist_T;
519 
520 struct signlist
521 {
522     int		id;		/* unique identifier for each placed sign */
523     linenr_T	lnum;		/* line number which has this sign */
524     int		typenr;		/* typenr of sign */
525     signlist_T	*next;		/* next signlist entry */
526 # ifdef FEAT_NETBEANS_INTG
527     signlist_T  *prev;		/* previous entry -- for easy reordering */
528 # endif
529 };
530 
531 /* type argument for buf_getsigntype() */
532 #define SIGN_ANY	0
533 #define SIGN_LINEHL	1
534 #define SIGN_ICON	2
535 #define SIGN_TEXT	3
536 #endif
537 
538 /*
539  * Argument list: Array of file names.
540  * Used for the global argument list and the argument lists local to a window.
541  */
542 typedef struct arglist
543 {
544     garray_T	al_ga;		/* growarray with the array of file names */
545     int		al_refcount;	/* number of windows using this arglist */
546 } alist_T;
547 
548 /*
549  * For each argument remember the file name as it was given, and the buffer
550  * number that contains the expanded file name (required for when ":cd" is
551  * used.
552  */
553 typedef struct argentry
554 {
555     char_u	*ae_fname;	/* file name as specified */
556     int		ae_fnum;	/* buffer number with expanded file name */
557 } aentry_T;
558 
559 #ifdef FEAT_WINDOWS
560 # define ALIST(win) (win)->w_alist
561 #else
562 # define ALIST(win) (&global_alist)
563 #endif
564 #define GARGLIST	((aentry_T *)global_alist.al_ga.ga_data)
565 #define ARGLIST		((aentry_T *)ALIST(curwin)->al_ga.ga_data)
566 #define WARGLIST(wp)	((aentry_T *)ALIST(wp)->al_ga.ga_data)
567 #define AARGLIST(al)	((aentry_T *)((al)->al_ga.ga_data))
568 #define GARGCOUNT	(global_alist.al_ga.ga_len)
569 #define ARGCOUNT	(ALIST(curwin)->al_ga.ga_len)
570 #define WARGCOUNT(wp)	(ALIST(wp)->al_ga.ga_len)
571 
572 /*
573  * A list used for saving values of "emsg_silent".  Used by ex_try() to save the
574  * value of "emsg_silent" if it was non-zero.  When this is done, the CSF_SILENT
575  * flag below is set.
576  */
577 
578 typedef struct eslist_elem eslist_T;
579 struct eslist_elem
580 {
581     int		saved_emsg_silent;	/* saved value of "emsg_silent" */
582     eslist_T	*next;			/* next element on the list */
583 };
584 
585 /*
586  * For conditional commands a stack is kept of nested conditionals.
587  * When cs_idx < 0, there is no conditional command.
588  */
589 #define CSTACK_LEN	50
590 
591 struct condstack
592 {
593     char	cs_flags[CSTACK_LEN];	/* CSF_ flags */
594     char	cs_pending[CSTACK_LEN];	/* CSTP_: what's pending in ":finally"*/
595     union {
596 	void   *cs_pend_rv[CSTACK_LEN];	/* returnval for pending return */
597 	void   *cs_pend_ex[CSTACK_LEN];	/* exception for pending throw */
598     }		cs_pend;
599     int		cs_line[CSTACK_LEN];	/* line number of ":while" line */
600     int		cs_idx;			/* current entry, or -1 if none */
601     int		cs_whilelevel;		/* number of nested ":while"s */
602     int		cs_trylevel;		/* number of nested ":try"s */
603     eslist_T	*cs_emsg_silent_list;	/* saved values of "emsg_silent" */
604     char	cs_had_while;		/* just found ":while" */
605     char	cs_had_continue;	/* just found ":continue" */
606     char	cs_had_endwhile;	/* just found ":endwhile" */
607     char	cs_had_finally;		/* just found ":finally" */
608 };
609 # define cs_retvar	cs_pend.cs_pend_rv
610 # define cs_exception	cs_pend.cs_pend_ex
611 
612 # define CSF_TRUE	1	/* condition was TRUE */
613 # define CSF_ACTIVE	2	/* current state is active */
614 # define CSF_ELSE	4	/* ":else" has been passed */
615 # define CSF_WHILE	8	/* is a ":while" */
616 # define CSF_TRY	16	/* is a ":try" */
617 # define CSF_FINALLY	32	/* ":finally" has been passed */
618 # define CSF_THROWN	64	/* exception thrown to this try conditional */
619 # define CSF_CAUGHT	128	/* exception caught by this try conditional */
620 # define CSF_SILENT	4	/* "emsg_silent" reset by ":try" */
621 /* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
622  * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
623 
624 /*
625  * What's pending for being reactivated at the ":endtry" of this try
626  * conditional:
627  */
628 # define CSTP_NONE	0	/* nothing pending in ":finally" clause */
629 # define CSTP_ERROR	1	/* an error is pending */
630 # define CSTP_INTERRUPT	2	/* an interrupt is pending */
631 # define CSTP_THROW	4	/* a throw is pending */
632 # define CSTP_BREAK	8	/* ":break" is pending */
633 # define CSTP_CONTINUE	16	/* ":continue" is pending */
634 # define CSTP_RETURN	24	/* ":return" is pending */
635 # define CSTP_FINISH	32	/* ":finish" is pending */
636 
637 /*
638  * A list of error messages that can be converted to an exception.  "throw_msg"
639  * is only set in the first element of the list.  Usually, it points to the
640  * original message stored in that element, but sometimes it points to a later
641  * message in the list.  See cause_errthrow() below.
642  */
643 struct msglist
644 {
645     char_u		*msg;		/* original message */
646     char_u		*throw_msg;	/* msg to throw: usually original one */
647     struct msglist	*next;		/* next of several messages in a row */
648 };
649 
650 /*
651  * Structure describing an exception.
652  * (don't use "struct exception", it's used by the math library).
653  */
654 typedef struct vim_exception except_T;
655 struct vim_exception
656 {
657     int			type;		/* exception type */
658     char_u		*value;		/* exception value */
659     struct msglist	*messages;	/* message(s) causing error exception */
660     char_u		*throw_name;	/* name of the throw point */
661     linenr_T		throw_lnum;	/* line number of the throw point */
662     except_T		*caught;	/* next exception on the caught stack */
663 };
664 
665 /*
666  * The exception types.
667  */
668 #define ET_USER		0	/* exception caused by ":throw" command */
669 #define ET_ERROR	1	/* error exception */
670 #define ET_INTERRUPT	2	/* interrupt exception triggered by Ctrl-C */
671 
672 
673 #ifdef FEAT_SYN_HL
674 /* struct passed to in_id_list() */
675 struct sp_syn
676 {
677     int		inc_tag;	/* ":syn include" unique tag */
678     short	id;		/* highlight group ID of item */
679     short	*cont_in_list;	/* cont.in group IDs, if non-zero */
680 };
681 
682 /*
683  * Each keyword has one keyentry, which is linked in a hash list.
684  */
685 typedef struct keyentry keyentry_T;
686 
687 struct keyentry
688 {
689     keyentry_T	*next;		/* next keyword in the hash list */
690     struct sp_syn k_syn;	/* struct passed to in_id_list() */
691     short	*next_list;	/* ID list for next match (if non-zero) */
692     short	flags;		/* see syntax.c */
693     char_u	keyword[1];	/* actually longer */
694 };
695 
696 /*
697  * Struct used to store one state of the state stack.
698  */
699 typedef struct buf_state
700 {
701     int		    bs_idx;	 /* index of pattern */
702     long	    bs_flags;	 /* flags for pattern */
703     reg_extmatch_T *bs_extmatch; /* external matches from start pattern */
704 } bufstate_T;
705 
706 /*
707  * syn_state contains the syntax state stack for the start of one line.
708  * Used by b_sst_array[].
709  */
710 typedef struct syn_state synstate_T;
711 
712 struct syn_state
713 {
714     synstate_T	*sst_next;	/* next entry in used or free list */
715     linenr_T	sst_lnum;	/* line number for this state */
716     union
717     {
718 	bufstate_T	sst_stack[SST_FIX_STATES]; /* short state stack */
719 	garray_T	sst_ga;	/* growarray for long state stack */
720     } sst_union;
721     int		sst_next_flags;	/* flags for sst_next_list */
722     short	*sst_next_list;	/* "nextgroup" list in this state
723 				 * (this is a copy, don't free it! */
724     short	sst_stacksize;	/* number of states on the stack */
725     disptick_T	sst_tick;	/* tick when last displayed */
726     linenr_T	sst_change_lnum;/* when non-zero, change in this line
727 				 * may have made the state invalid */
728 };
729 #endif /* FEAT_SYN_HL */
730 
731 /*
732  * Structure shared between syntax.c, screen.c and gui_x11.c.
733  */
734 typedef struct attr_entry
735 {
736     short	    ae_attr;		/* HL_BOLD, etc. */
737     union
738     {
739 	struct
740 	{
741 	    char_u	    *start;	/* start escape sequence */
742 	    char_u	    *stop;	/* stop escape sequence */
743 	} term;
744 	struct
745 	{
746 	    char_u	    fg_color;	/* foreground color number */
747 	    char_u	    bg_color;	/* background color number */
748 	} cterm;
749 # ifdef FEAT_GUI
750 	struct
751 	{
752 	    guicolor_T	    fg_color;	/* foreground color handle */
753 	    guicolor_T	    bg_color;	/* background color handle */
754 	    GuiFont	    font;	/* font handle */
755 #  ifdef FEAT_XFONTSET
756 	    GuiFontset	    fontset;	/* fontset handle */
757 #  endif
758 	} gui;
759 # endif
760     } ae_u;
761 } attrentry_T;
762 
763 #ifdef USE_ICONV
764 # ifdef HAVE_ICONV_H
765 #  include <iconv.h>
766 # else
767 #  if defined(MACOS_X)
768 #   include <sys/errno.h>
769 #   define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
770 typedef struct _iconv_t *iconv_t;
771 #  else
772 #   if defined(MACOS_CLASSIC)
773 typedef struct _iconv_t *iconv_t;
774 #    define EINVAL	22
775 #    define E2BIG	7
776 #    define ENOENT	2
777 #    define EFAULT	14
778 #    define EILSEQ	123
779 #   else
780 #    include <errno.h>
781 #   endif
782 #  endif
783 typedef void *iconv_t;
784 # endif
785 #endif
786 
787 /*
788  * Used for the typeahead buffer: typebuf.
789  */
790 typedef struct
791 {
792     char_u	*tb_buf;	/* buffer for typed characters */
793     char_u	*tb_noremap;	/* mapping flags for characters in tb_buf[] */
794     int		tb_buflen;	/* size of tb_buf[] */
795     int		tb_off;		/* current position in tb_buf[] */
796     int		tb_len;		/* number of valid bytes in tb_buf[] */
797     int		tb_maplen;	/* nr of mapped bytes in tb_buf[] */
798     int		tb_silent;	/* nr of silently mapped bytes in tb_buf[] */
799     int		tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */
800     int		tb_change_cnt;	/* nr of time tb_buf was changed; never zero */
801 } typebuf_T;
802 
803 /* Struct to hold the saved typeahead for save_typeahead(). */
804 typedef struct
805 {
806     typebuf_T		save_typebuf;
807     int			typebuf_valid;	    /* TRUE when save_typebuf valid */
808     struct buffheader	save_stuffbuff;
809 #ifdef USE_INPUT_BUF
810     char_u		*save_inputbuf;
811 #endif
812 } tasave_T;
813 
814 /*
815  * Used for conversion of terminal I/O and script files.
816  */
817 typedef struct
818 {
819     int		vc_type;	/* zero or one of the CONV_ values */
820     int		vc_factor;	/* max. expansion factor */
821 # ifdef WIN3264
822     int		vc_cpfrom;	/* codepage to convert from (CONV_CODEPAGE) */
823     int		vc_cpto;	/* codepage to convert to (CONV_CODEPAGE) */
824 # endif
825 # ifdef USE_ICONV
826     iconv_t	vc_fd;		/* for CONV_ICONV */
827 # endif
828     int		vc_fail;	/* fail for invalid char, don't use '?' */
829 } vimconv_T;
830 
831 /*
832  * Structure used for reading from the viminfo file.
833  */
834 typedef struct
835 {
836     char_u	*vir_line;	/* text of the current line */
837     FILE	*vir_fd;	/* file descriptor */
838 #ifdef FEAT_MBYTE
839     vimconv_T	vir_conv;	/* encoding conversion */
840 #endif
841 } vir_T;
842 
843 #define CONV_NONE		0
844 #define CONV_TO_UTF8		1
845 #define CONV_TO_LATIN1		2
846 #define CONV_ICONV		3
847 #ifdef WIN3264
848 # define CONV_CODEPAGE		4	/* codepage -> codepage */
849 #endif
850 #ifdef MACOS_X
851 # define CONV_MAC_LATIN1	5
852 # define CONV_LATIN1_MAC	6
853 # define CONV_MAC_UTF8		7
854 # define CONV_UTF8_MAC		8
855 #endif
856 
857 /*
858  * Structure used for mappings and abbreviations.
859  */
860 typedef struct mapblock mapblock_T;
861 struct mapblock
862 {
863     mapblock_T	*m_next;	/* next mapblock in list */
864     char_u	*m_keys;	/* mapped from */
865     int		m_keylen;	/* strlen(m_keys) */
866     char_u	*m_str;		/* mapped to */
867     int		m_mode;		/* valid mode */
868     int		m_noremap;	/* if non-zero no re-mapping for m_str */
869     char	m_silent;	/* <silent> used, don't echo commands */
870 #if 0  /* Not used yet */
871     scid_T	m_script_ID;	/* ID of script where map was defined,
872 				   used for s: variables and functions */
873 #endif
874 };
875 
876 /*
877  * Used for highlighting in the status line.
878  */
879 struct stl_hlrec
880 {
881     char_u	*start;
882     int		userhl;
883 };
884 
885 /*
886  * buffer: structure that holds information about one file
887  *
888  * Several windows can share a single Buffer
889  * A buffer is unallocated if there is no memfile for it.
890  * A buffer is new if the associated file has never been loaded yet.
891  */
892 
893 typedef struct file_buffer buf_T;
894 
895 struct file_buffer
896 {
897     memline_T	b_ml;		/* associated memline (also contains line
898 				   count) */
899 
900     buf_T	*b_next;	/* links in list of buffers */
901     buf_T	*b_prev;
902 
903     int		b_nwindows;	/* nr of windows open on this buffer */
904 
905     int		b_flags;	/* various BF_ flags */
906 
907     /*
908      * b_ffname has the full path of the file (NULL for no name).
909      * b_sfname is the name as the user typed it (or NULL).
910      * b_fname is the same as b_sfname, unless ":cd" has been done,
911      *		then it is the same as b_ffname (NULL for no name).
912      */
913     char_u	*b_ffname;	/* full path file name */
914     char_u	*b_sfname;	/* short file name */
915     char_u	*b_fname;	/* current file name */
916 
917 #ifdef UNIX
918     int		b_dev;		/* device number (-1 if not set) */
919     ino_t	b_ino;		/* inode number */
920 #endif
921 #ifdef FEAT_CW_EDITOR
922     FSSpec	b_FSSpec;	/* MacOS File Identification */
923 #endif
924 #ifdef VMS
925     char	b_fab_rfm;	/* Record format */
926 #endif
927 #ifdef FEAT_SNIFF
928     int		b_sniff;	/* file was loaded through Sniff */
929 #endif
930 
931     int		b_fnum;		/* buffer number for this file. */
932 
933     int		b_changed;	/* 'modified': Set to TRUE if something in the
934 				   file has been changed and not written out. */
935     int		b_changedtick;	/* incremented for each change, also for undo */
936 
937     int		b_saving;	/* Set to TRUE if we are in the middle of
938 				   saving the buffer. */
939 
940     /*
941      * Changes to a buffer require updating of the display.  To minimize the
942      * work, remember changes made and update everything at once.
943      */
944     int		b_mod_set;	/* TRUE when there are changes since the last
945 				   time the display was updated */
946     linenr_T	b_mod_top;	/* topmost lnum that was changed */
947     linenr_T	b_mod_bot;	/* lnum below last changed line, AFTER the
948 				   change */
949     long	b_mod_xlines;	/* number of extra buffer lines inserted;
950 				   negative when lines were deleted */
951 
952     wininfo_T	*b_wininfo;	/* list of last used info for each window */
953 
954     long	b_mtime;	/* last change time of original file */
955     long	b_mtime_read;	/* last change time when reading */
956     size_t	b_orig_size;	/* size of original file in bytes */
957     int		b_orig_mode;	/* mode of original file */
958 
959     pos_T	b_namedm[NMARKS]; /* current named marks (mark.c) */
960 
961 #ifdef FEAT_VISUAL
962     /* These variables are set when VIsual_active becomes FALSE */
963     pos_T	b_visual_start;	/* start pos of last VIsual */
964     pos_T	b_visual_end;	/* end position of last VIsual */
965     int		b_visual_mode;	/* VIsual_mode of last VIsual */
966 # ifdef FEAT_EVAL
967     int		b_visual_mode_eval;  /* b_visual_mode for visualmode() */
968 # endif
969     colnr_T	b_visual_curswant;   /* MAXCOL from w_curswant */
970 #endif
971 
972     pos_T	b_last_cursor;	/* cursor position when last unloading this
973 				   buffer */
974     pos_T	b_last_insert;	/* where Insert mode was left */
975     pos_T	b_last_change;	/* position of last change: '. mark */
976 
977 #ifdef FEAT_JUMPLIST
978     /*
979      * the changelist contains old change positions
980      */
981     pos_T	b_changelist[JUMPLISTSIZE];
982     int		b_changelistlen;	/* number of active entries */
983     int		b_new_change;		/* set by u_savecommon() */
984 #endif
985 
986     /*
987      * Character table, only used in charset.c for 'iskeyword'
988      * 32 bytes of 8 bits: 1 bit per character 0-255.
989      */
990     char_u	b_chartab[32];
991 
992 #ifdef FEAT_LOCALMAP
993     /* Table used for mappings local to a buffer. */
994     mapblock_T	*(b_maphash[256]);
995 
996     /* First abbreviation local to a buffer. */
997     mapblock_T	*b_first_abbr;
998 #endif
999 #ifdef FEAT_USR_CMDS
1000     /* User commands local to the buffer. */
1001     garray_T	b_ucmds;
1002 #endif
1003     /*
1004      * start and end of an operator, also used for '[ and ']
1005      */
1006     pos_T	b_op_start;
1007     pos_T	b_op_end;
1008 
1009 #ifdef FEAT_VIMINFO
1010     int		b_marks_read;	/* Have we read viminfo marks yet? */
1011 #endif
1012 
1013     /*
1014      * The following only used in undo.c.
1015      */
1016     u_header_T	*b_u_oldhead;	/* pointer to oldest header */
1017     u_header_T	*b_u_newhead;	/* pointer to newest header */
1018     u_header_T	*b_u_curhead;	/* pointer to current header */
1019     int		b_u_numhead;	/* current number of headers */
1020     int		b_u_synced;	/* entry lists are synced */
1021 
1022     /*
1023      * variables for "U" command in undo.c
1024      */
1025     char_u	*b_u_line_ptr;	/* saved line for "U" command */
1026     linenr_T	b_u_line_lnum;	/* line number of line in u_line */
1027     colnr_T	b_u_line_colnr;	/* optional column number */
1028 
1029     /*
1030      * The following only used in undo.c
1031      */
1032     mblock_T	b_block_head;	/* head of allocated memory block list */
1033     minfo_T	*b_m_search;	/* pointer to chunk before previously
1034 				   allocated/freed chunk */
1035     mblock_T	*b_mb_current;	/* block where m_search points in */
1036 #ifdef FEAT_INS_EXPAND
1037     int		b_scanned;	/* ^N/^P have scanned this buffer */
1038 #endif
1039 
1040     /* flags for use of ":lmap" and IM control */
1041     long	b_p_iminsert;	/* input mode for insert */
1042     long	b_p_imsearch;	/* input mode for search */
1043 #define B_IMODE_USE_INSERT -1	/*	Use b_p_iminsert value for search */
1044 #define B_IMODE_NONE 0		/*	Input via none */
1045 #define B_IMODE_LMAP 1		/*	Input via langmap */
1046 #ifndef USE_IM_CONTROL
1047 # define B_IMODE_LAST 1
1048 #else
1049 # define B_IMODE_IM 2		/*	Input via input method */
1050 # define B_IMODE_LAST 2
1051 #endif
1052 
1053 #ifdef FEAT_KEYMAP
1054     short	b_kmap_state;	/* using "lmap" mappings */
1055 # define KEYMAP_INIT	1	/* 'keymap' was set, call keymap_init() */
1056 # define KEYMAP_LOADED	2	/* 'keymap' mappings have been loaded */
1057     garray_T	b_kmap_ga;	/* the keymap table */
1058 #endif
1059 
1060     /*
1061      * Options local to a buffer.
1062      * They are here because their value depends on the type of file
1063      * or contents of the file being edited.
1064      */
1065     int		b_p_initialized;	/* set when options initialized */
1066 
1067     int		b_p_ai;		/* 'autoindent' */
1068     int		b_p_ai_nopaste;	/* b_p_ai saved for paste mode */
1069     int		b_p_ci;		/* 'copyindent' */
1070     int		b_p_bin;	/* 'binary' */
1071 #ifdef FEAT_MBYTE
1072     int		b_p_bomb;	/* 'bomb' */
1073 #endif
1074 #if defined(FEAT_QUICKFIX)
1075     char_u	*b_p_bh;	/* 'bufhidden' */
1076     char_u	*b_p_bt;	/* 'buftype' */
1077 #endif
1078     int		b_p_bl;		/* 'buflisted' */
1079 #ifdef FEAT_CINDENT
1080     int		b_p_cin;	/* 'cindent' */
1081     char_u	*b_p_cino;	/* 'cinoptions' */
1082     char_u	*b_p_cink;	/* 'cinkeys' */
1083 #endif
1084 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
1085     char_u	*b_p_cinw;	/* 'cinwords' */
1086 #endif
1087 #ifdef FEAT_COMMENTS
1088     char_u	*b_p_com;	/* 'comments' */
1089 #endif
1090 #ifdef FEAT_FOLDING
1091     char_u	*b_p_cms;	/* 'commentstring' */
1092 #endif
1093 #ifdef FEAT_INS_EXPAND
1094     char_u	*b_p_cpt;	/* 'complete' */
1095 #endif
1096 #ifdef FEAT_COMPL_FUNC
1097     char_u	*b_p_cfu;	/* 'completefunc' */
1098 #endif
1099     int		b_p_eol;	/* 'endofline' */
1100     int		b_p_et;		/* 'expandtab' */
1101     int		b_p_et_nobin;	/* b_p_et saved for binary mode */
1102 #ifdef FEAT_MBYTE
1103     char_u	*b_p_fenc;	/* 'fileencoding' */
1104 #endif
1105     char_u	*b_p_ff;	/* 'fileformat' */
1106 #ifdef FEAT_AUTOCMD
1107     char_u	*b_p_ft;	/* 'filetype' */
1108 #endif
1109     char_u	*b_p_fo;	/* 'formatoptions' */
1110     int		b_p_inf;	/* 'infercase' */
1111     char_u	*b_p_isk;	/* 'iskeyword' */
1112 #ifdef FEAT_FIND_ID
1113     char_u	*b_p_def;	/* 'define' local value */
1114     char_u	*b_p_inc;	/* 'include' */
1115 # ifdef FEAT_EVAL
1116     char_u	*b_p_inex;	/* 'includeexpr' */
1117 # endif
1118 #endif
1119 #if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
1120     char_u	*b_p_inde;	/* 'indentexpr' */
1121     char_u	*b_p_indk;	/* 'indentkeys' */
1122 #endif
1123 #ifdef FEAT_CRYPT
1124     char_u	*b_p_key;	/* 'key' */
1125 #endif
1126     char_u	*b_p_kp;	/* 'keywordprg' */
1127 #ifdef FEAT_LISP
1128     int		b_p_lisp;	/* 'lisp' */
1129 #endif
1130     char_u	*b_p_mps;	/* 'matchpairs' */
1131     int		b_p_ml;		/* 'modeline' */
1132     int		b_p_ml_nobin;	/* b_p_ml saved for binary mode */
1133     int		b_p_ma;		/* 'modifiable' */
1134     char_u	*b_p_nf;	/* 'nrformats' */
1135 #ifdef FEAT_OSFILETYPE
1136     char_u	*b_p_oft;	/* 'osfiletype' */
1137 #endif
1138     int		b_p_pi;		/* 'preserveindent' */
1139 #ifdef FEAT_TEXTOBJ
1140     char_u	*b_p_qe;	/* 'quoteescape' */
1141 #endif
1142     int		b_p_ro;		/* 'readonly' */
1143     long	b_p_sw;		/* 'shiftwidth' */
1144 #ifndef SHORT_FNAME
1145     int		b_p_sn;		/* 'shortname' */
1146 #endif
1147 #ifdef FEAT_SMARTINDENT
1148     int		b_p_si;		/* 'smartindent' */
1149 #endif
1150     long	b_p_sts;	/* 'softtabstop' */
1151     long	b_p_sts_nopaste; /* b_p_sts saved for paste mode */
1152 #ifdef FEAT_SEARCHPATH
1153     char_u	*b_p_sua;	/* 'suffixesadd' */
1154 #endif
1155     int		b_p_swf;	/* 'swapfile' */
1156 #ifdef FEAT_SYN_HL
1157     char_u	*b_p_syn;	/* 'syntax' */
1158 #endif
1159     long	b_p_ts;		/* 'tabstop' */
1160     int		b_p_tx;		/* 'textmode' */
1161     long	b_p_tw;		/* 'textwidth' */
1162     long	b_p_tw_nobin;	/* b_p_tw saved for binary mode */
1163     long	b_p_tw_nopaste;	/* b_p_tw saved for paste mode */
1164     long	b_p_wm;		/* 'wrapmargin' */
1165     long	b_p_wm_nobin;	/* b_p_wm saved for binary mode */
1166     long	b_p_wm_nopaste;	/* b_p_wm saved for paste mode */
1167 #ifdef FEAT_KEYMAP
1168     char_u	*b_p_keymap;	/* 'keymap' */
1169 #endif
1170 
1171     /* local values for options which are normally global */
1172 #ifdef FEAT_QUICKFIX
1173     char_u	*b_p_gp;	/* 'grepprg' local value */
1174     char_u	*b_p_mp;	/* 'makeprg' local value */
1175     char_u	*b_p_efm;	/* 'errorformat' local value */
1176 #endif
1177     char_u	*b_p_ep;	/* 'equalprg' local value */
1178     char_u	*b_p_path;	/* 'path' local value */
1179     int		b_p_ar;		/* 'autoread' local value */
1180     char_u	*b_p_tags;	/* 'tags' local value */
1181 #ifdef FEAT_INS_EXPAND
1182     char_u	*b_p_dict;	/* 'dictionary' local value */
1183     char_u	*b_p_tsr;	/* 'thesaurus' local value */
1184 #endif
1185 
1186     /* end of buffer options */
1187 
1188     int		b_start_eol;	/* last line had eol when it was read */
1189     int		b_start_ffc;	/* first char of 'ff' when edit started */
1190 #ifdef FEAT_MBYTE
1191     char_u	*b_start_fenc;	/* 'fileencoding' when edit started or NULL */
1192 #endif
1193 
1194 #ifdef FEAT_EVAL
1195     garray_T	b_vars;		/* internal variables, local to buffer */
1196 #endif
1197 
1198     /* When a buffer is created, it starts without a swap file.  b_may_swap is
1199      * then set to indicate that a swap file may be opened later.  It is reset
1200      * if a swap file could not be opened.
1201      */
1202     int		b_may_swap;
1203     int		b_did_warn;	/* Set to 1 if user has been warned on first
1204 				   change of a read-only file */
1205     int		b_help;		/* buffer for help file (when set b_p_bt is
1206 				   "help") */
1207 
1208 #ifndef SHORT_FNAME
1209     int		b_shortname;	/* this file has an 8.3 file name */
1210 #endif
1211 
1212 #ifdef FEAT_PERL
1213     void	*perl_private;
1214 #endif
1215 
1216 #ifdef FEAT_PYTHON
1217     void	*python_ref;	/* The Python value referring to this buffer */
1218 #endif
1219 
1220 #ifdef FEAT_TCL
1221     void	*tcl_ref;
1222 #endif
1223 
1224 #ifdef FEAT_RUBY
1225     void	*ruby_ref;
1226 #endif
1227 
1228 #ifdef FEAT_SYN_HL
1229     keyentry_T	**b_keywtab;		/* syntax keywords hash table */
1230     keyentry_T	**b_keywtab_ic;		/* idem, ignore case */
1231     int		b_syn_ic;		/* ignore case for :syn cmds */
1232     garray_T	b_syn_patterns;		/* table for syntax patterns */
1233     garray_T	b_syn_clusters;		/* table for syntax clusters */
1234     int		b_syn_containedin;	/* TRUE when there is an item with a
1235 					   "containedin" argument */
1236     int		b_syn_sync_flags;	/* flags about how to sync */
1237     short	b_syn_sync_id;		/* group to sync on */
1238     long	b_syn_sync_minlines;	/* minimal sync lines offset */
1239     long	b_syn_sync_maxlines;	/* maximal sync lines offset */
1240     long	b_syn_sync_linebreaks;	/* offset for multi-line pattern */
1241     char_u	*b_syn_linecont_pat;	/* line continuation pattern */
1242     regprog_T	*b_syn_linecont_prog;	/* line continuation program */
1243     int		b_syn_linecont_ic;	/* ignore-case flag for above */
1244     int		b_syn_topgrp;		/* for ":syntax include" */
1245 # ifdef FEAT_FOLDING
1246     int		b_syn_folditems;	/* number of patterns with the HL_FOLD
1247 					   flag set */
1248 # endif
1249 /*
1250  * b_sst_array[] contains the state stack for a number of lines, for the start
1251  * of that line (col == 0).  This avoids having to recompute the syntax state
1252  * too often.
1253  * b_sst_array[] is allocated to hold the state for all displayed lines, and
1254  * states for 1 out of about 20 other lines.
1255  * b_sst_array		pointer to an array of synstate_T
1256  * b_sst_len		number of entries in b_sst_array[]
1257  * b_sst_first		pointer to first used entry in b_sst_array[] or NULL
1258  * b_sst_firstfree	pointer to first free entry in b_sst_array[] or NULL
1259  * b_sst_freecount	number of free entries in b_sst_array[]
1260  * b_sst_check_lnum	entries after this lnum need to be checked for
1261  *			validity (MAXLNUM means no check needed)
1262  */
1263     synstate_T	*b_sst_array;
1264     int		b_sst_len;
1265     synstate_T	*b_sst_first;
1266     synstate_T	*b_sst_firstfree;
1267     int		b_sst_freecount;
1268     linenr_T	b_sst_check_lnum;
1269     short_u	b_sst_lasttick;	/* last display tick */
1270 #endif /* FEAT_SYN_HL */
1271 
1272 #ifdef FEAT_SIGNS
1273     signlist_T	*b_signlist;	/* list of signs to draw */
1274 #endif
1275 
1276 #ifdef FEAT_NETBEANS_INTG
1277     int		b_netbeans_file;    /* TRUE when buffer is owned by NetBeans */
1278     int		b_was_netbeans_file;/* TRUE if b_netbeans_file was once set */
1279 #endif
1280 
1281 };
1282 
1283 /*
1284  * Structure to cache info for displayed lines in w_lines[].
1285  * Each logical line has one entry.
1286  * The entry tells how the logical line is currently displayed in the window.
1287  * This is updated when displaying the window.
1288  * When the display is changed (e.g., when clearing the screen) w_lines_valid
1289  * is changed to exclude invalid entries.
1290  * When making changes to the buffer, wl_valid is reset to indicate wl_size
1291  * may not reflect what is actually in the buffer.  When wl_valid is FALSE,
1292  * the entries can only be used to count the number of displayed lines used.
1293  * wl_lnum and wl_lastlnum are invalid too.
1294  */
1295 typedef struct w_line
1296 {
1297     linenr_T	wl_lnum;	/* buffer line number for logical line */
1298     short_u	wl_size;	/* height in screen lines */
1299     char	wl_valid;	/* TRUE values are valid for text in buffer */
1300 #ifdef FEAT_FOLDING
1301     char	wl_folded;	/* TRUE when this is a range of folded lines */
1302     linenr_T	wl_lastlnum;	/* last buffer line number for logical line */
1303 #endif
1304 } wline_T;
1305 
1306 /*
1307  * Windows are kept in a tree of frames.  Each frame has a column (FR_COL)
1308  * or row (FR_ROW) layout or is a leaf, which has a window.
1309  */
1310 struct frame
1311 {
1312     char	fr_layout;	/* FR_LEAF, FR_COL or FR_ROW */
1313 #ifdef FEAT_VERTSPLIT
1314     int		fr_width;
1315 #endif
1316     int		fr_height;
1317     int		fr_newheight;	/* new height used in win_equal_rec() */
1318     frame_T	*fr_parent;	/* containing frame or NULL */
1319     frame_T	*fr_next;	/* frame right or below in same parent, NULL
1320 				   for first */
1321     frame_T	*fr_prev;	/* frame left or above in same parent, NULL
1322 				   for last */
1323     /* fr_child and fr_win are mutually exclusive */
1324     frame_T	*fr_child;	/* first contained frame */
1325     win_T	*fr_win;	/* window that fills this frame */
1326 };
1327 
1328 #define FR_LEAF	0	/* frame is a leaf */
1329 #define FR_ROW	1	/* frame with a row of windows */
1330 #define FR_COL	2	/* frame with a column of windows */
1331 
1332 /*
1333  * Structure which contains all information that belongs to a window
1334  *
1335  * All row numbers are relative to the start of the window, except w_winrow.
1336  */
1337 struct window
1338 {
1339     buf_T	*w_buffer;	    /* buffer we are a window into (used
1340 				       often, keep it the first item!) */
1341 
1342 #ifdef FEAT_WINDOWS
1343     win_T	*w_prev;	    /* link to previous window */
1344     win_T	*w_next;	    /* link to next window */
1345 #endif
1346 
1347     frame_T	*w_frame;	    /* frame containing this window */
1348 
1349     pos_T	w_cursor;	    /* cursor position in buffer */
1350 
1351     colnr_T	w_curswant;	    /* The column we'd like to be at.  This is
1352 				       used to try to stay in the same column
1353 				       for up/down cursor motions. */
1354 
1355     int		w_set_curswant;	    /* If set, then update w_curswant the next
1356 				       time through cursupdate() to the
1357 				       current virtual column */
1358 
1359 #ifdef FEAT_VISUAL
1360     /*
1361      * the next six are used to update the visual part
1362      */
1363     char	w_old_visual_mode;  /* last known VIsual_mode */
1364     linenr_T	w_old_cursor_lnum;  /* last known end of visual part */
1365     colnr_T	w_old_cursor_fcol;  /* first column for block visual part */
1366     colnr_T	w_old_cursor_lcol;  /* last column for block visual part */
1367     linenr_T	w_old_visual_lnum;  /* last known start of visual part */
1368     colnr_T	w_old_curswant;	    /* last known value of Curswant */
1369 #endif
1370 
1371     /*
1372      * The next three specify the offsets for displaying the buffer:
1373      */
1374     linenr_T	w_topline;	    /* buffer line number of the line at the
1375 				       top of the window */
1376 #ifdef FEAT_DIFF
1377     int		w_topfill;	    /* number of filler lines above w_topline */
1378     int		w_old_topfill;	    /* w_topfill at last redraw */
1379     int		w_botfill;	    /* TRUE when filler lines are actually
1380 				       below w_topline (at end of file) */
1381     int		w_old_botfill;	    /* w_botfill at last redraw */
1382 #endif
1383     colnr_T	w_leftcol;	    /* window column number of the left most
1384 				       character in the window; used when
1385 				       'wrap' is off */
1386     colnr_T	w_skipcol;	    /* starting column when a single line
1387 				       doesn't fit in the window */
1388 
1389     /*
1390      * Layout of the window in the screen.
1391      * May need to add "msg_scrolled" to "w_winrow" in rare situations.
1392      */
1393 #ifdef FEAT_WINDOWS
1394     int		w_winrow;	    /* first row of window in screen */
1395 #endif
1396     int		w_height;	    /* number of rows in window, excluding
1397 				       status/command line(s) */
1398 #ifdef FEAT_WINDOWS
1399     int		w_status_height;    /* number of status lines (0 or 1) */
1400 #endif
1401 #ifdef FEAT_VERTSPLIT
1402     int		w_wincol;	    /* Leftmost column of window in screen.
1403 				       use W_WINCOL() */
1404     int		w_width;	    /* Width of window, excluding separation.
1405 				       use W_WIDTH() */
1406     int		w_vsep_width;	    /* Number of separator columns (0 or 1).
1407 				       use W_VSEP_WIDTH() */
1408 #endif
1409 
1410     /*
1411      * === start of cached values ====
1412      */
1413     /*
1414      * Recomputing is minimized by storing the result of computations.
1415      * Use functions in screen.c to check if they are valid and to update.
1416      * w_valid is a bitfield of flags, which indicate if specific values are
1417      * valid or need to be recomputed.	See screen.c for values.
1418      */
1419     int		w_valid;
1420     pos_T	w_valid_cursor;	    /* last known position of w_cursor, used
1421 				       to adjust w_valid */
1422     colnr_T	w_valid_leftcol;    /* last known w_leftcol */
1423 
1424     /*
1425      * w_cline_height is the number of physical lines taken by the buffer line
1426      * that the cursor is on.  We use this to avoid extra calls to plines().
1427      */
1428     int		w_cline_height;	    /* current size of cursor line */
1429 #ifdef FEAT_FOLDING
1430     int		w_cline_folded;	    /* cursor line is folded */
1431 #endif
1432 
1433     int		w_cline_row;	    /* starting row of the cursor line */
1434 
1435     colnr_T	w_virtcol;	    /* column number of the cursor in the
1436 				       buffer line, as opposed to the column
1437 				       number we're at on the screen.  This
1438 				       makes a difference on lines which span
1439 				       more than one screen line or when
1440 				       w_leftcol is non-zero */
1441 
1442     /*
1443      * w_wrow and w_wcol specify the cursor position in the window.
1444      * This is related to positions in the window, not in the display or
1445      * buffer, thus w_wrow is relative to w_winrow.
1446      */
1447     int		w_wrow, w_wcol;	    /* cursor position in window */
1448 
1449     linenr_T	w_botline;	    /* number of the line below the bottom of
1450 				       the screen */
1451     int		w_empty_rows;	    /* number of ~ rows in window */
1452 #ifdef FEAT_DIFF
1453     int		w_filler_rows;	    /* number of filler rows at the end of the
1454 				       window */
1455 #endif
1456 
1457     /*
1458      * Info about the lines currently in the window is remembered to avoid
1459      * recomputing it every time.  The allocated size of w_lines[] is Rows.
1460      * Only the w_lines_valid entries are actually valid.
1461      * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
1462      * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
1463      * Between changing text and updating the display w_lines[] represents
1464      * what is currently displayed.  wl_valid is reset to indicated this.
1465      * This is used for efficient redrawing.
1466      */
1467     int		w_lines_valid;	    /* number of valid entries */
1468     wline_T	*w_lines;
1469 
1470 #ifdef FEAT_FOLDING
1471     garray_T	w_folds;	    /* array of nested folds */
1472     char	w_fold_manual;	    /* when TRUE: some folds are opened/closed
1473 				       manually */
1474     char	w_foldinvalid;	    /* when TRUE: folding needs to be
1475 				       recomputed */
1476 #endif
1477 #ifdef FEAT_LINEBREAK
1478     int		w_nrwidth;	    /* width of 'number' column being used */
1479 #endif
1480 
1481     /*
1482      * === end of cached values ===
1483      */
1484 
1485     int		w_redr_type;	    /* type of redraw to be performed on win */
1486     int		w_upd_rows;	    /* number of window lines to update when
1487 				       w_redr_type is REDRAW_TOP */
1488     linenr_T	w_redraw_top;	    /* when != 0: first line needing redraw */
1489     linenr_T	w_redraw_bot;	    /* when != 0: last line needing redraw */
1490 #ifdef FEAT_WINDOWS
1491     int		w_redr_status;	    /* if TRUE status line must be redrawn */
1492 #endif
1493 
1494 #ifdef FEAT_CMDL_INFO
1495     /* remember what is shown in the ruler for this window (if 'ruler' set) */
1496     pos_T	w_ru_cursor;	    /* cursor position shown in ruler */
1497     colnr_T	w_ru_virtcol;	    /* virtcol shown in ruler */
1498     linenr_T	w_ru_topline;	    /* topline shown in ruler */
1499     linenr_T	w_ru_line_count;    /* line count used for ruler */
1500 # ifdef FEAT_DIFF
1501     int		w_ru_topfill;	    /* topfill shown in ruler */
1502 # endif
1503     char	w_ru_empty;	    /* TRUE if ruler shows 0-1 (empty line) */
1504 #endif
1505 
1506     int		w_alt_fnum;	    /* alternate file (for # and CTRL-^) */
1507 
1508 #ifdef FEAT_WINDOWS
1509     alist_T	*w_alist;	    /* pointer to arglist for this window */
1510 #endif
1511     int		w_arg_idx;	    /* current index in argument list (can be
1512 				       out of range!) */
1513     int		w_arg_idx_invalid;  /* editing another file than w_arg_idx */
1514 
1515     char_u	*w_localdir;	    /* absolute path of local directory or
1516 				       NULL */
1517     /*
1518      * Options local to a window.
1519      * They are local because they influence the layout of the window or
1520      * depend on the window layout.
1521      * There are two values: w_onebuf_opt is local to the buffer currently in
1522      * this window, w_allbuf_opt is for all buffers in this window.
1523      */
1524     winopt_T	w_onebuf_opt;
1525     winopt_T	w_allbuf_opt;
1526 
1527     /* transform a pointer to a "onebuf" option into a "allbuf" option */
1528 #define GLOBAL_WO(p)	((char *)p + sizeof(winopt_T))
1529 
1530 #ifdef FEAT_SCROLLBIND
1531     long	w_scbind_pos;
1532 #endif
1533 
1534 #ifdef FEAT_EVAL
1535     garray_T	w_vars;		/* internal variables, local to window */
1536 #endif
1537 
1538 #if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
1539     int		w_farsi;	/* for the window dependent Farsi functions */
1540 #endif
1541 
1542     /*
1543      * The w_prev_pcmark field is used to check whether we really did jump to
1544      * a new line after setting the w_pcmark.  If not, then we revert to
1545      * using the previous w_pcmark.
1546      */
1547     pos_T	w_pcmark;	/* previous context mark */
1548     pos_T	w_prev_pcmark;	/* previous w_pcmark */
1549 
1550 #ifdef FEAT_JUMPLIST
1551     /*
1552      * the jumplist contains old cursor positions
1553      */
1554     xfmark_T	w_jumplist[JUMPLISTSIZE];
1555     int		w_jumplistlen;		/* number of active entries */
1556     int		w_jumplistidx;		/* current position */
1557 
1558     int		w_changelistidx;	/* current position in b_changelist */
1559 #endif
1560 
1561 #ifdef FEAT_SEARCH_EXTRA
1562     regmmatch_T	w_match;	/* regexp program for ":match" */
1563     int		w_match_id;	/* highlight ID for ":match" */
1564 #endif
1565 
1566     /*
1567      * the tagstack grows from 0 upwards:
1568      * entry 0: older
1569      * entry 1: newer
1570      * entry 2: newest
1571      */
1572     taggy_T	w_tagstack[TAGSTACKSIZE];	/* the tag stack */
1573     int		w_tagstackidx;		/* idx just below activ entry */
1574     int		w_tagstacklen;		/* number of tags on stack */
1575 
1576     /*
1577      * w_fraction is the fractional row of the cursor within the window, from
1578      * 0 at the top row to FRACTION_MULT at the last row.
1579      * w_prev_fraction_row was the actual cursor row when w_fraction was last
1580      * calculated.
1581      */
1582     int		w_fraction;
1583     int		w_prev_fraction_row;
1584 
1585 #ifdef FEAT_GUI
1586     scrollbar_T	w_scrollbars[2];	/* vert. Scrollbars for this window */
1587 #endif
1588 #ifdef FEAT_LINEBREAK
1589     linenr_T	w_nrwidth_line_count;	/* line count when ml_nrwidth_width
1590 					 * was computed. */
1591     int		w_nrwidth_width;	/* nr of chars to print line count. */
1592 #endif
1593 
1594 #ifdef FEAT_PERL
1595     void	*perl_private;
1596 #endif
1597 
1598 #ifdef FEAT_PYTHON
1599     void	*python_ref;	/* The Python value referring to this
1600 					   window */
1601 #endif
1602 
1603 #ifdef FEAT_TCL
1604     void	*tcl_ref;
1605 #endif
1606 
1607 #ifdef FEAT_RUBY
1608     void	*ruby_ref;
1609 #endif
1610 };
1611 
1612 /*
1613  * Arguments for operators.
1614  */
1615 typedef struct oparg
1616 {
1617     int		op_type;	/* current pending operator type */
1618     int		regname;	/* register to use for the operator */
1619     int		motion_type;	/* type of the current cursor motion */
1620     int		motion_force;	/* force motion type: 'v', 'V' or CTRL-V */
1621     int		use_reg_one;	/* TRUE if delete uses reg 1 even when not
1622 				   linewise */
1623     int		inclusive;	/* TRUE if char motion is inclusive (only
1624 				   valid when motion_type is MCHAR */
1625     int		end_adjusted;	/* backuped b_op_end one char (only used by
1626 				   do_format()) */
1627     pos_T	start;		/* start of the operator */
1628     pos_T	end;		/* end of the operator */
1629     pos_T	cursor_start;	/* cursor position before motion for "gw" */
1630 
1631     long	line_count;	/* number of lines from op_start to op_end
1632 				   (inclusive) */
1633     int		empty;		/* op_start and op_end the same (only used by
1634 				   do_change()) */
1635 #ifdef FEAT_VISUAL
1636     int		is_VIsual;	/* operator on Visual area */
1637     int		block_mode;	/* current operator is Visual block mode */
1638 #endif
1639     colnr_T	start_vcol;	/* start col for block mode operator */
1640     colnr_T	end_vcol;	/* end col for block mode operator */
1641 } oparg_T;
1642 
1643 /*
1644  * Arguments for Normal mode commands.
1645  */
1646 typedef struct cmdarg
1647 {
1648     oparg_T	*oap;		/* Operator arguments */
1649     int		prechar;	/* prefix character (optional, always 'g') */
1650     int		cmdchar;	/* command character */
1651     int		nchar;		/* next command character (optional) */
1652 #ifdef FEAT_MBYTE
1653     int		ncharC1;	/* first composing character (optional) */
1654     int		ncharC2;	/* second composing character (optional) */
1655 #endif
1656     int		extra_char;	/* yet another character (optional) */
1657     long	opcount;	/* count before an operator */
1658     long	count0;		/* count before command, default 0 */
1659     long	count1;		/* count before command, default 1 */
1660     int		arg;		/* extra argument from nv_cmds[] */
1661     int		retval;		/* return: CA_* values */
1662     char_u	*searchbuf;	/* return: pointer to search pattern or NULL */
1663 } cmdarg_T;
1664 
1665 /* values for retval: */
1666 #define CA_COMMAND_BUSY	    1	/* skip restarting edit() once */
1667 #define CA_NO_ADJ_OP_END    2	/* don't adjust operator end */
1668 
1669 #ifdef CURSOR_SHAPE
1670 /*
1671  * struct to store values from 'guicursor' and 'mouseshape'
1672  */
1673 /* Indexes in shape_table[] */
1674 #define SHAPE_IDX_N	0	/* Normal mode */
1675 #define SHAPE_IDX_V	1	/* Visual mode */
1676 #define SHAPE_IDX_I	2	/* Insert mode */
1677 #define SHAPE_IDX_R	3	/* Replace mode */
1678 #define SHAPE_IDX_C	4	/* Command line Normal mode */
1679 #define SHAPE_IDX_CI	5	/* Command line Insert mode */
1680 #define SHAPE_IDX_CR	6	/* Command line Replace mode */
1681 #define SHAPE_IDX_O	7	/* Operator-pending mode */
1682 #define SHAPE_IDX_VE	8	/* Visual mode with 'seleciton' exclusive */
1683 #define SHAPE_IDX_CLINE	9	/* On command line */
1684 #define SHAPE_IDX_STATUS 10	/* A status line */
1685 #define SHAPE_IDX_SDRAG 11	/* dragging a status line */
1686 #define SHAPE_IDX_VSEP	12	/* A vertical separator line */
1687 #define SHAPE_IDX_VDRAG 13	/* dragging a vertical separator line */
1688 #define SHAPE_IDX_MORE	14	/* Hit-return or More */
1689 #define SHAPE_IDX_MOREL	15	/* Hit-return or More in last line */
1690 #define SHAPE_IDX_SM	16	/* showing matching paren */
1691 #define SHAPE_IDX_COUNT	17
1692 
1693 #define SHAPE_BLOCK	0	/* block cursor */
1694 #define SHAPE_HOR	1	/* horizontal bar cursor */
1695 #define SHAPE_VER	2	/* vertical bar cursor */
1696 
1697 #define MSHAPE_NUMBERED	1000	/* offset for shapes identified by number */
1698 #define MSHAPE_HIDE	1	/* hide mouse pointer */
1699 
1700 #define SHAPE_MOUSE	1	/* used for mouse pointer shape */
1701 #define SHAPE_CURSOR	2	/* used for text cursor shape */
1702 
1703 typedef struct cursor_entry
1704 {
1705     int		shape;		/* one of the SHAPE_ defines */
1706     int		mshape;		/* one of the MSHAPE defines */
1707     int		percentage;	/* percentage of cell for bar */
1708     long	blinkwait;	/* blinking, wait time before blinking starts */
1709     long	blinkon;	/* blinking, on time */
1710     long	blinkoff;	/* blinking, off time */
1711     int		id;		/* highlight group ID */
1712     int		id_lm;		/* highlight group ID for :lmap mode */
1713     char	*name;		/* mode name (fixed) */
1714     char	used_for;	/* SHAPE_MOUSE and/or SHAPE_CURSOR */
1715 } cursorentry_T;
1716 #endif /* CURSOR_SHAPE */
1717 
1718 #ifdef FEAT_MENU
1719 
1720 /* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
1721 #define MENU_INDEX_INVALID	-1
1722 #define MENU_INDEX_NORMAL	0
1723 #define MENU_INDEX_VISUAL	1
1724 #define MENU_INDEX_OP_PENDING	2
1725 #define MENU_INDEX_INSERT	3
1726 #define MENU_INDEX_CMDLINE	4
1727 #define MENU_INDEX_TIP		5
1728 #define MENU_MODES		6
1729 
1730 /* Menu modes */
1731 #define MENU_NORMAL_MODE	(1 << MENU_INDEX_NORMAL)
1732 #define MENU_VISUAL_MODE	(1 << MENU_INDEX_VISUAL)
1733 #define MENU_OP_PENDING_MODE	(1 << MENU_INDEX_OP_PENDING)
1734 #define MENU_INSERT_MODE	(1 << MENU_INDEX_INSERT)
1735 #define MENU_CMDLINE_MODE	(1 << MENU_INDEX_CMDLINE)
1736 #define MENU_TIP_MODE		(1 << MENU_INDEX_TIP)
1737 #define MENU_ALL_MODES		((1 << MENU_INDEX_TIP) - 1)
1738 /*note MENU_INDEX_TIP is not a 'real' mode*/
1739 
1740 /* Start a menu name with this to not include it on the main menu bar */
1741 #define MNU_HIDDEN_CHAR		']'
1742 
1743 typedef struct VimMenu vimmenu_T;
1744 
1745 struct VimMenu
1746 {
1747     int		modes;		    /* Which modes is this menu visible for? */
1748     int		enabled;	    /* for which modes the menu is enabled */
1749     char_u	*name;		    /* Name of menu */
1750     char_u	*dname;		    /* Displayed Name (without '&') */
1751     int		mnemonic;	    /* mnemonic key (after '&') */
1752     char_u	*actext;	    /* accelerator text (after TAB) */
1753     int		priority;	    /* Menu order priority */
1754 #ifdef FEAT_GUI
1755     void	(*cb)();	    /* Call-back routine */
1756 #endif
1757 #ifdef FEAT_TOOLBAR
1758     char_u	*iconfile;	    /* name of file for icon or NULL */
1759     int		iconidx;	    /* icon index (-1 if not set) */
1760     int		icon_builtin;	    /* icon names is BuiltIn{nr} */
1761 #endif
1762     char_u	*strings[MENU_MODES]; /* Mapped string for each mode */
1763     int		noremap[MENU_MODES]; /* A REMAP_ flag for each mode */
1764     char	silent[MENU_MODES]; /* A silent flag for each mode */
1765     vimmenu_T	*children;	    /* Children of sub-menu */
1766     vimmenu_T	*parent;	    /* Parent of menu */
1767     vimmenu_T	*next;		    /* Next item in menu */
1768 #ifdef FEAT_GUI_X11
1769     Widget	id;		    /* Manage this to enable item */
1770     Widget	submenu_id;	    /* If this is submenu, add children here */
1771 #endif
1772 #ifdef FEAT_GUI_KDE
1773     QPopupMenu *widget;
1774 #endif
1775 #ifdef FEAT_GUI_GTK
1776     GtkWidget	*id;		    /* Manage this to enable item */
1777     GtkWidget	*submenu_id;	    /* If this is submenu, add children here */
1778     GtkWidget	*tearoff_handle;
1779     GtkWidget   *label;		    /* Used by "set wak=" code. */
1780 #endif
1781 #ifdef FEAT_GUI_MOTIF
1782     int		sensitive;	    /* turn button on/off */
1783 #endif
1784 #if defined(FEAT_GUI_ATHENA) || defined(FEAT_GUI_MOTIF)
1785     Pixmap	image;		    /* Toolbar image */
1786 #endif
1787 #ifdef FEAT_GUI_MOTIF
1788     Pixmap	image_ins;	    /* Toolbar image insensitive */
1789 #endif
1790 #ifdef FEAT_BEVAL_TIP
1791     BalloonEval *tip;		    /* tooltip for this menu item */
1792 #endif
1793 #ifdef FEAT_GUI_W16
1794     UINT	id;		    /* Id of menu item */
1795     HMENU	submenu_id;	    /* If this is submenu, add children here */
1796 #endif
1797 #ifdef FEAT_GUI_W32
1798     UINT	id;		    /* Id of menu item */
1799     HMENU	submenu_id;	    /* If this is submenu, add children here */
1800     HWND	tearoff_handle;	    /* hWnd of tearoff if created */
1801 #endif
1802 #if FEAT_GUI_BEOS
1803     BMenuItem	*id;		    /* Id of menu item */
1804     BMenu	*submenu_id;	    /* If this is submenu, add children here */
1805 #endif
1806 #ifdef FEAT_GUI_MAC
1807 /*  MenuHandle	id; */
1808 /*  short	index;	*/	    /* the item index within the father menu */
1809     short	menu_id;	    /* the menu id to which this item belong */
1810     short	submenu_id;	    /* the menu id of the children (could be
1811 				       get throught some tricks) */
1812     MenuHandle	menu_handle;
1813     MenuHandle	submenu_handle;
1814 #endif
1815 #if defined(FEAT_GUI_AMIGA)
1816 				    /* only one of these will ever be set, but
1817 				     * they are used to allow the menu routine
1818 				     * to easily get a hold of the parent menu
1819 				     * pointer which is needed by all items to
1820 				     * form the chain correctly */
1821     int		    id;		    /* unused by the amiga, but used in the
1822 				     * code kept for compatibility */
1823     struct Menu	    *menuPtr;
1824     struct MenuItem *menuItemPtr;
1825 #endif
1826 #ifdef RISCOS
1827     int		*id;		    /* Not used, but gui.c needs it */
1828     int		greyed_out;	    /* Flag */
1829     int		hidden;
1830 #endif
1831 #ifdef FEAT_GUI_PHOTON
1832     PtWidget_t	*id;
1833     PtWidget_t	*submenu_id;
1834 #endif
1835 };
1836 #else
1837 /* For generating prototypes when FEAT_MENU isn't defined. */
1838 typedef int vimmenu_T;
1839 
1840 #endif /* FEAT_MENU */
1841 
1842 /*
1843  * Struct to save values in before executing autocommands for a buffer that is
1844  * not the current buffer.
1845  */
1846 typedef struct
1847 {
1848     buf_T	*save_buf;	/* saved curbuf */
1849     buf_T	*new_curbuf;	/* buffer to be used */
1850     win_T	*save_curwin;	/* saved curwin, NULL if it didn't change */
1851     win_T	*new_curwin;	/* new curwin if save_curwin != NULL */
1852     pos_T	save_cursor;	/* saved cursor pos of save_curwin */
1853     linenr_T	save_topline;	/* saved topline of save_curwin */
1854 #ifdef FEAT_DIFF
1855     int		save_topfill;	/* saved topfill of save_curwin */
1856 #endif
1857 } aco_save_T;
1858 
1859 /*
1860  * Generic option table item, only used for printer at the moment.
1861  */
1862 typedef struct
1863 {
1864     const char	*name;
1865     int		hasnum;
1866     long	number;
1867     char_u	*string;	/* points into option string */
1868     int		strlen;
1869     int		present;
1870 } option_table_T;
1871 
1872 /*
1873  * Structure to hold printing color and font attributes.
1874  */
1875 typedef struct
1876 {
1877     long_u	fg_color;
1878     long_u	bg_color;
1879     int		bold;
1880     int		italic;
1881     int		underline;
1882 } prt_text_attr_T;
1883 
1884 /*
1885  * Structure passed back to the generic printer code.
1886  */
1887 typedef struct
1888 {
1889     int		n_collated_copies;
1890     int		n_uncollated_copies;
1891     int		duplex;
1892     int		chars_per_line;
1893     int		lines_per_page;
1894     int		has_color;
1895     prt_text_attr_T number;
1896 #ifdef FEAT_SYN_HL
1897     int		modec;
1898     int		do_syntax;
1899 #endif
1900     int		user_abort;
1901     char_u	*jobname;
1902 #ifdef FEAT_POSTSCRIPT
1903     char_u	*outfile;
1904     char_u	*arguments;
1905 #endif
1906 } prt_settings_T;
1907 
1908 #define PRINT_NUMBER_WIDTH 8
1909