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