blob: e68c1f906d6cdf4fd2d23740a90a6e71bc35d56e [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 Moolenaar8a7d6542020-01-26 15:56:19 +010070// value for sc_version in a Vim9 script file
71#define SCRIPT_VERSION_VIM9 999999
72
Bram Moolenaar45e5fd12017-06-04 14:58:02 +020073/*
Bram Moolenaarfe72d082019-12-20 19:07:00 +010074 * SCript ConteXt (SCTX): identifies a script line.
Bram Moolenaarf29c1c62018-09-10 21:05:02 +020075 * When sourcing a script "sc_lnum" is zero, "sourcing_lnum" is the current
76 * line number. When executing a user function "sc_lnum" is the line where the
77 * function was defined, "sourcing_lnum" is the line number inside the
78 * function. When stored with a function, mapping, option, etc. "sc_lnum" is
79 * the line number in the script "sc_sid".
Bram Moolenaar7ebcba62020-01-12 17:42:55 +010080 *
81 * sc_version is also here, for convenience.
Bram Moolenaarf29c1c62018-09-10 21:05:02 +020082 */
83typedef struct {
84 scid_T sc_sid; // script ID
Bram Moolenaarded5f1b2018-11-10 17:33:29 +010085 int sc_seq; // sourcing sequence number
Bram Moolenaarf29c1c62018-09-10 21:05:02 +020086 linenr_T sc_lnum; // line number
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020087 int sc_version; // :scriptversion
Bram Moolenaarf29c1c62018-09-10 21:05:02 +020088} sctx_T;
89
90/*
Bram Moolenaar45e5fd12017-06-04 14:58:02 +020091 * Reference to a buffer that stores the value of buf_free_count.
Bram Moolenaarb25f9a92016-07-10 18:21:50 +020092 * bufref_valid() only needs to check "buf" when the count differs.
93 */
94typedef struct {
95 buf_T *br_buf;
Bram Moolenaar45e5fd12017-06-04 14:58:02 +020096 int br_fnum;
Bram Moolenaarb25f9a92016-07-10 18:21:50 +020097 int br_buf_free_count;
98} bufref_T;
99
Bram Moolenaarfbc0d2e2013-05-19 19:40:29 +0200100/*
101 * This is here because regexp.h needs pos_T and below regprog_T is used.
102 */
103#include "regexp.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104
105/*
106 * This is here because gui.h needs the pos_T and win_T, and win_T needs gui.h
107 * for scrollbar_T.
108 */
109#ifdef FEAT_GUI
110# include "gui.h"
111#else
112# ifdef FEAT_XCLIPBOARD
113# include <X11/Intrinsic.h>
114# endif
Bram Moolenaar1b58cdd2016-08-22 23:04:33 +0200115# define guicolor_T long
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200116# define INVALCOLOR ((guicolor_T)0x1ffffff)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200117 // only used for cterm.bg_rgb and cterm.fg_rgb: use cterm color
Bram Moolenaard4fc5772018-02-27 14:39:03 +0100118# define CTERMCOLOR ((guicolor_T)0x1fffffe)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119#endif
Bram Moolenaard4fc5772018-02-27 14:39:03 +0100120#define COLOR_INVALID(x) ((x) == INVALCOLOR || (x) == CTERMCOLOR)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121
122/*
123 * marks: positions in a file
124 * (a normal mark is a lnum/col pair, the same as a file position)
125 */
126
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200127// (Note: for EBCDIC there are more than 26, because there are gaps in the
128// alphabet coding. To minimize changes to the code, I decided to just
129// increase the number of possible marks.
130#define NMARKS ('z' - 'a' + 1) // max. # of named marks
Bram Moolenaar1e78e692019-07-22 20:18:27 +0200131#define EXTRA_MARKS 10 // marks 0-9
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200132#define JUMPLISTSIZE 100 // max. # of marks in jump list
133#define TAGSTACKSIZE 20 // max. # of tags in tag stack
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134
135typedef struct filemark
136{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200137 pos_T mark; // cursor position
138 int fnum; // file number
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139} fmark_T;
140
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200141// Xtended file mark: also has a file name
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142typedef struct xfilemark
143{
144 fmark_T fmark;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200145 char_u *fname; // file name, used when fnum == 0
Bram Moolenaar2d358992016-06-12 21:20:54 +0200146#ifdef FEAT_VIMINFO
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +0200147 time_T time_set;
Bram Moolenaar2d358992016-06-12 21:20:54 +0200148#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149} xfmark_T;
150
151/*
152 * The taggy struct is used to store the information about a :tag command.
153 */
154typedef struct taggy
155{
Bram Moolenaar45e18cb2019-04-28 18:05:35 +0200156 char_u *tagname; // tag name
157 fmark_T fmark; // cursor position BEFORE ":tag"
158 int cur_match; // match number
159 int cur_fnum; // buffer number used for cur_match
160 char_u *user_data; // used with tagfunc
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161} taggy_T;
162
163/*
164 * Structure that contains all options that are local to a window.
165 * Used twice in a window: for the current buffer and for all buffers.
166 * Also used in wininfo_T.
167 */
168typedef struct
169{
170#ifdef FEAT_ARABIC
171 int wo_arab;
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200172# define w_p_arab w_onebuf_opt.wo_arab // 'arabic'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173#endif
Bram Moolenaar597a4222014-06-25 14:39:50 +0200174#ifdef FEAT_LINEBREAK
175 int wo_bri;
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200176# define w_p_bri w_onebuf_opt.wo_bri // 'breakindent'
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200177 char_u *wo_briopt;
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200178# define w_p_briopt w_onebuf_opt.wo_briopt // 'breakindentopt'
Bram Moolenaar597a4222014-06-25 14:39:50 +0200179#endif
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200180 char_u *wo_wcr;
181# define w_p_wcr w_onebuf_opt.wo_wcr // 'wincolor'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182#ifdef FEAT_DIFF
183 int wo_diff;
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200184# define w_p_diff w_onebuf_opt.wo_diff // 'diff'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185#endif
186#ifdef FEAT_FOLDING
187 long wo_fdc;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200188# define w_p_fdc w_onebuf_opt.wo_fdc // 'foldcolumn'
Bram Moolenaara87aa802013-07-03 15:47:03 +0200189 int wo_fdc_save;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200190# define w_p_fdc_save w_onebuf_opt.wo_fdc_save // 'foldenable' saved for diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191 int wo_fen;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200192# define w_p_fen w_onebuf_opt.wo_fen // 'foldenable'
Bram Moolenaara87aa802013-07-03 15:47:03 +0200193 int wo_fen_save;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200194# define w_p_fen_save w_onebuf_opt.wo_fen_save // 'foldenable' saved for diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195 char_u *wo_fdi;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200196# define w_p_fdi w_onebuf_opt.wo_fdi // 'foldignore'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197 long wo_fdl;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200198# define w_p_fdl w_onebuf_opt.wo_fdl // 'foldlevel'
Bram Moolenaara87aa802013-07-03 15:47:03 +0200199 int wo_fdl_save;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200200# define w_p_fdl_save w_onebuf_opt.wo_fdl_save // 'foldlevel' state saved for diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201 char_u *wo_fdm;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200202# define w_p_fdm w_onebuf_opt.wo_fdm // 'foldmethod'
Bram Moolenaara87aa802013-07-03 15:47:03 +0200203 char_u *wo_fdm_save;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200204# define w_p_fdm_save w_onebuf_opt.wo_fdm_save // 'fdm' saved for diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205 long wo_fml;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200206# define w_p_fml w_onebuf_opt.wo_fml // 'foldminlines'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207 long wo_fdn;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200208# define w_p_fdn w_onebuf_opt.wo_fdn // 'foldnestmax'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000209# ifdef FEAT_EVAL
210 char_u *wo_fde;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200211# define w_p_fde w_onebuf_opt.wo_fde // 'foldexpr'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 char_u *wo_fdt;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200213# define w_p_fdt w_onebuf_opt.wo_fdt // 'foldtext'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214# endif
215 char_u *wo_fmr;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200216# define w_p_fmr w_onebuf_opt.wo_fmr // 'foldmarker'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217#endif
218#ifdef FEAT_LINEBREAK
219 int wo_lbr;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200220# define w_p_lbr w_onebuf_opt.wo_lbr // 'linebreak'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221#endif
222 int wo_list;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200223#define w_p_list w_onebuf_opt.wo_list // 'list'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224 int wo_nu;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200225#define w_p_nu w_onebuf_opt.wo_nu // 'number'
Bram Moolenaar64486672010-05-16 15:46:46 +0200226 int wo_rnu;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200227#define w_p_rnu w_onebuf_opt.wo_rnu // 'relativenumber'
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000228#ifdef FEAT_LINEBREAK
229 long wo_nuw;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200230# define w_p_nuw w_onebuf_opt.wo_nuw // 'numberwidth'
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000231#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232 int wo_wfh;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200233# define w_p_wfh w_onebuf_opt.wo_wfh // 'winfixheight'
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000234 int wo_wfw;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200235# define w_p_wfw w_onebuf_opt.wo_wfw // 'winfixwidth'
Bram Moolenaar4033c552017-09-16 20:54:51 +0200236#if defined(FEAT_QUICKFIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237 int wo_pvw;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200238# define w_p_pvw w_onebuf_opt.wo_pvw // 'previewwindow'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000239#endif
240#ifdef FEAT_RIGHTLEFT
241 int wo_rl;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200242# define w_p_rl w_onebuf_opt.wo_rl // 'rightleft'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000243 char_u *wo_rlc;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200244# define w_p_rlc w_onebuf_opt.wo_rlc // 'rightleftcmd'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000245#endif
246 long wo_scr;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200247#define w_p_scr w_onebuf_opt.wo_scr // 'scroll'
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000248#ifdef FEAT_SPELL
Bram Moolenaar217ad922005-03-20 22:37:15 +0000249 int wo_spell;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200250# define w_p_spell w_onebuf_opt.wo_spell // 'spell'
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000251#endif
252#ifdef FEAT_SYN_HL
253 int wo_cuc;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200254# define w_p_cuc w_onebuf_opt.wo_cuc // 'cursorcolumn'
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +0000255 int wo_cul;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200256# define w_p_cul w_onebuf_opt.wo_cul // 'cursorline'
Bram Moolenaar410e98a2019-09-09 22:05:49 +0200257 char_u *wo_culopt;
258# define w_p_culopt w_onebuf_opt.wo_culopt // 'cursorlineopt'
Bram Moolenaar1a384422010-07-14 19:53:30 +0200259 char_u *wo_cc;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200260# define w_p_cc w_onebuf_opt.wo_cc // 'colorcolumn'
Bram Moolenaar217ad922005-03-20 22:37:15 +0000261#endif
Bram Moolenaaree857022019-11-09 23:26:40 +0100262#ifdef FEAT_LINEBREAK
263 char_u *wo_sbr;
264#define w_p_sbr w_onebuf_opt.wo_sbr // 'showbreak'
265#endif
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000266#ifdef FEAT_STL_OPT
267 char_u *wo_stl;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200268#define w_p_stl w_onebuf_opt.wo_stl // 'statusline'
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000269#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 int wo_scb;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200271#define w_p_scb w_onebuf_opt.wo_scb // 'scrollbind'
272 int wo_diff_saved; // options were saved for starting diff mode
Bram Moolenaar8a3bb562018-03-04 20:14:14 +0100273#define w_p_diff_saved w_onebuf_opt.wo_diff_saved
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200274 int wo_scb_save; // 'scrollbind' saved for diff mode
Bram Moolenaar8a3bb562018-03-04 20:14:14 +0100275#define w_p_scb_save w_onebuf_opt.wo_scb_save
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276 int wo_wrap;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200277#define w_p_wrap w_onebuf_opt.wo_wrap // 'wrap'
Bram Moolenaara87aa802013-07-03 15:47:03 +0200278#ifdef FEAT_DIFF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200279 int wo_wrap_save; // 'wrap' state saved for diff mode
Bram Moolenaara87aa802013-07-03 15:47:03 +0200280# define w_p_wrap_save w_onebuf_opt.wo_wrap_save
281#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +0200282#ifdef FEAT_CONCEAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200283 char_u *wo_cocu; // 'concealcursor'
Bram Moolenaarf5963f72010-07-23 22:10:27 +0200284# define w_p_cocu w_onebuf_opt.wo_cocu
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200285 long wo_cole; // 'conceallevel'
Bram Moolenaarf5963f72010-07-23 22:10:27 +0200286# define w_p_cole w_onebuf_opt.wo_cole
Bram Moolenaar860cae12010-06-05 23:22:07 +0200287#endif
Bram Moolenaar860cae12010-06-05 23:22:07 +0200288 int wo_crb;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200289#define w_p_crb w_onebuf_opt.wo_crb // 'cursorbind'
290 int wo_crb_save; // 'cursorbind' state saved for diff mode
Bram Moolenaar8a3bb562018-03-04 20:14:14 +0100291#define w_p_crb_save w_onebuf_opt.wo_crb_save
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200292#ifdef FEAT_SIGNS
293 char_u *wo_scl;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200294# define w_p_scl w_onebuf_opt.wo_scl // 'signcolumn'
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200295#endif
Bram Moolenaare4f25e42017-07-07 11:54:15 +0200296#ifdef FEAT_TERMINAL
Bram Moolenaare1fc5152018-04-21 19:49:08 +0200297 char_u *wo_twk;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200298# define w_p_twk w_onebuf_opt.wo_twk // 'termwinkey'
Bram Moolenaare1fc5152018-04-21 19:49:08 +0200299 char_u *wo_tws;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200300# define w_p_tws w_onebuf_opt.wo_tws // 'termwinsize'
Bram Moolenaare4f25e42017-07-07 11:54:15 +0200301#endif
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000302
303#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200304 sctx_T wo_script_ctx[WV_COUNT]; // SCTXs for window-local options
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200305# define w_p_script_ctx w_onebuf_opt.wo_script_ctx
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000306#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307} winopt_T;
308
309/*
310 * Window info stored with a buffer.
311 *
312 * Two types of info are kept for a buffer which are associated with a
313 * specific window:
314 * 1. Each window can have a different line number associated with a buffer.
315 * 2. The window-local options for a buffer work in a similar way.
316 * The window-info is kept in a list at b_wininfo. It is kept in
317 * most-recently-used order.
318 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000319struct wininfo_S
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200321 wininfo_T *wi_next; // next entry or NULL for last entry
322 wininfo_T *wi_prev; // previous entry or NULL for first entry
323 win_T *wi_win; // pointer to window that did set wi_fpos
324 pos_T wi_fpos; // last cursor position in the file
325 int wi_optset; // TRUE when wi_opt has useful values
326 winopt_T wi_opt; // local window options
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327#ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200328 int wi_fold_manual; // copy of w_fold_manual
329 garray_T wi_folds; // clone of w_folds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330#endif
331};
332
333/*
334 * Info used to pass info about a fold from the fold-detection code to the
335 * code that displays the foldcolumn.
336 */
337typedef struct foldinfo
338{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200339 int fi_level; // level of the fold; when this is zero the
340 // other fields are invalid
341 int fi_lnum; // line number where fold starts
342 int fi_low_level; // lowest fold level that starts in the same
343 // line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344} foldinfo_T;
345
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200346/*
347 * Structure to store info about the Visual area.
348 */
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000349typedef struct
350{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200351 pos_T vi_start; // start pos of last VIsual
352 pos_T vi_end; // end position of last VIsual
353 int vi_mode; // VIsual_mode of last VIsual
354 colnr_T vi_curswant; // MAXCOL from w_curswant
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000355} visualinfo_T;
356
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357/*
Bram Moolenaar335437b2007-05-10 18:32:52 +0000358 * structures used for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 */
360
Bram Moolenaarccae4672019-01-04 15:09:57 +0100361// One line saved for undo. After the NUL terminated text there might be text
362// properties, thus ul_len can be larger than STRLEN(ul_line) + 1.
363typedef struct {
364 char_u *ul_line; // text of the line
365 long ul_len; // length of the line including NUL, plus text
366 // properties
367} undoline_T;
368
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369typedef struct u_entry u_entry_T;
370typedef struct u_header u_header_T;
371struct u_entry
372{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200373 u_entry_T *ue_next; // pointer to next entry in list
374 linenr_T ue_top; // number of line above undo block
375 linenr_T ue_bot; // number of line below undo block
376 linenr_T ue_lcount; // linecount when u_save called
377 undoline_T *ue_array; // array of lines in undo block
378 long ue_size; // number of lines in ue_array
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000379#ifdef U_DEBUG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200380 int ue_magic; // magic number to check allocation
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000381#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382};
383
384struct u_header
385{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200386 // The following have a pointer and a number. The number is used when
387 // reading the undo file in u_read_undo()
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200388 union {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200389 u_header_T *ptr; // pointer to next undo header in list
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200390 long seq;
391 } uh_next;
392 union {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200393 u_header_T *ptr; // pointer to previous header in list
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200394 long seq;
395 } uh_prev;
396 union {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200397 u_header_T *ptr; // pointer to next header for alt. redo
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200398 long seq;
399 } uh_alt_next;
400 union {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200401 u_header_T *ptr; // pointer to previous header for alt. redo
Bram Moolenaar83d09bb2010-06-01 19:58:08 +0200402 long seq;
403 } uh_alt_prev;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200404 long uh_seq; // sequence number, higher == newer undo
405 int uh_walk; // used by undo_time()
406 u_entry_T *uh_entry; // pointer to first entry
407 u_entry_T *uh_getbot_entry; // pointer to where ue_bot must be set
408 pos_T uh_cursor; // cursor position before saving
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 long uh_cursor_vcol;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200410 int uh_flags; // see below
411 pos_T uh_namedm[NMARKS]; // marks before undo/after redo
412 visualinfo_T uh_visual; // Visual areas before undo/after redo
413 time_T uh_time; // timestamp when the change was made
414 long uh_save_nr; // set when the file was saved after the
415 // changes in this block
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000416#ifdef U_DEBUG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200417 int uh_magic; // magic number to check allocation
Bram Moolenaarfecb6602007-10-01 20:54:15 +0000418#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419};
420
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200421// values for uh_flags
422#define UH_CHANGED 0x01 // b_changed flag before undo/after redo
423#define UH_EMPTYBUF 0x02 // buffer was empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000424
425/*
Bram Moolenaar335437b2007-05-10 18:32:52 +0000426 * structures used in undo.c
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200428#define ALIGN_LONG // longword alignment and use filler byte
Bram Moolenaar30276f22019-01-24 17:59:39 +0100429#define ALIGN_SIZE (sizeof(long))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430
431#define ALIGN_MASK (ALIGN_SIZE - 1)
432
433typedef struct m_info minfo_T;
434
435/*
Bram Moolenaar2767c602010-05-16 13:56:06 +0200436 * structure used to link chunks in one of the free chunk lists.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437 */
438struct m_info
439{
440#ifdef ALIGN_LONG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200441 long_u m_size; // size of the chunk (including m_info)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442#else
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200443 short_u m_size; // size of the chunk (including m_info)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200445 minfo_T *m_next; // pointer to next free chunk in the list
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446};
447
448/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449 * things used in memfile.c
450 */
451
452typedef struct block_hdr bhdr_T;
453typedef struct memfile memfile_T;
454typedef long blocknr_T;
455
456/*
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100457 * mf_hashtab_T is a chained hashtable with blocknr_T key and arbitrary
458 * structures as items. This is an intrusive data structure: we require
459 * that items begin with mf_hashitem_T which contains the key and linked
460 * list pointers. List of items in each bucket is doubly-linked.
461 */
462
463typedef struct mf_hashitem_S mf_hashitem_T;
464
465struct mf_hashitem_S
466{
467 mf_hashitem_T *mhi_next;
468 mf_hashitem_T *mhi_prev;
469 blocknr_T mhi_key;
470};
471
472#define MHT_INIT_SIZE 64
473
474typedef struct mf_hashtab_S
475{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200476 long_u mht_mask; // mask used for hash value (nr of items
477 // in array is "mht_mask" + 1)
478 long_u mht_count; // nr of items inserted into hashtable
479 mf_hashitem_T **mht_buckets; // points to mht_small_buckets or
480 //dynamically allocated array
481 mf_hashitem_T *mht_small_buckets[MHT_INIT_SIZE]; // initial buckets
482 char mht_fixed; // non-zero value forbids growth
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100483} mf_hashtab_T;
484
485/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000486 * for each (previously) used block in the memfile there is one block header.
487 *
488 * The block may be linked in the used list OR in the free list.
489 * The used blocks are also kept in hash lists.
490 *
491 * The used list is a doubly linked list, most recently used block first.
492 * The blocks in the used list have a block of memory allocated.
493 * mf_used_count is the number of pages in the used list.
494 * The hash lists are used to quickly find a block in the used list.
495 * The free list is a single linked list, not sorted.
496 * The blocks in the free list have no block of memory allocated and
497 * the contents of the block in the file (if any) is irrelevant.
498 */
499
500struct block_hdr
501{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200502 mf_hashitem_T bh_hashitem; // header for hash table and key
503#define bh_bnum bh_hashitem.mhi_key // block number, part of bh_hashitem
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100504
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200505 bhdr_T *bh_next; // next block_hdr in free or used list
506 bhdr_T *bh_prev; // previous block_hdr in used list
507 char_u *bh_data; // pointer to memory (for used block)
508 int bh_page_count; // number of pages in this block
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
510#define BH_DIRTY 1
511#define BH_LOCKED 2
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200512 char bh_flags; // BH_DIRTY or BH_LOCKED
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513};
514
515/*
516 * when a block with a negative number is flushed to the file, it gets
517 * a positive number. Because the reference to the block is still the negative
518 * number, we remember the translation to the new positive number in the
519 * double linked trans lists. The structure is the same as the hash lists.
520 */
521typedef struct nr_trans NR_TRANS;
522
523struct nr_trans
524{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200525 mf_hashitem_T nt_hashitem; // header for hash table and key
526#define nt_old_bnum nt_hashitem.mhi_key // old, negative, number
Bram Moolenaarb05b10a2011-03-22 18:10:45 +0100527
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200528 blocknr_T nt_new_bnum; // new, positive, number
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529};
530
Bram Moolenaar0a36fec2014-02-11 15:10:43 +0100531
532typedef struct buffblock buffblock_T;
533typedef struct buffheader buffheader_T;
534
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535/*
536 * structure used to store one block of the stuff/redo/recording buffers
537 */
538struct buffblock
539{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200540 buffblock_T *b_next; // pointer to next buffblock
541 char_u b_str[1]; // contents (actually longer)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542};
543
544/*
545 * header used for the stuff buffer and the redo buffer
546 */
547struct buffheader
548{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200549 buffblock_T bh_first; // first (dummy) block of list
550 buffblock_T *bh_curr; // buffblock for appending
551 int bh_index; // index for reading
552 int bh_space; // space in bh_curr for appending
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553};
554
Bram Moolenaard4863aa2017-04-07 19:50:12 +0200555typedef struct
556{
557 buffheader_T sr_redobuff;
558 buffheader_T sr_old_redobuff;
559} save_redo_T;
560
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561/*
562 * used for completion on the command line
563 */
564typedef struct expand
565{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200566 char_u *xp_pattern; // start of item to expand
Bram Moolenaard6beab02019-11-10 15:07:19 +0100567 int xp_context; // type of expansion
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200568 int xp_pattern_len; // bytes in xp_pattern before cursor
Bram Moolenaar0a52df52019-08-18 22:26:31 +0200569#if defined(FEAT_EVAL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200570 char_u *xp_arg; // completion function
571 sctx_T xp_script_ctx; // SCTX for completion function
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200573 int xp_backslash; // one of the XP_BS_ values
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000574#ifndef BACKSLASH_IN_FILENAME
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200575 int xp_shell; // TRUE for a shell command, more
576 // characters need to be escaped
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000577#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200578 int xp_numfiles; // number of files found by
579 // file name completion
Bram Moolenaard6beab02019-11-10 15:07:19 +0100580 int xp_col; // cursor position in line
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200581 char_u **xp_files; // list of files
582 char_u *xp_line; // text being completed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583} expand_T;
584
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200585/*
586 * values for xp_backslash
587 */
588#define XP_BS_NONE 0 // nothing special for backslashes
589#define XP_BS_ONE 1 // uses one backslash before a space
590#define XP_BS_THREE 2 // uses three backslashes before a space
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591
592/*
Bram Moolenaar66b51422019-08-18 21:44:12 +0200593 * Variables shared between getcmdline(), redrawcmdline() and others.
594 * These need to be saved when using CTRL-R |, that's why they are in a
595 * structure.
596 */
597typedef struct
598{
Bram Moolenaar4aea03e2019-09-25 22:37:17 +0200599 char_u *cmdbuff; // pointer to command line buffer
600 int cmdbufflen; // length of cmdbuff
601 int cmdlen; // number of chars in command line
602 int cmdpos; // current cursor position
603 int cmdspos; // cursor column on screen
604 int cmdfirstc; // ':', '/', '?', '=', '>' or NUL
605 int cmdindent; // number of spaces before cmdline
606 char_u *cmdprompt; // message in front of cmdline
607 int cmdattr; // attributes for prompt
608 int overstrike; // Typing mode on the command line. Shared by
609 // getcmdline() and put_on_cmdline().
610 expand_T *xpc; // struct being used for expansion, xp_pattern
611 // may point into cmdbuff
612 int xp_context; // type of expansion
Bram Moolenaar66b51422019-08-18 21:44:12 +0200613# ifdef FEAT_EVAL
Bram Moolenaar4aea03e2019-09-25 22:37:17 +0200614 char_u *xp_arg; // user-defined expansion arg
615 int input_fn; // when TRUE Invoked for input() function
Bram Moolenaar66b51422019-08-18 21:44:12 +0200616# endif
617} cmdline_info_T;
618
619/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620 * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
621 * This needs to be saved for recursive commands, put them in a structure for
622 * easy manipulation.
623 */
624typedef struct
625{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200626 int hide; // TRUE when ":hide" was used
Bram Moolenaard812df62008-11-09 12:46:09 +0000627# ifdef FEAT_BROWSE_CMD
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200628 int browse; // TRUE to invoke file dialog
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629# endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200630 int split; // flags for win_split()
631 int tab; // > 0 when ":tab" was used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632# if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200633 int confirm; // TRUE to invoke yes/no dialog
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634# endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200635 int keepalt; // TRUE when ":keepalt" was used
636 int keepmarks; // TRUE when ":keepmarks" was used
637 int keepjumps; // TRUE when ":keepjumps" was used
638 int lockmarks; // TRUE when ":lockmarks" was used
639 int keeppatterns; // TRUE when ":keeppatterns" was used
640 int noswapfile; // TRUE when ":noswapfile" was used
641 char_u *save_ei; // saved value of 'eventignore'
642 regmatch_T filter_regmatch; // set by :filter /pat/
643 int filter_force; // set for :filter!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644} cmdmod_T;
645
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200646#define MF_SEED_LEN 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647
648struct memfile
649{
Bram Moolenaarb58a4b92019-05-27 23:36:21 +0200650 char_u *mf_fname; // name of the file
651 char_u *mf_ffname; // idem, full path
652 int mf_fd; // file descriptor
653 int mf_flags; // flags used when opening this memfile
654 int mf_reopen; // mf_fd was closed, retry opening
655 bhdr_T *mf_free_first; // first block_hdr in free list
656 bhdr_T *mf_used_first; // mru block_hdr in used list
657 bhdr_T *mf_used_last; // lru block_hdr in used list
658 unsigned mf_used_count; // number of pages in used list
659 unsigned mf_used_count_max; // maximum number of pages in memory
660 mf_hashtab_T mf_hash; // hash lists
661 mf_hashtab_T mf_trans; // trans lists
662 blocknr_T mf_blocknr_max; // highest positive block number + 1
663 blocknr_T mf_blocknr_min; // lowest negative block number - 1
664 blocknr_T mf_neg_count; // number of negative blocks numbers
665 blocknr_T mf_infile_count; // number of pages in the file
666 unsigned mf_page_size; // number of bytes in a page
667 int mf_dirty; // TRUE if there are dirty blocks
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200668#ifdef FEAT_CRYPT
Bram Moolenaarb58a4b92019-05-27 23:36:21 +0200669 buf_T *mf_buffer; // buffer this memfile is for
670 char_u mf_seed[MF_SEED_LEN]; // seed for encryption
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200671
Bram Moolenaarb58a4b92019-05-27 23:36:21 +0200672 // Values for key, method and seed used for reading data blocks when
673 // updating for a newly set key or method. Only when mf_old_key != NULL.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200674 char_u *mf_old_key;
675 int mf_old_cm;
676 char_u mf_old_seed[MF_SEED_LEN];
677#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678};
679
680/*
681 * things used in memline.c
682 */
683/*
684 * When searching for a specific line, we remember what blocks in the tree
685 * are the branches leading to that block. This is stored in ml_stack. Each
686 * entry is a pointer to info in a block (may be data block or pointer block)
687 */
688typedef struct info_pointer
689{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200690 blocknr_T ip_bnum; // block number
691 linenr_T ip_low; // lowest lnum in this block
692 linenr_T ip_high; // highest lnum in this block
693 int ip_index; // index for block with current lnum
694} infoptr_T; // block/index pair
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
696#ifdef FEAT_BYTEOFF
697typedef struct ml_chunksize
698{
699 int mlcs_numlines;
700 long mlcs_totalsize;
701} chunksize_T;
702
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200703/*
704 * Flags when calling ml_updatechunk()
705 */
706# define ML_CHNK_ADDLINE 1
707# define ML_CHNK_DELLINE 2
708# define ML_CHNK_UPDLINE 3
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709#endif
710
711/*
712 * the memline structure holds all the information about a memline
713 */
714typedef struct memline
715{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200716 linenr_T ml_line_count; // number of lines in the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200718 memfile_T *ml_mfp; // pointer to associated memfile
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719
Bram Moolenaard6beab02019-11-10 15:07:19 +0100720 infoptr_T *ml_stack; // stack of pointer blocks (array of IPTRs)
721 int ml_stack_top; // current top of ml_stack
722 int ml_stack_size; // total number of entries in ml_stack
723
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200724#define ML_EMPTY 1 // empty buffer
725#define ML_LINE_DIRTY 2 // cached line was changed and allocated
726#define ML_LOCKED_DIRTY 4 // ml_locked was changed
727#define ML_LOCKED_POS 8 // ml_locked needs positive block number
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 int ml_flags;
729
Bram Moolenaard6beab02019-11-10 15:07:19 +0100730 colnr_T ml_line_len; // length of the cached line, including NUL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200731 linenr_T ml_line_lnum; // line number of cached line, 0 if not valid
732 char_u *ml_line_ptr; // pointer to cached line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200734 bhdr_T *ml_locked; // block used by last ml_get
735 linenr_T ml_locked_low; // first line in ml_locked
736 linenr_T ml_locked_high; // last line in ml_locked
737 int ml_locked_lineadd; // number of lines inserted in ml_locked
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738#ifdef FEAT_BYTEOFF
739 chunksize_T *ml_chunksize;
740 int ml_numchunks;
741 int ml_usedchunks;
742#endif
743} memline_T;
744
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100745
746/*
747 * Structure defining text properties. These stick with the text.
748 * When stored in memline they are after the text, ml_line_len is larger than
749 * STRLEN(ml_line_ptr) + 1.
750 */
751typedef struct textprop_S
752{
Bram Moolenaarb9c67a52019-01-01 19:49:20 +0100753 colnr_T tp_col; // start column (one based, in bytes)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100754 colnr_T tp_len; // length in bytes
755 int tp_id; // identifier
756 int tp_type; // property type
757 int tp_flags; // TP_FLAG_ values
758} textprop_T;
759
760#define TP_FLAG_CONT_NEXT 1 // property continues in next line
761#define TP_FLAG_CONT_PREV 2 // property was continued from prev line
762
763/*
764 * Structure defining a property type.
765 */
766typedef struct proptype_S
767{
768 int pt_id; // value used for tp_id
769 int pt_type; // number used for tp_type
770 int pt_hl_id; // highlighting
771 int pt_priority; // priority
772 int pt_flags; // PT_FLAG_ values
773 char_u pt_name[1]; // property type name, actually longer
774} proptype_T;
775
776#define PT_FLAG_INS_START_INCL 1 // insert at start included in property
777#define PT_FLAG_INS_END_INCL 2 // insert at end included in property
Bram Moolenaarde24a872019-05-05 15:48:00 +0200778#define PT_FLAG_COMBINE 4 // combine with syntax highlight
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100779
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100780// Sign group
781typedef struct signgroup_S
782{
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200783 int sg_next_sign_id; // next sign id for this group
784 short_u sg_refcount; // number of signs in this group
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200785 char_u sg_name[1]; // sign group name, actually longer
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100786} signgroup_T;
787
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200788typedef struct sign_entry sign_entry_T;
789struct sign_entry
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790{
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200791 int se_id; // unique identifier for each placed sign
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200792 int se_typenr; // typenr of sign
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200793 int se_priority; // priority for highlighting
Bram Moolenaard6beab02019-11-10 15:07:19 +0100794 linenr_T se_lnum; // line number which has this sign
795 signgroup_T *se_group; // sign group
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200796 sign_entry_T *se_next; // next entry in a list of signs
797 sign_entry_T *se_prev; // previous entry -- for easy reordering
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798};
799
Bram Moolenaar4e038572019-07-04 18:28:35 +0200800/*
801 * Sign attributes. Used by the screen refresh routines.
802 */
803typedef struct sign_attrs_S {
Bram Moolenaar6656c2e2019-10-24 15:00:04 +0200804 int sat_typenr;
805 void *sat_icon;
806 char_u *sat_text;
807 int sat_texthl;
808 int sat_linehl;
Bram Moolenaar4e038572019-07-04 18:28:35 +0200809} sign_attrs_T;
810
Bram Moolenaarced198d2018-12-29 20:04:40 +0100811#if defined(FEAT_SIGNS) || defined(PROTO)
812// Macros to get the sign group structure from the group name
813#define SGN_KEY_OFF offsetof(signgroup_T, sg_name)
814#define HI2SG(hi) ((signgroup_T *)((hi)->hi_key - SGN_KEY_OFF))
815
Bram Moolenaar162b7142018-12-21 15:17:36 +0100816// Default sign priority for highlighting
817#define SIGN_DEF_PRIO 10
818
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819#endif
820
821/*
822 * Argument list: Array of file names.
823 * Used for the global argument list and the argument lists local to a window.
824 */
825typedef struct arglist
826{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200827 garray_T al_ga; // growarray with the array of file names
828 int al_refcount; // number of windows using this arglist
829 int id; // id of this arglist
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830} alist_T;
831
832/*
833 * For each argument remember the file name as it was given, and the buffer
834 * number that contains the expanded file name (required for when ":cd" is
Bram Moolenaard6beab02019-11-10 15:07:19 +0100835 * used).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 */
837typedef struct argentry
838{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200839 char_u *ae_fname; // file name as specified
840 int ae_fnum; // buffer number with expanded file name
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841} aentry_T;
842
Bram Moolenaar4033c552017-09-16 20:54:51 +0200843#define ALIST(win) (win)->w_alist
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844#define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data)
845#define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data)
846#define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data)
847#define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data))
848#define GARGCOUNT (global_alist.al_ga.ga_len)
849#define ARGCOUNT (ALIST(curwin)->al_ga.ga_len)
850#define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len)
851
852/*
853 * A list used for saving values of "emsg_silent". Used by ex_try() to save the
854 * value of "emsg_silent" if it was non-zero. When this is done, the CSF_SILENT
855 * flag below is set.
856 */
857
858typedef struct eslist_elem eslist_T;
859struct eslist_elem
860{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200861 int saved_emsg_silent; // saved value of "emsg_silent"
862 eslist_T *next; // next element on the list
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863};
864
865/*
866 * For conditional commands a stack is kept of nested conditionals.
867 * When cs_idx < 0, there is no conditional command.
868 */
869#define CSTACK_LEN 50
870
Bram Moolenaarddef1292019-12-16 17:10:33 +0100871typedef struct {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200872 short cs_flags[CSTACK_LEN]; // CSF_ flags
873 char cs_pending[CSTACK_LEN]; // CSTP_: what's pending in ":finally"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 union {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200875 void *csp_rv[CSTACK_LEN]; // return typeval for pending return
876 void *csp_ex[CSTACK_LEN]; // exception for pending throw
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 } cs_pend;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200878 void *cs_forinfo[CSTACK_LEN]; // info used by ":for"
879 int cs_line[CSTACK_LEN]; // line nr of ":while"/":for" line
880 int cs_idx; // current entry, or -1 if none
881 int cs_looplevel; // nr of nested ":while"s and ":for"s
882 int cs_trylevel; // nr of nested ":try"s
883 eslist_T *cs_emsg_silent_list; // saved values of "emsg_silent"
884 char cs_lflags; // loop flags: CSL_ flags
Bram Moolenaarddef1292019-12-16 17:10:33 +0100885} cstack_T;
Bram Moolenaar12805862005-01-05 22:16:17 +0000886# define cs_rettv cs_pend.csp_rv
887# define cs_exception cs_pend.csp_ex
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200889// There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
890// was used.
891# define CSF_TRUE 0x0001 // condition was TRUE
892# define CSF_ACTIVE 0x0002 // current state is active
893# define CSF_ELSE 0x0004 // ":else" has been passed
894# define CSF_WHILE 0x0008 // is a ":while"
895# define CSF_FOR 0x0010 // is a ":for"
Bram Moolenaar12805862005-01-05 22:16:17 +0000896
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200897# define CSF_TRY 0x0100 // is a ":try"
898# define CSF_FINALLY 0x0200 // ":finally" has been passed
899# define CSF_THROWN 0x0400 // exception thrown to this try conditional
900# define CSF_CAUGHT 0x0800 // exception caught by this try conditional
901# define CSF_SILENT 0x1000 // "emsg_silent" reset by ":try"
902// Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
903// (an ":if"), and CSF_SILENT is only used when CSF_TRY is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904
905/*
906 * What's pending for being reactivated at the ":endtry" of this try
907 * conditional:
908 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200909# define CSTP_NONE 0 // nothing pending in ":finally" clause
910# define CSTP_ERROR 1 // an error is pending
911# define CSTP_INTERRUPT 2 // an interrupt is pending
912# define CSTP_THROW 4 // a throw is pending
913# define CSTP_BREAK 8 // ":break" is pending
914# define CSTP_CONTINUE 16 // ":continue" is pending
915# define CSTP_RETURN 24 // ":return" is pending
916# define CSTP_FINISH 32 // ":finish" is pending
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917
918/*
Bram Moolenaarddef1292019-12-16 17:10:33 +0100919 * Flags for the cs_lflags item in cstack_T.
Bram Moolenaar12805862005-01-05 22:16:17 +0000920 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200921# define CSL_HAD_LOOP 1 // just found ":while" or ":for"
922# define CSL_HAD_ENDLOOP 2 // just found ":endwhile" or ":endfor"
923# define CSL_HAD_CONT 4 // just found ":continue"
924# define CSL_HAD_FINA 8 // just found ":finally"
Bram Moolenaar12805862005-01-05 22:16:17 +0000925
926/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 * A list of error messages that can be converted to an exception. "throw_msg"
928 * is only set in the first element of the list. Usually, it points to the
929 * original message stored in that element, but sometimes it points to a later
930 * message in the list. See cause_errthrow() below.
931 */
932struct msglist
933{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200934 char *msg; // original message
935 char *throw_msg; // msg to throw: usually original one
936 struct msglist *next; // next of several messages in a row
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937};
938
939/*
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100940 * The exception types.
941 */
942typedef enum
943{
Bram Moolenaarea3ece42018-04-17 20:14:39 +0200944 ET_USER, // exception caused by ":throw" command
945 ET_ERROR, // error exception
946 ET_INTERRUPT, // interrupt exception triggered by Ctrl-C
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100947} except_type_T;
948
949/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 * Structure describing an exception.
951 * (don't use "struct exception", it's used by the math library).
952 */
953typedef struct vim_exception except_T;
954struct vim_exception
955{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200956 except_type_T type; // exception type
957 char *value; // exception value
958 struct msglist *messages; // message(s) causing error exception
959 char_u *throw_name; // name of the throw point
960 linenr_T throw_lnum; // line number of the throw point
961 except_T *caught; // next exception on the caught stack
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962};
963
964/*
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000965 * Structure to save the error/interrupt/exception state between calls to
966 * enter_cleanup() and leave_cleanup(). Must be allocated as an automatic
967 * variable by the (common) caller of these functions.
968 */
969typedef struct cleanup_stuff cleanup_T;
970struct cleanup_stuff
971{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200972 int pending; // error/interrupt/exception state
973 except_T *exception; // exception value
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000974};
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975
976#ifdef FEAT_SYN_HL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200977// struct passed to in_id_list()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978struct sp_syn
979{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200980 int inc_tag; // ":syn include" unique tag
981 short id; // highlight group ID of item
982 short *cont_in_list; // cont.in group IDs, if non-zero
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983};
984
985/*
986 * Each keyword has one keyentry, which is linked in a hash list.
987 */
988typedef struct keyentry keyentry_T;
989
990struct keyentry
991{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200992 keyentry_T *ke_next; // next entry with identical "keyword[]"
993 struct sp_syn k_syn; // struct passed to in_id_list()
994 short *next_list; // ID list for next match (if non-zero)
Bram Moolenaar860cae12010-06-05 23:22:07 +0200995 int flags;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +0200996 int k_char; // conceal substitute character
997 char_u keyword[1]; // actually longer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998};
999
1000/*
1001 * Struct used to store one state of the state stack.
1002 */
1003typedef struct buf_state
1004{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001005 int bs_idx; // index of pattern
1006 int bs_flags; // flags for pattern
Bram Moolenaar6e202e52010-07-28 18:14:45 +02001007#ifdef FEAT_CONCEAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001008 int bs_seqnr; // stores si_seqnr
1009 int bs_cchar; // stores si_cchar
Bram Moolenaar6e202e52010-07-28 18:14:45 +02001010#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001011 reg_extmatch_T *bs_extmatch; // external matches from start pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012} bufstate_T;
1013
1014/*
1015 * syn_state contains the syntax state stack for the start of one line.
1016 * Used by b_sst_array[].
1017 */
1018typedef struct syn_state synstate_T;
1019
1020struct syn_state
1021{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001022 synstate_T *sst_next; // next entry in used or free list
1023 linenr_T sst_lnum; // line number for this state
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024 union
1025 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001026 bufstate_T sst_stack[SST_FIX_STATES]; // short state stack
1027 garray_T sst_ga; // growarray for long state stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 } sst_union;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001029 int sst_next_flags; // flags for sst_next_list
1030 int sst_stacksize; // number of states on the stack
1031 short *sst_next_list; // "nextgroup" list in this state
1032 // (this is a copy, don't free it!
1033 disptick_T sst_tick; // tick when last displayed
1034 linenr_T sst_change_lnum;// when non-zero, change in this line
1035 // may have made the state invalid
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036};
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001037#endif // FEAT_SYN_HL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038
Bram Moolenaarf9cc9f22019-07-14 21:29:22 +02001039#define MAX_HL_ID 20000 // maximum value for a highlight ID.
1040
1041/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 * Structure shared between syntax.c, screen.c and gui_x11.c.
1043 */
1044typedef struct attr_entry
1045{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001046 short ae_attr; // HL_BOLD, etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 union
1048 {
1049 struct
1050 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001051 char_u *start; // start escape sequence
1052 char_u *stop; // stop escape sequence
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 } term;
1054 struct
1055 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001056 // These colors need to be > 8 bits to hold 256.
1057 short_u fg_color; // foreground color number
1058 short_u bg_color; // background color number
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001059# ifdef FEAT_TERMGUICOLORS
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001060 guicolor_T fg_rgb; // foreground color RGB
1061 guicolor_T bg_rgb; // background color RGB
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001062# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063 } cterm;
1064# ifdef FEAT_GUI
1065 struct
1066 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001067 guicolor_T fg_color; // foreground color handle
1068 guicolor_T bg_color; // background color handle
1069 guicolor_T sp_color; // special color handle
1070 GuiFont font; // font handle
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071# ifdef FEAT_XFONTSET
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001072 GuiFontset fontset; // fontset handle
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073# endif
1074 } gui;
1075# endif
1076 } ae_u;
1077} attrentry_T;
1078
1079#ifdef USE_ICONV
1080# ifdef HAVE_ICONV_H
1081# include <iconv.h>
1082# else
1083# if defined(MACOS_X)
1084# include <sys/errno.h>
Bram Moolenaard0573012017-10-28 21:11:06 +02001085# ifndef EILSEQ
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001086# define EILSEQ ENOENT // Early MacOS X does not have EILSEQ
Bram Moolenaard0573012017-10-28 21:11:06 +02001087# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088typedef struct _iconv_t *iconv_t;
1089# else
Bram Moolenaard0573012017-10-28 21:11:06 +02001090# include <errno.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091# endif
1092typedef void *iconv_t;
1093# endif
1094#endif
1095
1096/*
1097 * Used for the typeahead buffer: typebuf.
1098 */
1099typedef struct
1100{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001101 char_u *tb_buf; // buffer for typed characters
1102 char_u *tb_noremap; // mapping flags for characters in tb_buf[]
1103 int tb_buflen; // size of tb_buf[]
1104 int tb_off; // current position in tb_buf[]
1105 int tb_len; // number of valid bytes in tb_buf[]
1106 int tb_maplen; // nr of mapped bytes in tb_buf[]
1107 int tb_silent; // nr of silently mapped bytes in tb_buf[]
1108 int tb_no_abbr_cnt; // nr of bytes without abbrev. in tb_buf[]
1109 int tb_change_cnt; // nr of time tb_buf was changed; never zero
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110} typebuf_T;
1111
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001112// Struct to hold the saved typeahead for save_typeahead().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113typedef struct
1114{
1115 typebuf_T save_typebuf;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001116 int typebuf_valid; // TRUE when save_typebuf valid
Bram Moolenaar13df0fe2009-07-09 16:24:19 +00001117 int old_char;
1118 int old_mod_mask;
Bram Moolenaar0a36fec2014-02-11 15:10:43 +01001119 buffheader_T save_readbuf1;
1120 buffheader_T save_readbuf2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121#ifdef USE_INPUT_BUF
1122 char_u *save_inputbuf;
1123#endif
1124} tasave_T;
1125
1126/*
1127 * Used for conversion of terminal I/O and script files.
1128 */
1129typedef struct
1130{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001131 int vc_type; // zero or one of the CONV_ values
1132 int vc_factor; // max. expansion factor
Bram Moolenaar4f974752019-02-17 17:44:42 +01001133# ifdef MSWIN
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001134 int vc_cpfrom; // codepage to convert from (CONV_CODEPAGE)
1135 int vc_cpto; // codepage to convert to (CONV_CODEPAGE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136# endif
1137# ifdef USE_ICONV
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001138 iconv_t vc_fd; // for CONV_ICONV
Bram Moolenaar071d4272004-06-13 20:20:40 +00001139# endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001140 int vc_fail; // fail for invalid char, don't use '?'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141} vimconv_T;
1142
1143/*
Bram Moolenaar5f32ece2019-07-21 21:51:59 +02001144 * Structure used for the command line history.
1145 */
1146typedef struct hist_entry
1147{
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02001148 int hisnum; // identifying number
1149 int viminfo; // when TRUE hisstr comes from viminfo
1150 char_u *hisstr; // actual entry, separator char after the NUL
1151 time_t time_set; // when it was typed, zero if unknown
Bram Moolenaar5f32ece2019-07-21 21:51:59 +02001152} histentry_T;
1153
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154#define CONV_NONE 0
1155#define CONV_TO_UTF8 1
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001156#define CONV_9_TO_UTF8 2
1157#define CONV_TO_LATIN1 3
1158#define CONV_TO_LATIN9 4
1159#define CONV_ICONV 5
Bram Moolenaar4f974752019-02-17 17:44:42 +01001160#ifdef MSWIN
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001161# define CONV_CODEPAGE 10 // codepage -> codepage
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162#endif
1163#ifdef MACOS_X
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001164# define CONV_MAC_LATIN1 20
1165# define CONV_LATIN1_MAC 21
1166# define CONV_MAC_UTF8 22
1167# define CONV_UTF8_MAC 23
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168#endif
1169
1170/*
1171 * Structure used for mappings and abbreviations.
1172 */
1173typedef struct mapblock mapblock_T;
1174struct mapblock
1175{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001176 mapblock_T *m_next; // next mapblock in list
1177 char_u *m_keys; // mapped from, lhs
1178 char_u *m_str; // mapped to, rhs
1179 char_u *m_orig_str; // rhs as entered by the user
1180 int m_keylen; // strlen(m_keys)
1181 int m_mode; // valid mode
Bram Moolenaar459fd782019-10-13 16:43:39 +02001182 int m_simplified; // m_keys was simplified, do not use this map
1183 // if seenModifyOtherKeys is TRUE
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001184 int m_noremap; // if non-zero no re-mapping for m_str
1185 char m_silent; // <silent> used, don't echo commands
1186 char m_nowait; // <nowait> used
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001187#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001188 char m_expr; // <expr> used, m_str is an expression
1189 sctx_T m_script_ctx; // SCTX where map was defined
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190#endif
1191};
1192
1193/*
1194 * Used for highlighting in the status line.
1195 */
1196struct stl_hlrec
1197{
1198 char_u *start;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001199 int userhl; // 0: no HL, 1-9: User HL, < 0 for syn ID
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200};
1201
Bram Moolenaar860cae12010-06-05 23:22:07 +02001202
1203/*
1204 * Syntax items - usually buffer-specific.
1205 */
1206
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001207/*
1208 * Item for a hashtable. "hi_key" can be one of three values:
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001209 * NULL: Never been used
1210 * HI_KEY_REMOVED: Entry was removed
1211 * Otherwise: Used item, pointer to the actual key; this usually is
1212 * inside the item, subtract an offset to locate the item.
1213 * This reduces the size of hashitem by 1/3.
1214 */
1215typedef struct hashitem_S
1216{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001217 long_u hi_hash; // cached hash number of hi_key
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001218 char_u *hi_key;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001219} hashitem_T;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001220
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001221// The address of "hash_removed" is used as a magic number for hi_key to
1222// indicate a removed item.
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001223#define HI_KEY_REMOVED &hash_removed
1224#define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
1225
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001226// Initial size for a hashtable. Our items are relatively small and growing
1227// is expensive, thus use 16 as a start. Must be a power of 2.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001228// This allows for storing 10 items (2/3 of 16) before a resize is needed.
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001229#define HT_INIT_SIZE 16
1230
1231typedef struct hashtable_S
1232{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001233 long_u ht_mask; // mask used for hash value (nr of items in
1234 // array is "ht_mask" + 1)
1235 long_u ht_used; // number of items used
1236 long_u ht_filled; // number of items used + removed
1237 int ht_locked; // counter for hash_lock()
1238 int ht_error; // when set growing failed, can't add more
1239 // items before growing works
1240 hashitem_T *ht_array; // points to the array, allocated when it's
1241 // not "ht_smallarray"
1242 hashitem_T ht_smallarray[HT_INIT_SIZE]; // initial array
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001243} hashtab_T;
1244
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001245typedef long_u hash_T; // Type for hi_hash
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001246
1247
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001248// Use 64-bit Number.
Bram Moolenaar82f654e2020-02-17 22:12:50 +01001249#ifdef MSWIN
1250# ifdef PROTO
Bram Moolenaarf9706e92020-02-22 14:27:04 +01001251 // workaround for cproto that doesn't recognize __int64
1252 typedef long varnumber_T;
1253 typedef unsigned long uvarnumber_T;
1254# define VARNUM_MIN LONG_MIN
1255# define VARNUM_MAX LONG_MAX
1256# define UVARNUM_MAX ULONG_MAX
Bram Moolenaar82f654e2020-02-17 22:12:50 +01001257# else
Bram Moolenaarf9706e92020-02-22 14:27:04 +01001258 typedef __int64 varnumber_T;
1259 typedef unsigned __int64 uvarnumber_T;
1260# define VARNUM_MIN _I64_MIN
1261# define VARNUM_MAX _I64_MAX
1262# define UVARNUM_MAX _UI64_MAX
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001263# endif
Bram Moolenaarf9706e92020-02-22 14:27:04 +01001264#elif defined(HAVE_NO_LONG_LONG)
1265# if defined(HAVE_STDINT_H)
1266 typedef int64_t varnumber_T;
1267 typedef uint64_t uvarnumber_T;
1268# define VARNUM_MIN INT64_MIN
1269# define VARNUM_MAX INT64_MAX
1270# define UVARNUM_MAX UINT64_MAX
1271# else
1272 // this may cause trouble for code that depends on 64 bit ints
1273 typedef long varnumber_T;
1274 typedef unsigned long uvarnumber_T;
1275# define VARNUM_MIN LONG_MIN
1276# define VARNUM_MAX LONG_MAX
1277# define UVARNUM_MAX ULONG_MAX
1278# endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001279#else
Bram Moolenaarf9706e92020-02-22 14:27:04 +01001280 typedef long long varnumber_T;
1281 typedef unsigned long long uvarnumber_T;
Bram Moolenaarc593bec2020-02-25 21:26:49 +01001282# ifdef LLONG_MIN
1283# define VARNUM_MIN LLONG_MIN
1284# define VARNUM_MAX LLONG_MAX
1285# define UVARNUM_MAX ULLONG_MAX
1286# else
1287# define VARNUM_MIN LONG_LONG_MIN
1288# define VARNUM_MAX LONG_LONG_MAX
1289# define UVARNUM_MAX ULONG_LONG_MAX
1290# endif
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001291#endif
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001292
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001293typedef double float_T;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001294
1295typedef struct listvar_S list_T;
1296typedef struct dictvar_S dict_T;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001297typedef struct partial_S partial_T;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01001298typedef struct blobvar_S blob_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001299
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001300// Struct that holds both a normal function name and a partial_T, as used for a
1301// callback argument.
1302// When used temporarily "cb_name" is not allocated. The refcounts to either
1303// the function or the partial are incremented and need to be decremented
1304// later with free_callback().
1305typedef struct {
1306 char_u *cb_name;
1307 partial_T *cb_partial;
1308 int cb_free_name; // cb_name was allocated
1309} callback_T;
1310
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001311typedef struct dfunc_S dfunc_T; // :def function
1312
Bram Moolenaar835dc632016-02-07 14:27:38 +01001313typedef struct jobvar_S job_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001314typedef struct readq_S readq_T;
Bram Moolenaar97bd5e62017-08-18 20:50:30 +02001315typedef struct writeq_S writeq_T;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001316typedef struct jsonq_S jsonq_T;
1317typedef struct cbq_S cbq_T;
1318typedef struct channel_S channel_T;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001319typedef struct cctx_S cctx_T;
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001320
Bram Moolenaara03f2332016-02-06 18:09:59 +01001321typedef enum
1322{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001323 VAR_UNKNOWN = 0, // not set, also used for "any" type
1324 VAR_VOID, // no value
1325 VAR_BOOL, // "v_number" is used: VVAL_TRUE or VVAL_FALSE
1326 VAR_SPECIAL, // "v_number" is used: VVAL_NULL or VVAL_NONE
1327 VAR_NUMBER, // "v_number" is used
1328 VAR_FLOAT, // "v_float" is used
1329 VAR_STRING, // "v_string" is used
1330 VAR_BLOB, // "v_blob" is used
1331 VAR_FUNC, // "v_string" is function name
1332 VAR_PARTIAL, // "v_partial" is used
1333 VAR_LIST, // "v_list" is used
1334 VAR_DICT, // "v_dict" is used
1335 VAR_JOB, // "v_job" is used
1336 VAR_CHANNEL, // "v_channel" is used
Bram Moolenaara03f2332016-02-06 18:09:59 +01001337} vartype_T;
1338
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001339// A type specification.
1340typedef struct type_S type_T;
1341struct type_S {
1342 vartype_T tt_type;
1343 short tt_argcount; // for func, partial, -1 for unknown
1344 type_T *tt_member; // for list, dict, func return type
1345 type_T *tt_args; // func arguments
1346};
1347
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001348/*
1349 * Structure to hold an internal variable without a name.
1350 */
1351typedef struct
1352{
Bram Moolenaara03f2332016-02-06 18:09:59 +01001353 vartype_T v_type;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001354 char v_lock; // see below: VAR_LOCKED, VAR_FIXED
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001355 union
1356 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001357 varnumber_T v_number; // number value
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001358#ifdef FEAT_FLOAT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001359 float_T v_float; // floating number value
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001360#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001361 char_u *v_string; // string value (can be NULL!)
1362 list_T *v_list; // list value (can be NULL!)
1363 dict_T *v_dict; // dict value (can be NULL!)
1364 partial_T *v_partial; // closure: function with args
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01001365#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001366 job_T *v_job; // job value (can be NULL!)
1367 channel_T *v_channel; // channel value (can be NULL!)
Bram Moolenaar77073442016-02-13 23:23:53 +01001368#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001369 blob_T *v_blob; // blob value (can be NULL!)
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001370 } vval;
1371} typval_T;
1372
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001373// Values for "dv_scope".
1374#define VAR_SCOPE 1 // a:, v:, s:, etc. scope dictionaries
1375#define VAR_DEF_SCOPE 2 // l:, g: scope dictionaries: here funcrefs are not
1376 // allowed to mask existing functions
Bram Moolenaarbdb62052012-07-16 17:31:53 +02001377
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001378// Values for "v_lock".
1379#define VAR_LOCKED 1 // locked with lock(), can use unlock()
1380#define VAR_FIXED 2 // locked forever
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001381
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001382/*
1383 * Structure to hold an item of a list: an internal variable without a name.
1384 */
1385typedef struct listitem_S listitem_T;
1386
1387struct listitem_S
1388{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001389 listitem_T *li_next; // next item in list
1390 listitem_T *li_prev; // previous item in list
1391 typval_T li_tv; // type and value of the variable
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001392};
1393
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001394// Struct used by those that are using an item in a list.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001395typedef struct listwatch_S listwatch_T;
1396
1397struct listwatch_S
1398{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001399 listitem_T *lw_item; // item being watched
1400 listwatch_T *lw_next; // next watcher
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001401};
1402
1403/*
1404 * Structure to hold info about a list.
Bram Moolenaar1a840242018-03-08 21:46:43 +01001405 * Order of members is optimized to reduce padding.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001406 * When created by range() it will at first have special value:
1407 * lv_first == &range_list_item;
1408 * and use lv_start, lv_end, lv_stride.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001409 */
1410struct listvar_S
1411{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001412 listitem_T *lv_first; // first item, NULL if none
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001413 listwatch_T *lv_watch; // first watcher, NULL if none
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001414 union {
1415 struct { // used for non-materialized range list:
1416 // "lv_first" is &range_list_item
1417 varnumber_T lv_start;
1418 varnumber_T lv_end;
1419 int lv_stride;
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01001420 } nonmat;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001421 struct { // used for materialized list
1422 listitem_T *lv_last; // last item, NULL if none
1423 listitem_T *lv_idx_item; // when not NULL item at index "lv_idx"
1424 int lv_idx; // cached index of an item
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01001425 } mat;
1426 } lv_u;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001427 list_T *lv_copylist; // copied list used by deepcopy()
1428 list_T *lv_used_next; // next list in used lists list
1429 list_T *lv_used_prev; // previous list in used lists list
1430 int lv_refcount; // reference count
1431 int lv_len; // number of items
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001432 int lv_with_items; // number of items following this struct that
1433 // should not be freed
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001434 int lv_copyID; // ID used by deepcopy()
1435 char lv_lock; // zero, VAR_LOCKED, VAR_FIXED
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001436};
1437
1438/*
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001439 * Static list with 10 items. Use init_static_list() to initialize.
1440 */
1441typedef struct {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001442 list_T sl_list; // must be first
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001443 listitem_T sl_items[10];
1444} staticList10_T;
1445
1446/*
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001447 * Structure to hold an item of a Dictionary.
1448 * Also used for a variable.
1449 * The key is copied into "di_key" to avoid an extra alloc/free for it.
1450 */
1451struct dictitem_S
1452{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001453 typval_T di_tv; // type and value of the variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001454 char_u di_flags; // DI_FLAGS_ flags (only used for variable)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001455 char_u di_key[1]; // key (actually longer!)
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001456};
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001457typedef struct dictitem_S dictitem_T;
1458
Bram Moolenaard7c96872019-06-15 17:12:48 +02001459/*
1460 * A dictitem with a 16 character key (plus NUL). This is an efficient way to
1461 * have a fixed-size dictitem.
1462 */
1463#define DICTITEM16_KEY_LEN 16
Bram Moolenaarbee6c0c2016-03-25 15:40:50 +01001464struct dictitem16_S
1465{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001466 typval_T di_tv; // type and value of the variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001467 char_u di_flags; // DI_FLAGS_ flags (only used for variable)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001468 char_u di_key[DICTITEM16_KEY_LEN + 1]; // key
Bram Moolenaarbee6c0c2016-03-25 15:40:50 +01001469};
1470typedef struct dictitem16_S dictitem16_T;
1471
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001472// Flags for "di_flags"
1473#define DI_FLAGS_RO 0x01 // read-only variable
1474#define DI_FLAGS_RO_SBX 0x02 // read-only in the sandbox
1475#define DI_FLAGS_FIX 0x04 // fixed: no :unlet or remove()
1476#define DI_FLAGS_LOCK 0x08 // locked variable
1477#define DI_FLAGS_ALLOC 0x10 // separately allocated
1478#define DI_FLAGS_RELOAD 0x20 // set when script sourced again
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001479
1480/*
1481 * Structure to hold info about a Dictionary.
1482 */
1483struct dictvar_S
1484{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001485 char dv_lock; // zero, VAR_LOCKED, VAR_FIXED
1486 char dv_scope; // zero, VAR_SCOPE, VAR_DEF_SCOPE
1487 int dv_refcount; // reference count
1488 int dv_copyID; // ID used by deepcopy()
1489 hashtab_T dv_hashtab; // hashtab that refers to the items
1490 dict_T *dv_copydict; // copied dict used by deepcopy()
1491 dict_T *dv_used_next; // next dict in used dicts list
1492 dict_T *dv_used_prev; // previous dict in used dicts list
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001493};
1494
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01001495/*
1496 * Structure to hold info about a blob.
1497 */
1498struct blobvar_S
1499{
1500 garray_T bv_ga; // growarray with the data
1501 int bv_refcount; // reference count
1502 char bv_lock; // zero, VAR_LOCKED, VAR_FIXED
1503};
1504
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001505#if defined(FEAT_EVAL) || defined(PROTO)
1506typedef struct funccall_S funccall_T;
1507
1508/*
1509 * Structure to hold info for a user function.
1510 */
1511typedef struct
1512{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001513 int uf_varargs; // variable nr of arguments (old style)
1514 int uf_flags; // FC_ flags
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001515 int uf_calls; // nr of active calls
1516 int uf_cleared; // func_clear() was already called
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001517 int uf_dfunc_idx; // >= 0 for :def function only
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001518 garray_T uf_args; // arguments
1519 garray_T uf_def_args; // default argument expressions
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001520
1521 // for :def (for :function uf_ret_type is NULL)
1522 type_T **uf_arg_types; // argument types (count == uf_args.ga_len)
1523 type_T *uf_ret_type; // return type
1524 garray_T uf_type_list; // types used in arg and return types
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01001525 int *uf_def_arg_idx; // instruction indexes for evaluating
1526 // uf_def_args; length: uf_def_args.ga_len + 1
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001527 char_u *uf_va_name; // name from "...name" or NULL
1528 type_T *uf_va_type; // type from "...name: type" or NULL
1529
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001530 garray_T uf_lines; // function lines
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001531# ifdef FEAT_PROFILE
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001532 int uf_profiling; // TRUE when func is being profiled
Bram Moolenaarad648092018-06-30 18:28:03 +02001533 int uf_prof_initialized;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001534 // profiling the function as a whole
1535 int uf_tm_count; // nr of calls
1536 proftime_T uf_tm_total; // time spent in function + children
1537 proftime_T uf_tm_self; // time spent in function itself
1538 proftime_T uf_tm_children; // time spent in children this call
1539 // profiling the function per line
1540 int *uf_tml_count; // nr of times line was executed
1541 proftime_T *uf_tml_total; // time spent in a line + children
1542 proftime_T *uf_tml_self; // time spent in a line itself
1543 proftime_T uf_tml_start; // start time for current line
1544 proftime_T uf_tml_children; // time spent in children for this line
1545 proftime_T uf_tml_wait; // start wait time for current line
1546 int uf_tml_idx; // index of line being timed; -1 if none
1547 int uf_tml_execed; // line being timed was executed
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001548# endif
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001549 sctx_T uf_script_ctx; // SCTX where function was defined,
1550 // used for s: variables
1551 int uf_refcount; // reference count, see func_name_refcount()
1552 funccall_T *uf_scoped; // l: local variables for closure
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001553 char_u *uf_name_exp; // if "uf_name[]" starts with SNR the name with
1554 // "<SNR>" as a string, otherwise NULL
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001555 char_u uf_name[1]; // name of function (actually longer); can
1556 // start with <SNR>123_ (<SNR> is K_SPECIAL
1557 // KS_EXTRA KE_SNR)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001558} ufunc_T;
1559
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001560#define MAX_FUNC_ARGS 20 // maximum number of function arguments
1561#define VAR_SHORT_LEN 20 // short variable name length
1562#define FIXVAR_CNT 12 // number of fixed variables
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001563
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001564/*
1565 * structure to hold info for a function that is currently being executed.
1566 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001567struct funccall_S
1568{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001569 ufunc_T *func; // function being called
1570 int linenr; // next line to be executed
1571 int returned; // ":return" used
1572 struct // fixed variables for arguments
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001573 {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001574 dictitem_T var; // variable (without room for name)
1575 char_u room[VAR_SHORT_LEN]; // room for the name
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001576 } fixvar[FIXVAR_CNT];
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001577 dict_T l_vars; // l: local function variables
1578 dictitem_T l_vars_var; // variable for l: scope
1579 dict_T l_avars; // a: argument variables
1580 dictitem_T l_avars_var; // variable for a: scope
1581 list_T l_varlist; // list for a:000
1582 listitem_T l_listitems[MAX_FUNC_ARGS]; // listitems for a:000
1583 typval_T *rettv; // return value
1584 linenr_T breakpoint; // next line with breakpoint or zero
1585 int dbg_tick; // debug_tick when breakpoint was set
1586 int level; // top nesting level of executed function
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001587#ifdef FEAT_PROFILE
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001588 proftime_T prof_child; // time spent in a child
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001589#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001590 funccall_T *caller; // calling function or NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001591
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001592 // for closure
1593 int fc_refcount; // number of user functions that reference this
1594 // funccal
1595 int fc_copyID; // for garbage collection
1596 garray_T fc_funcs; // list of ufunc_T* which keep a reference to
1597 // "func"
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001598};
1599
1600/*
1601 * Struct used by trans_function_name()
1602 */
1603typedef struct
1604{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001605 dict_T *fd_dict; // Dictionary used
1606 char_u *fd_newkey; // new key in "dict" in allocated memory
1607 dictitem_T *fd_di; // Dictionary item used
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001608} funcdict_T;
1609
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001610typedef struct funccal_entry funccal_entry_T;
1611struct funccal_entry {
1612 void *top_funccal;
1613 funccal_entry_T *next;
1614};
1615
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001616// From user function to hashitem and back.
Bram Moolenaar660a10a2019-07-14 15:48:38 +02001617#define UF2HIKEY(fp) ((fp)->uf_name)
1618#define HIKEY2UF(p) ((ufunc_T *)((p) - offsetof(ufunc_T, uf_name)))
1619#define HI2UF(hi) HIKEY2UF((hi)->hi_key)
1620
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001621/*
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001622 * Holds the hashtab with variables local to each sourced script.
1623 * Each item holds a variable (nameless) that points to the dict_T.
1624 */
1625typedef struct
1626{
1627 dictitem_T sv_var;
1628 dict_T sv_dict;
1629} scriptvar_T;
1630
1631/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001632 * Entry for "sn_var_vals". Used for script-local variables.
1633 */
1634typedef struct {
1635 char_u *sv_name; // points into "sn_vars" di_key
1636 typval_T *sv_tv; // points into "sn_vars" di_tv
1637 type_T *sv_type;
1638 int sv_const;
1639 int sv_export; // "export let var = val"
1640} svar_T;
1641
1642typedef struct {
1643 char_u *imp_name; // name imported as (allocated)
1644 int imp_sid; // script ID of "from"
1645
1646 // for "import * as Name", "imp_name" is "Name"
1647 int imp_all;
1648
1649 // for variable
1650 type_T *imp_type;
1651 int imp_var_vals_idx; // index in sn_var_vals of "from"
1652
1653 // for function
1654 char_u *imp_funcname; // user func name (NOT allocated)
1655} imported_T;
1656
1657/*
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001658 * Growarray to store info about already sourced scripts.
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001659 * For Unix also store the dev/ino, so that we don't have to stat() each
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001660 * script when going through the list.
1661 */
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001662typedef struct
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001663{
1664 char_u *sn_name;
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001665
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001666 scriptvar_T *sn_vars; // stores s: variables for this script
1667 garray_T sn_var_vals; // same variables as a list of svar_T
1668
1669 garray_T sn_imports; // imported items, imported_T
1670
1671 garray_T sn_type_list; // keeps types used by variables
1672
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001673 int sn_version; // :scriptversion
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001674 int sn_had_command; // TRUE if any command was executed
1675 char_u *sn_save_cpo; // 'cpo' value when :vim9script found
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01001676
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001677# ifdef FEAT_PROFILE
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02001678 int sn_prof_on; // TRUE when script is/was profiled
1679 int sn_pr_force; // forceit: profile functions in this script
1680 proftime_T sn_pr_child; // time set when going into first child
1681 int sn_pr_nest; // nesting for sn_pr_child
1682 // profiling the script as a whole
1683 int sn_pr_count; // nr of times sourced
1684 proftime_T sn_pr_total; // time spent in script + children
1685 proftime_T sn_pr_self; // time spent in script itself
1686 proftime_T sn_pr_start; // time at script start
1687 proftime_T sn_pr_children; // time in children after script start
1688 // profiling the script per line
1689 garray_T sn_prl_ga; // things stored for every line
1690 proftime_T sn_prl_start; // start time for current line
1691 proftime_T sn_prl_children; // time spent in children for this line
1692 proftime_T sn_prl_wait; // wait start time for current line
1693 int sn_prl_idx; // index of line being timed; -1 if none
1694 int sn_prl_execed; // line being timed was executed
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001695# endif
1696} scriptitem_T;
1697
1698# ifdef FEAT_PROFILE
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001699/*
1700 * Struct used in sn_prl_ga for every line of a script.
1701 */
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001702typedef struct sn_prl_S
1703{
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02001704 int snp_count; // nr of times line was executed
1705 proftime_T sn_prl_total; // time spent in a line + children
1706 proftime_T sn_prl_self; // time spent in a line itself
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001707} sn_prl_T;
1708
1709# define PRL_ITEM(si, idx) (((sn_prl_T *)(si)->sn_prl_ga.ga_data)[(idx)])
1710# endif
Bram Moolenaaracadbea2016-08-01 16:35:59 +02001711#else
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001712// dummy typedefs for use in function prototypes
Bram Moolenaaracadbea2016-08-01 16:35:59 +02001713typedef struct
1714{
1715 int dummy;
1716} ufunc_T;
1717typedef struct
1718{
1719 int dummy;
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001720} funccall_T;
1721typedef struct
1722{
1723 int dummy;
Bram Moolenaaracadbea2016-08-01 16:35:59 +02001724} funcdict_T;
Bram Moolenaard95c3c22018-10-14 22:38:09 +02001725typedef struct
1726{
1727 int dummy;
1728} funccal_entry_T;
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001729typedef struct
1730{
1731 int dummy;
1732} scriptitem_T;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001733#endif
1734
Bram Moolenaar505e43a2019-08-03 18:28:17 +02001735// Struct passed between functions dealing with function call execution.
1736//
1737// "argv_func", when not NULL, can be used to fill in arguments only when the
1738// invoked function uses them. It is called like this:
Bram Moolenaarb0745b22019-11-09 22:28:11 +01001739// new_argcount = argv_func(current_argcount, argv, partial_argcount,
1740// called_func_argcount)
Bram Moolenaar505e43a2019-08-03 18:28:17 +02001741//
1742typedef struct {
Bram Moolenaarb0745b22019-11-09 22:28:11 +01001743 int (* argv_func)(int, typval_T *, int, int);
Bram Moolenaar505e43a2019-08-03 18:28:17 +02001744 linenr_T firstline; // first line of range
1745 linenr_T lastline; // last line of range
1746 int *doesrange; // if not NULL: return: function handled range
1747 int evaluate; // actually evaluate expressions
1748 partial_T *partial; // for extra arguments
1749 dict_T *selfdict; // Dictionary for "self"
Bram Moolenaarac92e252019-08-03 21:58:38 +02001750 typval_T *basetv; // base for base->method()
Bram Moolenaar505e43a2019-08-03 18:28:17 +02001751} funcexe_T;
1752
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001753struct partial_S
1754{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001755 int pt_refcount; // reference count
1756 char_u *pt_name; // function name; when NULL use
1757 // pt_func->uf_name
1758 ufunc_T *pt_func; // function pointer; when NULL lookup function
1759 // with pt_name
1760 int pt_auto; // when TRUE the partial was created for using
1761 // dict.member in handle_subscript()
1762 int pt_argc; // number of arguments
1763 typval_T *pt_argv; // arguments in allocated array
1764 dict_T *pt_dict; // dict for "self"
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001765};
1766
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001767typedef struct AutoPatCmd_S AutoPatCmd;
1768
1769/*
1770 * Entry in the execution stack "exestack".
1771 */
1772typedef enum {
1773 ETYPE_TOP, // toplevel
1774 ETYPE_SCRIPT, // sourcing script, use es_info.sctx
1775 ETYPE_UFUNC, // user function, use es_info.ufunc
1776 ETYPE_AUCMD, // autocomand, use es_info.aucmd
1777 ETYPE_MODELINE, // modeline, use es_info.sctx
1778 ETYPE_EXCEPT, // exception, use es_info.exception
1779 ETYPE_ARGS, // command line argument
1780 ETYPE_ENV, // environment variable
1781 ETYPE_INTERNAL, // internal operation
1782 ETYPE_SPELL, // loading spell file
1783} etype_T;
1784
1785typedef struct {
1786 long es_lnum; // replaces "sourcing_lnum"
1787 char_u *es_name; // replaces "sourcing_name"
1788 etype_T es_type;
1789 union {
1790 sctx_T *sctx; // script and modeline info
1791#if defined(FEAT_EVAL)
1792 ufunc_T *ufunc; // function info
1793#endif
1794 AutoPatCmd *aucmd; // autocommand info
1795 except_T *except; // exception info
1796 } es_info;
1797} estack_T;
1798
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001799// Information returned by get_tty_info().
Bram Moolenaar6b93b0e2017-08-13 20:28:53 +02001800typedef struct {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001801 int backspace; // what the Backspace key produces
1802 int enter; // what the Enter key produces
1803 int interrupt; // interrupt character
1804 int nl_does_cr; // TRUE when a NL is expanded to CR-NL on output
Bram Moolenaar6b93b0e2017-08-13 20:28:53 +02001805} ttyinfo_T;
1806
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001807// Status of a job. Order matters!
Bram Moolenaar835dc632016-02-07 14:27:38 +01001808typedef enum
1809{
1810 JOB_FAILED,
1811 JOB_STARTED,
Bram Moolenaarea3ece42018-04-17 20:14:39 +02001812 JOB_ENDED, // detected job done
1813 JOB_FINISHED, // job done and cleanup done
Bram Moolenaar835dc632016-02-07 14:27:38 +01001814} jobstatus_T;
1815
1816/*
1817 * Structure to hold info about a Job.
1818 */
1819struct jobvar_S
1820{
Bram Moolenaar65edff82016-02-21 16:40:11 +01001821 job_T *jv_next;
1822 job_T *jv_prev;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001823#ifdef UNIX
1824 pid_t jv_pid;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001825#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001826#ifdef MSWIN
Bram Moolenaar76467df2016-02-12 19:30:26 +01001827 PROCESS_INFORMATION jv_proc_info;
Bram Moolenaar14207f42016-10-27 21:13:10 +02001828 HANDLE jv_job_object;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001829#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001830 char_u *jv_tty_in; // controlling tty input, allocated
1831 char_u *jv_tty_out; // controlling tty output, allocated
Bram Moolenaar835dc632016-02-07 14:27:38 +01001832 jobstatus_T jv_status;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001833 char_u *jv_stoponexit; // allocated
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01001834#ifdef UNIX
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001835 char_u *jv_termsig; // allocated
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01001836#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001837#ifdef MSWIN
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01001838 char_u *jv_tty_type; // allocated
1839#endif
Bram Moolenaareab089d2016-02-21 19:32:02 +01001840 int jv_exitval;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001841 callback_T jv_exit_cb;
Bram Moolenaar835dc632016-02-07 14:27:38 +01001842
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001843 buf_T *jv_in_buf; // buffer from "in-name"
Bram Moolenaar014069a2016-03-03 22:51:40 +01001844
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001845 int jv_refcount; // reference count
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02001846 int jv_copyID;
1847
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001848 channel_T *jv_channel; // channel for I/O, reference counted
1849 char **jv_argv; // command line used to start the job
Bram Moolenaar835dc632016-02-07 14:27:38 +01001850};
1851
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001852/*
1853 * Structures to hold info about a Channel.
1854 */
1855struct readq_S
1856{
Bram Moolenaar77073442016-02-13 23:23:53 +01001857 char_u *rq_buffer;
Bram Moolenaar9ed96ef2016-06-04 17:17:11 +02001858 long_u rq_buflen;
Bram Moolenaar77073442016-02-13 23:23:53 +01001859 readq_T *rq_next;
1860 readq_T *rq_prev;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001861};
1862
Bram Moolenaar97bd5e62017-08-18 20:50:30 +02001863struct writeq_S
1864{
1865 garray_T wq_ga;
1866 writeq_T *wq_next;
1867 writeq_T *wq_prev;
1868};
1869
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001870struct jsonq_S
1871{
Bram Moolenaar77073442016-02-13 23:23:53 +01001872 typval_T *jq_value;
1873 jsonq_T *jq_next;
1874 jsonq_T *jq_prev;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001875 int jq_no_callback; // TRUE when no callback was found
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001876};
1877
1878struct cbq_S
1879{
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001880 callback_T cq_callback;
Bram Moolenaar77073442016-02-13 23:23:53 +01001881 int cq_seq_nr;
1882 cbq_T *cq_next;
1883 cbq_T *cq_prev;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001884};
1885
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001886// mode for a channel
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001887typedef enum
1888{
Bram Moolenaar77073442016-02-13 23:23:53 +01001889 MODE_NL = 0,
1890 MODE_RAW,
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001891 MODE_JSON,
Bram Moolenaarea3ece42018-04-17 20:14:39 +02001892 MODE_JS,
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001893} ch_mode_T;
1894
Bram Moolenaar580984e2016-03-20 21:17:13 +01001895typedef enum {
Bram Moolenaarea3ece42018-04-17 20:14:39 +02001896 JIO_PIPE, // default
Bram Moolenaar580984e2016-03-20 21:17:13 +01001897 JIO_NULL,
1898 JIO_FILE,
1899 JIO_BUFFER,
1900 JIO_OUT
1901} job_io_T;
1902
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001903#define CH_PART_FD(part) ch_part[part].ch_fd
1904
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001905// Ordering matters, it is used in for loops: IN is last, only SOCK/OUT/ERR
1906// are polled.
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001907typedef enum {
1908 PART_SOCK = 0,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001909#define CH_SOCK_FD CH_PART_FD(PART_SOCK)
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01001910#ifdef FEAT_JOB_CHANNEL
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001911 PART_OUT,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001912# define CH_OUT_FD CH_PART_FD(PART_OUT)
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001913 PART_ERR,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001914# define CH_ERR_FD CH_PART_FD(PART_ERR)
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001915 PART_IN,
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001916# define CH_IN_FD CH_PART_FD(PART_IN)
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001917#endif
Bram Moolenaarea3ece42018-04-17 20:14:39 +02001918 PART_COUNT,
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02001919} ch_part_T;
1920
1921#define INVALID_FD (-1)
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001922
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001923// The per-fd info for a channel.
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001924typedef struct {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001925 sock_T ch_fd; // socket/stdin/stdout/stderr, -1 if not used
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001926
1927# if defined(UNIX) && !defined(HAVE_SELECT)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001928 int ch_poll_idx; // used by channel_poll_setup()
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001929# endif
1930
1931#ifdef FEAT_GUI_X11
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001932 XtInputId ch_inputHandler; // Cookie for input
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001933#endif
1934#ifdef FEAT_GUI_GTK
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001935 gint ch_inputHandler; // Cookie for input
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001936#endif
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001937
1938 ch_mode_T ch_mode;
Bram Moolenaar580984e2016-03-20 21:17:13 +01001939 job_io_T ch_io;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001940 int ch_timeout; // request timeout in msec
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001941
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001942 readq_T ch_head; // header for circular raw read queue
1943 jsonq_T ch_json_head; // header for circular json read queue
1944 garray_T ch_block_ids; // list of IDs that channel_read_json_block()
1945 // is waiting for
1946 // When ch_wait_len is non-zero use ch_deadline to wait for incomplete
1947 // message to be complete. The value is the length of the incomplete
1948 // message when the deadline was set. If it gets longer (something was
1949 // received) the deadline is reset.
Bram Moolenaar88989cc2017-02-06 21:56:09 +01001950 size_t ch_wait_len;
Bram Moolenaar4f974752019-02-17 17:44:42 +01001951#ifdef MSWIN
Bram Moolenaarba61ac02016-03-20 16:40:37 +01001952 DWORD ch_deadline;
1953#else
1954 struct timeval ch_deadline;
1955#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001956 int ch_block_write; // for testing: 0 when not used, -1 when write
1957 // does not block, 1 simulate blocking
1958 int ch_nonblocking; // write() is non-blocking
1959 writeq_T ch_writeque; // header for write queue
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001960
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001961 cbq_T ch_cb_head; // dummy node for per-request callbacks
1962 callback_T ch_callback; // call when a msg is not handled
Bram Moolenaar014069a2016-03-03 22:51:40 +01001963
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001964 bufref_T ch_bufref; // buffer to read from or write to
1965 int ch_nomodifiable; // TRUE when buffer can be 'nomodifiable'
1966 int ch_nomod_error; // TRUE when e_modifiable was given
1967 int ch_buf_append; // write appended lines instead top-bot
1968 linenr_T ch_buf_top; // next line to send
1969 linenr_T ch_buf_bot; // last line to send
Bram Moolenaar42d38a22016-02-20 18:18:59 +01001970} chanpart_T;
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01001971
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001972struct channel_S {
Bram Moolenaar77073442016-02-13 23:23:53 +01001973 channel_T *ch_next;
1974 channel_T *ch_prev;
1975
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001976 int ch_id; // ID of the channel
1977 int ch_last_msg_id; // ID of the last message
Bram Moolenaar77073442016-02-13 23:23:53 +01001978
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001979 chanpart_T ch_part[PART_COUNT]; // info for socket, out, err and in
1980 int ch_write_text_mode; // write buffer lines with CR, not NL
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001981
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001982 char *ch_hostname; // only for socket, allocated
1983 int ch_port; // only for socket
Bram Moolenaar580984e2016-03-20 21:17:13 +01001984
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001985 int ch_to_be_closed; // bitset of readable fds to be closed.
1986 // When all readable fds have been closed,
1987 // set to (1 << PART_COUNT).
1988 int ch_to_be_freed; // When TRUE channel must be freed when it's
1989 // safe to invoke callbacks.
1990 int ch_error; // When TRUE an error was reported. Avoids
1991 // giving pages full of error messages when
1992 // the other side has exited, only mention the
1993 // first error until the connection works
1994 // again.
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01001995
Bram Moolenaar4e221c92016-02-23 13:20:22 +01001996 void (*ch_nb_close_cb)(void);
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02001997 // callback for Netbeans when channel is
1998 // closed
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001999
Bram Moolenaar4f974752019-02-17 17:44:42 +01002000#ifdef MSWIN
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002001 int ch_named_pipe; // using named pipe instead of pty
Bram Moolenaar2dc9d262017-09-08 14:39:30 +02002002#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002003 callback_T ch_callback; // call when any msg is not handled
2004 callback_T ch_close_cb; // call when channel is closed
Bram Moolenaar958dc692016-12-01 15:34:12 +01002005 int ch_drop_never;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002006 int ch_keep_open; // do not close on read error
Bram Moolenaar0b146882018-09-06 16:27:24 +02002007 int ch_nonblock;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002008
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01002009 job_T *ch_job; // Job that uses this channel; this does not
2010 // count as a reference to avoid a circular
2011 // reference, the job refers to the channel.
2012 int ch_job_killed; // TRUE when there was a job and it was killed
2013 // or we know it died.
2014 int ch_anonymous_pipe; // ConPTY
2015 int ch_killing; // TerminateJobObject() was called
Bram Moolenaar77073442016-02-13 23:23:53 +01002016
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01002017 int ch_refcount; // reference count
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02002018 int ch_copyID;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002019};
2020
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002021#define JO_MODE 0x0001 // channel mode
2022#define JO_IN_MODE 0x0002 // stdin mode
2023#define JO_OUT_MODE 0x0004 // stdout mode
2024#define JO_ERR_MODE 0x0008 // stderr mode
2025#define JO_CALLBACK 0x0010 // channel callback
2026#define JO_OUT_CALLBACK 0x0020 // stdout callback
2027#define JO_ERR_CALLBACK 0x0040 // stderr callback
2028#define JO_CLOSE_CALLBACK 0x0080 // "close_cb"
2029#define JO_WAITTIME 0x0100 // only for ch_open()
2030#define JO_TIMEOUT 0x0200 // all timeouts
2031#define JO_OUT_TIMEOUT 0x0400 // stdout timeouts
2032#define JO_ERR_TIMEOUT 0x0800 // stderr timeouts
2033#define JO_PART 0x1000 // "part"
2034#define JO_ID 0x2000 // "id"
2035#define JO_STOPONEXIT 0x4000 // "stoponexit"
2036#define JO_EXIT_CB 0x8000 // "exit_cb"
2037#define JO_OUT_IO 0x10000 // "out_io"
2038#define JO_ERR_IO 0x20000 // "err_io" (JO_OUT_IO << 1)
2039#define JO_IN_IO 0x40000 // "in_io" (JO_OUT_IO << 2)
2040#define JO_OUT_NAME 0x80000 // "out_name"
2041#define JO_ERR_NAME 0x100000 // "err_name" (JO_OUT_NAME << 1)
2042#define JO_IN_NAME 0x200000 // "in_name" (JO_OUT_NAME << 2)
2043#define JO_IN_TOP 0x400000 // "in_top"
2044#define JO_IN_BOT 0x800000 // "in_bot"
2045#define JO_OUT_BUF 0x1000000 // "out_buf"
2046#define JO_ERR_BUF 0x2000000 // "err_buf" (JO_OUT_BUF << 1)
2047#define JO_IN_BUF 0x4000000 // "in_buf" (JO_OUT_BUF << 2)
2048#define JO_CHANNEL 0x8000000 // "channel"
2049#define JO_BLOCK_WRITE 0x10000000 // "block_write"
2050#define JO_OUT_MODIFIABLE 0x20000000 // "out_modifiable"
2051#define JO_ERR_MODIFIABLE 0x40000000 // "err_modifiable" (JO_OUT_ << 1)
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02002052#define JO_ALL 0x7fffffff
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01002053
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002054#define JO2_OUT_MSG 0x0001 // "out_msg"
2055#define JO2_ERR_MSG 0x0002 // "err_msg" (JO_OUT_ << 1)
2056#define JO2_TERM_NAME 0x0004 // "term_name"
2057#define JO2_TERM_FINISH 0x0008 // "term_finish"
2058#define JO2_ENV 0x0010 // "env"
2059#define JO2_CWD 0x0020 // "cwd"
2060#define JO2_TERM_ROWS 0x0040 // "term_rows"
2061#define JO2_TERM_COLS 0x0080 // "term_cols"
2062#define JO2_VERTICAL 0x0100 // "vertical"
2063#define JO2_CURWIN 0x0200 // "curwin"
2064#define JO2_HIDDEN 0x0400 // "hidden"
2065#define JO2_TERM_OPENCMD 0x0800 // "term_opencmd"
2066#define JO2_EOF_CHARS 0x1000 // "eof_chars"
2067#define JO2_NORESTORE 0x2000 // "norestore"
2068#define JO2_TERM_KILL 0x4000 // "term_kill"
2069#define JO2_ANSI_COLORS 0x8000 // "ansi_colors"
2070#define JO2_TTY_TYPE 0x10000 // "tty_type"
2071#define JO2_BUFNR 0x20000 // "bufnr"
Bram Moolenaard2842ea2019-09-26 23:08:54 +02002072#define JO2_TERM_API 0x40000 // "term_api"
Bram Moolenaar169ebb02016-09-07 23:32:23 +02002073
Bram Moolenaarb6b52522016-02-20 23:30:07 +01002074#define JO_MODE_ALL (JO_MODE + JO_IN_MODE + JO_OUT_MODE + JO_ERR_MODE)
Bram Moolenaar4e221c92016-02-23 13:20:22 +01002075#define JO_CB_ALL \
2076 (JO_CALLBACK + JO_OUT_CALLBACK + JO_ERR_CALLBACK + JO_CLOSE_CALLBACK)
Bram Moolenaarb6b52522016-02-20 23:30:07 +01002077#define JO_TIMEOUT_ALL (JO_TIMEOUT + JO_OUT_TIMEOUT + JO_ERR_TIMEOUT)
2078
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01002079/*
Bram Moolenaar910b8aa2016-02-16 21:03:07 +01002080 * Options for job and channel commands.
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01002081 */
2082typedef struct
2083{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002084 int jo_set; // JO_ bits for values that were set
2085 int jo_set2; // JO2_ bits for values that were set
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01002086
2087 ch_mode_T jo_mode;
Bram Moolenaarb6b52522016-02-20 23:30:07 +01002088 ch_mode_T jo_in_mode;
2089 ch_mode_T jo_out_mode;
2090 ch_mode_T jo_err_mode;
Bram Moolenaar0b146882018-09-06 16:27:24 +02002091 int jo_noblock;
Bram Moolenaar187db502016-02-27 14:44:26 +01002092
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002093 job_io_T jo_io[4]; // PART_OUT, PART_ERR, PART_IN
Bram Moolenaar187db502016-02-27 14:44:26 +01002094 char_u jo_io_name_buf[4][NUMBUFLEN];
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002095 char_u *jo_io_name[4]; // not allocated!
Bram Moolenaar29fd0382016-03-09 23:14:07 +01002096 int jo_io_buf[4];
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02002097 int jo_pty;
Bram Moolenaar9f5842e2016-05-29 16:17:08 +02002098 int jo_modifiable[4];
Bram Moolenaar169ebb02016-09-07 23:32:23 +02002099 int jo_message[4];
Bram Moolenaarde279892016-03-11 22:19:44 +01002100 channel_T *jo_channel;
Bram Moolenaar187db502016-02-27 14:44:26 +01002101
Bram Moolenaar014069a2016-03-03 22:51:40 +01002102 linenr_T jo_in_top;
2103 linenr_T jo_in_bot;
2104
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002105 callback_T jo_callback;
2106 callback_T jo_out_cb;
2107 callback_T jo_err_cb;
2108 callback_T jo_close_cb;
2109 callback_T jo_exit_cb;
Bram Moolenaar958dc692016-12-01 15:34:12 +01002110 int jo_drop_never;
Bram Moolenaar40ea1da2016-02-19 22:33:35 +01002111 int jo_waittime;
2112 int jo_timeout;
Bram Moolenaarb6b52522016-02-20 23:30:07 +01002113 int jo_out_timeout;
2114 int jo_err_timeout;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002115 int jo_block_write; // for testing only
Bram Moolenaar6f3a5442016-02-20 19:56:13 +01002116 int jo_part;
2117 int jo_id;
Bram Moolenaar21109272020-01-30 16:27:20 +01002118 char_u jo_stoponexit_buf[NUMBUFLEN];
Bram Moolenaar65edff82016-02-21 16:40:11 +01002119 char_u *jo_stoponexit;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002120 dict_T *jo_env; // environment variables
Bram Moolenaar05aafed2017-08-11 19:12:11 +02002121 char_u jo_cwd_buf[NUMBUFLEN];
2122 char_u *jo_cwd;
Bram Moolenaar58556cd2017-07-20 23:04:46 +02002123
2124#ifdef FEAT_TERMINAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002125 // when non-zero run the job in a terminal window of this size
Bram Moolenaar58556cd2017-07-20 23:04:46 +02002126 int jo_term_rows;
2127 int jo_term_cols;
Bram Moolenaar08d384f2017-08-11 21:51:23 +02002128 int jo_vertical;
Bram Moolenaarda43b612017-08-11 22:27:50 +02002129 int jo_curwin;
Bram Moolenaar87abab92019-06-03 21:14:59 +02002130 buf_T *jo_bufnr_buf;
Bram Moolenaar8cad9302017-08-12 14:32:32 +02002131 int jo_hidden;
Bram Moolenaar4d8bac82018-03-09 21:33:34 +01002132 int jo_term_norestore;
Bram Moolenaar21109272020-01-30 16:27:20 +01002133 char_u jo_term_name_buf[NUMBUFLEN];
Bram Moolenaar78712a72017-08-05 14:50:12 +02002134 char_u *jo_term_name;
Bram Moolenaar21109272020-01-30 16:27:20 +01002135 char_u jo_term_opencmd_buf[NUMBUFLEN];
Bram Moolenaar37c45832017-08-12 16:01:04 +02002136 char_u *jo_term_opencmd;
Bram Moolenaardd693ce2017-08-10 23:15:19 +02002137 int jo_term_finish;
Bram Moolenaar21109272020-01-30 16:27:20 +01002138 char_u jo_eof_chars_buf[NUMBUFLEN];
Bram Moolenaar3346cc42017-09-02 14:54:21 +02002139 char_u *jo_eof_chars;
Bram Moolenaar21109272020-01-30 16:27:20 +01002140 char_u jo_term_kill_buf[NUMBUFLEN];
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002141 char_u *jo_term_kill;
Bram Moolenaarf59c6e82018-04-10 15:59:11 +02002142# if defined(FEAT_GUI) || defined(FEAT_TERMGUICOLORS)
2143 long_u jo_ansi_colors[16];
2144# endif
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01002145 int jo_tty_type; // first character of "tty_type"
Bram Moolenaard2842ea2019-09-26 23:08:54 +02002146 char_u jo_term_api_buf[NUMBUFLEN];
Bram Moolenaar21109272020-01-30 16:27:20 +01002147 char_u *jo_term_api;
Bram Moolenaar58556cd2017-07-20 23:04:46 +02002148#endif
Bram Moolenaar9a6e33a2016-02-16 19:25:12 +01002149} jobopt_T;
2150
Bram Moolenaar6d2399b2019-05-11 19:14:16 +02002151#ifdef FEAT_EVAL
2152/*
2153 * Structure used for listeners added with listener_add().
2154 */
2155typedef struct listener_S listener_T;
2156struct listener_S
2157{
2158 listener_T *lr_next;
2159 int lr_id;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002160 callback_T lr_callback;
Bram Moolenaar6d2399b2019-05-11 19:14:16 +02002161};
2162#endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002163
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002164/*
2165 * structure used for explicit stack while garbage collecting hash tables
2166 */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01002167typedef struct ht_stack_S
2168{
2169 hashtab_T *ht;
2170 struct ht_stack_S *prev;
2171} ht_stack_T;
2172
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002173/*
2174 * structure used for explicit stack while garbage collecting lists
2175 */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01002176typedef struct list_stack_S
2177{
2178 list_T *list;
2179 struct list_stack_S *prev;
2180} list_stack_T;
2181
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02002182/*
2183 * Structure used for iterating over dictionary items.
2184 * Initialize with dict_iterate_start().
2185 */
2186typedef struct
2187{
2188 long_u dit_todo;
2189 hashitem_T *dit_hi;
2190} dict_iterator_T;
2191
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002192// values for b_syn_spell: what to do with toplevel text
2193#define SYNSPL_DEFAULT 0 // spell check if @Spell not defined
2194#define SYNSPL_TOP 1 // spell check toplevel text
2195#define SYNSPL_NOTOP 2 // don't spell check toplevel text
Bram Moolenaarce0842a2005-07-18 21:58:11 +00002196
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002197// avoid #ifdefs for when b_spell is not available
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002198#ifdef FEAT_SPELL
Bram Moolenaar4770d092006-01-12 23:22:24 +00002199# define B_SPELL(buf) ((buf)->b_spell)
2200#else
2201# define B_SPELL(buf) (0)
2202#endif
2203
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002204typedef struct qf_info_S qf_info_T;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00002205
Bram Moolenaarf7512552013-06-06 14:55:19 +02002206#ifdef FEAT_PROFILE
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02002207/*
2208 * Used for :syntime: timing of executing a syntax pattern.
2209 */
2210typedef struct {
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002211 proftime_T total; // total time used
2212 proftime_T slowest; // time of slowest call
2213 long count; // nr of times used
2214 long match; // nr of times matched
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02002215} syn_time_T;
2216#endif
2217
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002218typedef struct timer_S timer_T;
2219struct timer_S
2220{
2221 long tr_id;
2222#ifdef FEAT_TIMERS
2223 timer_T *tr_next;
2224 timer_T *tr_prev;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002225 proftime_T tr_due; // when the callback is to be invoked
2226 char tr_firing; // when TRUE callback is being called
2227 char tr_paused; // when TRUE callback is not invoked
2228 int tr_repeat; // number of times to repeat, -1 forever
2229 long tr_interval; // msec
2230 callback_T tr_callback;
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002231 int tr_emsg_count;
2232#endif
2233};
2234
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002235#ifdef FEAT_CRYPT
2236/*
2237 * Structure to hold the type of encryption and the state of encryption or
2238 * decryption.
2239 */
2240typedef struct {
2241 int method_nr;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002242 void *method_state; // method-specific state information
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002243} cryptstate_T;
2244
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002245// values for method_nr
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002246# define CRYPT_M_ZIP 0
2247# define CRYPT_M_BF 1
2248# define CRYPT_M_BF2 2
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002249# define CRYPT_M_COUNT 3 // number of crypt methods
Bram Moolenaar987411d2019-01-18 22:48:34 +01002250
2251// Currently all crypt methods work inplace. If one is added that isn't then
2252// define this.
2253// # define CRYPT_NOT_INPLACE 1
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002254#endif
2255
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002256#ifdef FEAT_PROP_POPUP
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002257typedef enum {
2258 POPPOS_BOTLEFT,
2259 POPPOS_TOPLEFT,
2260 POPPOS_BOTRIGHT,
2261 POPPOS_TOPRIGHT,
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01002262 POPPOS_CENTER,
2263 POPPOS_NONE
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002264} poppos_T;
Bram Moolenaar6c009a32019-06-08 16:06:28 +02002265
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002266typedef enum {
2267 POPCLOSE_NONE,
2268 POPCLOSE_BUTTON,
2269 POPCLOSE_CLICK
2270} popclose_T;
2271
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002272# define POPUPWIN_DEFAULT_ZINDEX 50
2273# define POPUPMENU_ZINDEX 100
Bram Moolenaara42d9452019-06-15 21:46:30 +02002274# define POPUPWIN_DIALOG_ZINDEX 200
2275# define POPUPWIN_NOTIFICATION_ZINDEX 300
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002276#endif
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002277
Bram Moolenaar362ce482012-06-06 19:02:45 +02002278/*
2279 * These are items normally related to a buffer. But when using ":ownsyntax"
2280 * a window may have its own instance.
2281 */
Bram Moolenaar860cae12010-06-05 23:22:07 +02002282typedef struct {
2283#ifdef FEAT_SYN_HL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002284 hashtab_T b_keywtab; // syntax keywords hash table
2285 hashtab_T b_keywtab_ic; // idem, ignore case
2286 int b_syn_error; // TRUE when error occurred in HL
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02002287# ifdef FEAT_RELTIME
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002288 int b_syn_slow; // TRUE when 'redrawtime' reached
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02002289# endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002290 int b_syn_ic; // ignore case for :syn cmds
2291 int b_syn_spell; // SYNSPL_ values
2292 garray_T b_syn_patterns; // table for syntax patterns
2293 garray_T b_syn_clusters; // table for syntax clusters
2294 int b_spell_cluster_id; // @Spell cluster ID or 0
2295 int b_nospell_cluster_id; // @NoSpell cluster ID or 0
2296 int b_syn_containedin; // TRUE when there is an item with a
2297 // "containedin" argument
2298 int b_syn_sync_flags; // flags about how to sync
2299 short b_syn_sync_id; // group to sync on
2300 long b_syn_sync_minlines; // minimal sync lines offset
2301 long b_syn_sync_maxlines; // maximal sync lines offset
2302 long b_syn_sync_linebreaks; // offset for multi-line pattern
2303 char_u *b_syn_linecont_pat; // line continuation pattern
2304 regprog_T *b_syn_linecont_prog; // line continuation program
Bram Moolenaarf7512552013-06-06 14:55:19 +02002305#ifdef FEAT_PROFILE
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02002306 syn_time_T b_syn_linecont_time;
2307#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002308 int b_syn_linecont_ic; // ignore-case flag for above
2309 int b_syn_topgrp; // for ":syntax include"
Bram Moolenaar860cae12010-06-05 23:22:07 +02002310# ifdef FEAT_CONCEAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002311 int b_syn_conceal; // auto-conceal for :syn cmds
Bram Moolenaar860cae12010-06-05 23:22:07 +02002312# endif
2313# ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002314 int b_syn_folditems; // number of patterns with the HL_FOLD
2315 // flag set
Bram Moolenaar860cae12010-06-05 23:22:07 +02002316# endif
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02002317 /*
2318 * b_sst_array[] contains the state stack for a number of lines, for the
2319 * start of that line (col == 0). This avoids having to recompute the
2320 * syntax state too often.
2321 * b_sst_array[] is allocated to hold the state for all displayed lines,
2322 * and states for 1 out of about 20 other lines.
2323 * b_sst_array pointer to an array of synstate_T
2324 * b_sst_len number of entries in b_sst_array[]
2325 * b_sst_first pointer to first used entry in b_sst_array[] or NULL
2326 * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL
2327 * b_sst_freecount number of free entries in b_sst_array[]
2328 * b_sst_check_lnum entries after this lnum need to be checked for
2329 * validity (MAXLNUM means no check needed)
2330 */
Bram Moolenaar860cae12010-06-05 23:22:07 +02002331 synstate_T *b_sst_array;
2332 int b_sst_len;
2333 synstate_T *b_sst_first;
2334 synstate_T *b_sst_firstfree;
2335 int b_sst_freecount;
2336 linenr_T b_sst_check_lnum;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002337 short_u b_sst_lasttick; // last display tick
2338#endif // FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02002339
2340#ifdef FEAT_SPELL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002341 // for spell checking
2342 garray_T b_langp; // list of pointers to slang_T, see spell.c
2343 char_u b_spell_ismw[256]; // flags: is midword char
2344 char_u *b_spell_ismw_mb; // multi-byte midword chars
2345 char_u *b_p_spc; // 'spellcapcheck'
2346 regprog_T *b_cap_prog; // program for 'spellcapcheck'
2347 char_u *b_p_spf; // 'spellfile'
2348 char_u *b_p_spl; // 'spelllang'
2349 int b_cjk; // all CJK letters as OK
Bram Moolenaar860cae12010-06-05 23:22:07 +02002350#endif
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02002351#if !defined(FEAT_SYN_HL) && !defined(FEAT_SPELL)
2352 int dummy;
2353#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002354 char_u b_syn_chartab[32]; // syntax iskeyword option
2355 char_u *b_syn_isk; // iskeyword option
Bram Moolenaar860cae12010-06-05 23:22:07 +02002356} synblock_T;
2357
2358
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359/*
2360 * buffer: structure that holds information about one file
2361 *
2362 * Several windows can share a single Buffer
2363 * A buffer is unallocated if there is no memfile for it.
2364 * A buffer is new if the associated file has never been loaded yet.
2365 */
2366
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367struct file_buffer
2368{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002369 memline_T b_ml; // associated memline (also contains line
2370 // count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002372 buf_T *b_next; // links in list of buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373 buf_T *b_prev;
2374
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002375 int b_nwindows; // nr of windows open on this buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002377 int b_flags; // various BF_ flags
2378 int b_locked; // Buffer is being closed or referenced, don't
2379 // let autocommands wipe it out.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380
2381 /*
2382 * b_ffname has the full path of the file (NULL for no name).
2383 * b_sfname is the name as the user typed it (or NULL).
2384 * b_fname is the same as b_sfname, unless ":cd" has been done,
2385 * then it is the same as b_ffname (NULL for no name).
2386 */
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002387 char_u *b_ffname; // full path file name, allocated
2388 char_u *b_sfname; // short file name, allocated, may be equal to
2389 // b_ffname
2390 char_u *b_fname; // current file name, points to b_ffname or
2391 // b_sfname
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392
2393#ifdef UNIX
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002394 int b_dev_valid; // TRUE when b_dev has a valid number
2395 dev_t b_dev; // device number
2396 ino_t b_ino; // inode number
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397#endif
2398#ifdef FEAT_CW_EDITOR
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002399 FSSpec b_FSSpec; // MacOS File Identification
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400#endif
2401#ifdef VMS
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002402 char b_fab_rfm; // Record format
2403 char b_fab_rat; // Record attribute
2404 unsigned int b_fab_mrs; // Max record size
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002406 int b_fnum; // buffer number for this file.
Bram Moolenaar480778b2016-07-14 22:09:39 +02002407 char_u b_key[VIM_SIZEOF_INT * 2 + 1];
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002408 // key used for buf_hashtab, holds b_fnum as
2409 // hex string
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002411 int b_changed; // 'modified': Set to TRUE if something in the
2412 // file has been changed and not written out.
2413 dictitem16_T b_ct_di; // holds the b:changedtick value in
2414 // b_ct_di.di_tv.vval.v_number;
2415 // incremented for each change, also for undo
Bram Moolenaar95c526e2017-02-25 14:59:34 +01002416#define CHANGEDTICK(buf) ((buf)->b_ct_di.di_tv.vval.v_number)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002417
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002418 varnumber_T b_last_changedtick; // b:changedtick when TextChanged or
2419 // TextChangedI was last triggered.
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002420 varnumber_T b_last_changedtick_pum; // b:changedtick when TextChangedP was
2421 // last triggered.
Bram Moolenaar5a093432018-02-10 18:15:19 +01002422
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002423 int b_saving; // Set to TRUE if we are in the middle of
2424 // saving the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425
2426 /*
2427 * Changes to a buffer require updating of the display. To minimize the
2428 * work, remember changes made and update everything at once.
2429 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002430 int b_mod_set; // TRUE when there are changes since the last
2431 // time the display was updated
2432 linenr_T b_mod_top; // topmost lnum that was changed
2433 linenr_T b_mod_bot; // lnum below last changed line, AFTER the
2434 // change
2435 long b_mod_xlines; // number of extra buffer lines inserted;
2436 // negative when lines were deleted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002438 wininfo_T *b_wininfo; // list of last used info for each window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002440 long b_mtime; // last change time of original file
2441 long b_mtime_read; // last change time when reading
2442 off_T b_orig_size; // size of original file in bytes
2443 int b_orig_mode; // mode of original file
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002444#ifdef FEAT_VIMINFO
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002445 time_T b_last_used; // time when the buffer was last used; used
2446 // for viminfo
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002447#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002449 pos_T b_namedm[NMARKS]; // current named marks (mark.c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002451 // These variables are set when VIsual_active becomes FALSE
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002452 visualinfo_T b_visual;
Bram Moolenaarf7ff6e82014-03-23 15:13:05 +01002453#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002454 int b_visual_mode_eval; // b_visual.vi_mode for visualmode()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455#endif
2456
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002457 pos_T b_last_cursor; // cursor position when last unloading this
2458 // buffer
2459 pos_T b_last_insert; // where Insert mode was left
2460 pos_T b_last_change; // position of last change: '. mark
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461
2462#ifdef FEAT_JUMPLIST
2463 /*
2464 * the changelist contains old change positions
2465 */
2466 pos_T b_changelist[JUMPLISTSIZE];
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002467 int b_changelistlen; // number of active entries
2468 int b_new_change; // set by u_savecommon()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469#endif
2470
2471 /*
2472 * Character table, only used in charset.c for 'iskeyword'
2473 * 32 bytes of 8 bits: 1 bit per character 0-255.
2474 */
2475 char_u b_chartab[32];
2476
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002477 // Table used for mappings local to a buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 mapblock_T *(b_maphash[256]);
2479
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002480 // First abbreviation local to a buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 mapblock_T *b_first_abbr;
Bram Moolenaarb66bab32019-08-01 14:28:24 +02002482
Bram Moolenaarac9fb182019-04-27 13:04:13 +02002483 // User commands local to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 garray_T b_ucmds;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002485 // start and end of an operator, also used for '[ and ']
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 pos_T b_op_start;
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02002487 pos_T b_op_start_orig; // used for Insstart_orig
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 pos_T b_op_end;
2489
2490#ifdef FEAT_VIMINFO
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002491 int b_marks_read; // Have we read viminfo marks yet?
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492#endif
2493
2494 /*
2495 * The following only used in undo.c.
2496 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002497 u_header_T *b_u_oldhead; // pointer to oldest header
2498 u_header_T *b_u_newhead; // pointer to newest header; may not be valid
2499 // if b_u_curhead is not NULL
2500 u_header_T *b_u_curhead; // pointer to current header
2501 int b_u_numhead; // current number of headers
2502 int b_u_synced; // entry lists are synced
2503 long b_u_seq_last; // last used undo sequence number
2504 long b_u_save_nr_last; // counter for last file write
2505 long b_u_seq_cur; // hu_seq of header below which we are now
2506 time_T b_u_time_cur; // uh_time of header below which we are now
2507 long b_u_save_nr_cur; // file write nr after which we are now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508
2509 /*
2510 * variables for "U" command in undo.c
2511 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002512 undoline_T b_u_line_ptr; // saved line for "U" command
2513 linenr_T b_u_line_lnum; // line number of line in u_line
2514 colnr_T b_u_line_colnr; // optional column number
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002516 int b_scanned; // ^N/^P have scanned this buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002518 // flags for use of ":lmap" and IM control
2519 long b_p_iminsert; // input mode for insert
2520 long b_p_imsearch; // input mode for search
2521#define B_IMODE_USE_INSERT -1 // Use b_p_iminsert value for search
2522#define B_IMODE_NONE 0 // Input via none
2523#define B_IMODE_LMAP 1 // Input via langmap
2524#define B_IMODE_IM 2 // Input via input method
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01002525#define B_IMODE_LAST 2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526
2527#ifdef FEAT_KEYMAP
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002528 short b_kmap_state; // using "lmap" mappings
2529# define KEYMAP_INIT 1 // 'keymap' was set, call keymap_init()
2530# define KEYMAP_LOADED 2 // 'keymap' mappings have been loaded
2531 garray_T b_kmap_ga; // the keymap table
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532#endif
2533
2534 /*
2535 * Options local to a buffer.
2536 * They are here because their value depends on the type of file
2537 * or contents of the file being edited.
2538 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002539 int b_p_initialized; // set when options initialized
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00002541#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002542 sctx_T b_p_script_ctx[BV_COUNT]; // SCTXs for buffer-local options
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00002543#endif
2544
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002545 int b_p_ai; // 'autoindent'
2546 int b_p_ai_nopaste; // b_p_ai saved for paste mode
2547 char_u *b_p_bkc; // 'backupcopy'
2548 unsigned b_bkc_flags; // flags for 'backupcopy'
2549 int b_p_ci; // 'copyindent'
2550 int b_p_bin; // 'binary'
2551 int b_p_bomb; // 'bomb'
2552 char_u *b_p_bh; // 'bufhidden'
2553 char_u *b_p_bt; // 'buftype'
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02002554#ifdef FEAT_QUICKFIX
Bram Moolenaarc1542742016-07-20 21:44:37 +02002555#define BUF_HAS_QF_ENTRY 1
2556#define BUF_HAS_LL_ENTRY 2
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002557 int b_has_qf_entry;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002559 int b_p_bl; // 'buflisted'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560#ifdef FEAT_CINDENT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002561 int b_p_cin; // 'cindent'
2562 char_u *b_p_cino; // 'cinoptions'
2563 char_u *b_p_cink; // 'cinkeys'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564#endif
2565#if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002566 char_u *b_p_cinw; // 'cinwords'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002568 char_u *b_p_com; // 'comments'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569#ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002570 char_u *b_p_cms; // 'commentstring'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002572 char_u *b_p_cpt; // 'complete'
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002573#ifdef BACKSLASH_IN_FILENAME
2574 char_u *b_p_csl; // 'completeslash'
2575#endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002576#ifdef FEAT_COMPL_FUNC
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002577 char_u *b_p_cfu; // 'completefunc'
2578 char_u *b_p_ofu; // 'omnifunc'
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002579#endif
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02002580#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002581 char_u *b_p_tfu; // 'tagfunc'
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02002582#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002583 int b_p_eol; // 'endofline'
2584 int b_p_fixeol; // 'fixendofline'
2585 int b_p_et; // 'expandtab'
2586 int b_p_et_nobin; // b_p_et saved for binary mode
2587 int b_p_et_nopaste; // b_p_et saved for paste mode
2588 char_u *b_p_fenc; // 'fileencoding'
2589 char_u *b_p_ff; // 'fileformat'
2590 char_u *b_p_ft; // 'filetype'
2591 char_u *b_p_fo; // 'formatoptions'
2592 char_u *b_p_flp; // 'formatlistpat'
2593 int b_p_inf; // 'infercase'
2594 char_u *b_p_isk; // 'iskeyword'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595#ifdef FEAT_FIND_ID
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002596 char_u *b_p_def; // 'define' local value
2597 char_u *b_p_inc; // 'include'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598# ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002599 char_u *b_p_inex; // 'includeexpr'
2600 long_u b_p_inex_flags; // flags for 'includeexpr'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601# endif
2602#endif
2603#if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002604 char_u *b_p_inde; // 'indentexpr'
2605 long_u b_p_inde_flags; // flags for 'indentexpr'
2606 char_u *b_p_indk; // 'indentkeys'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002608 char_u *b_p_fp; // 'formatprg'
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002609#if defined(FEAT_EVAL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002610 char_u *b_p_fex; // 'formatexpr'
2611 long_u b_p_fex_flags; // flags for 'formatexpr'
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002612#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613#ifdef FEAT_CRYPT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002614 char_u *b_p_key; // 'key'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002616 char_u *b_p_kp; // 'keywordprg'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617#ifdef FEAT_LISP
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002618 int b_p_lisp; // 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002620 char_u *b_p_menc; // 'makeencoding'
2621 char_u *b_p_mps; // 'matchpairs'
2622 int b_p_ml; // 'modeline'
2623 int b_p_ml_nobin; // b_p_ml saved for binary mode
2624 int b_p_ma; // 'modifiable'
2625 char_u *b_p_nf; // 'nrformats'
2626 int b_p_pi; // 'preserveindent'
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002627#ifdef FEAT_TEXTOBJ
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002628 char_u *b_p_qe; // 'quoteescape'
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002629#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002630 int b_p_ro; // 'readonly'
2631 long b_p_sw; // 'shiftwidth'
2632 int b_p_sn; // 'shortname'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633#ifdef FEAT_SMARTINDENT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002634 int b_p_si; // 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002636 long b_p_sts; // 'softtabstop'
2637 long b_p_sts_nopaste; // b_p_sts saved for paste mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638#ifdef FEAT_SEARCHPATH
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002639 char_u *b_p_sua; // 'suffixesadd'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002641 int b_p_swf; // 'swapfile'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642#ifdef FEAT_SYN_HL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002643 long b_p_smc; // 'synmaxcol'
2644 char_u *b_p_syn; // 'syntax'
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002645#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002646 long b_p_ts; // 'tabstop'
2647 int b_p_tx; // 'textmode'
2648 long b_p_tw; // 'textwidth'
2649 long b_p_tw_nobin; // b_p_tw saved for binary mode
2650 long b_p_tw_nopaste; // b_p_tw saved for paste mode
2651 long b_p_wm; // 'wrapmargin'
2652 long b_p_wm_nobin; // b_p_wm saved for binary mode
2653 long b_p_wm_nopaste; // b_p_wm saved for paste mode
Bram Moolenaar04958cb2018-06-23 19:23:02 +02002654#ifdef FEAT_VARTABS
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002655 char_u *b_p_vsts; // 'varsofttabstop'
2656 int *b_p_vsts_array; // 'varsofttabstop' in internal format
2657 char_u *b_p_vsts_nopaste; // b_p_vsts saved for paste mode
2658 char_u *b_p_vts; // 'vartabstop'
2659 int *b_p_vts_array; // 'vartabstop' in internal format
Bram Moolenaar04958cb2018-06-23 19:23:02 +02002660#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661#ifdef FEAT_KEYMAP
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002662 char_u *b_p_keymap; // 'keymap'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663#endif
2664
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002665 /*
2666 * local values for options which are normally global
2667 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668#ifdef FEAT_QUICKFIX
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002669 char_u *b_p_gp; // 'grepprg' local value
2670 char_u *b_p_mp; // 'makeprg' local value
2671 char_u *b_p_efm; // 'errorformat' local value
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002673 char_u *b_p_ep; // 'equalprg' local value
2674 char_u *b_p_path; // 'path' local value
2675 int b_p_ar; // 'autoread' local value
2676 char_u *b_p_tags; // 'tags' local value
2677 char_u *b_p_tc; // 'tagcase' local value
2678 unsigned b_tc_flags; // flags for 'tagcase'
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002679 char_u *b_p_dict; // 'dictionary' local value
2680 char_u *b_p_tsr; // 'thesaurus' local value
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002681 long b_p_ul; // 'undolevels' local value
Bram Moolenaar55debbe2010-05-23 23:34:36 +02002682#ifdef FEAT_PERSISTENT_UNDO
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002683 int b_p_udf; // 'undofile'
Bram Moolenaar55debbe2010-05-23 23:34:36 +02002684#endif
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01002685#ifdef FEAT_LISP
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002686 char_u *b_p_lw; // 'lispwords' local value
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01002687#endif
Bram Moolenaare1fc5152018-04-21 19:49:08 +02002688#ifdef FEAT_TERMINAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002689 long b_p_twsl; // 'termwinscroll'
Bram Moolenaare1fc5152018-04-21 19:49:08 +02002690#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002692 /*
2693 * end of buffer options
2694 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +01002696#ifdef FEAT_CINDENT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002697 // values set from b_p_cino
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +01002698 int b_ind_level;
2699 int b_ind_open_imag;
2700 int b_ind_no_brace;
2701 int b_ind_first_open;
2702 int b_ind_open_extra;
2703 int b_ind_close_extra;
2704 int b_ind_open_left_imag;
2705 int b_ind_jump_label;
2706 int b_ind_case;
2707 int b_ind_case_code;
2708 int b_ind_case_break;
2709 int b_ind_param;
2710 int b_ind_func_type;
2711 int b_ind_comment;
2712 int b_ind_in_comment;
2713 int b_ind_in_comment2;
2714 int b_ind_cpp_baseclass;
2715 int b_ind_continuation;
2716 int b_ind_unclosed;
2717 int b_ind_unclosed2;
2718 int b_ind_unclosed_noignore;
2719 int b_ind_unclosed_wrapped;
2720 int b_ind_unclosed_whiteok;
2721 int b_ind_matching_paren;
2722 int b_ind_paren_prev;
2723 int b_ind_maxparen;
2724 int b_ind_maxcomment;
2725 int b_ind_scopedecl;
2726 int b_ind_scopedecl_code;
2727 int b_ind_java;
2728 int b_ind_js;
2729 int b_ind_keep_case_label;
2730 int b_ind_hash_comment;
2731 int b_ind_cpp_namespace;
2732 int b_ind_if_for_while;
Bram Moolenaar7720ba82017-03-08 22:19:26 +01002733 int b_ind_cpp_extern_c;
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +01002734#endif
2735
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002736 linenr_T b_no_eol_lnum; // non-zero lnum when last line of next binary
2737 // write should not have an end-of-line
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01002738
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002739 int b_start_eol; // last line had eol when it was read
2740 int b_start_ffc; // first char of 'ff' when edit started
2741 char_u *b_start_fenc; // 'fileencoding' when edit started or NULL
2742 int b_bad_char; // "++bad=" argument when edit started or 0
2743 int b_start_bomb; // 'bomb' when it was read
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744
2745#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002746 dictitem_T b_bufvar; // variable for "b:" Dictionary
2747 dict_T *b_vars; // internal variables, local to buffer
Bram Moolenaar6d2399b2019-05-11 19:14:16 +02002748
2749 listener_T *b_listener;
Bram Moolenaardda41442019-05-16 22:11:47 +02002750 list_T *b_recorded_changes;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751#endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002752#ifdef FEAT_PROP_POPUP
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01002753 int b_has_textprop; // TRUE when text props were added
2754 hashtab_T *b_proptypes; // text property types local to buffer
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002755#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002757#if defined(FEAT_BEVAL) && defined(FEAT_EVAL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002758 char_u *b_p_bexpr; // 'balloonexpr' local value
2759 long_u b_p_bexpr_flags;// flags for 'balloonexpr'
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002760#endif
Bram Moolenaar49771f42010-07-20 17:32:38 +02002761#ifdef FEAT_CRYPT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002762 char_u *b_p_cm; // 'cryptmethod'
Bram Moolenaar49771f42010-07-20 17:32:38 +02002763#endif
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002764
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002765 // When a buffer is created, it starts without a swap file. b_may_swap is
2766 // then set to indicate that a swap file may be opened later. It is reset
2767 // if a swap file could not be opened.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 int b_may_swap;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002769 int b_did_warn; // Set to 1 if user has been warned on first
2770 // change of a read-only file
Bram Moolenaar4770d092006-01-12 23:22:24 +00002771
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002772 // Two special kinds of buffers:
2773 // help buffer - used for help files, won't use a swap file.
2774 // spell buffer - used for spell info, never displayed and doesn't have a
2775 // file name.
2776 int b_help; // TRUE for help file buffer (when set b_p_bt
2777 // is "help")
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002778#ifdef FEAT_SPELL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002779 int b_spell; // TRUE for a spell file buffer, most fields
2780 // are not used! Use the B_SPELL macro to
2781 // access b_spell without #ifdef.
Bram Moolenaar4770d092006-01-12 23:22:24 +00002782#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002784 int b_shortname; // this file has an 8.3 file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785
Bram Moolenaarf2732452018-06-03 14:47:35 +02002786#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002787 char_u *b_prompt_text; // set by prompt_setprompt()
2788 callback_T b_prompt_callback; // set by prompt_setcallback()
2789 callback_T b_prompt_interrupt; // set by prompt_setinterrupt()
2790 int b_prompt_insert; // value for restart_edit when entering
2791 // a prompt buffer window.
Bram Moolenaarf2732452018-06-03 14:47:35 +02002792#endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002793#ifdef FEAT_MZSCHEME
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002794 void *b_mzscheme_ref; // The MzScheme reference to this buffer
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002795#endif
2796
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797#ifdef FEAT_PERL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002798 void *b_perl_private;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799#endif
2800
2801#ifdef FEAT_PYTHON
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002802 void *b_python_ref; // The Python reference to this buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803#endif
2804
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02002805#ifdef FEAT_PYTHON3
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002806 void *b_python3_ref; // The Python3 reference to this buffer
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02002807#endif
2808
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809#ifdef FEAT_TCL
Bram Moolenaare344bea2005-09-01 20:46:49 +00002810 void *b_tcl_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811#endif
2812
2813#ifdef FEAT_RUBY
Bram Moolenaare344bea2005-09-01 20:46:49 +00002814 void *b_ruby_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815#endif
2816
Bram Moolenaar860cae12010-06-05 23:22:07 +02002817#if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002818 synblock_T b_s; // Info related to syntax highlighting. w_s
2819 // normally points to this, but some windows
2820 // may use a different synblock_T.
Bram Moolenaarb9a02fc2006-03-12 22:08:12 +00002821#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822
2823#ifdef FEAT_SIGNS
Bram Moolenaar6656c2e2019-10-24 15:00:04 +02002824 sign_entry_T *b_signlist; // list of placed signs
Bram Moolenaar3b7b8362015-03-20 18:11:48 +01002825# ifdef FEAT_NETBEANS_INTG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002826 int b_has_sign_column; // Flag that is set when a first sign is
2827 // added and remains set until the end of
2828 // the netbeans session.
Bram Moolenaar3b7b8362015-03-20 18:11:48 +01002829# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830#endif
2831
2832#ifdef FEAT_NETBEANS_INTG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002833 int b_netbeans_file; // TRUE when buffer is owned by NetBeans
2834 int b_was_netbeans_file;// TRUE if b_netbeans_file was once set
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835#endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01002836#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002837 int b_write_to_channel; // TRUE when appended lines are written to
2838 // a channel.
Bram Moolenaar99ef0622016-03-06 20:22:25 +01002839#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002841#ifdef FEAT_CRYPT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002842 cryptstate_T *b_cryptstate; // Encryption state while reading or writing
2843 // the file. NULL when not using encryption.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002844#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002845 int b_mapped_ctrl_c; // modes where CTRL-C is mapped
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002846
Bram Moolenaare4f25e42017-07-07 11:54:15 +02002847#ifdef FEAT_TERMINAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002848 term_T *b_term; // When not NULL this buffer is for a terminal
2849 // window.
Bram Moolenaare4f25e42017-07-07 11:54:15 +02002850#endif
Bram Moolenaare828b762018-09-10 17:51:58 +02002851#ifdef FEAT_DIFF
2852 int b_diff_failed; // internal diff failed for this buffer
2853#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002854}; // file_buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002856
2857#ifdef FEAT_DIFF
2858/*
2859 * Stuff for diff mode.
2860 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002861# define DB_COUNT 8 // up to eight buffers can be diff'ed
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002862
2863/*
2864 * Each diffblock defines where a block of lines starts in each of the buffers
2865 * and how many lines it occupies in that buffer. When the lines are missing
2866 * in the buffer the df_count[] is zero. This is all counted in
2867 * buffer lines.
2868 * There is always at least one unchanged line in between the diffs.
2869 * Otherwise it would have been included in the diff above or below it.
2870 * df_lnum[] + df_count[] is the lnum below the change. When in one buffer
2871 * lines have been inserted, in the other buffer df_lnum[] is the line below
2872 * the insertion and df_count[] is zero. When appending lines at the end of
2873 * the buffer, df_lnum[] is one beyond the end!
2874 * This is using a linked list, because the number of differences is expected
2875 * to be reasonable small. The list is sorted on lnum.
2876 */
2877typedef struct diffblock_S diff_T;
2878struct diffblock_S
2879{
2880 diff_T *df_next;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002881 linenr_T df_lnum[DB_COUNT]; // line number in buffer
2882 linenr_T df_count[DB_COUNT]; // nr of inserted/changed lines
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002883};
2884#endif
2885
Bram Moolenaar746ebd32009-06-16 14:01:43 +00002886#define SNAP_HELP_IDX 0
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002887#define SNAP_AUCMD_IDX 1
2888#define SNAP_COUNT 2
Bram Moolenaar746ebd32009-06-16 14:01:43 +00002889
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002890/*
2891 * Tab pages point to the top frame of each tab page.
2892 * Note: Most values are NOT valid for the current tab page! Use "curwin",
2893 * "firstwin", etc. for that. "tp_topframe" is always valid and can be
2894 * compared against "topframe" to find the current tab page.
2895 */
2896typedef struct tabpage_S tabpage_T;
2897struct tabpage_S
2898{
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002899 tabpage_T *tp_next; // next tabpage or NULL
2900 frame_T *tp_topframe; // topframe for the windows
2901 win_T *tp_curwin; // current window in this Tab page
2902 win_T *tp_prevwin; // previous window in this Tab page
2903 win_T *tp_firstwin; // first window in this Tab page
2904 win_T *tp_lastwin; // last window in this Tab page
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002905#ifdef FEAT_PROP_POPUP
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002906 win_T *tp_first_popupwin; // first popup window in this Tab page
2907#endif
2908 long tp_old_Rows; // Rows when Tab page was left
2909 long tp_old_Columns; // Columns when Tab page was left
2910 long tp_ch_used; // value of 'cmdheight' when frame size
2911 // was set
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002912#ifdef FEAT_GUI
2913 int tp_prev_which_scrollbars[3];
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002914 // previous value of which_scrollbars
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002915#endif
Bram Moolenaar00aa0692019-04-27 20:37:57 +02002916
2917 char_u *tp_localdir; // absolute path of local directory or
2918 // NULL
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002919#ifdef FEAT_DIFF
2920 diff_T *tp_first_diff;
2921 buf_T *(tp_diffbuf[DB_COUNT]);
Bram Moolenaare3521d92018-09-16 14:10:31 +02002922 int tp_diff_invalid; // list of diffs is outdated
2923 int tp_diff_update; // update diffs before redrawing
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002924#endif
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002925 frame_T *(tp_snapshot[SNAP_COUNT]); // window layout snapshots
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002926#ifdef FEAT_EVAL
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002927 dictitem_T tp_winvar; // variable for "t:" Dictionary
2928 dict_T *tp_vars; // internal variables, local to tab page
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002929#endif
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02002930
2931#ifdef FEAT_PYTHON
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002932 void *tp_python_ref; // The Python value for this tab page
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02002933#endif
2934
2935#ifdef FEAT_PYTHON3
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002936 void *tp_python3_ref; // The Python value for this tab page
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02002937#endif
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002938};
2939
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940/*
2941 * Structure to cache info for displayed lines in w_lines[].
2942 * Each logical line has one entry.
2943 * The entry tells how the logical line is currently displayed in the window.
2944 * This is updated when displaying the window.
2945 * When the display is changed (e.g., when clearing the screen) w_lines_valid
2946 * is changed to exclude invalid entries.
2947 * When making changes to the buffer, wl_valid is reset to indicate wl_size
2948 * may not reflect what is actually in the buffer. When wl_valid is FALSE,
2949 * the entries can only be used to count the number of displayed lines used.
2950 * wl_lnum and wl_lastlnum are invalid too.
2951 */
2952typedef struct w_line
2953{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002954 linenr_T wl_lnum; // buffer line number for logical line
2955 short_u wl_size; // height in screen lines
2956 char wl_valid; // TRUE values are valid for text in buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957#ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002958 char wl_folded; // TRUE when this is a range of folded lines
2959 linenr_T wl_lastlnum; // last buffer line number for logical line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960#endif
2961} wline_T;
2962
2963/*
2964 * Windows are kept in a tree of frames. Each frame has a column (FR_COL)
2965 * or row (FR_ROW) layout or is a leaf, which has a window.
2966 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002967struct frame_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968{
Bram Moolenaarcce713d2019-03-04 11:40:12 +01002969 char fr_layout; // FR_LEAF, FR_COL or FR_ROW
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 int fr_width;
Bram Moolenaarcce713d2019-03-04 11:40:12 +01002971 int fr_newwidth; // new width used in win_equal_rec()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 int fr_height;
Bram Moolenaarcce713d2019-03-04 11:40:12 +01002973 int fr_newheight; // new height used in win_equal_rec()
2974 frame_T *fr_parent; // containing frame or NULL
2975 frame_T *fr_next; // frame right or below in same parent, NULL
2976 // for last
2977 frame_T *fr_prev; // frame left or above in same parent, NULL
2978 // for first
2979 // fr_child and fr_win are mutually exclusive
2980 frame_T *fr_child; // first contained frame
2981 win_T *fr_win; // window that fills this frame
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982};
2983
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002984#define FR_LEAF 0 // frame is a leaf
2985#define FR_ROW 1 // frame with a row of windows
2986#define FR_COL 2 // frame with a column of windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987
2988/*
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002989 * Struct used for highlighting 'hlsearch' matches, matches defined by
2990 * ":match" and matches defined by match functions.
2991 * For 'hlsearch' there is one pattern for all windows. For ":match" and the
2992 * match functions there is a different pattern for each window.
2993 */
2994typedef struct
2995{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02002996 regmmatch_T rm; // points to the regexp program; contains last
2997 // found match (may continue in next line)
2998 buf_T *buf; // the buffer to search for a match
2999 linenr_T lnum; // the line to search for a match
3000 int attr; // attributes to be used for a match
3001 int attr_cur; // attributes currently active in win_line()
3002 linenr_T first_lnum; // first lnum to search for multi-line pat
3003 colnr_T startcol; // in win_line() points to char where HL starts
3004 colnr_T endcol; // in win_line() points to char where HL ends
3005 int is_addpos; // position specified directly by
3006 // matchaddpos(). TRUE/FALSE
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003007#ifdef FEAT_RELTIME
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003008 proftime_T tm; // for a time limit
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003009#endif
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003010} match_T;
3011
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003012// number of positions supported by matchaddpos()
Bram Moolenaarb3414592014-06-17 17:48:32 +02003013#define MAXPOSMATCH 8
3014
3015/*
3016 * Same as lpos_T, but with additional field len.
3017 */
3018typedef struct
3019{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003020 linenr_T lnum; // line number
3021 colnr_T col; // column number
3022 int len; // length: 0 - to the end of line
Bram Moolenaarb3414592014-06-17 17:48:32 +02003023} llpos_T;
3024
3025/*
3026 * posmatch_T provides an array for storing match items for matchaddpos()
3027 * function.
3028 */
3029typedef struct posmatch posmatch_T;
3030struct posmatch
3031{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003032 llpos_T pos[MAXPOSMATCH]; // array of positions
3033 int cur; // internal position counter
3034 linenr_T toplnum; // top buffer line
3035 linenr_T botlnum; // bottom buffer line
Bram Moolenaarb3414592014-06-17 17:48:32 +02003036};
3037
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003038/*
3039 * matchitem_T provides a linked list for storing match items for ":match" and
3040 * the match functions.
3041 */
3042typedef struct matchitem matchitem_T;
3043struct matchitem
3044{
3045 matchitem_T *next;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003046 int id; // match ID
3047 int priority; // match priority
3048 char_u *pattern; // pattern to highlight
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003049 regmmatch_T match; // regexp program for pattern
3050 posmatch_T pos; // position matches
3051 match_T hl; // struct for doing the actual highlighting
Bram Moolenaard6beab02019-11-10 15:07:19 +01003052 int hlg_id; // highlight group ID
Bram Moolenaar6561d522015-07-21 15:48:27 +02003053#ifdef FEAT_CONCEAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003054 int conceal_char; // cchar for Conceal highlighting
Bram Moolenaar6561d522015-07-21 15:48:27 +02003055#endif
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003056};
3057
Bram Moolenaara68e5952019-04-25 22:22:01 +02003058// Structure to store last cursor position and topline. Used by check_lnums()
3059// and reset_lnums().
3060typedef struct
3061{
3062 int w_topline_save; // original topline value
3063 int w_topline_corr; // corrected topline value
3064 pos_T w_cursor_save; // original cursor position
3065 pos_T w_cursor_corr; // corrected cursor position
3066} pos_save_T;
3067
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02003068#ifdef FEAT_MENU
3069typedef struct {
3070 int wb_startcol;
3071 int wb_endcol;
3072 vimmenu_T *wb_menu;
3073} winbar_item_T;
3074#endif
3075
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003076/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 * Structure which contains all information that belongs to a window
3078 *
3079 * All row numbers are relative to the start of the window, except w_winrow.
3080 */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003081struct window_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003083 int w_id; // unique window ID
Bram Moolenaar86edef62016-03-13 18:07:30 +01003084
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003085 buf_T *w_buffer; // buffer we are a window into
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003086
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003087 win_T *w_prev; // link to previous window
3088 win_T *w_next; // link to next window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089
Bram Moolenaar860cae12010-06-05 23:22:07 +02003090#if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003091 synblock_T *w_s; // for :ownsyntax
Bram Moolenaar860cae12010-06-05 23:22:07 +02003092#endif
3093
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003094 int w_closing; // window is being closed, don't let
3095 // autocommands close it too.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003097 frame_T *w_frame; // frame containing this window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003099 pos_T w_cursor; // cursor position in buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003101 colnr_T w_curswant; // The column we'd like to be at. This is
3102 // used to try to stay in the same column
3103 // for up/down cursor motions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003105 int w_set_curswant; // If set, then update w_curswant the next
3106 // time through cursupdate() to the
3107 // current virtual column
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108
Bram Moolenaar4a5abbd2018-10-02 18:26:10 +02003109#ifdef FEAT_SYN_HL
3110 linenr_T w_last_cursorline; // where last time 'cursorline' was drawn
3111#endif
3112
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 /*
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003114 * the next seven are used to update the Visual highlighting
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003116 char w_old_visual_mode; // last known VIsual_mode
3117 linenr_T w_old_cursor_lnum; // last known end of visual part
3118 colnr_T w_old_cursor_fcol; // first column for block visual part
3119 colnr_T w_old_cursor_lcol; // last column for block visual part
3120 linenr_T w_old_visual_lnum; // last known start of visual part
3121 colnr_T w_old_visual_col; // last known start of visual part
3122 colnr_T w_old_curswant; // last known value of Curswant
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123
3124 /*
Bram Moolenaard4153d42008-11-15 15:06:17 +00003125 * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for
3126 * displaying the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003128 linenr_T w_topline; // buffer line number of the line at the
3129 // top of the window
3130 char w_topline_was_set; // flag set to TRUE when topline is set,
3131 // e.g. by winrestview()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132#ifdef FEAT_DIFF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003133 int w_topfill; // number of filler lines above w_topline
3134 int w_old_topfill; // w_topfill at last redraw
3135 int w_botfill; // TRUE when filler lines are actually
3136 // below w_topline (at end of file)
3137 int w_old_botfill; // w_botfill at last redraw
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003139 colnr_T w_leftcol; // window column number of the left most
3140 // character in the window; used when
3141 // 'wrap' is off
3142 colnr_T w_skipcol; // starting column when a single line
3143 // doesn't fit in the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144
3145 /*
3146 * Layout of the window in the screen.
3147 * May need to add "msg_scrolled" to "w_winrow" in rare situations.
3148 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003149 int w_winrow; // first row of window in screen
3150 int w_height; // number of rows in window, excluding
3151 // status/command/winbar line(s)
3152 int w_status_height; // number of status lines (0 or 1)
3153 int w_wincol; // Leftmost column of window in screen.
3154 int w_width; // Width of window, excluding separation.
3155 int w_vsep_width; // Number of separator columns (0 or 1).
3156 pos_save_T w_save_cursor; // backup of cursor pos and topline
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003157#ifdef FEAT_PROP_POPUP
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02003158 int w_popup_flags; // POPF_ values
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003159 int w_popup_handled; // POPUP_HANDLE[0-9] flags
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003160 char_u *w_popup_title;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02003161 poppos_T w_popup_pos;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02003162 int w_popup_fixed; // do not shift popup to fit on screen
Bram Moolenaar12034e22019-08-25 22:25:02 +02003163 int w_popup_prop_type; // when not zero: textprop type ID
3164 win_T *w_popup_prop_win; // window to search for textprop
3165 int w_popup_prop_id; // when not zero: textprop ID
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003166 int w_zindex;
Bram Moolenaar60cdb302019-05-27 21:54:10 +02003167 int w_minheight; // "minheight" for popup window
3168 int w_minwidth; // "minwidth" for popup window
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003169 int w_maxheight; // "maxheight" for popup window
3170 int w_maxwidth; // "maxwidth" for popup window
Bram Moolenaar60cdb302019-05-27 21:54:10 +02003171 int w_wantline; // "line" for popup window
3172 int w_wantcol; // "col" for popup window
Bram Moolenaar8d241042019-06-12 23:40:01 +02003173 int w_firstline; // "firstline" for popup window
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003174 int w_want_scrollbar; // when zero don't use a scrollbar
Bram Moolenaarf9c85f52019-06-29 07:41:35 +02003175 int w_has_scrollbar; // 1 if scrollbar displayed, 0 otherwise
Bram Moolenaar4cd583c2019-06-26 05:13:57 +02003176 char_u *w_scrollbar_highlight; // "scrollbarhighlight"
3177 char_u *w_thumb_highlight; // "thumbhighlight"
Bram Moolenaar2fd8e352019-06-01 20:16:48 +02003178 int w_popup_padding[4]; // popup padding top/right/bot/left
3179 int w_popup_border[4]; // popup border top/right/bot/left
Bram Moolenaar790498b2019-06-01 22:15:29 +02003180 char_u *w_border_highlight[4]; // popup border highlight
3181 int w_border_char[8]; // popup border characters
Bram Moolenaard529ba52019-07-02 23:13:53 +02003182
3183 int w_popup_leftoff; // columns left of the screen
3184 int w_popup_rightoff; // columns right of the screen
Bram Moolenaar12034e22019-08-25 22:25:02 +02003185 varnumber_T w_popup_last_changedtick; // b:changedtick of popup buffer
3186 // when position was computed
3187 varnumber_T w_popup_prop_changedtick; // b:changedtick of buffer with
3188 // w_popup_prop_type when position
3189 // was computed
3190 int w_popup_prop_topline; // w_topline of window with
3191 // w_popup_prop_type when position was
3192 // computed
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +02003193 linenr_T w_popup_last_curline; // last known w_cursor.lnum of window
3194 // with "cursorline" set
Bram Moolenaar9eaac892019-06-01 22:49:29 +02003195 callback_T w_close_cb; // popup close callback
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003196 callback_T w_filter_cb; // popup filter callback
Bram Moolenaar581ba392019-09-03 22:08:33 +02003197 int w_filter_mode; // mode when filter callback is used
Bram Moolenaar3397f742019-06-02 18:40:06 +02003198
3199 win_T *w_popup_curwin; // close popup if curwin differs
3200 linenr_T w_popup_lnum; // close popup if cursor not on this line
3201 colnr_T w_popup_mincol; // close popup if cursor before this col
3202 colnr_T w_popup_maxcol; // close popup if cursor after this col
Bram Moolenaar56a63122019-07-07 18:38:34 +02003203 int w_popup_mouse_row; // close popup if mouse moves away
3204 int w_popup_mouse_mincol; // close popup if mouse moves away
3205 int w_popup_mouse_maxcol; // close popup if mouse moves away
Bram Moolenaar2e62b562019-06-30 18:07:00 +02003206 popclose_T w_popup_close; // allow closing the popup with the mouse
Bram Moolenaar3397f742019-06-02 18:40:06 +02003207
Bram Moolenaar4f0d0022019-07-26 22:20:03 +02003208 list_T *w_popup_mask; // list of lists for "mask"
3209 char_u *w_popup_mask_cells; // cached mask cells
3210 int w_popup_mask_height; // height of w_popup_mask_cells
3211 int w_popup_mask_width; // width of w_popup_mask_cells
Bram Moolenaar35d5af62019-05-26 20:44:10 +02003212# if defined(FEAT_TIMERS)
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02003213 timer_T *w_popup_timer; // timer for closing popup window
Bram Moolenaar35d5af62019-05-26 20:44:10 +02003214# endif
Bram Moolenaar4d784b22019-05-25 19:51:39 +02003215#endif
Bram Moolenaara68e5952019-04-25 22:22:01 +02003216
Bram Moolenaare0de17d2017-09-24 16:24:34 +02003217
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 /*
3219 * === start of cached values ====
3220 */
3221 /*
3222 * Recomputing is minimized by storing the result of computations.
3223 * Use functions in screen.c to check if they are valid and to update.
3224 * w_valid is a bitfield of flags, which indicate if specific values are
3225 * valid or need to be recomputed. See screen.c for values.
3226 */
3227 int w_valid;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003228 pos_T w_valid_cursor; // last known position of w_cursor, used
3229 // to adjust w_valid
3230 colnr_T w_valid_leftcol; // last known w_leftcol
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231
3232 /*
3233 * w_cline_height is the number of physical lines taken by the buffer line
3234 * that the cursor is on. We use this to avoid extra calls to plines().
3235 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003236 int w_cline_height; // current size of cursor line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237#ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003238 int w_cline_folded; // cursor line is folded
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239#endif
3240
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003241 int w_cline_row; // starting row of the cursor line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003243 colnr_T w_virtcol; // column number of the cursor in the
3244 // buffer line, as opposed to the column
3245 // number we're at on the screen. This
3246 // makes a difference on lines which span
3247 // more than one screen line or when
3248 // w_leftcol is non-zero
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249
3250 /*
3251 * w_wrow and w_wcol specify the cursor position in the window.
3252 * This is related to positions in the window, not in the display or
3253 * buffer, thus w_wrow is relative to w_winrow.
3254 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003255 int w_wrow, w_wcol; // cursor position in window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003257 linenr_T w_botline; // number of the line below the bottom of
3258 // the window
3259 int w_empty_rows; // number of ~ rows in window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260#ifdef FEAT_DIFF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003261 int w_filler_rows; // number of filler rows at the end of the
3262 // window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263#endif
3264
3265 /*
3266 * Info about the lines currently in the window is remembered to avoid
3267 * recomputing it every time. The allocated size of w_lines[] is Rows.
3268 * Only the w_lines_valid entries are actually valid.
3269 * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
3270 * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
3271 * Between changing text and updating the display w_lines[] represents
3272 * what is currently displayed. wl_valid is reset to indicated this.
3273 * This is used for efficient redrawing.
3274 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003275 int w_lines_valid; // number of valid entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 wline_T *w_lines;
3277
3278#ifdef FEAT_FOLDING
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003279 garray_T w_folds; // array of nested folds
3280 char w_fold_manual; // when TRUE: some folds are opened/closed
3281 // manually
3282 char w_foldinvalid; // when TRUE: folding needs to be
3283 // recomputed
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003285#ifdef FEAT_LINEBREAK
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003286 int w_nrwidth; // width of 'number' and 'relativenumber'
3287 // column being used
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003288#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289
3290 /*
3291 * === end of cached values ===
3292 */
3293
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003294 int w_redr_type; // type of redraw to be performed on win
3295 int w_upd_rows; // number of window lines to update when
3296 // w_redr_type is REDRAW_TOP
3297 linenr_T w_redraw_top; // when != 0: first line needing redraw
3298 linenr_T w_redraw_bot; // when != 0: last line needing redraw
3299 int w_redr_status; // if TRUE status line must be redrawn
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300
3301#ifdef FEAT_CMDL_INFO
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003302 // remember what is shown in the ruler for this window (if 'ruler' set)
3303 pos_T w_ru_cursor; // cursor position shown in ruler
3304 colnr_T w_ru_virtcol; // virtcol shown in ruler
3305 linenr_T w_ru_topline; // topline shown in ruler
3306 linenr_T w_ru_line_count; // line count used for ruler
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307# ifdef FEAT_DIFF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003308 int w_ru_topfill; // topfill shown in ruler
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309# endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003310 char w_ru_empty; // TRUE if ruler shows 0-1 (empty line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311#endif
3312
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003313 int w_alt_fnum; // alternate file (for # and CTRL-^)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003315 alist_T *w_alist; // pointer to arglist for this window
3316 int w_arg_idx; // current index in argument list (can be
3317 // out of range!)
3318 int w_arg_idx_invalid; // editing another file than w_arg_idx
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003320 char_u *w_localdir; // absolute path of local directory or
3321 // NULL
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02003322#ifdef FEAT_MENU
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003323 vimmenu_T *w_winbar; // The root of the WinBar menu hierarchy.
3324 winbar_item_T *w_winbar_items; // list of items in the WinBar
3325 int w_winbar_height; // 1 if there is a window toolbar
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02003326#endif
3327
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 /*
3329 * Options local to a window.
3330 * They are local because they influence the layout of the window or
3331 * depend on the window layout.
3332 * There are two values: w_onebuf_opt is local to the buffer currently in
3333 * this window, w_allbuf_opt is for all buffers in this window.
3334 */
3335 winopt_T w_onebuf_opt;
3336 winopt_T w_allbuf_opt;
3337
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003338 // A few options have local flags for P_INSECURE.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003339#ifdef FEAT_STL_OPT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003340 long_u w_p_stl_flags; // flags for 'statusline'
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003341#endif
3342#ifdef FEAT_EVAL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003343 long_u w_p_fde_flags; // flags for 'foldexpr'
3344 long_u w_p_fdt_flags; // flags for 'foldtext'
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003345#endif
Bram Moolenaar1a384422010-07-14 19:53:30 +02003346#ifdef FEAT_SYN_HL
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003347 int *w_p_cc_cols; // array of columns to highlight or NULL
Bram Moolenaar017ba072019-09-14 21:01:23 +02003348 char_u w_p_culopt_flags; // flags for cursorline highlighting
Bram Moolenaar1a384422010-07-14 19:53:30 +02003349#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003350 long w_p_siso; // 'sidescrolloff' local value
3351 long w_p_so; // 'scrolloff' local value
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003352
Bram Moolenaarb81f56f2020-02-23 15:29:46 +01003353#ifdef FEAT_LINEBREAK
3354 int w_briopt_min; // minimum width for breakindent
3355 int w_briopt_shift; // additional shift for breakindent
3356 int w_briopt_sbr; // sbr in 'briopt'
3357#endif
3358
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003359 // transform a pointer to a "onebuf" option into a "allbuf" option
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360#define GLOBAL_WO(p) ((char *)p + sizeof(winopt_T))
3361
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 long w_scbind_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363
3364#ifdef FEAT_EVAL
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02003365 dictitem_T w_winvar; // variable for "w:" Dictionary
3366 dict_T *w_vars; // internal variables, local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367#endif
3368
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 /*
3370 * The w_prev_pcmark field is used to check whether we really did jump to
3371 * a new line after setting the w_pcmark. If not, then we revert to
3372 * using the previous w_pcmark.
3373 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003374 pos_T w_pcmark; // previous context mark
3375 pos_T w_prev_pcmark; // previous w_pcmark
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376
3377#ifdef FEAT_JUMPLIST
3378 /*
3379 * the jumplist contains old cursor positions
3380 */
3381 xfmark_T w_jumplist[JUMPLISTSIZE];
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003382 int w_jumplistlen; // number of active entries
3383 int w_jumplistidx; // current position
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003385 int w_changelistidx; // current position in b_changelist
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386#endif
3387
3388#ifdef FEAT_SEARCH_EXTRA
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003389 matchitem_T *w_match_head; // head of match list
3390 int w_next_match_id; // next match ID
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391#endif
3392
3393 /*
3394 * the tagstack grows from 0 upwards:
3395 * entry 0: older
3396 * entry 1: newer
3397 * entry 2: newest
3398 */
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003399 taggy_T w_tagstack[TAGSTACKSIZE]; // the tag stack
3400 int w_tagstackidx; // idx just below active entry
3401 int w_tagstacklen; // number of tags on stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402
3403 /*
3404 * w_fraction is the fractional row of the cursor within the window, from
3405 * 0 at the top row to FRACTION_MULT at the last row.
3406 * w_prev_fraction_row was the actual cursor row when w_fraction was last
3407 * calculated.
3408 */
3409 int w_fraction;
3410 int w_prev_fraction_row;
3411
3412#ifdef FEAT_GUI
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003413 scrollbar_T w_scrollbars[2]; // vert. Scrollbars for this window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003415#ifdef FEAT_LINEBREAK
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003416 linenr_T w_nrwidth_line_count; // line count when ml_nrwidth_width
3417 // was computed.
3418 long w_nuw_cached; // 'numberwidth' option cached
3419 int w_nrwidth_width; // nr of chars to print line count.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003420#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003422#ifdef FEAT_QUICKFIX
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003423 qf_info_T *w_llist; // Location list for this window
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003424 /*
3425 * Location list reference used in the location list window.
3426 * In a non-location list window, w_llist_ref is NULL.
3427 */
3428 qf_info_T *w_llist_ref;
3429#endif
3430
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003431#ifdef FEAT_MZSCHEME
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003432 void *w_mzscheme_ref; // The MzScheme value for this window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003433#endif
3434
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435#ifdef FEAT_PERL
Bram Moolenaare344bea2005-09-01 20:46:49 +00003436 void *w_perl_private;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437#endif
3438
3439#ifdef FEAT_PYTHON
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003440 void *w_python_ref; // The Python value for this window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441#endif
3442
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02003443#ifdef FEAT_PYTHON3
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003444 void *w_python3_ref; // The Python value for this window
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +02003445#endif
3446
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447#ifdef FEAT_TCL
Bram Moolenaare344bea2005-09-01 20:46:49 +00003448 void *w_tcl_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449#endif
3450
3451#ifdef FEAT_RUBY
Bram Moolenaare344bea2005-09-01 20:46:49 +00003452 void *w_ruby_ref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453#endif
3454};
3455
3456/*
3457 * Arguments for operators.
3458 */
Bram Moolenaare344bea2005-09-01 20:46:49 +00003459typedef struct oparg_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003461 int op_type; // current pending operator type
3462 int regname; // register to use for the operator
3463 int motion_type; // type of the current cursor motion
3464 int motion_force; // force motion type: 'v', 'V' or CTRL-V
3465 int use_reg_one; // TRUE if delete uses reg 1 even when not
3466 // linewise
3467 int inclusive; // TRUE if char motion is inclusive (only
3468 // valid when motion_type is MCHAR
3469 int end_adjusted; // backuped b_op_end one char (only used by
3470 // do_format())
3471 pos_T start; // start of the operator
3472 pos_T end; // end of the operator
3473 pos_T cursor_start; // cursor position before motion for "gw"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003475 long line_count; // number of lines from op_start to op_end
3476 // (inclusive)
3477 int empty; // op_start and op_end the same (only used by
3478 // do_change())
3479 int is_VIsual; // operator on Visual area
3480 int block_mode; // current operator is Visual block mode
3481 colnr_T start_vcol; // start col for block mode operator
3482 colnr_T end_vcol; // end col for block mode operator
3483 long prev_opcount; // ca.opcount saved for K_CURSORHOLD
3484 long prev_count0; // ca.count0 saved for K_CURSORHOLD
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485} oparg_T;
3486
3487/*
3488 * Arguments for Normal mode commands.
3489 */
Bram Moolenaare344bea2005-09-01 20:46:49 +00003490typedef struct cmdarg_S
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003492 oparg_T *oap; // Operator arguments
3493 int prechar; // prefix character (optional, always 'g')
3494 int cmdchar; // command character
3495 int nchar; // next command character (optional)
3496 int ncharC1; // first composing character (optional)
3497 int ncharC2; // second composing character (optional)
3498 int extra_char; // yet another character (optional)
3499 long opcount; // count before an operator
3500 long count0; // count before command, default 0
3501 long count1; // count before command, default 1
3502 int arg; // extra argument from nv_cmds[]
3503 int retval; // return: CA_* values
3504 char_u *searchbuf; // return: pointer to search pattern or NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505} cmdarg_T;
3506
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003507// values for retval:
3508#define CA_COMMAND_BUSY 1 // skip restarting edit() once
3509#define CA_NO_ADJ_OP_END 2 // don't adjust operator end
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510
3511#ifdef CURSOR_SHAPE
3512/*
3513 * struct to store values from 'guicursor' and 'mouseshape'
3514 */
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01003515// Indexes in shape_table[]
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003516#define SHAPE_IDX_N 0 // Normal mode
3517#define SHAPE_IDX_V 1 // Visual mode
3518#define SHAPE_IDX_I 2 // Insert mode
3519#define SHAPE_IDX_R 3 // Replace mode
3520#define SHAPE_IDX_C 4 // Command line Normal mode
3521#define SHAPE_IDX_CI 5 // Command line Insert mode
3522#define SHAPE_IDX_CR 6 // Command line Replace mode
3523#define SHAPE_IDX_O 7 // Operator-pending mode
3524#define SHAPE_IDX_VE 8 // Visual mode with 'selection' exclusive
3525#define SHAPE_IDX_CLINE 9 // On command line
3526#define SHAPE_IDX_STATUS 10 // A status line
3527#define SHAPE_IDX_SDRAG 11 // dragging a status line
3528#define SHAPE_IDX_VSEP 12 // A vertical separator line
3529#define SHAPE_IDX_VDRAG 13 // dragging a vertical separator line
3530#define SHAPE_IDX_MORE 14 // Hit-return or More
3531#define SHAPE_IDX_MOREL 15 // Hit-return or More in last line
3532#define SHAPE_IDX_SM 16 // showing matching paren
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533#define SHAPE_IDX_COUNT 17
3534
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003535#define SHAPE_BLOCK 0 // block cursor
3536#define SHAPE_HOR 1 // horizontal bar cursor
3537#define SHAPE_VER 2 // vertical bar cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003539#define MSHAPE_NUMBERED 1000 // offset for shapes identified by number
3540#define MSHAPE_HIDE 1 // hide mouse pointer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003542#define SHAPE_MOUSE 1 // used for mouse pointer shape
3543#define SHAPE_CURSOR 2 // used for text cursor shape
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544
3545typedef struct cursor_entry
3546{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003547 int shape; // one of the SHAPE_ defines
3548 int mshape; // one of the MSHAPE defines
3549 int percentage; // percentage of cell for bar
3550 long blinkwait; // blinking, wait time before blinking starts
3551 long blinkon; // blinking, on time
3552 long blinkoff; // blinking, off time
3553 int id; // highlight group ID
3554 int id_lm; // highlight group ID for :lmap mode
3555 char *name; // mode name (fixed)
3556 char used_for; // SHAPE_MOUSE and/or SHAPE_CURSOR
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557} cursorentry_T;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003558#endif // CURSOR_SHAPE
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559
3560#ifdef FEAT_MENU
3561
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003562// Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563#define MENU_INDEX_INVALID -1
3564#define MENU_INDEX_NORMAL 0
3565#define MENU_INDEX_VISUAL 1
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003566#define MENU_INDEX_SELECT 2
3567#define MENU_INDEX_OP_PENDING 3
3568#define MENU_INDEX_INSERT 4
3569#define MENU_INDEX_CMDLINE 5
Bram Moolenaar4c5d8152018-10-19 22:36:53 +02003570#define MENU_INDEX_TERMINAL 6
3571#define MENU_INDEX_TIP 7
3572#define MENU_MODES 8
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003574// Menu modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575#define MENU_NORMAL_MODE (1 << MENU_INDEX_NORMAL)
3576#define MENU_VISUAL_MODE (1 << MENU_INDEX_VISUAL)
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003577#define MENU_SELECT_MODE (1 << MENU_INDEX_SELECT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578#define MENU_OP_PENDING_MODE (1 << MENU_INDEX_OP_PENDING)
3579#define MENU_INSERT_MODE (1 << MENU_INDEX_INSERT)
3580#define MENU_CMDLINE_MODE (1 << MENU_INDEX_CMDLINE)
Bram Moolenaar4c5d8152018-10-19 22:36:53 +02003581#define MENU_TERMINAL_MODE (1 << MENU_INDEX_TERMINAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582#define MENU_TIP_MODE (1 << MENU_INDEX_TIP)
3583#define MENU_ALL_MODES ((1 << MENU_INDEX_TIP) - 1)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003584// note MENU_INDEX_TIP is not a 'real' mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003586// Start a menu name with this to not include it on the main menu bar
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587#define MNU_HIDDEN_CHAR ']'
3588
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589struct VimMenu
3590{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003591 int modes; // Which modes is this menu visible for?
3592 int enabled; // for which modes the menu is enabled
3593 char_u *name; // Name of menu, possibly translated
3594 char_u *dname; // Displayed Name ("name" without '&')
Bram Moolenaar70b11cd2010-05-14 22:24:40 +02003595#ifdef FEAT_MULTI_LANG
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003596 char_u *en_name; // "name" untranslated, NULL when "name"
3597 // was not translated
3598 char_u *en_dname; // "dname" untranslated, NULL when "dname"
3599 // was not translated
Bram Moolenaar70b11cd2010-05-14 22:24:40 +02003600#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003601 int mnemonic; // mnemonic key (after '&')
3602 char_u *actext; // accelerator text (after TAB)
3603 int priority; // Menu order priority
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604#ifdef FEAT_GUI
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003605 void (*cb)(vimmenu_T *); // Call-back function
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606#endif
3607#ifdef FEAT_TOOLBAR
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003608 char_u *iconfile; // name of file for icon or NULL
3609 int iconidx; // icon index (-1 if not set)
3610 int icon_builtin; // icon names is BuiltIn{nr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003612 char_u *strings[MENU_MODES]; // Mapped string for each mode
3613 int noremap[MENU_MODES]; // A REMAP_ flag for each mode
3614 char silent[MENU_MODES]; // A silent flag for each mode
3615 vimmenu_T *children; // Children of sub-menu
3616 vimmenu_T *parent; // Parent of menu
3617 vimmenu_T *next; // Next item in menu
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618#ifdef FEAT_GUI_X11
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003619 Widget id; // Manage this to enable item
3620 Widget submenu_id; // If this is submenu, add children here
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622#ifdef FEAT_GUI_GTK
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003623 GtkWidget *id; // Manage this to enable item
3624 GtkWidget *submenu_id; // If this is submenu, add children here
Bram Moolenaar98921892016-02-23 17:14:37 +01003625# if defined(GTK_CHECK_VERSION) && !GTK_CHECK_VERSION(3,4,0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 GtkWidget *tearoff_handle;
Bram Moolenaar98921892016-02-23 17:14:37 +01003627# endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003628 GtkWidget *label; // Used by "set wak=" code.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629#endif
3630#ifdef FEAT_GUI_MOTIF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003631 int sensitive; // turn button on/off
3632 char **xpm; // pixmap data
3633 char *xpm_fname; // file with pixmap data
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634#endif
Bram Moolenaarec2dad62005-01-02 11:36:03 +00003635#ifdef FEAT_GUI_ATHENA
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003636 Pixmap image; // Toolbar image
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638#ifdef FEAT_BEVAL_TIP
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003639 BalloonEval *tip; // tooltip for this menu item
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01003641#ifdef FEAT_GUI_MSWIN
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003642 UINT id; // Id of menu item
3643 HMENU submenu_id; // If this is submenu, add children here
3644 HWND tearoff_handle; // hWnd of tearoff if created
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646#ifdef FEAT_GUI_MAC
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003647// MenuHandle id;
3648// short index; // the item index within the father menu
Bram Moolenaar32aa1022019-11-02 22:54:41 +01003649 short menu_id; // the menu id to which this item belongs
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003650 short submenu_id; // the menu id of the children (could be
3651 // get through some tricks)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 MenuHandle menu_handle;
3653 MenuHandle submenu_handle;
3654#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655#ifdef FEAT_GUI_PHOTON
3656 PtWidget_t *id;
3657 PtWidget_t *submenu_id;
3658#endif
3659};
3660#else
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003661// For generating prototypes when FEAT_MENU isn't defined.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662typedef int vimmenu_T;
3663
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003664#endif // FEAT_MENU
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665
3666/*
3667 * Struct to save values in before executing autocommands for a buffer that is
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003668 * not the current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 */
3670typedef struct
3671{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003672 buf_T *save_curbuf; // saved curbuf
3673 int use_aucmd_win; // using aucmd_win
3674 win_T *save_curwin; // saved curwin
3675 win_T *new_curwin; // new curwin
3676 win_T *save_prevwin; // saved prevwin
3677 bufref_T new_curbuf; // new curbuf
3678 char_u *globaldir; // saved value of globaldir
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679} aco_save_T;
3680
3681/*
3682 * Generic option table item, only used for printer at the moment.
3683 */
3684typedef struct
3685{
3686 const char *name;
3687 int hasnum;
3688 long number;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003689 char_u *string; // points into option string
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 int strlen;
3691 int present;
3692} option_table_T;
3693
3694/*
3695 * Structure to hold printing color and font attributes.
3696 */
3697typedef struct
3698{
3699 long_u fg_color;
3700 long_u bg_color;
3701 int bold;
3702 int italic;
3703 int underline;
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003704 int undercurl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705} prt_text_attr_T;
3706
3707/*
3708 * Structure passed back to the generic printer code.
3709 */
3710typedef struct
3711{
3712 int n_collated_copies;
3713 int n_uncollated_copies;
3714 int duplex;
3715 int chars_per_line;
3716 int lines_per_page;
3717 int has_color;
3718 prt_text_attr_T number;
3719#ifdef FEAT_SYN_HL
3720 int modec;
3721 int do_syntax;
3722#endif
3723 int user_abort;
3724 char_u *jobname;
3725#ifdef FEAT_POSTSCRIPT
3726 char_u *outfile;
3727 char_u *arguments;
3728#endif
3729} prt_settings_T;
3730
3731#define PRINT_NUMBER_WIDTH 8
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00003732
3733/*
3734 * Used for popup menu items.
3735 */
3736typedef struct
3737{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003738 char_u *pum_text; // main menu text
3739 char_u *pum_kind; // extra kind text (may be truncated)
3740 char_u *pum_extra; // extra menu text (may be truncated)
3741 char_u *pum_info; // extra info
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00003742} pumitem_T;
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003743
3744/*
3745 * Structure used for get_tagfname().
3746 */
3747typedef struct
3748{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003749 char_u *tn_tags; // value of 'tags' when starting
3750 char_u *tn_np; // current position in tn_tags
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003751 int tn_did_filefind_init;
3752 int tn_hf_idx;
3753 void *tn_search_ctx;
3754} tagname_T;
3755
Bram Moolenaar55debbe2010-05-23 23:34:36 +02003756typedef struct {
3757 UINT32_T total[2];
3758 UINT32_T state[8];
3759 char_u buffer[64];
3760} context_sha256_T;
Bram Moolenaar520e1e42016-01-23 19:46:28 +01003761
3762/*
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01003763 * types for expressions.
3764 */
3765typedef enum
3766{
Bram Moolenaar87396072019-12-31 22:36:18 +01003767 EXPR_UNKNOWN = 0,
3768 EXPR_EQUAL, // ==
3769 EXPR_NEQUAL, // !=
3770 EXPR_GREATER, // >
3771 EXPR_GEQUAL, // >=
3772 EXPR_SMALLER, // <
3773 EXPR_SEQUAL, // <=
3774 EXPR_MATCH, // =~
3775 EXPR_NOMATCH, // !~
3776 EXPR_IS, // is
3777 EXPR_ISNOT, // isnot
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003778 // used with ISN_OPNR
3779 EXPR_ADD, // +
3780 EXPR_SUB, // -
3781 EXPR_MULT, // *
3782 EXPR_DIV, // /
3783 EXPR_REM, // %
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01003784} exptype_T;
3785
3786/*
Bram Moolenaar520e1e42016-01-23 19:46:28 +01003787 * Structure used for reading in json_decode().
3788 */
Bram Moolenaar56ead342016-02-02 18:20:08 +01003789struct js_reader
Bram Moolenaar520e1e42016-01-23 19:46:28 +01003790{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003791 char_u *js_buf; // text to be decoded
3792 char_u *js_end; // NUL in js_buf
3793 int js_used; // bytes used from js_buf
Bram Moolenaar56ead342016-02-02 18:20:08 +01003794 int (*js_fill)(struct js_reader *);
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003795 // function to fill the buffer or NULL;
3796 // return TRUE when the buffer was filled
3797 void *js_cookie; // can be used by js_fill
3798 int js_cookie_arg; // can be used by js_fill
Bram Moolenaar56ead342016-02-02 18:20:08 +01003799};
3800typedef struct js_reader js_read_T;
Bram Moolenaar975b5272016-03-15 23:10:59 +01003801
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003802// Maximum number of commands from + or -c arguments.
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003803#define MAX_ARG_CMDS 10
3804
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003805// values for "window_layout"
3806#define WIN_HOR 1 // "-o" horizontally split windows
3807#define WIN_VER 2 // "-O" vertically split windows
3808#define WIN_TABS 3 // "-p" windows on tab pages
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003809
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003810// Struct for various parameters passed between main() and other functions.
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003811typedef struct
3812{
3813 int argc;
3814 char **argv;
3815
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003816 char_u *fname; // first file to edit
Bram Moolenaara8e691d2016-08-07 15:19:26 +02003817
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003818 int evim_mode; // started as "evim"
3819 char_u *use_vimrc; // vimrc from -u argument
3820 int clean; // --clean argument
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003821
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003822 int n_commands; // no. of commands from + or -c
3823 char_u *commands[MAX_ARG_CMDS]; // commands from + or -c arg.
3824 char_u cmds_tofree[MAX_ARG_CMDS]; // commands that need free()
3825 int n_pre_commands; // no. of commands from --cmd
3826 char_u *pre_commands[MAX_ARG_CMDS]; // commands from --cmd argument
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003827
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003828 int edit_type; // type of editing to do
3829 char_u *tagname; // tag from -t argument
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003830#ifdef FEAT_QUICKFIX
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003831 char_u *use_ef; // 'errorfile' from -q argument
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003832#endif
3833
3834 int want_full_screen;
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003835 int not_a_term; // no warning for missing term?
3836 int tty_fail; // exit if not a tty
3837 char_u *term; // specified terminal name
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003838#ifdef FEAT_CRYPT
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003839 int ask_for_key; // -x argument
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003840#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003841 int no_swap_file; // "-n" argument used
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003842#ifdef FEAT_EVAL
3843 int use_debug_break_level;
3844#endif
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003845 int window_count; // number of windows to use
3846 int window_layout; // 0, WIN_HOR, WIN_VER or WIN_TABS
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003847
3848#ifdef FEAT_CLIENTSERVER
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003849 int serverArg; // TRUE when argument for a server
3850 char_u *serverName_arg; // cmdline arg for server name
3851 char_u *serverStr; // remote server command
3852 char_u *serverStrEnc; // encoding of serverStr
3853 char_u *servername; // allocated name for our server
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003854#endif
3855#if !defined(UNIX)
3856# define EXPAND_FILENAMES
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003857 int literal; // don't expand file names
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003858#endif
3859#ifdef MSWIN
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003860 int full_path; // file name argument was full path
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003861#endif
3862#ifdef FEAT_DIFF
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003863 int diff_mode; // start with 'diff' set
Bram Moolenaar502ae4b2016-07-16 19:50:13 +02003864#endif
3865} mparm_T;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003866
3867/*
3868 * Structure returned by get_lval() and used by set_var_lval().
3869 * For a plain name:
3870 * "name" points to the variable name.
3871 * "exp_name" is NULL.
3872 * "tv" is NULL
3873 * For a magic braces name:
3874 * "name" points to the expanded variable name.
3875 * "exp_name" is non-NULL, to be freed later.
3876 * "tv" is NULL
3877 * For an index in a list:
3878 * "name" points to the (expanded) variable name.
3879 * "exp_name" NULL or non-NULL, to be freed later.
3880 * "tv" points to the (first) list item value
3881 * "li" points to the (first) list item
3882 * "range", "n1", "n2" and "empty2" indicate what items are used.
3883 * For an existing Dict item:
3884 * "name" points to the (expanded) variable name.
3885 * "exp_name" NULL or non-NULL, to be freed later.
3886 * "tv" points to the dict item value
3887 * "newkey" is NULL
3888 * For a non-existing Dict item:
3889 * "name" points to the (expanded) variable name.
3890 * "exp_name" NULL or non-NULL, to be freed later.
3891 * "tv" points to the Dictionary typval_T
3892 * "newkey" is the key for the new item.
3893 */
3894typedef struct lval_S
3895{
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003896 char_u *ll_name; // start of variable name (can be NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003897 char_u *ll_name_end; // end of variable name (can be NULL)
3898 type_T *ll_type; // type of variable (can be NULL)
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003899 char_u *ll_exp_name; // NULL or expanded name in allocated memory.
3900 typval_T *ll_tv; // Typeval of item being used. If "newkey"
3901 // isn't NULL it's the Dict to which to add
3902 // the item.
3903 listitem_T *ll_li; // The list item or NULL.
3904 list_T *ll_list; // The list or NULL.
3905 int ll_range; // TRUE when a [i:j] range was used
Bram Moolenaard6beab02019-11-10 15:07:19 +01003906 int ll_empty2; // Second index is empty: [i:]
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003907 long ll_n1; // First index for list
3908 long ll_n2; // Second index for list range
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003909 dict_T *ll_dict; // The Dictionary or NULL
3910 dictitem_T *ll_di; // The dictitem or NULL
3911 char_u *ll_newkey; // New key for Dict in alloc. mem or NULL.
3912 blob_T *ll_blob; // The Blob or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003913} lval_T;
Bram Moolenaara21a6a92017-09-23 16:33:50 +02003914
Bram Moolenaar6cb39f92019-07-04 16:05:14 +02003915// Structure used to save the current state. Used when executing Normal mode
3916// commands while in any other mode.
Bram Moolenaara21a6a92017-09-23 16:33:50 +02003917typedef struct {
3918 int save_msg_scroll;
3919 int save_restart_edit;
3920 int save_msg_didout;
3921 int save_State;
3922 int save_insertmode;
3923 int save_finish_op;
3924 int save_opcount;
Bram Moolenaarcce713d2019-03-04 11:40:12 +01003925 int save_reg_executing;
Bram Moolenaara21a6a92017-09-23 16:33:50 +02003926 tasave_T tabuf;
3927} save_state_T;
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02003928
3929typedef struct {
3930 varnumber_T vv_prevcount;
3931 varnumber_T vv_count;
3932 varnumber_T vv_count1;
3933} vimvars_save_T;
Bram Moolenaar1063f3d2019-05-07 22:06:52 +02003934
3935// Scope for changing directory
3936typedef enum {
3937 CDSCOPE_GLOBAL, // :cd
3938 CDSCOPE_TABPAGE, // :tcd
3939 CDSCOPE_WINDOW // :lcd
3940} cdscope_T;
Bram Moolenaar451d4b52019-06-12 20:22:27 +02003941
Bram Moolenaardefa0672019-07-21 19:25:37 +02003942// Variable flavor
3943typedef enum
3944{
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02003945 VAR_FLAVOUR_DEFAULT, // doesn't start with uppercase
3946 VAR_FLAVOUR_SESSION, // starts with uppercase, some lower
3947 VAR_FLAVOUR_VIMINFO // all uppercase
Bram Moolenaardefa0672019-07-21 19:25:37 +02003948} var_flavour_T;
3949
Bram Moolenaar451d4b52019-06-12 20:22:27 +02003950// argument for mouse_find_win()
3951typedef enum {
3952 IGNORE_POPUP, // only check non-popup windows
3953 FIND_POPUP, // also find popup windows
3954 FAIL_POPUP // return NULL if mouse on popup window
3955} mouse_find_T;
Bram Moolenaarc3328162019-07-23 22:15:25 +02003956
3957// Symbolic names for some registers.
3958#define DELETION_REGISTER 36
3959#ifdef FEAT_CLIPBOARD
3960# define STAR_REGISTER 37
3961# ifdef FEAT_X11
3962# define PLUS_REGISTER 38
3963# else
3964# define PLUS_REGISTER STAR_REGISTER // there is only one
3965# endif
3966#endif
3967#ifdef FEAT_DND
3968# define TILDE_REGISTER (PLUS_REGISTER + 1)
3969#endif
3970
3971#ifdef FEAT_CLIPBOARD
3972# ifdef FEAT_DND
3973# define NUM_REGISTERS (TILDE_REGISTER + 1)
3974# else
3975# define NUM_REGISTERS (PLUS_REGISTER + 1)
3976# endif
3977#else
3978# define NUM_REGISTERS 37
3979#endif
3980
Bram Moolenaar4aea03e2019-09-25 22:37:17 +02003981// structure used by block_prep, op_delete and op_yank for blockwise operators
3982// also op_change, op_shift, op_insert, op_replace - AKelly
3983struct block_def
3984{
3985 int startspaces; // 'extra' cols before first char
3986 int endspaces; // 'extra' cols after last char
3987 int textlen; // chars in block
3988 char_u *textstart; // pointer to 1st char (partially) in block
3989 colnr_T textcol; // index of chars (partially) in block
3990 colnr_T start_vcol; // start col of 1st char wholly inside block
3991 colnr_T end_vcol; // start col of 1st char wholly after block
3992 int is_short; // TRUE if line is too short to fit in block
3993 int is_MAX; // TRUE if curswant==MAXCOL when starting
3994 int is_oneChar; // TRUE if block within one character
3995 int pre_whitesp; // screen cols of ws before block
3996 int pre_whitesp_c; // chars of ws before block
3997 colnr_T end_char_vcols; // number of vcols of post-block char
3998 colnr_T start_char_vcols; // number of vcols of pre-block char
3999};
4000
Bram Moolenaarc3328162019-07-23 22:15:25 +02004001// Each yank register has an array of pointers to lines.
4002typedef struct
4003{
4004 char_u **y_array; // pointer to array of line pointers
4005 linenr_T y_size; // number of lines in y_array
4006 char_u y_type; // MLINE, MCHAR or MBLOCK
4007 colnr_T y_width; // only set if y_type == MBLOCK
4008#ifdef FEAT_VIMINFO
4009 time_t y_time_set;
4010#endif
4011} yankreg_T;
4012
4013// The offset for a search command is store in a soff struct
4014// Note: only spats[0].off is really used
4015typedef struct soffset
4016{
4017 int dir; // search direction, '/' or '?'
4018 int line; // search has line offset
4019 int end; // search set cursor at end
4020 long off; // line or char offset
4021} soffset_T;
4022
4023// A search pattern and its attributes are stored in a spat struct
4024typedef struct spat
4025{
4026 char_u *pat; // the pattern (in allocated memory) or NULL
4027 int magic; // magicness of the pattern
4028 int no_scs; // no smartcase for this pattern
4029 soffset_T off;
4030} spat_T;
Bram Moolenaar473952e2019-09-28 16:30:04 +02004031
Bram Moolenaar92ea26b2019-10-18 20:53:34 +02004032/*
4033 * Optional extra arguments for searchit().
4034 */
4035typedef struct
4036{
4037 linenr_T sa_stop_lnum; // stop after this line number when != 0
4038#ifdef FEAT_RELTIME
4039 proftime_T *sa_tm; // timeout limit or NULL
4040 int sa_timed_out; // set when timed out
4041#endif
4042 int sa_wrapped; // search wrapped around
4043} searchit_arg_T;
4044
Bram Moolenaar473952e2019-09-28 16:30:04 +02004045#define WRITEBUFSIZE 8192 // size of normal write buffer
4046
4047#define FIO_LATIN1 0x01 // convert Latin1
4048#define FIO_UTF8 0x02 // convert UTF-8
4049#define FIO_UCS2 0x04 // convert UCS-2
4050#define FIO_UCS4 0x08 // convert UCS-4
4051#define FIO_UTF16 0x10 // convert UTF-16
4052#ifdef MSWIN
4053# define FIO_CODEPAGE 0x20 // convert MS-Windows codepage
4054# define FIO_PUT_CP(x) (((x) & 0xffff) << 16) // put codepage in top word
4055# define FIO_GET_CP(x) (((x)>>16) & 0xffff) // get codepage from top word
4056#endif
4057#ifdef MACOS_CONVERT
4058# define FIO_MACROMAN 0x20 // convert MacRoman
4059#endif
4060#define FIO_ENDIAN_L 0x80 // little endian
4061#define FIO_ENCRYPTED 0x1000 // encrypt written bytes
4062#define FIO_NOCONVERT 0x2000 // skip encoding conversion
4063#define FIO_UCSBOM 0x4000 // check for BOM at start of file
4064#define FIO_ALL -1 // allow all formats
4065
4066// When converting, a read() or write() may leave some bytes to be converted
4067// for the next call. The value is guessed...
4068#define CONV_RESTLEN 30
4069
4070// We have to guess how much a sequence of bytes may expand when converting
4071// with iconv() to be able to allocate a buffer.
4072#define ICONV_MULT 8