blob: 7b0f70cd3c5edfb0594ab82be7f0dfacecdd4cd6 [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 Moolenaar1b9645d2017-09-17 23:03:31 +020073#ifdef FEAT_MENU
74typedef struct VimMenu vimmenu_T;
75#endif
76
Bram Moolenaar45e5fd12017-06-04 14:58:02 +020077/*
78 * Reference to a buffer that stores the value of buf_free_count.
Bram Moolenaarb25f9a92016-07-10 18:21:50 +020079 * bufref_valid() only needs to check "buf" when the count differs.
80 */
81typedef struct {
82 buf_T *br_buf;
Bram Moolenaar45e5fd12017-06-04 14:58:02 +020083 int br_fnum;
Bram Moolenaarb25f9a92016-07-10 18:21:50 +020084 int br_buf_free_count;
85} bufref_T;
86
Bram Moolenaarfbc0d2e2013-05-19 19:40:29 +020087/*
88 * This is here because regexp.h needs pos_T and below regprog_T is used.
89 */
90#include "regexp.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000091
92/*
93 * This is here because gui.h needs the pos_T and win_T, and win_T needs gui.h
94 * for scrollbar_T.
95 */
96#ifdef FEAT_GUI
97# include "gui.h"
98#else
99# ifdef FEAT_XCLIPBOARD
100# include <X11/Intrinsic.h>
101# endif
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +0200102# define guicolor_T long
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200103# define INVALCOLOR ((guicolor_T)0x1ffffff)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104#endif
105
106/*
107 * marks: positions in a file
108 * (a normal mark is a lnum/col pair, the same as a file position)
109 */
110
111/* (Note: for EBCDIC there are more than 26, because there are gaps in the
112 * alphabet coding. To minimize changes to the code, I decided to just
113 * increase the number of possible marks. */
114#define NMARKS ('z' - 'a' + 1) /* max. # of named marks */
115#define JUMPLISTSIZE 100 /* max. # of marks in jump list */
116#define TAGSTACKSIZE 20 /* max. # of tags in tag stack */
117
118typedef struct filemark
119{
120 pos_T mark; /* cursor position */
121 int fnum; /* file number */
122} fmark_T;
123
124/* Xtended file mark: also has a file name */
125typedef struct xfilemark
126{
127 fmark_T fmark;
128 char_u *fname; /* file name, used when fnum == 0 */
Bram Moolenaar2d358992016-06-12 21:20:54 +0200129#ifdef FEAT_VIMINFO
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +0200130 time_T time_set;
Bram Moolenaar2d358992016-06-12 21:20:54 +0200131#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132} xfmark_T;
133
134/*
135 * The taggy struct is used to store the information about a :tag command.
136 */
137typedef struct taggy
138{
139 char_u *tagname; /* tag name */
140 fmark_T fmark; /* cursor position BEFORE ":tag" */
141 int cur_match; /* match number */
142 int cur_fnum; /* buffer number used for cur_match */
143} taggy_T;
144
145/*
146 * Structure that contains all options that are local to a window.
147 * Used twice in a window: for the current buffer and for all buffers.
148 * Also used in wininfo_T.
149 */
150typedef struct
151{
152#ifdef FEAT_ARABIC
153 int wo_arab;
154# define w_p_arab w_onebuf_opt.wo_arab /* 'arabic' */
155#endif
Bram Moolenaar597a4222014-06-25 14:39:50 +0200156#ifdef FEAT_LINEBREAK
157 int wo_bri;
158# define w_p_bri w_onebuf_opt.wo_bri /* 'breakindent' */
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200159 char_u *wo_briopt;
Bram Moolenaar597a4222014-06-25 14:39:50 +0200160# define w_p_briopt w_onebuf_opt.wo_briopt /* 'breakindentopt' */
161#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162#ifdef FEAT_DIFF
163 int wo_diff;
164# define w_p_diff w_onebuf_opt.wo_diff /* 'diff' */
165#endif
166#ifdef FEAT_FOLDING
167 long wo_fdc;
168# define w_p_fdc w_onebuf_opt.wo_fdc /* 'foldcolumn' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200169 int wo_fdc_save;
170# define w_p_fdc_save w_onebuf_opt.wo_fdc_save /* 'foldenable' saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171 int wo_fen;
172# define w_p_fen w_onebuf_opt.wo_fen /* 'foldenable' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200173 int wo_fen_save;
174# define w_p_fen_save w_onebuf_opt.wo_fen_save /* 'foldenable' saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175 char_u *wo_fdi;
176# define w_p_fdi w_onebuf_opt.wo_fdi /* 'foldignore' */
177 long wo_fdl;
178# define w_p_fdl w_onebuf_opt.wo_fdl /* 'foldlevel' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200179 int wo_fdl_save;
180# define w_p_fdl_save w_onebuf_opt.wo_fdl_save /* 'foldlevel' state saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181 char_u *wo_fdm;
182# define w_p_fdm w_onebuf_opt.wo_fdm /* 'foldmethod' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200183 char_u *wo_fdm_save;
184# define w_p_fdm_save w_onebuf_opt.wo_fdm_save /* 'fdm' saved for diff mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185 long wo_fml;
186# define w_p_fml w_onebuf_opt.wo_fml /* 'foldminlines' */
187 long wo_fdn;
Bram Moolenaar65c923a2006-03-03 22:56:30 +0000188# define w_p_fdn w_onebuf_opt.wo_fdn /* 'foldnestmax' */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189# ifdef FEAT_EVAL
190 char_u *wo_fde;
191# define w_p_fde w_onebuf_opt.wo_fde /* 'foldexpr' */
192 char_u *wo_fdt;
193# define w_p_fdt w_onebuf_opt.wo_fdt /* 'foldtext' */
194# endif
195 char_u *wo_fmr;
196# define w_p_fmr w_onebuf_opt.wo_fmr /* 'foldmarker' */
197#endif
198#ifdef FEAT_LINEBREAK
199 int wo_lbr;
200# define w_p_lbr w_onebuf_opt.wo_lbr /* 'linebreak' */
201#endif
202 int wo_list;
203#define w_p_list w_onebuf_opt.wo_list /* 'list' */
204 int wo_nu;
205#define w_p_nu w_onebuf_opt.wo_nu /* 'number' */
Bram Moolenaar64486672010-05-16 15:46:46 +0200206 int wo_rnu;
207#define w_p_rnu w_onebuf_opt.wo_rnu /* 'relativenumber' */
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000208#ifdef FEAT_LINEBREAK
209 long wo_nuw;
210# define w_p_nuw w_onebuf_opt.wo_nuw /* 'numberwidth' */
211#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 int wo_wfh;
213# define w_p_wfh w_onebuf_opt.wo_wfh /* 'winfixheight' */
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000214 int wo_wfw;
215# define w_p_wfw w_onebuf_opt.wo_wfw /* 'winfixwidth' */
Bram Moolenaar4033c552017-09-16 20:54:51 +0200216#if defined(FEAT_QUICKFIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217 int wo_pvw;
218# define w_p_pvw w_onebuf_opt.wo_pvw /* 'previewwindow' */
219#endif
220#ifdef FEAT_RIGHTLEFT
221 int wo_rl;
222# define w_p_rl w_onebuf_opt.wo_rl /* 'rightleft' */
223 char_u *wo_rlc;
224# define w_p_rlc w_onebuf_opt.wo_rlc /* 'rightleftcmd' */
225#endif
226 long wo_scr;
227#define w_p_scr w_onebuf_opt.wo_scr /* 'scroll' */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000228#ifdef FEAT_SPELL
Bram Moolenaar217ad922005-03-20 22:37:15 +0000229 int wo_spell;
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000230# define w_p_spell w_onebuf_opt.wo_spell /* 'spell' */
231#endif
232#ifdef FEAT_SYN_HL
233 int wo_cuc;
234# define w_p_cuc w_onebuf_opt.wo_cuc /* 'cursorcolumn' */
235 int wo_cul;
236# define w_p_cul w_onebuf_opt.wo_cul /* 'cursorline' */
Bram Moolenaar1a384422010-07-14 19:53:30 +0200237 char_u *wo_cc;
238# define w_p_cc w_onebuf_opt.wo_cc /* 'colorcolumn' */
Bram Moolenaar217ad922005-03-20 22:37:15 +0000239#endif
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000240#ifdef FEAT_STL_OPT
241 char_u *wo_stl;
242#define w_p_stl w_onebuf_opt.wo_stl /* 'statusline' */
243#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244#ifdef FEAT_SCROLLBIND
245 int wo_scb;
246# define w_p_scb w_onebuf_opt.wo_scb /* 'scrollbind' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200247 int wo_diff_saved; /* options were saved for starting diff mode */
248# define w_p_diff_saved w_onebuf_opt.wo_diff_saved
249 int wo_scb_save; /* 'scrollbind' saved for diff mode*/
250# define w_p_scb_save w_onebuf_opt.wo_scb_save
Bram Moolenaar071d4272004-06-13 20:20:40 +0000251#endif
252 int wo_wrap;
253#define w_p_wrap w_onebuf_opt.wo_wrap /* 'wrap' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200254#ifdef FEAT_DIFF
255 int wo_wrap_save; /* 'wrap' state saved for diff mode*/
256# define w_p_wrap_save w_onebuf_opt.wo_wrap_save
257#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +0200258#ifdef FEAT_CONCEAL
Bram Moolenaarf5963f72010-07-23 22:10:27 +0200259 char_u *wo_cocu; /* 'concealcursor' */
260# define w_p_cocu w_onebuf_opt.wo_cocu
261 long wo_cole; /* 'conceallevel' */
262# define w_p_cole w_onebuf_opt.wo_cole
Bram Moolenaar860cae12010-06-05 23:22:07 +0200263#endif
264#ifdef FEAT_CURSORBIND
265 int wo_crb;
266# define w_p_crb w_onebuf_opt.wo_crb /* 'cursorbind' */
Bram Moolenaara87aa802013-07-03 15:47:03 +0200267 int wo_crb_save; /* 'cursorbind' state saved for diff mode*/
268# define w_p_crb_save w_onebuf_opt.wo_crb_save
Bram Moolenaar860cae12010-06-05 23:22:07 +0200269#endif
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200270#ifdef FEAT_SIGNS
271 char_u *wo_scl;
272# define w_p_scl w_onebuf_opt.wo_scl /* 'signcolumn' */
273#endif
Bram Moolenaare4f25e42017-07-07 11:54:15 +0200274#ifdef FEAT_TERMINAL
Bram Moolenaar1b0675c2017-07-15 14:04:01 +0200275 char_u *wo_tk;
276#define w_p_tk w_onebuf_opt.wo_tk /* 'termkey' */
Bram Moolenaare4f25e42017-07-07 11:54:15 +0200277 char_u *wo_tms;
278#define w_p_tms w_onebuf_opt.wo_tms /* 'termsize' */
279#endif
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000280
281#ifdef FEAT_EVAL
282 int wo_scriptID[WV_COUNT]; /* SIDs for window-local options */
283# define w_p_scriptID w_onebuf_opt.wo_scriptID
284#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285} winopt_T;
286
287/*
288 * Window info stored with a buffer.
289 *
290 * Two types of info are kept for a buffer which are associated with a
291 * specific window:
292 * 1. Each window can have a different line number associated with a buffer.
293 * 2. The window-local options for a buffer work in a similar way.
294 * The window-info is kept in a list at b_wininfo. It is kept in
295 * most-recently-used order.
296 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000297struct wininfo_S
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298{
299 wininfo_T *wi_next; /* next entry or NULL for last entry */
300 wininfo_T *wi_prev; /* previous entry or NULL for first entry */
Bram Moolenaar70b11cd2010-05-14 22:24:40 +0200301 win_T *wi_win; /* pointer to window that did set wi_fpos */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 pos_T wi_fpos; /* last cursor position in the file */
303 int wi_optset; /* TRUE when wi_opt has useful values */
304 winopt_T wi_opt; /* local window options */
305#ifdef FEAT_FOLDING
306 int wi_fold_manual; /* copy of w_fold_manual */
307 garray_T wi_folds; /* clone of w_folds */
308#endif
309};
310
311/*
312 * Info used to pass info about a fold from the fold-detection code to the
313 * code that displays the foldcolumn.
314 */
315typedef struct foldinfo
316{
317 int fi_level; /* level of the fold; when this is zero the
318 other fields are invalid */
319 int fi_lnum; /* line number where fold starts */
320 int fi_low_level; /* lowest fold level that starts in the same
321 line */
322} foldinfo_T;
323
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000324/* Structure to store info about the Visual area. */
325typedef struct
326{
327 pos_T vi_start; /* start pos of last VIsual */
328 pos_T vi_end; /* end position of last VIsual */
329 int vi_mode; /* VIsual_mode of last VIsual */
330 colnr_T vi_curswant; /* MAXCOL from w_curswant */
331} visualinfo_T;
332
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333/*
Bram Moolenaar335437b2007-05-10 18:32:52 +0000334 * structures used for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335 */
336
337typedef struct u_entry u_entry_T;
338typedef struct u_header u_header_T;
339struct u_entry
340{
341 u_entry_T *ue_next; /* pointer to next entry in list */
342 linenr_T ue_top; /* number of line above undo block */
343 linenr_T ue_bot; /* number of line below undo block */
344 linenr_T ue_lcount; /* linecount when u_save called */
345 char_u **ue_array; /* array of lines in undo block */
346 long ue_size; /* number of lines in ue_array */
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000347#ifdef U_DEBUG
348 int ue_magic; /* magic number to check allocation */
349#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350};
351
352struct u_header
353{
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200354 /* The following have a pointer and a number. The number is used when
355 * reading the undo file in u_read_undo() */
356 union {
357 u_header_T *ptr; /* pointer to next undo header in list */
358 long seq;
359 } uh_next;
360 union {
361 u_header_T *ptr; /* pointer to previous header in list */
362 long seq;
363 } uh_prev;
364 union {
365 u_header_T *ptr; /* pointer to next header for alt. redo */
366 long seq;
367 } uh_alt_next;
368 union {
369 u_header_T *ptr; /* pointer to previous header for alt. redo */
370 long seq;
371 } uh_alt_prev;
Bram Moolenaar1e607892006-03-13 22:15:53 +0000372 long uh_seq; /* sequence number, higher == newer undo */
373 int uh_walk; /* used by undo_time() */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 u_entry_T *uh_entry; /* pointer to first entry */
375 u_entry_T *uh_getbot_entry; /* pointer to where ue_bot must be set */
376 pos_T uh_cursor; /* cursor position before saving */
377#ifdef FEAT_VIRTUALEDIT
378 long uh_cursor_vcol;
379#endif
380 int uh_flags; /* see below */
381 pos_T uh_namedm[NMARKS]; /* marks before undo/after redo */
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000382 visualinfo_T uh_visual; /* Visual areas before undo/after redo */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +0200383 time_T uh_time; /* timestamp when the change was made */
Bram Moolenaar730cde92010-06-27 05:18:54 +0200384 long uh_save_nr; /* set when the file was saved after the
385 changes in this block */
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000386#ifdef U_DEBUG
387 int uh_magic; /* magic number to check allocation */
388#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389};
390
391/* values for uh_flags */
392#define UH_CHANGED 0x01 /* b_changed flag before undo/after redo */
393#define UH_EMPTYBUF 0x02 /* buffer was empty */
394
395/*
Bram Moolenaar335437b2007-05-10 18:32:52 +0000396 * structures used in undo.c
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100398#if VIM_SIZEOF_INT > 2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399# define ALIGN_LONG /* longword alignment and use filler byte */
400# define ALIGN_SIZE (sizeof(long))
401#else
402# define ALIGN_SIZE (sizeof(short))
403#endif
404
405#define ALIGN_MASK (ALIGN_SIZE - 1)
406
407typedef struct m_info minfo_T;
408
409/*
Bram Moolenaar2767c602010-05-16 13:56:06 +0200410 * structure used to link chunks in one of the free chunk lists.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411 */
412struct m_info
413{
414#ifdef ALIGN_LONG
415 long_u m_size; /* size of the chunk (including m_info) */
416#else
417 short_u m_size; /* size of the chunk (including m_info) */
418#endif
419 minfo_T *m_next; /* pointer to next free chunk in the list */
420};
421
422/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423 * things used in memfile.c
424 */
425
426typedef struct block_hdr bhdr_T;
427typedef struct memfile memfile_T;
428typedef long blocknr_T;
429
430/*
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100431 * mf_hashtab_T is a chained hashtable with blocknr_T key and arbitrary
432 * structures as items. This is an intrusive data structure: we require
433 * that items begin with mf_hashitem_T which contains the key and linked
434 * list pointers. List of items in each bucket is doubly-linked.
435 */
436
437typedef struct mf_hashitem_S mf_hashitem_T;
438
439struct mf_hashitem_S
440{
441 mf_hashitem_T *mhi_next;
442 mf_hashitem_T *mhi_prev;
443 blocknr_T mhi_key;
444};
445
446#define MHT_INIT_SIZE 64
447
448typedef struct mf_hashtab_S
449{
450 long_u mht_mask; /* mask used for hash value (nr of items
451 * in array is "mht_mask" + 1) */
452 long_u mht_count; /* nr of items inserted into hashtable */
453 mf_hashitem_T **mht_buckets; /* points to mht_small_buckets or
454 *dynamically allocated array */
455 mf_hashitem_T *mht_small_buckets[MHT_INIT_SIZE]; /* initial buckets */
456 char mht_fixed; /* non-zero value forbids growth */
457} mf_hashtab_T;
458
459/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460 * for each (previously) used block in the memfile there is one block header.
461 *
462 * The block may be linked in the used list OR in the free list.
463 * The used blocks are also kept in hash lists.
464 *
465 * The used list is a doubly linked list, most recently used block first.
466 * The blocks in the used list have a block of memory allocated.
467 * mf_used_count is the number of pages in the used list.
468 * The hash lists are used to quickly find a block in the used list.
469 * The free list is a single linked list, not sorted.
470 * The blocks in the free list have no block of memory allocated and
471 * the contents of the block in the file (if any) is irrelevant.
472 */
473
474struct block_hdr
475{
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100476 mf_hashitem_T bh_hashitem; /* header for hash table and key */
477#define bh_bnum bh_hashitem.mhi_key /* block number, part of bh_hashitem */
478
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 bhdr_T *bh_next; /* next block_hdr in free or used list */
480 bhdr_T *bh_prev; /* previous block_hdr in used list */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000481 char_u *bh_data; /* pointer to memory (for used block) */
482 int bh_page_count; /* number of pages in this block */
483
484#define BH_DIRTY 1
485#define BH_LOCKED 2
486 char bh_flags; /* BH_DIRTY or BH_LOCKED */
487};
488
489/*
490 * when a block with a negative number is flushed to the file, it gets
491 * a positive number. Because the reference to the block is still the negative
492 * number, we remember the translation to the new positive number in the
493 * double linked trans lists. The structure is the same as the hash lists.
494 */
495typedef struct nr_trans NR_TRANS;
496
497struct nr_trans
498{
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100499 mf_hashitem_T nt_hashitem; /* header for hash table and key */
500#define nt_old_bnum nt_hashitem.mhi_key /* old, negative, number */
501
Bram Moolenaar071d4272004-06-13 20:20:40 +0000502 blocknr_T nt_new_bnum; /* new, positive, number */
503};
504
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100505
506typedef struct buffblock buffblock_T;
507typedef struct buffheader buffheader_T;
508
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509/*
510 * structure used to store one block of the stuff/redo/recording buffers
511 */
512struct buffblock
513{
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100514 buffblock_T *b_next; /* pointer to next buffblock */
515 char_u b_str[1]; /* contents (actually longer) */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516};
517
518/*
519 * header used for the stuff buffer and the redo buffer
520 */
521struct buffheader
522{
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100523 buffblock_T bh_first; /* first (dummy) block of list */
524 buffblock_T *bh_curr; /* buffblock for appending */
525 int bh_index; /* index for reading */
526 int bh_space; /* space in bh_curr for appending */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527};
528
Bram Moolenaard4863aa2017-04-07 19:50:12 +0200529typedef struct
530{
531 buffheader_T sr_redobuff;
532 buffheader_T sr_old_redobuff;
533} save_redo_T;
534
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535/*
536 * used for completion on the command line
537 */
538typedef struct expand
539{
540 int xp_context; /* type of expansion */
541 char_u *xp_pattern; /* start of item to expand */
Bram Moolenaar67b891e2009-09-18 15:25:52 +0000542 int xp_pattern_len; /* bytes in xp_pattern before cursor */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543#if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
544 char_u *xp_arg; /* completion function */
545 int xp_scriptID; /* SID for completion function */
546#endif
547 int xp_backslash; /* one of the XP_BS_ values */
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000548#ifndef BACKSLASH_IN_FILENAME
Bram Moolenaarc0cba4d2010-08-07 17:07:21 +0200549 int xp_shell; /* TRUE for a shell command, more
550 characters need to be escaped */
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000551#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552 int xp_numfiles; /* number of files found by
553 file name completion */
554 char_u **xp_files; /* list of files */
Bram Moolenaarb7515462013-06-29 12:58:33 +0200555 char_u *xp_line; /* text being completed */
556 int xp_col; /* cursor position in line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557} expand_T;
558
559/* values for xp_backslash */
560#define XP_BS_NONE 0 /* nothing special for backslashes */
561#define XP_BS_ONE 1 /* uses one backslash before a space */
562#define XP_BS_THREE 2 /* uses three backslashes before a space */
563
564/*
565 * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
566 * This needs to be saved for recursive commands, put them in a structure for
567 * easy manipulation.
568 */
569typedef struct
570{
571 int hide; /* TRUE when ":hide" was used */
Bram Moolenaard812df62008-11-09 12:46:09 +0000572# ifdef FEAT_BROWSE_CMD
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573 int browse; /* TRUE to invoke file dialog */
574# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000575 int split; /* flags for win_split() */
Bram Moolenaardf1bdc92006-02-23 21:32:16 +0000576 int tab; /* > 0 when ":tab" was used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577# 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
Bram Moolenaar4033c552017-09-16 20:54:51 +0200731#define ALIST(win) (win)->w_alist
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732#define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data)
733#define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data)
734#define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data)
735#define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data))
736#define GARGCOUNT (global_alist.al_ga.ga_len)
737#define ARGCOUNT (ALIST(curwin)->al_ga.ga_len)
738#define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len)
739
740/*
741 * A list used for saving values of "emsg_silent". Used by ex_try() to save the
742 * value of "emsg_silent" if it was non-zero. When this is done, the CSF_SILENT
743 * flag below is set.
744 */
745
746typedef struct eslist_elem eslist_T;
747struct eslist_elem
748{
749 int saved_emsg_silent; /* saved value of "emsg_silent" */
750 eslist_T *next; /* next element on the list */
751};
752
753/*
754 * For conditional commands a stack is kept of nested conditionals.
755 * When cs_idx < 0, there is no conditional command.
756 */
757#define CSTACK_LEN 50
758
759struct condstack
760{
Bram Moolenaar12805862005-01-05 22:16:17 +0000761 short cs_flags[CSTACK_LEN]; /* CSF_ flags */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762 char cs_pending[CSTACK_LEN]; /* CSTP_: what's pending in ":finally"*/
763 union {
Bram Moolenaar12805862005-01-05 22:16:17 +0000764 void *csp_rv[CSTACK_LEN]; /* return typeval for pending return */
765 void *csp_ex[CSTACK_LEN]; /* exception for pending throw */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 } cs_pend;
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000767 void *cs_forinfo[CSTACK_LEN]; /* info used by ":for" */
Bram Moolenaar12805862005-01-05 22:16:17 +0000768 int cs_line[CSTACK_LEN]; /* line nr of ":while"/":for" line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 int cs_idx; /* current entry, or -1 if none */
Bram Moolenaar12805862005-01-05 22:16:17 +0000770 int cs_looplevel; /* nr of nested ":while"s and ":for"s */
771 int cs_trylevel; /* nr of nested ":try"s */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 eslist_T *cs_emsg_silent_list; /* saved values of "emsg_silent" */
Bram Moolenaar12805862005-01-05 22:16:17 +0000773 char cs_lflags; /* loop flags: CSL_ flags */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774};
Bram Moolenaar12805862005-01-05 22:16:17 +0000775# define cs_rettv cs_pend.csp_rv
776# define cs_exception cs_pend.csp_ex
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000778/* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
779 * was used. */
Bram Moolenaar12805862005-01-05 22:16:17 +0000780# define CSF_TRUE 0x0001 /* condition was TRUE */
781# define CSF_ACTIVE 0x0002 /* current state is active */
782# define CSF_ELSE 0x0004 /* ":else" has been passed */
783# define CSF_WHILE 0x0008 /* is a ":while" */
784# define CSF_FOR 0x0010 /* is a ":for" */
785
786# define CSF_TRY 0x0100 /* is a ":try" */
787# define CSF_FINALLY 0x0200 /* ":finally" has been passed */
788# define CSF_THROWN 0x0400 /* exception thrown to this try conditional */
789# define CSF_CAUGHT 0x0800 /* exception caught by this try conditional */
790# define CSF_SILENT 0x1000 /* "emsg_silent" reset by ":try" */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791/* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
792 * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
793
794/*
795 * What's pending for being reactivated at the ":endtry" of this try
796 * conditional:
797 */
798# define CSTP_NONE 0 /* nothing pending in ":finally" clause */
799# define CSTP_ERROR 1 /* an error is pending */
800# define CSTP_INTERRUPT 2 /* an interrupt is pending */
801# define CSTP_THROW 4 /* a throw is pending */
802# define CSTP_BREAK 8 /* ":break" is pending */
803# define CSTP_CONTINUE 16 /* ":continue" is pending */
804# define CSTP_RETURN 24 /* ":return" is pending */
805# define CSTP_FINISH 32 /* ":finish" is pending */
806
807/*
Bram Moolenaar12805862005-01-05 22:16:17 +0000808 * Flags for the cs_lflags item in struct condstack.
809 */
810# define CSL_HAD_LOOP 1 /* just found ":while" or ":for" */
811# define CSL_HAD_ENDLOOP 2 /* just found ":endwhile" or ":endfor" */
812# define CSL_HAD_CONT 4 /* just found ":continue" */
813# define CSL_HAD_FINA 8 /* just found ":finally" */
814
815/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 * A list of error messages that can be converted to an exception. "throw_msg"
817 * is only set in the first element of the list. Usually, it points to the
818 * original message stored in that element, but sometimes it points to a later
819 * message in the list. See cause_errthrow() below.
820 */
821struct msglist
822{
823 char_u *msg; /* original message */
824 char_u *throw_msg; /* msg to throw: usually original one */
825 struct msglist *next; /* next of several messages in a row */
826};
827
828/*
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100829 * The exception types.
830 */
831typedef enum
832{
833 ET_USER, /* exception caused by ":throw" command */
834 ET_ERROR, /* error exception */
835 ET_INTERRUPT /* interrupt exception triggered by Ctrl-C */
836} except_type_T;
837
838/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 * Structure describing an exception.
840 * (don't use "struct exception", it's used by the math library).
841 */
842typedef struct vim_exception except_T;
843struct vim_exception
844{
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100845 except_type_T type; /* exception type */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 char_u *value; /* exception value */
847 struct msglist *messages; /* message(s) causing error exception */
848 char_u *throw_name; /* name of the throw point */
849 linenr_T throw_lnum; /* line number of the throw point */
850 except_T *caught; /* next exception on the caught stack */
851};
852
853/*
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000854 * Structure to save the error/interrupt/exception state between calls to
855 * enter_cleanup() and leave_cleanup(). Must be allocated as an automatic
856 * variable by the (common) caller of these functions.
857 */
858typedef struct cleanup_stuff cleanup_T;
859struct cleanup_stuff
860{
861 int pending; /* error/interrupt/exception state */
862 except_T *exception; /* exception value */
863};
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864
865#ifdef FEAT_SYN_HL
866/* struct passed to in_id_list() */
867struct sp_syn
868{
869 int inc_tag; /* ":syn include" unique tag */
870 short id; /* highlight group ID of item */
871 short *cont_in_list; /* cont.in group IDs, if non-zero */
872};
873
874/*
875 * Each keyword has one keyentry, which is linked in a hash list.
876 */
877typedef struct keyentry keyentry_T;
878
879struct keyentry
880{
Bram Moolenaar8f999f12005-01-25 22:12:55 +0000881 keyentry_T *ke_next; /* next entry with identical "keyword[]" */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 struct sp_syn k_syn; /* struct passed to in_id_list() */
883 short *next_list; /* ID list for next match (if non-zero) */
Bram Moolenaar860cae12010-06-05 23:22:07 +0200884 int flags;
885 int k_char; /* conceal substitute character */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 char_u keyword[1]; /* actually longer */
887};
888
889/*
890 * Struct used to store one state of the state stack.
891 */
892typedef struct buf_state
893{
894 int bs_idx; /* index of pattern */
Bram Moolenaar860cae12010-06-05 23:22:07 +0200895 int bs_flags; /* flags for pattern */
Bram Moolenaar6e202e52010-07-28 18:14:45 +0200896#ifdef FEAT_CONCEAL
897 int bs_seqnr; /* stores si_seqnr */
898 int bs_cchar; /* stores si_cchar */
899#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900 reg_extmatch_T *bs_extmatch; /* external matches from start pattern */
901} bufstate_T;
902
903/*
904 * syn_state contains the syntax state stack for the start of one line.
905 * Used by b_sst_array[].
906 */
907typedef struct syn_state synstate_T;
908
909struct syn_state
910{
911 synstate_T *sst_next; /* next entry in used or free list */
912 linenr_T sst_lnum; /* line number for this state */
913 union
914 {
915 bufstate_T sst_stack[SST_FIX_STATES]; /* short state stack */
916 garray_T sst_ga; /* growarray for long state stack */
917 } sst_union;
918 int sst_next_flags; /* flags for sst_next_list */
Bram Moolenaar2767c602010-05-16 13:56:06 +0200919 int sst_stacksize; /* number of states on the stack */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 short *sst_next_list; /* "nextgroup" list in this state
921 * (this is a copy, don't free it! */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 disptick_T sst_tick; /* tick when last displayed */
923 linenr_T sst_change_lnum;/* when non-zero, change in this line
924 * may have made the state invalid */
925};
926#endif /* FEAT_SYN_HL */
927
928/*
929 * Structure shared between syntax.c, screen.c and gui_x11.c.
930 */
931typedef struct attr_entry
932{
933 short ae_attr; /* HL_BOLD, etc. */
934 union
935 {
936 struct
937 {
938 char_u *start; /* start escape sequence */
939 char_u *stop; /* stop escape sequence */
940 } term;
941 struct
942 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000943 /* These colors need to be > 8 bits to hold 256. */
944 short_u fg_color; /* foreground color number */
945 short_u bg_color; /* background color number */
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200946# ifdef FEAT_TERMGUICOLORS
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +0200947 guicolor_T fg_rgb; /* foreground color RGB */
948 guicolor_T bg_rgb; /* background color RGB */
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200949# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 } cterm;
951# ifdef FEAT_GUI
952 struct
953 {
954 guicolor_T fg_color; /* foreground color handle */
955 guicolor_T bg_color; /* background color handle */
Bram Moolenaare2cc9702005-03-15 22:43:58 +0000956 guicolor_T sp_color; /* special color handle */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 GuiFont font; /* font handle */
958# ifdef FEAT_XFONTSET
959 GuiFontset fontset; /* fontset handle */
960# endif
961 } gui;
962# endif
963 } ae_u;
964} attrentry_T;
965
966#ifdef USE_ICONV
967# ifdef HAVE_ICONV_H
968# include <iconv.h>
969# else
970# if defined(MACOS_X)
971# include <sys/errno.h>
972# define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
973typedef struct _iconv_t *iconv_t;
974# else
975# if defined(MACOS_CLASSIC)
976typedef struct _iconv_t *iconv_t;
977# define EINVAL 22
978# define E2BIG 7
979# define ENOENT 2
980# define EFAULT 14
981# define EILSEQ 123
982# else
983# include <errno.h>
984# endif
985# endif
986typedef void *iconv_t;
987# endif
988#endif
989
990/*
991 * Used for the typeahead buffer: typebuf.
992 */
993typedef struct
994{
995 char_u *tb_buf; /* buffer for typed characters */
996 char_u *tb_noremap; /* mapping flags for characters in tb_buf[] */
997 int tb_buflen; /* size of tb_buf[] */
998 int tb_off; /* current position in tb_buf[] */
999 int tb_len; /* number of valid bytes in tb_buf[] */
1000 int tb_maplen; /* nr of mapped bytes in tb_buf[] */
1001 int tb_silent; /* nr of silently mapped bytes in tb_buf[] */
1002 int tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */
1003 int tb_change_cnt; /* nr of time tb_buf was changed; never zero */
1004} typebuf_T;
1005
1006/* Struct to hold the saved typeahead for save_typeahead(). */
1007typedef struct
1008{
1009 typebuf_T save_typebuf;
1010 int typebuf_valid; /* TRUE when save_typebuf valid */
Bram Moolenaar13df0fe2009-07-09 16:24:19 +00001011 int old_char;
1012 int old_mod_mask;
Bram Moolenaar0a36fec2014-02-11 15:10:43 +01001013 buffheader_T save_readbuf1;
1014 buffheader_T save_readbuf2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015#ifdef USE_INPUT_BUF
1016 char_u *save_inputbuf;
1017#endif
1018} tasave_T;
1019
1020/*
1021 * Used for conversion of terminal I/O and script files.
1022 */
1023typedef struct
1024{
1025 int vc_type; /* zero or one of the CONV_ values */
1026 int vc_factor; /* max. expansion factor */
1027# ifdef WIN3264
1028 int vc_cpfrom; /* codepage to convert from (CONV_CODEPAGE) */
1029 int vc_cpto; /* codepage to convert to (CONV_CODEPAGE) */
1030# endif
1031# ifdef USE_ICONV
1032 iconv_t vc_fd; /* for CONV_ICONV */
1033# endif
1034 int vc_fail; /* fail for invalid char, don't use '?' */
1035} vimconv_T;
1036
1037/*
1038 * Structure used for reading from the viminfo file.
1039 */
1040typedef struct
1041{
1042 char_u *vir_line; /* text of the current line */
1043 FILE *vir_fd; /* file descriptor */
1044#ifdef FEAT_MBYTE
1045 vimconv_T vir_conv; /* encoding conversion */
1046#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001047 int vir_version; /* viminfo version detected or -1 */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001048 garray_T vir_barlines; /* lines starting with | */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049} vir_T;
1050
1051#define CONV_NONE 0
1052#define CONV_TO_UTF8 1
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001053#define CONV_9_TO_UTF8 2
1054#define CONV_TO_LATIN1 3
1055#define CONV_TO_LATIN9 4
1056#define CONV_ICONV 5
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057#ifdef WIN3264
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001058# define CONV_CODEPAGE 10 /* codepage -> codepage */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059#endif
1060#ifdef MACOS_X
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001061# define CONV_MAC_LATIN1 20
1062# define CONV_LATIN1_MAC 21
1063# define CONV_MAC_UTF8 22
1064# define CONV_UTF8_MAC 23
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065#endif
1066
1067/*
1068 * Structure used for mappings and abbreviations.
1069 */
1070typedef struct mapblock mapblock_T;
1071struct mapblock
1072{
1073 mapblock_T *m_next; /* next mapblock in list */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001074 char_u *m_keys; /* mapped from, lhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001075 char_u *m_str; /* mapped to, rhs */
1076 char_u *m_orig_str; /* rhs as entered by the user */
Bram Moolenaarf3fe3922013-06-29 14:47:22 +02001077 int m_keylen; /* strlen(m_keys) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 int m_mode; /* valid mode */
1079 int m_noremap; /* if non-zero no re-mapping for m_str */
1080 char m_silent; /* <silent> used, don't echo commands */
Bram Moolenaarf3fe3922013-06-29 14:47:22 +02001081 char m_nowait; /* <nowait> used */
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001082#ifdef FEAT_EVAL
Bram Moolenaara94bc432006-03-10 21:42:59 +00001083 char m_expr; /* <expr> used, m_str is an expression */
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001084 scid_T m_script_ID; /* ID of script where map was defined */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085#endif
1086};
1087
1088/*
1089 * Used for highlighting in the status line.
1090 */
1091struct stl_hlrec
1092{
1093 char_u *start;
Bram Moolenaar238a5642006-02-21 22:12:05 +00001094 int userhl; /* 0: no HL, 1-9: User HL, < 0 for syn ID */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095};
1096
Bram Moolenaar860cae12010-06-05 23:22:07 +02001097
1098/*
1099 * Syntax items - usually buffer-specific.
1100 */
1101
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001102/* Item for a hashtable. "hi_key" can be one of three values:
1103 * NULL: Never been used
1104 * HI_KEY_REMOVED: Entry was removed
1105 * Otherwise: Used item, pointer to the actual key; this usually is
1106 * inside the item, subtract an offset to locate the item.
1107 * This reduces the size of hashitem by 1/3.
1108 */
1109typedef struct hashitem_S
1110{
1111 long_u hi_hash; /* cached hash number of hi_key */
1112 char_u *hi_key;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001113} hashitem_T;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001114
1115/* The address of "hash_removed" is used as a magic number for hi_key to
1116 * indicate a removed item. */
1117#define HI_KEY_REMOVED &hash_removed
1118#define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
1119
1120/* Initial size for a hashtable. Our items are relatively small and growing
1121 * is expensive, thus use 16 as a start. Must be a power of 2. */
1122#define HT_INIT_SIZE 16
1123
1124typedef struct hashtable_S
1125{
1126 long_u ht_mask; /* mask used for hash value (nr of items in
1127 * array is "ht_mask" + 1) */
Bram Moolenaar677ee682005-01-27 14:41:15 +00001128 long_u ht_used; /* number of items used */
1129 long_u ht_filled; /* number of items used + removed */
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001130 int ht_locked; /* counter for hash_lock() */
1131 int ht_error; /* when set growing failed, can't add more
1132 items before growing works */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001133 hashitem_T *ht_array; /* points to the array, allocated when it's
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001134 not "ht_smallarray" */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001135 hashitem_T ht_smallarray[HT_INIT_SIZE]; /* initial array */
1136} hashtab_T;
1137
1138typedef long_u hash_T; /* Type for hi_hash */
1139
1140
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001141#ifdef FEAT_NUM64
1142/* Use 64-bit Number. */
1143# ifdef WIN3264
Bram Moolenaard90b6c02016-08-28 18:10:45 +02001144# ifdef PROTO
1145typedef long varnumber_T;
1146typedef unsigned long uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001147#define VARNUM_MIN LONG_MIN
1148#define VARNUM_MAX LONG_MAX
1149#define UVARNUM_MAX ULONG_MAX
Bram Moolenaard90b6c02016-08-28 18:10:45 +02001150# else
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001151typedef __int64 varnumber_T;
1152typedef unsigned __int64 uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001153#define VARNUM_MIN _I64_MIN
1154#define VARNUM_MAX _I64_MAX
1155#define UVARNUM_MAX _UI64_MAX
Bram Moolenaard90b6c02016-08-28 18:10:45 +02001156# endif
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001157# elif defined(HAVE_STDINT_H)
1158typedef int64_t varnumber_T;
1159typedef uint64_t uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001160#define VARNUM_MIN INT64_MIN
1161#define VARNUM_MAX INT64_MAX
1162#define UVARNUM_MAX UINT64_MAX
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001163# else
1164typedef long varnumber_T;
1165typedef unsigned long uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001166#define VARNUM_MIN LONG_MIN
1167#define VARNUM_MAX LONG_MAX
1168#define UVARNUM_MAX ULONG_MAX
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001169# endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001170#else
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001171/* Use 32-bit Number. */
1172# if VIM_SIZEOF_INT <= 3 /* use long if int is smaller than 32 bits */
1173typedef long varnumber_T;
1174typedef unsigned long uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001175#define VARNUM_MIN LONG_MIN
1176#define VARNUM_MAX LONG_MAX
1177#define UVARNUM_MAX ULONG_MAX
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001178# else
1179typedef int varnumber_T;
1180typedef unsigned int uvarnumber_T;
Bram Moolenaar7a40ea22017-01-22 18:34:57 +01001181#define VARNUM_MIN INT_MIN
1182#define VARNUM_MAX INT_MAX
1183#define UVARNUM_MAX UINT_MAX
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001184# endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001185#endif
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001186
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001187typedef double float_T;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001188
1189typedef struct listvar_S list_T;
1190typedef struct dictvar_S dict_T;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001191typedef struct partial_S partial_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001192
Bram Moolenaar835dc632016-02-07 14:27:38 +01001193typedef struct jobvar_S job_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001194typedef struct readq_S readq_T;
Bram Moolenaar97bd5e62017-08-18 20:50:30 +02001195typedef struct writeq_S writeq_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001196typedef struct jsonq_S jsonq_T;
1197typedef struct cbq_S cbq_T;
1198typedef struct channel_S channel_T;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001199
Bram Moolenaara03f2332016-02-06 18:09:59 +01001200typedef enum
1201{
1202 VAR_UNKNOWN = 0,
Bram Moolenaar835dc632016-02-07 14:27:38 +01001203 VAR_NUMBER, /* "v_number" is used */
1204 VAR_STRING, /* "v_string" is used */
1205 VAR_FUNC, /* "v_string" is function name */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001206 VAR_PARTIAL, /* "v_partial" is used */
Bram Moolenaar835dc632016-02-07 14:27:38 +01001207 VAR_LIST, /* "v_list" is used */
1208 VAR_DICT, /* "v_dict" is used */
1209 VAR_FLOAT, /* "v_float" is used */
1210 VAR_SPECIAL, /* "v_number" is used */
Bram Moolenaar77073442016-02-13 23:23:53 +01001211 VAR_JOB, /* "v_job" is used */
1212 VAR_CHANNEL /* "v_channel" is used */
Bram Moolenaara03f2332016-02-06 18:09:59 +01001213} vartype_T;
1214
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001215/*
1216 * Structure to hold an internal variable without a name.
1217 */
1218typedef struct
1219{
Bram Moolenaara03f2332016-02-06 18:09:59 +01001220 vartype_T v_type;
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001221 char v_lock; /* see below: VAR_LOCKED, VAR_FIXED */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001222 union
1223 {
1224 varnumber_T v_number; /* number value */
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001225#ifdef FEAT_FLOAT
1226 float_T v_float; /* floating number value */
1227#endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001228 char_u *v_string; /* string value (can be NULL!) */
1229 list_T *v_list; /* list value (can be NULL!) */
1230 dict_T *v_dict; /* dict value (can be NULL!) */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001231 partial_T *v_partial; /* closure: function with args */
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01001232#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01001233 job_T *v_job; /* job value (can be NULL!) */
Bram Moolenaar77073442016-02-13 23:23:53 +01001234 channel_T *v_channel; /* channel value (can be NULL!) */
1235#endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001236 } vval;
1237} typval_T;
1238
Bram Moolenaarbdb62052012-07-16 17:31:53 +02001239/* Values for "dv_scope". */
1240#define VAR_SCOPE 1 /* a:, v:, s:, etc. scope dictionaries */
1241#define VAR_DEF_SCOPE 2 /* l:, g: scope dictionaries: here funcrefs are not
1242 allowed to mask existing functions */
1243
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001244/* Values for "v_lock". */
1245#define VAR_LOCKED 1 /* locked with lock(), can use unlock() */
1246#define VAR_FIXED 2 /* locked forever */
1247
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001248/*
1249 * Structure to hold an item of a list: an internal variable without a name.
1250 */
1251typedef struct listitem_S listitem_T;
1252
1253struct listitem_S
1254{
1255 listitem_T *li_next; /* next item in list */
1256 listitem_T *li_prev; /* previous item in list */
1257 typval_T li_tv; /* type and value of the variable */
1258};
1259
1260/*
1261 * Struct used by those that are using an item in a list.
1262 */
1263typedef struct listwatch_S listwatch_T;
1264
1265struct listwatch_S
1266{
1267 listitem_T *lw_item; /* item being watched */
1268 listwatch_T *lw_next; /* next watcher */
1269};
1270
1271/*
1272 * Structure to hold info about a list.
1273 */
1274struct listvar_S
1275{
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001276 listitem_T *lv_first; /* first item, NULL if none */
1277 listitem_T *lv_last; /* last item, NULL if none */
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00001278 int lv_refcount; /* reference count */
1279 int lv_len; /* number of items */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001280 listwatch_T *lv_watch; /* first watcher, NULL if none */
Bram Moolenaar748bf032005-02-02 23:04:36 +00001281 int lv_idx; /* cached index of an item */
1282 listitem_T *lv_idx_item; /* when not NULL item at index "lv_idx" */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001283 int lv_copyID; /* ID used by deepcopy() */
1284 list_T *lv_copylist; /* copied list used by deepcopy() */
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001285 char lv_lock; /* zero, VAR_LOCKED, VAR_FIXED */
Bram Moolenaar46152342005-09-07 21:18:43 +00001286 list_T *lv_used_next; /* next list in used lists list */
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00001287 list_T *lv_used_prev; /* previous list in used lists list */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001288};
1289
1290/*
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001291 * Static list with 10 items. Use init_static_list() to initialize.
1292 */
1293typedef struct {
1294 list_T sl_list; /* must be first */
1295 listitem_T sl_items[10];
1296} staticList10_T;
1297
1298/*
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001299 * Structure to hold an item of a Dictionary.
1300 * Also used for a variable.
1301 * The key is copied into "di_key" to avoid an extra alloc/free for it.
1302 */
1303struct dictitem_S
1304{
1305 typval_T di_tv; /* type and value of the variable */
1306 char_u di_flags; /* flags (only used for variable) */
1307 char_u di_key[1]; /* key (actually longer!) */
1308};
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001309typedef struct dictitem_S dictitem_T;
1310
Bram Moolenaarbee6c0c2016-03-25 15:40:50 +01001311/* A dictitem with a 16 character key (plus NUL). */
1312struct dictitem16_S
1313{
1314 typval_T di_tv; /* type and value of the variable */
1315 char_u di_flags; /* flags (only used for variable) */
1316 char_u di_key[17]; /* key */
1317};
1318typedef struct dictitem16_S dictitem16_T;
1319
Bram Moolenaar9bc174b2015-04-13 16:16:38 +02001320#define DI_FLAGS_RO 1 /* "di_flags" value: read-only variable */
1321#define DI_FLAGS_RO_SBX 2 /* "di_flags" value: read-only in the sandbox */
1322#define DI_FLAGS_FIX 4 /* "di_flags" value: fixed: no :unlet or remove() */
1323#define DI_FLAGS_LOCK 8 /* "di_flags" value: locked variable */
1324#define DI_FLAGS_ALLOC 16 /* "di_flags" value: separately allocated */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001325
1326/*
1327 * Structure to hold info about a Dictionary.
1328 */
1329struct dictvar_S
1330{
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001331 char dv_lock; /* zero, VAR_LOCKED, VAR_FIXED */
Bram Moolenaarbdb62052012-07-16 17:31:53 +02001332 char dv_scope; /* zero, VAR_SCOPE, VAR_DEF_SCOPE */
Bram Moolenaar6395af82013-06-12 19:52:15 +02001333 int dv_refcount; /* reference count */
1334 int dv_copyID; /* ID used by deepcopy() */
1335 hashtab_T dv_hashtab; /* hashtab that refers to the items */
1336 dict_T *dv_copydict; /* copied dict used by deepcopy() */
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00001337 dict_T *dv_used_next; /* next dict in used dicts list */
1338 dict_T *dv_used_prev; /* previous dict in used dicts list */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001339};
1340
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001341#if defined(FEAT_EVAL) || defined(PROTO)
1342typedef struct funccall_S funccall_T;
1343
1344/*
1345 * Structure to hold info for a user function.
1346 */
1347typedef struct
1348{
1349 int uf_varargs; /* variable nr of arguments */
1350 int uf_flags;
1351 int uf_calls; /* nr of active calls */
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001352 int uf_cleared; /* func_clear() was already called */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001353 garray_T uf_args; /* arguments */
1354 garray_T uf_lines; /* function lines */
1355#ifdef FEAT_PROFILE
1356 int uf_profiling; /* TRUE when func is being profiled */
1357 /* profiling the function as a whole */
1358 int uf_tm_count; /* nr of calls */
1359 proftime_T uf_tm_total; /* time spent in function + children */
1360 proftime_T uf_tm_self; /* time spent in function itself */
1361 proftime_T uf_tm_children; /* time spent in children this call */
1362 /* profiling the function per line */
1363 int *uf_tml_count; /* nr of times line was executed */
1364 proftime_T *uf_tml_total; /* time spent in a line + children */
1365 proftime_T *uf_tml_self; /* time spent in a line itself */
1366 proftime_T uf_tml_start; /* start time for current line */
1367 proftime_T uf_tml_children; /* time spent in children for this line */
1368 proftime_T uf_tml_wait; /* start wait time for current line */
1369 int uf_tml_idx; /* index of line being timed; -1 if none */
1370 int uf_tml_execed; /* line being timed was executed */
1371#endif
1372 scid_T uf_script_ID; /* ID of script where function was defined,
1373 used for s: variables */
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001374 int uf_refcount; /* reference count, see func_name_refcount() */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001375 funccall_T *uf_scoped; /* l: local variables for closure */
1376 char_u uf_name[1]; /* name of function (actually longer); can
1377 start with <SNR>123_ (<SNR> is K_SPECIAL
1378 KS_EXTRA KE_SNR) */
1379} ufunc_T;
1380
1381#define MAX_FUNC_ARGS 20 /* maximum number of function arguments */
1382#define VAR_SHORT_LEN 20 /* short variable name length */
1383#define FIXVAR_CNT 12 /* number of fixed variables */
1384
1385/* structure to hold info for a function that is currently being executed. */
1386struct funccall_S
1387{
1388 ufunc_T *func; /* function being called */
1389 int linenr; /* next line to be executed */
1390 int returned; /* ":return" used */
1391 struct /* fixed variables for arguments */
1392 {
1393 dictitem_T var; /* variable (without room for name) */
1394 char_u room[VAR_SHORT_LEN]; /* room for the name */
1395 } fixvar[FIXVAR_CNT];
1396 dict_T l_vars; /* l: local function variables */
1397 dictitem_T l_vars_var; /* variable for l: scope */
1398 dict_T l_avars; /* a: argument variables */
1399 dictitem_T l_avars_var; /* variable for a: scope */
1400 list_T l_varlist; /* list for a:000 */
1401 listitem_T l_listitems[MAX_FUNC_ARGS]; /* listitems for a:000 */
1402 typval_T *rettv; /* return value */
1403 linenr_T breakpoint; /* next line with breakpoint or zero */
1404 int dbg_tick; /* debug_tick when breakpoint was set */
1405 int level; /* top nesting level of executed function */
1406#ifdef FEAT_PROFILE
1407 proftime_T prof_child; /* time spent in a child */
1408#endif
1409 funccall_T *caller; /* calling function or NULL */
1410
1411 /* for closure */
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001412 int fc_refcount; /* number of user functions that reference this
1413 * funccal */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001414 int fc_copyID; /* for garbage collection */
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001415 garray_T fc_funcs; /* list of ufunc_T* which keep a reference to
1416 * "func" */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001417};
1418
1419/*
1420 * Struct used by trans_function_name()
1421 */
1422typedef struct
1423{
1424 dict_T *fd_dict; /* Dictionary used */
1425 char_u *fd_newkey; /* new key in "dict" in allocated memory */
1426 dictitem_T *fd_di; /* Dictionary item used */
1427} funcdict_T;
1428
Bram Moolenaaracadbea2016-08-01 16:35:59 +02001429#else
1430/* dummy typedefs for function prototypes */
1431typedef struct
1432{
1433 int dummy;
1434} ufunc_T;
1435typedef struct
1436{
1437 int dummy;
1438} funcdict_T;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001439#endif
1440
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001441struct partial_S
1442{
1443 int pt_refcount; /* reference count */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001444 char_u *pt_name; /* function name; when NULL use
1445 * pt_func->uf_name */
1446 ufunc_T *pt_func; /* function pointer; when NULL lookup function
1447 * with pt_name */
Bram Moolenaar1d429612016-05-24 15:44:17 +02001448 int pt_auto; /* when TRUE the partial was created for using
1449 dict.member in handle_subscript() */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001450 int pt_argc; /* number of arguments */
1451 typval_T *pt_argv; /* arguments in allocated array */
1452 dict_T *pt_dict; /* dict for "self" */
1453};
1454
Bram Moolenaar6b93b0e2017-08-13 20:28:53 +02001455/* Information returned by get_tty_info(). */
1456typedef struct {
1457 int backspace; /* what the Backspace key produces */
1458 int enter; /* what the Enter key produces */
1459 int interrupt; /* interrupt character */
1460 int nl_does_cr; /* TRUE when a NL is expanded to CR-NL on output */
1461} ttyinfo_T;
1462
Bram Moolenaar7df915d2016-11-17 17:25:32 +01001463/* Status of a job. Order matters! */
Bram Moolenaar835dc632016-02-07 14:27:38 +01001464typedef enum
1465{
1466 JOB_FAILED,
1467 JOB_STARTED,
Bram Moolenaar7df915d2016-11-17 17:25:32 +01001468 JOB_ENDED, /* detected job done */
1469 JOB_FINISHED /* job done and cleanup done */
Bram Moolenaar835dc632016-02-07 14:27:38 +01001470} jobstatus_T;
1471
1472/*
1473 * Structure to hold info about a Job.
1474 */
1475struct jobvar_S
1476{
Bram Moolenaar65edff82016-02-21 16:40:11 +01001477 job_T *jv_next;
1478 job_T *jv_prev;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001479#ifdef UNIX
1480 pid_t jv_pid;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001481#endif
1482#ifdef WIN32
Bram Moolenaar76467df2016-02-12 19:30:26 +01001483 PROCESS_INFORMATION jv_proc_info;
Bram Moolenaar14207f42016-10-27 21:13:10 +02001484 HANDLE jv_job_object;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001485#endif
Bram Moolenaar2dc9d262017-09-08 14:39:30 +02001486 char_u *jv_tty_in; /* controlling tty input, allocated */
1487 char_u *jv_tty_out; /* controlling tty output, allocated */
Bram Moolenaar835dc632016-02-07 14:27:38 +01001488 jobstatus_T jv_status;
Bram Moolenaar65edff82016-02-21 16:40:11 +01001489 char_u *jv_stoponexit; /* allocated */
Bram Moolenaareab089d2016-02-21 19:32:02 +01001490 int jv_exitval;
Bram Moolenaaree1cffc2016-02-21 19:14:41 +01001491 char_u *jv_exit_cb; /* allocated */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001492 partial_T *jv_exit_partial;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001493
Bram Moolenaar014069a2016-03-03 22:51:40 +01001494 buf_T *jv_in_buf; /* buffer from "in-name" */
1495
Bram Moolenaar835dc632016-02-07 14:27:38 +01001496 int jv_refcount; /* reference count */
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02001497 int jv_copyID;
1498
Bram Moolenaar77073442016-02-13 23:23:53 +01001499 channel_T *jv_channel; /* channel for I/O, reference counted */
Bram Moolenaar835dc632016-02-07 14:27:38 +01001500};
1501
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001502/*
1503 * Structures to hold info about a Channel.
1504 */
1505struct readq_S
1506{
Bram Moolenaar77073442016-02-13 23:23:53 +01001507 char_u *rq_buffer;
Bram Moolenaar9ed96ef2016-06-04 17:17:11 +02001508 long_u rq_buflen;
Bram Moolenaar77073442016-02-13 23:23:53 +01001509 readq_T *rq_next;
1510 readq_T *rq_prev;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001511};
1512
Bram Moolenaar97bd5e62017-08-18 20:50:30 +02001513struct writeq_S
1514{
1515 garray_T wq_ga;
1516 writeq_T *wq_next;
1517 writeq_T *wq_prev;
1518};
1519
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001520struct jsonq_S
1521{
Bram Moolenaar77073442016-02-13 23:23:53 +01001522 typval_T *jq_value;
1523 jsonq_T *jq_next;
1524 jsonq_T *jq_prev;
Bram Moolenaar958dc692016-12-01 15:34:12 +01001525 int jq_no_callback; /* TRUE when no callback was found */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001526};
1527
1528struct cbq_S
1529{
Bram Moolenaar77073442016-02-13 23:23:53 +01001530 char_u *cq_callback;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001531 partial_T *cq_partial;
Bram Moolenaar77073442016-02-13 23:23:53 +01001532 int cq_seq_nr;
1533 cbq_T *cq_next;
1534 cbq_T *cq_prev;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001535};
1536
1537/* mode for a channel */
1538typedef enum
1539{
Bram Moolenaar77073442016-02-13 23:23:53 +01001540 MODE_NL = 0,
1541 MODE_RAW,
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001542 MODE_JSON,
1543 MODE_JS
1544} ch_mode_T;
1545
Bram Moolenaar580984e2016-03-20 21:17:13 +01001546typedef enum {
1547 JIO_PIPE, /* default */
1548 JIO_NULL,
1549 JIO_FILE,
1550 JIO_BUFFER,
1551 JIO_OUT
1552} job_io_T;
1553
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001554#define CH_PART_FD(part) ch_part[part].ch_fd
1555
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01001556/* Ordering matters, it is used in for loops: IN is last, only SOCK/OUT/ERR
1557 * are polled. */
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001558typedef enum {
1559 PART_SOCK = 0,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001560#define CH_SOCK_FD CH_PART_FD(PART_SOCK)
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01001561#ifdef FEAT_JOB_CHANNEL
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001562 PART_OUT,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001563# define CH_OUT_FD CH_PART_FD(PART_OUT)
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001564 PART_ERR,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001565# define CH_ERR_FD CH_PART_FD(PART_ERR)
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001566 PART_IN,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001567# define CH_IN_FD CH_PART_FD(PART_IN)
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001568#endif
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001569 PART_COUNT
1570} ch_part_T;
1571
1572#define INVALID_FD (-1)
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001573
1574/* The per-fd info for a channel. */
1575typedef struct {
1576 sock_T ch_fd; /* socket/stdin/stdout/stderr, -1 if not used */
1577
1578# if defined(UNIX) && !defined(HAVE_SELECT)
1579 int ch_poll_idx; /* used by channel_poll_setup() */
1580# endif
1581
1582#ifdef FEAT_GUI_X11
1583 XtInputId ch_inputHandler; /* Cookie for input */
1584#endif
1585#ifdef FEAT_GUI_GTK
1586 gint ch_inputHandler; /* Cookie for input */
1587#endif
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001588
1589 ch_mode_T ch_mode;
Bram Moolenaar580984e2016-03-20 21:17:13 +01001590 job_io_T ch_io;
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001591 int ch_timeout; /* request timeout in msec */
1592
1593 readq_T ch_head; /* header for circular raw read queue */
1594 jsonq_T ch_json_head; /* header for circular json read queue */
1595 int ch_block_id; /* ID that channel_read_json_block() is
1596 waiting for */
Bram Moolenaar88989cc2017-02-06 21:56:09 +01001597 /* When ch_wait_len is non-zero use ch_deadline to wait for incomplete
1598 * message to be complete. The value is the length of the incomplete
1599 * message when the deadline was set. If it gets longer (something was
1600 * received) the deadline is reset. */
1601 size_t ch_wait_len;
Bram Moolenaarba61ac02016-03-20 16:40:37 +01001602#ifdef WIN32
1603 DWORD ch_deadline;
1604#else
1605 struct timeval ch_deadline;
1606#endif
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02001607 int ch_block_write; /* for testing: 0 when not used, -1 when write
1608 * does not block, 1 simulate blocking */
Bram Moolenaar97bd5e62017-08-18 20:50:30 +02001609 int ch_nonblocking; /* write() is non-blocking */
1610 writeq_T ch_writeque; /* header for write queue */
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001611
1612 cbq_T ch_cb_head; /* dummy node for per-request callbacks */
1613 char_u *ch_callback; /* call when a msg is not handled */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001614 partial_T *ch_partial;
Bram Moolenaar014069a2016-03-03 22:51:40 +01001615
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001616 bufref_T ch_bufref; /* buffer to read from or write to */
Bram Moolenaar9f5842e2016-05-29 16:17:08 +02001617 int ch_nomodifiable; /* TRUE when buffer can be 'nomodifiable' */
1618 int ch_nomod_error; /* TRUE when e_modifiable was given */
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02001619 int ch_buf_append; /* write appended lines instead top-bot */
Bram Moolenaar014069a2016-03-03 22:51:40 +01001620 linenr_T ch_buf_top; /* next line to send */
1621 linenr_T ch_buf_bot; /* last line to send */
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001622} chanpart_T;
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001623
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001624struct channel_S {
Bram Moolenaar77073442016-02-13 23:23:53 +01001625 channel_T *ch_next;
1626 channel_T *ch_prev;
1627
1628 int ch_id; /* ID of the channel */
Bram Moolenaare9d6a292016-03-20 19:31:33 +01001629 int ch_last_msg_id; /* ID of the last message */
Bram Moolenaar77073442016-02-13 23:23:53 +01001630
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001631 chanpart_T ch_part[PART_COUNT]; /* info for socket, out, err and in */
Bram Moolenaaref68e4f2017-09-02 16:28:36 +02001632 int ch_write_text_mode; /* write buffer lines with CR, not NL */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001633
Bram Moolenaar580984e2016-03-20 21:17:13 +01001634 char *ch_hostname; /* only for socket, allocated */
1635 int ch_port; /* only for socket */
1636
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001637 int ch_to_be_closed; /* bitset of readable fds to be closed.
1638 * When all readable fds have been closed,
1639 * set to (1 << PART_COUNT). */
Bram Moolenaarfb6ffc72016-05-09 17:58:04 +02001640 int ch_to_be_freed; /* When TRUE channel must be freed when it's
1641 * safe to invoke callbacks. */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001642 int ch_error; /* When TRUE an error was reported. Avoids
1643 * giving pages full of error messages when
1644 * the other side has exited, only mention the
1645 * first error until the connection works
1646 * again. */
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01001647
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001648 void (*ch_nb_close_cb)(void);
1649 /* callback for Netbeans when channel is
1650 * closed */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001651
Bram Moolenaar2dc9d262017-09-08 14:39:30 +02001652#ifdef WIN32
1653 int ch_named_pipe; /* using named pipe instead of pty */
1654#endif
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001655 char_u *ch_callback; /* call when any msg is not handled */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001656 partial_T *ch_partial;
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001657 char_u *ch_close_cb; /* call when channel is closed */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001658 partial_T *ch_close_partial;
Bram Moolenaar958dc692016-12-01 15:34:12 +01001659 int ch_drop_never;
Bram Moolenaar13ebb032017-08-26 22:02:51 +02001660 int ch_keep_open; /* do not close on read error */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001661
Bram Moolenaar77073442016-02-13 23:23:53 +01001662 job_T *ch_job; /* Job that uses this channel; this does not
1663 * count as a reference to avoid a circular
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02001664 * reference, the job refers to the channel. */
Bram Moolenaar46c85432016-02-26 11:17:46 +01001665 int ch_job_killed; /* TRUE when there was a job and it was killed
1666 * or we know it died. */
Bram Moolenaar77073442016-02-13 23:23:53 +01001667
1668 int ch_refcount; /* reference count */
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02001669 int ch_copyID;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001670};
1671
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001672#define JO_MODE 0x0001 /* channel mode */
1673#define JO_IN_MODE 0x0002 /* stdin mode */
1674#define JO_OUT_MODE 0x0004 /* stdout mode */
1675#define JO_ERR_MODE 0x0008 /* stderr mode */
1676#define JO_CALLBACK 0x0010 /* channel callback */
1677#define JO_OUT_CALLBACK 0x0020 /* stdout callback */
1678#define JO_ERR_CALLBACK 0x0040 /* stderr callback */
Bram Moolenaar78712a72017-08-05 14:50:12 +02001679#define JO_CLOSE_CALLBACK 0x0080 /* "close_cb" */
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001680#define JO_WAITTIME 0x0100 /* only for ch_open() */
1681#define JO_TIMEOUT 0x0200 /* all timeouts */
1682#define JO_OUT_TIMEOUT 0x0400 /* stdout timeouts */
1683#define JO_ERR_TIMEOUT 0x0800 /* stderr timeouts */
1684#define JO_PART 0x1000 /* "part" */
1685#define JO_ID 0x2000 /* "id" */
1686#define JO_STOPONEXIT 0x4000 /* "stoponexit" */
Bram Moolenaard6c2f052016-03-14 23:22:59 +01001687#define JO_EXIT_CB 0x8000 /* "exit_cb" */
1688#define JO_OUT_IO 0x10000 /* "out_io" */
1689#define JO_ERR_IO 0x20000 /* "err_io" (JO_OUT_IO << 1) */
1690#define JO_IN_IO 0x40000 /* "in_io" (JO_OUT_IO << 2) */
1691#define JO_OUT_NAME 0x80000 /* "out_name" */
1692#define JO_ERR_NAME 0x100000 /* "err_name" (JO_OUT_NAME << 1) */
1693#define JO_IN_NAME 0x200000 /* "in_name" (JO_OUT_NAME << 2) */
1694#define JO_IN_TOP 0x400000 /* "in_top" */
1695#define JO_IN_BOT 0x800000 /* "in_bot" */
1696#define JO_OUT_BUF 0x1000000 /* "out_buf" */
1697#define JO_ERR_BUF 0x2000000 /* "err_buf" (JO_OUT_BUF << 1) */
1698#define JO_IN_BUF 0x4000000 /* "in_buf" (JO_OUT_BUF << 2) */
Bram Moolenaarde279892016-03-11 22:19:44 +01001699#define JO_CHANNEL 0x8000000 /* "channel" */
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02001700#define JO_BLOCK_WRITE 0x10000000 /* "block_write" */
Bram Moolenaar9f5842e2016-05-29 16:17:08 +02001701#define JO_OUT_MODIFIABLE 0x20000000 /* "out_modifiable" */
1702#define JO_ERR_MODIFIABLE 0x40000000 /* "err_modifiable" (JO_OUT_ << 1) */
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02001703#define JO_ALL 0x7fffffff
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01001704
Bram Moolenaar169ebb02016-09-07 23:32:23 +02001705#define JO2_OUT_MSG 0x0001 /* "out_msg" */
1706#define JO2_ERR_MSG 0x0002 /* "err_msg" (JO_OUT_ << 1) */
Bram Moolenaar78712a72017-08-05 14:50:12 +02001707#define JO2_TERM_NAME 0x0004 /* "term_name" */
Bram Moolenaardd693ce2017-08-10 23:15:19 +02001708#define JO2_TERM_FINISH 0x0008 /* "term_finish" */
Bram Moolenaar05aafed2017-08-11 19:12:11 +02001709#define JO2_ENV 0x0010 /* "env" */
1710#define JO2_CWD 0x0020 /* "cwd" */
Bram Moolenaar08d384f2017-08-11 21:51:23 +02001711#define JO2_TERM_ROWS 0x0040 /* "term_rows" */
1712#define JO2_TERM_COLS 0x0080 /* "term_cols" */
1713#define JO2_VERTICAL 0x0100 /* "vertical" */
Bram Moolenaarda43b612017-08-11 22:27:50 +02001714#define JO2_CURWIN 0x0200 /* "curwin" */
Bram Moolenaar8cad9302017-08-12 14:32:32 +02001715#define JO2_HIDDEN 0x0400 /* "hidden" */
Bram Moolenaar37c45832017-08-12 16:01:04 +02001716#define JO2_TERM_OPENCMD 0x0800 /* "term_opencmd" */
Bram Moolenaar3346cc42017-09-02 14:54:21 +02001717#define JO2_EOF_CHARS 0x1000 /* "eof_chars" */
1718#define JO2_ALL 0x1FFF
Bram Moolenaar169ebb02016-09-07 23:32:23 +02001719
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001720#define JO_MODE_ALL (JO_MODE + JO_IN_MODE + JO_OUT_MODE + JO_ERR_MODE)
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001721#define JO_CB_ALL \
1722 (JO_CALLBACK + JO_OUT_CALLBACK + JO_ERR_CALLBACK + JO_CLOSE_CALLBACK)
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001723#define JO_TIMEOUT_ALL (JO_TIMEOUT + JO_OUT_TIMEOUT + JO_ERR_TIMEOUT)
1724
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01001725/*
Bram Moolenaar910b8aa2016-02-16 21:03:07 +01001726 * Options for job and channel commands.
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01001727 */
1728typedef struct
1729{
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01001730 int jo_set; /* JO_ bits for values that were set */
Bram Moolenaar169ebb02016-09-07 23:32:23 +02001731 int jo_set2; /* JO2_ bits for values that were set */
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01001732
1733 ch_mode_T jo_mode;
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001734 ch_mode_T jo_in_mode;
1735 ch_mode_T jo_out_mode;
1736 ch_mode_T jo_err_mode;
Bram Moolenaar187db502016-02-27 14:44:26 +01001737
1738 job_io_T jo_io[4]; /* PART_OUT, PART_ERR, PART_IN */
1739 char_u jo_io_name_buf[4][NUMBUFLEN];
1740 char_u *jo_io_name[4]; /* not allocated! */
Bram Moolenaar29fd0382016-03-09 23:14:07 +01001741 int jo_io_buf[4];
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02001742 int jo_pty;
Bram Moolenaar9f5842e2016-05-29 16:17:08 +02001743 int jo_modifiable[4];
Bram Moolenaar169ebb02016-09-07 23:32:23 +02001744 int jo_message[4];
Bram Moolenaarde279892016-03-11 22:19:44 +01001745 channel_T *jo_channel;
Bram Moolenaar187db502016-02-27 14:44:26 +01001746
Bram Moolenaar014069a2016-03-03 22:51:40 +01001747 linenr_T jo_in_top;
1748 linenr_T jo_in_bot;
1749
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01001750 char_u *jo_callback; /* not allocated! */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001751 partial_T *jo_partial; /* not referenced! */
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001752 char_u *jo_out_cb; /* not allocated! */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001753 partial_T *jo_out_partial; /* not referenced! */
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001754 char_u *jo_err_cb; /* not allocated! */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001755 partial_T *jo_err_partial; /* not referenced! */
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001756 char_u *jo_close_cb; /* not allocated! */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001757 partial_T *jo_close_partial; /* not referenced! */
1758 char_u *jo_exit_cb; /* not allocated! */
1759 partial_T *jo_exit_partial; /* not referenced! */
Bram Moolenaar958dc692016-12-01 15:34:12 +01001760 int jo_drop_never;
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01001761 int jo_waittime;
1762 int jo_timeout;
Bram Moolenaarb6b52522016-02-20 23:30:07 +01001763 int jo_out_timeout;
1764 int jo_err_timeout;
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02001765 int jo_block_write; /* for testing only */
Bram Moolenaar6f3a5442016-02-20 19:56:13 +01001766 int jo_part;
1767 int jo_id;
Bram Moolenaar65edff82016-02-21 16:40:11 +01001768 char_u jo_soe_buf[NUMBUFLEN];
1769 char_u *jo_stoponexit;
Bram Moolenaar05aafed2017-08-11 19:12:11 +02001770 dict_T *jo_env; /* environment variables */
1771 char_u jo_cwd_buf[NUMBUFLEN];
1772 char_u *jo_cwd;
Bram Moolenaar58556cd2017-07-20 23:04:46 +02001773
1774#ifdef FEAT_TERMINAL
1775 /* when non-zero run the job in a terminal window of this size */
1776 int jo_term_rows;
1777 int jo_term_cols;
Bram Moolenaar08d384f2017-08-11 21:51:23 +02001778 int jo_vertical;
Bram Moolenaarda43b612017-08-11 22:27:50 +02001779 int jo_curwin;
Bram Moolenaar8cad9302017-08-12 14:32:32 +02001780 int jo_hidden;
Bram Moolenaar78712a72017-08-05 14:50:12 +02001781 char_u *jo_term_name;
Bram Moolenaar37c45832017-08-12 16:01:04 +02001782 char_u *jo_term_opencmd;
Bram Moolenaardd693ce2017-08-10 23:15:19 +02001783 int jo_term_finish;
Bram Moolenaar3346cc42017-09-02 14:54:21 +02001784 char_u *jo_eof_chars;
Bram Moolenaar58556cd2017-07-20 23:04:46 +02001785#endif
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01001786} jobopt_T;
1787
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001788
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01001789/* structure used for explicit stack while garbage collecting hash tables */
1790typedef struct ht_stack_S
1791{
1792 hashtab_T *ht;
1793 struct ht_stack_S *prev;
1794} ht_stack_T;
1795
1796/* structure used for explicit stack while garbage collecting lists */
1797typedef struct list_stack_S
1798{
1799 list_T *list;
1800 struct list_stack_S *prev;
1801} list_stack_T;
1802
Bram Moolenaarce0842a2005-07-18 21:58:11 +00001803/* values for b_syn_spell: what to do with toplevel text */
1804#define SYNSPL_DEFAULT 0 /* spell check if @Spell not defined */
1805#define SYNSPL_TOP 1 /* spell check toplevel text */
1806#define SYNSPL_NOTOP 2 /* don't spell check toplevel text */
1807
Bram Moolenaar4770d092006-01-12 23:22:24 +00001808/* avoid #ifdefs for when b_spell is not available */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00001809#ifdef FEAT_SPELL
Bram Moolenaar4770d092006-01-12 23:22:24 +00001810# define B_SPELL(buf) ((buf)->b_spell)
1811#else
1812# define B_SPELL(buf) (0)
1813#endif
1814
Bram Moolenaar76b92b22006-03-24 22:46:53 +00001815#ifdef FEAT_QUICKFIX
Bram Moolenaard12f5c12006-01-25 22:10:52 +00001816typedef struct qf_info_S qf_info_T;
Bram Moolenaar76b92b22006-03-24 22:46:53 +00001817#endif
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001818
Bram Moolenaarf7512552013-06-06 14:55:19 +02001819#ifdef FEAT_PROFILE
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001820/*
1821 * Used for :syntime: timing of executing a syntax pattern.
1822 */
1823typedef struct {
1824 proftime_T total; /* total time used */
1825 proftime_T slowest; /* time of slowest call */
1826 long count; /* nr of times used */
1827 long match; /* nr of times matched */
1828} syn_time_T;
1829#endif
1830
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001831#ifdef FEAT_CRYPT
1832/*
1833 * Structure to hold the type of encryption and the state of encryption or
1834 * decryption.
1835 */
1836typedef struct {
1837 int method_nr;
1838 void *method_state; /* method-specific state information */
1839} cryptstate_T;
1840
1841/* values for method_nr */
1842# define CRYPT_M_ZIP 0
1843# define CRYPT_M_BF 1
1844# define CRYPT_M_BF2 2
1845# define CRYPT_M_COUNT 3 /* number of crypt methods */
1846#endif
1847
1848
Bram Moolenaar362ce482012-06-06 19:02:45 +02001849/*
1850 * These are items normally related to a buffer. But when using ":ownsyntax"
1851 * a window may have its own instance.
1852 */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001853typedef struct {
1854#ifdef FEAT_SYN_HL
1855 hashtab_T b_keywtab; /* syntax keywords hash table */
1856 hashtab_T b_keywtab_ic; /* idem, ignore case */
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02001857 int b_syn_error; /* TRUE when error occurred in HL */
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02001858# ifdef FEAT_RELTIME
1859 int b_syn_slow; /* TRUE when 'redrawtime' reached */
1860# endif
Bram Moolenaar860cae12010-06-05 23:22:07 +02001861 int b_syn_ic; /* ignore case for :syn cmds */
1862 int b_syn_spell; /* SYNSPL_ values */
1863 garray_T b_syn_patterns; /* table for syntax patterns */
1864 garray_T b_syn_clusters; /* table for syntax clusters */
1865 int b_spell_cluster_id; /* @Spell cluster ID or 0 */
1866 int b_nospell_cluster_id; /* @NoSpell cluster ID or 0 */
1867 int b_syn_containedin; /* TRUE when there is an item with a
1868 "containedin" argument */
1869 int b_syn_sync_flags; /* flags about how to sync */
1870 short b_syn_sync_id; /* group to sync on */
1871 long b_syn_sync_minlines; /* minimal sync lines offset */
1872 long b_syn_sync_maxlines; /* maximal sync lines offset */
1873 long b_syn_sync_linebreaks; /* offset for multi-line pattern */
1874 char_u *b_syn_linecont_pat; /* line continuation pattern */
1875 regprog_T *b_syn_linecont_prog; /* line continuation program */
Bram Moolenaarf7512552013-06-06 14:55:19 +02001876#ifdef FEAT_PROFILE
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001877 syn_time_T b_syn_linecont_time;
1878#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +02001879 int b_syn_linecont_ic; /* ignore-case flag for above */
1880 int b_syn_topgrp; /* for ":syntax include" */
1881# ifdef FEAT_CONCEAL
1882 int b_syn_conceal; /* auto-conceal for :syn cmds */
1883# endif
1884# ifdef FEAT_FOLDING
1885 int b_syn_folditems; /* number of patterns with the HL_FOLD
1886 flag set */
1887# endif
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02001888 /*
1889 * b_sst_array[] contains the state stack for a number of lines, for the
1890 * start of that line (col == 0). This avoids having to recompute the
1891 * syntax state too often.
1892 * b_sst_array[] is allocated to hold the state for all displayed lines,
1893 * and states for 1 out of about 20 other lines.
1894 * b_sst_array pointer to an array of synstate_T
1895 * b_sst_len number of entries in b_sst_array[]
1896 * b_sst_first pointer to first used entry in b_sst_array[] or NULL
1897 * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL
1898 * b_sst_freecount number of free entries in b_sst_array[]
1899 * b_sst_check_lnum entries after this lnum need to be checked for
1900 * validity (MAXLNUM means no check needed)
1901 */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001902 synstate_T *b_sst_array;
1903 int b_sst_len;
1904 synstate_T *b_sst_first;
1905 synstate_T *b_sst_firstfree;
1906 int b_sst_freecount;
1907 linenr_T b_sst_check_lnum;
1908 short_u b_sst_lasttick; /* last display tick */
1909#endif /* FEAT_SYN_HL */
1910
1911#ifdef FEAT_SPELL
1912 /* for spell checking */
1913 garray_T b_langp; /* list of pointers to slang_T, see spell.c */
1914 char_u b_spell_ismw[256];/* flags: is midword char */
1915# ifdef FEAT_MBYTE
1916 char_u *b_spell_ismw_mb; /* multi-byte midword chars */
1917# endif
1918 char_u *b_p_spc; /* 'spellcapcheck' */
1919 regprog_T *b_cap_prog; /* program for 'spellcapcheck' */
1920 char_u *b_p_spf; /* 'spellfile' */
1921 char_u *b_p_spl; /* 'spelllang' */
Bram Moolenaarcc63c642013-11-12 04:44:01 +01001922# ifdef FEAT_MBYTE
1923 int b_cjk; /* all CJK letters as OK */
1924# endif
Bram Moolenaar860cae12010-06-05 23:22:07 +02001925#endif
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02001926#if !defined(FEAT_SYN_HL) && !defined(FEAT_SPELL)
1927 int dummy;
1928#endif
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01001929 char_u b_syn_chartab[32]; /* syntax iskeyword option */
1930 char_u *b_syn_isk; /* iskeyword option */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001931} synblock_T;
1932
1933
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934/*
1935 * buffer: structure that holds information about one file
1936 *
1937 * Several windows can share a single Buffer
1938 * A buffer is unallocated if there is no memfile for it.
1939 * A buffer is new if the associated file has never been loaded yet.
1940 */
1941
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942struct file_buffer
1943{
1944 memline_T b_ml; /* associated memline (also contains line
1945 count) */
1946
1947 buf_T *b_next; /* links in list of buffers */
1948 buf_T *b_prev;
1949
1950 int b_nwindows; /* nr of windows open on this buffer */
1951
1952 int b_flags; /* various BF_ flags */
Bram Moolenaar362ce482012-06-06 19:02:45 +02001953#ifdef FEAT_AUTOCMD
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02001954 int b_locked; /* Buffer is being closed or referenced, don't
1955 let autocommands wipe it out. */
Bram Moolenaar362ce482012-06-06 19:02:45 +02001956#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957
1958 /*
1959 * b_ffname has the full path of the file (NULL for no name).
1960 * b_sfname is the name as the user typed it (or NULL).
1961 * b_fname is the same as b_sfname, unless ":cd" has been done,
1962 * then it is the same as b_ffname (NULL for no name).
1963 */
1964 char_u *b_ffname; /* full path file name */
1965 char_u *b_sfname; /* short file name */
1966 char_u *b_fname; /* current file name */
1967
1968#ifdef UNIX
Bram Moolenaarf1726cc2009-05-13 18:48:16 +00001969 int b_dev_valid; /* TRUE when b_dev has a valid number */
1970 dev_t b_dev; /* device number */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 ino_t b_ino; /* inode number */
1972#endif
1973#ifdef FEAT_CW_EDITOR
1974 FSSpec b_FSSpec; /* MacOS File Identification */
1975#endif
1976#ifdef VMS
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001977 char b_fab_rfm; /* Record format */
1978 char b_fab_rat; /* Record attribute */
1979 unsigned int b_fab_mrs; /* Max record size */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 int b_fnum; /* buffer number for this file. */
Bram Moolenaar480778b2016-07-14 22:09:39 +02001982 char_u b_key[VIM_SIZEOF_INT * 2 + 1];
1983 /* key used for buf_hashtab, holds b_fnum as
1984 hex string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985
1986 int b_changed; /* 'modified': Set to TRUE if something in the
1987 file has been changed and not written out. */
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001988 dictitem16_T b_ct_di; /* holds the b:changedtick value in
1989 b_ct_di.di_tv.vval.v_number;
Bram Moolenaar79518e22017-02-17 16:31:35 +01001990 incremented for each change, also for undo */
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001991#define CHANGEDTICK(buf) ((buf)->b_ct_di.di_tv.vval.v_number)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992
1993 int b_saving; /* Set to TRUE if we are in the middle of
1994 saving the buffer. */
1995
1996 /*
1997 * Changes to a buffer require updating of the display. To minimize the
1998 * work, remember changes made and update everything at once.
1999 */
2000 int b_mod_set; /* TRUE when there are changes since the last
2001 time the display was updated */
2002 linenr_T b_mod_top; /* topmost lnum that was changed */
2003 linenr_T b_mod_bot; /* lnum below last changed line, AFTER the
2004 change */
2005 long b_mod_xlines; /* number of extra buffer lines inserted;
2006 negative when lines were deleted */
2007
2008 wininfo_T *b_wininfo; /* list of last used info for each window */
2009
2010 long b_mtime; /* last change time of original file */
2011 long b_mtime_read; /* last change time when reading */
Bram Moolenaar8767f522016-07-01 17:17:39 +02002012 off_T b_orig_size; /* size of original file in bytes */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 int b_orig_mode; /* mode of original file */
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002014#ifdef FEAT_VIMINFO
2015 time_T b_last_used; /* time when the buffer was last used; used
2016 * for viminfo */
2017#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018
2019 pos_T b_namedm[NMARKS]; /* current named marks (mark.c) */
2020
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 /* These variables are set when VIsual_active becomes FALSE */
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002022 visualinfo_T b_visual;
Bram Moolenaarf7ff6e82014-03-23 15:13:05 +01002023#ifdef FEAT_EVAL
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002024 int b_visual_mode_eval; /* b_visual.vi_mode for visualmode() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025#endif
2026
2027 pos_T b_last_cursor; /* cursor position when last unloading this
2028 buffer */
2029 pos_T b_last_insert; /* where Insert mode was left */
2030 pos_T b_last_change; /* position of last change: '. mark */
2031
2032#ifdef FEAT_JUMPLIST
2033 /*
2034 * the changelist contains old change positions
2035 */
2036 pos_T b_changelist[JUMPLISTSIZE];
2037 int b_changelistlen; /* number of active entries */
2038 int b_new_change; /* set by u_savecommon() */
2039#endif
2040
2041 /*
2042 * Character table, only used in charset.c for 'iskeyword'
2043 * 32 bytes of 8 bits: 1 bit per character 0-255.
2044 */
2045 char_u b_chartab[32];
2046
2047#ifdef FEAT_LOCALMAP
2048 /* Table used for mappings local to a buffer. */
2049 mapblock_T *(b_maphash[256]);
2050
2051 /* First abbreviation local to a buffer. */
2052 mapblock_T *b_first_abbr;
2053#endif
2054#ifdef FEAT_USR_CMDS
2055 /* User commands local to the buffer. */
2056 garray_T b_ucmds;
2057#endif
2058 /*
2059 * start and end of an operator, also used for '[ and ']
2060 */
2061 pos_T b_op_start;
Bram Moolenaarb1d90a32014-02-22 23:03:55 +01002062 pos_T b_op_start_orig; /* used for Insstart_orig */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 pos_T b_op_end;
2064
2065#ifdef FEAT_VIMINFO
2066 int b_marks_read; /* Have we read viminfo marks yet? */
2067#endif
2068
2069 /*
2070 * The following only used in undo.c.
2071 */
2072 u_header_T *b_u_oldhead; /* pointer to oldest header */
Bram Moolenaara9a568c2006-03-14 23:04:27 +00002073 u_header_T *b_u_newhead; /* pointer to newest header; may not be valid
2074 if b_u_curhead is not NULL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 u_header_T *b_u_curhead; /* pointer to current header */
2076 int b_u_numhead; /* current number of headers */
2077 int b_u_synced; /* entry lists are synced */
Bram Moolenaarca003e12006-03-17 23:19:38 +00002078 long b_u_seq_last; /* last used undo sequence number */
Bram Moolenaar730cde92010-06-27 05:18:54 +02002079 long b_u_save_nr_last; /* counter for last file write */
Bram Moolenaarca003e12006-03-17 23:19:38 +00002080 long b_u_seq_cur; /* hu_seq of header below which we are now */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002081 time_T b_u_time_cur; /* uh_time of header below which we are now */
Bram Moolenaar730cde92010-06-27 05:18:54 +02002082 long b_u_save_nr_cur; /* file write nr after which we are now */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083
2084 /*
2085 * variables for "U" command in undo.c
2086 */
2087 char_u *b_u_line_ptr; /* saved line for "U" command */
2088 linenr_T b_u_line_lnum; /* line number of line in u_line */
2089 colnr_T b_u_line_colnr; /* optional column number */
2090
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091#ifdef FEAT_INS_EXPAND
2092 int b_scanned; /* ^N/^P have scanned this buffer */
2093#endif
2094
2095 /* flags for use of ":lmap" and IM control */
2096 long b_p_iminsert; /* input mode for insert */
2097 long b_p_imsearch; /* input mode for search */
2098#define B_IMODE_USE_INSERT -1 /* Use b_p_iminsert value for search */
2099#define B_IMODE_NONE 0 /* Input via none */
2100#define B_IMODE_LMAP 1 /* Input via langmap */
2101#ifndef USE_IM_CONTROL
2102# define B_IMODE_LAST 1
2103#else
2104# define B_IMODE_IM 2 /* Input via input method */
2105# define B_IMODE_LAST 2
2106#endif
2107
2108#ifdef FEAT_KEYMAP
2109 short b_kmap_state; /* using "lmap" mappings */
2110# define KEYMAP_INIT 1 /* 'keymap' was set, call keymap_init() */
2111# define KEYMAP_LOADED 2 /* 'keymap' mappings have been loaded */
2112 garray_T b_kmap_ga; /* the keymap table */
2113#endif
2114
2115 /*
2116 * Options local to a buffer.
2117 * They are here because their value depends on the type of file
2118 * or contents of the file being edited.
2119 */
2120 int b_p_initialized; /* set when options initialized */
2121
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00002122#ifdef FEAT_EVAL
2123 int b_p_scriptID[BV_COUNT]; /* SIDs for buffer-local options */
2124#endif
2125
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 int b_p_ai; /* 'autoindent' */
2127 int b_p_ai_nopaste; /* b_p_ai saved for paste mode */
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02002128 char_u *b_p_bkc; /* 'backupcopy' */
2129 unsigned b_bkc_flags; /* flags for 'backupcopy' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 int b_p_ci; /* 'copyindent' */
2131 int b_p_bin; /* 'binary' */
2132#ifdef FEAT_MBYTE
2133 int b_p_bomb; /* 'bomb' */
2134#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 char_u *b_p_bh; /* 'bufhidden' */
2136 char_u *b_p_bt; /* 'buftype' */
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02002137#ifdef FEAT_QUICKFIX
Bram Moolenaarc1542742016-07-20 21:44:37 +02002138#define BUF_HAS_QF_ENTRY 1
2139#define BUF_HAS_LL_ENTRY 2
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002140 int b_has_qf_entry;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141#endif
2142 int b_p_bl; /* 'buflisted' */
2143#ifdef FEAT_CINDENT
2144 int b_p_cin; /* 'cindent' */
2145 char_u *b_p_cino; /* 'cinoptions' */
2146 char_u *b_p_cink; /* 'cinkeys' */
2147#endif
2148#if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
2149 char_u *b_p_cinw; /* 'cinwords' */
2150#endif
2151#ifdef FEAT_COMMENTS
2152 char_u *b_p_com; /* 'comments' */
2153#endif
2154#ifdef FEAT_FOLDING
2155 char_u *b_p_cms; /* 'commentstring' */
2156#endif
2157#ifdef FEAT_INS_EXPAND
2158 char_u *b_p_cpt; /* 'complete' */
2159#endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002160#ifdef FEAT_COMPL_FUNC
2161 char_u *b_p_cfu; /* 'completefunc' */
Bram Moolenaarf75a9632005-09-13 21:20:47 +00002162 char_u *b_p_ofu; /* 'omnifunc' */
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002163#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 int b_p_eol; /* 'endofline' */
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002165 int b_p_fixeol; /* 'fixendofline' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 int b_p_et; /* 'expandtab' */
2167 int b_p_et_nobin; /* b_p_et saved for binary mode */
Bram Moolenaar54f018c2015-09-15 17:30:40 +02002168 int b_p_et_nopaste; /* b_p_et saved for paste mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169#ifdef FEAT_MBYTE
2170 char_u *b_p_fenc; /* 'fileencoding' */
2171#endif
2172 char_u *b_p_ff; /* 'fileformat' */
2173#ifdef FEAT_AUTOCMD
2174 char_u *b_p_ft; /* 'filetype' */
2175#endif
2176 char_u *b_p_fo; /* 'formatoptions' */
Bram Moolenaar86b68352004-12-27 21:59:20 +00002177 char_u *b_p_flp; /* 'formatlistpat' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 int b_p_inf; /* 'infercase' */
2179 char_u *b_p_isk; /* 'iskeyword' */
2180#ifdef FEAT_FIND_ID
2181 char_u *b_p_def; /* 'define' local value */
2182 char_u *b_p_inc; /* 'include' */
2183# ifdef FEAT_EVAL
2184 char_u *b_p_inex; /* 'includeexpr' */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002185 long_u b_p_inex_flags; /* flags for 'includeexpr' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186# endif
2187#endif
2188#if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
2189 char_u *b_p_inde; /* 'indentexpr' */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002190 long_u b_p_inde_flags; /* flags for 'indentexpr' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 char_u *b_p_indk; /* 'indentkeys' */
2192#endif
Bram Moolenaar9be7c042017-01-14 14:28:30 +01002193 char_u *b_p_fp; /* 'formatprg' */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002194#if defined(FEAT_EVAL)
2195 char_u *b_p_fex; /* 'formatexpr' */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002196 long_u b_p_fex_flags; /* flags for 'formatexpr' */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002197#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198#ifdef FEAT_CRYPT
2199 char_u *b_p_key; /* 'key' */
2200#endif
2201 char_u *b_p_kp; /* 'keywordprg' */
2202#ifdef FEAT_LISP
2203 int b_p_lisp; /* 'lisp' */
2204#endif
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01002205#ifdef FEAT_MBYTE
2206 char_u *b_p_menc; /* 'makeencoding' */
2207#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 char_u *b_p_mps; /* 'matchpairs' */
2209 int b_p_ml; /* 'modeline' */
2210 int b_p_ml_nobin; /* b_p_ml saved for binary mode */
2211 int b_p_ma; /* 'modifiable' */
2212 char_u *b_p_nf; /* 'nrformats' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 int b_p_pi; /* 'preserveindent' */
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002214#ifdef FEAT_TEXTOBJ
2215 char_u *b_p_qe; /* 'quoteescape' */
2216#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 int b_p_ro; /* 'readonly' */
2218 long b_p_sw; /* 'shiftwidth' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 int b_p_sn; /* 'shortname' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220#ifdef FEAT_SMARTINDENT
2221 int b_p_si; /* 'smartindent' */
2222#endif
2223 long b_p_sts; /* 'softtabstop' */
2224 long b_p_sts_nopaste; /* b_p_sts saved for paste mode */
2225#ifdef FEAT_SEARCHPATH
2226 char_u *b_p_sua; /* 'suffixesadd' */
2227#endif
2228 int b_p_swf; /* 'swapfile' */
2229#ifdef FEAT_SYN_HL
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00002230 long b_p_smc; /* 'synmaxcol' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 char_u *b_p_syn; /* 'syntax' */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002232#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 long b_p_ts; /* 'tabstop' */
2234 int b_p_tx; /* 'textmode' */
2235 long b_p_tw; /* 'textwidth' */
2236 long b_p_tw_nobin; /* b_p_tw saved for binary mode */
2237 long b_p_tw_nopaste; /* b_p_tw saved for paste mode */
2238 long b_p_wm; /* 'wrapmargin' */
2239 long b_p_wm_nobin; /* b_p_wm saved for binary mode */
2240 long b_p_wm_nopaste; /* b_p_wm saved for paste mode */
2241#ifdef FEAT_KEYMAP
2242 char_u *b_p_keymap; /* 'keymap' */
2243#endif
2244
2245 /* local values for options which are normally global */
2246#ifdef FEAT_QUICKFIX
2247 char_u *b_p_gp; /* 'grepprg' local value */
2248 char_u *b_p_mp; /* 'makeprg' local value */
2249 char_u *b_p_efm; /* 'errorformat' local value */
2250#endif
2251 char_u *b_p_ep; /* 'equalprg' local value */
2252 char_u *b_p_path; /* 'path' local value */
2253 int b_p_ar; /* 'autoread' local value */
2254 char_u *b_p_tags; /* 'tags' local value */
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01002255 char_u *b_p_tc; /* 'tagcase' local value */
2256 unsigned b_tc_flags; /* flags for 'tagcase' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257#ifdef FEAT_INS_EXPAND
2258 char_u *b_p_dict; /* 'dictionary' local value */
2259 char_u *b_p_tsr; /* 'thesaurus' local value */
2260#endif
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01002261 long b_p_ul; /* 'undolevels' local value */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02002262#ifdef FEAT_PERSISTENT_UNDO
2263 int b_p_udf; /* 'undofile' */
2264#endif
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01002265#ifdef FEAT_LISP
2266 char_u *b_p_lw; /* 'lispwords' local value */
2267#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268
2269 /* end of buffer options */
2270
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +01002271#ifdef FEAT_CINDENT
2272 /* values set from b_p_cino */
2273 int b_ind_level;
2274 int b_ind_open_imag;
2275 int b_ind_no_brace;
2276 int b_ind_first_open;
2277 int b_ind_open_extra;
2278 int b_ind_close_extra;
2279 int b_ind_open_left_imag;
2280 int b_ind_jump_label;
2281 int b_ind_case;
2282 int b_ind_case_code;
2283 int b_ind_case_break;
2284 int b_ind_param;
2285 int b_ind_func_type;
2286 int b_ind_comment;
2287 int b_ind_in_comment;
2288 int b_ind_in_comment2;
2289 int b_ind_cpp_baseclass;
2290 int b_ind_continuation;
2291 int b_ind_unclosed;
2292 int b_ind_unclosed2;
2293 int b_ind_unclosed_noignore;
2294 int b_ind_unclosed_wrapped;
2295 int b_ind_unclosed_whiteok;
2296 int b_ind_matching_paren;
2297 int b_ind_paren_prev;
2298 int b_ind_maxparen;
2299 int b_ind_maxcomment;
2300 int b_ind_scopedecl;
2301 int b_ind_scopedecl_code;
2302 int b_ind_java;
2303 int b_ind_js;
2304 int b_ind_keep_case_label;
2305 int b_ind_hash_comment;
2306 int b_ind_cpp_namespace;
2307 int b_ind_if_for_while;
Bram Moolenaar7720ba82017-03-08 22:19:26 +01002308 int b_ind_cpp_extern_c;
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +01002309#endif
2310
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01002311 linenr_T b_no_eol_lnum; /* non-zero lnum when last line of next binary
2312 * write should not have an end-of-line */
2313
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 int b_start_eol; /* last line had eol when it was read */
2315 int b_start_ffc; /* first char of 'ff' when edit started */
2316#ifdef FEAT_MBYTE
2317 char_u *b_start_fenc; /* 'fileencoding' when edit started or NULL */
Bram Moolenaara9b1e742005-12-19 22:14:58 +00002318 int b_bad_char; /* "++bad=" argument when edit started or 0 */
Bram Moolenaar83eb8852007-08-12 13:51:26 +00002319 int b_start_bomb; /* 'bomb' when it was read */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320#endif
2321
2322#ifdef FEAT_EVAL
Bram Moolenaar8f999f12005-01-25 22:12:55 +00002323 dictitem_T b_bufvar; /* variable for "b:" Dictionary */
Bram Moolenaar429fa852013-04-15 12:27:36 +02002324 dict_T *b_vars; /* internal variables, local to buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325#endif
2326
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002327#if defined(FEAT_BEVAL) && defined(FEAT_EVAL)
2328 char_u *b_p_bexpr; /* 'balloonexpr' local value */
2329 long_u b_p_bexpr_flags;/* flags for 'balloonexpr' */
2330#endif
Bram Moolenaar49771f42010-07-20 17:32:38 +02002331#ifdef FEAT_CRYPT
2332 char_u *b_p_cm; /* 'cryptmethod' */
2333#endif
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002334
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 /* When a buffer is created, it starts without a swap file. b_may_swap is
2336 * then set to indicate that a swap file may be opened later. It is reset
2337 * if a swap file could not be opened.
2338 */
2339 int b_may_swap;
2340 int b_did_warn; /* Set to 1 if user has been warned on first
2341 change of a read-only file */
Bram Moolenaar4770d092006-01-12 23:22:24 +00002342
2343 /* Two special kinds of buffers:
2344 * help buffer - used for help files, won't use a swap file.
2345 * spell buffer - used for spell info, never displayed and doesn't have a
2346 * file name.
2347 */
2348 int b_help; /* TRUE for help file buffer (when set b_p_bt
2349 is "help") */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002350#ifdef FEAT_SPELL
Bram Moolenaar4770d092006-01-12 23:22:24 +00002351 int b_spell; /* TRUE for a spell file buffer, most fields
2352 are not used! Use the B_SPELL macro to
2353 access b_spell without #ifdef. */
2354#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 int b_shortname; /* this file has an 8.3 file name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002358#ifdef FEAT_MZSCHEME
Bram Moolenaare344bea2005-09-01 20:46:49 +00002359 void *b_mzscheme_ref; /* The MzScheme reference to this buffer */
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002360#endif
2361
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362#ifdef FEAT_PERL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002363 void *b_perl_private;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364#endif
2365
2366#ifdef FEAT_PYTHON
Bram Moolenaare344bea2005-09-01 20:46:49 +00002367 void *b_python_ref; /* The Python reference to this buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368#endif
2369
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02002370#ifdef FEAT_PYTHON3
2371 void *b_python3_ref; /* The Python3 reference to this buffer */
2372#endif
2373
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374#ifdef FEAT_TCL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002375 void *b_tcl_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376#endif
2377
2378#ifdef FEAT_RUBY
Bram Moolenaare344bea2005-09-01 20:46:49 +00002379 void *b_ruby_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380#endif
2381
Bram Moolenaar860cae12010-06-05 23:22:07 +02002382#if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
2383 synblock_T b_s; /* Info related to syntax highlighting. w_s
2384 * normally points to this, but some windows
2385 * may use a different synblock_T. */
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002386#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387
2388#ifdef FEAT_SIGNS
2389 signlist_T *b_signlist; /* list of signs to draw */
Bram Moolenaar3b7b8362015-03-20 18:11:48 +01002390# ifdef FEAT_NETBEANS_INTG
2391 int b_has_sign_column; /* Flag that is set when a first sign is
2392 * added and remains set until the end of
2393 * the netbeans session. */
2394# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395#endif
2396
2397#ifdef FEAT_NETBEANS_INTG
2398 int b_netbeans_file; /* TRUE when buffer is owned by NetBeans */
2399 int b_was_netbeans_file;/* TRUE if b_netbeans_file was once set */
2400#endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01002401#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar99ef0622016-03-06 20:22:25 +01002402 int b_write_to_channel; /* TRUE when appended lines are written to
2403 * a channel. */
2404#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002406#ifdef FEAT_CRYPT
2407 cryptstate_T *b_cryptstate; /* Encryption state while reading or writing
2408 * the file. NULL when not using encryption. */
2409#endif
Bram Moolenaar651863c2015-01-14 12:44:41 +01002410 int b_mapped_ctrl_c; /* modes where CTRL-C is mapped */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002411
Bram Moolenaare4f25e42017-07-07 11:54:15 +02002412#ifdef FEAT_TERMINAL
2413 term_T *b_term; /* When not NULL this buffer is for a terminal
2414 * window. */
2415#endif
2416
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002417}; /* file_buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002419
2420#ifdef FEAT_DIFF
2421/*
2422 * Stuff for diff mode.
2423 */
Bram Moolenaar015efc32016-08-24 22:34:33 +02002424# define DB_COUNT 8 /* up to eight buffers can be diff'ed */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002425
2426/*
2427 * Each diffblock defines where a block of lines starts in each of the buffers
2428 * and how many lines it occupies in that buffer. When the lines are missing
2429 * in the buffer the df_count[] is zero. This is all counted in
2430 * buffer lines.
2431 * There is always at least one unchanged line in between the diffs.
2432 * Otherwise it would have been included in the diff above or below it.
2433 * df_lnum[] + df_count[] is the lnum below the change. When in one buffer
2434 * lines have been inserted, in the other buffer df_lnum[] is the line below
2435 * the insertion and df_count[] is zero. When appending lines at the end of
2436 * the buffer, df_lnum[] is one beyond the end!
2437 * This is using a linked list, because the number of differences is expected
2438 * to be reasonable small. The list is sorted on lnum.
2439 */
2440typedef struct diffblock_S diff_T;
2441struct diffblock_S
2442{
2443 diff_T *df_next;
2444 linenr_T df_lnum[DB_COUNT]; /* line number in buffer */
2445 linenr_T df_count[DB_COUNT]; /* nr of inserted/changed lines */
2446};
2447#endif
2448
Bram Moolenaar746ebd32009-06-16 14:01:43 +00002449#define SNAP_HELP_IDX 0
2450#ifdef FEAT_AUTOCMD
2451# define SNAP_AUCMD_IDX 1
2452# define SNAP_COUNT 2
2453#else
2454# define SNAP_COUNT 1
2455#endif
2456
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002457/*
2458 * Tab pages point to the top frame of each tab page.
2459 * Note: Most values are NOT valid for the current tab page! Use "curwin",
2460 * "firstwin", etc. for that. "tp_topframe" is always valid and can be
2461 * compared against "topframe" to find the current tab page.
2462 */
2463typedef struct tabpage_S tabpage_T;
2464struct tabpage_S
2465{
2466 tabpage_T *tp_next; /* next tabpage or NULL */
2467 frame_T *tp_topframe; /* topframe for the windows */
2468 win_T *tp_curwin; /* current window in this Tab page */
2469 win_T *tp_prevwin; /* previous window in this Tab page */
2470 win_T *tp_firstwin; /* first window in this Tab page */
2471 win_T *tp_lastwin; /* last window in this Tab page */
2472 long tp_old_Rows; /* Rows when Tab page was left */
2473 long tp_old_Columns; /* Columns when Tab page was left */
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00002474 long tp_ch_used; /* value of 'cmdheight' when frame size
2475 was set */
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002476#ifdef FEAT_GUI
2477 int tp_prev_which_scrollbars[3];
2478 /* previous value of which_scrollbars */
2479#endif
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002480#ifdef FEAT_DIFF
2481 diff_T *tp_first_diff;
2482 buf_T *(tp_diffbuf[DB_COUNT]);
2483 int tp_diff_invalid; /* list of diffs is outdated */
2484#endif
Bram Moolenaar746ebd32009-06-16 14:01:43 +00002485 frame_T *(tp_snapshot[SNAP_COUNT]); /* window layout snapshots */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002486#ifdef FEAT_EVAL
2487 dictitem_T tp_winvar; /* variable for "t:" Dictionary */
Bram Moolenaar429fa852013-04-15 12:27:36 +02002488 dict_T *tp_vars; /* internal variables, local to tab page */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002489#endif
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02002490
2491#ifdef FEAT_PYTHON
2492 void *tp_python_ref; /* The Python value for this tab page */
2493#endif
2494
2495#ifdef FEAT_PYTHON3
2496 void *tp_python3_ref; /* The Python value for this tab page */
2497#endif
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002498};
2499
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500/*
2501 * Structure to cache info for displayed lines in w_lines[].
2502 * Each logical line has one entry.
2503 * The entry tells how the logical line is currently displayed in the window.
2504 * This is updated when displaying the window.
2505 * When the display is changed (e.g., when clearing the screen) w_lines_valid
2506 * is changed to exclude invalid entries.
2507 * When making changes to the buffer, wl_valid is reset to indicate wl_size
2508 * may not reflect what is actually in the buffer. When wl_valid is FALSE,
2509 * the entries can only be used to count the number of displayed lines used.
2510 * wl_lnum and wl_lastlnum are invalid too.
2511 */
2512typedef struct w_line
2513{
2514 linenr_T wl_lnum; /* buffer line number for logical line */
2515 short_u wl_size; /* height in screen lines */
2516 char wl_valid; /* TRUE values are valid for text in buffer */
2517#ifdef FEAT_FOLDING
2518 char wl_folded; /* TRUE when this is a range of folded lines */
2519 linenr_T wl_lastlnum; /* last buffer line number for logical line */
2520#endif
2521} wline_T;
2522
2523/*
2524 * Windows are kept in a tree of frames. Each frame has a column (FR_COL)
2525 * or row (FR_ROW) layout or is a leaf, which has a window.
2526 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002527struct frame_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528{
2529 char fr_layout; /* FR_LEAF, FR_COL or FR_ROW */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 int fr_width;
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002531 int fr_newwidth; /* new width used in win_equal_rec() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 int fr_height;
2533 int fr_newheight; /* new height used in win_equal_rec() */
2534 frame_T *fr_parent; /* containing frame or NULL */
2535 frame_T *fr_next; /* frame right or below in same parent, NULL
2536 for first */
2537 frame_T *fr_prev; /* frame left or above in same parent, NULL
2538 for last */
2539 /* fr_child and fr_win are mutually exclusive */
2540 frame_T *fr_child; /* first contained frame */
2541 win_T *fr_win; /* window that fills this frame */
2542};
2543
2544#define FR_LEAF 0 /* frame is a leaf */
2545#define FR_ROW 1 /* frame with a row of windows */
2546#define FR_COL 2 /* frame with a column of windows */
2547
2548/*
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002549 * Struct used for highlighting 'hlsearch' matches, matches defined by
2550 * ":match" and matches defined by match functions.
2551 * For 'hlsearch' there is one pattern for all windows. For ":match" and the
2552 * match functions there is a different pattern for each window.
2553 */
2554typedef struct
2555{
2556 regmmatch_T rm; /* points to the regexp program; contains last found
2557 match (may continue in next line) */
2558 buf_T *buf; /* the buffer to search for a match */
2559 linenr_T lnum; /* the line to search for a match */
2560 int attr; /* attributes to be used for a match */
2561 int attr_cur; /* attributes currently active in win_line() */
2562 linenr_T first_lnum; /* first lnum to search for multi-line pat */
2563 colnr_T startcol; /* in win_line() points to char where HL starts */
2564 colnr_T endcol; /* in win_line() points to char where HL ends */
Bram Moolenaar4f416e42016-08-16 16:08:18 +02002565 int is_addpos; /* position specified directly by
2566 matchaddpos(). TRUE/FALSE */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00002567#ifdef FEAT_RELTIME
2568 proftime_T tm; /* for a time limit */
2569#endif
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002570} match_T;
2571
Bram Moolenaarb3414592014-06-17 17:48:32 +02002572/* number of positions supported by matchaddpos() */
2573#define MAXPOSMATCH 8
2574
2575/*
2576 * Same as lpos_T, but with additional field len.
2577 */
2578typedef struct
2579{
2580 linenr_T lnum; /* line number */
2581 colnr_T col; /* column number */
2582 int len; /* length: 0 - to the end of line */
2583} llpos_T;
2584
2585/*
2586 * posmatch_T provides an array for storing match items for matchaddpos()
2587 * function.
2588 */
2589typedef struct posmatch posmatch_T;
2590struct posmatch
2591{
2592 llpos_T pos[MAXPOSMATCH]; /* array of positions */
2593 int cur; /* internal position counter */
2594 linenr_T toplnum; /* top buffer line */
2595 linenr_T botlnum; /* bottom buffer line */
2596};
2597
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002598/*
2599 * matchitem_T provides a linked list for storing match items for ":match" and
2600 * the match functions.
2601 */
2602typedef struct matchitem matchitem_T;
2603struct matchitem
2604{
2605 matchitem_T *next;
2606 int id; /* match ID */
2607 int priority; /* match priority */
2608 char_u *pattern; /* pattern to highlight */
2609 int hlg_id; /* highlight group ID */
2610 regmmatch_T match; /* regexp program for pattern */
Bram Moolenaarb3414592014-06-17 17:48:32 +02002611 posmatch_T pos; /* position matches */
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002612 match_T hl; /* struct for doing the actual highlighting */
Bram Moolenaar6561d522015-07-21 15:48:27 +02002613#ifdef FEAT_CONCEAL
2614 int conceal_char; /* cchar for Conceal highlighting */
2615#endif
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002616};
2617
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02002618#ifdef FEAT_MENU
2619typedef struct {
2620 int wb_startcol;
2621 int wb_endcol;
2622 vimmenu_T *wb_menu;
2623} winbar_item_T;
2624#endif
2625
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002626/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 * Structure which contains all information that belongs to a window
2628 *
2629 * All row numbers are relative to the start of the window, except w_winrow.
2630 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002631struct window_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632{
Bram Moolenaar86edef62016-03-13 18:07:30 +01002633 int w_id; /* unique window ID */
2634
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 buf_T *w_buffer; /* buffer we are a window into (used
2636 often, keep it the first item!) */
2637
Bram Moolenaar860cae12010-06-05 23:22:07 +02002638#if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002639 synblock_T *w_s; /* for :ownsyntax */
Bram Moolenaar860cae12010-06-05 23:22:07 +02002640#endif
2641
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 win_T *w_prev; /* link to previous window */
2643 win_T *w_next; /* link to next window */
Bram Moolenaar362ce482012-06-06 19:02:45 +02002644#ifdef FEAT_AUTOCMD
2645 int w_closing; /* window is being closed, don't let
2646 autocommands close it too. */
2647#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648
2649 frame_T *w_frame; /* frame containing this window */
2650
2651 pos_T w_cursor; /* cursor position in buffer */
2652
2653 colnr_T w_curswant; /* The column we'd like to be at. This is
2654 used to try to stay in the same column
2655 for up/down cursor motions. */
2656
2657 int w_set_curswant; /* If set, then update w_curswant the next
2658 time through cursupdate() to the
2659 current virtual column */
2660
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 /*
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01002662 * the next seven are used to update the visual part
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663 */
2664 char w_old_visual_mode; /* last known VIsual_mode */
2665 linenr_T w_old_cursor_lnum; /* last known end of visual part */
2666 colnr_T w_old_cursor_fcol; /* first column for block visual part */
2667 colnr_T w_old_cursor_lcol; /* last column for block visual part */
2668 linenr_T w_old_visual_lnum; /* last known start of visual part */
Bram Moolenaar6c131c42005-07-19 22:17:30 +00002669 colnr_T w_old_visual_col; /* last known start of visual part */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 colnr_T w_old_curswant; /* last known value of Curswant */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671
2672 /*
Bram Moolenaard4153d42008-11-15 15:06:17 +00002673 * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for
2674 * displaying the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 */
2676 linenr_T w_topline; /* buffer line number of the line at the
2677 top of the window */
Bram Moolenaard4153d42008-11-15 15:06:17 +00002678#ifdef FEAT_AUTOCMD
2679 char w_topline_was_set; /* flag set to TRUE when topline is set,
2680 e.g. by winrestview() */
2681#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682#ifdef FEAT_DIFF
2683 int w_topfill; /* number of filler lines above w_topline */
2684 int w_old_topfill; /* w_topfill at last redraw */
2685 int w_botfill; /* TRUE when filler lines are actually
2686 below w_topline (at end of file) */
2687 int w_old_botfill; /* w_botfill at last redraw */
2688#endif
2689 colnr_T w_leftcol; /* window column number of the left most
2690 character in the window; used when
2691 'wrap' is off */
2692 colnr_T w_skipcol; /* starting column when a single line
2693 doesn't fit in the window */
2694
2695 /*
2696 * Layout of the window in the screen.
2697 * May need to add "msg_scrolled" to "w_winrow" in rare situations.
2698 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 int w_winrow; /* first row of window in screen */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 int w_height; /* number of rows in window, excluding
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02002701 status/command/winbar line(s) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 int w_status_height; /* number of status lines (0 or 1) */
Bram Moolenaar53f81742017-09-22 14:35:51 +02002703 int w_wincol; /* Leftmost column of window in screen. */
Bram Moolenaar02631462017-09-22 15:20:32 +02002704 int w_width; /* Width of window, excluding separation. */
Bram Moolenaare0de17d2017-09-24 16:24:34 +02002705 int w_vsep_width; /* Number of separator columns (0 or 1). */
2706
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 /*
2708 * === start of cached values ====
2709 */
2710 /*
2711 * Recomputing is minimized by storing the result of computations.
2712 * Use functions in screen.c to check if they are valid and to update.
2713 * w_valid is a bitfield of flags, which indicate if specific values are
2714 * valid or need to be recomputed. See screen.c for values.
2715 */
2716 int w_valid;
2717 pos_T w_valid_cursor; /* last known position of w_cursor, used
2718 to adjust w_valid */
2719 colnr_T w_valid_leftcol; /* last known w_leftcol */
2720
2721 /*
2722 * w_cline_height is the number of physical lines taken by the buffer line
2723 * that the cursor is on. We use this to avoid extra calls to plines().
2724 */
2725 int w_cline_height; /* current size of cursor line */
2726#ifdef FEAT_FOLDING
2727 int w_cline_folded; /* cursor line is folded */
2728#endif
2729
2730 int w_cline_row; /* starting row of the cursor line */
2731
2732 colnr_T w_virtcol; /* column number of the cursor in the
2733 buffer line, as opposed to the column
2734 number we're at on the screen. This
2735 makes a difference on lines which span
2736 more than one screen line or when
2737 w_leftcol is non-zero */
2738
2739 /*
2740 * w_wrow and w_wcol specify the cursor position in the window.
2741 * This is related to positions in the window, not in the display or
2742 * buffer, thus w_wrow is relative to w_winrow.
2743 */
2744 int w_wrow, w_wcol; /* cursor position in window */
2745
2746 linenr_T w_botline; /* number of the line below the bottom of
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002747 the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 int w_empty_rows; /* number of ~ rows in window */
2749#ifdef FEAT_DIFF
2750 int w_filler_rows; /* number of filler rows at the end of the
2751 window */
2752#endif
2753
2754 /*
2755 * Info about the lines currently in the window is remembered to avoid
2756 * recomputing it every time. The allocated size of w_lines[] is Rows.
2757 * Only the w_lines_valid entries are actually valid.
2758 * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
2759 * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
2760 * Between changing text and updating the display w_lines[] represents
2761 * what is currently displayed. wl_valid is reset to indicated this.
2762 * This is used for efficient redrawing.
2763 */
2764 int w_lines_valid; /* number of valid entries */
2765 wline_T *w_lines;
2766
2767#ifdef FEAT_FOLDING
2768 garray_T w_folds; /* array of nested folds */
2769 char w_fold_manual; /* when TRUE: some folds are opened/closed
2770 manually */
2771 char w_foldinvalid; /* when TRUE: folding needs to be
2772 recomputed */
2773#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002774#ifdef FEAT_LINEBREAK
Bram Moolenaar64486672010-05-16 15:46:46 +02002775 int w_nrwidth; /* width of 'number' and 'relativenumber'
2776 column being used */
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002777#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778
2779 /*
2780 * === end of cached values ===
2781 */
2782
2783 int w_redr_type; /* type of redraw to be performed on win */
2784 int w_upd_rows; /* number of window lines to update when
2785 w_redr_type is REDRAW_TOP */
2786 linenr_T w_redraw_top; /* when != 0: first line needing redraw */
2787 linenr_T w_redraw_bot; /* when != 0: last line needing redraw */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 int w_redr_status; /* if TRUE status line must be redrawn */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789
2790#ifdef FEAT_CMDL_INFO
2791 /* remember what is shown in the ruler for this window (if 'ruler' set) */
2792 pos_T w_ru_cursor; /* cursor position shown in ruler */
2793 colnr_T w_ru_virtcol; /* virtcol shown in ruler */
2794 linenr_T w_ru_topline; /* topline shown in ruler */
2795 linenr_T w_ru_line_count; /* line count used for ruler */
2796# ifdef FEAT_DIFF
2797 int w_ru_topfill; /* topfill shown in ruler */
2798# endif
2799 char w_ru_empty; /* TRUE if ruler shows 0-1 (empty line) */
2800#endif
2801
2802 int w_alt_fnum; /* alternate file (for # and CTRL-^) */
2803
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 alist_T *w_alist; /* pointer to arglist for this window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 int w_arg_idx; /* current index in argument list (can be
2806 out of range!) */
2807 int w_arg_idx_invalid; /* editing another file than w_arg_idx */
2808
2809 char_u *w_localdir; /* absolute path of local directory or
2810 NULL */
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02002811#ifdef FEAT_MENU
2812 vimmenu_T *w_winbar; /* The root of the WinBar menu hierarchy. */
2813 winbar_item_T *w_winbar_items; /* list of items in the WinBar */
2814 int w_winbar_height; /* 1 if there is a window toolbar */
2815#endif
2816
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 /*
2818 * Options local to a window.
2819 * They are local because they influence the layout of the window or
2820 * depend on the window layout.
2821 * There are two values: w_onebuf_opt is local to the buffer currently in
2822 * this window, w_allbuf_opt is for all buffers in this window.
2823 */
2824 winopt_T w_onebuf_opt;
2825 winopt_T w_allbuf_opt;
2826
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002827 /* A few options have local flags for P_INSECURE. */
2828#ifdef FEAT_STL_OPT
2829 long_u w_p_stl_flags; /* flags for 'statusline' */
2830#endif
2831#ifdef FEAT_EVAL
2832 long_u w_p_fde_flags; /* flags for 'foldexpr' */
2833 long_u w_p_fdt_flags; /* flags for 'foldtext' */
2834#endif
Bram Moolenaar1a384422010-07-14 19:53:30 +02002835#ifdef FEAT_SYN_HL
2836 int *w_p_cc_cols; /* array of columns to highlight or NULL */
2837#endif
Bram Moolenaar597a4222014-06-25 14:39:50 +02002838#ifdef FEAT_LINEBREAK
2839 int w_p_brimin; /* minimum width for breakindent */
2840 int w_p_brishift; /* additional shift for breakindent */
2841 int w_p_brisbr; /* sbr in 'briopt' */
2842#endif
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002843
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844 /* transform a pointer to a "onebuf" option into a "allbuf" option */
2845#define GLOBAL_WO(p) ((char *)p + sizeof(winopt_T))
2846
2847#ifdef FEAT_SCROLLBIND
2848 long w_scbind_pos;
2849#endif
2850
2851#ifdef FEAT_EVAL
Bram Moolenaar8f999f12005-01-25 22:12:55 +00002852 dictitem_T w_winvar; /* variable for "w:" Dictionary */
Bram Moolenaar429fa852013-04-15 12:27:36 +02002853 dict_T *w_vars; /* internal variables, local to window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002854#endif
2855
2856#if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
2857 int w_farsi; /* for the window dependent Farsi functions */
2858#endif
2859
2860 /*
2861 * The w_prev_pcmark field is used to check whether we really did jump to
2862 * a new line after setting the w_pcmark. If not, then we revert to
2863 * using the previous w_pcmark.
2864 */
2865 pos_T w_pcmark; /* previous context mark */
2866 pos_T w_prev_pcmark; /* previous w_pcmark */
2867
2868#ifdef FEAT_JUMPLIST
2869 /*
2870 * the jumplist contains old cursor positions
2871 */
2872 xfmark_T w_jumplist[JUMPLISTSIZE];
2873 int w_jumplistlen; /* number of active entries */
2874 int w_jumplistidx; /* current position */
2875
2876 int w_changelistidx; /* current position in b_changelist */
2877#endif
2878
2879#ifdef FEAT_SEARCH_EXTRA
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002880 matchitem_T *w_match_head; /* head of match list */
2881 int w_next_match_id; /* next match ID */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882#endif
2883
2884 /*
2885 * the tagstack grows from 0 upwards:
2886 * entry 0: older
2887 * entry 1: newer
2888 * entry 2: newest
2889 */
2890 taggy_T w_tagstack[TAGSTACKSIZE]; /* the tag stack */
Bram Moolenaar335437b2007-05-10 18:32:52 +00002891 int w_tagstackidx; /* idx just below active entry */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 int w_tagstacklen; /* number of tags on stack */
2893
2894 /*
2895 * w_fraction is the fractional row of the cursor within the window, from
2896 * 0 at the top row to FRACTION_MULT at the last row.
2897 * w_prev_fraction_row was the actual cursor row when w_fraction was last
2898 * calculated.
2899 */
2900 int w_fraction;
2901 int w_prev_fraction_row;
2902
2903#ifdef FEAT_GUI
2904 scrollbar_T w_scrollbars[2]; /* vert. Scrollbars for this window */
2905#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002906#ifdef FEAT_LINEBREAK
2907 linenr_T w_nrwidth_line_count; /* line count when ml_nrwidth_width
2908 * was computed. */
Bram Moolenaar6b314672015-03-20 15:42:10 +01002909 long w_nuw_cached; /* 'numberwidth' option cached */
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002910 int w_nrwidth_width; /* nr of chars to print line count. */
2911#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002913#ifdef FEAT_QUICKFIX
2914 qf_info_T *w_llist; /* Location list for this window */
2915 /*
2916 * Location list reference used in the location list window.
2917 * In a non-location list window, w_llist_ref is NULL.
2918 */
2919 qf_info_T *w_llist_ref;
2920#endif
2921
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002922
2923#ifdef FEAT_MZSCHEME
Bram Moolenaare344bea2005-09-01 20:46:49 +00002924 void *w_mzscheme_ref; /* The MzScheme value for this window */
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002925#endif
2926
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927#ifdef FEAT_PERL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002928 void *w_perl_private;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929#endif
2930
2931#ifdef FEAT_PYTHON
Bram Moolenaare344bea2005-09-01 20:46:49 +00002932 void *w_python_ref; /* The Python value for this window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933#endif
2934
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02002935#ifdef FEAT_PYTHON3
2936 void *w_python3_ref; /* The Python value for this window */
2937#endif
2938
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939#ifdef FEAT_TCL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002940 void *w_tcl_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941#endif
2942
2943#ifdef FEAT_RUBY
Bram Moolenaare344bea2005-09-01 20:46:49 +00002944 void *w_ruby_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945#endif
2946};
2947
2948/*
2949 * Arguments for operators.
2950 */
Bram Moolenaare344bea2005-09-01 20:46:49 +00002951typedef struct oparg_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952{
2953 int op_type; /* current pending operator type */
2954 int regname; /* register to use for the operator */
2955 int motion_type; /* type of the current cursor motion */
2956 int motion_force; /* force motion type: 'v', 'V' or CTRL-V */
2957 int use_reg_one; /* TRUE if delete uses reg 1 even when not
2958 linewise */
2959 int inclusive; /* TRUE if char motion is inclusive (only
2960 valid when motion_type is MCHAR */
2961 int end_adjusted; /* backuped b_op_end one char (only used by
2962 do_format()) */
2963 pos_T start; /* start of the operator */
2964 pos_T end; /* end of the operator */
2965 pos_T cursor_start; /* cursor position before motion for "gw" */
2966
2967 long line_count; /* number of lines from op_start to op_end
2968 (inclusive) */
2969 int empty; /* op_start and op_end the same (only used by
2970 do_change()) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 int is_VIsual; /* operator on Visual area */
2972 int block_mode; /* current operator is Visual block mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 colnr_T start_vcol; /* start col for block mode operator */
2974 colnr_T end_vcol; /* end col for block mode operator */
Bram Moolenaara983fe92008-07-31 20:04:27 +00002975#ifdef FEAT_AUTOCMD
2976 long prev_opcount; /* ca.opcount saved for K_CURSORHOLD */
2977 long prev_count0; /* ca.count0 saved for K_CURSORHOLD */
2978#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979} oparg_T;
2980
2981/*
2982 * Arguments for Normal mode commands.
2983 */
Bram Moolenaare344bea2005-09-01 20:46:49 +00002984typedef struct cmdarg_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985{
2986 oparg_T *oap; /* Operator arguments */
2987 int prechar; /* prefix character (optional, always 'g') */
2988 int cmdchar; /* command character */
2989 int nchar; /* next command character (optional) */
2990#ifdef FEAT_MBYTE
2991 int ncharC1; /* first composing character (optional) */
2992 int ncharC2; /* second composing character (optional) */
2993#endif
2994 int extra_char; /* yet another character (optional) */
2995 long opcount; /* count before an operator */
2996 long count0; /* count before command, default 0 */
2997 long count1; /* count before command, default 1 */
2998 int arg; /* extra argument from nv_cmds[] */
2999 int retval; /* return: CA_* values */
3000 char_u *searchbuf; /* return: pointer to search pattern or NULL */
3001} cmdarg_T;
3002
3003/* values for retval: */
3004#define CA_COMMAND_BUSY 1 /* skip restarting edit() once */
3005#define CA_NO_ADJ_OP_END 2 /* don't adjust operator end */
3006
3007#ifdef CURSOR_SHAPE
3008/*
3009 * struct to store values from 'guicursor' and 'mouseshape'
3010 */
3011/* Indexes in shape_table[] */
3012#define SHAPE_IDX_N 0 /* Normal mode */
3013#define SHAPE_IDX_V 1 /* Visual mode */
3014#define SHAPE_IDX_I 2 /* Insert mode */
3015#define SHAPE_IDX_R 3 /* Replace mode */
3016#define SHAPE_IDX_C 4 /* Command line Normal mode */
3017#define SHAPE_IDX_CI 5 /* Command line Insert mode */
3018#define SHAPE_IDX_CR 6 /* Command line Replace mode */
3019#define SHAPE_IDX_O 7 /* Operator-pending mode */
Bram Moolenaar2767c602010-05-16 13:56:06 +02003020#define SHAPE_IDX_VE 8 /* Visual mode with 'selection' exclusive */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021#define SHAPE_IDX_CLINE 9 /* On command line */
3022#define SHAPE_IDX_STATUS 10 /* A status line */
3023#define SHAPE_IDX_SDRAG 11 /* dragging a status line */
3024#define SHAPE_IDX_VSEP 12 /* A vertical separator line */
3025#define SHAPE_IDX_VDRAG 13 /* dragging a vertical separator line */
3026#define SHAPE_IDX_MORE 14 /* Hit-return or More */
3027#define SHAPE_IDX_MOREL 15 /* Hit-return or More in last line */
3028#define SHAPE_IDX_SM 16 /* showing matching paren */
3029#define SHAPE_IDX_COUNT 17
3030
3031#define SHAPE_BLOCK 0 /* block cursor */
3032#define SHAPE_HOR 1 /* horizontal bar cursor */
3033#define SHAPE_VER 2 /* vertical bar cursor */
3034
3035#define MSHAPE_NUMBERED 1000 /* offset for shapes identified by number */
3036#define MSHAPE_HIDE 1 /* hide mouse pointer */
3037
3038#define SHAPE_MOUSE 1 /* used for mouse pointer shape */
3039#define SHAPE_CURSOR 2 /* used for text cursor shape */
3040
3041typedef struct cursor_entry
3042{
3043 int shape; /* one of the SHAPE_ defines */
3044 int mshape; /* one of the MSHAPE defines */
3045 int percentage; /* percentage of cell for bar */
3046 long blinkwait; /* blinking, wait time before blinking starts */
3047 long blinkon; /* blinking, on time */
3048 long blinkoff; /* blinking, off time */
3049 int id; /* highlight group ID */
3050 int id_lm; /* highlight group ID for :lmap mode */
3051 char *name; /* mode name (fixed) */
3052 char used_for; /* SHAPE_MOUSE and/or SHAPE_CURSOR */
3053} cursorentry_T;
3054#endif /* CURSOR_SHAPE */
3055
3056#ifdef FEAT_MENU
3057
3058/* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
3059#define MENU_INDEX_INVALID -1
3060#define MENU_INDEX_NORMAL 0
3061#define MENU_INDEX_VISUAL 1
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003062#define MENU_INDEX_SELECT 2
3063#define MENU_INDEX_OP_PENDING 3
3064#define MENU_INDEX_INSERT 4
3065#define MENU_INDEX_CMDLINE 5
3066#define MENU_INDEX_TIP 6
3067#define MENU_MODES 7
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068
3069/* Menu modes */
3070#define MENU_NORMAL_MODE (1 << MENU_INDEX_NORMAL)
3071#define MENU_VISUAL_MODE (1 << MENU_INDEX_VISUAL)
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003072#define MENU_SELECT_MODE (1 << MENU_INDEX_SELECT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073#define MENU_OP_PENDING_MODE (1 << MENU_INDEX_OP_PENDING)
3074#define MENU_INSERT_MODE (1 << MENU_INDEX_INSERT)
3075#define MENU_CMDLINE_MODE (1 << MENU_INDEX_CMDLINE)
3076#define MENU_TIP_MODE (1 << MENU_INDEX_TIP)
3077#define MENU_ALL_MODES ((1 << MENU_INDEX_TIP) - 1)
3078/*note MENU_INDEX_TIP is not a 'real' mode*/
3079
3080/* Start a menu name with this to not include it on the main menu bar */
3081#define MNU_HIDDEN_CHAR ']'
3082
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083struct VimMenu
3084{
3085 int modes; /* Which modes is this menu visible for? */
3086 int enabled; /* for which modes the menu is enabled */
Bram Moolenaar70b11cd2010-05-14 22:24:40 +02003087 char_u *name; /* Name of menu, possibly translated */
3088 char_u *dname; /* Displayed Name ("name" without '&') */
3089#ifdef FEAT_MULTI_LANG
3090 char_u *en_name; /* "name" untranslated, NULL when "name"
3091 * was not translated */
3092 char_u *en_dname; /* "dname" untranslated, NULL when "dname"
3093 * was not translated */
3094#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 int mnemonic; /* mnemonic key (after '&') */
3096 char_u *actext; /* accelerator text (after TAB) */
3097 int priority; /* Menu order priority */
3098#ifdef FEAT_GUI
Bram Moolenaard99df422016-01-29 23:20:40 +01003099 void (*cb)(vimmenu_T *); /* Call-back routine */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100#endif
3101#ifdef FEAT_TOOLBAR
3102 char_u *iconfile; /* name of file for icon or NULL */
3103 int iconidx; /* icon index (-1 if not set) */
3104 int icon_builtin; /* icon names is BuiltIn{nr} */
3105#endif
3106 char_u *strings[MENU_MODES]; /* Mapped string for each mode */
3107 int noremap[MENU_MODES]; /* A REMAP_ flag for each mode */
3108 char silent[MENU_MODES]; /* A silent flag for each mode */
3109 vimmenu_T *children; /* Children of sub-menu */
3110 vimmenu_T *parent; /* Parent of menu */
3111 vimmenu_T *next; /* Next item in menu */
3112#ifdef FEAT_GUI_X11
3113 Widget id; /* Manage this to enable item */
3114 Widget submenu_id; /* If this is submenu, add children here */
3115#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116#ifdef FEAT_GUI_GTK
3117 GtkWidget *id; /* Manage this to enable item */
3118 GtkWidget *submenu_id; /* If this is submenu, add children here */
Bram Moolenaar98921892016-02-23 17:14:37 +01003119# if defined(GTK_CHECK_VERSION) && !GTK_CHECK_VERSION(3,4,0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 GtkWidget *tearoff_handle;
Bram Moolenaar98921892016-02-23 17:14:37 +01003121# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 GtkWidget *label; /* Used by "set wak=" code. */
3123#endif
3124#ifdef FEAT_GUI_MOTIF
3125 int sensitive; /* turn button on/off */
Bram Moolenaarec2dad62005-01-02 11:36:03 +00003126 char **xpm; /* pixmap data */
Bram Moolenaar7c626922005-02-07 22:01:03 +00003127 char *xpm_fname; /* file with pixmap data */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128#endif
Bram Moolenaarec2dad62005-01-02 11:36:03 +00003129#ifdef FEAT_GUI_ATHENA
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 Pixmap image; /* Toolbar image */
3131#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132#ifdef FEAT_BEVAL_TIP
3133 BalloonEval *tip; /* tooltip for this menu item */
3134#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135#ifdef FEAT_GUI_W32
3136 UINT id; /* Id of menu item */
3137 HMENU submenu_id; /* If this is submenu, add children here */
3138 HWND tearoff_handle; /* hWnd of tearoff if created */
3139#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140#ifdef FEAT_GUI_MAC
3141/* MenuHandle id; */
3142/* short index; */ /* the item index within the father menu */
3143 short menu_id; /* the menu id to which this item belong */
3144 short submenu_id; /* the menu id of the children (could be
Bram Moolenaar2767c602010-05-16 13:56:06 +02003145 get through some tricks) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 MenuHandle menu_handle;
3147 MenuHandle submenu_handle;
3148#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149#ifdef FEAT_GUI_PHOTON
3150 PtWidget_t *id;
3151 PtWidget_t *submenu_id;
3152#endif
3153};
3154#else
3155/* For generating prototypes when FEAT_MENU isn't defined. */
3156typedef int vimmenu_T;
3157
3158#endif /* FEAT_MENU */
3159
3160/*
3161 * Struct to save values in before executing autocommands for a buffer that is
Bram Moolenaarf30e74c2006-08-16 17:35:00 +00003162 * not the current buffer. Without FEAT_AUTOCMD only "curbuf" is remembered.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 */
3164typedef struct
3165{
Bram Moolenaar746ebd32009-06-16 14:01:43 +00003166 buf_T *save_curbuf; /* saved curbuf */
Bram Moolenaarf30e74c2006-08-16 17:35:00 +00003167#ifdef FEAT_AUTOCMD
Bram Moolenaar6bef63c2009-07-29 10:10:29 +00003168 int use_aucmd_win; /* using aucmd_win */
Bram Moolenaar746ebd32009-06-16 14:01:43 +00003169 win_T *save_curwin; /* saved curwin */
3170 win_T *new_curwin; /* new curwin */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003171 bufref_T new_curbuf; /* new curbuf */
Bram Moolenaar6bef63c2009-07-29 10:10:29 +00003172 char_u *globaldir; /* saved value of globaldir */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173#endif
3174} aco_save_T;
3175
3176/*
3177 * Generic option table item, only used for printer at the moment.
3178 */
3179typedef struct
3180{
3181 const char *name;
3182 int hasnum;
3183 long number;
3184 char_u *string; /* points into option string */
3185 int strlen;
3186 int present;
3187} option_table_T;
3188
3189/*
3190 * Structure to hold printing color and font attributes.
3191 */
3192typedef struct
3193{
3194 long_u fg_color;
3195 long_u bg_color;
3196 int bold;
3197 int italic;
3198 int underline;
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003199 int undercurl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200} prt_text_attr_T;
3201
3202/*
3203 * Structure passed back to the generic printer code.
3204 */
3205typedef struct
3206{
3207 int n_collated_copies;
3208 int n_uncollated_copies;
3209 int duplex;
3210 int chars_per_line;
3211 int lines_per_page;
3212 int has_color;
3213 prt_text_attr_T number;
3214#ifdef FEAT_SYN_HL
3215 int modec;
3216 int do_syntax;
3217#endif
3218 int user_abort;
3219 char_u *jobname;
3220#ifdef FEAT_POSTSCRIPT
3221 char_u *outfile;
3222 char_u *arguments;
3223#endif
3224} prt_settings_T;
3225
3226#define PRINT_NUMBER_WIDTH 8
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00003227
3228/*
3229 * Used for popup menu items.
3230 */
3231typedef struct
3232{
3233 char_u *pum_text; /* main menu text */
Bram Moolenaarc270d802006-03-11 21:29:41 +00003234 char_u *pum_kind; /* extra kind text (may be truncated) */
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00003235 char_u *pum_extra; /* extra menu text (may be truncated) */
3236 char_u *pum_info; /* extra info */
3237} pumitem_T;
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003238
3239/*
3240 * Structure used for get_tagfname().
3241 */
3242typedef struct
3243{
3244 char_u *tn_tags; /* value of 'tags' when starting */
3245 char_u *tn_np; /* current position in tn_tags */
3246 int tn_did_filefind_init;
3247 int tn_hf_idx;
3248 void *tn_search_ctx;
3249} tagname_T;
3250
Bram Moolenaar39f05632006-03-19 22:15:26 +00003251/*
3252 * Array indexes used for cptext argument of ins_compl_add().
3253 */
3254#define CPT_ABBR 0 /* "abbr" */
3255#define CPT_MENU 1 /* "menu" */
3256#define CPT_KIND 2 /* "kind" */
3257#define CPT_INFO 3 /* "info" */
3258#define CPT_COUNT 4 /* Number of entries */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02003259
3260typedef struct {
3261 UINT32_T total[2];
3262 UINT32_T state[8];
3263 char_u buffer[64];
3264} context_sha256_T;
Bram Moolenaar520e1e42016-01-23 19:46:28 +01003265
3266/*
3267 * Structure used for reading in json_decode().
3268 */
Bram Moolenaar56ead342016-02-02 18:20:08 +01003269struct js_reader
Bram Moolenaar520e1e42016-01-23 19:46:28 +01003270{
3271 char_u *js_buf; /* text to be decoded */
Bram Moolenaar56ead342016-02-02 18:20:08 +01003272 char_u *js_end; /* NUL in js_buf */
Bram Moolenaar520e1e42016-01-23 19:46:28 +01003273 int js_used; /* bytes used from js_buf */
Bram Moolenaar56ead342016-02-02 18:20:08 +01003274 int (*js_fill)(struct js_reader *);
3275 /* function to fill the buffer or NULL;
3276 * return TRUE when the buffer was filled */
3277 void *js_cookie; /* can be used by js_fill */
Bram Moolenaar46c00a62016-03-28 14:11:42 +02003278 int js_cookie_arg; /* can be used by js_fill */
Bram Moolenaar56ead342016-02-02 18:20:08 +01003279};
3280typedef struct js_reader js_read_T;
Bram Moolenaar975b5272016-03-15 23:10:59 +01003281
3282typedef struct timer_S timer_T;
3283struct timer_S
3284{
Bram Moolenaar75537a92016-09-05 22:45:28 +02003285 long tr_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01003286#ifdef FEAT_TIMERS
3287 timer_T *tr_next;
3288 timer_T *tr_prev;
3289 proftime_T tr_due; /* when the callback is to be invoked */
Bram Moolenaar75537a92016-09-05 22:45:28 +02003290 char tr_firing; /* when TRUE callback is being called */
3291 char tr_paused; /* when TRUE callback is not invoked */
Bram Moolenaar975b5272016-03-15 23:10:59 +01003292 int tr_repeat; /* number of times to repeat, -1 forever */
Bram Moolenaara8e691d2016-08-07 15:19:26 +02003293 long tr_interval; /* msec */
Bram Moolenaar975b5272016-03-15 23:10:59 +01003294 char_u *tr_callback; /* allocated */
3295 partial_T *tr_partial;
Bram Moolenaarc577d812017-07-08 22:37:34 +02003296 int tr_emsg_count;
Bram Moolenaar975b5272016-03-15 23:10:59 +01003297#endif
3298};
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003299
3300/* Maximum number of commands from + or -c arguments. */
3301#define MAX_ARG_CMDS 10
3302
3303/* values for "window_layout" */
3304#define WIN_HOR 1 /* "-o" horizontally split windows */
3305#define WIN_VER 2 /* "-O" vertically split windows */
3306#define WIN_TABS 3 /* "-p" windows on tab pages */
3307
3308/* Struct for various parameters passed between main() and other functions. */
3309typedef struct
3310{
3311 int argc;
3312 char **argv;
3313
Bram Moolenaara8e691d2016-08-07 15:19:26 +02003314 char_u *fname; /* first file to edit */
3315
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003316 int evim_mode; /* started as "evim" */
3317 char_u *use_vimrc; /* vimrc from -u argument */
3318
3319 int n_commands; /* no. of commands from + or -c */
3320 char_u *commands[MAX_ARG_CMDS]; /* commands from + or -c arg. */
3321 char_u cmds_tofree[MAX_ARG_CMDS]; /* commands that need free() */
3322 int n_pre_commands; /* no. of commands from --cmd */
3323 char_u *pre_commands[MAX_ARG_CMDS]; /* commands from --cmd argument */
3324
3325 int edit_type; /* type of editing to do */
3326 char_u *tagname; /* tag from -t argument */
3327#ifdef FEAT_QUICKFIX
3328 char_u *use_ef; /* 'errorfile' from -q argument */
3329#endif
3330
3331 int want_full_screen;
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003332 int not_a_term; /* no warning for missing term? */
Bram Moolenaar2cab0e12016-11-24 15:09:07 +01003333 int tty_fail; /* exit if not a tty */
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003334 char_u *term; /* specified terminal name */
3335#ifdef FEAT_CRYPT
3336 int ask_for_key; /* -x argument */
3337#endif
3338 int no_swap_file; /* "-n" argument used */
3339#ifdef FEAT_EVAL
3340 int use_debug_break_level;
3341#endif
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003342 int window_count; /* number of windows to use */
3343 int window_layout; /* 0, WIN_HOR, WIN_VER or WIN_TABS */
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003344
3345#ifdef FEAT_CLIENTSERVER
3346 int serverArg; /* TRUE when argument for a server */
3347 char_u *serverName_arg; /* cmdline arg for server name */
3348 char_u *serverStr; /* remote server command */
3349 char_u *serverStrEnc; /* encoding of serverStr */
3350 char_u *servername; /* allocated name for our server */
3351#endif
3352#if !defined(UNIX)
3353# define EXPAND_FILENAMES
3354 int literal; /* don't expand file names */
3355#endif
3356#ifdef MSWIN
3357 int full_path; /* file name argument was full path */
3358#endif
3359#ifdef FEAT_DIFF
3360 int diff_mode; /* start with 'diff' set */
3361#endif
3362} mparm_T;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003363
3364/*
3365 * Structure returned by get_lval() and used by set_var_lval().
3366 * For a plain name:
3367 * "name" points to the variable name.
3368 * "exp_name" is NULL.
3369 * "tv" is NULL
3370 * For a magic braces name:
3371 * "name" points to the expanded variable name.
3372 * "exp_name" is non-NULL, to be freed later.
3373 * "tv" is NULL
3374 * For an index in a list:
3375 * "name" points to the (expanded) variable name.
3376 * "exp_name" NULL or non-NULL, to be freed later.
3377 * "tv" points to the (first) list item value
3378 * "li" points to the (first) list item
3379 * "range", "n1", "n2" and "empty2" indicate what items are used.
3380 * For an existing Dict item:
3381 * "name" points to the (expanded) variable name.
3382 * "exp_name" NULL or non-NULL, to be freed later.
3383 * "tv" points to the dict item value
3384 * "newkey" is NULL
3385 * For a non-existing Dict item:
3386 * "name" points to the (expanded) variable name.
3387 * "exp_name" NULL or non-NULL, to be freed later.
3388 * "tv" points to the Dictionary typval_T
3389 * "newkey" is the key for the new item.
3390 */
3391typedef struct lval_S
3392{
3393 char_u *ll_name; /* start of variable name (can be NULL) */
3394 char_u *ll_exp_name; /* NULL or expanded name in allocated memory. */
3395 typval_T *ll_tv; /* Typeval of item being used. If "newkey"
3396 isn't NULL it's the Dict to which to add
3397 the item. */
3398 listitem_T *ll_li; /* The list item or NULL. */
3399 list_T *ll_list; /* The list or NULL. */
3400 int ll_range; /* TRUE when a [i:j] range was used */
3401 long ll_n1; /* First index for list */
3402 long ll_n2; /* Second index for list range */
3403 int ll_empty2; /* Second index is empty: [i:] */
3404 dict_T *ll_dict; /* The Dictionary or NULL */
3405 dictitem_T *ll_di; /* The dictitem or NULL */
3406 char_u *ll_newkey; /* New key for Dict in alloc. mem or NULL. */
3407} lval_T;
Bram Moolenaara21a6a92017-09-23 16:33:50 +02003408
3409/* Structure used to save the current state. Used when executing Normal mode
3410 * commands while in any other mode. */
3411typedef struct {
3412 int save_msg_scroll;
3413 int save_restart_edit;
3414 int save_msg_didout;
3415 int save_State;
3416 int save_insertmode;
3417 int save_finish_op;
3418 int save_opcount;
3419 tasave_T tabuf;
3420} save_state_T;