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