blob: 07dd6392f3120c69d7e55b5e6408867ed21ec3a3 [file] [log] [blame]
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * vim9.h: types and globals used for Vim9 script.
12 */
13
Bram Moolenaardc7c3662021-12-20 15:04:29 +000014#ifdef VMS
15# include <float.h>
16#endif
17
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010018typedef enum {
19 ISN_EXEC, // execute Ex command line isn_arg.string
Bram Moolenaarcfe435d2020-04-25 20:02:55 +020020 ISN_EXECCONCAT, // execute Ex command from isn_arg.number items on stack
Bram Moolenaar20677332021-06-06 17:02:53 +020021 ISN_EXEC_SPLIT, // execute Ex command from isn_arg.string split at NL
Bram Moolenaare4eed8c2021-12-01 15:22:56 +000022 ISN_EXECRANGE, // execute EX command that is only a range
Bram Moolenaar3b1373b2021-05-17 00:01:42 +020023 ISN_LEGACY_EVAL, // evaluate expression isn_arg.string with legacy syntax.
Bram Moolenaar7de62622021-08-07 15:05:47 +020024 ISN_ECHO, // :echo with isn_arg.echo.echo_count items on top of stack
25 ISN_EXECUTE, // :execute with isn_arg.number items on top of stack
26 ISN_ECHOMSG, // :echomsg with isn_arg.number items on top of stack
27 ISN_ECHOCONSOLE, // :echoconsole with isn_arg.number items on top of stack
28 ISN_ECHOERR, // :echoerr with isn_arg.number items on top of stack
Bram Moolenaar08597872020-12-10 19:43:40 +010029 ISN_RANGE, // compute range from isn_arg.string, push to stack
Bram Moolenaar4c137212021-04-19 16:48:48 +020030 ISN_SUBSTITUTE, // :s command with expression
Bram Moolenaarf18332f2021-05-07 17:55:55 +020031 ISN_INSTR, // instructions compiled from expression
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010032
33 // get and set variables
34 ISN_LOAD, // push local variable isn_arg.number
35 ISN_LOADV, // push v: variable isn_arg.number
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010036 ISN_LOADG, // push g: variable isn_arg.string
Bram Moolenaar03290b82020-12-19 16:30:44 +010037 ISN_LOADAUTO, // push g: autoload variable isn_arg.string
Bram Moolenaard3aac292020-04-19 14:32:17 +020038 ISN_LOADB, // push b: variable isn_arg.string
39 ISN_LOADW, // push w: variable isn_arg.string
40 ISN_LOADT, // push t: variable isn_arg.string
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +020041 ISN_LOADGDICT, // push g: dict
42 ISN_LOADBDICT, // push b: dict
43 ISN_LOADWDICT, // push w: dict
44 ISN_LOADTDICT, // push t: dict
Bram Moolenaarb283a8a2020-02-02 22:24:04 +010045 ISN_LOADS, // push s: variable isn_arg.loadstore
Bram Moolenaarab360522021-01-10 14:02:28 +010046 ISN_LOADOUTER, // push variable from outer scope isn_arg.outer
Bram Moolenaarb283a8a2020-02-02 22:24:04 +010047 ISN_LOADSCRIPT, // push script-local variable isn_arg.script.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010048 ISN_LOADOPT, // push option isn_arg.string
49 ISN_LOADENV, // push environment variable isn_arg.string
50 ISN_LOADREG, // push register isn_arg.number
51
52 ISN_STORE, // pop into local variable isn_arg.number
Bram Moolenaarb283a8a2020-02-02 22:24:04 +010053 ISN_STOREV, // pop into v: variable isn_arg.number
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010054 ISN_STOREG, // pop into global variable isn_arg.string
Bram Moolenaar03290b82020-12-19 16:30:44 +010055 ISN_STOREAUTO, // pop into global autoload variable isn_arg.string
Bram Moolenaard3aac292020-04-19 14:32:17 +020056 ISN_STOREB, // pop into buffer-local variable isn_arg.string
57 ISN_STOREW, // pop into window-local variable isn_arg.string
58 ISN_STORET, // pop into tab-local variable isn_arg.string
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +020059 ISN_STORES, // pop into script variable isn_arg.loadstore
Bram Moolenaarab360522021-01-10 14:02:28 +010060 ISN_STOREOUTER, // pop variable into outer scope isn_arg.outer
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +020061 ISN_STORESCRIPT, // pop into script variable isn_arg.script
Bram Moolenaardcb53be2021-12-09 14:23:43 +000062 ISN_STOREOPT, // pop into option isn_arg.storeopt
63 ISN_STOREFUNCOPT, // pop into option isn_arg.storeopt
Bram Moolenaarb283a8a2020-02-02 22:24:04 +010064 ISN_STOREENV, // pop into environment variable isn_arg.string
65 ISN_STOREREG, // pop into register isn_arg.number
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010066 // ISN_STOREOTHER, // pop into other script variable isn_arg.other.
67
Bram Moolenaara471eea2020-03-04 22:20:26 +010068 ISN_STORENR, // store number into local variable isn_arg.storenr.stnr_idx
Bram Moolenaar4f5e3972020-12-21 17:30:50 +010069 ISN_STOREINDEX, // store into list or dictionary, type isn_arg.vartype,
70 // value/index/variable on stack
Bram Moolenaar68452172021-04-12 21:21:02 +020071 ISN_STORERANGE, // store into blob,
72 // value/index 1/index 2/variable on stack
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073
Bram Moolenaard72c1bf2020-04-19 16:28:59 +020074 ISN_UNLET, // unlet variable isn_arg.unlet.ul_name
Bram Moolenaar7bdaea62020-04-19 18:27:26 +020075 ISN_UNLETENV, // unlet environment variable isn_arg.unlet.ul_name
Bram Moolenaar752fc692021-01-04 21:57:11 +010076 ISN_UNLETINDEX, // unlet item of list or dict
Bram Moolenaar5b5ae292021-02-20 17:04:02 +010077 ISN_UNLETRANGE, // unlet items of list
Bram Moolenaard72c1bf2020-04-19 16:28:59 +020078
Bram Moolenaaraacc9662021-08-13 19:40:51 +020079 ISN_LOCKUNLOCK, // :lock and :unlock for local variable member
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +020080 ISN_LOCKCONST, // lock constant value
81
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010082 // constants
Bram Moolenaar42a480b2020-02-29 23:23:47 +010083 ISN_PUSHNR, // push number isn_arg.number
84 ISN_PUSHBOOL, // push bool value isn_arg.number
85 ISN_PUSHSPEC, // push special value isn_arg.number
86 ISN_PUSHF, // push float isn_arg.fnumber
87 ISN_PUSHS, // push string isn_arg.string
88 ISN_PUSHBLOB, // push blob isn_arg.blob
89 ISN_PUSHFUNC, // push func isn_arg.string
Bram Moolenaar42a480b2020-02-29 23:23:47 +010090 ISN_PUSHCHANNEL, // push channel isn_arg.channel
91 ISN_PUSHJOB, // push channel isn_arg.job
92 ISN_NEWLIST, // push list from stack items, size is isn_arg.number
93 ISN_NEWDICT, // push dict from stack items, size is isn_arg.number
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010094
Bram Moolenaar06b77222022-01-25 15:51:56 +000095 ISN_AUTOLOAD, // get item from autoload import, function or variable
96
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010097 // function call
98 ISN_BCALL, // call builtin function isn_arg.bfunc
99 ISN_DCALL, // call def function isn_arg.dfunc
100 ISN_UCALL, // call user function or funcref/partial isn_arg.ufunc
101 ISN_PCALL, // call partial, use isn_arg.pfunc
Bram Moolenaarbd5da372020-03-31 23:13:10 +0200102 ISN_PCALL_END, // cleanup after ISN_PCALL with cpf_top set
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100103 ISN_RETURN, // return, result is on top of stack
Bram Moolenaarf57b43c2021-06-15 22:13:27 +0200104 ISN_RETURN_VOID, // Push void, then return
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200105 ISN_FUNCREF, // push a function ref to dfunc isn_arg.funcref
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200106 ISN_NEWFUNC, // create a global function from a lambda function
Bram Moolenaar6abdcf82020-11-22 18:15:44 +0100107 ISN_DEF, // list functions
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100108
109 // expression operations
110 ISN_JUMP, // jump if condition is matched isn_arg.jump
Bram Moolenaar4c137212021-04-19 16:48:48 +0200111 ISN_JUMP_IF_ARG_SET, // jump if argument is already set, uses
112 // isn_arg.jumparg
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100113
114 // loop
115 ISN_FOR, // get next item from a list, uses isn_arg.forloop
116
Bram Moolenaar0d807102021-12-21 09:42:09 +0000117 ISN_TRY, // add entry to ec_trystack, uses isn_arg.tryref
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100118 ISN_THROW, // pop value of stack, store in v:exception
119 ISN_PUSHEXC, // push v:exception
120 ISN_CATCH, // drop v:exception
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +0100121 ISN_FINALLY, // start of :finally block
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100122 ISN_ENDTRY, // take entry off from ec_trystack
Bram Moolenaarc150c092021-02-13 15:02:46 +0100123 ISN_TRYCONT, // handle :continue inside a :try statement
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100124
Bram Moolenaar418f1df2020-08-12 21:34:49 +0200125 // more expression operations
Bram Moolenaar1dcae592020-10-19 19:02:42 +0200126 ISN_ADDLIST, // add two lists
127 ISN_ADDBLOB, // add two blobs
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100128
Bram Moolenaar657137c2021-01-09 15:45:23 +0100129 // operation with two arguments; isn_arg.op.op_type is exprtype_T
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100130 ISN_OPNR,
131 ISN_OPFLOAT,
132 ISN_OPANY,
133
Bram Moolenaar657137c2021-01-09 15:45:23 +0100134 // comparative operations; isn_arg.op.op_type is exprtype_T, op_ic used
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100135 ISN_COMPAREBOOL,
136 ISN_COMPARESPECIAL,
Bram Moolenaar7a222242022-03-01 19:23:24 +0000137 ISN_COMPARENULL,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 ISN_COMPARENR,
139 ISN_COMPAREFLOAT,
140 ISN_COMPARESTRING,
141 ISN_COMPAREBLOB,
142 ISN_COMPARELIST,
143 ISN_COMPAREDICT,
144 ISN_COMPAREFUNC,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100145 ISN_COMPAREANY,
146
147 // expression operations
148 ISN_CONCAT,
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +0200149 ISN_STRINDEX, // [expr] string index
Bram Moolenaar11107ba2020-08-15 21:10:16 +0200150 ISN_STRSLICE, // [expr:expr] string slice
Bram Moolenaar1dcae592020-10-19 19:02:42 +0200151 ISN_LISTAPPEND, // append to a list, like add()
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +0200152 ISN_LISTINDEX, // [expr] list index
Bram Moolenaared591872020-08-15 22:14:53 +0200153 ISN_LISTSLICE, // [expr:expr] list slice
Bram Moolenaarcfc30232021-04-11 20:26:34 +0200154 ISN_BLOBINDEX, // [expr] blob index
155 ISN_BLOBSLICE, // [expr:expr] blob slice
Bram Moolenaarcc673e72020-08-16 17:33:35 +0200156 ISN_ANYINDEX, // [expr] runtime index
157 ISN_ANYSLICE, // [expr:expr] runtime slice
Bram Moolenaar9af78762020-06-16 11:34:42 +0200158 ISN_SLICE, // drop isn_arg.number items from start of list
Bram Moolenaar80b0e5e2020-10-19 20:45:36 +0200159 ISN_BLOBAPPEND, // append to a blob, like add()
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200160 ISN_GETITEM, // push list item, isn_arg.number is the index
Bram Moolenaar1cc2a942020-05-10 19:10:31 +0200161 ISN_MEMBER, // dict[member]
162 ISN_STRINGMEMBER, // dict.member using isn_arg.string
Bram Moolenaar5fa9b242021-06-04 21:00:32 +0200163 ISN_2BOOL, // falsy/truthy to bool, uses isn_arg.tobool
Bram Moolenaar2bb26582020-10-03 22:52:39 +0200164 ISN_COND2BOOL, // convert value to bool
Bram Moolenaar5fa9b242021-06-04 21:00:32 +0200165 ISN_2STRING, // convert value to string at isn_arg.tostring on stack
Bram Moolenaar418f1df2020-08-12 21:34:49 +0200166 ISN_2STRING_ANY, // like ISN_2STRING but check type
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100167 ISN_NEGATENR, // apply "-" to number
168
169 ISN_CHECKNR, // check value can be used as a number
Bram Moolenaar628c1022021-01-02 15:49:28 +0100170 ISN_CHECKTYPE, // check value type is isn_arg.type.ct_type
Bram Moolenaar9af78762020-06-16 11:34:42 +0200171 ISN_CHECKLEN, // check list length is isn_arg.checklen.cl_min_len
Bram Moolenaar628c1022021-01-02 15:49:28 +0100172 ISN_SETTYPE, // set dict type to isn_arg.type.ct_type
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100173
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +0200174 ISN_CLEARDICT, // clear dict saved by ISN_MEMBER/ISN_STRINGMEMBER
175 ISN_USEDICT, // use or clear dict saved by ISN_MEMBER/ISN_STRINGMEMBER
176
Bram Moolenaarc3516f72020-09-08 22:45:35 +0200177 ISN_PUT, // ":put", uses isn_arg.put
178
Bram Moolenaar02194d22020-10-24 23:08:38 +0200179 ISN_CMDMOD, // set cmdmod
180 ISN_CMDMOD_REV, // undo ISN_CMDMOD
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +0200181
Bram Moolenaarb2049902021-01-24 12:53:53 +0100182 ISN_PROF_START, // start a line for profiling
183 ISN_PROF_END, // end a line for profiling
184
Bram Moolenaar8cec9272021-06-23 20:20:53 +0200185 ISN_DEBUG, // check for debug breakpoint, uses isn_arg.debug
Bram Moolenaare99d4222021-06-13 14:01:26 +0200186
Bram Moolenaar792f7862020-11-23 08:31:18 +0100187 ISN_UNPACK, // unpack list into items, uses isn_arg.unpack
Bram Moolenaar389df252020-07-09 21:20:47 +0200188 ISN_SHUFFLE, // move item on stack up or down
Bram Moolenaar4c137212021-04-19 16:48:48 +0200189 ISN_DROP, // pop stack and discard value
190
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +0200191 ISN_REDIRSTART, // :redir =>
192 ISN_REDIREND, // :redir END, isn_arg.number == 1 for append
193
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +0200194 ISN_CEXPR_AUCMD, // first part of :cexpr isn_arg.number is cmdidx
195 ISN_CEXPR_CORE, // second part of :cexpr, uses isn_arg.cexpr
196
Bram Moolenaar4c137212021-04-19 16:48:48 +0200197 ISN_FINISH // end marker in list of instructions
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100198} isntype_T;
199
200
201// arguments to ISN_BCALL
202typedef struct {
203 int cbf_idx; // index in "global_functions"
204 int cbf_argcount; // number of arguments on top of stack
205} cbfunc_T;
206
207// arguments to ISN_DCALL
208typedef struct {
209 int cdf_idx; // index in "def_functions" for ISN_DCALL
210 int cdf_argcount; // number of arguments on top of stack
211} cdfunc_T;
212
213// arguments to ISN_PCALL
214typedef struct {
215 int cpf_top; // when TRUE partial is above the arguments
216 int cpf_argcount; // number of arguments on top of stack
217} cpfunc_T;
218
219// arguments to ISN_UCALL and ISN_XCALL
220typedef struct {
221 char_u *cuf_name;
222 int cuf_argcount; // number of arguments on top of stack
223} cufunc_T;
224
Bram Moolenaar035bd1c2021-06-21 19:44:11 +0200225// arguments to ISN_GETITEM
226typedef struct {
227 varnumber_T gi_index;
228 int gi_with_op;
229} getitem_T;
230
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100231typedef enum {
232 JUMP_ALWAYS,
Bram Moolenaar1a7ee4d2021-09-16 16:15:07 +0200233 JUMP_NEVER,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100234 JUMP_IF_FALSE, // pop and jump if false
Bram Moolenaar2bb26582020-10-03 22:52:39 +0200235 JUMP_AND_KEEP_IF_TRUE, // jump if top of stack is truthy, drop if not
236 JUMP_AND_KEEP_IF_FALSE, // jump if top of stack is falsy, drop if not
237 JUMP_IF_COND_TRUE, // jump if top of stack is true, drop if not
238 JUMP_IF_COND_FALSE, // jump if top of stack is false, drop if not
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100239} jumpwhen_T;
240
241// arguments to ISN_JUMP
242typedef struct {
243 jumpwhen_T jump_when;
244 int jump_where; // position to jump to
245} jump_T;
246
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200247// arguments to ISN_JUMP_IF_ARG_SET
248typedef struct {
249 int jump_arg_off; // argument index, negative
250 int jump_where; // position to jump to
251} jumparg_T;
252
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253// arguments to ISN_FOR
254typedef struct {
255 int for_idx; // loop variable index
256 int for_end; // position to jump to after done
257} forloop_T;
258
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +0100259// indirect arguments to ISN_TRY
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100260typedef struct {
261 int try_catch; // position to jump to on throw
Bram Moolenaarc150c092021-02-13 15:02:46 +0100262 int try_finally; // :finally or :endtry position to jump to
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +0100263 int try_endtry; // :endtry position to jump to
264} tryref_T;
265
266// arguments to ISN_TRY
267typedef struct {
268 tryref_T *try_ref;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100269} try_T;
270
Bram Moolenaarc150c092021-02-13 15:02:46 +0100271// arguments to ISN_TRYCONT
272typedef struct {
273 int tct_levels; // number of nested try statements
274 int tct_where; // position to jump to, WHILE or FOR
275} trycont_T;
276
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100277// arguments to ISN_ECHO
278typedef struct {
279 int echo_with_white; // :echo instead of :echon
280 int echo_count; // number of expressions
281} echo_T;
282
283// arguments to ISN_OPNR, ISN_OPFLOAT, etc.
284typedef struct {
Bram Moolenaar657137c2021-01-09 15:45:23 +0100285 exprtype_T op_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100286 int op_ic; // TRUE with '#', FALSE with '?', else MAYBE
287} opexpr_T;
288
289// arguments to ISN_CHECKTYPE
290typedef struct {
Bram Moolenaar5e654232020-09-16 15:22:00 +0200291 type_T *ct_type;
Bram Moolenaarb3005ce2021-01-22 17:51:06 +0100292 int8_T ct_off; // offset in stack, -1 is bottom
293 int8_T ct_arg_idx; // argument index or zero
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100294} checktype_T;
295
296// arguments to ISN_STORENR
297typedef struct {
Bram Moolenaara471eea2020-03-04 22:20:26 +0100298 int stnr_idx;
299 varnumber_T stnr_val;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100300} storenr_T;
301
Bram Moolenaardcb53be2021-12-09 14:23:43 +0000302// arguments to ISN_STOREOPT and ISN_STOREFUNCOPT
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100303typedef struct {
304 char_u *so_name;
305 int so_flags;
306} storeopt_T;
307
Bram Moolenaarb283a8a2020-02-02 22:24:04 +0100308// arguments to ISN_LOADS and ISN_STORES
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100309typedef struct {
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +0200310 char_u *ls_name; // variable name (with s: for ISN_STORES)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100311 int ls_sid; // script ID
Bram Moolenaarb283a8a2020-02-02 22:24:04 +0100312} loadstore_T;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100313
Bram Moolenaarb283a8a2020-02-02 22:24:04 +0100314// arguments to ISN_LOADSCRIPT and ISN_STORESCRIPT
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100315typedef struct {
Bram Moolenaar4aab88d2020-12-24 21:56:41 +0100316 int sref_sid; // script ID
317 int sref_idx; // index in sn_var_vals
318 int sref_seq; // sn_script_seq when compiled
Bram Moolenaar07a65d22020-12-26 20:09:15 +0100319 type_T *sref_type; // type of the variable when compiled
Bram Moolenaar4aab88d2020-12-24 21:56:41 +0100320} scriptref_T;
321
322typedef struct {
323 scriptref_T *scriptref;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100324} script_T;
325
Bram Moolenaard72c1bf2020-04-19 16:28:59 +0200326// arguments to ISN_UNLET
327typedef struct {
328 char_u *ul_name; // variable name with g:, w:, etc.
329 int ul_forceit; // forceit flag
330} unlet_T;
331
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200332// arguments to ISN_FUNCREF
333typedef struct {
Bram Moolenaar38453522021-11-28 22:00:12 +0000334 int fr_dfunc_idx; // function index for :def function
335 char_u *fr_func_name; // function name for legacy function
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200336} funcref_T;
337
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200338// arguments to ISN_NEWFUNC
339typedef struct {
340 char_u *nf_lambda; // name of the lambda already defined
341 char_u *nf_global; // name of the global function to be created
342} newfunc_T;
343
Bram Moolenaar9af78762020-06-16 11:34:42 +0200344// arguments to ISN_CHECKLEN
345typedef struct {
346 int cl_min_len; // minimum length
347 int cl_more_OK; // longer is allowed
348} checklen_T;
349
Bram Moolenaar389df252020-07-09 21:20:47 +0200350// arguments to ISN_SHUFFLE
351typedef struct {
352 int shfl_item; // item to move (relative to top of stack)
353 int shfl_up; // places to move upwards
354} shuffle_T;
355
Bram Moolenaarc3516f72020-09-08 22:45:35 +0200356// arguments to ISN_PUT
357typedef struct {
358 int put_regname; // register, can be NUL
359 linenr_T put_lnum; // line number to put below
360} put_T;
361
Bram Moolenaar02194d22020-10-24 23:08:38 +0200362// arguments to ISN_CMDMOD
363typedef struct {
364 cmdmod_T *cf_cmdmod; // allocated
365} cmod_T;
366
Bram Moolenaar792f7862020-11-23 08:31:18 +0100367// arguments to ISN_UNPACK
368typedef struct {
369 int unp_count; // number of items to produce
370 int unp_semicolon; // last item gets list of remainder
371} unpack_T;
372
Bram Moolenaarab360522021-01-10 14:02:28 +0100373// arguments to ISN_LOADOUTER and ISN_STOREOUTER
374typedef struct {
375 int outer_idx; // index
376 int outer_depth; // nesting level, stack frames to go up
Bram Moolenaar0186e582021-01-10 18:33:11 +0100377} isn_outer_T;
Bram Moolenaarab360522021-01-10 14:02:28 +0100378
Bram Moolenaar4c137212021-04-19 16:48:48 +0200379// arguments to ISN_SUBSTITUTE
380typedef struct {
381 char_u *subs_cmd; // :s command
382 isn_T *subs_instr; // sequence of instructions
383} subs_T;
384
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +0200385// indirect arguments to ISN_TRY
386typedef struct {
387 int cer_cmdidx;
388 char_u *cer_cmdline;
389 int cer_forceit;
390} cexprref_T;
391
392// arguments to ISN_CEXPR_CORE
393typedef struct {
394 cexprref_T *cexpr_ref;
395} cexpr_T;
396
Bram Moolenaar5fa9b242021-06-04 21:00:32 +0200397// arguments to ISN_2STRING and ISN_2STRING_ANY
398typedef struct {
399 int offset;
400 int tolerant;
401} tostring_T;
402
403// arguments to ISN_2BOOL
404typedef struct {
405 int offset;
406 int invert;
407} tobool_T;
408
Bram Moolenaar8cec9272021-06-23 20:20:53 +0200409// arguments to ISN_DEBUG
410typedef struct {
411 varnumber_T dbg_var_names_len; // current number of local variables
412 int dbg_break_lnum; // first line to break after
413} debug_T;
414
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100415/*
416 * Instruction
417 */
Bram Moolenaar20431c92020-03-20 18:39:46 +0100418struct isn_S {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100419 isntype_T isn_type;
420 int isn_lnum;
421 union {
422 char_u *string;
423 varnumber_T number;
424 blob_T *blob;
Bram Moolenaar4f5e3972020-12-21 17:30:50 +0100425 vartype_T vartype;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100426#ifdef FEAT_FLOAT
427 float_T fnumber;
428#endif
Bram Moolenaar42a480b2020-02-29 23:23:47 +0100429 channel_T *channel;
430 job_T *job;
Bram Moolenaar087d2e12020-03-01 15:36:42 +0100431 partial_T *partial;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100432 jump_T jump;
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200433 jumparg_T jumparg;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100434 forloop_T forloop;
Bram Moolenaar0d807102021-12-21 09:42:09 +0000435 try_T tryref;
Bram Moolenaarc150c092021-02-13 15:02:46 +0100436 trycont_T trycont;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100437 cbfunc_T bfunc;
438 cdfunc_T dfunc;
439 cpfunc_T pfunc;
440 cufunc_T ufunc;
441 echo_T echo;
442 opexpr_T op;
443 checktype_T type;
444 storenr_T storenr;
445 storeopt_T storeopt;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +0100446 loadstore_T loadstore;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100447 script_T script;
Bram Moolenaard72c1bf2020-04-19 16:28:59 +0200448 unlet_T unlet;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200449 funcref_T funcref;
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200450 newfunc_T newfunc;
Bram Moolenaar9af78762020-06-16 11:34:42 +0200451 checklen_T checklen;
Bram Moolenaar389df252020-07-09 21:20:47 +0200452 shuffle_T shuffle;
Bram Moolenaarc3516f72020-09-08 22:45:35 +0200453 put_T put;
Bram Moolenaar02194d22020-10-24 23:08:38 +0200454 cmod_T cmdmod;
Bram Moolenaar792f7862020-11-23 08:31:18 +0100455 unpack_T unpack;
Bram Moolenaar0186e582021-01-10 18:33:11 +0100456 isn_outer_T outer;
Bram Moolenaar4c137212021-04-19 16:48:48 +0200457 subs_T subs;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +0200458 cexpr_T cexpr;
Bram Moolenaarf18332f2021-05-07 17:55:55 +0200459 isn_T *instr;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +0200460 tostring_T tostring;
461 tobool_T tobool;
Bram Moolenaar035bd1c2021-06-21 19:44:11 +0200462 getitem_T getitem;
Bram Moolenaar8cec9272021-06-23 20:20:53 +0200463 debug_T debug;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100464 } isn_arg;
Bram Moolenaar20431c92020-03-20 18:39:46 +0100465};
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100466
467/*
468 * Info about a function defined with :def. Used in "def_functions".
469 */
470struct dfunc_S {
471 ufunc_T *df_ufunc; // struct containing most stuff
Bram Moolenaarcd45ed02020-12-22 17:35:54 +0100472 int df_refcount; // how many ufunc_T point to this dfunc_T
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100473 int df_idx; // index in def_functions
474 int df_deleted; // if TRUE function was deleted
Bram Moolenaar4aab88d2020-12-24 21:56:41 +0100475 int df_script_seq; // Value of sctx_T sc_seq when the function
476 // was compiled.
Dominique Pelle3276f582021-08-07 12:44:41 +0200477 char_u *df_name; // name used for error messages
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100478
479 garray_T df_def_args_isn; // default argument instructions
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200480 garray_T df_var_names; // names of local vars
Bram Moolenaarb2049902021-01-24 12:53:53 +0100481
482 // After compiling "df_instr" and/or "df_instr_prof" is not NULL.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100483 isn_T *df_instr; // function body to be executed
Bram Moolenaarb2049902021-01-24 12:53:53 +0100484 int df_instr_count; // size of "df_instr"
Dominique Pelle3276f582021-08-07 12:44:41 +0200485 int df_instr_debug_count; // size of "df_instr_debug"
486 isn_T *df_instr_debug; // like "df_instr" with debugging
Bram Moolenaarf002a412021-01-24 13:34:18 +0100487#ifdef FEAT_PROFILE
488 isn_T *df_instr_prof; // like "df_instr" with profiling
489 int df_instr_prof_count; // size of "df_instr_prof"
490#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100491
492 int df_varcount; // number of local variables
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200493 int df_has_closure; // one if a closure was created
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100494};
495
496// Number of entries used by stack frame for a function call.
Bram Moolenaar5366e1a2020-10-01 13:01:34 +0200497// - ec_dfunc_idx: function index
498// - ec_iidx: instruction index
Bram Moolenaar5930ddc2021-04-26 20:32:59 +0200499// - ec_instr: instruction list pointer
Bram Moolenaar0186e582021-01-10 18:33:11 +0100500// - ec_outer: stack used for closures
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100501// - funclocal: function-local data
Bram Moolenaar5366e1a2020-10-01 13:01:34 +0200502// - ec_frame_idx: previous frame index
Bram Moolenaar0186e582021-01-10 18:33:11 +0100503#define STACK_FRAME_FUNC_OFF 0
504#define STACK_FRAME_IIDX_OFF 1
Bram Moolenaar5930ddc2021-04-26 20:32:59 +0200505#define STACK_FRAME_INSTR_OFF 2
506#define STACK_FRAME_OUTER_OFF 3
507#define STACK_FRAME_FUNCLOCAL_OFF 4
508#define STACK_FRAME_IDX_OFF 5
509#define STACK_FRAME_SIZE 6
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100510
511
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100512extern garray_T def_functions;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100513
Bram Moolenaar08597872020-12-10 19:43:40 +0100514// Used for "lnum" when a range is to be taken from the stack.
515#define LNUM_VARIABLE_RANGE -999
516
517// Used for "lnum" when a range is to be taken from the stack and "!" is used.
518#define LNUM_VARIABLE_RANGE_ABOVE -888
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100519
Bram Moolenaarc3a27bb2021-06-13 15:16:01 +0200520// Keep in sync with COMPILE_TYPE()
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100521#ifdef FEAT_PROFILE
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100522# define INSTRUCTIONS(dfunc) \
Bram Moolenaar26a44842021-09-02 18:49:06 +0200523 (debug_break_level > 0 || may_break_in_function(dfunc->df_ufunc) \
Bram Moolenaarc3a27bb2021-06-13 15:16:01 +0200524 ? (dfunc)->df_instr_debug \
525 : ((do_profiling == PROF_YES && (dfunc->df_ufunc)->uf_profiling) \
526 ? (dfunc)->df_instr_prof \
527 : (dfunc)->df_instr))
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100528#else
Bram Moolenaarc3a27bb2021-06-13 15:16:01 +0200529# define INSTRUCTIONS(dfunc) \
Bram Moolenaar26a44842021-09-02 18:49:06 +0200530 (debug_break_level > 0 || may_break_in_function(dfunc->df_ufunc) \
Bram Moolenaarc3a27bb2021-06-13 15:16:01 +0200531 ? (dfunc)->df_instr_debug \
532 : (dfunc)->df_instr)
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100533#endif
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000534
535// Structure passed between the compile_expr* functions to keep track of
536// constants that have been parsed but for which no code was produced yet. If
537// possible expressions on these constants are applied at compile time. If
538// that is not possible, the code to push the constants needs to be generated
539// before other instructions.
540// Using 50 should be more than enough of 5 levels of ().
541#define PPSIZE 50
542typedef struct {
543 typval_T pp_tv[PPSIZE]; // stack of ppconst constants
544 int pp_used; // active entries in pp_tv[]
545 int pp_is_const; // all generated code was constants, used for a
546 // list or dict with constant members
547} ppconst_T;
548
549// values for ctx_skip
550typedef enum {
551 SKIP_NOT, // condition is a constant, produce code
552 SKIP_YES, // condition is a constant, do NOT produce code
553 SKIP_UNKNOWN // condition is not a constant, produce code
554} skip_T;
555
556/*
557 * Chain of jump instructions where the end label needs to be set.
558 */
559typedef struct endlabel_S endlabel_T;
560struct endlabel_S {
561 endlabel_T *el_next; // chain end_label locations
562 int el_end_label; // instruction idx where to set end
563};
564
565/*
566 * info specific for the scope of :if / elseif / else
567 */
568typedef struct {
569 int is_seen_else;
570 int is_seen_skip_not; // a block was unconditionally executed
571 int is_had_return; // every block ends in :return
572 int is_if_label; // instruction idx at IF or ELSEIF
573 endlabel_T *is_end_label; // instructions to set end label
574} ifscope_T;
575
576/*
577 * info specific for the scope of :while
578 */
579typedef struct {
580 int ws_top_label; // instruction idx at WHILE
581 endlabel_T *ws_end_label; // instructions to set end
582} whilescope_T;
583
584/*
585 * info specific for the scope of :for
586 */
587typedef struct {
588 int fs_top_label; // instruction idx at FOR
589 endlabel_T *fs_end_label; // break instructions
590} forscope_T;
591
592/*
593 * info specific for the scope of :try
594 */
595typedef struct {
596 int ts_try_label; // instruction idx at TRY
597 endlabel_T *ts_end_label; // jump to :finally or :endtry
598 int ts_catch_label; // instruction idx of last CATCH
599 int ts_caught_all; // "catch" without argument encountered
Bram Moolenaar53c29612022-01-12 16:18:18 +0000600 int ts_has_finally; // "finally" encountered
601 int ts_no_return; // one of the blocks did not end in return
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000602} tryscope_T;
603
604typedef enum {
605 NO_SCOPE,
606 IF_SCOPE,
607 WHILE_SCOPE,
608 FOR_SCOPE,
609 TRY_SCOPE,
610 BLOCK_SCOPE
611} scopetype_T;
612
613/*
614 * Info for one scope, pointed to by "ctx_scope".
615 */
616typedef struct scope_S scope_T;
617struct scope_S {
618 scope_T *se_outer; // scope containing this one
619 scopetype_T se_type;
620 int se_local_count; // ctx_locals.ga_len before scope
621 skip_T se_skip_save; // ctx_skip before the block
622 union {
623 ifscope_T se_if;
624 whilescope_T se_while;
625 forscope_T se_for;
626 tryscope_T se_try;
627 } se_u;
628};
629
630/*
631 * Entry for "ctx_locals". Used for arguments and local variables.
632 */
633typedef struct {
634 char_u *lv_name;
635 type_T *lv_type;
636 int lv_idx; // index of the variable on the stack
637 int lv_from_outer; // nesting level, using ctx_outer scope
638 int lv_const; // when TRUE cannot be assigned to
639 int lv_arg; // when TRUE this is an argument
640} lvar_T;
641
642// Destination for an assignment or ":unlet" with an index.
643typedef enum {
644 dest_local,
645 dest_option,
646 dest_func_option,
647 dest_env,
648 dest_global,
649 dest_buffer,
650 dest_window,
651 dest_tab,
652 dest_vimvar,
653 dest_script,
654 dest_reg,
655 dest_expr,
656} assign_dest_T;
657
658// Used by compile_lhs() to store information about the LHS of an assignment
659// and one argument of ":unlet" with an index.
660typedef struct {
661 assign_dest_T lhs_dest; // type of destination
662
663 char_u *lhs_name; // allocated name excluding the last
664 // "[expr]" or ".name".
665 size_t lhs_varlen; // length of the variable without
666 // "[expr]" or ".name"
667 char_u *lhs_whole; // allocated name including the last
668 // "[expr]" or ".name" for :redir
669 size_t lhs_varlen_total; // length of the variable including
670 // any "[expr]" or ".name"
671 char_u *lhs_dest_end; // end of the destination, including
672 // "[expr]" or ".name".
673 char_u *lhs_end; // end including any type
674
675 int lhs_has_index; // has "[expr]" or ".name"
676
677 int lhs_new_local; // create new local variable
678 int lhs_opt_flags; // for when destination is an option
679 int lhs_vimvaridx; // for when destination is a v:var
680
681 lvar_T lhs_local_lvar; // used for existing local destination
682 lvar_T lhs_arg_lvar; // used for argument destination
683 lvar_T *lhs_lvar; // points to destination lvar
684 int lhs_scriptvar_sid;
685 int lhs_scriptvar_idx;
686
687 int lhs_has_type; // type was specified
688 type_T *lhs_type;
689 type_T *lhs_member_type;
690
691 int lhs_append; // used by ISN_REDIREND
692} lhs_T;
693
694/*
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000695 * Context for compiling lines of a :def function.
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000696 * Stores info about the local variables and condition stack.
697 */
698struct cctx_S {
699 ufunc_T *ctx_ufunc; // current function
700 int ctx_lnum; // line number in current function
701 char_u *ctx_line_start; // start of current line or NULL
702 garray_T ctx_instr; // generated instructions
703
704 int ctx_prev_lnum; // line number below previous command, for
705 // debugging
706
707 compiletype_T ctx_compile_type;
708
709 garray_T ctx_locals; // currently visible local variables
710
Dominique Pelleaf4a61a2021-12-27 17:21:41 +0000711 int ctx_has_closure; // set to one if a closure was created in
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000712 // the function
713
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000714 skip_T ctx_skip;
715 scope_T *ctx_scope; // current scope, NULL at toplevel
716 int ctx_had_return; // last seen statement was "return"
717
718 cctx_T *ctx_outer; // outer scope for lambda or nested
719 // function
720 int ctx_outer_used; // var in ctx_outer was used
721
722 garray_T ctx_type_stack; // type of each item on the stack
723 garray_T *ctx_type_list; // list of pointers to allocated types
724
725 int ctx_has_cmdmod; // ISN_CMDMOD was generated
726
727 lhs_T ctx_redir_lhs; // LHS for ":redir => var", valid when
728 // lhs_name is not NULL
729};
730
Bram Moolenaar114dbda2022-01-03 12:28:03 +0000731// flags for typval2type()
732#define TVTT_DO_MEMBER 1
733#define TVTT_MORE_SPECIFIC 2 // get most specific type for member
734