1 /* 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 14 typedef enum { 15 ISN_EXEC, // execute Ex command line isn_arg.string 16 ISN_EXECCONCAT, // execute Ex command from isn_arg.number items on stack 17 ISN_ECHO, // echo isn_arg.echo.echo_count items on top of stack 18 ISN_EXECUTE, // execute Ex commands isn_arg.number items on top of stack 19 ISN_ECHOMSG, // echo Ex commands isn_arg.number items on top of stack 20 ISN_ECHOERR, // echo Ex commands isn_arg.number items on top of stack 21 ISN_RANGE, // compute range from isn_arg.string, push to stack 22 23 // get and set variables 24 ISN_LOAD, // push local variable isn_arg.number 25 ISN_LOADV, // push v: variable isn_arg.number 26 ISN_LOADG, // push g: variable isn_arg.string 27 ISN_LOADAUTO, // push g: autoload variable isn_arg.string 28 ISN_LOADB, // push b: variable isn_arg.string 29 ISN_LOADW, // push w: variable isn_arg.string 30 ISN_LOADT, // push t: variable isn_arg.string 31 ISN_LOADGDICT, // push g: dict 32 ISN_LOADBDICT, // push b: dict 33 ISN_LOADWDICT, // push w: dict 34 ISN_LOADTDICT, // push t: dict 35 ISN_LOADS, // push s: variable isn_arg.loadstore 36 ISN_LOADOUTER, // push variable from outer scope isn_arg.outer 37 ISN_LOADSCRIPT, // push script-local variable isn_arg.script. 38 ISN_LOADOPT, // push option isn_arg.string 39 ISN_LOADENV, // push environment variable isn_arg.string 40 ISN_LOADREG, // push register isn_arg.number 41 42 ISN_STORE, // pop into local variable isn_arg.number 43 ISN_STOREV, // pop into v: variable isn_arg.number 44 ISN_STOREG, // pop into global variable isn_arg.string 45 ISN_STOREAUTO, // pop into global autoload variable isn_arg.string 46 ISN_STOREB, // pop into buffer-local variable isn_arg.string 47 ISN_STOREW, // pop into window-local variable isn_arg.string 48 ISN_STORET, // pop into tab-local variable isn_arg.string 49 ISN_STORES, // pop into script variable isn_arg.loadstore 50 ISN_STOREOUTER, // pop variable into outer scope isn_arg.outer 51 ISN_STORESCRIPT, // pop into script variable isn_arg.script 52 ISN_STOREOPT, // pop into option isn_arg.string 53 ISN_STOREENV, // pop into environment variable isn_arg.string 54 ISN_STOREREG, // pop into register isn_arg.number 55 // ISN_STOREOTHER, // pop into other script variable isn_arg.other. 56 57 ISN_STORENR, // store number into local variable isn_arg.storenr.stnr_idx 58 ISN_STOREINDEX, // store into list or dictionary, type isn_arg.vartype, 59 // value/index/variable on stack 60 61 ISN_UNLET, // unlet variable isn_arg.unlet.ul_name 62 ISN_UNLETENV, // unlet environment variable isn_arg.unlet.ul_name 63 ISN_UNLETINDEX, // unlet item of list or dict 64 ISN_UNLETRANGE, // unlet items of list 65 66 ISN_LOCKCONST, // lock constant value 67 68 // constants 69 ISN_PUSHNR, // push number isn_arg.number 70 ISN_PUSHBOOL, // push bool value isn_arg.number 71 ISN_PUSHSPEC, // push special value isn_arg.number 72 ISN_PUSHF, // push float isn_arg.fnumber 73 ISN_PUSHS, // push string isn_arg.string 74 ISN_PUSHBLOB, // push blob isn_arg.blob 75 ISN_PUSHFUNC, // push func isn_arg.string 76 ISN_PUSHCHANNEL, // push channel isn_arg.channel 77 ISN_PUSHJOB, // push channel isn_arg.job 78 ISN_NEWLIST, // push list from stack items, size is isn_arg.number 79 ISN_NEWDICT, // push dict from stack items, size is isn_arg.number 80 81 // function call 82 ISN_BCALL, // call builtin function isn_arg.bfunc 83 ISN_DCALL, // call def function isn_arg.dfunc 84 ISN_UCALL, // call user function or funcref/partial isn_arg.ufunc 85 ISN_PCALL, // call partial, use isn_arg.pfunc 86 ISN_PCALL_END, // cleanup after ISN_PCALL with cpf_top set 87 ISN_RETURN, // return, result is on top of stack 88 ISN_RETURN_ZERO, // Push zero, then return 89 ISN_FUNCREF, // push a function ref to dfunc isn_arg.funcref 90 ISN_NEWFUNC, // create a global function from a lambda function 91 ISN_DEF, // list functions 92 93 // expression operations 94 ISN_JUMP, // jump if condition is matched isn_arg.jump 95 ISN_JUMP_IF_ARG_SET, // jump if argument is already set, uses isn_arg.jumparg 96 97 // loop 98 ISN_FOR, // get next item from a list, uses isn_arg.forloop 99 100 ISN_TRY, // add entry to ec_trystack, uses isn_arg.try 101 ISN_THROW, // pop value of stack, store in v:exception 102 ISN_PUSHEXC, // push v:exception 103 ISN_CATCH, // drop v:exception 104 ISN_FINALLY, // start of :finally block 105 ISN_ENDTRY, // take entry off from ec_trystack 106 ISN_TRYCONT, // handle :continue inside a :try statement 107 108 // more expression operations 109 ISN_ADDLIST, // add two lists 110 ISN_ADDBLOB, // add two blobs 111 112 // operation with two arguments; isn_arg.op.op_type is exprtype_T 113 ISN_OPNR, 114 ISN_OPFLOAT, 115 ISN_OPANY, 116 117 // comparative operations; isn_arg.op.op_type is exprtype_T, op_ic used 118 ISN_COMPAREBOOL, 119 ISN_COMPARESPECIAL, 120 ISN_COMPARENR, 121 ISN_COMPAREFLOAT, 122 ISN_COMPARESTRING, 123 ISN_COMPAREBLOB, 124 ISN_COMPARELIST, 125 ISN_COMPAREDICT, 126 ISN_COMPAREFUNC, 127 ISN_COMPAREANY, 128 129 // expression operations 130 ISN_CONCAT, 131 ISN_STRINDEX, // [expr] string index 132 ISN_STRSLICE, // [expr:expr] string slice 133 ISN_LISTAPPEND, // append to a list, like add() 134 ISN_LISTINDEX, // [expr] list index 135 ISN_LISTSLICE, // [expr:expr] list slice 136 ISN_ANYINDEX, // [expr] runtime index 137 ISN_ANYSLICE, // [expr:expr] runtime slice 138 ISN_SLICE, // drop isn_arg.number items from start of list 139 ISN_BLOBAPPEND, // append to a blob, like add() 140 ISN_GETITEM, // push list item, isn_arg.number is the index 141 ISN_MEMBER, // dict[member] 142 ISN_STRINGMEMBER, // dict.member using isn_arg.string 143 ISN_2BOOL, // falsy/truthy to bool, invert if isn_arg.number != 0 144 ISN_COND2BOOL, // convert value to bool 145 ISN_2STRING, // convert value to string at isn_arg.number on stack 146 ISN_2STRING_ANY, // like ISN_2STRING but check type 147 ISN_NEGATENR, // apply "-" to number 148 149 ISN_CHECKNR, // check value can be used as a number 150 ISN_CHECKTYPE, // check value type is isn_arg.type.ct_type 151 ISN_CHECKLEN, // check list length is isn_arg.checklen.cl_min_len 152 ISN_SETTYPE, // set dict type to isn_arg.type.ct_type 153 154 ISN_PUT, // ":put", uses isn_arg.put 155 156 ISN_CMDMOD, // set cmdmod 157 ISN_CMDMOD_REV, // undo ISN_CMDMOD 158 159 ISN_PROF_START, // start a line for profiling 160 ISN_PROF_END, // end a line for profiling 161 162 ISN_UNPACK, // unpack list into items, uses isn_arg.unpack 163 ISN_SHUFFLE, // move item on stack up or down 164 ISN_DROP // pop stack and discard value 165 } isntype_T; 166 167 168 // arguments to ISN_BCALL 169 typedef struct { 170 int cbf_idx; // index in "global_functions" 171 int cbf_argcount; // number of arguments on top of stack 172 } cbfunc_T; 173 174 // arguments to ISN_DCALL 175 typedef struct { 176 int cdf_idx; // index in "def_functions" for ISN_DCALL 177 int cdf_argcount; // number of arguments on top of stack 178 } cdfunc_T; 179 180 // arguments to ISN_PCALL 181 typedef struct { 182 int cpf_top; // when TRUE partial is above the arguments 183 int cpf_argcount; // number of arguments on top of stack 184 } cpfunc_T; 185 186 // arguments to ISN_UCALL and ISN_XCALL 187 typedef struct { 188 char_u *cuf_name; 189 int cuf_argcount; // number of arguments on top of stack 190 } cufunc_T; 191 192 typedef enum { 193 JUMP_ALWAYS, 194 JUMP_IF_FALSE, // pop and jump if false 195 JUMP_AND_KEEP_IF_TRUE, // jump if top of stack is truthy, drop if not 196 JUMP_AND_KEEP_IF_FALSE, // jump if top of stack is falsy, drop if not 197 JUMP_IF_COND_TRUE, // jump if top of stack is true, drop if not 198 JUMP_IF_COND_FALSE, // jump if top of stack is false, drop if not 199 } jumpwhen_T; 200 201 // arguments to ISN_JUMP 202 typedef struct { 203 jumpwhen_T jump_when; 204 int jump_where; // position to jump to 205 } jump_T; 206 207 // arguments to ISN_JUMP_IF_ARG_SET 208 typedef struct { 209 int jump_arg_off; // argument index, negative 210 int jump_where; // position to jump to 211 } jumparg_T; 212 213 // arguments to ISN_FOR 214 typedef struct { 215 int for_idx; // loop variable index 216 int for_end; // position to jump to after done 217 } forloop_T; 218 219 // indirect arguments to ISN_TRY 220 typedef struct { 221 int try_catch; // position to jump to on throw 222 int try_finally; // :finally or :endtry position to jump to 223 int try_endtry; // :endtry position to jump to 224 } tryref_T; 225 226 // arguments to ISN_TRY 227 typedef struct { 228 tryref_T *try_ref; 229 } try_T; 230 231 // arguments to ISN_TRYCONT 232 typedef struct { 233 int tct_levels; // number of nested try statements 234 int tct_where; // position to jump to, WHILE or FOR 235 } trycont_T; 236 237 // arguments to ISN_ECHO 238 typedef struct { 239 int echo_with_white; // :echo instead of :echon 240 int echo_count; // number of expressions 241 } echo_T; 242 243 // arguments to ISN_OPNR, ISN_OPFLOAT, etc. 244 typedef struct { 245 exprtype_T op_type; 246 int op_ic; // TRUE with '#', FALSE with '?', else MAYBE 247 } opexpr_T; 248 249 // arguments to ISN_CHECKTYPE 250 typedef struct { 251 type_T *ct_type; 252 int8_T ct_off; // offset in stack, -1 is bottom 253 int8_T ct_arg_idx; // argument index or zero 254 } checktype_T; 255 256 // arguments to ISN_STORENR 257 typedef struct { 258 int stnr_idx; 259 varnumber_T stnr_val; 260 } storenr_T; 261 262 // arguments to ISN_STOREOPT 263 typedef struct { 264 char_u *so_name; 265 int so_flags; 266 } storeopt_T; 267 268 // arguments to ISN_LOADS and ISN_STORES 269 typedef struct { 270 char_u *ls_name; // variable name (with s: for ISN_STORES) 271 int ls_sid; // script ID 272 } loadstore_T; 273 274 // arguments to ISN_LOADSCRIPT and ISN_STORESCRIPT 275 typedef struct { 276 int sref_sid; // script ID 277 int sref_idx; // index in sn_var_vals 278 int sref_seq; // sn_script_seq when compiled 279 type_T *sref_type; // type of the variable when compiled 280 } scriptref_T; 281 282 typedef struct { 283 scriptref_T *scriptref; 284 } script_T; 285 286 // arguments to ISN_UNLET 287 typedef struct { 288 char_u *ul_name; // variable name with g:, w:, etc. 289 int ul_forceit; // forceit flag 290 } unlet_T; 291 292 // arguments to ISN_FUNCREF 293 typedef struct { 294 int fr_func; // function index 295 } funcref_T; 296 297 // arguments to ISN_NEWFUNC 298 typedef struct { 299 char_u *nf_lambda; // name of the lambda already defined 300 char_u *nf_global; // name of the global function to be created 301 } newfunc_T; 302 303 // arguments to ISN_CHECKLEN 304 typedef struct { 305 int cl_min_len; // minimum length 306 int cl_more_OK; // longer is allowed 307 } checklen_T; 308 309 // arguments to ISN_SHUFFLE 310 typedef struct { 311 int shfl_item; // item to move (relative to top of stack) 312 int shfl_up; // places to move upwards 313 } shuffle_T; 314 315 // arguments to ISN_PUT 316 typedef struct { 317 int put_regname; // register, can be NUL 318 linenr_T put_lnum; // line number to put below 319 } put_T; 320 321 // arguments to ISN_CMDMOD 322 typedef struct { 323 cmdmod_T *cf_cmdmod; // allocated 324 } cmod_T; 325 326 // arguments to ISN_UNPACK 327 typedef struct { 328 int unp_count; // number of items to produce 329 int unp_semicolon; // last item gets list of remainder 330 } unpack_T; 331 332 // arguments to ISN_LOADOUTER and ISN_STOREOUTER 333 typedef struct { 334 int outer_idx; // index 335 int outer_depth; // nesting level, stack frames to go up 336 } isn_outer_T; 337 338 /* 339 * Instruction 340 */ 341 struct isn_S { 342 isntype_T isn_type; 343 int isn_lnum; 344 union { 345 char_u *string; 346 varnumber_T number; 347 blob_T *blob; 348 vartype_T vartype; 349 #ifdef FEAT_FLOAT 350 float_T fnumber; 351 #endif 352 channel_T *channel; 353 job_T *job; 354 partial_T *partial; 355 jump_T jump; 356 jumparg_T jumparg; 357 forloop_T forloop; 358 try_T try; 359 trycont_T trycont; 360 cbfunc_T bfunc; 361 cdfunc_T dfunc; 362 cpfunc_T pfunc; 363 cufunc_T ufunc; 364 echo_T echo; 365 opexpr_T op; 366 checktype_T type; 367 storenr_T storenr; 368 storeopt_T storeopt; 369 loadstore_T loadstore; 370 script_T script; 371 unlet_T unlet; 372 funcref_T funcref; 373 newfunc_T newfunc; 374 checklen_T checklen; 375 shuffle_T shuffle; 376 put_T put; 377 cmod_T cmdmod; 378 unpack_T unpack; 379 isn_outer_T outer; 380 } isn_arg; 381 }; 382 383 /* 384 * Info about a function defined with :def. Used in "def_functions". 385 */ 386 struct dfunc_S { 387 ufunc_T *df_ufunc; // struct containing most stuff 388 int df_refcount; // how many ufunc_T point to this dfunc_T 389 int df_idx; // index in def_functions 390 int df_deleted; // if TRUE function was deleted 391 char_u *df_name; // name used for error messages 392 int df_script_seq; // Value of sctx_T sc_seq when the function 393 // was compiled. 394 395 garray_T df_def_args_isn; // default argument instructions 396 397 // After compiling "df_instr" and/or "df_instr_prof" is not NULL. 398 isn_T *df_instr; // function body to be executed 399 int df_instr_count; // size of "df_instr" 400 #ifdef FEAT_PROFILE 401 isn_T *df_instr_prof; // like "df_instr" with profiling 402 int df_instr_prof_count; // size of "df_instr_prof" 403 #endif 404 405 int df_varcount; // number of local variables 406 int df_has_closure; // one if a closure was created 407 }; 408 409 // Number of entries used by stack frame for a function call. 410 // - ec_dfunc_idx: function index 411 // - ec_iidx: instruction index 412 // - ec_outer: stack used for closures 413 // - funclocal: function-local data 414 // - ec_frame_idx: previous frame index 415 #define STACK_FRAME_FUNC_OFF 0 416 #define STACK_FRAME_IIDX_OFF 1 417 #define STACK_FRAME_OUTER_OFF 2 418 #define STACK_FRAME_FUNCLOCAL_OFF 3 419 #define STACK_FRAME_IDX_OFF 4 420 #define STACK_FRAME_SIZE 5 421 422 423 #ifdef DEFINE_VIM9_GLOBALS 424 // Functions defined with :def are stored in this growarray. 425 // They are never removed, so that they can be found by index. 426 // Deleted functions have the df_deleted flag set. 427 garray_T def_functions = {0, 0, sizeof(dfunc_T), 50, NULL}; 428 #else 429 extern garray_T def_functions; 430 #endif 431 432 // Used for "lnum" when a range is to be taken from the stack. 433 #define LNUM_VARIABLE_RANGE -999 434 435 // Used for "lnum" when a range is to be taken from the stack and "!" is used. 436 #define LNUM_VARIABLE_RANGE_ABOVE -888 437 438 #ifdef FEAT_PROFILE 439 # define INSTRUCTIONS(dfunc) \ 440 ((do_profiling == PROF_YES && (dfunc->df_ufunc)->uf_profiling) \ 441 ? (dfunc)->df_instr_prof : (dfunc)->df_instr) 442 #else 443 # define INSTRUCTIONS(dfunc) ((dfunc)->df_instr) 444 #endif 445