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