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