xref: /vim-8.2.3635/src/structs.h (revision f4cd3e80)
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 unsigned	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 {0, 0, 0}
37 #else
38 # define INIT_POS_T {0, 0}
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 /*
67  * This is here because regexp.h needs pos_T and below regprog_T is used.
68  */
69 #include "regexp.h"
70 
71 typedef struct window	win_T;
72 typedef struct wininfo	wininfo_T;
73 typedef struct frame	frame_T;
74 typedef int		scid_T;		/* script ID */
75 
76 /*
77  * This is here because gui.h needs the pos_T and win_T, and win_T needs gui.h
78  * for scrollbar_T.
79  */
80 #ifdef FEAT_GUI
81 # include "gui.h"
82 #else
83 # ifdef FEAT_XCLIPBOARD
84 #  include <X11/Intrinsic.h>
85 # endif
86 # define guicolor_T int		/* avoid error in prototypes */
87 #endif
88 
89 /*
90  * marks: positions in a file
91  * (a normal mark is a lnum/col pair, the same as a file position)
92  */
93 
94 /* (Note: for EBCDIC there are more than 26, because there are gaps in the
95  * alphabet coding.  To minimize changes to the code, I decided to just
96  * increase the number of possible marks. */
97 #define NMARKS		('z' - 'a' + 1)	/* max. # of named marks */
98 #define JUMPLISTSIZE	100		/* max. # of marks in jump list */
99 #define TAGSTACKSIZE	20		/* max. # of tags in tag stack */
100 
101 typedef struct filemark
102 {
103     pos_T	mark;		/* cursor position */
104     int		fnum;		/* file number */
105 } fmark_T;
106 
107 /* Xtended file mark: also has a file name */
108 typedef struct xfilemark
109 {
110     fmark_T	fmark;
111     char_u	*fname;		/* file name, used when fnum == 0 */
112 } xfmark_T;
113 
114 /*
115  * The taggy struct is used to store the information about a :tag command.
116  */
117 typedef struct taggy
118 {
119     char_u	*tagname;	/* tag name */
120     fmark_T	fmark;		/* cursor position BEFORE ":tag" */
121     int		cur_match;	/* match number */
122     int		cur_fnum;	/* buffer number used for cur_match */
123 } taggy_T;
124 
125 /*
126  * Structure that contains all options that are local to a window.
127  * Used twice in a window: for the current buffer and for all buffers.
128  * Also used in wininfo_T.
129  */
130 typedef struct
131 {
132 #ifdef FEAT_ARABIC
133     int		wo_arab;
134 # define w_p_arab w_onebuf_opt.wo_arab	/* 'arabic' */
135 #endif
136 #ifdef FEAT_DIFF
137     int		wo_diff;
138 # define w_p_diff w_onebuf_opt.wo_diff	/* 'diff' */
139 #endif
140 #ifdef FEAT_FOLDING
141     long	wo_fdc;
142 # define w_p_fdc w_onebuf_opt.wo_fdc	/* 'foldcolumn' */
143     int		wo_fen;
144 # define w_p_fen w_onebuf_opt.wo_fen	/* 'foldenable' */
145     char_u	*wo_fdi;
146 # define w_p_fdi w_onebuf_opt.wo_fdi	/* 'foldignore' */
147     long	wo_fdl;
148 # define w_p_fdl w_onebuf_opt.wo_fdl	/* 'foldlevel' */
149     char_u	*wo_fdm;
150 # define w_p_fdm w_onebuf_opt.wo_fdm	/* 'foldmethod' */
151     long	wo_fml;
152 # define w_p_fml w_onebuf_opt.wo_fml	/* 'foldminlines' */
153     long	wo_fdn;
154 # define w_p_fdn w_onebuf_opt.wo_fdn	/* 'foldnextmax' */
155 # ifdef FEAT_EVAL
156     char_u	*wo_fde;
157 # define w_p_fde w_onebuf_opt.wo_fde	/* 'foldexpr' */
158     char_u	*wo_fdt;
159 #  define w_p_fdt w_onebuf_opt.wo_fdt	/* 'foldtext' */
160 # endif
161     char_u	*wo_fmr;
162 # define w_p_fmr w_onebuf_opt.wo_fmr	/* 'foldmarker' */
163 #endif
164 #ifdef FEAT_LINEBREAK
165     int		wo_lbr;
166 # define w_p_lbr w_onebuf_opt.wo_lbr	/* 'linebreak' */
167 #endif
168     int		wo_list;
169 #define w_p_list w_onebuf_opt.wo_list	/* 'list' */
170     int		wo_nu;
171 #define w_p_nu w_onebuf_opt.wo_nu	/* 'number' */
172 #ifdef FEAT_LINEBREAK
173     long	wo_nuw;
174 # define w_p_nuw w_onebuf_opt.wo_nuw	/* 'numberwidth' */
175 #endif
176 #if defined(FEAT_WINDOWS)
177     int		wo_wfh;
178 # define w_p_wfh w_onebuf_opt.wo_wfh	/* 'winfixheight' */
179 #endif
180 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
181     int		wo_pvw;
182 # define w_p_pvw w_onebuf_opt.wo_pvw	/* 'previewwindow' */
183 #endif
184 #ifdef FEAT_RIGHTLEFT
185     int		wo_rl;
186 # define w_p_rl w_onebuf_opt.wo_rl	/* 'rightleft' */
187     char_u	*wo_rlc;
188 # define w_p_rlc w_onebuf_opt.wo_rlc	/* 'rightleftcmd' */
189 #endif
190     long	wo_scr;
191 #define w_p_scr w_onebuf_opt.wo_scr	/* 'scroll' */
192 #ifdef FEAT_SYN_HL
193     int		wo_spell;
194 #define w_p_spell w_onebuf_opt.wo_spell	/* 'spell' */
195 #endif
196 #ifdef FEAT_STL_OPT
197     char_u	*wo_stl;
198 #define w_p_stl w_onebuf_opt.wo_stl	/* 'statusline' */
199 #endif
200 #ifdef FEAT_SCROLLBIND
201     int		wo_scb;
202 # define w_p_scb w_onebuf_opt.wo_scb	/* 'scrollbind' */
203 #endif
204     int		wo_wrap;
205 #define w_p_wrap w_onebuf_opt.wo_wrap	/* 'wrap' */
206 } winopt_T;
207 
208 /*
209  * Window info stored with a buffer.
210  *
211  * Two types of info are kept for a buffer which are associated with a
212  * specific window:
213  * 1. Each window can have a different line number associated with a buffer.
214  * 2. The window-local options for a buffer work in a similar way.
215  * The window-info is kept in a list at b_wininfo.  It is kept in
216  * most-recently-used order.
217  */
218 struct wininfo
219 {
220     wininfo_T	*wi_next;	/* next entry or NULL for last entry */
221     wininfo_T	*wi_prev;	/* previous entry or NULL for first entry */
222     win_T	*wi_win;	/* pointer to window that did set wi_lnum */
223     pos_T	wi_fpos;	/* last cursor position in the file */
224     int		wi_optset;	/* TRUE when wi_opt has useful values */
225     winopt_T	wi_opt;		/* local window options */
226 #ifdef FEAT_FOLDING
227     int		wi_fold_manual;	/* copy of w_fold_manual */
228     garray_T	wi_folds;	/* clone of w_folds */
229 #endif
230 };
231 
232 /*
233  * Info used to pass info about a fold from the fold-detection code to the
234  * code that displays the foldcolumn.
235  */
236 typedef struct foldinfo
237 {
238     int		fi_level;	/* level of the fold; when this is zero the
239 				   other fields are invalid */
240     int		fi_lnum;	/* line number where fold starts */
241     int		fi_low_level;	/* lowest fold level that starts in the same
242 				   line */
243 } foldinfo_T;
244 
245 /*
246  * stuctures used for undo
247  */
248 
249 typedef struct u_entry u_entry_T;
250 typedef struct u_header u_header_T;
251 struct u_entry
252 {
253     u_entry_T	*ue_next;	/* pointer to next entry in list */
254     linenr_T	ue_top;		/* number of line above undo block */
255     linenr_T	ue_bot;		/* number of line below undo block */
256     linenr_T	ue_lcount;	/* linecount when u_save called */
257     char_u	**ue_array;	/* array of lines in undo block */
258     long	ue_size;	/* number of lines in ue_array */
259 };
260 
261 struct u_header
262 {
263     u_header_T	*uh_next;	/* pointer to next header in list */
264     u_header_T	*uh_prev;	/* pointer to previous header in list */
265     u_entry_T	*uh_entry;	/* pointer to first entry */
266     u_entry_T	*uh_getbot_entry; /* pointer to where ue_bot must be set */
267     pos_T	uh_cursor;	/* cursor position before saving */
268 #ifdef FEAT_VIRTUALEDIT
269     long	uh_cursor_vcol;
270 #endif
271     int		uh_flags;	/* see below */
272     pos_T	uh_namedm[NMARKS];	/* marks before undo/after redo */
273 };
274 
275 /* values for uh_flags */
276 #define UH_CHANGED  0x01	/* b_changed flag before undo/after redo */
277 #define UH_EMPTYBUF 0x02	/* buffer was empty */
278 
279 /*
280  * stuctures used in undo.c
281  */
282 #if SIZEOF_INT > 2
283 # define ALIGN_LONG	/* longword alignment and use filler byte */
284 # define ALIGN_SIZE (sizeof(long))
285 #else
286 # define ALIGN_SIZE (sizeof(short))
287 #endif
288 
289 #define ALIGN_MASK (ALIGN_SIZE - 1)
290 
291 typedef struct m_info minfo_T;
292 
293 /*
294  * stucture used to link chunks in one of the free chunk lists.
295  */
296 struct m_info
297 {
298 #ifdef ALIGN_LONG
299     long_u	m_size;		/* size of the chunk (including m_info) */
300 #else
301     short_u	m_size;		/* size of the chunk (including m_info) */
302 #endif
303     minfo_T	*m_next;	/* pointer to next free chunk in the list */
304 };
305 
306 /*
307  * structure used to link blocks in the list of allocated blocks.
308  */
309 typedef struct m_block mblock_T;
310 struct m_block
311 {
312     mblock_T	*mb_next;	/* pointer to next allocated block */
313     size_t	mb_size;	/* total size of all chunks in this block */
314     size_t	mb_maxsize;	/* size of largest fee chunk */
315     minfo_T	mb_info;	/* head of free chunk list for this block */
316 };
317 
318 /*
319  * things used in memfile.c
320  */
321 
322 typedef struct block_hdr    bhdr_T;
323 typedef struct memfile	    memfile_T;
324 typedef long		    blocknr_T;
325 
326 /*
327  * for each (previously) used block in the memfile there is one block header.
328  *
329  * The block may be linked in the used list OR in the free list.
330  * The used blocks are also kept in hash lists.
331  *
332  * The used list is a doubly linked list, most recently used block first.
333  *	The blocks in the used list have a block of memory allocated.
334  *	mf_used_count is the number of pages in the used list.
335  * The hash lists are used to quickly find a block in the used list.
336  * The free list is a single linked list, not sorted.
337  *	The blocks in the free list have no block of memory allocated and
338  *	the contents of the block in the file (if any) is irrelevant.
339  */
340 
341 struct block_hdr
342 {
343     bhdr_T	*bh_next;	    /* next block_hdr in free or used list */
344     bhdr_T	*bh_prev;	    /* previous block_hdr in used list */
345     bhdr_T	*bh_hash_next;	    /* next block_hdr in hash list */
346     bhdr_T	*bh_hash_prev;	    /* previous block_hdr in hash list */
347     blocknr_T	bh_bnum;		/* block number */
348     char_u	*bh_data;	    /* pointer to memory (for used block) */
349     int		bh_page_count;	    /* number of pages in this block */
350 
351 #define BH_DIRTY    1
352 #define BH_LOCKED   2
353     char	bh_flags;	    /* BH_DIRTY or BH_LOCKED */
354 };
355 
356 /*
357  * when a block with a negative number is flushed to the file, it gets
358  * a positive number. Because the reference to the block is still the negative
359  * number, we remember the translation to the new positive number in the
360  * double linked trans lists. The structure is the same as the hash lists.
361  */
362 typedef struct nr_trans NR_TRANS;
363 
364 struct nr_trans
365 {
366     NR_TRANS	*nt_next;		/* next nr_trans in hash list */
367     NR_TRANS	*nt_prev;		/* previous nr_trans in hash list */
368     blocknr_T	nt_old_bnum;		/* old, negative, number */
369     blocknr_T	nt_new_bnum;		/* new, positive, number */
370 };
371 
372 /*
373  * structure used to store one block of the stuff/redo/recording buffers
374  */
375 struct buffblock
376 {
377     struct buffblock	*b_next;	/* pointer to next buffblock */
378     char_u		b_str[1];	/* contents (actually longer) */
379 };
380 
381 /*
382  * header used for the stuff buffer and the redo buffer
383  */
384 struct buffheader
385 {
386     struct buffblock	bh_first;	/* first (dummy) block of list */
387     struct buffblock	*bh_curr;	/* buffblock for appending */
388     int			bh_index;	/* index for reading */
389     int			bh_space;	/* space in bh_curr for appending */
390 };
391 
392 /*
393  * used for completion on the command line
394  */
395 typedef struct expand
396 {
397     int		xp_context;		/* type of expansion */
398     char_u	*xp_pattern;		/* start of item to expand */
399 #if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
400     char_u	*xp_arg;		/* completion function */
401     int		xp_scriptID;		/* SID for completion function */
402 #endif
403     int		xp_backslash;		/* one of the XP_BS_ values */
404     int		xp_numfiles;		/* number of files found by
405 						    file name completion */
406     char_u	**xp_files;		/* list of files */
407 } expand_T;
408 
409 /* values for xp_backslash */
410 #define XP_BS_NONE	0	/* nothing special for backslashes */
411 #define XP_BS_ONE	1	/* uses one backslash before a space */
412 #define XP_BS_THREE	2	/* uses three backslashes before a space */
413 
414 /*
415  * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
416  * This needs to be saved for recursive commands, put them in a structure for
417  * easy manipulation.
418  */
419 typedef struct
420 {
421     int		hide;			/* TRUE when ":hide" was used */
422 # ifdef FEAT_BROWSE
423     int		browse;			/* TRUE to invoke file dialog */
424 # endif
425 # ifdef FEAT_WINDOWS
426     int		split;			/* flags for win_split() */
427 # endif
428 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
429     int		confirm;		/* TRUE to invoke yes/no dialog */
430 # endif
431     int		keepalt;		/* TRUE when ":keepalt" was used */
432     int		keepmarks;		/* TRUE when ":keepmarks" was used */
433     int		keepjumps;		/* TRUE when ":keepjumps" was used */
434     int		lockmarks;		/* TRUE when ":lockmarks" was used */
435 # ifdef FEAT_AUTOCMD
436     char_u	*save_ei;		/* saved value of 'eventignore' */
437 # endif
438 } cmdmod_T;
439 
440 /*
441  * Simplistic hashing scheme to quickly locate the blocks in the used list.
442  * 64 blocks are found directly (64 * 4K = 256K, most files are smaller).
443  */
444 #define MEMHASHSIZE	64
445 #define MEMHASH(nr)	((nr) & (MEMHASHSIZE - 1))
446 
447 struct memfile
448 {
449     char_u	*mf_fname;		/* name of the file */
450     char_u	*mf_ffname;		/* idem, full path */
451     int		mf_fd;			/* file descriptor */
452     bhdr_T	*mf_free_first;		/* first block_hdr in free list */
453     bhdr_T	*mf_used_first;		/* mru block_hdr in used list */
454     bhdr_T	*mf_used_last;		/* lru block_hdr in used list */
455     unsigned	mf_used_count;		/* number of pages in used list */
456     unsigned	mf_used_count_max;	/* maximum number of pages in memory */
457     bhdr_T	*mf_hash[MEMHASHSIZE];	/* array of hash lists */
458     NR_TRANS	*mf_trans[MEMHASHSIZE];	/* array of trans lists */
459     blocknr_T	mf_blocknr_max;		/* highest positive block number + 1*/
460     blocknr_T	mf_blocknr_min;		/* lowest negative block number - 1 */
461     blocknr_T	mf_neg_count;		/* number of negative blocks numbers */
462     blocknr_T	mf_infile_count;	/* number of pages in the file */
463     unsigned	mf_page_size;		/* number of bytes in a page */
464     int		mf_dirty;		/* TRUE if there are dirty blocks */
465 };
466 
467 /*
468  * things used in memline.c
469  */
470 /*
471  * When searching for a specific line, we remember what blocks in the tree
472  * are the branches leading to that block. This is stored in ml_stack.  Each
473  * entry is a pointer to info in a block (may be data block or pointer block)
474  */
475 typedef struct info_pointer
476 {
477     blocknr_T	ip_bnum;	/* block number */
478     linenr_T	ip_low;		/* lowest lnum in this block */
479     linenr_T	ip_high;	/* highest lnum in this block */
480     int		ip_index;	/* index for block with current lnum */
481 } infoptr_T;	/* block/index pair */
482 
483 #ifdef FEAT_BYTEOFF
484 typedef struct ml_chunksize
485 {
486     int		mlcs_numlines;
487     long	mlcs_totalsize;
488 } chunksize_T;
489 
490  /* Flags when calling ml_updatechunk() */
491 
492 #define ML_CHNK_ADDLINE 1
493 #define ML_CHNK_DELLINE 2
494 #define ML_CHNK_UPDLINE 3
495 #endif
496 
497 /*
498  * the memline structure holds all the information about a memline
499  */
500 typedef struct memline
501 {
502     linenr_T	ml_line_count;	/* number of lines in the buffer */
503 
504     memfile_T	*ml_mfp;	/* pointer to associated memfile */
505 
506 #define ML_EMPTY	1	/* empty buffer */
507 #define ML_LINE_DIRTY	2	/* cached line was changed and allocated */
508 #define ML_LOCKED_DIRTY	4	/* ml_locked was changed */
509 #define ML_LOCKED_POS	8	/* ml_locked needs positive block number */
510     int		ml_flags;
511 
512     infoptr_T	*ml_stack;	/* stack of pointer blocks (array of IPTRs) */
513     int		ml_stack_top;	/* current top if ml_stack */
514     int		ml_stack_size;	/* total number of entries in ml_stack */
515 
516     linenr_T	ml_line_lnum;	/* line number of cached line, 0 if not valid */
517     char_u	*ml_line_ptr;	/* pointer to cached line */
518 
519     bhdr_T	*ml_locked;	/* block used by last ml_get */
520     linenr_T	ml_locked_low;	/* first line in ml_locked */
521     linenr_T	ml_locked_high;	/* last line in ml_locked */
522     int		ml_locked_lineadd;  /* number of lines inserted in ml_locked */
523 #ifdef FEAT_BYTEOFF
524     chunksize_T *ml_chunksize;
525     int		ml_numchunks;
526     int		ml_usedchunks;
527 #endif
528 } memline_T;
529 
530 #if defined(FEAT_SIGNS) || defined(PROTO)
531 typedef struct signlist signlist_T;
532 
533 struct signlist
534 {
535     int		id;		/* unique identifier for each placed sign */
536     linenr_T	lnum;		/* line number which has this sign */
537     int		typenr;		/* typenr of sign */
538     signlist_T	*next;		/* next signlist entry */
539 # ifdef FEAT_NETBEANS_INTG
540     signlist_T  *prev;		/* previous entry -- for easy reordering */
541 # endif
542 };
543 
544 /* type argument for buf_getsigntype() */
545 #define SIGN_ANY	0
546 #define SIGN_LINEHL	1
547 #define SIGN_ICON	2
548 #define SIGN_TEXT	3
549 #endif
550 
551 /*
552  * Argument list: Array of file names.
553  * Used for the global argument list and the argument lists local to a window.
554  */
555 typedef struct arglist
556 {
557     garray_T	al_ga;		/* growarray with the array of file names */
558     int		al_refcount;	/* number of windows using this arglist */
559 } alist_T;
560 
561 /*
562  * For each argument remember the file name as it was given, and the buffer
563  * number that contains the expanded file name (required for when ":cd" is
564  * used.
565  */
566 typedef struct argentry
567 {
568     char_u	*ae_fname;	/* file name as specified */
569     int		ae_fnum;	/* buffer number with expanded file name */
570 } aentry_T;
571 
572 #ifdef FEAT_WINDOWS
573 # define ALIST(win) (win)->w_alist
574 #else
575 # define ALIST(win) (&global_alist)
576 #endif
577 #define GARGLIST	((aentry_T *)global_alist.al_ga.ga_data)
578 #define ARGLIST		((aentry_T *)ALIST(curwin)->al_ga.ga_data)
579 #define WARGLIST(wp)	((aentry_T *)ALIST(wp)->al_ga.ga_data)
580 #define AARGLIST(al)	((aentry_T *)((al)->al_ga.ga_data))
581 #define GARGCOUNT	(global_alist.al_ga.ga_len)
582 #define ARGCOUNT	(ALIST(curwin)->al_ga.ga_len)
583 #define WARGCOUNT(wp)	(ALIST(wp)->al_ga.ga_len)
584 
585 /*
586  * A list used for saving values of "emsg_silent".  Used by ex_try() to save the
587  * value of "emsg_silent" if it was non-zero.  When this is done, the CSF_SILENT
588  * flag below is set.
589  */
590 
591 typedef struct eslist_elem eslist_T;
592 struct eslist_elem
593 {
594     int		saved_emsg_silent;	/* saved value of "emsg_silent" */
595     eslist_T	*next;			/* next element on the list */
596 };
597 
598 /*
599  * For conditional commands a stack is kept of nested conditionals.
600  * When cs_idx < 0, there is no conditional command.
601  */
602 #define CSTACK_LEN	50
603 
604 struct condstack
605 {
606     short	cs_flags[CSTACK_LEN];	/* CSF_ flags */
607     char	cs_pending[CSTACK_LEN];	/* CSTP_: what's pending in ":finally"*/
608     union {
609 	void	*csp_rv[CSTACK_LEN];	/* return typeval for pending return */
610 	void	*csp_ex[CSTACK_LEN];	/* exception for pending throw */
611     }		cs_pend;
612     void	*cs_forinfo[CSTACK_LEN]; /* info used by ":for" */
613     int		cs_line[CSTACK_LEN];	/* line nr of ":while"/":for" line */
614     int		cs_idx;			/* current entry, or -1 if none */
615     int		cs_looplevel;		/* nr of nested ":while"s and ":for"s */
616     int		cs_trylevel;		/* nr of nested ":try"s */
617     eslist_T	*cs_emsg_silent_list;	/* saved values of "emsg_silent" */
618     char	cs_lflags;		/* loop flags: CSL_ flags */
619 };
620 # define cs_rettv	cs_pend.csp_rv
621 # define cs_exception	cs_pend.csp_ex
622 
623 /* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
624  * was used. */
625 # define CSF_TRUE	0x0001	/* condition was TRUE */
626 # define CSF_ACTIVE	0x0002	/* current state is active */
627 # define CSF_ELSE	0x0004	/* ":else" has been passed */
628 # define CSF_WHILE	0x0008	/* is a ":while" */
629 # define CSF_FOR	0x0010	/* is a ":for" */
630 
631 # define CSF_TRY	0x0100	/* is a ":try" */
632 # define CSF_FINALLY	0x0200	/* ":finally" has been passed */
633 # define CSF_THROWN	0x0400	/* exception thrown to this try conditional */
634 # define CSF_CAUGHT	0x0800  /* exception caught by this try conditional */
635 # define CSF_SILENT	0x1000	/* "emsg_silent" reset by ":try" */
636 /* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
637  * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
638 
639 /*
640  * What's pending for being reactivated at the ":endtry" of this try
641  * conditional:
642  */
643 # define CSTP_NONE	0	/* nothing pending in ":finally" clause */
644 # define CSTP_ERROR	1	/* an error is pending */
645 # define CSTP_INTERRUPT	2	/* an interrupt is pending */
646 # define CSTP_THROW	4	/* a throw is pending */
647 # define CSTP_BREAK	8	/* ":break" is pending */
648 # define CSTP_CONTINUE	16	/* ":continue" is pending */
649 # define CSTP_RETURN	24	/* ":return" is pending */
650 # define CSTP_FINISH	32	/* ":finish" is pending */
651 
652 /*
653  * Flags for the cs_lflags item in struct condstack.
654  */
655 # define CSL_HAD_LOOP	 1	/* just found ":while" or ":for" */
656 # define CSL_HAD_ENDLOOP 2	/* just found ":endwhile" or ":endfor" */
657 # define CSL_HAD_CONT	 4	/* just found ":continue" */
658 # define CSL_HAD_FINA	 8	/* just found ":finally" */
659 
660 /*
661  * A list of error messages that can be converted to an exception.  "throw_msg"
662  * is only set in the first element of the list.  Usually, it points to the
663  * original message stored in that element, but sometimes it points to a later
664  * message in the list.  See cause_errthrow() below.
665  */
666 struct msglist
667 {
668     char_u		*msg;		/* original message */
669     char_u		*throw_msg;	/* msg to throw: usually original one */
670     struct msglist	*next;		/* next of several messages in a row */
671 };
672 
673 /*
674  * Structure describing an exception.
675  * (don't use "struct exception", it's used by the math library).
676  */
677 typedef struct vim_exception except_T;
678 struct vim_exception
679 {
680     int			type;		/* exception type */
681     char_u		*value;		/* exception value */
682     struct msglist	*messages;	/* message(s) causing error exception */
683     char_u		*throw_name;	/* name of the throw point */
684     linenr_T		throw_lnum;	/* line number of the throw point */
685     except_T		*caught;	/* next exception on the caught stack */
686 };
687 
688 /*
689  * The exception types.
690  */
691 #define ET_USER		0	/* exception caused by ":throw" command */
692 #define ET_ERROR	1	/* error exception */
693 #define ET_INTERRUPT	2	/* interrupt exception triggered by Ctrl-C */
694 
695 /*
696  * Structure to save the error/interrupt/exception state between calls to
697  * enter_cleanup() and leave_cleanup().  Must be allocated as an automatic
698  * variable by the (common) caller of these functions.
699  */
700 typedef struct cleanup_stuff cleanup_T;
701 struct cleanup_stuff
702 {
703     int pending;		/* error/interrupt/exception state */
704     except_T *exception;	/* exception value */
705 };
706 
707 #ifdef FEAT_SYN_HL
708 /* struct passed to in_id_list() */
709 struct sp_syn
710 {
711     int		inc_tag;	/* ":syn include" unique tag */
712     short	id;		/* highlight group ID of item */
713     short	*cont_in_list;	/* cont.in group IDs, if non-zero */
714 };
715 
716 /*
717  * Each keyword has one keyentry, which is linked in a hash list.
718  */
719 typedef struct keyentry keyentry_T;
720 
721 struct keyentry
722 {
723     keyentry_T	*ke_next;	/* next entry with identical "keyword[]" */
724     struct sp_syn k_syn;	/* struct passed to in_id_list() */
725     short	*next_list;	/* ID list for next match (if non-zero) */
726     short	flags;		/* see syntax.c */
727     char_u	keyword[1];	/* actually longer */
728 };
729 
730 /*
731  * Struct used to store one state of the state stack.
732  */
733 typedef struct buf_state
734 {
735     int		    bs_idx;	 /* index of pattern */
736     long	    bs_flags;	 /* flags for pattern */
737     reg_extmatch_T *bs_extmatch; /* external matches from start pattern */
738 } bufstate_T;
739 
740 /*
741  * syn_state contains the syntax state stack for the start of one line.
742  * Used by b_sst_array[].
743  */
744 typedef struct syn_state synstate_T;
745 
746 struct syn_state
747 {
748     synstate_T	*sst_next;	/* next entry in used or free list */
749     linenr_T	sst_lnum;	/* line number for this state */
750     union
751     {
752 	bufstate_T	sst_stack[SST_FIX_STATES]; /* short state stack */
753 	garray_T	sst_ga;	/* growarray for long state stack */
754     } sst_union;
755     int		sst_next_flags;	/* flags for sst_next_list */
756     short	*sst_next_list;	/* "nextgroup" list in this state
757 				 * (this is a copy, don't free it! */
758     short	sst_stacksize;	/* number of states on the stack */
759     disptick_T	sst_tick;	/* tick when last displayed */
760     linenr_T	sst_change_lnum;/* when non-zero, change in this line
761 				 * may have made the state invalid */
762 };
763 #endif /* FEAT_SYN_HL */
764 
765 /*
766  * Structure shared between syntax.c, screen.c and gui_x11.c.
767  */
768 typedef struct attr_entry
769 {
770     short	    ae_attr;		/* HL_BOLD, etc. */
771     union
772     {
773 	struct
774 	{
775 	    char_u	    *start;	/* start escape sequence */
776 	    char_u	    *stop;	/* stop escape sequence */
777 	} term;
778 	struct
779 	{
780 	    char_u	    fg_color;	/* foreground color number */
781 	    char_u	    bg_color;	/* background color number */
782 	} cterm;
783 # ifdef FEAT_GUI
784 	struct
785 	{
786 	    guicolor_T	    fg_color;	/* foreground color handle */
787 	    guicolor_T	    bg_color;	/* background color handle */
788 	    guicolor_T	    sp_color;	/* special color handle */
789 	    GuiFont	    font;	/* font handle */
790 #  ifdef FEAT_XFONTSET
791 	    GuiFontset	    fontset;	/* fontset handle */
792 #  endif
793 	} gui;
794 # endif
795     } ae_u;
796 } attrentry_T;
797 
798 #ifdef USE_ICONV
799 # ifdef HAVE_ICONV_H
800 #  include <iconv.h>
801 # else
802 #  if defined(MACOS_X)
803 #   include <sys/errno.h>
804 #   define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
805 typedef struct _iconv_t *iconv_t;
806 #  else
807 #   if defined(MACOS_CLASSIC)
808 typedef struct _iconv_t *iconv_t;
809 #    define EINVAL	22
810 #    define E2BIG	7
811 #    define ENOENT	2
812 #    define EFAULT	14
813 #    define EILSEQ	123
814 #   else
815 #    include <errno.h>
816 #   endif
817 #  endif
818 typedef void *iconv_t;
819 # endif
820 #endif
821 
822 /*
823  * Used for the typeahead buffer: typebuf.
824  */
825 typedef struct
826 {
827     char_u	*tb_buf;	/* buffer for typed characters */
828     char_u	*tb_noremap;	/* mapping flags for characters in tb_buf[] */
829     int		tb_buflen;	/* size of tb_buf[] */
830     int		tb_off;		/* current position in tb_buf[] */
831     int		tb_len;		/* number of valid bytes in tb_buf[] */
832     int		tb_maplen;	/* nr of mapped bytes in tb_buf[] */
833     int		tb_silent;	/* nr of silently mapped bytes in tb_buf[] */
834     int		tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */
835     int		tb_change_cnt;	/* nr of time tb_buf was changed; never zero */
836 } typebuf_T;
837 
838 /* Struct to hold the saved typeahead for save_typeahead(). */
839 typedef struct
840 {
841     typebuf_T		save_typebuf;
842     int			typebuf_valid;	    /* TRUE when save_typebuf valid */
843     struct buffheader	save_stuffbuff;
844 #ifdef USE_INPUT_BUF
845     char_u		*save_inputbuf;
846 #endif
847 } tasave_T;
848 
849 /*
850  * Used for conversion of terminal I/O and script files.
851  */
852 typedef struct
853 {
854     int		vc_type;	/* zero or one of the CONV_ values */
855     int		vc_factor;	/* max. expansion factor */
856 # ifdef WIN3264
857     int		vc_cpfrom;	/* codepage to convert from (CONV_CODEPAGE) */
858     int		vc_cpto;	/* codepage to convert to (CONV_CODEPAGE) */
859 # endif
860 # ifdef USE_ICONV
861     iconv_t	vc_fd;		/* for CONV_ICONV */
862 # endif
863     int		vc_fail;	/* fail for invalid char, don't use '?' */
864 } vimconv_T;
865 
866 /*
867  * Structure used for reading from the viminfo file.
868  */
869 typedef struct
870 {
871     char_u	*vir_line;	/* text of the current line */
872     FILE	*vir_fd;	/* file descriptor */
873 #ifdef FEAT_MBYTE
874     vimconv_T	vir_conv;	/* encoding conversion */
875 #endif
876 } vir_T;
877 
878 #define CONV_NONE		0
879 #define CONV_TO_UTF8		1
880 #define CONV_9_TO_UTF8		2
881 #define CONV_TO_LATIN1		3
882 #define CONV_TO_LATIN9		4
883 #define CONV_ICONV		5
884 #ifdef WIN3264
885 # define CONV_CODEPAGE		10	/* codepage -> codepage */
886 #endif
887 #ifdef MACOS_X
888 # define CONV_MAC_LATIN1	20
889 # define CONV_LATIN1_MAC	21
890 # define CONV_MAC_UTF8		22
891 # define CONV_UTF8_MAC		23
892 #endif
893 
894 /*
895  * Structure used for mappings and abbreviations.
896  */
897 typedef struct mapblock mapblock_T;
898 struct mapblock
899 {
900     mapblock_T	*m_next;	/* next mapblock in list */
901     char_u	*m_keys;	/* mapped from */
902     int		m_keylen;	/* strlen(m_keys) */
903     char_u	*m_str;		/* mapped to */
904     int		m_mode;		/* valid mode */
905     int		m_noremap;	/* if non-zero no re-mapping for m_str */
906     char	m_silent;	/* <silent> used, don't echo commands */
907 #ifdef FEAT_EVAL
908     scid_T	m_script_ID;	/* ID of script where map was defined */
909 #endif
910 };
911 
912 /*
913  * Used for highlighting in the status line.
914  */
915 struct stl_hlrec
916 {
917     char_u	*start;
918     int		userhl;
919 };
920 
921 /* Item for a hashtable.  "hi_key" can be one of three values:
922  * NULL:	   Never been used
923  * HI_KEY_REMOVED: Entry was removed
924  * Otherwise:	   Used item, pointer to the actual key; this usually is
925  *		   inside the item, subtract an offset to locate the item.
926  *		   This reduces the size of hashitem by 1/3.
927  */
928 typedef struct hashitem_S
929 {
930     long_u	hi_hash;	/* cached hash number of hi_key */
931     char_u	*hi_key;
932 } hashitem_T;
933 
934 /* The address of "hash_removed" is used as a magic number for hi_key to
935  * indicate a removed item. */
936 #define HI_KEY_REMOVED &hash_removed
937 #define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
938 
939 /* Initial size for a hashtable.  Our items are relatively small and growing
940  * is expensive, thus use 16 as a start.  Must be a power of 2. */
941 #define HT_INIT_SIZE 16
942 
943 typedef struct hashtable_S
944 {
945     long_u	ht_mask;	/* mask used for hash value (nr of items in
946 				 * array is "ht_mask" + 1) */
947     long_u	ht_used;	/* number of items used */
948     long_u	ht_filled;	/* number of items used + removed */
949     int		ht_locked;	/* counter for hash_lock() */
950     int		ht_error;	/* when set growing failed, can't add more
951 				   items before growing works */
952     hashitem_T	*ht_array;	/* points to the array, allocated when it's
953 				   not "ht_smallarray" */
954     hashitem_T	ht_smallarray[HT_INIT_SIZE];   /* initial array */
955 } hashtab_T;
956 
957 typedef long_u hash_T;		/* Type for hi_hash */
958 
959 
960 #if SIZEOF_INT <= 3		/* use long if int is smaller than 32 bits */
961 typedef long	varnumber_T;
962 #else
963 typedef int	varnumber_T;
964 #endif
965 
966 typedef struct listvar_S list_T;
967 typedef struct dictvar_S dict_T;
968 
969 /*
970  * Structure to hold an internal variable without a name.
971  */
972 typedef struct
973 {
974     char	v_type;	    /* see below: VAR_NUMBER, VAR_STRING, etc. */
975     char	v_lock;	    /* see below: VAR_LOCKED, VAR_FIXED */
976     union
977     {
978 	varnumber_T	v_number;	/* number value */
979 	char_u		*v_string;	/* string value (can be NULL!) */
980 	list_T		*v_list;	/* list value (can be NULL!) */
981 	dict_T		*v_dict;	/* dict value (can be NULL!) */
982     }		vval;
983 } typval_T;
984 
985 /* Values for "v_type". */
986 #define VAR_UNKNOWN 0
987 #define VAR_NUMBER  1	/* "v_number" is used */
988 #define VAR_STRING  2	/* "v_string" is used */
989 #define VAR_FUNC    3	/* "v_string" is function name */
990 #define VAR_LIST    4	/* "v_list" is used */
991 #define VAR_DICT    5	/* "v_dict" is used */
992 
993 /* Values for "v_lock". */
994 #define VAR_LOCKED  1	/* locked with lock(), can use unlock() */
995 #define VAR_FIXED   2	/* locked forever */
996 
997 /*
998  * Structure to hold an item of a list: an internal variable without a name.
999  */
1000 typedef struct listitem_S listitem_T;
1001 
1002 struct listitem_S
1003 {
1004     listitem_T	*li_next;	/* next item in list */
1005     listitem_T	*li_prev;	/* previous item in list */
1006     typval_T	li_tv;		/* type and value of the variable */
1007 };
1008 
1009 /*
1010  * Struct used by those that are using an item in a list.
1011  */
1012 typedef struct listwatch_S listwatch_T;
1013 
1014 struct listwatch_S
1015 {
1016     listitem_T		*lw_item;	/* item being watched */
1017     listwatch_T		*lw_next;	/* next watcher */
1018 };
1019 
1020 /*
1021  * Structure to hold info about a list.
1022  */
1023 struct listvar_S
1024 {
1025     listitem_T	*lv_first;	/* first item, NULL if none */
1026     listitem_T	*lv_last;	/* last item, NULL if none */
1027     int		lv_refcount;	/* reference count */
1028     int		lv_len;		/* number of items */
1029     listwatch_T	*lv_watch;	/* first watcher, NULL if none */
1030     int		lv_idx;		/* cached index of an item */
1031     listitem_T	*lv_idx_item;	/* when not NULL item at index "lv_idx" */
1032     int		lv_copyID;	/* ID used by deepcopy() */
1033     list_T	*lv_copylist;	/* copied list used by deepcopy() */
1034     char	lv_lock;	/* zero, VAR_LOCKED, VAR_FIXED */
1035     list_T	*lv_used_next;	/* next list in used lists list */
1036     list_T	*lv_used_prev;	/* previous list in used lists list */
1037 };
1038 
1039 /*
1040  * Structure to hold an item of a Dictionary.
1041  * Also used for a variable.
1042  * The key is copied into "di_key" to avoid an extra alloc/free for it.
1043  */
1044 struct dictitem_S
1045 {
1046     typval_T	di_tv;		/* type and value of the variable */
1047     char_u	di_flags;	/* flags (only used for variable) */
1048     char_u	di_key[1];	/* key (actually longer!) */
1049 };
1050 
1051 typedef struct dictitem_S dictitem_T;
1052 
1053 #define DI_FLAGS_RO	1 /* "di_flags" value: read-only variable */
1054 #define DI_FLAGS_RO_SBX 2 /* "di_flags" value: read-only in the sandbox */
1055 #define DI_FLAGS_FIX	4 /* "di_flags" value: fixed variable, not allocated */
1056 #define DI_FLAGS_LOCK	8 /* "di_flags" value: locked variable */
1057 
1058 /*
1059  * Structure to hold info about a Dictionary.
1060  */
1061 struct dictvar_S
1062 {
1063     int		dv_refcount;	/* reference count */
1064     hashtab_T	dv_hashtab;	/* hashtab that refers to the items */
1065     int		dv_copyID;	/* ID used by deepcopy() */
1066     dict_T	*dv_copydict;	/* copied dict used by deepcopy() */
1067     char	dv_lock;	/* zero, VAR_LOCKED, VAR_FIXED */
1068     dict_T	*dv_used_next;	/* next dict in used dicts list */
1069     dict_T	*dv_used_prev;	/* previous dict in used dicts list */
1070 };
1071 
1072 /* values for b_syn_spell: what to do with toplevel text */
1073 #define SYNSPL_DEFAULT	0	/* spell check if @Spell not defined */
1074 #define SYNSPL_TOP	1	/* spell check toplevel text */
1075 #define SYNSPL_NOTOP	2	/* don't spell check toplevel text */
1076 
1077 
1078 /*
1079  * buffer: structure that holds information about one file
1080  *
1081  * Several windows can share a single Buffer
1082  * A buffer is unallocated if there is no memfile for it.
1083  * A buffer is new if the associated file has never been loaded yet.
1084  */
1085 
1086 typedef struct file_buffer buf_T;
1087 
1088 struct file_buffer
1089 {
1090     memline_T	b_ml;		/* associated memline (also contains line
1091 				   count) */
1092 
1093     buf_T	*b_next;	/* links in list of buffers */
1094     buf_T	*b_prev;
1095 
1096     int		b_nwindows;	/* nr of windows open on this buffer */
1097 
1098     int		b_flags;	/* various BF_ flags */
1099 
1100     /*
1101      * b_ffname has the full path of the file (NULL for no name).
1102      * b_sfname is the name as the user typed it (or NULL).
1103      * b_fname is the same as b_sfname, unless ":cd" has been done,
1104      *		then it is the same as b_ffname (NULL for no name).
1105      */
1106     char_u	*b_ffname;	/* full path file name */
1107     char_u	*b_sfname;	/* short file name */
1108     char_u	*b_fname;	/* current file name */
1109 
1110 #ifdef UNIX
1111     int		b_dev;		/* device number (-1 if not set) */
1112     ino_t	b_ino;		/* inode number */
1113 #endif
1114 #ifdef FEAT_CW_EDITOR
1115     FSSpec	b_FSSpec;	/* MacOS File Identification */
1116 #endif
1117 #ifdef VMS
1118     char	 b_fab_rfm;	/* Record format    */
1119     char	 b_fab_rat;	/* Record attribute */
1120     unsigned int b_fab_mrs;	/* Max record size  */
1121 #endif
1122 #ifdef FEAT_SNIFF
1123     int		b_sniff;	/* file was loaded through Sniff */
1124 #endif
1125 
1126     int		b_fnum;		/* buffer number for this file. */
1127 
1128     int		b_changed;	/* 'modified': Set to TRUE if something in the
1129 				   file has been changed and not written out. */
1130     int		b_changedtick;	/* incremented for each change, also for undo */
1131 
1132     int		b_saving;	/* Set to TRUE if we are in the middle of
1133 				   saving the buffer. */
1134 
1135     /*
1136      * Changes to a buffer require updating of the display.  To minimize the
1137      * work, remember changes made and update everything at once.
1138      */
1139     int		b_mod_set;	/* TRUE when there are changes since the last
1140 				   time the display was updated */
1141     linenr_T	b_mod_top;	/* topmost lnum that was changed */
1142     linenr_T	b_mod_bot;	/* lnum below last changed line, AFTER the
1143 				   change */
1144     long	b_mod_xlines;	/* number of extra buffer lines inserted;
1145 				   negative when lines were deleted */
1146 
1147     wininfo_T	*b_wininfo;	/* list of last used info for each window */
1148 
1149     long	b_mtime;	/* last change time of original file */
1150     long	b_mtime_read;	/* last change time when reading */
1151     size_t	b_orig_size;	/* size of original file in bytes */
1152     int		b_orig_mode;	/* mode of original file */
1153 
1154     pos_T	b_namedm[NMARKS]; /* current named marks (mark.c) */
1155 
1156 #ifdef FEAT_VISUAL
1157     /* These variables are set when VIsual_active becomes FALSE */
1158     pos_T	b_visual_start;	/* start pos of last VIsual */
1159     pos_T	b_visual_end;	/* end position of last VIsual */
1160     int		b_visual_mode;	/* VIsual_mode of last VIsual */
1161 # ifdef FEAT_EVAL
1162     int		b_visual_mode_eval;  /* b_visual_mode for visualmode() */
1163 # endif
1164     colnr_T	b_visual_curswant;   /* MAXCOL from w_curswant */
1165 #endif
1166 
1167     pos_T	b_last_cursor;	/* cursor position when last unloading this
1168 				   buffer */
1169     pos_T	b_last_insert;	/* where Insert mode was left */
1170     pos_T	b_last_change;	/* position of last change: '. mark */
1171 
1172 #ifdef FEAT_JUMPLIST
1173     /*
1174      * the changelist contains old change positions
1175      */
1176     pos_T	b_changelist[JUMPLISTSIZE];
1177     int		b_changelistlen;	/* number of active entries */
1178     int		b_new_change;		/* set by u_savecommon() */
1179 #endif
1180 
1181     /*
1182      * Character table, only used in charset.c for 'iskeyword'
1183      * 32 bytes of 8 bits: 1 bit per character 0-255.
1184      */
1185     char_u	b_chartab[32];
1186 
1187 #ifdef FEAT_LOCALMAP
1188     /* Table used for mappings local to a buffer. */
1189     mapblock_T	*(b_maphash[256]);
1190 
1191     /* First abbreviation local to a buffer. */
1192     mapblock_T	*b_first_abbr;
1193 #endif
1194 #ifdef FEAT_USR_CMDS
1195     /* User commands local to the buffer. */
1196     garray_T	b_ucmds;
1197 #endif
1198     /*
1199      * start and end of an operator, also used for '[ and ']
1200      */
1201     pos_T	b_op_start;
1202     pos_T	b_op_end;
1203 
1204 #ifdef FEAT_VIMINFO
1205     int		b_marks_read;	/* Have we read viminfo marks yet? */
1206 #endif
1207 
1208     /*
1209      * The following only used in undo.c.
1210      */
1211     u_header_T	*b_u_oldhead;	/* pointer to oldest header */
1212     u_header_T	*b_u_newhead;	/* pointer to newest header */
1213     u_header_T	*b_u_curhead;	/* pointer to current header */
1214     int		b_u_numhead;	/* current number of headers */
1215     int		b_u_synced;	/* entry lists are synced */
1216 
1217     /*
1218      * variables for "U" command in undo.c
1219      */
1220     char_u	*b_u_line_ptr;	/* saved line for "U" command */
1221     linenr_T	b_u_line_lnum;	/* line number of line in u_line */
1222     colnr_T	b_u_line_colnr;	/* optional column number */
1223 
1224     /*
1225      * The following only used in undo.c
1226      */
1227     mblock_T	b_block_head;	/* head of allocated memory block list */
1228     minfo_T	*b_m_search;	/* pointer to chunk before previously
1229 				   allocated/freed chunk */
1230     mblock_T	*b_mb_current;	/* block where m_search points in */
1231 
1232 #ifdef FEAT_INS_EXPAND
1233     int		b_scanned;	/* ^N/^P have scanned this buffer */
1234 #endif
1235 
1236     /* flags for use of ":lmap" and IM control */
1237     long	b_p_iminsert;	/* input mode for insert */
1238     long	b_p_imsearch;	/* input mode for search */
1239 #define B_IMODE_USE_INSERT -1	/*	Use b_p_iminsert value for search */
1240 #define B_IMODE_NONE 0		/*	Input via none */
1241 #define B_IMODE_LMAP 1		/*	Input via langmap */
1242 #ifndef USE_IM_CONTROL
1243 # define B_IMODE_LAST 1
1244 #else
1245 # define B_IMODE_IM 2		/*	Input via input method */
1246 # define B_IMODE_LAST 2
1247 #endif
1248 
1249 #ifdef FEAT_KEYMAP
1250     short	b_kmap_state;	/* using "lmap" mappings */
1251 # define KEYMAP_INIT	1	/* 'keymap' was set, call keymap_init() */
1252 # define KEYMAP_LOADED	2	/* 'keymap' mappings have been loaded */
1253     garray_T	b_kmap_ga;	/* the keymap table */
1254 #endif
1255 
1256     /*
1257      * Options local to a buffer.
1258      * They are here because their value depends on the type of file
1259      * or contents of the file being edited.
1260      */
1261     int		b_p_initialized;	/* set when options initialized */
1262 
1263     int		b_p_ai;		/* 'autoindent' */
1264     int		b_p_ai_nopaste;	/* b_p_ai saved for paste mode */
1265     int		b_p_ci;		/* 'copyindent' */
1266     int		b_p_bin;	/* 'binary' */
1267 #ifdef FEAT_MBYTE
1268     int		b_p_bomb;	/* 'bomb' */
1269 #endif
1270 #if defined(FEAT_QUICKFIX)
1271     char_u	*b_p_bh;	/* 'bufhidden' */
1272     char_u	*b_p_bt;	/* 'buftype' */
1273 #endif
1274     int		b_p_bl;		/* 'buflisted' */
1275 #ifdef FEAT_CINDENT
1276     int		b_p_cin;	/* 'cindent' */
1277     char_u	*b_p_cino;	/* 'cinoptions' */
1278     char_u	*b_p_cink;	/* 'cinkeys' */
1279 #endif
1280 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
1281     char_u	*b_p_cinw;	/* 'cinwords' */
1282 #endif
1283 #ifdef FEAT_COMMENTS
1284     char_u	*b_p_com;	/* 'comments' */
1285 #endif
1286 #ifdef FEAT_FOLDING
1287     char_u	*b_p_cms;	/* 'commentstring' */
1288 #endif
1289 #ifdef FEAT_INS_EXPAND
1290     char_u	*b_p_cpt;	/* 'complete' */
1291 #endif
1292 #ifdef FEAT_COMPL_FUNC
1293     char_u	*b_p_cfu;	/* 'completefunc' */
1294     char_u	*b_p_ofu;	/* 'omnifunc' */
1295 #endif
1296     int		b_p_eol;	/* 'endofline' */
1297     int		b_p_et;		/* 'expandtab' */
1298     int		b_p_et_nobin;	/* b_p_et saved for binary mode */
1299 #ifdef FEAT_MBYTE
1300     char_u	*b_p_fenc;	/* 'fileencoding' */
1301 #endif
1302     char_u	*b_p_ff;	/* 'fileformat' */
1303 #ifdef FEAT_AUTOCMD
1304     char_u	*b_p_ft;	/* 'filetype' */
1305 #endif
1306     char_u	*b_p_fo;	/* 'formatoptions' */
1307     char_u	*b_p_flp;	/* 'formatlistpat' */
1308     int		b_p_inf;	/* 'infercase' */
1309     char_u	*b_p_isk;	/* 'iskeyword' */
1310 #ifdef FEAT_FIND_ID
1311     char_u	*b_p_def;	/* 'define' local value */
1312     char_u	*b_p_inc;	/* 'include' */
1313 # ifdef FEAT_EVAL
1314     char_u	*b_p_inex;	/* 'includeexpr' */
1315 # endif
1316 #endif
1317 #if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
1318     char_u	*b_p_inde;	/* 'indentexpr' */
1319     char_u	*b_p_indk;	/* 'indentkeys' */
1320 #endif
1321 #ifdef FEAT_CRYPT
1322     char_u	*b_p_key;	/* 'key' */
1323 #endif
1324     char_u	*b_p_kp;	/* 'keywordprg' */
1325 #ifdef FEAT_LISP
1326     int		b_p_lisp;	/* 'lisp' */
1327 #endif
1328     char_u	*b_p_mps;	/* 'matchpairs' */
1329     int		b_p_ml;		/* 'modeline' */
1330     int		b_p_ml_nobin;	/* b_p_ml saved for binary mode */
1331     int		b_p_ma;		/* 'modifiable' */
1332     char_u	*b_p_nf;	/* 'nrformats' */
1333 #ifdef FEAT_OSFILETYPE
1334     char_u	*b_p_oft;	/* 'osfiletype' */
1335 #endif
1336     int		b_p_pi;		/* 'preserveindent' */
1337 #ifdef FEAT_TEXTOBJ
1338     char_u	*b_p_qe;	/* 'quoteescape' */
1339 #endif
1340     int		b_p_ro;		/* 'readonly' */
1341     long	b_p_sw;		/* 'shiftwidth' */
1342 #ifndef SHORT_FNAME
1343     int		b_p_sn;		/* 'shortname' */
1344 #endif
1345 #ifdef FEAT_SMARTINDENT
1346     int		b_p_si;		/* 'smartindent' */
1347 #endif
1348     long	b_p_sts;	/* 'softtabstop' */
1349     long	b_p_sts_nopaste; /* b_p_sts saved for paste mode */
1350 #ifdef FEAT_SEARCHPATH
1351     char_u	*b_p_sua;	/* 'suffixesadd' */
1352 #endif
1353     int		b_p_swf;	/* 'swapfile' */
1354 #ifdef FEAT_SYN_HL
1355     long	b_p_smc;	/* 'synmaxcol' */
1356     char_u	*b_p_syn;	/* 'syntax' */
1357     char_u	*b_p_spc;	/* 'spellcapcheck' */
1358     regprog_T	*b_cap_prog;	/* program for 'spellcapcheck' */
1359     char_u	*b_p_spf;	/* 'spellfile' */
1360     char_u	*b_p_spl;	/* 'spelllang' */
1361 #endif
1362     long	b_p_ts;		/* 'tabstop' */
1363     int		b_p_tx;		/* 'textmode' */
1364     long	b_p_tw;		/* 'textwidth' */
1365     long	b_p_tw_nobin;	/* b_p_tw saved for binary mode */
1366     long	b_p_tw_nopaste;	/* b_p_tw saved for paste mode */
1367     long	b_p_wm;		/* 'wrapmargin' */
1368     long	b_p_wm_nobin;	/* b_p_wm saved for binary mode */
1369     long	b_p_wm_nopaste;	/* b_p_wm saved for paste mode */
1370 #ifdef FEAT_KEYMAP
1371     char_u	*b_p_keymap;	/* 'keymap' */
1372 #endif
1373 
1374     /* local values for options which are normally global */
1375 #ifdef FEAT_QUICKFIX
1376     char_u	*b_p_gp;	/* 'grepprg' local value */
1377     char_u	*b_p_mp;	/* 'makeprg' local value */
1378     char_u	*b_p_efm;	/* 'errorformat' local value */
1379 #endif
1380     char_u	*b_p_ep;	/* 'equalprg' local value */
1381     char_u	*b_p_path;	/* 'path' local value */
1382     int		b_p_ar;		/* 'autoread' local value */
1383     char_u	*b_p_tags;	/* 'tags' local value */
1384 #ifdef FEAT_INS_EXPAND
1385     char_u	*b_p_dict;	/* 'dictionary' local value */
1386     char_u	*b_p_tsr;	/* 'thesaurus' local value */
1387 #endif
1388 
1389     /* end of buffer options */
1390 
1391     int		b_start_eol;	/* last line had eol when it was read */
1392     int		b_start_ffc;	/* first char of 'ff' when edit started */
1393 #ifdef FEAT_MBYTE
1394     char_u	*b_start_fenc;	/* 'fileencoding' when edit started or NULL */
1395     int		b_bad_char;	/* "++bad=" argument when edit started or 0 */
1396 #endif
1397 
1398 #ifdef FEAT_EVAL
1399     dictitem_T	b_bufvar;	/* variable for "b:" Dictionary */
1400     dict_T	b_vars;		/* internal variables, local to buffer */
1401 #endif
1402 
1403     /* When a buffer is created, it starts without a swap file.  b_may_swap is
1404      * then set to indicate that a swap file may be opened later.  It is reset
1405      * if a swap file could not be opened.
1406      */
1407     int		b_may_swap;
1408     int		b_did_warn;	/* Set to 1 if user has been warned on first
1409 				   change of a read-only file */
1410     int		b_help;		/* buffer for help file (when set b_p_bt is
1411 				   "help") */
1412 
1413 #ifndef SHORT_FNAME
1414     int		b_shortname;	/* this file has an 8.3 file name */
1415 #endif
1416 
1417 #ifdef FEAT_MZSCHEME
1418     void	*b_mzscheme_ref; /* The MzScheme reference to this buffer */
1419 #endif
1420 
1421 #ifdef FEAT_PERL
1422     void	*b_perl_private;
1423 #endif
1424 
1425 #ifdef FEAT_PYTHON
1426     void	*b_python_ref;	/* The Python reference to this buffer */
1427 #endif
1428 
1429 #ifdef FEAT_TCL
1430     void	*b_tcl_ref;
1431 #endif
1432 
1433 #ifdef FEAT_RUBY
1434     void	*b_ruby_ref;
1435 #endif
1436 
1437 #ifdef FEAT_SYN_HL
1438     hashtab_T	b_keywtab;		/* syntax keywords hash table */
1439     hashtab_T	b_keywtab_ic;		/* idem, ignore case */
1440     int		b_syn_error;		/* TRUE when error occured in HL */
1441     int		b_syn_ic;		/* ignore case for :syn cmds */
1442     int		b_syn_spell;		/* SYNSPL_ values */
1443     garray_T	b_syn_patterns;		/* table for syntax patterns */
1444     garray_T	b_syn_clusters;		/* table for syntax clusters */
1445     int		b_spell_cluster_id;	/* @Spell cluster ID or 0 */
1446     int		b_nospell_cluster_id;	/* @NoSpell cluster ID or 0 */
1447     int		b_syn_containedin;	/* TRUE when there is an item with a
1448 					   "containedin" argument */
1449     int		b_syn_sync_flags;	/* flags about how to sync */
1450     short	b_syn_sync_id;		/* group to sync on */
1451     long	b_syn_sync_minlines;	/* minimal sync lines offset */
1452     long	b_syn_sync_maxlines;	/* maximal sync lines offset */
1453     long	b_syn_sync_linebreaks;	/* offset for multi-line pattern */
1454     char_u	*b_syn_linecont_pat;	/* line continuation pattern */
1455     regprog_T	*b_syn_linecont_prog;	/* line continuation program */
1456     int		b_syn_linecont_ic;	/* ignore-case flag for above */
1457     int		b_syn_topgrp;		/* for ":syntax include" */
1458 # ifdef FEAT_FOLDING
1459     int		b_syn_folditems;	/* number of patterns with the HL_FOLD
1460 					   flag set */
1461 # endif
1462 /*
1463  * b_sst_array[] contains the state stack for a number of lines, for the start
1464  * of that line (col == 0).  This avoids having to recompute the syntax state
1465  * too often.
1466  * b_sst_array[] is allocated to hold the state for all displayed lines, and
1467  * states for 1 out of about 20 other lines.
1468  * b_sst_array		pointer to an array of synstate_T
1469  * b_sst_len		number of entries in b_sst_array[]
1470  * b_sst_first		pointer to first used entry in b_sst_array[] or NULL
1471  * b_sst_firstfree	pointer to first free entry in b_sst_array[] or NULL
1472  * b_sst_freecount	number of free entries in b_sst_array[]
1473  * b_sst_check_lnum	entries after this lnum need to be checked for
1474  *			validity (MAXLNUM means no check needed)
1475  */
1476     synstate_T	*b_sst_array;
1477     int		b_sst_len;
1478     synstate_T	*b_sst_first;
1479     synstate_T	*b_sst_firstfree;
1480     int		b_sst_freecount;
1481     linenr_T	b_sst_check_lnum;
1482     short_u	b_sst_lasttick;	/* last display tick */
1483 
1484     /* for spell checking */
1485     garray_T	b_langp;	/* list of pointers to slang_T, see spell.c */
1486     char_u	b_spell_ismw[256];/* flags: is midword char */
1487 # ifdef FEAT_MBYTE
1488     char_u	*b_spell_ismw_mb; /* multi-byte midword chars */
1489 # endif
1490 #endif /* FEAT_SYN_HL */
1491 
1492 #ifdef FEAT_SIGNS
1493     signlist_T	*b_signlist;	/* list of signs to draw */
1494 #endif
1495 
1496 #ifdef FEAT_NETBEANS_INTG
1497     int		b_netbeans_file;    /* TRUE when buffer is owned by NetBeans */
1498     int		b_was_netbeans_file;/* TRUE if b_netbeans_file was once set */
1499 #endif
1500 
1501 };
1502 
1503 /*
1504  * Structure to cache info for displayed lines in w_lines[].
1505  * Each logical line has one entry.
1506  * The entry tells how the logical line is currently displayed in the window.
1507  * This is updated when displaying the window.
1508  * When the display is changed (e.g., when clearing the screen) w_lines_valid
1509  * is changed to exclude invalid entries.
1510  * When making changes to the buffer, wl_valid is reset to indicate wl_size
1511  * may not reflect what is actually in the buffer.  When wl_valid is FALSE,
1512  * the entries can only be used to count the number of displayed lines used.
1513  * wl_lnum and wl_lastlnum are invalid too.
1514  */
1515 typedef struct w_line
1516 {
1517     linenr_T	wl_lnum;	/* buffer line number for logical line */
1518     short_u	wl_size;	/* height in screen lines */
1519     char	wl_valid;	/* TRUE values are valid for text in buffer */
1520 #ifdef FEAT_FOLDING
1521     char	wl_folded;	/* TRUE when this is a range of folded lines */
1522     linenr_T	wl_lastlnum;	/* last buffer line number for logical line */
1523 #endif
1524 } wline_T;
1525 
1526 /*
1527  * Windows are kept in a tree of frames.  Each frame has a column (FR_COL)
1528  * or row (FR_ROW) layout or is a leaf, which has a window.
1529  */
1530 struct frame
1531 {
1532     char	fr_layout;	/* FR_LEAF, FR_COL or FR_ROW */
1533 #ifdef FEAT_VERTSPLIT
1534     int		fr_width;
1535 #endif
1536     int		fr_height;
1537     int		fr_newheight;	/* new height used in win_equal_rec() */
1538     frame_T	*fr_parent;	/* containing frame or NULL */
1539     frame_T	*fr_next;	/* frame right or below in same parent, NULL
1540 				   for first */
1541     frame_T	*fr_prev;	/* frame left or above in same parent, NULL
1542 				   for last */
1543     /* fr_child and fr_win are mutually exclusive */
1544     frame_T	*fr_child;	/* first contained frame */
1545     win_T	*fr_win;	/* window that fills this frame */
1546 };
1547 
1548 #define FR_LEAF	0	/* frame is a leaf */
1549 #define FR_ROW	1	/* frame with a row of windows */
1550 #define FR_COL	2	/* frame with a column of windows */
1551 
1552 /*
1553  * Structure which contains all information that belongs to a window
1554  *
1555  * All row numbers are relative to the start of the window, except w_winrow.
1556  */
1557 struct window
1558 {
1559     buf_T	*w_buffer;	    /* buffer we are a window into (used
1560 				       often, keep it the first item!) */
1561 
1562 #ifdef FEAT_WINDOWS
1563     win_T	*w_prev;	    /* link to previous window */
1564     win_T	*w_next;	    /* link to next window */
1565 #endif
1566 
1567     frame_T	*w_frame;	    /* frame containing this window */
1568 
1569     pos_T	w_cursor;	    /* cursor position in buffer */
1570 
1571     colnr_T	w_curswant;	    /* The column we'd like to be at.  This is
1572 				       used to try to stay in the same column
1573 				       for up/down cursor motions. */
1574 
1575     int		w_set_curswant;	    /* If set, then update w_curswant the next
1576 				       time through cursupdate() to the
1577 				       current virtual column */
1578 
1579 #ifdef FEAT_VISUAL
1580     /*
1581      * the next six are used to update the visual part
1582      */
1583     char	w_old_visual_mode;  /* last known VIsual_mode */
1584     linenr_T	w_old_cursor_lnum;  /* last known end of visual part */
1585     colnr_T	w_old_cursor_fcol;  /* first column for block visual part */
1586     colnr_T	w_old_cursor_lcol;  /* last column for block visual part */
1587     linenr_T	w_old_visual_lnum;  /* last known start of visual part */
1588     colnr_T	w_old_visual_col;   /* last known start of visual part */
1589     colnr_T	w_old_curswant;	    /* last known value of Curswant */
1590 #endif
1591 
1592     /*
1593      * The next three specify the offsets for displaying the buffer:
1594      */
1595     linenr_T	w_topline;	    /* buffer line number of the line at the
1596 				       top of the window */
1597 #ifdef FEAT_DIFF
1598     int		w_topfill;	    /* number of filler lines above w_topline */
1599     int		w_old_topfill;	    /* w_topfill at last redraw */
1600     int		w_botfill;	    /* TRUE when filler lines are actually
1601 				       below w_topline (at end of file) */
1602     int		w_old_botfill;	    /* w_botfill at last redraw */
1603 #endif
1604     colnr_T	w_leftcol;	    /* window column number of the left most
1605 				       character in the window; used when
1606 				       'wrap' is off */
1607     colnr_T	w_skipcol;	    /* starting column when a single line
1608 				       doesn't fit in the window */
1609 
1610     /*
1611      * Layout of the window in the screen.
1612      * May need to add "msg_scrolled" to "w_winrow" in rare situations.
1613      */
1614 #ifdef FEAT_WINDOWS
1615     int		w_winrow;	    /* first row of window in screen */
1616 #endif
1617     int		w_height;	    /* number of rows in window, excluding
1618 				       status/command line(s) */
1619 #ifdef FEAT_WINDOWS
1620     int		w_status_height;    /* number of status lines (0 or 1) */
1621 #endif
1622 #ifdef FEAT_VERTSPLIT
1623     int		w_wincol;	    /* Leftmost column of window in screen.
1624 				       use W_WINCOL() */
1625     int		w_width;	    /* Width of window, excluding separation.
1626 				       use W_WIDTH() */
1627     int		w_vsep_width;	    /* Number of separator columns (0 or 1).
1628 				       use W_VSEP_WIDTH() */
1629 #endif
1630 
1631     /*
1632      * === start of cached values ====
1633      */
1634     /*
1635      * Recomputing is minimized by storing the result of computations.
1636      * Use functions in screen.c to check if they are valid and to update.
1637      * w_valid is a bitfield of flags, which indicate if specific values are
1638      * valid or need to be recomputed.	See screen.c for values.
1639      */
1640     int		w_valid;
1641     pos_T	w_valid_cursor;	    /* last known position of w_cursor, used
1642 				       to adjust w_valid */
1643     colnr_T	w_valid_leftcol;    /* last known w_leftcol */
1644 
1645     /*
1646      * w_cline_height is the number of physical lines taken by the buffer line
1647      * that the cursor is on.  We use this to avoid extra calls to plines().
1648      */
1649     int		w_cline_height;	    /* current size of cursor line */
1650 #ifdef FEAT_FOLDING
1651     int		w_cline_folded;	    /* cursor line is folded */
1652 #endif
1653 
1654     int		w_cline_row;	    /* starting row of the cursor line */
1655 
1656     colnr_T	w_virtcol;	    /* column number of the cursor in the
1657 				       buffer line, as opposed to the column
1658 				       number we're at on the screen.  This
1659 				       makes a difference on lines which span
1660 				       more than one screen line or when
1661 				       w_leftcol is non-zero */
1662 
1663     /*
1664      * w_wrow and w_wcol specify the cursor position in the window.
1665      * This is related to positions in the window, not in the display or
1666      * buffer, thus w_wrow is relative to w_winrow.
1667      */
1668     int		w_wrow, w_wcol;	    /* cursor position in window */
1669 
1670     linenr_T	w_botline;	    /* number of the line below the bottom of
1671 				       the screen */
1672     int		w_empty_rows;	    /* number of ~ rows in window */
1673 #ifdef FEAT_DIFF
1674     int		w_filler_rows;	    /* number of filler rows at the end of the
1675 				       window */
1676 #endif
1677 
1678     /*
1679      * Info about the lines currently in the window is remembered to avoid
1680      * recomputing it every time.  The allocated size of w_lines[] is Rows.
1681      * Only the w_lines_valid entries are actually valid.
1682      * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
1683      * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
1684      * Between changing text and updating the display w_lines[] represents
1685      * what is currently displayed.  wl_valid is reset to indicated this.
1686      * This is used for efficient redrawing.
1687      */
1688     int		w_lines_valid;	    /* number of valid entries */
1689     wline_T	*w_lines;
1690 
1691 #ifdef FEAT_FOLDING
1692     garray_T	w_folds;	    /* array of nested folds */
1693     char	w_fold_manual;	    /* when TRUE: some folds are opened/closed
1694 				       manually */
1695     char	w_foldinvalid;	    /* when TRUE: folding needs to be
1696 				       recomputed */
1697 #endif
1698 #ifdef FEAT_LINEBREAK
1699     int		w_nrwidth;	    /* width of 'number' column being used */
1700 #endif
1701 
1702     /*
1703      * === end of cached values ===
1704      */
1705 
1706     int		w_redr_type;	    /* type of redraw to be performed on win */
1707     int		w_upd_rows;	    /* number of window lines to update when
1708 				       w_redr_type is REDRAW_TOP */
1709     linenr_T	w_redraw_top;	    /* when != 0: first line needing redraw */
1710     linenr_T	w_redraw_bot;	    /* when != 0: last line needing redraw */
1711 #ifdef FEAT_WINDOWS
1712     int		w_redr_status;	    /* if TRUE status line must be redrawn */
1713 #endif
1714 
1715 #ifdef FEAT_CMDL_INFO
1716     /* remember what is shown in the ruler for this window (if 'ruler' set) */
1717     pos_T	w_ru_cursor;	    /* cursor position shown in ruler */
1718     colnr_T	w_ru_virtcol;	    /* virtcol shown in ruler */
1719     linenr_T	w_ru_topline;	    /* topline shown in ruler */
1720     linenr_T	w_ru_line_count;    /* line count used for ruler */
1721 # ifdef FEAT_DIFF
1722     int		w_ru_topfill;	    /* topfill shown in ruler */
1723 # endif
1724     char	w_ru_empty;	    /* TRUE if ruler shows 0-1 (empty line) */
1725 #endif
1726 
1727     int		w_alt_fnum;	    /* alternate file (for # and CTRL-^) */
1728 
1729 #ifdef FEAT_WINDOWS
1730     alist_T	*w_alist;	    /* pointer to arglist for this window */
1731 #endif
1732     int		w_arg_idx;	    /* current index in argument list (can be
1733 				       out of range!) */
1734     int		w_arg_idx_invalid;  /* editing another file than w_arg_idx */
1735 
1736     char_u	*w_localdir;	    /* absolute path of local directory or
1737 				       NULL */
1738     /*
1739      * Options local to a window.
1740      * They are local because they influence the layout of the window or
1741      * depend on the window layout.
1742      * There are two values: w_onebuf_opt is local to the buffer currently in
1743      * this window, w_allbuf_opt is for all buffers in this window.
1744      */
1745     winopt_T	w_onebuf_opt;
1746     winopt_T	w_allbuf_opt;
1747 
1748     /* transform a pointer to a "onebuf" option into a "allbuf" option */
1749 #define GLOBAL_WO(p)	((char *)p + sizeof(winopt_T))
1750 
1751 #ifdef FEAT_SCROLLBIND
1752     long	w_scbind_pos;
1753 #endif
1754 
1755 #ifdef FEAT_EVAL
1756     dictitem_T	w_winvar;	/* variable for "w:" Dictionary */
1757     dict_T	w_vars;		/* internal variables, local to window */
1758 #endif
1759 
1760 #if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
1761     int		w_farsi;	/* for the window dependent Farsi functions */
1762 #endif
1763 
1764     /*
1765      * The w_prev_pcmark field is used to check whether we really did jump to
1766      * a new line after setting the w_pcmark.  If not, then we revert to
1767      * using the previous w_pcmark.
1768      */
1769     pos_T	w_pcmark;	/* previous context mark */
1770     pos_T	w_prev_pcmark;	/* previous w_pcmark */
1771 
1772 #ifdef FEAT_JUMPLIST
1773     /*
1774      * the jumplist contains old cursor positions
1775      */
1776     xfmark_T	w_jumplist[JUMPLISTSIZE];
1777     int		w_jumplistlen;		/* number of active entries */
1778     int		w_jumplistidx;		/* current position */
1779 
1780     int		w_changelistidx;	/* current position in b_changelist */
1781 #endif
1782 
1783 #ifdef FEAT_SEARCH_EXTRA
1784     regmmatch_T	w_match;	/* regexp program for ":match" */
1785     int		w_match_id;	/* highlight ID for ":match" */
1786 #endif
1787 
1788     /*
1789      * the tagstack grows from 0 upwards:
1790      * entry 0: older
1791      * entry 1: newer
1792      * entry 2: newest
1793      */
1794     taggy_T	w_tagstack[TAGSTACKSIZE];	/* the tag stack */
1795     int		w_tagstackidx;		/* idx just below activ entry */
1796     int		w_tagstacklen;		/* number of tags on stack */
1797 
1798     /*
1799      * w_fraction is the fractional row of the cursor within the window, from
1800      * 0 at the top row to FRACTION_MULT at the last row.
1801      * w_prev_fraction_row was the actual cursor row when w_fraction was last
1802      * calculated.
1803      */
1804     int		w_fraction;
1805     int		w_prev_fraction_row;
1806 
1807 #ifdef FEAT_GUI
1808     scrollbar_T	w_scrollbars[2];	/* vert. Scrollbars for this window */
1809 #endif
1810 #ifdef FEAT_LINEBREAK
1811     linenr_T	w_nrwidth_line_count;	/* line count when ml_nrwidth_width
1812 					 * was computed. */
1813     int		w_nrwidth_width;	/* nr of chars to print line count. */
1814 #endif
1815 
1816 
1817 #ifdef FEAT_MZSCHEME
1818     void	*w_mzscheme_ref;	/* The MzScheme value for this window */
1819 #endif
1820 
1821 #ifdef FEAT_PERL
1822     void	*w_perl_private;
1823 #endif
1824 
1825 #ifdef FEAT_PYTHON
1826     void	*w_python_ref;		/* The Python value for this window */
1827 #endif
1828 
1829 #ifdef FEAT_TCL
1830     void	*w_tcl_ref;
1831 #endif
1832 
1833 #ifdef FEAT_RUBY
1834     void	*w_ruby_ref;
1835 #endif
1836 };
1837 
1838 /*
1839  * Arguments for operators.
1840  */
1841 typedef struct oparg_S
1842 {
1843     int		op_type;	/* current pending operator type */
1844     int		regname;	/* register to use for the operator */
1845     int		motion_type;	/* type of the current cursor motion */
1846     int		motion_force;	/* force motion type: 'v', 'V' or CTRL-V */
1847     int		use_reg_one;	/* TRUE if delete uses reg 1 even when not
1848 				   linewise */
1849     int		inclusive;	/* TRUE if char motion is inclusive (only
1850 				   valid when motion_type is MCHAR */
1851     int		end_adjusted;	/* backuped b_op_end one char (only used by
1852 				   do_format()) */
1853     pos_T	start;		/* start of the operator */
1854     pos_T	end;		/* end of the operator */
1855     pos_T	cursor_start;	/* cursor position before motion for "gw" */
1856 
1857     long	line_count;	/* number of lines from op_start to op_end
1858 				   (inclusive) */
1859     int		empty;		/* op_start and op_end the same (only used by
1860 				   do_change()) */
1861 #ifdef FEAT_VISUAL
1862     int		is_VIsual;	/* operator on Visual area */
1863     int		block_mode;	/* current operator is Visual block mode */
1864 #endif
1865     colnr_T	start_vcol;	/* start col for block mode operator */
1866     colnr_T	end_vcol;	/* end col for block mode operator */
1867 } oparg_T;
1868 
1869 /*
1870  * Arguments for Normal mode commands.
1871  */
1872 typedef struct cmdarg_S
1873 {
1874     oparg_T	*oap;		/* Operator arguments */
1875     int		prechar;	/* prefix character (optional, always 'g') */
1876     int		cmdchar;	/* command character */
1877     int		nchar;		/* next command character (optional) */
1878 #ifdef FEAT_MBYTE
1879     int		ncharC1;	/* first composing character (optional) */
1880     int		ncharC2;	/* second composing character (optional) */
1881 #endif
1882     int		extra_char;	/* yet another character (optional) */
1883     long	opcount;	/* count before an operator */
1884     long	count0;		/* count before command, default 0 */
1885     long	count1;		/* count before command, default 1 */
1886     int		arg;		/* extra argument from nv_cmds[] */
1887     int		retval;		/* return: CA_* values */
1888     char_u	*searchbuf;	/* return: pointer to search pattern or NULL */
1889 } cmdarg_T;
1890 
1891 /* values for retval: */
1892 #define CA_COMMAND_BUSY	    1	/* skip restarting edit() once */
1893 #define CA_NO_ADJ_OP_END    2	/* don't adjust operator end */
1894 
1895 #ifdef CURSOR_SHAPE
1896 /*
1897  * struct to store values from 'guicursor' and 'mouseshape'
1898  */
1899 /* Indexes in shape_table[] */
1900 #define SHAPE_IDX_N	0	/* Normal mode */
1901 #define SHAPE_IDX_V	1	/* Visual mode */
1902 #define SHAPE_IDX_I	2	/* Insert mode */
1903 #define SHAPE_IDX_R	3	/* Replace mode */
1904 #define SHAPE_IDX_C	4	/* Command line Normal mode */
1905 #define SHAPE_IDX_CI	5	/* Command line Insert mode */
1906 #define SHAPE_IDX_CR	6	/* Command line Replace mode */
1907 #define SHAPE_IDX_O	7	/* Operator-pending mode */
1908 #define SHAPE_IDX_VE	8	/* Visual mode with 'seleciton' exclusive */
1909 #define SHAPE_IDX_CLINE	9	/* On command line */
1910 #define SHAPE_IDX_STATUS 10	/* A status line */
1911 #define SHAPE_IDX_SDRAG 11	/* dragging a status line */
1912 #define SHAPE_IDX_VSEP	12	/* A vertical separator line */
1913 #define SHAPE_IDX_VDRAG 13	/* dragging a vertical separator line */
1914 #define SHAPE_IDX_MORE	14	/* Hit-return or More */
1915 #define SHAPE_IDX_MOREL	15	/* Hit-return or More in last line */
1916 #define SHAPE_IDX_SM	16	/* showing matching paren */
1917 #define SHAPE_IDX_COUNT	17
1918 
1919 #define SHAPE_BLOCK	0	/* block cursor */
1920 #define SHAPE_HOR	1	/* horizontal bar cursor */
1921 #define SHAPE_VER	2	/* vertical bar cursor */
1922 
1923 #define MSHAPE_NUMBERED	1000	/* offset for shapes identified by number */
1924 #define MSHAPE_HIDE	1	/* hide mouse pointer */
1925 
1926 #define SHAPE_MOUSE	1	/* used for mouse pointer shape */
1927 #define SHAPE_CURSOR	2	/* used for text cursor shape */
1928 
1929 typedef struct cursor_entry
1930 {
1931     int		shape;		/* one of the SHAPE_ defines */
1932     int		mshape;		/* one of the MSHAPE defines */
1933     int		percentage;	/* percentage of cell for bar */
1934     long	blinkwait;	/* blinking, wait time before blinking starts */
1935     long	blinkon;	/* blinking, on time */
1936     long	blinkoff;	/* blinking, off time */
1937     int		id;		/* highlight group ID */
1938     int		id_lm;		/* highlight group ID for :lmap mode */
1939     char	*name;		/* mode name (fixed) */
1940     char	used_for;	/* SHAPE_MOUSE and/or SHAPE_CURSOR */
1941 } cursorentry_T;
1942 #endif /* CURSOR_SHAPE */
1943 
1944 #ifdef FEAT_MENU
1945 
1946 /* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
1947 #define MENU_INDEX_INVALID	-1
1948 #define MENU_INDEX_NORMAL	0
1949 #define MENU_INDEX_VISUAL	1
1950 #define MENU_INDEX_OP_PENDING	2
1951 #define MENU_INDEX_INSERT	3
1952 #define MENU_INDEX_CMDLINE	4
1953 #define MENU_INDEX_TIP		5
1954 #define MENU_MODES		6
1955 
1956 /* Menu modes */
1957 #define MENU_NORMAL_MODE	(1 << MENU_INDEX_NORMAL)
1958 #define MENU_VISUAL_MODE	(1 << MENU_INDEX_VISUAL)
1959 #define MENU_OP_PENDING_MODE	(1 << MENU_INDEX_OP_PENDING)
1960 #define MENU_INSERT_MODE	(1 << MENU_INDEX_INSERT)
1961 #define MENU_CMDLINE_MODE	(1 << MENU_INDEX_CMDLINE)
1962 #define MENU_TIP_MODE		(1 << MENU_INDEX_TIP)
1963 #define MENU_ALL_MODES		((1 << MENU_INDEX_TIP) - 1)
1964 /*note MENU_INDEX_TIP is not a 'real' mode*/
1965 
1966 /* Start a menu name with this to not include it on the main menu bar */
1967 #define MNU_HIDDEN_CHAR		']'
1968 
1969 typedef struct VimMenu vimmenu_T;
1970 
1971 struct VimMenu
1972 {
1973     int		modes;		    /* Which modes is this menu visible for? */
1974     int		enabled;	    /* for which modes the menu is enabled */
1975     char_u	*name;		    /* Name of menu */
1976     char_u	*dname;		    /* Displayed Name (without '&') */
1977     int		mnemonic;	    /* mnemonic key (after '&') */
1978     char_u	*actext;	    /* accelerator text (after TAB) */
1979     int		priority;	    /* Menu order priority */
1980 #ifdef FEAT_GUI
1981     void	(*cb) __ARGS((vimmenu_T *));	    /* Call-back routine */
1982 #endif
1983 #ifdef FEAT_TOOLBAR
1984     char_u	*iconfile;	    /* name of file for icon or NULL */
1985     int		iconidx;	    /* icon index (-1 if not set) */
1986     int		icon_builtin;	    /* icon names is BuiltIn{nr} */
1987 #endif
1988     char_u	*strings[MENU_MODES]; /* Mapped string for each mode */
1989     int		noremap[MENU_MODES]; /* A REMAP_ flag for each mode */
1990     char	silent[MENU_MODES]; /* A silent flag for each mode */
1991     vimmenu_T	*children;	    /* Children of sub-menu */
1992     vimmenu_T	*parent;	    /* Parent of menu */
1993     vimmenu_T	*next;		    /* Next item in menu */
1994 #ifdef FEAT_GUI_X11
1995     Widget	id;		    /* Manage this to enable item */
1996     Widget	submenu_id;	    /* If this is submenu, add children here */
1997 #endif
1998 #ifdef FEAT_GUI_GTK
1999     GtkWidget	*id;		    /* Manage this to enable item */
2000     GtkWidget	*submenu_id;	    /* If this is submenu, add children here */
2001     GtkWidget	*tearoff_handle;
2002     GtkWidget   *label;		    /* Used by "set wak=" code. */
2003 #endif
2004 #ifdef FEAT_GUI_MOTIF
2005     int		sensitive;	    /* turn button on/off */
2006     char	**xpm;		    /* pixmap data */
2007     char	*xpm_fname;	    /* file with pixmap data */
2008 #endif
2009 #ifdef FEAT_GUI_ATHENA
2010     Pixmap	image;		    /* Toolbar image */
2011 #endif
2012 #ifdef FEAT_BEVAL_TIP
2013     BalloonEval *tip;		    /* tooltip for this menu item */
2014 #endif
2015 #ifdef FEAT_GUI_W16
2016     UINT	id;		    /* Id of menu item */
2017     HMENU	submenu_id;	    /* If this is submenu, add children here */
2018 #endif
2019 #ifdef FEAT_GUI_W32
2020     UINT	id;		    /* Id of menu item */
2021     HMENU	submenu_id;	    /* If this is submenu, add children here */
2022     HWND	tearoff_handle;	    /* hWnd of tearoff if created */
2023 #endif
2024 #ifdef FEAT_GUI_MAC
2025 /*  MenuHandle	id; */
2026 /*  short	index;	*/	    /* the item index within the father menu */
2027     short	menu_id;	    /* the menu id to which this item belong */
2028     short	submenu_id;	    /* the menu id of the children (could be
2029 				       get throught some tricks) */
2030     MenuHandle	menu_handle;
2031     MenuHandle	submenu_handle;
2032 #endif
2033 #ifdef RISCOS
2034     int		*id;		    /* Not used, but gui.c needs it */
2035     int		greyed_out;	    /* Flag */
2036     int		hidden;
2037 #endif
2038 #ifdef FEAT_GUI_PHOTON
2039     PtWidget_t	*id;
2040     PtWidget_t	*submenu_id;
2041 #endif
2042 };
2043 #else
2044 /* For generating prototypes when FEAT_MENU isn't defined. */
2045 typedef int vimmenu_T;
2046 
2047 #endif /* FEAT_MENU */
2048 
2049 /*
2050  * Struct to save values in before executing autocommands for a buffer that is
2051  * not the current buffer.
2052  */
2053 typedef struct
2054 {
2055     buf_T	*save_buf;	/* saved curbuf */
2056     buf_T	*new_curbuf;	/* buffer to be used */
2057     win_T	*save_curwin;	/* saved curwin, NULL if it didn't change */
2058     win_T	*new_curwin;	/* new curwin if save_curwin != NULL */
2059     pos_T	save_cursor;	/* saved cursor pos of save_curwin */
2060     linenr_T	save_topline;	/* saved topline of save_curwin */
2061 #ifdef FEAT_DIFF
2062     int		save_topfill;	/* saved topfill of save_curwin */
2063 #endif
2064 } aco_save_T;
2065 
2066 /*
2067  * Generic option table item, only used for printer at the moment.
2068  */
2069 typedef struct
2070 {
2071     const char	*name;
2072     int		hasnum;
2073     long	number;
2074     char_u	*string;	/* points into option string */
2075     int		strlen;
2076     int		present;
2077 } option_table_T;
2078 
2079 /*
2080  * Structure to hold printing color and font attributes.
2081  */
2082 typedef struct
2083 {
2084     long_u	fg_color;
2085     long_u	bg_color;
2086     int		bold;
2087     int		italic;
2088     int		underline;
2089     int		undercurl;
2090 } prt_text_attr_T;
2091 
2092 /*
2093  * Structure passed back to the generic printer code.
2094  */
2095 typedef struct
2096 {
2097     int		n_collated_copies;
2098     int		n_uncollated_copies;
2099     int		duplex;
2100     int		chars_per_line;
2101     int		lines_per_page;
2102     int		has_color;
2103     prt_text_attr_T number;
2104 #ifdef FEAT_SYN_HL
2105     int		modec;
2106     int		do_syntax;
2107 #endif
2108     int		user_abort;
2109     char_u	*jobname;
2110 #ifdef FEAT_POSTSCRIPT
2111     char_u	*outfile;
2112     char_u	*arguments;
2113 #endif
2114 } prt_settings_T;
2115 
2116 #define PRINT_NUMBER_WIDTH 8
2117