Ensure viminfo is written on Cmd-q
[MacVim.git] / src / eval.c
blob5c2c9660269ce9e90bdb5e54303c6b14a8a6f015
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
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 */
11 * eval.c: Expression evaluation.
13 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
14 # include "vimio.h" /* for mch_open(), must be before vim.h */
15 #endif
17 #include "vim.h"
19 #if defined(FEAT_EVAL) || defined(PROTO)
21 #ifdef AMIGA
22 # include <time.h> /* for strftime() */
23 #endif
25 #ifdef MACOS
26 # include <time.h> /* for time_t */
27 #endif
29 #if defined(FEAT_FLOAT) && defined(HAVE_MATH_H)
30 # include <math.h>
31 #endif
33 #define DICT_MAXNEST 100 /* maximum nesting of lists and dicts */
35 #define DO_NOT_FREE_CNT 99999 /* refcount for dict or list that should not
36 be freed. */
39 * In a hashtab item "hi_key" points to "di_key" in a dictitem.
40 * This avoids adding a pointer to the hashtab item.
41 * DI2HIKEY() converts a dictitem pointer to a hashitem key pointer.
42 * HIKEY2DI() converts a hashitem key pointer to a dictitem pointer.
43 * HI2DI() converts a hashitem pointer to a dictitem pointer.
45 static dictitem_T dumdi;
46 #define DI2HIKEY(di) ((di)->di_key)
47 #define HIKEY2DI(p) ((dictitem_T *)(p - (dumdi.di_key - (char_u *)&dumdi)))
48 #define HI2DI(hi) HIKEY2DI((hi)->hi_key)
51 * Structure returned by get_lval() and used by set_var_lval().
52 * For a plain name:
53 * "name" points to the variable name.
54 * "exp_name" is NULL.
55 * "tv" is NULL
56 * For a magic braces name:
57 * "name" points to the expanded variable name.
58 * "exp_name" is non-NULL, to be freed later.
59 * "tv" is NULL
60 * For an index in a list:
61 * "name" points to the (expanded) variable name.
62 * "exp_name" NULL or non-NULL, to be freed later.
63 * "tv" points to the (first) list item value
64 * "li" points to the (first) list item
65 * "range", "n1", "n2" and "empty2" indicate what items are used.
66 * For an existing Dict item:
67 * "name" points to the (expanded) variable name.
68 * "exp_name" NULL or non-NULL, to be freed later.
69 * "tv" points to the dict item value
70 * "newkey" is NULL
71 * For a non-existing Dict item:
72 * "name" points to the (expanded) variable name.
73 * "exp_name" NULL or non-NULL, to be freed later.
74 * "tv" points to the Dictionary typval_T
75 * "newkey" is the key for the new item.
77 typedef struct lval_S
79 char_u *ll_name; /* start of variable name (can be NULL) */
80 char_u *ll_exp_name; /* NULL or expanded name in allocated memory. */
81 typval_T *ll_tv; /* Typeval of item being used. If "newkey"
82 isn't NULL it's the Dict to which to add
83 the item. */
84 listitem_T *ll_li; /* The list item or NULL. */
85 list_T *ll_list; /* The list or NULL. */
86 int ll_range; /* TRUE when a [i:j] range was used */
87 long ll_n1; /* First index for list */
88 long ll_n2; /* Second index for list range */
89 int ll_empty2; /* Second index is empty: [i:] */
90 dict_T *ll_dict; /* The Dictionary or NULL */
91 dictitem_T *ll_di; /* The dictitem or NULL */
92 char_u *ll_newkey; /* New key for Dict in alloc. mem or NULL. */
93 } lval_T;
96 static char *e_letunexp = N_("E18: Unexpected characters in :let");
97 static char *e_listidx = N_("E684: list index out of range: %ld");
98 static char *e_undefvar = N_("E121: Undefined variable: %s");
99 static char *e_missbrac = N_("E111: Missing ']'");
100 static char *e_listarg = N_("E686: Argument of %s must be a List");
101 static char *e_listdictarg = N_("E712: Argument of %s must be a List or Dictionary");
102 static char *e_emptykey = N_("E713: Cannot use empty key for Dictionary");
103 static char *e_listreq = N_("E714: List required");
104 static char *e_dictreq = N_("E715: Dictionary required");
105 static char *e_toomanyarg = N_("E118: Too many arguments for function: %s");
106 static char *e_dictkey = N_("E716: Key not present in Dictionary: %s");
107 static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
108 static char *e_funcdict = N_("E717: Dictionary entry already exists");
109 static char *e_funcref = N_("E718: Funcref required");
110 static char *e_dictrange = N_("E719: Cannot use [:] with a Dictionary");
111 static char *e_letwrong = N_("E734: Wrong variable type for %s=");
112 static char *e_nofunc = N_("E130: Unknown function: %s");
113 static char *e_illvar = N_("E461: Illegal variable name: %s");
116 * All user-defined global variables are stored in dictionary "globvardict".
117 * "globvars_var" is the variable that is used for "g:".
119 static dict_T globvardict;
120 static dictitem_T globvars_var;
121 #define globvarht globvardict.dv_hashtab
124 * Old Vim variables such as "v:version" are also available without the "v:".
125 * Also in functions. We need a special hashtable for them.
127 static hashtab_T compat_hashtab;
130 * When recursively copying lists and dicts we need to remember which ones we
131 * have done to avoid endless recursiveness. This unique ID is used for that.
133 static int current_copyID = 0;
136 * Array to hold the hashtab with variables local to each sourced script.
137 * Each item holds a variable (nameless) that points to the dict_T.
139 typedef struct
141 dictitem_T sv_var;
142 dict_T sv_dict;
143 } scriptvar_T;
145 static garray_T ga_scripts = {0, 0, sizeof(scriptvar_T), 4, NULL};
146 #define SCRIPT_SV(id) (((scriptvar_T *)ga_scripts.ga_data)[(id) - 1])
147 #define SCRIPT_VARS(id) (SCRIPT_SV(id).sv_dict.dv_hashtab)
149 static int echo_attr = 0; /* attributes used for ":echo" */
151 /* Values for trans_function_name() argument: */
152 #define TFN_INT 1 /* internal function name OK */
153 #define TFN_QUIET 2 /* no error messages */
156 * Structure to hold info for a user function.
158 typedef struct ufunc ufunc_T;
160 struct ufunc
162 int uf_varargs; /* variable nr of arguments */
163 int uf_flags;
164 int uf_calls; /* nr of active calls */
165 garray_T uf_args; /* arguments */
166 garray_T uf_lines; /* function lines */
167 #ifdef FEAT_PROFILE
168 int uf_profiling; /* TRUE when func is being profiled */
169 /* profiling the function as a whole */
170 int uf_tm_count; /* nr of calls */
171 proftime_T uf_tm_total; /* time spent in function + children */
172 proftime_T uf_tm_self; /* time spent in function itself */
173 proftime_T uf_tm_children; /* time spent in children this call */
174 /* profiling the function per line */
175 int *uf_tml_count; /* nr of times line was executed */
176 proftime_T *uf_tml_total; /* time spent in a line + children */
177 proftime_T *uf_tml_self; /* time spent in a line itself */
178 proftime_T uf_tml_start; /* start time for current line */
179 proftime_T uf_tml_children; /* time spent in children for this line */
180 proftime_T uf_tml_wait; /* start wait time for current line */
181 int uf_tml_idx; /* index of line being timed; -1 if none */
182 int uf_tml_execed; /* line being timed was executed */
183 #endif
184 scid_T uf_script_ID; /* ID of script where function was defined,
185 used for s: variables */
186 int uf_refcount; /* for numbered function: reference count */
187 char_u uf_name[1]; /* name of function (actually longer); can
188 start with <SNR>123_ (<SNR> is K_SPECIAL
189 KS_EXTRA KE_SNR) */
192 /* function flags */
193 #define FC_ABORT 1 /* abort function on error */
194 #define FC_RANGE 2 /* function accepts range */
195 #define FC_DICT 4 /* Dict function, uses "self" */
198 * All user-defined functions are found in this hashtable.
200 static hashtab_T func_hashtab;
202 /* The names of packages that once were loaded are remembered. */
203 static garray_T ga_loaded = {0, 0, sizeof(char_u *), 4, NULL};
205 /* list heads for garbage collection */
206 static dict_T *first_dict = NULL; /* list of all dicts */
207 static list_T *first_list = NULL; /* list of all lists */
209 /* From user function to hashitem and back. */
210 static ufunc_T dumuf;
211 #define UF2HIKEY(fp) ((fp)->uf_name)
212 #define HIKEY2UF(p) ((ufunc_T *)(p - (dumuf.uf_name - (char_u *)&dumuf)))
213 #define HI2UF(hi) HIKEY2UF((hi)->hi_key)
215 #define FUNCARG(fp, j) ((char_u **)(fp->uf_args.ga_data))[j]
216 #define FUNCLINE(fp, j) ((char_u **)(fp->uf_lines.ga_data))[j]
218 #define MAX_FUNC_ARGS 20 /* maximum number of function arguments */
219 #define VAR_SHORT_LEN 20 /* short variable name length */
220 #define FIXVAR_CNT 12 /* number of fixed variables */
222 /* structure to hold info for a function that is currently being executed. */
223 typedef struct funccall_S funccall_T;
225 struct funccall_S
227 ufunc_T *func; /* function being called */
228 int linenr; /* next line to be executed */
229 int returned; /* ":return" used */
230 struct /* fixed variables for arguments */
232 dictitem_T var; /* variable (without room for name) */
233 char_u room[VAR_SHORT_LEN]; /* room for the name */
234 } fixvar[FIXVAR_CNT];
235 dict_T l_vars; /* l: local function variables */
236 dictitem_T l_vars_var; /* variable for l: scope */
237 dict_T l_avars; /* a: argument variables */
238 dictitem_T l_avars_var; /* variable for a: scope */
239 list_T l_varlist; /* list for a:000 */
240 listitem_T l_listitems[MAX_FUNC_ARGS]; /* listitems for a:000 */
241 typval_T *rettv; /* return value */
242 linenr_T breakpoint; /* next line with breakpoint or zero */
243 int dbg_tick; /* debug_tick when breakpoint was set */
244 int level; /* top nesting level of executed function */
245 #ifdef FEAT_PROFILE
246 proftime_T prof_child; /* time spent in a child */
247 #endif
248 funccall_T *caller; /* calling function or NULL */
252 * Info used by a ":for" loop.
254 typedef struct
256 int fi_semicolon; /* TRUE if ending in '; var]' */
257 int fi_varcount; /* nr of variables in the list */
258 listwatch_T fi_lw; /* keep an eye on the item used. */
259 list_T *fi_list; /* list being used */
260 } forinfo_T;
263 * Struct used by trans_function_name()
265 typedef struct
267 dict_T *fd_dict; /* Dictionary used */
268 char_u *fd_newkey; /* new key in "dict" in allocated memory */
269 dictitem_T *fd_di; /* Dictionary item used */
270 } funcdict_T;
274 * Array to hold the value of v: variables.
275 * The value is in a dictitem, so that it can also be used in the v: scope.
276 * The reason to use this table anyway is for very quick access to the
277 * variables with the VV_ defines.
279 #include "version.h"
281 /* values for vv_flags: */
282 #define VV_COMPAT 1 /* compatible, also used without "v:" */
283 #define VV_RO 2 /* read-only */
284 #define VV_RO_SBX 4 /* read-only in the sandbox */
286 #define VV_NAME(s, t) s, {{t}}, {0}
288 static struct vimvar
290 char *vv_name; /* name of variable, without v: */
291 dictitem_T vv_di; /* value and name for key */
292 char vv_filler[16]; /* space for LONGEST name below!!! */
293 char vv_flags; /* VV_COMPAT, VV_RO, VV_RO_SBX */
294 } vimvars[VV_LEN] =
297 * The order here must match the VV_ defines in vim.h!
298 * Initializing a union does not work, leave tv.vval empty to get zero's.
300 {VV_NAME("count", VAR_NUMBER), VV_COMPAT+VV_RO},
301 {VV_NAME("count1", VAR_NUMBER), VV_RO},
302 {VV_NAME("prevcount", VAR_NUMBER), VV_RO},
303 {VV_NAME("errmsg", VAR_STRING), VV_COMPAT},
304 {VV_NAME("warningmsg", VAR_STRING), 0},
305 {VV_NAME("statusmsg", VAR_STRING), 0},
306 {VV_NAME("shell_error", VAR_NUMBER), VV_COMPAT+VV_RO},
307 {VV_NAME("this_session", VAR_STRING), VV_COMPAT},
308 {VV_NAME("version", VAR_NUMBER), VV_COMPAT+VV_RO},
309 {VV_NAME("lnum", VAR_NUMBER), VV_RO_SBX},
310 {VV_NAME("termresponse", VAR_STRING), VV_RO},
311 {VV_NAME("fname", VAR_STRING), VV_RO},
312 {VV_NAME("lang", VAR_STRING), VV_RO},
313 {VV_NAME("lc_time", VAR_STRING), VV_RO},
314 {VV_NAME("ctype", VAR_STRING), VV_RO},
315 {VV_NAME("charconvert_from", VAR_STRING), VV_RO},
316 {VV_NAME("charconvert_to", VAR_STRING), VV_RO},
317 {VV_NAME("fname_in", VAR_STRING), VV_RO},
318 {VV_NAME("fname_out", VAR_STRING), VV_RO},
319 {VV_NAME("fname_new", VAR_STRING), VV_RO},
320 {VV_NAME("fname_diff", VAR_STRING), VV_RO},
321 {VV_NAME("cmdarg", VAR_STRING), VV_RO},
322 {VV_NAME("foldstart", VAR_NUMBER), VV_RO_SBX},
323 {VV_NAME("foldend", VAR_NUMBER), VV_RO_SBX},
324 {VV_NAME("folddashes", VAR_STRING), VV_RO_SBX},
325 {VV_NAME("foldlevel", VAR_NUMBER), VV_RO_SBX},
326 {VV_NAME("progname", VAR_STRING), VV_RO},
327 {VV_NAME("servername", VAR_STRING), VV_RO},
328 {VV_NAME("dying", VAR_NUMBER), VV_RO},
329 {VV_NAME("exception", VAR_STRING), VV_RO},
330 {VV_NAME("throwpoint", VAR_STRING), VV_RO},
331 {VV_NAME("register", VAR_STRING), VV_RO},
332 {VV_NAME("cmdbang", VAR_NUMBER), VV_RO},
333 {VV_NAME("insertmode", VAR_STRING), VV_RO},
334 {VV_NAME("val", VAR_UNKNOWN), VV_RO},
335 {VV_NAME("key", VAR_UNKNOWN), VV_RO},
336 {VV_NAME("profiling", VAR_NUMBER), VV_RO},
337 {VV_NAME("fcs_reason", VAR_STRING), VV_RO},
338 {VV_NAME("fcs_choice", VAR_STRING), 0},
339 {VV_NAME("beval_bufnr", VAR_NUMBER), VV_RO},
340 {VV_NAME("beval_winnr", VAR_NUMBER), VV_RO},
341 {VV_NAME("beval_lnum", VAR_NUMBER), VV_RO},
342 {VV_NAME("beval_col", VAR_NUMBER), VV_RO},
343 {VV_NAME("beval_text", VAR_STRING), VV_RO},
344 {VV_NAME("scrollstart", VAR_STRING), 0},
345 {VV_NAME("swapname", VAR_STRING), VV_RO},
346 {VV_NAME("swapchoice", VAR_STRING), 0},
347 {VV_NAME("swapcommand", VAR_STRING), VV_RO},
348 {VV_NAME("char", VAR_STRING), VV_RO},
349 {VV_NAME("mouse_win", VAR_NUMBER), 0},
350 {VV_NAME("mouse_lnum", VAR_NUMBER), 0},
351 {VV_NAME("mouse_col", VAR_NUMBER), 0},
352 {VV_NAME("operator", VAR_STRING), VV_RO},
353 {VV_NAME("searchforward", VAR_NUMBER), 0},
354 {VV_NAME("oldfiles", VAR_LIST), 0},
357 /* shorthand */
358 #define vv_type vv_di.di_tv.v_type
359 #define vv_nr vv_di.di_tv.vval.v_number
360 #define vv_float vv_di.di_tv.vval.v_float
361 #define vv_str vv_di.di_tv.vval.v_string
362 #define vv_list vv_di.di_tv.vval.v_list
363 #define vv_tv vv_di.di_tv
366 * The v: variables are stored in dictionary "vimvardict".
367 * "vimvars_var" is the variable that is used for the "l:" scope.
369 static dict_T vimvardict;
370 static dictitem_T vimvars_var;
371 #define vimvarht vimvardict.dv_hashtab
373 static void prepare_vimvar __ARGS((int idx, typval_T *save_tv));
374 static void restore_vimvar __ARGS((int idx, typval_T *save_tv));
375 #if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
376 static int call_vim_function __ARGS((char_u *func, int argc, char_u **argv, int safe, typval_T *rettv));
377 #endif
378 static int ex_let_vars __ARGS((char_u *arg, typval_T *tv, int copy, int semicolon, int var_count, char_u *nextchars));
379 static char_u *skip_var_list __ARGS((char_u *arg, int *var_count, int *semicolon));
380 static char_u *skip_var_one __ARGS((char_u *arg));
381 static void list_hashtable_vars __ARGS((hashtab_T *ht, char_u *prefix, int empty, int *first));
382 static void list_glob_vars __ARGS((int *first));
383 static void list_buf_vars __ARGS((int *first));
384 static void list_win_vars __ARGS((int *first));
385 #ifdef FEAT_WINDOWS
386 static void list_tab_vars __ARGS((int *first));
387 #endif
388 static void list_vim_vars __ARGS((int *first));
389 static void list_script_vars __ARGS((int *first));
390 static void list_func_vars __ARGS((int *first));
391 static char_u *list_arg_vars __ARGS((exarg_T *eap, char_u *arg, int *first));
392 static char_u *ex_let_one __ARGS((char_u *arg, typval_T *tv, int copy, char_u *endchars, char_u *op));
393 static int check_changedtick __ARGS((char_u *arg));
394 static char_u *get_lval __ARGS((char_u *name, typval_T *rettv, lval_T *lp, int unlet, int skip, int quiet, int fne_flags));
395 static void clear_lval __ARGS((lval_T *lp));
396 static void set_var_lval __ARGS((lval_T *lp, char_u *endp, typval_T *rettv, int copy, char_u *op));
397 static int tv_op __ARGS((typval_T *tv1, typval_T *tv2, char_u *op));
398 static void list_add_watch __ARGS((list_T *l, listwatch_T *lw));
399 static void list_rem_watch __ARGS((list_T *l, listwatch_T *lwrem));
400 static void list_fix_watch __ARGS((list_T *l, listitem_T *item));
401 static void ex_unletlock __ARGS((exarg_T *eap, char_u *argstart, int deep));
402 static int do_unlet_var __ARGS((lval_T *lp, char_u *name_end, int forceit));
403 static int do_lock_var __ARGS((lval_T *lp, char_u *name_end, int deep, int lock));
404 static void item_lock __ARGS((typval_T *tv, int deep, int lock));
405 static int tv_islocked __ARGS((typval_T *tv));
407 static int eval0 __ARGS((char_u *arg, typval_T *rettv, char_u **nextcmd, int evaluate));
408 static int eval1 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
409 static int eval2 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
410 static int eval3 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
411 static int eval4 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
412 static int eval5 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
413 static int eval6 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
414 static int eval7 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
416 static int eval_index __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
417 static int get_option_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
418 static int get_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
419 static int get_lit_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
420 static int get_list_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
421 static int rettv_list_alloc __ARGS((typval_T *rettv));
422 static listitem_T *listitem_alloc __ARGS((void));
423 static void listitem_free __ARGS((listitem_T *item));
424 static void listitem_remove __ARGS((list_T *l, listitem_T *item));
425 static long list_len __ARGS((list_T *l));
426 static int list_equal __ARGS((list_T *l1, list_T *l2, int ic));
427 static int dict_equal __ARGS((dict_T *d1, dict_T *d2, int ic));
428 static int tv_equal __ARGS((typval_T *tv1, typval_T *tv2, int ic));
429 static listitem_T *list_find __ARGS((list_T *l, long n));
430 static long list_find_nr __ARGS((list_T *l, long idx, int *errorp));
431 static long list_idx_of_item __ARGS((list_T *l, listitem_T *item));
432 static void list_append __ARGS((list_T *l, listitem_T *item));
433 static int list_append_tv __ARGS((list_T *l, typval_T *tv));
434 static int list_append_number __ARGS((list_T *l, varnumber_T n));
435 static int list_insert_tv __ARGS((list_T *l, typval_T *tv, listitem_T *item));
436 static int list_extend __ARGS((list_T *l1, list_T *l2, listitem_T *bef));
437 static int list_concat __ARGS((list_T *l1, list_T *l2, typval_T *tv));
438 static list_T *list_copy __ARGS((list_T *orig, int deep, int copyID));
439 static void list_remove __ARGS((list_T *l, listitem_T *item, listitem_T *item2));
440 static char_u *list2string __ARGS((typval_T *tv, int copyID));
441 static int list_join __ARGS((garray_T *gap, list_T *l, char_u *sep, int echo, int copyID));
442 static void set_ref_in_ht __ARGS((hashtab_T *ht, int copyID));
443 static void set_ref_in_list __ARGS((list_T *l, int copyID));
444 static void set_ref_in_item __ARGS((typval_T *tv, int copyID));
445 static void dict_unref __ARGS((dict_T *d));
446 static void dict_free __ARGS((dict_T *d, int recurse));
447 static dictitem_T *dictitem_alloc __ARGS((char_u *key));
448 static dictitem_T *dictitem_copy __ARGS((dictitem_T *org));
449 static void dictitem_remove __ARGS((dict_T *dict, dictitem_T *item));
450 static void dictitem_free __ARGS((dictitem_T *item));
451 static dict_T *dict_copy __ARGS((dict_T *orig, int deep, int copyID));
452 static int dict_add __ARGS((dict_T *d, dictitem_T *item));
453 static long dict_len __ARGS((dict_T *d));
454 static dictitem_T *dict_find __ARGS((dict_T *d, char_u *key, int len));
455 static char_u *dict2string __ARGS((typval_T *tv, int copyID));
456 static int get_dict_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
457 static char_u *echo_string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
458 static char_u *tv2string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
459 static char_u *string_quote __ARGS((char_u *str, int function));
460 #ifdef FEAT_FLOAT
461 static int string2float __ARGS((char_u *text, float_T *value));
462 #endif
463 static int get_env_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
464 static int find_internal_func __ARGS((char_u *name));
465 static char_u *deref_func_name __ARGS((char_u *name, int *lenp));
466 static int get_func_tv __ARGS((char_u *name, int len, typval_T *rettv, char_u **arg, linenr_T firstline, linenr_T lastline, int *doesrange, int evaluate, dict_T *selfdict));
467 static int call_func __ARGS((char_u *name, int len, typval_T *rettv, int argcount, typval_T *argvars, linenr_T firstline, linenr_T lastline, int *doesrange, int evaluate, dict_T *selfdict));
468 static void emsg_funcname __ARGS((char *ermsg, char_u *name));
469 static int non_zero_arg __ARGS((typval_T *argvars));
471 #ifdef FEAT_FLOAT
472 static void f_abs __ARGS((typval_T *argvars, typval_T *rettv));
473 #endif
474 static void f_add __ARGS((typval_T *argvars, typval_T *rettv));
475 static void f_append __ARGS((typval_T *argvars, typval_T *rettv));
476 static void f_argc __ARGS((typval_T *argvars, typval_T *rettv));
477 static void f_argidx __ARGS((typval_T *argvars, typval_T *rettv));
478 static void f_argv __ARGS((typval_T *argvars, typval_T *rettv));
479 #ifdef FEAT_FLOAT
480 static void f_atan __ARGS((typval_T *argvars, typval_T *rettv));
481 #endif
482 static void f_browse __ARGS((typval_T *argvars, typval_T *rettv));
483 static void f_browsedir __ARGS((typval_T *argvars, typval_T *rettv));
484 static void f_bufexists __ARGS((typval_T *argvars, typval_T *rettv));
485 static void f_buflisted __ARGS((typval_T *argvars, typval_T *rettv));
486 static void f_bufloaded __ARGS((typval_T *argvars, typval_T *rettv));
487 static void f_bufname __ARGS((typval_T *argvars, typval_T *rettv));
488 static void f_bufnr __ARGS((typval_T *argvars, typval_T *rettv));
489 static void f_bufwinnr __ARGS((typval_T *argvars, typval_T *rettv));
490 static void f_byte2line __ARGS((typval_T *argvars, typval_T *rettv));
491 static void f_byteidx __ARGS((typval_T *argvars, typval_T *rettv));
492 static void f_call __ARGS((typval_T *argvars, typval_T *rettv));
493 #ifdef FEAT_FLOAT
494 static void f_ceil __ARGS((typval_T *argvars, typval_T *rettv));
495 #endif
496 static void f_changenr __ARGS((typval_T *argvars, typval_T *rettv));
497 static void f_char2nr __ARGS((typval_T *argvars, typval_T *rettv));
498 static void f_cindent __ARGS((typval_T *argvars, typval_T *rettv));
499 static void f_clearmatches __ARGS((typval_T *argvars, typval_T *rettv));
500 static void f_col __ARGS((typval_T *argvars, typval_T *rettv));
501 #if defined(FEAT_INS_EXPAND)
502 static void f_complete __ARGS((typval_T *argvars, typval_T *rettv));
503 static void f_complete_add __ARGS((typval_T *argvars, typval_T *rettv));
504 static void f_complete_check __ARGS((typval_T *argvars, typval_T *rettv));
505 #endif
506 static void f_confirm __ARGS((typval_T *argvars, typval_T *rettv));
507 static void f_copy __ARGS((typval_T *argvars, typval_T *rettv));
508 #ifdef FEAT_FLOAT
509 static void f_cos __ARGS((typval_T *argvars, typval_T *rettv));
510 #endif
511 static void f_count __ARGS((typval_T *argvars, typval_T *rettv));
512 static void f_cscope_connection __ARGS((typval_T *argvars, typval_T *rettv));
513 static void f_cursor __ARGS((typval_T *argsvars, typval_T *rettv));
514 static void f_deepcopy __ARGS((typval_T *argvars, typval_T *rettv));
515 static void f_delete __ARGS((typval_T *argvars, typval_T *rettv));
516 static void f_did_filetype __ARGS((typval_T *argvars, typval_T *rettv));
517 static void f_diff_filler __ARGS((typval_T *argvars, typval_T *rettv));
518 static void f_diff_hlID __ARGS((typval_T *argvars, typval_T *rettv));
519 static void f_empty __ARGS((typval_T *argvars, typval_T *rettv));
520 static void f_escape __ARGS((typval_T *argvars, typval_T *rettv));
521 static void f_eval __ARGS((typval_T *argvars, typval_T *rettv));
522 static void f_eventhandler __ARGS((typval_T *argvars, typval_T *rettv));
523 static void f_executable __ARGS((typval_T *argvars, typval_T *rettv));
524 static void f_exists __ARGS((typval_T *argvars, typval_T *rettv));
525 static void f_expand __ARGS((typval_T *argvars, typval_T *rettv));
526 static void f_extend __ARGS((typval_T *argvars, typval_T *rettv));
527 static void f_feedkeys __ARGS((typval_T *argvars, typval_T *rettv));
528 static void f_filereadable __ARGS((typval_T *argvars, typval_T *rettv));
529 static void f_filewritable __ARGS((typval_T *argvars, typval_T *rettv));
530 static void f_filter __ARGS((typval_T *argvars, typval_T *rettv));
531 static void f_finddir __ARGS((typval_T *argvars, typval_T *rettv));
532 static void f_findfile __ARGS((typval_T *argvars, typval_T *rettv));
533 #ifdef FEAT_FLOAT
534 static void f_float2nr __ARGS((typval_T *argvars, typval_T *rettv));
535 static void f_floor __ARGS((typval_T *argvars, typval_T *rettv));
536 #endif
537 static void f_fnameescape __ARGS((typval_T *argvars, typval_T *rettv));
538 static void f_fnamemodify __ARGS((typval_T *argvars, typval_T *rettv));
539 static void f_foldclosed __ARGS((typval_T *argvars, typval_T *rettv));
540 static void f_foldclosedend __ARGS((typval_T *argvars, typval_T *rettv));
541 static void f_foldlevel __ARGS((typval_T *argvars, typval_T *rettv));
542 static void f_foldtext __ARGS((typval_T *argvars, typval_T *rettv));
543 static void f_foldtextresult __ARGS((typval_T *argvars, typval_T *rettv));
544 static void f_foreground __ARGS((typval_T *argvars, typval_T *rettv));
545 static void f_function __ARGS((typval_T *argvars, typval_T *rettv));
546 static void f_garbagecollect __ARGS((typval_T *argvars, typval_T *rettv));
547 static void f_get __ARGS((typval_T *argvars, typval_T *rettv));
548 static void f_getbufline __ARGS((typval_T *argvars, typval_T *rettv));
549 static void f_getbufvar __ARGS((typval_T *argvars, typval_T *rettv));
550 static void f_getchar __ARGS((typval_T *argvars, typval_T *rettv));
551 static void f_getcharmod __ARGS((typval_T *argvars, typval_T *rettv));
552 static void f_getcmdline __ARGS((typval_T *argvars, typval_T *rettv));
553 static void f_getcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
554 static void f_getcmdtype __ARGS((typval_T *argvars, typval_T *rettv));
555 static void f_getcwd __ARGS((typval_T *argvars, typval_T *rettv));
556 static void f_getfontname __ARGS((typval_T *argvars, typval_T *rettv));
557 static void f_getfperm __ARGS((typval_T *argvars, typval_T *rettv));
558 static void f_getfsize __ARGS((typval_T *argvars, typval_T *rettv));
559 static void f_getftime __ARGS((typval_T *argvars, typval_T *rettv));
560 static void f_getftype __ARGS((typval_T *argvars, typval_T *rettv));
561 static void f_getline __ARGS((typval_T *argvars, typval_T *rettv));
562 static void f_getmatches __ARGS((typval_T *argvars, typval_T *rettv));
563 static void f_getpid __ARGS((typval_T *argvars, typval_T *rettv));
564 static void f_getpos __ARGS((typval_T *argvars, typval_T *rettv));
565 static void f_getqflist __ARGS((typval_T *argvars, typval_T *rettv));
566 static void f_getreg __ARGS((typval_T *argvars, typval_T *rettv));
567 static void f_getregtype __ARGS((typval_T *argvars, typval_T *rettv));
568 static void f_gettabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
569 static void f_getwinposx __ARGS((typval_T *argvars, typval_T *rettv));
570 static void f_getwinposy __ARGS((typval_T *argvars, typval_T *rettv));
571 static void f_getwinvar __ARGS((typval_T *argvars, typval_T *rettv));
572 static void f_glob __ARGS((typval_T *argvars, typval_T *rettv));
573 static void f_globpath __ARGS((typval_T *argvars, typval_T *rettv));
574 static void f_has __ARGS((typval_T *argvars, typval_T *rettv));
575 static void f_has_key __ARGS((typval_T *argvars, typval_T *rettv));
576 static void f_haslocaldir __ARGS((typval_T *argvars, typval_T *rettv));
577 static void f_hasmapto __ARGS((typval_T *argvars, typval_T *rettv));
578 static void f_histadd __ARGS((typval_T *argvars, typval_T *rettv));
579 static void f_histdel __ARGS((typval_T *argvars, typval_T *rettv));
580 static void f_histget __ARGS((typval_T *argvars, typval_T *rettv));
581 static void f_histnr __ARGS((typval_T *argvars, typval_T *rettv));
582 static void f_hlID __ARGS((typval_T *argvars, typval_T *rettv));
583 static void f_hlexists __ARGS((typval_T *argvars, typval_T *rettv));
584 static void f_hostname __ARGS((typval_T *argvars, typval_T *rettv));
585 static void f_iconv __ARGS((typval_T *argvars, typval_T *rettv));
586 static void f_indent __ARGS((typval_T *argvars, typval_T *rettv));
587 static void f_index __ARGS((typval_T *argvars, typval_T *rettv));
588 static void f_input __ARGS((typval_T *argvars, typval_T *rettv));
589 static void f_inputdialog __ARGS((typval_T *argvars, typval_T *rettv));
590 static void f_inputlist __ARGS((typval_T *argvars, typval_T *rettv));
591 static void f_inputrestore __ARGS((typval_T *argvars, typval_T *rettv));
592 static void f_inputsave __ARGS((typval_T *argvars, typval_T *rettv));
593 static void f_inputsecret __ARGS((typval_T *argvars, typval_T *rettv));
594 static void f_insert __ARGS((typval_T *argvars, typval_T *rettv));
595 static void f_isdirectory __ARGS((typval_T *argvars, typval_T *rettv));
596 static void f_islocked __ARGS((typval_T *argvars, typval_T *rettv));
597 static void f_items __ARGS((typval_T *argvars, typval_T *rettv));
598 static void f_join __ARGS((typval_T *argvars, typval_T *rettv));
599 static void f_keys __ARGS((typval_T *argvars, typval_T *rettv));
600 static void f_last_buffer_nr __ARGS((typval_T *argvars, typval_T *rettv));
601 static void f_len __ARGS((typval_T *argvars, typval_T *rettv));
602 static void f_libcall __ARGS((typval_T *argvars, typval_T *rettv));
603 static void f_libcallnr __ARGS((typval_T *argvars, typval_T *rettv));
604 static void f_line __ARGS((typval_T *argvars, typval_T *rettv));
605 static void f_line2byte __ARGS((typval_T *argvars, typval_T *rettv));
606 static void f_lispindent __ARGS((typval_T *argvars, typval_T *rettv));
607 static void f_localtime __ARGS((typval_T *argvars, typval_T *rettv));
608 #ifdef FEAT_FLOAT
609 static void f_log10 __ARGS((typval_T *argvars, typval_T *rettv));
610 #endif
611 static void f_map __ARGS((typval_T *argvars, typval_T *rettv));
612 static void f_maparg __ARGS((typval_T *argvars, typval_T *rettv));
613 static void f_mapcheck __ARGS((typval_T *argvars, typval_T *rettv));
614 static void f_match __ARGS((typval_T *argvars, typval_T *rettv));
615 static void f_matchadd __ARGS((typval_T *argvars, typval_T *rettv));
616 static void f_matcharg __ARGS((typval_T *argvars, typval_T *rettv));
617 static void f_matchdelete __ARGS((typval_T *argvars, typval_T *rettv));
618 static void f_matchend __ARGS((typval_T *argvars, typval_T *rettv));
619 static void f_matchlist __ARGS((typval_T *argvars, typval_T *rettv));
620 static void f_matchstr __ARGS((typval_T *argvars, typval_T *rettv));
621 static void f_max __ARGS((typval_T *argvars, typval_T *rettv));
622 static void f_min __ARGS((typval_T *argvars, typval_T *rettv));
623 #ifdef vim_mkdir
624 static void f_mkdir __ARGS((typval_T *argvars, typval_T *rettv));
625 #endif
626 static void f_mode __ARGS((typval_T *argvars, typval_T *rettv));
627 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
628 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
629 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
630 #ifdef FEAT_FLOAT
631 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
632 #endif
633 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
634 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
635 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
636 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
637 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
642 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
643 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
644 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
645 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
646 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
647 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
648 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
649 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
650 #ifdef FEAT_FLOAT
651 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
652 #endif
653 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
654 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
655 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
656 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
657 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
668 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
669 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
670 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
671 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
672 #ifdef FEAT_FLOAT
673 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
674 #endif
675 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
676 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
677 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
678 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
679 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
680 #ifdef FEAT_FLOAT
681 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
682 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
683 #endif
684 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
685 #ifdef HAVE_STRFTIME
686 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
687 #endif
688 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
689 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
690 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
691 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
692 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
693 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
699 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
700 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
707 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
708 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
709 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
710 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
711 #ifdef FEAT_FLOAT
712 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
713 #endif
714 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
715 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
716 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
717 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
718 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
724 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
725 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
726 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
727 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
729 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
730 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
731 static int get_env_len __ARGS((char_u **arg));
732 static int get_id_len __ARGS((char_u **arg));
733 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
734 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
735 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
736 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
737 valid character */
738 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
739 static int eval_isnamec __ARGS((int c));
740 static int eval_isnamec1 __ARGS((int c));
741 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
742 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
743 static typval_T *alloc_tv __ARGS((void));
744 static typval_T *alloc_string_tv __ARGS((char_u *string));
745 static void init_tv __ARGS((typval_T *varp));
746 static long get_tv_number __ARGS((typval_T *varp));
747 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
748 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
749 static char_u *get_tv_string __ARGS((typval_T *varp));
750 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
751 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
752 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
753 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
754 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
755 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
756 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
757 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
758 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
759 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
760 static int var_check_ro __ARGS((int flags, char_u *name));
761 static int var_check_fixed __ARGS((int flags, char_u *name));
762 static int tv_check_lock __ARGS((int lock, char_u *name));
763 static void copy_tv __ARGS((typval_T *from, typval_T *to));
764 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
765 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
766 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
767 static int eval_fname_script __ARGS((char_u *p));
768 static int eval_fname_sid __ARGS((char_u *p));
769 static void list_func_head __ARGS((ufunc_T *fp, int indent));
770 static ufunc_T *find_func __ARGS((char_u *name));
771 static int function_exists __ARGS((char_u *name));
772 static int builtin_function __ARGS((char_u *name));
773 #ifdef FEAT_PROFILE
774 static void func_do_profile __ARGS((ufunc_T *fp));
775 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
776 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
777 static int
778 # ifdef __BORLANDC__
779 _RTLENTRYF
780 # endif
781 prof_total_cmp __ARGS((const void *s1, const void *s2));
782 static int
783 # ifdef __BORLANDC__
784 _RTLENTRYF
785 # endif
786 prof_self_cmp __ARGS((const void *s1, const void *s2));
787 #endif
788 static int script_autoload __ARGS((char_u *name, int reload));
789 static char_u *autoload_name __ARGS((char_u *name));
790 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
791 static void func_free __ARGS((ufunc_T *fp));
792 static void func_unref __ARGS((char_u *name));
793 static void func_ref __ARGS((char_u *name));
794 static void call_user_func __ARGS((ufunc_T *fp, int argcount, typval_T *argvars, typval_T *rettv, linenr_T firstline, linenr_T lastline, dict_T *selfdict));
795 static int can_free_funccal __ARGS((funccall_T *fc, int copyID)) ;
796 static void free_funccal __ARGS((funccall_T *fc, int free_val));
797 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
798 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
799 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
800 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
801 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
802 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
804 /* Character used as separated in autoload function/variable names. */
805 #define AUTOLOAD_CHAR '#'
808 * Initialize the global and v: variables.
810 void
811 eval_init()
813 int i;
814 struct vimvar *p;
816 init_var_dict(&globvardict, &globvars_var);
817 init_var_dict(&vimvardict, &vimvars_var);
818 hash_init(&compat_hashtab);
819 hash_init(&func_hashtab);
821 for (i = 0; i < VV_LEN; ++i)
823 p = &vimvars[i];
824 STRCPY(p->vv_di.di_key, p->vv_name);
825 if (p->vv_flags & VV_RO)
826 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
827 else if (p->vv_flags & VV_RO_SBX)
828 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
829 else
830 p->vv_di.di_flags = DI_FLAGS_FIX;
832 /* add to v: scope dict, unless the value is not always available */
833 if (p->vv_type != VAR_UNKNOWN)
834 hash_add(&vimvarht, p->vv_di.di_key);
835 if (p->vv_flags & VV_COMPAT)
836 /* add to compat scope dict */
837 hash_add(&compat_hashtab, p->vv_di.di_key);
839 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
842 #if defined(EXITFREE) || defined(PROTO)
843 void
844 eval_clear()
846 int i;
847 struct vimvar *p;
849 for (i = 0; i < VV_LEN; ++i)
851 p = &vimvars[i];
852 if (p->vv_di.di_tv.v_type == VAR_STRING)
854 vim_free(p->vv_str);
855 p->vv_str = NULL;
857 else if (p->vv_di.di_tv.v_type == VAR_LIST)
859 list_unref(p->vv_list);
860 p->vv_list = NULL;
863 hash_clear(&vimvarht);
864 hash_init(&vimvarht); /* garbage_collect() will access it */
865 hash_clear(&compat_hashtab);
867 /* script-local variables */
868 for (i = 1; i <= ga_scripts.ga_len; ++i)
869 vars_clear(&SCRIPT_VARS(i));
870 ga_clear(&ga_scripts);
871 free_scriptnames();
873 /* global variables */
874 vars_clear(&globvarht);
876 /* autoloaded script names */
877 ga_clear_strings(&ga_loaded);
879 /* unreferenced lists and dicts */
880 (void)garbage_collect();
882 /* functions */
883 free_all_functions();
884 hash_clear(&func_hashtab);
886 #endif
889 * Return the name of the executed function.
891 char_u *
892 func_name(cookie)
893 void *cookie;
895 return ((funccall_T *)cookie)->func->uf_name;
899 * Return the address holding the next breakpoint line for a funccall cookie.
901 linenr_T *
902 func_breakpoint(cookie)
903 void *cookie;
905 return &((funccall_T *)cookie)->breakpoint;
909 * Return the address holding the debug tick for a funccall cookie.
911 int *
912 func_dbg_tick(cookie)
913 void *cookie;
915 return &((funccall_T *)cookie)->dbg_tick;
919 * Return the nesting level for a funccall cookie.
922 func_level(cookie)
923 void *cookie;
925 return ((funccall_T *)cookie)->level;
928 /* pointer to funccal for currently active function */
929 funccall_T *current_funccal = NULL;
931 /* pointer to list of previously used funccal, still around because some
932 * item in it is still being used. */
933 funccall_T *previous_funccal = NULL;
936 * Return TRUE when a function was ended by a ":return" command.
939 current_func_returned()
941 return current_funccal->returned;
946 * Set an internal variable to a string value. Creates the variable if it does
947 * not already exist.
949 void
950 set_internal_string_var(name, value)
951 char_u *name;
952 char_u *value;
954 char_u *val;
955 typval_T *tvp;
957 val = vim_strsave(value);
958 if (val != NULL)
960 tvp = alloc_string_tv(val);
961 if (tvp != NULL)
963 set_var(name, tvp, FALSE);
964 free_tv(tvp);
969 static lval_T *redir_lval = NULL;
970 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
971 static char_u *redir_endp = NULL;
972 static char_u *redir_varname = NULL;
975 * Start recording command output to a variable
976 * Returns OK if successfully completed the setup. FAIL otherwise.
979 var_redir_start(name, append)
980 char_u *name;
981 int append; /* append to an existing variable */
983 int save_emsg;
984 int err;
985 typval_T tv;
987 /* Make sure a valid variable name is specified */
988 if (!eval_isnamec1(*name))
990 EMSG(_(e_invarg));
991 return FAIL;
994 redir_varname = vim_strsave(name);
995 if (redir_varname == NULL)
996 return FAIL;
998 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
999 if (redir_lval == NULL)
1001 var_redir_stop();
1002 return FAIL;
1005 /* The output is stored in growarray "redir_ga" until redirection ends. */
1006 ga_init2(&redir_ga, (int)sizeof(char), 500);
1008 /* Parse the variable name (can be a dict or list entry). */
1009 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1010 FNE_CHECK_START);
1011 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1013 if (redir_endp != NULL && *redir_endp != NUL)
1014 /* Trailing characters are present after the variable name */
1015 EMSG(_(e_trailing));
1016 else
1017 EMSG(_(e_invarg));
1018 var_redir_stop();
1019 return FAIL;
1022 /* check if we can write to the variable: set it to or append an empty
1023 * string */
1024 save_emsg = did_emsg;
1025 did_emsg = FALSE;
1026 tv.v_type = VAR_STRING;
1027 tv.vval.v_string = (char_u *)"";
1028 if (append)
1029 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1030 else
1031 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1032 err = did_emsg;
1033 did_emsg |= save_emsg;
1034 if (err)
1036 var_redir_stop();
1037 return FAIL;
1039 if (redir_lval->ll_newkey != NULL)
1041 /* Dictionary item was created, don't do it again. */
1042 vim_free(redir_lval->ll_newkey);
1043 redir_lval->ll_newkey = NULL;
1046 return OK;
1050 * Append "value[value_len]" to the variable set by var_redir_start().
1051 * The actual appending is postponed until redirection ends, because the value
1052 * appended may in fact be the string we write to, changing it may cause freed
1053 * memory to be used:
1054 * :redir => foo
1055 * :let foo
1056 * :redir END
1058 void
1059 var_redir_str(value, value_len)
1060 char_u *value;
1061 int value_len;
1063 int len;
1065 if (redir_lval == NULL)
1066 return;
1068 if (value_len == -1)
1069 len = (int)STRLEN(value); /* Append the entire string */
1070 else
1071 len = value_len; /* Append only "value_len" characters */
1073 if (ga_grow(&redir_ga, len) == OK)
1075 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1076 redir_ga.ga_len += len;
1078 else
1079 var_redir_stop();
1083 * Stop redirecting command output to a variable.
1085 void
1086 var_redir_stop()
1088 typval_T tv;
1090 if (redir_lval != NULL)
1092 /* Append the trailing NUL. */
1093 ga_append(&redir_ga, NUL);
1095 /* Assign the text to the variable. */
1096 tv.v_type = VAR_STRING;
1097 tv.vval.v_string = redir_ga.ga_data;
1098 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1099 vim_free(tv.vval.v_string);
1101 clear_lval(redir_lval);
1102 vim_free(redir_lval);
1103 redir_lval = NULL;
1105 vim_free(redir_varname);
1106 redir_varname = NULL;
1109 # if defined(FEAT_MBYTE) || defined(PROTO)
1111 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1112 char_u *enc_from;
1113 char_u *enc_to;
1114 char_u *fname_from;
1115 char_u *fname_to;
1117 int err = FALSE;
1119 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1120 set_vim_var_string(VV_CC_TO, enc_to, -1);
1121 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1122 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1123 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1124 err = TRUE;
1125 set_vim_var_string(VV_CC_FROM, NULL, -1);
1126 set_vim_var_string(VV_CC_TO, NULL, -1);
1127 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1128 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1130 if (err)
1131 return FAIL;
1132 return OK;
1134 # endif
1136 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1138 eval_printexpr(fname, args)
1139 char_u *fname;
1140 char_u *args;
1142 int err = FALSE;
1144 set_vim_var_string(VV_FNAME_IN, fname, -1);
1145 set_vim_var_string(VV_CMDARG, args, -1);
1146 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1147 err = TRUE;
1148 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1149 set_vim_var_string(VV_CMDARG, NULL, -1);
1151 if (err)
1153 mch_remove(fname);
1154 return FAIL;
1156 return OK;
1158 # endif
1160 # if defined(FEAT_DIFF) || defined(PROTO)
1161 void
1162 eval_diff(origfile, newfile, outfile)
1163 char_u *origfile;
1164 char_u *newfile;
1165 char_u *outfile;
1167 int err = FALSE;
1169 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1170 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1171 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1172 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1173 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1174 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1175 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1178 void
1179 eval_patch(origfile, difffile, outfile)
1180 char_u *origfile;
1181 char_u *difffile;
1182 char_u *outfile;
1184 int err;
1186 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1187 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1188 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1189 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1190 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1191 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1192 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1194 # endif
1197 * Top level evaluation function, returning a boolean.
1198 * Sets "error" to TRUE if there was an error.
1199 * Return TRUE or FALSE.
1202 eval_to_bool(arg, error, nextcmd, skip)
1203 char_u *arg;
1204 int *error;
1205 char_u **nextcmd;
1206 int skip; /* only parse, don't execute */
1208 typval_T tv;
1209 int retval = FALSE;
1211 if (skip)
1212 ++emsg_skip;
1213 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1214 *error = TRUE;
1215 else
1217 *error = FALSE;
1218 if (!skip)
1220 retval = (get_tv_number_chk(&tv, error) != 0);
1221 clear_tv(&tv);
1224 if (skip)
1225 --emsg_skip;
1227 return retval;
1231 * Top level evaluation function, returning a string. If "skip" is TRUE,
1232 * only parsing to "nextcmd" is done, without reporting errors. Return
1233 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1235 char_u *
1236 eval_to_string_skip(arg, nextcmd, skip)
1237 char_u *arg;
1238 char_u **nextcmd;
1239 int skip; /* only parse, don't execute */
1241 typval_T tv;
1242 char_u *retval;
1244 if (skip)
1245 ++emsg_skip;
1246 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1247 retval = NULL;
1248 else
1250 retval = vim_strsave(get_tv_string(&tv));
1251 clear_tv(&tv);
1253 if (skip)
1254 --emsg_skip;
1256 return retval;
1260 * Skip over an expression at "*pp".
1261 * Return FAIL for an error, OK otherwise.
1264 skip_expr(pp)
1265 char_u **pp;
1267 typval_T rettv;
1269 *pp = skipwhite(*pp);
1270 return eval1(pp, &rettv, FALSE);
1274 * Top level evaluation function, returning a string.
1275 * When "convert" is TRUE convert a List into a sequence of lines and convert
1276 * a Float to a String.
1277 * Return pointer to allocated memory, or NULL for failure.
1279 char_u *
1280 eval_to_string(arg, nextcmd, convert)
1281 char_u *arg;
1282 char_u **nextcmd;
1283 int convert;
1285 typval_T tv;
1286 char_u *retval;
1287 garray_T ga;
1288 char_u numbuf[NUMBUFLEN];
1290 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1291 retval = NULL;
1292 else
1294 if (convert && tv.v_type == VAR_LIST)
1296 ga_init2(&ga, (int)sizeof(char), 80);
1297 if (tv.vval.v_list != NULL)
1298 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1299 ga_append(&ga, NUL);
1300 retval = (char_u *)ga.ga_data;
1302 #ifdef FEAT_FLOAT
1303 else if (convert && tv.v_type == VAR_FLOAT)
1305 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1306 retval = vim_strsave(numbuf);
1308 #endif
1309 else
1310 retval = vim_strsave(get_tv_string(&tv));
1311 clear_tv(&tv);
1314 return retval;
1318 * Call eval_to_string() without using current local variables and using
1319 * textlock. When "use_sandbox" is TRUE use the sandbox.
1321 char_u *
1322 eval_to_string_safe(arg, nextcmd, use_sandbox)
1323 char_u *arg;
1324 char_u **nextcmd;
1325 int use_sandbox;
1327 char_u *retval;
1328 void *save_funccalp;
1330 save_funccalp = save_funccal();
1331 if (use_sandbox)
1332 ++sandbox;
1333 ++textlock;
1334 retval = eval_to_string(arg, nextcmd, FALSE);
1335 if (use_sandbox)
1336 --sandbox;
1337 --textlock;
1338 restore_funccal(save_funccalp);
1339 return retval;
1343 * Top level evaluation function, returning a number.
1344 * Evaluates "expr" silently.
1345 * Returns -1 for an error.
1348 eval_to_number(expr)
1349 char_u *expr;
1351 typval_T rettv;
1352 int retval;
1353 char_u *p = skipwhite(expr);
1355 ++emsg_off;
1357 if (eval1(&p, &rettv, TRUE) == FAIL)
1358 retval = -1;
1359 else
1361 retval = get_tv_number_chk(&rettv, NULL);
1362 clear_tv(&rettv);
1364 --emsg_off;
1366 return retval;
1370 * Prepare v: variable "idx" to be used.
1371 * Save the current typeval in "save_tv".
1372 * When not used yet add the variable to the v: hashtable.
1374 static void
1375 prepare_vimvar(idx, save_tv)
1376 int idx;
1377 typval_T *save_tv;
1379 *save_tv = vimvars[idx].vv_tv;
1380 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1381 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1385 * Restore v: variable "idx" to typeval "save_tv".
1386 * When no longer defined, remove the variable from the v: hashtable.
1388 static void
1389 restore_vimvar(idx, save_tv)
1390 int idx;
1391 typval_T *save_tv;
1393 hashitem_T *hi;
1395 vimvars[idx].vv_tv = *save_tv;
1396 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1398 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1399 if (HASHITEM_EMPTY(hi))
1400 EMSG2(_(e_intern2), "restore_vimvar()");
1401 else
1402 hash_remove(&vimvarht, hi);
1406 #if defined(FEAT_SPELL) || defined(PROTO)
1408 * Evaluate an expression to a list with suggestions.
1409 * For the "expr:" part of 'spellsuggest'.
1410 * Returns NULL when there is an error.
1412 list_T *
1413 eval_spell_expr(badword, expr)
1414 char_u *badword;
1415 char_u *expr;
1417 typval_T save_val;
1418 typval_T rettv;
1419 list_T *list = NULL;
1420 char_u *p = skipwhite(expr);
1422 /* Set "v:val" to the bad word. */
1423 prepare_vimvar(VV_VAL, &save_val);
1424 vimvars[VV_VAL].vv_type = VAR_STRING;
1425 vimvars[VV_VAL].vv_str = badword;
1426 if (p_verbose == 0)
1427 ++emsg_off;
1429 if (eval1(&p, &rettv, TRUE) == OK)
1431 if (rettv.v_type != VAR_LIST)
1432 clear_tv(&rettv);
1433 else
1434 list = rettv.vval.v_list;
1437 if (p_verbose == 0)
1438 --emsg_off;
1439 restore_vimvar(VV_VAL, &save_val);
1441 return list;
1445 * "list" is supposed to contain two items: a word and a number. Return the
1446 * word in "pp" and the number as the return value.
1447 * Return -1 if anything isn't right.
1448 * Used to get the good word and score from the eval_spell_expr() result.
1451 get_spellword(list, pp)
1452 list_T *list;
1453 char_u **pp;
1455 listitem_T *li;
1457 li = list->lv_first;
1458 if (li == NULL)
1459 return -1;
1460 *pp = get_tv_string(&li->li_tv);
1462 li = li->li_next;
1463 if (li == NULL)
1464 return -1;
1465 return get_tv_number(&li->li_tv);
1467 #endif
1470 * Top level evaluation function.
1471 * Returns an allocated typval_T with the result.
1472 * Returns NULL when there is an error.
1474 typval_T *
1475 eval_expr(arg, nextcmd)
1476 char_u *arg;
1477 char_u **nextcmd;
1479 typval_T *tv;
1481 tv = (typval_T *)alloc(sizeof(typval_T));
1482 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1484 vim_free(tv);
1485 tv = NULL;
1488 return tv;
1492 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1493 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1495 * Call some vimL function and return the result in "*rettv".
1496 * Uses argv[argc] for the function arguments. Only Number and String
1497 * arguments are currently supported.
1498 * Returns OK or FAIL.
1500 static int
1501 call_vim_function(func, argc, argv, safe, rettv)
1502 char_u *func;
1503 int argc;
1504 char_u **argv;
1505 int safe; /* use the sandbox */
1506 typval_T *rettv;
1508 typval_T *argvars;
1509 long n;
1510 int len;
1511 int i;
1512 int doesrange;
1513 void *save_funccalp = NULL;
1514 int ret;
1516 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1517 if (argvars == NULL)
1518 return FAIL;
1520 for (i = 0; i < argc; i++)
1522 /* Pass a NULL or empty argument as an empty string */
1523 if (argv[i] == NULL || *argv[i] == NUL)
1525 argvars[i].v_type = VAR_STRING;
1526 argvars[i].vval.v_string = (char_u *)"";
1527 continue;
1530 /* Recognize a number argument, the others must be strings. */
1531 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1532 if (len != 0 && len == (int)STRLEN(argv[i]))
1534 argvars[i].v_type = VAR_NUMBER;
1535 argvars[i].vval.v_number = n;
1537 else
1539 argvars[i].v_type = VAR_STRING;
1540 argvars[i].vval.v_string = argv[i];
1544 if (safe)
1546 save_funccalp = save_funccal();
1547 ++sandbox;
1550 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1551 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1552 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1553 &doesrange, TRUE, NULL);
1554 if (safe)
1556 --sandbox;
1557 restore_funccal(save_funccalp);
1559 vim_free(argvars);
1561 if (ret == FAIL)
1562 clear_tv(rettv);
1564 return ret;
1567 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1569 * Call vimL function "func" and return the result as a string.
1570 * Returns NULL when calling the function fails.
1571 * Uses argv[argc] for the function arguments.
1573 void *
1574 call_func_retstr(func, argc, argv, safe)
1575 char_u *func;
1576 int argc;
1577 char_u **argv;
1578 int safe; /* use the sandbox */
1580 typval_T rettv;
1581 char_u *retval;
1583 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1584 return NULL;
1586 retval = vim_strsave(get_tv_string(&rettv));
1587 clear_tv(&rettv);
1588 return retval;
1590 # endif
1592 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1594 * Call vimL function "func" and return the result as a number.
1595 * Returns -1 when calling the function fails.
1596 * Uses argv[argc] for the function arguments.
1598 long
1599 call_func_retnr(func, argc, argv, safe)
1600 char_u *func;
1601 int argc;
1602 char_u **argv;
1603 int safe; /* use the sandbox */
1605 typval_T rettv;
1606 long retval;
1608 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1609 return -1;
1611 retval = get_tv_number_chk(&rettv, NULL);
1612 clear_tv(&rettv);
1613 return retval;
1615 # endif
1618 * Call vimL function "func" and return the result as a List.
1619 * Uses argv[argc] for the function arguments.
1620 * Returns NULL when there is something wrong.
1622 void *
1623 call_func_retlist(func, argc, argv, safe)
1624 char_u *func;
1625 int argc;
1626 char_u **argv;
1627 int safe; /* use the sandbox */
1629 typval_T rettv;
1631 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1632 return NULL;
1634 if (rettv.v_type != VAR_LIST)
1636 clear_tv(&rettv);
1637 return NULL;
1640 return rettv.vval.v_list;
1642 #endif
1646 * Save the current function call pointer, and set it to NULL.
1647 * Used when executing autocommands and for ":source".
1649 void *
1650 save_funccal()
1652 funccall_T *fc = current_funccal;
1654 current_funccal = NULL;
1655 return (void *)fc;
1658 void
1659 restore_funccal(vfc)
1660 void *vfc;
1662 funccall_T *fc = (funccall_T *)vfc;
1664 current_funccal = fc;
1667 #if defined(FEAT_PROFILE) || defined(PROTO)
1669 * Prepare profiling for entering a child or something else that is not
1670 * counted for the script/function itself.
1671 * Should always be called in pair with prof_child_exit().
1673 void
1674 prof_child_enter(tm)
1675 proftime_T *tm; /* place to store waittime */
1677 funccall_T *fc = current_funccal;
1679 if (fc != NULL && fc->func->uf_profiling)
1680 profile_start(&fc->prof_child);
1681 script_prof_save(tm);
1685 * Take care of time spent in a child.
1686 * Should always be called after prof_child_enter().
1688 void
1689 prof_child_exit(tm)
1690 proftime_T *tm; /* where waittime was stored */
1692 funccall_T *fc = current_funccal;
1694 if (fc != NULL && fc->func->uf_profiling)
1696 profile_end(&fc->prof_child);
1697 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1698 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1699 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1701 script_prof_restore(tm);
1703 #endif
1706 #ifdef FEAT_FOLDING
1708 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1709 * it in "*cp". Doesn't give error messages.
1712 eval_foldexpr(arg, cp)
1713 char_u *arg;
1714 int *cp;
1716 typval_T tv;
1717 int retval;
1718 char_u *s;
1719 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1720 OPT_LOCAL);
1722 ++emsg_off;
1723 if (use_sandbox)
1724 ++sandbox;
1725 ++textlock;
1726 *cp = NUL;
1727 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1728 retval = 0;
1729 else
1731 /* If the result is a number, just return the number. */
1732 if (tv.v_type == VAR_NUMBER)
1733 retval = tv.vval.v_number;
1734 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1735 retval = 0;
1736 else
1738 /* If the result is a string, check if there is a non-digit before
1739 * the number. */
1740 s = tv.vval.v_string;
1741 if (!VIM_ISDIGIT(*s) && *s != '-')
1742 *cp = *s++;
1743 retval = atol((char *)s);
1745 clear_tv(&tv);
1747 --emsg_off;
1748 if (use_sandbox)
1749 --sandbox;
1750 --textlock;
1752 return retval;
1754 #endif
1757 * ":let" list all variable values
1758 * ":let var1 var2" list variable values
1759 * ":let var = expr" assignment command.
1760 * ":let var += expr" assignment command.
1761 * ":let var -= expr" assignment command.
1762 * ":let var .= expr" assignment command.
1763 * ":let [var1, var2] = expr" unpack list.
1765 void
1766 ex_let(eap)
1767 exarg_T *eap;
1769 char_u *arg = eap->arg;
1770 char_u *expr = NULL;
1771 typval_T rettv;
1772 int i;
1773 int var_count = 0;
1774 int semicolon = 0;
1775 char_u op[2];
1776 char_u *argend;
1777 int first = TRUE;
1779 argend = skip_var_list(arg, &var_count, &semicolon);
1780 if (argend == NULL)
1781 return;
1782 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1783 --argend;
1784 expr = vim_strchr(argend, '=');
1785 if (expr == NULL)
1788 * ":let" without "=": list variables
1790 if (*arg == '[')
1791 EMSG(_(e_invarg));
1792 else if (!ends_excmd(*arg))
1793 /* ":let var1 var2" */
1794 arg = list_arg_vars(eap, arg, &first);
1795 else if (!eap->skip)
1797 /* ":let" */
1798 list_glob_vars(&first);
1799 list_buf_vars(&first);
1800 list_win_vars(&first);
1801 #ifdef FEAT_WINDOWS
1802 list_tab_vars(&first);
1803 #endif
1804 list_script_vars(&first);
1805 list_func_vars(&first);
1806 list_vim_vars(&first);
1808 eap->nextcmd = check_nextcmd(arg);
1810 else
1812 op[0] = '=';
1813 op[1] = NUL;
1814 if (expr > argend)
1816 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1817 op[0] = expr[-1]; /* +=, -= or .= */
1819 expr = skipwhite(expr + 1);
1821 if (eap->skip)
1822 ++emsg_skip;
1823 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1824 if (eap->skip)
1826 if (i != FAIL)
1827 clear_tv(&rettv);
1828 --emsg_skip;
1830 else if (i != FAIL)
1832 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1833 op);
1834 clear_tv(&rettv);
1840 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1841 * Handles both "var" with any type and "[var, var; var]" with a list type.
1842 * When "nextchars" is not NULL it points to a string with characters that
1843 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1844 * or concatenate.
1845 * Returns OK or FAIL;
1847 static int
1848 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1849 char_u *arg_start;
1850 typval_T *tv;
1851 int copy; /* copy values from "tv", don't move */
1852 int semicolon; /* from skip_var_list() */
1853 int var_count; /* from skip_var_list() */
1854 char_u *nextchars;
1856 char_u *arg = arg_start;
1857 list_T *l;
1858 int i;
1859 listitem_T *item;
1860 typval_T ltv;
1862 if (*arg != '[')
1865 * ":let var = expr" or ":for var in list"
1867 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1868 return FAIL;
1869 return OK;
1873 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1875 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1877 EMSG(_(e_listreq));
1878 return FAIL;
1881 i = list_len(l);
1882 if (semicolon == 0 && var_count < i)
1884 EMSG(_("E687: Less targets than List items"));
1885 return FAIL;
1887 if (var_count - semicolon > i)
1889 EMSG(_("E688: More targets than List items"));
1890 return FAIL;
1893 item = l->lv_first;
1894 while (*arg != ']')
1896 arg = skipwhite(arg + 1);
1897 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1898 item = item->li_next;
1899 if (arg == NULL)
1900 return FAIL;
1902 arg = skipwhite(arg);
1903 if (*arg == ';')
1905 /* Put the rest of the list (may be empty) in the var after ';'.
1906 * Create a new list for this. */
1907 l = list_alloc();
1908 if (l == NULL)
1909 return FAIL;
1910 while (item != NULL)
1912 list_append_tv(l, &item->li_tv);
1913 item = item->li_next;
1916 ltv.v_type = VAR_LIST;
1917 ltv.v_lock = 0;
1918 ltv.vval.v_list = l;
1919 l->lv_refcount = 1;
1921 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1922 (char_u *)"]", nextchars);
1923 clear_tv(&ltv);
1924 if (arg == NULL)
1925 return FAIL;
1926 break;
1928 else if (*arg != ',' && *arg != ']')
1930 EMSG2(_(e_intern2), "ex_let_vars()");
1931 return FAIL;
1935 return OK;
1939 * Skip over assignable variable "var" or list of variables "[var, var]".
1940 * Used for ":let varvar = expr" and ":for varvar in expr".
1941 * For "[var, var]" increment "*var_count" for each variable.
1942 * for "[var, var; var]" set "semicolon".
1943 * Return NULL for an error.
1945 static char_u *
1946 skip_var_list(arg, var_count, semicolon)
1947 char_u *arg;
1948 int *var_count;
1949 int *semicolon;
1951 char_u *p, *s;
1953 if (*arg == '[')
1955 /* "[var, var]": find the matching ']'. */
1956 p = arg;
1957 for (;;)
1959 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1960 s = skip_var_one(p);
1961 if (s == p)
1963 EMSG2(_(e_invarg2), p);
1964 return NULL;
1966 ++*var_count;
1968 p = skipwhite(s);
1969 if (*p == ']')
1970 break;
1971 else if (*p == ';')
1973 if (*semicolon == 1)
1975 EMSG(_("Double ; in list of variables"));
1976 return NULL;
1978 *semicolon = 1;
1980 else if (*p != ',')
1982 EMSG2(_(e_invarg2), p);
1983 return NULL;
1986 return p + 1;
1988 else
1989 return skip_var_one(arg);
1993 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1994 * l[idx].
1996 static char_u *
1997 skip_var_one(arg)
1998 char_u *arg;
2000 if (*arg == '@' && arg[1] != NUL)
2001 return arg + 2;
2002 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2003 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2007 * List variables for hashtab "ht" with prefix "prefix".
2008 * If "empty" is TRUE also list NULL strings as empty strings.
2010 static void
2011 list_hashtable_vars(ht, prefix, empty, first)
2012 hashtab_T *ht;
2013 char_u *prefix;
2014 int empty;
2015 int *first;
2017 hashitem_T *hi;
2018 dictitem_T *di;
2019 int todo;
2021 todo = (int)ht->ht_used;
2022 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2024 if (!HASHITEM_EMPTY(hi))
2026 --todo;
2027 di = HI2DI(hi);
2028 if (empty || di->di_tv.v_type != VAR_STRING
2029 || di->di_tv.vval.v_string != NULL)
2030 list_one_var(di, prefix, first);
2036 * List global variables.
2038 static void
2039 list_glob_vars(first)
2040 int *first;
2042 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2046 * List buffer variables.
2048 static void
2049 list_buf_vars(first)
2050 int *first;
2052 char_u numbuf[NUMBUFLEN];
2054 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2055 TRUE, first);
2057 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2058 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2059 numbuf, first);
2063 * List window variables.
2065 static void
2066 list_win_vars(first)
2067 int *first;
2069 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2070 (char_u *)"w:", TRUE, first);
2073 #ifdef FEAT_WINDOWS
2075 * List tab page variables.
2077 static void
2078 list_tab_vars(first)
2079 int *first;
2081 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2082 (char_u *)"t:", TRUE, first);
2084 #endif
2087 * List Vim variables.
2089 static void
2090 list_vim_vars(first)
2091 int *first;
2093 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2097 * List script-local variables, if there is a script.
2099 static void
2100 list_script_vars(first)
2101 int *first;
2103 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2104 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2105 (char_u *)"s:", FALSE, first);
2109 * List function variables, if there is a function.
2111 static void
2112 list_func_vars(first)
2113 int *first;
2115 if (current_funccal != NULL)
2116 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2117 (char_u *)"l:", FALSE, first);
2121 * List variables in "arg".
2123 static char_u *
2124 list_arg_vars(eap, arg, first)
2125 exarg_T *eap;
2126 char_u *arg;
2127 int *first;
2129 int error = FALSE;
2130 int len;
2131 char_u *name;
2132 char_u *name_start;
2133 char_u *arg_subsc;
2134 char_u *tofree;
2135 typval_T tv;
2137 while (!ends_excmd(*arg) && !got_int)
2139 if (error || eap->skip)
2141 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2142 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2144 emsg_severe = TRUE;
2145 EMSG(_(e_trailing));
2146 break;
2149 else
2151 /* get_name_len() takes care of expanding curly braces */
2152 name_start = name = arg;
2153 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2154 if (len <= 0)
2156 /* This is mainly to keep test 49 working: when expanding
2157 * curly braces fails overrule the exception error message. */
2158 if (len < 0 && !aborting())
2160 emsg_severe = TRUE;
2161 EMSG2(_(e_invarg2), arg);
2162 break;
2164 error = TRUE;
2166 else
2168 if (tofree != NULL)
2169 name = tofree;
2170 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2171 error = TRUE;
2172 else
2174 /* handle d.key, l[idx], f(expr) */
2175 arg_subsc = arg;
2176 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2177 error = TRUE;
2178 else
2180 if (arg == arg_subsc && len == 2 && name[1] == ':')
2182 switch (*name)
2184 case 'g': list_glob_vars(first); break;
2185 case 'b': list_buf_vars(first); break;
2186 case 'w': list_win_vars(first); break;
2187 #ifdef FEAT_WINDOWS
2188 case 't': list_tab_vars(first); break;
2189 #endif
2190 case 'v': list_vim_vars(first); break;
2191 case 's': list_script_vars(first); break;
2192 case 'l': list_func_vars(first); break;
2193 default:
2194 EMSG2(_("E738: Can't list variables for %s"), name);
2197 else
2199 char_u numbuf[NUMBUFLEN];
2200 char_u *tf;
2201 int c;
2202 char_u *s;
2204 s = echo_string(&tv, &tf, numbuf, 0);
2205 c = *arg;
2206 *arg = NUL;
2207 list_one_var_a((char_u *)"",
2208 arg == arg_subsc ? name : name_start,
2209 tv.v_type,
2210 s == NULL ? (char_u *)"" : s,
2211 first);
2212 *arg = c;
2213 vim_free(tf);
2215 clear_tv(&tv);
2220 vim_free(tofree);
2223 arg = skipwhite(arg);
2226 return arg;
2230 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2231 * Returns a pointer to the char just after the var name.
2232 * Returns NULL if there is an error.
2234 static char_u *
2235 ex_let_one(arg, tv, copy, endchars, op)
2236 char_u *arg; /* points to variable name */
2237 typval_T *tv; /* value to assign to variable */
2238 int copy; /* copy value from "tv" */
2239 char_u *endchars; /* valid chars after variable name or NULL */
2240 char_u *op; /* "+", "-", "." or NULL*/
2242 int c1;
2243 char_u *name;
2244 char_u *p;
2245 char_u *arg_end = NULL;
2246 int len;
2247 int opt_flags;
2248 char_u *tofree = NULL;
2251 * ":let $VAR = expr": Set environment variable.
2253 if (*arg == '$')
2255 /* Find the end of the name. */
2256 ++arg;
2257 name = arg;
2258 len = get_env_len(&arg);
2259 if (len == 0)
2260 EMSG2(_(e_invarg2), name - 1);
2261 else
2263 if (op != NULL && (*op == '+' || *op == '-'))
2264 EMSG2(_(e_letwrong), op);
2265 else if (endchars != NULL
2266 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2267 EMSG(_(e_letunexp));
2268 else
2270 c1 = name[len];
2271 name[len] = NUL;
2272 p = get_tv_string_chk(tv);
2273 if (p != NULL && op != NULL && *op == '.')
2275 int mustfree = FALSE;
2276 char_u *s = vim_getenv(name, &mustfree);
2278 if (s != NULL)
2280 p = tofree = concat_str(s, p);
2281 if (mustfree)
2282 vim_free(s);
2285 if (p != NULL)
2287 vim_setenv(name, p);
2288 if (STRICMP(name, "HOME") == 0)
2289 init_homedir();
2290 else if (didset_vim && STRICMP(name, "VIM") == 0)
2291 didset_vim = FALSE;
2292 else if (didset_vimruntime
2293 && STRICMP(name, "VIMRUNTIME") == 0)
2294 didset_vimruntime = FALSE;
2295 arg_end = arg;
2297 name[len] = c1;
2298 vim_free(tofree);
2304 * ":let &option = expr": Set option value.
2305 * ":let &l:option = expr": Set local option value.
2306 * ":let &g:option = expr": Set global option value.
2308 else if (*arg == '&')
2310 /* Find the end of the name. */
2311 p = find_option_end(&arg, &opt_flags);
2312 if (p == NULL || (endchars != NULL
2313 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2314 EMSG(_(e_letunexp));
2315 else
2317 long n;
2318 int opt_type;
2319 long numval;
2320 char_u *stringval = NULL;
2321 char_u *s;
2323 c1 = *p;
2324 *p = NUL;
2326 n = get_tv_number(tv);
2327 s = get_tv_string_chk(tv); /* != NULL if number or string */
2328 if (s != NULL && op != NULL && *op != '=')
2330 opt_type = get_option_value(arg, &numval,
2331 &stringval, opt_flags);
2332 if ((opt_type == 1 && *op == '.')
2333 || (opt_type == 0 && *op != '.'))
2334 EMSG2(_(e_letwrong), op);
2335 else
2337 if (opt_type == 1) /* number */
2339 if (*op == '+')
2340 n = numval + n;
2341 else
2342 n = numval - n;
2344 else if (opt_type == 0 && stringval != NULL) /* string */
2346 s = concat_str(stringval, s);
2347 vim_free(stringval);
2348 stringval = s;
2352 if (s != NULL)
2354 set_option_value(arg, n, s, opt_flags);
2355 arg_end = p;
2357 *p = c1;
2358 vim_free(stringval);
2363 * ":let @r = expr": Set register contents.
2365 else if (*arg == '@')
2367 ++arg;
2368 if (op != NULL && (*op == '+' || *op == '-'))
2369 EMSG2(_(e_letwrong), op);
2370 else if (endchars != NULL
2371 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2372 EMSG(_(e_letunexp));
2373 else
2375 char_u *ptofree = NULL;
2376 char_u *s;
2378 p = get_tv_string_chk(tv);
2379 if (p != NULL && op != NULL && *op == '.')
2381 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2382 if (s != NULL)
2384 p = ptofree = concat_str(s, p);
2385 vim_free(s);
2388 if (p != NULL)
2390 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2391 arg_end = arg + 1;
2393 vim_free(ptofree);
2398 * ":let var = expr": Set internal variable.
2399 * ":let {expr} = expr": Idem, name made with curly braces
2401 else if (eval_isnamec1(*arg) || *arg == '{')
2403 lval_T lv;
2405 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2406 if (p != NULL && lv.ll_name != NULL)
2408 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2409 EMSG(_(e_letunexp));
2410 else
2412 set_var_lval(&lv, p, tv, copy, op);
2413 arg_end = p;
2416 clear_lval(&lv);
2419 else
2420 EMSG2(_(e_invarg2), arg);
2422 return arg_end;
2426 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2428 static int
2429 check_changedtick(arg)
2430 char_u *arg;
2432 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2434 EMSG2(_(e_readonlyvar), arg);
2435 return TRUE;
2437 return FALSE;
2441 * Get an lval: variable, Dict item or List item that can be assigned a value
2442 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2443 * "name.key", "name.key[expr]" etc.
2444 * Indexing only works if "name" is an existing List or Dictionary.
2445 * "name" points to the start of the name.
2446 * If "rettv" is not NULL it points to the value to be assigned.
2447 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2448 * wrong; must end in space or cmd separator.
2450 * Returns a pointer to just after the name, including indexes.
2451 * When an evaluation error occurs "lp->ll_name" is NULL;
2452 * Returns NULL for a parsing error. Still need to free items in "lp"!
2454 static char_u *
2455 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2456 char_u *name;
2457 typval_T *rettv;
2458 lval_T *lp;
2459 int unlet;
2460 int skip;
2461 int quiet; /* don't give error messages */
2462 int fne_flags; /* flags for find_name_end() */
2464 char_u *p;
2465 char_u *expr_start, *expr_end;
2466 int cc;
2467 dictitem_T *v;
2468 typval_T var1;
2469 typval_T var2;
2470 int empty1 = FALSE;
2471 listitem_T *ni;
2472 char_u *key = NULL;
2473 int len;
2474 hashtab_T *ht;
2476 /* Clear everything in "lp". */
2477 vim_memset(lp, 0, sizeof(lval_T));
2479 if (skip)
2481 /* When skipping just find the end of the name. */
2482 lp->ll_name = name;
2483 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2486 /* Find the end of the name. */
2487 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2488 if (expr_start != NULL)
2490 /* Don't expand the name when we already know there is an error. */
2491 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2492 && *p != '[' && *p != '.')
2494 EMSG(_(e_trailing));
2495 return NULL;
2498 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2499 if (lp->ll_exp_name == NULL)
2501 /* Report an invalid expression in braces, unless the
2502 * expression evaluation has been cancelled due to an
2503 * aborting error, an interrupt, or an exception. */
2504 if (!aborting() && !quiet)
2506 emsg_severe = TRUE;
2507 EMSG2(_(e_invarg2), name);
2508 return NULL;
2511 lp->ll_name = lp->ll_exp_name;
2513 else
2514 lp->ll_name = name;
2516 /* Without [idx] or .key we are done. */
2517 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2518 return p;
2520 cc = *p;
2521 *p = NUL;
2522 v = find_var(lp->ll_name, &ht);
2523 if (v == NULL && !quiet)
2524 EMSG2(_(e_undefvar), lp->ll_name);
2525 *p = cc;
2526 if (v == NULL)
2527 return NULL;
2530 * Loop until no more [idx] or .key is following.
2532 lp->ll_tv = &v->di_tv;
2533 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2535 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2536 && !(lp->ll_tv->v_type == VAR_DICT
2537 && lp->ll_tv->vval.v_dict != NULL))
2539 if (!quiet)
2540 EMSG(_("E689: Can only index a List or Dictionary"));
2541 return NULL;
2543 if (lp->ll_range)
2545 if (!quiet)
2546 EMSG(_("E708: [:] must come last"));
2547 return NULL;
2550 len = -1;
2551 if (*p == '.')
2553 key = p + 1;
2554 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2556 if (len == 0)
2558 if (!quiet)
2559 EMSG(_(e_emptykey));
2560 return NULL;
2562 p = key + len;
2564 else
2566 /* Get the index [expr] or the first index [expr: ]. */
2567 p = skipwhite(p + 1);
2568 if (*p == ':')
2569 empty1 = TRUE;
2570 else
2572 empty1 = FALSE;
2573 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2574 return NULL;
2575 if (get_tv_string_chk(&var1) == NULL)
2577 /* not a number or string */
2578 clear_tv(&var1);
2579 return NULL;
2583 /* Optionally get the second index [ :expr]. */
2584 if (*p == ':')
2586 if (lp->ll_tv->v_type == VAR_DICT)
2588 if (!quiet)
2589 EMSG(_(e_dictrange));
2590 if (!empty1)
2591 clear_tv(&var1);
2592 return NULL;
2594 if (rettv != NULL && (rettv->v_type != VAR_LIST
2595 || rettv->vval.v_list == NULL))
2597 if (!quiet)
2598 EMSG(_("E709: [:] requires a List value"));
2599 if (!empty1)
2600 clear_tv(&var1);
2601 return NULL;
2603 p = skipwhite(p + 1);
2604 if (*p == ']')
2605 lp->ll_empty2 = TRUE;
2606 else
2608 lp->ll_empty2 = FALSE;
2609 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2611 if (!empty1)
2612 clear_tv(&var1);
2613 return NULL;
2615 if (get_tv_string_chk(&var2) == NULL)
2617 /* not a number or string */
2618 if (!empty1)
2619 clear_tv(&var1);
2620 clear_tv(&var2);
2621 return NULL;
2624 lp->ll_range = TRUE;
2626 else
2627 lp->ll_range = FALSE;
2629 if (*p != ']')
2631 if (!quiet)
2632 EMSG(_(e_missbrac));
2633 if (!empty1)
2634 clear_tv(&var1);
2635 if (lp->ll_range && !lp->ll_empty2)
2636 clear_tv(&var2);
2637 return NULL;
2640 /* Skip to past ']'. */
2641 ++p;
2644 if (lp->ll_tv->v_type == VAR_DICT)
2646 if (len == -1)
2648 /* "[key]": get key from "var1" */
2649 key = get_tv_string(&var1); /* is number or string */
2650 if (*key == NUL)
2652 if (!quiet)
2653 EMSG(_(e_emptykey));
2654 clear_tv(&var1);
2655 return NULL;
2658 lp->ll_list = NULL;
2659 lp->ll_dict = lp->ll_tv->vval.v_dict;
2660 lp->ll_di = dict_find(lp->ll_dict, key, len);
2661 if (lp->ll_di == NULL)
2663 /* Key does not exist in dict: may need to add it. */
2664 if (*p == '[' || *p == '.' || unlet)
2666 if (!quiet)
2667 EMSG2(_(e_dictkey), key);
2668 if (len == -1)
2669 clear_tv(&var1);
2670 return NULL;
2672 if (len == -1)
2673 lp->ll_newkey = vim_strsave(key);
2674 else
2675 lp->ll_newkey = vim_strnsave(key, len);
2676 if (len == -1)
2677 clear_tv(&var1);
2678 if (lp->ll_newkey == NULL)
2679 p = NULL;
2680 break;
2682 if (len == -1)
2683 clear_tv(&var1);
2684 lp->ll_tv = &lp->ll_di->di_tv;
2686 else
2689 * Get the number and item for the only or first index of the List.
2691 if (empty1)
2692 lp->ll_n1 = 0;
2693 else
2695 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2696 clear_tv(&var1);
2698 lp->ll_dict = NULL;
2699 lp->ll_list = lp->ll_tv->vval.v_list;
2700 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2701 if (lp->ll_li == NULL)
2703 if (lp->ll_n1 < 0)
2705 lp->ll_n1 = 0;
2706 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2709 if (lp->ll_li == NULL)
2711 if (lp->ll_range && !lp->ll_empty2)
2712 clear_tv(&var2);
2713 return NULL;
2717 * May need to find the item or absolute index for the second
2718 * index of a range.
2719 * When no index given: "lp->ll_empty2" is TRUE.
2720 * Otherwise "lp->ll_n2" is set to the second index.
2722 if (lp->ll_range && !lp->ll_empty2)
2724 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2725 clear_tv(&var2);
2726 if (lp->ll_n2 < 0)
2728 ni = list_find(lp->ll_list, lp->ll_n2);
2729 if (ni == NULL)
2730 return NULL;
2731 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2734 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2735 if (lp->ll_n1 < 0)
2736 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2737 if (lp->ll_n2 < lp->ll_n1)
2738 return NULL;
2741 lp->ll_tv = &lp->ll_li->li_tv;
2745 return p;
2749 * Clear lval "lp" that was filled by get_lval().
2751 static void
2752 clear_lval(lp)
2753 lval_T *lp;
2755 vim_free(lp->ll_exp_name);
2756 vim_free(lp->ll_newkey);
2760 * Set a variable that was parsed by get_lval() to "rettv".
2761 * "endp" points to just after the parsed name.
2762 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2764 static void
2765 set_var_lval(lp, endp, rettv, copy, op)
2766 lval_T *lp;
2767 char_u *endp;
2768 typval_T *rettv;
2769 int copy;
2770 char_u *op;
2772 int cc;
2773 listitem_T *ri;
2774 dictitem_T *di;
2776 if (lp->ll_tv == NULL)
2778 if (!check_changedtick(lp->ll_name))
2780 cc = *endp;
2781 *endp = NUL;
2782 if (op != NULL && *op != '=')
2784 typval_T tv;
2786 /* handle +=, -= and .= */
2787 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2788 &tv, TRUE) == OK)
2790 if (tv_op(&tv, rettv, op) == OK)
2791 set_var(lp->ll_name, &tv, FALSE);
2792 clear_tv(&tv);
2795 else
2796 set_var(lp->ll_name, rettv, copy);
2797 *endp = cc;
2800 else if (tv_check_lock(lp->ll_newkey == NULL
2801 ? lp->ll_tv->v_lock
2802 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2804 else if (lp->ll_range)
2807 * Assign the List values to the list items.
2809 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2811 if (op != NULL && *op != '=')
2812 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2813 else
2815 clear_tv(&lp->ll_li->li_tv);
2816 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2818 ri = ri->li_next;
2819 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2820 break;
2821 if (lp->ll_li->li_next == NULL)
2823 /* Need to add an empty item. */
2824 if (list_append_number(lp->ll_list, 0) == FAIL)
2826 ri = NULL;
2827 break;
2830 lp->ll_li = lp->ll_li->li_next;
2831 ++lp->ll_n1;
2833 if (ri != NULL)
2834 EMSG(_("E710: List value has more items than target"));
2835 else if (lp->ll_empty2
2836 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2837 : lp->ll_n1 != lp->ll_n2)
2838 EMSG(_("E711: List value has not enough items"));
2840 else
2843 * Assign to a List or Dictionary item.
2845 if (lp->ll_newkey != NULL)
2847 if (op != NULL && *op != '=')
2849 EMSG2(_(e_letwrong), op);
2850 return;
2853 /* Need to add an item to the Dictionary. */
2854 di = dictitem_alloc(lp->ll_newkey);
2855 if (di == NULL)
2856 return;
2857 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2859 vim_free(di);
2860 return;
2862 lp->ll_tv = &di->di_tv;
2864 else if (op != NULL && *op != '=')
2866 tv_op(lp->ll_tv, rettv, op);
2867 return;
2869 else
2870 clear_tv(lp->ll_tv);
2873 * Assign the value to the variable or list item.
2875 if (copy)
2876 copy_tv(rettv, lp->ll_tv);
2877 else
2879 *lp->ll_tv = *rettv;
2880 lp->ll_tv->v_lock = 0;
2881 init_tv(rettv);
2887 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2888 * Returns OK or FAIL.
2890 static int
2891 tv_op(tv1, tv2, op)
2892 typval_T *tv1;
2893 typval_T *tv2;
2894 char_u *op;
2896 long n;
2897 char_u numbuf[NUMBUFLEN];
2898 char_u *s;
2900 /* Can't do anything with a Funcref or a Dict on the right. */
2901 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2903 switch (tv1->v_type)
2905 case VAR_DICT:
2906 case VAR_FUNC:
2907 break;
2909 case VAR_LIST:
2910 if (*op != '+' || tv2->v_type != VAR_LIST)
2911 break;
2912 /* List += List */
2913 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2914 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2915 return OK;
2917 case VAR_NUMBER:
2918 case VAR_STRING:
2919 if (tv2->v_type == VAR_LIST)
2920 break;
2921 if (*op == '+' || *op == '-')
2923 /* nr += nr or nr -= nr*/
2924 n = get_tv_number(tv1);
2925 #ifdef FEAT_FLOAT
2926 if (tv2->v_type == VAR_FLOAT)
2928 float_T f = n;
2930 if (*op == '+')
2931 f += tv2->vval.v_float;
2932 else
2933 f -= tv2->vval.v_float;
2934 clear_tv(tv1);
2935 tv1->v_type = VAR_FLOAT;
2936 tv1->vval.v_float = f;
2938 else
2939 #endif
2941 if (*op == '+')
2942 n += get_tv_number(tv2);
2943 else
2944 n -= get_tv_number(tv2);
2945 clear_tv(tv1);
2946 tv1->v_type = VAR_NUMBER;
2947 tv1->vval.v_number = n;
2950 else
2952 if (tv2->v_type == VAR_FLOAT)
2953 break;
2955 /* str .= str */
2956 s = get_tv_string(tv1);
2957 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2958 clear_tv(tv1);
2959 tv1->v_type = VAR_STRING;
2960 tv1->vval.v_string = s;
2962 return OK;
2964 #ifdef FEAT_FLOAT
2965 case VAR_FLOAT:
2967 float_T f;
2969 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2970 && tv2->v_type != VAR_NUMBER
2971 && tv2->v_type != VAR_STRING))
2972 break;
2973 if (tv2->v_type == VAR_FLOAT)
2974 f = tv2->vval.v_float;
2975 else
2976 f = get_tv_number(tv2);
2977 if (*op == '+')
2978 tv1->vval.v_float += f;
2979 else
2980 tv1->vval.v_float -= f;
2982 return OK;
2983 #endif
2987 EMSG2(_(e_letwrong), op);
2988 return FAIL;
2992 * Add a watcher to a list.
2994 static void
2995 list_add_watch(l, lw)
2996 list_T *l;
2997 listwatch_T *lw;
2999 lw->lw_next = l->lv_watch;
3000 l->lv_watch = lw;
3004 * Remove a watcher from a list.
3005 * No warning when it isn't found...
3007 static void
3008 list_rem_watch(l, lwrem)
3009 list_T *l;
3010 listwatch_T *lwrem;
3012 listwatch_T *lw, **lwp;
3014 lwp = &l->lv_watch;
3015 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3017 if (lw == lwrem)
3019 *lwp = lw->lw_next;
3020 break;
3022 lwp = &lw->lw_next;
3027 * Just before removing an item from a list: advance watchers to the next
3028 * item.
3030 static void
3031 list_fix_watch(l, item)
3032 list_T *l;
3033 listitem_T *item;
3035 listwatch_T *lw;
3037 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3038 if (lw->lw_item == item)
3039 lw->lw_item = item->li_next;
3043 * Evaluate the expression used in a ":for var in expr" command.
3044 * "arg" points to "var".
3045 * Set "*errp" to TRUE for an error, FALSE otherwise;
3046 * Return a pointer that holds the info. Null when there is an error.
3048 void *
3049 eval_for_line(arg, errp, nextcmdp, skip)
3050 char_u *arg;
3051 int *errp;
3052 char_u **nextcmdp;
3053 int skip;
3055 forinfo_T *fi;
3056 char_u *expr;
3057 typval_T tv;
3058 list_T *l;
3060 *errp = TRUE; /* default: there is an error */
3062 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3063 if (fi == NULL)
3064 return NULL;
3066 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3067 if (expr == NULL)
3068 return fi;
3070 expr = skipwhite(expr);
3071 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3073 EMSG(_("E690: Missing \"in\" after :for"));
3074 return fi;
3077 if (skip)
3078 ++emsg_skip;
3079 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3081 *errp = FALSE;
3082 if (!skip)
3084 l = tv.vval.v_list;
3085 if (tv.v_type != VAR_LIST || l == NULL)
3087 EMSG(_(e_listreq));
3088 clear_tv(&tv);
3090 else
3092 /* No need to increment the refcount, it's already set for the
3093 * list being used in "tv". */
3094 fi->fi_list = l;
3095 list_add_watch(l, &fi->fi_lw);
3096 fi->fi_lw.lw_item = l->lv_first;
3100 if (skip)
3101 --emsg_skip;
3103 return fi;
3107 * Use the first item in a ":for" list. Advance to the next.
3108 * Assign the values to the variable (list). "arg" points to the first one.
3109 * Return TRUE when a valid item was found, FALSE when at end of list or
3110 * something wrong.
3113 next_for_item(fi_void, arg)
3114 void *fi_void;
3115 char_u *arg;
3117 forinfo_T *fi = (forinfo_T *)fi_void;
3118 int result;
3119 listitem_T *item;
3121 item = fi->fi_lw.lw_item;
3122 if (item == NULL)
3123 result = FALSE;
3124 else
3126 fi->fi_lw.lw_item = item->li_next;
3127 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3128 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3130 return result;
3134 * Free the structure used to store info used by ":for".
3136 void
3137 free_for_info(fi_void)
3138 void *fi_void;
3140 forinfo_T *fi = (forinfo_T *)fi_void;
3142 if (fi != NULL && fi->fi_list != NULL)
3144 list_rem_watch(fi->fi_list, &fi->fi_lw);
3145 list_unref(fi->fi_list);
3147 vim_free(fi);
3150 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3152 void
3153 set_context_for_expression(xp, arg, cmdidx)
3154 expand_T *xp;
3155 char_u *arg;
3156 cmdidx_T cmdidx;
3158 int got_eq = FALSE;
3159 int c;
3160 char_u *p;
3162 if (cmdidx == CMD_let)
3164 xp->xp_context = EXPAND_USER_VARS;
3165 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3167 /* ":let var1 var2 ...": find last space. */
3168 for (p = arg + STRLEN(arg); p >= arg; )
3170 xp->xp_pattern = p;
3171 mb_ptr_back(arg, p);
3172 if (vim_iswhite(*p))
3173 break;
3175 return;
3178 else
3179 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3180 : EXPAND_EXPRESSION;
3181 while ((xp->xp_pattern = vim_strpbrk(arg,
3182 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3184 c = *xp->xp_pattern;
3185 if (c == '&')
3187 c = xp->xp_pattern[1];
3188 if (c == '&')
3190 ++xp->xp_pattern;
3191 xp->xp_context = cmdidx != CMD_let || got_eq
3192 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3194 else if (c != ' ')
3196 xp->xp_context = EXPAND_SETTINGS;
3197 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3198 xp->xp_pattern += 2;
3202 else if (c == '$')
3204 /* environment variable */
3205 xp->xp_context = EXPAND_ENV_VARS;
3207 else if (c == '=')
3209 got_eq = TRUE;
3210 xp->xp_context = EXPAND_EXPRESSION;
3212 else if (c == '<'
3213 && xp->xp_context == EXPAND_FUNCTIONS
3214 && vim_strchr(xp->xp_pattern, '(') == NULL)
3216 /* Function name can start with "<SNR>" */
3217 break;
3219 else if (cmdidx != CMD_let || got_eq)
3221 if (c == '"') /* string */
3223 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3224 if (c == '\\' && xp->xp_pattern[1] != NUL)
3225 ++xp->xp_pattern;
3226 xp->xp_context = EXPAND_NOTHING;
3228 else if (c == '\'') /* literal string */
3230 /* Trick: '' is like stopping and starting a literal string. */
3231 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3232 /* skip */ ;
3233 xp->xp_context = EXPAND_NOTHING;
3235 else if (c == '|')
3237 if (xp->xp_pattern[1] == '|')
3239 ++xp->xp_pattern;
3240 xp->xp_context = EXPAND_EXPRESSION;
3242 else
3243 xp->xp_context = EXPAND_COMMANDS;
3245 else
3246 xp->xp_context = EXPAND_EXPRESSION;
3248 else
3249 /* Doesn't look like something valid, expand as an expression
3250 * anyway. */
3251 xp->xp_context = EXPAND_EXPRESSION;
3252 arg = xp->xp_pattern;
3253 if (*arg != NUL)
3254 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3255 /* skip */ ;
3257 xp->xp_pattern = arg;
3260 #endif /* FEAT_CMDL_COMPL */
3263 * ":1,25call func(arg1, arg2)" function call.
3265 void
3266 ex_call(eap)
3267 exarg_T *eap;
3269 char_u *arg = eap->arg;
3270 char_u *startarg;
3271 char_u *name;
3272 char_u *tofree;
3273 int len;
3274 typval_T rettv;
3275 linenr_T lnum;
3276 int doesrange;
3277 int failed = FALSE;
3278 funcdict_T fudi;
3280 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3281 if (fudi.fd_newkey != NULL)
3283 /* Still need to give an error message for missing key. */
3284 EMSG2(_(e_dictkey), fudi.fd_newkey);
3285 vim_free(fudi.fd_newkey);
3287 if (tofree == NULL)
3288 return;
3290 /* Increase refcount on dictionary, it could get deleted when evaluating
3291 * the arguments. */
3292 if (fudi.fd_dict != NULL)
3293 ++fudi.fd_dict->dv_refcount;
3295 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3296 len = (int)STRLEN(tofree);
3297 name = deref_func_name(tofree, &len);
3299 /* Skip white space to allow ":call func ()". Not good, but required for
3300 * backward compatibility. */
3301 startarg = skipwhite(arg);
3302 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3304 if (*startarg != '(')
3306 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3307 goto end;
3311 * When skipping, evaluate the function once, to find the end of the
3312 * arguments.
3313 * When the function takes a range, this is discovered after the first
3314 * call, and the loop is broken.
3316 if (eap->skip)
3318 ++emsg_skip;
3319 lnum = eap->line2; /* do it once, also with an invalid range */
3321 else
3322 lnum = eap->line1;
3323 for ( ; lnum <= eap->line2; ++lnum)
3325 if (!eap->skip && eap->addr_count > 0)
3327 curwin->w_cursor.lnum = lnum;
3328 curwin->w_cursor.col = 0;
3330 arg = startarg;
3331 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3332 eap->line1, eap->line2, &doesrange,
3333 !eap->skip, fudi.fd_dict) == FAIL)
3335 failed = TRUE;
3336 break;
3339 /* Handle a function returning a Funcref, Dictionary or List. */
3340 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3342 failed = TRUE;
3343 break;
3346 clear_tv(&rettv);
3347 if (doesrange || eap->skip)
3348 break;
3350 /* Stop when immediately aborting on error, or when an interrupt
3351 * occurred or an exception was thrown but not caught.
3352 * get_func_tv() returned OK, so that the check for trailing
3353 * characters below is executed. */
3354 if (aborting())
3355 break;
3357 if (eap->skip)
3358 --emsg_skip;
3360 if (!failed)
3362 /* Check for trailing illegal characters and a following command. */
3363 if (!ends_excmd(*arg))
3365 emsg_severe = TRUE;
3366 EMSG(_(e_trailing));
3368 else
3369 eap->nextcmd = check_nextcmd(arg);
3372 end:
3373 dict_unref(fudi.fd_dict);
3374 vim_free(tofree);
3378 * ":unlet[!] var1 ... " command.
3380 void
3381 ex_unlet(eap)
3382 exarg_T *eap;
3384 ex_unletlock(eap, eap->arg, 0);
3388 * ":lockvar" and ":unlockvar" commands
3390 void
3391 ex_lockvar(eap)
3392 exarg_T *eap;
3394 char_u *arg = eap->arg;
3395 int deep = 2;
3397 if (eap->forceit)
3398 deep = -1;
3399 else if (vim_isdigit(*arg))
3401 deep = getdigits(&arg);
3402 arg = skipwhite(arg);
3405 ex_unletlock(eap, arg, deep);
3409 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3411 static void
3412 ex_unletlock(eap, argstart, deep)
3413 exarg_T *eap;
3414 char_u *argstart;
3415 int deep;
3417 char_u *arg = argstart;
3418 char_u *name_end;
3419 int error = FALSE;
3420 lval_T lv;
3424 /* Parse the name and find the end. */
3425 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3426 FNE_CHECK_START);
3427 if (lv.ll_name == NULL)
3428 error = TRUE; /* error but continue parsing */
3429 if (name_end == NULL || (!vim_iswhite(*name_end)
3430 && !ends_excmd(*name_end)))
3432 if (name_end != NULL)
3434 emsg_severe = TRUE;
3435 EMSG(_(e_trailing));
3437 if (!(eap->skip || error))
3438 clear_lval(&lv);
3439 break;
3442 if (!error && !eap->skip)
3444 if (eap->cmdidx == CMD_unlet)
3446 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3447 error = TRUE;
3449 else
3451 if (do_lock_var(&lv, name_end, deep,
3452 eap->cmdidx == CMD_lockvar) == FAIL)
3453 error = TRUE;
3457 if (!eap->skip)
3458 clear_lval(&lv);
3460 arg = skipwhite(name_end);
3461 } while (!ends_excmd(*arg));
3463 eap->nextcmd = check_nextcmd(arg);
3466 static int
3467 do_unlet_var(lp, name_end, forceit)
3468 lval_T *lp;
3469 char_u *name_end;
3470 int forceit;
3472 int ret = OK;
3473 int cc;
3475 if (lp->ll_tv == NULL)
3477 cc = *name_end;
3478 *name_end = NUL;
3480 /* Normal name or expanded name. */
3481 if (check_changedtick(lp->ll_name))
3482 ret = FAIL;
3483 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3484 ret = FAIL;
3485 *name_end = cc;
3487 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3488 return FAIL;
3489 else if (lp->ll_range)
3491 listitem_T *li;
3493 /* Delete a range of List items. */
3494 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3496 li = lp->ll_li->li_next;
3497 listitem_remove(lp->ll_list, lp->ll_li);
3498 lp->ll_li = li;
3499 ++lp->ll_n1;
3502 else
3504 if (lp->ll_list != NULL)
3505 /* unlet a List item. */
3506 listitem_remove(lp->ll_list, lp->ll_li);
3507 else
3508 /* unlet a Dictionary item. */
3509 dictitem_remove(lp->ll_dict, lp->ll_di);
3512 return ret;
3516 * "unlet" a variable. Return OK if it existed, FAIL if not.
3517 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3520 do_unlet(name, forceit)
3521 char_u *name;
3522 int forceit;
3524 hashtab_T *ht;
3525 hashitem_T *hi;
3526 char_u *varname;
3527 dictitem_T *di;
3529 ht = find_var_ht(name, &varname);
3530 if (ht != NULL && *varname != NUL)
3532 hi = hash_find(ht, varname);
3533 if (!HASHITEM_EMPTY(hi))
3535 di = HI2DI(hi);
3536 if (var_check_fixed(di->di_flags, name)
3537 || var_check_ro(di->di_flags, name))
3538 return FAIL;
3539 delete_var(ht, hi);
3540 return OK;
3543 if (forceit)
3544 return OK;
3545 EMSG2(_("E108: No such variable: \"%s\""), name);
3546 return FAIL;
3550 * Lock or unlock variable indicated by "lp".
3551 * "deep" is the levels to go (-1 for unlimited);
3552 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3554 static int
3555 do_lock_var(lp, name_end, deep, lock)
3556 lval_T *lp;
3557 char_u *name_end;
3558 int deep;
3559 int lock;
3561 int ret = OK;
3562 int cc;
3563 dictitem_T *di;
3565 if (deep == 0) /* nothing to do */
3566 return OK;
3568 if (lp->ll_tv == NULL)
3570 cc = *name_end;
3571 *name_end = NUL;
3573 /* Normal name or expanded name. */
3574 if (check_changedtick(lp->ll_name))
3575 ret = FAIL;
3576 else
3578 di = find_var(lp->ll_name, NULL);
3579 if (di == NULL)
3580 ret = FAIL;
3581 else
3583 if (lock)
3584 di->di_flags |= DI_FLAGS_LOCK;
3585 else
3586 di->di_flags &= ~DI_FLAGS_LOCK;
3587 item_lock(&di->di_tv, deep, lock);
3590 *name_end = cc;
3592 else if (lp->ll_range)
3594 listitem_T *li = lp->ll_li;
3596 /* (un)lock a range of List items. */
3597 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3599 item_lock(&li->li_tv, deep, lock);
3600 li = li->li_next;
3601 ++lp->ll_n1;
3604 else if (lp->ll_list != NULL)
3605 /* (un)lock a List item. */
3606 item_lock(&lp->ll_li->li_tv, deep, lock);
3607 else
3608 /* un(lock) a Dictionary item. */
3609 item_lock(&lp->ll_di->di_tv, deep, lock);
3611 return ret;
3615 * Lock or unlock an item. "deep" is nr of levels to go.
3617 static void
3618 item_lock(tv, deep, lock)
3619 typval_T *tv;
3620 int deep;
3621 int lock;
3623 static int recurse = 0;
3624 list_T *l;
3625 listitem_T *li;
3626 dict_T *d;
3627 hashitem_T *hi;
3628 int todo;
3630 if (recurse >= DICT_MAXNEST)
3632 EMSG(_("E743: variable nested too deep for (un)lock"));
3633 return;
3635 if (deep == 0)
3636 return;
3637 ++recurse;
3639 /* lock/unlock the item itself */
3640 if (lock)
3641 tv->v_lock |= VAR_LOCKED;
3642 else
3643 tv->v_lock &= ~VAR_LOCKED;
3645 switch (tv->v_type)
3647 case VAR_LIST:
3648 if ((l = tv->vval.v_list) != NULL)
3650 if (lock)
3651 l->lv_lock |= VAR_LOCKED;
3652 else
3653 l->lv_lock &= ~VAR_LOCKED;
3654 if (deep < 0 || deep > 1)
3655 /* recursive: lock/unlock the items the List contains */
3656 for (li = l->lv_first; li != NULL; li = li->li_next)
3657 item_lock(&li->li_tv, deep - 1, lock);
3659 break;
3660 case VAR_DICT:
3661 if ((d = tv->vval.v_dict) != NULL)
3663 if (lock)
3664 d->dv_lock |= VAR_LOCKED;
3665 else
3666 d->dv_lock &= ~VAR_LOCKED;
3667 if (deep < 0 || deep > 1)
3669 /* recursive: lock/unlock the items the List contains */
3670 todo = (int)d->dv_hashtab.ht_used;
3671 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3673 if (!HASHITEM_EMPTY(hi))
3675 --todo;
3676 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3682 --recurse;
3686 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3687 * or it refers to a List or Dictionary that is locked.
3689 static int
3690 tv_islocked(tv)
3691 typval_T *tv;
3693 return (tv->v_lock & VAR_LOCKED)
3694 || (tv->v_type == VAR_LIST
3695 && tv->vval.v_list != NULL
3696 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3697 || (tv->v_type == VAR_DICT
3698 && tv->vval.v_dict != NULL
3699 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3702 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3704 * Delete all "menutrans_" variables.
3706 void
3707 del_menutrans_vars()
3709 hashitem_T *hi;
3710 int todo;
3712 hash_lock(&globvarht);
3713 todo = (int)globvarht.ht_used;
3714 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3716 if (!HASHITEM_EMPTY(hi))
3718 --todo;
3719 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3720 delete_var(&globvarht, hi);
3723 hash_unlock(&globvarht);
3725 #endif
3727 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3730 * Local string buffer for the next two functions to store a variable name
3731 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3732 * get_user_var_name().
3735 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3737 static char_u *varnamebuf = NULL;
3738 static int varnamebuflen = 0;
3741 * Function to concatenate a prefix and a variable name.
3743 static char_u *
3744 cat_prefix_varname(prefix, name)
3745 int prefix;
3746 char_u *name;
3748 int len;
3750 len = (int)STRLEN(name) + 3;
3751 if (len > varnamebuflen)
3753 vim_free(varnamebuf);
3754 len += 10; /* some additional space */
3755 varnamebuf = alloc(len);
3756 if (varnamebuf == NULL)
3758 varnamebuflen = 0;
3759 return NULL;
3761 varnamebuflen = len;
3763 *varnamebuf = prefix;
3764 varnamebuf[1] = ':';
3765 STRCPY(varnamebuf + 2, name);
3766 return varnamebuf;
3770 * Function given to ExpandGeneric() to obtain the list of user defined
3771 * (global/buffer/window/built-in) variable names.
3773 /*ARGSUSED*/
3774 char_u *
3775 get_user_var_name(xp, idx)
3776 expand_T *xp;
3777 int idx;
3779 static long_u gdone;
3780 static long_u bdone;
3781 static long_u wdone;
3782 #ifdef FEAT_WINDOWS
3783 static long_u tdone;
3784 #endif
3785 static int vidx;
3786 static hashitem_T *hi;
3787 hashtab_T *ht;
3789 if (idx == 0)
3791 gdone = bdone = wdone = vidx = 0;
3792 #ifdef FEAT_WINDOWS
3793 tdone = 0;
3794 #endif
3797 /* Global variables */
3798 if (gdone < globvarht.ht_used)
3800 if (gdone++ == 0)
3801 hi = globvarht.ht_array;
3802 else
3803 ++hi;
3804 while (HASHITEM_EMPTY(hi))
3805 ++hi;
3806 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3807 return cat_prefix_varname('g', hi->hi_key);
3808 return hi->hi_key;
3811 /* b: variables */
3812 ht = &curbuf->b_vars.dv_hashtab;
3813 if (bdone < ht->ht_used)
3815 if (bdone++ == 0)
3816 hi = ht->ht_array;
3817 else
3818 ++hi;
3819 while (HASHITEM_EMPTY(hi))
3820 ++hi;
3821 return cat_prefix_varname('b', hi->hi_key);
3823 if (bdone == ht->ht_used)
3825 ++bdone;
3826 return (char_u *)"b:changedtick";
3829 /* w: variables */
3830 ht = &curwin->w_vars.dv_hashtab;
3831 if (wdone < ht->ht_used)
3833 if (wdone++ == 0)
3834 hi = ht->ht_array;
3835 else
3836 ++hi;
3837 while (HASHITEM_EMPTY(hi))
3838 ++hi;
3839 return cat_prefix_varname('w', hi->hi_key);
3842 #ifdef FEAT_WINDOWS
3843 /* t: variables */
3844 ht = &curtab->tp_vars.dv_hashtab;
3845 if (tdone < ht->ht_used)
3847 if (tdone++ == 0)
3848 hi = ht->ht_array;
3849 else
3850 ++hi;
3851 while (HASHITEM_EMPTY(hi))
3852 ++hi;
3853 return cat_prefix_varname('t', hi->hi_key);
3855 #endif
3857 /* v: variables */
3858 if (vidx < VV_LEN)
3859 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3861 vim_free(varnamebuf);
3862 varnamebuf = NULL;
3863 varnamebuflen = 0;
3864 return NULL;
3867 #endif /* FEAT_CMDL_COMPL */
3870 * types for expressions.
3872 typedef enum
3874 TYPE_UNKNOWN = 0
3875 , TYPE_EQUAL /* == */
3876 , TYPE_NEQUAL /* != */
3877 , TYPE_GREATER /* > */
3878 , TYPE_GEQUAL /* >= */
3879 , TYPE_SMALLER /* < */
3880 , TYPE_SEQUAL /* <= */
3881 , TYPE_MATCH /* =~ */
3882 , TYPE_NOMATCH /* !~ */
3883 } exptype_T;
3886 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3887 * executed. The function may return OK, but the rettv will be of type
3888 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3892 * Handle zero level expression.
3893 * This calls eval1() and handles error message and nextcmd.
3894 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3895 * Note: "rettv.v_lock" is not set.
3896 * Return OK or FAIL.
3898 static int
3899 eval0(arg, rettv, nextcmd, evaluate)
3900 char_u *arg;
3901 typval_T *rettv;
3902 char_u **nextcmd;
3903 int evaluate;
3905 int ret;
3906 char_u *p;
3908 p = skipwhite(arg);
3909 ret = eval1(&p, rettv, evaluate);
3910 if (ret == FAIL || !ends_excmd(*p))
3912 if (ret != FAIL)
3913 clear_tv(rettv);
3915 * Report the invalid expression unless the expression evaluation has
3916 * been cancelled due to an aborting error, an interrupt, or an
3917 * exception.
3919 if (!aborting())
3920 EMSG2(_(e_invexpr2), arg);
3921 ret = FAIL;
3923 if (nextcmd != NULL)
3924 *nextcmd = check_nextcmd(p);
3926 return ret;
3930 * Handle top level expression:
3931 * expr1 ? expr0 : expr0
3933 * "arg" must point to the first non-white of the expression.
3934 * "arg" is advanced to the next non-white after the recognized expression.
3936 * Note: "rettv.v_lock" is not set.
3938 * Return OK or FAIL.
3940 static int
3941 eval1(arg, rettv, evaluate)
3942 char_u **arg;
3943 typval_T *rettv;
3944 int evaluate;
3946 int result;
3947 typval_T var2;
3950 * Get the first variable.
3952 if (eval2(arg, rettv, evaluate) == FAIL)
3953 return FAIL;
3955 if ((*arg)[0] == '?')
3957 result = FALSE;
3958 if (evaluate)
3960 int error = FALSE;
3962 if (get_tv_number_chk(rettv, &error) != 0)
3963 result = TRUE;
3964 clear_tv(rettv);
3965 if (error)
3966 return FAIL;
3970 * Get the second variable.
3972 *arg = skipwhite(*arg + 1);
3973 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3974 return FAIL;
3977 * Check for the ":".
3979 if ((*arg)[0] != ':')
3981 EMSG(_("E109: Missing ':' after '?'"));
3982 if (evaluate && result)
3983 clear_tv(rettv);
3984 return FAIL;
3988 * Get the third variable.
3990 *arg = skipwhite(*arg + 1);
3991 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
3993 if (evaluate && result)
3994 clear_tv(rettv);
3995 return FAIL;
3997 if (evaluate && !result)
3998 *rettv = var2;
4001 return OK;
4005 * Handle first level expression:
4006 * expr2 || expr2 || expr2 logical OR
4008 * "arg" must point to the first non-white of the expression.
4009 * "arg" is advanced to the next non-white after the recognized expression.
4011 * Return OK or FAIL.
4013 static int
4014 eval2(arg, rettv, evaluate)
4015 char_u **arg;
4016 typval_T *rettv;
4017 int evaluate;
4019 typval_T var2;
4020 long result;
4021 int first;
4022 int error = FALSE;
4025 * Get the first variable.
4027 if (eval3(arg, rettv, evaluate) == FAIL)
4028 return FAIL;
4031 * Repeat until there is no following "||".
4033 first = TRUE;
4034 result = FALSE;
4035 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4037 if (evaluate && first)
4039 if (get_tv_number_chk(rettv, &error) != 0)
4040 result = TRUE;
4041 clear_tv(rettv);
4042 if (error)
4043 return FAIL;
4044 first = FALSE;
4048 * Get the second variable.
4050 *arg = skipwhite(*arg + 2);
4051 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4052 return FAIL;
4055 * Compute the result.
4057 if (evaluate && !result)
4059 if (get_tv_number_chk(&var2, &error) != 0)
4060 result = TRUE;
4061 clear_tv(&var2);
4062 if (error)
4063 return FAIL;
4065 if (evaluate)
4067 rettv->v_type = VAR_NUMBER;
4068 rettv->vval.v_number = result;
4072 return OK;
4076 * Handle second level expression:
4077 * expr3 && expr3 && expr3 logical AND
4079 * "arg" must point to the first non-white of the expression.
4080 * "arg" is advanced to the next non-white after the recognized expression.
4082 * Return OK or FAIL.
4084 static int
4085 eval3(arg, rettv, evaluate)
4086 char_u **arg;
4087 typval_T *rettv;
4088 int evaluate;
4090 typval_T var2;
4091 long result;
4092 int first;
4093 int error = FALSE;
4096 * Get the first variable.
4098 if (eval4(arg, rettv, evaluate) == FAIL)
4099 return FAIL;
4102 * Repeat until there is no following "&&".
4104 first = TRUE;
4105 result = TRUE;
4106 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4108 if (evaluate && first)
4110 if (get_tv_number_chk(rettv, &error) == 0)
4111 result = FALSE;
4112 clear_tv(rettv);
4113 if (error)
4114 return FAIL;
4115 first = FALSE;
4119 * Get the second variable.
4121 *arg = skipwhite(*arg + 2);
4122 if (eval4(arg, &var2, evaluate && result) == FAIL)
4123 return FAIL;
4126 * Compute the result.
4128 if (evaluate && result)
4130 if (get_tv_number_chk(&var2, &error) == 0)
4131 result = FALSE;
4132 clear_tv(&var2);
4133 if (error)
4134 return FAIL;
4136 if (evaluate)
4138 rettv->v_type = VAR_NUMBER;
4139 rettv->vval.v_number = result;
4143 return OK;
4147 * Handle third level expression:
4148 * var1 == var2
4149 * var1 =~ var2
4150 * var1 != var2
4151 * var1 !~ var2
4152 * var1 > var2
4153 * var1 >= var2
4154 * var1 < var2
4155 * var1 <= var2
4156 * var1 is var2
4157 * var1 isnot var2
4159 * "arg" must point to the first non-white of the expression.
4160 * "arg" is advanced to the next non-white after the recognized expression.
4162 * Return OK or FAIL.
4164 static int
4165 eval4(arg, rettv, evaluate)
4166 char_u **arg;
4167 typval_T *rettv;
4168 int evaluate;
4170 typval_T var2;
4171 char_u *p;
4172 int i;
4173 exptype_T type = TYPE_UNKNOWN;
4174 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4175 int len = 2;
4176 long n1, n2;
4177 char_u *s1, *s2;
4178 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4179 regmatch_T regmatch;
4180 int ic;
4181 char_u *save_cpo;
4184 * Get the first variable.
4186 if (eval5(arg, rettv, evaluate) == FAIL)
4187 return FAIL;
4189 p = *arg;
4190 switch (p[0])
4192 case '=': if (p[1] == '=')
4193 type = TYPE_EQUAL;
4194 else if (p[1] == '~')
4195 type = TYPE_MATCH;
4196 break;
4197 case '!': if (p[1] == '=')
4198 type = TYPE_NEQUAL;
4199 else if (p[1] == '~')
4200 type = TYPE_NOMATCH;
4201 break;
4202 case '>': if (p[1] != '=')
4204 type = TYPE_GREATER;
4205 len = 1;
4207 else
4208 type = TYPE_GEQUAL;
4209 break;
4210 case '<': if (p[1] != '=')
4212 type = TYPE_SMALLER;
4213 len = 1;
4215 else
4216 type = TYPE_SEQUAL;
4217 break;
4218 case 'i': if (p[1] == 's')
4220 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4221 len = 5;
4222 if (!vim_isIDc(p[len]))
4224 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4225 type_is = TRUE;
4228 break;
4232 * If there is a comparative operator, use it.
4234 if (type != TYPE_UNKNOWN)
4236 /* extra question mark appended: ignore case */
4237 if (p[len] == '?')
4239 ic = TRUE;
4240 ++len;
4242 /* extra '#' appended: match case */
4243 else if (p[len] == '#')
4245 ic = FALSE;
4246 ++len;
4248 /* nothing appended: use 'ignorecase' */
4249 else
4250 ic = p_ic;
4253 * Get the second variable.
4255 *arg = skipwhite(p + len);
4256 if (eval5(arg, &var2, evaluate) == FAIL)
4258 clear_tv(rettv);
4259 return FAIL;
4262 if (evaluate)
4264 if (type_is && rettv->v_type != var2.v_type)
4266 /* For "is" a different type always means FALSE, for "notis"
4267 * it means TRUE. */
4268 n1 = (type == TYPE_NEQUAL);
4270 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4272 if (type_is)
4274 n1 = (rettv->v_type == var2.v_type
4275 && rettv->vval.v_list == var2.vval.v_list);
4276 if (type == TYPE_NEQUAL)
4277 n1 = !n1;
4279 else if (rettv->v_type != var2.v_type
4280 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4282 if (rettv->v_type != var2.v_type)
4283 EMSG(_("E691: Can only compare List with List"));
4284 else
4285 EMSG(_("E692: Invalid operation for Lists"));
4286 clear_tv(rettv);
4287 clear_tv(&var2);
4288 return FAIL;
4290 else
4292 /* Compare two Lists for being equal or unequal. */
4293 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4294 if (type == TYPE_NEQUAL)
4295 n1 = !n1;
4299 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4301 if (type_is)
4303 n1 = (rettv->v_type == var2.v_type
4304 && rettv->vval.v_dict == var2.vval.v_dict);
4305 if (type == TYPE_NEQUAL)
4306 n1 = !n1;
4308 else if (rettv->v_type != var2.v_type
4309 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4311 if (rettv->v_type != var2.v_type)
4312 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4313 else
4314 EMSG(_("E736: Invalid operation for Dictionary"));
4315 clear_tv(rettv);
4316 clear_tv(&var2);
4317 return FAIL;
4319 else
4321 /* Compare two Dictionaries for being equal or unequal. */
4322 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4323 if (type == TYPE_NEQUAL)
4324 n1 = !n1;
4328 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4330 if (rettv->v_type != var2.v_type
4331 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4333 if (rettv->v_type != var2.v_type)
4334 EMSG(_("E693: Can only compare Funcref with Funcref"));
4335 else
4336 EMSG(_("E694: Invalid operation for Funcrefs"));
4337 clear_tv(rettv);
4338 clear_tv(&var2);
4339 return FAIL;
4341 else
4343 /* Compare two Funcrefs for being equal or unequal. */
4344 if (rettv->vval.v_string == NULL
4345 || var2.vval.v_string == NULL)
4346 n1 = FALSE;
4347 else
4348 n1 = STRCMP(rettv->vval.v_string,
4349 var2.vval.v_string) == 0;
4350 if (type == TYPE_NEQUAL)
4351 n1 = !n1;
4355 #ifdef FEAT_FLOAT
4357 * If one of the two variables is a float, compare as a float.
4358 * When using "=~" or "!~", always compare as string.
4360 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4361 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4363 float_T f1, f2;
4365 if (rettv->v_type == VAR_FLOAT)
4366 f1 = rettv->vval.v_float;
4367 else
4368 f1 = get_tv_number(rettv);
4369 if (var2.v_type == VAR_FLOAT)
4370 f2 = var2.vval.v_float;
4371 else
4372 f2 = get_tv_number(&var2);
4373 n1 = FALSE;
4374 switch (type)
4376 case TYPE_EQUAL: n1 = (f1 == f2); break;
4377 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4378 case TYPE_GREATER: n1 = (f1 > f2); break;
4379 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4380 case TYPE_SMALLER: n1 = (f1 < f2); break;
4381 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4382 case TYPE_UNKNOWN:
4383 case TYPE_MATCH:
4384 case TYPE_NOMATCH: break; /* avoid gcc warning */
4387 #endif
4390 * If one of the two variables is a number, compare as a number.
4391 * When using "=~" or "!~", always compare as string.
4393 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4394 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4396 n1 = get_tv_number(rettv);
4397 n2 = get_tv_number(&var2);
4398 switch (type)
4400 case TYPE_EQUAL: n1 = (n1 == n2); break;
4401 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4402 case TYPE_GREATER: n1 = (n1 > n2); break;
4403 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4404 case TYPE_SMALLER: n1 = (n1 < n2); break;
4405 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4406 case TYPE_UNKNOWN:
4407 case TYPE_MATCH:
4408 case TYPE_NOMATCH: break; /* avoid gcc warning */
4411 else
4413 s1 = get_tv_string_buf(rettv, buf1);
4414 s2 = get_tv_string_buf(&var2, buf2);
4415 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4416 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4417 else
4418 i = 0;
4419 n1 = FALSE;
4420 switch (type)
4422 case TYPE_EQUAL: n1 = (i == 0); break;
4423 case TYPE_NEQUAL: n1 = (i != 0); break;
4424 case TYPE_GREATER: n1 = (i > 0); break;
4425 case TYPE_GEQUAL: n1 = (i >= 0); break;
4426 case TYPE_SMALLER: n1 = (i < 0); break;
4427 case TYPE_SEQUAL: n1 = (i <= 0); break;
4429 case TYPE_MATCH:
4430 case TYPE_NOMATCH:
4431 /* avoid 'l' flag in 'cpoptions' */
4432 save_cpo = p_cpo;
4433 p_cpo = (char_u *)"";
4434 regmatch.regprog = vim_regcomp(s2,
4435 RE_MAGIC + RE_STRING);
4436 regmatch.rm_ic = ic;
4437 if (regmatch.regprog != NULL)
4439 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4440 vim_free(regmatch.regprog);
4441 if (type == TYPE_NOMATCH)
4442 n1 = !n1;
4444 p_cpo = save_cpo;
4445 break;
4447 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4450 clear_tv(rettv);
4451 clear_tv(&var2);
4452 rettv->v_type = VAR_NUMBER;
4453 rettv->vval.v_number = n1;
4457 return OK;
4461 * Handle fourth level expression:
4462 * + number addition
4463 * - number subtraction
4464 * . string concatenation
4466 * "arg" must point to the first non-white of the expression.
4467 * "arg" is advanced to the next non-white after the recognized expression.
4469 * Return OK or FAIL.
4471 static int
4472 eval5(arg, rettv, evaluate)
4473 char_u **arg;
4474 typval_T *rettv;
4475 int evaluate;
4477 typval_T var2;
4478 typval_T var3;
4479 int op;
4480 long n1, n2;
4481 #ifdef FEAT_FLOAT
4482 float_T f1 = 0, f2 = 0;
4483 #endif
4484 char_u *s1, *s2;
4485 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4486 char_u *p;
4489 * Get the first variable.
4491 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4492 return FAIL;
4495 * Repeat computing, until no '+', '-' or '.' is following.
4497 for (;;)
4499 op = **arg;
4500 if (op != '+' && op != '-' && op != '.')
4501 break;
4503 if ((op != '+' || rettv->v_type != VAR_LIST)
4504 #ifdef FEAT_FLOAT
4505 && (op == '.' || rettv->v_type != VAR_FLOAT)
4506 #endif
4509 /* For "list + ...", an illegal use of the first operand as
4510 * a number cannot be determined before evaluating the 2nd
4511 * operand: if this is also a list, all is ok.
4512 * For "something . ...", "something - ..." or "non-list + ...",
4513 * we know that the first operand needs to be a string or number
4514 * without evaluating the 2nd operand. So check before to avoid
4515 * side effects after an error. */
4516 if (evaluate && get_tv_string_chk(rettv) == NULL)
4518 clear_tv(rettv);
4519 return FAIL;
4524 * Get the second variable.
4526 *arg = skipwhite(*arg + 1);
4527 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4529 clear_tv(rettv);
4530 return FAIL;
4533 if (evaluate)
4536 * Compute the result.
4538 if (op == '.')
4540 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4541 s2 = get_tv_string_buf_chk(&var2, buf2);
4542 if (s2 == NULL) /* type error ? */
4544 clear_tv(rettv);
4545 clear_tv(&var2);
4546 return FAIL;
4548 p = concat_str(s1, s2);
4549 clear_tv(rettv);
4550 rettv->v_type = VAR_STRING;
4551 rettv->vval.v_string = p;
4553 else if (op == '+' && rettv->v_type == VAR_LIST
4554 && var2.v_type == VAR_LIST)
4556 /* concatenate Lists */
4557 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4558 &var3) == FAIL)
4560 clear_tv(rettv);
4561 clear_tv(&var2);
4562 return FAIL;
4564 clear_tv(rettv);
4565 *rettv = var3;
4567 else
4569 int error = FALSE;
4571 #ifdef FEAT_FLOAT
4572 if (rettv->v_type == VAR_FLOAT)
4574 f1 = rettv->vval.v_float;
4575 n1 = 0;
4577 else
4578 #endif
4580 n1 = get_tv_number_chk(rettv, &error);
4581 if (error)
4583 /* This can only happen for "list + non-list". For
4584 * "non-list + ..." or "something - ...", we returned
4585 * before evaluating the 2nd operand. */
4586 clear_tv(rettv);
4587 return FAIL;
4589 #ifdef FEAT_FLOAT
4590 if (var2.v_type == VAR_FLOAT)
4591 f1 = n1;
4592 #endif
4594 #ifdef FEAT_FLOAT
4595 if (var2.v_type == VAR_FLOAT)
4597 f2 = var2.vval.v_float;
4598 n2 = 0;
4600 else
4601 #endif
4603 n2 = get_tv_number_chk(&var2, &error);
4604 if (error)
4606 clear_tv(rettv);
4607 clear_tv(&var2);
4608 return FAIL;
4610 #ifdef FEAT_FLOAT
4611 if (rettv->v_type == VAR_FLOAT)
4612 f2 = n2;
4613 #endif
4615 clear_tv(rettv);
4617 #ifdef FEAT_FLOAT
4618 /* If there is a float on either side the result is a float. */
4619 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4621 if (op == '+')
4622 f1 = f1 + f2;
4623 else
4624 f1 = f1 - f2;
4625 rettv->v_type = VAR_FLOAT;
4626 rettv->vval.v_float = f1;
4628 else
4629 #endif
4631 if (op == '+')
4632 n1 = n1 + n2;
4633 else
4634 n1 = n1 - n2;
4635 rettv->v_type = VAR_NUMBER;
4636 rettv->vval.v_number = n1;
4639 clear_tv(&var2);
4642 return OK;
4646 * Handle fifth level expression:
4647 * * number multiplication
4648 * / number division
4649 * % number modulo
4651 * "arg" must point to the first non-white of the expression.
4652 * "arg" is advanced to the next non-white after the recognized expression.
4654 * Return OK or FAIL.
4656 static int
4657 eval6(arg, rettv, evaluate, want_string)
4658 char_u **arg;
4659 typval_T *rettv;
4660 int evaluate;
4661 int want_string; /* after "." operator */
4663 typval_T var2;
4664 int op;
4665 long n1, n2;
4666 #ifdef FEAT_FLOAT
4667 int use_float = FALSE;
4668 float_T f1 = 0, f2;
4669 #endif
4670 int error = FALSE;
4673 * Get the first variable.
4675 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4676 return FAIL;
4679 * Repeat computing, until no '*', '/' or '%' is following.
4681 for (;;)
4683 op = **arg;
4684 if (op != '*' && op != '/' && op != '%')
4685 break;
4687 if (evaluate)
4689 #ifdef FEAT_FLOAT
4690 if (rettv->v_type == VAR_FLOAT)
4692 f1 = rettv->vval.v_float;
4693 use_float = TRUE;
4694 n1 = 0;
4696 else
4697 #endif
4698 n1 = get_tv_number_chk(rettv, &error);
4699 clear_tv(rettv);
4700 if (error)
4701 return FAIL;
4703 else
4704 n1 = 0;
4707 * Get the second variable.
4709 *arg = skipwhite(*arg + 1);
4710 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4711 return FAIL;
4713 if (evaluate)
4715 #ifdef FEAT_FLOAT
4716 if (var2.v_type == VAR_FLOAT)
4718 if (!use_float)
4720 f1 = n1;
4721 use_float = TRUE;
4723 f2 = var2.vval.v_float;
4724 n2 = 0;
4726 else
4727 #endif
4729 n2 = get_tv_number_chk(&var2, &error);
4730 clear_tv(&var2);
4731 if (error)
4732 return FAIL;
4733 #ifdef FEAT_FLOAT
4734 if (use_float)
4735 f2 = n2;
4736 #endif
4740 * Compute the result.
4741 * When either side is a float the result is a float.
4743 #ifdef FEAT_FLOAT
4744 if (use_float)
4746 if (op == '*')
4747 f1 = f1 * f2;
4748 else if (op == '/')
4750 /* We rely on the floating point library to handle divide
4751 * by zero to result in "inf" and not a crash. */
4752 f1 = f1 / f2;
4754 else
4756 EMSG(_("E804: Cannot use '%' with Float"));
4757 return FAIL;
4759 rettv->v_type = VAR_FLOAT;
4760 rettv->vval.v_float = f1;
4762 else
4763 #endif
4765 if (op == '*')
4766 n1 = n1 * n2;
4767 else if (op == '/')
4769 if (n2 == 0) /* give an error message? */
4771 if (n1 == 0)
4772 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4773 else if (n1 < 0)
4774 n1 = -0x7fffffffL;
4775 else
4776 n1 = 0x7fffffffL;
4778 else
4779 n1 = n1 / n2;
4781 else
4783 if (n2 == 0) /* give an error message? */
4784 n1 = 0;
4785 else
4786 n1 = n1 % n2;
4788 rettv->v_type = VAR_NUMBER;
4789 rettv->vval.v_number = n1;
4794 return OK;
4798 * Handle sixth level expression:
4799 * number number constant
4800 * "string" string constant
4801 * 'string' literal string constant
4802 * &option-name option value
4803 * @r register contents
4804 * identifier variable value
4805 * function() function call
4806 * $VAR environment variable
4807 * (expression) nested expression
4808 * [expr, expr] List
4809 * {key: val, key: val} Dictionary
4811 * Also handle:
4812 * ! in front logical NOT
4813 * - in front unary minus
4814 * + in front unary plus (ignored)
4815 * trailing [] subscript in String or List
4816 * trailing .name entry in Dictionary
4818 * "arg" must point to the first non-white of the expression.
4819 * "arg" is advanced to the next non-white after the recognized expression.
4821 * Return OK or FAIL.
4823 static int
4824 eval7(arg, rettv, evaluate, want_string)
4825 char_u **arg;
4826 typval_T *rettv;
4827 int evaluate;
4828 int want_string; /* after "." operator */
4830 long n;
4831 int len;
4832 char_u *s;
4833 char_u *start_leader, *end_leader;
4834 int ret = OK;
4835 char_u *alias;
4838 * Initialise variable so that clear_tv() can't mistake this for a
4839 * string and free a string that isn't there.
4841 rettv->v_type = VAR_UNKNOWN;
4844 * Skip '!' and '-' characters. They are handled later.
4846 start_leader = *arg;
4847 while (**arg == '!' || **arg == '-' || **arg == '+')
4848 *arg = skipwhite(*arg + 1);
4849 end_leader = *arg;
4851 switch (**arg)
4854 * Number constant.
4856 case '0':
4857 case '1':
4858 case '2':
4859 case '3':
4860 case '4':
4861 case '5':
4862 case '6':
4863 case '7':
4864 case '8':
4865 case '9':
4867 #ifdef FEAT_FLOAT
4868 char_u *p = skipdigits(*arg + 1);
4869 int get_float = FALSE;
4871 /* We accept a float when the format matches
4872 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4873 * strict to avoid backwards compatibility problems.
4874 * Don't look for a float after the "." operator, so that
4875 * ":let vers = 1.2.3" doesn't fail. */
4876 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4878 get_float = TRUE;
4879 p = skipdigits(p + 2);
4880 if (*p == 'e' || *p == 'E')
4882 ++p;
4883 if (*p == '-' || *p == '+')
4884 ++p;
4885 if (!vim_isdigit(*p))
4886 get_float = FALSE;
4887 else
4888 p = skipdigits(p + 1);
4890 if (ASCII_ISALPHA(*p) || *p == '.')
4891 get_float = FALSE;
4893 if (get_float)
4895 float_T f;
4897 *arg += string2float(*arg, &f);
4898 if (evaluate)
4900 rettv->v_type = VAR_FLOAT;
4901 rettv->vval.v_float = f;
4904 else
4905 #endif
4907 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4908 *arg += len;
4909 if (evaluate)
4911 rettv->v_type = VAR_NUMBER;
4912 rettv->vval.v_number = n;
4915 break;
4919 * String constant: "string".
4921 case '"': ret = get_string_tv(arg, rettv, evaluate);
4922 break;
4925 * Literal string constant: 'str''ing'.
4927 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4928 break;
4931 * List: [expr, expr]
4933 case '[': ret = get_list_tv(arg, rettv, evaluate);
4934 break;
4937 * Dictionary: {key: val, key: val}
4939 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4940 break;
4943 * Option value: &name
4945 case '&': ret = get_option_tv(arg, rettv, evaluate);
4946 break;
4949 * Environment variable: $VAR.
4951 case '$': ret = get_env_tv(arg, rettv, evaluate);
4952 break;
4955 * Register contents: @r.
4957 case '@': ++*arg;
4958 if (evaluate)
4960 rettv->v_type = VAR_STRING;
4961 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4963 if (**arg != NUL)
4964 ++*arg;
4965 break;
4968 * nested expression: (expression).
4970 case '(': *arg = skipwhite(*arg + 1);
4971 ret = eval1(arg, rettv, evaluate); /* recursive! */
4972 if (**arg == ')')
4973 ++*arg;
4974 else if (ret == OK)
4976 EMSG(_("E110: Missing ')'"));
4977 clear_tv(rettv);
4978 ret = FAIL;
4980 break;
4982 default: ret = NOTDONE;
4983 break;
4986 if (ret == NOTDONE)
4989 * Must be a variable or function name.
4990 * Can also be a curly-braces kind of name: {expr}.
4992 s = *arg;
4993 len = get_name_len(arg, &alias, evaluate, TRUE);
4994 if (alias != NULL)
4995 s = alias;
4997 if (len <= 0)
4998 ret = FAIL;
4999 else
5001 if (**arg == '(') /* recursive! */
5003 /* If "s" is the name of a variable of type VAR_FUNC
5004 * use its contents. */
5005 s = deref_func_name(s, &len);
5007 /* Invoke the function. */
5008 ret = get_func_tv(s, len, rettv, arg,
5009 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5010 &len, evaluate, NULL);
5011 /* Stop the expression evaluation when immediately
5012 * aborting on error, or when an interrupt occurred or
5013 * an exception was thrown but not caught. */
5014 if (aborting())
5016 if (ret == OK)
5017 clear_tv(rettv);
5018 ret = FAIL;
5021 else if (evaluate)
5022 ret = get_var_tv(s, len, rettv, TRUE);
5023 else
5024 ret = OK;
5027 if (alias != NULL)
5028 vim_free(alias);
5031 *arg = skipwhite(*arg);
5033 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5034 * expr(expr). */
5035 if (ret == OK)
5036 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5039 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5041 if (ret == OK && evaluate && end_leader > start_leader)
5043 int error = FALSE;
5044 int val = 0;
5045 #ifdef FEAT_FLOAT
5046 float_T f = 0.0;
5048 if (rettv->v_type == VAR_FLOAT)
5049 f = rettv->vval.v_float;
5050 else
5051 #endif
5052 val = get_tv_number_chk(rettv, &error);
5053 if (error)
5055 clear_tv(rettv);
5056 ret = FAIL;
5058 else
5060 while (end_leader > start_leader)
5062 --end_leader;
5063 if (*end_leader == '!')
5065 #ifdef FEAT_FLOAT
5066 if (rettv->v_type == VAR_FLOAT)
5067 f = !f;
5068 else
5069 #endif
5070 val = !val;
5072 else if (*end_leader == '-')
5074 #ifdef FEAT_FLOAT
5075 if (rettv->v_type == VAR_FLOAT)
5076 f = -f;
5077 else
5078 #endif
5079 val = -val;
5082 #ifdef FEAT_FLOAT
5083 if (rettv->v_type == VAR_FLOAT)
5085 clear_tv(rettv);
5086 rettv->vval.v_float = f;
5088 else
5089 #endif
5091 clear_tv(rettv);
5092 rettv->v_type = VAR_NUMBER;
5093 rettv->vval.v_number = val;
5098 return ret;
5102 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5103 * "*arg" points to the '[' or '.'.
5104 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5106 static int
5107 eval_index(arg, rettv, evaluate, verbose)
5108 char_u **arg;
5109 typval_T *rettv;
5110 int evaluate;
5111 int verbose; /* give error messages */
5113 int empty1 = FALSE, empty2 = FALSE;
5114 typval_T var1, var2;
5115 long n1, n2 = 0;
5116 long len = -1;
5117 int range = FALSE;
5118 char_u *s;
5119 char_u *key = NULL;
5121 if (rettv->v_type == VAR_FUNC
5122 #ifdef FEAT_FLOAT
5123 || rettv->v_type == VAR_FLOAT
5124 #endif
5127 if (verbose)
5128 EMSG(_("E695: Cannot index a Funcref"));
5129 return FAIL;
5132 if (**arg == '.')
5135 * dict.name
5137 key = *arg + 1;
5138 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5140 if (len == 0)
5141 return FAIL;
5142 *arg = skipwhite(key + len);
5144 else
5147 * something[idx]
5149 * Get the (first) variable from inside the [].
5151 *arg = skipwhite(*arg + 1);
5152 if (**arg == ':')
5153 empty1 = TRUE;
5154 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5155 return FAIL;
5156 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5158 /* not a number or string */
5159 clear_tv(&var1);
5160 return FAIL;
5164 * Get the second variable from inside the [:].
5166 if (**arg == ':')
5168 range = TRUE;
5169 *arg = skipwhite(*arg + 1);
5170 if (**arg == ']')
5171 empty2 = TRUE;
5172 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5174 if (!empty1)
5175 clear_tv(&var1);
5176 return FAIL;
5178 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5180 /* not a number or string */
5181 if (!empty1)
5182 clear_tv(&var1);
5183 clear_tv(&var2);
5184 return FAIL;
5188 /* Check for the ']'. */
5189 if (**arg != ']')
5191 if (verbose)
5192 EMSG(_(e_missbrac));
5193 clear_tv(&var1);
5194 if (range)
5195 clear_tv(&var2);
5196 return FAIL;
5198 *arg = skipwhite(*arg + 1); /* skip the ']' */
5201 if (evaluate)
5203 n1 = 0;
5204 if (!empty1 && rettv->v_type != VAR_DICT)
5206 n1 = get_tv_number(&var1);
5207 clear_tv(&var1);
5209 if (range)
5211 if (empty2)
5212 n2 = -1;
5213 else
5215 n2 = get_tv_number(&var2);
5216 clear_tv(&var2);
5220 switch (rettv->v_type)
5222 case VAR_NUMBER:
5223 case VAR_STRING:
5224 s = get_tv_string(rettv);
5225 len = (long)STRLEN(s);
5226 if (range)
5228 /* The resulting variable is a substring. If the indexes
5229 * are out of range the result is empty. */
5230 if (n1 < 0)
5232 n1 = len + n1;
5233 if (n1 < 0)
5234 n1 = 0;
5236 if (n2 < 0)
5237 n2 = len + n2;
5238 else if (n2 >= len)
5239 n2 = len;
5240 if (n1 >= len || n2 < 0 || n1 > n2)
5241 s = NULL;
5242 else
5243 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5245 else
5247 /* The resulting variable is a string of a single
5248 * character. If the index is too big or negative the
5249 * result is empty. */
5250 if (n1 >= len || n1 < 0)
5251 s = NULL;
5252 else
5253 s = vim_strnsave(s + n1, 1);
5255 clear_tv(rettv);
5256 rettv->v_type = VAR_STRING;
5257 rettv->vval.v_string = s;
5258 break;
5260 case VAR_LIST:
5261 len = list_len(rettv->vval.v_list);
5262 if (n1 < 0)
5263 n1 = len + n1;
5264 if (!empty1 && (n1 < 0 || n1 >= len))
5266 /* For a range we allow invalid values and return an empty
5267 * list. A list index out of range is an error. */
5268 if (!range)
5270 if (verbose)
5271 EMSGN(_(e_listidx), n1);
5272 return FAIL;
5274 n1 = len;
5276 if (range)
5278 list_T *l;
5279 listitem_T *item;
5281 if (n2 < 0)
5282 n2 = len + n2;
5283 else if (n2 >= len)
5284 n2 = len - 1;
5285 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5286 n2 = -1;
5287 l = list_alloc();
5288 if (l == NULL)
5289 return FAIL;
5290 for (item = list_find(rettv->vval.v_list, n1);
5291 n1 <= n2; ++n1)
5293 if (list_append_tv(l, &item->li_tv) == FAIL)
5295 list_free(l, TRUE);
5296 return FAIL;
5298 item = item->li_next;
5300 clear_tv(rettv);
5301 rettv->v_type = VAR_LIST;
5302 rettv->vval.v_list = l;
5303 ++l->lv_refcount;
5305 else
5307 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5308 clear_tv(rettv);
5309 *rettv = var1;
5311 break;
5313 case VAR_DICT:
5314 if (range)
5316 if (verbose)
5317 EMSG(_(e_dictrange));
5318 if (len == -1)
5319 clear_tv(&var1);
5320 return FAIL;
5323 dictitem_T *item;
5325 if (len == -1)
5327 key = get_tv_string(&var1);
5328 if (*key == NUL)
5330 if (verbose)
5331 EMSG(_(e_emptykey));
5332 clear_tv(&var1);
5333 return FAIL;
5337 item = dict_find(rettv->vval.v_dict, key, (int)len);
5339 if (item == NULL && verbose)
5340 EMSG2(_(e_dictkey), key);
5341 if (len == -1)
5342 clear_tv(&var1);
5343 if (item == NULL)
5344 return FAIL;
5346 copy_tv(&item->di_tv, &var1);
5347 clear_tv(rettv);
5348 *rettv = var1;
5350 break;
5354 return OK;
5358 * Get an option value.
5359 * "arg" points to the '&' or '+' before the option name.
5360 * "arg" is advanced to character after the option name.
5361 * Return OK or FAIL.
5363 static int
5364 get_option_tv(arg, rettv, evaluate)
5365 char_u **arg;
5366 typval_T *rettv; /* when NULL, only check if option exists */
5367 int evaluate;
5369 char_u *option_end;
5370 long numval;
5371 char_u *stringval;
5372 int opt_type;
5373 int c;
5374 int working = (**arg == '+'); /* has("+option") */
5375 int ret = OK;
5376 int opt_flags;
5379 * Isolate the option name and find its value.
5381 option_end = find_option_end(arg, &opt_flags);
5382 if (option_end == NULL)
5384 if (rettv != NULL)
5385 EMSG2(_("E112: Option name missing: %s"), *arg);
5386 return FAIL;
5389 if (!evaluate)
5391 *arg = option_end;
5392 return OK;
5395 c = *option_end;
5396 *option_end = NUL;
5397 opt_type = get_option_value(*arg, &numval,
5398 rettv == NULL ? NULL : &stringval, opt_flags);
5400 if (opt_type == -3) /* invalid name */
5402 if (rettv != NULL)
5403 EMSG2(_("E113: Unknown option: %s"), *arg);
5404 ret = FAIL;
5406 else if (rettv != NULL)
5408 if (opt_type == -2) /* hidden string option */
5410 rettv->v_type = VAR_STRING;
5411 rettv->vval.v_string = NULL;
5413 else if (opt_type == -1) /* hidden number option */
5415 rettv->v_type = VAR_NUMBER;
5416 rettv->vval.v_number = 0;
5418 else if (opt_type == 1) /* number option */
5420 rettv->v_type = VAR_NUMBER;
5421 rettv->vval.v_number = numval;
5423 else /* string option */
5425 rettv->v_type = VAR_STRING;
5426 rettv->vval.v_string = stringval;
5429 else if (working && (opt_type == -2 || opt_type == -1))
5430 ret = FAIL;
5432 *option_end = c; /* put back for error messages */
5433 *arg = option_end;
5435 return ret;
5439 * Allocate a variable for a string constant.
5440 * Return OK or FAIL.
5442 static int
5443 get_string_tv(arg, rettv, evaluate)
5444 char_u **arg;
5445 typval_T *rettv;
5446 int evaluate;
5448 char_u *p;
5449 char_u *name;
5450 int extra = 0;
5453 * Find the end of the string, skipping backslashed characters.
5455 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5457 if (*p == '\\' && p[1] != NUL)
5459 ++p;
5460 /* A "\<x>" form occupies at least 4 characters, and produces up
5461 * to 6 characters: reserve space for 2 extra */
5462 if (*p == '<')
5463 extra += 2;
5467 if (*p != '"')
5469 EMSG2(_("E114: Missing quote: %s"), *arg);
5470 return FAIL;
5473 /* If only parsing, set *arg and return here */
5474 if (!evaluate)
5476 *arg = p + 1;
5477 return OK;
5481 * Copy the string into allocated memory, handling backslashed
5482 * characters.
5484 name = alloc((unsigned)(p - *arg + extra));
5485 if (name == NULL)
5486 return FAIL;
5487 rettv->v_type = VAR_STRING;
5488 rettv->vval.v_string = name;
5490 for (p = *arg + 1; *p != NUL && *p != '"'; )
5492 if (*p == '\\')
5494 switch (*++p)
5496 case 'b': *name++ = BS; ++p; break;
5497 case 'e': *name++ = ESC; ++p; break;
5498 case 'f': *name++ = FF; ++p; break;
5499 case 'n': *name++ = NL; ++p; break;
5500 case 'r': *name++ = CAR; ++p; break;
5501 case 't': *name++ = TAB; ++p; break;
5503 case 'X': /* hex: "\x1", "\x12" */
5504 case 'x':
5505 case 'u': /* Unicode: "\u0023" */
5506 case 'U':
5507 if (vim_isxdigit(p[1]))
5509 int n, nr;
5510 int c = toupper(*p);
5512 if (c == 'X')
5513 n = 2;
5514 else
5515 n = 4;
5516 nr = 0;
5517 while (--n >= 0 && vim_isxdigit(p[1]))
5519 ++p;
5520 nr = (nr << 4) + hex2nr(*p);
5522 ++p;
5523 #ifdef FEAT_MBYTE
5524 /* For "\u" store the number according to
5525 * 'encoding'. */
5526 if (c != 'X')
5527 name += (*mb_char2bytes)(nr, name);
5528 else
5529 #endif
5530 *name++ = nr;
5532 break;
5534 /* octal: "\1", "\12", "\123" */
5535 case '0':
5536 case '1':
5537 case '2':
5538 case '3':
5539 case '4':
5540 case '5':
5541 case '6':
5542 case '7': *name = *p++ - '0';
5543 if (*p >= '0' && *p <= '7')
5545 *name = (*name << 3) + *p++ - '0';
5546 if (*p >= '0' && *p <= '7')
5547 *name = (*name << 3) + *p++ - '0';
5549 ++name;
5550 break;
5552 /* Special key, e.g.: "\<C-W>" */
5553 case '<': extra = trans_special(&p, name, TRUE);
5554 if (extra != 0)
5556 name += extra;
5557 break;
5559 /* FALLTHROUGH */
5561 default: MB_COPY_CHAR(p, name);
5562 break;
5565 else
5566 MB_COPY_CHAR(p, name);
5569 *name = NUL;
5570 *arg = p + 1;
5572 return OK;
5576 * Allocate a variable for a 'str''ing' constant.
5577 * Return OK or FAIL.
5579 static int
5580 get_lit_string_tv(arg, rettv, evaluate)
5581 char_u **arg;
5582 typval_T *rettv;
5583 int evaluate;
5585 char_u *p;
5586 char_u *str;
5587 int reduce = 0;
5590 * Find the end of the string, skipping ''.
5592 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5594 if (*p == '\'')
5596 if (p[1] != '\'')
5597 break;
5598 ++reduce;
5599 ++p;
5603 if (*p != '\'')
5605 EMSG2(_("E115: Missing quote: %s"), *arg);
5606 return FAIL;
5609 /* If only parsing return after setting "*arg" */
5610 if (!evaluate)
5612 *arg = p + 1;
5613 return OK;
5617 * Copy the string into allocated memory, handling '' to ' reduction.
5619 str = alloc((unsigned)((p - *arg) - reduce));
5620 if (str == NULL)
5621 return FAIL;
5622 rettv->v_type = VAR_STRING;
5623 rettv->vval.v_string = str;
5625 for (p = *arg + 1; *p != NUL; )
5627 if (*p == '\'')
5629 if (p[1] != '\'')
5630 break;
5631 ++p;
5633 MB_COPY_CHAR(p, str);
5635 *str = NUL;
5636 *arg = p + 1;
5638 return OK;
5642 * Allocate a variable for a List and fill it from "*arg".
5643 * Return OK or FAIL.
5645 static int
5646 get_list_tv(arg, rettv, evaluate)
5647 char_u **arg;
5648 typval_T *rettv;
5649 int evaluate;
5651 list_T *l = NULL;
5652 typval_T tv;
5653 listitem_T *item;
5655 if (evaluate)
5657 l = list_alloc();
5658 if (l == NULL)
5659 return FAIL;
5662 *arg = skipwhite(*arg + 1);
5663 while (**arg != ']' && **arg != NUL)
5665 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5666 goto failret;
5667 if (evaluate)
5669 item = listitem_alloc();
5670 if (item != NULL)
5672 item->li_tv = tv;
5673 item->li_tv.v_lock = 0;
5674 list_append(l, item);
5676 else
5677 clear_tv(&tv);
5680 if (**arg == ']')
5681 break;
5682 if (**arg != ',')
5684 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5685 goto failret;
5687 *arg = skipwhite(*arg + 1);
5690 if (**arg != ']')
5692 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5693 failret:
5694 if (evaluate)
5695 list_free(l, TRUE);
5696 return FAIL;
5699 *arg = skipwhite(*arg + 1);
5700 if (evaluate)
5702 rettv->v_type = VAR_LIST;
5703 rettv->vval.v_list = l;
5704 ++l->lv_refcount;
5707 return OK;
5711 * Allocate an empty header for a list.
5712 * Caller should take care of the reference count.
5714 list_T *
5715 list_alloc()
5717 list_T *l;
5719 l = (list_T *)alloc_clear(sizeof(list_T));
5720 if (l != NULL)
5722 /* Prepend the list to the list of lists for garbage collection. */
5723 if (first_list != NULL)
5724 first_list->lv_used_prev = l;
5725 l->lv_used_prev = NULL;
5726 l->lv_used_next = first_list;
5727 first_list = l;
5729 return l;
5733 * Allocate an empty list for a return value.
5734 * Returns OK or FAIL.
5736 static int
5737 rettv_list_alloc(rettv)
5738 typval_T *rettv;
5740 list_T *l = list_alloc();
5742 if (l == NULL)
5743 return FAIL;
5745 rettv->vval.v_list = l;
5746 rettv->v_type = VAR_LIST;
5747 ++l->lv_refcount;
5748 return OK;
5752 * Unreference a list: decrement the reference count and free it when it
5753 * becomes zero.
5755 void
5756 list_unref(l)
5757 list_T *l;
5759 if (l != NULL && --l->lv_refcount <= 0)
5760 list_free(l, TRUE);
5764 * Free a list, including all items it points to.
5765 * Ignores the reference count.
5767 void
5768 list_free(l, recurse)
5769 list_T *l;
5770 int recurse; /* Free Lists and Dictionaries recursively. */
5772 listitem_T *item;
5774 /* Remove the list from the list of lists for garbage collection. */
5775 if (l->lv_used_prev == NULL)
5776 first_list = l->lv_used_next;
5777 else
5778 l->lv_used_prev->lv_used_next = l->lv_used_next;
5779 if (l->lv_used_next != NULL)
5780 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5782 for (item = l->lv_first; item != NULL; item = l->lv_first)
5784 /* Remove the item before deleting it. */
5785 l->lv_first = item->li_next;
5786 if (recurse || (item->li_tv.v_type != VAR_LIST
5787 && item->li_tv.v_type != VAR_DICT))
5788 clear_tv(&item->li_tv);
5789 vim_free(item);
5791 vim_free(l);
5795 * Allocate a list item.
5797 static listitem_T *
5798 listitem_alloc()
5800 return (listitem_T *)alloc(sizeof(listitem_T));
5804 * Free a list item. Also clears the value. Does not notify watchers.
5806 static void
5807 listitem_free(item)
5808 listitem_T *item;
5810 clear_tv(&item->li_tv);
5811 vim_free(item);
5815 * Remove a list item from a List and free it. Also clears the value.
5817 static void
5818 listitem_remove(l, item)
5819 list_T *l;
5820 listitem_T *item;
5822 list_remove(l, item, item);
5823 listitem_free(item);
5827 * Get the number of items in a list.
5829 static long
5830 list_len(l)
5831 list_T *l;
5833 if (l == NULL)
5834 return 0L;
5835 return l->lv_len;
5839 * Return TRUE when two lists have exactly the same values.
5841 static int
5842 list_equal(l1, l2, ic)
5843 list_T *l1;
5844 list_T *l2;
5845 int ic; /* ignore case for strings */
5847 listitem_T *item1, *item2;
5849 if (l1 == NULL || l2 == NULL)
5850 return FALSE;
5851 if (l1 == l2)
5852 return TRUE;
5853 if (list_len(l1) != list_len(l2))
5854 return FALSE;
5856 for (item1 = l1->lv_first, item2 = l2->lv_first;
5857 item1 != NULL && item2 != NULL;
5858 item1 = item1->li_next, item2 = item2->li_next)
5859 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5860 return FALSE;
5861 return item1 == NULL && item2 == NULL;
5864 #if defined(FEAT_PYTHON) || defined(PROTO) || defined(FEAT_GUI_MACVIM)
5866 * Return the dictitem that an entry in a hashtable points to.
5868 dictitem_T *
5869 dict_lookup(hi)
5870 hashitem_T *hi;
5872 return HI2DI(hi);
5874 #endif
5877 * Return TRUE when two dictionaries have exactly the same key/values.
5879 static int
5880 dict_equal(d1, d2, ic)
5881 dict_T *d1;
5882 dict_T *d2;
5883 int ic; /* ignore case for strings */
5885 hashitem_T *hi;
5886 dictitem_T *item2;
5887 int todo;
5889 if (d1 == NULL || d2 == NULL)
5890 return FALSE;
5891 if (d1 == d2)
5892 return TRUE;
5893 if (dict_len(d1) != dict_len(d2))
5894 return FALSE;
5896 todo = (int)d1->dv_hashtab.ht_used;
5897 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5899 if (!HASHITEM_EMPTY(hi))
5901 item2 = dict_find(d2, hi->hi_key, -1);
5902 if (item2 == NULL)
5903 return FALSE;
5904 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5905 return FALSE;
5906 --todo;
5909 return TRUE;
5913 * Return TRUE if "tv1" and "tv2" have the same value.
5914 * Compares the items just like "==" would compare them, but strings and
5915 * numbers are different. Floats and numbers are also different.
5917 static int
5918 tv_equal(tv1, tv2, ic)
5919 typval_T *tv1;
5920 typval_T *tv2;
5921 int ic; /* ignore case */
5923 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5924 char_u *s1, *s2;
5925 static int recursive = 0; /* cach recursive loops */
5926 int r;
5928 if (tv1->v_type != tv2->v_type)
5929 return FALSE;
5930 /* Catch lists and dicts that have an endless loop by limiting
5931 * recursiveness to 1000. We guess they are equal then. */
5932 if (recursive >= 1000)
5933 return TRUE;
5935 switch (tv1->v_type)
5937 case VAR_LIST:
5938 ++recursive;
5939 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5940 --recursive;
5941 return r;
5943 case VAR_DICT:
5944 ++recursive;
5945 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5946 --recursive;
5947 return r;
5949 case VAR_FUNC:
5950 return (tv1->vval.v_string != NULL
5951 && tv2->vval.v_string != NULL
5952 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5954 case VAR_NUMBER:
5955 return tv1->vval.v_number == tv2->vval.v_number;
5957 #ifdef FEAT_FLOAT
5958 case VAR_FLOAT:
5959 return tv1->vval.v_float == tv2->vval.v_float;
5960 #endif
5962 case VAR_STRING:
5963 s1 = get_tv_string_buf(tv1, buf1);
5964 s2 = get_tv_string_buf(tv2, buf2);
5965 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5968 EMSG2(_(e_intern2), "tv_equal()");
5969 return TRUE;
5973 * Locate item with index "n" in list "l" and return it.
5974 * A negative index is counted from the end; -1 is the last item.
5975 * Returns NULL when "n" is out of range.
5977 static listitem_T *
5978 list_find(l, n)
5979 list_T *l;
5980 long n;
5982 listitem_T *item;
5983 long idx;
5985 if (l == NULL)
5986 return NULL;
5988 /* Negative index is relative to the end. */
5989 if (n < 0)
5990 n = l->lv_len + n;
5992 /* Check for index out of range. */
5993 if (n < 0 || n >= l->lv_len)
5994 return NULL;
5996 /* When there is a cached index may start search from there. */
5997 if (l->lv_idx_item != NULL)
5999 if (n < l->lv_idx / 2)
6001 /* closest to the start of the list */
6002 item = l->lv_first;
6003 idx = 0;
6005 else if (n > (l->lv_idx + l->lv_len) / 2)
6007 /* closest to the end of the list */
6008 item = l->lv_last;
6009 idx = l->lv_len - 1;
6011 else
6013 /* closest to the cached index */
6014 item = l->lv_idx_item;
6015 idx = l->lv_idx;
6018 else
6020 if (n < l->lv_len / 2)
6022 /* closest to the start of the list */
6023 item = l->lv_first;
6024 idx = 0;
6026 else
6028 /* closest to the end of the list */
6029 item = l->lv_last;
6030 idx = l->lv_len - 1;
6034 while (n > idx)
6036 /* search forward */
6037 item = item->li_next;
6038 ++idx;
6040 while (n < idx)
6042 /* search backward */
6043 item = item->li_prev;
6044 --idx;
6047 /* cache the used index */
6048 l->lv_idx = idx;
6049 l->lv_idx_item = item;
6051 return item;
6055 * Get list item "l[idx]" as a number.
6057 static long
6058 list_find_nr(l, idx, errorp)
6059 list_T *l;
6060 long idx;
6061 int *errorp; /* set to TRUE when something wrong */
6063 listitem_T *li;
6065 li = list_find(l, idx);
6066 if (li == NULL)
6068 if (errorp != NULL)
6069 *errorp = TRUE;
6070 return -1L;
6072 return get_tv_number_chk(&li->li_tv, errorp);
6076 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6078 char_u *
6079 list_find_str(l, idx)
6080 list_T *l;
6081 long idx;
6083 listitem_T *li;
6085 li = list_find(l, idx - 1);
6086 if (li == NULL)
6088 EMSGN(_(e_listidx), idx);
6089 return NULL;
6091 return get_tv_string(&li->li_tv);
6095 * Locate "item" list "l" and return its index.
6096 * Returns -1 when "item" is not in the list.
6098 static long
6099 list_idx_of_item(l, item)
6100 list_T *l;
6101 listitem_T *item;
6103 long idx = 0;
6104 listitem_T *li;
6106 if (l == NULL)
6107 return -1;
6108 idx = 0;
6109 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6110 ++idx;
6111 if (li == NULL)
6112 return -1;
6113 return idx;
6117 * Append item "item" to the end of list "l".
6119 static void
6120 list_append(l, item)
6121 list_T *l;
6122 listitem_T *item;
6124 if (l->lv_last == NULL)
6126 /* empty list */
6127 l->lv_first = item;
6128 l->lv_last = item;
6129 item->li_prev = NULL;
6131 else
6133 l->lv_last->li_next = item;
6134 item->li_prev = l->lv_last;
6135 l->lv_last = item;
6137 ++l->lv_len;
6138 item->li_next = NULL;
6142 * Append typval_T "tv" to the end of list "l".
6143 * Return FAIL when out of memory.
6145 static int
6146 list_append_tv(l, tv)
6147 list_T *l;
6148 typval_T *tv;
6150 listitem_T *li = listitem_alloc();
6152 if (li == NULL)
6153 return FAIL;
6154 copy_tv(tv, &li->li_tv);
6155 list_append(l, li);
6156 return OK;
6160 * Add a dictionary to a list. Used by getqflist().
6161 * Return FAIL when out of memory.
6164 list_append_dict(list, dict)
6165 list_T *list;
6166 dict_T *dict;
6168 listitem_T *li = listitem_alloc();
6170 if (li == NULL)
6171 return FAIL;
6172 li->li_tv.v_type = VAR_DICT;
6173 li->li_tv.v_lock = 0;
6174 li->li_tv.vval.v_dict = dict;
6175 list_append(list, li);
6176 ++dict->dv_refcount;
6177 return OK;
6181 * Make a copy of "str" and append it as an item to list "l".
6182 * When "len" >= 0 use "str[len]".
6183 * Returns FAIL when out of memory.
6186 list_append_string(l, str, len)
6187 list_T *l;
6188 char_u *str;
6189 int len;
6191 listitem_T *li = listitem_alloc();
6193 if (li == NULL)
6194 return FAIL;
6195 list_append(l, li);
6196 li->li_tv.v_type = VAR_STRING;
6197 li->li_tv.v_lock = 0;
6198 if (str == NULL)
6199 li->li_tv.vval.v_string = NULL;
6200 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6201 : vim_strsave(str))) == NULL)
6202 return FAIL;
6203 return OK;
6207 * Append "n" to list "l".
6208 * Returns FAIL when out of memory.
6210 static int
6211 list_append_number(l, n)
6212 list_T *l;
6213 varnumber_T n;
6215 listitem_T *li;
6217 li = listitem_alloc();
6218 if (li == NULL)
6219 return FAIL;
6220 li->li_tv.v_type = VAR_NUMBER;
6221 li->li_tv.v_lock = 0;
6222 li->li_tv.vval.v_number = n;
6223 list_append(l, li);
6224 return OK;
6228 * Insert typval_T "tv" in list "l" before "item".
6229 * If "item" is NULL append at the end.
6230 * Return FAIL when out of memory.
6232 static int
6233 list_insert_tv(l, tv, item)
6234 list_T *l;
6235 typval_T *tv;
6236 listitem_T *item;
6238 listitem_T *ni = listitem_alloc();
6240 if (ni == NULL)
6241 return FAIL;
6242 copy_tv(tv, &ni->li_tv);
6243 if (item == NULL)
6244 /* Append new item at end of list. */
6245 list_append(l, ni);
6246 else
6248 /* Insert new item before existing item. */
6249 ni->li_prev = item->li_prev;
6250 ni->li_next = item;
6251 if (item->li_prev == NULL)
6253 l->lv_first = ni;
6254 ++l->lv_idx;
6256 else
6258 item->li_prev->li_next = ni;
6259 l->lv_idx_item = NULL;
6261 item->li_prev = ni;
6262 ++l->lv_len;
6264 return OK;
6268 * Extend "l1" with "l2".
6269 * If "bef" is NULL append at the end, otherwise insert before this item.
6270 * Returns FAIL when out of memory.
6272 static int
6273 list_extend(l1, l2, bef)
6274 list_T *l1;
6275 list_T *l2;
6276 listitem_T *bef;
6278 listitem_T *item;
6279 int todo = l2->lv_len;
6281 /* We also quit the loop when we have inserted the original item count of
6282 * the list, avoid a hang when we extend a list with itself. */
6283 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6284 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6285 return FAIL;
6286 return OK;
6290 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6291 * Return FAIL when out of memory.
6293 static int
6294 list_concat(l1, l2, tv)
6295 list_T *l1;
6296 list_T *l2;
6297 typval_T *tv;
6299 list_T *l;
6301 if (l1 == NULL || l2 == NULL)
6302 return FAIL;
6304 /* make a copy of the first list. */
6305 l = list_copy(l1, FALSE, 0);
6306 if (l == NULL)
6307 return FAIL;
6308 tv->v_type = VAR_LIST;
6309 tv->vval.v_list = l;
6311 /* append all items from the second list */
6312 return list_extend(l, l2, NULL);
6316 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6317 * The refcount of the new list is set to 1.
6318 * See item_copy() for "copyID".
6319 * Returns NULL when out of memory.
6321 static list_T *
6322 list_copy(orig, deep, copyID)
6323 list_T *orig;
6324 int deep;
6325 int copyID;
6327 list_T *copy;
6328 listitem_T *item;
6329 listitem_T *ni;
6331 if (orig == NULL)
6332 return NULL;
6334 copy = list_alloc();
6335 if (copy != NULL)
6337 if (copyID != 0)
6339 /* Do this before adding the items, because one of the items may
6340 * refer back to this list. */
6341 orig->lv_copyID = copyID;
6342 orig->lv_copylist = copy;
6344 for (item = orig->lv_first; item != NULL && !got_int;
6345 item = item->li_next)
6347 ni = listitem_alloc();
6348 if (ni == NULL)
6349 break;
6350 if (deep)
6352 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6354 vim_free(ni);
6355 break;
6358 else
6359 copy_tv(&item->li_tv, &ni->li_tv);
6360 list_append(copy, ni);
6362 ++copy->lv_refcount;
6363 if (item != NULL)
6365 list_unref(copy);
6366 copy = NULL;
6370 return copy;
6374 * Remove items "item" to "item2" from list "l".
6375 * Does not free the listitem or the value!
6377 static void
6378 list_remove(l, item, item2)
6379 list_T *l;
6380 listitem_T *item;
6381 listitem_T *item2;
6383 listitem_T *ip;
6385 /* notify watchers */
6386 for (ip = item; ip != NULL; ip = ip->li_next)
6388 --l->lv_len;
6389 list_fix_watch(l, ip);
6390 if (ip == item2)
6391 break;
6394 if (item2->li_next == NULL)
6395 l->lv_last = item->li_prev;
6396 else
6397 item2->li_next->li_prev = item->li_prev;
6398 if (item->li_prev == NULL)
6399 l->lv_first = item2->li_next;
6400 else
6401 item->li_prev->li_next = item2->li_next;
6402 l->lv_idx_item = NULL;
6406 * Return an allocated string with the string representation of a list.
6407 * May return NULL.
6409 static char_u *
6410 list2string(tv, copyID)
6411 typval_T *tv;
6412 int copyID;
6414 garray_T ga;
6416 if (tv->vval.v_list == NULL)
6417 return NULL;
6418 ga_init2(&ga, (int)sizeof(char), 80);
6419 ga_append(&ga, '[');
6420 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6422 vim_free(ga.ga_data);
6423 return NULL;
6425 ga_append(&ga, ']');
6426 ga_append(&ga, NUL);
6427 return (char_u *)ga.ga_data;
6431 * Join list "l" into a string in "*gap", using separator "sep".
6432 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6433 * Return FAIL or OK.
6435 static int
6436 list_join(gap, l, sep, echo, copyID)
6437 garray_T *gap;
6438 list_T *l;
6439 char_u *sep;
6440 int echo;
6441 int copyID;
6443 int first = TRUE;
6444 char_u *tofree;
6445 char_u numbuf[NUMBUFLEN];
6446 listitem_T *item;
6447 char_u *s;
6449 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6451 if (first)
6452 first = FALSE;
6453 else
6454 ga_concat(gap, sep);
6456 if (echo)
6457 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6458 else
6459 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6460 if (s != NULL)
6461 ga_concat(gap, s);
6462 vim_free(tofree);
6463 if (s == NULL)
6464 return FAIL;
6466 return OK;
6470 * Garbage collection for lists and dictionaries.
6472 * We use reference counts to be able to free most items right away when they
6473 * are no longer used. But for composite items it's possible that it becomes
6474 * unused while the reference count is > 0: When there is a recursive
6475 * reference. Example:
6476 * :let l = [1, 2, 3]
6477 * :let d = {9: l}
6478 * :let l[1] = d
6480 * Since this is quite unusual we handle this with garbage collection: every
6481 * once in a while find out which lists and dicts are not referenced from any
6482 * variable.
6484 * Here is a good reference text about garbage collection (refers to Python
6485 * but it applies to all reference-counting mechanisms):
6486 * http://python.ca/nas/python/gc/
6490 * Do garbage collection for lists and dicts.
6491 * Return TRUE if some memory was freed.
6494 garbage_collect()
6496 dict_T *dd;
6497 list_T *ll;
6498 int copyID = ++current_copyID;
6499 buf_T *buf;
6500 win_T *wp;
6501 int i;
6502 funccall_T *fc, **pfc;
6503 int did_free = FALSE;
6504 #ifdef FEAT_WINDOWS
6505 tabpage_T *tp;
6506 #endif
6508 /* Only do this once. */
6509 want_garbage_collect = FALSE;
6510 may_garbage_collect = FALSE;
6511 garbage_collect_at_exit = FALSE;
6514 * 1. Go through all accessible variables and mark all lists and dicts
6515 * with copyID.
6517 /* script-local variables */
6518 for (i = 1; i <= ga_scripts.ga_len; ++i)
6519 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6521 /* buffer-local variables */
6522 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6523 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6525 /* window-local variables */
6526 FOR_ALL_TAB_WINDOWS(tp, wp)
6527 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6529 #ifdef FEAT_WINDOWS
6530 /* tabpage-local variables */
6531 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6532 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6533 #endif
6535 /* global variables */
6536 set_ref_in_ht(&globvarht, copyID);
6538 /* function-local variables */
6539 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6541 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6542 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6545 /* v: vars */
6546 set_ref_in_ht(&vimvarht, copyID);
6549 * 2. Go through the list of dicts and free items without the copyID.
6551 for (dd = first_dict; dd != NULL; )
6552 if (dd->dv_copyID != copyID)
6554 /* Free the Dictionary and ordinary items it contains, but don't
6555 * recurse into Lists and Dictionaries, they will be in the list
6556 * of dicts or list of lists. */
6557 dict_free(dd, FALSE);
6558 did_free = TRUE;
6560 /* restart, next dict may also have been freed */
6561 dd = first_dict;
6563 else
6564 dd = dd->dv_used_next;
6567 * 3. Go through the list of lists and free items without the copyID.
6568 * But don't free a list that has a watcher (used in a for loop), these
6569 * are not referenced anywhere.
6571 for (ll = first_list; ll != NULL; )
6572 if (ll->lv_copyID != copyID && ll->lv_watch == NULL)
6574 /* Free the List and ordinary items it contains, but don't recurse
6575 * into Lists and Dictionaries, they will be in the list of dicts
6576 * or list of lists. */
6577 list_free(ll, FALSE);
6578 did_free = TRUE;
6580 /* restart, next list may also have been freed */
6581 ll = first_list;
6583 else
6584 ll = ll->lv_used_next;
6586 /* check if any funccal can be freed now */
6587 for (pfc = &previous_funccal; *pfc != NULL; )
6589 if (can_free_funccal(*pfc, copyID))
6591 fc = *pfc;
6592 *pfc = fc->caller;
6593 free_funccal(fc, TRUE);
6594 did_free = TRUE;
6596 else
6597 pfc = &(*pfc)->caller;
6600 return did_free;
6604 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6606 static void
6607 set_ref_in_ht(ht, copyID)
6608 hashtab_T *ht;
6609 int copyID;
6611 int todo;
6612 hashitem_T *hi;
6614 todo = (int)ht->ht_used;
6615 for (hi = ht->ht_array; todo > 0; ++hi)
6616 if (!HASHITEM_EMPTY(hi))
6618 --todo;
6619 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6624 * Mark all lists and dicts referenced through list "l" with "copyID".
6626 static void
6627 set_ref_in_list(l, copyID)
6628 list_T *l;
6629 int copyID;
6631 listitem_T *li;
6633 for (li = l->lv_first; li != NULL; li = li->li_next)
6634 set_ref_in_item(&li->li_tv, copyID);
6638 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6640 static void
6641 set_ref_in_item(tv, copyID)
6642 typval_T *tv;
6643 int copyID;
6645 dict_T *dd;
6646 list_T *ll;
6648 switch (tv->v_type)
6650 case VAR_DICT:
6651 dd = tv->vval.v_dict;
6652 if (dd != NULL && dd->dv_copyID != copyID)
6654 /* Didn't see this dict yet. */
6655 dd->dv_copyID = copyID;
6656 set_ref_in_ht(&dd->dv_hashtab, copyID);
6658 break;
6660 case VAR_LIST:
6661 ll = tv->vval.v_list;
6662 if (ll != NULL && ll->lv_copyID != copyID)
6664 /* Didn't see this list yet. */
6665 ll->lv_copyID = copyID;
6666 set_ref_in_list(ll, copyID);
6668 break;
6670 return;
6674 * Allocate an empty header for a dictionary.
6676 dict_T *
6677 dict_alloc()
6679 dict_T *d;
6681 d = (dict_T *)alloc(sizeof(dict_T));
6682 if (d != NULL)
6684 /* Add the list to the list of dicts for garbage collection. */
6685 if (first_dict != NULL)
6686 first_dict->dv_used_prev = d;
6687 d->dv_used_next = first_dict;
6688 d->dv_used_prev = NULL;
6689 first_dict = d;
6691 hash_init(&d->dv_hashtab);
6692 d->dv_lock = 0;
6693 d->dv_refcount = 0;
6694 d->dv_copyID = 0;
6696 return d;
6700 * Unreference a Dictionary: decrement the reference count and free it when it
6701 * becomes zero.
6703 static void
6704 dict_unref(d)
6705 dict_T *d;
6707 if (d != NULL && --d->dv_refcount <= 0)
6708 dict_free(d, TRUE);
6712 * Free a Dictionary, including all items it contains.
6713 * Ignores the reference count.
6715 static void
6716 dict_free(d, recurse)
6717 dict_T *d;
6718 int recurse; /* Free Lists and Dictionaries recursively. */
6720 int todo;
6721 hashitem_T *hi;
6722 dictitem_T *di;
6724 /* Remove the dict from the list of dicts for garbage collection. */
6725 if (d->dv_used_prev == NULL)
6726 first_dict = d->dv_used_next;
6727 else
6728 d->dv_used_prev->dv_used_next = d->dv_used_next;
6729 if (d->dv_used_next != NULL)
6730 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6732 /* Lock the hashtab, we don't want it to resize while freeing items. */
6733 hash_lock(&d->dv_hashtab);
6734 todo = (int)d->dv_hashtab.ht_used;
6735 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6737 if (!HASHITEM_EMPTY(hi))
6739 /* Remove the item before deleting it, just in case there is
6740 * something recursive causing trouble. */
6741 di = HI2DI(hi);
6742 hash_remove(&d->dv_hashtab, hi);
6743 if (recurse || (di->di_tv.v_type != VAR_LIST
6744 && di->di_tv.v_type != VAR_DICT))
6745 clear_tv(&di->di_tv);
6746 vim_free(di);
6747 --todo;
6750 hash_clear(&d->dv_hashtab);
6751 vim_free(d);
6755 * Allocate a Dictionary item.
6756 * The "key" is copied to the new item.
6757 * Note that the value of the item "di_tv" still needs to be initialized!
6758 * Returns NULL when out of memory.
6760 static dictitem_T *
6761 dictitem_alloc(key)
6762 char_u *key;
6764 dictitem_T *di;
6766 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6767 if (di != NULL)
6769 STRCPY(di->di_key, key);
6770 di->di_flags = 0;
6772 return di;
6776 * Make a copy of a Dictionary item.
6778 static dictitem_T *
6779 dictitem_copy(org)
6780 dictitem_T *org;
6782 dictitem_T *di;
6784 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6785 + STRLEN(org->di_key)));
6786 if (di != NULL)
6788 STRCPY(di->di_key, org->di_key);
6789 di->di_flags = 0;
6790 copy_tv(&org->di_tv, &di->di_tv);
6792 return di;
6796 * Remove item "item" from Dictionary "dict" and free it.
6798 static void
6799 dictitem_remove(dict, item)
6800 dict_T *dict;
6801 dictitem_T *item;
6803 hashitem_T *hi;
6805 hi = hash_find(&dict->dv_hashtab, item->di_key);
6806 if (HASHITEM_EMPTY(hi))
6807 EMSG2(_(e_intern2), "dictitem_remove()");
6808 else
6809 hash_remove(&dict->dv_hashtab, hi);
6810 dictitem_free(item);
6814 * Free a dict item. Also clears the value.
6816 static void
6817 dictitem_free(item)
6818 dictitem_T *item;
6820 clear_tv(&item->di_tv);
6821 vim_free(item);
6825 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6826 * The refcount of the new dict is set to 1.
6827 * See item_copy() for "copyID".
6828 * Returns NULL when out of memory.
6830 static dict_T *
6831 dict_copy(orig, deep, copyID)
6832 dict_T *orig;
6833 int deep;
6834 int copyID;
6836 dict_T *copy;
6837 dictitem_T *di;
6838 int todo;
6839 hashitem_T *hi;
6841 if (orig == NULL)
6842 return NULL;
6844 copy = dict_alloc();
6845 if (copy != NULL)
6847 if (copyID != 0)
6849 orig->dv_copyID = copyID;
6850 orig->dv_copydict = copy;
6852 todo = (int)orig->dv_hashtab.ht_used;
6853 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6855 if (!HASHITEM_EMPTY(hi))
6857 --todo;
6859 di = dictitem_alloc(hi->hi_key);
6860 if (di == NULL)
6861 break;
6862 if (deep)
6864 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6865 copyID) == FAIL)
6867 vim_free(di);
6868 break;
6871 else
6872 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6873 if (dict_add(copy, di) == FAIL)
6875 dictitem_free(di);
6876 break;
6881 ++copy->dv_refcount;
6882 if (todo > 0)
6884 dict_unref(copy);
6885 copy = NULL;
6889 return copy;
6893 * Add item "item" to Dictionary "d".
6894 * Returns FAIL when out of memory and when key already existed.
6896 static int
6897 dict_add(d, item)
6898 dict_T *d;
6899 dictitem_T *item;
6901 return hash_add(&d->dv_hashtab, item->di_key);
6905 * Add a number or string entry to dictionary "d".
6906 * When "str" is NULL use number "nr", otherwise use "str".
6907 * Returns FAIL when out of memory and when key already exists.
6910 dict_add_nr_str(d, key, nr, str)
6911 dict_T *d;
6912 char *key;
6913 long nr;
6914 char_u *str;
6916 dictitem_T *item;
6918 item = dictitem_alloc((char_u *)key);
6919 if (item == NULL)
6920 return FAIL;
6921 item->di_tv.v_lock = 0;
6922 if (str == NULL)
6924 item->di_tv.v_type = VAR_NUMBER;
6925 item->di_tv.vval.v_number = nr;
6927 else
6929 item->di_tv.v_type = VAR_STRING;
6930 item->di_tv.vval.v_string = vim_strsave(str);
6932 if (dict_add(d, item) == FAIL)
6934 dictitem_free(item);
6935 return FAIL;
6937 return OK;
6941 * Get the number of items in a Dictionary.
6943 static long
6944 dict_len(d)
6945 dict_T *d;
6947 if (d == NULL)
6948 return 0L;
6949 return (long)d->dv_hashtab.ht_used;
6953 * Find item "key[len]" in Dictionary "d".
6954 * If "len" is negative use strlen(key).
6955 * Returns NULL when not found.
6957 static dictitem_T *
6958 dict_find(d, key, len)
6959 dict_T *d;
6960 char_u *key;
6961 int len;
6963 #define AKEYLEN 200
6964 char_u buf[AKEYLEN];
6965 char_u *akey;
6966 char_u *tofree = NULL;
6967 hashitem_T *hi;
6969 if (len < 0)
6970 akey = key;
6971 else if (len >= AKEYLEN)
6973 tofree = akey = vim_strnsave(key, len);
6974 if (akey == NULL)
6975 return NULL;
6977 else
6979 /* Avoid a malloc/free by using buf[]. */
6980 vim_strncpy(buf, key, len);
6981 akey = buf;
6984 hi = hash_find(&d->dv_hashtab, akey);
6985 vim_free(tofree);
6986 if (HASHITEM_EMPTY(hi))
6987 return NULL;
6988 return HI2DI(hi);
6992 * Get a string item from a dictionary.
6993 * When "save" is TRUE allocate memory for it.
6994 * Returns NULL if the entry doesn't exist or out of memory.
6996 char_u *
6997 get_dict_string(d, key, save)
6998 dict_T *d;
6999 char_u *key;
7000 int save;
7002 dictitem_T *di;
7003 char_u *s;
7005 di = dict_find(d, key, -1);
7006 if (di == NULL)
7007 return NULL;
7008 s = get_tv_string(&di->di_tv);
7009 if (save && s != NULL)
7010 s = vim_strsave(s);
7011 return s;
7015 * Get a number item from a dictionary.
7016 * Returns 0 if the entry doesn't exist or out of memory.
7018 long
7019 get_dict_number(d, key)
7020 dict_T *d;
7021 char_u *key;
7023 dictitem_T *di;
7025 di = dict_find(d, key, -1);
7026 if (di == NULL)
7027 return 0;
7028 return get_tv_number(&di->di_tv);
7032 * Return an allocated string with the string representation of a Dictionary.
7033 * May return NULL.
7035 static char_u *
7036 dict2string(tv, copyID)
7037 typval_T *tv;
7038 int copyID;
7040 garray_T ga;
7041 int first = TRUE;
7042 char_u *tofree;
7043 char_u numbuf[NUMBUFLEN];
7044 hashitem_T *hi;
7045 char_u *s;
7046 dict_T *d;
7047 int todo;
7049 if ((d = tv->vval.v_dict) == NULL)
7050 return NULL;
7051 ga_init2(&ga, (int)sizeof(char), 80);
7052 ga_append(&ga, '{');
7054 todo = (int)d->dv_hashtab.ht_used;
7055 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7057 if (!HASHITEM_EMPTY(hi))
7059 --todo;
7061 if (first)
7062 first = FALSE;
7063 else
7064 ga_concat(&ga, (char_u *)", ");
7066 tofree = string_quote(hi->hi_key, FALSE);
7067 if (tofree != NULL)
7069 ga_concat(&ga, tofree);
7070 vim_free(tofree);
7072 ga_concat(&ga, (char_u *)": ");
7073 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7074 if (s != NULL)
7075 ga_concat(&ga, s);
7076 vim_free(tofree);
7077 if (s == NULL)
7078 break;
7081 if (todo > 0)
7083 vim_free(ga.ga_data);
7084 return NULL;
7087 ga_append(&ga, '}');
7088 ga_append(&ga, NUL);
7089 return (char_u *)ga.ga_data;
7093 * Allocate a variable for a Dictionary and fill it from "*arg".
7094 * Return OK or FAIL. Returns NOTDONE for {expr}.
7096 static int
7097 get_dict_tv(arg, rettv, evaluate)
7098 char_u **arg;
7099 typval_T *rettv;
7100 int evaluate;
7102 dict_T *d = NULL;
7103 typval_T tvkey;
7104 typval_T tv;
7105 char_u *key = NULL;
7106 dictitem_T *item;
7107 char_u *start = skipwhite(*arg + 1);
7108 char_u buf[NUMBUFLEN];
7111 * First check if it's not a curly-braces thing: {expr}.
7112 * Must do this without evaluating, otherwise a function may be called
7113 * twice. Unfortunately this means we need to call eval1() twice for the
7114 * first item.
7115 * But {} is an empty Dictionary.
7117 if (*start != '}')
7119 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7120 return FAIL;
7121 if (*start == '}')
7122 return NOTDONE;
7125 if (evaluate)
7127 d = dict_alloc();
7128 if (d == NULL)
7129 return FAIL;
7131 tvkey.v_type = VAR_UNKNOWN;
7132 tv.v_type = VAR_UNKNOWN;
7134 *arg = skipwhite(*arg + 1);
7135 while (**arg != '}' && **arg != NUL)
7137 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7138 goto failret;
7139 if (**arg != ':')
7141 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7142 clear_tv(&tvkey);
7143 goto failret;
7145 if (evaluate)
7147 key = get_tv_string_buf_chk(&tvkey, buf);
7148 if (key == NULL || *key == NUL)
7150 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7151 if (key != NULL)
7152 EMSG(_(e_emptykey));
7153 clear_tv(&tvkey);
7154 goto failret;
7158 *arg = skipwhite(*arg + 1);
7159 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7161 if (evaluate)
7162 clear_tv(&tvkey);
7163 goto failret;
7165 if (evaluate)
7167 item = dict_find(d, key, -1);
7168 if (item != NULL)
7170 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7171 clear_tv(&tvkey);
7172 clear_tv(&tv);
7173 goto failret;
7175 item = dictitem_alloc(key);
7176 clear_tv(&tvkey);
7177 if (item != NULL)
7179 item->di_tv = tv;
7180 item->di_tv.v_lock = 0;
7181 if (dict_add(d, item) == FAIL)
7182 dictitem_free(item);
7186 if (**arg == '}')
7187 break;
7188 if (**arg != ',')
7190 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7191 goto failret;
7193 *arg = skipwhite(*arg + 1);
7196 if (**arg != '}')
7198 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7199 failret:
7200 if (evaluate)
7201 dict_free(d, TRUE);
7202 return FAIL;
7205 *arg = skipwhite(*arg + 1);
7206 if (evaluate)
7208 rettv->v_type = VAR_DICT;
7209 rettv->vval.v_dict = d;
7210 ++d->dv_refcount;
7213 return OK;
7217 * Return a string with the string representation of a variable.
7218 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7219 * "numbuf" is used for a number.
7220 * Does not put quotes around strings, as ":echo" displays values.
7221 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7222 * May return NULL.
7224 static char_u *
7225 echo_string(tv, tofree, numbuf, copyID)
7226 typval_T *tv;
7227 char_u **tofree;
7228 char_u *numbuf;
7229 int copyID;
7231 static int recurse = 0;
7232 char_u *r = NULL;
7234 if (recurse >= DICT_MAXNEST)
7236 EMSG(_("E724: variable nested too deep for displaying"));
7237 *tofree = NULL;
7238 return NULL;
7240 ++recurse;
7242 switch (tv->v_type)
7244 case VAR_FUNC:
7245 *tofree = NULL;
7246 r = tv->vval.v_string;
7247 break;
7249 case VAR_LIST:
7250 if (tv->vval.v_list == NULL)
7252 *tofree = NULL;
7253 r = NULL;
7255 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7257 *tofree = NULL;
7258 r = (char_u *)"[...]";
7260 else
7262 tv->vval.v_list->lv_copyID = copyID;
7263 *tofree = list2string(tv, copyID);
7264 r = *tofree;
7266 break;
7268 case VAR_DICT:
7269 if (tv->vval.v_dict == NULL)
7271 *tofree = NULL;
7272 r = NULL;
7274 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7276 *tofree = NULL;
7277 r = (char_u *)"{...}";
7279 else
7281 tv->vval.v_dict->dv_copyID = copyID;
7282 *tofree = dict2string(tv, copyID);
7283 r = *tofree;
7285 break;
7287 case VAR_STRING:
7288 case VAR_NUMBER:
7289 *tofree = NULL;
7290 r = get_tv_string_buf(tv, numbuf);
7291 break;
7293 #ifdef FEAT_FLOAT
7294 case VAR_FLOAT:
7295 *tofree = NULL;
7296 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7297 r = numbuf;
7298 break;
7299 #endif
7301 default:
7302 EMSG2(_(e_intern2), "echo_string()");
7303 *tofree = NULL;
7306 --recurse;
7307 return r;
7311 * Return a string with the string representation of a variable.
7312 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7313 * "numbuf" is used for a number.
7314 * Puts quotes around strings, so that they can be parsed back by eval().
7315 * May return NULL.
7317 static char_u *
7318 tv2string(tv, tofree, numbuf, copyID)
7319 typval_T *tv;
7320 char_u **tofree;
7321 char_u *numbuf;
7322 int copyID;
7324 switch (tv->v_type)
7326 case VAR_FUNC:
7327 *tofree = string_quote(tv->vval.v_string, TRUE);
7328 return *tofree;
7329 case VAR_STRING:
7330 *tofree = string_quote(tv->vval.v_string, FALSE);
7331 return *tofree;
7332 #ifdef FEAT_FLOAT
7333 case VAR_FLOAT:
7334 *tofree = NULL;
7335 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7336 return numbuf;
7337 #endif
7338 case VAR_NUMBER:
7339 case VAR_LIST:
7340 case VAR_DICT:
7341 break;
7342 default:
7343 EMSG2(_(e_intern2), "tv2string()");
7345 return echo_string(tv, tofree, numbuf, copyID);
7349 * Return string "str" in ' quotes, doubling ' characters.
7350 * If "str" is NULL an empty string is assumed.
7351 * If "function" is TRUE make it function('string').
7353 static char_u *
7354 string_quote(str, function)
7355 char_u *str;
7356 int function;
7358 unsigned len;
7359 char_u *p, *r, *s;
7361 len = (function ? 13 : 3);
7362 if (str != NULL)
7364 len += (unsigned)STRLEN(str);
7365 for (p = str; *p != NUL; mb_ptr_adv(p))
7366 if (*p == '\'')
7367 ++len;
7369 s = r = alloc(len);
7370 if (r != NULL)
7372 if (function)
7374 STRCPY(r, "function('");
7375 r += 10;
7377 else
7378 *r++ = '\'';
7379 if (str != NULL)
7380 for (p = str; *p != NUL; )
7382 if (*p == '\'')
7383 *r++ = '\'';
7384 MB_COPY_CHAR(p, r);
7386 *r++ = '\'';
7387 if (function)
7388 *r++ = ')';
7389 *r++ = NUL;
7391 return s;
7394 #ifdef FEAT_FLOAT
7396 * Convert the string "text" to a floating point number.
7397 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7398 * this always uses a decimal point.
7399 * Returns the length of the text that was consumed.
7401 static int
7402 string2float(text, value)
7403 char_u *text;
7404 float_T *value; /* result stored here */
7406 char *s = (char *)text;
7407 float_T f;
7409 f = strtod(s, &s);
7410 *value = f;
7411 return (int)((char_u *)s - text);
7413 #endif
7416 * Get the value of an environment variable.
7417 * "arg" is pointing to the '$'. It is advanced to after the name.
7418 * If the environment variable was not set, silently assume it is empty.
7419 * Always return OK.
7421 static int
7422 get_env_tv(arg, rettv, evaluate)
7423 char_u **arg;
7424 typval_T *rettv;
7425 int evaluate;
7427 char_u *string = NULL;
7428 int len;
7429 int cc;
7430 char_u *name;
7431 int mustfree = FALSE;
7433 ++*arg;
7434 name = *arg;
7435 len = get_env_len(arg);
7436 if (evaluate)
7438 if (len != 0)
7440 cc = name[len];
7441 name[len] = NUL;
7442 /* first try vim_getenv(), fast for normal environment vars */
7443 string = vim_getenv(name, &mustfree);
7444 if (string != NULL && *string != NUL)
7446 if (!mustfree)
7447 string = vim_strsave(string);
7449 else
7451 if (mustfree)
7452 vim_free(string);
7454 /* next try expanding things like $VIM and ${HOME} */
7455 string = expand_env_save(name - 1);
7456 if (string != NULL && *string == '$')
7458 vim_free(string);
7459 string = NULL;
7462 name[len] = cc;
7464 rettv->v_type = VAR_STRING;
7465 rettv->vval.v_string = string;
7468 return OK;
7472 * Array with names and number of arguments of all internal functions
7473 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7475 static struct fst
7477 char *f_name; /* function name */
7478 char f_min_argc; /* minimal number of arguments */
7479 char f_max_argc; /* maximal number of arguments */
7480 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7481 /* implementation of function */
7482 } functions[] =
7484 #ifdef FEAT_FLOAT
7485 {"abs", 1, 1, f_abs},
7486 #endif
7487 {"add", 2, 2, f_add},
7488 {"append", 2, 2, f_append},
7489 {"argc", 0, 0, f_argc},
7490 {"argidx", 0, 0, f_argidx},
7491 {"argv", 0, 1, f_argv},
7492 #ifdef FEAT_FLOAT
7493 {"atan", 1, 1, f_atan},
7494 #endif
7495 {"browse", 4, 4, f_browse},
7496 {"browsedir", 2, 2, f_browsedir},
7497 {"bufexists", 1, 1, f_bufexists},
7498 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7499 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7500 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7501 {"buflisted", 1, 1, f_buflisted},
7502 {"bufloaded", 1, 1, f_bufloaded},
7503 {"bufname", 1, 1, f_bufname},
7504 {"bufnr", 1, 2, f_bufnr},
7505 {"bufwinnr", 1, 1, f_bufwinnr},
7506 {"byte2line", 1, 1, f_byte2line},
7507 {"byteidx", 2, 2, f_byteidx},
7508 {"call", 2, 3, f_call},
7509 #ifdef FEAT_FLOAT
7510 {"ceil", 1, 1, f_ceil},
7511 #endif
7512 {"changenr", 0, 0, f_changenr},
7513 {"char2nr", 1, 1, f_char2nr},
7514 {"cindent", 1, 1, f_cindent},
7515 {"clearmatches", 0, 0, f_clearmatches},
7516 {"col", 1, 1, f_col},
7517 #if defined(FEAT_INS_EXPAND)
7518 {"complete", 2, 2, f_complete},
7519 {"complete_add", 1, 1, f_complete_add},
7520 {"complete_check", 0, 0, f_complete_check},
7521 #endif
7522 {"confirm", 1, 4, f_confirm},
7523 {"copy", 1, 1, f_copy},
7524 #ifdef FEAT_FLOAT
7525 {"cos", 1, 1, f_cos},
7526 #endif
7527 {"count", 2, 4, f_count},
7528 {"cscope_connection",0,3, f_cscope_connection},
7529 {"cursor", 1, 3, f_cursor},
7530 {"deepcopy", 1, 2, f_deepcopy},
7531 {"delete", 1, 1, f_delete},
7532 {"did_filetype", 0, 0, f_did_filetype},
7533 {"diff_filler", 1, 1, f_diff_filler},
7534 {"diff_hlID", 2, 2, f_diff_hlID},
7535 {"empty", 1, 1, f_empty},
7536 {"escape", 2, 2, f_escape},
7537 {"eval", 1, 1, f_eval},
7538 {"eventhandler", 0, 0, f_eventhandler},
7539 {"executable", 1, 1, f_executable},
7540 {"exists", 1, 1, f_exists},
7541 {"expand", 1, 2, f_expand},
7542 {"extend", 2, 3, f_extend},
7543 {"feedkeys", 1, 2, f_feedkeys},
7544 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7545 {"filereadable", 1, 1, f_filereadable},
7546 {"filewritable", 1, 1, f_filewritable},
7547 {"filter", 2, 2, f_filter},
7548 {"finddir", 1, 3, f_finddir},
7549 {"findfile", 1, 3, f_findfile},
7550 #ifdef FEAT_FLOAT
7551 {"float2nr", 1, 1, f_float2nr},
7552 {"floor", 1, 1, f_floor},
7553 #endif
7554 {"fnameescape", 1, 1, f_fnameescape},
7555 {"fnamemodify", 2, 2, f_fnamemodify},
7556 {"foldclosed", 1, 1, f_foldclosed},
7557 {"foldclosedend", 1, 1, f_foldclosedend},
7558 {"foldlevel", 1, 1, f_foldlevel},
7559 {"foldtext", 0, 0, f_foldtext},
7560 {"foldtextresult", 1, 1, f_foldtextresult},
7561 {"foreground", 0, 0, f_foreground},
7562 {"function", 1, 1, f_function},
7563 {"garbagecollect", 0, 1, f_garbagecollect},
7564 {"get", 2, 3, f_get},
7565 {"getbufline", 2, 3, f_getbufline},
7566 {"getbufvar", 2, 2, f_getbufvar},
7567 {"getchar", 0, 1, f_getchar},
7568 {"getcharmod", 0, 0, f_getcharmod},
7569 {"getcmdline", 0, 0, f_getcmdline},
7570 {"getcmdpos", 0, 0, f_getcmdpos},
7571 {"getcmdtype", 0, 0, f_getcmdtype},
7572 {"getcwd", 0, 0, f_getcwd},
7573 {"getfontname", 0, 1, f_getfontname},
7574 {"getfperm", 1, 1, f_getfperm},
7575 {"getfsize", 1, 1, f_getfsize},
7576 {"getftime", 1, 1, f_getftime},
7577 {"getftype", 1, 1, f_getftype},
7578 {"getline", 1, 2, f_getline},
7579 {"getloclist", 1, 1, f_getqflist},
7580 {"getmatches", 0, 0, f_getmatches},
7581 {"getpid", 0, 0, f_getpid},
7582 {"getpos", 1, 1, f_getpos},
7583 {"getqflist", 0, 0, f_getqflist},
7584 {"getreg", 0, 2, f_getreg},
7585 {"getregtype", 0, 1, f_getregtype},
7586 {"gettabwinvar", 3, 3, f_gettabwinvar},
7587 {"getwinposx", 0, 0, f_getwinposx},
7588 {"getwinposy", 0, 0, f_getwinposy},
7589 {"getwinvar", 2, 2, f_getwinvar},
7590 {"glob", 1, 2, f_glob},
7591 {"globpath", 2, 3, f_globpath},
7592 {"has", 1, 1, f_has},
7593 {"has_key", 2, 2, f_has_key},
7594 {"haslocaldir", 0, 0, f_haslocaldir},
7595 {"hasmapto", 1, 3, f_hasmapto},
7596 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7597 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7598 {"histadd", 2, 2, f_histadd},
7599 {"histdel", 1, 2, f_histdel},
7600 {"histget", 1, 2, f_histget},
7601 {"histnr", 1, 1, f_histnr},
7602 {"hlID", 1, 1, f_hlID},
7603 {"hlexists", 1, 1, f_hlexists},
7604 {"hostname", 0, 0, f_hostname},
7605 {"iconv", 3, 3, f_iconv},
7606 {"indent", 1, 1, f_indent},
7607 {"index", 2, 4, f_index},
7608 {"input", 1, 3, f_input},
7609 {"inputdialog", 1, 3, f_inputdialog},
7610 {"inputlist", 1, 1, f_inputlist},
7611 {"inputrestore", 0, 0, f_inputrestore},
7612 {"inputsave", 0, 0, f_inputsave},
7613 {"inputsecret", 1, 2, f_inputsecret},
7614 {"insert", 2, 3, f_insert},
7615 {"isdirectory", 1, 1, f_isdirectory},
7616 {"islocked", 1, 1, f_islocked},
7617 {"items", 1, 1, f_items},
7618 {"join", 1, 2, f_join},
7619 {"keys", 1, 1, f_keys},
7620 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7621 {"len", 1, 1, f_len},
7622 {"libcall", 3, 3, f_libcall},
7623 {"libcallnr", 3, 3, f_libcallnr},
7624 {"line", 1, 1, f_line},
7625 {"line2byte", 1, 1, f_line2byte},
7626 {"lispindent", 1, 1, f_lispindent},
7627 {"localtime", 0, 0, f_localtime},
7628 #ifdef FEAT_FLOAT
7629 {"log10", 1, 1, f_log10},
7630 #endif
7631 {"map", 2, 2, f_map},
7632 {"maparg", 1, 3, f_maparg},
7633 {"mapcheck", 1, 3, f_mapcheck},
7634 {"match", 2, 4, f_match},
7635 {"matchadd", 2, 4, f_matchadd},
7636 {"matcharg", 1, 1, f_matcharg},
7637 {"matchdelete", 1, 1, f_matchdelete},
7638 {"matchend", 2, 4, f_matchend},
7639 {"matchlist", 2, 4, f_matchlist},
7640 {"matchstr", 2, 4, f_matchstr},
7641 {"max", 1, 1, f_max},
7642 {"min", 1, 1, f_min},
7643 #ifdef vim_mkdir
7644 {"mkdir", 1, 3, f_mkdir},
7645 #endif
7646 {"mode", 0, 1, f_mode},
7647 {"nextnonblank", 1, 1, f_nextnonblank},
7648 {"nr2char", 1, 1, f_nr2char},
7649 {"pathshorten", 1, 1, f_pathshorten},
7650 #ifdef FEAT_FLOAT
7651 {"pow", 2, 2, f_pow},
7652 #endif
7653 {"prevnonblank", 1, 1, f_prevnonblank},
7654 {"printf", 2, 19, f_printf},
7655 {"pumvisible", 0, 0, f_pumvisible},
7656 {"range", 1, 3, f_range},
7657 {"readfile", 1, 3, f_readfile},
7658 {"reltime", 0, 2, f_reltime},
7659 {"reltimestr", 1, 1, f_reltimestr},
7660 {"remote_expr", 2, 3, f_remote_expr},
7661 {"remote_foreground", 1, 1, f_remote_foreground},
7662 {"remote_peek", 1, 2, f_remote_peek},
7663 {"remote_read", 1, 1, f_remote_read},
7664 {"remote_send", 2, 3, f_remote_send},
7665 {"remove", 2, 3, f_remove},
7666 {"rename", 2, 2, f_rename},
7667 {"repeat", 2, 2, f_repeat},
7668 {"resolve", 1, 1, f_resolve},
7669 {"reverse", 1, 1, f_reverse},
7670 #ifdef FEAT_FLOAT
7671 {"round", 1, 1, f_round},
7672 #endif
7673 {"search", 1, 4, f_search},
7674 {"searchdecl", 1, 3, f_searchdecl},
7675 {"searchpair", 3, 7, f_searchpair},
7676 {"searchpairpos", 3, 7, f_searchpairpos},
7677 {"searchpos", 1, 4, f_searchpos},
7678 {"server2client", 2, 2, f_server2client},
7679 {"serverlist", 0, 0, f_serverlist},
7680 {"setbufvar", 3, 3, f_setbufvar},
7681 {"setcmdpos", 1, 1, f_setcmdpos},
7682 {"setline", 2, 2, f_setline},
7683 {"setloclist", 2, 3, f_setloclist},
7684 {"setmatches", 1, 1, f_setmatches},
7685 {"setpos", 2, 2, f_setpos},
7686 {"setqflist", 1, 2, f_setqflist},
7687 {"setreg", 2, 3, f_setreg},
7688 {"settabwinvar", 4, 4, f_settabwinvar},
7689 {"setwinvar", 3, 3, f_setwinvar},
7690 {"shellescape", 1, 2, f_shellescape},
7691 {"simplify", 1, 1, f_simplify},
7692 #ifdef FEAT_FLOAT
7693 {"sin", 1, 1, f_sin},
7694 #endif
7695 {"sort", 1, 2, f_sort},
7696 {"soundfold", 1, 1, f_soundfold},
7697 {"spellbadword", 0, 1, f_spellbadword},
7698 {"spellsuggest", 1, 3, f_spellsuggest},
7699 {"split", 1, 3, f_split},
7700 #ifdef FEAT_FLOAT
7701 {"sqrt", 1, 1, f_sqrt},
7702 {"str2float", 1, 1, f_str2float},
7703 #endif
7704 {"str2nr", 1, 2, f_str2nr},
7705 #ifdef HAVE_STRFTIME
7706 {"strftime", 1, 2, f_strftime},
7707 #endif
7708 {"stridx", 2, 3, f_stridx},
7709 {"string", 1, 1, f_string},
7710 {"strlen", 1, 1, f_strlen},
7711 {"strpart", 2, 3, f_strpart},
7712 {"strridx", 2, 3, f_strridx},
7713 {"strtrans", 1, 1, f_strtrans},
7714 {"submatch", 1, 1, f_submatch},
7715 {"substitute", 4, 4, f_substitute},
7716 {"synID", 3, 3, f_synID},
7717 {"synIDattr", 2, 3, f_synIDattr},
7718 {"synIDtrans", 1, 1, f_synIDtrans},
7719 {"synstack", 2, 2, f_synstack},
7720 {"system", 1, 2, f_system},
7721 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7722 {"tabpagenr", 0, 1, f_tabpagenr},
7723 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7724 {"tagfiles", 0, 0, f_tagfiles},
7725 {"taglist", 1, 1, f_taglist},
7726 {"tempname", 0, 0, f_tempname},
7727 {"test", 1, 1, f_test},
7728 {"tolower", 1, 1, f_tolower},
7729 {"toupper", 1, 1, f_toupper},
7730 {"tr", 3, 3, f_tr},
7731 #ifdef FEAT_FLOAT
7732 {"trunc", 1, 1, f_trunc},
7733 #endif
7734 {"type", 1, 1, f_type},
7735 {"values", 1, 1, f_values},
7736 {"virtcol", 1, 1, f_virtcol},
7737 {"visualmode", 0, 1, f_visualmode},
7738 {"winbufnr", 1, 1, f_winbufnr},
7739 {"wincol", 0, 0, f_wincol},
7740 {"winheight", 1, 1, f_winheight},
7741 {"winline", 0, 0, f_winline},
7742 {"winnr", 0, 1, f_winnr},
7743 {"winrestcmd", 0, 0, f_winrestcmd},
7744 {"winrestview", 1, 1, f_winrestview},
7745 {"winsaveview", 0, 0, f_winsaveview},
7746 {"winwidth", 1, 1, f_winwidth},
7747 {"writefile", 2, 3, f_writefile},
7750 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7753 * Function given to ExpandGeneric() to obtain the list of internal
7754 * or user defined function names.
7756 char_u *
7757 get_function_name(xp, idx)
7758 expand_T *xp;
7759 int idx;
7761 static int intidx = -1;
7762 char_u *name;
7764 if (idx == 0)
7765 intidx = -1;
7766 if (intidx < 0)
7768 name = get_user_func_name(xp, idx);
7769 if (name != NULL)
7770 return name;
7772 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7774 STRCPY(IObuff, functions[intidx].f_name);
7775 STRCAT(IObuff, "(");
7776 if (functions[intidx].f_max_argc == 0)
7777 STRCAT(IObuff, ")");
7778 return IObuff;
7781 return NULL;
7785 * Function given to ExpandGeneric() to obtain the list of internal or
7786 * user defined variable or function names.
7788 /*ARGSUSED*/
7789 char_u *
7790 get_expr_name(xp, idx)
7791 expand_T *xp;
7792 int idx;
7794 static int intidx = -1;
7795 char_u *name;
7797 if (idx == 0)
7798 intidx = -1;
7799 if (intidx < 0)
7801 name = get_function_name(xp, idx);
7802 if (name != NULL)
7803 return name;
7805 return get_user_var_name(xp, ++intidx);
7808 #endif /* FEAT_CMDL_COMPL */
7811 * Find internal function in table above.
7812 * Return index, or -1 if not found
7814 static int
7815 find_internal_func(name)
7816 char_u *name; /* name of the function */
7818 int first = 0;
7819 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7820 int cmp;
7821 int x;
7824 * Find the function name in the table. Binary search.
7826 while (first <= last)
7828 x = first + ((unsigned)(last - first) >> 1);
7829 cmp = STRCMP(name, functions[x].f_name);
7830 if (cmp < 0)
7831 last = x - 1;
7832 else if (cmp > 0)
7833 first = x + 1;
7834 else
7835 return x;
7837 return -1;
7841 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7842 * name it contains, otherwise return "name".
7844 static char_u *
7845 deref_func_name(name, lenp)
7846 char_u *name;
7847 int *lenp;
7849 dictitem_T *v;
7850 int cc;
7852 cc = name[*lenp];
7853 name[*lenp] = NUL;
7854 v = find_var(name, NULL);
7855 name[*lenp] = cc;
7856 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7858 if (v->di_tv.vval.v_string == NULL)
7860 *lenp = 0;
7861 return (char_u *)""; /* just in case */
7863 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7864 return v->di_tv.vval.v_string;
7867 return name;
7871 * Allocate a variable for the result of a function.
7872 * Return OK or FAIL.
7874 static int
7875 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7876 evaluate, selfdict)
7877 char_u *name; /* name of the function */
7878 int len; /* length of "name" */
7879 typval_T *rettv;
7880 char_u **arg; /* argument, pointing to the '(' */
7881 linenr_T firstline; /* first line of range */
7882 linenr_T lastline; /* last line of range */
7883 int *doesrange; /* return: function handled range */
7884 int evaluate;
7885 dict_T *selfdict; /* Dictionary for "self" */
7887 char_u *argp;
7888 int ret = OK;
7889 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7890 int argcount = 0; /* number of arguments found */
7893 * Get the arguments.
7895 argp = *arg;
7896 while (argcount < MAX_FUNC_ARGS)
7898 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7899 if (*argp == ')' || *argp == ',' || *argp == NUL)
7900 break;
7901 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7903 ret = FAIL;
7904 break;
7906 ++argcount;
7907 if (*argp != ',')
7908 break;
7910 if (*argp == ')')
7911 ++argp;
7912 else
7913 ret = FAIL;
7915 if (ret == OK)
7916 ret = call_func(name, len, rettv, argcount, argvars,
7917 firstline, lastline, doesrange, evaluate, selfdict);
7918 else if (!aborting())
7920 if (argcount == MAX_FUNC_ARGS)
7921 emsg_funcname("E740: Too many arguments for function %s", name);
7922 else
7923 emsg_funcname("E116: Invalid arguments for function %s", name);
7926 while (--argcount >= 0)
7927 clear_tv(&argvars[argcount]);
7929 *arg = skipwhite(argp);
7930 return ret;
7935 * Call a function with its resolved parameters
7936 * Return OK when the function can't be called, FAIL otherwise.
7937 * Also returns OK when an error was encountered while executing the function.
7939 static int
7940 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7941 doesrange, evaluate, selfdict)
7942 char_u *name; /* name of the function */
7943 int len; /* length of "name" */
7944 typval_T *rettv; /* return value goes here */
7945 int argcount; /* number of "argvars" */
7946 typval_T *argvars; /* vars for arguments, must have "argcount"
7947 PLUS ONE elements! */
7948 linenr_T firstline; /* first line of range */
7949 linenr_T lastline; /* last line of range */
7950 int *doesrange; /* return: function handled range */
7951 int evaluate;
7952 dict_T *selfdict; /* Dictionary for "self" */
7954 int ret = FAIL;
7955 #define ERROR_UNKNOWN 0
7956 #define ERROR_TOOMANY 1
7957 #define ERROR_TOOFEW 2
7958 #define ERROR_SCRIPT 3
7959 #define ERROR_DICT 4
7960 #define ERROR_NONE 5
7961 #define ERROR_OTHER 6
7962 int error = ERROR_NONE;
7963 int i;
7964 int llen;
7965 ufunc_T *fp;
7966 int cc;
7967 #define FLEN_FIXED 40
7968 char_u fname_buf[FLEN_FIXED + 1];
7969 char_u *fname;
7972 * In a script change <SID>name() and s:name() to K_SNR 123_name().
7973 * Change <SNR>123_name() to K_SNR 123_name().
7974 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
7976 cc = name[len];
7977 name[len] = NUL;
7978 llen = eval_fname_script(name);
7979 if (llen > 0)
7981 fname_buf[0] = K_SPECIAL;
7982 fname_buf[1] = KS_EXTRA;
7983 fname_buf[2] = (int)KE_SNR;
7984 i = 3;
7985 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
7987 if (current_SID <= 0)
7988 error = ERROR_SCRIPT;
7989 else
7991 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
7992 i = (int)STRLEN(fname_buf);
7995 if (i + STRLEN(name + llen) < FLEN_FIXED)
7997 STRCPY(fname_buf + i, name + llen);
7998 fname = fname_buf;
8000 else
8002 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8003 if (fname == NULL)
8004 error = ERROR_OTHER;
8005 else
8007 mch_memmove(fname, fname_buf, (size_t)i);
8008 STRCPY(fname + i, name + llen);
8012 else
8013 fname = name;
8015 *doesrange = FALSE;
8018 /* execute the function if no errors detected and executing */
8019 if (evaluate && error == ERROR_NONE)
8021 rettv->v_type = VAR_NUMBER; /* default is number rettv */
8022 error = ERROR_UNKNOWN;
8024 if (!builtin_function(fname))
8027 * User defined function.
8029 fp = find_func(fname);
8031 #ifdef FEAT_AUTOCMD
8032 /* Trigger FuncUndefined event, may load the function. */
8033 if (fp == NULL
8034 && apply_autocmds(EVENT_FUNCUNDEFINED,
8035 fname, fname, TRUE, NULL)
8036 && !aborting())
8038 /* executed an autocommand, search for the function again */
8039 fp = find_func(fname);
8041 #endif
8042 /* Try loading a package. */
8043 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8045 /* loaded a package, search for the function again */
8046 fp = find_func(fname);
8049 if (fp != NULL)
8051 if (fp->uf_flags & FC_RANGE)
8052 *doesrange = TRUE;
8053 if (argcount < fp->uf_args.ga_len)
8054 error = ERROR_TOOFEW;
8055 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8056 error = ERROR_TOOMANY;
8057 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8058 error = ERROR_DICT;
8059 else
8062 * Call the user function.
8063 * Save and restore search patterns, script variables and
8064 * redo buffer.
8066 save_search_patterns();
8067 saveRedobuff();
8068 ++fp->uf_calls;
8069 call_user_func(fp, argcount, argvars, rettv,
8070 firstline, lastline,
8071 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8072 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8073 && fp->uf_refcount <= 0)
8074 /* Function was unreferenced while being used, free it
8075 * now. */
8076 func_free(fp);
8077 restoreRedobuff();
8078 restore_search_patterns();
8079 error = ERROR_NONE;
8083 else
8086 * Find the function name in the table, call its implementation.
8088 i = find_internal_func(fname);
8089 if (i >= 0)
8091 if (argcount < functions[i].f_min_argc)
8092 error = ERROR_TOOFEW;
8093 else if (argcount > functions[i].f_max_argc)
8094 error = ERROR_TOOMANY;
8095 else
8097 argvars[argcount].v_type = VAR_UNKNOWN;
8098 functions[i].f_func(argvars, rettv);
8099 error = ERROR_NONE;
8104 * The function call (or "FuncUndefined" autocommand sequence) might
8105 * have been aborted by an error, an interrupt, or an explicitly thrown
8106 * exception that has not been caught so far. This situation can be
8107 * tested for by calling aborting(). For an error in an internal
8108 * function or for the "E132" error in call_user_func(), however, the
8109 * throw point at which the "force_abort" flag (temporarily reset by
8110 * emsg()) is normally updated has not been reached yet. We need to
8111 * update that flag first to make aborting() reliable.
8113 update_force_abort();
8115 if (error == ERROR_NONE)
8116 ret = OK;
8119 * Report an error unless the argument evaluation or function call has been
8120 * cancelled due to an aborting error, an interrupt, or an exception.
8122 if (!aborting())
8124 switch (error)
8126 case ERROR_UNKNOWN:
8127 emsg_funcname(N_("E117: Unknown function: %s"), name);
8128 break;
8129 case ERROR_TOOMANY:
8130 emsg_funcname(e_toomanyarg, name);
8131 break;
8132 case ERROR_TOOFEW:
8133 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8134 name);
8135 break;
8136 case ERROR_SCRIPT:
8137 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8138 name);
8139 break;
8140 case ERROR_DICT:
8141 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8142 name);
8143 break;
8147 name[len] = cc;
8148 if (fname != name && fname != fname_buf)
8149 vim_free(fname);
8151 return ret;
8155 * Give an error message with a function name. Handle <SNR> things.
8157 static void
8158 emsg_funcname(ermsg, name)
8159 char *ermsg;
8160 char_u *name;
8162 char_u *p;
8164 if (*name == K_SPECIAL)
8165 p = concat_str((char_u *)"<SNR>", name + 3);
8166 else
8167 p = name;
8168 EMSG2(_(ermsg), p);
8169 if (p != name)
8170 vim_free(p);
8174 * Return TRUE for a non-zero Number and a non-empty String.
8176 static int
8177 non_zero_arg(argvars)
8178 typval_T *argvars;
8180 return ((argvars[0].v_type == VAR_NUMBER
8181 && argvars[0].vval.v_number != 0)
8182 || (argvars[0].v_type == VAR_STRING
8183 && argvars[0].vval.v_string != NULL
8184 && *argvars[0].vval.v_string != NUL));
8187 /*********************************************
8188 * Implementation of the built-in functions
8191 #ifdef FEAT_FLOAT
8193 * "abs(expr)" function
8195 static void
8196 f_abs(argvars, rettv)
8197 typval_T *argvars;
8198 typval_T *rettv;
8200 if (argvars[0].v_type == VAR_FLOAT)
8202 rettv->v_type = VAR_FLOAT;
8203 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8205 else
8207 varnumber_T n;
8208 int error = FALSE;
8210 n = get_tv_number_chk(&argvars[0], &error);
8211 if (error)
8212 rettv->vval.v_number = -1;
8213 else if (n > 0)
8214 rettv->vval.v_number = n;
8215 else
8216 rettv->vval.v_number = -n;
8219 #endif
8222 * "add(list, item)" function
8224 static void
8225 f_add(argvars, rettv)
8226 typval_T *argvars;
8227 typval_T *rettv;
8229 list_T *l;
8231 rettv->vval.v_number = 1; /* Default: Failed */
8232 if (argvars[0].v_type == VAR_LIST)
8234 if ((l = argvars[0].vval.v_list) != NULL
8235 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8236 && list_append_tv(l, &argvars[1]) == OK)
8237 copy_tv(&argvars[0], rettv);
8239 else
8240 EMSG(_(e_listreq));
8244 * "append(lnum, string/list)" function
8246 static void
8247 f_append(argvars, rettv)
8248 typval_T *argvars;
8249 typval_T *rettv;
8251 long lnum;
8252 char_u *line;
8253 list_T *l = NULL;
8254 listitem_T *li = NULL;
8255 typval_T *tv;
8256 long added = 0;
8258 lnum = get_tv_lnum(argvars);
8259 if (lnum >= 0
8260 && lnum <= curbuf->b_ml.ml_line_count
8261 && u_save(lnum, lnum + 1) == OK)
8263 if (argvars[1].v_type == VAR_LIST)
8265 l = argvars[1].vval.v_list;
8266 if (l == NULL)
8267 return;
8268 li = l->lv_first;
8270 rettv->vval.v_number = 0; /* Default: Success */
8271 for (;;)
8273 if (l == NULL)
8274 tv = &argvars[1]; /* append a string */
8275 else if (li == NULL)
8276 break; /* end of list */
8277 else
8278 tv = &li->li_tv; /* append item from list */
8279 line = get_tv_string_chk(tv);
8280 if (line == NULL) /* type error */
8282 rettv->vval.v_number = 1; /* Failed */
8283 break;
8285 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8286 ++added;
8287 if (l == NULL)
8288 break;
8289 li = li->li_next;
8292 appended_lines_mark(lnum, added);
8293 if (curwin->w_cursor.lnum > lnum)
8294 curwin->w_cursor.lnum += added;
8296 else
8297 rettv->vval.v_number = 1; /* Failed */
8301 * "argc()" function
8303 /* ARGSUSED */
8304 static void
8305 f_argc(argvars, rettv)
8306 typval_T *argvars;
8307 typval_T *rettv;
8309 rettv->vval.v_number = ARGCOUNT;
8313 * "argidx()" function
8315 /* ARGSUSED */
8316 static void
8317 f_argidx(argvars, rettv)
8318 typval_T *argvars;
8319 typval_T *rettv;
8321 rettv->vval.v_number = curwin->w_arg_idx;
8325 * "argv(nr)" function
8327 static void
8328 f_argv(argvars, rettv)
8329 typval_T *argvars;
8330 typval_T *rettv;
8332 int idx;
8334 if (argvars[0].v_type != VAR_UNKNOWN)
8336 idx = get_tv_number_chk(&argvars[0], NULL);
8337 if (idx >= 0 && idx < ARGCOUNT)
8338 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8339 else
8340 rettv->vval.v_string = NULL;
8341 rettv->v_type = VAR_STRING;
8343 else if (rettv_list_alloc(rettv) == OK)
8344 for (idx = 0; idx < ARGCOUNT; ++idx)
8345 list_append_string(rettv->vval.v_list,
8346 alist_name(&ARGLIST[idx]), -1);
8349 #ifdef FEAT_FLOAT
8350 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8353 * Get the float value of "argvars[0]" into "f".
8354 * Returns FAIL when the argument is not a Number or Float.
8356 static int
8357 get_float_arg(argvars, f)
8358 typval_T *argvars;
8359 float_T *f;
8361 if (argvars[0].v_type == VAR_FLOAT)
8363 *f = argvars[0].vval.v_float;
8364 return OK;
8366 if (argvars[0].v_type == VAR_NUMBER)
8368 *f = (float_T)argvars[0].vval.v_number;
8369 return OK;
8371 EMSG(_("E808: Number or Float required"));
8372 return FAIL;
8376 * "atan()" function
8378 static void
8379 f_atan(argvars, rettv)
8380 typval_T *argvars;
8381 typval_T *rettv;
8383 float_T f;
8385 rettv->v_type = VAR_FLOAT;
8386 if (get_float_arg(argvars, &f) == OK)
8387 rettv->vval.v_float = atan(f);
8388 else
8389 rettv->vval.v_float = 0.0;
8391 #endif
8394 * "browse(save, title, initdir, default)" function
8396 /* ARGSUSED */
8397 static void
8398 f_browse(argvars, rettv)
8399 typval_T *argvars;
8400 typval_T *rettv;
8402 #ifdef FEAT_BROWSE
8403 int save;
8404 char_u *title;
8405 char_u *initdir;
8406 char_u *defname;
8407 char_u buf[NUMBUFLEN];
8408 char_u buf2[NUMBUFLEN];
8409 int error = FALSE;
8411 save = get_tv_number_chk(&argvars[0], &error);
8412 title = get_tv_string_chk(&argvars[1]);
8413 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8414 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8416 if (error || title == NULL || initdir == NULL || defname == NULL)
8417 rettv->vval.v_string = NULL;
8418 else
8419 rettv->vval.v_string =
8420 do_browse(save ? BROWSE_SAVE : 0,
8421 title, defname, NULL, initdir, NULL, curbuf);
8422 #else
8423 rettv->vval.v_string = NULL;
8424 #endif
8425 rettv->v_type = VAR_STRING;
8429 * "browsedir(title, initdir)" function
8431 /* ARGSUSED */
8432 static void
8433 f_browsedir(argvars, rettv)
8434 typval_T *argvars;
8435 typval_T *rettv;
8437 #ifdef FEAT_BROWSE
8438 char_u *title;
8439 char_u *initdir;
8440 char_u buf[NUMBUFLEN];
8442 title = get_tv_string_chk(&argvars[0]);
8443 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8445 if (title == NULL || initdir == NULL)
8446 rettv->vval.v_string = NULL;
8447 else
8448 rettv->vval.v_string = do_browse(BROWSE_DIR,
8449 title, NULL, NULL, initdir, NULL, curbuf);
8450 #else
8451 rettv->vval.v_string = NULL;
8452 #endif
8453 rettv->v_type = VAR_STRING;
8456 static buf_T *find_buffer __ARGS((typval_T *avar));
8459 * Find a buffer by number or exact name.
8461 static buf_T *
8462 find_buffer(avar)
8463 typval_T *avar;
8465 buf_T *buf = NULL;
8467 if (avar->v_type == VAR_NUMBER)
8468 buf = buflist_findnr((int)avar->vval.v_number);
8469 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8471 buf = buflist_findname_exp(avar->vval.v_string);
8472 if (buf == NULL)
8474 /* No full path name match, try a match with a URL or a "nofile"
8475 * buffer, these don't use the full path. */
8476 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8477 if (buf->b_fname != NULL
8478 && (path_with_url(buf->b_fname)
8479 #ifdef FEAT_QUICKFIX
8480 || bt_nofile(buf)
8481 #endif
8483 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8484 break;
8487 return buf;
8491 * "bufexists(expr)" function
8493 static void
8494 f_bufexists(argvars, rettv)
8495 typval_T *argvars;
8496 typval_T *rettv;
8498 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8502 * "buflisted(expr)" function
8504 static void
8505 f_buflisted(argvars, rettv)
8506 typval_T *argvars;
8507 typval_T *rettv;
8509 buf_T *buf;
8511 buf = find_buffer(&argvars[0]);
8512 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8516 * "bufloaded(expr)" function
8518 static void
8519 f_bufloaded(argvars, rettv)
8520 typval_T *argvars;
8521 typval_T *rettv;
8523 buf_T *buf;
8525 buf = find_buffer(&argvars[0]);
8526 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8529 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8532 * Get buffer by number or pattern.
8534 static buf_T *
8535 get_buf_tv(tv)
8536 typval_T *tv;
8538 char_u *name = tv->vval.v_string;
8539 int save_magic;
8540 char_u *save_cpo;
8541 buf_T *buf;
8543 if (tv->v_type == VAR_NUMBER)
8544 return buflist_findnr((int)tv->vval.v_number);
8545 if (tv->v_type != VAR_STRING)
8546 return NULL;
8547 if (name == NULL || *name == NUL)
8548 return curbuf;
8549 if (name[0] == '$' && name[1] == NUL)
8550 return lastbuf;
8552 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8553 save_magic = p_magic;
8554 p_magic = TRUE;
8555 save_cpo = p_cpo;
8556 p_cpo = (char_u *)"";
8558 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8559 TRUE, FALSE));
8561 p_magic = save_magic;
8562 p_cpo = save_cpo;
8564 /* If not found, try expanding the name, like done for bufexists(). */
8565 if (buf == NULL)
8566 buf = find_buffer(tv);
8568 return buf;
8572 * "bufname(expr)" function
8574 static void
8575 f_bufname(argvars, rettv)
8576 typval_T *argvars;
8577 typval_T *rettv;
8579 buf_T *buf;
8581 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8582 ++emsg_off;
8583 buf = get_buf_tv(&argvars[0]);
8584 rettv->v_type = VAR_STRING;
8585 if (buf != NULL && buf->b_fname != NULL)
8586 rettv->vval.v_string = vim_strsave(buf->b_fname);
8587 else
8588 rettv->vval.v_string = NULL;
8589 --emsg_off;
8593 * "bufnr(expr)" function
8595 static void
8596 f_bufnr(argvars, rettv)
8597 typval_T *argvars;
8598 typval_T *rettv;
8600 buf_T *buf;
8601 int error = FALSE;
8602 char_u *name;
8604 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8605 ++emsg_off;
8606 buf = get_buf_tv(&argvars[0]);
8607 --emsg_off;
8609 /* If the buffer isn't found and the second argument is not zero create a
8610 * new buffer. */
8611 if (buf == NULL
8612 && argvars[1].v_type != VAR_UNKNOWN
8613 && get_tv_number_chk(&argvars[1], &error) != 0
8614 && !error
8615 && (name = get_tv_string_chk(&argvars[0])) != NULL
8616 && !error)
8617 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8619 if (buf != NULL)
8620 rettv->vval.v_number = buf->b_fnum;
8621 else
8622 rettv->vval.v_number = -1;
8626 * "bufwinnr(nr)" function
8628 static void
8629 f_bufwinnr(argvars, rettv)
8630 typval_T *argvars;
8631 typval_T *rettv;
8633 #ifdef FEAT_WINDOWS
8634 win_T *wp;
8635 int winnr = 0;
8636 #endif
8637 buf_T *buf;
8639 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8640 ++emsg_off;
8641 buf = get_buf_tv(&argvars[0]);
8642 #ifdef FEAT_WINDOWS
8643 for (wp = firstwin; wp; wp = wp->w_next)
8645 ++winnr;
8646 if (wp->w_buffer == buf)
8647 break;
8649 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8650 #else
8651 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8652 #endif
8653 --emsg_off;
8657 * "byte2line(byte)" function
8659 /*ARGSUSED*/
8660 static void
8661 f_byte2line(argvars, rettv)
8662 typval_T *argvars;
8663 typval_T *rettv;
8665 #ifndef FEAT_BYTEOFF
8666 rettv->vval.v_number = -1;
8667 #else
8668 long boff = 0;
8670 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8671 if (boff < 0)
8672 rettv->vval.v_number = -1;
8673 else
8674 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8675 (linenr_T)0, &boff);
8676 #endif
8680 * "byteidx()" function
8682 /*ARGSUSED*/
8683 static void
8684 f_byteidx(argvars, rettv)
8685 typval_T *argvars;
8686 typval_T *rettv;
8688 #ifdef FEAT_MBYTE
8689 char_u *t;
8690 #endif
8691 char_u *str;
8692 long idx;
8694 str = get_tv_string_chk(&argvars[0]);
8695 idx = get_tv_number_chk(&argvars[1], NULL);
8696 rettv->vval.v_number = -1;
8697 if (str == NULL || idx < 0)
8698 return;
8700 #ifdef FEAT_MBYTE
8701 t = str;
8702 for ( ; idx > 0; idx--)
8704 if (*t == NUL) /* EOL reached */
8705 return;
8706 t += (*mb_ptr2len)(t);
8708 rettv->vval.v_number = (varnumber_T)(t - str);
8709 #else
8710 if ((size_t)idx <= STRLEN(str))
8711 rettv->vval.v_number = idx;
8712 #endif
8716 * "call(func, arglist)" function
8718 static void
8719 f_call(argvars, rettv)
8720 typval_T *argvars;
8721 typval_T *rettv;
8723 char_u *func;
8724 typval_T argv[MAX_FUNC_ARGS + 1];
8725 int argc = 0;
8726 listitem_T *item;
8727 int dummy;
8728 dict_T *selfdict = NULL;
8730 rettv->vval.v_number = 0;
8731 if (argvars[1].v_type != VAR_LIST)
8733 EMSG(_(e_listreq));
8734 return;
8736 if (argvars[1].vval.v_list == NULL)
8737 return;
8739 if (argvars[0].v_type == VAR_FUNC)
8740 func = argvars[0].vval.v_string;
8741 else
8742 func = get_tv_string(&argvars[0]);
8743 if (*func == NUL)
8744 return; /* type error or empty name */
8746 if (argvars[2].v_type != VAR_UNKNOWN)
8748 if (argvars[2].v_type != VAR_DICT)
8750 EMSG(_(e_dictreq));
8751 return;
8753 selfdict = argvars[2].vval.v_dict;
8756 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8757 item = item->li_next)
8759 if (argc == MAX_FUNC_ARGS)
8761 EMSG(_("E699: Too many arguments"));
8762 break;
8764 /* Make a copy of each argument. This is needed to be able to set
8765 * v_lock to VAR_FIXED in the copy without changing the original list.
8767 copy_tv(&item->li_tv, &argv[argc++]);
8770 if (item == NULL)
8771 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8772 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8773 &dummy, TRUE, selfdict);
8775 /* Free the arguments. */
8776 while (argc > 0)
8777 clear_tv(&argv[--argc]);
8780 #ifdef FEAT_FLOAT
8782 * "ceil({float})" function
8784 static void
8785 f_ceil(argvars, rettv)
8786 typval_T *argvars;
8787 typval_T *rettv;
8789 float_T f;
8791 rettv->v_type = VAR_FLOAT;
8792 if (get_float_arg(argvars, &f) == OK)
8793 rettv->vval.v_float = ceil(f);
8794 else
8795 rettv->vval.v_float = 0.0;
8797 #endif
8800 * "changenr()" function
8802 /*ARGSUSED*/
8803 static void
8804 f_changenr(argvars, rettv)
8805 typval_T *argvars;
8806 typval_T *rettv;
8808 rettv->vval.v_number = curbuf->b_u_seq_cur;
8812 * "char2nr(string)" function
8814 static void
8815 f_char2nr(argvars, rettv)
8816 typval_T *argvars;
8817 typval_T *rettv;
8819 #ifdef FEAT_MBYTE
8820 if (has_mbyte)
8821 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8822 else
8823 #endif
8824 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8828 * "cindent(lnum)" function
8830 static void
8831 f_cindent(argvars, rettv)
8832 typval_T *argvars;
8833 typval_T *rettv;
8835 #ifdef FEAT_CINDENT
8836 pos_T pos;
8837 linenr_T lnum;
8839 pos = curwin->w_cursor;
8840 lnum = get_tv_lnum(argvars);
8841 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8843 curwin->w_cursor.lnum = lnum;
8844 rettv->vval.v_number = get_c_indent();
8845 curwin->w_cursor = pos;
8847 else
8848 #endif
8849 rettv->vval.v_number = -1;
8853 * "clearmatches()" function
8855 /*ARGSUSED*/
8856 static void
8857 f_clearmatches(argvars, rettv)
8858 typval_T *argvars;
8859 typval_T *rettv;
8861 #ifdef FEAT_SEARCH_EXTRA
8862 clear_matches(curwin);
8863 #endif
8867 * "col(string)" function
8869 static void
8870 f_col(argvars, rettv)
8871 typval_T *argvars;
8872 typval_T *rettv;
8874 colnr_T col = 0;
8875 pos_T *fp;
8876 int fnum = curbuf->b_fnum;
8878 fp = var2fpos(&argvars[0], FALSE, &fnum);
8879 if (fp != NULL && fnum == curbuf->b_fnum)
8881 if (fp->col == MAXCOL)
8883 /* '> can be MAXCOL, get the length of the line then */
8884 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8885 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8886 else
8887 col = MAXCOL;
8889 else
8891 col = fp->col + 1;
8892 #ifdef FEAT_VIRTUALEDIT
8893 /* col(".") when the cursor is on the NUL at the end of the line
8894 * because of "coladd" can be seen as an extra column. */
8895 if (virtual_active() && fp == &curwin->w_cursor)
8897 char_u *p = ml_get_cursor();
8899 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8900 curwin->w_virtcol - curwin->w_cursor.coladd))
8902 # ifdef FEAT_MBYTE
8903 int l;
8905 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8906 col += l;
8907 # else
8908 if (*p != NUL && p[1] == NUL)
8909 ++col;
8910 # endif
8913 #endif
8916 rettv->vval.v_number = col;
8919 #if defined(FEAT_INS_EXPAND)
8921 * "complete()" function
8923 /*ARGSUSED*/
8924 static void
8925 f_complete(argvars, rettv)
8926 typval_T *argvars;
8927 typval_T *rettv;
8929 int startcol;
8931 if ((State & INSERT) == 0)
8933 EMSG(_("E785: complete() can only be used in Insert mode"));
8934 return;
8937 /* Check for undo allowed here, because if something was already inserted
8938 * the line was already saved for undo and this check isn't done. */
8939 if (!undo_allowed())
8940 return;
8942 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8944 EMSG(_(e_invarg));
8945 return;
8948 startcol = get_tv_number_chk(&argvars[0], NULL);
8949 if (startcol <= 0)
8950 return;
8952 set_completion(startcol - 1, argvars[1].vval.v_list);
8956 * "complete_add()" function
8958 /*ARGSUSED*/
8959 static void
8960 f_complete_add(argvars, rettv)
8961 typval_T *argvars;
8962 typval_T *rettv;
8964 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
8968 * "complete_check()" function
8970 /*ARGSUSED*/
8971 static void
8972 f_complete_check(argvars, rettv)
8973 typval_T *argvars;
8974 typval_T *rettv;
8976 int saved = RedrawingDisabled;
8978 RedrawingDisabled = 0;
8979 ins_compl_check_keys(0);
8980 rettv->vval.v_number = compl_interrupted;
8981 RedrawingDisabled = saved;
8983 #endif
8986 * "confirm(message, buttons[, default [, type]])" function
8988 /*ARGSUSED*/
8989 static void
8990 f_confirm(argvars, rettv)
8991 typval_T *argvars;
8992 typval_T *rettv;
8994 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
8995 char_u *message;
8996 char_u *buttons = NULL;
8997 char_u buf[NUMBUFLEN];
8998 char_u buf2[NUMBUFLEN];
8999 int def = 1;
9000 int type = VIM_GENERIC;
9001 char_u *typestr;
9002 int error = FALSE;
9004 message = get_tv_string_chk(&argvars[0]);
9005 if (message == NULL)
9006 error = TRUE;
9007 if (argvars[1].v_type != VAR_UNKNOWN)
9009 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9010 if (buttons == NULL)
9011 error = TRUE;
9012 if (argvars[2].v_type != VAR_UNKNOWN)
9014 def = get_tv_number_chk(&argvars[2], &error);
9015 if (argvars[3].v_type != VAR_UNKNOWN)
9017 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9018 if (typestr == NULL)
9019 error = TRUE;
9020 else
9022 switch (TOUPPER_ASC(*typestr))
9024 case 'E': type = VIM_ERROR; break;
9025 case 'Q': type = VIM_QUESTION; break;
9026 case 'I': type = VIM_INFO; break;
9027 case 'W': type = VIM_WARNING; break;
9028 case 'G': type = VIM_GENERIC; break;
9035 if (buttons == NULL || *buttons == NUL)
9036 buttons = (char_u *)_("&Ok");
9038 if (error)
9039 rettv->vval.v_number = 0;
9040 else
9041 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9042 def, NULL);
9043 #else
9044 rettv->vval.v_number = 0;
9045 #endif
9049 * "copy()" function
9051 static void
9052 f_copy(argvars, rettv)
9053 typval_T *argvars;
9054 typval_T *rettv;
9056 item_copy(&argvars[0], rettv, FALSE, 0);
9059 #ifdef FEAT_FLOAT
9061 * "cos()" function
9063 static void
9064 f_cos(argvars, rettv)
9065 typval_T *argvars;
9066 typval_T *rettv;
9068 float_T f;
9070 rettv->v_type = VAR_FLOAT;
9071 if (get_float_arg(argvars, &f) == OK)
9072 rettv->vval.v_float = cos(f);
9073 else
9074 rettv->vval.v_float = 0.0;
9076 #endif
9079 * "count()" function
9081 static void
9082 f_count(argvars, rettv)
9083 typval_T *argvars;
9084 typval_T *rettv;
9086 long n = 0;
9087 int ic = FALSE;
9089 if (argvars[0].v_type == VAR_LIST)
9091 listitem_T *li;
9092 list_T *l;
9093 long idx;
9095 if ((l = argvars[0].vval.v_list) != NULL)
9097 li = l->lv_first;
9098 if (argvars[2].v_type != VAR_UNKNOWN)
9100 int error = FALSE;
9102 ic = get_tv_number_chk(&argvars[2], &error);
9103 if (argvars[3].v_type != VAR_UNKNOWN)
9105 idx = get_tv_number_chk(&argvars[3], &error);
9106 if (!error)
9108 li = list_find(l, idx);
9109 if (li == NULL)
9110 EMSGN(_(e_listidx), idx);
9113 if (error)
9114 li = NULL;
9117 for ( ; li != NULL; li = li->li_next)
9118 if (tv_equal(&li->li_tv, &argvars[1], ic))
9119 ++n;
9122 else if (argvars[0].v_type == VAR_DICT)
9124 int todo;
9125 dict_T *d;
9126 hashitem_T *hi;
9128 if ((d = argvars[0].vval.v_dict) != NULL)
9130 int error = FALSE;
9132 if (argvars[2].v_type != VAR_UNKNOWN)
9134 ic = get_tv_number_chk(&argvars[2], &error);
9135 if (argvars[3].v_type != VAR_UNKNOWN)
9136 EMSG(_(e_invarg));
9139 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9140 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9142 if (!HASHITEM_EMPTY(hi))
9144 --todo;
9145 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9146 ++n;
9151 else
9152 EMSG2(_(e_listdictarg), "count()");
9153 rettv->vval.v_number = n;
9157 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9159 * Checks the existence of a cscope connection.
9161 /*ARGSUSED*/
9162 static void
9163 f_cscope_connection(argvars, rettv)
9164 typval_T *argvars;
9165 typval_T *rettv;
9167 #ifdef FEAT_CSCOPE
9168 int num = 0;
9169 char_u *dbpath = NULL;
9170 char_u *prepend = NULL;
9171 char_u buf[NUMBUFLEN];
9173 if (argvars[0].v_type != VAR_UNKNOWN
9174 && argvars[1].v_type != VAR_UNKNOWN)
9176 num = (int)get_tv_number(&argvars[0]);
9177 dbpath = get_tv_string(&argvars[1]);
9178 if (argvars[2].v_type != VAR_UNKNOWN)
9179 prepend = get_tv_string_buf(&argvars[2], buf);
9182 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9183 #else
9184 rettv->vval.v_number = 0;
9185 #endif
9189 * "cursor(lnum, col)" function
9191 * Moves the cursor to the specified line and column
9193 /*ARGSUSED*/
9194 static void
9195 f_cursor(argvars, rettv)
9196 typval_T *argvars;
9197 typval_T *rettv;
9199 long line, col;
9200 #ifdef FEAT_VIRTUALEDIT
9201 long coladd = 0;
9202 #endif
9204 if (argvars[1].v_type == VAR_UNKNOWN)
9206 pos_T pos;
9208 if (list2fpos(argvars, &pos, NULL) == FAIL)
9209 return;
9210 line = pos.lnum;
9211 col = pos.col;
9212 #ifdef FEAT_VIRTUALEDIT
9213 coladd = pos.coladd;
9214 #endif
9216 else
9218 line = get_tv_lnum(argvars);
9219 col = get_tv_number_chk(&argvars[1], NULL);
9220 #ifdef FEAT_VIRTUALEDIT
9221 if (argvars[2].v_type != VAR_UNKNOWN)
9222 coladd = get_tv_number_chk(&argvars[2], NULL);
9223 #endif
9225 if (line < 0 || col < 0
9226 #ifdef FEAT_VIRTUALEDIT
9227 || coladd < 0
9228 #endif
9230 return; /* type error; errmsg already given */
9231 if (line > 0)
9232 curwin->w_cursor.lnum = line;
9233 if (col > 0)
9234 curwin->w_cursor.col = col - 1;
9235 #ifdef FEAT_VIRTUALEDIT
9236 curwin->w_cursor.coladd = coladd;
9237 #endif
9239 /* Make sure the cursor is in a valid position. */
9240 check_cursor();
9241 #ifdef FEAT_MBYTE
9242 /* Correct cursor for multi-byte character. */
9243 if (has_mbyte)
9244 mb_adjust_cursor();
9245 #endif
9247 curwin->w_set_curswant = TRUE;
9251 * "deepcopy()" function
9253 static void
9254 f_deepcopy(argvars, rettv)
9255 typval_T *argvars;
9256 typval_T *rettv;
9258 int noref = 0;
9260 if (argvars[1].v_type != VAR_UNKNOWN)
9261 noref = get_tv_number_chk(&argvars[1], NULL);
9262 if (noref < 0 || noref > 1)
9263 EMSG(_(e_invarg));
9264 else
9265 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? ++current_copyID : 0);
9269 * "delete()" function
9271 static void
9272 f_delete(argvars, rettv)
9273 typval_T *argvars;
9274 typval_T *rettv;
9276 if (check_restricted() || check_secure())
9277 rettv->vval.v_number = -1;
9278 else
9279 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9283 * "did_filetype()" function
9285 /*ARGSUSED*/
9286 static void
9287 f_did_filetype(argvars, rettv)
9288 typval_T *argvars;
9289 typval_T *rettv;
9291 #ifdef FEAT_AUTOCMD
9292 rettv->vval.v_number = did_filetype;
9293 #else
9294 rettv->vval.v_number = 0;
9295 #endif
9299 * "diff_filler()" function
9301 /*ARGSUSED*/
9302 static void
9303 f_diff_filler(argvars, rettv)
9304 typval_T *argvars;
9305 typval_T *rettv;
9307 #ifdef FEAT_DIFF
9308 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9309 #endif
9313 * "diff_hlID()" function
9315 /*ARGSUSED*/
9316 static void
9317 f_diff_hlID(argvars, rettv)
9318 typval_T *argvars;
9319 typval_T *rettv;
9321 #ifdef FEAT_DIFF
9322 linenr_T lnum = get_tv_lnum(argvars);
9323 static linenr_T prev_lnum = 0;
9324 static int changedtick = 0;
9325 static int fnum = 0;
9326 static int change_start = 0;
9327 static int change_end = 0;
9328 static hlf_T hlID = (hlf_T)0;
9329 int filler_lines;
9330 int col;
9332 if (lnum < 0) /* ignore type error in {lnum} arg */
9333 lnum = 0;
9334 if (lnum != prev_lnum
9335 || changedtick != curbuf->b_changedtick
9336 || fnum != curbuf->b_fnum)
9338 /* New line, buffer, change: need to get the values. */
9339 filler_lines = diff_check(curwin, lnum);
9340 if (filler_lines < 0)
9342 if (filler_lines == -1)
9344 change_start = MAXCOL;
9345 change_end = -1;
9346 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9347 hlID = HLF_ADD; /* added line */
9348 else
9349 hlID = HLF_CHD; /* changed line */
9351 else
9352 hlID = HLF_ADD; /* added line */
9354 else
9355 hlID = (hlf_T)0;
9356 prev_lnum = lnum;
9357 changedtick = curbuf->b_changedtick;
9358 fnum = curbuf->b_fnum;
9361 if (hlID == HLF_CHD || hlID == HLF_TXD)
9363 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9364 if (col >= change_start && col <= change_end)
9365 hlID = HLF_TXD; /* changed text */
9366 else
9367 hlID = HLF_CHD; /* changed line */
9369 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9370 #endif
9374 * "empty({expr})" function
9376 static void
9377 f_empty(argvars, rettv)
9378 typval_T *argvars;
9379 typval_T *rettv;
9381 int n;
9383 switch (argvars[0].v_type)
9385 case VAR_STRING:
9386 case VAR_FUNC:
9387 n = argvars[0].vval.v_string == NULL
9388 || *argvars[0].vval.v_string == NUL;
9389 break;
9390 case VAR_NUMBER:
9391 n = argvars[0].vval.v_number == 0;
9392 break;
9393 #ifdef FEAT_FLOAT
9394 case VAR_FLOAT:
9395 n = argvars[0].vval.v_float == 0.0;
9396 break;
9397 #endif
9398 case VAR_LIST:
9399 n = argvars[0].vval.v_list == NULL
9400 || argvars[0].vval.v_list->lv_first == NULL;
9401 break;
9402 case VAR_DICT:
9403 n = argvars[0].vval.v_dict == NULL
9404 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9405 break;
9406 default:
9407 EMSG2(_(e_intern2), "f_empty()");
9408 n = 0;
9411 rettv->vval.v_number = n;
9415 * "escape({string}, {chars})" function
9417 static void
9418 f_escape(argvars, rettv)
9419 typval_T *argvars;
9420 typval_T *rettv;
9422 char_u buf[NUMBUFLEN];
9424 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9425 get_tv_string_buf(&argvars[1], buf));
9426 rettv->v_type = VAR_STRING;
9430 * "eval()" function
9432 /*ARGSUSED*/
9433 static void
9434 f_eval(argvars, rettv)
9435 typval_T *argvars;
9436 typval_T *rettv;
9438 char_u *s;
9440 s = get_tv_string_chk(&argvars[0]);
9441 if (s != NULL)
9442 s = skipwhite(s);
9444 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9446 rettv->v_type = VAR_NUMBER;
9447 rettv->vval.v_number = 0;
9449 else if (*s != NUL)
9450 EMSG(_(e_trailing));
9454 * "eventhandler()" function
9456 /*ARGSUSED*/
9457 static void
9458 f_eventhandler(argvars, rettv)
9459 typval_T *argvars;
9460 typval_T *rettv;
9462 rettv->vval.v_number = vgetc_busy;
9466 * "executable()" function
9468 static void
9469 f_executable(argvars, rettv)
9470 typval_T *argvars;
9471 typval_T *rettv;
9473 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9477 * "exists()" function
9479 static void
9480 f_exists(argvars, rettv)
9481 typval_T *argvars;
9482 typval_T *rettv;
9484 char_u *p;
9485 char_u *name;
9486 int n = FALSE;
9487 int len = 0;
9489 p = get_tv_string(&argvars[0]);
9490 if (*p == '$') /* environment variable */
9492 /* first try "normal" environment variables (fast) */
9493 if (mch_getenv(p + 1) != NULL)
9494 n = TRUE;
9495 else
9497 /* try expanding things like $VIM and ${HOME} */
9498 p = expand_env_save(p);
9499 if (p != NULL && *p != '$')
9500 n = TRUE;
9501 vim_free(p);
9504 else if (*p == '&' || *p == '+') /* option */
9506 n = (get_option_tv(&p, NULL, TRUE) == OK);
9507 if (*skipwhite(p) != NUL)
9508 n = FALSE; /* trailing garbage */
9510 else if (*p == '*') /* internal or user defined function */
9512 n = function_exists(p + 1);
9514 else if (*p == ':')
9516 n = cmd_exists(p + 1);
9518 else if (*p == '#')
9520 #ifdef FEAT_AUTOCMD
9521 if (p[1] == '#')
9522 n = autocmd_supported(p + 2);
9523 else
9524 n = au_exists(p + 1);
9525 #endif
9527 else /* internal variable */
9529 char_u *tofree;
9530 typval_T tv;
9532 /* get_name_len() takes care of expanding curly braces */
9533 name = p;
9534 len = get_name_len(&p, &tofree, TRUE, FALSE);
9535 if (len > 0)
9537 if (tofree != NULL)
9538 name = tofree;
9539 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9540 if (n)
9542 /* handle d.key, l[idx], f(expr) */
9543 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9544 if (n)
9545 clear_tv(&tv);
9548 if (*p != NUL)
9549 n = FALSE;
9551 vim_free(tofree);
9554 rettv->vval.v_number = n;
9558 * "expand()" function
9560 static void
9561 f_expand(argvars, rettv)
9562 typval_T *argvars;
9563 typval_T *rettv;
9565 char_u *s;
9566 int len;
9567 char_u *errormsg;
9568 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9569 expand_T xpc;
9570 int error = FALSE;
9572 rettv->v_type = VAR_STRING;
9573 s = get_tv_string(&argvars[0]);
9574 if (*s == '%' || *s == '#' || *s == '<')
9576 ++emsg_off;
9577 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9578 --emsg_off;
9580 else
9582 /* When the optional second argument is non-zero, don't remove matches
9583 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9584 if (argvars[1].v_type != VAR_UNKNOWN
9585 && get_tv_number_chk(&argvars[1], &error))
9586 flags |= WILD_KEEP_ALL;
9587 if (!error)
9589 ExpandInit(&xpc);
9590 xpc.xp_context = EXPAND_FILES;
9591 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9593 else
9594 rettv->vval.v_string = NULL;
9599 * "extend(list, list [, idx])" function
9600 * "extend(dict, dict [, action])" function
9602 static void
9603 f_extend(argvars, rettv)
9604 typval_T *argvars;
9605 typval_T *rettv;
9607 rettv->vval.v_number = 0;
9608 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9610 list_T *l1, *l2;
9611 listitem_T *item;
9612 long before;
9613 int error = FALSE;
9615 l1 = argvars[0].vval.v_list;
9616 l2 = argvars[1].vval.v_list;
9617 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9618 && l2 != NULL)
9620 if (argvars[2].v_type != VAR_UNKNOWN)
9622 before = get_tv_number_chk(&argvars[2], &error);
9623 if (error)
9624 return; /* type error; errmsg already given */
9626 if (before == l1->lv_len)
9627 item = NULL;
9628 else
9630 item = list_find(l1, before);
9631 if (item == NULL)
9633 EMSGN(_(e_listidx), before);
9634 return;
9638 else
9639 item = NULL;
9640 list_extend(l1, l2, item);
9642 copy_tv(&argvars[0], rettv);
9645 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9647 dict_T *d1, *d2;
9648 dictitem_T *di1;
9649 char_u *action;
9650 int i;
9651 hashitem_T *hi2;
9652 int todo;
9654 d1 = argvars[0].vval.v_dict;
9655 d2 = argvars[1].vval.v_dict;
9656 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9657 && d2 != NULL)
9659 /* Check the third argument. */
9660 if (argvars[2].v_type != VAR_UNKNOWN)
9662 static char *(av[]) = {"keep", "force", "error"};
9664 action = get_tv_string_chk(&argvars[2]);
9665 if (action == NULL)
9666 return; /* type error; errmsg already given */
9667 for (i = 0; i < 3; ++i)
9668 if (STRCMP(action, av[i]) == 0)
9669 break;
9670 if (i == 3)
9672 EMSG2(_(e_invarg2), action);
9673 return;
9676 else
9677 action = (char_u *)"force";
9679 /* Go over all entries in the second dict and add them to the
9680 * first dict. */
9681 todo = (int)d2->dv_hashtab.ht_used;
9682 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9684 if (!HASHITEM_EMPTY(hi2))
9686 --todo;
9687 di1 = dict_find(d1, hi2->hi_key, -1);
9688 if (di1 == NULL)
9690 di1 = dictitem_copy(HI2DI(hi2));
9691 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9692 dictitem_free(di1);
9694 else if (*action == 'e')
9696 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9697 break;
9699 else if (*action == 'f')
9701 clear_tv(&di1->di_tv);
9702 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9707 copy_tv(&argvars[0], rettv);
9710 else
9711 EMSG2(_(e_listdictarg), "extend()");
9715 * "feedkeys()" function
9717 /*ARGSUSED*/
9718 static void
9719 f_feedkeys(argvars, rettv)
9720 typval_T *argvars;
9721 typval_T *rettv;
9723 int remap = TRUE;
9724 char_u *keys, *flags;
9725 char_u nbuf[NUMBUFLEN];
9726 int typed = FALSE;
9727 char_u *keys_esc;
9729 /* This is not allowed in the sandbox. If the commands would still be
9730 * executed in the sandbox it would be OK, but it probably happens later,
9731 * when "sandbox" is no longer set. */
9732 if (check_secure())
9733 return;
9735 rettv->vval.v_number = 0;
9736 keys = get_tv_string(&argvars[0]);
9737 if (*keys != NUL)
9739 if (argvars[1].v_type != VAR_UNKNOWN)
9741 flags = get_tv_string_buf(&argvars[1], nbuf);
9742 for ( ; *flags != NUL; ++flags)
9744 switch (*flags)
9746 case 'n': remap = FALSE; break;
9747 case 'm': remap = TRUE; break;
9748 case 't': typed = TRUE; break;
9753 /* Need to escape K_SPECIAL and CSI before putting the string in the
9754 * typeahead buffer. */
9755 keys_esc = vim_strsave_escape_csi(keys);
9756 if (keys_esc != NULL)
9758 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9759 typebuf.tb_len, !typed, FALSE);
9760 vim_free(keys_esc);
9761 if (vgetc_busy)
9762 typebuf_was_filled = TRUE;
9768 * "filereadable()" function
9770 static void
9771 f_filereadable(argvars, rettv)
9772 typval_T *argvars;
9773 typval_T *rettv;
9775 int fd;
9776 char_u *p;
9777 int n;
9779 #ifndef O_NONBLOCK
9780 # define O_NONBLOCK 0
9781 #endif
9782 p = get_tv_string(&argvars[0]);
9783 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9784 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9786 n = TRUE;
9787 close(fd);
9789 else
9790 n = FALSE;
9792 rettv->vval.v_number = n;
9796 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9797 * rights to write into.
9799 static void
9800 f_filewritable(argvars, rettv)
9801 typval_T *argvars;
9802 typval_T *rettv;
9804 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9807 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9809 static void
9810 findfilendir(argvars, rettv, find_what)
9811 typval_T *argvars;
9812 typval_T *rettv;
9813 int find_what;
9815 #ifdef FEAT_SEARCHPATH
9816 char_u *fname;
9817 char_u *fresult = NULL;
9818 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9819 char_u *p;
9820 char_u pathbuf[NUMBUFLEN];
9821 int count = 1;
9822 int first = TRUE;
9823 int error = FALSE;
9824 #endif
9826 rettv->vval.v_string = NULL;
9827 rettv->v_type = VAR_STRING;
9829 #ifdef FEAT_SEARCHPATH
9830 fname = get_tv_string(&argvars[0]);
9832 if (argvars[1].v_type != VAR_UNKNOWN)
9834 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9835 if (p == NULL)
9836 error = TRUE;
9837 else
9839 if (*p != NUL)
9840 path = p;
9842 if (argvars[2].v_type != VAR_UNKNOWN)
9843 count = get_tv_number_chk(&argvars[2], &error);
9847 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9848 error = TRUE;
9850 if (*fname != NUL && !error)
9854 if (rettv->v_type == VAR_STRING)
9855 vim_free(fresult);
9856 fresult = find_file_in_path_option(first ? fname : NULL,
9857 first ? (int)STRLEN(fname) : 0,
9858 0, first, path,
9859 find_what,
9860 curbuf->b_ffname,
9861 find_what == FINDFILE_DIR
9862 ? (char_u *)"" : curbuf->b_p_sua);
9863 first = FALSE;
9865 if (fresult != NULL && rettv->v_type == VAR_LIST)
9866 list_append_string(rettv->vval.v_list, fresult, -1);
9868 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9871 if (rettv->v_type == VAR_STRING)
9872 rettv->vval.v_string = fresult;
9873 #endif
9876 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9877 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9880 * Implementation of map() and filter().
9882 static void
9883 filter_map(argvars, rettv, map)
9884 typval_T *argvars;
9885 typval_T *rettv;
9886 int map;
9888 char_u buf[NUMBUFLEN];
9889 char_u *expr;
9890 listitem_T *li, *nli;
9891 list_T *l = NULL;
9892 dictitem_T *di;
9893 hashtab_T *ht;
9894 hashitem_T *hi;
9895 dict_T *d = NULL;
9896 typval_T save_val;
9897 typval_T save_key;
9898 int rem;
9899 int todo;
9900 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9901 int save_did_emsg;
9903 rettv->vval.v_number = 0;
9904 if (argvars[0].v_type == VAR_LIST)
9906 if ((l = argvars[0].vval.v_list) == NULL
9907 || (map && tv_check_lock(l->lv_lock, ermsg)))
9908 return;
9910 else if (argvars[0].v_type == VAR_DICT)
9912 if ((d = argvars[0].vval.v_dict) == NULL
9913 || (map && tv_check_lock(d->dv_lock, ermsg)))
9914 return;
9916 else
9918 EMSG2(_(e_listdictarg), ermsg);
9919 return;
9922 expr = get_tv_string_buf_chk(&argvars[1], buf);
9923 /* On type errors, the preceding call has already displayed an error
9924 * message. Avoid a misleading error message for an empty string that
9925 * was not passed as argument. */
9926 if (expr != NULL)
9928 prepare_vimvar(VV_VAL, &save_val);
9929 expr = skipwhite(expr);
9931 /* We reset "did_emsg" to be able to detect whether an error
9932 * occurred during evaluation of the expression. */
9933 save_did_emsg = did_emsg;
9934 did_emsg = FALSE;
9936 if (argvars[0].v_type == VAR_DICT)
9938 prepare_vimvar(VV_KEY, &save_key);
9939 vimvars[VV_KEY].vv_type = VAR_STRING;
9941 ht = &d->dv_hashtab;
9942 hash_lock(ht);
9943 todo = (int)ht->ht_used;
9944 for (hi = ht->ht_array; todo > 0; ++hi)
9946 if (!HASHITEM_EMPTY(hi))
9948 --todo;
9949 di = HI2DI(hi);
9950 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9951 break;
9952 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9953 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9954 || did_emsg)
9955 break;
9956 if (!map && rem)
9957 dictitem_remove(d, di);
9958 clear_tv(&vimvars[VV_KEY].vv_tv);
9961 hash_unlock(ht);
9963 restore_vimvar(VV_KEY, &save_key);
9965 else
9967 for (li = l->lv_first; li != NULL; li = nli)
9969 if (tv_check_lock(li->li_tv.v_lock, ermsg))
9970 break;
9971 nli = li->li_next;
9972 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
9973 || did_emsg)
9974 break;
9975 if (!map && rem)
9976 listitem_remove(l, li);
9980 restore_vimvar(VV_VAL, &save_val);
9982 did_emsg |= save_did_emsg;
9985 copy_tv(&argvars[0], rettv);
9988 static int
9989 filter_map_one(tv, expr, map, remp)
9990 typval_T *tv;
9991 char_u *expr;
9992 int map;
9993 int *remp;
9995 typval_T rettv;
9996 char_u *s;
9997 int retval = FAIL;
9999 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10000 s = expr;
10001 if (eval1(&s, &rettv, TRUE) == FAIL)
10002 goto theend;
10003 if (*s != NUL) /* check for trailing chars after expr */
10005 EMSG2(_(e_invexpr2), s);
10006 goto theend;
10008 if (map)
10010 /* map(): replace the list item value */
10011 clear_tv(tv);
10012 rettv.v_lock = 0;
10013 *tv = rettv;
10015 else
10017 int error = FALSE;
10019 /* filter(): when expr is zero remove the item */
10020 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10021 clear_tv(&rettv);
10022 /* On type error, nothing has been removed; return FAIL to stop the
10023 * loop. The error message was given by get_tv_number_chk(). */
10024 if (error)
10025 goto theend;
10027 retval = OK;
10028 theend:
10029 clear_tv(&vimvars[VV_VAL].vv_tv);
10030 return retval;
10034 * "filter()" function
10036 static void
10037 f_filter(argvars, rettv)
10038 typval_T *argvars;
10039 typval_T *rettv;
10041 filter_map(argvars, rettv, FALSE);
10045 * "finddir({fname}[, {path}[, {count}]])" function
10047 static void
10048 f_finddir(argvars, rettv)
10049 typval_T *argvars;
10050 typval_T *rettv;
10052 findfilendir(argvars, rettv, FINDFILE_DIR);
10056 * "findfile({fname}[, {path}[, {count}]])" function
10058 static void
10059 f_findfile(argvars, rettv)
10060 typval_T *argvars;
10061 typval_T *rettv;
10063 findfilendir(argvars, rettv, FINDFILE_FILE);
10066 #ifdef FEAT_FLOAT
10068 * "float2nr({float})" function
10070 static void
10071 f_float2nr(argvars, rettv)
10072 typval_T *argvars;
10073 typval_T *rettv;
10075 float_T f;
10077 if (get_float_arg(argvars, &f) == OK)
10079 if (f < -0x7fffffff)
10080 rettv->vval.v_number = -0x7fffffff;
10081 else if (f > 0x7fffffff)
10082 rettv->vval.v_number = 0x7fffffff;
10083 else
10084 rettv->vval.v_number = (varnumber_T)f;
10086 else
10087 rettv->vval.v_number = 0;
10091 * "floor({float})" function
10093 static void
10094 f_floor(argvars, rettv)
10095 typval_T *argvars;
10096 typval_T *rettv;
10098 float_T f;
10100 rettv->v_type = VAR_FLOAT;
10101 if (get_float_arg(argvars, &f) == OK)
10102 rettv->vval.v_float = floor(f);
10103 else
10104 rettv->vval.v_float = 0.0;
10106 #endif
10109 * "fnameescape({string})" function
10111 static void
10112 f_fnameescape(argvars, rettv)
10113 typval_T *argvars;
10114 typval_T *rettv;
10116 rettv->vval.v_string = vim_strsave_fnameescape(
10117 get_tv_string(&argvars[0]), FALSE);
10118 rettv->v_type = VAR_STRING;
10122 * "fnamemodify({fname}, {mods})" function
10124 static void
10125 f_fnamemodify(argvars, rettv)
10126 typval_T *argvars;
10127 typval_T *rettv;
10129 char_u *fname;
10130 char_u *mods;
10131 int usedlen = 0;
10132 int len;
10133 char_u *fbuf = NULL;
10134 char_u buf[NUMBUFLEN];
10136 fname = get_tv_string_chk(&argvars[0]);
10137 mods = get_tv_string_buf_chk(&argvars[1], buf);
10138 if (fname == NULL || mods == NULL)
10139 fname = NULL;
10140 else
10142 len = (int)STRLEN(fname);
10143 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10146 rettv->v_type = VAR_STRING;
10147 if (fname == NULL)
10148 rettv->vval.v_string = NULL;
10149 else
10150 rettv->vval.v_string = vim_strnsave(fname, len);
10151 vim_free(fbuf);
10154 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10157 * "foldclosed()" function
10159 static void
10160 foldclosed_both(argvars, rettv, end)
10161 typval_T *argvars;
10162 typval_T *rettv;
10163 int end;
10165 #ifdef FEAT_FOLDING
10166 linenr_T lnum;
10167 linenr_T first, last;
10169 lnum = get_tv_lnum(argvars);
10170 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10172 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10174 if (end)
10175 rettv->vval.v_number = (varnumber_T)last;
10176 else
10177 rettv->vval.v_number = (varnumber_T)first;
10178 return;
10181 #endif
10182 rettv->vval.v_number = -1;
10186 * "foldclosed()" function
10188 static void
10189 f_foldclosed(argvars, rettv)
10190 typval_T *argvars;
10191 typval_T *rettv;
10193 foldclosed_both(argvars, rettv, FALSE);
10197 * "foldclosedend()" function
10199 static void
10200 f_foldclosedend(argvars, rettv)
10201 typval_T *argvars;
10202 typval_T *rettv;
10204 foldclosed_both(argvars, rettv, TRUE);
10208 * "foldlevel()" function
10210 static void
10211 f_foldlevel(argvars, rettv)
10212 typval_T *argvars;
10213 typval_T *rettv;
10215 #ifdef FEAT_FOLDING
10216 linenr_T lnum;
10218 lnum = get_tv_lnum(argvars);
10219 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10220 rettv->vval.v_number = foldLevel(lnum);
10221 else
10222 #endif
10223 rettv->vval.v_number = 0;
10227 * "foldtext()" function
10229 /*ARGSUSED*/
10230 static void
10231 f_foldtext(argvars, rettv)
10232 typval_T *argvars;
10233 typval_T *rettv;
10235 #ifdef FEAT_FOLDING
10236 linenr_T lnum;
10237 char_u *s;
10238 char_u *r;
10239 int len;
10240 char *txt;
10241 #endif
10243 rettv->v_type = VAR_STRING;
10244 rettv->vval.v_string = NULL;
10245 #ifdef FEAT_FOLDING
10246 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10247 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10248 <= curbuf->b_ml.ml_line_count
10249 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10251 /* Find first non-empty line in the fold. */
10252 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10253 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10255 if (!linewhite(lnum))
10256 break;
10257 ++lnum;
10260 /* Find interesting text in this line. */
10261 s = skipwhite(ml_get(lnum));
10262 /* skip C comment-start */
10263 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10265 s = skipwhite(s + 2);
10266 if (*skipwhite(s) == NUL
10267 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10269 s = skipwhite(ml_get(lnum + 1));
10270 if (*s == '*')
10271 s = skipwhite(s + 1);
10274 txt = _("+-%s%3ld lines: ");
10275 r = alloc((unsigned)(STRLEN(txt)
10276 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10277 + 20 /* for %3ld */
10278 + STRLEN(s))); /* concatenated */
10279 if (r != NULL)
10281 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10282 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10283 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10284 len = (int)STRLEN(r);
10285 STRCAT(r, s);
10286 /* remove 'foldmarker' and 'commentstring' */
10287 foldtext_cleanup(r + len);
10288 rettv->vval.v_string = r;
10291 #endif
10295 * "foldtextresult(lnum)" function
10297 /*ARGSUSED*/
10298 static void
10299 f_foldtextresult(argvars, rettv)
10300 typval_T *argvars;
10301 typval_T *rettv;
10303 #ifdef FEAT_FOLDING
10304 linenr_T lnum;
10305 char_u *text;
10306 char_u buf[51];
10307 foldinfo_T foldinfo;
10308 int fold_count;
10309 #endif
10311 rettv->v_type = VAR_STRING;
10312 rettv->vval.v_string = NULL;
10313 #ifdef FEAT_FOLDING
10314 lnum = get_tv_lnum(argvars);
10315 /* treat illegal types and illegal string values for {lnum} the same */
10316 if (lnum < 0)
10317 lnum = 0;
10318 fold_count = foldedCount(curwin, lnum, &foldinfo);
10319 if (fold_count > 0)
10321 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10322 &foldinfo, buf);
10323 if (text == buf)
10324 text = vim_strsave(text);
10325 rettv->vval.v_string = text;
10327 #endif
10331 * "foreground()" function
10333 /*ARGSUSED*/
10334 static void
10335 f_foreground(argvars, rettv)
10336 typval_T *argvars;
10337 typval_T *rettv;
10339 rettv->vval.v_number = 0;
10340 #ifdef FEAT_GUI
10341 if (gui.in_use)
10342 gui_mch_set_foreground();
10343 #else
10344 # ifdef WIN32
10345 win32_set_foreground();
10346 # endif
10347 #endif
10351 * "function()" function
10353 /*ARGSUSED*/
10354 static void
10355 f_function(argvars, rettv)
10356 typval_T *argvars;
10357 typval_T *rettv;
10359 char_u *s;
10361 rettv->vval.v_number = 0;
10362 s = get_tv_string(&argvars[0]);
10363 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10364 EMSG2(_(e_invarg2), s);
10365 /* Don't check an autoload name for existence here. */
10366 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10367 EMSG2(_("E700: Unknown function: %s"), s);
10368 else
10370 rettv->vval.v_string = vim_strsave(s);
10371 rettv->v_type = VAR_FUNC;
10376 * "garbagecollect()" function
10378 /*ARGSUSED*/
10379 static void
10380 f_garbagecollect(argvars, rettv)
10381 typval_T *argvars;
10382 typval_T *rettv;
10384 /* This is postponed until we are back at the toplevel, because we may be
10385 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10386 want_garbage_collect = TRUE;
10388 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10389 garbage_collect_at_exit = TRUE;
10393 * "get()" function
10395 static void
10396 f_get(argvars, rettv)
10397 typval_T *argvars;
10398 typval_T *rettv;
10400 listitem_T *li;
10401 list_T *l;
10402 dictitem_T *di;
10403 dict_T *d;
10404 typval_T *tv = NULL;
10406 if (argvars[0].v_type == VAR_LIST)
10408 if ((l = argvars[0].vval.v_list) != NULL)
10410 int error = FALSE;
10412 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10413 if (!error && li != NULL)
10414 tv = &li->li_tv;
10417 else if (argvars[0].v_type == VAR_DICT)
10419 if ((d = argvars[0].vval.v_dict) != NULL)
10421 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10422 if (di != NULL)
10423 tv = &di->di_tv;
10426 else
10427 EMSG2(_(e_listdictarg), "get()");
10429 if (tv == NULL)
10431 if (argvars[2].v_type == VAR_UNKNOWN)
10432 rettv->vval.v_number = 0;
10433 else
10434 copy_tv(&argvars[2], rettv);
10436 else
10437 copy_tv(tv, rettv);
10440 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10443 * Get line or list of lines from buffer "buf" into "rettv".
10444 * Return a range (from start to end) of lines in rettv from the specified
10445 * buffer.
10446 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10448 static void
10449 get_buffer_lines(buf, start, end, retlist, rettv)
10450 buf_T *buf;
10451 linenr_T start;
10452 linenr_T end;
10453 int retlist;
10454 typval_T *rettv;
10456 char_u *p;
10458 if (retlist)
10460 if (rettv_list_alloc(rettv) == FAIL)
10461 return;
10463 else
10464 rettv->vval.v_number = 0;
10466 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10467 return;
10469 if (!retlist)
10471 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10472 p = ml_get_buf(buf, start, FALSE);
10473 else
10474 p = (char_u *)"";
10476 rettv->v_type = VAR_STRING;
10477 rettv->vval.v_string = vim_strsave(p);
10479 else
10481 if (end < start)
10482 return;
10484 if (start < 1)
10485 start = 1;
10486 if (end > buf->b_ml.ml_line_count)
10487 end = buf->b_ml.ml_line_count;
10488 while (start <= end)
10489 if (list_append_string(rettv->vval.v_list,
10490 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10491 break;
10496 * "getbufline()" function
10498 static void
10499 f_getbufline(argvars, rettv)
10500 typval_T *argvars;
10501 typval_T *rettv;
10503 linenr_T lnum;
10504 linenr_T end;
10505 buf_T *buf;
10507 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10508 ++emsg_off;
10509 buf = get_buf_tv(&argvars[0]);
10510 --emsg_off;
10512 lnum = get_tv_lnum_buf(&argvars[1], buf);
10513 if (argvars[2].v_type == VAR_UNKNOWN)
10514 end = lnum;
10515 else
10516 end = get_tv_lnum_buf(&argvars[2], buf);
10518 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10522 * "getbufvar()" function
10524 static void
10525 f_getbufvar(argvars, rettv)
10526 typval_T *argvars;
10527 typval_T *rettv;
10529 buf_T *buf;
10530 buf_T *save_curbuf;
10531 char_u *varname;
10532 dictitem_T *v;
10534 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10535 varname = get_tv_string_chk(&argvars[1]);
10536 ++emsg_off;
10537 buf = get_buf_tv(&argvars[0]);
10539 rettv->v_type = VAR_STRING;
10540 rettv->vval.v_string = NULL;
10542 if (buf != NULL && varname != NULL)
10544 /* set curbuf to be our buf, temporarily */
10545 save_curbuf = curbuf;
10546 curbuf = buf;
10548 if (*varname == '&') /* buffer-local-option */
10549 get_option_tv(&varname, rettv, TRUE);
10550 else
10552 if (*varname == NUL)
10553 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10554 * scope prefix before the NUL byte is required by
10555 * find_var_in_ht(). */
10556 varname = (char_u *)"b:" + 2;
10557 /* look up the variable */
10558 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10559 if (v != NULL)
10560 copy_tv(&v->di_tv, rettv);
10563 /* restore previous notion of curbuf */
10564 curbuf = save_curbuf;
10567 --emsg_off;
10571 * "getchar()" function
10573 static void
10574 f_getchar(argvars, rettv)
10575 typval_T *argvars;
10576 typval_T *rettv;
10578 varnumber_T n;
10579 int error = FALSE;
10581 /* Position the cursor. Needed after a message that ends in a space. */
10582 windgoto(msg_row, msg_col);
10584 ++no_mapping;
10585 ++allow_keys;
10586 for (;;)
10588 if (argvars[0].v_type == VAR_UNKNOWN)
10589 /* getchar(): blocking wait. */
10590 n = safe_vgetc();
10591 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10592 /* getchar(1): only check if char avail */
10593 n = vpeekc();
10594 else if (error || vpeekc() == NUL)
10595 /* illegal argument or getchar(0) and no char avail: return zero */
10596 n = 0;
10597 else
10598 /* getchar(0) and char avail: return char */
10599 n = safe_vgetc();
10600 if (n == K_IGNORE)
10601 continue;
10602 break;
10604 --no_mapping;
10605 --allow_keys;
10607 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10608 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10609 vimvars[VV_MOUSE_COL].vv_nr = 0;
10611 rettv->vval.v_number = n;
10612 if (IS_SPECIAL(n) || mod_mask != 0)
10614 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10615 int i = 0;
10617 /* Turn a special key into three bytes, plus modifier. */
10618 if (mod_mask != 0)
10620 temp[i++] = K_SPECIAL;
10621 temp[i++] = KS_MODIFIER;
10622 temp[i++] = mod_mask;
10624 if (IS_SPECIAL(n))
10626 temp[i++] = K_SPECIAL;
10627 temp[i++] = K_SECOND(n);
10628 temp[i++] = K_THIRD(n);
10630 #ifdef FEAT_MBYTE
10631 else if (has_mbyte)
10632 i += (*mb_char2bytes)(n, temp + i);
10633 #endif
10634 else
10635 temp[i++] = n;
10636 temp[i++] = NUL;
10637 rettv->v_type = VAR_STRING;
10638 rettv->vval.v_string = vim_strsave(temp);
10640 #ifdef FEAT_MOUSE
10641 if (n == K_LEFTMOUSE
10642 || n == K_LEFTMOUSE_NM
10643 || n == K_LEFTDRAG
10644 || n == K_LEFTRELEASE
10645 || n == K_LEFTRELEASE_NM
10646 || n == K_MIDDLEMOUSE
10647 || n == K_MIDDLEDRAG
10648 || n == K_MIDDLERELEASE
10649 || n == K_RIGHTMOUSE
10650 || n == K_RIGHTDRAG
10651 || n == K_RIGHTRELEASE
10652 || n == K_X1MOUSE
10653 || n == K_X1DRAG
10654 || n == K_X1RELEASE
10655 || n == K_X2MOUSE
10656 || n == K_X2DRAG
10657 || n == K_X2RELEASE
10658 || n == K_MOUSEDOWN
10659 || n == K_MOUSEUP)
10661 int row = mouse_row;
10662 int col = mouse_col;
10663 win_T *win;
10664 linenr_T lnum;
10665 # ifdef FEAT_WINDOWS
10666 win_T *wp;
10667 # endif
10668 int winnr = 1;
10670 if (row >= 0 && col >= 0)
10672 /* Find the window at the mouse coordinates and compute the
10673 * text position. */
10674 win = mouse_find_win(&row, &col);
10675 (void)mouse_comp_pos(win, &row, &col, &lnum);
10676 # ifdef FEAT_WINDOWS
10677 for (wp = firstwin; wp != win; wp = wp->w_next)
10678 ++winnr;
10679 # endif
10680 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10681 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10682 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10685 #endif
10690 * "getcharmod()" function
10692 /*ARGSUSED*/
10693 static void
10694 f_getcharmod(argvars, rettv)
10695 typval_T *argvars;
10696 typval_T *rettv;
10698 rettv->vval.v_number = mod_mask;
10702 * "getcmdline()" function
10704 /*ARGSUSED*/
10705 static void
10706 f_getcmdline(argvars, rettv)
10707 typval_T *argvars;
10708 typval_T *rettv;
10710 rettv->v_type = VAR_STRING;
10711 rettv->vval.v_string = get_cmdline_str();
10715 * "getcmdpos()" function
10717 /*ARGSUSED*/
10718 static void
10719 f_getcmdpos(argvars, rettv)
10720 typval_T *argvars;
10721 typval_T *rettv;
10723 rettv->vval.v_number = get_cmdline_pos() + 1;
10727 * "getcmdtype()" function
10729 /*ARGSUSED*/
10730 static void
10731 f_getcmdtype(argvars, rettv)
10732 typval_T *argvars;
10733 typval_T *rettv;
10735 rettv->v_type = VAR_STRING;
10736 rettv->vval.v_string = alloc(2);
10737 if (rettv->vval.v_string != NULL)
10739 rettv->vval.v_string[0] = get_cmdline_type();
10740 rettv->vval.v_string[1] = NUL;
10745 * "getcwd()" function
10747 /*ARGSUSED*/
10748 static void
10749 f_getcwd(argvars, rettv)
10750 typval_T *argvars;
10751 typval_T *rettv;
10753 char_u cwd[MAXPATHL];
10755 rettv->v_type = VAR_STRING;
10756 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10757 rettv->vval.v_string = NULL;
10758 else
10760 rettv->vval.v_string = vim_strsave(cwd);
10761 #ifdef BACKSLASH_IN_FILENAME
10762 if (rettv->vval.v_string != NULL)
10763 slash_adjust(rettv->vval.v_string);
10764 #endif
10769 * "getfontname()" function
10771 /*ARGSUSED*/
10772 static void
10773 f_getfontname(argvars, rettv)
10774 typval_T *argvars;
10775 typval_T *rettv;
10777 rettv->v_type = VAR_STRING;
10778 rettv->vval.v_string = NULL;
10779 #ifdef FEAT_GUI
10780 if (gui.in_use)
10782 GuiFont font;
10783 char_u *name = NULL;
10785 if (argvars[0].v_type == VAR_UNKNOWN)
10787 /* Get the "Normal" font. Either the name saved by
10788 * hl_set_font_name() or from the font ID. */
10789 font = gui.norm_font;
10790 name = hl_get_font_name();
10792 else
10794 name = get_tv_string(&argvars[0]);
10795 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10796 return;
10797 font = gui_mch_get_font(name, FALSE);
10798 if (font == NOFONT)
10799 return; /* Invalid font name, return empty string. */
10801 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10802 if (argvars[0].v_type != VAR_UNKNOWN)
10803 gui_mch_free_font(font);
10805 #endif
10809 * "getfperm({fname})" function
10811 static void
10812 f_getfperm(argvars, rettv)
10813 typval_T *argvars;
10814 typval_T *rettv;
10816 char_u *fname;
10817 struct stat st;
10818 char_u *perm = NULL;
10819 char_u flags[] = "rwx";
10820 int i;
10822 fname = get_tv_string(&argvars[0]);
10824 rettv->v_type = VAR_STRING;
10825 if (mch_stat((char *)fname, &st) >= 0)
10827 perm = vim_strsave((char_u *)"---------");
10828 if (perm != NULL)
10830 for (i = 0; i < 9; i++)
10832 if (st.st_mode & (1 << (8 - i)))
10833 perm[i] = flags[i % 3];
10837 rettv->vval.v_string = perm;
10841 * "getfsize({fname})" function
10843 static void
10844 f_getfsize(argvars, rettv)
10845 typval_T *argvars;
10846 typval_T *rettv;
10848 char_u *fname;
10849 struct stat st;
10851 fname = get_tv_string(&argvars[0]);
10853 rettv->v_type = VAR_NUMBER;
10855 if (mch_stat((char *)fname, &st) >= 0)
10857 if (mch_isdir(fname))
10858 rettv->vval.v_number = 0;
10859 else
10861 rettv->vval.v_number = (varnumber_T)st.st_size;
10863 /* non-perfect check for overflow */
10864 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10865 rettv->vval.v_number = -2;
10868 else
10869 rettv->vval.v_number = -1;
10873 * "getftime({fname})" function
10875 static void
10876 f_getftime(argvars, rettv)
10877 typval_T *argvars;
10878 typval_T *rettv;
10880 char_u *fname;
10881 struct stat st;
10883 fname = get_tv_string(&argvars[0]);
10885 if (mch_stat((char *)fname, &st) >= 0)
10886 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10887 else
10888 rettv->vval.v_number = -1;
10892 * "getftype({fname})" function
10894 static void
10895 f_getftype(argvars, rettv)
10896 typval_T *argvars;
10897 typval_T *rettv;
10899 char_u *fname;
10900 struct stat st;
10901 char_u *type = NULL;
10902 char *t;
10904 fname = get_tv_string(&argvars[0]);
10906 rettv->v_type = VAR_STRING;
10907 if (mch_lstat((char *)fname, &st) >= 0)
10909 #ifdef S_ISREG
10910 if (S_ISREG(st.st_mode))
10911 t = "file";
10912 else if (S_ISDIR(st.st_mode))
10913 t = "dir";
10914 # ifdef S_ISLNK
10915 else if (S_ISLNK(st.st_mode))
10916 t = "link";
10917 # endif
10918 # ifdef S_ISBLK
10919 else if (S_ISBLK(st.st_mode))
10920 t = "bdev";
10921 # endif
10922 # ifdef S_ISCHR
10923 else if (S_ISCHR(st.st_mode))
10924 t = "cdev";
10925 # endif
10926 # ifdef S_ISFIFO
10927 else if (S_ISFIFO(st.st_mode))
10928 t = "fifo";
10929 # endif
10930 # ifdef S_ISSOCK
10931 else if (S_ISSOCK(st.st_mode))
10932 t = "fifo";
10933 # endif
10934 else
10935 t = "other";
10936 #else
10937 # ifdef S_IFMT
10938 switch (st.st_mode & S_IFMT)
10940 case S_IFREG: t = "file"; break;
10941 case S_IFDIR: t = "dir"; break;
10942 # ifdef S_IFLNK
10943 case S_IFLNK: t = "link"; break;
10944 # endif
10945 # ifdef S_IFBLK
10946 case S_IFBLK: t = "bdev"; break;
10947 # endif
10948 # ifdef S_IFCHR
10949 case S_IFCHR: t = "cdev"; break;
10950 # endif
10951 # ifdef S_IFIFO
10952 case S_IFIFO: t = "fifo"; break;
10953 # endif
10954 # ifdef S_IFSOCK
10955 case S_IFSOCK: t = "socket"; break;
10956 # endif
10957 default: t = "other";
10959 # else
10960 if (mch_isdir(fname))
10961 t = "dir";
10962 else
10963 t = "file";
10964 # endif
10965 #endif
10966 type = vim_strsave((char_u *)t);
10968 rettv->vval.v_string = type;
10972 * "getline(lnum, [end])" function
10974 static void
10975 f_getline(argvars, rettv)
10976 typval_T *argvars;
10977 typval_T *rettv;
10979 linenr_T lnum;
10980 linenr_T end;
10981 int retlist;
10983 lnum = get_tv_lnum(argvars);
10984 if (argvars[1].v_type == VAR_UNKNOWN)
10986 end = 0;
10987 retlist = FALSE;
10989 else
10991 end = get_tv_lnum(&argvars[1]);
10992 retlist = TRUE;
10995 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
10999 * "getmatches()" function
11001 /*ARGSUSED*/
11002 static void
11003 f_getmatches(argvars, rettv)
11004 typval_T *argvars;
11005 typval_T *rettv;
11007 #ifdef FEAT_SEARCH_EXTRA
11008 dict_T *dict;
11009 matchitem_T *cur = curwin->w_match_head;
11011 rettv->vval.v_number = 0;
11013 if (rettv_list_alloc(rettv) == OK)
11015 while (cur != NULL)
11017 dict = dict_alloc();
11018 if (dict == NULL)
11019 return;
11020 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11021 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11022 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11023 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11024 list_append_dict(rettv->vval.v_list, dict);
11025 cur = cur->next;
11028 #endif
11032 * "getpid()" function
11034 /*ARGSUSED*/
11035 static void
11036 f_getpid(argvars, rettv)
11037 typval_T *argvars;
11038 typval_T *rettv;
11040 rettv->vval.v_number = mch_get_pid();
11044 * "getpos(string)" function
11046 static void
11047 f_getpos(argvars, rettv)
11048 typval_T *argvars;
11049 typval_T *rettv;
11051 pos_T *fp;
11052 list_T *l;
11053 int fnum = -1;
11055 if (rettv_list_alloc(rettv) == OK)
11057 l = rettv->vval.v_list;
11058 fp = var2fpos(&argvars[0], TRUE, &fnum);
11059 if (fnum != -1)
11060 list_append_number(l, (varnumber_T)fnum);
11061 else
11062 list_append_number(l, (varnumber_T)0);
11063 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11064 : (varnumber_T)0);
11065 list_append_number(l, (fp != NULL)
11066 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11067 : (varnumber_T)0);
11068 list_append_number(l,
11069 #ifdef FEAT_VIRTUALEDIT
11070 (fp != NULL) ? (varnumber_T)fp->coladd :
11071 #endif
11072 (varnumber_T)0);
11074 else
11075 rettv->vval.v_number = FALSE;
11079 * "getqflist()" and "getloclist()" functions
11081 /*ARGSUSED*/
11082 static void
11083 f_getqflist(argvars, rettv)
11084 typval_T *argvars;
11085 typval_T *rettv;
11087 #ifdef FEAT_QUICKFIX
11088 win_T *wp;
11089 #endif
11091 rettv->vval.v_number = 0;
11092 #ifdef FEAT_QUICKFIX
11093 if (rettv_list_alloc(rettv) == OK)
11095 wp = NULL;
11096 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11098 wp = find_win_by_nr(&argvars[0], NULL);
11099 if (wp == NULL)
11100 return;
11103 (void)get_errorlist(wp, rettv->vval.v_list);
11105 #endif
11109 * "getreg()" function
11111 static void
11112 f_getreg(argvars, rettv)
11113 typval_T *argvars;
11114 typval_T *rettv;
11116 char_u *strregname;
11117 int regname;
11118 int arg2 = FALSE;
11119 int error = FALSE;
11121 if (argvars[0].v_type != VAR_UNKNOWN)
11123 strregname = get_tv_string_chk(&argvars[0]);
11124 error = strregname == NULL;
11125 if (argvars[1].v_type != VAR_UNKNOWN)
11126 arg2 = get_tv_number_chk(&argvars[1], &error);
11128 else
11129 strregname = vimvars[VV_REG].vv_str;
11130 regname = (strregname == NULL ? '"' : *strregname);
11131 if (regname == 0)
11132 regname = '"';
11134 rettv->v_type = VAR_STRING;
11135 rettv->vval.v_string = error ? NULL :
11136 get_reg_contents(regname, TRUE, arg2);
11140 * "getregtype()" function
11142 static void
11143 f_getregtype(argvars, rettv)
11144 typval_T *argvars;
11145 typval_T *rettv;
11147 char_u *strregname;
11148 int regname;
11149 char_u buf[NUMBUFLEN + 2];
11150 long reglen = 0;
11152 if (argvars[0].v_type != VAR_UNKNOWN)
11154 strregname = get_tv_string_chk(&argvars[0]);
11155 if (strregname == NULL) /* type error; errmsg already given */
11157 rettv->v_type = VAR_STRING;
11158 rettv->vval.v_string = NULL;
11159 return;
11162 else
11163 /* Default to v:register */
11164 strregname = vimvars[VV_REG].vv_str;
11166 regname = (strregname == NULL ? '"' : *strregname);
11167 if (regname == 0)
11168 regname = '"';
11170 buf[0] = NUL;
11171 buf[1] = NUL;
11172 switch (get_reg_type(regname, &reglen))
11174 case MLINE: buf[0] = 'V'; break;
11175 case MCHAR: buf[0] = 'v'; break;
11176 #ifdef FEAT_VISUAL
11177 case MBLOCK:
11178 buf[0] = Ctrl_V;
11179 sprintf((char *)buf + 1, "%ld", reglen + 1);
11180 break;
11181 #endif
11183 rettv->v_type = VAR_STRING;
11184 rettv->vval.v_string = vim_strsave(buf);
11188 * "gettabwinvar()" function
11190 static void
11191 f_gettabwinvar(argvars, rettv)
11192 typval_T *argvars;
11193 typval_T *rettv;
11195 getwinvar(argvars, rettv, 1);
11199 * "getwinposx()" function
11201 /*ARGSUSED*/
11202 static void
11203 f_getwinposx(argvars, rettv)
11204 typval_T *argvars;
11205 typval_T *rettv;
11207 rettv->vval.v_number = -1;
11208 #ifdef FEAT_GUI
11209 if (gui.in_use)
11211 int x, y;
11213 if (gui_mch_get_winpos(&x, &y) == OK)
11214 rettv->vval.v_number = x;
11216 #endif
11220 * "getwinposy()" function
11222 /*ARGSUSED*/
11223 static void
11224 f_getwinposy(argvars, rettv)
11225 typval_T *argvars;
11226 typval_T *rettv;
11228 rettv->vval.v_number = -1;
11229 #ifdef FEAT_GUI
11230 if (gui.in_use)
11232 int x, y;
11234 if (gui_mch_get_winpos(&x, &y) == OK)
11235 rettv->vval.v_number = y;
11237 #endif
11241 * Find window specified by "vp" in tabpage "tp".
11243 static win_T *
11244 find_win_by_nr(vp, tp)
11245 typval_T *vp;
11246 tabpage_T *tp; /* NULL for current tab page */
11248 #ifdef FEAT_WINDOWS
11249 win_T *wp;
11250 #endif
11251 int nr;
11253 nr = get_tv_number_chk(vp, NULL);
11255 #ifdef FEAT_WINDOWS
11256 if (nr < 0)
11257 return NULL;
11258 if (nr == 0)
11259 return curwin;
11261 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11262 wp != NULL; wp = wp->w_next)
11263 if (--nr <= 0)
11264 break;
11265 return wp;
11266 #else
11267 if (nr == 0 || nr == 1)
11268 return curwin;
11269 return NULL;
11270 #endif
11274 * "getwinvar()" function
11276 static void
11277 f_getwinvar(argvars, rettv)
11278 typval_T *argvars;
11279 typval_T *rettv;
11281 getwinvar(argvars, rettv, 0);
11285 * getwinvar() and gettabwinvar()
11287 static void
11288 getwinvar(argvars, rettv, off)
11289 typval_T *argvars;
11290 typval_T *rettv;
11291 int off; /* 1 for gettabwinvar() */
11293 win_T *win, *oldcurwin;
11294 char_u *varname;
11295 dictitem_T *v;
11296 tabpage_T *tp;
11298 #ifdef FEAT_WINDOWS
11299 if (off == 1)
11300 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11301 else
11302 tp = curtab;
11303 #endif
11304 win = find_win_by_nr(&argvars[off], tp);
11305 varname = get_tv_string_chk(&argvars[off + 1]);
11306 ++emsg_off;
11308 rettv->v_type = VAR_STRING;
11309 rettv->vval.v_string = NULL;
11311 if (win != NULL && varname != NULL)
11313 /* Set curwin to be our win, temporarily. Also set curbuf, so
11314 * that we can get buffer-local options. */
11315 oldcurwin = curwin;
11316 curwin = win;
11317 curbuf = win->w_buffer;
11319 if (*varname == '&') /* window-local-option */
11320 get_option_tv(&varname, rettv, 1);
11321 else
11323 if (*varname == NUL)
11324 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11325 * scope prefix before the NUL byte is required by
11326 * find_var_in_ht(). */
11327 varname = (char_u *)"w:" + 2;
11328 /* look up the variable */
11329 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11330 if (v != NULL)
11331 copy_tv(&v->di_tv, rettv);
11334 /* restore previous notion of curwin */
11335 curwin = oldcurwin;
11336 curbuf = curwin->w_buffer;
11339 --emsg_off;
11343 * "glob()" function
11345 static void
11346 f_glob(argvars, rettv)
11347 typval_T *argvars;
11348 typval_T *rettv;
11350 int flags = WILD_SILENT|WILD_USE_NL;
11351 expand_T xpc;
11352 int error = FALSE;
11354 /* When the optional second argument is non-zero, don't remove matches
11355 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11356 if (argvars[1].v_type != VAR_UNKNOWN
11357 && get_tv_number_chk(&argvars[1], &error))
11358 flags |= WILD_KEEP_ALL;
11359 rettv->v_type = VAR_STRING;
11360 if (!error)
11362 ExpandInit(&xpc);
11363 xpc.xp_context = EXPAND_FILES;
11364 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11365 NULL, flags, WILD_ALL);
11367 else
11368 rettv->vval.v_string = NULL;
11372 * "globpath()" function
11374 static void
11375 f_globpath(argvars, rettv)
11376 typval_T *argvars;
11377 typval_T *rettv;
11379 int flags = 0;
11380 char_u buf1[NUMBUFLEN];
11381 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11382 int error = FALSE;
11384 /* When the optional second argument is non-zero, don't remove matches
11385 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11386 if (argvars[2].v_type != VAR_UNKNOWN
11387 && get_tv_number_chk(&argvars[2], &error))
11388 flags |= WILD_KEEP_ALL;
11389 rettv->v_type = VAR_STRING;
11390 if (file == NULL || error)
11391 rettv->vval.v_string = NULL;
11392 else
11393 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11394 flags);
11398 * "has()" function
11400 static void
11401 f_has(argvars, rettv)
11402 typval_T *argvars;
11403 typval_T *rettv;
11405 int i;
11406 char_u *name;
11407 int n = FALSE;
11408 static char *(has_list[]) =
11410 #ifdef AMIGA
11411 "amiga",
11412 # ifdef FEAT_ARP
11413 "arp",
11414 # endif
11415 #endif
11416 #ifdef __BEOS__
11417 "beos",
11418 #endif
11419 #ifdef MSDOS
11420 # ifdef DJGPP
11421 "dos32",
11422 # else
11423 "dos16",
11424 # endif
11425 #endif
11426 #ifdef MACOS
11427 "mac",
11428 #endif
11429 #if defined(MACOS_X_UNIX)
11430 "macunix",
11431 #endif
11432 #ifdef OS2
11433 "os2",
11434 #endif
11435 #ifdef __QNX__
11436 "qnx",
11437 #endif
11438 #ifdef RISCOS
11439 "riscos",
11440 #endif
11441 #ifdef UNIX
11442 "unix",
11443 #endif
11444 #ifdef VMS
11445 "vms",
11446 #endif
11447 #ifdef WIN16
11448 "win16",
11449 #endif
11450 #ifdef WIN32
11451 "win32",
11452 #endif
11453 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11454 "win32unix",
11455 #endif
11456 #ifdef WIN64
11457 "win64",
11458 #endif
11459 #ifdef EBCDIC
11460 "ebcdic",
11461 #endif
11462 #ifndef CASE_INSENSITIVE_FILENAME
11463 "fname_case",
11464 #endif
11465 #ifdef FEAT_ARABIC
11466 "arabic",
11467 #endif
11468 #ifdef FEAT_AUTOCMD
11469 "autocmd",
11470 #endif
11471 #ifdef FEAT_BEVAL
11472 "balloon_eval",
11473 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11474 "balloon_multiline",
11475 # endif
11476 #endif
11477 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11478 "builtin_terms",
11479 # ifdef ALL_BUILTIN_TCAPS
11480 "all_builtin_terms",
11481 # endif
11482 #endif
11483 #ifdef FEAT_BYTEOFF
11484 "byte_offset",
11485 #endif
11486 #ifdef FEAT_CINDENT
11487 "cindent",
11488 #endif
11489 #ifdef FEAT_CLIENTSERVER
11490 "clientserver",
11491 #endif
11492 #ifdef FEAT_CLIPBOARD
11493 "clipboard",
11494 #endif
11495 #ifdef FEAT_CMDL_COMPL
11496 "cmdline_compl",
11497 #endif
11498 #ifdef FEAT_CMDHIST
11499 "cmdline_hist",
11500 #endif
11501 #ifdef FEAT_COMMENTS
11502 "comments",
11503 #endif
11504 #ifdef FEAT_CRYPT
11505 "cryptv",
11506 #endif
11507 #ifdef FEAT_CSCOPE
11508 "cscope",
11509 #endif
11510 #ifdef CURSOR_SHAPE
11511 "cursorshape",
11512 #endif
11513 #ifdef DEBUG
11514 "debug",
11515 #endif
11516 #ifdef FEAT_CON_DIALOG
11517 "dialog_con",
11518 #endif
11519 #ifdef FEAT_GUI_DIALOG
11520 "dialog_gui",
11521 #endif
11522 #ifdef FEAT_DIFF
11523 "diff",
11524 #endif
11525 #ifdef FEAT_DIGRAPHS
11526 "digraphs",
11527 #endif
11528 #ifdef FEAT_DND
11529 "dnd",
11530 #endif
11531 #ifdef FEAT_EMACS_TAGS
11532 "emacs_tags",
11533 #endif
11534 "eval", /* always present, of course! */
11535 #ifdef FEAT_EX_EXTRA
11536 "ex_extra",
11537 #endif
11538 #ifdef FEAT_SEARCH_EXTRA
11539 "extra_search",
11540 #endif
11541 #ifdef FEAT_FKMAP
11542 "farsi",
11543 #endif
11544 #ifdef FEAT_SEARCHPATH
11545 "file_in_path",
11546 #endif
11547 #if defined(UNIX) && !defined(USE_SYSTEM)
11548 "filterpipe",
11549 #endif
11550 #ifdef FEAT_FIND_ID
11551 "find_in_path",
11552 #endif
11553 #ifdef FEAT_FLOAT
11554 "float",
11555 #endif
11556 #ifdef FEAT_FOLDING
11557 "folding",
11558 #endif
11559 #ifdef FEAT_FOOTER
11560 "footer",
11561 #endif
11562 #if !defined(USE_SYSTEM) && defined(UNIX)
11563 "fork",
11564 #endif
11565 #ifdef FEAT_FULLSCREEN
11566 "fullscreen",
11567 #endif
11568 #ifdef FEAT_GETTEXT
11569 "gettext",
11570 #endif
11571 #ifdef FEAT_GUI
11572 "gui",
11573 #endif
11574 #ifdef FEAT_GUI_ATHENA
11575 # ifdef FEAT_GUI_NEXTAW
11576 "gui_neXtaw",
11577 # else
11578 "gui_athena",
11579 # endif
11580 #endif
11581 #ifdef FEAT_GUI_GTK
11582 "gui_gtk",
11583 # ifdef HAVE_GTK2
11584 "gui_gtk2",
11585 # endif
11586 #endif
11587 #ifdef FEAT_GUI_GNOME
11588 "gui_gnome",
11589 #endif
11590 #ifdef FEAT_GUI_MAC
11591 "gui_mac",
11592 #endif
11593 #ifdef FEAT_GUI_MACVIM
11594 "gui_macvim",
11595 #endif
11596 #ifdef FEAT_GUI_MOTIF
11597 "gui_motif",
11598 #endif
11599 #ifdef FEAT_GUI_PHOTON
11600 "gui_photon",
11601 #endif
11602 #ifdef FEAT_GUI_W16
11603 "gui_win16",
11604 #endif
11605 #ifdef FEAT_GUI_W32
11606 "gui_win32",
11607 #endif
11608 #ifdef FEAT_HANGULIN
11609 "hangul_input",
11610 #endif
11611 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11612 "iconv",
11613 #endif
11614 #ifdef FEAT_INS_EXPAND
11615 "insert_expand",
11616 #endif
11617 #ifdef FEAT_JUMPLIST
11618 "jumplist",
11619 #endif
11620 #ifdef FEAT_KEYMAP
11621 "keymap",
11622 #endif
11623 #ifdef FEAT_LANGMAP
11624 "langmap",
11625 #endif
11626 #ifdef FEAT_LIBCALL
11627 "libcall",
11628 #endif
11629 #ifdef FEAT_LINEBREAK
11630 "linebreak",
11631 #endif
11632 #ifdef FEAT_LISP
11633 "lispindent",
11634 #endif
11635 #ifdef FEAT_LISTCMDS
11636 "listcmds",
11637 #endif
11638 #ifdef FEAT_LOCALMAP
11639 "localmap",
11640 #endif
11641 #ifdef FEAT_MENU
11642 "menu",
11643 #endif
11644 #ifdef FEAT_SESSION
11645 "mksession",
11646 #endif
11647 #ifdef FEAT_MODIFY_FNAME
11648 "modify_fname",
11649 #endif
11650 #ifdef FEAT_MOUSE
11651 "mouse",
11652 #endif
11653 #ifdef FEAT_MOUSESHAPE
11654 "mouseshape",
11655 #endif
11656 #if defined(UNIX) || defined(VMS)
11657 # ifdef FEAT_MOUSE_DEC
11658 "mouse_dec",
11659 # endif
11660 # ifdef FEAT_MOUSE_GPM
11661 "mouse_gpm",
11662 # endif
11663 # ifdef FEAT_MOUSE_JSB
11664 "mouse_jsbterm",
11665 # endif
11666 # ifdef FEAT_MOUSE_NET
11667 "mouse_netterm",
11668 # endif
11669 # ifdef FEAT_MOUSE_PTERM
11670 "mouse_pterm",
11671 # endif
11672 # ifdef FEAT_SYSMOUSE
11673 "mouse_sysmouse",
11674 # endif
11675 # ifdef FEAT_MOUSE_XTERM
11676 "mouse_xterm",
11677 # endif
11678 #endif
11679 #ifdef FEAT_MBYTE
11680 "multi_byte",
11681 #endif
11682 #ifdef FEAT_MBYTE_IME
11683 "multi_byte_ime",
11684 #endif
11685 #ifdef FEAT_MULTI_LANG
11686 "multi_lang",
11687 #endif
11688 #ifdef FEAT_MZSCHEME
11689 #ifndef DYNAMIC_MZSCHEME
11690 "mzscheme",
11691 #endif
11692 #endif
11693 #ifdef FEAT_OLE
11694 "ole",
11695 #endif
11696 #ifdef FEAT_OSFILETYPE
11697 "osfiletype",
11698 #endif
11699 #ifdef FEAT_PATH_EXTRA
11700 "path_extra",
11701 #endif
11702 #ifdef FEAT_PERL
11703 #ifndef DYNAMIC_PERL
11704 "perl",
11705 #endif
11706 #endif
11707 #ifdef FEAT_PYTHON
11708 #ifndef DYNAMIC_PYTHON
11709 "python",
11710 #endif
11711 #endif
11712 #ifdef FEAT_POSTSCRIPT
11713 "postscript",
11714 #endif
11715 #ifdef FEAT_PRINTER
11716 "printer",
11717 #endif
11718 #ifdef FEAT_PROFILE
11719 "profile",
11720 #endif
11721 #ifdef FEAT_RELTIME
11722 "reltime",
11723 #endif
11724 #ifdef FEAT_QUICKFIX
11725 "quickfix",
11726 #endif
11727 #ifdef FEAT_RIGHTLEFT
11728 "rightleft",
11729 #endif
11730 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11731 "ruby",
11732 #endif
11733 #ifdef FEAT_SCROLLBIND
11734 "scrollbind",
11735 #endif
11736 #ifdef FEAT_CMDL_INFO
11737 "showcmd",
11738 "cmdline_info",
11739 #endif
11740 #ifdef FEAT_SIGNS
11741 "signs",
11742 #endif
11743 #ifdef FEAT_SMARTINDENT
11744 "smartindent",
11745 #endif
11746 #ifdef FEAT_SNIFF
11747 "sniff",
11748 #endif
11749 #ifdef FEAT_STL_OPT
11750 "statusline",
11751 #endif
11752 #ifdef FEAT_SUN_WORKSHOP
11753 "sun_workshop",
11754 #endif
11755 #ifdef FEAT_NETBEANS_INTG
11756 "netbeans_intg",
11757 #endif
11758 #ifdef FEAT_ODB_EDITOR
11759 "odbeditor",
11760 #endif
11761 #ifdef FEAT_SPELL
11762 "spell",
11763 #endif
11764 #ifdef FEAT_SYN_HL
11765 "syntax",
11766 #endif
11767 #if defined(USE_SYSTEM) || !defined(UNIX)
11768 "system",
11769 #endif
11770 #ifdef FEAT_TAG_BINS
11771 "tag_binary",
11772 #endif
11773 #ifdef FEAT_TAG_OLDSTATIC
11774 "tag_old_static",
11775 #endif
11776 #ifdef FEAT_TAG_ANYWHITE
11777 "tag_any_white",
11778 #endif
11779 #ifdef FEAT_TCL
11780 # ifndef DYNAMIC_TCL
11781 "tcl",
11782 # endif
11783 #endif
11784 #ifdef TERMINFO
11785 "terminfo",
11786 #endif
11787 #ifdef FEAT_TERMRESPONSE
11788 "termresponse",
11789 #endif
11790 #ifdef FEAT_TEXTOBJ
11791 "textobjects",
11792 #endif
11793 #ifdef HAVE_TGETENT
11794 "tgetent",
11795 #endif
11796 #ifdef FEAT_TITLE
11797 "title",
11798 #endif
11799 #ifdef FEAT_TOOLBAR
11800 "toolbar",
11801 #endif
11802 #ifdef FEAT_TRANSPARENCY
11803 "transparency",
11804 #endif
11805 #ifdef FEAT_USR_CMDS
11806 "user-commands", /* was accidentally included in 5.4 */
11807 "user_commands",
11808 #endif
11809 #ifdef FEAT_VIMINFO
11810 "viminfo",
11811 #endif
11812 #ifdef FEAT_VERTSPLIT
11813 "vertsplit",
11814 #endif
11815 #ifdef FEAT_VIRTUALEDIT
11816 "virtualedit",
11817 #endif
11818 #ifdef FEAT_VISUAL
11819 "visual",
11820 #endif
11821 #ifdef FEAT_VISUALEXTRA
11822 "visualextra",
11823 #endif
11824 #ifdef FEAT_VREPLACE
11825 "vreplace",
11826 #endif
11827 #ifdef FEAT_WILDIGN
11828 "wildignore",
11829 #endif
11830 #ifdef FEAT_WILDMENU
11831 "wildmenu",
11832 #endif
11833 #ifdef FEAT_WINDOWS
11834 "windows",
11835 #endif
11836 #ifdef FEAT_WAK
11837 "winaltkeys",
11838 #endif
11839 #ifdef FEAT_WRITEBACKUP
11840 "writebackup",
11841 #endif
11842 #ifdef FEAT_XIM
11843 "xim",
11844 #endif
11845 #ifdef FEAT_XFONTSET
11846 "xfontset",
11847 #endif
11848 #ifdef USE_XSMP
11849 "xsmp",
11850 #endif
11851 #ifdef USE_XSMP_INTERACT
11852 "xsmp_interact",
11853 #endif
11854 #ifdef FEAT_XCLIPBOARD
11855 "xterm_clipboard",
11856 #endif
11857 #ifdef FEAT_XTERM_SAVE
11858 "xterm_save",
11859 #endif
11860 #if defined(UNIX) && defined(FEAT_X11)
11861 "X11",
11862 #endif
11863 NULL
11866 name = get_tv_string(&argvars[0]);
11867 for (i = 0; has_list[i] != NULL; ++i)
11868 if (STRICMP(name, has_list[i]) == 0)
11870 n = TRUE;
11871 break;
11874 if (n == FALSE)
11876 if (STRNICMP(name, "patch", 5) == 0)
11877 n = has_patch(atoi((char *)name + 5));
11878 else if (STRICMP(name, "vim_starting") == 0)
11879 n = (starting != 0);
11880 #ifdef FEAT_MBYTE
11881 else if (STRICMP(name, "multi_byte_encoding") == 0)
11882 n = has_mbyte;
11883 #endif
11884 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11885 else if (STRICMP(name, "balloon_multiline") == 0)
11886 n = multiline_balloon_available();
11887 #endif
11888 #ifdef DYNAMIC_TCL
11889 else if (STRICMP(name, "tcl") == 0)
11890 n = tcl_enabled(FALSE);
11891 #endif
11892 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11893 else if (STRICMP(name, "iconv") == 0)
11894 n = iconv_enabled(FALSE);
11895 #endif
11896 #ifdef DYNAMIC_MZSCHEME
11897 else if (STRICMP(name, "mzscheme") == 0)
11898 n = mzscheme_enabled(FALSE);
11899 #endif
11900 #ifdef DYNAMIC_RUBY
11901 else if (STRICMP(name, "ruby") == 0)
11902 n = ruby_enabled(FALSE);
11903 #endif
11904 #ifdef DYNAMIC_PYTHON
11905 else if (STRICMP(name, "python") == 0)
11906 n = python_enabled(FALSE);
11907 #endif
11908 #ifdef DYNAMIC_PERL
11909 else if (STRICMP(name, "perl") == 0)
11910 n = perl_enabled(FALSE);
11911 #endif
11912 #ifdef FEAT_GUI
11913 else if (STRICMP(name, "gui_running") == 0)
11914 n = (gui.in_use || gui.starting);
11915 # ifdef FEAT_GUI_W32
11916 else if (STRICMP(name, "gui_win32s") == 0)
11917 n = gui_is_win32s();
11918 # endif
11919 # ifdef FEAT_BROWSE
11920 else if (STRICMP(name, "browse") == 0)
11921 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11922 # endif
11923 #endif
11924 #ifdef FEAT_SYN_HL
11925 else if (STRICMP(name, "syntax_items") == 0)
11926 n = syntax_present(curbuf);
11927 #endif
11928 #if defined(WIN3264)
11929 else if (STRICMP(name, "win95") == 0)
11930 n = mch_windows95();
11931 #endif
11932 #ifdef FEAT_NETBEANS_INTG
11933 else if (STRICMP(name, "netbeans_enabled") == 0)
11934 n = usingNetbeans;
11935 #endif
11938 rettv->vval.v_number = n;
11942 * "has_key()" function
11944 static void
11945 f_has_key(argvars, rettv)
11946 typval_T *argvars;
11947 typval_T *rettv;
11949 rettv->vval.v_number = 0;
11950 if (argvars[0].v_type != VAR_DICT)
11952 EMSG(_(e_dictreq));
11953 return;
11955 if (argvars[0].vval.v_dict == NULL)
11956 return;
11958 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11959 get_tv_string(&argvars[1]), -1) != NULL;
11963 * "haslocaldir()" function
11965 /*ARGSUSED*/
11966 static void
11967 f_haslocaldir(argvars, rettv)
11968 typval_T *argvars;
11969 typval_T *rettv;
11971 rettv->vval.v_number = (curwin->w_localdir != NULL);
11975 * "hasmapto()" function
11977 static void
11978 f_hasmapto(argvars, rettv)
11979 typval_T *argvars;
11980 typval_T *rettv;
11982 char_u *name;
11983 char_u *mode;
11984 char_u buf[NUMBUFLEN];
11985 int abbr = FALSE;
11987 name = get_tv_string(&argvars[0]);
11988 if (argvars[1].v_type == VAR_UNKNOWN)
11989 mode = (char_u *)"nvo";
11990 else
11992 mode = get_tv_string_buf(&argvars[1], buf);
11993 if (argvars[2].v_type != VAR_UNKNOWN)
11994 abbr = get_tv_number(&argvars[2]);
11997 if (map_to_exists(name, mode, abbr))
11998 rettv->vval.v_number = TRUE;
11999 else
12000 rettv->vval.v_number = FALSE;
12004 * "histadd()" function
12006 /*ARGSUSED*/
12007 static void
12008 f_histadd(argvars, rettv)
12009 typval_T *argvars;
12010 typval_T *rettv;
12012 #ifdef FEAT_CMDHIST
12013 int histype;
12014 char_u *str;
12015 char_u buf[NUMBUFLEN];
12016 #endif
12018 rettv->vval.v_number = FALSE;
12019 if (check_restricted() || check_secure())
12020 return;
12021 #ifdef FEAT_CMDHIST
12022 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12023 histype = str != NULL ? get_histtype(str) : -1;
12024 if (histype >= 0)
12026 str = get_tv_string_buf(&argvars[1], buf);
12027 if (*str != NUL)
12029 add_to_history(histype, str, FALSE, NUL);
12030 rettv->vval.v_number = TRUE;
12031 return;
12034 #endif
12038 * "histdel()" function
12040 /*ARGSUSED*/
12041 static void
12042 f_histdel(argvars, rettv)
12043 typval_T *argvars;
12044 typval_T *rettv;
12046 #ifdef FEAT_CMDHIST
12047 int n;
12048 char_u buf[NUMBUFLEN];
12049 char_u *str;
12051 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12052 if (str == NULL)
12053 n = 0;
12054 else if (argvars[1].v_type == VAR_UNKNOWN)
12055 /* only one argument: clear entire history */
12056 n = clr_history(get_histtype(str));
12057 else if (argvars[1].v_type == VAR_NUMBER)
12058 /* index given: remove that entry */
12059 n = del_history_idx(get_histtype(str),
12060 (int)get_tv_number(&argvars[1]));
12061 else
12062 /* string given: remove all matching entries */
12063 n = del_history_entry(get_histtype(str),
12064 get_tv_string_buf(&argvars[1], buf));
12065 rettv->vval.v_number = n;
12066 #else
12067 rettv->vval.v_number = 0;
12068 #endif
12072 * "histget()" function
12074 /*ARGSUSED*/
12075 static void
12076 f_histget(argvars, rettv)
12077 typval_T *argvars;
12078 typval_T *rettv;
12080 #ifdef FEAT_CMDHIST
12081 int type;
12082 int idx;
12083 char_u *str;
12085 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12086 if (str == NULL)
12087 rettv->vval.v_string = NULL;
12088 else
12090 type = get_histtype(str);
12091 if (argvars[1].v_type == VAR_UNKNOWN)
12092 idx = get_history_idx(type);
12093 else
12094 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12095 /* -1 on type error */
12096 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12098 #else
12099 rettv->vval.v_string = NULL;
12100 #endif
12101 rettv->v_type = VAR_STRING;
12105 * "histnr()" function
12107 /*ARGSUSED*/
12108 static void
12109 f_histnr(argvars, rettv)
12110 typval_T *argvars;
12111 typval_T *rettv;
12113 int i;
12115 #ifdef FEAT_CMDHIST
12116 char_u *history = get_tv_string_chk(&argvars[0]);
12118 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12119 if (i >= HIST_CMD && i < HIST_COUNT)
12120 i = get_history_idx(i);
12121 else
12122 #endif
12123 i = -1;
12124 rettv->vval.v_number = i;
12128 * "highlightID(name)" function
12130 static void
12131 f_hlID(argvars, rettv)
12132 typval_T *argvars;
12133 typval_T *rettv;
12135 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12139 * "highlight_exists()" function
12141 static void
12142 f_hlexists(argvars, rettv)
12143 typval_T *argvars;
12144 typval_T *rettv;
12146 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12150 * "hostname()" function
12152 /*ARGSUSED*/
12153 static void
12154 f_hostname(argvars, rettv)
12155 typval_T *argvars;
12156 typval_T *rettv;
12158 char_u hostname[256];
12160 mch_get_host_name(hostname, 256);
12161 rettv->v_type = VAR_STRING;
12162 rettv->vval.v_string = vim_strsave(hostname);
12166 * iconv() function
12168 /*ARGSUSED*/
12169 static void
12170 f_iconv(argvars, rettv)
12171 typval_T *argvars;
12172 typval_T *rettv;
12174 #ifdef FEAT_MBYTE
12175 char_u buf1[NUMBUFLEN];
12176 char_u buf2[NUMBUFLEN];
12177 char_u *from, *to, *str;
12178 vimconv_T vimconv;
12179 #endif
12181 rettv->v_type = VAR_STRING;
12182 rettv->vval.v_string = NULL;
12184 #ifdef FEAT_MBYTE
12185 str = get_tv_string(&argvars[0]);
12186 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12187 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12188 vimconv.vc_type = CONV_NONE;
12189 convert_setup(&vimconv, from, to);
12191 /* If the encodings are equal, no conversion needed. */
12192 if (vimconv.vc_type == CONV_NONE)
12193 rettv->vval.v_string = vim_strsave(str);
12194 else
12195 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12197 convert_setup(&vimconv, NULL, NULL);
12198 vim_free(from);
12199 vim_free(to);
12200 #endif
12204 * "indent()" function
12206 static void
12207 f_indent(argvars, rettv)
12208 typval_T *argvars;
12209 typval_T *rettv;
12211 linenr_T lnum;
12213 lnum = get_tv_lnum(argvars);
12214 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12215 rettv->vval.v_number = get_indent_lnum(lnum);
12216 else
12217 rettv->vval.v_number = -1;
12221 * "index()" function
12223 static void
12224 f_index(argvars, rettv)
12225 typval_T *argvars;
12226 typval_T *rettv;
12228 list_T *l;
12229 listitem_T *item;
12230 long idx = 0;
12231 int ic = FALSE;
12233 rettv->vval.v_number = -1;
12234 if (argvars[0].v_type != VAR_LIST)
12236 EMSG(_(e_listreq));
12237 return;
12239 l = argvars[0].vval.v_list;
12240 if (l != NULL)
12242 item = l->lv_first;
12243 if (argvars[2].v_type != VAR_UNKNOWN)
12245 int error = FALSE;
12247 /* Start at specified item. Use the cached index that list_find()
12248 * sets, so that a negative number also works. */
12249 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12250 idx = l->lv_idx;
12251 if (argvars[3].v_type != VAR_UNKNOWN)
12252 ic = get_tv_number_chk(&argvars[3], &error);
12253 if (error)
12254 item = NULL;
12257 for ( ; item != NULL; item = item->li_next, ++idx)
12258 if (tv_equal(&item->li_tv, &argvars[1], ic))
12260 rettv->vval.v_number = idx;
12261 break;
12266 static int inputsecret_flag = 0;
12268 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12271 * This function is used by f_input() and f_inputdialog() functions. The third
12272 * argument to f_input() specifies the type of completion to use at the
12273 * prompt. The third argument to f_inputdialog() specifies the value to return
12274 * when the user cancels the prompt.
12276 static void
12277 get_user_input(argvars, rettv, inputdialog)
12278 typval_T *argvars;
12279 typval_T *rettv;
12280 int inputdialog;
12282 char_u *prompt = get_tv_string_chk(&argvars[0]);
12283 char_u *p = NULL;
12284 int c;
12285 char_u buf[NUMBUFLEN];
12286 int cmd_silent_save = cmd_silent;
12287 char_u *defstr = (char_u *)"";
12288 int xp_type = EXPAND_NOTHING;
12289 char_u *xp_arg = NULL;
12291 rettv->v_type = VAR_STRING;
12292 rettv->vval.v_string = NULL;
12294 #ifdef NO_CONSOLE_INPUT
12295 /* While starting up, there is no place to enter text. */
12296 if (no_console_input())
12297 return;
12298 #endif
12300 cmd_silent = FALSE; /* Want to see the prompt. */
12301 if (prompt != NULL)
12303 /* Only the part of the message after the last NL is considered as
12304 * prompt for the command line */
12305 p = vim_strrchr(prompt, '\n');
12306 if (p == NULL)
12307 p = prompt;
12308 else
12310 ++p;
12311 c = *p;
12312 *p = NUL;
12313 msg_start();
12314 msg_clr_eos();
12315 msg_puts_attr(prompt, echo_attr);
12316 msg_didout = FALSE;
12317 msg_starthere();
12318 *p = c;
12320 cmdline_row = msg_row;
12322 if (argvars[1].v_type != VAR_UNKNOWN)
12324 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12325 if (defstr != NULL)
12326 stuffReadbuffSpec(defstr);
12328 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12330 char_u *xp_name;
12331 int xp_namelen;
12332 long argt;
12334 rettv->vval.v_string = NULL;
12336 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12337 if (xp_name == NULL)
12338 return;
12340 xp_namelen = (int)STRLEN(xp_name);
12342 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12343 &xp_arg) == FAIL)
12344 return;
12348 if (defstr != NULL)
12349 rettv->vval.v_string =
12350 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12351 xp_type, xp_arg);
12353 vim_free(xp_arg);
12355 /* since the user typed this, no need to wait for return */
12356 need_wait_return = FALSE;
12357 msg_didout = FALSE;
12359 cmd_silent = cmd_silent_save;
12363 * "input()" function
12364 * Also handles inputsecret() when inputsecret is set.
12366 static void
12367 f_input(argvars, rettv)
12368 typval_T *argvars;
12369 typval_T *rettv;
12371 get_user_input(argvars, rettv, FALSE);
12375 * "inputdialog()" function
12377 static void
12378 f_inputdialog(argvars, rettv)
12379 typval_T *argvars;
12380 typval_T *rettv;
12382 #if defined(FEAT_GUI_TEXTDIALOG)
12383 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12384 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12386 char_u *message;
12387 char_u buf[NUMBUFLEN];
12388 char_u *defstr = (char_u *)"";
12390 message = get_tv_string_chk(&argvars[0]);
12391 if (argvars[1].v_type != VAR_UNKNOWN
12392 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12393 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12394 else
12395 IObuff[0] = NUL;
12396 if (message != NULL && defstr != NULL
12397 && do_dialog(VIM_QUESTION, NULL, message,
12398 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12399 rettv->vval.v_string = vim_strsave(IObuff);
12400 else
12402 if (message != NULL && defstr != NULL
12403 && argvars[1].v_type != VAR_UNKNOWN
12404 && argvars[2].v_type != VAR_UNKNOWN)
12405 rettv->vval.v_string = vim_strsave(
12406 get_tv_string_buf(&argvars[2], buf));
12407 else
12408 rettv->vval.v_string = NULL;
12410 rettv->v_type = VAR_STRING;
12412 else
12413 #endif
12414 get_user_input(argvars, rettv, TRUE);
12418 * "inputlist()" function
12420 static void
12421 f_inputlist(argvars, rettv)
12422 typval_T *argvars;
12423 typval_T *rettv;
12425 listitem_T *li;
12426 int selected;
12427 int mouse_used;
12429 rettv->vval.v_number = 0;
12430 #ifdef NO_CONSOLE_INPUT
12431 /* While starting up, there is no place to enter text. */
12432 if (no_console_input())
12433 return;
12434 #endif
12435 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12437 EMSG2(_(e_listarg), "inputlist()");
12438 return;
12441 msg_start();
12442 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12443 lines_left = Rows; /* avoid more prompt */
12444 msg_scroll = TRUE;
12445 msg_clr_eos();
12447 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12449 msg_puts(get_tv_string(&li->li_tv));
12450 msg_putchar('\n');
12453 /* Ask for choice. */
12454 selected = prompt_for_number(&mouse_used);
12455 if (mouse_used)
12456 selected -= lines_left;
12458 rettv->vval.v_number = selected;
12462 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12465 * "inputrestore()" function
12467 /*ARGSUSED*/
12468 static void
12469 f_inputrestore(argvars, rettv)
12470 typval_T *argvars;
12471 typval_T *rettv;
12473 if (ga_userinput.ga_len > 0)
12475 --ga_userinput.ga_len;
12476 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12477 + ga_userinput.ga_len);
12478 rettv->vval.v_number = 0; /* OK */
12480 else if (p_verbose > 1)
12482 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12483 rettv->vval.v_number = 1; /* Failed */
12488 * "inputsave()" function
12490 /*ARGSUSED*/
12491 static void
12492 f_inputsave(argvars, rettv)
12493 typval_T *argvars;
12494 typval_T *rettv;
12496 /* Add an entry to the stack of typeahead storage. */
12497 if (ga_grow(&ga_userinput, 1) == OK)
12499 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12500 + ga_userinput.ga_len);
12501 ++ga_userinput.ga_len;
12502 rettv->vval.v_number = 0; /* OK */
12504 else
12505 rettv->vval.v_number = 1; /* Failed */
12509 * "inputsecret()" function
12511 static void
12512 f_inputsecret(argvars, rettv)
12513 typval_T *argvars;
12514 typval_T *rettv;
12516 ++cmdline_star;
12517 ++inputsecret_flag;
12518 f_input(argvars, rettv);
12519 --cmdline_star;
12520 --inputsecret_flag;
12524 * "insert()" function
12526 static void
12527 f_insert(argvars, rettv)
12528 typval_T *argvars;
12529 typval_T *rettv;
12531 long before = 0;
12532 listitem_T *item;
12533 list_T *l;
12534 int error = FALSE;
12536 rettv->vval.v_number = 0;
12537 if (argvars[0].v_type != VAR_LIST)
12538 EMSG2(_(e_listarg), "insert()");
12539 else if ((l = argvars[0].vval.v_list) != NULL
12540 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12542 if (argvars[2].v_type != VAR_UNKNOWN)
12543 before = get_tv_number_chk(&argvars[2], &error);
12544 if (error)
12545 return; /* type error; errmsg already given */
12547 if (before == l->lv_len)
12548 item = NULL;
12549 else
12551 item = list_find(l, before);
12552 if (item == NULL)
12554 EMSGN(_(e_listidx), before);
12555 l = NULL;
12558 if (l != NULL)
12560 list_insert_tv(l, &argvars[1], item);
12561 copy_tv(&argvars[0], rettv);
12567 * "isdirectory()" function
12569 static void
12570 f_isdirectory(argvars, rettv)
12571 typval_T *argvars;
12572 typval_T *rettv;
12574 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12578 * "islocked()" function
12580 static void
12581 f_islocked(argvars, rettv)
12582 typval_T *argvars;
12583 typval_T *rettv;
12585 lval_T lv;
12586 char_u *end;
12587 dictitem_T *di;
12589 rettv->vval.v_number = -1;
12590 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12591 FNE_CHECK_START);
12592 if (end != NULL && lv.ll_name != NULL)
12594 if (*end != NUL)
12595 EMSG(_(e_trailing));
12596 else
12598 if (lv.ll_tv == NULL)
12600 if (check_changedtick(lv.ll_name))
12601 rettv->vval.v_number = 1; /* always locked */
12602 else
12604 di = find_var(lv.ll_name, NULL);
12605 if (di != NULL)
12607 /* Consider a variable locked when:
12608 * 1. the variable itself is locked
12609 * 2. the value of the variable is locked.
12610 * 3. the List or Dict value is locked.
12612 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12613 || tv_islocked(&di->di_tv));
12617 else if (lv.ll_range)
12618 EMSG(_("E786: Range not allowed"));
12619 else if (lv.ll_newkey != NULL)
12620 EMSG2(_(e_dictkey), lv.ll_newkey);
12621 else if (lv.ll_list != NULL)
12622 /* List item. */
12623 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12624 else
12625 /* Dictionary item. */
12626 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12630 clear_lval(&lv);
12633 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12636 * Turn a dict into a list:
12637 * "what" == 0: list of keys
12638 * "what" == 1: list of values
12639 * "what" == 2: list of items
12641 static void
12642 dict_list(argvars, rettv, what)
12643 typval_T *argvars;
12644 typval_T *rettv;
12645 int what;
12647 list_T *l2;
12648 dictitem_T *di;
12649 hashitem_T *hi;
12650 listitem_T *li;
12651 listitem_T *li2;
12652 dict_T *d;
12653 int todo;
12655 rettv->vval.v_number = 0;
12656 if (argvars[0].v_type != VAR_DICT)
12658 EMSG(_(e_dictreq));
12659 return;
12661 if ((d = argvars[0].vval.v_dict) == NULL)
12662 return;
12664 if (rettv_list_alloc(rettv) == FAIL)
12665 return;
12667 todo = (int)d->dv_hashtab.ht_used;
12668 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12670 if (!HASHITEM_EMPTY(hi))
12672 --todo;
12673 di = HI2DI(hi);
12675 li = listitem_alloc();
12676 if (li == NULL)
12677 break;
12678 list_append(rettv->vval.v_list, li);
12680 if (what == 0)
12682 /* keys() */
12683 li->li_tv.v_type = VAR_STRING;
12684 li->li_tv.v_lock = 0;
12685 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12687 else if (what == 1)
12689 /* values() */
12690 copy_tv(&di->di_tv, &li->li_tv);
12692 else
12694 /* items() */
12695 l2 = list_alloc();
12696 li->li_tv.v_type = VAR_LIST;
12697 li->li_tv.v_lock = 0;
12698 li->li_tv.vval.v_list = l2;
12699 if (l2 == NULL)
12700 break;
12701 ++l2->lv_refcount;
12703 li2 = listitem_alloc();
12704 if (li2 == NULL)
12705 break;
12706 list_append(l2, li2);
12707 li2->li_tv.v_type = VAR_STRING;
12708 li2->li_tv.v_lock = 0;
12709 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12711 li2 = listitem_alloc();
12712 if (li2 == NULL)
12713 break;
12714 list_append(l2, li2);
12715 copy_tv(&di->di_tv, &li2->li_tv);
12722 * "items(dict)" function
12724 static void
12725 f_items(argvars, rettv)
12726 typval_T *argvars;
12727 typval_T *rettv;
12729 dict_list(argvars, rettv, 2);
12733 * "join()" function
12735 static void
12736 f_join(argvars, rettv)
12737 typval_T *argvars;
12738 typval_T *rettv;
12740 garray_T ga;
12741 char_u *sep;
12743 rettv->vval.v_number = 0;
12744 if (argvars[0].v_type != VAR_LIST)
12746 EMSG(_(e_listreq));
12747 return;
12749 if (argvars[0].vval.v_list == NULL)
12750 return;
12751 if (argvars[1].v_type == VAR_UNKNOWN)
12752 sep = (char_u *)" ";
12753 else
12754 sep = get_tv_string_chk(&argvars[1]);
12756 rettv->v_type = VAR_STRING;
12758 if (sep != NULL)
12760 ga_init2(&ga, (int)sizeof(char), 80);
12761 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12762 ga_append(&ga, NUL);
12763 rettv->vval.v_string = (char_u *)ga.ga_data;
12765 else
12766 rettv->vval.v_string = NULL;
12770 * "keys()" function
12772 static void
12773 f_keys(argvars, rettv)
12774 typval_T *argvars;
12775 typval_T *rettv;
12777 dict_list(argvars, rettv, 0);
12781 * "last_buffer_nr()" function.
12783 /*ARGSUSED*/
12784 static void
12785 f_last_buffer_nr(argvars, rettv)
12786 typval_T *argvars;
12787 typval_T *rettv;
12789 int n = 0;
12790 buf_T *buf;
12792 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12793 if (n < buf->b_fnum)
12794 n = buf->b_fnum;
12796 rettv->vval.v_number = n;
12800 * "len()" function
12802 static void
12803 f_len(argvars, rettv)
12804 typval_T *argvars;
12805 typval_T *rettv;
12807 switch (argvars[0].v_type)
12809 case VAR_STRING:
12810 case VAR_NUMBER:
12811 rettv->vval.v_number = (varnumber_T)STRLEN(
12812 get_tv_string(&argvars[0]));
12813 break;
12814 case VAR_LIST:
12815 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12816 break;
12817 case VAR_DICT:
12818 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12819 break;
12820 default:
12821 EMSG(_("E701: Invalid type for len()"));
12822 break;
12826 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12828 static void
12829 libcall_common(argvars, rettv, type)
12830 typval_T *argvars;
12831 typval_T *rettv;
12832 int type;
12834 #ifdef FEAT_LIBCALL
12835 char_u *string_in;
12836 char_u **string_result;
12837 int nr_result;
12838 #endif
12840 rettv->v_type = type;
12841 if (type == VAR_NUMBER)
12842 rettv->vval.v_number = 0;
12843 else
12844 rettv->vval.v_string = NULL;
12846 if (check_restricted() || check_secure())
12847 return;
12849 #ifdef FEAT_LIBCALL
12850 /* The first two args must be strings, otherwise its meaningless */
12851 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12853 string_in = NULL;
12854 if (argvars[2].v_type == VAR_STRING)
12855 string_in = argvars[2].vval.v_string;
12856 if (type == VAR_NUMBER)
12857 string_result = NULL;
12858 else
12859 string_result = &rettv->vval.v_string;
12860 if (mch_libcall(argvars[0].vval.v_string,
12861 argvars[1].vval.v_string,
12862 string_in,
12863 argvars[2].vval.v_number,
12864 string_result,
12865 &nr_result) == OK
12866 && type == VAR_NUMBER)
12867 rettv->vval.v_number = nr_result;
12869 #endif
12873 * "libcall()" function
12875 static void
12876 f_libcall(argvars, rettv)
12877 typval_T *argvars;
12878 typval_T *rettv;
12880 libcall_common(argvars, rettv, VAR_STRING);
12884 * "libcallnr()" function
12886 static void
12887 f_libcallnr(argvars, rettv)
12888 typval_T *argvars;
12889 typval_T *rettv;
12891 libcall_common(argvars, rettv, VAR_NUMBER);
12895 * "line(string)" function
12897 static void
12898 f_line(argvars, rettv)
12899 typval_T *argvars;
12900 typval_T *rettv;
12902 linenr_T lnum = 0;
12903 pos_T *fp;
12904 int fnum;
12906 fp = var2fpos(&argvars[0], TRUE, &fnum);
12907 if (fp != NULL)
12908 lnum = fp->lnum;
12909 rettv->vval.v_number = lnum;
12913 * "line2byte(lnum)" function
12915 /*ARGSUSED*/
12916 static void
12917 f_line2byte(argvars, rettv)
12918 typval_T *argvars;
12919 typval_T *rettv;
12921 #ifndef FEAT_BYTEOFF
12922 rettv->vval.v_number = -1;
12923 #else
12924 linenr_T lnum;
12926 lnum = get_tv_lnum(argvars);
12927 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12928 rettv->vval.v_number = -1;
12929 else
12930 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12931 if (rettv->vval.v_number >= 0)
12932 ++rettv->vval.v_number;
12933 #endif
12937 * "lispindent(lnum)" function
12939 static void
12940 f_lispindent(argvars, rettv)
12941 typval_T *argvars;
12942 typval_T *rettv;
12944 #ifdef FEAT_LISP
12945 pos_T pos;
12946 linenr_T lnum;
12948 pos = curwin->w_cursor;
12949 lnum = get_tv_lnum(argvars);
12950 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12952 curwin->w_cursor.lnum = lnum;
12953 rettv->vval.v_number = get_lisp_indent();
12954 curwin->w_cursor = pos;
12956 else
12957 #endif
12958 rettv->vval.v_number = -1;
12962 * "localtime()" function
12964 /*ARGSUSED*/
12965 static void
12966 f_localtime(argvars, rettv)
12967 typval_T *argvars;
12968 typval_T *rettv;
12970 rettv->vval.v_number = (varnumber_T)time(NULL);
12973 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12975 static void
12976 get_maparg(argvars, rettv, exact)
12977 typval_T *argvars;
12978 typval_T *rettv;
12979 int exact;
12981 char_u *keys;
12982 char_u *which;
12983 char_u buf[NUMBUFLEN];
12984 char_u *keys_buf = NULL;
12985 char_u *rhs;
12986 int mode;
12987 garray_T ga;
12988 int abbr = FALSE;
12990 /* return empty string for failure */
12991 rettv->v_type = VAR_STRING;
12992 rettv->vval.v_string = NULL;
12994 keys = get_tv_string(&argvars[0]);
12995 if (*keys == NUL)
12996 return;
12998 if (argvars[1].v_type != VAR_UNKNOWN)
13000 which = get_tv_string_buf_chk(&argvars[1], buf);
13001 if (argvars[2].v_type != VAR_UNKNOWN)
13002 abbr = get_tv_number(&argvars[2]);
13004 else
13005 which = (char_u *)"";
13006 if (which == NULL)
13007 return;
13009 mode = get_map_mode(&which, 0);
13011 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
13012 rhs = check_map(keys, mode, exact, FALSE, abbr);
13013 vim_free(keys_buf);
13014 if (rhs != NULL)
13016 ga_init(&ga);
13017 ga.ga_itemsize = 1;
13018 ga.ga_growsize = 40;
13020 while (*rhs != NUL)
13021 ga_concat(&ga, str2special(&rhs, FALSE));
13023 ga_append(&ga, NUL);
13024 rettv->vval.v_string = (char_u *)ga.ga_data;
13028 #ifdef FEAT_FLOAT
13030 * "log10()" function
13032 static void
13033 f_log10(argvars, rettv)
13034 typval_T *argvars;
13035 typval_T *rettv;
13037 float_T f;
13039 rettv->v_type = VAR_FLOAT;
13040 if (get_float_arg(argvars, &f) == OK)
13041 rettv->vval.v_float = log10(f);
13042 else
13043 rettv->vval.v_float = 0.0;
13045 #endif
13048 * "map()" function
13050 static void
13051 f_map(argvars, rettv)
13052 typval_T *argvars;
13053 typval_T *rettv;
13055 filter_map(argvars, rettv, TRUE);
13059 * "maparg()" function
13061 static void
13062 f_maparg(argvars, rettv)
13063 typval_T *argvars;
13064 typval_T *rettv;
13066 get_maparg(argvars, rettv, TRUE);
13070 * "mapcheck()" function
13072 static void
13073 f_mapcheck(argvars, rettv)
13074 typval_T *argvars;
13075 typval_T *rettv;
13077 get_maparg(argvars, rettv, FALSE);
13080 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13082 static void
13083 find_some_match(argvars, rettv, type)
13084 typval_T *argvars;
13085 typval_T *rettv;
13086 int type;
13088 char_u *str = NULL;
13089 char_u *expr = NULL;
13090 char_u *pat;
13091 regmatch_T regmatch;
13092 char_u patbuf[NUMBUFLEN];
13093 char_u strbuf[NUMBUFLEN];
13094 char_u *save_cpo;
13095 long start = 0;
13096 long nth = 1;
13097 colnr_T startcol = 0;
13098 int match = 0;
13099 list_T *l = NULL;
13100 listitem_T *li = NULL;
13101 long idx = 0;
13102 char_u *tofree = NULL;
13104 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13105 save_cpo = p_cpo;
13106 p_cpo = (char_u *)"";
13108 rettv->vval.v_number = -1;
13109 if (type == 3)
13111 /* return empty list when there are no matches */
13112 if (rettv_list_alloc(rettv) == FAIL)
13113 goto theend;
13115 else if (type == 2)
13117 rettv->v_type = VAR_STRING;
13118 rettv->vval.v_string = NULL;
13121 if (argvars[0].v_type == VAR_LIST)
13123 if ((l = argvars[0].vval.v_list) == NULL)
13124 goto theend;
13125 li = l->lv_first;
13127 else
13128 expr = str = get_tv_string(&argvars[0]);
13130 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13131 if (pat == NULL)
13132 goto theend;
13134 if (argvars[2].v_type != VAR_UNKNOWN)
13136 int error = FALSE;
13138 start = get_tv_number_chk(&argvars[2], &error);
13139 if (error)
13140 goto theend;
13141 if (l != NULL)
13143 li = list_find(l, start);
13144 if (li == NULL)
13145 goto theend;
13146 idx = l->lv_idx; /* use the cached index */
13148 else
13150 if (start < 0)
13151 start = 0;
13152 if (start > (long)STRLEN(str))
13153 goto theend;
13154 /* When "count" argument is there ignore matches before "start",
13155 * otherwise skip part of the string. Differs when pattern is "^"
13156 * or "\<". */
13157 if (argvars[3].v_type != VAR_UNKNOWN)
13158 startcol = start;
13159 else
13160 str += start;
13163 if (argvars[3].v_type != VAR_UNKNOWN)
13164 nth = get_tv_number_chk(&argvars[3], &error);
13165 if (error)
13166 goto theend;
13169 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13170 if (regmatch.regprog != NULL)
13172 regmatch.rm_ic = p_ic;
13174 for (;;)
13176 if (l != NULL)
13178 if (li == NULL)
13180 match = FALSE;
13181 break;
13183 vim_free(tofree);
13184 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13185 if (str == NULL)
13186 break;
13189 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13191 if (match && --nth <= 0)
13192 break;
13193 if (l == NULL && !match)
13194 break;
13196 /* Advance to just after the match. */
13197 if (l != NULL)
13199 li = li->li_next;
13200 ++idx;
13202 else
13204 #ifdef FEAT_MBYTE
13205 startcol = (colnr_T)(regmatch.startp[0]
13206 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13207 #else
13208 startcol = regmatch.startp[0] + 1 - str;
13209 #endif
13213 if (match)
13215 if (type == 3)
13217 int i;
13219 /* return list with matched string and submatches */
13220 for (i = 0; i < NSUBEXP; ++i)
13222 if (regmatch.endp[i] == NULL)
13224 if (list_append_string(rettv->vval.v_list,
13225 (char_u *)"", 0) == FAIL)
13226 break;
13228 else if (list_append_string(rettv->vval.v_list,
13229 regmatch.startp[i],
13230 (int)(regmatch.endp[i] - regmatch.startp[i]))
13231 == FAIL)
13232 break;
13235 else if (type == 2)
13237 /* return matched string */
13238 if (l != NULL)
13239 copy_tv(&li->li_tv, rettv);
13240 else
13241 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13242 (int)(regmatch.endp[0] - regmatch.startp[0]));
13244 else if (l != NULL)
13245 rettv->vval.v_number = idx;
13246 else
13248 if (type != 0)
13249 rettv->vval.v_number =
13250 (varnumber_T)(regmatch.startp[0] - str);
13251 else
13252 rettv->vval.v_number =
13253 (varnumber_T)(regmatch.endp[0] - str);
13254 rettv->vval.v_number += (varnumber_T)(str - expr);
13257 vim_free(regmatch.regprog);
13260 theend:
13261 vim_free(tofree);
13262 p_cpo = save_cpo;
13266 * "match()" function
13268 static void
13269 f_match(argvars, rettv)
13270 typval_T *argvars;
13271 typval_T *rettv;
13273 find_some_match(argvars, rettv, 1);
13277 * "matchadd()" function
13279 static void
13280 f_matchadd(argvars, rettv)
13281 typval_T *argvars;
13282 typval_T *rettv;
13284 #ifdef FEAT_SEARCH_EXTRA
13285 char_u buf[NUMBUFLEN];
13286 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13287 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13288 int prio = 10; /* default priority */
13289 int id = -1;
13290 int error = FALSE;
13292 rettv->vval.v_number = -1;
13294 if (grp == NULL || pat == NULL)
13295 return;
13296 if (argvars[2].v_type != VAR_UNKNOWN)
13298 prio = get_tv_number_chk(&argvars[2], &error);
13299 if (argvars[3].v_type != VAR_UNKNOWN)
13300 id = get_tv_number_chk(&argvars[3], &error);
13302 if (error == TRUE)
13303 return;
13304 if (id >= 1 && id <= 3)
13306 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13307 return;
13310 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13311 #endif
13315 * "matcharg()" function
13317 static void
13318 f_matcharg(argvars, rettv)
13319 typval_T *argvars;
13320 typval_T *rettv;
13322 if (rettv_list_alloc(rettv) == OK)
13324 #ifdef FEAT_SEARCH_EXTRA
13325 int id = get_tv_number(&argvars[0]);
13326 matchitem_T *m;
13328 if (id >= 1 && id <= 3)
13330 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13332 list_append_string(rettv->vval.v_list,
13333 syn_id2name(m->hlg_id), -1);
13334 list_append_string(rettv->vval.v_list, m->pattern, -1);
13336 else
13338 list_append_string(rettv->vval.v_list, NUL, -1);
13339 list_append_string(rettv->vval.v_list, NUL, -1);
13342 #endif
13347 * "matchdelete()" function
13349 static void
13350 f_matchdelete(argvars, rettv)
13351 typval_T *argvars;
13352 typval_T *rettv;
13354 #ifdef FEAT_SEARCH_EXTRA
13355 rettv->vval.v_number = match_delete(curwin,
13356 (int)get_tv_number(&argvars[0]), TRUE);
13357 #endif
13361 * "matchend()" function
13363 static void
13364 f_matchend(argvars, rettv)
13365 typval_T *argvars;
13366 typval_T *rettv;
13368 find_some_match(argvars, rettv, 0);
13372 * "matchlist()" function
13374 static void
13375 f_matchlist(argvars, rettv)
13376 typval_T *argvars;
13377 typval_T *rettv;
13379 find_some_match(argvars, rettv, 3);
13383 * "matchstr()" function
13385 static void
13386 f_matchstr(argvars, rettv)
13387 typval_T *argvars;
13388 typval_T *rettv;
13390 find_some_match(argvars, rettv, 2);
13393 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13395 static void
13396 max_min(argvars, rettv, domax)
13397 typval_T *argvars;
13398 typval_T *rettv;
13399 int domax;
13401 long n = 0;
13402 long i;
13403 int error = FALSE;
13405 if (argvars[0].v_type == VAR_LIST)
13407 list_T *l;
13408 listitem_T *li;
13410 l = argvars[0].vval.v_list;
13411 if (l != NULL)
13413 li = l->lv_first;
13414 if (li != NULL)
13416 n = get_tv_number_chk(&li->li_tv, &error);
13417 for (;;)
13419 li = li->li_next;
13420 if (li == NULL)
13421 break;
13422 i = get_tv_number_chk(&li->li_tv, &error);
13423 if (domax ? i > n : i < n)
13424 n = i;
13429 else if (argvars[0].v_type == VAR_DICT)
13431 dict_T *d;
13432 int first = TRUE;
13433 hashitem_T *hi;
13434 int todo;
13436 d = argvars[0].vval.v_dict;
13437 if (d != NULL)
13439 todo = (int)d->dv_hashtab.ht_used;
13440 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13442 if (!HASHITEM_EMPTY(hi))
13444 --todo;
13445 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13446 if (first)
13448 n = i;
13449 first = FALSE;
13451 else if (domax ? i > n : i < n)
13452 n = i;
13457 else
13458 EMSG(_(e_listdictarg));
13459 rettv->vval.v_number = error ? 0 : n;
13463 * "max()" function
13465 static void
13466 f_max(argvars, rettv)
13467 typval_T *argvars;
13468 typval_T *rettv;
13470 max_min(argvars, rettv, TRUE);
13474 * "min()" function
13476 static void
13477 f_min(argvars, rettv)
13478 typval_T *argvars;
13479 typval_T *rettv;
13481 max_min(argvars, rettv, FALSE);
13484 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13487 * Create the directory in which "dir" is located, and higher levels when
13488 * needed.
13490 static int
13491 mkdir_recurse(dir, prot)
13492 char_u *dir;
13493 int prot;
13495 char_u *p;
13496 char_u *updir;
13497 int r = FAIL;
13499 /* Get end of directory name in "dir".
13500 * We're done when it's "/" or "c:/". */
13501 p = gettail_sep(dir);
13502 if (p <= get_past_head(dir))
13503 return OK;
13505 /* If the directory exists we're done. Otherwise: create it.*/
13506 updir = vim_strnsave(dir, (int)(p - dir));
13507 if (updir == NULL)
13508 return FAIL;
13509 if (mch_isdir(updir))
13510 r = OK;
13511 else if (mkdir_recurse(updir, prot) == OK)
13512 r = vim_mkdir_emsg(updir, prot);
13513 vim_free(updir);
13514 return r;
13517 #ifdef vim_mkdir
13519 * "mkdir()" function
13521 static void
13522 f_mkdir(argvars, rettv)
13523 typval_T *argvars;
13524 typval_T *rettv;
13526 char_u *dir;
13527 char_u buf[NUMBUFLEN];
13528 int prot = 0755;
13530 rettv->vval.v_number = FAIL;
13531 if (check_restricted() || check_secure())
13532 return;
13534 dir = get_tv_string_buf(&argvars[0], buf);
13535 if (argvars[1].v_type != VAR_UNKNOWN)
13537 if (argvars[2].v_type != VAR_UNKNOWN)
13538 prot = get_tv_number_chk(&argvars[2], NULL);
13539 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13540 mkdir_recurse(dir, prot);
13542 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13544 #endif
13547 * "mode()" function
13549 /*ARGSUSED*/
13550 static void
13551 f_mode(argvars, rettv)
13552 typval_T *argvars;
13553 typval_T *rettv;
13555 char_u buf[3];
13557 buf[1] = NUL;
13558 buf[2] = NUL;
13560 #ifdef FEAT_VISUAL
13561 if (VIsual_active)
13563 if (VIsual_select)
13564 buf[0] = VIsual_mode + 's' - 'v';
13565 else
13566 buf[0] = VIsual_mode;
13568 else
13569 #endif
13570 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13571 || State == CONFIRM)
13573 buf[0] = 'r';
13574 if (State == ASKMORE)
13575 buf[1] = 'm';
13576 else if (State == CONFIRM)
13577 buf[1] = '?';
13579 else if (State == EXTERNCMD)
13580 buf[0] = '!';
13581 else if (State & INSERT)
13583 #ifdef FEAT_VREPLACE
13584 if (State & VREPLACE_FLAG)
13586 buf[0] = 'R';
13587 buf[1] = 'v';
13589 else
13590 #endif
13591 if (State & REPLACE_FLAG)
13592 buf[0] = 'R';
13593 else
13594 buf[0] = 'i';
13596 else if (State & CMDLINE)
13598 buf[0] = 'c';
13599 if (exmode_active)
13600 buf[1] = 'v';
13602 else if (exmode_active)
13604 buf[0] = 'c';
13605 buf[1] = 'e';
13607 else
13609 buf[0] = 'n';
13610 if (finish_op)
13611 buf[1] = 'o';
13614 /* Clear out the minor mode when the argument is not a non-zero number or
13615 * non-empty string. */
13616 if (!non_zero_arg(&argvars[0]))
13617 buf[1] = NUL;
13619 rettv->vval.v_string = vim_strsave(buf);
13620 rettv->v_type = VAR_STRING;
13624 * "nextnonblank()" function
13626 static void
13627 f_nextnonblank(argvars, rettv)
13628 typval_T *argvars;
13629 typval_T *rettv;
13631 linenr_T lnum;
13633 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13635 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13637 lnum = 0;
13638 break;
13640 if (*skipwhite(ml_get(lnum)) != NUL)
13641 break;
13643 rettv->vval.v_number = lnum;
13647 * "nr2char()" function
13649 static void
13650 f_nr2char(argvars, rettv)
13651 typval_T *argvars;
13652 typval_T *rettv;
13654 char_u buf[NUMBUFLEN];
13656 #ifdef FEAT_MBYTE
13657 if (has_mbyte)
13658 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13659 else
13660 #endif
13662 buf[0] = (char_u)get_tv_number(&argvars[0]);
13663 buf[1] = NUL;
13665 rettv->v_type = VAR_STRING;
13666 rettv->vval.v_string = vim_strsave(buf);
13670 * "pathshorten()" function
13672 static void
13673 f_pathshorten(argvars, rettv)
13674 typval_T *argvars;
13675 typval_T *rettv;
13677 char_u *p;
13679 rettv->v_type = VAR_STRING;
13680 p = get_tv_string_chk(&argvars[0]);
13681 if (p == NULL)
13682 rettv->vval.v_string = NULL;
13683 else
13685 p = vim_strsave(p);
13686 rettv->vval.v_string = p;
13687 if (p != NULL)
13688 shorten_dir(p);
13692 #ifdef FEAT_FLOAT
13694 * "pow()" function
13696 static void
13697 f_pow(argvars, rettv)
13698 typval_T *argvars;
13699 typval_T *rettv;
13701 float_T fx, fy;
13703 rettv->v_type = VAR_FLOAT;
13704 if (get_float_arg(argvars, &fx) == OK
13705 && get_float_arg(&argvars[1], &fy) == OK)
13706 rettv->vval.v_float = pow(fx, fy);
13707 else
13708 rettv->vval.v_float = 0.0;
13710 #endif
13713 * "prevnonblank()" function
13715 static void
13716 f_prevnonblank(argvars, rettv)
13717 typval_T *argvars;
13718 typval_T *rettv;
13720 linenr_T lnum;
13722 lnum = get_tv_lnum(argvars);
13723 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13724 lnum = 0;
13725 else
13726 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13727 --lnum;
13728 rettv->vval.v_number = lnum;
13731 #ifdef HAVE_STDARG_H
13732 /* This dummy va_list is here because:
13733 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13734 * - locally in the function results in a "used before set" warning
13735 * - using va_start() to initialize it gives "function with fixed args" error */
13736 static va_list ap;
13737 #endif
13740 * "printf()" function
13742 static void
13743 f_printf(argvars, rettv)
13744 typval_T *argvars;
13745 typval_T *rettv;
13747 rettv->v_type = VAR_STRING;
13748 rettv->vval.v_string = NULL;
13749 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13751 char_u buf[NUMBUFLEN];
13752 int len;
13753 char_u *s;
13754 int saved_did_emsg = did_emsg;
13755 char *fmt;
13757 /* Get the required length, allocate the buffer and do it for real. */
13758 did_emsg = FALSE;
13759 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13760 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13761 if (!did_emsg)
13763 s = alloc(len + 1);
13764 if (s != NULL)
13766 rettv->vval.v_string = s;
13767 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13770 did_emsg |= saved_did_emsg;
13772 #endif
13776 * "pumvisible()" function
13778 /*ARGSUSED*/
13779 static void
13780 f_pumvisible(argvars, rettv)
13781 typval_T *argvars;
13782 typval_T *rettv;
13784 rettv->vval.v_number = 0;
13785 #ifdef FEAT_INS_EXPAND
13786 if (pum_visible())
13787 rettv->vval.v_number = 1;
13788 #endif
13792 * "range()" function
13794 static void
13795 f_range(argvars, rettv)
13796 typval_T *argvars;
13797 typval_T *rettv;
13799 long start;
13800 long end;
13801 long stride = 1;
13802 long i;
13803 int error = FALSE;
13805 start = get_tv_number_chk(&argvars[0], &error);
13806 if (argvars[1].v_type == VAR_UNKNOWN)
13808 end = start - 1;
13809 start = 0;
13811 else
13813 end = get_tv_number_chk(&argvars[1], &error);
13814 if (argvars[2].v_type != VAR_UNKNOWN)
13815 stride = get_tv_number_chk(&argvars[2], &error);
13818 rettv->vval.v_number = 0;
13819 if (error)
13820 return; /* type error; errmsg already given */
13821 if (stride == 0)
13822 EMSG(_("E726: Stride is zero"));
13823 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13824 EMSG(_("E727: Start past end"));
13825 else
13827 if (rettv_list_alloc(rettv) == OK)
13828 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13829 if (list_append_number(rettv->vval.v_list,
13830 (varnumber_T)i) == FAIL)
13831 break;
13836 * "readfile()" function
13838 static void
13839 f_readfile(argvars, rettv)
13840 typval_T *argvars;
13841 typval_T *rettv;
13843 int binary = FALSE;
13844 char_u *fname;
13845 FILE *fd;
13846 listitem_T *li;
13847 #define FREAD_SIZE 200 /* optimized for text lines */
13848 char_u buf[FREAD_SIZE];
13849 int readlen; /* size of last fread() */
13850 int buflen; /* nr of valid chars in buf[] */
13851 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13852 int tolist; /* first byte in buf[] still to be put in list */
13853 int chop; /* how many CR to chop off */
13854 char_u *prev = NULL; /* previously read bytes, if any */
13855 int prevlen = 0; /* length of "prev" if not NULL */
13856 char_u *s;
13857 int len;
13858 long maxline = MAXLNUM;
13859 long cnt = 0;
13861 if (argvars[1].v_type != VAR_UNKNOWN)
13863 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13864 binary = TRUE;
13865 if (argvars[2].v_type != VAR_UNKNOWN)
13866 maxline = get_tv_number(&argvars[2]);
13869 if (rettv_list_alloc(rettv) == FAIL)
13870 return;
13872 /* Always open the file in binary mode, library functions have a mind of
13873 * their own about CR-LF conversion. */
13874 fname = get_tv_string(&argvars[0]);
13875 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13877 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13878 return;
13881 filtd = 0;
13882 while (cnt < maxline || maxline < 0)
13884 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13885 buflen = filtd + readlen;
13886 tolist = 0;
13887 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13889 if (buf[filtd] == '\n' || readlen <= 0)
13891 /* Only when in binary mode add an empty list item when the
13892 * last line ends in a '\n'. */
13893 if (!binary && readlen == 0 && filtd == 0)
13894 break;
13896 /* Found end-of-line or end-of-file: add a text line to the
13897 * list. */
13898 chop = 0;
13899 if (!binary)
13900 while (filtd - chop - 1 >= tolist
13901 && buf[filtd - chop - 1] == '\r')
13902 ++chop;
13903 len = filtd - tolist - chop;
13904 if (prev == NULL)
13905 s = vim_strnsave(buf + tolist, len);
13906 else
13908 s = alloc((unsigned)(prevlen + len + 1));
13909 if (s != NULL)
13911 mch_memmove(s, prev, prevlen);
13912 vim_free(prev);
13913 prev = NULL;
13914 mch_memmove(s + prevlen, buf + tolist, len);
13915 s[prevlen + len] = NUL;
13918 tolist = filtd + 1;
13920 li = listitem_alloc();
13921 if (li == NULL)
13923 vim_free(s);
13924 break;
13926 li->li_tv.v_type = VAR_STRING;
13927 li->li_tv.v_lock = 0;
13928 li->li_tv.vval.v_string = s;
13929 list_append(rettv->vval.v_list, li);
13931 if (++cnt >= maxline && maxline >= 0)
13932 break;
13933 if (readlen <= 0)
13934 break;
13936 else if (buf[filtd] == NUL)
13937 buf[filtd] = '\n';
13939 if (readlen <= 0)
13940 break;
13942 if (tolist == 0)
13944 /* "buf" is full, need to move text to an allocated buffer */
13945 if (prev == NULL)
13947 prev = vim_strnsave(buf, buflen);
13948 prevlen = buflen;
13950 else
13952 s = alloc((unsigned)(prevlen + buflen));
13953 if (s != NULL)
13955 mch_memmove(s, prev, prevlen);
13956 mch_memmove(s + prevlen, buf, buflen);
13957 vim_free(prev);
13958 prev = s;
13959 prevlen += buflen;
13962 filtd = 0;
13964 else
13966 mch_memmove(buf, buf + tolist, buflen - tolist);
13967 filtd -= tolist;
13972 * For a negative line count use only the lines at the end of the file,
13973 * free the rest.
13975 if (maxline < 0)
13976 while (cnt > -maxline)
13978 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13979 --cnt;
13982 vim_free(prev);
13983 fclose(fd);
13986 #if defined(FEAT_RELTIME)
13987 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13990 * Convert a List to proftime_T.
13991 * Return FAIL when there is something wrong.
13993 static int
13994 list2proftime(arg, tm)
13995 typval_T *arg;
13996 proftime_T *tm;
13998 long n1, n2;
13999 int error = FALSE;
14001 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
14002 || arg->vval.v_list->lv_len != 2)
14003 return FAIL;
14004 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
14005 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
14006 # ifdef WIN3264
14007 tm->HighPart = n1;
14008 tm->LowPart = n2;
14009 # else
14010 tm->tv_sec = n1;
14011 tm->tv_usec = n2;
14012 # endif
14013 return error ? FAIL : OK;
14015 #endif /* FEAT_RELTIME */
14018 * "reltime()" function
14020 static void
14021 f_reltime(argvars, rettv)
14022 typval_T *argvars;
14023 typval_T *rettv;
14025 #ifdef FEAT_RELTIME
14026 proftime_T res;
14027 proftime_T start;
14029 if (argvars[0].v_type == VAR_UNKNOWN)
14031 /* No arguments: get current time. */
14032 profile_start(&res);
14034 else if (argvars[1].v_type == VAR_UNKNOWN)
14036 if (list2proftime(&argvars[0], &res) == FAIL)
14037 return;
14038 profile_end(&res);
14040 else
14042 /* Two arguments: compute the difference. */
14043 if (list2proftime(&argvars[0], &start) == FAIL
14044 || list2proftime(&argvars[1], &res) == FAIL)
14045 return;
14046 profile_sub(&res, &start);
14049 if (rettv_list_alloc(rettv) == OK)
14051 long n1, n2;
14053 # ifdef WIN3264
14054 n1 = res.HighPart;
14055 n2 = res.LowPart;
14056 # else
14057 n1 = res.tv_sec;
14058 n2 = res.tv_usec;
14059 # endif
14060 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14061 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14063 #endif
14067 * "reltimestr()" function
14069 static void
14070 f_reltimestr(argvars, rettv)
14071 typval_T *argvars;
14072 typval_T *rettv;
14074 #ifdef FEAT_RELTIME
14075 proftime_T tm;
14076 #endif
14078 rettv->v_type = VAR_STRING;
14079 rettv->vval.v_string = NULL;
14080 #ifdef FEAT_RELTIME
14081 if (list2proftime(&argvars[0], &tm) == OK)
14082 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14083 #endif
14086 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14087 static void make_connection __ARGS((void));
14088 static int check_connection __ARGS((void));
14090 static void
14091 make_connection()
14093 if (X_DISPLAY == NULL
14094 # ifdef FEAT_GUI
14095 && !gui.in_use
14096 # endif
14099 x_force_connect = TRUE;
14100 setup_term_clip();
14101 x_force_connect = FALSE;
14105 static int
14106 check_connection()
14108 make_connection();
14109 if (X_DISPLAY == NULL)
14111 EMSG(_("E240: No connection to Vim server"));
14112 return FAIL;
14114 return OK;
14116 #endif
14118 #ifdef FEAT_CLIENTSERVER
14119 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14121 static void
14122 remote_common(argvars, rettv, expr)
14123 typval_T *argvars;
14124 typval_T *rettv;
14125 int expr;
14127 char_u *server_name;
14128 char_u *keys;
14129 char_u *r = NULL;
14130 char_u buf[NUMBUFLEN];
14131 # ifdef WIN32
14132 HWND w;
14133 # elif defined(FEAT_X11)
14134 Window w;
14135 # elif defined(MAC_CLIENTSERVER)
14136 int w; // This is the port number ('w' is a bit confusing)
14137 # endif
14139 if (check_restricted() || check_secure())
14140 return;
14142 # ifdef FEAT_X11
14143 if (check_connection() == FAIL)
14144 return;
14145 # endif
14147 server_name = get_tv_string_chk(&argvars[0]);
14148 if (server_name == NULL)
14149 return; /* type error; errmsg already given */
14150 keys = get_tv_string_buf(&argvars[1], buf);
14151 # ifdef WIN32
14152 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14153 # elif defined(FEAT_X11)
14154 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14155 < 0)
14156 # elif defined(MAC_CLIENTSERVER)
14157 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14158 # endif
14160 if (r != NULL)
14161 EMSG(r); /* sending worked but evaluation failed */
14162 else
14163 EMSG2(_("E241: Unable to send to %s"), server_name);
14164 return;
14167 rettv->vval.v_string = r;
14169 if (argvars[2].v_type != VAR_UNKNOWN)
14171 dictitem_T v;
14172 char_u str[30];
14173 char_u *idvar;
14175 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14176 v.di_tv.v_type = VAR_STRING;
14177 v.di_tv.vval.v_string = vim_strsave(str);
14178 idvar = get_tv_string_chk(&argvars[2]);
14179 if (idvar != NULL)
14180 set_var(idvar, &v.di_tv, FALSE);
14181 vim_free(v.di_tv.vval.v_string);
14184 #endif
14187 * "remote_expr()" function
14189 /*ARGSUSED*/
14190 static void
14191 f_remote_expr(argvars, rettv)
14192 typval_T *argvars;
14193 typval_T *rettv;
14195 rettv->v_type = VAR_STRING;
14196 rettv->vval.v_string = NULL;
14197 #ifdef FEAT_CLIENTSERVER
14198 remote_common(argvars, rettv, TRUE);
14199 #endif
14203 * "remote_foreground()" function
14205 /*ARGSUSED*/
14206 static void
14207 f_remote_foreground(argvars, rettv)
14208 typval_T *argvars;
14209 typval_T *rettv;
14211 rettv->vval.v_number = 0;
14212 #ifdef FEAT_CLIENTSERVER
14213 # ifdef WIN32
14214 /* On Win32 it's done in this application. */
14216 char_u *server_name = get_tv_string_chk(&argvars[0]);
14218 if (server_name != NULL)
14219 serverForeground(server_name);
14221 # elif defined(FEAT_X11) || defined(MAC_CLIENTSERVER)
14222 /* Send a foreground() expression to the server. */
14223 argvars[1].v_type = VAR_STRING;
14224 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14225 argvars[2].v_type = VAR_UNKNOWN;
14226 remote_common(argvars, rettv, TRUE);
14227 vim_free(argvars[1].vval.v_string);
14228 # endif
14229 #endif
14232 /*ARGSUSED*/
14233 static void
14234 f_remote_peek(argvars, rettv)
14235 typval_T *argvars;
14236 typval_T *rettv;
14238 #ifdef FEAT_CLIENTSERVER
14239 dictitem_T v;
14240 char_u *s = NULL;
14241 # ifdef WIN32
14242 long_u n = 0;
14243 # endif
14244 char_u *serverid;
14246 if (check_restricted() || check_secure())
14248 rettv->vval.v_number = -1;
14249 return;
14251 serverid = get_tv_string_chk(&argvars[0]);
14252 if (serverid == NULL)
14254 rettv->vval.v_number = -1;
14255 return; /* type error; errmsg already given */
14257 # ifdef WIN32
14258 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14259 if (n == 0)
14260 rettv->vval.v_number = -1;
14261 else
14263 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14264 rettv->vval.v_number = (s != NULL);
14266 # elif defined(FEAT_X11)
14267 rettv->vval.v_number = 0;
14268 if (check_connection() == FAIL)
14269 return;
14271 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14272 serverStrToWin(serverid), &s);
14273 # elif defined(MAC_CLIENTSERVER)
14274 rettv->vval.v_number = serverPeekReply(serverStrToPort(serverid), &s);
14275 # endif
14277 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14279 char_u *retvar;
14281 v.di_tv.v_type = VAR_STRING;
14282 v.di_tv.vval.v_string = vim_strsave(s);
14283 retvar = get_tv_string_chk(&argvars[1]);
14284 if (retvar != NULL)
14285 set_var(retvar, &v.di_tv, FALSE);
14286 vim_free(v.di_tv.vval.v_string);
14288 #else
14289 rettv->vval.v_number = -1;
14290 #endif
14293 /*ARGSUSED*/
14294 static void
14295 f_remote_read(argvars, rettv)
14296 typval_T *argvars;
14297 typval_T *rettv;
14299 char_u *r = NULL;
14301 #ifdef FEAT_CLIENTSERVER
14302 char_u *serverid = get_tv_string_chk(&argvars[0]);
14304 if (serverid != NULL && !check_restricted() && !check_secure())
14306 # ifdef WIN32
14307 /* The server's HWND is encoded in the 'id' parameter */
14308 long_u n = 0;
14310 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14311 if (n != 0)
14312 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14313 if (r == NULL)
14314 # elif defined(FEAT_X11)
14315 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14316 serverStrToWin(serverid), &r, FALSE) < 0)
14317 # elif defined(MAC_CLIENTSERVER)
14318 if (serverReadReply(serverStrToPort(serverid), &r) < 0)
14319 # endif
14320 EMSG(_("E277: Unable to read a server reply"));
14322 #endif
14323 rettv->v_type = VAR_STRING;
14324 rettv->vval.v_string = r;
14328 * "remote_send()" function
14330 /*ARGSUSED*/
14331 static void
14332 f_remote_send(argvars, rettv)
14333 typval_T *argvars;
14334 typval_T *rettv;
14336 rettv->v_type = VAR_STRING;
14337 rettv->vval.v_string = NULL;
14338 #ifdef FEAT_CLIENTSERVER
14339 remote_common(argvars, rettv, FALSE);
14340 #endif
14344 * "remove()" function
14346 static void
14347 f_remove(argvars, rettv)
14348 typval_T *argvars;
14349 typval_T *rettv;
14351 list_T *l;
14352 listitem_T *item, *item2;
14353 listitem_T *li;
14354 long idx;
14355 long end;
14356 char_u *key;
14357 dict_T *d;
14358 dictitem_T *di;
14360 rettv->vval.v_number = 0;
14361 if (argvars[0].v_type == VAR_DICT)
14363 if (argvars[2].v_type != VAR_UNKNOWN)
14364 EMSG2(_(e_toomanyarg), "remove()");
14365 else if ((d = argvars[0].vval.v_dict) != NULL
14366 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14368 key = get_tv_string_chk(&argvars[1]);
14369 if (key != NULL)
14371 di = dict_find(d, key, -1);
14372 if (di == NULL)
14373 EMSG2(_(e_dictkey), key);
14374 else
14376 *rettv = di->di_tv;
14377 init_tv(&di->di_tv);
14378 dictitem_remove(d, di);
14383 else if (argvars[0].v_type != VAR_LIST)
14384 EMSG2(_(e_listdictarg), "remove()");
14385 else if ((l = argvars[0].vval.v_list) != NULL
14386 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14388 int error = FALSE;
14390 idx = get_tv_number_chk(&argvars[1], &error);
14391 if (error)
14392 ; /* type error: do nothing, errmsg already given */
14393 else if ((item = list_find(l, idx)) == NULL)
14394 EMSGN(_(e_listidx), idx);
14395 else
14397 if (argvars[2].v_type == VAR_UNKNOWN)
14399 /* Remove one item, return its value. */
14400 list_remove(l, item, item);
14401 *rettv = item->li_tv;
14402 vim_free(item);
14404 else
14406 /* Remove range of items, return list with values. */
14407 end = get_tv_number_chk(&argvars[2], &error);
14408 if (error)
14409 ; /* type error: do nothing */
14410 else if ((item2 = list_find(l, end)) == NULL)
14411 EMSGN(_(e_listidx), end);
14412 else
14414 int cnt = 0;
14416 for (li = item; li != NULL; li = li->li_next)
14418 ++cnt;
14419 if (li == item2)
14420 break;
14422 if (li == NULL) /* didn't find "item2" after "item" */
14423 EMSG(_(e_invrange));
14424 else
14426 list_remove(l, item, item2);
14427 if (rettv_list_alloc(rettv) == OK)
14429 l = rettv->vval.v_list;
14430 l->lv_first = item;
14431 l->lv_last = item2;
14432 item->li_prev = NULL;
14433 item2->li_next = NULL;
14434 l->lv_len = cnt;
14444 * "rename({from}, {to})" function
14446 static void
14447 f_rename(argvars, rettv)
14448 typval_T *argvars;
14449 typval_T *rettv;
14451 char_u buf[NUMBUFLEN];
14453 if (check_restricted() || check_secure())
14454 rettv->vval.v_number = -1;
14455 else
14456 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14457 get_tv_string_buf(&argvars[1], buf));
14461 * "repeat()" function
14463 /*ARGSUSED*/
14464 static void
14465 f_repeat(argvars, rettv)
14466 typval_T *argvars;
14467 typval_T *rettv;
14469 char_u *p;
14470 int n;
14471 int slen;
14472 int len;
14473 char_u *r;
14474 int i;
14476 n = get_tv_number(&argvars[1]);
14477 if (argvars[0].v_type == VAR_LIST)
14479 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14480 while (n-- > 0)
14481 if (list_extend(rettv->vval.v_list,
14482 argvars[0].vval.v_list, NULL) == FAIL)
14483 break;
14485 else
14487 p = get_tv_string(&argvars[0]);
14488 rettv->v_type = VAR_STRING;
14489 rettv->vval.v_string = NULL;
14491 slen = (int)STRLEN(p);
14492 len = slen * n;
14493 if (len <= 0)
14494 return;
14496 r = alloc(len + 1);
14497 if (r != NULL)
14499 for (i = 0; i < n; i++)
14500 mch_memmove(r + i * slen, p, (size_t)slen);
14501 r[len] = NUL;
14504 rettv->vval.v_string = r;
14509 * "resolve()" function
14511 static void
14512 f_resolve(argvars, rettv)
14513 typval_T *argvars;
14514 typval_T *rettv;
14516 char_u *p;
14518 p = get_tv_string(&argvars[0]);
14519 #ifdef FEAT_SHORTCUT
14521 char_u *v = NULL;
14523 v = mch_resolve_shortcut(p);
14524 if (v != NULL)
14525 rettv->vval.v_string = v;
14526 else
14527 rettv->vval.v_string = vim_strsave(p);
14529 #else
14530 # ifdef HAVE_READLINK
14532 char_u buf[MAXPATHL + 1];
14533 char_u *cpy;
14534 int len;
14535 char_u *remain = NULL;
14536 char_u *q;
14537 int is_relative_to_current = FALSE;
14538 int has_trailing_pathsep = FALSE;
14539 int limit = 100;
14541 p = vim_strsave(p);
14543 if (p[0] == '.' && (vim_ispathsep(p[1])
14544 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14545 is_relative_to_current = TRUE;
14547 len = STRLEN(p);
14548 if (len > 0 && after_pathsep(p, p + len))
14549 has_trailing_pathsep = TRUE;
14551 q = getnextcomp(p);
14552 if (*q != NUL)
14554 /* Separate the first path component in "p", and keep the
14555 * remainder (beginning with the path separator). */
14556 remain = vim_strsave(q - 1);
14557 q[-1] = NUL;
14560 for (;;)
14562 for (;;)
14564 len = readlink((char *)p, (char *)buf, MAXPATHL);
14565 if (len <= 0)
14566 break;
14567 buf[len] = NUL;
14569 if (limit-- == 0)
14571 vim_free(p);
14572 vim_free(remain);
14573 EMSG(_("E655: Too many symbolic links (cycle?)"));
14574 rettv->vval.v_string = NULL;
14575 goto fail;
14578 /* Ensure that the result will have a trailing path separator
14579 * if the argument has one. */
14580 if (remain == NULL && has_trailing_pathsep)
14581 add_pathsep(buf);
14583 /* Separate the first path component in the link value and
14584 * concatenate the remainders. */
14585 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14586 if (*q != NUL)
14588 if (remain == NULL)
14589 remain = vim_strsave(q - 1);
14590 else
14592 cpy = concat_str(q - 1, remain);
14593 if (cpy != NULL)
14595 vim_free(remain);
14596 remain = cpy;
14599 q[-1] = NUL;
14602 q = gettail(p);
14603 if (q > p && *q == NUL)
14605 /* Ignore trailing path separator. */
14606 q[-1] = NUL;
14607 q = gettail(p);
14609 if (q > p && !mch_isFullName(buf))
14611 /* symlink is relative to directory of argument */
14612 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14613 if (cpy != NULL)
14615 STRCPY(cpy, p);
14616 STRCPY(gettail(cpy), buf);
14617 vim_free(p);
14618 p = cpy;
14621 else
14623 vim_free(p);
14624 p = vim_strsave(buf);
14628 if (remain == NULL)
14629 break;
14631 /* Append the first path component of "remain" to "p". */
14632 q = getnextcomp(remain + 1);
14633 len = q - remain - (*q != NUL);
14634 cpy = vim_strnsave(p, STRLEN(p) + len);
14635 if (cpy != NULL)
14637 STRNCAT(cpy, remain, len);
14638 vim_free(p);
14639 p = cpy;
14641 /* Shorten "remain". */
14642 if (*q != NUL)
14643 STRMOVE(remain, q - 1);
14644 else
14646 vim_free(remain);
14647 remain = NULL;
14651 /* If the result is a relative path name, make it explicitly relative to
14652 * the current directory if and only if the argument had this form. */
14653 if (!vim_ispathsep(*p))
14655 if (is_relative_to_current
14656 && *p != NUL
14657 && !(p[0] == '.'
14658 && (p[1] == NUL
14659 || vim_ispathsep(p[1])
14660 || (p[1] == '.'
14661 && (p[2] == NUL
14662 || vim_ispathsep(p[2]))))))
14664 /* Prepend "./". */
14665 cpy = concat_str((char_u *)"./", p);
14666 if (cpy != NULL)
14668 vim_free(p);
14669 p = cpy;
14672 else if (!is_relative_to_current)
14674 /* Strip leading "./". */
14675 q = p;
14676 while (q[0] == '.' && vim_ispathsep(q[1]))
14677 q += 2;
14678 if (q > p)
14679 STRMOVE(p, p + 2);
14683 /* Ensure that the result will have no trailing path separator
14684 * if the argument had none. But keep "/" or "//". */
14685 if (!has_trailing_pathsep)
14687 q = p + STRLEN(p);
14688 if (after_pathsep(p, q))
14689 *gettail_sep(p) = NUL;
14692 rettv->vval.v_string = p;
14694 # else
14695 rettv->vval.v_string = vim_strsave(p);
14696 # endif
14697 #endif
14699 simplify_filename(rettv->vval.v_string);
14701 #ifdef HAVE_READLINK
14702 fail:
14703 #endif
14704 rettv->v_type = VAR_STRING;
14708 * "reverse({list})" function
14710 static void
14711 f_reverse(argvars, rettv)
14712 typval_T *argvars;
14713 typval_T *rettv;
14715 list_T *l;
14716 listitem_T *li, *ni;
14718 rettv->vval.v_number = 0;
14719 if (argvars[0].v_type != VAR_LIST)
14720 EMSG2(_(e_listarg), "reverse()");
14721 else if ((l = argvars[0].vval.v_list) != NULL
14722 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14724 li = l->lv_last;
14725 l->lv_first = l->lv_last = NULL;
14726 l->lv_len = 0;
14727 while (li != NULL)
14729 ni = li->li_prev;
14730 list_append(l, li);
14731 li = ni;
14733 rettv->vval.v_list = l;
14734 rettv->v_type = VAR_LIST;
14735 ++l->lv_refcount;
14736 l->lv_idx = l->lv_len - l->lv_idx - 1;
14740 #define SP_NOMOVE 0x01 /* don't move cursor */
14741 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14742 #define SP_RETCOUNT 0x04 /* return matchcount */
14743 #define SP_SETPCMARK 0x08 /* set previous context mark */
14744 #define SP_START 0x10 /* accept match at start position */
14745 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14746 #define SP_END 0x40 /* leave cursor at end of match */
14748 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14751 * Get flags for a search function.
14752 * Possibly sets "p_ws".
14753 * Returns BACKWARD, FORWARD or zero (for an error).
14755 static int
14756 get_search_arg(varp, flagsp)
14757 typval_T *varp;
14758 int *flagsp;
14760 int dir = FORWARD;
14761 char_u *flags;
14762 char_u nbuf[NUMBUFLEN];
14763 int mask;
14765 if (varp->v_type != VAR_UNKNOWN)
14767 flags = get_tv_string_buf_chk(varp, nbuf);
14768 if (flags == NULL)
14769 return 0; /* type error; errmsg already given */
14770 while (*flags != NUL)
14772 switch (*flags)
14774 case 'b': dir = BACKWARD; break;
14775 case 'w': p_ws = TRUE; break;
14776 case 'W': p_ws = FALSE; break;
14777 default: mask = 0;
14778 if (flagsp != NULL)
14779 switch (*flags)
14781 case 'c': mask = SP_START; break;
14782 case 'e': mask = SP_END; break;
14783 case 'm': mask = SP_RETCOUNT; break;
14784 case 'n': mask = SP_NOMOVE; break;
14785 case 'p': mask = SP_SUBPAT; break;
14786 case 'r': mask = SP_REPEAT; break;
14787 case 's': mask = SP_SETPCMARK; break;
14789 if (mask == 0)
14791 EMSG2(_(e_invarg2), flags);
14792 dir = 0;
14794 else
14795 *flagsp |= mask;
14797 if (dir == 0)
14798 break;
14799 ++flags;
14802 return dir;
14806 * Shared by search() and searchpos() functions
14808 static int
14809 search_cmn(argvars, match_pos, flagsp)
14810 typval_T *argvars;
14811 pos_T *match_pos;
14812 int *flagsp;
14814 int flags;
14815 char_u *pat;
14816 pos_T pos;
14817 pos_T save_cursor;
14818 int save_p_ws = p_ws;
14819 int dir;
14820 int retval = 0; /* default: FAIL */
14821 long lnum_stop = 0;
14822 proftime_T tm;
14823 #ifdef FEAT_RELTIME
14824 long time_limit = 0;
14825 #endif
14826 int options = SEARCH_KEEP;
14827 int subpatnum;
14829 pat = get_tv_string(&argvars[0]);
14830 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14831 if (dir == 0)
14832 goto theend;
14833 flags = *flagsp;
14834 if (flags & SP_START)
14835 options |= SEARCH_START;
14836 if (flags & SP_END)
14837 options |= SEARCH_END;
14839 /* Optional arguments: line number to stop searching and timeout. */
14840 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14842 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14843 if (lnum_stop < 0)
14844 goto theend;
14845 #ifdef FEAT_RELTIME
14846 if (argvars[3].v_type != VAR_UNKNOWN)
14848 time_limit = get_tv_number_chk(&argvars[3], NULL);
14849 if (time_limit < 0)
14850 goto theend;
14852 #endif
14855 #ifdef FEAT_RELTIME
14856 /* Set the time limit, if there is one. */
14857 profile_setlimit(time_limit, &tm);
14858 #endif
14861 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14862 * Check to make sure only those flags are set.
14863 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14864 * flags cannot be set. Check for that condition also.
14866 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14867 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14869 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14870 goto theend;
14873 pos = save_cursor = curwin->w_cursor;
14874 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14875 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14876 if (subpatnum != FAIL)
14878 if (flags & SP_SUBPAT)
14879 retval = subpatnum;
14880 else
14881 retval = pos.lnum;
14882 if (flags & SP_SETPCMARK)
14883 setpcmark();
14884 curwin->w_cursor = pos;
14885 if (match_pos != NULL)
14887 /* Store the match cursor position */
14888 match_pos->lnum = pos.lnum;
14889 match_pos->col = pos.col + 1;
14891 /* "/$" will put the cursor after the end of the line, may need to
14892 * correct that here */
14893 check_cursor();
14896 /* If 'n' flag is used: restore cursor position. */
14897 if (flags & SP_NOMOVE)
14898 curwin->w_cursor = save_cursor;
14899 else
14900 curwin->w_set_curswant = TRUE;
14901 theend:
14902 p_ws = save_p_ws;
14904 return retval;
14907 #ifdef FEAT_FLOAT
14909 * "round({float})" function
14911 static void
14912 f_round(argvars, rettv)
14913 typval_T *argvars;
14914 typval_T *rettv;
14916 float_T f;
14918 rettv->v_type = VAR_FLOAT;
14919 if (get_float_arg(argvars, &f) == OK)
14920 /* round() is not in C90, use ceil() or floor() instead. */
14921 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14922 else
14923 rettv->vval.v_float = 0.0;
14925 #endif
14928 * "search()" function
14930 static void
14931 f_search(argvars, rettv)
14932 typval_T *argvars;
14933 typval_T *rettv;
14935 int flags = 0;
14937 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14941 * "searchdecl()" function
14943 static void
14944 f_searchdecl(argvars, rettv)
14945 typval_T *argvars;
14946 typval_T *rettv;
14948 int locally = 1;
14949 int thisblock = 0;
14950 int error = FALSE;
14951 char_u *name;
14953 rettv->vval.v_number = 1; /* default: FAIL */
14955 name = get_tv_string_chk(&argvars[0]);
14956 if (argvars[1].v_type != VAR_UNKNOWN)
14958 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14959 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14960 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14962 if (!error && name != NULL)
14963 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14964 locally, thisblock, SEARCH_KEEP) == FAIL;
14968 * Used by searchpair() and searchpairpos()
14970 static int
14971 searchpair_cmn(argvars, match_pos)
14972 typval_T *argvars;
14973 pos_T *match_pos;
14975 char_u *spat, *mpat, *epat;
14976 char_u *skip;
14977 int save_p_ws = p_ws;
14978 int dir;
14979 int flags = 0;
14980 char_u nbuf1[NUMBUFLEN];
14981 char_u nbuf2[NUMBUFLEN];
14982 char_u nbuf3[NUMBUFLEN];
14983 int retval = 0; /* default: FAIL */
14984 long lnum_stop = 0;
14985 long time_limit = 0;
14987 /* Get the three pattern arguments: start, middle, end. */
14988 spat = get_tv_string_chk(&argvars[0]);
14989 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14990 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14991 if (spat == NULL || mpat == NULL || epat == NULL)
14992 goto theend; /* type error */
14994 /* Handle the optional fourth argument: flags */
14995 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14996 if (dir == 0)
14997 goto theend;
14999 /* Don't accept SP_END or SP_SUBPAT.
15000 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
15002 if ((flags & (SP_END | SP_SUBPAT)) != 0
15003 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
15005 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
15006 goto theend;
15009 /* Using 'r' implies 'W', otherwise it doesn't work. */
15010 if (flags & SP_REPEAT)
15011 p_ws = FALSE;
15013 /* Optional fifth argument: skip expression */
15014 if (argvars[3].v_type == VAR_UNKNOWN
15015 || argvars[4].v_type == VAR_UNKNOWN)
15016 skip = (char_u *)"";
15017 else
15019 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
15020 if (argvars[5].v_type != VAR_UNKNOWN)
15022 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
15023 if (lnum_stop < 0)
15024 goto theend;
15025 #ifdef FEAT_RELTIME
15026 if (argvars[6].v_type != VAR_UNKNOWN)
15028 time_limit = get_tv_number_chk(&argvars[6], NULL);
15029 if (time_limit < 0)
15030 goto theend;
15032 #endif
15035 if (skip == NULL)
15036 goto theend; /* type error */
15038 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
15039 match_pos, lnum_stop, time_limit);
15041 theend:
15042 p_ws = save_p_ws;
15044 return retval;
15048 * "searchpair()" function
15050 static void
15051 f_searchpair(argvars, rettv)
15052 typval_T *argvars;
15053 typval_T *rettv;
15055 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15059 * "searchpairpos()" function
15061 static void
15062 f_searchpairpos(argvars, rettv)
15063 typval_T *argvars;
15064 typval_T *rettv;
15066 pos_T match_pos;
15067 int lnum = 0;
15068 int col = 0;
15070 rettv->vval.v_number = 0;
15072 if (rettv_list_alloc(rettv) == FAIL)
15073 return;
15075 if (searchpair_cmn(argvars, &match_pos) > 0)
15077 lnum = match_pos.lnum;
15078 col = match_pos.col;
15081 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15082 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15086 * Search for a start/middle/end thing.
15087 * Used by searchpair(), see its documentation for the details.
15088 * Returns 0 or -1 for no match,
15090 long
15091 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15092 lnum_stop, time_limit)
15093 char_u *spat; /* start pattern */
15094 char_u *mpat; /* middle pattern */
15095 char_u *epat; /* end pattern */
15096 int dir; /* BACKWARD or FORWARD */
15097 char_u *skip; /* skip expression */
15098 int flags; /* SP_SETPCMARK and other SP_ values */
15099 pos_T *match_pos;
15100 linenr_T lnum_stop; /* stop at this line if not zero */
15101 long time_limit; /* stop after this many msec */
15103 char_u *save_cpo;
15104 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15105 long retval = 0;
15106 pos_T pos;
15107 pos_T firstpos;
15108 pos_T foundpos;
15109 pos_T save_cursor;
15110 pos_T save_pos;
15111 int n;
15112 int r;
15113 int nest = 1;
15114 int err;
15115 int options = SEARCH_KEEP;
15116 proftime_T tm;
15118 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15119 save_cpo = p_cpo;
15120 p_cpo = empty_option;
15122 #ifdef FEAT_RELTIME
15123 /* Set the time limit, if there is one. */
15124 profile_setlimit(time_limit, &tm);
15125 #endif
15127 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15128 * start/middle/end (pat3, for the top pair). */
15129 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15130 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15131 if (pat2 == NULL || pat3 == NULL)
15132 goto theend;
15133 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15134 if (*mpat == NUL)
15135 STRCPY(pat3, pat2);
15136 else
15137 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15138 spat, epat, mpat);
15139 if (flags & SP_START)
15140 options |= SEARCH_START;
15142 save_cursor = curwin->w_cursor;
15143 pos = curwin->w_cursor;
15144 clearpos(&firstpos);
15145 clearpos(&foundpos);
15146 pat = pat3;
15147 for (;;)
15149 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15150 options, RE_SEARCH, lnum_stop, &tm);
15151 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15152 /* didn't find it or found the first match again: FAIL */
15153 break;
15155 if (firstpos.lnum == 0)
15156 firstpos = pos;
15157 if (equalpos(pos, foundpos))
15159 /* Found the same position again. Can happen with a pattern that
15160 * has "\zs" at the end and searching backwards. Advance one
15161 * character and try again. */
15162 if (dir == BACKWARD)
15163 decl(&pos);
15164 else
15165 incl(&pos);
15167 foundpos = pos;
15169 /* clear the start flag to avoid getting stuck here */
15170 options &= ~SEARCH_START;
15172 /* If the skip pattern matches, ignore this match. */
15173 if (*skip != NUL)
15175 save_pos = curwin->w_cursor;
15176 curwin->w_cursor = pos;
15177 r = eval_to_bool(skip, &err, NULL, FALSE);
15178 curwin->w_cursor = save_pos;
15179 if (err)
15181 /* Evaluating {skip} caused an error, break here. */
15182 curwin->w_cursor = save_cursor;
15183 retval = -1;
15184 break;
15186 if (r)
15187 continue;
15190 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15192 /* Found end when searching backwards or start when searching
15193 * forward: nested pair. */
15194 ++nest;
15195 pat = pat2; /* nested, don't search for middle */
15197 else
15199 /* Found end when searching forward or start when searching
15200 * backward: end of (nested) pair; or found middle in outer pair. */
15201 if (--nest == 1)
15202 pat = pat3; /* outer level, search for middle */
15205 if (nest == 0)
15207 /* Found the match: return matchcount or line number. */
15208 if (flags & SP_RETCOUNT)
15209 ++retval;
15210 else
15211 retval = pos.lnum;
15212 if (flags & SP_SETPCMARK)
15213 setpcmark();
15214 curwin->w_cursor = pos;
15215 if (!(flags & SP_REPEAT))
15216 break;
15217 nest = 1; /* search for next unmatched */
15221 if (match_pos != NULL)
15223 /* Store the match cursor position */
15224 match_pos->lnum = curwin->w_cursor.lnum;
15225 match_pos->col = curwin->w_cursor.col + 1;
15228 /* If 'n' flag is used or search failed: restore cursor position. */
15229 if ((flags & SP_NOMOVE) || retval == 0)
15230 curwin->w_cursor = save_cursor;
15232 theend:
15233 vim_free(pat2);
15234 vim_free(pat3);
15235 if (p_cpo == empty_option)
15236 p_cpo = save_cpo;
15237 else
15238 /* Darn, evaluating the {skip} expression changed the value. */
15239 free_string_option(save_cpo);
15241 return retval;
15245 * "searchpos()" function
15247 static void
15248 f_searchpos(argvars, rettv)
15249 typval_T *argvars;
15250 typval_T *rettv;
15252 pos_T match_pos;
15253 int lnum = 0;
15254 int col = 0;
15255 int n;
15256 int flags = 0;
15258 rettv->vval.v_number = 0;
15260 if (rettv_list_alloc(rettv) == FAIL)
15261 return;
15263 n = search_cmn(argvars, &match_pos, &flags);
15264 if (n > 0)
15266 lnum = match_pos.lnum;
15267 col = match_pos.col;
15270 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15271 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15272 if (flags & SP_SUBPAT)
15273 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15277 /*ARGSUSED*/
15278 static void
15279 f_server2client(argvars, rettv)
15280 typval_T *argvars;
15281 typval_T *rettv;
15283 #ifdef FEAT_CLIENTSERVER
15284 char_u buf[NUMBUFLEN];
15285 char_u *server = get_tv_string_chk(&argvars[0]);
15286 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15288 rettv->vval.v_number = -1;
15289 if (server == NULL || reply == NULL)
15290 return;
15291 if (check_restricted() || check_secure())
15292 return;
15293 # ifdef FEAT_X11
15294 if (check_connection() == FAIL)
15295 return;
15296 # endif
15298 if (serverSendReply(server, reply) < 0)
15300 EMSG(_("E258: Unable to send to client"));
15301 return;
15303 rettv->vval.v_number = 0;
15304 #else
15305 rettv->vval.v_number = -1;
15306 #endif
15309 /*ARGSUSED*/
15310 static void
15311 f_serverlist(argvars, rettv)
15312 typval_T *argvars;
15313 typval_T *rettv;
15315 char_u *r = NULL;
15317 #ifdef FEAT_CLIENTSERVER
15318 # if defined(WIN32) || defined(MAC_CLIENTSERVER)
15319 r = serverGetVimNames();
15320 # elif defined(FEAT_X11)
15321 make_connection();
15322 if (X_DISPLAY != NULL)
15323 r = serverGetVimNames(X_DISPLAY);
15324 # endif
15325 #endif
15326 rettv->v_type = VAR_STRING;
15327 rettv->vval.v_string = r;
15331 * "setbufvar()" function
15333 /*ARGSUSED*/
15334 static void
15335 f_setbufvar(argvars, rettv)
15336 typval_T *argvars;
15337 typval_T *rettv;
15339 buf_T *buf;
15340 aco_save_T aco;
15341 char_u *varname, *bufvarname;
15342 typval_T *varp;
15343 char_u nbuf[NUMBUFLEN];
15345 rettv->vval.v_number = 0;
15347 if (check_restricted() || check_secure())
15348 return;
15349 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15350 varname = get_tv_string_chk(&argvars[1]);
15351 buf = get_buf_tv(&argvars[0]);
15352 varp = &argvars[2];
15354 if (buf != NULL && varname != NULL && varp != NULL)
15356 /* set curbuf to be our buf, temporarily */
15357 aucmd_prepbuf(&aco, buf);
15359 if (*varname == '&')
15361 long numval;
15362 char_u *strval;
15363 int error = FALSE;
15365 ++varname;
15366 numval = get_tv_number_chk(varp, &error);
15367 strval = get_tv_string_buf_chk(varp, nbuf);
15368 if (!error && strval != NULL)
15369 set_option_value(varname, numval, strval, OPT_LOCAL);
15371 else
15373 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15374 if (bufvarname != NULL)
15376 STRCPY(bufvarname, "b:");
15377 STRCPY(bufvarname + 2, varname);
15378 set_var(bufvarname, varp, TRUE);
15379 vim_free(bufvarname);
15383 /* reset notion of buffer */
15384 aucmd_restbuf(&aco);
15389 * "setcmdpos()" function
15391 static void
15392 f_setcmdpos(argvars, rettv)
15393 typval_T *argvars;
15394 typval_T *rettv;
15396 int pos = (int)get_tv_number(&argvars[0]) - 1;
15398 if (pos >= 0)
15399 rettv->vval.v_number = set_cmdline_pos(pos);
15403 * "setline()" function
15405 static void
15406 f_setline(argvars, rettv)
15407 typval_T *argvars;
15408 typval_T *rettv;
15410 linenr_T lnum;
15411 char_u *line = NULL;
15412 list_T *l = NULL;
15413 listitem_T *li = NULL;
15414 long added = 0;
15415 linenr_T lcount = curbuf->b_ml.ml_line_count;
15417 lnum = get_tv_lnum(&argvars[0]);
15418 if (argvars[1].v_type == VAR_LIST)
15420 l = argvars[1].vval.v_list;
15421 li = l->lv_first;
15423 else
15424 line = get_tv_string_chk(&argvars[1]);
15426 rettv->vval.v_number = 0; /* OK */
15427 for (;;)
15429 if (l != NULL)
15431 /* list argument, get next string */
15432 if (li == NULL)
15433 break;
15434 line = get_tv_string_chk(&li->li_tv);
15435 li = li->li_next;
15438 rettv->vval.v_number = 1; /* FAIL */
15439 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15440 break;
15441 if (lnum <= curbuf->b_ml.ml_line_count)
15443 /* existing line, replace it */
15444 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15446 changed_bytes(lnum, 0);
15447 if (lnum == curwin->w_cursor.lnum)
15448 check_cursor_col();
15449 rettv->vval.v_number = 0; /* OK */
15452 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15454 /* lnum is one past the last line, append the line */
15455 ++added;
15456 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15457 rettv->vval.v_number = 0; /* OK */
15460 if (l == NULL) /* only one string argument */
15461 break;
15462 ++lnum;
15465 if (added > 0)
15466 appended_lines_mark(lcount, added);
15469 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15472 * Used by "setqflist()" and "setloclist()" functions
15474 /*ARGSUSED*/
15475 static void
15476 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15477 win_T *wp;
15478 typval_T *list_arg;
15479 typval_T *action_arg;
15480 typval_T *rettv;
15482 #ifdef FEAT_QUICKFIX
15483 char_u *act;
15484 int action = ' ';
15485 #endif
15487 rettv->vval.v_number = -1;
15489 #ifdef FEAT_QUICKFIX
15490 if (list_arg->v_type != VAR_LIST)
15491 EMSG(_(e_listreq));
15492 else
15494 list_T *l = list_arg->vval.v_list;
15496 if (action_arg->v_type == VAR_STRING)
15498 act = get_tv_string_chk(action_arg);
15499 if (act == NULL)
15500 return; /* type error; errmsg already given */
15501 if (*act == 'a' || *act == 'r')
15502 action = *act;
15505 if (l != NULL && set_errorlist(wp, l, action) == OK)
15506 rettv->vval.v_number = 0;
15508 #endif
15512 * "setloclist()" function
15514 /*ARGSUSED*/
15515 static void
15516 f_setloclist(argvars, rettv)
15517 typval_T *argvars;
15518 typval_T *rettv;
15520 win_T *win;
15522 rettv->vval.v_number = -1;
15524 win = find_win_by_nr(&argvars[0], NULL);
15525 if (win != NULL)
15526 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15530 * "setmatches()" function
15532 static void
15533 f_setmatches(argvars, rettv)
15534 typval_T *argvars;
15535 typval_T *rettv;
15537 #ifdef FEAT_SEARCH_EXTRA
15538 list_T *l;
15539 listitem_T *li;
15540 dict_T *d;
15542 rettv->vval.v_number = -1;
15543 if (argvars[0].v_type != VAR_LIST)
15545 EMSG(_(e_listreq));
15546 return;
15548 if ((l = argvars[0].vval.v_list) != NULL)
15551 /* To some extent make sure that we are dealing with a list from
15552 * "getmatches()". */
15553 li = l->lv_first;
15554 while (li != NULL)
15556 if (li->li_tv.v_type != VAR_DICT
15557 || (d = li->li_tv.vval.v_dict) == NULL)
15559 EMSG(_(e_invarg));
15560 return;
15562 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15563 && dict_find(d, (char_u *)"pattern", -1) != NULL
15564 && dict_find(d, (char_u *)"priority", -1) != NULL
15565 && dict_find(d, (char_u *)"id", -1) != NULL))
15567 EMSG(_(e_invarg));
15568 return;
15570 li = li->li_next;
15573 clear_matches(curwin);
15574 li = l->lv_first;
15575 while (li != NULL)
15577 d = li->li_tv.vval.v_dict;
15578 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15579 get_dict_string(d, (char_u *)"pattern", FALSE),
15580 (int)get_dict_number(d, (char_u *)"priority"),
15581 (int)get_dict_number(d, (char_u *)"id"));
15582 li = li->li_next;
15584 rettv->vval.v_number = 0;
15586 #endif
15590 * "setpos()" function
15592 /*ARGSUSED*/
15593 static void
15594 f_setpos(argvars, rettv)
15595 typval_T *argvars;
15596 typval_T *rettv;
15598 pos_T pos;
15599 int fnum;
15600 char_u *name;
15602 rettv->vval.v_number = -1;
15603 name = get_tv_string_chk(argvars);
15604 if (name != NULL)
15606 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15608 --pos.col;
15609 if (name[0] == '.' && name[1] == NUL)
15611 /* set cursor */
15612 if (fnum == curbuf->b_fnum)
15614 curwin->w_cursor = pos;
15615 check_cursor();
15616 rettv->vval.v_number = 0;
15618 else
15619 EMSG(_(e_invarg));
15621 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15623 /* set mark */
15624 if (setmark_pos(name[1], &pos, fnum) == OK)
15625 rettv->vval.v_number = 0;
15627 else
15628 EMSG(_(e_invarg));
15634 * "setqflist()" function
15636 /*ARGSUSED*/
15637 static void
15638 f_setqflist(argvars, rettv)
15639 typval_T *argvars;
15640 typval_T *rettv;
15642 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15646 * "setreg()" function
15648 static void
15649 f_setreg(argvars, rettv)
15650 typval_T *argvars;
15651 typval_T *rettv;
15653 int regname;
15654 char_u *strregname;
15655 char_u *stropt;
15656 char_u *strval;
15657 int append;
15658 char_u yank_type;
15659 long block_len;
15661 block_len = -1;
15662 yank_type = MAUTO;
15663 append = FALSE;
15665 strregname = get_tv_string_chk(argvars);
15666 rettv->vval.v_number = 1; /* FAIL is default */
15668 if (strregname == NULL)
15669 return; /* type error; errmsg already given */
15670 regname = *strregname;
15671 if (regname == 0 || regname == '@')
15672 regname = '"';
15673 else if (regname == '=')
15674 return;
15676 if (argvars[2].v_type != VAR_UNKNOWN)
15678 stropt = get_tv_string_chk(&argvars[2]);
15679 if (stropt == NULL)
15680 return; /* type error */
15681 for (; *stropt != NUL; ++stropt)
15682 switch (*stropt)
15684 case 'a': case 'A': /* append */
15685 append = TRUE;
15686 break;
15687 case 'v': case 'c': /* character-wise selection */
15688 yank_type = MCHAR;
15689 break;
15690 case 'V': case 'l': /* line-wise selection */
15691 yank_type = MLINE;
15692 break;
15693 #ifdef FEAT_VISUAL
15694 case 'b': case Ctrl_V: /* block-wise selection */
15695 yank_type = MBLOCK;
15696 if (VIM_ISDIGIT(stropt[1]))
15698 ++stropt;
15699 block_len = getdigits(&stropt) - 1;
15700 --stropt;
15702 break;
15703 #endif
15707 strval = get_tv_string_chk(&argvars[1]);
15708 if (strval != NULL)
15709 write_reg_contents_ex(regname, strval, -1,
15710 append, yank_type, block_len);
15711 rettv->vval.v_number = 0;
15715 * "settabwinvar()" function
15717 static void
15718 f_settabwinvar(argvars, rettv)
15719 typval_T *argvars;
15720 typval_T *rettv;
15722 setwinvar(argvars, rettv, 1);
15726 * "setwinvar()" function
15728 static void
15729 f_setwinvar(argvars, rettv)
15730 typval_T *argvars;
15731 typval_T *rettv;
15733 setwinvar(argvars, rettv, 0);
15737 * "setwinvar()" and "settabwinvar()" functions
15739 static void
15740 setwinvar(argvars, rettv, off)
15741 typval_T *argvars;
15742 typval_T *rettv;
15743 int off;
15745 win_T *win;
15746 #ifdef FEAT_WINDOWS
15747 win_T *save_curwin;
15748 tabpage_T *save_curtab;
15749 #endif
15750 char_u *varname, *winvarname;
15751 typval_T *varp;
15752 char_u nbuf[NUMBUFLEN];
15753 tabpage_T *tp;
15755 rettv->vval.v_number = 0;
15757 if (check_restricted() || check_secure())
15758 return;
15760 #ifdef FEAT_WINDOWS
15761 if (off == 1)
15762 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15763 else
15764 tp = curtab;
15765 #endif
15766 win = find_win_by_nr(&argvars[off], tp);
15767 varname = get_tv_string_chk(&argvars[off + 1]);
15768 varp = &argvars[off + 2];
15770 if (win != NULL && varname != NULL && varp != NULL)
15772 #ifdef FEAT_WINDOWS
15773 /* set curwin to be our win, temporarily */
15774 save_curwin = curwin;
15775 save_curtab = curtab;
15776 goto_tabpage_tp(tp);
15777 if (!win_valid(win))
15778 return;
15779 curwin = win;
15780 curbuf = curwin->w_buffer;
15781 #endif
15783 if (*varname == '&')
15785 long numval;
15786 char_u *strval;
15787 int error = FALSE;
15789 ++varname;
15790 numval = get_tv_number_chk(varp, &error);
15791 strval = get_tv_string_buf_chk(varp, nbuf);
15792 if (!error && strval != NULL)
15793 set_option_value(varname, numval, strval, OPT_LOCAL);
15795 else
15797 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15798 if (winvarname != NULL)
15800 STRCPY(winvarname, "w:");
15801 STRCPY(winvarname + 2, varname);
15802 set_var(winvarname, varp, TRUE);
15803 vim_free(winvarname);
15807 #ifdef FEAT_WINDOWS
15808 /* Restore current tabpage and window, if still valid (autocomands can
15809 * make them invalid). */
15810 if (valid_tabpage(save_curtab))
15811 goto_tabpage_tp(save_curtab);
15812 if (win_valid(save_curwin))
15814 curwin = save_curwin;
15815 curbuf = curwin->w_buffer;
15817 #endif
15822 * "shellescape({string})" function
15824 static void
15825 f_shellescape(argvars, rettv)
15826 typval_T *argvars;
15827 typval_T *rettv;
15829 rettv->vval.v_string = vim_strsave_shellescape(
15830 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15831 rettv->v_type = VAR_STRING;
15835 * "simplify()" function
15837 static void
15838 f_simplify(argvars, rettv)
15839 typval_T *argvars;
15840 typval_T *rettv;
15842 char_u *p;
15844 p = get_tv_string(&argvars[0]);
15845 rettv->vval.v_string = vim_strsave(p);
15846 simplify_filename(rettv->vval.v_string); /* simplify in place */
15847 rettv->v_type = VAR_STRING;
15850 #ifdef FEAT_FLOAT
15852 * "sin()" function
15854 static void
15855 f_sin(argvars, rettv)
15856 typval_T *argvars;
15857 typval_T *rettv;
15859 float_T f;
15861 rettv->v_type = VAR_FLOAT;
15862 if (get_float_arg(argvars, &f) == OK)
15863 rettv->vval.v_float = sin(f);
15864 else
15865 rettv->vval.v_float = 0.0;
15867 #endif
15869 static int
15870 #ifdef __BORLANDC__
15871 _RTLENTRYF
15872 #endif
15873 item_compare __ARGS((const void *s1, const void *s2));
15874 static int
15875 #ifdef __BORLANDC__
15876 _RTLENTRYF
15877 #endif
15878 item_compare2 __ARGS((const void *s1, const void *s2));
15880 static int item_compare_ic;
15881 static char_u *item_compare_func;
15882 static int item_compare_func_err;
15883 #define ITEM_COMPARE_FAIL 999
15886 * Compare functions for f_sort() below.
15888 static int
15889 #ifdef __BORLANDC__
15890 _RTLENTRYF
15891 #endif
15892 item_compare(s1, s2)
15893 const void *s1;
15894 const void *s2;
15896 char_u *p1, *p2;
15897 char_u *tofree1, *tofree2;
15898 int res;
15899 char_u numbuf1[NUMBUFLEN];
15900 char_u numbuf2[NUMBUFLEN];
15902 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15903 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15904 if (p1 == NULL)
15905 p1 = (char_u *)"";
15906 if (p2 == NULL)
15907 p2 = (char_u *)"";
15908 if (item_compare_ic)
15909 res = STRICMP(p1, p2);
15910 else
15911 res = STRCMP(p1, p2);
15912 vim_free(tofree1);
15913 vim_free(tofree2);
15914 return res;
15917 static int
15918 #ifdef __BORLANDC__
15919 _RTLENTRYF
15920 #endif
15921 item_compare2(s1, s2)
15922 const void *s1;
15923 const void *s2;
15925 int res;
15926 typval_T rettv;
15927 typval_T argv[3];
15928 int dummy;
15930 /* shortcut after failure in previous call; compare all items equal */
15931 if (item_compare_func_err)
15932 return 0;
15934 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15935 * in the copy without changing the original list items. */
15936 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15937 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15939 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15940 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15941 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15942 clear_tv(&argv[0]);
15943 clear_tv(&argv[1]);
15945 if (res == FAIL)
15946 res = ITEM_COMPARE_FAIL;
15947 else
15948 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15949 if (item_compare_func_err)
15950 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15951 clear_tv(&rettv);
15952 return res;
15956 * "sort({list})" function
15958 static void
15959 f_sort(argvars, rettv)
15960 typval_T *argvars;
15961 typval_T *rettv;
15963 list_T *l;
15964 listitem_T *li;
15965 listitem_T **ptrs;
15966 long len;
15967 long i;
15969 rettv->vval.v_number = 0;
15970 if (argvars[0].v_type != VAR_LIST)
15971 EMSG2(_(e_listarg), "sort()");
15972 else
15974 l = argvars[0].vval.v_list;
15975 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15976 return;
15977 rettv->vval.v_list = l;
15978 rettv->v_type = VAR_LIST;
15979 ++l->lv_refcount;
15981 len = list_len(l);
15982 if (len <= 1)
15983 return; /* short list sorts pretty quickly */
15985 item_compare_ic = FALSE;
15986 item_compare_func = NULL;
15987 if (argvars[1].v_type != VAR_UNKNOWN)
15989 if (argvars[1].v_type == VAR_FUNC)
15990 item_compare_func = argvars[1].vval.v_string;
15991 else
15993 int error = FALSE;
15995 i = get_tv_number_chk(&argvars[1], &error);
15996 if (error)
15997 return; /* type error; errmsg already given */
15998 if (i == 1)
15999 item_compare_ic = TRUE;
16000 else
16001 item_compare_func = get_tv_string(&argvars[1]);
16005 /* Make an array with each entry pointing to an item in the List. */
16006 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
16007 if (ptrs == NULL)
16008 return;
16009 i = 0;
16010 for (li = l->lv_first; li != NULL; li = li->li_next)
16011 ptrs[i++] = li;
16013 item_compare_func_err = FALSE;
16014 /* test the compare function */
16015 if (item_compare_func != NULL
16016 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
16017 == ITEM_COMPARE_FAIL)
16018 EMSG(_("E702: Sort compare function failed"));
16019 else
16021 /* Sort the array with item pointers. */
16022 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
16023 item_compare_func == NULL ? item_compare : item_compare2);
16025 if (!item_compare_func_err)
16027 /* Clear the List and append the items in the sorted order. */
16028 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
16029 l->lv_len = 0;
16030 for (i = 0; i < len; ++i)
16031 list_append(l, ptrs[i]);
16035 vim_free(ptrs);
16040 * "soundfold({word})" function
16042 static void
16043 f_soundfold(argvars, rettv)
16044 typval_T *argvars;
16045 typval_T *rettv;
16047 char_u *s;
16049 rettv->v_type = VAR_STRING;
16050 s = get_tv_string(&argvars[0]);
16051 #ifdef FEAT_SPELL
16052 rettv->vval.v_string = eval_soundfold(s);
16053 #else
16054 rettv->vval.v_string = vim_strsave(s);
16055 #endif
16059 * "spellbadword()" function
16061 /* ARGSUSED */
16062 static void
16063 f_spellbadword(argvars, rettv)
16064 typval_T *argvars;
16065 typval_T *rettv;
16067 char_u *word = (char_u *)"";
16068 hlf_T attr = HLF_COUNT;
16069 int len = 0;
16071 if (rettv_list_alloc(rettv) == FAIL)
16072 return;
16074 #ifdef FEAT_SPELL
16075 if (argvars[0].v_type == VAR_UNKNOWN)
16077 /* Find the start and length of the badly spelled word. */
16078 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16079 if (len != 0)
16080 word = ml_get_cursor();
16082 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16084 char_u *str = get_tv_string_chk(&argvars[0]);
16085 int capcol = -1;
16087 if (str != NULL)
16089 /* Check the argument for spelling. */
16090 while (*str != NUL)
16092 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16093 if (attr != HLF_COUNT)
16095 word = str;
16096 break;
16098 str += len;
16102 #endif
16104 list_append_string(rettv->vval.v_list, word, len);
16105 list_append_string(rettv->vval.v_list, (char_u *)(
16106 attr == HLF_SPB ? "bad" :
16107 attr == HLF_SPR ? "rare" :
16108 attr == HLF_SPL ? "local" :
16109 attr == HLF_SPC ? "caps" :
16110 ""), -1);
16114 * "spellsuggest()" function
16116 /*ARGSUSED*/
16117 static void
16118 f_spellsuggest(argvars, rettv)
16119 typval_T *argvars;
16120 typval_T *rettv;
16122 #ifdef FEAT_SPELL
16123 char_u *str;
16124 int typeerr = FALSE;
16125 int maxcount;
16126 garray_T ga;
16127 int i;
16128 listitem_T *li;
16129 int need_capital = FALSE;
16130 #endif
16132 if (rettv_list_alloc(rettv) == FAIL)
16133 return;
16135 #ifdef FEAT_SPELL
16136 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16138 str = get_tv_string(&argvars[0]);
16139 if (argvars[1].v_type != VAR_UNKNOWN)
16141 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16142 if (maxcount <= 0)
16143 return;
16144 if (argvars[2].v_type != VAR_UNKNOWN)
16146 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16147 if (typeerr)
16148 return;
16151 else
16152 maxcount = 25;
16154 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16156 for (i = 0; i < ga.ga_len; ++i)
16158 str = ((char_u **)ga.ga_data)[i];
16160 li = listitem_alloc();
16161 if (li == NULL)
16162 vim_free(str);
16163 else
16165 li->li_tv.v_type = VAR_STRING;
16166 li->li_tv.v_lock = 0;
16167 li->li_tv.vval.v_string = str;
16168 list_append(rettv->vval.v_list, li);
16171 ga_clear(&ga);
16173 #endif
16176 static void
16177 f_split(argvars, rettv)
16178 typval_T *argvars;
16179 typval_T *rettv;
16181 char_u *str;
16182 char_u *end;
16183 char_u *pat = NULL;
16184 regmatch_T regmatch;
16185 char_u patbuf[NUMBUFLEN];
16186 char_u *save_cpo;
16187 int match;
16188 colnr_T col = 0;
16189 int keepempty = FALSE;
16190 int typeerr = FALSE;
16192 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16193 save_cpo = p_cpo;
16194 p_cpo = (char_u *)"";
16196 str = get_tv_string(&argvars[0]);
16197 if (argvars[1].v_type != VAR_UNKNOWN)
16199 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16200 if (pat == NULL)
16201 typeerr = TRUE;
16202 if (argvars[2].v_type != VAR_UNKNOWN)
16203 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16205 if (pat == NULL || *pat == NUL)
16206 pat = (char_u *)"[\\x01- ]\\+";
16208 if (rettv_list_alloc(rettv) == FAIL)
16209 return;
16210 if (typeerr)
16211 return;
16213 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16214 if (regmatch.regprog != NULL)
16216 regmatch.rm_ic = FALSE;
16217 while (*str != NUL || keepempty)
16219 if (*str == NUL)
16220 match = FALSE; /* empty item at the end */
16221 else
16222 match = vim_regexec_nl(&regmatch, str, col);
16223 if (match)
16224 end = regmatch.startp[0];
16225 else
16226 end = str + STRLEN(str);
16227 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16228 && *str != NUL && match && end < regmatch.endp[0]))
16230 if (list_append_string(rettv->vval.v_list, str,
16231 (int)(end - str)) == FAIL)
16232 break;
16234 if (!match)
16235 break;
16236 /* Advance to just after the match. */
16237 if (regmatch.endp[0] > str)
16238 col = 0;
16239 else
16241 /* Don't get stuck at the same match. */
16242 #ifdef FEAT_MBYTE
16243 col = (*mb_ptr2len)(regmatch.endp[0]);
16244 #else
16245 col = 1;
16246 #endif
16248 str = regmatch.endp[0];
16251 vim_free(regmatch.regprog);
16254 p_cpo = save_cpo;
16257 #ifdef FEAT_FLOAT
16259 * "sqrt()" function
16261 static void
16262 f_sqrt(argvars, rettv)
16263 typval_T *argvars;
16264 typval_T *rettv;
16266 float_T f;
16268 rettv->v_type = VAR_FLOAT;
16269 if (get_float_arg(argvars, &f) == OK)
16270 rettv->vval.v_float = sqrt(f);
16271 else
16272 rettv->vval.v_float = 0.0;
16276 * "str2float()" function
16278 static void
16279 f_str2float(argvars, rettv)
16280 typval_T *argvars;
16281 typval_T *rettv;
16283 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16285 if (*p == '+')
16286 p = skipwhite(p + 1);
16287 (void)string2float(p, &rettv->vval.v_float);
16288 rettv->v_type = VAR_FLOAT;
16290 #endif
16293 * "str2nr()" function
16295 static void
16296 f_str2nr(argvars, rettv)
16297 typval_T *argvars;
16298 typval_T *rettv;
16300 int base = 10;
16301 char_u *p;
16302 long n;
16304 if (argvars[1].v_type != VAR_UNKNOWN)
16306 base = get_tv_number(&argvars[1]);
16307 if (base != 8 && base != 10 && base != 16)
16309 EMSG(_(e_invarg));
16310 return;
16314 p = skipwhite(get_tv_string(&argvars[0]));
16315 if (*p == '+')
16316 p = skipwhite(p + 1);
16317 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16318 rettv->vval.v_number = n;
16321 #ifdef HAVE_STRFTIME
16323 * "strftime({format}[, {time}])" function
16325 static void
16326 f_strftime(argvars, rettv)
16327 typval_T *argvars;
16328 typval_T *rettv;
16330 char_u result_buf[256];
16331 struct tm *curtime;
16332 time_t seconds;
16333 char_u *p;
16335 rettv->v_type = VAR_STRING;
16337 p = get_tv_string(&argvars[0]);
16338 if (argvars[1].v_type == VAR_UNKNOWN)
16339 seconds = time(NULL);
16340 else
16341 seconds = (time_t)get_tv_number(&argvars[1]);
16342 curtime = localtime(&seconds);
16343 /* MSVC returns NULL for an invalid value of seconds. */
16344 if (curtime == NULL)
16345 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16346 else
16348 # ifdef FEAT_MBYTE
16349 vimconv_T conv;
16350 char_u *enc;
16352 conv.vc_type = CONV_NONE;
16353 enc = enc_locale();
16354 convert_setup(&conv, p_enc, enc);
16355 if (conv.vc_type != CONV_NONE)
16356 p = string_convert(&conv, p, NULL);
16357 # endif
16358 if (p != NULL)
16359 (void)strftime((char *)result_buf, sizeof(result_buf),
16360 (char *)p, curtime);
16361 else
16362 result_buf[0] = NUL;
16364 # ifdef FEAT_MBYTE
16365 if (conv.vc_type != CONV_NONE)
16366 vim_free(p);
16367 convert_setup(&conv, enc, p_enc);
16368 if (conv.vc_type != CONV_NONE)
16369 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16370 else
16371 # endif
16372 rettv->vval.v_string = vim_strsave(result_buf);
16374 # ifdef FEAT_MBYTE
16375 /* Release conversion descriptors */
16376 convert_setup(&conv, NULL, NULL);
16377 vim_free(enc);
16378 # endif
16381 #endif
16384 * "stridx()" function
16386 static void
16387 f_stridx(argvars, rettv)
16388 typval_T *argvars;
16389 typval_T *rettv;
16391 char_u buf[NUMBUFLEN];
16392 char_u *needle;
16393 char_u *haystack;
16394 char_u *save_haystack;
16395 char_u *pos;
16396 int start_idx;
16398 needle = get_tv_string_chk(&argvars[1]);
16399 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16400 rettv->vval.v_number = -1;
16401 if (needle == NULL || haystack == NULL)
16402 return; /* type error; errmsg already given */
16404 if (argvars[2].v_type != VAR_UNKNOWN)
16406 int error = FALSE;
16408 start_idx = get_tv_number_chk(&argvars[2], &error);
16409 if (error || start_idx >= (int)STRLEN(haystack))
16410 return;
16411 if (start_idx >= 0)
16412 haystack += start_idx;
16415 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16416 if (pos != NULL)
16417 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16421 * "string()" function
16423 static void
16424 f_string(argvars, rettv)
16425 typval_T *argvars;
16426 typval_T *rettv;
16428 char_u *tofree;
16429 char_u numbuf[NUMBUFLEN];
16431 rettv->v_type = VAR_STRING;
16432 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16433 /* Make a copy if we have a value but it's not in allocated memory. */
16434 if (rettv->vval.v_string != NULL && tofree == NULL)
16435 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16439 * "strlen()" function
16441 static void
16442 f_strlen(argvars, rettv)
16443 typval_T *argvars;
16444 typval_T *rettv;
16446 rettv->vval.v_number = (varnumber_T)(STRLEN(
16447 get_tv_string(&argvars[0])));
16451 * "strpart()" function
16453 static void
16454 f_strpart(argvars, rettv)
16455 typval_T *argvars;
16456 typval_T *rettv;
16458 char_u *p;
16459 int n;
16460 int len;
16461 int slen;
16462 int error = FALSE;
16464 p = get_tv_string(&argvars[0]);
16465 slen = (int)STRLEN(p);
16467 n = get_tv_number_chk(&argvars[1], &error);
16468 if (error)
16469 len = 0;
16470 else if (argvars[2].v_type != VAR_UNKNOWN)
16471 len = get_tv_number(&argvars[2]);
16472 else
16473 len = slen - n; /* default len: all bytes that are available. */
16476 * Only return the overlap between the specified part and the actual
16477 * string.
16479 if (n < 0)
16481 len += n;
16482 n = 0;
16484 else if (n > slen)
16485 n = slen;
16486 if (len < 0)
16487 len = 0;
16488 else if (n + len > slen)
16489 len = slen - n;
16491 rettv->v_type = VAR_STRING;
16492 rettv->vval.v_string = vim_strnsave(p + n, len);
16496 * "strridx()" function
16498 static void
16499 f_strridx(argvars, rettv)
16500 typval_T *argvars;
16501 typval_T *rettv;
16503 char_u buf[NUMBUFLEN];
16504 char_u *needle;
16505 char_u *haystack;
16506 char_u *rest;
16507 char_u *lastmatch = NULL;
16508 int haystack_len, end_idx;
16510 needle = get_tv_string_chk(&argvars[1]);
16511 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16513 rettv->vval.v_number = -1;
16514 if (needle == NULL || haystack == NULL)
16515 return; /* type error; errmsg already given */
16517 haystack_len = (int)STRLEN(haystack);
16518 if (argvars[2].v_type != VAR_UNKNOWN)
16520 /* Third argument: upper limit for index */
16521 end_idx = get_tv_number_chk(&argvars[2], NULL);
16522 if (end_idx < 0)
16523 return; /* can never find a match */
16525 else
16526 end_idx = haystack_len;
16528 if (*needle == NUL)
16530 /* Empty string matches past the end. */
16531 lastmatch = haystack + end_idx;
16533 else
16535 for (rest = haystack; *rest != '\0'; ++rest)
16537 rest = (char_u *)strstr((char *)rest, (char *)needle);
16538 if (rest == NULL || rest > haystack + end_idx)
16539 break;
16540 lastmatch = rest;
16544 if (lastmatch == NULL)
16545 rettv->vval.v_number = -1;
16546 else
16547 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16551 * "strtrans()" function
16553 static void
16554 f_strtrans(argvars, rettv)
16555 typval_T *argvars;
16556 typval_T *rettv;
16558 rettv->v_type = VAR_STRING;
16559 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16563 * "submatch()" function
16565 static void
16566 f_submatch(argvars, rettv)
16567 typval_T *argvars;
16568 typval_T *rettv;
16570 rettv->v_type = VAR_STRING;
16571 rettv->vval.v_string =
16572 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16576 * "substitute()" function
16578 static void
16579 f_substitute(argvars, rettv)
16580 typval_T *argvars;
16581 typval_T *rettv;
16583 char_u patbuf[NUMBUFLEN];
16584 char_u subbuf[NUMBUFLEN];
16585 char_u flagsbuf[NUMBUFLEN];
16587 char_u *str = get_tv_string_chk(&argvars[0]);
16588 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16589 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16590 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16592 rettv->v_type = VAR_STRING;
16593 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16594 rettv->vval.v_string = NULL;
16595 else
16596 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16600 * "synID(lnum, col, trans)" function
16602 /*ARGSUSED*/
16603 static void
16604 f_synID(argvars, rettv)
16605 typval_T *argvars;
16606 typval_T *rettv;
16608 int id = 0;
16609 #ifdef FEAT_SYN_HL
16610 long lnum;
16611 long col;
16612 int trans;
16613 int transerr = FALSE;
16615 lnum = get_tv_lnum(argvars); /* -1 on type error */
16616 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16617 trans = get_tv_number_chk(&argvars[2], &transerr);
16619 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16620 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16621 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16622 #endif
16624 rettv->vval.v_number = id;
16628 * "synIDattr(id, what [, mode])" function
16630 /*ARGSUSED*/
16631 static void
16632 f_synIDattr(argvars, rettv)
16633 typval_T *argvars;
16634 typval_T *rettv;
16636 char_u *p = NULL;
16637 #ifdef FEAT_SYN_HL
16638 int id;
16639 char_u *what;
16640 char_u *mode;
16641 char_u modebuf[NUMBUFLEN];
16642 int modec;
16644 id = get_tv_number(&argvars[0]);
16645 what = get_tv_string(&argvars[1]);
16646 if (argvars[2].v_type != VAR_UNKNOWN)
16648 mode = get_tv_string_buf(&argvars[2], modebuf);
16649 modec = TOLOWER_ASC(mode[0]);
16650 if (modec != 't' && modec != 'c'
16651 #ifdef FEAT_GUI
16652 && modec != 'g'
16653 #endif
16655 modec = 0; /* replace invalid with current */
16657 else
16659 #ifdef FEAT_GUI
16660 if (gui.in_use)
16661 modec = 'g';
16662 else
16663 #endif
16664 if (t_colors > 1)
16665 modec = 'c';
16666 else
16667 modec = 't';
16671 switch (TOLOWER_ASC(what[0]))
16673 case 'b':
16674 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16675 p = highlight_color(id, what, modec);
16676 else /* bold */
16677 p = highlight_has_attr(id, HL_BOLD, modec);
16678 break;
16680 case 'f': /* fg[#] */
16681 p = highlight_color(id, what, modec);
16682 break;
16684 case 'i':
16685 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16686 p = highlight_has_attr(id, HL_INVERSE, modec);
16687 else /* italic */
16688 p = highlight_has_attr(id, HL_ITALIC, modec);
16689 break;
16691 case 'n': /* name */
16692 p = get_highlight_name(NULL, id - 1);
16693 break;
16695 case 'r': /* reverse */
16696 p = highlight_has_attr(id, HL_INVERSE, modec);
16697 break;
16699 case 's':
16700 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16701 p = highlight_color(id, what, modec);
16702 else /* standout */
16703 p = highlight_has_attr(id, HL_STANDOUT, modec);
16704 break;
16706 case 'u':
16707 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16708 /* underline */
16709 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16710 else
16711 /* undercurl */
16712 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16713 break;
16716 if (p != NULL)
16717 p = vim_strsave(p);
16718 #endif
16719 rettv->v_type = VAR_STRING;
16720 rettv->vval.v_string = p;
16724 * "synIDtrans(id)" function
16726 /*ARGSUSED*/
16727 static void
16728 f_synIDtrans(argvars, rettv)
16729 typval_T *argvars;
16730 typval_T *rettv;
16732 int id;
16734 #ifdef FEAT_SYN_HL
16735 id = get_tv_number(&argvars[0]);
16737 if (id > 0)
16738 id = syn_get_final_id(id);
16739 else
16740 #endif
16741 id = 0;
16743 rettv->vval.v_number = id;
16747 * "synstack(lnum, col)" function
16749 /*ARGSUSED*/
16750 static void
16751 f_synstack(argvars, rettv)
16752 typval_T *argvars;
16753 typval_T *rettv;
16755 #ifdef FEAT_SYN_HL
16756 long lnum;
16757 long col;
16758 int i;
16759 int id;
16760 #endif
16762 rettv->v_type = VAR_LIST;
16763 rettv->vval.v_list = NULL;
16765 #ifdef FEAT_SYN_HL
16766 lnum = get_tv_lnum(argvars); /* -1 on type error */
16767 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16769 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16770 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16771 && rettv_list_alloc(rettv) != FAIL)
16773 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16774 for (i = 0; ; ++i)
16776 id = syn_get_stack_item(i);
16777 if (id < 0)
16778 break;
16779 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16780 break;
16783 #endif
16787 * "system()" function
16789 static void
16790 f_system(argvars, rettv)
16791 typval_T *argvars;
16792 typval_T *rettv;
16794 char_u *res = NULL;
16795 char_u *p;
16796 char_u *infile = NULL;
16797 char_u buf[NUMBUFLEN];
16798 int err = FALSE;
16799 FILE *fd;
16801 if (check_restricted() || check_secure())
16802 goto done;
16804 if (argvars[1].v_type != VAR_UNKNOWN)
16807 * Write the string to a temp file, to be used for input of the shell
16808 * command.
16810 if ((infile = vim_tempname('i')) == NULL)
16812 EMSG(_(e_notmp));
16813 goto done;
16816 fd = mch_fopen((char *)infile, WRITEBIN);
16817 if (fd == NULL)
16819 EMSG2(_(e_notopen), infile);
16820 goto done;
16822 p = get_tv_string_buf_chk(&argvars[1], buf);
16823 if (p == NULL)
16825 fclose(fd);
16826 goto done; /* type error; errmsg already given */
16828 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16829 err = TRUE;
16830 if (fclose(fd) != 0)
16831 err = TRUE;
16832 if (err)
16834 EMSG(_("E677: Error writing temp file"));
16835 goto done;
16839 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16840 SHELL_SILENT | SHELL_COOKED);
16842 #ifdef USE_CR
16843 /* translate <CR> into <NL> */
16844 if (res != NULL)
16846 char_u *s;
16848 for (s = res; *s; ++s)
16850 if (*s == CAR)
16851 *s = NL;
16854 #else
16855 # ifdef USE_CRNL
16856 /* translate <CR><NL> into <NL> */
16857 if (res != NULL)
16859 char_u *s, *d;
16861 d = res;
16862 for (s = res; *s; ++s)
16864 if (s[0] == CAR && s[1] == NL)
16865 ++s;
16866 *d++ = *s;
16868 *d = NUL;
16870 # endif
16871 #endif
16873 done:
16874 if (infile != NULL)
16876 mch_remove(infile);
16877 vim_free(infile);
16879 rettv->v_type = VAR_STRING;
16880 rettv->vval.v_string = res;
16884 * "tabpagebuflist()" function
16886 /* ARGSUSED */
16887 static void
16888 f_tabpagebuflist(argvars, rettv)
16889 typval_T *argvars;
16890 typval_T *rettv;
16892 #ifndef FEAT_WINDOWS
16893 rettv->vval.v_number = 0;
16894 #else
16895 tabpage_T *tp;
16896 win_T *wp = NULL;
16898 if (argvars[0].v_type == VAR_UNKNOWN)
16899 wp = firstwin;
16900 else
16902 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16903 if (tp != NULL)
16904 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16906 if (wp == NULL)
16907 rettv->vval.v_number = 0;
16908 else
16910 if (rettv_list_alloc(rettv) == FAIL)
16911 rettv->vval.v_number = 0;
16912 else
16914 for (; wp != NULL; wp = wp->w_next)
16915 if (list_append_number(rettv->vval.v_list,
16916 wp->w_buffer->b_fnum) == FAIL)
16917 break;
16920 #endif
16925 * "tabpagenr()" function
16927 /* ARGSUSED */
16928 static void
16929 f_tabpagenr(argvars, rettv)
16930 typval_T *argvars;
16931 typval_T *rettv;
16933 int nr = 1;
16934 #ifdef FEAT_WINDOWS
16935 char_u *arg;
16937 if (argvars[0].v_type != VAR_UNKNOWN)
16939 arg = get_tv_string_chk(&argvars[0]);
16940 nr = 0;
16941 if (arg != NULL)
16943 if (STRCMP(arg, "$") == 0)
16944 nr = tabpage_index(NULL) - 1;
16945 else
16946 EMSG2(_(e_invexpr2), arg);
16949 else
16950 nr = tabpage_index(curtab);
16951 #endif
16952 rettv->vval.v_number = nr;
16956 #ifdef FEAT_WINDOWS
16957 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16960 * Common code for tabpagewinnr() and winnr().
16962 static int
16963 get_winnr(tp, argvar)
16964 tabpage_T *tp;
16965 typval_T *argvar;
16967 win_T *twin;
16968 int nr = 1;
16969 win_T *wp;
16970 char_u *arg;
16972 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16973 if (argvar->v_type != VAR_UNKNOWN)
16975 arg = get_tv_string_chk(argvar);
16976 if (arg == NULL)
16977 nr = 0; /* type error; errmsg already given */
16978 else if (STRCMP(arg, "$") == 0)
16979 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16980 else if (STRCMP(arg, "#") == 0)
16982 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16983 if (twin == NULL)
16984 nr = 0;
16986 else
16988 EMSG2(_(e_invexpr2), arg);
16989 nr = 0;
16993 if (nr > 0)
16994 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16995 wp != twin; wp = wp->w_next)
16997 if (wp == NULL)
16999 /* didn't find it in this tabpage */
17000 nr = 0;
17001 break;
17003 ++nr;
17005 return nr;
17007 #endif
17010 * "tabpagewinnr()" function
17012 /* ARGSUSED */
17013 static void
17014 f_tabpagewinnr(argvars, rettv)
17015 typval_T *argvars;
17016 typval_T *rettv;
17018 int nr = 1;
17019 #ifdef FEAT_WINDOWS
17020 tabpage_T *tp;
17022 tp = find_tabpage((int)get_tv_number(&argvars[0]));
17023 if (tp == NULL)
17024 nr = 0;
17025 else
17026 nr = get_winnr(tp, &argvars[1]);
17027 #endif
17028 rettv->vval.v_number = nr;
17033 * "tagfiles()" function
17035 /*ARGSUSED*/
17036 static void
17037 f_tagfiles(argvars, rettv)
17038 typval_T *argvars;
17039 typval_T *rettv;
17041 char_u fname[MAXPATHL + 1];
17042 tagname_T tn;
17043 int first;
17045 if (rettv_list_alloc(rettv) == FAIL)
17047 rettv->vval.v_number = 0;
17048 return;
17051 for (first = TRUE; ; first = FALSE)
17052 if (get_tagfname(&tn, first, fname) == FAIL
17053 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
17054 break;
17055 tagname_free(&tn);
17059 * "taglist()" function
17061 static void
17062 f_taglist(argvars, rettv)
17063 typval_T *argvars;
17064 typval_T *rettv;
17066 char_u *tag_pattern;
17068 tag_pattern = get_tv_string(&argvars[0]);
17070 rettv->vval.v_number = FALSE;
17071 if (*tag_pattern == NUL)
17072 return;
17074 if (rettv_list_alloc(rettv) == OK)
17075 (void)get_tags(rettv->vval.v_list, tag_pattern);
17079 * "tempname()" function
17081 /*ARGSUSED*/
17082 static void
17083 f_tempname(argvars, rettv)
17084 typval_T *argvars;
17085 typval_T *rettv;
17087 static int x = 'A';
17089 rettv->v_type = VAR_STRING;
17090 rettv->vval.v_string = vim_tempname(x);
17092 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17093 * names. Skip 'I' and 'O', they are used for shell redirection. */
17096 if (x == 'Z')
17097 x = '0';
17098 else if (x == '9')
17099 x = 'A';
17100 else
17102 #ifdef EBCDIC
17103 if (x == 'I')
17104 x = 'J';
17105 else if (x == 'R')
17106 x = 'S';
17107 else
17108 #endif
17109 ++x;
17111 } while (x == 'I' || x == 'O');
17115 * "test(list)" function: Just checking the walls...
17117 /*ARGSUSED*/
17118 static void
17119 f_test(argvars, rettv)
17120 typval_T *argvars;
17121 typval_T *rettv;
17123 /* Used for unit testing. Change the code below to your liking. */
17124 #if 0
17125 listitem_T *li;
17126 list_T *l;
17127 char_u *bad, *good;
17129 if (argvars[0].v_type != VAR_LIST)
17130 return;
17131 l = argvars[0].vval.v_list;
17132 if (l == NULL)
17133 return;
17134 li = l->lv_first;
17135 if (li == NULL)
17136 return;
17137 bad = get_tv_string(&li->li_tv);
17138 li = li->li_next;
17139 if (li == NULL)
17140 return;
17141 good = get_tv_string(&li->li_tv);
17142 rettv->vval.v_number = test_edit_score(bad, good);
17143 #endif
17147 * "tolower(string)" function
17149 static void
17150 f_tolower(argvars, rettv)
17151 typval_T *argvars;
17152 typval_T *rettv;
17154 char_u *p;
17156 p = vim_strsave(get_tv_string(&argvars[0]));
17157 rettv->v_type = VAR_STRING;
17158 rettv->vval.v_string = p;
17160 if (p != NULL)
17161 while (*p != NUL)
17163 #ifdef FEAT_MBYTE
17164 int l;
17166 if (enc_utf8)
17168 int c, lc;
17170 c = utf_ptr2char(p);
17171 lc = utf_tolower(c);
17172 l = utf_ptr2len(p);
17173 /* TODO: reallocate string when byte count changes. */
17174 if (utf_char2len(lc) == l)
17175 utf_char2bytes(lc, p);
17176 p += l;
17178 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17179 p += l; /* skip multi-byte character */
17180 else
17181 #endif
17183 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17184 ++p;
17190 * "toupper(string)" function
17192 static void
17193 f_toupper(argvars, rettv)
17194 typval_T *argvars;
17195 typval_T *rettv;
17197 rettv->v_type = VAR_STRING;
17198 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17202 * "tr(string, fromstr, tostr)" function
17204 static void
17205 f_tr(argvars, rettv)
17206 typval_T *argvars;
17207 typval_T *rettv;
17209 char_u *instr;
17210 char_u *fromstr;
17211 char_u *tostr;
17212 char_u *p;
17213 #ifdef FEAT_MBYTE
17214 int inlen;
17215 int fromlen;
17216 int tolen;
17217 int idx;
17218 char_u *cpstr;
17219 int cplen;
17220 int first = TRUE;
17221 #endif
17222 char_u buf[NUMBUFLEN];
17223 char_u buf2[NUMBUFLEN];
17224 garray_T ga;
17226 instr = get_tv_string(&argvars[0]);
17227 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17228 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17230 /* Default return value: empty string. */
17231 rettv->v_type = VAR_STRING;
17232 rettv->vval.v_string = NULL;
17233 if (fromstr == NULL || tostr == NULL)
17234 return; /* type error; errmsg already given */
17235 ga_init2(&ga, (int)sizeof(char), 80);
17237 #ifdef FEAT_MBYTE
17238 if (!has_mbyte)
17239 #endif
17240 /* not multi-byte: fromstr and tostr must be the same length */
17241 if (STRLEN(fromstr) != STRLEN(tostr))
17243 #ifdef FEAT_MBYTE
17244 error:
17245 #endif
17246 EMSG2(_(e_invarg2), fromstr);
17247 ga_clear(&ga);
17248 return;
17251 /* fromstr and tostr have to contain the same number of chars */
17252 while (*instr != NUL)
17254 #ifdef FEAT_MBYTE
17255 if (has_mbyte)
17257 inlen = (*mb_ptr2len)(instr);
17258 cpstr = instr;
17259 cplen = inlen;
17260 idx = 0;
17261 for (p = fromstr; *p != NUL; p += fromlen)
17263 fromlen = (*mb_ptr2len)(p);
17264 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17266 for (p = tostr; *p != NUL; p += tolen)
17268 tolen = (*mb_ptr2len)(p);
17269 if (idx-- == 0)
17271 cplen = tolen;
17272 cpstr = p;
17273 break;
17276 if (*p == NUL) /* tostr is shorter than fromstr */
17277 goto error;
17278 break;
17280 ++idx;
17283 if (first && cpstr == instr)
17285 /* Check that fromstr and tostr have the same number of
17286 * (multi-byte) characters. Done only once when a character
17287 * of instr doesn't appear in fromstr. */
17288 first = FALSE;
17289 for (p = tostr; *p != NUL; p += tolen)
17291 tolen = (*mb_ptr2len)(p);
17292 --idx;
17294 if (idx != 0)
17295 goto error;
17298 ga_grow(&ga, cplen);
17299 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17300 ga.ga_len += cplen;
17302 instr += inlen;
17304 else
17305 #endif
17307 /* When not using multi-byte chars we can do it faster. */
17308 p = vim_strchr(fromstr, *instr);
17309 if (p != NULL)
17310 ga_append(&ga, tostr[p - fromstr]);
17311 else
17312 ga_append(&ga, *instr);
17313 ++instr;
17317 /* add a terminating NUL */
17318 ga_grow(&ga, 1);
17319 ga_append(&ga, NUL);
17321 rettv->vval.v_string = ga.ga_data;
17324 #ifdef FEAT_FLOAT
17326 * "trunc({float})" function
17328 static void
17329 f_trunc(argvars, rettv)
17330 typval_T *argvars;
17331 typval_T *rettv;
17333 float_T f;
17335 rettv->v_type = VAR_FLOAT;
17336 if (get_float_arg(argvars, &f) == OK)
17337 /* trunc() is not in C90, use floor() or ceil() instead. */
17338 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17339 else
17340 rettv->vval.v_float = 0.0;
17342 #endif
17345 * "type(expr)" function
17347 static void
17348 f_type(argvars, rettv)
17349 typval_T *argvars;
17350 typval_T *rettv;
17352 int n;
17354 switch (argvars[0].v_type)
17356 case VAR_NUMBER: n = 0; break;
17357 case VAR_STRING: n = 1; break;
17358 case VAR_FUNC: n = 2; break;
17359 case VAR_LIST: n = 3; break;
17360 case VAR_DICT: n = 4; break;
17361 #ifdef FEAT_FLOAT
17362 case VAR_FLOAT: n = 5; break;
17363 #endif
17364 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17366 rettv->vval.v_number = n;
17370 * "values(dict)" function
17372 static void
17373 f_values(argvars, rettv)
17374 typval_T *argvars;
17375 typval_T *rettv;
17377 dict_list(argvars, rettv, 1);
17381 * "virtcol(string)" function
17383 static void
17384 f_virtcol(argvars, rettv)
17385 typval_T *argvars;
17386 typval_T *rettv;
17388 colnr_T vcol = 0;
17389 pos_T *fp;
17390 int fnum = curbuf->b_fnum;
17392 fp = var2fpos(&argvars[0], FALSE, &fnum);
17393 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17394 && fnum == curbuf->b_fnum)
17396 getvvcol(curwin, fp, NULL, NULL, &vcol);
17397 ++vcol;
17400 rettv->vval.v_number = vcol;
17404 * "visualmode()" function
17406 /*ARGSUSED*/
17407 static void
17408 f_visualmode(argvars, rettv)
17409 typval_T *argvars;
17410 typval_T *rettv;
17412 #ifdef FEAT_VISUAL
17413 char_u str[2];
17415 rettv->v_type = VAR_STRING;
17416 str[0] = curbuf->b_visual_mode_eval;
17417 str[1] = NUL;
17418 rettv->vval.v_string = vim_strsave(str);
17420 /* A non-zero number or non-empty string argument: reset mode. */
17421 if (non_zero_arg(&argvars[0]))
17422 curbuf->b_visual_mode_eval = NUL;
17423 #else
17424 rettv->vval.v_number = 0; /* return anything, it won't work anyway */
17425 #endif
17429 * "winbufnr(nr)" function
17431 static void
17432 f_winbufnr(argvars, rettv)
17433 typval_T *argvars;
17434 typval_T *rettv;
17436 win_T *wp;
17438 wp = find_win_by_nr(&argvars[0], NULL);
17439 if (wp == NULL)
17440 rettv->vval.v_number = -1;
17441 else
17442 rettv->vval.v_number = wp->w_buffer->b_fnum;
17446 * "wincol()" function
17448 /*ARGSUSED*/
17449 static void
17450 f_wincol(argvars, rettv)
17451 typval_T *argvars;
17452 typval_T *rettv;
17454 validate_cursor();
17455 rettv->vval.v_number = curwin->w_wcol + 1;
17459 * "winheight(nr)" function
17461 static void
17462 f_winheight(argvars, rettv)
17463 typval_T *argvars;
17464 typval_T *rettv;
17466 win_T *wp;
17468 wp = find_win_by_nr(&argvars[0], NULL);
17469 if (wp == NULL)
17470 rettv->vval.v_number = -1;
17471 else
17472 rettv->vval.v_number = wp->w_height;
17476 * "winline()" function
17478 /*ARGSUSED*/
17479 static void
17480 f_winline(argvars, rettv)
17481 typval_T *argvars;
17482 typval_T *rettv;
17484 validate_cursor();
17485 rettv->vval.v_number = curwin->w_wrow + 1;
17489 * "winnr()" function
17491 /* ARGSUSED */
17492 static void
17493 f_winnr(argvars, rettv)
17494 typval_T *argvars;
17495 typval_T *rettv;
17497 int nr = 1;
17499 #ifdef FEAT_WINDOWS
17500 nr = get_winnr(curtab, &argvars[0]);
17501 #endif
17502 rettv->vval.v_number = nr;
17506 * "winrestcmd()" function
17508 /* ARGSUSED */
17509 static void
17510 f_winrestcmd(argvars, rettv)
17511 typval_T *argvars;
17512 typval_T *rettv;
17514 #ifdef FEAT_WINDOWS
17515 win_T *wp;
17516 int winnr = 1;
17517 garray_T ga;
17518 char_u buf[50];
17520 ga_init2(&ga, (int)sizeof(char), 70);
17521 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17523 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17524 ga_concat(&ga, buf);
17525 # ifdef FEAT_VERTSPLIT
17526 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17527 ga_concat(&ga, buf);
17528 # endif
17529 ++winnr;
17531 ga_append(&ga, NUL);
17533 rettv->vval.v_string = ga.ga_data;
17534 #else
17535 rettv->vval.v_string = NULL;
17536 #endif
17537 rettv->v_type = VAR_STRING;
17541 * "winrestview()" function
17543 /* ARGSUSED */
17544 static void
17545 f_winrestview(argvars, rettv)
17546 typval_T *argvars;
17547 typval_T *rettv;
17549 dict_T *dict;
17551 if (argvars[0].v_type != VAR_DICT
17552 || (dict = argvars[0].vval.v_dict) == NULL)
17553 EMSG(_(e_invarg));
17554 else
17556 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17557 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17558 #ifdef FEAT_VIRTUALEDIT
17559 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17560 #endif
17561 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17562 curwin->w_set_curswant = FALSE;
17564 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17565 #ifdef FEAT_DIFF
17566 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17567 #endif
17568 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17569 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17571 check_cursor();
17572 changed_cline_bef_curs();
17573 invalidate_botline();
17574 redraw_later(VALID);
17576 if (curwin->w_topline == 0)
17577 curwin->w_topline = 1;
17578 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17579 curwin->w_topline = curbuf->b_ml.ml_line_count;
17580 #ifdef FEAT_DIFF
17581 check_topfill(curwin, TRUE);
17582 #endif
17587 * "winsaveview()" function
17589 /* ARGSUSED */
17590 static void
17591 f_winsaveview(argvars, rettv)
17592 typval_T *argvars;
17593 typval_T *rettv;
17595 dict_T *dict;
17597 dict = dict_alloc();
17598 if (dict == NULL)
17599 return;
17600 rettv->v_type = VAR_DICT;
17601 rettv->vval.v_dict = dict;
17602 ++dict->dv_refcount;
17604 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17605 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17606 #ifdef FEAT_VIRTUALEDIT
17607 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17608 #endif
17609 update_curswant();
17610 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17612 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17613 #ifdef FEAT_DIFF
17614 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17615 #endif
17616 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17617 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17621 * "winwidth(nr)" function
17623 static void
17624 f_winwidth(argvars, rettv)
17625 typval_T *argvars;
17626 typval_T *rettv;
17628 win_T *wp;
17630 wp = find_win_by_nr(&argvars[0], NULL);
17631 if (wp == NULL)
17632 rettv->vval.v_number = -1;
17633 else
17634 #ifdef FEAT_VERTSPLIT
17635 rettv->vval.v_number = wp->w_width;
17636 #else
17637 rettv->vval.v_number = Columns;
17638 #endif
17642 * "writefile()" function
17644 static void
17645 f_writefile(argvars, rettv)
17646 typval_T *argvars;
17647 typval_T *rettv;
17649 int binary = FALSE;
17650 char_u *fname;
17651 FILE *fd;
17652 listitem_T *li;
17653 char_u *s;
17654 int ret = 0;
17655 int c;
17657 if (check_restricted() || check_secure())
17658 return;
17660 if (argvars[0].v_type != VAR_LIST)
17662 EMSG2(_(e_listarg), "writefile()");
17663 return;
17665 if (argvars[0].vval.v_list == NULL)
17666 return;
17668 if (argvars[2].v_type != VAR_UNKNOWN
17669 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17670 binary = TRUE;
17672 /* Always open the file in binary mode, library functions have a mind of
17673 * their own about CR-LF conversion. */
17674 fname = get_tv_string(&argvars[1]);
17675 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17677 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17678 ret = -1;
17680 else
17682 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17683 li = li->li_next)
17685 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17687 if (*s == '\n')
17688 c = putc(NUL, fd);
17689 else
17690 c = putc(*s, fd);
17691 if (c == EOF)
17693 ret = -1;
17694 break;
17697 if (!binary || li->li_next != NULL)
17698 if (putc('\n', fd) == EOF)
17700 ret = -1;
17701 break;
17703 if (ret < 0)
17705 EMSG(_(e_write));
17706 break;
17709 fclose(fd);
17712 rettv->vval.v_number = ret;
17716 * Translate a String variable into a position.
17717 * Returns NULL when there is an error.
17719 static pos_T *
17720 var2fpos(varp, dollar_lnum, fnum)
17721 typval_T *varp;
17722 int dollar_lnum; /* TRUE when $ is last line */
17723 int *fnum; /* set to fnum for '0, 'A, etc. */
17725 char_u *name;
17726 static pos_T pos;
17727 pos_T *pp;
17729 /* Argument can be [lnum, col, coladd]. */
17730 if (varp->v_type == VAR_LIST)
17732 list_T *l;
17733 int len;
17734 int error = FALSE;
17735 listitem_T *li;
17737 l = varp->vval.v_list;
17738 if (l == NULL)
17739 return NULL;
17741 /* Get the line number */
17742 pos.lnum = list_find_nr(l, 0L, &error);
17743 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17744 return NULL; /* invalid line number */
17746 /* Get the column number */
17747 pos.col = list_find_nr(l, 1L, &error);
17748 if (error)
17749 return NULL;
17750 len = (long)STRLEN(ml_get(pos.lnum));
17752 /* We accept "$" for the column number: last column. */
17753 li = list_find(l, 1L);
17754 if (li != NULL && li->li_tv.v_type == VAR_STRING
17755 && li->li_tv.vval.v_string != NULL
17756 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17757 pos.col = len + 1;
17759 /* Accept a position up to the NUL after the line. */
17760 if (pos.col == 0 || (int)pos.col > len + 1)
17761 return NULL; /* invalid column number */
17762 --pos.col;
17764 #ifdef FEAT_VIRTUALEDIT
17765 /* Get the virtual offset. Defaults to zero. */
17766 pos.coladd = list_find_nr(l, 2L, &error);
17767 if (error)
17768 pos.coladd = 0;
17769 #endif
17771 return &pos;
17774 name = get_tv_string_chk(varp);
17775 if (name == NULL)
17776 return NULL;
17777 if (name[0] == '.') /* cursor */
17778 return &curwin->w_cursor;
17779 #ifdef FEAT_VISUAL
17780 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17782 if (VIsual_active)
17783 return &VIsual;
17784 return &curwin->w_cursor;
17786 #endif
17787 if (name[0] == '\'') /* mark */
17789 pp = getmark_fnum(name[1], FALSE, fnum);
17790 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17791 return NULL;
17792 return pp;
17795 #ifdef FEAT_VIRTUALEDIT
17796 pos.coladd = 0;
17797 #endif
17799 if (name[0] == 'w' && dollar_lnum)
17801 pos.col = 0;
17802 if (name[1] == '0') /* "w0": first visible line */
17804 update_topline();
17805 pos.lnum = curwin->w_topline;
17806 return &pos;
17808 else if (name[1] == '$') /* "w$": last visible line */
17810 validate_botline();
17811 pos.lnum = curwin->w_botline - 1;
17812 return &pos;
17815 else if (name[0] == '$') /* last column or line */
17817 if (dollar_lnum)
17819 pos.lnum = curbuf->b_ml.ml_line_count;
17820 pos.col = 0;
17822 else
17824 pos.lnum = curwin->w_cursor.lnum;
17825 pos.col = (colnr_T)STRLEN(ml_get_curline());
17827 return &pos;
17829 return NULL;
17833 * Convert list in "arg" into a position and optional file number.
17834 * When "fnump" is NULL there is no file number, only 3 items.
17835 * Note that the column is passed on as-is, the caller may want to decrement
17836 * it to use 1 for the first column.
17837 * Return FAIL when conversion is not possible, doesn't check the position for
17838 * validity.
17840 static int
17841 list2fpos(arg, posp, fnump)
17842 typval_T *arg;
17843 pos_T *posp;
17844 int *fnump;
17846 list_T *l = arg->vval.v_list;
17847 long i = 0;
17848 long n;
17850 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17851 * when "fnump" isn't NULL and "coladd" is optional. */
17852 if (arg->v_type != VAR_LIST
17853 || l == NULL
17854 || l->lv_len < (fnump == NULL ? 2 : 3)
17855 || l->lv_len > (fnump == NULL ? 3 : 4))
17856 return FAIL;
17858 if (fnump != NULL)
17860 n = list_find_nr(l, i++, NULL); /* fnum */
17861 if (n < 0)
17862 return FAIL;
17863 if (n == 0)
17864 n = curbuf->b_fnum; /* current buffer */
17865 *fnump = n;
17868 n = list_find_nr(l, i++, NULL); /* lnum */
17869 if (n < 0)
17870 return FAIL;
17871 posp->lnum = n;
17873 n = list_find_nr(l, i++, NULL); /* col */
17874 if (n < 0)
17875 return FAIL;
17876 posp->col = n;
17878 #ifdef FEAT_VIRTUALEDIT
17879 n = list_find_nr(l, i, NULL);
17880 if (n < 0)
17881 posp->coladd = 0;
17882 else
17883 posp->coladd = n;
17884 #endif
17886 return OK;
17890 * Get the length of an environment variable name.
17891 * Advance "arg" to the first character after the name.
17892 * Return 0 for error.
17894 static int
17895 get_env_len(arg)
17896 char_u **arg;
17898 char_u *p;
17899 int len;
17901 for (p = *arg; vim_isIDc(*p); ++p)
17903 if (p == *arg) /* no name found */
17904 return 0;
17906 len = (int)(p - *arg);
17907 *arg = p;
17908 return len;
17912 * Get the length of the name of a function or internal variable.
17913 * "arg" is advanced to the first non-white character after the name.
17914 * Return 0 if something is wrong.
17916 static int
17917 get_id_len(arg)
17918 char_u **arg;
17920 char_u *p;
17921 int len;
17923 /* Find the end of the name. */
17924 for (p = *arg; eval_isnamec(*p); ++p)
17926 if (p == *arg) /* no name found */
17927 return 0;
17929 len = (int)(p - *arg);
17930 *arg = skipwhite(p);
17932 return len;
17936 * Get the length of the name of a variable or function.
17937 * Only the name is recognized, does not handle ".key" or "[idx]".
17938 * "arg" is advanced to the first non-white character after the name.
17939 * Return -1 if curly braces expansion failed.
17940 * Return 0 if something else is wrong.
17941 * If the name contains 'magic' {}'s, expand them and return the
17942 * expanded name in an allocated string via 'alias' - caller must free.
17944 static int
17945 get_name_len(arg, alias, evaluate, verbose)
17946 char_u **arg;
17947 char_u **alias;
17948 int evaluate;
17949 int verbose;
17951 int len;
17952 char_u *p;
17953 char_u *expr_start;
17954 char_u *expr_end;
17956 *alias = NULL; /* default to no alias */
17958 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17959 && (*arg)[2] == (int)KE_SNR)
17961 /* hard coded <SNR>, already translated */
17962 *arg += 3;
17963 return get_id_len(arg) + 3;
17965 len = eval_fname_script(*arg);
17966 if (len > 0)
17968 /* literal "<SID>", "s:" or "<SNR>" */
17969 *arg += len;
17973 * Find the end of the name; check for {} construction.
17975 p = find_name_end(*arg, &expr_start, &expr_end,
17976 len > 0 ? 0 : FNE_CHECK_START);
17977 if (expr_start != NULL)
17979 char_u *temp_string;
17981 if (!evaluate)
17983 len += (int)(p - *arg);
17984 *arg = skipwhite(p);
17985 return len;
17989 * Include any <SID> etc in the expanded string:
17990 * Thus the -len here.
17992 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17993 if (temp_string == NULL)
17994 return -1;
17995 *alias = temp_string;
17996 *arg = skipwhite(p);
17997 return (int)STRLEN(temp_string);
18000 len += get_id_len(arg);
18001 if (len == 0 && verbose)
18002 EMSG2(_(e_invexpr2), *arg);
18004 return len;
18008 * Find the end of a variable or function name, taking care of magic braces.
18009 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
18010 * start and end of the first magic braces item.
18011 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
18012 * Return a pointer to just after the name. Equal to "arg" if there is no
18013 * valid name.
18015 static char_u *
18016 find_name_end(arg, expr_start, expr_end, flags)
18017 char_u *arg;
18018 char_u **expr_start;
18019 char_u **expr_end;
18020 int flags;
18022 int mb_nest = 0;
18023 int br_nest = 0;
18024 char_u *p;
18026 if (expr_start != NULL)
18028 *expr_start = NULL;
18029 *expr_end = NULL;
18032 /* Quick check for valid starting character. */
18033 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
18034 return arg;
18036 for (p = arg; *p != NUL
18037 && (eval_isnamec(*p)
18038 || *p == '{'
18039 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
18040 || mb_nest != 0
18041 || br_nest != 0); mb_ptr_adv(p))
18043 if (*p == '\'')
18045 /* skip over 'string' to avoid counting [ and ] inside it. */
18046 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
18048 if (*p == NUL)
18049 break;
18051 else if (*p == '"')
18053 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
18054 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
18055 if (*p == '\\' && p[1] != NUL)
18056 ++p;
18057 if (*p == NUL)
18058 break;
18061 if (mb_nest == 0)
18063 if (*p == '[')
18064 ++br_nest;
18065 else if (*p == ']')
18066 --br_nest;
18069 if (br_nest == 0)
18071 if (*p == '{')
18073 mb_nest++;
18074 if (expr_start != NULL && *expr_start == NULL)
18075 *expr_start = p;
18077 else if (*p == '}')
18079 mb_nest--;
18080 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18081 *expr_end = p;
18086 return p;
18090 * Expands out the 'magic' {}'s in a variable/function name.
18091 * Note that this can call itself recursively, to deal with
18092 * constructs like foo{bar}{baz}{bam}
18093 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18094 * "in_start" ^
18095 * "expr_start" ^
18096 * "expr_end" ^
18097 * "in_end" ^
18099 * Returns a new allocated string, which the caller must free.
18100 * Returns NULL for failure.
18102 static char_u *
18103 make_expanded_name(in_start, expr_start, expr_end, in_end)
18104 char_u *in_start;
18105 char_u *expr_start;
18106 char_u *expr_end;
18107 char_u *in_end;
18109 char_u c1;
18110 char_u *retval = NULL;
18111 char_u *temp_result;
18112 char_u *nextcmd = NULL;
18114 if (expr_end == NULL || in_end == NULL)
18115 return NULL;
18116 *expr_start = NUL;
18117 *expr_end = NUL;
18118 c1 = *in_end;
18119 *in_end = NUL;
18121 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18122 if (temp_result != NULL && nextcmd == NULL)
18124 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18125 + (in_end - expr_end) + 1));
18126 if (retval != NULL)
18128 STRCPY(retval, in_start);
18129 STRCAT(retval, temp_result);
18130 STRCAT(retval, expr_end + 1);
18133 vim_free(temp_result);
18135 *in_end = c1; /* put char back for error messages */
18136 *expr_start = '{';
18137 *expr_end = '}';
18139 if (retval != NULL)
18141 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18142 if (expr_start != NULL)
18144 /* Further expansion! */
18145 temp_result = make_expanded_name(retval, expr_start,
18146 expr_end, temp_result);
18147 vim_free(retval);
18148 retval = temp_result;
18152 return retval;
18156 * Return TRUE if character "c" can be used in a variable or function name.
18157 * Does not include '{' or '}' for magic braces.
18159 static int
18160 eval_isnamec(c)
18161 int c;
18163 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18167 * Return TRUE if character "c" can be used as the first character in a
18168 * variable or function name (excluding '{' and '}').
18170 static int
18171 eval_isnamec1(c)
18172 int c;
18174 return (ASCII_ISALPHA(c) || c == '_');
18178 * Set number v: variable to "val".
18180 void
18181 set_vim_var_nr(idx, val)
18182 int idx;
18183 long val;
18185 vimvars[idx].vv_nr = val;
18189 * Get number v: variable value.
18191 long
18192 get_vim_var_nr(idx)
18193 int idx;
18195 return vimvars[idx].vv_nr;
18199 * Get string v: variable value. Uses a static buffer, can only be used once.
18201 char_u *
18202 get_vim_var_str(idx)
18203 int idx;
18205 return get_tv_string(&vimvars[idx].vv_tv);
18209 * Get List v: variable value. Caller must take care of reference count when
18210 * needed.
18212 list_T *
18213 get_vim_var_list(idx)
18214 int idx;
18216 return vimvars[idx].vv_list;
18220 * Set v:count to "count" and v:count1 to "count1".
18221 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18223 void
18224 set_vcount(count, count1, set_prevcount)
18225 long count;
18226 long count1;
18227 int set_prevcount;
18229 if (set_prevcount)
18230 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18231 vimvars[VV_COUNT].vv_nr = count;
18232 vimvars[VV_COUNT1].vv_nr = count1;
18236 * Set string v: variable to a copy of "val".
18238 void
18239 set_vim_var_string(idx, val, len)
18240 int idx;
18241 char_u *val;
18242 int len; /* length of "val" to use or -1 (whole string) */
18244 /* Need to do this (at least) once, since we can't initialize a union.
18245 * Will always be invoked when "v:progname" is set. */
18246 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18248 vim_free(vimvars[idx].vv_str);
18249 if (val == NULL)
18250 vimvars[idx].vv_str = NULL;
18251 else if (len == -1)
18252 vimvars[idx].vv_str = vim_strsave(val);
18253 else
18254 vimvars[idx].vv_str = vim_strnsave(val, len);
18258 * Set List v: variable to "val".
18260 void
18261 set_vim_var_list(idx, val)
18262 int idx;
18263 list_T *val;
18265 list_unref(vimvars[idx].vv_list);
18266 vimvars[idx].vv_list = val;
18267 if (val != NULL)
18268 ++val->lv_refcount;
18272 * Set v:register if needed.
18274 void
18275 set_reg_var(c)
18276 int c;
18278 char_u regname;
18280 if (c == 0 || c == ' ')
18281 regname = '"';
18282 else
18283 regname = c;
18284 /* Avoid free/alloc when the value is already right. */
18285 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18286 set_vim_var_string(VV_REG, &regname, 1);
18290 * Get or set v:exception. If "oldval" == NULL, return the current value.
18291 * Otherwise, restore the value to "oldval" and return NULL.
18292 * Must always be called in pairs to save and restore v:exception! Does not
18293 * take care of memory allocations.
18295 char_u *
18296 v_exception(oldval)
18297 char_u *oldval;
18299 if (oldval == NULL)
18300 return vimvars[VV_EXCEPTION].vv_str;
18302 vimvars[VV_EXCEPTION].vv_str = oldval;
18303 return NULL;
18307 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18308 * Otherwise, restore the value to "oldval" and return NULL.
18309 * Must always be called in pairs to save and restore v:throwpoint! Does not
18310 * take care of memory allocations.
18312 char_u *
18313 v_throwpoint(oldval)
18314 char_u *oldval;
18316 if (oldval == NULL)
18317 return vimvars[VV_THROWPOINT].vv_str;
18319 vimvars[VV_THROWPOINT].vv_str = oldval;
18320 return NULL;
18323 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18325 * Set v:cmdarg.
18326 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18327 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18328 * Must always be called in pairs!
18330 char_u *
18331 set_cmdarg(eap, oldarg)
18332 exarg_T *eap;
18333 char_u *oldarg;
18335 char_u *oldval;
18336 char_u *newval;
18337 unsigned len;
18339 oldval = vimvars[VV_CMDARG].vv_str;
18340 if (eap == NULL)
18342 vim_free(oldval);
18343 vimvars[VV_CMDARG].vv_str = oldarg;
18344 return NULL;
18347 if (eap->force_bin == FORCE_BIN)
18348 len = 6;
18349 else if (eap->force_bin == FORCE_NOBIN)
18350 len = 8;
18351 else
18352 len = 0;
18354 if (eap->read_edit)
18355 len += 7;
18357 if (eap->force_ff != 0)
18358 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18359 # ifdef FEAT_MBYTE
18360 if (eap->force_enc != 0)
18361 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18362 if (eap->bad_char != 0)
18363 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18364 # endif
18366 newval = alloc(len + 1);
18367 if (newval == NULL)
18368 return NULL;
18370 if (eap->force_bin == FORCE_BIN)
18371 sprintf((char *)newval, " ++bin");
18372 else if (eap->force_bin == FORCE_NOBIN)
18373 sprintf((char *)newval, " ++nobin");
18374 else
18375 *newval = NUL;
18377 if (eap->read_edit)
18378 STRCAT(newval, " ++edit");
18380 if (eap->force_ff != 0)
18381 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18382 eap->cmd + eap->force_ff);
18383 # ifdef FEAT_MBYTE
18384 if (eap->force_enc != 0)
18385 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18386 eap->cmd + eap->force_enc);
18387 if (eap->bad_char != 0)
18388 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18389 eap->cmd + eap->bad_char);
18390 # endif
18391 vimvars[VV_CMDARG].vv_str = newval;
18392 return oldval;
18394 #endif
18397 * Get the value of internal variable "name".
18398 * Return OK or FAIL.
18400 static int
18401 get_var_tv(name, len, rettv, verbose)
18402 char_u *name;
18403 int len; /* length of "name" */
18404 typval_T *rettv; /* NULL when only checking existence */
18405 int verbose; /* may give error message */
18407 int ret = OK;
18408 typval_T *tv = NULL;
18409 typval_T atv;
18410 dictitem_T *v;
18411 int cc;
18413 /* truncate the name, so that we can use strcmp() */
18414 cc = name[len];
18415 name[len] = NUL;
18418 * Check for "b:changedtick".
18420 if (STRCMP(name, "b:changedtick") == 0)
18422 atv.v_type = VAR_NUMBER;
18423 atv.vval.v_number = curbuf->b_changedtick;
18424 tv = &atv;
18428 * Check for user-defined variables.
18430 else
18432 v = find_var(name, NULL);
18433 if (v != NULL)
18434 tv = &v->di_tv;
18437 if (tv == NULL)
18439 if (rettv != NULL && verbose)
18440 EMSG2(_(e_undefvar), name);
18441 ret = FAIL;
18443 else if (rettv != NULL)
18444 copy_tv(tv, rettv);
18446 name[len] = cc;
18448 return ret;
18452 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18453 * Also handle function call with Funcref variable: func(expr)
18454 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18456 static int
18457 handle_subscript(arg, rettv, evaluate, verbose)
18458 char_u **arg;
18459 typval_T *rettv;
18460 int evaluate; /* do more than finding the end */
18461 int verbose; /* give error messages */
18463 int ret = OK;
18464 dict_T *selfdict = NULL;
18465 char_u *s;
18466 int len;
18467 typval_T functv;
18469 while (ret == OK
18470 && (**arg == '['
18471 || (**arg == '.' && rettv->v_type == VAR_DICT)
18472 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18473 && !vim_iswhite(*(*arg - 1)))
18475 if (**arg == '(')
18477 /* need to copy the funcref so that we can clear rettv */
18478 functv = *rettv;
18479 rettv->v_type = VAR_UNKNOWN;
18481 /* Invoke the function. Recursive! */
18482 s = functv.vval.v_string;
18483 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18484 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18485 &len, evaluate, selfdict);
18487 /* Clear the funcref afterwards, so that deleting it while
18488 * evaluating the arguments is possible (see test55). */
18489 clear_tv(&functv);
18491 /* Stop the expression evaluation when immediately aborting on
18492 * error, or when an interrupt occurred or an exception was thrown
18493 * but not caught. */
18494 if (aborting())
18496 if (ret == OK)
18497 clear_tv(rettv);
18498 ret = FAIL;
18500 dict_unref(selfdict);
18501 selfdict = NULL;
18503 else /* **arg == '[' || **arg == '.' */
18505 dict_unref(selfdict);
18506 if (rettv->v_type == VAR_DICT)
18508 selfdict = rettv->vval.v_dict;
18509 if (selfdict != NULL)
18510 ++selfdict->dv_refcount;
18512 else
18513 selfdict = NULL;
18514 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18516 clear_tv(rettv);
18517 ret = FAIL;
18521 dict_unref(selfdict);
18522 return ret;
18526 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18527 * value).
18529 static typval_T *
18530 alloc_tv()
18532 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18536 * Allocate memory for a variable type-value, and assign a string to it.
18537 * The string "s" must have been allocated, it is consumed.
18538 * Return NULL for out of memory, the variable otherwise.
18540 static typval_T *
18541 alloc_string_tv(s)
18542 char_u *s;
18544 typval_T *rettv;
18546 rettv = alloc_tv();
18547 if (rettv != NULL)
18549 rettv->v_type = VAR_STRING;
18550 rettv->vval.v_string = s;
18552 else
18553 vim_free(s);
18554 return rettv;
18558 * Free the memory for a variable type-value.
18560 void
18561 free_tv(varp)
18562 typval_T *varp;
18564 if (varp != NULL)
18566 switch (varp->v_type)
18568 case VAR_FUNC:
18569 func_unref(varp->vval.v_string);
18570 /*FALLTHROUGH*/
18571 case VAR_STRING:
18572 vim_free(varp->vval.v_string);
18573 break;
18574 case VAR_LIST:
18575 list_unref(varp->vval.v_list);
18576 break;
18577 case VAR_DICT:
18578 dict_unref(varp->vval.v_dict);
18579 break;
18580 case VAR_NUMBER:
18581 #ifdef FEAT_FLOAT
18582 case VAR_FLOAT:
18583 #endif
18584 case VAR_UNKNOWN:
18585 break;
18586 default:
18587 EMSG2(_(e_intern2), "free_tv()");
18588 break;
18590 vim_free(varp);
18595 * Free the memory for a variable value and set the value to NULL or 0.
18597 void
18598 clear_tv(varp)
18599 typval_T *varp;
18601 if (varp != NULL)
18603 switch (varp->v_type)
18605 case VAR_FUNC:
18606 func_unref(varp->vval.v_string);
18607 /*FALLTHROUGH*/
18608 case VAR_STRING:
18609 vim_free(varp->vval.v_string);
18610 varp->vval.v_string = NULL;
18611 break;
18612 case VAR_LIST:
18613 list_unref(varp->vval.v_list);
18614 varp->vval.v_list = NULL;
18615 break;
18616 case VAR_DICT:
18617 dict_unref(varp->vval.v_dict);
18618 varp->vval.v_dict = NULL;
18619 break;
18620 case VAR_NUMBER:
18621 varp->vval.v_number = 0;
18622 break;
18623 #ifdef FEAT_FLOAT
18624 case VAR_FLOAT:
18625 varp->vval.v_float = 0.0;
18626 break;
18627 #endif
18628 case VAR_UNKNOWN:
18629 break;
18630 default:
18631 EMSG2(_(e_intern2), "clear_tv()");
18633 varp->v_lock = 0;
18638 * Set the value of a variable to NULL without freeing items.
18640 static void
18641 init_tv(varp)
18642 typval_T *varp;
18644 if (varp != NULL)
18645 vim_memset(varp, 0, sizeof(typval_T));
18649 * Get the number value of a variable.
18650 * If it is a String variable, uses vim_str2nr().
18651 * For incompatible types, return 0.
18652 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18653 * caller of incompatible types: it sets *denote to TRUE if "denote"
18654 * is not NULL or returns -1 otherwise.
18656 static long
18657 get_tv_number(varp)
18658 typval_T *varp;
18660 int error = FALSE;
18662 return get_tv_number_chk(varp, &error); /* return 0L on error */
18665 long
18666 get_tv_number_chk(varp, denote)
18667 typval_T *varp;
18668 int *denote;
18670 long n = 0L;
18672 switch (varp->v_type)
18674 case VAR_NUMBER:
18675 return (long)(varp->vval.v_number);
18676 #ifdef FEAT_FLOAT
18677 case VAR_FLOAT:
18678 EMSG(_("E805: Using a Float as a Number"));
18679 break;
18680 #endif
18681 case VAR_FUNC:
18682 EMSG(_("E703: Using a Funcref as a Number"));
18683 break;
18684 case VAR_STRING:
18685 if (varp->vval.v_string != NULL)
18686 vim_str2nr(varp->vval.v_string, NULL, NULL,
18687 TRUE, TRUE, &n, NULL);
18688 return n;
18689 case VAR_LIST:
18690 EMSG(_("E745: Using a List as a Number"));
18691 break;
18692 case VAR_DICT:
18693 EMSG(_("E728: Using a Dictionary as a Number"));
18694 break;
18695 default:
18696 EMSG2(_(e_intern2), "get_tv_number()");
18697 break;
18699 if (denote == NULL) /* useful for values that must be unsigned */
18700 n = -1;
18701 else
18702 *denote = TRUE;
18703 return n;
18707 * Get the lnum from the first argument.
18708 * Also accepts ".", "$", etc., but that only works for the current buffer.
18709 * Returns -1 on error.
18711 static linenr_T
18712 get_tv_lnum(argvars)
18713 typval_T *argvars;
18715 typval_T rettv;
18716 linenr_T lnum;
18718 lnum = get_tv_number_chk(&argvars[0], NULL);
18719 if (lnum == 0) /* no valid number, try using line() */
18721 rettv.v_type = VAR_NUMBER;
18722 f_line(argvars, &rettv);
18723 lnum = rettv.vval.v_number;
18724 clear_tv(&rettv);
18726 return lnum;
18730 * Get the lnum from the first argument.
18731 * Also accepts "$", then "buf" is used.
18732 * Returns 0 on error.
18734 static linenr_T
18735 get_tv_lnum_buf(argvars, buf)
18736 typval_T *argvars;
18737 buf_T *buf;
18739 if (argvars[0].v_type == VAR_STRING
18740 && argvars[0].vval.v_string != NULL
18741 && argvars[0].vval.v_string[0] == '$'
18742 && buf != NULL)
18743 return buf->b_ml.ml_line_count;
18744 return get_tv_number_chk(&argvars[0], NULL);
18748 * Get the string value of a variable.
18749 * If it is a Number variable, the number is converted into a string.
18750 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18751 * get_tv_string_buf() uses a given buffer.
18752 * If the String variable has never been set, return an empty string.
18753 * Never returns NULL;
18754 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18755 * NULL on error.
18757 static char_u *
18758 get_tv_string(varp)
18759 typval_T *varp;
18761 static char_u mybuf[NUMBUFLEN];
18763 return get_tv_string_buf(varp, mybuf);
18766 static char_u *
18767 get_tv_string_buf(varp, buf)
18768 typval_T *varp;
18769 char_u *buf;
18771 char_u *res = get_tv_string_buf_chk(varp, buf);
18773 return res != NULL ? res : (char_u *)"";
18776 char_u *
18777 get_tv_string_chk(varp)
18778 typval_T *varp;
18780 static char_u mybuf[NUMBUFLEN];
18782 return get_tv_string_buf_chk(varp, mybuf);
18785 static char_u *
18786 get_tv_string_buf_chk(varp, buf)
18787 typval_T *varp;
18788 char_u *buf;
18790 switch (varp->v_type)
18792 case VAR_NUMBER:
18793 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18794 return buf;
18795 case VAR_FUNC:
18796 EMSG(_("E729: using Funcref as a String"));
18797 break;
18798 case VAR_LIST:
18799 EMSG(_("E730: using List as a String"));
18800 break;
18801 case VAR_DICT:
18802 EMSG(_("E731: using Dictionary as a String"));
18803 break;
18804 #ifdef FEAT_FLOAT
18805 case VAR_FLOAT:
18806 EMSG(_("E806: using Float as a String"));
18807 break;
18808 #endif
18809 case VAR_STRING:
18810 if (varp->vval.v_string != NULL)
18811 return varp->vval.v_string;
18812 return (char_u *)"";
18813 default:
18814 EMSG2(_(e_intern2), "get_tv_string_buf()");
18815 break;
18817 return NULL;
18821 * Find variable "name" in the list of variables.
18822 * Return a pointer to it if found, NULL if not found.
18823 * Careful: "a:0" variables don't have a name.
18824 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18825 * hashtab_T used.
18827 static dictitem_T *
18828 find_var(name, htp)
18829 char_u *name;
18830 hashtab_T **htp;
18832 char_u *varname;
18833 hashtab_T *ht;
18835 ht = find_var_ht(name, &varname);
18836 if (htp != NULL)
18837 *htp = ht;
18838 if (ht == NULL)
18839 return NULL;
18840 return find_var_in_ht(ht, varname, htp != NULL);
18844 * Find variable "varname" in hashtab "ht".
18845 * Returns NULL if not found.
18847 static dictitem_T *
18848 find_var_in_ht(ht, varname, writing)
18849 hashtab_T *ht;
18850 char_u *varname;
18851 int writing;
18853 hashitem_T *hi;
18855 if (*varname == NUL)
18857 /* Must be something like "s:", otherwise "ht" would be NULL. */
18858 switch (varname[-2])
18860 case 's': return &SCRIPT_SV(current_SID).sv_var;
18861 case 'g': return &globvars_var;
18862 case 'v': return &vimvars_var;
18863 case 'b': return &curbuf->b_bufvar;
18864 case 'w': return &curwin->w_winvar;
18865 #ifdef FEAT_WINDOWS
18866 case 't': return &curtab->tp_winvar;
18867 #endif
18868 case 'l': return current_funccal == NULL
18869 ? NULL : &current_funccal->l_vars_var;
18870 case 'a': return current_funccal == NULL
18871 ? NULL : &current_funccal->l_avars_var;
18873 return NULL;
18876 hi = hash_find(ht, varname);
18877 if (HASHITEM_EMPTY(hi))
18879 /* For global variables we may try auto-loading the script. If it
18880 * worked find the variable again. Don't auto-load a script if it was
18881 * loaded already, otherwise it would be loaded every time when
18882 * checking if a function name is a Funcref variable. */
18883 if (ht == &globvarht && !writing
18884 && script_autoload(varname, FALSE) && !aborting())
18885 hi = hash_find(ht, varname);
18886 if (HASHITEM_EMPTY(hi))
18887 return NULL;
18889 return HI2DI(hi);
18893 * Find the hashtab used for a variable name.
18894 * Set "varname" to the start of name without ':'.
18896 static hashtab_T *
18897 find_var_ht(name, varname)
18898 char_u *name;
18899 char_u **varname;
18901 hashitem_T *hi;
18903 if (name[1] != ':')
18905 /* The name must not start with a colon or #. */
18906 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18907 return NULL;
18908 *varname = name;
18910 /* "version" is "v:version" in all scopes */
18911 hi = hash_find(&compat_hashtab, name);
18912 if (!HASHITEM_EMPTY(hi))
18913 return &compat_hashtab;
18915 if (current_funccal == NULL)
18916 return &globvarht; /* global variable */
18917 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18919 *varname = name + 2;
18920 if (*name == 'g') /* global variable */
18921 return &globvarht;
18922 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18924 if (vim_strchr(name + 2, ':') != NULL
18925 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18926 return NULL;
18927 if (*name == 'b') /* buffer variable */
18928 return &curbuf->b_vars.dv_hashtab;
18929 if (*name == 'w') /* window variable */
18930 return &curwin->w_vars.dv_hashtab;
18931 #ifdef FEAT_WINDOWS
18932 if (*name == 't') /* tab page variable */
18933 return &curtab->tp_vars.dv_hashtab;
18934 #endif
18935 if (*name == 'v') /* v: variable */
18936 return &vimvarht;
18937 if (*name == 'a' && current_funccal != NULL) /* function argument */
18938 return &current_funccal->l_avars.dv_hashtab;
18939 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18940 return &current_funccal->l_vars.dv_hashtab;
18941 if (*name == 's' /* script variable */
18942 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18943 return &SCRIPT_VARS(current_SID);
18944 return NULL;
18948 * Get the string value of a (global/local) variable.
18949 * Returns NULL when it doesn't exist.
18951 char_u *
18952 get_var_value(name)
18953 char_u *name;
18955 dictitem_T *v;
18957 v = find_var(name, NULL);
18958 if (v == NULL)
18959 return NULL;
18960 return get_tv_string(&v->di_tv);
18964 * Allocate a new hashtab for a sourced script. It will be used while
18965 * sourcing this script and when executing functions defined in the script.
18967 void
18968 new_script_vars(id)
18969 scid_T id;
18971 int i;
18972 hashtab_T *ht;
18973 scriptvar_T *sv;
18975 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18977 /* Re-allocating ga_data means that an ht_array pointing to
18978 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18979 * at its init value. Also reset "v_dict", it's always the same. */
18980 for (i = 1; i <= ga_scripts.ga_len; ++i)
18982 ht = &SCRIPT_VARS(i);
18983 if (ht->ht_mask == HT_INIT_SIZE - 1)
18984 ht->ht_array = ht->ht_smallarray;
18985 sv = &SCRIPT_SV(i);
18986 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18989 while (ga_scripts.ga_len < id)
18991 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18992 init_var_dict(&sv->sv_dict, &sv->sv_var);
18993 ++ga_scripts.ga_len;
18999 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
19000 * point to it.
19002 void
19003 init_var_dict(dict, dict_var)
19004 dict_T *dict;
19005 dictitem_T *dict_var;
19007 hash_init(&dict->dv_hashtab);
19008 dict->dv_refcount = DO_NOT_FREE_CNT;
19009 dict_var->di_tv.vval.v_dict = dict;
19010 dict_var->di_tv.v_type = VAR_DICT;
19011 dict_var->di_tv.v_lock = VAR_FIXED;
19012 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
19013 dict_var->di_key[0] = NUL;
19017 * Clean up a list of internal variables.
19018 * Frees all allocated variables and the value they contain.
19019 * Clears hashtab "ht", does not free it.
19021 void
19022 vars_clear(ht)
19023 hashtab_T *ht;
19025 vars_clear_ext(ht, TRUE);
19029 * Like vars_clear(), but only free the value if "free_val" is TRUE.
19031 static void
19032 vars_clear_ext(ht, free_val)
19033 hashtab_T *ht;
19034 int free_val;
19036 int todo;
19037 hashitem_T *hi;
19038 dictitem_T *v;
19040 hash_lock(ht);
19041 todo = (int)ht->ht_used;
19042 for (hi = ht->ht_array; todo > 0; ++hi)
19044 if (!HASHITEM_EMPTY(hi))
19046 --todo;
19048 /* Free the variable. Don't remove it from the hashtab,
19049 * ht_array might change then. hash_clear() takes care of it
19050 * later. */
19051 v = HI2DI(hi);
19052 if (free_val)
19053 clear_tv(&v->di_tv);
19054 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19055 vim_free(v);
19058 hash_clear(ht);
19059 ht->ht_used = 0;
19063 * Delete a variable from hashtab "ht" at item "hi".
19064 * Clear the variable value and free the dictitem.
19066 static void
19067 delete_var(ht, hi)
19068 hashtab_T *ht;
19069 hashitem_T *hi;
19071 dictitem_T *di = HI2DI(hi);
19073 hash_remove(ht, hi);
19074 clear_tv(&di->di_tv);
19075 vim_free(di);
19079 * List the value of one internal variable.
19081 static void
19082 list_one_var(v, prefix, first)
19083 dictitem_T *v;
19084 char_u *prefix;
19085 int *first;
19087 char_u *tofree;
19088 char_u *s;
19089 char_u numbuf[NUMBUFLEN];
19091 s = echo_string(&v->di_tv, &tofree, numbuf, ++current_copyID);
19092 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19093 s == NULL ? (char_u *)"" : s, first);
19094 vim_free(tofree);
19097 static void
19098 list_one_var_a(prefix, name, type, string, first)
19099 char_u *prefix;
19100 char_u *name;
19101 int type;
19102 char_u *string;
19103 int *first; /* when TRUE clear rest of screen and set to FALSE */
19105 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19106 msg_start();
19107 msg_puts(prefix);
19108 if (name != NULL) /* "a:" vars don't have a name stored */
19109 msg_puts(name);
19110 msg_putchar(' ');
19111 msg_advance(22);
19112 if (type == VAR_NUMBER)
19113 msg_putchar('#');
19114 else if (type == VAR_FUNC)
19115 msg_putchar('*');
19116 else if (type == VAR_LIST)
19118 msg_putchar('[');
19119 if (*string == '[')
19120 ++string;
19122 else if (type == VAR_DICT)
19124 msg_putchar('{');
19125 if (*string == '{')
19126 ++string;
19128 else
19129 msg_putchar(' ');
19131 msg_outtrans(string);
19133 if (type == VAR_FUNC)
19134 msg_puts((char_u *)"()");
19135 if (*first)
19137 msg_clr_eos();
19138 *first = FALSE;
19143 * Set variable "name" to value in "tv".
19144 * If the variable already exists, the value is updated.
19145 * Otherwise the variable is created.
19147 static void
19148 set_var(name, tv, copy)
19149 char_u *name;
19150 typval_T *tv;
19151 int copy; /* make copy of value in "tv" */
19153 dictitem_T *v;
19154 char_u *varname;
19155 hashtab_T *ht;
19156 char_u *p;
19158 if (tv->v_type == VAR_FUNC)
19160 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19161 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19162 ? name[2] : name[0]))
19164 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19165 return;
19167 if (function_exists(name))
19169 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19170 name);
19171 return;
19175 ht = find_var_ht(name, &varname);
19176 if (ht == NULL || *varname == NUL)
19178 EMSG2(_(e_illvar), name);
19179 return;
19182 v = find_var_in_ht(ht, varname, TRUE);
19183 if (v != NULL)
19185 /* existing variable, need to clear the value */
19186 if (var_check_ro(v->di_flags, name)
19187 || tv_check_lock(v->di_tv.v_lock, name))
19188 return;
19189 if (v->di_tv.v_type != tv->v_type
19190 && !((v->di_tv.v_type == VAR_STRING
19191 || v->di_tv.v_type == VAR_NUMBER)
19192 && (tv->v_type == VAR_STRING
19193 || tv->v_type == VAR_NUMBER))
19194 #ifdef FEAT_FLOAT
19195 && !((v->di_tv.v_type == VAR_NUMBER
19196 || v->di_tv.v_type == VAR_FLOAT)
19197 && (tv->v_type == VAR_NUMBER
19198 || tv->v_type == VAR_FLOAT))
19199 #endif
19202 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19203 return;
19207 * Handle setting internal v: variables separately: we don't change
19208 * the type.
19210 if (ht == &vimvarht)
19212 if (v->di_tv.v_type == VAR_STRING)
19214 vim_free(v->di_tv.vval.v_string);
19215 if (copy || tv->v_type != VAR_STRING)
19216 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19217 else
19219 /* Take over the string to avoid an extra alloc/free. */
19220 v->di_tv.vval.v_string = tv->vval.v_string;
19221 tv->vval.v_string = NULL;
19224 else if (v->di_tv.v_type != VAR_NUMBER)
19225 EMSG2(_(e_intern2), "set_var()");
19226 else
19228 v->di_tv.vval.v_number = get_tv_number(tv);
19229 if (STRCMP(varname, "searchforward") == 0)
19230 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19232 return;
19235 clear_tv(&v->di_tv);
19237 else /* add a new variable */
19239 /* Can't add "v:" variable. */
19240 if (ht == &vimvarht)
19242 EMSG2(_(e_illvar), name);
19243 return;
19246 /* Make sure the variable name is valid. */
19247 for (p = varname; *p != NUL; ++p)
19248 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19249 && *p != AUTOLOAD_CHAR)
19251 EMSG2(_(e_illvar), varname);
19252 return;
19255 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19256 + STRLEN(varname)));
19257 if (v == NULL)
19258 return;
19259 STRCPY(v->di_key, varname);
19260 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19262 vim_free(v);
19263 return;
19265 v->di_flags = 0;
19268 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19269 copy_tv(tv, &v->di_tv);
19270 else
19272 v->di_tv = *tv;
19273 v->di_tv.v_lock = 0;
19274 init_tv(tv);
19279 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19280 * Also give an error message.
19282 static int
19283 var_check_ro(flags, name)
19284 int flags;
19285 char_u *name;
19287 if (flags & DI_FLAGS_RO)
19289 EMSG2(_(e_readonlyvar), name);
19290 return TRUE;
19292 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19294 EMSG2(_(e_readonlysbx), name);
19295 return TRUE;
19297 return FALSE;
19301 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19302 * Also give an error message.
19304 static int
19305 var_check_fixed(flags, name)
19306 int flags;
19307 char_u *name;
19309 if (flags & DI_FLAGS_FIX)
19311 EMSG2(_("E795: Cannot delete variable %s"), name);
19312 return TRUE;
19314 return FALSE;
19318 * Return TRUE if typeval "tv" is set to be locked (immutable).
19319 * Also give an error message, using "name".
19321 static int
19322 tv_check_lock(lock, name)
19323 int lock;
19324 char_u *name;
19326 if (lock & VAR_LOCKED)
19328 EMSG2(_("E741: Value is locked: %s"),
19329 name == NULL ? (char_u *)_("Unknown") : name);
19330 return TRUE;
19332 if (lock & VAR_FIXED)
19334 EMSG2(_("E742: Cannot change value of %s"),
19335 name == NULL ? (char_u *)_("Unknown") : name);
19336 return TRUE;
19338 return FALSE;
19342 * Copy the values from typval_T "from" to typval_T "to".
19343 * When needed allocates string or increases reference count.
19344 * Does not make a copy of a list or dict but copies the reference!
19345 * It is OK for "from" and "to" to point to the same item. This is used to
19346 * make a copy later.
19348 static void
19349 copy_tv(from, to)
19350 typval_T *from;
19351 typval_T *to;
19353 to->v_type = from->v_type;
19354 to->v_lock = 0;
19355 switch (from->v_type)
19357 case VAR_NUMBER:
19358 to->vval.v_number = from->vval.v_number;
19359 break;
19360 #ifdef FEAT_FLOAT
19361 case VAR_FLOAT:
19362 to->vval.v_float = from->vval.v_float;
19363 break;
19364 #endif
19365 case VAR_STRING:
19366 case VAR_FUNC:
19367 if (from->vval.v_string == NULL)
19368 to->vval.v_string = NULL;
19369 else
19371 to->vval.v_string = vim_strsave(from->vval.v_string);
19372 if (from->v_type == VAR_FUNC)
19373 func_ref(to->vval.v_string);
19375 break;
19376 case VAR_LIST:
19377 if (from->vval.v_list == NULL)
19378 to->vval.v_list = NULL;
19379 else
19381 to->vval.v_list = from->vval.v_list;
19382 ++to->vval.v_list->lv_refcount;
19384 break;
19385 case VAR_DICT:
19386 if (from->vval.v_dict == NULL)
19387 to->vval.v_dict = NULL;
19388 else
19390 to->vval.v_dict = from->vval.v_dict;
19391 ++to->vval.v_dict->dv_refcount;
19393 break;
19394 default:
19395 EMSG2(_(e_intern2), "copy_tv()");
19396 break;
19401 * Make a copy of an item.
19402 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19403 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19404 * reference to an already copied list/dict can be used.
19405 * Returns FAIL or OK.
19407 static int
19408 item_copy(from, to, deep, copyID)
19409 typval_T *from;
19410 typval_T *to;
19411 int deep;
19412 int copyID;
19414 static int recurse = 0;
19415 int ret = OK;
19417 if (recurse >= DICT_MAXNEST)
19419 EMSG(_("E698: variable nested too deep for making a copy"));
19420 return FAIL;
19422 ++recurse;
19424 switch (from->v_type)
19426 case VAR_NUMBER:
19427 #ifdef FEAT_FLOAT
19428 case VAR_FLOAT:
19429 #endif
19430 case VAR_STRING:
19431 case VAR_FUNC:
19432 copy_tv(from, to);
19433 break;
19434 case VAR_LIST:
19435 to->v_type = VAR_LIST;
19436 to->v_lock = 0;
19437 if (from->vval.v_list == NULL)
19438 to->vval.v_list = NULL;
19439 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19441 /* use the copy made earlier */
19442 to->vval.v_list = from->vval.v_list->lv_copylist;
19443 ++to->vval.v_list->lv_refcount;
19445 else
19446 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19447 if (to->vval.v_list == NULL)
19448 ret = FAIL;
19449 break;
19450 case VAR_DICT:
19451 to->v_type = VAR_DICT;
19452 to->v_lock = 0;
19453 if (from->vval.v_dict == NULL)
19454 to->vval.v_dict = NULL;
19455 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19457 /* use the copy made earlier */
19458 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19459 ++to->vval.v_dict->dv_refcount;
19461 else
19462 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19463 if (to->vval.v_dict == NULL)
19464 ret = FAIL;
19465 break;
19466 default:
19467 EMSG2(_(e_intern2), "item_copy()");
19468 ret = FAIL;
19470 --recurse;
19471 return ret;
19475 * ":echo expr1 ..." print each argument separated with a space, add a
19476 * newline at the end.
19477 * ":echon expr1 ..." print each argument plain.
19479 void
19480 ex_echo(eap)
19481 exarg_T *eap;
19483 char_u *arg = eap->arg;
19484 typval_T rettv;
19485 char_u *tofree;
19486 char_u *p;
19487 int needclr = TRUE;
19488 int atstart = TRUE;
19489 char_u numbuf[NUMBUFLEN];
19491 if (eap->skip)
19492 ++emsg_skip;
19493 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19495 /* If eval1() causes an error message the text from the command may
19496 * still need to be cleared. E.g., "echo 22,44". */
19497 need_clr_eos = needclr;
19499 p = arg;
19500 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19503 * Report the invalid expression unless the expression evaluation
19504 * has been cancelled due to an aborting error, an interrupt, or an
19505 * exception.
19507 if (!aborting())
19508 EMSG2(_(e_invexpr2), p);
19509 need_clr_eos = FALSE;
19510 break;
19512 need_clr_eos = FALSE;
19514 if (!eap->skip)
19516 if (atstart)
19518 atstart = FALSE;
19519 /* Call msg_start() after eval1(), evaluating the expression
19520 * may cause a message to appear. */
19521 if (eap->cmdidx == CMD_echo)
19522 msg_start();
19524 else if (eap->cmdidx == CMD_echo)
19525 msg_puts_attr((char_u *)" ", echo_attr);
19526 p = echo_string(&rettv, &tofree, numbuf, ++current_copyID);
19527 if (p != NULL)
19528 for ( ; *p != NUL && !got_int; ++p)
19530 if (*p == '\n' || *p == '\r' || *p == TAB)
19532 if (*p != TAB && needclr)
19534 /* remove any text still there from the command */
19535 msg_clr_eos();
19536 needclr = FALSE;
19538 msg_putchar_attr(*p, echo_attr);
19540 else
19542 #ifdef FEAT_MBYTE
19543 if (has_mbyte)
19545 int i = (*mb_ptr2len)(p);
19547 (void)msg_outtrans_len_attr(p, i, echo_attr);
19548 p += i - 1;
19550 else
19551 #endif
19552 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19555 vim_free(tofree);
19557 clear_tv(&rettv);
19558 arg = skipwhite(arg);
19560 eap->nextcmd = check_nextcmd(arg);
19562 if (eap->skip)
19563 --emsg_skip;
19564 else
19566 /* remove text that may still be there from the command */
19567 if (needclr)
19568 msg_clr_eos();
19569 if (eap->cmdidx == CMD_echo)
19570 msg_end();
19575 * ":echohl {name}".
19577 void
19578 ex_echohl(eap)
19579 exarg_T *eap;
19581 int id;
19583 id = syn_name2id(eap->arg);
19584 if (id == 0)
19585 echo_attr = 0;
19586 else
19587 echo_attr = syn_id2attr(id);
19591 * ":execute expr1 ..." execute the result of an expression.
19592 * ":echomsg expr1 ..." Print a message
19593 * ":echoerr expr1 ..." Print an error
19594 * Each gets spaces around each argument and a newline at the end for
19595 * echo commands
19597 void
19598 ex_execute(eap)
19599 exarg_T *eap;
19601 char_u *arg = eap->arg;
19602 typval_T rettv;
19603 int ret = OK;
19604 char_u *p;
19605 garray_T ga;
19606 int len;
19607 int save_did_emsg;
19609 ga_init2(&ga, 1, 80);
19611 if (eap->skip)
19612 ++emsg_skip;
19613 while (*arg != NUL && *arg != '|' && *arg != '\n')
19615 p = arg;
19616 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19619 * Report the invalid expression unless the expression evaluation
19620 * has been cancelled due to an aborting error, an interrupt, or an
19621 * exception.
19623 if (!aborting())
19624 EMSG2(_(e_invexpr2), p);
19625 ret = FAIL;
19626 break;
19629 if (!eap->skip)
19631 p = get_tv_string(&rettv);
19632 len = (int)STRLEN(p);
19633 if (ga_grow(&ga, len + 2) == FAIL)
19635 clear_tv(&rettv);
19636 ret = FAIL;
19637 break;
19639 if (ga.ga_len)
19640 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19641 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19642 ga.ga_len += len;
19645 clear_tv(&rettv);
19646 arg = skipwhite(arg);
19649 if (ret != FAIL && ga.ga_data != NULL)
19651 if (eap->cmdidx == CMD_echomsg)
19653 MSG_ATTR(ga.ga_data, echo_attr);
19654 out_flush();
19656 else if (eap->cmdidx == CMD_echoerr)
19658 /* We don't want to abort following commands, restore did_emsg. */
19659 save_did_emsg = did_emsg;
19660 EMSG((char_u *)ga.ga_data);
19661 if (!force_abort)
19662 did_emsg = save_did_emsg;
19664 else if (eap->cmdidx == CMD_execute)
19665 do_cmdline((char_u *)ga.ga_data,
19666 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19669 ga_clear(&ga);
19671 if (eap->skip)
19672 --emsg_skip;
19674 eap->nextcmd = check_nextcmd(arg);
19678 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19679 * "arg" points to the "&" or '+' when called, to "option" when returning.
19680 * Returns NULL when no option name found. Otherwise pointer to the char
19681 * after the option name.
19683 static char_u *
19684 find_option_end(arg, opt_flags)
19685 char_u **arg;
19686 int *opt_flags;
19688 char_u *p = *arg;
19690 ++p;
19691 if (*p == 'g' && p[1] == ':')
19693 *opt_flags = OPT_GLOBAL;
19694 p += 2;
19696 else if (*p == 'l' && p[1] == ':')
19698 *opt_flags = OPT_LOCAL;
19699 p += 2;
19701 else
19702 *opt_flags = 0;
19704 if (!ASCII_ISALPHA(*p))
19705 return NULL;
19706 *arg = p;
19708 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19709 p += 4; /* termcap option */
19710 else
19711 while (ASCII_ISALPHA(*p))
19712 ++p;
19713 return p;
19717 * ":function"
19719 void
19720 ex_function(eap)
19721 exarg_T *eap;
19723 char_u *theline;
19724 int j;
19725 int c;
19726 int saved_did_emsg;
19727 char_u *name = NULL;
19728 char_u *p;
19729 char_u *arg;
19730 char_u *line_arg = NULL;
19731 garray_T newargs;
19732 garray_T newlines;
19733 int varargs = FALSE;
19734 int mustend = FALSE;
19735 int flags = 0;
19736 ufunc_T *fp;
19737 int indent;
19738 int nesting;
19739 char_u *skip_until = NULL;
19740 dictitem_T *v;
19741 funcdict_T fudi;
19742 static int func_nr = 0; /* number for nameless function */
19743 int paren;
19744 hashtab_T *ht;
19745 int todo;
19746 hashitem_T *hi;
19747 int sourcing_lnum_off;
19750 * ":function" without argument: list functions.
19752 if (ends_excmd(*eap->arg))
19754 if (!eap->skip)
19756 todo = (int)func_hashtab.ht_used;
19757 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19759 if (!HASHITEM_EMPTY(hi))
19761 --todo;
19762 fp = HI2UF(hi);
19763 if (!isdigit(*fp->uf_name))
19764 list_func_head(fp, FALSE);
19768 eap->nextcmd = check_nextcmd(eap->arg);
19769 return;
19773 * ":function /pat": list functions matching pattern.
19775 if (*eap->arg == '/')
19777 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19778 if (!eap->skip)
19780 regmatch_T regmatch;
19782 c = *p;
19783 *p = NUL;
19784 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19785 *p = c;
19786 if (regmatch.regprog != NULL)
19788 regmatch.rm_ic = p_ic;
19790 todo = (int)func_hashtab.ht_used;
19791 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19793 if (!HASHITEM_EMPTY(hi))
19795 --todo;
19796 fp = HI2UF(hi);
19797 if (!isdigit(*fp->uf_name)
19798 && vim_regexec(&regmatch, fp->uf_name, 0))
19799 list_func_head(fp, FALSE);
19804 if (*p == '/')
19805 ++p;
19806 eap->nextcmd = check_nextcmd(p);
19807 return;
19811 * Get the function name. There are these situations:
19812 * func normal function name
19813 * "name" == func, "fudi.fd_dict" == NULL
19814 * dict.func new dictionary entry
19815 * "name" == NULL, "fudi.fd_dict" set,
19816 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19817 * dict.func existing dict entry with a Funcref
19818 * "name" == func, "fudi.fd_dict" set,
19819 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19820 * dict.func existing dict entry that's not a Funcref
19821 * "name" == NULL, "fudi.fd_dict" set,
19822 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19824 p = eap->arg;
19825 name = trans_function_name(&p, eap->skip, 0, &fudi);
19826 paren = (vim_strchr(p, '(') != NULL);
19827 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19830 * Return on an invalid expression in braces, unless the expression
19831 * evaluation has been cancelled due to an aborting error, an
19832 * interrupt, or an exception.
19834 if (!aborting())
19836 if (!eap->skip && fudi.fd_newkey != NULL)
19837 EMSG2(_(e_dictkey), fudi.fd_newkey);
19838 vim_free(fudi.fd_newkey);
19839 return;
19841 else
19842 eap->skip = TRUE;
19845 /* An error in a function call during evaluation of an expression in magic
19846 * braces should not cause the function not to be defined. */
19847 saved_did_emsg = did_emsg;
19848 did_emsg = FALSE;
19851 * ":function func" with only function name: list function.
19853 if (!paren)
19855 if (!ends_excmd(*skipwhite(p)))
19857 EMSG(_(e_trailing));
19858 goto ret_free;
19860 eap->nextcmd = check_nextcmd(p);
19861 if (eap->nextcmd != NULL)
19862 *p = NUL;
19863 if (!eap->skip && !got_int)
19865 fp = find_func(name);
19866 if (fp != NULL)
19868 list_func_head(fp, TRUE);
19869 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19871 if (FUNCLINE(fp, j) == NULL)
19872 continue;
19873 msg_putchar('\n');
19874 msg_outnum((long)(j + 1));
19875 if (j < 9)
19876 msg_putchar(' ');
19877 if (j < 99)
19878 msg_putchar(' ');
19879 msg_prt_line(FUNCLINE(fp, j), FALSE);
19880 out_flush(); /* show a line at a time */
19881 ui_breakcheck();
19883 if (!got_int)
19885 msg_putchar('\n');
19886 msg_puts((char_u *)" endfunction");
19889 else
19890 emsg_funcname("E123: Undefined function: %s", name);
19892 goto ret_free;
19896 * ":function name(arg1, arg2)" Define function.
19898 p = skipwhite(p);
19899 if (*p != '(')
19901 if (!eap->skip)
19903 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19904 goto ret_free;
19906 /* attempt to continue by skipping some text */
19907 if (vim_strchr(p, '(') != NULL)
19908 p = vim_strchr(p, '(');
19910 p = skipwhite(p + 1);
19912 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19913 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19915 if (!eap->skip)
19917 /* Check the name of the function. Unless it's a dictionary function
19918 * (that we are overwriting). */
19919 if (name != NULL)
19920 arg = name;
19921 else
19922 arg = fudi.fd_newkey;
19923 if (arg != NULL && (fudi.fd_di == NULL
19924 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19926 if (*arg == K_SPECIAL)
19927 j = 3;
19928 else
19929 j = 0;
19930 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19931 : eval_isnamec(arg[j])))
19932 ++j;
19933 if (arg[j] != NUL)
19934 emsg_funcname(_(e_invarg2), arg);
19939 * Isolate the arguments: "arg1, arg2, ...)"
19941 while (*p != ')')
19943 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19945 varargs = TRUE;
19946 p += 3;
19947 mustend = TRUE;
19949 else
19951 arg = p;
19952 while (ASCII_ISALNUM(*p) || *p == '_')
19953 ++p;
19954 if (arg == p || isdigit(*arg)
19955 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19956 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19958 if (!eap->skip)
19959 EMSG2(_("E125: Illegal argument: %s"), arg);
19960 break;
19962 if (ga_grow(&newargs, 1) == FAIL)
19963 goto erret;
19964 c = *p;
19965 *p = NUL;
19966 arg = vim_strsave(arg);
19967 if (arg == NULL)
19968 goto erret;
19969 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19970 *p = c;
19971 newargs.ga_len++;
19972 if (*p == ',')
19973 ++p;
19974 else
19975 mustend = TRUE;
19977 p = skipwhite(p);
19978 if (mustend && *p != ')')
19980 if (!eap->skip)
19981 EMSG2(_(e_invarg2), eap->arg);
19982 break;
19985 ++p; /* skip the ')' */
19987 /* find extra arguments "range", "dict" and "abort" */
19988 for (;;)
19990 p = skipwhite(p);
19991 if (STRNCMP(p, "range", 5) == 0)
19993 flags |= FC_RANGE;
19994 p += 5;
19996 else if (STRNCMP(p, "dict", 4) == 0)
19998 flags |= FC_DICT;
19999 p += 4;
20001 else if (STRNCMP(p, "abort", 5) == 0)
20003 flags |= FC_ABORT;
20004 p += 5;
20006 else
20007 break;
20010 /* When there is a line break use what follows for the function body.
20011 * Makes 'exe "func Test()\n...\nendfunc"' work. */
20012 if (*p == '\n')
20013 line_arg = p + 1;
20014 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
20015 EMSG(_(e_trailing));
20018 * Read the body of the function, until ":endfunction" is found.
20020 if (KeyTyped)
20022 /* Check if the function already exists, don't let the user type the
20023 * whole function before telling him it doesn't work! For a script we
20024 * need to skip the body to be able to find what follows. */
20025 if (!eap->skip && !eap->forceit)
20027 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
20028 EMSG(_(e_funcdict));
20029 else if (name != NULL && find_func(name) != NULL)
20030 emsg_funcname(e_funcexts, name);
20033 if (!eap->skip && did_emsg)
20034 goto erret;
20036 msg_putchar('\n'); /* don't overwrite the function name */
20037 cmdline_row = msg_row;
20040 indent = 2;
20041 nesting = 0;
20042 for (;;)
20044 msg_scroll = TRUE;
20045 need_wait_return = FALSE;
20046 sourcing_lnum_off = sourcing_lnum;
20048 if (line_arg != NULL)
20050 /* Use eap->arg, split up in parts by line breaks. */
20051 theline = line_arg;
20052 p = vim_strchr(theline, '\n');
20053 if (p == NULL)
20054 line_arg += STRLEN(line_arg);
20055 else
20057 *p = NUL;
20058 line_arg = p + 1;
20061 else if (eap->getline == NULL)
20062 theline = getcmdline(':', 0L, indent);
20063 else
20064 theline = eap->getline(':', eap->cookie, indent);
20065 if (KeyTyped)
20066 lines_left = Rows - 1;
20067 if (theline == NULL)
20069 EMSG(_("E126: Missing :endfunction"));
20070 goto erret;
20073 /* Detect line continuation: sourcing_lnum increased more than one. */
20074 if (sourcing_lnum > sourcing_lnum_off + 1)
20075 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20076 else
20077 sourcing_lnum_off = 0;
20079 if (skip_until != NULL)
20081 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20082 * don't check for ":endfunc". */
20083 if (STRCMP(theline, skip_until) == 0)
20085 vim_free(skip_until);
20086 skip_until = NULL;
20089 else
20091 /* skip ':' and blanks*/
20092 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20095 /* Check for "endfunction". */
20096 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20098 if (line_arg == NULL)
20099 vim_free(theline);
20100 break;
20103 /* Increase indent inside "if", "while", "for" and "try", decrease
20104 * at "end". */
20105 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20106 indent -= 2;
20107 else if (STRNCMP(p, "if", 2) == 0
20108 || STRNCMP(p, "wh", 2) == 0
20109 || STRNCMP(p, "for", 3) == 0
20110 || STRNCMP(p, "try", 3) == 0)
20111 indent += 2;
20113 /* Check for defining a function inside this function. */
20114 if (checkforcmd(&p, "function", 2))
20116 if (*p == '!')
20117 p = skipwhite(p + 1);
20118 p += eval_fname_script(p);
20119 if (ASCII_ISALPHA(*p))
20121 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20122 if (*skipwhite(p) == '(')
20124 ++nesting;
20125 indent += 2;
20130 /* Check for ":append" or ":insert". */
20131 p = skip_range(p, NULL);
20132 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20133 || (p[0] == 'i'
20134 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20135 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20136 skip_until = vim_strsave((char_u *)".");
20138 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20139 arg = skipwhite(skiptowhite(p));
20140 if (arg[0] == '<' && arg[1] =='<'
20141 && ((p[0] == 'p' && p[1] == 'y'
20142 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20143 || (p[0] == 'p' && p[1] == 'e'
20144 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20145 || (p[0] == 't' && p[1] == 'c'
20146 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20147 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20148 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20149 || (p[0] == 'm' && p[1] == 'z'
20150 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20153 /* ":python <<" continues until a dot, like ":append" */
20154 p = skipwhite(arg + 2);
20155 if (*p == NUL)
20156 skip_until = vim_strsave((char_u *)".");
20157 else
20158 skip_until = vim_strsave(p);
20162 /* Add the line to the function. */
20163 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20165 if (line_arg == NULL)
20166 vim_free(theline);
20167 goto erret;
20170 /* Copy the line to newly allocated memory. get_one_sourceline()
20171 * allocates 250 bytes per line, this saves 80% on average. The cost
20172 * is an extra alloc/free. */
20173 p = vim_strsave(theline);
20174 if (p != NULL)
20176 if (line_arg == NULL)
20177 vim_free(theline);
20178 theline = p;
20181 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20183 /* Add NULL lines for continuation lines, so that the line count is
20184 * equal to the index in the growarray. */
20185 while (sourcing_lnum_off-- > 0)
20186 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20188 /* Check for end of eap->arg. */
20189 if (line_arg != NULL && *line_arg == NUL)
20190 line_arg = NULL;
20193 /* Don't define the function when skipping commands or when an error was
20194 * detected. */
20195 if (eap->skip || did_emsg)
20196 goto erret;
20199 * If there are no errors, add the function
20201 if (fudi.fd_dict == NULL)
20203 v = find_var(name, &ht);
20204 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20206 emsg_funcname("E707: Function name conflicts with variable: %s",
20207 name);
20208 goto erret;
20211 fp = find_func(name);
20212 if (fp != NULL)
20214 if (!eap->forceit)
20216 emsg_funcname(e_funcexts, name);
20217 goto erret;
20219 if (fp->uf_calls > 0)
20221 emsg_funcname("E127: Cannot redefine function %s: It is in use",
20222 name);
20223 goto erret;
20225 /* redefine existing function */
20226 ga_clear_strings(&(fp->uf_args));
20227 ga_clear_strings(&(fp->uf_lines));
20228 vim_free(name);
20229 name = NULL;
20232 else
20234 char numbuf[20];
20236 fp = NULL;
20237 if (fudi.fd_newkey == NULL && !eap->forceit)
20239 EMSG(_(e_funcdict));
20240 goto erret;
20242 if (fudi.fd_di == NULL)
20244 /* Can't add a function to a locked dictionary */
20245 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20246 goto erret;
20248 /* Can't change an existing function if it is locked */
20249 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20250 goto erret;
20252 /* Give the function a sequential number. Can only be used with a
20253 * Funcref! */
20254 vim_free(name);
20255 sprintf(numbuf, "%d", ++func_nr);
20256 name = vim_strsave((char_u *)numbuf);
20257 if (name == NULL)
20258 goto erret;
20261 if (fp == NULL)
20263 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20265 int slen, plen;
20266 char_u *scriptname;
20268 /* Check that the autoload name matches the script name. */
20269 j = FAIL;
20270 if (sourcing_name != NULL)
20272 scriptname = autoload_name(name);
20273 if (scriptname != NULL)
20275 p = vim_strchr(scriptname, '/');
20276 plen = (int)STRLEN(p);
20277 slen = (int)STRLEN(sourcing_name);
20278 if (slen > plen && fnamecmp(p,
20279 sourcing_name + slen - plen) == 0)
20280 j = OK;
20281 vim_free(scriptname);
20284 if (j == FAIL)
20286 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20287 goto erret;
20291 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20292 if (fp == NULL)
20293 goto erret;
20295 if (fudi.fd_dict != NULL)
20297 if (fudi.fd_di == NULL)
20299 /* add new dict entry */
20300 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20301 if (fudi.fd_di == NULL)
20303 vim_free(fp);
20304 goto erret;
20306 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20308 vim_free(fudi.fd_di);
20309 vim_free(fp);
20310 goto erret;
20313 else
20314 /* overwrite existing dict entry */
20315 clear_tv(&fudi.fd_di->di_tv);
20316 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20317 fudi.fd_di->di_tv.v_lock = 0;
20318 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20319 fp->uf_refcount = 1;
20321 /* behave like "dict" was used */
20322 flags |= FC_DICT;
20325 /* insert the new function in the function list */
20326 STRCPY(fp->uf_name, name);
20327 hash_add(&func_hashtab, UF2HIKEY(fp));
20329 fp->uf_args = newargs;
20330 fp->uf_lines = newlines;
20331 #ifdef FEAT_PROFILE
20332 fp->uf_tml_count = NULL;
20333 fp->uf_tml_total = NULL;
20334 fp->uf_tml_self = NULL;
20335 fp->uf_profiling = FALSE;
20336 if (prof_def_func())
20337 func_do_profile(fp);
20338 #endif
20339 fp->uf_varargs = varargs;
20340 fp->uf_flags = flags;
20341 fp->uf_calls = 0;
20342 fp->uf_script_ID = current_SID;
20343 goto ret_free;
20345 erret:
20346 ga_clear_strings(&newargs);
20347 ga_clear_strings(&newlines);
20348 ret_free:
20349 vim_free(skip_until);
20350 vim_free(fudi.fd_newkey);
20351 vim_free(name);
20352 did_emsg |= saved_did_emsg;
20356 * Get a function name, translating "<SID>" and "<SNR>".
20357 * Also handles a Funcref in a List or Dictionary.
20358 * Returns the function name in allocated memory, or NULL for failure.
20359 * flags:
20360 * TFN_INT: internal function name OK
20361 * TFN_QUIET: be quiet
20362 * Advances "pp" to just after the function name (if no error).
20364 static char_u *
20365 trans_function_name(pp, skip, flags, fdp)
20366 char_u **pp;
20367 int skip; /* only find the end, don't evaluate */
20368 int flags;
20369 funcdict_T *fdp; /* return: info about dictionary used */
20371 char_u *name = NULL;
20372 char_u *start;
20373 char_u *end;
20374 int lead;
20375 char_u sid_buf[20];
20376 int len;
20377 lval_T lv;
20379 if (fdp != NULL)
20380 vim_memset(fdp, 0, sizeof(funcdict_T));
20381 start = *pp;
20383 /* Check for hard coded <SNR>: already translated function ID (from a user
20384 * command). */
20385 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20386 && (*pp)[2] == (int)KE_SNR)
20388 *pp += 3;
20389 len = get_id_len(pp) + 3;
20390 return vim_strnsave(start, len);
20393 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20394 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20395 lead = eval_fname_script(start);
20396 if (lead > 2)
20397 start += lead;
20399 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20400 lead > 2 ? 0 : FNE_CHECK_START);
20401 if (end == start)
20403 if (!skip)
20404 EMSG(_("E129: Function name required"));
20405 goto theend;
20407 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20410 * Report an invalid expression in braces, unless the expression
20411 * evaluation has been cancelled due to an aborting error, an
20412 * interrupt, or an exception.
20414 if (!aborting())
20416 if (end != NULL)
20417 EMSG2(_(e_invarg2), start);
20419 else
20420 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20421 goto theend;
20424 if (lv.ll_tv != NULL)
20426 if (fdp != NULL)
20428 fdp->fd_dict = lv.ll_dict;
20429 fdp->fd_newkey = lv.ll_newkey;
20430 lv.ll_newkey = NULL;
20431 fdp->fd_di = lv.ll_di;
20433 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20435 name = vim_strsave(lv.ll_tv->vval.v_string);
20436 *pp = end;
20438 else
20440 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20441 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20442 EMSG(_(e_funcref));
20443 else
20444 *pp = end;
20445 name = NULL;
20447 goto theend;
20450 if (lv.ll_name == NULL)
20452 /* Error found, but continue after the function name. */
20453 *pp = end;
20454 goto theend;
20457 /* Check if the name is a Funcref. If so, use the value. */
20458 if (lv.ll_exp_name != NULL)
20460 len = (int)STRLEN(lv.ll_exp_name);
20461 name = deref_func_name(lv.ll_exp_name, &len);
20462 if (name == lv.ll_exp_name)
20463 name = NULL;
20465 else
20467 len = (int)(end - *pp);
20468 name = deref_func_name(*pp, &len);
20469 if (name == *pp)
20470 name = NULL;
20472 if (name != NULL)
20474 name = vim_strsave(name);
20475 *pp = end;
20476 goto theend;
20479 if (lv.ll_exp_name != NULL)
20481 len = (int)STRLEN(lv.ll_exp_name);
20482 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20483 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20485 /* When there was "s:" already or the name expanded to get a
20486 * leading "s:" then remove it. */
20487 lv.ll_name += 2;
20488 len -= 2;
20489 lead = 2;
20492 else
20494 if (lead == 2) /* skip over "s:" */
20495 lv.ll_name += 2;
20496 len = (int)(end - lv.ll_name);
20500 * Copy the function name to allocated memory.
20501 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20502 * Accept <SNR>123_name() outside a script.
20504 if (skip)
20505 lead = 0; /* do nothing */
20506 else if (lead > 0)
20508 lead = 3;
20509 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20510 || eval_fname_sid(*pp))
20512 /* It's "s:" or "<SID>" */
20513 if (current_SID <= 0)
20515 EMSG(_(e_usingsid));
20516 goto theend;
20518 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20519 lead += (int)STRLEN(sid_buf);
20522 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20524 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20525 goto theend;
20527 name = alloc((unsigned)(len + lead + 1));
20528 if (name != NULL)
20530 if (lead > 0)
20532 name[0] = K_SPECIAL;
20533 name[1] = KS_EXTRA;
20534 name[2] = (int)KE_SNR;
20535 if (lead > 3) /* If it's "<SID>" */
20536 STRCPY(name + 3, sid_buf);
20538 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20539 name[len + lead] = NUL;
20541 *pp = end;
20543 theend:
20544 clear_lval(&lv);
20545 return name;
20549 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20550 * Return 2 if "p" starts with "s:".
20551 * Return 0 otherwise.
20553 static int
20554 eval_fname_script(p)
20555 char_u *p;
20557 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20558 || STRNICMP(p + 1, "SNR>", 4) == 0))
20559 return 5;
20560 if (p[0] == 's' && p[1] == ':')
20561 return 2;
20562 return 0;
20566 * Return TRUE if "p" starts with "<SID>" or "s:".
20567 * Only works if eval_fname_script() returned non-zero for "p"!
20569 static int
20570 eval_fname_sid(p)
20571 char_u *p;
20573 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20577 * List the head of the function: "name(arg1, arg2)".
20579 static void
20580 list_func_head(fp, indent)
20581 ufunc_T *fp;
20582 int indent;
20584 int j;
20586 msg_start();
20587 if (indent)
20588 MSG_PUTS(" ");
20589 MSG_PUTS("function ");
20590 if (fp->uf_name[0] == K_SPECIAL)
20592 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20593 msg_puts(fp->uf_name + 3);
20595 else
20596 msg_puts(fp->uf_name);
20597 msg_putchar('(');
20598 for (j = 0; j < fp->uf_args.ga_len; ++j)
20600 if (j)
20601 MSG_PUTS(", ");
20602 msg_puts(FUNCARG(fp, j));
20604 if (fp->uf_varargs)
20606 if (j)
20607 MSG_PUTS(", ");
20608 MSG_PUTS("...");
20610 msg_putchar(')');
20611 msg_clr_eos();
20612 if (p_verbose > 0)
20613 last_set_msg(fp->uf_script_ID);
20617 * Find a function by name, return pointer to it in ufuncs.
20618 * Return NULL for unknown function.
20620 static ufunc_T *
20621 find_func(name)
20622 char_u *name;
20624 hashitem_T *hi;
20626 hi = hash_find(&func_hashtab, name);
20627 if (!HASHITEM_EMPTY(hi))
20628 return HI2UF(hi);
20629 return NULL;
20632 #if defined(EXITFREE) || defined(PROTO)
20633 void
20634 free_all_functions()
20636 hashitem_T *hi;
20638 /* Need to start all over every time, because func_free() may change the
20639 * hash table. */
20640 while (func_hashtab.ht_used > 0)
20641 for (hi = func_hashtab.ht_array; ; ++hi)
20642 if (!HASHITEM_EMPTY(hi))
20644 func_free(HI2UF(hi));
20645 break;
20648 #endif
20651 * Return TRUE if a function "name" exists.
20653 static int
20654 function_exists(name)
20655 char_u *name;
20657 char_u *nm = name;
20658 char_u *p;
20659 int n = FALSE;
20661 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20662 nm = skipwhite(nm);
20664 /* Only accept "funcname", "funcname ", "funcname (..." and
20665 * "funcname(...", not "funcname!...". */
20666 if (p != NULL && (*nm == NUL || *nm == '('))
20668 if (builtin_function(p))
20669 n = (find_internal_func(p) >= 0);
20670 else
20671 n = (find_func(p) != NULL);
20673 vim_free(p);
20674 return n;
20678 * Return TRUE if "name" looks like a builtin function name: starts with a
20679 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20681 static int
20682 builtin_function(name)
20683 char_u *name;
20685 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20686 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20689 #if defined(FEAT_PROFILE) || defined(PROTO)
20691 * Start profiling function "fp".
20693 static void
20694 func_do_profile(fp)
20695 ufunc_T *fp;
20697 fp->uf_tm_count = 0;
20698 profile_zero(&fp->uf_tm_self);
20699 profile_zero(&fp->uf_tm_total);
20700 if (fp->uf_tml_count == NULL)
20701 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20702 (sizeof(int) * fp->uf_lines.ga_len));
20703 if (fp->uf_tml_total == NULL)
20704 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20705 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20706 if (fp->uf_tml_self == NULL)
20707 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20708 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20709 fp->uf_tml_idx = -1;
20710 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20711 || fp->uf_tml_self == NULL)
20712 return; /* out of memory */
20714 fp->uf_profiling = TRUE;
20718 * Dump the profiling results for all functions in file "fd".
20720 void
20721 func_dump_profile(fd)
20722 FILE *fd;
20724 hashitem_T *hi;
20725 int todo;
20726 ufunc_T *fp;
20727 int i;
20728 ufunc_T **sorttab;
20729 int st_len = 0;
20731 todo = (int)func_hashtab.ht_used;
20732 if (todo == 0)
20733 return; /* nothing to dump */
20735 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20737 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20739 if (!HASHITEM_EMPTY(hi))
20741 --todo;
20742 fp = HI2UF(hi);
20743 if (fp->uf_profiling)
20745 if (sorttab != NULL)
20746 sorttab[st_len++] = fp;
20748 if (fp->uf_name[0] == K_SPECIAL)
20749 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20750 else
20751 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20752 if (fp->uf_tm_count == 1)
20753 fprintf(fd, "Called 1 time\n");
20754 else
20755 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20756 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20757 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20758 fprintf(fd, "\n");
20759 fprintf(fd, "count total (s) self (s)\n");
20761 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20763 if (FUNCLINE(fp, i) == NULL)
20764 continue;
20765 prof_func_line(fd, fp->uf_tml_count[i],
20766 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20767 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20769 fprintf(fd, "\n");
20774 if (sorttab != NULL && st_len > 0)
20776 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20777 prof_total_cmp);
20778 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20779 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20780 prof_self_cmp);
20781 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20784 vim_free(sorttab);
20787 static void
20788 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20789 FILE *fd;
20790 ufunc_T **sorttab;
20791 int st_len;
20792 char *title;
20793 int prefer_self; /* when equal print only self time */
20795 int i;
20796 ufunc_T *fp;
20798 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20799 fprintf(fd, "count total (s) self (s) function\n");
20800 for (i = 0; i < 20 && i < st_len; ++i)
20802 fp = sorttab[i];
20803 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20804 prefer_self);
20805 if (fp->uf_name[0] == K_SPECIAL)
20806 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20807 else
20808 fprintf(fd, " %s()\n", fp->uf_name);
20810 fprintf(fd, "\n");
20814 * Print the count and times for one function or function line.
20816 static void
20817 prof_func_line(fd, count, total, self, prefer_self)
20818 FILE *fd;
20819 int count;
20820 proftime_T *total;
20821 proftime_T *self;
20822 int prefer_self; /* when equal print only self time */
20824 if (count > 0)
20826 fprintf(fd, "%5d ", count);
20827 if (prefer_self && profile_equal(total, self))
20828 fprintf(fd, " ");
20829 else
20830 fprintf(fd, "%s ", profile_msg(total));
20831 if (!prefer_self && profile_equal(total, self))
20832 fprintf(fd, " ");
20833 else
20834 fprintf(fd, "%s ", profile_msg(self));
20836 else
20837 fprintf(fd, " ");
20841 * Compare function for total time sorting.
20843 static int
20844 #ifdef __BORLANDC__
20845 _RTLENTRYF
20846 #endif
20847 prof_total_cmp(s1, s2)
20848 const void *s1;
20849 const void *s2;
20851 ufunc_T *p1, *p2;
20853 p1 = *(ufunc_T **)s1;
20854 p2 = *(ufunc_T **)s2;
20855 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20859 * Compare function for self time sorting.
20861 static int
20862 #ifdef __BORLANDC__
20863 _RTLENTRYF
20864 #endif
20865 prof_self_cmp(s1, s2)
20866 const void *s1;
20867 const void *s2;
20869 ufunc_T *p1, *p2;
20871 p1 = *(ufunc_T **)s1;
20872 p2 = *(ufunc_T **)s2;
20873 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20876 #endif
20879 * If "name" has a package name try autoloading the script for it.
20880 * Return TRUE if a package was loaded.
20882 static int
20883 script_autoload(name, reload)
20884 char_u *name;
20885 int reload; /* load script again when already loaded */
20887 char_u *p;
20888 char_u *scriptname, *tofree;
20889 int ret = FALSE;
20890 int i;
20892 /* If there is no '#' after name[0] there is no package name. */
20893 p = vim_strchr(name, AUTOLOAD_CHAR);
20894 if (p == NULL || p == name)
20895 return FALSE;
20897 tofree = scriptname = autoload_name(name);
20899 /* Find the name in the list of previously loaded package names. Skip
20900 * "autoload/", it's always the same. */
20901 for (i = 0; i < ga_loaded.ga_len; ++i)
20902 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20903 break;
20904 if (!reload && i < ga_loaded.ga_len)
20905 ret = FALSE; /* was loaded already */
20906 else
20908 /* Remember the name if it wasn't loaded already. */
20909 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20911 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20912 tofree = NULL;
20915 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20916 if (source_runtime(scriptname, FALSE) == OK)
20917 ret = TRUE;
20920 vim_free(tofree);
20921 return ret;
20925 * Return the autoload script name for a function or variable name.
20926 * Returns NULL when out of memory.
20928 static char_u *
20929 autoload_name(name)
20930 char_u *name;
20932 char_u *p;
20933 char_u *scriptname;
20935 /* Get the script file name: replace '#' with '/', append ".vim". */
20936 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20937 if (scriptname == NULL)
20938 return FALSE;
20939 STRCPY(scriptname, "autoload/");
20940 STRCAT(scriptname, name);
20941 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20942 STRCAT(scriptname, ".vim");
20943 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20944 *p = '/';
20945 return scriptname;
20948 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20951 * Function given to ExpandGeneric() to obtain the list of user defined
20952 * function names.
20954 char_u *
20955 get_user_func_name(xp, idx)
20956 expand_T *xp;
20957 int idx;
20959 static long_u done;
20960 static hashitem_T *hi;
20961 ufunc_T *fp;
20963 if (idx == 0)
20965 done = 0;
20966 hi = func_hashtab.ht_array;
20968 if (done < func_hashtab.ht_used)
20970 if (done++ > 0)
20971 ++hi;
20972 while (HASHITEM_EMPTY(hi))
20973 ++hi;
20974 fp = HI2UF(hi);
20976 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20977 return fp->uf_name; /* prevents overflow */
20979 cat_func_name(IObuff, fp);
20980 if (xp->xp_context != EXPAND_USER_FUNC)
20982 STRCAT(IObuff, "(");
20983 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20984 STRCAT(IObuff, ")");
20986 return IObuff;
20988 return NULL;
20991 #endif /* FEAT_CMDL_COMPL */
20994 * Copy the function name of "fp" to buffer "buf".
20995 * "buf" must be able to hold the function name plus three bytes.
20996 * Takes care of script-local function names.
20998 static void
20999 cat_func_name(buf, fp)
21000 char_u *buf;
21001 ufunc_T *fp;
21003 if (fp->uf_name[0] == K_SPECIAL)
21005 STRCPY(buf, "<SNR>");
21006 STRCAT(buf, fp->uf_name + 3);
21008 else
21009 STRCPY(buf, fp->uf_name);
21013 * ":delfunction {name}"
21015 void
21016 ex_delfunction(eap)
21017 exarg_T *eap;
21019 ufunc_T *fp = NULL;
21020 char_u *p;
21021 char_u *name;
21022 funcdict_T fudi;
21024 p = eap->arg;
21025 name = trans_function_name(&p, eap->skip, 0, &fudi);
21026 vim_free(fudi.fd_newkey);
21027 if (name == NULL)
21029 if (fudi.fd_dict != NULL && !eap->skip)
21030 EMSG(_(e_funcref));
21031 return;
21033 if (!ends_excmd(*skipwhite(p)))
21035 vim_free(name);
21036 EMSG(_(e_trailing));
21037 return;
21039 eap->nextcmd = check_nextcmd(p);
21040 if (eap->nextcmd != NULL)
21041 *p = NUL;
21043 if (!eap->skip)
21044 fp = find_func(name);
21045 vim_free(name);
21047 if (!eap->skip)
21049 if (fp == NULL)
21051 EMSG2(_(e_nofunc), eap->arg);
21052 return;
21054 if (fp->uf_calls > 0)
21056 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21057 return;
21060 if (fudi.fd_dict != NULL)
21062 /* Delete the dict item that refers to the function, it will
21063 * invoke func_unref() and possibly delete the function. */
21064 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21066 else
21067 func_free(fp);
21072 * Free a function and remove it from the list of functions.
21074 static void
21075 func_free(fp)
21076 ufunc_T *fp;
21078 hashitem_T *hi;
21080 /* clear this function */
21081 ga_clear_strings(&(fp->uf_args));
21082 ga_clear_strings(&(fp->uf_lines));
21083 #ifdef FEAT_PROFILE
21084 vim_free(fp->uf_tml_count);
21085 vim_free(fp->uf_tml_total);
21086 vim_free(fp->uf_tml_self);
21087 #endif
21089 /* remove the function from the function hashtable */
21090 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21091 if (HASHITEM_EMPTY(hi))
21092 EMSG2(_(e_intern2), "func_free()");
21093 else
21094 hash_remove(&func_hashtab, hi);
21096 vim_free(fp);
21100 * Unreference a Function: decrement the reference count and free it when it
21101 * becomes zero. Only for numbered functions.
21103 static void
21104 func_unref(name)
21105 char_u *name;
21107 ufunc_T *fp;
21109 if (name != NULL && isdigit(*name))
21111 fp = find_func(name);
21112 if (fp == NULL)
21113 EMSG2(_(e_intern2), "func_unref()");
21114 else if (--fp->uf_refcount <= 0)
21116 /* Only delete it when it's not being used. Otherwise it's done
21117 * when "uf_calls" becomes zero. */
21118 if (fp->uf_calls == 0)
21119 func_free(fp);
21125 * Count a reference to a Function.
21127 static void
21128 func_ref(name)
21129 char_u *name;
21131 ufunc_T *fp;
21133 if (name != NULL && isdigit(*name))
21135 fp = find_func(name);
21136 if (fp == NULL)
21137 EMSG2(_(e_intern2), "func_ref()");
21138 else
21139 ++fp->uf_refcount;
21144 * Call a user function.
21146 static void
21147 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21148 ufunc_T *fp; /* pointer to function */
21149 int argcount; /* nr of args */
21150 typval_T *argvars; /* arguments */
21151 typval_T *rettv; /* return value */
21152 linenr_T firstline; /* first line of range */
21153 linenr_T lastline; /* last line of range */
21154 dict_T *selfdict; /* Dictionary for "self" */
21156 char_u *save_sourcing_name;
21157 linenr_T save_sourcing_lnum;
21158 scid_T save_current_SID;
21159 funccall_T *fc;
21160 int save_did_emsg;
21161 static int depth = 0;
21162 dictitem_T *v;
21163 int fixvar_idx = 0; /* index in fixvar[] */
21164 int i;
21165 int ai;
21166 char_u numbuf[NUMBUFLEN];
21167 char_u *name;
21168 #ifdef FEAT_PROFILE
21169 proftime_T wait_start;
21170 proftime_T call_start;
21171 #endif
21173 /* If depth of calling is getting too high, don't execute the function */
21174 if (depth >= p_mfd)
21176 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21177 rettv->v_type = VAR_NUMBER;
21178 rettv->vval.v_number = -1;
21179 return;
21181 ++depth;
21183 line_breakcheck(); /* check for CTRL-C hit */
21185 fc = (funccall_T *)alloc(sizeof(funccall_T));
21186 fc->caller = current_funccal;
21187 current_funccal = fc;
21188 fc->func = fp;
21189 fc->rettv = rettv;
21190 rettv->vval.v_number = 0;
21191 fc->linenr = 0;
21192 fc->returned = FALSE;
21193 fc->level = ex_nesting_level;
21194 /* Check if this function has a breakpoint. */
21195 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21196 fc->dbg_tick = debug_tick;
21199 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21200 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21201 * each argument variable and saves a lot of time.
21204 * Init l: variables.
21206 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21207 if (selfdict != NULL)
21209 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21210 * some compiler that checks the destination size. */
21211 v = &fc->fixvar[fixvar_idx++].var;
21212 name = v->di_key;
21213 STRCPY(name, "self");
21214 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21215 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21216 v->di_tv.v_type = VAR_DICT;
21217 v->di_tv.v_lock = 0;
21218 v->di_tv.vval.v_dict = selfdict;
21219 ++selfdict->dv_refcount;
21223 * Init a: variables.
21224 * Set a:0 to "argcount".
21225 * Set a:000 to a list with room for the "..." arguments.
21227 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21228 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21229 (varnumber_T)(argcount - fp->uf_args.ga_len));
21230 /* Use "name" to avoid a warning from some compiler that checks the
21231 * destination size. */
21232 v = &fc->fixvar[fixvar_idx++].var;
21233 name = v->di_key;
21234 STRCPY(name, "000");
21235 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21236 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21237 v->di_tv.v_type = VAR_LIST;
21238 v->di_tv.v_lock = VAR_FIXED;
21239 v->di_tv.vval.v_list = &fc->l_varlist;
21240 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21241 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21242 fc->l_varlist.lv_lock = VAR_FIXED;
21245 * Set a:firstline to "firstline" and a:lastline to "lastline".
21246 * Set a:name to named arguments.
21247 * Set a:N to the "..." arguments.
21249 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21250 (varnumber_T)firstline);
21251 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21252 (varnumber_T)lastline);
21253 for (i = 0; i < argcount; ++i)
21255 ai = i - fp->uf_args.ga_len;
21256 if (ai < 0)
21257 /* named argument a:name */
21258 name = FUNCARG(fp, i);
21259 else
21261 /* "..." argument a:1, a:2, etc. */
21262 sprintf((char *)numbuf, "%d", ai + 1);
21263 name = numbuf;
21265 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21267 v = &fc->fixvar[fixvar_idx++].var;
21268 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21270 else
21272 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21273 + STRLEN(name)));
21274 if (v == NULL)
21275 break;
21276 v->di_flags = DI_FLAGS_RO;
21278 STRCPY(v->di_key, name);
21279 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21281 /* Note: the values are copied directly to avoid alloc/free.
21282 * "argvars" must have VAR_FIXED for v_lock. */
21283 v->di_tv = argvars[i];
21284 v->di_tv.v_lock = VAR_FIXED;
21286 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21288 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21289 fc->l_listitems[ai].li_tv = argvars[i];
21290 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21294 /* Don't redraw while executing the function. */
21295 ++RedrawingDisabled;
21296 save_sourcing_name = sourcing_name;
21297 save_sourcing_lnum = sourcing_lnum;
21298 sourcing_lnum = 1;
21299 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21300 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21301 if (sourcing_name != NULL)
21303 if (save_sourcing_name != NULL
21304 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21305 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21306 else
21307 STRCPY(sourcing_name, "function ");
21308 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21310 if (p_verbose >= 12)
21312 ++no_wait_return;
21313 verbose_enter_scroll();
21315 smsg((char_u *)_("calling %s"), sourcing_name);
21316 if (p_verbose >= 14)
21318 char_u buf[MSG_BUF_LEN];
21319 char_u numbuf2[NUMBUFLEN];
21320 char_u *tofree;
21321 char_u *s;
21323 msg_puts((char_u *)"(");
21324 for (i = 0; i < argcount; ++i)
21326 if (i > 0)
21327 msg_puts((char_u *)", ");
21328 if (argvars[i].v_type == VAR_NUMBER)
21329 msg_outnum((long)argvars[i].vval.v_number);
21330 else
21332 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21333 if (s != NULL)
21335 trunc_string(s, buf, MSG_BUF_CLEN);
21336 msg_puts(buf);
21337 vim_free(tofree);
21341 msg_puts((char_u *)")");
21343 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21345 verbose_leave_scroll();
21346 --no_wait_return;
21349 #ifdef FEAT_PROFILE
21350 if (do_profiling == PROF_YES)
21352 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21353 func_do_profile(fp);
21354 if (fp->uf_profiling
21355 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21357 ++fp->uf_tm_count;
21358 profile_start(&call_start);
21359 profile_zero(&fp->uf_tm_children);
21361 script_prof_save(&wait_start);
21363 #endif
21365 save_current_SID = current_SID;
21366 current_SID = fp->uf_script_ID;
21367 save_did_emsg = did_emsg;
21368 did_emsg = FALSE;
21370 /* call do_cmdline() to execute the lines */
21371 do_cmdline(NULL, get_func_line, (void *)fc,
21372 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21374 --RedrawingDisabled;
21376 /* when the function was aborted because of an error, return -1 */
21377 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21379 clear_tv(rettv);
21380 rettv->v_type = VAR_NUMBER;
21381 rettv->vval.v_number = -1;
21384 #ifdef FEAT_PROFILE
21385 if (do_profiling == PROF_YES && (fp->uf_profiling
21386 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21388 profile_end(&call_start);
21389 profile_sub_wait(&wait_start, &call_start);
21390 profile_add(&fp->uf_tm_total, &call_start);
21391 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21392 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21394 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21395 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21398 #endif
21400 /* when being verbose, mention the return value */
21401 if (p_verbose >= 12)
21403 ++no_wait_return;
21404 verbose_enter_scroll();
21406 if (aborting())
21407 smsg((char_u *)_("%s aborted"), sourcing_name);
21408 else if (fc->rettv->v_type == VAR_NUMBER)
21409 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21410 (long)fc->rettv->vval.v_number);
21411 else
21413 char_u buf[MSG_BUF_LEN];
21414 char_u numbuf2[NUMBUFLEN];
21415 char_u *tofree;
21416 char_u *s;
21418 /* The value may be very long. Skip the middle part, so that we
21419 * have some idea how it starts and ends. smsg() would always
21420 * truncate it at the end. */
21421 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21422 if (s != NULL)
21424 trunc_string(s, buf, MSG_BUF_CLEN);
21425 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21426 vim_free(tofree);
21429 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21431 verbose_leave_scroll();
21432 --no_wait_return;
21435 vim_free(sourcing_name);
21436 sourcing_name = save_sourcing_name;
21437 sourcing_lnum = save_sourcing_lnum;
21438 current_SID = save_current_SID;
21439 #ifdef FEAT_PROFILE
21440 if (do_profiling == PROF_YES)
21441 script_prof_restore(&wait_start);
21442 #endif
21444 if (p_verbose >= 12 && sourcing_name != NULL)
21446 ++no_wait_return;
21447 verbose_enter_scroll();
21449 smsg((char_u *)_("continuing in %s"), sourcing_name);
21450 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21452 verbose_leave_scroll();
21453 --no_wait_return;
21456 did_emsg |= save_did_emsg;
21457 current_funccal = fc->caller;
21458 --depth;
21460 /* if the a:000 list and the a: dict are not referenced we can free the
21461 * funccall_T and what's in it. */
21462 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21463 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21464 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21466 free_funccal(fc, FALSE);
21468 else
21470 hashitem_T *hi;
21471 listitem_T *li;
21472 int todo;
21474 /* "fc" is still in use. This can happen when returning "a:000" or
21475 * assigning "l:" to a global variable.
21476 * Link "fc" in the list for garbage collection later. */
21477 fc->caller = previous_funccal;
21478 previous_funccal = fc;
21480 /* Make a copy of the a: variables, since we didn't do that above. */
21481 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21482 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21484 if (!HASHITEM_EMPTY(hi))
21486 --todo;
21487 v = HI2DI(hi);
21488 copy_tv(&v->di_tv, &v->di_tv);
21492 /* Make a copy of the a:000 items, since we didn't do that above. */
21493 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21494 copy_tv(&li->li_tv, &li->li_tv);
21499 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21500 * referenced from anywyere.
21502 static int
21503 can_free_funccal(fc, copyID)
21504 funccall_T *fc;
21505 int copyID;
21507 return (fc->l_varlist.lv_copyID != copyID
21508 && fc->l_vars.dv_copyID != copyID
21509 && fc->l_avars.dv_copyID != copyID);
21513 * Free "fc" and what it contains.
21515 static void
21516 free_funccal(fc, free_val)
21517 funccall_T *fc;
21518 int free_val; /* a: vars were allocated */
21520 listitem_T *li;
21522 /* The a: variables typevals may not have been allocated, only free the
21523 * allocated variables. */
21524 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21526 /* free all l: variables */
21527 vars_clear(&fc->l_vars.dv_hashtab);
21529 /* Free the a:000 variables if they were allocated. */
21530 if (free_val)
21531 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21532 clear_tv(&li->li_tv);
21534 vim_free(fc);
21538 * Add a number variable "name" to dict "dp" with value "nr".
21540 static void
21541 add_nr_var(dp, v, name, nr)
21542 dict_T *dp;
21543 dictitem_T *v;
21544 char *name;
21545 varnumber_T nr;
21547 STRCPY(v->di_key, name);
21548 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21549 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21550 v->di_tv.v_type = VAR_NUMBER;
21551 v->di_tv.v_lock = VAR_FIXED;
21552 v->di_tv.vval.v_number = nr;
21556 * ":return [expr]"
21558 void
21559 ex_return(eap)
21560 exarg_T *eap;
21562 char_u *arg = eap->arg;
21563 typval_T rettv;
21564 int returning = FALSE;
21566 if (current_funccal == NULL)
21568 EMSG(_("E133: :return not inside a function"));
21569 return;
21572 if (eap->skip)
21573 ++emsg_skip;
21575 eap->nextcmd = NULL;
21576 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21577 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21579 if (!eap->skip)
21580 returning = do_return(eap, FALSE, TRUE, &rettv);
21581 else
21582 clear_tv(&rettv);
21584 /* It's safer to return also on error. */
21585 else if (!eap->skip)
21588 * Return unless the expression evaluation has been cancelled due to an
21589 * aborting error, an interrupt, or an exception.
21591 if (!aborting())
21592 returning = do_return(eap, FALSE, TRUE, NULL);
21595 /* When skipping or the return gets pending, advance to the next command
21596 * in this line (!returning). Otherwise, ignore the rest of the line.
21597 * Following lines will be ignored by get_func_line(). */
21598 if (returning)
21599 eap->nextcmd = NULL;
21600 else if (eap->nextcmd == NULL) /* no argument */
21601 eap->nextcmd = check_nextcmd(arg);
21603 if (eap->skip)
21604 --emsg_skip;
21608 * Return from a function. Possibly makes the return pending. Also called
21609 * for a pending return at the ":endtry" or after returning from an extra
21610 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21611 * when called due to a ":return" command. "rettv" may point to a typval_T
21612 * with the return rettv. Returns TRUE when the return can be carried out,
21613 * FALSE when the return gets pending.
21616 do_return(eap, reanimate, is_cmd, rettv)
21617 exarg_T *eap;
21618 int reanimate;
21619 int is_cmd;
21620 void *rettv;
21622 int idx;
21623 struct condstack *cstack = eap->cstack;
21625 if (reanimate)
21626 /* Undo the return. */
21627 current_funccal->returned = FALSE;
21630 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21631 * not in its finally clause (which then is to be executed next) is found.
21632 * In this case, make the ":return" pending for execution at the ":endtry".
21633 * Otherwise, return normally.
21635 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21636 if (idx >= 0)
21638 cstack->cs_pending[idx] = CSTP_RETURN;
21640 if (!is_cmd && !reanimate)
21641 /* A pending return again gets pending. "rettv" points to an
21642 * allocated variable with the rettv of the original ":return"'s
21643 * argument if present or is NULL else. */
21644 cstack->cs_rettv[idx] = rettv;
21645 else
21647 /* When undoing a return in order to make it pending, get the stored
21648 * return rettv. */
21649 if (reanimate)
21650 rettv = current_funccal->rettv;
21652 if (rettv != NULL)
21654 /* Store the value of the pending return. */
21655 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21656 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21657 else
21658 EMSG(_(e_outofmem));
21660 else
21661 cstack->cs_rettv[idx] = NULL;
21663 if (reanimate)
21665 /* The pending return value could be overwritten by a ":return"
21666 * without argument in a finally clause; reset the default
21667 * return value. */
21668 current_funccal->rettv->v_type = VAR_NUMBER;
21669 current_funccal->rettv->vval.v_number = 0;
21672 report_make_pending(CSTP_RETURN, rettv);
21674 else
21676 current_funccal->returned = TRUE;
21678 /* If the return is carried out now, store the return value. For
21679 * a return immediately after reanimation, the value is already
21680 * there. */
21681 if (!reanimate && rettv != NULL)
21683 clear_tv(current_funccal->rettv);
21684 *current_funccal->rettv = *(typval_T *)rettv;
21685 if (!is_cmd)
21686 vim_free(rettv);
21690 return idx < 0;
21694 * Free the variable with a pending return value.
21696 void
21697 discard_pending_return(rettv)
21698 void *rettv;
21700 free_tv((typval_T *)rettv);
21704 * Generate a return command for producing the value of "rettv". The result
21705 * is an allocated string. Used by report_pending() for verbose messages.
21707 char_u *
21708 get_return_cmd(rettv)
21709 void *rettv;
21711 char_u *s = NULL;
21712 char_u *tofree = NULL;
21713 char_u numbuf[NUMBUFLEN];
21715 if (rettv != NULL)
21716 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21717 if (s == NULL)
21718 s = (char_u *)"";
21720 STRCPY(IObuff, ":return ");
21721 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21722 if (STRLEN(s) + 8 >= IOSIZE)
21723 STRCPY(IObuff + IOSIZE - 4, "...");
21724 vim_free(tofree);
21725 return vim_strsave(IObuff);
21729 * Get next function line.
21730 * Called by do_cmdline() to get the next line.
21731 * Returns allocated string, or NULL for end of function.
21733 /* ARGSUSED */
21734 char_u *
21735 get_func_line(c, cookie, indent)
21736 int c; /* not used */
21737 void *cookie;
21738 int indent; /* not used */
21740 funccall_T *fcp = (funccall_T *)cookie;
21741 ufunc_T *fp = fcp->func;
21742 char_u *retval;
21743 garray_T *gap; /* growarray with function lines */
21745 /* If breakpoints have been added/deleted need to check for it. */
21746 if (fcp->dbg_tick != debug_tick)
21748 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21749 sourcing_lnum);
21750 fcp->dbg_tick = debug_tick;
21752 #ifdef FEAT_PROFILE
21753 if (do_profiling == PROF_YES)
21754 func_line_end(cookie);
21755 #endif
21757 gap = &fp->uf_lines;
21758 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21759 || fcp->returned)
21760 retval = NULL;
21761 else
21763 /* Skip NULL lines (continuation lines). */
21764 while (fcp->linenr < gap->ga_len
21765 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21766 ++fcp->linenr;
21767 if (fcp->linenr >= gap->ga_len)
21768 retval = NULL;
21769 else
21771 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21772 sourcing_lnum = fcp->linenr;
21773 #ifdef FEAT_PROFILE
21774 if (do_profiling == PROF_YES)
21775 func_line_start(cookie);
21776 #endif
21780 /* Did we encounter a breakpoint? */
21781 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21783 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21784 /* Find next breakpoint. */
21785 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21786 sourcing_lnum);
21787 fcp->dbg_tick = debug_tick;
21790 return retval;
21793 #if defined(FEAT_PROFILE) || defined(PROTO)
21795 * Called when starting to read a function line.
21796 * "sourcing_lnum" must be correct!
21797 * When skipping lines it may not actually be executed, but we won't find out
21798 * until later and we need to store the time now.
21800 void
21801 func_line_start(cookie)
21802 void *cookie;
21804 funccall_T *fcp = (funccall_T *)cookie;
21805 ufunc_T *fp = fcp->func;
21807 if (fp->uf_profiling && sourcing_lnum >= 1
21808 && sourcing_lnum <= fp->uf_lines.ga_len)
21810 fp->uf_tml_idx = sourcing_lnum - 1;
21811 /* Skip continuation lines. */
21812 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21813 --fp->uf_tml_idx;
21814 fp->uf_tml_execed = FALSE;
21815 profile_start(&fp->uf_tml_start);
21816 profile_zero(&fp->uf_tml_children);
21817 profile_get_wait(&fp->uf_tml_wait);
21822 * Called when actually executing a function line.
21824 void
21825 func_line_exec(cookie)
21826 void *cookie;
21828 funccall_T *fcp = (funccall_T *)cookie;
21829 ufunc_T *fp = fcp->func;
21831 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21832 fp->uf_tml_execed = TRUE;
21836 * Called when done with a function line.
21838 void
21839 func_line_end(cookie)
21840 void *cookie;
21842 funccall_T *fcp = (funccall_T *)cookie;
21843 ufunc_T *fp = fcp->func;
21845 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21847 if (fp->uf_tml_execed)
21849 ++fp->uf_tml_count[fp->uf_tml_idx];
21850 profile_end(&fp->uf_tml_start);
21851 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21852 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21853 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21854 &fp->uf_tml_children);
21856 fp->uf_tml_idx = -1;
21859 #endif
21862 * Return TRUE if the currently active function should be ended, because a
21863 * return was encountered or an error occurred. Used inside a ":while".
21866 func_has_ended(cookie)
21867 void *cookie;
21869 funccall_T *fcp = (funccall_T *)cookie;
21871 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21872 * an error inside a try conditional. */
21873 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21874 || fcp->returned);
21878 * return TRUE if cookie indicates a function which "abort"s on errors.
21881 func_has_abort(cookie)
21882 void *cookie;
21884 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21887 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21888 typedef enum
21890 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21891 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21892 VAR_FLAVOUR_VIMINFO /* all uppercase */
21893 } var_flavour_T;
21895 static var_flavour_T var_flavour __ARGS((char_u *varname));
21897 static var_flavour_T
21898 var_flavour(varname)
21899 char_u *varname;
21901 char_u *p = varname;
21903 if (ASCII_ISUPPER(*p))
21905 while (*(++p))
21906 if (ASCII_ISLOWER(*p))
21907 return VAR_FLAVOUR_SESSION;
21908 return VAR_FLAVOUR_VIMINFO;
21910 else
21911 return VAR_FLAVOUR_DEFAULT;
21913 #endif
21915 #if defined(FEAT_VIMINFO) || defined(PROTO)
21917 * Restore global vars that start with a capital from the viminfo file
21920 read_viminfo_varlist(virp, writing)
21921 vir_T *virp;
21922 int writing;
21924 char_u *tab;
21925 int type = VAR_NUMBER;
21926 typval_T tv;
21928 if (!writing && (find_viminfo_parameter('!') != NULL))
21930 tab = vim_strchr(virp->vir_line + 1, '\t');
21931 if (tab != NULL)
21933 *tab++ = '\0'; /* isolate the variable name */
21934 if (*tab == 'S') /* string var */
21935 type = VAR_STRING;
21936 #ifdef FEAT_FLOAT
21937 else if (*tab == 'F')
21938 type = VAR_FLOAT;
21939 #endif
21941 tab = vim_strchr(tab, '\t');
21942 if (tab != NULL)
21944 tv.v_type = type;
21945 if (type == VAR_STRING)
21946 tv.vval.v_string = viminfo_readstring(virp,
21947 (int)(tab - virp->vir_line + 1), TRUE);
21948 #ifdef FEAT_FLOAT
21949 else if (type == VAR_FLOAT)
21950 (void)string2float(tab + 1, &tv.vval.v_float);
21951 #endif
21952 else
21953 tv.vval.v_number = atol((char *)tab + 1);
21954 set_var(virp->vir_line + 1, &tv, FALSE);
21955 if (type == VAR_STRING)
21956 vim_free(tv.vval.v_string);
21961 return viminfo_readline(virp);
21965 * Write global vars that start with a capital to the viminfo file
21967 void
21968 write_viminfo_varlist(fp)
21969 FILE *fp;
21971 hashitem_T *hi;
21972 dictitem_T *this_var;
21973 int todo;
21974 char *s;
21975 char_u *p;
21976 char_u *tofree;
21977 char_u numbuf[NUMBUFLEN];
21979 if (find_viminfo_parameter('!') == NULL)
21980 return;
21982 fprintf(fp, _("\n# global variables:\n"));
21984 todo = (int)globvarht.ht_used;
21985 for (hi = globvarht.ht_array; todo > 0; ++hi)
21987 if (!HASHITEM_EMPTY(hi))
21989 --todo;
21990 this_var = HI2DI(hi);
21991 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21993 switch (this_var->di_tv.v_type)
21995 case VAR_STRING: s = "STR"; break;
21996 case VAR_NUMBER: s = "NUM"; break;
21997 #ifdef FEAT_FLOAT
21998 case VAR_FLOAT: s = "FLO"; break;
21999 #endif
22000 default: continue;
22002 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
22003 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
22004 if (p != NULL)
22005 viminfo_writestring(fp, p);
22006 vim_free(tofree);
22011 #endif
22013 #if defined(FEAT_SESSION) || defined(PROTO)
22015 store_session_globals(fd)
22016 FILE *fd;
22018 hashitem_T *hi;
22019 dictitem_T *this_var;
22020 int todo;
22021 char_u *p, *t;
22023 todo = (int)globvarht.ht_used;
22024 for (hi = globvarht.ht_array; todo > 0; ++hi)
22026 if (!HASHITEM_EMPTY(hi))
22028 --todo;
22029 this_var = HI2DI(hi);
22030 if ((this_var->di_tv.v_type == VAR_NUMBER
22031 || this_var->di_tv.v_type == VAR_STRING)
22032 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22034 /* Escape special characters with a backslash. Turn a LF and
22035 * CR into \n and \r. */
22036 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
22037 (char_u *)"\\\"\n\r");
22038 if (p == NULL) /* out of memory */
22039 break;
22040 for (t = p; *t != NUL; ++t)
22041 if (*t == '\n')
22042 *t = 'n';
22043 else if (*t == '\r')
22044 *t = 'r';
22045 if ((fprintf(fd, "let %s = %c%s%c",
22046 this_var->di_key,
22047 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22048 : ' ',
22050 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22051 : ' ') < 0)
22052 || put_eol(fd) == FAIL)
22054 vim_free(p);
22055 return FAIL;
22057 vim_free(p);
22059 #ifdef FEAT_FLOAT
22060 else if (this_var->di_tv.v_type == VAR_FLOAT
22061 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22063 float_T f = this_var->di_tv.vval.v_float;
22064 int sign = ' ';
22066 if (f < 0)
22068 f = -f;
22069 sign = '-';
22071 if ((fprintf(fd, "let %s = %c&%f",
22072 this_var->di_key, sign, f) < 0)
22073 || put_eol(fd) == FAIL)
22074 return FAIL;
22076 #endif
22079 return OK;
22081 #endif
22084 * Display script name where an item was last set.
22085 * Should only be invoked when 'verbose' is non-zero.
22087 void
22088 last_set_msg(scriptID)
22089 scid_T scriptID;
22091 char_u *p;
22093 if (scriptID != 0)
22095 p = home_replace_save(NULL, get_scriptname(scriptID));
22096 if (p != NULL)
22098 verbose_enter();
22099 MSG_PUTS(_("\n\tLast set from "));
22100 MSG_PUTS(p);
22101 vim_free(p);
22102 verbose_leave();
22108 * List v:oldfiles in a nice way.
22110 /*ARGSUSED*/
22111 void
22112 ex_oldfiles(eap)
22113 exarg_T *eap;
22115 list_T *l = vimvars[VV_OLDFILES].vv_list;
22116 listitem_T *li;
22117 int nr = 0;
22119 if (l == NULL)
22120 msg((char_u *)_("No old files"));
22121 else
22123 msg_start();
22124 msg_scroll = TRUE;
22125 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22127 msg_outnum((long)++nr);
22128 MSG_PUTS(": ");
22129 msg_outtrans(get_tv_string(&li->li_tv));
22130 msg_putchar('\n');
22131 out_flush(); /* output one line at a time */
22132 ui_breakcheck();
22134 /* Assume "got_int" was set to truncate the listing. */
22135 got_int = FALSE;
22137 #ifdef FEAT_BROWSE_CMD
22138 if (cmdmod.browse)
22140 quit_more = FALSE;
22141 nr = prompt_for_number(FALSE);
22142 msg_starthere();
22143 if (nr > 0)
22145 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22146 (long)nr);
22148 if (p != NULL)
22150 p = expand_env_save(p);
22151 eap->arg = p;
22152 eap->cmdidx = CMD_edit;
22153 cmdmod.browse = FALSE;
22154 do_exedit(eap, NULL);
22155 vim_free(p);
22159 #endif
22163 #endif /* FEAT_EVAL */
22166 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22168 #ifdef WIN3264
22170 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22172 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22173 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22174 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22177 * Get the short path (8.3) for the filename in "fnamep".
22178 * Only works for a valid file name.
22179 * When the path gets longer "fnamep" is changed and the allocated buffer
22180 * is put in "bufp".
22181 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22182 * Returns OK on success, FAIL on failure.
22184 static int
22185 get_short_pathname(fnamep, bufp, fnamelen)
22186 char_u **fnamep;
22187 char_u **bufp;
22188 int *fnamelen;
22190 int l, len;
22191 char_u *newbuf;
22193 len = *fnamelen;
22194 l = GetShortPathName(*fnamep, *fnamep, len);
22195 if (l > len - 1)
22197 /* If that doesn't work (not enough space), then save the string
22198 * and try again with a new buffer big enough. */
22199 newbuf = vim_strnsave(*fnamep, l);
22200 if (newbuf == NULL)
22201 return FAIL;
22203 vim_free(*bufp);
22204 *fnamep = *bufp = newbuf;
22206 /* Really should always succeed, as the buffer is big enough. */
22207 l = GetShortPathName(*fnamep, *fnamep, l+1);
22210 *fnamelen = l;
22211 return OK;
22215 * Get the short path (8.3) for the filename in "fname". The converted
22216 * path is returned in "bufp".
22218 * Some of the directories specified in "fname" may not exist. This function
22219 * will shorten the existing directories at the beginning of the path and then
22220 * append the remaining non-existing path.
22222 * fname - Pointer to the filename to shorten. On return, contains the
22223 * pointer to the shortened pathname
22224 * bufp - Pointer to an allocated buffer for the filename.
22225 * fnamelen - Length of the filename pointed to by fname
22227 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22229 static int
22230 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22231 char_u **fname;
22232 char_u **bufp;
22233 int *fnamelen;
22235 char_u *short_fname, *save_fname, *pbuf_unused;
22236 char_u *endp, *save_endp;
22237 char_u ch;
22238 int old_len, len;
22239 int new_len, sfx_len;
22240 int retval = OK;
22242 /* Make a copy */
22243 old_len = *fnamelen;
22244 save_fname = vim_strnsave(*fname, old_len);
22245 pbuf_unused = NULL;
22246 short_fname = NULL;
22248 endp = save_fname + old_len - 1; /* Find the end of the copy */
22249 save_endp = endp;
22252 * Try shortening the supplied path till it succeeds by removing one
22253 * directory at a time from the tail of the path.
22255 len = 0;
22256 for (;;)
22258 /* go back one path-separator */
22259 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22260 --endp;
22261 if (endp <= save_fname)
22262 break; /* processed the complete path */
22265 * Replace the path separator with a NUL and try to shorten the
22266 * resulting path.
22268 ch = *endp;
22269 *endp = 0;
22270 short_fname = save_fname;
22271 len = (int)STRLEN(short_fname) + 1;
22272 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22274 retval = FAIL;
22275 goto theend;
22277 *endp = ch; /* preserve the string */
22279 if (len > 0)
22280 break; /* successfully shortened the path */
22282 /* failed to shorten the path. Skip the path separator */
22283 --endp;
22286 if (len > 0)
22289 * Succeeded in shortening the path. Now concatenate the shortened
22290 * path with the remaining path at the tail.
22293 /* Compute the length of the new path. */
22294 sfx_len = (int)(save_endp - endp) + 1;
22295 new_len = len + sfx_len;
22297 *fnamelen = new_len;
22298 vim_free(*bufp);
22299 if (new_len > old_len)
22301 /* There is not enough space in the currently allocated string,
22302 * copy it to a buffer big enough. */
22303 *fname = *bufp = vim_strnsave(short_fname, new_len);
22304 if (*fname == NULL)
22306 retval = FAIL;
22307 goto theend;
22310 else
22312 /* Transfer short_fname to the main buffer (it's big enough),
22313 * unless get_short_pathname() did its work in-place. */
22314 *fname = *bufp = save_fname;
22315 if (short_fname != save_fname)
22316 vim_strncpy(save_fname, short_fname, len);
22317 save_fname = NULL;
22320 /* concat the not-shortened part of the path */
22321 vim_strncpy(*fname + len, endp, sfx_len);
22322 (*fname)[new_len] = NUL;
22325 theend:
22326 vim_free(pbuf_unused);
22327 vim_free(save_fname);
22329 return retval;
22333 * Get a pathname for a partial path.
22334 * Returns OK for success, FAIL for failure.
22336 static int
22337 shortpath_for_partial(fnamep, bufp, fnamelen)
22338 char_u **fnamep;
22339 char_u **bufp;
22340 int *fnamelen;
22342 int sepcount, len, tflen;
22343 char_u *p;
22344 char_u *pbuf, *tfname;
22345 int hasTilde;
22347 /* Count up the path separators from the RHS.. so we know which part
22348 * of the path to return. */
22349 sepcount = 0;
22350 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22351 if (vim_ispathsep(*p))
22352 ++sepcount;
22354 /* Need full path first (use expand_env() to remove a "~/") */
22355 hasTilde = (**fnamep == '~');
22356 if (hasTilde)
22357 pbuf = tfname = expand_env_save(*fnamep);
22358 else
22359 pbuf = tfname = FullName_save(*fnamep, FALSE);
22361 len = tflen = (int)STRLEN(tfname);
22363 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22364 return FAIL;
22366 if (len == 0)
22368 /* Don't have a valid filename, so shorten the rest of the
22369 * path if we can. This CAN give us invalid 8.3 filenames, but
22370 * there's not a lot of point in guessing what it might be.
22372 len = tflen;
22373 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22374 return FAIL;
22377 /* Count the paths backward to find the beginning of the desired string. */
22378 for (p = tfname + len - 1; p >= tfname; --p)
22380 #ifdef FEAT_MBYTE
22381 if (has_mbyte)
22382 p -= mb_head_off(tfname, p);
22383 #endif
22384 if (vim_ispathsep(*p))
22386 if (sepcount == 0 || (hasTilde && sepcount == 1))
22387 break;
22388 else
22389 sepcount --;
22392 if (hasTilde)
22394 --p;
22395 if (p >= tfname)
22396 *p = '~';
22397 else
22398 return FAIL;
22400 else
22401 ++p;
22403 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22404 vim_free(*bufp);
22405 *fnamelen = (int)STRLEN(p);
22406 *bufp = pbuf;
22407 *fnamep = p;
22409 return OK;
22411 #endif /* WIN3264 */
22414 * Adjust a filename, according to a string of modifiers.
22415 * *fnamep must be NUL terminated when called. When returning, the length is
22416 * determined by *fnamelen.
22417 * Returns VALID_ flags or -1 for failure.
22418 * When there is an error, *fnamep is set to NULL.
22421 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22422 char_u *src; /* string with modifiers */
22423 int *usedlen; /* characters after src that are used */
22424 char_u **fnamep; /* file name so far */
22425 char_u **bufp; /* buffer for allocated file name or NULL */
22426 int *fnamelen; /* length of fnamep */
22428 int valid = 0;
22429 char_u *tail;
22430 char_u *s, *p, *pbuf;
22431 char_u dirname[MAXPATHL];
22432 int c;
22433 int has_fullname = 0;
22434 #ifdef WIN3264
22435 int has_shortname = 0;
22436 #endif
22438 repeat:
22439 /* ":p" - full path/file_name */
22440 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22442 has_fullname = 1;
22444 valid |= VALID_PATH;
22445 *usedlen += 2;
22447 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22448 if ((*fnamep)[0] == '~'
22449 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22450 && ((*fnamep)[1] == '/'
22451 # ifdef BACKSLASH_IN_FILENAME
22452 || (*fnamep)[1] == '\\'
22453 # endif
22454 || (*fnamep)[1] == NUL)
22456 #endif
22459 *fnamep = expand_env_save(*fnamep);
22460 vim_free(*bufp); /* free any allocated file name */
22461 *bufp = *fnamep;
22462 if (*fnamep == NULL)
22463 return -1;
22466 /* When "/." or "/.." is used: force expansion to get rid of it. */
22467 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22469 if (vim_ispathsep(*p)
22470 && p[1] == '.'
22471 && (p[2] == NUL
22472 || vim_ispathsep(p[2])
22473 || (p[2] == '.'
22474 && (p[3] == NUL || vim_ispathsep(p[3])))))
22475 break;
22478 /* FullName_save() is slow, don't use it when not needed. */
22479 if (*p != NUL || !vim_isAbsName(*fnamep))
22481 *fnamep = FullName_save(*fnamep, *p != NUL);
22482 vim_free(*bufp); /* free any allocated file name */
22483 *bufp = *fnamep;
22484 if (*fnamep == NULL)
22485 return -1;
22488 /* Append a path separator to a directory. */
22489 if (mch_isdir(*fnamep))
22491 /* Make room for one or two extra characters. */
22492 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22493 vim_free(*bufp); /* free any allocated file name */
22494 *bufp = *fnamep;
22495 if (*fnamep == NULL)
22496 return -1;
22497 add_pathsep(*fnamep);
22501 /* ":." - path relative to the current directory */
22502 /* ":~" - path relative to the home directory */
22503 /* ":8" - shortname path - postponed till after */
22504 while (src[*usedlen] == ':'
22505 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22507 *usedlen += 2;
22508 if (c == '8')
22510 #ifdef WIN3264
22511 has_shortname = 1; /* Postpone this. */
22512 #endif
22513 continue;
22515 pbuf = NULL;
22516 /* Need full path first (use expand_env() to remove a "~/") */
22517 if (!has_fullname)
22519 if (c == '.' && **fnamep == '~')
22520 p = pbuf = expand_env_save(*fnamep);
22521 else
22522 p = pbuf = FullName_save(*fnamep, FALSE);
22524 else
22525 p = *fnamep;
22527 has_fullname = 0;
22529 if (p != NULL)
22531 if (c == '.')
22533 mch_dirname(dirname, MAXPATHL);
22534 s = shorten_fname(p, dirname);
22535 if (s != NULL)
22537 *fnamep = s;
22538 if (pbuf != NULL)
22540 vim_free(*bufp); /* free any allocated file name */
22541 *bufp = pbuf;
22542 pbuf = NULL;
22546 else
22548 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22549 /* Only replace it when it starts with '~' */
22550 if (*dirname == '~')
22552 s = vim_strsave(dirname);
22553 if (s != NULL)
22555 *fnamep = s;
22556 vim_free(*bufp);
22557 *bufp = s;
22561 vim_free(pbuf);
22565 tail = gettail(*fnamep);
22566 *fnamelen = (int)STRLEN(*fnamep);
22568 /* ":h" - head, remove "/file_name", can be repeated */
22569 /* Don't remove the first "/" or "c:\" */
22570 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22572 valid |= VALID_HEAD;
22573 *usedlen += 2;
22574 s = get_past_head(*fnamep);
22575 while (tail > s && after_pathsep(s, tail))
22576 mb_ptr_back(*fnamep, tail);
22577 *fnamelen = (int)(tail - *fnamep);
22578 #ifdef VMS
22579 if (*fnamelen > 0)
22580 *fnamelen += 1; /* the path separator is part of the path */
22581 #endif
22582 if (*fnamelen == 0)
22584 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22585 p = vim_strsave((char_u *)".");
22586 if (p == NULL)
22587 return -1;
22588 vim_free(*bufp);
22589 *bufp = *fnamep = tail = p;
22590 *fnamelen = 1;
22592 else
22594 while (tail > s && !after_pathsep(s, tail))
22595 mb_ptr_back(*fnamep, tail);
22599 /* ":8" - shortname */
22600 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22602 *usedlen += 2;
22603 #ifdef WIN3264
22604 has_shortname = 1;
22605 #endif
22608 #ifdef WIN3264
22609 /* Check shortname after we have done 'heads' and before we do 'tails'
22611 if (has_shortname)
22613 pbuf = NULL;
22614 /* Copy the string if it is shortened by :h */
22615 if (*fnamelen < (int)STRLEN(*fnamep))
22617 p = vim_strnsave(*fnamep, *fnamelen);
22618 if (p == 0)
22619 return -1;
22620 vim_free(*bufp);
22621 *bufp = *fnamep = p;
22624 /* Split into two implementations - makes it easier. First is where
22625 * there isn't a full name already, second is where there is.
22627 if (!has_fullname && !vim_isAbsName(*fnamep))
22629 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22630 return -1;
22632 else
22634 int l;
22636 /* Simple case, already have the full-name
22637 * Nearly always shorter, so try first time. */
22638 l = *fnamelen;
22639 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22640 return -1;
22642 if (l == 0)
22644 /* Couldn't find the filename.. search the paths.
22646 l = *fnamelen;
22647 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22648 return -1;
22650 *fnamelen = l;
22653 #endif /* WIN3264 */
22655 /* ":t" - tail, just the basename */
22656 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22658 *usedlen += 2;
22659 *fnamelen -= (int)(tail - *fnamep);
22660 *fnamep = tail;
22663 /* ":e" - extension, can be repeated */
22664 /* ":r" - root, without extension, can be repeated */
22665 while (src[*usedlen] == ':'
22666 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22668 /* find a '.' in the tail:
22669 * - for second :e: before the current fname
22670 * - otherwise: The last '.'
22672 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22673 s = *fnamep - 2;
22674 else
22675 s = *fnamep + *fnamelen - 1;
22676 for ( ; s > tail; --s)
22677 if (s[0] == '.')
22678 break;
22679 if (src[*usedlen + 1] == 'e') /* :e */
22681 if (s > tail)
22683 *fnamelen += (int)(*fnamep - (s + 1));
22684 *fnamep = s + 1;
22685 #ifdef VMS
22686 /* cut version from the extension */
22687 s = *fnamep + *fnamelen - 1;
22688 for ( ; s > *fnamep; --s)
22689 if (s[0] == ';')
22690 break;
22691 if (s > *fnamep)
22692 *fnamelen = s - *fnamep;
22693 #endif
22695 else if (*fnamep <= tail)
22696 *fnamelen = 0;
22698 else /* :r */
22700 if (s > tail) /* remove one extension */
22701 *fnamelen = (int)(s - *fnamep);
22703 *usedlen += 2;
22706 /* ":s?pat?foo?" - substitute */
22707 /* ":gs?pat?foo?" - global substitute */
22708 if (src[*usedlen] == ':'
22709 && (src[*usedlen + 1] == 's'
22710 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22712 char_u *str;
22713 char_u *pat;
22714 char_u *sub;
22715 int sep;
22716 char_u *flags;
22717 int didit = FALSE;
22719 flags = (char_u *)"";
22720 s = src + *usedlen + 2;
22721 if (src[*usedlen + 1] == 'g')
22723 flags = (char_u *)"g";
22724 ++s;
22727 sep = *s++;
22728 if (sep)
22730 /* find end of pattern */
22731 p = vim_strchr(s, sep);
22732 if (p != NULL)
22734 pat = vim_strnsave(s, (int)(p - s));
22735 if (pat != NULL)
22737 s = p + 1;
22738 /* find end of substitution */
22739 p = vim_strchr(s, sep);
22740 if (p != NULL)
22742 sub = vim_strnsave(s, (int)(p - s));
22743 str = vim_strnsave(*fnamep, *fnamelen);
22744 if (sub != NULL && str != NULL)
22746 *usedlen = (int)(p + 1 - src);
22747 s = do_string_sub(str, pat, sub, flags);
22748 if (s != NULL)
22750 *fnamep = s;
22751 *fnamelen = (int)STRLEN(s);
22752 vim_free(*bufp);
22753 *bufp = s;
22754 didit = TRUE;
22757 vim_free(sub);
22758 vim_free(str);
22760 vim_free(pat);
22763 /* after using ":s", repeat all the modifiers */
22764 if (didit)
22765 goto repeat;
22769 return valid;
22773 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22774 * "flags" can be "g" to do a global substitute.
22775 * Returns an allocated string, NULL for error.
22777 char_u *
22778 do_string_sub(str, pat, sub, flags)
22779 char_u *str;
22780 char_u *pat;
22781 char_u *sub;
22782 char_u *flags;
22784 int sublen;
22785 regmatch_T regmatch;
22786 int i;
22787 int do_all;
22788 char_u *tail;
22789 garray_T ga;
22790 char_u *ret;
22791 char_u *save_cpo;
22793 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22794 save_cpo = p_cpo;
22795 p_cpo = empty_option;
22797 ga_init2(&ga, 1, 200);
22799 do_all = (flags[0] == 'g');
22801 regmatch.rm_ic = p_ic;
22802 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22803 if (regmatch.regprog != NULL)
22805 tail = str;
22806 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22809 * Get some space for a temporary buffer to do the substitution
22810 * into. It will contain:
22811 * - The text up to where the match is.
22812 * - The substituted text.
22813 * - The text after the match.
22815 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22816 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22817 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22819 ga_clear(&ga);
22820 break;
22823 /* copy the text up to where the match is */
22824 i = (int)(regmatch.startp[0] - tail);
22825 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22826 /* add the substituted text */
22827 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22828 + ga.ga_len + i, TRUE, TRUE, FALSE);
22829 ga.ga_len += i + sublen - 1;
22830 /* avoid getting stuck on a match with an empty string */
22831 if (tail == regmatch.endp[0])
22833 if (*tail == NUL)
22834 break;
22835 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22836 ++ga.ga_len;
22838 else
22840 tail = regmatch.endp[0];
22841 if (*tail == NUL)
22842 break;
22844 if (!do_all)
22845 break;
22848 if (ga.ga_data != NULL)
22849 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22851 vim_free(regmatch.regprog);
22854 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22855 ga_clear(&ga);
22856 if (p_cpo == empty_option)
22857 p_cpo = save_cpo;
22858 else
22859 /* Darn, evaluating {sub} expression changed the value. */
22860 free_string_option(save_cpo);
22862 return ret;
22865 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */