xref: /vim-8.2.3635/src/structs.h (revision 89eaa418)
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 /* Reference to a buffer that stores the value of buf_free_count.
73  * bufref_valid() only needs to check "buf" when the count differs.
74  */
75 typedef struct {
76     buf_T   *br_buf;
77     int	    br_buf_free_count;
78 } bufref_T;
79 
80 /*
81  * This is here because regexp.h needs pos_T and below regprog_T is used.
82  */
83 #include "regexp.h"
84 
85 /*
86  * This is here because gui.h needs the pos_T and win_T, and win_T needs gui.h
87  * for scrollbar_T.
88  */
89 #ifdef FEAT_GUI
90 # include "gui.h"
91 #else
92 # ifdef FEAT_XCLIPBOARD
93 #  include <X11/Intrinsic.h>
94 # endif
95 # define guicolor_T long_u		/* avoid error in prototypes and
96 					 * make FEAT_TERMGUICOLORS work */
97 # define INVALCOLOR ((guicolor_T)0x1ffffff)
98 #endif
99 
100 /*
101  * marks: positions in a file
102  * (a normal mark is a lnum/col pair, the same as a file position)
103  */
104 
105 /* (Note: for EBCDIC there are more than 26, because there are gaps in the
106  * alphabet coding.  To minimize changes to the code, I decided to just
107  * increase the number of possible marks. */
108 #define NMARKS		('z' - 'a' + 1)	/* max. # of named marks */
109 #define JUMPLISTSIZE	100		/* max. # of marks in jump list */
110 #define TAGSTACKSIZE	20		/* max. # of tags in tag stack */
111 
112 typedef struct filemark
113 {
114     pos_T	mark;		/* cursor position */
115     int		fnum;		/* file number */
116 } fmark_T;
117 
118 /* Xtended file mark: also has a file name */
119 typedef struct xfilemark
120 {
121     fmark_T	fmark;
122     char_u	*fname;		/* file name, used when fnum == 0 */
123 #ifdef FEAT_VIMINFO
124     time_T	time_set;
125 #endif
126 } xfmark_T;
127 
128 /*
129  * The taggy struct is used to store the information about a :tag command.
130  */
131 typedef struct taggy
132 {
133     char_u	*tagname;	/* tag name */
134     fmark_T	fmark;		/* cursor position BEFORE ":tag" */
135     int		cur_match;	/* match number */
136     int		cur_fnum;	/* buffer number used for cur_match */
137 } taggy_T;
138 
139 /*
140  * Structure that contains all options that are local to a window.
141  * Used twice in a window: for the current buffer and for all buffers.
142  * Also used in wininfo_T.
143  */
144 typedef struct
145 {
146 #ifdef FEAT_ARABIC
147     int		wo_arab;
148 # define w_p_arab w_onebuf_opt.wo_arab	/* 'arabic' */
149 #endif
150 #ifdef FEAT_LINEBREAK
151     int		wo_bri;
152 # define w_p_bri w_onebuf_opt.wo_bri	/* 'breakindent' */
153     char_u	*wo_briopt;
154 # define w_p_briopt w_onebuf_opt.wo_briopt /* 'breakindentopt' */
155 #endif
156 #ifdef FEAT_DIFF
157     int		wo_diff;
158 # define w_p_diff w_onebuf_opt.wo_diff	/* 'diff' */
159 #endif
160 #ifdef FEAT_FOLDING
161     long	wo_fdc;
162 # define w_p_fdc w_onebuf_opt.wo_fdc	/* 'foldcolumn' */
163     int		wo_fdc_save;
164 # define w_p_fdc_save w_onebuf_opt.wo_fdc_save	/* 'foldenable' saved for diff mode */
165     int		wo_fen;
166 # define w_p_fen w_onebuf_opt.wo_fen	/* 'foldenable' */
167     int		wo_fen_save;
168 # define w_p_fen_save w_onebuf_opt.wo_fen_save	/* 'foldenable' saved for diff mode */
169     char_u	*wo_fdi;
170 # define w_p_fdi w_onebuf_opt.wo_fdi	/* 'foldignore' */
171     long	wo_fdl;
172 # define w_p_fdl w_onebuf_opt.wo_fdl	/* 'foldlevel' */
173     int		wo_fdl_save;
174 # define w_p_fdl_save w_onebuf_opt.wo_fdl_save	/* 'foldlevel' state saved for diff mode */
175     char_u	*wo_fdm;
176 # define w_p_fdm w_onebuf_opt.wo_fdm	/* 'foldmethod' */
177     char_u	*wo_fdm_save;
178 # define w_p_fdm_save w_onebuf_opt.wo_fdm_save	/* 'fdm' saved for diff mode */
179     long	wo_fml;
180 # define w_p_fml w_onebuf_opt.wo_fml	/* 'foldminlines' */
181     long	wo_fdn;
182 # define w_p_fdn w_onebuf_opt.wo_fdn	/* 'foldnestmax' */
183 # ifdef FEAT_EVAL
184     char_u	*wo_fde;
185 # define w_p_fde w_onebuf_opt.wo_fde	/* 'foldexpr' */
186     char_u	*wo_fdt;
187 #  define w_p_fdt w_onebuf_opt.wo_fdt	/* 'foldtext' */
188 # endif
189     char_u	*wo_fmr;
190 # define w_p_fmr w_onebuf_opt.wo_fmr	/* 'foldmarker' */
191 #endif
192 #ifdef FEAT_LINEBREAK
193     int		wo_lbr;
194 # define w_p_lbr w_onebuf_opt.wo_lbr	/* 'linebreak' */
195 #endif
196     int		wo_list;
197 #define w_p_list w_onebuf_opt.wo_list	/* 'list' */
198     int		wo_nu;
199 #define w_p_nu w_onebuf_opt.wo_nu	/* 'number' */
200     int		wo_rnu;
201 #define w_p_rnu w_onebuf_opt.wo_rnu	/* 'relativenumber' */
202 #ifdef FEAT_LINEBREAK
203     long	wo_nuw;
204 # define w_p_nuw w_onebuf_opt.wo_nuw	/* 'numberwidth' */
205 #endif
206 #if defined(FEAT_WINDOWS)
207     int		wo_wfh;
208 # define w_p_wfh w_onebuf_opt.wo_wfh	/* 'winfixheight' */
209     int		wo_wfw;
210 # define w_p_wfw w_onebuf_opt.wo_wfw	/* 'winfixwidth' */
211 #endif
212 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
213     int		wo_pvw;
214 # define w_p_pvw w_onebuf_opt.wo_pvw	/* 'previewwindow' */
215 #endif
216 #ifdef FEAT_RIGHTLEFT
217     int		wo_rl;
218 # define w_p_rl w_onebuf_opt.wo_rl	/* 'rightleft' */
219     char_u	*wo_rlc;
220 # define w_p_rlc w_onebuf_opt.wo_rlc	/* 'rightleftcmd' */
221 #endif
222     long	wo_scr;
223 #define w_p_scr w_onebuf_opt.wo_scr	/* 'scroll' */
224 #ifdef FEAT_SPELL
225     int		wo_spell;
226 # define w_p_spell w_onebuf_opt.wo_spell /* 'spell' */
227 #endif
228 #ifdef FEAT_SYN_HL
229     int		wo_cuc;
230 # define w_p_cuc w_onebuf_opt.wo_cuc	/* 'cursorcolumn' */
231     int		wo_cul;
232 # define w_p_cul w_onebuf_opt.wo_cul	/* 'cursorline' */
233     char_u	*wo_cc;
234 # define w_p_cc w_onebuf_opt.wo_cc	/* 'colorcolumn' */
235 #endif
236 #ifdef FEAT_STL_OPT
237     char_u	*wo_stl;
238 #define w_p_stl w_onebuf_opt.wo_stl	/* 'statusline' */
239 #endif
240 #ifdef FEAT_SCROLLBIND
241     int		wo_scb;
242 # define w_p_scb w_onebuf_opt.wo_scb	/* 'scrollbind' */
243     int		wo_diff_saved; /* options were saved for starting diff mode */
244 # define w_p_diff_saved w_onebuf_opt.wo_diff_saved
245     int		wo_scb_save;	/* 'scrollbind' saved for diff mode*/
246 # define w_p_scb_save w_onebuf_opt.wo_scb_save
247 #endif
248     int		wo_wrap;
249 #define w_p_wrap w_onebuf_opt.wo_wrap	/* 'wrap' */
250 #ifdef FEAT_DIFF
251     int		wo_wrap_save;	/* 'wrap' state saved for diff mode*/
252 # define w_p_wrap_save w_onebuf_opt.wo_wrap_save
253 #endif
254 #ifdef FEAT_CONCEAL
255     char_u	*wo_cocu;		/* 'concealcursor' */
256 # define w_p_cocu w_onebuf_opt.wo_cocu
257     long	wo_cole;		/* 'conceallevel' */
258 # define w_p_cole w_onebuf_opt.wo_cole
259 #endif
260 #ifdef FEAT_CURSORBIND
261     int		wo_crb;
262 # define w_p_crb w_onebuf_opt.wo_crb	/* 'cursorbind' */
263     int		wo_crb_save;	/* 'cursorbind' state saved for diff mode*/
264 # define w_p_crb_save w_onebuf_opt.wo_crb_save
265 #endif
266 
267 #ifdef FEAT_EVAL
268     int		wo_scriptID[WV_COUNT];	/* SIDs for window-local options */
269 # define w_p_scriptID w_onebuf_opt.wo_scriptID
270 #endif
271 } winopt_T;
272 
273 /*
274  * Window info stored with a buffer.
275  *
276  * Two types of info are kept for a buffer which are associated with a
277  * specific window:
278  * 1. Each window can have a different line number associated with a buffer.
279  * 2. The window-local options for a buffer work in a similar way.
280  * The window-info is kept in a list at b_wininfo.  It is kept in
281  * most-recently-used order.
282  */
283 struct wininfo_S
284 {
285     wininfo_T	*wi_next;	/* next entry or NULL for last entry */
286     wininfo_T	*wi_prev;	/* previous entry or NULL for first entry */
287     win_T	*wi_win;	/* pointer to window that did set wi_fpos */
288     pos_T	wi_fpos;	/* last cursor position in the file */
289     int		wi_optset;	/* TRUE when wi_opt has useful values */
290     winopt_T	wi_opt;		/* local window options */
291 #ifdef FEAT_FOLDING
292     int		wi_fold_manual;	/* copy of w_fold_manual */
293     garray_T	wi_folds;	/* clone of w_folds */
294 #endif
295 };
296 
297 /*
298  * Info used to pass info about a fold from the fold-detection code to the
299  * code that displays the foldcolumn.
300  */
301 typedef struct foldinfo
302 {
303     int		fi_level;	/* level of the fold; when this is zero the
304 				   other fields are invalid */
305     int		fi_lnum;	/* line number where fold starts */
306     int		fi_low_level;	/* lowest fold level that starts in the same
307 				   line */
308 } foldinfo_T;
309 
310 /* Structure to store info about the Visual area. */
311 typedef struct
312 {
313     pos_T	vi_start;	/* start pos of last VIsual */
314     pos_T	vi_end;		/* end position of last VIsual */
315     int		vi_mode;	/* VIsual_mode of last VIsual */
316     colnr_T	vi_curswant;	/* MAXCOL from w_curswant */
317 } visualinfo_T;
318 
319 /*
320  * structures used for undo
321  */
322 
323 typedef struct u_entry u_entry_T;
324 typedef struct u_header u_header_T;
325 struct u_entry
326 {
327     u_entry_T	*ue_next;	/* pointer to next entry in list */
328     linenr_T	ue_top;		/* number of line above undo block */
329     linenr_T	ue_bot;		/* number of line below undo block */
330     linenr_T	ue_lcount;	/* linecount when u_save called */
331     char_u	**ue_array;	/* array of lines in undo block */
332     long	ue_size;	/* number of lines in ue_array */
333 #ifdef U_DEBUG
334     int		ue_magic;	/* magic number to check allocation */
335 #endif
336 };
337 
338 struct u_header
339 {
340     /* The following have a pointer and a number. The number is used when
341      * reading the undo file in u_read_undo() */
342     union {
343 	u_header_T *ptr;	/* pointer to next undo header in list */
344 	long	   seq;
345     } uh_next;
346     union {
347 	u_header_T *ptr;	/* pointer to previous header in list */
348 	long	   seq;
349     } uh_prev;
350     union {
351 	u_header_T *ptr;	/* pointer to next header for alt. redo */
352 	long	   seq;
353     } uh_alt_next;
354     union {
355 	u_header_T *ptr;	/* pointer to previous header for alt. redo */
356 	long	   seq;
357     } uh_alt_prev;
358     long	uh_seq;		/* sequence number, higher == newer undo */
359     int		uh_walk;	/* used by undo_time() */
360     u_entry_T	*uh_entry;	/* pointer to first entry */
361     u_entry_T	*uh_getbot_entry; /* pointer to where ue_bot must be set */
362     pos_T	uh_cursor;	/* cursor position before saving */
363 #ifdef FEAT_VIRTUALEDIT
364     long	uh_cursor_vcol;
365 #endif
366     int		uh_flags;	/* see below */
367     pos_T	uh_namedm[NMARKS];	/* marks before undo/after redo */
368     visualinfo_T uh_visual;	/* Visual areas before undo/after redo */
369     time_T	uh_time;	/* timestamp when the change was made */
370     long	uh_save_nr;	/* set when the file was saved after the
371 				   changes in this block */
372 #ifdef U_DEBUG
373     int		uh_magic;	/* magic number to check allocation */
374 #endif
375 };
376 
377 /* values for uh_flags */
378 #define UH_CHANGED  0x01	/* b_changed flag before undo/after redo */
379 #define UH_EMPTYBUF 0x02	/* buffer was empty */
380 
381 /*
382  * structures used in undo.c
383  */
384 #if VIM_SIZEOF_INT > 2
385 # define ALIGN_LONG	/* longword alignment and use filler byte */
386 # define ALIGN_SIZE (sizeof(long))
387 #else
388 # define ALIGN_SIZE (sizeof(short))
389 #endif
390 
391 #define ALIGN_MASK (ALIGN_SIZE - 1)
392 
393 typedef struct m_info minfo_T;
394 
395 /*
396  * structure used to link chunks in one of the free chunk lists.
397  */
398 struct m_info
399 {
400 #ifdef ALIGN_LONG
401     long_u	m_size;		/* size of the chunk (including m_info) */
402 #else
403     short_u	m_size;		/* size of the chunk (including m_info) */
404 #endif
405     minfo_T	*m_next;	/* pointer to next free chunk in the list */
406 };
407 
408 /*
409  * things used in memfile.c
410  */
411 
412 typedef struct block_hdr    bhdr_T;
413 typedef struct memfile	    memfile_T;
414 typedef long		    blocknr_T;
415 
416 /*
417  * mf_hashtab_T is a chained hashtable with blocknr_T key and arbitrary
418  * structures as items.  This is an intrusive data structure: we require
419  * that items begin with mf_hashitem_T which contains the key and linked
420  * list pointers.  List of items in each bucket is doubly-linked.
421  */
422 
423 typedef struct mf_hashitem_S mf_hashitem_T;
424 
425 struct mf_hashitem_S
426 {
427     mf_hashitem_T   *mhi_next;
428     mf_hashitem_T   *mhi_prev;
429     blocknr_T	    mhi_key;
430 };
431 
432 #define MHT_INIT_SIZE   64
433 
434 typedef struct mf_hashtab_S
435 {
436     long_u	    mht_mask;	    /* mask used for hash value (nr of items
437 				     * in array is "mht_mask" + 1) */
438     long_u	    mht_count;	    /* nr of items inserted into hashtable */
439     mf_hashitem_T   **mht_buckets;  /* points to mht_small_buckets or
440 				     *dynamically allocated array */
441     mf_hashitem_T   *mht_small_buckets[MHT_INIT_SIZE];   /* initial buckets */
442     char	    mht_fixed;	    /* non-zero value forbids growth */
443 } mf_hashtab_T;
444 
445 /*
446  * for each (previously) used block in the memfile there is one block header.
447  *
448  * The block may be linked in the used list OR in the free list.
449  * The used blocks are also kept in hash lists.
450  *
451  * The used list is a doubly linked list, most recently used block first.
452  *	The blocks in the used list have a block of memory allocated.
453  *	mf_used_count is the number of pages in the used list.
454  * The hash lists are used to quickly find a block in the used list.
455  * The free list is a single linked list, not sorted.
456  *	The blocks in the free list have no block of memory allocated and
457  *	the contents of the block in the file (if any) is irrelevant.
458  */
459 
460 struct block_hdr
461 {
462     mf_hashitem_T bh_hashitem;      /* header for hash table and key */
463 #define bh_bnum bh_hashitem.mhi_key /* block number, part of bh_hashitem */
464 
465     bhdr_T	*bh_next;	    /* next block_hdr in free or used list */
466     bhdr_T	*bh_prev;	    /* previous block_hdr in used list */
467     char_u	*bh_data;	    /* pointer to memory (for used block) */
468     int		bh_page_count;	    /* number of pages in this block */
469 
470 #define BH_DIRTY    1
471 #define BH_LOCKED   2
472     char	bh_flags;	    /* BH_DIRTY or BH_LOCKED */
473 };
474 
475 /*
476  * when a block with a negative number is flushed to the file, it gets
477  * a positive number. Because the reference to the block is still the negative
478  * number, we remember the translation to the new positive number in the
479  * double linked trans lists. The structure is the same as the hash lists.
480  */
481 typedef struct nr_trans NR_TRANS;
482 
483 struct nr_trans
484 {
485     mf_hashitem_T nt_hashitem;		/* header for hash table and key */
486 #define nt_old_bnum nt_hashitem.mhi_key	/* old, negative, number */
487 
488     blocknr_T	nt_new_bnum;		/* new, positive, number */
489 };
490 
491 
492 typedef struct buffblock buffblock_T;
493 typedef struct buffheader buffheader_T;
494 
495 /*
496  * structure used to store one block of the stuff/redo/recording buffers
497  */
498 struct buffblock
499 {
500     buffblock_T	*b_next;	/* pointer to next buffblock */
501     char_u	b_str[1];	/* contents (actually longer) */
502 };
503 
504 /*
505  * header used for the stuff buffer and the redo buffer
506  */
507 struct buffheader
508 {
509     buffblock_T	bh_first;	/* first (dummy) block of list */
510     buffblock_T	*bh_curr;	/* buffblock for appending */
511     int		bh_index;	/* index for reading */
512     int		bh_space;	/* space in bh_curr for appending */
513 };
514 
515 /*
516  * used for completion on the command line
517  */
518 typedef struct expand
519 {
520     int		xp_context;		/* type of expansion */
521     char_u	*xp_pattern;		/* start of item to expand */
522     int		xp_pattern_len;		/* bytes in xp_pattern before cursor */
523 #if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
524     char_u	*xp_arg;		/* completion function */
525     int		xp_scriptID;		/* SID for completion function */
526 #endif
527     int		xp_backslash;		/* one of the XP_BS_ values */
528 #ifndef BACKSLASH_IN_FILENAME
529     int		xp_shell;		/* TRUE for a shell command, more
530 					   characters need to be escaped */
531 #endif
532     int		xp_numfiles;		/* number of files found by
533 						    file name completion */
534     char_u	**xp_files;		/* list of files */
535     char_u	*xp_line;		/* text being completed */
536     int		xp_col;			/* cursor position in line */
537 } expand_T;
538 
539 /* values for xp_backslash */
540 #define XP_BS_NONE	0	/* nothing special for backslashes */
541 #define XP_BS_ONE	1	/* uses one backslash before a space */
542 #define XP_BS_THREE	2	/* uses three backslashes before a space */
543 
544 /*
545  * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
546  * This needs to be saved for recursive commands, put them in a structure for
547  * easy manipulation.
548  */
549 typedef struct
550 {
551     int		hide;			/* TRUE when ":hide" was used */
552 # ifdef FEAT_BROWSE_CMD
553     int		browse;			/* TRUE to invoke file dialog */
554 # endif
555 # ifdef FEAT_WINDOWS
556     int		split;			/* flags for win_split() */
557     int		tab;			/* > 0 when ":tab" was used */
558 # endif
559 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
560     int		confirm;		/* TRUE to invoke yes/no dialog */
561 # endif
562     int		keepalt;		/* TRUE when ":keepalt" was used */
563     int		keepmarks;		/* TRUE when ":keepmarks" was used */
564     int		keepjumps;		/* TRUE when ":keepjumps" was used */
565     int		lockmarks;		/* TRUE when ":lockmarks" was used */
566     int		keeppatterns;		/* TRUE when ":keeppatterns" was used */
567     int		noswapfile;		/* TRUE when ":noswapfile" was used */
568 # ifdef FEAT_AUTOCMD
569     char_u	*save_ei;		/* saved value of 'eventignore' */
570 # endif
571 } cmdmod_T;
572 
573 #define MF_SEED_LEN	8
574 
575 struct memfile
576 {
577     char_u	*mf_fname;		/* name of the file */
578     char_u	*mf_ffname;		/* idem, full path */
579     int		mf_fd;			/* file descriptor */
580     bhdr_T	*mf_free_first;		/* first block_hdr in free list */
581     bhdr_T	*mf_used_first;		/* mru block_hdr in used list */
582     bhdr_T	*mf_used_last;		/* lru block_hdr in used list */
583     unsigned	mf_used_count;		/* number of pages in used list */
584     unsigned	mf_used_count_max;	/* maximum number of pages in memory */
585     mf_hashtab_T mf_hash;		/* hash lists */
586     mf_hashtab_T mf_trans;		/* trans lists */
587     blocknr_T	mf_blocknr_max;		/* highest positive block number + 1*/
588     blocknr_T	mf_blocknr_min;		/* lowest negative block number - 1 */
589     blocknr_T	mf_neg_count;		/* number of negative blocks numbers */
590     blocknr_T	mf_infile_count;	/* number of pages in the file */
591     unsigned	mf_page_size;		/* number of bytes in a page */
592     int		mf_dirty;		/* TRUE if there are dirty blocks */
593 #ifdef FEAT_CRYPT
594     buf_T	*mf_buffer;		/* buffer this memfile is for */
595     char_u	mf_seed[MF_SEED_LEN];	/* seed for encryption */
596 
597     /* Values for key, method and seed used for reading data blocks when
598      * updating for a newly set key or method. Only when mf_old_key != NULL. */
599     char_u	*mf_old_key;
600     int		mf_old_cm;
601     char_u	mf_old_seed[MF_SEED_LEN];
602 #endif
603 };
604 
605 /*
606  * things used in memline.c
607  */
608 /*
609  * When searching for a specific line, we remember what blocks in the tree
610  * are the branches leading to that block. This is stored in ml_stack.  Each
611  * entry is a pointer to info in a block (may be data block or pointer block)
612  */
613 typedef struct info_pointer
614 {
615     blocknr_T	ip_bnum;	/* block number */
616     linenr_T	ip_low;		/* lowest lnum in this block */
617     linenr_T	ip_high;	/* highest lnum in this block */
618     int		ip_index;	/* index for block with current lnum */
619 } infoptr_T;	/* block/index pair */
620 
621 #ifdef FEAT_BYTEOFF
622 typedef struct ml_chunksize
623 {
624     int		mlcs_numlines;
625     long	mlcs_totalsize;
626 } chunksize_T;
627 
628  /* Flags when calling ml_updatechunk() */
629 
630 #define ML_CHNK_ADDLINE 1
631 #define ML_CHNK_DELLINE 2
632 #define ML_CHNK_UPDLINE 3
633 #endif
634 
635 /*
636  * the memline structure holds all the information about a memline
637  */
638 typedef struct memline
639 {
640     linenr_T	ml_line_count;	/* number of lines in the buffer */
641 
642     memfile_T	*ml_mfp;	/* pointer to associated memfile */
643 
644 #define ML_EMPTY	1	/* empty buffer */
645 #define ML_LINE_DIRTY	2	/* cached line was changed and allocated */
646 #define ML_LOCKED_DIRTY	4	/* ml_locked was changed */
647 #define ML_LOCKED_POS	8	/* ml_locked needs positive block number */
648     int		ml_flags;
649 
650     infoptr_T	*ml_stack;	/* stack of pointer blocks (array of IPTRs) */
651     int		ml_stack_top;	/* current top of ml_stack */
652     int		ml_stack_size;	/* total number of entries in ml_stack */
653 
654     linenr_T	ml_line_lnum;	/* line number of cached line, 0 if not valid */
655     char_u	*ml_line_ptr;	/* pointer to cached line */
656 
657     bhdr_T	*ml_locked;	/* block used by last ml_get */
658     linenr_T	ml_locked_low;	/* first line in ml_locked */
659     linenr_T	ml_locked_high;	/* last line in ml_locked */
660     int		ml_locked_lineadd;  /* number of lines inserted in ml_locked */
661 #ifdef FEAT_BYTEOFF
662     chunksize_T *ml_chunksize;
663     int		ml_numchunks;
664     int		ml_usedchunks;
665 #endif
666 } memline_T;
667 
668 #if defined(FEAT_SIGNS) || defined(PROTO)
669 typedef struct signlist signlist_T;
670 
671 struct signlist
672 {
673     int		id;		/* unique identifier for each placed sign */
674     linenr_T	lnum;		/* line number which has this sign */
675     int		typenr;		/* typenr of sign */
676     signlist_T	*next;		/* next signlist entry */
677 # ifdef FEAT_NETBEANS_INTG
678     signlist_T  *prev;		/* previous entry -- for easy reordering */
679 # endif
680 };
681 
682 /* type argument for buf_getsigntype() */
683 #define SIGN_ANY	0
684 #define SIGN_LINEHL	1
685 #define SIGN_ICON	2
686 #define SIGN_TEXT	3
687 #endif
688 
689 /*
690  * Argument list: Array of file names.
691  * Used for the global argument list and the argument lists local to a window.
692  */
693 typedef struct arglist
694 {
695     garray_T	al_ga;		/* growarray with the array of file names */
696     int		al_refcount;	/* number of windows using this arglist */
697     int		id;		/* id of this arglist */
698 } alist_T;
699 
700 /*
701  * For each argument remember the file name as it was given, and the buffer
702  * number that contains the expanded file name (required for when ":cd" is
703  * used.
704  */
705 typedef struct argentry
706 {
707     char_u	*ae_fname;	/* file name as specified */
708     int		ae_fnum;	/* buffer number with expanded file name */
709 } aentry_T;
710 
711 #ifdef FEAT_WINDOWS
712 # define ALIST(win) (win)->w_alist
713 #else
714 # define ALIST(win) (&global_alist)
715 #endif
716 #define GARGLIST	((aentry_T *)global_alist.al_ga.ga_data)
717 #define ARGLIST		((aentry_T *)ALIST(curwin)->al_ga.ga_data)
718 #define WARGLIST(wp)	((aentry_T *)ALIST(wp)->al_ga.ga_data)
719 #define AARGLIST(al)	((aentry_T *)((al)->al_ga.ga_data))
720 #define GARGCOUNT	(global_alist.al_ga.ga_len)
721 #define ARGCOUNT	(ALIST(curwin)->al_ga.ga_len)
722 #define WARGCOUNT(wp)	(ALIST(wp)->al_ga.ga_len)
723 
724 /*
725  * A list used for saving values of "emsg_silent".  Used by ex_try() to save the
726  * value of "emsg_silent" if it was non-zero.  When this is done, the CSF_SILENT
727  * flag below is set.
728  */
729 
730 typedef struct eslist_elem eslist_T;
731 struct eslist_elem
732 {
733     int		saved_emsg_silent;	/* saved value of "emsg_silent" */
734     eslist_T	*next;			/* next element on the list */
735 };
736 
737 /*
738  * For conditional commands a stack is kept of nested conditionals.
739  * When cs_idx < 0, there is no conditional command.
740  */
741 #define CSTACK_LEN	50
742 
743 struct condstack
744 {
745     short	cs_flags[CSTACK_LEN];	/* CSF_ flags */
746     char	cs_pending[CSTACK_LEN];	/* CSTP_: what's pending in ":finally"*/
747     union {
748 	void	*csp_rv[CSTACK_LEN];	/* return typeval for pending return */
749 	void	*csp_ex[CSTACK_LEN];	/* exception for pending throw */
750     }		cs_pend;
751     void	*cs_forinfo[CSTACK_LEN]; /* info used by ":for" */
752     int		cs_line[CSTACK_LEN];	/* line nr of ":while"/":for" line */
753     int		cs_idx;			/* current entry, or -1 if none */
754     int		cs_looplevel;		/* nr of nested ":while"s and ":for"s */
755     int		cs_trylevel;		/* nr of nested ":try"s */
756     eslist_T	*cs_emsg_silent_list;	/* saved values of "emsg_silent" */
757     char	cs_lflags;		/* loop flags: CSL_ flags */
758 };
759 # define cs_rettv	cs_pend.csp_rv
760 # define cs_exception	cs_pend.csp_ex
761 
762 /* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
763  * was used. */
764 # define CSF_TRUE	0x0001	/* condition was TRUE */
765 # define CSF_ACTIVE	0x0002	/* current state is active */
766 # define CSF_ELSE	0x0004	/* ":else" has been passed */
767 # define CSF_WHILE	0x0008	/* is a ":while" */
768 # define CSF_FOR	0x0010	/* is a ":for" */
769 
770 # define CSF_TRY	0x0100	/* is a ":try" */
771 # define CSF_FINALLY	0x0200	/* ":finally" has been passed */
772 # define CSF_THROWN	0x0400	/* exception thrown to this try conditional */
773 # define CSF_CAUGHT	0x0800  /* exception caught by this try conditional */
774 # define CSF_SILENT	0x1000	/* "emsg_silent" reset by ":try" */
775 /* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
776  * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
777 
778 /*
779  * What's pending for being reactivated at the ":endtry" of this try
780  * conditional:
781  */
782 # define CSTP_NONE	0	/* nothing pending in ":finally" clause */
783 # define CSTP_ERROR	1	/* an error is pending */
784 # define CSTP_INTERRUPT	2	/* an interrupt is pending */
785 # define CSTP_THROW	4	/* a throw is pending */
786 # define CSTP_BREAK	8	/* ":break" is pending */
787 # define CSTP_CONTINUE	16	/* ":continue" is pending */
788 # define CSTP_RETURN	24	/* ":return" is pending */
789 # define CSTP_FINISH	32	/* ":finish" is pending */
790 
791 /*
792  * Flags for the cs_lflags item in struct condstack.
793  */
794 # define CSL_HAD_LOOP	 1	/* just found ":while" or ":for" */
795 # define CSL_HAD_ENDLOOP 2	/* just found ":endwhile" or ":endfor" */
796 # define CSL_HAD_CONT	 4	/* just found ":continue" */
797 # define CSL_HAD_FINA	 8	/* just found ":finally" */
798 
799 /*
800  * A list of error messages that can be converted to an exception.  "throw_msg"
801  * is only set in the first element of the list.  Usually, it points to the
802  * original message stored in that element, but sometimes it points to a later
803  * message in the list.  See cause_errthrow() below.
804  */
805 struct msglist
806 {
807     char_u		*msg;		/* original message */
808     char_u		*throw_msg;	/* msg to throw: usually original one */
809     struct msglist	*next;		/* next of several messages in a row */
810 };
811 
812 /*
813  * Structure describing an exception.
814  * (don't use "struct exception", it's used by the math library).
815  */
816 typedef struct vim_exception except_T;
817 struct vim_exception
818 {
819     int			type;		/* exception type */
820     char_u		*value;		/* exception value */
821     struct msglist	*messages;	/* message(s) causing error exception */
822     char_u		*throw_name;	/* name of the throw point */
823     linenr_T		throw_lnum;	/* line number of the throw point */
824     except_T		*caught;	/* next exception on the caught stack */
825 };
826 
827 /*
828  * The exception types.
829  */
830 #define ET_USER		0	/* exception caused by ":throw" command */
831 #define ET_ERROR	1	/* error exception */
832 #define ET_INTERRUPT	2	/* interrupt exception triggered by Ctrl-C */
833 
834 /*
835  * Structure to save the error/interrupt/exception state between calls to
836  * enter_cleanup() and leave_cleanup().  Must be allocated as an automatic
837  * variable by the (common) caller of these functions.
838  */
839 typedef struct cleanup_stuff cleanup_T;
840 struct cleanup_stuff
841 {
842     int pending;		/* error/interrupt/exception state */
843     except_T *exception;	/* exception value */
844 };
845 
846 #ifdef FEAT_SYN_HL
847 /* struct passed to in_id_list() */
848 struct sp_syn
849 {
850     int		inc_tag;	/* ":syn include" unique tag */
851     short	id;		/* highlight group ID of item */
852     short	*cont_in_list;	/* cont.in group IDs, if non-zero */
853 };
854 
855 /*
856  * Each keyword has one keyentry, which is linked in a hash list.
857  */
858 typedef struct keyentry keyentry_T;
859 
860 struct keyentry
861 {
862     keyentry_T	*ke_next;	/* next entry with identical "keyword[]" */
863     struct sp_syn k_syn;	/* struct passed to in_id_list() */
864     short	*next_list;	/* ID list for next match (if non-zero) */
865     int		flags;
866     int		k_char;		/* conceal substitute character */
867     char_u	keyword[1];	/* actually longer */
868 };
869 
870 /*
871  * Struct used to store one state of the state stack.
872  */
873 typedef struct buf_state
874 {
875     int		    bs_idx;	 /* index of pattern */
876     int		    bs_flags;	 /* flags for pattern */
877 #ifdef FEAT_CONCEAL
878     int		    bs_seqnr;	 /* stores si_seqnr */
879     int		    bs_cchar;	 /* stores si_cchar */
880 #endif
881     reg_extmatch_T *bs_extmatch; /* external matches from start pattern */
882 } bufstate_T;
883 
884 /*
885  * syn_state contains the syntax state stack for the start of one line.
886  * Used by b_sst_array[].
887  */
888 typedef struct syn_state synstate_T;
889 
890 struct syn_state
891 {
892     synstate_T	*sst_next;	/* next entry in used or free list */
893     linenr_T	sst_lnum;	/* line number for this state */
894     union
895     {
896 	bufstate_T	sst_stack[SST_FIX_STATES]; /* short state stack */
897 	garray_T	sst_ga;	/* growarray for long state stack */
898     } sst_union;
899     int		sst_next_flags;	/* flags for sst_next_list */
900     int		sst_stacksize;	/* number of states on the stack */
901     short	*sst_next_list;	/* "nextgroup" list in this state
902 				 * (this is a copy, don't free it! */
903     disptick_T	sst_tick;	/* tick when last displayed */
904     linenr_T	sst_change_lnum;/* when non-zero, change in this line
905 				 * may have made the state invalid */
906 };
907 #endif /* FEAT_SYN_HL */
908 
909 /*
910  * Structure shared between syntax.c, screen.c and gui_x11.c.
911  */
912 typedef struct attr_entry
913 {
914     short	    ae_attr;		/* HL_BOLD, etc. */
915     union
916     {
917 	struct
918 	{
919 	    char_u	    *start;	/* start escape sequence */
920 	    char_u	    *stop;	/* stop escape sequence */
921 	} term;
922 	struct
923 	{
924 	    /* These colors need to be > 8 bits to hold 256. */
925 	    short_u	    fg_color;	/* foreground color number */
926 	    short_u	    bg_color;	/* background color number */
927 # ifdef FEAT_TERMGUICOLORS
928 	    long_u	    fg_rgb;	/* foreground color RGB */
929 	    long_u	    bg_rgb;	/* background color RGB */
930 # endif
931 	} cterm;
932 # ifdef FEAT_GUI
933 	struct
934 	{
935 	    guicolor_T	    fg_color;	/* foreground color handle */
936 	    guicolor_T	    bg_color;	/* background color handle */
937 	    guicolor_T	    sp_color;	/* special color handle */
938 	    GuiFont	    font;	/* font handle */
939 #  ifdef FEAT_XFONTSET
940 	    GuiFontset	    fontset;	/* fontset handle */
941 #  endif
942 	} gui;
943 # endif
944     } ae_u;
945 } attrentry_T;
946 
947 #ifdef USE_ICONV
948 # ifdef HAVE_ICONV_H
949 #  include <iconv.h>
950 # else
951 #  if defined(MACOS_X)
952 #   include <sys/errno.h>
953 #   define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
954 typedef struct _iconv_t *iconv_t;
955 #  else
956 #   if defined(MACOS_CLASSIC)
957 typedef struct _iconv_t *iconv_t;
958 #    define EINVAL	22
959 #    define E2BIG	7
960 #    define ENOENT	2
961 #    define EFAULT	14
962 #    define EILSEQ	123
963 #   else
964 #    include <errno.h>
965 #   endif
966 #  endif
967 typedef void *iconv_t;
968 # endif
969 #endif
970 
971 /*
972  * Used for the typeahead buffer: typebuf.
973  */
974 typedef struct
975 {
976     char_u	*tb_buf;	/* buffer for typed characters */
977     char_u	*tb_noremap;	/* mapping flags for characters in tb_buf[] */
978     int		tb_buflen;	/* size of tb_buf[] */
979     int		tb_off;		/* current position in tb_buf[] */
980     int		tb_len;		/* number of valid bytes in tb_buf[] */
981     int		tb_maplen;	/* nr of mapped bytes in tb_buf[] */
982     int		tb_silent;	/* nr of silently mapped bytes in tb_buf[] */
983     int		tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */
984     int		tb_change_cnt;	/* nr of time tb_buf was changed; never zero */
985 } typebuf_T;
986 
987 /* Struct to hold the saved typeahead for save_typeahead(). */
988 typedef struct
989 {
990     typebuf_T		save_typebuf;
991     int			typebuf_valid;	    /* TRUE when save_typebuf valid */
992     int			old_char;
993     int			old_mod_mask;
994     buffheader_T	save_readbuf1;
995     buffheader_T	save_readbuf2;
996 #ifdef USE_INPUT_BUF
997     char_u		*save_inputbuf;
998 #endif
999 } tasave_T;
1000 
1001 /*
1002  * Used for conversion of terminal I/O and script files.
1003  */
1004 typedef struct
1005 {
1006     int		vc_type;	/* zero or one of the CONV_ values */
1007     int		vc_factor;	/* max. expansion factor */
1008 # ifdef WIN3264
1009     int		vc_cpfrom;	/* codepage to convert from (CONV_CODEPAGE) */
1010     int		vc_cpto;	/* codepage to convert to (CONV_CODEPAGE) */
1011 # endif
1012 # ifdef USE_ICONV
1013     iconv_t	vc_fd;		/* for CONV_ICONV */
1014 # endif
1015     int		vc_fail;	/* fail for invalid char, don't use '?' */
1016 } vimconv_T;
1017 
1018 /*
1019  * Structure used for reading from the viminfo file.
1020  */
1021 typedef struct
1022 {
1023     char_u	*vir_line;	/* text of the current line */
1024     FILE	*vir_fd;	/* file descriptor */
1025 #ifdef FEAT_MBYTE
1026     vimconv_T	vir_conv;	/* encoding conversion */
1027 #endif
1028     int		vir_version;	/* viminfo version detected or -1 */
1029     garray_T	vir_barlines;	/* lines starting with | */
1030 } vir_T;
1031 
1032 #define CONV_NONE		0
1033 #define CONV_TO_UTF8		1
1034 #define CONV_9_TO_UTF8		2
1035 #define CONV_TO_LATIN1		3
1036 #define CONV_TO_LATIN9		4
1037 #define CONV_ICONV		5
1038 #ifdef WIN3264
1039 # define CONV_CODEPAGE		10	/* codepage -> codepage */
1040 #endif
1041 #ifdef MACOS_X
1042 # define CONV_MAC_LATIN1	20
1043 # define CONV_LATIN1_MAC	21
1044 # define CONV_MAC_UTF8		22
1045 # define CONV_UTF8_MAC		23
1046 #endif
1047 
1048 /*
1049  * Structure used for mappings and abbreviations.
1050  */
1051 typedef struct mapblock mapblock_T;
1052 struct mapblock
1053 {
1054     mapblock_T	*m_next;	/* next mapblock in list */
1055     char_u	*m_keys;	/* mapped from, lhs */
1056     char_u	*m_str;		/* mapped to, rhs */
1057     char_u	*m_orig_str;	/* rhs as entered by the user */
1058     int		m_keylen;	/* strlen(m_keys) */
1059     int		m_mode;		/* valid mode */
1060     int		m_noremap;	/* if non-zero no re-mapping for m_str */
1061     char	m_silent;	/* <silent> used, don't echo commands */
1062     char	m_nowait;	/* <nowait> used */
1063 #ifdef FEAT_EVAL
1064     char	m_expr;		/* <expr> used, m_str is an expression */
1065     scid_T	m_script_ID;	/* ID of script where map was defined */
1066 #endif
1067 };
1068 
1069 /*
1070  * Used for highlighting in the status line.
1071  */
1072 struct stl_hlrec
1073 {
1074     char_u	*start;
1075     int		userhl;		/* 0: no HL, 1-9: User HL, < 0 for syn ID */
1076 };
1077 
1078 
1079 /*
1080  * Syntax items - usually buffer-specific.
1081  */
1082 
1083 /* Item for a hashtable.  "hi_key" can be one of three values:
1084  * NULL:	   Never been used
1085  * HI_KEY_REMOVED: Entry was removed
1086  * Otherwise:	   Used item, pointer to the actual key; this usually is
1087  *		   inside the item, subtract an offset to locate the item.
1088  *		   This reduces the size of hashitem by 1/3.
1089  */
1090 typedef struct hashitem_S
1091 {
1092     long_u	hi_hash;	/* cached hash number of hi_key */
1093     char_u	*hi_key;
1094 } hashitem_T;
1095 
1096 /* The address of "hash_removed" is used as a magic number for hi_key to
1097  * indicate a removed item. */
1098 #define HI_KEY_REMOVED &hash_removed
1099 #define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
1100 
1101 /* Initial size for a hashtable.  Our items are relatively small and growing
1102  * is expensive, thus use 16 as a start.  Must be a power of 2. */
1103 #define HT_INIT_SIZE 16
1104 
1105 typedef struct hashtable_S
1106 {
1107     long_u	ht_mask;	/* mask used for hash value (nr of items in
1108 				 * array is "ht_mask" + 1) */
1109     long_u	ht_used;	/* number of items used */
1110     long_u	ht_filled;	/* number of items used + removed */
1111     int		ht_locked;	/* counter for hash_lock() */
1112     int		ht_error;	/* when set growing failed, can't add more
1113 				   items before growing works */
1114     hashitem_T	*ht_array;	/* points to the array, allocated when it's
1115 				   not "ht_smallarray" */
1116     hashitem_T	ht_smallarray[HT_INIT_SIZE];   /* initial array */
1117 } hashtab_T;
1118 
1119 typedef long_u hash_T;		/* Type for hi_hash */
1120 
1121 
1122 #ifdef FEAT_NUM64
1123 /* Use 64-bit Number. */
1124 # ifdef WIN3264
1125 typedef __int64		    varnumber_T;
1126 typedef unsigned __int64    uvarnumber_T;
1127 # elif defined(HAVE_STDINT_H)
1128 typedef int64_t		    varnumber_T;
1129 typedef uint64_t	    uvarnumber_T;
1130 # else
1131 typedef long		    varnumber_T;
1132 typedef unsigned long	    uvarnumber_T;
1133 # endif
1134 #else
1135 /* Use 32-bit Number. */
1136 # if VIM_SIZEOF_INT <= 3	/* use long if int is smaller than 32 bits */
1137 typedef long		    varnumber_T;
1138 typedef unsigned long	    uvarnumber_T;
1139 # else
1140 typedef int		    varnumber_T;
1141 typedef unsigned int	    uvarnumber_T;
1142 # endif
1143 #endif
1144 
1145 typedef double	float_T;
1146 
1147 typedef struct listvar_S list_T;
1148 typedef struct dictvar_S dict_T;
1149 typedef struct partial_S partial_T;
1150 
1151 typedef struct jobvar_S job_T;
1152 typedef struct readq_S readq_T;
1153 typedef struct jsonq_S jsonq_T;
1154 typedef struct cbq_S cbq_T;
1155 typedef struct channel_S channel_T;
1156 
1157 typedef enum
1158 {
1159     VAR_UNKNOWN = 0,
1160     VAR_NUMBER,	 /* "v_number" is used */
1161     VAR_STRING,	 /* "v_string" is used */
1162     VAR_FUNC,	 /* "v_string" is function name */
1163     VAR_PARTIAL, /* "v_partial" is used */
1164     VAR_LIST,	 /* "v_list" is used */
1165     VAR_DICT,	 /* "v_dict" is used */
1166     VAR_FLOAT,	 /* "v_float" is used */
1167     VAR_SPECIAL, /* "v_number" is used */
1168     VAR_JOB,	 /* "v_job" is used */
1169     VAR_CHANNEL	 /* "v_channel" is used */
1170 } vartype_T;
1171 
1172 /*
1173  * Structure to hold an internal variable without a name.
1174  */
1175 typedef struct
1176 {
1177     vartype_T	v_type;
1178     char	v_lock;	    /* see below: VAR_LOCKED, VAR_FIXED */
1179     union
1180     {
1181 	varnumber_T	v_number;	/* number value */
1182 #ifdef FEAT_FLOAT
1183 	float_T		v_float;	/* floating number value */
1184 #endif
1185 	char_u		*v_string;	/* string value (can be NULL!) */
1186 	list_T		*v_list;	/* list value (can be NULL!) */
1187 	dict_T		*v_dict;	/* dict value (can be NULL!) */
1188 	partial_T	*v_partial;	/* closure: function with args */
1189 #ifdef FEAT_JOB_CHANNEL
1190 	job_T		*v_job;		/* job value (can be NULL!) */
1191 	channel_T	*v_channel;	/* channel value (can be NULL!) */
1192 #endif
1193     }		vval;
1194 } typval_T;
1195 
1196 /* Values for "dv_scope". */
1197 #define VAR_SCOPE     1	/* a:, v:, s:, etc. scope dictionaries */
1198 #define VAR_DEF_SCOPE 2	/* l:, g: scope dictionaries: here funcrefs are not
1199 			   allowed to mask existing functions */
1200 
1201 /* Values for "v_lock". */
1202 #define VAR_LOCKED  1	/* locked with lock(), can use unlock() */
1203 #define VAR_FIXED   2	/* locked forever */
1204 
1205 /*
1206  * Structure to hold an item of a list: an internal variable without a name.
1207  */
1208 typedef struct listitem_S listitem_T;
1209 
1210 struct listitem_S
1211 {
1212     listitem_T	*li_next;	/* next item in list */
1213     listitem_T	*li_prev;	/* previous item in list */
1214     typval_T	li_tv;		/* type and value of the variable */
1215 };
1216 
1217 /*
1218  * Struct used by those that are using an item in a list.
1219  */
1220 typedef struct listwatch_S listwatch_T;
1221 
1222 struct listwatch_S
1223 {
1224     listitem_T		*lw_item;	/* item being watched */
1225     listwatch_T		*lw_next;	/* next watcher */
1226 };
1227 
1228 /*
1229  * Structure to hold info about a list.
1230  */
1231 struct listvar_S
1232 {
1233     listitem_T	*lv_first;	/* first item, NULL if none */
1234     listitem_T	*lv_last;	/* last item, NULL if none */
1235     int		lv_refcount;	/* reference count */
1236     int		lv_len;		/* number of items */
1237     listwatch_T	*lv_watch;	/* first watcher, NULL if none */
1238     int		lv_idx;		/* cached index of an item */
1239     listitem_T	*lv_idx_item;	/* when not NULL item at index "lv_idx" */
1240     int		lv_copyID;	/* ID used by deepcopy() */
1241     list_T	*lv_copylist;	/* copied list used by deepcopy() */
1242     char	lv_lock;	/* zero, VAR_LOCKED, VAR_FIXED */
1243     list_T	*lv_used_next;	/* next list in used lists list */
1244     list_T	*lv_used_prev;	/* previous list in used lists list */
1245 };
1246 
1247 /*
1248  * Static list with 10 items.  Use init_static_list() to initialize.
1249  */
1250 typedef struct {
1251     list_T	sl_list;	/* must be first */
1252     listitem_T	sl_items[10];
1253 } staticList10_T;
1254 
1255 /*
1256  * Structure to hold an item of a Dictionary.
1257  * Also used for a variable.
1258  * The key is copied into "di_key" to avoid an extra alloc/free for it.
1259  */
1260 struct dictitem_S
1261 {
1262     typval_T	di_tv;		/* type and value of the variable */
1263     char_u	di_flags;	/* flags (only used for variable) */
1264     char_u	di_key[1];	/* key (actually longer!) */
1265 };
1266 typedef struct dictitem_S dictitem_T;
1267 
1268 /* A dictitem with a 16 character key (plus NUL). */
1269 struct dictitem16_S
1270 {
1271     typval_T	di_tv;		/* type and value of the variable */
1272     char_u	di_flags;	/* flags (only used for variable) */
1273     char_u	di_key[17];	/* key */
1274 };
1275 typedef struct dictitem16_S dictitem16_T;
1276 
1277 #define DI_FLAGS_RO	1  /* "di_flags" value: read-only variable */
1278 #define DI_FLAGS_RO_SBX 2  /* "di_flags" value: read-only in the sandbox */
1279 #define DI_FLAGS_FIX	4  /* "di_flags" value: fixed: no :unlet or remove() */
1280 #define DI_FLAGS_LOCK	8  /* "di_flags" value: locked variable */
1281 #define DI_FLAGS_ALLOC	16 /* "di_flags" value: separately allocated */
1282 
1283 /*
1284  * Structure to hold info about a Dictionary.
1285  */
1286 struct dictvar_S
1287 {
1288     char	dv_lock;	/* zero, VAR_LOCKED, VAR_FIXED */
1289     char	dv_scope;	/* zero, VAR_SCOPE, VAR_DEF_SCOPE */
1290     int		dv_refcount;	/* reference count */
1291     int		dv_copyID;	/* ID used by deepcopy() */
1292     hashtab_T	dv_hashtab;	/* hashtab that refers to the items */
1293     dict_T	*dv_copydict;	/* copied dict used by deepcopy() */
1294     dict_T	*dv_used_next;	/* next dict in used dicts list */
1295     dict_T	*dv_used_prev;	/* previous dict in used dicts list */
1296 };
1297 
1298 struct partial_S
1299 {
1300     int		pt_refcount;	/* reference count */
1301     char_u	*pt_name;	/* function name */
1302     int		pt_auto;	/* when TRUE the partial was created for using
1303 				   dict.member in handle_subscript() */
1304     int		pt_argc;	/* number of arguments */
1305     typval_T	*pt_argv;	/* arguments in allocated array */
1306     dict_T	*pt_dict;	/* dict for "self" */
1307 };
1308 
1309 typedef enum
1310 {
1311     JOB_FAILED,
1312     JOB_STARTED,
1313     JOB_ENDED
1314 } jobstatus_T;
1315 
1316 /*
1317  * Structure to hold info about a Job.
1318  */
1319 struct jobvar_S
1320 {
1321     job_T	*jv_next;
1322     job_T	*jv_prev;
1323 #ifdef UNIX
1324     pid_t	jv_pid;
1325 #endif
1326 #ifdef WIN32
1327     PROCESS_INFORMATION	jv_proc_info;
1328     HANDLE		jv_job_object;
1329 #endif
1330     jobstatus_T	jv_status;
1331     char_u	*jv_stoponexit; /* allocated */
1332     int		jv_exitval;
1333     char_u	*jv_exit_cb;	/* allocated */
1334     partial_T	*jv_exit_partial;
1335 
1336     buf_T	*jv_in_buf;	/* buffer from "in-name" */
1337 
1338     int		jv_refcount;	/* reference count */
1339     int		jv_copyID;
1340 
1341     channel_T	*jv_channel;	/* channel for I/O, reference counted */
1342 };
1343 
1344 /*
1345  * Structures to hold info about a Channel.
1346  */
1347 struct readq_S
1348 {
1349     char_u	*rq_buffer;
1350     long_u	rq_buflen;
1351     readq_T	*rq_next;
1352     readq_T	*rq_prev;
1353 };
1354 
1355 struct jsonq_S
1356 {
1357     typval_T	*jq_value;
1358     jsonq_T	*jq_next;
1359     jsonq_T	*jq_prev;
1360 };
1361 
1362 struct cbq_S
1363 {
1364     char_u	*cq_callback;
1365     partial_T	*cq_partial;
1366     int		cq_seq_nr;
1367     cbq_T	*cq_next;
1368     cbq_T	*cq_prev;
1369 };
1370 
1371 /* mode for a channel */
1372 typedef enum
1373 {
1374     MODE_NL = 0,
1375     MODE_RAW,
1376     MODE_JSON,
1377     MODE_JS
1378 } ch_mode_T;
1379 
1380 typedef enum {
1381     JIO_PIPE,	    /* default */
1382     JIO_NULL,
1383     JIO_FILE,
1384     JIO_BUFFER,
1385     JIO_OUT
1386 } job_io_T;
1387 
1388 /* Ordering matters, it is used in for loops: IN is last, only SOCK/OUT/ERR
1389  * are polled. */
1390 #define PART_SOCK   0
1391 #define CH_SOCK_FD	ch_part[PART_SOCK].ch_fd
1392 
1393 #ifdef FEAT_JOB_CHANNEL
1394 # define INVALID_FD  (-1)
1395 
1396 # define PART_OUT   1
1397 # define PART_ERR   2
1398 # define PART_IN    3
1399 # define CH_OUT_FD	ch_part[PART_OUT].ch_fd
1400 # define CH_ERR_FD	ch_part[PART_ERR].ch_fd
1401 # define CH_IN_FD	ch_part[PART_IN].ch_fd
1402 #endif
1403 
1404 /* The per-fd info for a channel. */
1405 typedef struct {
1406     sock_T	ch_fd;	    /* socket/stdin/stdout/stderr, -1 if not used */
1407 
1408 # if defined(UNIX) && !defined(HAVE_SELECT)
1409     int		ch_poll_idx;	/* used by channel_poll_setup() */
1410 # endif
1411 
1412 #ifdef FEAT_GUI_X11
1413     XtInputId	ch_inputHandler; /* Cookie for input */
1414 #endif
1415 #ifdef FEAT_GUI_GTK
1416     gint	ch_inputHandler; /* Cookie for input */
1417 #endif
1418 
1419     ch_mode_T	ch_mode;
1420     job_io_T	ch_io;
1421     int		ch_timeout;	/* request timeout in msec */
1422 
1423     readq_T	ch_head;	/* header for circular raw read queue */
1424     jsonq_T	ch_json_head;	/* header for circular json read queue */
1425     int		ch_block_id;	/* ID that channel_read_json_block() is
1426 				   waiting for */
1427     /* When ch_waiting is TRUE use ch_deadline to wait for incomplete message
1428      * to be complete. */
1429     int		ch_waiting;
1430 #ifdef WIN32
1431     DWORD	ch_deadline;
1432 #else
1433     struct timeval ch_deadline;
1434 #endif
1435     int		ch_block_write;	/* for testing: 0 when not used, -1 when write
1436 				 * does not block, 1 simulate blocking */
1437 
1438     cbq_T	ch_cb_head;	/* dummy node for per-request callbacks */
1439     char_u	*ch_callback;	/* call when a msg is not handled */
1440     partial_T	*ch_partial;
1441 
1442     bufref_T	ch_bufref;	/* buffer to read from or write to */
1443     int		ch_nomodifiable; /* TRUE when buffer can be 'nomodifiable' */
1444     int		ch_nomod_error;	/* TRUE when e_modifiable was given */
1445     int		ch_buf_append;	/* write appended lines instead top-bot */
1446     linenr_T	ch_buf_top;	/* next line to send */
1447     linenr_T	ch_buf_bot;	/* last line to send */
1448 } chanpart_T;
1449 
1450 struct channel_S {
1451     channel_T	*ch_next;
1452     channel_T	*ch_prev;
1453 
1454     int		ch_id;		/* ID of the channel */
1455     int		ch_last_msg_id;	/* ID of the last message */
1456 
1457     chanpart_T	ch_part[4];	/* info for socket, out, err and in */
1458 
1459     char	*ch_hostname;	/* only for socket, allocated */
1460     int		ch_port;	/* only for socket */
1461 
1462     int		ch_to_be_closed; /* When TRUE reading or writing failed and
1463 				  * the channel must be closed when it's safe
1464 				  * to invoke callbacks. */
1465     int		ch_to_be_freed; /* When TRUE channel must be freed when it's
1466 				 * safe to invoke callbacks. */
1467     int		ch_error;	/* When TRUE an error was reported.  Avoids
1468 				 * giving pages full of error messages when
1469 				 * the other side has exited, only mention the
1470 				 * first error until the connection works
1471 				 * again. */
1472 
1473     void	(*ch_nb_close_cb)(void);
1474 				/* callback for Netbeans when channel is
1475 				 * closed */
1476 
1477     char_u	*ch_callback;	/* call when any msg is not handled */
1478     partial_T	*ch_partial;
1479     char_u	*ch_close_cb;	/* call when channel is closed */
1480     partial_T	*ch_close_partial;
1481 
1482     job_T	*ch_job;	/* Job that uses this channel; this does not
1483 				 * count as a reference to avoid a circular
1484 				 * reference, the job refers to the channel. */
1485     int		ch_job_killed;	/* TRUE when there was a job and it was killed
1486 				 * or we know it died. */
1487 
1488     int		ch_refcount;	/* reference count */
1489     int		ch_copyID;
1490 };
1491 
1492 #define JO_MODE		    0x0001	/* channel mode */
1493 #define JO_IN_MODE	    0x0002	/* stdin mode */
1494 #define JO_OUT_MODE	    0x0004	/* stdout mode */
1495 #define JO_ERR_MODE	    0x0008	/* stderr mode */
1496 #define JO_CALLBACK	    0x0010	/* channel callback */
1497 #define JO_OUT_CALLBACK	    0x0020	/* stdout callback */
1498 #define JO_ERR_CALLBACK	    0x0040	/* stderr callback */
1499 #define JO_CLOSE_CALLBACK   0x0080	/* close callback */
1500 #define JO_WAITTIME	    0x0100	/* only for ch_open() */
1501 #define JO_TIMEOUT	    0x0200	/* all timeouts */
1502 #define JO_OUT_TIMEOUT	    0x0400	/* stdout timeouts */
1503 #define JO_ERR_TIMEOUT	    0x0800	/* stderr timeouts */
1504 #define JO_PART		    0x1000	/* "part" */
1505 #define JO_ID		    0x2000	/* "id" */
1506 #define JO_STOPONEXIT	    0x4000	/* "stoponexit" */
1507 #define JO_EXIT_CB	    0x8000	/* "exit_cb" */
1508 #define JO_OUT_IO	    0x10000	/* "out_io" */
1509 #define JO_ERR_IO	    0x20000	/* "err_io" (JO_OUT_IO << 1) */
1510 #define JO_IN_IO	    0x40000	/* "in_io" (JO_OUT_IO << 2) */
1511 #define JO_OUT_NAME	    0x80000	/* "out_name" */
1512 #define JO_ERR_NAME	    0x100000	/* "err_name" (JO_OUT_NAME << 1) */
1513 #define JO_IN_NAME	    0x200000	/* "in_name" (JO_OUT_NAME << 2) */
1514 #define JO_IN_TOP	    0x400000	/* "in_top" */
1515 #define JO_IN_BOT	    0x800000	/* "in_bot" */
1516 #define JO_OUT_BUF	    0x1000000	/* "out_buf" */
1517 #define JO_ERR_BUF	    0x2000000	/* "err_buf" (JO_OUT_BUF << 1) */
1518 #define JO_IN_BUF	    0x4000000	/* "in_buf" (JO_OUT_BUF << 2) */
1519 #define JO_CHANNEL	    0x8000000	/* "channel" */
1520 #define JO_BLOCK_WRITE	    0x10000000	/* "block_write" */
1521 #define JO_OUT_MODIFIABLE   0x20000000	/* "out_modifiable" */
1522 #define JO_ERR_MODIFIABLE   0x40000000	/* "err_modifiable" (JO_OUT_ << 1) */
1523 #define JO_ALL		    0x7fffffff
1524 
1525 #define JO_MODE_ALL	(JO_MODE + JO_IN_MODE + JO_OUT_MODE + JO_ERR_MODE)
1526 #define JO_CB_ALL \
1527     (JO_CALLBACK + JO_OUT_CALLBACK + JO_ERR_CALLBACK + JO_CLOSE_CALLBACK)
1528 #define JO_TIMEOUT_ALL	(JO_TIMEOUT + JO_OUT_TIMEOUT + JO_ERR_TIMEOUT)
1529 
1530 /*
1531  * Options for job and channel commands.
1532  */
1533 typedef struct
1534 {
1535     int		jo_set;		/* JO_ bits for values that were set */
1536 
1537     ch_mode_T	jo_mode;
1538     ch_mode_T	jo_in_mode;
1539     ch_mode_T	jo_out_mode;
1540     ch_mode_T	jo_err_mode;
1541 
1542     job_io_T	jo_io[4];	/* PART_OUT, PART_ERR, PART_IN */
1543     char_u	jo_io_name_buf[4][NUMBUFLEN];
1544     char_u	*jo_io_name[4];	/* not allocated! */
1545     int		jo_io_buf[4];
1546     int		jo_modifiable[4];
1547     channel_T	*jo_channel;
1548 
1549     linenr_T	jo_in_top;
1550     linenr_T	jo_in_bot;
1551 
1552     char_u	*jo_callback;	/* not allocated! */
1553     partial_T	*jo_partial;	/* not referenced! */
1554     char_u	*jo_out_cb;	/* not allocated! */
1555     partial_T	*jo_out_partial; /* not referenced! */
1556     char_u	*jo_err_cb;	/* not allocated! */
1557     partial_T	*jo_err_partial; /* not referenced! */
1558     char_u	*jo_close_cb;	/* not allocated! */
1559     partial_T	*jo_close_partial; /* not referenced! */
1560     char_u	*jo_exit_cb;	/* not allocated! */
1561     partial_T	*jo_exit_partial; /* not referenced! */
1562     int		jo_waittime;
1563     int		jo_timeout;
1564     int		jo_out_timeout;
1565     int		jo_err_timeout;
1566     int		jo_block_write;	/* for testing only */
1567     int		jo_part;
1568     int		jo_id;
1569     char_u	jo_soe_buf[NUMBUFLEN];
1570     char_u	*jo_stoponexit;
1571 } jobopt_T;
1572 
1573 
1574 /* structure used for explicit stack while garbage collecting hash tables */
1575 typedef struct ht_stack_S
1576 {
1577     hashtab_T		*ht;
1578     struct ht_stack_S	*prev;
1579 } ht_stack_T;
1580 
1581 /* structure used for explicit stack while garbage collecting lists */
1582 typedef struct list_stack_S
1583 {
1584     list_T		*list;
1585     struct list_stack_S	*prev;
1586 } list_stack_T;
1587 
1588 /* values for b_syn_spell: what to do with toplevel text */
1589 #define SYNSPL_DEFAULT	0	/* spell check if @Spell not defined */
1590 #define SYNSPL_TOP	1	/* spell check toplevel text */
1591 #define SYNSPL_NOTOP	2	/* don't spell check toplevel text */
1592 
1593 /* avoid #ifdefs for when b_spell is not available */
1594 #ifdef FEAT_SPELL
1595 # define B_SPELL(buf)  ((buf)->b_spell)
1596 #else
1597 # define B_SPELL(buf)  (0)
1598 #endif
1599 
1600 #ifdef FEAT_QUICKFIX
1601 typedef struct qf_info_S qf_info_T;
1602 #endif
1603 
1604 #ifdef FEAT_PROFILE
1605 /*
1606  * Used for :syntime: timing of executing a syntax pattern.
1607  */
1608 typedef struct {
1609     proftime_T	total;		/* total time used */
1610     proftime_T	slowest;	/* time of slowest call */
1611     long	count;		/* nr of times used */
1612     long	match;		/* nr of times matched */
1613 } syn_time_T;
1614 #endif
1615 
1616 #ifdef FEAT_CRYPT
1617 /*
1618  * Structure to hold the type of encryption and the state of encryption or
1619  * decryption.
1620  */
1621 typedef struct {
1622     int	    method_nr;
1623     void    *method_state;  /* method-specific state information */
1624 } cryptstate_T;
1625 
1626 /* values for method_nr */
1627 # define CRYPT_M_ZIP	0
1628 # define CRYPT_M_BF	1
1629 # define CRYPT_M_BF2	2
1630 # define CRYPT_M_COUNT	3 /* number of crypt methods */
1631 #endif
1632 
1633 
1634 /*
1635  * These are items normally related to a buffer.  But when using ":ownsyntax"
1636  * a window may have its own instance.
1637  */
1638 typedef struct {
1639 #ifdef FEAT_SYN_HL
1640     hashtab_T	b_keywtab;		/* syntax keywords hash table */
1641     hashtab_T	b_keywtab_ic;		/* idem, ignore case */
1642     int		b_syn_error;		/* TRUE when error occurred in HL */
1643     int		b_syn_ic;		/* ignore case for :syn cmds */
1644     int		b_syn_spell;		/* SYNSPL_ values */
1645     garray_T	b_syn_patterns;		/* table for syntax patterns */
1646     garray_T	b_syn_clusters;		/* table for syntax clusters */
1647     int		b_spell_cluster_id;	/* @Spell cluster ID or 0 */
1648     int		b_nospell_cluster_id;	/* @NoSpell cluster ID or 0 */
1649     int		b_syn_containedin;	/* TRUE when there is an item with a
1650 					   "containedin" argument */
1651     int		b_syn_sync_flags;	/* flags about how to sync */
1652     short	b_syn_sync_id;		/* group to sync on */
1653     long	b_syn_sync_minlines;	/* minimal sync lines offset */
1654     long	b_syn_sync_maxlines;	/* maximal sync lines offset */
1655     long	b_syn_sync_linebreaks;	/* offset for multi-line pattern */
1656     char_u	*b_syn_linecont_pat;	/* line continuation pattern */
1657     regprog_T	*b_syn_linecont_prog;	/* line continuation program */
1658 #ifdef FEAT_PROFILE
1659     syn_time_T  b_syn_linecont_time;
1660 #endif
1661     int		b_syn_linecont_ic;	/* ignore-case flag for above */
1662     int		b_syn_topgrp;		/* for ":syntax include" */
1663 # ifdef FEAT_CONCEAL
1664     int		b_syn_conceal;		/* auto-conceal for :syn cmds */
1665 # endif
1666 # ifdef FEAT_FOLDING
1667     int		b_syn_folditems;	/* number of patterns with the HL_FOLD
1668 					   flag set */
1669 # endif
1670     /*
1671      * b_sst_array[] contains the state stack for a number of lines, for the
1672      * start of that line (col == 0).  This avoids having to recompute the
1673      * syntax state too often.
1674      * b_sst_array[] is allocated to hold the state for all displayed lines,
1675      * and states for 1 out of about 20 other lines.
1676      * b_sst_array	pointer to an array of synstate_T
1677      * b_sst_len	number of entries in b_sst_array[]
1678      * b_sst_first	pointer to first used entry in b_sst_array[] or NULL
1679      * b_sst_firstfree	pointer to first free entry in b_sst_array[] or NULL
1680      * b_sst_freecount	number of free entries in b_sst_array[]
1681      * b_sst_check_lnum	entries after this lnum need to be checked for
1682      *			validity (MAXLNUM means no check needed)
1683      */
1684     synstate_T	*b_sst_array;
1685     int		b_sst_len;
1686     synstate_T	*b_sst_first;
1687     synstate_T	*b_sst_firstfree;
1688     int		b_sst_freecount;
1689     linenr_T	b_sst_check_lnum;
1690     short_u	b_sst_lasttick;	/* last display tick */
1691 #endif /* FEAT_SYN_HL */
1692 
1693 #ifdef FEAT_SPELL
1694     /* for spell checking */
1695     garray_T	b_langp;	/* list of pointers to slang_T, see spell.c */
1696     char_u	b_spell_ismw[256];/* flags: is midword char */
1697 # ifdef FEAT_MBYTE
1698     char_u	*b_spell_ismw_mb; /* multi-byte midword chars */
1699 # endif
1700     char_u	*b_p_spc;	/* 'spellcapcheck' */
1701     regprog_T	*b_cap_prog;	/* program for 'spellcapcheck' */
1702     char_u	*b_p_spf;	/* 'spellfile' */
1703     char_u	*b_p_spl;	/* 'spelllang' */
1704 # ifdef FEAT_MBYTE
1705     int		b_cjk;		/* all CJK letters as OK */
1706 # endif
1707 #endif
1708 #if !defined(FEAT_SYN_HL) && !defined(FEAT_SPELL)
1709     int		dummy;
1710 #endif
1711     char_u	b_syn_chartab[32];	/* syntax iskeyword option */
1712     char_u	*b_syn_isk;		/* iskeyword option */
1713 } synblock_T;
1714 
1715 
1716 /*
1717  * buffer: structure that holds information about one file
1718  *
1719  * Several windows can share a single Buffer
1720  * A buffer is unallocated if there is no memfile for it.
1721  * A buffer is new if the associated file has never been loaded yet.
1722  */
1723 
1724 struct file_buffer
1725 {
1726     memline_T	b_ml;		/* associated memline (also contains line
1727 				   count) */
1728 
1729     buf_T	*b_next;	/* links in list of buffers */
1730     buf_T	*b_prev;
1731 
1732     int		b_nwindows;	/* nr of windows open on this buffer */
1733 
1734     int		b_flags;	/* various BF_ flags */
1735 #ifdef FEAT_AUTOCMD
1736     int		b_closing;	/* buffer is being closed, don't let
1737 				   autocommands close it too. */
1738 #endif
1739 
1740     /*
1741      * b_ffname has the full path of the file (NULL for no name).
1742      * b_sfname is the name as the user typed it (or NULL).
1743      * b_fname is the same as b_sfname, unless ":cd" has been done,
1744      *		then it is the same as b_ffname (NULL for no name).
1745      */
1746     char_u	*b_ffname;	/* full path file name */
1747     char_u	*b_sfname;	/* short file name */
1748     char_u	*b_fname;	/* current file name */
1749 
1750 #ifdef UNIX
1751     int		b_dev_valid;	/* TRUE when b_dev has a valid number */
1752     dev_t	b_dev;		/* device number */
1753     ino_t	b_ino;		/* inode number */
1754 #endif
1755 #ifdef FEAT_CW_EDITOR
1756     FSSpec	b_FSSpec;	/* MacOS File Identification */
1757 #endif
1758 #ifdef VMS
1759     char	 b_fab_rfm;	/* Record format    */
1760     char	 b_fab_rat;	/* Record attribute */
1761     unsigned int b_fab_mrs;	/* Max record size  */
1762 #endif
1763     int		b_fnum;		/* buffer number for this file. */
1764     char_u	b_key[VIM_SIZEOF_INT * 2 + 1];
1765 				/* key used for buf_hashtab, holds b_fnum as
1766 				   hex string */
1767 
1768     int		b_changed;	/* 'modified': Set to TRUE if something in the
1769 				   file has been changed and not written out. */
1770     int		b_changedtick;	/* incremented for each change, also for undo */
1771 
1772     int		b_saving;	/* Set to TRUE if we are in the middle of
1773 				   saving the buffer. */
1774 
1775     /*
1776      * Changes to a buffer require updating of the display.  To minimize the
1777      * work, remember changes made and update everything at once.
1778      */
1779     int		b_mod_set;	/* TRUE when there are changes since the last
1780 				   time the display was updated */
1781     linenr_T	b_mod_top;	/* topmost lnum that was changed */
1782     linenr_T	b_mod_bot;	/* lnum below last changed line, AFTER the
1783 				   change */
1784     long	b_mod_xlines;	/* number of extra buffer lines inserted;
1785 				   negative when lines were deleted */
1786 
1787     wininfo_T	*b_wininfo;	/* list of last used info for each window */
1788 
1789     long	b_mtime;	/* last change time of original file */
1790     long	b_mtime_read;	/* last change time when reading */
1791     off_T	b_orig_size;	/* size of original file in bytes */
1792     int		b_orig_mode;	/* mode of original file */
1793 #ifdef FEAT_VIMINFO
1794     time_T	b_last_used;	/* time when the buffer was last used; used
1795 				 * for viminfo */
1796 #endif
1797 
1798     pos_T	b_namedm[NMARKS]; /* current named marks (mark.c) */
1799 
1800     /* These variables are set when VIsual_active becomes FALSE */
1801     visualinfo_T b_visual;
1802 #ifdef FEAT_EVAL
1803     int		b_visual_mode_eval;  /* b_visual.vi_mode for visualmode() */
1804 #endif
1805 
1806     pos_T	b_last_cursor;	/* cursor position when last unloading this
1807 				   buffer */
1808     pos_T	b_last_insert;	/* where Insert mode was left */
1809     pos_T	b_last_change;	/* position of last change: '. mark */
1810 
1811 #ifdef FEAT_JUMPLIST
1812     /*
1813      * the changelist contains old change positions
1814      */
1815     pos_T	b_changelist[JUMPLISTSIZE];
1816     int		b_changelistlen;	/* number of active entries */
1817     int		b_new_change;		/* set by u_savecommon() */
1818 #endif
1819 
1820     /*
1821      * Character table, only used in charset.c for 'iskeyword'
1822      * 32 bytes of 8 bits: 1 bit per character 0-255.
1823      */
1824     char_u	b_chartab[32];
1825 
1826 #ifdef FEAT_LOCALMAP
1827     /* Table used for mappings local to a buffer. */
1828     mapblock_T	*(b_maphash[256]);
1829 
1830     /* First abbreviation local to a buffer. */
1831     mapblock_T	*b_first_abbr;
1832 #endif
1833 #ifdef FEAT_USR_CMDS
1834     /* User commands local to the buffer. */
1835     garray_T	b_ucmds;
1836 #endif
1837     /*
1838      * start and end of an operator, also used for '[ and ']
1839      */
1840     pos_T	b_op_start;
1841     pos_T	b_op_start_orig;  /* used for Insstart_orig */
1842     pos_T	b_op_end;
1843 
1844 #ifdef FEAT_VIMINFO
1845     int		b_marks_read;	/* Have we read viminfo marks yet? */
1846 #endif
1847 
1848     /*
1849      * The following only used in undo.c.
1850      */
1851     u_header_T	*b_u_oldhead;	/* pointer to oldest header */
1852     u_header_T	*b_u_newhead;	/* pointer to newest header; may not be valid
1853 				   if b_u_curhead is not NULL */
1854     u_header_T	*b_u_curhead;	/* pointer to current header */
1855     int		b_u_numhead;	/* current number of headers */
1856     int		b_u_synced;	/* entry lists are synced */
1857     long	b_u_seq_last;	/* last used undo sequence number */
1858     long	b_u_save_nr_last; /* counter for last file write */
1859     long	b_u_seq_cur;	/* hu_seq of header below which we are now */
1860     time_T	b_u_time_cur;	/* uh_time of header below which we are now */
1861     long	b_u_save_nr_cur; /* file write nr after which we are now */
1862 
1863     /*
1864      * variables for "U" command in undo.c
1865      */
1866     char_u	*b_u_line_ptr;	/* saved line for "U" command */
1867     linenr_T	b_u_line_lnum;	/* line number of line in u_line */
1868     colnr_T	b_u_line_colnr;	/* optional column number */
1869 
1870 #ifdef FEAT_INS_EXPAND
1871     int		b_scanned;	/* ^N/^P have scanned this buffer */
1872 #endif
1873 
1874     /* flags for use of ":lmap" and IM control */
1875     long	b_p_iminsert;	/* input mode for insert */
1876     long	b_p_imsearch;	/* input mode for search */
1877 #define B_IMODE_USE_INSERT -1	/*	Use b_p_iminsert value for search */
1878 #define B_IMODE_NONE 0		/*	Input via none */
1879 #define B_IMODE_LMAP 1		/*	Input via langmap */
1880 #ifndef USE_IM_CONTROL
1881 # define B_IMODE_LAST 1
1882 #else
1883 # define B_IMODE_IM 2		/*	Input via input method */
1884 # define B_IMODE_LAST 2
1885 #endif
1886 
1887 #ifdef FEAT_KEYMAP
1888     short	b_kmap_state;	/* using "lmap" mappings */
1889 # define KEYMAP_INIT	1	/* 'keymap' was set, call keymap_init() */
1890 # define KEYMAP_LOADED	2	/* 'keymap' mappings have been loaded */
1891     garray_T	b_kmap_ga;	/* the keymap table */
1892 #endif
1893 
1894     /*
1895      * Options local to a buffer.
1896      * They are here because their value depends on the type of file
1897      * or contents of the file being edited.
1898      */
1899     int		b_p_initialized;	/* set when options initialized */
1900 
1901 #ifdef FEAT_EVAL
1902     int		b_p_scriptID[BV_COUNT];	/* SIDs for buffer-local options */
1903 #endif
1904 
1905     int		b_p_ai;		/* 'autoindent' */
1906     int		b_p_ai_nopaste;	/* b_p_ai saved for paste mode */
1907     char_u	*b_p_bkc;	/* 'backupcopy' */
1908     unsigned	b_bkc_flags;    /* flags for 'backupcopy' */
1909     int		b_p_ci;		/* 'copyindent' */
1910     int		b_p_bin;	/* 'binary' */
1911 #ifdef FEAT_MBYTE
1912     int		b_p_bomb;	/* 'bomb' */
1913 #endif
1914 #ifdef FEAT_QUICKFIX
1915     char_u	*b_p_bh;	/* 'bufhidden' */
1916     char_u	*b_p_bt;	/* 'buftype' */
1917 #define BUF_HAS_QF_ENTRY 1
1918 #define BUF_HAS_LL_ENTRY 2
1919     int		b_has_qf_entry;
1920 #endif
1921     int		b_p_bl;		/* 'buflisted' */
1922 #ifdef FEAT_CINDENT
1923     int		b_p_cin;	/* 'cindent' */
1924     char_u	*b_p_cino;	/* 'cinoptions' */
1925     char_u	*b_p_cink;	/* 'cinkeys' */
1926 #endif
1927 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
1928     char_u	*b_p_cinw;	/* 'cinwords' */
1929 #endif
1930 #ifdef FEAT_COMMENTS
1931     char_u	*b_p_com;	/* 'comments' */
1932 #endif
1933 #ifdef FEAT_FOLDING
1934     char_u	*b_p_cms;	/* 'commentstring' */
1935 #endif
1936 #ifdef FEAT_INS_EXPAND
1937     char_u	*b_p_cpt;	/* 'complete' */
1938 #endif
1939 #ifdef FEAT_COMPL_FUNC
1940     char_u	*b_p_cfu;	/* 'completefunc' */
1941     char_u	*b_p_ofu;	/* 'omnifunc' */
1942 #endif
1943     int		b_p_eol;	/* 'endofline' */
1944     int		b_p_fixeol;	/* 'fixendofline' */
1945     int		b_p_et;		/* 'expandtab' */
1946     int		b_p_et_nobin;	/* b_p_et saved for binary mode */
1947     int	        b_p_et_nopaste; /* b_p_et saved for paste mode */
1948 #ifdef FEAT_MBYTE
1949     char_u	*b_p_fenc;	/* 'fileencoding' */
1950 #endif
1951     char_u	*b_p_ff;	/* 'fileformat' */
1952 #ifdef FEAT_AUTOCMD
1953     char_u	*b_p_ft;	/* 'filetype' */
1954 #endif
1955     char_u	*b_p_fo;	/* 'formatoptions' */
1956     char_u	*b_p_flp;	/* 'formatlistpat' */
1957     int		b_p_inf;	/* 'infercase' */
1958     char_u	*b_p_isk;	/* 'iskeyword' */
1959 #ifdef FEAT_FIND_ID
1960     char_u	*b_p_def;	/* 'define' local value */
1961     char_u	*b_p_inc;	/* 'include' */
1962 # ifdef FEAT_EVAL
1963     char_u	*b_p_inex;	/* 'includeexpr' */
1964     long_u	b_p_inex_flags;	/* flags for 'includeexpr' */
1965 # endif
1966 #endif
1967 #if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
1968     char_u	*b_p_inde;	/* 'indentexpr' */
1969     long_u	b_p_inde_flags;	/* flags for 'indentexpr' */
1970     char_u	*b_p_indk;	/* 'indentkeys' */
1971 #endif
1972 #if defined(FEAT_EVAL)
1973     char_u	*b_p_fex;	/* 'formatexpr' */
1974     long_u	b_p_fex_flags;	/* flags for 'formatexpr' */
1975 #endif
1976 #ifdef FEAT_CRYPT
1977     char_u	*b_p_key;	/* 'key' */
1978 #endif
1979     char_u	*b_p_kp;	/* 'keywordprg' */
1980 #ifdef FEAT_LISP
1981     int		b_p_lisp;	/* 'lisp' */
1982 #endif
1983     char_u	*b_p_mps;	/* 'matchpairs' */
1984     int		b_p_ml;		/* 'modeline' */
1985     int		b_p_ml_nobin;	/* b_p_ml saved for binary mode */
1986     int		b_p_ma;		/* 'modifiable' */
1987     char_u	*b_p_nf;	/* 'nrformats' */
1988     int		b_p_pi;		/* 'preserveindent' */
1989 #ifdef FEAT_TEXTOBJ
1990     char_u	*b_p_qe;	/* 'quoteescape' */
1991 #endif
1992     int		b_p_ro;		/* 'readonly' */
1993     long	b_p_sw;		/* 'shiftwidth' */
1994     int		b_p_sn;		/* 'shortname' */
1995 #ifdef FEAT_SMARTINDENT
1996     int		b_p_si;		/* 'smartindent' */
1997 #endif
1998     long	b_p_sts;	/* 'softtabstop' */
1999     long	b_p_sts_nopaste; /* b_p_sts saved for paste mode */
2000 #ifdef FEAT_SEARCHPATH
2001     char_u	*b_p_sua;	/* 'suffixesadd' */
2002 #endif
2003     int		b_p_swf;	/* 'swapfile' */
2004 #ifdef FEAT_SYN_HL
2005     long	b_p_smc;	/* 'synmaxcol' */
2006     char_u	*b_p_syn;	/* 'syntax' */
2007 #endif
2008     long	b_p_ts;		/* 'tabstop' */
2009     int		b_p_tx;		/* 'textmode' */
2010     long	b_p_tw;		/* 'textwidth' */
2011     long	b_p_tw_nobin;	/* b_p_tw saved for binary mode */
2012     long	b_p_tw_nopaste;	/* b_p_tw saved for paste mode */
2013     long	b_p_wm;		/* 'wrapmargin' */
2014     long	b_p_wm_nobin;	/* b_p_wm saved for binary mode */
2015     long	b_p_wm_nopaste;	/* b_p_wm saved for paste mode */
2016 #ifdef FEAT_KEYMAP
2017     char_u	*b_p_keymap;	/* 'keymap' */
2018 #endif
2019 
2020     /* local values for options which are normally global */
2021 #ifdef FEAT_QUICKFIX
2022     char_u	*b_p_gp;	/* 'grepprg' local value */
2023     char_u	*b_p_mp;	/* 'makeprg' local value */
2024     char_u	*b_p_efm;	/* 'errorformat' local value */
2025 #endif
2026     char_u	*b_p_ep;	/* 'equalprg' local value */
2027     char_u	*b_p_path;	/* 'path' local value */
2028     int		b_p_ar;		/* 'autoread' local value */
2029     char_u	*b_p_tags;	/* 'tags' local value */
2030     char_u	*b_p_tc;	/* 'tagcase' local value */
2031     unsigned	b_tc_flags;     /* flags for 'tagcase' */
2032 #ifdef FEAT_INS_EXPAND
2033     char_u	*b_p_dict;	/* 'dictionary' local value */
2034     char_u	*b_p_tsr;	/* 'thesaurus' local value */
2035 #endif
2036     long	b_p_ul;		/* 'undolevels' local value */
2037 #ifdef FEAT_PERSISTENT_UNDO
2038     int		b_p_udf;	/* 'undofile' */
2039 #endif
2040 #ifdef FEAT_LISP
2041     char_u	*b_p_lw;	/* 'lispwords' local value */
2042 #endif
2043 
2044     /* end of buffer options */
2045 
2046 #ifdef FEAT_CINDENT
2047     /* values set from b_p_cino */
2048     int		b_ind_level;
2049     int		b_ind_open_imag;
2050     int		b_ind_no_brace;
2051     int		b_ind_first_open;
2052     int		b_ind_open_extra;
2053     int		b_ind_close_extra;
2054     int		b_ind_open_left_imag;
2055     int		b_ind_jump_label;
2056     int		b_ind_case;
2057     int		b_ind_case_code;
2058     int		b_ind_case_break;
2059     int		b_ind_param;
2060     int		b_ind_func_type;
2061     int		b_ind_comment;
2062     int		b_ind_in_comment;
2063     int		b_ind_in_comment2;
2064     int		b_ind_cpp_baseclass;
2065     int		b_ind_continuation;
2066     int		b_ind_unclosed;
2067     int		b_ind_unclosed2;
2068     int		b_ind_unclosed_noignore;
2069     int		b_ind_unclosed_wrapped;
2070     int		b_ind_unclosed_whiteok;
2071     int		b_ind_matching_paren;
2072     int		b_ind_paren_prev;
2073     int		b_ind_maxparen;
2074     int		b_ind_maxcomment;
2075     int		b_ind_scopedecl;
2076     int		b_ind_scopedecl_code;
2077     int		b_ind_java;
2078     int		b_ind_js;
2079     int		b_ind_keep_case_label;
2080     int		b_ind_hash_comment;
2081     int		b_ind_cpp_namespace;
2082     int		b_ind_if_for_while;
2083 #endif
2084 
2085     linenr_T	b_no_eol_lnum;	/* non-zero lnum when last line of next binary
2086 				 * write should not have an end-of-line */
2087 
2088     int		b_start_eol;	/* last line had eol when it was read */
2089     int		b_start_ffc;	/* first char of 'ff' when edit started */
2090 #ifdef FEAT_MBYTE
2091     char_u	*b_start_fenc;	/* 'fileencoding' when edit started or NULL */
2092     int		b_bad_char;	/* "++bad=" argument when edit started or 0 */
2093     int		b_start_bomb;	/* 'bomb' when it was read */
2094 #endif
2095 
2096 #ifdef FEAT_EVAL
2097     dictitem_T	b_bufvar;	/* variable for "b:" Dictionary */
2098     dict_T	*b_vars;	/* internal variables, local to buffer */
2099 #endif
2100 
2101 #if defined(FEAT_BEVAL) && defined(FEAT_EVAL)
2102     char_u	*b_p_bexpr;	/* 'balloonexpr' local value */
2103     long_u	b_p_bexpr_flags;/* flags for 'balloonexpr' */
2104 #endif
2105 #ifdef FEAT_CRYPT
2106     char_u	*b_p_cm;	/* 'cryptmethod' */
2107 #endif
2108 
2109     /* When a buffer is created, it starts without a swap file.  b_may_swap is
2110      * then set to indicate that a swap file may be opened later.  It is reset
2111      * if a swap file could not be opened.
2112      */
2113     int		b_may_swap;
2114     int		b_did_warn;	/* Set to 1 if user has been warned on first
2115 				   change of a read-only file */
2116 
2117     /* Two special kinds of buffers:
2118      * help buffer  - used for help files, won't use a swap file.
2119      * spell buffer - used for spell info, never displayed and doesn't have a
2120      *		      file name.
2121      */
2122     int		b_help;		/* TRUE for help file buffer (when set b_p_bt
2123 				   is "help") */
2124 #ifdef FEAT_SPELL
2125     int		b_spell;	/* TRUE for a spell file buffer, most fields
2126 				   are not used!  Use the B_SPELL macro to
2127 				   access b_spell without #ifdef. */
2128 #endif
2129 
2130     int		b_shortname;	/* this file has an 8.3 file name */
2131 
2132 #ifdef FEAT_MZSCHEME
2133     void	*b_mzscheme_ref; /* The MzScheme reference to this buffer */
2134 #endif
2135 
2136 #ifdef FEAT_PERL
2137     void	*b_perl_private;
2138 #endif
2139 
2140 #ifdef FEAT_PYTHON
2141     void	*b_python_ref;	/* The Python reference to this buffer */
2142 #endif
2143 
2144 #ifdef FEAT_PYTHON3
2145     void	*b_python3_ref;	/* The Python3 reference to this buffer */
2146 #endif
2147 
2148 #ifdef FEAT_TCL
2149     void	*b_tcl_ref;
2150 #endif
2151 
2152 #ifdef FEAT_RUBY
2153     void	*b_ruby_ref;
2154 #endif
2155 
2156 #if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
2157     synblock_T	b_s;		/* Info related to syntax highlighting.  w_s
2158 				 * normally points to this, but some windows
2159 				 * may use a different synblock_T. */
2160 #endif
2161 
2162 #ifdef FEAT_SIGNS
2163     signlist_T	*b_signlist;	/* list of signs to draw */
2164 # ifdef FEAT_NETBEANS_INTG
2165     int		b_has_sign_column; /* Flag that is set when a first sign is
2166 				    * added and remains set until the end of
2167 				    * the netbeans session. */
2168 # endif
2169 #endif
2170 
2171 #ifdef FEAT_NETBEANS_INTG
2172     int		b_netbeans_file;    /* TRUE when buffer is owned by NetBeans */
2173     int		b_was_netbeans_file;/* TRUE if b_netbeans_file was once set */
2174 #endif
2175 #ifdef FEAT_JOB_CHANNEL
2176     int		b_write_to_channel; /* TRUE when appended lines are written to
2177 				     * a channel. */
2178 #endif
2179 
2180 #ifdef FEAT_CRYPT
2181     cryptstate_T *b_cryptstate;	/* Encryption state while reading or writing
2182 				 * the file. NULL when not using encryption. */
2183 #endif
2184     int		b_mapped_ctrl_c; /* modes where CTRL-C is mapped */
2185 
2186 }; /* file_buffer */
2187 
2188 
2189 #ifdef FEAT_DIFF
2190 /*
2191  * Stuff for diff mode.
2192  */
2193 # define DB_COUNT 4	/* up to four buffers can be diff'ed */
2194 
2195 /*
2196  * Each diffblock defines where a block of lines starts in each of the buffers
2197  * and how many lines it occupies in that buffer.  When the lines are missing
2198  * in the buffer the df_count[] is zero.  This is all counted in
2199  * buffer lines.
2200  * There is always at least one unchanged line in between the diffs.
2201  * Otherwise it would have been included in the diff above or below it.
2202  * df_lnum[] + df_count[] is the lnum below the change.  When in one buffer
2203  * lines have been inserted, in the other buffer df_lnum[] is the line below
2204  * the insertion and df_count[] is zero.  When appending lines at the end of
2205  * the buffer, df_lnum[] is one beyond the end!
2206  * This is using a linked list, because the number of differences is expected
2207  * to be reasonable small.  The list is sorted on lnum.
2208  */
2209 typedef struct diffblock_S diff_T;
2210 struct diffblock_S
2211 {
2212     diff_T	*df_next;
2213     linenr_T	df_lnum[DB_COUNT];	/* line number in buffer */
2214     linenr_T	df_count[DB_COUNT];	/* nr of inserted/changed lines */
2215 };
2216 #endif
2217 
2218 #define SNAP_HELP_IDX	0
2219 #ifdef FEAT_AUTOCMD
2220 # define SNAP_AUCMD_IDX 1
2221 # define SNAP_COUNT	2
2222 #else
2223 # define SNAP_COUNT	1
2224 #endif
2225 
2226 /*
2227  * Tab pages point to the top frame of each tab page.
2228  * Note: Most values are NOT valid for the current tab page!  Use "curwin",
2229  * "firstwin", etc. for that.  "tp_topframe" is always valid and can be
2230  * compared against "topframe" to find the current tab page.
2231  */
2232 typedef struct tabpage_S tabpage_T;
2233 struct tabpage_S
2234 {
2235     tabpage_T	    *tp_next;	    /* next tabpage or NULL */
2236     frame_T	    *tp_topframe;   /* topframe for the windows */
2237     win_T	    *tp_curwin;	    /* current window in this Tab page */
2238     win_T	    *tp_prevwin;    /* previous window in this Tab page */
2239     win_T	    *tp_firstwin;   /* first window in this Tab page */
2240     win_T	    *tp_lastwin;    /* last window in this Tab page */
2241     long	    tp_old_Rows;    /* Rows when Tab page was left */
2242     long	    tp_old_Columns; /* Columns when Tab page was left */
2243     long	    tp_ch_used;	    /* value of 'cmdheight' when frame size
2244 				       was set */
2245 #ifdef FEAT_GUI
2246     int		    tp_prev_which_scrollbars[3];
2247 				    /* previous value of which_scrollbars */
2248 #endif
2249 #ifdef FEAT_DIFF
2250     diff_T	    *tp_first_diff;
2251     buf_T	    *(tp_diffbuf[DB_COUNT]);
2252     int		    tp_diff_invalid;	/* list of diffs is outdated */
2253 #endif
2254     frame_T	    *(tp_snapshot[SNAP_COUNT]);  /* window layout snapshots */
2255 #ifdef FEAT_EVAL
2256     dictitem_T	    tp_winvar;	    /* variable for "t:" Dictionary */
2257     dict_T	    *tp_vars;	    /* internal variables, local to tab page */
2258 #endif
2259 
2260 #ifdef FEAT_PYTHON
2261     void	    *tp_python_ref;	/* The Python value for this tab page */
2262 #endif
2263 
2264 #ifdef FEAT_PYTHON3
2265     void	    *tp_python3_ref;	/* The Python value for this tab page */
2266 #endif
2267 };
2268 
2269 /*
2270  * Structure to cache info for displayed lines in w_lines[].
2271  * Each logical line has one entry.
2272  * The entry tells how the logical line is currently displayed in the window.
2273  * This is updated when displaying the window.
2274  * When the display is changed (e.g., when clearing the screen) w_lines_valid
2275  * is changed to exclude invalid entries.
2276  * When making changes to the buffer, wl_valid is reset to indicate wl_size
2277  * may not reflect what is actually in the buffer.  When wl_valid is FALSE,
2278  * the entries can only be used to count the number of displayed lines used.
2279  * wl_lnum and wl_lastlnum are invalid too.
2280  */
2281 typedef struct w_line
2282 {
2283     linenr_T	wl_lnum;	/* buffer line number for logical line */
2284     short_u	wl_size;	/* height in screen lines */
2285     char	wl_valid;	/* TRUE values are valid for text in buffer */
2286 #ifdef FEAT_FOLDING
2287     char	wl_folded;	/* TRUE when this is a range of folded lines */
2288     linenr_T	wl_lastlnum;	/* last buffer line number for logical line */
2289 #endif
2290 } wline_T;
2291 
2292 /*
2293  * Windows are kept in a tree of frames.  Each frame has a column (FR_COL)
2294  * or row (FR_ROW) layout or is a leaf, which has a window.
2295  */
2296 struct frame_S
2297 {
2298     char	fr_layout;	/* FR_LEAF, FR_COL or FR_ROW */
2299 #ifdef FEAT_WINDOWS
2300     int		fr_width;
2301     int		fr_newwidth;	/* new width used in win_equal_rec() */
2302 #endif
2303     int		fr_height;
2304     int		fr_newheight;	/* new height used in win_equal_rec() */
2305     frame_T	*fr_parent;	/* containing frame or NULL */
2306     frame_T	*fr_next;	/* frame right or below in same parent, NULL
2307 				   for first */
2308     frame_T	*fr_prev;	/* frame left or above in same parent, NULL
2309 				   for last */
2310     /* fr_child and fr_win are mutually exclusive */
2311     frame_T	*fr_child;	/* first contained frame */
2312     win_T	*fr_win;	/* window that fills this frame */
2313 };
2314 
2315 #define FR_LEAF	0	/* frame is a leaf */
2316 #define FR_ROW	1	/* frame with a row of windows */
2317 #define FR_COL	2	/* frame with a column of windows */
2318 
2319 /*
2320  * Struct used for highlighting 'hlsearch' matches, matches defined by
2321  * ":match" and matches defined by match functions.
2322  * For 'hlsearch' there is one pattern for all windows.  For ":match" and the
2323  * match functions there is a different pattern for each window.
2324  */
2325 typedef struct
2326 {
2327     regmmatch_T	rm;	/* points to the regexp program; contains last found
2328 			   match (may continue in next line) */
2329     buf_T	*buf;	/* the buffer to search for a match */
2330     linenr_T	lnum;	/* the line to search for a match */
2331     int		attr;	/* attributes to be used for a match */
2332     int		attr_cur; /* attributes currently active in win_line() */
2333     linenr_T	first_lnum;	/* first lnum to search for multi-line pat */
2334     colnr_T	startcol; /* in win_line() points to char where HL starts */
2335     colnr_T	endcol;	 /* in win_line() points to char where HL ends */
2336 #ifdef FEAT_RELTIME
2337     proftime_T	tm;	/* for a time limit */
2338 #endif
2339 } match_T;
2340 
2341 /* number of positions supported by matchaddpos() */
2342 #define MAXPOSMATCH 8
2343 
2344 /*
2345  * Same as lpos_T, but with additional field len.
2346  */
2347 typedef struct
2348 {
2349     linenr_T	lnum;	/* line number */
2350     colnr_T	col;	/* column number */
2351     int		len;	/* length: 0 - to the end of line */
2352 } llpos_T;
2353 
2354 /*
2355  * posmatch_T provides an array for storing match items for matchaddpos()
2356  * function.
2357  */
2358 typedef struct posmatch posmatch_T;
2359 struct posmatch
2360 {
2361     llpos_T	pos[MAXPOSMATCH];	/* array of positions */
2362     int		cur;			/* internal position counter */
2363     linenr_T	toplnum;		/* top buffer line */
2364     linenr_T	botlnum;		/* bottom buffer line */
2365 };
2366 
2367 /*
2368  * matchitem_T provides a linked list for storing match items for ":match" and
2369  * the match functions.
2370  */
2371 typedef struct matchitem matchitem_T;
2372 struct matchitem
2373 {
2374     matchitem_T	*next;
2375     int		id;	    /* match ID */
2376     int		priority;   /* match priority */
2377     char_u	*pattern;   /* pattern to highlight */
2378     int		hlg_id;	    /* highlight group ID */
2379     regmmatch_T	match;	    /* regexp program for pattern */
2380     posmatch_T	pos;	    /* position matches */
2381     match_T	hl;	    /* struct for doing the actual highlighting */
2382 #ifdef FEAT_CONCEAL
2383     int		conceal_char; /* cchar for Conceal highlighting */
2384 #endif
2385 };
2386 
2387 /*
2388  * Structure which contains all information that belongs to a window
2389  *
2390  * All row numbers are relative to the start of the window, except w_winrow.
2391  */
2392 struct window_S
2393 {
2394     int		w_id;		    /* unique window ID */
2395 
2396     buf_T	*w_buffer;	    /* buffer we are a window into (used
2397 				       often, keep it the first item!) */
2398 
2399 #if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
2400     synblock_T	*w_s;		    /* for :ownsyntax */
2401 #endif
2402 
2403 #ifdef FEAT_WINDOWS
2404     win_T	*w_prev;	    /* link to previous window */
2405     win_T	*w_next;	    /* link to next window */
2406 #endif
2407 #ifdef FEAT_AUTOCMD
2408     int		w_closing;	    /* window is being closed, don't let
2409 				       autocommands close it too. */
2410 #endif
2411 
2412     frame_T	*w_frame;	    /* frame containing this window */
2413 
2414     pos_T	w_cursor;	    /* cursor position in buffer */
2415 
2416     colnr_T	w_curswant;	    /* The column we'd like to be at.  This is
2417 				       used to try to stay in the same column
2418 				       for up/down cursor motions. */
2419 
2420     int		w_set_curswant;	    /* If set, then update w_curswant the next
2421 				       time through cursupdate() to the
2422 				       current virtual column */
2423 
2424     /*
2425      * the next seven are used to update the visual part
2426      */
2427     char	w_old_visual_mode;  /* last known VIsual_mode */
2428     linenr_T	w_old_cursor_lnum;  /* last known end of visual part */
2429     colnr_T	w_old_cursor_fcol;  /* first column for block visual part */
2430     colnr_T	w_old_cursor_lcol;  /* last column for block visual part */
2431     linenr_T	w_old_visual_lnum;  /* last known start of visual part */
2432     colnr_T	w_old_visual_col;   /* last known start of visual part */
2433     colnr_T	w_old_curswant;	    /* last known value of Curswant */
2434 
2435     /*
2436      * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for
2437      * displaying the buffer.
2438      */
2439     linenr_T	w_topline;	    /* buffer line number of the line at the
2440 				       top of the window */
2441 #ifdef FEAT_AUTOCMD
2442     char	w_topline_was_set;  /* flag set to TRUE when topline is set,
2443 				       e.g. by winrestview() */
2444 #endif
2445 #ifdef FEAT_DIFF
2446     int		w_topfill;	    /* number of filler lines above w_topline */
2447     int		w_old_topfill;	    /* w_topfill at last redraw */
2448     int		w_botfill;	    /* TRUE when filler lines are actually
2449 				       below w_topline (at end of file) */
2450     int		w_old_botfill;	    /* w_botfill at last redraw */
2451 #endif
2452     colnr_T	w_leftcol;	    /* window column number of the left most
2453 				       character in the window; used when
2454 				       'wrap' is off */
2455     colnr_T	w_skipcol;	    /* starting column when a single line
2456 				       doesn't fit in the window */
2457 
2458     /*
2459      * Layout of the window in the screen.
2460      * May need to add "msg_scrolled" to "w_winrow" in rare situations.
2461      */
2462 #ifdef FEAT_WINDOWS
2463     int		w_winrow;	    /* first row of window in screen */
2464 #endif
2465     int		w_height;	    /* number of rows in window, excluding
2466 				       status/command line(s) */
2467 #ifdef FEAT_WINDOWS
2468     int		w_status_height;    /* number of status lines (0 or 1) */
2469     int		w_wincol;	    /* Leftmost column of window in screen.
2470 				       use W_WINCOL() */
2471     int		w_width;	    /* Width of window, excluding separation.
2472 				       use W_WIDTH() */
2473     int		w_vsep_width;	    /* Number of separator columns (0 or 1).
2474 				       use W_VSEP_WIDTH() */
2475 #endif
2476 
2477     /*
2478      * === start of cached values ====
2479      */
2480     /*
2481      * Recomputing is minimized by storing the result of computations.
2482      * Use functions in screen.c to check if they are valid and to update.
2483      * w_valid is a bitfield of flags, which indicate if specific values are
2484      * valid or need to be recomputed.	See screen.c for values.
2485      */
2486     int		w_valid;
2487     pos_T	w_valid_cursor;	    /* last known position of w_cursor, used
2488 				       to adjust w_valid */
2489     colnr_T	w_valid_leftcol;    /* last known w_leftcol */
2490 
2491     /*
2492      * w_cline_height is the number of physical lines taken by the buffer line
2493      * that the cursor is on.  We use this to avoid extra calls to plines().
2494      */
2495     int		w_cline_height;	    /* current size of cursor line */
2496 #ifdef FEAT_FOLDING
2497     int		w_cline_folded;	    /* cursor line is folded */
2498 #endif
2499 
2500     int		w_cline_row;	    /* starting row of the cursor line */
2501 
2502     colnr_T	w_virtcol;	    /* column number of the cursor in the
2503 				       buffer line, as opposed to the column
2504 				       number we're at on the screen.  This
2505 				       makes a difference on lines which span
2506 				       more than one screen line or when
2507 				       w_leftcol is non-zero */
2508 
2509     /*
2510      * w_wrow and w_wcol specify the cursor position in the window.
2511      * This is related to positions in the window, not in the display or
2512      * buffer, thus w_wrow is relative to w_winrow.
2513      */
2514     int		w_wrow, w_wcol;	    /* cursor position in window */
2515 
2516     linenr_T	w_botline;	    /* number of the line below the bottom of
2517 				       the window */
2518     int		w_empty_rows;	    /* number of ~ rows in window */
2519 #ifdef FEAT_DIFF
2520     int		w_filler_rows;	    /* number of filler rows at the end of the
2521 				       window */
2522 #endif
2523 
2524     /*
2525      * Info about the lines currently in the window is remembered to avoid
2526      * recomputing it every time.  The allocated size of w_lines[] is Rows.
2527      * Only the w_lines_valid entries are actually valid.
2528      * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
2529      * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
2530      * Between changing text and updating the display w_lines[] represents
2531      * what is currently displayed.  wl_valid is reset to indicated this.
2532      * This is used for efficient redrawing.
2533      */
2534     int		w_lines_valid;	    /* number of valid entries */
2535     wline_T	*w_lines;
2536 
2537 #ifdef FEAT_FOLDING
2538     garray_T	w_folds;	    /* array of nested folds */
2539     char	w_fold_manual;	    /* when TRUE: some folds are opened/closed
2540 				       manually */
2541     char	w_foldinvalid;	    /* when TRUE: folding needs to be
2542 				       recomputed */
2543 #endif
2544 #ifdef FEAT_LINEBREAK
2545     int		w_nrwidth;	    /* width of 'number' and 'relativenumber'
2546 				       column being used */
2547 #endif
2548 
2549     /*
2550      * === end of cached values ===
2551      */
2552 
2553     int		w_redr_type;	    /* type of redraw to be performed on win */
2554     int		w_upd_rows;	    /* number of window lines to update when
2555 				       w_redr_type is REDRAW_TOP */
2556     linenr_T	w_redraw_top;	    /* when != 0: first line needing redraw */
2557     linenr_T	w_redraw_bot;	    /* when != 0: last line needing redraw */
2558 #ifdef FEAT_WINDOWS
2559     int		w_redr_status;	    /* if TRUE status line must be redrawn */
2560 #endif
2561 
2562 #ifdef FEAT_CMDL_INFO
2563     /* remember what is shown in the ruler for this window (if 'ruler' set) */
2564     pos_T	w_ru_cursor;	    /* cursor position shown in ruler */
2565     colnr_T	w_ru_virtcol;	    /* virtcol shown in ruler */
2566     linenr_T	w_ru_topline;	    /* topline shown in ruler */
2567     linenr_T	w_ru_line_count;    /* line count used for ruler */
2568 # ifdef FEAT_DIFF
2569     int		w_ru_topfill;	    /* topfill shown in ruler */
2570 # endif
2571     char	w_ru_empty;	    /* TRUE if ruler shows 0-1 (empty line) */
2572 #endif
2573 
2574     int		w_alt_fnum;	    /* alternate file (for # and CTRL-^) */
2575 
2576 #ifdef FEAT_WINDOWS
2577     alist_T	*w_alist;	    /* pointer to arglist for this window */
2578 #endif
2579     int		w_arg_idx;	    /* current index in argument list (can be
2580 				       out of range!) */
2581     int		w_arg_idx_invalid;  /* editing another file than w_arg_idx */
2582 
2583     char_u	*w_localdir;	    /* absolute path of local directory or
2584 				       NULL */
2585     /*
2586      * Options local to a window.
2587      * They are local because they influence the layout of the window or
2588      * depend on the window layout.
2589      * There are two values: w_onebuf_opt is local to the buffer currently in
2590      * this window, w_allbuf_opt is for all buffers in this window.
2591      */
2592     winopt_T	w_onebuf_opt;
2593     winopt_T	w_allbuf_opt;
2594 
2595     /* A few options have local flags for P_INSECURE. */
2596 #ifdef FEAT_STL_OPT
2597     long_u	w_p_stl_flags;	    /* flags for 'statusline' */
2598 #endif
2599 #ifdef FEAT_EVAL
2600     long_u	w_p_fde_flags;	    /* flags for 'foldexpr' */
2601     long_u	w_p_fdt_flags;	    /* flags for 'foldtext' */
2602 #endif
2603 #ifdef FEAT_SYN_HL
2604     int		*w_p_cc_cols;	    /* array of columns to highlight or NULL */
2605 #endif
2606 #ifdef FEAT_LINEBREAK
2607     int		w_p_brimin;	    /* minimum width for breakindent */
2608     int		w_p_brishift;	    /* additional shift for breakindent */
2609     int		w_p_brisbr;	    /* sbr in 'briopt' */
2610 #endif
2611 
2612     /* transform a pointer to a "onebuf" option into a "allbuf" option */
2613 #define GLOBAL_WO(p)	((char *)p + sizeof(winopt_T))
2614 
2615 #ifdef FEAT_SCROLLBIND
2616     long	w_scbind_pos;
2617 #endif
2618 
2619 #ifdef FEAT_EVAL
2620     dictitem_T	w_winvar;	/* variable for "w:" Dictionary */
2621     dict_T	*w_vars;	/* internal variables, local to window */
2622 #endif
2623 
2624 #if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
2625     int		w_farsi;	/* for the window dependent Farsi functions */
2626 #endif
2627 
2628     /*
2629      * The w_prev_pcmark field is used to check whether we really did jump to
2630      * a new line after setting the w_pcmark.  If not, then we revert to
2631      * using the previous w_pcmark.
2632      */
2633     pos_T	w_pcmark;	/* previous context mark */
2634     pos_T	w_prev_pcmark;	/* previous w_pcmark */
2635 
2636 #ifdef FEAT_JUMPLIST
2637     /*
2638      * the jumplist contains old cursor positions
2639      */
2640     xfmark_T	w_jumplist[JUMPLISTSIZE];
2641     int		w_jumplistlen;		/* number of active entries */
2642     int		w_jumplistidx;		/* current position */
2643 
2644     int		w_changelistidx;	/* current position in b_changelist */
2645 #endif
2646 
2647 #ifdef FEAT_SEARCH_EXTRA
2648     matchitem_T	*w_match_head;		/* head of match list */
2649     int		w_next_match_id;	/* next match ID */
2650 #endif
2651 
2652     /*
2653      * the tagstack grows from 0 upwards:
2654      * entry 0: older
2655      * entry 1: newer
2656      * entry 2: newest
2657      */
2658     taggy_T	w_tagstack[TAGSTACKSIZE];	/* the tag stack */
2659     int		w_tagstackidx;		/* idx just below active entry */
2660     int		w_tagstacklen;		/* number of tags on stack */
2661 
2662     /*
2663      * w_fraction is the fractional row of the cursor within the window, from
2664      * 0 at the top row to FRACTION_MULT at the last row.
2665      * w_prev_fraction_row was the actual cursor row when w_fraction was last
2666      * calculated.
2667      */
2668     int		w_fraction;
2669     int		w_prev_fraction_row;
2670 
2671 #ifdef FEAT_GUI
2672     scrollbar_T	w_scrollbars[2];	/* vert. Scrollbars for this window */
2673 #endif
2674 #ifdef FEAT_LINEBREAK
2675     linenr_T	w_nrwidth_line_count;	/* line count when ml_nrwidth_width
2676 					 * was computed. */
2677     long	w_nuw_cached;		/* 'numberwidth' option cached */
2678     int		w_nrwidth_width;	/* nr of chars to print line count. */
2679 #endif
2680 
2681 #ifdef FEAT_QUICKFIX
2682     qf_info_T	*w_llist;		/* Location list for this window */
2683     /*
2684      * Location list reference used in the location list window.
2685      * In a non-location list window, w_llist_ref is NULL.
2686      */
2687     qf_info_T	*w_llist_ref;
2688 #endif
2689 
2690 
2691 #ifdef FEAT_MZSCHEME
2692     void	*w_mzscheme_ref;	/* The MzScheme value for this window */
2693 #endif
2694 
2695 #ifdef FEAT_PERL
2696     void	*w_perl_private;
2697 #endif
2698 
2699 #ifdef FEAT_PYTHON
2700     void	*w_python_ref;		/* The Python value for this window */
2701 #endif
2702 
2703 #ifdef FEAT_PYTHON3
2704     void	*w_python3_ref;		/* The Python value for this window */
2705 #endif
2706 
2707 #ifdef FEAT_TCL
2708     void	*w_tcl_ref;
2709 #endif
2710 
2711 #ifdef FEAT_RUBY
2712     void	*w_ruby_ref;
2713 #endif
2714 };
2715 
2716 /*
2717  * Arguments for operators.
2718  */
2719 typedef struct oparg_S
2720 {
2721     int		op_type;	/* current pending operator type */
2722     int		regname;	/* register to use for the operator */
2723     int		motion_type;	/* type of the current cursor motion */
2724     int		motion_force;	/* force motion type: 'v', 'V' or CTRL-V */
2725     int		use_reg_one;	/* TRUE if delete uses reg 1 even when not
2726 				   linewise */
2727     int		inclusive;	/* TRUE if char motion is inclusive (only
2728 				   valid when motion_type is MCHAR */
2729     int		end_adjusted;	/* backuped b_op_end one char (only used by
2730 				   do_format()) */
2731     pos_T	start;		/* start of the operator */
2732     pos_T	end;		/* end of the operator */
2733     pos_T	cursor_start;	/* cursor position before motion for "gw" */
2734 
2735     long	line_count;	/* number of lines from op_start to op_end
2736 				   (inclusive) */
2737     int		empty;		/* op_start and op_end the same (only used by
2738 				   do_change()) */
2739     int		is_VIsual;	/* operator on Visual area */
2740     int		block_mode;	/* current operator is Visual block mode */
2741     colnr_T	start_vcol;	/* start col for block mode operator */
2742     colnr_T	end_vcol;	/* end col for block mode operator */
2743 #ifdef FEAT_AUTOCMD
2744     long	prev_opcount;	/* ca.opcount saved for K_CURSORHOLD */
2745     long	prev_count0;	/* ca.count0 saved for K_CURSORHOLD */
2746 #endif
2747 } oparg_T;
2748 
2749 /*
2750  * Arguments for Normal mode commands.
2751  */
2752 typedef struct cmdarg_S
2753 {
2754     oparg_T	*oap;		/* Operator arguments */
2755     int		prechar;	/* prefix character (optional, always 'g') */
2756     int		cmdchar;	/* command character */
2757     int		nchar;		/* next command character (optional) */
2758 #ifdef FEAT_MBYTE
2759     int		ncharC1;	/* first composing character (optional) */
2760     int		ncharC2;	/* second composing character (optional) */
2761 #endif
2762     int		extra_char;	/* yet another character (optional) */
2763     long	opcount;	/* count before an operator */
2764     long	count0;		/* count before command, default 0 */
2765     long	count1;		/* count before command, default 1 */
2766     int		arg;		/* extra argument from nv_cmds[] */
2767     int		retval;		/* return: CA_* values */
2768     char_u	*searchbuf;	/* return: pointer to search pattern or NULL */
2769 } cmdarg_T;
2770 
2771 /* values for retval: */
2772 #define CA_COMMAND_BUSY	    1	/* skip restarting edit() once */
2773 #define CA_NO_ADJ_OP_END    2	/* don't adjust operator end */
2774 
2775 #ifdef CURSOR_SHAPE
2776 /*
2777  * struct to store values from 'guicursor' and 'mouseshape'
2778  */
2779 /* Indexes in shape_table[] */
2780 #define SHAPE_IDX_N	0	/* Normal mode */
2781 #define SHAPE_IDX_V	1	/* Visual mode */
2782 #define SHAPE_IDX_I	2	/* Insert mode */
2783 #define SHAPE_IDX_R	3	/* Replace mode */
2784 #define SHAPE_IDX_C	4	/* Command line Normal mode */
2785 #define SHAPE_IDX_CI	5	/* Command line Insert mode */
2786 #define SHAPE_IDX_CR	6	/* Command line Replace mode */
2787 #define SHAPE_IDX_O	7	/* Operator-pending mode */
2788 #define SHAPE_IDX_VE	8	/* Visual mode with 'selection' exclusive */
2789 #define SHAPE_IDX_CLINE	9	/* On command line */
2790 #define SHAPE_IDX_STATUS 10	/* A status line */
2791 #define SHAPE_IDX_SDRAG 11	/* dragging a status line */
2792 #define SHAPE_IDX_VSEP	12	/* A vertical separator line */
2793 #define SHAPE_IDX_VDRAG 13	/* dragging a vertical separator line */
2794 #define SHAPE_IDX_MORE	14	/* Hit-return or More */
2795 #define SHAPE_IDX_MOREL	15	/* Hit-return or More in last line */
2796 #define SHAPE_IDX_SM	16	/* showing matching paren */
2797 #define SHAPE_IDX_COUNT	17
2798 
2799 #define SHAPE_BLOCK	0	/* block cursor */
2800 #define SHAPE_HOR	1	/* horizontal bar cursor */
2801 #define SHAPE_VER	2	/* vertical bar cursor */
2802 
2803 #define MSHAPE_NUMBERED	1000	/* offset for shapes identified by number */
2804 #define MSHAPE_HIDE	1	/* hide mouse pointer */
2805 
2806 #define SHAPE_MOUSE	1	/* used for mouse pointer shape */
2807 #define SHAPE_CURSOR	2	/* used for text cursor shape */
2808 
2809 typedef struct cursor_entry
2810 {
2811     int		shape;		/* one of the SHAPE_ defines */
2812     int		mshape;		/* one of the MSHAPE defines */
2813     int		percentage;	/* percentage of cell for bar */
2814     long	blinkwait;	/* blinking, wait time before blinking starts */
2815     long	blinkon;	/* blinking, on time */
2816     long	blinkoff;	/* blinking, off time */
2817     int		id;		/* highlight group ID */
2818     int		id_lm;		/* highlight group ID for :lmap mode */
2819     char	*name;		/* mode name (fixed) */
2820     char	used_for;	/* SHAPE_MOUSE and/or SHAPE_CURSOR */
2821 } cursorentry_T;
2822 #endif /* CURSOR_SHAPE */
2823 
2824 #ifdef FEAT_MENU
2825 
2826 /* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
2827 #define MENU_INDEX_INVALID	-1
2828 #define MENU_INDEX_NORMAL	0
2829 #define MENU_INDEX_VISUAL	1
2830 #define MENU_INDEX_SELECT	2
2831 #define MENU_INDEX_OP_PENDING	3
2832 #define MENU_INDEX_INSERT	4
2833 #define MENU_INDEX_CMDLINE	5
2834 #define MENU_INDEX_TIP		6
2835 #define MENU_MODES		7
2836 
2837 /* Menu modes */
2838 #define MENU_NORMAL_MODE	(1 << MENU_INDEX_NORMAL)
2839 #define MENU_VISUAL_MODE	(1 << MENU_INDEX_VISUAL)
2840 #define MENU_SELECT_MODE	(1 << MENU_INDEX_SELECT)
2841 #define MENU_OP_PENDING_MODE	(1 << MENU_INDEX_OP_PENDING)
2842 #define MENU_INSERT_MODE	(1 << MENU_INDEX_INSERT)
2843 #define MENU_CMDLINE_MODE	(1 << MENU_INDEX_CMDLINE)
2844 #define MENU_TIP_MODE		(1 << MENU_INDEX_TIP)
2845 #define MENU_ALL_MODES		((1 << MENU_INDEX_TIP) - 1)
2846 /*note MENU_INDEX_TIP is not a 'real' mode*/
2847 
2848 /* Start a menu name with this to not include it on the main menu bar */
2849 #define MNU_HIDDEN_CHAR		']'
2850 
2851 typedef struct VimMenu vimmenu_T;
2852 
2853 struct VimMenu
2854 {
2855     int		modes;		    /* Which modes is this menu visible for? */
2856     int		enabled;	    /* for which modes the menu is enabled */
2857     char_u	*name;		    /* Name of menu, possibly translated */
2858     char_u	*dname;		    /* Displayed Name ("name" without '&') */
2859 #ifdef FEAT_MULTI_LANG
2860     char_u	*en_name;	    /* "name" untranslated, NULL when "name"
2861 				     * was not translated */
2862     char_u	*en_dname;	    /* "dname" untranslated, NULL when "dname"
2863 				     * was not translated */
2864 #endif
2865     int		mnemonic;	    /* mnemonic key (after '&') */
2866     char_u	*actext;	    /* accelerator text (after TAB) */
2867     int		priority;	    /* Menu order priority */
2868 #ifdef FEAT_GUI
2869     void	(*cb)(vimmenu_T *);	    /* Call-back routine */
2870 #endif
2871 #ifdef FEAT_TOOLBAR
2872     char_u	*iconfile;	    /* name of file for icon or NULL */
2873     int		iconidx;	    /* icon index (-1 if not set) */
2874     int		icon_builtin;	    /* icon names is BuiltIn{nr} */
2875 #endif
2876     char_u	*strings[MENU_MODES]; /* Mapped string for each mode */
2877     int		noremap[MENU_MODES]; /* A REMAP_ flag for each mode */
2878     char	silent[MENU_MODES]; /* A silent flag for each mode */
2879     vimmenu_T	*children;	    /* Children of sub-menu */
2880     vimmenu_T	*parent;	    /* Parent of menu */
2881     vimmenu_T	*next;		    /* Next item in menu */
2882 #ifdef FEAT_GUI_X11
2883     Widget	id;		    /* Manage this to enable item */
2884     Widget	submenu_id;	    /* If this is submenu, add children here */
2885 #endif
2886 #ifdef FEAT_GUI_GTK
2887     GtkWidget	*id;		    /* Manage this to enable item */
2888     GtkWidget	*submenu_id;	    /* If this is submenu, add children here */
2889 # if defined(GTK_CHECK_VERSION) && !GTK_CHECK_VERSION(3,4,0)
2890     GtkWidget	*tearoff_handle;
2891 # endif
2892     GtkWidget   *label;		    /* Used by "set wak=" code. */
2893 #endif
2894 #ifdef FEAT_GUI_MOTIF
2895     int		sensitive;	    /* turn button on/off */
2896     char	**xpm;		    /* pixmap data */
2897     char	*xpm_fname;	    /* file with pixmap data */
2898 #endif
2899 #ifdef FEAT_GUI_ATHENA
2900     Pixmap	image;		    /* Toolbar image */
2901 #endif
2902 #ifdef FEAT_BEVAL_TIP
2903     BalloonEval *tip;		    /* tooltip for this menu item */
2904 #endif
2905 #ifdef FEAT_GUI_W32
2906     UINT	id;		    /* Id of menu item */
2907     HMENU	submenu_id;	    /* If this is submenu, add children here */
2908     HWND	tearoff_handle;	    /* hWnd of tearoff if created */
2909 #endif
2910 #ifdef FEAT_GUI_MAC
2911 /*  MenuHandle	id; */
2912 /*  short	index;	*/	    /* the item index within the father menu */
2913     short	menu_id;	    /* the menu id to which this item belong */
2914     short	submenu_id;	    /* the menu id of the children (could be
2915 				       get through some tricks) */
2916     MenuHandle	menu_handle;
2917     MenuHandle	submenu_handle;
2918 #endif
2919 #ifdef FEAT_GUI_PHOTON
2920     PtWidget_t	*id;
2921     PtWidget_t	*submenu_id;
2922 #endif
2923 };
2924 #else
2925 /* For generating prototypes when FEAT_MENU isn't defined. */
2926 typedef int vimmenu_T;
2927 
2928 #endif /* FEAT_MENU */
2929 
2930 /*
2931  * Struct to save values in before executing autocommands for a buffer that is
2932  * not the current buffer.  Without FEAT_AUTOCMD only "curbuf" is remembered.
2933  */
2934 typedef struct
2935 {
2936     buf_T	*save_curbuf;	/* saved curbuf */
2937 #ifdef FEAT_AUTOCMD
2938     int		use_aucmd_win;	/* using aucmd_win */
2939     win_T	*save_curwin;	/* saved curwin */
2940     win_T	*new_curwin;	/* new curwin */
2941     bufref_T	new_curbuf;	/* new curbuf */
2942     char_u	*globaldir;	/* saved value of globaldir */
2943 #endif
2944 } aco_save_T;
2945 
2946 /*
2947  * Generic option table item, only used for printer at the moment.
2948  */
2949 typedef struct
2950 {
2951     const char	*name;
2952     int		hasnum;
2953     long	number;
2954     char_u	*string;	/* points into option string */
2955     int		strlen;
2956     int		present;
2957 } option_table_T;
2958 
2959 /*
2960  * Structure to hold printing color and font attributes.
2961  */
2962 typedef struct
2963 {
2964     long_u	fg_color;
2965     long_u	bg_color;
2966     int		bold;
2967     int		italic;
2968     int		underline;
2969     int		undercurl;
2970 } prt_text_attr_T;
2971 
2972 /*
2973  * Structure passed back to the generic printer code.
2974  */
2975 typedef struct
2976 {
2977     int		n_collated_copies;
2978     int		n_uncollated_copies;
2979     int		duplex;
2980     int		chars_per_line;
2981     int		lines_per_page;
2982     int		has_color;
2983     prt_text_attr_T number;
2984 #ifdef FEAT_SYN_HL
2985     int		modec;
2986     int		do_syntax;
2987 #endif
2988     int		user_abort;
2989     char_u	*jobname;
2990 #ifdef FEAT_POSTSCRIPT
2991     char_u	*outfile;
2992     char_u	*arguments;
2993 #endif
2994 } prt_settings_T;
2995 
2996 #define PRINT_NUMBER_WIDTH 8
2997 
2998 /*
2999  * Used for popup menu items.
3000  */
3001 typedef struct
3002 {
3003     char_u	*pum_text;	/* main menu text */
3004     char_u	*pum_kind;	/* extra kind text (may be truncated) */
3005     char_u	*pum_extra;	/* extra menu text (may be truncated) */
3006     char_u	*pum_info;	/* extra info */
3007 } pumitem_T;
3008 
3009 /*
3010  * Structure used for get_tagfname().
3011  */
3012 typedef struct
3013 {
3014     char_u	*tn_tags;	/* value of 'tags' when starting */
3015     char_u	*tn_np;		/* current position in tn_tags */
3016     int		tn_did_filefind_init;
3017     int		tn_hf_idx;
3018     void	*tn_search_ctx;
3019 } tagname_T;
3020 
3021 /*
3022  * Array indexes used for cptext argument of ins_compl_add().
3023  */
3024 #define CPT_ABBR    0	/* "abbr" */
3025 #define CPT_MENU    1	/* "menu" */
3026 #define CPT_KIND    2	/* "kind" */
3027 #define CPT_INFO    3	/* "info" */
3028 #define CPT_COUNT   4	/* Number of entries */
3029 
3030 typedef struct {
3031   UINT32_T total[2];
3032   UINT32_T state[8];
3033   char_u   buffer[64];
3034 } context_sha256_T;
3035 
3036 /*
3037  * Structure used for reading in json_decode().
3038  */
3039 struct js_reader
3040 {
3041     char_u	*js_buf;	/* text to be decoded */
3042     char_u	*js_end;	/* NUL in js_buf */
3043     int		js_used;	/* bytes used from js_buf */
3044     int		(*js_fill)(struct js_reader *);
3045 				/* function to fill the buffer or NULL;
3046                                  * return TRUE when the buffer was filled */
3047     void	*js_cookie;	/* can be used by js_fill */
3048     int		js_cookie_arg;	/* can be used by js_fill */
3049 };
3050 typedef struct js_reader js_read_T;
3051 
3052 typedef struct timer_S timer_T;
3053 struct timer_S
3054 {
3055     int		tr_id;
3056 #ifdef FEAT_TIMERS
3057     timer_T	*tr_next;
3058     timer_T	*tr_prev;
3059     proftime_T	tr_due;		    /* when the callback is to be invoked */
3060     int		tr_repeat;	    /* number of times to repeat, -1 forever */
3061     long	tr_interval;	    /* only set when it repeats */
3062     char_u	*tr_callback;	    /* allocated */
3063     partial_T	*tr_partial;
3064 #endif
3065 };
3066 
3067 /* Maximum number of commands from + or -c arguments. */
3068 #define MAX_ARG_CMDS 10
3069 
3070 /* values for "window_layout" */
3071 #define WIN_HOR	    1	    /* "-o" horizontally split windows */
3072 #define	WIN_VER	    2	    /* "-O" vertically split windows */
3073 #define	WIN_TABS    3	    /* "-p" windows on tab pages */
3074 
3075 /* Struct for various parameters passed between main() and other functions. */
3076 typedef struct
3077 {
3078     int		argc;
3079     char	**argv;
3080 
3081     int		evim_mode;		/* started as "evim" */
3082     char_u	*use_vimrc;		/* vimrc from -u argument */
3083 
3084     int		n_commands;		     /* no. of commands from + or -c */
3085     char_u	*commands[MAX_ARG_CMDS];     /* commands from + or -c arg. */
3086     char_u	cmds_tofree[MAX_ARG_CMDS];   /* commands that need free() */
3087     int		n_pre_commands;		     /* no. of commands from --cmd */
3088     char_u	*pre_commands[MAX_ARG_CMDS]; /* commands from --cmd argument */
3089 
3090     int		edit_type;		/* type of editing to do */
3091     char_u	*tagname;		/* tag from -t argument */
3092 #ifdef FEAT_QUICKFIX
3093     char_u	*use_ef;		/* 'errorfile' from -q argument */
3094 #endif
3095 
3096     int		want_full_screen;
3097     int		stdout_isatty;		/* is stdout a terminal? */
3098     int		not_a_term;		/* no warning for missing term? */
3099     char_u	*term;			/* specified terminal name */
3100 #ifdef FEAT_CRYPT
3101     int		ask_for_key;		/* -x argument */
3102 #endif
3103     int		no_swap_file;		/* "-n" argument used */
3104 #ifdef FEAT_EVAL
3105     int		use_debug_break_level;
3106 #endif
3107 #ifdef FEAT_WINDOWS
3108     int		window_count;		/* number of windows to use */
3109     int		window_layout;		/* 0, WIN_HOR, WIN_VER or WIN_TABS */
3110 #endif
3111 
3112 #ifdef FEAT_CLIENTSERVER
3113     int		serverArg;		/* TRUE when argument for a server */
3114     char_u	*serverName_arg;	/* cmdline arg for server name */
3115     char_u	*serverStr;		/* remote server command */
3116     char_u	*serverStrEnc;		/* encoding of serverStr */
3117     char_u	*servername;		/* allocated name for our server */
3118 #endif
3119 #if !defined(UNIX)
3120 # define EXPAND_FILENAMES
3121     int		literal;		/* don't expand file names */
3122 #endif
3123 #ifdef MSWIN
3124     int		full_path;		/* file name argument was full path */
3125 #endif
3126 #ifdef FEAT_DIFF
3127     int		diff_mode;		/* start with 'diff' set */
3128 #endif
3129 } mparm_T;
3130 
3131 /*
3132  * Structure returned by get_lval() and used by set_var_lval().
3133  * For a plain name:
3134  *	"name"	    points to the variable name.
3135  *	"exp_name"  is NULL.
3136  *	"tv"	    is NULL
3137  * For a magic braces name:
3138  *	"name"	    points to the expanded variable name.
3139  *	"exp_name"  is non-NULL, to be freed later.
3140  *	"tv"	    is NULL
3141  * For an index in a list:
3142  *	"name"	    points to the (expanded) variable name.
3143  *	"exp_name"  NULL or non-NULL, to be freed later.
3144  *	"tv"	    points to the (first) list item value
3145  *	"li"	    points to the (first) list item
3146  *	"range", "n1", "n2" and "empty2" indicate what items are used.
3147  * For an existing Dict item:
3148  *	"name"	    points to the (expanded) variable name.
3149  *	"exp_name"  NULL or non-NULL, to be freed later.
3150  *	"tv"	    points to the dict item value
3151  *	"newkey"    is NULL
3152  * For a non-existing Dict item:
3153  *	"name"	    points to the (expanded) variable name.
3154  *	"exp_name"  NULL or non-NULL, to be freed later.
3155  *	"tv"	    points to the Dictionary typval_T
3156  *	"newkey"    is the key for the new item.
3157  */
3158 typedef struct lval_S
3159 {
3160     char_u	*ll_name;	/* start of variable name (can be NULL) */
3161     char_u	*ll_exp_name;	/* NULL or expanded name in allocated memory. */
3162     typval_T	*ll_tv;		/* Typeval of item being used.  If "newkey"
3163 				   isn't NULL it's the Dict to which to add
3164 				   the item. */
3165     listitem_T	*ll_li;		/* The list item or NULL. */
3166     list_T	*ll_list;	/* The list or NULL. */
3167     int		ll_range;	/* TRUE when a [i:j] range was used */
3168     long	ll_n1;		/* First index for list */
3169     long	ll_n2;		/* Second index for list range */
3170     int		ll_empty2;	/* Second index is empty: [i:] */
3171     dict_T	*ll_dict;	/* The Dictionary or NULL */
3172     dictitem_T	*ll_di;		/* The dictitem or NULL */
3173     char_u	*ll_newkey;	/* New key for Dict in alloc. mem or NULL. */
3174 } lval_T;
3175