blob: f8e5e5634f6ba79fa7ed6bb0b3beb6c2f12cb390 [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
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +010028 ISN_ECHOWINDOW, // :echowindow with isn_arg.number items on top of stack
Bram Moolenaar7de62622021-08-07 15:05:47 +020029 ISN_ECHOERR, // :echoerr with isn_arg.number items on top of stack
Bram Moolenaar08597872020-12-10 19:43:40 +010030 ISN_RANGE, // compute range from isn_arg.string, push to stack
Bram Moolenaar4c137212021-04-19 16:48:48 +020031 ISN_SUBSTITUTE, // :s command with expression
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +010032
33 ISN_SOURCE, // source autoload script, isn_arg.number is the script ID
Bram Moolenaarf18332f2021-05-07 17:55:55 +020034 ISN_INSTR, // instructions compiled from expression
Bram Moolenaar00b28d62022-12-08 15:32:33 +000035 ISN_CONSTRUCT, // construct an object, using contstruct_T
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +000036 ISN_GET_OBJ_MEMBER, // object member, index is isn_arg.number
37 ISN_STORE_THIS, // store value in "this" object member, index is
38 // isn_arg.number
Bram Moolenaard505d172022-12-18 21:42:55 +000039 ISN_LOAD_CLASSMEMBER, // load class member, using classmember_T
40 ISN_STORE_CLASSMEMBER, // store in class member, using classmember_T
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010041
42 // get and set variables
43 ISN_LOAD, // push local variable isn_arg.number
44 ISN_LOADV, // push v: variable isn_arg.number
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010045 ISN_LOADG, // push g: variable isn_arg.string
Bram Moolenaar03290b82020-12-19 16:30:44 +010046 ISN_LOADAUTO, // push g: autoload variable isn_arg.string
Bram Moolenaard3aac292020-04-19 14:32:17 +020047 ISN_LOADB, // push b: variable isn_arg.string
48 ISN_LOADW, // push w: variable isn_arg.string
49 ISN_LOADT, // push t: variable isn_arg.string
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +020050 ISN_LOADGDICT, // push g: dict
51 ISN_LOADBDICT, // push b: dict
52 ISN_LOADWDICT, // push w: dict
53 ISN_LOADTDICT, // push t: dict
Bram Moolenaarb283a8a2020-02-02 22:24:04 +010054 ISN_LOADS, // push s: variable isn_arg.loadstore
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +010055 ISN_LOADEXPORT, // push exported variable isn_arg.loadstore
Bram Moolenaarab360522021-01-10 14:02:28 +010056 ISN_LOADOUTER, // push variable from outer scope isn_arg.outer
Bram Moolenaarb283a8a2020-02-02 22:24:04 +010057 ISN_LOADSCRIPT, // push script-local variable isn_arg.script.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010058 ISN_LOADOPT, // push option isn_arg.string
59 ISN_LOADENV, // push environment variable isn_arg.string
60 ISN_LOADREG, // push register isn_arg.number
61
62 ISN_STORE, // pop into local variable isn_arg.number
Bram Moolenaarb283a8a2020-02-02 22:24:04 +010063 ISN_STOREV, // pop into v: variable isn_arg.number
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010064 ISN_STOREG, // pop into global variable isn_arg.string
Bram Moolenaar03290b82020-12-19 16:30:44 +010065 ISN_STOREAUTO, // pop into global autoload variable isn_arg.string
Bram Moolenaard3aac292020-04-19 14:32:17 +020066 ISN_STOREB, // pop into buffer-local variable isn_arg.string
67 ISN_STOREW, // pop into window-local variable isn_arg.string
68 ISN_STORET, // pop into tab-local variable isn_arg.string
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +020069 ISN_STORES, // pop into script variable isn_arg.loadstore
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +010070 ISN_STOREEXPORT, // pop into exported script variable isn_arg.loadstore
Bram Moolenaarab360522021-01-10 14:02:28 +010071 ISN_STOREOUTER, // pop variable into outer scope isn_arg.outer
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +020072 ISN_STORESCRIPT, // pop into script variable isn_arg.script
Bram Moolenaardcb53be2021-12-09 14:23:43 +000073 ISN_STOREOPT, // pop into option isn_arg.storeopt
74 ISN_STOREFUNCOPT, // pop into option isn_arg.storeopt
Bram Moolenaarb283a8a2020-02-02 22:24:04 +010075 ISN_STOREENV, // pop into environment variable isn_arg.string
76 ISN_STOREREG, // pop into register isn_arg.number
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077 // ISN_STOREOTHER, // pop into other script variable isn_arg.other.
78
Bram Moolenaara471eea2020-03-04 22:20:26 +010079 ISN_STORENR, // store number into local variable isn_arg.storenr.stnr_idx
Bram Moolenaar4f5e3972020-12-21 17:30:50 +010080 ISN_STOREINDEX, // store into list or dictionary, type isn_arg.vartype,
81 // value/index/variable on stack
Bram Moolenaar68452172021-04-12 21:21:02 +020082 ISN_STORERANGE, // store into blob,
83 // value/index 1/index 2/variable on stack
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084
Bram Moolenaard72c1bf2020-04-19 16:28:59 +020085 ISN_UNLET, // unlet variable isn_arg.unlet.ul_name
Bram Moolenaar7bdaea62020-04-19 18:27:26 +020086 ISN_UNLETENV, // unlet environment variable isn_arg.unlet.ul_name
Bram Moolenaar752fc692021-01-04 21:57:11 +010087 ISN_UNLETINDEX, // unlet item of list or dict
Bram Moolenaar5b5ae292021-02-20 17:04:02 +010088 ISN_UNLETRANGE, // unlet items of list
Bram Moolenaard72c1bf2020-04-19 16:28:59 +020089
Bram Moolenaaraacc9662021-08-13 19:40:51 +020090 ISN_LOCKUNLOCK, // :lock and :unlock for local variable member
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +020091 ISN_LOCKCONST, // lock constant value
92
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010093 // constants
Bram Moolenaar42a480b2020-02-29 23:23:47 +010094 ISN_PUSHNR, // push number isn_arg.number
95 ISN_PUSHBOOL, // push bool value isn_arg.number
96 ISN_PUSHSPEC, // push special value isn_arg.number
97 ISN_PUSHF, // push float isn_arg.fnumber
98 ISN_PUSHS, // push string isn_arg.string
99 ISN_PUSHBLOB, // push blob isn_arg.blob
100 ISN_PUSHFUNC, // push func isn_arg.string
Bram Moolenaar397a87a2022-03-20 21:14:15 +0000101 ISN_PUSHCHANNEL, // push NULL channel
102 ISN_PUSHJOB, // push NULL job
Bram Moolenaar42a480b2020-02-29 23:23:47 +0100103 ISN_NEWLIST, // push list from stack items, size is isn_arg.number
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100104 // -1 for null_list
Bram Moolenaar42a480b2020-02-29 23:23:47 +0100105 ISN_NEWDICT, // push dict from stack items, size is isn_arg.number
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100106 // -1 for null_dict
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +0000107 ISN_NEWPARTIAL, // push NULL partial
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100108
Bram Moolenaar06b77222022-01-25 15:51:56 +0000109 ISN_AUTOLOAD, // get item from autoload import, function or variable
110
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100111 // function call
112 ISN_BCALL, // call builtin function isn_arg.bfunc
113 ISN_DCALL, // call def function isn_arg.dfunc
114 ISN_UCALL, // call user function or funcref/partial isn_arg.ufunc
115 ISN_PCALL, // call partial, use isn_arg.pfunc
Bram Moolenaarbd5da372020-03-31 23:13:10 +0200116 ISN_PCALL_END, // cleanup after ISN_PCALL with cpf_top set
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100117 ISN_RETURN, // return, result is on top of stack
Bram Moolenaarf57b43c2021-06-15 22:13:27 +0200118 ISN_RETURN_VOID, // Push void, then return
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000119 ISN_RETURN_OBJECT, // Push constructed object, then return
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200120 ISN_FUNCREF, // push a function ref to dfunc isn_arg.funcref
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200121 ISN_NEWFUNC, // create a global function from a lambda function
Bram Moolenaar6abdcf82020-11-22 18:15:44 +0100122 ISN_DEF, // list functions
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100123 ISN_DEFER, // :defer argument count is isn_arg.number
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100124
125 // expression operations
126 ISN_JUMP, // jump if condition is matched isn_arg.jump
Bram Moolenaar4c137212021-04-19 16:48:48 +0200127 ISN_JUMP_IF_ARG_SET, // jump if argument is already set, uses
128 // isn_arg.jumparg
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000129 ISN_JUMP_IF_ARG_NOT_SET, // jump if argument is not set, uses
130 // isn_arg.jumparg
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100131
132 // loop
133 ISN_FOR, // get next item from a list, uses isn_arg.forloop
Bram Moolenaarb46c0832022-09-15 17:19:37 +0100134 ISN_WHILE, // jump if condition false, store funcref count, uses
135 // isn_arg.whileloop
136 ISN_ENDLOOP, // handle variables for closures, uses isn_arg.endloop
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100137
Bram Moolenaar0d807102021-12-21 09:42:09 +0000138 ISN_TRY, // add entry to ec_trystack, uses isn_arg.tryref
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100139 ISN_THROW, // pop value of stack, store in v:exception
140 ISN_PUSHEXC, // push v:exception
141 ISN_CATCH, // drop v:exception
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +0100142 ISN_FINALLY, // start of :finally block
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100143 ISN_ENDTRY, // take entry off from ec_trystack
Bram Moolenaar873f8242022-03-10 21:53:44 +0000144 ISN_TRYCONT, // handle :continue or :break inside a :try statement
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100145
Bram Moolenaar418f1df2020-08-12 21:34:49 +0200146 // more expression operations
Bram Moolenaar1dcae592020-10-19 19:02:42 +0200147 ISN_ADDLIST, // add two lists
148 ISN_ADDBLOB, // add two blobs
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100149
Bram Moolenaar657137c2021-01-09 15:45:23 +0100150 // operation with two arguments; isn_arg.op.op_type is exprtype_T
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100151 ISN_OPNR,
152 ISN_OPFLOAT,
153 ISN_OPANY,
154
Bram Moolenaar657137c2021-01-09 15:45:23 +0100155 // comparative operations; isn_arg.op.op_type is exprtype_T, op_ic used
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100156 ISN_COMPAREBOOL,
157 ISN_COMPARESPECIAL,
Bram Moolenaar7a222242022-03-01 19:23:24 +0000158 ISN_COMPARENULL,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100159 ISN_COMPARENR,
160 ISN_COMPAREFLOAT,
161 ISN_COMPARESTRING,
162 ISN_COMPAREBLOB,
163 ISN_COMPARELIST,
164 ISN_COMPAREDICT,
165 ISN_COMPAREFUNC,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100166 ISN_COMPAREANY,
167
168 // expression operations
LemonBoy372bcce2022-04-25 12:43:20 +0100169 ISN_CONCAT, // concatenate isn_arg.number strings
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +0200170 ISN_STRINDEX, // [expr] string index
Bram Moolenaar11107ba2020-08-15 21:10:16 +0200171 ISN_STRSLICE, // [expr:expr] string slice
Bram Moolenaar1dcae592020-10-19 19:02:42 +0200172 ISN_LISTAPPEND, // append to a list, like add()
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +0200173 ISN_LISTINDEX, // [expr] list index
Bram Moolenaared591872020-08-15 22:14:53 +0200174 ISN_LISTSLICE, // [expr:expr] list slice
Bram Moolenaarcfc30232021-04-11 20:26:34 +0200175 ISN_BLOBINDEX, // [expr] blob index
176 ISN_BLOBSLICE, // [expr:expr] blob slice
Bram Moolenaarcc673e72020-08-16 17:33:35 +0200177 ISN_ANYINDEX, // [expr] runtime index
178 ISN_ANYSLICE, // [expr:expr] runtime slice
Bram Moolenaar9af78762020-06-16 11:34:42 +0200179 ISN_SLICE, // drop isn_arg.number items from start of list
Bram Moolenaar80b0e5e2020-10-19 20:45:36 +0200180 ISN_BLOBAPPEND, // append to a blob, like add()
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200181 ISN_GETITEM, // push list item, isn_arg.number is the index
Bram Moolenaar1cc2a942020-05-10 19:10:31 +0200182 ISN_MEMBER, // dict[member]
183 ISN_STRINGMEMBER, // dict.member using isn_arg.string
Bram Moolenaar5fa9b242021-06-04 21:00:32 +0200184 ISN_2BOOL, // falsy/truthy to bool, uses isn_arg.tobool
Bram Moolenaar2bb26582020-10-03 22:52:39 +0200185 ISN_COND2BOOL, // convert value to bool
Bram Moolenaar5fa9b242021-06-04 21:00:32 +0200186 ISN_2STRING, // convert value to string at isn_arg.tostring on stack
Bram Moolenaar418f1df2020-08-12 21:34:49 +0200187 ISN_2STRING_ANY, // like ISN_2STRING but check type
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100188 ISN_NEGATENR, // apply "-" to number
189
Bram Moolenaar628c1022021-01-02 15:49:28 +0100190 ISN_CHECKTYPE, // check value type is isn_arg.type.ct_type
Bram Moolenaar9af78762020-06-16 11:34:42 +0200191 ISN_CHECKLEN, // check list length is isn_arg.checklen.cl_min_len
Bram Moolenaar628c1022021-01-02 15:49:28 +0100192 ISN_SETTYPE, // set dict type to isn_arg.type.ct_type
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100193
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +0200194 ISN_CLEARDICT, // clear dict saved by ISN_MEMBER/ISN_STRINGMEMBER
195 ISN_USEDICT, // use or clear dict saved by ISN_MEMBER/ISN_STRINGMEMBER
196
Bram Moolenaarc3516f72020-09-08 22:45:35 +0200197 ISN_PUT, // ":put", uses isn_arg.put
198
Bram Moolenaar02194d22020-10-24 23:08:38 +0200199 ISN_CMDMOD, // set cmdmod
200 ISN_CMDMOD_REV, // undo ISN_CMDMOD
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +0200201
Bram Moolenaarb2049902021-01-24 12:53:53 +0100202 ISN_PROF_START, // start a line for profiling
203 ISN_PROF_END, // end a line for profiling
204
Bram Moolenaar8cec9272021-06-23 20:20:53 +0200205 ISN_DEBUG, // check for debug breakpoint, uses isn_arg.debug
Bram Moolenaare99d4222021-06-13 14:01:26 +0200206
Bram Moolenaar792f7862020-11-23 08:31:18 +0100207 ISN_UNPACK, // unpack list into items, uses isn_arg.unpack
Bram Moolenaar389df252020-07-09 21:20:47 +0200208 ISN_SHUFFLE, // move item on stack up or down
Bram Moolenaar4c137212021-04-19 16:48:48 +0200209 ISN_DROP, // pop stack and discard value
210
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +0200211 ISN_REDIRSTART, // :redir =>
212 ISN_REDIREND, // :redir END, isn_arg.number == 1 for append
213
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +0200214 ISN_CEXPR_AUCMD, // first part of :cexpr isn_arg.number is cmdidx
215 ISN_CEXPR_CORE, // second part of :cexpr, uses isn_arg.cexpr
216
Bram Moolenaar4c137212021-04-19 16:48:48 +0200217 ISN_FINISH // end marker in list of instructions
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100218} isntype_T;
219
220
221// arguments to ISN_BCALL
222typedef struct {
223 int cbf_idx; // index in "global_functions"
224 int cbf_argcount; // number of arguments on top of stack
225} cbfunc_T;
226
227// arguments to ISN_DCALL
228typedef struct {
229 int cdf_idx; // index in "def_functions" for ISN_DCALL
230 int cdf_argcount; // number of arguments on top of stack
231} cdfunc_T;
232
233// arguments to ISN_PCALL
234typedef struct {
235 int cpf_top; // when TRUE partial is above the arguments
236 int cpf_argcount; // number of arguments on top of stack
237} cpfunc_T;
238
239// arguments to ISN_UCALL and ISN_XCALL
240typedef struct {
241 char_u *cuf_name;
242 int cuf_argcount; // number of arguments on top of stack
243} cufunc_T;
244
Bram Moolenaar035bd1c2021-06-21 19:44:11 +0200245// arguments to ISN_GETITEM
246typedef struct {
247 varnumber_T gi_index;
248 int gi_with_op;
249} getitem_T;
250
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100251typedef enum {
252 JUMP_ALWAYS,
Bram Moolenaar1a7ee4d2021-09-16 16:15:07 +0200253 JUMP_NEVER,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100254 JUMP_IF_FALSE, // pop and jump if false
Bram Moolenaarb46c0832022-09-15 17:19:37 +0100255 JUMP_WHILE_FALSE, // pop and jump if false for :while
Bram Moolenaar2bb26582020-10-03 22:52:39 +0200256 JUMP_AND_KEEP_IF_TRUE, // jump if top of stack is truthy, drop if not
Bram Moolenaar2bb26582020-10-03 22:52:39 +0200257 JUMP_IF_COND_TRUE, // jump if top of stack is true, drop if not
258 JUMP_IF_COND_FALSE, // jump if top of stack is false, drop if not
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100259} jumpwhen_T;
260
261// arguments to ISN_JUMP
262typedef struct {
263 jumpwhen_T jump_when;
Bram Moolenaarcc341812022-09-19 15:54:34 +0100264 int jump_where; // position to jump to
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265} jump_T;
266
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000267// arguments to ISN_JUMP_IF_ARG_SET and ISN_JUMP_IF_ARG_NOT_SET
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200268typedef struct {
Bram Moolenaarcc341812022-09-19 15:54:34 +0100269 int jump_arg_off; // argument index, negative
270 int jump_where; // position to jump to
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200271} jumparg_T;
272
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100273// arguments to ISN_FOR
274typedef struct {
Bram Moolenaarcc341812022-09-19 15:54:34 +0100275 short for_loop_idx; // loop variable index
276 int for_end; // position to jump to after done
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100277} forloop_T;
278
Bram Moolenaarb46c0832022-09-15 17:19:37 +0100279// arguments to ISN_WHILE
280typedef struct {
Bram Moolenaarcc341812022-09-19 15:54:34 +0100281 short while_funcref_idx; // variable index for funcref count
282 int while_end; // position to jump to after done
Bram Moolenaarb46c0832022-09-15 17:19:37 +0100283} whileloop_T;
284
285// arguments to ISN_ENDLOOP
286typedef struct {
287 short end_funcref_idx; // variable index of funcrefs.ga_len
Bram Moolenaarcc341812022-09-19 15:54:34 +0100288 short end_depth; // nested loop depth
Bram Moolenaarb46c0832022-09-15 17:19:37 +0100289 short end_var_idx; // first variable declared in the loop
290 short end_var_count; // number of variables declared in the loop
291} endloop_T;
292
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +0100293// indirect arguments to ISN_TRY
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100294typedef struct {
295 int try_catch; // position to jump to on throw
Bram Moolenaarc150c092021-02-13 15:02:46 +0100296 int try_finally; // :finally or :endtry position to jump to
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +0100297 int try_endtry; // :endtry position to jump to
298} tryref_T;
299
300// arguments to ISN_TRY
301typedef struct {
302 tryref_T *try_ref;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100303} try_T;
304
Bram Moolenaarc150c092021-02-13 15:02:46 +0100305// arguments to ISN_TRYCONT
306typedef struct {
307 int tct_levels; // number of nested try statements
308 int tct_where; // position to jump to, WHILE or FOR
309} trycont_T;
310
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100311// arguments to ISN_ECHO
312typedef struct {
313 int echo_with_white; // :echo instead of :echon
314 int echo_count; // number of expressions
315} echo_T;
316
317// arguments to ISN_OPNR, ISN_OPFLOAT, etc.
318typedef struct {
Bram Moolenaar657137c2021-01-09 15:45:23 +0100319 exprtype_T op_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100320 int op_ic; // TRUE with '#', FALSE with '?', else MAYBE
321} opexpr_T;
322
323// arguments to ISN_CHECKTYPE
324typedef struct {
Bram Moolenaar5e654232020-09-16 15:22:00 +0200325 type_T *ct_type;
Bram Moolenaarb3005ce2021-01-22 17:51:06 +0100326 int8_T ct_off; // offset in stack, -1 is bottom
327 int8_T ct_arg_idx; // argument index or zero
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +0100328 int8_T ct_is_var; // when TRUE checking variable instead of arg
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100329} checktype_T;
330
331// arguments to ISN_STORENR
332typedef struct {
Bram Moolenaara471eea2020-03-04 22:20:26 +0100333 int stnr_idx;
334 varnumber_T stnr_val;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100335} storenr_T;
336
Bram Moolenaardcb53be2021-12-09 14:23:43 +0000337// arguments to ISN_STOREOPT and ISN_STOREFUNCOPT
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100338typedef struct {
339 char_u *so_name;
340 int so_flags;
341} storeopt_T;
342
Bram Moolenaarb283a8a2020-02-02 22:24:04 +0100343// arguments to ISN_LOADS and ISN_STORES
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100344typedef struct {
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +0200345 char_u *ls_name; // variable name (with s: for ISN_STORES)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100346 int ls_sid; // script ID
Bram Moolenaarb283a8a2020-02-02 22:24:04 +0100347} loadstore_T;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100348
Bram Moolenaarb283a8a2020-02-02 22:24:04 +0100349// arguments to ISN_LOADSCRIPT and ISN_STORESCRIPT
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100350typedef struct {
Bram Moolenaar4aab88d2020-12-24 21:56:41 +0100351 int sref_sid; // script ID
352 int sref_idx; // index in sn_var_vals
353 int sref_seq; // sn_script_seq when compiled
Bram Moolenaar07a65d22020-12-26 20:09:15 +0100354 type_T *sref_type; // type of the variable when compiled
Bram Moolenaar4aab88d2020-12-24 21:56:41 +0100355} scriptref_T;
356
357typedef struct {
358 scriptref_T *scriptref;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100359} script_T;
360
Bram Moolenaard72c1bf2020-04-19 16:28:59 +0200361// arguments to ISN_UNLET
362typedef struct {
363 char_u *ul_name; // variable name with g:, w:, etc.
364 int ul_forceit; // forceit flag
365} unlet_T;
366
Bram Moolenaar8fa745e2022-09-16 19:04:24 +0100367// extra arguments for funcref_T
368typedef struct {
Bram Moolenaarcc341812022-09-19 15:54:34 +0100369 char_u *fre_func_name; // function name for legacy function
370 loopvarinfo_T fre_loopvar_info; // info about variables inside loops
Bram Moolenaar8fa745e2022-09-16 19:04:24 +0100371} funcref_extra_T;
372
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200373// arguments to ISN_FUNCREF
374typedef struct {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +0100375 int fr_dfunc_idx; // function index for :def function
376 funcref_extra_T *fr_extra; // optional extra information
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200377} funcref_T;
378
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200379// arguments to ISN_NEWFUNC
380typedef struct {
Bram Moolenaarcc341812022-09-19 15:54:34 +0100381 char_u *nfa_lambda; // name of the lambda already defined
382 char_u *nfa_global; // name of the global function to be created
383 loopvarinfo_T nfa_loopvar_info; // ifno about variables inside loops
Bram Moolenaar8fa745e2022-09-16 19:04:24 +0100384} newfuncarg_T;
385
386typedef struct {
387 newfuncarg_T *nf_arg;
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200388} newfunc_T;
389
Bram Moolenaar9af78762020-06-16 11:34:42 +0200390// arguments to ISN_CHECKLEN
391typedef struct {
392 int cl_min_len; // minimum length
393 int cl_more_OK; // longer is allowed
394} checklen_T;
395
Bram Moolenaar389df252020-07-09 21:20:47 +0200396// arguments to ISN_SHUFFLE
397typedef struct {
398 int shfl_item; // item to move (relative to top of stack)
399 int shfl_up; // places to move upwards
400} shuffle_T;
401
Bram Moolenaarc3516f72020-09-08 22:45:35 +0200402// arguments to ISN_PUT
403typedef struct {
404 int put_regname; // register, can be NUL
405 linenr_T put_lnum; // line number to put below
406} put_T;
407
Bram Moolenaar02194d22020-10-24 23:08:38 +0200408// arguments to ISN_CMDMOD
409typedef struct {
410 cmdmod_T *cf_cmdmod; // allocated
411} cmod_T;
412
Bram Moolenaar792f7862020-11-23 08:31:18 +0100413// arguments to ISN_UNPACK
414typedef struct {
415 int unp_count; // number of items to produce
416 int unp_semicolon; // last item gets list of remainder
417} unpack_T;
418
Bram Moolenaarab360522021-01-10 14:02:28 +0100419// arguments to ISN_LOADOUTER and ISN_STOREOUTER
420typedef struct {
421 int outer_idx; // index
422 int outer_depth; // nesting level, stack frames to go up
Bram Moolenaar0186e582021-01-10 18:33:11 +0100423} isn_outer_T;
Bram Moolenaarab360522021-01-10 14:02:28 +0100424
Bram Moolenaar8fa745e2022-09-16 19:04:24 +0100425#define OUTER_LOOP_DEPTH -9 // used for outer_depth for loop variables
426
Bram Moolenaar4c137212021-04-19 16:48:48 +0200427// arguments to ISN_SUBSTITUTE
428typedef struct {
429 char_u *subs_cmd; // :s command
430 isn_T *subs_instr; // sequence of instructions
431} subs_T;
432
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +0200433// indirect arguments to ISN_TRY
434typedef struct {
435 int cer_cmdidx;
436 char_u *cer_cmdline;
437 int cer_forceit;
438} cexprref_T;
439
440// arguments to ISN_CEXPR_CORE
441typedef struct {
442 cexprref_T *cexpr_ref;
443} cexpr_T;
444
Bram Moolenaar5fa9b242021-06-04 21:00:32 +0200445// arguments to ISN_2STRING and ISN_2STRING_ANY
446typedef struct {
447 int offset;
448 int tolerant;
449} tostring_T;
450
451// arguments to ISN_2BOOL
452typedef struct {
453 int offset;
454 int invert;
455} tobool_T;
456
Bram Moolenaar8cec9272021-06-23 20:20:53 +0200457// arguments to ISN_DEBUG
458typedef struct {
459 varnumber_T dbg_var_names_len; // current number of local variables
460 int dbg_break_lnum; // first line to break after
461} debug_T;
462
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100463// arguments to ISN_DEFER
464typedef struct {
465 int defer_var_idx; // local variable index for defer list
466 int defer_argcount; // number of arguments
467} deferins_T;
468
Bram Moolenaarbdc09a12022-10-07 14:31:45 +0100469// arguments to ISN_ECHOWINDOW
470typedef struct {
471 int ewin_count; // number of arguments
472 long ewin_time; // time argument (msec)
473} echowin_T;
474
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000475// arguments to ISN_CONSTRUCT
476typedef struct {
477 int construct_size; // size of object in bytes
478 class_T *construct_class; // class the object is created from
479} construct_T;
480
Bram Moolenaard505d172022-12-18 21:42:55 +0000481// arguments to ISN_STORE_CLASSMEMBER and ISN_LOAD_CLASSMEMBER
482typedef struct {
483 class_T *cm_class;
484 int cm_idx;
485} classmember_T;
486
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100487/*
488 * Instruction
489 */
Bram Moolenaar20431c92020-03-20 18:39:46 +0100490struct isn_S {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100491 isntype_T isn_type;
492 int isn_lnum;
493 union {
494 char_u *string;
495 varnumber_T number;
496 blob_T *blob;
Bram Moolenaar4f5e3972020-12-21 17:30:50 +0100497 vartype_T vartype;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100498 float_T fnumber;
Bram Moolenaar42a480b2020-02-29 23:23:47 +0100499 channel_T *channel;
500 job_T *job;
Bram Moolenaar087d2e12020-03-01 15:36:42 +0100501 partial_T *partial;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100502 jump_T jump;
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200503 jumparg_T jumparg;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100504 forloop_T forloop;
Bram Moolenaarb46c0832022-09-15 17:19:37 +0100505 whileloop_T whileloop;
506 endloop_T endloop;
Bram Moolenaar0d807102021-12-21 09:42:09 +0000507 try_T tryref;
Bram Moolenaarc150c092021-02-13 15:02:46 +0100508 trycont_T trycont;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100509 cbfunc_T bfunc;
510 cdfunc_T dfunc;
511 cpfunc_T pfunc;
512 cufunc_T ufunc;
513 echo_T echo;
514 opexpr_T op;
515 checktype_T type;
516 storenr_T storenr;
517 storeopt_T storeopt;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +0100518 loadstore_T loadstore;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100519 script_T script;
Bram Moolenaard72c1bf2020-04-19 16:28:59 +0200520 unlet_T unlet;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200521 funcref_T funcref;
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200522 newfunc_T newfunc;
Bram Moolenaar9af78762020-06-16 11:34:42 +0200523 checklen_T checklen;
Bram Moolenaar389df252020-07-09 21:20:47 +0200524 shuffle_T shuffle;
Bram Moolenaarc3516f72020-09-08 22:45:35 +0200525 put_T put;
Bram Moolenaar02194d22020-10-24 23:08:38 +0200526 cmod_T cmdmod;
Bram Moolenaar792f7862020-11-23 08:31:18 +0100527 unpack_T unpack;
Bram Moolenaar0186e582021-01-10 18:33:11 +0100528 isn_outer_T outer;
Bram Moolenaar4c137212021-04-19 16:48:48 +0200529 subs_T subs;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +0200530 cexpr_T cexpr;
Bram Moolenaarf18332f2021-05-07 17:55:55 +0200531 isn_T *instr;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +0200532 tostring_T tostring;
533 tobool_T tobool;
Bram Moolenaar035bd1c2021-06-21 19:44:11 +0200534 getitem_T getitem;
Bram Moolenaar8cec9272021-06-23 20:20:53 +0200535 debug_T debug;
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100536 deferins_T defer;
Bram Moolenaarbdc09a12022-10-07 14:31:45 +0100537 echowin_T echowin;
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000538 construct_T construct;
Bram Moolenaard505d172022-12-18 21:42:55 +0000539 classmember_T classmember;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100540 } isn_arg;
Bram Moolenaar20431c92020-03-20 18:39:46 +0100541};
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100542
543/*
544 * Info about a function defined with :def. Used in "def_functions".
545 */
546struct dfunc_S {
547 ufunc_T *df_ufunc; // struct containing most stuff
Bram Moolenaarcd45ed02020-12-22 17:35:54 +0100548 int df_refcount; // how many ufunc_T point to this dfunc_T
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100549 int df_idx; // index in def_functions
Bram Moolenaard505d172022-12-18 21:42:55 +0000550 char df_deleted; // if TRUE function was deleted
551 char df_delete_busy; // TRUE when in
552 // delete_def_function_contents()
Bram Moolenaar4aab88d2020-12-24 21:56:41 +0100553 int df_script_seq; // Value of sctx_T sc_seq when the function
554 // was compiled.
Dominique Pelle3276f582021-08-07 12:44:41 +0200555 char_u *df_name; // name used for error messages
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100556
557 garray_T df_def_args_isn; // default argument instructions
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200558 garray_T df_var_names; // names of local vars
Bram Moolenaarb2049902021-01-24 12:53:53 +0100559
560 // After compiling "df_instr" and/or "df_instr_prof" is not NULL.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100561 isn_T *df_instr; // function body to be executed
Bram Moolenaarb2049902021-01-24 12:53:53 +0100562 int df_instr_count; // size of "df_instr"
Dominique Pelle3276f582021-08-07 12:44:41 +0200563 int df_instr_debug_count; // size of "df_instr_debug"
564 isn_T *df_instr_debug; // like "df_instr" with debugging
Bram Moolenaarf002a412021-01-24 13:34:18 +0100565#ifdef FEAT_PROFILE
566 isn_T *df_instr_prof; // like "df_instr" with profiling
567 int df_instr_prof_count; // size of "df_instr_prof"
568#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100569
570 int df_varcount; // number of local variables
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200571 int df_has_closure; // one if a closure was created
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100572 int df_defer_var_idx; // index of local variable that has a list
573 // of deferred function calls; zero if not
574 // set
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100575};
576
577// Number of entries used by stack frame for a function call.
Bram Moolenaar5366e1a2020-10-01 13:01:34 +0200578// - ec_dfunc_idx: function index
Bram Moolenaar6ed545e2022-05-09 20:09:23 +0100579// - ec_iidx: instruction index
Bram Moolenaar5930ddc2021-04-26 20:32:59 +0200580// - ec_instr: instruction list pointer
Bram Moolenaar0186e582021-01-10 18:33:11 +0100581// - ec_outer: stack used for closures
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100582// - funclocal: function-local data
Bram Moolenaar5366e1a2020-10-01 13:01:34 +0200583// - ec_frame_idx: previous frame index
Bram Moolenaar0186e582021-01-10 18:33:11 +0100584#define STACK_FRAME_FUNC_OFF 0
585#define STACK_FRAME_IIDX_OFF 1
Bram Moolenaar5930ddc2021-04-26 20:32:59 +0200586#define STACK_FRAME_INSTR_OFF 2
587#define STACK_FRAME_OUTER_OFF 3
588#define STACK_FRAME_FUNCLOCAL_OFF 4
589#define STACK_FRAME_IDX_OFF 5
590#define STACK_FRAME_SIZE 6
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100591
592
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100593extern garray_T def_functions;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100594
Bram Moolenaar08597872020-12-10 19:43:40 +0100595// Used for "lnum" when a range is to be taken from the stack.
kylo2529dac9b12022-03-27 20:05:17 +0100596#define LNUM_VARIABLE_RANGE (-999)
Bram Moolenaar08597872020-12-10 19:43:40 +0100597
598// Used for "lnum" when a range is to be taken from the stack and "!" is used.
kylo2529dac9b12022-03-27 20:05:17 +0100599#define LNUM_VARIABLE_RANGE_ABOVE (-888)
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100600
Bram Moolenaar139575d2022-03-15 19:29:30 +0000601// Keep in sync with get_compile_type()
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100602#ifdef FEAT_PROFILE
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100603# define INSTRUCTIONS(dfunc) \
Bram Moolenaar26a44842021-09-02 18:49:06 +0200604 (debug_break_level > 0 || may_break_in_function(dfunc->df_ufunc) \
Bram Moolenaarc3a27bb2021-06-13 15:16:01 +0200605 ? (dfunc)->df_instr_debug \
606 : ((do_profiling == PROF_YES && (dfunc->df_ufunc)->uf_profiling) \
607 ? (dfunc)->df_instr_prof \
608 : (dfunc)->df_instr))
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100609#else
Bram Moolenaarc3a27bb2021-06-13 15:16:01 +0200610# define INSTRUCTIONS(dfunc) \
kylo2529dac9b12022-03-27 20:05:17 +0100611 (debug_break_level > 0 || may_break_in_function((dfunc)->df_ufunc) \
Bram Moolenaarc3a27bb2021-06-13 15:16:01 +0200612 ? (dfunc)->df_instr_debug \
613 : (dfunc)->df_instr)
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100614#endif
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000615
616// Structure passed between the compile_expr* functions to keep track of
617// constants that have been parsed but for which no code was produced yet. If
618// possible expressions on these constants are applied at compile time. If
619// that is not possible, the code to push the constants needs to be generated
620// before other instructions.
621// Using 50 should be more than enough of 5 levels of ().
622#define PPSIZE 50
623typedef struct {
624 typval_T pp_tv[PPSIZE]; // stack of ppconst constants
625 int pp_used; // active entries in pp_tv[]
626 int pp_is_const; // all generated code was constants, used for a
627 // list or dict with constant members
628} ppconst_T;
629
630// values for ctx_skip
631typedef enum {
632 SKIP_NOT, // condition is a constant, produce code
633 SKIP_YES, // condition is a constant, do NOT produce code
634 SKIP_UNKNOWN // condition is not a constant, produce code
635} skip_T;
636
637/*
638 * Chain of jump instructions where the end label needs to be set.
639 */
640typedef struct endlabel_S endlabel_T;
641struct endlabel_S {
642 endlabel_T *el_next; // chain end_label locations
643 int el_end_label; // instruction idx where to set end
644};
645
646/*
647 * info specific for the scope of :if / elseif / else
648 */
649typedef struct {
650 int is_seen_else;
651 int is_seen_skip_not; // a block was unconditionally executed
652 int is_had_return; // every block ends in :return
653 int is_if_label; // instruction idx at IF or ELSEIF
654 endlabel_T *is_end_label; // instructions to set end label
655} ifscope_T;
656
Bram Moolenaar8abb5842022-09-17 12:39:58 +0100657// info used by :for and :while needed for ENDLOOP
658typedef struct {
659 int li_local_count; // ctx_locals.ga_len at loop start
660 int li_closure_count; // ctx_closure_count at loop start
661 int li_funcref_idx; // index of var that holds funcref count
Bram Moolenaarcc341812022-09-19 15:54:34 +0100662 int li_depth; // nested loop depth
Bram Moolenaar8abb5842022-09-17 12:39:58 +0100663} loop_info_T;
664
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000665/*
666 * info specific for the scope of :while
667 */
668typedef struct {
669 int ws_top_label; // instruction idx at WHILE
670 endlabel_T *ws_end_label; // instructions to set end
Bram Moolenaar8abb5842022-09-17 12:39:58 +0100671 loop_info_T ws_loop_info; // info for LOOPEND
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000672} whilescope_T;
673
674/*
675 * info specific for the scope of :for
676 */
677typedef struct {
678 int fs_top_label; // instruction idx at FOR
679 endlabel_T *fs_end_label; // break instructions
Bram Moolenaar8abb5842022-09-17 12:39:58 +0100680 loop_info_T fs_loop_info; // info for LOOPEND
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000681} forscope_T;
682
683/*
684 * info specific for the scope of :try
685 */
686typedef struct {
687 int ts_try_label; // instruction idx at TRY
688 endlabel_T *ts_end_label; // jump to :finally or :endtry
689 int ts_catch_label; // instruction idx of last CATCH
690 int ts_caught_all; // "catch" without argument encountered
Bram Moolenaar53c29612022-01-12 16:18:18 +0000691 int ts_has_finally; // "finally" encountered
692 int ts_no_return; // one of the blocks did not end in return
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000693} tryscope_T;
694
695typedef enum {
696 NO_SCOPE,
697 IF_SCOPE,
698 WHILE_SCOPE,
699 FOR_SCOPE,
700 TRY_SCOPE,
701 BLOCK_SCOPE
702} scopetype_T;
703
704/*
705 * Info for one scope, pointed to by "ctx_scope".
706 */
707typedef struct scope_S scope_T;
708struct scope_S {
709 scope_T *se_outer; // scope containing this one
710 scopetype_T se_type;
711 int se_local_count; // ctx_locals.ga_len before scope
712 skip_T se_skip_save; // ctx_skip before the block
Bram Moolenaarcc341812022-09-19 15:54:34 +0100713 int se_loop_depth; // number of loop scopes, including this
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000714 union {
715 ifscope_T se_if;
716 whilescope_T se_while;
717 forscope_T se_for;
718 tryscope_T se_try;
719 } se_u;
720};
721
722/*
723 * Entry for "ctx_locals". Used for arguments and local variables.
724 */
725typedef struct {
726 char_u *lv_name;
727 type_T *lv_type;
728 int lv_idx; // index of the variable on the stack
Bram Moolenaarcc341812022-09-19 15:54:34 +0100729 int lv_loop_depth; // depth for variable inside a loop or -1
Bram Moolenaar8fa745e2022-09-16 19:04:24 +0100730 int lv_loop_idx; // index of first variable inside a loop or -1
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000731 int lv_from_outer; // nesting level, using ctx_outer scope
Bram Moolenaar6586a012022-09-30 11:04:50 +0100732 int lv_const; // ASSIGN_VAR (can be assigned to),
733 // ASSIGN_FINAL (no assignment) or ASSIGN_CONST
734 // (value cannot be changed)
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000735 int lv_arg; // when TRUE this is an argument
736} lvar_T;
737
738// Destination for an assignment or ":unlet" with an index.
739typedef enum {
740 dest_local,
741 dest_option,
742 dest_func_option,
743 dest_env,
744 dest_global,
745 dest_buffer,
746 dest_window,
747 dest_tab,
748 dest_vimvar,
Bram Moolenaard505d172022-12-18 21:42:55 +0000749 dest_class_member,
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000750 dest_script,
751 dest_reg,
752 dest_expr,
753} assign_dest_T;
754
755// Used by compile_lhs() to store information about the LHS of an assignment
756// and one argument of ":unlet" with an index.
757typedef struct {
758 assign_dest_T lhs_dest; // type of destination
759
760 char_u *lhs_name; // allocated name excluding the last
761 // "[expr]" or ".name".
762 size_t lhs_varlen; // length of the variable without
763 // "[expr]" or ".name"
764 char_u *lhs_whole; // allocated name including the last
765 // "[expr]" or ".name" for :redir
766 size_t lhs_varlen_total; // length of the variable including
767 // any "[expr]" or ".name"
768 char_u *lhs_dest_end; // end of the destination, including
769 // "[expr]" or ".name".
770 char_u *lhs_end; // end including any type
771
772 int lhs_has_index; // has "[expr]" or ".name"
773
774 int lhs_new_local; // create new local variable
775 int lhs_opt_flags; // for when destination is an option
776 int lhs_vimvaridx; // for when destination is a v:var
777
778 lvar_T lhs_local_lvar; // used for existing local destination
779 lvar_T lhs_arg_lvar; // used for argument destination
780 lvar_T *lhs_lvar; // points to destination lvar
Bram Moolenaard505d172022-12-18 21:42:55 +0000781
782 class_T *lhs_class; // for dest_class_member
783 int lhs_classmember_idx; // for dest_class_member
784
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000785 int lhs_scriptvar_sid;
786 int lhs_scriptvar_idx;
787
788 int lhs_has_type; // type was specified
789 type_T *lhs_type;
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000790 int lhs_member_idx; // object member index
791 type_T *lhs_member_type; // list/dict/object member type
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000792
793 int lhs_append; // used by ISN_REDIREND
794} lhs_T;
795
796/*
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000797 * Context for compiling lines of a :def function.
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000798 * Stores info about the local variables and condition stack.
799 */
800struct cctx_S {
801 ufunc_T *ctx_ufunc; // current function
802 int ctx_lnum; // line number in current function
803 char_u *ctx_line_start; // start of current line or NULL
804 garray_T ctx_instr; // generated instructions
805
806 int ctx_prev_lnum; // line number below previous command, for
807 // debugging
808
809 compiletype_T ctx_compile_type;
810
811 garray_T ctx_locals; // currently visible local variables
812
Bram Moolenaarb46c0832022-09-15 17:19:37 +0100813 int ctx_has_closure; // set to one if a FUNCREF was used in the
814 // function
815 int ctx_closure_count; // incremented for each closure created in
816 // the function.
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000817
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000818 skip_T ctx_skip;
819 scope_T *ctx_scope; // current scope, NULL at toplevel
820 int ctx_had_return; // last seen statement was "return"
821
822 cctx_T *ctx_outer; // outer scope for lambda or nested
823 // function
824 int ctx_outer_used; // var in ctx_outer was used
825
826 garray_T ctx_type_stack; // type of each item on the stack
827 garray_T *ctx_type_list; // list of pointers to allocated types
828
829 int ctx_has_cmdmod; // ISN_CMDMOD was generated
830
831 lhs_T ctx_redir_lhs; // LHS for ":redir => var", valid when
832 // lhs_name is not NULL
833};
834
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100835/*
836 * List of special functions for "compile_arguments()".
837 */
838typedef enum {
839 CA_NOT_SPECIAL,
840 CA_SEARCHPAIR, // {skip} in searchpair() and searchpairpos()
841 CA_SUBSTITUTE, // {sub} in substitute(), when prefixed with \=
842} ca_special_T;
843
Bram Moolenaar114dbda2022-01-03 12:28:03 +0000844// flags for typval2type()
845#define TVTT_DO_MEMBER 1
846#define TVTT_MORE_SPECIFIC 2 // get most specific type for member
847
Bram Moolenaarc9c967d2022-09-07 16:48:46 +0100848// flags for call_def_function()
849#define DEF_USE_PT_ARGV 1 // use the partial arguments