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