1114c95f7edb28f8784d73c0c83861cb8ded99aa
[vim_extended.git] / src / eval.c
blob1114c95f7edb28f8784d73c0c83861cb8ded99aa
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.
132 * The last bit is used for previous_funccal, ignored when comparing.
134 static int current_copyID = 0;
135 #define COPYID_INC 2
136 #define COPYID_MASK (~0x1)
139 * Array to hold the hashtab with variables local to each sourced script.
140 * Each item holds a variable (nameless) that points to the dict_T.
142 typedef struct
144 dictitem_T sv_var;
145 dict_T sv_dict;
146 } scriptvar_T;
148 static garray_T ga_scripts = {0, 0, sizeof(scriptvar_T *), 4, NULL};
149 #define SCRIPT_SV(id) (((scriptvar_T **)ga_scripts.ga_data)[(id) - 1])
150 #define SCRIPT_VARS(id) (SCRIPT_SV(id)->sv_dict.dv_hashtab)
152 static int echo_attr = 0; /* attributes used for ":echo" */
154 /* Values for trans_function_name() argument: */
155 #define TFN_INT 1 /* internal function name OK */
156 #define TFN_QUIET 2 /* no error messages */
159 * Structure to hold info for a user function.
161 typedef struct ufunc ufunc_T;
163 struct ufunc
165 int uf_varargs; /* variable nr of arguments */
166 int uf_flags;
167 int uf_calls; /* nr of active calls */
168 garray_T uf_args; /* arguments */
169 garray_T uf_lines; /* function lines */
170 #ifdef FEAT_PROFILE
171 int uf_profiling; /* TRUE when func is being profiled */
172 /* profiling the function as a whole */
173 int uf_tm_count; /* nr of calls */
174 proftime_T uf_tm_total; /* time spent in function + children */
175 proftime_T uf_tm_self; /* time spent in function itself */
176 proftime_T uf_tm_children; /* time spent in children this call */
177 /* profiling the function per line */
178 int *uf_tml_count; /* nr of times line was executed */
179 proftime_T *uf_tml_total; /* time spent in a line + children */
180 proftime_T *uf_tml_self; /* time spent in a line itself */
181 proftime_T uf_tml_start; /* start time for current line */
182 proftime_T uf_tml_children; /* time spent in children for this line */
183 proftime_T uf_tml_wait; /* start wait time for current line */
184 int uf_tml_idx; /* index of line being timed; -1 if none */
185 int uf_tml_execed; /* line being timed was executed */
186 #endif
187 scid_T uf_script_ID; /* ID of script where function was defined,
188 used for s: variables */
189 int uf_refcount; /* for numbered function: reference count */
190 char_u uf_name[1]; /* name of function (actually longer); can
191 start with <SNR>123_ (<SNR> is K_SPECIAL
192 KS_EXTRA KE_SNR) */
195 /* function flags */
196 #define FC_ABORT 1 /* abort function on error */
197 #define FC_RANGE 2 /* function accepts range */
198 #define FC_DICT 4 /* Dict function, uses "self" */
201 * All user-defined functions are found in this hashtable.
203 static hashtab_T func_hashtab;
205 /* The names of packages that once were loaded are remembered. */
206 static garray_T ga_loaded = {0, 0, sizeof(char_u *), 4, NULL};
208 /* list heads for garbage collection */
209 static dict_T *first_dict = NULL; /* list of all dicts */
210 static list_T *first_list = NULL; /* list of all lists */
212 /* From user function to hashitem and back. */
213 static ufunc_T dumuf;
214 #define UF2HIKEY(fp) ((fp)->uf_name)
215 #define HIKEY2UF(p) ((ufunc_T *)(p - (dumuf.uf_name - (char_u *)&dumuf)))
216 #define HI2UF(hi) HIKEY2UF((hi)->hi_key)
218 #define FUNCARG(fp, j) ((char_u **)(fp->uf_args.ga_data))[j]
219 #define FUNCLINE(fp, j) ((char_u **)(fp->uf_lines.ga_data))[j]
221 #define MAX_FUNC_ARGS 20 /* maximum number of function arguments */
222 #define VAR_SHORT_LEN 20 /* short variable name length */
223 #define FIXVAR_CNT 12 /* number of fixed variables */
225 /* structure to hold info for a function that is currently being executed. */
226 typedef struct funccall_S funccall_T;
228 struct funccall_S
230 ufunc_T *func; /* function being called */
231 int linenr; /* next line to be executed */
232 int returned; /* ":return" used */
233 struct /* fixed variables for arguments */
235 dictitem_T var; /* variable (without room for name) */
236 char_u room[VAR_SHORT_LEN]; /* room for the name */
237 } fixvar[FIXVAR_CNT];
238 dict_T l_vars; /* l: local function variables */
239 dictitem_T l_vars_var; /* variable for l: scope */
240 dict_T l_avars; /* a: argument variables */
241 dictitem_T l_avars_var; /* variable for a: scope */
242 list_T l_varlist; /* list for a:000 */
243 listitem_T l_listitems[MAX_FUNC_ARGS]; /* listitems for a:000 */
244 typval_T *rettv; /* return value */
245 linenr_T breakpoint; /* next line with breakpoint or zero */
246 int dbg_tick; /* debug_tick when breakpoint was set */
247 int level; /* top nesting level of executed function */
248 #ifdef FEAT_PROFILE
249 proftime_T prof_child; /* time spent in a child */
250 #endif
251 funccall_T *caller; /* calling function or NULL */
255 * Info used by a ":for" loop.
257 typedef struct
259 int fi_semicolon; /* TRUE if ending in '; var]' */
260 int fi_varcount; /* nr of variables in the list */
261 listwatch_T fi_lw; /* keep an eye on the item used. */
262 list_T *fi_list; /* list being used */
263 } forinfo_T;
266 * Struct used by trans_function_name()
268 typedef struct
270 dict_T *fd_dict; /* Dictionary used */
271 char_u *fd_newkey; /* new key in "dict" in allocated memory */
272 dictitem_T *fd_di; /* Dictionary item used */
273 } funcdict_T;
277 * Array to hold the value of v: variables.
278 * The value is in a dictitem, so that it can also be used in the v: scope.
279 * The reason to use this table anyway is for very quick access to the
280 * variables with the VV_ defines.
282 #include "version.h"
284 /* values for vv_flags: */
285 #define VV_COMPAT 1 /* compatible, also used without "v:" */
286 #define VV_RO 2 /* read-only */
287 #define VV_RO_SBX 4 /* read-only in the sandbox */
289 #define VV_NAME(s, t) s, {{t, 0, {0}}, 0, {0}}, {0}
291 static struct vimvar
293 char *vv_name; /* name of variable, without v: */
294 dictitem_T vv_di; /* value and name for key */
295 char vv_filler[16]; /* space for LONGEST name below!!! */
296 char vv_flags; /* VV_COMPAT, VV_RO, VV_RO_SBX */
297 } vimvars[VV_LEN] =
300 * The order here must match the VV_ defines in vim.h!
301 * Initializing a union does not work, leave tv.vval empty to get zero's.
303 {VV_NAME("count", VAR_NUMBER), VV_COMPAT+VV_RO},
304 {VV_NAME("count1", VAR_NUMBER), VV_RO},
305 {VV_NAME("prevcount", VAR_NUMBER), VV_RO},
306 {VV_NAME("errmsg", VAR_STRING), VV_COMPAT},
307 {VV_NAME("warningmsg", VAR_STRING), 0},
308 {VV_NAME("statusmsg", VAR_STRING), 0},
309 {VV_NAME("shell_error", VAR_NUMBER), VV_COMPAT+VV_RO},
310 {VV_NAME("this_session", VAR_STRING), VV_COMPAT},
311 {VV_NAME("version", VAR_NUMBER), VV_COMPAT+VV_RO},
312 {VV_NAME("lnum", VAR_NUMBER), VV_RO_SBX},
313 {VV_NAME("termresponse", VAR_STRING), VV_RO},
314 {VV_NAME("fname", VAR_STRING), VV_RO},
315 {VV_NAME("lang", VAR_STRING), VV_RO},
316 {VV_NAME("lc_time", VAR_STRING), VV_RO},
317 {VV_NAME("ctype", VAR_STRING), VV_RO},
318 {VV_NAME("charconvert_from", VAR_STRING), VV_RO},
319 {VV_NAME("charconvert_to", VAR_STRING), VV_RO},
320 {VV_NAME("fname_in", VAR_STRING), VV_RO},
321 {VV_NAME("fname_out", VAR_STRING), VV_RO},
322 {VV_NAME("fname_new", VAR_STRING), VV_RO},
323 {VV_NAME("fname_diff", VAR_STRING), VV_RO},
324 {VV_NAME("cmdarg", VAR_STRING), VV_RO},
325 {VV_NAME("foldstart", VAR_NUMBER), VV_RO_SBX},
326 {VV_NAME("foldend", VAR_NUMBER), VV_RO_SBX},
327 {VV_NAME("folddashes", VAR_STRING), VV_RO_SBX},
328 {VV_NAME("foldlevel", VAR_NUMBER), VV_RO_SBX},
329 {VV_NAME("progname", VAR_STRING), VV_RO},
330 {VV_NAME("servername", VAR_STRING), VV_RO},
331 {VV_NAME("dying", VAR_NUMBER), VV_RO},
332 {VV_NAME("exception", VAR_STRING), VV_RO},
333 {VV_NAME("throwpoint", VAR_STRING), VV_RO},
334 {VV_NAME("register", VAR_STRING), VV_RO},
335 {VV_NAME("cmdbang", VAR_NUMBER), VV_RO},
336 {VV_NAME("insertmode", VAR_STRING), VV_RO},
337 {VV_NAME("val", VAR_UNKNOWN), VV_RO},
338 {VV_NAME("key", VAR_UNKNOWN), VV_RO},
339 {VV_NAME("profiling", VAR_NUMBER), VV_RO},
340 {VV_NAME("fcs_reason", VAR_STRING), VV_RO},
341 {VV_NAME("fcs_choice", VAR_STRING), 0},
342 {VV_NAME("beval_bufnr", VAR_NUMBER), VV_RO},
343 {VV_NAME("beval_winnr", VAR_NUMBER), VV_RO},
344 {VV_NAME("beval_lnum", VAR_NUMBER), VV_RO},
345 {VV_NAME("beval_col", VAR_NUMBER), VV_RO},
346 {VV_NAME("beval_text", VAR_STRING), VV_RO},
347 {VV_NAME("scrollstart", VAR_STRING), 0},
348 {VV_NAME("swapname", VAR_STRING), VV_RO},
349 {VV_NAME("swapchoice", VAR_STRING), 0},
350 {VV_NAME("swapcommand", VAR_STRING), VV_RO},
351 {VV_NAME("char", VAR_STRING), VV_RO},
352 {VV_NAME("mouse_win", VAR_NUMBER), 0},
353 {VV_NAME("mouse_lnum", VAR_NUMBER), 0},
354 {VV_NAME("mouse_col", VAR_NUMBER), 0},
355 {VV_NAME("operator", VAR_STRING), VV_RO},
356 {VV_NAME("searchforward", VAR_NUMBER), 0},
357 {VV_NAME("oldfiles", VAR_LIST), 0},
360 /* shorthand */
361 #define vv_type vv_di.di_tv.v_type
362 #define vv_nr vv_di.di_tv.vval.v_number
363 #define vv_float vv_di.di_tv.vval.v_float
364 #define vv_str vv_di.di_tv.vval.v_string
365 #define vv_list vv_di.di_tv.vval.v_list
366 #define vv_tv vv_di.di_tv
369 * The v: variables are stored in dictionary "vimvardict".
370 * "vimvars_var" is the variable that is used for the "l:" scope.
372 static dict_T vimvardict;
373 static dictitem_T vimvars_var;
374 #define vimvarht vimvardict.dv_hashtab
376 static void prepare_vimvar __ARGS((int idx, typval_T *save_tv));
377 static void restore_vimvar __ARGS((int idx, typval_T *save_tv));
378 #if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
379 static int call_vim_function __ARGS((char_u *func, int argc, char_u **argv, int safe, typval_T *rettv));
380 #endif
381 static int ex_let_vars __ARGS((char_u *arg, typval_T *tv, int copy, int semicolon, int var_count, char_u *nextchars));
382 static char_u *skip_var_list __ARGS((char_u *arg, int *var_count, int *semicolon));
383 static char_u *skip_var_one __ARGS((char_u *arg));
384 static void list_hashtable_vars __ARGS((hashtab_T *ht, char_u *prefix, int empty, int *first));
385 static void list_glob_vars __ARGS((int *first));
386 static void list_buf_vars __ARGS((int *first));
387 static void list_win_vars __ARGS((int *first));
388 #ifdef FEAT_WINDOWS
389 static void list_tab_vars __ARGS((int *first));
390 #endif
391 static void list_vim_vars __ARGS((int *first));
392 static void list_script_vars __ARGS((int *first));
393 static void list_func_vars __ARGS((int *first));
394 static char_u *list_arg_vars __ARGS((exarg_T *eap, char_u *arg, int *first));
395 static char_u *ex_let_one __ARGS((char_u *arg, typval_T *tv, int copy, char_u *endchars, char_u *op));
396 static int check_changedtick __ARGS((char_u *arg));
397 static char_u *get_lval __ARGS((char_u *name, typval_T *rettv, lval_T *lp, int unlet, int skip, int quiet, int fne_flags));
398 static void clear_lval __ARGS((lval_T *lp));
399 static void set_var_lval __ARGS((lval_T *lp, char_u *endp, typval_T *rettv, int copy, char_u *op));
400 static int tv_op __ARGS((typval_T *tv1, typval_T *tv2, char_u *op));
401 static void list_add_watch __ARGS((list_T *l, listwatch_T *lw));
402 static void list_rem_watch __ARGS((list_T *l, listwatch_T *lwrem));
403 static void list_fix_watch __ARGS((list_T *l, listitem_T *item));
404 static void ex_unletlock __ARGS((exarg_T *eap, char_u *argstart, int deep));
405 static int do_unlet_var __ARGS((lval_T *lp, char_u *name_end, int forceit));
406 static int do_lock_var __ARGS((lval_T *lp, char_u *name_end, int deep, int lock));
407 static void item_lock __ARGS((typval_T *tv, int deep, int lock));
408 static int tv_islocked __ARGS((typval_T *tv));
410 static int eval0 __ARGS((char_u *arg, typval_T *rettv, char_u **nextcmd, int evaluate));
411 static int eval1 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
412 static int eval2 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
413 static int eval3 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
414 static int eval4 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
415 static int eval5 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
416 static int eval6 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
417 static int eval7 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
419 static int eval_index __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
420 static int get_option_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
421 static int get_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
422 static int get_lit_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
423 static int get_list_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
424 static int rettv_list_alloc __ARGS((typval_T *rettv));
425 static listitem_T *listitem_alloc __ARGS((void));
426 static void listitem_free __ARGS((listitem_T *item));
427 static void listitem_remove __ARGS((list_T *l, listitem_T *item));
428 static long list_len __ARGS((list_T *l));
429 static int list_equal __ARGS((list_T *l1, list_T *l2, int ic));
430 static int dict_equal __ARGS((dict_T *d1, dict_T *d2, int ic));
431 static int tv_equal __ARGS((typval_T *tv1, typval_T *tv2, int ic));
432 static listitem_T *list_find __ARGS((list_T *l, long n));
433 static long list_find_nr __ARGS((list_T *l, long idx, int *errorp));
434 static long list_idx_of_item __ARGS((list_T *l, listitem_T *item));
435 static void list_append __ARGS((list_T *l, listitem_T *item));
436 static int list_append_number __ARGS((list_T *l, varnumber_T n));
437 static int list_insert_tv __ARGS((list_T *l, typval_T *tv, listitem_T *item));
438 static int list_extend __ARGS((list_T *l1, list_T *l2, listitem_T *bef));
439 static int list_concat __ARGS((list_T *l1, list_T *l2, typval_T *tv));
440 static list_T *list_copy __ARGS((list_T *orig, int deep, int copyID));
441 static void list_remove __ARGS((list_T *l, listitem_T *item, listitem_T *item2));
442 static char_u *list2string __ARGS((typval_T *tv, int copyID));
443 static int list_join __ARGS((garray_T *gap, list_T *l, char_u *sep, int echo, int copyID));
444 static int free_unref_items __ARGS((int copyID));
445 static void set_ref_in_ht __ARGS((hashtab_T *ht, int copyID));
446 static void set_ref_in_list __ARGS((list_T *l, int copyID));
447 static void set_ref_in_item __ARGS((typval_T *tv, int copyID));
448 static void dict_unref __ARGS((dict_T *d));
449 static void dict_free __ARGS((dict_T *d, int recurse));
450 static dictitem_T *dictitem_copy __ARGS((dictitem_T *org));
451 static void dictitem_remove __ARGS((dict_T *dict, dictitem_T *item));
452 static dict_T *dict_copy __ARGS((dict_T *orig, int deep, int copyID));
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 *func_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 #ifdef FEAT_MZSCHEME
628 static void f_mzeval __ARGS((typval_T *argvars, typval_T *rettv));
629 #endif
630 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
631 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
632 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
633 #ifdef FEAT_FLOAT
634 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
635 #endif
636 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
637 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
642 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
643 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
644 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
645 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
646 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
647 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
648 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
649 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
650 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
651 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
652 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
653 #ifdef FEAT_FLOAT
654 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
655 #endif
656 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
657 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
668 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
669 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
670 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
671 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
672 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
673 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
674 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
675 #ifdef FEAT_FLOAT
676 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
677 #endif
678 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
679 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
680 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
681 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
682 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
683 #ifdef FEAT_FLOAT
684 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
685 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
686 #endif
687 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
688 #ifdef HAVE_STRFTIME
689 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
690 #endif
691 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
692 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
693 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
699 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
700 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
707 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
708 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
709 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
710 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
711 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
712 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
713 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
714 #ifdef FEAT_FLOAT
715 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
716 #endif
717 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
718 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
724 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
725 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
726 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
727 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
728 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
729 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
730 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
732 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
733 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
734 static int get_env_len __ARGS((char_u **arg));
735 static int get_id_len __ARGS((char_u **arg));
736 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
737 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
738 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
739 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
740 valid character */
741 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
742 static int eval_isnamec __ARGS((int c));
743 static int eval_isnamec1 __ARGS((int c));
744 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
745 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
746 static typval_T *alloc_tv __ARGS((void));
747 static typval_T *alloc_string_tv __ARGS((char_u *string));
748 static void init_tv __ARGS((typval_T *varp));
749 static long get_tv_number __ARGS((typval_T *varp));
750 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
751 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
752 static char_u *get_tv_string __ARGS((typval_T *varp));
753 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
754 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
755 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
756 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
757 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
758 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
759 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
760 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
761 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
762 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
763 static int var_check_ro __ARGS((int flags, char_u *name));
764 static int var_check_fixed __ARGS((int flags, char_u *name));
765 static int tv_check_lock __ARGS((int lock, char_u *name));
766 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
767 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
768 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
769 static int eval_fname_script __ARGS((char_u *p));
770 static int eval_fname_sid __ARGS((char_u *p));
771 static void list_func_head __ARGS((ufunc_T *fp, int indent));
772 static ufunc_T *find_func __ARGS((char_u *name));
773 static int function_exists __ARGS((char_u *name));
774 static int builtin_function __ARGS((char_u *name));
775 #ifdef FEAT_PROFILE
776 static void func_do_profile __ARGS((ufunc_T *fp));
777 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
778 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
779 static int
780 # ifdef __BORLANDC__
781 _RTLENTRYF
782 # endif
783 prof_total_cmp __ARGS((const void *s1, const void *s2));
784 static int
785 # ifdef __BORLANDC__
786 _RTLENTRYF
787 # endif
788 prof_self_cmp __ARGS((const void *s1, const void *s2));
789 #endif
790 static int script_autoload __ARGS((char_u *name, int reload));
791 static char_u *autoload_name __ARGS((char_u *name));
792 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
793 static void func_free __ARGS((ufunc_T *fp));
794 static void func_unref __ARGS((char_u *name));
795 static void func_ref __ARGS((char_u *name));
796 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));
797 static int can_free_funccal __ARGS((funccall_T *fc, int copyID)) ;
798 static void free_funccal __ARGS((funccall_T *fc, int free_val));
799 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
800 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
801 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
802 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
803 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
804 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
806 /* Character used as separated in autoload function/variable names. */
807 #define AUTOLOAD_CHAR '#'
810 * Initialize the global and v: variables.
812 void
813 eval_init()
815 int i;
816 struct vimvar *p;
818 init_var_dict(&globvardict, &globvars_var);
819 init_var_dict(&vimvardict, &vimvars_var);
820 hash_init(&compat_hashtab);
821 hash_init(&func_hashtab);
823 for (i = 0; i < VV_LEN; ++i)
825 p = &vimvars[i];
826 STRCPY(p->vv_di.di_key, p->vv_name);
827 if (p->vv_flags & VV_RO)
828 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
829 else if (p->vv_flags & VV_RO_SBX)
830 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
831 else
832 p->vv_di.di_flags = DI_FLAGS_FIX;
834 /* add to v: scope dict, unless the value is not always available */
835 if (p->vv_type != VAR_UNKNOWN)
836 hash_add(&vimvarht, p->vv_di.di_key);
837 if (p->vv_flags & VV_COMPAT)
838 /* add to compat scope dict */
839 hash_add(&compat_hashtab, p->vv_di.di_key);
841 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
844 #if defined(EXITFREE) || defined(PROTO)
845 void
846 eval_clear()
848 int i;
849 struct vimvar *p;
851 for (i = 0; i < VV_LEN; ++i)
853 p = &vimvars[i];
854 if (p->vv_di.di_tv.v_type == VAR_STRING)
856 vim_free(p->vv_str);
857 p->vv_str = NULL;
859 else if (p->vv_di.di_tv.v_type == VAR_LIST)
861 list_unref(p->vv_list);
862 p->vv_list = NULL;
865 hash_clear(&vimvarht);
866 hash_init(&vimvarht); /* garbage_collect() will access it */
867 hash_clear(&compat_hashtab);
869 free_scriptnames();
871 /* global variables */
872 vars_clear(&globvarht);
874 /* autoloaded script names */
875 ga_clear_strings(&ga_loaded);
877 /* script-local variables */
878 for (i = 1; i <= ga_scripts.ga_len; ++i)
880 vars_clear(&SCRIPT_VARS(i));
881 vim_free(SCRIPT_SV(i));
883 ga_clear(&ga_scripts);
885 /* unreferenced lists and dicts */
886 (void)garbage_collect();
888 /* functions */
889 free_all_functions();
890 hash_clear(&func_hashtab);
892 #endif
895 * Return the name of the executed function.
897 char_u *
898 func_name(cookie)
899 void *cookie;
901 return ((funccall_T *)cookie)->func->uf_name;
905 * Return the address holding the next breakpoint line for a funccall cookie.
907 linenr_T *
908 func_breakpoint(cookie)
909 void *cookie;
911 return &((funccall_T *)cookie)->breakpoint;
915 * Return the address holding the debug tick for a funccall cookie.
917 int *
918 func_dbg_tick(cookie)
919 void *cookie;
921 return &((funccall_T *)cookie)->dbg_tick;
925 * Return the nesting level for a funccall cookie.
928 func_level(cookie)
929 void *cookie;
931 return ((funccall_T *)cookie)->level;
934 /* pointer to funccal for currently active function */
935 funccall_T *current_funccal = NULL;
937 /* pointer to list of previously used funccal, still around because some
938 * item in it is still being used. */
939 funccall_T *previous_funccal = NULL;
942 * Return TRUE when a function was ended by a ":return" command.
945 current_func_returned()
947 return current_funccal->returned;
952 * Set an internal variable to a string value. Creates the variable if it does
953 * not already exist.
955 void
956 set_internal_string_var(name, value)
957 char_u *name;
958 char_u *value;
960 char_u *val;
961 typval_T *tvp;
963 val = vim_strsave(value);
964 if (val != NULL)
966 tvp = alloc_string_tv(val);
967 if (tvp != NULL)
969 set_var(name, tvp, FALSE);
970 free_tv(tvp);
975 static lval_T *redir_lval = NULL;
976 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
977 static char_u *redir_endp = NULL;
978 static char_u *redir_varname = NULL;
981 * Start recording command output to a variable
982 * Returns OK if successfully completed the setup. FAIL otherwise.
985 var_redir_start(name, append)
986 char_u *name;
987 int append; /* append to an existing variable */
989 int save_emsg;
990 int err;
991 typval_T tv;
993 /* Catch a bad name early. */
994 if (!eval_isnamec1(*name))
996 EMSG(_(e_invarg));
997 return FAIL;
1000 /* Make a copy of the name, it is used in redir_lval until redir ends. */
1001 redir_varname = vim_strsave(name);
1002 if (redir_varname == NULL)
1003 return FAIL;
1005 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
1006 if (redir_lval == NULL)
1008 var_redir_stop();
1009 return FAIL;
1012 /* The output is stored in growarray "redir_ga" until redirection ends. */
1013 ga_init2(&redir_ga, (int)sizeof(char), 500);
1015 /* Parse the variable name (can be a dict or list entry). */
1016 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1017 FNE_CHECK_START);
1018 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1020 if (redir_endp != NULL && *redir_endp != NUL)
1021 /* Trailing characters are present after the variable name */
1022 EMSG(_(e_trailing));
1023 else
1024 EMSG(_(e_invarg));
1025 redir_endp = NULL; /* don't store a value, only cleanup */
1026 var_redir_stop();
1027 return FAIL;
1030 /* check if we can write to the variable: set it to or append an empty
1031 * string */
1032 save_emsg = did_emsg;
1033 did_emsg = FALSE;
1034 tv.v_type = VAR_STRING;
1035 tv.vval.v_string = (char_u *)"";
1036 if (append)
1037 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1038 else
1039 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1040 err = did_emsg;
1041 did_emsg |= save_emsg;
1042 if (err)
1044 redir_endp = NULL; /* don't store a value, only cleanup */
1045 var_redir_stop();
1046 return FAIL;
1048 if (redir_lval->ll_newkey != NULL)
1050 /* Dictionary item was created, don't do it again. */
1051 vim_free(redir_lval->ll_newkey);
1052 redir_lval->ll_newkey = NULL;
1055 return OK;
1059 * Append "value[value_len]" to the variable set by var_redir_start().
1060 * The actual appending is postponed until redirection ends, because the value
1061 * appended may in fact be the string we write to, changing it may cause freed
1062 * memory to be used:
1063 * :redir => foo
1064 * :let foo
1065 * :redir END
1067 void
1068 var_redir_str(value, value_len)
1069 char_u *value;
1070 int value_len;
1072 int len;
1074 if (redir_lval == NULL)
1075 return;
1077 if (value_len == -1)
1078 len = (int)STRLEN(value); /* Append the entire string */
1079 else
1080 len = value_len; /* Append only "value_len" characters */
1082 if (ga_grow(&redir_ga, len) == OK)
1084 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1085 redir_ga.ga_len += len;
1087 else
1088 var_redir_stop();
1092 * Stop redirecting command output to a variable.
1093 * Frees the allocated memory.
1095 void
1096 var_redir_stop()
1098 typval_T tv;
1100 if (redir_lval != NULL)
1102 /* If there was no error: assign the text to the variable. */
1103 if (redir_endp != NULL)
1105 ga_append(&redir_ga, NUL); /* Append the trailing NUL. */
1106 tv.v_type = VAR_STRING;
1107 tv.vval.v_string = redir_ga.ga_data;
1108 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1111 /* free the collected output */
1112 vim_free(redir_ga.ga_data);
1113 redir_ga.ga_data = NULL;
1115 clear_lval(redir_lval);
1116 vim_free(redir_lval);
1117 redir_lval = NULL;
1119 vim_free(redir_varname);
1120 redir_varname = NULL;
1123 # if defined(FEAT_MBYTE) || defined(PROTO)
1125 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1126 char_u *enc_from;
1127 char_u *enc_to;
1128 char_u *fname_from;
1129 char_u *fname_to;
1131 int err = FALSE;
1133 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1134 set_vim_var_string(VV_CC_TO, enc_to, -1);
1135 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1136 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1137 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1138 err = TRUE;
1139 set_vim_var_string(VV_CC_FROM, NULL, -1);
1140 set_vim_var_string(VV_CC_TO, NULL, -1);
1141 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1142 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1144 if (err)
1145 return FAIL;
1146 return OK;
1148 # endif
1150 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1152 eval_printexpr(fname, args)
1153 char_u *fname;
1154 char_u *args;
1156 int err = FALSE;
1158 set_vim_var_string(VV_FNAME_IN, fname, -1);
1159 set_vim_var_string(VV_CMDARG, args, -1);
1160 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1161 err = TRUE;
1162 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1163 set_vim_var_string(VV_CMDARG, NULL, -1);
1165 if (err)
1167 mch_remove(fname);
1168 return FAIL;
1170 return OK;
1172 # endif
1174 # if defined(FEAT_DIFF) || defined(PROTO)
1175 void
1176 eval_diff(origfile, newfile, outfile)
1177 char_u *origfile;
1178 char_u *newfile;
1179 char_u *outfile;
1181 int err = FALSE;
1183 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1184 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1185 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1186 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1187 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1188 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1189 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1192 void
1193 eval_patch(origfile, difffile, outfile)
1194 char_u *origfile;
1195 char_u *difffile;
1196 char_u *outfile;
1198 int err;
1200 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1201 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1202 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1203 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1204 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1205 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1206 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1208 # endif
1211 * Top level evaluation function, returning a boolean.
1212 * Sets "error" to TRUE if there was an error.
1213 * Return TRUE or FALSE.
1216 eval_to_bool(arg, error, nextcmd, skip)
1217 char_u *arg;
1218 int *error;
1219 char_u **nextcmd;
1220 int skip; /* only parse, don't execute */
1222 typval_T tv;
1223 int retval = FALSE;
1225 if (skip)
1226 ++emsg_skip;
1227 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1228 *error = TRUE;
1229 else
1231 *error = FALSE;
1232 if (!skip)
1234 retval = (get_tv_number_chk(&tv, error) != 0);
1235 clear_tv(&tv);
1238 if (skip)
1239 --emsg_skip;
1241 return retval;
1245 * Top level evaluation function, returning a string. If "skip" is TRUE,
1246 * only parsing to "nextcmd" is done, without reporting errors. Return
1247 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1249 char_u *
1250 eval_to_string_skip(arg, nextcmd, skip)
1251 char_u *arg;
1252 char_u **nextcmd;
1253 int skip; /* only parse, don't execute */
1255 typval_T tv;
1256 char_u *retval;
1258 if (skip)
1259 ++emsg_skip;
1260 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1261 retval = NULL;
1262 else
1264 retval = vim_strsave(get_tv_string(&tv));
1265 clear_tv(&tv);
1267 if (skip)
1268 --emsg_skip;
1270 return retval;
1274 * Skip over an expression at "*pp".
1275 * Return FAIL for an error, OK otherwise.
1278 skip_expr(pp)
1279 char_u **pp;
1281 typval_T rettv;
1283 *pp = skipwhite(*pp);
1284 return eval1(pp, &rettv, FALSE);
1288 * Top level evaluation function, returning a string.
1289 * When "convert" is TRUE convert a List into a sequence of lines and convert
1290 * a Float to a String.
1291 * Return pointer to allocated memory, or NULL for failure.
1293 char_u *
1294 eval_to_string(arg, nextcmd, convert)
1295 char_u *arg;
1296 char_u **nextcmd;
1297 int convert;
1299 typval_T tv;
1300 char_u *retval;
1301 garray_T ga;
1302 #ifdef FEAT_FLOAT
1303 char_u numbuf[NUMBUFLEN];
1304 #endif
1306 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1307 retval = NULL;
1308 else
1310 if (convert && tv.v_type == VAR_LIST)
1312 ga_init2(&ga, (int)sizeof(char), 80);
1313 if (tv.vval.v_list != NULL)
1314 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1315 ga_append(&ga, NUL);
1316 retval = (char_u *)ga.ga_data;
1318 #ifdef FEAT_FLOAT
1319 else if (convert && tv.v_type == VAR_FLOAT)
1321 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1322 retval = vim_strsave(numbuf);
1324 #endif
1325 else
1326 retval = vim_strsave(get_tv_string(&tv));
1327 clear_tv(&tv);
1330 return retval;
1334 * Call eval_to_string() without using current local variables and using
1335 * textlock. When "use_sandbox" is TRUE use the sandbox.
1337 char_u *
1338 eval_to_string_safe(arg, nextcmd, use_sandbox)
1339 char_u *arg;
1340 char_u **nextcmd;
1341 int use_sandbox;
1343 char_u *retval;
1344 void *save_funccalp;
1346 save_funccalp = save_funccal();
1347 if (use_sandbox)
1348 ++sandbox;
1349 ++textlock;
1350 retval = eval_to_string(arg, nextcmd, FALSE);
1351 if (use_sandbox)
1352 --sandbox;
1353 --textlock;
1354 restore_funccal(save_funccalp);
1355 return retval;
1359 * Top level evaluation function, returning a number.
1360 * Evaluates "expr" silently.
1361 * Returns -1 for an error.
1364 eval_to_number(expr)
1365 char_u *expr;
1367 typval_T rettv;
1368 int retval;
1369 char_u *p = skipwhite(expr);
1371 ++emsg_off;
1373 if (eval1(&p, &rettv, TRUE) == FAIL)
1374 retval = -1;
1375 else
1377 retval = get_tv_number_chk(&rettv, NULL);
1378 clear_tv(&rettv);
1380 --emsg_off;
1382 return retval;
1386 * Prepare v: variable "idx" to be used.
1387 * Save the current typeval in "save_tv".
1388 * When not used yet add the variable to the v: hashtable.
1390 static void
1391 prepare_vimvar(idx, save_tv)
1392 int idx;
1393 typval_T *save_tv;
1395 *save_tv = vimvars[idx].vv_tv;
1396 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1397 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1401 * Restore v: variable "idx" to typeval "save_tv".
1402 * When no longer defined, remove the variable from the v: hashtable.
1404 static void
1405 restore_vimvar(idx, save_tv)
1406 int idx;
1407 typval_T *save_tv;
1409 hashitem_T *hi;
1411 vimvars[idx].vv_tv = *save_tv;
1412 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1414 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1415 if (HASHITEM_EMPTY(hi))
1416 EMSG2(_(e_intern2), "restore_vimvar()");
1417 else
1418 hash_remove(&vimvarht, hi);
1422 #if defined(FEAT_SPELL) || defined(PROTO)
1424 * Evaluate an expression to a list with suggestions.
1425 * For the "expr:" part of 'spellsuggest'.
1426 * Returns NULL when there is an error.
1428 list_T *
1429 eval_spell_expr(badword, expr)
1430 char_u *badword;
1431 char_u *expr;
1433 typval_T save_val;
1434 typval_T rettv;
1435 list_T *list = NULL;
1436 char_u *p = skipwhite(expr);
1438 /* Set "v:val" to the bad word. */
1439 prepare_vimvar(VV_VAL, &save_val);
1440 vimvars[VV_VAL].vv_type = VAR_STRING;
1441 vimvars[VV_VAL].vv_str = badword;
1442 if (p_verbose == 0)
1443 ++emsg_off;
1445 if (eval1(&p, &rettv, TRUE) == OK)
1447 if (rettv.v_type != VAR_LIST)
1448 clear_tv(&rettv);
1449 else
1450 list = rettv.vval.v_list;
1453 if (p_verbose == 0)
1454 --emsg_off;
1455 restore_vimvar(VV_VAL, &save_val);
1457 return list;
1461 * "list" is supposed to contain two items: a word and a number. Return the
1462 * word in "pp" and the number as the return value.
1463 * Return -1 if anything isn't right.
1464 * Used to get the good word and score from the eval_spell_expr() result.
1467 get_spellword(list, pp)
1468 list_T *list;
1469 char_u **pp;
1471 listitem_T *li;
1473 li = list->lv_first;
1474 if (li == NULL)
1475 return -1;
1476 *pp = get_tv_string(&li->li_tv);
1478 li = li->li_next;
1479 if (li == NULL)
1480 return -1;
1481 return get_tv_number(&li->li_tv);
1483 #endif
1486 * Top level evaluation function.
1487 * Returns an allocated typval_T with the result.
1488 * Returns NULL when there is an error.
1490 typval_T *
1491 eval_expr(arg, nextcmd)
1492 char_u *arg;
1493 char_u **nextcmd;
1495 typval_T *tv;
1497 tv = (typval_T *)alloc(sizeof(typval_T));
1498 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1500 vim_free(tv);
1501 tv = NULL;
1504 return tv;
1508 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1509 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1511 * Call some vimL function and return the result in "*rettv".
1512 * Uses argv[argc] for the function arguments. Only Number and String
1513 * arguments are currently supported.
1514 * Returns OK or FAIL.
1516 static int
1517 call_vim_function(func, argc, argv, safe, rettv)
1518 char_u *func;
1519 int argc;
1520 char_u **argv;
1521 int safe; /* use the sandbox */
1522 typval_T *rettv;
1524 typval_T *argvars;
1525 long n;
1526 int len;
1527 int i;
1528 int doesrange;
1529 void *save_funccalp = NULL;
1530 int ret;
1532 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1533 if (argvars == NULL)
1534 return FAIL;
1536 for (i = 0; i < argc; i++)
1538 /* Pass a NULL or empty argument as an empty string */
1539 if (argv[i] == NULL || *argv[i] == NUL)
1541 argvars[i].v_type = VAR_STRING;
1542 argvars[i].vval.v_string = (char_u *)"";
1543 continue;
1546 /* Recognize a number argument, the others must be strings. */
1547 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1548 if (len != 0 && len == (int)STRLEN(argv[i]))
1550 argvars[i].v_type = VAR_NUMBER;
1551 argvars[i].vval.v_number = n;
1553 else
1555 argvars[i].v_type = VAR_STRING;
1556 argvars[i].vval.v_string = argv[i];
1560 if (safe)
1562 save_funccalp = save_funccal();
1563 ++sandbox;
1566 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1567 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1568 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1569 &doesrange, TRUE, NULL);
1570 if (safe)
1572 --sandbox;
1573 restore_funccal(save_funccalp);
1575 vim_free(argvars);
1577 if (ret == FAIL)
1578 clear_tv(rettv);
1580 return ret;
1583 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1585 * Call vimL function "func" and return the result as a string.
1586 * Returns NULL when calling the function fails.
1587 * Uses argv[argc] for the function arguments.
1589 void *
1590 call_func_retstr(func, argc, argv, safe)
1591 char_u *func;
1592 int argc;
1593 char_u **argv;
1594 int safe; /* use the sandbox */
1596 typval_T rettv;
1597 char_u *retval;
1599 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1600 return NULL;
1602 retval = vim_strsave(get_tv_string(&rettv));
1603 clear_tv(&rettv);
1604 return retval;
1606 # endif
1608 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1610 * Call vimL function "func" and return the result as a number.
1611 * Returns -1 when calling the function fails.
1612 * Uses argv[argc] for the function arguments.
1614 long
1615 call_func_retnr(func, argc, argv, safe)
1616 char_u *func;
1617 int argc;
1618 char_u **argv;
1619 int safe; /* use the sandbox */
1621 typval_T rettv;
1622 long retval;
1624 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1625 return -1;
1627 retval = get_tv_number_chk(&rettv, NULL);
1628 clear_tv(&rettv);
1629 return retval;
1631 # endif
1634 * Call vimL function "func" and return the result as a List.
1635 * Uses argv[argc] for the function arguments.
1636 * Returns NULL when there is something wrong.
1638 void *
1639 call_func_retlist(func, argc, argv, safe)
1640 char_u *func;
1641 int argc;
1642 char_u **argv;
1643 int safe; /* use the sandbox */
1645 typval_T rettv;
1647 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1648 return NULL;
1650 if (rettv.v_type != VAR_LIST)
1652 clear_tv(&rettv);
1653 return NULL;
1656 return rettv.vval.v_list;
1658 #endif
1662 * Save the current function call pointer, and set it to NULL.
1663 * Used when executing autocommands and for ":source".
1665 void *
1666 save_funccal()
1668 funccall_T *fc = current_funccal;
1670 current_funccal = NULL;
1671 return (void *)fc;
1674 void
1675 restore_funccal(vfc)
1676 void *vfc;
1678 funccall_T *fc = (funccall_T *)vfc;
1680 current_funccal = fc;
1683 #if defined(FEAT_PROFILE) || defined(PROTO)
1685 * Prepare profiling for entering a child or something else that is not
1686 * counted for the script/function itself.
1687 * Should always be called in pair with prof_child_exit().
1689 void
1690 prof_child_enter(tm)
1691 proftime_T *tm; /* place to store waittime */
1693 funccall_T *fc = current_funccal;
1695 if (fc != NULL && fc->func->uf_profiling)
1696 profile_start(&fc->prof_child);
1697 script_prof_save(tm);
1701 * Take care of time spent in a child.
1702 * Should always be called after prof_child_enter().
1704 void
1705 prof_child_exit(tm)
1706 proftime_T *tm; /* where waittime was stored */
1708 funccall_T *fc = current_funccal;
1710 if (fc != NULL && fc->func->uf_profiling)
1712 profile_end(&fc->prof_child);
1713 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1714 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1715 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1717 script_prof_restore(tm);
1719 #endif
1722 #ifdef FEAT_FOLDING
1724 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1725 * it in "*cp". Doesn't give error messages.
1728 eval_foldexpr(arg, cp)
1729 char_u *arg;
1730 int *cp;
1732 typval_T tv;
1733 int retval;
1734 char_u *s;
1735 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1736 OPT_LOCAL);
1738 ++emsg_off;
1739 if (use_sandbox)
1740 ++sandbox;
1741 ++textlock;
1742 *cp = NUL;
1743 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1744 retval = 0;
1745 else
1747 /* If the result is a number, just return the number. */
1748 if (tv.v_type == VAR_NUMBER)
1749 retval = tv.vval.v_number;
1750 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1751 retval = 0;
1752 else
1754 /* If the result is a string, check if there is a non-digit before
1755 * the number. */
1756 s = tv.vval.v_string;
1757 if (!VIM_ISDIGIT(*s) && *s != '-')
1758 *cp = *s++;
1759 retval = atol((char *)s);
1761 clear_tv(&tv);
1763 --emsg_off;
1764 if (use_sandbox)
1765 --sandbox;
1766 --textlock;
1768 return retval;
1770 #endif
1773 * ":let" list all variable values
1774 * ":let var1 var2" list variable values
1775 * ":let var = expr" assignment command.
1776 * ":let var += expr" assignment command.
1777 * ":let var -= expr" assignment command.
1778 * ":let var .= expr" assignment command.
1779 * ":let [var1, var2] = expr" unpack list.
1781 void
1782 ex_let(eap)
1783 exarg_T *eap;
1785 char_u *arg = eap->arg;
1786 char_u *expr = NULL;
1787 typval_T rettv;
1788 int i;
1789 int var_count = 0;
1790 int semicolon = 0;
1791 char_u op[2];
1792 char_u *argend;
1793 int first = TRUE;
1795 argend = skip_var_list(arg, &var_count, &semicolon);
1796 if (argend == NULL)
1797 return;
1798 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1799 --argend;
1800 expr = vim_strchr(argend, '=');
1801 if (expr == NULL)
1804 * ":let" without "=": list variables
1806 if (*arg == '[')
1807 EMSG(_(e_invarg));
1808 else if (!ends_excmd(*arg))
1809 /* ":let var1 var2" */
1810 arg = list_arg_vars(eap, arg, &first);
1811 else if (!eap->skip)
1813 /* ":let" */
1814 list_glob_vars(&first);
1815 list_buf_vars(&first);
1816 list_win_vars(&first);
1817 #ifdef FEAT_WINDOWS
1818 list_tab_vars(&first);
1819 #endif
1820 list_script_vars(&first);
1821 list_func_vars(&first);
1822 list_vim_vars(&first);
1824 eap->nextcmd = check_nextcmd(arg);
1826 else
1828 op[0] = '=';
1829 op[1] = NUL;
1830 if (expr > argend)
1832 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1833 op[0] = expr[-1]; /* +=, -= or .= */
1835 expr = skipwhite(expr + 1);
1837 if (eap->skip)
1838 ++emsg_skip;
1839 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1840 if (eap->skip)
1842 if (i != FAIL)
1843 clear_tv(&rettv);
1844 --emsg_skip;
1846 else if (i != FAIL)
1848 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1849 op);
1850 clear_tv(&rettv);
1856 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1857 * Handles both "var" with any type and "[var, var; var]" with a list type.
1858 * When "nextchars" is not NULL it points to a string with characters that
1859 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1860 * or concatenate.
1861 * Returns OK or FAIL;
1863 static int
1864 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1865 char_u *arg_start;
1866 typval_T *tv;
1867 int copy; /* copy values from "tv", don't move */
1868 int semicolon; /* from skip_var_list() */
1869 int var_count; /* from skip_var_list() */
1870 char_u *nextchars;
1872 char_u *arg = arg_start;
1873 list_T *l;
1874 int i;
1875 listitem_T *item;
1876 typval_T ltv;
1878 if (*arg != '[')
1881 * ":let var = expr" or ":for var in list"
1883 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1884 return FAIL;
1885 return OK;
1889 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1891 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1893 EMSG(_(e_listreq));
1894 return FAIL;
1897 i = list_len(l);
1898 if (semicolon == 0 && var_count < i)
1900 EMSG(_("E687: Less targets than List items"));
1901 return FAIL;
1903 if (var_count - semicolon > i)
1905 EMSG(_("E688: More targets than List items"));
1906 return FAIL;
1909 item = l->lv_first;
1910 while (*arg != ']')
1912 arg = skipwhite(arg + 1);
1913 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1914 item = item->li_next;
1915 if (arg == NULL)
1916 return FAIL;
1918 arg = skipwhite(arg);
1919 if (*arg == ';')
1921 /* Put the rest of the list (may be empty) in the var after ';'.
1922 * Create a new list for this. */
1923 l = list_alloc();
1924 if (l == NULL)
1925 return FAIL;
1926 while (item != NULL)
1928 list_append_tv(l, &item->li_tv);
1929 item = item->li_next;
1932 ltv.v_type = VAR_LIST;
1933 ltv.v_lock = 0;
1934 ltv.vval.v_list = l;
1935 l->lv_refcount = 1;
1937 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1938 (char_u *)"]", nextchars);
1939 clear_tv(&ltv);
1940 if (arg == NULL)
1941 return FAIL;
1942 break;
1944 else if (*arg != ',' && *arg != ']')
1946 EMSG2(_(e_intern2), "ex_let_vars()");
1947 return FAIL;
1951 return OK;
1955 * Skip over assignable variable "var" or list of variables "[var, var]".
1956 * Used for ":let varvar = expr" and ":for varvar in expr".
1957 * For "[var, var]" increment "*var_count" for each variable.
1958 * for "[var, var; var]" set "semicolon".
1959 * Return NULL for an error.
1961 static char_u *
1962 skip_var_list(arg, var_count, semicolon)
1963 char_u *arg;
1964 int *var_count;
1965 int *semicolon;
1967 char_u *p, *s;
1969 if (*arg == '[')
1971 /* "[var, var]": find the matching ']'. */
1972 p = arg;
1973 for (;;)
1975 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1976 s = skip_var_one(p);
1977 if (s == p)
1979 EMSG2(_(e_invarg2), p);
1980 return NULL;
1982 ++*var_count;
1984 p = skipwhite(s);
1985 if (*p == ']')
1986 break;
1987 else if (*p == ';')
1989 if (*semicolon == 1)
1991 EMSG(_("Double ; in list of variables"));
1992 return NULL;
1994 *semicolon = 1;
1996 else if (*p != ',')
1998 EMSG2(_(e_invarg2), p);
1999 return NULL;
2002 return p + 1;
2004 else
2005 return skip_var_one(arg);
2009 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
2010 * l[idx].
2012 static char_u *
2013 skip_var_one(arg)
2014 char_u *arg;
2016 if (*arg == '@' && arg[1] != NUL)
2017 return arg + 2;
2018 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2019 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2023 * List variables for hashtab "ht" with prefix "prefix".
2024 * If "empty" is TRUE also list NULL strings as empty strings.
2026 static void
2027 list_hashtable_vars(ht, prefix, empty, first)
2028 hashtab_T *ht;
2029 char_u *prefix;
2030 int empty;
2031 int *first;
2033 hashitem_T *hi;
2034 dictitem_T *di;
2035 int todo;
2037 todo = (int)ht->ht_used;
2038 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2040 if (!HASHITEM_EMPTY(hi))
2042 --todo;
2043 di = HI2DI(hi);
2044 if (empty || di->di_tv.v_type != VAR_STRING
2045 || di->di_tv.vval.v_string != NULL)
2046 list_one_var(di, prefix, first);
2052 * List global variables.
2054 static void
2055 list_glob_vars(first)
2056 int *first;
2058 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2062 * List buffer variables.
2064 static void
2065 list_buf_vars(first)
2066 int *first;
2068 char_u numbuf[NUMBUFLEN];
2070 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2071 TRUE, first);
2073 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2074 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2075 numbuf, first);
2079 * List window variables.
2081 static void
2082 list_win_vars(first)
2083 int *first;
2085 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2086 (char_u *)"w:", TRUE, first);
2089 #ifdef FEAT_WINDOWS
2091 * List tab page variables.
2093 static void
2094 list_tab_vars(first)
2095 int *first;
2097 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2098 (char_u *)"t:", TRUE, first);
2100 #endif
2103 * List Vim variables.
2105 static void
2106 list_vim_vars(first)
2107 int *first;
2109 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2113 * List script-local variables, if there is a script.
2115 static void
2116 list_script_vars(first)
2117 int *first;
2119 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2120 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2121 (char_u *)"s:", FALSE, first);
2125 * List function variables, if there is a function.
2127 static void
2128 list_func_vars(first)
2129 int *first;
2131 if (current_funccal != NULL)
2132 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2133 (char_u *)"l:", FALSE, first);
2137 * List variables in "arg".
2139 static char_u *
2140 list_arg_vars(eap, arg, first)
2141 exarg_T *eap;
2142 char_u *arg;
2143 int *first;
2145 int error = FALSE;
2146 int len;
2147 char_u *name;
2148 char_u *name_start;
2149 char_u *arg_subsc;
2150 char_u *tofree;
2151 typval_T tv;
2153 while (!ends_excmd(*arg) && !got_int)
2155 if (error || eap->skip)
2157 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2158 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2160 emsg_severe = TRUE;
2161 EMSG(_(e_trailing));
2162 break;
2165 else
2167 /* get_name_len() takes care of expanding curly braces */
2168 name_start = name = arg;
2169 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2170 if (len <= 0)
2172 /* This is mainly to keep test 49 working: when expanding
2173 * curly braces fails overrule the exception error message. */
2174 if (len < 0 && !aborting())
2176 emsg_severe = TRUE;
2177 EMSG2(_(e_invarg2), arg);
2178 break;
2180 error = TRUE;
2182 else
2184 if (tofree != NULL)
2185 name = tofree;
2186 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2187 error = TRUE;
2188 else
2190 /* handle d.key, l[idx], f(expr) */
2191 arg_subsc = arg;
2192 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2193 error = TRUE;
2194 else
2196 if (arg == arg_subsc && len == 2 && name[1] == ':')
2198 switch (*name)
2200 case 'g': list_glob_vars(first); break;
2201 case 'b': list_buf_vars(first); break;
2202 case 'w': list_win_vars(first); break;
2203 #ifdef FEAT_WINDOWS
2204 case 't': list_tab_vars(first); break;
2205 #endif
2206 case 'v': list_vim_vars(first); break;
2207 case 's': list_script_vars(first); break;
2208 case 'l': list_func_vars(first); break;
2209 default:
2210 EMSG2(_("E738: Can't list variables for %s"), name);
2213 else
2215 char_u numbuf[NUMBUFLEN];
2216 char_u *tf;
2217 int c;
2218 char_u *s;
2220 s = echo_string(&tv, &tf, numbuf, 0);
2221 c = *arg;
2222 *arg = NUL;
2223 list_one_var_a((char_u *)"",
2224 arg == arg_subsc ? name : name_start,
2225 tv.v_type,
2226 s == NULL ? (char_u *)"" : s,
2227 first);
2228 *arg = c;
2229 vim_free(tf);
2231 clear_tv(&tv);
2236 vim_free(tofree);
2239 arg = skipwhite(arg);
2242 return arg;
2246 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2247 * Returns a pointer to the char just after the var name.
2248 * Returns NULL if there is an error.
2250 static char_u *
2251 ex_let_one(arg, tv, copy, endchars, op)
2252 char_u *arg; /* points to variable name */
2253 typval_T *tv; /* value to assign to variable */
2254 int copy; /* copy value from "tv" */
2255 char_u *endchars; /* valid chars after variable name or NULL */
2256 char_u *op; /* "+", "-", "." or NULL*/
2258 int c1;
2259 char_u *name;
2260 char_u *p;
2261 char_u *arg_end = NULL;
2262 int len;
2263 int opt_flags;
2264 char_u *tofree = NULL;
2267 * ":let $VAR = expr": Set environment variable.
2269 if (*arg == '$')
2271 /* Find the end of the name. */
2272 ++arg;
2273 name = arg;
2274 len = get_env_len(&arg);
2275 if (len == 0)
2276 EMSG2(_(e_invarg2), name - 1);
2277 else
2279 if (op != NULL && (*op == '+' || *op == '-'))
2280 EMSG2(_(e_letwrong), op);
2281 else if (endchars != NULL
2282 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2283 EMSG(_(e_letunexp));
2284 else
2286 c1 = name[len];
2287 name[len] = NUL;
2288 p = get_tv_string_chk(tv);
2289 if (p != NULL && op != NULL && *op == '.')
2291 int mustfree = FALSE;
2292 char_u *s = vim_getenv(name, &mustfree);
2294 if (s != NULL)
2296 p = tofree = concat_str(s, p);
2297 if (mustfree)
2298 vim_free(s);
2301 if (p != NULL)
2303 vim_setenv(name, p);
2304 if (STRICMP(name, "HOME") == 0)
2305 init_homedir();
2306 else if (didset_vim && STRICMP(name, "VIM") == 0)
2307 didset_vim = FALSE;
2308 else if (didset_vimruntime
2309 && STRICMP(name, "VIMRUNTIME") == 0)
2310 didset_vimruntime = FALSE;
2311 arg_end = arg;
2313 name[len] = c1;
2314 vim_free(tofree);
2320 * ":let &option = expr": Set option value.
2321 * ":let &l:option = expr": Set local option value.
2322 * ":let &g:option = expr": Set global option value.
2324 else if (*arg == '&')
2326 /* Find the end of the name. */
2327 p = find_option_end(&arg, &opt_flags);
2328 if (p == NULL || (endchars != NULL
2329 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2330 EMSG(_(e_letunexp));
2331 else
2333 long n;
2334 int opt_type;
2335 long numval;
2336 char_u *stringval = NULL;
2337 char_u *s;
2339 c1 = *p;
2340 *p = NUL;
2342 n = get_tv_number(tv);
2343 s = get_tv_string_chk(tv); /* != NULL if number or string */
2344 if (s != NULL && op != NULL && *op != '=')
2346 opt_type = get_option_value(arg, &numval,
2347 &stringval, opt_flags);
2348 if ((opt_type == 1 && *op == '.')
2349 || (opt_type == 0 && *op != '.'))
2350 EMSG2(_(e_letwrong), op);
2351 else
2353 if (opt_type == 1) /* number */
2355 if (*op == '+')
2356 n = numval + n;
2357 else
2358 n = numval - n;
2360 else if (opt_type == 0 && stringval != NULL) /* string */
2362 s = concat_str(stringval, s);
2363 vim_free(stringval);
2364 stringval = s;
2368 if (s != NULL)
2370 set_option_value(arg, n, s, opt_flags);
2371 arg_end = p;
2373 *p = c1;
2374 vim_free(stringval);
2379 * ":let @r = expr": Set register contents.
2381 else if (*arg == '@')
2383 ++arg;
2384 if (op != NULL && (*op == '+' || *op == '-'))
2385 EMSG2(_(e_letwrong), op);
2386 else if (endchars != NULL
2387 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2388 EMSG(_(e_letunexp));
2389 else
2391 char_u *ptofree = NULL;
2392 char_u *s;
2394 p = get_tv_string_chk(tv);
2395 if (p != NULL && op != NULL && *op == '.')
2397 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2398 if (s != NULL)
2400 p = ptofree = concat_str(s, p);
2401 vim_free(s);
2404 if (p != NULL)
2406 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2407 arg_end = arg + 1;
2409 vim_free(ptofree);
2414 * ":let var = expr": Set internal variable.
2415 * ":let {expr} = expr": Idem, name made with curly braces
2417 else if (eval_isnamec1(*arg) || *arg == '{')
2419 lval_T lv;
2421 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2422 if (p != NULL && lv.ll_name != NULL)
2424 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2425 EMSG(_(e_letunexp));
2426 else
2428 set_var_lval(&lv, p, tv, copy, op);
2429 arg_end = p;
2432 clear_lval(&lv);
2435 else
2436 EMSG2(_(e_invarg2), arg);
2438 return arg_end;
2442 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2444 static int
2445 check_changedtick(arg)
2446 char_u *arg;
2448 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2450 EMSG2(_(e_readonlyvar), arg);
2451 return TRUE;
2453 return FALSE;
2457 * Get an lval: variable, Dict item or List item that can be assigned a value
2458 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2459 * "name.key", "name.key[expr]" etc.
2460 * Indexing only works if "name" is an existing List or Dictionary.
2461 * "name" points to the start of the name.
2462 * If "rettv" is not NULL it points to the value to be assigned.
2463 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2464 * wrong; must end in space or cmd separator.
2466 * Returns a pointer to just after the name, including indexes.
2467 * When an evaluation error occurs "lp->ll_name" is NULL;
2468 * Returns NULL for a parsing error. Still need to free items in "lp"!
2470 static char_u *
2471 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2472 char_u *name;
2473 typval_T *rettv;
2474 lval_T *lp;
2475 int unlet;
2476 int skip;
2477 int quiet; /* don't give error messages */
2478 int fne_flags; /* flags for find_name_end() */
2480 char_u *p;
2481 char_u *expr_start, *expr_end;
2482 int cc;
2483 dictitem_T *v;
2484 typval_T var1;
2485 typval_T var2;
2486 int empty1 = FALSE;
2487 listitem_T *ni;
2488 char_u *key = NULL;
2489 int len;
2490 hashtab_T *ht;
2492 /* Clear everything in "lp". */
2493 vim_memset(lp, 0, sizeof(lval_T));
2495 if (skip)
2497 /* When skipping just find the end of the name. */
2498 lp->ll_name = name;
2499 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2502 /* Find the end of the name. */
2503 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2504 if (expr_start != NULL)
2506 /* Don't expand the name when we already know there is an error. */
2507 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2508 && *p != '[' && *p != '.')
2510 EMSG(_(e_trailing));
2511 return NULL;
2514 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2515 if (lp->ll_exp_name == NULL)
2517 /* Report an invalid expression in braces, unless the
2518 * expression evaluation has been cancelled due to an
2519 * aborting error, an interrupt, or an exception. */
2520 if (!aborting() && !quiet)
2522 emsg_severe = TRUE;
2523 EMSG2(_(e_invarg2), name);
2524 return NULL;
2527 lp->ll_name = lp->ll_exp_name;
2529 else
2530 lp->ll_name = name;
2532 /* Without [idx] or .key we are done. */
2533 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2534 return p;
2536 cc = *p;
2537 *p = NUL;
2538 v = find_var(lp->ll_name, &ht);
2539 if (v == NULL && !quiet)
2540 EMSG2(_(e_undefvar), lp->ll_name);
2541 *p = cc;
2542 if (v == NULL)
2543 return NULL;
2546 * Loop until no more [idx] or .key is following.
2548 lp->ll_tv = &v->di_tv;
2549 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2551 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2552 && !(lp->ll_tv->v_type == VAR_DICT
2553 && lp->ll_tv->vval.v_dict != NULL))
2555 if (!quiet)
2556 EMSG(_("E689: Can only index a List or Dictionary"));
2557 return NULL;
2559 if (lp->ll_range)
2561 if (!quiet)
2562 EMSG(_("E708: [:] must come last"));
2563 return NULL;
2566 len = -1;
2567 if (*p == '.')
2569 key = p + 1;
2570 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2572 if (len == 0)
2574 if (!quiet)
2575 EMSG(_(e_emptykey));
2576 return NULL;
2578 p = key + len;
2580 else
2582 /* Get the index [expr] or the first index [expr: ]. */
2583 p = skipwhite(p + 1);
2584 if (*p == ':')
2585 empty1 = TRUE;
2586 else
2588 empty1 = FALSE;
2589 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2590 return NULL;
2591 if (get_tv_string_chk(&var1) == NULL)
2593 /* not a number or string */
2594 clear_tv(&var1);
2595 return NULL;
2599 /* Optionally get the second index [ :expr]. */
2600 if (*p == ':')
2602 if (lp->ll_tv->v_type == VAR_DICT)
2604 if (!quiet)
2605 EMSG(_(e_dictrange));
2606 if (!empty1)
2607 clear_tv(&var1);
2608 return NULL;
2610 if (rettv != NULL && (rettv->v_type != VAR_LIST
2611 || rettv->vval.v_list == NULL))
2613 if (!quiet)
2614 EMSG(_("E709: [:] requires a List value"));
2615 if (!empty1)
2616 clear_tv(&var1);
2617 return NULL;
2619 p = skipwhite(p + 1);
2620 if (*p == ']')
2621 lp->ll_empty2 = TRUE;
2622 else
2624 lp->ll_empty2 = FALSE;
2625 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2627 if (!empty1)
2628 clear_tv(&var1);
2629 return NULL;
2631 if (get_tv_string_chk(&var2) == NULL)
2633 /* not a number or string */
2634 if (!empty1)
2635 clear_tv(&var1);
2636 clear_tv(&var2);
2637 return NULL;
2640 lp->ll_range = TRUE;
2642 else
2643 lp->ll_range = FALSE;
2645 if (*p != ']')
2647 if (!quiet)
2648 EMSG(_(e_missbrac));
2649 if (!empty1)
2650 clear_tv(&var1);
2651 if (lp->ll_range && !lp->ll_empty2)
2652 clear_tv(&var2);
2653 return NULL;
2656 /* Skip to past ']'. */
2657 ++p;
2660 if (lp->ll_tv->v_type == VAR_DICT)
2662 if (len == -1)
2664 /* "[key]": get key from "var1" */
2665 key = get_tv_string(&var1); /* is number or string */
2666 if (*key == NUL)
2668 if (!quiet)
2669 EMSG(_(e_emptykey));
2670 clear_tv(&var1);
2671 return NULL;
2674 lp->ll_list = NULL;
2675 lp->ll_dict = lp->ll_tv->vval.v_dict;
2676 lp->ll_di = dict_find(lp->ll_dict, key, len);
2677 if (lp->ll_di == NULL)
2679 /* Key does not exist in dict: may need to add it. */
2680 if (*p == '[' || *p == '.' || unlet)
2682 if (!quiet)
2683 EMSG2(_(e_dictkey), key);
2684 if (len == -1)
2685 clear_tv(&var1);
2686 return NULL;
2688 if (len == -1)
2689 lp->ll_newkey = vim_strsave(key);
2690 else
2691 lp->ll_newkey = vim_strnsave(key, len);
2692 if (len == -1)
2693 clear_tv(&var1);
2694 if (lp->ll_newkey == NULL)
2695 p = NULL;
2696 break;
2698 if (len == -1)
2699 clear_tv(&var1);
2700 lp->ll_tv = &lp->ll_di->di_tv;
2702 else
2705 * Get the number and item for the only or first index of the List.
2707 if (empty1)
2708 lp->ll_n1 = 0;
2709 else
2711 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2712 clear_tv(&var1);
2714 lp->ll_dict = NULL;
2715 lp->ll_list = lp->ll_tv->vval.v_list;
2716 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2717 if (lp->ll_li == NULL)
2719 if (lp->ll_n1 < 0)
2721 lp->ll_n1 = 0;
2722 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2725 if (lp->ll_li == NULL)
2727 if (lp->ll_range && !lp->ll_empty2)
2728 clear_tv(&var2);
2729 return NULL;
2733 * May need to find the item or absolute index for the second
2734 * index of a range.
2735 * When no index given: "lp->ll_empty2" is TRUE.
2736 * Otherwise "lp->ll_n2" is set to the second index.
2738 if (lp->ll_range && !lp->ll_empty2)
2740 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2741 clear_tv(&var2);
2742 if (lp->ll_n2 < 0)
2744 ni = list_find(lp->ll_list, lp->ll_n2);
2745 if (ni == NULL)
2746 return NULL;
2747 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2750 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2751 if (lp->ll_n1 < 0)
2752 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2753 if (lp->ll_n2 < lp->ll_n1)
2754 return NULL;
2757 lp->ll_tv = &lp->ll_li->li_tv;
2761 return p;
2765 * Clear lval "lp" that was filled by get_lval().
2767 static void
2768 clear_lval(lp)
2769 lval_T *lp;
2771 vim_free(lp->ll_exp_name);
2772 vim_free(lp->ll_newkey);
2776 * Set a variable that was parsed by get_lval() to "rettv".
2777 * "endp" points to just after the parsed name.
2778 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2780 static void
2781 set_var_lval(lp, endp, rettv, copy, op)
2782 lval_T *lp;
2783 char_u *endp;
2784 typval_T *rettv;
2785 int copy;
2786 char_u *op;
2788 int cc;
2789 listitem_T *ri;
2790 dictitem_T *di;
2792 if (lp->ll_tv == NULL)
2794 if (!check_changedtick(lp->ll_name))
2796 cc = *endp;
2797 *endp = NUL;
2798 if (op != NULL && *op != '=')
2800 typval_T tv;
2802 /* handle +=, -= and .= */
2803 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2804 &tv, TRUE) == OK)
2806 if (tv_op(&tv, rettv, op) == OK)
2807 set_var(lp->ll_name, &tv, FALSE);
2808 clear_tv(&tv);
2811 else
2812 set_var(lp->ll_name, rettv, copy);
2813 *endp = cc;
2816 else if (tv_check_lock(lp->ll_newkey == NULL
2817 ? lp->ll_tv->v_lock
2818 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2820 else if (lp->ll_range)
2823 * Assign the List values to the list items.
2825 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2827 if (op != NULL && *op != '=')
2828 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2829 else
2831 clear_tv(&lp->ll_li->li_tv);
2832 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2834 ri = ri->li_next;
2835 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2836 break;
2837 if (lp->ll_li->li_next == NULL)
2839 /* Need to add an empty item. */
2840 if (list_append_number(lp->ll_list, 0) == FAIL)
2842 ri = NULL;
2843 break;
2846 lp->ll_li = lp->ll_li->li_next;
2847 ++lp->ll_n1;
2849 if (ri != NULL)
2850 EMSG(_("E710: List value has more items than target"));
2851 else if (lp->ll_empty2
2852 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2853 : lp->ll_n1 != lp->ll_n2)
2854 EMSG(_("E711: List value has not enough items"));
2856 else
2859 * Assign to a List or Dictionary item.
2861 if (lp->ll_newkey != NULL)
2863 if (op != NULL && *op != '=')
2865 EMSG2(_(e_letwrong), op);
2866 return;
2869 /* Need to add an item to the Dictionary. */
2870 di = dictitem_alloc(lp->ll_newkey);
2871 if (di == NULL)
2872 return;
2873 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2875 vim_free(di);
2876 return;
2878 lp->ll_tv = &di->di_tv;
2880 else if (op != NULL && *op != '=')
2882 tv_op(lp->ll_tv, rettv, op);
2883 return;
2885 else
2886 clear_tv(lp->ll_tv);
2889 * Assign the value to the variable or list item.
2891 if (copy)
2892 copy_tv(rettv, lp->ll_tv);
2893 else
2895 *lp->ll_tv = *rettv;
2896 lp->ll_tv->v_lock = 0;
2897 init_tv(rettv);
2903 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2904 * Returns OK or FAIL.
2906 static int
2907 tv_op(tv1, tv2, op)
2908 typval_T *tv1;
2909 typval_T *tv2;
2910 char_u *op;
2912 long n;
2913 char_u numbuf[NUMBUFLEN];
2914 char_u *s;
2916 /* Can't do anything with a Funcref or a Dict on the right. */
2917 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2919 switch (tv1->v_type)
2921 case VAR_DICT:
2922 case VAR_FUNC:
2923 break;
2925 case VAR_LIST:
2926 if (*op != '+' || tv2->v_type != VAR_LIST)
2927 break;
2928 /* List += List */
2929 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2930 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2931 return OK;
2933 case VAR_NUMBER:
2934 case VAR_STRING:
2935 if (tv2->v_type == VAR_LIST)
2936 break;
2937 if (*op == '+' || *op == '-')
2939 /* nr += nr or nr -= nr*/
2940 n = get_tv_number(tv1);
2941 #ifdef FEAT_FLOAT
2942 if (tv2->v_type == VAR_FLOAT)
2944 float_T f = n;
2946 if (*op == '+')
2947 f += tv2->vval.v_float;
2948 else
2949 f -= tv2->vval.v_float;
2950 clear_tv(tv1);
2951 tv1->v_type = VAR_FLOAT;
2952 tv1->vval.v_float = f;
2954 else
2955 #endif
2957 if (*op == '+')
2958 n += get_tv_number(tv2);
2959 else
2960 n -= get_tv_number(tv2);
2961 clear_tv(tv1);
2962 tv1->v_type = VAR_NUMBER;
2963 tv1->vval.v_number = n;
2966 else
2968 if (tv2->v_type == VAR_FLOAT)
2969 break;
2971 /* str .= str */
2972 s = get_tv_string(tv1);
2973 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2974 clear_tv(tv1);
2975 tv1->v_type = VAR_STRING;
2976 tv1->vval.v_string = s;
2978 return OK;
2980 #ifdef FEAT_FLOAT
2981 case VAR_FLOAT:
2983 float_T f;
2985 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2986 && tv2->v_type != VAR_NUMBER
2987 && tv2->v_type != VAR_STRING))
2988 break;
2989 if (tv2->v_type == VAR_FLOAT)
2990 f = tv2->vval.v_float;
2991 else
2992 f = get_tv_number(tv2);
2993 if (*op == '+')
2994 tv1->vval.v_float += f;
2995 else
2996 tv1->vval.v_float -= f;
2998 return OK;
2999 #endif
3003 EMSG2(_(e_letwrong), op);
3004 return FAIL;
3008 * Add a watcher to a list.
3010 static void
3011 list_add_watch(l, lw)
3012 list_T *l;
3013 listwatch_T *lw;
3015 lw->lw_next = l->lv_watch;
3016 l->lv_watch = lw;
3020 * Remove a watcher from a list.
3021 * No warning when it isn't found...
3023 static void
3024 list_rem_watch(l, lwrem)
3025 list_T *l;
3026 listwatch_T *lwrem;
3028 listwatch_T *lw, **lwp;
3030 lwp = &l->lv_watch;
3031 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3033 if (lw == lwrem)
3035 *lwp = lw->lw_next;
3036 break;
3038 lwp = &lw->lw_next;
3043 * Just before removing an item from a list: advance watchers to the next
3044 * item.
3046 static void
3047 list_fix_watch(l, item)
3048 list_T *l;
3049 listitem_T *item;
3051 listwatch_T *lw;
3053 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3054 if (lw->lw_item == item)
3055 lw->lw_item = item->li_next;
3059 * Evaluate the expression used in a ":for var in expr" command.
3060 * "arg" points to "var".
3061 * Set "*errp" to TRUE for an error, FALSE otherwise;
3062 * Return a pointer that holds the info. Null when there is an error.
3064 void *
3065 eval_for_line(arg, errp, nextcmdp, skip)
3066 char_u *arg;
3067 int *errp;
3068 char_u **nextcmdp;
3069 int skip;
3071 forinfo_T *fi;
3072 char_u *expr;
3073 typval_T tv;
3074 list_T *l;
3076 *errp = TRUE; /* default: there is an error */
3078 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3079 if (fi == NULL)
3080 return NULL;
3082 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3083 if (expr == NULL)
3084 return fi;
3086 expr = skipwhite(expr);
3087 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3089 EMSG(_("E690: Missing \"in\" after :for"));
3090 return fi;
3093 if (skip)
3094 ++emsg_skip;
3095 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3097 *errp = FALSE;
3098 if (!skip)
3100 l = tv.vval.v_list;
3101 if (tv.v_type != VAR_LIST || l == NULL)
3103 EMSG(_(e_listreq));
3104 clear_tv(&tv);
3106 else
3108 /* No need to increment the refcount, it's already set for the
3109 * list being used in "tv". */
3110 fi->fi_list = l;
3111 list_add_watch(l, &fi->fi_lw);
3112 fi->fi_lw.lw_item = l->lv_first;
3116 if (skip)
3117 --emsg_skip;
3119 return fi;
3123 * Use the first item in a ":for" list. Advance to the next.
3124 * Assign the values to the variable (list). "arg" points to the first one.
3125 * Return TRUE when a valid item was found, FALSE when at end of list or
3126 * something wrong.
3129 next_for_item(fi_void, arg)
3130 void *fi_void;
3131 char_u *arg;
3133 forinfo_T *fi = (forinfo_T *)fi_void;
3134 int result;
3135 listitem_T *item;
3137 item = fi->fi_lw.lw_item;
3138 if (item == NULL)
3139 result = FALSE;
3140 else
3142 fi->fi_lw.lw_item = item->li_next;
3143 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3144 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3146 return result;
3150 * Free the structure used to store info used by ":for".
3152 void
3153 free_for_info(fi_void)
3154 void *fi_void;
3156 forinfo_T *fi = (forinfo_T *)fi_void;
3158 if (fi != NULL && fi->fi_list != NULL)
3160 list_rem_watch(fi->fi_list, &fi->fi_lw);
3161 list_unref(fi->fi_list);
3163 vim_free(fi);
3166 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3168 void
3169 set_context_for_expression(xp, arg, cmdidx)
3170 expand_T *xp;
3171 char_u *arg;
3172 cmdidx_T cmdidx;
3174 int got_eq = FALSE;
3175 int c;
3176 char_u *p;
3178 if (cmdidx == CMD_let)
3180 xp->xp_context = EXPAND_USER_VARS;
3181 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3183 /* ":let var1 var2 ...": find last space. */
3184 for (p = arg + STRLEN(arg); p >= arg; )
3186 xp->xp_pattern = p;
3187 mb_ptr_back(arg, p);
3188 if (vim_iswhite(*p))
3189 break;
3191 return;
3194 else
3195 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3196 : EXPAND_EXPRESSION;
3197 while ((xp->xp_pattern = vim_strpbrk(arg,
3198 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3200 c = *xp->xp_pattern;
3201 if (c == '&')
3203 c = xp->xp_pattern[1];
3204 if (c == '&')
3206 ++xp->xp_pattern;
3207 xp->xp_context = cmdidx != CMD_let || got_eq
3208 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3210 else if (c != ' ')
3212 xp->xp_context = EXPAND_SETTINGS;
3213 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3214 xp->xp_pattern += 2;
3218 else if (c == '$')
3220 /* environment variable */
3221 xp->xp_context = EXPAND_ENV_VARS;
3223 else if (c == '=')
3225 got_eq = TRUE;
3226 xp->xp_context = EXPAND_EXPRESSION;
3228 else if (c == '<'
3229 && xp->xp_context == EXPAND_FUNCTIONS
3230 && vim_strchr(xp->xp_pattern, '(') == NULL)
3232 /* Function name can start with "<SNR>" */
3233 break;
3235 else if (cmdidx != CMD_let || got_eq)
3237 if (c == '"') /* string */
3239 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3240 if (c == '\\' && xp->xp_pattern[1] != NUL)
3241 ++xp->xp_pattern;
3242 xp->xp_context = EXPAND_NOTHING;
3244 else if (c == '\'') /* literal string */
3246 /* Trick: '' is like stopping and starting a literal string. */
3247 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3248 /* skip */ ;
3249 xp->xp_context = EXPAND_NOTHING;
3251 else if (c == '|')
3253 if (xp->xp_pattern[1] == '|')
3255 ++xp->xp_pattern;
3256 xp->xp_context = EXPAND_EXPRESSION;
3258 else
3259 xp->xp_context = EXPAND_COMMANDS;
3261 else
3262 xp->xp_context = EXPAND_EXPRESSION;
3264 else
3265 /* Doesn't look like something valid, expand as an expression
3266 * anyway. */
3267 xp->xp_context = EXPAND_EXPRESSION;
3268 arg = xp->xp_pattern;
3269 if (*arg != NUL)
3270 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3271 /* skip */ ;
3273 xp->xp_pattern = arg;
3276 #endif /* FEAT_CMDL_COMPL */
3279 * ":1,25call func(arg1, arg2)" function call.
3281 void
3282 ex_call(eap)
3283 exarg_T *eap;
3285 char_u *arg = eap->arg;
3286 char_u *startarg;
3287 char_u *name;
3288 char_u *tofree;
3289 int len;
3290 typval_T rettv;
3291 linenr_T lnum;
3292 int doesrange;
3293 int failed = FALSE;
3294 funcdict_T fudi;
3296 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3297 if (fudi.fd_newkey != NULL)
3299 /* Still need to give an error message for missing key. */
3300 EMSG2(_(e_dictkey), fudi.fd_newkey);
3301 vim_free(fudi.fd_newkey);
3303 if (tofree == NULL)
3304 return;
3306 /* Increase refcount on dictionary, it could get deleted when evaluating
3307 * the arguments. */
3308 if (fudi.fd_dict != NULL)
3309 ++fudi.fd_dict->dv_refcount;
3311 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3312 len = (int)STRLEN(tofree);
3313 name = deref_func_name(tofree, &len);
3315 /* Skip white space to allow ":call func ()". Not good, but required for
3316 * backward compatibility. */
3317 startarg = skipwhite(arg);
3318 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3320 if (*startarg != '(')
3322 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3323 goto end;
3327 * When skipping, evaluate the function once, to find the end of the
3328 * arguments.
3329 * When the function takes a range, this is discovered after the first
3330 * call, and the loop is broken.
3332 if (eap->skip)
3334 ++emsg_skip;
3335 lnum = eap->line2; /* do it once, also with an invalid range */
3337 else
3338 lnum = eap->line1;
3339 for ( ; lnum <= eap->line2; ++lnum)
3341 if (!eap->skip && eap->addr_count > 0)
3343 curwin->w_cursor.lnum = lnum;
3344 curwin->w_cursor.col = 0;
3346 arg = startarg;
3347 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3348 eap->line1, eap->line2, &doesrange,
3349 !eap->skip, fudi.fd_dict) == FAIL)
3351 failed = TRUE;
3352 break;
3355 /* Handle a function returning a Funcref, Dictionary or List. */
3356 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3358 failed = TRUE;
3359 break;
3362 clear_tv(&rettv);
3363 if (doesrange || eap->skip)
3364 break;
3366 /* Stop when immediately aborting on error, or when an interrupt
3367 * occurred or an exception was thrown but not caught.
3368 * get_func_tv() returned OK, so that the check for trailing
3369 * characters below is executed. */
3370 if (aborting())
3371 break;
3373 if (eap->skip)
3374 --emsg_skip;
3376 if (!failed)
3378 /* Check for trailing illegal characters and a following command. */
3379 if (!ends_excmd(*arg))
3381 emsg_severe = TRUE;
3382 EMSG(_(e_trailing));
3384 else
3385 eap->nextcmd = check_nextcmd(arg);
3388 end:
3389 dict_unref(fudi.fd_dict);
3390 vim_free(tofree);
3394 * ":unlet[!] var1 ... " command.
3396 void
3397 ex_unlet(eap)
3398 exarg_T *eap;
3400 ex_unletlock(eap, eap->arg, 0);
3404 * ":lockvar" and ":unlockvar" commands
3406 void
3407 ex_lockvar(eap)
3408 exarg_T *eap;
3410 char_u *arg = eap->arg;
3411 int deep = 2;
3413 if (eap->forceit)
3414 deep = -1;
3415 else if (vim_isdigit(*arg))
3417 deep = getdigits(&arg);
3418 arg = skipwhite(arg);
3421 ex_unletlock(eap, arg, deep);
3425 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3427 static void
3428 ex_unletlock(eap, argstart, deep)
3429 exarg_T *eap;
3430 char_u *argstart;
3431 int deep;
3433 char_u *arg = argstart;
3434 char_u *name_end;
3435 int error = FALSE;
3436 lval_T lv;
3440 /* Parse the name and find the end. */
3441 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3442 FNE_CHECK_START);
3443 if (lv.ll_name == NULL)
3444 error = TRUE; /* error but continue parsing */
3445 if (name_end == NULL || (!vim_iswhite(*name_end)
3446 && !ends_excmd(*name_end)))
3448 if (name_end != NULL)
3450 emsg_severe = TRUE;
3451 EMSG(_(e_trailing));
3453 if (!(eap->skip || error))
3454 clear_lval(&lv);
3455 break;
3458 if (!error && !eap->skip)
3460 if (eap->cmdidx == CMD_unlet)
3462 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3463 error = TRUE;
3465 else
3467 if (do_lock_var(&lv, name_end, deep,
3468 eap->cmdidx == CMD_lockvar) == FAIL)
3469 error = TRUE;
3473 if (!eap->skip)
3474 clear_lval(&lv);
3476 arg = skipwhite(name_end);
3477 } while (!ends_excmd(*arg));
3479 eap->nextcmd = check_nextcmd(arg);
3482 static int
3483 do_unlet_var(lp, name_end, forceit)
3484 lval_T *lp;
3485 char_u *name_end;
3486 int forceit;
3488 int ret = OK;
3489 int cc;
3491 if (lp->ll_tv == NULL)
3493 cc = *name_end;
3494 *name_end = NUL;
3496 /* Normal name or expanded name. */
3497 if (check_changedtick(lp->ll_name))
3498 ret = FAIL;
3499 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3500 ret = FAIL;
3501 *name_end = cc;
3503 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3504 return FAIL;
3505 else if (lp->ll_range)
3507 listitem_T *li;
3509 /* Delete a range of List items. */
3510 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3512 li = lp->ll_li->li_next;
3513 listitem_remove(lp->ll_list, lp->ll_li);
3514 lp->ll_li = li;
3515 ++lp->ll_n1;
3518 else
3520 if (lp->ll_list != NULL)
3521 /* unlet a List item. */
3522 listitem_remove(lp->ll_list, lp->ll_li);
3523 else
3524 /* unlet a Dictionary item. */
3525 dictitem_remove(lp->ll_dict, lp->ll_di);
3528 return ret;
3532 * "unlet" a variable. Return OK if it existed, FAIL if not.
3533 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3536 do_unlet(name, forceit)
3537 char_u *name;
3538 int forceit;
3540 hashtab_T *ht;
3541 hashitem_T *hi;
3542 char_u *varname;
3543 dictitem_T *di;
3545 ht = find_var_ht(name, &varname);
3546 if (ht != NULL && *varname != NUL)
3548 hi = hash_find(ht, varname);
3549 if (!HASHITEM_EMPTY(hi))
3551 di = HI2DI(hi);
3552 if (var_check_fixed(di->di_flags, name)
3553 || var_check_ro(di->di_flags, name))
3554 return FAIL;
3555 delete_var(ht, hi);
3556 return OK;
3559 if (forceit)
3560 return OK;
3561 EMSG2(_("E108: No such variable: \"%s\""), name);
3562 return FAIL;
3566 * Lock or unlock variable indicated by "lp".
3567 * "deep" is the levels to go (-1 for unlimited);
3568 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3570 static int
3571 do_lock_var(lp, name_end, deep, lock)
3572 lval_T *lp;
3573 char_u *name_end;
3574 int deep;
3575 int lock;
3577 int ret = OK;
3578 int cc;
3579 dictitem_T *di;
3581 if (deep == 0) /* nothing to do */
3582 return OK;
3584 if (lp->ll_tv == NULL)
3586 cc = *name_end;
3587 *name_end = NUL;
3589 /* Normal name or expanded name. */
3590 if (check_changedtick(lp->ll_name))
3591 ret = FAIL;
3592 else
3594 di = find_var(lp->ll_name, NULL);
3595 if (di == NULL)
3596 ret = FAIL;
3597 else
3599 if (lock)
3600 di->di_flags |= DI_FLAGS_LOCK;
3601 else
3602 di->di_flags &= ~DI_FLAGS_LOCK;
3603 item_lock(&di->di_tv, deep, lock);
3606 *name_end = cc;
3608 else if (lp->ll_range)
3610 listitem_T *li = lp->ll_li;
3612 /* (un)lock a range of List items. */
3613 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3615 item_lock(&li->li_tv, deep, lock);
3616 li = li->li_next;
3617 ++lp->ll_n1;
3620 else if (lp->ll_list != NULL)
3621 /* (un)lock a List item. */
3622 item_lock(&lp->ll_li->li_tv, deep, lock);
3623 else
3624 /* un(lock) a Dictionary item. */
3625 item_lock(&lp->ll_di->di_tv, deep, lock);
3627 return ret;
3631 * Lock or unlock an item. "deep" is nr of levels to go.
3633 static void
3634 item_lock(tv, deep, lock)
3635 typval_T *tv;
3636 int deep;
3637 int lock;
3639 static int recurse = 0;
3640 list_T *l;
3641 listitem_T *li;
3642 dict_T *d;
3643 hashitem_T *hi;
3644 int todo;
3646 if (recurse >= DICT_MAXNEST)
3648 EMSG(_("E743: variable nested too deep for (un)lock"));
3649 return;
3651 if (deep == 0)
3652 return;
3653 ++recurse;
3655 /* lock/unlock the item itself */
3656 if (lock)
3657 tv->v_lock |= VAR_LOCKED;
3658 else
3659 tv->v_lock &= ~VAR_LOCKED;
3661 switch (tv->v_type)
3663 case VAR_LIST:
3664 if ((l = tv->vval.v_list) != NULL)
3666 if (lock)
3667 l->lv_lock |= VAR_LOCKED;
3668 else
3669 l->lv_lock &= ~VAR_LOCKED;
3670 if (deep < 0 || deep > 1)
3671 /* recursive: lock/unlock the items the List contains */
3672 for (li = l->lv_first; li != NULL; li = li->li_next)
3673 item_lock(&li->li_tv, deep - 1, lock);
3675 break;
3676 case VAR_DICT:
3677 if ((d = tv->vval.v_dict) != NULL)
3679 if (lock)
3680 d->dv_lock |= VAR_LOCKED;
3681 else
3682 d->dv_lock &= ~VAR_LOCKED;
3683 if (deep < 0 || deep > 1)
3685 /* recursive: lock/unlock the items the List contains */
3686 todo = (int)d->dv_hashtab.ht_used;
3687 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3689 if (!HASHITEM_EMPTY(hi))
3691 --todo;
3692 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3698 --recurse;
3702 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3703 * or it refers to a List or Dictionary that is locked.
3705 static int
3706 tv_islocked(tv)
3707 typval_T *tv;
3709 return (tv->v_lock & VAR_LOCKED)
3710 || (tv->v_type == VAR_LIST
3711 && tv->vval.v_list != NULL
3712 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3713 || (tv->v_type == VAR_DICT
3714 && tv->vval.v_dict != NULL
3715 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3718 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3720 * Delete all "menutrans_" variables.
3722 void
3723 del_menutrans_vars()
3725 hashitem_T *hi;
3726 int todo;
3728 hash_lock(&globvarht);
3729 todo = (int)globvarht.ht_used;
3730 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3732 if (!HASHITEM_EMPTY(hi))
3734 --todo;
3735 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3736 delete_var(&globvarht, hi);
3739 hash_unlock(&globvarht);
3741 #endif
3743 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3746 * Local string buffer for the next two functions to store a variable name
3747 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3748 * get_user_var_name().
3751 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3753 static char_u *varnamebuf = NULL;
3754 static int varnamebuflen = 0;
3757 * Function to concatenate a prefix and a variable name.
3759 static char_u *
3760 cat_prefix_varname(prefix, name)
3761 int prefix;
3762 char_u *name;
3764 int len;
3766 len = (int)STRLEN(name) + 3;
3767 if (len > varnamebuflen)
3769 vim_free(varnamebuf);
3770 len += 10; /* some additional space */
3771 varnamebuf = alloc(len);
3772 if (varnamebuf == NULL)
3774 varnamebuflen = 0;
3775 return NULL;
3777 varnamebuflen = len;
3779 *varnamebuf = prefix;
3780 varnamebuf[1] = ':';
3781 STRCPY(varnamebuf + 2, name);
3782 return varnamebuf;
3786 * Function given to ExpandGeneric() to obtain the list of user defined
3787 * (global/buffer/window/built-in) variable names.
3789 char_u *
3790 get_user_var_name(xp, idx)
3791 expand_T *xp;
3792 int idx;
3794 static long_u gdone;
3795 static long_u bdone;
3796 static long_u wdone;
3797 #ifdef FEAT_WINDOWS
3798 static long_u tdone;
3799 #endif
3800 static int vidx;
3801 static hashitem_T *hi;
3802 hashtab_T *ht;
3804 if (idx == 0)
3806 gdone = bdone = wdone = vidx = 0;
3807 #ifdef FEAT_WINDOWS
3808 tdone = 0;
3809 #endif
3812 /* Global variables */
3813 if (gdone < globvarht.ht_used)
3815 if (gdone++ == 0)
3816 hi = globvarht.ht_array;
3817 else
3818 ++hi;
3819 while (HASHITEM_EMPTY(hi))
3820 ++hi;
3821 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3822 return cat_prefix_varname('g', hi->hi_key);
3823 return hi->hi_key;
3826 /* b: variables */
3827 ht = &curbuf->b_vars.dv_hashtab;
3828 if (bdone < ht->ht_used)
3830 if (bdone++ == 0)
3831 hi = ht->ht_array;
3832 else
3833 ++hi;
3834 while (HASHITEM_EMPTY(hi))
3835 ++hi;
3836 return cat_prefix_varname('b', hi->hi_key);
3838 if (bdone == ht->ht_used)
3840 ++bdone;
3841 return (char_u *)"b:changedtick";
3844 /* w: variables */
3845 ht = &curwin->w_vars.dv_hashtab;
3846 if (wdone < ht->ht_used)
3848 if (wdone++ == 0)
3849 hi = ht->ht_array;
3850 else
3851 ++hi;
3852 while (HASHITEM_EMPTY(hi))
3853 ++hi;
3854 return cat_prefix_varname('w', hi->hi_key);
3857 #ifdef FEAT_WINDOWS
3858 /* t: variables */
3859 ht = &curtab->tp_vars.dv_hashtab;
3860 if (tdone < ht->ht_used)
3862 if (tdone++ == 0)
3863 hi = ht->ht_array;
3864 else
3865 ++hi;
3866 while (HASHITEM_EMPTY(hi))
3867 ++hi;
3868 return cat_prefix_varname('t', hi->hi_key);
3870 #endif
3872 /* v: variables */
3873 if (vidx < VV_LEN)
3874 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3876 vim_free(varnamebuf);
3877 varnamebuf = NULL;
3878 varnamebuflen = 0;
3879 return NULL;
3882 #endif /* FEAT_CMDL_COMPL */
3885 * types for expressions.
3887 typedef enum
3889 TYPE_UNKNOWN = 0
3890 , TYPE_EQUAL /* == */
3891 , TYPE_NEQUAL /* != */
3892 , TYPE_GREATER /* > */
3893 , TYPE_GEQUAL /* >= */
3894 , TYPE_SMALLER /* < */
3895 , TYPE_SEQUAL /* <= */
3896 , TYPE_MATCH /* =~ */
3897 , TYPE_NOMATCH /* !~ */
3898 } exptype_T;
3901 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3902 * executed. The function may return OK, but the rettv will be of type
3903 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3907 * Handle zero level expression.
3908 * This calls eval1() and handles error message and nextcmd.
3909 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3910 * Note: "rettv.v_lock" is not set.
3911 * Return OK or FAIL.
3913 static int
3914 eval0(arg, rettv, nextcmd, evaluate)
3915 char_u *arg;
3916 typval_T *rettv;
3917 char_u **nextcmd;
3918 int evaluate;
3920 int ret;
3921 char_u *p;
3923 p = skipwhite(arg);
3924 ret = eval1(&p, rettv, evaluate);
3925 if (ret == FAIL || !ends_excmd(*p))
3927 if (ret != FAIL)
3928 clear_tv(rettv);
3930 * Report the invalid expression unless the expression evaluation has
3931 * been cancelled due to an aborting error, an interrupt, or an
3932 * exception.
3934 if (!aborting())
3935 EMSG2(_(e_invexpr2), arg);
3936 ret = FAIL;
3938 if (nextcmd != NULL)
3939 *nextcmd = check_nextcmd(p);
3941 return ret;
3945 * Handle top level expression:
3946 * expr2 ? expr1 : expr1
3948 * "arg" must point to the first non-white of the expression.
3949 * "arg" is advanced to the next non-white after the recognized expression.
3951 * Note: "rettv.v_lock" is not set.
3953 * Return OK or FAIL.
3955 static int
3956 eval1(arg, rettv, evaluate)
3957 char_u **arg;
3958 typval_T *rettv;
3959 int evaluate;
3961 int result;
3962 typval_T var2;
3965 * Get the first variable.
3967 if (eval2(arg, rettv, evaluate) == FAIL)
3968 return FAIL;
3970 if ((*arg)[0] == '?')
3972 result = FALSE;
3973 if (evaluate)
3975 int error = FALSE;
3977 if (get_tv_number_chk(rettv, &error) != 0)
3978 result = TRUE;
3979 clear_tv(rettv);
3980 if (error)
3981 return FAIL;
3985 * Get the second variable.
3987 *arg = skipwhite(*arg + 1);
3988 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3989 return FAIL;
3992 * Check for the ":".
3994 if ((*arg)[0] != ':')
3996 EMSG(_("E109: Missing ':' after '?'"));
3997 if (evaluate && result)
3998 clear_tv(rettv);
3999 return FAIL;
4003 * Get the third variable.
4005 *arg = skipwhite(*arg + 1);
4006 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
4008 if (evaluate && result)
4009 clear_tv(rettv);
4010 return FAIL;
4012 if (evaluate && !result)
4013 *rettv = var2;
4016 return OK;
4020 * Handle first level expression:
4021 * expr2 || expr2 || expr2 logical OR
4023 * "arg" must point to the first non-white of the expression.
4024 * "arg" is advanced to the next non-white after the recognized expression.
4026 * Return OK or FAIL.
4028 static int
4029 eval2(arg, rettv, evaluate)
4030 char_u **arg;
4031 typval_T *rettv;
4032 int evaluate;
4034 typval_T var2;
4035 long result;
4036 int first;
4037 int error = FALSE;
4040 * Get the first variable.
4042 if (eval3(arg, rettv, evaluate) == FAIL)
4043 return FAIL;
4046 * Repeat until there is no following "||".
4048 first = TRUE;
4049 result = FALSE;
4050 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4052 if (evaluate && first)
4054 if (get_tv_number_chk(rettv, &error) != 0)
4055 result = TRUE;
4056 clear_tv(rettv);
4057 if (error)
4058 return FAIL;
4059 first = FALSE;
4063 * Get the second variable.
4065 *arg = skipwhite(*arg + 2);
4066 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4067 return FAIL;
4070 * Compute the result.
4072 if (evaluate && !result)
4074 if (get_tv_number_chk(&var2, &error) != 0)
4075 result = TRUE;
4076 clear_tv(&var2);
4077 if (error)
4078 return FAIL;
4080 if (evaluate)
4082 rettv->v_type = VAR_NUMBER;
4083 rettv->vval.v_number = result;
4087 return OK;
4091 * Handle second level expression:
4092 * expr3 && expr3 && expr3 logical AND
4094 * "arg" must point to the first non-white of the expression.
4095 * "arg" is advanced to the next non-white after the recognized expression.
4097 * Return OK or FAIL.
4099 static int
4100 eval3(arg, rettv, evaluate)
4101 char_u **arg;
4102 typval_T *rettv;
4103 int evaluate;
4105 typval_T var2;
4106 long result;
4107 int first;
4108 int error = FALSE;
4111 * Get the first variable.
4113 if (eval4(arg, rettv, evaluate) == FAIL)
4114 return FAIL;
4117 * Repeat until there is no following "&&".
4119 first = TRUE;
4120 result = TRUE;
4121 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4123 if (evaluate && first)
4125 if (get_tv_number_chk(rettv, &error) == 0)
4126 result = FALSE;
4127 clear_tv(rettv);
4128 if (error)
4129 return FAIL;
4130 first = FALSE;
4134 * Get the second variable.
4136 *arg = skipwhite(*arg + 2);
4137 if (eval4(arg, &var2, evaluate && result) == FAIL)
4138 return FAIL;
4141 * Compute the result.
4143 if (evaluate && result)
4145 if (get_tv_number_chk(&var2, &error) == 0)
4146 result = FALSE;
4147 clear_tv(&var2);
4148 if (error)
4149 return FAIL;
4151 if (evaluate)
4153 rettv->v_type = VAR_NUMBER;
4154 rettv->vval.v_number = result;
4158 return OK;
4162 * Handle third level expression:
4163 * var1 == var2
4164 * var1 =~ var2
4165 * var1 != var2
4166 * var1 !~ var2
4167 * var1 > var2
4168 * var1 >= var2
4169 * var1 < var2
4170 * var1 <= var2
4171 * var1 is var2
4172 * var1 isnot var2
4174 * "arg" must point to the first non-white of the expression.
4175 * "arg" is advanced to the next non-white after the recognized expression.
4177 * Return OK or FAIL.
4179 static int
4180 eval4(arg, rettv, evaluate)
4181 char_u **arg;
4182 typval_T *rettv;
4183 int evaluate;
4185 typval_T var2;
4186 char_u *p;
4187 int i;
4188 exptype_T type = TYPE_UNKNOWN;
4189 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4190 int len = 2;
4191 long n1, n2;
4192 char_u *s1, *s2;
4193 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4194 regmatch_T regmatch;
4195 int ic;
4196 char_u *save_cpo;
4199 * Get the first variable.
4201 if (eval5(arg, rettv, evaluate) == FAIL)
4202 return FAIL;
4204 p = *arg;
4205 switch (p[0])
4207 case '=': if (p[1] == '=')
4208 type = TYPE_EQUAL;
4209 else if (p[1] == '~')
4210 type = TYPE_MATCH;
4211 break;
4212 case '!': if (p[1] == '=')
4213 type = TYPE_NEQUAL;
4214 else if (p[1] == '~')
4215 type = TYPE_NOMATCH;
4216 break;
4217 case '>': if (p[1] != '=')
4219 type = TYPE_GREATER;
4220 len = 1;
4222 else
4223 type = TYPE_GEQUAL;
4224 break;
4225 case '<': if (p[1] != '=')
4227 type = TYPE_SMALLER;
4228 len = 1;
4230 else
4231 type = TYPE_SEQUAL;
4232 break;
4233 case 'i': if (p[1] == 's')
4235 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4236 len = 5;
4237 if (!vim_isIDc(p[len]))
4239 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4240 type_is = TRUE;
4243 break;
4247 * If there is a comparative operator, use it.
4249 if (type != TYPE_UNKNOWN)
4251 /* extra question mark appended: ignore case */
4252 if (p[len] == '?')
4254 ic = TRUE;
4255 ++len;
4257 /* extra '#' appended: match case */
4258 else if (p[len] == '#')
4260 ic = FALSE;
4261 ++len;
4263 /* nothing appended: use 'ignorecase' */
4264 else
4265 ic = p_ic;
4268 * Get the second variable.
4270 *arg = skipwhite(p + len);
4271 if (eval5(arg, &var2, evaluate) == FAIL)
4273 clear_tv(rettv);
4274 return FAIL;
4277 if (evaluate)
4279 if (type_is && rettv->v_type != var2.v_type)
4281 /* For "is" a different type always means FALSE, for "notis"
4282 * it means TRUE. */
4283 n1 = (type == TYPE_NEQUAL);
4285 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4287 if (type_is)
4289 n1 = (rettv->v_type == var2.v_type
4290 && rettv->vval.v_list == var2.vval.v_list);
4291 if (type == TYPE_NEQUAL)
4292 n1 = !n1;
4294 else if (rettv->v_type != var2.v_type
4295 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4297 if (rettv->v_type != var2.v_type)
4298 EMSG(_("E691: Can only compare List with List"));
4299 else
4300 EMSG(_("E692: Invalid operation for Lists"));
4301 clear_tv(rettv);
4302 clear_tv(&var2);
4303 return FAIL;
4305 else
4307 /* Compare two Lists for being equal or unequal. */
4308 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4309 if (type == TYPE_NEQUAL)
4310 n1 = !n1;
4314 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4316 if (type_is)
4318 n1 = (rettv->v_type == var2.v_type
4319 && rettv->vval.v_dict == var2.vval.v_dict);
4320 if (type == TYPE_NEQUAL)
4321 n1 = !n1;
4323 else if (rettv->v_type != var2.v_type
4324 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4326 if (rettv->v_type != var2.v_type)
4327 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4328 else
4329 EMSG(_("E736: Invalid operation for Dictionary"));
4330 clear_tv(rettv);
4331 clear_tv(&var2);
4332 return FAIL;
4334 else
4336 /* Compare two Dictionaries for being equal or unequal. */
4337 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4338 if (type == TYPE_NEQUAL)
4339 n1 = !n1;
4343 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4345 if (rettv->v_type != var2.v_type
4346 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4348 if (rettv->v_type != var2.v_type)
4349 EMSG(_("E693: Can only compare Funcref with Funcref"));
4350 else
4351 EMSG(_("E694: Invalid operation for Funcrefs"));
4352 clear_tv(rettv);
4353 clear_tv(&var2);
4354 return FAIL;
4356 else
4358 /* Compare two Funcrefs for being equal or unequal. */
4359 if (rettv->vval.v_string == NULL
4360 || var2.vval.v_string == NULL)
4361 n1 = FALSE;
4362 else
4363 n1 = STRCMP(rettv->vval.v_string,
4364 var2.vval.v_string) == 0;
4365 if (type == TYPE_NEQUAL)
4366 n1 = !n1;
4370 #ifdef FEAT_FLOAT
4372 * If one of the two variables is a float, compare as a float.
4373 * When using "=~" or "!~", always compare as string.
4375 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4376 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4378 float_T f1, f2;
4380 if (rettv->v_type == VAR_FLOAT)
4381 f1 = rettv->vval.v_float;
4382 else
4383 f1 = get_tv_number(rettv);
4384 if (var2.v_type == VAR_FLOAT)
4385 f2 = var2.vval.v_float;
4386 else
4387 f2 = get_tv_number(&var2);
4388 n1 = FALSE;
4389 switch (type)
4391 case TYPE_EQUAL: n1 = (f1 == f2); break;
4392 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4393 case TYPE_GREATER: n1 = (f1 > f2); break;
4394 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4395 case TYPE_SMALLER: n1 = (f1 < f2); break;
4396 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4397 case TYPE_UNKNOWN:
4398 case TYPE_MATCH:
4399 case TYPE_NOMATCH: break; /* avoid gcc warning */
4402 #endif
4405 * If one of the two variables is a number, compare as a number.
4406 * When using "=~" or "!~", always compare as string.
4408 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4409 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4411 n1 = get_tv_number(rettv);
4412 n2 = get_tv_number(&var2);
4413 switch (type)
4415 case TYPE_EQUAL: n1 = (n1 == n2); break;
4416 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4417 case TYPE_GREATER: n1 = (n1 > n2); break;
4418 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4419 case TYPE_SMALLER: n1 = (n1 < n2); break;
4420 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4421 case TYPE_UNKNOWN:
4422 case TYPE_MATCH:
4423 case TYPE_NOMATCH: break; /* avoid gcc warning */
4426 else
4428 s1 = get_tv_string_buf(rettv, buf1);
4429 s2 = get_tv_string_buf(&var2, buf2);
4430 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4431 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4432 else
4433 i = 0;
4434 n1 = FALSE;
4435 switch (type)
4437 case TYPE_EQUAL: n1 = (i == 0); break;
4438 case TYPE_NEQUAL: n1 = (i != 0); break;
4439 case TYPE_GREATER: n1 = (i > 0); break;
4440 case TYPE_GEQUAL: n1 = (i >= 0); break;
4441 case TYPE_SMALLER: n1 = (i < 0); break;
4442 case TYPE_SEQUAL: n1 = (i <= 0); break;
4444 case TYPE_MATCH:
4445 case TYPE_NOMATCH:
4446 /* avoid 'l' flag in 'cpoptions' */
4447 save_cpo = p_cpo;
4448 p_cpo = (char_u *)"";
4449 regmatch.regprog = vim_regcomp(s2,
4450 RE_MAGIC + RE_STRING);
4451 regmatch.rm_ic = ic;
4452 if (regmatch.regprog != NULL)
4454 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4455 vim_free(regmatch.regprog);
4456 if (type == TYPE_NOMATCH)
4457 n1 = !n1;
4459 p_cpo = save_cpo;
4460 break;
4462 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4465 clear_tv(rettv);
4466 clear_tv(&var2);
4467 rettv->v_type = VAR_NUMBER;
4468 rettv->vval.v_number = n1;
4472 return OK;
4476 * Handle fourth level expression:
4477 * + number addition
4478 * - number subtraction
4479 * . string concatenation
4481 * "arg" must point to the first non-white of the expression.
4482 * "arg" is advanced to the next non-white after the recognized expression.
4484 * Return OK or FAIL.
4486 static int
4487 eval5(arg, rettv, evaluate)
4488 char_u **arg;
4489 typval_T *rettv;
4490 int evaluate;
4492 typval_T var2;
4493 typval_T var3;
4494 int op;
4495 long n1, n2;
4496 #ifdef FEAT_FLOAT
4497 float_T f1 = 0, f2 = 0;
4498 #endif
4499 char_u *s1, *s2;
4500 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4501 char_u *p;
4504 * Get the first variable.
4506 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4507 return FAIL;
4510 * Repeat computing, until no '+', '-' or '.' is following.
4512 for (;;)
4514 op = **arg;
4515 if (op != '+' && op != '-' && op != '.')
4516 break;
4518 if ((op != '+' || rettv->v_type != VAR_LIST)
4519 #ifdef FEAT_FLOAT
4520 && (op == '.' || rettv->v_type != VAR_FLOAT)
4521 #endif
4524 /* For "list + ...", an illegal use of the first operand as
4525 * a number cannot be determined before evaluating the 2nd
4526 * operand: if this is also a list, all is ok.
4527 * For "something . ...", "something - ..." or "non-list + ...",
4528 * we know that the first operand needs to be a string or number
4529 * without evaluating the 2nd operand. So check before to avoid
4530 * side effects after an error. */
4531 if (evaluate && get_tv_string_chk(rettv) == NULL)
4533 clear_tv(rettv);
4534 return FAIL;
4539 * Get the second variable.
4541 *arg = skipwhite(*arg + 1);
4542 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4544 clear_tv(rettv);
4545 return FAIL;
4548 if (evaluate)
4551 * Compute the result.
4553 if (op == '.')
4555 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4556 s2 = get_tv_string_buf_chk(&var2, buf2);
4557 if (s2 == NULL) /* type error ? */
4559 clear_tv(rettv);
4560 clear_tv(&var2);
4561 return FAIL;
4563 p = concat_str(s1, s2);
4564 clear_tv(rettv);
4565 rettv->v_type = VAR_STRING;
4566 rettv->vval.v_string = p;
4568 else if (op == '+' && rettv->v_type == VAR_LIST
4569 && var2.v_type == VAR_LIST)
4571 /* concatenate Lists */
4572 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4573 &var3) == FAIL)
4575 clear_tv(rettv);
4576 clear_tv(&var2);
4577 return FAIL;
4579 clear_tv(rettv);
4580 *rettv = var3;
4582 else
4584 int error = FALSE;
4586 #ifdef FEAT_FLOAT
4587 if (rettv->v_type == VAR_FLOAT)
4589 f1 = rettv->vval.v_float;
4590 n1 = 0;
4592 else
4593 #endif
4595 n1 = get_tv_number_chk(rettv, &error);
4596 if (error)
4598 /* This can only happen for "list + non-list". For
4599 * "non-list + ..." or "something - ...", we returned
4600 * before evaluating the 2nd operand. */
4601 clear_tv(rettv);
4602 return FAIL;
4604 #ifdef FEAT_FLOAT
4605 if (var2.v_type == VAR_FLOAT)
4606 f1 = n1;
4607 #endif
4609 #ifdef FEAT_FLOAT
4610 if (var2.v_type == VAR_FLOAT)
4612 f2 = var2.vval.v_float;
4613 n2 = 0;
4615 else
4616 #endif
4618 n2 = get_tv_number_chk(&var2, &error);
4619 if (error)
4621 clear_tv(rettv);
4622 clear_tv(&var2);
4623 return FAIL;
4625 #ifdef FEAT_FLOAT
4626 if (rettv->v_type == VAR_FLOAT)
4627 f2 = n2;
4628 #endif
4630 clear_tv(rettv);
4632 #ifdef FEAT_FLOAT
4633 /* If there is a float on either side the result is a float. */
4634 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4636 if (op == '+')
4637 f1 = f1 + f2;
4638 else
4639 f1 = f1 - f2;
4640 rettv->v_type = VAR_FLOAT;
4641 rettv->vval.v_float = f1;
4643 else
4644 #endif
4646 if (op == '+')
4647 n1 = n1 + n2;
4648 else
4649 n1 = n1 - n2;
4650 rettv->v_type = VAR_NUMBER;
4651 rettv->vval.v_number = n1;
4654 clear_tv(&var2);
4657 return OK;
4661 * Handle fifth level expression:
4662 * * number multiplication
4663 * / number division
4664 * % number modulo
4666 * "arg" must point to the first non-white of the expression.
4667 * "arg" is advanced to the next non-white after the recognized expression.
4669 * Return OK or FAIL.
4671 static int
4672 eval6(arg, rettv, evaluate, want_string)
4673 char_u **arg;
4674 typval_T *rettv;
4675 int evaluate;
4676 int want_string; /* after "." operator */
4678 typval_T var2;
4679 int op;
4680 long n1, n2;
4681 #ifdef FEAT_FLOAT
4682 int use_float = FALSE;
4683 float_T f1 = 0, f2;
4684 #endif
4685 int error = FALSE;
4688 * Get the first variable.
4690 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4691 return FAIL;
4694 * Repeat computing, until no '*', '/' or '%' is following.
4696 for (;;)
4698 op = **arg;
4699 if (op != '*' && op != '/' && op != '%')
4700 break;
4702 if (evaluate)
4704 #ifdef FEAT_FLOAT
4705 if (rettv->v_type == VAR_FLOAT)
4707 f1 = rettv->vval.v_float;
4708 use_float = TRUE;
4709 n1 = 0;
4711 else
4712 #endif
4713 n1 = get_tv_number_chk(rettv, &error);
4714 clear_tv(rettv);
4715 if (error)
4716 return FAIL;
4718 else
4719 n1 = 0;
4722 * Get the second variable.
4724 *arg = skipwhite(*arg + 1);
4725 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4726 return FAIL;
4728 if (evaluate)
4730 #ifdef FEAT_FLOAT
4731 if (var2.v_type == VAR_FLOAT)
4733 if (!use_float)
4735 f1 = n1;
4736 use_float = TRUE;
4738 f2 = var2.vval.v_float;
4739 n2 = 0;
4741 else
4742 #endif
4744 n2 = get_tv_number_chk(&var2, &error);
4745 clear_tv(&var2);
4746 if (error)
4747 return FAIL;
4748 #ifdef FEAT_FLOAT
4749 if (use_float)
4750 f2 = n2;
4751 #endif
4755 * Compute the result.
4756 * When either side is a float the result is a float.
4758 #ifdef FEAT_FLOAT
4759 if (use_float)
4761 if (op == '*')
4762 f1 = f1 * f2;
4763 else if (op == '/')
4765 /* We rely on the floating point library to handle divide
4766 * by zero to result in "inf" and not a crash. */
4767 f1 = f1 / f2;
4769 else
4771 EMSG(_("E804: Cannot use '%' with Float"));
4772 return FAIL;
4774 rettv->v_type = VAR_FLOAT;
4775 rettv->vval.v_float = f1;
4777 else
4778 #endif
4780 if (op == '*')
4781 n1 = n1 * n2;
4782 else if (op == '/')
4784 if (n2 == 0) /* give an error message? */
4786 if (n1 == 0)
4787 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4788 else if (n1 < 0)
4789 n1 = -0x7fffffffL;
4790 else
4791 n1 = 0x7fffffffL;
4793 else
4794 n1 = n1 / n2;
4796 else
4798 if (n2 == 0) /* give an error message? */
4799 n1 = 0;
4800 else
4801 n1 = n1 % n2;
4803 rettv->v_type = VAR_NUMBER;
4804 rettv->vval.v_number = n1;
4809 return OK;
4813 * Handle sixth level expression:
4814 * number number constant
4815 * "string" string constant
4816 * 'string' literal string constant
4817 * &option-name option value
4818 * @r register contents
4819 * identifier variable value
4820 * function() function call
4821 * $VAR environment variable
4822 * (expression) nested expression
4823 * [expr, expr] List
4824 * {key: val, key: val} Dictionary
4826 * Also handle:
4827 * ! in front logical NOT
4828 * - in front unary minus
4829 * + in front unary plus (ignored)
4830 * trailing [] subscript in String or List
4831 * trailing .name entry in Dictionary
4833 * "arg" must point to the first non-white of the expression.
4834 * "arg" is advanced to the next non-white after the recognized expression.
4836 * Return OK or FAIL.
4838 static int
4839 eval7(arg, rettv, evaluate, want_string)
4840 char_u **arg;
4841 typval_T *rettv;
4842 int evaluate;
4843 int want_string; /* after "." operator */
4845 long n;
4846 int len;
4847 char_u *s;
4848 char_u *start_leader, *end_leader;
4849 int ret = OK;
4850 char_u *alias;
4853 * Initialise variable so that clear_tv() can't mistake this for a
4854 * string and free a string that isn't there.
4856 rettv->v_type = VAR_UNKNOWN;
4859 * Skip '!' and '-' characters. They are handled later.
4861 start_leader = *arg;
4862 while (**arg == '!' || **arg == '-' || **arg == '+')
4863 *arg = skipwhite(*arg + 1);
4864 end_leader = *arg;
4866 switch (**arg)
4869 * Number constant.
4871 case '0':
4872 case '1':
4873 case '2':
4874 case '3':
4875 case '4':
4876 case '5':
4877 case '6':
4878 case '7':
4879 case '8':
4880 case '9':
4882 #ifdef FEAT_FLOAT
4883 char_u *p = skipdigits(*arg + 1);
4884 int get_float = FALSE;
4886 /* We accept a float when the format matches
4887 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4888 * strict to avoid backwards compatibility problems.
4889 * Don't look for a float after the "." operator, so that
4890 * ":let vers = 1.2.3" doesn't fail. */
4891 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4893 get_float = TRUE;
4894 p = skipdigits(p + 2);
4895 if (*p == 'e' || *p == 'E')
4897 ++p;
4898 if (*p == '-' || *p == '+')
4899 ++p;
4900 if (!vim_isdigit(*p))
4901 get_float = FALSE;
4902 else
4903 p = skipdigits(p + 1);
4905 if (ASCII_ISALPHA(*p) || *p == '.')
4906 get_float = FALSE;
4908 if (get_float)
4910 float_T f;
4912 *arg += string2float(*arg, &f);
4913 if (evaluate)
4915 rettv->v_type = VAR_FLOAT;
4916 rettv->vval.v_float = f;
4919 else
4920 #endif
4922 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4923 *arg += len;
4924 if (evaluate)
4926 rettv->v_type = VAR_NUMBER;
4927 rettv->vval.v_number = n;
4930 break;
4934 * String constant: "string".
4936 case '"': ret = get_string_tv(arg, rettv, evaluate);
4937 break;
4940 * Literal string constant: 'str''ing'.
4942 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4943 break;
4946 * List: [expr, expr]
4948 case '[': ret = get_list_tv(arg, rettv, evaluate);
4949 break;
4952 * Dictionary: {key: val, key: val}
4954 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4955 break;
4958 * Option value: &name
4960 case '&': ret = get_option_tv(arg, rettv, evaluate);
4961 break;
4964 * Environment variable: $VAR.
4966 case '$': ret = get_env_tv(arg, rettv, evaluate);
4967 break;
4970 * Register contents: @r.
4972 case '@': ++*arg;
4973 if (evaluate)
4975 rettv->v_type = VAR_STRING;
4976 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4978 if (**arg != NUL)
4979 ++*arg;
4980 break;
4983 * nested expression: (expression).
4985 case '(': *arg = skipwhite(*arg + 1);
4986 ret = eval1(arg, rettv, evaluate); /* recursive! */
4987 if (**arg == ')')
4988 ++*arg;
4989 else if (ret == OK)
4991 EMSG(_("E110: Missing ')'"));
4992 clear_tv(rettv);
4993 ret = FAIL;
4995 break;
4997 default: ret = NOTDONE;
4998 break;
5001 if (ret == NOTDONE)
5004 * Must be a variable or function name.
5005 * Can also be a curly-braces kind of name: {expr}.
5007 s = *arg;
5008 len = get_name_len(arg, &alias, evaluate, TRUE);
5009 if (alias != NULL)
5010 s = alias;
5012 if (len <= 0)
5013 ret = FAIL;
5014 else
5016 if (**arg == '(') /* recursive! */
5018 /* If "s" is the name of a variable of type VAR_FUNC
5019 * use its contents. */
5020 s = deref_func_name(s, &len);
5022 /* Invoke the function. */
5023 ret = get_func_tv(s, len, rettv, arg,
5024 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5025 &len, evaluate, NULL);
5026 /* Stop the expression evaluation when immediately
5027 * aborting on error, or when an interrupt occurred or
5028 * an exception was thrown but not caught. */
5029 if (aborting())
5031 if (ret == OK)
5032 clear_tv(rettv);
5033 ret = FAIL;
5036 else if (evaluate)
5037 ret = get_var_tv(s, len, rettv, TRUE);
5038 else
5039 ret = OK;
5042 if (alias != NULL)
5043 vim_free(alias);
5046 *arg = skipwhite(*arg);
5048 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5049 * expr(expr). */
5050 if (ret == OK)
5051 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5054 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5056 if (ret == OK && evaluate && end_leader > start_leader)
5058 int error = FALSE;
5059 int val = 0;
5060 #ifdef FEAT_FLOAT
5061 float_T f = 0.0;
5063 if (rettv->v_type == VAR_FLOAT)
5064 f = rettv->vval.v_float;
5065 else
5066 #endif
5067 val = get_tv_number_chk(rettv, &error);
5068 if (error)
5070 clear_tv(rettv);
5071 ret = FAIL;
5073 else
5075 while (end_leader > start_leader)
5077 --end_leader;
5078 if (*end_leader == '!')
5080 #ifdef FEAT_FLOAT
5081 if (rettv->v_type == VAR_FLOAT)
5082 f = !f;
5083 else
5084 #endif
5085 val = !val;
5087 else if (*end_leader == '-')
5089 #ifdef FEAT_FLOAT
5090 if (rettv->v_type == VAR_FLOAT)
5091 f = -f;
5092 else
5093 #endif
5094 val = -val;
5097 #ifdef FEAT_FLOAT
5098 if (rettv->v_type == VAR_FLOAT)
5100 clear_tv(rettv);
5101 rettv->vval.v_float = f;
5103 else
5104 #endif
5106 clear_tv(rettv);
5107 rettv->v_type = VAR_NUMBER;
5108 rettv->vval.v_number = val;
5113 return ret;
5117 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5118 * "*arg" points to the '[' or '.'.
5119 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5121 static int
5122 eval_index(arg, rettv, evaluate, verbose)
5123 char_u **arg;
5124 typval_T *rettv;
5125 int evaluate;
5126 int verbose; /* give error messages */
5128 int empty1 = FALSE, empty2 = FALSE;
5129 typval_T var1, var2;
5130 long n1, n2 = 0;
5131 long len = -1;
5132 int range = FALSE;
5133 char_u *s;
5134 char_u *key = NULL;
5136 if (rettv->v_type == VAR_FUNC
5137 #ifdef FEAT_FLOAT
5138 || rettv->v_type == VAR_FLOAT
5139 #endif
5142 if (verbose)
5143 EMSG(_("E695: Cannot index a Funcref"));
5144 return FAIL;
5147 if (**arg == '.')
5150 * dict.name
5152 key = *arg + 1;
5153 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5155 if (len == 0)
5156 return FAIL;
5157 *arg = skipwhite(key + len);
5159 else
5162 * something[idx]
5164 * Get the (first) variable from inside the [].
5166 *arg = skipwhite(*arg + 1);
5167 if (**arg == ':')
5168 empty1 = TRUE;
5169 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5170 return FAIL;
5171 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5173 /* not a number or string */
5174 clear_tv(&var1);
5175 return FAIL;
5179 * Get the second variable from inside the [:].
5181 if (**arg == ':')
5183 range = TRUE;
5184 *arg = skipwhite(*arg + 1);
5185 if (**arg == ']')
5186 empty2 = TRUE;
5187 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5189 if (!empty1)
5190 clear_tv(&var1);
5191 return FAIL;
5193 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5195 /* not a number or string */
5196 if (!empty1)
5197 clear_tv(&var1);
5198 clear_tv(&var2);
5199 return FAIL;
5203 /* Check for the ']'. */
5204 if (**arg != ']')
5206 if (verbose)
5207 EMSG(_(e_missbrac));
5208 clear_tv(&var1);
5209 if (range)
5210 clear_tv(&var2);
5211 return FAIL;
5213 *arg = skipwhite(*arg + 1); /* skip the ']' */
5216 if (evaluate)
5218 n1 = 0;
5219 if (!empty1 && rettv->v_type != VAR_DICT)
5221 n1 = get_tv_number(&var1);
5222 clear_tv(&var1);
5224 if (range)
5226 if (empty2)
5227 n2 = -1;
5228 else
5230 n2 = get_tv_number(&var2);
5231 clear_tv(&var2);
5235 switch (rettv->v_type)
5237 case VAR_NUMBER:
5238 case VAR_STRING:
5239 s = get_tv_string(rettv);
5240 len = (long)STRLEN(s);
5241 if (range)
5243 /* The resulting variable is a substring. If the indexes
5244 * are out of range the result is empty. */
5245 if (n1 < 0)
5247 n1 = len + n1;
5248 if (n1 < 0)
5249 n1 = 0;
5251 if (n2 < 0)
5252 n2 = len + n2;
5253 else if (n2 >= len)
5254 n2 = len;
5255 if (n1 >= len || n2 < 0 || n1 > n2)
5256 s = NULL;
5257 else
5258 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5260 else
5262 /* The resulting variable is a string of a single
5263 * character. If the index is too big or negative the
5264 * result is empty. */
5265 if (n1 >= len || n1 < 0)
5266 s = NULL;
5267 else
5268 s = vim_strnsave(s + n1, 1);
5270 clear_tv(rettv);
5271 rettv->v_type = VAR_STRING;
5272 rettv->vval.v_string = s;
5273 break;
5275 case VAR_LIST:
5276 len = list_len(rettv->vval.v_list);
5277 if (n1 < 0)
5278 n1 = len + n1;
5279 if (!empty1 && (n1 < 0 || n1 >= len))
5281 /* For a range we allow invalid values and return an empty
5282 * list. A list index out of range is an error. */
5283 if (!range)
5285 if (verbose)
5286 EMSGN(_(e_listidx), n1);
5287 return FAIL;
5289 n1 = len;
5291 if (range)
5293 list_T *l;
5294 listitem_T *item;
5296 if (n2 < 0)
5297 n2 = len + n2;
5298 else if (n2 >= len)
5299 n2 = len - 1;
5300 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5301 n2 = -1;
5302 l = list_alloc();
5303 if (l == NULL)
5304 return FAIL;
5305 for (item = list_find(rettv->vval.v_list, n1);
5306 n1 <= n2; ++n1)
5308 if (list_append_tv(l, &item->li_tv) == FAIL)
5310 list_free(l, TRUE);
5311 return FAIL;
5313 item = item->li_next;
5315 clear_tv(rettv);
5316 rettv->v_type = VAR_LIST;
5317 rettv->vval.v_list = l;
5318 ++l->lv_refcount;
5320 else
5322 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5323 clear_tv(rettv);
5324 *rettv = var1;
5326 break;
5328 case VAR_DICT:
5329 if (range)
5331 if (verbose)
5332 EMSG(_(e_dictrange));
5333 if (len == -1)
5334 clear_tv(&var1);
5335 return FAIL;
5338 dictitem_T *item;
5340 if (len == -1)
5342 key = get_tv_string(&var1);
5343 if (*key == NUL)
5345 if (verbose)
5346 EMSG(_(e_emptykey));
5347 clear_tv(&var1);
5348 return FAIL;
5352 item = dict_find(rettv->vval.v_dict, key, (int)len);
5354 if (item == NULL && verbose)
5355 EMSG2(_(e_dictkey), key);
5356 if (len == -1)
5357 clear_tv(&var1);
5358 if (item == NULL)
5359 return FAIL;
5361 copy_tv(&item->di_tv, &var1);
5362 clear_tv(rettv);
5363 *rettv = var1;
5365 break;
5369 return OK;
5373 * Get an option value.
5374 * "arg" points to the '&' or '+' before the option name.
5375 * "arg" is advanced to character after the option name.
5376 * Return OK or FAIL.
5378 static int
5379 get_option_tv(arg, rettv, evaluate)
5380 char_u **arg;
5381 typval_T *rettv; /* when NULL, only check if option exists */
5382 int evaluate;
5384 char_u *option_end;
5385 long numval;
5386 char_u *stringval;
5387 int opt_type;
5388 int c;
5389 int working = (**arg == '+'); /* has("+option") */
5390 int ret = OK;
5391 int opt_flags;
5394 * Isolate the option name and find its value.
5396 option_end = find_option_end(arg, &opt_flags);
5397 if (option_end == NULL)
5399 if (rettv != NULL)
5400 EMSG2(_("E112: Option name missing: %s"), *arg);
5401 return FAIL;
5404 if (!evaluate)
5406 *arg = option_end;
5407 return OK;
5410 c = *option_end;
5411 *option_end = NUL;
5412 opt_type = get_option_value(*arg, &numval,
5413 rettv == NULL ? NULL : &stringval, opt_flags);
5415 if (opt_type == -3) /* invalid name */
5417 if (rettv != NULL)
5418 EMSG2(_("E113: Unknown option: %s"), *arg);
5419 ret = FAIL;
5421 else if (rettv != NULL)
5423 if (opt_type == -2) /* hidden string option */
5425 rettv->v_type = VAR_STRING;
5426 rettv->vval.v_string = NULL;
5428 else if (opt_type == -1) /* hidden number option */
5430 rettv->v_type = VAR_NUMBER;
5431 rettv->vval.v_number = 0;
5433 else if (opt_type == 1) /* number option */
5435 rettv->v_type = VAR_NUMBER;
5436 rettv->vval.v_number = numval;
5438 else /* string option */
5440 rettv->v_type = VAR_STRING;
5441 rettv->vval.v_string = stringval;
5444 else if (working && (opt_type == -2 || opt_type == -1))
5445 ret = FAIL;
5447 *option_end = c; /* put back for error messages */
5448 *arg = option_end;
5450 return ret;
5454 * Allocate a variable for a string constant.
5455 * Return OK or FAIL.
5457 static int
5458 get_string_tv(arg, rettv, evaluate)
5459 char_u **arg;
5460 typval_T *rettv;
5461 int evaluate;
5463 char_u *p;
5464 char_u *name;
5465 int extra = 0;
5468 * Find the end of the string, skipping backslashed characters.
5470 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5472 if (*p == '\\' && p[1] != NUL)
5474 ++p;
5475 /* A "\<x>" form occupies at least 4 characters, and produces up
5476 * to 6 characters: reserve space for 2 extra */
5477 if (*p == '<')
5478 extra += 2;
5482 if (*p != '"')
5484 EMSG2(_("E114: Missing quote: %s"), *arg);
5485 return FAIL;
5488 /* If only parsing, set *arg and return here */
5489 if (!evaluate)
5491 *arg = p + 1;
5492 return OK;
5496 * Copy the string into allocated memory, handling backslashed
5497 * characters.
5499 name = alloc((unsigned)(p - *arg + extra));
5500 if (name == NULL)
5501 return FAIL;
5502 rettv->v_type = VAR_STRING;
5503 rettv->vval.v_string = name;
5505 for (p = *arg + 1; *p != NUL && *p != '"'; )
5507 if (*p == '\\')
5509 switch (*++p)
5511 case 'b': *name++ = BS; ++p; break;
5512 case 'e': *name++ = ESC; ++p; break;
5513 case 'f': *name++ = FF; ++p; break;
5514 case 'n': *name++ = NL; ++p; break;
5515 case 'r': *name++ = CAR; ++p; break;
5516 case 't': *name++ = TAB; ++p; break;
5518 case 'X': /* hex: "\x1", "\x12" */
5519 case 'x':
5520 case 'u': /* Unicode: "\u0023" */
5521 case 'U':
5522 if (vim_isxdigit(p[1]))
5524 int n, nr;
5525 int c = toupper(*p);
5527 if (c == 'X')
5528 n = 2;
5529 else
5530 n = 4;
5531 nr = 0;
5532 while (--n >= 0 && vim_isxdigit(p[1]))
5534 ++p;
5535 nr = (nr << 4) + hex2nr(*p);
5537 ++p;
5538 #ifdef FEAT_MBYTE
5539 /* For "\u" store the number according to
5540 * 'encoding'. */
5541 if (c != 'X')
5542 name += (*mb_char2bytes)(nr, name);
5543 else
5544 #endif
5545 *name++ = nr;
5547 break;
5549 /* octal: "\1", "\12", "\123" */
5550 case '0':
5551 case '1':
5552 case '2':
5553 case '3':
5554 case '4':
5555 case '5':
5556 case '6':
5557 case '7': *name = *p++ - '0';
5558 if (*p >= '0' && *p <= '7')
5560 *name = (*name << 3) + *p++ - '0';
5561 if (*p >= '0' && *p <= '7')
5562 *name = (*name << 3) + *p++ - '0';
5564 ++name;
5565 break;
5567 /* Special key, e.g.: "\<C-W>" */
5568 case '<': extra = trans_special(&p, name, TRUE);
5569 if (extra != 0)
5571 name += extra;
5572 break;
5574 /* FALLTHROUGH */
5576 default: MB_COPY_CHAR(p, name);
5577 break;
5580 else
5581 MB_COPY_CHAR(p, name);
5584 *name = NUL;
5585 *arg = p + 1;
5587 return OK;
5591 * Allocate a variable for a 'str''ing' constant.
5592 * Return OK or FAIL.
5594 static int
5595 get_lit_string_tv(arg, rettv, evaluate)
5596 char_u **arg;
5597 typval_T *rettv;
5598 int evaluate;
5600 char_u *p;
5601 char_u *str;
5602 int reduce = 0;
5605 * Find the end of the string, skipping ''.
5607 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5609 if (*p == '\'')
5611 if (p[1] != '\'')
5612 break;
5613 ++reduce;
5614 ++p;
5618 if (*p != '\'')
5620 EMSG2(_("E115: Missing quote: %s"), *arg);
5621 return FAIL;
5624 /* If only parsing return after setting "*arg" */
5625 if (!evaluate)
5627 *arg = p + 1;
5628 return OK;
5632 * Copy the string into allocated memory, handling '' to ' reduction.
5634 str = alloc((unsigned)((p - *arg) - reduce));
5635 if (str == NULL)
5636 return FAIL;
5637 rettv->v_type = VAR_STRING;
5638 rettv->vval.v_string = str;
5640 for (p = *arg + 1; *p != NUL; )
5642 if (*p == '\'')
5644 if (p[1] != '\'')
5645 break;
5646 ++p;
5648 MB_COPY_CHAR(p, str);
5650 *str = NUL;
5651 *arg = p + 1;
5653 return OK;
5657 * Allocate a variable for a List and fill it from "*arg".
5658 * Return OK or FAIL.
5660 static int
5661 get_list_tv(arg, rettv, evaluate)
5662 char_u **arg;
5663 typval_T *rettv;
5664 int evaluate;
5666 list_T *l = NULL;
5667 typval_T tv;
5668 listitem_T *item;
5670 if (evaluate)
5672 l = list_alloc();
5673 if (l == NULL)
5674 return FAIL;
5677 *arg = skipwhite(*arg + 1);
5678 while (**arg != ']' && **arg != NUL)
5680 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5681 goto failret;
5682 if (evaluate)
5684 item = listitem_alloc();
5685 if (item != NULL)
5687 item->li_tv = tv;
5688 item->li_tv.v_lock = 0;
5689 list_append(l, item);
5691 else
5692 clear_tv(&tv);
5695 if (**arg == ']')
5696 break;
5697 if (**arg != ',')
5699 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5700 goto failret;
5702 *arg = skipwhite(*arg + 1);
5705 if (**arg != ']')
5707 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5708 failret:
5709 if (evaluate)
5710 list_free(l, TRUE);
5711 return FAIL;
5714 *arg = skipwhite(*arg + 1);
5715 if (evaluate)
5717 rettv->v_type = VAR_LIST;
5718 rettv->vval.v_list = l;
5719 ++l->lv_refcount;
5722 return OK;
5726 * Allocate an empty header for a list.
5727 * Caller should take care of the reference count.
5729 list_T *
5730 list_alloc()
5732 list_T *l;
5734 l = (list_T *)alloc_clear(sizeof(list_T));
5735 if (l != NULL)
5737 /* Prepend the list to the list of lists for garbage collection. */
5738 if (first_list != NULL)
5739 first_list->lv_used_prev = l;
5740 l->lv_used_prev = NULL;
5741 l->lv_used_next = first_list;
5742 first_list = l;
5744 return l;
5748 * Allocate an empty list for a return value.
5749 * Returns OK or FAIL.
5751 static int
5752 rettv_list_alloc(rettv)
5753 typval_T *rettv;
5755 list_T *l = list_alloc();
5757 if (l == NULL)
5758 return FAIL;
5760 rettv->vval.v_list = l;
5761 rettv->v_type = VAR_LIST;
5762 ++l->lv_refcount;
5763 return OK;
5767 * Unreference a list: decrement the reference count and free it when it
5768 * becomes zero.
5770 void
5771 list_unref(l)
5772 list_T *l;
5774 if (l != NULL && --l->lv_refcount <= 0)
5775 list_free(l, TRUE);
5779 * Free a list, including all items it points to.
5780 * Ignores the reference count.
5782 void
5783 list_free(l, recurse)
5784 list_T *l;
5785 int recurse; /* Free Lists and Dictionaries recursively. */
5787 listitem_T *item;
5789 /* Remove the list from the list of lists for garbage collection. */
5790 if (l->lv_used_prev == NULL)
5791 first_list = l->lv_used_next;
5792 else
5793 l->lv_used_prev->lv_used_next = l->lv_used_next;
5794 if (l->lv_used_next != NULL)
5795 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5797 for (item = l->lv_first; item != NULL; item = l->lv_first)
5799 /* Remove the item before deleting it. */
5800 l->lv_first = item->li_next;
5801 if (recurse || (item->li_tv.v_type != VAR_LIST
5802 && item->li_tv.v_type != VAR_DICT))
5803 clear_tv(&item->li_tv);
5804 vim_free(item);
5806 vim_free(l);
5810 * Allocate a list item.
5812 static listitem_T *
5813 listitem_alloc()
5815 return (listitem_T *)alloc(sizeof(listitem_T));
5819 * Free a list item. Also clears the value. Does not notify watchers.
5821 static void
5822 listitem_free(item)
5823 listitem_T *item;
5825 clear_tv(&item->li_tv);
5826 vim_free(item);
5830 * Remove a list item from a List and free it. Also clears the value.
5832 static void
5833 listitem_remove(l, item)
5834 list_T *l;
5835 listitem_T *item;
5837 list_remove(l, item, item);
5838 listitem_free(item);
5842 * Get the number of items in a list.
5844 static long
5845 list_len(l)
5846 list_T *l;
5848 if (l == NULL)
5849 return 0L;
5850 return l->lv_len;
5854 * Return TRUE when two lists have exactly the same values.
5856 static int
5857 list_equal(l1, l2, ic)
5858 list_T *l1;
5859 list_T *l2;
5860 int ic; /* ignore case for strings */
5862 listitem_T *item1, *item2;
5864 if (l1 == NULL || l2 == NULL)
5865 return FALSE;
5866 if (l1 == l2)
5867 return TRUE;
5868 if (list_len(l1) != list_len(l2))
5869 return FALSE;
5871 for (item1 = l1->lv_first, item2 = l2->lv_first;
5872 item1 != NULL && item2 != NULL;
5873 item1 = item1->li_next, item2 = item2->li_next)
5874 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5875 return FALSE;
5876 return item1 == NULL && item2 == NULL;
5879 #if defined(FEAT_RUBY) || defined(FEAT_PYTHON) || defined(FEAT_MZSCHEME) \
5880 || defined(PROTO)
5882 * Return the dictitem that an entry in a hashtable points to.
5884 dictitem_T *
5885 dict_lookup(hi)
5886 hashitem_T *hi;
5888 return HI2DI(hi);
5890 #endif
5893 * Return TRUE when two dictionaries have exactly the same key/values.
5895 static int
5896 dict_equal(d1, d2, ic)
5897 dict_T *d1;
5898 dict_T *d2;
5899 int ic; /* ignore case for strings */
5901 hashitem_T *hi;
5902 dictitem_T *item2;
5903 int todo;
5905 if (d1 == NULL || d2 == NULL)
5906 return FALSE;
5907 if (d1 == d2)
5908 return TRUE;
5909 if (dict_len(d1) != dict_len(d2))
5910 return FALSE;
5912 todo = (int)d1->dv_hashtab.ht_used;
5913 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5915 if (!HASHITEM_EMPTY(hi))
5917 item2 = dict_find(d2, hi->hi_key, -1);
5918 if (item2 == NULL)
5919 return FALSE;
5920 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5921 return FALSE;
5922 --todo;
5925 return TRUE;
5929 * Return TRUE if "tv1" and "tv2" have the same value.
5930 * Compares the items just like "==" would compare them, but strings and
5931 * numbers are different. Floats and numbers are also different.
5933 static int
5934 tv_equal(tv1, tv2, ic)
5935 typval_T *tv1;
5936 typval_T *tv2;
5937 int ic; /* ignore case */
5939 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5940 char_u *s1, *s2;
5941 static int recursive = 0; /* cach recursive loops */
5942 int r;
5944 if (tv1->v_type != tv2->v_type)
5945 return FALSE;
5946 /* Catch lists and dicts that have an endless loop by limiting
5947 * recursiveness to 1000. We guess they are equal then. */
5948 if (recursive >= 1000)
5949 return TRUE;
5951 switch (tv1->v_type)
5953 case VAR_LIST:
5954 ++recursive;
5955 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5956 --recursive;
5957 return r;
5959 case VAR_DICT:
5960 ++recursive;
5961 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5962 --recursive;
5963 return r;
5965 case VAR_FUNC:
5966 return (tv1->vval.v_string != NULL
5967 && tv2->vval.v_string != NULL
5968 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5970 case VAR_NUMBER:
5971 return tv1->vval.v_number == tv2->vval.v_number;
5973 #ifdef FEAT_FLOAT
5974 case VAR_FLOAT:
5975 return tv1->vval.v_float == tv2->vval.v_float;
5976 #endif
5978 case VAR_STRING:
5979 s1 = get_tv_string_buf(tv1, buf1);
5980 s2 = get_tv_string_buf(tv2, buf2);
5981 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5984 EMSG2(_(e_intern2), "tv_equal()");
5985 return TRUE;
5989 * Locate item with index "n" in list "l" and return it.
5990 * A negative index is counted from the end; -1 is the last item.
5991 * Returns NULL when "n" is out of range.
5993 static listitem_T *
5994 list_find(l, n)
5995 list_T *l;
5996 long n;
5998 listitem_T *item;
5999 long idx;
6001 if (l == NULL)
6002 return NULL;
6004 /* Negative index is relative to the end. */
6005 if (n < 0)
6006 n = l->lv_len + n;
6008 /* Check for index out of range. */
6009 if (n < 0 || n >= l->lv_len)
6010 return NULL;
6012 /* When there is a cached index may start search from there. */
6013 if (l->lv_idx_item != NULL)
6015 if (n < l->lv_idx / 2)
6017 /* closest to the start of the list */
6018 item = l->lv_first;
6019 idx = 0;
6021 else if (n > (l->lv_idx + l->lv_len) / 2)
6023 /* closest to the end of the list */
6024 item = l->lv_last;
6025 idx = l->lv_len - 1;
6027 else
6029 /* closest to the cached index */
6030 item = l->lv_idx_item;
6031 idx = l->lv_idx;
6034 else
6036 if (n < l->lv_len / 2)
6038 /* closest to the start of the list */
6039 item = l->lv_first;
6040 idx = 0;
6042 else
6044 /* closest to the end of the list */
6045 item = l->lv_last;
6046 idx = l->lv_len - 1;
6050 while (n > idx)
6052 /* search forward */
6053 item = item->li_next;
6054 ++idx;
6056 while (n < idx)
6058 /* search backward */
6059 item = item->li_prev;
6060 --idx;
6063 /* cache the used index */
6064 l->lv_idx = idx;
6065 l->lv_idx_item = item;
6067 return item;
6071 * Get list item "l[idx]" as a number.
6073 static long
6074 list_find_nr(l, idx, errorp)
6075 list_T *l;
6076 long idx;
6077 int *errorp; /* set to TRUE when something wrong */
6079 listitem_T *li;
6081 li = list_find(l, idx);
6082 if (li == NULL)
6084 if (errorp != NULL)
6085 *errorp = TRUE;
6086 return -1L;
6088 return get_tv_number_chk(&li->li_tv, errorp);
6092 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6094 char_u *
6095 list_find_str(l, idx)
6096 list_T *l;
6097 long idx;
6099 listitem_T *li;
6101 li = list_find(l, idx - 1);
6102 if (li == NULL)
6104 EMSGN(_(e_listidx), idx);
6105 return NULL;
6107 return get_tv_string(&li->li_tv);
6111 * Locate "item" list "l" and return its index.
6112 * Returns -1 when "item" is not in the list.
6114 static long
6115 list_idx_of_item(l, item)
6116 list_T *l;
6117 listitem_T *item;
6119 long idx = 0;
6120 listitem_T *li;
6122 if (l == NULL)
6123 return -1;
6124 idx = 0;
6125 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6126 ++idx;
6127 if (li == NULL)
6128 return -1;
6129 return idx;
6133 * Append item "item" to the end of list "l".
6135 static void
6136 list_append(l, item)
6137 list_T *l;
6138 listitem_T *item;
6140 if (l->lv_last == NULL)
6142 /* empty list */
6143 l->lv_first = item;
6144 l->lv_last = item;
6145 item->li_prev = NULL;
6147 else
6149 l->lv_last->li_next = item;
6150 item->li_prev = l->lv_last;
6151 l->lv_last = item;
6153 ++l->lv_len;
6154 item->li_next = NULL;
6158 * Append typval_T "tv" to the end of list "l".
6159 * Return FAIL when out of memory.
6162 list_append_tv(l, tv)
6163 list_T *l;
6164 typval_T *tv;
6166 listitem_T *li = listitem_alloc();
6168 if (li == NULL)
6169 return FAIL;
6170 copy_tv(tv, &li->li_tv);
6171 list_append(l, li);
6172 return OK;
6176 * Add a dictionary to a list. Used by getqflist().
6177 * Return FAIL when out of memory.
6180 list_append_dict(list, dict)
6181 list_T *list;
6182 dict_T *dict;
6184 listitem_T *li = listitem_alloc();
6186 if (li == NULL)
6187 return FAIL;
6188 li->li_tv.v_type = VAR_DICT;
6189 li->li_tv.v_lock = 0;
6190 li->li_tv.vval.v_dict = dict;
6191 list_append(list, li);
6192 ++dict->dv_refcount;
6193 return OK;
6197 * Make a copy of "str" and append it as an item to list "l".
6198 * When "len" >= 0 use "str[len]".
6199 * Returns FAIL when out of memory.
6202 list_append_string(l, str, len)
6203 list_T *l;
6204 char_u *str;
6205 int len;
6207 listitem_T *li = listitem_alloc();
6209 if (li == NULL)
6210 return FAIL;
6211 list_append(l, li);
6212 li->li_tv.v_type = VAR_STRING;
6213 li->li_tv.v_lock = 0;
6214 if (str == NULL)
6215 li->li_tv.vval.v_string = NULL;
6216 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6217 : vim_strsave(str))) == NULL)
6218 return FAIL;
6219 return OK;
6223 * Append "n" to list "l".
6224 * Returns FAIL when out of memory.
6226 static int
6227 list_append_number(l, n)
6228 list_T *l;
6229 varnumber_T n;
6231 listitem_T *li;
6233 li = listitem_alloc();
6234 if (li == NULL)
6235 return FAIL;
6236 li->li_tv.v_type = VAR_NUMBER;
6237 li->li_tv.v_lock = 0;
6238 li->li_tv.vval.v_number = n;
6239 list_append(l, li);
6240 return OK;
6244 * Insert typval_T "tv" in list "l" before "item".
6245 * If "item" is NULL append at the end.
6246 * Return FAIL when out of memory.
6248 static int
6249 list_insert_tv(l, tv, item)
6250 list_T *l;
6251 typval_T *tv;
6252 listitem_T *item;
6254 listitem_T *ni = listitem_alloc();
6256 if (ni == NULL)
6257 return FAIL;
6258 copy_tv(tv, &ni->li_tv);
6259 if (item == NULL)
6260 /* Append new item at end of list. */
6261 list_append(l, ni);
6262 else
6264 /* Insert new item before existing item. */
6265 ni->li_prev = item->li_prev;
6266 ni->li_next = item;
6267 if (item->li_prev == NULL)
6269 l->lv_first = ni;
6270 ++l->lv_idx;
6272 else
6274 item->li_prev->li_next = ni;
6275 l->lv_idx_item = NULL;
6277 item->li_prev = ni;
6278 ++l->lv_len;
6280 return OK;
6284 * Extend "l1" with "l2".
6285 * If "bef" is NULL append at the end, otherwise insert before this item.
6286 * Returns FAIL when out of memory.
6288 static int
6289 list_extend(l1, l2, bef)
6290 list_T *l1;
6291 list_T *l2;
6292 listitem_T *bef;
6294 listitem_T *item;
6295 int todo = l2->lv_len;
6297 /* We also quit the loop when we have inserted the original item count of
6298 * the list, avoid a hang when we extend a list with itself. */
6299 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6300 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6301 return FAIL;
6302 return OK;
6306 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6307 * Return FAIL when out of memory.
6309 static int
6310 list_concat(l1, l2, tv)
6311 list_T *l1;
6312 list_T *l2;
6313 typval_T *tv;
6315 list_T *l;
6317 if (l1 == NULL || l2 == NULL)
6318 return FAIL;
6320 /* make a copy of the first list. */
6321 l = list_copy(l1, FALSE, 0);
6322 if (l == NULL)
6323 return FAIL;
6324 tv->v_type = VAR_LIST;
6325 tv->vval.v_list = l;
6327 /* append all items from the second list */
6328 return list_extend(l, l2, NULL);
6332 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6333 * The refcount of the new list is set to 1.
6334 * See item_copy() for "copyID".
6335 * Returns NULL when out of memory.
6337 static list_T *
6338 list_copy(orig, deep, copyID)
6339 list_T *orig;
6340 int deep;
6341 int copyID;
6343 list_T *copy;
6344 listitem_T *item;
6345 listitem_T *ni;
6347 if (orig == NULL)
6348 return NULL;
6350 copy = list_alloc();
6351 if (copy != NULL)
6353 if (copyID != 0)
6355 /* Do this before adding the items, because one of the items may
6356 * refer back to this list. */
6357 orig->lv_copyID = copyID;
6358 orig->lv_copylist = copy;
6360 for (item = orig->lv_first; item != NULL && !got_int;
6361 item = item->li_next)
6363 ni = listitem_alloc();
6364 if (ni == NULL)
6365 break;
6366 if (deep)
6368 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6370 vim_free(ni);
6371 break;
6374 else
6375 copy_tv(&item->li_tv, &ni->li_tv);
6376 list_append(copy, ni);
6378 ++copy->lv_refcount;
6379 if (item != NULL)
6381 list_unref(copy);
6382 copy = NULL;
6386 return copy;
6390 * Remove items "item" to "item2" from list "l".
6391 * Does not free the listitem or the value!
6393 static void
6394 list_remove(l, item, item2)
6395 list_T *l;
6396 listitem_T *item;
6397 listitem_T *item2;
6399 listitem_T *ip;
6401 /* notify watchers */
6402 for (ip = item; ip != NULL; ip = ip->li_next)
6404 --l->lv_len;
6405 list_fix_watch(l, ip);
6406 if (ip == item2)
6407 break;
6410 if (item2->li_next == NULL)
6411 l->lv_last = item->li_prev;
6412 else
6413 item2->li_next->li_prev = item->li_prev;
6414 if (item->li_prev == NULL)
6415 l->lv_first = item2->li_next;
6416 else
6417 item->li_prev->li_next = item2->li_next;
6418 l->lv_idx_item = NULL;
6422 * Return an allocated string with the string representation of a list.
6423 * May return NULL.
6425 static char_u *
6426 list2string(tv, copyID)
6427 typval_T *tv;
6428 int copyID;
6430 garray_T ga;
6432 if (tv->vval.v_list == NULL)
6433 return NULL;
6434 ga_init2(&ga, (int)sizeof(char), 80);
6435 ga_append(&ga, '[');
6436 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6438 vim_free(ga.ga_data);
6439 return NULL;
6441 ga_append(&ga, ']');
6442 ga_append(&ga, NUL);
6443 return (char_u *)ga.ga_data;
6447 * Join list "l" into a string in "*gap", using separator "sep".
6448 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6449 * Return FAIL or OK.
6451 static int
6452 list_join(gap, l, sep, echo, copyID)
6453 garray_T *gap;
6454 list_T *l;
6455 char_u *sep;
6456 int echo;
6457 int copyID;
6459 int first = TRUE;
6460 char_u *tofree;
6461 char_u numbuf[NUMBUFLEN];
6462 listitem_T *item;
6463 char_u *s;
6465 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6467 if (first)
6468 first = FALSE;
6469 else
6470 ga_concat(gap, sep);
6472 if (echo)
6473 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6474 else
6475 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6476 if (s != NULL)
6477 ga_concat(gap, s);
6478 vim_free(tofree);
6479 if (s == NULL)
6480 return FAIL;
6481 line_breakcheck();
6483 return OK;
6487 * Garbage collection for lists and dictionaries.
6489 * We use reference counts to be able to free most items right away when they
6490 * are no longer used. But for composite items it's possible that it becomes
6491 * unused while the reference count is > 0: When there is a recursive
6492 * reference. Example:
6493 * :let l = [1, 2, 3]
6494 * :let d = {9: l}
6495 * :let l[1] = d
6497 * Since this is quite unusual we handle this with garbage collection: every
6498 * once in a while find out which lists and dicts are not referenced from any
6499 * variable.
6501 * Here is a good reference text about garbage collection (refers to Python
6502 * but it applies to all reference-counting mechanisms):
6503 * http://python.ca/nas/python/gc/
6507 * Do garbage collection for lists and dicts.
6508 * Return TRUE if some memory was freed.
6511 garbage_collect()
6513 int copyID;
6514 buf_T *buf;
6515 win_T *wp;
6516 int i;
6517 funccall_T *fc, **pfc;
6518 int did_free;
6519 int did_free_funccal = FALSE;
6520 #ifdef FEAT_WINDOWS
6521 tabpage_T *tp;
6522 #endif
6524 /* Only do this once. */
6525 want_garbage_collect = FALSE;
6526 may_garbage_collect = FALSE;
6527 garbage_collect_at_exit = FALSE;
6529 /* We advance by two because we add one for items referenced through
6530 * previous_funccal. */
6531 current_copyID += COPYID_INC;
6532 copyID = current_copyID;
6535 * 1. Go through all accessible variables and mark all lists and dicts
6536 * with copyID.
6539 /* Don't free variables in the previous_funccal list unless they are only
6540 * referenced through previous_funccal. This must be first, because if
6541 * the item is referenced elsewhere the funccal must not be freed. */
6542 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
6544 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1);
6545 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1);
6548 /* script-local variables */
6549 for (i = 1; i <= ga_scripts.ga_len; ++i)
6550 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6552 /* buffer-local variables */
6553 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6554 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6556 /* window-local variables */
6557 FOR_ALL_TAB_WINDOWS(tp, wp)
6558 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6560 #ifdef FEAT_WINDOWS
6561 /* tabpage-local variables */
6562 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6563 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6564 #endif
6566 /* global variables */
6567 set_ref_in_ht(&globvarht, copyID);
6569 /* function-local variables */
6570 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6572 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6573 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6576 /* v: vars */
6577 set_ref_in_ht(&vimvarht, copyID);
6580 * 2. Free lists and dictionaries that are not referenced.
6582 did_free = free_unref_items(copyID);
6585 * 3. 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;
6595 did_free_funccal = TRUE;
6597 else
6598 pfc = &(*pfc)->caller;
6600 if (did_free_funccal)
6601 /* When a funccal was freed some more items might be garbage
6602 * collected, so run again. */
6603 (void)garbage_collect();
6605 return did_free;
6609 * Free lists and dictionaries that are no longer referenced.
6611 static int
6612 free_unref_items(copyID)
6613 int copyID;
6615 dict_T *dd;
6616 list_T *ll;
6617 int did_free = FALSE;
6620 * Go through the list of dicts and free items without the copyID.
6622 for (dd = first_dict; dd != NULL; )
6623 if ((dd->dv_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
6625 /* Free the Dictionary and ordinary items it contains, but don't
6626 * recurse into Lists and Dictionaries, they will be in the list
6627 * of dicts or list of lists. */
6628 dict_free(dd, FALSE);
6629 did_free = TRUE;
6631 /* restart, next dict may also have been freed */
6632 dd = first_dict;
6634 else
6635 dd = dd->dv_used_next;
6638 * Go through the list of lists and free items without the copyID.
6639 * But don't free a list that has a watcher (used in a for loop), these
6640 * are not referenced anywhere.
6642 for (ll = first_list; ll != NULL; )
6643 if ((ll->lv_copyID & COPYID_MASK) != (copyID & COPYID_MASK)
6644 && ll->lv_watch == NULL)
6646 /* Free the List and ordinary items it contains, but don't recurse
6647 * into Lists and Dictionaries, they will be in the list of dicts
6648 * or list of lists. */
6649 list_free(ll, FALSE);
6650 did_free = TRUE;
6652 /* restart, next list may also have been freed */
6653 ll = first_list;
6655 else
6656 ll = ll->lv_used_next;
6658 return did_free;
6662 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6664 static void
6665 set_ref_in_ht(ht, copyID)
6666 hashtab_T *ht;
6667 int copyID;
6669 int todo;
6670 hashitem_T *hi;
6672 todo = (int)ht->ht_used;
6673 for (hi = ht->ht_array; todo > 0; ++hi)
6674 if (!HASHITEM_EMPTY(hi))
6676 --todo;
6677 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6682 * Mark all lists and dicts referenced through list "l" with "copyID".
6684 static void
6685 set_ref_in_list(l, copyID)
6686 list_T *l;
6687 int copyID;
6689 listitem_T *li;
6691 for (li = l->lv_first; li != NULL; li = li->li_next)
6692 set_ref_in_item(&li->li_tv, copyID);
6696 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6698 static void
6699 set_ref_in_item(tv, copyID)
6700 typval_T *tv;
6701 int copyID;
6703 dict_T *dd;
6704 list_T *ll;
6706 switch (tv->v_type)
6708 case VAR_DICT:
6709 dd = tv->vval.v_dict;
6710 if (dd != NULL && dd->dv_copyID != copyID)
6712 /* Didn't see this dict yet. */
6713 dd->dv_copyID = copyID;
6714 set_ref_in_ht(&dd->dv_hashtab, copyID);
6716 break;
6718 case VAR_LIST:
6719 ll = tv->vval.v_list;
6720 if (ll != NULL && ll->lv_copyID != copyID)
6722 /* Didn't see this list yet. */
6723 ll->lv_copyID = copyID;
6724 set_ref_in_list(ll, copyID);
6726 break;
6728 return;
6732 * Allocate an empty header for a dictionary.
6734 dict_T *
6735 dict_alloc()
6737 dict_T *d;
6739 d = (dict_T *)alloc(sizeof(dict_T));
6740 if (d != NULL)
6742 /* Add the list to the list of dicts for garbage collection. */
6743 if (first_dict != NULL)
6744 first_dict->dv_used_prev = d;
6745 d->dv_used_next = first_dict;
6746 d->dv_used_prev = NULL;
6747 first_dict = d;
6749 hash_init(&d->dv_hashtab);
6750 d->dv_lock = 0;
6751 d->dv_refcount = 0;
6752 d->dv_copyID = 0;
6754 return d;
6758 * Unreference a Dictionary: decrement the reference count and free it when it
6759 * becomes zero.
6761 static void
6762 dict_unref(d)
6763 dict_T *d;
6765 if (d != NULL && --d->dv_refcount <= 0)
6766 dict_free(d, TRUE);
6770 * Free a Dictionary, including all items it contains.
6771 * Ignores the reference count.
6773 static void
6774 dict_free(d, recurse)
6775 dict_T *d;
6776 int recurse; /* Free Lists and Dictionaries recursively. */
6778 int todo;
6779 hashitem_T *hi;
6780 dictitem_T *di;
6782 /* Remove the dict from the list of dicts for garbage collection. */
6783 if (d->dv_used_prev == NULL)
6784 first_dict = d->dv_used_next;
6785 else
6786 d->dv_used_prev->dv_used_next = d->dv_used_next;
6787 if (d->dv_used_next != NULL)
6788 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6790 /* Lock the hashtab, we don't want it to resize while freeing items. */
6791 hash_lock(&d->dv_hashtab);
6792 todo = (int)d->dv_hashtab.ht_used;
6793 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6795 if (!HASHITEM_EMPTY(hi))
6797 /* Remove the item before deleting it, just in case there is
6798 * something recursive causing trouble. */
6799 di = HI2DI(hi);
6800 hash_remove(&d->dv_hashtab, hi);
6801 if (recurse || (di->di_tv.v_type != VAR_LIST
6802 && di->di_tv.v_type != VAR_DICT))
6803 clear_tv(&di->di_tv);
6804 vim_free(di);
6805 --todo;
6808 hash_clear(&d->dv_hashtab);
6809 vim_free(d);
6813 * Allocate a Dictionary item.
6814 * The "key" is copied to the new item.
6815 * Note that the value of the item "di_tv" still needs to be initialized!
6816 * Returns NULL when out of memory.
6818 dictitem_T *
6819 dictitem_alloc(key)
6820 char_u *key;
6822 dictitem_T *di;
6824 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6825 if (di != NULL)
6827 STRCPY(di->di_key, key);
6828 di->di_flags = 0;
6830 return di;
6834 * Make a copy of a Dictionary item.
6836 static dictitem_T *
6837 dictitem_copy(org)
6838 dictitem_T *org;
6840 dictitem_T *di;
6842 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6843 + STRLEN(org->di_key)));
6844 if (di != NULL)
6846 STRCPY(di->di_key, org->di_key);
6847 di->di_flags = 0;
6848 copy_tv(&org->di_tv, &di->di_tv);
6850 return di;
6854 * Remove item "item" from Dictionary "dict" and free it.
6856 static void
6857 dictitem_remove(dict, item)
6858 dict_T *dict;
6859 dictitem_T *item;
6861 hashitem_T *hi;
6863 hi = hash_find(&dict->dv_hashtab, item->di_key);
6864 if (HASHITEM_EMPTY(hi))
6865 EMSG2(_(e_intern2), "dictitem_remove()");
6866 else
6867 hash_remove(&dict->dv_hashtab, hi);
6868 dictitem_free(item);
6872 * Free a dict item. Also clears the value.
6874 void
6875 dictitem_free(item)
6876 dictitem_T *item;
6878 clear_tv(&item->di_tv);
6879 vim_free(item);
6883 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6884 * The refcount of the new dict is set to 1.
6885 * See item_copy() for "copyID".
6886 * Returns NULL when out of memory.
6888 static dict_T *
6889 dict_copy(orig, deep, copyID)
6890 dict_T *orig;
6891 int deep;
6892 int copyID;
6894 dict_T *copy;
6895 dictitem_T *di;
6896 int todo;
6897 hashitem_T *hi;
6899 if (orig == NULL)
6900 return NULL;
6902 copy = dict_alloc();
6903 if (copy != NULL)
6905 if (copyID != 0)
6907 orig->dv_copyID = copyID;
6908 orig->dv_copydict = copy;
6910 todo = (int)orig->dv_hashtab.ht_used;
6911 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6913 if (!HASHITEM_EMPTY(hi))
6915 --todo;
6917 di = dictitem_alloc(hi->hi_key);
6918 if (di == NULL)
6919 break;
6920 if (deep)
6922 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6923 copyID) == FAIL)
6925 vim_free(di);
6926 break;
6929 else
6930 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6931 if (dict_add(copy, di) == FAIL)
6933 dictitem_free(di);
6934 break;
6939 ++copy->dv_refcount;
6940 if (todo > 0)
6942 dict_unref(copy);
6943 copy = NULL;
6947 return copy;
6951 * Add item "item" to Dictionary "d".
6952 * Returns FAIL when out of memory and when key already existed.
6955 dict_add(d, item)
6956 dict_T *d;
6957 dictitem_T *item;
6959 return hash_add(&d->dv_hashtab, item->di_key);
6963 * Add a number or string entry to dictionary "d".
6964 * When "str" is NULL use number "nr", otherwise use "str".
6965 * Returns FAIL when out of memory and when key already exists.
6968 dict_add_nr_str(d, key, nr, str)
6969 dict_T *d;
6970 char *key;
6971 long nr;
6972 char_u *str;
6974 dictitem_T *item;
6976 item = dictitem_alloc((char_u *)key);
6977 if (item == NULL)
6978 return FAIL;
6979 item->di_tv.v_lock = 0;
6980 if (str == NULL)
6982 item->di_tv.v_type = VAR_NUMBER;
6983 item->di_tv.vval.v_number = nr;
6985 else
6987 item->di_tv.v_type = VAR_STRING;
6988 item->di_tv.vval.v_string = vim_strsave(str);
6990 if (dict_add(d, item) == FAIL)
6992 dictitem_free(item);
6993 return FAIL;
6995 return OK;
6999 * Get the number of items in a Dictionary.
7001 static long
7002 dict_len(d)
7003 dict_T *d;
7005 if (d == NULL)
7006 return 0L;
7007 return (long)d->dv_hashtab.ht_used;
7011 * Find item "key[len]" in Dictionary "d".
7012 * If "len" is negative use strlen(key).
7013 * Returns NULL when not found.
7015 static dictitem_T *
7016 dict_find(d, key, len)
7017 dict_T *d;
7018 char_u *key;
7019 int len;
7021 #define AKEYLEN 200
7022 char_u buf[AKEYLEN];
7023 char_u *akey;
7024 char_u *tofree = NULL;
7025 hashitem_T *hi;
7027 if (len < 0)
7028 akey = key;
7029 else if (len >= AKEYLEN)
7031 tofree = akey = vim_strnsave(key, len);
7032 if (akey == NULL)
7033 return NULL;
7035 else
7037 /* Avoid a malloc/free by using buf[]. */
7038 vim_strncpy(buf, key, len);
7039 akey = buf;
7042 hi = hash_find(&d->dv_hashtab, akey);
7043 vim_free(tofree);
7044 if (HASHITEM_EMPTY(hi))
7045 return NULL;
7046 return HI2DI(hi);
7050 * Get a string item from a dictionary.
7051 * When "save" is TRUE allocate memory for it.
7052 * Returns NULL if the entry doesn't exist or out of memory.
7054 char_u *
7055 get_dict_string(d, key, save)
7056 dict_T *d;
7057 char_u *key;
7058 int save;
7060 dictitem_T *di;
7061 char_u *s;
7063 di = dict_find(d, key, -1);
7064 if (di == NULL)
7065 return NULL;
7066 s = get_tv_string(&di->di_tv);
7067 if (save && s != NULL)
7068 s = vim_strsave(s);
7069 return s;
7073 * Get a number item from a dictionary.
7074 * Returns 0 if the entry doesn't exist or out of memory.
7076 long
7077 get_dict_number(d, key)
7078 dict_T *d;
7079 char_u *key;
7081 dictitem_T *di;
7083 di = dict_find(d, key, -1);
7084 if (di == NULL)
7085 return 0;
7086 return get_tv_number(&di->di_tv);
7090 * Return an allocated string with the string representation of a Dictionary.
7091 * May return NULL.
7093 static char_u *
7094 dict2string(tv, copyID)
7095 typval_T *tv;
7096 int copyID;
7098 garray_T ga;
7099 int first = TRUE;
7100 char_u *tofree;
7101 char_u numbuf[NUMBUFLEN];
7102 hashitem_T *hi;
7103 char_u *s;
7104 dict_T *d;
7105 int todo;
7107 if ((d = tv->vval.v_dict) == NULL)
7108 return NULL;
7109 ga_init2(&ga, (int)sizeof(char), 80);
7110 ga_append(&ga, '{');
7112 todo = (int)d->dv_hashtab.ht_used;
7113 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7115 if (!HASHITEM_EMPTY(hi))
7117 --todo;
7119 if (first)
7120 first = FALSE;
7121 else
7122 ga_concat(&ga, (char_u *)", ");
7124 tofree = string_quote(hi->hi_key, FALSE);
7125 if (tofree != NULL)
7127 ga_concat(&ga, tofree);
7128 vim_free(tofree);
7130 ga_concat(&ga, (char_u *)": ");
7131 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7132 if (s != NULL)
7133 ga_concat(&ga, s);
7134 vim_free(tofree);
7135 if (s == NULL)
7136 break;
7139 if (todo > 0)
7141 vim_free(ga.ga_data);
7142 return NULL;
7145 ga_append(&ga, '}');
7146 ga_append(&ga, NUL);
7147 return (char_u *)ga.ga_data;
7151 * Allocate a variable for a Dictionary and fill it from "*arg".
7152 * Return OK or FAIL. Returns NOTDONE for {expr}.
7154 static int
7155 get_dict_tv(arg, rettv, evaluate)
7156 char_u **arg;
7157 typval_T *rettv;
7158 int evaluate;
7160 dict_T *d = NULL;
7161 typval_T tvkey;
7162 typval_T tv;
7163 char_u *key = NULL;
7164 dictitem_T *item;
7165 char_u *start = skipwhite(*arg + 1);
7166 char_u buf[NUMBUFLEN];
7169 * First check if it's not a curly-braces thing: {expr}.
7170 * Must do this without evaluating, otherwise a function may be called
7171 * twice. Unfortunately this means we need to call eval1() twice for the
7172 * first item.
7173 * But {} is an empty Dictionary.
7175 if (*start != '}')
7177 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7178 return FAIL;
7179 if (*start == '}')
7180 return NOTDONE;
7183 if (evaluate)
7185 d = dict_alloc();
7186 if (d == NULL)
7187 return FAIL;
7189 tvkey.v_type = VAR_UNKNOWN;
7190 tv.v_type = VAR_UNKNOWN;
7192 *arg = skipwhite(*arg + 1);
7193 while (**arg != '}' && **arg != NUL)
7195 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7196 goto failret;
7197 if (**arg != ':')
7199 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7200 clear_tv(&tvkey);
7201 goto failret;
7203 if (evaluate)
7205 key = get_tv_string_buf_chk(&tvkey, buf);
7206 if (key == NULL || *key == NUL)
7208 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7209 if (key != NULL)
7210 EMSG(_(e_emptykey));
7211 clear_tv(&tvkey);
7212 goto failret;
7216 *arg = skipwhite(*arg + 1);
7217 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7219 if (evaluate)
7220 clear_tv(&tvkey);
7221 goto failret;
7223 if (evaluate)
7225 item = dict_find(d, key, -1);
7226 if (item != NULL)
7228 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7229 clear_tv(&tvkey);
7230 clear_tv(&tv);
7231 goto failret;
7233 item = dictitem_alloc(key);
7234 clear_tv(&tvkey);
7235 if (item != NULL)
7237 item->di_tv = tv;
7238 item->di_tv.v_lock = 0;
7239 if (dict_add(d, item) == FAIL)
7240 dictitem_free(item);
7244 if (**arg == '}')
7245 break;
7246 if (**arg != ',')
7248 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7249 goto failret;
7251 *arg = skipwhite(*arg + 1);
7254 if (**arg != '}')
7256 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7257 failret:
7258 if (evaluate)
7259 dict_free(d, TRUE);
7260 return FAIL;
7263 *arg = skipwhite(*arg + 1);
7264 if (evaluate)
7266 rettv->v_type = VAR_DICT;
7267 rettv->vval.v_dict = d;
7268 ++d->dv_refcount;
7271 return OK;
7275 * Return a string with the string representation of a variable.
7276 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7277 * "numbuf" is used for a number.
7278 * Does not put quotes around strings, as ":echo" displays values.
7279 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7280 * May return NULL.
7282 static char_u *
7283 echo_string(tv, tofree, numbuf, copyID)
7284 typval_T *tv;
7285 char_u **tofree;
7286 char_u *numbuf;
7287 int copyID;
7289 static int recurse = 0;
7290 char_u *r = NULL;
7292 if (recurse >= DICT_MAXNEST)
7294 EMSG(_("E724: variable nested too deep for displaying"));
7295 *tofree = NULL;
7296 return NULL;
7298 ++recurse;
7300 switch (tv->v_type)
7302 case VAR_FUNC:
7303 *tofree = NULL;
7304 r = tv->vval.v_string;
7305 break;
7307 case VAR_LIST:
7308 if (tv->vval.v_list == NULL)
7310 *tofree = NULL;
7311 r = NULL;
7313 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7315 *tofree = NULL;
7316 r = (char_u *)"[...]";
7318 else
7320 tv->vval.v_list->lv_copyID = copyID;
7321 *tofree = list2string(tv, copyID);
7322 r = *tofree;
7324 break;
7326 case VAR_DICT:
7327 if (tv->vval.v_dict == NULL)
7329 *tofree = NULL;
7330 r = NULL;
7332 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7334 *tofree = NULL;
7335 r = (char_u *)"{...}";
7337 else
7339 tv->vval.v_dict->dv_copyID = copyID;
7340 *tofree = dict2string(tv, copyID);
7341 r = *tofree;
7343 break;
7345 case VAR_STRING:
7346 case VAR_NUMBER:
7347 *tofree = NULL;
7348 r = get_tv_string_buf(tv, numbuf);
7349 break;
7351 #ifdef FEAT_FLOAT
7352 case VAR_FLOAT:
7353 *tofree = NULL;
7354 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7355 r = numbuf;
7356 break;
7357 #endif
7359 default:
7360 EMSG2(_(e_intern2), "echo_string()");
7361 *tofree = NULL;
7364 --recurse;
7365 return r;
7369 * Return a string with the string representation of a variable.
7370 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7371 * "numbuf" is used for a number.
7372 * Puts quotes around strings, so that they can be parsed back by eval().
7373 * May return NULL.
7375 static char_u *
7376 tv2string(tv, tofree, numbuf, copyID)
7377 typval_T *tv;
7378 char_u **tofree;
7379 char_u *numbuf;
7380 int copyID;
7382 switch (tv->v_type)
7384 case VAR_FUNC:
7385 *tofree = string_quote(tv->vval.v_string, TRUE);
7386 return *tofree;
7387 case VAR_STRING:
7388 *tofree = string_quote(tv->vval.v_string, FALSE);
7389 return *tofree;
7390 #ifdef FEAT_FLOAT
7391 case VAR_FLOAT:
7392 *tofree = NULL;
7393 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7394 return numbuf;
7395 #endif
7396 case VAR_NUMBER:
7397 case VAR_LIST:
7398 case VAR_DICT:
7399 break;
7400 default:
7401 EMSG2(_(e_intern2), "tv2string()");
7403 return echo_string(tv, tofree, numbuf, copyID);
7407 * Return string "str" in ' quotes, doubling ' characters.
7408 * If "str" is NULL an empty string is assumed.
7409 * If "function" is TRUE make it function('string').
7411 static char_u *
7412 string_quote(str, function)
7413 char_u *str;
7414 int function;
7416 unsigned len;
7417 char_u *p, *r, *s;
7419 len = (function ? 13 : 3);
7420 if (str != NULL)
7422 len += (unsigned)STRLEN(str);
7423 for (p = str; *p != NUL; mb_ptr_adv(p))
7424 if (*p == '\'')
7425 ++len;
7427 s = r = alloc(len);
7428 if (r != NULL)
7430 if (function)
7432 STRCPY(r, "function('");
7433 r += 10;
7435 else
7436 *r++ = '\'';
7437 if (str != NULL)
7438 for (p = str; *p != NUL; )
7440 if (*p == '\'')
7441 *r++ = '\'';
7442 MB_COPY_CHAR(p, r);
7444 *r++ = '\'';
7445 if (function)
7446 *r++ = ')';
7447 *r++ = NUL;
7449 return s;
7452 #ifdef FEAT_FLOAT
7454 * Convert the string "text" to a floating point number.
7455 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7456 * this always uses a decimal point.
7457 * Returns the length of the text that was consumed.
7459 static int
7460 string2float(text, value)
7461 char_u *text;
7462 float_T *value; /* result stored here */
7464 char *s = (char *)text;
7465 float_T f;
7467 f = strtod(s, &s);
7468 *value = f;
7469 return (int)((char_u *)s - text);
7471 #endif
7474 * Get the value of an environment variable.
7475 * "arg" is pointing to the '$'. It is advanced to after the name.
7476 * If the environment variable was not set, silently assume it is empty.
7477 * Always return OK.
7479 static int
7480 get_env_tv(arg, rettv, evaluate)
7481 char_u **arg;
7482 typval_T *rettv;
7483 int evaluate;
7485 char_u *string = NULL;
7486 int len;
7487 int cc;
7488 char_u *name;
7489 int mustfree = FALSE;
7491 ++*arg;
7492 name = *arg;
7493 len = get_env_len(arg);
7494 if (evaluate)
7496 if (len != 0)
7498 cc = name[len];
7499 name[len] = NUL;
7500 /* first try vim_getenv(), fast for normal environment vars */
7501 string = vim_getenv(name, &mustfree);
7502 if (string != NULL && *string != NUL)
7504 if (!mustfree)
7505 string = vim_strsave(string);
7507 else
7509 if (mustfree)
7510 vim_free(string);
7512 /* next try expanding things like $VIM and ${HOME} */
7513 string = expand_env_save(name - 1);
7514 if (string != NULL && *string == '$')
7516 vim_free(string);
7517 string = NULL;
7520 name[len] = cc;
7522 rettv->v_type = VAR_STRING;
7523 rettv->vval.v_string = string;
7526 return OK;
7530 * Array with names and number of arguments of all internal functions
7531 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7533 static struct fst
7535 char *f_name; /* function name */
7536 char f_min_argc; /* minimal number of arguments */
7537 char f_max_argc; /* maximal number of arguments */
7538 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7539 /* implementation of function */
7540 } functions[] =
7542 #ifdef FEAT_FLOAT
7543 {"abs", 1, 1, f_abs},
7544 #endif
7545 {"add", 2, 2, f_add},
7546 {"append", 2, 2, f_append},
7547 {"argc", 0, 0, f_argc},
7548 {"argidx", 0, 0, f_argidx},
7549 {"argv", 0, 1, f_argv},
7550 #ifdef FEAT_FLOAT
7551 {"atan", 1, 1, f_atan},
7552 #endif
7553 {"browse", 4, 4, f_browse},
7554 {"browsedir", 2, 2, f_browsedir},
7555 {"bufexists", 1, 1, f_bufexists},
7556 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7557 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7558 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7559 {"buflisted", 1, 1, f_buflisted},
7560 {"bufloaded", 1, 1, f_bufloaded},
7561 {"bufname", 1, 1, f_bufname},
7562 {"bufnr", 1, 2, f_bufnr},
7563 {"bufwinnr", 1, 1, f_bufwinnr},
7564 {"byte2line", 1, 1, f_byte2line},
7565 {"byteidx", 2, 2, f_byteidx},
7566 {"call", 2, 3, f_call},
7567 #ifdef FEAT_FLOAT
7568 {"ceil", 1, 1, f_ceil},
7569 #endif
7570 {"changenr", 0, 0, f_changenr},
7571 {"char2nr", 1, 1, f_char2nr},
7572 {"cindent", 1, 1, f_cindent},
7573 {"clearmatches", 0, 0, f_clearmatches},
7574 {"col", 1, 1, f_col},
7575 #if defined(FEAT_INS_EXPAND)
7576 {"complete", 2, 2, f_complete},
7577 {"complete_add", 1, 1, f_complete_add},
7578 {"complete_check", 0, 0, f_complete_check},
7579 #endif
7580 {"confirm", 1, 4, f_confirm},
7581 {"copy", 1, 1, f_copy},
7582 #ifdef FEAT_FLOAT
7583 {"cos", 1, 1, f_cos},
7584 #endif
7585 {"count", 2, 4, f_count},
7586 {"cscope_connection",0,3, f_cscope_connection},
7587 {"cursor", 1, 3, f_cursor},
7588 {"deepcopy", 1, 2, f_deepcopy},
7589 {"delete", 1, 1, f_delete},
7590 {"did_filetype", 0, 0, f_did_filetype},
7591 {"diff_filler", 1, 1, f_diff_filler},
7592 {"diff_hlID", 2, 2, f_diff_hlID},
7593 {"empty", 1, 1, f_empty},
7594 {"escape", 2, 2, f_escape},
7595 {"eval", 1, 1, f_eval},
7596 {"eventhandler", 0, 0, f_eventhandler},
7597 {"executable", 1, 1, f_executable},
7598 {"exists", 1, 1, f_exists},
7599 {"expand", 1, 2, f_expand},
7600 {"extend", 2, 3, f_extend},
7601 {"feedkeys", 1, 2, f_feedkeys},
7602 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7603 {"filereadable", 1, 1, f_filereadable},
7604 {"filewritable", 1, 1, f_filewritable},
7605 {"filter", 2, 2, f_filter},
7606 {"finddir", 1, 3, f_finddir},
7607 {"findfile", 1, 3, f_findfile},
7608 #ifdef FEAT_FLOAT
7609 {"float2nr", 1, 1, f_float2nr},
7610 {"floor", 1, 1, f_floor},
7611 #endif
7612 {"fnameescape", 1, 1, f_fnameescape},
7613 {"fnamemodify", 2, 2, f_fnamemodify},
7614 {"foldclosed", 1, 1, f_foldclosed},
7615 {"foldclosedend", 1, 1, f_foldclosedend},
7616 {"foldlevel", 1, 1, f_foldlevel},
7617 {"foldtext", 0, 0, f_foldtext},
7618 {"foldtextresult", 1, 1, f_foldtextresult},
7619 {"foreground", 0, 0, f_foreground},
7620 {"function", 1, 1, f_function},
7621 {"garbagecollect", 0, 1, f_garbagecollect},
7622 {"get", 2, 3, f_get},
7623 {"getbufline", 2, 3, f_getbufline},
7624 {"getbufvar", 2, 2, f_getbufvar},
7625 {"getchar", 0, 1, f_getchar},
7626 {"getcharmod", 0, 0, f_getcharmod},
7627 {"getcmdline", 0, 0, f_getcmdline},
7628 {"getcmdpos", 0, 0, f_getcmdpos},
7629 {"getcmdtype", 0, 0, f_getcmdtype},
7630 {"getcwd", 0, 0, f_getcwd},
7631 {"getfontname", 0, 1, f_getfontname},
7632 {"getfperm", 1, 1, f_getfperm},
7633 {"getfsize", 1, 1, f_getfsize},
7634 {"getftime", 1, 1, f_getftime},
7635 {"getftype", 1, 1, f_getftype},
7636 {"getline", 1, 2, f_getline},
7637 {"getloclist", 1, 1, f_getqflist},
7638 {"getmatches", 0, 0, f_getmatches},
7639 {"getpid", 0, 0, f_getpid},
7640 {"getpos", 1, 1, f_getpos},
7641 {"getqflist", 0, 0, f_getqflist},
7642 {"getreg", 0, 2, f_getreg},
7643 {"getregtype", 0, 1, f_getregtype},
7644 {"gettabwinvar", 3, 3, f_gettabwinvar},
7645 {"getwinposx", 0, 0, f_getwinposx},
7646 {"getwinposy", 0, 0, f_getwinposy},
7647 {"getwinvar", 2, 2, f_getwinvar},
7648 {"glob", 1, 2, f_glob},
7649 {"globpath", 2, 3, f_globpath},
7650 {"has", 1, 1, f_has},
7651 {"has_key", 2, 2, f_has_key},
7652 {"haslocaldir", 0, 0, f_haslocaldir},
7653 {"hasmapto", 1, 3, f_hasmapto},
7654 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7655 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7656 {"histadd", 2, 2, f_histadd},
7657 {"histdel", 1, 2, f_histdel},
7658 {"histget", 1, 2, f_histget},
7659 {"histnr", 1, 1, f_histnr},
7660 {"hlID", 1, 1, f_hlID},
7661 {"hlexists", 1, 1, f_hlexists},
7662 {"hostname", 0, 0, f_hostname},
7663 {"iconv", 3, 3, f_iconv},
7664 {"indent", 1, 1, f_indent},
7665 {"index", 2, 4, f_index},
7666 {"input", 1, 3, f_input},
7667 {"inputdialog", 1, 3, f_inputdialog},
7668 {"inputlist", 1, 1, f_inputlist},
7669 {"inputrestore", 0, 0, f_inputrestore},
7670 {"inputsave", 0, 0, f_inputsave},
7671 {"inputsecret", 1, 2, f_inputsecret},
7672 {"insert", 2, 3, f_insert},
7673 {"isdirectory", 1, 1, f_isdirectory},
7674 {"islocked", 1, 1, f_islocked},
7675 {"items", 1, 1, f_items},
7676 {"join", 1, 2, f_join},
7677 {"keys", 1, 1, f_keys},
7678 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7679 {"len", 1, 1, f_len},
7680 {"libcall", 3, 3, f_libcall},
7681 {"libcallnr", 3, 3, f_libcallnr},
7682 {"line", 1, 1, f_line},
7683 {"line2byte", 1, 1, f_line2byte},
7684 {"lispindent", 1, 1, f_lispindent},
7685 {"localtime", 0, 0, f_localtime},
7686 #ifdef FEAT_FLOAT
7687 {"log10", 1, 1, f_log10},
7688 #endif
7689 {"map", 2, 2, f_map},
7690 {"maparg", 1, 3, f_maparg},
7691 {"mapcheck", 1, 3, f_mapcheck},
7692 {"match", 2, 4, f_match},
7693 {"matchadd", 2, 4, f_matchadd},
7694 {"matcharg", 1, 1, f_matcharg},
7695 {"matchdelete", 1, 1, f_matchdelete},
7696 {"matchend", 2, 4, f_matchend},
7697 {"matchlist", 2, 4, f_matchlist},
7698 {"matchstr", 2, 4, f_matchstr},
7699 {"max", 1, 1, f_max},
7700 {"min", 1, 1, f_min},
7701 #ifdef vim_mkdir
7702 {"mkdir", 1, 3, f_mkdir},
7703 #endif
7704 {"mode", 0, 1, f_mode},
7705 #ifdef FEAT_MZSCHEME
7706 {"mzeval", 1, 1, f_mzeval},
7707 #endif
7708 {"nextnonblank", 1, 1, f_nextnonblank},
7709 {"nr2char", 1, 1, f_nr2char},
7710 {"pathshorten", 1, 1, f_pathshorten},
7711 #ifdef FEAT_FLOAT
7712 {"pow", 2, 2, f_pow},
7713 #endif
7714 {"prevnonblank", 1, 1, f_prevnonblank},
7715 {"printf", 2, 19, f_printf},
7716 {"pumvisible", 0, 0, f_pumvisible},
7717 {"range", 1, 3, f_range},
7718 {"readfile", 1, 3, f_readfile},
7719 {"reltime", 0, 2, f_reltime},
7720 {"reltimestr", 1, 1, f_reltimestr},
7721 {"remote_expr", 2, 3, f_remote_expr},
7722 {"remote_foreground", 1, 1, f_remote_foreground},
7723 {"remote_peek", 1, 2, f_remote_peek},
7724 {"remote_read", 1, 1, f_remote_read},
7725 {"remote_send", 2, 3, f_remote_send},
7726 {"remove", 2, 3, f_remove},
7727 {"rename", 2, 2, f_rename},
7728 {"repeat", 2, 2, f_repeat},
7729 {"resolve", 1, 1, f_resolve},
7730 {"reverse", 1, 1, f_reverse},
7731 #ifdef FEAT_FLOAT
7732 {"round", 1, 1, f_round},
7733 #endif
7734 {"search", 1, 4, f_search},
7735 {"searchdecl", 1, 3, f_searchdecl},
7736 {"searchpair", 3, 7, f_searchpair},
7737 {"searchpairpos", 3, 7, f_searchpairpos},
7738 {"searchpos", 1, 4, f_searchpos},
7739 {"server2client", 2, 2, f_server2client},
7740 {"serverlist", 0, 0, f_serverlist},
7741 {"setbufvar", 3, 3, f_setbufvar},
7742 {"setcmdpos", 1, 1, f_setcmdpos},
7743 {"setline", 2, 2, f_setline},
7744 {"setloclist", 2, 3, f_setloclist},
7745 {"setmatches", 1, 1, f_setmatches},
7746 {"setpos", 2, 2, f_setpos},
7747 {"setqflist", 1, 2, f_setqflist},
7748 {"setreg", 2, 3, f_setreg},
7749 {"settabwinvar", 4, 4, f_settabwinvar},
7750 {"setwinvar", 3, 3, f_setwinvar},
7751 {"shellescape", 1, 2, f_shellescape},
7752 {"simplify", 1, 1, f_simplify},
7753 #ifdef FEAT_FLOAT
7754 {"sin", 1, 1, f_sin},
7755 #endif
7756 {"sort", 1, 2, f_sort},
7757 {"soundfold", 1, 1, f_soundfold},
7758 {"spellbadword", 0, 1, f_spellbadword},
7759 {"spellsuggest", 1, 3, f_spellsuggest},
7760 {"split", 1, 3, f_split},
7761 #ifdef FEAT_FLOAT
7762 {"sqrt", 1, 1, f_sqrt},
7763 {"str2float", 1, 1, f_str2float},
7764 #endif
7765 {"str2nr", 1, 2, f_str2nr},
7766 #ifdef HAVE_STRFTIME
7767 {"strftime", 1, 2, f_strftime},
7768 #endif
7769 {"stridx", 2, 3, f_stridx},
7770 {"string", 1, 1, f_string},
7771 {"strlen", 1, 1, f_strlen},
7772 {"strpart", 2, 3, f_strpart},
7773 {"strridx", 2, 3, f_strridx},
7774 {"strtrans", 1, 1, f_strtrans},
7775 {"submatch", 1, 1, f_submatch},
7776 {"substitute", 4, 4, f_substitute},
7777 {"synID", 3, 3, f_synID},
7778 {"synIDattr", 2, 3, f_synIDattr},
7779 {"synIDtrans", 1, 1, f_synIDtrans},
7780 {"synstack", 2, 2, f_synstack},
7781 {"system", 1, 2, f_system},
7782 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7783 {"tabpagenr", 0, 1, f_tabpagenr},
7784 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7785 {"tagfiles", 0, 0, f_tagfiles},
7786 {"taglist", 1, 1, f_taglist},
7787 {"tempname", 0, 0, f_tempname},
7788 {"test", 1, 1, f_test},
7789 {"tolower", 1, 1, f_tolower},
7790 {"toupper", 1, 1, f_toupper},
7791 {"tr", 3, 3, f_tr},
7792 #ifdef FEAT_FLOAT
7793 {"trunc", 1, 1, f_trunc},
7794 #endif
7795 {"type", 1, 1, f_type},
7796 {"values", 1, 1, f_values},
7797 {"virtcol", 1, 1, f_virtcol},
7798 {"visualmode", 0, 1, f_visualmode},
7799 {"winbufnr", 1, 1, f_winbufnr},
7800 {"wincol", 0, 0, f_wincol},
7801 {"winheight", 1, 1, f_winheight},
7802 {"winline", 0, 0, f_winline},
7803 {"winnr", 0, 1, f_winnr},
7804 {"winrestcmd", 0, 0, f_winrestcmd},
7805 {"winrestview", 1, 1, f_winrestview},
7806 {"winsaveview", 0, 0, f_winsaveview},
7807 {"winwidth", 1, 1, f_winwidth},
7808 {"writefile", 2, 3, f_writefile},
7811 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7814 * Function given to ExpandGeneric() to obtain the list of internal
7815 * or user defined function names.
7817 char_u *
7818 get_function_name(xp, idx)
7819 expand_T *xp;
7820 int idx;
7822 static int intidx = -1;
7823 char_u *name;
7825 if (idx == 0)
7826 intidx = -1;
7827 if (intidx < 0)
7829 name = get_user_func_name(xp, idx);
7830 if (name != NULL)
7831 return name;
7833 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7835 STRCPY(IObuff, functions[intidx].f_name);
7836 STRCAT(IObuff, "(");
7837 if (functions[intidx].f_max_argc == 0)
7838 STRCAT(IObuff, ")");
7839 return IObuff;
7842 return NULL;
7846 * Function given to ExpandGeneric() to obtain the list of internal or
7847 * user defined variable or function names.
7849 char_u *
7850 get_expr_name(xp, idx)
7851 expand_T *xp;
7852 int idx;
7854 static int intidx = -1;
7855 char_u *name;
7857 if (idx == 0)
7858 intidx = -1;
7859 if (intidx < 0)
7861 name = get_function_name(xp, idx);
7862 if (name != NULL)
7863 return name;
7865 return get_user_var_name(xp, ++intidx);
7868 #endif /* FEAT_CMDL_COMPL */
7871 * Find internal function in table above.
7872 * Return index, or -1 if not found
7874 static int
7875 find_internal_func(name)
7876 char_u *name; /* name of the function */
7878 int first = 0;
7879 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7880 int cmp;
7881 int x;
7884 * Find the function name in the table. Binary search.
7886 while (first <= last)
7888 x = first + ((unsigned)(last - first) >> 1);
7889 cmp = STRCMP(name, functions[x].f_name);
7890 if (cmp < 0)
7891 last = x - 1;
7892 else if (cmp > 0)
7893 first = x + 1;
7894 else
7895 return x;
7897 return -1;
7901 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7902 * name it contains, otherwise return "name".
7904 static char_u *
7905 deref_func_name(name, lenp)
7906 char_u *name;
7907 int *lenp;
7909 dictitem_T *v;
7910 int cc;
7912 cc = name[*lenp];
7913 name[*lenp] = NUL;
7914 v = find_var(name, NULL);
7915 name[*lenp] = cc;
7916 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7918 if (v->di_tv.vval.v_string == NULL)
7920 *lenp = 0;
7921 return (char_u *)""; /* just in case */
7923 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7924 return v->di_tv.vval.v_string;
7927 return name;
7931 * Allocate a variable for the result of a function.
7932 * Return OK or FAIL.
7934 static int
7935 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7936 evaluate, selfdict)
7937 char_u *name; /* name of the function */
7938 int len; /* length of "name" */
7939 typval_T *rettv;
7940 char_u **arg; /* argument, pointing to the '(' */
7941 linenr_T firstline; /* first line of range */
7942 linenr_T lastline; /* last line of range */
7943 int *doesrange; /* return: function handled range */
7944 int evaluate;
7945 dict_T *selfdict; /* Dictionary for "self" */
7947 char_u *argp;
7948 int ret = OK;
7949 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7950 int argcount = 0; /* number of arguments found */
7953 * Get the arguments.
7955 argp = *arg;
7956 while (argcount < MAX_FUNC_ARGS)
7958 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7959 if (*argp == ')' || *argp == ',' || *argp == NUL)
7960 break;
7961 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7963 ret = FAIL;
7964 break;
7966 ++argcount;
7967 if (*argp != ',')
7968 break;
7970 if (*argp == ')')
7971 ++argp;
7972 else
7973 ret = FAIL;
7975 if (ret == OK)
7976 ret = call_func(name, len, rettv, argcount, argvars,
7977 firstline, lastline, doesrange, evaluate, selfdict);
7978 else if (!aborting())
7980 if (argcount == MAX_FUNC_ARGS)
7981 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
7982 else
7983 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
7986 while (--argcount >= 0)
7987 clear_tv(&argvars[argcount]);
7989 *arg = skipwhite(argp);
7990 return ret;
7995 * Call a function with its resolved parameters
7996 * Return OK when the function can't be called, FAIL otherwise.
7997 * Also returns OK when an error was encountered while executing the function.
7999 static int
8000 call_func(func_name, len, rettv, argcount, argvars, firstline, lastline,
8001 doesrange, evaluate, selfdict)
8002 char_u *func_name; /* name of the function */
8003 int len; /* length of "name" */
8004 typval_T *rettv; /* return value goes here */
8005 int argcount; /* number of "argvars" */
8006 typval_T *argvars; /* vars for arguments, must have "argcount"
8007 PLUS ONE elements! */
8008 linenr_T firstline; /* first line of range */
8009 linenr_T lastline; /* last line of range */
8010 int *doesrange; /* return: function handled range */
8011 int evaluate;
8012 dict_T *selfdict; /* Dictionary for "self" */
8014 int ret = FAIL;
8015 #define ERROR_UNKNOWN 0
8016 #define ERROR_TOOMANY 1
8017 #define ERROR_TOOFEW 2
8018 #define ERROR_SCRIPT 3
8019 #define ERROR_DICT 4
8020 #define ERROR_NONE 5
8021 #define ERROR_OTHER 6
8022 int error = ERROR_NONE;
8023 int i;
8024 int llen;
8025 ufunc_T *fp;
8026 #define FLEN_FIXED 40
8027 char_u fname_buf[FLEN_FIXED + 1];
8028 char_u *fname;
8029 char_u *name;
8031 /* Make a copy of the name, if it comes from a funcref variable it could
8032 * be changed or deleted in the called function. */
8033 name = vim_strnsave(func_name, len);
8034 if (name == NULL)
8035 return ret;
8038 * In a script change <SID>name() and s:name() to K_SNR 123_name().
8039 * Change <SNR>123_name() to K_SNR 123_name().
8040 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
8042 llen = eval_fname_script(name);
8043 if (llen > 0)
8045 fname_buf[0] = K_SPECIAL;
8046 fname_buf[1] = KS_EXTRA;
8047 fname_buf[2] = (int)KE_SNR;
8048 i = 3;
8049 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
8051 if (current_SID <= 0)
8052 error = ERROR_SCRIPT;
8053 else
8055 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
8056 i = (int)STRLEN(fname_buf);
8059 if (i + STRLEN(name + llen) < FLEN_FIXED)
8061 STRCPY(fname_buf + i, name + llen);
8062 fname = fname_buf;
8064 else
8066 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8067 if (fname == NULL)
8068 error = ERROR_OTHER;
8069 else
8071 mch_memmove(fname, fname_buf, (size_t)i);
8072 STRCPY(fname + i, name + llen);
8076 else
8077 fname = name;
8079 *doesrange = FALSE;
8082 /* execute the function if no errors detected and executing */
8083 if (evaluate && error == ERROR_NONE)
8085 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */
8086 rettv->vval.v_number = 0;
8087 error = ERROR_UNKNOWN;
8089 if (!builtin_function(fname))
8092 * User defined function.
8094 fp = find_func(fname);
8096 #ifdef FEAT_AUTOCMD
8097 /* Trigger FuncUndefined event, may load the function. */
8098 if (fp == NULL
8099 && apply_autocmds(EVENT_FUNCUNDEFINED,
8100 fname, fname, TRUE, NULL)
8101 && !aborting())
8103 /* executed an autocommand, search for the function again */
8104 fp = find_func(fname);
8106 #endif
8107 /* Try loading a package. */
8108 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8110 /* loaded a package, search for the function again */
8111 fp = find_func(fname);
8114 if (fp != NULL)
8116 if (fp->uf_flags & FC_RANGE)
8117 *doesrange = TRUE;
8118 if (argcount < fp->uf_args.ga_len)
8119 error = ERROR_TOOFEW;
8120 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8121 error = ERROR_TOOMANY;
8122 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8123 error = ERROR_DICT;
8124 else
8127 * Call the user function.
8128 * Save and restore search patterns, script variables and
8129 * redo buffer.
8131 save_search_patterns();
8132 saveRedobuff();
8133 ++fp->uf_calls;
8134 call_user_func(fp, argcount, argvars, rettv,
8135 firstline, lastline,
8136 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8137 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8138 && fp->uf_refcount <= 0)
8139 /* Function was unreferenced while being used, free it
8140 * now. */
8141 func_free(fp);
8142 restoreRedobuff();
8143 restore_search_patterns();
8144 error = ERROR_NONE;
8148 else
8151 * Find the function name in the table, call its implementation.
8153 i = find_internal_func(fname);
8154 if (i >= 0)
8156 if (argcount < functions[i].f_min_argc)
8157 error = ERROR_TOOFEW;
8158 else if (argcount > functions[i].f_max_argc)
8159 error = ERROR_TOOMANY;
8160 else
8162 argvars[argcount].v_type = VAR_UNKNOWN;
8163 functions[i].f_func(argvars, rettv);
8164 error = ERROR_NONE;
8169 * The function call (or "FuncUndefined" autocommand sequence) might
8170 * have been aborted by an error, an interrupt, or an explicitly thrown
8171 * exception that has not been caught so far. This situation can be
8172 * tested for by calling aborting(). For an error in an internal
8173 * function or for the "E132" error in call_user_func(), however, the
8174 * throw point at which the "force_abort" flag (temporarily reset by
8175 * emsg()) is normally updated has not been reached yet. We need to
8176 * update that flag first to make aborting() reliable.
8178 update_force_abort();
8180 if (error == ERROR_NONE)
8181 ret = OK;
8184 * Report an error unless the argument evaluation or function call has been
8185 * cancelled due to an aborting error, an interrupt, or an exception.
8187 if (!aborting())
8189 switch (error)
8191 case ERROR_UNKNOWN:
8192 emsg_funcname(N_("E117: Unknown function: %s"), name);
8193 break;
8194 case ERROR_TOOMANY:
8195 emsg_funcname(e_toomanyarg, name);
8196 break;
8197 case ERROR_TOOFEW:
8198 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8199 name);
8200 break;
8201 case ERROR_SCRIPT:
8202 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8203 name);
8204 break;
8205 case ERROR_DICT:
8206 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8207 name);
8208 break;
8212 if (fname != name && fname != fname_buf)
8213 vim_free(fname);
8214 vim_free(name);
8216 return ret;
8220 * Give an error message with a function name. Handle <SNR> things.
8221 * "ermsg" is to be passed without translation, use N_() instead of _().
8223 static void
8224 emsg_funcname(ermsg, name)
8225 char *ermsg;
8226 char_u *name;
8228 char_u *p;
8230 if (*name == K_SPECIAL)
8231 p = concat_str((char_u *)"<SNR>", name + 3);
8232 else
8233 p = name;
8234 EMSG2(_(ermsg), p);
8235 if (p != name)
8236 vim_free(p);
8240 * Return TRUE for a non-zero Number and a non-empty String.
8242 static int
8243 non_zero_arg(argvars)
8244 typval_T *argvars;
8246 return ((argvars[0].v_type == VAR_NUMBER
8247 && argvars[0].vval.v_number != 0)
8248 || (argvars[0].v_type == VAR_STRING
8249 && argvars[0].vval.v_string != NULL
8250 && *argvars[0].vval.v_string != NUL));
8253 /*********************************************
8254 * Implementation of the built-in functions
8257 #ifdef FEAT_FLOAT
8259 * "abs(expr)" function
8261 static void
8262 f_abs(argvars, rettv)
8263 typval_T *argvars;
8264 typval_T *rettv;
8266 if (argvars[0].v_type == VAR_FLOAT)
8268 rettv->v_type = VAR_FLOAT;
8269 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8271 else
8273 varnumber_T n;
8274 int error = FALSE;
8276 n = get_tv_number_chk(&argvars[0], &error);
8277 if (error)
8278 rettv->vval.v_number = -1;
8279 else if (n > 0)
8280 rettv->vval.v_number = n;
8281 else
8282 rettv->vval.v_number = -n;
8285 #endif
8288 * "add(list, item)" function
8290 static void
8291 f_add(argvars, rettv)
8292 typval_T *argvars;
8293 typval_T *rettv;
8295 list_T *l;
8297 rettv->vval.v_number = 1; /* Default: Failed */
8298 if (argvars[0].v_type == VAR_LIST)
8300 if ((l = argvars[0].vval.v_list) != NULL
8301 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8302 && list_append_tv(l, &argvars[1]) == OK)
8303 copy_tv(&argvars[0], rettv);
8305 else
8306 EMSG(_(e_listreq));
8310 * "append(lnum, string/list)" function
8312 static void
8313 f_append(argvars, rettv)
8314 typval_T *argvars;
8315 typval_T *rettv;
8317 long lnum;
8318 char_u *line;
8319 list_T *l = NULL;
8320 listitem_T *li = NULL;
8321 typval_T *tv;
8322 long added = 0;
8324 lnum = get_tv_lnum(argvars);
8325 if (lnum >= 0
8326 && lnum <= curbuf->b_ml.ml_line_count
8327 && u_save(lnum, lnum + 1) == OK)
8329 if (argvars[1].v_type == VAR_LIST)
8331 l = argvars[1].vval.v_list;
8332 if (l == NULL)
8333 return;
8334 li = l->lv_first;
8336 for (;;)
8338 if (l == NULL)
8339 tv = &argvars[1]; /* append a string */
8340 else if (li == NULL)
8341 break; /* end of list */
8342 else
8343 tv = &li->li_tv; /* append item from list */
8344 line = get_tv_string_chk(tv);
8345 if (line == NULL) /* type error */
8347 rettv->vval.v_number = 1; /* Failed */
8348 break;
8350 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8351 ++added;
8352 if (l == NULL)
8353 break;
8354 li = li->li_next;
8357 appended_lines_mark(lnum, added);
8358 if (curwin->w_cursor.lnum > lnum)
8359 curwin->w_cursor.lnum += added;
8361 else
8362 rettv->vval.v_number = 1; /* Failed */
8366 * "argc()" function
8368 static void
8369 f_argc(argvars, rettv)
8370 typval_T *argvars UNUSED;
8371 typval_T *rettv;
8373 rettv->vval.v_number = ARGCOUNT;
8377 * "argidx()" function
8379 static void
8380 f_argidx(argvars, rettv)
8381 typval_T *argvars UNUSED;
8382 typval_T *rettv;
8384 rettv->vval.v_number = curwin->w_arg_idx;
8388 * "argv(nr)" function
8390 static void
8391 f_argv(argvars, rettv)
8392 typval_T *argvars;
8393 typval_T *rettv;
8395 int idx;
8397 if (argvars[0].v_type != VAR_UNKNOWN)
8399 idx = get_tv_number_chk(&argvars[0], NULL);
8400 if (idx >= 0 && idx < ARGCOUNT)
8401 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8402 else
8403 rettv->vval.v_string = NULL;
8404 rettv->v_type = VAR_STRING;
8406 else if (rettv_list_alloc(rettv) == OK)
8407 for (idx = 0; idx < ARGCOUNT; ++idx)
8408 list_append_string(rettv->vval.v_list,
8409 alist_name(&ARGLIST[idx]), -1);
8412 #ifdef FEAT_FLOAT
8413 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8416 * Get the float value of "argvars[0]" into "f".
8417 * Returns FAIL when the argument is not a Number or Float.
8419 static int
8420 get_float_arg(argvars, f)
8421 typval_T *argvars;
8422 float_T *f;
8424 if (argvars[0].v_type == VAR_FLOAT)
8426 *f = argvars[0].vval.v_float;
8427 return OK;
8429 if (argvars[0].v_type == VAR_NUMBER)
8431 *f = (float_T)argvars[0].vval.v_number;
8432 return OK;
8434 EMSG(_("E808: Number or Float required"));
8435 return FAIL;
8439 * "atan()" function
8441 static void
8442 f_atan(argvars, rettv)
8443 typval_T *argvars;
8444 typval_T *rettv;
8446 float_T f;
8448 rettv->v_type = VAR_FLOAT;
8449 if (get_float_arg(argvars, &f) == OK)
8450 rettv->vval.v_float = atan(f);
8451 else
8452 rettv->vval.v_float = 0.0;
8454 #endif
8457 * "browse(save, title, initdir, default)" function
8459 static void
8460 f_browse(argvars, rettv)
8461 typval_T *argvars UNUSED;
8462 typval_T *rettv;
8464 #ifdef FEAT_BROWSE
8465 int save;
8466 char_u *title;
8467 char_u *initdir;
8468 char_u *defname;
8469 char_u buf[NUMBUFLEN];
8470 char_u buf2[NUMBUFLEN];
8471 int error = FALSE;
8473 save = get_tv_number_chk(&argvars[0], &error);
8474 title = get_tv_string_chk(&argvars[1]);
8475 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8476 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8478 if (error || title == NULL || initdir == NULL || defname == NULL)
8479 rettv->vval.v_string = NULL;
8480 else
8481 rettv->vval.v_string =
8482 do_browse(save ? BROWSE_SAVE : 0,
8483 title, defname, NULL, initdir, NULL, curbuf);
8484 #else
8485 rettv->vval.v_string = NULL;
8486 #endif
8487 rettv->v_type = VAR_STRING;
8491 * "browsedir(title, initdir)" function
8493 static void
8494 f_browsedir(argvars, rettv)
8495 typval_T *argvars UNUSED;
8496 typval_T *rettv;
8498 #ifdef FEAT_BROWSE
8499 char_u *title;
8500 char_u *initdir;
8501 char_u buf[NUMBUFLEN];
8503 title = get_tv_string_chk(&argvars[0]);
8504 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8506 if (title == NULL || initdir == NULL)
8507 rettv->vval.v_string = NULL;
8508 else
8509 rettv->vval.v_string = do_browse(BROWSE_DIR,
8510 title, NULL, NULL, initdir, NULL, curbuf);
8511 #else
8512 rettv->vval.v_string = NULL;
8513 #endif
8514 rettv->v_type = VAR_STRING;
8517 static buf_T *find_buffer __ARGS((typval_T *avar));
8520 * Find a buffer by number or exact name.
8522 static buf_T *
8523 find_buffer(avar)
8524 typval_T *avar;
8526 buf_T *buf = NULL;
8528 if (avar->v_type == VAR_NUMBER)
8529 buf = buflist_findnr((int)avar->vval.v_number);
8530 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8532 buf = buflist_findname_exp(avar->vval.v_string);
8533 if (buf == NULL)
8535 /* No full path name match, try a match with a URL or a "nofile"
8536 * buffer, these don't use the full path. */
8537 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8538 if (buf->b_fname != NULL
8539 && (path_with_url(buf->b_fname)
8540 #ifdef FEAT_QUICKFIX
8541 || bt_nofile(buf)
8542 #endif
8544 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8545 break;
8548 return buf;
8552 * "bufexists(expr)" function
8554 static void
8555 f_bufexists(argvars, rettv)
8556 typval_T *argvars;
8557 typval_T *rettv;
8559 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8563 * "buflisted(expr)" function
8565 static void
8566 f_buflisted(argvars, rettv)
8567 typval_T *argvars;
8568 typval_T *rettv;
8570 buf_T *buf;
8572 buf = find_buffer(&argvars[0]);
8573 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8577 * "bufloaded(expr)" function
8579 static void
8580 f_bufloaded(argvars, rettv)
8581 typval_T *argvars;
8582 typval_T *rettv;
8584 buf_T *buf;
8586 buf = find_buffer(&argvars[0]);
8587 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8590 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8593 * Get buffer by number or pattern.
8595 static buf_T *
8596 get_buf_tv(tv)
8597 typval_T *tv;
8599 char_u *name = tv->vval.v_string;
8600 int save_magic;
8601 char_u *save_cpo;
8602 buf_T *buf;
8604 if (tv->v_type == VAR_NUMBER)
8605 return buflist_findnr((int)tv->vval.v_number);
8606 if (tv->v_type != VAR_STRING)
8607 return NULL;
8608 if (name == NULL || *name == NUL)
8609 return curbuf;
8610 if (name[0] == '$' && name[1] == NUL)
8611 return lastbuf;
8613 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8614 save_magic = p_magic;
8615 p_magic = TRUE;
8616 save_cpo = p_cpo;
8617 p_cpo = (char_u *)"";
8619 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8620 TRUE, FALSE));
8622 p_magic = save_magic;
8623 p_cpo = save_cpo;
8625 /* If not found, try expanding the name, like done for bufexists(). */
8626 if (buf == NULL)
8627 buf = find_buffer(tv);
8629 return buf;
8633 * "bufname(expr)" function
8635 static void
8636 f_bufname(argvars, rettv)
8637 typval_T *argvars;
8638 typval_T *rettv;
8640 buf_T *buf;
8642 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8643 ++emsg_off;
8644 buf = get_buf_tv(&argvars[0]);
8645 rettv->v_type = VAR_STRING;
8646 if (buf != NULL && buf->b_fname != NULL)
8647 rettv->vval.v_string = vim_strsave(buf->b_fname);
8648 else
8649 rettv->vval.v_string = NULL;
8650 --emsg_off;
8654 * "bufnr(expr)" function
8656 static void
8657 f_bufnr(argvars, rettv)
8658 typval_T *argvars;
8659 typval_T *rettv;
8661 buf_T *buf;
8662 int error = FALSE;
8663 char_u *name;
8665 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8666 ++emsg_off;
8667 buf = get_buf_tv(&argvars[0]);
8668 --emsg_off;
8670 /* If the buffer isn't found and the second argument is not zero create a
8671 * new buffer. */
8672 if (buf == NULL
8673 && argvars[1].v_type != VAR_UNKNOWN
8674 && get_tv_number_chk(&argvars[1], &error) != 0
8675 && !error
8676 && (name = get_tv_string_chk(&argvars[0])) != NULL
8677 && !error)
8678 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8680 if (buf != NULL)
8681 rettv->vval.v_number = buf->b_fnum;
8682 else
8683 rettv->vval.v_number = -1;
8687 * "bufwinnr(nr)" function
8689 static void
8690 f_bufwinnr(argvars, rettv)
8691 typval_T *argvars;
8692 typval_T *rettv;
8694 #ifdef FEAT_WINDOWS
8695 win_T *wp;
8696 int winnr = 0;
8697 #endif
8698 buf_T *buf;
8700 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8701 ++emsg_off;
8702 buf = get_buf_tv(&argvars[0]);
8703 #ifdef FEAT_WINDOWS
8704 for (wp = firstwin; wp; wp = wp->w_next)
8706 ++winnr;
8707 if (wp->w_buffer == buf)
8708 break;
8710 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8711 #else
8712 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8713 #endif
8714 --emsg_off;
8718 * "byte2line(byte)" function
8720 static void
8721 f_byte2line(argvars, rettv)
8722 typval_T *argvars UNUSED;
8723 typval_T *rettv;
8725 #ifndef FEAT_BYTEOFF
8726 rettv->vval.v_number = -1;
8727 #else
8728 long boff = 0;
8730 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8731 if (boff < 0)
8732 rettv->vval.v_number = -1;
8733 else
8734 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8735 (linenr_T)0, &boff);
8736 #endif
8740 * "byteidx()" function
8742 static void
8743 f_byteidx(argvars, rettv)
8744 typval_T *argvars;
8745 typval_T *rettv;
8747 #ifdef FEAT_MBYTE
8748 char_u *t;
8749 #endif
8750 char_u *str;
8751 long idx;
8753 str = get_tv_string_chk(&argvars[0]);
8754 idx = get_tv_number_chk(&argvars[1], NULL);
8755 rettv->vval.v_number = -1;
8756 if (str == NULL || idx < 0)
8757 return;
8759 #ifdef FEAT_MBYTE
8760 t = str;
8761 for ( ; idx > 0; idx--)
8763 if (*t == NUL) /* EOL reached */
8764 return;
8765 t += (*mb_ptr2len)(t);
8767 rettv->vval.v_number = (varnumber_T)(t - str);
8768 #else
8769 if ((size_t)idx <= STRLEN(str))
8770 rettv->vval.v_number = idx;
8771 #endif
8775 * "call(func, arglist)" function
8777 static void
8778 f_call(argvars, rettv)
8779 typval_T *argvars;
8780 typval_T *rettv;
8782 char_u *func;
8783 typval_T argv[MAX_FUNC_ARGS + 1];
8784 int argc = 0;
8785 listitem_T *item;
8786 int dummy;
8787 dict_T *selfdict = NULL;
8789 if (argvars[1].v_type != VAR_LIST)
8791 EMSG(_(e_listreq));
8792 return;
8794 if (argvars[1].vval.v_list == NULL)
8795 return;
8797 if (argvars[0].v_type == VAR_FUNC)
8798 func = argvars[0].vval.v_string;
8799 else
8800 func = get_tv_string(&argvars[0]);
8801 if (*func == NUL)
8802 return; /* type error or empty name */
8804 if (argvars[2].v_type != VAR_UNKNOWN)
8806 if (argvars[2].v_type != VAR_DICT)
8808 EMSG(_(e_dictreq));
8809 return;
8811 selfdict = argvars[2].vval.v_dict;
8814 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8815 item = item->li_next)
8817 if (argc == MAX_FUNC_ARGS)
8819 EMSG(_("E699: Too many arguments"));
8820 break;
8822 /* Make a copy of each argument. This is needed to be able to set
8823 * v_lock to VAR_FIXED in the copy without changing the original list.
8825 copy_tv(&item->li_tv, &argv[argc++]);
8828 if (item == NULL)
8829 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8830 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8831 &dummy, TRUE, selfdict);
8833 /* Free the arguments. */
8834 while (argc > 0)
8835 clear_tv(&argv[--argc]);
8838 #ifdef FEAT_FLOAT
8840 * "ceil({float})" function
8842 static void
8843 f_ceil(argvars, rettv)
8844 typval_T *argvars;
8845 typval_T *rettv;
8847 float_T f;
8849 rettv->v_type = VAR_FLOAT;
8850 if (get_float_arg(argvars, &f) == OK)
8851 rettv->vval.v_float = ceil(f);
8852 else
8853 rettv->vval.v_float = 0.0;
8855 #endif
8858 * "changenr()" function
8860 static void
8861 f_changenr(argvars, rettv)
8862 typval_T *argvars UNUSED;
8863 typval_T *rettv;
8865 rettv->vval.v_number = curbuf->b_u_seq_cur;
8869 * "char2nr(string)" function
8871 static void
8872 f_char2nr(argvars, rettv)
8873 typval_T *argvars;
8874 typval_T *rettv;
8876 #ifdef FEAT_MBYTE
8877 if (has_mbyte)
8878 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8879 else
8880 #endif
8881 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8885 * "cindent(lnum)" function
8887 static void
8888 f_cindent(argvars, rettv)
8889 typval_T *argvars;
8890 typval_T *rettv;
8892 #ifdef FEAT_CINDENT
8893 pos_T pos;
8894 linenr_T lnum;
8896 pos = curwin->w_cursor;
8897 lnum = get_tv_lnum(argvars);
8898 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8900 curwin->w_cursor.lnum = lnum;
8901 rettv->vval.v_number = get_c_indent();
8902 curwin->w_cursor = pos;
8904 else
8905 #endif
8906 rettv->vval.v_number = -1;
8910 * "clearmatches()" function
8912 static void
8913 f_clearmatches(argvars, rettv)
8914 typval_T *argvars UNUSED;
8915 typval_T *rettv UNUSED;
8917 #ifdef FEAT_SEARCH_EXTRA
8918 clear_matches(curwin);
8919 #endif
8923 * "col(string)" function
8925 static void
8926 f_col(argvars, rettv)
8927 typval_T *argvars;
8928 typval_T *rettv;
8930 colnr_T col = 0;
8931 pos_T *fp;
8932 int fnum = curbuf->b_fnum;
8934 fp = var2fpos(&argvars[0], FALSE, &fnum);
8935 if (fp != NULL && fnum == curbuf->b_fnum)
8937 if (fp->col == MAXCOL)
8939 /* '> can be MAXCOL, get the length of the line then */
8940 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8941 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8942 else
8943 col = MAXCOL;
8945 else
8947 col = fp->col + 1;
8948 #ifdef FEAT_VIRTUALEDIT
8949 /* col(".") when the cursor is on the NUL at the end of the line
8950 * because of "coladd" can be seen as an extra column. */
8951 if (virtual_active() && fp == &curwin->w_cursor)
8953 char_u *p = ml_get_cursor();
8955 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8956 curwin->w_virtcol - curwin->w_cursor.coladd))
8958 # ifdef FEAT_MBYTE
8959 int l;
8961 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8962 col += l;
8963 # else
8964 if (*p != NUL && p[1] == NUL)
8965 ++col;
8966 # endif
8969 #endif
8972 rettv->vval.v_number = col;
8975 #if defined(FEAT_INS_EXPAND)
8977 * "complete()" function
8979 static void
8980 f_complete(argvars, rettv)
8981 typval_T *argvars;
8982 typval_T *rettv UNUSED;
8984 int startcol;
8986 if ((State & INSERT) == 0)
8988 EMSG(_("E785: complete() can only be used in Insert mode"));
8989 return;
8992 /* Check for undo allowed here, because if something was already inserted
8993 * the line was already saved for undo and this check isn't done. */
8994 if (!undo_allowed())
8995 return;
8997 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8999 EMSG(_(e_invarg));
9000 return;
9003 startcol = get_tv_number_chk(&argvars[0], NULL);
9004 if (startcol <= 0)
9005 return;
9007 set_completion(startcol - 1, argvars[1].vval.v_list);
9011 * "complete_add()" function
9013 static void
9014 f_complete_add(argvars, rettv)
9015 typval_T *argvars;
9016 typval_T *rettv;
9018 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
9022 * "complete_check()" function
9024 static void
9025 f_complete_check(argvars, rettv)
9026 typval_T *argvars UNUSED;
9027 typval_T *rettv;
9029 int saved = RedrawingDisabled;
9031 RedrawingDisabled = 0;
9032 ins_compl_check_keys(0);
9033 rettv->vval.v_number = compl_interrupted;
9034 RedrawingDisabled = saved;
9036 #endif
9039 * "confirm(message, buttons[, default [, type]])" function
9041 static void
9042 f_confirm(argvars, rettv)
9043 typval_T *argvars UNUSED;
9044 typval_T *rettv UNUSED;
9046 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
9047 char_u *message;
9048 char_u *buttons = NULL;
9049 char_u buf[NUMBUFLEN];
9050 char_u buf2[NUMBUFLEN];
9051 int def = 1;
9052 int type = VIM_GENERIC;
9053 char_u *typestr;
9054 int error = FALSE;
9056 message = get_tv_string_chk(&argvars[0]);
9057 if (message == NULL)
9058 error = TRUE;
9059 if (argvars[1].v_type != VAR_UNKNOWN)
9061 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9062 if (buttons == NULL)
9063 error = TRUE;
9064 if (argvars[2].v_type != VAR_UNKNOWN)
9066 def = get_tv_number_chk(&argvars[2], &error);
9067 if (argvars[3].v_type != VAR_UNKNOWN)
9069 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9070 if (typestr == NULL)
9071 error = TRUE;
9072 else
9074 switch (TOUPPER_ASC(*typestr))
9076 case 'E': type = VIM_ERROR; break;
9077 case 'Q': type = VIM_QUESTION; break;
9078 case 'I': type = VIM_INFO; break;
9079 case 'W': type = VIM_WARNING; break;
9080 case 'G': type = VIM_GENERIC; break;
9087 if (buttons == NULL || *buttons == NUL)
9088 buttons = (char_u *)_("&Ok");
9090 if (!error)
9091 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9092 def, NULL);
9093 #endif
9097 * "copy()" function
9099 static void
9100 f_copy(argvars, rettv)
9101 typval_T *argvars;
9102 typval_T *rettv;
9104 item_copy(&argvars[0], rettv, FALSE, 0);
9107 #ifdef FEAT_FLOAT
9109 * "cos()" function
9111 static void
9112 f_cos(argvars, rettv)
9113 typval_T *argvars;
9114 typval_T *rettv;
9116 float_T f;
9118 rettv->v_type = VAR_FLOAT;
9119 if (get_float_arg(argvars, &f) == OK)
9120 rettv->vval.v_float = cos(f);
9121 else
9122 rettv->vval.v_float = 0.0;
9124 #endif
9127 * "count()" function
9129 static void
9130 f_count(argvars, rettv)
9131 typval_T *argvars;
9132 typval_T *rettv;
9134 long n = 0;
9135 int ic = FALSE;
9137 if (argvars[0].v_type == VAR_LIST)
9139 listitem_T *li;
9140 list_T *l;
9141 long idx;
9143 if ((l = argvars[0].vval.v_list) != NULL)
9145 li = l->lv_first;
9146 if (argvars[2].v_type != VAR_UNKNOWN)
9148 int error = FALSE;
9150 ic = get_tv_number_chk(&argvars[2], &error);
9151 if (argvars[3].v_type != VAR_UNKNOWN)
9153 idx = get_tv_number_chk(&argvars[3], &error);
9154 if (!error)
9156 li = list_find(l, idx);
9157 if (li == NULL)
9158 EMSGN(_(e_listidx), idx);
9161 if (error)
9162 li = NULL;
9165 for ( ; li != NULL; li = li->li_next)
9166 if (tv_equal(&li->li_tv, &argvars[1], ic))
9167 ++n;
9170 else if (argvars[0].v_type == VAR_DICT)
9172 int todo;
9173 dict_T *d;
9174 hashitem_T *hi;
9176 if ((d = argvars[0].vval.v_dict) != NULL)
9178 int error = FALSE;
9180 if (argvars[2].v_type != VAR_UNKNOWN)
9182 ic = get_tv_number_chk(&argvars[2], &error);
9183 if (argvars[3].v_type != VAR_UNKNOWN)
9184 EMSG(_(e_invarg));
9187 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9188 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9190 if (!HASHITEM_EMPTY(hi))
9192 --todo;
9193 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9194 ++n;
9199 else
9200 EMSG2(_(e_listdictarg), "count()");
9201 rettv->vval.v_number = n;
9205 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9207 * Checks the existence of a cscope connection.
9209 static void
9210 f_cscope_connection(argvars, rettv)
9211 typval_T *argvars UNUSED;
9212 typval_T *rettv UNUSED;
9214 #ifdef FEAT_CSCOPE
9215 int num = 0;
9216 char_u *dbpath = NULL;
9217 char_u *prepend = NULL;
9218 char_u buf[NUMBUFLEN];
9220 if (argvars[0].v_type != VAR_UNKNOWN
9221 && argvars[1].v_type != VAR_UNKNOWN)
9223 num = (int)get_tv_number(&argvars[0]);
9224 dbpath = get_tv_string(&argvars[1]);
9225 if (argvars[2].v_type != VAR_UNKNOWN)
9226 prepend = get_tv_string_buf(&argvars[2], buf);
9229 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9230 #endif
9234 * "cursor(lnum, col)" function
9236 * Moves the cursor to the specified line and column.
9237 * Returns 0 when the position could be set, -1 otherwise.
9239 static void
9240 f_cursor(argvars, rettv)
9241 typval_T *argvars;
9242 typval_T *rettv;
9244 long line, col;
9245 #ifdef FEAT_VIRTUALEDIT
9246 long coladd = 0;
9247 #endif
9249 rettv->vval.v_number = -1;
9250 if (argvars[1].v_type == VAR_UNKNOWN)
9252 pos_T pos;
9254 if (list2fpos(argvars, &pos, NULL) == FAIL)
9255 return;
9256 line = pos.lnum;
9257 col = pos.col;
9258 #ifdef FEAT_VIRTUALEDIT
9259 coladd = pos.coladd;
9260 #endif
9262 else
9264 line = get_tv_lnum(argvars);
9265 col = get_tv_number_chk(&argvars[1], NULL);
9266 #ifdef FEAT_VIRTUALEDIT
9267 if (argvars[2].v_type != VAR_UNKNOWN)
9268 coladd = get_tv_number_chk(&argvars[2], NULL);
9269 #endif
9271 if (line < 0 || col < 0
9272 #ifdef FEAT_VIRTUALEDIT
9273 || coladd < 0
9274 #endif
9276 return; /* type error; errmsg already given */
9277 if (line > 0)
9278 curwin->w_cursor.lnum = line;
9279 if (col > 0)
9280 curwin->w_cursor.col = col - 1;
9281 #ifdef FEAT_VIRTUALEDIT
9282 curwin->w_cursor.coladd = coladd;
9283 #endif
9285 /* Make sure the cursor is in a valid position. */
9286 check_cursor();
9287 #ifdef FEAT_MBYTE
9288 /* Correct cursor for multi-byte character. */
9289 if (has_mbyte)
9290 mb_adjust_cursor();
9291 #endif
9293 curwin->w_set_curswant = TRUE;
9294 rettv->vval.v_number = 0;
9298 * "deepcopy()" function
9300 static void
9301 f_deepcopy(argvars, rettv)
9302 typval_T *argvars;
9303 typval_T *rettv;
9305 int noref = 0;
9307 if (argvars[1].v_type != VAR_UNKNOWN)
9308 noref = get_tv_number_chk(&argvars[1], NULL);
9309 if (noref < 0 || noref > 1)
9310 EMSG(_(e_invarg));
9311 else
9313 current_copyID += COPYID_INC;
9314 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? current_copyID : 0);
9319 * "delete()" function
9321 static void
9322 f_delete(argvars, rettv)
9323 typval_T *argvars;
9324 typval_T *rettv;
9326 if (check_restricted() || check_secure())
9327 rettv->vval.v_number = -1;
9328 else
9329 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9333 * "did_filetype()" function
9335 static void
9336 f_did_filetype(argvars, rettv)
9337 typval_T *argvars UNUSED;
9338 typval_T *rettv UNUSED;
9340 #ifdef FEAT_AUTOCMD
9341 rettv->vval.v_number = did_filetype;
9342 #endif
9346 * "diff_filler()" function
9348 static void
9349 f_diff_filler(argvars, rettv)
9350 typval_T *argvars UNUSED;
9351 typval_T *rettv UNUSED;
9353 #ifdef FEAT_DIFF
9354 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9355 #endif
9359 * "diff_hlID()" function
9361 static void
9362 f_diff_hlID(argvars, rettv)
9363 typval_T *argvars UNUSED;
9364 typval_T *rettv UNUSED;
9366 #ifdef FEAT_DIFF
9367 linenr_T lnum = get_tv_lnum(argvars);
9368 static linenr_T prev_lnum = 0;
9369 static int changedtick = 0;
9370 static int fnum = 0;
9371 static int change_start = 0;
9372 static int change_end = 0;
9373 static hlf_T hlID = (hlf_T)0;
9374 int filler_lines;
9375 int col;
9377 if (lnum < 0) /* ignore type error in {lnum} arg */
9378 lnum = 0;
9379 if (lnum != prev_lnum
9380 || changedtick != curbuf->b_changedtick
9381 || fnum != curbuf->b_fnum)
9383 /* New line, buffer, change: need to get the values. */
9384 filler_lines = diff_check(curwin, lnum);
9385 if (filler_lines < 0)
9387 if (filler_lines == -1)
9389 change_start = MAXCOL;
9390 change_end = -1;
9391 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9392 hlID = HLF_ADD; /* added line */
9393 else
9394 hlID = HLF_CHD; /* changed line */
9396 else
9397 hlID = HLF_ADD; /* added line */
9399 else
9400 hlID = (hlf_T)0;
9401 prev_lnum = lnum;
9402 changedtick = curbuf->b_changedtick;
9403 fnum = curbuf->b_fnum;
9406 if (hlID == HLF_CHD || hlID == HLF_TXD)
9408 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9409 if (col >= change_start && col <= change_end)
9410 hlID = HLF_TXD; /* changed text */
9411 else
9412 hlID = HLF_CHD; /* changed line */
9414 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9415 #endif
9419 * "empty({expr})" function
9421 static void
9422 f_empty(argvars, rettv)
9423 typval_T *argvars;
9424 typval_T *rettv;
9426 int n;
9428 switch (argvars[0].v_type)
9430 case VAR_STRING:
9431 case VAR_FUNC:
9432 n = argvars[0].vval.v_string == NULL
9433 || *argvars[0].vval.v_string == NUL;
9434 break;
9435 case VAR_NUMBER:
9436 n = argvars[0].vval.v_number == 0;
9437 break;
9438 #ifdef FEAT_FLOAT
9439 case VAR_FLOAT:
9440 n = argvars[0].vval.v_float == 0.0;
9441 break;
9442 #endif
9443 case VAR_LIST:
9444 n = argvars[0].vval.v_list == NULL
9445 || argvars[0].vval.v_list->lv_first == NULL;
9446 break;
9447 case VAR_DICT:
9448 n = argvars[0].vval.v_dict == NULL
9449 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9450 break;
9451 default:
9452 EMSG2(_(e_intern2), "f_empty()");
9453 n = 0;
9456 rettv->vval.v_number = n;
9460 * "escape({string}, {chars})" function
9462 static void
9463 f_escape(argvars, rettv)
9464 typval_T *argvars;
9465 typval_T *rettv;
9467 char_u buf[NUMBUFLEN];
9469 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9470 get_tv_string_buf(&argvars[1], buf));
9471 rettv->v_type = VAR_STRING;
9475 * "eval()" function
9477 static void
9478 f_eval(argvars, rettv)
9479 typval_T *argvars;
9480 typval_T *rettv;
9482 char_u *s;
9484 s = get_tv_string_chk(&argvars[0]);
9485 if (s != NULL)
9486 s = skipwhite(s);
9488 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9490 rettv->v_type = VAR_NUMBER;
9491 rettv->vval.v_number = 0;
9493 else if (*s != NUL)
9494 EMSG(_(e_trailing));
9498 * "eventhandler()" function
9500 static void
9501 f_eventhandler(argvars, rettv)
9502 typval_T *argvars UNUSED;
9503 typval_T *rettv;
9505 rettv->vval.v_number = vgetc_busy;
9509 * "executable()" function
9511 static void
9512 f_executable(argvars, rettv)
9513 typval_T *argvars;
9514 typval_T *rettv;
9516 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9520 * "exists()" function
9522 static void
9523 f_exists(argvars, rettv)
9524 typval_T *argvars;
9525 typval_T *rettv;
9527 char_u *p;
9528 char_u *name;
9529 int n = FALSE;
9530 int len = 0;
9532 p = get_tv_string(&argvars[0]);
9533 if (*p == '$') /* environment variable */
9535 /* first try "normal" environment variables (fast) */
9536 if (mch_getenv(p + 1) != NULL)
9537 n = TRUE;
9538 else
9540 /* try expanding things like $VIM and ${HOME} */
9541 p = expand_env_save(p);
9542 if (p != NULL && *p != '$')
9543 n = TRUE;
9544 vim_free(p);
9547 else if (*p == '&' || *p == '+') /* option */
9549 n = (get_option_tv(&p, NULL, TRUE) == OK);
9550 if (*skipwhite(p) != NUL)
9551 n = FALSE; /* trailing garbage */
9553 else if (*p == '*') /* internal or user defined function */
9555 n = function_exists(p + 1);
9557 else if (*p == ':')
9559 n = cmd_exists(p + 1);
9561 else if (*p == '#')
9563 #ifdef FEAT_AUTOCMD
9564 if (p[1] == '#')
9565 n = autocmd_supported(p + 2);
9566 else
9567 n = au_exists(p + 1);
9568 #endif
9570 else /* internal variable */
9572 char_u *tofree;
9573 typval_T tv;
9575 /* get_name_len() takes care of expanding curly braces */
9576 name = p;
9577 len = get_name_len(&p, &tofree, TRUE, FALSE);
9578 if (len > 0)
9580 if (tofree != NULL)
9581 name = tofree;
9582 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9583 if (n)
9585 /* handle d.key, l[idx], f(expr) */
9586 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9587 if (n)
9588 clear_tv(&tv);
9591 if (*p != NUL)
9592 n = FALSE;
9594 vim_free(tofree);
9597 rettv->vval.v_number = n;
9601 * "expand()" function
9603 static void
9604 f_expand(argvars, rettv)
9605 typval_T *argvars;
9606 typval_T *rettv;
9608 char_u *s;
9609 int len;
9610 char_u *errormsg;
9611 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9612 expand_T xpc;
9613 int error = FALSE;
9615 rettv->v_type = VAR_STRING;
9616 s = get_tv_string(&argvars[0]);
9617 if (*s == '%' || *s == '#' || *s == '<')
9619 ++emsg_off;
9620 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9621 --emsg_off;
9623 else
9625 /* When the optional second argument is non-zero, don't remove matches
9626 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9627 if (argvars[1].v_type != VAR_UNKNOWN
9628 && get_tv_number_chk(&argvars[1], &error))
9629 flags |= WILD_KEEP_ALL;
9630 if (!error)
9632 ExpandInit(&xpc);
9633 xpc.xp_context = EXPAND_FILES;
9634 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9636 else
9637 rettv->vval.v_string = NULL;
9642 * "extend(list, list [, idx])" function
9643 * "extend(dict, dict [, action])" function
9645 static void
9646 f_extend(argvars, rettv)
9647 typval_T *argvars;
9648 typval_T *rettv;
9650 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9652 list_T *l1, *l2;
9653 listitem_T *item;
9654 long before;
9655 int error = FALSE;
9657 l1 = argvars[0].vval.v_list;
9658 l2 = argvars[1].vval.v_list;
9659 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9660 && l2 != NULL)
9662 if (argvars[2].v_type != VAR_UNKNOWN)
9664 before = get_tv_number_chk(&argvars[2], &error);
9665 if (error)
9666 return; /* type error; errmsg already given */
9668 if (before == l1->lv_len)
9669 item = NULL;
9670 else
9672 item = list_find(l1, before);
9673 if (item == NULL)
9675 EMSGN(_(e_listidx), before);
9676 return;
9680 else
9681 item = NULL;
9682 list_extend(l1, l2, item);
9684 copy_tv(&argvars[0], rettv);
9687 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9689 dict_T *d1, *d2;
9690 dictitem_T *di1;
9691 char_u *action;
9692 int i;
9693 hashitem_T *hi2;
9694 int todo;
9696 d1 = argvars[0].vval.v_dict;
9697 d2 = argvars[1].vval.v_dict;
9698 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9699 && d2 != NULL)
9701 /* Check the third argument. */
9702 if (argvars[2].v_type != VAR_UNKNOWN)
9704 static char *(av[]) = {"keep", "force", "error"};
9706 action = get_tv_string_chk(&argvars[2]);
9707 if (action == NULL)
9708 return; /* type error; errmsg already given */
9709 for (i = 0; i < 3; ++i)
9710 if (STRCMP(action, av[i]) == 0)
9711 break;
9712 if (i == 3)
9714 EMSG2(_(e_invarg2), action);
9715 return;
9718 else
9719 action = (char_u *)"force";
9721 /* Go over all entries in the second dict and add them to the
9722 * first dict. */
9723 todo = (int)d2->dv_hashtab.ht_used;
9724 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9726 if (!HASHITEM_EMPTY(hi2))
9728 --todo;
9729 di1 = dict_find(d1, hi2->hi_key, -1);
9730 if (di1 == NULL)
9732 di1 = dictitem_copy(HI2DI(hi2));
9733 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9734 dictitem_free(di1);
9736 else if (*action == 'e')
9738 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9739 break;
9741 else if (*action == 'f')
9743 clear_tv(&di1->di_tv);
9744 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9749 copy_tv(&argvars[0], rettv);
9752 else
9753 EMSG2(_(e_listdictarg), "extend()");
9757 * "feedkeys()" function
9759 static void
9760 f_feedkeys(argvars, rettv)
9761 typval_T *argvars;
9762 typval_T *rettv UNUSED;
9764 int remap = TRUE;
9765 char_u *keys, *flags;
9766 char_u nbuf[NUMBUFLEN];
9767 int typed = FALSE;
9768 char_u *keys_esc;
9770 /* This is not allowed in the sandbox. If the commands would still be
9771 * executed in the sandbox it would be OK, but it probably happens later,
9772 * when "sandbox" is no longer set. */
9773 if (check_secure())
9774 return;
9776 keys = get_tv_string(&argvars[0]);
9777 if (*keys != NUL)
9779 if (argvars[1].v_type != VAR_UNKNOWN)
9781 flags = get_tv_string_buf(&argvars[1], nbuf);
9782 for ( ; *flags != NUL; ++flags)
9784 switch (*flags)
9786 case 'n': remap = FALSE; break;
9787 case 'm': remap = TRUE; break;
9788 case 't': typed = TRUE; break;
9793 /* Need to escape K_SPECIAL and CSI before putting the string in the
9794 * typeahead buffer. */
9795 keys_esc = vim_strsave_escape_csi(keys);
9796 if (keys_esc != NULL)
9798 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9799 typebuf.tb_len, !typed, FALSE);
9800 vim_free(keys_esc);
9801 if (vgetc_busy)
9802 typebuf_was_filled = TRUE;
9808 * "filereadable()" function
9810 static void
9811 f_filereadable(argvars, rettv)
9812 typval_T *argvars;
9813 typval_T *rettv;
9815 int fd;
9816 char_u *p;
9817 int n;
9819 #ifndef O_NONBLOCK
9820 # define O_NONBLOCK 0
9821 #endif
9822 p = get_tv_string(&argvars[0]);
9823 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9824 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9826 n = TRUE;
9827 close(fd);
9829 else
9830 n = FALSE;
9832 rettv->vval.v_number = n;
9836 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9837 * rights to write into.
9839 static void
9840 f_filewritable(argvars, rettv)
9841 typval_T *argvars;
9842 typval_T *rettv;
9844 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9847 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9849 static void
9850 findfilendir(argvars, rettv, find_what)
9851 typval_T *argvars;
9852 typval_T *rettv;
9853 int find_what;
9855 #ifdef FEAT_SEARCHPATH
9856 char_u *fname;
9857 char_u *fresult = NULL;
9858 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9859 char_u *p;
9860 char_u pathbuf[NUMBUFLEN];
9861 int count = 1;
9862 int first = TRUE;
9863 int error = FALSE;
9864 #endif
9866 rettv->vval.v_string = NULL;
9867 rettv->v_type = VAR_STRING;
9869 #ifdef FEAT_SEARCHPATH
9870 fname = get_tv_string(&argvars[0]);
9872 if (argvars[1].v_type != VAR_UNKNOWN)
9874 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9875 if (p == NULL)
9876 error = TRUE;
9877 else
9879 if (*p != NUL)
9880 path = p;
9882 if (argvars[2].v_type != VAR_UNKNOWN)
9883 count = get_tv_number_chk(&argvars[2], &error);
9887 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9888 error = TRUE;
9890 if (*fname != NUL && !error)
9894 if (rettv->v_type == VAR_STRING)
9895 vim_free(fresult);
9896 fresult = find_file_in_path_option(first ? fname : NULL,
9897 first ? (int)STRLEN(fname) : 0,
9898 0, first, path,
9899 find_what,
9900 curbuf->b_ffname,
9901 find_what == FINDFILE_DIR
9902 ? (char_u *)"" : curbuf->b_p_sua);
9903 first = FALSE;
9905 if (fresult != NULL && rettv->v_type == VAR_LIST)
9906 list_append_string(rettv->vval.v_list, fresult, -1);
9908 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9911 if (rettv->v_type == VAR_STRING)
9912 rettv->vval.v_string = fresult;
9913 #endif
9916 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9917 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9920 * Implementation of map() and filter().
9922 static void
9923 filter_map(argvars, rettv, map)
9924 typval_T *argvars;
9925 typval_T *rettv;
9926 int map;
9928 char_u buf[NUMBUFLEN];
9929 char_u *expr;
9930 listitem_T *li, *nli;
9931 list_T *l = NULL;
9932 dictitem_T *di;
9933 hashtab_T *ht;
9934 hashitem_T *hi;
9935 dict_T *d = NULL;
9936 typval_T save_val;
9937 typval_T save_key;
9938 int rem;
9939 int todo;
9940 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9941 int save_did_emsg;
9942 int index = 0;
9944 if (argvars[0].v_type == VAR_LIST)
9946 if ((l = argvars[0].vval.v_list) == NULL
9947 || (map && tv_check_lock(l->lv_lock, ermsg)))
9948 return;
9950 else if (argvars[0].v_type == VAR_DICT)
9952 if ((d = argvars[0].vval.v_dict) == NULL
9953 || (map && tv_check_lock(d->dv_lock, ermsg)))
9954 return;
9956 else
9958 EMSG2(_(e_listdictarg), ermsg);
9959 return;
9962 expr = get_tv_string_buf_chk(&argvars[1], buf);
9963 /* On type errors, the preceding call has already displayed an error
9964 * message. Avoid a misleading error message for an empty string that
9965 * was not passed as argument. */
9966 if (expr != NULL)
9968 prepare_vimvar(VV_VAL, &save_val);
9969 expr = skipwhite(expr);
9971 /* We reset "did_emsg" to be able to detect whether an error
9972 * occurred during evaluation of the expression. */
9973 save_did_emsg = did_emsg;
9974 did_emsg = FALSE;
9976 prepare_vimvar(VV_KEY, &save_key);
9977 if (argvars[0].v_type == VAR_DICT)
9979 vimvars[VV_KEY].vv_type = VAR_STRING;
9981 ht = &d->dv_hashtab;
9982 hash_lock(ht);
9983 todo = (int)ht->ht_used;
9984 for (hi = ht->ht_array; todo > 0; ++hi)
9986 if (!HASHITEM_EMPTY(hi))
9988 --todo;
9989 di = HI2DI(hi);
9990 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9991 break;
9992 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9993 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9994 || did_emsg)
9995 break;
9996 if (!map && rem)
9997 dictitem_remove(d, di);
9998 clear_tv(&vimvars[VV_KEY].vv_tv);
10001 hash_unlock(ht);
10003 else
10005 vimvars[VV_KEY].vv_type = VAR_NUMBER;
10007 for (li = l->lv_first; li != NULL; li = nli)
10009 if (tv_check_lock(li->li_tv.v_lock, ermsg))
10010 break;
10011 nli = li->li_next;
10012 vimvars[VV_KEY].vv_nr = index;
10013 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
10014 || did_emsg)
10015 break;
10016 if (!map && rem)
10017 listitem_remove(l, li);
10018 ++index;
10022 restore_vimvar(VV_KEY, &save_key);
10023 restore_vimvar(VV_VAL, &save_val);
10025 did_emsg |= save_did_emsg;
10028 copy_tv(&argvars[0], rettv);
10031 static int
10032 filter_map_one(tv, expr, map, remp)
10033 typval_T *tv;
10034 char_u *expr;
10035 int map;
10036 int *remp;
10038 typval_T rettv;
10039 char_u *s;
10040 int retval = FAIL;
10042 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10043 s = expr;
10044 if (eval1(&s, &rettv, TRUE) == FAIL)
10045 goto theend;
10046 if (*s != NUL) /* check for trailing chars after expr */
10048 EMSG2(_(e_invexpr2), s);
10049 goto theend;
10051 if (map)
10053 /* map(): replace the list item value */
10054 clear_tv(tv);
10055 rettv.v_lock = 0;
10056 *tv = rettv;
10058 else
10060 int error = FALSE;
10062 /* filter(): when expr is zero remove the item */
10063 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10064 clear_tv(&rettv);
10065 /* On type error, nothing has been removed; return FAIL to stop the
10066 * loop. The error message was given by get_tv_number_chk(). */
10067 if (error)
10068 goto theend;
10070 retval = OK;
10071 theend:
10072 clear_tv(&vimvars[VV_VAL].vv_tv);
10073 return retval;
10077 * "filter()" function
10079 static void
10080 f_filter(argvars, rettv)
10081 typval_T *argvars;
10082 typval_T *rettv;
10084 filter_map(argvars, rettv, FALSE);
10088 * "finddir({fname}[, {path}[, {count}]])" function
10090 static void
10091 f_finddir(argvars, rettv)
10092 typval_T *argvars;
10093 typval_T *rettv;
10095 findfilendir(argvars, rettv, FINDFILE_DIR);
10099 * "findfile({fname}[, {path}[, {count}]])" function
10101 static void
10102 f_findfile(argvars, rettv)
10103 typval_T *argvars;
10104 typval_T *rettv;
10106 findfilendir(argvars, rettv, FINDFILE_FILE);
10109 #ifdef FEAT_FLOAT
10111 * "float2nr({float})" function
10113 static void
10114 f_float2nr(argvars, rettv)
10115 typval_T *argvars;
10116 typval_T *rettv;
10118 float_T f;
10120 if (get_float_arg(argvars, &f) == OK)
10122 if (f < -0x7fffffff)
10123 rettv->vval.v_number = -0x7fffffff;
10124 else if (f > 0x7fffffff)
10125 rettv->vval.v_number = 0x7fffffff;
10126 else
10127 rettv->vval.v_number = (varnumber_T)f;
10132 * "floor({float})" function
10134 static void
10135 f_floor(argvars, rettv)
10136 typval_T *argvars;
10137 typval_T *rettv;
10139 float_T f;
10141 rettv->v_type = VAR_FLOAT;
10142 if (get_float_arg(argvars, &f) == OK)
10143 rettv->vval.v_float = floor(f);
10144 else
10145 rettv->vval.v_float = 0.0;
10147 #endif
10150 * "fnameescape({string})" function
10152 static void
10153 f_fnameescape(argvars, rettv)
10154 typval_T *argvars;
10155 typval_T *rettv;
10157 rettv->vval.v_string = vim_strsave_fnameescape(
10158 get_tv_string(&argvars[0]), FALSE);
10159 rettv->v_type = VAR_STRING;
10163 * "fnamemodify({fname}, {mods})" function
10165 static void
10166 f_fnamemodify(argvars, rettv)
10167 typval_T *argvars;
10168 typval_T *rettv;
10170 char_u *fname;
10171 char_u *mods;
10172 int usedlen = 0;
10173 int len;
10174 char_u *fbuf = NULL;
10175 char_u buf[NUMBUFLEN];
10177 fname = get_tv_string_chk(&argvars[0]);
10178 mods = get_tv_string_buf_chk(&argvars[1], buf);
10179 if (fname == NULL || mods == NULL)
10180 fname = NULL;
10181 else
10183 len = (int)STRLEN(fname);
10184 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10187 rettv->v_type = VAR_STRING;
10188 if (fname == NULL)
10189 rettv->vval.v_string = NULL;
10190 else
10191 rettv->vval.v_string = vim_strnsave(fname, len);
10192 vim_free(fbuf);
10195 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10198 * "foldclosed()" function
10200 static void
10201 foldclosed_both(argvars, rettv, end)
10202 typval_T *argvars;
10203 typval_T *rettv;
10204 int end;
10206 #ifdef FEAT_FOLDING
10207 linenr_T lnum;
10208 linenr_T first, last;
10210 lnum = get_tv_lnum(argvars);
10211 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10213 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10215 if (end)
10216 rettv->vval.v_number = (varnumber_T)last;
10217 else
10218 rettv->vval.v_number = (varnumber_T)first;
10219 return;
10222 #endif
10223 rettv->vval.v_number = -1;
10227 * "foldclosed()" function
10229 static void
10230 f_foldclosed(argvars, rettv)
10231 typval_T *argvars;
10232 typval_T *rettv;
10234 foldclosed_both(argvars, rettv, FALSE);
10238 * "foldclosedend()" function
10240 static void
10241 f_foldclosedend(argvars, rettv)
10242 typval_T *argvars;
10243 typval_T *rettv;
10245 foldclosed_both(argvars, rettv, TRUE);
10249 * "foldlevel()" function
10251 static void
10252 f_foldlevel(argvars, rettv)
10253 typval_T *argvars;
10254 typval_T *rettv;
10256 #ifdef FEAT_FOLDING
10257 linenr_T lnum;
10259 lnum = get_tv_lnum(argvars);
10260 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10261 rettv->vval.v_number = foldLevel(lnum);
10262 #endif
10266 * "foldtext()" function
10268 static void
10269 f_foldtext(argvars, rettv)
10270 typval_T *argvars UNUSED;
10271 typval_T *rettv;
10273 #ifdef FEAT_FOLDING
10274 linenr_T lnum;
10275 char_u *s;
10276 char_u *r;
10277 int len;
10278 char *txt;
10279 #endif
10281 rettv->v_type = VAR_STRING;
10282 rettv->vval.v_string = NULL;
10283 #ifdef FEAT_FOLDING
10284 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10285 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10286 <= curbuf->b_ml.ml_line_count
10287 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10289 /* Find first non-empty line in the fold. */
10290 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10291 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10293 if (!linewhite(lnum))
10294 break;
10295 ++lnum;
10298 /* Find interesting text in this line. */
10299 s = skipwhite(ml_get(lnum));
10300 /* skip C comment-start */
10301 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10303 s = skipwhite(s + 2);
10304 if (*skipwhite(s) == NUL
10305 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10307 s = skipwhite(ml_get(lnum + 1));
10308 if (*s == '*')
10309 s = skipwhite(s + 1);
10312 txt = _("+-%s%3ld lines: ");
10313 r = alloc((unsigned)(STRLEN(txt)
10314 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10315 + 20 /* for %3ld */
10316 + STRLEN(s))); /* concatenated */
10317 if (r != NULL)
10319 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10320 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10321 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10322 len = (int)STRLEN(r);
10323 STRCAT(r, s);
10324 /* remove 'foldmarker' and 'commentstring' */
10325 foldtext_cleanup(r + len);
10326 rettv->vval.v_string = r;
10329 #endif
10333 * "foldtextresult(lnum)" function
10335 static void
10336 f_foldtextresult(argvars, rettv)
10337 typval_T *argvars UNUSED;
10338 typval_T *rettv;
10340 #ifdef FEAT_FOLDING
10341 linenr_T lnum;
10342 char_u *text;
10343 char_u buf[51];
10344 foldinfo_T foldinfo;
10345 int fold_count;
10346 #endif
10348 rettv->v_type = VAR_STRING;
10349 rettv->vval.v_string = NULL;
10350 #ifdef FEAT_FOLDING
10351 lnum = get_tv_lnum(argvars);
10352 /* treat illegal types and illegal string values for {lnum} the same */
10353 if (lnum < 0)
10354 lnum = 0;
10355 fold_count = foldedCount(curwin, lnum, &foldinfo);
10356 if (fold_count > 0)
10358 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10359 &foldinfo, buf);
10360 if (text == buf)
10361 text = vim_strsave(text);
10362 rettv->vval.v_string = text;
10364 #endif
10368 * "foreground()" function
10370 static void
10371 f_foreground(argvars, rettv)
10372 typval_T *argvars UNUSED;
10373 typval_T *rettv UNUSED;
10375 #ifdef FEAT_GUI
10376 if (gui.in_use)
10377 gui_mch_set_foreground();
10378 #else
10379 # ifdef WIN32
10380 win32_set_foreground();
10381 # endif
10382 #endif
10386 * "function()" function
10388 static void
10389 f_function(argvars, rettv)
10390 typval_T *argvars;
10391 typval_T *rettv;
10393 char_u *s;
10395 s = get_tv_string(&argvars[0]);
10396 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10397 EMSG2(_(e_invarg2), s);
10398 /* Don't check an autoload name for existence here. */
10399 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10400 EMSG2(_("E700: Unknown function: %s"), s);
10401 else
10403 rettv->vval.v_string = vim_strsave(s);
10404 rettv->v_type = VAR_FUNC;
10409 * "garbagecollect()" function
10411 static void
10412 f_garbagecollect(argvars, rettv)
10413 typval_T *argvars;
10414 typval_T *rettv UNUSED;
10416 /* This is postponed until we are back at the toplevel, because we may be
10417 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10418 want_garbage_collect = TRUE;
10420 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10421 garbage_collect_at_exit = TRUE;
10425 * "get()" function
10427 static void
10428 f_get(argvars, rettv)
10429 typval_T *argvars;
10430 typval_T *rettv;
10432 listitem_T *li;
10433 list_T *l;
10434 dictitem_T *di;
10435 dict_T *d;
10436 typval_T *tv = NULL;
10438 if (argvars[0].v_type == VAR_LIST)
10440 if ((l = argvars[0].vval.v_list) != NULL)
10442 int error = FALSE;
10444 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10445 if (!error && li != NULL)
10446 tv = &li->li_tv;
10449 else if (argvars[0].v_type == VAR_DICT)
10451 if ((d = argvars[0].vval.v_dict) != NULL)
10453 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10454 if (di != NULL)
10455 tv = &di->di_tv;
10458 else
10459 EMSG2(_(e_listdictarg), "get()");
10461 if (tv == NULL)
10463 if (argvars[2].v_type != VAR_UNKNOWN)
10464 copy_tv(&argvars[2], rettv);
10466 else
10467 copy_tv(tv, rettv);
10470 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10473 * Get line or list of lines from buffer "buf" into "rettv".
10474 * Return a range (from start to end) of lines in rettv from the specified
10475 * buffer.
10476 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10478 static void
10479 get_buffer_lines(buf, start, end, retlist, rettv)
10480 buf_T *buf;
10481 linenr_T start;
10482 linenr_T end;
10483 int retlist;
10484 typval_T *rettv;
10486 char_u *p;
10488 if (retlist && rettv_list_alloc(rettv) == FAIL)
10489 return;
10491 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10492 return;
10494 if (!retlist)
10496 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10497 p = ml_get_buf(buf, start, FALSE);
10498 else
10499 p = (char_u *)"";
10501 rettv->v_type = VAR_STRING;
10502 rettv->vval.v_string = vim_strsave(p);
10504 else
10506 if (end < start)
10507 return;
10509 if (start < 1)
10510 start = 1;
10511 if (end > buf->b_ml.ml_line_count)
10512 end = buf->b_ml.ml_line_count;
10513 while (start <= end)
10514 if (list_append_string(rettv->vval.v_list,
10515 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10516 break;
10521 * "getbufline()" function
10523 static void
10524 f_getbufline(argvars, rettv)
10525 typval_T *argvars;
10526 typval_T *rettv;
10528 linenr_T lnum;
10529 linenr_T end;
10530 buf_T *buf;
10532 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10533 ++emsg_off;
10534 buf = get_buf_tv(&argvars[0]);
10535 --emsg_off;
10537 lnum = get_tv_lnum_buf(&argvars[1], buf);
10538 if (argvars[2].v_type == VAR_UNKNOWN)
10539 end = lnum;
10540 else
10541 end = get_tv_lnum_buf(&argvars[2], buf);
10543 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10547 * "getbufvar()" function
10549 static void
10550 f_getbufvar(argvars, rettv)
10551 typval_T *argvars;
10552 typval_T *rettv;
10554 buf_T *buf;
10555 buf_T *save_curbuf;
10556 char_u *varname;
10557 dictitem_T *v;
10559 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10560 varname = get_tv_string_chk(&argvars[1]);
10561 ++emsg_off;
10562 buf = get_buf_tv(&argvars[0]);
10564 rettv->v_type = VAR_STRING;
10565 rettv->vval.v_string = NULL;
10567 if (buf != NULL && varname != NULL)
10569 /* set curbuf to be our buf, temporarily */
10570 save_curbuf = curbuf;
10571 curbuf = buf;
10573 if (*varname == '&') /* buffer-local-option */
10574 get_option_tv(&varname, rettv, TRUE);
10575 else
10577 if (*varname == NUL)
10578 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10579 * scope prefix before the NUL byte is required by
10580 * find_var_in_ht(). */
10581 varname = (char_u *)"b:" + 2;
10582 /* look up the variable */
10583 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10584 if (v != NULL)
10585 copy_tv(&v->di_tv, rettv);
10588 /* restore previous notion of curbuf */
10589 curbuf = save_curbuf;
10592 --emsg_off;
10596 * "getchar()" function
10598 static void
10599 f_getchar(argvars, rettv)
10600 typval_T *argvars;
10601 typval_T *rettv;
10603 varnumber_T n;
10604 int error = FALSE;
10606 /* Position the cursor. Needed after a message that ends in a space. */
10607 windgoto(msg_row, msg_col);
10609 ++no_mapping;
10610 ++allow_keys;
10611 for (;;)
10613 if (argvars[0].v_type == VAR_UNKNOWN)
10614 /* getchar(): blocking wait. */
10615 n = safe_vgetc();
10616 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10617 /* getchar(1): only check if char avail */
10618 n = vpeekc();
10619 else if (error || vpeekc() == NUL)
10620 /* illegal argument or getchar(0) and no char avail: return zero */
10621 n = 0;
10622 else
10623 /* getchar(0) and char avail: return char */
10624 n = safe_vgetc();
10625 if (n == K_IGNORE)
10626 continue;
10627 break;
10629 --no_mapping;
10630 --allow_keys;
10632 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10633 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10634 vimvars[VV_MOUSE_COL].vv_nr = 0;
10636 rettv->vval.v_number = n;
10637 if (IS_SPECIAL(n) || mod_mask != 0)
10639 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10640 int i = 0;
10642 /* Turn a special key into three bytes, plus modifier. */
10643 if (mod_mask != 0)
10645 temp[i++] = K_SPECIAL;
10646 temp[i++] = KS_MODIFIER;
10647 temp[i++] = mod_mask;
10649 if (IS_SPECIAL(n))
10651 temp[i++] = K_SPECIAL;
10652 temp[i++] = K_SECOND(n);
10653 temp[i++] = K_THIRD(n);
10655 #ifdef FEAT_MBYTE
10656 else if (has_mbyte)
10657 i += (*mb_char2bytes)(n, temp + i);
10658 #endif
10659 else
10660 temp[i++] = n;
10661 temp[i++] = NUL;
10662 rettv->v_type = VAR_STRING;
10663 rettv->vval.v_string = vim_strsave(temp);
10665 #ifdef FEAT_MOUSE
10666 if (n == K_LEFTMOUSE
10667 || n == K_LEFTMOUSE_NM
10668 || n == K_LEFTDRAG
10669 || n == K_LEFTRELEASE
10670 || n == K_LEFTRELEASE_NM
10671 || n == K_MIDDLEMOUSE
10672 || n == K_MIDDLEDRAG
10673 || n == K_MIDDLERELEASE
10674 || n == K_RIGHTMOUSE
10675 || n == K_RIGHTDRAG
10676 || n == K_RIGHTRELEASE
10677 || n == K_X1MOUSE
10678 || n == K_X1DRAG
10679 || n == K_X1RELEASE
10680 || n == K_X2MOUSE
10681 || n == K_X2DRAG
10682 || n == K_X2RELEASE
10683 || n == K_MOUSEDOWN
10684 || n == K_MOUSEUP)
10686 int row = mouse_row;
10687 int col = mouse_col;
10688 win_T *win;
10689 linenr_T lnum;
10690 # ifdef FEAT_WINDOWS
10691 win_T *wp;
10692 # endif
10693 int winnr = 1;
10695 if (row >= 0 && col >= 0)
10697 /* Find the window at the mouse coordinates and compute the
10698 * text position. */
10699 win = mouse_find_win(&row, &col);
10700 (void)mouse_comp_pos(win, &row, &col, &lnum);
10701 # ifdef FEAT_WINDOWS
10702 for (wp = firstwin; wp != win; wp = wp->w_next)
10703 ++winnr;
10704 # endif
10705 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10706 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10707 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10710 #endif
10715 * "getcharmod()" function
10717 static void
10718 f_getcharmod(argvars, rettv)
10719 typval_T *argvars UNUSED;
10720 typval_T *rettv;
10722 rettv->vval.v_number = mod_mask;
10726 * "getcmdline()" function
10728 static void
10729 f_getcmdline(argvars, rettv)
10730 typval_T *argvars UNUSED;
10731 typval_T *rettv;
10733 rettv->v_type = VAR_STRING;
10734 rettv->vval.v_string = get_cmdline_str();
10738 * "getcmdpos()" function
10740 static void
10741 f_getcmdpos(argvars, rettv)
10742 typval_T *argvars UNUSED;
10743 typval_T *rettv;
10745 rettv->vval.v_number = get_cmdline_pos() + 1;
10749 * "getcmdtype()" function
10751 static void
10752 f_getcmdtype(argvars, rettv)
10753 typval_T *argvars UNUSED;
10754 typval_T *rettv;
10756 rettv->v_type = VAR_STRING;
10757 rettv->vval.v_string = alloc(2);
10758 if (rettv->vval.v_string != NULL)
10760 rettv->vval.v_string[0] = get_cmdline_type();
10761 rettv->vval.v_string[1] = NUL;
10766 * "getcwd()" function
10768 static void
10769 f_getcwd(argvars, rettv)
10770 typval_T *argvars UNUSED;
10771 typval_T *rettv;
10773 char_u cwd[MAXPATHL];
10775 rettv->v_type = VAR_STRING;
10776 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10777 rettv->vval.v_string = NULL;
10778 else
10780 rettv->vval.v_string = vim_strsave(cwd);
10781 #ifdef BACKSLASH_IN_FILENAME
10782 if (rettv->vval.v_string != NULL)
10783 slash_adjust(rettv->vval.v_string);
10784 #endif
10789 * "getfontname()" function
10791 static void
10792 f_getfontname(argvars, rettv)
10793 typval_T *argvars UNUSED;
10794 typval_T *rettv;
10796 rettv->v_type = VAR_STRING;
10797 rettv->vval.v_string = NULL;
10798 #ifdef FEAT_GUI
10799 if (gui.in_use)
10801 GuiFont font;
10802 char_u *name = NULL;
10804 if (argvars[0].v_type == VAR_UNKNOWN)
10806 /* Get the "Normal" font. Either the name saved by
10807 * hl_set_font_name() or from the font ID. */
10808 font = gui.norm_font;
10809 name = hl_get_font_name();
10811 else
10813 name = get_tv_string(&argvars[0]);
10814 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10815 return;
10816 font = gui_mch_get_font(name, FALSE);
10817 if (font == NOFONT)
10818 return; /* Invalid font name, return empty string. */
10820 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10821 if (argvars[0].v_type != VAR_UNKNOWN)
10822 gui_mch_free_font(font);
10824 #endif
10828 * "getfperm({fname})" function
10830 static void
10831 f_getfperm(argvars, rettv)
10832 typval_T *argvars;
10833 typval_T *rettv;
10835 char_u *fname;
10836 struct stat st;
10837 char_u *perm = NULL;
10838 char_u flags[] = "rwx";
10839 int i;
10841 fname = get_tv_string(&argvars[0]);
10843 rettv->v_type = VAR_STRING;
10844 if (mch_stat((char *)fname, &st) >= 0)
10846 perm = vim_strsave((char_u *)"---------");
10847 if (perm != NULL)
10849 for (i = 0; i < 9; i++)
10851 if (st.st_mode & (1 << (8 - i)))
10852 perm[i] = flags[i % 3];
10856 rettv->vval.v_string = perm;
10860 * "getfsize({fname})" function
10862 static void
10863 f_getfsize(argvars, rettv)
10864 typval_T *argvars;
10865 typval_T *rettv;
10867 char_u *fname;
10868 struct stat st;
10870 fname = get_tv_string(&argvars[0]);
10872 rettv->v_type = VAR_NUMBER;
10874 if (mch_stat((char *)fname, &st) >= 0)
10876 if (mch_isdir(fname))
10877 rettv->vval.v_number = 0;
10878 else
10880 rettv->vval.v_number = (varnumber_T)st.st_size;
10882 /* non-perfect check for overflow */
10883 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10884 rettv->vval.v_number = -2;
10887 else
10888 rettv->vval.v_number = -1;
10892 * "getftime({fname})" function
10894 static void
10895 f_getftime(argvars, rettv)
10896 typval_T *argvars;
10897 typval_T *rettv;
10899 char_u *fname;
10900 struct stat st;
10902 fname = get_tv_string(&argvars[0]);
10904 if (mch_stat((char *)fname, &st) >= 0)
10905 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10906 else
10907 rettv->vval.v_number = -1;
10911 * "getftype({fname})" function
10913 static void
10914 f_getftype(argvars, rettv)
10915 typval_T *argvars;
10916 typval_T *rettv;
10918 char_u *fname;
10919 struct stat st;
10920 char_u *type = NULL;
10921 char *t;
10923 fname = get_tv_string(&argvars[0]);
10925 rettv->v_type = VAR_STRING;
10926 if (mch_lstat((char *)fname, &st) >= 0)
10928 #ifdef S_ISREG
10929 if (S_ISREG(st.st_mode))
10930 t = "file";
10931 else if (S_ISDIR(st.st_mode))
10932 t = "dir";
10933 # ifdef S_ISLNK
10934 else if (S_ISLNK(st.st_mode))
10935 t = "link";
10936 # endif
10937 # ifdef S_ISBLK
10938 else if (S_ISBLK(st.st_mode))
10939 t = "bdev";
10940 # endif
10941 # ifdef S_ISCHR
10942 else if (S_ISCHR(st.st_mode))
10943 t = "cdev";
10944 # endif
10945 # ifdef S_ISFIFO
10946 else if (S_ISFIFO(st.st_mode))
10947 t = "fifo";
10948 # endif
10949 # ifdef S_ISSOCK
10950 else if (S_ISSOCK(st.st_mode))
10951 t = "fifo";
10952 # endif
10953 else
10954 t = "other";
10955 #else
10956 # ifdef S_IFMT
10957 switch (st.st_mode & S_IFMT)
10959 case S_IFREG: t = "file"; break;
10960 case S_IFDIR: t = "dir"; break;
10961 # ifdef S_IFLNK
10962 case S_IFLNK: t = "link"; break;
10963 # endif
10964 # ifdef S_IFBLK
10965 case S_IFBLK: t = "bdev"; break;
10966 # endif
10967 # ifdef S_IFCHR
10968 case S_IFCHR: t = "cdev"; break;
10969 # endif
10970 # ifdef S_IFIFO
10971 case S_IFIFO: t = "fifo"; break;
10972 # endif
10973 # ifdef S_IFSOCK
10974 case S_IFSOCK: t = "socket"; break;
10975 # endif
10976 default: t = "other";
10978 # else
10979 if (mch_isdir(fname))
10980 t = "dir";
10981 else
10982 t = "file";
10983 # endif
10984 #endif
10985 type = vim_strsave((char_u *)t);
10987 rettv->vval.v_string = type;
10991 * "getline(lnum, [end])" function
10993 static void
10994 f_getline(argvars, rettv)
10995 typval_T *argvars;
10996 typval_T *rettv;
10998 linenr_T lnum;
10999 linenr_T end;
11000 int retlist;
11002 lnum = get_tv_lnum(argvars);
11003 if (argvars[1].v_type == VAR_UNKNOWN)
11005 end = 0;
11006 retlist = FALSE;
11008 else
11010 end = get_tv_lnum(&argvars[1]);
11011 retlist = TRUE;
11014 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
11018 * "getmatches()" function
11020 static void
11021 f_getmatches(argvars, rettv)
11022 typval_T *argvars UNUSED;
11023 typval_T *rettv;
11025 #ifdef FEAT_SEARCH_EXTRA
11026 dict_T *dict;
11027 matchitem_T *cur = curwin->w_match_head;
11029 if (rettv_list_alloc(rettv) == OK)
11031 while (cur != NULL)
11033 dict = dict_alloc();
11034 if (dict == NULL)
11035 return;
11036 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11037 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11038 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11039 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11040 list_append_dict(rettv->vval.v_list, dict);
11041 cur = cur->next;
11044 #endif
11048 * "getpid()" function
11050 static void
11051 f_getpid(argvars, rettv)
11052 typval_T *argvars UNUSED;
11053 typval_T *rettv;
11055 rettv->vval.v_number = mch_get_pid();
11059 * "getpos(string)" function
11061 static void
11062 f_getpos(argvars, rettv)
11063 typval_T *argvars;
11064 typval_T *rettv;
11066 pos_T *fp;
11067 list_T *l;
11068 int fnum = -1;
11070 if (rettv_list_alloc(rettv) == OK)
11072 l = rettv->vval.v_list;
11073 fp = var2fpos(&argvars[0], TRUE, &fnum);
11074 if (fnum != -1)
11075 list_append_number(l, (varnumber_T)fnum);
11076 else
11077 list_append_number(l, (varnumber_T)0);
11078 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11079 : (varnumber_T)0);
11080 list_append_number(l, (fp != NULL)
11081 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11082 : (varnumber_T)0);
11083 list_append_number(l,
11084 #ifdef FEAT_VIRTUALEDIT
11085 (fp != NULL) ? (varnumber_T)fp->coladd :
11086 #endif
11087 (varnumber_T)0);
11089 else
11090 rettv->vval.v_number = FALSE;
11094 * "getqflist()" and "getloclist()" functions
11096 static void
11097 f_getqflist(argvars, rettv)
11098 typval_T *argvars UNUSED;
11099 typval_T *rettv UNUSED;
11101 #ifdef FEAT_QUICKFIX
11102 win_T *wp;
11103 #endif
11105 #ifdef FEAT_QUICKFIX
11106 if (rettv_list_alloc(rettv) == OK)
11108 wp = NULL;
11109 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11111 wp = find_win_by_nr(&argvars[0], NULL);
11112 if (wp == NULL)
11113 return;
11116 (void)get_errorlist(wp, rettv->vval.v_list);
11118 #endif
11122 * "getreg()" function
11124 static void
11125 f_getreg(argvars, rettv)
11126 typval_T *argvars;
11127 typval_T *rettv;
11129 char_u *strregname;
11130 int regname;
11131 int arg2 = FALSE;
11132 int error = FALSE;
11134 if (argvars[0].v_type != VAR_UNKNOWN)
11136 strregname = get_tv_string_chk(&argvars[0]);
11137 error = strregname == NULL;
11138 if (argvars[1].v_type != VAR_UNKNOWN)
11139 arg2 = get_tv_number_chk(&argvars[1], &error);
11141 else
11142 strregname = vimvars[VV_REG].vv_str;
11143 regname = (strregname == NULL ? '"' : *strregname);
11144 if (regname == 0)
11145 regname = '"';
11147 rettv->v_type = VAR_STRING;
11148 rettv->vval.v_string = error ? NULL :
11149 get_reg_contents(regname, TRUE, arg2);
11153 * "getregtype()" function
11155 static void
11156 f_getregtype(argvars, rettv)
11157 typval_T *argvars;
11158 typval_T *rettv;
11160 char_u *strregname;
11161 int regname;
11162 char_u buf[NUMBUFLEN + 2];
11163 long reglen = 0;
11165 if (argvars[0].v_type != VAR_UNKNOWN)
11167 strregname = get_tv_string_chk(&argvars[0]);
11168 if (strregname == NULL) /* type error; errmsg already given */
11170 rettv->v_type = VAR_STRING;
11171 rettv->vval.v_string = NULL;
11172 return;
11175 else
11176 /* Default to v:register */
11177 strregname = vimvars[VV_REG].vv_str;
11179 regname = (strregname == NULL ? '"' : *strregname);
11180 if (regname == 0)
11181 regname = '"';
11183 buf[0] = NUL;
11184 buf[1] = NUL;
11185 switch (get_reg_type(regname, &reglen))
11187 case MLINE: buf[0] = 'V'; break;
11188 case MCHAR: buf[0] = 'v'; break;
11189 #ifdef FEAT_VISUAL
11190 case MBLOCK:
11191 buf[0] = Ctrl_V;
11192 sprintf((char *)buf + 1, "%ld", reglen + 1);
11193 break;
11194 #endif
11196 rettv->v_type = VAR_STRING;
11197 rettv->vval.v_string = vim_strsave(buf);
11201 * "gettabwinvar()" function
11203 static void
11204 f_gettabwinvar(argvars, rettv)
11205 typval_T *argvars;
11206 typval_T *rettv;
11208 getwinvar(argvars, rettv, 1);
11212 * "getwinposx()" function
11214 static void
11215 f_getwinposx(argvars, rettv)
11216 typval_T *argvars UNUSED;
11217 typval_T *rettv;
11219 rettv->vval.v_number = -1;
11220 #ifdef FEAT_GUI
11221 if (gui.in_use)
11223 int x, y;
11225 if (gui_mch_get_winpos(&x, &y) == OK)
11226 rettv->vval.v_number = x;
11228 #endif
11232 * "getwinposy()" function
11234 static void
11235 f_getwinposy(argvars, rettv)
11236 typval_T *argvars UNUSED;
11237 typval_T *rettv;
11239 rettv->vval.v_number = -1;
11240 #ifdef FEAT_GUI
11241 if (gui.in_use)
11243 int x, y;
11245 if (gui_mch_get_winpos(&x, &y) == OK)
11246 rettv->vval.v_number = y;
11248 #endif
11252 * Find window specified by "vp" in tabpage "tp".
11254 static win_T *
11255 find_win_by_nr(vp, tp)
11256 typval_T *vp;
11257 tabpage_T *tp; /* NULL for current tab page */
11259 #ifdef FEAT_WINDOWS
11260 win_T *wp;
11261 #endif
11262 int nr;
11264 nr = get_tv_number_chk(vp, NULL);
11266 #ifdef FEAT_WINDOWS
11267 if (nr < 0)
11268 return NULL;
11269 if (nr == 0)
11270 return curwin;
11272 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11273 wp != NULL; wp = wp->w_next)
11274 if (--nr <= 0)
11275 break;
11276 return wp;
11277 #else
11278 if (nr == 0 || nr == 1)
11279 return curwin;
11280 return NULL;
11281 #endif
11285 * "getwinvar()" function
11287 static void
11288 f_getwinvar(argvars, rettv)
11289 typval_T *argvars;
11290 typval_T *rettv;
11292 getwinvar(argvars, rettv, 0);
11296 * getwinvar() and gettabwinvar()
11298 static void
11299 getwinvar(argvars, rettv, off)
11300 typval_T *argvars;
11301 typval_T *rettv;
11302 int off; /* 1 for gettabwinvar() */
11304 win_T *win, *oldcurwin;
11305 char_u *varname;
11306 dictitem_T *v;
11307 tabpage_T *tp;
11309 #ifdef FEAT_WINDOWS
11310 if (off == 1)
11311 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11312 else
11313 tp = curtab;
11314 #endif
11315 win = find_win_by_nr(&argvars[off], tp);
11316 varname = get_tv_string_chk(&argvars[off + 1]);
11317 ++emsg_off;
11319 rettv->v_type = VAR_STRING;
11320 rettv->vval.v_string = NULL;
11322 if (win != NULL && varname != NULL)
11324 /* Set curwin to be our win, temporarily. Also set curbuf, so
11325 * that we can get buffer-local options. */
11326 oldcurwin = curwin;
11327 curwin = win;
11328 curbuf = win->w_buffer;
11330 if (*varname == '&') /* window-local-option */
11331 get_option_tv(&varname, rettv, 1);
11332 else
11334 if (*varname == NUL)
11335 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11336 * scope prefix before the NUL byte is required by
11337 * find_var_in_ht(). */
11338 varname = (char_u *)"w:" + 2;
11339 /* look up the variable */
11340 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11341 if (v != NULL)
11342 copy_tv(&v->di_tv, rettv);
11345 /* restore previous notion of curwin */
11346 curwin = oldcurwin;
11347 curbuf = curwin->w_buffer;
11350 --emsg_off;
11354 * "glob()" function
11356 static void
11357 f_glob(argvars, rettv)
11358 typval_T *argvars;
11359 typval_T *rettv;
11361 int flags = WILD_SILENT|WILD_USE_NL;
11362 expand_T xpc;
11363 int error = FALSE;
11365 /* When the optional second argument is non-zero, don't remove matches
11366 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11367 if (argvars[1].v_type != VAR_UNKNOWN
11368 && get_tv_number_chk(&argvars[1], &error))
11369 flags |= WILD_KEEP_ALL;
11370 rettv->v_type = VAR_STRING;
11371 if (!error)
11373 ExpandInit(&xpc);
11374 xpc.xp_context = EXPAND_FILES;
11375 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11376 NULL, flags, WILD_ALL);
11378 else
11379 rettv->vval.v_string = NULL;
11383 * "globpath()" function
11385 static void
11386 f_globpath(argvars, rettv)
11387 typval_T *argvars;
11388 typval_T *rettv;
11390 int flags = 0;
11391 char_u buf1[NUMBUFLEN];
11392 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11393 int error = FALSE;
11395 /* When the optional second argument is non-zero, don't remove matches
11396 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11397 if (argvars[2].v_type != VAR_UNKNOWN
11398 && get_tv_number_chk(&argvars[2], &error))
11399 flags |= WILD_KEEP_ALL;
11400 rettv->v_type = VAR_STRING;
11401 if (file == NULL || error)
11402 rettv->vval.v_string = NULL;
11403 else
11404 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11405 flags);
11409 * "has()" function
11411 static void
11412 f_has(argvars, rettv)
11413 typval_T *argvars;
11414 typval_T *rettv;
11416 int i;
11417 char_u *name;
11418 int n = FALSE;
11419 static char *(has_list[]) =
11421 #ifdef AMIGA
11422 "amiga",
11423 # ifdef FEAT_ARP
11424 "arp",
11425 # endif
11426 #endif
11427 #ifdef __BEOS__
11428 "beos",
11429 #endif
11430 #ifdef MSDOS
11431 # ifdef DJGPP
11432 "dos32",
11433 # else
11434 "dos16",
11435 # endif
11436 #endif
11437 #ifdef MACOS
11438 "mac",
11439 #endif
11440 #if defined(MACOS_X_UNIX)
11441 "macunix",
11442 #endif
11443 #ifdef OS2
11444 "os2",
11445 #endif
11446 #ifdef __QNX__
11447 "qnx",
11448 #endif
11449 #ifdef RISCOS
11450 "riscos",
11451 #endif
11452 #ifdef UNIX
11453 "unix",
11454 #endif
11455 #ifdef VMS
11456 "vms",
11457 #endif
11458 #ifdef WIN16
11459 "win16",
11460 #endif
11461 #ifdef WIN32
11462 "win32",
11463 #endif
11464 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11465 "win32unix",
11466 #endif
11467 #if defined(WIN64) || defined(_WIN64)
11468 "win64",
11469 #endif
11470 #ifdef EBCDIC
11471 "ebcdic",
11472 #endif
11473 #ifndef CASE_INSENSITIVE_FILENAME
11474 "fname_case",
11475 #endif
11476 #ifdef FEAT_ARABIC
11477 "arabic",
11478 #endif
11479 #ifdef FEAT_AUTOCMD
11480 "autocmd",
11481 #endif
11482 #ifdef FEAT_BEVAL
11483 "balloon_eval",
11484 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11485 "balloon_multiline",
11486 # endif
11487 #endif
11488 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11489 "builtin_terms",
11490 # ifdef ALL_BUILTIN_TCAPS
11491 "all_builtin_terms",
11492 # endif
11493 #endif
11494 #ifdef FEAT_BYTEOFF
11495 "byte_offset",
11496 #endif
11497 #ifdef FEAT_CINDENT
11498 "cindent",
11499 #endif
11500 #ifdef FEAT_CLIENTSERVER
11501 "clientserver",
11502 #endif
11503 #ifdef FEAT_CLIPBOARD
11504 "clipboard",
11505 #endif
11506 #ifdef FEAT_CMDL_COMPL
11507 "cmdline_compl",
11508 #endif
11509 #ifdef FEAT_CMDHIST
11510 "cmdline_hist",
11511 #endif
11512 #ifdef FEAT_COMMENTS
11513 "comments",
11514 #endif
11515 #ifdef FEAT_CRYPT
11516 "cryptv",
11517 #endif
11518 #ifdef FEAT_CSCOPE
11519 "cscope",
11520 #endif
11521 #ifdef CURSOR_SHAPE
11522 "cursorshape",
11523 #endif
11524 #ifdef DEBUG
11525 "debug",
11526 #endif
11527 #ifdef FEAT_CON_DIALOG
11528 "dialog_con",
11529 #endif
11530 #ifdef FEAT_GUI_DIALOG
11531 "dialog_gui",
11532 #endif
11533 #ifdef FEAT_DIFF
11534 "diff",
11535 #endif
11536 #ifdef FEAT_DIGRAPHS
11537 "digraphs",
11538 #endif
11539 #ifdef FEAT_DND
11540 "dnd",
11541 #endif
11542 #ifdef FEAT_EMACS_TAGS
11543 "emacs_tags",
11544 #endif
11545 "eval", /* always present, of course! */
11546 #ifdef FEAT_EX_EXTRA
11547 "ex_extra",
11548 #endif
11549 #ifdef FEAT_SEARCH_EXTRA
11550 "extra_search",
11551 #endif
11552 #ifdef FEAT_FKMAP
11553 "farsi",
11554 #endif
11555 #ifdef FEAT_SEARCHPATH
11556 "file_in_path",
11557 #endif
11558 #if defined(UNIX) && !defined(USE_SYSTEM)
11559 "filterpipe",
11560 #endif
11561 #ifdef FEAT_FIND_ID
11562 "find_in_path",
11563 #endif
11564 #ifdef FEAT_FLOAT
11565 "float",
11566 #endif
11567 #ifdef FEAT_FOLDING
11568 "folding",
11569 #endif
11570 #ifdef FEAT_FOOTER
11571 "footer",
11572 #endif
11573 #if !defined(USE_SYSTEM) && defined(UNIX)
11574 "fork",
11575 #endif
11576 #ifdef FEAT_GETTEXT
11577 "gettext",
11578 #endif
11579 #ifdef FEAT_GUI
11580 "gui",
11581 #endif
11582 #ifdef FEAT_GUI_ATHENA
11583 # ifdef FEAT_GUI_NEXTAW
11584 "gui_neXtaw",
11585 # else
11586 "gui_athena",
11587 # endif
11588 #endif
11589 #ifdef FEAT_GUI_GTK
11590 "gui_gtk",
11591 # ifdef HAVE_GTK2
11592 "gui_gtk2",
11593 # endif
11594 #endif
11595 #ifdef FEAT_GUI_GNOME
11596 "gui_gnome",
11597 #endif
11598 #ifdef FEAT_GUI_MAC
11599 "gui_mac",
11600 #endif
11601 #ifdef FEAT_GUI_MOTIF
11602 "gui_motif",
11603 #endif
11604 #ifdef FEAT_GUI_PHOTON
11605 "gui_photon",
11606 #endif
11607 #ifdef FEAT_GUI_W16
11608 "gui_win16",
11609 #endif
11610 #ifdef FEAT_GUI_W32
11611 "gui_win32",
11612 #endif
11613 #ifdef FEAT_HANGULIN
11614 "hangul_input",
11615 #endif
11616 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11617 "iconv",
11618 #endif
11619 #ifdef FEAT_INS_EXPAND
11620 "insert_expand",
11621 #endif
11622 #ifdef FEAT_JUMPLIST
11623 "jumplist",
11624 #endif
11625 #ifdef FEAT_KEYMAP
11626 "keymap",
11627 #endif
11628 #ifdef FEAT_LANGMAP
11629 "langmap",
11630 #endif
11631 #ifdef FEAT_LIBCALL
11632 "libcall",
11633 #endif
11634 #ifdef FEAT_LINEBREAK
11635 "linebreak",
11636 #endif
11637 #ifdef FEAT_LISP
11638 "lispindent",
11639 #endif
11640 #ifdef FEAT_LISTCMDS
11641 "listcmds",
11642 #endif
11643 #ifdef FEAT_LOCALMAP
11644 "localmap",
11645 #endif
11646 #ifdef FEAT_MENU
11647 "menu",
11648 #endif
11649 #ifdef FEAT_SESSION
11650 "mksession",
11651 #endif
11652 #ifdef FEAT_MODIFY_FNAME
11653 "modify_fname",
11654 #endif
11655 #ifdef FEAT_MOUSE
11656 "mouse",
11657 #endif
11658 #ifdef FEAT_MOUSESHAPE
11659 "mouseshape",
11660 #endif
11661 #if defined(UNIX) || defined(VMS)
11662 # ifdef FEAT_MOUSE_DEC
11663 "mouse_dec",
11664 # endif
11665 # ifdef FEAT_MOUSE_GPM
11666 "mouse_gpm",
11667 # endif
11668 # ifdef FEAT_MOUSE_JSB
11669 "mouse_jsbterm",
11670 # endif
11671 # ifdef FEAT_MOUSE_NET
11672 "mouse_netterm",
11673 # endif
11674 # ifdef FEAT_MOUSE_PTERM
11675 "mouse_pterm",
11676 # endif
11677 # ifdef FEAT_SYSMOUSE
11678 "mouse_sysmouse",
11679 # endif
11680 # ifdef FEAT_MOUSE_XTERM
11681 "mouse_xterm",
11682 # endif
11683 #endif
11684 #ifdef FEAT_MBYTE
11685 "multi_byte",
11686 #endif
11687 #ifdef FEAT_MBYTE_IME
11688 "multi_byte_ime",
11689 #endif
11690 #ifdef FEAT_MULTI_LANG
11691 "multi_lang",
11692 #endif
11693 #ifdef FEAT_MZSCHEME
11694 #ifndef DYNAMIC_MZSCHEME
11695 "mzscheme",
11696 #endif
11697 #endif
11698 #ifdef FEAT_OLE
11699 "ole",
11700 #endif
11701 #ifdef FEAT_OSFILETYPE
11702 "osfiletype",
11703 #endif
11704 #ifdef FEAT_PATH_EXTRA
11705 "path_extra",
11706 #endif
11707 #ifdef FEAT_PERL
11708 #ifndef DYNAMIC_PERL
11709 "perl",
11710 #endif
11711 #endif
11712 #ifdef FEAT_PYTHON
11713 #ifndef DYNAMIC_PYTHON
11714 "python",
11715 #endif
11716 #endif
11717 #ifdef FEAT_POSTSCRIPT
11718 "postscript",
11719 #endif
11720 #ifdef FEAT_PRINTER
11721 "printer",
11722 #endif
11723 #ifdef FEAT_PROFILE
11724 "profile",
11725 #endif
11726 #ifdef FEAT_RELTIME
11727 "reltime",
11728 #endif
11729 #ifdef FEAT_QUICKFIX
11730 "quickfix",
11731 #endif
11732 #ifdef FEAT_RIGHTLEFT
11733 "rightleft",
11734 #endif
11735 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11736 "ruby",
11737 #endif
11738 #ifdef FEAT_SCROLLBIND
11739 "scrollbind",
11740 #endif
11741 #ifdef FEAT_CMDL_INFO
11742 "showcmd",
11743 "cmdline_info",
11744 #endif
11745 #ifdef FEAT_SIGNS
11746 "signs",
11747 #endif
11748 #ifdef FEAT_SMARTINDENT
11749 "smartindent",
11750 #endif
11751 #ifdef FEAT_SNIFF
11752 "sniff",
11753 #endif
11754 #ifdef STARTUPTIME
11755 "startuptime",
11756 #endif
11757 #ifdef FEAT_STL_OPT
11758 "statusline",
11759 #endif
11760 #ifdef FEAT_SUN_WORKSHOP
11761 "sun_workshop",
11762 #endif
11763 #ifdef FEAT_NETBEANS_INTG
11764 "netbeans_intg",
11765 #endif
11766 #ifdef FEAT_SPELL
11767 "spell",
11768 #endif
11769 #ifdef FEAT_SYN_HL
11770 "syntax",
11771 #endif
11772 #if defined(USE_SYSTEM) || !defined(UNIX)
11773 "system",
11774 #endif
11775 #ifdef FEAT_TAG_BINS
11776 "tag_binary",
11777 #endif
11778 #ifdef FEAT_TAG_OLDSTATIC
11779 "tag_old_static",
11780 #endif
11781 #ifdef FEAT_TAG_ANYWHITE
11782 "tag_any_white",
11783 #endif
11784 #ifdef FEAT_TCL
11785 # ifndef DYNAMIC_TCL
11786 "tcl",
11787 # endif
11788 #endif
11789 #ifdef TERMINFO
11790 "terminfo",
11791 #endif
11792 #ifdef FEAT_TERMRESPONSE
11793 "termresponse",
11794 #endif
11795 #ifdef FEAT_TEXTOBJ
11796 "textobjects",
11797 #endif
11798 #ifdef HAVE_TGETENT
11799 "tgetent",
11800 #endif
11801 #ifdef FEAT_TITLE
11802 "title",
11803 #endif
11804 #ifdef FEAT_TOOLBAR
11805 "toolbar",
11806 #endif
11807 #ifdef FEAT_USR_CMDS
11808 "user-commands", /* was accidentally included in 5.4 */
11809 "user_commands",
11810 #endif
11811 #ifdef FEAT_VIMINFO
11812 "viminfo",
11813 #endif
11814 #ifdef FEAT_VERTSPLIT
11815 "vertsplit",
11816 #endif
11817 #ifdef FEAT_VIRTUALEDIT
11818 "virtualedit",
11819 #endif
11820 #ifdef FEAT_VISUAL
11821 "visual",
11822 #endif
11823 #ifdef FEAT_VISUALEXTRA
11824 "visualextra",
11825 #endif
11826 #ifdef FEAT_VREPLACE
11827 "vreplace",
11828 #endif
11829 #ifdef FEAT_WILDIGN
11830 "wildignore",
11831 #endif
11832 #ifdef FEAT_WILDMENU
11833 "wildmenu",
11834 #endif
11835 #ifdef FEAT_WINDOWS
11836 "windows",
11837 #endif
11838 #ifdef FEAT_WAK
11839 "winaltkeys",
11840 #endif
11841 #ifdef FEAT_WRITEBACKUP
11842 "writebackup",
11843 #endif
11844 #ifdef FEAT_XIM
11845 "xim",
11846 #endif
11847 #ifdef FEAT_XFONTSET
11848 "xfontset",
11849 #endif
11850 #ifdef USE_XSMP
11851 "xsmp",
11852 #endif
11853 #ifdef USE_XSMP_INTERACT
11854 "xsmp_interact",
11855 #endif
11856 #ifdef FEAT_XCLIPBOARD
11857 "xterm_clipboard",
11858 #endif
11859 #ifdef FEAT_XTERM_SAVE
11860 "xterm_save",
11861 #endif
11862 #if defined(UNIX) && defined(FEAT_X11)
11863 "X11",
11864 #endif
11865 NULL
11868 name = get_tv_string(&argvars[0]);
11869 for (i = 0; has_list[i] != NULL; ++i)
11870 if (STRICMP(name, has_list[i]) == 0)
11872 n = TRUE;
11873 break;
11876 if (n == FALSE)
11878 if (STRNICMP(name, "patch", 5) == 0)
11879 n = has_patch(atoi((char *)name + 5));
11880 else if (STRICMP(name, "vim_starting") == 0)
11881 n = (starting != 0);
11882 #ifdef FEAT_MBYTE
11883 else if (STRICMP(name, "multi_byte_encoding") == 0)
11884 n = has_mbyte;
11885 #endif
11886 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11887 else if (STRICMP(name, "balloon_multiline") == 0)
11888 n = multiline_balloon_available();
11889 #endif
11890 #ifdef DYNAMIC_TCL
11891 else if (STRICMP(name, "tcl") == 0)
11892 n = tcl_enabled(FALSE);
11893 #endif
11894 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11895 else if (STRICMP(name, "iconv") == 0)
11896 n = iconv_enabled(FALSE);
11897 #endif
11898 #ifdef DYNAMIC_MZSCHEME
11899 else if (STRICMP(name, "mzscheme") == 0)
11900 n = mzscheme_enabled(FALSE);
11901 #endif
11902 #ifdef DYNAMIC_RUBY
11903 else if (STRICMP(name, "ruby") == 0)
11904 n = ruby_enabled(FALSE);
11905 #endif
11906 #ifdef DYNAMIC_PYTHON
11907 else if (STRICMP(name, "python") == 0)
11908 n = python_enabled(FALSE);
11909 #endif
11910 #ifdef DYNAMIC_PERL
11911 else if (STRICMP(name, "perl") == 0)
11912 n = perl_enabled(FALSE);
11913 #endif
11914 #ifdef FEAT_GUI
11915 else if (STRICMP(name, "gui_running") == 0)
11916 n = (gui.in_use || gui.starting);
11917 # ifdef FEAT_GUI_W32
11918 else if (STRICMP(name, "gui_win32s") == 0)
11919 n = gui_is_win32s();
11920 # endif
11921 # ifdef FEAT_BROWSE
11922 else if (STRICMP(name, "browse") == 0)
11923 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11924 # endif
11925 #endif
11926 #ifdef FEAT_SYN_HL
11927 else if (STRICMP(name, "syntax_items") == 0)
11928 n = syntax_present(curbuf);
11929 #endif
11930 #if defined(WIN3264)
11931 else if (STRICMP(name, "win95") == 0)
11932 n = mch_windows95();
11933 #endif
11934 #ifdef FEAT_NETBEANS_INTG
11935 else if (STRICMP(name, "netbeans_enabled") == 0)
11936 n = usingNetbeans;
11937 #endif
11940 rettv->vval.v_number = n;
11944 * "has_key()" function
11946 static void
11947 f_has_key(argvars, rettv)
11948 typval_T *argvars;
11949 typval_T *rettv;
11951 if (argvars[0].v_type != VAR_DICT)
11953 EMSG(_(e_dictreq));
11954 return;
11956 if (argvars[0].vval.v_dict == NULL)
11957 return;
11959 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11960 get_tv_string(&argvars[1]), -1) != NULL;
11964 * "haslocaldir()" function
11966 static void
11967 f_haslocaldir(argvars, rettv)
11968 typval_T *argvars UNUSED;
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 static void
12007 f_histadd(argvars, rettv)
12008 typval_T *argvars UNUSED;
12009 typval_T *rettv;
12011 #ifdef FEAT_CMDHIST
12012 int histype;
12013 char_u *str;
12014 char_u buf[NUMBUFLEN];
12015 #endif
12017 rettv->vval.v_number = FALSE;
12018 if (check_restricted() || check_secure())
12019 return;
12020 #ifdef FEAT_CMDHIST
12021 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12022 histype = str != NULL ? get_histtype(str) : -1;
12023 if (histype >= 0)
12025 str = get_tv_string_buf(&argvars[1], buf);
12026 if (*str != NUL)
12028 init_history();
12029 add_to_history(histype, str, FALSE, NUL);
12030 rettv->vval.v_number = TRUE;
12031 return;
12034 #endif
12038 * "histdel()" function
12040 static void
12041 f_histdel(argvars, rettv)
12042 typval_T *argvars UNUSED;
12043 typval_T *rettv UNUSED;
12045 #ifdef FEAT_CMDHIST
12046 int n;
12047 char_u buf[NUMBUFLEN];
12048 char_u *str;
12050 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12051 if (str == NULL)
12052 n = 0;
12053 else if (argvars[1].v_type == VAR_UNKNOWN)
12054 /* only one argument: clear entire history */
12055 n = clr_history(get_histtype(str));
12056 else if (argvars[1].v_type == VAR_NUMBER)
12057 /* index given: remove that entry */
12058 n = del_history_idx(get_histtype(str),
12059 (int)get_tv_number(&argvars[1]));
12060 else
12061 /* string given: remove all matching entries */
12062 n = del_history_entry(get_histtype(str),
12063 get_tv_string_buf(&argvars[1], buf));
12064 rettv->vval.v_number = n;
12065 #endif
12069 * "histget()" function
12071 static void
12072 f_histget(argvars, rettv)
12073 typval_T *argvars UNUSED;
12074 typval_T *rettv;
12076 #ifdef FEAT_CMDHIST
12077 int type;
12078 int idx;
12079 char_u *str;
12081 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12082 if (str == NULL)
12083 rettv->vval.v_string = NULL;
12084 else
12086 type = get_histtype(str);
12087 if (argvars[1].v_type == VAR_UNKNOWN)
12088 idx = get_history_idx(type);
12089 else
12090 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12091 /* -1 on type error */
12092 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12094 #else
12095 rettv->vval.v_string = NULL;
12096 #endif
12097 rettv->v_type = VAR_STRING;
12101 * "histnr()" function
12103 static void
12104 f_histnr(argvars, rettv)
12105 typval_T *argvars UNUSED;
12106 typval_T *rettv;
12108 int i;
12110 #ifdef FEAT_CMDHIST
12111 char_u *history = get_tv_string_chk(&argvars[0]);
12113 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12114 if (i >= HIST_CMD && i < HIST_COUNT)
12115 i = get_history_idx(i);
12116 else
12117 #endif
12118 i = -1;
12119 rettv->vval.v_number = i;
12123 * "highlightID(name)" function
12125 static void
12126 f_hlID(argvars, rettv)
12127 typval_T *argvars;
12128 typval_T *rettv;
12130 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12134 * "highlight_exists()" function
12136 static void
12137 f_hlexists(argvars, rettv)
12138 typval_T *argvars;
12139 typval_T *rettv;
12141 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12145 * "hostname()" function
12147 static void
12148 f_hostname(argvars, rettv)
12149 typval_T *argvars UNUSED;
12150 typval_T *rettv;
12152 char_u hostname[256];
12154 mch_get_host_name(hostname, 256);
12155 rettv->v_type = VAR_STRING;
12156 rettv->vval.v_string = vim_strsave(hostname);
12160 * iconv() function
12162 static void
12163 f_iconv(argvars, rettv)
12164 typval_T *argvars UNUSED;
12165 typval_T *rettv;
12167 #ifdef FEAT_MBYTE
12168 char_u buf1[NUMBUFLEN];
12169 char_u buf2[NUMBUFLEN];
12170 char_u *from, *to, *str;
12171 vimconv_T vimconv;
12172 #endif
12174 rettv->v_type = VAR_STRING;
12175 rettv->vval.v_string = NULL;
12177 #ifdef FEAT_MBYTE
12178 str = get_tv_string(&argvars[0]);
12179 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12180 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12181 vimconv.vc_type = CONV_NONE;
12182 convert_setup(&vimconv, from, to);
12184 /* If the encodings are equal, no conversion needed. */
12185 if (vimconv.vc_type == CONV_NONE)
12186 rettv->vval.v_string = vim_strsave(str);
12187 else
12188 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12190 convert_setup(&vimconv, NULL, NULL);
12191 vim_free(from);
12192 vim_free(to);
12193 #endif
12197 * "indent()" function
12199 static void
12200 f_indent(argvars, rettv)
12201 typval_T *argvars;
12202 typval_T *rettv;
12204 linenr_T lnum;
12206 lnum = get_tv_lnum(argvars);
12207 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12208 rettv->vval.v_number = get_indent_lnum(lnum);
12209 else
12210 rettv->vval.v_number = -1;
12214 * "index()" function
12216 static void
12217 f_index(argvars, rettv)
12218 typval_T *argvars;
12219 typval_T *rettv;
12221 list_T *l;
12222 listitem_T *item;
12223 long idx = 0;
12224 int ic = FALSE;
12226 rettv->vval.v_number = -1;
12227 if (argvars[0].v_type != VAR_LIST)
12229 EMSG(_(e_listreq));
12230 return;
12232 l = argvars[0].vval.v_list;
12233 if (l != NULL)
12235 item = l->lv_first;
12236 if (argvars[2].v_type != VAR_UNKNOWN)
12238 int error = FALSE;
12240 /* Start at specified item. Use the cached index that list_find()
12241 * sets, so that a negative number also works. */
12242 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12243 idx = l->lv_idx;
12244 if (argvars[3].v_type != VAR_UNKNOWN)
12245 ic = get_tv_number_chk(&argvars[3], &error);
12246 if (error)
12247 item = NULL;
12250 for ( ; item != NULL; item = item->li_next, ++idx)
12251 if (tv_equal(&item->li_tv, &argvars[1], ic))
12253 rettv->vval.v_number = idx;
12254 break;
12259 static int inputsecret_flag = 0;
12261 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12264 * This function is used by f_input() and f_inputdialog() functions. The third
12265 * argument to f_input() specifies the type of completion to use at the
12266 * prompt. The third argument to f_inputdialog() specifies the value to return
12267 * when the user cancels the prompt.
12269 static void
12270 get_user_input(argvars, rettv, inputdialog)
12271 typval_T *argvars;
12272 typval_T *rettv;
12273 int inputdialog;
12275 char_u *prompt = get_tv_string_chk(&argvars[0]);
12276 char_u *p = NULL;
12277 int c;
12278 char_u buf[NUMBUFLEN];
12279 int cmd_silent_save = cmd_silent;
12280 char_u *defstr = (char_u *)"";
12281 int xp_type = EXPAND_NOTHING;
12282 char_u *xp_arg = NULL;
12284 rettv->v_type = VAR_STRING;
12285 rettv->vval.v_string = NULL;
12287 #ifdef NO_CONSOLE_INPUT
12288 /* While starting up, there is no place to enter text. */
12289 if (no_console_input())
12290 return;
12291 #endif
12293 cmd_silent = FALSE; /* Want to see the prompt. */
12294 if (prompt != NULL)
12296 /* Only the part of the message after the last NL is considered as
12297 * prompt for the command line */
12298 p = vim_strrchr(prompt, '\n');
12299 if (p == NULL)
12300 p = prompt;
12301 else
12303 ++p;
12304 c = *p;
12305 *p = NUL;
12306 msg_start();
12307 msg_clr_eos();
12308 msg_puts_attr(prompt, echo_attr);
12309 msg_didout = FALSE;
12310 msg_starthere();
12311 *p = c;
12313 cmdline_row = msg_row;
12315 if (argvars[1].v_type != VAR_UNKNOWN)
12317 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12318 if (defstr != NULL)
12319 stuffReadbuffSpec(defstr);
12321 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12323 char_u *xp_name;
12324 int xp_namelen;
12325 long argt;
12327 rettv->vval.v_string = NULL;
12329 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12330 if (xp_name == NULL)
12331 return;
12333 xp_namelen = (int)STRLEN(xp_name);
12335 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12336 &xp_arg) == FAIL)
12337 return;
12341 if (defstr != NULL)
12342 rettv->vval.v_string =
12343 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12344 xp_type, xp_arg);
12346 vim_free(xp_arg);
12348 /* since the user typed this, no need to wait for return */
12349 need_wait_return = FALSE;
12350 msg_didout = FALSE;
12352 cmd_silent = cmd_silent_save;
12356 * "input()" function
12357 * Also handles inputsecret() when inputsecret is set.
12359 static void
12360 f_input(argvars, rettv)
12361 typval_T *argvars;
12362 typval_T *rettv;
12364 get_user_input(argvars, rettv, FALSE);
12368 * "inputdialog()" function
12370 static void
12371 f_inputdialog(argvars, rettv)
12372 typval_T *argvars;
12373 typval_T *rettv;
12375 #if defined(FEAT_GUI_TEXTDIALOG)
12376 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12377 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12379 char_u *message;
12380 char_u buf[NUMBUFLEN];
12381 char_u *defstr = (char_u *)"";
12383 message = get_tv_string_chk(&argvars[0]);
12384 if (argvars[1].v_type != VAR_UNKNOWN
12385 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12386 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12387 else
12388 IObuff[0] = NUL;
12389 if (message != NULL && defstr != NULL
12390 && do_dialog(VIM_QUESTION, NULL, message,
12391 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12392 rettv->vval.v_string = vim_strsave(IObuff);
12393 else
12395 if (message != NULL && defstr != NULL
12396 && argvars[1].v_type != VAR_UNKNOWN
12397 && argvars[2].v_type != VAR_UNKNOWN)
12398 rettv->vval.v_string = vim_strsave(
12399 get_tv_string_buf(&argvars[2], buf));
12400 else
12401 rettv->vval.v_string = NULL;
12403 rettv->v_type = VAR_STRING;
12405 else
12406 #endif
12407 get_user_input(argvars, rettv, TRUE);
12411 * "inputlist()" function
12413 static void
12414 f_inputlist(argvars, rettv)
12415 typval_T *argvars;
12416 typval_T *rettv;
12418 listitem_T *li;
12419 int selected;
12420 int mouse_used;
12422 #ifdef NO_CONSOLE_INPUT
12423 /* While starting up, there is no place to enter text. */
12424 if (no_console_input())
12425 return;
12426 #endif
12427 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12429 EMSG2(_(e_listarg), "inputlist()");
12430 return;
12433 msg_start();
12434 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12435 lines_left = Rows; /* avoid more prompt */
12436 msg_scroll = TRUE;
12437 msg_clr_eos();
12439 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12441 msg_puts(get_tv_string(&li->li_tv));
12442 msg_putchar('\n');
12445 /* Ask for choice. */
12446 selected = prompt_for_number(&mouse_used);
12447 if (mouse_used)
12448 selected -= lines_left;
12450 rettv->vval.v_number = selected;
12454 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12457 * "inputrestore()" function
12459 static void
12460 f_inputrestore(argvars, rettv)
12461 typval_T *argvars UNUSED;
12462 typval_T *rettv;
12464 if (ga_userinput.ga_len > 0)
12466 --ga_userinput.ga_len;
12467 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12468 + ga_userinput.ga_len);
12469 /* default return is zero == OK */
12471 else if (p_verbose > 1)
12473 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12474 rettv->vval.v_number = 1; /* Failed */
12479 * "inputsave()" function
12481 static void
12482 f_inputsave(argvars, rettv)
12483 typval_T *argvars UNUSED;
12484 typval_T *rettv;
12486 /* Add an entry to the stack of typeahead storage. */
12487 if (ga_grow(&ga_userinput, 1) == OK)
12489 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12490 + ga_userinput.ga_len);
12491 ++ga_userinput.ga_len;
12492 /* default return is zero == OK */
12494 else
12495 rettv->vval.v_number = 1; /* Failed */
12499 * "inputsecret()" function
12501 static void
12502 f_inputsecret(argvars, rettv)
12503 typval_T *argvars;
12504 typval_T *rettv;
12506 ++cmdline_star;
12507 ++inputsecret_flag;
12508 f_input(argvars, rettv);
12509 --cmdline_star;
12510 --inputsecret_flag;
12514 * "insert()" function
12516 static void
12517 f_insert(argvars, rettv)
12518 typval_T *argvars;
12519 typval_T *rettv;
12521 long before = 0;
12522 listitem_T *item;
12523 list_T *l;
12524 int error = FALSE;
12526 if (argvars[0].v_type != VAR_LIST)
12527 EMSG2(_(e_listarg), "insert()");
12528 else if ((l = argvars[0].vval.v_list) != NULL
12529 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12531 if (argvars[2].v_type != VAR_UNKNOWN)
12532 before = get_tv_number_chk(&argvars[2], &error);
12533 if (error)
12534 return; /* type error; errmsg already given */
12536 if (before == l->lv_len)
12537 item = NULL;
12538 else
12540 item = list_find(l, before);
12541 if (item == NULL)
12543 EMSGN(_(e_listidx), before);
12544 l = NULL;
12547 if (l != NULL)
12549 list_insert_tv(l, &argvars[1], item);
12550 copy_tv(&argvars[0], rettv);
12556 * "isdirectory()" function
12558 static void
12559 f_isdirectory(argvars, rettv)
12560 typval_T *argvars;
12561 typval_T *rettv;
12563 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12567 * "islocked()" function
12569 static void
12570 f_islocked(argvars, rettv)
12571 typval_T *argvars;
12572 typval_T *rettv;
12574 lval_T lv;
12575 char_u *end;
12576 dictitem_T *di;
12578 rettv->vval.v_number = -1;
12579 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12580 FNE_CHECK_START);
12581 if (end != NULL && lv.ll_name != NULL)
12583 if (*end != NUL)
12584 EMSG(_(e_trailing));
12585 else
12587 if (lv.ll_tv == NULL)
12589 if (check_changedtick(lv.ll_name))
12590 rettv->vval.v_number = 1; /* always locked */
12591 else
12593 di = find_var(lv.ll_name, NULL);
12594 if (di != NULL)
12596 /* Consider a variable locked when:
12597 * 1. the variable itself is locked
12598 * 2. the value of the variable is locked.
12599 * 3. the List or Dict value is locked.
12601 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12602 || tv_islocked(&di->di_tv));
12606 else if (lv.ll_range)
12607 EMSG(_("E786: Range not allowed"));
12608 else if (lv.ll_newkey != NULL)
12609 EMSG2(_(e_dictkey), lv.ll_newkey);
12610 else if (lv.ll_list != NULL)
12611 /* List item. */
12612 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12613 else
12614 /* Dictionary item. */
12615 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12619 clear_lval(&lv);
12622 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12625 * Turn a dict into a list:
12626 * "what" == 0: list of keys
12627 * "what" == 1: list of values
12628 * "what" == 2: list of items
12630 static void
12631 dict_list(argvars, rettv, what)
12632 typval_T *argvars;
12633 typval_T *rettv;
12634 int what;
12636 list_T *l2;
12637 dictitem_T *di;
12638 hashitem_T *hi;
12639 listitem_T *li;
12640 listitem_T *li2;
12641 dict_T *d;
12642 int todo;
12644 if (argvars[0].v_type != VAR_DICT)
12646 EMSG(_(e_dictreq));
12647 return;
12649 if ((d = argvars[0].vval.v_dict) == NULL)
12650 return;
12652 if (rettv_list_alloc(rettv) == FAIL)
12653 return;
12655 todo = (int)d->dv_hashtab.ht_used;
12656 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12658 if (!HASHITEM_EMPTY(hi))
12660 --todo;
12661 di = HI2DI(hi);
12663 li = listitem_alloc();
12664 if (li == NULL)
12665 break;
12666 list_append(rettv->vval.v_list, li);
12668 if (what == 0)
12670 /* keys() */
12671 li->li_tv.v_type = VAR_STRING;
12672 li->li_tv.v_lock = 0;
12673 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12675 else if (what == 1)
12677 /* values() */
12678 copy_tv(&di->di_tv, &li->li_tv);
12680 else
12682 /* items() */
12683 l2 = list_alloc();
12684 li->li_tv.v_type = VAR_LIST;
12685 li->li_tv.v_lock = 0;
12686 li->li_tv.vval.v_list = l2;
12687 if (l2 == NULL)
12688 break;
12689 ++l2->lv_refcount;
12691 li2 = listitem_alloc();
12692 if (li2 == NULL)
12693 break;
12694 list_append(l2, li2);
12695 li2->li_tv.v_type = VAR_STRING;
12696 li2->li_tv.v_lock = 0;
12697 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12699 li2 = listitem_alloc();
12700 if (li2 == NULL)
12701 break;
12702 list_append(l2, li2);
12703 copy_tv(&di->di_tv, &li2->li_tv);
12710 * "items(dict)" function
12712 static void
12713 f_items(argvars, rettv)
12714 typval_T *argvars;
12715 typval_T *rettv;
12717 dict_list(argvars, rettv, 2);
12721 * "join()" function
12723 static void
12724 f_join(argvars, rettv)
12725 typval_T *argvars;
12726 typval_T *rettv;
12728 garray_T ga;
12729 char_u *sep;
12731 if (argvars[0].v_type != VAR_LIST)
12733 EMSG(_(e_listreq));
12734 return;
12736 if (argvars[0].vval.v_list == NULL)
12737 return;
12738 if (argvars[1].v_type == VAR_UNKNOWN)
12739 sep = (char_u *)" ";
12740 else
12741 sep = get_tv_string_chk(&argvars[1]);
12743 rettv->v_type = VAR_STRING;
12745 if (sep != NULL)
12747 ga_init2(&ga, (int)sizeof(char), 80);
12748 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12749 ga_append(&ga, NUL);
12750 rettv->vval.v_string = (char_u *)ga.ga_data;
12752 else
12753 rettv->vval.v_string = NULL;
12757 * "keys()" function
12759 static void
12760 f_keys(argvars, rettv)
12761 typval_T *argvars;
12762 typval_T *rettv;
12764 dict_list(argvars, rettv, 0);
12768 * "last_buffer_nr()" function.
12770 static void
12771 f_last_buffer_nr(argvars, rettv)
12772 typval_T *argvars UNUSED;
12773 typval_T *rettv;
12775 int n = 0;
12776 buf_T *buf;
12778 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12779 if (n < buf->b_fnum)
12780 n = buf->b_fnum;
12782 rettv->vval.v_number = n;
12786 * "len()" function
12788 static void
12789 f_len(argvars, rettv)
12790 typval_T *argvars;
12791 typval_T *rettv;
12793 switch (argvars[0].v_type)
12795 case VAR_STRING:
12796 case VAR_NUMBER:
12797 rettv->vval.v_number = (varnumber_T)STRLEN(
12798 get_tv_string(&argvars[0]));
12799 break;
12800 case VAR_LIST:
12801 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12802 break;
12803 case VAR_DICT:
12804 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12805 break;
12806 default:
12807 EMSG(_("E701: Invalid type for len()"));
12808 break;
12812 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12814 static void
12815 libcall_common(argvars, rettv, type)
12816 typval_T *argvars;
12817 typval_T *rettv;
12818 int type;
12820 #ifdef FEAT_LIBCALL
12821 char_u *string_in;
12822 char_u **string_result;
12823 int nr_result;
12824 #endif
12826 rettv->v_type = type;
12827 if (type != VAR_NUMBER)
12828 rettv->vval.v_string = NULL;
12830 if (check_restricted() || check_secure())
12831 return;
12833 #ifdef FEAT_LIBCALL
12834 /* The first two args must be strings, otherwise its meaningless */
12835 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12837 string_in = NULL;
12838 if (argvars[2].v_type == VAR_STRING)
12839 string_in = argvars[2].vval.v_string;
12840 if (type == VAR_NUMBER)
12841 string_result = NULL;
12842 else
12843 string_result = &rettv->vval.v_string;
12844 if (mch_libcall(argvars[0].vval.v_string,
12845 argvars[1].vval.v_string,
12846 string_in,
12847 argvars[2].vval.v_number,
12848 string_result,
12849 &nr_result) == OK
12850 && type == VAR_NUMBER)
12851 rettv->vval.v_number = nr_result;
12853 #endif
12857 * "libcall()" function
12859 static void
12860 f_libcall(argvars, rettv)
12861 typval_T *argvars;
12862 typval_T *rettv;
12864 libcall_common(argvars, rettv, VAR_STRING);
12868 * "libcallnr()" function
12870 static void
12871 f_libcallnr(argvars, rettv)
12872 typval_T *argvars;
12873 typval_T *rettv;
12875 libcall_common(argvars, rettv, VAR_NUMBER);
12879 * "line(string)" function
12881 static void
12882 f_line(argvars, rettv)
12883 typval_T *argvars;
12884 typval_T *rettv;
12886 linenr_T lnum = 0;
12887 pos_T *fp;
12888 int fnum;
12890 fp = var2fpos(&argvars[0], TRUE, &fnum);
12891 if (fp != NULL)
12892 lnum = fp->lnum;
12893 rettv->vval.v_number = lnum;
12897 * "line2byte(lnum)" function
12899 static void
12900 f_line2byte(argvars, rettv)
12901 typval_T *argvars UNUSED;
12902 typval_T *rettv;
12904 #ifndef FEAT_BYTEOFF
12905 rettv->vval.v_number = -1;
12906 #else
12907 linenr_T lnum;
12909 lnum = get_tv_lnum(argvars);
12910 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12911 rettv->vval.v_number = -1;
12912 else
12913 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12914 if (rettv->vval.v_number >= 0)
12915 ++rettv->vval.v_number;
12916 #endif
12920 * "lispindent(lnum)" function
12922 static void
12923 f_lispindent(argvars, rettv)
12924 typval_T *argvars;
12925 typval_T *rettv;
12927 #ifdef FEAT_LISP
12928 pos_T pos;
12929 linenr_T lnum;
12931 pos = curwin->w_cursor;
12932 lnum = get_tv_lnum(argvars);
12933 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12935 curwin->w_cursor.lnum = lnum;
12936 rettv->vval.v_number = get_lisp_indent();
12937 curwin->w_cursor = pos;
12939 else
12940 #endif
12941 rettv->vval.v_number = -1;
12945 * "localtime()" function
12947 static void
12948 f_localtime(argvars, rettv)
12949 typval_T *argvars UNUSED;
12950 typval_T *rettv;
12952 rettv->vval.v_number = (varnumber_T)time(NULL);
12955 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12957 static void
12958 get_maparg(argvars, rettv, exact)
12959 typval_T *argvars;
12960 typval_T *rettv;
12961 int exact;
12963 char_u *keys;
12964 char_u *which;
12965 char_u buf[NUMBUFLEN];
12966 char_u *keys_buf = NULL;
12967 char_u *rhs;
12968 int mode;
12969 garray_T ga;
12970 int abbr = FALSE;
12972 /* return empty string for failure */
12973 rettv->v_type = VAR_STRING;
12974 rettv->vval.v_string = NULL;
12976 keys = get_tv_string(&argvars[0]);
12977 if (*keys == NUL)
12978 return;
12980 if (argvars[1].v_type != VAR_UNKNOWN)
12982 which = get_tv_string_buf_chk(&argvars[1], buf);
12983 if (argvars[2].v_type != VAR_UNKNOWN)
12984 abbr = get_tv_number(&argvars[2]);
12986 else
12987 which = (char_u *)"";
12988 if (which == NULL)
12989 return;
12991 mode = get_map_mode(&which, 0);
12993 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12994 rhs = check_map(keys, mode, exact, FALSE, abbr);
12995 vim_free(keys_buf);
12996 if (rhs != NULL)
12998 ga_init(&ga);
12999 ga.ga_itemsize = 1;
13000 ga.ga_growsize = 40;
13002 while (*rhs != NUL)
13003 ga_concat(&ga, str2special(&rhs, FALSE));
13005 ga_append(&ga, NUL);
13006 rettv->vval.v_string = (char_u *)ga.ga_data;
13010 #ifdef FEAT_FLOAT
13012 * "log10()" function
13014 static void
13015 f_log10(argvars, rettv)
13016 typval_T *argvars;
13017 typval_T *rettv;
13019 float_T f;
13021 rettv->v_type = VAR_FLOAT;
13022 if (get_float_arg(argvars, &f) == OK)
13023 rettv->vval.v_float = log10(f);
13024 else
13025 rettv->vval.v_float = 0.0;
13027 #endif
13030 * "map()" function
13032 static void
13033 f_map(argvars, rettv)
13034 typval_T *argvars;
13035 typval_T *rettv;
13037 filter_map(argvars, rettv, TRUE);
13041 * "maparg()" function
13043 static void
13044 f_maparg(argvars, rettv)
13045 typval_T *argvars;
13046 typval_T *rettv;
13048 get_maparg(argvars, rettv, TRUE);
13052 * "mapcheck()" function
13054 static void
13055 f_mapcheck(argvars, rettv)
13056 typval_T *argvars;
13057 typval_T *rettv;
13059 get_maparg(argvars, rettv, FALSE);
13062 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13064 static void
13065 find_some_match(argvars, rettv, type)
13066 typval_T *argvars;
13067 typval_T *rettv;
13068 int type;
13070 char_u *str = NULL;
13071 char_u *expr = NULL;
13072 char_u *pat;
13073 regmatch_T regmatch;
13074 char_u patbuf[NUMBUFLEN];
13075 char_u strbuf[NUMBUFLEN];
13076 char_u *save_cpo;
13077 long start = 0;
13078 long nth = 1;
13079 colnr_T startcol = 0;
13080 int match = 0;
13081 list_T *l = NULL;
13082 listitem_T *li = NULL;
13083 long idx = 0;
13084 char_u *tofree = NULL;
13086 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13087 save_cpo = p_cpo;
13088 p_cpo = (char_u *)"";
13090 rettv->vval.v_number = -1;
13091 if (type == 3)
13093 /* return empty list when there are no matches */
13094 if (rettv_list_alloc(rettv) == FAIL)
13095 goto theend;
13097 else if (type == 2)
13099 rettv->v_type = VAR_STRING;
13100 rettv->vval.v_string = NULL;
13103 if (argvars[0].v_type == VAR_LIST)
13105 if ((l = argvars[0].vval.v_list) == NULL)
13106 goto theend;
13107 li = l->lv_first;
13109 else
13110 expr = str = get_tv_string(&argvars[0]);
13112 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13113 if (pat == NULL)
13114 goto theend;
13116 if (argvars[2].v_type != VAR_UNKNOWN)
13118 int error = FALSE;
13120 start = get_tv_number_chk(&argvars[2], &error);
13121 if (error)
13122 goto theend;
13123 if (l != NULL)
13125 li = list_find(l, start);
13126 if (li == NULL)
13127 goto theend;
13128 idx = l->lv_idx; /* use the cached index */
13130 else
13132 if (start < 0)
13133 start = 0;
13134 if (start > (long)STRLEN(str))
13135 goto theend;
13136 /* When "count" argument is there ignore matches before "start",
13137 * otherwise skip part of the string. Differs when pattern is "^"
13138 * or "\<". */
13139 if (argvars[3].v_type != VAR_UNKNOWN)
13140 startcol = start;
13141 else
13142 str += start;
13145 if (argvars[3].v_type != VAR_UNKNOWN)
13146 nth = get_tv_number_chk(&argvars[3], &error);
13147 if (error)
13148 goto theend;
13151 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13152 if (regmatch.regprog != NULL)
13154 regmatch.rm_ic = p_ic;
13156 for (;;)
13158 if (l != NULL)
13160 if (li == NULL)
13162 match = FALSE;
13163 break;
13165 vim_free(tofree);
13166 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13167 if (str == NULL)
13168 break;
13171 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13173 if (match && --nth <= 0)
13174 break;
13175 if (l == NULL && !match)
13176 break;
13178 /* Advance to just after the match. */
13179 if (l != NULL)
13181 li = li->li_next;
13182 ++idx;
13184 else
13186 #ifdef FEAT_MBYTE
13187 startcol = (colnr_T)(regmatch.startp[0]
13188 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13189 #else
13190 startcol = regmatch.startp[0] + 1 - str;
13191 #endif
13195 if (match)
13197 if (type == 3)
13199 int i;
13201 /* return list with matched string and submatches */
13202 for (i = 0; i < NSUBEXP; ++i)
13204 if (regmatch.endp[i] == NULL)
13206 if (list_append_string(rettv->vval.v_list,
13207 (char_u *)"", 0) == FAIL)
13208 break;
13210 else if (list_append_string(rettv->vval.v_list,
13211 regmatch.startp[i],
13212 (int)(regmatch.endp[i] - regmatch.startp[i]))
13213 == FAIL)
13214 break;
13217 else if (type == 2)
13219 /* return matched string */
13220 if (l != NULL)
13221 copy_tv(&li->li_tv, rettv);
13222 else
13223 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13224 (int)(regmatch.endp[0] - regmatch.startp[0]));
13226 else if (l != NULL)
13227 rettv->vval.v_number = idx;
13228 else
13230 if (type != 0)
13231 rettv->vval.v_number =
13232 (varnumber_T)(regmatch.startp[0] - str);
13233 else
13234 rettv->vval.v_number =
13235 (varnumber_T)(regmatch.endp[0] - str);
13236 rettv->vval.v_number += (varnumber_T)(str - expr);
13239 vim_free(regmatch.regprog);
13242 theend:
13243 vim_free(tofree);
13244 p_cpo = save_cpo;
13248 * "match()" function
13250 static void
13251 f_match(argvars, rettv)
13252 typval_T *argvars;
13253 typval_T *rettv;
13255 find_some_match(argvars, rettv, 1);
13259 * "matchadd()" function
13261 static void
13262 f_matchadd(argvars, rettv)
13263 typval_T *argvars;
13264 typval_T *rettv;
13266 #ifdef FEAT_SEARCH_EXTRA
13267 char_u buf[NUMBUFLEN];
13268 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13269 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13270 int prio = 10; /* default priority */
13271 int id = -1;
13272 int error = FALSE;
13274 rettv->vval.v_number = -1;
13276 if (grp == NULL || pat == NULL)
13277 return;
13278 if (argvars[2].v_type != VAR_UNKNOWN)
13280 prio = get_tv_number_chk(&argvars[2], &error);
13281 if (argvars[3].v_type != VAR_UNKNOWN)
13282 id = get_tv_number_chk(&argvars[3], &error);
13284 if (error == TRUE)
13285 return;
13286 if (id >= 1 && id <= 3)
13288 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13289 return;
13292 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13293 #endif
13297 * "matcharg()" function
13299 static void
13300 f_matcharg(argvars, rettv)
13301 typval_T *argvars;
13302 typval_T *rettv;
13304 if (rettv_list_alloc(rettv) == OK)
13306 #ifdef FEAT_SEARCH_EXTRA
13307 int id = get_tv_number(&argvars[0]);
13308 matchitem_T *m;
13310 if (id >= 1 && id <= 3)
13312 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13314 list_append_string(rettv->vval.v_list,
13315 syn_id2name(m->hlg_id), -1);
13316 list_append_string(rettv->vval.v_list, m->pattern, -1);
13318 else
13320 list_append_string(rettv->vval.v_list, NUL, -1);
13321 list_append_string(rettv->vval.v_list, NUL, -1);
13324 #endif
13329 * "matchdelete()" function
13331 static void
13332 f_matchdelete(argvars, rettv)
13333 typval_T *argvars;
13334 typval_T *rettv;
13336 #ifdef FEAT_SEARCH_EXTRA
13337 rettv->vval.v_number = match_delete(curwin,
13338 (int)get_tv_number(&argvars[0]), TRUE);
13339 #endif
13343 * "matchend()" function
13345 static void
13346 f_matchend(argvars, rettv)
13347 typval_T *argvars;
13348 typval_T *rettv;
13350 find_some_match(argvars, rettv, 0);
13354 * "matchlist()" function
13356 static void
13357 f_matchlist(argvars, rettv)
13358 typval_T *argvars;
13359 typval_T *rettv;
13361 find_some_match(argvars, rettv, 3);
13365 * "matchstr()" function
13367 static void
13368 f_matchstr(argvars, rettv)
13369 typval_T *argvars;
13370 typval_T *rettv;
13372 find_some_match(argvars, rettv, 2);
13375 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13377 static void
13378 max_min(argvars, rettv, domax)
13379 typval_T *argvars;
13380 typval_T *rettv;
13381 int domax;
13383 long n = 0;
13384 long i;
13385 int error = FALSE;
13387 if (argvars[0].v_type == VAR_LIST)
13389 list_T *l;
13390 listitem_T *li;
13392 l = argvars[0].vval.v_list;
13393 if (l != NULL)
13395 li = l->lv_first;
13396 if (li != NULL)
13398 n = get_tv_number_chk(&li->li_tv, &error);
13399 for (;;)
13401 li = li->li_next;
13402 if (li == NULL)
13403 break;
13404 i = get_tv_number_chk(&li->li_tv, &error);
13405 if (domax ? i > n : i < n)
13406 n = i;
13411 else if (argvars[0].v_type == VAR_DICT)
13413 dict_T *d;
13414 int first = TRUE;
13415 hashitem_T *hi;
13416 int todo;
13418 d = argvars[0].vval.v_dict;
13419 if (d != NULL)
13421 todo = (int)d->dv_hashtab.ht_used;
13422 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13424 if (!HASHITEM_EMPTY(hi))
13426 --todo;
13427 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13428 if (first)
13430 n = i;
13431 first = FALSE;
13433 else if (domax ? i > n : i < n)
13434 n = i;
13439 else
13440 EMSG(_(e_listdictarg));
13441 rettv->vval.v_number = error ? 0 : n;
13445 * "max()" function
13447 static void
13448 f_max(argvars, rettv)
13449 typval_T *argvars;
13450 typval_T *rettv;
13452 max_min(argvars, rettv, TRUE);
13456 * "min()" function
13458 static void
13459 f_min(argvars, rettv)
13460 typval_T *argvars;
13461 typval_T *rettv;
13463 max_min(argvars, rettv, FALSE);
13466 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13469 * Create the directory in which "dir" is located, and higher levels when
13470 * needed.
13472 static int
13473 mkdir_recurse(dir, prot)
13474 char_u *dir;
13475 int prot;
13477 char_u *p;
13478 char_u *updir;
13479 int r = FAIL;
13481 /* Get end of directory name in "dir".
13482 * We're done when it's "/" or "c:/". */
13483 p = gettail_sep(dir);
13484 if (p <= get_past_head(dir))
13485 return OK;
13487 /* If the directory exists we're done. Otherwise: create it.*/
13488 updir = vim_strnsave(dir, (int)(p - dir));
13489 if (updir == NULL)
13490 return FAIL;
13491 if (mch_isdir(updir))
13492 r = OK;
13493 else if (mkdir_recurse(updir, prot) == OK)
13494 r = vim_mkdir_emsg(updir, prot);
13495 vim_free(updir);
13496 return r;
13499 #ifdef vim_mkdir
13501 * "mkdir()" function
13503 static void
13504 f_mkdir(argvars, rettv)
13505 typval_T *argvars;
13506 typval_T *rettv;
13508 char_u *dir;
13509 char_u buf[NUMBUFLEN];
13510 int prot = 0755;
13512 rettv->vval.v_number = FAIL;
13513 if (check_restricted() || check_secure())
13514 return;
13516 dir = get_tv_string_buf(&argvars[0], buf);
13517 if (argvars[1].v_type != VAR_UNKNOWN)
13519 if (argvars[2].v_type != VAR_UNKNOWN)
13520 prot = get_tv_number_chk(&argvars[2], NULL);
13521 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13522 mkdir_recurse(dir, prot);
13524 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13526 #endif
13529 * "mode()" function
13531 static void
13532 f_mode(argvars, rettv)
13533 typval_T *argvars;
13534 typval_T *rettv;
13536 char_u buf[3];
13538 buf[1] = NUL;
13539 buf[2] = NUL;
13541 #ifdef FEAT_VISUAL
13542 if (VIsual_active)
13544 if (VIsual_select)
13545 buf[0] = VIsual_mode + 's' - 'v';
13546 else
13547 buf[0] = VIsual_mode;
13549 else
13550 #endif
13551 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13552 || State == CONFIRM)
13554 buf[0] = 'r';
13555 if (State == ASKMORE)
13556 buf[1] = 'm';
13557 else if (State == CONFIRM)
13558 buf[1] = '?';
13560 else if (State == EXTERNCMD)
13561 buf[0] = '!';
13562 else if (State & INSERT)
13564 #ifdef FEAT_VREPLACE
13565 if (State & VREPLACE_FLAG)
13567 buf[0] = 'R';
13568 buf[1] = 'v';
13570 else
13571 #endif
13572 if (State & REPLACE_FLAG)
13573 buf[0] = 'R';
13574 else
13575 buf[0] = 'i';
13577 else if (State & CMDLINE)
13579 buf[0] = 'c';
13580 if (exmode_active)
13581 buf[1] = 'v';
13583 else if (exmode_active)
13585 buf[0] = 'c';
13586 buf[1] = 'e';
13588 else
13590 buf[0] = 'n';
13591 if (finish_op)
13592 buf[1] = 'o';
13595 /* Clear out the minor mode when the argument is not a non-zero number or
13596 * non-empty string. */
13597 if (!non_zero_arg(&argvars[0]))
13598 buf[1] = NUL;
13600 rettv->vval.v_string = vim_strsave(buf);
13601 rettv->v_type = VAR_STRING;
13604 #ifdef FEAT_MZSCHEME
13606 * "mzeval()" function
13608 static void
13609 f_mzeval(argvars, rettv)
13610 typval_T *argvars;
13611 typval_T *rettv;
13613 char_u *str;
13614 char_u buf[NUMBUFLEN];
13616 str = get_tv_string_buf(&argvars[0], buf);
13617 do_mzeval(str, rettv);
13619 #endif
13622 * "nextnonblank()" function
13624 static void
13625 f_nextnonblank(argvars, rettv)
13626 typval_T *argvars;
13627 typval_T *rettv;
13629 linenr_T lnum;
13631 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13633 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13635 lnum = 0;
13636 break;
13638 if (*skipwhite(ml_get(lnum)) != NUL)
13639 break;
13641 rettv->vval.v_number = lnum;
13645 * "nr2char()" function
13647 static void
13648 f_nr2char(argvars, rettv)
13649 typval_T *argvars;
13650 typval_T *rettv;
13652 char_u buf[NUMBUFLEN];
13654 #ifdef FEAT_MBYTE
13655 if (has_mbyte)
13656 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13657 else
13658 #endif
13660 buf[0] = (char_u)get_tv_number(&argvars[0]);
13661 buf[1] = NUL;
13663 rettv->v_type = VAR_STRING;
13664 rettv->vval.v_string = vim_strsave(buf);
13668 * "pathshorten()" function
13670 static void
13671 f_pathshorten(argvars, rettv)
13672 typval_T *argvars;
13673 typval_T *rettv;
13675 char_u *p;
13677 rettv->v_type = VAR_STRING;
13678 p = get_tv_string_chk(&argvars[0]);
13679 if (p == NULL)
13680 rettv->vval.v_string = NULL;
13681 else
13683 p = vim_strsave(p);
13684 rettv->vval.v_string = p;
13685 if (p != NULL)
13686 shorten_dir(p);
13690 #ifdef FEAT_FLOAT
13692 * "pow()" function
13694 static void
13695 f_pow(argvars, rettv)
13696 typval_T *argvars;
13697 typval_T *rettv;
13699 float_T fx, fy;
13701 rettv->v_type = VAR_FLOAT;
13702 if (get_float_arg(argvars, &fx) == OK
13703 && get_float_arg(&argvars[1], &fy) == OK)
13704 rettv->vval.v_float = pow(fx, fy);
13705 else
13706 rettv->vval.v_float = 0.0;
13708 #endif
13711 * "prevnonblank()" function
13713 static void
13714 f_prevnonblank(argvars, rettv)
13715 typval_T *argvars;
13716 typval_T *rettv;
13718 linenr_T lnum;
13720 lnum = get_tv_lnum(argvars);
13721 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13722 lnum = 0;
13723 else
13724 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13725 --lnum;
13726 rettv->vval.v_number = lnum;
13729 #ifdef HAVE_STDARG_H
13730 /* This dummy va_list is here because:
13731 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13732 * - locally in the function results in a "used before set" warning
13733 * - using va_start() to initialize it gives "function with fixed args" error */
13734 static va_list ap;
13735 #endif
13738 * "printf()" function
13740 static void
13741 f_printf(argvars, rettv)
13742 typval_T *argvars;
13743 typval_T *rettv;
13745 rettv->v_type = VAR_STRING;
13746 rettv->vval.v_string = NULL;
13747 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13749 char_u buf[NUMBUFLEN];
13750 int len;
13751 char_u *s;
13752 int saved_did_emsg = did_emsg;
13753 char *fmt;
13755 /* Get the required length, allocate the buffer and do it for real. */
13756 did_emsg = FALSE;
13757 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13758 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13759 if (!did_emsg)
13761 s = alloc(len + 1);
13762 if (s != NULL)
13764 rettv->vval.v_string = s;
13765 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13768 did_emsg |= saved_did_emsg;
13770 #endif
13774 * "pumvisible()" function
13776 static void
13777 f_pumvisible(argvars, rettv)
13778 typval_T *argvars UNUSED;
13779 typval_T *rettv UNUSED;
13781 #ifdef FEAT_INS_EXPAND
13782 if (pum_visible())
13783 rettv->vval.v_number = 1;
13784 #endif
13788 * "range()" function
13790 static void
13791 f_range(argvars, rettv)
13792 typval_T *argvars;
13793 typval_T *rettv;
13795 long start;
13796 long end;
13797 long stride = 1;
13798 long i;
13799 int error = FALSE;
13801 start = get_tv_number_chk(&argvars[0], &error);
13802 if (argvars[1].v_type == VAR_UNKNOWN)
13804 end = start - 1;
13805 start = 0;
13807 else
13809 end = get_tv_number_chk(&argvars[1], &error);
13810 if (argvars[2].v_type != VAR_UNKNOWN)
13811 stride = get_tv_number_chk(&argvars[2], &error);
13814 if (error)
13815 return; /* type error; errmsg already given */
13816 if (stride == 0)
13817 EMSG(_("E726: Stride is zero"));
13818 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13819 EMSG(_("E727: Start past end"));
13820 else
13822 if (rettv_list_alloc(rettv) == OK)
13823 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13824 if (list_append_number(rettv->vval.v_list,
13825 (varnumber_T)i) == FAIL)
13826 break;
13831 * "readfile()" function
13833 static void
13834 f_readfile(argvars, rettv)
13835 typval_T *argvars;
13836 typval_T *rettv;
13838 int binary = FALSE;
13839 char_u *fname;
13840 FILE *fd;
13841 listitem_T *li;
13842 #define FREAD_SIZE 200 /* optimized for text lines */
13843 char_u buf[FREAD_SIZE];
13844 int readlen; /* size of last fread() */
13845 int buflen; /* nr of valid chars in buf[] */
13846 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13847 int tolist; /* first byte in buf[] still to be put in list */
13848 int chop; /* how many CR to chop off */
13849 char_u *prev = NULL; /* previously read bytes, if any */
13850 int prevlen = 0; /* length of "prev" if not NULL */
13851 char_u *s;
13852 int len;
13853 long maxline = MAXLNUM;
13854 long cnt = 0;
13856 if (argvars[1].v_type != VAR_UNKNOWN)
13858 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13859 binary = TRUE;
13860 if (argvars[2].v_type != VAR_UNKNOWN)
13861 maxline = get_tv_number(&argvars[2]);
13864 if (rettv_list_alloc(rettv) == FAIL)
13865 return;
13867 /* Always open the file in binary mode, library functions have a mind of
13868 * their own about CR-LF conversion. */
13869 fname = get_tv_string(&argvars[0]);
13870 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13872 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13873 return;
13876 filtd = 0;
13877 while (cnt < maxline || maxline < 0)
13879 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13880 buflen = filtd + readlen;
13881 tolist = 0;
13882 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13884 if (buf[filtd] == '\n' || readlen <= 0)
13886 /* Only when in binary mode add an empty list item when the
13887 * last line ends in a '\n'. */
13888 if (!binary && readlen == 0 && filtd == 0)
13889 break;
13891 /* Found end-of-line or end-of-file: add a text line to the
13892 * list. */
13893 chop = 0;
13894 if (!binary)
13895 while (filtd - chop - 1 >= tolist
13896 && buf[filtd - chop - 1] == '\r')
13897 ++chop;
13898 len = filtd - tolist - chop;
13899 if (prev == NULL)
13900 s = vim_strnsave(buf + tolist, len);
13901 else
13903 s = alloc((unsigned)(prevlen + len + 1));
13904 if (s != NULL)
13906 mch_memmove(s, prev, prevlen);
13907 vim_free(prev);
13908 prev = NULL;
13909 mch_memmove(s + prevlen, buf + tolist, len);
13910 s[prevlen + len] = NUL;
13913 tolist = filtd + 1;
13915 li = listitem_alloc();
13916 if (li == NULL)
13918 vim_free(s);
13919 break;
13921 li->li_tv.v_type = VAR_STRING;
13922 li->li_tv.v_lock = 0;
13923 li->li_tv.vval.v_string = s;
13924 list_append(rettv->vval.v_list, li);
13926 if (++cnt >= maxline && maxline >= 0)
13927 break;
13928 if (readlen <= 0)
13929 break;
13931 else if (buf[filtd] == NUL)
13932 buf[filtd] = '\n';
13934 if (readlen <= 0)
13935 break;
13937 if (tolist == 0)
13939 /* "buf" is full, need to move text to an allocated buffer */
13940 if (prev == NULL)
13942 prev = vim_strnsave(buf, buflen);
13943 prevlen = buflen;
13945 else
13947 s = alloc((unsigned)(prevlen + buflen));
13948 if (s != NULL)
13950 mch_memmove(s, prev, prevlen);
13951 mch_memmove(s + prevlen, buf, buflen);
13952 vim_free(prev);
13953 prev = s;
13954 prevlen += buflen;
13957 filtd = 0;
13959 else
13961 mch_memmove(buf, buf + tolist, buflen - tolist);
13962 filtd -= tolist;
13967 * For a negative line count use only the lines at the end of the file,
13968 * free the rest.
13970 if (maxline < 0)
13971 while (cnt > -maxline)
13973 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13974 --cnt;
13977 vim_free(prev);
13978 fclose(fd);
13981 #if defined(FEAT_RELTIME)
13982 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13985 * Convert a List to proftime_T.
13986 * Return FAIL when there is something wrong.
13988 static int
13989 list2proftime(arg, tm)
13990 typval_T *arg;
13991 proftime_T *tm;
13993 long n1, n2;
13994 int error = FALSE;
13996 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13997 || arg->vval.v_list->lv_len != 2)
13998 return FAIL;
13999 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
14000 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
14001 # ifdef WIN3264
14002 tm->HighPart = n1;
14003 tm->LowPart = n2;
14004 # else
14005 tm->tv_sec = n1;
14006 tm->tv_usec = n2;
14007 # endif
14008 return error ? FAIL : OK;
14010 #endif /* FEAT_RELTIME */
14013 * "reltime()" function
14015 static void
14016 f_reltime(argvars, rettv)
14017 typval_T *argvars;
14018 typval_T *rettv;
14020 #ifdef FEAT_RELTIME
14021 proftime_T res;
14022 proftime_T start;
14024 if (argvars[0].v_type == VAR_UNKNOWN)
14026 /* No arguments: get current time. */
14027 profile_start(&res);
14029 else if (argvars[1].v_type == VAR_UNKNOWN)
14031 if (list2proftime(&argvars[0], &res) == FAIL)
14032 return;
14033 profile_end(&res);
14035 else
14037 /* Two arguments: compute the difference. */
14038 if (list2proftime(&argvars[0], &start) == FAIL
14039 || list2proftime(&argvars[1], &res) == FAIL)
14040 return;
14041 profile_sub(&res, &start);
14044 if (rettv_list_alloc(rettv) == OK)
14046 long n1, n2;
14048 # ifdef WIN3264
14049 n1 = res.HighPart;
14050 n2 = res.LowPart;
14051 # else
14052 n1 = res.tv_sec;
14053 n2 = res.tv_usec;
14054 # endif
14055 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14056 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14058 #endif
14062 * "reltimestr()" function
14064 static void
14065 f_reltimestr(argvars, rettv)
14066 typval_T *argvars;
14067 typval_T *rettv;
14069 #ifdef FEAT_RELTIME
14070 proftime_T tm;
14071 #endif
14073 rettv->v_type = VAR_STRING;
14074 rettv->vval.v_string = NULL;
14075 #ifdef FEAT_RELTIME
14076 if (list2proftime(&argvars[0], &tm) == OK)
14077 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14078 #endif
14081 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14082 static void make_connection __ARGS((void));
14083 static int check_connection __ARGS((void));
14085 static void
14086 make_connection()
14088 if (X_DISPLAY == NULL
14089 # ifdef FEAT_GUI
14090 && !gui.in_use
14091 # endif
14094 x_force_connect = TRUE;
14095 setup_term_clip();
14096 x_force_connect = FALSE;
14100 static int
14101 check_connection()
14103 make_connection();
14104 if (X_DISPLAY == NULL)
14106 EMSG(_("E240: No connection to Vim server"));
14107 return FAIL;
14109 return OK;
14111 #endif
14113 #ifdef FEAT_CLIENTSERVER
14114 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14116 static void
14117 remote_common(argvars, rettv, expr)
14118 typval_T *argvars;
14119 typval_T *rettv;
14120 int expr;
14122 char_u *server_name;
14123 char_u *keys;
14124 char_u *r = NULL;
14125 char_u buf[NUMBUFLEN];
14126 # ifdef WIN32
14127 HWND w;
14128 # else
14129 Window w;
14130 # endif
14132 if (check_restricted() || check_secure())
14133 return;
14135 # ifdef FEAT_X11
14136 if (check_connection() == FAIL)
14137 return;
14138 # endif
14140 server_name = get_tv_string_chk(&argvars[0]);
14141 if (server_name == NULL)
14142 return; /* type error; errmsg already given */
14143 keys = get_tv_string_buf(&argvars[1], buf);
14144 # ifdef WIN32
14145 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14146 # else
14147 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14148 < 0)
14149 # endif
14151 if (r != NULL)
14152 EMSG(r); /* sending worked but evaluation failed */
14153 else
14154 EMSG2(_("E241: Unable to send to %s"), server_name);
14155 return;
14158 rettv->vval.v_string = r;
14160 if (argvars[2].v_type != VAR_UNKNOWN)
14162 dictitem_T v;
14163 char_u str[30];
14164 char_u *idvar;
14166 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14167 v.di_tv.v_type = VAR_STRING;
14168 v.di_tv.vval.v_string = vim_strsave(str);
14169 idvar = get_tv_string_chk(&argvars[2]);
14170 if (idvar != NULL)
14171 set_var(idvar, &v.di_tv, FALSE);
14172 vim_free(v.di_tv.vval.v_string);
14175 #endif
14178 * "remote_expr()" function
14180 static void
14181 f_remote_expr(argvars, rettv)
14182 typval_T *argvars UNUSED;
14183 typval_T *rettv;
14185 rettv->v_type = VAR_STRING;
14186 rettv->vval.v_string = NULL;
14187 #ifdef FEAT_CLIENTSERVER
14188 remote_common(argvars, rettv, TRUE);
14189 #endif
14193 * "remote_foreground()" function
14195 static void
14196 f_remote_foreground(argvars, rettv)
14197 typval_T *argvars UNUSED;
14198 typval_T *rettv UNUSED;
14200 #ifdef FEAT_CLIENTSERVER
14201 # ifdef WIN32
14202 /* On Win32 it's done in this application. */
14204 char_u *server_name = get_tv_string_chk(&argvars[0]);
14206 if (server_name != NULL)
14207 serverForeground(server_name);
14209 # else
14210 /* Send a foreground() expression to the server. */
14211 argvars[1].v_type = VAR_STRING;
14212 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14213 argvars[2].v_type = VAR_UNKNOWN;
14214 remote_common(argvars, rettv, TRUE);
14215 vim_free(argvars[1].vval.v_string);
14216 # endif
14217 #endif
14220 static void
14221 f_remote_peek(argvars, rettv)
14222 typval_T *argvars UNUSED;
14223 typval_T *rettv;
14225 #ifdef FEAT_CLIENTSERVER
14226 dictitem_T v;
14227 char_u *s = NULL;
14228 # ifdef WIN32
14229 long_u n = 0;
14230 # endif
14231 char_u *serverid;
14233 if (check_restricted() || check_secure())
14235 rettv->vval.v_number = -1;
14236 return;
14238 serverid = get_tv_string_chk(&argvars[0]);
14239 if (serverid == NULL)
14241 rettv->vval.v_number = -1;
14242 return; /* type error; errmsg already given */
14244 # ifdef WIN32
14245 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14246 if (n == 0)
14247 rettv->vval.v_number = -1;
14248 else
14250 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14251 rettv->vval.v_number = (s != NULL);
14253 # else
14254 if (check_connection() == FAIL)
14255 return;
14257 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14258 serverStrToWin(serverid), &s);
14259 # endif
14261 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14263 char_u *retvar;
14265 v.di_tv.v_type = VAR_STRING;
14266 v.di_tv.vval.v_string = vim_strsave(s);
14267 retvar = get_tv_string_chk(&argvars[1]);
14268 if (retvar != NULL)
14269 set_var(retvar, &v.di_tv, FALSE);
14270 vim_free(v.di_tv.vval.v_string);
14272 #else
14273 rettv->vval.v_number = -1;
14274 #endif
14277 static void
14278 f_remote_read(argvars, rettv)
14279 typval_T *argvars UNUSED;
14280 typval_T *rettv;
14282 char_u *r = NULL;
14284 #ifdef FEAT_CLIENTSERVER
14285 char_u *serverid = get_tv_string_chk(&argvars[0]);
14287 if (serverid != NULL && !check_restricted() && !check_secure())
14289 # ifdef WIN32
14290 /* The server's HWND is encoded in the 'id' parameter */
14291 long_u n = 0;
14293 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14294 if (n != 0)
14295 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14296 if (r == NULL)
14297 # else
14298 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14299 serverStrToWin(serverid), &r, FALSE) < 0)
14300 # endif
14301 EMSG(_("E277: Unable to read a server reply"));
14303 #endif
14304 rettv->v_type = VAR_STRING;
14305 rettv->vval.v_string = r;
14309 * "remote_send()" function
14311 static void
14312 f_remote_send(argvars, rettv)
14313 typval_T *argvars UNUSED;
14314 typval_T *rettv;
14316 rettv->v_type = VAR_STRING;
14317 rettv->vval.v_string = NULL;
14318 #ifdef FEAT_CLIENTSERVER
14319 remote_common(argvars, rettv, FALSE);
14320 #endif
14324 * "remove()" function
14326 static void
14327 f_remove(argvars, rettv)
14328 typval_T *argvars;
14329 typval_T *rettv;
14331 list_T *l;
14332 listitem_T *item, *item2;
14333 listitem_T *li;
14334 long idx;
14335 long end;
14336 char_u *key;
14337 dict_T *d;
14338 dictitem_T *di;
14340 if (argvars[0].v_type == VAR_DICT)
14342 if (argvars[2].v_type != VAR_UNKNOWN)
14343 EMSG2(_(e_toomanyarg), "remove()");
14344 else if ((d = argvars[0].vval.v_dict) != NULL
14345 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14347 key = get_tv_string_chk(&argvars[1]);
14348 if (key != NULL)
14350 di = dict_find(d, key, -1);
14351 if (di == NULL)
14352 EMSG2(_(e_dictkey), key);
14353 else
14355 *rettv = di->di_tv;
14356 init_tv(&di->di_tv);
14357 dictitem_remove(d, di);
14362 else if (argvars[0].v_type != VAR_LIST)
14363 EMSG2(_(e_listdictarg), "remove()");
14364 else if ((l = argvars[0].vval.v_list) != NULL
14365 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14367 int error = FALSE;
14369 idx = get_tv_number_chk(&argvars[1], &error);
14370 if (error)
14371 ; /* type error: do nothing, errmsg already given */
14372 else if ((item = list_find(l, idx)) == NULL)
14373 EMSGN(_(e_listidx), idx);
14374 else
14376 if (argvars[2].v_type == VAR_UNKNOWN)
14378 /* Remove one item, return its value. */
14379 list_remove(l, item, item);
14380 *rettv = item->li_tv;
14381 vim_free(item);
14383 else
14385 /* Remove range of items, return list with values. */
14386 end = get_tv_number_chk(&argvars[2], &error);
14387 if (error)
14388 ; /* type error: do nothing */
14389 else if ((item2 = list_find(l, end)) == NULL)
14390 EMSGN(_(e_listidx), end);
14391 else
14393 int cnt = 0;
14395 for (li = item; li != NULL; li = li->li_next)
14397 ++cnt;
14398 if (li == item2)
14399 break;
14401 if (li == NULL) /* didn't find "item2" after "item" */
14402 EMSG(_(e_invrange));
14403 else
14405 list_remove(l, item, item2);
14406 if (rettv_list_alloc(rettv) == OK)
14408 l = rettv->vval.v_list;
14409 l->lv_first = item;
14410 l->lv_last = item2;
14411 item->li_prev = NULL;
14412 item2->li_next = NULL;
14413 l->lv_len = cnt;
14423 * "rename({from}, {to})" function
14425 static void
14426 f_rename(argvars, rettv)
14427 typval_T *argvars;
14428 typval_T *rettv;
14430 char_u buf[NUMBUFLEN];
14432 if (check_restricted() || check_secure())
14433 rettv->vval.v_number = -1;
14434 else
14435 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14436 get_tv_string_buf(&argvars[1], buf));
14440 * "repeat()" function
14442 static void
14443 f_repeat(argvars, rettv)
14444 typval_T *argvars;
14445 typval_T *rettv;
14447 char_u *p;
14448 int n;
14449 int slen;
14450 int len;
14451 char_u *r;
14452 int i;
14454 n = get_tv_number(&argvars[1]);
14455 if (argvars[0].v_type == VAR_LIST)
14457 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14458 while (n-- > 0)
14459 if (list_extend(rettv->vval.v_list,
14460 argvars[0].vval.v_list, NULL) == FAIL)
14461 break;
14463 else
14465 p = get_tv_string(&argvars[0]);
14466 rettv->v_type = VAR_STRING;
14467 rettv->vval.v_string = NULL;
14469 slen = (int)STRLEN(p);
14470 len = slen * n;
14471 if (len <= 0)
14472 return;
14474 r = alloc(len + 1);
14475 if (r != NULL)
14477 for (i = 0; i < n; i++)
14478 mch_memmove(r + i * slen, p, (size_t)slen);
14479 r[len] = NUL;
14482 rettv->vval.v_string = r;
14487 * "resolve()" function
14489 static void
14490 f_resolve(argvars, rettv)
14491 typval_T *argvars;
14492 typval_T *rettv;
14494 char_u *p;
14496 p = get_tv_string(&argvars[0]);
14497 #ifdef FEAT_SHORTCUT
14499 char_u *v = NULL;
14501 v = mch_resolve_shortcut(p);
14502 if (v != NULL)
14503 rettv->vval.v_string = v;
14504 else
14505 rettv->vval.v_string = vim_strsave(p);
14507 #else
14508 # ifdef HAVE_READLINK
14510 char_u buf[MAXPATHL + 1];
14511 char_u *cpy;
14512 int len;
14513 char_u *remain = NULL;
14514 char_u *q;
14515 int is_relative_to_current = FALSE;
14516 int has_trailing_pathsep = FALSE;
14517 int limit = 100;
14519 p = vim_strsave(p);
14521 if (p[0] == '.' && (vim_ispathsep(p[1])
14522 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14523 is_relative_to_current = TRUE;
14525 len = STRLEN(p);
14526 if (len > 0 && after_pathsep(p, p + len))
14527 has_trailing_pathsep = TRUE;
14529 q = getnextcomp(p);
14530 if (*q != NUL)
14532 /* Separate the first path component in "p", and keep the
14533 * remainder (beginning with the path separator). */
14534 remain = vim_strsave(q - 1);
14535 q[-1] = NUL;
14538 for (;;)
14540 for (;;)
14542 len = readlink((char *)p, (char *)buf, MAXPATHL);
14543 if (len <= 0)
14544 break;
14545 buf[len] = NUL;
14547 if (limit-- == 0)
14549 vim_free(p);
14550 vim_free(remain);
14551 EMSG(_("E655: Too many symbolic links (cycle?)"));
14552 rettv->vval.v_string = NULL;
14553 goto fail;
14556 /* Ensure that the result will have a trailing path separator
14557 * if the argument has one. */
14558 if (remain == NULL && has_trailing_pathsep)
14559 add_pathsep(buf);
14561 /* Separate the first path component in the link value and
14562 * concatenate the remainders. */
14563 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14564 if (*q != NUL)
14566 if (remain == NULL)
14567 remain = vim_strsave(q - 1);
14568 else
14570 cpy = concat_str(q - 1, remain);
14571 if (cpy != NULL)
14573 vim_free(remain);
14574 remain = cpy;
14577 q[-1] = NUL;
14580 q = gettail(p);
14581 if (q > p && *q == NUL)
14583 /* Ignore trailing path separator. */
14584 q[-1] = NUL;
14585 q = gettail(p);
14587 if (q > p && !mch_isFullName(buf))
14589 /* symlink is relative to directory of argument */
14590 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14591 if (cpy != NULL)
14593 STRCPY(cpy, p);
14594 STRCPY(gettail(cpy), buf);
14595 vim_free(p);
14596 p = cpy;
14599 else
14601 vim_free(p);
14602 p = vim_strsave(buf);
14606 if (remain == NULL)
14607 break;
14609 /* Append the first path component of "remain" to "p". */
14610 q = getnextcomp(remain + 1);
14611 len = q - remain - (*q != NUL);
14612 cpy = vim_strnsave(p, STRLEN(p) + len);
14613 if (cpy != NULL)
14615 STRNCAT(cpy, remain, len);
14616 vim_free(p);
14617 p = cpy;
14619 /* Shorten "remain". */
14620 if (*q != NUL)
14621 STRMOVE(remain, q - 1);
14622 else
14624 vim_free(remain);
14625 remain = NULL;
14629 /* If the result is a relative path name, make it explicitly relative to
14630 * the current directory if and only if the argument had this form. */
14631 if (!vim_ispathsep(*p))
14633 if (is_relative_to_current
14634 && *p != NUL
14635 && !(p[0] == '.'
14636 && (p[1] == NUL
14637 || vim_ispathsep(p[1])
14638 || (p[1] == '.'
14639 && (p[2] == NUL
14640 || vim_ispathsep(p[2]))))))
14642 /* Prepend "./". */
14643 cpy = concat_str((char_u *)"./", p);
14644 if (cpy != NULL)
14646 vim_free(p);
14647 p = cpy;
14650 else if (!is_relative_to_current)
14652 /* Strip leading "./". */
14653 q = p;
14654 while (q[0] == '.' && vim_ispathsep(q[1]))
14655 q += 2;
14656 if (q > p)
14657 STRMOVE(p, p + 2);
14661 /* Ensure that the result will have no trailing path separator
14662 * if the argument had none. But keep "/" or "//". */
14663 if (!has_trailing_pathsep)
14665 q = p + STRLEN(p);
14666 if (after_pathsep(p, q))
14667 *gettail_sep(p) = NUL;
14670 rettv->vval.v_string = p;
14672 # else
14673 rettv->vval.v_string = vim_strsave(p);
14674 # endif
14675 #endif
14677 simplify_filename(rettv->vval.v_string);
14679 #ifdef HAVE_READLINK
14680 fail:
14681 #endif
14682 rettv->v_type = VAR_STRING;
14686 * "reverse({list})" function
14688 static void
14689 f_reverse(argvars, rettv)
14690 typval_T *argvars;
14691 typval_T *rettv;
14693 list_T *l;
14694 listitem_T *li, *ni;
14696 if (argvars[0].v_type != VAR_LIST)
14697 EMSG2(_(e_listarg), "reverse()");
14698 else if ((l = argvars[0].vval.v_list) != NULL
14699 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14701 li = l->lv_last;
14702 l->lv_first = l->lv_last = NULL;
14703 l->lv_len = 0;
14704 while (li != NULL)
14706 ni = li->li_prev;
14707 list_append(l, li);
14708 li = ni;
14710 rettv->vval.v_list = l;
14711 rettv->v_type = VAR_LIST;
14712 ++l->lv_refcount;
14713 l->lv_idx = l->lv_len - l->lv_idx - 1;
14717 #define SP_NOMOVE 0x01 /* don't move cursor */
14718 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14719 #define SP_RETCOUNT 0x04 /* return matchcount */
14720 #define SP_SETPCMARK 0x08 /* set previous context mark */
14721 #define SP_START 0x10 /* accept match at start position */
14722 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14723 #define SP_END 0x40 /* leave cursor at end of match */
14725 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14728 * Get flags for a search function.
14729 * Possibly sets "p_ws".
14730 * Returns BACKWARD, FORWARD or zero (for an error).
14732 static int
14733 get_search_arg(varp, flagsp)
14734 typval_T *varp;
14735 int *flagsp;
14737 int dir = FORWARD;
14738 char_u *flags;
14739 char_u nbuf[NUMBUFLEN];
14740 int mask;
14742 if (varp->v_type != VAR_UNKNOWN)
14744 flags = get_tv_string_buf_chk(varp, nbuf);
14745 if (flags == NULL)
14746 return 0; /* type error; errmsg already given */
14747 while (*flags != NUL)
14749 switch (*flags)
14751 case 'b': dir = BACKWARD; break;
14752 case 'w': p_ws = TRUE; break;
14753 case 'W': p_ws = FALSE; break;
14754 default: mask = 0;
14755 if (flagsp != NULL)
14756 switch (*flags)
14758 case 'c': mask = SP_START; break;
14759 case 'e': mask = SP_END; break;
14760 case 'm': mask = SP_RETCOUNT; break;
14761 case 'n': mask = SP_NOMOVE; break;
14762 case 'p': mask = SP_SUBPAT; break;
14763 case 'r': mask = SP_REPEAT; break;
14764 case 's': mask = SP_SETPCMARK; break;
14766 if (mask == 0)
14768 EMSG2(_(e_invarg2), flags);
14769 dir = 0;
14771 else
14772 *flagsp |= mask;
14774 if (dir == 0)
14775 break;
14776 ++flags;
14779 return dir;
14783 * Shared by search() and searchpos() functions
14785 static int
14786 search_cmn(argvars, match_pos, flagsp)
14787 typval_T *argvars;
14788 pos_T *match_pos;
14789 int *flagsp;
14791 int flags;
14792 char_u *pat;
14793 pos_T pos;
14794 pos_T save_cursor;
14795 int save_p_ws = p_ws;
14796 int dir;
14797 int retval = 0; /* default: FAIL */
14798 long lnum_stop = 0;
14799 proftime_T tm;
14800 #ifdef FEAT_RELTIME
14801 long time_limit = 0;
14802 #endif
14803 int options = SEARCH_KEEP;
14804 int subpatnum;
14806 pat = get_tv_string(&argvars[0]);
14807 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14808 if (dir == 0)
14809 goto theend;
14810 flags = *flagsp;
14811 if (flags & SP_START)
14812 options |= SEARCH_START;
14813 if (flags & SP_END)
14814 options |= SEARCH_END;
14816 /* Optional arguments: line number to stop searching and timeout. */
14817 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14819 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14820 if (lnum_stop < 0)
14821 goto theend;
14822 #ifdef FEAT_RELTIME
14823 if (argvars[3].v_type != VAR_UNKNOWN)
14825 time_limit = get_tv_number_chk(&argvars[3], NULL);
14826 if (time_limit < 0)
14827 goto theend;
14829 #endif
14832 #ifdef FEAT_RELTIME
14833 /* Set the time limit, if there is one. */
14834 profile_setlimit(time_limit, &tm);
14835 #endif
14838 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14839 * Check to make sure only those flags are set.
14840 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14841 * flags cannot be set. Check for that condition also.
14843 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14844 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14846 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14847 goto theend;
14850 pos = save_cursor = curwin->w_cursor;
14851 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14852 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14853 if (subpatnum != FAIL)
14855 if (flags & SP_SUBPAT)
14856 retval = subpatnum;
14857 else
14858 retval = pos.lnum;
14859 if (flags & SP_SETPCMARK)
14860 setpcmark();
14861 curwin->w_cursor = pos;
14862 if (match_pos != NULL)
14864 /* Store the match cursor position */
14865 match_pos->lnum = pos.lnum;
14866 match_pos->col = pos.col + 1;
14868 /* "/$" will put the cursor after the end of the line, may need to
14869 * correct that here */
14870 check_cursor();
14873 /* If 'n' flag is used: restore cursor position. */
14874 if (flags & SP_NOMOVE)
14875 curwin->w_cursor = save_cursor;
14876 else
14877 curwin->w_set_curswant = TRUE;
14878 theend:
14879 p_ws = save_p_ws;
14881 return retval;
14884 #ifdef FEAT_FLOAT
14886 * "round({float})" function
14888 static void
14889 f_round(argvars, rettv)
14890 typval_T *argvars;
14891 typval_T *rettv;
14893 float_T f;
14895 rettv->v_type = VAR_FLOAT;
14896 if (get_float_arg(argvars, &f) == OK)
14897 /* round() is not in C90, use ceil() or floor() instead. */
14898 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14899 else
14900 rettv->vval.v_float = 0.0;
14902 #endif
14905 * "search()" function
14907 static void
14908 f_search(argvars, rettv)
14909 typval_T *argvars;
14910 typval_T *rettv;
14912 int flags = 0;
14914 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14918 * "searchdecl()" function
14920 static void
14921 f_searchdecl(argvars, rettv)
14922 typval_T *argvars;
14923 typval_T *rettv;
14925 int locally = 1;
14926 int thisblock = 0;
14927 int error = FALSE;
14928 char_u *name;
14930 rettv->vval.v_number = 1; /* default: FAIL */
14932 name = get_tv_string_chk(&argvars[0]);
14933 if (argvars[1].v_type != VAR_UNKNOWN)
14935 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14936 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14937 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14939 if (!error && name != NULL)
14940 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14941 locally, thisblock, SEARCH_KEEP) == FAIL;
14945 * Used by searchpair() and searchpairpos()
14947 static int
14948 searchpair_cmn(argvars, match_pos)
14949 typval_T *argvars;
14950 pos_T *match_pos;
14952 char_u *spat, *mpat, *epat;
14953 char_u *skip;
14954 int save_p_ws = p_ws;
14955 int dir;
14956 int flags = 0;
14957 char_u nbuf1[NUMBUFLEN];
14958 char_u nbuf2[NUMBUFLEN];
14959 char_u nbuf3[NUMBUFLEN];
14960 int retval = 0; /* default: FAIL */
14961 long lnum_stop = 0;
14962 long time_limit = 0;
14964 /* Get the three pattern arguments: start, middle, end. */
14965 spat = get_tv_string_chk(&argvars[0]);
14966 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14967 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14968 if (spat == NULL || mpat == NULL || epat == NULL)
14969 goto theend; /* type error */
14971 /* Handle the optional fourth argument: flags */
14972 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14973 if (dir == 0)
14974 goto theend;
14976 /* Don't accept SP_END or SP_SUBPAT.
14977 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14979 if ((flags & (SP_END | SP_SUBPAT)) != 0
14980 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14982 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14983 goto theend;
14986 /* Using 'r' implies 'W', otherwise it doesn't work. */
14987 if (flags & SP_REPEAT)
14988 p_ws = FALSE;
14990 /* Optional fifth argument: skip expression */
14991 if (argvars[3].v_type == VAR_UNKNOWN
14992 || argvars[4].v_type == VAR_UNKNOWN)
14993 skip = (char_u *)"";
14994 else
14996 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14997 if (argvars[5].v_type != VAR_UNKNOWN)
14999 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
15000 if (lnum_stop < 0)
15001 goto theend;
15002 #ifdef FEAT_RELTIME
15003 if (argvars[6].v_type != VAR_UNKNOWN)
15005 time_limit = get_tv_number_chk(&argvars[6], NULL);
15006 if (time_limit < 0)
15007 goto theend;
15009 #endif
15012 if (skip == NULL)
15013 goto theend; /* type error */
15015 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
15016 match_pos, lnum_stop, time_limit);
15018 theend:
15019 p_ws = save_p_ws;
15021 return retval;
15025 * "searchpair()" function
15027 static void
15028 f_searchpair(argvars, rettv)
15029 typval_T *argvars;
15030 typval_T *rettv;
15032 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15036 * "searchpairpos()" function
15038 static void
15039 f_searchpairpos(argvars, rettv)
15040 typval_T *argvars;
15041 typval_T *rettv;
15043 pos_T match_pos;
15044 int lnum = 0;
15045 int col = 0;
15047 if (rettv_list_alloc(rettv) == FAIL)
15048 return;
15050 if (searchpair_cmn(argvars, &match_pos) > 0)
15052 lnum = match_pos.lnum;
15053 col = match_pos.col;
15056 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15057 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15061 * Search for a start/middle/end thing.
15062 * Used by searchpair(), see its documentation for the details.
15063 * Returns 0 or -1 for no match,
15065 long
15066 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15067 lnum_stop, time_limit)
15068 char_u *spat; /* start pattern */
15069 char_u *mpat; /* middle pattern */
15070 char_u *epat; /* end pattern */
15071 int dir; /* BACKWARD or FORWARD */
15072 char_u *skip; /* skip expression */
15073 int flags; /* SP_SETPCMARK and other SP_ values */
15074 pos_T *match_pos;
15075 linenr_T lnum_stop; /* stop at this line if not zero */
15076 long time_limit; /* stop after this many msec */
15078 char_u *save_cpo;
15079 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15080 long retval = 0;
15081 pos_T pos;
15082 pos_T firstpos;
15083 pos_T foundpos;
15084 pos_T save_cursor;
15085 pos_T save_pos;
15086 int n;
15087 int r;
15088 int nest = 1;
15089 int err;
15090 int options = SEARCH_KEEP;
15091 proftime_T tm;
15093 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15094 save_cpo = p_cpo;
15095 p_cpo = empty_option;
15097 #ifdef FEAT_RELTIME
15098 /* Set the time limit, if there is one. */
15099 profile_setlimit(time_limit, &tm);
15100 #endif
15102 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15103 * start/middle/end (pat3, for the top pair). */
15104 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15105 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15106 if (pat2 == NULL || pat3 == NULL)
15107 goto theend;
15108 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15109 if (*mpat == NUL)
15110 STRCPY(pat3, pat2);
15111 else
15112 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15113 spat, epat, mpat);
15114 if (flags & SP_START)
15115 options |= SEARCH_START;
15117 save_cursor = curwin->w_cursor;
15118 pos = curwin->w_cursor;
15119 clearpos(&firstpos);
15120 clearpos(&foundpos);
15121 pat = pat3;
15122 for (;;)
15124 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15125 options, RE_SEARCH, lnum_stop, &tm);
15126 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15127 /* didn't find it or found the first match again: FAIL */
15128 break;
15130 if (firstpos.lnum == 0)
15131 firstpos = pos;
15132 if (equalpos(pos, foundpos))
15134 /* Found the same position again. Can happen with a pattern that
15135 * has "\zs" at the end and searching backwards. Advance one
15136 * character and try again. */
15137 if (dir == BACKWARD)
15138 decl(&pos);
15139 else
15140 incl(&pos);
15142 foundpos = pos;
15144 /* clear the start flag to avoid getting stuck here */
15145 options &= ~SEARCH_START;
15147 /* If the skip pattern matches, ignore this match. */
15148 if (*skip != NUL)
15150 save_pos = curwin->w_cursor;
15151 curwin->w_cursor = pos;
15152 r = eval_to_bool(skip, &err, NULL, FALSE);
15153 curwin->w_cursor = save_pos;
15154 if (err)
15156 /* Evaluating {skip} caused an error, break here. */
15157 curwin->w_cursor = save_cursor;
15158 retval = -1;
15159 break;
15161 if (r)
15162 continue;
15165 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15167 /* Found end when searching backwards or start when searching
15168 * forward: nested pair. */
15169 ++nest;
15170 pat = pat2; /* nested, don't search for middle */
15172 else
15174 /* Found end when searching forward or start when searching
15175 * backward: end of (nested) pair; or found middle in outer pair. */
15176 if (--nest == 1)
15177 pat = pat3; /* outer level, search for middle */
15180 if (nest == 0)
15182 /* Found the match: return matchcount or line number. */
15183 if (flags & SP_RETCOUNT)
15184 ++retval;
15185 else
15186 retval = pos.lnum;
15187 if (flags & SP_SETPCMARK)
15188 setpcmark();
15189 curwin->w_cursor = pos;
15190 if (!(flags & SP_REPEAT))
15191 break;
15192 nest = 1; /* search for next unmatched */
15196 if (match_pos != NULL)
15198 /* Store the match cursor position */
15199 match_pos->lnum = curwin->w_cursor.lnum;
15200 match_pos->col = curwin->w_cursor.col + 1;
15203 /* If 'n' flag is used or search failed: restore cursor position. */
15204 if ((flags & SP_NOMOVE) || retval == 0)
15205 curwin->w_cursor = save_cursor;
15207 theend:
15208 vim_free(pat2);
15209 vim_free(pat3);
15210 if (p_cpo == empty_option)
15211 p_cpo = save_cpo;
15212 else
15213 /* Darn, evaluating the {skip} expression changed the value. */
15214 free_string_option(save_cpo);
15216 return retval;
15220 * "searchpos()" function
15222 static void
15223 f_searchpos(argvars, rettv)
15224 typval_T *argvars;
15225 typval_T *rettv;
15227 pos_T match_pos;
15228 int lnum = 0;
15229 int col = 0;
15230 int n;
15231 int flags = 0;
15233 if (rettv_list_alloc(rettv) == FAIL)
15234 return;
15236 n = search_cmn(argvars, &match_pos, &flags);
15237 if (n > 0)
15239 lnum = match_pos.lnum;
15240 col = match_pos.col;
15243 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15244 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15245 if (flags & SP_SUBPAT)
15246 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15250 static void
15251 f_server2client(argvars, rettv)
15252 typval_T *argvars UNUSED;
15253 typval_T *rettv;
15255 #ifdef FEAT_CLIENTSERVER
15256 char_u buf[NUMBUFLEN];
15257 char_u *server = get_tv_string_chk(&argvars[0]);
15258 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15260 rettv->vval.v_number = -1;
15261 if (server == NULL || reply == NULL)
15262 return;
15263 if (check_restricted() || check_secure())
15264 return;
15265 # ifdef FEAT_X11
15266 if (check_connection() == FAIL)
15267 return;
15268 # endif
15270 if (serverSendReply(server, reply) < 0)
15272 EMSG(_("E258: Unable to send to client"));
15273 return;
15275 rettv->vval.v_number = 0;
15276 #else
15277 rettv->vval.v_number = -1;
15278 #endif
15281 static void
15282 f_serverlist(argvars, rettv)
15283 typval_T *argvars UNUSED;
15284 typval_T *rettv;
15286 char_u *r = NULL;
15288 #ifdef FEAT_CLIENTSERVER
15289 # ifdef WIN32
15290 r = serverGetVimNames();
15291 # else
15292 make_connection();
15293 if (X_DISPLAY != NULL)
15294 r = serverGetVimNames(X_DISPLAY);
15295 # endif
15296 #endif
15297 rettv->v_type = VAR_STRING;
15298 rettv->vval.v_string = r;
15302 * "setbufvar()" function
15304 static void
15305 f_setbufvar(argvars, rettv)
15306 typval_T *argvars;
15307 typval_T *rettv UNUSED;
15309 buf_T *buf;
15310 aco_save_T aco;
15311 char_u *varname, *bufvarname;
15312 typval_T *varp;
15313 char_u nbuf[NUMBUFLEN];
15315 if (check_restricted() || check_secure())
15316 return;
15317 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15318 varname = get_tv_string_chk(&argvars[1]);
15319 buf = get_buf_tv(&argvars[0]);
15320 varp = &argvars[2];
15322 if (buf != NULL && varname != NULL && varp != NULL)
15324 /* set curbuf to be our buf, temporarily */
15325 aucmd_prepbuf(&aco, buf);
15327 if (*varname == '&')
15329 long numval;
15330 char_u *strval;
15331 int error = FALSE;
15333 ++varname;
15334 numval = get_tv_number_chk(varp, &error);
15335 strval = get_tv_string_buf_chk(varp, nbuf);
15336 if (!error && strval != NULL)
15337 set_option_value(varname, numval, strval, OPT_LOCAL);
15339 else
15341 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15342 if (bufvarname != NULL)
15344 STRCPY(bufvarname, "b:");
15345 STRCPY(bufvarname + 2, varname);
15346 set_var(bufvarname, varp, TRUE);
15347 vim_free(bufvarname);
15351 /* reset notion of buffer */
15352 aucmd_restbuf(&aco);
15357 * "setcmdpos()" function
15359 static void
15360 f_setcmdpos(argvars, rettv)
15361 typval_T *argvars;
15362 typval_T *rettv;
15364 int pos = (int)get_tv_number(&argvars[0]) - 1;
15366 if (pos >= 0)
15367 rettv->vval.v_number = set_cmdline_pos(pos);
15371 * "setline()" function
15373 static void
15374 f_setline(argvars, rettv)
15375 typval_T *argvars;
15376 typval_T *rettv;
15378 linenr_T lnum;
15379 char_u *line = NULL;
15380 list_T *l = NULL;
15381 listitem_T *li = NULL;
15382 long added = 0;
15383 linenr_T lcount = curbuf->b_ml.ml_line_count;
15385 lnum = get_tv_lnum(&argvars[0]);
15386 if (argvars[1].v_type == VAR_LIST)
15388 l = argvars[1].vval.v_list;
15389 li = l->lv_first;
15391 else
15392 line = get_tv_string_chk(&argvars[1]);
15394 /* default result is zero == OK */
15395 for (;;)
15397 if (l != NULL)
15399 /* list argument, get next string */
15400 if (li == NULL)
15401 break;
15402 line = get_tv_string_chk(&li->li_tv);
15403 li = li->li_next;
15406 rettv->vval.v_number = 1; /* FAIL */
15407 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15408 break;
15409 if (lnum <= curbuf->b_ml.ml_line_count)
15411 /* existing line, replace it */
15412 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15414 changed_bytes(lnum, 0);
15415 if (lnum == curwin->w_cursor.lnum)
15416 check_cursor_col();
15417 rettv->vval.v_number = 0; /* OK */
15420 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15422 /* lnum is one past the last line, append the line */
15423 ++added;
15424 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15425 rettv->vval.v_number = 0; /* OK */
15428 if (l == NULL) /* only one string argument */
15429 break;
15430 ++lnum;
15433 if (added > 0)
15434 appended_lines_mark(lcount, added);
15437 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15440 * Used by "setqflist()" and "setloclist()" functions
15442 static void
15443 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15444 win_T *wp UNUSED;
15445 typval_T *list_arg UNUSED;
15446 typval_T *action_arg UNUSED;
15447 typval_T *rettv;
15449 #ifdef FEAT_QUICKFIX
15450 char_u *act;
15451 int action = ' ';
15452 #endif
15454 rettv->vval.v_number = -1;
15456 #ifdef FEAT_QUICKFIX
15457 if (list_arg->v_type != VAR_LIST)
15458 EMSG(_(e_listreq));
15459 else
15461 list_T *l = list_arg->vval.v_list;
15463 if (action_arg->v_type == VAR_STRING)
15465 act = get_tv_string_chk(action_arg);
15466 if (act == NULL)
15467 return; /* type error; errmsg already given */
15468 if (*act == 'a' || *act == 'r')
15469 action = *act;
15472 if (l != NULL && set_errorlist(wp, l, action) == OK)
15473 rettv->vval.v_number = 0;
15475 #endif
15479 * "setloclist()" function
15481 static void
15482 f_setloclist(argvars, rettv)
15483 typval_T *argvars;
15484 typval_T *rettv;
15486 win_T *win;
15488 rettv->vval.v_number = -1;
15490 win = find_win_by_nr(&argvars[0], NULL);
15491 if (win != NULL)
15492 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15496 * "setmatches()" function
15498 static void
15499 f_setmatches(argvars, rettv)
15500 typval_T *argvars;
15501 typval_T *rettv;
15503 #ifdef FEAT_SEARCH_EXTRA
15504 list_T *l;
15505 listitem_T *li;
15506 dict_T *d;
15508 rettv->vval.v_number = -1;
15509 if (argvars[0].v_type != VAR_LIST)
15511 EMSG(_(e_listreq));
15512 return;
15514 if ((l = argvars[0].vval.v_list) != NULL)
15517 /* To some extent make sure that we are dealing with a list from
15518 * "getmatches()". */
15519 li = l->lv_first;
15520 while (li != NULL)
15522 if (li->li_tv.v_type != VAR_DICT
15523 || (d = li->li_tv.vval.v_dict) == NULL)
15525 EMSG(_(e_invarg));
15526 return;
15528 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15529 && dict_find(d, (char_u *)"pattern", -1) != NULL
15530 && dict_find(d, (char_u *)"priority", -1) != NULL
15531 && dict_find(d, (char_u *)"id", -1) != NULL))
15533 EMSG(_(e_invarg));
15534 return;
15536 li = li->li_next;
15539 clear_matches(curwin);
15540 li = l->lv_first;
15541 while (li != NULL)
15543 d = li->li_tv.vval.v_dict;
15544 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15545 get_dict_string(d, (char_u *)"pattern", FALSE),
15546 (int)get_dict_number(d, (char_u *)"priority"),
15547 (int)get_dict_number(d, (char_u *)"id"));
15548 li = li->li_next;
15550 rettv->vval.v_number = 0;
15552 #endif
15556 * "setpos()" function
15558 static void
15559 f_setpos(argvars, rettv)
15560 typval_T *argvars;
15561 typval_T *rettv;
15563 pos_T pos;
15564 int fnum;
15565 char_u *name;
15567 rettv->vval.v_number = -1;
15568 name = get_tv_string_chk(argvars);
15569 if (name != NULL)
15571 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15573 if (--pos.col < 0)
15574 pos.col = 0;
15575 if (name[0] == '.' && name[1] == NUL)
15577 /* set cursor */
15578 if (fnum == curbuf->b_fnum)
15580 curwin->w_cursor = pos;
15581 check_cursor();
15582 rettv->vval.v_number = 0;
15584 else
15585 EMSG(_(e_invarg));
15587 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15589 /* set mark */
15590 if (setmark_pos(name[1], &pos, fnum) == OK)
15591 rettv->vval.v_number = 0;
15593 else
15594 EMSG(_(e_invarg));
15600 * "setqflist()" function
15602 static void
15603 f_setqflist(argvars, rettv)
15604 typval_T *argvars;
15605 typval_T *rettv;
15607 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15611 * "setreg()" function
15613 static void
15614 f_setreg(argvars, rettv)
15615 typval_T *argvars;
15616 typval_T *rettv;
15618 int regname;
15619 char_u *strregname;
15620 char_u *stropt;
15621 char_u *strval;
15622 int append;
15623 char_u yank_type;
15624 long block_len;
15626 block_len = -1;
15627 yank_type = MAUTO;
15628 append = FALSE;
15630 strregname = get_tv_string_chk(argvars);
15631 rettv->vval.v_number = 1; /* FAIL is default */
15633 if (strregname == NULL)
15634 return; /* type error; errmsg already given */
15635 regname = *strregname;
15636 if (regname == 0 || regname == '@')
15637 regname = '"';
15638 else if (regname == '=')
15639 return;
15641 if (argvars[2].v_type != VAR_UNKNOWN)
15643 stropt = get_tv_string_chk(&argvars[2]);
15644 if (stropt == NULL)
15645 return; /* type error */
15646 for (; *stropt != NUL; ++stropt)
15647 switch (*stropt)
15649 case 'a': case 'A': /* append */
15650 append = TRUE;
15651 break;
15652 case 'v': case 'c': /* character-wise selection */
15653 yank_type = MCHAR;
15654 break;
15655 case 'V': case 'l': /* line-wise selection */
15656 yank_type = MLINE;
15657 break;
15658 #ifdef FEAT_VISUAL
15659 case 'b': case Ctrl_V: /* block-wise selection */
15660 yank_type = MBLOCK;
15661 if (VIM_ISDIGIT(stropt[1]))
15663 ++stropt;
15664 block_len = getdigits(&stropt) - 1;
15665 --stropt;
15667 break;
15668 #endif
15672 strval = get_tv_string_chk(&argvars[1]);
15673 if (strval != NULL)
15674 write_reg_contents_ex(regname, strval, -1,
15675 append, yank_type, block_len);
15676 rettv->vval.v_number = 0;
15680 * "settabwinvar()" function
15682 static void
15683 f_settabwinvar(argvars, rettv)
15684 typval_T *argvars;
15685 typval_T *rettv;
15687 setwinvar(argvars, rettv, 1);
15691 * "setwinvar()" function
15693 static void
15694 f_setwinvar(argvars, rettv)
15695 typval_T *argvars;
15696 typval_T *rettv;
15698 setwinvar(argvars, rettv, 0);
15702 * "setwinvar()" and "settabwinvar()" functions
15704 static void
15705 setwinvar(argvars, rettv, off)
15706 typval_T *argvars;
15707 typval_T *rettv UNUSED;
15708 int off;
15710 win_T *win;
15711 #ifdef FEAT_WINDOWS
15712 win_T *save_curwin;
15713 tabpage_T *save_curtab;
15714 #endif
15715 char_u *varname, *winvarname;
15716 typval_T *varp;
15717 char_u nbuf[NUMBUFLEN];
15718 tabpage_T *tp;
15720 if (check_restricted() || check_secure())
15721 return;
15723 #ifdef FEAT_WINDOWS
15724 if (off == 1)
15725 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15726 else
15727 tp = curtab;
15728 #endif
15729 win = find_win_by_nr(&argvars[off], tp);
15730 varname = get_tv_string_chk(&argvars[off + 1]);
15731 varp = &argvars[off + 2];
15733 if (win != NULL && varname != NULL && varp != NULL)
15735 #ifdef FEAT_WINDOWS
15736 /* set curwin to be our win, temporarily */
15737 save_curwin = curwin;
15738 save_curtab = curtab;
15739 goto_tabpage_tp(tp);
15740 if (!win_valid(win))
15741 return;
15742 curwin = win;
15743 curbuf = curwin->w_buffer;
15744 #endif
15746 if (*varname == '&')
15748 long numval;
15749 char_u *strval;
15750 int error = FALSE;
15752 ++varname;
15753 numval = get_tv_number_chk(varp, &error);
15754 strval = get_tv_string_buf_chk(varp, nbuf);
15755 if (!error && strval != NULL)
15756 set_option_value(varname, numval, strval, OPT_LOCAL);
15758 else
15760 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15761 if (winvarname != NULL)
15763 STRCPY(winvarname, "w:");
15764 STRCPY(winvarname + 2, varname);
15765 set_var(winvarname, varp, TRUE);
15766 vim_free(winvarname);
15770 #ifdef FEAT_WINDOWS
15771 /* Restore current tabpage and window, if still valid (autocomands can
15772 * make them invalid). */
15773 if (valid_tabpage(save_curtab))
15774 goto_tabpage_tp(save_curtab);
15775 if (win_valid(save_curwin))
15777 curwin = save_curwin;
15778 curbuf = curwin->w_buffer;
15780 #endif
15785 * "shellescape({string})" function
15787 static void
15788 f_shellescape(argvars, rettv)
15789 typval_T *argvars;
15790 typval_T *rettv;
15792 rettv->vval.v_string = vim_strsave_shellescape(
15793 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15794 rettv->v_type = VAR_STRING;
15798 * "simplify()" function
15800 static void
15801 f_simplify(argvars, rettv)
15802 typval_T *argvars;
15803 typval_T *rettv;
15805 char_u *p;
15807 p = get_tv_string(&argvars[0]);
15808 rettv->vval.v_string = vim_strsave(p);
15809 simplify_filename(rettv->vval.v_string); /* simplify in place */
15810 rettv->v_type = VAR_STRING;
15813 #ifdef FEAT_FLOAT
15815 * "sin()" function
15817 static void
15818 f_sin(argvars, rettv)
15819 typval_T *argvars;
15820 typval_T *rettv;
15822 float_T f;
15824 rettv->v_type = VAR_FLOAT;
15825 if (get_float_arg(argvars, &f) == OK)
15826 rettv->vval.v_float = sin(f);
15827 else
15828 rettv->vval.v_float = 0.0;
15830 #endif
15832 static int
15833 #ifdef __BORLANDC__
15834 _RTLENTRYF
15835 #endif
15836 item_compare __ARGS((const void *s1, const void *s2));
15837 static int
15838 #ifdef __BORLANDC__
15839 _RTLENTRYF
15840 #endif
15841 item_compare2 __ARGS((const void *s1, const void *s2));
15843 static int item_compare_ic;
15844 static char_u *item_compare_func;
15845 static int item_compare_func_err;
15846 #define ITEM_COMPARE_FAIL 999
15849 * Compare functions for f_sort() below.
15851 static int
15852 #ifdef __BORLANDC__
15853 _RTLENTRYF
15854 #endif
15855 item_compare(s1, s2)
15856 const void *s1;
15857 const void *s2;
15859 char_u *p1, *p2;
15860 char_u *tofree1, *tofree2;
15861 int res;
15862 char_u numbuf1[NUMBUFLEN];
15863 char_u numbuf2[NUMBUFLEN];
15865 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15866 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15867 if (p1 == NULL)
15868 p1 = (char_u *)"";
15869 if (p2 == NULL)
15870 p2 = (char_u *)"";
15871 if (item_compare_ic)
15872 res = STRICMP(p1, p2);
15873 else
15874 res = STRCMP(p1, p2);
15875 vim_free(tofree1);
15876 vim_free(tofree2);
15877 return res;
15880 static int
15881 #ifdef __BORLANDC__
15882 _RTLENTRYF
15883 #endif
15884 item_compare2(s1, s2)
15885 const void *s1;
15886 const void *s2;
15888 int res;
15889 typval_T rettv;
15890 typval_T argv[3];
15891 int dummy;
15893 /* shortcut after failure in previous call; compare all items equal */
15894 if (item_compare_func_err)
15895 return 0;
15897 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15898 * in the copy without changing the original list items. */
15899 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15900 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15902 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15903 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15904 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15905 clear_tv(&argv[0]);
15906 clear_tv(&argv[1]);
15908 if (res == FAIL)
15909 res = ITEM_COMPARE_FAIL;
15910 else
15911 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15912 if (item_compare_func_err)
15913 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15914 clear_tv(&rettv);
15915 return res;
15919 * "sort({list})" function
15921 static void
15922 f_sort(argvars, rettv)
15923 typval_T *argvars;
15924 typval_T *rettv;
15926 list_T *l;
15927 listitem_T *li;
15928 listitem_T **ptrs;
15929 long len;
15930 long i;
15932 if (argvars[0].v_type != VAR_LIST)
15933 EMSG2(_(e_listarg), "sort()");
15934 else
15936 l = argvars[0].vval.v_list;
15937 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15938 return;
15939 rettv->vval.v_list = l;
15940 rettv->v_type = VAR_LIST;
15941 ++l->lv_refcount;
15943 len = list_len(l);
15944 if (len <= 1)
15945 return; /* short list sorts pretty quickly */
15947 item_compare_ic = FALSE;
15948 item_compare_func = NULL;
15949 if (argvars[1].v_type != VAR_UNKNOWN)
15951 if (argvars[1].v_type == VAR_FUNC)
15952 item_compare_func = argvars[1].vval.v_string;
15953 else
15955 int error = FALSE;
15957 i = get_tv_number_chk(&argvars[1], &error);
15958 if (error)
15959 return; /* type error; errmsg already given */
15960 if (i == 1)
15961 item_compare_ic = TRUE;
15962 else
15963 item_compare_func = get_tv_string(&argvars[1]);
15967 /* Make an array with each entry pointing to an item in the List. */
15968 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15969 if (ptrs == NULL)
15970 return;
15971 i = 0;
15972 for (li = l->lv_first; li != NULL; li = li->li_next)
15973 ptrs[i++] = li;
15975 item_compare_func_err = FALSE;
15976 /* test the compare function */
15977 if (item_compare_func != NULL
15978 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15979 == ITEM_COMPARE_FAIL)
15980 EMSG(_("E702: Sort compare function failed"));
15981 else
15983 /* Sort the array with item pointers. */
15984 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15985 item_compare_func == NULL ? item_compare : item_compare2);
15987 if (!item_compare_func_err)
15989 /* Clear the List and append the items in the sorted order. */
15990 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15991 l->lv_len = 0;
15992 for (i = 0; i < len; ++i)
15993 list_append(l, ptrs[i]);
15997 vim_free(ptrs);
16002 * "soundfold({word})" function
16004 static void
16005 f_soundfold(argvars, rettv)
16006 typval_T *argvars;
16007 typval_T *rettv;
16009 char_u *s;
16011 rettv->v_type = VAR_STRING;
16012 s = get_tv_string(&argvars[0]);
16013 #ifdef FEAT_SPELL
16014 rettv->vval.v_string = eval_soundfold(s);
16015 #else
16016 rettv->vval.v_string = vim_strsave(s);
16017 #endif
16021 * "spellbadword()" function
16023 static void
16024 f_spellbadword(argvars, rettv)
16025 typval_T *argvars UNUSED;
16026 typval_T *rettv;
16028 char_u *word = (char_u *)"";
16029 hlf_T attr = HLF_COUNT;
16030 int len = 0;
16032 if (rettv_list_alloc(rettv) == FAIL)
16033 return;
16035 #ifdef FEAT_SPELL
16036 if (argvars[0].v_type == VAR_UNKNOWN)
16038 /* Find the start and length of the badly spelled word. */
16039 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16040 if (len != 0)
16041 word = ml_get_cursor();
16043 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16045 char_u *str = get_tv_string_chk(&argvars[0]);
16046 int capcol = -1;
16048 if (str != NULL)
16050 /* Check the argument for spelling. */
16051 while (*str != NUL)
16053 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16054 if (attr != HLF_COUNT)
16056 word = str;
16057 break;
16059 str += len;
16063 #endif
16065 list_append_string(rettv->vval.v_list, word, len);
16066 list_append_string(rettv->vval.v_list, (char_u *)(
16067 attr == HLF_SPB ? "bad" :
16068 attr == HLF_SPR ? "rare" :
16069 attr == HLF_SPL ? "local" :
16070 attr == HLF_SPC ? "caps" :
16071 ""), -1);
16075 * "spellsuggest()" function
16077 static void
16078 f_spellsuggest(argvars, rettv)
16079 typval_T *argvars UNUSED;
16080 typval_T *rettv;
16082 #ifdef FEAT_SPELL
16083 char_u *str;
16084 int typeerr = FALSE;
16085 int maxcount;
16086 garray_T ga;
16087 int i;
16088 listitem_T *li;
16089 int need_capital = FALSE;
16090 #endif
16092 if (rettv_list_alloc(rettv) == FAIL)
16093 return;
16095 #ifdef FEAT_SPELL
16096 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16098 str = get_tv_string(&argvars[0]);
16099 if (argvars[1].v_type != VAR_UNKNOWN)
16101 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16102 if (maxcount <= 0)
16103 return;
16104 if (argvars[2].v_type != VAR_UNKNOWN)
16106 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16107 if (typeerr)
16108 return;
16111 else
16112 maxcount = 25;
16114 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16116 for (i = 0; i < ga.ga_len; ++i)
16118 str = ((char_u **)ga.ga_data)[i];
16120 li = listitem_alloc();
16121 if (li == NULL)
16122 vim_free(str);
16123 else
16125 li->li_tv.v_type = VAR_STRING;
16126 li->li_tv.v_lock = 0;
16127 li->li_tv.vval.v_string = str;
16128 list_append(rettv->vval.v_list, li);
16131 ga_clear(&ga);
16133 #endif
16136 static void
16137 f_split(argvars, rettv)
16138 typval_T *argvars;
16139 typval_T *rettv;
16141 char_u *str;
16142 char_u *end;
16143 char_u *pat = NULL;
16144 regmatch_T regmatch;
16145 char_u patbuf[NUMBUFLEN];
16146 char_u *save_cpo;
16147 int match;
16148 colnr_T col = 0;
16149 int keepempty = FALSE;
16150 int typeerr = FALSE;
16152 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16153 save_cpo = p_cpo;
16154 p_cpo = (char_u *)"";
16156 str = get_tv_string(&argvars[0]);
16157 if (argvars[1].v_type != VAR_UNKNOWN)
16159 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16160 if (pat == NULL)
16161 typeerr = TRUE;
16162 if (argvars[2].v_type != VAR_UNKNOWN)
16163 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16165 if (pat == NULL || *pat == NUL)
16166 pat = (char_u *)"[\\x01- ]\\+";
16168 if (rettv_list_alloc(rettv) == FAIL)
16169 return;
16170 if (typeerr)
16171 return;
16173 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16174 if (regmatch.regprog != NULL)
16176 regmatch.rm_ic = FALSE;
16177 while (*str != NUL || keepempty)
16179 if (*str == NUL)
16180 match = FALSE; /* empty item at the end */
16181 else
16182 match = vim_regexec_nl(&regmatch, str, col);
16183 if (match)
16184 end = regmatch.startp[0];
16185 else
16186 end = str + STRLEN(str);
16187 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16188 && *str != NUL && match && end < regmatch.endp[0]))
16190 if (list_append_string(rettv->vval.v_list, str,
16191 (int)(end - str)) == FAIL)
16192 break;
16194 if (!match)
16195 break;
16196 /* Advance to just after the match. */
16197 if (regmatch.endp[0] > str)
16198 col = 0;
16199 else
16201 /* Don't get stuck at the same match. */
16202 #ifdef FEAT_MBYTE
16203 col = (*mb_ptr2len)(regmatch.endp[0]);
16204 #else
16205 col = 1;
16206 #endif
16208 str = regmatch.endp[0];
16211 vim_free(regmatch.regprog);
16214 p_cpo = save_cpo;
16217 #ifdef FEAT_FLOAT
16219 * "sqrt()" function
16221 static void
16222 f_sqrt(argvars, rettv)
16223 typval_T *argvars;
16224 typval_T *rettv;
16226 float_T f;
16228 rettv->v_type = VAR_FLOAT;
16229 if (get_float_arg(argvars, &f) == OK)
16230 rettv->vval.v_float = sqrt(f);
16231 else
16232 rettv->vval.v_float = 0.0;
16236 * "str2float()" function
16238 static void
16239 f_str2float(argvars, rettv)
16240 typval_T *argvars;
16241 typval_T *rettv;
16243 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16245 if (*p == '+')
16246 p = skipwhite(p + 1);
16247 (void)string2float(p, &rettv->vval.v_float);
16248 rettv->v_type = VAR_FLOAT;
16250 #endif
16253 * "str2nr()" function
16255 static void
16256 f_str2nr(argvars, rettv)
16257 typval_T *argvars;
16258 typval_T *rettv;
16260 int base = 10;
16261 char_u *p;
16262 long n;
16264 if (argvars[1].v_type != VAR_UNKNOWN)
16266 base = get_tv_number(&argvars[1]);
16267 if (base != 8 && base != 10 && base != 16)
16269 EMSG(_(e_invarg));
16270 return;
16274 p = skipwhite(get_tv_string(&argvars[0]));
16275 if (*p == '+')
16276 p = skipwhite(p + 1);
16277 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16278 rettv->vval.v_number = n;
16281 #ifdef HAVE_STRFTIME
16283 * "strftime({format}[, {time}])" function
16285 static void
16286 f_strftime(argvars, rettv)
16287 typval_T *argvars;
16288 typval_T *rettv;
16290 char_u result_buf[256];
16291 struct tm *curtime;
16292 time_t seconds;
16293 char_u *p;
16295 rettv->v_type = VAR_STRING;
16297 p = get_tv_string(&argvars[0]);
16298 if (argvars[1].v_type == VAR_UNKNOWN)
16299 seconds = time(NULL);
16300 else
16301 seconds = (time_t)get_tv_number(&argvars[1]);
16302 curtime = localtime(&seconds);
16303 /* MSVC returns NULL for an invalid value of seconds. */
16304 if (curtime == NULL)
16305 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16306 else
16308 # ifdef FEAT_MBYTE
16309 vimconv_T conv;
16310 char_u *enc;
16312 conv.vc_type = CONV_NONE;
16313 enc = enc_locale();
16314 convert_setup(&conv, p_enc, enc);
16315 if (conv.vc_type != CONV_NONE)
16316 p = string_convert(&conv, p, NULL);
16317 # endif
16318 if (p != NULL)
16319 (void)strftime((char *)result_buf, sizeof(result_buf),
16320 (char *)p, curtime);
16321 else
16322 result_buf[0] = NUL;
16324 # ifdef FEAT_MBYTE
16325 if (conv.vc_type != CONV_NONE)
16326 vim_free(p);
16327 convert_setup(&conv, enc, p_enc);
16328 if (conv.vc_type != CONV_NONE)
16329 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16330 else
16331 # endif
16332 rettv->vval.v_string = vim_strsave(result_buf);
16334 # ifdef FEAT_MBYTE
16335 /* Release conversion descriptors */
16336 convert_setup(&conv, NULL, NULL);
16337 vim_free(enc);
16338 # endif
16341 #endif
16344 * "stridx()" function
16346 static void
16347 f_stridx(argvars, rettv)
16348 typval_T *argvars;
16349 typval_T *rettv;
16351 char_u buf[NUMBUFLEN];
16352 char_u *needle;
16353 char_u *haystack;
16354 char_u *save_haystack;
16355 char_u *pos;
16356 int start_idx;
16358 needle = get_tv_string_chk(&argvars[1]);
16359 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16360 rettv->vval.v_number = -1;
16361 if (needle == NULL || haystack == NULL)
16362 return; /* type error; errmsg already given */
16364 if (argvars[2].v_type != VAR_UNKNOWN)
16366 int error = FALSE;
16368 start_idx = get_tv_number_chk(&argvars[2], &error);
16369 if (error || start_idx >= (int)STRLEN(haystack))
16370 return;
16371 if (start_idx >= 0)
16372 haystack += start_idx;
16375 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16376 if (pos != NULL)
16377 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16381 * "string()" function
16383 static void
16384 f_string(argvars, rettv)
16385 typval_T *argvars;
16386 typval_T *rettv;
16388 char_u *tofree;
16389 char_u numbuf[NUMBUFLEN];
16391 rettv->v_type = VAR_STRING;
16392 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16393 /* Make a copy if we have a value but it's not in allocated memory. */
16394 if (rettv->vval.v_string != NULL && tofree == NULL)
16395 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16399 * "strlen()" function
16401 static void
16402 f_strlen(argvars, rettv)
16403 typval_T *argvars;
16404 typval_T *rettv;
16406 rettv->vval.v_number = (varnumber_T)(STRLEN(
16407 get_tv_string(&argvars[0])));
16411 * "strpart()" function
16413 static void
16414 f_strpart(argvars, rettv)
16415 typval_T *argvars;
16416 typval_T *rettv;
16418 char_u *p;
16419 int n;
16420 int len;
16421 int slen;
16422 int error = FALSE;
16424 p = get_tv_string(&argvars[0]);
16425 slen = (int)STRLEN(p);
16427 n = get_tv_number_chk(&argvars[1], &error);
16428 if (error)
16429 len = 0;
16430 else if (argvars[2].v_type != VAR_UNKNOWN)
16431 len = get_tv_number(&argvars[2]);
16432 else
16433 len = slen - n; /* default len: all bytes that are available. */
16436 * Only return the overlap between the specified part and the actual
16437 * string.
16439 if (n < 0)
16441 len += n;
16442 n = 0;
16444 else if (n > slen)
16445 n = slen;
16446 if (len < 0)
16447 len = 0;
16448 else if (n + len > slen)
16449 len = slen - n;
16451 rettv->v_type = VAR_STRING;
16452 rettv->vval.v_string = vim_strnsave(p + n, len);
16456 * "strridx()" function
16458 static void
16459 f_strridx(argvars, rettv)
16460 typval_T *argvars;
16461 typval_T *rettv;
16463 char_u buf[NUMBUFLEN];
16464 char_u *needle;
16465 char_u *haystack;
16466 char_u *rest;
16467 char_u *lastmatch = NULL;
16468 int haystack_len, end_idx;
16470 needle = get_tv_string_chk(&argvars[1]);
16471 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16473 rettv->vval.v_number = -1;
16474 if (needle == NULL || haystack == NULL)
16475 return; /* type error; errmsg already given */
16477 haystack_len = (int)STRLEN(haystack);
16478 if (argvars[2].v_type != VAR_UNKNOWN)
16480 /* Third argument: upper limit for index */
16481 end_idx = get_tv_number_chk(&argvars[2], NULL);
16482 if (end_idx < 0)
16483 return; /* can never find a match */
16485 else
16486 end_idx = haystack_len;
16488 if (*needle == NUL)
16490 /* Empty string matches past the end. */
16491 lastmatch = haystack + end_idx;
16493 else
16495 for (rest = haystack; *rest != '\0'; ++rest)
16497 rest = (char_u *)strstr((char *)rest, (char *)needle);
16498 if (rest == NULL || rest > haystack + end_idx)
16499 break;
16500 lastmatch = rest;
16504 if (lastmatch == NULL)
16505 rettv->vval.v_number = -1;
16506 else
16507 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16511 * "strtrans()" function
16513 static void
16514 f_strtrans(argvars, rettv)
16515 typval_T *argvars;
16516 typval_T *rettv;
16518 rettv->v_type = VAR_STRING;
16519 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16523 * "submatch()" function
16525 static void
16526 f_submatch(argvars, rettv)
16527 typval_T *argvars;
16528 typval_T *rettv;
16530 rettv->v_type = VAR_STRING;
16531 rettv->vval.v_string =
16532 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16536 * "substitute()" function
16538 static void
16539 f_substitute(argvars, rettv)
16540 typval_T *argvars;
16541 typval_T *rettv;
16543 char_u patbuf[NUMBUFLEN];
16544 char_u subbuf[NUMBUFLEN];
16545 char_u flagsbuf[NUMBUFLEN];
16547 char_u *str = get_tv_string_chk(&argvars[0]);
16548 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16549 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16550 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16552 rettv->v_type = VAR_STRING;
16553 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16554 rettv->vval.v_string = NULL;
16555 else
16556 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16560 * "synID(lnum, col, trans)" function
16562 static void
16563 f_synID(argvars, rettv)
16564 typval_T *argvars UNUSED;
16565 typval_T *rettv;
16567 int id = 0;
16568 #ifdef FEAT_SYN_HL
16569 long lnum;
16570 long col;
16571 int trans;
16572 int transerr = FALSE;
16574 lnum = get_tv_lnum(argvars); /* -1 on type error */
16575 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16576 trans = get_tv_number_chk(&argvars[2], &transerr);
16578 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16579 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16580 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16581 #endif
16583 rettv->vval.v_number = id;
16587 * "synIDattr(id, what [, mode])" function
16589 static void
16590 f_synIDattr(argvars, rettv)
16591 typval_T *argvars UNUSED;
16592 typval_T *rettv;
16594 char_u *p = NULL;
16595 #ifdef FEAT_SYN_HL
16596 int id;
16597 char_u *what;
16598 char_u *mode;
16599 char_u modebuf[NUMBUFLEN];
16600 int modec;
16602 id = get_tv_number(&argvars[0]);
16603 what = get_tv_string(&argvars[1]);
16604 if (argvars[2].v_type != VAR_UNKNOWN)
16606 mode = get_tv_string_buf(&argvars[2], modebuf);
16607 modec = TOLOWER_ASC(mode[0]);
16608 if (modec != 't' && modec != 'c'
16609 #ifdef FEAT_GUI
16610 && modec != 'g'
16611 #endif
16613 modec = 0; /* replace invalid with current */
16615 else
16617 #ifdef FEAT_GUI
16618 if (gui.in_use)
16619 modec = 'g';
16620 else
16621 #endif
16622 if (t_colors > 1)
16623 modec = 'c';
16624 else
16625 modec = 't';
16629 switch (TOLOWER_ASC(what[0]))
16631 case 'b':
16632 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16633 p = highlight_color(id, what, modec);
16634 else /* bold */
16635 p = highlight_has_attr(id, HL_BOLD, modec);
16636 break;
16638 case 'f': /* fg[#] or font */
16639 p = highlight_color(id, what, modec);
16640 break;
16642 case 'i':
16643 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16644 p = highlight_has_attr(id, HL_INVERSE, modec);
16645 else /* italic */
16646 p = highlight_has_attr(id, HL_ITALIC, modec);
16647 break;
16649 case 'n': /* name */
16650 p = get_highlight_name(NULL, id - 1);
16651 break;
16653 case 'r': /* reverse */
16654 p = highlight_has_attr(id, HL_INVERSE, modec);
16655 break;
16657 case 's':
16658 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16659 p = highlight_color(id, what, modec);
16660 else /* standout */
16661 p = highlight_has_attr(id, HL_STANDOUT, modec);
16662 break;
16664 case 'u':
16665 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16666 /* underline */
16667 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16668 else
16669 /* undercurl */
16670 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16671 break;
16674 if (p != NULL)
16675 p = vim_strsave(p);
16676 #endif
16677 rettv->v_type = VAR_STRING;
16678 rettv->vval.v_string = p;
16682 * "synIDtrans(id)" function
16684 static void
16685 f_synIDtrans(argvars, rettv)
16686 typval_T *argvars UNUSED;
16687 typval_T *rettv;
16689 int id;
16691 #ifdef FEAT_SYN_HL
16692 id = get_tv_number(&argvars[0]);
16694 if (id > 0)
16695 id = syn_get_final_id(id);
16696 else
16697 #endif
16698 id = 0;
16700 rettv->vval.v_number = id;
16704 * "synstack(lnum, col)" function
16706 static void
16707 f_synstack(argvars, rettv)
16708 typval_T *argvars UNUSED;
16709 typval_T *rettv;
16711 #ifdef FEAT_SYN_HL
16712 long lnum;
16713 long col;
16714 int i;
16715 int id;
16716 #endif
16718 rettv->v_type = VAR_LIST;
16719 rettv->vval.v_list = NULL;
16721 #ifdef FEAT_SYN_HL
16722 lnum = get_tv_lnum(argvars); /* -1 on type error */
16723 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16725 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16726 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16727 && rettv_list_alloc(rettv) != FAIL)
16729 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16730 for (i = 0; ; ++i)
16732 id = syn_get_stack_item(i);
16733 if (id < 0)
16734 break;
16735 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16736 break;
16739 #endif
16743 * "system()" function
16745 static void
16746 f_system(argvars, rettv)
16747 typval_T *argvars;
16748 typval_T *rettv;
16750 char_u *res = NULL;
16751 char_u *p;
16752 char_u *infile = NULL;
16753 char_u buf[NUMBUFLEN];
16754 int err = FALSE;
16755 FILE *fd;
16757 if (check_restricted() || check_secure())
16758 goto done;
16760 if (argvars[1].v_type != VAR_UNKNOWN)
16763 * Write the string to a temp file, to be used for input of the shell
16764 * command.
16766 if ((infile = vim_tempname('i')) == NULL)
16768 EMSG(_(e_notmp));
16769 goto done;
16772 fd = mch_fopen((char *)infile, WRITEBIN);
16773 if (fd == NULL)
16775 EMSG2(_(e_notopen), infile);
16776 goto done;
16778 p = get_tv_string_buf_chk(&argvars[1], buf);
16779 if (p == NULL)
16781 fclose(fd);
16782 goto done; /* type error; errmsg already given */
16784 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16785 err = TRUE;
16786 if (fclose(fd) != 0)
16787 err = TRUE;
16788 if (err)
16790 EMSG(_("E677: Error writing temp file"));
16791 goto done;
16795 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16796 SHELL_SILENT | SHELL_COOKED);
16798 #ifdef USE_CR
16799 /* translate <CR> into <NL> */
16800 if (res != NULL)
16802 char_u *s;
16804 for (s = res; *s; ++s)
16806 if (*s == CAR)
16807 *s = NL;
16810 #else
16811 # ifdef USE_CRNL
16812 /* translate <CR><NL> into <NL> */
16813 if (res != NULL)
16815 char_u *s, *d;
16817 d = res;
16818 for (s = res; *s; ++s)
16820 if (s[0] == CAR && s[1] == NL)
16821 ++s;
16822 *d++ = *s;
16824 *d = NUL;
16826 # endif
16827 #endif
16829 done:
16830 if (infile != NULL)
16832 mch_remove(infile);
16833 vim_free(infile);
16835 rettv->v_type = VAR_STRING;
16836 rettv->vval.v_string = res;
16840 * "tabpagebuflist()" function
16842 static void
16843 f_tabpagebuflist(argvars, rettv)
16844 typval_T *argvars UNUSED;
16845 typval_T *rettv UNUSED;
16847 #ifdef FEAT_WINDOWS
16848 tabpage_T *tp;
16849 win_T *wp = NULL;
16851 if (argvars[0].v_type == VAR_UNKNOWN)
16852 wp = firstwin;
16853 else
16855 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16856 if (tp != NULL)
16857 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16859 if (wp != NULL && rettv_list_alloc(rettv) != FAIL)
16861 for (; wp != NULL; wp = wp->w_next)
16862 if (list_append_number(rettv->vval.v_list,
16863 wp->w_buffer->b_fnum) == FAIL)
16864 break;
16866 #endif
16871 * "tabpagenr()" function
16873 static void
16874 f_tabpagenr(argvars, rettv)
16875 typval_T *argvars UNUSED;
16876 typval_T *rettv;
16878 int nr = 1;
16879 #ifdef FEAT_WINDOWS
16880 char_u *arg;
16882 if (argvars[0].v_type != VAR_UNKNOWN)
16884 arg = get_tv_string_chk(&argvars[0]);
16885 nr = 0;
16886 if (arg != NULL)
16888 if (STRCMP(arg, "$") == 0)
16889 nr = tabpage_index(NULL) - 1;
16890 else
16891 EMSG2(_(e_invexpr2), arg);
16894 else
16895 nr = tabpage_index(curtab);
16896 #endif
16897 rettv->vval.v_number = nr;
16901 #ifdef FEAT_WINDOWS
16902 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16905 * Common code for tabpagewinnr() and winnr().
16907 static int
16908 get_winnr(tp, argvar)
16909 tabpage_T *tp;
16910 typval_T *argvar;
16912 win_T *twin;
16913 int nr = 1;
16914 win_T *wp;
16915 char_u *arg;
16917 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16918 if (argvar->v_type != VAR_UNKNOWN)
16920 arg = get_tv_string_chk(argvar);
16921 if (arg == NULL)
16922 nr = 0; /* type error; errmsg already given */
16923 else if (STRCMP(arg, "$") == 0)
16924 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16925 else if (STRCMP(arg, "#") == 0)
16927 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16928 if (twin == NULL)
16929 nr = 0;
16931 else
16933 EMSG2(_(e_invexpr2), arg);
16934 nr = 0;
16938 if (nr > 0)
16939 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16940 wp != twin; wp = wp->w_next)
16942 if (wp == NULL)
16944 /* didn't find it in this tabpage */
16945 nr = 0;
16946 break;
16948 ++nr;
16950 return nr;
16952 #endif
16955 * "tabpagewinnr()" function
16957 static void
16958 f_tabpagewinnr(argvars, rettv)
16959 typval_T *argvars UNUSED;
16960 typval_T *rettv;
16962 int nr = 1;
16963 #ifdef FEAT_WINDOWS
16964 tabpage_T *tp;
16966 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16967 if (tp == NULL)
16968 nr = 0;
16969 else
16970 nr = get_winnr(tp, &argvars[1]);
16971 #endif
16972 rettv->vval.v_number = nr;
16977 * "tagfiles()" function
16979 static void
16980 f_tagfiles(argvars, rettv)
16981 typval_T *argvars UNUSED;
16982 typval_T *rettv;
16984 char_u fname[MAXPATHL + 1];
16985 tagname_T tn;
16986 int first;
16988 if (rettv_list_alloc(rettv) == FAIL)
16989 return;
16991 for (first = TRUE; ; first = FALSE)
16992 if (get_tagfname(&tn, first, fname) == FAIL
16993 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
16994 break;
16995 tagname_free(&tn);
16999 * "taglist()" function
17001 static void
17002 f_taglist(argvars, rettv)
17003 typval_T *argvars;
17004 typval_T *rettv;
17006 char_u *tag_pattern;
17008 tag_pattern = get_tv_string(&argvars[0]);
17010 rettv->vval.v_number = FALSE;
17011 if (*tag_pattern == NUL)
17012 return;
17014 if (rettv_list_alloc(rettv) == OK)
17015 (void)get_tags(rettv->vval.v_list, tag_pattern);
17019 * "tempname()" function
17021 static void
17022 f_tempname(argvars, rettv)
17023 typval_T *argvars UNUSED;
17024 typval_T *rettv;
17026 static int x = 'A';
17028 rettv->v_type = VAR_STRING;
17029 rettv->vval.v_string = vim_tempname(x);
17031 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17032 * names. Skip 'I' and 'O', they are used for shell redirection. */
17035 if (x == 'Z')
17036 x = '0';
17037 else if (x == '9')
17038 x = 'A';
17039 else
17041 #ifdef EBCDIC
17042 if (x == 'I')
17043 x = 'J';
17044 else if (x == 'R')
17045 x = 'S';
17046 else
17047 #endif
17048 ++x;
17050 } while (x == 'I' || x == 'O');
17054 * "test(list)" function: Just checking the walls...
17056 static void
17057 f_test(argvars, rettv)
17058 typval_T *argvars UNUSED;
17059 typval_T *rettv UNUSED;
17061 /* Used for unit testing. Change the code below to your liking. */
17062 #if 0
17063 listitem_T *li;
17064 list_T *l;
17065 char_u *bad, *good;
17067 if (argvars[0].v_type != VAR_LIST)
17068 return;
17069 l = argvars[0].vval.v_list;
17070 if (l == NULL)
17071 return;
17072 li = l->lv_first;
17073 if (li == NULL)
17074 return;
17075 bad = get_tv_string(&li->li_tv);
17076 li = li->li_next;
17077 if (li == NULL)
17078 return;
17079 good = get_tv_string(&li->li_tv);
17080 rettv->vval.v_number = test_edit_score(bad, good);
17081 #endif
17085 * "tolower(string)" function
17087 static void
17088 f_tolower(argvars, rettv)
17089 typval_T *argvars;
17090 typval_T *rettv;
17092 char_u *p;
17094 p = vim_strsave(get_tv_string(&argvars[0]));
17095 rettv->v_type = VAR_STRING;
17096 rettv->vval.v_string = p;
17098 if (p != NULL)
17099 while (*p != NUL)
17101 #ifdef FEAT_MBYTE
17102 int l;
17104 if (enc_utf8)
17106 int c, lc;
17108 c = utf_ptr2char(p);
17109 lc = utf_tolower(c);
17110 l = utf_ptr2len(p);
17111 /* TODO: reallocate string when byte count changes. */
17112 if (utf_char2len(lc) == l)
17113 utf_char2bytes(lc, p);
17114 p += l;
17116 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17117 p += l; /* skip multi-byte character */
17118 else
17119 #endif
17121 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17122 ++p;
17128 * "toupper(string)" function
17130 static void
17131 f_toupper(argvars, rettv)
17132 typval_T *argvars;
17133 typval_T *rettv;
17135 rettv->v_type = VAR_STRING;
17136 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17140 * "tr(string, fromstr, tostr)" function
17142 static void
17143 f_tr(argvars, rettv)
17144 typval_T *argvars;
17145 typval_T *rettv;
17147 char_u *instr;
17148 char_u *fromstr;
17149 char_u *tostr;
17150 char_u *p;
17151 #ifdef FEAT_MBYTE
17152 int inlen;
17153 int fromlen;
17154 int tolen;
17155 int idx;
17156 char_u *cpstr;
17157 int cplen;
17158 int first = TRUE;
17159 #endif
17160 char_u buf[NUMBUFLEN];
17161 char_u buf2[NUMBUFLEN];
17162 garray_T ga;
17164 instr = get_tv_string(&argvars[0]);
17165 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17166 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17168 /* Default return value: empty string. */
17169 rettv->v_type = VAR_STRING;
17170 rettv->vval.v_string = NULL;
17171 if (fromstr == NULL || tostr == NULL)
17172 return; /* type error; errmsg already given */
17173 ga_init2(&ga, (int)sizeof(char), 80);
17175 #ifdef FEAT_MBYTE
17176 if (!has_mbyte)
17177 #endif
17178 /* not multi-byte: fromstr and tostr must be the same length */
17179 if (STRLEN(fromstr) != STRLEN(tostr))
17181 #ifdef FEAT_MBYTE
17182 error:
17183 #endif
17184 EMSG2(_(e_invarg2), fromstr);
17185 ga_clear(&ga);
17186 return;
17189 /* fromstr and tostr have to contain the same number of chars */
17190 while (*instr != NUL)
17192 #ifdef FEAT_MBYTE
17193 if (has_mbyte)
17195 inlen = (*mb_ptr2len)(instr);
17196 cpstr = instr;
17197 cplen = inlen;
17198 idx = 0;
17199 for (p = fromstr; *p != NUL; p += fromlen)
17201 fromlen = (*mb_ptr2len)(p);
17202 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17204 for (p = tostr; *p != NUL; p += tolen)
17206 tolen = (*mb_ptr2len)(p);
17207 if (idx-- == 0)
17209 cplen = tolen;
17210 cpstr = p;
17211 break;
17214 if (*p == NUL) /* tostr is shorter than fromstr */
17215 goto error;
17216 break;
17218 ++idx;
17221 if (first && cpstr == instr)
17223 /* Check that fromstr and tostr have the same number of
17224 * (multi-byte) characters. Done only once when a character
17225 * of instr doesn't appear in fromstr. */
17226 first = FALSE;
17227 for (p = tostr; *p != NUL; p += tolen)
17229 tolen = (*mb_ptr2len)(p);
17230 --idx;
17232 if (idx != 0)
17233 goto error;
17236 ga_grow(&ga, cplen);
17237 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17238 ga.ga_len += cplen;
17240 instr += inlen;
17242 else
17243 #endif
17245 /* When not using multi-byte chars we can do it faster. */
17246 p = vim_strchr(fromstr, *instr);
17247 if (p != NULL)
17248 ga_append(&ga, tostr[p - fromstr]);
17249 else
17250 ga_append(&ga, *instr);
17251 ++instr;
17255 /* add a terminating NUL */
17256 ga_grow(&ga, 1);
17257 ga_append(&ga, NUL);
17259 rettv->vval.v_string = ga.ga_data;
17262 #ifdef FEAT_FLOAT
17264 * "trunc({float})" function
17266 static void
17267 f_trunc(argvars, rettv)
17268 typval_T *argvars;
17269 typval_T *rettv;
17271 float_T f;
17273 rettv->v_type = VAR_FLOAT;
17274 if (get_float_arg(argvars, &f) == OK)
17275 /* trunc() is not in C90, use floor() or ceil() instead. */
17276 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17277 else
17278 rettv->vval.v_float = 0.0;
17280 #endif
17283 * "type(expr)" function
17285 static void
17286 f_type(argvars, rettv)
17287 typval_T *argvars;
17288 typval_T *rettv;
17290 int n;
17292 switch (argvars[0].v_type)
17294 case VAR_NUMBER: n = 0; break;
17295 case VAR_STRING: n = 1; break;
17296 case VAR_FUNC: n = 2; break;
17297 case VAR_LIST: n = 3; break;
17298 case VAR_DICT: n = 4; break;
17299 #ifdef FEAT_FLOAT
17300 case VAR_FLOAT: n = 5; break;
17301 #endif
17302 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17304 rettv->vval.v_number = n;
17308 * "values(dict)" function
17310 static void
17311 f_values(argvars, rettv)
17312 typval_T *argvars;
17313 typval_T *rettv;
17315 dict_list(argvars, rettv, 1);
17319 * "virtcol(string)" function
17321 static void
17322 f_virtcol(argvars, rettv)
17323 typval_T *argvars;
17324 typval_T *rettv;
17326 colnr_T vcol = 0;
17327 pos_T *fp;
17328 int fnum = curbuf->b_fnum;
17330 fp = var2fpos(&argvars[0], FALSE, &fnum);
17331 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17332 && fnum == curbuf->b_fnum)
17334 getvvcol(curwin, fp, NULL, NULL, &vcol);
17335 ++vcol;
17338 rettv->vval.v_number = vcol;
17342 * "visualmode()" function
17344 static void
17345 f_visualmode(argvars, rettv)
17346 typval_T *argvars UNUSED;
17347 typval_T *rettv UNUSED;
17349 #ifdef FEAT_VISUAL
17350 char_u str[2];
17352 rettv->v_type = VAR_STRING;
17353 str[0] = curbuf->b_visual_mode_eval;
17354 str[1] = NUL;
17355 rettv->vval.v_string = vim_strsave(str);
17357 /* A non-zero number or non-empty string argument: reset mode. */
17358 if (non_zero_arg(&argvars[0]))
17359 curbuf->b_visual_mode_eval = NUL;
17360 #endif
17364 * "winbufnr(nr)" function
17366 static void
17367 f_winbufnr(argvars, rettv)
17368 typval_T *argvars;
17369 typval_T *rettv;
17371 win_T *wp;
17373 wp = find_win_by_nr(&argvars[0], NULL);
17374 if (wp == NULL)
17375 rettv->vval.v_number = -1;
17376 else
17377 rettv->vval.v_number = wp->w_buffer->b_fnum;
17381 * "wincol()" function
17383 static void
17384 f_wincol(argvars, rettv)
17385 typval_T *argvars UNUSED;
17386 typval_T *rettv;
17388 validate_cursor();
17389 rettv->vval.v_number = curwin->w_wcol + 1;
17393 * "winheight(nr)" function
17395 static void
17396 f_winheight(argvars, rettv)
17397 typval_T *argvars;
17398 typval_T *rettv;
17400 win_T *wp;
17402 wp = find_win_by_nr(&argvars[0], NULL);
17403 if (wp == NULL)
17404 rettv->vval.v_number = -1;
17405 else
17406 rettv->vval.v_number = wp->w_height;
17410 * "winline()" function
17412 static void
17413 f_winline(argvars, rettv)
17414 typval_T *argvars UNUSED;
17415 typval_T *rettv;
17417 validate_cursor();
17418 rettv->vval.v_number = curwin->w_wrow + 1;
17422 * "winnr()" function
17424 static void
17425 f_winnr(argvars, rettv)
17426 typval_T *argvars UNUSED;
17427 typval_T *rettv;
17429 int nr = 1;
17431 #ifdef FEAT_WINDOWS
17432 nr = get_winnr(curtab, &argvars[0]);
17433 #endif
17434 rettv->vval.v_number = nr;
17438 * "winrestcmd()" function
17440 static void
17441 f_winrestcmd(argvars, rettv)
17442 typval_T *argvars UNUSED;
17443 typval_T *rettv;
17445 #ifdef FEAT_WINDOWS
17446 win_T *wp;
17447 int winnr = 1;
17448 garray_T ga;
17449 char_u buf[50];
17451 ga_init2(&ga, (int)sizeof(char), 70);
17452 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17454 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17455 ga_concat(&ga, buf);
17456 # ifdef FEAT_VERTSPLIT
17457 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17458 ga_concat(&ga, buf);
17459 # endif
17460 ++winnr;
17462 ga_append(&ga, NUL);
17464 rettv->vval.v_string = ga.ga_data;
17465 #else
17466 rettv->vval.v_string = NULL;
17467 #endif
17468 rettv->v_type = VAR_STRING;
17472 * "winrestview()" function
17474 static void
17475 f_winrestview(argvars, rettv)
17476 typval_T *argvars;
17477 typval_T *rettv UNUSED;
17479 dict_T *dict;
17481 if (argvars[0].v_type != VAR_DICT
17482 || (dict = argvars[0].vval.v_dict) == NULL)
17483 EMSG(_(e_invarg));
17484 else
17486 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17487 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17488 #ifdef FEAT_VIRTUALEDIT
17489 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17490 #endif
17491 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17492 curwin->w_set_curswant = FALSE;
17494 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17495 #ifdef FEAT_DIFF
17496 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17497 #endif
17498 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17499 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17501 check_cursor();
17502 changed_cline_bef_curs();
17503 invalidate_botline();
17504 redraw_later(VALID);
17506 if (curwin->w_topline == 0)
17507 curwin->w_topline = 1;
17508 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17509 curwin->w_topline = curbuf->b_ml.ml_line_count;
17510 #ifdef FEAT_DIFF
17511 check_topfill(curwin, TRUE);
17512 #endif
17517 * "winsaveview()" function
17519 static void
17520 f_winsaveview(argvars, rettv)
17521 typval_T *argvars UNUSED;
17522 typval_T *rettv;
17524 dict_T *dict;
17526 dict = dict_alloc();
17527 if (dict == NULL)
17528 return;
17529 rettv->v_type = VAR_DICT;
17530 rettv->vval.v_dict = dict;
17531 ++dict->dv_refcount;
17533 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17534 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17535 #ifdef FEAT_VIRTUALEDIT
17536 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17537 #endif
17538 update_curswant();
17539 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17541 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17542 #ifdef FEAT_DIFF
17543 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17544 #endif
17545 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17546 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17550 * "winwidth(nr)" function
17552 static void
17553 f_winwidth(argvars, rettv)
17554 typval_T *argvars;
17555 typval_T *rettv;
17557 win_T *wp;
17559 wp = find_win_by_nr(&argvars[0], NULL);
17560 if (wp == NULL)
17561 rettv->vval.v_number = -1;
17562 else
17563 #ifdef FEAT_VERTSPLIT
17564 rettv->vval.v_number = wp->w_width;
17565 #else
17566 rettv->vval.v_number = Columns;
17567 #endif
17571 * "writefile()" function
17573 static void
17574 f_writefile(argvars, rettv)
17575 typval_T *argvars;
17576 typval_T *rettv;
17578 int binary = FALSE;
17579 char_u *fname;
17580 FILE *fd;
17581 listitem_T *li;
17582 char_u *s;
17583 int ret = 0;
17584 int c;
17586 if (check_restricted() || check_secure())
17587 return;
17589 if (argvars[0].v_type != VAR_LIST)
17591 EMSG2(_(e_listarg), "writefile()");
17592 return;
17594 if (argvars[0].vval.v_list == NULL)
17595 return;
17597 if (argvars[2].v_type != VAR_UNKNOWN
17598 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17599 binary = TRUE;
17601 /* Always open the file in binary mode, library functions have a mind of
17602 * their own about CR-LF conversion. */
17603 fname = get_tv_string(&argvars[1]);
17604 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17606 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17607 ret = -1;
17609 else
17611 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17612 li = li->li_next)
17614 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17616 if (*s == '\n')
17617 c = putc(NUL, fd);
17618 else
17619 c = putc(*s, fd);
17620 if (c == EOF)
17622 ret = -1;
17623 break;
17626 if (!binary || li->li_next != NULL)
17627 if (putc('\n', fd) == EOF)
17629 ret = -1;
17630 break;
17632 if (ret < 0)
17634 EMSG(_(e_write));
17635 break;
17638 fclose(fd);
17641 rettv->vval.v_number = ret;
17645 * Translate a String variable into a position.
17646 * Returns NULL when there is an error.
17648 static pos_T *
17649 var2fpos(varp, dollar_lnum, fnum)
17650 typval_T *varp;
17651 int dollar_lnum; /* TRUE when $ is last line */
17652 int *fnum; /* set to fnum for '0, 'A, etc. */
17654 char_u *name;
17655 static pos_T pos;
17656 pos_T *pp;
17658 /* Argument can be [lnum, col, coladd]. */
17659 if (varp->v_type == VAR_LIST)
17661 list_T *l;
17662 int len;
17663 int error = FALSE;
17664 listitem_T *li;
17666 l = varp->vval.v_list;
17667 if (l == NULL)
17668 return NULL;
17670 /* Get the line number */
17671 pos.lnum = list_find_nr(l, 0L, &error);
17672 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17673 return NULL; /* invalid line number */
17675 /* Get the column number */
17676 pos.col = list_find_nr(l, 1L, &error);
17677 if (error)
17678 return NULL;
17679 len = (long)STRLEN(ml_get(pos.lnum));
17681 /* We accept "$" for the column number: last column. */
17682 li = list_find(l, 1L);
17683 if (li != NULL && li->li_tv.v_type == VAR_STRING
17684 && li->li_tv.vval.v_string != NULL
17685 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17686 pos.col = len + 1;
17688 /* Accept a position up to the NUL after the line. */
17689 if (pos.col == 0 || (int)pos.col > len + 1)
17690 return NULL; /* invalid column number */
17691 --pos.col;
17693 #ifdef FEAT_VIRTUALEDIT
17694 /* Get the virtual offset. Defaults to zero. */
17695 pos.coladd = list_find_nr(l, 2L, &error);
17696 if (error)
17697 pos.coladd = 0;
17698 #endif
17700 return &pos;
17703 name = get_tv_string_chk(varp);
17704 if (name == NULL)
17705 return NULL;
17706 if (name[0] == '.') /* cursor */
17707 return &curwin->w_cursor;
17708 #ifdef FEAT_VISUAL
17709 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17711 if (VIsual_active)
17712 return &VIsual;
17713 return &curwin->w_cursor;
17715 #endif
17716 if (name[0] == '\'') /* mark */
17718 pp = getmark_fnum(name[1], FALSE, fnum);
17719 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17720 return NULL;
17721 return pp;
17724 #ifdef FEAT_VIRTUALEDIT
17725 pos.coladd = 0;
17726 #endif
17728 if (name[0] == 'w' && dollar_lnum)
17730 pos.col = 0;
17731 if (name[1] == '0') /* "w0": first visible line */
17733 update_topline();
17734 pos.lnum = curwin->w_topline;
17735 return &pos;
17737 else if (name[1] == '$') /* "w$": last visible line */
17739 validate_botline();
17740 pos.lnum = curwin->w_botline - 1;
17741 return &pos;
17744 else if (name[0] == '$') /* last column or line */
17746 if (dollar_lnum)
17748 pos.lnum = curbuf->b_ml.ml_line_count;
17749 pos.col = 0;
17751 else
17753 pos.lnum = curwin->w_cursor.lnum;
17754 pos.col = (colnr_T)STRLEN(ml_get_curline());
17756 return &pos;
17758 return NULL;
17762 * Convert list in "arg" into a position and optional file number.
17763 * When "fnump" is NULL there is no file number, only 3 items.
17764 * Note that the column is passed on as-is, the caller may want to decrement
17765 * it to use 1 for the first column.
17766 * Return FAIL when conversion is not possible, doesn't check the position for
17767 * validity.
17769 static int
17770 list2fpos(arg, posp, fnump)
17771 typval_T *arg;
17772 pos_T *posp;
17773 int *fnump;
17775 list_T *l = arg->vval.v_list;
17776 long i = 0;
17777 long n;
17779 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17780 * when "fnump" isn't NULL and "coladd" is optional. */
17781 if (arg->v_type != VAR_LIST
17782 || l == NULL
17783 || l->lv_len < (fnump == NULL ? 2 : 3)
17784 || l->lv_len > (fnump == NULL ? 3 : 4))
17785 return FAIL;
17787 if (fnump != NULL)
17789 n = list_find_nr(l, i++, NULL); /* fnum */
17790 if (n < 0)
17791 return FAIL;
17792 if (n == 0)
17793 n = curbuf->b_fnum; /* current buffer */
17794 *fnump = n;
17797 n = list_find_nr(l, i++, NULL); /* lnum */
17798 if (n < 0)
17799 return FAIL;
17800 posp->lnum = n;
17802 n = list_find_nr(l, i++, NULL); /* col */
17803 if (n < 0)
17804 return FAIL;
17805 posp->col = n;
17807 #ifdef FEAT_VIRTUALEDIT
17808 n = list_find_nr(l, i, NULL);
17809 if (n < 0)
17810 posp->coladd = 0;
17811 else
17812 posp->coladd = n;
17813 #endif
17815 return OK;
17819 * Get the length of an environment variable name.
17820 * Advance "arg" to the first character after the name.
17821 * Return 0 for error.
17823 static int
17824 get_env_len(arg)
17825 char_u **arg;
17827 char_u *p;
17828 int len;
17830 for (p = *arg; vim_isIDc(*p); ++p)
17832 if (p == *arg) /* no name found */
17833 return 0;
17835 len = (int)(p - *arg);
17836 *arg = p;
17837 return len;
17841 * Get the length of the name of a function or internal variable.
17842 * "arg" is advanced to the first non-white character after the name.
17843 * Return 0 if something is wrong.
17845 static int
17846 get_id_len(arg)
17847 char_u **arg;
17849 char_u *p;
17850 int len;
17852 /* Find the end of the name. */
17853 for (p = *arg; eval_isnamec(*p); ++p)
17855 if (p == *arg) /* no name found */
17856 return 0;
17858 len = (int)(p - *arg);
17859 *arg = skipwhite(p);
17861 return len;
17865 * Get the length of the name of a variable or function.
17866 * Only the name is recognized, does not handle ".key" or "[idx]".
17867 * "arg" is advanced to the first non-white character after the name.
17868 * Return -1 if curly braces expansion failed.
17869 * Return 0 if something else is wrong.
17870 * If the name contains 'magic' {}'s, expand them and return the
17871 * expanded name in an allocated string via 'alias' - caller must free.
17873 static int
17874 get_name_len(arg, alias, evaluate, verbose)
17875 char_u **arg;
17876 char_u **alias;
17877 int evaluate;
17878 int verbose;
17880 int len;
17881 char_u *p;
17882 char_u *expr_start;
17883 char_u *expr_end;
17885 *alias = NULL; /* default to no alias */
17887 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17888 && (*arg)[2] == (int)KE_SNR)
17890 /* hard coded <SNR>, already translated */
17891 *arg += 3;
17892 return get_id_len(arg) + 3;
17894 len = eval_fname_script(*arg);
17895 if (len > 0)
17897 /* literal "<SID>", "s:" or "<SNR>" */
17898 *arg += len;
17902 * Find the end of the name; check for {} construction.
17904 p = find_name_end(*arg, &expr_start, &expr_end,
17905 len > 0 ? 0 : FNE_CHECK_START);
17906 if (expr_start != NULL)
17908 char_u *temp_string;
17910 if (!evaluate)
17912 len += (int)(p - *arg);
17913 *arg = skipwhite(p);
17914 return len;
17918 * Include any <SID> etc in the expanded string:
17919 * Thus the -len here.
17921 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17922 if (temp_string == NULL)
17923 return -1;
17924 *alias = temp_string;
17925 *arg = skipwhite(p);
17926 return (int)STRLEN(temp_string);
17929 len += get_id_len(arg);
17930 if (len == 0 && verbose)
17931 EMSG2(_(e_invexpr2), *arg);
17933 return len;
17937 * Find the end of a variable or function name, taking care of magic braces.
17938 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17939 * start and end of the first magic braces item.
17940 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17941 * Return a pointer to just after the name. Equal to "arg" if there is no
17942 * valid name.
17944 static char_u *
17945 find_name_end(arg, expr_start, expr_end, flags)
17946 char_u *arg;
17947 char_u **expr_start;
17948 char_u **expr_end;
17949 int flags;
17951 int mb_nest = 0;
17952 int br_nest = 0;
17953 char_u *p;
17955 if (expr_start != NULL)
17957 *expr_start = NULL;
17958 *expr_end = NULL;
17961 /* Quick check for valid starting character. */
17962 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17963 return arg;
17965 for (p = arg; *p != NUL
17966 && (eval_isnamec(*p)
17967 || *p == '{'
17968 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17969 || mb_nest != 0
17970 || br_nest != 0); mb_ptr_adv(p))
17972 if (*p == '\'')
17974 /* skip over 'string' to avoid counting [ and ] inside it. */
17975 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17977 if (*p == NUL)
17978 break;
17980 else if (*p == '"')
17982 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17983 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17984 if (*p == '\\' && p[1] != NUL)
17985 ++p;
17986 if (*p == NUL)
17987 break;
17990 if (mb_nest == 0)
17992 if (*p == '[')
17993 ++br_nest;
17994 else if (*p == ']')
17995 --br_nest;
17998 if (br_nest == 0)
18000 if (*p == '{')
18002 mb_nest++;
18003 if (expr_start != NULL && *expr_start == NULL)
18004 *expr_start = p;
18006 else if (*p == '}')
18008 mb_nest--;
18009 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18010 *expr_end = p;
18015 return p;
18019 * Expands out the 'magic' {}'s in a variable/function name.
18020 * Note that this can call itself recursively, to deal with
18021 * constructs like foo{bar}{baz}{bam}
18022 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18023 * "in_start" ^
18024 * "expr_start" ^
18025 * "expr_end" ^
18026 * "in_end" ^
18028 * Returns a new allocated string, which the caller must free.
18029 * Returns NULL for failure.
18031 static char_u *
18032 make_expanded_name(in_start, expr_start, expr_end, in_end)
18033 char_u *in_start;
18034 char_u *expr_start;
18035 char_u *expr_end;
18036 char_u *in_end;
18038 char_u c1;
18039 char_u *retval = NULL;
18040 char_u *temp_result;
18041 char_u *nextcmd = NULL;
18043 if (expr_end == NULL || in_end == NULL)
18044 return NULL;
18045 *expr_start = NUL;
18046 *expr_end = NUL;
18047 c1 = *in_end;
18048 *in_end = NUL;
18050 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18051 if (temp_result != NULL && nextcmd == NULL)
18053 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18054 + (in_end - expr_end) + 1));
18055 if (retval != NULL)
18057 STRCPY(retval, in_start);
18058 STRCAT(retval, temp_result);
18059 STRCAT(retval, expr_end + 1);
18062 vim_free(temp_result);
18064 *in_end = c1; /* put char back for error messages */
18065 *expr_start = '{';
18066 *expr_end = '}';
18068 if (retval != NULL)
18070 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18071 if (expr_start != NULL)
18073 /* Further expansion! */
18074 temp_result = make_expanded_name(retval, expr_start,
18075 expr_end, temp_result);
18076 vim_free(retval);
18077 retval = temp_result;
18081 return retval;
18085 * Return TRUE if character "c" can be used in a variable or function name.
18086 * Does not include '{' or '}' for magic braces.
18088 static int
18089 eval_isnamec(c)
18090 int c;
18092 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18096 * Return TRUE if character "c" can be used as the first character in a
18097 * variable or function name (excluding '{' and '}').
18099 static int
18100 eval_isnamec1(c)
18101 int c;
18103 return (ASCII_ISALPHA(c) || c == '_');
18107 * Set number v: variable to "val".
18109 void
18110 set_vim_var_nr(idx, val)
18111 int idx;
18112 long val;
18114 vimvars[idx].vv_nr = val;
18118 * Get number v: variable value.
18120 long
18121 get_vim_var_nr(idx)
18122 int idx;
18124 return vimvars[idx].vv_nr;
18128 * Get string v: variable value. Uses a static buffer, can only be used once.
18130 char_u *
18131 get_vim_var_str(idx)
18132 int idx;
18134 return get_tv_string(&vimvars[idx].vv_tv);
18138 * Get List v: variable value. Caller must take care of reference count when
18139 * needed.
18141 list_T *
18142 get_vim_var_list(idx)
18143 int idx;
18145 return vimvars[idx].vv_list;
18149 * Set v:char to character "c".
18151 void
18152 set_vim_var_char(c)
18153 int c;
18155 #ifdef FEAT_MBYTE
18156 char_u buf[MB_MAXBYTES];
18157 #else
18158 char_u buf[2];
18159 #endif
18161 #ifdef FEAT_MBYTE
18162 if (has_mbyte)
18163 buf[(*mb_char2bytes)(c, buf)] = NUL;
18164 else
18165 #endif
18167 buf[0] = c;
18168 buf[1] = NUL;
18170 set_vim_var_string(VV_CHAR, buf, -1);
18174 * Set v:count to "count" and v:count1 to "count1".
18175 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18177 void
18178 set_vcount(count, count1, set_prevcount)
18179 long count;
18180 long count1;
18181 int set_prevcount;
18183 if (set_prevcount)
18184 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18185 vimvars[VV_COUNT].vv_nr = count;
18186 vimvars[VV_COUNT1].vv_nr = count1;
18190 * Set string v: variable to a copy of "val".
18192 void
18193 set_vim_var_string(idx, val, len)
18194 int idx;
18195 char_u *val;
18196 int len; /* length of "val" to use or -1 (whole string) */
18198 /* Need to do this (at least) once, since we can't initialize a union.
18199 * Will always be invoked when "v:progname" is set. */
18200 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18202 vim_free(vimvars[idx].vv_str);
18203 if (val == NULL)
18204 vimvars[idx].vv_str = NULL;
18205 else if (len == -1)
18206 vimvars[idx].vv_str = vim_strsave(val);
18207 else
18208 vimvars[idx].vv_str = vim_strnsave(val, len);
18212 * Set List v: variable to "val".
18214 void
18215 set_vim_var_list(idx, val)
18216 int idx;
18217 list_T *val;
18219 list_unref(vimvars[idx].vv_list);
18220 vimvars[idx].vv_list = val;
18221 if (val != NULL)
18222 ++val->lv_refcount;
18226 * Set v:register if needed.
18228 void
18229 set_reg_var(c)
18230 int c;
18232 char_u regname;
18234 if (c == 0 || c == ' ')
18235 regname = '"';
18236 else
18237 regname = c;
18238 /* Avoid free/alloc when the value is already right. */
18239 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18240 set_vim_var_string(VV_REG, &regname, 1);
18244 * Get or set v:exception. If "oldval" == NULL, return the current value.
18245 * Otherwise, restore the value to "oldval" and return NULL.
18246 * Must always be called in pairs to save and restore v:exception! Does not
18247 * take care of memory allocations.
18249 char_u *
18250 v_exception(oldval)
18251 char_u *oldval;
18253 if (oldval == NULL)
18254 return vimvars[VV_EXCEPTION].vv_str;
18256 vimvars[VV_EXCEPTION].vv_str = oldval;
18257 return NULL;
18261 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18262 * Otherwise, restore the value to "oldval" and return NULL.
18263 * Must always be called in pairs to save and restore v:throwpoint! Does not
18264 * take care of memory allocations.
18266 char_u *
18267 v_throwpoint(oldval)
18268 char_u *oldval;
18270 if (oldval == NULL)
18271 return vimvars[VV_THROWPOINT].vv_str;
18273 vimvars[VV_THROWPOINT].vv_str = oldval;
18274 return NULL;
18277 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18279 * Set v:cmdarg.
18280 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18281 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18282 * Must always be called in pairs!
18284 char_u *
18285 set_cmdarg(eap, oldarg)
18286 exarg_T *eap;
18287 char_u *oldarg;
18289 char_u *oldval;
18290 char_u *newval;
18291 unsigned len;
18293 oldval = vimvars[VV_CMDARG].vv_str;
18294 if (eap == NULL)
18296 vim_free(oldval);
18297 vimvars[VV_CMDARG].vv_str = oldarg;
18298 return NULL;
18301 if (eap->force_bin == FORCE_BIN)
18302 len = 6;
18303 else if (eap->force_bin == FORCE_NOBIN)
18304 len = 8;
18305 else
18306 len = 0;
18308 if (eap->read_edit)
18309 len += 7;
18311 if (eap->force_ff != 0)
18312 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18313 # ifdef FEAT_MBYTE
18314 if (eap->force_enc != 0)
18315 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18316 if (eap->bad_char != 0)
18317 len += 7 + 4; /* " ++bad=" + "keep" or "drop" */
18318 # endif
18320 newval = alloc(len + 1);
18321 if (newval == NULL)
18322 return NULL;
18324 if (eap->force_bin == FORCE_BIN)
18325 sprintf((char *)newval, " ++bin");
18326 else if (eap->force_bin == FORCE_NOBIN)
18327 sprintf((char *)newval, " ++nobin");
18328 else
18329 *newval = NUL;
18331 if (eap->read_edit)
18332 STRCAT(newval, " ++edit");
18334 if (eap->force_ff != 0)
18335 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18336 eap->cmd + eap->force_ff);
18337 # ifdef FEAT_MBYTE
18338 if (eap->force_enc != 0)
18339 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18340 eap->cmd + eap->force_enc);
18341 if (eap->bad_char == BAD_KEEP)
18342 STRCPY(newval + STRLEN(newval), " ++bad=keep");
18343 else if (eap->bad_char == BAD_DROP)
18344 STRCPY(newval + STRLEN(newval), " ++bad=drop");
18345 else if (eap->bad_char != 0)
18346 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
18347 # endif
18348 vimvars[VV_CMDARG].vv_str = newval;
18349 return oldval;
18351 #endif
18354 * Get the value of internal variable "name".
18355 * Return OK or FAIL.
18357 static int
18358 get_var_tv(name, len, rettv, verbose)
18359 char_u *name;
18360 int len; /* length of "name" */
18361 typval_T *rettv; /* NULL when only checking existence */
18362 int verbose; /* may give error message */
18364 int ret = OK;
18365 typval_T *tv = NULL;
18366 typval_T atv;
18367 dictitem_T *v;
18368 int cc;
18370 /* truncate the name, so that we can use strcmp() */
18371 cc = name[len];
18372 name[len] = NUL;
18375 * Check for "b:changedtick".
18377 if (STRCMP(name, "b:changedtick") == 0)
18379 atv.v_type = VAR_NUMBER;
18380 atv.vval.v_number = curbuf->b_changedtick;
18381 tv = &atv;
18385 * Check for user-defined variables.
18387 else
18389 v = find_var(name, NULL);
18390 if (v != NULL)
18391 tv = &v->di_tv;
18394 if (tv == NULL)
18396 if (rettv != NULL && verbose)
18397 EMSG2(_(e_undefvar), name);
18398 ret = FAIL;
18400 else if (rettv != NULL)
18401 copy_tv(tv, rettv);
18403 name[len] = cc;
18405 return ret;
18409 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18410 * Also handle function call with Funcref variable: func(expr)
18411 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18413 static int
18414 handle_subscript(arg, rettv, evaluate, verbose)
18415 char_u **arg;
18416 typval_T *rettv;
18417 int evaluate; /* do more than finding the end */
18418 int verbose; /* give error messages */
18420 int ret = OK;
18421 dict_T *selfdict = NULL;
18422 char_u *s;
18423 int len;
18424 typval_T functv;
18426 while (ret == OK
18427 && (**arg == '['
18428 || (**arg == '.' && rettv->v_type == VAR_DICT)
18429 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18430 && !vim_iswhite(*(*arg - 1)))
18432 if (**arg == '(')
18434 /* need to copy the funcref so that we can clear rettv */
18435 functv = *rettv;
18436 rettv->v_type = VAR_UNKNOWN;
18438 /* Invoke the function. Recursive! */
18439 s = functv.vval.v_string;
18440 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18441 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18442 &len, evaluate, selfdict);
18444 /* Clear the funcref afterwards, so that deleting it while
18445 * evaluating the arguments is possible (see test55). */
18446 clear_tv(&functv);
18448 /* Stop the expression evaluation when immediately aborting on
18449 * error, or when an interrupt occurred or an exception was thrown
18450 * but not caught. */
18451 if (aborting())
18453 if (ret == OK)
18454 clear_tv(rettv);
18455 ret = FAIL;
18457 dict_unref(selfdict);
18458 selfdict = NULL;
18460 else /* **arg == '[' || **arg == '.' */
18462 dict_unref(selfdict);
18463 if (rettv->v_type == VAR_DICT)
18465 selfdict = rettv->vval.v_dict;
18466 if (selfdict != NULL)
18467 ++selfdict->dv_refcount;
18469 else
18470 selfdict = NULL;
18471 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18473 clear_tv(rettv);
18474 ret = FAIL;
18478 dict_unref(selfdict);
18479 return ret;
18483 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18484 * value).
18486 static typval_T *
18487 alloc_tv()
18489 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18493 * Allocate memory for a variable type-value, and assign a string to it.
18494 * The string "s" must have been allocated, it is consumed.
18495 * Return NULL for out of memory, the variable otherwise.
18497 static typval_T *
18498 alloc_string_tv(s)
18499 char_u *s;
18501 typval_T *rettv;
18503 rettv = alloc_tv();
18504 if (rettv != NULL)
18506 rettv->v_type = VAR_STRING;
18507 rettv->vval.v_string = s;
18509 else
18510 vim_free(s);
18511 return rettv;
18515 * Free the memory for a variable type-value.
18517 void
18518 free_tv(varp)
18519 typval_T *varp;
18521 if (varp != NULL)
18523 switch (varp->v_type)
18525 case VAR_FUNC:
18526 func_unref(varp->vval.v_string);
18527 /*FALLTHROUGH*/
18528 case VAR_STRING:
18529 vim_free(varp->vval.v_string);
18530 break;
18531 case VAR_LIST:
18532 list_unref(varp->vval.v_list);
18533 break;
18534 case VAR_DICT:
18535 dict_unref(varp->vval.v_dict);
18536 break;
18537 case VAR_NUMBER:
18538 #ifdef FEAT_FLOAT
18539 case VAR_FLOAT:
18540 #endif
18541 case VAR_UNKNOWN:
18542 break;
18543 default:
18544 EMSG2(_(e_intern2), "free_tv()");
18545 break;
18547 vim_free(varp);
18552 * Free the memory for a variable value and set the value to NULL or 0.
18554 void
18555 clear_tv(varp)
18556 typval_T *varp;
18558 if (varp != NULL)
18560 switch (varp->v_type)
18562 case VAR_FUNC:
18563 func_unref(varp->vval.v_string);
18564 /*FALLTHROUGH*/
18565 case VAR_STRING:
18566 vim_free(varp->vval.v_string);
18567 varp->vval.v_string = NULL;
18568 break;
18569 case VAR_LIST:
18570 list_unref(varp->vval.v_list);
18571 varp->vval.v_list = NULL;
18572 break;
18573 case VAR_DICT:
18574 dict_unref(varp->vval.v_dict);
18575 varp->vval.v_dict = NULL;
18576 break;
18577 case VAR_NUMBER:
18578 varp->vval.v_number = 0;
18579 break;
18580 #ifdef FEAT_FLOAT
18581 case VAR_FLOAT:
18582 varp->vval.v_float = 0.0;
18583 break;
18584 #endif
18585 case VAR_UNKNOWN:
18586 break;
18587 default:
18588 EMSG2(_(e_intern2), "clear_tv()");
18590 varp->v_lock = 0;
18595 * Set the value of a variable to NULL without freeing items.
18597 static void
18598 init_tv(varp)
18599 typval_T *varp;
18601 if (varp != NULL)
18602 vim_memset(varp, 0, sizeof(typval_T));
18606 * Get the number value of a variable.
18607 * If it is a String variable, uses vim_str2nr().
18608 * For incompatible types, return 0.
18609 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18610 * caller of incompatible types: it sets *denote to TRUE if "denote"
18611 * is not NULL or returns -1 otherwise.
18613 static long
18614 get_tv_number(varp)
18615 typval_T *varp;
18617 int error = FALSE;
18619 return get_tv_number_chk(varp, &error); /* return 0L on error */
18622 long
18623 get_tv_number_chk(varp, denote)
18624 typval_T *varp;
18625 int *denote;
18627 long n = 0L;
18629 switch (varp->v_type)
18631 case VAR_NUMBER:
18632 return (long)(varp->vval.v_number);
18633 #ifdef FEAT_FLOAT
18634 case VAR_FLOAT:
18635 EMSG(_("E805: Using a Float as a Number"));
18636 break;
18637 #endif
18638 case VAR_FUNC:
18639 EMSG(_("E703: Using a Funcref as a Number"));
18640 break;
18641 case VAR_STRING:
18642 if (varp->vval.v_string != NULL)
18643 vim_str2nr(varp->vval.v_string, NULL, NULL,
18644 TRUE, TRUE, &n, NULL);
18645 return n;
18646 case VAR_LIST:
18647 EMSG(_("E745: Using a List as a Number"));
18648 break;
18649 case VAR_DICT:
18650 EMSG(_("E728: Using a Dictionary as a Number"));
18651 break;
18652 default:
18653 EMSG2(_(e_intern2), "get_tv_number()");
18654 break;
18656 if (denote == NULL) /* useful for values that must be unsigned */
18657 n = -1;
18658 else
18659 *denote = TRUE;
18660 return n;
18664 * Get the lnum from the first argument.
18665 * Also accepts ".", "$", etc., but that only works for the current buffer.
18666 * Returns -1 on error.
18668 static linenr_T
18669 get_tv_lnum(argvars)
18670 typval_T *argvars;
18672 typval_T rettv;
18673 linenr_T lnum;
18675 lnum = get_tv_number_chk(&argvars[0], NULL);
18676 if (lnum == 0) /* no valid number, try using line() */
18678 rettv.v_type = VAR_NUMBER;
18679 f_line(argvars, &rettv);
18680 lnum = rettv.vval.v_number;
18681 clear_tv(&rettv);
18683 return lnum;
18687 * Get the lnum from the first argument.
18688 * Also accepts "$", then "buf" is used.
18689 * Returns 0 on error.
18691 static linenr_T
18692 get_tv_lnum_buf(argvars, buf)
18693 typval_T *argvars;
18694 buf_T *buf;
18696 if (argvars[0].v_type == VAR_STRING
18697 && argvars[0].vval.v_string != NULL
18698 && argvars[0].vval.v_string[0] == '$'
18699 && buf != NULL)
18700 return buf->b_ml.ml_line_count;
18701 return get_tv_number_chk(&argvars[0], NULL);
18705 * Get the string value of a variable.
18706 * If it is a Number variable, the number is converted into a string.
18707 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18708 * get_tv_string_buf() uses a given buffer.
18709 * If the String variable has never been set, return an empty string.
18710 * Never returns NULL;
18711 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18712 * NULL on error.
18714 static char_u *
18715 get_tv_string(varp)
18716 typval_T *varp;
18718 static char_u mybuf[NUMBUFLEN];
18720 return get_tv_string_buf(varp, mybuf);
18723 static char_u *
18724 get_tv_string_buf(varp, buf)
18725 typval_T *varp;
18726 char_u *buf;
18728 char_u *res = get_tv_string_buf_chk(varp, buf);
18730 return res != NULL ? res : (char_u *)"";
18733 char_u *
18734 get_tv_string_chk(varp)
18735 typval_T *varp;
18737 static char_u mybuf[NUMBUFLEN];
18739 return get_tv_string_buf_chk(varp, mybuf);
18742 static char_u *
18743 get_tv_string_buf_chk(varp, buf)
18744 typval_T *varp;
18745 char_u *buf;
18747 switch (varp->v_type)
18749 case VAR_NUMBER:
18750 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18751 return buf;
18752 case VAR_FUNC:
18753 EMSG(_("E729: using Funcref as a String"));
18754 break;
18755 case VAR_LIST:
18756 EMSG(_("E730: using List as a String"));
18757 break;
18758 case VAR_DICT:
18759 EMSG(_("E731: using Dictionary as a String"));
18760 break;
18761 #ifdef FEAT_FLOAT
18762 case VAR_FLOAT:
18763 EMSG(_("E806: using Float as a String"));
18764 break;
18765 #endif
18766 case VAR_STRING:
18767 if (varp->vval.v_string != NULL)
18768 return varp->vval.v_string;
18769 return (char_u *)"";
18770 default:
18771 EMSG2(_(e_intern2), "get_tv_string_buf()");
18772 break;
18774 return NULL;
18778 * Find variable "name" in the list of variables.
18779 * Return a pointer to it if found, NULL if not found.
18780 * Careful: "a:0" variables don't have a name.
18781 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18782 * hashtab_T used.
18784 static dictitem_T *
18785 find_var(name, htp)
18786 char_u *name;
18787 hashtab_T **htp;
18789 char_u *varname;
18790 hashtab_T *ht;
18792 ht = find_var_ht(name, &varname);
18793 if (htp != NULL)
18794 *htp = ht;
18795 if (ht == NULL)
18796 return NULL;
18797 return find_var_in_ht(ht, varname, htp != NULL);
18801 * Find variable "varname" in hashtab "ht".
18802 * Returns NULL if not found.
18804 static dictitem_T *
18805 find_var_in_ht(ht, varname, writing)
18806 hashtab_T *ht;
18807 char_u *varname;
18808 int writing;
18810 hashitem_T *hi;
18812 if (*varname == NUL)
18814 /* Must be something like "s:", otherwise "ht" would be NULL. */
18815 switch (varname[-2])
18817 case 's': return &SCRIPT_SV(current_SID)->sv_var;
18818 case 'g': return &globvars_var;
18819 case 'v': return &vimvars_var;
18820 case 'b': return &curbuf->b_bufvar;
18821 case 'w': return &curwin->w_winvar;
18822 #ifdef FEAT_WINDOWS
18823 case 't': return &curtab->tp_winvar;
18824 #endif
18825 case 'l': return current_funccal == NULL
18826 ? NULL : &current_funccal->l_vars_var;
18827 case 'a': return current_funccal == NULL
18828 ? NULL : &current_funccal->l_avars_var;
18830 return NULL;
18833 hi = hash_find(ht, varname);
18834 if (HASHITEM_EMPTY(hi))
18836 /* For global variables we may try auto-loading the script. If it
18837 * worked find the variable again. Don't auto-load a script if it was
18838 * loaded already, otherwise it would be loaded every time when
18839 * checking if a function name is a Funcref variable. */
18840 if (ht == &globvarht && !writing
18841 && script_autoload(varname, FALSE) && !aborting())
18842 hi = hash_find(ht, varname);
18843 if (HASHITEM_EMPTY(hi))
18844 return NULL;
18846 return HI2DI(hi);
18850 * Find the hashtab used for a variable name.
18851 * Set "varname" to the start of name without ':'.
18853 static hashtab_T *
18854 find_var_ht(name, varname)
18855 char_u *name;
18856 char_u **varname;
18858 hashitem_T *hi;
18860 if (name[1] != ':')
18862 /* The name must not start with a colon or #. */
18863 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18864 return NULL;
18865 *varname = name;
18867 /* "version" is "v:version" in all scopes */
18868 hi = hash_find(&compat_hashtab, name);
18869 if (!HASHITEM_EMPTY(hi))
18870 return &compat_hashtab;
18872 if (current_funccal == NULL)
18873 return &globvarht; /* global variable */
18874 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18876 *varname = name + 2;
18877 if (*name == 'g') /* global variable */
18878 return &globvarht;
18879 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18881 if (vim_strchr(name + 2, ':') != NULL
18882 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18883 return NULL;
18884 if (*name == 'b') /* buffer variable */
18885 return &curbuf->b_vars.dv_hashtab;
18886 if (*name == 'w') /* window variable */
18887 return &curwin->w_vars.dv_hashtab;
18888 #ifdef FEAT_WINDOWS
18889 if (*name == 't') /* tab page variable */
18890 return &curtab->tp_vars.dv_hashtab;
18891 #endif
18892 if (*name == 'v') /* v: variable */
18893 return &vimvarht;
18894 if (*name == 'a' && current_funccal != NULL) /* function argument */
18895 return &current_funccal->l_avars.dv_hashtab;
18896 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18897 return &current_funccal->l_vars.dv_hashtab;
18898 if (*name == 's' /* script variable */
18899 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18900 return &SCRIPT_VARS(current_SID);
18901 return NULL;
18905 * Get the string value of a (global/local) variable.
18906 * Returns NULL when it doesn't exist.
18908 char_u *
18909 get_var_value(name)
18910 char_u *name;
18912 dictitem_T *v;
18914 v = find_var(name, NULL);
18915 if (v == NULL)
18916 return NULL;
18917 return get_tv_string(&v->di_tv);
18921 * Allocate a new hashtab for a sourced script. It will be used while
18922 * sourcing this script and when executing functions defined in the script.
18924 void
18925 new_script_vars(id)
18926 scid_T id;
18928 int i;
18929 hashtab_T *ht;
18930 scriptvar_T *sv;
18932 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18934 /* Re-allocating ga_data means that an ht_array pointing to
18935 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18936 * at its init value. Also reset "v_dict", it's always the same. */
18937 for (i = 1; i <= ga_scripts.ga_len; ++i)
18939 ht = &SCRIPT_VARS(i);
18940 if (ht->ht_mask == HT_INIT_SIZE - 1)
18941 ht->ht_array = ht->ht_smallarray;
18942 sv = SCRIPT_SV(i);
18943 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18946 while (ga_scripts.ga_len < id)
18948 sv = SCRIPT_SV(ga_scripts.ga_len + 1) =
18949 (scriptvar_T *)alloc_clear(sizeof(scriptvar_T));
18950 init_var_dict(&sv->sv_dict, &sv->sv_var);
18951 ++ga_scripts.ga_len;
18957 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18958 * point to it.
18960 void
18961 init_var_dict(dict, dict_var)
18962 dict_T *dict;
18963 dictitem_T *dict_var;
18965 hash_init(&dict->dv_hashtab);
18966 dict->dv_refcount = DO_NOT_FREE_CNT;
18967 dict->dv_copyID = 0;
18968 dict_var->di_tv.vval.v_dict = dict;
18969 dict_var->di_tv.v_type = VAR_DICT;
18970 dict_var->di_tv.v_lock = VAR_FIXED;
18971 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18972 dict_var->di_key[0] = NUL;
18976 * Clean up a list of internal variables.
18977 * Frees all allocated variables and the value they contain.
18978 * Clears hashtab "ht", does not free it.
18980 void
18981 vars_clear(ht)
18982 hashtab_T *ht;
18984 vars_clear_ext(ht, TRUE);
18988 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18990 static void
18991 vars_clear_ext(ht, free_val)
18992 hashtab_T *ht;
18993 int free_val;
18995 int todo;
18996 hashitem_T *hi;
18997 dictitem_T *v;
18999 hash_lock(ht);
19000 todo = (int)ht->ht_used;
19001 for (hi = ht->ht_array; todo > 0; ++hi)
19003 if (!HASHITEM_EMPTY(hi))
19005 --todo;
19007 /* Free the variable. Don't remove it from the hashtab,
19008 * ht_array might change then. hash_clear() takes care of it
19009 * later. */
19010 v = HI2DI(hi);
19011 if (free_val)
19012 clear_tv(&v->di_tv);
19013 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19014 vim_free(v);
19017 hash_clear(ht);
19018 ht->ht_used = 0;
19022 * Delete a variable from hashtab "ht" at item "hi".
19023 * Clear the variable value and free the dictitem.
19025 static void
19026 delete_var(ht, hi)
19027 hashtab_T *ht;
19028 hashitem_T *hi;
19030 dictitem_T *di = HI2DI(hi);
19032 hash_remove(ht, hi);
19033 clear_tv(&di->di_tv);
19034 vim_free(di);
19038 * List the value of one internal variable.
19040 static void
19041 list_one_var(v, prefix, first)
19042 dictitem_T *v;
19043 char_u *prefix;
19044 int *first;
19046 char_u *tofree;
19047 char_u *s;
19048 char_u numbuf[NUMBUFLEN];
19050 current_copyID += COPYID_INC;
19051 s = echo_string(&v->di_tv, &tofree, numbuf, current_copyID);
19052 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19053 s == NULL ? (char_u *)"" : s, first);
19054 vim_free(tofree);
19057 static void
19058 list_one_var_a(prefix, name, type, string, first)
19059 char_u *prefix;
19060 char_u *name;
19061 int type;
19062 char_u *string;
19063 int *first; /* when TRUE clear rest of screen and set to FALSE */
19065 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19066 msg_start();
19067 msg_puts(prefix);
19068 if (name != NULL) /* "a:" vars don't have a name stored */
19069 msg_puts(name);
19070 msg_putchar(' ');
19071 msg_advance(22);
19072 if (type == VAR_NUMBER)
19073 msg_putchar('#');
19074 else if (type == VAR_FUNC)
19075 msg_putchar('*');
19076 else if (type == VAR_LIST)
19078 msg_putchar('[');
19079 if (*string == '[')
19080 ++string;
19082 else if (type == VAR_DICT)
19084 msg_putchar('{');
19085 if (*string == '{')
19086 ++string;
19088 else
19089 msg_putchar(' ');
19091 msg_outtrans(string);
19093 if (type == VAR_FUNC)
19094 msg_puts((char_u *)"()");
19095 if (*first)
19097 msg_clr_eos();
19098 *first = FALSE;
19103 * Set variable "name" to value in "tv".
19104 * If the variable already exists, the value is updated.
19105 * Otherwise the variable is created.
19107 static void
19108 set_var(name, tv, copy)
19109 char_u *name;
19110 typval_T *tv;
19111 int copy; /* make copy of value in "tv" */
19113 dictitem_T *v;
19114 char_u *varname;
19115 hashtab_T *ht;
19116 char_u *p;
19118 ht = find_var_ht(name, &varname);
19119 if (ht == NULL || *varname == NUL)
19121 EMSG2(_(e_illvar), name);
19122 return;
19124 v = find_var_in_ht(ht, varname, TRUE);
19126 if (tv->v_type == VAR_FUNC)
19128 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19129 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19130 ? name[2] : name[0]))
19132 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19133 return;
19135 /* Don't allow hiding a function. When "v" is not NULL we migth be
19136 * assigning another function to the same var, the type is checked
19137 * below. */
19138 if (v == NULL && function_exists(name))
19140 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19141 name);
19142 return;
19146 if (v != NULL)
19148 /* existing variable, need to clear the value */
19149 if (var_check_ro(v->di_flags, name)
19150 || tv_check_lock(v->di_tv.v_lock, name))
19151 return;
19152 if (v->di_tv.v_type != tv->v_type
19153 && !((v->di_tv.v_type == VAR_STRING
19154 || v->di_tv.v_type == VAR_NUMBER)
19155 && (tv->v_type == VAR_STRING
19156 || tv->v_type == VAR_NUMBER))
19157 #ifdef FEAT_FLOAT
19158 && !((v->di_tv.v_type == VAR_NUMBER
19159 || v->di_tv.v_type == VAR_FLOAT)
19160 && (tv->v_type == VAR_NUMBER
19161 || tv->v_type == VAR_FLOAT))
19162 #endif
19165 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19166 return;
19170 * Handle setting internal v: variables separately: we don't change
19171 * the type.
19173 if (ht == &vimvarht)
19175 if (v->di_tv.v_type == VAR_STRING)
19177 vim_free(v->di_tv.vval.v_string);
19178 if (copy || tv->v_type != VAR_STRING)
19179 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19180 else
19182 /* Take over the string to avoid an extra alloc/free. */
19183 v->di_tv.vval.v_string = tv->vval.v_string;
19184 tv->vval.v_string = NULL;
19187 else if (v->di_tv.v_type != VAR_NUMBER)
19188 EMSG2(_(e_intern2), "set_var()");
19189 else
19191 v->di_tv.vval.v_number = get_tv_number(tv);
19192 if (STRCMP(varname, "searchforward") == 0)
19193 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19195 return;
19198 clear_tv(&v->di_tv);
19200 else /* add a new variable */
19202 /* Can't add "v:" variable. */
19203 if (ht == &vimvarht)
19205 EMSG2(_(e_illvar), name);
19206 return;
19209 /* Make sure the variable name is valid. */
19210 for (p = varname; *p != NUL; ++p)
19211 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19212 && *p != AUTOLOAD_CHAR)
19214 EMSG2(_(e_illvar), varname);
19215 return;
19218 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19219 + STRLEN(varname)));
19220 if (v == NULL)
19221 return;
19222 STRCPY(v->di_key, varname);
19223 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19225 vim_free(v);
19226 return;
19228 v->di_flags = 0;
19231 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19232 copy_tv(tv, &v->di_tv);
19233 else
19235 v->di_tv = *tv;
19236 v->di_tv.v_lock = 0;
19237 init_tv(tv);
19242 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19243 * Also give an error message.
19245 static int
19246 var_check_ro(flags, name)
19247 int flags;
19248 char_u *name;
19250 if (flags & DI_FLAGS_RO)
19252 EMSG2(_(e_readonlyvar), name);
19253 return TRUE;
19255 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19257 EMSG2(_(e_readonlysbx), name);
19258 return TRUE;
19260 return FALSE;
19264 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19265 * Also give an error message.
19267 static int
19268 var_check_fixed(flags, name)
19269 int flags;
19270 char_u *name;
19272 if (flags & DI_FLAGS_FIX)
19274 EMSG2(_("E795: Cannot delete variable %s"), name);
19275 return TRUE;
19277 return FALSE;
19281 * Return TRUE if typeval "tv" is set to be locked (immutable).
19282 * Also give an error message, using "name".
19284 static int
19285 tv_check_lock(lock, name)
19286 int lock;
19287 char_u *name;
19289 if (lock & VAR_LOCKED)
19291 EMSG2(_("E741: Value is locked: %s"),
19292 name == NULL ? (char_u *)_("Unknown") : name);
19293 return TRUE;
19295 if (lock & VAR_FIXED)
19297 EMSG2(_("E742: Cannot change value of %s"),
19298 name == NULL ? (char_u *)_("Unknown") : name);
19299 return TRUE;
19301 return FALSE;
19305 * Copy the values from typval_T "from" to typval_T "to".
19306 * When needed allocates string or increases reference count.
19307 * Does not make a copy of a list or dict but copies the reference!
19308 * It is OK for "from" and "to" to point to the same item. This is used to
19309 * make a copy later.
19311 void
19312 copy_tv(from, to)
19313 typval_T *from;
19314 typval_T *to;
19316 to->v_type = from->v_type;
19317 to->v_lock = 0;
19318 switch (from->v_type)
19320 case VAR_NUMBER:
19321 to->vval.v_number = from->vval.v_number;
19322 break;
19323 #ifdef FEAT_FLOAT
19324 case VAR_FLOAT:
19325 to->vval.v_float = from->vval.v_float;
19326 break;
19327 #endif
19328 case VAR_STRING:
19329 case VAR_FUNC:
19330 if (from->vval.v_string == NULL)
19331 to->vval.v_string = NULL;
19332 else
19334 to->vval.v_string = vim_strsave(from->vval.v_string);
19335 if (from->v_type == VAR_FUNC)
19336 func_ref(to->vval.v_string);
19338 break;
19339 case VAR_LIST:
19340 if (from->vval.v_list == NULL)
19341 to->vval.v_list = NULL;
19342 else
19344 to->vval.v_list = from->vval.v_list;
19345 ++to->vval.v_list->lv_refcount;
19347 break;
19348 case VAR_DICT:
19349 if (from->vval.v_dict == NULL)
19350 to->vval.v_dict = NULL;
19351 else
19353 to->vval.v_dict = from->vval.v_dict;
19354 ++to->vval.v_dict->dv_refcount;
19356 break;
19357 default:
19358 EMSG2(_(e_intern2), "copy_tv()");
19359 break;
19364 * Make a copy of an item.
19365 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19366 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19367 * reference to an already copied list/dict can be used.
19368 * Returns FAIL or OK.
19370 static int
19371 item_copy(from, to, deep, copyID)
19372 typval_T *from;
19373 typval_T *to;
19374 int deep;
19375 int copyID;
19377 static int recurse = 0;
19378 int ret = OK;
19380 if (recurse >= DICT_MAXNEST)
19382 EMSG(_("E698: variable nested too deep for making a copy"));
19383 return FAIL;
19385 ++recurse;
19387 switch (from->v_type)
19389 case VAR_NUMBER:
19390 #ifdef FEAT_FLOAT
19391 case VAR_FLOAT:
19392 #endif
19393 case VAR_STRING:
19394 case VAR_FUNC:
19395 copy_tv(from, to);
19396 break;
19397 case VAR_LIST:
19398 to->v_type = VAR_LIST;
19399 to->v_lock = 0;
19400 if (from->vval.v_list == NULL)
19401 to->vval.v_list = NULL;
19402 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19404 /* use the copy made earlier */
19405 to->vval.v_list = from->vval.v_list->lv_copylist;
19406 ++to->vval.v_list->lv_refcount;
19408 else
19409 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19410 if (to->vval.v_list == NULL)
19411 ret = FAIL;
19412 break;
19413 case VAR_DICT:
19414 to->v_type = VAR_DICT;
19415 to->v_lock = 0;
19416 if (from->vval.v_dict == NULL)
19417 to->vval.v_dict = NULL;
19418 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19420 /* use the copy made earlier */
19421 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19422 ++to->vval.v_dict->dv_refcount;
19424 else
19425 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19426 if (to->vval.v_dict == NULL)
19427 ret = FAIL;
19428 break;
19429 default:
19430 EMSG2(_(e_intern2), "item_copy()");
19431 ret = FAIL;
19433 --recurse;
19434 return ret;
19438 * ":echo expr1 ..." print each argument separated with a space, add a
19439 * newline at the end.
19440 * ":echon expr1 ..." print each argument plain.
19442 void
19443 ex_echo(eap)
19444 exarg_T *eap;
19446 char_u *arg = eap->arg;
19447 typval_T rettv;
19448 char_u *tofree;
19449 char_u *p;
19450 int needclr = TRUE;
19451 int atstart = TRUE;
19452 char_u numbuf[NUMBUFLEN];
19454 if (eap->skip)
19455 ++emsg_skip;
19456 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19458 /* If eval1() causes an error message the text from the command may
19459 * still need to be cleared. E.g., "echo 22,44". */
19460 need_clr_eos = needclr;
19462 p = arg;
19463 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19466 * Report the invalid expression unless the expression evaluation
19467 * has been cancelled due to an aborting error, an interrupt, or an
19468 * exception.
19470 if (!aborting())
19471 EMSG2(_(e_invexpr2), p);
19472 need_clr_eos = FALSE;
19473 break;
19475 need_clr_eos = FALSE;
19477 if (!eap->skip)
19479 if (atstart)
19481 atstart = FALSE;
19482 /* Call msg_start() after eval1(), evaluating the expression
19483 * may cause a message to appear. */
19484 if (eap->cmdidx == CMD_echo)
19485 msg_start();
19487 else if (eap->cmdidx == CMD_echo)
19488 msg_puts_attr((char_u *)" ", echo_attr);
19489 current_copyID += COPYID_INC;
19490 p = echo_string(&rettv, &tofree, numbuf, current_copyID);
19491 if (p != NULL)
19492 for ( ; *p != NUL && !got_int; ++p)
19494 if (*p == '\n' || *p == '\r' || *p == TAB)
19496 if (*p != TAB && needclr)
19498 /* remove any text still there from the command */
19499 msg_clr_eos();
19500 needclr = FALSE;
19502 msg_putchar_attr(*p, echo_attr);
19504 else
19506 #ifdef FEAT_MBYTE
19507 if (has_mbyte)
19509 int i = (*mb_ptr2len)(p);
19511 (void)msg_outtrans_len_attr(p, i, echo_attr);
19512 p += i - 1;
19514 else
19515 #endif
19516 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19519 vim_free(tofree);
19521 clear_tv(&rettv);
19522 arg = skipwhite(arg);
19524 eap->nextcmd = check_nextcmd(arg);
19526 if (eap->skip)
19527 --emsg_skip;
19528 else
19530 /* remove text that may still be there from the command */
19531 if (needclr)
19532 msg_clr_eos();
19533 if (eap->cmdidx == CMD_echo)
19534 msg_end();
19539 * ":echohl {name}".
19541 void
19542 ex_echohl(eap)
19543 exarg_T *eap;
19545 int id;
19547 id = syn_name2id(eap->arg);
19548 if (id == 0)
19549 echo_attr = 0;
19550 else
19551 echo_attr = syn_id2attr(id);
19555 * ":execute expr1 ..." execute the result of an expression.
19556 * ":echomsg expr1 ..." Print a message
19557 * ":echoerr expr1 ..." Print an error
19558 * Each gets spaces around each argument and a newline at the end for
19559 * echo commands
19561 void
19562 ex_execute(eap)
19563 exarg_T *eap;
19565 char_u *arg = eap->arg;
19566 typval_T rettv;
19567 int ret = OK;
19568 char_u *p;
19569 garray_T ga;
19570 int len;
19571 int save_did_emsg;
19573 ga_init2(&ga, 1, 80);
19575 if (eap->skip)
19576 ++emsg_skip;
19577 while (*arg != NUL && *arg != '|' && *arg != '\n')
19579 p = arg;
19580 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19583 * Report the invalid expression unless the expression evaluation
19584 * has been cancelled due to an aborting error, an interrupt, or an
19585 * exception.
19587 if (!aborting())
19588 EMSG2(_(e_invexpr2), p);
19589 ret = FAIL;
19590 break;
19593 if (!eap->skip)
19595 p = get_tv_string(&rettv);
19596 len = (int)STRLEN(p);
19597 if (ga_grow(&ga, len + 2) == FAIL)
19599 clear_tv(&rettv);
19600 ret = FAIL;
19601 break;
19603 if (ga.ga_len)
19604 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19605 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19606 ga.ga_len += len;
19609 clear_tv(&rettv);
19610 arg = skipwhite(arg);
19613 if (ret != FAIL && ga.ga_data != NULL)
19615 if (eap->cmdidx == CMD_echomsg)
19617 MSG_ATTR(ga.ga_data, echo_attr);
19618 out_flush();
19620 else if (eap->cmdidx == CMD_echoerr)
19622 /* We don't want to abort following commands, restore did_emsg. */
19623 save_did_emsg = did_emsg;
19624 EMSG((char_u *)ga.ga_data);
19625 if (!force_abort)
19626 did_emsg = save_did_emsg;
19628 else if (eap->cmdidx == CMD_execute)
19629 do_cmdline((char_u *)ga.ga_data,
19630 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19633 ga_clear(&ga);
19635 if (eap->skip)
19636 --emsg_skip;
19638 eap->nextcmd = check_nextcmd(arg);
19642 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19643 * "arg" points to the "&" or '+' when called, to "option" when returning.
19644 * Returns NULL when no option name found. Otherwise pointer to the char
19645 * after the option name.
19647 static char_u *
19648 find_option_end(arg, opt_flags)
19649 char_u **arg;
19650 int *opt_flags;
19652 char_u *p = *arg;
19654 ++p;
19655 if (*p == 'g' && p[1] == ':')
19657 *opt_flags = OPT_GLOBAL;
19658 p += 2;
19660 else if (*p == 'l' && p[1] == ':')
19662 *opt_flags = OPT_LOCAL;
19663 p += 2;
19665 else
19666 *opt_flags = 0;
19668 if (!ASCII_ISALPHA(*p))
19669 return NULL;
19670 *arg = p;
19672 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19673 p += 4; /* termcap option */
19674 else
19675 while (ASCII_ISALPHA(*p))
19676 ++p;
19677 return p;
19681 * ":function"
19683 void
19684 ex_function(eap)
19685 exarg_T *eap;
19687 char_u *theline;
19688 int j;
19689 int c;
19690 int saved_did_emsg;
19691 char_u *name = NULL;
19692 char_u *p;
19693 char_u *arg;
19694 char_u *line_arg = NULL;
19695 garray_T newargs;
19696 garray_T newlines;
19697 int varargs = FALSE;
19698 int mustend = FALSE;
19699 int flags = 0;
19700 ufunc_T *fp;
19701 int indent;
19702 int nesting;
19703 char_u *skip_until = NULL;
19704 dictitem_T *v;
19705 funcdict_T fudi;
19706 static int func_nr = 0; /* number for nameless function */
19707 int paren;
19708 hashtab_T *ht;
19709 int todo;
19710 hashitem_T *hi;
19711 int sourcing_lnum_off;
19714 * ":function" without argument: list functions.
19716 if (ends_excmd(*eap->arg))
19718 if (!eap->skip)
19720 todo = (int)func_hashtab.ht_used;
19721 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19723 if (!HASHITEM_EMPTY(hi))
19725 --todo;
19726 fp = HI2UF(hi);
19727 if (!isdigit(*fp->uf_name))
19728 list_func_head(fp, FALSE);
19732 eap->nextcmd = check_nextcmd(eap->arg);
19733 return;
19737 * ":function /pat": list functions matching pattern.
19739 if (*eap->arg == '/')
19741 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19742 if (!eap->skip)
19744 regmatch_T regmatch;
19746 c = *p;
19747 *p = NUL;
19748 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19749 *p = c;
19750 if (regmatch.regprog != NULL)
19752 regmatch.rm_ic = p_ic;
19754 todo = (int)func_hashtab.ht_used;
19755 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19757 if (!HASHITEM_EMPTY(hi))
19759 --todo;
19760 fp = HI2UF(hi);
19761 if (!isdigit(*fp->uf_name)
19762 && vim_regexec(&regmatch, fp->uf_name, 0))
19763 list_func_head(fp, FALSE);
19766 vim_free(regmatch.regprog);
19769 if (*p == '/')
19770 ++p;
19771 eap->nextcmd = check_nextcmd(p);
19772 return;
19776 * Get the function name. There are these situations:
19777 * func normal function name
19778 * "name" == func, "fudi.fd_dict" == NULL
19779 * dict.func new dictionary entry
19780 * "name" == NULL, "fudi.fd_dict" set,
19781 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19782 * dict.func existing dict entry with a Funcref
19783 * "name" == func, "fudi.fd_dict" set,
19784 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19785 * dict.func existing dict entry that's not a Funcref
19786 * "name" == NULL, "fudi.fd_dict" set,
19787 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19789 p = eap->arg;
19790 name = trans_function_name(&p, eap->skip, 0, &fudi);
19791 paren = (vim_strchr(p, '(') != NULL);
19792 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19795 * Return on an invalid expression in braces, unless the expression
19796 * evaluation has been cancelled due to an aborting error, an
19797 * interrupt, or an exception.
19799 if (!aborting())
19801 if (!eap->skip && fudi.fd_newkey != NULL)
19802 EMSG2(_(e_dictkey), fudi.fd_newkey);
19803 vim_free(fudi.fd_newkey);
19804 return;
19806 else
19807 eap->skip = TRUE;
19810 /* An error in a function call during evaluation of an expression in magic
19811 * braces should not cause the function not to be defined. */
19812 saved_did_emsg = did_emsg;
19813 did_emsg = FALSE;
19816 * ":function func" with only function name: list function.
19818 if (!paren)
19820 if (!ends_excmd(*skipwhite(p)))
19822 EMSG(_(e_trailing));
19823 goto ret_free;
19825 eap->nextcmd = check_nextcmd(p);
19826 if (eap->nextcmd != NULL)
19827 *p = NUL;
19828 if (!eap->skip && !got_int)
19830 fp = find_func(name);
19831 if (fp != NULL)
19833 list_func_head(fp, TRUE);
19834 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19836 if (FUNCLINE(fp, j) == NULL)
19837 continue;
19838 msg_putchar('\n');
19839 msg_outnum((long)(j + 1));
19840 if (j < 9)
19841 msg_putchar(' ');
19842 if (j < 99)
19843 msg_putchar(' ');
19844 msg_prt_line(FUNCLINE(fp, j), FALSE);
19845 out_flush(); /* show a line at a time */
19846 ui_breakcheck();
19848 if (!got_int)
19850 msg_putchar('\n');
19851 msg_puts((char_u *)" endfunction");
19854 else
19855 emsg_funcname(N_("E123: Undefined function: %s"), name);
19857 goto ret_free;
19861 * ":function name(arg1, arg2)" Define function.
19863 p = skipwhite(p);
19864 if (*p != '(')
19866 if (!eap->skip)
19868 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19869 goto ret_free;
19871 /* attempt to continue by skipping some text */
19872 if (vim_strchr(p, '(') != NULL)
19873 p = vim_strchr(p, '(');
19875 p = skipwhite(p + 1);
19877 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19878 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19880 if (!eap->skip)
19882 /* Check the name of the function. Unless it's a dictionary function
19883 * (that we are overwriting). */
19884 if (name != NULL)
19885 arg = name;
19886 else
19887 arg = fudi.fd_newkey;
19888 if (arg != NULL && (fudi.fd_di == NULL
19889 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19891 if (*arg == K_SPECIAL)
19892 j = 3;
19893 else
19894 j = 0;
19895 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19896 : eval_isnamec(arg[j])))
19897 ++j;
19898 if (arg[j] != NUL)
19899 emsg_funcname((char *)e_invarg2, arg);
19904 * Isolate the arguments: "arg1, arg2, ...)"
19906 while (*p != ')')
19908 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19910 varargs = TRUE;
19911 p += 3;
19912 mustend = TRUE;
19914 else
19916 arg = p;
19917 while (ASCII_ISALNUM(*p) || *p == '_')
19918 ++p;
19919 if (arg == p || isdigit(*arg)
19920 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19921 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19923 if (!eap->skip)
19924 EMSG2(_("E125: Illegal argument: %s"), arg);
19925 break;
19927 if (ga_grow(&newargs, 1) == FAIL)
19928 goto erret;
19929 c = *p;
19930 *p = NUL;
19931 arg = vim_strsave(arg);
19932 if (arg == NULL)
19933 goto erret;
19934 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19935 *p = c;
19936 newargs.ga_len++;
19937 if (*p == ',')
19938 ++p;
19939 else
19940 mustend = TRUE;
19942 p = skipwhite(p);
19943 if (mustend && *p != ')')
19945 if (!eap->skip)
19946 EMSG2(_(e_invarg2), eap->arg);
19947 break;
19950 ++p; /* skip the ')' */
19952 /* find extra arguments "range", "dict" and "abort" */
19953 for (;;)
19955 p = skipwhite(p);
19956 if (STRNCMP(p, "range", 5) == 0)
19958 flags |= FC_RANGE;
19959 p += 5;
19961 else if (STRNCMP(p, "dict", 4) == 0)
19963 flags |= FC_DICT;
19964 p += 4;
19966 else if (STRNCMP(p, "abort", 5) == 0)
19968 flags |= FC_ABORT;
19969 p += 5;
19971 else
19972 break;
19975 /* When there is a line break use what follows for the function body.
19976 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19977 if (*p == '\n')
19978 line_arg = p + 1;
19979 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19980 EMSG(_(e_trailing));
19983 * Read the body of the function, until ":endfunction" is found.
19985 if (KeyTyped)
19987 /* Check if the function already exists, don't let the user type the
19988 * whole function before telling him it doesn't work! For a script we
19989 * need to skip the body to be able to find what follows. */
19990 if (!eap->skip && !eap->forceit)
19992 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19993 EMSG(_(e_funcdict));
19994 else if (name != NULL && find_func(name) != NULL)
19995 emsg_funcname(e_funcexts, name);
19998 if (!eap->skip && did_emsg)
19999 goto erret;
20001 msg_putchar('\n'); /* don't overwrite the function name */
20002 cmdline_row = msg_row;
20005 indent = 2;
20006 nesting = 0;
20007 for (;;)
20009 msg_scroll = TRUE;
20010 need_wait_return = FALSE;
20011 sourcing_lnum_off = sourcing_lnum;
20013 if (line_arg != NULL)
20015 /* Use eap->arg, split up in parts by line breaks. */
20016 theline = line_arg;
20017 p = vim_strchr(theline, '\n');
20018 if (p == NULL)
20019 line_arg += STRLEN(line_arg);
20020 else
20022 *p = NUL;
20023 line_arg = p + 1;
20026 else if (eap->getline == NULL)
20027 theline = getcmdline(':', 0L, indent);
20028 else
20029 theline = eap->getline(':', eap->cookie, indent);
20030 if (KeyTyped)
20031 lines_left = Rows - 1;
20032 if (theline == NULL)
20034 EMSG(_("E126: Missing :endfunction"));
20035 goto erret;
20038 /* Detect line continuation: sourcing_lnum increased more than one. */
20039 if (sourcing_lnum > sourcing_lnum_off + 1)
20040 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20041 else
20042 sourcing_lnum_off = 0;
20044 if (skip_until != NULL)
20046 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20047 * don't check for ":endfunc". */
20048 if (STRCMP(theline, skip_until) == 0)
20050 vim_free(skip_until);
20051 skip_until = NULL;
20054 else
20056 /* skip ':' and blanks*/
20057 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20060 /* Check for "endfunction". */
20061 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20063 if (line_arg == NULL)
20064 vim_free(theline);
20065 break;
20068 /* Increase indent inside "if", "while", "for" and "try", decrease
20069 * at "end". */
20070 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20071 indent -= 2;
20072 else if (STRNCMP(p, "if", 2) == 0
20073 || STRNCMP(p, "wh", 2) == 0
20074 || STRNCMP(p, "for", 3) == 0
20075 || STRNCMP(p, "try", 3) == 0)
20076 indent += 2;
20078 /* Check for defining a function inside this function. */
20079 if (checkforcmd(&p, "function", 2))
20081 if (*p == '!')
20082 p = skipwhite(p + 1);
20083 p += eval_fname_script(p);
20084 if (ASCII_ISALPHA(*p))
20086 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20087 if (*skipwhite(p) == '(')
20089 ++nesting;
20090 indent += 2;
20095 /* Check for ":append" or ":insert". */
20096 p = skip_range(p, NULL);
20097 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20098 || (p[0] == 'i'
20099 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20100 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20101 skip_until = vim_strsave((char_u *)".");
20103 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20104 arg = skipwhite(skiptowhite(p));
20105 if (arg[0] == '<' && arg[1] =='<'
20106 && ((p[0] == 'p' && p[1] == 'y'
20107 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20108 || (p[0] == 'p' && p[1] == 'e'
20109 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20110 || (p[0] == 't' && p[1] == 'c'
20111 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20112 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20113 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20114 || (p[0] == 'm' && p[1] == 'z'
20115 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20118 /* ":python <<" continues until a dot, like ":append" */
20119 p = skipwhite(arg + 2);
20120 if (*p == NUL)
20121 skip_until = vim_strsave((char_u *)".");
20122 else
20123 skip_until = vim_strsave(p);
20127 /* Add the line to the function. */
20128 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20130 if (line_arg == NULL)
20131 vim_free(theline);
20132 goto erret;
20135 /* Copy the line to newly allocated memory. get_one_sourceline()
20136 * allocates 250 bytes per line, this saves 80% on average. The cost
20137 * is an extra alloc/free. */
20138 p = vim_strsave(theline);
20139 if (p != NULL)
20141 if (line_arg == NULL)
20142 vim_free(theline);
20143 theline = p;
20146 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20148 /* Add NULL lines for continuation lines, so that the line count is
20149 * equal to the index in the growarray. */
20150 while (sourcing_lnum_off-- > 0)
20151 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20153 /* Check for end of eap->arg. */
20154 if (line_arg != NULL && *line_arg == NUL)
20155 line_arg = NULL;
20158 /* Don't define the function when skipping commands or when an error was
20159 * detected. */
20160 if (eap->skip || did_emsg)
20161 goto erret;
20164 * If there are no errors, add the function
20166 if (fudi.fd_dict == NULL)
20168 v = find_var(name, &ht);
20169 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20171 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
20172 name);
20173 goto erret;
20176 fp = find_func(name);
20177 if (fp != NULL)
20179 if (!eap->forceit)
20181 emsg_funcname(e_funcexts, name);
20182 goto erret;
20184 if (fp->uf_calls > 0)
20186 emsg_funcname(N_("E127: Cannot redefine function %s: It is in use"),
20187 name);
20188 goto erret;
20190 /* redefine existing function */
20191 ga_clear_strings(&(fp->uf_args));
20192 ga_clear_strings(&(fp->uf_lines));
20193 vim_free(name);
20194 name = NULL;
20197 else
20199 char numbuf[20];
20201 fp = NULL;
20202 if (fudi.fd_newkey == NULL && !eap->forceit)
20204 EMSG(_(e_funcdict));
20205 goto erret;
20207 if (fudi.fd_di == NULL)
20209 /* Can't add a function to a locked dictionary */
20210 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20211 goto erret;
20213 /* Can't change an existing function if it is locked */
20214 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20215 goto erret;
20217 /* Give the function a sequential number. Can only be used with a
20218 * Funcref! */
20219 vim_free(name);
20220 sprintf(numbuf, "%d", ++func_nr);
20221 name = vim_strsave((char_u *)numbuf);
20222 if (name == NULL)
20223 goto erret;
20226 if (fp == NULL)
20228 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20230 int slen, plen;
20231 char_u *scriptname;
20233 /* Check that the autoload name matches the script name. */
20234 j = FAIL;
20235 if (sourcing_name != NULL)
20237 scriptname = autoload_name(name);
20238 if (scriptname != NULL)
20240 p = vim_strchr(scriptname, '/');
20241 plen = (int)STRLEN(p);
20242 slen = (int)STRLEN(sourcing_name);
20243 if (slen > plen && fnamecmp(p,
20244 sourcing_name + slen - plen) == 0)
20245 j = OK;
20246 vim_free(scriptname);
20249 if (j == FAIL)
20251 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20252 goto erret;
20256 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20257 if (fp == NULL)
20258 goto erret;
20260 if (fudi.fd_dict != NULL)
20262 if (fudi.fd_di == NULL)
20264 /* add new dict entry */
20265 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20266 if (fudi.fd_di == NULL)
20268 vim_free(fp);
20269 goto erret;
20271 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20273 vim_free(fudi.fd_di);
20274 vim_free(fp);
20275 goto erret;
20278 else
20279 /* overwrite existing dict entry */
20280 clear_tv(&fudi.fd_di->di_tv);
20281 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20282 fudi.fd_di->di_tv.v_lock = 0;
20283 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20284 fp->uf_refcount = 1;
20286 /* behave like "dict" was used */
20287 flags |= FC_DICT;
20290 /* insert the new function in the function list */
20291 STRCPY(fp->uf_name, name);
20292 hash_add(&func_hashtab, UF2HIKEY(fp));
20294 fp->uf_args = newargs;
20295 fp->uf_lines = newlines;
20296 #ifdef FEAT_PROFILE
20297 fp->uf_tml_count = NULL;
20298 fp->uf_tml_total = NULL;
20299 fp->uf_tml_self = NULL;
20300 fp->uf_profiling = FALSE;
20301 if (prof_def_func())
20302 func_do_profile(fp);
20303 #endif
20304 fp->uf_varargs = varargs;
20305 fp->uf_flags = flags;
20306 fp->uf_calls = 0;
20307 fp->uf_script_ID = current_SID;
20308 goto ret_free;
20310 erret:
20311 ga_clear_strings(&newargs);
20312 ga_clear_strings(&newlines);
20313 ret_free:
20314 vim_free(skip_until);
20315 vim_free(fudi.fd_newkey);
20316 vim_free(name);
20317 did_emsg |= saved_did_emsg;
20321 * Get a function name, translating "<SID>" and "<SNR>".
20322 * Also handles a Funcref in a List or Dictionary.
20323 * Returns the function name in allocated memory, or NULL for failure.
20324 * flags:
20325 * TFN_INT: internal function name OK
20326 * TFN_QUIET: be quiet
20327 * Advances "pp" to just after the function name (if no error).
20329 static char_u *
20330 trans_function_name(pp, skip, flags, fdp)
20331 char_u **pp;
20332 int skip; /* only find the end, don't evaluate */
20333 int flags;
20334 funcdict_T *fdp; /* return: info about dictionary used */
20336 char_u *name = NULL;
20337 char_u *start;
20338 char_u *end;
20339 int lead;
20340 char_u sid_buf[20];
20341 int len;
20342 lval_T lv;
20344 if (fdp != NULL)
20345 vim_memset(fdp, 0, sizeof(funcdict_T));
20346 start = *pp;
20348 /* Check for hard coded <SNR>: already translated function ID (from a user
20349 * command). */
20350 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20351 && (*pp)[2] == (int)KE_SNR)
20353 *pp += 3;
20354 len = get_id_len(pp) + 3;
20355 return vim_strnsave(start, len);
20358 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20359 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20360 lead = eval_fname_script(start);
20361 if (lead > 2)
20362 start += lead;
20364 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20365 lead > 2 ? 0 : FNE_CHECK_START);
20366 if (end == start)
20368 if (!skip)
20369 EMSG(_("E129: Function name required"));
20370 goto theend;
20372 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20375 * Report an invalid expression in braces, unless the expression
20376 * evaluation has been cancelled due to an aborting error, an
20377 * interrupt, or an exception.
20379 if (!aborting())
20381 if (end != NULL)
20382 EMSG2(_(e_invarg2), start);
20384 else
20385 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20386 goto theend;
20389 if (lv.ll_tv != NULL)
20391 if (fdp != NULL)
20393 fdp->fd_dict = lv.ll_dict;
20394 fdp->fd_newkey = lv.ll_newkey;
20395 lv.ll_newkey = NULL;
20396 fdp->fd_di = lv.ll_di;
20398 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20400 name = vim_strsave(lv.ll_tv->vval.v_string);
20401 *pp = end;
20403 else
20405 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20406 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20407 EMSG(_(e_funcref));
20408 else
20409 *pp = end;
20410 name = NULL;
20412 goto theend;
20415 if (lv.ll_name == NULL)
20417 /* Error found, but continue after the function name. */
20418 *pp = end;
20419 goto theend;
20422 /* Check if the name is a Funcref. If so, use the value. */
20423 if (lv.ll_exp_name != NULL)
20425 len = (int)STRLEN(lv.ll_exp_name);
20426 name = deref_func_name(lv.ll_exp_name, &len);
20427 if (name == lv.ll_exp_name)
20428 name = NULL;
20430 else
20432 len = (int)(end - *pp);
20433 name = deref_func_name(*pp, &len);
20434 if (name == *pp)
20435 name = NULL;
20437 if (name != NULL)
20439 name = vim_strsave(name);
20440 *pp = end;
20441 goto theend;
20444 if (lv.ll_exp_name != NULL)
20446 len = (int)STRLEN(lv.ll_exp_name);
20447 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20448 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20450 /* When there was "s:" already or the name expanded to get a
20451 * leading "s:" then remove it. */
20452 lv.ll_name += 2;
20453 len -= 2;
20454 lead = 2;
20457 else
20459 if (lead == 2) /* skip over "s:" */
20460 lv.ll_name += 2;
20461 len = (int)(end - lv.ll_name);
20465 * Copy the function name to allocated memory.
20466 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20467 * Accept <SNR>123_name() outside a script.
20469 if (skip)
20470 lead = 0; /* do nothing */
20471 else if (lead > 0)
20473 lead = 3;
20474 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20475 || eval_fname_sid(*pp))
20477 /* It's "s:" or "<SID>" */
20478 if (current_SID <= 0)
20480 EMSG(_(e_usingsid));
20481 goto theend;
20483 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20484 lead += (int)STRLEN(sid_buf);
20487 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20489 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20490 goto theend;
20492 name = alloc((unsigned)(len + lead + 1));
20493 if (name != NULL)
20495 if (lead > 0)
20497 name[0] = K_SPECIAL;
20498 name[1] = KS_EXTRA;
20499 name[2] = (int)KE_SNR;
20500 if (lead > 3) /* If it's "<SID>" */
20501 STRCPY(name + 3, sid_buf);
20503 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20504 name[len + lead] = NUL;
20506 *pp = end;
20508 theend:
20509 clear_lval(&lv);
20510 return name;
20514 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20515 * Return 2 if "p" starts with "s:".
20516 * Return 0 otherwise.
20518 static int
20519 eval_fname_script(p)
20520 char_u *p;
20522 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20523 || STRNICMP(p + 1, "SNR>", 4) == 0))
20524 return 5;
20525 if (p[0] == 's' && p[1] == ':')
20526 return 2;
20527 return 0;
20531 * Return TRUE if "p" starts with "<SID>" or "s:".
20532 * Only works if eval_fname_script() returned non-zero for "p"!
20534 static int
20535 eval_fname_sid(p)
20536 char_u *p;
20538 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20542 * List the head of the function: "name(arg1, arg2)".
20544 static void
20545 list_func_head(fp, indent)
20546 ufunc_T *fp;
20547 int indent;
20549 int j;
20551 msg_start();
20552 if (indent)
20553 MSG_PUTS(" ");
20554 MSG_PUTS("function ");
20555 if (fp->uf_name[0] == K_SPECIAL)
20557 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20558 msg_puts(fp->uf_name + 3);
20560 else
20561 msg_puts(fp->uf_name);
20562 msg_putchar('(');
20563 for (j = 0; j < fp->uf_args.ga_len; ++j)
20565 if (j)
20566 MSG_PUTS(", ");
20567 msg_puts(FUNCARG(fp, j));
20569 if (fp->uf_varargs)
20571 if (j)
20572 MSG_PUTS(", ");
20573 MSG_PUTS("...");
20575 msg_putchar(')');
20576 msg_clr_eos();
20577 if (p_verbose > 0)
20578 last_set_msg(fp->uf_script_ID);
20582 * Find a function by name, return pointer to it in ufuncs.
20583 * Return NULL for unknown function.
20585 static ufunc_T *
20586 find_func(name)
20587 char_u *name;
20589 hashitem_T *hi;
20591 hi = hash_find(&func_hashtab, name);
20592 if (!HASHITEM_EMPTY(hi))
20593 return HI2UF(hi);
20594 return NULL;
20597 #if defined(EXITFREE) || defined(PROTO)
20598 void
20599 free_all_functions()
20601 hashitem_T *hi;
20603 /* Need to start all over every time, because func_free() may change the
20604 * hash table. */
20605 while (func_hashtab.ht_used > 0)
20606 for (hi = func_hashtab.ht_array; ; ++hi)
20607 if (!HASHITEM_EMPTY(hi))
20609 func_free(HI2UF(hi));
20610 break;
20613 #endif
20616 * Return TRUE if a function "name" exists.
20618 static int
20619 function_exists(name)
20620 char_u *name;
20622 char_u *nm = name;
20623 char_u *p;
20624 int n = FALSE;
20626 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20627 nm = skipwhite(nm);
20629 /* Only accept "funcname", "funcname ", "funcname (..." and
20630 * "funcname(...", not "funcname!...". */
20631 if (p != NULL && (*nm == NUL || *nm == '('))
20633 if (builtin_function(p))
20634 n = (find_internal_func(p) >= 0);
20635 else
20636 n = (find_func(p) != NULL);
20638 vim_free(p);
20639 return n;
20643 * Return TRUE if "name" looks like a builtin function name: starts with a
20644 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20646 static int
20647 builtin_function(name)
20648 char_u *name;
20650 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20651 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20654 #if defined(FEAT_PROFILE) || defined(PROTO)
20656 * Start profiling function "fp".
20658 static void
20659 func_do_profile(fp)
20660 ufunc_T *fp;
20662 fp->uf_tm_count = 0;
20663 profile_zero(&fp->uf_tm_self);
20664 profile_zero(&fp->uf_tm_total);
20665 if (fp->uf_tml_count == NULL)
20666 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20667 (sizeof(int) * fp->uf_lines.ga_len));
20668 if (fp->uf_tml_total == NULL)
20669 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20670 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20671 if (fp->uf_tml_self == NULL)
20672 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20673 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20674 fp->uf_tml_idx = -1;
20675 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20676 || fp->uf_tml_self == NULL)
20677 return; /* out of memory */
20679 fp->uf_profiling = TRUE;
20683 * Dump the profiling results for all functions in file "fd".
20685 void
20686 func_dump_profile(fd)
20687 FILE *fd;
20689 hashitem_T *hi;
20690 int todo;
20691 ufunc_T *fp;
20692 int i;
20693 ufunc_T **sorttab;
20694 int st_len = 0;
20696 todo = (int)func_hashtab.ht_used;
20697 if (todo == 0)
20698 return; /* nothing to dump */
20700 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20702 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20704 if (!HASHITEM_EMPTY(hi))
20706 --todo;
20707 fp = HI2UF(hi);
20708 if (fp->uf_profiling)
20710 if (sorttab != NULL)
20711 sorttab[st_len++] = fp;
20713 if (fp->uf_name[0] == K_SPECIAL)
20714 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20715 else
20716 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20717 if (fp->uf_tm_count == 1)
20718 fprintf(fd, "Called 1 time\n");
20719 else
20720 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20721 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20722 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20723 fprintf(fd, "\n");
20724 fprintf(fd, "count total (s) self (s)\n");
20726 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20728 if (FUNCLINE(fp, i) == NULL)
20729 continue;
20730 prof_func_line(fd, fp->uf_tml_count[i],
20731 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20732 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20734 fprintf(fd, "\n");
20739 if (sorttab != NULL && st_len > 0)
20741 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20742 prof_total_cmp);
20743 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20744 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20745 prof_self_cmp);
20746 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20749 vim_free(sorttab);
20752 static void
20753 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20754 FILE *fd;
20755 ufunc_T **sorttab;
20756 int st_len;
20757 char *title;
20758 int prefer_self; /* when equal print only self time */
20760 int i;
20761 ufunc_T *fp;
20763 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20764 fprintf(fd, "count total (s) self (s) function\n");
20765 for (i = 0; i < 20 && i < st_len; ++i)
20767 fp = sorttab[i];
20768 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20769 prefer_self);
20770 if (fp->uf_name[0] == K_SPECIAL)
20771 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20772 else
20773 fprintf(fd, " %s()\n", fp->uf_name);
20775 fprintf(fd, "\n");
20779 * Print the count and times for one function or function line.
20781 static void
20782 prof_func_line(fd, count, total, self, prefer_self)
20783 FILE *fd;
20784 int count;
20785 proftime_T *total;
20786 proftime_T *self;
20787 int prefer_self; /* when equal print only self time */
20789 if (count > 0)
20791 fprintf(fd, "%5d ", count);
20792 if (prefer_self && profile_equal(total, self))
20793 fprintf(fd, " ");
20794 else
20795 fprintf(fd, "%s ", profile_msg(total));
20796 if (!prefer_self && profile_equal(total, self))
20797 fprintf(fd, " ");
20798 else
20799 fprintf(fd, "%s ", profile_msg(self));
20801 else
20802 fprintf(fd, " ");
20806 * Compare function for total time sorting.
20808 static int
20809 #ifdef __BORLANDC__
20810 _RTLENTRYF
20811 #endif
20812 prof_total_cmp(s1, s2)
20813 const void *s1;
20814 const void *s2;
20816 ufunc_T *p1, *p2;
20818 p1 = *(ufunc_T **)s1;
20819 p2 = *(ufunc_T **)s2;
20820 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20824 * Compare function for self time sorting.
20826 static int
20827 #ifdef __BORLANDC__
20828 _RTLENTRYF
20829 #endif
20830 prof_self_cmp(s1, s2)
20831 const void *s1;
20832 const void *s2;
20834 ufunc_T *p1, *p2;
20836 p1 = *(ufunc_T **)s1;
20837 p2 = *(ufunc_T **)s2;
20838 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20841 #endif
20844 * If "name" has a package name try autoloading the script for it.
20845 * Return TRUE if a package was loaded.
20847 static int
20848 script_autoload(name, reload)
20849 char_u *name;
20850 int reload; /* load script again when already loaded */
20852 char_u *p;
20853 char_u *scriptname, *tofree;
20854 int ret = FALSE;
20855 int i;
20857 /* If there is no '#' after name[0] there is no package name. */
20858 p = vim_strchr(name, AUTOLOAD_CHAR);
20859 if (p == NULL || p == name)
20860 return FALSE;
20862 tofree = scriptname = autoload_name(name);
20864 /* Find the name in the list of previously loaded package names. Skip
20865 * "autoload/", it's always the same. */
20866 for (i = 0; i < ga_loaded.ga_len; ++i)
20867 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20868 break;
20869 if (!reload && i < ga_loaded.ga_len)
20870 ret = FALSE; /* was loaded already */
20871 else
20873 /* Remember the name if it wasn't loaded already. */
20874 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20876 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20877 tofree = NULL;
20880 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20881 if (source_runtime(scriptname, FALSE) == OK)
20882 ret = TRUE;
20885 vim_free(tofree);
20886 return ret;
20890 * Return the autoload script name for a function or variable name.
20891 * Returns NULL when out of memory.
20893 static char_u *
20894 autoload_name(name)
20895 char_u *name;
20897 char_u *p;
20898 char_u *scriptname;
20900 /* Get the script file name: replace '#' with '/', append ".vim". */
20901 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20902 if (scriptname == NULL)
20903 return FALSE;
20904 STRCPY(scriptname, "autoload/");
20905 STRCAT(scriptname, name);
20906 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20907 STRCAT(scriptname, ".vim");
20908 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20909 *p = '/';
20910 return scriptname;
20913 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20916 * Function given to ExpandGeneric() to obtain the list of user defined
20917 * function names.
20919 char_u *
20920 get_user_func_name(xp, idx)
20921 expand_T *xp;
20922 int idx;
20924 static long_u done;
20925 static hashitem_T *hi;
20926 ufunc_T *fp;
20928 if (idx == 0)
20930 done = 0;
20931 hi = func_hashtab.ht_array;
20933 if (done < func_hashtab.ht_used)
20935 if (done++ > 0)
20936 ++hi;
20937 while (HASHITEM_EMPTY(hi))
20938 ++hi;
20939 fp = HI2UF(hi);
20941 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20942 return fp->uf_name; /* prevents overflow */
20944 cat_func_name(IObuff, fp);
20945 if (xp->xp_context != EXPAND_USER_FUNC)
20947 STRCAT(IObuff, "(");
20948 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20949 STRCAT(IObuff, ")");
20951 return IObuff;
20953 return NULL;
20956 #endif /* FEAT_CMDL_COMPL */
20959 * Copy the function name of "fp" to buffer "buf".
20960 * "buf" must be able to hold the function name plus three bytes.
20961 * Takes care of script-local function names.
20963 static void
20964 cat_func_name(buf, fp)
20965 char_u *buf;
20966 ufunc_T *fp;
20968 if (fp->uf_name[0] == K_SPECIAL)
20970 STRCPY(buf, "<SNR>");
20971 STRCAT(buf, fp->uf_name + 3);
20973 else
20974 STRCPY(buf, fp->uf_name);
20978 * ":delfunction {name}"
20980 void
20981 ex_delfunction(eap)
20982 exarg_T *eap;
20984 ufunc_T *fp = NULL;
20985 char_u *p;
20986 char_u *name;
20987 funcdict_T fudi;
20989 p = eap->arg;
20990 name = trans_function_name(&p, eap->skip, 0, &fudi);
20991 vim_free(fudi.fd_newkey);
20992 if (name == NULL)
20994 if (fudi.fd_dict != NULL && !eap->skip)
20995 EMSG(_(e_funcref));
20996 return;
20998 if (!ends_excmd(*skipwhite(p)))
21000 vim_free(name);
21001 EMSG(_(e_trailing));
21002 return;
21004 eap->nextcmd = check_nextcmd(p);
21005 if (eap->nextcmd != NULL)
21006 *p = NUL;
21008 if (!eap->skip)
21009 fp = find_func(name);
21010 vim_free(name);
21012 if (!eap->skip)
21014 if (fp == NULL)
21016 EMSG2(_(e_nofunc), eap->arg);
21017 return;
21019 if (fp->uf_calls > 0)
21021 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21022 return;
21025 if (fudi.fd_dict != NULL)
21027 /* Delete the dict item that refers to the function, it will
21028 * invoke func_unref() and possibly delete the function. */
21029 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21031 else
21032 func_free(fp);
21037 * Free a function and remove it from the list of functions.
21039 static void
21040 func_free(fp)
21041 ufunc_T *fp;
21043 hashitem_T *hi;
21045 /* clear this function */
21046 ga_clear_strings(&(fp->uf_args));
21047 ga_clear_strings(&(fp->uf_lines));
21048 #ifdef FEAT_PROFILE
21049 vim_free(fp->uf_tml_count);
21050 vim_free(fp->uf_tml_total);
21051 vim_free(fp->uf_tml_self);
21052 #endif
21054 /* remove the function from the function hashtable */
21055 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21056 if (HASHITEM_EMPTY(hi))
21057 EMSG2(_(e_intern2), "func_free()");
21058 else
21059 hash_remove(&func_hashtab, hi);
21061 vim_free(fp);
21065 * Unreference a Function: decrement the reference count and free it when it
21066 * becomes zero. Only for numbered functions.
21068 static void
21069 func_unref(name)
21070 char_u *name;
21072 ufunc_T *fp;
21074 if (name != NULL && isdigit(*name))
21076 fp = find_func(name);
21077 if (fp == NULL)
21078 EMSG2(_(e_intern2), "func_unref()");
21079 else if (--fp->uf_refcount <= 0)
21081 /* Only delete it when it's not being used. Otherwise it's done
21082 * when "uf_calls" becomes zero. */
21083 if (fp->uf_calls == 0)
21084 func_free(fp);
21090 * Count a reference to a Function.
21092 static void
21093 func_ref(name)
21094 char_u *name;
21096 ufunc_T *fp;
21098 if (name != NULL && isdigit(*name))
21100 fp = find_func(name);
21101 if (fp == NULL)
21102 EMSG2(_(e_intern2), "func_ref()");
21103 else
21104 ++fp->uf_refcount;
21109 * Call a user function.
21111 static void
21112 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21113 ufunc_T *fp; /* pointer to function */
21114 int argcount; /* nr of args */
21115 typval_T *argvars; /* arguments */
21116 typval_T *rettv; /* return value */
21117 linenr_T firstline; /* first line of range */
21118 linenr_T lastline; /* last line of range */
21119 dict_T *selfdict; /* Dictionary for "self" */
21121 char_u *save_sourcing_name;
21122 linenr_T save_sourcing_lnum;
21123 scid_T save_current_SID;
21124 funccall_T *fc;
21125 int save_did_emsg;
21126 static int depth = 0;
21127 dictitem_T *v;
21128 int fixvar_idx = 0; /* index in fixvar[] */
21129 int i;
21130 int ai;
21131 char_u numbuf[NUMBUFLEN];
21132 char_u *name;
21133 #ifdef FEAT_PROFILE
21134 proftime_T wait_start;
21135 proftime_T call_start;
21136 #endif
21138 /* If depth of calling is getting too high, don't execute the function */
21139 if (depth >= p_mfd)
21141 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21142 rettv->v_type = VAR_NUMBER;
21143 rettv->vval.v_number = -1;
21144 return;
21146 ++depth;
21148 line_breakcheck(); /* check for CTRL-C hit */
21150 fc = (funccall_T *)alloc(sizeof(funccall_T));
21151 fc->caller = current_funccal;
21152 current_funccal = fc;
21153 fc->func = fp;
21154 fc->rettv = rettv;
21155 rettv->vval.v_number = 0;
21156 fc->linenr = 0;
21157 fc->returned = FALSE;
21158 fc->level = ex_nesting_level;
21159 /* Check if this function has a breakpoint. */
21160 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21161 fc->dbg_tick = debug_tick;
21164 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21165 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21166 * each argument variable and saves a lot of time.
21169 * Init l: variables.
21171 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21172 if (selfdict != NULL)
21174 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21175 * some compiler that checks the destination size. */
21176 v = &fc->fixvar[fixvar_idx++].var;
21177 name = v->di_key;
21178 STRCPY(name, "self");
21179 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21180 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21181 v->di_tv.v_type = VAR_DICT;
21182 v->di_tv.v_lock = 0;
21183 v->di_tv.vval.v_dict = selfdict;
21184 ++selfdict->dv_refcount;
21188 * Init a: variables.
21189 * Set a:0 to "argcount".
21190 * Set a:000 to a list with room for the "..." arguments.
21192 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21193 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21194 (varnumber_T)(argcount - fp->uf_args.ga_len));
21195 /* Use "name" to avoid a warning from some compiler that checks the
21196 * destination size. */
21197 v = &fc->fixvar[fixvar_idx++].var;
21198 name = v->di_key;
21199 STRCPY(name, "000");
21200 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21201 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21202 v->di_tv.v_type = VAR_LIST;
21203 v->di_tv.v_lock = VAR_FIXED;
21204 v->di_tv.vval.v_list = &fc->l_varlist;
21205 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21206 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21207 fc->l_varlist.lv_lock = VAR_FIXED;
21210 * Set a:firstline to "firstline" and a:lastline to "lastline".
21211 * Set a:name to named arguments.
21212 * Set a:N to the "..." arguments.
21214 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21215 (varnumber_T)firstline);
21216 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21217 (varnumber_T)lastline);
21218 for (i = 0; i < argcount; ++i)
21220 ai = i - fp->uf_args.ga_len;
21221 if (ai < 0)
21222 /* named argument a:name */
21223 name = FUNCARG(fp, i);
21224 else
21226 /* "..." argument a:1, a:2, etc. */
21227 sprintf((char *)numbuf, "%d", ai + 1);
21228 name = numbuf;
21230 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21232 v = &fc->fixvar[fixvar_idx++].var;
21233 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21235 else
21237 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21238 + STRLEN(name)));
21239 if (v == NULL)
21240 break;
21241 v->di_flags = DI_FLAGS_RO;
21243 STRCPY(v->di_key, name);
21244 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21246 /* Note: the values are copied directly to avoid alloc/free.
21247 * "argvars" must have VAR_FIXED for v_lock. */
21248 v->di_tv = argvars[i];
21249 v->di_tv.v_lock = VAR_FIXED;
21251 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21253 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21254 fc->l_listitems[ai].li_tv = argvars[i];
21255 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21259 /* Don't redraw while executing the function. */
21260 ++RedrawingDisabled;
21261 save_sourcing_name = sourcing_name;
21262 save_sourcing_lnum = sourcing_lnum;
21263 sourcing_lnum = 1;
21264 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21265 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21266 if (sourcing_name != NULL)
21268 if (save_sourcing_name != NULL
21269 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21270 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21271 else
21272 STRCPY(sourcing_name, "function ");
21273 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21275 if (p_verbose >= 12)
21277 ++no_wait_return;
21278 verbose_enter_scroll();
21280 smsg((char_u *)_("calling %s"), sourcing_name);
21281 if (p_verbose >= 14)
21283 char_u buf[MSG_BUF_LEN];
21284 char_u numbuf2[NUMBUFLEN];
21285 char_u *tofree;
21286 char_u *s;
21288 msg_puts((char_u *)"(");
21289 for (i = 0; i < argcount; ++i)
21291 if (i > 0)
21292 msg_puts((char_u *)", ");
21293 if (argvars[i].v_type == VAR_NUMBER)
21294 msg_outnum((long)argvars[i].vval.v_number);
21295 else
21297 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21298 if (s != NULL)
21300 trunc_string(s, buf, MSG_BUF_CLEN);
21301 msg_puts(buf);
21302 vim_free(tofree);
21306 msg_puts((char_u *)")");
21308 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21310 verbose_leave_scroll();
21311 --no_wait_return;
21314 #ifdef FEAT_PROFILE
21315 if (do_profiling == PROF_YES)
21317 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21318 func_do_profile(fp);
21319 if (fp->uf_profiling
21320 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21322 ++fp->uf_tm_count;
21323 profile_start(&call_start);
21324 profile_zero(&fp->uf_tm_children);
21326 script_prof_save(&wait_start);
21328 #endif
21330 save_current_SID = current_SID;
21331 current_SID = fp->uf_script_ID;
21332 save_did_emsg = did_emsg;
21333 did_emsg = FALSE;
21335 /* call do_cmdline() to execute the lines */
21336 do_cmdline(NULL, get_func_line, (void *)fc,
21337 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21339 --RedrawingDisabled;
21341 /* when the function was aborted because of an error, return -1 */
21342 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21344 clear_tv(rettv);
21345 rettv->v_type = VAR_NUMBER;
21346 rettv->vval.v_number = -1;
21349 #ifdef FEAT_PROFILE
21350 if (do_profiling == PROF_YES && (fp->uf_profiling
21351 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21353 profile_end(&call_start);
21354 profile_sub_wait(&wait_start, &call_start);
21355 profile_add(&fp->uf_tm_total, &call_start);
21356 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21357 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21359 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21360 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21363 #endif
21365 /* when being verbose, mention the return value */
21366 if (p_verbose >= 12)
21368 ++no_wait_return;
21369 verbose_enter_scroll();
21371 if (aborting())
21372 smsg((char_u *)_("%s aborted"), sourcing_name);
21373 else if (fc->rettv->v_type == VAR_NUMBER)
21374 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21375 (long)fc->rettv->vval.v_number);
21376 else
21378 char_u buf[MSG_BUF_LEN];
21379 char_u numbuf2[NUMBUFLEN];
21380 char_u *tofree;
21381 char_u *s;
21383 /* The value may be very long. Skip the middle part, so that we
21384 * have some idea how it starts and ends. smsg() would always
21385 * truncate it at the end. */
21386 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21387 if (s != NULL)
21389 trunc_string(s, buf, MSG_BUF_CLEN);
21390 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21391 vim_free(tofree);
21394 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21396 verbose_leave_scroll();
21397 --no_wait_return;
21400 vim_free(sourcing_name);
21401 sourcing_name = save_sourcing_name;
21402 sourcing_lnum = save_sourcing_lnum;
21403 current_SID = save_current_SID;
21404 #ifdef FEAT_PROFILE
21405 if (do_profiling == PROF_YES)
21406 script_prof_restore(&wait_start);
21407 #endif
21409 if (p_verbose >= 12 && sourcing_name != NULL)
21411 ++no_wait_return;
21412 verbose_enter_scroll();
21414 smsg((char_u *)_("continuing in %s"), sourcing_name);
21415 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21417 verbose_leave_scroll();
21418 --no_wait_return;
21421 did_emsg |= save_did_emsg;
21422 current_funccal = fc->caller;
21423 --depth;
21425 /* If the a:000 list and the l: and a: dicts are not referenced we can
21426 * free the funccall_T and what's in it. */
21427 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21428 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21429 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21431 free_funccal(fc, FALSE);
21433 else
21435 hashitem_T *hi;
21436 listitem_T *li;
21437 int todo;
21439 /* "fc" is still in use. This can happen when returning "a:000" or
21440 * assigning "l:" to a global variable.
21441 * Link "fc" in the list for garbage collection later. */
21442 fc->caller = previous_funccal;
21443 previous_funccal = fc;
21445 /* Make a copy of the a: variables, since we didn't do that above. */
21446 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21447 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21449 if (!HASHITEM_EMPTY(hi))
21451 --todo;
21452 v = HI2DI(hi);
21453 copy_tv(&v->di_tv, &v->di_tv);
21457 /* Make a copy of the a:000 items, since we didn't do that above. */
21458 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21459 copy_tv(&li->li_tv, &li->li_tv);
21464 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21465 * referenced from anywhere that is in use.
21467 static int
21468 can_free_funccal(fc, copyID)
21469 funccall_T *fc;
21470 int copyID;
21472 return (fc->l_varlist.lv_copyID != copyID
21473 && fc->l_vars.dv_copyID != copyID
21474 && fc->l_avars.dv_copyID != copyID);
21478 * Free "fc" and what it contains.
21480 static void
21481 free_funccal(fc, free_val)
21482 funccall_T *fc;
21483 int free_val; /* a: vars were allocated */
21485 listitem_T *li;
21487 /* The a: variables typevals may not have been allocated, only free the
21488 * allocated variables. */
21489 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21491 /* free all l: variables */
21492 vars_clear(&fc->l_vars.dv_hashtab);
21494 /* Free the a:000 variables if they were allocated. */
21495 if (free_val)
21496 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21497 clear_tv(&li->li_tv);
21499 vim_free(fc);
21503 * Add a number variable "name" to dict "dp" with value "nr".
21505 static void
21506 add_nr_var(dp, v, name, nr)
21507 dict_T *dp;
21508 dictitem_T *v;
21509 char *name;
21510 varnumber_T nr;
21512 STRCPY(v->di_key, name);
21513 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21514 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21515 v->di_tv.v_type = VAR_NUMBER;
21516 v->di_tv.v_lock = VAR_FIXED;
21517 v->di_tv.vval.v_number = nr;
21521 * ":return [expr]"
21523 void
21524 ex_return(eap)
21525 exarg_T *eap;
21527 char_u *arg = eap->arg;
21528 typval_T rettv;
21529 int returning = FALSE;
21531 if (current_funccal == NULL)
21533 EMSG(_("E133: :return not inside a function"));
21534 return;
21537 if (eap->skip)
21538 ++emsg_skip;
21540 eap->nextcmd = NULL;
21541 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21542 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21544 if (!eap->skip)
21545 returning = do_return(eap, FALSE, TRUE, &rettv);
21546 else
21547 clear_tv(&rettv);
21549 /* It's safer to return also on error. */
21550 else if (!eap->skip)
21553 * Return unless the expression evaluation has been cancelled due to an
21554 * aborting error, an interrupt, or an exception.
21556 if (!aborting())
21557 returning = do_return(eap, FALSE, TRUE, NULL);
21560 /* When skipping or the return gets pending, advance to the next command
21561 * in this line (!returning). Otherwise, ignore the rest of the line.
21562 * Following lines will be ignored by get_func_line(). */
21563 if (returning)
21564 eap->nextcmd = NULL;
21565 else if (eap->nextcmd == NULL) /* no argument */
21566 eap->nextcmd = check_nextcmd(arg);
21568 if (eap->skip)
21569 --emsg_skip;
21573 * Return from a function. Possibly makes the return pending. Also called
21574 * for a pending return at the ":endtry" or after returning from an extra
21575 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21576 * when called due to a ":return" command. "rettv" may point to a typval_T
21577 * with the return rettv. Returns TRUE when the return can be carried out,
21578 * FALSE when the return gets pending.
21581 do_return(eap, reanimate, is_cmd, rettv)
21582 exarg_T *eap;
21583 int reanimate;
21584 int is_cmd;
21585 void *rettv;
21587 int idx;
21588 struct condstack *cstack = eap->cstack;
21590 if (reanimate)
21591 /* Undo the return. */
21592 current_funccal->returned = FALSE;
21595 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21596 * not in its finally clause (which then is to be executed next) is found.
21597 * In this case, make the ":return" pending for execution at the ":endtry".
21598 * Otherwise, return normally.
21600 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21601 if (idx >= 0)
21603 cstack->cs_pending[idx] = CSTP_RETURN;
21605 if (!is_cmd && !reanimate)
21606 /* A pending return again gets pending. "rettv" points to an
21607 * allocated variable with the rettv of the original ":return"'s
21608 * argument if present or is NULL else. */
21609 cstack->cs_rettv[idx] = rettv;
21610 else
21612 /* When undoing a return in order to make it pending, get the stored
21613 * return rettv. */
21614 if (reanimate)
21615 rettv = current_funccal->rettv;
21617 if (rettv != NULL)
21619 /* Store the value of the pending return. */
21620 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21621 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21622 else
21623 EMSG(_(e_outofmem));
21625 else
21626 cstack->cs_rettv[idx] = NULL;
21628 if (reanimate)
21630 /* The pending return value could be overwritten by a ":return"
21631 * without argument in a finally clause; reset the default
21632 * return value. */
21633 current_funccal->rettv->v_type = VAR_NUMBER;
21634 current_funccal->rettv->vval.v_number = 0;
21637 report_make_pending(CSTP_RETURN, rettv);
21639 else
21641 current_funccal->returned = TRUE;
21643 /* If the return is carried out now, store the return value. For
21644 * a return immediately after reanimation, the value is already
21645 * there. */
21646 if (!reanimate && rettv != NULL)
21648 clear_tv(current_funccal->rettv);
21649 *current_funccal->rettv = *(typval_T *)rettv;
21650 if (!is_cmd)
21651 vim_free(rettv);
21655 return idx < 0;
21659 * Free the variable with a pending return value.
21661 void
21662 discard_pending_return(rettv)
21663 void *rettv;
21665 free_tv((typval_T *)rettv);
21669 * Generate a return command for producing the value of "rettv". The result
21670 * is an allocated string. Used by report_pending() for verbose messages.
21672 char_u *
21673 get_return_cmd(rettv)
21674 void *rettv;
21676 char_u *s = NULL;
21677 char_u *tofree = NULL;
21678 char_u numbuf[NUMBUFLEN];
21680 if (rettv != NULL)
21681 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21682 if (s == NULL)
21683 s = (char_u *)"";
21685 STRCPY(IObuff, ":return ");
21686 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21687 if (STRLEN(s) + 8 >= IOSIZE)
21688 STRCPY(IObuff + IOSIZE - 4, "...");
21689 vim_free(tofree);
21690 return vim_strsave(IObuff);
21694 * Get next function line.
21695 * Called by do_cmdline() to get the next line.
21696 * Returns allocated string, or NULL for end of function.
21698 char_u *
21699 get_func_line(c, cookie, indent)
21700 int c UNUSED;
21701 void *cookie;
21702 int indent UNUSED;
21704 funccall_T *fcp = (funccall_T *)cookie;
21705 ufunc_T *fp = fcp->func;
21706 char_u *retval;
21707 garray_T *gap; /* growarray with function lines */
21709 /* If breakpoints have been added/deleted need to check for it. */
21710 if (fcp->dbg_tick != debug_tick)
21712 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21713 sourcing_lnum);
21714 fcp->dbg_tick = debug_tick;
21716 #ifdef FEAT_PROFILE
21717 if (do_profiling == PROF_YES)
21718 func_line_end(cookie);
21719 #endif
21721 gap = &fp->uf_lines;
21722 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21723 || fcp->returned)
21724 retval = NULL;
21725 else
21727 /* Skip NULL lines (continuation lines). */
21728 while (fcp->linenr < gap->ga_len
21729 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21730 ++fcp->linenr;
21731 if (fcp->linenr >= gap->ga_len)
21732 retval = NULL;
21733 else
21735 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21736 sourcing_lnum = fcp->linenr;
21737 #ifdef FEAT_PROFILE
21738 if (do_profiling == PROF_YES)
21739 func_line_start(cookie);
21740 #endif
21744 /* Did we encounter a breakpoint? */
21745 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21747 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21748 /* Find next breakpoint. */
21749 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21750 sourcing_lnum);
21751 fcp->dbg_tick = debug_tick;
21754 return retval;
21757 #if defined(FEAT_PROFILE) || defined(PROTO)
21759 * Called when starting to read a function line.
21760 * "sourcing_lnum" must be correct!
21761 * When skipping lines it may not actually be executed, but we won't find out
21762 * until later and we need to store the time now.
21764 void
21765 func_line_start(cookie)
21766 void *cookie;
21768 funccall_T *fcp = (funccall_T *)cookie;
21769 ufunc_T *fp = fcp->func;
21771 if (fp->uf_profiling && sourcing_lnum >= 1
21772 && sourcing_lnum <= fp->uf_lines.ga_len)
21774 fp->uf_tml_idx = sourcing_lnum - 1;
21775 /* Skip continuation lines. */
21776 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21777 --fp->uf_tml_idx;
21778 fp->uf_tml_execed = FALSE;
21779 profile_start(&fp->uf_tml_start);
21780 profile_zero(&fp->uf_tml_children);
21781 profile_get_wait(&fp->uf_tml_wait);
21786 * Called when actually executing a function line.
21788 void
21789 func_line_exec(cookie)
21790 void *cookie;
21792 funccall_T *fcp = (funccall_T *)cookie;
21793 ufunc_T *fp = fcp->func;
21795 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21796 fp->uf_tml_execed = TRUE;
21800 * Called when done with a function line.
21802 void
21803 func_line_end(cookie)
21804 void *cookie;
21806 funccall_T *fcp = (funccall_T *)cookie;
21807 ufunc_T *fp = fcp->func;
21809 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21811 if (fp->uf_tml_execed)
21813 ++fp->uf_tml_count[fp->uf_tml_idx];
21814 profile_end(&fp->uf_tml_start);
21815 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21816 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21817 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21818 &fp->uf_tml_children);
21820 fp->uf_tml_idx = -1;
21823 #endif
21826 * Return TRUE if the currently active function should be ended, because a
21827 * return was encountered or an error occurred. Used inside a ":while".
21830 func_has_ended(cookie)
21831 void *cookie;
21833 funccall_T *fcp = (funccall_T *)cookie;
21835 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21836 * an error inside a try conditional. */
21837 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21838 || fcp->returned);
21842 * return TRUE if cookie indicates a function which "abort"s on errors.
21845 func_has_abort(cookie)
21846 void *cookie;
21848 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21851 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21852 typedef enum
21854 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21855 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21856 VAR_FLAVOUR_VIMINFO /* all uppercase */
21857 } var_flavour_T;
21859 static var_flavour_T var_flavour __ARGS((char_u *varname));
21861 static var_flavour_T
21862 var_flavour(varname)
21863 char_u *varname;
21865 char_u *p = varname;
21867 if (ASCII_ISUPPER(*p))
21869 while (*(++p))
21870 if (ASCII_ISLOWER(*p))
21871 return VAR_FLAVOUR_SESSION;
21872 return VAR_FLAVOUR_VIMINFO;
21874 else
21875 return VAR_FLAVOUR_DEFAULT;
21877 #endif
21879 #if defined(FEAT_VIMINFO) || defined(PROTO)
21881 * Restore global vars that start with a capital from the viminfo file
21884 read_viminfo_varlist(virp, writing)
21885 vir_T *virp;
21886 int writing;
21888 char_u *tab;
21889 int type = VAR_NUMBER;
21890 typval_T tv;
21892 if (!writing && (find_viminfo_parameter('!') != NULL))
21894 tab = vim_strchr(virp->vir_line + 1, '\t');
21895 if (tab != NULL)
21897 *tab++ = '\0'; /* isolate the variable name */
21898 if (*tab == 'S') /* string var */
21899 type = VAR_STRING;
21900 #ifdef FEAT_FLOAT
21901 else if (*tab == 'F')
21902 type = VAR_FLOAT;
21903 #endif
21905 tab = vim_strchr(tab, '\t');
21906 if (tab != NULL)
21908 tv.v_type = type;
21909 if (type == VAR_STRING)
21910 tv.vval.v_string = viminfo_readstring(virp,
21911 (int)(tab - virp->vir_line + 1), TRUE);
21912 #ifdef FEAT_FLOAT
21913 else if (type == VAR_FLOAT)
21914 (void)string2float(tab + 1, &tv.vval.v_float);
21915 #endif
21916 else
21917 tv.vval.v_number = atol((char *)tab + 1);
21918 set_var(virp->vir_line + 1, &tv, FALSE);
21919 if (type == VAR_STRING)
21920 vim_free(tv.vval.v_string);
21925 return viminfo_readline(virp);
21929 * Write global vars that start with a capital to the viminfo file
21931 void
21932 write_viminfo_varlist(fp)
21933 FILE *fp;
21935 hashitem_T *hi;
21936 dictitem_T *this_var;
21937 int todo;
21938 char *s;
21939 char_u *p;
21940 char_u *tofree;
21941 char_u numbuf[NUMBUFLEN];
21943 if (find_viminfo_parameter('!') == NULL)
21944 return;
21946 fputs(_("\n# global variables:\n"), fp);
21948 todo = (int)globvarht.ht_used;
21949 for (hi = globvarht.ht_array; todo > 0; ++hi)
21951 if (!HASHITEM_EMPTY(hi))
21953 --todo;
21954 this_var = HI2DI(hi);
21955 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21957 switch (this_var->di_tv.v_type)
21959 case VAR_STRING: s = "STR"; break;
21960 case VAR_NUMBER: s = "NUM"; break;
21961 #ifdef FEAT_FLOAT
21962 case VAR_FLOAT: s = "FLO"; break;
21963 #endif
21964 default: continue;
21966 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21967 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21968 if (p != NULL)
21969 viminfo_writestring(fp, p);
21970 vim_free(tofree);
21975 #endif
21977 #if defined(FEAT_SESSION) || defined(PROTO)
21979 store_session_globals(fd)
21980 FILE *fd;
21982 hashitem_T *hi;
21983 dictitem_T *this_var;
21984 int todo;
21985 char_u *p, *t;
21987 todo = (int)globvarht.ht_used;
21988 for (hi = globvarht.ht_array; todo > 0; ++hi)
21990 if (!HASHITEM_EMPTY(hi))
21992 --todo;
21993 this_var = HI2DI(hi);
21994 if ((this_var->di_tv.v_type == VAR_NUMBER
21995 || this_var->di_tv.v_type == VAR_STRING)
21996 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21998 /* Escape special characters with a backslash. Turn a LF and
21999 * CR into \n and \r. */
22000 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
22001 (char_u *)"\\\"\n\r");
22002 if (p == NULL) /* out of memory */
22003 break;
22004 for (t = p; *t != NUL; ++t)
22005 if (*t == '\n')
22006 *t = 'n';
22007 else if (*t == '\r')
22008 *t = 'r';
22009 if ((fprintf(fd, "let %s = %c%s%c",
22010 this_var->di_key,
22011 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22012 : ' ',
22014 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22015 : ' ') < 0)
22016 || put_eol(fd) == FAIL)
22018 vim_free(p);
22019 return FAIL;
22021 vim_free(p);
22023 #ifdef FEAT_FLOAT
22024 else if (this_var->di_tv.v_type == VAR_FLOAT
22025 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22027 float_T f = this_var->di_tv.vval.v_float;
22028 int sign = ' ';
22030 if (f < 0)
22032 f = -f;
22033 sign = '-';
22035 if ((fprintf(fd, "let %s = %c&%f",
22036 this_var->di_key, sign, f) < 0)
22037 || put_eol(fd) == FAIL)
22038 return FAIL;
22040 #endif
22043 return OK;
22045 #endif
22048 * Display script name where an item was last set.
22049 * Should only be invoked when 'verbose' is non-zero.
22051 void
22052 last_set_msg(scriptID)
22053 scid_T scriptID;
22055 char_u *p;
22057 if (scriptID != 0)
22059 p = home_replace_save(NULL, get_scriptname(scriptID));
22060 if (p != NULL)
22062 verbose_enter();
22063 MSG_PUTS(_("\n\tLast set from "));
22064 MSG_PUTS(p);
22065 vim_free(p);
22066 verbose_leave();
22072 * List v:oldfiles in a nice way.
22074 void
22075 ex_oldfiles(eap)
22076 exarg_T *eap UNUSED;
22078 list_T *l = vimvars[VV_OLDFILES].vv_list;
22079 listitem_T *li;
22080 int nr = 0;
22082 if (l == NULL)
22083 msg((char_u *)_("No old files"));
22084 else
22086 msg_start();
22087 msg_scroll = TRUE;
22088 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22090 msg_outnum((long)++nr);
22091 MSG_PUTS(": ");
22092 msg_outtrans(get_tv_string(&li->li_tv));
22093 msg_putchar('\n');
22094 out_flush(); /* output one line at a time */
22095 ui_breakcheck();
22097 /* Assume "got_int" was set to truncate the listing. */
22098 got_int = FALSE;
22100 #ifdef FEAT_BROWSE_CMD
22101 if (cmdmod.browse)
22103 quit_more = FALSE;
22104 nr = prompt_for_number(FALSE);
22105 msg_starthere();
22106 if (nr > 0)
22108 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22109 (long)nr);
22111 if (p != NULL)
22113 p = expand_env_save(p);
22114 eap->arg = p;
22115 eap->cmdidx = CMD_edit;
22116 cmdmod.browse = FALSE;
22117 do_exedit(eap, NULL);
22118 vim_free(p);
22122 #endif
22126 #endif /* FEAT_EVAL */
22129 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22131 #ifdef WIN3264
22133 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22135 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22136 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22137 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22140 * Get the short path (8.3) for the filename in "fnamep".
22141 * Only works for a valid file name.
22142 * When the path gets longer "fnamep" is changed and the allocated buffer
22143 * is put in "bufp".
22144 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22145 * Returns OK on success, FAIL on failure.
22147 static int
22148 get_short_pathname(fnamep, bufp, fnamelen)
22149 char_u **fnamep;
22150 char_u **bufp;
22151 int *fnamelen;
22153 int l, len;
22154 char_u *newbuf;
22156 len = *fnamelen;
22157 l = GetShortPathName(*fnamep, *fnamep, len);
22158 if (l > len - 1)
22160 /* If that doesn't work (not enough space), then save the string
22161 * and try again with a new buffer big enough. */
22162 newbuf = vim_strnsave(*fnamep, l);
22163 if (newbuf == NULL)
22164 return FAIL;
22166 vim_free(*bufp);
22167 *fnamep = *bufp = newbuf;
22169 /* Really should always succeed, as the buffer is big enough. */
22170 l = GetShortPathName(*fnamep, *fnamep, l+1);
22173 *fnamelen = l;
22174 return OK;
22178 * Get the short path (8.3) for the filename in "fname". The converted
22179 * path is returned in "bufp".
22181 * Some of the directories specified in "fname" may not exist. This function
22182 * will shorten the existing directories at the beginning of the path and then
22183 * append the remaining non-existing path.
22185 * fname - Pointer to the filename to shorten. On return, contains the
22186 * pointer to the shortened pathname
22187 * bufp - Pointer to an allocated buffer for the filename.
22188 * fnamelen - Length of the filename pointed to by fname
22190 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22192 static int
22193 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22194 char_u **fname;
22195 char_u **bufp;
22196 int *fnamelen;
22198 char_u *short_fname, *save_fname, *pbuf_unused;
22199 char_u *endp, *save_endp;
22200 char_u ch;
22201 int old_len, len;
22202 int new_len, sfx_len;
22203 int retval = OK;
22205 /* Make a copy */
22206 old_len = *fnamelen;
22207 save_fname = vim_strnsave(*fname, old_len);
22208 pbuf_unused = NULL;
22209 short_fname = NULL;
22211 endp = save_fname + old_len - 1; /* Find the end of the copy */
22212 save_endp = endp;
22215 * Try shortening the supplied path till it succeeds by removing one
22216 * directory at a time from the tail of the path.
22218 len = 0;
22219 for (;;)
22221 /* go back one path-separator */
22222 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22223 --endp;
22224 if (endp <= save_fname)
22225 break; /* processed the complete path */
22228 * Replace the path separator with a NUL and try to shorten the
22229 * resulting path.
22231 ch = *endp;
22232 *endp = 0;
22233 short_fname = save_fname;
22234 len = (int)STRLEN(short_fname) + 1;
22235 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22237 retval = FAIL;
22238 goto theend;
22240 *endp = ch; /* preserve the string */
22242 if (len > 0)
22243 break; /* successfully shortened the path */
22245 /* failed to shorten the path. Skip the path separator */
22246 --endp;
22249 if (len > 0)
22252 * Succeeded in shortening the path. Now concatenate the shortened
22253 * path with the remaining path at the tail.
22256 /* Compute the length of the new path. */
22257 sfx_len = (int)(save_endp - endp) + 1;
22258 new_len = len + sfx_len;
22260 *fnamelen = new_len;
22261 vim_free(*bufp);
22262 if (new_len > old_len)
22264 /* There is not enough space in the currently allocated string,
22265 * copy it to a buffer big enough. */
22266 *fname = *bufp = vim_strnsave(short_fname, new_len);
22267 if (*fname == NULL)
22269 retval = FAIL;
22270 goto theend;
22273 else
22275 /* Transfer short_fname to the main buffer (it's big enough),
22276 * unless get_short_pathname() did its work in-place. */
22277 *fname = *bufp = save_fname;
22278 if (short_fname != save_fname)
22279 vim_strncpy(save_fname, short_fname, len);
22280 save_fname = NULL;
22283 /* concat the not-shortened part of the path */
22284 vim_strncpy(*fname + len, endp, sfx_len);
22285 (*fname)[new_len] = NUL;
22288 theend:
22289 vim_free(pbuf_unused);
22290 vim_free(save_fname);
22292 return retval;
22296 * Get a pathname for a partial path.
22297 * Returns OK for success, FAIL for failure.
22299 static int
22300 shortpath_for_partial(fnamep, bufp, fnamelen)
22301 char_u **fnamep;
22302 char_u **bufp;
22303 int *fnamelen;
22305 int sepcount, len, tflen;
22306 char_u *p;
22307 char_u *pbuf, *tfname;
22308 int hasTilde;
22310 /* Count up the path separators from the RHS.. so we know which part
22311 * of the path to return. */
22312 sepcount = 0;
22313 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22314 if (vim_ispathsep(*p))
22315 ++sepcount;
22317 /* Need full path first (use expand_env() to remove a "~/") */
22318 hasTilde = (**fnamep == '~');
22319 if (hasTilde)
22320 pbuf = tfname = expand_env_save(*fnamep);
22321 else
22322 pbuf = tfname = FullName_save(*fnamep, FALSE);
22324 len = tflen = (int)STRLEN(tfname);
22326 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22327 return FAIL;
22329 if (len == 0)
22331 /* Don't have a valid filename, so shorten the rest of the
22332 * path if we can. This CAN give us invalid 8.3 filenames, but
22333 * there's not a lot of point in guessing what it might be.
22335 len = tflen;
22336 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22337 return FAIL;
22340 /* Count the paths backward to find the beginning of the desired string. */
22341 for (p = tfname + len - 1; p >= tfname; --p)
22343 #ifdef FEAT_MBYTE
22344 if (has_mbyte)
22345 p -= mb_head_off(tfname, p);
22346 #endif
22347 if (vim_ispathsep(*p))
22349 if (sepcount == 0 || (hasTilde && sepcount == 1))
22350 break;
22351 else
22352 sepcount --;
22355 if (hasTilde)
22357 --p;
22358 if (p >= tfname)
22359 *p = '~';
22360 else
22361 return FAIL;
22363 else
22364 ++p;
22366 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22367 vim_free(*bufp);
22368 *fnamelen = (int)STRLEN(p);
22369 *bufp = pbuf;
22370 *fnamep = p;
22372 return OK;
22374 #endif /* WIN3264 */
22377 * Adjust a filename, according to a string of modifiers.
22378 * *fnamep must be NUL terminated when called. When returning, the length is
22379 * determined by *fnamelen.
22380 * Returns VALID_ flags or -1 for failure.
22381 * When there is an error, *fnamep is set to NULL.
22384 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22385 char_u *src; /* string with modifiers */
22386 int *usedlen; /* characters after src that are used */
22387 char_u **fnamep; /* file name so far */
22388 char_u **bufp; /* buffer for allocated file name or NULL */
22389 int *fnamelen; /* length of fnamep */
22391 int valid = 0;
22392 char_u *tail;
22393 char_u *s, *p, *pbuf;
22394 char_u dirname[MAXPATHL];
22395 int c;
22396 int has_fullname = 0;
22397 #ifdef WIN3264
22398 int has_shortname = 0;
22399 #endif
22401 repeat:
22402 /* ":p" - full path/file_name */
22403 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22405 has_fullname = 1;
22407 valid |= VALID_PATH;
22408 *usedlen += 2;
22410 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22411 if ((*fnamep)[0] == '~'
22412 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22413 && ((*fnamep)[1] == '/'
22414 # ifdef BACKSLASH_IN_FILENAME
22415 || (*fnamep)[1] == '\\'
22416 # endif
22417 || (*fnamep)[1] == NUL)
22419 #endif
22422 *fnamep = expand_env_save(*fnamep);
22423 vim_free(*bufp); /* free any allocated file name */
22424 *bufp = *fnamep;
22425 if (*fnamep == NULL)
22426 return -1;
22429 /* When "/." or "/.." is used: force expansion to get rid of it. */
22430 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22432 if (vim_ispathsep(*p)
22433 && p[1] == '.'
22434 && (p[2] == NUL
22435 || vim_ispathsep(p[2])
22436 || (p[2] == '.'
22437 && (p[3] == NUL || vim_ispathsep(p[3])))))
22438 break;
22441 /* FullName_save() is slow, don't use it when not needed. */
22442 if (*p != NUL || !vim_isAbsName(*fnamep))
22444 *fnamep = FullName_save(*fnamep, *p != NUL);
22445 vim_free(*bufp); /* free any allocated file name */
22446 *bufp = *fnamep;
22447 if (*fnamep == NULL)
22448 return -1;
22451 /* Append a path separator to a directory. */
22452 if (mch_isdir(*fnamep))
22454 /* Make room for one or two extra characters. */
22455 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22456 vim_free(*bufp); /* free any allocated file name */
22457 *bufp = *fnamep;
22458 if (*fnamep == NULL)
22459 return -1;
22460 add_pathsep(*fnamep);
22464 /* ":." - path relative to the current directory */
22465 /* ":~" - path relative to the home directory */
22466 /* ":8" - shortname path - postponed till after */
22467 while (src[*usedlen] == ':'
22468 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22470 *usedlen += 2;
22471 if (c == '8')
22473 #ifdef WIN3264
22474 has_shortname = 1; /* Postpone this. */
22475 #endif
22476 continue;
22478 pbuf = NULL;
22479 /* Need full path first (use expand_env() to remove a "~/") */
22480 if (!has_fullname)
22482 if (c == '.' && **fnamep == '~')
22483 p = pbuf = expand_env_save(*fnamep);
22484 else
22485 p = pbuf = FullName_save(*fnamep, FALSE);
22487 else
22488 p = *fnamep;
22490 has_fullname = 0;
22492 if (p != NULL)
22494 if (c == '.')
22496 mch_dirname(dirname, MAXPATHL);
22497 s = shorten_fname(p, dirname);
22498 if (s != NULL)
22500 *fnamep = s;
22501 if (pbuf != NULL)
22503 vim_free(*bufp); /* free any allocated file name */
22504 *bufp = pbuf;
22505 pbuf = NULL;
22509 else
22511 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22512 /* Only replace it when it starts with '~' */
22513 if (*dirname == '~')
22515 s = vim_strsave(dirname);
22516 if (s != NULL)
22518 *fnamep = s;
22519 vim_free(*bufp);
22520 *bufp = s;
22524 vim_free(pbuf);
22528 tail = gettail(*fnamep);
22529 *fnamelen = (int)STRLEN(*fnamep);
22531 /* ":h" - head, remove "/file_name", can be repeated */
22532 /* Don't remove the first "/" or "c:\" */
22533 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22535 valid |= VALID_HEAD;
22536 *usedlen += 2;
22537 s = get_past_head(*fnamep);
22538 while (tail > s && after_pathsep(s, tail))
22539 mb_ptr_back(*fnamep, tail);
22540 *fnamelen = (int)(tail - *fnamep);
22541 #ifdef VMS
22542 if (*fnamelen > 0)
22543 *fnamelen += 1; /* the path separator is part of the path */
22544 #endif
22545 if (*fnamelen == 0)
22547 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22548 p = vim_strsave((char_u *)".");
22549 if (p == NULL)
22550 return -1;
22551 vim_free(*bufp);
22552 *bufp = *fnamep = tail = p;
22553 *fnamelen = 1;
22555 else
22557 while (tail > s && !after_pathsep(s, tail))
22558 mb_ptr_back(*fnamep, tail);
22562 /* ":8" - shortname */
22563 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22565 *usedlen += 2;
22566 #ifdef WIN3264
22567 has_shortname = 1;
22568 #endif
22571 #ifdef WIN3264
22572 /* Check shortname after we have done 'heads' and before we do 'tails'
22574 if (has_shortname)
22576 pbuf = NULL;
22577 /* Copy the string if it is shortened by :h */
22578 if (*fnamelen < (int)STRLEN(*fnamep))
22580 p = vim_strnsave(*fnamep, *fnamelen);
22581 if (p == 0)
22582 return -1;
22583 vim_free(*bufp);
22584 *bufp = *fnamep = p;
22587 /* Split into two implementations - makes it easier. First is where
22588 * there isn't a full name already, second is where there is.
22590 if (!has_fullname && !vim_isAbsName(*fnamep))
22592 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22593 return -1;
22595 else
22597 int l;
22599 /* Simple case, already have the full-name
22600 * Nearly always shorter, so try first time. */
22601 l = *fnamelen;
22602 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22603 return -1;
22605 if (l == 0)
22607 /* Couldn't find the filename.. search the paths.
22609 l = *fnamelen;
22610 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22611 return -1;
22613 *fnamelen = l;
22616 #endif /* WIN3264 */
22618 /* ":t" - tail, just the basename */
22619 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22621 *usedlen += 2;
22622 *fnamelen -= (int)(tail - *fnamep);
22623 *fnamep = tail;
22626 /* ":e" - extension, can be repeated */
22627 /* ":r" - root, without extension, can be repeated */
22628 while (src[*usedlen] == ':'
22629 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22631 /* find a '.' in the tail:
22632 * - for second :e: before the current fname
22633 * - otherwise: The last '.'
22635 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22636 s = *fnamep - 2;
22637 else
22638 s = *fnamep + *fnamelen - 1;
22639 for ( ; s > tail; --s)
22640 if (s[0] == '.')
22641 break;
22642 if (src[*usedlen + 1] == 'e') /* :e */
22644 if (s > tail)
22646 *fnamelen += (int)(*fnamep - (s + 1));
22647 *fnamep = s + 1;
22648 #ifdef VMS
22649 /* cut version from the extension */
22650 s = *fnamep + *fnamelen - 1;
22651 for ( ; s > *fnamep; --s)
22652 if (s[0] == ';')
22653 break;
22654 if (s > *fnamep)
22655 *fnamelen = s - *fnamep;
22656 #endif
22658 else if (*fnamep <= tail)
22659 *fnamelen = 0;
22661 else /* :r */
22663 if (s > tail) /* remove one extension */
22664 *fnamelen = (int)(s - *fnamep);
22666 *usedlen += 2;
22669 /* ":s?pat?foo?" - substitute */
22670 /* ":gs?pat?foo?" - global substitute */
22671 if (src[*usedlen] == ':'
22672 && (src[*usedlen + 1] == 's'
22673 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22675 char_u *str;
22676 char_u *pat;
22677 char_u *sub;
22678 int sep;
22679 char_u *flags;
22680 int didit = FALSE;
22682 flags = (char_u *)"";
22683 s = src + *usedlen + 2;
22684 if (src[*usedlen + 1] == 'g')
22686 flags = (char_u *)"g";
22687 ++s;
22690 sep = *s++;
22691 if (sep)
22693 /* find end of pattern */
22694 p = vim_strchr(s, sep);
22695 if (p != NULL)
22697 pat = vim_strnsave(s, (int)(p - s));
22698 if (pat != NULL)
22700 s = p + 1;
22701 /* find end of substitution */
22702 p = vim_strchr(s, sep);
22703 if (p != NULL)
22705 sub = vim_strnsave(s, (int)(p - s));
22706 str = vim_strnsave(*fnamep, *fnamelen);
22707 if (sub != NULL && str != NULL)
22709 *usedlen = (int)(p + 1 - src);
22710 s = do_string_sub(str, pat, sub, flags);
22711 if (s != NULL)
22713 *fnamep = s;
22714 *fnamelen = (int)STRLEN(s);
22715 vim_free(*bufp);
22716 *bufp = s;
22717 didit = TRUE;
22720 vim_free(sub);
22721 vim_free(str);
22723 vim_free(pat);
22726 /* after using ":s", repeat all the modifiers */
22727 if (didit)
22728 goto repeat;
22732 return valid;
22736 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22737 * "flags" can be "g" to do a global substitute.
22738 * Returns an allocated string, NULL for error.
22740 char_u *
22741 do_string_sub(str, pat, sub, flags)
22742 char_u *str;
22743 char_u *pat;
22744 char_u *sub;
22745 char_u *flags;
22747 int sublen;
22748 regmatch_T regmatch;
22749 int i;
22750 int do_all;
22751 char_u *tail;
22752 garray_T ga;
22753 char_u *ret;
22754 char_u *save_cpo;
22756 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22757 save_cpo = p_cpo;
22758 p_cpo = empty_option;
22760 ga_init2(&ga, 1, 200);
22762 do_all = (flags[0] == 'g');
22764 regmatch.rm_ic = p_ic;
22765 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22766 if (regmatch.regprog != NULL)
22768 tail = str;
22769 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22772 * Get some space for a temporary buffer to do the substitution
22773 * into. It will contain:
22774 * - The text up to where the match is.
22775 * - The substituted text.
22776 * - The text after the match.
22778 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22779 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22780 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22782 ga_clear(&ga);
22783 break;
22786 /* copy the text up to where the match is */
22787 i = (int)(regmatch.startp[0] - tail);
22788 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22789 /* add the substituted text */
22790 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22791 + ga.ga_len + i, TRUE, TRUE, FALSE);
22792 ga.ga_len += i + sublen - 1;
22793 /* avoid getting stuck on a match with an empty string */
22794 if (tail == regmatch.endp[0])
22796 if (*tail == NUL)
22797 break;
22798 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22799 ++ga.ga_len;
22801 else
22803 tail = regmatch.endp[0];
22804 if (*tail == NUL)
22805 break;
22807 if (!do_all)
22808 break;
22811 if (ga.ga_data != NULL)
22812 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22814 vim_free(regmatch.regprog);
22817 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22818 ga_clear(&ga);
22819 if (p_cpo == empty_option)
22820 p_cpo = save_cpo;
22821 else
22822 /* Darn, evaluating {sub} expression changed the value. */
22823 free_string_option(save_cpo);
22825 return ret;
22828 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */