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