blob: 2c7f7108d483f6da3d91414f9fe1b2453c51b03e [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001/* 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
18typedef long linenr_T;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000019typedef int colnr_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +000020typedef unsigned short short_u;
21#endif
22
23/*
24 * position in file or buffer
25 */
26typedef 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
Bram Moolenaar0ab2a882009-05-13 10:51:08 +000036# define INIT_POS_T(l, c, ca) {l, c, ca}
Bram Moolenaar071d4272004-06-13 20:20:40 +000037#else
Bram Moolenaar0ab2a882009-05-13 10:51:08 +000038# define INIT_POS_T(l, c, ca) {l, c}
Bram Moolenaar071d4272004-06-13 20:20:40 +000039#endif
40
41/*
42 * Same, but without coladd.
43 */
44typedef 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 */
55typedef struct growarray
56{
57 int ga_len; /* current number of items used */
Bram Moolenaar86b68352004-12-27 21:59:20 +000058 int ga_maxlen; /* maximum number of items possible */
Bram Moolenaared203462004-06-16 11:19:22 +000059 int ga_itemsize; /* sizeof(item) */
Bram Moolenaar071d4272004-06-13 20:20:40 +000060 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
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +000066typedef struct window_S win_T;
67typedef struct wininfo_S wininfo_T;
68typedef struct frame_S frame_T;
69typedef int scid_T; /* script ID */
Bram Moolenaarfbc0d2e2013-05-19 19:40:29 +020070typedef 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"
Bram Moolenaar071d4272004-06-13 20:20:40 +000076
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 int /* avoid error in prototypes */
88#endif
89
90/*
91 * marks: positions in a file
92 * (a normal mark is a lnum/col pair, the same as a file position)
93 */
94
95/* (Note: for EBCDIC there are more than 26, because there are gaps in the
96 * alphabet coding. To minimize changes to the code, I decided to just
97 * increase the number of possible marks. */
98#define NMARKS ('z' - 'a' + 1) /* max. # of named marks */
99#define JUMPLISTSIZE 100 /* max. # of marks in jump list */
100#define TAGSTACKSIZE 20 /* max. # of tags in tag stack */
101
102typedef struct filemark
103{
104 pos_T mark; /* cursor position */
105 int fnum; /* file number */
106} fmark_T;
107
108/* Xtended file mark: also has a file name */
109typedef struct xfilemark
110{
111 fmark_T fmark;
112 char_u *fname; /* file name, used when fnum == 0 */
113} xfmark_T;
114
115/*
116 * The taggy struct is used to store the information about a :tag command.
117 */
118typedef struct taggy
119{
120 char_u *tagname; /* tag name */
121 fmark_T fmark; /* cursor position BEFORE ":tag" */
122 int cur_match; /* match number */
123 int cur_fnum; /* buffer number used for cur_match */
124} taggy_T;
125
126/*
127 * Structure that contains all options that are local to a window.
128 * Used twice in a window: for the current buffer and for all buffers.
129 * Also used in wininfo_T.
130 */
131typedef struct
132{
133#ifdef FEAT_ARABIC
134 int wo_arab;
135# define w_p_arab w_onebuf_opt.wo_arab /* 'arabic' */
136#endif
Bram Moolenaar597a4222014-06-25 14:39:50 +0200137#ifdef FEAT_LINEBREAK
138 int wo_bri;
139# define w_p_bri w_onebuf_opt.wo_bri /* 'breakindent' */
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200140 char_u *wo_briopt;
Bram Moolenaar597a4222014-06-25 14:39:50 +0200141# define w_p_briopt w_onebuf_opt.wo_briopt /* 'breakindentopt' */
142#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143#ifdef FEAT_DIFF
144 int wo_diff;
145# define w_p_diff w_onebuf_opt.wo_diff /* 'diff' */
146#endif
147#ifdef FEAT_FOLDING
148 long wo_fdc;
149# define w_p_fdc w_onebuf_opt.wo_fdc /* 'foldcolumn' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200150 int wo_fdc_save;
151# define w_p_fdc_save w_onebuf_opt.wo_fdc_save /* 'foldenable' saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152 int wo_fen;
153# define w_p_fen w_onebuf_opt.wo_fen /* 'foldenable' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200154 int wo_fen_save;
155# define w_p_fen_save w_onebuf_opt.wo_fen_save /* 'foldenable' saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156 char_u *wo_fdi;
157# define w_p_fdi w_onebuf_opt.wo_fdi /* 'foldignore' */
158 long wo_fdl;
159# define w_p_fdl w_onebuf_opt.wo_fdl /* 'foldlevel' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200160 int wo_fdl_save;
161# define w_p_fdl_save w_onebuf_opt.wo_fdl_save /* 'foldlevel' state saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162 char_u *wo_fdm;
163# define w_p_fdm w_onebuf_opt.wo_fdm /* 'foldmethod' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200164 char_u *wo_fdm_save;
165# define w_p_fdm_save w_onebuf_opt.wo_fdm_save /* 'fdm' saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166 long wo_fml;
167# define w_p_fml w_onebuf_opt.wo_fml /* 'foldminlines' */
168 long wo_fdn;
Bram Moolenaar65c923a2006-03-03 22:56:30 +0000169# define w_p_fdn w_onebuf_opt.wo_fdn /* 'foldnestmax' */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170# ifdef FEAT_EVAL
171 char_u *wo_fde;
172# define w_p_fde w_onebuf_opt.wo_fde /* 'foldexpr' */
173 char_u *wo_fdt;
174# define w_p_fdt w_onebuf_opt.wo_fdt /* 'foldtext' */
175# endif
176 char_u *wo_fmr;
177# define w_p_fmr w_onebuf_opt.wo_fmr /* 'foldmarker' */
178#endif
179#ifdef FEAT_LINEBREAK
180 int wo_lbr;
181# define w_p_lbr w_onebuf_opt.wo_lbr /* 'linebreak' */
182#endif
183 int wo_list;
184#define w_p_list w_onebuf_opt.wo_list /* 'list' */
185 int wo_nu;
186#define w_p_nu w_onebuf_opt.wo_nu /* 'number' */
Bram Moolenaar64486672010-05-16 15:46:46 +0200187 int wo_rnu;
188#define w_p_rnu w_onebuf_opt.wo_rnu /* 'relativenumber' */
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000189#ifdef FEAT_LINEBREAK
190 long wo_nuw;
191# define w_p_nuw w_onebuf_opt.wo_nuw /* 'numberwidth' */
192#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193#if defined(FEAT_WINDOWS)
194 int wo_wfh;
195# define w_p_wfh w_onebuf_opt.wo_wfh /* 'winfixheight' */
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000196 int wo_wfw;
197# define w_p_wfw w_onebuf_opt.wo_wfw /* 'winfixwidth' */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198#endif
199#if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
200 int wo_pvw;
201# define w_p_pvw w_onebuf_opt.wo_pvw /* 'previewwindow' */
202#endif
203#ifdef FEAT_RIGHTLEFT
204 int wo_rl;
205# define w_p_rl w_onebuf_opt.wo_rl /* 'rightleft' */
206 char_u *wo_rlc;
207# define w_p_rlc w_onebuf_opt.wo_rlc /* 'rightleftcmd' */
208#endif
209 long wo_scr;
210#define w_p_scr w_onebuf_opt.wo_scr /* 'scroll' */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000211#ifdef FEAT_SPELL
Bram Moolenaar217ad922005-03-20 22:37:15 +0000212 int wo_spell;
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000213# define w_p_spell w_onebuf_opt.wo_spell /* 'spell' */
214#endif
215#ifdef FEAT_SYN_HL
216 int wo_cuc;
217# define w_p_cuc w_onebuf_opt.wo_cuc /* 'cursorcolumn' */
218 int wo_cul;
219# define w_p_cul w_onebuf_opt.wo_cul /* 'cursorline' */
Bram Moolenaar1a384422010-07-14 19:53:30 +0200220 char_u *wo_cc;
221# define w_p_cc w_onebuf_opt.wo_cc /* 'colorcolumn' */
Bram Moolenaar217ad922005-03-20 22:37:15 +0000222#endif
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000223#ifdef FEAT_STL_OPT
224 char_u *wo_stl;
225#define w_p_stl w_onebuf_opt.wo_stl /* 'statusline' */
226#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227#ifdef FEAT_SCROLLBIND
228 int wo_scb;
229# define w_p_scb w_onebuf_opt.wo_scb /* 'scrollbind' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200230 int wo_diff_saved; /* options were saved for starting diff mode */
231# define w_p_diff_saved w_onebuf_opt.wo_diff_saved
232 int wo_scb_save; /* 'scrollbind' saved for diff mode*/
233# define w_p_scb_save w_onebuf_opt.wo_scb_save
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234#endif
235 int wo_wrap;
236#define w_p_wrap w_onebuf_opt.wo_wrap /* 'wrap' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200237#ifdef FEAT_DIFF
238 int wo_wrap_save; /* 'wrap' state saved for diff mode*/
239# define w_p_wrap_save w_onebuf_opt.wo_wrap_save
240#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +0200241#ifdef FEAT_CONCEAL
Bram Moolenaarf5963f72010-07-23 22:10:27 +0200242 char_u *wo_cocu; /* 'concealcursor' */
243# define w_p_cocu w_onebuf_opt.wo_cocu
244 long wo_cole; /* 'conceallevel' */
245# define w_p_cole w_onebuf_opt.wo_cole
Bram Moolenaar860cae12010-06-05 23:22:07 +0200246#endif
247#ifdef FEAT_CURSORBIND
248 int wo_crb;
249# define w_p_crb w_onebuf_opt.wo_crb /* 'cursorbind' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200250 int wo_crb_save; /* 'cursorbind' state saved for diff mode*/
251# define w_p_crb_save w_onebuf_opt.wo_crb_save
Bram Moolenaar860cae12010-06-05 23:22:07 +0200252#endif
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000253
254#ifdef FEAT_EVAL
255 int wo_scriptID[WV_COUNT]; /* SIDs for window-local options */
256# define w_p_scriptID w_onebuf_opt.wo_scriptID
257#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258} winopt_T;
259
260/*
261 * Window info stored with a buffer.
262 *
263 * Two types of info are kept for a buffer which are associated with a
264 * specific window:
265 * 1. Each window can have a different line number associated with a buffer.
266 * 2. The window-local options for a buffer work in a similar way.
267 * The window-info is kept in a list at b_wininfo. It is kept in
268 * most-recently-used order.
269 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000270struct wininfo_S
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271{
272 wininfo_T *wi_next; /* next entry or NULL for last entry */
273 wininfo_T *wi_prev; /* previous entry or NULL for first entry */
Bram Moolenaar70b11cd2010-05-14 22:24:40 +0200274 win_T *wi_win; /* pointer to window that did set wi_fpos */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275 pos_T wi_fpos; /* last cursor position in the file */
276 int wi_optset; /* TRUE when wi_opt has useful values */
277 winopt_T wi_opt; /* local window options */
278#ifdef FEAT_FOLDING
279 int wi_fold_manual; /* copy of w_fold_manual */
280 garray_T wi_folds; /* clone of w_folds */
281#endif
282};
283
284/*
285 * Info used to pass info about a fold from the fold-detection code to the
286 * code that displays the foldcolumn.
287 */
288typedef struct foldinfo
289{
290 int fi_level; /* level of the fold; when this is zero the
291 other fields are invalid */
292 int fi_lnum; /* line number where fold starts */
293 int fi_low_level; /* lowest fold level that starts in the same
294 line */
295} foldinfo_T;
296
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000297/* Structure to store info about the Visual area. */
298typedef struct
299{
300 pos_T vi_start; /* start pos of last VIsual */
301 pos_T vi_end; /* end position of last VIsual */
302 int vi_mode; /* VIsual_mode of last VIsual */
303 colnr_T vi_curswant; /* MAXCOL from w_curswant */
304} visualinfo_T;
305
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306/*
Bram Moolenaar335437b2007-05-10 18:32:52 +0000307 * structures used for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308 */
309
310typedef struct u_entry u_entry_T;
311typedef struct u_header u_header_T;
312struct u_entry
313{
314 u_entry_T *ue_next; /* pointer to next entry in list */
315 linenr_T ue_top; /* number of line above undo block */
316 linenr_T ue_bot; /* number of line below undo block */
317 linenr_T ue_lcount; /* linecount when u_save called */
318 char_u **ue_array; /* array of lines in undo block */
319 long ue_size; /* number of lines in ue_array */
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000320#ifdef U_DEBUG
321 int ue_magic; /* magic number to check allocation */
322#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323};
324
325struct u_header
326{
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200327 /* The following have a pointer and a number. The number is used when
328 * reading the undo file in u_read_undo() */
329 union {
330 u_header_T *ptr; /* pointer to next undo header in list */
331 long seq;
332 } uh_next;
333 union {
334 u_header_T *ptr; /* pointer to previous header in list */
335 long seq;
336 } uh_prev;
337 union {
338 u_header_T *ptr; /* pointer to next header for alt. redo */
339 long seq;
340 } uh_alt_next;
341 union {
342 u_header_T *ptr; /* pointer to previous header for alt. redo */
343 long seq;
344 } uh_alt_prev;
Bram Moolenaar1e607892006-03-13 22:15:53 +0000345 long uh_seq; /* sequence number, higher == newer undo */
346 int uh_walk; /* used by undo_time() */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000347 u_entry_T *uh_entry; /* pointer to first entry */
348 u_entry_T *uh_getbot_entry; /* pointer to where ue_bot must be set */
349 pos_T uh_cursor; /* cursor position before saving */
350#ifdef FEAT_VIRTUALEDIT
351 long uh_cursor_vcol;
352#endif
353 int uh_flags; /* see below */
354 pos_T uh_namedm[NMARKS]; /* marks before undo/after redo */
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000355 visualinfo_T uh_visual; /* Visual areas before undo/after redo */
Bram Moolenaar1e607892006-03-13 22:15:53 +0000356 time_t uh_time; /* timestamp when the change was made */
Bram Moolenaar730cde92010-06-27 05:18:54 +0200357 long uh_save_nr; /* set when the file was saved after the
358 changes in this block */
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000359#ifdef U_DEBUG
360 int uh_magic; /* magic number to check allocation */
361#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362};
363
364/* values for uh_flags */
365#define UH_CHANGED 0x01 /* b_changed flag before undo/after redo */
366#define UH_EMPTYBUF 0x02 /* buffer was empty */
367
368/*
Bram Moolenaar335437b2007-05-10 18:32:52 +0000369 * structures used in undo.c
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100371#if VIM_SIZEOF_INT > 2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372# define ALIGN_LONG /* longword alignment and use filler byte */
373# define ALIGN_SIZE (sizeof(long))
374#else
375# define ALIGN_SIZE (sizeof(short))
376#endif
377
378#define ALIGN_MASK (ALIGN_SIZE - 1)
379
380typedef struct m_info minfo_T;
381
382/*
Bram Moolenaar2767c602010-05-16 13:56:06 +0200383 * structure used to link chunks in one of the free chunk lists.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 */
385struct m_info
386{
387#ifdef ALIGN_LONG
388 long_u m_size; /* size of the chunk (including m_info) */
389#else
390 short_u m_size; /* size of the chunk (including m_info) */
391#endif
392 minfo_T *m_next; /* pointer to next free chunk in the list */
393};
394
395/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396 * things used in memfile.c
397 */
398
399typedef struct block_hdr bhdr_T;
400typedef struct memfile memfile_T;
401typedef long blocknr_T;
402
403/*
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100404 * mf_hashtab_T is a chained hashtable with blocknr_T key and arbitrary
405 * structures as items. This is an intrusive data structure: we require
406 * that items begin with mf_hashitem_T which contains the key and linked
407 * list pointers. List of items in each bucket is doubly-linked.
408 */
409
410typedef struct mf_hashitem_S mf_hashitem_T;
411
412struct mf_hashitem_S
413{
414 mf_hashitem_T *mhi_next;
415 mf_hashitem_T *mhi_prev;
416 blocknr_T mhi_key;
417};
418
419#define MHT_INIT_SIZE 64
420
421typedef struct mf_hashtab_S
422{
423 long_u mht_mask; /* mask used for hash value (nr of items
424 * in array is "mht_mask" + 1) */
425 long_u mht_count; /* nr of items inserted into hashtable */
426 mf_hashitem_T **mht_buckets; /* points to mht_small_buckets or
427 *dynamically allocated array */
428 mf_hashitem_T *mht_small_buckets[MHT_INIT_SIZE]; /* initial buckets */
429 char mht_fixed; /* non-zero value forbids growth */
430} mf_hashtab_T;
431
432/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433 * for each (previously) used block in the memfile there is one block header.
434 *
435 * The block may be linked in the used list OR in the free list.
436 * The used blocks are also kept in hash lists.
437 *
438 * The used list is a doubly linked list, most recently used block first.
439 * The blocks in the used list have a block of memory allocated.
440 * mf_used_count is the number of pages in the used list.
441 * The hash lists are used to quickly find a block in the used list.
442 * The free list is a single linked list, not sorted.
443 * The blocks in the free list have no block of memory allocated and
444 * the contents of the block in the file (if any) is irrelevant.
445 */
446
447struct block_hdr
448{
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100449 mf_hashitem_T bh_hashitem; /* header for hash table and key */
450#define bh_bnum bh_hashitem.mhi_key /* block number, part of bh_hashitem */
451
Bram Moolenaar071d4272004-06-13 20:20:40 +0000452 bhdr_T *bh_next; /* next block_hdr in free or used list */
453 bhdr_T *bh_prev; /* previous block_hdr in used list */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 char_u *bh_data; /* pointer to memory (for used block) */
455 int bh_page_count; /* number of pages in this block */
456
457#define BH_DIRTY 1
458#define BH_LOCKED 2
459 char bh_flags; /* BH_DIRTY or BH_LOCKED */
460};
461
462/*
463 * when a block with a negative number is flushed to the file, it gets
464 * a positive number. Because the reference to the block is still the negative
465 * number, we remember the translation to the new positive number in the
466 * double linked trans lists. The structure is the same as the hash lists.
467 */
468typedef struct nr_trans NR_TRANS;
469
470struct nr_trans
471{
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100472 mf_hashitem_T nt_hashitem; /* header for hash table and key */
473#define nt_old_bnum nt_hashitem.mhi_key /* old, negative, number */
474
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475 blocknr_T nt_new_bnum; /* new, positive, number */
476};
477
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100478
479typedef struct buffblock buffblock_T;
480typedef struct buffheader buffheader_T;
481
Bram Moolenaar071d4272004-06-13 20:20:40 +0000482/*
483 * structure used to store one block of the stuff/redo/recording buffers
484 */
485struct buffblock
486{
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100487 buffblock_T *b_next; /* pointer to next buffblock */
488 char_u b_str[1]; /* contents (actually longer) */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000489};
490
491/*
492 * header used for the stuff buffer and the redo buffer
493 */
494struct buffheader
495{
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100496 buffblock_T bh_first; /* first (dummy) block of list */
497 buffblock_T *bh_curr; /* buffblock for appending */
498 int bh_index; /* index for reading */
499 int bh_space; /* space in bh_curr for appending */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500};
501
502/*
503 * used for completion on the command line
504 */
505typedef struct expand
506{
507 int xp_context; /* type of expansion */
508 char_u *xp_pattern; /* start of item to expand */
Bram Moolenaar67b891e2009-09-18 15:25:52 +0000509 int xp_pattern_len; /* bytes in xp_pattern before cursor */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510#if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
511 char_u *xp_arg; /* completion function */
512 int xp_scriptID; /* SID for completion function */
513#endif
514 int xp_backslash; /* one of the XP_BS_ values */
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000515#ifndef BACKSLASH_IN_FILENAME
Bram Moolenaarc0cba4d2010-08-07 17:07:21 +0200516 int xp_shell; /* TRUE for a shell command, more
517 characters need to be escaped */
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000518#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519 int xp_numfiles; /* number of files found by
520 file name completion */
521 char_u **xp_files; /* list of files */
Bram Moolenaarb7515462013-06-29 12:58:33 +0200522 char_u *xp_line; /* text being completed */
523 int xp_col; /* cursor position in line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000524} expand_T;
525
526/* values for xp_backslash */
527#define XP_BS_NONE 0 /* nothing special for backslashes */
528#define XP_BS_ONE 1 /* uses one backslash before a space */
529#define XP_BS_THREE 2 /* uses three backslashes before a space */
530
531/*
532 * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
533 * This needs to be saved for recursive commands, put them in a structure for
534 * easy manipulation.
535 */
536typedef struct
537{
538 int hide; /* TRUE when ":hide" was used */
Bram Moolenaard812df62008-11-09 12:46:09 +0000539# ifdef FEAT_BROWSE_CMD
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540 int browse; /* TRUE to invoke file dialog */
541# endif
542# ifdef FEAT_WINDOWS
543 int split; /* flags for win_split() */
Bram Moolenaardf1bdc92006-02-23 21:32:16 +0000544 int tab; /* > 0 when ":tab" was used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545# endif
546# if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
547 int confirm; /* TRUE to invoke yes/no dialog */
548# endif
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000549 int keepalt; /* TRUE when ":keepalt" was used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 int keepmarks; /* TRUE when ":keepmarks" was used */
551 int keepjumps; /* TRUE when ":keepjumps" was used */
552 int lockmarks; /* TRUE when ":lockmarks" was used */
Bram Moolenaara939e432013-11-09 05:30:26 +0100553 int keeppatterns; /* TRUE when ":keeppatterns" was used */
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100554 int noswapfile; /* TRUE when ":noswapfile" was used */
Bram Moolenaarb3480382005-12-11 21:33:32 +0000555# ifdef FEAT_AUTOCMD
556 char_u *save_ei; /* saved value of 'eventignore' */
557# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558} cmdmod_T;
559
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200560#define MF_SEED_LEN 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561
562struct memfile
563{
564 char_u *mf_fname; /* name of the file */
565 char_u *mf_ffname; /* idem, full path */
566 int mf_fd; /* file descriptor */
567 bhdr_T *mf_free_first; /* first block_hdr in free list */
568 bhdr_T *mf_used_first; /* mru block_hdr in used list */
569 bhdr_T *mf_used_last; /* lru block_hdr in used list */
570 unsigned mf_used_count; /* number of pages in used list */
571 unsigned mf_used_count_max; /* maximum number of pages in memory */
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100572 mf_hashtab_T mf_hash; /* hash lists */
573 mf_hashtab_T mf_trans; /* trans lists */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000574 blocknr_T mf_blocknr_max; /* highest positive block number + 1*/
575 blocknr_T mf_blocknr_min; /* lowest negative block number - 1 */
576 blocknr_T mf_neg_count; /* number of negative blocks numbers */
577 blocknr_T mf_infile_count; /* number of pages in the file */
578 unsigned mf_page_size; /* number of bytes in a page */
579 int mf_dirty; /* TRUE if there are dirty blocks */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200580#ifdef FEAT_CRYPT
Bram Moolenaar24dc2302014-05-13 20:19:58 +0200581 buf_T *mf_buffer; /* buffer this memfile is for */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200582 char_u mf_seed[MF_SEED_LEN]; /* seed for encryption */
583
584 /* Values for key, method and seed used for reading data blocks when
585 * updating for a newly set key or method. Only when mf_old_key != NULL. */
586 char_u *mf_old_key;
587 int mf_old_cm;
588 char_u mf_old_seed[MF_SEED_LEN];
589#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590};
591
592/*
593 * things used in memline.c
594 */
595/*
596 * When searching for a specific line, we remember what blocks in the tree
597 * are the branches leading to that block. This is stored in ml_stack. Each
598 * entry is a pointer to info in a block (may be data block or pointer block)
599 */
600typedef struct info_pointer
601{
602 blocknr_T ip_bnum; /* block number */
603 linenr_T ip_low; /* lowest lnum in this block */
604 linenr_T ip_high; /* highest lnum in this block */
605 int ip_index; /* index for block with current lnum */
606} infoptr_T; /* block/index pair */
607
608#ifdef FEAT_BYTEOFF
609typedef struct ml_chunksize
610{
611 int mlcs_numlines;
612 long mlcs_totalsize;
613} chunksize_T;
614
615 /* Flags when calling ml_updatechunk() */
616
617#define ML_CHNK_ADDLINE 1
618#define ML_CHNK_DELLINE 2
619#define ML_CHNK_UPDLINE 3
620#endif
621
622/*
623 * the memline structure holds all the information about a memline
624 */
625typedef struct memline
626{
627 linenr_T ml_line_count; /* number of lines in the buffer */
628
629 memfile_T *ml_mfp; /* pointer to associated memfile */
630
631#define ML_EMPTY 1 /* empty buffer */
632#define ML_LINE_DIRTY 2 /* cached line was changed and allocated */
633#define ML_LOCKED_DIRTY 4 /* ml_locked was changed */
634#define ML_LOCKED_POS 8 /* ml_locked needs positive block number */
635 int ml_flags;
636
637 infoptr_T *ml_stack; /* stack of pointer blocks (array of IPTRs) */
Bram Moolenaar34d72d42015-07-17 14:18:08 +0200638 int ml_stack_top; /* current top of ml_stack */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 int ml_stack_size; /* total number of entries in ml_stack */
640
641 linenr_T ml_line_lnum; /* line number of cached line, 0 if not valid */
642 char_u *ml_line_ptr; /* pointer to cached line */
643
644 bhdr_T *ml_locked; /* block used by last ml_get */
645 linenr_T ml_locked_low; /* first line in ml_locked */
646 linenr_T ml_locked_high; /* last line in ml_locked */
647 int ml_locked_lineadd; /* number of lines inserted in ml_locked */
648#ifdef FEAT_BYTEOFF
649 chunksize_T *ml_chunksize;
650 int ml_numchunks;
651 int ml_usedchunks;
652#endif
653} memline_T;
654
655#if defined(FEAT_SIGNS) || defined(PROTO)
656typedef struct signlist signlist_T;
657
658struct signlist
659{
660 int id; /* unique identifier for each placed sign */
661 linenr_T lnum; /* line number which has this sign */
662 int typenr; /* typenr of sign */
663 signlist_T *next; /* next signlist entry */
664# ifdef FEAT_NETBEANS_INTG
665 signlist_T *prev; /* previous entry -- for easy reordering */
666# endif
667};
668
669/* type argument for buf_getsigntype() */
670#define SIGN_ANY 0
671#define SIGN_LINEHL 1
672#define SIGN_ICON 2
673#define SIGN_TEXT 3
674#endif
675
676/*
677 * Argument list: Array of file names.
678 * Used for the global argument list and the argument lists local to a window.
679 */
680typedef struct arglist
681{
682 garray_T al_ga; /* growarray with the array of file names */
683 int al_refcount; /* number of windows using this arglist */
Bram Moolenaar2d1fe052014-05-28 18:22:57 +0200684 int id; /* id of this arglist */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685} alist_T;
686
687/*
688 * For each argument remember the file name as it was given, and the buffer
689 * number that contains the expanded file name (required for when ":cd" is
690 * used.
691 */
692typedef struct argentry
693{
694 char_u *ae_fname; /* file name as specified */
695 int ae_fnum; /* buffer number with expanded file name */
696} aentry_T;
697
698#ifdef FEAT_WINDOWS
699# define ALIST(win) (win)->w_alist
700#else
701# define ALIST(win) (&global_alist)
702#endif
703#define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data)
704#define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data)
705#define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data)
706#define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data))
707#define GARGCOUNT (global_alist.al_ga.ga_len)
708#define ARGCOUNT (ALIST(curwin)->al_ga.ga_len)
709#define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len)
710
711/*
712 * A list used for saving values of "emsg_silent". Used by ex_try() to save the
713 * value of "emsg_silent" if it was non-zero. When this is done, the CSF_SILENT
714 * flag below is set.
715 */
716
717typedef struct eslist_elem eslist_T;
718struct eslist_elem
719{
720 int saved_emsg_silent; /* saved value of "emsg_silent" */
721 eslist_T *next; /* next element on the list */
722};
723
724/*
725 * For conditional commands a stack is kept of nested conditionals.
726 * When cs_idx < 0, there is no conditional command.
727 */
728#define CSTACK_LEN 50
729
730struct condstack
731{
Bram Moolenaar12805862005-01-05 22:16:17 +0000732 short cs_flags[CSTACK_LEN]; /* CSF_ flags */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 char cs_pending[CSTACK_LEN]; /* CSTP_: what's pending in ":finally"*/
734 union {
Bram Moolenaar12805862005-01-05 22:16:17 +0000735 void *csp_rv[CSTACK_LEN]; /* return typeval for pending return */
736 void *csp_ex[CSTACK_LEN]; /* exception for pending throw */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 } cs_pend;
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000738 void *cs_forinfo[CSTACK_LEN]; /* info used by ":for" */
Bram Moolenaar12805862005-01-05 22:16:17 +0000739 int cs_line[CSTACK_LEN]; /* line nr of ":while"/":for" line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740 int cs_idx; /* current entry, or -1 if none */
Bram Moolenaar12805862005-01-05 22:16:17 +0000741 int cs_looplevel; /* nr of nested ":while"s and ":for"s */
742 int cs_trylevel; /* nr of nested ":try"s */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 eslist_T *cs_emsg_silent_list; /* saved values of "emsg_silent" */
Bram Moolenaar12805862005-01-05 22:16:17 +0000744 char cs_lflags; /* loop flags: CSL_ flags */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745};
Bram Moolenaar12805862005-01-05 22:16:17 +0000746# define cs_rettv cs_pend.csp_rv
747# define cs_exception cs_pend.csp_ex
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000749/* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
750 * was used. */
Bram Moolenaar12805862005-01-05 22:16:17 +0000751# define CSF_TRUE 0x0001 /* condition was TRUE */
752# define CSF_ACTIVE 0x0002 /* current state is active */
753# define CSF_ELSE 0x0004 /* ":else" has been passed */
754# define CSF_WHILE 0x0008 /* is a ":while" */
755# define CSF_FOR 0x0010 /* is a ":for" */
756
757# define CSF_TRY 0x0100 /* is a ":try" */
758# define CSF_FINALLY 0x0200 /* ":finally" has been passed */
759# define CSF_THROWN 0x0400 /* exception thrown to this try conditional */
760# define CSF_CAUGHT 0x0800 /* exception caught by this try conditional */
761# define CSF_SILENT 0x1000 /* "emsg_silent" reset by ":try" */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762/* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
763 * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
764
765/*
766 * What's pending for being reactivated at the ":endtry" of this try
767 * conditional:
768 */
769# define CSTP_NONE 0 /* nothing pending in ":finally" clause */
770# define CSTP_ERROR 1 /* an error is pending */
771# define CSTP_INTERRUPT 2 /* an interrupt is pending */
772# define CSTP_THROW 4 /* a throw is pending */
773# define CSTP_BREAK 8 /* ":break" is pending */
774# define CSTP_CONTINUE 16 /* ":continue" is pending */
775# define CSTP_RETURN 24 /* ":return" is pending */
776# define CSTP_FINISH 32 /* ":finish" is pending */
777
778/*
Bram Moolenaar12805862005-01-05 22:16:17 +0000779 * Flags for the cs_lflags item in struct condstack.
780 */
781# define CSL_HAD_LOOP 1 /* just found ":while" or ":for" */
782# define CSL_HAD_ENDLOOP 2 /* just found ":endwhile" or ":endfor" */
783# define CSL_HAD_CONT 4 /* just found ":continue" */
784# define CSL_HAD_FINA 8 /* just found ":finally" */
785
786/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 * A list of error messages that can be converted to an exception. "throw_msg"
788 * is only set in the first element of the list. Usually, it points to the
789 * original message stored in that element, but sometimes it points to a later
790 * message in the list. See cause_errthrow() below.
791 */
792struct msglist
793{
794 char_u *msg; /* original message */
795 char_u *throw_msg; /* msg to throw: usually original one */
796 struct msglist *next; /* next of several messages in a row */
797};
798
799/*
800 * Structure describing an exception.
801 * (don't use "struct exception", it's used by the math library).
802 */
803typedef struct vim_exception except_T;
804struct vim_exception
805{
806 int type; /* exception type */
807 char_u *value; /* exception value */
808 struct msglist *messages; /* message(s) causing error exception */
809 char_u *throw_name; /* name of the throw point */
810 linenr_T throw_lnum; /* line number of the throw point */
811 except_T *caught; /* next exception on the caught stack */
812};
813
814/*
815 * The exception types.
816 */
817#define ET_USER 0 /* exception caused by ":throw" command */
818#define ET_ERROR 1 /* error exception */
819#define ET_INTERRUPT 2 /* interrupt exception triggered by Ctrl-C */
820
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000821/*
822 * Structure to save the error/interrupt/exception state between calls to
823 * enter_cleanup() and leave_cleanup(). Must be allocated as an automatic
824 * variable by the (common) caller of these functions.
825 */
826typedef struct cleanup_stuff cleanup_T;
827struct cleanup_stuff
828{
829 int pending; /* error/interrupt/exception state */
830 except_T *exception; /* exception value */
831};
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832
833#ifdef FEAT_SYN_HL
834/* struct passed to in_id_list() */
835struct sp_syn
836{
837 int inc_tag; /* ":syn include" unique tag */
838 short id; /* highlight group ID of item */
839 short *cont_in_list; /* cont.in group IDs, if non-zero */
840};
841
842/*
843 * Each keyword has one keyentry, which is linked in a hash list.
844 */
845typedef struct keyentry keyentry_T;
846
847struct keyentry
848{
Bram Moolenaar8f999f12005-01-25 22:12:55 +0000849 keyentry_T *ke_next; /* next entry with identical "keyword[]" */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 struct sp_syn k_syn; /* struct passed to in_id_list() */
851 short *next_list; /* ID list for next match (if non-zero) */
Bram Moolenaar860cae12010-06-05 23:22:07 +0200852 int flags;
853 int k_char; /* conceal substitute character */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 char_u keyword[1]; /* actually longer */
855};
856
857/*
858 * Struct used to store one state of the state stack.
859 */
860typedef struct buf_state
861{
862 int bs_idx; /* index of pattern */
Bram Moolenaar860cae12010-06-05 23:22:07 +0200863 int bs_flags; /* flags for pattern */
Bram Moolenaar6e202e52010-07-28 18:14:45 +0200864#ifdef FEAT_CONCEAL
865 int bs_seqnr; /* stores si_seqnr */
866 int bs_cchar; /* stores si_cchar */
867#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868 reg_extmatch_T *bs_extmatch; /* external matches from start pattern */
869} bufstate_T;
870
871/*
872 * syn_state contains the syntax state stack for the start of one line.
873 * Used by b_sst_array[].
874 */
875typedef struct syn_state synstate_T;
876
877struct syn_state
878{
879 synstate_T *sst_next; /* next entry in used or free list */
880 linenr_T sst_lnum; /* line number for this state */
881 union
882 {
883 bufstate_T sst_stack[SST_FIX_STATES]; /* short state stack */
884 garray_T sst_ga; /* growarray for long state stack */
885 } sst_union;
886 int sst_next_flags; /* flags for sst_next_list */
Bram Moolenaar2767c602010-05-16 13:56:06 +0200887 int sst_stacksize; /* number of states on the stack */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 short *sst_next_list; /* "nextgroup" list in this state
889 * (this is a copy, don't free it! */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 disptick_T sst_tick; /* tick when last displayed */
891 linenr_T sst_change_lnum;/* when non-zero, change in this line
892 * may have made the state invalid */
893};
894#endif /* FEAT_SYN_HL */
895
896/*
897 * Structure shared between syntax.c, screen.c and gui_x11.c.
898 */
899typedef struct attr_entry
900{
901 short ae_attr; /* HL_BOLD, etc. */
902 union
903 {
904 struct
905 {
906 char_u *start; /* start escape sequence */
907 char_u *stop; /* stop escape sequence */
908 } term;
909 struct
910 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000911 /* These colors need to be > 8 bits to hold 256. */
912 short_u fg_color; /* foreground color number */
913 short_u bg_color; /* background color number */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 } cterm;
915# ifdef FEAT_GUI
916 struct
917 {
918 guicolor_T fg_color; /* foreground color handle */
919 guicolor_T bg_color; /* background color handle */
Bram Moolenaare2cc9702005-03-15 22:43:58 +0000920 guicolor_T sp_color; /* special color handle */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 GuiFont font; /* font handle */
922# ifdef FEAT_XFONTSET
923 GuiFontset fontset; /* fontset handle */
924# endif
925 } gui;
926# endif
927 } ae_u;
928} attrentry_T;
929
930#ifdef USE_ICONV
931# ifdef HAVE_ICONV_H
932# include <iconv.h>
933# else
934# if defined(MACOS_X)
935# include <sys/errno.h>
936# define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
937typedef struct _iconv_t *iconv_t;
938# else
939# if defined(MACOS_CLASSIC)
940typedef struct _iconv_t *iconv_t;
941# define EINVAL 22
942# define E2BIG 7
943# define ENOENT 2
944# define EFAULT 14
945# define EILSEQ 123
946# else
947# include <errno.h>
948# endif
949# endif
950typedef void *iconv_t;
951# endif
952#endif
953
954/*
955 * Used for the typeahead buffer: typebuf.
956 */
957typedef struct
958{
959 char_u *tb_buf; /* buffer for typed characters */
960 char_u *tb_noremap; /* mapping flags for characters in tb_buf[] */
961 int tb_buflen; /* size of tb_buf[] */
962 int tb_off; /* current position in tb_buf[] */
963 int tb_len; /* number of valid bytes in tb_buf[] */
964 int tb_maplen; /* nr of mapped bytes in tb_buf[] */
965 int tb_silent; /* nr of silently mapped bytes in tb_buf[] */
966 int tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */
967 int tb_change_cnt; /* nr of time tb_buf was changed; never zero */
968} typebuf_T;
969
970/* Struct to hold the saved typeahead for save_typeahead(). */
971typedef struct
972{
973 typebuf_T save_typebuf;
974 int typebuf_valid; /* TRUE when save_typebuf valid */
Bram Moolenaar13df0fe2009-07-09 16:24:19 +0000975 int old_char;
976 int old_mod_mask;
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100977 buffheader_T save_readbuf1;
978 buffheader_T save_readbuf2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979#ifdef USE_INPUT_BUF
980 char_u *save_inputbuf;
981#endif
982} tasave_T;
983
984/*
985 * Used for conversion of terminal I/O and script files.
986 */
987typedef struct
988{
989 int vc_type; /* zero or one of the CONV_ values */
990 int vc_factor; /* max. expansion factor */
991# ifdef WIN3264
992 int vc_cpfrom; /* codepage to convert from (CONV_CODEPAGE) */
993 int vc_cpto; /* codepage to convert to (CONV_CODEPAGE) */
994# endif
995# ifdef USE_ICONV
996 iconv_t vc_fd; /* for CONV_ICONV */
997# endif
998 int vc_fail; /* fail for invalid char, don't use '?' */
999} vimconv_T;
1000
1001/*
1002 * Structure used for reading from the viminfo file.
1003 */
1004typedef struct
1005{
1006 char_u *vir_line; /* text of the current line */
1007 FILE *vir_fd; /* file descriptor */
1008#ifdef FEAT_MBYTE
1009 vimconv_T vir_conv; /* encoding conversion */
1010#endif
1011} vir_T;
1012
1013#define CONV_NONE 0
1014#define CONV_TO_UTF8 1
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001015#define CONV_9_TO_UTF8 2
1016#define CONV_TO_LATIN1 3
1017#define CONV_TO_LATIN9 4
1018#define CONV_ICONV 5
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019#ifdef WIN3264
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001020# define CONV_CODEPAGE 10 /* codepage -> codepage */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021#endif
1022#ifdef MACOS_X
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001023# define CONV_MAC_LATIN1 20
1024# define CONV_LATIN1_MAC 21
1025# define CONV_MAC_UTF8 22
1026# define CONV_UTF8_MAC 23
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027#endif
1028
1029/*
1030 * Structure used for mappings and abbreviations.
1031 */
1032typedef struct mapblock mapblock_T;
1033struct mapblock
1034{
1035 mapblock_T *m_next; /* next mapblock in list */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001036 char_u *m_keys; /* mapped from, lhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001037 char_u *m_str; /* mapped to, rhs */
1038 char_u *m_orig_str; /* rhs as entered by the user */
Bram Moolenaarf3fe3922013-06-29 14:47:22 +02001039 int m_keylen; /* strlen(m_keys) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 int m_mode; /* valid mode */
1041 int m_noremap; /* if non-zero no re-mapping for m_str */
1042 char m_silent; /* <silent> used, don't echo commands */
Bram Moolenaarf3fe3922013-06-29 14:47:22 +02001043 char m_nowait; /* <nowait> used */
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001044#ifdef FEAT_EVAL
Bram Moolenaara94bc432006-03-10 21:42:59 +00001045 char m_expr; /* <expr> used, m_str is an expression */
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001046 scid_T m_script_ID; /* ID of script where map was defined */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047#endif
1048};
1049
1050/*
1051 * Used for highlighting in the status line.
1052 */
1053struct stl_hlrec
1054{
1055 char_u *start;
Bram Moolenaar238a5642006-02-21 22:12:05 +00001056 int userhl; /* 0: no HL, 1-9: User HL, < 0 for syn ID */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057};
1058
Bram Moolenaar860cae12010-06-05 23:22:07 +02001059
1060/*
1061 * Syntax items - usually buffer-specific.
1062 */
1063
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001064/* Item for a hashtable. "hi_key" can be one of three values:
1065 * NULL: Never been used
1066 * HI_KEY_REMOVED: Entry was removed
1067 * Otherwise: Used item, pointer to the actual key; this usually is
1068 * inside the item, subtract an offset to locate the item.
1069 * This reduces the size of hashitem by 1/3.
1070 */
1071typedef struct hashitem_S
1072{
1073 long_u hi_hash; /* cached hash number of hi_key */
1074 char_u *hi_key;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001075} hashitem_T;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001076
1077/* The address of "hash_removed" is used as a magic number for hi_key to
1078 * indicate a removed item. */
1079#define HI_KEY_REMOVED &hash_removed
1080#define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
1081
1082/* Initial size for a hashtable. Our items are relatively small and growing
1083 * is expensive, thus use 16 as a start. Must be a power of 2. */
1084#define HT_INIT_SIZE 16
1085
1086typedef struct hashtable_S
1087{
1088 long_u ht_mask; /* mask used for hash value (nr of items in
1089 * array is "ht_mask" + 1) */
Bram Moolenaar677ee682005-01-27 14:41:15 +00001090 long_u ht_used; /* number of items used */
1091 long_u ht_filled; /* number of items used + removed */
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001092 int ht_locked; /* counter for hash_lock() */
1093 int ht_error; /* when set growing failed, can't add more
1094 items before growing works */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001095 hashitem_T *ht_array; /* points to the array, allocated when it's
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001096 not "ht_smallarray" */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001097 hashitem_T ht_smallarray[HT_INIT_SIZE]; /* initial array */
1098} hashtab_T;
1099
1100typedef long_u hash_T; /* Type for hi_hash */
1101
1102
Bram Moolenaara2aa31a2014-02-23 22:52:40 +01001103#if VIM_SIZEOF_INT <= 3 /* use long if int is smaller than 32 bits */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001104typedef long varnumber_T;
1105#else
1106typedef int varnumber_T;
1107#endif
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001108typedef double float_T;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001109
1110typedef struct listvar_S list_T;
1111typedef struct dictvar_S dict_T;
1112
1113/*
1114 * Structure to hold an internal variable without a name.
1115 */
1116typedef struct
1117{
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001118 char v_type; /* see below: VAR_NUMBER, VAR_STRING, etc. */
1119 char v_lock; /* see below: VAR_LOCKED, VAR_FIXED */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001120 union
1121 {
1122 varnumber_T v_number; /* number value */
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001123#ifdef FEAT_FLOAT
1124 float_T v_float; /* floating number value */
1125#endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001126 char_u *v_string; /* string value (can be NULL!) */
1127 list_T *v_list; /* list value (can be NULL!) */
1128 dict_T *v_dict; /* dict value (can be NULL!) */
1129 } vval;
1130} typval_T;
1131
1132/* Values for "v_type". */
1133#define VAR_UNKNOWN 0
1134#define VAR_NUMBER 1 /* "v_number" is used */
1135#define VAR_STRING 2 /* "v_string" is used */
1136#define VAR_FUNC 3 /* "v_string" is function name */
1137#define VAR_LIST 4 /* "v_list" is used */
1138#define VAR_DICT 5 /* "v_dict" is used */
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001139#define VAR_FLOAT 6 /* "v_float" is used */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001140
Bram Moolenaarbdb62052012-07-16 17:31:53 +02001141/* Values for "dv_scope". */
1142#define VAR_SCOPE 1 /* a:, v:, s:, etc. scope dictionaries */
1143#define VAR_DEF_SCOPE 2 /* l:, g: scope dictionaries: here funcrefs are not
1144 allowed to mask existing functions */
1145
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001146/* Values for "v_lock". */
1147#define VAR_LOCKED 1 /* locked with lock(), can use unlock() */
1148#define VAR_FIXED 2 /* locked forever */
1149
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001150/*
1151 * Structure to hold an item of a list: an internal variable without a name.
1152 */
1153typedef struct listitem_S listitem_T;
1154
1155struct listitem_S
1156{
1157 listitem_T *li_next; /* next item in list */
1158 listitem_T *li_prev; /* previous item in list */
1159 typval_T li_tv; /* type and value of the variable */
1160};
1161
1162/*
1163 * Struct used by those that are using an item in a list.
1164 */
1165typedef struct listwatch_S listwatch_T;
1166
1167struct listwatch_S
1168{
1169 listitem_T *lw_item; /* item being watched */
1170 listwatch_T *lw_next; /* next watcher */
1171};
1172
1173/*
1174 * Structure to hold info about a list.
1175 */
1176struct listvar_S
1177{
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001178 listitem_T *lv_first; /* first item, NULL if none */
1179 listitem_T *lv_last; /* last item, NULL if none */
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00001180 int lv_refcount; /* reference count */
1181 int lv_len; /* number of items */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001182 listwatch_T *lv_watch; /* first watcher, NULL if none */
Bram Moolenaar748bf032005-02-02 23:04:36 +00001183 int lv_idx; /* cached index of an item */
1184 listitem_T *lv_idx_item; /* when not NULL item at index "lv_idx" */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001185 int lv_copyID; /* ID used by deepcopy() */
1186 list_T *lv_copylist; /* copied list used by deepcopy() */
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001187 char lv_lock; /* zero, VAR_LOCKED, VAR_FIXED */
Bram Moolenaar46152342005-09-07 21:18:43 +00001188 list_T *lv_used_next; /* next list in used lists list */
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00001189 list_T *lv_used_prev; /* previous list in used lists list */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001190};
1191
1192/*
1193 * Structure to hold an item of a Dictionary.
1194 * Also used for a variable.
1195 * The key is copied into "di_key" to avoid an extra alloc/free for it.
1196 */
1197struct dictitem_S
1198{
1199 typval_T di_tv; /* type and value of the variable */
1200 char_u di_flags; /* flags (only used for variable) */
1201 char_u di_key[1]; /* key (actually longer!) */
1202};
1203
1204typedef struct dictitem_S dictitem_T;
1205
Bram Moolenaar9bc174b2015-04-13 16:16:38 +02001206#define DI_FLAGS_RO 1 /* "di_flags" value: read-only variable */
1207#define DI_FLAGS_RO_SBX 2 /* "di_flags" value: read-only in the sandbox */
1208#define DI_FLAGS_FIX 4 /* "di_flags" value: fixed: no :unlet or remove() */
1209#define DI_FLAGS_LOCK 8 /* "di_flags" value: locked variable */
1210#define DI_FLAGS_ALLOC 16 /* "di_flags" value: separately allocated */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001211
1212/*
1213 * Structure to hold info about a Dictionary.
1214 */
1215struct dictvar_S
1216{
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001217 char dv_lock; /* zero, VAR_LOCKED, VAR_FIXED */
Bram Moolenaarbdb62052012-07-16 17:31:53 +02001218 char dv_scope; /* zero, VAR_SCOPE, VAR_DEF_SCOPE */
Bram Moolenaar6395af82013-06-12 19:52:15 +02001219 int dv_refcount; /* reference count */
1220 int dv_copyID; /* ID used by deepcopy() */
1221 hashtab_T dv_hashtab; /* hashtab that refers to the items */
1222 dict_T *dv_copydict; /* copied dict used by deepcopy() */
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00001223 dict_T *dv_used_next; /* next dict in used dicts list */
1224 dict_T *dv_used_prev; /* previous dict in used dicts list */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001225};
1226
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01001227/* structure used for explicit stack while garbage collecting hash tables */
1228typedef struct ht_stack_S
1229{
1230 hashtab_T *ht;
1231 struct ht_stack_S *prev;
1232} ht_stack_T;
1233
1234/* structure used for explicit stack while garbage collecting lists */
1235typedef struct list_stack_S
1236{
1237 list_T *list;
1238 struct list_stack_S *prev;
1239} list_stack_T;
1240
Bram Moolenaarce0842a2005-07-18 21:58:11 +00001241/* values for b_syn_spell: what to do with toplevel text */
1242#define SYNSPL_DEFAULT 0 /* spell check if @Spell not defined */
1243#define SYNSPL_TOP 1 /* spell check toplevel text */
1244#define SYNSPL_NOTOP 2 /* don't spell check toplevel text */
1245
Bram Moolenaar4770d092006-01-12 23:22:24 +00001246/* avoid #ifdefs for when b_spell is not available */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00001247#ifdef FEAT_SPELL
Bram Moolenaar4770d092006-01-12 23:22:24 +00001248# define B_SPELL(buf) ((buf)->b_spell)
1249#else
1250# define B_SPELL(buf) (0)
1251#endif
1252
Bram Moolenaar76b92b22006-03-24 22:46:53 +00001253#ifdef FEAT_QUICKFIX
Bram Moolenaard12f5c12006-01-25 22:10:52 +00001254typedef struct qf_info_S qf_info_T;
Bram Moolenaar76b92b22006-03-24 22:46:53 +00001255#endif
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001256
Bram Moolenaarf7512552013-06-06 14:55:19 +02001257#ifdef FEAT_PROFILE
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001258/*
1259 * Used for :syntime: timing of executing a syntax pattern.
1260 */
1261typedef struct {
1262 proftime_T total; /* total time used */
1263 proftime_T slowest; /* time of slowest call */
1264 long count; /* nr of times used */
1265 long match; /* nr of times matched */
1266} syn_time_T;
1267#endif
1268
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001269#ifdef FEAT_CRYPT
1270/*
1271 * Structure to hold the type of encryption and the state of encryption or
1272 * decryption.
1273 */
1274typedef struct {
1275 int method_nr;
1276 void *method_state; /* method-specific state information */
1277} cryptstate_T;
1278
1279/* values for method_nr */
1280# define CRYPT_M_ZIP 0
1281# define CRYPT_M_BF 1
1282# define CRYPT_M_BF2 2
1283# define CRYPT_M_COUNT 3 /* number of crypt methods */
1284#endif
1285
1286
Bram Moolenaar362ce482012-06-06 19:02:45 +02001287/*
1288 * These are items normally related to a buffer. But when using ":ownsyntax"
1289 * a window may have its own instance.
1290 */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001291typedef struct {
1292#ifdef FEAT_SYN_HL
1293 hashtab_T b_keywtab; /* syntax keywords hash table */
1294 hashtab_T b_keywtab_ic; /* idem, ignore case */
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02001295 int b_syn_error; /* TRUE when error occurred in HL */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001296 int b_syn_ic; /* ignore case for :syn cmds */
1297 int b_syn_spell; /* SYNSPL_ values */
1298 garray_T b_syn_patterns; /* table for syntax patterns */
1299 garray_T b_syn_clusters; /* table for syntax clusters */
1300 int b_spell_cluster_id; /* @Spell cluster ID or 0 */
1301 int b_nospell_cluster_id; /* @NoSpell cluster ID or 0 */
1302 int b_syn_containedin; /* TRUE when there is an item with a
1303 "containedin" argument */
1304 int b_syn_sync_flags; /* flags about how to sync */
1305 short b_syn_sync_id; /* group to sync on */
1306 long b_syn_sync_minlines; /* minimal sync lines offset */
1307 long b_syn_sync_maxlines; /* maximal sync lines offset */
1308 long b_syn_sync_linebreaks; /* offset for multi-line pattern */
1309 char_u *b_syn_linecont_pat; /* line continuation pattern */
1310 regprog_T *b_syn_linecont_prog; /* line continuation program */
Bram Moolenaarf7512552013-06-06 14:55:19 +02001311#ifdef FEAT_PROFILE
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001312 syn_time_T b_syn_linecont_time;
1313#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +02001314 int b_syn_linecont_ic; /* ignore-case flag for above */
1315 int b_syn_topgrp; /* for ":syntax include" */
1316# ifdef FEAT_CONCEAL
1317 int b_syn_conceal; /* auto-conceal for :syn cmds */
1318# endif
1319# ifdef FEAT_FOLDING
1320 int b_syn_folditems; /* number of patterns with the HL_FOLD
1321 flag set */
1322# endif
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02001323 /*
1324 * b_sst_array[] contains the state stack for a number of lines, for the
1325 * start of that line (col == 0). This avoids having to recompute the
1326 * syntax state too often.
1327 * b_sst_array[] is allocated to hold the state for all displayed lines,
1328 * and states for 1 out of about 20 other lines.
1329 * b_sst_array pointer to an array of synstate_T
1330 * b_sst_len number of entries in b_sst_array[]
1331 * b_sst_first pointer to first used entry in b_sst_array[] or NULL
1332 * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL
1333 * b_sst_freecount number of free entries in b_sst_array[]
1334 * b_sst_check_lnum entries after this lnum need to be checked for
1335 * validity (MAXLNUM means no check needed)
1336 */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001337 synstate_T *b_sst_array;
1338 int b_sst_len;
1339 synstate_T *b_sst_first;
1340 synstate_T *b_sst_firstfree;
1341 int b_sst_freecount;
1342 linenr_T b_sst_check_lnum;
1343 short_u b_sst_lasttick; /* last display tick */
1344#endif /* FEAT_SYN_HL */
1345
1346#ifdef FEAT_SPELL
1347 /* for spell checking */
1348 garray_T b_langp; /* list of pointers to slang_T, see spell.c */
1349 char_u b_spell_ismw[256];/* flags: is midword char */
1350# ifdef FEAT_MBYTE
1351 char_u *b_spell_ismw_mb; /* multi-byte midword chars */
1352# endif
1353 char_u *b_p_spc; /* 'spellcapcheck' */
1354 regprog_T *b_cap_prog; /* program for 'spellcapcheck' */
1355 char_u *b_p_spf; /* 'spellfile' */
1356 char_u *b_p_spl; /* 'spelllang' */
Bram Moolenaarcc63c642013-11-12 04:44:01 +01001357# ifdef FEAT_MBYTE
1358 int b_cjk; /* all CJK letters as OK */
1359# endif
Bram Moolenaar860cae12010-06-05 23:22:07 +02001360#endif
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02001361#if !defined(FEAT_SYN_HL) && !defined(FEAT_SPELL)
1362 int dummy;
1363#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +02001364} synblock_T;
1365
1366
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367/*
1368 * buffer: structure that holds information about one file
1369 *
1370 * Several windows can share a single Buffer
1371 * A buffer is unallocated if there is no memfile for it.
1372 * A buffer is new if the associated file has never been loaded yet.
1373 */
1374
Bram Moolenaar071d4272004-06-13 20:20:40 +00001375struct file_buffer
1376{
1377 memline_T b_ml; /* associated memline (also contains line
1378 count) */
1379
1380 buf_T *b_next; /* links in list of buffers */
1381 buf_T *b_prev;
1382
1383 int b_nwindows; /* nr of windows open on this buffer */
1384
1385 int b_flags; /* various BF_ flags */
Bram Moolenaar362ce482012-06-06 19:02:45 +02001386#ifdef FEAT_AUTOCMD
1387 int b_closing; /* buffer is being closed, don't let
1388 autocommands close it too. */
1389#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390
1391 /*
1392 * b_ffname has the full path of the file (NULL for no name).
1393 * b_sfname is the name as the user typed it (or NULL).
1394 * b_fname is the same as b_sfname, unless ":cd" has been done,
1395 * then it is the same as b_ffname (NULL for no name).
1396 */
1397 char_u *b_ffname; /* full path file name */
1398 char_u *b_sfname; /* short file name */
1399 char_u *b_fname; /* current file name */
1400
1401#ifdef UNIX
Bram Moolenaarf1726cc2009-05-13 18:48:16 +00001402 int b_dev_valid; /* TRUE when b_dev has a valid number */
1403 dev_t b_dev; /* device number */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 ino_t b_ino; /* inode number */
1405#endif
1406#ifdef FEAT_CW_EDITOR
1407 FSSpec b_FSSpec; /* MacOS File Identification */
1408#endif
1409#ifdef VMS
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001410 char b_fab_rfm; /* Record format */
1411 char b_fab_rat; /* Record attribute */
1412 unsigned int b_fab_mrs; /* Max record size */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413#endif
1414#ifdef FEAT_SNIFF
1415 int b_sniff; /* file was loaded through Sniff */
1416#endif
1417
1418 int b_fnum; /* buffer number for this file. */
1419
1420 int b_changed; /* 'modified': Set to TRUE if something in the
1421 file has been changed and not written out. */
1422 int b_changedtick; /* incremented for each change, also for undo */
1423
1424 int b_saving; /* Set to TRUE if we are in the middle of
1425 saving the buffer. */
1426
1427 /*
1428 * Changes to a buffer require updating of the display. To minimize the
1429 * work, remember changes made and update everything at once.
1430 */
1431 int b_mod_set; /* TRUE when there are changes since the last
1432 time the display was updated */
1433 linenr_T b_mod_top; /* topmost lnum that was changed */
1434 linenr_T b_mod_bot; /* lnum below last changed line, AFTER the
1435 change */
1436 long b_mod_xlines; /* number of extra buffer lines inserted;
1437 negative when lines were deleted */
1438
1439 wininfo_T *b_wininfo; /* list of last used info for each window */
1440
1441 long b_mtime; /* last change time of original file */
1442 long b_mtime_read; /* last change time when reading */
Bram Moolenaar914703b2010-05-31 21:59:46 +02001443 off_t b_orig_size; /* size of original file in bytes */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444 int b_orig_mode; /* mode of original file */
1445
1446 pos_T b_namedm[NMARKS]; /* current named marks (mark.c) */
1447
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 /* These variables are set when VIsual_active becomes FALSE */
Bram Moolenaara23ccb82006-02-27 00:08:02 +00001449 visualinfo_T b_visual;
Bram Moolenaarf7ff6e82014-03-23 15:13:05 +01001450#ifdef FEAT_EVAL
Bram Moolenaara23ccb82006-02-27 00:08:02 +00001451 int b_visual_mode_eval; /* b_visual.vi_mode for visualmode() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452#endif
1453
1454 pos_T b_last_cursor; /* cursor position when last unloading this
1455 buffer */
1456 pos_T b_last_insert; /* where Insert mode was left */
1457 pos_T b_last_change; /* position of last change: '. mark */
1458
1459#ifdef FEAT_JUMPLIST
1460 /*
1461 * the changelist contains old change positions
1462 */
1463 pos_T b_changelist[JUMPLISTSIZE];
1464 int b_changelistlen; /* number of active entries */
1465 int b_new_change; /* set by u_savecommon() */
1466#endif
1467
1468 /*
1469 * Character table, only used in charset.c for 'iskeyword'
1470 * 32 bytes of 8 bits: 1 bit per character 0-255.
1471 */
1472 char_u b_chartab[32];
1473
1474#ifdef FEAT_LOCALMAP
1475 /* Table used for mappings local to a buffer. */
1476 mapblock_T *(b_maphash[256]);
1477
1478 /* First abbreviation local to a buffer. */
1479 mapblock_T *b_first_abbr;
1480#endif
1481#ifdef FEAT_USR_CMDS
1482 /* User commands local to the buffer. */
1483 garray_T b_ucmds;
1484#endif
1485 /*
1486 * start and end of an operator, also used for '[ and ']
1487 */
1488 pos_T b_op_start;
Bram Moolenaarb1d90a32014-02-22 23:03:55 +01001489 pos_T b_op_start_orig; /* used for Insstart_orig */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 pos_T b_op_end;
1491
1492#ifdef FEAT_VIMINFO
1493 int b_marks_read; /* Have we read viminfo marks yet? */
1494#endif
1495
1496 /*
1497 * The following only used in undo.c.
1498 */
1499 u_header_T *b_u_oldhead; /* pointer to oldest header */
Bram Moolenaara9a568c2006-03-14 23:04:27 +00001500 u_header_T *b_u_newhead; /* pointer to newest header; may not be valid
1501 if b_u_curhead is not NULL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 u_header_T *b_u_curhead; /* pointer to current header */
1503 int b_u_numhead; /* current number of headers */
1504 int b_u_synced; /* entry lists are synced */
Bram Moolenaarca003e12006-03-17 23:19:38 +00001505 long b_u_seq_last; /* last used undo sequence number */
Bram Moolenaar730cde92010-06-27 05:18:54 +02001506 long b_u_save_nr_last; /* counter for last file write */
Bram Moolenaarca003e12006-03-17 23:19:38 +00001507 long b_u_seq_cur; /* hu_seq of header below which we are now */
Bram Moolenaara800b422010-06-27 01:15:55 +02001508 time_t b_u_time_cur; /* uh_time of header below which we are now */
Bram Moolenaar730cde92010-06-27 05:18:54 +02001509 long b_u_save_nr_cur; /* file write nr after which we are now */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510
1511 /*
1512 * variables for "U" command in undo.c
1513 */
1514 char_u *b_u_line_ptr; /* saved line for "U" command */
1515 linenr_T b_u_line_lnum; /* line number of line in u_line */
1516 colnr_T b_u_line_colnr; /* optional column number */
1517
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518#ifdef FEAT_INS_EXPAND
1519 int b_scanned; /* ^N/^P have scanned this buffer */
1520#endif
1521
1522 /* flags for use of ":lmap" and IM control */
1523 long b_p_iminsert; /* input mode for insert */
1524 long b_p_imsearch; /* input mode for search */
1525#define B_IMODE_USE_INSERT -1 /* Use b_p_iminsert value for search */
1526#define B_IMODE_NONE 0 /* Input via none */
1527#define B_IMODE_LMAP 1 /* Input via langmap */
1528#ifndef USE_IM_CONTROL
1529# define B_IMODE_LAST 1
1530#else
1531# define B_IMODE_IM 2 /* Input via input method */
1532# define B_IMODE_LAST 2
1533#endif
1534
1535#ifdef FEAT_KEYMAP
1536 short b_kmap_state; /* using "lmap" mappings */
1537# define KEYMAP_INIT 1 /* 'keymap' was set, call keymap_init() */
1538# define KEYMAP_LOADED 2 /* 'keymap' mappings have been loaded */
1539 garray_T b_kmap_ga; /* the keymap table */
1540#endif
1541
1542 /*
1543 * Options local to a buffer.
1544 * They are here because their value depends on the type of file
1545 * or contents of the file being edited.
1546 */
1547 int b_p_initialized; /* set when options initialized */
1548
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001549#ifdef FEAT_EVAL
1550 int b_p_scriptID[BV_COUNT]; /* SIDs for buffer-local options */
1551#endif
1552
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 int b_p_ai; /* 'autoindent' */
1554 int b_p_ai_nopaste; /* b_p_ai saved for paste mode */
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001555 char_u *b_p_bkc; /* 'backupcopy' */
1556 unsigned b_bkc_flags; /* flags for 'backupcopy' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 int b_p_ci; /* 'copyindent' */
1558 int b_p_bin; /* 'binary' */
1559#ifdef FEAT_MBYTE
1560 int b_p_bomb; /* 'bomb' */
1561#endif
1562#if defined(FEAT_QUICKFIX)
1563 char_u *b_p_bh; /* 'bufhidden' */
1564 char_u *b_p_bt; /* 'buftype' */
1565#endif
1566 int b_p_bl; /* 'buflisted' */
1567#ifdef FEAT_CINDENT
1568 int b_p_cin; /* 'cindent' */
1569 char_u *b_p_cino; /* 'cinoptions' */
1570 char_u *b_p_cink; /* 'cinkeys' */
1571#endif
1572#if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
1573 char_u *b_p_cinw; /* 'cinwords' */
1574#endif
1575#ifdef FEAT_COMMENTS
1576 char_u *b_p_com; /* 'comments' */
1577#endif
1578#ifdef FEAT_FOLDING
1579 char_u *b_p_cms; /* 'commentstring' */
1580#endif
1581#ifdef FEAT_INS_EXPAND
1582 char_u *b_p_cpt; /* 'complete' */
1583#endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001584#ifdef FEAT_COMPL_FUNC
1585 char_u *b_p_cfu; /* 'completefunc' */
Bram Moolenaarf75a9632005-09-13 21:20:47 +00001586 char_u *b_p_ofu; /* 'omnifunc' */
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001587#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 int b_p_eol; /* 'endofline' */
Bram Moolenaar34d72d42015-07-17 14:18:08 +02001589 int b_p_fixeol; /* 'fixendofline' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 int b_p_et; /* 'expandtab' */
1591 int b_p_et_nobin; /* b_p_et saved for binary mode */
1592#ifdef FEAT_MBYTE
1593 char_u *b_p_fenc; /* 'fileencoding' */
1594#endif
1595 char_u *b_p_ff; /* 'fileformat' */
1596#ifdef FEAT_AUTOCMD
1597 char_u *b_p_ft; /* 'filetype' */
1598#endif
1599 char_u *b_p_fo; /* 'formatoptions' */
Bram Moolenaar86b68352004-12-27 21:59:20 +00001600 char_u *b_p_flp; /* 'formatlistpat' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 int b_p_inf; /* 'infercase' */
1602 char_u *b_p_isk; /* 'iskeyword' */
1603#ifdef FEAT_FIND_ID
1604 char_u *b_p_def; /* 'define' local value */
1605 char_u *b_p_inc; /* 'include' */
1606# ifdef FEAT_EVAL
1607 char_u *b_p_inex; /* 'includeexpr' */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001608 long_u b_p_inex_flags; /* flags for 'includeexpr' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609# endif
1610#endif
1611#if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
1612 char_u *b_p_inde; /* 'indentexpr' */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001613 long_u b_p_inde_flags; /* flags for 'indentexpr' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 char_u *b_p_indk; /* 'indentkeys' */
1615#endif
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001616#if defined(FEAT_EVAL)
1617 char_u *b_p_fex; /* 'formatexpr' */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001618 long_u b_p_fex_flags; /* flags for 'formatexpr' */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001619#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620#ifdef FEAT_CRYPT
1621 char_u *b_p_key; /* 'key' */
1622#endif
1623 char_u *b_p_kp; /* 'keywordprg' */
1624#ifdef FEAT_LISP
1625 int b_p_lisp; /* 'lisp' */
1626#endif
1627 char_u *b_p_mps; /* 'matchpairs' */
1628 int b_p_ml; /* 'modeline' */
1629 int b_p_ml_nobin; /* b_p_ml saved for binary mode */
1630 int b_p_ma; /* 'modifiable' */
1631 char_u *b_p_nf; /* 'nrformats' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 int b_p_pi; /* 'preserveindent' */
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001633#ifdef FEAT_TEXTOBJ
1634 char_u *b_p_qe; /* 'quoteescape' */
1635#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 int b_p_ro; /* 'readonly' */
1637 long b_p_sw; /* 'shiftwidth' */
1638#ifndef SHORT_FNAME
1639 int b_p_sn; /* 'shortname' */
1640#endif
1641#ifdef FEAT_SMARTINDENT
1642 int b_p_si; /* 'smartindent' */
1643#endif
1644 long b_p_sts; /* 'softtabstop' */
1645 long b_p_sts_nopaste; /* b_p_sts saved for paste mode */
1646#ifdef FEAT_SEARCHPATH
1647 char_u *b_p_sua; /* 'suffixesadd' */
1648#endif
1649 int b_p_swf; /* 'swapfile' */
1650#ifdef FEAT_SYN_HL
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00001651 long b_p_smc; /* 'synmaxcol' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 char_u *b_p_syn; /* 'syntax' */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00001653#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654 long b_p_ts; /* 'tabstop' */
1655 int b_p_tx; /* 'textmode' */
1656 long b_p_tw; /* 'textwidth' */
1657 long b_p_tw_nobin; /* b_p_tw saved for binary mode */
1658 long b_p_tw_nopaste; /* b_p_tw saved for paste mode */
1659 long b_p_wm; /* 'wrapmargin' */
1660 long b_p_wm_nobin; /* b_p_wm saved for binary mode */
1661 long b_p_wm_nopaste; /* b_p_wm saved for paste mode */
1662#ifdef FEAT_KEYMAP
1663 char_u *b_p_keymap; /* 'keymap' */
1664#endif
1665
1666 /* local values for options which are normally global */
1667#ifdef FEAT_QUICKFIX
1668 char_u *b_p_gp; /* 'grepprg' local value */
1669 char_u *b_p_mp; /* 'makeprg' local value */
1670 char_u *b_p_efm; /* 'errorformat' local value */
1671#endif
1672 char_u *b_p_ep; /* 'equalprg' local value */
1673 char_u *b_p_path; /* 'path' local value */
1674 int b_p_ar; /* 'autoread' local value */
1675 char_u *b_p_tags; /* 'tags' local value */
1676#ifdef FEAT_INS_EXPAND
1677 char_u *b_p_dict; /* 'dictionary' local value */
1678 char_u *b_p_tsr; /* 'thesaurus' local value */
1679#endif
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01001680 long b_p_ul; /* 'undolevels' local value */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02001681#ifdef FEAT_PERSISTENT_UNDO
1682 int b_p_udf; /* 'undofile' */
1683#endif
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01001684#ifdef FEAT_LISP
1685 char_u *b_p_lw; /* 'lispwords' local value */
1686#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687
1688 /* end of buffer options */
1689
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +01001690#ifdef FEAT_CINDENT
1691 /* values set from b_p_cino */
1692 int b_ind_level;
1693 int b_ind_open_imag;
1694 int b_ind_no_brace;
1695 int b_ind_first_open;
1696 int b_ind_open_extra;
1697 int b_ind_close_extra;
1698 int b_ind_open_left_imag;
1699 int b_ind_jump_label;
1700 int b_ind_case;
1701 int b_ind_case_code;
1702 int b_ind_case_break;
1703 int b_ind_param;
1704 int b_ind_func_type;
1705 int b_ind_comment;
1706 int b_ind_in_comment;
1707 int b_ind_in_comment2;
1708 int b_ind_cpp_baseclass;
1709 int b_ind_continuation;
1710 int b_ind_unclosed;
1711 int b_ind_unclosed2;
1712 int b_ind_unclosed_noignore;
1713 int b_ind_unclosed_wrapped;
1714 int b_ind_unclosed_whiteok;
1715 int b_ind_matching_paren;
1716 int b_ind_paren_prev;
1717 int b_ind_maxparen;
1718 int b_ind_maxcomment;
1719 int b_ind_scopedecl;
1720 int b_ind_scopedecl_code;
1721 int b_ind_java;
1722 int b_ind_js;
1723 int b_ind_keep_case_label;
1724 int b_ind_hash_comment;
1725 int b_ind_cpp_namespace;
1726 int b_ind_if_for_while;
1727#endif
1728
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01001729 linenr_T b_no_eol_lnum; /* non-zero lnum when last line of next binary
1730 * write should not have an end-of-line */
1731
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 int b_start_eol; /* last line had eol when it was read */
1733 int b_start_ffc; /* first char of 'ff' when edit started */
1734#ifdef FEAT_MBYTE
1735 char_u *b_start_fenc; /* 'fileencoding' when edit started or NULL */
Bram Moolenaara9b1e742005-12-19 22:14:58 +00001736 int b_bad_char; /* "++bad=" argument when edit started or 0 */
Bram Moolenaar83eb8852007-08-12 13:51:26 +00001737 int b_start_bomb; /* 'bomb' when it was read */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738#endif
1739
1740#ifdef FEAT_EVAL
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001741 dictitem_T b_bufvar; /* variable for "b:" Dictionary */
Bram Moolenaar429fa852013-04-15 12:27:36 +02001742 dict_T *b_vars; /* internal variables, local to buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743#endif
1744
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001745#if defined(FEAT_BEVAL) && defined(FEAT_EVAL)
1746 char_u *b_p_bexpr; /* 'balloonexpr' local value */
1747 long_u b_p_bexpr_flags;/* flags for 'balloonexpr' */
1748#endif
Bram Moolenaar49771f42010-07-20 17:32:38 +02001749#ifdef FEAT_CRYPT
1750 char_u *b_p_cm; /* 'cryptmethod' */
1751#endif
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001752
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 /* When a buffer is created, it starts without a swap file. b_may_swap is
1754 * then set to indicate that a swap file may be opened later. It is reset
1755 * if a swap file could not be opened.
1756 */
1757 int b_may_swap;
1758 int b_did_warn; /* Set to 1 if user has been warned on first
1759 change of a read-only file */
Bram Moolenaar4770d092006-01-12 23:22:24 +00001760
1761 /* Two special kinds of buffers:
1762 * help buffer - used for help files, won't use a swap file.
1763 * spell buffer - used for spell info, never displayed and doesn't have a
1764 * file name.
1765 */
1766 int b_help; /* TRUE for help file buffer (when set b_p_bt
1767 is "help") */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00001768#ifdef FEAT_SPELL
Bram Moolenaar4770d092006-01-12 23:22:24 +00001769 int b_spell; /* TRUE for a spell file buffer, most fields
1770 are not used! Use the B_SPELL macro to
1771 access b_spell without #ifdef. */
1772#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773
1774#ifndef SHORT_FNAME
1775 int b_shortname; /* this file has an 8.3 file name */
1776#endif
1777
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001778#ifdef FEAT_MZSCHEME
Bram Moolenaare344bea2005-09-01 20:46:49 +00001779 void *b_mzscheme_ref; /* The MzScheme reference to this buffer */
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001780#endif
1781
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782#ifdef FEAT_PERL
Bram Moolenaare344bea2005-09-01 20:46:49 +00001783 void *b_perl_private;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784#endif
1785
1786#ifdef FEAT_PYTHON
Bram Moolenaare344bea2005-09-01 20:46:49 +00001787 void *b_python_ref; /* The Python reference to this buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788#endif
1789
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02001790#ifdef FEAT_PYTHON3
1791 void *b_python3_ref; /* The Python3 reference to this buffer */
1792#endif
1793
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794#ifdef FEAT_TCL
Bram Moolenaare344bea2005-09-01 20:46:49 +00001795 void *b_tcl_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796#endif
1797
1798#ifdef FEAT_RUBY
Bram Moolenaare344bea2005-09-01 20:46:49 +00001799 void *b_ruby_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800#endif
1801
Bram Moolenaar860cae12010-06-05 23:22:07 +02001802#if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
1803 synblock_T b_s; /* Info related to syntax highlighting. w_s
1804 * normally points to this, but some windows
1805 * may use a different synblock_T. */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00001806#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807
1808#ifdef FEAT_SIGNS
1809 signlist_T *b_signlist; /* list of signs to draw */
Bram Moolenaar3b7b8362015-03-20 18:11:48 +01001810# ifdef FEAT_NETBEANS_INTG
1811 int b_has_sign_column; /* Flag that is set when a first sign is
1812 * added and remains set until the end of
1813 * the netbeans session. */
1814# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815#endif
1816
1817#ifdef FEAT_NETBEANS_INTG
1818 int b_netbeans_file; /* TRUE when buffer is owned by NetBeans */
1819 int b_was_netbeans_file;/* TRUE if b_netbeans_file was once set */
1820#endif
1821
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001822#ifdef FEAT_CRYPT
1823 cryptstate_T *b_cryptstate; /* Encryption state while reading or writing
1824 * the file. NULL when not using encryption. */
1825#endif
Bram Moolenaar651863c2015-01-14 12:44:41 +01001826 int b_mapped_ctrl_c; /* modes where CTRL-C is mapped */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001827
1828}; /* file_buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001830
1831#ifdef FEAT_DIFF
1832/*
1833 * Stuff for diff mode.
1834 */
1835# define DB_COUNT 4 /* up to four buffers can be diff'ed */
1836
1837/*
1838 * Each diffblock defines where a block of lines starts in each of the buffers
1839 * and how many lines it occupies in that buffer. When the lines are missing
1840 * in the buffer the df_count[] is zero. This is all counted in
1841 * buffer lines.
1842 * There is always at least one unchanged line in between the diffs.
1843 * Otherwise it would have been included in the diff above or below it.
1844 * df_lnum[] + df_count[] is the lnum below the change. When in one buffer
1845 * lines have been inserted, in the other buffer df_lnum[] is the line below
1846 * the insertion and df_count[] is zero. When appending lines at the end of
1847 * the buffer, df_lnum[] is one beyond the end!
1848 * This is using a linked list, because the number of differences is expected
1849 * to be reasonable small. The list is sorted on lnum.
1850 */
1851typedef struct diffblock_S diff_T;
1852struct diffblock_S
1853{
1854 diff_T *df_next;
1855 linenr_T df_lnum[DB_COUNT]; /* line number in buffer */
1856 linenr_T df_count[DB_COUNT]; /* nr of inserted/changed lines */
1857};
1858#endif
1859
Bram Moolenaar746ebd32009-06-16 14:01:43 +00001860#define SNAP_HELP_IDX 0
1861#ifdef FEAT_AUTOCMD
1862# define SNAP_AUCMD_IDX 1
1863# define SNAP_COUNT 2
1864#else
1865# define SNAP_COUNT 1
1866#endif
1867
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001868/*
1869 * Tab pages point to the top frame of each tab page.
1870 * Note: Most values are NOT valid for the current tab page! Use "curwin",
1871 * "firstwin", etc. for that. "tp_topframe" is always valid and can be
1872 * compared against "topframe" to find the current tab page.
1873 */
1874typedef struct tabpage_S tabpage_T;
1875struct tabpage_S
1876{
1877 tabpage_T *tp_next; /* next tabpage or NULL */
1878 frame_T *tp_topframe; /* topframe for the windows */
1879 win_T *tp_curwin; /* current window in this Tab page */
1880 win_T *tp_prevwin; /* previous window in this Tab page */
1881 win_T *tp_firstwin; /* first window in this Tab page */
1882 win_T *tp_lastwin; /* last window in this Tab page */
1883 long tp_old_Rows; /* Rows when Tab page was left */
1884 long tp_old_Columns; /* Columns when Tab page was left */
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001885 long tp_ch_used; /* value of 'cmdheight' when frame size
1886 was set */
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001887#ifdef FEAT_GUI
1888 int tp_prev_which_scrollbars[3];
1889 /* previous value of which_scrollbars */
1890#endif
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001891#ifdef FEAT_DIFF
1892 diff_T *tp_first_diff;
1893 buf_T *(tp_diffbuf[DB_COUNT]);
1894 int tp_diff_invalid; /* list of diffs is outdated */
1895#endif
Bram Moolenaar746ebd32009-06-16 14:01:43 +00001896 frame_T *(tp_snapshot[SNAP_COUNT]); /* window layout snapshots */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001897#ifdef FEAT_EVAL
1898 dictitem_T tp_winvar; /* variable for "t:" Dictionary */
Bram Moolenaar429fa852013-04-15 12:27:36 +02001899 dict_T *tp_vars; /* internal variables, local to tab page */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001900#endif
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02001901
1902#ifdef FEAT_PYTHON
1903 void *tp_python_ref; /* The Python value for this tab page */
1904#endif
1905
1906#ifdef FEAT_PYTHON3
1907 void *tp_python3_ref; /* The Python value for this tab page */
1908#endif
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001909};
1910
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911/*
1912 * Structure to cache info for displayed lines in w_lines[].
1913 * Each logical line has one entry.
1914 * The entry tells how the logical line is currently displayed in the window.
1915 * This is updated when displaying the window.
1916 * When the display is changed (e.g., when clearing the screen) w_lines_valid
1917 * is changed to exclude invalid entries.
1918 * When making changes to the buffer, wl_valid is reset to indicate wl_size
1919 * may not reflect what is actually in the buffer. When wl_valid is FALSE,
1920 * the entries can only be used to count the number of displayed lines used.
1921 * wl_lnum and wl_lastlnum are invalid too.
1922 */
1923typedef struct w_line
1924{
1925 linenr_T wl_lnum; /* buffer line number for logical line */
1926 short_u wl_size; /* height in screen lines */
1927 char wl_valid; /* TRUE values are valid for text in buffer */
1928#ifdef FEAT_FOLDING
1929 char wl_folded; /* TRUE when this is a range of folded lines */
1930 linenr_T wl_lastlnum; /* last buffer line number for logical line */
1931#endif
1932} wline_T;
1933
1934/*
1935 * Windows are kept in a tree of frames. Each frame has a column (FR_COL)
1936 * or row (FR_ROW) layout or is a leaf, which has a window.
1937 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001938struct frame_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00001939{
1940 char fr_layout; /* FR_LEAF, FR_COL or FR_ROW */
1941#ifdef FEAT_VERTSPLIT
1942 int fr_width;
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001943 int fr_newwidth; /* new width used in win_equal_rec() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944#endif
1945 int fr_height;
1946 int fr_newheight; /* new height used in win_equal_rec() */
1947 frame_T *fr_parent; /* containing frame or NULL */
1948 frame_T *fr_next; /* frame right or below in same parent, NULL
1949 for first */
1950 frame_T *fr_prev; /* frame left or above in same parent, NULL
1951 for last */
1952 /* fr_child and fr_win are mutually exclusive */
1953 frame_T *fr_child; /* first contained frame */
1954 win_T *fr_win; /* window that fills this frame */
1955};
1956
1957#define FR_LEAF 0 /* frame is a leaf */
1958#define FR_ROW 1 /* frame with a row of windows */
1959#define FR_COL 2 /* frame with a column of windows */
1960
1961/*
Bram Moolenaar6ee10162007-07-26 20:58:42 +00001962 * Struct used for highlighting 'hlsearch' matches, matches defined by
1963 * ":match" and matches defined by match functions.
1964 * For 'hlsearch' there is one pattern for all windows. For ":match" and the
1965 * match functions there is a different pattern for each window.
1966 */
1967typedef struct
1968{
1969 regmmatch_T rm; /* points to the regexp program; contains last found
1970 match (may continue in next line) */
1971 buf_T *buf; /* the buffer to search for a match */
1972 linenr_T lnum; /* the line to search for a match */
1973 int attr; /* attributes to be used for a match */
1974 int attr_cur; /* attributes currently active in win_line() */
1975 linenr_T first_lnum; /* first lnum to search for multi-line pat */
1976 colnr_T startcol; /* in win_line() points to char where HL starts */
1977 colnr_T endcol; /* in win_line() points to char where HL ends */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00001978#ifdef FEAT_RELTIME
1979 proftime_T tm; /* for a time limit */
1980#endif
Bram Moolenaar6ee10162007-07-26 20:58:42 +00001981} match_T;
1982
Bram Moolenaarb3414592014-06-17 17:48:32 +02001983/* number of positions supported by matchaddpos() */
1984#define MAXPOSMATCH 8
1985
1986/*
1987 * Same as lpos_T, but with additional field len.
1988 */
1989typedef struct
1990{
1991 linenr_T lnum; /* line number */
1992 colnr_T col; /* column number */
1993 int len; /* length: 0 - to the end of line */
1994} llpos_T;
1995
1996/*
1997 * posmatch_T provides an array for storing match items for matchaddpos()
1998 * function.
1999 */
2000typedef struct posmatch posmatch_T;
2001struct posmatch
2002{
2003 llpos_T pos[MAXPOSMATCH]; /* array of positions */
2004 int cur; /* internal position counter */
2005 linenr_T toplnum; /* top buffer line */
2006 linenr_T botlnum; /* bottom buffer line */
2007};
2008
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002009/*
2010 * matchitem_T provides a linked list for storing match items for ":match" and
2011 * the match functions.
2012 */
2013typedef struct matchitem matchitem_T;
2014struct matchitem
2015{
2016 matchitem_T *next;
2017 int id; /* match ID */
2018 int priority; /* match priority */
2019 char_u *pattern; /* pattern to highlight */
2020 int hlg_id; /* highlight group ID */
2021 regmmatch_T match; /* regexp program for pattern */
Bram Moolenaarb3414592014-06-17 17:48:32 +02002022 posmatch_T pos; /* position matches */
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002023 match_T hl; /* struct for doing the actual highlighting */
2024};
2025
2026/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 * Structure which contains all information that belongs to a window
2028 *
2029 * All row numbers are relative to the start of the window, except w_winrow.
2030 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002031struct window_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032{
2033 buf_T *w_buffer; /* buffer we are a window into (used
2034 often, keep it the first item!) */
2035
Bram Moolenaar860cae12010-06-05 23:22:07 +02002036#if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002037 synblock_T *w_s; /* for :ownsyntax */
Bram Moolenaar860cae12010-06-05 23:22:07 +02002038#endif
2039
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040#ifdef FEAT_WINDOWS
2041 win_T *w_prev; /* link to previous window */
2042 win_T *w_next; /* link to next window */
2043#endif
Bram Moolenaar362ce482012-06-06 19:02:45 +02002044#ifdef FEAT_AUTOCMD
2045 int w_closing; /* window is being closed, don't let
2046 autocommands close it too. */
2047#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048
2049 frame_T *w_frame; /* frame containing this window */
2050
2051 pos_T w_cursor; /* cursor position in buffer */
2052
2053 colnr_T w_curswant; /* The column we'd like to be at. This is
2054 used to try to stay in the same column
2055 for up/down cursor motions. */
2056
2057 int w_set_curswant; /* If set, then update w_curswant the next
2058 time through cursupdate() to the
2059 current virtual column */
2060
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 /*
2062 * the next six are used to update the visual part
2063 */
2064 char w_old_visual_mode; /* last known VIsual_mode */
2065 linenr_T w_old_cursor_lnum; /* last known end of visual part */
2066 colnr_T w_old_cursor_fcol; /* first column for block visual part */
2067 colnr_T w_old_cursor_lcol; /* last column for block visual part */
2068 linenr_T w_old_visual_lnum; /* last known start of visual part */
Bram Moolenaar6c131c42005-07-19 22:17:30 +00002069 colnr_T w_old_visual_col; /* last known start of visual part */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 colnr_T w_old_curswant; /* last known value of Curswant */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071
2072 /*
Bram Moolenaard4153d42008-11-15 15:06:17 +00002073 * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for
2074 * displaying the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 */
2076 linenr_T w_topline; /* buffer line number of the line at the
2077 top of the window */
Bram Moolenaard4153d42008-11-15 15:06:17 +00002078#ifdef FEAT_AUTOCMD
2079 char w_topline_was_set; /* flag set to TRUE when topline is set,
2080 e.g. by winrestview() */
2081#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082#ifdef FEAT_DIFF
2083 int w_topfill; /* number of filler lines above w_topline */
2084 int w_old_topfill; /* w_topfill at last redraw */
2085 int w_botfill; /* TRUE when filler lines are actually
2086 below w_topline (at end of file) */
2087 int w_old_botfill; /* w_botfill at last redraw */
2088#endif
2089 colnr_T w_leftcol; /* window column number of the left most
2090 character in the window; used when
2091 'wrap' is off */
2092 colnr_T w_skipcol; /* starting column when a single line
2093 doesn't fit in the window */
2094
2095 /*
2096 * Layout of the window in the screen.
2097 * May need to add "msg_scrolled" to "w_winrow" in rare situations.
2098 */
2099#ifdef FEAT_WINDOWS
2100 int w_winrow; /* first row of window in screen */
2101#endif
2102 int w_height; /* number of rows in window, excluding
2103 status/command line(s) */
2104#ifdef FEAT_WINDOWS
2105 int w_status_height; /* number of status lines (0 or 1) */
2106#endif
2107#ifdef FEAT_VERTSPLIT
2108 int w_wincol; /* Leftmost column of window in screen.
2109 use W_WINCOL() */
2110 int w_width; /* Width of window, excluding separation.
2111 use W_WIDTH() */
2112 int w_vsep_width; /* Number of separator columns (0 or 1).
2113 use W_VSEP_WIDTH() */
2114#endif
2115
2116 /*
2117 * === start of cached values ====
2118 */
2119 /*
2120 * Recomputing is minimized by storing the result of computations.
2121 * Use functions in screen.c to check if they are valid and to update.
2122 * w_valid is a bitfield of flags, which indicate if specific values are
2123 * valid or need to be recomputed. See screen.c for values.
2124 */
2125 int w_valid;
2126 pos_T w_valid_cursor; /* last known position of w_cursor, used
2127 to adjust w_valid */
2128 colnr_T w_valid_leftcol; /* last known w_leftcol */
2129
2130 /*
2131 * w_cline_height is the number of physical lines taken by the buffer line
2132 * that the cursor is on. We use this to avoid extra calls to plines().
2133 */
2134 int w_cline_height; /* current size of cursor line */
2135#ifdef FEAT_FOLDING
2136 int w_cline_folded; /* cursor line is folded */
2137#endif
2138
2139 int w_cline_row; /* starting row of the cursor line */
2140
2141 colnr_T w_virtcol; /* column number of the cursor in the
2142 buffer line, as opposed to the column
2143 number we're at on the screen. This
2144 makes a difference on lines which span
2145 more than one screen line or when
2146 w_leftcol is non-zero */
2147
2148 /*
2149 * w_wrow and w_wcol specify the cursor position in the window.
2150 * This is related to positions in the window, not in the display or
2151 * buffer, thus w_wrow is relative to w_winrow.
2152 */
2153 int w_wrow, w_wcol; /* cursor position in window */
2154
2155 linenr_T w_botline; /* number of the line below the bottom of
2156 the screen */
2157 int w_empty_rows; /* number of ~ rows in window */
2158#ifdef FEAT_DIFF
2159 int w_filler_rows; /* number of filler rows at the end of the
2160 window */
2161#endif
2162
2163 /*
2164 * Info about the lines currently in the window is remembered to avoid
2165 * recomputing it every time. The allocated size of w_lines[] is Rows.
2166 * Only the w_lines_valid entries are actually valid.
2167 * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
2168 * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
2169 * Between changing text and updating the display w_lines[] represents
2170 * what is currently displayed. wl_valid is reset to indicated this.
2171 * This is used for efficient redrawing.
2172 */
2173 int w_lines_valid; /* number of valid entries */
2174 wline_T *w_lines;
2175
2176#ifdef FEAT_FOLDING
2177 garray_T w_folds; /* array of nested folds */
2178 char w_fold_manual; /* when TRUE: some folds are opened/closed
2179 manually */
2180 char w_foldinvalid; /* when TRUE: folding needs to be
2181 recomputed */
2182#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002183#ifdef FEAT_LINEBREAK
Bram Moolenaar64486672010-05-16 15:46:46 +02002184 int w_nrwidth; /* width of 'number' and 'relativenumber'
2185 column being used */
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002186#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187
2188 /*
2189 * === end of cached values ===
2190 */
2191
2192 int w_redr_type; /* type of redraw to be performed on win */
2193 int w_upd_rows; /* number of window lines to update when
2194 w_redr_type is REDRAW_TOP */
2195 linenr_T w_redraw_top; /* when != 0: first line needing redraw */
2196 linenr_T w_redraw_bot; /* when != 0: last line needing redraw */
2197#ifdef FEAT_WINDOWS
2198 int w_redr_status; /* if TRUE status line must be redrawn */
2199#endif
2200
2201#ifdef FEAT_CMDL_INFO
2202 /* remember what is shown in the ruler for this window (if 'ruler' set) */
2203 pos_T w_ru_cursor; /* cursor position shown in ruler */
2204 colnr_T w_ru_virtcol; /* virtcol shown in ruler */
2205 linenr_T w_ru_topline; /* topline shown in ruler */
2206 linenr_T w_ru_line_count; /* line count used for ruler */
2207# ifdef FEAT_DIFF
2208 int w_ru_topfill; /* topfill shown in ruler */
2209# endif
2210 char w_ru_empty; /* TRUE if ruler shows 0-1 (empty line) */
2211#endif
2212
2213 int w_alt_fnum; /* alternate file (for # and CTRL-^) */
2214
2215#ifdef FEAT_WINDOWS
2216 alist_T *w_alist; /* pointer to arglist for this window */
2217#endif
2218 int w_arg_idx; /* current index in argument list (can be
2219 out of range!) */
2220 int w_arg_idx_invalid; /* editing another file than w_arg_idx */
2221
2222 char_u *w_localdir; /* absolute path of local directory or
2223 NULL */
2224 /*
2225 * Options local to a window.
2226 * They are local because they influence the layout of the window or
2227 * depend on the window layout.
2228 * There are two values: w_onebuf_opt is local to the buffer currently in
2229 * this window, w_allbuf_opt is for all buffers in this window.
2230 */
2231 winopt_T w_onebuf_opt;
2232 winopt_T w_allbuf_opt;
2233
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002234 /* A few options have local flags for P_INSECURE. */
2235#ifdef FEAT_STL_OPT
2236 long_u w_p_stl_flags; /* flags for 'statusline' */
2237#endif
2238#ifdef FEAT_EVAL
2239 long_u w_p_fde_flags; /* flags for 'foldexpr' */
2240 long_u w_p_fdt_flags; /* flags for 'foldtext' */
2241#endif
Bram Moolenaar1a384422010-07-14 19:53:30 +02002242#ifdef FEAT_SYN_HL
2243 int *w_p_cc_cols; /* array of columns to highlight or NULL */
2244#endif
Bram Moolenaar597a4222014-06-25 14:39:50 +02002245#ifdef FEAT_LINEBREAK
2246 int w_p_brimin; /* minimum width for breakindent */
2247 int w_p_brishift; /* additional shift for breakindent */
2248 int w_p_brisbr; /* sbr in 'briopt' */
2249#endif
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002250
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 /* transform a pointer to a "onebuf" option into a "allbuf" option */
2252#define GLOBAL_WO(p) ((char *)p + sizeof(winopt_T))
2253
2254#ifdef FEAT_SCROLLBIND
2255 long w_scbind_pos;
2256#endif
2257
2258#ifdef FEAT_EVAL
Bram Moolenaar8f999f12005-01-25 22:12:55 +00002259 dictitem_T w_winvar; /* variable for "w:" Dictionary */
Bram Moolenaar429fa852013-04-15 12:27:36 +02002260 dict_T *w_vars; /* internal variables, local to window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261#endif
2262
2263#if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
2264 int w_farsi; /* for the window dependent Farsi functions */
2265#endif
2266
2267 /*
2268 * The w_prev_pcmark field is used to check whether we really did jump to
2269 * a new line after setting the w_pcmark. If not, then we revert to
2270 * using the previous w_pcmark.
2271 */
2272 pos_T w_pcmark; /* previous context mark */
2273 pos_T w_prev_pcmark; /* previous w_pcmark */
2274
2275#ifdef FEAT_JUMPLIST
2276 /*
2277 * the jumplist contains old cursor positions
2278 */
2279 xfmark_T w_jumplist[JUMPLISTSIZE];
2280 int w_jumplistlen; /* number of active entries */
2281 int w_jumplistidx; /* current position */
2282
2283 int w_changelistidx; /* current position in b_changelist */
2284#endif
2285
2286#ifdef FEAT_SEARCH_EXTRA
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002287 matchitem_T *w_match_head; /* head of match list */
2288 int w_next_match_id; /* next match ID */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289#endif
2290
2291 /*
2292 * the tagstack grows from 0 upwards:
2293 * entry 0: older
2294 * entry 1: newer
2295 * entry 2: newest
2296 */
2297 taggy_T w_tagstack[TAGSTACKSIZE]; /* the tag stack */
Bram Moolenaar335437b2007-05-10 18:32:52 +00002298 int w_tagstackidx; /* idx just below active entry */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 int w_tagstacklen; /* number of tags on stack */
2300
2301 /*
2302 * w_fraction is the fractional row of the cursor within the window, from
2303 * 0 at the top row to FRACTION_MULT at the last row.
2304 * w_prev_fraction_row was the actual cursor row when w_fraction was last
2305 * calculated.
2306 */
2307 int w_fraction;
2308 int w_prev_fraction_row;
2309
2310#ifdef FEAT_GUI
2311 scrollbar_T w_scrollbars[2]; /* vert. Scrollbars for this window */
2312#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002313#ifdef FEAT_LINEBREAK
2314 linenr_T w_nrwidth_line_count; /* line count when ml_nrwidth_width
2315 * was computed. */
Bram Moolenaar6b314672015-03-20 15:42:10 +01002316 long w_nuw_cached; /* 'numberwidth' option cached */
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002317 int w_nrwidth_width; /* nr of chars to print line count. */
2318#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002320#ifdef FEAT_QUICKFIX
2321 qf_info_T *w_llist; /* Location list for this window */
2322 /*
2323 * Location list reference used in the location list window.
2324 * In a non-location list window, w_llist_ref is NULL.
2325 */
2326 qf_info_T *w_llist_ref;
2327#endif
2328
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002329
2330#ifdef FEAT_MZSCHEME
Bram Moolenaare344bea2005-09-01 20:46:49 +00002331 void *w_mzscheme_ref; /* The MzScheme value for this window */
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002332#endif
2333
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334#ifdef FEAT_PERL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002335 void *w_perl_private;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336#endif
2337
2338#ifdef FEAT_PYTHON
Bram Moolenaare344bea2005-09-01 20:46:49 +00002339 void *w_python_ref; /* The Python value for this window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340#endif
2341
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02002342#ifdef FEAT_PYTHON3
2343 void *w_python3_ref; /* The Python value for this window */
2344#endif
2345
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346#ifdef FEAT_TCL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002347 void *w_tcl_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002348#endif
2349
2350#ifdef FEAT_RUBY
Bram Moolenaare344bea2005-09-01 20:46:49 +00002351 void *w_ruby_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352#endif
2353};
2354
2355/*
2356 * Arguments for operators.
2357 */
Bram Moolenaare344bea2005-09-01 20:46:49 +00002358typedef struct oparg_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359{
2360 int op_type; /* current pending operator type */
2361 int regname; /* register to use for the operator */
2362 int motion_type; /* type of the current cursor motion */
2363 int motion_force; /* force motion type: 'v', 'V' or CTRL-V */
2364 int use_reg_one; /* TRUE if delete uses reg 1 even when not
2365 linewise */
2366 int inclusive; /* TRUE if char motion is inclusive (only
2367 valid when motion_type is MCHAR */
2368 int end_adjusted; /* backuped b_op_end one char (only used by
2369 do_format()) */
2370 pos_T start; /* start of the operator */
2371 pos_T end; /* end of the operator */
2372 pos_T cursor_start; /* cursor position before motion for "gw" */
2373
2374 long line_count; /* number of lines from op_start to op_end
2375 (inclusive) */
2376 int empty; /* op_start and op_end the same (only used by
2377 do_change()) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 int is_VIsual; /* operator on Visual area */
2379 int block_mode; /* current operator is Visual block mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380 colnr_T start_vcol; /* start col for block mode operator */
2381 colnr_T end_vcol; /* end col for block mode operator */
Bram Moolenaara983fe92008-07-31 20:04:27 +00002382#ifdef FEAT_AUTOCMD
2383 long prev_opcount; /* ca.opcount saved for K_CURSORHOLD */
2384 long prev_count0; /* ca.count0 saved for K_CURSORHOLD */
2385#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386} oparg_T;
2387
2388/*
2389 * Arguments for Normal mode commands.
2390 */
Bram Moolenaare344bea2005-09-01 20:46:49 +00002391typedef struct cmdarg_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392{
2393 oparg_T *oap; /* Operator arguments */
2394 int prechar; /* prefix character (optional, always 'g') */
2395 int cmdchar; /* command character */
2396 int nchar; /* next command character (optional) */
2397#ifdef FEAT_MBYTE
2398 int ncharC1; /* first composing character (optional) */
2399 int ncharC2; /* second composing character (optional) */
2400#endif
2401 int extra_char; /* yet another character (optional) */
2402 long opcount; /* count before an operator */
2403 long count0; /* count before command, default 0 */
2404 long count1; /* count before command, default 1 */
2405 int arg; /* extra argument from nv_cmds[] */
2406 int retval; /* return: CA_* values */
2407 char_u *searchbuf; /* return: pointer to search pattern or NULL */
2408} cmdarg_T;
2409
2410/* values for retval: */
2411#define CA_COMMAND_BUSY 1 /* skip restarting edit() once */
2412#define CA_NO_ADJ_OP_END 2 /* don't adjust operator end */
2413
2414#ifdef CURSOR_SHAPE
2415/*
2416 * struct to store values from 'guicursor' and 'mouseshape'
2417 */
2418/* Indexes in shape_table[] */
2419#define SHAPE_IDX_N 0 /* Normal mode */
2420#define SHAPE_IDX_V 1 /* Visual mode */
2421#define SHAPE_IDX_I 2 /* Insert mode */
2422#define SHAPE_IDX_R 3 /* Replace mode */
2423#define SHAPE_IDX_C 4 /* Command line Normal mode */
2424#define SHAPE_IDX_CI 5 /* Command line Insert mode */
2425#define SHAPE_IDX_CR 6 /* Command line Replace mode */
2426#define SHAPE_IDX_O 7 /* Operator-pending mode */
Bram Moolenaar2767c602010-05-16 13:56:06 +02002427#define SHAPE_IDX_VE 8 /* Visual mode with 'selection' exclusive */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428#define SHAPE_IDX_CLINE 9 /* On command line */
2429#define SHAPE_IDX_STATUS 10 /* A status line */
2430#define SHAPE_IDX_SDRAG 11 /* dragging a status line */
2431#define SHAPE_IDX_VSEP 12 /* A vertical separator line */
2432#define SHAPE_IDX_VDRAG 13 /* dragging a vertical separator line */
2433#define SHAPE_IDX_MORE 14 /* Hit-return or More */
2434#define SHAPE_IDX_MOREL 15 /* Hit-return or More in last line */
2435#define SHAPE_IDX_SM 16 /* showing matching paren */
2436#define SHAPE_IDX_COUNT 17
2437
2438#define SHAPE_BLOCK 0 /* block cursor */
2439#define SHAPE_HOR 1 /* horizontal bar cursor */
2440#define SHAPE_VER 2 /* vertical bar cursor */
2441
2442#define MSHAPE_NUMBERED 1000 /* offset for shapes identified by number */
2443#define MSHAPE_HIDE 1 /* hide mouse pointer */
2444
2445#define SHAPE_MOUSE 1 /* used for mouse pointer shape */
2446#define SHAPE_CURSOR 2 /* used for text cursor shape */
2447
2448typedef struct cursor_entry
2449{
2450 int shape; /* one of the SHAPE_ defines */
2451 int mshape; /* one of the MSHAPE defines */
2452 int percentage; /* percentage of cell for bar */
2453 long blinkwait; /* blinking, wait time before blinking starts */
2454 long blinkon; /* blinking, on time */
2455 long blinkoff; /* blinking, off time */
2456 int id; /* highlight group ID */
2457 int id_lm; /* highlight group ID for :lmap mode */
2458 char *name; /* mode name (fixed) */
2459 char used_for; /* SHAPE_MOUSE and/or SHAPE_CURSOR */
2460} cursorentry_T;
2461#endif /* CURSOR_SHAPE */
2462
2463#ifdef FEAT_MENU
2464
2465/* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
2466#define MENU_INDEX_INVALID -1
2467#define MENU_INDEX_NORMAL 0
2468#define MENU_INDEX_VISUAL 1
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002469#define MENU_INDEX_SELECT 2
2470#define MENU_INDEX_OP_PENDING 3
2471#define MENU_INDEX_INSERT 4
2472#define MENU_INDEX_CMDLINE 5
2473#define MENU_INDEX_TIP 6
2474#define MENU_MODES 7
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475
2476/* Menu modes */
2477#define MENU_NORMAL_MODE (1 << MENU_INDEX_NORMAL)
2478#define MENU_VISUAL_MODE (1 << MENU_INDEX_VISUAL)
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002479#define MENU_SELECT_MODE (1 << MENU_INDEX_SELECT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480#define MENU_OP_PENDING_MODE (1 << MENU_INDEX_OP_PENDING)
2481#define MENU_INSERT_MODE (1 << MENU_INDEX_INSERT)
2482#define MENU_CMDLINE_MODE (1 << MENU_INDEX_CMDLINE)
2483#define MENU_TIP_MODE (1 << MENU_INDEX_TIP)
2484#define MENU_ALL_MODES ((1 << MENU_INDEX_TIP) - 1)
2485/*note MENU_INDEX_TIP is not a 'real' mode*/
2486
2487/* Start a menu name with this to not include it on the main menu bar */
2488#define MNU_HIDDEN_CHAR ']'
2489
2490typedef struct VimMenu vimmenu_T;
2491
2492struct VimMenu
2493{
2494 int modes; /* Which modes is this menu visible for? */
2495 int enabled; /* for which modes the menu is enabled */
Bram Moolenaar70b11cd2010-05-14 22:24:40 +02002496 char_u *name; /* Name of menu, possibly translated */
2497 char_u *dname; /* Displayed Name ("name" without '&') */
2498#ifdef FEAT_MULTI_LANG
2499 char_u *en_name; /* "name" untranslated, NULL when "name"
2500 * was not translated */
2501 char_u *en_dname; /* "dname" untranslated, NULL when "dname"
2502 * was not translated */
2503#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 int mnemonic; /* mnemonic key (after '&') */
2505 char_u *actext; /* accelerator text (after TAB) */
2506 int priority; /* Menu order priority */
2507#ifdef FEAT_GUI
Bram Moolenaard857f0e2005-06-21 22:37:39 +00002508 void (*cb) __ARGS((vimmenu_T *)); /* Call-back routine */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509#endif
2510#ifdef FEAT_TOOLBAR
2511 char_u *iconfile; /* name of file for icon or NULL */
2512 int iconidx; /* icon index (-1 if not set) */
2513 int icon_builtin; /* icon names is BuiltIn{nr} */
2514#endif
2515 char_u *strings[MENU_MODES]; /* Mapped string for each mode */
2516 int noremap[MENU_MODES]; /* A REMAP_ flag for each mode */
2517 char silent[MENU_MODES]; /* A silent flag for each mode */
2518 vimmenu_T *children; /* Children of sub-menu */
2519 vimmenu_T *parent; /* Parent of menu */
2520 vimmenu_T *next; /* Next item in menu */
2521#ifdef FEAT_GUI_X11
2522 Widget id; /* Manage this to enable item */
2523 Widget submenu_id; /* If this is submenu, add children here */
2524#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525#ifdef FEAT_GUI_GTK
2526 GtkWidget *id; /* Manage this to enable item */
2527 GtkWidget *submenu_id; /* If this is submenu, add children here */
2528 GtkWidget *tearoff_handle;
2529 GtkWidget *label; /* Used by "set wak=" code. */
2530#endif
2531#ifdef FEAT_GUI_MOTIF
2532 int sensitive; /* turn button on/off */
Bram Moolenaarec2dad62005-01-02 11:36:03 +00002533 char **xpm; /* pixmap data */
Bram Moolenaar7c626922005-02-07 22:01:03 +00002534 char *xpm_fname; /* file with pixmap data */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535#endif
Bram Moolenaarec2dad62005-01-02 11:36:03 +00002536#ifdef FEAT_GUI_ATHENA
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 Pixmap image; /* Toolbar image */
2538#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539#ifdef FEAT_BEVAL_TIP
2540 BalloonEval *tip; /* tooltip for this menu item */
2541#endif
2542#ifdef FEAT_GUI_W16
2543 UINT id; /* Id of menu item */
2544 HMENU submenu_id; /* If this is submenu, add children here */
2545#endif
2546#ifdef FEAT_GUI_W32
2547 UINT id; /* Id of menu item */
2548 HMENU submenu_id; /* If this is submenu, add children here */
2549 HWND tearoff_handle; /* hWnd of tearoff if created */
2550#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551#ifdef FEAT_GUI_MAC
2552/* MenuHandle id; */
2553/* short index; */ /* the item index within the father menu */
2554 short menu_id; /* the menu id to which this item belong */
2555 short submenu_id; /* the menu id of the children (could be
Bram Moolenaar2767c602010-05-16 13:56:06 +02002556 get through some tricks) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 MenuHandle menu_handle;
2558 MenuHandle submenu_handle;
2559#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560#ifdef FEAT_GUI_PHOTON
2561 PtWidget_t *id;
2562 PtWidget_t *submenu_id;
2563#endif
2564};
2565#else
2566/* For generating prototypes when FEAT_MENU isn't defined. */
2567typedef int vimmenu_T;
2568
2569#endif /* FEAT_MENU */
2570
2571/*
2572 * Struct to save values in before executing autocommands for a buffer that is
Bram Moolenaarf30e74c2006-08-16 17:35:00 +00002573 * not the current buffer. Without FEAT_AUTOCMD only "curbuf" is remembered.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 */
2575typedef struct
2576{
Bram Moolenaar746ebd32009-06-16 14:01:43 +00002577 buf_T *save_curbuf; /* saved curbuf */
Bram Moolenaarf30e74c2006-08-16 17:35:00 +00002578#ifdef FEAT_AUTOCMD
Bram Moolenaar6bef63c2009-07-29 10:10:29 +00002579 int use_aucmd_win; /* using aucmd_win */
Bram Moolenaar746ebd32009-06-16 14:01:43 +00002580 win_T *save_curwin; /* saved curwin */
2581 win_T *new_curwin; /* new curwin */
2582 buf_T *new_curbuf; /* new curbuf */
Bram Moolenaar6bef63c2009-07-29 10:10:29 +00002583 char_u *globaldir; /* saved value of globaldir */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584#endif
2585} aco_save_T;
2586
2587/*
2588 * Generic option table item, only used for printer at the moment.
2589 */
2590typedef struct
2591{
2592 const char *name;
2593 int hasnum;
2594 long number;
2595 char_u *string; /* points into option string */
2596 int strlen;
2597 int present;
2598} option_table_T;
2599
2600/*
2601 * Structure to hold printing color and font attributes.
2602 */
2603typedef struct
2604{
2605 long_u fg_color;
2606 long_u bg_color;
2607 int bold;
2608 int italic;
2609 int underline;
Bram Moolenaare2cc9702005-03-15 22:43:58 +00002610 int undercurl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611} prt_text_attr_T;
2612
2613/*
2614 * Structure passed back to the generic printer code.
2615 */
2616typedef struct
2617{
2618 int n_collated_copies;
2619 int n_uncollated_copies;
2620 int duplex;
2621 int chars_per_line;
2622 int lines_per_page;
2623 int has_color;
2624 prt_text_attr_T number;
2625#ifdef FEAT_SYN_HL
2626 int modec;
2627 int do_syntax;
2628#endif
2629 int user_abort;
2630 char_u *jobname;
2631#ifdef FEAT_POSTSCRIPT
2632 char_u *outfile;
2633 char_u *arguments;
2634#endif
2635} prt_settings_T;
2636
2637#define PRINT_NUMBER_WIDTH 8
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00002638
2639/*
2640 * Used for popup menu items.
2641 */
2642typedef struct
2643{
2644 char_u *pum_text; /* main menu text */
Bram Moolenaarc270d802006-03-11 21:29:41 +00002645 char_u *pum_kind; /* extra kind text (may be truncated) */
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00002646 char_u *pum_extra; /* extra menu text (may be truncated) */
2647 char_u *pum_info; /* extra info */
2648} pumitem_T;
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002649
2650/*
2651 * Structure used for get_tagfname().
2652 */
2653typedef struct
2654{
2655 char_u *tn_tags; /* value of 'tags' when starting */
2656 char_u *tn_np; /* current position in tn_tags */
2657 int tn_did_filefind_init;
2658 int tn_hf_idx;
2659 void *tn_search_ctx;
2660} tagname_T;
2661
Bram Moolenaar39f05632006-03-19 22:15:26 +00002662/*
2663 * Array indexes used for cptext argument of ins_compl_add().
2664 */
2665#define CPT_ABBR 0 /* "abbr" */
2666#define CPT_MENU 1 /* "menu" */
2667#define CPT_KIND 2 /* "kind" */
2668#define CPT_INFO 3 /* "info" */
2669#define CPT_COUNT 4 /* Number of entries */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02002670
2671typedef struct {
2672 UINT32_T total[2];
2673 UINT32_T state[8];
2674 char_u buffer[64];
2675} context_sha256_T;