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_UNPACK, // unpack list into items, uses isn_arg.unpack 156 ISN_SHUFFLE, // move item on stack up or down 157 ISN_DROP // pop stack and discard value 158 } isntype_T; 159 160 161 // arguments to ISN_BCALL 162 typedef struct { 163 int cbf_idx; // index in "global_functions" 164 int cbf_argcount; // number of arguments on top of stack 165 } cbfunc_T; 166 167 // arguments to ISN_DCALL 168 typedef struct { 169 int cdf_idx; // index in "def_functions" for ISN_DCALL 170 int cdf_argcount; // number of arguments on top of stack 171 } cdfunc_T; 172 173 // arguments to ISN_PCALL 174 typedef struct { 175 int cpf_top; // when TRUE partial is above the arguments 176 int cpf_argcount; // number of arguments on top of stack 177 } cpfunc_T; 178 179 // arguments to ISN_UCALL and ISN_XCALL 180 typedef struct { 181 char_u *cuf_name; 182 int cuf_argcount; // number of arguments on top of stack 183 } cufunc_T; 184 185 typedef enum { 186 JUMP_ALWAYS, 187 JUMP_IF_FALSE, // pop and jump if false 188 JUMP_AND_KEEP_IF_TRUE, // jump if top of stack is truthy, drop if not 189 JUMP_AND_KEEP_IF_FALSE, // jump if top of stack is falsy, drop if not 190 JUMP_IF_COND_TRUE, // jump if top of stack is true, drop if not 191 JUMP_IF_COND_FALSE, // jump if top of stack is false, drop if not 192 } jumpwhen_T; 193 194 // arguments to ISN_JUMP 195 typedef struct { 196 jumpwhen_T jump_when; 197 int jump_where; // position to jump to 198 } jump_T; 199 200 // arguments to ISN_FOR 201 typedef struct { 202 int for_idx; // loop variable index 203 int for_end; // position to jump to after done 204 } forloop_T; 205 206 // arguments to ISN_TRY 207 typedef struct { 208 int try_catch; // position to jump to on throw 209 int try_finally; // position to jump to for return 210 } try_T; 211 212 // arguments to ISN_ECHO 213 typedef struct { 214 int echo_with_white; // :echo instead of :echon 215 int echo_count; // number of expressions 216 } echo_T; 217 218 // arguments to ISN_OPNR, ISN_OPFLOAT, etc. 219 typedef struct { 220 exprtype_T op_type; 221 int op_ic; // TRUE with '#', FALSE with '?', else MAYBE 222 } opexpr_T; 223 224 // arguments to ISN_CHECKTYPE 225 typedef struct { 226 type_T *ct_type; 227 int ct_off; // offset in stack, -1 is bottom 228 } checktype_T; 229 230 // arguments to ISN_STORENR 231 typedef struct { 232 int stnr_idx; 233 varnumber_T stnr_val; 234 } storenr_T; 235 236 // arguments to ISN_STOREOPT 237 typedef struct { 238 char_u *so_name; 239 int so_flags; 240 } storeopt_T; 241 242 // arguments to ISN_LOADS and ISN_STORES 243 typedef struct { 244 char_u *ls_name; // variable name (with s: for ISN_STORES) 245 int ls_sid; // script ID 246 } loadstore_T; 247 248 // arguments to ISN_LOADSCRIPT and ISN_STORESCRIPT 249 typedef struct { 250 int sref_sid; // script ID 251 int sref_idx; // index in sn_var_vals 252 int sref_seq; // sn_script_seq when compiled 253 type_T *sref_type; // type of the variable when compiled 254 } scriptref_T; 255 256 typedef struct { 257 scriptref_T *scriptref; 258 } script_T; 259 260 // arguments to ISN_UNLET 261 typedef struct { 262 char_u *ul_name; // variable name with g:, w:, etc. 263 int ul_forceit; // forceit flag 264 } unlet_T; 265 266 // arguments to ISN_FUNCREF 267 typedef struct { 268 int fr_func; // function index 269 } funcref_T; 270 271 // arguments to ISN_NEWFUNC 272 typedef struct { 273 char_u *nf_lambda; // name of the lambda already defined 274 char_u *nf_global; // name of the global function to be created 275 } newfunc_T; 276 277 // arguments to ISN_CHECKLEN 278 typedef struct { 279 int cl_min_len; // minimum length 280 int cl_more_OK; // longer is allowed 281 } checklen_T; 282 283 // arguments to ISN_SHUFFLE 284 typedef struct { 285 int shfl_item; // item to move (relative to top of stack) 286 int shfl_up; // places to move upwards 287 } shuffle_T; 288 289 // arguments to ISN_PUT 290 typedef struct { 291 int put_regname; // register, can be NUL 292 linenr_T put_lnum; // line number to put below 293 } put_T; 294 295 // arguments to ISN_CMDMOD 296 typedef struct { 297 cmdmod_T *cf_cmdmod; // allocated 298 } cmod_T; 299 300 // arguments to ISN_UNPACK 301 typedef struct { 302 int unp_count; // number of items to produce 303 int unp_semicolon; // last item gets list of remainder 304 } unpack_T; 305 306 // arguments to ISN_LOADOUTER and ISN_STOREOUTER 307 typedef struct { 308 int outer_idx; // index 309 int outer_depth; // nesting level, stack frames to go up 310 } isn_outer_T; 311 312 /* 313 * Instruction 314 */ 315 struct isn_S { 316 isntype_T isn_type; 317 int isn_lnum; 318 union { 319 char_u *string; 320 varnumber_T number; 321 blob_T *blob; 322 vartype_T vartype; 323 #ifdef FEAT_FLOAT 324 float_T fnumber; 325 #endif 326 channel_T *channel; 327 job_T *job; 328 partial_T *partial; 329 jump_T jump; 330 forloop_T forloop; 331 try_T try; 332 cbfunc_T bfunc; 333 cdfunc_T dfunc; 334 cpfunc_T pfunc; 335 cufunc_T ufunc; 336 echo_T echo; 337 opexpr_T op; 338 checktype_T type; 339 storenr_T storenr; 340 storeopt_T storeopt; 341 loadstore_T loadstore; 342 script_T script; 343 unlet_T unlet; 344 funcref_T funcref; 345 newfunc_T newfunc; 346 checklen_T checklen; 347 shuffle_T shuffle; 348 put_T put; 349 cmod_T cmdmod; 350 unpack_T unpack; 351 isn_outer_T outer; 352 } isn_arg; 353 }; 354 355 /* 356 * Info about a function defined with :def. Used in "def_functions". 357 */ 358 struct dfunc_S { 359 ufunc_T *df_ufunc; // struct containing most stuff 360 int df_refcount; // how many ufunc_T point to this dfunc_T 361 int df_idx; // index in def_functions 362 int df_deleted; // if TRUE function was deleted 363 char_u *df_name; // name used for error messages 364 int df_script_seq; // Value of sctx_T sc_seq when the function 365 // was compiled. 366 367 garray_T df_def_args_isn; // default argument instructions 368 isn_T *df_instr; // function body to be executed 369 int df_instr_count; 370 371 int df_varcount; // number of local variables 372 int df_has_closure; // one if a closure was created 373 }; 374 375 // Number of entries used by stack frame for a function call. 376 // - ec_dfunc_idx: function index 377 // - ec_iidx: instruction index 378 // - ec_outer: stack used for closures 379 // - ec_frame_idx: previous frame index 380 #define STACK_FRAME_FUNC_OFF 0 381 #define STACK_FRAME_IIDX_OFF 1 382 #define STACK_FRAME_OUTER_OFF 2 383 #define STACK_FRAME_IDX_OFF 3 384 #define STACK_FRAME_SIZE 4 385 386 387 #ifdef DEFINE_VIM9_GLOBALS 388 // Functions defined with :def are stored in this growarray. 389 // They are never removed, so that they can be found by index. 390 // Deleted functions have the df_deleted flag set. 391 garray_T def_functions = {0, 0, sizeof(dfunc_T), 50, NULL}; 392 #else 393 extern garray_T def_functions; 394 #endif 395 396 // Used for "lnum" when a range is to be taken from the stack. 397 #define LNUM_VARIABLE_RANGE -999 398 399 // Used for "lnum" when a range is to be taken from the stack and "!" is used. 400 #define LNUM_VARIABLE_RANGE_ABOVE -888 401