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