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