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