blob: 522e15a98981372dedf085bc5507044279695d4a [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
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 */
Bram Moolenaare4f25e42017-07-07 11:54:15 +020071typedef struct terminal_S term_T;
Bram Moolenaarfbc0d2e2013-05-19 19:40:29 +020072
Bram Moolenaar45e5fd12017-06-04 14:58:02 +020073/*
74 * Reference to a buffer that stores the value of buf_free_count.
Bram Moolenaarb25f9a92016-07-10 18:21:50 +020075 * bufref_valid() only needs to check "buf" when the count differs.
76 */
77typedef struct {
78 buf_T *br_buf;
Bram Moolenaar45e5fd12017-06-04 14:58:02 +020079 int br_fnum;
Bram Moolenaarb25f9a92016-07-10 18:21:50 +020080 int br_buf_free_count;
81} bufref_T;
82
Bram Moolenaarfbc0d2e2013-05-19 19:40:29 +020083/*
84 * This is here because regexp.h needs pos_T and below regprog_T is used.
85 */
86#include "regexp.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000087
88/*
89 * This is here because gui.h needs the pos_T and win_T, and win_T needs gui.h
90 * for scrollbar_T.
91 */
92#ifdef FEAT_GUI
93# include "gui.h"
94#else
95# ifdef FEAT_XCLIPBOARD
96# include <X11/Intrinsic.h>
97# endif
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +020098# define guicolor_T long
Bram Moolenaar8a633e32016-04-21 21:10:14 +020099# define INVALCOLOR ((guicolor_T)0x1ffffff)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100#endif
101
102/*
103 * marks: positions in a file
104 * (a normal mark is a lnum/col pair, the same as a file position)
105 */
106
107/* (Note: for EBCDIC there are more than 26, because there are gaps in the
108 * alphabet coding. To minimize changes to the code, I decided to just
109 * increase the number of possible marks. */
110#define NMARKS ('z' - 'a' + 1) /* max. # of named marks */
111#define JUMPLISTSIZE 100 /* max. # of marks in jump list */
112#define TAGSTACKSIZE 20 /* max. # of tags in tag stack */
113
114typedef struct filemark
115{
116 pos_T mark; /* cursor position */
117 int fnum; /* file number */
118} fmark_T;
119
120/* Xtended file mark: also has a file name */
121typedef struct xfilemark
122{
123 fmark_T fmark;
124 char_u *fname; /* file name, used when fnum == 0 */
Bram Moolenaar2d358992016-06-12 21:20:54 +0200125#ifdef FEAT_VIMINFO
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +0200126 time_T time_set;
Bram Moolenaar2d358992016-06-12 21:20:54 +0200127#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128} xfmark_T;
129
130/*
131 * The taggy struct is used to store the information about a :tag command.
132 */
133typedef struct taggy
134{
135 char_u *tagname; /* tag name */
136 fmark_T fmark; /* cursor position BEFORE ":tag" */
137 int cur_match; /* match number */
138 int cur_fnum; /* buffer number used for cur_match */
139} taggy_T;
140
141/*
142 * Structure that contains all options that are local to a window.
143 * Used twice in a window: for the current buffer and for all buffers.
144 * Also used in wininfo_T.
145 */
146typedef struct
147{
148#ifdef FEAT_ARABIC
149 int wo_arab;
150# define w_p_arab w_onebuf_opt.wo_arab /* 'arabic' */
151#endif
Bram Moolenaar597a4222014-06-25 14:39:50 +0200152#ifdef FEAT_LINEBREAK
153 int wo_bri;
154# define w_p_bri w_onebuf_opt.wo_bri /* 'breakindent' */
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200155 char_u *wo_briopt;
Bram Moolenaar597a4222014-06-25 14:39:50 +0200156# define w_p_briopt w_onebuf_opt.wo_briopt /* 'breakindentopt' */
157#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158#ifdef FEAT_DIFF
159 int wo_diff;
160# define w_p_diff w_onebuf_opt.wo_diff /* 'diff' */
161#endif
162#ifdef FEAT_FOLDING
163 long wo_fdc;
164# define w_p_fdc w_onebuf_opt.wo_fdc /* 'foldcolumn' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200165 int wo_fdc_save;
166# define w_p_fdc_save w_onebuf_opt.wo_fdc_save /* 'foldenable' saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167 int wo_fen;
168# define w_p_fen w_onebuf_opt.wo_fen /* 'foldenable' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200169 int wo_fen_save;
170# define w_p_fen_save w_onebuf_opt.wo_fen_save /* 'foldenable' saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171 char_u *wo_fdi;
172# define w_p_fdi w_onebuf_opt.wo_fdi /* 'foldignore' */
173 long wo_fdl;
174# define w_p_fdl w_onebuf_opt.wo_fdl /* 'foldlevel' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200175 int wo_fdl_save;
176# define w_p_fdl_save w_onebuf_opt.wo_fdl_save /* 'foldlevel' state saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000177 char_u *wo_fdm;
178# define w_p_fdm w_onebuf_opt.wo_fdm /* 'foldmethod' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200179 char_u *wo_fdm_save;
180# define w_p_fdm_save w_onebuf_opt.wo_fdm_save /* 'fdm' saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181 long wo_fml;
182# define w_p_fml w_onebuf_opt.wo_fml /* 'foldminlines' */
183 long wo_fdn;
Bram Moolenaar65c923a2006-03-03 22:56:30 +0000184# define w_p_fdn w_onebuf_opt.wo_fdn /* 'foldnestmax' */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185# ifdef FEAT_EVAL
186 char_u *wo_fde;
187# define w_p_fde w_onebuf_opt.wo_fde /* 'foldexpr' */
188 char_u *wo_fdt;
189# define w_p_fdt w_onebuf_opt.wo_fdt /* 'foldtext' */
190# endif
191 char_u *wo_fmr;
192# define w_p_fmr w_onebuf_opt.wo_fmr /* 'foldmarker' */
193#endif
194#ifdef FEAT_LINEBREAK
195 int wo_lbr;
196# define w_p_lbr w_onebuf_opt.wo_lbr /* 'linebreak' */
197#endif
198 int wo_list;
199#define w_p_list w_onebuf_opt.wo_list /* 'list' */
200 int wo_nu;
201#define w_p_nu w_onebuf_opt.wo_nu /* 'number' */
Bram Moolenaar64486672010-05-16 15:46:46 +0200202 int wo_rnu;
203#define w_p_rnu w_onebuf_opt.wo_rnu /* 'relativenumber' */
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000204#ifdef FEAT_LINEBREAK
205 long wo_nuw;
206# define w_p_nuw w_onebuf_opt.wo_nuw /* 'numberwidth' */
207#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208#if defined(FEAT_WINDOWS)
209 int wo_wfh;
210# define w_p_wfh w_onebuf_opt.wo_wfh /* 'winfixheight' */
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000211 int wo_wfw;
212# define w_p_wfw w_onebuf_opt.wo_wfw /* 'winfixwidth' */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213#endif
214#if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
215 int wo_pvw;
216# define w_p_pvw w_onebuf_opt.wo_pvw /* 'previewwindow' */
217#endif
218#ifdef FEAT_RIGHTLEFT
219 int wo_rl;
220# define w_p_rl w_onebuf_opt.wo_rl /* 'rightleft' */
221 char_u *wo_rlc;
222# define w_p_rlc w_onebuf_opt.wo_rlc /* 'rightleftcmd' */
223#endif
224 long wo_scr;
225#define w_p_scr w_onebuf_opt.wo_scr /* 'scroll' */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000226#ifdef FEAT_SPELL
Bram Moolenaar217ad922005-03-20 22:37:15 +0000227 int wo_spell;
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000228# define w_p_spell w_onebuf_opt.wo_spell /* 'spell' */
229#endif
230#ifdef FEAT_SYN_HL
231 int wo_cuc;
232# define w_p_cuc w_onebuf_opt.wo_cuc /* 'cursorcolumn' */
233 int wo_cul;
234# define w_p_cul w_onebuf_opt.wo_cul /* 'cursorline' */
Bram Moolenaar1a384422010-07-14 19:53:30 +0200235 char_u *wo_cc;
236# define w_p_cc w_onebuf_opt.wo_cc /* 'colorcolumn' */
Bram Moolenaar217ad922005-03-20 22:37:15 +0000237#endif
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000238#ifdef FEAT_STL_OPT
239 char_u *wo_stl;
240#define w_p_stl w_onebuf_opt.wo_stl /* 'statusline' */
241#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242#ifdef FEAT_SCROLLBIND
243 int wo_scb;
244# define w_p_scb w_onebuf_opt.wo_scb /* 'scrollbind' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200245 int wo_diff_saved; /* options were saved for starting diff mode */
246# define w_p_diff_saved w_onebuf_opt.wo_diff_saved
247 int wo_scb_save; /* 'scrollbind' saved for diff mode*/
248# define w_p_scb_save w_onebuf_opt.wo_scb_save
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249#endif
250 int wo_wrap;
251#define w_p_wrap w_onebuf_opt.wo_wrap /* 'wrap' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200252#ifdef FEAT_DIFF
253 int wo_wrap_save; /* 'wrap' state saved for diff mode*/
254# define w_p_wrap_save w_onebuf_opt.wo_wrap_save
255#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +0200256#ifdef FEAT_CONCEAL
Bram Moolenaarf5963f72010-07-23 22:10:27 +0200257 char_u *wo_cocu; /* 'concealcursor' */
258# define w_p_cocu w_onebuf_opt.wo_cocu
259 long wo_cole; /* 'conceallevel' */
260# define w_p_cole w_onebuf_opt.wo_cole
Bram Moolenaar860cae12010-06-05 23:22:07 +0200261#endif
262#ifdef FEAT_CURSORBIND
263 int wo_crb;
264# define w_p_crb w_onebuf_opt.wo_crb /* 'cursorbind' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200265 int wo_crb_save; /* 'cursorbind' state saved for diff mode*/
266# define w_p_crb_save w_onebuf_opt.wo_crb_save
Bram Moolenaar860cae12010-06-05 23:22:07 +0200267#endif
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200268#ifdef FEAT_SIGNS
269 char_u *wo_scl;
270# define w_p_scl w_onebuf_opt.wo_scl /* 'signcolumn' */
271#endif
Bram Moolenaare4f25e42017-07-07 11:54:15 +0200272#ifdef FEAT_TERMINAL
Bram Moolenaar1b0675c2017-07-15 14:04:01 +0200273 char_u *wo_tk;
274#define w_p_tk w_onebuf_opt.wo_tk /* 'termkey' */
Bram Moolenaare4f25e42017-07-07 11:54:15 +0200275 char_u *wo_tms;
276#define w_p_tms w_onebuf_opt.wo_tms /* 'termsize' */
277#endif
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000278
279#ifdef FEAT_EVAL
280 int wo_scriptID[WV_COUNT]; /* SIDs for window-local options */
281# define w_p_scriptID w_onebuf_opt.wo_scriptID
282#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283} winopt_T;
284
285/*
286 * Window info stored with a buffer.
287 *
288 * Two types of info are kept for a buffer which are associated with a
289 * specific window:
290 * 1. Each window can have a different line number associated with a buffer.
291 * 2. The window-local options for a buffer work in a similar way.
292 * The window-info is kept in a list at b_wininfo. It is kept in
293 * most-recently-used order.
294 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000295struct wininfo_S
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296{
297 wininfo_T *wi_next; /* next entry or NULL for last entry */
298 wininfo_T *wi_prev; /* previous entry or NULL for first entry */
Bram Moolenaar70b11cd2010-05-14 22:24:40 +0200299 win_T *wi_win; /* pointer to window that did set wi_fpos */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000300 pos_T wi_fpos; /* last cursor position in the file */
301 int wi_optset; /* TRUE when wi_opt has useful values */
302 winopt_T wi_opt; /* local window options */
303#ifdef FEAT_FOLDING
304 int wi_fold_manual; /* copy of w_fold_manual */
305 garray_T wi_folds; /* clone of w_folds */
306#endif
307};
308
309/*
310 * Info used to pass info about a fold from the fold-detection code to the
311 * code that displays the foldcolumn.
312 */
313typedef struct foldinfo
314{
315 int fi_level; /* level of the fold; when this is zero the
316 other fields are invalid */
317 int fi_lnum; /* line number where fold starts */
318 int fi_low_level; /* lowest fold level that starts in the same
319 line */
320} foldinfo_T;
321
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000322/* Structure to store info about the Visual area. */
323typedef struct
324{
325 pos_T vi_start; /* start pos of last VIsual */
326 pos_T vi_end; /* end position of last VIsual */
327 int vi_mode; /* VIsual_mode of last VIsual */
328 colnr_T vi_curswant; /* MAXCOL from w_curswant */
329} visualinfo_T;
330
Bram Moolenaar071d4272004-06-13 20:20:40 +0000331/*
Bram Moolenaar335437b2007-05-10 18:32:52 +0000332 * structures used for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 */
334
335typedef struct u_entry u_entry_T;
336typedef struct u_header u_header_T;
337struct u_entry
338{
339 u_entry_T *ue_next; /* pointer to next entry in list */
340 linenr_T ue_top; /* number of line above undo block */
341 linenr_T ue_bot; /* number of line below undo block */
342 linenr_T ue_lcount; /* linecount when u_save called */
343 char_u **ue_array; /* array of lines in undo block */
344 long ue_size; /* number of lines in ue_array */
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000345#ifdef U_DEBUG
346 int ue_magic; /* magic number to check allocation */
347#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348};
349
350struct u_header
351{
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200352 /* The following have a pointer and a number. The number is used when
353 * reading the undo file in u_read_undo() */
354 union {
355 u_header_T *ptr; /* pointer to next undo header in list */
356 long seq;
357 } uh_next;
358 union {
359 u_header_T *ptr; /* pointer to previous header in list */
360 long seq;
361 } uh_prev;
362 union {
363 u_header_T *ptr; /* pointer to next header for alt. redo */
364 long seq;
365 } uh_alt_next;
366 union {
367 u_header_T *ptr; /* pointer to previous header for alt. redo */
368 long seq;
369 } uh_alt_prev;
Bram Moolenaar1e607892006-03-13 22:15:53 +0000370 long uh_seq; /* sequence number, higher == newer undo */
371 int uh_walk; /* used by undo_time() */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372 u_entry_T *uh_entry; /* pointer to first entry */
373 u_entry_T *uh_getbot_entry; /* pointer to where ue_bot must be set */
374 pos_T uh_cursor; /* cursor position before saving */
375#ifdef FEAT_VIRTUALEDIT
376 long uh_cursor_vcol;
377#endif
378 int uh_flags; /* see below */
379 pos_T uh_namedm[NMARKS]; /* marks before undo/after redo */
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000380 visualinfo_T uh_visual; /* Visual areas before undo/after redo */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +0200381 time_T uh_time; /* timestamp when the change was made */
Bram Moolenaar730cde92010-06-27 05:18:54 +0200382 long uh_save_nr; /* set when the file was saved after the
383 changes in this block */
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000384#ifdef U_DEBUG
385 int uh_magic; /* magic number to check allocation */
386#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387};
388
389/* values for uh_flags */
390#define UH_CHANGED 0x01 /* b_changed flag before undo/after redo */
391#define UH_EMPTYBUF 0x02 /* buffer was empty */
392
393/*
Bram Moolenaar335437b2007-05-10 18:32:52 +0000394 * structures used in undo.c
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100396#if VIM_SIZEOF_INT > 2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397# define ALIGN_LONG /* longword alignment and use filler byte */
398# define ALIGN_SIZE (sizeof(long))
399#else
400# define ALIGN_SIZE (sizeof(short))
401#endif
402
403#define ALIGN_MASK (ALIGN_SIZE - 1)
404
405typedef struct m_info minfo_T;
406
407/*
Bram Moolenaar2767c602010-05-16 13:56:06 +0200408 * structure used to link chunks in one of the free chunk lists.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 */
410struct m_info
411{
412#ifdef ALIGN_LONG
413 long_u m_size; /* size of the chunk (including m_info) */
414#else
415 short_u m_size; /* size of the chunk (including m_info) */
416#endif
417 minfo_T *m_next; /* pointer to next free chunk in the list */
418};
419
420/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 * things used in memfile.c
422 */
423
424typedef struct block_hdr bhdr_T;
425typedef struct memfile memfile_T;
426typedef long blocknr_T;
427
428/*
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100429 * mf_hashtab_T is a chained hashtable with blocknr_T key and arbitrary
430 * structures as items. This is an intrusive data structure: we require
431 * that items begin with mf_hashitem_T which contains the key and linked
432 * list pointers. List of items in each bucket is doubly-linked.
433 */
434
435typedef struct mf_hashitem_S mf_hashitem_T;
436
437struct mf_hashitem_S
438{
439 mf_hashitem_T *mhi_next;
440 mf_hashitem_T *mhi_prev;
441 blocknr_T mhi_key;
442};
443
444#define MHT_INIT_SIZE 64
445
446typedef struct mf_hashtab_S
447{
448 long_u mht_mask; /* mask used for hash value (nr of items
449 * in array is "mht_mask" + 1) */
450 long_u mht_count; /* nr of items inserted into hashtable */
451 mf_hashitem_T **mht_buckets; /* points to mht_small_buckets or
452 *dynamically allocated array */
453 mf_hashitem_T *mht_small_buckets[MHT_INIT_SIZE]; /* initial buckets */
454 char mht_fixed; /* non-zero value forbids growth */
455} mf_hashtab_T;
456
457/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458 * for each (previously) used block in the memfile there is one block header.
459 *
460 * The block may be linked in the used list OR in the free list.
461 * The used blocks are also kept in hash lists.
462 *
463 * The used list is a doubly linked list, most recently used block first.
464 * The blocks in the used list have a block of memory allocated.
465 * mf_used_count is the number of pages in the used list.
466 * The hash lists are used to quickly find a block in the used list.
467 * The free list is a single linked list, not sorted.
468 * The blocks in the free list have no block of memory allocated and
469 * the contents of the block in the file (if any) is irrelevant.
470 */
471
472struct block_hdr
473{
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100474 mf_hashitem_T bh_hashitem; /* header for hash table and key */
475#define bh_bnum bh_hashitem.mhi_key /* block number, part of bh_hashitem */
476
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477 bhdr_T *bh_next; /* next block_hdr in free or used list */
478 bhdr_T *bh_prev; /* previous block_hdr in used list */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 char_u *bh_data; /* pointer to memory (for used block) */
480 int bh_page_count; /* number of pages in this block */
481
482#define BH_DIRTY 1
483#define BH_LOCKED 2
484 char bh_flags; /* BH_DIRTY or BH_LOCKED */
485};
486
487/*
488 * when a block with a negative number is flushed to the file, it gets
489 * a positive number. Because the reference to the block is still the negative
490 * number, we remember the translation to the new positive number in the
491 * double linked trans lists. The structure is the same as the hash lists.
492 */
493typedef struct nr_trans NR_TRANS;
494
495struct nr_trans
496{
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100497 mf_hashitem_T nt_hashitem; /* header for hash table and key */
498#define nt_old_bnum nt_hashitem.mhi_key /* old, negative, number */
499
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500 blocknr_T nt_new_bnum; /* new, positive, number */
501};
502
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100503
504typedef struct buffblock buffblock_T;
505typedef struct buffheader buffheader_T;
506
Bram Moolenaar071d4272004-06-13 20:20:40 +0000507/*
508 * structure used to store one block of the stuff/redo/recording buffers
509 */
510struct buffblock
511{
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100512 buffblock_T *b_next; /* pointer to next buffblock */
513 char_u b_str[1]; /* contents (actually longer) */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514};
515
516/*
517 * header used for the stuff buffer and the redo buffer
518 */
519struct buffheader
520{
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100521 buffblock_T bh_first; /* first (dummy) block of list */
522 buffblock_T *bh_curr; /* buffblock for appending */
523 int bh_index; /* index for reading */
524 int bh_space; /* space in bh_curr for appending */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000525};
526
Bram Moolenaard4863aa2017-04-07 19:50:12 +0200527typedef struct
528{
529 buffheader_T sr_redobuff;
530 buffheader_T sr_old_redobuff;
531} save_redo_T;
532
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533/*
534 * used for completion on the command line
535 */
536typedef struct expand
537{
538 int xp_context; /* type of expansion */
539 char_u *xp_pattern; /* start of item to expand */
Bram Moolenaar67b891e2009-09-18 15:25:52 +0000540 int xp_pattern_len; /* bytes in xp_pattern before cursor */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541#if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
542 char_u *xp_arg; /* completion function */
543 int xp_scriptID; /* SID for completion function */
544#endif
545 int xp_backslash; /* one of the XP_BS_ values */
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000546#ifndef BACKSLASH_IN_FILENAME
Bram Moolenaarc0cba4d2010-08-07 17:07:21 +0200547 int xp_shell; /* TRUE for a shell command, more
548 characters need to be escaped */
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000549#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 int xp_numfiles; /* number of files found by
551 file name completion */
552 char_u **xp_files; /* list of files */
Bram Moolenaarb7515462013-06-29 12:58:33 +0200553 char_u *xp_line; /* text being completed */
554 int xp_col; /* cursor position in line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555} expand_T;
556
557/* values for xp_backslash */
558#define XP_BS_NONE 0 /* nothing special for backslashes */
559#define XP_BS_ONE 1 /* uses one backslash before a space */
560#define XP_BS_THREE 2 /* uses three backslashes before a space */
561
562/*
563 * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
564 * This needs to be saved for recursive commands, put them in a structure for
565 * easy manipulation.
566 */
567typedef struct
568{
569 int hide; /* TRUE when ":hide" was used */
Bram Moolenaard812df62008-11-09 12:46:09 +0000570# ifdef FEAT_BROWSE_CMD
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571 int browse; /* TRUE to invoke file dialog */
572# endif
573# ifdef FEAT_WINDOWS
574 int split; /* flags for win_split() */
Bram Moolenaardf1bdc92006-02-23 21:32:16 +0000575 int tab; /* > 0 when ":tab" was used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576# endif
577# if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
578 int confirm; /* TRUE to invoke yes/no dialog */
579# endif
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000580 int keepalt; /* TRUE when ":keepalt" was used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581 int keepmarks; /* TRUE when ":keepmarks" was used */
582 int keepjumps; /* TRUE when ":keepjumps" was used */
583 int lockmarks; /* TRUE when ":lockmarks" was used */
Bram Moolenaara939e432013-11-09 05:30:26 +0100584 int keeppatterns; /* TRUE when ":keeppatterns" was used */
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100585 int noswapfile; /* TRUE when ":noswapfile" was used */
Bram Moolenaarb3480382005-12-11 21:33:32 +0000586# ifdef FEAT_AUTOCMD
587 char_u *save_ei; /* saved value of 'eventignore' */
588# endif
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200589 regmatch_T filter_regmatch; /* set by :filter /pat/ */
Bram Moolenaard29459b2016-08-26 22:29:11 +0200590 int filter_force; /* set for :filter! */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591} cmdmod_T;
592
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200593#define MF_SEED_LEN 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594
595struct memfile
596{
597 char_u *mf_fname; /* name of the file */
598 char_u *mf_ffname; /* idem, full path */
599 int mf_fd; /* file descriptor */
600 bhdr_T *mf_free_first; /* first block_hdr in free list */
601 bhdr_T *mf_used_first; /* mru block_hdr in used list */
602 bhdr_T *mf_used_last; /* lru block_hdr in used list */
603 unsigned mf_used_count; /* number of pages in used list */
604 unsigned mf_used_count_max; /* maximum number of pages in memory */
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100605 mf_hashtab_T mf_hash; /* hash lists */
606 mf_hashtab_T mf_trans; /* trans lists */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607 blocknr_T mf_blocknr_max; /* highest positive block number + 1*/
608 blocknr_T mf_blocknr_min; /* lowest negative block number - 1 */
609 blocknr_T mf_neg_count; /* number of negative blocks numbers */
610 blocknr_T mf_infile_count; /* number of pages in the file */
611 unsigned mf_page_size; /* number of bytes in a page */
612 int mf_dirty; /* TRUE if there are dirty blocks */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200613#ifdef FEAT_CRYPT
Bram Moolenaar24dc2302014-05-13 20:19:58 +0200614 buf_T *mf_buffer; /* buffer this memfile is for */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200615 char_u mf_seed[MF_SEED_LEN]; /* seed for encryption */
616
617 /* Values for key, method and seed used for reading data blocks when
618 * updating for a newly set key or method. Only when mf_old_key != NULL. */
619 char_u *mf_old_key;
620 int mf_old_cm;
621 char_u mf_old_seed[MF_SEED_LEN];
622#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623};
624
625/*
626 * things used in memline.c
627 */
628/*
629 * When searching for a specific line, we remember what blocks in the tree
630 * are the branches leading to that block. This is stored in ml_stack. Each
631 * entry is a pointer to info in a block (may be data block or pointer block)
632 */
633typedef struct info_pointer
634{
635 blocknr_T ip_bnum; /* block number */
636 linenr_T ip_low; /* lowest lnum in this block */
637 linenr_T ip_high; /* highest lnum in this block */
638 int ip_index; /* index for block with current lnum */
639} infoptr_T; /* block/index pair */
640
641#ifdef FEAT_BYTEOFF
642typedef struct ml_chunksize
643{
644 int mlcs_numlines;
645 long mlcs_totalsize;
646} chunksize_T;
647
648 /* Flags when calling ml_updatechunk() */
649
650#define ML_CHNK_ADDLINE 1
651#define ML_CHNK_DELLINE 2
652#define ML_CHNK_UPDLINE 3
653#endif
654
655/*
656 * the memline structure holds all the information about a memline
657 */
658typedef struct memline
659{
660 linenr_T ml_line_count; /* number of lines in the buffer */
661
662 memfile_T *ml_mfp; /* pointer to associated memfile */
663
664#define ML_EMPTY 1 /* empty buffer */
665#define ML_LINE_DIRTY 2 /* cached line was changed and allocated */
666#define ML_LOCKED_DIRTY 4 /* ml_locked was changed */
667#define ML_LOCKED_POS 8 /* ml_locked needs positive block number */
668 int ml_flags;
669
670 infoptr_T *ml_stack; /* stack of pointer blocks (array of IPTRs) */
Bram Moolenaar34d72d42015-07-17 14:18:08 +0200671 int ml_stack_top; /* current top of ml_stack */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672 int ml_stack_size; /* total number of entries in ml_stack */
673
674 linenr_T ml_line_lnum; /* line number of cached line, 0 if not valid */
675 char_u *ml_line_ptr; /* pointer to cached line */
676
677 bhdr_T *ml_locked; /* block used by last ml_get */
678 linenr_T ml_locked_low; /* first line in ml_locked */
679 linenr_T ml_locked_high; /* last line in ml_locked */
680 int ml_locked_lineadd; /* number of lines inserted in ml_locked */
681#ifdef FEAT_BYTEOFF
682 chunksize_T *ml_chunksize;
683 int ml_numchunks;
684 int ml_usedchunks;
685#endif
686} memline_T;
687
688#if defined(FEAT_SIGNS) || defined(PROTO)
689typedef struct signlist signlist_T;
690
691struct signlist
692{
693 int id; /* unique identifier for each placed sign */
694 linenr_T lnum; /* line number which has this sign */
695 int typenr; /* typenr of sign */
696 signlist_T *next; /* next signlist entry */
697# ifdef FEAT_NETBEANS_INTG
698 signlist_T *prev; /* previous entry -- for easy reordering */
699# endif
700};
701
702/* type argument for buf_getsigntype() */
703#define SIGN_ANY 0
704#define SIGN_LINEHL 1
705#define SIGN_ICON 2
706#define SIGN_TEXT 3
707#endif
708
709/*
710 * Argument list: Array of file names.
711 * Used for the global argument list and the argument lists local to a window.
712 */
713typedef struct arglist
714{
715 garray_T al_ga; /* growarray with the array of file names */
716 int al_refcount; /* number of windows using this arglist */
Bram Moolenaar2d1fe052014-05-28 18:22:57 +0200717 int id; /* id of this arglist */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718} alist_T;
719
720/*
721 * For each argument remember the file name as it was given, and the buffer
722 * number that contains the expanded file name (required for when ":cd" is
723 * used.
724 */
725typedef struct argentry
726{
727 char_u *ae_fname; /* file name as specified */
728 int ae_fnum; /* buffer number with expanded file name */
729} aentry_T;
730
731#ifdef FEAT_WINDOWS
732# define ALIST(win) (win)->w_alist
733#else
734# define ALIST(win) (&global_alist)
735#endif
736#define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data)
737#define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data)
738#define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data)
739#define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data))
740#define GARGCOUNT (global_alist.al_ga.ga_len)
741#define ARGCOUNT (ALIST(curwin)->al_ga.ga_len)
742#define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len)
743
744/*
745 * A list used for saving values of "emsg_silent". Used by ex_try() to save the
746 * value of "emsg_silent" if it was non-zero. When this is done, the CSF_SILENT
747 * flag below is set.
748 */
749
750typedef struct eslist_elem eslist_T;
751struct eslist_elem
752{
753 int saved_emsg_silent; /* saved value of "emsg_silent" */
754 eslist_T *next; /* next element on the list */
755};
756
757/*
758 * For conditional commands a stack is kept of nested conditionals.
759 * When cs_idx < 0, there is no conditional command.
760 */
761#define CSTACK_LEN 50
762
763struct condstack
764{
Bram Moolenaar12805862005-01-05 22:16:17 +0000765 short cs_flags[CSTACK_LEN]; /* CSF_ flags */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 char cs_pending[CSTACK_LEN]; /* CSTP_: what's pending in ":finally"*/
767 union {
Bram Moolenaar12805862005-01-05 22:16:17 +0000768 void *csp_rv[CSTACK_LEN]; /* return typeval for pending return */
769 void *csp_ex[CSTACK_LEN]; /* exception for pending throw */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770 } cs_pend;
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000771 void *cs_forinfo[CSTACK_LEN]; /* info used by ":for" */
Bram Moolenaar12805862005-01-05 22:16:17 +0000772 int cs_line[CSTACK_LEN]; /* line nr of ":while"/":for" line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 int cs_idx; /* current entry, or -1 if none */
Bram Moolenaar12805862005-01-05 22:16:17 +0000774 int cs_looplevel; /* nr of nested ":while"s and ":for"s */
775 int cs_trylevel; /* nr of nested ":try"s */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 eslist_T *cs_emsg_silent_list; /* saved values of "emsg_silent" */
Bram Moolenaar12805862005-01-05 22:16:17 +0000777 char cs_lflags; /* loop flags: CSL_ flags */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778};
Bram Moolenaar12805862005-01-05 22:16:17 +0000779# define cs_rettv cs_pend.csp_rv
780# define cs_exception cs_pend.csp_ex
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000782/* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
783 * was used. */
Bram Moolenaar12805862005-01-05 22:16:17 +0000784# define CSF_TRUE 0x0001 /* condition was TRUE */
785# define CSF_ACTIVE 0x0002 /* current state is active */
786# define CSF_ELSE 0x0004 /* ":else" has been passed */
787# define CSF_WHILE 0x0008 /* is a ":while" */
788# define CSF_FOR 0x0010 /* is a ":for" */
789
790# define CSF_TRY 0x0100 /* is a ":try" */
791# define CSF_FINALLY 0x0200 /* ":finally" has been passed */
792# define CSF_THROWN 0x0400 /* exception thrown to this try conditional */
793# define CSF_CAUGHT 0x0800 /* exception caught by this try conditional */
794# define CSF_SILENT 0x1000 /* "emsg_silent" reset by ":try" */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795/* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
796 * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
797
798/*
799 * What's pending for being reactivated at the ":endtry" of this try
800 * conditional:
801 */
802# define CSTP_NONE 0 /* nothing pending in ":finally" clause */
803# define CSTP_ERROR 1 /* an error is pending */
804# define CSTP_INTERRUPT 2 /* an interrupt is pending */
805# define CSTP_THROW 4 /* a throw is pending */
806# define CSTP_BREAK 8 /* ":break" is pending */
807# define CSTP_CONTINUE 16 /* ":continue" is pending */
808# define CSTP_RETURN 24 /* ":return" is pending */
809# define CSTP_FINISH 32 /* ":finish" is pending */
810
811/*
Bram Moolenaar12805862005-01-05 22:16:17 +0000812 * Flags for the cs_lflags item in struct condstack.
813 */
814# define CSL_HAD_LOOP 1 /* just found ":while" or ":for" */
815# define CSL_HAD_ENDLOOP 2 /* just found ":endwhile" or ":endfor" */
816# define CSL_HAD_CONT 4 /* just found ":continue" */
817# define CSL_HAD_FINA 8 /* just found ":finally" */
818
819/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 * A list of error messages that can be converted to an exception. "throw_msg"
821 * is only set in the first element of the list. Usually, it points to the
822 * original message stored in that element, but sometimes it points to a later
823 * message in the list. See cause_errthrow() below.
824 */
825struct msglist
826{
827 char_u *msg; /* original message */
828 char_u *throw_msg; /* msg to throw: usually original one */
829 struct msglist *next; /* next of several messages in a row */
830};
831
832/*
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100833 * The exception types.
834 */
835typedef enum
836{
837 ET_USER, /* exception caused by ":throw" command */
838 ET_ERROR, /* error exception */
839 ET_INTERRUPT /* interrupt exception triggered by Ctrl-C */
840} except_type_T;
841
842/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 * Structure describing an exception.
844 * (don't use "struct exception", it's used by the math library).
845 */
846typedef struct vim_exception except_T;
847struct vim_exception
848{
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100849 except_type_T type; /* exception type */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 char_u *value; /* exception value */
851 struct msglist *messages; /* message(s) causing error exception */
852 char_u *throw_name; /* name of the throw point */
853 linenr_T throw_lnum; /* line number of the throw point */
854 except_T *caught; /* next exception on the caught stack */
855};
856
857/*
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000858 * Structure to save the error/interrupt/exception state between calls to
859 * enter_cleanup() and leave_cleanup(). Must be allocated as an automatic
860 * variable by the (common) caller of these functions.
861 */
862typedef struct cleanup_stuff cleanup_T;
863struct cleanup_stuff
864{
865 int pending; /* error/interrupt/exception state */
866 except_T *exception; /* exception value */
867};
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868
869#ifdef FEAT_SYN_HL
870/* struct passed to in_id_list() */
871struct sp_syn
872{
873 int inc_tag; /* ":syn include" unique tag */
874 short id; /* highlight group ID of item */
875 short *cont_in_list; /* cont.in group IDs, if non-zero */
876};
877
878/*
879 * Each keyword has one keyentry, which is linked in a hash list.
880 */
881typedef struct keyentry keyentry_T;
882
883struct keyentry
884{
Bram Moolenaar8f999f12005-01-25 22:12:55 +0000885 keyentry_T *ke_next; /* next entry with identical "keyword[]" */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 struct sp_syn k_syn; /* struct passed to in_id_list() */
887 short *next_list; /* ID list for next match (if non-zero) */
Bram Moolenaar860cae12010-06-05 23:22:07 +0200888 int flags;
889 int k_char; /* conceal substitute character */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 char_u keyword[1]; /* actually longer */
891};
892
893/*
894 * Struct used to store one state of the state stack.
895 */
896typedef struct buf_state
897{
898 int bs_idx; /* index of pattern */
Bram Moolenaar860cae12010-06-05 23:22:07 +0200899 int bs_flags; /* flags for pattern */
Bram Moolenaar6e202e52010-07-28 18:14:45 +0200900#ifdef FEAT_CONCEAL
901 int bs_seqnr; /* stores si_seqnr */
902 int bs_cchar; /* stores si_cchar */
903#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 reg_extmatch_T *bs_extmatch; /* external matches from start pattern */
905} bufstate_T;
906
907/*
908 * syn_state contains the syntax state stack for the start of one line.
909 * Used by b_sst_array[].
910 */
911typedef struct syn_state synstate_T;
912
913struct syn_state
914{
915 synstate_T *sst_next; /* next entry in used or free list */
916 linenr_T sst_lnum; /* line number for this state */
917 union
918 {
919 bufstate_T sst_stack[SST_FIX_STATES]; /* short state stack */
920 garray_T sst_ga; /* growarray for long state stack */
921 } sst_union;
922 int sst_next_flags; /* flags for sst_next_list */
Bram Moolenaar2767c602010-05-16 13:56:06 +0200923 int sst_stacksize; /* number of states on the stack */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 short *sst_next_list; /* "nextgroup" list in this state
925 * (this is a copy, don't free it! */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 disptick_T sst_tick; /* tick when last displayed */
927 linenr_T sst_change_lnum;/* when non-zero, change in this line
928 * may have made the state invalid */
929};
930#endif /* FEAT_SYN_HL */
931
932/*
933 * Structure shared between syntax.c, screen.c and gui_x11.c.
934 */
935typedef struct attr_entry
936{
937 short ae_attr; /* HL_BOLD, etc. */
938 union
939 {
940 struct
941 {
942 char_u *start; /* start escape sequence */
943 char_u *stop; /* stop escape sequence */
944 } term;
945 struct
946 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000947 /* These colors need to be > 8 bits to hold 256. */
948 short_u fg_color; /* foreground color number */
949 short_u bg_color; /* background color number */
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200950# ifdef FEAT_TERMGUICOLORS
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +0200951 guicolor_T fg_rgb; /* foreground color RGB */
952 guicolor_T bg_rgb; /* background color RGB */
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200953# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 } cterm;
955# ifdef FEAT_GUI
956 struct
957 {
958 guicolor_T fg_color; /* foreground color handle */
959 guicolor_T bg_color; /* background color handle */
Bram Moolenaare2cc9702005-03-15 22:43:58 +0000960 guicolor_T sp_color; /* special color handle */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961 GuiFont font; /* font handle */
962# ifdef FEAT_XFONTSET
963 GuiFontset fontset; /* fontset handle */
964# endif
965 } gui;
966# endif
967 } ae_u;
968} attrentry_T;
969
970#ifdef USE_ICONV
971# ifdef HAVE_ICONV_H
972# include <iconv.h>
973# else
974# if defined(MACOS_X)
975# include <sys/errno.h>
976# define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
977typedef struct _iconv_t *iconv_t;
978# else
979# if defined(MACOS_CLASSIC)
980typedef struct _iconv_t *iconv_t;
981# define EINVAL 22
982# define E2BIG 7
983# define ENOENT 2
984# define EFAULT 14
985# define EILSEQ 123
986# else
987# include <errno.h>
988# endif
989# endif
990typedef void *iconv_t;
991# endif
992#endif
993
994/*
995 * Used for the typeahead buffer: typebuf.
996 */
997typedef struct
998{
999 char_u *tb_buf; /* buffer for typed characters */
1000 char_u *tb_noremap; /* mapping flags for characters in tb_buf[] */
1001 int tb_buflen; /* size of tb_buf[] */
1002 int tb_off; /* current position in tb_buf[] */
1003 int tb_len; /* number of valid bytes in tb_buf[] */
1004 int tb_maplen; /* nr of mapped bytes in tb_buf[] */
1005 int tb_silent; /* nr of silently mapped bytes in tb_buf[] */
1006 int tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */
1007 int tb_change_cnt; /* nr of time tb_buf was changed; never zero */
1008} typebuf_T;
1009
1010/* Struct to hold the saved typeahead for save_typeahead(). */
1011typedef struct
1012{
1013 typebuf_T save_typebuf;
1014 int typebuf_valid; /* TRUE when save_typebuf valid */
Bram Moolenaar13df0fe2009-07-09 16:24:19 +00001015 int old_char;
1016 int old_mod_mask;
Bram Moolenaar0a36fec2014-02-11 15:10:43 +01001017 buffheader_T save_readbuf1;
1018 buffheader_T save_readbuf2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019#ifdef USE_INPUT_BUF
1020 char_u *save_inputbuf;
1021#endif
1022} tasave_T;
1023
1024/*
1025 * Used for conversion of terminal I/O and script files.
1026 */
1027typedef struct
1028{
1029 int vc_type; /* zero or one of the CONV_ values */
1030 int vc_factor; /* max. expansion factor */
1031# ifdef WIN3264
1032 int vc_cpfrom; /* codepage to convert from (CONV_CODEPAGE) */
1033 int vc_cpto; /* codepage to convert to (CONV_CODEPAGE) */
1034# endif
1035# ifdef USE_ICONV
1036 iconv_t vc_fd; /* for CONV_ICONV */
1037# endif
1038 int vc_fail; /* fail for invalid char, don't use '?' */
1039} vimconv_T;
1040
1041/*
1042 * Structure used for reading from the viminfo file.
1043 */
1044typedef struct
1045{
1046 char_u *vir_line; /* text of the current line */
1047 FILE *vir_fd; /* file descriptor */
1048#ifdef FEAT_MBYTE
1049 vimconv_T vir_conv; /* encoding conversion */
1050#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001051 int vir_version; /* viminfo version detected or -1 */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001052 garray_T vir_barlines; /* lines starting with | */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053} vir_T;
1054
1055#define CONV_NONE 0
1056#define CONV_TO_UTF8 1
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001057#define CONV_9_TO_UTF8 2
1058#define CONV_TO_LATIN1 3
1059#define CONV_TO_LATIN9 4
1060#define CONV_ICONV 5
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061#ifdef WIN3264
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001062# define CONV_CODEPAGE 10 /* codepage -> codepage */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063#endif
1064#ifdef MACOS_X
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001065# define CONV_MAC_LATIN1 20
1066# define CONV_LATIN1_MAC 21
1067# define CONV_MAC_UTF8 22
1068# define CONV_UTF8_MAC 23
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069#endif
1070
1071/*
1072 * Structure used for mappings and abbreviations.
1073 */
1074typedef struct mapblock mapblock_T;
1075struct mapblock
1076{
1077 mapblock_T *m_next; /* next mapblock in list */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001078 char_u *m_keys; /* mapped from, lhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001079 char_u *m_str; /* mapped to, rhs */
1080 char_u *m_orig_str; /* rhs as entered by the user */
Bram Moolenaarf3fe3922013-06-29 14:47:22 +02001081 int m_keylen; /* strlen(m_keys) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 int m_mode; /* valid mode */
1083 int m_noremap; /* if non-zero no re-mapping for m_str */
1084 char m_silent; /* <silent> used, don't echo commands */
Bram Moolenaarf3fe3922013-06-29 14:47:22 +02001085 char m_nowait; /* <nowait> used */
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001086#ifdef FEAT_EVAL
Bram Moolenaara94bc432006-03-10 21:42:59 +00001087 char m_expr; /* <expr> used, m_str is an expression */
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001088 scid_T m_script_ID; /* ID of script where map was defined */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089#endif
1090};
1091
1092/*
1093 * Used for highlighting in the status line.
1094 */
1095struct stl_hlrec
1096{
1097 char_u *start;
Bram Moolenaar238a5642006-02-21 22:12:05 +00001098 int userhl; /* 0: no HL, 1-9: User HL, < 0 for syn ID */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099};
1100
Bram Moolenaar860cae12010-06-05 23:22:07 +02001101
1102/*
1103 * Syntax items - usually buffer-specific.
1104 */
1105
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001106/* Item for a hashtable. "hi_key" can be one of three values:
1107 * NULL: Never been used
1108 * HI_KEY_REMOVED: Entry was removed
1109 * Otherwise: Used item, pointer to the actual key; this usually is
1110 * inside the item, subtract an offset to locate the item.
1111 * This reduces the size of hashitem by 1/3.
1112 */
1113typedef struct hashitem_S
1114{
1115 long_u hi_hash; /* cached hash number of hi_key */
1116 char_u *hi_key;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001117} hashitem_T;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001118
1119/* The address of "hash_removed" is used as a magic number for hi_key to
1120 * indicate a removed item. */
1121#define HI_KEY_REMOVED &hash_removed
1122#define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
1123
1124/* Initial size for a hashtable. Our items are relatively small and growing
1125 * is expensive, thus use 16 as a start. Must be a power of 2. */
1126#define HT_INIT_SIZE 16
1127
1128typedef struct hashtable_S
1129{
1130 long_u ht_mask; /* mask used for hash value (nr of items in
1131 * array is "ht_mask" + 1) */
Bram Moolenaar677ee682005-01-27 14:41:15 +00001132 long_u ht_used; /* number of items used */
1133 long_u ht_filled; /* number of items used + removed */
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001134 int ht_locked; /* counter for hash_lock() */
1135 int ht_error; /* when set growing failed, can't add more
1136 items before growing works */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001137 hashitem_T *ht_array; /* points to the array, allocated when it's
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001138 not "ht_smallarray" */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001139 hashitem_T ht_smallarray[HT_INIT_SIZE]; /* initial array */
1140} hashtab_T;
1141
1142typedef long_u hash_T; /* Type for hi_hash */
1143
1144
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001145#ifdef FEAT_NUM64
1146/* Use 64-bit Number. */
1147# ifdef WIN3264
Bram Moolenaard90b6c02016-08-28 18:10:45 +02001148# ifdef PROTO
1149typedef long varnumber_T;
1150typedef unsigned long uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001151#define VARNUM_MIN LONG_MIN
1152#define VARNUM_MAX LONG_MAX
1153#define UVARNUM_MAX ULONG_MAX
Bram Moolenaard90b6c02016-08-28 18:10:45 +02001154# else
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001155typedef __int64 varnumber_T;
1156typedef unsigned __int64 uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001157#define VARNUM_MIN _I64_MIN
1158#define VARNUM_MAX _I64_MAX
1159#define UVARNUM_MAX _UI64_MAX
Bram Moolenaard90b6c02016-08-28 18:10:45 +02001160# endif
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001161# elif defined(HAVE_STDINT_H)
1162typedef int64_t varnumber_T;
1163typedef uint64_t uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001164#define VARNUM_MIN INT64_MIN
1165#define VARNUM_MAX INT64_MAX
1166#define UVARNUM_MAX UINT64_MAX
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001167# else
1168typedef long varnumber_T;
1169typedef unsigned long uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001170#define VARNUM_MIN LONG_MIN
1171#define VARNUM_MAX LONG_MAX
1172#define UVARNUM_MAX ULONG_MAX
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001173# endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001174#else
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001175/* Use 32-bit Number. */
1176# if VIM_SIZEOF_INT <= 3 /* use long if int is smaller than 32 bits */
1177typedef long varnumber_T;
1178typedef unsigned long uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001179#define VARNUM_MIN LONG_MIN
1180#define VARNUM_MAX LONG_MAX
1181#define UVARNUM_MAX ULONG_MAX
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001182# else
1183typedef int varnumber_T;
1184typedef unsigned int uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001185#define VARNUM_MIN INT_MIN
1186#define VARNUM_MAX INT_MAX
1187#define UVARNUM_MAX UINT_MAX
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001188# endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001189#endif
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001190
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001191typedef double float_T;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001192
1193typedef struct listvar_S list_T;
1194typedef struct dictvar_S dict_T;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001195typedef struct partial_S partial_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001196
Bram Moolenaar835dc632016-02-07 14:27:38 +01001197typedef struct jobvar_S job_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001198typedef struct readq_S readq_T;
1199typedef struct jsonq_S jsonq_T;
1200typedef struct cbq_S cbq_T;
1201typedef struct channel_S channel_T;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001202
Bram Moolenaara03f2332016-02-06 18:09:59 +01001203typedef enum
1204{
1205 VAR_UNKNOWN = 0,
Bram Moolenaar835dc632016-02-07 14:27:38 +01001206 VAR_NUMBER, /* "v_number" is used */
1207 VAR_STRING, /* "v_string" is used */
1208 VAR_FUNC, /* "v_string" is function name */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001209 VAR_PARTIAL, /* "v_partial" is used */
Bram Moolenaar835dc632016-02-07 14:27:38 +01001210 VAR_LIST, /* "v_list" is used */
1211 VAR_DICT, /* "v_dict" is used */
1212 VAR_FLOAT, /* "v_float" is used */
1213 VAR_SPECIAL, /* "v_number" is used */
Bram Moolenaar77073442016-02-13 23:23:53 +01001214 VAR_JOB, /* "v_job" is used */
1215 VAR_CHANNEL /* "v_channel" is used */
Bram Moolenaara03f2332016-02-06 18:09:59 +01001216} vartype_T;
1217
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001218/*
1219 * Structure to hold an internal variable without a name.
1220 */
1221typedef struct
1222{
Bram Moolenaara03f2332016-02-06 18:09:59 +01001223 vartype_T v_type;
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001224 char v_lock; /* see below: VAR_LOCKED, VAR_FIXED */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001225 union
1226 {
1227 varnumber_T v_number; /* number value */
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001228#ifdef FEAT_FLOAT
1229 float_T v_float; /* floating number value */
1230#endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001231 char_u *v_string; /* string value (can be NULL!) */
1232 list_T *v_list; /* list value (can be NULL!) */
1233 dict_T *v_dict; /* dict value (can be NULL!) */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001234 partial_T *v_partial; /* closure: function with args */
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01001235#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01001236 job_T *v_job; /* job value (can be NULL!) */
Bram Moolenaar77073442016-02-13 23:23:53 +01001237 channel_T *v_channel; /* channel value (can be NULL!) */
1238#endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001239 } vval;
1240} typval_T;
1241
Bram Moolenaarbdb62052012-07-16 17:31:53 +02001242/* Values for "dv_scope". */
1243#define VAR_SCOPE 1 /* a:, v:, s:, etc. scope dictionaries */
1244#define VAR_DEF_SCOPE 2 /* l:, g: scope dictionaries: here funcrefs are not
1245 allowed to mask existing functions */
1246
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001247/* Values for "v_lock". */
1248#define VAR_LOCKED 1 /* locked with lock(), can use unlock() */
1249#define VAR_FIXED 2 /* locked forever */
1250
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001251/*
1252 * Structure to hold an item of a list: an internal variable without a name.
1253 */
1254typedef struct listitem_S listitem_T;
1255
1256struct listitem_S
1257{
1258 listitem_T *li_next; /* next item in list */
1259 listitem_T *li_prev; /* previous item in list */
1260 typval_T li_tv; /* type and value of the variable */
1261};
1262
1263/*
1264 * Struct used by those that are using an item in a list.
1265 */
1266typedef struct listwatch_S listwatch_T;
1267
1268struct listwatch_S
1269{
1270 listitem_T *lw_item; /* item being watched */
1271 listwatch_T *lw_next; /* next watcher */
1272};
1273
1274/*
1275 * Structure to hold info about a list.
1276 */
1277struct listvar_S
1278{
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001279 listitem_T *lv_first; /* first item, NULL if none */
1280 listitem_T *lv_last; /* last item, NULL if none */
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00001281 int lv_refcount; /* reference count */
1282 int lv_len; /* number of items */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001283 listwatch_T *lv_watch; /* first watcher, NULL if none */
Bram Moolenaar748bf032005-02-02 23:04:36 +00001284 int lv_idx; /* cached index of an item */
1285 listitem_T *lv_idx_item; /* when not NULL item at index "lv_idx" */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001286 int lv_copyID; /* ID used by deepcopy() */
1287 list_T *lv_copylist; /* copied list used by deepcopy() */
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001288 char lv_lock; /* zero, VAR_LOCKED, VAR_FIXED */
Bram Moolenaar46152342005-09-07 21:18:43 +00001289 list_T *lv_used_next; /* next list in used lists list */
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00001290 list_T *lv_used_prev; /* previous list in used lists list */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001291};
1292
1293/*
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001294 * Static list with 10 items. Use init_static_list() to initialize.
1295 */
1296typedef struct {
1297 list_T sl_list; /* must be first */
1298 listitem_T sl_items[10];
1299} staticList10_T;
1300
1301/*
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001302 * Structure to hold an item of a Dictionary.
1303 * Also used for a variable.
1304 * The key is copied into "di_key" to avoid an extra alloc/free for it.
1305 */
1306struct dictitem_S
1307{
1308 typval_T di_tv; /* type and value of the variable */
1309 char_u di_flags; /* flags (only used for variable) */
1310 char_u di_key[1]; /* key (actually longer!) */
1311};
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001312typedef struct dictitem_S dictitem_T;
1313
Bram Moolenaarbee6c0c2016-03-25 15:40:50 +01001314/* A dictitem with a 16 character key (plus NUL). */
1315struct dictitem16_S
1316{
1317 typval_T di_tv; /* type and value of the variable */
1318 char_u di_flags; /* flags (only used for variable) */
1319 char_u di_key[17]; /* key */
1320};
1321typedef struct dictitem16_S dictitem16_T;
1322
Bram Moolenaar9bc174b2015-04-13 16:16:38 +02001323#define DI_FLAGS_RO 1 /* "di_flags" value: read-only variable */
1324#define DI_FLAGS_RO_SBX 2 /* "di_flags" value: read-only in the sandbox */
1325#define DI_FLAGS_FIX 4 /* "di_flags" value: fixed: no :unlet or remove() */
1326#define DI_FLAGS_LOCK 8 /* "di_flags" value: locked variable */
1327#define DI_FLAGS_ALLOC 16 /* "di_flags" value: separately allocated */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001328
1329/*
1330 * Structure to hold info about a Dictionary.
1331 */
1332struct dictvar_S
1333{
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001334 char dv_lock; /* zero, VAR_LOCKED, VAR_FIXED */
Bram Moolenaarbdb62052012-07-16 17:31:53 +02001335 char dv_scope; /* zero, VAR_SCOPE, VAR_DEF_SCOPE */
Bram Moolenaar6395af82013-06-12 19:52:15 +02001336 int dv_refcount; /* reference count */
1337 int dv_copyID; /* ID used by deepcopy() */
1338 hashtab_T dv_hashtab; /* hashtab that refers to the items */
1339 dict_T *dv_copydict; /* copied dict used by deepcopy() */
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00001340 dict_T *dv_used_next; /* next dict in used dicts list */
1341 dict_T *dv_used_prev; /* previous dict in used dicts list */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001342};
1343
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001344#if defined(FEAT_EVAL) || defined(PROTO)
1345typedef struct funccall_S funccall_T;
1346
1347/*
1348 * Structure to hold info for a user function.
1349 */
1350typedef struct
1351{
1352 int uf_varargs; /* variable nr of arguments */
1353 int uf_flags;
1354 int uf_calls; /* nr of active calls */
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001355 int uf_cleared; /* func_clear() was already called */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001356 garray_T uf_args; /* arguments */
1357 garray_T uf_lines; /* function lines */
1358#ifdef FEAT_PROFILE
1359 int uf_profiling; /* TRUE when func is being profiled */
1360 /* profiling the function as a whole */
1361 int uf_tm_count; /* nr of calls */
1362 proftime_T uf_tm_total; /* time spent in function + children */
1363 proftime_T uf_tm_self; /* time spent in function itself */
1364 proftime_T uf_tm_children; /* time spent in children this call */
1365 /* profiling the function per line */
1366 int *uf_tml_count; /* nr of times line was executed */
1367 proftime_T *uf_tml_total; /* time spent in a line + children */
1368 proftime_T *uf_tml_self; /* time spent in a line itself */
1369 proftime_T uf_tml_start; /* start time for current line */
1370 proftime_T uf_tml_children; /* time spent in children for this line */
1371 proftime_T uf_tml_wait; /* start wait time for current line */
1372 int uf_tml_idx; /* index of line being timed; -1 if none */
1373 int uf_tml_execed; /* line being timed was executed */
1374#endif
1375 scid_T uf_script_ID; /* ID of script where function was defined,
1376 used for s: variables */
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001377 int uf_refcount; /* reference count, see func_name_refcount() */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001378 funccall_T *uf_scoped; /* l: local variables for closure */
1379 char_u uf_name[1]; /* name of function (actually longer); can
1380 start with <SNR>123_ (<SNR> is K_SPECIAL
1381 KS_EXTRA KE_SNR) */
1382} ufunc_T;
1383
1384#define MAX_FUNC_ARGS 20 /* maximum number of function arguments */
1385#define VAR_SHORT_LEN 20 /* short variable name length */
1386#define FIXVAR_CNT 12 /* number of fixed variables */
1387
1388/* structure to hold info for a function that is currently being executed. */
1389struct funccall_S
1390{
1391 ufunc_T *func; /* function being called */
1392 int linenr; /* next line to be executed */
1393 int returned; /* ":return" used */
1394 struct /* fixed variables for arguments */
1395 {
1396 dictitem_T var; /* variable (without room for name) */
1397 char_u room[VAR_SHORT_LEN]; /* room for the name */
1398 } fixvar[FIXVAR_CNT];
1399 dict_T l_vars; /* l: local function variables */
1400 dictitem_T l_vars_var; /* variable for l: scope */
1401 dict_T l_avars; /* a: argument variables */
1402 dictitem_T l_avars_var; /* variable for a: scope */
1403 list_T l_varlist; /* list for a:000 */
1404 listitem_T l_listitems[MAX_FUNC_ARGS]; /* listitems for a:000 */
1405 typval_T *rettv; /* return value */
1406 linenr_T breakpoint; /* next line with breakpoint or zero */
1407 int dbg_tick; /* debug_tick when breakpoint was set */
1408 int level; /* top nesting level of executed function */
1409#ifdef FEAT_PROFILE
1410 proftime_T prof_child; /* time spent in a child */
1411#endif
1412 funccall_T *caller; /* calling function or NULL */
1413
1414 /* for closure */
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001415 int fc_refcount; /* number of user functions that reference this
1416 * funccal */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001417 int fc_copyID; /* for garbage collection */
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001418 garray_T fc_funcs; /* list of ufunc_T* which keep a reference to
1419 * "func" */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001420};
1421
1422/*
1423 * Struct used by trans_function_name()
1424 */
1425typedef struct
1426{
1427 dict_T *fd_dict; /* Dictionary used */
1428 char_u *fd_newkey; /* new key in "dict" in allocated memory */
1429 dictitem_T *fd_di; /* Dictionary item used */
1430} funcdict_T;
1431
Bram Moolenaaracadbea2016-08-01 16:35:59 +02001432#else
1433/* dummy typedefs for function prototypes */
1434typedef struct
1435{
1436 int dummy;
1437} ufunc_T;
1438typedef struct
1439{
1440 int dummy;
1441} funcdict_T;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001442#endif
1443
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001444struct partial_S
1445{
1446 int pt_refcount; /* reference count */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001447 char_u *pt_name; /* function name; when NULL use
1448 * pt_func->uf_name */
1449 ufunc_T *pt_func; /* function pointer; when NULL lookup function
1450 * with pt_name */
Bram Moolenaar1d429612016-05-24 15:44:17 +02001451 int pt_auto; /* when TRUE the partial was created for using
1452 dict.member in handle_subscript() */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001453 int pt_argc; /* number of arguments */
1454 typval_T *pt_argv; /* arguments in allocated array */
1455 dict_T *pt_dict; /* dict for "self" */
1456};
1457
Bram Moolenaar7df915d2016-11-17 17:25:32 +01001458/* Status of a job. Order matters! */
Bram Moolenaar835dc632016-02-07 14:27:38 +01001459typedef enum
1460{
1461 JOB_FAILED,
1462 JOB_STARTED,
Bram Moolenaar7df915d2016-11-17 17:25:32 +01001463 JOB_ENDED, /* detected job done */
1464 JOB_FINISHED /* job done and cleanup done */
Bram Moolenaar835dc632016-02-07 14:27:38 +01001465} jobstatus_T;
1466
1467/*
1468 * Structure to hold info about a Job.
1469 */
1470struct jobvar_S
1471{
Bram Moolenaar65edff82016-02-21 16:40:11 +01001472 job_T *jv_next;
1473 job_T *jv_prev;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001474#ifdef UNIX
1475 pid_t jv_pid;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001476#endif
1477#ifdef WIN32
Bram Moolenaar76467df2016-02-12 19:30:26 +01001478 PROCESS_INFORMATION jv_proc_info;
Bram Moolenaar14207f42016-10-27 21:13:10 +02001479 HANDLE jv_job_object;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001480#endif
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001481 char_u *jv_tty_name; /* controlling tty, allocated */
Bram Moolenaar835dc632016-02-07 14:27:38 +01001482 jobstatus_T jv_status;
Bram Moolenaar65edff82016-02-21 16:40:11 +01001483 char_u *jv_stoponexit; /* allocated */
Bram Moolenaareab089d2016-02-21 19:32:02 +01001484 int jv_exitval;
Bram Moolenaaree1cffc2016-02-21 19:14:41 +01001485 char_u *jv_exit_cb; /* allocated */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001486 partial_T *jv_exit_partial;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001487
Bram Moolenaar014069a2016-03-03 22:51:40 +01001488 buf_T *jv_in_buf; /* buffer from "in-name" */
1489
Bram Moolenaar835dc632016-02-07 14:27:38 +01001490 int jv_refcount; /* reference count */
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02001491 int jv_copyID;
1492
Bram Moolenaar77073442016-02-13 23:23:53 +01001493 channel_T *jv_channel; /* channel for I/O, reference counted */
Bram Moolenaar835dc632016-02-07 14:27:38 +01001494};
1495
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001496/*
1497 * Structures to hold info about a Channel.
1498 */
1499struct readq_S
1500{
Bram Moolenaar77073442016-02-13 23:23:53 +01001501 char_u *rq_buffer;
Bram Moolenaar9ed96ef2016-06-04 17:17:11 +02001502 long_u rq_buflen;
Bram Moolenaar77073442016-02-13 23:23:53 +01001503 readq_T *rq_next;
1504 readq_T *rq_prev;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001505};
1506
1507struct jsonq_S
1508{
Bram Moolenaar77073442016-02-13 23:23:53 +01001509 typval_T *jq_value;
1510 jsonq_T *jq_next;
1511 jsonq_T *jq_prev;
Bram Moolenaar958dc692016-12-01 15:34:12 +01001512 int jq_no_callback; /* TRUE when no callback was found */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001513};
1514
1515struct cbq_S
1516{
Bram Moolenaar77073442016-02-13 23:23:53 +01001517 char_u *cq_callback;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001518 partial_T *cq_partial;
Bram Moolenaar77073442016-02-13 23:23:53 +01001519 int cq_seq_nr;
1520 cbq_T *cq_next;
1521 cbq_T *cq_prev;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001522};
1523
1524/* mode for a channel */
1525typedef enum
1526{
Bram Moolenaar77073442016-02-13 23:23:53 +01001527 MODE_NL = 0,
1528 MODE_RAW,
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001529 MODE_JSON,
1530 MODE_JS
1531} ch_mode_T;
1532
Bram Moolenaar580984e2016-03-20 21:17:13 +01001533typedef enum {
1534 JIO_PIPE, /* default */
1535 JIO_NULL,
1536 JIO_FILE,
1537 JIO_BUFFER,
1538 JIO_OUT
1539} job_io_T;
1540
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001541#define CH_PART_FD(part) ch_part[part].ch_fd
1542
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01001543/* Ordering matters, it is used in for loops: IN is last, only SOCK/OUT/ERR
1544 * are polled. */
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001545typedef enum {
1546 PART_SOCK = 0,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001547#define CH_SOCK_FD CH_PART_FD(PART_SOCK)
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01001548#ifdef FEAT_JOB_CHANNEL
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001549 PART_OUT,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001550# define CH_OUT_FD CH_PART_FD(PART_OUT)
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001551 PART_ERR,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001552# define CH_ERR_FD CH_PART_FD(PART_ERR)
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001553 PART_IN,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001554# define CH_IN_FD CH_PART_FD(PART_IN)
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001555#endif
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001556 PART_COUNT
1557} ch_part_T;
1558
1559#define INVALID_FD (-1)
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001560
1561/* The per-fd info for a channel. */
1562typedef struct {
1563 sock_T ch_fd; /* socket/stdin/stdout/stderr, -1 if not used */
1564
1565# if defined(UNIX) && !defined(HAVE_SELECT)
1566 int ch_poll_idx; /* used by channel_poll_setup() */
1567# endif
1568
1569#ifdef FEAT_GUI_X11
1570 XtInputId ch_inputHandler; /* Cookie for input */
1571#endif
1572#ifdef FEAT_GUI_GTK
1573 gint ch_inputHandler; /* Cookie for input */
1574#endif
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001575
1576 ch_mode_T ch_mode;
Bram Moolenaar580984e2016-03-20 21:17:13 +01001577 job_io_T ch_io;
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001578 int ch_timeout; /* request timeout in msec */
1579
1580 readq_T ch_head; /* header for circular raw read queue */
1581 jsonq_T ch_json_head; /* header for circular json read queue */
1582 int ch_block_id; /* ID that channel_read_json_block() is
1583 waiting for */
Bram Moolenaar88989cc2017-02-06 21:56:09 +01001584 /* When ch_wait_len is non-zero use ch_deadline to wait for incomplete
1585 * message to be complete. The value is the length of the incomplete
1586 * message when the deadline was set. If it gets longer (something was
1587 * received) the deadline is reset. */
1588 size_t ch_wait_len;
Bram Moolenaarba61ac02016-03-20 16:40:37 +01001589#ifdef WIN32
1590 DWORD ch_deadline;
1591#else
1592 struct timeval ch_deadline;
1593#endif
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02001594 int ch_block_write; /* for testing: 0 when not used, -1 when write
1595 * does not block, 1 simulate blocking */
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001596
1597 cbq_T ch_cb_head; /* dummy node for per-request callbacks */
1598 char_u *ch_callback; /* call when a msg is not handled */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001599 partial_T *ch_partial;
Bram Moolenaar014069a2016-03-03 22:51:40 +01001600
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001601 bufref_T ch_bufref; /* buffer to read from or write to */
Bram Moolenaar9f5842e2016-05-29 16:17:08 +02001602 int ch_nomodifiable; /* TRUE when buffer can be 'nomodifiable' */
1603 int ch_nomod_error; /* TRUE when e_modifiable was given */
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02001604 int ch_buf_append; /* write appended lines instead top-bot */
Bram Moolenaar014069a2016-03-03 22:51:40 +01001605 linenr_T ch_buf_top; /* next line to send */
1606 linenr_T ch_buf_bot; /* last line to send */
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001607} chanpart_T;
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001608
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001609struct channel_S {
Bram Moolenaar77073442016-02-13 23:23:53 +01001610 channel_T *ch_next;
1611 channel_T *ch_prev;
1612
1613 int ch_id; /* ID of the channel */
Bram Moolenaare9d6a292016-03-20 19:31:33 +01001614 int ch_last_msg_id; /* ID of the last message */
Bram Moolenaar77073442016-02-13 23:23:53 +01001615
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001616 chanpart_T ch_part[PART_COUNT]; /* info for socket, out, err and in */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001617
Bram Moolenaar580984e2016-03-20 21:17:13 +01001618 char *ch_hostname; /* only for socket, allocated */
1619 int ch_port; /* only for socket */
1620
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001621 int ch_to_be_closed; /* bitset of readable fds to be closed.
1622 * When all readable fds have been closed,
1623 * set to (1 << PART_COUNT). */
Bram Moolenaarfb6ffc72016-05-09 17:58:04 +02001624 int ch_to_be_freed; /* When TRUE channel must be freed when it's
1625 * safe to invoke callbacks. */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001626 int ch_error; /* When TRUE an error was reported. Avoids
1627 * giving pages full of error messages when
1628 * the other side has exited, only mention the
1629 * first error until the connection works
1630 * again. */
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01001631
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001632 void (*ch_nb_close_cb)(void);
1633 /* callback for Netbeans when channel is
1634 * closed */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001635
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001636 char_u *ch_callback; /* call when any msg is not handled */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001637 partial_T *ch_partial;
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001638 char_u *ch_close_cb; /* call when channel is closed */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001639 partial_T *ch_close_partial;
Bram Moolenaar958dc692016-12-01 15:34:12 +01001640 int ch_drop_never;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001641
Bram Moolenaar77073442016-02-13 23:23:53 +01001642 job_T *ch_job; /* Job that uses this channel; this does not
1643 * count as a reference to avoid a circular
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02001644 * reference, the job refers to the channel. */
Bram Moolenaar46c85432016-02-26 11:17:46 +01001645 int ch_job_killed; /* TRUE when there was a job and it was killed
1646 * or we know it died. */
Bram Moolenaar77073442016-02-13 23:23:53 +01001647
1648 int ch_refcount; /* reference count */
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02001649 int ch_copyID;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001650};
1651
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001652#define JO_MODE 0x0001 /* channel mode */
1653#define JO_IN_MODE 0x0002 /* stdin mode */
1654#define JO_OUT_MODE 0x0004 /* stdout mode */
1655#define JO_ERR_MODE 0x0008 /* stderr mode */
1656#define JO_CALLBACK 0x0010 /* channel callback */
1657#define JO_OUT_CALLBACK 0x0020 /* stdout callback */
1658#define JO_ERR_CALLBACK 0x0040 /* stderr callback */
1659#define JO_CLOSE_CALLBACK 0x0080 /* close callback */
1660#define JO_WAITTIME 0x0100 /* only for ch_open() */
1661#define JO_TIMEOUT 0x0200 /* all timeouts */
1662#define JO_OUT_TIMEOUT 0x0400 /* stdout timeouts */
1663#define JO_ERR_TIMEOUT 0x0800 /* stderr timeouts */
1664#define JO_PART 0x1000 /* "part" */
1665#define JO_ID 0x2000 /* "id" */
1666#define JO_STOPONEXIT 0x4000 /* "stoponexit" */
Bram Moolenaard6c2f052016-03-14 23:22:59 +01001667#define JO_EXIT_CB 0x8000 /* "exit_cb" */
1668#define JO_OUT_IO 0x10000 /* "out_io" */
1669#define JO_ERR_IO 0x20000 /* "err_io" (JO_OUT_IO << 1) */
1670#define JO_IN_IO 0x40000 /* "in_io" (JO_OUT_IO << 2) */
1671#define JO_OUT_NAME 0x80000 /* "out_name" */
1672#define JO_ERR_NAME 0x100000 /* "err_name" (JO_OUT_NAME << 1) */
1673#define JO_IN_NAME 0x200000 /* "in_name" (JO_OUT_NAME << 2) */
1674#define JO_IN_TOP 0x400000 /* "in_top" */
1675#define JO_IN_BOT 0x800000 /* "in_bot" */
1676#define JO_OUT_BUF 0x1000000 /* "out_buf" */
1677#define JO_ERR_BUF 0x2000000 /* "err_buf" (JO_OUT_BUF << 1) */
1678#define JO_IN_BUF 0x4000000 /* "in_buf" (JO_OUT_BUF << 2) */
Bram Moolenaarde279892016-03-11 22:19:44 +01001679#define JO_CHANNEL 0x8000000 /* "channel" */
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02001680#define JO_BLOCK_WRITE 0x10000000 /* "block_write" */
Bram Moolenaar9f5842e2016-05-29 16:17:08 +02001681#define JO_OUT_MODIFIABLE 0x20000000 /* "out_modifiable" */
1682#define JO_ERR_MODIFIABLE 0x40000000 /* "err_modifiable" (JO_OUT_ << 1) */
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02001683#define JO_ALL 0x7fffffff
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01001684
Bram Moolenaar169ebb02016-09-07 23:32:23 +02001685#define JO2_OUT_MSG 0x0001 /* "out_msg" */
1686#define JO2_ERR_MSG 0x0002 /* "err_msg" (JO_OUT_ << 1) */
1687#define JO2_ALL 0x0003
1688
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001689#define JO_MODE_ALL (JO_MODE + JO_IN_MODE + JO_OUT_MODE + JO_ERR_MODE)
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001690#define JO_CB_ALL \
1691 (JO_CALLBACK + JO_OUT_CALLBACK + JO_ERR_CALLBACK + JO_CLOSE_CALLBACK)
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001692#define JO_TIMEOUT_ALL (JO_TIMEOUT + JO_OUT_TIMEOUT + JO_ERR_TIMEOUT)
1693
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01001694/*
Bram Moolenaar910b8aa2016-02-16 21:03:07 +01001695 * Options for job and channel commands.
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01001696 */
1697typedef struct
1698{
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01001699 int jo_set; /* JO_ bits for values that were set */
Bram Moolenaar169ebb02016-09-07 23:32:23 +02001700 int jo_set2; /* JO2_ bits for values that were set */
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01001701
1702 ch_mode_T jo_mode;
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001703 ch_mode_T jo_in_mode;
1704 ch_mode_T jo_out_mode;
1705 ch_mode_T jo_err_mode;
Bram Moolenaar187db502016-02-27 14:44:26 +01001706
1707 job_io_T jo_io[4]; /* PART_OUT, PART_ERR, PART_IN */
1708 char_u jo_io_name_buf[4][NUMBUFLEN];
1709 char_u *jo_io_name[4]; /* not allocated! */
Bram Moolenaar29fd0382016-03-09 23:14:07 +01001710 int jo_io_buf[4];
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02001711 int jo_pty;
Bram Moolenaar9f5842e2016-05-29 16:17:08 +02001712 int jo_modifiable[4];
Bram Moolenaar169ebb02016-09-07 23:32:23 +02001713 int jo_message[4];
Bram Moolenaarde279892016-03-11 22:19:44 +01001714 channel_T *jo_channel;
Bram Moolenaar187db502016-02-27 14:44:26 +01001715
Bram Moolenaar014069a2016-03-03 22:51:40 +01001716 linenr_T jo_in_top;
1717 linenr_T jo_in_bot;
1718
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01001719 char_u *jo_callback; /* not allocated! */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001720 partial_T *jo_partial; /* not referenced! */
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001721 char_u *jo_out_cb; /* not allocated! */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001722 partial_T *jo_out_partial; /* not referenced! */
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001723 char_u *jo_err_cb; /* not allocated! */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001724 partial_T *jo_err_partial; /* not referenced! */
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001725 char_u *jo_close_cb; /* not allocated! */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001726 partial_T *jo_close_partial; /* not referenced! */
1727 char_u *jo_exit_cb; /* not allocated! */
1728 partial_T *jo_exit_partial; /* not referenced! */
Bram Moolenaar958dc692016-12-01 15:34:12 +01001729 int jo_drop_never;
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01001730 int jo_waittime;
1731 int jo_timeout;
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001732 int jo_out_timeout;
1733 int jo_err_timeout;
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02001734 int jo_block_write; /* for testing only */
Bram Moolenaar6f3a5442016-02-20 19:56:13 +01001735 int jo_part;
1736 int jo_id;
Bram Moolenaar65edff82016-02-21 16:40:11 +01001737 char_u jo_soe_buf[NUMBUFLEN];
1738 char_u *jo_stoponexit;
Bram Moolenaar58556cd2017-07-20 23:04:46 +02001739
1740#ifdef FEAT_TERMINAL
1741 /* when non-zero run the job in a terminal window of this size */
1742 int jo_term_rows;
1743 int jo_term_cols;
1744#endif
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01001745} jobopt_T;
1746
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001747
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01001748/* structure used for explicit stack while garbage collecting hash tables */
1749typedef struct ht_stack_S
1750{
1751 hashtab_T *ht;
1752 struct ht_stack_S *prev;
1753} ht_stack_T;
1754
1755/* structure used for explicit stack while garbage collecting lists */
1756typedef struct list_stack_S
1757{
1758 list_T *list;
1759 struct list_stack_S *prev;
1760} list_stack_T;
1761
Bram Moolenaarce0842a2005-07-18 21:58:11 +00001762/* values for b_syn_spell: what to do with toplevel text */
1763#define SYNSPL_DEFAULT 0 /* spell check if @Spell not defined */
1764#define SYNSPL_TOP 1 /* spell check toplevel text */
1765#define SYNSPL_NOTOP 2 /* don't spell check toplevel text */
1766
Bram Moolenaar4770d092006-01-12 23:22:24 +00001767/* avoid #ifdefs for when b_spell is not available */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00001768#ifdef FEAT_SPELL
Bram Moolenaar4770d092006-01-12 23:22:24 +00001769# define B_SPELL(buf) ((buf)->b_spell)
1770#else
1771# define B_SPELL(buf) (0)
1772#endif
1773
Bram Moolenaar76b92b22006-03-24 22:46:53 +00001774#ifdef FEAT_QUICKFIX
Bram Moolenaard12f5c12006-01-25 22:10:52 +00001775typedef struct qf_info_S qf_info_T;
Bram Moolenaar76b92b22006-03-24 22:46:53 +00001776#endif
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001777
Bram Moolenaarf7512552013-06-06 14:55:19 +02001778#ifdef FEAT_PROFILE
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001779/*
1780 * Used for :syntime: timing of executing a syntax pattern.
1781 */
1782typedef struct {
1783 proftime_T total; /* total time used */
1784 proftime_T slowest; /* time of slowest call */
1785 long count; /* nr of times used */
1786 long match; /* nr of times matched */
1787} syn_time_T;
1788#endif
1789
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001790#ifdef FEAT_CRYPT
1791/*
1792 * Structure to hold the type of encryption and the state of encryption or
1793 * decryption.
1794 */
1795typedef struct {
1796 int method_nr;
1797 void *method_state; /* method-specific state information */
1798} cryptstate_T;
1799
1800/* values for method_nr */
1801# define CRYPT_M_ZIP 0
1802# define CRYPT_M_BF 1
1803# define CRYPT_M_BF2 2
1804# define CRYPT_M_COUNT 3 /* number of crypt methods */
1805#endif
1806
1807
Bram Moolenaar362ce482012-06-06 19:02:45 +02001808/*
1809 * These are items normally related to a buffer. But when using ":ownsyntax"
1810 * a window may have its own instance.
1811 */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001812typedef struct {
1813#ifdef FEAT_SYN_HL
1814 hashtab_T b_keywtab; /* syntax keywords hash table */
1815 hashtab_T b_keywtab_ic; /* idem, ignore case */
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02001816 int b_syn_error; /* TRUE when error occurred in HL */
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02001817# ifdef FEAT_RELTIME
1818 int b_syn_slow; /* TRUE when 'redrawtime' reached */
1819# endif
Bram Moolenaar860cae12010-06-05 23:22:07 +02001820 int b_syn_ic; /* ignore case for :syn cmds */
1821 int b_syn_spell; /* SYNSPL_ values */
1822 garray_T b_syn_patterns; /* table for syntax patterns */
1823 garray_T b_syn_clusters; /* table for syntax clusters */
1824 int b_spell_cluster_id; /* @Spell cluster ID or 0 */
1825 int b_nospell_cluster_id; /* @NoSpell cluster ID or 0 */
1826 int b_syn_containedin; /* TRUE when there is an item with a
1827 "containedin" argument */
1828 int b_syn_sync_flags; /* flags about how to sync */
1829 short b_syn_sync_id; /* group to sync on */
1830 long b_syn_sync_minlines; /* minimal sync lines offset */
1831 long b_syn_sync_maxlines; /* maximal sync lines offset */
1832 long b_syn_sync_linebreaks; /* offset for multi-line pattern */
1833 char_u *b_syn_linecont_pat; /* line continuation pattern */
1834 regprog_T *b_syn_linecont_prog; /* line continuation program */
Bram Moolenaarf7512552013-06-06 14:55:19 +02001835#ifdef FEAT_PROFILE
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001836 syn_time_T b_syn_linecont_time;
1837#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +02001838 int b_syn_linecont_ic; /* ignore-case flag for above */
1839 int b_syn_topgrp; /* for ":syntax include" */
1840# ifdef FEAT_CONCEAL
1841 int b_syn_conceal; /* auto-conceal for :syn cmds */
1842# endif
1843# ifdef FEAT_FOLDING
1844 int b_syn_folditems; /* number of patterns with the HL_FOLD
1845 flag set */
1846# endif
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02001847 /*
1848 * b_sst_array[] contains the state stack for a number of lines, for the
1849 * start of that line (col == 0). This avoids having to recompute the
1850 * syntax state too often.
1851 * b_sst_array[] is allocated to hold the state for all displayed lines,
1852 * and states for 1 out of about 20 other lines.
1853 * b_sst_array pointer to an array of synstate_T
1854 * b_sst_len number of entries in b_sst_array[]
1855 * b_sst_first pointer to first used entry in b_sst_array[] or NULL
1856 * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL
1857 * b_sst_freecount number of free entries in b_sst_array[]
1858 * b_sst_check_lnum entries after this lnum need to be checked for
1859 * validity (MAXLNUM means no check needed)
1860 */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001861 synstate_T *b_sst_array;
1862 int b_sst_len;
1863 synstate_T *b_sst_first;
1864 synstate_T *b_sst_firstfree;
1865 int b_sst_freecount;
1866 linenr_T b_sst_check_lnum;
1867 short_u b_sst_lasttick; /* last display tick */
1868#endif /* FEAT_SYN_HL */
1869
1870#ifdef FEAT_SPELL
1871 /* for spell checking */
1872 garray_T b_langp; /* list of pointers to slang_T, see spell.c */
1873 char_u b_spell_ismw[256];/* flags: is midword char */
1874# ifdef FEAT_MBYTE
1875 char_u *b_spell_ismw_mb; /* multi-byte midword chars */
1876# endif
1877 char_u *b_p_spc; /* 'spellcapcheck' */
1878 regprog_T *b_cap_prog; /* program for 'spellcapcheck' */
1879 char_u *b_p_spf; /* 'spellfile' */
1880 char_u *b_p_spl; /* 'spelllang' */
Bram Moolenaarcc63c642013-11-12 04:44:01 +01001881# ifdef FEAT_MBYTE
1882 int b_cjk; /* all CJK letters as OK */
1883# endif
Bram Moolenaar860cae12010-06-05 23:22:07 +02001884#endif
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02001885#if !defined(FEAT_SYN_HL) && !defined(FEAT_SPELL)
1886 int dummy;
1887#endif
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01001888 char_u b_syn_chartab[32]; /* syntax iskeyword option */
1889 char_u *b_syn_isk; /* iskeyword option */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001890} synblock_T;
1891
1892
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893/*
1894 * buffer: structure that holds information about one file
1895 *
1896 * Several windows can share a single Buffer
1897 * A buffer is unallocated if there is no memfile for it.
1898 * A buffer is new if the associated file has never been loaded yet.
1899 */
1900
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901struct file_buffer
1902{
1903 memline_T b_ml; /* associated memline (also contains line
1904 count) */
1905
1906 buf_T *b_next; /* links in list of buffers */
1907 buf_T *b_prev;
1908
1909 int b_nwindows; /* nr of windows open on this buffer */
1910
1911 int b_flags; /* various BF_ flags */
Bram Moolenaar362ce482012-06-06 19:02:45 +02001912#ifdef FEAT_AUTOCMD
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02001913 int b_locked; /* Buffer is being closed or referenced, don't
1914 let autocommands wipe it out. */
Bram Moolenaar362ce482012-06-06 19:02:45 +02001915#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916
1917 /*
1918 * b_ffname has the full path of the file (NULL for no name).
1919 * b_sfname is the name as the user typed it (or NULL).
1920 * b_fname is the same as b_sfname, unless ":cd" has been done,
1921 * then it is the same as b_ffname (NULL for no name).
1922 */
1923 char_u *b_ffname; /* full path file name */
1924 char_u *b_sfname; /* short file name */
1925 char_u *b_fname; /* current file name */
1926
1927#ifdef UNIX
Bram Moolenaarf1726cc2009-05-13 18:48:16 +00001928 int b_dev_valid; /* TRUE when b_dev has a valid number */
1929 dev_t b_dev; /* device number */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 ino_t b_ino; /* inode number */
1931#endif
1932#ifdef FEAT_CW_EDITOR
1933 FSSpec b_FSSpec; /* MacOS File Identification */
1934#endif
1935#ifdef VMS
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001936 char b_fab_rfm; /* Record format */
1937 char b_fab_rat; /* Record attribute */
1938 unsigned int b_fab_mrs; /* Max record size */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001939#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 int b_fnum; /* buffer number for this file. */
Bram Moolenaar480778b2016-07-14 22:09:39 +02001941 char_u b_key[VIM_SIZEOF_INT * 2 + 1];
1942 /* key used for buf_hashtab, holds b_fnum as
1943 hex string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944
1945 int b_changed; /* 'modified': Set to TRUE if something in the
1946 file has been changed and not written out. */
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001947 dictitem16_T b_ct_di; /* holds the b:changedtick value in
1948 b_ct_di.di_tv.vval.v_number;
Bram Moolenaar79518e22017-02-17 16:31:35 +01001949 incremented for each change, also for undo */
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001950#define CHANGEDTICK(buf) ((buf)->b_ct_di.di_tv.vval.v_number)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951
1952 int b_saving; /* Set to TRUE if we are in the middle of
1953 saving the buffer. */
1954
1955 /*
1956 * Changes to a buffer require updating of the display. To minimize the
1957 * work, remember changes made and update everything at once.
1958 */
1959 int b_mod_set; /* TRUE when there are changes since the last
1960 time the display was updated */
1961 linenr_T b_mod_top; /* topmost lnum that was changed */
1962 linenr_T b_mod_bot; /* lnum below last changed line, AFTER the
1963 change */
1964 long b_mod_xlines; /* number of extra buffer lines inserted;
1965 negative when lines were deleted */
1966
1967 wininfo_T *b_wininfo; /* list of last used info for each window */
1968
1969 long b_mtime; /* last change time of original file */
1970 long b_mtime_read; /* last change time when reading */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001971 off_T b_orig_size; /* size of original file in bytes */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 int b_orig_mode; /* mode of original file */
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02001973#ifdef FEAT_VIMINFO
1974 time_T b_last_used; /* time when the buffer was last used; used
1975 * for viminfo */
1976#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977
1978 pos_T b_namedm[NMARKS]; /* current named marks (mark.c) */
1979
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 /* These variables are set when VIsual_active becomes FALSE */
Bram Moolenaara23ccb82006-02-27 00:08:02 +00001981 visualinfo_T b_visual;
Bram Moolenaarf7ff6e82014-03-23 15:13:05 +01001982#ifdef FEAT_EVAL
Bram Moolenaara23ccb82006-02-27 00:08:02 +00001983 int b_visual_mode_eval; /* b_visual.vi_mode for visualmode() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984#endif
1985
1986 pos_T b_last_cursor; /* cursor position when last unloading this
1987 buffer */
1988 pos_T b_last_insert; /* where Insert mode was left */
1989 pos_T b_last_change; /* position of last change: '. mark */
1990
1991#ifdef FEAT_JUMPLIST
1992 /*
1993 * the changelist contains old change positions
1994 */
1995 pos_T b_changelist[JUMPLISTSIZE];
1996 int b_changelistlen; /* number of active entries */
1997 int b_new_change; /* set by u_savecommon() */
1998#endif
1999
2000 /*
2001 * Character table, only used in charset.c for 'iskeyword'
2002 * 32 bytes of 8 bits: 1 bit per character 0-255.
2003 */
2004 char_u b_chartab[32];
2005
2006#ifdef FEAT_LOCALMAP
2007 /* Table used for mappings local to a buffer. */
2008 mapblock_T *(b_maphash[256]);
2009
2010 /* First abbreviation local to a buffer. */
2011 mapblock_T *b_first_abbr;
2012#endif
2013#ifdef FEAT_USR_CMDS
2014 /* User commands local to the buffer. */
2015 garray_T b_ucmds;
2016#endif
2017 /*
2018 * start and end of an operator, also used for '[ and ']
2019 */
2020 pos_T b_op_start;
Bram Moolenaarb1d90a32014-02-22 23:03:55 +01002021 pos_T b_op_start_orig; /* used for Insstart_orig */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 pos_T b_op_end;
2023
2024#ifdef FEAT_VIMINFO
2025 int b_marks_read; /* Have we read viminfo marks yet? */
2026#endif
2027
2028 /*
2029 * The following only used in undo.c.
2030 */
2031 u_header_T *b_u_oldhead; /* pointer to oldest header */
Bram Moolenaara9a568c2006-03-14 23:04:27 +00002032 u_header_T *b_u_newhead; /* pointer to newest header; may not be valid
2033 if b_u_curhead is not NULL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 u_header_T *b_u_curhead; /* pointer to current header */
2035 int b_u_numhead; /* current number of headers */
2036 int b_u_synced; /* entry lists are synced */
Bram Moolenaarca003e12006-03-17 23:19:38 +00002037 long b_u_seq_last; /* last used undo sequence number */
Bram Moolenaar730cde92010-06-27 05:18:54 +02002038 long b_u_save_nr_last; /* counter for last file write */
Bram Moolenaarca003e12006-03-17 23:19:38 +00002039 long b_u_seq_cur; /* hu_seq of header below which we are now */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002040 time_T b_u_time_cur; /* uh_time of header below which we are now */
Bram Moolenaar730cde92010-06-27 05:18:54 +02002041 long b_u_save_nr_cur; /* file write nr after which we are now */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042
2043 /*
2044 * variables for "U" command in undo.c
2045 */
2046 char_u *b_u_line_ptr; /* saved line for "U" command */
2047 linenr_T b_u_line_lnum; /* line number of line in u_line */
2048 colnr_T b_u_line_colnr; /* optional column number */
2049
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050#ifdef FEAT_INS_EXPAND
2051 int b_scanned; /* ^N/^P have scanned this buffer */
2052#endif
2053
2054 /* flags for use of ":lmap" and IM control */
2055 long b_p_iminsert; /* input mode for insert */
2056 long b_p_imsearch; /* input mode for search */
2057#define B_IMODE_USE_INSERT -1 /* Use b_p_iminsert value for search */
2058#define B_IMODE_NONE 0 /* Input via none */
2059#define B_IMODE_LMAP 1 /* Input via langmap */
2060#ifndef USE_IM_CONTROL
2061# define B_IMODE_LAST 1
2062#else
2063# define B_IMODE_IM 2 /* Input via input method */
2064# define B_IMODE_LAST 2
2065#endif
2066
2067#ifdef FEAT_KEYMAP
2068 short b_kmap_state; /* using "lmap" mappings */
2069# define KEYMAP_INIT 1 /* 'keymap' was set, call keymap_init() */
2070# define KEYMAP_LOADED 2 /* 'keymap' mappings have been loaded */
2071 garray_T b_kmap_ga; /* the keymap table */
2072#endif
2073
2074 /*
2075 * Options local to a buffer.
2076 * They are here because their value depends on the type of file
2077 * or contents of the file being edited.
2078 */
2079 int b_p_initialized; /* set when options initialized */
2080
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00002081#ifdef FEAT_EVAL
2082 int b_p_scriptID[BV_COUNT]; /* SIDs for buffer-local options */
2083#endif
2084
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 int b_p_ai; /* 'autoindent' */
2086 int b_p_ai_nopaste; /* b_p_ai saved for paste mode */
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02002087 char_u *b_p_bkc; /* 'backupcopy' */
2088 unsigned b_bkc_flags; /* flags for 'backupcopy' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 int b_p_ci; /* 'copyindent' */
2090 int b_p_bin; /* 'binary' */
2091#ifdef FEAT_MBYTE
2092 int b_p_bomb; /* 'bomb' */
2093#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 char_u *b_p_bh; /* 'bufhidden' */
2095 char_u *b_p_bt; /* 'buftype' */
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02002096#ifdef FEAT_QUICKFIX
Bram Moolenaarc1542742016-07-20 21:44:37 +02002097#define BUF_HAS_QF_ENTRY 1
2098#define BUF_HAS_LL_ENTRY 2
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002099 int b_has_qf_entry;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100#endif
2101 int b_p_bl; /* 'buflisted' */
2102#ifdef FEAT_CINDENT
2103 int b_p_cin; /* 'cindent' */
2104 char_u *b_p_cino; /* 'cinoptions' */
2105 char_u *b_p_cink; /* 'cinkeys' */
2106#endif
2107#if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
2108 char_u *b_p_cinw; /* 'cinwords' */
2109#endif
2110#ifdef FEAT_COMMENTS
2111 char_u *b_p_com; /* 'comments' */
2112#endif
2113#ifdef FEAT_FOLDING
2114 char_u *b_p_cms; /* 'commentstring' */
2115#endif
2116#ifdef FEAT_INS_EXPAND
2117 char_u *b_p_cpt; /* 'complete' */
2118#endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002119#ifdef FEAT_COMPL_FUNC
2120 char_u *b_p_cfu; /* 'completefunc' */
Bram Moolenaarf75a9632005-09-13 21:20:47 +00002121 char_u *b_p_ofu; /* 'omnifunc' */
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002122#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123 int b_p_eol; /* 'endofline' */
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002124 int b_p_fixeol; /* 'fixendofline' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 int b_p_et; /* 'expandtab' */
2126 int b_p_et_nobin; /* b_p_et saved for binary mode */
Bram Moolenaar54f018c2015-09-15 17:30:40 +02002127 int b_p_et_nopaste; /* b_p_et saved for paste mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128#ifdef FEAT_MBYTE
2129 char_u *b_p_fenc; /* 'fileencoding' */
2130#endif
2131 char_u *b_p_ff; /* 'fileformat' */
2132#ifdef FEAT_AUTOCMD
2133 char_u *b_p_ft; /* 'filetype' */
2134#endif
2135 char_u *b_p_fo; /* 'formatoptions' */
Bram Moolenaar86b68352004-12-27 21:59:20 +00002136 char_u *b_p_flp; /* 'formatlistpat' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 int b_p_inf; /* 'infercase' */
2138 char_u *b_p_isk; /* 'iskeyword' */
2139#ifdef FEAT_FIND_ID
2140 char_u *b_p_def; /* 'define' local value */
2141 char_u *b_p_inc; /* 'include' */
2142# ifdef FEAT_EVAL
2143 char_u *b_p_inex; /* 'includeexpr' */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002144 long_u b_p_inex_flags; /* flags for 'includeexpr' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145# endif
2146#endif
2147#if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
2148 char_u *b_p_inde; /* 'indentexpr' */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002149 long_u b_p_inde_flags; /* flags for 'indentexpr' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 char_u *b_p_indk; /* 'indentkeys' */
2151#endif
Bram Moolenaar9be7c042017-01-14 14:28:30 +01002152 char_u *b_p_fp; /* 'formatprg' */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002153#if defined(FEAT_EVAL)
2154 char_u *b_p_fex; /* 'formatexpr' */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002155 long_u b_p_fex_flags; /* flags for 'formatexpr' */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002156#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157#ifdef FEAT_CRYPT
2158 char_u *b_p_key; /* 'key' */
2159#endif
2160 char_u *b_p_kp; /* 'keywordprg' */
2161#ifdef FEAT_LISP
2162 int b_p_lisp; /* 'lisp' */
2163#endif
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01002164#ifdef FEAT_MBYTE
2165 char_u *b_p_menc; /* 'makeencoding' */
2166#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 char_u *b_p_mps; /* 'matchpairs' */
2168 int b_p_ml; /* 'modeline' */
2169 int b_p_ml_nobin; /* b_p_ml saved for binary mode */
2170 int b_p_ma; /* 'modifiable' */
2171 char_u *b_p_nf; /* 'nrformats' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 int b_p_pi; /* 'preserveindent' */
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002173#ifdef FEAT_TEXTOBJ
2174 char_u *b_p_qe; /* 'quoteescape' */
2175#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 int b_p_ro; /* 'readonly' */
2177 long b_p_sw; /* 'shiftwidth' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 int b_p_sn; /* 'shortname' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179#ifdef FEAT_SMARTINDENT
2180 int b_p_si; /* 'smartindent' */
2181#endif
2182 long b_p_sts; /* 'softtabstop' */
2183 long b_p_sts_nopaste; /* b_p_sts saved for paste mode */
2184#ifdef FEAT_SEARCHPATH
2185 char_u *b_p_sua; /* 'suffixesadd' */
2186#endif
2187 int b_p_swf; /* 'swapfile' */
2188#ifdef FEAT_SYN_HL
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00002189 long b_p_smc; /* 'synmaxcol' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 char_u *b_p_syn; /* 'syntax' */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002191#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 long b_p_ts; /* 'tabstop' */
2193 int b_p_tx; /* 'textmode' */
2194 long b_p_tw; /* 'textwidth' */
2195 long b_p_tw_nobin; /* b_p_tw saved for binary mode */
2196 long b_p_tw_nopaste; /* b_p_tw saved for paste mode */
2197 long b_p_wm; /* 'wrapmargin' */
2198 long b_p_wm_nobin; /* b_p_wm saved for binary mode */
2199 long b_p_wm_nopaste; /* b_p_wm saved for paste mode */
2200#ifdef FEAT_KEYMAP
2201 char_u *b_p_keymap; /* 'keymap' */
2202#endif
2203
2204 /* local values for options which are normally global */
2205#ifdef FEAT_QUICKFIX
2206 char_u *b_p_gp; /* 'grepprg' local value */
2207 char_u *b_p_mp; /* 'makeprg' local value */
2208 char_u *b_p_efm; /* 'errorformat' local value */
2209#endif
2210 char_u *b_p_ep; /* 'equalprg' local value */
2211 char_u *b_p_path; /* 'path' local value */
2212 int b_p_ar; /* 'autoread' local value */
2213 char_u *b_p_tags; /* 'tags' local value */
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01002214 char_u *b_p_tc; /* 'tagcase' local value */
2215 unsigned b_tc_flags; /* flags for 'tagcase' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216#ifdef FEAT_INS_EXPAND
2217 char_u *b_p_dict; /* 'dictionary' local value */
2218 char_u *b_p_tsr; /* 'thesaurus' local value */
2219#endif
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01002220 long b_p_ul; /* 'undolevels' local value */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02002221#ifdef FEAT_PERSISTENT_UNDO
2222 int b_p_udf; /* 'undofile' */
2223#endif
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01002224#ifdef FEAT_LISP
2225 char_u *b_p_lw; /* 'lispwords' local value */
2226#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227
2228 /* end of buffer options */
2229
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +01002230#ifdef FEAT_CINDENT
2231 /* values set from b_p_cino */
2232 int b_ind_level;
2233 int b_ind_open_imag;
2234 int b_ind_no_brace;
2235 int b_ind_first_open;
2236 int b_ind_open_extra;
2237 int b_ind_close_extra;
2238 int b_ind_open_left_imag;
2239 int b_ind_jump_label;
2240 int b_ind_case;
2241 int b_ind_case_code;
2242 int b_ind_case_break;
2243 int b_ind_param;
2244 int b_ind_func_type;
2245 int b_ind_comment;
2246 int b_ind_in_comment;
2247 int b_ind_in_comment2;
2248 int b_ind_cpp_baseclass;
2249 int b_ind_continuation;
2250 int b_ind_unclosed;
2251 int b_ind_unclosed2;
2252 int b_ind_unclosed_noignore;
2253 int b_ind_unclosed_wrapped;
2254 int b_ind_unclosed_whiteok;
2255 int b_ind_matching_paren;
2256 int b_ind_paren_prev;
2257 int b_ind_maxparen;
2258 int b_ind_maxcomment;
2259 int b_ind_scopedecl;
2260 int b_ind_scopedecl_code;
2261 int b_ind_java;
2262 int b_ind_js;
2263 int b_ind_keep_case_label;
2264 int b_ind_hash_comment;
2265 int b_ind_cpp_namespace;
2266 int b_ind_if_for_while;
Bram Moolenaar7720ba82017-03-08 22:19:26 +01002267 int b_ind_cpp_extern_c;
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +01002268#endif
2269
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01002270 linenr_T b_no_eol_lnum; /* non-zero lnum when last line of next binary
2271 * write should not have an end-of-line */
2272
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 int b_start_eol; /* last line had eol when it was read */
2274 int b_start_ffc; /* first char of 'ff' when edit started */
2275#ifdef FEAT_MBYTE
2276 char_u *b_start_fenc; /* 'fileencoding' when edit started or NULL */
Bram Moolenaara9b1e742005-12-19 22:14:58 +00002277 int b_bad_char; /* "++bad=" argument when edit started or 0 */
Bram Moolenaar83eb8852007-08-12 13:51:26 +00002278 int b_start_bomb; /* 'bomb' when it was read */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279#endif
2280
2281#ifdef FEAT_EVAL
Bram Moolenaar8f999f12005-01-25 22:12:55 +00002282 dictitem_T b_bufvar; /* variable for "b:" Dictionary */
Bram Moolenaar429fa852013-04-15 12:27:36 +02002283 dict_T *b_vars; /* internal variables, local to buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284#endif
2285
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002286#if defined(FEAT_BEVAL) && defined(FEAT_EVAL)
2287 char_u *b_p_bexpr; /* 'balloonexpr' local value */
2288 long_u b_p_bexpr_flags;/* flags for 'balloonexpr' */
2289#endif
Bram Moolenaar49771f42010-07-20 17:32:38 +02002290#ifdef FEAT_CRYPT
2291 char_u *b_p_cm; /* 'cryptmethod' */
2292#endif
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002293
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 /* When a buffer is created, it starts without a swap file. b_may_swap is
2295 * then set to indicate that a swap file may be opened later. It is reset
2296 * if a swap file could not be opened.
2297 */
2298 int b_may_swap;
2299 int b_did_warn; /* Set to 1 if user has been warned on first
2300 change of a read-only file */
Bram Moolenaar4770d092006-01-12 23:22:24 +00002301
2302 /* Two special kinds of buffers:
2303 * help buffer - used for help files, won't use a swap file.
2304 * spell buffer - used for spell info, never displayed and doesn't have a
2305 * file name.
2306 */
2307 int b_help; /* TRUE for help file buffer (when set b_p_bt
2308 is "help") */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002309#ifdef FEAT_SPELL
Bram Moolenaar4770d092006-01-12 23:22:24 +00002310 int b_spell; /* TRUE for a spell file buffer, most fields
2311 are not used! Use the B_SPELL macro to
2312 access b_spell without #ifdef. */
2313#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 int b_shortname; /* this file has an 8.3 file name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002317#ifdef FEAT_MZSCHEME
Bram Moolenaare344bea2005-09-01 20:46:49 +00002318 void *b_mzscheme_ref; /* The MzScheme reference to this buffer */
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002319#endif
2320
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321#ifdef FEAT_PERL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002322 void *b_perl_private;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323#endif
2324
2325#ifdef FEAT_PYTHON
Bram Moolenaare344bea2005-09-01 20:46:49 +00002326 void *b_python_ref; /* The Python reference to this buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327#endif
2328
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02002329#ifdef FEAT_PYTHON3
2330 void *b_python3_ref; /* The Python3 reference to this buffer */
2331#endif
2332
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333#ifdef FEAT_TCL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002334 void *b_tcl_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335#endif
2336
2337#ifdef FEAT_RUBY
Bram Moolenaare344bea2005-09-01 20:46:49 +00002338 void *b_ruby_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339#endif
2340
Bram Moolenaar860cae12010-06-05 23:22:07 +02002341#if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
2342 synblock_T b_s; /* Info related to syntax highlighting. w_s
2343 * normally points to this, but some windows
2344 * may use a different synblock_T. */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002345#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346
2347#ifdef FEAT_SIGNS
2348 signlist_T *b_signlist; /* list of signs to draw */
Bram Moolenaar3b7b8362015-03-20 18:11:48 +01002349# ifdef FEAT_NETBEANS_INTG
2350 int b_has_sign_column; /* Flag that is set when a first sign is
2351 * added and remains set until the end of
2352 * the netbeans session. */
2353# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354#endif
2355
2356#ifdef FEAT_NETBEANS_INTG
2357 int b_netbeans_file; /* TRUE when buffer is owned by NetBeans */
2358 int b_was_netbeans_file;/* TRUE if b_netbeans_file was once set */
2359#endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01002360#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar99ef0622016-03-06 20:22:25 +01002361 int b_write_to_channel; /* TRUE when appended lines are written to
2362 * a channel. */
2363#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002365#ifdef FEAT_CRYPT
2366 cryptstate_T *b_cryptstate; /* Encryption state while reading or writing
2367 * the file. NULL when not using encryption. */
2368#endif
Bram Moolenaar651863c2015-01-14 12:44:41 +01002369 int b_mapped_ctrl_c; /* modes where CTRL-C is mapped */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002370
Bram Moolenaare4f25e42017-07-07 11:54:15 +02002371#ifdef FEAT_TERMINAL
2372 term_T *b_term; /* When not NULL this buffer is for a terminal
2373 * window. */
2374#endif
2375
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002376}; /* file_buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002378
2379#ifdef FEAT_DIFF
2380/*
2381 * Stuff for diff mode.
2382 */
Bram Moolenaar015efc32016-08-24 22:34:33 +02002383# define DB_COUNT 8 /* up to eight buffers can be diff'ed */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002384
2385/*
2386 * Each diffblock defines where a block of lines starts in each of the buffers
2387 * and how many lines it occupies in that buffer. When the lines are missing
2388 * in the buffer the df_count[] is zero. This is all counted in
2389 * buffer lines.
2390 * There is always at least one unchanged line in between the diffs.
2391 * Otherwise it would have been included in the diff above or below it.
2392 * df_lnum[] + df_count[] is the lnum below the change. When in one buffer
2393 * lines have been inserted, in the other buffer df_lnum[] is the line below
2394 * the insertion and df_count[] is zero. When appending lines at the end of
2395 * the buffer, df_lnum[] is one beyond the end!
2396 * This is using a linked list, because the number of differences is expected
2397 * to be reasonable small. The list is sorted on lnum.
2398 */
2399typedef struct diffblock_S diff_T;
2400struct diffblock_S
2401{
2402 diff_T *df_next;
2403 linenr_T df_lnum[DB_COUNT]; /* line number in buffer */
2404 linenr_T df_count[DB_COUNT]; /* nr of inserted/changed lines */
2405};
2406#endif
2407
Bram Moolenaar746ebd32009-06-16 14:01:43 +00002408#define SNAP_HELP_IDX 0
2409#ifdef FEAT_AUTOCMD
2410# define SNAP_AUCMD_IDX 1
2411# define SNAP_COUNT 2
2412#else
2413# define SNAP_COUNT 1
2414#endif
2415
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002416/*
2417 * Tab pages point to the top frame of each tab page.
2418 * Note: Most values are NOT valid for the current tab page! Use "curwin",
2419 * "firstwin", etc. for that. "tp_topframe" is always valid and can be
2420 * compared against "topframe" to find the current tab page.
2421 */
2422typedef struct tabpage_S tabpage_T;
2423struct tabpage_S
2424{
2425 tabpage_T *tp_next; /* next tabpage or NULL */
2426 frame_T *tp_topframe; /* topframe for the windows */
2427 win_T *tp_curwin; /* current window in this Tab page */
2428 win_T *tp_prevwin; /* previous window in this Tab page */
2429 win_T *tp_firstwin; /* first window in this Tab page */
2430 win_T *tp_lastwin; /* last window in this Tab page */
2431 long tp_old_Rows; /* Rows when Tab page was left */
2432 long tp_old_Columns; /* Columns when Tab page was left */
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00002433 long tp_ch_used; /* value of 'cmdheight' when frame size
2434 was set */
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002435#ifdef FEAT_GUI
2436 int tp_prev_which_scrollbars[3];
2437 /* previous value of which_scrollbars */
2438#endif
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002439#ifdef FEAT_DIFF
2440 diff_T *tp_first_diff;
2441 buf_T *(tp_diffbuf[DB_COUNT]);
2442 int tp_diff_invalid; /* list of diffs is outdated */
2443#endif
Bram Moolenaar746ebd32009-06-16 14:01:43 +00002444 frame_T *(tp_snapshot[SNAP_COUNT]); /* window layout snapshots */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002445#ifdef FEAT_EVAL
2446 dictitem_T tp_winvar; /* variable for "t:" Dictionary */
Bram Moolenaar429fa852013-04-15 12:27:36 +02002447 dict_T *tp_vars; /* internal variables, local to tab page */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002448#endif
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02002449
2450#ifdef FEAT_PYTHON
2451 void *tp_python_ref; /* The Python value for this tab page */
2452#endif
2453
2454#ifdef FEAT_PYTHON3
2455 void *tp_python3_ref; /* The Python value for this tab page */
2456#endif
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002457};
2458
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459/*
2460 * Structure to cache info for displayed lines in w_lines[].
2461 * Each logical line has one entry.
2462 * The entry tells how the logical line is currently displayed in the window.
2463 * This is updated when displaying the window.
2464 * When the display is changed (e.g., when clearing the screen) w_lines_valid
2465 * is changed to exclude invalid entries.
2466 * When making changes to the buffer, wl_valid is reset to indicate wl_size
2467 * may not reflect what is actually in the buffer. When wl_valid is FALSE,
2468 * the entries can only be used to count the number of displayed lines used.
2469 * wl_lnum and wl_lastlnum are invalid too.
2470 */
2471typedef struct w_line
2472{
2473 linenr_T wl_lnum; /* buffer line number for logical line */
2474 short_u wl_size; /* height in screen lines */
2475 char wl_valid; /* TRUE values are valid for text in buffer */
2476#ifdef FEAT_FOLDING
2477 char wl_folded; /* TRUE when this is a range of folded lines */
2478 linenr_T wl_lastlnum; /* last buffer line number for logical line */
2479#endif
2480} wline_T;
2481
2482/*
2483 * Windows are kept in a tree of frames. Each frame has a column (FR_COL)
2484 * or row (FR_ROW) layout or is a leaf, which has a window.
2485 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002486struct frame_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487{
2488 char fr_layout; /* FR_LEAF, FR_COL or FR_ROW */
Bram Moolenaar44a2f922016-03-19 22:11:51 +01002489#ifdef FEAT_WINDOWS
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490 int fr_width;
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002491 int fr_newwidth; /* new width used in win_equal_rec() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492#endif
2493 int fr_height;
2494 int fr_newheight; /* new height used in win_equal_rec() */
2495 frame_T *fr_parent; /* containing frame or NULL */
2496 frame_T *fr_next; /* frame right or below in same parent, NULL
2497 for first */
2498 frame_T *fr_prev; /* frame left or above in same parent, NULL
2499 for last */
2500 /* fr_child and fr_win are mutually exclusive */
2501 frame_T *fr_child; /* first contained frame */
2502 win_T *fr_win; /* window that fills this frame */
2503};
2504
2505#define FR_LEAF 0 /* frame is a leaf */
2506#define FR_ROW 1 /* frame with a row of windows */
2507#define FR_COL 2 /* frame with a column of windows */
2508
2509/*
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002510 * Struct used for highlighting 'hlsearch' matches, matches defined by
2511 * ":match" and matches defined by match functions.
2512 * For 'hlsearch' there is one pattern for all windows. For ":match" and the
2513 * match functions there is a different pattern for each window.
2514 */
2515typedef struct
2516{
2517 regmmatch_T rm; /* points to the regexp program; contains last found
2518 match (may continue in next line) */
2519 buf_T *buf; /* the buffer to search for a match */
2520 linenr_T lnum; /* the line to search for a match */
2521 int attr; /* attributes to be used for a match */
2522 int attr_cur; /* attributes currently active in win_line() */
2523 linenr_T first_lnum; /* first lnum to search for multi-line pat */
2524 colnr_T startcol; /* in win_line() points to char where HL starts */
2525 colnr_T endcol; /* in win_line() points to char where HL ends */
Bram Moolenaar4f416e42016-08-16 16:08:18 +02002526 int is_addpos; /* position specified directly by
2527 matchaddpos(). TRUE/FALSE */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00002528#ifdef FEAT_RELTIME
2529 proftime_T tm; /* for a time limit */
2530#endif
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002531} match_T;
2532
Bram Moolenaarb3414592014-06-17 17:48:32 +02002533/* number of positions supported by matchaddpos() */
2534#define MAXPOSMATCH 8
2535
2536/*
2537 * Same as lpos_T, but with additional field len.
2538 */
2539typedef struct
2540{
2541 linenr_T lnum; /* line number */
2542 colnr_T col; /* column number */
2543 int len; /* length: 0 - to the end of line */
2544} llpos_T;
2545
2546/*
2547 * posmatch_T provides an array for storing match items for matchaddpos()
2548 * function.
2549 */
2550typedef struct posmatch posmatch_T;
2551struct posmatch
2552{
2553 llpos_T pos[MAXPOSMATCH]; /* array of positions */
2554 int cur; /* internal position counter */
2555 linenr_T toplnum; /* top buffer line */
2556 linenr_T botlnum; /* bottom buffer line */
2557};
2558
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002559/*
2560 * matchitem_T provides a linked list for storing match items for ":match" and
2561 * the match functions.
2562 */
2563typedef struct matchitem matchitem_T;
2564struct matchitem
2565{
2566 matchitem_T *next;
2567 int id; /* match ID */
2568 int priority; /* match priority */
2569 char_u *pattern; /* pattern to highlight */
2570 int hlg_id; /* highlight group ID */
2571 regmmatch_T match; /* regexp program for pattern */
Bram Moolenaarb3414592014-06-17 17:48:32 +02002572 posmatch_T pos; /* position matches */
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002573 match_T hl; /* struct for doing the actual highlighting */
Bram Moolenaar6561d522015-07-21 15:48:27 +02002574#ifdef FEAT_CONCEAL
2575 int conceal_char; /* cchar for Conceal highlighting */
2576#endif
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002577};
2578
2579/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 * Structure which contains all information that belongs to a window
2581 *
2582 * All row numbers are relative to the start of the window, except w_winrow.
2583 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002584struct window_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585{
Bram Moolenaar86edef62016-03-13 18:07:30 +01002586 int w_id; /* unique window ID */
2587
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 buf_T *w_buffer; /* buffer we are a window into (used
2589 often, keep it the first item!) */
2590
Bram Moolenaar860cae12010-06-05 23:22:07 +02002591#if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002592 synblock_T *w_s; /* for :ownsyntax */
Bram Moolenaar860cae12010-06-05 23:22:07 +02002593#endif
2594
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595#ifdef FEAT_WINDOWS
2596 win_T *w_prev; /* link to previous window */
2597 win_T *w_next; /* link to next window */
2598#endif
Bram Moolenaar362ce482012-06-06 19:02:45 +02002599#ifdef FEAT_AUTOCMD
2600 int w_closing; /* window is being closed, don't let
2601 autocommands close it too. */
2602#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603
2604 frame_T *w_frame; /* frame containing this window */
2605
2606 pos_T w_cursor; /* cursor position in buffer */
2607
2608 colnr_T w_curswant; /* The column we'd like to be at. This is
2609 used to try to stay in the same column
2610 for up/down cursor motions. */
2611
2612 int w_set_curswant; /* If set, then update w_curswant the next
2613 time through cursupdate() to the
2614 current virtual column */
2615
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 /*
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01002617 * the next seven are used to update the visual part
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 */
2619 char w_old_visual_mode; /* last known VIsual_mode */
2620 linenr_T w_old_cursor_lnum; /* last known end of visual part */
2621 colnr_T w_old_cursor_fcol; /* first column for block visual part */
2622 colnr_T w_old_cursor_lcol; /* last column for block visual part */
2623 linenr_T w_old_visual_lnum; /* last known start of visual part */
Bram Moolenaar6c131c42005-07-19 22:17:30 +00002624 colnr_T w_old_visual_col; /* last known start of visual part */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 colnr_T w_old_curswant; /* last known value of Curswant */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626
2627 /*
Bram Moolenaard4153d42008-11-15 15:06:17 +00002628 * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for
2629 * displaying the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630 */
2631 linenr_T w_topline; /* buffer line number of the line at the
2632 top of the window */
Bram Moolenaard4153d42008-11-15 15:06:17 +00002633#ifdef FEAT_AUTOCMD
2634 char w_topline_was_set; /* flag set to TRUE when topline is set,
2635 e.g. by winrestview() */
2636#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637#ifdef FEAT_DIFF
2638 int w_topfill; /* number of filler lines above w_topline */
2639 int w_old_topfill; /* w_topfill at last redraw */
2640 int w_botfill; /* TRUE when filler lines are actually
2641 below w_topline (at end of file) */
2642 int w_old_botfill; /* w_botfill at last redraw */
2643#endif
2644 colnr_T w_leftcol; /* window column number of the left most
2645 character in the window; used when
2646 'wrap' is off */
2647 colnr_T w_skipcol; /* starting column when a single line
2648 doesn't fit in the window */
2649
2650 /*
2651 * Layout of the window in the screen.
2652 * May need to add "msg_scrolled" to "w_winrow" in rare situations.
2653 */
2654#ifdef FEAT_WINDOWS
2655 int w_winrow; /* first row of window in screen */
2656#endif
2657 int w_height; /* number of rows in window, excluding
2658 status/command line(s) */
2659#ifdef FEAT_WINDOWS
2660 int w_status_height; /* number of status lines (0 or 1) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 int w_wincol; /* Leftmost column of window in screen.
2662 use W_WINCOL() */
2663 int w_width; /* Width of window, excluding separation.
2664 use W_WIDTH() */
2665 int w_vsep_width; /* Number of separator columns (0 or 1).
2666 use W_VSEP_WIDTH() */
2667#endif
2668
2669 /*
2670 * === start of cached values ====
2671 */
2672 /*
2673 * Recomputing is minimized by storing the result of computations.
2674 * Use functions in screen.c to check if they are valid and to update.
2675 * w_valid is a bitfield of flags, which indicate if specific values are
2676 * valid or need to be recomputed. See screen.c for values.
2677 */
2678 int w_valid;
2679 pos_T w_valid_cursor; /* last known position of w_cursor, used
2680 to adjust w_valid */
2681 colnr_T w_valid_leftcol; /* last known w_leftcol */
2682
2683 /*
2684 * w_cline_height is the number of physical lines taken by the buffer line
2685 * that the cursor is on. We use this to avoid extra calls to plines().
2686 */
2687 int w_cline_height; /* current size of cursor line */
2688#ifdef FEAT_FOLDING
2689 int w_cline_folded; /* cursor line is folded */
2690#endif
2691
2692 int w_cline_row; /* starting row of the cursor line */
2693
2694 colnr_T w_virtcol; /* column number of the cursor in the
2695 buffer line, as opposed to the column
2696 number we're at on the screen. This
2697 makes a difference on lines which span
2698 more than one screen line or when
2699 w_leftcol is non-zero */
2700
2701 /*
2702 * w_wrow and w_wcol specify the cursor position in the window.
2703 * This is related to positions in the window, not in the display or
2704 * buffer, thus w_wrow is relative to w_winrow.
2705 */
2706 int w_wrow, w_wcol; /* cursor position in window */
2707
2708 linenr_T w_botline; /* number of the line below the bottom of
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002709 the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 int w_empty_rows; /* number of ~ rows in window */
2711#ifdef FEAT_DIFF
2712 int w_filler_rows; /* number of filler rows at the end of the
2713 window */
2714#endif
2715
2716 /*
2717 * Info about the lines currently in the window is remembered to avoid
2718 * recomputing it every time. The allocated size of w_lines[] is Rows.
2719 * Only the w_lines_valid entries are actually valid.
2720 * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
2721 * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
2722 * Between changing text and updating the display w_lines[] represents
2723 * what is currently displayed. wl_valid is reset to indicated this.
2724 * This is used for efficient redrawing.
2725 */
2726 int w_lines_valid; /* number of valid entries */
2727 wline_T *w_lines;
2728
2729#ifdef FEAT_FOLDING
2730 garray_T w_folds; /* array of nested folds */
2731 char w_fold_manual; /* when TRUE: some folds are opened/closed
2732 manually */
2733 char w_foldinvalid; /* when TRUE: folding needs to be
2734 recomputed */
2735#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002736#ifdef FEAT_LINEBREAK
Bram Moolenaar64486672010-05-16 15:46:46 +02002737 int w_nrwidth; /* width of 'number' and 'relativenumber'
2738 column being used */
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002739#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740
2741 /*
2742 * === end of cached values ===
2743 */
2744
2745 int w_redr_type; /* type of redraw to be performed on win */
2746 int w_upd_rows; /* number of window lines to update when
2747 w_redr_type is REDRAW_TOP */
2748 linenr_T w_redraw_top; /* when != 0: first line needing redraw */
2749 linenr_T w_redraw_bot; /* when != 0: last line needing redraw */
2750#ifdef FEAT_WINDOWS
2751 int w_redr_status; /* if TRUE status line must be redrawn */
2752#endif
2753
2754#ifdef FEAT_CMDL_INFO
2755 /* remember what is shown in the ruler for this window (if 'ruler' set) */
2756 pos_T w_ru_cursor; /* cursor position shown in ruler */
2757 colnr_T w_ru_virtcol; /* virtcol shown in ruler */
2758 linenr_T w_ru_topline; /* topline shown in ruler */
2759 linenr_T w_ru_line_count; /* line count used for ruler */
2760# ifdef FEAT_DIFF
2761 int w_ru_topfill; /* topfill shown in ruler */
2762# endif
2763 char w_ru_empty; /* TRUE if ruler shows 0-1 (empty line) */
2764#endif
2765
2766 int w_alt_fnum; /* alternate file (for # and CTRL-^) */
2767
2768#ifdef FEAT_WINDOWS
2769 alist_T *w_alist; /* pointer to arglist for this window */
2770#endif
2771 int w_arg_idx; /* current index in argument list (can be
2772 out of range!) */
2773 int w_arg_idx_invalid; /* editing another file than w_arg_idx */
2774
2775 char_u *w_localdir; /* absolute path of local directory or
2776 NULL */
2777 /*
2778 * Options local to a window.
2779 * They are local because they influence the layout of the window or
2780 * depend on the window layout.
2781 * There are two values: w_onebuf_opt is local to the buffer currently in
2782 * this window, w_allbuf_opt is for all buffers in this window.
2783 */
2784 winopt_T w_onebuf_opt;
2785 winopt_T w_allbuf_opt;
2786
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002787 /* A few options have local flags for P_INSECURE. */
2788#ifdef FEAT_STL_OPT
2789 long_u w_p_stl_flags; /* flags for 'statusline' */
2790#endif
2791#ifdef FEAT_EVAL
2792 long_u w_p_fde_flags; /* flags for 'foldexpr' */
2793 long_u w_p_fdt_flags; /* flags for 'foldtext' */
2794#endif
Bram Moolenaar1a384422010-07-14 19:53:30 +02002795#ifdef FEAT_SYN_HL
2796 int *w_p_cc_cols; /* array of columns to highlight or NULL */
2797#endif
Bram Moolenaar597a4222014-06-25 14:39:50 +02002798#ifdef FEAT_LINEBREAK
2799 int w_p_brimin; /* minimum width for breakindent */
2800 int w_p_brishift; /* additional shift for breakindent */
2801 int w_p_brisbr; /* sbr in 'briopt' */
2802#endif
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002803
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 /* transform a pointer to a "onebuf" option into a "allbuf" option */
2805#define GLOBAL_WO(p) ((char *)p + sizeof(winopt_T))
2806
2807#ifdef FEAT_SCROLLBIND
2808 long w_scbind_pos;
2809#endif
2810
2811#ifdef FEAT_EVAL
Bram Moolenaar8f999f12005-01-25 22:12:55 +00002812 dictitem_T w_winvar; /* variable for "w:" Dictionary */
Bram Moolenaar429fa852013-04-15 12:27:36 +02002813 dict_T *w_vars; /* internal variables, local to window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814#endif
2815
2816#if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
2817 int w_farsi; /* for the window dependent Farsi functions */
2818#endif
2819
2820 /*
2821 * The w_prev_pcmark field is used to check whether we really did jump to
2822 * a new line after setting the w_pcmark. If not, then we revert to
2823 * using the previous w_pcmark.
2824 */
2825 pos_T w_pcmark; /* previous context mark */
2826 pos_T w_prev_pcmark; /* previous w_pcmark */
2827
2828#ifdef FEAT_JUMPLIST
2829 /*
2830 * the jumplist contains old cursor positions
2831 */
2832 xfmark_T w_jumplist[JUMPLISTSIZE];
2833 int w_jumplistlen; /* number of active entries */
2834 int w_jumplistidx; /* current position */
2835
2836 int w_changelistidx; /* current position in b_changelist */
2837#endif
2838
2839#ifdef FEAT_SEARCH_EXTRA
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002840 matchitem_T *w_match_head; /* head of match list */
2841 int w_next_match_id; /* next match ID */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842#endif
2843
2844 /*
2845 * the tagstack grows from 0 upwards:
2846 * entry 0: older
2847 * entry 1: newer
2848 * entry 2: newest
2849 */
2850 taggy_T w_tagstack[TAGSTACKSIZE]; /* the tag stack */
Bram Moolenaar335437b2007-05-10 18:32:52 +00002851 int w_tagstackidx; /* idx just below active entry */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 int w_tagstacklen; /* number of tags on stack */
2853
2854 /*
2855 * w_fraction is the fractional row of the cursor within the window, from
2856 * 0 at the top row to FRACTION_MULT at the last row.
2857 * w_prev_fraction_row was the actual cursor row when w_fraction was last
2858 * calculated.
2859 */
2860 int w_fraction;
2861 int w_prev_fraction_row;
2862
2863#ifdef FEAT_GUI
2864 scrollbar_T w_scrollbars[2]; /* vert. Scrollbars for this window */
2865#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002866#ifdef FEAT_LINEBREAK
2867 linenr_T w_nrwidth_line_count; /* line count when ml_nrwidth_width
2868 * was computed. */
Bram Moolenaar6b314672015-03-20 15:42:10 +01002869 long w_nuw_cached; /* 'numberwidth' option cached */
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002870 int w_nrwidth_width; /* nr of chars to print line count. */
2871#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002873#ifdef FEAT_QUICKFIX
2874 qf_info_T *w_llist; /* Location list for this window */
2875 /*
2876 * Location list reference used in the location list window.
2877 * In a non-location list window, w_llist_ref is NULL.
2878 */
2879 qf_info_T *w_llist_ref;
2880#endif
2881
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002882
2883#ifdef FEAT_MZSCHEME
Bram Moolenaare344bea2005-09-01 20:46:49 +00002884 void *w_mzscheme_ref; /* The MzScheme value for this window */
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002885#endif
2886
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887#ifdef FEAT_PERL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002888 void *w_perl_private;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889#endif
2890
2891#ifdef FEAT_PYTHON
Bram Moolenaare344bea2005-09-01 20:46:49 +00002892 void *w_python_ref; /* The Python value for this window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893#endif
2894
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02002895#ifdef FEAT_PYTHON3
2896 void *w_python3_ref; /* The Python value for this window */
2897#endif
2898
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899#ifdef FEAT_TCL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002900 void *w_tcl_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901#endif
2902
2903#ifdef FEAT_RUBY
Bram Moolenaare344bea2005-09-01 20:46:49 +00002904 void *w_ruby_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905#endif
2906};
2907
2908/*
2909 * Arguments for operators.
2910 */
Bram Moolenaare344bea2005-09-01 20:46:49 +00002911typedef struct oparg_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912{
2913 int op_type; /* current pending operator type */
2914 int regname; /* register to use for the operator */
2915 int motion_type; /* type of the current cursor motion */
2916 int motion_force; /* force motion type: 'v', 'V' or CTRL-V */
2917 int use_reg_one; /* TRUE if delete uses reg 1 even when not
2918 linewise */
2919 int inclusive; /* TRUE if char motion is inclusive (only
2920 valid when motion_type is MCHAR */
2921 int end_adjusted; /* backuped b_op_end one char (only used by
2922 do_format()) */
2923 pos_T start; /* start of the operator */
2924 pos_T end; /* end of the operator */
2925 pos_T cursor_start; /* cursor position before motion for "gw" */
2926
2927 long line_count; /* number of lines from op_start to op_end
2928 (inclusive) */
2929 int empty; /* op_start and op_end the same (only used by
2930 do_change()) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 int is_VIsual; /* operator on Visual area */
2932 int block_mode; /* current operator is Visual block mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 colnr_T start_vcol; /* start col for block mode operator */
2934 colnr_T end_vcol; /* end col for block mode operator */
Bram Moolenaara983fe92008-07-31 20:04:27 +00002935#ifdef FEAT_AUTOCMD
2936 long prev_opcount; /* ca.opcount saved for K_CURSORHOLD */
2937 long prev_count0; /* ca.count0 saved for K_CURSORHOLD */
2938#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939} oparg_T;
2940
2941/*
2942 * Arguments for Normal mode commands.
2943 */
Bram Moolenaare344bea2005-09-01 20:46:49 +00002944typedef struct cmdarg_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945{
2946 oparg_T *oap; /* Operator arguments */
2947 int prechar; /* prefix character (optional, always 'g') */
2948 int cmdchar; /* command character */
2949 int nchar; /* next command character (optional) */
2950#ifdef FEAT_MBYTE
2951 int ncharC1; /* first composing character (optional) */
2952 int ncharC2; /* second composing character (optional) */
2953#endif
2954 int extra_char; /* yet another character (optional) */
2955 long opcount; /* count before an operator */
2956 long count0; /* count before command, default 0 */
2957 long count1; /* count before command, default 1 */
2958 int arg; /* extra argument from nv_cmds[] */
2959 int retval; /* return: CA_* values */
2960 char_u *searchbuf; /* return: pointer to search pattern or NULL */
2961} cmdarg_T;
2962
2963/* values for retval: */
2964#define CA_COMMAND_BUSY 1 /* skip restarting edit() once */
2965#define CA_NO_ADJ_OP_END 2 /* don't adjust operator end */
2966
2967#ifdef CURSOR_SHAPE
2968/*
2969 * struct to store values from 'guicursor' and 'mouseshape'
2970 */
2971/* Indexes in shape_table[] */
2972#define SHAPE_IDX_N 0 /* Normal mode */
2973#define SHAPE_IDX_V 1 /* Visual mode */
2974#define SHAPE_IDX_I 2 /* Insert mode */
2975#define SHAPE_IDX_R 3 /* Replace mode */
2976#define SHAPE_IDX_C 4 /* Command line Normal mode */
2977#define SHAPE_IDX_CI 5 /* Command line Insert mode */
2978#define SHAPE_IDX_CR 6 /* Command line Replace mode */
2979#define SHAPE_IDX_O 7 /* Operator-pending mode */
Bram Moolenaar2767c602010-05-16 13:56:06 +02002980#define SHAPE_IDX_VE 8 /* Visual mode with 'selection' exclusive */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981#define SHAPE_IDX_CLINE 9 /* On command line */
2982#define SHAPE_IDX_STATUS 10 /* A status line */
2983#define SHAPE_IDX_SDRAG 11 /* dragging a status line */
2984#define SHAPE_IDX_VSEP 12 /* A vertical separator line */
2985#define SHAPE_IDX_VDRAG 13 /* dragging a vertical separator line */
2986#define SHAPE_IDX_MORE 14 /* Hit-return or More */
2987#define SHAPE_IDX_MOREL 15 /* Hit-return or More in last line */
2988#define SHAPE_IDX_SM 16 /* showing matching paren */
2989#define SHAPE_IDX_COUNT 17
2990
2991#define SHAPE_BLOCK 0 /* block cursor */
2992#define SHAPE_HOR 1 /* horizontal bar cursor */
2993#define SHAPE_VER 2 /* vertical bar cursor */
2994
2995#define MSHAPE_NUMBERED 1000 /* offset for shapes identified by number */
2996#define MSHAPE_HIDE 1 /* hide mouse pointer */
2997
2998#define SHAPE_MOUSE 1 /* used for mouse pointer shape */
2999#define SHAPE_CURSOR 2 /* used for text cursor shape */
3000
3001typedef struct cursor_entry
3002{
3003 int shape; /* one of the SHAPE_ defines */
3004 int mshape; /* one of the MSHAPE defines */
3005 int percentage; /* percentage of cell for bar */
3006 long blinkwait; /* blinking, wait time before blinking starts */
3007 long blinkon; /* blinking, on time */
3008 long blinkoff; /* blinking, off time */
3009 int id; /* highlight group ID */
3010 int id_lm; /* highlight group ID for :lmap mode */
3011 char *name; /* mode name (fixed) */
3012 char used_for; /* SHAPE_MOUSE and/or SHAPE_CURSOR */
3013} cursorentry_T;
3014#endif /* CURSOR_SHAPE */
3015
3016#ifdef FEAT_MENU
3017
3018/* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
3019#define MENU_INDEX_INVALID -1
3020#define MENU_INDEX_NORMAL 0
3021#define MENU_INDEX_VISUAL 1
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003022#define MENU_INDEX_SELECT 2
3023#define MENU_INDEX_OP_PENDING 3
3024#define MENU_INDEX_INSERT 4
3025#define MENU_INDEX_CMDLINE 5
3026#define MENU_INDEX_TIP 6
3027#define MENU_MODES 7
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028
3029/* Menu modes */
3030#define MENU_NORMAL_MODE (1 << MENU_INDEX_NORMAL)
3031#define MENU_VISUAL_MODE (1 << MENU_INDEX_VISUAL)
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003032#define MENU_SELECT_MODE (1 << MENU_INDEX_SELECT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033#define MENU_OP_PENDING_MODE (1 << MENU_INDEX_OP_PENDING)
3034#define MENU_INSERT_MODE (1 << MENU_INDEX_INSERT)
3035#define MENU_CMDLINE_MODE (1 << MENU_INDEX_CMDLINE)
3036#define MENU_TIP_MODE (1 << MENU_INDEX_TIP)
3037#define MENU_ALL_MODES ((1 << MENU_INDEX_TIP) - 1)
3038/*note MENU_INDEX_TIP is not a 'real' mode*/
3039
3040/* Start a menu name with this to not include it on the main menu bar */
3041#define MNU_HIDDEN_CHAR ']'
3042
3043typedef struct VimMenu vimmenu_T;
3044
3045struct VimMenu
3046{
3047 int modes; /* Which modes is this menu visible for? */
3048 int enabled; /* for which modes the menu is enabled */
Bram Moolenaar70b11cd2010-05-14 22:24:40 +02003049 char_u *name; /* Name of menu, possibly translated */
3050 char_u *dname; /* Displayed Name ("name" without '&') */
3051#ifdef FEAT_MULTI_LANG
3052 char_u *en_name; /* "name" untranslated, NULL when "name"
3053 * was not translated */
3054 char_u *en_dname; /* "dname" untranslated, NULL when "dname"
3055 * was not translated */
3056#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 int mnemonic; /* mnemonic key (after '&') */
3058 char_u *actext; /* accelerator text (after TAB) */
3059 int priority; /* Menu order priority */
3060#ifdef FEAT_GUI
Bram Moolenaard99df422016-01-29 23:20:40 +01003061 void (*cb)(vimmenu_T *); /* Call-back routine */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062#endif
3063#ifdef FEAT_TOOLBAR
3064 char_u *iconfile; /* name of file for icon or NULL */
3065 int iconidx; /* icon index (-1 if not set) */
3066 int icon_builtin; /* icon names is BuiltIn{nr} */
3067#endif
3068 char_u *strings[MENU_MODES]; /* Mapped string for each mode */
3069 int noremap[MENU_MODES]; /* A REMAP_ flag for each mode */
3070 char silent[MENU_MODES]; /* A silent flag for each mode */
3071 vimmenu_T *children; /* Children of sub-menu */
3072 vimmenu_T *parent; /* Parent of menu */
3073 vimmenu_T *next; /* Next item in menu */
3074#ifdef FEAT_GUI_X11
3075 Widget id; /* Manage this to enable item */
3076 Widget submenu_id; /* If this is submenu, add children here */
3077#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078#ifdef FEAT_GUI_GTK
3079 GtkWidget *id; /* Manage this to enable item */
3080 GtkWidget *submenu_id; /* If this is submenu, add children here */
Bram Moolenaar98921892016-02-23 17:14:37 +01003081# if defined(GTK_CHECK_VERSION) && !GTK_CHECK_VERSION(3,4,0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 GtkWidget *tearoff_handle;
Bram Moolenaar98921892016-02-23 17:14:37 +01003083# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 GtkWidget *label; /* Used by "set wak=" code. */
3085#endif
3086#ifdef FEAT_GUI_MOTIF
3087 int sensitive; /* turn button on/off */
Bram Moolenaarec2dad62005-01-02 11:36:03 +00003088 char **xpm; /* pixmap data */
Bram Moolenaar7c626922005-02-07 22:01:03 +00003089 char *xpm_fname; /* file with pixmap data */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090#endif
Bram Moolenaarec2dad62005-01-02 11:36:03 +00003091#ifdef FEAT_GUI_ATHENA
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 Pixmap image; /* Toolbar image */
3093#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094#ifdef FEAT_BEVAL_TIP
3095 BalloonEval *tip; /* tooltip for this menu item */
3096#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097#ifdef FEAT_GUI_W32
3098 UINT id; /* Id of menu item */
3099 HMENU submenu_id; /* If this is submenu, add children here */
3100 HWND tearoff_handle; /* hWnd of tearoff if created */
3101#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102#ifdef FEAT_GUI_MAC
3103/* MenuHandle id; */
3104/* short index; */ /* the item index within the father menu */
3105 short menu_id; /* the menu id to which this item belong */
3106 short submenu_id; /* the menu id of the children (could be
Bram Moolenaar2767c602010-05-16 13:56:06 +02003107 get through some tricks) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 MenuHandle menu_handle;
3109 MenuHandle submenu_handle;
3110#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111#ifdef FEAT_GUI_PHOTON
3112 PtWidget_t *id;
3113 PtWidget_t *submenu_id;
3114#endif
3115};
3116#else
3117/* For generating prototypes when FEAT_MENU isn't defined. */
3118typedef int vimmenu_T;
3119
3120#endif /* FEAT_MENU */
3121
3122/*
3123 * Struct to save values in before executing autocommands for a buffer that is
Bram Moolenaarf30e74c2006-08-16 17:35:00 +00003124 * not the current buffer. Without FEAT_AUTOCMD only "curbuf" is remembered.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 */
3126typedef struct
3127{
Bram Moolenaar746ebd32009-06-16 14:01:43 +00003128 buf_T *save_curbuf; /* saved curbuf */
Bram Moolenaarf30e74c2006-08-16 17:35:00 +00003129#ifdef FEAT_AUTOCMD
Bram Moolenaar6bef63c2009-07-29 10:10:29 +00003130 int use_aucmd_win; /* using aucmd_win */
Bram Moolenaar746ebd32009-06-16 14:01:43 +00003131 win_T *save_curwin; /* saved curwin */
3132 win_T *new_curwin; /* new curwin */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003133 bufref_T new_curbuf; /* new curbuf */
Bram Moolenaar6bef63c2009-07-29 10:10:29 +00003134 char_u *globaldir; /* saved value of globaldir */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135#endif
3136} aco_save_T;
3137
3138/*
3139 * Generic option table item, only used for printer at the moment.
3140 */
3141typedef struct
3142{
3143 const char *name;
3144 int hasnum;
3145 long number;
3146 char_u *string; /* points into option string */
3147 int strlen;
3148 int present;
3149} option_table_T;
3150
3151/*
3152 * Structure to hold printing color and font attributes.
3153 */
3154typedef struct
3155{
3156 long_u fg_color;
3157 long_u bg_color;
3158 int bold;
3159 int italic;
3160 int underline;
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003161 int undercurl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162} prt_text_attr_T;
3163
3164/*
3165 * Structure passed back to the generic printer code.
3166 */
3167typedef struct
3168{
3169 int n_collated_copies;
3170 int n_uncollated_copies;
3171 int duplex;
3172 int chars_per_line;
3173 int lines_per_page;
3174 int has_color;
3175 prt_text_attr_T number;
3176#ifdef FEAT_SYN_HL
3177 int modec;
3178 int do_syntax;
3179#endif
3180 int user_abort;
3181 char_u *jobname;
3182#ifdef FEAT_POSTSCRIPT
3183 char_u *outfile;
3184 char_u *arguments;
3185#endif
3186} prt_settings_T;
3187
3188#define PRINT_NUMBER_WIDTH 8
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00003189
3190/*
3191 * Used for popup menu items.
3192 */
3193typedef struct
3194{
3195 char_u *pum_text; /* main menu text */
Bram Moolenaarc270d802006-03-11 21:29:41 +00003196 char_u *pum_kind; /* extra kind text (may be truncated) */
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00003197 char_u *pum_extra; /* extra menu text (may be truncated) */
3198 char_u *pum_info; /* extra info */
3199} pumitem_T;
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003200
3201/*
3202 * Structure used for get_tagfname().
3203 */
3204typedef struct
3205{
3206 char_u *tn_tags; /* value of 'tags' when starting */
3207 char_u *tn_np; /* current position in tn_tags */
3208 int tn_did_filefind_init;
3209 int tn_hf_idx;
3210 void *tn_search_ctx;
3211} tagname_T;
3212
Bram Moolenaar39f05632006-03-19 22:15:26 +00003213/*
3214 * Array indexes used for cptext argument of ins_compl_add().
3215 */
3216#define CPT_ABBR 0 /* "abbr" */
3217#define CPT_MENU 1 /* "menu" */
3218#define CPT_KIND 2 /* "kind" */
3219#define CPT_INFO 3 /* "info" */
3220#define CPT_COUNT 4 /* Number of entries */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02003221
3222typedef struct {
3223 UINT32_T total[2];
3224 UINT32_T state[8];
3225 char_u buffer[64];
3226} context_sha256_T;
Bram Moolenaar520e1e42016-01-23 19:46:28 +01003227
3228/*
3229 * Structure used for reading in json_decode().
3230 */
Bram Moolenaar56ead342016-02-02 18:20:08 +01003231struct js_reader
Bram Moolenaar520e1e42016-01-23 19:46:28 +01003232{
3233 char_u *js_buf; /* text to be decoded */
Bram Moolenaar56ead342016-02-02 18:20:08 +01003234 char_u *js_end; /* NUL in js_buf */
Bram Moolenaar520e1e42016-01-23 19:46:28 +01003235 int js_used; /* bytes used from js_buf */
Bram Moolenaar56ead342016-02-02 18:20:08 +01003236 int (*js_fill)(struct js_reader *);
3237 /* function to fill the buffer or NULL;
3238 * return TRUE when the buffer was filled */
3239 void *js_cookie; /* can be used by js_fill */
Bram Moolenaar46c00a62016-03-28 14:11:42 +02003240 int js_cookie_arg; /* can be used by js_fill */
Bram Moolenaar56ead342016-02-02 18:20:08 +01003241};
3242typedef struct js_reader js_read_T;
Bram Moolenaar975b5272016-03-15 23:10:59 +01003243
3244typedef struct timer_S timer_T;
3245struct timer_S
3246{
Bram Moolenaar75537a92016-09-05 22:45:28 +02003247 long tr_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01003248#ifdef FEAT_TIMERS
3249 timer_T *tr_next;
3250 timer_T *tr_prev;
3251 proftime_T tr_due; /* when the callback is to be invoked */
Bram Moolenaar75537a92016-09-05 22:45:28 +02003252 char tr_firing; /* when TRUE callback is being called */
3253 char tr_paused; /* when TRUE callback is not invoked */
Bram Moolenaar975b5272016-03-15 23:10:59 +01003254 int tr_repeat; /* number of times to repeat, -1 forever */
Bram Moolenaara8e691d2016-08-07 15:19:26 +02003255 long tr_interval; /* msec */
Bram Moolenaar975b5272016-03-15 23:10:59 +01003256 char_u *tr_callback; /* allocated */
3257 partial_T *tr_partial;
Bram Moolenaarc577d812017-07-08 22:37:34 +02003258 int tr_emsg_count;
Bram Moolenaar975b5272016-03-15 23:10:59 +01003259#endif
3260};
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003261
3262/* Maximum number of commands from + or -c arguments. */
3263#define MAX_ARG_CMDS 10
3264
3265/* values for "window_layout" */
3266#define WIN_HOR 1 /* "-o" horizontally split windows */
3267#define WIN_VER 2 /* "-O" vertically split windows */
3268#define WIN_TABS 3 /* "-p" windows on tab pages */
3269
3270/* Struct for various parameters passed between main() and other functions. */
3271typedef struct
3272{
3273 int argc;
3274 char **argv;
3275
Bram Moolenaara8e691d2016-08-07 15:19:26 +02003276 char_u *fname; /* first file to edit */
3277
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003278 int evim_mode; /* started as "evim" */
3279 char_u *use_vimrc; /* vimrc from -u argument */
3280
3281 int n_commands; /* no. of commands from + or -c */
3282 char_u *commands[MAX_ARG_CMDS]; /* commands from + or -c arg. */
3283 char_u cmds_tofree[MAX_ARG_CMDS]; /* commands that need free() */
3284 int n_pre_commands; /* no. of commands from --cmd */
3285 char_u *pre_commands[MAX_ARG_CMDS]; /* commands from --cmd argument */
3286
3287 int edit_type; /* type of editing to do */
3288 char_u *tagname; /* tag from -t argument */
3289#ifdef FEAT_QUICKFIX
3290 char_u *use_ef; /* 'errorfile' from -q argument */
3291#endif
3292
3293 int want_full_screen;
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003294 int not_a_term; /* no warning for missing term? */
Bram Moolenaar2cab0e12016-11-24 15:09:07 +01003295 int tty_fail; /* exit if not a tty */
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003296 char_u *term; /* specified terminal name */
3297#ifdef FEAT_CRYPT
3298 int ask_for_key; /* -x argument */
3299#endif
3300 int no_swap_file; /* "-n" argument used */
3301#ifdef FEAT_EVAL
3302 int use_debug_break_level;
3303#endif
3304#ifdef FEAT_WINDOWS
3305 int window_count; /* number of windows to use */
3306 int window_layout; /* 0, WIN_HOR, WIN_VER or WIN_TABS */
3307#endif
3308
3309#ifdef FEAT_CLIENTSERVER
3310 int serverArg; /* TRUE when argument for a server */
3311 char_u *serverName_arg; /* cmdline arg for server name */
3312 char_u *serverStr; /* remote server command */
3313 char_u *serverStrEnc; /* encoding of serverStr */
3314 char_u *servername; /* allocated name for our server */
3315#endif
3316#if !defined(UNIX)
3317# define EXPAND_FILENAMES
3318 int literal; /* don't expand file names */
3319#endif
3320#ifdef MSWIN
3321 int full_path; /* file name argument was full path */
3322#endif
3323#ifdef FEAT_DIFF
3324 int diff_mode; /* start with 'diff' set */
3325#endif
3326} mparm_T;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003327
3328/*
3329 * Structure returned by get_lval() and used by set_var_lval().
3330 * For a plain name:
3331 * "name" points to the variable name.
3332 * "exp_name" is NULL.
3333 * "tv" is NULL
3334 * For a magic braces name:
3335 * "name" points to the expanded variable name.
3336 * "exp_name" is non-NULL, to be freed later.
3337 * "tv" is NULL
3338 * For an index in a list:
3339 * "name" points to the (expanded) variable name.
3340 * "exp_name" NULL or non-NULL, to be freed later.
3341 * "tv" points to the (first) list item value
3342 * "li" points to the (first) list item
3343 * "range", "n1", "n2" and "empty2" indicate what items are used.
3344 * For an existing Dict item:
3345 * "name" points to the (expanded) variable name.
3346 * "exp_name" NULL or non-NULL, to be freed later.
3347 * "tv" points to the dict item value
3348 * "newkey" is NULL
3349 * For a non-existing Dict item:
3350 * "name" points to the (expanded) variable name.
3351 * "exp_name" NULL or non-NULL, to be freed later.
3352 * "tv" points to the Dictionary typval_T
3353 * "newkey" is the key for the new item.
3354 */
3355typedef struct lval_S
3356{
3357 char_u *ll_name; /* start of variable name (can be NULL) */
3358 char_u *ll_exp_name; /* NULL or expanded name in allocated memory. */
3359 typval_T *ll_tv; /* Typeval of item being used. If "newkey"
3360 isn't NULL it's the Dict to which to add
3361 the item. */
3362 listitem_T *ll_li; /* The list item or NULL. */
3363 list_T *ll_list; /* The list or NULL. */
3364 int ll_range; /* TRUE when a [i:j] range was used */
3365 long ll_n1; /* First index for list */
3366 long ll_n2; /* Second index for list range */
3367 int ll_empty2; /* Second index is empty: [i:] */
3368 dict_T *ll_dict; /* The Dictionary or NULL */
3369 dictitem_T *ll_di; /* The dictitem or NULL */
3370 char_u *ll_newkey; /* New key for Dict in alloc. mem or NULL. */
3371} lval_T;