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