xref: /vim-8.2.3635/src/structs.h (revision c3d2c447)
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 int		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(l, c, ca) {l, c, ca}
37 #else
38 # define INIT_POS_T(l, c, ca) {l, c}
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_maxlen;		    /* maximum number of items possible */
59     int	    ga_itemsize;	    /* sizeof(item) */
60     int	    ga_growsize;	    /* number of items to grow each time */
61     void    *ga_data;		    /* pointer to the first item */
62 } garray_T;
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_S		win_T;
72 typedef struct wininfo_S	wininfo_T;
73 typedef struct frame_S		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	/* 'foldnestmax' */
155 # ifdef FEAT_EVAL
156     char_u	*wo_fde;
157 # define w_p_fde w_onebuf_opt.wo_fde	/* 'foldexpr' */
158     char_u	*wo_fdt;
159 #  define w_p_fdt w_onebuf_opt.wo_fdt	/* 'foldtext' */
160 # endif
161     char_u	*wo_fmr;
162 # define w_p_fmr w_onebuf_opt.wo_fmr	/* 'foldmarker' */
163 #endif
164 #ifdef FEAT_LINEBREAK
165     int		wo_lbr;
166 # define w_p_lbr w_onebuf_opt.wo_lbr	/* 'linebreak' */
167 #endif
168     int		wo_list;
169 #define w_p_list w_onebuf_opt.wo_list	/* 'list' */
170     int		wo_nu;
171 #define w_p_nu w_onebuf_opt.wo_nu	/* 'number' */
172     int		wo_rnu;
173 #define w_p_rnu w_onebuf_opt.wo_rnu	/* 'relativenumber' */
174 #ifdef FEAT_LINEBREAK
175     long	wo_nuw;
176 # define w_p_nuw w_onebuf_opt.wo_nuw	/* 'numberwidth' */
177 #endif
178 #if defined(FEAT_WINDOWS)
179     int		wo_wfh;
180 # define w_p_wfh w_onebuf_opt.wo_wfh	/* 'winfixheight' */
181     int		wo_wfw;
182 # define w_p_wfw w_onebuf_opt.wo_wfw	/* 'winfixwidth' */
183 #endif
184 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
185     int		wo_pvw;
186 # define w_p_pvw w_onebuf_opt.wo_pvw	/* 'previewwindow' */
187 #endif
188 #ifdef FEAT_RIGHTLEFT
189     int		wo_rl;
190 # define w_p_rl w_onebuf_opt.wo_rl	/* 'rightleft' */
191     char_u	*wo_rlc;
192 # define w_p_rlc w_onebuf_opt.wo_rlc	/* 'rightleftcmd' */
193 #endif
194     long	wo_scr;
195 #define w_p_scr w_onebuf_opt.wo_scr	/* 'scroll' */
196 #ifdef FEAT_SPELL
197     int		wo_spell;
198 # define w_p_spell w_onebuf_opt.wo_spell /* 'spell' */
199 #endif
200 #ifdef FEAT_SYN_HL
201     int		wo_cuc;
202 # define w_p_cuc w_onebuf_opt.wo_cuc	/* 'cursorcolumn' */
203     int		wo_cul;
204 # define w_p_cul w_onebuf_opt.wo_cul	/* 'cursorline' */
205     char_u	*wo_cc;
206 # define w_p_cc w_onebuf_opt.wo_cc	/* 'colorcolumn' */
207 #endif
208 #ifdef FEAT_STL_OPT
209     char_u	*wo_stl;
210 #define w_p_stl w_onebuf_opt.wo_stl	/* 'statusline' */
211 #endif
212 #ifdef FEAT_SCROLLBIND
213     int		wo_scb;
214 # define w_p_scb w_onebuf_opt.wo_scb	/* 'scrollbind' */
215 #endif
216     int		wo_wrap;
217 #define w_p_wrap w_onebuf_opt.wo_wrap	/* 'wrap' */
218 #ifdef FEAT_CONCEAL
219     char_u	*wo_cocu;		/* 'concealcursor' */
220 # define w_p_cocu w_onebuf_opt.wo_cocu
221     long	wo_cole;		/* 'conceallevel' */
222 # define w_p_cole w_onebuf_opt.wo_cole
223 #endif
224 #ifdef FEAT_CURSORBIND
225     int		wo_crb;
226 # define w_p_crb w_onebuf_opt.wo_crb	/* 'cursorbind' */
227 #endif
228 
229 #ifdef FEAT_EVAL
230     int		wo_scriptID[WV_COUNT];	/* SIDs for window-local options */
231 # define w_p_scriptID w_onebuf_opt.wo_scriptID
232 #endif
233 } winopt_T;
234 
235 /*
236  * Window info stored with a buffer.
237  *
238  * Two types of info are kept for a buffer which are associated with a
239  * specific window:
240  * 1. Each window can have a different line number associated with a buffer.
241  * 2. The window-local options for a buffer work in a similar way.
242  * The window-info is kept in a list at b_wininfo.  It is kept in
243  * most-recently-used order.
244  */
245 struct wininfo_S
246 {
247     wininfo_T	*wi_next;	/* next entry or NULL for last entry */
248     wininfo_T	*wi_prev;	/* previous entry or NULL for first entry */
249     win_T	*wi_win;	/* pointer to window that did set wi_fpos */
250     pos_T	wi_fpos;	/* last cursor position in the file */
251     int		wi_optset;	/* TRUE when wi_opt has useful values */
252     winopt_T	wi_opt;		/* local window options */
253 #ifdef FEAT_FOLDING
254     int		wi_fold_manual;	/* copy of w_fold_manual */
255     garray_T	wi_folds;	/* clone of w_folds */
256 #endif
257 };
258 
259 /*
260  * Info used to pass info about a fold from the fold-detection code to the
261  * code that displays the foldcolumn.
262  */
263 typedef struct foldinfo
264 {
265     int		fi_level;	/* level of the fold; when this is zero the
266 				   other fields are invalid */
267     int		fi_lnum;	/* line number where fold starts */
268     int		fi_low_level;	/* lowest fold level that starts in the same
269 				   line */
270 } foldinfo_T;
271 
272 /* Structure to store info about the Visual area. */
273 typedef struct
274 {
275     pos_T	vi_start;	/* start pos of last VIsual */
276     pos_T	vi_end;		/* end position of last VIsual */
277     int		vi_mode;	/* VIsual_mode of last VIsual */
278     colnr_T	vi_curswant;	/* MAXCOL from w_curswant */
279 } visualinfo_T;
280 
281 /*
282  * structures used for undo
283  */
284 
285 typedef struct u_entry u_entry_T;
286 typedef struct u_header u_header_T;
287 struct u_entry
288 {
289     u_entry_T	*ue_next;	/* pointer to next entry in list */
290     linenr_T	ue_top;		/* number of line above undo block */
291     linenr_T	ue_bot;		/* number of line below undo block */
292     linenr_T	ue_lcount;	/* linecount when u_save called */
293     char_u	**ue_array;	/* array of lines in undo block */
294     long	ue_size;	/* number of lines in ue_array */
295 #ifdef U_DEBUG
296     int		ue_magic;	/* magic number to check allocation */
297 #endif
298 };
299 
300 struct u_header
301 {
302     /* The following have a pointer and a number. The number is used when
303      * reading the undo file in u_read_undo() */
304     union {
305 	u_header_T *ptr;	/* pointer to next undo header in list */
306 	long	   seq;
307     } uh_next;
308     union {
309 	u_header_T *ptr;	/* pointer to previous header in list */
310 	long	   seq;
311     } uh_prev;
312     union {
313 	u_header_T *ptr;	/* pointer to next header for alt. redo */
314 	long	   seq;
315     } uh_alt_next;
316     union {
317 	u_header_T *ptr;	/* pointer to previous header for alt. redo */
318 	long	   seq;
319     } uh_alt_prev;
320     long	uh_seq;		/* sequence number, higher == newer undo */
321     int		uh_walk;	/* used by undo_time() */
322     u_entry_T	*uh_entry;	/* pointer to first entry */
323     u_entry_T	*uh_getbot_entry; /* pointer to where ue_bot must be set */
324     pos_T	uh_cursor;	/* cursor position before saving */
325 #ifdef FEAT_VIRTUALEDIT
326     long	uh_cursor_vcol;
327 #endif
328     int		uh_flags;	/* see below */
329     pos_T	uh_namedm[NMARKS];	/* marks before undo/after redo */
330 #ifdef FEAT_VISUAL
331     visualinfo_T uh_visual;	/* Visual areas before undo/after redo */
332 #endif
333     time_t	uh_time;	/* timestamp when the change was made */
334     long	uh_save_nr;	/* set when the file was saved after the
335 				   changes in this block */
336 #ifdef U_DEBUG
337     int		uh_magic;	/* magic number to check allocation */
338 #endif
339 };
340 
341 /* values for uh_flags */
342 #define UH_CHANGED  0x01	/* b_changed flag before undo/after redo */
343 #define UH_EMPTYBUF 0x02	/* buffer was empty */
344 
345 /*
346  * structures used in undo.c
347  */
348 #if SIZEOF_INT > 2
349 # define ALIGN_LONG	/* longword alignment and use filler byte */
350 # define ALIGN_SIZE (sizeof(long))
351 #else
352 # define ALIGN_SIZE (sizeof(short))
353 #endif
354 
355 #define ALIGN_MASK (ALIGN_SIZE - 1)
356 
357 typedef struct m_info minfo_T;
358 
359 /*
360  * structure used to link chunks in one of the free chunk lists.
361  */
362 struct m_info
363 {
364 #ifdef ALIGN_LONG
365     long_u	m_size;		/* size of the chunk (including m_info) */
366 #else
367     short_u	m_size;		/* size of the chunk (including m_info) */
368 #endif
369     minfo_T	*m_next;	/* pointer to next free chunk in the list */
370 };
371 
372 /*
373  * things used in memfile.c
374  */
375 
376 typedef struct block_hdr    bhdr_T;
377 typedef struct memfile	    memfile_T;
378 typedef long		    blocknr_T;
379 
380 /*
381  * for each (previously) used block in the memfile there is one block header.
382  *
383  * The block may be linked in the used list OR in the free list.
384  * The used blocks are also kept in hash lists.
385  *
386  * The used list is a doubly linked list, most recently used block first.
387  *	The blocks in the used list have a block of memory allocated.
388  *	mf_used_count is the number of pages in the used list.
389  * The hash lists are used to quickly find a block in the used list.
390  * The free list is a single linked list, not sorted.
391  *	The blocks in the free list have no block of memory allocated and
392  *	the contents of the block in the file (if any) is irrelevant.
393  */
394 
395 struct block_hdr
396 {
397     bhdr_T	*bh_next;	    /* next block_hdr in free or used list */
398     bhdr_T	*bh_prev;	    /* previous block_hdr in used list */
399     bhdr_T	*bh_hash_next;	    /* next block_hdr in hash list */
400     bhdr_T	*bh_hash_prev;	    /* previous block_hdr in hash list */
401     blocknr_T	bh_bnum;	    /* block number */
402     char_u	*bh_data;	    /* pointer to memory (for used block) */
403     int		bh_page_count;	    /* number of pages in this block */
404 
405 #define BH_DIRTY    1
406 #define BH_LOCKED   2
407     char	bh_flags;	    /* BH_DIRTY or BH_LOCKED */
408 };
409 
410 /*
411  * when a block with a negative number is flushed to the file, it gets
412  * a positive number. Because the reference to the block is still the negative
413  * number, we remember the translation to the new positive number in the
414  * double linked trans lists. The structure is the same as the hash lists.
415  */
416 typedef struct nr_trans NR_TRANS;
417 
418 struct nr_trans
419 {
420     NR_TRANS	*nt_next;		/* next nr_trans in hash list */
421     NR_TRANS	*nt_prev;		/* previous nr_trans in hash list */
422     blocknr_T	nt_old_bnum;		/* old, negative, number */
423     blocknr_T	nt_new_bnum;		/* new, positive, number */
424 };
425 
426 /*
427  * structure used to store one block of the stuff/redo/recording buffers
428  */
429 struct buffblock
430 {
431     struct buffblock	*b_next;	/* pointer to next buffblock */
432     char_u		b_str[1];	/* contents (actually longer) */
433 };
434 
435 /*
436  * header used for the stuff buffer and the redo buffer
437  */
438 struct buffheader
439 {
440     struct buffblock	bh_first;	/* first (dummy) block of list */
441     struct buffblock	*bh_curr;	/* buffblock for appending */
442     int			bh_index;	/* index for reading */
443     int			bh_space;	/* space in bh_curr for appending */
444 };
445 
446 /*
447  * used for completion on the command line
448  */
449 typedef struct expand
450 {
451     int		xp_context;		/* type of expansion */
452     char_u	*xp_pattern;		/* start of item to expand */
453     int		xp_pattern_len;		/* bytes in xp_pattern before cursor */
454 #if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
455     char_u	*xp_arg;		/* completion function */
456     int		xp_scriptID;		/* SID for completion function */
457 #endif
458     int		xp_backslash;		/* one of the XP_BS_ values */
459 #ifndef BACKSLASH_IN_FILENAME
460     int		xp_shell;		/* for a shell command more characters
461 					   need to be escaped */
462 #endif
463     int		xp_numfiles;		/* number of files found by
464 						    file name completion */
465     char_u	**xp_files;		/* list of files */
466 } expand_T;
467 
468 /* values for xp_backslash */
469 #define XP_BS_NONE	0	/* nothing special for backslashes */
470 #define XP_BS_ONE	1	/* uses one backslash before a space */
471 #define XP_BS_THREE	2	/* uses three backslashes before a space */
472 
473 /*
474  * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
475  * This needs to be saved for recursive commands, put them in a structure for
476  * easy manipulation.
477  */
478 typedef struct
479 {
480     int		hide;			/* TRUE when ":hide" was used */
481 # ifdef FEAT_BROWSE_CMD
482     int		browse;			/* TRUE to invoke file dialog */
483 # endif
484 # ifdef FEAT_WINDOWS
485     int		split;			/* flags for win_split() */
486     int		tab;			/* > 0 when ":tab" was used */
487 # endif
488 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
489     int		confirm;		/* TRUE to invoke yes/no dialog */
490 # endif
491     int		keepalt;		/* TRUE when ":keepalt" was used */
492     int		keepmarks;		/* TRUE when ":keepmarks" was used */
493     int		keepjumps;		/* TRUE when ":keepjumps" was used */
494     int		lockmarks;		/* TRUE when ":lockmarks" was used */
495 # ifdef FEAT_AUTOCMD
496     char_u	*save_ei;		/* saved value of 'eventignore' */
497 # endif
498 } cmdmod_T;
499 
500 typedef struct file_buffer buf_T;  /* forward declaration */
501 
502 /*
503  * Simplistic hashing scheme to quickly locate the blocks in the used list.
504  * 64 blocks are found directly (64 * 4K = 256K, most files are smaller).
505  */
506 #define MEMHASHSIZE	64
507 #define MEMHASH(nr)	((nr) & (MEMHASHSIZE - 1))
508 #define MF_SEED_LEN	8
509 
510 struct memfile
511 {
512     char_u	*mf_fname;		/* name of the file */
513     char_u	*mf_ffname;		/* idem, full path */
514     int		mf_fd;			/* file descriptor */
515     bhdr_T	*mf_free_first;		/* first block_hdr in free list */
516     bhdr_T	*mf_used_first;		/* mru block_hdr in used list */
517     bhdr_T	*mf_used_last;		/* lru block_hdr in used list */
518     unsigned	mf_used_count;		/* number of pages in used list */
519     unsigned	mf_used_count_max;	/* maximum number of pages in memory */
520     bhdr_T	*mf_hash[MEMHASHSIZE];	/* array of hash lists */
521     NR_TRANS	*mf_trans[MEMHASHSIZE];	/* array of trans lists */
522     blocknr_T	mf_blocknr_max;		/* highest positive block number + 1*/
523     blocknr_T	mf_blocknr_min;		/* lowest negative block number - 1 */
524     blocknr_T	mf_neg_count;		/* number of negative blocks numbers */
525     blocknr_T	mf_infile_count;	/* number of pages in the file */
526     unsigned	mf_page_size;		/* number of bytes in a page */
527     int		mf_dirty;		/* TRUE if there are dirty blocks */
528 #ifdef FEAT_CRYPT
529     buf_T	*mf_buffer;		/* bufer this memfile is for */
530     char_u	mf_seed[MF_SEED_LEN];	/* seed for encryption */
531 
532     /* Values for key, method and seed used for reading data blocks when
533      * updating for a newly set key or method. Only when mf_old_key != NULL. */
534     char_u	*mf_old_key;
535     int		mf_old_cm;
536     char_u	mf_old_seed[MF_SEED_LEN];
537 #endif
538 };
539 
540 /*
541  * things used in memline.c
542  */
543 /*
544  * When searching for a specific line, we remember what blocks in the tree
545  * are the branches leading to that block. This is stored in ml_stack.  Each
546  * entry is a pointer to info in a block (may be data block or pointer block)
547  */
548 typedef struct info_pointer
549 {
550     blocknr_T	ip_bnum;	/* block number */
551     linenr_T	ip_low;		/* lowest lnum in this block */
552     linenr_T	ip_high;	/* highest lnum in this block */
553     int		ip_index;	/* index for block with current lnum */
554 } infoptr_T;	/* block/index pair */
555 
556 #ifdef FEAT_BYTEOFF
557 typedef struct ml_chunksize
558 {
559     int		mlcs_numlines;
560     long	mlcs_totalsize;
561 } chunksize_T;
562 
563  /* Flags when calling ml_updatechunk() */
564 
565 #define ML_CHNK_ADDLINE 1
566 #define ML_CHNK_DELLINE 2
567 #define ML_CHNK_UPDLINE 3
568 #endif
569 
570 /*
571  * the memline structure holds all the information about a memline
572  */
573 typedef struct memline
574 {
575     linenr_T	ml_line_count;	/* number of lines in the buffer */
576 
577     memfile_T	*ml_mfp;	/* pointer to associated memfile */
578 
579 #define ML_EMPTY	1	/* empty buffer */
580 #define ML_LINE_DIRTY	2	/* cached line was changed and allocated */
581 #define ML_LOCKED_DIRTY	4	/* ml_locked was changed */
582 #define ML_LOCKED_POS	8	/* ml_locked needs positive block number */
583     int		ml_flags;
584 
585     infoptr_T	*ml_stack;	/* stack of pointer blocks (array of IPTRs) */
586     int		ml_stack_top;	/* current top if ml_stack */
587     int		ml_stack_size;	/* total number of entries in ml_stack */
588 
589     linenr_T	ml_line_lnum;	/* line number of cached line, 0 if not valid */
590     char_u	*ml_line_ptr;	/* pointer to cached line */
591 
592     bhdr_T	*ml_locked;	/* block used by last ml_get */
593     linenr_T	ml_locked_low;	/* first line in ml_locked */
594     linenr_T	ml_locked_high;	/* last line in ml_locked */
595     int		ml_locked_lineadd;  /* number of lines inserted in ml_locked */
596 #ifdef FEAT_BYTEOFF
597     chunksize_T *ml_chunksize;
598     int		ml_numchunks;
599     int		ml_usedchunks;
600 #endif
601 } memline_T;
602 
603 #if defined(FEAT_SIGNS) || defined(PROTO)
604 typedef struct signlist signlist_T;
605 
606 struct signlist
607 {
608     int		id;		/* unique identifier for each placed sign */
609     linenr_T	lnum;		/* line number which has this sign */
610     int		typenr;		/* typenr of sign */
611     signlist_T	*next;		/* next signlist entry */
612 # ifdef FEAT_NETBEANS_INTG
613     signlist_T  *prev;		/* previous entry -- for easy reordering */
614 # endif
615 };
616 
617 /* type argument for buf_getsigntype() */
618 #define SIGN_ANY	0
619 #define SIGN_LINEHL	1
620 #define SIGN_ICON	2
621 #define SIGN_TEXT	3
622 #endif
623 
624 /*
625  * Argument list: Array of file names.
626  * Used for the global argument list and the argument lists local to a window.
627  */
628 typedef struct arglist
629 {
630     garray_T	al_ga;		/* growarray with the array of file names */
631     int		al_refcount;	/* number of windows using this arglist */
632 } alist_T;
633 
634 /*
635  * For each argument remember the file name as it was given, and the buffer
636  * number that contains the expanded file name (required for when ":cd" is
637  * used.
638  */
639 typedef struct argentry
640 {
641     char_u	*ae_fname;	/* file name as specified */
642     int		ae_fnum;	/* buffer number with expanded file name */
643 } aentry_T;
644 
645 #ifdef FEAT_WINDOWS
646 # define ALIST(win) (win)->w_alist
647 #else
648 # define ALIST(win) (&global_alist)
649 #endif
650 #define GARGLIST	((aentry_T *)global_alist.al_ga.ga_data)
651 #define ARGLIST		((aentry_T *)ALIST(curwin)->al_ga.ga_data)
652 #define WARGLIST(wp)	((aentry_T *)ALIST(wp)->al_ga.ga_data)
653 #define AARGLIST(al)	((aentry_T *)((al)->al_ga.ga_data))
654 #define GARGCOUNT	(global_alist.al_ga.ga_len)
655 #define ARGCOUNT	(ALIST(curwin)->al_ga.ga_len)
656 #define WARGCOUNT(wp)	(ALIST(wp)->al_ga.ga_len)
657 
658 /*
659  * A list used for saving values of "emsg_silent".  Used by ex_try() to save the
660  * value of "emsg_silent" if it was non-zero.  When this is done, the CSF_SILENT
661  * flag below is set.
662  */
663 
664 typedef struct eslist_elem eslist_T;
665 struct eslist_elem
666 {
667     int		saved_emsg_silent;	/* saved value of "emsg_silent" */
668     eslist_T	*next;			/* next element on the list */
669 };
670 
671 /*
672  * For conditional commands a stack is kept of nested conditionals.
673  * When cs_idx < 0, there is no conditional command.
674  */
675 #define CSTACK_LEN	50
676 
677 struct condstack
678 {
679     short	cs_flags[CSTACK_LEN];	/* CSF_ flags */
680     char	cs_pending[CSTACK_LEN];	/* CSTP_: what's pending in ":finally"*/
681     union {
682 	void	*csp_rv[CSTACK_LEN];	/* return typeval for pending return */
683 	void	*csp_ex[CSTACK_LEN];	/* exception for pending throw */
684     }		cs_pend;
685     void	*cs_forinfo[CSTACK_LEN]; /* info used by ":for" */
686     int		cs_line[CSTACK_LEN];	/* line nr of ":while"/":for" line */
687     int		cs_idx;			/* current entry, or -1 if none */
688     int		cs_looplevel;		/* nr of nested ":while"s and ":for"s */
689     int		cs_trylevel;		/* nr of nested ":try"s */
690     eslist_T	*cs_emsg_silent_list;	/* saved values of "emsg_silent" */
691     char	cs_lflags;		/* loop flags: CSL_ flags */
692 };
693 # define cs_rettv	cs_pend.csp_rv
694 # define cs_exception	cs_pend.csp_ex
695 
696 /* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
697  * was used. */
698 # define CSF_TRUE	0x0001	/* condition was TRUE */
699 # define CSF_ACTIVE	0x0002	/* current state is active */
700 # define CSF_ELSE	0x0004	/* ":else" has been passed */
701 # define CSF_WHILE	0x0008	/* is a ":while" */
702 # define CSF_FOR	0x0010	/* is a ":for" */
703 
704 # define CSF_TRY	0x0100	/* is a ":try" */
705 # define CSF_FINALLY	0x0200	/* ":finally" has been passed */
706 # define CSF_THROWN	0x0400	/* exception thrown to this try conditional */
707 # define CSF_CAUGHT	0x0800  /* exception caught by this try conditional */
708 # define CSF_SILENT	0x1000	/* "emsg_silent" reset by ":try" */
709 /* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
710  * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
711 
712 /*
713  * What's pending for being reactivated at the ":endtry" of this try
714  * conditional:
715  */
716 # define CSTP_NONE	0	/* nothing pending in ":finally" clause */
717 # define CSTP_ERROR	1	/* an error is pending */
718 # define CSTP_INTERRUPT	2	/* an interrupt is pending */
719 # define CSTP_THROW	4	/* a throw is pending */
720 # define CSTP_BREAK	8	/* ":break" is pending */
721 # define CSTP_CONTINUE	16	/* ":continue" is pending */
722 # define CSTP_RETURN	24	/* ":return" is pending */
723 # define CSTP_FINISH	32	/* ":finish" is pending */
724 
725 /*
726  * Flags for the cs_lflags item in struct condstack.
727  */
728 # define CSL_HAD_LOOP	 1	/* just found ":while" or ":for" */
729 # define CSL_HAD_ENDLOOP 2	/* just found ":endwhile" or ":endfor" */
730 # define CSL_HAD_CONT	 4	/* just found ":continue" */
731 # define CSL_HAD_FINA	 8	/* just found ":finally" */
732 
733 /*
734  * A list of error messages that can be converted to an exception.  "throw_msg"
735  * is only set in the first element of the list.  Usually, it points to the
736  * original message stored in that element, but sometimes it points to a later
737  * message in the list.  See cause_errthrow() below.
738  */
739 struct msglist
740 {
741     char_u		*msg;		/* original message */
742     char_u		*throw_msg;	/* msg to throw: usually original one */
743     struct msglist	*next;		/* next of several messages in a row */
744 };
745 
746 /*
747  * Structure describing an exception.
748  * (don't use "struct exception", it's used by the math library).
749  */
750 typedef struct vim_exception except_T;
751 struct vim_exception
752 {
753     int			type;		/* exception type */
754     char_u		*value;		/* exception value */
755     struct msglist	*messages;	/* message(s) causing error exception */
756     char_u		*throw_name;	/* name of the throw point */
757     linenr_T		throw_lnum;	/* line number of the throw point */
758     except_T		*caught;	/* next exception on the caught stack */
759 };
760 
761 /*
762  * The exception types.
763  */
764 #define ET_USER		0	/* exception caused by ":throw" command */
765 #define ET_ERROR	1	/* error exception */
766 #define ET_INTERRUPT	2	/* interrupt exception triggered by Ctrl-C */
767 
768 /*
769  * Structure to save the error/interrupt/exception state between calls to
770  * enter_cleanup() and leave_cleanup().  Must be allocated as an automatic
771  * variable by the (common) caller of these functions.
772  */
773 typedef struct cleanup_stuff cleanup_T;
774 struct cleanup_stuff
775 {
776     int pending;		/* error/interrupt/exception state */
777     except_T *exception;	/* exception value */
778 };
779 
780 #ifdef FEAT_SYN_HL
781 /* struct passed to in_id_list() */
782 struct sp_syn
783 {
784     int		inc_tag;	/* ":syn include" unique tag */
785     short	id;		/* highlight group ID of item */
786     short	*cont_in_list;	/* cont.in group IDs, if non-zero */
787 };
788 
789 /*
790  * Each keyword has one keyentry, which is linked in a hash list.
791  */
792 typedef struct keyentry keyentry_T;
793 
794 struct keyentry
795 {
796     keyentry_T	*ke_next;	/* next entry with identical "keyword[]" */
797     struct sp_syn k_syn;	/* struct passed to in_id_list() */
798     short	*next_list;	/* ID list for next match (if non-zero) */
799     int		flags;
800     int		k_char;		/* conceal substitute character */
801     char_u	keyword[1];	/* actually longer */
802 };
803 
804 /*
805  * Struct used to store one state of the state stack.
806  */
807 typedef struct buf_state
808 {
809     int		    bs_idx;	 /* index of pattern */
810     int		    bs_flags;	 /* flags for pattern */
811 #ifdef FEAT_CONCEAL
812     int		    bs_seqnr;	 /* stores si_seqnr */
813     int		    bs_cchar;	 /* stores si_cchar */
814 #endif
815     reg_extmatch_T *bs_extmatch; /* external matches from start pattern */
816 } bufstate_T;
817 
818 /*
819  * syn_state contains the syntax state stack for the start of one line.
820  * Used by b_sst_array[].
821  */
822 typedef struct syn_state synstate_T;
823 
824 struct syn_state
825 {
826     synstate_T	*sst_next;	/* next entry in used or free list */
827     linenr_T	sst_lnum;	/* line number for this state */
828     union
829     {
830 	bufstate_T	sst_stack[SST_FIX_STATES]; /* short state stack */
831 	garray_T	sst_ga;	/* growarray for long state stack */
832     } sst_union;
833     int		sst_next_flags;	/* flags for sst_next_list */
834     int		sst_stacksize;	/* number of states on the stack */
835     short	*sst_next_list;	/* "nextgroup" list in this state
836 				 * (this is a copy, don't free it! */
837     disptick_T	sst_tick;	/* tick when last displayed */
838     linenr_T	sst_change_lnum;/* when non-zero, change in this line
839 				 * may have made the state invalid */
840 };
841 #endif /* FEAT_SYN_HL */
842 
843 /*
844  * Structure shared between syntax.c, screen.c and gui_x11.c.
845  */
846 typedef struct attr_entry
847 {
848     short	    ae_attr;		/* HL_BOLD, etc. */
849     union
850     {
851 	struct
852 	{
853 	    char_u	    *start;	/* start escape sequence */
854 	    char_u	    *stop;	/* stop escape sequence */
855 	} term;
856 	struct
857 	{
858 	    /* These colors need to be > 8 bits to hold 256. */
859 	    short_u	    fg_color;	/* foreground color number */
860 	    short_u	    bg_color;	/* background color number */
861 	} cterm;
862 # ifdef FEAT_GUI
863 	struct
864 	{
865 	    guicolor_T	    fg_color;	/* foreground color handle */
866 	    guicolor_T	    bg_color;	/* background color handle */
867 	    guicolor_T	    sp_color;	/* special color handle */
868 	    GuiFont	    font;	/* font handle */
869 #  ifdef FEAT_XFONTSET
870 	    GuiFontset	    fontset;	/* fontset handle */
871 #  endif
872 	} gui;
873 # endif
874     } ae_u;
875 } attrentry_T;
876 
877 #ifdef USE_ICONV
878 # ifdef HAVE_ICONV_H
879 #  include <iconv.h>
880 # else
881 #  if defined(MACOS_X)
882 #   include <sys/errno.h>
883 #   define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
884 typedef struct _iconv_t *iconv_t;
885 #  else
886 #   if defined(MACOS_CLASSIC)
887 typedef struct _iconv_t *iconv_t;
888 #    define EINVAL	22
889 #    define E2BIG	7
890 #    define ENOENT	2
891 #    define EFAULT	14
892 #    define EILSEQ	123
893 #   else
894 #    include <errno.h>
895 #   endif
896 #  endif
897 typedef void *iconv_t;
898 # endif
899 #endif
900 
901 /*
902  * Used for the typeahead buffer: typebuf.
903  */
904 typedef struct
905 {
906     char_u	*tb_buf;	/* buffer for typed characters */
907     char_u	*tb_noremap;	/* mapping flags for characters in tb_buf[] */
908     int		tb_buflen;	/* size of tb_buf[] */
909     int		tb_off;		/* current position in tb_buf[] */
910     int		tb_len;		/* number of valid bytes in tb_buf[] */
911     int		tb_maplen;	/* nr of mapped bytes in tb_buf[] */
912     int		tb_silent;	/* nr of silently mapped bytes in tb_buf[] */
913     int		tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */
914     int		tb_change_cnt;	/* nr of time tb_buf was changed; never zero */
915 } typebuf_T;
916 
917 /* Struct to hold the saved typeahead for save_typeahead(). */
918 typedef struct
919 {
920     typebuf_T		save_typebuf;
921     int			typebuf_valid;	    /* TRUE when save_typebuf valid */
922     int			old_char;
923     int			old_mod_mask;
924     struct buffheader	save_stuffbuff;
925 #ifdef USE_INPUT_BUF
926     char_u		*save_inputbuf;
927 #endif
928 } tasave_T;
929 
930 /*
931  * Used for conversion of terminal I/O and script files.
932  */
933 typedef struct
934 {
935     int		vc_type;	/* zero or one of the CONV_ values */
936     int		vc_factor;	/* max. expansion factor */
937 # ifdef WIN3264
938     int		vc_cpfrom;	/* codepage to convert from (CONV_CODEPAGE) */
939     int		vc_cpto;	/* codepage to convert to (CONV_CODEPAGE) */
940 # endif
941 # ifdef USE_ICONV
942     iconv_t	vc_fd;		/* for CONV_ICONV */
943 # endif
944     int		vc_fail;	/* fail for invalid char, don't use '?' */
945 } vimconv_T;
946 
947 /*
948  * Structure used for reading from the viminfo file.
949  */
950 typedef struct
951 {
952     char_u	*vir_line;	/* text of the current line */
953     FILE	*vir_fd;	/* file descriptor */
954 #ifdef FEAT_MBYTE
955     vimconv_T	vir_conv;	/* encoding conversion */
956 #endif
957 } vir_T;
958 
959 #define CONV_NONE		0
960 #define CONV_TO_UTF8		1
961 #define CONV_9_TO_UTF8		2
962 #define CONV_TO_LATIN1		3
963 #define CONV_TO_LATIN9		4
964 #define CONV_ICONV		5
965 #ifdef WIN3264
966 # define CONV_CODEPAGE		10	/* codepage -> codepage */
967 #endif
968 #ifdef MACOS_X
969 # define CONV_MAC_LATIN1	20
970 # define CONV_LATIN1_MAC	21
971 # define CONV_MAC_UTF8		22
972 # define CONV_UTF8_MAC		23
973 #endif
974 
975 /*
976  * Structure used for mappings and abbreviations.
977  */
978 typedef struct mapblock mapblock_T;
979 struct mapblock
980 {
981     mapblock_T	*m_next;	/* next mapblock in list */
982     char_u	*m_keys;	/* mapped from */
983     int		m_keylen;	/* strlen(m_keys) */
984     char_u	*m_str;		/* mapped to */
985     int		m_mode;		/* valid mode */
986     int		m_noremap;	/* if non-zero no re-mapping for m_str */
987     char	m_silent;	/* <silent> used, don't echo commands */
988 #ifdef FEAT_EVAL
989     char	m_expr;		/* <expr> used, m_str is an expression */
990     scid_T	m_script_ID;	/* ID of script where map was defined */
991 #endif
992 };
993 
994 /*
995  * Used for highlighting in the status line.
996  */
997 struct stl_hlrec
998 {
999     char_u	*start;
1000     int		userhl;		/* 0: no HL, 1-9: User HL, < 0 for syn ID */
1001 };
1002 
1003 
1004 /*
1005  * Syntax items - usually buffer-specific.
1006  */
1007 
1008 /* Item for a hashtable.  "hi_key" can be one of three values:
1009  * NULL:	   Never been used
1010  * HI_KEY_REMOVED: Entry was removed
1011  * Otherwise:	   Used item, pointer to the actual key; this usually is
1012  *		   inside the item, subtract an offset to locate the item.
1013  *		   This reduces the size of hashitem by 1/3.
1014  */
1015 typedef struct hashitem_S
1016 {
1017     long_u	hi_hash;	/* cached hash number of hi_key */
1018     char_u	*hi_key;
1019 } hashitem_T;
1020 
1021 /* The address of "hash_removed" is used as a magic number for hi_key to
1022  * indicate a removed item. */
1023 #define HI_KEY_REMOVED &hash_removed
1024 #define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
1025 
1026 /* Initial size for a hashtable.  Our items are relatively small and growing
1027  * is expensive, thus use 16 as a start.  Must be a power of 2. */
1028 #define HT_INIT_SIZE 16
1029 
1030 typedef struct hashtable_S
1031 {
1032     long_u	ht_mask;	/* mask used for hash value (nr of items in
1033 				 * array is "ht_mask" + 1) */
1034     long_u	ht_used;	/* number of items used */
1035     long_u	ht_filled;	/* number of items used + removed */
1036     int		ht_locked;	/* counter for hash_lock() */
1037     int		ht_error;	/* when set growing failed, can't add more
1038 				   items before growing works */
1039     hashitem_T	*ht_array;	/* points to the array, allocated when it's
1040 				   not "ht_smallarray" */
1041     hashitem_T	ht_smallarray[HT_INIT_SIZE];   /* initial array */
1042 } hashtab_T;
1043 
1044 typedef long_u hash_T;		/* Type for hi_hash */
1045 
1046 
1047 #if SIZEOF_INT <= 3		/* use long if int is smaller than 32 bits */
1048 typedef long	varnumber_T;
1049 #else
1050 typedef int	varnumber_T;
1051 #endif
1052 typedef double	float_T;
1053 
1054 typedef struct listvar_S list_T;
1055 typedef struct dictvar_S dict_T;
1056 
1057 /*
1058  * Structure to hold an internal variable without a name.
1059  */
1060 typedef struct
1061 {
1062     char	v_type;	    /* see below: VAR_NUMBER, VAR_STRING, etc. */
1063     char	v_lock;	    /* see below: VAR_LOCKED, VAR_FIXED */
1064     union
1065     {
1066 	varnumber_T	v_number;	/* number value */
1067 #ifdef FEAT_FLOAT
1068 	float_T		v_float;	/* floating number value */
1069 #endif
1070 	char_u		*v_string;	/* string value (can be NULL!) */
1071 	list_T		*v_list;	/* list value (can be NULL!) */
1072 	dict_T		*v_dict;	/* dict value (can be NULL!) */
1073     }		vval;
1074 } typval_T;
1075 
1076 /* Values for "v_type". */
1077 #define VAR_UNKNOWN 0
1078 #define VAR_NUMBER  1	/* "v_number" is used */
1079 #define VAR_STRING  2	/* "v_string" is used */
1080 #define VAR_FUNC    3	/* "v_string" is function name */
1081 #define VAR_LIST    4	/* "v_list" is used */
1082 #define VAR_DICT    5	/* "v_dict" is used */
1083 #define VAR_FLOAT   6	/* "v_float" is used */
1084 
1085 /* Values for "v_lock". */
1086 #define VAR_LOCKED  1	/* locked with lock(), can use unlock() */
1087 #define VAR_FIXED   2	/* locked forever */
1088 
1089 /*
1090  * Structure to hold an item of a list: an internal variable without a name.
1091  */
1092 typedef struct listitem_S listitem_T;
1093 
1094 struct listitem_S
1095 {
1096     listitem_T	*li_next;	/* next item in list */
1097     listitem_T	*li_prev;	/* previous item in list */
1098     typval_T	li_tv;		/* type and value of the variable */
1099 };
1100 
1101 /*
1102  * Struct used by those that are using an item in a list.
1103  */
1104 typedef struct listwatch_S listwatch_T;
1105 
1106 struct listwatch_S
1107 {
1108     listitem_T		*lw_item;	/* item being watched */
1109     listwatch_T		*lw_next;	/* next watcher */
1110 };
1111 
1112 /*
1113  * Structure to hold info about a list.
1114  */
1115 struct listvar_S
1116 {
1117     listitem_T	*lv_first;	/* first item, NULL if none */
1118     listitem_T	*lv_last;	/* last item, NULL if none */
1119     int		lv_refcount;	/* reference count */
1120     int		lv_len;		/* number of items */
1121     listwatch_T	*lv_watch;	/* first watcher, NULL if none */
1122     int		lv_idx;		/* cached index of an item */
1123     listitem_T	*lv_idx_item;	/* when not NULL item at index "lv_idx" */
1124     int		lv_copyID;	/* ID used by deepcopy() */
1125     list_T	*lv_copylist;	/* copied list used by deepcopy() */
1126     char	lv_lock;	/* zero, VAR_LOCKED, VAR_FIXED */
1127     list_T	*lv_used_next;	/* next list in used lists list */
1128     list_T	*lv_used_prev;	/* previous list in used lists list */
1129 };
1130 
1131 /*
1132  * Structure to hold an item of a Dictionary.
1133  * Also used for a variable.
1134  * The key is copied into "di_key" to avoid an extra alloc/free for it.
1135  */
1136 struct dictitem_S
1137 {
1138     typval_T	di_tv;		/* type and value of the variable */
1139     char_u	di_flags;	/* flags (only used for variable) */
1140     char_u	di_key[1];	/* key (actually longer!) */
1141 };
1142 
1143 typedef struct dictitem_S dictitem_T;
1144 
1145 #define DI_FLAGS_RO	1 /* "di_flags" value: read-only variable */
1146 #define DI_FLAGS_RO_SBX 2 /* "di_flags" value: read-only in the sandbox */
1147 #define DI_FLAGS_FIX	4 /* "di_flags" value: fixed variable, not allocated */
1148 #define DI_FLAGS_LOCK	8 /* "di_flags" value: locked variable */
1149 
1150 /*
1151  * Structure to hold info about a Dictionary.
1152  */
1153 struct dictvar_S
1154 {
1155     int		dv_refcount;	/* reference count */
1156     hashtab_T	dv_hashtab;	/* hashtab that refers to the items */
1157     int		dv_copyID;	/* ID used by deepcopy() */
1158     dict_T	*dv_copydict;	/* copied dict used by deepcopy() */
1159     char	dv_lock;	/* zero, VAR_LOCKED, VAR_FIXED */
1160     dict_T	*dv_used_next;	/* next dict in used dicts list */
1161     dict_T	*dv_used_prev;	/* previous dict in used dicts list */
1162 };
1163 
1164 /* values for b_syn_spell: what to do with toplevel text */
1165 #define SYNSPL_DEFAULT	0	/* spell check if @Spell not defined */
1166 #define SYNSPL_TOP	1	/* spell check toplevel text */
1167 #define SYNSPL_NOTOP	2	/* don't spell check toplevel text */
1168 
1169 /* avoid #ifdefs for when b_spell is not available */
1170 #ifdef FEAT_SPELL
1171 # define B_SPELL(buf)  ((buf)->b_spell)
1172 #else
1173 # define B_SPELL(buf)  (0)
1174 #endif
1175 
1176 #ifdef FEAT_QUICKFIX
1177 typedef struct qf_info_S qf_info_T;
1178 #endif
1179 
1180 typedef struct {
1181 #ifdef FEAT_SYN_HL
1182     hashtab_T	b_keywtab;		/* syntax keywords hash table */
1183     hashtab_T	b_keywtab_ic;		/* idem, ignore case */
1184     int		b_syn_error;		/* TRUE when error occured in HL */
1185     int		b_syn_ic;		/* ignore case for :syn cmds */
1186     int		b_syn_spell;		/* SYNSPL_ values */
1187     garray_T	b_syn_patterns;		/* table for syntax patterns */
1188     garray_T	b_syn_clusters;		/* table for syntax clusters */
1189     int		b_spell_cluster_id;	/* @Spell cluster ID or 0 */
1190     int		b_nospell_cluster_id;	/* @NoSpell cluster ID or 0 */
1191     int		b_syn_containedin;	/* TRUE when there is an item with a
1192 					   "containedin" argument */
1193     int		b_syn_sync_flags;	/* flags about how to sync */
1194     short	b_syn_sync_id;		/* group to sync on */
1195     long	b_syn_sync_minlines;	/* minimal sync lines offset */
1196     long	b_syn_sync_maxlines;	/* maximal sync lines offset */
1197     long	b_syn_sync_linebreaks;	/* offset for multi-line pattern */
1198     char_u	*b_syn_linecont_pat;	/* line continuation pattern */
1199     regprog_T	*b_syn_linecont_prog;	/* line continuation program */
1200     int		b_syn_linecont_ic;	/* ignore-case flag for above */
1201     int		b_syn_topgrp;		/* for ":syntax include" */
1202 # ifdef FEAT_CONCEAL
1203     int		b_syn_conceal;		/* auto-conceal for :syn cmds */
1204 # endif
1205 # ifdef FEAT_FOLDING
1206     int		b_syn_folditems;	/* number of patterns with the HL_FOLD
1207 					   flag set */
1208 # endif
1209     /*
1210      * b_sst_array[] contains the state stack for a number of lines, for the
1211      * start of that line (col == 0).  This avoids having to recompute the
1212      * syntax state too often.
1213      * b_sst_array[] is allocated to hold the state for all displayed lines,
1214      * and states for 1 out of about 20 other lines.
1215      * b_sst_array	pointer to an array of synstate_T
1216      * b_sst_len	number of entries in b_sst_array[]
1217      * b_sst_first	pointer to first used entry in b_sst_array[] or NULL
1218      * b_sst_firstfree	pointer to first free entry in b_sst_array[] or NULL
1219      * b_sst_freecount	number of free entries in b_sst_array[]
1220      * b_sst_check_lnum	entries after this lnum need to be checked for
1221      *			validity (MAXLNUM means no check needed)
1222      */
1223     synstate_T	*b_sst_array;
1224     int		b_sst_len;
1225     synstate_T	*b_sst_first;
1226     synstate_T	*b_sst_firstfree;
1227     int		b_sst_freecount;
1228     linenr_T	b_sst_check_lnum;
1229     short_u	b_sst_lasttick;	/* last display tick */
1230 #endif /* FEAT_SYN_HL */
1231 
1232 #ifdef FEAT_SPELL
1233     /* for spell checking */
1234     garray_T	b_langp;	/* list of pointers to slang_T, see spell.c */
1235     char_u	b_spell_ismw[256];/* flags: is midword char */
1236 # ifdef FEAT_MBYTE
1237     char_u	*b_spell_ismw_mb; /* multi-byte midword chars */
1238 # endif
1239     char_u	*b_p_spc;	/* 'spellcapcheck' */
1240     regprog_T	*b_cap_prog;	/* program for 'spellcapcheck' */
1241     char_u	*b_p_spf;	/* 'spellfile' */
1242     char_u	*b_p_spl;	/* 'spelllang' */
1243 #endif
1244 #if !defined(FEAT_SYN_HL) && !defined(FEAT_SPELL)
1245     int		dummy;
1246 #endif
1247 } synblock_T;
1248 
1249 
1250 /*
1251  * buffer: structure that holds information about one file
1252  *
1253  * Several windows can share a single Buffer
1254  * A buffer is unallocated if there is no memfile for it.
1255  * A buffer is new if the associated file has never been loaded yet.
1256  */
1257 
1258 struct file_buffer
1259 {
1260     memline_T	b_ml;		/* associated memline (also contains line
1261 				   count) */
1262 
1263     buf_T	*b_next;	/* links in list of buffers */
1264     buf_T	*b_prev;
1265 
1266     int		b_nwindows;	/* nr of windows open on this buffer */
1267 
1268     int		b_flags;	/* various BF_ flags */
1269 
1270     /*
1271      * b_ffname has the full path of the file (NULL for no name).
1272      * b_sfname is the name as the user typed it (or NULL).
1273      * b_fname is the same as b_sfname, unless ":cd" has been done,
1274      *		then it is the same as b_ffname (NULL for no name).
1275      */
1276     char_u	*b_ffname;	/* full path file name */
1277     char_u	*b_sfname;	/* short file name */
1278     char_u	*b_fname;	/* current file name */
1279 
1280 #ifdef UNIX
1281     int		b_dev_valid;	/* TRUE when b_dev has a valid number */
1282     dev_t	b_dev;		/* device number */
1283     ino_t	b_ino;		/* inode number */
1284 #endif
1285 #ifdef FEAT_CW_EDITOR
1286     FSSpec	b_FSSpec;	/* MacOS File Identification */
1287 #endif
1288 #ifdef VMS
1289     char	 b_fab_rfm;	/* Record format    */
1290     char	 b_fab_rat;	/* Record attribute */
1291     unsigned int b_fab_mrs;	/* Max record size  */
1292 #endif
1293 #ifdef FEAT_SNIFF
1294     int		b_sniff;	/* file was loaded through Sniff */
1295 #endif
1296 
1297     int		b_fnum;		/* buffer number for this file. */
1298 
1299     int		b_changed;	/* 'modified': Set to TRUE if something in the
1300 				   file has been changed and not written out. */
1301     int		b_changedtick;	/* incremented for each change, also for undo */
1302 
1303     int		b_saving;	/* Set to TRUE if we are in the middle of
1304 				   saving the buffer. */
1305 
1306     /*
1307      * Changes to a buffer require updating of the display.  To minimize the
1308      * work, remember changes made and update everything at once.
1309      */
1310     int		b_mod_set;	/* TRUE when there are changes since the last
1311 				   time the display was updated */
1312     linenr_T	b_mod_top;	/* topmost lnum that was changed */
1313     linenr_T	b_mod_bot;	/* lnum below last changed line, AFTER the
1314 				   change */
1315     long	b_mod_xlines;	/* number of extra buffer lines inserted;
1316 				   negative when lines were deleted */
1317 
1318     wininfo_T	*b_wininfo;	/* list of last used info for each window */
1319 
1320     long	b_mtime;	/* last change time of original file */
1321     long	b_mtime_read;	/* last change time when reading */
1322     off_t	b_orig_size;	/* size of original file in bytes */
1323     int		b_orig_mode;	/* mode of original file */
1324 
1325     pos_T	b_namedm[NMARKS]; /* current named marks (mark.c) */
1326 
1327 #ifdef FEAT_VISUAL
1328     /* These variables are set when VIsual_active becomes FALSE */
1329     visualinfo_T b_visual;
1330 # ifdef FEAT_EVAL
1331     int		b_visual_mode_eval;  /* b_visual.vi_mode for visualmode() */
1332 # endif
1333 #endif
1334 
1335     pos_T	b_last_cursor;	/* cursor position when last unloading this
1336 				   buffer */
1337     pos_T	b_last_insert;	/* where Insert mode was left */
1338     pos_T	b_last_change;	/* position of last change: '. mark */
1339 
1340 #ifdef FEAT_JUMPLIST
1341     /*
1342      * the changelist contains old change positions
1343      */
1344     pos_T	b_changelist[JUMPLISTSIZE];
1345     int		b_changelistlen;	/* number of active entries */
1346     int		b_new_change;		/* set by u_savecommon() */
1347 #endif
1348 
1349     /*
1350      * Character table, only used in charset.c for 'iskeyword'
1351      * 32 bytes of 8 bits: 1 bit per character 0-255.
1352      */
1353     char_u	b_chartab[32];
1354 
1355 #ifdef FEAT_LOCALMAP
1356     /* Table used for mappings local to a buffer. */
1357     mapblock_T	*(b_maphash[256]);
1358 
1359     /* First abbreviation local to a buffer. */
1360     mapblock_T	*b_first_abbr;
1361 #endif
1362 #ifdef FEAT_USR_CMDS
1363     /* User commands local to the buffer. */
1364     garray_T	b_ucmds;
1365 #endif
1366     /*
1367      * start and end of an operator, also used for '[ and ']
1368      */
1369     pos_T	b_op_start;
1370     pos_T	b_op_end;
1371 
1372 #ifdef FEAT_VIMINFO
1373     int		b_marks_read;	/* Have we read viminfo marks yet? */
1374 #endif
1375 
1376     /*
1377      * The following only used in undo.c.
1378      */
1379     u_header_T	*b_u_oldhead;	/* pointer to oldest header */
1380     u_header_T	*b_u_newhead;	/* pointer to newest header; may not be valid
1381 				   if b_u_curhead is not NULL */
1382     u_header_T	*b_u_curhead;	/* pointer to current header */
1383     int		b_u_numhead;	/* current number of headers */
1384     int		b_u_synced;	/* entry lists are synced */
1385     long	b_u_seq_last;	/* last used undo sequence number */
1386     long	b_u_save_nr_last; /* counter for last file write */
1387     long	b_u_seq_cur;	/* hu_seq of header below which we are now */
1388     time_t	b_u_time_cur;	/* uh_time of header below which we are now */
1389     long	b_u_save_nr_cur; /* file write nr after which we are now */
1390 
1391     /*
1392      * variables for "U" command in undo.c
1393      */
1394     char_u	*b_u_line_ptr;	/* saved line for "U" command */
1395     linenr_T	b_u_line_lnum;	/* line number of line in u_line */
1396     colnr_T	b_u_line_colnr;	/* optional column number */
1397 
1398 #ifdef FEAT_INS_EXPAND
1399     int		b_scanned;	/* ^N/^P have scanned this buffer */
1400 #endif
1401 
1402     /* flags for use of ":lmap" and IM control */
1403     long	b_p_iminsert;	/* input mode for insert */
1404     long	b_p_imsearch;	/* input mode for search */
1405 #define B_IMODE_USE_INSERT -1	/*	Use b_p_iminsert value for search */
1406 #define B_IMODE_NONE 0		/*	Input via none */
1407 #define B_IMODE_LMAP 1		/*	Input via langmap */
1408 #ifndef USE_IM_CONTROL
1409 # define B_IMODE_LAST 1
1410 #else
1411 # define B_IMODE_IM 2		/*	Input via input method */
1412 # define B_IMODE_LAST 2
1413 #endif
1414 
1415 #ifdef FEAT_KEYMAP
1416     short	b_kmap_state;	/* using "lmap" mappings */
1417 # define KEYMAP_INIT	1	/* 'keymap' was set, call keymap_init() */
1418 # define KEYMAP_LOADED	2	/* 'keymap' mappings have been loaded */
1419     garray_T	b_kmap_ga;	/* the keymap table */
1420 #endif
1421 
1422     /*
1423      * Options local to a buffer.
1424      * They are here because their value depends on the type of file
1425      * or contents of the file being edited.
1426      */
1427     int		b_p_initialized;	/* set when options initialized */
1428 
1429 #ifdef FEAT_EVAL
1430     int		b_p_scriptID[BV_COUNT];	/* SIDs for buffer-local options */
1431 #endif
1432 
1433     int		b_p_ai;		/* 'autoindent' */
1434     int		b_p_ai_nopaste;	/* b_p_ai saved for paste mode */
1435     int		b_p_ci;		/* 'copyindent' */
1436     int		b_p_bin;	/* 'binary' */
1437 #ifdef FEAT_MBYTE
1438     int		b_p_bomb;	/* 'bomb' */
1439 #endif
1440 #if defined(FEAT_QUICKFIX)
1441     char_u	*b_p_bh;	/* 'bufhidden' */
1442     char_u	*b_p_bt;	/* 'buftype' */
1443 #endif
1444     int		b_p_bl;		/* 'buflisted' */
1445 #ifdef FEAT_CINDENT
1446     int		b_p_cin;	/* 'cindent' */
1447     char_u	*b_p_cino;	/* 'cinoptions' */
1448     char_u	*b_p_cink;	/* 'cinkeys' */
1449 #endif
1450 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
1451     char_u	*b_p_cinw;	/* 'cinwords' */
1452 #endif
1453 #ifdef FEAT_COMMENTS
1454     char_u	*b_p_com;	/* 'comments' */
1455 #endif
1456 #ifdef FEAT_FOLDING
1457     char_u	*b_p_cms;	/* 'commentstring' */
1458 #endif
1459 #ifdef FEAT_INS_EXPAND
1460     char_u	*b_p_cpt;	/* 'complete' */
1461 #endif
1462 #ifdef FEAT_COMPL_FUNC
1463     char_u	*b_p_cfu;	/* 'completefunc' */
1464     char_u	*b_p_ofu;	/* 'omnifunc' */
1465 #endif
1466     int		b_p_eol;	/* 'endofline' */
1467     int		b_p_et;		/* 'expandtab' */
1468     int		b_p_et_nobin;	/* b_p_et saved for binary mode */
1469 #ifdef FEAT_MBYTE
1470     char_u	*b_p_fenc;	/* 'fileencoding' */
1471 #endif
1472     char_u	*b_p_ff;	/* 'fileformat' */
1473 #ifdef FEAT_AUTOCMD
1474     char_u	*b_p_ft;	/* 'filetype' */
1475 #endif
1476     char_u	*b_p_fo;	/* 'formatoptions' */
1477     char_u	*b_p_flp;	/* 'formatlistpat' */
1478     int		b_p_inf;	/* 'infercase' */
1479     char_u	*b_p_isk;	/* 'iskeyword' */
1480 #ifdef FEAT_FIND_ID
1481     char_u	*b_p_def;	/* 'define' local value */
1482     char_u	*b_p_inc;	/* 'include' */
1483 # ifdef FEAT_EVAL
1484     char_u	*b_p_inex;	/* 'includeexpr' */
1485     long_u	b_p_inex_flags;	/* flags for 'includeexpr' */
1486 # endif
1487 #endif
1488 #if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
1489     char_u	*b_p_inde;	/* 'indentexpr' */
1490     long_u	b_p_inde_flags;	/* flags for 'indentexpr' */
1491     char_u	*b_p_indk;	/* 'indentkeys' */
1492 #endif
1493 #if defined(FEAT_EVAL)
1494     char_u	*b_p_fex;	/* 'formatexpr' */
1495     long_u	b_p_fex_flags;	/* flags for 'formatexpr' */
1496 #endif
1497 #ifdef FEAT_CRYPT
1498     char_u	*b_p_key;	/* 'key' */
1499 #endif
1500     char_u	*b_p_kp;	/* 'keywordprg' */
1501 #ifdef FEAT_LISP
1502     int		b_p_lisp;	/* 'lisp' */
1503 #endif
1504     char_u	*b_p_mps;	/* 'matchpairs' */
1505     int		b_p_ml;		/* 'modeline' */
1506     int		b_p_ml_nobin;	/* b_p_ml saved for binary mode */
1507     int		b_p_ma;		/* 'modifiable' */
1508     char_u	*b_p_nf;	/* 'nrformats' */
1509 #ifdef FEAT_OSFILETYPE
1510     char_u	*b_p_oft;	/* 'osfiletype' */
1511 #endif
1512     int		b_p_pi;		/* 'preserveindent' */
1513 #ifdef FEAT_TEXTOBJ
1514     char_u	*b_p_qe;	/* 'quoteescape' */
1515 #endif
1516     int		b_p_ro;		/* 'readonly' */
1517     long	b_p_sw;		/* 'shiftwidth' */
1518 #ifndef SHORT_FNAME
1519     int		b_p_sn;		/* 'shortname' */
1520 #endif
1521 #ifdef FEAT_SMARTINDENT
1522     int		b_p_si;		/* 'smartindent' */
1523 #endif
1524     long	b_p_sts;	/* 'softtabstop' */
1525     long	b_p_sts_nopaste; /* b_p_sts saved for paste mode */
1526 #ifdef FEAT_SEARCHPATH
1527     char_u	*b_p_sua;	/* 'suffixesadd' */
1528 #endif
1529     int		b_p_swf;	/* 'swapfile' */
1530 #ifdef FEAT_SYN_HL
1531     long	b_p_smc;	/* 'synmaxcol' */
1532     char_u	*b_p_syn;	/* 'syntax' */
1533 #endif
1534     long	b_p_ts;		/* 'tabstop' */
1535     int		b_p_tx;		/* 'textmode' */
1536     long	b_p_tw;		/* 'textwidth' */
1537     long	b_p_tw_nobin;	/* b_p_tw saved for binary mode */
1538     long	b_p_tw_nopaste;	/* b_p_tw saved for paste mode */
1539     long	b_p_wm;		/* 'wrapmargin' */
1540     long	b_p_wm_nobin;	/* b_p_wm saved for binary mode */
1541     long	b_p_wm_nopaste;	/* b_p_wm saved for paste mode */
1542 #ifdef FEAT_KEYMAP
1543     char_u	*b_p_keymap;	/* 'keymap' */
1544 #endif
1545 
1546     /* local values for options which are normally global */
1547 #ifdef FEAT_QUICKFIX
1548     char_u	*b_p_gp;	/* 'grepprg' local value */
1549     char_u	*b_p_mp;	/* 'makeprg' local value */
1550     char_u	*b_p_efm;	/* 'errorformat' local value */
1551 #endif
1552     char_u	*b_p_ep;	/* 'equalprg' local value */
1553     char_u	*b_p_path;	/* 'path' local value */
1554     int		b_p_ar;		/* 'autoread' local value */
1555     char_u	*b_p_tags;	/* 'tags' local value */
1556 #ifdef FEAT_INS_EXPAND
1557     char_u	*b_p_dict;	/* 'dictionary' local value */
1558     char_u	*b_p_tsr;	/* 'thesaurus' local value */
1559 #endif
1560 #ifdef FEAT_PERSISTENT_UNDO
1561     int		b_p_udf;	/* 'undofile' */
1562 #endif
1563 
1564     /* end of buffer options */
1565 
1566     int		b_start_eol;	/* last line had eol when it was read */
1567     int		b_start_ffc;	/* first char of 'ff' when edit started */
1568 #ifdef FEAT_MBYTE
1569     char_u	*b_start_fenc;	/* 'fileencoding' when edit started or NULL */
1570     int		b_bad_char;	/* "++bad=" argument when edit started or 0 */
1571     int		b_start_bomb;	/* 'bomb' when it was read */
1572 #endif
1573 
1574 #ifdef FEAT_EVAL
1575     dictitem_T	b_bufvar;	/* variable for "b:" Dictionary */
1576     dict_T	b_vars;		/* internal variables, local to buffer */
1577 #endif
1578 
1579 #if defined(FEAT_BEVAL) && defined(FEAT_EVAL)
1580     char_u	*b_p_bexpr;	/* 'balloonexpr' local value */
1581     long_u	b_p_bexpr_flags;/* flags for 'balloonexpr' */
1582 #endif
1583 #ifdef FEAT_CRYPT
1584     char_u	*b_p_cm;	/* 'cryptmethod' */
1585 #endif
1586 
1587     /* When a buffer is created, it starts without a swap file.  b_may_swap is
1588      * then set to indicate that a swap file may be opened later.  It is reset
1589      * if a swap file could not be opened.
1590      */
1591     int		b_may_swap;
1592     int		b_did_warn;	/* Set to 1 if user has been warned on first
1593 				   change of a read-only file */
1594 
1595     /* Two special kinds of buffers:
1596      * help buffer  - used for help files, won't use a swap file.
1597      * spell buffer - used for spell info, never displayed and doesn't have a
1598      *		      file name.
1599      */
1600     int		b_help;		/* TRUE for help file buffer (when set b_p_bt
1601 				   is "help") */
1602 #ifdef FEAT_SPELL
1603     int		b_spell;	/* TRUE for a spell file buffer, most fields
1604 				   are not used!  Use the B_SPELL macro to
1605 				   access b_spell without #ifdef. */
1606 #endif
1607 
1608 #ifndef SHORT_FNAME
1609     int		b_shortname;	/* this file has an 8.3 file name */
1610 #endif
1611 
1612 #ifdef FEAT_MZSCHEME
1613     void	*b_mzscheme_ref; /* The MzScheme reference to this buffer */
1614 #endif
1615 
1616 #ifdef FEAT_PERL
1617     void	*b_perl_private;
1618 #endif
1619 
1620 #ifdef FEAT_PYTHON
1621     void	*b_python_ref;	/* The Python reference to this buffer */
1622 #endif
1623 
1624 #ifdef FEAT_PYTHON3
1625     void	*b_python3_ref;	/* The Python3 reference to this buffer */
1626 #endif
1627 
1628 #ifdef FEAT_TCL
1629     void	*b_tcl_ref;
1630 #endif
1631 
1632 #ifdef FEAT_RUBY
1633     void	*b_ruby_ref;
1634 #endif
1635 
1636 #if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
1637     synblock_T	b_s;		/* Info related to syntax highlighting.  w_s
1638 				 * normally points to this, but some windows
1639 				 * may use a different synblock_T. */
1640 #endif
1641 
1642 #ifdef FEAT_SIGNS
1643     signlist_T	*b_signlist;	/* list of signs to draw */
1644 #endif
1645 
1646 #ifdef FEAT_NETBEANS_INTG
1647     int		b_netbeans_file;    /* TRUE when buffer is owned by NetBeans */
1648     int		b_was_netbeans_file;/* TRUE if b_netbeans_file was once set */
1649 #endif
1650 
1651 };
1652 
1653 
1654 #ifdef FEAT_DIFF
1655 /*
1656  * Stuff for diff mode.
1657  */
1658 # define DB_COUNT 4	/* up to four buffers can be diff'ed */
1659 
1660 /*
1661  * Each diffblock defines where a block of lines starts in each of the buffers
1662  * and how many lines it occupies in that buffer.  When the lines are missing
1663  * in the buffer the df_count[] is zero.  This is all counted in
1664  * buffer lines.
1665  * There is always at least one unchanged line in between the diffs.
1666  * Otherwise it would have been included in the diff above or below it.
1667  * df_lnum[] + df_count[] is the lnum below the change.  When in one buffer
1668  * lines have been inserted, in the other buffer df_lnum[] is the line below
1669  * the insertion and df_count[] is zero.  When appending lines at the end of
1670  * the buffer, df_lnum[] is one beyond the end!
1671  * This is using a linked list, because the number of differences is expected
1672  * to be reasonable small.  The list is sorted on lnum.
1673  */
1674 typedef struct diffblock_S diff_T;
1675 struct diffblock_S
1676 {
1677     diff_T	*df_next;
1678     linenr_T	df_lnum[DB_COUNT];	/* line number in buffer */
1679     linenr_T	df_count[DB_COUNT];	/* nr of inserted/changed lines */
1680 };
1681 #endif
1682 
1683 #define SNAP_HELP_IDX	0
1684 #ifdef FEAT_AUTOCMD
1685 # define SNAP_AUCMD_IDX 1
1686 # define SNAP_COUNT	2
1687 #else
1688 # define SNAP_COUNT	1
1689 #endif
1690 
1691 /*
1692  * Tab pages point to the top frame of each tab page.
1693  * Note: Most values are NOT valid for the current tab page!  Use "curwin",
1694  * "firstwin", etc. for that.  "tp_topframe" is always valid and can be
1695  * compared against "topframe" to find the current tab page.
1696  */
1697 typedef struct tabpage_S tabpage_T;
1698 struct tabpage_S
1699 {
1700     tabpage_T	    *tp_next;	    /* next tabpage or NULL */
1701     frame_T	    *tp_topframe;   /* topframe for the windows */
1702     win_T	    *tp_curwin;	    /* current window in this Tab page */
1703     win_T	    *tp_prevwin;    /* previous window in this Tab page */
1704     win_T	    *tp_firstwin;   /* first window in this Tab page */
1705     win_T	    *tp_lastwin;    /* last window in this Tab page */
1706     long	    tp_old_Rows;    /* Rows when Tab page was left */
1707     long	    tp_old_Columns; /* Columns when Tab page was left */
1708     long	    tp_ch_used;	    /* value of 'cmdheight' when frame size
1709 				       was set */
1710 #ifdef FEAT_GUI
1711     int		    tp_prev_which_scrollbars[3];
1712 				    /* previous value of which_scrollbars */
1713 #endif
1714 #ifdef FEAT_DIFF
1715     diff_T	    *tp_first_diff;
1716     buf_T	    *(tp_diffbuf[DB_COUNT]);
1717     int		    tp_diff_invalid;	/* list of diffs is outdated */
1718 #endif
1719     frame_T	    *(tp_snapshot[SNAP_COUNT]);  /* window layout snapshots */
1720 #ifdef FEAT_EVAL
1721     dictitem_T	    tp_winvar;	    /* variable for "t:" Dictionary */
1722     dict_T	    tp_vars;	    /* internal variables, local to tab page */
1723 #endif
1724 };
1725 
1726 /*
1727  * Structure to cache info for displayed lines in w_lines[].
1728  * Each logical line has one entry.
1729  * The entry tells how the logical line is currently displayed in the window.
1730  * This is updated when displaying the window.
1731  * When the display is changed (e.g., when clearing the screen) w_lines_valid
1732  * is changed to exclude invalid entries.
1733  * When making changes to the buffer, wl_valid is reset to indicate wl_size
1734  * may not reflect what is actually in the buffer.  When wl_valid is FALSE,
1735  * the entries can only be used to count the number of displayed lines used.
1736  * wl_lnum and wl_lastlnum are invalid too.
1737  */
1738 typedef struct w_line
1739 {
1740     linenr_T	wl_lnum;	/* buffer line number for logical line */
1741     short_u	wl_size;	/* height in screen lines */
1742     char	wl_valid;	/* TRUE values are valid for text in buffer */
1743 #ifdef FEAT_FOLDING
1744     char	wl_folded;	/* TRUE when this is a range of folded lines */
1745     linenr_T	wl_lastlnum;	/* last buffer line number for logical line */
1746 #endif
1747 } wline_T;
1748 
1749 /*
1750  * Windows are kept in a tree of frames.  Each frame has a column (FR_COL)
1751  * or row (FR_ROW) layout or is a leaf, which has a window.
1752  */
1753 struct frame_S
1754 {
1755     char	fr_layout;	/* FR_LEAF, FR_COL or FR_ROW */
1756 #ifdef FEAT_VERTSPLIT
1757     int		fr_width;
1758     int		fr_newwidth;	/* new width used in win_equal_rec() */
1759 #endif
1760     int		fr_height;
1761     int		fr_newheight;	/* new height used in win_equal_rec() */
1762     frame_T	*fr_parent;	/* containing frame or NULL */
1763     frame_T	*fr_next;	/* frame right or below in same parent, NULL
1764 				   for first */
1765     frame_T	*fr_prev;	/* frame left or above in same parent, NULL
1766 				   for last */
1767     /* fr_child and fr_win are mutually exclusive */
1768     frame_T	*fr_child;	/* first contained frame */
1769     win_T	*fr_win;	/* window that fills this frame */
1770 };
1771 
1772 #define FR_LEAF	0	/* frame is a leaf */
1773 #define FR_ROW	1	/* frame with a row of windows */
1774 #define FR_COL	2	/* frame with a column of windows */
1775 
1776 /*
1777  * Struct used for highlighting 'hlsearch' matches, matches defined by
1778  * ":match" and matches defined by match functions.
1779  * For 'hlsearch' there is one pattern for all windows.  For ":match" and the
1780  * match functions there is a different pattern for each window.
1781  */
1782 typedef struct
1783 {
1784     regmmatch_T	rm;	/* points to the regexp program; contains last found
1785 			   match (may continue in next line) */
1786     buf_T	*buf;	/* the buffer to search for a match */
1787     linenr_T	lnum;	/* the line to search for a match */
1788     int		attr;	/* attributes to be used for a match */
1789     int		attr_cur; /* attributes currently active in win_line() */
1790     linenr_T	first_lnum;	/* first lnum to search for multi-line pat */
1791     colnr_T	startcol; /* in win_line() points to char where HL starts */
1792     colnr_T	endcol;	 /* in win_line() points to char where HL ends */
1793 #ifdef FEAT_RELTIME
1794     proftime_T	tm;	/* for a time limit */
1795 #endif
1796 } match_T;
1797 
1798 /*
1799  * matchitem_T provides a linked list for storing match items for ":match" and
1800  * the match functions.
1801  */
1802 typedef struct matchitem matchitem_T;
1803 struct matchitem
1804 {
1805     matchitem_T	*next;
1806     int		id;	    /* match ID */
1807     int		priority;   /* match priority */
1808     char_u	*pattern;   /* pattern to highlight */
1809     int		hlg_id;	    /* highlight group ID */
1810     regmmatch_T	match;	    /* regexp program for pattern */
1811     match_T	hl;	    /* struct for doing the actual highlighting */
1812 };
1813 
1814 /*
1815  * Structure which contains all information that belongs to a window
1816  *
1817  * All row numbers are relative to the start of the window, except w_winrow.
1818  */
1819 struct window_S
1820 {
1821     buf_T	*w_buffer;	    /* buffer we are a window into (used
1822 				       often, keep it the first item!) */
1823 
1824 #if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
1825     synblock_T	*w_s;
1826 #endif
1827 
1828 #ifdef FEAT_WINDOWS
1829     win_T	*w_prev;	    /* link to previous window */
1830     win_T	*w_next;	    /* link to next window */
1831 #endif
1832 
1833     frame_T	*w_frame;	    /* frame containing this window */
1834 
1835     pos_T	w_cursor;	    /* cursor position in buffer */
1836 
1837     colnr_T	w_curswant;	    /* The column we'd like to be at.  This is
1838 				       used to try to stay in the same column
1839 				       for up/down cursor motions. */
1840 
1841     int		w_set_curswant;	    /* If set, then update w_curswant the next
1842 				       time through cursupdate() to the
1843 				       current virtual column */
1844 
1845 #ifdef FEAT_VISUAL
1846     /*
1847      * the next six are used to update the visual part
1848      */
1849     char	w_old_visual_mode;  /* last known VIsual_mode */
1850     linenr_T	w_old_cursor_lnum;  /* last known end of visual part */
1851     colnr_T	w_old_cursor_fcol;  /* first column for block visual part */
1852     colnr_T	w_old_cursor_lcol;  /* last column for block visual part */
1853     linenr_T	w_old_visual_lnum;  /* last known start of visual part */
1854     colnr_T	w_old_visual_col;   /* last known start of visual part */
1855     colnr_T	w_old_curswant;	    /* last known value of Curswant */
1856 #endif
1857 
1858     /*
1859      * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for
1860      * displaying the buffer.
1861      */
1862     linenr_T	w_topline;	    /* buffer line number of the line at the
1863 				       top of the window */
1864 #ifdef FEAT_AUTOCMD
1865     char	w_topline_was_set;  /* flag set to TRUE when topline is set,
1866 				       e.g. by winrestview() */
1867 #endif
1868 #ifdef FEAT_DIFF
1869     int		w_topfill;	    /* number of filler lines above w_topline */
1870     int		w_old_topfill;	    /* w_topfill at last redraw */
1871     int		w_botfill;	    /* TRUE when filler lines are actually
1872 				       below w_topline (at end of file) */
1873     int		w_old_botfill;	    /* w_botfill at last redraw */
1874 #endif
1875     colnr_T	w_leftcol;	    /* window column number of the left most
1876 				       character in the window; used when
1877 				       'wrap' is off */
1878     colnr_T	w_skipcol;	    /* starting column when a single line
1879 				       doesn't fit in the window */
1880 
1881     /*
1882      * Layout of the window in the screen.
1883      * May need to add "msg_scrolled" to "w_winrow" in rare situations.
1884      */
1885 #ifdef FEAT_WINDOWS
1886     int		w_winrow;	    /* first row of window in screen */
1887 #endif
1888     int		w_height;	    /* number of rows in window, excluding
1889 				       status/command line(s) */
1890 #ifdef FEAT_WINDOWS
1891     int		w_status_height;    /* number of status lines (0 or 1) */
1892 #endif
1893 #ifdef FEAT_VERTSPLIT
1894     int		w_wincol;	    /* Leftmost column of window in screen.
1895 				       use W_WINCOL() */
1896     int		w_width;	    /* Width of window, excluding separation.
1897 				       use W_WIDTH() */
1898     int		w_vsep_width;	    /* Number of separator columns (0 or 1).
1899 				       use W_VSEP_WIDTH() */
1900 #endif
1901 
1902     /*
1903      * === start of cached values ====
1904      */
1905     /*
1906      * Recomputing is minimized by storing the result of computations.
1907      * Use functions in screen.c to check if they are valid and to update.
1908      * w_valid is a bitfield of flags, which indicate if specific values are
1909      * valid or need to be recomputed.	See screen.c for values.
1910      */
1911     int		w_valid;
1912     pos_T	w_valid_cursor;	    /* last known position of w_cursor, used
1913 				       to adjust w_valid */
1914     colnr_T	w_valid_leftcol;    /* last known w_leftcol */
1915 
1916     /*
1917      * w_cline_height is the number of physical lines taken by the buffer line
1918      * that the cursor is on.  We use this to avoid extra calls to plines().
1919      */
1920     int		w_cline_height;	    /* current size of cursor line */
1921 #ifdef FEAT_FOLDING
1922     int		w_cline_folded;	    /* cursor line is folded */
1923 #endif
1924 
1925     int		w_cline_row;	    /* starting row of the cursor line */
1926 
1927     colnr_T	w_virtcol;	    /* column number of the cursor in the
1928 				       buffer line, as opposed to the column
1929 				       number we're at on the screen.  This
1930 				       makes a difference on lines which span
1931 				       more than one screen line or when
1932 				       w_leftcol is non-zero */
1933 
1934     /*
1935      * w_wrow and w_wcol specify the cursor position in the window.
1936      * This is related to positions in the window, not in the display or
1937      * buffer, thus w_wrow is relative to w_winrow.
1938      */
1939     int		w_wrow, w_wcol;	    /* cursor position in window */
1940 
1941     linenr_T	w_botline;	    /* number of the line below the bottom of
1942 				       the screen */
1943     int		w_empty_rows;	    /* number of ~ rows in window */
1944 #ifdef FEAT_DIFF
1945     int		w_filler_rows;	    /* number of filler rows at the end of the
1946 				       window */
1947 #endif
1948 
1949     /*
1950      * Info about the lines currently in the window is remembered to avoid
1951      * recomputing it every time.  The allocated size of w_lines[] is Rows.
1952      * Only the w_lines_valid entries are actually valid.
1953      * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
1954      * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
1955      * Between changing text and updating the display w_lines[] represents
1956      * what is currently displayed.  wl_valid is reset to indicated this.
1957      * This is used for efficient redrawing.
1958      */
1959     int		w_lines_valid;	    /* number of valid entries */
1960     wline_T	*w_lines;
1961 
1962 #ifdef FEAT_FOLDING
1963     garray_T	w_folds;	    /* array of nested folds */
1964     char	w_fold_manual;	    /* when TRUE: some folds are opened/closed
1965 				       manually */
1966     char	w_foldinvalid;	    /* when TRUE: folding needs to be
1967 				       recomputed */
1968 #endif
1969 #ifdef FEAT_LINEBREAK
1970     int		w_nrwidth;	    /* width of 'number' and 'relativenumber'
1971 				       column being used */
1972 #endif
1973 
1974     /*
1975      * === end of cached values ===
1976      */
1977 
1978     int		w_redr_type;	    /* type of redraw to be performed on win */
1979     int		w_upd_rows;	    /* number of window lines to update when
1980 				       w_redr_type is REDRAW_TOP */
1981     linenr_T	w_redraw_top;	    /* when != 0: first line needing redraw */
1982     linenr_T	w_redraw_bot;	    /* when != 0: last line needing redraw */
1983 #ifdef FEAT_WINDOWS
1984     int		w_redr_status;	    /* if TRUE status line must be redrawn */
1985 #endif
1986 
1987 #ifdef FEAT_CMDL_INFO
1988     /* remember what is shown in the ruler for this window (if 'ruler' set) */
1989     pos_T	w_ru_cursor;	    /* cursor position shown in ruler */
1990     colnr_T	w_ru_virtcol;	    /* virtcol shown in ruler */
1991     linenr_T	w_ru_topline;	    /* topline shown in ruler */
1992     linenr_T	w_ru_line_count;    /* line count used for ruler */
1993 # ifdef FEAT_DIFF
1994     int		w_ru_topfill;	    /* topfill shown in ruler */
1995 # endif
1996     char	w_ru_empty;	    /* TRUE if ruler shows 0-1 (empty line) */
1997 #endif
1998 
1999     int		w_alt_fnum;	    /* alternate file (for # and CTRL-^) */
2000 
2001 #ifdef FEAT_WINDOWS
2002     alist_T	*w_alist;	    /* pointer to arglist for this window */
2003 #endif
2004     int		w_arg_idx;	    /* current index in argument list (can be
2005 				       out of range!) */
2006     int		w_arg_idx_invalid;  /* editing another file than w_arg_idx */
2007 
2008     char_u	*w_localdir;	    /* absolute path of local directory or
2009 				       NULL */
2010     /*
2011      * Options local to a window.
2012      * They are local because they influence the layout of the window or
2013      * depend on the window layout.
2014      * There are two values: w_onebuf_opt is local to the buffer currently in
2015      * this window, w_allbuf_opt is for all buffers in this window.
2016      */
2017     winopt_T	w_onebuf_opt;
2018     winopt_T	w_allbuf_opt;
2019 
2020     /* A few options have local flags for P_INSECURE. */
2021 #ifdef FEAT_STL_OPT
2022     long_u	w_p_stl_flags;	    /* flags for 'statusline' */
2023 #endif
2024 #ifdef FEAT_EVAL
2025     long_u	w_p_fde_flags;	    /* flags for 'foldexpr' */
2026     long_u	w_p_fdt_flags;	    /* flags for 'foldtext' */
2027 #endif
2028 #ifdef FEAT_SYN_HL
2029     int		*w_p_cc_cols;	    /* array of columns to highlight or NULL */
2030 #endif
2031 
2032     /* transform a pointer to a "onebuf" option into a "allbuf" option */
2033 #define GLOBAL_WO(p)	((char *)p + sizeof(winopt_T))
2034 
2035 #ifdef FEAT_SCROLLBIND
2036     long	w_scbind_pos;
2037 #endif
2038 
2039 #ifdef FEAT_EVAL
2040     dictitem_T	w_winvar;	/* variable for "w:" Dictionary */
2041     dict_T	w_vars;		/* internal variables, local to window */
2042 #endif
2043 
2044 #if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
2045     int		w_farsi;	/* for the window dependent Farsi functions */
2046 #endif
2047 
2048     /*
2049      * The w_prev_pcmark field is used to check whether we really did jump to
2050      * a new line after setting the w_pcmark.  If not, then we revert to
2051      * using the previous w_pcmark.
2052      */
2053     pos_T	w_pcmark;	/* previous context mark */
2054     pos_T	w_prev_pcmark;	/* previous w_pcmark */
2055 
2056 #ifdef FEAT_JUMPLIST
2057     /*
2058      * the jumplist contains old cursor positions
2059      */
2060     xfmark_T	w_jumplist[JUMPLISTSIZE];
2061     int		w_jumplistlen;		/* number of active entries */
2062     int		w_jumplistidx;		/* current position */
2063 
2064     int		w_changelistidx;	/* current position in b_changelist */
2065 #endif
2066 
2067 #ifdef FEAT_SEARCH_EXTRA
2068     matchitem_T	*w_match_head;		/* head of match list */
2069     int		w_next_match_id;	/* next match ID */
2070 #endif
2071 
2072     /*
2073      * the tagstack grows from 0 upwards:
2074      * entry 0: older
2075      * entry 1: newer
2076      * entry 2: newest
2077      */
2078     taggy_T	w_tagstack[TAGSTACKSIZE];	/* the tag stack */
2079     int		w_tagstackidx;		/* idx just below active entry */
2080     int		w_tagstacklen;		/* number of tags on stack */
2081 
2082     /*
2083      * w_fraction is the fractional row of the cursor within the window, from
2084      * 0 at the top row to FRACTION_MULT at the last row.
2085      * w_prev_fraction_row was the actual cursor row when w_fraction was last
2086      * calculated.
2087      */
2088     int		w_fraction;
2089     int		w_prev_fraction_row;
2090 
2091 #ifdef FEAT_GUI
2092     scrollbar_T	w_scrollbars[2];	/* vert. Scrollbars for this window */
2093 #endif
2094 #ifdef FEAT_LINEBREAK
2095     linenr_T	w_nrwidth_line_count;	/* line count when ml_nrwidth_width
2096 					 * was computed. */
2097     int		w_nrwidth_width;	/* nr of chars to print line count. */
2098 #endif
2099 
2100 #ifdef FEAT_QUICKFIX
2101     qf_info_T	*w_llist;		/* Location list for this window */
2102     /*
2103      * Location list reference used in the location list window.
2104      * In a non-location list window, w_llist_ref is NULL.
2105      */
2106     qf_info_T	*w_llist_ref;
2107 #endif
2108 
2109 
2110 #ifdef FEAT_MZSCHEME
2111     void	*w_mzscheme_ref;	/* The MzScheme value for this window */
2112 #endif
2113 
2114 #ifdef FEAT_PERL
2115     void	*w_perl_private;
2116 #endif
2117 
2118 #ifdef FEAT_PYTHON
2119     void	*w_python_ref;		/* The Python value for this window */
2120 #endif
2121 
2122 #ifdef FEAT_PYTHON3
2123     void	*w_python3_ref;		/* The Python value for this window */
2124 #endif
2125 
2126 #ifdef FEAT_TCL
2127     void	*w_tcl_ref;
2128 #endif
2129 
2130 #ifdef FEAT_RUBY
2131     void	*w_ruby_ref;
2132 #endif
2133 };
2134 
2135 /*
2136  * Arguments for operators.
2137  */
2138 typedef struct oparg_S
2139 {
2140     int		op_type;	/* current pending operator type */
2141     int		regname;	/* register to use for the operator */
2142     int		motion_type;	/* type of the current cursor motion */
2143     int		motion_force;	/* force motion type: 'v', 'V' or CTRL-V */
2144     int		use_reg_one;	/* TRUE if delete uses reg 1 even when not
2145 				   linewise */
2146     int		inclusive;	/* TRUE if char motion is inclusive (only
2147 				   valid when motion_type is MCHAR */
2148     int		end_adjusted;	/* backuped b_op_end one char (only used by
2149 				   do_format()) */
2150     pos_T	start;		/* start of the operator */
2151     pos_T	end;		/* end of the operator */
2152     pos_T	cursor_start;	/* cursor position before motion for "gw" */
2153 
2154     long	line_count;	/* number of lines from op_start to op_end
2155 				   (inclusive) */
2156     int		empty;		/* op_start and op_end the same (only used by
2157 				   do_change()) */
2158 #ifdef FEAT_VISUAL
2159     int		is_VIsual;	/* operator on Visual area */
2160     int		block_mode;	/* current operator is Visual block mode */
2161 #endif
2162     colnr_T	start_vcol;	/* start col for block mode operator */
2163     colnr_T	end_vcol;	/* end col for block mode operator */
2164 #ifdef FEAT_AUTOCMD
2165     long	prev_opcount;	/* ca.opcount saved for K_CURSORHOLD */
2166     long	prev_count0;	/* ca.count0 saved for K_CURSORHOLD */
2167 #endif
2168 } oparg_T;
2169 
2170 /*
2171  * Arguments for Normal mode commands.
2172  */
2173 typedef struct cmdarg_S
2174 {
2175     oparg_T	*oap;		/* Operator arguments */
2176     int		prechar;	/* prefix character (optional, always 'g') */
2177     int		cmdchar;	/* command character */
2178     int		nchar;		/* next command character (optional) */
2179 #ifdef FEAT_MBYTE
2180     int		ncharC1;	/* first composing character (optional) */
2181     int		ncharC2;	/* second composing character (optional) */
2182 #endif
2183     int		extra_char;	/* yet another character (optional) */
2184     long	opcount;	/* count before an operator */
2185     long	count0;		/* count before command, default 0 */
2186     long	count1;		/* count before command, default 1 */
2187     int		arg;		/* extra argument from nv_cmds[] */
2188     int		retval;		/* return: CA_* values */
2189     char_u	*searchbuf;	/* return: pointer to search pattern or NULL */
2190 } cmdarg_T;
2191 
2192 /* values for retval: */
2193 #define CA_COMMAND_BUSY	    1	/* skip restarting edit() once */
2194 #define CA_NO_ADJ_OP_END    2	/* don't adjust operator end */
2195 
2196 #ifdef CURSOR_SHAPE
2197 /*
2198  * struct to store values from 'guicursor' and 'mouseshape'
2199  */
2200 /* Indexes in shape_table[] */
2201 #define SHAPE_IDX_N	0	/* Normal mode */
2202 #define SHAPE_IDX_V	1	/* Visual mode */
2203 #define SHAPE_IDX_I	2	/* Insert mode */
2204 #define SHAPE_IDX_R	3	/* Replace mode */
2205 #define SHAPE_IDX_C	4	/* Command line Normal mode */
2206 #define SHAPE_IDX_CI	5	/* Command line Insert mode */
2207 #define SHAPE_IDX_CR	6	/* Command line Replace mode */
2208 #define SHAPE_IDX_O	7	/* Operator-pending mode */
2209 #define SHAPE_IDX_VE	8	/* Visual mode with 'selection' exclusive */
2210 #define SHAPE_IDX_CLINE	9	/* On command line */
2211 #define SHAPE_IDX_STATUS 10	/* A status line */
2212 #define SHAPE_IDX_SDRAG 11	/* dragging a status line */
2213 #define SHAPE_IDX_VSEP	12	/* A vertical separator line */
2214 #define SHAPE_IDX_VDRAG 13	/* dragging a vertical separator line */
2215 #define SHAPE_IDX_MORE	14	/* Hit-return or More */
2216 #define SHAPE_IDX_MOREL	15	/* Hit-return or More in last line */
2217 #define SHAPE_IDX_SM	16	/* showing matching paren */
2218 #define SHAPE_IDX_COUNT	17
2219 
2220 #define SHAPE_BLOCK	0	/* block cursor */
2221 #define SHAPE_HOR	1	/* horizontal bar cursor */
2222 #define SHAPE_VER	2	/* vertical bar cursor */
2223 
2224 #define MSHAPE_NUMBERED	1000	/* offset for shapes identified by number */
2225 #define MSHAPE_HIDE	1	/* hide mouse pointer */
2226 
2227 #define SHAPE_MOUSE	1	/* used for mouse pointer shape */
2228 #define SHAPE_CURSOR	2	/* used for text cursor shape */
2229 
2230 typedef struct cursor_entry
2231 {
2232     int		shape;		/* one of the SHAPE_ defines */
2233     int		mshape;		/* one of the MSHAPE defines */
2234     int		percentage;	/* percentage of cell for bar */
2235     long	blinkwait;	/* blinking, wait time before blinking starts */
2236     long	blinkon;	/* blinking, on time */
2237     long	blinkoff;	/* blinking, off time */
2238     int		id;		/* highlight group ID */
2239     int		id_lm;		/* highlight group ID for :lmap mode */
2240     char	*name;		/* mode name (fixed) */
2241     char	used_for;	/* SHAPE_MOUSE and/or SHAPE_CURSOR */
2242 } cursorentry_T;
2243 #endif /* CURSOR_SHAPE */
2244 
2245 #ifdef FEAT_MENU
2246 
2247 /* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
2248 #define MENU_INDEX_INVALID	-1
2249 #define MENU_INDEX_NORMAL	0
2250 #define MENU_INDEX_VISUAL	1
2251 #define MENU_INDEX_SELECT	2
2252 #define MENU_INDEX_OP_PENDING	3
2253 #define MENU_INDEX_INSERT	4
2254 #define MENU_INDEX_CMDLINE	5
2255 #define MENU_INDEX_TIP		6
2256 #define MENU_MODES		7
2257 
2258 /* Menu modes */
2259 #define MENU_NORMAL_MODE	(1 << MENU_INDEX_NORMAL)
2260 #define MENU_VISUAL_MODE	(1 << MENU_INDEX_VISUAL)
2261 #define MENU_SELECT_MODE	(1 << MENU_INDEX_SELECT)
2262 #define MENU_OP_PENDING_MODE	(1 << MENU_INDEX_OP_PENDING)
2263 #define MENU_INSERT_MODE	(1 << MENU_INDEX_INSERT)
2264 #define MENU_CMDLINE_MODE	(1 << MENU_INDEX_CMDLINE)
2265 #define MENU_TIP_MODE		(1 << MENU_INDEX_TIP)
2266 #define MENU_ALL_MODES		((1 << MENU_INDEX_TIP) - 1)
2267 /*note MENU_INDEX_TIP is not a 'real' mode*/
2268 
2269 /* Start a menu name with this to not include it on the main menu bar */
2270 #define MNU_HIDDEN_CHAR		']'
2271 
2272 typedef struct VimMenu vimmenu_T;
2273 
2274 struct VimMenu
2275 {
2276     int		modes;		    /* Which modes is this menu visible for? */
2277     int		enabled;	    /* for which modes the menu is enabled */
2278     char_u	*name;		    /* Name of menu, possibly translated */
2279     char_u	*dname;		    /* Displayed Name ("name" without '&') */
2280 #ifdef FEAT_MULTI_LANG
2281     char_u	*en_name;	    /* "name" untranslated, NULL when "name"
2282 				     * was not translated */
2283     char_u	*en_dname;	    /* "dname" untranslated, NULL when "dname"
2284 				     * was not translated */
2285 #endif
2286     int		mnemonic;	    /* mnemonic key (after '&') */
2287     char_u	*actext;	    /* accelerator text (after TAB) */
2288     int		priority;	    /* Menu order priority */
2289 #ifdef FEAT_GUI
2290     void	(*cb) __ARGS((vimmenu_T *));	    /* Call-back routine */
2291 #endif
2292 #ifdef FEAT_TOOLBAR
2293     char_u	*iconfile;	    /* name of file for icon or NULL */
2294     int		iconidx;	    /* icon index (-1 if not set) */
2295     int		icon_builtin;	    /* icon names is BuiltIn{nr} */
2296 #endif
2297     char_u	*strings[MENU_MODES]; /* Mapped string for each mode */
2298     int		noremap[MENU_MODES]; /* A REMAP_ flag for each mode */
2299     char	silent[MENU_MODES]; /* A silent flag for each mode */
2300     vimmenu_T	*children;	    /* Children of sub-menu */
2301     vimmenu_T	*parent;	    /* Parent of menu */
2302     vimmenu_T	*next;		    /* Next item in menu */
2303 #ifdef FEAT_GUI_X11
2304     Widget	id;		    /* Manage this to enable item */
2305     Widget	submenu_id;	    /* If this is submenu, add children here */
2306 #endif
2307 #ifdef FEAT_GUI_GTK
2308     GtkWidget	*id;		    /* Manage this to enable item */
2309     GtkWidget	*submenu_id;	    /* If this is submenu, add children here */
2310     GtkWidget	*tearoff_handle;
2311     GtkWidget   *label;		    /* Used by "set wak=" code. */
2312 #endif
2313 #ifdef FEAT_GUI_MOTIF
2314     int		sensitive;	    /* turn button on/off */
2315     char	**xpm;		    /* pixmap data */
2316     char	*xpm_fname;	    /* file with pixmap data */
2317 #endif
2318 #ifdef FEAT_GUI_ATHENA
2319     Pixmap	image;		    /* Toolbar image */
2320 #endif
2321 #ifdef FEAT_BEVAL_TIP
2322     BalloonEval *tip;		    /* tooltip for this menu item */
2323 #endif
2324 #ifdef FEAT_GUI_W16
2325     UINT	id;		    /* Id of menu item */
2326     HMENU	submenu_id;	    /* If this is submenu, add children here */
2327 #endif
2328 #ifdef FEAT_GUI_W32
2329     UINT	id;		    /* Id of menu item */
2330     HMENU	submenu_id;	    /* If this is submenu, add children here */
2331     HWND	tearoff_handle;	    /* hWnd of tearoff if created */
2332 #endif
2333 #ifdef FEAT_GUI_MAC
2334 /*  MenuHandle	id; */
2335 /*  short	index;	*/	    /* the item index within the father menu */
2336     short	menu_id;	    /* the menu id to which this item belong */
2337     short	submenu_id;	    /* the menu id of the children (could be
2338 				       get through some tricks) */
2339     MenuHandle	menu_handle;
2340     MenuHandle	submenu_handle;
2341 #endif
2342 #ifdef RISCOS
2343     int		*id;		    /* Not used, but gui.c needs it */
2344     int		greyed_out;	    /* Flag */
2345     int		hidden;
2346 #endif
2347 #ifdef FEAT_GUI_PHOTON
2348     PtWidget_t	*id;
2349     PtWidget_t	*submenu_id;
2350 #endif
2351 };
2352 #else
2353 /* For generating prototypes when FEAT_MENU isn't defined. */
2354 typedef int vimmenu_T;
2355 
2356 #endif /* FEAT_MENU */
2357 
2358 /*
2359  * Struct to save values in before executing autocommands for a buffer that is
2360  * not the current buffer.  Without FEAT_AUTOCMD only "curbuf" is remembered.
2361  */
2362 typedef struct
2363 {
2364     buf_T	*save_curbuf;	/* saved curbuf */
2365 #ifdef FEAT_AUTOCMD
2366     int		use_aucmd_win;	/* using aucmd_win */
2367     win_T	*save_curwin;	/* saved curwin */
2368     win_T	*new_curwin;	/* new curwin */
2369     buf_T	*new_curbuf;	/* new curbuf */
2370     char_u	*globaldir;	/* saved value of globaldir */
2371 #endif
2372 } aco_save_T;
2373 
2374 /*
2375  * Generic option table item, only used for printer at the moment.
2376  */
2377 typedef struct
2378 {
2379     const char	*name;
2380     int		hasnum;
2381     long	number;
2382     char_u	*string;	/* points into option string */
2383     int		strlen;
2384     int		present;
2385 } option_table_T;
2386 
2387 /*
2388  * Structure to hold printing color and font attributes.
2389  */
2390 typedef struct
2391 {
2392     long_u	fg_color;
2393     long_u	bg_color;
2394     int		bold;
2395     int		italic;
2396     int		underline;
2397     int		undercurl;
2398 } prt_text_attr_T;
2399 
2400 /*
2401  * Structure passed back to the generic printer code.
2402  */
2403 typedef struct
2404 {
2405     int		n_collated_copies;
2406     int		n_uncollated_copies;
2407     int		duplex;
2408     int		chars_per_line;
2409     int		lines_per_page;
2410     int		has_color;
2411     prt_text_attr_T number;
2412 #ifdef FEAT_SYN_HL
2413     int		modec;
2414     int		do_syntax;
2415 #endif
2416     int		user_abort;
2417     char_u	*jobname;
2418 #ifdef FEAT_POSTSCRIPT
2419     char_u	*outfile;
2420     char_u	*arguments;
2421 #endif
2422 } prt_settings_T;
2423 
2424 #define PRINT_NUMBER_WIDTH 8
2425 
2426 /*
2427  * Used for popup menu items.
2428  */
2429 typedef struct
2430 {
2431     char_u	*pum_text;	/* main menu text */
2432     char_u	*pum_kind;	/* extra kind text (may be truncated) */
2433     char_u	*pum_extra;	/* extra menu text (may be truncated) */
2434     char_u	*pum_info;	/* extra info */
2435 } pumitem_T;
2436 
2437 /*
2438  * Structure used for get_tagfname().
2439  */
2440 typedef struct
2441 {
2442     char_u	*tn_tags;	/* value of 'tags' when starting */
2443     char_u	*tn_np;		/* current position in tn_tags */
2444     int		tn_did_filefind_init;
2445     int		tn_hf_idx;
2446     void	*tn_search_ctx;
2447 } tagname_T;
2448 
2449 /*
2450  * Array indexes used for cptext argument of ins_compl_add().
2451  */
2452 #define CPT_ABBR    0	/* "abbr" */
2453 #define CPT_MENU    1	/* "menu" */
2454 #define CPT_KIND    2	/* "kind" */
2455 #define CPT_INFO    3	/* "info" */
2456 #define CPT_COUNT   4	/* Number of entries */
2457 
2458 typedef struct {
2459   UINT32_T total[2];
2460   UINT32_T state[8];
2461   char_u   buffer[64];
2462 } context_sha256_T;
2463