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