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