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