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