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