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