blob: e6b9f0dbef3ccd1c6ad42fcc19c12ea14a268cb5 [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/*
Bram Moolenaar29ddebe2019-01-26 17:28:26 +010024 * Position in file or buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +000025 */
26typedef struct
27{
Bram Moolenaar29ddebe2019-01-26 17:28:26 +010028 linenr_T lnum; // line number
29 colnr_T col; // column number
30 colnr_T coladd; // extra virtual column
Bram Moolenaar071d4272004-06-13 20:20:40 +000031} pos_T;
32
Bram Moolenaar071d4272004-06-13 20:20:40 +000033
34/*
35 * Same, but without coladd.
36 */
37typedef struct
38{
Bram Moolenaar29ddebe2019-01-26 17:28:26 +010039 linenr_T lnum; // line number
40 colnr_T col; // column number
Bram Moolenaar071d4272004-06-13 20:20:40 +000041} lpos_T;
42
43/*
44 * Structure used for growing arrays.
45 * This is used to store information that only grows, is deleted all at
46 * once, and needs to be accessed by index. See ga_clear() and ga_grow().
47 */
48typedef struct growarray
49{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +020050 int ga_len; // current number of items used
51 int ga_maxlen; // maximum number of items possible
52 int ga_itemsize; // sizeof(item)
53 int ga_growsize; // number of items to grow each time
54 void *ga_data; // pointer to the first item
Bram Moolenaar071d4272004-06-13 20:20:40 +000055} garray_T;
56
57#define GA_EMPTY {0, 0, 0, 0, NULL}
58
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +000059typedef struct window_S win_T;
60typedef struct wininfo_S wininfo_T;
61typedef struct frame_S frame_T;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +020062typedef int scid_T; // script ID
63typedef struct file_buffer buf_T; // forward declaration
Bram Moolenaare4f25e42017-07-07 11:54:15 +020064typedef struct terminal_S term_T;
Bram Moolenaarfbc0d2e2013-05-19 19:40:29 +020065
Bram Moolenaar1b9645d2017-09-17 23:03:31 +020066#ifdef FEAT_MENU
67typedef struct VimMenu vimmenu_T;
68#endif
69
Bram Moolenaar67979662020-06-20 22:50:47 +020070// maximum value for sc_version
71#define SCRIPT_VERSION_MAX 4
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010072// value for sc_version in a Vim9 script file
73#define SCRIPT_VERSION_VIM9 999999
74
Bram Moolenaar45e5fd12017-06-04 14:58:02 +020075/*
Bram Moolenaarfe72d082019-12-20 19:07:00 +010076 * SCript ConteXt (SCTX): identifies a script line.
Bram Moolenaarf29c1c62018-09-10 21:05:02 +020077 * When sourcing a script "sc_lnum" is zero, "sourcing_lnum" is the current
78 * line number. When executing a user function "sc_lnum" is the line where the
79 * function was defined, "sourcing_lnum" is the line number inside the
80 * function. When stored with a function, mapping, option, etc. "sc_lnum" is
81 * the line number in the script "sc_sid".
Bram Moolenaar7ebcba62020-01-12 17:42:55 +010082 *
83 * sc_version is also here, for convenience.
Bram Moolenaarf29c1c62018-09-10 21:05:02 +020084 */
85typedef struct {
Bram Moolenaar9b8d6222020-12-28 18:26:00 +010086#ifdef FEAT_EVAL
Bram Moolenaarf29c1c62018-09-10 21:05:02 +020087 scid_T sc_sid; // script ID
Bram Moolenaarded5f1b2018-11-10 17:33:29 +010088 int sc_seq; // sourcing sequence number
Bram Moolenaarf29c1c62018-09-10 21:05:02 +020089 linenr_T sc_lnum; // line number
Bram Moolenaar9b8d6222020-12-28 18:26:00 +010090#endif
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020091 int sc_version; // :scriptversion
Bram Moolenaarf29c1c62018-09-10 21:05:02 +020092} sctx_T;
93
94/*
Bram Moolenaar45e5fd12017-06-04 14:58:02 +020095 * Reference to a buffer that stores the value of buf_free_count.
Bram Moolenaarb25f9a92016-07-10 18:21:50 +020096 * bufref_valid() only needs to check "buf" when the count differs.
97 */
98typedef struct {
99 buf_T *br_buf;
Bram Moolenaar45e5fd12017-06-04 14:58:02 +0200100 int br_fnum;
Bram Moolenaarb25f9a92016-07-10 18:21:50 +0200101 int br_buf_free_count;
102} bufref_T;
103
Bram Moolenaarfbc0d2e2013-05-19 19:40:29 +0200104/*
105 * This is here because regexp.h needs pos_T and below regprog_T is used.
106 */
107#include "regexp.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
109/*
110 * This is here because gui.h needs the pos_T and win_T, and win_T needs gui.h
111 * for scrollbar_T.
112 */
113#ifdef FEAT_GUI
114# include "gui.h"
115#else
116# ifdef FEAT_XCLIPBOARD
117# include <X11/Intrinsic.h>
118# endif
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +0200119# define guicolor_T long
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200120# define INVALCOLOR ((guicolor_T)0x1ffffff)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200121 // only used for cterm.bg_rgb and cterm.fg_rgb: use cterm color
Bram Moolenaard4fc5772018-02-27 14:39:03 +0100122# define CTERMCOLOR ((guicolor_T)0x1fffffe)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123#endif
Bram Moolenaard4fc5772018-02-27 14:39:03 +0100124#define COLOR_INVALID(x) ((x) == INVALCOLOR || (x) == CTERMCOLOR)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125
Bram Moolenaar87fd0922021-11-20 13:47:45 +0000126#ifdef FEAT_TERMINAL
127# include "libvterm/include/vterm.h"
128typedef struct {
129 VTermColor fg;
130 VTermColor bg;
131} termcellcolor_T;
132#endif
133
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134/*
135 * marks: positions in a file
136 * (a normal mark is a lnum/col pair, the same as a file position)
137 */
138
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200139#define NMARKS ('z' - 'a' + 1) // max. # of named marks
Bram Moolenaar1e78e692019-07-22 20:18:27 +0200140#define EXTRA_MARKS 10 // marks 0-9
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200141#define JUMPLISTSIZE 100 // max. # of marks in jump list
142#define TAGSTACKSIZE 20 // max. # of tags in tag stack
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143
144typedef struct filemark
145{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200146 pos_T mark; // cursor position
147 int fnum; // file number
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148} fmark_T;
149
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200150// Xtended file mark: also has a file name
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151typedef struct xfilemark
152{
153 fmark_T fmark;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200154 char_u *fname; // file name, used when fnum == 0
Bram Moolenaar2d358992016-06-12 21:20:54 +0200155#ifdef FEAT_VIMINFO
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +0200156 time_T time_set;
Bram Moolenaar2d358992016-06-12 21:20:54 +0200157#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158} xfmark_T;
159
160/*
161 * The taggy struct is used to store the information about a :tag command.
162 */
163typedef struct taggy
164{
Bram Moolenaar45e18cb2019-04-28 18:05:35 +0200165 char_u *tagname; // tag name
166 fmark_T fmark; // cursor position BEFORE ":tag"
167 int cur_match; // match number
168 int cur_fnum; // buffer number used for cur_match
169 char_u *user_data; // used with tagfunc
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170} taggy_T;
171
172/*
173 * Structure that contains all options that are local to a window.
174 * Used twice in a window: for the current buffer and for all buffers.
175 * Also used in wininfo_T.
176 */
177typedef struct
178{
179#ifdef FEAT_ARABIC
180 int wo_arab;
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200181# define w_p_arab w_onebuf_opt.wo_arab // 'arabic'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182#endif
Bram Moolenaar597a4222014-06-25 14:39:50 +0200183#ifdef FEAT_LINEBREAK
184 int wo_bri;
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200185# define w_p_bri w_onebuf_opt.wo_bri // 'breakindent'
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200186 char_u *wo_briopt;
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200187# define w_p_briopt w_onebuf_opt.wo_briopt // 'breakindentopt'
Bram Moolenaar597a4222014-06-25 14:39:50 +0200188#endif
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200189 char_u *wo_wcr;
190# define w_p_wcr w_onebuf_opt.wo_wcr // 'wincolor'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191#ifdef FEAT_DIFF
192 int wo_diff;
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200193# define w_p_diff w_onebuf_opt.wo_diff // 'diff'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194#endif
195#ifdef FEAT_FOLDING
196 long wo_fdc;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200197# define w_p_fdc w_onebuf_opt.wo_fdc // 'foldcolumn'
Bram Moolenaara87aa802013-07-03 15:47:03 +0200198 int wo_fdc_save;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200199# define w_p_fdc_save w_onebuf_opt.wo_fdc_save // 'foldenable' saved for diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200 int wo_fen;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200201# define w_p_fen w_onebuf_opt.wo_fen // 'foldenable'
Bram Moolenaara87aa802013-07-03 15:47:03 +0200202 int wo_fen_save;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200203# define w_p_fen_save w_onebuf_opt.wo_fen_save // 'foldenable' saved for diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204 char_u *wo_fdi;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200205# define w_p_fdi w_onebuf_opt.wo_fdi // 'foldignore'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 long wo_fdl;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200207# define w_p_fdl w_onebuf_opt.wo_fdl // 'foldlevel'
Bram Moolenaara87aa802013-07-03 15:47:03 +0200208 int wo_fdl_save;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200209# define w_p_fdl_save w_onebuf_opt.wo_fdl_save // 'foldlevel' state saved for diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210 char_u *wo_fdm;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200211# define w_p_fdm w_onebuf_opt.wo_fdm // 'foldmethod'
Bram Moolenaara87aa802013-07-03 15:47:03 +0200212 char_u *wo_fdm_save;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200213# define w_p_fdm_save w_onebuf_opt.wo_fdm_save // 'fdm' saved for diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214 long wo_fml;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200215# define w_p_fml w_onebuf_opt.wo_fml // 'foldminlines'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216 long wo_fdn;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200217# define w_p_fdn w_onebuf_opt.wo_fdn // 'foldnestmax'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218# ifdef FEAT_EVAL
219 char_u *wo_fde;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200220# define w_p_fde w_onebuf_opt.wo_fde // 'foldexpr'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221 char_u *wo_fdt;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200222# define w_p_fdt w_onebuf_opt.wo_fdt // 'foldtext'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223# endif
224 char_u *wo_fmr;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200225# define w_p_fmr w_onebuf_opt.wo_fmr // 'foldmarker'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226#endif
227#ifdef FEAT_LINEBREAK
228 int wo_lbr;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200229# define w_p_lbr w_onebuf_opt.wo_lbr // 'linebreak'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230#endif
231 int wo_list;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200232#define w_p_list w_onebuf_opt.wo_list // 'list'
Bram Moolenaareed9d462021-02-15 20:38:25 +0100233 char_u *wo_lcs;
234#define w_p_lcs w_onebuf_opt.wo_lcs // 'listchars'
Bram Moolenaar96ba25a2022-07-04 17:34:33 +0100235 char_u *wo_fcs;
236#define w_p_fcs w_onebuf_opt.wo_fcs // 'fillchars'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237 int wo_nu;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200238#define w_p_nu w_onebuf_opt.wo_nu // 'number'
Bram Moolenaar64486672010-05-16 15:46:46 +0200239 int wo_rnu;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200240#define w_p_rnu w_onebuf_opt.wo_rnu // 'relativenumber'
Gary Johnson51ad8502021-08-03 18:33:08 +0200241 char_u *wo_ve;
242#define w_p_ve w_onebuf_opt.wo_ve // 'virtualedit'
243 unsigned wo_ve_flags;
244#define w_ve_flags w_onebuf_opt.wo_ve_flags // flags for 'virtualedit'
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000245#ifdef FEAT_LINEBREAK
246 long wo_nuw;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200247# define w_p_nuw w_onebuf_opt.wo_nuw // 'numberwidth'
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000248#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249 int wo_wfh;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200250# define w_p_wfh w_onebuf_opt.wo_wfh // 'winfixheight'
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000251 int wo_wfw;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200252# define w_p_wfw w_onebuf_opt.wo_wfw // 'winfixwidth'
Bram Moolenaar4033c552017-09-16 20:54:51 +0200253#if defined(FEAT_QUICKFIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254 int wo_pvw;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200255# define w_p_pvw w_onebuf_opt.wo_pvw // 'previewwindow'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256#endif
257#ifdef FEAT_RIGHTLEFT
258 int wo_rl;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200259# define w_p_rl w_onebuf_opt.wo_rl // 'rightleft'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 char_u *wo_rlc;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200261# define w_p_rlc w_onebuf_opt.wo_rlc // 'rightleftcmd'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262#endif
263 long wo_scr;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200264#define w_p_scr w_onebuf_opt.wo_scr // 'scroll'
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000265#ifdef FEAT_SPELL
Bram Moolenaar217ad922005-03-20 22:37:15 +0000266 int wo_spell;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200267# define w_p_spell w_onebuf_opt.wo_spell // 'spell'
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000268#endif
269#ifdef FEAT_SYN_HL
270 int wo_cuc;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200271# define w_p_cuc w_onebuf_opt.wo_cuc // 'cursorcolumn'
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000272 int wo_cul;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200273# define w_p_cul w_onebuf_opt.wo_cul // 'cursorline'
Bram Moolenaar410e98a2019-09-09 22:05:49 +0200274 char_u *wo_culopt;
275# define w_p_culopt w_onebuf_opt.wo_culopt // 'cursorlineopt'
Bram Moolenaar1a384422010-07-14 19:53:30 +0200276 char_u *wo_cc;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200277# define w_p_cc w_onebuf_opt.wo_cc // 'colorcolumn'
Bram Moolenaar217ad922005-03-20 22:37:15 +0000278#endif
Bram Moolenaaree857022019-11-09 23:26:40 +0100279#ifdef FEAT_LINEBREAK
280 char_u *wo_sbr;
281#define w_p_sbr w_onebuf_opt.wo_sbr // 'showbreak'
282#endif
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000283#ifdef FEAT_STL_OPT
284 char_u *wo_stl;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200285#define w_p_stl w_onebuf_opt.wo_stl // 'statusline'
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000286#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000287 int wo_scb;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200288#define w_p_scb w_onebuf_opt.wo_scb // 'scrollbind'
289 int wo_diff_saved; // options were saved for starting diff mode
Bram Moolenaar8a3bb562018-03-04 20:14:14 +0100290#define w_p_diff_saved w_onebuf_opt.wo_diff_saved
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200291 int wo_scb_save; // 'scrollbind' saved for diff mode
Bram Moolenaar8a3bb562018-03-04 20:14:14 +0100292#define w_p_scb_save w_onebuf_opt.wo_scb_save
Bram Moolenaar071d4272004-06-13 20:20:40 +0000293 int wo_wrap;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200294#define w_p_wrap w_onebuf_opt.wo_wrap // 'wrap'
Bram Moolenaara87aa802013-07-03 15:47:03 +0200295#ifdef FEAT_DIFF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200296 int wo_wrap_save; // 'wrap' state saved for diff mode
Bram Moolenaara87aa802013-07-03 15:47:03 +0200297# define w_p_wrap_save w_onebuf_opt.wo_wrap_save
298#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +0200299#ifdef FEAT_CONCEAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200300 char_u *wo_cocu; // 'concealcursor'
Bram Moolenaarf5963f72010-07-23 22:10:27 +0200301# define w_p_cocu w_onebuf_opt.wo_cocu
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200302 long wo_cole; // 'conceallevel'
Bram Moolenaarf5963f72010-07-23 22:10:27 +0200303# define w_p_cole w_onebuf_opt.wo_cole
Bram Moolenaar860cae12010-06-05 23:22:07 +0200304#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +0200305 int wo_crb;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200306#define w_p_crb w_onebuf_opt.wo_crb // 'cursorbind'
307 int wo_crb_save; // 'cursorbind' state saved for diff mode
Bram Moolenaar8a3bb562018-03-04 20:14:14 +0100308#define w_p_crb_save w_onebuf_opt.wo_crb_save
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200309#ifdef FEAT_SIGNS
310 char_u *wo_scl;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200311# define w_p_scl w_onebuf_opt.wo_scl // 'signcolumn'
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200312#endif
Bram Moolenaare4f25e42017-07-07 11:54:15 +0200313#ifdef FEAT_TERMINAL
Bram Moolenaare1fc5152018-04-21 19:49:08 +0200314 char_u *wo_twk;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200315# define w_p_twk w_onebuf_opt.wo_twk // 'termwinkey'
Bram Moolenaare1fc5152018-04-21 19:49:08 +0200316 char_u *wo_tws;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200317# define w_p_tws w_onebuf_opt.wo_tws // 'termwinsize'
Bram Moolenaare4f25e42017-07-07 11:54:15 +0200318#endif
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000319
320#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200321 sctx_T wo_script_ctx[WV_COUNT]; // SCTXs for window-local options
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200322# define w_p_script_ctx w_onebuf_opt.wo_script_ctx
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000323#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324} winopt_T;
325
326/*
327 * Window info stored with a buffer.
328 *
329 * Two types of info are kept for a buffer which are associated with a
330 * specific window:
331 * 1. Each window can have a different line number associated with a buffer.
332 * 2. The window-local options for a buffer work in a similar way.
333 * The window-info is kept in a list at b_wininfo. It is kept in
334 * most-recently-used order.
335 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000336struct wininfo_S
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200338 wininfo_T *wi_next; // next entry or NULL for last entry
339 wininfo_T *wi_prev; // previous entry or NULL for first entry
340 win_T *wi_win; // pointer to window that did set wi_fpos
341 pos_T wi_fpos; // last cursor position in the file
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200342 winopt_T wi_opt; // local window options
Dominique Pelle3276f582021-08-07 12:44:41 +0200343 int wi_optset; // TRUE when wi_opt has useful values
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344#ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200345 int wi_fold_manual; // copy of w_fold_manual
346 garray_T wi_folds; // clone of w_folds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000347#endif
LemonBoydb0ea7f2022-04-10 17:59:26 +0100348 int wi_changelistidx; // copy of w_changelistidx
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349};
350
351/*
352 * Info used to pass info about a fold from the fold-detection code to the
353 * code that displays the foldcolumn.
354 */
355typedef struct foldinfo
356{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200357 int fi_level; // level of the fold; when this is zero the
358 // other fields are invalid
359 int fi_lnum; // line number where fold starts
360 int fi_low_level; // lowest fold level that starts in the same
361 // line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362} foldinfo_T;
363
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200364/*
365 * Structure to store info about the Visual area.
366 */
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000367typedef struct
368{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200369 pos_T vi_start; // start pos of last VIsual
370 pos_T vi_end; // end position of last VIsual
371 int vi_mode; // VIsual_mode of last VIsual
372 colnr_T vi_curswant; // MAXCOL from w_curswant
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000373} visualinfo_T;
374
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375/*
Bram Moolenaar335437b2007-05-10 18:32:52 +0000376 * structures used for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377 */
378
Bram Moolenaarccae4672019-01-04 15:09:57 +0100379// One line saved for undo. After the NUL terminated text there might be text
380// properties, thus ul_len can be larger than STRLEN(ul_line) + 1.
381typedef struct {
382 char_u *ul_line; // text of the line
383 long ul_len; // length of the line including NUL, plus text
384 // properties
385} undoline_T;
386
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387typedef struct u_entry u_entry_T;
388typedef struct u_header u_header_T;
389struct u_entry
390{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200391 u_entry_T *ue_next; // pointer to next entry in list
392 linenr_T ue_top; // number of line above undo block
393 linenr_T ue_bot; // number of line below undo block
394 linenr_T ue_lcount; // linecount when u_save called
395 undoline_T *ue_array; // array of lines in undo block
396 long ue_size; // number of lines in ue_array
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000397#ifdef U_DEBUG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200398 int ue_magic; // magic number to check allocation
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000399#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400};
401
402struct u_header
403{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200404 // The following have a pointer and a number. The number is used when
405 // reading the undo file in u_read_undo()
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200406 union {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200407 u_header_T *ptr; // pointer to next undo header in list
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200408 long seq;
409 } uh_next;
410 union {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200411 u_header_T *ptr; // pointer to previous header in list
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200412 long seq;
413 } uh_prev;
414 union {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200415 u_header_T *ptr; // pointer to next header for alt. redo
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200416 long seq;
417 } uh_alt_next;
418 union {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200419 u_header_T *ptr; // pointer to previous header for alt. redo
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200420 long seq;
421 } uh_alt_prev;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200422 long uh_seq; // sequence number, higher == newer undo
423 int uh_walk; // used by undo_time()
424 u_entry_T *uh_entry; // pointer to first entry
425 u_entry_T *uh_getbot_entry; // pointer to where ue_bot must be set
426 pos_T uh_cursor; // cursor position before saving
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427 long uh_cursor_vcol;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200428 int uh_flags; // see below
429 pos_T uh_namedm[NMARKS]; // marks before undo/after redo
430 visualinfo_T uh_visual; // Visual areas before undo/after redo
431 time_T uh_time; // timestamp when the change was made
432 long uh_save_nr; // set when the file was saved after the
433 // changes in this block
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000434#ifdef U_DEBUG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200435 int uh_magic; // magic number to check allocation
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000436#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437};
438
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200439// values for uh_flags
440#define UH_CHANGED 0x01 // b_changed flag before undo/after redo
441#define UH_EMPTYBUF 0x02 // buffer was empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442
443/*
Bram Moolenaar335437b2007-05-10 18:32:52 +0000444 * structures used in undo.c
Bram Moolenaar071d4272004-06-13 20:20:40 +0000445 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200446#define ALIGN_LONG // longword alignment and use filler byte
Bram Moolenaar30276f22019-01-24 17:59:39 +0100447#define ALIGN_SIZE (sizeof(long))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000448
449#define ALIGN_MASK (ALIGN_SIZE - 1)
450
451typedef struct m_info minfo_T;
452
453/*
Bram Moolenaar2767c602010-05-16 13:56:06 +0200454 * structure used to link chunks in one of the free chunk lists.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455 */
456struct m_info
457{
458#ifdef ALIGN_LONG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200459 long_u m_size; // size of the chunk (including m_info)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460#else
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200461 short_u m_size; // size of the chunk (including m_info)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200463 minfo_T *m_next; // pointer to next free chunk in the list
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464};
465
466/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000467 * things used in memfile.c
468 */
469
470typedef struct block_hdr bhdr_T;
471typedef struct memfile memfile_T;
472typedef long blocknr_T;
473
474/*
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100475 * mf_hashtab_T is a chained hashtable with blocknr_T key and arbitrary
476 * structures as items. This is an intrusive data structure: we require
477 * that items begin with mf_hashitem_T which contains the key and linked
478 * list pointers. List of items in each bucket is doubly-linked.
479 */
480
481typedef struct mf_hashitem_S mf_hashitem_T;
482
483struct mf_hashitem_S
484{
485 mf_hashitem_T *mhi_next;
486 mf_hashitem_T *mhi_prev;
487 blocknr_T mhi_key;
488};
489
490#define MHT_INIT_SIZE 64
491
492typedef struct mf_hashtab_S
493{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200494 long_u mht_mask; // mask used for hash value (nr of items
495 // in array is "mht_mask" + 1)
496 long_u mht_count; // nr of items inserted into hashtable
497 mf_hashitem_T **mht_buckets; // points to mht_small_buckets or
498 //dynamically allocated array
499 mf_hashitem_T *mht_small_buckets[MHT_INIT_SIZE]; // initial buckets
500 char mht_fixed; // non-zero value forbids growth
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100501} mf_hashtab_T;
502
503/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504 * for each (previously) used block in the memfile there is one block header.
505 *
506 * The block may be linked in the used list OR in the free list.
507 * The used blocks are also kept in hash lists.
508 *
509 * The used list is a doubly linked list, most recently used block first.
510 * The blocks in the used list have a block of memory allocated.
511 * mf_used_count is the number of pages in the used list.
512 * The hash lists are used to quickly find a block in the used list.
513 * The free list is a single linked list, not sorted.
514 * The blocks in the free list have no block of memory allocated and
515 * the contents of the block in the file (if any) is irrelevant.
516 */
517
518struct block_hdr
519{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200520 mf_hashitem_T bh_hashitem; // header for hash table and key
521#define bh_bnum bh_hashitem.mhi_key // block number, part of bh_hashitem
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100522
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200523 bhdr_T *bh_next; // next block_hdr in free or used list
524 bhdr_T *bh_prev; // previous block_hdr in used list
525 char_u *bh_data; // pointer to memory (for used block)
526 int bh_page_count; // number of pages in this block
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
528#define BH_DIRTY 1
529#define BH_LOCKED 2
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200530 char bh_flags; // BH_DIRTY or BH_LOCKED
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531};
532
533/*
534 * when a block with a negative number is flushed to the file, it gets
535 * a positive number. Because the reference to the block is still the negative
536 * number, we remember the translation to the new positive number in the
537 * double linked trans lists. The structure is the same as the hash lists.
538 */
539typedef struct nr_trans NR_TRANS;
540
541struct nr_trans
542{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200543 mf_hashitem_T nt_hashitem; // header for hash table and key
544#define nt_old_bnum nt_hashitem.mhi_key // old, negative, number
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100545
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200546 blocknr_T nt_new_bnum; // new, positive, number
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547};
548
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100549
550typedef struct buffblock buffblock_T;
551typedef struct buffheader buffheader_T;
552
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553/*
554 * structure used to store one block of the stuff/redo/recording buffers
555 */
556struct buffblock
557{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200558 buffblock_T *b_next; // pointer to next buffblock
559 char_u b_str[1]; // contents (actually longer)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560};
561
562/*
563 * header used for the stuff buffer and the redo buffer
564 */
565struct buffheader
566{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200567 buffblock_T bh_first; // first (dummy) block of list
568 buffblock_T *bh_curr; // buffblock for appending
569 int bh_index; // index for reading
570 int bh_space; // space in bh_curr for appending
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571};
572
Bram Moolenaard4863aa2017-04-07 19:50:12 +0200573typedef struct
574{
575 buffheader_T sr_redobuff;
576 buffheader_T sr_old_redobuff;
577} save_redo_T;
578
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579/*
580 * used for completion on the command line
581 */
582typedef struct expand
583{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200584 char_u *xp_pattern; // start of item to expand
Bram Moolenaard6beab02019-11-10 15:07:19 +0100585 int xp_context; // type of expansion
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200586 int xp_pattern_len; // bytes in xp_pattern before cursor
Bram Moolenaar0a52df52019-08-18 22:26:31 +0200587#if defined(FEAT_EVAL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200588 char_u *xp_arg; // completion function
589 sctx_T xp_script_ctx; // SCTX for completion function
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200591 int xp_backslash; // one of the XP_BS_ values
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000592#ifndef BACKSLASH_IN_FILENAME
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200593 int xp_shell; // TRUE for a shell command, more
594 // characters need to be escaped
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000595#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200596 int xp_numfiles; // number of files found by
597 // file name completion
Bram Moolenaard6beab02019-11-10 15:07:19 +0100598 int xp_col; // cursor position in line
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200599 char_u **xp_files; // list of files
600 char_u *xp_line; // text being completed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601} expand_T;
602
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200603/*
604 * values for xp_backslash
605 */
606#define XP_BS_NONE 0 // nothing special for backslashes
607#define XP_BS_ONE 1 // uses one backslash before a space
608#define XP_BS_THREE 2 // uses three backslashes before a space
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609
610/*
Bram Moolenaar66b51422019-08-18 21:44:12 +0200611 * Variables shared between getcmdline(), redrawcmdline() and others.
612 * These need to be saved when using CTRL-R |, that's why they are in a
613 * structure.
614 */
615typedef struct
616{
Bram Moolenaar4aea03e2019-09-25 22:37:17 +0200617 char_u *cmdbuff; // pointer to command line buffer
618 int cmdbufflen; // length of cmdbuff
619 int cmdlen; // number of chars in command line
620 int cmdpos; // current cursor position
621 int cmdspos; // cursor column on screen
622 int cmdfirstc; // ':', '/', '?', '=', '>' or NUL
623 int cmdindent; // number of spaces before cmdline
624 char_u *cmdprompt; // message in front of cmdline
625 int cmdattr; // attributes for prompt
626 int overstrike; // Typing mode on the command line. Shared by
627 // getcmdline() and put_on_cmdline().
628 expand_T *xpc; // struct being used for expansion, xp_pattern
629 // may point into cmdbuff
630 int xp_context; // type of expansion
Bram Moolenaar66b51422019-08-18 21:44:12 +0200631# ifdef FEAT_EVAL
Bram Moolenaar4aea03e2019-09-25 22:37:17 +0200632 char_u *xp_arg; // user-defined expansion arg
633 int input_fn; // when TRUE Invoked for input() function
Bram Moolenaar66b51422019-08-18 21:44:12 +0200634# endif
635} cmdline_info_T;
636
637/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000638 * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
639 * This needs to be saved for recursive commands, put them in a structure for
640 * easy manipulation.
641 */
642typedef struct
643{
Bram Moolenaare1004402020-10-24 20:49:43 +0200644 int cmod_flags; // CMOD_ flags
645#define CMOD_SANDBOX 0x0001 // ":sandbox"
646#define CMOD_SILENT 0x0002 // ":silent"
647#define CMOD_ERRSILENT 0x0004 // ":silent!"
648#define CMOD_UNSILENT 0x0008 // ":unsilent"
649#define CMOD_NOAUTOCMD 0x0010 // ":noautocmd"
650#define CMOD_HIDE 0x0020 // ":hide"
651#define CMOD_BROWSE 0x0040 // ":browse" - invoke file dialog
652#define CMOD_CONFIRM 0x0080 // ":confirm" - invoke yes/no dialog
653#define CMOD_KEEPALT 0x0100 // ":keepalt"
654#define CMOD_KEEPMARKS 0x0200 // ":keepmarks"
655#define CMOD_KEEPJUMPS 0x0400 // ":keepjumps"
656#define CMOD_LOCKMARKS 0x0800 // ":lockmarks"
657#define CMOD_KEEPPATTERNS 0x1000 // ":keeppatterns"
658#define CMOD_NOSWAPFILE 0x2000 // ":noswapfile"
Bram Moolenaar39f3b142021-02-14 12:57:36 +0100659#define CMOD_VIM9CMD 0x4000 // ":vim9cmd"
Bram Moolenaar96cf4ba2021-04-24 14:15:41 +0200660#define CMOD_LEGACY 0x8000 // ":legacy"
Bram Moolenaare1004402020-10-24 20:49:43 +0200661
662 int cmod_split; // flags for win_split()
663 int cmod_tab; // > 0 when ":tab" was used
664 regmatch_T cmod_filter_regmatch; // set by :filter /pat/
665 int cmod_filter_force; // set for :filter!
Bram Moolenaar5661ed62020-10-24 17:19:16 +0200666
zeertzjqcd749632022-06-14 13:30:35 +0100667 int cmod_verbose; // 0 if not set, > 0 to set 'verbose'
668 // to cmod_verbose - 1
Bram Moolenaar5661ed62020-10-24 17:19:16 +0200669
670 // values for undo_cmdmod()
671 char_u *cmod_save_ei; // saved value of 'eventignore'
672#ifdef HAVE_SANDBOX
673 int cmod_did_sandbox; // set when "sandbox" was incremented
674#endif
675 long cmod_verbose_save; // if 'verbose' was set: value of
676 // p_verbose plus one
677 int cmod_save_msg_silent; // if non-zero: saved value of
678 // msg_silent + 1
Bram Moolenaare1004402020-10-24 20:49:43 +0200679 int cmod_save_msg_scroll; // for restoring msg_scroll
Bram Moolenaar5661ed62020-10-24 17:19:16 +0200680 int cmod_did_esilent; // incremented when emsg_silent is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681} cmdmod_T;
682
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200683#define MF_SEED_LEN 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684
685struct memfile
686{
Bram Moolenaarb58a4b92019-05-27 23:36:21 +0200687 char_u *mf_fname; // name of the file
688 char_u *mf_ffname; // idem, full path
689 int mf_fd; // file descriptor
690 int mf_flags; // flags used when opening this memfile
691 int mf_reopen; // mf_fd was closed, retry opening
692 bhdr_T *mf_free_first; // first block_hdr in free list
693 bhdr_T *mf_used_first; // mru block_hdr in used list
694 bhdr_T *mf_used_last; // lru block_hdr in used list
695 unsigned mf_used_count; // number of pages in used list
696 unsigned mf_used_count_max; // maximum number of pages in memory
697 mf_hashtab_T mf_hash; // hash lists
698 mf_hashtab_T mf_trans; // trans lists
699 blocknr_T mf_blocknr_max; // highest positive block number + 1
700 blocknr_T mf_blocknr_min; // lowest negative block number - 1
701 blocknr_T mf_neg_count; // number of negative blocks numbers
702 blocknr_T mf_infile_count; // number of pages in the file
703 unsigned mf_page_size; // number of bytes in a page
704 int mf_dirty; // TRUE if there are dirty blocks
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200705#ifdef FEAT_CRYPT
Bram Moolenaarb58a4b92019-05-27 23:36:21 +0200706 buf_T *mf_buffer; // buffer this memfile is for
707 char_u mf_seed[MF_SEED_LEN]; // seed for encryption
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200708
Bram Moolenaarb58a4b92019-05-27 23:36:21 +0200709 // Values for key, method and seed used for reading data blocks when
710 // updating for a newly set key or method. Only when mf_old_key != NULL.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200711 char_u *mf_old_key;
712 int mf_old_cm;
713 char_u mf_old_seed[MF_SEED_LEN];
714#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715};
716
717/*
718 * things used in memline.c
719 */
720/*
721 * When searching for a specific line, we remember what blocks in the tree
722 * are the branches leading to that block. This is stored in ml_stack. Each
723 * entry is a pointer to info in a block (may be data block or pointer block)
724 */
725typedef struct info_pointer
726{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200727 blocknr_T ip_bnum; // block number
728 linenr_T ip_low; // lowest lnum in this block
729 linenr_T ip_high; // highest lnum in this block
730 int ip_index; // index for block with current lnum
731} infoptr_T; // block/index pair
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732
733#ifdef FEAT_BYTEOFF
734typedef struct ml_chunksize
735{
736 int mlcs_numlines;
737 long mlcs_totalsize;
738} chunksize_T;
739
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200740/*
741 * Flags when calling ml_updatechunk()
742 */
743# define ML_CHNK_ADDLINE 1
744# define ML_CHNK_DELLINE 2
745# define ML_CHNK_UPDLINE 3
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746#endif
747
748/*
749 * the memline structure holds all the information about a memline
750 */
751typedef struct memline
752{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200753 linenr_T ml_line_count; // number of lines in the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200755 memfile_T *ml_mfp; // pointer to associated memfile
Bram Moolenaar071d4272004-06-13 20:20:40 +0000756
Bram Moolenaard6beab02019-11-10 15:07:19 +0100757 infoptr_T *ml_stack; // stack of pointer blocks (array of IPTRs)
758 int ml_stack_top; // current top of ml_stack
759 int ml_stack_size; // total number of entries in ml_stack
760
Bram Moolenaarfa4873c2022-06-30 22:13:59 +0100761#define ML_EMPTY 0x01 // empty buffer
762#define ML_LINE_DIRTY 0x02 // cached line was changed and allocated
763#define ML_LOCKED_DIRTY 0x04 // ml_locked was changed
764#define ML_LOCKED_POS 0x08 // ml_locked needs positive block number
765#define ML_ALLOCATED 0x10 // ml_line_ptr is an allocated copy
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 int ml_flags;
767
Bram Moolenaard6beab02019-11-10 15:07:19 +0100768 colnr_T ml_line_len; // length of the cached line, including NUL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200769 linenr_T ml_line_lnum; // line number of cached line, 0 if not valid
770 char_u *ml_line_ptr; // pointer to cached line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200772 bhdr_T *ml_locked; // block used by last ml_get
773 linenr_T ml_locked_low; // first line in ml_locked
774 linenr_T ml_locked_high; // last line in ml_locked
775 int ml_locked_lineadd; // number of lines inserted in ml_locked
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776#ifdef FEAT_BYTEOFF
777 chunksize_T *ml_chunksize;
778 int ml_numchunks;
779 int ml_usedchunks;
780#endif
781} memline_T;
782
Bram Moolenaara9d4b842020-05-30 14:46:52 +0200783// Values for the flags argument of ml_delete_flags().
784#define ML_DEL_MESSAGE 1 // may give a "No lines in buffer" message
785#define ML_DEL_UNDO 2 // called from undo, do not update textprops
Bram Moolenaar4cd5c522021-06-27 13:04:00 +0200786#define ML_DEL_NOPROP 4 // splitting data block, do not update textprops
Bram Moolenaara9d4b842020-05-30 14:46:52 +0200787
788// Values for the flags argument of ml_append_int().
789#define ML_APPEND_NEW 1 // starting to edit a new file
790#define ML_APPEND_MARK 2 // mark the new line
791#define ML_APPEND_UNDO 4 // called from undo
Bram Moolenaar840f91f2021-05-26 22:32:10 +0200792#define ML_APPEND_NOPROP 8 // do not continue textprop from previous line
Bram Moolenaara9d4b842020-05-30 14:46:52 +0200793
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100794
795/*
796 * Structure defining text properties. These stick with the text.
797 * When stored in memline they are after the text, ml_line_len is larger than
798 * STRLEN(ml_line_ptr) + 1.
799 */
800typedef struct textprop_S
801{
Bram Moolenaarb9c67a52019-01-01 19:49:20 +0100802 colnr_T tp_col; // start column (one based, in bytes)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100803 colnr_T tp_len; // length in bytes
804 int tp_id; // identifier
805 int tp_type; // property type
806 int tp_flags; // TP_FLAG_ values
807} textprop_T;
808
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100809#define TP_FLAG_CONT_NEXT 0x1 // property continues in next line
810#define TP_FLAG_CONT_PREV 0x2 // property was continued from prev line
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100811
812// without these text is placed after the end of the line
813#define TP_FLAG_ALIGN_RIGHT 0x10 // virtual text is right-aligned
814#define TP_FLAG_ALIGN_BELOW 0x20 // virtual text on next screen line
815
816#define TP_FLAG_WRAP 0x40 // virtual text wraps - when missing
817 // text is truncated
Bram Moolenaar398649e2022-08-04 15:03:48 +0100818#define PROP_TEXT_MIN_CELLS 4 // minimun number of cells to use for
819 // the text, even when truncating
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100820
821/*
822 * Structure defining a property type.
823 */
824typedef struct proptype_S
825{
826 int pt_id; // value used for tp_id
827 int pt_type; // number used for tp_type
828 int pt_hl_id; // highlighting
829 int pt_priority; // priority
830 int pt_flags; // PT_FLAG_ values
831 char_u pt_name[1]; // property type name, actually longer
832} proptype_T;
833
834#define PT_FLAG_INS_START_INCL 1 // insert at start included in property
835#define PT_FLAG_INS_END_INCL 2 // insert at end included in property
Bram Moolenaarde24a872019-05-05 15:48:00 +0200836#define PT_FLAG_COMBINE 4 // combine with syntax highlight
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100837
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100838// Sign group
839typedef struct signgroup_S
840{
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200841 int sg_next_sign_id; // next sign id for this group
842 short_u sg_refcount; // number of signs in this group
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200843 char_u sg_name[1]; // sign group name, actually longer
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100844} signgroup_T;
845
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200846typedef struct sign_entry sign_entry_T;
847struct sign_entry
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848{
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200849 int se_id; // unique identifier for each placed sign
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200850 int se_typenr; // typenr of sign
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200851 int se_priority; // priority for highlighting
Bram Moolenaard6beab02019-11-10 15:07:19 +0100852 linenr_T se_lnum; // line number which has this sign
853 signgroup_T *se_group; // sign group
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200854 sign_entry_T *se_next; // next entry in a list of signs
855 sign_entry_T *se_prev; // previous entry -- for easy reordering
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856};
857
Bram Moolenaar4e038572019-07-04 18:28:35 +0200858/*
859 * Sign attributes. Used by the screen refresh routines.
860 */
861typedef struct sign_attrs_S {
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200862 int sat_typenr;
863 void *sat_icon;
864 char_u *sat_text;
865 int sat_texthl;
866 int sat_linehl;
Bram Moolenaare413ea02021-11-24 16:20:13 +0000867 int sat_culhl;
James McCoya80aad72021-12-22 19:45:28 +0000868 int sat_numhl;
Bram Moolenaar39f7aa32020-08-31 22:00:05 +0200869 int sat_priority;
Bram Moolenaar4e038572019-07-04 18:28:35 +0200870} sign_attrs_T;
871
Bram Moolenaarced198d2018-12-29 20:04:40 +0100872#if defined(FEAT_SIGNS) || defined(PROTO)
873// Macros to get the sign group structure from the group name
874#define SGN_KEY_OFF offsetof(signgroup_T, sg_name)
875#define HI2SG(hi) ((signgroup_T *)((hi)->hi_key - SGN_KEY_OFF))
876
Bram Moolenaar162b7142018-12-21 15:17:36 +0100877// Default sign priority for highlighting
878#define SIGN_DEF_PRIO 10
879
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880#endif
881
882/*
883 * Argument list: Array of file names.
884 * Used for the global argument list and the argument lists local to a window.
885 */
886typedef struct arglist
887{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200888 garray_T al_ga; // growarray with the array of file names
889 int al_refcount; // number of windows using this arglist
890 int id; // id of this arglist
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891} alist_T;
892
893/*
894 * For each argument remember the file name as it was given, and the buffer
895 * number that contains the expanded file name (required for when ":cd" is
Bram Moolenaard6beab02019-11-10 15:07:19 +0100896 * used).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 */
898typedef struct argentry
899{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200900 char_u *ae_fname; // file name as specified
901 int ae_fnum; // buffer number with expanded file name
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902} aentry_T;
903
Bram Moolenaar4033c552017-09-16 20:54:51 +0200904#define ALIST(win) (win)->w_alist
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905#define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data)
906#define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data)
907#define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data)
908#define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data))
909#define GARGCOUNT (global_alist.al_ga.ga_len)
910#define ARGCOUNT (ALIST(curwin)->al_ga.ga_len)
911#define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len)
912
913/*
914 * A list used for saving values of "emsg_silent". Used by ex_try() to save the
915 * value of "emsg_silent" if it was non-zero. When this is done, the CSF_SILENT
916 * flag below is set.
917 */
918
919typedef struct eslist_elem eslist_T;
920struct eslist_elem
921{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200922 int saved_emsg_silent; // saved value of "emsg_silent"
923 eslist_T *next; // next element on the list
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924};
925
926/*
927 * For conditional commands a stack is kept of nested conditionals.
928 * When cs_idx < 0, there is no conditional command.
929 */
930#define CSTACK_LEN 50
931
Bram Moolenaarddef1292019-12-16 17:10:33 +0100932typedef struct {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200933 short cs_flags[CSTACK_LEN]; // CSF_ flags
934 char cs_pending[CSTACK_LEN]; // CSTP_: what's pending in ":finally"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 union {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200936 void *csp_rv[CSTACK_LEN]; // return typeval for pending return
937 void *csp_ex[CSTACK_LEN]; // exception for pending throw
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 } cs_pend;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200939 void *cs_forinfo[CSTACK_LEN]; // info used by ":for"
940 int cs_line[CSTACK_LEN]; // line nr of ":while"/":for" line
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200941 int cs_block_id[CSTACK_LEN]; // block ID stack
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200942 int cs_script_var_len[CSTACK_LEN]; // value of sn_var_vals.ga_len
943 // when entering the block
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200944 int cs_idx; // current entry, or -1 if none
945 int cs_looplevel; // nr of nested ":while"s and ":for"s
946 int cs_trylevel; // nr of nested ":try"s
947 eslist_T *cs_emsg_silent_list; // saved values of "emsg_silent"
948 char cs_lflags; // loop flags: CSL_ flags
Bram Moolenaarddef1292019-12-16 17:10:33 +0100949} cstack_T;
Bram Moolenaar12805862005-01-05 22:16:17 +0000950# define cs_rettv cs_pend.csp_rv
951# define cs_exception cs_pend.csp_ex
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200953// There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
954// was used.
955# define CSF_TRUE 0x0001 // condition was TRUE
956# define CSF_ACTIVE 0x0002 // current state is active
957# define CSF_ELSE 0x0004 // ":else" has been passed
958# define CSF_WHILE 0x0008 // is a ":while"
959# define CSF_FOR 0x0010 // is a ":for"
Bram Moolenaar9becdf22020-10-10 21:33:48 +0200960# define CSF_BLOCK 0x0020 // is a "{" block
Bram Moolenaar12805862005-01-05 22:16:17 +0000961
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200962# define CSF_TRY 0x0100 // is a ":try"
963# define CSF_FINALLY 0x0200 // ":finally" has been passed
Bram Moolenaar41978282021-07-04 14:47:30 +0200964# define CSF_CATCH 0x0400 // ":catch" has been seen
965# define CSF_THROWN 0x0800 // exception thrown to this try conditional
966# define CSF_CAUGHT 0x1000 // exception caught by this try conditional
Bram Moolenaarf67d3fb2021-10-05 11:22:27 +0100967# define CSF_FINISHED 0x2000 // CSF_CAUGHT was handled by finish_exception()
968# define CSF_SILENT 0x4000 // "emsg_silent" reset by ":try"
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200969// Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
970// (an ":if"), and CSF_SILENT is only used when CSF_TRY is set.
Bram Moolenaarf67d3fb2021-10-05 11:22:27 +0100971
972# define CSF_FUNC_DEF 0x8000 // a function was defined in this block
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973
974/*
975 * What's pending for being reactivated at the ":endtry" of this try
976 * conditional:
977 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200978# define CSTP_NONE 0 // nothing pending in ":finally" clause
979# define CSTP_ERROR 1 // an error is pending
980# define CSTP_INTERRUPT 2 // an interrupt is pending
981# define CSTP_THROW 4 // a throw is pending
982# define CSTP_BREAK 8 // ":break" is pending
983# define CSTP_CONTINUE 16 // ":continue" is pending
984# define CSTP_RETURN 24 // ":return" is pending
985# define CSTP_FINISH 32 // ":finish" is pending
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986
987/*
Bram Moolenaarddef1292019-12-16 17:10:33 +0100988 * Flags for the cs_lflags item in cstack_T.
Bram Moolenaar12805862005-01-05 22:16:17 +0000989 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200990# define CSL_HAD_LOOP 1 // just found ":while" or ":for"
991# define CSL_HAD_ENDLOOP 2 // just found ":endwhile" or ":endfor"
992# define CSL_HAD_CONT 4 // just found ":continue"
993# define CSL_HAD_FINA 8 // just found ":finally"
Bram Moolenaar12805862005-01-05 22:16:17 +0000994
995/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 * A list of error messages that can be converted to an exception. "throw_msg"
997 * is only set in the first element of the list. Usually, it points to the
998 * original message stored in that element, but sometimes it points to a later
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200999 * message in the list. See cause_errthrow().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 */
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001001typedef struct msglist msglist_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001002struct msglist
1003{
Bram Moolenaare8c46602021-04-05 22:27:37 +02001004 msglist_T *next; // next of several messages in a row
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001005 char *msg; // original message, allocated
1006 char *throw_msg; // msg to throw: usually original one
1007 char_u *sfile; // value from estack_sfile(), allocated
1008 long slnum; // line number for "sfile"
Bram Moolenaare8c46602021-04-05 22:27:37 +02001009 int msg_compiling; // saved value of estack_compiling
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010};
1011
1012/*
Bram Moolenaar8a5883b2016-11-10 20:20:05 +01001013 * The exception types.
1014 */
1015typedef enum
1016{
Bram Moolenaarea3ece42018-04-17 20:14:39 +02001017 ET_USER, // exception caused by ":throw" command
1018 ET_ERROR, // error exception
1019 ET_INTERRUPT, // interrupt exception triggered by Ctrl-C
Bram Moolenaar8a5883b2016-11-10 20:20:05 +01001020} except_type_T;
1021
1022/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 * Structure describing an exception.
1024 * (don't use "struct exception", it's used by the math library).
1025 */
1026typedef struct vim_exception except_T;
1027struct vim_exception
1028{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001029 except_type_T type; // exception type
1030 char *value; // exception value
1031 struct msglist *messages; // message(s) causing error exception
1032 char_u *throw_name; // name of the throw point
1033 linenr_T throw_lnum; // line number of the throw point
1034 except_T *caught; // next exception on the caught stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035};
1036
1037/*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001038 * Structure to save the error/interrupt/exception state between calls to
1039 * enter_cleanup() and leave_cleanup(). Must be allocated as an automatic
1040 * variable by the (common) caller of these functions.
1041 */
1042typedef struct cleanup_stuff cleanup_T;
1043struct cleanup_stuff
1044{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001045 int pending; // error/interrupt/exception state
1046 except_T *exception; // exception value
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001047};
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048
1049#ifdef FEAT_SYN_HL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001050// struct passed to in_id_list()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051struct sp_syn
1052{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001053 int inc_tag; // ":syn include" unique tag
1054 short id; // highlight group ID of item
1055 short *cont_in_list; // cont.in group IDs, if non-zero
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056};
1057
1058/*
1059 * Each keyword has one keyentry, which is linked in a hash list.
1060 */
1061typedef struct keyentry keyentry_T;
1062
1063struct keyentry
1064{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001065 keyentry_T *ke_next; // next entry with identical "keyword[]"
1066 struct sp_syn k_syn; // struct passed to in_id_list()
1067 short *next_list; // ID list for next match (if non-zero)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001068 int flags;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001069 int k_char; // conceal substitute character
1070 char_u keyword[1]; // actually longer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071};
1072
1073/*
1074 * Struct used to store one state of the state stack.
1075 */
1076typedef struct buf_state
1077{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001078 int bs_idx; // index of pattern
1079 int bs_flags; // flags for pattern
Bram Moolenaar6e202e52010-07-28 18:14:45 +02001080#ifdef FEAT_CONCEAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001081 int bs_seqnr; // stores si_seqnr
1082 int bs_cchar; // stores si_cchar
Bram Moolenaar6e202e52010-07-28 18:14:45 +02001083#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001084 reg_extmatch_T *bs_extmatch; // external matches from start pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085} bufstate_T;
1086
1087/*
1088 * syn_state contains the syntax state stack for the start of one line.
1089 * Used by b_sst_array[].
1090 */
1091typedef struct syn_state synstate_T;
1092
1093struct syn_state
1094{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001095 synstate_T *sst_next; // next entry in used or free list
1096 linenr_T sst_lnum; // line number for this state
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097 union
1098 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001099 bufstate_T sst_stack[SST_FIX_STATES]; // short state stack
1100 garray_T sst_ga; // growarray for long state stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 } sst_union;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001102 int sst_next_flags; // flags for sst_next_list
1103 int sst_stacksize; // number of states on the stack
1104 short *sst_next_list; // "nextgroup" list in this state
1105 // (this is a copy, don't free it!
1106 disptick_T sst_tick; // tick when last displayed
1107 linenr_T sst_change_lnum;// when non-zero, change in this line
1108 // may have made the state invalid
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109};
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001110#endif // FEAT_SYN_HL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111
Bram Moolenaarf9cc9f22019-07-14 21:29:22 +02001112#define MAX_HL_ID 20000 // maximum value for a highlight ID.
1113
1114/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 * Structure shared between syntax.c, screen.c and gui_x11.c.
1116 */
1117typedef struct attr_entry
1118{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001119 short ae_attr; // HL_BOLD, etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120 union
1121 {
1122 struct
1123 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001124 char_u *start; // start escape sequence
1125 char_u *stop; // stop escape sequence
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126 } term;
1127 struct
1128 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001129 // These colors need to be > 8 bits to hold 256.
1130 short_u fg_color; // foreground color number
1131 short_u bg_color; // background color number
Bram Moolenaare023e882020-05-31 16:42:30 +02001132 short_u ul_color; // underline color number
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001133# ifdef FEAT_TERMGUICOLORS
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001134 guicolor_T fg_rgb; // foreground color RGB
1135 guicolor_T bg_rgb; // background color RGB
Bram Moolenaare023e882020-05-31 16:42:30 +02001136 guicolor_T ul_rgb; // underline color RGB
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001137# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 } cterm;
1139# ifdef FEAT_GUI
1140 struct
1141 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001142 guicolor_T fg_color; // foreground color handle
1143 guicolor_T bg_color; // background color handle
1144 guicolor_T sp_color; // special color handle
1145 GuiFont font; // font handle
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146# ifdef FEAT_XFONTSET
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001147 GuiFontset fontset; // fontset handle
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148# endif
1149 } gui;
1150# endif
1151 } ae_u;
1152} attrentry_T;
1153
1154#ifdef USE_ICONV
1155# ifdef HAVE_ICONV_H
1156# include <iconv.h>
1157# else
1158# if defined(MACOS_X)
1159# include <sys/errno.h>
Bram Moolenaard0573012017-10-28 21:11:06 +02001160# ifndef EILSEQ
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001161# define EILSEQ ENOENT // Early MacOS X does not have EILSEQ
Bram Moolenaard0573012017-10-28 21:11:06 +02001162# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163typedef struct _iconv_t *iconv_t;
1164# else
Bram Moolenaard0573012017-10-28 21:11:06 +02001165# include <errno.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001166# endif
1167typedef void *iconv_t;
1168# endif
1169#endif
1170
1171/*
1172 * Used for the typeahead buffer: typebuf.
1173 */
1174typedef struct
1175{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001176 char_u *tb_buf; // buffer for typed characters
1177 char_u *tb_noremap; // mapping flags for characters in tb_buf[]
1178 int tb_buflen; // size of tb_buf[]
1179 int tb_off; // current position in tb_buf[]
1180 int tb_len; // number of valid bytes in tb_buf[]
1181 int tb_maplen; // nr of mapped bytes in tb_buf[]
1182 int tb_silent; // nr of silently mapped bytes in tb_buf[]
1183 int tb_no_abbr_cnt; // nr of bytes without abbrev. in tb_buf[]
1184 int tb_change_cnt; // nr of time tb_buf was changed; never zero
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185} typebuf_T;
1186
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001187// Struct to hold the saved typeahead for save_typeahead().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188typedef struct
1189{
1190 typebuf_T save_typebuf;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001191 int typebuf_valid; // TRUE when save_typebuf valid
Bram Moolenaar13df0fe2009-07-09 16:24:19 +00001192 int old_char;
1193 int old_mod_mask;
Bram Moolenaar0a36fec2014-02-11 15:10:43 +01001194 buffheader_T save_readbuf1;
1195 buffheader_T save_readbuf2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196#ifdef USE_INPUT_BUF
1197 char_u *save_inputbuf;
1198#endif
1199} tasave_T;
1200
1201/*
1202 * Used for conversion of terminal I/O and script files.
1203 */
1204typedef struct
1205{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001206 int vc_type; // zero or one of the CONV_ values
1207 int vc_factor; // max. expansion factor
Bram Moolenaar4f974752019-02-17 17:44:42 +01001208# ifdef MSWIN
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001209 int vc_cpfrom; // codepage to convert from (CONV_CODEPAGE)
1210 int vc_cpto; // codepage to convert to (CONV_CODEPAGE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211# endif
1212# ifdef USE_ICONV
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001213 iconv_t vc_fd; // for CONV_ICONV
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214# endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001215 int vc_fail; // fail for invalid char, don't use '?'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216} vimconv_T;
1217
1218/*
Bram Moolenaar5f32ece2019-07-21 21:51:59 +02001219 * Structure used for the command line history.
1220 */
1221typedef struct hist_entry
1222{
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02001223 int hisnum; // identifying number
1224 int viminfo; // when TRUE hisstr comes from viminfo
1225 char_u *hisstr; // actual entry, separator char after the NUL
1226 time_t time_set; // when it was typed, zero if unknown
Bram Moolenaar5f32ece2019-07-21 21:51:59 +02001227} histentry_T;
1228
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229#define CONV_NONE 0
1230#define CONV_TO_UTF8 1
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001231#define CONV_9_TO_UTF8 2
1232#define CONV_TO_LATIN1 3
1233#define CONV_TO_LATIN9 4
1234#define CONV_ICONV 5
Bram Moolenaar4f974752019-02-17 17:44:42 +01001235#ifdef MSWIN
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001236# define CONV_CODEPAGE 10 // codepage -> codepage
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237#endif
1238#ifdef MACOS_X
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001239# define CONV_MAC_LATIN1 20
1240# define CONV_LATIN1_MAC 21
1241# define CONV_MAC_UTF8 22
1242# define CONV_UTF8_MAC 23
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243#endif
1244
1245/*
1246 * Structure used for mappings and abbreviations.
1247 */
1248typedef struct mapblock mapblock_T;
1249struct mapblock
1250{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001251 mapblock_T *m_next; // next mapblock in list
1252 char_u *m_keys; // mapped from, lhs
1253 char_u *m_str; // mapped to, rhs
1254 char_u *m_orig_str; // rhs as entered by the user
1255 int m_keylen; // strlen(m_keys)
1256 int m_mode; // valid mode
Bram Moolenaar459fd782019-10-13 16:43:39 +02001257 int m_simplified; // m_keys was simplified, do not use this map
1258 // if seenModifyOtherKeys is TRUE
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001259 int m_noremap; // if non-zero no re-mapping for m_str
1260 char m_silent; // <silent> used, don't echo commands
1261 char m_nowait; // <nowait> used
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001262#ifdef FEAT_EVAL
Bram Moolenaar9b8d6222020-12-28 18:26:00 +01001263 char m_expr; // <expr> used, m_str is an expression
Dominique Pelle3276f582021-08-07 12:44:41 +02001264 sctx_T m_script_ctx; // SCTX where map was defined
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265#endif
1266};
1267
Bram Moolenaar8133cc62020-10-26 21:05:27 +01001268
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269/*
1270 * Used for highlighting in the status line.
1271 */
Bram Moolenaar8133cc62020-10-26 21:05:27 +01001272typedef struct
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273{
1274 char_u *start;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001275 int userhl; // 0: no HL, 1-9: User HL, < 0 for syn ID
Bram Moolenaar8133cc62020-10-26 21:05:27 +01001276} stl_hlrec_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277
Bram Moolenaar860cae12010-06-05 23:22:07 +02001278
1279/*
1280 * Syntax items - usually buffer-specific.
1281 */
1282
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001283/*
1284 * Item for a hashtable. "hi_key" can be one of three values:
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001285 * NULL: Never been used
1286 * HI_KEY_REMOVED: Entry was removed
1287 * Otherwise: Used item, pointer to the actual key; this usually is
1288 * inside the item, subtract an offset to locate the item.
1289 * This reduces the size of hashitem by 1/3.
1290 */
1291typedef struct hashitem_S
1292{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001293 long_u hi_hash; // cached hash number of hi_key
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001294 char_u *hi_key;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001295} hashitem_T;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001296
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001297// The address of "hash_removed" is used as a magic number for hi_key to
1298// indicate a removed item.
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001299#define HI_KEY_REMOVED &hash_removed
1300#define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
1301
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001302// Initial size for a hashtable. Our items are relatively small and growing
1303// is expensive, thus use 16 as a start. Must be a power of 2.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001304// This allows for storing 10 items (2/3 of 16) before a resize is needed.
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001305#define HT_INIT_SIZE 16
1306
1307typedef struct hashtable_S
1308{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001309 long_u ht_mask; // mask used for hash value (nr of items in
1310 // array is "ht_mask" + 1)
1311 long_u ht_used; // number of items used
1312 long_u ht_filled; // number of items used + removed
Bram Moolenaar49fe0d62020-07-14 15:47:23 +02001313 int ht_changed; // incremented when adding or removing an item
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001314 int ht_locked; // counter for hash_lock()
1315 int ht_error; // when set growing failed, can't add more
1316 // items before growing works
1317 hashitem_T *ht_array; // points to the array, allocated when it's
1318 // not "ht_smallarray"
1319 hashitem_T ht_smallarray[HT_INIT_SIZE]; // initial array
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001320} hashtab_T;
1321
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001322typedef long_u hash_T; // Type for hi_hash
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001323
1324
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001325// Use 64-bit Number.
Bram Moolenaar82f654e2020-02-17 22:12:50 +01001326#ifdef MSWIN
1327# ifdef PROTO
Bram Moolenaarf9706e92020-02-22 14:27:04 +01001328 // workaround for cproto that doesn't recognize __int64
1329 typedef long varnumber_T;
1330 typedef unsigned long uvarnumber_T;
1331# define VARNUM_MIN LONG_MIN
1332# define VARNUM_MAX LONG_MAX
1333# define UVARNUM_MAX ULONG_MAX
Bram Moolenaar82f654e2020-02-17 22:12:50 +01001334# else
Bram Moolenaarf9706e92020-02-22 14:27:04 +01001335 typedef __int64 varnumber_T;
1336 typedef unsigned __int64 uvarnumber_T;
1337# define VARNUM_MIN _I64_MIN
1338# define VARNUM_MAX _I64_MAX
1339# define UVARNUM_MAX _UI64_MAX
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001340# endif
Bram Moolenaarf9706e92020-02-22 14:27:04 +01001341#elif defined(HAVE_NO_LONG_LONG)
1342# if defined(HAVE_STDINT_H)
1343 typedef int64_t varnumber_T;
1344 typedef uint64_t uvarnumber_T;
1345# define VARNUM_MIN INT64_MIN
1346# define VARNUM_MAX INT64_MAX
1347# define UVARNUM_MAX UINT64_MAX
1348# else
1349 // this may cause trouble for code that depends on 64 bit ints
1350 typedef long varnumber_T;
1351 typedef unsigned long uvarnumber_T;
1352# define VARNUM_MIN LONG_MIN
1353# define VARNUM_MAX LONG_MAX
1354# define UVARNUM_MAX ULONG_MAX
1355# endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001356#else
Bram Moolenaarf9706e92020-02-22 14:27:04 +01001357 typedef long long varnumber_T;
1358 typedef unsigned long long uvarnumber_T;
Bram Moolenaarc593bec2020-02-25 21:26:49 +01001359# ifdef LLONG_MIN
1360# define VARNUM_MIN LLONG_MIN
1361# define VARNUM_MAX LLONG_MAX
1362# define UVARNUM_MAX ULLONG_MAX
1363# else
1364# define VARNUM_MIN LONG_LONG_MIN
1365# define VARNUM_MAX LONG_LONG_MAX
1366# define UVARNUM_MAX ULONG_LONG_MAX
1367# endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001368#endif
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001369
Bram Moolenaara65c2882020-04-08 11:31:48 +02001370// On rare systems "char" is unsigned, sometimes we really want a signed 8-bit
1371// value.
1372typedef signed char int8_T;
1373
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001374typedef double float_T;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001375
1376typedef struct listvar_S list_T;
1377typedef struct dictvar_S dict_T;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001378typedef struct partial_S partial_T;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01001379typedef struct blobvar_S blob_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001380
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001381// Struct that holds both a normal function name and a partial_T, as used for a
1382// callback argument.
1383// When used temporarily "cb_name" is not allocated. The refcounts to either
1384// the function or the partial are incremented and need to be decremented
1385// later with free_callback().
1386typedef struct {
1387 char_u *cb_name;
1388 partial_T *cb_partial;
1389 int cb_free_name; // cb_name was allocated
1390} callback_T;
1391
Bram Moolenaar20431c92020-03-20 18:39:46 +01001392typedef struct isn_S isn_T; // instruction
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001393typedef struct dfunc_S dfunc_T; // :def function
1394
Bram Moolenaar835dc632016-02-07 14:27:38 +01001395typedef struct jobvar_S job_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001396typedef struct readq_S readq_T;
Bram Moolenaar97bd5e62017-08-18 20:50:30 +02001397typedef struct writeq_S writeq_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001398typedef struct jsonq_S jsonq_T;
1399typedef struct cbq_S cbq_T;
1400typedef struct channel_S channel_T;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001401typedef struct cctx_S cctx_T;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001402typedef struct ectx_S ectx_T;
Bram Moolenaarf18332f2021-05-07 17:55:55 +02001403typedef struct instr_S instr_T;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001404
Bram Moolenaara03f2332016-02-06 18:09:59 +01001405typedef enum
1406{
Bram Moolenaar4c683752020-04-05 21:38:23 +02001407 VAR_UNKNOWN = 0, // not set, any type or "void" allowed
1408 VAR_ANY, // used for "any" type
1409 VAR_VOID, // no value (function not returning anything)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001410 VAR_BOOL, // "v_number" is used: VVAL_TRUE or VVAL_FALSE
1411 VAR_SPECIAL, // "v_number" is used: VVAL_NULL or VVAL_NONE
1412 VAR_NUMBER, // "v_number" is used
1413 VAR_FLOAT, // "v_float" is used
1414 VAR_STRING, // "v_string" is used
1415 VAR_BLOB, // "v_blob" is used
1416 VAR_FUNC, // "v_string" is function name
1417 VAR_PARTIAL, // "v_partial" is used
1418 VAR_LIST, // "v_list" is used
1419 VAR_DICT, // "v_dict" is used
1420 VAR_JOB, // "v_job" is used
1421 VAR_CHANNEL, // "v_channel" is used
Bram Moolenaarf18332f2021-05-07 17:55:55 +02001422 VAR_INSTR, // "v_instr" is used
Bram Moolenaara03f2332016-02-06 18:09:59 +01001423} vartype_T;
1424
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001425// A type specification.
1426typedef struct type_S type_T;
1427struct type_S {
1428 vartype_T tt_type;
Bram Moolenaar1378fbc2020-04-11 20:50:33 +02001429 int8_T tt_argcount; // for func, incl. vararg, -1 for unknown
James McCoy2e258bd2021-10-05 19:44:04 +01001430 int8_T tt_min_argcount; // number of non-optional arguments
1431 char_u tt_flags; // TTFLAG_ values
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001432 type_T *tt_member; // for list, dict, func return type
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02001433 type_T **tt_args; // func argument types, allocated
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001434};
1435
Bram Moolenaar078a4612022-01-04 15:17:03 +00001436typedef struct {
1437 type_T *type_curr; // current type, value type
1438 type_T *type_decl; // declared type or equal to type_current
1439} type2_T;
1440
Bram Moolenaard77a8522020-04-03 21:59:57 +02001441#define TTFLAG_VARARGS 1 // func args ends with "..."
1442#define TTFLAG_OPTARG 2 // func arg type with "?"
Bram Moolenaar29a86ff2020-09-09 14:55:31 +02001443#define TTFLAG_BOOL_OK 4 // can be converted to bool
Bram Moolenaarfb489af2020-09-16 15:41:09 +02001444#define TTFLAG_STATIC 8 // one of the static types, e.g. t_any
Bram Moolenaard77a8522020-04-03 21:59:57 +02001445
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001446/*
1447 * Structure to hold an internal variable without a name.
1448 */
1449typedef struct
1450{
Bram Moolenaara03f2332016-02-06 18:09:59 +01001451 vartype_T v_type;
Bram Moolenaar2bb26582020-10-03 22:52:39 +02001452 char v_lock; // see below: VAR_LOCKED, VAR_FIXED
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001453 union
1454 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001455 varnumber_T v_number; // number value
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001456#ifdef FEAT_FLOAT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001457 float_T v_float; // floating number value
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001458#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001459 char_u *v_string; // string value (can be NULL!)
1460 list_T *v_list; // list value (can be NULL!)
1461 dict_T *v_dict; // dict value (can be NULL!)
1462 partial_T *v_partial; // closure: function with args
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01001463#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001464 job_T *v_job; // job value (can be NULL!)
1465 channel_T *v_channel; // channel value (can be NULL!)
Bram Moolenaar77073442016-02-13 23:23:53 +01001466#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001467 blob_T *v_blob; // blob value (can be NULL!)
Bram Moolenaarf18332f2021-05-07 17:55:55 +02001468 instr_T *v_instr; // instructions to execute
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001469 } vval;
1470} typval_T;
1471
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001472// Values for "dv_scope".
1473#define VAR_SCOPE 1 // a:, v:, s:, etc. scope dictionaries
1474#define VAR_DEF_SCOPE 2 // l:, g: scope dictionaries: here funcrefs are not
1475 // allowed to mask existing functions
Bram Moolenaarbdb62052012-07-16 17:31:53 +02001476
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001477// Values for "v_lock".
Bram Moolenaar70c43d82022-01-26 21:01:15 +00001478#define VAR_LOCKED 1 // locked with lock(), can use unlock()
1479#define VAR_FIXED 2 // locked forever
1480#define VAR_ITEMS_LOCKED 4 // items of non-materialized list locked
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001481
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001482/*
1483 * Structure to hold an item of a list: an internal variable without a name.
1484 */
1485typedef struct listitem_S listitem_T;
1486
1487struct listitem_S
1488{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001489 listitem_T *li_next; // next item in list
1490 listitem_T *li_prev; // previous item in list
1491 typval_T li_tv; // type and value of the variable
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001492};
1493
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001494// Struct used by those that are using an item in a list.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001495typedef struct listwatch_S listwatch_T;
1496
1497struct listwatch_S
1498{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001499 listitem_T *lw_item; // item being watched
1500 listwatch_T *lw_next; // next watcher
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001501};
1502
1503/*
1504 * Structure to hold info about a list.
Bram Moolenaar1a840242018-03-08 21:46:43 +01001505 * Order of members is optimized to reduce padding.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001506 * When created by range() it will at first have special value:
1507 * lv_first == &range_list_item;
1508 * and use lv_start, lv_end, lv_stride.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001509 */
1510struct listvar_S
1511{
Bram Moolenaar70c43d82022-01-26 21:01:15 +00001512 listitem_T *lv_first; // first item, NULL if none, &range_list_item
1513 // for a non-materialized list
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001514 listwatch_T *lv_watch; // first watcher, NULL if none
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001515 union {
1516 struct { // used for non-materialized range list:
1517 // "lv_first" is &range_list_item
1518 varnumber_T lv_start;
1519 varnumber_T lv_end;
1520 int lv_stride;
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01001521 } nonmat;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001522 struct { // used for materialized list
1523 listitem_T *lv_last; // last item, NULL if none
1524 listitem_T *lv_idx_item; // when not NULL item at index "lv_idx"
1525 int lv_idx; // cached index of an item
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01001526 } mat;
1527 } lv_u;
Bram Moolenaar078a4612022-01-04 15:17:03 +00001528 type_T *lv_type; // current type, allocated by alloc_type()
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001529 list_T *lv_copylist; // copied list used by deepcopy()
1530 list_T *lv_used_next; // next list in used lists list
1531 list_T *lv_used_prev; // previous list in used lists list
1532 int lv_refcount; // reference count
1533 int lv_len; // number of items
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001534 int lv_with_items; // number of items following this struct that
1535 // should not be freed
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001536 int lv_copyID; // ID used by deepcopy()
1537 char lv_lock; // zero, VAR_LOCKED, VAR_FIXED
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001538};
1539
1540/*
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001541 * Static list with 10 items. Use init_static_list() to initialize.
1542 */
1543typedef struct {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001544 list_T sl_list; // must be first
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001545 listitem_T sl_items[10];
1546} staticList10_T;
1547
1548/*
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001549 * Structure to hold an item of a Dictionary.
1550 * Also used for a variable.
1551 * The key is copied into "di_key" to avoid an extra alloc/free for it.
1552 */
1553struct dictitem_S
1554{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001555 typval_T di_tv; // type and value of the variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001556 char_u di_flags; // DI_FLAGS_ flags (only used for variable)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001557 char_u di_key[1]; // key (actually longer!)
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001558};
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001559typedef struct dictitem_S dictitem_T;
1560
Bram Moolenaard7c96872019-06-15 17:12:48 +02001561/*
1562 * A dictitem with a 16 character key (plus NUL). This is an efficient way to
1563 * have a fixed-size dictitem.
1564 */
1565#define DICTITEM16_KEY_LEN 16
Bram Moolenaarbee6c0c2016-03-25 15:40:50 +01001566struct dictitem16_S
1567{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001568 typval_T di_tv; // type and value of the variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001569 char_u di_flags; // DI_FLAGS_ flags (only used for variable)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001570 char_u di_key[DICTITEM16_KEY_LEN + 1]; // key
Bram Moolenaarbee6c0c2016-03-25 15:40:50 +01001571};
1572typedef struct dictitem16_S dictitem16_T;
1573
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001574// Flags for "di_flags"
1575#define DI_FLAGS_RO 0x01 // read-only variable
1576#define DI_FLAGS_RO_SBX 0x02 // read-only in the sandbox
1577#define DI_FLAGS_FIX 0x04 // fixed: no :unlet or remove()
1578#define DI_FLAGS_LOCK 0x08 // locked variable
1579#define DI_FLAGS_ALLOC 0x10 // separately allocated
1580#define DI_FLAGS_RELOAD 0x20 // set when script sourced again
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001581
1582/*
1583 * Structure to hold info about a Dictionary.
1584 */
1585struct dictvar_S
1586{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001587 char dv_lock; // zero, VAR_LOCKED, VAR_FIXED
1588 char dv_scope; // zero, VAR_SCOPE, VAR_DEF_SCOPE
1589 int dv_refcount; // reference count
1590 int dv_copyID; // ID used by deepcopy()
1591 hashtab_T dv_hashtab; // hashtab that refers to the items
Bram Moolenaar078a4612022-01-04 15:17:03 +00001592 type_T *dv_type; // current type, allocated by alloc_type()
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001593 dict_T *dv_copydict; // copied dict used by deepcopy()
1594 dict_T *dv_used_next; // next dict in used dicts list
1595 dict_T *dv_used_prev; // previous dict in used dicts list
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001596};
1597
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01001598/*
1599 * Structure to hold info about a blob.
1600 */
1601struct blobvar_S
1602{
1603 garray_T bv_ga; // growarray with the data
1604 int bv_refcount; // reference count
1605 char bv_lock; // zero, VAR_LOCKED, VAR_FIXED
1606};
1607
Bram Moolenaar801ab062020-06-25 19:27:56 +02001608typedef int (*cfunc_T)(int argcount, typval_T *argvars, typval_T *rettv, void *state);
1609typedef void (*cfunc_free_T)(void *state);
1610
Bram Moolenaar20b23c62020-08-20 15:25:00 +02001611// type of getline() last argument
1612typedef enum {
1613 GETLINE_NONE, // do not concatenate any lines
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01001614 GETLINE_CONCAT_CONT, // concatenate continuation lines with backslash
1615 GETLINE_CONCAT_CONTBAR, // concatenate continuation lines with \ and |
Bram Moolenaar20b23c62020-08-20 15:25:00 +02001616 GETLINE_CONCAT_ALL // concatenate continuation and Vim9 # comment lines
1617} getline_opt_T;
1618
Bram Moolenaar9b8d6222020-12-28 18:26:00 +01001619typedef struct svar_S svar_T;
1620
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001621#if defined(FEAT_EVAL) || defined(PROTO)
1622typedef struct funccall_S funccall_T;
1623
Bram Moolenaarb2049902021-01-24 12:53:53 +01001624// values used for "uf_def_status"
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001625typedef enum {
Bram Moolenaar701cc6c2021-04-10 13:33:48 +02001626 UF_NOT_COMPILED, // executed with interpreter
1627 UF_TO_BE_COMPILED, // to be compiled before execution
1628 UF_COMPILING, // in compile_def_function()
1629 UF_COMPILED, // successfully compiled
1630 UF_COMPILE_ERROR // compilation error, cannot execute
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001631} def_status_T;
Bram Moolenaar822ba242020-05-24 23:00:18 +02001632
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001633/*
1634 * Structure to hold info for a user function.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001635 * When adding a field check copy_func().
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001636 */
1637typedef struct
1638{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001639 int uf_varargs; // variable nr of arguments (old style)
1640 int uf_flags; // FC_ flags
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001641 int uf_calls; // nr of active calls
1642 int uf_cleared; // func_clear() was already called
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001643 def_status_T uf_def_status; // UF_NOT_COMPILED, UF_TO_BE_COMPILED, etc.
1644 int uf_dfunc_idx; // only valid if uf_def_status is UF_COMPILED
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02001645 garray_T uf_args; // arguments, including optional arguments
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001646 garray_T uf_def_args; // default argument expressions
Bram Moolenaare28d9b32021-07-03 18:56:53 +02001647 int uf_args_visible; // normally uf_args.ga_len, less when
1648 // compiling default argument expression.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001649
1650 // for :def (for :function uf_ret_type is NULL)
1651 type_T **uf_arg_types; // argument types (count == uf_args.ga_len)
1652 type_T *uf_ret_type; // return type
1653 garray_T uf_type_list; // types used in arg and return types
Bram Moolenaarf112f302020-12-20 17:47:52 +01001654 partial_T *uf_partial; // for closure created inside :def function:
1655 // information about the context
1656
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001657 char_u *uf_va_name; // name from "...name" or NULL
1658 type_T *uf_va_type; // type from "...name: type" or NULL
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02001659 type_T *uf_func_type; // type of the function, &t_func_any if unknown
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001660 int uf_block_depth; // nr of entries in uf_block_ids
1661 int *uf_block_ids; // blocks a :def function is defined inside
Bram Moolenaar801ab062020-06-25 19:27:56 +02001662# if defined(FEAT_LUA)
1663 cfunc_T uf_cb; // callback function for cfunc
1664 cfunc_free_T uf_cb_free; // callback function to free cfunc
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01001665 void *uf_cb_state; // state of uf_cb
Bram Moolenaar801ab062020-06-25 19:27:56 +02001666# endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001667
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001668 garray_T uf_lines; // function lines
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02001669
1670 int uf_debug_tick; // when last checked for a breakpoint in this
1671 // function.
1672 int uf_has_breakpoint; // TRUE when a breakpoint has been set in
1673 // this function.
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001674# ifdef FEAT_PROFILE
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001675 int uf_profiling; // TRUE when func is being profiled
Bram Moolenaarad648092018-06-30 18:28:03 +02001676 int uf_prof_initialized;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001677 // profiling the function as a whole
1678 int uf_tm_count; // nr of calls
1679 proftime_T uf_tm_total; // time spent in function + children
1680 proftime_T uf_tm_self; // time spent in function itself
1681 proftime_T uf_tm_children; // time spent in children this call
1682 // profiling the function per line
1683 int *uf_tml_count; // nr of times line was executed
1684 proftime_T *uf_tml_total; // time spent in a line + children
1685 proftime_T *uf_tml_self; // time spent in a line itself
1686 proftime_T uf_tml_start; // start time for current line
1687 proftime_T uf_tml_children; // time spent in children for this line
1688 proftime_T uf_tml_wait; // start wait time for current line
1689 int uf_tml_idx; // index of line being timed; -1 if none
1690 int uf_tml_execed; // line being timed was executed
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001691# endif
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001692 sctx_T uf_script_ctx; // SCTX where function was defined,
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02001693 // used for s: variables; sc_version changed
1694 // for :function
1695 int uf_script_ctx_version; // original sc_version of SCTX
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001696 int uf_refcount; // reference count, see func_name_refcount()
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02001697
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001698 funccall_T *uf_scoped; // l: local variables for closure
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02001699
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001700 char_u *uf_name_exp; // if "uf_name[]" starts with SNR the name with
1701 // "<SNR>" as a string, otherwise NULL
Bram Moolenaar6a12e332021-01-31 14:46:00 +01001702 char_u uf_name[4]; // name of function (actual size equals name);
1703 // can start with <SNR>123_ (<SNR> is K_SPECIAL
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001704 // KS_EXTRA KE_SNR)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001705} ufunc_T;
1706
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02001707// flags used in uf_flags
1708#define FC_ABORT 0x01 // abort function on error
1709#define FC_RANGE 0x02 // function accepts range
1710#define FC_DICT 0x04 // Dict function, uses "self"
1711#define FC_CLOSURE 0x08 // closure, uses outer scope variables
1712#define FC_DELETED 0x10 // :delfunction used while uf_refcount > 0
1713#define FC_REMOVED 0x20 // function redefined while uf_refcount > 0
1714#define FC_SANDBOX 0x40 // function defined in the sandbox
1715#define FC_DEAD 0x80 // function kept only for reference to dfunc
1716#define FC_EXPORT 0x100 // "export def Func()"
1717#define FC_NOARGS 0x200 // no a: variables in lambda
1718#define FC_VIM9 0x400 // defined in vim9 script file
Bram Moolenaar801ab062020-06-25 19:27:56 +02001719#define FC_CFUNC 0x800 // defined as Lua C func
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001720#define FC_COPY 0x1000 // copy of another function by copy_func()
Bram Moolenaar38453522021-11-28 22:00:12 +00001721#define FC_LAMBDA 0x2000 // one line "return {expr}"
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02001722
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001723#define MAX_FUNC_ARGS 20 // maximum number of function arguments
1724#define VAR_SHORT_LEN 20 // short variable name length
1725#define FIXVAR_CNT 12 // number of fixed variables
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001726
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001727/*
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001728 * Structure to hold info for a function that is currently being executed.
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001729 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001730struct funccall_S
1731{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001732 ufunc_T *func; // function being called
1733 int linenr; // next line to be executed
1734 int returned; // ":return" used
1735 struct // fixed variables for arguments
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001736 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001737 dictitem_T var; // variable (without room for name)
1738 char_u room[VAR_SHORT_LEN]; // room for the name
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001739 } fixvar[FIXVAR_CNT];
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001740 dict_T l_vars; // l: local function variables
1741 dictitem_T l_vars_var; // variable for l: scope
1742 dict_T l_avars; // a: argument variables
1743 dictitem_T l_avars_var; // variable for a: scope
1744 list_T l_varlist; // list for a:000
1745 listitem_T l_listitems[MAX_FUNC_ARGS]; // listitems for a:000
1746 typval_T *rettv; // return value
1747 linenr_T breakpoint; // next line with breakpoint or zero
1748 int dbg_tick; // debug_tick when breakpoint was set
1749 int level; // top nesting level of executed function
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001750#ifdef FEAT_PROFILE
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001751 proftime_T prof_child; // time spent in a child
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001752#endif
Bram Moolenaar22286892020-11-05 20:50:51 +01001753 funccall_T *caller; // calling function or NULL; or next funccal in
1754 // list pointed to by previous_funccal.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001755
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001756 // for closure
1757 int fc_refcount; // number of user functions that reference this
1758 // funccal
1759 int fc_copyID; // for garbage collection
1760 garray_T fc_funcs; // list of ufunc_T* which keep a reference to
1761 // "func"
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001762};
1763
1764/*
1765 * Struct used by trans_function_name()
1766 */
1767typedef struct
1768{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001769 dict_T *fd_dict; // Dictionary used
1770 char_u *fd_newkey; // new key in "dict" in allocated memory
1771 dictitem_T *fd_di; // Dictionary item used
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001772} funcdict_T;
1773
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001774typedef struct funccal_entry funccal_entry_T;
1775struct funccal_entry {
1776 void *top_funccal;
1777 funccal_entry_T *next;
1778};
1779
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001780// From user function to hashitem and back.
Bram Moolenaar660a10a2019-07-14 15:48:38 +02001781#define UF2HIKEY(fp) ((fp)->uf_name)
1782#define HIKEY2UF(p) ((ufunc_T *)((p) - offsetof(ufunc_T, uf_name)))
1783#define HI2UF(hi) HIKEY2UF((hi)->hi_key)
1784
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001785/*
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001786 * Holds the hashtab with variables local to each sourced script.
1787 * Each item holds a variable (nameless) that points to the dict_T.
1788 */
Bram Moolenaar8d739de2020-10-14 19:39:19 +02001789typedef struct {
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001790 dictitem_T sv_var;
1791 dict_T sv_dict;
1792} scriptvar_T;
1793
1794/*
Bram Moolenaar8d739de2020-10-14 19:39:19 +02001795 * Entry for "sn_all_vars". Contains the s: variables from sn_vars plus the
1796 * block-local ones.
1797 */
1798typedef struct sallvar_S sallvar_T;
1799struct sallvar_S {
1800 sallvar_T *sav_next; // var with same name but different block
1801 int sav_block_id; // block ID where declared
1802 int sav_var_vals_idx; // index in sn_var_vals
1803
1804 // So long as the variable is valid (block it was defined in is still
1805 // active) "sav_di" is used. It is set to NULL when leaving the block,
1806 // then sav_tv and sav_flags are used.
1807 dictitem_T *sav_di; // dictitem with di_key and di_tv
1808 typval_T sav_tv; // type and value of the variable
1809 char_u sav_flags; // DI_FLAGS_ flags (only used for variable)
1810 char_u sav_key[1]; // key (actually longer!)
1811};
1812
1813/*
1814 * In the sn_all_vars hashtab item "hi_key" points to "sav_key" in a sallvar_T.
1815 * This makes it possible to store and find the sallvar_T.
1816 * SAV2HIKEY() converts a sallvar_T pointer to a hashitem key pointer.
1817 * HIKEY2SAV() converts a hashitem key pointer to a sallvar_T pointer.
1818 * HI2SAV() converts a hashitem pointer to a sallvar_T pointer.
1819 */
1820#define SAV2HIKEY(sav) ((sav)->sav_key)
1821#define HIKEY2SAV(p) ((sallvar_T *)(p - offsetof(sallvar_T, sav_key)))
1822#define HI2SAV(hi) HIKEY2SAV((hi)->hi_key)
1823
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01001824#define SVFLAG_TYPE_ALLOCATED 1 // call free_type() for "sv_type"
1825#define SVFLAG_EXPORTED 2 // "export let var = val"
1826#define SVFLAG_ASSIGNED 4 // assigned a value
1827
Bram Moolenaar8d739de2020-10-14 19:39:19 +02001828/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001829 * Entry for "sn_var_vals". Used for script-local variables.
1830 */
Bram Moolenaar9b8d6222020-12-28 18:26:00 +01001831struct svar_S {
Bram Moolenaar8d739de2020-10-14 19:39:19 +02001832 char_u *sv_name; // points into "sn_all_vars" di_key
1833 typval_T *sv_tv; // points into "sn_vars" or "sn_all_vars" di_tv
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001834 type_T *sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01001835 int sv_flags; // SVFLAG_ values above
Bram Moolenaar08251752021-01-11 21:20:18 +01001836 int sv_const; // 0, ASSIGN_CONST or ASSIGN_FINAL
Bram Moolenaar9b8d6222020-12-28 18:26:00 +01001837};
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001838
1839typedef struct {
1840 char_u *imp_name; // name imported as (allocated)
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001841 scid_T imp_sid; // script ID of "from"
Bram Moolenaara6294952020-12-27 13:39:50 +01001842 int imp_flags; // IMP_FLAGS_ values
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001843} imported_T;
1844
Bram Moolenaara6294952020-12-27 13:39:50 +01001845#define IMP_FLAGS_RELOAD 2 // script reloaded, OK to redefine
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001846#define IMP_FLAGS_AUTOLOAD 4 // script still needs to be loaded
Bram Moolenaara6294952020-12-27 13:39:50 +01001847
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001848/*
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01001849 * Info about an already sourced scripts.
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001850 */
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001851typedef struct
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001852{
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001853 char_u *sn_name; // full path of script file
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01001854 int sn_script_seq; // latest sctx_T sc_seq value
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001855
Bram Moolenaar8d739de2020-10-14 19:39:19 +02001856 // "sn_vars" stores the s: variables currently valid. When leaving a block
1857 // variables local to that block are removed.
1858 scriptvar_T *sn_vars;
1859
1860 // Specific for a Vim9 script.
1861 // "sn_all_vars" stores all script variables ever declared. So long as the
1862 // variable is still valid the value is in "sn_vars->sv_dict...di_tv".
1863 // When the block of a declaration is left the value is moved to
1864 // "sn_all_vars..sav_tv".
1865 // Variables with duplicate names are possible, the sav_block_id must be
1866 // used to check that which variable is valid.
1867 dict_T sn_all_vars; // all script variables, dict of sallvar_T
1868
1869 // Stores the same variables as in "sn_all_vars" as a list of svar_T, so
1870 // that they can be quickly found by index instead of a hash table lookup.
1871 // Also stores the type.
1872 garray_T sn_var_vals;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001873
1874 garray_T sn_imports; // imported items, imported_T
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001875 garray_T sn_type_list; // keeps types used by variables
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001876 int sn_current_block_id; // ID for current block, 0 for outer
1877 int sn_last_block_id; // Unique ID for each script block
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001878
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001879 int sn_version; // :scriptversion
Bram Moolenaar2b327002020-12-26 15:39:31 +01001880 int sn_state; // SN_STATE_ values
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001881 char_u *sn_save_cpo; // 'cpo' value when :vim9script found
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00001882 char sn_is_vimrc; // .vimrc file, do not restore 'cpo'
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00001883
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001884 // for a Vim9 script under "rtp/autoload/" this is "dir#scriptname#"
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00001885 char_u *sn_autoload_prefix;
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001886
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001887 // TRUE for a script used with "import autoload './dirname/script.vim'"
Bram Moolenaarccbfd482022-03-31 16:18:23 +01001888 // For "../autoload/script.vim" sn_autoload_prefix is also set.
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001889 int sn_import_autoload;
1890
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001891# ifdef FEAT_PROFILE
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02001892 int sn_prof_on; // TRUE when script is/was profiled
1893 int sn_pr_force; // forceit: profile functions in this script
1894 proftime_T sn_pr_child; // time set when going into first child
1895 int sn_pr_nest; // nesting for sn_pr_child
1896 // profiling the script as a whole
1897 int sn_pr_count; // nr of times sourced
1898 proftime_T sn_pr_total; // time spent in script + children
1899 proftime_T sn_pr_self; // time spent in script itself
1900 proftime_T sn_pr_start; // time at script start
1901 proftime_T sn_pr_children; // time in children after script start
1902 // profiling the script per line
1903 garray_T sn_prl_ga; // things stored for every line
1904 proftime_T sn_prl_start; // start time for current line
1905 proftime_T sn_prl_children; // time spent in children for this line
1906 proftime_T sn_prl_wait; // wait start time for current line
1907 int sn_prl_idx; // index of line being timed; -1 if none
1908 int sn_prl_execed; // line being timed was executed
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001909# endif
1910} scriptitem_T;
1911
Bram Moolenaar2b327002020-12-26 15:39:31 +01001912#define SN_STATE_NEW 0 // newly loaded script, nothing done
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001913#define SN_STATE_NOT_LOADED 1 // script located but not loaded
1914#define SN_STATE_RELOAD 2 // script loaded before, nothing done
Bram Moolenaar2b327002020-12-26 15:39:31 +01001915#define SN_STATE_HAD_COMMAND 9 // a command was executed
1916
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001917// Struct passed through eval() functions.
1918// See EVALARG_EVALUATE for a fixed value with eval_flags set to EVAL_EVALUATE.
1919typedef struct {
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001920 int eval_flags; // EVAL_ flag values below
1921 int eval_break_count; // nr of line breaks consumed
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001922
1923 // copied from exarg_T when "getline" is "getsourceline". Can be NULL.
Bram Moolenaar66250c92020-08-20 15:02:42 +02001924 char_u *(*eval_getline)(int, void *, int, getline_opt_T);
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001925 void *eval_cookie; // argument for eval_getline()
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001926
Bram Moolenaar7a4b8982020-07-08 17:36:21 +02001927 // used when compiling a :def function, NULL otherwise
1928 cctx_T *eval_cctx;
1929
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001930 // used when executing commands from a script, NULL otherwise
1931 cstack_T *eval_cstack;
1932
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001933 // Used to collect lines while parsing them, so that they can be
1934 // concatenated later. Used when "eval_ga.ga_itemsize" is not zero.
1935 // "eval_ga.ga_data" is a list of pointers to lines.
Bram Moolenaarecb66452021-05-18 15:09:18 +02001936 // "eval_freega" list pointers that need to be freed after concatenating.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001937 garray_T eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001938 garray_T eval_freega;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001939
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001940 // pointer to the last line obtained with getsourceline()
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001941 char_u *eval_tofree;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001942
Bram Moolenaar844fb642021-10-23 13:32:30 +01001943 // array with lines of an inline function
1944 garray_T eval_tofree_ga;
1945
1946 // set when "arg" points into the last entry of "eval_tofree_ga"
1947 int eval_using_cmdline;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001948
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001949 // pointer to the lines concatenated for a lambda.
1950 char_u *eval_tofree_lambda;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001951} evalarg_T;
1952
1953// Flags for expression evaluation.
1954#define EVAL_EVALUATE 1 // when missing don't actually evaluate
1955#define EVAL_CONSTANT 2 // when not a constant return FAIL
1956
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001957# ifdef FEAT_PROFILE
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001958/*
1959 * Struct used in sn_prl_ga for every line of a script.
1960 */
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001961typedef struct sn_prl_S
1962{
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02001963 int snp_count; // nr of times line was executed
1964 proftime_T sn_prl_total; // time spent in a line + children
1965 proftime_T sn_prl_self; // time spent in a line itself
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001966} sn_prl_T;
1967
1968# define PRL_ITEM(si, idx) (((sn_prl_T *)(si)->sn_prl_ga.ga_data)[(idx)])
Bram Moolenaarb2049902021-01-24 12:53:53 +01001969
1970typedef struct {
1971 int pi_started_profiling;
1972 proftime_T pi_wait_start;
1973 proftime_T pi_call_start;
1974} profinfo_T;
1975
Bram Moolenaarf002a412021-01-24 13:34:18 +01001976# else
1977typedef struct
1978{
1979 int dummy;
1980} profinfo_T;
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001981# endif
Bram Moolenaaracadbea2016-08-01 16:35:59 +02001982#else
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001983// dummy typedefs for use in function prototypes
Bram Moolenaaracadbea2016-08-01 16:35:59 +02001984typedef struct
1985{
1986 int dummy;
1987} ufunc_T;
1988typedef struct
1989{
1990 int dummy;
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001991} funccall_T;
1992typedef struct
1993{
1994 int dummy;
Bram Moolenaaracadbea2016-08-01 16:35:59 +02001995} funcdict_T;
Bram Moolenaard95c3c22018-10-14 22:38:09 +02001996typedef struct
1997{
1998 int dummy;
1999} funccal_entry_T;
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002000typedef struct
2001{
2002 int dummy;
2003} scriptitem_T;
Bram Moolenaar9d40c632020-06-24 19:05:29 +02002004typedef struct
2005{
2006 int dummy;
2007} evalarg_T;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002008#endif
2009
Bram Moolenaar505e43a2019-08-03 18:28:17 +02002010// Struct passed between functions dealing with function call execution.
2011//
2012// "argv_func", when not NULL, can be used to fill in arguments only when the
2013// invoked function uses them. It is called like this:
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002014// new_argcount = argv_func(current_argcount, argv, partial_argcount,
2015// called_func_argcount)
Bram Moolenaar505e43a2019-08-03 18:28:17 +02002016//
2017typedef struct {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002018 int (* fe_argv_func)(int, typval_T *, int, int);
2019 linenr_T fe_firstline; // first line of range
2020 linenr_T fe_lastline; // last line of range
2021 int *fe_doesrange; // if not NULL: return: function handled range
2022 int fe_evaluate; // actually evaluate expressions
2023 partial_T *fe_partial; // for extra arguments
2024 dict_T *fe_selfdict; // Dictionary for "self"
2025 typval_T *fe_basetv; // base for base->method()
2026 type_T *fe_check_type; // type from funcref or NULL
Bram Moolenaar2ef91562021-12-11 16:14:07 +00002027 int fe_found_var; // if the function is not found then give an
2028 // error that a variable is not callable.
Bram Moolenaar505e43a2019-08-03 18:28:17 +02002029} funcexe_T;
2030
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002031/*
2032 * Structure to hold the context of a compiled function, used by closures
2033 * defined in that function.
2034 */
Bram Moolenaar7509ad82021-12-14 18:14:37 +00002035typedef struct funcstack_S funcstack_T;
2036
2037struct funcstack_S
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002038{
Bram Moolenaar7509ad82021-12-14 18:14:37 +00002039 funcstack_T *fs_next; // linked list at "first_funcstack"
2040 funcstack_T *fs_prev;
2041
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002042 garray_T fs_ga; // contains the stack, with:
2043 // - arguments
2044 // - frame
2045 // - local variables
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +02002046 int fs_var_offset; // count of arguments + frame size == offset to
2047 // local variables
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002048
2049 int fs_refcount; // nr of closures referencing this funcstack
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +02002050 int fs_min_refcount; // nr of closures on this funcstack
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002051 int fs_copyID; // for garray_T collection
Bram Moolenaar7509ad82021-12-14 18:14:37 +00002052};
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002053
Bram Moolenaar0186e582021-01-10 18:33:11 +01002054typedef struct outer_S outer_T;
2055struct outer_S {
2056 garray_T *out_stack; // stack from outer scope
2057 int out_frame_idx; // index of stack frame in out_stack
2058 outer_T *out_up; // outer scope of outer scope or NULL
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02002059 partial_T *out_up_partial; // partial owning out_up or NULL
Bram Moolenaar0186e582021-01-10 18:33:11 +01002060};
2061
Bram Moolenaar1735bc92016-03-14 23:05:14 +01002062struct partial_S
2063{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002064 int pt_refcount; // reference count
Dominique Pelle3276f582021-08-07 12:44:41 +02002065 int pt_auto; // when TRUE the partial was created for using
2066 // dict.member in handle_subscript()
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002067 char_u *pt_name; // function name; when NULL use
2068 // pt_func->uf_name
2069 ufunc_T *pt_func; // function pointer; when NULL lookup function
2070 // with pt_name
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002071
Bram Moolenaar0186e582021-01-10 18:33:11 +01002072 // For a compiled closure: the arguments and local variables scope
2073 outer_T pt_outer;
2074
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +00002075 // For a partial of a partial: use pt_outer values of this partial.
2076 partial_T *pt_outer_partial;
2077
Bram Moolenaar0186e582021-01-10 18:33:11 +01002078 funcstack_T *pt_funcstack; // copy of stack, used after context
2079 // function returns
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002080
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002081 typval_T *pt_argv; // arguments in allocated array
Dominique Pelle3276f582021-08-07 12:44:41 +02002082 int pt_argc; // number of arguments
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002083
Bram Moolenaarb68b3462020-05-06 21:06:30 +02002084 int pt_copyID; // funcstack may contain pointer to partial
Dominique Pelle3276f582021-08-07 12:44:41 +02002085 dict_T *pt_dict; // dict for "self"
Bram Moolenaar1735bc92016-03-14 23:05:14 +01002086};
2087
LemonBoyeca7c602022-04-14 15:39:43 +01002088typedef struct AutoPatCmd_S AutoPatCmd_T;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002089
2090/*
2091 * Entry in the execution stack "exestack".
2092 */
2093typedef enum {
2094 ETYPE_TOP, // toplevel
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002095 ETYPE_SCRIPT, // sourcing script, use es_info.sctx
2096 ETYPE_UFUNC, // user function, use es_info.ufunc
2097 ETYPE_AUCMD, // autocomand, use es_info.aucmd
2098 ETYPE_MODELINE, // modeline, use es_info.sctx
2099 ETYPE_EXCEPT, // exception, use es_info.exception
2100 ETYPE_ARGS, // command line argument
2101 ETYPE_ENV, // environment variable
2102 ETYPE_INTERNAL, // internal operation
2103 ETYPE_SPELL, // loading spell file
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002104} etype_T;
2105
2106typedef struct {
2107 long es_lnum; // replaces "sourcing_lnum"
2108 char_u *es_name; // replaces "sourcing_name"
2109 etype_T es_type;
2110 union {
2111 sctx_T *sctx; // script and modeline info
2112#if defined(FEAT_EVAL)
2113 ufunc_T *ufunc; // function info
2114#endif
LemonBoyeca7c602022-04-14 15:39:43 +01002115 AutoPatCmd_T *aucmd; // autocommand info
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002116 except_T *except; // exception info
2117 } es_info;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002118#if defined(FEAT_EVAL)
Bram Moolenaarc70fe462021-04-17 17:59:19 +02002119 sctx_T es_save_sctx; // saved current_sctx when calling function
Bram Moolenaarc620c052020-07-08 15:16:19 +02002120#endif
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002121} estack_T;
2122
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002123// Information returned by get_tty_info().
Bram Moolenaar6b93b0e2017-08-13 20:28:53 +02002124typedef struct {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002125 int backspace; // what the Backspace key produces
2126 int enter; // what the Enter key produces
2127 int interrupt; // interrupt character
2128 int nl_does_cr; // TRUE when a NL is expanded to CR-NL on output
Bram Moolenaar6b93b0e2017-08-13 20:28:53 +02002129} ttyinfo_T;
2130
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002131// Status of a job. Order matters!
Bram Moolenaar835dc632016-02-07 14:27:38 +01002132typedef enum
2133{
2134 JOB_FAILED,
2135 JOB_STARTED,
Bram Moolenaarea3ece42018-04-17 20:14:39 +02002136 JOB_ENDED, // detected job done
2137 JOB_FINISHED, // job done and cleanup done
Bram Moolenaar835dc632016-02-07 14:27:38 +01002138} jobstatus_T;
2139
2140/*
2141 * Structure to hold info about a Job.
2142 */
2143struct jobvar_S
2144{
Bram Moolenaar65edff82016-02-21 16:40:11 +01002145 job_T *jv_next;
2146 job_T *jv_prev;
Bram Moolenaar835dc632016-02-07 14:27:38 +01002147#ifdef UNIX
2148 pid_t jv_pid;
Bram Moolenaar835dc632016-02-07 14:27:38 +01002149#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01002150#ifdef MSWIN
Bram Moolenaar76467df2016-02-12 19:30:26 +01002151 PROCESS_INFORMATION jv_proc_info;
Bram Moolenaar14207f42016-10-27 21:13:10 +02002152 HANDLE jv_job_object;
Bram Moolenaar835dc632016-02-07 14:27:38 +01002153#endif
Dominique Pelle3276f582021-08-07 12:44:41 +02002154 jobstatus_T jv_status;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002155 char_u *jv_tty_in; // controlling tty input, allocated
2156 char_u *jv_tty_out; // controlling tty output, allocated
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002157 char_u *jv_stoponexit; // allocated
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01002158#ifdef UNIX
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002159 char_u *jv_termsig; // allocated
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01002160#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01002161#ifdef MSWIN
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01002162 char_u *jv_tty_type; // allocated
2163#endif
Bram Moolenaareab089d2016-02-21 19:32:02 +01002164 int jv_exitval;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002165 callback_T jv_exit_cb;
Bram Moolenaar835dc632016-02-07 14:27:38 +01002166
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002167 buf_T *jv_in_buf; // buffer from "in-name"
Bram Moolenaar014069a2016-03-03 22:51:40 +01002168
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002169 int jv_refcount; // reference count
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02002170 int jv_copyID;
2171
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002172 channel_T *jv_channel; // channel for I/O, reference counted
2173 char **jv_argv; // command line used to start the job
Bram Moolenaar835dc632016-02-07 14:27:38 +01002174};
2175
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002176/*
2177 * Structures to hold info about a Channel.
2178 */
2179struct readq_S
2180{
Bram Moolenaar77073442016-02-13 23:23:53 +01002181 char_u *rq_buffer;
Bram Moolenaar9ed96ef2016-06-04 17:17:11 +02002182 long_u rq_buflen;
Bram Moolenaar77073442016-02-13 23:23:53 +01002183 readq_T *rq_next;
2184 readq_T *rq_prev;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002185};
2186
Bram Moolenaar97bd5e62017-08-18 20:50:30 +02002187struct writeq_S
2188{
2189 garray_T wq_ga;
2190 writeq_T *wq_next;
2191 writeq_T *wq_prev;
2192};
2193
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002194struct jsonq_S
2195{
Bram Moolenaar77073442016-02-13 23:23:53 +01002196 typval_T *jq_value;
2197 jsonq_T *jq_next;
2198 jsonq_T *jq_prev;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002199 int jq_no_callback; // TRUE when no callback was found
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002200};
2201
2202struct cbq_S
2203{
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002204 callback_T cq_callback;
Bram Moolenaar77073442016-02-13 23:23:53 +01002205 int cq_seq_nr;
2206 cbq_T *cq_next;
2207 cbq_T *cq_prev;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002208};
2209
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002210// mode for a channel
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002211typedef enum
2212{
Bram Moolenaarac4174e2022-05-07 16:38:24 +01002213 CH_MODE_NL = 0,
2214 CH_MODE_RAW,
2215 CH_MODE_JSON,
2216 CH_MODE_JS,
2217 CH_MODE_LSP // Language Server Protocol (http + json)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002218} ch_mode_T;
2219
Bram Moolenaar580984e2016-03-20 21:17:13 +01002220typedef enum {
Bram Moolenaarea3ece42018-04-17 20:14:39 +02002221 JIO_PIPE, // default
Bram Moolenaar580984e2016-03-20 21:17:13 +01002222 JIO_NULL,
2223 JIO_FILE,
2224 JIO_BUFFER,
2225 JIO_OUT
2226} job_io_T;
2227
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02002228#define CH_PART_FD(part) ch_part[part].ch_fd
2229
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002230// Ordering matters, it is used in for loops: IN is last, only SOCK/OUT/ERR
2231// are polled.
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02002232typedef enum {
2233 PART_SOCK = 0,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02002234#define CH_SOCK_FD CH_PART_FD(PART_SOCK)
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01002235#ifdef FEAT_JOB_CHANNEL
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02002236 PART_OUT,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02002237# define CH_OUT_FD CH_PART_FD(PART_OUT)
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02002238 PART_ERR,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02002239# define CH_ERR_FD CH_PART_FD(PART_ERR)
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02002240 PART_IN,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02002241# define CH_IN_FD CH_PART_FD(PART_IN)
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01002242#endif
Bram Moolenaarea3ece42018-04-17 20:14:39 +02002243 PART_COUNT,
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02002244} ch_part_T;
2245
2246#define INVALID_FD (-1)
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01002247
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002248// The per-fd info for a channel.
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01002249typedef struct {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002250 sock_T ch_fd; // socket/stdin/stdout/stderr, -1 if not used
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01002251
2252# if defined(UNIX) && !defined(HAVE_SELECT)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002253 int ch_poll_idx; // used by channel_poll_setup()
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01002254# endif
2255
2256#ifdef FEAT_GUI_X11
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002257 XtInputId ch_inputHandler; // Cookie for input
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01002258#endif
2259#ifdef FEAT_GUI_GTK
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002260 gint ch_inputHandler; // Cookie for input
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01002261#endif
Bram Moolenaar42d38a22016-02-20 18:18:59 +01002262
2263 ch_mode_T ch_mode;
Bram Moolenaar580984e2016-03-20 21:17:13 +01002264 job_io_T ch_io;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002265 int ch_timeout; // request timeout in msec
Bram Moolenaar42d38a22016-02-20 18:18:59 +01002266
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002267 readq_T ch_head; // header for circular raw read queue
2268 jsonq_T ch_json_head; // header for circular json read queue
2269 garray_T ch_block_ids; // list of IDs that channel_read_json_block()
2270 // is waiting for
2271 // When ch_wait_len is non-zero use ch_deadline to wait for incomplete
2272 // message to be complete. The value is the length of the incomplete
2273 // message when the deadline was set. If it gets longer (something was
2274 // received) the deadline is reset.
Bram Moolenaar88989cc2017-02-06 21:56:09 +01002275 size_t ch_wait_len;
Bram Moolenaar4f974752019-02-17 17:44:42 +01002276#ifdef MSWIN
Bram Moolenaarba61ac02016-03-20 16:40:37 +01002277 DWORD ch_deadline;
2278#else
2279 struct timeval ch_deadline;
2280#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002281 int ch_block_write; // for testing: 0 when not used, -1 when write
2282 // does not block, 1 simulate blocking
2283 int ch_nonblocking; // write() is non-blocking
2284 writeq_T ch_writeque; // header for write queue
Bram Moolenaar42d38a22016-02-20 18:18:59 +01002285
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002286 cbq_T ch_cb_head; // dummy node for per-request callbacks
2287 callback_T ch_callback; // call when a msg is not handled
Bram Moolenaar014069a2016-03-03 22:51:40 +01002288
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002289 bufref_T ch_bufref; // buffer to read from or write to
2290 int ch_nomodifiable; // TRUE when buffer can be 'nomodifiable'
2291 int ch_nomod_error; // TRUE when e_modifiable was given
2292 int ch_buf_append; // write appended lines instead top-bot
2293 linenr_T ch_buf_top; // next line to send
2294 linenr_T ch_buf_bot; // last line to send
Bram Moolenaar42d38a22016-02-20 18:18:59 +01002295} chanpart_T;
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01002296
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002297struct channel_S {
Bram Moolenaar77073442016-02-13 23:23:53 +01002298 channel_T *ch_next;
2299 channel_T *ch_prev;
2300
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002301 int ch_id; // ID of the channel
2302 int ch_last_msg_id; // ID of the last message
Bram Moolenaar77073442016-02-13 23:23:53 +01002303
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002304 chanpart_T ch_part[PART_COUNT]; // info for socket, out, err and in
2305 int ch_write_text_mode; // write buffer lines with CR, not NL
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002306
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002307 char *ch_hostname; // only for socket, allocated
2308 int ch_port; // only for socket
Bram Moolenaar580984e2016-03-20 21:17:13 +01002309
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002310 int ch_to_be_closed; // bitset of readable fds to be closed.
2311 // When all readable fds have been closed,
2312 // set to (1 << PART_COUNT).
2313 int ch_to_be_freed; // When TRUE channel must be freed when it's
2314 // safe to invoke callbacks.
2315 int ch_error; // When TRUE an error was reported. Avoids
2316 // giving pages full of error messages when
2317 // the other side has exited, only mention the
2318 // first error until the connection works
2319 // again.
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01002320
Bram Moolenaar4e221c92016-02-23 13:20:22 +01002321 void (*ch_nb_close_cb)(void);
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002322 // callback for Netbeans when channel is
2323 // closed
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002324
Bram Moolenaar4f974752019-02-17 17:44:42 +01002325#ifdef MSWIN
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002326 int ch_named_pipe; // using named pipe instead of pty
Bram Moolenaar2dc9d262017-09-08 14:39:30 +02002327#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002328 callback_T ch_callback; // call when any msg is not handled
2329 callback_T ch_close_cb; // call when channel is closed
Bram Moolenaar958dc692016-12-01 15:34:12 +01002330 int ch_drop_never;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002331 int ch_keep_open; // do not close on read error
Bram Moolenaar0b146882018-09-06 16:27:24 +02002332 int ch_nonblock;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002333
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01002334 job_T *ch_job; // Job that uses this channel; this does not
2335 // count as a reference to avoid a circular
2336 // reference, the job refers to the channel.
2337 int ch_job_killed; // TRUE when there was a job and it was killed
2338 // or we know it died.
2339 int ch_anonymous_pipe; // ConPTY
2340 int ch_killing; // TerminateJobObject() was called
Bram Moolenaar77073442016-02-13 23:23:53 +01002341
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01002342 int ch_refcount; // reference count
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02002343 int ch_copyID;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002344};
2345
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002346#define JO_MODE 0x0001 // channel mode
2347#define JO_IN_MODE 0x0002 // stdin mode
2348#define JO_OUT_MODE 0x0004 // stdout mode
2349#define JO_ERR_MODE 0x0008 // stderr mode
2350#define JO_CALLBACK 0x0010 // channel callback
2351#define JO_OUT_CALLBACK 0x0020 // stdout callback
2352#define JO_ERR_CALLBACK 0x0040 // stderr callback
2353#define JO_CLOSE_CALLBACK 0x0080 // "close_cb"
2354#define JO_WAITTIME 0x0100 // only for ch_open()
2355#define JO_TIMEOUT 0x0200 // all timeouts
2356#define JO_OUT_TIMEOUT 0x0400 // stdout timeouts
2357#define JO_ERR_TIMEOUT 0x0800 // stderr timeouts
2358#define JO_PART 0x1000 // "part"
2359#define JO_ID 0x2000 // "id"
2360#define JO_STOPONEXIT 0x4000 // "stoponexit"
2361#define JO_EXIT_CB 0x8000 // "exit_cb"
2362#define JO_OUT_IO 0x10000 // "out_io"
2363#define JO_ERR_IO 0x20000 // "err_io" (JO_OUT_IO << 1)
2364#define JO_IN_IO 0x40000 // "in_io" (JO_OUT_IO << 2)
2365#define JO_OUT_NAME 0x80000 // "out_name"
2366#define JO_ERR_NAME 0x100000 // "err_name" (JO_OUT_NAME << 1)
2367#define JO_IN_NAME 0x200000 // "in_name" (JO_OUT_NAME << 2)
2368#define JO_IN_TOP 0x400000 // "in_top"
2369#define JO_IN_BOT 0x800000 // "in_bot"
2370#define JO_OUT_BUF 0x1000000 // "out_buf"
2371#define JO_ERR_BUF 0x2000000 // "err_buf" (JO_OUT_BUF << 1)
2372#define JO_IN_BUF 0x4000000 // "in_buf" (JO_OUT_BUF << 2)
2373#define JO_CHANNEL 0x8000000 // "channel"
2374#define JO_BLOCK_WRITE 0x10000000 // "block_write"
2375#define JO_OUT_MODIFIABLE 0x20000000 // "out_modifiable"
2376#define JO_ERR_MODIFIABLE 0x40000000 // "err_modifiable" (JO_OUT_ << 1)
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02002377#define JO_ALL 0x7fffffff
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01002378
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002379#define JO2_OUT_MSG 0x0001 // "out_msg"
2380#define JO2_ERR_MSG 0x0002 // "err_msg" (JO_OUT_ << 1)
2381#define JO2_TERM_NAME 0x0004 // "term_name"
2382#define JO2_TERM_FINISH 0x0008 // "term_finish"
2383#define JO2_ENV 0x0010 // "env"
2384#define JO2_CWD 0x0020 // "cwd"
2385#define JO2_TERM_ROWS 0x0040 // "term_rows"
2386#define JO2_TERM_COLS 0x0080 // "term_cols"
2387#define JO2_VERTICAL 0x0100 // "vertical"
2388#define JO2_CURWIN 0x0200 // "curwin"
2389#define JO2_HIDDEN 0x0400 // "hidden"
2390#define JO2_TERM_OPENCMD 0x0800 // "term_opencmd"
2391#define JO2_EOF_CHARS 0x1000 // "eof_chars"
2392#define JO2_NORESTORE 0x2000 // "norestore"
2393#define JO2_TERM_KILL 0x4000 // "term_kill"
2394#define JO2_ANSI_COLORS 0x8000 // "ansi_colors"
2395#define JO2_TTY_TYPE 0x10000 // "tty_type"
2396#define JO2_BUFNR 0x20000 // "bufnr"
Bram Moolenaard2842ea2019-09-26 23:08:54 +02002397#define JO2_TERM_API 0x40000 // "term_api"
Bram Moolenaar83d47902020-03-26 20:34:00 +01002398#define JO2_TERM_HIGHLIGHT 0x80000 // "highlight"
Bram Moolenaar169ebb02016-09-07 23:32:23 +02002399
Bram Moolenaarb6b52522016-02-20 23:30:07 +01002400#define JO_MODE_ALL (JO_MODE + JO_IN_MODE + JO_OUT_MODE + JO_ERR_MODE)
Bram Moolenaar4e221c92016-02-23 13:20:22 +01002401#define JO_CB_ALL \
2402 (JO_CALLBACK + JO_OUT_CALLBACK + JO_ERR_CALLBACK + JO_CLOSE_CALLBACK)
Bram Moolenaarb6b52522016-02-20 23:30:07 +01002403#define JO_TIMEOUT_ALL (JO_TIMEOUT + JO_OUT_TIMEOUT + JO_ERR_TIMEOUT)
2404
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01002405/*
Bram Moolenaar910b8aa2016-02-16 21:03:07 +01002406 * Options for job and channel commands.
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01002407 */
2408typedef struct
2409{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002410 int jo_set; // JO_ bits for values that were set
2411 int jo_set2; // JO2_ bits for values that were set
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01002412
2413 ch_mode_T jo_mode;
Bram Moolenaarb6b52522016-02-20 23:30:07 +01002414 ch_mode_T jo_in_mode;
2415 ch_mode_T jo_out_mode;
2416 ch_mode_T jo_err_mode;
Bram Moolenaar0b146882018-09-06 16:27:24 +02002417 int jo_noblock;
Bram Moolenaar187db502016-02-27 14:44:26 +01002418
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002419 job_io_T jo_io[4]; // PART_OUT, PART_ERR, PART_IN
Bram Moolenaar187db502016-02-27 14:44:26 +01002420 char_u jo_io_name_buf[4][NUMBUFLEN];
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002421 char_u *jo_io_name[4]; // not allocated!
Bram Moolenaar29fd0382016-03-09 23:14:07 +01002422 int jo_io_buf[4];
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02002423 int jo_pty;
Bram Moolenaar9f5842e2016-05-29 16:17:08 +02002424 int jo_modifiable[4];
Bram Moolenaar169ebb02016-09-07 23:32:23 +02002425 int jo_message[4];
Bram Moolenaarde279892016-03-11 22:19:44 +01002426 channel_T *jo_channel;
Bram Moolenaar187db502016-02-27 14:44:26 +01002427
Bram Moolenaar014069a2016-03-03 22:51:40 +01002428 linenr_T jo_in_top;
2429 linenr_T jo_in_bot;
2430
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002431 callback_T jo_callback;
2432 callback_T jo_out_cb;
2433 callback_T jo_err_cb;
2434 callback_T jo_close_cb;
2435 callback_T jo_exit_cb;
Bram Moolenaar958dc692016-12-01 15:34:12 +01002436 int jo_drop_never;
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01002437 int jo_waittime;
2438 int jo_timeout;
Bram Moolenaarb6b52522016-02-20 23:30:07 +01002439 int jo_out_timeout;
2440 int jo_err_timeout;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002441 int jo_block_write; // for testing only
Bram Moolenaar6f3a5442016-02-20 19:56:13 +01002442 int jo_part;
2443 int jo_id;
Bram Moolenaar21109272020-01-30 16:27:20 +01002444 char_u jo_stoponexit_buf[NUMBUFLEN];
Bram Moolenaar65edff82016-02-21 16:40:11 +01002445 char_u *jo_stoponexit;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002446 dict_T *jo_env; // environment variables
Bram Moolenaar05aafed2017-08-11 19:12:11 +02002447 char_u jo_cwd_buf[NUMBUFLEN];
2448 char_u *jo_cwd;
Bram Moolenaar58556cd2017-07-20 23:04:46 +02002449
2450#ifdef FEAT_TERMINAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002451 // when non-zero run the job in a terminal window of this size
Bram Moolenaar58556cd2017-07-20 23:04:46 +02002452 int jo_term_rows;
2453 int jo_term_cols;
Bram Moolenaar08d384f2017-08-11 21:51:23 +02002454 int jo_vertical;
Bram Moolenaarda43b612017-08-11 22:27:50 +02002455 int jo_curwin;
Bram Moolenaar87abab92019-06-03 21:14:59 +02002456 buf_T *jo_bufnr_buf;
Bram Moolenaar8cad9302017-08-12 14:32:32 +02002457 int jo_hidden;
Bram Moolenaar4d8bac82018-03-09 21:33:34 +01002458 int jo_term_norestore;
Bram Moolenaar21109272020-01-30 16:27:20 +01002459 char_u jo_term_name_buf[NUMBUFLEN];
Bram Moolenaar78712a72017-08-05 14:50:12 +02002460 char_u *jo_term_name;
Bram Moolenaar21109272020-01-30 16:27:20 +01002461 char_u jo_term_opencmd_buf[NUMBUFLEN];
Bram Moolenaar37c45832017-08-12 16:01:04 +02002462 char_u *jo_term_opencmd;
Bram Moolenaardd693ce2017-08-10 23:15:19 +02002463 int jo_term_finish;
Bram Moolenaar21109272020-01-30 16:27:20 +01002464 char_u jo_eof_chars_buf[NUMBUFLEN];
Bram Moolenaar3346cc42017-09-02 14:54:21 +02002465 char_u *jo_eof_chars;
Bram Moolenaar21109272020-01-30 16:27:20 +01002466 char_u jo_term_kill_buf[NUMBUFLEN];
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002467 char_u *jo_term_kill;
Bram Moolenaarf59c6e82018-04-10 15:59:11 +02002468# if defined(FEAT_GUI) || defined(FEAT_TERMGUICOLORS)
2469 long_u jo_ansi_colors[16];
2470# endif
Bram Moolenaar83d47902020-03-26 20:34:00 +01002471 char_u jo_term_highlight_buf[NUMBUFLEN];
2472 char_u *jo_term_highlight;
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01002473 int jo_tty_type; // first character of "tty_type"
Bram Moolenaard2842ea2019-09-26 23:08:54 +02002474 char_u jo_term_api_buf[NUMBUFLEN];
Bram Moolenaar21109272020-01-30 16:27:20 +01002475 char_u *jo_term_api;
Bram Moolenaar58556cd2017-07-20 23:04:46 +02002476#endif
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01002477} jobopt_T;
2478
Bram Moolenaar6d2399b2019-05-11 19:14:16 +02002479#ifdef FEAT_EVAL
2480/*
2481 * Structure used for listeners added with listener_add().
2482 */
2483typedef struct listener_S listener_T;
2484struct listener_S
2485{
2486 listener_T *lr_next;
2487 int lr_id;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002488 callback_T lr_callback;
Bram Moolenaar6d2399b2019-05-11 19:14:16 +02002489};
2490#endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002491
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002492/*
2493 * structure used for explicit stack while garbage collecting hash tables
2494 */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01002495typedef struct ht_stack_S
2496{
2497 hashtab_T *ht;
2498 struct ht_stack_S *prev;
2499} ht_stack_T;
2500
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002501/*
2502 * structure used for explicit stack while garbage collecting lists
2503 */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01002504typedef struct list_stack_S
2505{
2506 list_T *list;
2507 struct list_stack_S *prev;
2508} list_stack_T;
2509
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02002510/*
2511 * Structure used for iterating over dictionary items.
2512 * Initialize with dict_iterate_start().
2513 */
2514typedef struct
2515{
2516 long_u dit_todo;
2517 hashitem_T *dit_hi;
2518} dict_iterator_T;
2519
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002520// values for b_syn_spell: what to do with toplevel text
2521#define SYNSPL_DEFAULT 0 // spell check if @Spell not defined
2522#define SYNSPL_TOP 1 // spell check toplevel text
2523#define SYNSPL_NOTOP 2 // don't spell check toplevel text
Bram Moolenaarce0842a2005-07-18 21:58:11 +00002524
Bram Moolenaare35a52a2020-05-31 19:48:53 +02002525// values for b_syn_foldlevel: how to compute foldlevel on a line
2526#define SYNFLD_START 0 // use level of item at start of line
2527#define SYNFLD_MINIMUM 1 // use lowest local minimum level on line
2528
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002529// avoid #ifdefs for when b_spell is not available
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002530#ifdef FEAT_SPELL
Bram Moolenaar4770d092006-01-12 23:22:24 +00002531# define B_SPELL(buf) ((buf)->b_spell)
2532#else
2533# define B_SPELL(buf) (0)
2534#endif
2535
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002536typedef struct qf_info_S qf_info_T;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00002537
Bram Moolenaarf7512552013-06-06 14:55:19 +02002538#ifdef FEAT_PROFILE
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02002539/*
2540 * Used for :syntime: timing of executing a syntax pattern.
2541 */
2542typedef struct {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002543 proftime_T total; // total time used
2544 proftime_T slowest; // time of slowest call
2545 long count; // nr of times used
2546 long match; // nr of times matched
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02002547} syn_time_T;
2548#endif
2549
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002550typedef struct timer_S timer_T;
2551struct timer_S
2552{
2553 long tr_id;
2554#ifdef FEAT_TIMERS
2555 timer_T *tr_next;
2556 timer_T *tr_prev;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002557 proftime_T tr_due; // when the callback is to be invoked
2558 char tr_firing; // when TRUE callback is being called
2559 char tr_paused; // when TRUE callback is not invoked
2560 int tr_repeat; // number of times to repeat, -1 forever
2561 long tr_interval; // msec
2562 callback_T tr_callback;
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002563 int tr_emsg_count;
2564#endif
2565};
2566
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002567#ifdef FEAT_CRYPT
2568/*
2569 * Structure to hold the type of encryption and the state of encryption or
2570 * decryption.
2571 */
2572typedef struct {
2573 int method_nr;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002574 void *method_state; // method-specific state information
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002575} cryptstate_T;
2576
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002577// values for method_nr
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002578# define CRYPT_M_ZIP 0
2579# define CRYPT_M_BF 1
2580# define CRYPT_M_BF2 2
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002581# define CRYPT_M_SOD 3
2582# define CRYPT_M_COUNT 4 // number of crypt methods
Bram Moolenaar987411d2019-01-18 22:48:34 +01002583
2584// Currently all crypt methods work inplace. If one is added that isn't then
2585// define this.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002586# define CRYPT_NOT_INPLACE 1
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002587#endif
2588
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002589#ifdef FEAT_PROP_POPUP
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002590typedef enum {
2591 POPPOS_BOTLEFT,
2592 POPPOS_TOPLEFT,
2593 POPPOS_BOTRIGHT,
2594 POPPOS_TOPRIGHT,
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01002595 POPPOS_CENTER,
2596 POPPOS_NONE
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002597} poppos_T;
Bram Moolenaar6c009a32019-06-08 16:06:28 +02002598
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002599typedef enum {
2600 POPCLOSE_NONE,
2601 POPCLOSE_BUTTON,
2602 POPCLOSE_CLICK
2603} popclose_T;
2604
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002605# define POPUPWIN_DEFAULT_ZINDEX 50
2606# define POPUPMENU_ZINDEX 100
Bram Moolenaara42d9452019-06-15 21:46:30 +02002607# define POPUPWIN_DIALOG_ZINDEX 200
2608# define POPUPWIN_NOTIFICATION_ZINDEX 300
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002609#endif
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002610
Bram Moolenaar362ce482012-06-06 19:02:45 +02002611/*
2612 * These are items normally related to a buffer. But when using ":ownsyntax"
2613 * a window may have its own instance.
2614 */
Bram Moolenaar860cae12010-06-05 23:22:07 +02002615typedef struct {
2616#ifdef FEAT_SYN_HL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002617 hashtab_T b_keywtab; // syntax keywords hash table
2618 hashtab_T b_keywtab_ic; // idem, ignore case
2619 int b_syn_error; // TRUE when error occurred in HL
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02002620# ifdef FEAT_RELTIME
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002621 int b_syn_slow; // TRUE when 'redrawtime' reached
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02002622# endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002623 int b_syn_ic; // ignore case for :syn cmds
Bram Moolenaare35a52a2020-05-31 19:48:53 +02002624 int b_syn_foldlevel; // how to compute foldlevel on a line
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002625 int b_syn_spell; // SYNSPL_ values
2626 garray_T b_syn_patterns; // table for syntax patterns
2627 garray_T b_syn_clusters; // table for syntax clusters
2628 int b_spell_cluster_id; // @Spell cluster ID or 0
2629 int b_nospell_cluster_id; // @NoSpell cluster ID or 0
2630 int b_syn_containedin; // TRUE when there is an item with a
2631 // "containedin" argument
2632 int b_syn_sync_flags; // flags about how to sync
2633 short b_syn_sync_id; // group to sync on
2634 long b_syn_sync_minlines; // minimal sync lines offset
2635 long b_syn_sync_maxlines; // maximal sync lines offset
2636 long b_syn_sync_linebreaks; // offset for multi-line pattern
2637 char_u *b_syn_linecont_pat; // line continuation pattern
2638 regprog_T *b_syn_linecont_prog; // line continuation program
Bram Moolenaarf7512552013-06-06 14:55:19 +02002639#ifdef FEAT_PROFILE
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02002640 syn_time_T b_syn_linecont_time;
2641#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002642 int b_syn_linecont_ic; // ignore-case flag for above
2643 int b_syn_topgrp; // for ":syntax include"
Bram Moolenaar860cae12010-06-05 23:22:07 +02002644# ifdef FEAT_CONCEAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002645 int b_syn_conceal; // auto-conceal for :syn cmds
Bram Moolenaar860cae12010-06-05 23:22:07 +02002646# endif
2647# ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002648 int b_syn_folditems; // number of patterns with the HL_FOLD
2649 // flag set
Bram Moolenaar860cae12010-06-05 23:22:07 +02002650# endif
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02002651 /*
2652 * b_sst_array[] contains the state stack for a number of lines, for the
2653 * start of that line (col == 0). This avoids having to recompute the
2654 * syntax state too often.
2655 * b_sst_array[] is allocated to hold the state for all displayed lines,
2656 * and states for 1 out of about 20 other lines.
2657 * b_sst_array pointer to an array of synstate_T
2658 * b_sst_len number of entries in b_sst_array[]
2659 * b_sst_first pointer to first used entry in b_sst_array[] or NULL
2660 * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL
2661 * b_sst_freecount number of free entries in b_sst_array[]
2662 * b_sst_check_lnum entries after this lnum need to be checked for
2663 * validity (MAXLNUM means no check needed)
2664 */
Bram Moolenaar860cae12010-06-05 23:22:07 +02002665 synstate_T *b_sst_array;
2666 int b_sst_len;
2667 synstate_T *b_sst_first;
2668 synstate_T *b_sst_firstfree;
2669 int b_sst_freecount;
2670 linenr_T b_sst_check_lnum;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002671 short_u b_sst_lasttick; // last display tick
2672#endif // FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02002673
2674#ifdef FEAT_SPELL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002675 // for spell checking
2676 garray_T b_langp; // list of pointers to slang_T, see spell.c
2677 char_u b_spell_ismw[256]; // flags: is midword char
2678 char_u *b_spell_ismw_mb; // multi-byte midword chars
2679 char_u *b_p_spc; // 'spellcapcheck'
2680 regprog_T *b_cap_prog; // program for 'spellcapcheck'
2681 char_u *b_p_spf; // 'spellfile'
2682 char_u *b_p_spl; // 'spelllang'
Bram Moolenaar215f49c2020-06-10 22:12:04 +02002683 char_u *b_p_spo; // 'spelloptions'
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002684 int b_cjk; // all CJK letters as OK
Bram Moolenaar860cae12010-06-05 23:22:07 +02002685#endif
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02002686#if !defined(FEAT_SYN_HL) && !defined(FEAT_SPELL)
2687 int dummy;
2688#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002689 char_u b_syn_chartab[32]; // syntax iskeyword option
2690 char_u *b_syn_isk; // iskeyword option
Bram Moolenaar860cae12010-06-05 23:22:07 +02002691} synblock_T;
2692
2693
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694/*
2695 * buffer: structure that holds information about one file
2696 *
2697 * Several windows can share a single Buffer
2698 * A buffer is unallocated if there is no memfile for it.
2699 * A buffer is new if the associated file has never been loaded yet.
2700 */
2701
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702struct file_buffer
2703{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002704 memline_T b_ml; // associated memline (also contains line
2705 // count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002707 buf_T *b_next; // links in list of buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 buf_T *b_prev;
2709
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002710 int b_nwindows; // nr of windows open on this buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002712 int b_flags; // various BF_ flags
2713 int b_locked; // Buffer is being closed or referenced, don't
2714 // let autocommands wipe it out.
Bram Moolenaar983d83f2021-02-07 12:12:43 +01002715 int b_locked_split; // Buffer is being closed, don't allow opening
2716 // a new window with it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717
2718 /*
2719 * b_ffname has the full path of the file (NULL for no name).
2720 * b_sfname is the name as the user typed it (or NULL).
2721 * b_fname is the same as b_sfname, unless ":cd" has been done,
2722 * then it is the same as b_ffname (NULL for no name).
2723 */
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002724 char_u *b_ffname; // full path file name, allocated
2725 char_u *b_sfname; // short file name, allocated, may be equal to
2726 // b_ffname
2727 char_u *b_fname; // current file name, points to b_ffname or
2728 // b_sfname
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729
2730#ifdef UNIX
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002731 int b_dev_valid; // TRUE when b_dev has a valid number
2732 dev_t b_dev; // device number
2733 ino_t b_ino; // inode number
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735#ifdef VMS
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002736 char b_fab_rfm; // Record format
2737 char b_fab_rat; // Record attribute
2738 unsigned int b_fab_mrs; // Max record size
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002740 int b_fnum; // buffer number for this file.
Bram Moolenaar480778b2016-07-14 22:09:39 +02002741 char_u b_key[VIM_SIZEOF_INT * 2 + 1];
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002742 // key used for buf_hashtab, holds b_fnum as
2743 // hex string
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002745 int b_changed; // 'modified': Set to TRUE if something in the
2746 // file has been changed and not written out.
2747 dictitem16_T b_ct_di; // holds the b:changedtick value in
2748 // b_ct_di.di_tv.vval.v_number;
2749 // incremented for each change, also for undo
Bram Moolenaar95c526e2017-02-25 14:59:34 +01002750#define CHANGEDTICK(buf) ((buf)->b_ct_di.di_tv.vval.v_number)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751
Christian Brabandtdb3b4462021-10-16 11:58:55 +01002752 varnumber_T b_last_changedtick; // b:changedtick when TextChanged was
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002753 // last triggered.
Christian Brabandtdb3b4462021-10-16 11:58:55 +01002754 varnumber_T b_last_changedtick_pum; // b:changedtick for TextChangedP
2755 varnumber_T b_last_changedtick_i; // b:changedtick for TextChangedI
Bram Moolenaar5a093432018-02-10 18:15:19 +01002756
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002757 int b_saving; // Set to TRUE if we are in the middle of
2758 // saving the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759
2760 /*
2761 * Changes to a buffer require updating of the display. To minimize the
2762 * work, remember changes made and update everything at once.
2763 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002764 int b_mod_set; // TRUE when there are changes since the last
2765 // time the display was updated
2766 linenr_T b_mod_top; // topmost lnum that was changed
2767 linenr_T b_mod_bot; // lnum below last changed line, AFTER the
2768 // change
2769 long b_mod_xlines; // number of extra buffer lines inserted;
2770 // negative when lines were deleted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002772 wininfo_T *b_wininfo; // list of last used info for each window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002774 long b_mtime; // last change time of original file
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01002775 long b_mtime_ns; // nanoseconds of last change time
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002776 long b_mtime_read; // last change time when reading
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01002777 long b_mtime_read_ns; // nanoseconds of last read time
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002778 off_T b_orig_size; // size of original file in bytes
2779 int b_orig_mode; // mode of original file
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002780#ifdef FEAT_VIMINFO
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002781 time_T b_last_used; // time when the buffer was last used; used
2782 // for viminfo
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002783#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002785 pos_T b_namedm[NMARKS]; // current named marks (mark.c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002787 // These variables are set when VIsual_active becomes FALSE
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002788 visualinfo_T b_visual;
Bram Moolenaarf7ff6e82014-03-23 15:13:05 +01002789#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002790 int b_visual_mode_eval; // b_visual.vi_mode for visualmode()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791#endif
2792
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002793 pos_T b_last_cursor; // cursor position when last unloading this
2794 // buffer
2795 pos_T b_last_insert; // where Insert mode was left
2796 pos_T b_last_change; // position of last change: '. mark
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 /*
2799 * the changelist contains old change positions
2800 */
2801 pos_T b_changelist[JUMPLISTSIZE];
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002802 int b_changelistlen; // number of active entries
2803 int b_new_change; // set by u_savecommon()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804
2805 /*
2806 * Character table, only used in charset.c for 'iskeyword'
2807 * 32 bytes of 8 bits: 1 bit per character 0-255.
2808 */
2809 char_u b_chartab[32];
2810
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002811 // Table used for mappings local to a buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 mapblock_T *(b_maphash[256]);
2813
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002814 // First abbreviation local to a buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 mapblock_T *b_first_abbr;
Bram Moolenaarb66bab32019-08-01 14:28:24 +02002816
Bram Moolenaarac9fb182019-04-27 13:04:13 +02002817 // User commands local to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 garray_T b_ucmds;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002819 // start and end of an operator, also used for '[ and ']
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 pos_T b_op_start;
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02002821 pos_T b_op_start_orig; // used for Insstart_orig
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 pos_T b_op_end;
2823
2824#ifdef FEAT_VIMINFO
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002825 int b_marks_read; // Have we read viminfo marks yet?
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826#endif
2827
2828 /*
2829 * The following only used in undo.c.
2830 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002831 u_header_T *b_u_oldhead; // pointer to oldest header
2832 u_header_T *b_u_newhead; // pointer to newest header; may not be valid
2833 // if b_u_curhead is not NULL
2834 u_header_T *b_u_curhead; // pointer to current header
2835 int b_u_numhead; // current number of headers
2836 int b_u_synced; // entry lists are synced
2837 long b_u_seq_last; // last used undo sequence number
2838 long b_u_save_nr_last; // counter for last file write
2839 long b_u_seq_cur; // hu_seq of header below which we are now
2840 time_T b_u_time_cur; // uh_time of header below which we are now
2841 long b_u_save_nr_cur; // file write nr after which we are now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842
2843 /*
2844 * variables for "U" command in undo.c
2845 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002846 undoline_T b_u_line_ptr; // saved line for "U" command
2847 linenr_T b_u_line_lnum; // line number of line in u_line
2848 colnr_T b_u_line_colnr; // optional column number
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002850 int b_scanned; // ^N/^P have scanned this buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002852 // flags for use of ":lmap" and IM control
2853 long b_p_iminsert; // input mode for insert
2854 long b_p_imsearch; // input mode for search
kylo2529dac9b12022-03-27 20:05:17 +01002855#define B_IMODE_USE_INSERT (-1) // Use b_p_iminsert value for search
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002856#define B_IMODE_NONE 0 // Input via none
2857#define B_IMODE_LMAP 1 // Input via langmap
2858#define B_IMODE_IM 2 // Input via input method
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01002859#define B_IMODE_LAST 2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860
2861#ifdef FEAT_KEYMAP
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002862 short b_kmap_state; // using "lmap" mappings
2863# define KEYMAP_INIT 1 // 'keymap' was set, call keymap_init()
2864# define KEYMAP_LOADED 2 // 'keymap' mappings have been loaded
2865 garray_T b_kmap_ga; // the keymap table
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866#endif
2867
2868 /*
2869 * Options local to a buffer.
2870 * They are here because their value depends on the type of file
2871 * or contents of the file being edited.
2872 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002873 int b_p_initialized; // set when options initialized
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00002875#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002876 sctx_T b_p_script_ctx[BV_COUNT]; // SCTXs for buffer-local options
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00002877#endif
2878
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002879 int b_p_ai; // 'autoindent'
2880 int b_p_ai_nopaste; // b_p_ai saved for paste mode
2881 char_u *b_p_bkc; // 'backupcopy'
2882 unsigned b_bkc_flags; // flags for 'backupcopy'
2883 int b_p_ci; // 'copyindent'
2884 int b_p_bin; // 'binary'
2885 int b_p_bomb; // 'bomb'
2886 char_u *b_p_bh; // 'bufhidden'
2887 char_u *b_p_bt; // 'buftype'
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02002888#ifdef FEAT_QUICKFIX
Bram Moolenaarc1542742016-07-20 21:44:37 +02002889#define BUF_HAS_QF_ENTRY 1
2890#define BUF_HAS_LL_ENTRY 2
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002891 int b_has_qf_entry;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002893 int b_p_bl; // 'buflisted'
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002894 int b_p_cin; // 'cindent'
2895 char_u *b_p_cino; // 'cinoptions'
2896 char_u *b_p_cink; // 'cinkeys'
Tom Praschan3506cf32022-04-07 12:39:08 +01002897 char_u *b_p_cinsd; // 'cinscopedecls'
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002898 char_u *b_p_cinw; // 'cinwords'
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002899 char_u *b_p_com; // 'comments'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900#ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002901 char_u *b_p_cms; // 'commentstring'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002903 char_u *b_p_cpt; // 'complete'
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002904#ifdef BACKSLASH_IN_FILENAME
2905 char_u *b_p_csl; // 'completeslash'
2906#endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002907#ifdef FEAT_COMPL_FUNC
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002908 char_u *b_p_cfu; // 'completefunc'
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002909 callback_T b_cfu_cb; // 'completefunc' callback
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002910 char_u *b_p_ofu; // 'omnifunc'
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002911 callback_T b_ofu_cb; // 'omnifunc' callback
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002912#endif
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02002913#ifdef FEAT_EVAL
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00002914 char_u *b_p_tfu; // 'tagfunc' option value
2915 callback_T b_tfu_cb; // 'tagfunc' callback
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02002916#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002917 int b_p_eol; // 'endofline'
2918 int b_p_fixeol; // 'fixendofline'
2919 int b_p_et; // 'expandtab'
2920 int b_p_et_nobin; // b_p_et saved for binary mode
2921 int b_p_et_nopaste; // b_p_et saved for paste mode
2922 char_u *b_p_fenc; // 'fileencoding'
2923 char_u *b_p_ff; // 'fileformat'
2924 char_u *b_p_ft; // 'filetype'
2925 char_u *b_p_fo; // 'formatoptions'
2926 char_u *b_p_flp; // 'formatlistpat'
2927 int b_p_inf; // 'infercase'
2928 char_u *b_p_isk; // 'iskeyword'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929#ifdef FEAT_FIND_ID
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002930 char_u *b_p_def; // 'define' local value
2931 char_u *b_p_inc; // 'include'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932# ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002933 char_u *b_p_inex; // 'includeexpr'
2934 long_u b_p_inex_flags; // flags for 'includeexpr'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935# endif
2936#endif
Bram Moolenaar8e145b82022-05-21 20:17:31 +01002937#if defined(FEAT_EVAL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002938 char_u *b_p_inde; // 'indentexpr'
2939 long_u b_p_inde_flags; // flags for 'indentexpr'
2940 char_u *b_p_indk; // 'indentkeys'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002942 char_u *b_p_fp; // 'formatprg'
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002943#if defined(FEAT_EVAL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002944 char_u *b_p_fex; // 'formatexpr'
2945 long_u b_p_fex_flags; // flags for 'formatexpr'
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002946#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947#ifdef FEAT_CRYPT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002948 char_u *b_p_key; // 'key'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002950 char_u *b_p_kp; // 'keywordprg'
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002951 int b_p_lisp; // 'lisp'
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002952 char_u *b_p_menc; // 'makeencoding'
2953 char_u *b_p_mps; // 'matchpairs'
2954 int b_p_ml; // 'modeline'
2955 int b_p_ml_nobin; // b_p_ml saved for binary mode
2956 int b_p_ma; // 'modifiable'
2957 char_u *b_p_nf; // 'nrformats'
2958 int b_p_pi; // 'preserveindent'
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002959#ifdef FEAT_TEXTOBJ
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002960 char_u *b_p_qe; // 'quoteescape'
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002961#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002962 int b_p_ro; // 'readonly'
2963 long b_p_sw; // 'shiftwidth'
2964 int b_p_sn; // 'shortname'
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002965 int b_p_si; // 'smartindent'
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002966 long b_p_sts; // 'softtabstop'
2967 long b_p_sts_nopaste; // b_p_sts saved for paste mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968#ifdef FEAT_SEARCHPATH
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002969 char_u *b_p_sua; // 'suffixesadd'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002971 int b_p_swf; // 'swapfile'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972#ifdef FEAT_SYN_HL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002973 long b_p_smc; // 'synmaxcol'
2974 char_u *b_p_syn; // 'syntax'
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002975#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002976 long b_p_ts; // 'tabstop'
2977 int b_p_tx; // 'textmode'
2978 long b_p_tw; // 'textwidth'
2979 long b_p_tw_nobin; // b_p_tw saved for binary mode
2980 long b_p_tw_nopaste; // b_p_tw saved for paste mode
2981 long b_p_wm; // 'wrapmargin'
2982 long b_p_wm_nobin; // b_p_wm saved for binary mode
2983 long b_p_wm_nopaste; // b_p_wm saved for paste mode
Bram Moolenaar04958cb2018-06-23 19:23:02 +02002984#ifdef FEAT_VARTABS
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002985 char_u *b_p_vsts; // 'varsofttabstop'
2986 int *b_p_vsts_array; // 'varsofttabstop' in internal format
2987 char_u *b_p_vsts_nopaste; // b_p_vsts saved for paste mode
2988 char_u *b_p_vts; // 'vartabstop'
2989 int *b_p_vts_array; // 'vartabstop' in internal format
Bram Moolenaar04958cb2018-06-23 19:23:02 +02002990#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991#ifdef FEAT_KEYMAP
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002992 char_u *b_p_keymap; // 'keymap'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993#endif
2994
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002995 /*
2996 * local values for options which are normally global
2997 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998#ifdef FEAT_QUICKFIX
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002999 char_u *b_p_gp; // 'grepprg' local value
3000 char_u *b_p_mp; // 'makeprg' local value
3001 char_u *b_p_efm; // 'errorformat' local value
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003003 char_u *b_p_ep; // 'equalprg' local value
3004 char_u *b_p_path; // 'path' local value
3005 int b_p_ar; // 'autoread' local value
3006 char_u *b_p_tags; // 'tags' local value
3007 char_u *b_p_tc; // 'tagcase' local value
3008 unsigned b_tc_flags; // flags for 'tagcase'
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003009 char_u *b_p_dict; // 'dictionary' local value
3010 char_u *b_p_tsr; // 'thesaurus' local value
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01003011#ifdef FEAT_COMPL_FUNC
3012 char_u *b_p_tsrfu; // 'thesaurusfunc' local value
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003013 callback_T b_tsrfu_cb; // 'thesaurusfunc' callback
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01003014#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003015 long b_p_ul; // 'undolevels' local value
Bram Moolenaar55debbe2010-05-23 23:34:36 +02003016#ifdef FEAT_PERSISTENT_UNDO
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003017 int b_p_udf; // 'undofile'
Bram Moolenaar55debbe2010-05-23 23:34:36 +02003018#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003019 char_u *b_p_lw; // 'lispwords' local value
Bram Moolenaare1fc5152018-04-21 19:49:08 +02003020#ifdef FEAT_TERMINAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003021 long b_p_twsl; // 'termwinscroll'
Bram Moolenaare1fc5152018-04-21 19:49:08 +02003022#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003024 /*
3025 * end of buffer options
3026 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003028 // values set from b_p_cino
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +01003029 int b_ind_level;
3030 int b_ind_open_imag;
3031 int b_ind_no_brace;
3032 int b_ind_first_open;
3033 int b_ind_open_extra;
3034 int b_ind_close_extra;
3035 int b_ind_open_left_imag;
3036 int b_ind_jump_label;
3037 int b_ind_case;
3038 int b_ind_case_code;
3039 int b_ind_case_break;
3040 int b_ind_param;
3041 int b_ind_func_type;
3042 int b_ind_comment;
3043 int b_ind_in_comment;
3044 int b_ind_in_comment2;
3045 int b_ind_cpp_baseclass;
3046 int b_ind_continuation;
3047 int b_ind_unclosed;
3048 int b_ind_unclosed2;
3049 int b_ind_unclosed_noignore;
3050 int b_ind_unclosed_wrapped;
3051 int b_ind_unclosed_whiteok;
3052 int b_ind_matching_paren;
3053 int b_ind_paren_prev;
3054 int b_ind_maxparen;
3055 int b_ind_maxcomment;
3056 int b_ind_scopedecl;
3057 int b_ind_scopedecl_code;
3058 int b_ind_java;
3059 int b_ind_js;
3060 int b_ind_keep_case_label;
3061 int b_ind_hash_comment;
3062 int b_ind_cpp_namespace;
3063 int b_ind_if_for_while;
Bram Moolenaar7720ba82017-03-08 22:19:26 +01003064 int b_ind_cpp_extern_c;
Bram Moolenaard881b512020-05-31 17:49:30 +02003065 int b_ind_pragma;
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +01003066
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003067 linenr_T b_no_eol_lnum; // non-zero lnum when last line of next binary
3068 // write should not have an end-of-line
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01003069
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003070 int b_start_eol; // last line had eol when it was read
3071 int b_start_ffc; // first char of 'ff' when edit started
3072 char_u *b_start_fenc; // 'fileencoding' when edit started or NULL
3073 int b_bad_char; // "++bad=" argument when edit started or 0
3074 int b_start_bomb; // 'bomb' when it was read
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075
3076#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003077 dictitem_T b_bufvar; // variable for "b:" Dictionary
3078 dict_T *b_vars; // internal variables, local to buffer
Bram Moolenaar6d2399b2019-05-11 19:14:16 +02003079
3080 listener_T *b_listener;
Bram Moolenaardda41442019-05-16 22:11:47 +02003081 list_T *b_recorded_changes;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082#endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003083#ifdef FEAT_PROP_POPUP
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01003084 int b_has_textprop; // TRUE when text props were added
3085 hashtab_T *b_proptypes; // text property types local to buffer
Bram Moolenaar7f9969c2022-07-25 18:13:54 +01003086 garray_T b_textprop_text; // stores text for props, index by (-id - 1)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003087#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003089#if defined(FEAT_BEVAL) && defined(FEAT_EVAL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003090 char_u *b_p_bexpr; // 'balloonexpr' local value
3091 long_u b_p_bexpr_flags;// flags for 'balloonexpr'
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003092#endif
Bram Moolenaar49771f42010-07-20 17:32:38 +02003093#ifdef FEAT_CRYPT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003094 char_u *b_p_cm; // 'cryptmethod'
Bram Moolenaar49771f42010-07-20 17:32:38 +02003095#endif
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003096
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003097 // When a buffer is created, it starts without a swap file. b_may_swap is
3098 // then set to indicate that a swap file may be opened later. It is reset
3099 // if a swap file could not be opened.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 int b_may_swap;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003101 int b_did_warn; // Set to 1 if user has been warned on first
3102 // change of a read-only file
Bram Moolenaar4770d092006-01-12 23:22:24 +00003103
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003104 // Two special kinds of buffers:
3105 // help buffer - used for help files, won't use a swap file.
3106 // spell buffer - used for spell info, never displayed and doesn't have a
3107 // file name.
3108 int b_help; // TRUE for help file buffer (when set b_p_bt
3109 // is "help")
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00003110#ifdef FEAT_SPELL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003111 int b_spell; // TRUE for a spell file buffer, most fields
3112 // are not used! Use the B_SPELL macro to
3113 // access b_spell without #ifdef.
Bram Moolenaar4770d092006-01-12 23:22:24 +00003114#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003116 int b_shortname; // this file has an 8.3 file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117
Bram Moolenaarf2732452018-06-03 14:47:35 +02003118#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003119 char_u *b_prompt_text; // set by prompt_setprompt()
3120 callback_T b_prompt_callback; // set by prompt_setcallback()
3121 callback_T b_prompt_interrupt; // set by prompt_setinterrupt()
3122 int b_prompt_insert; // value for restart_edit when entering
3123 // a prompt buffer window.
Bram Moolenaarf2732452018-06-03 14:47:35 +02003124#endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003125#ifdef FEAT_MZSCHEME
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003126 void *b_mzscheme_ref; // The MzScheme reference to this buffer
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003127#endif
3128
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129#ifdef FEAT_PERL
Bram Moolenaare344bea2005-09-01 20:46:49 +00003130 void *b_perl_private;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131#endif
3132
3133#ifdef FEAT_PYTHON
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003134 void *b_python_ref; // The Python reference to this buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135#endif
3136
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02003137#ifdef FEAT_PYTHON3
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003138 void *b_python3_ref; // The Python3 reference to this buffer
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02003139#endif
3140
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141#ifdef FEAT_TCL
Bram Moolenaare344bea2005-09-01 20:46:49 +00003142 void *b_tcl_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143#endif
3144
3145#ifdef FEAT_RUBY
Bram Moolenaare344bea2005-09-01 20:46:49 +00003146 void *b_ruby_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147#endif
3148
Bram Moolenaar860cae12010-06-05 23:22:07 +02003149#if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003150 synblock_T b_s; // Info related to syntax highlighting. w_s
3151 // normally points to this, but some windows
3152 // may use a different synblock_T.
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00003153#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154
3155#ifdef FEAT_SIGNS
Bram Moolenaar6656c2e2019-10-24 15:00:04 +02003156 sign_entry_T *b_signlist; // list of placed signs
Bram Moolenaar3b7b8362015-03-20 18:11:48 +01003157# ifdef FEAT_NETBEANS_INTG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003158 int b_has_sign_column; // Flag that is set when a first sign is
3159 // added and remains set until the end of
3160 // the netbeans session.
Bram Moolenaar3b7b8362015-03-20 18:11:48 +01003161# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162#endif
3163
3164#ifdef FEAT_NETBEANS_INTG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003165 int b_netbeans_file; // TRUE when buffer is owned by NetBeans
3166 int b_was_netbeans_file;// TRUE if b_netbeans_file was once set
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167#endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01003168#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003169 int b_write_to_channel; // TRUE when appended lines are written to
3170 // a channel.
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003171#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02003173#ifdef FEAT_CRYPT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003174 cryptstate_T *b_cryptstate; // Encryption state while reading or writing
3175 // the file. NULL when not using encryption.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02003176#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003177 int b_mapped_ctrl_c; // modes where CTRL-C is mapped
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02003178
Bram Moolenaare4f25e42017-07-07 11:54:15 +02003179#ifdef FEAT_TERMINAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003180 term_T *b_term; // When not NULL this buffer is for a terminal
3181 // window.
Bram Moolenaare4f25e42017-07-07 11:54:15 +02003182#endif
Bram Moolenaare828b762018-09-10 17:51:58 +02003183#ifdef FEAT_DIFF
3184 int b_diff_failed; // internal diff failed for this buffer
3185#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003186}; // file_buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003188
3189#ifdef FEAT_DIFF
3190/*
3191 * Stuff for diff mode.
3192 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003193# define DB_COUNT 8 // up to eight buffers can be diff'ed
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003194
3195/*
3196 * Each diffblock defines where a block of lines starts in each of the buffers
3197 * and how many lines it occupies in that buffer. When the lines are missing
3198 * in the buffer the df_count[] is zero. This is all counted in
3199 * buffer lines.
3200 * There is always at least one unchanged line in between the diffs.
3201 * Otherwise it would have been included in the diff above or below it.
3202 * df_lnum[] + df_count[] is the lnum below the change. When in one buffer
3203 * lines have been inserted, in the other buffer df_lnum[] is the line below
3204 * the insertion and df_count[] is zero. When appending lines at the end of
3205 * the buffer, df_lnum[] is one beyond the end!
3206 * This is using a linked list, because the number of differences is expected
3207 * to be reasonable small. The list is sorted on lnum.
3208 */
3209typedef struct diffblock_S diff_T;
3210struct diffblock_S
3211{
3212 diff_T *df_next;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003213 linenr_T df_lnum[DB_COUNT]; // line number in buffer
3214 linenr_T df_count[DB_COUNT]; // nr of inserted/changed lines
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003215};
3216#endif
3217
Bram Moolenaar746ebd32009-06-16 14:01:43 +00003218#define SNAP_HELP_IDX 0
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01003219#define SNAP_AUCMD_IDX 1
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003220#define SNAP_COUNT 2
Bram Moolenaar746ebd32009-06-16 14:01:43 +00003221
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003222/*
3223 * Tab pages point to the top frame of each tab page.
3224 * Note: Most values are NOT valid for the current tab page! Use "curwin",
3225 * "firstwin", etc. for that. "tp_topframe" is always valid and can be
3226 * compared against "topframe" to find the current tab page.
3227 */
3228typedef struct tabpage_S tabpage_T;
3229struct tabpage_S
3230{
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003231 tabpage_T *tp_next; // next tabpage or NULL
3232 frame_T *tp_topframe; // topframe for the windows
3233 win_T *tp_curwin; // current window in this Tab page
3234 win_T *tp_prevwin; // previous window in this Tab page
3235 win_T *tp_firstwin; // first window in this Tab page
3236 win_T *tp_lastwin; // last window in this Tab page
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003237#ifdef FEAT_PROP_POPUP
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003238 win_T *tp_first_popupwin; // first popup window in this Tab page
3239#endif
3240 long tp_old_Rows; // Rows when Tab page was left
Bram Moolenaarb7118142021-12-10 13:40:08 +00003241 long tp_old_Columns; // Columns when Tab page was left, -1 when
3242 // calling shell_new_columns() postponed
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003243 long tp_ch_used; // value of 'cmdheight' when frame size
3244 // was set
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003245#ifdef FEAT_GUI
3246 int tp_prev_which_scrollbars[3];
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003247 // previous value of which_scrollbars
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003248#endif
Bram Moolenaar00aa0692019-04-27 20:37:57 +02003249
3250 char_u *tp_localdir; // absolute path of local directory or
3251 // NULL
Bram Moolenaar002bc792020-06-05 22:33:42 +02003252 char_u *tp_prevdir; // previous directory
3253
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003254#ifdef FEAT_DIFF
3255 diff_T *tp_first_diff;
3256 buf_T *(tp_diffbuf[DB_COUNT]);
Bram Moolenaare3521d92018-09-16 14:10:31 +02003257 int tp_diff_invalid; // list of diffs is outdated
3258 int tp_diff_update; // update diffs before redrawing
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003259#endif
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003260 frame_T *(tp_snapshot[SNAP_COUNT]); // window layout snapshots
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003261#ifdef FEAT_EVAL
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003262 dictitem_T tp_winvar; // variable for "t:" Dictionary
3263 dict_T *tp_vars; // internal variables, local to tab page
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003264#endif
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003265
3266#ifdef FEAT_PYTHON
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003267 void *tp_python_ref; // The Python value for this tab page
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003268#endif
3269
3270#ifdef FEAT_PYTHON3
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003271 void *tp_python3_ref; // The Python value for this tab page
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003272#endif
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003273};
3274
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275/*
3276 * Structure to cache info for displayed lines in w_lines[].
3277 * Each logical line has one entry.
3278 * The entry tells how the logical line is currently displayed in the window.
3279 * This is updated when displaying the window.
3280 * When the display is changed (e.g., when clearing the screen) w_lines_valid
3281 * is changed to exclude invalid entries.
3282 * When making changes to the buffer, wl_valid is reset to indicate wl_size
3283 * may not reflect what is actually in the buffer. When wl_valid is FALSE,
3284 * the entries can only be used to count the number of displayed lines used.
3285 * wl_lnum and wl_lastlnum are invalid too.
3286 */
3287typedef struct w_line
3288{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003289 linenr_T wl_lnum; // buffer line number for logical line
3290 short_u wl_size; // height in screen lines
3291 char wl_valid; // TRUE values are valid for text in buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292#ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003293 char wl_folded; // TRUE when this is a range of folded lines
3294 linenr_T wl_lastlnum; // last buffer line number for logical line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295#endif
3296} wline_T;
3297
3298/*
3299 * Windows are kept in a tree of frames. Each frame has a column (FR_COL)
3300 * or row (FR_ROW) layout or is a leaf, which has a window.
3301 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003302struct frame_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303{
Bram Moolenaarcce713d2019-03-04 11:40:12 +01003304 char fr_layout; // FR_LEAF, FR_COL or FR_ROW
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 int fr_width;
Bram Moolenaarcce713d2019-03-04 11:40:12 +01003306 int fr_newwidth; // new width used in win_equal_rec()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 int fr_height;
Bram Moolenaarcce713d2019-03-04 11:40:12 +01003308 int fr_newheight; // new height used in win_equal_rec()
3309 frame_T *fr_parent; // containing frame or NULL
3310 frame_T *fr_next; // frame right or below in same parent, NULL
3311 // for last
3312 frame_T *fr_prev; // frame left or above in same parent, NULL
3313 // for first
3314 // fr_child and fr_win are mutually exclusive
3315 frame_T *fr_child; // first contained frame
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01003316 win_T *fr_win; // window that fills this frame; for a snapshot
3317 // set to the current window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318};
3319
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003320#define FR_LEAF 0 // frame is a leaf
3321#define FR_ROW 1 // frame with a row of windows
3322#define FR_COL 2 // frame with a column of windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323
3324/*
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003325 * Struct used for highlighting 'hlsearch' matches, matches defined by
3326 * ":match" and matches defined by match functions.
3327 * For 'hlsearch' there is one pattern for all windows. For ":match" and the
3328 * match functions there is a different pattern for each window.
3329 */
3330typedef struct
3331{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003332 regmmatch_T rm; // points to the regexp program; contains last
3333 // found match (may continue in next line)
3334 buf_T *buf; // the buffer to search for a match
3335 linenr_T lnum; // the line to search for a match
3336 int attr; // attributes to be used for a match
3337 int attr_cur; // attributes currently active in win_line()
3338 linenr_T first_lnum; // first lnum to search for multi-line pat
3339 colnr_T startcol; // in win_line() points to char where HL starts
3340 colnr_T endcol; // in win_line() points to char where HL ends
Bram Moolenaar693ccd12022-04-16 12:04:37 +01003341 char is_addpos; // position specified directly by
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003342 // matchaddpos(). TRUE/FALSE
Bram Moolenaar693ccd12022-04-16 12:04:37 +01003343 char has_cursor; // TRUE if the cursor is inside the match, used for
3344 // CurSearch
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003345} match_T;
3346
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003347// number of positions supported by matchaddpos()
Bram Moolenaarb3414592014-06-17 17:48:32 +02003348#define MAXPOSMATCH 8
3349
3350/*
3351 * Same as lpos_T, but with additional field len.
3352 */
3353typedef struct
3354{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003355 linenr_T lnum; // line number
3356 colnr_T col; // column number
3357 int len; // length: 0 - to the end of line
Bram Moolenaarb3414592014-06-17 17:48:32 +02003358} llpos_T;
3359
3360/*
3361 * posmatch_T provides an array for storing match items for matchaddpos()
3362 * function.
3363 */
3364typedef struct posmatch posmatch_T;
3365struct posmatch
3366{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003367 llpos_T pos[MAXPOSMATCH]; // array of positions
3368 int cur; // internal position counter
3369 linenr_T toplnum; // top buffer line
3370 linenr_T botlnum; // bottom buffer line
Bram Moolenaarb3414592014-06-17 17:48:32 +02003371};
3372
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003373/*
3374 * matchitem_T provides a linked list for storing match items for ":match" and
3375 * the match functions.
3376 */
3377typedef struct matchitem matchitem_T;
3378struct matchitem
3379{
3380 matchitem_T *next;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003381 int id; // match ID
3382 int priority; // match priority
3383 char_u *pattern; // pattern to highlight
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003384 regmmatch_T match; // regexp program for pattern
3385 posmatch_T pos; // position matches
3386 match_T hl; // struct for doing the actual highlighting
Bram Moolenaard6beab02019-11-10 15:07:19 +01003387 int hlg_id; // highlight group ID
Bram Moolenaar6561d522015-07-21 15:48:27 +02003388#ifdef FEAT_CONCEAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003389 int conceal_char; // cchar for Conceal highlighting
Bram Moolenaar6561d522015-07-21 15:48:27 +02003390#endif
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003391};
3392
Bram Moolenaara68e5952019-04-25 22:22:01 +02003393// Structure to store last cursor position and topline. Used by check_lnums()
3394// and reset_lnums().
3395typedef struct
3396{
3397 int w_topline_save; // original topline value
3398 int w_topline_corr; // corrected topline value
3399 pos_T w_cursor_save; // original cursor position
3400 pos_T w_cursor_corr; // corrected cursor position
3401} pos_save_T;
3402
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02003403#ifdef FEAT_MENU
3404typedef struct {
3405 int wb_startcol;
3406 int wb_endcol;
3407 vimmenu_T *wb_menu;
3408} winbar_item_T;
3409#endif
3410
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003411/*
Bram Moolenaareed9d462021-02-15 20:38:25 +01003412 * Characters from the 'listchars' option
3413 */
3414typedef struct
3415{
3416 int eol;
3417 int ext;
3418 int prec;
3419 int nbsp;
3420 int space;
3421 int tab1;
3422 int tab2;
3423 int tab3;
3424 int trail;
3425 int lead;
zeertzjqf14b8ba2021-09-10 16:58:30 +02003426 int *multispace;
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01003427 int *leadmultispace;
Bram Moolenaareed9d462021-02-15 20:38:25 +01003428#ifdef FEAT_CONCEAL
3429 int conceal;
3430#endif
3431} lcs_chars_T;
3432
3433/*
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003434 * Characters from the 'fillchars' option
3435 */
3436typedef struct
3437{
3438 int stl;
3439 int stlnc;
3440 int vert;
3441 int fold;
3442 int foldopen;
3443 int foldclosed;
3444 int foldsep;
3445 int diff;
3446 int eob;
3447} fill_chars_T;
3448
3449/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 * Structure which contains all information that belongs to a window
3451 *
3452 * All row numbers are relative to the start of the window, except w_winrow.
3453 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003454struct window_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003456 int w_id; // unique window ID
Bram Moolenaar86edef62016-03-13 18:07:30 +01003457
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003458 buf_T *w_buffer; // buffer we are a window into
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003459
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003460 win_T *w_prev; // link to previous window
3461 win_T *w_next; // link to next window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462
Bram Moolenaar860cae12010-06-05 23:22:07 +02003463#if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003464 synblock_T *w_s; // for :ownsyntax
Bram Moolenaar860cae12010-06-05 23:22:07 +02003465#endif
3466
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003467 int w_closing; // window is being closed, don't let
3468 // autocommands close it too.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003470 frame_T *w_frame; // frame containing this window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003472 pos_T w_cursor; // cursor position in buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003474 colnr_T w_curswant; // The column we'd like to be at. This is
3475 // used to try to stay in the same column
3476 // for up/down cursor motions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003478 int w_set_curswant; // If set, then update w_curswant the next
3479 // time through cursupdate() to the
3480 // current virtual column
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481
Bram Moolenaar4a5abbd2018-10-02 18:26:10 +02003482#ifdef FEAT_SYN_HL
3483 linenr_T w_last_cursorline; // where last time 'cursorline' was drawn
3484#endif
3485
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 /*
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003487 * the next seven are used to update the Visual highlighting
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003489 char w_old_visual_mode; // last known VIsual_mode
3490 linenr_T w_old_cursor_lnum; // last known end of visual part
3491 colnr_T w_old_cursor_fcol; // first column for block visual part
3492 colnr_T w_old_cursor_lcol; // last column for block visual part
3493 linenr_T w_old_visual_lnum; // last known start of visual part
3494 colnr_T w_old_visual_col; // last known start of visual part
3495 colnr_T w_old_curswant; // last known value of Curswant
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496
Lewis Russell16246392022-03-29 11:38:17 +01003497 linenr_T w_last_cursor_lnum_rnu; // cursor lnum when 'rnu' was last
3498 // redrawn
3499
Bram Moolenaareed9d462021-02-15 20:38:25 +01003500 lcs_chars_T w_lcs_chars; // 'listchars' characters
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003501 fill_chars_T w_fill_chars; // 'fillchars' characters
Bram Moolenaareed9d462021-02-15 20:38:25 +01003502
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 /*
Bram Moolenaard4153d42008-11-15 15:06:17 +00003504 * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for
3505 * displaying the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003507 linenr_T w_topline; // buffer line number of the line at the
3508 // top of the window
3509 char w_topline_was_set; // flag set to TRUE when topline is set,
3510 // e.g. by winrestview()
Bram Moolenaar6a076442020-11-15 20:32:58 +01003511
3512 linenr_T w_botline; // number of the line below the bottom of
3513 // the window
3514
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515#ifdef FEAT_DIFF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003516 int w_topfill; // number of filler lines above w_topline
3517 int w_old_topfill; // w_topfill at last redraw
3518 int w_botfill; // TRUE when filler lines are actually
3519 // below w_topline (at end of file)
3520 int w_old_botfill; // w_botfill at last redraw
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003522 colnr_T w_leftcol; // window column number of the left most
3523 // character in the window; used when
3524 // 'wrap' is off
3525 colnr_T w_skipcol; // starting column when a single line
3526 // doesn't fit in the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527
Bram Moolenaar6a076442020-11-15 20:32:58 +01003528 int w_empty_rows; // number of ~ rows in window
3529#ifdef FEAT_DIFF
3530 int w_filler_rows; // number of filler rows at the end of the
3531 // window
3532#endif
3533
LemonBoy09371822022-04-08 15:18:45 +01003534 // four fields that are only used when there is a WinScrolled autocommand
3535 linenr_T w_last_topline; // last known value for w_topline
3536 colnr_T w_last_leftcol; // last known value for w_leftcol
3537 int w_last_width; // last known value for w_width
3538 int w_last_height; // last known value for w_height
3539
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 /*
3541 * Layout of the window in the screen.
3542 * May need to add "msg_scrolled" to "w_winrow" in rare situations.
3543 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003544 int w_winrow; // first row of window in screen
3545 int w_height; // number of rows in window, excluding
3546 // status/command/winbar line(s)
Bram Moolenaar6a076442020-11-15 20:32:58 +01003547
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003548 int w_status_height; // number of status lines (0 or 1)
3549 int w_wincol; // Leftmost column of window in screen.
3550 int w_width; // Width of window, excluding separation.
3551 int w_vsep_width; // Number of separator columns (0 or 1).
Bram Moolenaar6a076442020-11-15 20:32:58 +01003552
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003553 pos_save_T w_save_cursor; // backup of cursor pos and topline
Bram Moolenaar6a076442020-11-15 20:32:58 +01003554
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003555#ifdef FEAT_PROP_POPUP
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02003556 int w_popup_flags; // POPF_ values
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003557 int w_popup_handled; // POPUP_HANDLE[0-9] flags
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003558 char_u *w_popup_title;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02003559 poppos_T w_popup_pos;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02003560 int w_popup_fixed; // do not shift popup to fit on screen
Bram Moolenaar12034e22019-08-25 22:25:02 +02003561 int w_popup_prop_type; // when not zero: textprop type ID
3562 win_T *w_popup_prop_win; // window to search for textprop
3563 int w_popup_prop_id; // when not zero: textprop ID
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003564 int w_zindex;
Bram Moolenaar60cdb302019-05-27 21:54:10 +02003565 int w_minheight; // "minheight" for popup window
3566 int w_minwidth; // "minwidth" for popup window
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003567 int w_maxheight; // "maxheight" for popup window
3568 int w_maxwidth; // "maxwidth" for popup window
Bram Moolenaarde2396f2020-07-18 21:40:41 +02003569 int w_maxwidth_opt; // maxwidth from option
Bram Moolenaar60cdb302019-05-27 21:54:10 +02003570 int w_wantline; // "line" for popup window
3571 int w_wantcol; // "col" for popup window
Bram Moolenaar8d241042019-06-12 23:40:01 +02003572 int w_firstline; // "firstline" for popup window
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003573 int w_want_scrollbar; // when zero don't use a scrollbar
Bram Moolenaarf9c85f52019-06-29 07:41:35 +02003574 int w_has_scrollbar; // 1 if scrollbar displayed, 0 otherwise
Bram Moolenaar4cd583c2019-06-26 05:13:57 +02003575 char_u *w_scrollbar_highlight; // "scrollbarhighlight"
3576 char_u *w_thumb_highlight; // "thumbhighlight"
Bram Moolenaar2fd8e352019-06-01 20:16:48 +02003577 int w_popup_padding[4]; // popup padding top/right/bot/left
3578 int w_popup_border[4]; // popup border top/right/bot/left
Bram Moolenaar790498b2019-06-01 22:15:29 +02003579 char_u *w_border_highlight[4]; // popup border highlight
3580 int w_border_char[8]; // popup border characters
Bram Moolenaard529ba52019-07-02 23:13:53 +02003581
3582 int w_popup_leftoff; // columns left of the screen
3583 int w_popup_rightoff; // columns right of the screen
Bram Moolenaar12034e22019-08-25 22:25:02 +02003584 varnumber_T w_popup_last_changedtick; // b:changedtick of popup buffer
3585 // when position was computed
3586 varnumber_T w_popup_prop_changedtick; // b:changedtick of buffer with
3587 // w_popup_prop_type when position
3588 // was computed
3589 int w_popup_prop_topline; // w_topline of window with
3590 // w_popup_prop_type when position was
3591 // computed
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +02003592 linenr_T w_popup_last_curline; // last known w_cursor.lnum of window
3593 // with "cursorline" set
Bram Moolenaar9eaac892019-06-01 22:49:29 +02003594 callback_T w_close_cb; // popup close callback
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003595 callback_T w_filter_cb; // popup filter callback
Bram Moolenaar6defa7b2020-09-08 22:06:44 +02003596 int w_filter_errors; // popup filter error count
Bram Moolenaar581ba392019-09-03 22:08:33 +02003597 int w_filter_mode; // mode when filter callback is used
Bram Moolenaar3397f742019-06-02 18:40:06 +02003598
3599 win_T *w_popup_curwin; // close popup if curwin differs
3600 linenr_T w_popup_lnum; // close popup if cursor not on this line
3601 colnr_T w_popup_mincol; // close popup if cursor before this col
3602 colnr_T w_popup_maxcol; // close popup if cursor after this col
Bram Moolenaar56a63122019-07-07 18:38:34 +02003603 int w_popup_mouse_row; // close popup if mouse moves away
3604 int w_popup_mouse_mincol; // close popup if mouse moves away
3605 int w_popup_mouse_maxcol; // close popup if mouse moves away
Bram Moolenaar2e62b562019-06-30 18:07:00 +02003606 popclose_T w_popup_close; // allow closing the popup with the mouse
Bram Moolenaar3397f742019-06-02 18:40:06 +02003607
Bram Moolenaar4f0d0022019-07-26 22:20:03 +02003608 list_T *w_popup_mask; // list of lists for "mask"
3609 char_u *w_popup_mask_cells; // cached mask cells
3610 int w_popup_mask_height; // height of w_popup_mask_cells
3611 int w_popup_mask_width; // width of w_popup_mask_cells
Bram Moolenaar35d5af62019-05-26 20:44:10 +02003612# if defined(FEAT_TIMERS)
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02003613 timer_T *w_popup_timer; // timer for closing popup window
Bram Moolenaar35d5af62019-05-26 20:44:10 +02003614# endif
Bram Moolenaara68e5952019-04-25 22:22:01 +02003615
Bram Moolenaar6a076442020-11-15 20:32:58 +01003616 int w_flags; // WFLAG_ flags
3617
3618# define WFLAG_WCOL_OFF_ADDED 1 // popup border and padding were added to
3619 // w_wcol
3620# define WFLAG_WROW_OFF_ADDED 2 // popup border and padding were added to
3621 // w_wrow
3622#endif
Bram Moolenaare0de17d2017-09-24 16:24:34 +02003623
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 /*
3625 * === start of cached values ====
3626 */
3627 /*
3628 * Recomputing is minimized by storing the result of computations.
3629 * Use functions in screen.c to check if they are valid and to update.
3630 * w_valid is a bitfield of flags, which indicate if specific values are
3631 * valid or need to be recomputed. See screen.c for values.
3632 */
3633 int w_valid;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003634 pos_T w_valid_cursor; // last known position of w_cursor, used
3635 // to adjust w_valid
3636 colnr_T w_valid_leftcol; // last known w_leftcol
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637
3638 /*
3639 * w_cline_height is the number of physical lines taken by the buffer line
3640 * that the cursor is on. We use this to avoid extra calls to plines().
3641 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003642 int w_cline_height; // current size of cursor line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643#ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003644 int w_cline_folded; // cursor line is folded
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645#endif
3646
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003647 int w_cline_row; // starting row of the cursor line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003649 colnr_T w_virtcol; // column number of the cursor in the
3650 // buffer line, as opposed to the column
3651 // number we're at on the screen. This
3652 // makes a difference on lines which span
3653 // more than one screen line or when
3654 // w_leftcol is non-zero
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655
3656 /*
3657 * w_wrow and w_wcol specify the cursor position in the window.
3658 * This is related to positions in the window, not in the display or
3659 * buffer, thus w_wrow is relative to w_winrow.
3660 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003661 int w_wrow, w_wcol; // cursor position in window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 /*
3664 * Info about the lines currently in the window is remembered to avoid
3665 * recomputing it every time. The allocated size of w_lines[] is Rows.
3666 * Only the w_lines_valid entries are actually valid.
3667 * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
3668 * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
3669 * Between changing text and updating the display w_lines[] represents
3670 * what is currently displayed. wl_valid is reset to indicated this.
3671 * This is used for efficient redrawing.
3672 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003673 int w_lines_valid; // number of valid entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 wline_T *w_lines;
3675
3676#ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003677 garray_T w_folds; // array of nested folds
3678 char w_fold_manual; // when TRUE: some folds are opened/closed
3679 // manually
3680 char w_foldinvalid; // when TRUE: folding needs to be
3681 // recomputed
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003683#ifdef FEAT_LINEBREAK
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003684 int w_nrwidth; // width of 'number' and 'relativenumber'
3685 // column being used
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003686#endif
Bram Moolenaar87fd0922021-11-20 13:47:45 +00003687#ifdef FEAT_TERMINAL
3688 termcellcolor_T w_term_wincolor; // cache for term color of 'wincolor'
3689#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690
3691 /*
3692 * === end of cached values ===
3693 */
3694
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003695 int w_redr_type; // type of redraw to be performed on win
3696 int w_upd_rows; // number of window lines to update when
3697 // w_redr_type is REDRAW_TOP
3698 linenr_T w_redraw_top; // when != 0: first line needing redraw
3699 linenr_T w_redraw_bot; // when != 0: last line needing redraw
3700 int w_redr_status; // if TRUE status line must be redrawn
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701
3702#ifdef FEAT_CMDL_INFO
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003703 // remember what is shown in the ruler for this window (if 'ruler' set)
3704 pos_T w_ru_cursor; // cursor position shown in ruler
3705 colnr_T w_ru_virtcol; // virtcol shown in ruler
3706 linenr_T w_ru_topline; // topline shown in ruler
3707 linenr_T w_ru_line_count; // line count used for ruler
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708# ifdef FEAT_DIFF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003709 int w_ru_topfill; // topfill shown in ruler
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710# endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003711 char w_ru_empty; // TRUE if ruler shows 0-1 (empty line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712#endif
3713
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003714 int w_alt_fnum; // alternate file (for # and CTRL-^)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003716 alist_T *w_alist; // pointer to arglist for this window
3717 int w_arg_idx; // current index in argument list (can be
3718 // out of range!)
3719 int w_arg_idx_invalid; // editing another file than w_arg_idx
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003721 char_u *w_localdir; // absolute path of local directory or
3722 // NULL
Bram Moolenaar002bc792020-06-05 22:33:42 +02003723 char_u *w_prevdir; // previous directory
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02003724#ifdef FEAT_MENU
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003725 vimmenu_T *w_winbar; // The root of the WinBar menu hierarchy.
3726 winbar_item_T *w_winbar_items; // list of items in the WinBar
3727 int w_winbar_height; // 1 if there is a window toolbar
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02003728#endif
3729
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 /*
3731 * Options local to a window.
3732 * They are local because they influence the layout of the window or
3733 * depend on the window layout.
3734 * There are two values: w_onebuf_opt is local to the buffer currently in
3735 * this window, w_allbuf_opt is for all buffers in this window.
3736 */
3737 winopt_T w_onebuf_opt;
3738 winopt_T w_allbuf_opt;
Bram Moolenaare70dd112022-01-21 16:31:11 +00003739 // transform a pointer to a "onebuf" option into a "allbuf" option
kylo2529dac9b12022-03-27 20:05:17 +01003740#define GLOBAL_WO(p) ((char *)(p) + sizeof(winopt_T))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003742 // A few options have local flags for P_INSECURE.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003743#ifdef FEAT_STL_OPT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003744 long_u w_p_stl_flags; // flags for 'statusline'
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003745#endif
3746#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003747 long_u w_p_fde_flags; // flags for 'foldexpr'
3748 long_u w_p_fdt_flags; // flags for 'foldtext'
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003749#endif
Bram Moolenaar1a384422010-07-14 19:53:30 +02003750#ifdef FEAT_SYN_HL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003751 int *w_p_cc_cols; // array of columns to highlight or NULL
Bram Moolenaar017ba072019-09-14 21:01:23 +02003752 char_u w_p_culopt_flags; // flags for cursorline highlighting
Bram Moolenaar1a384422010-07-14 19:53:30 +02003753#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003754 long w_p_siso; // 'sidescrolloff' local value
3755 long w_p_so; // 'scrolloff' local value
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003756
Bram Moolenaarb81f56f2020-02-23 15:29:46 +01003757#ifdef FEAT_LINEBREAK
3758 int w_briopt_min; // minimum width for breakindent
3759 int w_briopt_shift; // additional shift for breakindent
3760 int w_briopt_sbr; // sbr in 'briopt'
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02003761 int w_briopt_list; // additional indent for lists
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01003762 int w_briopt_vcol; // indent for specific column
Bram Moolenaarb81f56f2020-02-23 15:29:46 +01003763#endif
3764
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 long w_scbind_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766
3767#ifdef FEAT_EVAL
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02003768 dictitem_T w_winvar; // variable for "w:" Dictionary
3769 dict_T *w_vars; // internal variables, local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770#endif
3771
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 /*
3773 * The w_prev_pcmark field is used to check whether we really did jump to
3774 * a new line after setting the w_pcmark. If not, then we revert to
3775 * using the previous w_pcmark.
3776 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003777 pos_T w_pcmark; // previous context mark
3778 pos_T w_prev_pcmark; // previous w_pcmark
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 /*
3781 * the jumplist contains old cursor positions
3782 */
3783 xfmark_T w_jumplist[JUMPLISTSIZE];
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003784 int w_jumplistlen; // number of active entries
3785 int w_jumplistidx; // current position
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003787 int w_changelistidx; // current position in b_changelist
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788
3789#ifdef FEAT_SEARCH_EXTRA
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003790 matchitem_T *w_match_head; // head of match list
3791 int w_next_match_id; // next match ID
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792#endif
3793
3794 /*
3795 * the tagstack grows from 0 upwards:
3796 * entry 0: older
3797 * entry 1: newer
3798 * entry 2: newest
3799 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003800 taggy_T w_tagstack[TAGSTACKSIZE]; // the tag stack
3801 int w_tagstackidx; // idx just below active entry
3802 int w_tagstacklen; // number of tags on stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803
3804 /*
3805 * w_fraction is the fractional row of the cursor within the window, from
3806 * 0 at the top row to FRACTION_MULT at the last row.
3807 * w_prev_fraction_row was the actual cursor row when w_fraction was last
3808 * calculated.
3809 */
3810 int w_fraction;
3811 int w_prev_fraction_row;
3812
3813#ifdef FEAT_GUI
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003814 scrollbar_T w_scrollbars[2]; // vert. Scrollbars for this window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003816#ifdef FEAT_LINEBREAK
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003817 linenr_T w_nrwidth_line_count; // line count when ml_nrwidth_width
3818 // was computed.
3819 long w_nuw_cached; // 'numberwidth' option cached
3820 int w_nrwidth_width; // nr of chars to print line count.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003821#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003823#ifdef FEAT_QUICKFIX
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003824 qf_info_T *w_llist; // Location list for this window
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003825 /*
3826 * Location list reference used in the location list window.
3827 * In a non-location list window, w_llist_ref is NULL.
3828 */
3829 qf_info_T *w_llist_ref;
3830#endif
3831
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003832#ifdef FEAT_MZSCHEME
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003833 void *w_mzscheme_ref; // The MzScheme value for this window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003834#endif
3835
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836#ifdef FEAT_PERL
Bram Moolenaare344bea2005-09-01 20:46:49 +00003837 void *w_perl_private;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838#endif
3839
3840#ifdef FEAT_PYTHON
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003841 void *w_python_ref; // The Python value for this window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842#endif
3843
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02003844#ifdef FEAT_PYTHON3
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003845 void *w_python3_ref; // The Python value for this window
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02003846#endif
3847
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848#ifdef FEAT_TCL
Bram Moolenaare344bea2005-09-01 20:46:49 +00003849 void *w_tcl_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850#endif
3851
3852#ifdef FEAT_RUBY
Bram Moolenaare344bea2005-09-01 20:46:49 +00003853 void *w_ruby_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854#endif
3855};
3856
3857/*
3858 * Arguments for operators.
3859 */
Bram Moolenaare344bea2005-09-01 20:46:49 +00003860typedef struct oparg_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003862 int op_type; // current pending operator type
3863 int regname; // register to use for the operator
3864 int motion_type; // type of the current cursor motion
3865 int motion_force; // force motion type: 'v', 'V' or CTRL-V
3866 int use_reg_one; // TRUE if delete uses reg 1 even when not
3867 // linewise
3868 int inclusive; // TRUE if char motion is inclusive (only
Christian Brabandt544a38e2021-06-10 19:39:11 +02003869 // valid when motion_type is MCHAR)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003870 int end_adjusted; // backuped b_op_end one char (only used by
3871 // do_format())
3872 pos_T start; // start of the operator
3873 pos_T end; // end of the operator
3874 pos_T cursor_start; // cursor position before motion for "gw"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003876 long line_count; // number of lines from op_start to op_end
3877 // (inclusive)
3878 int empty; // op_start and op_end the same (only used by
3879 // do_change())
3880 int is_VIsual; // operator on Visual area
3881 int block_mode; // current operator is Visual block mode
3882 colnr_T start_vcol; // start col for block mode operator
3883 colnr_T end_vcol; // end col for block mode operator
3884 long prev_opcount; // ca.opcount saved for K_CURSORHOLD
3885 long prev_count0; // ca.count0 saved for K_CURSORHOLD
Christian Brabandt544a38e2021-06-10 19:39:11 +02003886 int excl_tr_ws; // exclude trailing whitespace for yank of a
3887 // block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888} oparg_T;
3889
3890/*
3891 * Arguments for Normal mode commands.
3892 */
Bram Moolenaare344bea2005-09-01 20:46:49 +00003893typedef struct cmdarg_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003895 oparg_T *oap; // Operator arguments
3896 int prechar; // prefix character (optional, always 'g')
3897 int cmdchar; // command character
3898 int nchar; // next command character (optional)
3899 int ncharC1; // first composing character (optional)
3900 int ncharC2; // second composing character (optional)
3901 int extra_char; // yet another character (optional)
3902 long opcount; // count before an operator
3903 long count0; // count before command, default 0
3904 long count1; // count before command, default 1
3905 int arg; // extra argument from nv_cmds[]
3906 int retval; // return: CA_* values
3907 char_u *searchbuf; // return: pointer to search pattern or NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908} cmdarg_T;
3909
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003910// values for retval:
3911#define CA_COMMAND_BUSY 1 // skip restarting edit() once
3912#define CA_NO_ADJ_OP_END 2 // don't adjust operator end
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913
3914#ifdef CURSOR_SHAPE
3915/*
3916 * struct to store values from 'guicursor' and 'mouseshape'
3917 */
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01003918// Indexes in shape_table[]
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003919#define SHAPE_IDX_N 0 // Normal mode
3920#define SHAPE_IDX_V 1 // Visual mode
3921#define SHAPE_IDX_I 2 // Insert mode
3922#define SHAPE_IDX_R 3 // Replace mode
3923#define SHAPE_IDX_C 4 // Command line Normal mode
3924#define SHAPE_IDX_CI 5 // Command line Insert mode
3925#define SHAPE_IDX_CR 6 // Command line Replace mode
3926#define SHAPE_IDX_O 7 // Operator-pending mode
3927#define SHAPE_IDX_VE 8 // Visual mode with 'selection' exclusive
3928#define SHAPE_IDX_CLINE 9 // On command line
3929#define SHAPE_IDX_STATUS 10 // A status line
3930#define SHAPE_IDX_SDRAG 11 // dragging a status line
3931#define SHAPE_IDX_VSEP 12 // A vertical separator line
3932#define SHAPE_IDX_VDRAG 13 // dragging a vertical separator line
3933#define SHAPE_IDX_MORE 14 // Hit-return or More
3934#define SHAPE_IDX_MOREL 15 // Hit-return or More in last line
3935#define SHAPE_IDX_SM 16 // showing matching paren
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936#define SHAPE_IDX_COUNT 17
3937
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003938#define SHAPE_BLOCK 0 // block cursor
3939#define SHAPE_HOR 1 // horizontal bar cursor
3940#define SHAPE_VER 2 // vertical bar cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003942#define MSHAPE_NUMBERED 1000 // offset for shapes identified by number
3943#define MSHAPE_HIDE 1 // hide mouse pointer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003945#define SHAPE_MOUSE 1 // used for mouse pointer shape
3946#define SHAPE_CURSOR 2 // used for text cursor shape
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947
3948typedef struct cursor_entry
3949{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003950 int shape; // one of the SHAPE_ defines
3951 int mshape; // one of the MSHAPE defines
3952 int percentage; // percentage of cell for bar
3953 long blinkwait; // blinking, wait time before blinking starts
3954 long blinkon; // blinking, on time
3955 long blinkoff; // blinking, off time
3956 int id; // highlight group ID
3957 int id_lm; // highlight group ID for :lmap mode
3958 char *name; // mode name (fixed)
3959 char used_for; // SHAPE_MOUSE and/or SHAPE_CURSOR
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960} cursorentry_T;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003961#endif // CURSOR_SHAPE
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962
3963#ifdef FEAT_MENU
3964
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003965// Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966#define MENU_INDEX_INVALID -1
3967#define MENU_INDEX_NORMAL 0
3968#define MENU_INDEX_VISUAL 1
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003969#define MENU_INDEX_SELECT 2
3970#define MENU_INDEX_OP_PENDING 3
3971#define MENU_INDEX_INSERT 4
3972#define MENU_INDEX_CMDLINE 5
Bram Moolenaar4c5d8152018-10-19 22:36:53 +02003973#define MENU_INDEX_TERMINAL 6
3974#define MENU_INDEX_TIP 7
3975#define MENU_MODES 8
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003977// Menu modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978#define MENU_NORMAL_MODE (1 << MENU_INDEX_NORMAL)
3979#define MENU_VISUAL_MODE (1 << MENU_INDEX_VISUAL)
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003980#define MENU_SELECT_MODE (1 << MENU_INDEX_SELECT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981#define MENU_OP_PENDING_MODE (1 << MENU_INDEX_OP_PENDING)
3982#define MENU_INSERT_MODE (1 << MENU_INDEX_INSERT)
3983#define MENU_CMDLINE_MODE (1 << MENU_INDEX_CMDLINE)
Bram Moolenaar4c5d8152018-10-19 22:36:53 +02003984#define MENU_TERMINAL_MODE (1 << MENU_INDEX_TERMINAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985#define MENU_TIP_MODE (1 << MENU_INDEX_TIP)
3986#define MENU_ALL_MODES ((1 << MENU_INDEX_TIP) - 1)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003987// note MENU_INDEX_TIP is not a 'real' mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003989// Start a menu name with this to not include it on the main menu bar
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990#define MNU_HIDDEN_CHAR ']'
3991
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992struct VimMenu
3993{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003994 int modes; // Which modes is this menu visible for?
3995 int enabled; // for which modes the menu is enabled
3996 char_u *name; // Name of menu, possibly translated
3997 char_u *dname; // Displayed Name ("name" without '&')
Bram Moolenaar70b11cd2010-05-14 22:24:40 +02003998#ifdef FEAT_MULTI_LANG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003999 char_u *en_name; // "name" untranslated, NULL when "name"
4000 // was not translated
4001 char_u *en_dname; // "dname" untranslated, NULL when "dname"
4002 // was not translated
Bram Moolenaar70b11cd2010-05-14 22:24:40 +02004003#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004004 char_u *actext; // accelerator text (after TAB)
Dominique Pelle3276f582021-08-07 12:44:41 +02004005 int mnemonic; // mnemonic key (after '&')
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004006 int priority; // Menu order priority
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007#ifdef FEAT_GUI
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004008 void (*cb)(vimmenu_T *); // Call-back function
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009#endif
4010#ifdef FEAT_TOOLBAR
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004011 char_u *iconfile; // name of file for icon or NULL
4012 int iconidx; // icon index (-1 if not set)
4013 int icon_builtin; // icon names is BuiltIn{nr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004015 char_u *strings[MENU_MODES]; // Mapped string for each mode
4016 int noremap[MENU_MODES]; // A REMAP_ flag for each mode
4017 char silent[MENU_MODES]; // A silent flag for each mode
4018 vimmenu_T *children; // Children of sub-menu
4019 vimmenu_T *parent; // Parent of menu
4020 vimmenu_T *next; // Next item in menu
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021#ifdef FEAT_GUI_X11
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004022 Widget id; // Manage this to enable item
4023 Widget submenu_id; // If this is submenu, add children here
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025#ifdef FEAT_GUI_GTK
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004026 GtkWidget *id; // Manage this to enable item
4027 GtkWidget *submenu_id; // If this is submenu, add children here
Bram Moolenaar98921892016-02-23 17:14:37 +01004028# if defined(GTK_CHECK_VERSION) && !GTK_CHECK_VERSION(3,4,0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 GtkWidget *tearoff_handle;
Bram Moolenaar98921892016-02-23 17:14:37 +01004030# endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004031 GtkWidget *label; // Used by "set wak=" code.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032#endif
4033#ifdef FEAT_GUI_MOTIF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004034 int sensitive; // turn button on/off
4035 char **xpm; // pixmap data
4036 char *xpm_fname; // file with pixmap data
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038#ifdef FEAT_BEVAL_TIP
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004039 BalloonEval *tip; // tooltip for this menu item
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01004041#ifdef FEAT_GUI_MSWIN
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004042 UINT id; // Id of menu item
4043 HMENU submenu_id; // If this is submenu, add children here
4044 HWND tearoff_handle; // hWnd of tearoff if created
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045#endif
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004046#if FEAT_GUI_HAIKU
4047 BMenuItem *id; // Id of menu item
4048 BMenu *submenu_id; // If this is submenu, add children here
4049# ifdef FEAT_TOOLBAR
4050 BPictureButton *button;
4051# endif
4052#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053#ifdef FEAT_GUI_PHOTON
4054 PtWidget_t *id;
4055 PtWidget_t *submenu_id;
4056#endif
4057};
4058#else
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004059// For generating prototypes when FEAT_MENU isn't defined.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060typedef int vimmenu_T;
4061
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004062#endif // FEAT_MENU
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063
4064/*
4065 * Struct to save values in before executing autocommands for a buffer that is
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004066 * not the current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 */
4068typedef struct
4069{
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01004070 buf_T *save_curbuf; // saved curbuf
4071 int use_aucmd_win; // using aucmd_win
4072 int save_curwin_id; // ID of saved curwin
4073 int new_curwin_id; // ID of new curwin
4074 int save_prevwin_id; // ID of saved prevwin
4075 bufref_T new_curbuf; // new curbuf
4076 char_u *globaldir; // saved value of globaldir
Bram Moolenaarcb1956d2022-01-07 15:45:18 +00004077 int save_VIsual_active; // saved VIsual_active
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078} aco_save_T;
4079
4080/*
4081 * Generic option table item, only used for printer at the moment.
4082 */
4083typedef struct
4084{
4085 const char *name;
4086 int hasnum;
4087 long number;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004088 char_u *string; // points into option string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 int strlen;
4090 int present;
4091} option_table_T;
4092
4093/*
4094 * Structure to hold printing color and font attributes.
4095 */
4096typedef struct
4097{
4098 long_u fg_color;
4099 long_u bg_color;
4100 int bold;
4101 int italic;
4102 int underline;
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004103 int undercurl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104} prt_text_attr_T;
4105
4106/*
4107 * Structure passed back to the generic printer code.
4108 */
4109typedef struct
4110{
4111 int n_collated_copies;
4112 int n_uncollated_copies;
4113 int duplex;
4114 int chars_per_line;
4115 int lines_per_page;
4116 int has_color;
4117 prt_text_attr_T number;
4118#ifdef FEAT_SYN_HL
4119 int modec;
4120 int do_syntax;
4121#endif
4122 int user_abort;
4123 char_u *jobname;
4124#ifdef FEAT_POSTSCRIPT
4125 char_u *outfile;
4126 char_u *arguments;
4127#endif
4128} prt_settings_T;
4129
4130#define PRINT_NUMBER_WIDTH 8
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00004131
4132/*
4133 * Used for popup menu items.
4134 */
4135typedef struct
4136{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004137 char_u *pum_text; // main menu text
4138 char_u *pum_kind; // extra kind text (may be truncated)
4139 char_u *pum_extra; // extra menu text (may be truncated)
4140 char_u *pum_info; // extra info
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00004141} pumitem_T;
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004142
4143/*
4144 * Structure used for get_tagfname().
4145 */
4146typedef struct
4147{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004148 char_u *tn_tags; // value of 'tags' when starting
4149 char_u *tn_np; // current position in tn_tags
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004150 int tn_did_filefind_init;
4151 int tn_hf_idx;
4152 void *tn_search_ctx;
4153} tagname_T;
4154
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004155typedef struct {
4156 UINT32_T total[2];
4157 UINT32_T state[8];
4158 char_u buffer[64];
4159} context_sha256_T;
Bram Moolenaar520e1e42016-01-23 19:46:28 +01004160
4161/*
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004162 * types for expressions.
4163 */
4164typedef enum
4165{
Bram Moolenaar87396072019-12-31 22:36:18 +01004166 EXPR_UNKNOWN = 0,
4167 EXPR_EQUAL, // ==
4168 EXPR_NEQUAL, // !=
4169 EXPR_GREATER, // >
4170 EXPR_GEQUAL, // >=
4171 EXPR_SMALLER, // <
4172 EXPR_SEQUAL, // <=
4173 EXPR_MATCH, // =~
4174 EXPR_NOMATCH, // !~
4175 EXPR_IS, // is
4176 EXPR_ISNOT, // isnot
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004177 // used with ISN_OPNR
4178 EXPR_ADD, // +
4179 EXPR_SUB, // -
4180 EXPR_MULT, // *
4181 EXPR_DIV, // /
4182 EXPR_REM, // %
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01004183 EXPR_LSHIFT, // <<
4184 EXPR_RSHIFT, // >>
Bram Moolenaar07802042021-09-09 23:01:14 +02004185 // used with ISN_ADDLIST
4186 EXPR_COPY, // create new list
4187 EXPR_APPEND, // append to first list
Bram Moolenaar657137c2021-01-09 15:45:23 +01004188} exprtype_T;
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004189
4190/*
Bram Moolenaar520e1e42016-01-23 19:46:28 +01004191 * Structure used for reading in json_decode().
4192 */
Bram Moolenaar56ead342016-02-02 18:20:08 +01004193struct js_reader
Bram Moolenaar520e1e42016-01-23 19:46:28 +01004194{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004195 char_u *js_buf; // text to be decoded
4196 char_u *js_end; // NUL in js_buf
4197 int js_used; // bytes used from js_buf
Bram Moolenaar56ead342016-02-02 18:20:08 +01004198 int (*js_fill)(struct js_reader *);
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004199 // function to fill the buffer or NULL;
4200 // return TRUE when the buffer was filled
4201 void *js_cookie; // can be used by js_fill
4202 int js_cookie_arg; // can be used by js_fill
Bram Moolenaar56ead342016-02-02 18:20:08 +01004203};
4204typedef struct js_reader js_read_T;
Bram Moolenaar975b5272016-03-15 23:10:59 +01004205
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004206// Maximum number of commands from + or -c arguments.
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004207#define MAX_ARG_CMDS 10
4208
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004209// values for "window_layout"
4210#define WIN_HOR 1 // "-o" horizontally split windows
4211#define WIN_VER 2 // "-O" vertically split windows
4212#define WIN_TABS 3 // "-p" windows on tab pages
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004213
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004214// Struct for various parameters passed between main() and other functions.
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004215typedef struct
4216{
4217 int argc;
4218 char **argv;
4219
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004220 char_u *fname; // first file to edit
Bram Moolenaara8e691d2016-08-07 15:19:26 +02004221
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004222 int evim_mode; // started as "evim"
4223 char_u *use_vimrc; // vimrc from -u argument
4224 int clean; // --clean argument
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004225
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004226 int n_commands; // no. of commands from + or -c
4227 char_u *commands[MAX_ARG_CMDS]; // commands from + or -c arg.
4228 char_u cmds_tofree[MAX_ARG_CMDS]; // commands that need free()
4229 int n_pre_commands; // no. of commands from --cmd
4230 char_u *pre_commands[MAX_ARG_CMDS]; // commands from --cmd argument
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004231
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004232 int edit_type; // type of editing to do
4233 char_u *tagname; // tag from -t argument
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004234#ifdef FEAT_QUICKFIX
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004235 char_u *use_ef; // 'errorfile' from -q argument
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004236#endif
4237
4238 int want_full_screen;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004239 int not_a_term; // no warning for missing term?
Bram Moolenaar2d12c252022-06-13 21:42:45 +01004240#ifdef FEAT_GUI
4241 char_u *gui_dialog_file; // file to write dialog text in
4242#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004243 int tty_fail; // exit if not a tty
4244 char_u *term; // specified terminal name
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004245#ifdef FEAT_CRYPT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004246 int ask_for_key; // -x argument
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004247#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004248 int no_swap_file; // "-n" argument used
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004249#ifdef FEAT_EVAL
4250 int use_debug_break_level;
4251#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004252 int window_count; // number of windows to use
4253 int window_layout; // 0, WIN_HOR, WIN_VER or WIN_TABS
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004254
4255#ifdef FEAT_CLIENTSERVER
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004256 int serverArg; // TRUE when argument for a server
4257 char_u *serverName_arg; // cmdline arg for server name
4258 char_u *serverStr; // remote server command
4259 char_u *serverStrEnc; // encoding of serverStr
4260 char_u *servername; // allocated name for our server
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004261#endif
4262#if !defined(UNIX)
4263# define EXPAND_FILENAMES
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004264 int literal; // don't expand file names
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004265#endif
4266#ifdef MSWIN
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004267 int full_path; // file name argument was full path
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004268#endif
4269#ifdef FEAT_DIFF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004270 int diff_mode; // start with 'diff' set
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02004271#endif
4272} mparm_T;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273
4274/*
4275 * Structure returned by get_lval() and used by set_var_lval().
4276 * For a plain name:
4277 * "name" points to the variable name.
4278 * "exp_name" is NULL.
4279 * "tv" is NULL
4280 * For a magic braces name:
4281 * "name" points to the expanded variable name.
4282 * "exp_name" is non-NULL, to be freed later.
4283 * "tv" is NULL
4284 * For an index in a list:
4285 * "name" points to the (expanded) variable name.
4286 * "exp_name" NULL or non-NULL, to be freed later.
4287 * "tv" points to the (first) list item value
4288 * "li" points to the (first) list item
4289 * "range", "n1", "n2" and "empty2" indicate what items are used.
4290 * For an existing Dict item:
4291 * "name" points to the (expanded) variable name.
4292 * "exp_name" NULL or non-NULL, to be freed later.
4293 * "tv" points to the dict item value
4294 * "newkey" is NULL
4295 * For a non-existing Dict item:
4296 * "name" points to the (expanded) variable name.
4297 * "exp_name" NULL or non-NULL, to be freed later.
4298 * "tv" points to the Dictionary typval_T
4299 * "newkey" is the key for the new item.
4300 */
4301typedef struct lval_S
4302{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004303 char_u *ll_name; // start of variable name (can be NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004304 char_u *ll_name_end; // end of variable name (can be NULL)
4305 type_T *ll_type; // type of variable (can be NULL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004306 char_u *ll_exp_name; // NULL or expanded name in allocated memory.
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004307
4308 scid_T ll_sid; // for an imported item: the script ID it was
4309 // imported from; zero otherwise
4310
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004311 typval_T *ll_tv; // Typeval of item being used. If "newkey"
4312 // isn't NULL it's the Dict to which to add
4313 // the item.
4314 listitem_T *ll_li; // The list item or NULL.
4315 list_T *ll_list; // The list or NULL.
4316 int ll_range; // TRUE when a [i:j] range was used
Bram Moolenaard6beab02019-11-10 15:07:19 +01004317 int ll_empty2; // Second index is empty: [i:]
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004318 long ll_n1; // First index for list
4319 long ll_n2; // Second index for list range
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004320 dict_T *ll_dict; // The Dictionary or NULL
4321 dictitem_T *ll_di; // The dictitem or NULL
4322 char_u *ll_newkey; // New key for Dict in alloc. mem or NULL.
Bram Moolenaar10c65862020-10-08 21:16:42 +02004323 type_T *ll_valtype; // type expected for the value or NULL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004324 blob_T *ll_blob; // The Blob or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325} lval_T;
Bram Moolenaara21a6a92017-09-23 16:33:50 +02004326
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02004327// Structure used to save the current state. Used when executing Normal mode
4328// commands while in any other mode.
Bram Moolenaara21a6a92017-09-23 16:33:50 +02004329typedef struct {
4330 int save_msg_scroll;
4331 int save_restart_edit;
4332 int save_msg_didout;
4333 int save_State;
4334 int save_insertmode;
4335 int save_finish_op;
4336 int save_opcount;
Bram Moolenaarcce713d2019-03-04 11:40:12 +01004337 int save_reg_executing;
zeertzjq6d4e7252022-04-07 13:58:04 +01004338 int save_pending_end_reg_executing;
Bram Moolenaar4324d872020-12-01 20:12:24 +01004339 int save_script_version;
Bram Moolenaara21a6a92017-09-23 16:33:50 +02004340 tasave_T tabuf;
4341} save_state_T;
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02004342
4343typedef struct {
4344 varnumber_T vv_prevcount;
4345 varnumber_T vv_count;
4346 varnumber_T vv_count1;
4347} vimvars_save_T;
Bram Moolenaar1063f3d2019-05-07 22:06:52 +02004348
4349// Scope for changing directory
4350typedef enum {
4351 CDSCOPE_GLOBAL, // :cd
4352 CDSCOPE_TABPAGE, // :tcd
4353 CDSCOPE_WINDOW // :lcd
4354} cdscope_T;
Bram Moolenaar451d4b52019-06-12 20:22:27 +02004355
Bram Moolenaardefa0672019-07-21 19:25:37 +02004356// Variable flavor
4357typedef enum
4358{
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02004359 VAR_FLAVOUR_DEFAULT, // doesn't start with uppercase
4360 VAR_FLAVOUR_SESSION, // starts with uppercase, some lower
4361 VAR_FLAVOUR_VIMINFO // all uppercase
Bram Moolenaardefa0672019-07-21 19:25:37 +02004362} var_flavour_T;
4363
Bram Moolenaar451d4b52019-06-12 20:22:27 +02004364// argument for mouse_find_win()
4365typedef enum {
4366 IGNORE_POPUP, // only check non-popup windows
4367 FIND_POPUP, // also find popup windows
4368 FAIL_POPUP // return NULL if mouse on popup window
4369} mouse_find_T;
Bram Moolenaarc3328162019-07-23 22:15:25 +02004370
4371// Symbolic names for some registers.
4372#define DELETION_REGISTER 36
4373#ifdef FEAT_CLIPBOARD
4374# define STAR_REGISTER 37
4375# ifdef FEAT_X11
4376# define PLUS_REGISTER 38
4377# else
4378# define PLUS_REGISTER STAR_REGISTER // there is only one
4379# endif
4380#endif
4381#ifdef FEAT_DND
4382# define TILDE_REGISTER (PLUS_REGISTER + 1)
4383#endif
4384
4385#ifdef FEAT_CLIPBOARD
4386# ifdef FEAT_DND
4387# define NUM_REGISTERS (TILDE_REGISTER + 1)
4388# else
4389# define NUM_REGISTERS (PLUS_REGISTER + 1)
4390# endif
4391#else
4392# define NUM_REGISTERS 37
4393#endif
4394
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02004395// structure used by block_prep, op_delete and op_yank for blockwise operators
4396// also op_change, op_shift, op_insert, op_replace - AKelly
4397struct block_def
4398{
4399 int startspaces; // 'extra' cols before first char
4400 int endspaces; // 'extra' cols after last char
4401 int textlen; // chars in block
4402 char_u *textstart; // pointer to 1st char (partially) in block
4403 colnr_T textcol; // index of chars (partially) in block
4404 colnr_T start_vcol; // start col of 1st char wholly inside block
4405 colnr_T end_vcol; // start col of 1st char wholly after block
4406 int is_short; // TRUE if line is too short to fit in block
4407 int is_MAX; // TRUE if curswant==MAXCOL when starting
4408 int is_oneChar; // TRUE if block within one character
4409 int pre_whitesp; // screen cols of ws before block
4410 int pre_whitesp_c; // chars of ws before block
4411 colnr_T end_char_vcols; // number of vcols of post-block char
4412 colnr_T start_char_vcols; // number of vcols of pre-block char
4413};
4414
Bram Moolenaarc3328162019-07-23 22:15:25 +02004415// Each yank register has an array of pointers to lines.
4416typedef struct
4417{
4418 char_u **y_array; // pointer to array of line pointers
4419 linenr_T y_size; // number of lines in y_array
4420 char_u y_type; // MLINE, MCHAR or MBLOCK
4421 colnr_T y_width; // only set if y_type == MBLOCK
4422#ifdef FEAT_VIMINFO
4423 time_t y_time_set;
4424#endif
4425} yankreg_T;
4426
4427// The offset for a search command is store in a soff struct
4428// Note: only spats[0].off is really used
4429typedef struct soffset
4430{
4431 int dir; // search direction, '/' or '?'
4432 int line; // search has line offset
4433 int end; // search set cursor at end
4434 long off; // line or char offset
4435} soffset_T;
4436
4437// A search pattern and its attributes are stored in a spat struct
4438typedef struct spat
4439{
4440 char_u *pat; // the pattern (in allocated memory) or NULL
4441 int magic; // magicness of the pattern
4442 int no_scs; // no smartcase for this pattern
4443 soffset_T off;
4444} spat_T;
Bram Moolenaar473952e2019-09-28 16:30:04 +02004445
Bram Moolenaar92ea26b2019-10-18 20:53:34 +02004446/*
4447 * Optional extra arguments for searchit().
4448 */
4449typedef struct
4450{
4451 linenr_T sa_stop_lnum; // stop after this line number when != 0
4452#ifdef FEAT_RELTIME
Paul Ollis65745772022-06-05 16:55:54 +01004453 long sa_tm; // timeout limit or zero
Bram Moolenaar92ea26b2019-10-18 20:53:34 +02004454 int sa_timed_out; // set when timed out
4455#endif
4456 int sa_wrapped; // search wrapped around
4457} searchit_arg_T;
4458
Bram Moolenaar9567efa2021-01-11 22:16:30 +01004459/*
4460 * Cookie used by getsourceline().
4461 */
4462/*
4463 * Cookie used to store info for each sourced file.
4464 * It is shared between do_source() and getsourceline().
4465 * This is passed to do_cmdline().
4466 */
4467typedef struct {
4468 FILE *fp; // opened file for sourcing
4469 char_u *nextline; // if not NULL: line that was read ahead
4470 linenr_T sourcing_lnum; // line number of the source file
4471 int finished; // ":finish" used
Yegappan Lakshmanan85b43c62022-03-21 19:45:17 +00004472 int source_from_buf;// TRUE if sourcing from current buffer
4473 int buf_lnum; // line number in the current buffer
4474 garray_T buflines; // lines in the current buffer
Bram Moolenaar9567efa2021-01-11 22:16:30 +01004475#ifdef USE_CRNL
4476 int fileformat; // EOL_UNKNOWN, EOL_UNIX or EOL_DOS
4477 int error; // TRUE if LF found after CR-LF
4478#endif
4479#ifdef FEAT_EVAL
4480 linenr_T breakpoint; // next line with breakpoint or zero
4481 char_u *fname; // name of sourced file
4482 int dbg_tick; // debug_tick when breakpoint was set
4483 int level; // top nesting level of sourced file
4484#endif
4485 vimconv_T conv; // type of conversion
4486} source_cookie_T;
4487
Bram Moolenaaradc17a52020-06-06 18:37:51 +02004488
Bram Moolenaar473952e2019-09-28 16:30:04 +02004489#define WRITEBUFSIZE 8192 // size of normal write buffer
4490
4491#define FIO_LATIN1 0x01 // convert Latin1
4492#define FIO_UTF8 0x02 // convert UTF-8
4493#define FIO_UCS2 0x04 // convert UCS-2
4494#define FIO_UCS4 0x08 // convert UCS-4
4495#define FIO_UTF16 0x10 // convert UTF-16
4496#ifdef MSWIN
4497# define FIO_CODEPAGE 0x20 // convert MS-Windows codepage
4498# define FIO_PUT_CP(x) (((x) & 0xffff) << 16) // put codepage in top word
4499# define FIO_GET_CP(x) (((x)>>16) & 0xffff) // get codepage from top word
4500#endif
4501#ifdef MACOS_CONVERT
4502# define FIO_MACROMAN 0x20 // convert MacRoman
4503#endif
4504#define FIO_ENDIAN_L 0x80 // little endian
4505#define FIO_ENCRYPTED 0x1000 // encrypt written bytes
4506#define FIO_NOCONVERT 0x2000 // skip encoding conversion
4507#define FIO_UCSBOM 0x4000 // check for BOM at start of file
kylo2529dac9b12022-03-27 20:05:17 +01004508#define FIO_ALL (-1) // allow all formats
Bram Moolenaar473952e2019-09-28 16:30:04 +02004509
4510// When converting, a read() or write() may leave some bytes to be converted
4511// for the next call. The value is guessed...
4512#define CONV_RESTLEN 30
4513
4514// We have to guess how much a sequence of bytes may expand when converting
4515// with iconv() to be able to allocate a buffer.
4516#define ICONV_MULT 8
Bram Moolenaarf4e20992020-12-21 19:59:08 +01004517
Bram Moolenaard93a7fc2021-01-04 12:42:13 +01004518// Used for "magic_overruled".
Bram Moolenaarf4e20992020-12-21 19:59:08 +01004519typedef enum {
Bram Moolenaard93a7fc2021-01-04 12:42:13 +01004520 OPTION_MAGIC_NOT_SET, // p_magic not overruled
4521 OPTION_MAGIC_ON, // magic on inside regexp
4522 OPTION_MAGIC_OFF // magic off inside regexp
4523} optmagic_T;
4524
4525// Magicness of a pattern, used by regexp code.
4526// The order and values matter:
4527// magic <= MAGIC_OFF includes MAGIC_NONE
4528// magic >= MAGIC_ON includes MAGIC_ALL
4529typedef enum {
4530 MAGIC_NONE = 1, // "\V" very unmagic
4531 MAGIC_OFF = 2, // "\M" or 'magic' off
4532 MAGIC_ON = 3, // "\m" or 'magic'
4533 MAGIC_ALL = 4 // "\v" very magic
Bram Moolenaarf4e20992020-12-21 19:59:08 +01004534} magic_T;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004535
4536// Struct used to pass to error messages about where the error happened.
4537typedef struct {
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02004538 char *wt_func_name; // function name or NULL
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004539 char wt_index; // argument or variable index, 0 means unknown
4540 char wt_variable; // "variable" when TRUE, "argument" otherwise
4541} where_T;
4542
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02004543#define WHERE_INIT {NULL, 0, 0}
4544
Bram Moolenaar3075a452021-11-17 15:51:52 +00004545// Struct passed to get_v_event() and restore_v_event().
4546typedef struct {
4547 int sve_did_save;
4548 hashtab_T sve_hashtab;
4549} save_v_event_T;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00004550
4551// Enum used by filter(), map() and mapnew()
4552typedef enum {
4553 FILTERMAP_FILTER,
4554 FILTERMAP_MAP,
4555 FILTERMAP_MAPNEW
4556} filtermap_T;
4557
Bram Moolenaar18f47402022-01-06 13:24:51 +00004558// Structure used by switch_win() to pass values to restore_win()
4559typedef struct {
4560 win_T *sw_curwin;
4561 tabpage_T *sw_curtab;
4562 int sw_same_win; // VIsual_active was not reset
4563 int sw_visual_active;
4564} switchwin_T;
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00004565
4566// Fuzzy matched string list item. Used for fuzzy match completion. Items are
4567// usually sorted by 'score'. The 'idx' member is used for stable-sort.
4568typedef struct {
4569 int idx;
4570 char_u *str;
4571 int score;
4572} fuzmatch_str_T;
Bram Moolenaar7f9969c2022-07-25 18:13:54 +01004573
4574// Argument for lbr_chartabsize().
4575typedef struct {
4576 win_T *cts_win;
4577 linenr_T cts_lnum; // zero when not using text properties
4578 char_u *cts_line; // start of the line
4579 char_u *cts_ptr; // current position in line
4580#ifdef FEAT_PROP_POPUP
Bram Moolenaar34a1f772022-07-26 11:20:48 +01004581 int cts_text_prop_count; // number of text props; when zero
4582 // cts_text_props is not used
4583 textprop_T *cts_text_props; // text props (allocated)
4584 char cts_has_prop_with_text; // TRUE if if a property inserts text
Bram Moolenaar7f9969c2022-07-25 18:13:54 +01004585 int cts_cur_text_width; // width of current inserted text
Bram Moolenaarb7963df2022-07-31 17:12:43 +01004586 int cts_with_trailing; // include size of trailing props with
4587 // last character
Bram Moolenaar7f9969c2022-07-25 18:13:54 +01004588#endif
4589 int cts_vcol; // virtual column at current position
4590} chartabsize_T;