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