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