feat/tagfunc: added functions for iterating over dictionary elements.
[vim_extended.git] / src / eval.c
blob295b9bdfd2aefb28ade2b7d1b2bda81080f1ad4a
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 *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 /* script-local variables */
870 for (i = 1; i <= ga_scripts.ga_len; ++i)
871 vars_clear(&SCRIPT_VARS(i));
872 ga_clear(&ga_scripts);
873 free_scriptnames();
875 /* global variables */
876 vars_clear(&globvarht);
878 /* autoloaded script names */
879 ga_clear_strings(&ga_loaded);
881 /* unreferenced lists and dicts */
882 (void)garbage_collect();
884 /* functions */
885 free_all_functions();
886 hash_clear(&func_hashtab);
888 #endif
891 * Return the name of the executed function.
893 char_u *
894 func_name(cookie)
895 void *cookie;
897 return ((funccall_T *)cookie)->func->uf_name;
901 * Return the address holding the next breakpoint line for a funccall cookie.
903 linenr_T *
904 func_breakpoint(cookie)
905 void *cookie;
907 return &((funccall_T *)cookie)->breakpoint;
911 * Return the address holding the debug tick for a funccall cookie.
913 int *
914 func_dbg_tick(cookie)
915 void *cookie;
917 return &((funccall_T *)cookie)->dbg_tick;
921 * Return the nesting level for a funccall cookie.
924 func_level(cookie)
925 void *cookie;
927 return ((funccall_T *)cookie)->level;
930 /* pointer to funccal for currently active function */
931 funccall_T *current_funccal = NULL;
933 /* pointer to list of previously used funccal, still around because some
934 * item in it is still being used. */
935 funccall_T *previous_funccal = NULL;
938 * Return TRUE when a function was ended by a ":return" command.
941 current_func_returned()
943 return current_funccal->returned;
948 * Set an internal variable to a string value. Creates the variable if it does
949 * not already exist.
951 void
952 set_internal_string_var(name, value)
953 char_u *name;
954 char_u *value;
956 char_u *val;
957 typval_T *tvp;
959 val = vim_strsave(value);
960 if (val != NULL)
962 tvp = alloc_string_tv(val);
963 if (tvp != NULL)
965 set_var(name, tvp, FALSE);
966 free_tv(tvp);
971 static lval_T *redir_lval = NULL;
972 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
973 static char_u *redir_endp = NULL;
974 static char_u *redir_varname = NULL;
977 * Start recording command output to a variable
978 * Returns OK if successfully completed the setup. FAIL otherwise.
981 var_redir_start(name, append)
982 char_u *name;
983 int append; /* append to an existing variable */
985 int save_emsg;
986 int err;
987 typval_T tv;
989 /* Catch a bad name early. */
990 if (!eval_isnamec1(*name))
992 EMSG(_(e_invarg));
993 return FAIL;
996 /* Make a copy of the name, it is used in redir_lval until redir ends. */
997 redir_varname = vim_strsave(name);
998 if (redir_varname == NULL)
999 return FAIL;
1001 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
1002 if (redir_lval == NULL)
1004 var_redir_stop();
1005 return FAIL;
1008 /* The output is stored in growarray "redir_ga" until redirection ends. */
1009 ga_init2(&redir_ga, (int)sizeof(char), 500);
1011 /* Parse the variable name (can be a dict or list entry). */
1012 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1013 FNE_CHECK_START);
1014 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1016 if (redir_endp != NULL && *redir_endp != NUL)
1017 /* Trailing characters are present after the variable name */
1018 EMSG(_(e_trailing));
1019 else
1020 EMSG(_(e_invarg));
1021 redir_endp = NULL; /* don't store a value, only cleanup */
1022 var_redir_stop();
1023 return FAIL;
1026 /* check if we can write to the variable: set it to or append an empty
1027 * string */
1028 save_emsg = did_emsg;
1029 did_emsg = FALSE;
1030 tv.v_type = VAR_STRING;
1031 tv.vval.v_string = (char_u *)"";
1032 if (append)
1033 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1034 else
1035 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1036 err = did_emsg;
1037 did_emsg |= save_emsg;
1038 if (err)
1040 redir_endp = NULL; /* don't store a value, only cleanup */
1041 var_redir_stop();
1042 return FAIL;
1044 if (redir_lval->ll_newkey != NULL)
1046 /* Dictionary item was created, don't do it again. */
1047 vim_free(redir_lval->ll_newkey);
1048 redir_lval->ll_newkey = NULL;
1051 return OK;
1055 * Append "value[value_len]" to the variable set by var_redir_start().
1056 * The actual appending is postponed until redirection ends, because the value
1057 * appended may in fact be the string we write to, changing it may cause freed
1058 * memory to be used:
1059 * :redir => foo
1060 * :let foo
1061 * :redir END
1063 void
1064 var_redir_str(value, value_len)
1065 char_u *value;
1066 int value_len;
1068 int len;
1070 if (redir_lval == NULL)
1071 return;
1073 if (value_len == -1)
1074 len = (int)STRLEN(value); /* Append the entire string */
1075 else
1076 len = value_len; /* Append only "value_len" characters */
1078 if (ga_grow(&redir_ga, len) == OK)
1080 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1081 redir_ga.ga_len += len;
1083 else
1084 var_redir_stop();
1088 * Stop redirecting command output to a variable.
1089 * Frees the allocated memory.
1091 void
1092 var_redir_stop()
1094 typval_T tv;
1096 if (redir_lval != NULL)
1098 /* If there was no error: assign the text to the variable. */
1099 if (redir_endp != NULL)
1101 ga_append(&redir_ga, NUL); /* Append the trailing NUL. */
1102 tv.v_type = VAR_STRING;
1103 tv.vval.v_string = redir_ga.ga_data;
1104 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1107 /* free the collected output */
1108 vim_free(redir_ga.ga_data);
1109 redir_ga.ga_data = NULL;
1111 clear_lval(redir_lval);
1112 vim_free(redir_lval);
1113 redir_lval = NULL;
1115 vim_free(redir_varname);
1116 redir_varname = NULL;
1119 # if defined(FEAT_MBYTE) || defined(PROTO)
1121 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1122 char_u *enc_from;
1123 char_u *enc_to;
1124 char_u *fname_from;
1125 char_u *fname_to;
1127 int err = FALSE;
1129 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1130 set_vim_var_string(VV_CC_TO, enc_to, -1);
1131 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1132 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1133 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1134 err = TRUE;
1135 set_vim_var_string(VV_CC_FROM, NULL, -1);
1136 set_vim_var_string(VV_CC_TO, NULL, -1);
1137 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1138 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1140 if (err)
1141 return FAIL;
1142 return OK;
1144 # endif
1146 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1148 eval_printexpr(fname, args)
1149 char_u *fname;
1150 char_u *args;
1152 int err = FALSE;
1154 set_vim_var_string(VV_FNAME_IN, fname, -1);
1155 set_vim_var_string(VV_CMDARG, args, -1);
1156 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1157 err = TRUE;
1158 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1159 set_vim_var_string(VV_CMDARG, NULL, -1);
1161 if (err)
1163 mch_remove(fname);
1164 return FAIL;
1166 return OK;
1168 # endif
1170 # if defined(FEAT_DIFF) || defined(PROTO)
1171 void
1172 eval_diff(origfile, newfile, outfile)
1173 char_u *origfile;
1174 char_u *newfile;
1175 char_u *outfile;
1177 int err = FALSE;
1179 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1180 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1181 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1182 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1183 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1184 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1185 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1188 void
1189 eval_patch(origfile, difffile, outfile)
1190 char_u *origfile;
1191 char_u *difffile;
1192 char_u *outfile;
1194 int err;
1196 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1197 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1198 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1199 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1200 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1201 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1202 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1204 # endif
1207 * Top level evaluation function, returning a boolean.
1208 * Sets "error" to TRUE if there was an error.
1209 * Return TRUE or FALSE.
1212 eval_to_bool(arg, error, nextcmd, skip)
1213 char_u *arg;
1214 int *error;
1215 char_u **nextcmd;
1216 int skip; /* only parse, don't execute */
1218 typval_T tv;
1219 int retval = FALSE;
1221 if (skip)
1222 ++emsg_skip;
1223 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1224 *error = TRUE;
1225 else
1227 *error = FALSE;
1228 if (!skip)
1230 retval = (get_tv_number_chk(&tv, error) != 0);
1231 clear_tv(&tv);
1234 if (skip)
1235 --emsg_skip;
1237 return retval;
1241 * Top level evaluation function, returning a string. If "skip" is TRUE,
1242 * only parsing to "nextcmd" is done, without reporting errors. Return
1243 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1245 char_u *
1246 eval_to_string_skip(arg, nextcmd, skip)
1247 char_u *arg;
1248 char_u **nextcmd;
1249 int skip; /* only parse, don't execute */
1251 typval_T tv;
1252 char_u *retval;
1254 if (skip)
1255 ++emsg_skip;
1256 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1257 retval = NULL;
1258 else
1260 retval = vim_strsave(get_tv_string(&tv));
1261 clear_tv(&tv);
1263 if (skip)
1264 --emsg_skip;
1266 return retval;
1270 * Skip over an expression at "*pp".
1271 * Return FAIL for an error, OK otherwise.
1274 skip_expr(pp)
1275 char_u **pp;
1277 typval_T rettv;
1279 *pp = skipwhite(*pp);
1280 return eval1(pp, &rettv, FALSE);
1284 * Top level evaluation function, returning a string.
1285 * When "convert" is TRUE convert a List into a sequence of lines and convert
1286 * a Float to a String.
1287 * Return pointer to allocated memory, or NULL for failure.
1289 char_u *
1290 eval_to_string(arg, nextcmd, convert)
1291 char_u *arg;
1292 char_u **nextcmd;
1293 int convert;
1295 typval_T tv;
1296 char_u *retval;
1297 garray_T ga;
1298 #ifdef FEAT_FLOAT
1299 char_u numbuf[NUMBUFLEN];
1300 #endif
1302 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1303 retval = NULL;
1304 else
1306 if (convert && tv.v_type == VAR_LIST)
1308 ga_init2(&ga, (int)sizeof(char), 80);
1309 if (tv.vval.v_list != NULL)
1310 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1311 ga_append(&ga, NUL);
1312 retval = (char_u *)ga.ga_data;
1314 #ifdef FEAT_FLOAT
1315 else if (convert && tv.v_type == VAR_FLOAT)
1317 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1318 retval = vim_strsave(numbuf);
1320 #endif
1321 else
1322 retval = vim_strsave(get_tv_string(&tv));
1323 clear_tv(&tv);
1326 return retval;
1330 * Call eval_to_string() without using current local variables and using
1331 * textlock. When "use_sandbox" is TRUE use the sandbox.
1333 char_u *
1334 eval_to_string_safe(arg, nextcmd, use_sandbox)
1335 char_u *arg;
1336 char_u **nextcmd;
1337 int use_sandbox;
1339 char_u *retval;
1340 void *save_funccalp;
1342 save_funccalp = save_funccal();
1343 if (use_sandbox)
1344 ++sandbox;
1345 ++textlock;
1346 retval = eval_to_string(arg, nextcmd, FALSE);
1347 if (use_sandbox)
1348 --sandbox;
1349 --textlock;
1350 restore_funccal(save_funccalp);
1351 return retval;
1355 * Top level evaluation function, returning a number.
1356 * Evaluates "expr" silently.
1357 * Returns -1 for an error.
1360 eval_to_number(expr)
1361 char_u *expr;
1363 typval_T rettv;
1364 int retval;
1365 char_u *p = skipwhite(expr);
1367 ++emsg_off;
1369 if (eval1(&p, &rettv, TRUE) == FAIL)
1370 retval = -1;
1371 else
1373 retval = get_tv_number_chk(&rettv, NULL);
1374 clear_tv(&rettv);
1376 --emsg_off;
1378 return retval;
1382 * Prepare v: variable "idx" to be used.
1383 * Save the current typeval in "save_tv".
1384 * When not used yet add the variable to the v: hashtable.
1386 static void
1387 prepare_vimvar(idx, save_tv)
1388 int idx;
1389 typval_T *save_tv;
1391 *save_tv = vimvars[idx].vv_tv;
1392 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1393 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1397 * Restore v: variable "idx" to typeval "save_tv".
1398 * When no longer defined, remove the variable from the v: hashtable.
1400 static void
1401 restore_vimvar(idx, save_tv)
1402 int idx;
1403 typval_T *save_tv;
1405 hashitem_T *hi;
1407 vimvars[idx].vv_tv = *save_tv;
1408 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1410 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1411 if (HASHITEM_EMPTY(hi))
1412 EMSG2(_(e_intern2), "restore_vimvar()");
1413 else
1414 hash_remove(&vimvarht, hi);
1418 #if defined(FEAT_SPELL) || defined(PROTO)
1420 * Evaluate an expression to a list with suggestions.
1421 * For the "expr:" part of 'spellsuggest'.
1422 * Returns NULL when there is an error.
1424 list_T *
1425 eval_spell_expr(badword, expr)
1426 char_u *badword;
1427 char_u *expr;
1429 typval_T save_val;
1430 typval_T rettv;
1431 list_T *list = NULL;
1432 char_u *p = skipwhite(expr);
1434 /* Set "v:val" to the bad word. */
1435 prepare_vimvar(VV_VAL, &save_val);
1436 vimvars[VV_VAL].vv_type = VAR_STRING;
1437 vimvars[VV_VAL].vv_str = badword;
1438 if (p_verbose == 0)
1439 ++emsg_off;
1441 if (eval1(&p, &rettv, TRUE) == OK)
1443 if (rettv.v_type != VAR_LIST)
1444 clear_tv(&rettv);
1445 else
1446 list = rettv.vval.v_list;
1449 if (p_verbose == 0)
1450 --emsg_off;
1451 restore_vimvar(VV_VAL, &save_val);
1453 return list;
1457 * "list" is supposed to contain two items: a word and a number. Return the
1458 * word in "pp" and the number as the return value.
1459 * Return -1 if anything isn't right.
1460 * Used to get the good word and score from the eval_spell_expr() result.
1463 get_spellword(list, pp)
1464 list_T *list;
1465 char_u **pp;
1467 listitem_T *li;
1469 li = list->lv_first;
1470 if (li == NULL)
1471 return -1;
1472 *pp = get_tv_string(&li->li_tv);
1474 li = li->li_next;
1475 if (li == NULL)
1476 return -1;
1477 return get_tv_number(&li->li_tv);
1479 #endif
1482 * Top level evaluation function.
1483 * Returns an allocated typval_T with the result.
1484 * Returns NULL when there is an error.
1486 typval_T *
1487 eval_expr(arg, nextcmd)
1488 char_u *arg;
1489 char_u **nextcmd;
1491 typval_T *tv;
1493 tv = (typval_T *)alloc(sizeof(typval_T));
1494 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1496 vim_free(tv);
1497 tv = NULL;
1500 return tv;
1504 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1505 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1507 * Call some vimL function and return the result in "*rettv".
1508 * Uses argv[argc] for the function arguments. Only Number and String
1509 * arguments are currently supported.
1510 * Returns OK or FAIL.
1512 static int
1513 call_vim_function(func, argc, argv, safe, rettv)
1514 char_u *func;
1515 int argc;
1516 char_u **argv;
1517 int safe; /* use the sandbox */
1518 typval_T *rettv;
1520 typval_T *argvars;
1521 long n;
1522 int len;
1523 int i;
1524 int doesrange;
1525 void *save_funccalp = NULL;
1526 int ret;
1528 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1529 if (argvars == NULL)
1530 return FAIL;
1532 for (i = 0; i < argc; i++)
1534 /* Pass a NULL or empty argument as an empty string */
1535 if (argv[i] == NULL || *argv[i] == NUL)
1537 argvars[i].v_type = VAR_STRING;
1538 argvars[i].vval.v_string = (char_u *)"";
1539 continue;
1542 /* Recognize a number argument, the others must be strings. */
1543 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1544 if (len != 0 && len == (int)STRLEN(argv[i]))
1546 argvars[i].v_type = VAR_NUMBER;
1547 argvars[i].vval.v_number = n;
1549 else
1551 argvars[i].v_type = VAR_STRING;
1552 argvars[i].vval.v_string = argv[i];
1556 if (safe)
1558 save_funccalp = save_funccal();
1559 ++sandbox;
1562 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1563 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1564 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1565 &doesrange, TRUE, NULL);
1566 if (safe)
1568 --sandbox;
1569 restore_funccal(save_funccalp);
1571 vim_free(argvars);
1573 if (ret == FAIL)
1574 clear_tv(rettv);
1576 return ret;
1579 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1581 * Call vimL function "func" and return the result as a string.
1582 * Returns NULL when calling the function fails.
1583 * Uses argv[argc] for the function arguments.
1585 void *
1586 call_func_retstr(func, argc, argv, safe)
1587 char_u *func;
1588 int argc;
1589 char_u **argv;
1590 int safe; /* use the sandbox */
1592 typval_T rettv;
1593 char_u *retval;
1595 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1596 return NULL;
1598 retval = vim_strsave(get_tv_string(&rettv));
1599 clear_tv(&rettv);
1600 return retval;
1602 # endif
1604 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1606 * Call vimL function "func" and return the result as a number.
1607 * Returns -1 when calling the function fails.
1608 * Uses argv[argc] for the function arguments.
1610 long
1611 call_func_retnr(func, argc, argv, safe)
1612 char_u *func;
1613 int argc;
1614 char_u **argv;
1615 int safe; /* use the sandbox */
1617 typval_T rettv;
1618 long retval;
1620 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1621 return -1;
1623 retval = get_tv_number_chk(&rettv, NULL);
1624 clear_tv(&rettv);
1625 return retval;
1627 # endif
1630 * Call vimL function "func" and return the result as a List.
1631 * Uses argv[argc] for the function arguments.
1632 * Returns NULL when there is something wrong.
1634 void *
1635 call_func_retlist(func, argc, argv, safe)
1636 char_u *func;
1637 int argc;
1638 char_u **argv;
1639 int safe; /* use the sandbox */
1641 typval_T rettv;
1643 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1644 return NULL;
1646 if (rettv.v_type != VAR_LIST)
1648 clear_tv(&rettv);
1649 return NULL;
1652 return rettv.vval.v_list;
1654 #endif
1658 * Save the current function call pointer, and set it to NULL.
1659 * Used when executing autocommands and for ":source".
1661 void *
1662 save_funccal()
1664 funccall_T *fc = current_funccal;
1666 current_funccal = NULL;
1667 return (void *)fc;
1670 void
1671 restore_funccal(vfc)
1672 void *vfc;
1674 funccall_T *fc = (funccall_T *)vfc;
1676 current_funccal = fc;
1679 #if defined(FEAT_PROFILE) || defined(PROTO)
1681 * Prepare profiling for entering a child or something else that is not
1682 * counted for the script/function itself.
1683 * Should always be called in pair with prof_child_exit().
1685 void
1686 prof_child_enter(tm)
1687 proftime_T *tm; /* place to store waittime */
1689 funccall_T *fc = current_funccal;
1691 if (fc != NULL && fc->func->uf_profiling)
1692 profile_start(&fc->prof_child);
1693 script_prof_save(tm);
1697 * Take care of time spent in a child.
1698 * Should always be called after prof_child_enter().
1700 void
1701 prof_child_exit(tm)
1702 proftime_T *tm; /* where waittime was stored */
1704 funccall_T *fc = current_funccal;
1706 if (fc != NULL && fc->func->uf_profiling)
1708 profile_end(&fc->prof_child);
1709 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1710 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1711 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1713 script_prof_restore(tm);
1715 #endif
1718 #ifdef FEAT_FOLDING
1720 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1721 * it in "*cp". Doesn't give error messages.
1724 eval_foldexpr(arg, cp)
1725 char_u *arg;
1726 int *cp;
1728 typval_T tv;
1729 int retval;
1730 char_u *s;
1731 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1732 OPT_LOCAL);
1734 ++emsg_off;
1735 if (use_sandbox)
1736 ++sandbox;
1737 ++textlock;
1738 *cp = NUL;
1739 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1740 retval = 0;
1741 else
1743 /* If the result is a number, just return the number. */
1744 if (tv.v_type == VAR_NUMBER)
1745 retval = tv.vval.v_number;
1746 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1747 retval = 0;
1748 else
1750 /* If the result is a string, check if there is a non-digit before
1751 * the number. */
1752 s = tv.vval.v_string;
1753 if (!VIM_ISDIGIT(*s) && *s != '-')
1754 *cp = *s++;
1755 retval = atol((char *)s);
1757 clear_tv(&tv);
1759 --emsg_off;
1760 if (use_sandbox)
1761 --sandbox;
1762 --textlock;
1764 return retval;
1766 #endif
1769 * ":let" list all variable values
1770 * ":let var1 var2" list variable values
1771 * ":let var = expr" assignment command.
1772 * ":let var += expr" assignment command.
1773 * ":let var -= expr" assignment command.
1774 * ":let var .= expr" assignment command.
1775 * ":let [var1, var2] = expr" unpack list.
1777 void
1778 ex_let(eap)
1779 exarg_T *eap;
1781 char_u *arg = eap->arg;
1782 char_u *expr = NULL;
1783 typval_T rettv;
1784 int i;
1785 int var_count = 0;
1786 int semicolon = 0;
1787 char_u op[2];
1788 char_u *argend;
1789 int first = TRUE;
1791 argend = skip_var_list(arg, &var_count, &semicolon);
1792 if (argend == NULL)
1793 return;
1794 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1795 --argend;
1796 expr = vim_strchr(argend, '=');
1797 if (expr == NULL)
1800 * ":let" without "=": list variables
1802 if (*arg == '[')
1803 EMSG(_(e_invarg));
1804 else if (!ends_excmd(*arg))
1805 /* ":let var1 var2" */
1806 arg = list_arg_vars(eap, arg, &first);
1807 else if (!eap->skip)
1809 /* ":let" */
1810 list_glob_vars(&first);
1811 list_buf_vars(&first);
1812 list_win_vars(&first);
1813 #ifdef FEAT_WINDOWS
1814 list_tab_vars(&first);
1815 #endif
1816 list_script_vars(&first);
1817 list_func_vars(&first);
1818 list_vim_vars(&first);
1820 eap->nextcmd = check_nextcmd(arg);
1822 else
1824 op[0] = '=';
1825 op[1] = NUL;
1826 if (expr > argend)
1828 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1829 op[0] = expr[-1]; /* +=, -= or .= */
1831 expr = skipwhite(expr + 1);
1833 if (eap->skip)
1834 ++emsg_skip;
1835 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1836 if (eap->skip)
1838 if (i != FAIL)
1839 clear_tv(&rettv);
1840 --emsg_skip;
1842 else if (i != FAIL)
1844 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1845 op);
1846 clear_tv(&rettv);
1852 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1853 * Handles both "var" with any type and "[var, var; var]" with a list type.
1854 * When "nextchars" is not NULL it points to a string with characters that
1855 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1856 * or concatenate.
1857 * Returns OK or FAIL;
1859 static int
1860 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1861 char_u *arg_start;
1862 typval_T *tv;
1863 int copy; /* copy values from "tv", don't move */
1864 int semicolon; /* from skip_var_list() */
1865 int var_count; /* from skip_var_list() */
1866 char_u *nextchars;
1868 char_u *arg = arg_start;
1869 list_T *l;
1870 int i;
1871 listitem_T *item;
1872 typval_T ltv;
1874 if (*arg != '[')
1877 * ":let var = expr" or ":for var in list"
1879 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1880 return FAIL;
1881 return OK;
1885 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1887 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1889 EMSG(_(e_listreq));
1890 return FAIL;
1893 i = list_len(l);
1894 if (semicolon == 0 && var_count < i)
1896 EMSG(_("E687: Less targets than List items"));
1897 return FAIL;
1899 if (var_count - semicolon > i)
1901 EMSG(_("E688: More targets than List items"));
1902 return FAIL;
1905 item = l->lv_first;
1906 while (*arg != ']')
1908 arg = skipwhite(arg + 1);
1909 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1910 item = item->li_next;
1911 if (arg == NULL)
1912 return FAIL;
1914 arg = skipwhite(arg);
1915 if (*arg == ';')
1917 /* Put the rest of the list (may be empty) in the var after ';'.
1918 * Create a new list for this. */
1919 l = list_alloc();
1920 if (l == NULL)
1921 return FAIL;
1922 while (item != NULL)
1924 list_append_tv(l, &item->li_tv);
1925 item = item->li_next;
1928 ltv.v_type = VAR_LIST;
1929 ltv.v_lock = 0;
1930 ltv.vval.v_list = l;
1931 l->lv_refcount = 1;
1933 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1934 (char_u *)"]", nextchars);
1935 clear_tv(&ltv);
1936 if (arg == NULL)
1937 return FAIL;
1938 break;
1940 else if (*arg != ',' && *arg != ']')
1942 EMSG2(_(e_intern2), "ex_let_vars()");
1943 return FAIL;
1947 return OK;
1951 * Skip over assignable variable "var" or list of variables "[var, var]".
1952 * Used for ":let varvar = expr" and ":for varvar in expr".
1953 * For "[var, var]" increment "*var_count" for each variable.
1954 * for "[var, var; var]" set "semicolon".
1955 * Return NULL for an error.
1957 static char_u *
1958 skip_var_list(arg, var_count, semicolon)
1959 char_u *arg;
1960 int *var_count;
1961 int *semicolon;
1963 char_u *p, *s;
1965 if (*arg == '[')
1967 /* "[var, var]": find the matching ']'. */
1968 p = arg;
1969 for (;;)
1971 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1972 s = skip_var_one(p);
1973 if (s == p)
1975 EMSG2(_(e_invarg2), p);
1976 return NULL;
1978 ++*var_count;
1980 p = skipwhite(s);
1981 if (*p == ']')
1982 break;
1983 else if (*p == ';')
1985 if (*semicolon == 1)
1987 EMSG(_("Double ; in list of variables"));
1988 return NULL;
1990 *semicolon = 1;
1992 else if (*p != ',')
1994 EMSG2(_(e_invarg2), p);
1995 return NULL;
1998 return p + 1;
2000 else
2001 return skip_var_one(arg);
2005 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
2006 * l[idx].
2008 static char_u *
2009 skip_var_one(arg)
2010 char_u *arg;
2012 if (*arg == '@' && arg[1] != NUL)
2013 return arg + 2;
2014 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2015 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2019 * List variables for hashtab "ht" with prefix "prefix".
2020 * If "empty" is TRUE also list NULL strings as empty strings.
2022 static void
2023 list_hashtable_vars(ht, prefix, empty, first)
2024 hashtab_T *ht;
2025 char_u *prefix;
2026 int empty;
2027 int *first;
2029 hashitem_T *hi;
2030 dictitem_T *di;
2031 int todo;
2033 todo = (int)ht->ht_used;
2034 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2036 if (!HASHITEM_EMPTY(hi))
2038 --todo;
2039 di = HI2DI(hi);
2040 if (empty || di->di_tv.v_type != VAR_STRING
2041 || di->di_tv.vval.v_string != NULL)
2042 list_one_var(di, prefix, first);
2048 * List global variables.
2050 static void
2051 list_glob_vars(first)
2052 int *first;
2054 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2058 * List buffer variables.
2060 static void
2061 list_buf_vars(first)
2062 int *first;
2064 char_u numbuf[NUMBUFLEN];
2066 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2067 TRUE, first);
2069 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2070 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2071 numbuf, first);
2075 * List window variables.
2077 static void
2078 list_win_vars(first)
2079 int *first;
2081 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2082 (char_u *)"w:", TRUE, first);
2085 #ifdef FEAT_WINDOWS
2087 * List tab page variables.
2089 static void
2090 list_tab_vars(first)
2091 int *first;
2093 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2094 (char_u *)"t:", TRUE, first);
2096 #endif
2099 * List Vim variables.
2101 static void
2102 list_vim_vars(first)
2103 int *first;
2105 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2109 * List script-local variables, if there is a script.
2111 static void
2112 list_script_vars(first)
2113 int *first;
2115 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2116 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2117 (char_u *)"s:", FALSE, first);
2121 * List function variables, if there is a function.
2123 static void
2124 list_func_vars(first)
2125 int *first;
2127 if (current_funccal != NULL)
2128 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2129 (char_u *)"l:", FALSE, first);
2133 * List variables in "arg".
2135 static char_u *
2136 list_arg_vars(eap, arg, first)
2137 exarg_T *eap;
2138 char_u *arg;
2139 int *first;
2141 int error = FALSE;
2142 int len;
2143 char_u *name;
2144 char_u *name_start;
2145 char_u *arg_subsc;
2146 char_u *tofree;
2147 typval_T tv;
2149 while (!ends_excmd(*arg) && !got_int)
2151 if (error || eap->skip)
2153 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2154 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2156 emsg_severe = TRUE;
2157 EMSG(_(e_trailing));
2158 break;
2161 else
2163 /* get_name_len() takes care of expanding curly braces */
2164 name_start = name = arg;
2165 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2166 if (len <= 0)
2168 /* This is mainly to keep test 49 working: when expanding
2169 * curly braces fails overrule the exception error message. */
2170 if (len < 0 && !aborting())
2172 emsg_severe = TRUE;
2173 EMSG2(_(e_invarg2), arg);
2174 break;
2176 error = TRUE;
2178 else
2180 if (tofree != NULL)
2181 name = tofree;
2182 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2183 error = TRUE;
2184 else
2186 /* handle d.key, l[idx], f(expr) */
2187 arg_subsc = arg;
2188 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2189 error = TRUE;
2190 else
2192 if (arg == arg_subsc && len == 2 && name[1] == ':')
2194 switch (*name)
2196 case 'g': list_glob_vars(first); break;
2197 case 'b': list_buf_vars(first); break;
2198 case 'w': list_win_vars(first); break;
2199 #ifdef FEAT_WINDOWS
2200 case 't': list_tab_vars(first); break;
2201 #endif
2202 case 'v': list_vim_vars(first); break;
2203 case 's': list_script_vars(first); break;
2204 case 'l': list_func_vars(first); break;
2205 default:
2206 EMSG2(_("E738: Can't list variables for %s"), name);
2209 else
2211 char_u numbuf[NUMBUFLEN];
2212 char_u *tf;
2213 int c;
2214 char_u *s;
2216 s = echo_string(&tv, &tf, numbuf, 0);
2217 c = *arg;
2218 *arg = NUL;
2219 list_one_var_a((char_u *)"",
2220 arg == arg_subsc ? name : name_start,
2221 tv.v_type,
2222 s == NULL ? (char_u *)"" : s,
2223 first);
2224 *arg = c;
2225 vim_free(tf);
2227 clear_tv(&tv);
2232 vim_free(tofree);
2235 arg = skipwhite(arg);
2238 return arg;
2242 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2243 * Returns a pointer to the char just after the var name.
2244 * Returns NULL if there is an error.
2246 static char_u *
2247 ex_let_one(arg, tv, copy, endchars, op)
2248 char_u *arg; /* points to variable name */
2249 typval_T *tv; /* value to assign to variable */
2250 int copy; /* copy value from "tv" */
2251 char_u *endchars; /* valid chars after variable name or NULL */
2252 char_u *op; /* "+", "-", "." or NULL*/
2254 int c1;
2255 char_u *name;
2256 char_u *p;
2257 char_u *arg_end = NULL;
2258 int len;
2259 int opt_flags;
2260 char_u *tofree = NULL;
2263 * ":let $VAR = expr": Set environment variable.
2265 if (*arg == '$')
2267 /* Find the end of the name. */
2268 ++arg;
2269 name = arg;
2270 len = get_env_len(&arg);
2271 if (len == 0)
2272 EMSG2(_(e_invarg2), name - 1);
2273 else
2275 if (op != NULL && (*op == '+' || *op == '-'))
2276 EMSG2(_(e_letwrong), op);
2277 else if (endchars != NULL
2278 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2279 EMSG(_(e_letunexp));
2280 else
2282 c1 = name[len];
2283 name[len] = NUL;
2284 p = get_tv_string_chk(tv);
2285 if (p != NULL && op != NULL && *op == '.')
2287 int mustfree = FALSE;
2288 char_u *s = vim_getenv(name, &mustfree);
2290 if (s != NULL)
2292 p = tofree = concat_str(s, p);
2293 if (mustfree)
2294 vim_free(s);
2297 if (p != NULL)
2299 vim_setenv(name, p);
2300 if (STRICMP(name, "HOME") == 0)
2301 init_homedir();
2302 else if (didset_vim && STRICMP(name, "VIM") == 0)
2303 didset_vim = FALSE;
2304 else if (didset_vimruntime
2305 && STRICMP(name, "VIMRUNTIME") == 0)
2306 didset_vimruntime = FALSE;
2307 arg_end = arg;
2309 name[len] = c1;
2310 vim_free(tofree);
2316 * ":let &option = expr": Set option value.
2317 * ":let &l:option = expr": Set local option value.
2318 * ":let &g:option = expr": Set global option value.
2320 else if (*arg == '&')
2322 /* Find the end of the name. */
2323 p = find_option_end(&arg, &opt_flags);
2324 if (p == NULL || (endchars != NULL
2325 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2326 EMSG(_(e_letunexp));
2327 else
2329 long n;
2330 int opt_type;
2331 long numval;
2332 char_u *stringval = NULL;
2333 char_u *s;
2335 c1 = *p;
2336 *p = NUL;
2338 n = get_tv_number(tv);
2339 s = get_tv_string_chk(tv); /* != NULL if number or string */
2340 if (s != NULL && op != NULL && *op != '=')
2342 opt_type = get_option_value(arg, &numval,
2343 &stringval, opt_flags);
2344 if ((opt_type == 1 && *op == '.')
2345 || (opt_type == 0 && *op != '.'))
2346 EMSG2(_(e_letwrong), op);
2347 else
2349 if (opt_type == 1) /* number */
2351 if (*op == '+')
2352 n = numval + n;
2353 else
2354 n = numval - n;
2356 else if (opt_type == 0 && stringval != NULL) /* string */
2358 s = concat_str(stringval, s);
2359 vim_free(stringval);
2360 stringval = s;
2364 if (s != NULL)
2366 set_option_value(arg, n, s, opt_flags);
2367 arg_end = p;
2369 *p = c1;
2370 vim_free(stringval);
2375 * ":let @r = expr": Set register contents.
2377 else if (*arg == '@')
2379 ++arg;
2380 if (op != NULL && (*op == '+' || *op == '-'))
2381 EMSG2(_(e_letwrong), op);
2382 else if (endchars != NULL
2383 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2384 EMSG(_(e_letunexp));
2385 else
2387 char_u *ptofree = NULL;
2388 char_u *s;
2390 p = get_tv_string_chk(tv);
2391 if (p != NULL && op != NULL && *op == '.')
2393 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2394 if (s != NULL)
2396 p = ptofree = concat_str(s, p);
2397 vim_free(s);
2400 if (p != NULL)
2402 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2403 arg_end = arg + 1;
2405 vim_free(ptofree);
2410 * ":let var = expr": Set internal variable.
2411 * ":let {expr} = expr": Idem, name made with curly braces
2413 else if (eval_isnamec1(*arg) || *arg == '{')
2415 lval_T lv;
2417 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2418 if (p != NULL && lv.ll_name != NULL)
2420 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2421 EMSG(_(e_letunexp));
2422 else
2424 set_var_lval(&lv, p, tv, copy, op);
2425 arg_end = p;
2428 clear_lval(&lv);
2431 else
2432 EMSG2(_(e_invarg2), arg);
2434 return arg_end;
2438 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2440 static int
2441 check_changedtick(arg)
2442 char_u *arg;
2444 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2446 EMSG2(_(e_readonlyvar), arg);
2447 return TRUE;
2449 return FALSE;
2453 * Get an lval: variable, Dict item or List item that can be assigned a value
2454 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2455 * "name.key", "name.key[expr]" etc.
2456 * Indexing only works if "name" is an existing List or Dictionary.
2457 * "name" points to the start of the name.
2458 * If "rettv" is not NULL it points to the value to be assigned.
2459 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2460 * wrong; must end in space or cmd separator.
2462 * Returns a pointer to just after the name, including indexes.
2463 * When an evaluation error occurs "lp->ll_name" is NULL;
2464 * Returns NULL for a parsing error. Still need to free items in "lp"!
2466 static char_u *
2467 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2468 char_u *name;
2469 typval_T *rettv;
2470 lval_T *lp;
2471 int unlet;
2472 int skip;
2473 int quiet; /* don't give error messages */
2474 int fne_flags; /* flags for find_name_end() */
2476 char_u *p;
2477 char_u *expr_start, *expr_end;
2478 int cc;
2479 dictitem_T *v;
2480 typval_T var1;
2481 typval_T var2;
2482 int empty1 = FALSE;
2483 listitem_T *ni;
2484 char_u *key = NULL;
2485 int len;
2486 hashtab_T *ht;
2488 /* Clear everything in "lp". */
2489 vim_memset(lp, 0, sizeof(lval_T));
2491 if (skip)
2493 /* When skipping just find the end of the name. */
2494 lp->ll_name = name;
2495 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2498 /* Find the end of the name. */
2499 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2500 if (expr_start != NULL)
2502 /* Don't expand the name when we already know there is an error. */
2503 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2504 && *p != '[' && *p != '.')
2506 EMSG(_(e_trailing));
2507 return NULL;
2510 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2511 if (lp->ll_exp_name == NULL)
2513 /* Report an invalid expression in braces, unless the
2514 * expression evaluation has been cancelled due to an
2515 * aborting error, an interrupt, or an exception. */
2516 if (!aborting() && !quiet)
2518 emsg_severe = TRUE;
2519 EMSG2(_(e_invarg2), name);
2520 return NULL;
2523 lp->ll_name = lp->ll_exp_name;
2525 else
2526 lp->ll_name = name;
2528 /* Without [idx] or .key we are done. */
2529 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2530 return p;
2532 cc = *p;
2533 *p = NUL;
2534 v = find_var(lp->ll_name, &ht);
2535 if (v == NULL && !quiet)
2536 EMSG2(_(e_undefvar), lp->ll_name);
2537 *p = cc;
2538 if (v == NULL)
2539 return NULL;
2542 * Loop until no more [idx] or .key is following.
2544 lp->ll_tv = &v->di_tv;
2545 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2547 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2548 && !(lp->ll_tv->v_type == VAR_DICT
2549 && lp->ll_tv->vval.v_dict != NULL))
2551 if (!quiet)
2552 EMSG(_("E689: Can only index a List or Dictionary"));
2553 return NULL;
2555 if (lp->ll_range)
2557 if (!quiet)
2558 EMSG(_("E708: [:] must come last"));
2559 return NULL;
2562 len = -1;
2563 if (*p == '.')
2565 key = p + 1;
2566 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2568 if (len == 0)
2570 if (!quiet)
2571 EMSG(_(e_emptykey));
2572 return NULL;
2574 p = key + len;
2576 else
2578 /* Get the index [expr] or the first index [expr: ]. */
2579 p = skipwhite(p + 1);
2580 if (*p == ':')
2581 empty1 = TRUE;
2582 else
2584 empty1 = FALSE;
2585 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2586 return NULL;
2587 if (get_tv_string_chk(&var1) == NULL)
2589 /* not a number or string */
2590 clear_tv(&var1);
2591 return NULL;
2595 /* Optionally get the second index [ :expr]. */
2596 if (*p == ':')
2598 if (lp->ll_tv->v_type == VAR_DICT)
2600 if (!quiet)
2601 EMSG(_(e_dictrange));
2602 if (!empty1)
2603 clear_tv(&var1);
2604 return NULL;
2606 if (rettv != NULL && (rettv->v_type != VAR_LIST
2607 || rettv->vval.v_list == NULL))
2609 if (!quiet)
2610 EMSG(_("E709: [:] requires a List value"));
2611 if (!empty1)
2612 clear_tv(&var1);
2613 return NULL;
2615 p = skipwhite(p + 1);
2616 if (*p == ']')
2617 lp->ll_empty2 = TRUE;
2618 else
2620 lp->ll_empty2 = FALSE;
2621 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2623 if (!empty1)
2624 clear_tv(&var1);
2625 return NULL;
2627 if (get_tv_string_chk(&var2) == NULL)
2629 /* not a number or string */
2630 if (!empty1)
2631 clear_tv(&var1);
2632 clear_tv(&var2);
2633 return NULL;
2636 lp->ll_range = TRUE;
2638 else
2639 lp->ll_range = FALSE;
2641 if (*p != ']')
2643 if (!quiet)
2644 EMSG(_(e_missbrac));
2645 if (!empty1)
2646 clear_tv(&var1);
2647 if (lp->ll_range && !lp->ll_empty2)
2648 clear_tv(&var2);
2649 return NULL;
2652 /* Skip to past ']'. */
2653 ++p;
2656 if (lp->ll_tv->v_type == VAR_DICT)
2658 if (len == -1)
2660 /* "[key]": get key from "var1" */
2661 key = get_tv_string(&var1); /* is number or string */
2662 if (*key == NUL)
2664 if (!quiet)
2665 EMSG(_(e_emptykey));
2666 clear_tv(&var1);
2667 return NULL;
2670 lp->ll_list = NULL;
2671 lp->ll_dict = lp->ll_tv->vval.v_dict;
2672 lp->ll_di = dict_find(lp->ll_dict, key, len);
2673 if (lp->ll_di == NULL)
2675 /* Key does not exist in dict: may need to add it. */
2676 if (*p == '[' || *p == '.' || unlet)
2678 if (!quiet)
2679 EMSG2(_(e_dictkey), key);
2680 if (len == -1)
2681 clear_tv(&var1);
2682 return NULL;
2684 if (len == -1)
2685 lp->ll_newkey = vim_strsave(key);
2686 else
2687 lp->ll_newkey = vim_strnsave(key, len);
2688 if (len == -1)
2689 clear_tv(&var1);
2690 if (lp->ll_newkey == NULL)
2691 p = NULL;
2692 break;
2694 if (len == -1)
2695 clear_tv(&var1);
2696 lp->ll_tv = &lp->ll_di->di_tv;
2698 else
2701 * Get the number and item for the only or first index of the List.
2703 if (empty1)
2704 lp->ll_n1 = 0;
2705 else
2707 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2708 clear_tv(&var1);
2710 lp->ll_dict = NULL;
2711 lp->ll_list = lp->ll_tv->vval.v_list;
2712 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2713 if (lp->ll_li == NULL)
2715 if (lp->ll_n1 < 0)
2717 lp->ll_n1 = 0;
2718 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2721 if (lp->ll_li == NULL)
2723 if (lp->ll_range && !lp->ll_empty2)
2724 clear_tv(&var2);
2725 return NULL;
2729 * May need to find the item or absolute index for the second
2730 * index of a range.
2731 * When no index given: "lp->ll_empty2" is TRUE.
2732 * Otherwise "lp->ll_n2" is set to the second index.
2734 if (lp->ll_range && !lp->ll_empty2)
2736 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2737 clear_tv(&var2);
2738 if (lp->ll_n2 < 0)
2740 ni = list_find(lp->ll_list, lp->ll_n2);
2741 if (ni == NULL)
2742 return NULL;
2743 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2746 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2747 if (lp->ll_n1 < 0)
2748 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2749 if (lp->ll_n2 < lp->ll_n1)
2750 return NULL;
2753 lp->ll_tv = &lp->ll_li->li_tv;
2757 return p;
2761 * Clear lval "lp" that was filled by get_lval().
2763 static void
2764 clear_lval(lp)
2765 lval_T *lp;
2767 vim_free(lp->ll_exp_name);
2768 vim_free(lp->ll_newkey);
2772 * Set a variable that was parsed by get_lval() to "rettv".
2773 * "endp" points to just after the parsed name.
2774 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2776 static void
2777 set_var_lval(lp, endp, rettv, copy, op)
2778 lval_T *lp;
2779 char_u *endp;
2780 typval_T *rettv;
2781 int copy;
2782 char_u *op;
2784 int cc;
2785 listitem_T *ri;
2786 dictitem_T *di;
2788 if (lp->ll_tv == NULL)
2790 if (!check_changedtick(lp->ll_name))
2792 cc = *endp;
2793 *endp = NUL;
2794 if (op != NULL && *op != '=')
2796 typval_T tv;
2798 /* handle +=, -= and .= */
2799 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2800 &tv, TRUE) == OK)
2802 if (tv_op(&tv, rettv, op) == OK)
2803 set_var(lp->ll_name, &tv, FALSE);
2804 clear_tv(&tv);
2807 else
2808 set_var(lp->ll_name, rettv, copy);
2809 *endp = cc;
2812 else if (tv_check_lock(lp->ll_newkey == NULL
2813 ? lp->ll_tv->v_lock
2814 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2816 else if (lp->ll_range)
2819 * Assign the List values to the list items.
2821 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2823 if (op != NULL && *op != '=')
2824 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2825 else
2827 clear_tv(&lp->ll_li->li_tv);
2828 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2830 ri = ri->li_next;
2831 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2832 break;
2833 if (lp->ll_li->li_next == NULL)
2835 /* Need to add an empty item. */
2836 if (list_append_number(lp->ll_list, 0) == FAIL)
2838 ri = NULL;
2839 break;
2842 lp->ll_li = lp->ll_li->li_next;
2843 ++lp->ll_n1;
2845 if (ri != NULL)
2846 EMSG(_("E710: List value has more items than target"));
2847 else if (lp->ll_empty2
2848 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2849 : lp->ll_n1 != lp->ll_n2)
2850 EMSG(_("E711: List value has not enough items"));
2852 else
2855 * Assign to a List or Dictionary item.
2857 if (lp->ll_newkey != NULL)
2859 if (op != NULL && *op != '=')
2861 EMSG2(_(e_letwrong), op);
2862 return;
2865 /* Need to add an item to the Dictionary. */
2866 di = dictitem_alloc(lp->ll_newkey);
2867 if (di == NULL)
2868 return;
2869 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2871 vim_free(di);
2872 return;
2874 lp->ll_tv = &di->di_tv;
2876 else if (op != NULL && *op != '=')
2878 tv_op(lp->ll_tv, rettv, op);
2879 return;
2881 else
2882 clear_tv(lp->ll_tv);
2885 * Assign the value to the variable or list item.
2887 if (copy)
2888 copy_tv(rettv, lp->ll_tv);
2889 else
2891 *lp->ll_tv = *rettv;
2892 lp->ll_tv->v_lock = 0;
2893 init_tv(rettv);
2899 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2900 * Returns OK or FAIL.
2902 static int
2903 tv_op(tv1, tv2, op)
2904 typval_T *tv1;
2905 typval_T *tv2;
2906 char_u *op;
2908 long n;
2909 char_u numbuf[NUMBUFLEN];
2910 char_u *s;
2912 /* Can't do anything with a Funcref or a Dict on the right. */
2913 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2915 switch (tv1->v_type)
2917 case VAR_DICT:
2918 case VAR_FUNC:
2919 break;
2921 case VAR_LIST:
2922 if (*op != '+' || tv2->v_type != VAR_LIST)
2923 break;
2924 /* List += List */
2925 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2926 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2927 return OK;
2929 case VAR_NUMBER:
2930 case VAR_STRING:
2931 if (tv2->v_type == VAR_LIST)
2932 break;
2933 if (*op == '+' || *op == '-')
2935 /* nr += nr or nr -= nr*/
2936 n = get_tv_number(tv1);
2937 #ifdef FEAT_FLOAT
2938 if (tv2->v_type == VAR_FLOAT)
2940 float_T f = n;
2942 if (*op == '+')
2943 f += tv2->vval.v_float;
2944 else
2945 f -= tv2->vval.v_float;
2946 clear_tv(tv1);
2947 tv1->v_type = VAR_FLOAT;
2948 tv1->vval.v_float = f;
2950 else
2951 #endif
2953 if (*op == '+')
2954 n += get_tv_number(tv2);
2955 else
2956 n -= get_tv_number(tv2);
2957 clear_tv(tv1);
2958 tv1->v_type = VAR_NUMBER;
2959 tv1->vval.v_number = n;
2962 else
2964 if (tv2->v_type == VAR_FLOAT)
2965 break;
2967 /* str .= str */
2968 s = get_tv_string(tv1);
2969 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2970 clear_tv(tv1);
2971 tv1->v_type = VAR_STRING;
2972 tv1->vval.v_string = s;
2974 return OK;
2976 #ifdef FEAT_FLOAT
2977 case VAR_FLOAT:
2979 float_T f;
2981 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2982 && tv2->v_type != VAR_NUMBER
2983 && tv2->v_type != VAR_STRING))
2984 break;
2985 if (tv2->v_type == VAR_FLOAT)
2986 f = tv2->vval.v_float;
2987 else
2988 f = get_tv_number(tv2);
2989 if (*op == '+')
2990 tv1->vval.v_float += f;
2991 else
2992 tv1->vval.v_float -= f;
2994 return OK;
2995 #endif
2999 EMSG2(_(e_letwrong), op);
3000 return FAIL;
3004 * Add a watcher to a list.
3006 static void
3007 list_add_watch(l, lw)
3008 list_T *l;
3009 listwatch_T *lw;
3011 lw->lw_next = l->lv_watch;
3012 l->lv_watch = lw;
3016 * Remove a watcher from a list.
3017 * No warning when it isn't found...
3019 static void
3020 list_rem_watch(l, lwrem)
3021 list_T *l;
3022 listwatch_T *lwrem;
3024 listwatch_T *lw, **lwp;
3026 lwp = &l->lv_watch;
3027 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3029 if (lw == lwrem)
3031 *lwp = lw->lw_next;
3032 break;
3034 lwp = &lw->lw_next;
3039 * Just before removing an item from a list: advance watchers to the next
3040 * item.
3042 static void
3043 list_fix_watch(l, item)
3044 list_T *l;
3045 listitem_T *item;
3047 listwatch_T *lw;
3049 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3050 if (lw->lw_item == item)
3051 lw->lw_item = item->li_next;
3055 * Evaluate the expression used in a ":for var in expr" command.
3056 * "arg" points to "var".
3057 * Set "*errp" to TRUE for an error, FALSE otherwise;
3058 * Return a pointer that holds the info. Null when there is an error.
3060 void *
3061 eval_for_line(arg, errp, nextcmdp, skip)
3062 char_u *arg;
3063 int *errp;
3064 char_u **nextcmdp;
3065 int skip;
3067 forinfo_T *fi;
3068 char_u *expr;
3069 typval_T tv;
3070 list_T *l;
3072 *errp = TRUE; /* default: there is an error */
3074 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3075 if (fi == NULL)
3076 return NULL;
3078 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3079 if (expr == NULL)
3080 return fi;
3082 expr = skipwhite(expr);
3083 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3085 EMSG(_("E690: Missing \"in\" after :for"));
3086 return fi;
3089 if (skip)
3090 ++emsg_skip;
3091 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3093 *errp = FALSE;
3094 if (!skip)
3096 l = tv.vval.v_list;
3097 if (tv.v_type != VAR_LIST || l == NULL)
3099 EMSG(_(e_listreq));
3100 clear_tv(&tv);
3102 else
3104 /* No need to increment the refcount, it's already set for the
3105 * list being used in "tv". */
3106 fi->fi_list = l;
3107 list_add_watch(l, &fi->fi_lw);
3108 fi->fi_lw.lw_item = l->lv_first;
3112 if (skip)
3113 --emsg_skip;
3115 return fi;
3119 * Use the first item in a ":for" list. Advance to the next.
3120 * Assign the values to the variable (list). "arg" points to the first one.
3121 * Return TRUE when a valid item was found, FALSE when at end of list or
3122 * something wrong.
3125 next_for_item(fi_void, arg)
3126 void *fi_void;
3127 char_u *arg;
3129 forinfo_T *fi = (forinfo_T *)fi_void;
3130 int result;
3131 listitem_T *item;
3133 item = fi->fi_lw.lw_item;
3134 if (item == NULL)
3135 result = FALSE;
3136 else
3138 fi->fi_lw.lw_item = item->li_next;
3139 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3140 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3142 return result;
3146 * Free the structure used to store info used by ":for".
3148 void
3149 free_for_info(fi_void)
3150 void *fi_void;
3152 forinfo_T *fi = (forinfo_T *)fi_void;
3154 if (fi != NULL && fi->fi_list != NULL)
3156 list_rem_watch(fi->fi_list, &fi->fi_lw);
3157 list_unref(fi->fi_list);
3159 vim_free(fi);
3162 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3164 void
3165 set_context_for_expression(xp, arg, cmdidx)
3166 expand_T *xp;
3167 char_u *arg;
3168 cmdidx_T cmdidx;
3170 int got_eq = FALSE;
3171 int c;
3172 char_u *p;
3174 if (cmdidx == CMD_let)
3176 xp->xp_context = EXPAND_USER_VARS;
3177 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3179 /* ":let var1 var2 ...": find last space. */
3180 for (p = arg + STRLEN(arg); p >= arg; )
3182 xp->xp_pattern = p;
3183 mb_ptr_back(arg, p);
3184 if (vim_iswhite(*p))
3185 break;
3187 return;
3190 else
3191 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3192 : EXPAND_EXPRESSION;
3193 while ((xp->xp_pattern = vim_strpbrk(arg,
3194 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3196 c = *xp->xp_pattern;
3197 if (c == '&')
3199 c = xp->xp_pattern[1];
3200 if (c == '&')
3202 ++xp->xp_pattern;
3203 xp->xp_context = cmdidx != CMD_let || got_eq
3204 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3206 else if (c != ' ')
3208 xp->xp_context = EXPAND_SETTINGS;
3209 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3210 xp->xp_pattern += 2;
3214 else if (c == '$')
3216 /* environment variable */
3217 xp->xp_context = EXPAND_ENV_VARS;
3219 else if (c == '=')
3221 got_eq = TRUE;
3222 xp->xp_context = EXPAND_EXPRESSION;
3224 else if (c == '<'
3225 && xp->xp_context == EXPAND_FUNCTIONS
3226 && vim_strchr(xp->xp_pattern, '(') == NULL)
3228 /* Function name can start with "<SNR>" */
3229 break;
3231 else if (cmdidx != CMD_let || got_eq)
3233 if (c == '"') /* string */
3235 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3236 if (c == '\\' && xp->xp_pattern[1] != NUL)
3237 ++xp->xp_pattern;
3238 xp->xp_context = EXPAND_NOTHING;
3240 else if (c == '\'') /* literal string */
3242 /* Trick: '' is like stopping and starting a literal string. */
3243 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3244 /* skip */ ;
3245 xp->xp_context = EXPAND_NOTHING;
3247 else if (c == '|')
3249 if (xp->xp_pattern[1] == '|')
3251 ++xp->xp_pattern;
3252 xp->xp_context = EXPAND_EXPRESSION;
3254 else
3255 xp->xp_context = EXPAND_COMMANDS;
3257 else
3258 xp->xp_context = EXPAND_EXPRESSION;
3260 else
3261 /* Doesn't look like something valid, expand as an expression
3262 * anyway. */
3263 xp->xp_context = EXPAND_EXPRESSION;
3264 arg = xp->xp_pattern;
3265 if (*arg != NUL)
3266 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3267 /* skip */ ;
3269 xp->xp_pattern = arg;
3272 #endif /* FEAT_CMDL_COMPL */
3275 * ":1,25call func(arg1, arg2)" function call.
3277 void
3278 ex_call(eap)
3279 exarg_T *eap;
3281 char_u *arg = eap->arg;
3282 char_u *startarg;
3283 char_u *name;
3284 char_u *tofree;
3285 int len;
3286 typval_T rettv;
3287 linenr_T lnum;
3288 int doesrange;
3289 int failed = FALSE;
3290 funcdict_T fudi;
3292 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3293 if (fudi.fd_newkey != NULL)
3295 /* Still need to give an error message for missing key. */
3296 EMSG2(_(e_dictkey), fudi.fd_newkey);
3297 vim_free(fudi.fd_newkey);
3299 if (tofree == NULL)
3300 return;
3302 /* Increase refcount on dictionary, it could get deleted when evaluating
3303 * the arguments. */
3304 if (fudi.fd_dict != NULL)
3305 ++fudi.fd_dict->dv_refcount;
3307 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3308 len = (int)STRLEN(tofree);
3309 name = deref_func_name(tofree, &len);
3311 /* Skip white space to allow ":call func ()". Not good, but required for
3312 * backward compatibility. */
3313 startarg = skipwhite(arg);
3314 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3316 if (*startarg != '(')
3318 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3319 goto end;
3323 * When skipping, evaluate the function once, to find the end of the
3324 * arguments.
3325 * When the function takes a range, this is discovered after the first
3326 * call, and the loop is broken.
3328 if (eap->skip)
3330 ++emsg_skip;
3331 lnum = eap->line2; /* do it once, also with an invalid range */
3333 else
3334 lnum = eap->line1;
3335 for ( ; lnum <= eap->line2; ++lnum)
3337 if (!eap->skip && eap->addr_count > 0)
3339 curwin->w_cursor.lnum = lnum;
3340 curwin->w_cursor.col = 0;
3342 arg = startarg;
3343 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3344 eap->line1, eap->line2, &doesrange,
3345 !eap->skip, fudi.fd_dict) == FAIL)
3347 failed = TRUE;
3348 break;
3351 /* Handle a function returning a Funcref, Dictionary or List. */
3352 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3354 failed = TRUE;
3355 break;
3358 clear_tv(&rettv);
3359 if (doesrange || eap->skip)
3360 break;
3362 /* Stop when immediately aborting on error, or when an interrupt
3363 * occurred or an exception was thrown but not caught.
3364 * get_func_tv() returned OK, so that the check for trailing
3365 * characters below is executed. */
3366 if (aborting())
3367 break;
3369 if (eap->skip)
3370 --emsg_skip;
3372 if (!failed)
3374 /* Check for trailing illegal characters and a following command. */
3375 if (!ends_excmd(*arg))
3377 emsg_severe = TRUE;
3378 EMSG(_(e_trailing));
3380 else
3381 eap->nextcmd = check_nextcmd(arg);
3384 end:
3385 dict_unref(fudi.fd_dict);
3386 vim_free(tofree);
3390 * ":unlet[!] var1 ... " command.
3392 void
3393 ex_unlet(eap)
3394 exarg_T *eap;
3396 ex_unletlock(eap, eap->arg, 0);
3400 * ":lockvar" and ":unlockvar" commands
3402 void
3403 ex_lockvar(eap)
3404 exarg_T *eap;
3406 char_u *arg = eap->arg;
3407 int deep = 2;
3409 if (eap->forceit)
3410 deep = -1;
3411 else if (vim_isdigit(*arg))
3413 deep = getdigits(&arg);
3414 arg = skipwhite(arg);
3417 ex_unletlock(eap, arg, deep);
3421 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3423 static void
3424 ex_unletlock(eap, argstart, deep)
3425 exarg_T *eap;
3426 char_u *argstart;
3427 int deep;
3429 char_u *arg = argstart;
3430 char_u *name_end;
3431 int error = FALSE;
3432 lval_T lv;
3436 /* Parse the name and find the end. */
3437 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3438 FNE_CHECK_START);
3439 if (lv.ll_name == NULL)
3440 error = TRUE; /* error but continue parsing */
3441 if (name_end == NULL || (!vim_iswhite(*name_end)
3442 && !ends_excmd(*name_end)))
3444 if (name_end != NULL)
3446 emsg_severe = TRUE;
3447 EMSG(_(e_trailing));
3449 if (!(eap->skip || error))
3450 clear_lval(&lv);
3451 break;
3454 if (!error && !eap->skip)
3456 if (eap->cmdidx == CMD_unlet)
3458 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3459 error = TRUE;
3461 else
3463 if (do_lock_var(&lv, name_end, deep,
3464 eap->cmdidx == CMD_lockvar) == FAIL)
3465 error = TRUE;
3469 if (!eap->skip)
3470 clear_lval(&lv);
3472 arg = skipwhite(name_end);
3473 } while (!ends_excmd(*arg));
3475 eap->nextcmd = check_nextcmd(arg);
3478 static int
3479 do_unlet_var(lp, name_end, forceit)
3480 lval_T *lp;
3481 char_u *name_end;
3482 int forceit;
3484 int ret = OK;
3485 int cc;
3487 if (lp->ll_tv == NULL)
3489 cc = *name_end;
3490 *name_end = NUL;
3492 /* Normal name or expanded name. */
3493 if (check_changedtick(lp->ll_name))
3494 ret = FAIL;
3495 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3496 ret = FAIL;
3497 *name_end = cc;
3499 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3500 return FAIL;
3501 else if (lp->ll_range)
3503 listitem_T *li;
3505 /* Delete a range of List items. */
3506 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3508 li = lp->ll_li->li_next;
3509 listitem_remove(lp->ll_list, lp->ll_li);
3510 lp->ll_li = li;
3511 ++lp->ll_n1;
3514 else
3516 if (lp->ll_list != NULL)
3517 /* unlet a List item. */
3518 listitem_remove(lp->ll_list, lp->ll_li);
3519 else
3520 /* unlet a Dictionary item. */
3521 dictitem_remove(lp->ll_dict, lp->ll_di);
3524 return ret;
3528 * "unlet" a variable. Return OK if it existed, FAIL if not.
3529 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3532 do_unlet(name, forceit)
3533 char_u *name;
3534 int forceit;
3536 hashtab_T *ht;
3537 hashitem_T *hi;
3538 char_u *varname;
3539 dictitem_T *di;
3541 ht = find_var_ht(name, &varname);
3542 if (ht != NULL && *varname != NUL)
3544 hi = hash_find(ht, varname);
3545 if (!HASHITEM_EMPTY(hi))
3547 di = HI2DI(hi);
3548 if (var_check_fixed(di->di_flags, name)
3549 || var_check_ro(di->di_flags, name))
3550 return FAIL;
3551 delete_var(ht, hi);
3552 return OK;
3555 if (forceit)
3556 return OK;
3557 EMSG2(_("E108: No such variable: \"%s\""), name);
3558 return FAIL;
3562 * Lock or unlock variable indicated by "lp".
3563 * "deep" is the levels to go (-1 for unlimited);
3564 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3566 static int
3567 do_lock_var(lp, name_end, deep, lock)
3568 lval_T *lp;
3569 char_u *name_end;
3570 int deep;
3571 int lock;
3573 int ret = OK;
3574 int cc;
3575 dictitem_T *di;
3577 if (deep == 0) /* nothing to do */
3578 return OK;
3580 if (lp->ll_tv == NULL)
3582 cc = *name_end;
3583 *name_end = NUL;
3585 /* Normal name or expanded name. */
3586 if (check_changedtick(lp->ll_name))
3587 ret = FAIL;
3588 else
3590 di = find_var(lp->ll_name, NULL);
3591 if (di == NULL)
3592 ret = FAIL;
3593 else
3595 if (lock)
3596 di->di_flags |= DI_FLAGS_LOCK;
3597 else
3598 di->di_flags &= ~DI_FLAGS_LOCK;
3599 item_lock(&di->di_tv, deep, lock);
3602 *name_end = cc;
3604 else if (lp->ll_range)
3606 listitem_T *li = lp->ll_li;
3608 /* (un)lock a range of List items. */
3609 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3611 item_lock(&li->li_tv, deep, lock);
3612 li = li->li_next;
3613 ++lp->ll_n1;
3616 else if (lp->ll_list != NULL)
3617 /* (un)lock a List item. */
3618 item_lock(&lp->ll_li->li_tv, deep, lock);
3619 else
3620 /* un(lock) a Dictionary item. */
3621 item_lock(&lp->ll_di->di_tv, deep, lock);
3623 return ret;
3627 * Lock or unlock an item. "deep" is nr of levels to go.
3629 static void
3630 item_lock(tv, deep, lock)
3631 typval_T *tv;
3632 int deep;
3633 int lock;
3635 static int recurse = 0;
3636 list_T *l;
3637 listitem_T *li;
3638 dict_T *d;
3639 hashitem_T *hi;
3640 int todo;
3642 if (recurse >= DICT_MAXNEST)
3644 EMSG(_("E743: variable nested too deep for (un)lock"));
3645 return;
3647 if (deep == 0)
3648 return;
3649 ++recurse;
3651 /* lock/unlock the item itself */
3652 if (lock)
3653 tv->v_lock |= VAR_LOCKED;
3654 else
3655 tv->v_lock &= ~VAR_LOCKED;
3657 switch (tv->v_type)
3659 case VAR_LIST:
3660 if ((l = tv->vval.v_list) != NULL)
3662 if (lock)
3663 l->lv_lock |= VAR_LOCKED;
3664 else
3665 l->lv_lock &= ~VAR_LOCKED;
3666 if (deep < 0 || deep > 1)
3667 /* recursive: lock/unlock the items the List contains */
3668 for (li = l->lv_first; li != NULL; li = li->li_next)
3669 item_lock(&li->li_tv, deep - 1, lock);
3671 break;
3672 case VAR_DICT:
3673 if ((d = tv->vval.v_dict) != NULL)
3675 if (lock)
3676 d->dv_lock |= VAR_LOCKED;
3677 else
3678 d->dv_lock &= ~VAR_LOCKED;
3679 if (deep < 0 || deep > 1)
3681 /* recursive: lock/unlock the items the List contains */
3682 todo = (int)d->dv_hashtab.ht_used;
3683 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3685 if (!HASHITEM_EMPTY(hi))
3687 --todo;
3688 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3694 --recurse;
3698 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3699 * or it refers to a List or Dictionary that is locked.
3701 static int
3702 tv_islocked(tv)
3703 typval_T *tv;
3705 return (tv->v_lock & VAR_LOCKED)
3706 || (tv->v_type == VAR_LIST
3707 && tv->vval.v_list != NULL
3708 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3709 || (tv->v_type == VAR_DICT
3710 && tv->vval.v_dict != NULL
3711 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3714 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3716 * Delete all "menutrans_" variables.
3718 void
3719 del_menutrans_vars()
3721 hashitem_T *hi;
3722 int todo;
3724 hash_lock(&globvarht);
3725 todo = (int)globvarht.ht_used;
3726 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3728 if (!HASHITEM_EMPTY(hi))
3730 --todo;
3731 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3732 delete_var(&globvarht, hi);
3735 hash_unlock(&globvarht);
3737 #endif
3739 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3742 * Local string buffer for the next two functions to store a variable name
3743 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3744 * get_user_var_name().
3747 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3749 static char_u *varnamebuf = NULL;
3750 static int varnamebuflen = 0;
3753 * Function to concatenate a prefix and a variable name.
3755 static char_u *
3756 cat_prefix_varname(prefix, name)
3757 int prefix;
3758 char_u *name;
3760 int len;
3762 len = (int)STRLEN(name) + 3;
3763 if (len > varnamebuflen)
3765 vim_free(varnamebuf);
3766 len += 10; /* some additional space */
3767 varnamebuf = alloc(len);
3768 if (varnamebuf == NULL)
3770 varnamebuflen = 0;
3771 return NULL;
3773 varnamebuflen = len;
3775 *varnamebuf = prefix;
3776 varnamebuf[1] = ':';
3777 STRCPY(varnamebuf + 2, name);
3778 return varnamebuf;
3782 * Function given to ExpandGeneric() to obtain the list of user defined
3783 * (global/buffer/window/built-in) variable names.
3785 char_u *
3786 get_user_var_name(xp, idx)
3787 expand_T *xp;
3788 int idx;
3790 static long_u gdone;
3791 static long_u bdone;
3792 static long_u wdone;
3793 #ifdef FEAT_WINDOWS
3794 static long_u tdone;
3795 #endif
3796 static int vidx;
3797 static hashitem_T *hi;
3798 hashtab_T *ht;
3800 if (idx == 0)
3802 gdone = bdone = wdone = vidx = 0;
3803 #ifdef FEAT_WINDOWS
3804 tdone = 0;
3805 #endif
3808 /* Global variables */
3809 if (gdone < globvarht.ht_used)
3811 if (gdone++ == 0)
3812 hi = globvarht.ht_array;
3813 else
3814 ++hi;
3815 while (HASHITEM_EMPTY(hi))
3816 ++hi;
3817 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3818 return cat_prefix_varname('g', hi->hi_key);
3819 return hi->hi_key;
3822 /* b: variables */
3823 ht = &curbuf->b_vars.dv_hashtab;
3824 if (bdone < ht->ht_used)
3826 if (bdone++ == 0)
3827 hi = ht->ht_array;
3828 else
3829 ++hi;
3830 while (HASHITEM_EMPTY(hi))
3831 ++hi;
3832 return cat_prefix_varname('b', hi->hi_key);
3834 if (bdone == ht->ht_used)
3836 ++bdone;
3837 return (char_u *)"b:changedtick";
3840 /* w: variables */
3841 ht = &curwin->w_vars.dv_hashtab;
3842 if (wdone < ht->ht_used)
3844 if (wdone++ == 0)
3845 hi = ht->ht_array;
3846 else
3847 ++hi;
3848 while (HASHITEM_EMPTY(hi))
3849 ++hi;
3850 return cat_prefix_varname('w', hi->hi_key);
3853 #ifdef FEAT_WINDOWS
3854 /* t: variables */
3855 ht = &curtab->tp_vars.dv_hashtab;
3856 if (tdone < ht->ht_used)
3858 if (tdone++ == 0)
3859 hi = ht->ht_array;
3860 else
3861 ++hi;
3862 while (HASHITEM_EMPTY(hi))
3863 ++hi;
3864 return cat_prefix_varname('t', hi->hi_key);
3866 #endif
3868 /* v: variables */
3869 if (vidx < VV_LEN)
3870 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3872 vim_free(varnamebuf);
3873 varnamebuf = NULL;
3874 varnamebuflen = 0;
3875 return NULL;
3878 #endif /* FEAT_CMDL_COMPL */
3881 * types for expressions.
3883 typedef enum
3885 TYPE_UNKNOWN = 0
3886 , TYPE_EQUAL /* == */
3887 , TYPE_NEQUAL /* != */
3888 , TYPE_GREATER /* > */
3889 , TYPE_GEQUAL /* >= */
3890 , TYPE_SMALLER /* < */
3891 , TYPE_SEQUAL /* <= */
3892 , TYPE_MATCH /* =~ */
3893 , TYPE_NOMATCH /* !~ */
3894 } exptype_T;
3897 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3898 * executed. The function may return OK, but the rettv will be of type
3899 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3903 * Handle zero level expression.
3904 * This calls eval1() and handles error message and nextcmd.
3905 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3906 * Note: "rettv.v_lock" is not set.
3907 * Return OK or FAIL.
3909 static int
3910 eval0(arg, rettv, nextcmd, evaluate)
3911 char_u *arg;
3912 typval_T *rettv;
3913 char_u **nextcmd;
3914 int evaluate;
3916 int ret;
3917 char_u *p;
3919 p = skipwhite(arg);
3920 ret = eval1(&p, rettv, evaluate);
3921 if (ret == FAIL || !ends_excmd(*p))
3923 if (ret != FAIL)
3924 clear_tv(rettv);
3926 * Report the invalid expression unless the expression evaluation has
3927 * been cancelled due to an aborting error, an interrupt, or an
3928 * exception.
3930 if (!aborting())
3931 EMSG2(_(e_invexpr2), arg);
3932 ret = FAIL;
3934 if (nextcmd != NULL)
3935 *nextcmd = check_nextcmd(p);
3937 return ret;
3941 * Handle top level expression:
3942 * expr2 ? expr1 : expr1
3944 * "arg" must point to the first non-white of the expression.
3945 * "arg" is advanced to the next non-white after the recognized expression.
3947 * Note: "rettv.v_lock" is not set.
3949 * Return OK or FAIL.
3951 static int
3952 eval1(arg, rettv, evaluate)
3953 char_u **arg;
3954 typval_T *rettv;
3955 int evaluate;
3957 int result;
3958 typval_T var2;
3961 * Get the first variable.
3963 if (eval2(arg, rettv, evaluate) == FAIL)
3964 return FAIL;
3966 if ((*arg)[0] == '?')
3968 result = FALSE;
3969 if (evaluate)
3971 int error = FALSE;
3973 if (get_tv_number_chk(rettv, &error) != 0)
3974 result = TRUE;
3975 clear_tv(rettv);
3976 if (error)
3977 return FAIL;
3981 * Get the second variable.
3983 *arg = skipwhite(*arg + 1);
3984 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3985 return FAIL;
3988 * Check for the ":".
3990 if ((*arg)[0] != ':')
3992 EMSG(_("E109: Missing ':' after '?'"));
3993 if (evaluate && result)
3994 clear_tv(rettv);
3995 return FAIL;
3999 * Get the third variable.
4001 *arg = skipwhite(*arg + 1);
4002 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
4004 if (evaluate && result)
4005 clear_tv(rettv);
4006 return FAIL;
4008 if (evaluate && !result)
4009 *rettv = var2;
4012 return OK;
4016 * Handle first level expression:
4017 * expr2 || expr2 || expr2 logical OR
4019 * "arg" must point to the first non-white of the expression.
4020 * "arg" is advanced to the next non-white after the recognized expression.
4022 * Return OK or FAIL.
4024 static int
4025 eval2(arg, rettv, evaluate)
4026 char_u **arg;
4027 typval_T *rettv;
4028 int evaluate;
4030 typval_T var2;
4031 long result;
4032 int first;
4033 int error = FALSE;
4036 * Get the first variable.
4038 if (eval3(arg, rettv, evaluate) == FAIL)
4039 return FAIL;
4042 * Repeat until there is no following "||".
4044 first = TRUE;
4045 result = FALSE;
4046 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4048 if (evaluate && first)
4050 if (get_tv_number_chk(rettv, &error) != 0)
4051 result = TRUE;
4052 clear_tv(rettv);
4053 if (error)
4054 return FAIL;
4055 first = FALSE;
4059 * Get the second variable.
4061 *arg = skipwhite(*arg + 2);
4062 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4063 return FAIL;
4066 * Compute the result.
4068 if (evaluate && !result)
4070 if (get_tv_number_chk(&var2, &error) != 0)
4071 result = TRUE;
4072 clear_tv(&var2);
4073 if (error)
4074 return FAIL;
4076 if (evaluate)
4078 rettv->v_type = VAR_NUMBER;
4079 rettv->vval.v_number = result;
4083 return OK;
4087 * Handle second level expression:
4088 * expr3 && expr3 && expr3 logical AND
4090 * "arg" must point to the first non-white of the expression.
4091 * "arg" is advanced to the next non-white after the recognized expression.
4093 * Return OK or FAIL.
4095 static int
4096 eval3(arg, rettv, evaluate)
4097 char_u **arg;
4098 typval_T *rettv;
4099 int evaluate;
4101 typval_T var2;
4102 long result;
4103 int first;
4104 int error = FALSE;
4107 * Get the first variable.
4109 if (eval4(arg, rettv, evaluate) == FAIL)
4110 return FAIL;
4113 * Repeat until there is no following "&&".
4115 first = TRUE;
4116 result = TRUE;
4117 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4119 if (evaluate && first)
4121 if (get_tv_number_chk(rettv, &error) == 0)
4122 result = FALSE;
4123 clear_tv(rettv);
4124 if (error)
4125 return FAIL;
4126 first = FALSE;
4130 * Get the second variable.
4132 *arg = skipwhite(*arg + 2);
4133 if (eval4(arg, &var2, evaluate && result) == FAIL)
4134 return FAIL;
4137 * Compute the result.
4139 if (evaluate && result)
4141 if (get_tv_number_chk(&var2, &error) == 0)
4142 result = FALSE;
4143 clear_tv(&var2);
4144 if (error)
4145 return FAIL;
4147 if (evaluate)
4149 rettv->v_type = VAR_NUMBER;
4150 rettv->vval.v_number = result;
4154 return OK;
4158 * Handle third level expression:
4159 * var1 == var2
4160 * var1 =~ var2
4161 * var1 != var2
4162 * var1 !~ var2
4163 * var1 > var2
4164 * var1 >= var2
4165 * var1 < var2
4166 * var1 <= var2
4167 * var1 is var2
4168 * var1 isnot var2
4170 * "arg" must point to the first non-white of the expression.
4171 * "arg" is advanced to the next non-white after the recognized expression.
4173 * Return OK or FAIL.
4175 static int
4176 eval4(arg, rettv, evaluate)
4177 char_u **arg;
4178 typval_T *rettv;
4179 int evaluate;
4181 typval_T var2;
4182 char_u *p;
4183 int i;
4184 exptype_T type = TYPE_UNKNOWN;
4185 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4186 int len = 2;
4187 long n1, n2;
4188 char_u *s1, *s2;
4189 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4190 regmatch_T regmatch;
4191 int ic;
4192 char_u *save_cpo;
4195 * Get the first variable.
4197 if (eval5(arg, rettv, evaluate) == FAIL)
4198 return FAIL;
4200 p = *arg;
4201 switch (p[0])
4203 case '=': if (p[1] == '=')
4204 type = TYPE_EQUAL;
4205 else if (p[1] == '~')
4206 type = TYPE_MATCH;
4207 break;
4208 case '!': if (p[1] == '=')
4209 type = TYPE_NEQUAL;
4210 else if (p[1] == '~')
4211 type = TYPE_NOMATCH;
4212 break;
4213 case '>': if (p[1] != '=')
4215 type = TYPE_GREATER;
4216 len = 1;
4218 else
4219 type = TYPE_GEQUAL;
4220 break;
4221 case '<': if (p[1] != '=')
4223 type = TYPE_SMALLER;
4224 len = 1;
4226 else
4227 type = TYPE_SEQUAL;
4228 break;
4229 case 'i': if (p[1] == 's')
4231 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4232 len = 5;
4233 if (!vim_isIDc(p[len]))
4235 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4236 type_is = TRUE;
4239 break;
4243 * If there is a comparative operator, use it.
4245 if (type != TYPE_UNKNOWN)
4247 /* extra question mark appended: ignore case */
4248 if (p[len] == '?')
4250 ic = TRUE;
4251 ++len;
4253 /* extra '#' appended: match case */
4254 else if (p[len] == '#')
4256 ic = FALSE;
4257 ++len;
4259 /* nothing appended: use 'ignorecase' */
4260 else
4261 ic = p_ic;
4264 * Get the second variable.
4266 *arg = skipwhite(p + len);
4267 if (eval5(arg, &var2, evaluate) == FAIL)
4269 clear_tv(rettv);
4270 return FAIL;
4273 if (evaluate)
4275 if (type_is && rettv->v_type != var2.v_type)
4277 /* For "is" a different type always means FALSE, for "notis"
4278 * it means TRUE. */
4279 n1 = (type == TYPE_NEQUAL);
4281 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4283 if (type_is)
4285 n1 = (rettv->v_type == var2.v_type
4286 && rettv->vval.v_list == var2.vval.v_list);
4287 if (type == TYPE_NEQUAL)
4288 n1 = !n1;
4290 else if (rettv->v_type != var2.v_type
4291 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4293 if (rettv->v_type != var2.v_type)
4294 EMSG(_("E691: Can only compare List with List"));
4295 else
4296 EMSG(_("E692: Invalid operation for Lists"));
4297 clear_tv(rettv);
4298 clear_tv(&var2);
4299 return FAIL;
4301 else
4303 /* Compare two Lists for being equal or unequal. */
4304 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4305 if (type == TYPE_NEQUAL)
4306 n1 = !n1;
4310 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4312 if (type_is)
4314 n1 = (rettv->v_type == var2.v_type
4315 && rettv->vval.v_dict == var2.vval.v_dict);
4316 if (type == TYPE_NEQUAL)
4317 n1 = !n1;
4319 else if (rettv->v_type != var2.v_type
4320 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4322 if (rettv->v_type != var2.v_type)
4323 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4324 else
4325 EMSG(_("E736: Invalid operation for Dictionary"));
4326 clear_tv(rettv);
4327 clear_tv(&var2);
4328 return FAIL;
4330 else
4332 /* Compare two Dictionaries for being equal or unequal. */
4333 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4334 if (type == TYPE_NEQUAL)
4335 n1 = !n1;
4339 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4341 if (rettv->v_type != var2.v_type
4342 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4344 if (rettv->v_type != var2.v_type)
4345 EMSG(_("E693: Can only compare Funcref with Funcref"));
4346 else
4347 EMSG(_("E694: Invalid operation for Funcrefs"));
4348 clear_tv(rettv);
4349 clear_tv(&var2);
4350 return FAIL;
4352 else
4354 /* Compare two Funcrefs for being equal or unequal. */
4355 if (rettv->vval.v_string == NULL
4356 || var2.vval.v_string == NULL)
4357 n1 = FALSE;
4358 else
4359 n1 = STRCMP(rettv->vval.v_string,
4360 var2.vval.v_string) == 0;
4361 if (type == TYPE_NEQUAL)
4362 n1 = !n1;
4366 #ifdef FEAT_FLOAT
4368 * If one of the two variables is a float, compare as a float.
4369 * When using "=~" or "!~", always compare as string.
4371 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4372 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4374 float_T f1, f2;
4376 if (rettv->v_type == VAR_FLOAT)
4377 f1 = rettv->vval.v_float;
4378 else
4379 f1 = get_tv_number(rettv);
4380 if (var2.v_type == VAR_FLOAT)
4381 f2 = var2.vval.v_float;
4382 else
4383 f2 = get_tv_number(&var2);
4384 n1 = FALSE;
4385 switch (type)
4387 case TYPE_EQUAL: n1 = (f1 == f2); break;
4388 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4389 case TYPE_GREATER: n1 = (f1 > f2); break;
4390 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4391 case TYPE_SMALLER: n1 = (f1 < f2); break;
4392 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4393 case TYPE_UNKNOWN:
4394 case TYPE_MATCH:
4395 case TYPE_NOMATCH: break; /* avoid gcc warning */
4398 #endif
4401 * If one of the two variables is a number, compare as a number.
4402 * When using "=~" or "!~", always compare as string.
4404 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4405 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4407 n1 = get_tv_number(rettv);
4408 n2 = get_tv_number(&var2);
4409 switch (type)
4411 case TYPE_EQUAL: n1 = (n1 == n2); break;
4412 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4413 case TYPE_GREATER: n1 = (n1 > n2); break;
4414 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4415 case TYPE_SMALLER: n1 = (n1 < n2); break;
4416 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4417 case TYPE_UNKNOWN:
4418 case TYPE_MATCH:
4419 case TYPE_NOMATCH: break; /* avoid gcc warning */
4422 else
4424 s1 = get_tv_string_buf(rettv, buf1);
4425 s2 = get_tv_string_buf(&var2, buf2);
4426 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4427 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4428 else
4429 i = 0;
4430 n1 = FALSE;
4431 switch (type)
4433 case TYPE_EQUAL: n1 = (i == 0); break;
4434 case TYPE_NEQUAL: n1 = (i != 0); break;
4435 case TYPE_GREATER: n1 = (i > 0); break;
4436 case TYPE_GEQUAL: n1 = (i >= 0); break;
4437 case TYPE_SMALLER: n1 = (i < 0); break;
4438 case TYPE_SEQUAL: n1 = (i <= 0); break;
4440 case TYPE_MATCH:
4441 case TYPE_NOMATCH:
4442 /* avoid 'l' flag in 'cpoptions' */
4443 save_cpo = p_cpo;
4444 p_cpo = (char_u *)"";
4445 regmatch.regprog = vim_regcomp(s2,
4446 RE_MAGIC + RE_STRING);
4447 regmatch.rm_ic = ic;
4448 if (regmatch.regprog != NULL)
4450 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4451 vim_free(regmatch.regprog);
4452 if (type == TYPE_NOMATCH)
4453 n1 = !n1;
4455 p_cpo = save_cpo;
4456 break;
4458 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4461 clear_tv(rettv);
4462 clear_tv(&var2);
4463 rettv->v_type = VAR_NUMBER;
4464 rettv->vval.v_number = n1;
4468 return OK;
4472 * Handle fourth level expression:
4473 * + number addition
4474 * - number subtraction
4475 * . string concatenation
4477 * "arg" must point to the first non-white of the expression.
4478 * "arg" is advanced to the next non-white after the recognized expression.
4480 * Return OK or FAIL.
4482 static int
4483 eval5(arg, rettv, evaluate)
4484 char_u **arg;
4485 typval_T *rettv;
4486 int evaluate;
4488 typval_T var2;
4489 typval_T var3;
4490 int op;
4491 long n1, n2;
4492 #ifdef FEAT_FLOAT
4493 float_T f1 = 0, f2 = 0;
4494 #endif
4495 char_u *s1, *s2;
4496 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4497 char_u *p;
4500 * Get the first variable.
4502 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4503 return FAIL;
4506 * Repeat computing, until no '+', '-' or '.' is following.
4508 for (;;)
4510 op = **arg;
4511 if (op != '+' && op != '-' && op != '.')
4512 break;
4514 if ((op != '+' || rettv->v_type != VAR_LIST)
4515 #ifdef FEAT_FLOAT
4516 && (op == '.' || rettv->v_type != VAR_FLOAT)
4517 #endif
4520 /* For "list + ...", an illegal use of the first operand as
4521 * a number cannot be determined before evaluating the 2nd
4522 * operand: if this is also a list, all is ok.
4523 * For "something . ...", "something - ..." or "non-list + ...",
4524 * we know that the first operand needs to be a string or number
4525 * without evaluating the 2nd operand. So check before to avoid
4526 * side effects after an error. */
4527 if (evaluate && get_tv_string_chk(rettv) == NULL)
4529 clear_tv(rettv);
4530 return FAIL;
4535 * Get the second variable.
4537 *arg = skipwhite(*arg + 1);
4538 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4540 clear_tv(rettv);
4541 return FAIL;
4544 if (evaluate)
4547 * Compute the result.
4549 if (op == '.')
4551 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4552 s2 = get_tv_string_buf_chk(&var2, buf2);
4553 if (s2 == NULL) /* type error ? */
4555 clear_tv(rettv);
4556 clear_tv(&var2);
4557 return FAIL;
4559 p = concat_str(s1, s2);
4560 clear_tv(rettv);
4561 rettv->v_type = VAR_STRING;
4562 rettv->vval.v_string = p;
4564 else if (op == '+' && rettv->v_type == VAR_LIST
4565 && var2.v_type == VAR_LIST)
4567 /* concatenate Lists */
4568 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4569 &var3) == FAIL)
4571 clear_tv(rettv);
4572 clear_tv(&var2);
4573 return FAIL;
4575 clear_tv(rettv);
4576 *rettv = var3;
4578 else
4580 int error = FALSE;
4582 #ifdef FEAT_FLOAT
4583 if (rettv->v_type == VAR_FLOAT)
4585 f1 = rettv->vval.v_float;
4586 n1 = 0;
4588 else
4589 #endif
4591 n1 = get_tv_number_chk(rettv, &error);
4592 if (error)
4594 /* This can only happen for "list + non-list". For
4595 * "non-list + ..." or "something - ...", we returned
4596 * before evaluating the 2nd operand. */
4597 clear_tv(rettv);
4598 return FAIL;
4600 #ifdef FEAT_FLOAT
4601 if (var2.v_type == VAR_FLOAT)
4602 f1 = n1;
4603 #endif
4605 #ifdef FEAT_FLOAT
4606 if (var2.v_type == VAR_FLOAT)
4608 f2 = var2.vval.v_float;
4609 n2 = 0;
4611 else
4612 #endif
4614 n2 = get_tv_number_chk(&var2, &error);
4615 if (error)
4617 clear_tv(rettv);
4618 clear_tv(&var2);
4619 return FAIL;
4621 #ifdef FEAT_FLOAT
4622 if (rettv->v_type == VAR_FLOAT)
4623 f2 = n2;
4624 #endif
4626 clear_tv(rettv);
4628 #ifdef FEAT_FLOAT
4629 /* If there is a float on either side the result is a float. */
4630 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4632 if (op == '+')
4633 f1 = f1 + f2;
4634 else
4635 f1 = f1 - f2;
4636 rettv->v_type = VAR_FLOAT;
4637 rettv->vval.v_float = f1;
4639 else
4640 #endif
4642 if (op == '+')
4643 n1 = n1 + n2;
4644 else
4645 n1 = n1 - n2;
4646 rettv->v_type = VAR_NUMBER;
4647 rettv->vval.v_number = n1;
4650 clear_tv(&var2);
4653 return OK;
4657 * Handle fifth level expression:
4658 * * number multiplication
4659 * / number division
4660 * % number modulo
4662 * "arg" must point to the first non-white of the expression.
4663 * "arg" is advanced to the next non-white after the recognized expression.
4665 * Return OK or FAIL.
4667 static int
4668 eval6(arg, rettv, evaluate, want_string)
4669 char_u **arg;
4670 typval_T *rettv;
4671 int evaluate;
4672 int want_string; /* after "." operator */
4674 typval_T var2;
4675 int op;
4676 long n1, n2;
4677 #ifdef FEAT_FLOAT
4678 int use_float = FALSE;
4679 float_T f1 = 0, f2;
4680 #endif
4681 int error = FALSE;
4684 * Get the first variable.
4686 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4687 return FAIL;
4690 * Repeat computing, until no '*', '/' or '%' is following.
4692 for (;;)
4694 op = **arg;
4695 if (op != '*' && op != '/' && op != '%')
4696 break;
4698 if (evaluate)
4700 #ifdef FEAT_FLOAT
4701 if (rettv->v_type == VAR_FLOAT)
4703 f1 = rettv->vval.v_float;
4704 use_float = TRUE;
4705 n1 = 0;
4707 else
4708 #endif
4709 n1 = get_tv_number_chk(rettv, &error);
4710 clear_tv(rettv);
4711 if (error)
4712 return FAIL;
4714 else
4715 n1 = 0;
4718 * Get the second variable.
4720 *arg = skipwhite(*arg + 1);
4721 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4722 return FAIL;
4724 if (evaluate)
4726 #ifdef FEAT_FLOAT
4727 if (var2.v_type == VAR_FLOAT)
4729 if (!use_float)
4731 f1 = n1;
4732 use_float = TRUE;
4734 f2 = var2.vval.v_float;
4735 n2 = 0;
4737 else
4738 #endif
4740 n2 = get_tv_number_chk(&var2, &error);
4741 clear_tv(&var2);
4742 if (error)
4743 return FAIL;
4744 #ifdef FEAT_FLOAT
4745 if (use_float)
4746 f2 = n2;
4747 #endif
4751 * Compute the result.
4752 * When either side is a float the result is a float.
4754 #ifdef FEAT_FLOAT
4755 if (use_float)
4757 if (op == '*')
4758 f1 = f1 * f2;
4759 else if (op == '/')
4761 /* We rely on the floating point library to handle divide
4762 * by zero to result in "inf" and not a crash. */
4763 f1 = f1 / f2;
4765 else
4767 EMSG(_("E804: Cannot use '%' with Float"));
4768 return FAIL;
4770 rettv->v_type = VAR_FLOAT;
4771 rettv->vval.v_float = f1;
4773 else
4774 #endif
4776 if (op == '*')
4777 n1 = n1 * n2;
4778 else if (op == '/')
4780 if (n2 == 0) /* give an error message? */
4782 if (n1 == 0)
4783 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4784 else if (n1 < 0)
4785 n1 = -0x7fffffffL;
4786 else
4787 n1 = 0x7fffffffL;
4789 else
4790 n1 = n1 / n2;
4792 else
4794 if (n2 == 0) /* give an error message? */
4795 n1 = 0;
4796 else
4797 n1 = n1 % n2;
4799 rettv->v_type = VAR_NUMBER;
4800 rettv->vval.v_number = n1;
4805 return OK;
4809 * Handle sixth level expression:
4810 * number number constant
4811 * "string" string constant
4812 * 'string' literal string constant
4813 * &option-name option value
4814 * @r register contents
4815 * identifier variable value
4816 * function() function call
4817 * $VAR environment variable
4818 * (expression) nested expression
4819 * [expr, expr] List
4820 * {key: val, key: val} Dictionary
4822 * Also handle:
4823 * ! in front logical NOT
4824 * - in front unary minus
4825 * + in front unary plus (ignored)
4826 * trailing [] subscript in String or List
4827 * trailing .name entry in Dictionary
4829 * "arg" must point to the first non-white of the expression.
4830 * "arg" is advanced to the next non-white after the recognized expression.
4832 * Return OK or FAIL.
4834 static int
4835 eval7(arg, rettv, evaluate, want_string)
4836 char_u **arg;
4837 typval_T *rettv;
4838 int evaluate;
4839 int want_string; /* after "." operator */
4841 long n;
4842 int len;
4843 char_u *s;
4844 char_u *start_leader, *end_leader;
4845 int ret = OK;
4846 char_u *alias;
4849 * Initialise variable so that clear_tv() can't mistake this for a
4850 * string and free a string that isn't there.
4852 rettv->v_type = VAR_UNKNOWN;
4855 * Skip '!' and '-' characters. They are handled later.
4857 start_leader = *arg;
4858 while (**arg == '!' || **arg == '-' || **arg == '+')
4859 *arg = skipwhite(*arg + 1);
4860 end_leader = *arg;
4862 switch (**arg)
4865 * Number constant.
4867 case '0':
4868 case '1':
4869 case '2':
4870 case '3':
4871 case '4':
4872 case '5':
4873 case '6':
4874 case '7':
4875 case '8':
4876 case '9':
4878 #ifdef FEAT_FLOAT
4879 char_u *p = skipdigits(*arg + 1);
4880 int get_float = FALSE;
4882 /* We accept a float when the format matches
4883 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4884 * strict to avoid backwards compatibility problems.
4885 * Don't look for a float after the "." operator, so that
4886 * ":let vers = 1.2.3" doesn't fail. */
4887 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4889 get_float = TRUE;
4890 p = skipdigits(p + 2);
4891 if (*p == 'e' || *p == 'E')
4893 ++p;
4894 if (*p == '-' || *p == '+')
4895 ++p;
4896 if (!vim_isdigit(*p))
4897 get_float = FALSE;
4898 else
4899 p = skipdigits(p + 1);
4901 if (ASCII_ISALPHA(*p) || *p == '.')
4902 get_float = FALSE;
4904 if (get_float)
4906 float_T f;
4908 *arg += string2float(*arg, &f);
4909 if (evaluate)
4911 rettv->v_type = VAR_FLOAT;
4912 rettv->vval.v_float = f;
4915 else
4916 #endif
4918 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4919 *arg += len;
4920 if (evaluate)
4922 rettv->v_type = VAR_NUMBER;
4923 rettv->vval.v_number = n;
4926 break;
4930 * String constant: "string".
4932 case '"': ret = get_string_tv(arg, rettv, evaluate);
4933 break;
4936 * Literal string constant: 'str''ing'.
4938 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4939 break;
4942 * List: [expr, expr]
4944 case '[': ret = get_list_tv(arg, rettv, evaluate);
4945 break;
4948 * Dictionary: {key: val, key: val}
4950 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4951 break;
4954 * Option value: &name
4956 case '&': ret = get_option_tv(arg, rettv, evaluate);
4957 break;
4960 * Environment variable: $VAR.
4962 case '$': ret = get_env_tv(arg, rettv, evaluate);
4963 break;
4966 * Register contents: @r.
4968 case '@': ++*arg;
4969 if (evaluate)
4971 rettv->v_type = VAR_STRING;
4972 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4974 if (**arg != NUL)
4975 ++*arg;
4976 break;
4979 * nested expression: (expression).
4981 case '(': *arg = skipwhite(*arg + 1);
4982 ret = eval1(arg, rettv, evaluate); /* recursive! */
4983 if (**arg == ')')
4984 ++*arg;
4985 else if (ret == OK)
4987 EMSG(_("E110: Missing ')'"));
4988 clear_tv(rettv);
4989 ret = FAIL;
4991 break;
4993 default: ret = NOTDONE;
4994 break;
4997 if (ret == NOTDONE)
5000 * Must be a variable or function name.
5001 * Can also be a curly-braces kind of name: {expr}.
5003 s = *arg;
5004 len = get_name_len(arg, &alias, evaluate, TRUE);
5005 if (alias != NULL)
5006 s = alias;
5008 if (len <= 0)
5009 ret = FAIL;
5010 else
5012 if (**arg == '(') /* recursive! */
5014 /* If "s" is the name of a variable of type VAR_FUNC
5015 * use its contents. */
5016 s = deref_func_name(s, &len);
5018 /* Invoke the function. */
5019 ret = get_func_tv(s, len, rettv, arg,
5020 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5021 &len, evaluate, NULL);
5022 /* Stop the expression evaluation when immediately
5023 * aborting on error, or when an interrupt occurred or
5024 * an exception was thrown but not caught. */
5025 if (aborting())
5027 if (ret == OK)
5028 clear_tv(rettv);
5029 ret = FAIL;
5032 else if (evaluate)
5033 ret = get_var_tv(s, len, rettv, TRUE);
5034 else
5035 ret = OK;
5038 if (alias != NULL)
5039 vim_free(alias);
5042 *arg = skipwhite(*arg);
5044 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5045 * expr(expr). */
5046 if (ret == OK)
5047 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5050 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5052 if (ret == OK && evaluate && end_leader > start_leader)
5054 int error = FALSE;
5055 int val = 0;
5056 #ifdef FEAT_FLOAT
5057 float_T f = 0.0;
5059 if (rettv->v_type == VAR_FLOAT)
5060 f = rettv->vval.v_float;
5061 else
5062 #endif
5063 val = get_tv_number_chk(rettv, &error);
5064 if (error)
5066 clear_tv(rettv);
5067 ret = FAIL;
5069 else
5071 while (end_leader > start_leader)
5073 --end_leader;
5074 if (*end_leader == '!')
5076 #ifdef FEAT_FLOAT
5077 if (rettv->v_type == VAR_FLOAT)
5078 f = !f;
5079 else
5080 #endif
5081 val = !val;
5083 else if (*end_leader == '-')
5085 #ifdef FEAT_FLOAT
5086 if (rettv->v_type == VAR_FLOAT)
5087 f = -f;
5088 else
5089 #endif
5090 val = -val;
5093 #ifdef FEAT_FLOAT
5094 if (rettv->v_type == VAR_FLOAT)
5096 clear_tv(rettv);
5097 rettv->vval.v_float = f;
5099 else
5100 #endif
5102 clear_tv(rettv);
5103 rettv->v_type = VAR_NUMBER;
5104 rettv->vval.v_number = val;
5109 return ret;
5113 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5114 * "*arg" points to the '[' or '.'.
5115 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5117 static int
5118 eval_index(arg, rettv, evaluate, verbose)
5119 char_u **arg;
5120 typval_T *rettv;
5121 int evaluate;
5122 int verbose; /* give error messages */
5124 int empty1 = FALSE, empty2 = FALSE;
5125 typval_T var1, var2;
5126 long n1, n2 = 0;
5127 long len = -1;
5128 int range = FALSE;
5129 char_u *s;
5130 char_u *key = NULL;
5132 if (rettv->v_type == VAR_FUNC
5133 #ifdef FEAT_FLOAT
5134 || rettv->v_type == VAR_FLOAT
5135 #endif
5138 if (verbose)
5139 EMSG(_("E695: Cannot index a Funcref"));
5140 return FAIL;
5143 if (**arg == '.')
5146 * dict.name
5148 key = *arg + 1;
5149 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5151 if (len == 0)
5152 return FAIL;
5153 *arg = skipwhite(key + len);
5155 else
5158 * something[idx]
5160 * Get the (first) variable from inside the [].
5162 *arg = skipwhite(*arg + 1);
5163 if (**arg == ':')
5164 empty1 = TRUE;
5165 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5166 return FAIL;
5167 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5169 /* not a number or string */
5170 clear_tv(&var1);
5171 return FAIL;
5175 * Get the second variable from inside the [:].
5177 if (**arg == ':')
5179 range = TRUE;
5180 *arg = skipwhite(*arg + 1);
5181 if (**arg == ']')
5182 empty2 = TRUE;
5183 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5185 if (!empty1)
5186 clear_tv(&var1);
5187 return FAIL;
5189 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5191 /* not a number or string */
5192 if (!empty1)
5193 clear_tv(&var1);
5194 clear_tv(&var2);
5195 return FAIL;
5199 /* Check for the ']'. */
5200 if (**arg != ']')
5202 if (verbose)
5203 EMSG(_(e_missbrac));
5204 clear_tv(&var1);
5205 if (range)
5206 clear_tv(&var2);
5207 return FAIL;
5209 *arg = skipwhite(*arg + 1); /* skip the ']' */
5212 if (evaluate)
5214 n1 = 0;
5215 if (!empty1 && rettv->v_type != VAR_DICT)
5217 n1 = get_tv_number(&var1);
5218 clear_tv(&var1);
5220 if (range)
5222 if (empty2)
5223 n2 = -1;
5224 else
5226 n2 = get_tv_number(&var2);
5227 clear_tv(&var2);
5231 switch (rettv->v_type)
5233 case VAR_NUMBER:
5234 case VAR_STRING:
5235 s = get_tv_string(rettv);
5236 len = (long)STRLEN(s);
5237 if (range)
5239 /* The resulting variable is a substring. If the indexes
5240 * are out of range the result is empty. */
5241 if (n1 < 0)
5243 n1 = len + n1;
5244 if (n1 < 0)
5245 n1 = 0;
5247 if (n2 < 0)
5248 n2 = len + n2;
5249 else if (n2 >= len)
5250 n2 = len;
5251 if (n1 >= len || n2 < 0 || n1 > n2)
5252 s = NULL;
5253 else
5254 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5256 else
5258 /* The resulting variable is a string of a single
5259 * character. If the index is too big or negative the
5260 * result is empty. */
5261 if (n1 >= len || n1 < 0)
5262 s = NULL;
5263 else
5264 s = vim_strnsave(s + n1, 1);
5266 clear_tv(rettv);
5267 rettv->v_type = VAR_STRING;
5268 rettv->vval.v_string = s;
5269 break;
5271 case VAR_LIST:
5272 len = list_len(rettv->vval.v_list);
5273 if (n1 < 0)
5274 n1 = len + n1;
5275 if (!empty1 && (n1 < 0 || n1 >= len))
5277 /* For a range we allow invalid values and return an empty
5278 * list. A list index out of range is an error. */
5279 if (!range)
5281 if (verbose)
5282 EMSGN(_(e_listidx), n1);
5283 return FAIL;
5285 n1 = len;
5287 if (range)
5289 list_T *l;
5290 listitem_T *item;
5292 if (n2 < 0)
5293 n2 = len + n2;
5294 else if (n2 >= len)
5295 n2 = len - 1;
5296 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5297 n2 = -1;
5298 l = list_alloc();
5299 if (l == NULL)
5300 return FAIL;
5301 for (item = list_find(rettv->vval.v_list, n1);
5302 n1 <= n2; ++n1)
5304 if (list_append_tv(l, &item->li_tv) == FAIL)
5306 list_free(l, TRUE);
5307 return FAIL;
5309 item = item->li_next;
5311 clear_tv(rettv);
5312 rettv->v_type = VAR_LIST;
5313 rettv->vval.v_list = l;
5314 ++l->lv_refcount;
5316 else
5318 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5319 clear_tv(rettv);
5320 *rettv = var1;
5322 break;
5324 case VAR_DICT:
5325 if (range)
5327 if (verbose)
5328 EMSG(_(e_dictrange));
5329 if (len == -1)
5330 clear_tv(&var1);
5331 return FAIL;
5334 dictitem_T *item;
5336 if (len == -1)
5338 key = get_tv_string(&var1);
5339 if (*key == NUL)
5341 if (verbose)
5342 EMSG(_(e_emptykey));
5343 clear_tv(&var1);
5344 return FAIL;
5348 item = dict_find(rettv->vval.v_dict, key, (int)len);
5350 if (item == NULL && verbose)
5351 EMSG2(_(e_dictkey), key);
5352 if (len == -1)
5353 clear_tv(&var1);
5354 if (item == NULL)
5355 return FAIL;
5357 copy_tv(&item->di_tv, &var1);
5358 clear_tv(rettv);
5359 *rettv = var1;
5361 break;
5365 return OK;
5369 * Get an option value.
5370 * "arg" points to the '&' or '+' before the option name.
5371 * "arg" is advanced to character after the option name.
5372 * Return OK or FAIL.
5374 static int
5375 get_option_tv(arg, rettv, evaluate)
5376 char_u **arg;
5377 typval_T *rettv; /* when NULL, only check if option exists */
5378 int evaluate;
5380 char_u *option_end;
5381 long numval;
5382 char_u *stringval;
5383 int opt_type;
5384 int c;
5385 int working = (**arg == '+'); /* has("+option") */
5386 int ret = OK;
5387 int opt_flags;
5390 * Isolate the option name and find its value.
5392 option_end = find_option_end(arg, &opt_flags);
5393 if (option_end == NULL)
5395 if (rettv != NULL)
5396 EMSG2(_("E112: Option name missing: %s"), *arg);
5397 return FAIL;
5400 if (!evaluate)
5402 *arg = option_end;
5403 return OK;
5406 c = *option_end;
5407 *option_end = NUL;
5408 opt_type = get_option_value(*arg, &numval,
5409 rettv == NULL ? NULL : &stringval, opt_flags);
5411 if (opt_type == -3) /* invalid name */
5413 if (rettv != NULL)
5414 EMSG2(_("E113: Unknown option: %s"), *arg);
5415 ret = FAIL;
5417 else if (rettv != NULL)
5419 if (opt_type == -2) /* hidden string option */
5421 rettv->v_type = VAR_STRING;
5422 rettv->vval.v_string = NULL;
5424 else if (opt_type == -1) /* hidden number option */
5426 rettv->v_type = VAR_NUMBER;
5427 rettv->vval.v_number = 0;
5429 else if (opt_type == 1) /* number option */
5431 rettv->v_type = VAR_NUMBER;
5432 rettv->vval.v_number = numval;
5434 else /* string option */
5436 rettv->v_type = VAR_STRING;
5437 rettv->vval.v_string = stringval;
5440 else if (working && (opt_type == -2 || opt_type == -1))
5441 ret = FAIL;
5443 *option_end = c; /* put back for error messages */
5444 *arg = option_end;
5446 return ret;
5450 * Allocate a variable for a string constant.
5451 * Return OK or FAIL.
5453 static int
5454 get_string_tv(arg, rettv, evaluate)
5455 char_u **arg;
5456 typval_T *rettv;
5457 int evaluate;
5459 char_u *p;
5460 char_u *name;
5461 int extra = 0;
5464 * Find the end of the string, skipping backslashed characters.
5466 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5468 if (*p == '\\' && p[1] != NUL)
5470 ++p;
5471 /* A "\<x>" form occupies at least 4 characters, and produces up
5472 * to 6 characters: reserve space for 2 extra */
5473 if (*p == '<')
5474 extra += 2;
5478 if (*p != '"')
5480 EMSG2(_("E114: Missing quote: %s"), *arg);
5481 return FAIL;
5484 /* If only parsing, set *arg and return here */
5485 if (!evaluate)
5487 *arg = p + 1;
5488 return OK;
5492 * Copy the string into allocated memory, handling backslashed
5493 * characters.
5495 name = alloc((unsigned)(p - *arg + extra));
5496 if (name == NULL)
5497 return FAIL;
5498 rettv->v_type = VAR_STRING;
5499 rettv->vval.v_string = name;
5501 for (p = *arg + 1; *p != NUL && *p != '"'; )
5503 if (*p == '\\')
5505 switch (*++p)
5507 case 'b': *name++ = BS; ++p; break;
5508 case 'e': *name++ = ESC; ++p; break;
5509 case 'f': *name++ = FF; ++p; break;
5510 case 'n': *name++ = NL; ++p; break;
5511 case 'r': *name++ = CAR; ++p; break;
5512 case 't': *name++ = TAB; ++p; break;
5514 case 'X': /* hex: "\x1", "\x12" */
5515 case 'x':
5516 case 'u': /* Unicode: "\u0023" */
5517 case 'U':
5518 if (vim_isxdigit(p[1]))
5520 int n, nr;
5521 int c = toupper(*p);
5523 if (c == 'X')
5524 n = 2;
5525 else
5526 n = 4;
5527 nr = 0;
5528 while (--n >= 0 && vim_isxdigit(p[1]))
5530 ++p;
5531 nr = (nr << 4) + hex2nr(*p);
5533 ++p;
5534 #ifdef FEAT_MBYTE
5535 /* For "\u" store the number according to
5536 * 'encoding'. */
5537 if (c != 'X')
5538 name += (*mb_char2bytes)(nr, name);
5539 else
5540 #endif
5541 *name++ = nr;
5543 break;
5545 /* octal: "\1", "\12", "\123" */
5546 case '0':
5547 case '1':
5548 case '2':
5549 case '3':
5550 case '4':
5551 case '5':
5552 case '6':
5553 case '7': *name = *p++ - '0';
5554 if (*p >= '0' && *p <= '7')
5556 *name = (*name << 3) + *p++ - '0';
5557 if (*p >= '0' && *p <= '7')
5558 *name = (*name << 3) + *p++ - '0';
5560 ++name;
5561 break;
5563 /* Special key, e.g.: "\<C-W>" */
5564 case '<': extra = trans_special(&p, name, TRUE);
5565 if (extra != 0)
5567 name += extra;
5568 break;
5570 /* FALLTHROUGH */
5572 default: MB_COPY_CHAR(p, name);
5573 break;
5576 else
5577 MB_COPY_CHAR(p, name);
5580 *name = NUL;
5581 *arg = p + 1;
5583 return OK;
5587 * Allocate a variable for a 'str''ing' constant.
5588 * Return OK or FAIL.
5590 static int
5591 get_lit_string_tv(arg, rettv, evaluate)
5592 char_u **arg;
5593 typval_T *rettv;
5594 int evaluate;
5596 char_u *p;
5597 char_u *str;
5598 int reduce = 0;
5601 * Find the end of the string, skipping ''.
5603 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5605 if (*p == '\'')
5607 if (p[1] != '\'')
5608 break;
5609 ++reduce;
5610 ++p;
5614 if (*p != '\'')
5616 EMSG2(_("E115: Missing quote: %s"), *arg);
5617 return FAIL;
5620 /* If only parsing return after setting "*arg" */
5621 if (!evaluate)
5623 *arg = p + 1;
5624 return OK;
5628 * Copy the string into allocated memory, handling '' to ' reduction.
5630 str = alloc((unsigned)((p - *arg) - reduce));
5631 if (str == NULL)
5632 return FAIL;
5633 rettv->v_type = VAR_STRING;
5634 rettv->vval.v_string = str;
5636 for (p = *arg + 1; *p != NUL; )
5638 if (*p == '\'')
5640 if (p[1] != '\'')
5641 break;
5642 ++p;
5644 MB_COPY_CHAR(p, str);
5646 *str = NUL;
5647 *arg = p + 1;
5649 return OK;
5653 * Allocate a variable for a List and fill it from "*arg".
5654 * Return OK or FAIL.
5656 static int
5657 get_list_tv(arg, rettv, evaluate)
5658 char_u **arg;
5659 typval_T *rettv;
5660 int evaluate;
5662 list_T *l = NULL;
5663 typval_T tv;
5664 listitem_T *item;
5666 if (evaluate)
5668 l = list_alloc();
5669 if (l == NULL)
5670 return FAIL;
5673 *arg = skipwhite(*arg + 1);
5674 while (**arg != ']' && **arg != NUL)
5676 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5677 goto failret;
5678 if (evaluate)
5680 item = listitem_alloc();
5681 if (item != NULL)
5683 item->li_tv = tv;
5684 item->li_tv.v_lock = 0;
5685 list_append(l, item);
5687 else
5688 clear_tv(&tv);
5691 if (**arg == ']')
5692 break;
5693 if (**arg != ',')
5695 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5696 goto failret;
5698 *arg = skipwhite(*arg + 1);
5701 if (**arg != ']')
5703 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5704 failret:
5705 if (evaluate)
5706 list_free(l, TRUE);
5707 return FAIL;
5710 *arg = skipwhite(*arg + 1);
5711 if (evaluate)
5713 rettv->v_type = VAR_LIST;
5714 rettv->vval.v_list = l;
5715 ++l->lv_refcount;
5718 return OK;
5722 * Allocate an empty header for a list.
5723 * Caller should take care of the reference count.
5725 list_T *
5726 list_alloc()
5728 list_T *l;
5730 l = (list_T *)alloc_clear(sizeof(list_T));
5731 if (l != NULL)
5733 /* Prepend the list to the list of lists for garbage collection. */
5734 if (first_list != NULL)
5735 first_list->lv_used_prev = l;
5736 l->lv_used_prev = NULL;
5737 l->lv_used_next = first_list;
5738 first_list = l;
5740 return l;
5744 * Allocate an empty list for a return value.
5745 * Returns OK or FAIL.
5747 static int
5748 rettv_list_alloc(rettv)
5749 typval_T *rettv;
5751 list_T *l = list_alloc();
5753 if (l == NULL)
5754 return FAIL;
5756 rettv->vval.v_list = l;
5757 rettv->v_type = VAR_LIST;
5758 ++l->lv_refcount;
5759 return OK;
5763 * Unreference a list: decrement the reference count and free it when it
5764 * becomes zero.
5766 void
5767 list_unref(l)
5768 list_T *l;
5770 if (l != NULL && --l->lv_refcount <= 0)
5771 list_free(l, TRUE);
5775 * Free a list, including all items it points to.
5776 * Ignores the reference count.
5778 void
5779 list_free(l, recurse)
5780 list_T *l;
5781 int recurse; /* Free Lists and Dictionaries recursively. */
5783 listitem_T *item;
5785 /* Remove the list from the list of lists for garbage collection. */
5786 if (l->lv_used_prev == NULL)
5787 first_list = l->lv_used_next;
5788 else
5789 l->lv_used_prev->lv_used_next = l->lv_used_next;
5790 if (l->lv_used_next != NULL)
5791 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5793 for (item = l->lv_first; item != NULL; item = l->lv_first)
5795 /* Remove the item before deleting it. */
5796 l->lv_first = item->li_next;
5797 if (recurse || (item->li_tv.v_type != VAR_LIST
5798 && item->li_tv.v_type != VAR_DICT))
5799 clear_tv(&item->li_tv);
5800 vim_free(item);
5802 vim_free(l);
5806 * Allocate a list item.
5808 static listitem_T *
5809 listitem_alloc()
5811 return (listitem_T *)alloc(sizeof(listitem_T));
5815 * Free a list item. Also clears the value. Does not notify watchers.
5817 static void
5818 listitem_free(item)
5819 listitem_T *item;
5821 clear_tv(&item->li_tv);
5822 vim_free(item);
5826 * Remove a list item from a List and free it. Also clears the value.
5828 static void
5829 listitem_remove(l, item)
5830 list_T *l;
5831 listitem_T *item;
5833 list_remove(l, item, item);
5834 listitem_free(item);
5838 * Get the number of items in a list.
5840 static long
5841 list_len(l)
5842 list_T *l;
5844 if (l == NULL)
5845 return 0L;
5846 return l->lv_len;
5850 * Return TRUE when two lists have exactly the same values.
5852 static int
5853 list_equal(l1, l2, ic)
5854 list_T *l1;
5855 list_T *l2;
5856 int ic; /* ignore case for strings */
5858 listitem_T *item1, *item2;
5860 if (l1 == NULL || l2 == NULL)
5861 return FALSE;
5862 if (l1 == l2)
5863 return TRUE;
5864 if (list_len(l1) != list_len(l2))
5865 return FALSE;
5867 for (item1 = l1->lv_first, item2 = l2->lv_first;
5868 item1 != NULL && item2 != NULL;
5869 item1 = item1->li_next, item2 = item2->li_next)
5870 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5871 return FALSE;
5872 return item1 == NULL && item2 == NULL;
5875 #if defined(FEAT_RUBY) || defined(FEAT_PYTHON) || defined(FEAT_MZSCHEME) \
5876 || defined(PROTO)
5878 * Return the dictitem that an entry in a hashtable points to.
5880 dictitem_T *
5881 dict_lookup(hi)
5882 hashitem_T *hi;
5884 return HI2DI(hi);
5886 #endif
5889 * Return TRUE when two dictionaries have exactly the same key/values.
5891 static int
5892 dict_equal(d1, d2, ic)
5893 dict_T *d1;
5894 dict_T *d2;
5895 int ic; /* ignore case for strings */
5897 hashitem_T *hi;
5898 dictitem_T *item2;
5899 int todo;
5901 if (d1 == NULL || d2 == NULL)
5902 return FALSE;
5903 if (d1 == d2)
5904 return TRUE;
5905 if (dict_len(d1) != dict_len(d2))
5906 return FALSE;
5908 todo = (int)d1->dv_hashtab.ht_used;
5909 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5911 if (!HASHITEM_EMPTY(hi))
5913 item2 = dict_find(d2, hi->hi_key, -1);
5914 if (item2 == NULL)
5915 return FALSE;
5916 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5917 return FALSE;
5918 --todo;
5921 return TRUE;
5925 * Return TRUE if "tv1" and "tv2" have the same value.
5926 * Compares the items just like "==" would compare them, but strings and
5927 * numbers are different. Floats and numbers are also different.
5929 static int
5930 tv_equal(tv1, tv2, ic)
5931 typval_T *tv1;
5932 typval_T *tv2;
5933 int ic; /* ignore case */
5935 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5936 char_u *s1, *s2;
5937 static int recursive = 0; /* cach recursive loops */
5938 int r;
5940 if (tv1->v_type != tv2->v_type)
5941 return FALSE;
5942 /* Catch lists and dicts that have an endless loop by limiting
5943 * recursiveness to 1000. We guess they are equal then. */
5944 if (recursive >= 1000)
5945 return TRUE;
5947 switch (tv1->v_type)
5949 case VAR_LIST:
5950 ++recursive;
5951 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5952 --recursive;
5953 return r;
5955 case VAR_DICT:
5956 ++recursive;
5957 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5958 --recursive;
5959 return r;
5961 case VAR_FUNC:
5962 return (tv1->vval.v_string != NULL
5963 && tv2->vval.v_string != NULL
5964 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5966 case VAR_NUMBER:
5967 return tv1->vval.v_number == tv2->vval.v_number;
5969 #ifdef FEAT_FLOAT
5970 case VAR_FLOAT:
5971 return tv1->vval.v_float == tv2->vval.v_float;
5972 #endif
5974 case VAR_STRING:
5975 s1 = get_tv_string_buf(tv1, buf1);
5976 s2 = get_tv_string_buf(tv2, buf2);
5977 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5980 EMSG2(_(e_intern2), "tv_equal()");
5981 return TRUE;
5985 * Locate item with index "n" in list "l" and return it.
5986 * A negative index is counted from the end; -1 is the last item.
5987 * Returns NULL when "n" is out of range.
5989 static listitem_T *
5990 list_find(l, n)
5991 list_T *l;
5992 long n;
5994 listitem_T *item;
5995 long idx;
5997 if (l == NULL)
5998 return NULL;
6000 /* Negative index is relative to the end. */
6001 if (n < 0)
6002 n = l->lv_len + n;
6004 /* Check for index out of range. */
6005 if (n < 0 || n >= l->lv_len)
6006 return NULL;
6008 /* When there is a cached index may start search from there. */
6009 if (l->lv_idx_item != NULL)
6011 if (n < l->lv_idx / 2)
6013 /* closest to the start of the list */
6014 item = l->lv_first;
6015 idx = 0;
6017 else if (n > (l->lv_idx + l->lv_len) / 2)
6019 /* closest to the end of the list */
6020 item = l->lv_last;
6021 idx = l->lv_len - 1;
6023 else
6025 /* closest to the cached index */
6026 item = l->lv_idx_item;
6027 idx = l->lv_idx;
6030 else
6032 if (n < l->lv_len / 2)
6034 /* closest to the start of the list */
6035 item = l->lv_first;
6036 idx = 0;
6038 else
6040 /* closest to the end of the list */
6041 item = l->lv_last;
6042 idx = l->lv_len - 1;
6046 while (n > idx)
6048 /* search forward */
6049 item = item->li_next;
6050 ++idx;
6052 while (n < idx)
6054 /* search backward */
6055 item = item->li_prev;
6056 --idx;
6059 /* cache the used index */
6060 l->lv_idx = idx;
6061 l->lv_idx_item = item;
6063 return item;
6067 * Get list item "l[idx]" as a number.
6069 static long
6070 list_find_nr(l, idx, errorp)
6071 list_T *l;
6072 long idx;
6073 int *errorp; /* set to TRUE when something wrong */
6075 listitem_T *li;
6077 li = list_find(l, idx);
6078 if (li == NULL)
6080 if (errorp != NULL)
6081 *errorp = TRUE;
6082 return -1L;
6084 return get_tv_number_chk(&li->li_tv, errorp);
6088 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6090 char_u *
6091 list_find_str(l, idx)
6092 list_T *l;
6093 long idx;
6095 listitem_T *li;
6097 li = list_find(l, idx - 1);
6098 if (li == NULL)
6100 EMSGN(_(e_listidx), idx);
6101 return NULL;
6103 return get_tv_string(&li->li_tv);
6107 * Locate "item" list "l" and return its index.
6108 * Returns -1 when "item" is not in the list.
6110 static long
6111 list_idx_of_item(l, item)
6112 list_T *l;
6113 listitem_T *item;
6115 long idx = 0;
6116 listitem_T *li;
6118 if (l == NULL)
6119 return -1;
6120 idx = 0;
6121 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6122 ++idx;
6123 if (li == NULL)
6124 return -1;
6125 return idx;
6129 * Append item "item" to the end of list "l".
6131 static void
6132 list_append(l, item)
6133 list_T *l;
6134 listitem_T *item;
6136 if (l->lv_last == NULL)
6138 /* empty list */
6139 l->lv_first = item;
6140 l->lv_last = item;
6141 item->li_prev = NULL;
6143 else
6145 l->lv_last->li_next = item;
6146 item->li_prev = l->lv_last;
6147 l->lv_last = item;
6149 ++l->lv_len;
6150 item->li_next = NULL;
6154 * Append typval_T "tv" to the end of list "l".
6155 * Return FAIL when out of memory.
6158 list_append_tv(l, tv)
6159 list_T *l;
6160 typval_T *tv;
6162 listitem_T *li = listitem_alloc();
6164 if (li == NULL)
6165 return FAIL;
6166 copy_tv(tv, &li->li_tv);
6167 list_append(l, li);
6168 return OK;
6172 * Add a dictionary to a list. Used by getqflist().
6173 * Return FAIL when out of memory.
6176 list_append_dict(list, dict)
6177 list_T *list;
6178 dict_T *dict;
6180 listitem_T *li = listitem_alloc();
6182 if (li == NULL)
6183 return FAIL;
6184 li->li_tv.v_type = VAR_DICT;
6185 li->li_tv.v_lock = 0;
6186 li->li_tv.vval.v_dict = dict;
6187 list_append(list, li);
6188 ++dict->dv_refcount;
6189 return OK;
6193 * Make a copy of "str" and append it as an item to list "l".
6194 * When "len" >= 0 use "str[len]".
6195 * Returns FAIL when out of memory.
6198 list_append_string(l, str, len)
6199 list_T *l;
6200 char_u *str;
6201 int len;
6203 listitem_T *li = listitem_alloc();
6205 if (li == NULL)
6206 return FAIL;
6207 list_append(l, li);
6208 li->li_tv.v_type = VAR_STRING;
6209 li->li_tv.v_lock = 0;
6210 if (str == NULL)
6211 li->li_tv.vval.v_string = NULL;
6212 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6213 : vim_strsave(str))) == NULL)
6214 return FAIL;
6215 return OK;
6219 * Append "n" to list "l".
6220 * Returns FAIL when out of memory.
6222 static int
6223 list_append_number(l, n)
6224 list_T *l;
6225 varnumber_T n;
6227 listitem_T *li;
6229 li = listitem_alloc();
6230 if (li == NULL)
6231 return FAIL;
6232 li->li_tv.v_type = VAR_NUMBER;
6233 li->li_tv.v_lock = 0;
6234 li->li_tv.vval.v_number = n;
6235 list_append(l, li);
6236 return OK;
6240 * Insert typval_T "tv" in list "l" before "item".
6241 * If "item" is NULL append at the end.
6242 * Return FAIL when out of memory.
6244 static int
6245 list_insert_tv(l, tv, item)
6246 list_T *l;
6247 typval_T *tv;
6248 listitem_T *item;
6250 listitem_T *ni = listitem_alloc();
6252 if (ni == NULL)
6253 return FAIL;
6254 copy_tv(tv, &ni->li_tv);
6255 if (item == NULL)
6256 /* Append new item at end of list. */
6257 list_append(l, ni);
6258 else
6260 /* Insert new item before existing item. */
6261 ni->li_prev = item->li_prev;
6262 ni->li_next = item;
6263 if (item->li_prev == NULL)
6265 l->lv_first = ni;
6266 ++l->lv_idx;
6268 else
6270 item->li_prev->li_next = ni;
6271 l->lv_idx_item = NULL;
6273 item->li_prev = ni;
6274 ++l->lv_len;
6276 return OK;
6280 * Extend "l1" with "l2".
6281 * If "bef" is NULL append at the end, otherwise insert before this item.
6282 * Returns FAIL when out of memory.
6284 static int
6285 list_extend(l1, l2, bef)
6286 list_T *l1;
6287 list_T *l2;
6288 listitem_T *bef;
6290 listitem_T *item;
6291 int todo = l2->lv_len;
6293 /* We also quit the loop when we have inserted the original item count of
6294 * the list, avoid a hang when we extend a list with itself. */
6295 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6296 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6297 return FAIL;
6298 return OK;
6302 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6303 * Return FAIL when out of memory.
6305 static int
6306 list_concat(l1, l2, tv)
6307 list_T *l1;
6308 list_T *l2;
6309 typval_T *tv;
6311 list_T *l;
6313 if (l1 == NULL || l2 == NULL)
6314 return FAIL;
6316 /* make a copy of the first list. */
6317 l = list_copy(l1, FALSE, 0);
6318 if (l == NULL)
6319 return FAIL;
6320 tv->v_type = VAR_LIST;
6321 tv->vval.v_list = l;
6323 /* append all items from the second list */
6324 return list_extend(l, l2, NULL);
6328 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6329 * The refcount of the new list is set to 1.
6330 * See item_copy() for "copyID".
6331 * Returns NULL when out of memory.
6333 static list_T *
6334 list_copy(orig, deep, copyID)
6335 list_T *orig;
6336 int deep;
6337 int copyID;
6339 list_T *copy;
6340 listitem_T *item;
6341 listitem_T *ni;
6343 if (orig == NULL)
6344 return NULL;
6346 copy = list_alloc();
6347 if (copy != NULL)
6349 if (copyID != 0)
6351 /* Do this before adding the items, because one of the items may
6352 * refer back to this list. */
6353 orig->lv_copyID = copyID;
6354 orig->lv_copylist = copy;
6356 for (item = orig->lv_first; item != NULL && !got_int;
6357 item = item->li_next)
6359 ni = listitem_alloc();
6360 if (ni == NULL)
6361 break;
6362 if (deep)
6364 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6366 vim_free(ni);
6367 break;
6370 else
6371 copy_tv(&item->li_tv, &ni->li_tv);
6372 list_append(copy, ni);
6374 ++copy->lv_refcount;
6375 if (item != NULL)
6377 list_unref(copy);
6378 copy = NULL;
6382 return copy;
6386 * Remove items "item" to "item2" from list "l".
6387 * Does not free the listitem or the value!
6389 static void
6390 list_remove(l, item, item2)
6391 list_T *l;
6392 listitem_T *item;
6393 listitem_T *item2;
6395 listitem_T *ip;
6397 /* notify watchers */
6398 for (ip = item; ip != NULL; ip = ip->li_next)
6400 --l->lv_len;
6401 list_fix_watch(l, ip);
6402 if (ip == item2)
6403 break;
6406 if (item2->li_next == NULL)
6407 l->lv_last = item->li_prev;
6408 else
6409 item2->li_next->li_prev = item->li_prev;
6410 if (item->li_prev == NULL)
6411 l->lv_first = item2->li_next;
6412 else
6413 item->li_prev->li_next = item2->li_next;
6414 l->lv_idx_item = NULL;
6418 * Return an allocated string with the string representation of a list.
6419 * May return NULL.
6421 static char_u *
6422 list2string(tv, copyID)
6423 typval_T *tv;
6424 int copyID;
6426 garray_T ga;
6428 if (tv->vval.v_list == NULL)
6429 return NULL;
6430 ga_init2(&ga, (int)sizeof(char), 80);
6431 ga_append(&ga, '[');
6432 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6434 vim_free(ga.ga_data);
6435 return NULL;
6437 ga_append(&ga, ']');
6438 ga_append(&ga, NUL);
6439 return (char_u *)ga.ga_data;
6443 * Join list "l" into a string in "*gap", using separator "sep".
6444 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6445 * Return FAIL or OK.
6447 static int
6448 list_join(gap, l, sep, echo, copyID)
6449 garray_T *gap;
6450 list_T *l;
6451 char_u *sep;
6452 int echo;
6453 int copyID;
6455 int first = TRUE;
6456 char_u *tofree;
6457 char_u numbuf[NUMBUFLEN];
6458 listitem_T *item;
6459 char_u *s;
6461 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6463 if (first)
6464 first = FALSE;
6465 else
6466 ga_concat(gap, sep);
6468 if (echo)
6469 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6470 else
6471 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6472 if (s != NULL)
6473 ga_concat(gap, s);
6474 vim_free(tofree);
6475 if (s == NULL)
6476 return FAIL;
6477 line_breakcheck();
6479 return OK;
6483 * Garbage collection for lists and dictionaries.
6485 * We use reference counts to be able to free most items right away when they
6486 * are no longer used. But for composite items it's possible that it becomes
6487 * unused while the reference count is > 0: When there is a recursive
6488 * reference. Example:
6489 * :let l = [1, 2, 3]
6490 * :let d = {9: l}
6491 * :let l[1] = d
6493 * Since this is quite unusual we handle this with garbage collection: every
6494 * once in a while find out which lists and dicts are not referenced from any
6495 * variable.
6497 * Here is a good reference text about garbage collection (refers to Python
6498 * but it applies to all reference-counting mechanisms):
6499 * http://python.ca/nas/python/gc/
6503 * Do garbage collection for lists and dicts.
6504 * Return TRUE if some memory was freed.
6507 garbage_collect()
6509 int copyID;
6510 buf_T *buf;
6511 win_T *wp;
6512 int i;
6513 funccall_T *fc, **pfc;
6514 int did_free;
6515 int did_free_funccal = FALSE;
6516 #ifdef FEAT_WINDOWS
6517 tabpage_T *tp;
6518 #endif
6520 /* Only do this once. */
6521 want_garbage_collect = FALSE;
6522 may_garbage_collect = FALSE;
6523 garbage_collect_at_exit = FALSE;
6525 /* We advance by two because we add one for items referenced through
6526 * previous_funccal. */
6527 current_copyID += COPYID_INC;
6528 copyID = current_copyID;
6531 * 1. Go through all accessible variables and mark all lists and dicts
6532 * with copyID.
6535 /* Don't free variables in the previous_funccal list unless they are only
6536 * referenced through previous_funccal. This must be first, because if
6537 * the item is referenced elsewhere the funccal must not be freed. */
6538 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
6540 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1);
6541 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1);
6544 /* script-local variables */
6545 for (i = 1; i <= ga_scripts.ga_len; ++i)
6546 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6548 /* buffer-local variables */
6549 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6550 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6552 /* window-local variables */
6553 FOR_ALL_TAB_WINDOWS(tp, wp)
6554 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6556 #ifdef FEAT_WINDOWS
6557 /* tabpage-local variables */
6558 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6559 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6560 #endif
6562 /* global variables */
6563 set_ref_in_ht(&globvarht, copyID);
6565 /* function-local variables */
6566 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6568 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6569 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6572 /* v: vars */
6573 set_ref_in_ht(&vimvarht, copyID);
6576 * 2. Free lists and dictionaries that are not referenced.
6578 did_free = free_unref_items(copyID);
6581 * 3. Check if any funccal can be freed now.
6583 for (pfc = &previous_funccal; *pfc != NULL; )
6585 if (can_free_funccal(*pfc, copyID))
6587 fc = *pfc;
6588 *pfc = fc->caller;
6589 free_funccal(fc, TRUE);
6590 did_free = TRUE;
6591 did_free_funccal = TRUE;
6593 else
6594 pfc = &(*pfc)->caller;
6596 if (did_free_funccal)
6597 /* When a funccal was freed some more items might be garbage
6598 * collected, so run again. */
6599 (void)garbage_collect();
6601 return did_free;
6605 * Free lists and dictionaries that are no longer referenced.
6607 static int
6608 free_unref_items(copyID)
6609 int copyID;
6611 dict_T *dd;
6612 list_T *ll;
6613 int did_free = FALSE;
6616 * Go through the list of dicts and free items without the copyID.
6618 for (dd = first_dict; dd != NULL; )
6619 if ((dd->dv_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
6621 /* Free the Dictionary and ordinary items it contains, but don't
6622 * recurse into Lists and Dictionaries, they will be in the list
6623 * of dicts or list of lists. */
6624 dict_free(dd, FALSE);
6625 did_free = TRUE;
6627 /* restart, next dict may also have been freed */
6628 dd = first_dict;
6630 else
6631 dd = dd->dv_used_next;
6634 * Go through the list of lists and free items without the copyID.
6635 * But don't free a list that has a watcher (used in a for loop), these
6636 * are not referenced anywhere.
6638 for (ll = first_list; ll != NULL; )
6639 if ((ll->lv_copyID & COPYID_MASK) != (copyID & COPYID_MASK)
6640 && ll->lv_watch == NULL)
6642 /* Free the List and ordinary items it contains, but don't recurse
6643 * into Lists and Dictionaries, they will be in the list of dicts
6644 * or list of lists. */
6645 list_free(ll, FALSE);
6646 did_free = TRUE;
6648 /* restart, next list may also have been freed */
6649 ll = first_list;
6651 else
6652 ll = ll->lv_used_next;
6654 return did_free;
6658 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6660 static void
6661 set_ref_in_ht(ht, copyID)
6662 hashtab_T *ht;
6663 int copyID;
6665 int todo;
6666 hashitem_T *hi;
6668 todo = (int)ht->ht_used;
6669 for (hi = ht->ht_array; todo > 0; ++hi)
6670 if (!HASHITEM_EMPTY(hi))
6672 --todo;
6673 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6678 * Mark all lists and dicts referenced through list "l" with "copyID".
6680 static void
6681 set_ref_in_list(l, copyID)
6682 list_T *l;
6683 int copyID;
6685 listitem_T *li;
6687 for (li = l->lv_first; li != NULL; li = li->li_next)
6688 set_ref_in_item(&li->li_tv, copyID);
6692 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6694 static void
6695 set_ref_in_item(tv, copyID)
6696 typval_T *tv;
6697 int copyID;
6699 dict_T *dd;
6700 list_T *ll;
6702 switch (tv->v_type)
6704 case VAR_DICT:
6705 dd = tv->vval.v_dict;
6706 if (dd != NULL && dd->dv_copyID != copyID)
6708 /* Didn't see this dict yet. */
6709 dd->dv_copyID = copyID;
6710 set_ref_in_ht(&dd->dv_hashtab, copyID);
6712 break;
6714 case VAR_LIST:
6715 ll = tv->vval.v_list;
6716 if (ll != NULL && ll->lv_copyID != copyID)
6718 /* Didn't see this list yet. */
6719 ll->lv_copyID = copyID;
6720 set_ref_in_list(ll, copyID);
6722 break;
6724 return;
6728 * Allocate an empty header for a dictionary.
6730 dict_T *
6731 dict_alloc()
6733 dict_T *d;
6735 d = (dict_T *)alloc(sizeof(dict_T));
6736 if (d != NULL)
6738 /* Add the list to the list of dicts for garbage collection. */
6739 if (first_dict != NULL)
6740 first_dict->dv_used_prev = d;
6741 d->dv_used_next = first_dict;
6742 d->dv_used_prev = NULL;
6743 first_dict = d;
6745 hash_init(&d->dv_hashtab);
6746 d->dv_lock = 0;
6747 d->dv_refcount = 0;
6748 d->dv_copyID = 0;
6750 return d;
6754 * Unreference a Dictionary: decrement the reference count and free it when it
6755 * becomes zero.
6757 static void
6758 dict_unref(d)
6759 dict_T *d;
6761 if (d != NULL && --d->dv_refcount <= 0)
6762 dict_free(d, TRUE);
6766 * Free a Dictionary, including all items it contains.
6767 * Ignores the reference count.
6769 static void
6770 dict_free(d, recurse)
6771 dict_T *d;
6772 int recurse; /* Free Lists and Dictionaries recursively. */
6774 int todo;
6775 hashitem_T *hi;
6776 dictitem_T *di;
6778 /* Remove the dict from the list of dicts for garbage collection. */
6779 if (d->dv_used_prev == NULL)
6780 first_dict = d->dv_used_next;
6781 else
6782 d->dv_used_prev->dv_used_next = d->dv_used_next;
6783 if (d->dv_used_next != NULL)
6784 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6786 /* Lock the hashtab, we don't want it to resize while freeing items. */
6787 hash_lock(&d->dv_hashtab);
6788 todo = (int)d->dv_hashtab.ht_used;
6789 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6791 if (!HASHITEM_EMPTY(hi))
6793 /* Remove the item before deleting it, just in case there is
6794 * something recursive causing trouble. */
6795 di = HI2DI(hi);
6796 hash_remove(&d->dv_hashtab, hi);
6797 if (recurse || (di->di_tv.v_type != VAR_LIST
6798 && di->di_tv.v_type != VAR_DICT))
6799 clear_tv(&di->di_tv);
6800 vim_free(di);
6801 --todo;
6804 hash_clear(&d->dv_hashtab);
6805 vim_free(d);
6809 * Allocate a Dictionary item.
6810 * The "key" is copied to the new item.
6811 * Note that the value of the item "di_tv" still needs to be initialized!
6812 * Returns NULL when out of memory.
6814 dictitem_T *
6815 dictitem_alloc(key)
6816 char_u *key;
6818 dictitem_T *di;
6820 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6821 if (di != NULL)
6823 STRCPY(di->di_key, key);
6824 di->di_flags = 0;
6826 return di;
6830 * Make a copy of a Dictionary item.
6832 static dictitem_T *
6833 dictitem_copy(org)
6834 dictitem_T *org;
6836 dictitem_T *di;
6838 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6839 + STRLEN(org->di_key)));
6840 if (di != NULL)
6842 STRCPY(di->di_key, org->di_key);
6843 di->di_flags = 0;
6844 copy_tv(&org->di_tv, &di->di_tv);
6846 return di;
6850 * Remove item "item" from Dictionary "dict" and free it.
6852 static void
6853 dictitem_remove(dict, item)
6854 dict_T *dict;
6855 dictitem_T *item;
6857 hashitem_T *hi;
6859 hi = hash_find(&dict->dv_hashtab, item->di_key);
6860 if (HASHITEM_EMPTY(hi))
6861 EMSG2(_(e_intern2), "dictitem_remove()");
6862 else
6863 hash_remove(&dict->dv_hashtab, hi);
6864 dictitem_free(item);
6868 * Free a dict item. Also clears the value.
6870 void
6871 dictitem_free(item)
6872 dictitem_T *item;
6874 clear_tv(&item->di_tv);
6875 vim_free(item);
6879 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6880 * The refcount of the new dict is set to 1.
6881 * See item_copy() for "copyID".
6882 * Returns NULL when out of memory.
6884 static dict_T *
6885 dict_copy(orig, deep, copyID)
6886 dict_T *orig;
6887 int deep;
6888 int copyID;
6890 dict_T *copy;
6891 dictitem_T *di;
6892 int todo;
6893 hashitem_T *hi;
6895 if (orig == NULL)
6896 return NULL;
6898 copy = dict_alloc();
6899 if (copy != NULL)
6901 if (copyID != 0)
6903 orig->dv_copyID = copyID;
6904 orig->dv_copydict = copy;
6906 todo = (int)orig->dv_hashtab.ht_used;
6907 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6909 if (!HASHITEM_EMPTY(hi))
6911 --todo;
6913 di = dictitem_alloc(hi->hi_key);
6914 if (di == NULL)
6915 break;
6916 if (deep)
6918 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6919 copyID) == FAIL)
6921 vim_free(di);
6922 break;
6925 else
6926 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6927 if (dict_add(copy, di) == FAIL)
6929 dictitem_free(di);
6930 break;
6935 ++copy->dv_refcount;
6936 if (todo > 0)
6938 dict_unref(copy);
6939 copy = NULL;
6943 return copy;
6947 * Add item "item" to Dictionary "d".
6948 * Returns FAIL when out of memory and when key already existed.
6951 dict_add(d, item)
6952 dict_T *d;
6953 dictitem_T *item;
6955 return hash_add(&d->dv_hashtab, item->di_key);
6959 * Add a number or string entry to dictionary "d".
6960 * When "str" is NULL use number "nr", otherwise use "str".
6961 * Returns FAIL when out of memory and when key already exists.
6964 dict_add_nr_str(d, key, nr, str)
6965 dict_T *d;
6966 char *key;
6967 long nr;
6968 char_u *str;
6970 dictitem_T *item;
6972 item = dictitem_alloc((char_u *)key);
6973 if (item == NULL)
6974 return FAIL;
6975 item->di_tv.v_lock = 0;
6976 if (str == NULL)
6978 item->di_tv.v_type = VAR_NUMBER;
6979 item->di_tv.vval.v_number = nr;
6981 else
6983 item->di_tv.v_type = VAR_STRING;
6984 item->di_tv.vval.v_string = vim_strsave(str);
6986 if (dict_add(d, item) == FAIL)
6988 dictitem_free(item);
6989 return FAIL;
6991 return OK;
6994 void
6995 dict_iterate_start(argvars, iter)
6996 typval_T *argvars;
6997 struct dict_iterator_S *iter;
6999 dict_T *d;
7001 if (argvars[0].v_type != VAR_DICT)
7003 iter->items = 0;
7004 return;
7007 if ((d = argvars[0].vval.v_dict) == NULL)
7009 iter->items = 0;
7010 return;
7013 iter->items = (int)d->dv_hashtab.ht_used;
7014 iter->hi = d->dv_hashtab.ht_array;
7017 /* Will return NULL after the last item. */
7018 char_u*
7019 dict_iterate_next(iter, tv_result)
7020 struct dict_iterator_S *iter;
7021 typval_T **tv_result;
7023 dictitem_T *di;
7024 char_u *result;
7026 if (iter->items <= 0)
7027 return NULL;
7029 while (HASHITEM_EMPTY(iter->hi))
7030 ++iter->hi;
7032 di = HI2DI(iter->hi);
7033 result = di->di_key;
7034 *tv_result = &di->di_tv;
7036 --iter->items;
7037 ++iter->hi;
7038 return result;
7042 * Get the number of items in a Dictionary.
7044 static long
7045 dict_len(d)
7046 dict_T *d;
7048 if (d == NULL)
7049 return 0L;
7050 return (long)d->dv_hashtab.ht_used;
7054 * Find item "key[len]" in Dictionary "d".
7055 * If "len" is negative use strlen(key).
7056 * Returns NULL when not found.
7058 static dictitem_T *
7059 dict_find(d, key, len)
7060 dict_T *d;
7061 char_u *key;
7062 int len;
7064 #define AKEYLEN 200
7065 char_u buf[AKEYLEN];
7066 char_u *akey;
7067 char_u *tofree = NULL;
7068 hashitem_T *hi;
7070 if (len < 0)
7071 akey = key;
7072 else if (len >= AKEYLEN)
7074 tofree = akey = vim_strnsave(key, len);
7075 if (akey == NULL)
7076 return NULL;
7078 else
7080 /* Avoid a malloc/free by using buf[]. */
7081 vim_strncpy(buf, key, len);
7082 akey = buf;
7085 hi = hash_find(&d->dv_hashtab, akey);
7086 vim_free(tofree);
7087 if (HASHITEM_EMPTY(hi))
7088 return NULL;
7089 return HI2DI(hi);
7093 * Get a string item from a dictionary.
7094 * When "save" is TRUE allocate memory for it.
7095 * Returns NULL if the entry doesn't exist or out of memory.
7097 char_u *
7098 get_dict_string(d, key, save)
7099 dict_T *d;
7100 char_u *key;
7101 int save;
7103 dictitem_T *di;
7104 char_u *s;
7106 di = dict_find(d, key, -1);
7107 if (di == NULL)
7108 return NULL;
7109 s = get_tv_string(&di->di_tv);
7110 if (save && s != NULL)
7111 s = vim_strsave(s);
7112 return s;
7116 * Get a number item from a dictionary.
7117 * Returns 0 if the entry doesn't exist or out of memory.
7119 long
7120 get_dict_number(d, key)
7121 dict_T *d;
7122 char_u *key;
7124 dictitem_T *di;
7126 di = dict_find(d, key, -1);
7127 if (di == NULL)
7128 return 0;
7129 return get_tv_number(&di->di_tv);
7133 * Return an allocated string with the string representation of a Dictionary.
7134 * May return NULL.
7136 static char_u *
7137 dict2string(tv, copyID)
7138 typval_T *tv;
7139 int copyID;
7141 garray_T ga;
7142 int first = TRUE;
7143 char_u *tofree;
7144 char_u numbuf[NUMBUFLEN];
7145 hashitem_T *hi;
7146 char_u *s;
7147 dict_T *d;
7148 int todo;
7150 if ((d = tv->vval.v_dict) == NULL)
7151 return NULL;
7152 ga_init2(&ga, (int)sizeof(char), 80);
7153 ga_append(&ga, '{');
7155 todo = (int)d->dv_hashtab.ht_used;
7156 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7158 if (!HASHITEM_EMPTY(hi))
7160 --todo;
7162 if (first)
7163 first = FALSE;
7164 else
7165 ga_concat(&ga, (char_u *)", ");
7167 tofree = string_quote(hi->hi_key, FALSE);
7168 if (tofree != NULL)
7170 ga_concat(&ga, tofree);
7171 vim_free(tofree);
7173 ga_concat(&ga, (char_u *)": ");
7174 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7175 if (s != NULL)
7176 ga_concat(&ga, s);
7177 vim_free(tofree);
7178 if (s == NULL)
7179 break;
7182 if (todo > 0)
7184 vim_free(ga.ga_data);
7185 return NULL;
7188 ga_append(&ga, '}');
7189 ga_append(&ga, NUL);
7190 return (char_u *)ga.ga_data;
7194 * Allocate a variable for a Dictionary and fill it from "*arg".
7195 * Return OK or FAIL. Returns NOTDONE for {expr}.
7197 static int
7198 get_dict_tv(arg, rettv, evaluate)
7199 char_u **arg;
7200 typval_T *rettv;
7201 int evaluate;
7203 dict_T *d = NULL;
7204 typval_T tvkey;
7205 typval_T tv;
7206 char_u *key = NULL;
7207 dictitem_T *item;
7208 char_u *start = skipwhite(*arg + 1);
7209 char_u buf[NUMBUFLEN];
7212 * First check if it's not a curly-braces thing: {expr}.
7213 * Must do this without evaluating, otherwise a function may be called
7214 * twice. Unfortunately this means we need to call eval1() twice for the
7215 * first item.
7216 * But {} is an empty Dictionary.
7218 if (*start != '}')
7220 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7221 return FAIL;
7222 if (*start == '}')
7223 return NOTDONE;
7226 if (evaluate)
7228 d = dict_alloc();
7229 if (d == NULL)
7230 return FAIL;
7232 tvkey.v_type = VAR_UNKNOWN;
7233 tv.v_type = VAR_UNKNOWN;
7235 *arg = skipwhite(*arg + 1);
7236 while (**arg != '}' && **arg != NUL)
7238 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7239 goto failret;
7240 if (**arg != ':')
7242 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7243 clear_tv(&tvkey);
7244 goto failret;
7246 if (evaluate)
7248 key = get_tv_string_buf_chk(&tvkey, buf);
7249 if (key == NULL || *key == NUL)
7251 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7252 if (key != NULL)
7253 EMSG(_(e_emptykey));
7254 clear_tv(&tvkey);
7255 goto failret;
7259 *arg = skipwhite(*arg + 1);
7260 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7262 if (evaluate)
7263 clear_tv(&tvkey);
7264 goto failret;
7266 if (evaluate)
7268 item = dict_find(d, key, -1);
7269 if (item != NULL)
7271 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7272 clear_tv(&tvkey);
7273 clear_tv(&tv);
7274 goto failret;
7276 item = dictitem_alloc(key);
7277 clear_tv(&tvkey);
7278 if (item != NULL)
7280 item->di_tv = tv;
7281 item->di_tv.v_lock = 0;
7282 if (dict_add(d, item) == FAIL)
7283 dictitem_free(item);
7287 if (**arg == '}')
7288 break;
7289 if (**arg != ',')
7291 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7292 goto failret;
7294 *arg = skipwhite(*arg + 1);
7297 if (**arg != '}')
7299 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7300 failret:
7301 if (evaluate)
7302 dict_free(d, TRUE);
7303 return FAIL;
7306 *arg = skipwhite(*arg + 1);
7307 if (evaluate)
7309 rettv->v_type = VAR_DICT;
7310 rettv->vval.v_dict = d;
7311 ++d->dv_refcount;
7314 return OK;
7318 * Return a string with the string representation of a variable.
7319 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7320 * "numbuf" is used for a number.
7321 * Does not put quotes around strings, as ":echo" displays values.
7322 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7323 * May return NULL.
7325 static char_u *
7326 echo_string(tv, tofree, numbuf, copyID)
7327 typval_T *tv;
7328 char_u **tofree;
7329 char_u *numbuf;
7330 int copyID;
7332 static int recurse = 0;
7333 char_u *r = NULL;
7335 if (recurse >= DICT_MAXNEST)
7337 EMSG(_("E724: variable nested too deep for displaying"));
7338 *tofree = NULL;
7339 return NULL;
7341 ++recurse;
7343 switch (tv->v_type)
7345 case VAR_FUNC:
7346 *tofree = NULL;
7347 r = tv->vval.v_string;
7348 break;
7350 case VAR_LIST:
7351 if (tv->vval.v_list == NULL)
7353 *tofree = NULL;
7354 r = NULL;
7356 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7358 *tofree = NULL;
7359 r = (char_u *)"[...]";
7361 else
7363 tv->vval.v_list->lv_copyID = copyID;
7364 *tofree = list2string(tv, copyID);
7365 r = *tofree;
7367 break;
7369 case VAR_DICT:
7370 if (tv->vval.v_dict == NULL)
7372 *tofree = NULL;
7373 r = NULL;
7375 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7377 *tofree = NULL;
7378 r = (char_u *)"{...}";
7380 else
7382 tv->vval.v_dict->dv_copyID = copyID;
7383 *tofree = dict2string(tv, copyID);
7384 r = *tofree;
7386 break;
7388 case VAR_STRING:
7389 case VAR_NUMBER:
7390 *tofree = NULL;
7391 r = get_tv_string_buf(tv, numbuf);
7392 break;
7394 #ifdef FEAT_FLOAT
7395 case VAR_FLOAT:
7396 *tofree = NULL;
7397 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7398 r = numbuf;
7399 break;
7400 #endif
7402 default:
7403 EMSG2(_(e_intern2), "echo_string()");
7404 *tofree = NULL;
7407 --recurse;
7408 return r;
7412 * Return a string with the string representation of a variable.
7413 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7414 * "numbuf" is used for a number.
7415 * Puts quotes around strings, so that they can be parsed back by eval().
7416 * May return NULL.
7418 static char_u *
7419 tv2string(tv, tofree, numbuf, copyID)
7420 typval_T *tv;
7421 char_u **tofree;
7422 char_u *numbuf;
7423 int copyID;
7425 switch (tv->v_type)
7427 case VAR_FUNC:
7428 *tofree = string_quote(tv->vval.v_string, TRUE);
7429 return *tofree;
7430 case VAR_STRING:
7431 *tofree = string_quote(tv->vval.v_string, FALSE);
7432 return *tofree;
7433 #ifdef FEAT_FLOAT
7434 case VAR_FLOAT:
7435 *tofree = NULL;
7436 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7437 return numbuf;
7438 #endif
7439 case VAR_NUMBER:
7440 case VAR_LIST:
7441 case VAR_DICT:
7442 break;
7443 default:
7444 EMSG2(_(e_intern2), "tv2string()");
7446 return echo_string(tv, tofree, numbuf, copyID);
7450 * Return string "str" in ' quotes, doubling ' characters.
7451 * If "str" is NULL an empty string is assumed.
7452 * If "function" is TRUE make it function('string').
7454 static char_u *
7455 string_quote(str, function)
7456 char_u *str;
7457 int function;
7459 unsigned len;
7460 char_u *p, *r, *s;
7462 len = (function ? 13 : 3);
7463 if (str != NULL)
7465 len += (unsigned)STRLEN(str);
7466 for (p = str; *p != NUL; mb_ptr_adv(p))
7467 if (*p == '\'')
7468 ++len;
7470 s = r = alloc(len);
7471 if (r != NULL)
7473 if (function)
7475 STRCPY(r, "function('");
7476 r += 10;
7478 else
7479 *r++ = '\'';
7480 if (str != NULL)
7481 for (p = str; *p != NUL; )
7483 if (*p == '\'')
7484 *r++ = '\'';
7485 MB_COPY_CHAR(p, r);
7487 *r++ = '\'';
7488 if (function)
7489 *r++ = ')';
7490 *r++ = NUL;
7492 return s;
7495 #ifdef FEAT_FLOAT
7497 * Convert the string "text" to a floating point number.
7498 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7499 * this always uses a decimal point.
7500 * Returns the length of the text that was consumed.
7502 static int
7503 string2float(text, value)
7504 char_u *text;
7505 float_T *value; /* result stored here */
7507 char *s = (char *)text;
7508 float_T f;
7510 f = strtod(s, &s);
7511 *value = f;
7512 return (int)((char_u *)s - text);
7514 #endif
7517 * Get the value of an environment variable.
7518 * "arg" is pointing to the '$'. It is advanced to after the name.
7519 * If the environment variable was not set, silently assume it is empty.
7520 * Always return OK.
7522 static int
7523 get_env_tv(arg, rettv, evaluate)
7524 char_u **arg;
7525 typval_T *rettv;
7526 int evaluate;
7528 char_u *string = NULL;
7529 int len;
7530 int cc;
7531 char_u *name;
7532 int mustfree = FALSE;
7534 ++*arg;
7535 name = *arg;
7536 len = get_env_len(arg);
7537 if (evaluate)
7539 if (len != 0)
7541 cc = name[len];
7542 name[len] = NUL;
7543 /* first try vim_getenv(), fast for normal environment vars */
7544 string = vim_getenv(name, &mustfree);
7545 if (string != NULL && *string != NUL)
7547 if (!mustfree)
7548 string = vim_strsave(string);
7550 else
7552 if (mustfree)
7553 vim_free(string);
7555 /* next try expanding things like $VIM and ${HOME} */
7556 string = expand_env_save(name - 1);
7557 if (string != NULL && *string == '$')
7559 vim_free(string);
7560 string = NULL;
7563 name[len] = cc;
7565 rettv->v_type = VAR_STRING;
7566 rettv->vval.v_string = string;
7569 return OK;
7573 * Array with names and number of arguments of all internal functions
7574 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7576 static struct fst
7578 char *f_name; /* function name */
7579 char f_min_argc; /* minimal number of arguments */
7580 char f_max_argc; /* maximal number of arguments */
7581 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7582 /* implementation of function */
7583 } functions[] =
7585 #ifdef FEAT_FLOAT
7586 {"abs", 1, 1, f_abs},
7587 #endif
7588 {"add", 2, 2, f_add},
7589 {"append", 2, 2, f_append},
7590 {"argc", 0, 0, f_argc},
7591 {"argidx", 0, 0, f_argidx},
7592 {"argv", 0, 1, f_argv},
7593 #ifdef FEAT_FLOAT
7594 {"atan", 1, 1, f_atan},
7595 #endif
7596 {"browse", 4, 4, f_browse},
7597 {"browsedir", 2, 2, f_browsedir},
7598 {"bufexists", 1, 1, f_bufexists},
7599 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7600 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7601 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7602 {"buflisted", 1, 1, f_buflisted},
7603 {"bufloaded", 1, 1, f_bufloaded},
7604 {"bufname", 1, 1, f_bufname},
7605 {"bufnr", 1, 2, f_bufnr},
7606 {"bufwinnr", 1, 1, f_bufwinnr},
7607 {"byte2line", 1, 1, f_byte2line},
7608 {"byteidx", 2, 2, f_byteidx},
7609 {"call", 2, 3, f_call},
7610 #ifdef FEAT_FLOAT
7611 {"ceil", 1, 1, f_ceil},
7612 #endif
7613 {"changenr", 0, 0, f_changenr},
7614 {"char2nr", 1, 1, f_char2nr},
7615 {"cindent", 1, 1, f_cindent},
7616 {"clearmatches", 0, 0, f_clearmatches},
7617 {"col", 1, 1, f_col},
7618 #if defined(FEAT_INS_EXPAND)
7619 {"complete", 2, 2, f_complete},
7620 {"complete_add", 1, 1, f_complete_add},
7621 {"complete_check", 0, 0, f_complete_check},
7622 #endif
7623 {"confirm", 1, 4, f_confirm},
7624 {"copy", 1, 1, f_copy},
7625 #ifdef FEAT_FLOAT
7626 {"cos", 1, 1, f_cos},
7627 #endif
7628 {"count", 2, 4, f_count},
7629 {"cscope_connection",0,3, f_cscope_connection},
7630 {"cursor", 1, 3, f_cursor},
7631 {"deepcopy", 1, 2, f_deepcopy},
7632 {"delete", 1, 1, f_delete},
7633 {"did_filetype", 0, 0, f_did_filetype},
7634 {"diff_filler", 1, 1, f_diff_filler},
7635 {"diff_hlID", 2, 2, f_diff_hlID},
7636 {"empty", 1, 1, f_empty},
7637 {"escape", 2, 2, f_escape},
7638 {"eval", 1, 1, f_eval},
7639 {"eventhandler", 0, 0, f_eventhandler},
7640 {"executable", 1, 1, f_executable},
7641 {"exists", 1, 1, f_exists},
7642 {"expand", 1, 2, f_expand},
7643 {"extend", 2, 3, f_extend},
7644 {"feedkeys", 1, 2, f_feedkeys},
7645 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7646 {"filereadable", 1, 1, f_filereadable},
7647 {"filewritable", 1, 1, f_filewritable},
7648 {"filter", 2, 2, f_filter},
7649 {"finddir", 1, 3, f_finddir},
7650 {"findfile", 1, 3, f_findfile},
7651 #ifdef FEAT_FLOAT
7652 {"float2nr", 1, 1, f_float2nr},
7653 {"floor", 1, 1, f_floor},
7654 #endif
7655 {"fnameescape", 1, 1, f_fnameescape},
7656 {"fnamemodify", 2, 2, f_fnamemodify},
7657 {"foldclosed", 1, 1, f_foldclosed},
7658 {"foldclosedend", 1, 1, f_foldclosedend},
7659 {"foldlevel", 1, 1, f_foldlevel},
7660 {"foldtext", 0, 0, f_foldtext},
7661 {"foldtextresult", 1, 1, f_foldtextresult},
7662 {"foreground", 0, 0, f_foreground},
7663 {"function", 1, 1, f_function},
7664 {"garbagecollect", 0, 1, f_garbagecollect},
7665 {"get", 2, 3, f_get},
7666 {"getbufline", 2, 3, f_getbufline},
7667 {"getbufvar", 2, 2, f_getbufvar},
7668 {"getchar", 0, 1, f_getchar},
7669 {"getcharmod", 0, 0, f_getcharmod},
7670 {"getcmdline", 0, 0, f_getcmdline},
7671 {"getcmdpos", 0, 0, f_getcmdpos},
7672 {"getcmdtype", 0, 0, f_getcmdtype},
7673 {"getcwd", 0, 0, f_getcwd},
7674 {"getfontname", 0, 1, f_getfontname},
7675 {"getfperm", 1, 1, f_getfperm},
7676 {"getfsize", 1, 1, f_getfsize},
7677 {"getftime", 1, 1, f_getftime},
7678 {"getftype", 1, 1, f_getftype},
7679 {"getline", 1, 2, f_getline},
7680 {"getloclist", 1, 1, f_getqflist},
7681 {"getmatches", 0, 0, f_getmatches},
7682 {"getpid", 0, 0, f_getpid},
7683 {"getpos", 1, 1, f_getpos},
7684 {"getqflist", 0, 0, f_getqflist},
7685 {"getreg", 0, 2, f_getreg},
7686 {"getregtype", 0, 1, f_getregtype},
7687 {"gettabwinvar", 3, 3, f_gettabwinvar},
7688 {"getwinposx", 0, 0, f_getwinposx},
7689 {"getwinposy", 0, 0, f_getwinposy},
7690 {"getwinvar", 2, 2, f_getwinvar},
7691 {"glob", 1, 2, f_glob},
7692 {"globpath", 2, 3, f_globpath},
7693 {"has", 1, 1, f_has},
7694 {"has_key", 2, 2, f_has_key},
7695 {"haslocaldir", 0, 0, f_haslocaldir},
7696 {"hasmapto", 1, 3, f_hasmapto},
7697 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7698 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7699 {"histadd", 2, 2, f_histadd},
7700 {"histdel", 1, 2, f_histdel},
7701 {"histget", 1, 2, f_histget},
7702 {"histnr", 1, 1, f_histnr},
7703 {"hlID", 1, 1, f_hlID},
7704 {"hlexists", 1, 1, f_hlexists},
7705 {"hostname", 0, 0, f_hostname},
7706 {"iconv", 3, 3, f_iconv},
7707 {"indent", 1, 1, f_indent},
7708 {"index", 2, 4, f_index},
7709 {"input", 1, 3, f_input},
7710 {"inputdialog", 1, 3, f_inputdialog},
7711 {"inputlist", 1, 1, f_inputlist},
7712 {"inputrestore", 0, 0, f_inputrestore},
7713 {"inputsave", 0, 0, f_inputsave},
7714 {"inputsecret", 1, 2, f_inputsecret},
7715 {"insert", 2, 3, f_insert},
7716 {"isdirectory", 1, 1, f_isdirectory},
7717 {"islocked", 1, 1, f_islocked},
7718 {"items", 1, 1, f_items},
7719 {"join", 1, 2, f_join},
7720 {"keys", 1, 1, f_keys},
7721 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7722 {"len", 1, 1, f_len},
7723 {"libcall", 3, 3, f_libcall},
7724 {"libcallnr", 3, 3, f_libcallnr},
7725 {"line", 1, 1, f_line},
7726 {"line2byte", 1, 1, f_line2byte},
7727 {"lispindent", 1, 1, f_lispindent},
7728 {"localtime", 0, 0, f_localtime},
7729 #ifdef FEAT_FLOAT
7730 {"log10", 1, 1, f_log10},
7731 #endif
7732 {"map", 2, 2, f_map},
7733 {"maparg", 1, 3, f_maparg},
7734 {"mapcheck", 1, 3, f_mapcheck},
7735 {"match", 2, 4, f_match},
7736 {"matchadd", 2, 4, f_matchadd},
7737 {"matcharg", 1, 1, f_matcharg},
7738 {"matchdelete", 1, 1, f_matchdelete},
7739 {"matchend", 2, 4, f_matchend},
7740 {"matchlist", 2, 4, f_matchlist},
7741 {"matchstr", 2, 4, f_matchstr},
7742 {"max", 1, 1, f_max},
7743 {"min", 1, 1, f_min},
7744 #ifdef vim_mkdir
7745 {"mkdir", 1, 3, f_mkdir},
7746 #endif
7747 {"mode", 0, 1, f_mode},
7748 #ifdef FEAT_MZSCHEME
7749 {"mzeval", 1, 1, f_mzeval},
7750 #endif
7751 {"nextnonblank", 1, 1, f_nextnonblank},
7752 {"nr2char", 1, 1, f_nr2char},
7753 {"pathshorten", 1, 1, f_pathshorten},
7754 #ifdef FEAT_FLOAT
7755 {"pow", 2, 2, f_pow},
7756 #endif
7757 {"prevnonblank", 1, 1, f_prevnonblank},
7758 {"printf", 2, 19, f_printf},
7759 {"pumvisible", 0, 0, f_pumvisible},
7760 {"range", 1, 3, f_range},
7761 {"readfile", 1, 3, f_readfile},
7762 {"reltime", 0, 2, f_reltime},
7763 {"reltimestr", 1, 1, f_reltimestr},
7764 {"remote_expr", 2, 3, f_remote_expr},
7765 {"remote_foreground", 1, 1, f_remote_foreground},
7766 {"remote_peek", 1, 2, f_remote_peek},
7767 {"remote_read", 1, 1, f_remote_read},
7768 {"remote_send", 2, 3, f_remote_send},
7769 {"remove", 2, 3, f_remove},
7770 {"rename", 2, 2, f_rename},
7771 {"repeat", 2, 2, f_repeat},
7772 {"resolve", 1, 1, f_resolve},
7773 {"reverse", 1, 1, f_reverse},
7774 #ifdef FEAT_FLOAT
7775 {"round", 1, 1, f_round},
7776 #endif
7777 {"search", 1, 4, f_search},
7778 {"searchdecl", 1, 3, f_searchdecl},
7779 {"searchpair", 3, 7, f_searchpair},
7780 {"searchpairpos", 3, 7, f_searchpairpos},
7781 {"searchpos", 1, 4, f_searchpos},
7782 {"server2client", 2, 2, f_server2client},
7783 {"serverlist", 0, 0, f_serverlist},
7784 {"setbufvar", 3, 3, f_setbufvar},
7785 {"setcmdpos", 1, 1, f_setcmdpos},
7786 {"setline", 2, 2, f_setline},
7787 {"setloclist", 2, 3, f_setloclist},
7788 {"setmatches", 1, 1, f_setmatches},
7789 {"setpos", 2, 2, f_setpos},
7790 {"setqflist", 1, 2, f_setqflist},
7791 {"setreg", 2, 3, f_setreg},
7792 {"settabwinvar", 4, 4, f_settabwinvar},
7793 {"setwinvar", 3, 3, f_setwinvar},
7794 {"shellescape", 1, 2, f_shellescape},
7795 {"simplify", 1, 1, f_simplify},
7796 #ifdef FEAT_FLOAT
7797 {"sin", 1, 1, f_sin},
7798 #endif
7799 {"sort", 1, 2, f_sort},
7800 {"soundfold", 1, 1, f_soundfold},
7801 {"spellbadword", 0, 1, f_spellbadword},
7802 {"spellsuggest", 1, 3, f_spellsuggest},
7803 {"split", 1, 3, f_split},
7804 #ifdef FEAT_FLOAT
7805 {"sqrt", 1, 1, f_sqrt},
7806 {"str2float", 1, 1, f_str2float},
7807 #endif
7808 {"str2nr", 1, 2, f_str2nr},
7809 #ifdef HAVE_STRFTIME
7810 {"strftime", 1, 2, f_strftime},
7811 #endif
7812 {"stridx", 2, 3, f_stridx},
7813 {"string", 1, 1, f_string},
7814 {"strlen", 1, 1, f_strlen},
7815 {"strpart", 2, 3, f_strpart},
7816 {"strridx", 2, 3, f_strridx},
7817 {"strtrans", 1, 1, f_strtrans},
7818 {"submatch", 1, 1, f_submatch},
7819 {"substitute", 4, 4, f_substitute},
7820 {"synID", 3, 3, f_synID},
7821 {"synIDattr", 2, 3, f_synIDattr},
7822 {"synIDtrans", 1, 1, f_synIDtrans},
7823 {"synstack", 2, 2, f_synstack},
7824 {"system", 1, 2, f_system},
7825 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7826 {"tabpagenr", 0, 1, f_tabpagenr},
7827 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7828 {"tagfiles", 0, 0, f_tagfiles},
7829 {"taglist", 1, 1, f_taglist},
7830 {"tempname", 0, 0, f_tempname},
7831 {"test", 1, 1, f_test},
7832 {"tolower", 1, 1, f_tolower},
7833 {"toupper", 1, 1, f_toupper},
7834 {"tr", 3, 3, f_tr},
7835 #ifdef FEAT_FLOAT
7836 {"trunc", 1, 1, f_trunc},
7837 #endif
7838 {"type", 1, 1, f_type},
7839 {"values", 1, 1, f_values},
7840 {"virtcol", 1, 1, f_virtcol},
7841 {"visualmode", 0, 1, f_visualmode},
7842 {"winbufnr", 1, 1, f_winbufnr},
7843 {"wincol", 0, 0, f_wincol},
7844 {"winheight", 1, 1, f_winheight},
7845 {"winline", 0, 0, f_winline},
7846 {"winnr", 0, 1, f_winnr},
7847 {"winrestcmd", 0, 0, f_winrestcmd},
7848 {"winrestview", 1, 1, f_winrestview},
7849 {"winsaveview", 0, 0, f_winsaveview},
7850 {"winwidth", 1, 1, f_winwidth},
7851 {"writefile", 2, 3, f_writefile},
7854 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7857 * Function given to ExpandGeneric() to obtain the list of internal
7858 * or user defined function names.
7860 char_u *
7861 get_function_name(xp, idx)
7862 expand_T *xp;
7863 int idx;
7865 static int intidx = -1;
7866 char_u *name;
7868 if (idx == 0)
7869 intidx = -1;
7870 if (intidx < 0)
7872 name = get_user_func_name(xp, idx);
7873 if (name != NULL)
7874 return name;
7876 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7878 STRCPY(IObuff, functions[intidx].f_name);
7879 STRCAT(IObuff, "(");
7880 if (functions[intidx].f_max_argc == 0)
7881 STRCAT(IObuff, ")");
7882 return IObuff;
7885 return NULL;
7889 * Function given to ExpandGeneric() to obtain the list of internal or
7890 * user defined variable or function names.
7892 char_u *
7893 get_expr_name(xp, idx)
7894 expand_T *xp;
7895 int idx;
7897 static int intidx = -1;
7898 char_u *name;
7900 if (idx == 0)
7901 intidx = -1;
7902 if (intidx < 0)
7904 name = get_function_name(xp, idx);
7905 if (name != NULL)
7906 return name;
7908 return get_user_var_name(xp, ++intidx);
7911 #endif /* FEAT_CMDL_COMPL */
7914 * Find internal function in table above.
7915 * Return index, or -1 if not found
7917 static int
7918 find_internal_func(name)
7919 char_u *name; /* name of the function */
7921 int first = 0;
7922 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7923 int cmp;
7924 int x;
7927 * Find the function name in the table. Binary search.
7929 while (first <= last)
7931 x = first + ((unsigned)(last - first) >> 1);
7932 cmp = STRCMP(name, functions[x].f_name);
7933 if (cmp < 0)
7934 last = x - 1;
7935 else if (cmp > 0)
7936 first = x + 1;
7937 else
7938 return x;
7940 return -1;
7944 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7945 * name it contains, otherwise return "name".
7947 static char_u *
7948 deref_func_name(name, lenp)
7949 char_u *name;
7950 int *lenp;
7952 dictitem_T *v;
7953 int cc;
7955 cc = name[*lenp];
7956 name[*lenp] = NUL;
7957 v = find_var(name, NULL);
7958 name[*lenp] = cc;
7959 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7961 if (v->di_tv.vval.v_string == NULL)
7963 *lenp = 0;
7964 return (char_u *)""; /* just in case */
7966 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7967 return v->di_tv.vval.v_string;
7970 return name;
7974 * Allocate a variable for the result of a function.
7975 * Return OK or FAIL.
7977 static int
7978 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7979 evaluate, selfdict)
7980 char_u *name; /* name of the function */
7981 int len; /* length of "name" */
7982 typval_T *rettv;
7983 char_u **arg; /* argument, pointing to the '(' */
7984 linenr_T firstline; /* first line of range */
7985 linenr_T lastline; /* last line of range */
7986 int *doesrange; /* return: function handled range */
7987 int evaluate;
7988 dict_T *selfdict; /* Dictionary for "self" */
7990 char_u *argp;
7991 int ret = OK;
7992 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7993 int argcount = 0; /* number of arguments found */
7996 * Get the arguments.
7998 argp = *arg;
7999 while (argcount < MAX_FUNC_ARGS)
8001 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
8002 if (*argp == ')' || *argp == ',' || *argp == NUL)
8003 break;
8004 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
8006 ret = FAIL;
8007 break;
8009 ++argcount;
8010 if (*argp != ',')
8011 break;
8013 if (*argp == ')')
8014 ++argp;
8015 else
8016 ret = FAIL;
8018 if (ret == OK)
8019 ret = call_func(name, len, rettv, argcount, argvars,
8020 firstline, lastline, doesrange, evaluate, selfdict);
8021 else if (!aborting())
8023 if (argcount == MAX_FUNC_ARGS)
8024 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
8025 else
8026 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
8029 while (--argcount >= 0)
8030 clear_tv(&argvars[argcount]);
8032 *arg = skipwhite(argp);
8033 return ret;
8038 * Call a function with its resolved parameters
8039 * Return OK when the function can't be called, FAIL otherwise.
8040 * Also returns OK when an error was encountered while executing the function.
8042 static int
8043 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
8044 doesrange, evaluate, selfdict)
8045 char_u *name; /* name of the function */
8046 int len; /* length of "name" */
8047 typval_T *rettv; /* return value goes here */
8048 int argcount; /* number of "argvars" */
8049 typval_T *argvars; /* vars for arguments, must have "argcount"
8050 PLUS ONE elements! */
8051 linenr_T firstline; /* first line of range */
8052 linenr_T lastline; /* last line of range */
8053 int *doesrange; /* return: function handled range */
8054 int evaluate;
8055 dict_T *selfdict; /* Dictionary for "self" */
8057 int ret = FAIL;
8058 #define ERROR_UNKNOWN 0
8059 #define ERROR_TOOMANY 1
8060 #define ERROR_TOOFEW 2
8061 #define ERROR_SCRIPT 3
8062 #define ERROR_DICT 4
8063 #define ERROR_NONE 5
8064 #define ERROR_OTHER 6
8065 int error = ERROR_NONE;
8066 int i;
8067 int llen;
8068 ufunc_T *fp;
8069 int cc;
8070 #define FLEN_FIXED 40
8071 char_u fname_buf[FLEN_FIXED + 1];
8072 char_u *fname;
8075 * In a script change <SID>name() and s:name() to K_SNR 123_name().
8076 * Change <SNR>123_name() to K_SNR 123_name().
8077 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
8079 cc = name[len];
8080 name[len] = NUL;
8081 llen = eval_fname_script(name);
8082 if (llen > 0)
8084 fname_buf[0] = K_SPECIAL;
8085 fname_buf[1] = KS_EXTRA;
8086 fname_buf[2] = (int)KE_SNR;
8087 i = 3;
8088 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
8090 if (current_SID <= 0)
8091 error = ERROR_SCRIPT;
8092 else
8094 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
8095 i = (int)STRLEN(fname_buf);
8098 if (i + STRLEN(name + llen) < FLEN_FIXED)
8100 STRCPY(fname_buf + i, name + llen);
8101 fname = fname_buf;
8103 else
8105 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8106 if (fname == NULL)
8107 error = ERROR_OTHER;
8108 else
8110 mch_memmove(fname, fname_buf, (size_t)i);
8111 STRCPY(fname + i, name + llen);
8115 else
8116 fname = name;
8118 *doesrange = FALSE;
8121 /* execute the function if no errors detected and executing */
8122 if (evaluate && error == ERROR_NONE)
8124 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */
8125 rettv->vval.v_number = 0;
8126 error = ERROR_UNKNOWN;
8128 if (!builtin_function(fname))
8131 * User defined function.
8133 fp = find_func(fname);
8135 #ifdef FEAT_AUTOCMD
8136 /* Trigger FuncUndefined event, may load the function. */
8137 if (fp == NULL
8138 && apply_autocmds(EVENT_FUNCUNDEFINED,
8139 fname, fname, TRUE, NULL)
8140 && !aborting())
8142 /* executed an autocommand, search for the function again */
8143 fp = find_func(fname);
8145 #endif
8146 /* Try loading a package. */
8147 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8149 /* loaded a package, search for the function again */
8150 fp = find_func(fname);
8153 if (fp != NULL)
8155 if (fp->uf_flags & FC_RANGE)
8156 *doesrange = TRUE;
8157 if (argcount < fp->uf_args.ga_len)
8158 error = ERROR_TOOFEW;
8159 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8160 error = ERROR_TOOMANY;
8161 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8162 error = ERROR_DICT;
8163 else
8166 * Call the user function.
8167 * Save and restore search patterns, script variables and
8168 * redo buffer.
8170 save_search_patterns();
8171 saveRedobuff();
8172 ++fp->uf_calls;
8173 call_user_func(fp, argcount, argvars, rettv,
8174 firstline, lastline,
8175 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8176 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8177 && fp->uf_refcount <= 0)
8178 /* Function was unreferenced while being used, free it
8179 * now. */
8180 func_free(fp);
8181 restoreRedobuff();
8182 restore_search_patterns();
8183 error = ERROR_NONE;
8187 else
8190 * Find the function name in the table, call its implementation.
8192 i = find_internal_func(fname);
8193 if (i >= 0)
8195 if (argcount < functions[i].f_min_argc)
8196 error = ERROR_TOOFEW;
8197 else if (argcount > functions[i].f_max_argc)
8198 error = ERROR_TOOMANY;
8199 else
8201 argvars[argcount].v_type = VAR_UNKNOWN;
8202 functions[i].f_func(argvars, rettv);
8203 error = ERROR_NONE;
8208 * The function call (or "FuncUndefined" autocommand sequence) might
8209 * have been aborted by an error, an interrupt, or an explicitly thrown
8210 * exception that has not been caught so far. This situation can be
8211 * tested for by calling aborting(). For an error in an internal
8212 * function or for the "E132" error in call_user_func(), however, the
8213 * throw point at which the "force_abort" flag (temporarily reset by
8214 * emsg()) is normally updated has not been reached yet. We need to
8215 * update that flag first to make aborting() reliable.
8217 update_force_abort();
8219 if (error == ERROR_NONE)
8220 ret = OK;
8223 * Report an error unless the argument evaluation or function call has been
8224 * cancelled due to an aborting error, an interrupt, or an exception.
8226 if (!aborting())
8228 switch (error)
8230 case ERROR_UNKNOWN:
8231 emsg_funcname(N_("E117: Unknown function: %s"), name);
8232 break;
8233 case ERROR_TOOMANY:
8234 emsg_funcname(e_toomanyarg, name);
8235 break;
8236 case ERROR_TOOFEW:
8237 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8238 name);
8239 break;
8240 case ERROR_SCRIPT:
8241 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8242 name);
8243 break;
8244 case ERROR_DICT:
8245 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8246 name);
8247 break;
8251 name[len] = cc;
8252 if (fname != name && fname != fname_buf)
8253 vim_free(fname);
8255 return ret;
8259 * Give an error message with a function name. Handle <SNR> things.
8260 * "ermsg" is to be passed without translation, use N_() instead of _().
8262 static void
8263 emsg_funcname(ermsg, name)
8264 char *ermsg;
8265 char_u *name;
8267 char_u *p;
8269 if (*name == K_SPECIAL)
8270 p = concat_str((char_u *)"<SNR>", name + 3);
8271 else
8272 p = name;
8273 EMSG2(_(ermsg), p);
8274 if (p != name)
8275 vim_free(p);
8279 * Return TRUE for a non-zero Number and a non-empty String.
8281 static int
8282 non_zero_arg(argvars)
8283 typval_T *argvars;
8285 return ((argvars[0].v_type == VAR_NUMBER
8286 && argvars[0].vval.v_number != 0)
8287 || (argvars[0].v_type == VAR_STRING
8288 && argvars[0].vval.v_string != NULL
8289 && *argvars[0].vval.v_string != NUL));
8292 /*********************************************
8293 * Implementation of the built-in functions
8296 #ifdef FEAT_FLOAT
8298 * "abs(expr)" function
8300 static void
8301 f_abs(argvars, rettv)
8302 typval_T *argvars;
8303 typval_T *rettv;
8305 if (argvars[0].v_type == VAR_FLOAT)
8307 rettv->v_type = VAR_FLOAT;
8308 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8310 else
8312 varnumber_T n;
8313 int error = FALSE;
8315 n = get_tv_number_chk(&argvars[0], &error);
8316 if (error)
8317 rettv->vval.v_number = -1;
8318 else if (n > 0)
8319 rettv->vval.v_number = n;
8320 else
8321 rettv->vval.v_number = -n;
8324 #endif
8327 * "add(list, item)" function
8329 static void
8330 f_add(argvars, rettv)
8331 typval_T *argvars;
8332 typval_T *rettv;
8334 list_T *l;
8336 rettv->vval.v_number = 1; /* Default: Failed */
8337 if (argvars[0].v_type == VAR_LIST)
8339 if ((l = argvars[0].vval.v_list) != NULL
8340 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8341 && list_append_tv(l, &argvars[1]) == OK)
8342 copy_tv(&argvars[0], rettv);
8344 else
8345 EMSG(_(e_listreq));
8349 * "append(lnum, string/list)" function
8351 static void
8352 f_append(argvars, rettv)
8353 typval_T *argvars;
8354 typval_T *rettv;
8356 long lnum;
8357 char_u *line;
8358 list_T *l = NULL;
8359 listitem_T *li = NULL;
8360 typval_T *tv;
8361 long added = 0;
8363 lnum = get_tv_lnum(argvars);
8364 if (lnum >= 0
8365 && lnum <= curbuf->b_ml.ml_line_count
8366 && u_save(lnum, lnum + 1) == OK)
8368 if (argvars[1].v_type == VAR_LIST)
8370 l = argvars[1].vval.v_list;
8371 if (l == NULL)
8372 return;
8373 li = l->lv_first;
8375 for (;;)
8377 if (l == NULL)
8378 tv = &argvars[1]; /* append a string */
8379 else if (li == NULL)
8380 break; /* end of list */
8381 else
8382 tv = &li->li_tv; /* append item from list */
8383 line = get_tv_string_chk(tv);
8384 if (line == NULL) /* type error */
8386 rettv->vval.v_number = 1; /* Failed */
8387 break;
8389 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8390 ++added;
8391 if (l == NULL)
8392 break;
8393 li = li->li_next;
8396 appended_lines_mark(lnum, added);
8397 if (curwin->w_cursor.lnum > lnum)
8398 curwin->w_cursor.lnum += added;
8400 else
8401 rettv->vval.v_number = 1; /* Failed */
8405 * "argc()" function
8407 static void
8408 f_argc(argvars, rettv)
8409 typval_T *argvars UNUSED;
8410 typval_T *rettv;
8412 rettv->vval.v_number = ARGCOUNT;
8416 * "argidx()" function
8418 static void
8419 f_argidx(argvars, rettv)
8420 typval_T *argvars UNUSED;
8421 typval_T *rettv;
8423 rettv->vval.v_number = curwin->w_arg_idx;
8427 * "argv(nr)" function
8429 static void
8430 f_argv(argvars, rettv)
8431 typval_T *argvars;
8432 typval_T *rettv;
8434 int idx;
8436 if (argvars[0].v_type != VAR_UNKNOWN)
8438 idx = get_tv_number_chk(&argvars[0], NULL);
8439 if (idx >= 0 && idx < ARGCOUNT)
8440 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8441 else
8442 rettv->vval.v_string = NULL;
8443 rettv->v_type = VAR_STRING;
8445 else if (rettv_list_alloc(rettv) == OK)
8446 for (idx = 0; idx < ARGCOUNT; ++idx)
8447 list_append_string(rettv->vval.v_list,
8448 alist_name(&ARGLIST[idx]), -1);
8451 #ifdef FEAT_FLOAT
8452 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8455 * Get the float value of "argvars[0]" into "f".
8456 * Returns FAIL when the argument is not a Number or Float.
8458 static int
8459 get_float_arg(argvars, f)
8460 typval_T *argvars;
8461 float_T *f;
8463 if (argvars[0].v_type == VAR_FLOAT)
8465 *f = argvars[0].vval.v_float;
8466 return OK;
8468 if (argvars[0].v_type == VAR_NUMBER)
8470 *f = (float_T)argvars[0].vval.v_number;
8471 return OK;
8473 EMSG(_("E808: Number or Float required"));
8474 return FAIL;
8478 * "atan()" function
8480 static void
8481 f_atan(argvars, rettv)
8482 typval_T *argvars;
8483 typval_T *rettv;
8485 float_T f;
8487 rettv->v_type = VAR_FLOAT;
8488 if (get_float_arg(argvars, &f) == OK)
8489 rettv->vval.v_float = atan(f);
8490 else
8491 rettv->vval.v_float = 0.0;
8493 #endif
8496 * "browse(save, title, initdir, default)" function
8498 static void
8499 f_browse(argvars, rettv)
8500 typval_T *argvars UNUSED;
8501 typval_T *rettv;
8503 #ifdef FEAT_BROWSE
8504 int save;
8505 char_u *title;
8506 char_u *initdir;
8507 char_u *defname;
8508 char_u buf[NUMBUFLEN];
8509 char_u buf2[NUMBUFLEN];
8510 int error = FALSE;
8512 save = get_tv_number_chk(&argvars[0], &error);
8513 title = get_tv_string_chk(&argvars[1]);
8514 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8515 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8517 if (error || title == NULL || initdir == NULL || defname == NULL)
8518 rettv->vval.v_string = NULL;
8519 else
8520 rettv->vval.v_string =
8521 do_browse(save ? BROWSE_SAVE : 0,
8522 title, defname, NULL, initdir, NULL, curbuf);
8523 #else
8524 rettv->vval.v_string = NULL;
8525 #endif
8526 rettv->v_type = VAR_STRING;
8530 * "browsedir(title, initdir)" function
8532 static void
8533 f_browsedir(argvars, rettv)
8534 typval_T *argvars UNUSED;
8535 typval_T *rettv;
8537 #ifdef FEAT_BROWSE
8538 char_u *title;
8539 char_u *initdir;
8540 char_u buf[NUMBUFLEN];
8542 title = get_tv_string_chk(&argvars[0]);
8543 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8545 if (title == NULL || initdir == NULL)
8546 rettv->vval.v_string = NULL;
8547 else
8548 rettv->vval.v_string = do_browse(BROWSE_DIR,
8549 title, NULL, NULL, initdir, NULL, curbuf);
8550 #else
8551 rettv->vval.v_string = NULL;
8552 #endif
8553 rettv->v_type = VAR_STRING;
8556 static buf_T *find_buffer __ARGS((typval_T *avar));
8559 * Find a buffer by number or exact name.
8561 static buf_T *
8562 find_buffer(avar)
8563 typval_T *avar;
8565 buf_T *buf = NULL;
8567 if (avar->v_type == VAR_NUMBER)
8568 buf = buflist_findnr((int)avar->vval.v_number);
8569 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8571 buf = buflist_findname_exp(avar->vval.v_string);
8572 if (buf == NULL)
8574 /* No full path name match, try a match with a URL or a "nofile"
8575 * buffer, these don't use the full path. */
8576 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8577 if (buf->b_fname != NULL
8578 && (path_with_url(buf->b_fname)
8579 #ifdef FEAT_QUICKFIX
8580 || bt_nofile(buf)
8581 #endif
8583 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8584 break;
8587 return buf;
8591 * "bufexists(expr)" function
8593 static void
8594 f_bufexists(argvars, rettv)
8595 typval_T *argvars;
8596 typval_T *rettv;
8598 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8602 * "buflisted(expr)" function
8604 static void
8605 f_buflisted(argvars, rettv)
8606 typval_T *argvars;
8607 typval_T *rettv;
8609 buf_T *buf;
8611 buf = find_buffer(&argvars[0]);
8612 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8616 * "bufloaded(expr)" function
8618 static void
8619 f_bufloaded(argvars, rettv)
8620 typval_T *argvars;
8621 typval_T *rettv;
8623 buf_T *buf;
8625 buf = find_buffer(&argvars[0]);
8626 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8629 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8632 * Get buffer by number or pattern.
8634 static buf_T *
8635 get_buf_tv(tv)
8636 typval_T *tv;
8638 char_u *name = tv->vval.v_string;
8639 int save_magic;
8640 char_u *save_cpo;
8641 buf_T *buf;
8643 if (tv->v_type == VAR_NUMBER)
8644 return buflist_findnr((int)tv->vval.v_number);
8645 if (tv->v_type != VAR_STRING)
8646 return NULL;
8647 if (name == NULL || *name == NUL)
8648 return curbuf;
8649 if (name[0] == '$' && name[1] == NUL)
8650 return lastbuf;
8652 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8653 save_magic = p_magic;
8654 p_magic = TRUE;
8655 save_cpo = p_cpo;
8656 p_cpo = (char_u *)"";
8658 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8659 TRUE, FALSE));
8661 p_magic = save_magic;
8662 p_cpo = save_cpo;
8664 /* If not found, try expanding the name, like done for bufexists(). */
8665 if (buf == NULL)
8666 buf = find_buffer(tv);
8668 return buf;
8672 * "bufname(expr)" function
8674 static void
8675 f_bufname(argvars, rettv)
8676 typval_T *argvars;
8677 typval_T *rettv;
8679 buf_T *buf;
8681 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8682 ++emsg_off;
8683 buf = get_buf_tv(&argvars[0]);
8684 rettv->v_type = VAR_STRING;
8685 if (buf != NULL && buf->b_fname != NULL)
8686 rettv->vval.v_string = vim_strsave(buf->b_fname);
8687 else
8688 rettv->vval.v_string = NULL;
8689 --emsg_off;
8693 * "bufnr(expr)" function
8695 static void
8696 f_bufnr(argvars, rettv)
8697 typval_T *argvars;
8698 typval_T *rettv;
8700 buf_T *buf;
8701 int error = FALSE;
8702 char_u *name;
8704 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8705 ++emsg_off;
8706 buf = get_buf_tv(&argvars[0]);
8707 --emsg_off;
8709 /* If the buffer isn't found and the second argument is not zero create a
8710 * new buffer. */
8711 if (buf == NULL
8712 && argvars[1].v_type != VAR_UNKNOWN
8713 && get_tv_number_chk(&argvars[1], &error) != 0
8714 && !error
8715 && (name = get_tv_string_chk(&argvars[0])) != NULL
8716 && !error)
8717 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8719 if (buf != NULL)
8720 rettv->vval.v_number = buf->b_fnum;
8721 else
8722 rettv->vval.v_number = -1;
8726 * "bufwinnr(nr)" function
8728 static void
8729 f_bufwinnr(argvars, rettv)
8730 typval_T *argvars;
8731 typval_T *rettv;
8733 #ifdef FEAT_WINDOWS
8734 win_T *wp;
8735 int winnr = 0;
8736 #endif
8737 buf_T *buf;
8739 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8740 ++emsg_off;
8741 buf = get_buf_tv(&argvars[0]);
8742 #ifdef FEAT_WINDOWS
8743 for (wp = firstwin; wp; wp = wp->w_next)
8745 ++winnr;
8746 if (wp->w_buffer == buf)
8747 break;
8749 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8750 #else
8751 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8752 #endif
8753 --emsg_off;
8757 * "byte2line(byte)" function
8759 static void
8760 f_byte2line(argvars, rettv)
8761 typval_T *argvars UNUSED;
8762 typval_T *rettv;
8764 #ifndef FEAT_BYTEOFF
8765 rettv->vval.v_number = -1;
8766 #else
8767 long boff = 0;
8769 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8770 if (boff < 0)
8771 rettv->vval.v_number = -1;
8772 else
8773 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8774 (linenr_T)0, &boff);
8775 #endif
8779 * "byteidx()" function
8781 static void
8782 f_byteidx(argvars, rettv)
8783 typval_T *argvars;
8784 typval_T *rettv;
8786 #ifdef FEAT_MBYTE
8787 char_u *t;
8788 #endif
8789 char_u *str;
8790 long idx;
8792 str = get_tv_string_chk(&argvars[0]);
8793 idx = get_tv_number_chk(&argvars[1], NULL);
8794 rettv->vval.v_number = -1;
8795 if (str == NULL || idx < 0)
8796 return;
8798 #ifdef FEAT_MBYTE
8799 t = str;
8800 for ( ; idx > 0; idx--)
8802 if (*t == NUL) /* EOL reached */
8803 return;
8804 t += (*mb_ptr2len)(t);
8806 rettv->vval.v_number = (varnumber_T)(t - str);
8807 #else
8808 if ((size_t)idx <= STRLEN(str))
8809 rettv->vval.v_number = idx;
8810 #endif
8814 * "call(func, arglist)" function
8816 static void
8817 f_call(argvars, rettv)
8818 typval_T *argvars;
8819 typval_T *rettv;
8821 char_u *func;
8822 typval_T argv[MAX_FUNC_ARGS + 1];
8823 int argc = 0;
8824 listitem_T *item;
8825 int dummy;
8826 dict_T *selfdict = NULL;
8828 if (argvars[1].v_type != VAR_LIST)
8830 EMSG(_(e_listreq));
8831 return;
8833 if (argvars[1].vval.v_list == NULL)
8834 return;
8836 if (argvars[0].v_type == VAR_FUNC)
8837 func = argvars[0].vval.v_string;
8838 else
8839 func = get_tv_string(&argvars[0]);
8840 if (*func == NUL)
8841 return; /* type error or empty name */
8843 if (argvars[2].v_type != VAR_UNKNOWN)
8845 if (argvars[2].v_type != VAR_DICT)
8847 EMSG(_(e_dictreq));
8848 return;
8850 selfdict = argvars[2].vval.v_dict;
8853 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8854 item = item->li_next)
8856 if (argc == MAX_FUNC_ARGS)
8858 EMSG(_("E699: Too many arguments"));
8859 break;
8861 /* Make a copy of each argument. This is needed to be able to set
8862 * v_lock to VAR_FIXED in the copy without changing the original list.
8864 copy_tv(&item->li_tv, &argv[argc++]);
8867 if (item == NULL)
8868 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8869 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8870 &dummy, TRUE, selfdict);
8872 /* Free the arguments. */
8873 while (argc > 0)
8874 clear_tv(&argv[--argc]);
8877 #ifdef FEAT_FLOAT
8879 * "ceil({float})" function
8881 static void
8882 f_ceil(argvars, rettv)
8883 typval_T *argvars;
8884 typval_T *rettv;
8886 float_T f;
8888 rettv->v_type = VAR_FLOAT;
8889 if (get_float_arg(argvars, &f) == OK)
8890 rettv->vval.v_float = ceil(f);
8891 else
8892 rettv->vval.v_float = 0.0;
8894 #endif
8897 * "changenr()" function
8899 static void
8900 f_changenr(argvars, rettv)
8901 typval_T *argvars UNUSED;
8902 typval_T *rettv;
8904 rettv->vval.v_number = curbuf->b_u_seq_cur;
8908 * "char2nr(string)" function
8910 static void
8911 f_char2nr(argvars, rettv)
8912 typval_T *argvars;
8913 typval_T *rettv;
8915 #ifdef FEAT_MBYTE
8916 if (has_mbyte)
8917 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8918 else
8919 #endif
8920 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8924 * "cindent(lnum)" function
8926 static void
8927 f_cindent(argvars, rettv)
8928 typval_T *argvars;
8929 typval_T *rettv;
8931 #ifdef FEAT_CINDENT
8932 pos_T pos;
8933 linenr_T lnum;
8935 pos = curwin->w_cursor;
8936 lnum = get_tv_lnum(argvars);
8937 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8939 curwin->w_cursor.lnum = lnum;
8940 rettv->vval.v_number = get_c_indent();
8941 curwin->w_cursor = pos;
8943 else
8944 #endif
8945 rettv->vval.v_number = -1;
8949 * "clearmatches()" function
8951 static void
8952 f_clearmatches(argvars, rettv)
8953 typval_T *argvars UNUSED;
8954 typval_T *rettv UNUSED;
8956 #ifdef FEAT_SEARCH_EXTRA
8957 clear_matches(curwin);
8958 #endif
8962 * "col(string)" function
8964 static void
8965 f_col(argvars, rettv)
8966 typval_T *argvars;
8967 typval_T *rettv;
8969 colnr_T col = 0;
8970 pos_T *fp;
8971 int fnum = curbuf->b_fnum;
8973 fp = var2fpos(&argvars[0], FALSE, &fnum);
8974 if (fp != NULL && fnum == curbuf->b_fnum)
8976 if (fp->col == MAXCOL)
8978 /* '> can be MAXCOL, get the length of the line then */
8979 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8980 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8981 else
8982 col = MAXCOL;
8984 else
8986 col = fp->col + 1;
8987 #ifdef FEAT_VIRTUALEDIT
8988 /* col(".") when the cursor is on the NUL at the end of the line
8989 * because of "coladd" can be seen as an extra column. */
8990 if (virtual_active() && fp == &curwin->w_cursor)
8992 char_u *p = ml_get_cursor();
8994 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8995 curwin->w_virtcol - curwin->w_cursor.coladd))
8997 # ifdef FEAT_MBYTE
8998 int l;
9000 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
9001 col += l;
9002 # else
9003 if (*p != NUL && p[1] == NUL)
9004 ++col;
9005 # endif
9008 #endif
9011 rettv->vval.v_number = col;
9014 #if defined(FEAT_INS_EXPAND)
9016 * "complete()" function
9018 static void
9019 f_complete(argvars, rettv)
9020 typval_T *argvars;
9021 typval_T *rettv UNUSED;
9023 int startcol;
9025 if ((State & INSERT) == 0)
9027 EMSG(_("E785: complete() can only be used in Insert mode"));
9028 return;
9031 /* Check for undo allowed here, because if something was already inserted
9032 * the line was already saved for undo and this check isn't done. */
9033 if (!undo_allowed())
9034 return;
9036 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
9038 EMSG(_(e_invarg));
9039 return;
9042 startcol = get_tv_number_chk(&argvars[0], NULL);
9043 if (startcol <= 0)
9044 return;
9046 set_completion(startcol - 1, argvars[1].vval.v_list);
9050 * "complete_add()" function
9052 static void
9053 f_complete_add(argvars, rettv)
9054 typval_T *argvars;
9055 typval_T *rettv;
9057 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
9061 * "complete_check()" function
9063 static void
9064 f_complete_check(argvars, rettv)
9065 typval_T *argvars UNUSED;
9066 typval_T *rettv;
9068 int saved = RedrawingDisabled;
9070 RedrawingDisabled = 0;
9071 ins_compl_check_keys(0);
9072 rettv->vval.v_number = compl_interrupted;
9073 RedrawingDisabled = saved;
9075 #endif
9078 * "confirm(message, buttons[, default [, type]])" function
9080 static void
9081 f_confirm(argvars, rettv)
9082 typval_T *argvars UNUSED;
9083 typval_T *rettv UNUSED;
9085 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
9086 char_u *message;
9087 char_u *buttons = NULL;
9088 char_u buf[NUMBUFLEN];
9089 char_u buf2[NUMBUFLEN];
9090 int def = 1;
9091 int type = VIM_GENERIC;
9092 char_u *typestr;
9093 int error = FALSE;
9095 message = get_tv_string_chk(&argvars[0]);
9096 if (message == NULL)
9097 error = TRUE;
9098 if (argvars[1].v_type != VAR_UNKNOWN)
9100 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9101 if (buttons == NULL)
9102 error = TRUE;
9103 if (argvars[2].v_type != VAR_UNKNOWN)
9105 def = get_tv_number_chk(&argvars[2], &error);
9106 if (argvars[3].v_type != VAR_UNKNOWN)
9108 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9109 if (typestr == NULL)
9110 error = TRUE;
9111 else
9113 switch (TOUPPER_ASC(*typestr))
9115 case 'E': type = VIM_ERROR; break;
9116 case 'Q': type = VIM_QUESTION; break;
9117 case 'I': type = VIM_INFO; break;
9118 case 'W': type = VIM_WARNING; break;
9119 case 'G': type = VIM_GENERIC; break;
9126 if (buttons == NULL || *buttons == NUL)
9127 buttons = (char_u *)_("&Ok");
9129 if (!error)
9130 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9131 def, NULL);
9132 #endif
9136 * "copy()" function
9138 static void
9139 f_copy(argvars, rettv)
9140 typval_T *argvars;
9141 typval_T *rettv;
9143 item_copy(&argvars[0], rettv, FALSE, 0);
9146 #ifdef FEAT_FLOAT
9148 * "cos()" function
9150 static void
9151 f_cos(argvars, rettv)
9152 typval_T *argvars;
9153 typval_T *rettv;
9155 float_T f;
9157 rettv->v_type = VAR_FLOAT;
9158 if (get_float_arg(argvars, &f) == OK)
9159 rettv->vval.v_float = cos(f);
9160 else
9161 rettv->vval.v_float = 0.0;
9163 #endif
9166 * "count()" function
9168 static void
9169 f_count(argvars, rettv)
9170 typval_T *argvars;
9171 typval_T *rettv;
9173 long n = 0;
9174 int ic = FALSE;
9176 if (argvars[0].v_type == VAR_LIST)
9178 listitem_T *li;
9179 list_T *l;
9180 long idx;
9182 if ((l = argvars[0].vval.v_list) != NULL)
9184 li = l->lv_first;
9185 if (argvars[2].v_type != VAR_UNKNOWN)
9187 int error = FALSE;
9189 ic = get_tv_number_chk(&argvars[2], &error);
9190 if (argvars[3].v_type != VAR_UNKNOWN)
9192 idx = get_tv_number_chk(&argvars[3], &error);
9193 if (!error)
9195 li = list_find(l, idx);
9196 if (li == NULL)
9197 EMSGN(_(e_listidx), idx);
9200 if (error)
9201 li = NULL;
9204 for ( ; li != NULL; li = li->li_next)
9205 if (tv_equal(&li->li_tv, &argvars[1], ic))
9206 ++n;
9209 else if (argvars[0].v_type == VAR_DICT)
9211 int todo;
9212 dict_T *d;
9213 hashitem_T *hi;
9215 if ((d = argvars[0].vval.v_dict) != NULL)
9217 int error = FALSE;
9219 if (argvars[2].v_type != VAR_UNKNOWN)
9221 ic = get_tv_number_chk(&argvars[2], &error);
9222 if (argvars[3].v_type != VAR_UNKNOWN)
9223 EMSG(_(e_invarg));
9226 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9227 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9229 if (!HASHITEM_EMPTY(hi))
9231 --todo;
9232 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9233 ++n;
9238 else
9239 EMSG2(_(e_listdictarg), "count()");
9240 rettv->vval.v_number = n;
9244 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9246 * Checks the existence of a cscope connection.
9248 static void
9249 f_cscope_connection(argvars, rettv)
9250 typval_T *argvars UNUSED;
9251 typval_T *rettv UNUSED;
9253 #ifdef FEAT_CSCOPE
9254 int num = 0;
9255 char_u *dbpath = NULL;
9256 char_u *prepend = NULL;
9257 char_u buf[NUMBUFLEN];
9259 if (argvars[0].v_type != VAR_UNKNOWN
9260 && argvars[1].v_type != VAR_UNKNOWN)
9262 num = (int)get_tv_number(&argvars[0]);
9263 dbpath = get_tv_string(&argvars[1]);
9264 if (argvars[2].v_type != VAR_UNKNOWN)
9265 prepend = get_tv_string_buf(&argvars[2], buf);
9268 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9269 #endif
9273 * "cursor(lnum, col)" function
9275 * Moves the cursor to the specified line and column.
9276 * Returns 0 when the position could be set, -1 otherwise.
9278 static void
9279 f_cursor(argvars, rettv)
9280 typval_T *argvars;
9281 typval_T *rettv;
9283 long line, col;
9284 #ifdef FEAT_VIRTUALEDIT
9285 long coladd = 0;
9286 #endif
9288 rettv->vval.v_number = -1;
9289 if (argvars[1].v_type == VAR_UNKNOWN)
9291 pos_T pos;
9293 if (list2fpos(argvars, &pos, NULL) == FAIL)
9294 return;
9295 line = pos.lnum;
9296 col = pos.col;
9297 #ifdef FEAT_VIRTUALEDIT
9298 coladd = pos.coladd;
9299 #endif
9301 else
9303 line = get_tv_lnum(argvars);
9304 col = get_tv_number_chk(&argvars[1], NULL);
9305 #ifdef FEAT_VIRTUALEDIT
9306 if (argvars[2].v_type != VAR_UNKNOWN)
9307 coladd = get_tv_number_chk(&argvars[2], NULL);
9308 #endif
9310 if (line < 0 || col < 0
9311 #ifdef FEAT_VIRTUALEDIT
9312 || coladd < 0
9313 #endif
9315 return; /* type error; errmsg already given */
9316 if (line > 0)
9317 curwin->w_cursor.lnum = line;
9318 if (col > 0)
9319 curwin->w_cursor.col = col - 1;
9320 #ifdef FEAT_VIRTUALEDIT
9321 curwin->w_cursor.coladd = coladd;
9322 #endif
9324 /* Make sure the cursor is in a valid position. */
9325 check_cursor();
9326 #ifdef FEAT_MBYTE
9327 /* Correct cursor for multi-byte character. */
9328 if (has_mbyte)
9329 mb_adjust_cursor();
9330 #endif
9332 curwin->w_set_curswant = TRUE;
9333 rettv->vval.v_number = 0;
9337 * "deepcopy()" function
9339 static void
9340 f_deepcopy(argvars, rettv)
9341 typval_T *argvars;
9342 typval_T *rettv;
9344 int noref = 0;
9346 if (argvars[1].v_type != VAR_UNKNOWN)
9347 noref = get_tv_number_chk(&argvars[1], NULL);
9348 if (noref < 0 || noref > 1)
9349 EMSG(_(e_invarg));
9350 else
9352 current_copyID += COPYID_INC;
9353 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? current_copyID : 0);
9358 * "delete()" function
9360 static void
9361 f_delete(argvars, rettv)
9362 typval_T *argvars;
9363 typval_T *rettv;
9365 if (check_restricted() || check_secure())
9366 rettv->vval.v_number = -1;
9367 else
9368 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9372 * "did_filetype()" function
9374 static void
9375 f_did_filetype(argvars, rettv)
9376 typval_T *argvars UNUSED;
9377 typval_T *rettv UNUSED;
9379 #ifdef FEAT_AUTOCMD
9380 rettv->vval.v_number = did_filetype;
9381 #endif
9385 * "diff_filler()" function
9387 static void
9388 f_diff_filler(argvars, rettv)
9389 typval_T *argvars UNUSED;
9390 typval_T *rettv UNUSED;
9392 #ifdef FEAT_DIFF
9393 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9394 #endif
9398 * "diff_hlID()" function
9400 static void
9401 f_diff_hlID(argvars, rettv)
9402 typval_T *argvars UNUSED;
9403 typval_T *rettv UNUSED;
9405 #ifdef FEAT_DIFF
9406 linenr_T lnum = get_tv_lnum(argvars);
9407 static linenr_T prev_lnum = 0;
9408 static int changedtick = 0;
9409 static int fnum = 0;
9410 static int change_start = 0;
9411 static int change_end = 0;
9412 static hlf_T hlID = (hlf_T)0;
9413 int filler_lines;
9414 int col;
9416 if (lnum < 0) /* ignore type error in {lnum} arg */
9417 lnum = 0;
9418 if (lnum != prev_lnum
9419 || changedtick != curbuf->b_changedtick
9420 || fnum != curbuf->b_fnum)
9422 /* New line, buffer, change: need to get the values. */
9423 filler_lines = diff_check(curwin, lnum);
9424 if (filler_lines < 0)
9426 if (filler_lines == -1)
9428 change_start = MAXCOL;
9429 change_end = -1;
9430 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9431 hlID = HLF_ADD; /* added line */
9432 else
9433 hlID = HLF_CHD; /* changed line */
9435 else
9436 hlID = HLF_ADD; /* added line */
9438 else
9439 hlID = (hlf_T)0;
9440 prev_lnum = lnum;
9441 changedtick = curbuf->b_changedtick;
9442 fnum = curbuf->b_fnum;
9445 if (hlID == HLF_CHD || hlID == HLF_TXD)
9447 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9448 if (col >= change_start && col <= change_end)
9449 hlID = HLF_TXD; /* changed text */
9450 else
9451 hlID = HLF_CHD; /* changed line */
9453 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9454 #endif
9458 * "empty({expr})" function
9460 static void
9461 f_empty(argvars, rettv)
9462 typval_T *argvars;
9463 typval_T *rettv;
9465 int n;
9467 switch (argvars[0].v_type)
9469 case VAR_STRING:
9470 case VAR_FUNC:
9471 n = argvars[0].vval.v_string == NULL
9472 || *argvars[0].vval.v_string == NUL;
9473 break;
9474 case VAR_NUMBER:
9475 n = argvars[0].vval.v_number == 0;
9476 break;
9477 #ifdef FEAT_FLOAT
9478 case VAR_FLOAT:
9479 n = argvars[0].vval.v_float == 0.0;
9480 break;
9481 #endif
9482 case VAR_LIST:
9483 n = argvars[0].vval.v_list == NULL
9484 || argvars[0].vval.v_list->lv_first == NULL;
9485 break;
9486 case VAR_DICT:
9487 n = argvars[0].vval.v_dict == NULL
9488 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9489 break;
9490 default:
9491 EMSG2(_(e_intern2), "f_empty()");
9492 n = 0;
9495 rettv->vval.v_number = n;
9499 * "escape({string}, {chars})" function
9501 static void
9502 f_escape(argvars, rettv)
9503 typval_T *argvars;
9504 typval_T *rettv;
9506 char_u buf[NUMBUFLEN];
9508 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9509 get_tv_string_buf(&argvars[1], buf));
9510 rettv->v_type = VAR_STRING;
9514 * "eval()" function
9516 static void
9517 f_eval(argvars, rettv)
9518 typval_T *argvars;
9519 typval_T *rettv;
9521 char_u *s;
9523 s = get_tv_string_chk(&argvars[0]);
9524 if (s != NULL)
9525 s = skipwhite(s);
9527 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9529 rettv->v_type = VAR_NUMBER;
9530 rettv->vval.v_number = 0;
9532 else if (*s != NUL)
9533 EMSG(_(e_trailing));
9537 * "eventhandler()" function
9539 static void
9540 f_eventhandler(argvars, rettv)
9541 typval_T *argvars UNUSED;
9542 typval_T *rettv;
9544 rettv->vval.v_number = vgetc_busy;
9548 * "executable()" function
9550 static void
9551 f_executable(argvars, rettv)
9552 typval_T *argvars;
9553 typval_T *rettv;
9555 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9559 * "exists()" function
9561 static void
9562 f_exists(argvars, rettv)
9563 typval_T *argvars;
9564 typval_T *rettv;
9566 char_u *p;
9567 char_u *name;
9568 int n = FALSE;
9569 int len = 0;
9571 p = get_tv_string(&argvars[0]);
9572 if (*p == '$') /* environment variable */
9574 /* first try "normal" environment variables (fast) */
9575 if (mch_getenv(p + 1) != NULL)
9576 n = TRUE;
9577 else
9579 /* try expanding things like $VIM and ${HOME} */
9580 p = expand_env_save(p);
9581 if (p != NULL && *p != '$')
9582 n = TRUE;
9583 vim_free(p);
9586 else if (*p == '&' || *p == '+') /* option */
9588 n = (get_option_tv(&p, NULL, TRUE) == OK);
9589 if (*skipwhite(p) != NUL)
9590 n = FALSE; /* trailing garbage */
9592 else if (*p == '*') /* internal or user defined function */
9594 n = function_exists(p + 1);
9596 else if (*p == ':')
9598 n = cmd_exists(p + 1);
9600 else if (*p == '#')
9602 #ifdef FEAT_AUTOCMD
9603 if (p[1] == '#')
9604 n = autocmd_supported(p + 2);
9605 else
9606 n = au_exists(p + 1);
9607 #endif
9609 else /* internal variable */
9611 char_u *tofree;
9612 typval_T tv;
9614 /* get_name_len() takes care of expanding curly braces */
9615 name = p;
9616 len = get_name_len(&p, &tofree, TRUE, FALSE);
9617 if (len > 0)
9619 if (tofree != NULL)
9620 name = tofree;
9621 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9622 if (n)
9624 /* handle d.key, l[idx], f(expr) */
9625 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9626 if (n)
9627 clear_tv(&tv);
9630 if (*p != NUL)
9631 n = FALSE;
9633 vim_free(tofree);
9636 rettv->vval.v_number = n;
9640 * "expand()" function
9642 static void
9643 f_expand(argvars, rettv)
9644 typval_T *argvars;
9645 typval_T *rettv;
9647 char_u *s;
9648 int len;
9649 char_u *errormsg;
9650 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9651 expand_T xpc;
9652 int error = FALSE;
9654 rettv->v_type = VAR_STRING;
9655 s = get_tv_string(&argvars[0]);
9656 if (*s == '%' || *s == '#' || *s == '<')
9658 ++emsg_off;
9659 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9660 --emsg_off;
9662 else
9664 /* When the optional second argument is non-zero, don't remove matches
9665 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9666 if (argvars[1].v_type != VAR_UNKNOWN
9667 && get_tv_number_chk(&argvars[1], &error))
9668 flags |= WILD_KEEP_ALL;
9669 if (!error)
9671 ExpandInit(&xpc);
9672 xpc.xp_context = EXPAND_FILES;
9673 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9675 else
9676 rettv->vval.v_string = NULL;
9681 * "extend(list, list [, idx])" function
9682 * "extend(dict, dict [, action])" function
9684 static void
9685 f_extend(argvars, rettv)
9686 typval_T *argvars;
9687 typval_T *rettv;
9689 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9691 list_T *l1, *l2;
9692 listitem_T *item;
9693 long before;
9694 int error = FALSE;
9696 l1 = argvars[0].vval.v_list;
9697 l2 = argvars[1].vval.v_list;
9698 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9699 && l2 != NULL)
9701 if (argvars[2].v_type != VAR_UNKNOWN)
9703 before = get_tv_number_chk(&argvars[2], &error);
9704 if (error)
9705 return; /* type error; errmsg already given */
9707 if (before == l1->lv_len)
9708 item = NULL;
9709 else
9711 item = list_find(l1, before);
9712 if (item == NULL)
9714 EMSGN(_(e_listidx), before);
9715 return;
9719 else
9720 item = NULL;
9721 list_extend(l1, l2, item);
9723 copy_tv(&argvars[0], rettv);
9726 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9728 dict_T *d1, *d2;
9729 dictitem_T *di1;
9730 char_u *action;
9731 int i;
9732 hashitem_T *hi2;
9733 int todo;
9735 d1 = argvars[0].vval.v_dict;
9736 d2 = argvars[1].vval.v_dict;
9737 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9738 && d2 != NULL)
9740 /* Check the third argument. */
9741 if (argvars[2].v_type != VAR_UNKNOWN)
9743 static char *(av[]) = {"keep", "force", "error"};
9745 action = get_tv_string_chk(&argvars[2]);
9746 if (action == NULL)
9747 return; /* type error; errmsg already given */
9748 for (i = 0; i < 3; ++i)
9749 if (STRCMP(action, av[i]) == 0)
9750 break;
9751 if (i == 3)
9753 EMSG2(_(e_invarg2), action);
9754 return;
9757 else
9758 action = (char_u *)"force";
9760 /* Go over all entries in the second dict and add them to the
9761 * first dict. */
9762 todo = (int)d2->dv_hashtab.ht_used;
9763 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9765 if (!HASHITEM_EMPTY(hi2))
9767 --todo;
9768 di1 = dict_find(d1, hi2->hi_key, -1);
9769 if (di1 == NULL)
9771 di1 = dictitem_copy(HI2DI(hi2));
9772 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9773 dictitem_free(di1);
9775 else if (*action == 'e')
9777 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9778 break;
9780 else if (*action == 'f')
9782 clear_tv(&di1->di_tv);
9783 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9788 copy_tv(&argvars[0], rettv);
9791 else
9792 EMSG2(_(e_listdictarg), "extend()");
9796 * "feedkeys()" function
9798 static void
9799 f_feedkeys(argvars, rettv)
9800 typval_T *argvars;
9801 typval_T *rettv UNUSED;
9803 int remap = TRUE;
9804 char_u *keys, *flags;
9805 char_u nbuf[NUMBUFLEN];
9806 int typed = FALSE;
9807 char_u *keys_esc;
9809 /* This is not allowed in the sandbox. If the commands would still be
9810 * executed in the sandbox it would be OK, but it probably happens later,
9811 * when "sandbox" is no longer set. */
9812 if (check_secure())
9813 return;
9815 keys = get_tv_string(&argvars[0]);
9816 if (*keys != NUL)
9818 if (argvars[1].v_type != VAR_UNKNOWN)
9820 flags = get_tv_string_buf(&argvars[1], nbuf);
9821 for ( ; *flags != NUL; ++flags)
9823 switch (*flags)
9825 case 'n': remap = FALSE; break;
9826 case 'm': remap = TRUE; break;
9827 case 't': typed = TRUE; break;
9832 /* Need to escape K_SPECIAL and CSI before putting the string in the
9833 * typeahead buffer. */
9834 keys_esc = vim_strsave_escape_csi(keys);
9835 if (keys_esc != NULL)
9837 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9838 typebuf.tb_len, !typed, FALSE);
9839 vim_free(keys_esc);
9840 if (vgetc_busy)
9841 typebuf_was_filled = TRUE;
9847 * "filereadable()" function
9849 static void
9850 f_filereadable(argvars, rettv)
9851 typval_T *argvars;
9852 typval_T *rettv;
9854 int fd;
9855 char_u *p;
9856 int n;
9858 #ifndef O_NONBLOCK
9859 # define O_NONBLOCK 0
9860 #endif
9861 p = get_tv_string(&argvars[0]);
9862 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9863 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9865 n = TRUE;
9866 close(fd);
9868 else
9869 n = FALSE;
9871 rettv->vval.v_number = n;
9875 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9876 * rights to write into.
9878 static void
9879 f_filewritable(argvars, rettv)
9880 typval_T *argvars;
9881 typval_T *rettv;
9883 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9886 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9888 static void
9889 findfilendir(argvars, rettv, find_what)
9890 typval_T *argvars;
9891 typval_T *rettv;
9892 int find_what;
9894 #ifdef FEAT_SEARCHPATH
9895 char_u *fname;
9896 char_u *fresult = NULL;
9897 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9898 char_u *p;
9899 char_u pathbuf[NUMBUFLEN];
9900 int count = 1;
9901 int first = TRUE;
9902 int error = FALSE;
9903 #endif
9905 rettv->vval.v_string = NULL;
9906 rettv->v_type = VAR_STRING;
9908 #ifdef FEAT_SEARCHPATH
9909 fname = get_tv_string(&argvars[0]);
9911 if (argvars[1].v_type != VAR_UNKNOWN)
9913 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9914 if (p == NULL)
9915 error = TRUE;
9916 else
9918 if (*p != NUL)
9919 path = p;
9921 if (argvars[2].v_type != VAR_UNKNOWN)
9922 count = get_tv_number_chk(&argvars[2], &error);
9926 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9927 error = TRUE;
9929 if (*fname != NUL && !error)
9933 if (rettv->v_type == VAR_STRING)
9934 vim_free(fresult);
9935 fresult = find_file_in_path_option(first ? fname : NULL,
9936 first ? (int)STRLEN(fname) : 0,
9937 0, first, path,
9938 find_what,
9939 curbuf->b_ffname,
9940 find_what == FINDFILE_DIR
9941 ? (char_u *)"" : curbuf->b_p_sua);
9942 first = FALSE;
9944 if (fresult != NULL && rettv->v_type == VAR_LIST)
9945 list_append_string(rettv->vval.v_list, fresult, -1);
9947 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9950 if (rettv->v_type == VAR_STRING)
9951 rettv->vval.v_string = fresult;
9952 #endif
9955 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9956 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9959 * Implementation of map() and filter().
9961 static void
9962 filter_map(argvars, rettv, map)
9963 typval_T *argvars;
9964 typval_T *rettv;
9965 int map;
9967 char_u buf[NUMBUFLEN];
9968 char_u *expr;
9969 listitem_T *li, *nli;
9970 list_T *l = NULL;
9971 dictitem_T *di;
9972 hashtab_T *ht;
9973 hashitem_T *hi;
9974 dict_T *d = NULL;
9975 typval_T save_val;
9976 typval_T save_key;
9977 int rem;
9978 int todo;
9979 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9980 int save_did_emsg;
9981 int index = 0;
9983 if (argvars[0].v_type == VAR_LIST)
9985 if ((l = argvars[0].vval.v_list) == NULL
9986 || (map && tv_check_lock(l->lv_lock, ermsg)))
9987 return;
9989 else if (argvars[0].v_type == VAR_DICT)
9991 if ((d = argvars[0].vval.v_dict) == NULL
9992 || (map && tv_check_lock(d->dv_lock, ermsg)))
9993 return;
9995 else
9997 EMSG2(_(e_listdictarg), ermsg);
9998 return;
10001 expr = get_tv_string_buf_chk(&argvars[1], buf);
10002 /* On type errors, the preceding call has already displayed an error
10003 * message. Avoid a misleading error message for an empty string that
10004 * was not passed as argument. */
10005 if (expr != NULL)
10007 prepare_vimvar(VV_VAL, &save_val);
10008 expr = skipwhite(expr);
10010 /* We reset "did_emsg" to be able to detect whether an error
10011 * occurred during evaluation of the expression. */
10012 save_did_emsg = did_emsg;
10013 did_emsg = FALSE;
10015 prepare_vimvar(VV_KEY, &save_key);
10016 if (argvars[0].v_type == VAR_DICT)
10018 vimvars[VV_KEY].vv_type = VAR_STRING;
10020 ht = &d->dv_hashtab;
10021 hash_lock(ht);
10022 todo = (int)ht->ht_used;
10023 for (hi = ht->ht_array; todo > 0; ++hi)
10025 if (!HASHITEM_EMPTY(hi))
10027 --todo;
10028 di = HI2DI(hi);
10029 if (tv_check_lock(di->di_tv.v_lock, ermsg))
10030 break;
10031 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
10032 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
10033 || did_emsg)
10034 break;
10035 if (!map && rem)
10036 dictitem_remove(d, di);
10037 clear_tv(&vimvars[VV_KEY].vv_tv);
10040 hash_unlock(ht);
10042 else
10044 vimvars[VV_KEY].vv_type = VAR_NUMBER;
10046 for (li = l->lv_first; li != NULL; li = nli)
10048 if (tv_check_lock(li->li_tv.v_lock, ermsg))
10049 break;
10050 nli = li->li_next;
10051 vimvars[VV_KEY].vv_nr = index;
10052 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
10053 || did_emsg)
10054 break;
10055 if (!map && rem)
10056 listitem_remove(l, li);
10057 ++index;
10061 restore_vimvar(VV_KEY, &save_key);
10062 restore_vimvar(VV_VAL, &save_val);
10064 did_emsg |= save_did_emsg;
10067 copy_tv(&argvars[0], rettv);
10070 static int
10071 filter_map_one(tv, expr, map, remp)
10072 typval_T *tv;
10073 char_u *expr;
10074 int map;
10075 int *remp;
10077 typval_T rettv;
10078 char_u *s;
10079 int retval = FAIL;
10081 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10082 s = expr;
10083 if (eval1(&s, &rettv, TRUE) == FAIL)
10084 goto theend;
10085 if (*s != NUL) /* check for trailing chars after expr */
10087 EMSG2(_(e_invexpr2), s);
10088 goto theend;
10090 if (map)
10092 /* map(): replace the list item value */
10093 clear_tv(tv);
10094 rettv.v_lock = 0;
10095 *tv = rettv;
10097 else
10099 int error = FALSE;
10101 /* filter(): when expr is zero remove the item */
10102 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10103 clear_tv(&rettv);
10104 /* On type error, nothing has been removed; return FAIL to stop the
10105 * loop. The error message was given by get_tv_number_chk(). */
10106 if (error)
10107 goto theend;
10109 retval = OK;
10110 theend:
10111 clear_tv(&vimvars[VV_VAL].vv_tv);
10112 return retval;
10116 * "filter()" function
10118 static void
10119 f_filter(argvars, rettv)
10120 typval_T *argvars;
10121 typval_T *rettv;
10123 filter_map(argvars, rettv, FALSE);
10127 * "finddir({fname}[, {path}[, {count}]])" function
10129 static void
10130 f_finddir(argvars, rettv)
10131 typval_T *argvars;
10132 typval_T *rettv;
10134 findfilendir(argvars, rettv, FINDFILE_DIR);
10138 * "findfile({fname}[, {path}[, {count}]])" function
10140 static void
10141 f_findfile(argvars, rettv)
10142 typval_T *argvars;
10143 typval_T *rettv;
10145 findfilendir(argvars, rettv, FINDFILE_FILE);
10148 #ifdef FEAT_FLOAT
10150 * "float2nr({float})" function
10152 static void
10153 f_float2nr(argvars, rettv)
10154 typval_T *argvars;
10155 typval_T *rettv;
10157 float_T f;
10159 if (get_float_arg(argvars, &f) == OK)
10161 if (f < -0x7fffffff)
10162 rettv->vval.v_number = -0x7fffffff;
10163 else if (f > 0x7fffffff)
10164 rettv->vval.v_number = 0x7fffffff;
10165 else
10166 rettv->vval.v_number = (varnumber_T)f;
10171 * "floor({float})" function
10173 static void
10174 f_floor(argvars, rettv)
10175 typval_T *argvars;
10176 typval_T *rettv;
10178 float_T f;
10180 rettv->v_type = VAR_FLOAT;
10181 if (get_float_arg(argvars, &f) == OK)
10182 rettv->vval.v_float = floor(f);
10183 else
10184 rettv->vval.v_float = 0.0;
10186 #endif
10189 * "fnameescape({string})" function
10191 static void
10192 f_fnameescape(argvars, rettv)
10193 typval_T *argvars;
10194 typval_T *rettv;
10196 rettv->vval.v_string = vim_strsave_fnameescape(
10197 get_tv_string(&argvars[0]), FALSE);
10198 rettv->v_type = VAR_STRING;
10202 * "fnamemodify({fname}, {mods})" function
10204 static void
10205 f_fnamemodify(argvars, rettv)
10206 typval_T *argvars;
10207 typval_T *rettv;
10209 char_u *fname;
10210 char_u *mods;
10211 int usedlen = 0;
10212 int len;
10213 char_u *fbuf = NULL;
10214 char_u buf[NUMBUFLEN];
10216 fname = get_tv_string_chk(&argvars[0]);
10217 mods = get_tv_string_buf_chk(&argvars[1], buf);
10218 if (fname == NULL || mods == NULL)
10219 fname = NULL;
10220 else
10222 len = (int)STRLEN(fname);
10223 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10226 rettv->v_type = VAR_STRING;
10227 if (fname == NULL)
10228 rettv->vval.v_string = NULL;
10229 else
10230 rettv->vval.v_string = vim_strnsave(fname, len);
10231 vim_free(fbuf);
10234 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10237 * "foldclosed()" function
10239 static void
10240 foldclosed_both(argvars, rettv, end)
10241 typval_T *argvars;
10242 typval_T *rettv;
10243 int end;
10245 #ifdef FEAT_FOLDING
10246 linenr_T lnum;
10247 linenr_T first, last;
10249 lnum = get_tv_lnum(argvars);
10250 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10252 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10254 if (end)
10255 rettv->vval.v_number = (varnumber_T)last;
10256 else
10257 rettv->vval.v_number = (varnumber_T)first;
10258 return;
10261 #endif
10262 rettv->vval.v_number = -1;
10266 * "foldclosed()" function
10268 static void
10269 f_foldclosed(argvars, rettv)
10270 typval_T *argvars;
10271 typval_T *rettv;
10273 foldclosed_both(argvars, rettv, FALSE);
10277 * "foldclosedend()" function
10279 static void
10280 f_foldclosedend(argvars, rettv)
10281 typval_T *argvars;
10282 typval_T *rettv;
10284 foldclosed_both(argvars, rettv, TRUE);
10288 * "foldlevel()" function
10290 static void
10291 f_foldlevel(argvars, rettv)
10292 typval_T *argvars;
10293 typval_T *rettv;
10295 #ifdef FEAT_FOLDING
10296 linenr_T lnum;
10298 lnum = get_tv_lnum(argvars);
10299 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10300 rettv->vval.v_number = foldLevel(lnum);
10301 #endif
10305 * "foldtext()" function
10307 static void
10308 f_foldtext(argvars, rettv)
10309 typval_T *argvars UNUSED;
10310 typval_T *rettv;
10312 #ifdef FEAT_FOLDING
10313 linenr_T lnum;
10314 char_u *s;
10315 char_u *r;
10316 int len;
10317 char *txt;
10318 #endif
10320 rettv->v_type = VAR_STRING;
10321 rettv->vval.v_string = NULL;
10322 #ifdef FEAT_FOLDING
10323 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10324 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10325 <= curbuf->b_ml.ml_line_count
10326 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10328 /* Find first non-empty line in the fold. */
10329 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10330 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10332 if (!linewhite(lnum))
10333 break;
10334 ++lnum;
10337 /* Find interesting text in this line. */
10338 s = skipwhite(ml_get(lnum));
10339 /* skip C comment-start */
10340 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10342 s = skipwhite(s + 2);
10343 if (*skipwhite(s) == NUL
10344 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10346 s = skipwhite(ml_get(lnum + 1));
10347 if (*s == '*')
10348 s = skipwhite(s + 1);
10351 txt = _("+-%s%3ld lines: ");
10352 r = alloc((unsigned)(STRLEN(txt)
10353 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10354 + 20 /* for %3ld */
10355 + STRLEN(s))); /* concatenated */
10356 if (r != NULL)
10358 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10359 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10360 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10361 len = (int)STRLEN(r);
10362 STRCAT(r, s);
10363 /* remove 'foldmarker' and 'commentstring' */
10364 foldtext_cleanup(r + len);
10365 rettv->vval.v_string = r;
10368 #endif
10372 * "foldtextresult(lnum)" function
10374 static void
10375 f_foldtextresult(argvars, rettv)
10376 typval_T *argvars UNUSED;
10377 typval_T *rettv;
10379 #ifdef FEAT_FOLDING
10380 linenr_T lnum;
10381 char_u *text;
10382 char_u buf[51];
10383 foldinfo_T foldinfo;
10384 int fold_count;
10385 #endif
10387 rettv->v_type = VAR_STRING;
10388 rettv->vval.v_string = NULL;
10389 #ifdef FEAT_FOLDING
10390 lnum = get_tv_lnum(argvars);
10391 /* treat illegal types and illegal string values for {lnum} the same */
10392 if (lnum < 0)
10393 lnum = 0;
10394 fold_count = foldedCount(curwin, lnum, &foldinfo);
10395 if (fold_count > 0)
10397 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10398 &foldinfo, buf);
10399 if (text == buf)
10400 text = vim_strsave(text);
10401 rettv->vval.v_string = text;
10403 #endif
10407 * "foreground()" function
10409 static void
10410 f_foreground(argvars, rettv)
10411 typval_T *argvars UNUSED;
10412 typval_T *rettv UNUSED;
10414 #ifdef FEAT_GUI
10415 if (gui.in_use)
10416 gui_mch_set_foreground();
10417 #else
10418 # ifdef WIN32
10419 win32_set_foreground();
10420 # endif
10421 #endif
10425 * "function()" function
10427 static void
10428 f_function(argvars, rettv)
10429 typval_T *argvars;
10430 typval_T *rettv;
10432 char_u *s;
10434 s = get_tv_string(&argvars[0]);
10435 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10436 EMSG2(_(e_invarg2), s);
10437 /* Don't check an autoload name for existence here. */
10438 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10439 EMSG2(_("E700: Unknown function: %s"), s);
10440 else
10442 rettv->vval.v_string = vim_strsave(s);
10443 rettv->v_type = VAR_FUNC;
10448 * "garbagecollect()" function
10450 static void
10451 f_garbagecollect(argvars, rettv)
10452 typval_T *argvars;
10453 typval_T *rettv UNUSED;
10455 /* This is postponed until we are back at the toplevel, because we may be
10456 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10457 want_garbage_collect = TRUE;
10459 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10460 garbage_collect_at_exit = TRUE;
10464 * "get()" function
10466 static void
10467 f_get(argvars, rettv)
10468 typval_T *argvars;
10469 typval_T *rettv;
10471 listitem_T *li;
10472 list_T *l;
10473 dictitem_T *di;
10474 dict_T *d;
10475 typval_T *tv = NULL;
10477 if (argvars[0].v_type == VAR_LIST)
10479 if ((l = argvars[0].vval.v_list) != NULL)
10481 int error = FALSE;
10483 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10484 if (!error && li != NULL)
10485 tv = &li->li_tv;
10488 else if (argvars[0].v_type == VAR_DICT)
10490 if ((d = argvars[0].vval.v_dict) != NULL)
10492 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10493 if (di != NULL)
10494 tv = &di->di_tv;
10497 else
10498 EMSG2(_(e_listdictarg), "get()");
10500 if (tv == NULL)
10502 if (argvars[2].v_type != VAR_UNKNOWN)
10503 copy_tv(&argvars[2], rettv);
10505 else
10506 copy_tv(tv, rettv);
10509 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10512 * Get line or list of lines from buffer "buf" into "rettv".
10513 * Return a range (from start to end) of lines in rettv from the specified
10514 * buffer.
10515 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10517 static void
10518 get_buffer_lines(buf, start, end, retlist, rettv)
10519 buf_T *buf;
10520 linenr_T start;
10521 linenr_T end;
10522 int retlist;
10523 typval_T *rettv;
10525 char_u *p;
10527 if (retlist && rettv_list_alloc(rettv) == FAIL)
10528 return;
10530 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10531 return;
10533 if (!retlist)
10535 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10536 p = ml_get_buf(buf, start, FALSE);
10537 else
10538 p = (char_u *)"";
10540 rettv->v_type = VAR_STRING;
10541 rettv->vval.v_string = vim_strsave(p);
10543 else
10545 if (end < start)
10546 return;
10548 if (start < 1)
10549 start = 1;
10550 if (end > buf->b_ml.ml_line_count)
10551 end = buf->b_ml.ml_line_count;
10552 while (start <= end)
10553 if (list_append_string(rettv->vval.v_list,
10554 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10555 break;
10560 * "getbufline()" function
10562 static void
10563 f_getbufline(argvars, rettv)
10564 typval_T *argvars;
10565 typval_T *rettv;
10567 linenr_T lnum;
10568 linenr_T end;
10569 buf_T *buf;
10571 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10572 ++emsg_off;
10573 buf = get_buf_tv(&argvars[0]);
10574 --emsg_off;
10576 lnum = get_tv_lnum_buf(&argvars[1], buf);
10577 if (argvars[2].v_type == VAR_UNKNOWN)
10578 end = lnum;
10579 else
10580 end = get_tv_lnum_buf(&argvars[2], buf);
10582 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10586 * "getbufvar()" function
10588 static void
10589 f_getbufvar(argvars, rettv)
10590 typval_T *argvars;
10591 typval_T *rettv;
10593 buf_T *buf;
10594 buf_T *save_curbuf;
10595 char_u *varname;
10596 dictitem_T *v;
10598 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10599 varname = get_tv_string_chk(&argvars[1]);
10600 ++emsg_off;
10601 buf = get_buf_tv(&argvars[0]);
10603 rettv->v_type = VAR_STRING;
10604 rettv->vval.v_string = NULL;
10606 if (buf != NULL && varname != NULL)
10608 /* set curbuf to be our buf, temporarily */
10609 save_curbuf = curbuf;
10610 curbuf = buf;
10612 if (*varname == '&') /* buffer-local-option */
10613 get_option_tv(&varname, rettv, TRUE);
10614 else
10616 if (*varname == NUL)
10617 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10618 * scope prefix before the NUL byte is required by
10619 * find_var_in_ht(). */
10620 varname = (char_u *)"b:" + 2;
10621 /* look up the variable */
10622 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10623 if (v != NULL)
10624 copy_tv(&v->di_tv, rettv);
10627 /* restore previous notion of curbuf */
10628 curbuf = save_curbuf;
10631 --emsg_off;
10635 * "getchar()" function
10637 static void
10638 f_getchar(argvars, rettv)
10639 typval_T *argvars;
10640 typval_T *rettv;
10642 varnumber_T n;
10643 int error = FALSE;
10645 /* Position the cursor. Needed after a message that ends in a space. */
10646 windgoto(msg_row, msg_col);
10648 ++no_mapping;
10649 ++allow_keys;
10650 for (;;)
10652 if (argvars[0].v_type == VAR_UNKNOWN)
10653 /* getchar(): blocking wait. */
10654 n = safe_vgetc();
10655 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10656 /* getchar(1): only check if char avail */
10657 n = vpeekc();
10658 else if (error || vpeekc() == NUL)
10659 /* illegal argument or getchar(0) and no char avail: return zero */
10660 n = 0;
10661 else
10662 /* getchar(0) and char avail: return char */
10663 n = safe_vgetc();
10664 if (n == K_IGNORE)
10665 continue;
10666 break;
10668 --no_mapping;
10669 --allow_keys;
10671 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10672 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10673 vimvars[VV_MOUSE_COL].vv_nr = 0;
10675 rettv->vval.v_number = n;
10676 if (IS_SPECIAL(n) || mod_mask != 0)
10678 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10679 int i = 0;
10681 /* Turn a special key into three bytes, plus modifier. */
10682 if (mod_mask != 0)
10684 temp[i++] = K_SPECIAL;
10685 temp[i++] = KS_MODIFIER;
10686 temp[i++] = mod_mask;
10688 if (IS_SPECIAL(n))
10690 temp[i++] = K_SPECIAL;
10691 temp[i++] = K_SECOND(n);
10692 temp[i++] = K_THIRD(n);
10694 #ifdef FEAT_MBYTE
10695 else if (has_mbyte)
10696 i += (*mb_char2bytes)(n, temp + i);
10697 #endif
10698 else
10699 temp[i++] = n;
10700 temp[i++] = NUL;
10701 rettv->v_type = VAR_STRING;
10702 rettv->vval.v_string = vim_strsave(temp);
10704 #ifdef FEAT_MOUSE
10705 if (n == K_LEFTMOUSE
10706 || n == K_LEFTMOUSE_NM
10707 || n == K_LEFTDRAG
10708 || n == K_LEFTRELEASE
10709 || n == K_LEFTRELEASE_NM
10710 || n == K_MIDDLEMOUSE
10711 || n == K_MIDDLEDRAG
10712 || n == K_MIDDLERELEASE
10713 || n == K_RIGHTMOUSE
10714 || n == K_RIGHTDRAG
10715 || n == K_RIGHTRELEASE
10716 || n == K_X1MOUSE
10717 || n == K_X1DRAG
10718 || n == K_X1RELEASE
10719 || n == K_X2MOUSE
10720 || n == K_X2DRAG
10721 || n == K_X2RELEASE
10722 || n == K_MOUSEDOWN
10723 || n == K_MOUSEUP)
10725 int row = mouse_row;
10726 int col = mouse_col;
10727 win_T *win;
10728 linenr_T lnum;
10729 # ifdef FEAT_WINDOWS
10730 win_T *wp;
10731 # endif
10732 int winnr = 1;
10734 if (row >= 0 && col >= 0)
10736 /* Find the window at the mouse coordinates and compute the
10737 * text position. */
10738 win = mouse_find_win(&row, &col);
10739 (void)mouse_comp_pos(win, &row, &col, &lnum);
10740 # ifdef FEAT_WINDOWS
10741 for (wp = firstwin; wp != win; wp = wp->w_next)
10742 ++winnr;
10743 # endif
10744 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10745 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10746 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10749 #endif
10754 * "getcharmod()" function
10756 static void
10757 f_getcharmod(argvars, rettv)
10758 typval_T *argvars UNUSED;
10759 typval_T *rettv;
10761 rettv->vval.v_number = mod_mask;
10765 * "getcmdline()" function
10767 static void
10768 f_getcmdline(argvars, rettv)
10769 typval_T *argvars UNUSED;
10770 typval_T *rettv;
10772 rettv->v_type = VAR_STRING;
10773 rettv->vval.v_string = get_cmdline_str();
10777 * "getcmdpos()" function
10779 static void
10780 f_getcmdpos(argvars, rettv)
10781 typval_T *argvars UNUSED;
10782 typval_T *rettv;
10784 rettv->vval.v_number = get_cmdline_pos() + 1;
10788 * "getcmdtype()" function
10790 static void
10791 f_getcmdtype(argvars, rettv)
10792 typval_T *argvars UNUSED;
10793 typval_T *rettv;
10795 rettv->v_type = VAR_STRING;
10796 rettv->vval.v_string = alloc(2);
10797 if (rettv->vval.v_string != NULL)
10799 rettv->vval.v_string[0] = get_cmdline_type();
10800 rettv->vval.v_string[1] = NUL;
10805 * "getcwd()" function
10807 static void
10808 f_getcwd(argvars, rettv)
10809 typval_T *argvars UNUSED;
10810 typval_T *rettv;
10812 char_u cwd[MAXPATHL];
10814 rettv->v_type = VAR_STRING;
10815 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10816 rettv->vval.v_string = NULL;
10817 else
10819 rettv->vval.v_string = vim_strsave(cwd);
10820 #ifdef BACKSLASH_IN_FILENAME
10821 if (rettv->vval.v_string != NULL)
10822 slash_adjust(rettv->vval.v_string);
10823 #endif
10828 * "getfontname()" function
10830 static void
10831 f_getfontname(argvars, rettv)
10832 typval_T *argvars UNUSED;
10833 typval_T *rettv;
10835 rettv->v_type = VAR_STRING;
10836 rettv->vval.v_string = NULL;
10837 #ifdef FEAT_GUI
10838 if (gui.in_use)
10840 GuiFont font;
10841 char_u *name = NULL;
10843 if (argvars[0].v_type == VAR_UNKNOWN)
10845 /* Get the "Normal" font. Either the name saved by
10846 * hl_set_font_name() or from the font ID. */
10847 font = gui.norm_font;
10848 name = hl_get_font_name();
10850 else
10852 name = get_tv_string(&argvars[0]);
10853 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10854 return;
10855 font = gui_mch_get_font(name, FALSE);
10856 if (font == NOFONT)
10857 return; /* Invalid font name, return empty string. */
10859 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10860 if (argvars[0].v_type != VAR_UNKNOWN)
10861 gui_mch_free_font(font);
10863 #endif
10867 * "getfperm({fname})" function
10869 static void
10870 f_getfperm(argvars, rettv)
10871 typval_T *argvars;
10872 typval_T *rettv;
10874 char_u *fname;
10875 struct stat st;
10876 char_u *perm = NULL;
10877 char_u flags[] = "rwx";
10878 int i;
10880 fname = get_tv_string(&argvars[0]);
10882 rettv->v_type = VAR_STRING;
10883 if (mch_stat((char *)fname, &st) >= 0)
10885 perm = vim_strsave((char_u *)"---------");
10886 if (perm != NULL)
10888 for (i = 0; i < 9; i++)
10890 if (st.st_mode & (1 << (8 - i)))
10891 perm[i] = flags[i % 3];
10895 rettv->vval.v_string = perm;
10899 * "getfsize({fname})" function
10901 static void
10902 f_getfsize(argvars, rettv)
10903 typval_T *argvars;
10904 typval_T *rettv;
10906 char_u *fname;
10907 struct stat st;
10909 fname = get_tv_string(&argvars[0]);
10911 rettv->v_type = VAR_NUMBER;
10913 if (mch_stat((char *)fname, &st) >= 0)
10915 if (mch_isdir(fname))
10916 rettv->vval.v_number = 0;
10917 else
10919 rettv->vval.v_number = (varnumber_T)st.st_size;
10921 /* non-perfect check for overflow */
10922 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10923 rettv->vval.v_number = -2;
10926 else
10927 rettv->vval.v_number = -1;
10931 * "getftime({fname})" function
10933 static void
10934 f_getftime(argvars, rettv)
10935 typval_T *argvars;
10936 typval_T *rettv;
10938 char_u *fname;
10939 struct stat st;
10941 fname = get_tv_string(&argvars[0]);
10943 if (mch_stat((char *)fname, &st) >= 0)
10944 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10945 else
10946 rettv->vval.v_number = -1;
10950 * "getftype({fname})" function
10952 static void
10953 f_getftype(argvars, rettv)
10954 typval_T *argvars;
10955 typval_T *rettv;
10957 char_u *fname;
10958 struct stat st;
10959 char_u *type = NULL;
10960 char *t;
10962 fname = get_tv_string(&argvars[0]);
10964 rettv->v_type = VAR_STRING;
10965 if (mch_lstat((char *)fname, &st) >= 0)
10967 #ifdef S_ISREG
10968 if (S_ISREG(st.st_mode))
10969 t = "file";
10970 else if (S_ISDIR(st.st_mode))
10971 t = "dir";
10972 # ifdef S_ISLNK
10973 else if (S_ISLNK(st.st_mode))
10974 t = "link";
10975 # endif
10976 # ifdef S_ISBLK
10977 else if (S_ISBLK(st.st_mode))
10978 t = "bdev";
10979 # endif
10980 # ifdef S_ISCHR
10981 else if (S_ISCHR(st.st_mode))
10982 t = "cdev";
10983 # endif
10984 # ifdef S_ISFIFO
10985 else if (S_ISFIFO(st.st_mode))
10986 t = "fifo";
10987 # endif
10988 # ifdef S_ISSOCK
10989 else if (S_ISSOCK(st.st_mode))
10990 t = "fifo";
10991 # endif
10992 else
10993 t = "other";
10994 #else
10995 # ifdef S_IFMT
10996 switch (st.st_mode & S_IFMT)
10998 case S_IFREG: t = "file"; break;
10999 case S_IFDIR: t = "dir"; break;
11000 # ifdef S_IFLNK
11001 case S_IFLNK: t = "link"; break;
11002 # endif
11003 # ifdef S_IFBLK
11004 case S_IFBLK: t = "bdev"; break;
11005 # endif
11006 # ifdef S_IFCHR
11007 case S_IFCHR: t = "cdev"; break;
11008 # endif
11009 # ifdef S_IFIFO
11010 case S_IFIFO: t = "fifo"; break;
11011 # endif
11012 # ifdef S_IFSOCK
11013 case S_IFSOCK: t = "socket"; break;
11014 # endif
11015 default: t = "other";
11017 # else
11018 if (mch_isdir(fname))
11019 t = "dir";
11020 else
11021 t = "file";
11022 # endif
11023 #endif
11024 type = vim_strsave((char_u *)t);
11026 rettv->vval.v_string = type;
11030 * "getline(lnum, [end])" function
11032 static void
11033 f_getline(argvars, rettv)
11034 typval_T *argvars;
11035 typval_T *rettv;
11037 linenr_T lnum;
11038 linenr_T end;
11039 int retlist;
11041 lnum = get_tv_lnum(argvars);
11042 if (argvars[1].v_type == VAR_UNKNOWN)
11044 end = 0;
11045 retlist = FALSE;
11047 else
11049 end = get_tv_lnum(&argvars[1]);
11050 retlist = TRUE;
11053 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
11057 * "getmatches()" function
11059 static void
11060 f_getmatches(argvars, rettv)
11061 typval_T *argvars UNUSED;
11062 typval_T *rettv;
11064 #ifdef FEAT_SEARCH_EXTRA
11065 dict_T *dict;
11066 matchitem_T *cur = curwin->w_match_head;
11068 if (rettv_list_alloc(rettv) == OK)
11070 while (cur != NULL)
11072 dict = dict_alloc();
11073 if (dict == NULL)
11074 return;
11075 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11076 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11077 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11078 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11079 list_append_dict(rettv->vval.v_list, dict);
11080 cur = cur->next;
11083 #endif
11087 * "getpid()" function
11089 static void
11090 f_getpid(argvars, rettv)
11091 typval_T *argvars UNUSED;
11092 typval_T *rettv;
11094 rettv->vval.v_number = mch_get_pid();
11098 * "getpos(string)" function
11100 static void
11101 f_getpos(argvars, rettv)
11102 typval_T *argvars;
11103 typval_T *rettv;
11105 pos_T *fp;
11106 list_T *l;
11107 int fnum = -1;
11109 if (rettv_list_alloc(rettv) == OK)
11111 l = rettv->vval.v_list;
11112 fp = var2fpos(&argvars[0], TRUE, &fnum);
11113 if (fnum != -1)
11114 list_append_number(l, (varnumber_T)fnum);
11115 else
11116 list_append_number(l, (varnumber_T)0);
11117 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11118 : (varnumber_T)0);
11119 list_append_number(l, (fp != NULL)
11120 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11121 : (varnumber_T)0);
11122 list_append_number(l,
11123 #ifdef FEAT_VIRTUALEDIT
11124 (fp != NULL) ? (varnumber_T)fp->coladd :
11125 #endif
11126 (varnumber_T)0);
11128 else
11129 rettv->vval.v_number = FALSE;
11133 * "getqflist()" and "getloclist()" functions
11135 static void
11136 f_getqflist(argvars, rettv)
11137 typval_T *argvars UNUSED;
11138 typval_T *rettv UNUSED;
11140 #ifdef FEAT_QUICKFIX
11141 win_T *wp;
11142 #endif
11144 #ifdef FEAT_QUICKFIX
11145 if (rettv_list_alloc(rettv) == OK)
11147 wp = NULL;
11148 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11150 wp = find_win_by_nr(&argvars[0], NULL);
11151 if (wp == NULL)
11152 return;
11155 (void)get_errorlist(wp, rettv->vval.v_list);
11157 #endif
11161 * "getreg()" function
11163 static void
11164 f_getreg(argvars, rettv)
11165 typval_T *argvars;
11166 typval_T *rettv;
11168 char_u *strregname;
11169 int regname;
11170 int arg2 = FALSE;
11171 int error = FALSE;
11173 if (argvars[0].v_type != VAR_UNKNOWN)
11175 strregname = get_tv_string_chk(&argvars[0]);
11176 error = strregname == NULL;
11177 if (argvars[1].v_type != VAR_UNKNOWN)
11178 arg2 = get_tv_number_chk(&argvars[1], &error);
11180 else
11181 strregname = vimvars[VV_REG].vv_str;
11182 regname = (strregname == NULL ? '"' : *strregname);
11183 if (regname == 0)
11184 regname = '"';
11186 rettv->v_type = VAR_STRING;
11187 rettv->vval.v_string = error ? NULL :
11188 get_reg_contents(regname, TRUE, arg2);
11192 * "getregtype()" function
11194 static void
11195 f_getregtype(argvars, rettv)
11196 typval_T *argvars;
11197 typval_T *rettv;
11199 char_u *strregname;
11200 int regname;
11201 char_u buf[NUMBUFLEN + 2];
11202 long reglen = 0;
11204 if (argvars[0].v_type != VAR_UNKNOWN)
11206 strregname = get_tv_string_chk(&argvars[0]);
11207 if (strregname == NULL) /* type error; errmsg already given */
11209 rettv->v_type = VAR_STRING;
11210 rettv->vval.v_string = NULL;
11211 return;
11214 else
11215 /* Default to v:register */
11216 strregname = vimvars[VV_REG].vv_str;
11218 regname = (strregname == NULL ? '"' : *strregname);
11219 if (regname == 0)
11220 regname = '"';
11222 buf[0] = NUL;
11223 buf[1] = NUL;
11224 switch (get_reg_type(regname, &reglen))
11226 case MLINE: buf[0] = 'V'; break;
11227 case MCHAR: buf[0] = 'v'; break;
11228 #ifdef FEAT_VISUAL
11229 case MBLOCK:
11230 buf[0] = Ctrl_V;
11231 sprintf((char *)buf + 1, "%ld", reglen + 1);
11232 break;
11233 #endif
11235 rettv->v_type = VAR_STRING;
11236 rettv->vval.v_string = vim_strsave(buf);
11240 * "gettabwinvar()" function
11242 static void
11243 f_gettabwinvar(argvars, rettv)
11244 typval_T *argvars;
11245 typval_T *rettv;
11247 getwinvar(argvars, rettv, 1);
11251 * "getwinposx()" function
11253 static void
11254 f_getwinposx(argvars, rettv)
11255 typval_T *argvars UNUSED;
11256 typval_T *rettv;
11258 rettv->vval.v_number = -1;
11259 #ifdef FEAT_GUI
11260 if (gui.in_use)
11262 int x, y;
11264 if (gui_mch_get_winpos(&x, &y) == OK)
11265 rettv->vval.v_number = x;
11267 #endif
11271 * "getwinposy()" function
11273 static void
11274 f_getwinposy(argvars, rettv)
11275 typval_T *argvars UNUSED;
11276 typval_T *rettv;
11278 rettv->vval.v_number = -1;
11279 #ifdef FEAT_GUI
11280 if (gui.in_use)
11282 int x, y;
11284 if (gui_mch_get_winpos(&x, &y) == OK)
11285 rettv->vval.v_number = y;
11287 #endif
11291 * Find window specified by "vp" in tabpage "tp".
11293 static win_T *
11294 find_win_by_nr(vp, tp)
11295 typval_T *vp;
11296 tabpage_T *tp; /* NULL for current tab page */
11298 #ifdef FEAT_WINDOWS
11299 win_T *wp;
11300 #endif
11301 int nr;
11303 nr = get_tv_number_chk(vp, NULL);
11305 #ifdef FEAT_WINDOWS
11306 if (nr < 0)
11307 return NULL;
11308 if (nr == 0)
11309 return curwin;
11311 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11312 wp != NULL; wp = wp->w_next)
11313 if (--nr <= 0)
11314 break;
11315 return wp;
11316 #else
11317 if (nr == 0 || nr == 1)
11318 return curwin;
11319 return NULL;
11320 #endif
11324 * "getwinvar()" function
11326 static void
11327 f_getwinvar(argvars, rettv)
11328 typval_T *argvars;
11329 typval_T *rettv;
11331 getwinvar(argvars, rettv, 0);
11335 * getwinvar() and gettabwinvar()
11337 static void
11338 getwinvar(argvars, rettv, off)
11339 typval_T *argvars;
11340 typval_T *rettv;
11341 int off; /* 1 for gettabwinvar() */
11343 win_T *win, *oldcurwin;
11344 char_u *varname;
11345 dictitem_T *v;
11346 tabpage_T *tp;
11348 #ifdef FEAT_WINDOWS
11349 if (off == 1)
11350 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11351 else
11352 tp = curtab;
11353 #endif
11354 win = find_win_by_nr(&argvars[off], tp);
11355 varname = get_tv_string_chk(&argvars[off + 1]);
11356 ++emsg_off;
11358 rettv->v_type = VAR_STRING;
11359 rettv->vval.v_string = NULL;
11361 if (win != NULL && varname != NULL)
11363 /* Set curwin to be our win, temporarily. Also set curbuf, so
11364 * that we can get buffer-local options. */
11365 oldcurwin = curwin;
11366 curwin = win;
11367 curbuf = win->w_buffer;
11369 if (*varname == '&') /* window-local-option */
11370 get_option_tv(&varname, rettv, 1);
11371 else
11373 if (*varname == NUL)
11374 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11375 * scope prefix before the NUL byte is required by
11376 * find_var_in_ht(). */
11377 varname = (char_u *)"w:" + 2;
11378 /* look up the variable */
11379 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11380 if (v != NULL)
11381 copy_tv(&v->di_tv, rettv);
11384 /* restore previous notion of curwin */
11385 curwin = oldcurwin;
11386 curbuf = curwin->w_buffer;
11389 --emsg_off;
11393 * "glob()" function
11395 static void
11396 f_glob(argvars, rettv)
11397 typval_T *argvars;
11398 typval_T *rettv;
11400 int flags = WILD_SILENT|WILD_USE_NL;
11401 expand_T xpc;
11402 int error = FALSE;
11404 /* When the optional second argument is non-zero, don't remove matches
11405 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11406 if (argvars[1].v_type != VAR_UNKNOWN
11407 && get_tv_number_chk(&argvars[1], &error))
11408 flags |= WILD_KEEP_ALL;
11409 rettv->v_type = VAR_STRING;
11410 if (!error)
11412 ExpandInit(&xpc);
11413 xpc.xp_context = EXPAND_FILES;
11414 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11415 NULL, flags, WILD_ALL);
11417 else
11418 rettv->vval.v_string = NULL;
11422 * "globpath()" function
11424 static void
11425 f_globpath(argvars, rettv)
11426 typval_T *argvars;
11427 typval_T *rettv;
11429 int flags = 0;
11430 char_u buf1[NUMBUFLEN];
11431 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11432 int error = FALSE;
11434 /* When the optional second argument is non-zero, don't remove matches
11435 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11436 if (argvars[2].v_type != VAR_UNKNOWN
11437 && get_tv_number_chk(&argvars[2], &error))
11438 flags |= WILD_KEEP_ALL;
11439 rettv->v_type = VAR_STRING;
11440 if (file == NULL || error)
11441 rettv->vval.v_string = NULL;
11442 else
11443 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11444 flags);
11448 * "has()" function
11450 static void
11451 f_has(argvars, rettv)
11452 typval_T *argvars;
11453 typval_T *rettv;
11455 int i;
11456 char_u *name;
11457 int n = FALSE;
11458 static char *(has_list[]) =
11460 #ifdef AMIGA
11461 "amiga",
11462 # ifdef FEAT_ARP
11463 "arp",
11464 # endif
11465 #endif
11466 #ifdef __BEOS__
11467 "beos",
11468 #endif
11469 #ifdef MSDOS
11470 # ifdef DJGPP
11471 "dos32",
11472 # else
11473 "dos16",
11474 # endif
11475 #endif
11476 #ifdef MACOS
11477 "mac",
11478 #endif
11479 #if defined(MACOS_X_UNIX)
11480 "macunix",
11481 #endif
11482 #ifdef OS2
11483 "os2",
11484 #endif
11485 #ifdef __QNX__
11486 "qnx",
11487 #endif
11488 #ifdef RISCOS
11489 "riscos",
11490 #endif
11491 #ifdef UNIX
11492 "unix",
11493 #endif
11494 #ifdef VMS
11495 "vms",
11496 #endif
11497 #ifdef WIN16
11498 "win16",
11499 #endif
11500 #ifdef WIN32
11501 "win32",
11502 #endif
11503 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11504 "win32unix",
11505 #endif
11506 #if defined(WIN64) || defined(_WIN64)
11507 "win64",
11508 #endif
11509 #ifdef EBCDIC
11510 "ebcdic",
11511 #endif
11512 #ifndef CASE_INSENSITIVE_FILENAME
11513 "fname_case",
11514 #endif
11515 #ifdef FEAT_ARABIC
11516 "arabic",
11517 #endif
11518 #ifdef FEAT_AUTOCMD
11519 "autocmd",
11520 #endif
11521 #ifdef FEAT_BEVAL
11522 "balloon_eval",
11523 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11524 "balloon_multiline",
11525 # endif
11526 #endif
11527 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11528 "builtin_terms",
11529 # ifdef ALL_BUILTIN_TCAPS
11530 "all_builtin_terms",
11531 # endif
11532 #endif
11533 #ifdef FEAT_BYTEOFF
11534 "byte_offset",
11535 #endif
11536 #ifdef FEAT_CINDENT
11537 "cindent",
11538 #endif
11539 #ifdef FEAT_CLIENTSERVER
11540 "clientserver",
11541 #endif
11542 #ifdef FEAT_CLIPBOARD
11543 "clipboard",
11544 #endif
11545 #ifdef FEAT_CMDL_COMPL
11546 "cmdline_compl",
11547 #endif
11548 #ifdef FEAT_CMDHIST
11549 "cmdline_hist",
11550 #endif
11551 #ifdef FEAT_COMMENTS
11552 "comments",
11553 #endif
11554 #ifdef FEAT_CRYPT
11555 "cryptv",
11556 #endif
11557 #ifdef FEAT_CSCOPE
11558 "cscope",
11559 #endif
11560 #ifdef CURSOR_SHAPE
11561 "cursorshape",
11562 #endif
11563 #ifdef DEBUG
11564 "debug",
11565 #endif
11566 #ifdef FEAT_CON_DIALOG
11567 "dialog_con",
11568 #endif
11569 #ifdef FEAT_GUI_DIALOG
11570 "dialog_gui",
11571 #endif
11572 #ifdef FEAT_DIFF
11573 "diff",
11574 #endif
11575 #ifdef FEAT_DIGRAPHS
11576 "digraphs",
11577 #endif
11578 #ifdef FEAT_DND
11579 "dnd",
11580 #endif
11581 #ifdef FEAT_EMACS_TAGS
11582 "emacs_tags",
11583 #endif
11584 "eval", /* always present, of course! */
11585 #ifdef FEAT_EX_EXTRA
11586 "ex_extra",
11587 #endif
11588 #ifdef FEAT_SEARCH_EXTRA
11589 "extra_search",
11590 #endif
11591 #ifdef FEAT_FKMAP
11592 "farsi",
11593 #endif
11594 #ifdef FEAT_SEARCHPATH
11595 "file_in_path",
11596 #endif
11597 #if defined(UNIX) && !defined(USE_SYSTEM)
11598 "filterpipe",
11599 #endif
11600 #ifdef FEAT_FIND_ID
11601 "find_in_path",
11602 #endif
11603 #ifdef FEAT_FLOAT
11604 "float",
11605 #endif
11606 #ifdef FEAT_FOLDING
11607 "folding",
11608 #endif
11609 #ifdef FEAT_FOOTER
11610 "footer",
11611 #endif
11612 #if !defined(USE_SYSTEM) && defined(UNIX)
11613 "fork",
11614 #endif
11615 #ifdef FEAT_GETTEXT
11616 "gettext",
11617 #endif
11618 #ifdef FEAT_GUI
11619 "gui",
11620 #endif
11621 #ifdef FEAT_GUI_ATHENA
11622 # ifdef FEAT_GUI_NEXTAW
11623 "gui_neXtaw",
11624 # else
11625 "gui_athena",
11626 # endif
11627 #endif
11628 #ifdef FEAT_GUI_GTK
11629 "gui_gtk",
11630 # ifdef HAVE_GTK2
11631 "gui_gtk2",
11632 # endif
11633 #endif
11634 #ifdef FEAT_GUI_GNOME
11635 "gui_gnome",
11636 #endif
11637 #ifdef FEAT_GUI_MAC
11638 "gui_mac",
11639 #endif
11640 #ifdef FEAT_GUI_MOTIF
11641 "gui_motif",
11642 #endif
11643 #ifdef FEAT_GUI_PHOTON
11644 "gui_photon",
11645 #endif
11646 #ifdef FEAT_GUI_W16
11647 "gui_win16",
11648 #endif
11649 #ifdef FEAT_GUI_W32
11650 "gui_win32",
11651 #endif
11652 #ifdef FEAT_HANGULIN
11653 "hangul_input",
11654 #endif
11655 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11656 "iconv",
11657 #endif
11658 #ifdef FEAT_INS_EXPAND
11659 "insert_expand",
11660 #endif
11661 #ifdef FEAT_JUMPLIST
11662 "jumplist",
11663 #endif
11664 #ifdef FEAT_KEYMAP
11665 "keymap",
11666 #endif
11667 #ifdef FEAT_LANGMAP
11668 "langmap",
11669 #endif
11670 #ifdef FEAT_LIBCALL
11671 "libcall",
11672 #endif
11673 #ifdef FEAT_LINEBREAK
11674 "linebreak",
11675 #endif
11676 #ifdef FEAT_LISP
11677 "lispindent",
11678 #endif
11679 #ifdef FEAT_LISTCMDS
11680 "listcmds",
11681 #endif
11682 #ifdef FEAT_LOCALMAP
11683 "localmap",
11684 #endif
11685 #ifdef FEAT_MENU
11686 "menu",
11687 #endif
11688 #ifdef FEAT_SESSION
11689 "mksession",
11690 #endif
11691 #ifdef FEAT_MODIFY_FNAME
11692 "modify_fname",
11693 #endif
11694 #ifdef FEAT_MOUSE
11695 "mouse",
11696 #endif
11697 #ifdef FEAT_MOUSESHAPE
11698 "mouseshape",
11699 #endif
11700 #if defined(UNIX) || defined(VMS)
11701 # ifdef FEAT_MOUSE_DEC
11702 "mouse_dec",
11703 # endif
11704 # ifdef FEAT_MOUSE_GPM
11705 "mouse_gpm",
11706 # endif
11707 # ifdef FEAT_MOUSE_JSB
11708 "mouse_jsbterm",
11709 # endif
11710 # ifdef FEAT_MOUSE_NET
11711 "mouse_netterm",
11712 # endif
11713 # ifdef FEAT_MOUSE_PTERM
11714 "mouse_pterm",
11715 # endif
11716 # ifdef FEAT_SYSMOUSE
11717 "mouse_sysmouse",
11718 # endif
11719 # ifdef FEAT_MOUSE_XTERM
11720 "mouse_xterm",
11721 # endif
11722 #endif
11723 #ifdef FEAT_MBYTE
11724 "multi_byte",
11725 #endif
11726 #ifdef FEAT_MBYTE_IME
11727 "multi_byte_ime",
11728 #endif
11729 #ifdef FEAT_MULTI_LANG
11730 "multi_lang",
11731 #endif
11732 #ifdef FEAT_MZSCHEME
11733 #ifndef DYNAMIC_MZSCHEME
11734 "mzscheme",
11735 #endif
11736 #endif
11737 #ifdef FEAT_OLE
11738 "ole",
11739 #endif
11740 #ifdef FEAT_OSFILETYPE
11741 "osfiletype",
11742 #endif
11743 #ifdef FEAT_PATH_EXTRA
11744 "path_extra",
11745 #endif
11746 #ifdef FEAT_PERL
11747 #ifndef DYNAMIC_PERL
11748 "perl",
11749 #endif
11750 #endif
11751 #ifdef FEAT_PYTHON
11752 #ifndef DYNAMIC_PYTHON
11753 "python",
11754 #endif
11755 #endif
11756 #ifdef FEAT_POSTSCRIPT
11757 "postscript",
11758 #endif
11759 #ifdef FEAT_PRINTER
11760 "printer",
11761 #endif
11762 #ifdef FEAT_PROFILE
11763 "profile",
11764 #endif
11765 #ifdef FEAT_RELTIME
11766 "reltime",
11767 #endif
11768 #ifdef FEAT_QUICKFIX
11769 "quickfix",
11770 #endif
11771 #ifdef FEAT_RIGHTLEFT
11772 "rightleft",
11773 #endif
11774 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11775 "ruby",
11776 #endif
11777 #ifdef FEAT_SCROLLBIND
11778 "scrollbind",
11779 #endif
11780 #ifdef FEAT_CMDL_INFO
11781 "showcmd",
11782 "cmdline_info",
11783 #endif
11784 #ifdef FEAT_SIGNS
11785 "signs",
11786 #endif
11787 #ifdef FEAT_SMARTINDENT
11788 "smartindent",
11789 #endif
11790 #ifdef FEAT_SNIFF
11791 "sniff",
11792 #endif
11793 #ifdef STARTUPTIME
11794 "startuptime",
11795 #endif
11796 #ifdef FEAT_STL_OPT
11797 "statusline",
11798 #endif
11799 #ifdef FEAT_SUN_WORKSHOP
11800 "sun_workshop",
11801 #endif
11802 #ifdef FEAT_NETBEANS_INTG
11803 "netbeans_intg",
11804 #endif
11805 #ifdef FEAT_SPELL
11806 "spell",
11807 #endif
11808 #ifdef FEAT_SYN_HL
11809 "syntax",
11810 #endif
11811 #if defined(USE_SYSTEM) || !defined(UNIX)
11812 "system",
11813 #endif
11814 #ifdef FEAT_TAG_BINS
11815 "tag_binary",
11816 #endif
11817 #ifdef FEAT_TAG_OLDSTATIC
11818 "tag_old_static",
11819 #endif
11820 #ifdef FEAT_TAG_ANYWHITE
11821 "tag_any_white",
11822 #endif
11823 #ifdef FEAT_TCL
11824 # ifndef DYNAMIC_TCL
11825 "tcl",
11826 # endif
11827 #endif
11828 #ifdef TERMINFO
11829 "terminfo",
11830 #endif
11831 #ifdef FEAT_TERMRESPONSE
11832 "termresponse",
11833 #endif
11834 #ifdef FEAT_TEXTOBJ
11835 "textobjects",
11836 #endif
11837 #ifdef HAVE_TGETENT
11838 "tgetent",
11839 #endif
11840 #ifdef FEAT_TITLE
11841 "title",
11842 #endif
11843 #ifdef FEAT_TOOLBAR
11844 "toolbar",
11845 #endif
11846 #ifdef FEAT_USR_CMDS
11847 "user-commands", /* was accidentally included in 5.4 */
11848 "user_commands",
11849 #endif
11850 #ifdef FEAT_VIMINFO
11851 "viminfo",
11852 #endif
11853 #ifdef FEAT_VERTSPLIT
11854 "vertsplit",
11855 #endif
11856 #ifdef FEAT_VIRTUALEDIT
11857 "virtualedit",
11858 #endif
11859 #ifdef FEAT_VISUAL
11860 "visual",
11861 #endif
11862 #ifdef FEAT_VISUALEXTRA
11863 "visualextra",
11864 #endif
11865 #ifdef FEAT_VREPLACE
11866 "vreplace",
11867 #endif
11868 #ifdef FEAT_WILDIGN
11869 "wildignore",
11870 #endif
11871 #ifdef FEAT_WILDMENU
11872 "wildmenu",
11873 #endif
11874 #ifdef FEAT_WINDOWS
11875 "windows",
11876 #endif
11877 #ifdef FEAT_WAK
11878 "winaltkeys",
11879 #endif
11880 #ifdef FEAT_WRITEBACKUP
11881 "writebackup",
11882 #endif
11883 #ifdef FEAT_XIM
11884 "xim",
11885 #endif
11886 #ifdef FEAT_XFONTSET
11887 "xfontset",
11888 #endif
11889 #ifdef USE_XSMP
11890 "xsmp",
11891 #endif
11892 #ifdef USE_XSMP_INTERACT
11893 "xsmp_interact",
11894 #endif
11895 #ifdef FEAT_XCLIPBOARD
11896 "xterm_clipboard",
11897 #endif
11898 #ifdef FEAT_XTERM_SAVE
11899 "xterm_save",
11900 #endif
11901 #if defined(UNIX) && defined(FEAT_X11)
11902 "X11",
11903 #endif
11904 NULL
11907 name = get_tv_string(&argvars[0]);
11908 for (i = 0; has_list[i] != NULL; ++i)
11909 if (STRICMP(name, has_list[i]) == 0)
11911 n = TRUE;
11912 break;
11915 if (n == FALSE)
11917 if (STRNICMP(name, "patch", 5) == 0)
11918 n = has_patch(atoi((char *)name + 5));
11919 else if (STRICMP(name, "vim_starting") == 0)
11920 n = (starting != 0);
11921 #ifdef FEAT_MBYTE
11922 else if (STRICMP(name, "multi_byte_encoding") == 0)
11923 n = has_mbyte;
11924 #endif
11925 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11926 else if (STRICMP(name, "balloon_multiline") == 0)
11927 n = multiline_balloon_available();
11928 #endif
11929 #ifdef DYNAMIC_TCL
11930 else if (STRICMP(name, "tcl") == 0)
11931 n = tcl_enabled(FALSE);
11932 #endif
11933 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11934 else if (STRICMP(name, "iconv") == 0)
11935 n = iconv_enabled(FALSE);
11936 #endif
11937 #ifdef DYNAMIC_MZSCHEME
11938 else if (STRICMP(name, "mzscheme") == 0)
11939 n = mzscheme_enabled(FALSE);
11940 #endif
11941 #ifdef DYNAMIC_RUBY
11942 else if (STRICMP(name, "ruby") == 0)
11943 n = ruby_enabled(FALSE);
11944 #endif
11945 #ifdef DYNAMIC_PYTHON
11946 else if (STRICMP(name, "python") == 0)
11947 n = python_enabled(FALSE);
11948 #endif
11949 #ifdef DYNAMIC_PERL
11950 else if (STRICMP(name, "perl") == 0)
11951 n = perl_enabled(FALSE);
11952 #endif
11953 #ifdef FEAT_GUI
11954 else if (STRICMP(name, "gui_running") == 0)
11955 n = (gui.in_use || gui.starting);
11956 # ifdef FEAT_GUI_W32
11957 else if (STRICMP(name, "gui_win32s") == 0)
11958 n = gui_is_win32s();
11959 # endif
11960 # ifdef FEAT_BROWSE
11961 else if (STRICMP(name, "browse") == 0)
11962 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11963 # endif
11964 #endif
11965 #ifdef FEAT_SYN_HL
11966 else if (STRICMP(name, "syntax_items") == 0)
11967 n = syntax_present(curbuf);
11968 #endif
11969 #if defined(WIN3264)
11970 else if (STRICMP(name, "win95") == 0)
11971 n = mch_windows95();
11972 #endif
11973 #ifdef FEAT_NETBEANS_INTG
11974 else if (STRICMP(name, "netbeans_enabled") == 0)
11975 n = usingNetbeans;
11976 #endif
11979 rettv->vval.v_number = n;
11983 * "has_key()" function
11985 static void
11986 f_has_key(argvars, rettv)
11987 typval_T *argvars;
11988 typval_T *rettv;
11990 if (argvars[0].v_type != VAR_DICT)
11992 EMSG(_(e_dictreq));
11993 return;
11995 if (argvars[0].vval.v_dict == NULL)
11996 return;
11998 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11999 get_tv_string(&argvars[1]), -1) != NULL;
12003 * "haslocaldir()" function
12005 static void
12006 f_haslocaldir(argvars, rettv)
12007 typval_T *argvars UNUSED;
12008 typval_T *rettv;
12010 rettv->vval.v_number = (curwin->w_localdir != NULL);
12014 * "hasmapto()" function
12016 static void
12017 f_hasmapto(argvars, rettv)
12018 typval_T *argvars;
12019 typval_T *rettv;
12021 char_u *name;
12022 char_u *mode;
12023 char_u buf[NUMBUFLEN];
12024 int abbr = FALSE;
12026 name = get_tv_string(&argvars[0]);
12027 if (argvars[1].v_type == VAR_UNKNOWN)
12028 mode = (char_u *)"nvo";
12029 else
12031 mode = get_tv_string_buf(&argvars[1], buf);
12032 if (argvars[2].v_type != VAR_UNKNOWN)
12033 abbr = get_tv_number(&argvars[2]);
12036 if (map_to_exists(name, mode, abbr))
12037 rettv->vval.v_number = TRUE;
12038 else
12039 rettv->vval.v_number = FALSE;
12043 * "histadd()" function
12045 static void
12046 f_histadd(argvars, rettv)
12047 typval_T *argvars UNUSED;
12048 typval_T *rettv;
12050 #ifdef FEAT_CMDHIST
12051 int histype;
12052 char_u *str;
12053 char_u buf[NUMBUFLEN];
12054 #endif
12056 rettv->vval.v_number = FALSE;
12057 if (check_restricted() || check_secure())
12058 return;
12059 #ifdef FEAT_CMDHIST
12060 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12061 histype = str != NULL ? get_histtype(str) : -1;
12062 if (histype >= 0)
12064 str = get_tv_string_buf(&argvars[1], buf);
12065 if (*str != NUL)
12067 init_history();
12068 add_to_history(histype, str, FALSE, NUL);
12069 rettv->vval.v_number = TRUE;
12070 return;
12073 #endif
12077 * "histdel()" function
12079 static void
12080 f_histdel(argvars, rettv)
12081 typval_T *argvars UNUSED;
12082 typval_T *rettv UNUSED;
12084 #ifdef FEAT_CMDHIST
12085 int n;
12086 char_u buf[NUMBUFLEN];
12087 char_u *str;
12089 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12090 if (str == NULL)
12091 n = 0;
12092 else if (argvars[1].v_type == VAR_UNKNOWN)
12093 /* only one argument: clear entire history */
12094 n = clr_history(get_histtype(str));
12095 else if (argvars[1].v_type == VAR_NUMBER)
12096 /* index given: remove that entry */
12097 n = del_history_idx(get_histtype(str),
12098 (int)get_tv_number(&argvars[1]));
12099 else
12100 /* string given: remove all matching entries */
12101 n = del_history_entry(get_histtype(str),
12102 get_tv_string_buf(&argvars[1], buf));
12103 rettv->vval.v_number = n;
12104 #endif
12108 * "histget()" function
12110 static void
12111 f_histget(argvars, rettv)
12112 typval_T *argvars UNUSED;
12113 typval_T *rettv;
12115 #ifdef FEAT_CMDHIST
12116 int type;
12117 int idx;
12118 char_u *str;
12120 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12121 if (str == NULL)
12122 rettv->vval.v_string = NULL;
12123 else
12125 type = get_histtype(str);
12126 if (argvars[1].v_type == VAR_UNKNOWN)
12127 idx = get_history_idx(type);
12128 else
12129 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12130 /* -1 on type error */
12131 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12133 #else
12134 rettv->vval.v_string = NULL;
12135 #endif
12136 rettv->v_type = VAR_STRING;
12140 * "histnr()" function
12142 static void
12143 f_histnr(argvars, rettv)
12144 typval_T *argvars UNUSED;
12145 typval_T *rettv;
12147 int i;
12149 #ifdef FEAT_CMDHIST
12150 char_u *history = get_tv_string_chk(&argvars[0]);
12152 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12153 if (i >= HIST_CMD && i < HIST_COUNT)
12154 i = get_history_idx(i);
12155 else
12156 #endif
12157 i = -1;
12158 rettv->vval.v_number = i;
12162 * "highlightID(name)" function
12164 static void
12165 f_hlID(argvars, rettv)
12166 typval_T *argvars;
12167 typval_T *rettv;
12169 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12173 * "highlight_exists()" function
12175 static void
12176 f_hlexists(argvars, rettv)
12177 typval_T *argvars;
12178 typval_T *rettv;
12180 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12184 * "hostname()" function
12186 static void
12187 f_hostname(argvars, rettv)
12188 typval_T *argvars UNUSED;
12189 typval_T *rettv;
12191 char_u hostname[256];
12193 mch_get_host_name(hostname, 256);
12194 rettv->v_type = VAR_STRING;
12195 rettv->vval.v_string = vim_strsave(hostname);
12199 * iconv() function
12201 static void
12202 f_iconv(argvars, rettv)
12203 typval_T *argvars UNUSED;
12204 typval_T *rettv;
12206 #ifdef FEAT_MBYTE
12207 char_u buf1[NUMBUFLEN];
12208 char_u buf2[NUMBUFLEN];
12209 char_u *from, *to, *str;
12210 vimconv_T vimconv;
12211 #endif
12213 rettv->v_type = VAR_STRING;
12214 rettv->vval.v_string = NULL;
12216 #ifdef FEAT_MBYTE
12217 str = get_tv_string(&argvars[0]);
12218 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12219 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12220 vimconv.vc_type = CONV_NONE;
12221 convert_setup(&vimconv, from, to);
12223 /* If the encodings are equal, no conversion needed. */
12224 if (vimconv.vc_type == CONV_NONE)
12225 rettv->vval.v_string = vim_strsave(str);
12226 else
12227 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12229 convert_setup(&vimconv, NULL, NULL);
12230 vim_free(from);
12231 vim_free(to);
12232 #endif
12236 * "indent()" function
12238 static void
12239 f_indent(argvars, rettv)
12240 typval_T *argvars;
12241 typval_T *rettv;
12243 linenr_T lnum;
12245 lnum = get_tv_lnum(argvars);
12246 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12247 rettv->vval.v_number = get_indent_lnum(lnum);
12248 else
12249 rettv->vval.v_number = -1;
12253 * "index()" function
12255 static void
12256 f_index(argvars, rettv)
12257 typval_T *argvars;
12258 typval_T *rettv;
12260 list_T *l;
12261 listitem_T *item;
12262 long idx = 0;
12263 int ic = FALSE;
12265 rettv->vval.v_number = -1;
12266 if (argvars[0].v_type != VAR_LIST)
12268 EMSG(_(e_listreq));
12269 return;
12271 l = argvars[0].vval.v_list;
12272 if (l != NULL)
12274 item = l->lv_first;
12275 if (argvars[2].v_type != VAR_UNKNOWN)
12277 int error = FALSE;
12279 /* Start at specified item. Use the cached index that list_find()
12280 * sets, so that a negative number also works. */
12281 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12282 idx = l->lv_idx;
12283 if (argvars[3].v_type != VAR_UNKNOWN)
12284 ic = get_tv_number_chk(&argvars[3], &error);
12285 if (error)
12286 item = NULL;
12289 for ( ; item != NULL; item = item->li_next, ++idx)
12290 if (tv_equal(&item->li_tv, &argvars[1], ic))
12292 rettv->vval.v_number = idx;
12293 break;
12298 static int inputsecret_flag = 0;
12300 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12303 * This function is used by f_input() and f_inputdialog() functions. The third
12304 * argument to f_input() specifies the type of completion to use at the
12305 * prompt. The third argument to f_inputdialog() specifies the value to return
12306 * when the user cancels the prompt.
12308 static void
12309 get_user_input(argvars, rettv, inputdialog)
12310 typval_T *argvars;
12311 typval_T *rettv;
12312 int inputdialog;
12314 char_u *prompt = get_tv_string_chk(&argvars[0]);
12315 char_u *p = NULL;
12316 int c;
12317 char_u buf[NUMBUFLEN];
12318 int cmd_silent_save = cmd_silent;
12319 char_u *defstr = (char_u *)"";
12320 int xp_type = EXPAND_NOTHING;
12321 char_u *xp_arg = NULL;
12323 rettv->v_type = VAR_STRING;
12324 rettv->vval.v_string = NULL;
12326 #ifdef NO_CONSOLE_INPUT
12327 /* While starting up, there is no place to enter text. */
12328 if (no_console_input())
12329 return;
12330 #endif
12332 cmd_silent = FALSE; /* Want to see the prompt. */
12333 if (prompt != NULL)
12335 /* Only the part of the message after the last NL is considered as
12336 * prompt for the command line */
12337 p = vim_strrchr(prompt, '\n');
12338 if (p == NULL)
12339 p = prompt;
12340 else
12342 ++p;
12343 c = *p;
12344 *p = NUL;
12345 msg_start();
12346 msg_clr_eos();
12347 msg_puts_attr(prompt, echo_attr);
12348 msg_didout = FALSE;
12349 msg_starthere();
12350 *p = c;
12352 cmdline_row = msg_row;
12354 if (argvars[1].v_type != VAR_UNKNOWN)
12356 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12357 if (defstr != NULL)
12358 stuffReadbuffSpec(defstr);
12360 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12362 char_u *xp_name;
12363 int xp_namelen;
12364 long argt;
12366 rettv->vval.v_string = NULL;
12368 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12369 if (xp_name == NULL)
12370 return;
12372 xp_namelen = (int)STRLEN(xp_name);
12374 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12375 &xp_arg) == FAIL)
12376 return;
12380 if (defstr != NULL)
12381 rettv->vval.v_string =
12382 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12383 xp_type, xp_arg);
12385 vim_free(xp_arg);
12387 /* since the user typed this, no need to wait for return */
12388 need_wait_return = FALSE;
12389 msg_didout = FALSE;
12391 cmd_silent = cmd_silent_save;
12395 * "input()" function
12396 * Also handles inputsecret() when inputsecret is set.
12398 static void
12399 f_input(argvars, rettv)
12400 typval_T *argvars;
12401 typval_T *rettv;
12403 get_user_input(argvars, rettv, FALSE);
12407 * "inputdialog()" function
12409 static void
12410 f_inputdialog(argvars, rettv)
12411 typval_T *argvars;
12412 typval_T *rettv;
12414 #if defined(FEAT_GUI_TEXTDIALOG)
12415 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12416 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12418 char_u *message;
12419 char_u buf[NUMBUFLEN];
12420 char_u *defstr = (char_u *)"";
12422 message = get_tv_string_chk(&argvars[0]);
12423 if (argvars[1].v_type != VAR_UNKNOWN
12424 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12425 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12426 else
12427 IObuff[0] = NUL;
12428 if (message != NULL && defstr != NULL
12429 && do_dialog(VIM_QUESTION, NULL, message,
12430 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12431 rettv->vval.v_string = vim_strsave(IObuff);
12432 else
12434 if (message != NULL && defstr != NULL
12435 && argvars[1].v_type != VAR_UNKNOWN
12436 && argvars[2].v_type != VAR_UNKNOWN)
12437 rettv->vval.v_string = vim_strsave(
12438 get_tv_string_buf(&argvars[2], buf));
12439 else
12440 rettv->vval.v_string = NULL;
12442 rettv->v_type = VAR_STRING;
12444 else
12445 #endif
12446 get_user_input(argvars, rettv, TRUE);
12450 * "inputlist()" function
12452 static void
12453 f_inputlist(argvars, rettv)
12454 typval_T *argvars;
12455 typval_T *rettv;
12457 listitem_T *li;
12458 int selected;
12459 int mouse_used;
12461 #ifdef NO_CONSOLE_INPUT
12462 /* While starting up, there is no place to enter text. */
12463 if (no_console_input())
12464 return;
12465 #endif
12466 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12468 EMSG2(_(e_listarg), "inputlist()");
12469 return;
12472 msg_start();
12473 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12474 lines_left = Rows; /* avoid more prompt */
12475 msg_scroll = TRUE;
12476 msg_clr_eos();
12478 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12480 msg_puts(get_tv_string(&li->li_tv));
12481 msg_putchar('\n');
12484 /* Ask for choice. */
12485 selected = prompt_for_number(&mouse_used);
12486 if (mouse_used)
12487 selected -= lines_left;
12489 rettv->vval.v_number = selected;
12493 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12496 * "inputrestore()" function
12498 static void
12499 f_inputrestore(argvars, rettv)
12500 typval_T *argvars UNUSED;
12501 typval_T *rettv;
12503 if (ga_userinput.ga_len > 0)
12505 --ga_userinput.ga_len;
12506 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12507 + ga_userinput.ga_len);
12508 /* default return is zero == OK */
12510 else if (p_verbose > 1)
12512 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12513 rettv->vval.v_number = 1; /* Failed */
12518 * "inputsave()" function
12520 static void
12521 f_inputsave(argvars, rettv)
12522 typval_T *argvars UNUSED;
12523 typval_T *rettv;
12525 /* Add an entry to the stack of typeahead storage. */
12526 if (ga_grow(&ga_userinput, 1) == OK)
12528 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12529 + ga_userinput.ga_len);
12530 ++ga_userinput.ga_len;
12531 /* default return is zero == OK */
12533 else
12534 rettv->vval.v_number = 1; /* Failed */
12538 * "inputsecret()" function
12540 static void
12541 f_inputsecret(argvars, rettv)
12542 typval_T *argvars;
12543 typval_T *rettv;
12545 ++cmdline_star;
12546 ++inputsecret_flag;
12547 f_input(argvars, rettv);
12548 --cmdline_star;
12549 --inputsecret_flag;
12553 * "insert()" function
12555 static void
12556 f_insert(argvars, rettv)
12557 typval_T *argvars;
12558 typval_T *rettv;
12560 long before = 0;
12561 listitem_T *item;
12562 list_T *l;
12563 int error = FALSE;
12565 if (argvars[0].v_type != VAR_LIST)
12566 EMSG2(_(e_listarg), "insert()");
12567 else if ((l = argvars[0].vval.v_list) != NULL
12568 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12570 if (argvars[2].v_type != VAR_UNKNOWN)
12571 before = get_tv_number_chk(&argvars[2], &error);
12572 if (error)
12573 return; /* type error; errmsg already given */
12575 if (before == l->lv_len)
12576 item = NULL;
12577 else
12579 item = list_find(l, before);
12580 if (item == NULL)
12582 EMSGN(_(e_listidx), before);
12583 l = NULL;
12586 if (l != NULL)
12588 list_insert_tv(l, &argvars[1], item);
12589 copy_tv(&argvars[0], rettv);
12595 * "isdirectory()" function
12597 static void
12598 f_isdirectory(argvars, rettv)
12599 typval_T *argvars;
12600 typval_T *rettv;
12602 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12606 * "islocked()" function
12608 static void
12609 f_islocked(argvars, rettv)
12610 typval_T *argvars;
12611 typval_T *rettv;
12613 lval_T lv;
12614 char_u *end;
12615 dictitem_T *di;
12617 rettv->vval.v_number = -1;
12618 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12619 FNE_CHECK_START);
12620 if (end != NULL && lv.ll_name != NULL)
12622 if (*end != NUL)
12623 EMSG(_(e_trailing));
12624 else
12626 if (lv.ll_tv == NULL)
12628 if (check_changedtick(lv.ll_name))
12629 rettv->vval.v_number = 1; /* always locked */
12630 else
12632 di = find_var(lv.ll_name, NULL);
12633 if (di != NULL)
12635 /* Consider a variable locked when:
12636 * 1. the variable itself is locked
12637 * 2. the value of the variable is locked.
12638 * 3. the List or Dict value is locked.
12640 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12641 || tv_islocked(&di->di_tv));
12645 else if (lv.ll_range)
12646 EMSG(_("E786: Range not allowed"));
12647 else if (lv.ll_newkey != NULL)
12648 EMSG2(_(e_dictkey), lv.ll_newkey);
12649 else if (lv.ll_list != NULL)
12650 /* List item. */
12651 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12652 else
12653 /* Dictionary item. */
12654 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12658 clear_lval(&lv);
12661 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12664 * Turn a dict into a list:
12665 * "what" == 0: list of keys
12666 * "what" == 1: list of values
12667 * "what" == 2: list of items
12669 static void
12670 dict_list(argvars, rettv, what)
12671 typval_T *argvars;
12672 typval_T *rettv;
12673 int what;
12675 list_T *l2;
12676 dictitem_T *di;
12677 hashitem_T *hi;
12678 listitem_T *li;
12679 listitem_T *li2;
12680 dict_T *d;
12681 int todo;
12683 if (argvars[0].v_type != VAR_DICT)
12685 EMSG(_(e_dictreq));
12686 return;
12688 if ((d = argvars[0].vval.v_dict) == NULL)
12689 return;
12691 if (rettv_list_alloc(rettv) == FAIL)
12692 return;
12694 todo = (int)d->dv_hashtab.ht_used;
12695 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12697 if (!HASHITEM_EMPTY(hi))
12699 --todo;
12700 di = HI2DI(hi);
12702 li = listitem_alloc();
12703 if (li == NULL)
12704 break;
12705 list_append(rettv->vval.v_list, li);
12707 if (what == 0)
12709 /* keys() */
12710 li->li_tv.v_type = VAR_STRING;
12711 li->li_tv.v_lock = 0;
12712 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12714 else if (what == 1)
12716 /* values() */
12717 copy_tv(&di->di_tv, &li->li_tv);
12719 else
12721 /* items() */
12722 l2 = list_alloc();
12723 li->li_tv.v_type = VAR_LIST;
12724 li->li_tv.v_lock = 0;
12725 li->li_tv.vval.v_list = l2;
12726 if (l2 == NULL)
12727 break;
12728 ++l2->lv_refcount;
12730 li2 = listitem_alloc();
12731 if (li2 == NULL)
12732 break;
12733 list_append(l2, li2);
12734 li2->li_tv.v_type = VAR_STRING;
12735 li2->li_tv.v_lock = 0;
12736 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12738 li2 = listitem_alloc();
12739 if (li2 == NULL)
12740 break;
12741 list_append(l2, li2);
12742 copy_tv(&di->di_tv, &li2->li_tv);
12749 * "items(dict)" function
12751 static void
12752 f_items(argvars, rettv)
12753 typval_T *argvars;
12754 typval_T *rettv;
12756 dict_list(argvars, rettv, 2);
12760 * "join()" function
12762 static void
12763 f_join(argvars, rettv)
12764 typval_T *argvars;
12765 typval_T *rettv;
12767 garray_T ga;
12768 char_u *sep;
12770 if (argvars[0].v_type != VAR_LIST)
12772 EMSG(_(e_listreq));
12773 return;
12775 if (argvars[0].vval.v_list == NULL)
12776 return;
12777 if (argvars[1].v_type == VAR_UNKNOWN)
12778 sep = (char_u *)" ";
12779 else
12780 sep = get_tv_string_chk(&argvars[1]);
12782 rettv->v_type = VAR_STRING;
12784 if (sep != NULL)
12786 ga_init2(&ga, (int)sizeof(char), 80);
12787 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12788 ga_append(&ga, NUL);
12789 rettv->vval.v_string = (char_u *)ga.ga_data;
12791 else
12792 rettv->vval.v_string = NULL;
12796 * "keys()" function
12798 static void
12799 f_keys(argvars, rettv)
12800 typval_T *argvars;
12801 typval_T *rettv;
12803 dict_list(argvars, rettv, 0);
12807 * "last_buffer_nr()" function.
12809 static void
12810 f_last_buffer_nr(argvars, rettv)
12811 typval_T *argvars UNUSED;
12812 typval_T *rettv;
12814 int n = 0;
12815 buf_T *buf;
12817 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12818 if (n < buf->b_fnum)
12819 n = buf->b_fnum;
12821 rettv->vval.v_number = n;
12825 * "len()" function
12827 static void
12828 f_len(argvars, rettv)
12829 typval_T *argvars;
12830 typval_T *rettv;
12832 switch (argvars[0].v_type)
12834 case VAR_STRING:
12835 case VAR_NUMBER:
12836 rettv->vval.v_number = (varnumber_T)STRLEN(
12837 get_tv_string(&argvars[0]));
12838 break;
12839 case VAR_LIST:
12840 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12841 break;
12842 case VAR_DICT:
12843 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12844 break;
12845 default:
12846 EMSG(_("E701: Invalid type for len()"));
12847 break;
12851 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12853 static void
12854 libcall_common(argvars, rettv, type)
12855 typval_T *argvars;
12856 typval_T *rettv;
12857 int type;
12859 #ifdef FEAT_LIBCALL
12860 char_u *string_in;
12861 char_u **string_result;
12862 int nr_result;
12863 #endif
12865 rettv->v_type = type;
12866 if (type != VAR_NUMBER)
12867 rettv->vval.v_string = NULL;
12869 if (check_restricted() || check_secure())
12870 return;
12872 #ifdef FEAT_LIBCALL
12873 /* The first two args must be strings, otherwise its meaningless */
12874 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12876 string_in = NULL;
12877 if (argvars[2].v_type == VAR_STRING)
12878 string_in = argvars[2].vval.v_string;
12879 if (type == VAR_NUMBER)
12880 string_result = NULL;
12881 else
12882 string_result = &rettv->vval.v_string;
12883 if (mch_libcall(argvars[0].vval.v_string,
12884 argvars[1].vval.v_string,
12885 string_in,
12886 argvars[2].vval.v_number,
12887 string_result,
12888 &nr_result) == OK
12889 && type == VAR_NUMBER)
12890 rettv->vval.v_number = nr_result;
12892 #endif
12896 * "libcall()" function
12898 static void
12899 f_libcall(argvars, rettv)
12900 typval_T *argvars;
12901 typval_T *rettv;
12903 libcall_common(argvars, rettv, VAR_STRING);
12907 * "libcallnr()" function
12909 static void
12910 f_libcallnr(argvars, rettv)
12911 typval_T *argvars;
12912 typval_T *rettv;
12914 libcall_common(argvars, rettv, VAR_NUMBER);
12918 * "line(string)" function
12920 static void
12921 f_line(argvars, rettv)
12922 typval_T *argvars;
12923 typval_T *rettv;
12925 linenr_T lnum = 0;
12926 pos_T *fp;
12927 int fnum;
12929 fp = var2fpos(&argvars[0], TRUE, &fnum);
12930 if (fp != NULL)
12931 lnum = fp->lnum;
12932 rettv->vval.v_number = lnum;
12936 * "line2byte(lnum)" function
12938 static void
12939 f_line2byte(argvars, rettv)
12940 typval_T *argvars UNUSED;
12941 typval_T *rettv;
12943 #ifndef FEAT_BYTEOFF
12944 rettv->vval.v_number = -1;
12945 #else
12946 linenr_T lnum;
12948 lnum = get_tv_lnum(argvars);
12949 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12950 rettv->vval.v_number = -1;
12951 else
12952 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12953 if (rettv->vval.v_number >= 0)
12954 ++rettv->vval.v_number;
12955 #endif
12959 * "lispindent(lnum)" function
12961 static void
12962 f_lispindent(argvars, rettv)
12963 typval_T *argvars;
12964 typval_T *rettv;
12966 #ifdef FEAT_LISP
12967 pos_T pos;
12968 linenr_T lnum;
12970 pos = curwin->w_cursor;
12971 lnum = get_tv_lnum(argvars);
12972 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12974 curwin->w_cursor.lnum = lnum;
12975 rettv->vval.v_number = get_lisp_indent();
12976 curwin->w_cursor = pos;
12978 else
12979 #endif
12980 rettv->vval.v_number = -1;
12984 * "localtime()" function
12986 static void
12987 f_localtime(argvars, rettv)
12988 typval_T *argvars UNUSED;
12989 typval_T *rettv;
12991 rettv->vval.v_number = (varnumber_T)time(NULL);
12994 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12996 static void
12997 get_maparg(argvars, rettv, exact)
12998 typval_T *argvars;
12999 typval_T *rettv;
13000 int exact;
13002 char_u *keys;
13003 char_u *which;
13004 char_u buf[NUMBUFLEN];
13005 char_u *keys_buf = NULL;
13006 char_u *rhs;
13007 int mode;
13008 garray_T ga;
13009 int abbr = FALSE;
13011 /* return empty string for failure */
13012 rettv->v_type = VAR_STRING;
13013 rettv->vval.v_string = NULL;
13015 keys = get_tv_string(&argvars[0]);
13016 if (*keys == NUL)
13017 return;
13019 if (argvars[1].v_type != VAR_UNKNOWN)
13021 which = get_tv_string_buf_chk(&argvars[1], buf);
13022 if (argvars[2].v_type != VAR_UNKNOWN)
13023 abbr = get_tv_number(&argvars[2]);
13025 else
13026 which = (char_u *)"";
13027 if (which == NULL)
13028 return;
13030 mode = get_map_mode(&which, 0);
13032 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
13033 rhs = check_map(keys, mode, exact, FALSE, abbr);
13034 vim_free(keys_buf);
13035 if (rhs != NULL)
13037 ga_init(&ga);
13038 ga.ga_itemsize = 1;
13039 ga.ga_growsize = 40;
13041 while (*rhs != NUL)
13042 ga_concat(&ga, str2special(&rhs, FALSE));
13044 ga_append(&ga, NUL);
13045 rettv->vval.v_string = (char_u *)ga.ga_data;
13049 #ifdef FEAT_FLOAT
13051 * "log10()" function
13053 static void
13054 f_log10(argvars, rettv)
13055 typval_T *argvars;
13056 typval_T *rettv;
13058 float_T f;
13060 rettv->v_type = VAR_FLOAT;
13061 if (get_float_arg(argvars, &f) == OK)
13062 rettv->vval.v_float = log10(f);
13063 else
13064 rettv->vval.v_float = 0.0;
13066 #endif
13069 * "map()" function
13071 static void
13072 f_map(argvars, rettv)
13073 typval_T *argvars;
13074 typval_T *rettv;
13076 filter_map(argvars, rettv, TRUE);
13080 * "maparg()" function
13082 static void
13083 f_maparg(argvars, rettv)
13084 typval_T *argvars;
13085 typval_T *rettv;
13087 get_maparg(argvars, rettv, TRUE);
13091 * "mapcheck()" function
13093 static void
13094 f_mapcheck(argvars, rettv)
13095 typval_T *argvars;
13096 typval_T *rettv;
13098 get_maparg(argvars, rettv, FALSE);
13101 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13103 static void
13104 find_some_match(argvars, rettv, type)
13105 typval_T *argvars;
13106 typval_T *rettv;
13107 int type;
13109 char_u *str = NULL;
13110 char_u *expr = NULL;
13111 char_u *pat;
13112 regmatch_T regmatch;
13113 char_u patbuf[NUMBUFLEN];
13114 char_u strbuf[NUMBUFLEN];
13115 char_u *save_cpo;
13116 long start = 0;
13117 long nth = 1;
13118 colnr_T startcol = 0;
13119 int match = 0;
13120 list_T *l = NULL;
13121 listitem_T *li = NULL;
13122 long idx = 0;
13123 char_u *tofree = NULL;
13125 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13126 save_cpo = p_cpo;
13127 p_cpo = (char_u *)"";
13129 rettv->vval.v_number = -1;
13130 if (type == 3)
13132 /* return empty list when there are no matches */
13133 if (rettv_list_alloc(rettv) == FAIL)
13134 goto theend;
13136 else if (type == 2)
13138 rettv->v_type = VAR_STRING;
13139 rettv->vval.v_string = NULL;
13142 if (argvars[0].v_type == VAR_LIST)
13144 if ((l = argvars[0].vval.v_list) == NULL)
13145 goto theend;
13146 li = l->lv_first;
13148 else
13149 expr = str = get_tv_string(&argvars[0]);
13151 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13152 if (pat == NULL)
13153 goto theend;
13155 if (argvars[2].v_type != VAR_UNKNOWN)
13157 int error = FALSE;
13159 start = get_tv_number_chk(&argvars[2], &error);
13160 if (error)
13161 goto theend;
13162 if (l != NULL)
13164 li = list_find(l, start);
13165 if (li == NULL)
13166 goto theend;
13167 idx = l->lv_idx; /* use the cached index */
13169 else
13171 if (start < 0)
13172 start = 0;
13173 if (start > (long)STRLEN(str))
13174 goto theend;
13175 /* When "count" argument is there ignore matches before "start",
13176 * otherwise skip part of the string. Differs when pattern is "^"
13177 * or "\<". */
13178 if (argvars[3].v_type != VAR_UNKNOWN)
13179 startcol = start;
13180 else
13181 str += start;
13184 if (argvars[3].v_type != VAR_UNKNOWN)
13185 nth = get_tv_number_chk(&argvars[3], &error);
13186 if (error)
13187 goto theend;
13190 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13191 if (regmatch.regprog != NULL)
13193 regmatch.rm_ic = p_ic;
13195 for (;;)
13197 if (l != NULL)
13199 if (li == NULL)
13201 match = FALSE;
13202 break;
13204 vim_free(tofree);
13205 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13206 if (str == NULL)
13207 break;
13210 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13212 if (match && --nth <= 0)
13213 break;
13214 if (l == NULL && !match)
13215 break;
13217 /* Advance to just after the match. */
13218 if (l != NULL)
13220 li = li->li_next;
13221 ++idx;
13223 else
13225 #ifdef FEAT_MBYTE
13226 startcol = (colnr_T)(regmatch.startp[0]
13227 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13228 #else
13229 startcol = regmatch.startp[0] + 1 - str;
13230 #endif
13234 if (match)
13236 if (type == 3)
13238 int i;
13240 /* return list with matched string and submatches */
13241 for (i = 0; i < NSUBEXP; ++i)
13243 if (regmatch.endp[i] == NULL)
13245 if (list_append_string(rettv->vval.v_list,
13246 (char_u *)"", 0) == FAIL)
13247 break;
13249 else if (list_append_string(rettv->vval.v_list,
13250 regmatch.startp[i],
13251 (int)(regmatch.endp[i] - regmatch.startp[i]))
13252 == FAIL)
13253 break;
13256 else if (type == 2)
13258 /* return matched string */
13259 if (l != NULL)
13260 copy_tv(&li->li_tv, rettv);
13261 else
13262 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13263 (int)(regmatch.endp[0] - regmatch.startp[0]));
13265 else if (l != NULL)
13266 rettv->vval.v_number = idx;
13267 else
13269 if (type != 0)
13270 rettv->vval.v_number =
13271 (varnumber_T)(regmatch.startp[0] - str);
13272 else
13273 rettv->vval.v_number =
13274 (varnumber_T)(regmatch.endp[0] - str);
13275 rettv->vval.v_number += (varnumber_T)(str - expr);
13278 vim_free(regmatch.regprog);
13281 theend:
13282 vim_free(tofree);
13283 p_cpo = save_cpo;
13287 * "match()" function
13289 static void
13290 f_match(argvars, rettv)
13291 typval_T *argvars;
13292 typval_T *rettv;
13294 find_some_match(argvars, rettv, 1);
13298 * "matchadd()" function
13300 static void
13301 f_matchadd(argvars, rettv)
13302 typval_T *argvars;
13303 typval_T *rettv;
13305 #ifdef FEAT_SEARCH_EXTRA
13306 char_u buf[NUMBUFLEN];
13307 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13308 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13309 int prio = 10; /* default priority */
13310 int id = -1;
13311 int error = FALSE;
13313 rettv->vval.v_number = -1;
13315 if (grp == NULL || pat == NULL)
13316 return;
13317 if (argvars[2].v_type != VAR_UNKNOWN)
13319 prio = get_tv_number_chk(&argvars[2], &error);
13320 if (argvars[3].v_type != VAR_UNKNOWN)
13321 id = get_tv_number_chk(&argvars[3], &error);
13323 if (error == TRUE)
13324 return;
13325 if (id >= 1 && id <= 3)
13327 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13328 return;
13331 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13332 #endif
13336 * "matcharg()" function
13338 static void
13339 f_matcharg(argvars, rettv)
13340 typval_T *argvars;
13341 typval_T *rettv;
13343 if (rettv_list_alloc(rettv) == OK)
13345 #ifdef FEAT_SEARCH_EXTRA
13346 int id = get_tv_number(&argvars[0]);
13347 matchitem_T *m;
13349 if (id >= 1 && id <= 3)
13351 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13353 list_append_string(rettv->vval.v_list,
13354 syn_id2name(m->hlg_id), -1);
13355 list_append_string(rettv->vval.v_list, m->pattern, -1);
13357 else
13359 list_append_string(rettv->vval.v_list, NUL, -1);
13360 list_append_string(rettv->vval.v_list, NUL, -1);
13363 #endif
13368 * "matchdelete()" function
13370 static void
13371 f_matchdelete(argvars, rettv)
13372 typval_T *argvars;
13373 typval_T *rettv;
13375 #ifdef FEAT_SEARCH_EXTRA
13376 rettv->vval.v_number = match_delete(curwin,
13377 (int)get_tv_number(&argvars[0]), TRUE);
13378 #endif
13382 * "matchend()" function
13384 static void
13385 f_matchend(argvars, rettv)
13386 typval_T *argvars;
13387 typval_T *rettv;
13389 find_some_match(argvars, rettv, 0);
13393 * "matchlist()" function
13395 static void
13396 f_matchlist(argvars, rettv)
13397 typval_T *argvars;
13398 typval_T *rettv;
13400 find_some_match(argvars, rettv, 3);
13404 * "matchstr()" function
13406 static void
13407 f_matchstr(argvars, rettv)
13408 typval_T *argvars;
13409 typval_T *rettv;
13411 find_some_match(argvars, rettv, 2);
13414 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13416 static void
13417 max_min(argvars, rettv, domax)
13418 typval_T *argvars;
13419 typval_T *rettv;
13420 int domax;
13422 long n = 0;
13423 long i;
13424 int error = FALSE;
13426 if (argvars[0].v_type == VAR_LIST)
13428 list_T *l;
13429 listitem_T *li;
13431 l = argvars[0].vval.v_list;
13432 if (l != NULL)
13434 li = l->lv_first;
13435 if (li != NULL)
13437 n = get_tv_number_chk(&li->li_tv, &error);
13438 for (;;)
13440 li = li->li_next;
13441 if (li == NULL)
13442 break;
13443 i = get_tv_number_chk(&li->li_tv, &error);
13444 if (domax ? i > n : i < n)
13445 n = i;
13450 else if (argvars[0].v_type == VAR_DICT)
13452 dict_T *d;
13453 int first = TRUE;
13454 hashitem_T *hi;
13455 int todo;
13457 d = argvars[0].vval.v_dict;
13458 if (d != NULL)
13460 todo = (int)d->dv_hashtab.ht_used;
13461 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13463 if (!HASHITEM_EMPTY(hi))
13465 --todo;
13466 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13467 if (first)
13469 n = i;
13470 first = FALSE;
13472 else if (domax ? i > n : i < n)
13473 n = i;
13478 else
13479 EMSG(_(e_listdictarg));
13480 rettv->vval.v_number = error ? 0 : n;
13484 * "max()" function
13486 static void
13487 f_max(argvars, rettv)
13488 typval_T *argvars;
13489 typval_T *rettv;
13491 max_min(argvars, rettv, TRUE);
13495 * "min()" function
13497 static void
13498 f_min(argvars, rettv)
13499 typval_T *argvars;
13500 typval_T *rettv;
13502 max_min(argvars, rettv, FALSE);
13505 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13508 * Create the directory in which "dir" is located, and higher levels when
13509 * needed.
13511 static int
13512 mkdir_recurse(dir, prot)
13513 char_u *dir;
13514 int prot;
13516 char_u *p;
13517 char_u *updir;
13518 int r = FAIL;
13520 /* Get end of directory name in "dir".
13521 * We're done when it's "/" or "c:/". */
13522 p = gettail_sep(dir);
13523 if (p <= get_past_head(dir))
13524 return OK;
13526 /* If the directory exists we're done. Otherwise: create it.*/
13527 updir = vim_strnsave(dir, (int)(p - dir));
13528 if (updir == NULL)
13529 return FAIL;
13530 if (mch_isdir(updir))
13531 r = OK;
13532 else if (mkdir_recurse(updir, prot) == OK)
13533 r = vim_mkdir_emsg(updir, prot);
13534 vim_free(updir);
13535 return r;
13538 #ifdef vim_mkdir
13540 * "mkdir()" function
13542 static void
13543 f_mkdir(argvars, rettv)
13544 typval_T *argvars;
13545 typval_T *rettv;
13547 char_u *dir;
13548 char_u buf[NUMBUFLEN];
13549 int prot = 0755;
13551 rettv->vval.v_number = FAIL;
13552 if (check_restricted() || check_secure())
13553 return;
13555 dir = get_tv_string_buf(&argvars[0], buf);
13556 if (argvars[1].v_type != VAR_UNKNOWN)
13558 if (argvars[2].v_type != VAR_UNKNOWN)
13559 prot = get_tv_number_chk(&argvars[2], NULL);
13560 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13561 mkdir_recurse(dir, prot);
13563 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13565 #endif
13568 * "mode()" function
13570 static void
13571 f_mode(argvars, rettv)
13572 typval_T *argvars;
13573 typval_T *rettv;
13575 char_u buf[3];
13577 buf[1] = NUL;
13578 buf[2] = NUL;
13580 #ifdef FEAT_VISUAL
13581 if (VIsual_active)
13583 if (VIsual_select)
13584 buf[0] = VIsual_mode + 's' - 'v';
13585 else
13586 buf[0] = VIsual_mode;
13588 else
13589 #endif
13590 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13591 || State == CONFIRM)
13593 buf[0] = 'r';
13594 if (State == ASKMORE)
13595 buf[1] = 'm';
13596 else if (State == CONFIRM)
13597 buf[1] = '?';
13599 else if (State == EXTERNCMD)
13600 buf[0] = '!';
13601 else if (State & INSERT)
13603 #ifdef FEAT_VREPLACE
13604 if (State & VREPLACE_FLAG)
13606 buf[0] = 'R';
13607 buf[1] = 'v';
13609 else
13610 #endif
13611 if (State & REPLACE_FLAG)
13612 buf[0] = 'R';
13613 else
13614 buf[0] = 'i';
13616 else if (State & CMDLINE)
13618 buf[0] = 'c';
13619 if (exmode_active)
13620 buf[1] = 'v';
13622 else if (exmode_active)
13624 buf[0] = 'c';
13625 buf[1] = 'e';
13627 else
13629 buf[0] = 'n';
13630 if (finish_op)
13631 buf[1] = 'o';
13634 /* Clear out the minor mode when the argument is not a non-zero number or
13635 * non-empty string. */
13636 if (!non_zero_arg(&argvars[0]))
13637 buf[1] = NUL;
13639 rettv->vval.v_string = vim_strsave(buf);
13640 rettv->v_type = VAR_STRING;
13643 #ifdef FEAT_MZSCHEME
13645 * "mzeval()" function
13647 static void
13648 f_mzeval(argvars, rettv)
13649 typval_T *argvars;
13650 typval_T *rettv;
13652 char_u *str;
13653 char_u buf[NUMBUFLEN];
13655 str = get_tv_string_buf(&argvars[0], buf);
13656 do_mzeval(str, rettv);
13658 #endif
13661 * "nextnonblank()" function
13663 static void
13664 f_nextnonblank(argvars, rettv)
13665 typval_T *argvars;
13666 typval_T *rettv;
13668 linenr_T lnum;
13670 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13672 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13674 lnum = 0;
13675 break;
13677 if (*skipwhite(ml_get(lnum)) != NUL)
13678 break;
13680 rettv->vval.v_number = lnum;
13684 * "nr2char()" function
13686 static void
13687 f_nr2char(argvars, rettv)
13688 typval_T *argvars;
13689 typval_T *rettv;
13691 char_u buf[NUMBUFLEN];
13693 #ifdef FEAT_MBYTE
13694 if (has_mbyte)
13695 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13696 else
13697 #endif
13699 buf[0] = (char_u)get_tv_number(&argvars[0]);
13700 buf[1] = NUL;
13702 rettv->v_type = VAR_STRING;
13703 rettv->vval.v_string = vim_strsave(buf);
13707 * "pathshorten()" function
13709 static void
13710 f_pathshorten(argvars, rettv)
13711 typval_T *argvars;
13712 typval_T *rettv;
13714 char_u *p;
13716 rettv->v_type = VAR_STRING;
13717 p = get_tv_string_chk(&argvars[0]);
13718 if (p == NULL)
13719 rettv->vval.v_string = NULL;
13720 else
13722 p = vim_strsave(p);
13723 rettv->vval.v_string = p;
13724 if (p != NULL)
13725 shorten_dir(p);
13729 #ifdef FEAT_FLOAT
13731 * "pow()" function
13733 static void
13734 f_pow(argvars, rettv)
13735 typval_T *argvars;
13736 typval_T *rettv;
13738 float_T fx, fy;
13740 rettv->v_type = VAR_FLOAT;
13741 if (get_float_arg(argvars, &fx) == OK
13742 && get_float_arg(&argvars[1], &fy) == OK)
13743 rettv->vval.v_float = pow(fx, fy);
13744 else
13745 rettv->vval.v_float = 0.0;
13747 #endif
13750 * "prevnonblank()" function
13752 static void
13753 f_prevnonblank(argvars, rettv)
13754 typval_T *argvars;
13755 typval_T *rettv;
13757 linenr_T lnum;
13759 lnum = get_tv_lnum(argvars);
13760 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13761 lnum = 0;
13762 else
13763 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13764 --lnum;
13765 rettv->vval.v_number = lnum;
13768 #ifdef HAVE_STDARG_H
13769 /* This dummy va_list is here because:
13770 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13771 * - locally in the function results in a "used before set" warning
13772 * - using va_start() to initialize it gives "function with fixed args" error */
13773 static va_list ap;
13774 #endif
13777 * "printf()" function
13779 static void
13780 f_printf(argvars, rettv)
13781 typval_T *argvars;
13782 typval_T *rettv;
13784 rettv->v_type = VAR_STRING;
13785 rettv->vval.v_string = NULL;
13786 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13788 char_u buf[NUMBUFLEN];
13789 int len;
13790 char_u *s;
13791 int saved_did_emsg = did_emsg;
13792 char *fmt;
13794 /* Get the required length, allocate the buffer and do it for real. */
13795 did_emsg = FALSE;
13796 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13797 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13798 if (!did_emsg)
13800 s = alloc(len + 1);
13801 if (s != NULL)
13803 rettv->vval.v_string = s;
13804 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13807 did_emsg |= saved_did_emsg;
13809 #endif
13813 * "pumvisible()" function
13815 static void
13816 f_pumvisible(argvars, rettv)
13817 typval_T *argvars UNUSED;
13818 typval_T *rettv UNUSED;
13820 #ifdef FEAT_INS_EXPAND
13821 if (pum_visible())
13822 rettv->vval.v_number = 1;
13823 #endif
13827 * "range()" function
13829 static void
13830 f_range(argvars, rettv)
13831 typval_T *argvars;
13832 typval_T *rettv;
13834 long start;
13835 long end;
13836 long stride = 1;
13837 long i;
13838 int error = FALSE;
13840 start = get_tv_number_chk(&argvars[0], &error);
13841 if (argvars[1].v_type == VAR_UNKNOWN)
13843 end = start - 1;
13844 start = 0;
13846 else
13848 end = get_tv_number_chk(&argvars[1], &error);
13849 if (argvars[2].v_type != VAR_UNKNOWN)
13850 stride = get_tv_number_chk(&argvars[2], &error);
13853 if (error)
13854 return; /* type error; errmsg already given */
13855 if (stride == 0)
13856 EMSG(_("E726: Stride is zero"));
13857 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13858 EMSG(_("E727: Start past end"));
13859 else
13861 if (rettv_list_alloc(rettv) == OK)
13862 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13863 if (list_append_number(rettv->vval.v_list,
13864 (varnumber_T)i) == FAIL)
13865 break;
13870 * "readfile()" function
13872 static void
13873 f_readfile(argvars, rettv)
13874 typval_T *argvars;
13875 typval_T *rettv;
13877 int binary = FALSE;
13878 char_u *fname;
13879 FILE *fd;
13880 listitem_T *li;
13881 #define FREAD_SIZE 200 /* optimized for text lines */
13882 char_u buf[FREAD_SIZE];
13883 int readlen; /* size of last fread() */
13884 int buflen; /* nr of valid chars in buf[] */
13885 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13886 int tolist; /* first byte in buf[] still to be put in list */
13887 int chop; /* how many CR to chop off */
13888 char_u *prev = NULL; /* previously read bytes, if any */
13889 int prevlen = 0; /* length of "prev" if not NULL */
13890 char_u *s;
13891 int len;
13892 long maxline = MAXLNUM;
13893 long cnt = 0;
13895 if (argvars[1].v_type != VAR_UNKNOWN)
13897 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13898 binary = TRUE;
13899 if (argvars[2].v_type != VAR_UNKNOWN)
13900 maxline = get_tv_number(&argvars[2]);
13903 if (rettv_list_alloc(rettv) == FAIL)
13904 return;
13906 /* Always open the file in binary mode, library functions have a mind of
13907 * their own about CR-LF conversion. */
13908 fname = get_tv_string(&argvars[0]);
13909 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13911 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13912 return;
13915 filtd = 0;
13916 while (cnt < maxline || maxline < 0)
13918 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13919 buflen = filtd + readlen;
13920 tolist = 0;
13921 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13923 if (buf[filtd] == '\n' || readlen <= 0)
13925 /* Only when in binary mode add an empty list item when the
13926 * last line ends in a '\n'. */
13927 if (!binary && readlen == 0 && filtd == 0)
13928 break;
13930 /* Found end-of-line or end-of-file: add a text line to the
13931 * list. */
13932 chop = 0;
13933 if (!binary)
13934 while (filtd - chop - 1 >= tolist
13935 && buf[filtd - chop - 1] == '\r')
13936 ++chop;
13937 len = filtd - tolist - chop;
13938 if (prev == NULL)
13939 s = vim_strnsave(buf + tolist, len);
13940 else
13942 s = alloc((unsigned)(prevlen + len + 1));
13943 if (s != NULL)
13945 mch_memmove(s, prev, prevlen);
13946 vim_free(prev);
13947 prev = NULL;
13948 mch_memmove(s + prevlen, buf + tolist, len);
13949 s[prevlen + len] = NUL;
13952 tolist = filtd + 1;
13954 li = listitem_alloc();
13955 if (li == NULL)
13957 vim_free(s);
13958 break;
13960 li->li_tv.v_type = VAR_STRING;
13961 li->li_tv.v_lock = 0;
13962 li->li_tv.vval.v_string = s;
13963 list_append(rettv->vval.v_list, li);
13965 if (++cnt >= maxline && maxline >= 0)
13966 break;
13967 if (readlen <= 0)
13968 break;
13970 else if (buf[filtd] == NUL)
13971 buf[filtd] = '\n';
13973 if (readlen <= 0)
13974 break;
13976 if (tolist == 0)
13978 /* "buf" is full, need to move text to an allocated buffer */
13979 if (prev == NULL)
13981 prev = vim_strnsave(buf, buflen);
13982 prevlen = buflen;
13984 else
13986 s = alloc((unsigned)(prevlen + buflen));
13987 if (s != NULL)
13989 mch_memmove(s, prev, prevlen);
13990 mch_memmove(s + prevlen, buf, buflen);
13991 vim_free(prev);
13992 prev = s;
13993 prevlen += buflen;
13996 filtd = 0;
13998 else
14000 mch_memmove(buf, buf + tolist, buflen - tolist);
14001 filtd -= tolist;
14006 * For a negative line count use only the lines at the end of the file,
14007 * free the rest.
14009 if (maxline < 0)
14010 while (cnt > -maxline)
14012 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
14013 --cnt;
14016 vim_free(prev);
14017 fclose(fd);
14020 #if defined(FEAT_RELTIME)
14021 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
14024 * Convert a List to proftime_T.
14025 * Return FAIL when there is something wrong.
14027 static int
14028 list2proftime(arg, tm)
14029 typval_T *arg;
14030 proftime_T *tm;
14032 long n1, n2;
14033 int error = FALSE;
14035 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
14036 || arg->vval.v_list->lv_len != 2)
14037 return FAIL;
14038 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
14039 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
14040 # ifdef WIN3264
14041 tm->HighPart = n1;
14042 tm->LowPart = n2;
14043 # else
14044 tm->tv_sec = n1;
14045 tm->tv_usec = n2;
14046 # endif
14047 return error ? FAIL : OK;
14049 #endif /* FEAT_RELTIME */
14052 * "reltime()" function
14054 static void
14055 f_reltime(argvars, rettv)
14056 typval_T *argvars;
14057 typval_T *rettv;
14059 #ifdef FEAT_RELTIME
14060 proftime_T res;
14061 proftime_T start;
14063 if (argvars[0].v_type == VAR_UNKNOWN)
14065 /* No arguments: get current time. */
14066 profile_start(&res);
14068 else if (argvars[1].v_type == VAR_UNKNOWN)
14070 if (list2proftime(&argvars[0], &res) == FAIL)
14071 return;
14072 profile_end(&res);
14074 else
14076 /* Two arguments: compute the difference. */
14077 if (list2proftime(&argvars[0], &start) == FAIL
14078 || list2proftime(&argvars[1], &res) == FAIL)
14079 return;
14080 profile_sub(&res, &start);
14083 if (rettv_list_alloc(rettv) == OK)
14085 long n1, n2;
14087 # ifdef WIN3264
14088 n1 = res.HighPart;
14089 n2 = res.LowPart;
14090 # else
14091 n1 = res.tv_sec;
14092 n2 = res.tv_usec;
14093 # endif
14094 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14095 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14097 #endif
14101 * "reltimestr()" function
14103 static void
14104 f_reltimestr(argvars, rettv)
14105 typval_T *argvars;
14106 typval_T *rettv;
14108 #ifdef FEAT_RELTIME
14109 proftime_T tm;
14110 #endif
14112 rettv->v_type = VAR_STRING;
14113 rettv->vval.v_string = NULL;
14114 #ifdef FEAT_RELTIME
14115 if (list2proftime(&argvars[0], &tm) == OK)
14116 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14117 #endif
14120 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14121 static void make_connection __ARGS((void));
14122 static int check_connection __ARGS((void));
14124 static void
14125 make_connection()
14127 if (X_DISPLAY == NULL
14128 # ifdef FEAT_GUI
14129 && !gui.in_use
14130 # endif
14133 x_force_connect = TRUE;
14134 setup_term_clip();
14135 x_force_connect = FALSE;
14139 static int
14140 check_connection()
14142 make_connection();
14143 if (X_DISPLAY == NULL)
14145 EMSG(_("E240: No connection to Vim server"));
14146 return FAIL;
14148 return OK;
14150 #endif
14152 #ifdef FEAT_CLIENTSERVER
14153 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14155 static void
14156 remote_common(argvars, rettv, expr)
14157 typval_T *argvars;
14158 typval_T *rettv;
14159 int expr;
14161 char_u *server_name;
14162 char_u *keys;
14163 char_u *r = NULL;
14164 char_u buf[NUMBUFLEN];
14165 # ifdef WIN32
14166 HWND w;
14167 # else
14168 Window w;
14169 # endif
14171 if (check_restricted() || check_secure())
14172 return;
14174 # ifdef FEAT_X11
14175 if (check_connection() == FAIL)
14176 return;
14177 # endif
14179 server_name = get_tv_string_chk(&argvars[0]);
14180 if (server_name == NULL)
14181 return; /* type error; errmsg already given */
14182 keys = get_tv_string_buf(&argvars[1], buf);
14183 # ifdef WIN32
14184 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14185 # else
14186 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14187 < 0)
14188 # endif
14190 if (r != NULL)
14191 EMSG(r); /* sending worked but evaluation failed */
14192 else
14193 EMSG2(_("E241: Unable to send to %s"), server_name);
14194 return;
14197 rettv->vval.v_string = r;
14199 if (argvars[2].v_type != VAR_UNKNOWN)
14201 dictitem_T v;
14202 char_u str[30];
14203 char_u *idvar;
14205 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14206 v.di_tv.v_type = VAR_STRING;
14207 v.di_tv.vval.v_string = vim_strsave(str);
14208 idvar = get_tv_string_chk(&argvars[2]);
14209 if (idvar != NULL)
14210 set_var(idvar, &v.di_tv, FALSE);
14211 vim_free(v.di_tv.vval.v_string);
14214 #endif
14217 * "remote_expr()" function
14219 static void
14220 f_remote_expr(argvars, rettv)
14221 typval_T *argvars UNUSED;
14222 typval_T *rettv;
14224 rettv->v_type = VAR_STRING;
14225 rettv->vval.v_string = NULL;
14226 #ifdef FEAT_CLIENTSERVER
14227 remote_common(argvars, rettv, TRUE);
14228 #endif
14232 * "remote_foreground()" function
14234 static void
14235 f_remote_foreground(argvars, rettv)
14236 typval_T *argvars UNUSED;
14237 typval_T *rettv UNUSED;
14239 #ifdef FEAT_CLIENTSERVER
14240 # ifdef WIN32
14241 /* On Win32 it's done in this application. */
14243 char_u *server_name = get_tv_string_chk(&argvars[0]);
14245 if (server_name != NULL)
14246 serverForeground(server_name);
14248 # else
14249 /* Send a foreground() expression to the server. */
14250 argvars[1].v_type = VAR_STRING;
14251 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14252 argvars[2].v_type = VAR_UNKNOWN;
14253 remote_common(argvars, rettv, TRUE);
14254 vim_free(argvars[1].vval.v_string);
14255 # endif
14256 #endif
14259 static void
14260 f_remote_peek(argvars, rettv)
14261 typval_T *argvars UNUSED;
14262 typval_T *rettv;
14264 #ifdef FEAT_CLIENTSERVER
14265 dictitem_T v;
14266 char_u *s = NULL;
14267 # ifdef WIN32
14268 long_u n = 0;
14269 # endif
14270 char_u *serverid;
14272 if (check_restricted() || check_secure())
14274 rettv->vval.v_number = -1;
14275 return;
14277 serverid = get_tv_string_chk(&argvars[0]);
14278 if (serverid == NULL)
14280 rettv->vval.v_number = -1;
14281 return; /* type error; errmsg already given */
14283 # ifdef WIN32
14284 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14285 if (n == 0)
14286 rettv->vval.v_number = -1;
14287 else
14289 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14290 rettv->vval.v_number = (s != NULL);
14292 # else
14293 if (check_connection() == FAIL)
14294 return;
14296 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14297 serverStrToWin(serverid), &s);
14298 # endif
14300 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14302 char_u *retvar;
14304 v.di_tv.v_type = VAR_STRING;
14305 v.di_tv.vval.v_string = vim_strsave(s);
14306 retvar = get_tv_string_chk(&argvars[1]);
14307 if (retvar != NULL)
14308 set_var(retvar, &v.di_tv, FALSE);
14309 vim_free(v.di_tv.vval.v_string);
14311 #else
14312 rettv->vval.v_number = -1;
14313 #endif
14316 static void
14317 f_remote_read(argvars, rettv)
14318 typval_T *argvars UNUSED;
14319 typval_T *rettv;
14321 char_u *r = NULL;
14323 #ifdef FEAT_CLIENTSERVER
14324 char_u *serverid = get_tv_string_chk(&argvars[0]);
14326 if (serverid != NULL && !check_restricted() && !check_secure())
14328 # ifdef WIN32
14329 /* The server's HWND is encoded in the 'id' parameter */
14330 long_u n = 0;
14332 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14333 if (n != 0)
14334 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14335 if (r == NULL)
14336 # else
14337 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14338 serverStrToWin(serverid), &r, FALSE) < 0)
14339 # endif
14340 EMSG(_("E277: Unable to read a server reply"));
14342 #endif
14343 rettv->v_type = VAR_STRING;
14344 rettv->vval.v_string = r;
14348 * "remote_send()" function
14350 static void
14351 f_remote_send(argvars, rettv)
14352 typval_T *argvars UNUSED;
14353 typval_T *rettv;
14355 rettv->v_type = VAR_STRING;
14356 rettv->vval.v_string = NULL;
14357 #ifdef FEAT_CLIENTSERVER
14358 remote_common(argvars, rettv, FALSE);
14359 #endif
14363 * "remove()" function
14365 static void
14366 f_remove(argvars, rettv)
14367 typval_T *argvars;
14368 typval_T *rettv;
14370 list_T *l;
14371 listitem_T *item, *item2;
14372 listitem_T *li;
14373 long idx;
14374 long end;
14375 char_u *key;
14376 dict_T *d;
14377 dictitem_T *di;
14379 if (argvars[0].v_type == VAR_DICT)
14381 if (argvars[2].v_type != VAR_UNKNOWN)
14382 EMSG2(_(e_toomanyarg), "remove()");
14383 else if ((d = argvars[0].vval.v_dict) != NULL
14384 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14386 key = get_tv_string_chk(&argvars[1]);
14387 if (key != NULL)
14389 di = dict_find(d, key, -1);
14390 if (di == NULL)
14391 EMSG2(_(e_dictkey), key);
14392 else
14394 *rettv = di->di_tv;
14395 init_tv(&di->di_tv);
14396 dictitem_remove(d, di);
14401 else if (argvars[0].v_type != VAR_LIST)
14402 EMSG2(_(e_listdictarg), "remove()");
14403 else if ((l = argvars[0].vval.v_list) != NULL
14404 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14406 int error = FALSE;
14408 idx = get_tv_number_chk(&argvars[1], &error);
14409 if (error)
14410 ; /* type error: do nothing, errmsg already given */
14411 else if ((item = list_find(l, idx)) == NULL)
14412 EMSGN(_(e_listidx), idx);
14413 else
14415 if (argvars[2].v_type == VAR_UNKNOWN)
14417 /* Remove one item, return its value. */
14418 list_remove(l, item, item);
14419 *rettv = item->li_tv;
14420 vim_free(item);
14422 else
14424 /* Remove range of items, return list with values. */
14425 end = get_tv_number_chk(&argvars[2], &error);
14426 if (error)
14427 ; /* type error: do nothing */
14428 else if ((item2 = list_find(l, end)) == NULL)
14429 EMSGN(_(e_listidx), end);
14430 else
14432 int cnt = 0;
14434 for (li = item; li != NULL; li = li->li_next)
14436 ++cnt;
14437 if (li == item2)
14438 break;
14440 if (li == NULL) /* didn't find "item2" after "item" */
14441 EMSG(_(e_invrange));
14442 else
14444 list_remove(l, item, item2);
14445 if (rettv_list_alloc(rettv) == OK)
14447 l = rettv->vval.v_list;
14448 l->lv_first = item;
14449 l->lv_last = item2;
14450 item->li_prev = NULL;
14451 item2->li_next = NULL;
14452 l->lv_len = cnt;
14462 * "rename({from}, {to})" function
14464 static void
14465 f_rename(argvars, rettv)
14466 typval_T *argvars;
14467 typval_T *rettv;
14469 char_u buf[NUMBUFLEN];
14471 if (check_restricted() || check_secure())
14472 rettv->vval.v_number = -1;
14473 else
14474 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14475 get_tv_string_buf(&argvars[1], buf));
14479 * "repeat()" function
14481 static void
14482 f_repeat(argvars, rettv)
14483 typval_T *argvars;
14484 typval_T *rettv;
14486 char_u *p;
14487 int n;
14488 int slen;
14489 int len;
14490 char_u *r;
14491 int i;
14493 n = get_tv_number(&argvars[1]);
14494 if (argvars[0].v_type == VAR_LIST)
14496 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14497 while (n-- > 0)
14498 if (list_extend(rettv->vval.v_list,
14499 argvars[0].vval.v_list, NULL) == FAIL)
14500 break;
14502 else
14504 p = get_tv_string(&argvars[0]);
14505 rettv->v_type = VAR_STRING;
14506 rettv->vval.v_string = NULL;
14508 slen = (int)STRLEN(p);
14509 len = slen * n;
14510 if (len <= 0)
14511 return;
14513 r = alloc(len + 1);
14514 if (r != NULL)
14516 for (i = 0; i < n; i++)
14517 mch_memmove(r + i * slen, p, (size_t)slen);
14518 r[len] = NUL;
14521 rettv->vval.v_string = r;
14526 * "resolve()" function
14528 static void
14529 f_resolve(argvars, rettv)
14530 typval_T *argvars;
14531 typval_T *rettv;
14533 char_u *p;
14535 p = get_tv_string(&argvars[0]);
14536 #ifdef FEAT_SHORTCUT
14538 char_u *v = NULL;
14540 v = mch_resolve_shortcut(p);
14541 if (v != NULL)
14542 rettv->vval.v_string = v;
14543 else
14544 rettv->vval.v_string = vim_strsave(p);
14546 #else
14547 # ifdef HAVE_READLINK
14549 char_u buf[MAXPATHL + 1];
14550 char_u *cpy;
14551 int len;
14552 char_u *remain = NULL;
14553 char_u *q;
14554 int is_relative_to_current = FALSE;
14555 int has_trailing_pathsep = FALSE;
14556 int limit = 100;
14558 p = vim_strsave(p);
14560 if (p[0] == '.' && (vim_ispathsep(p[1])
14561 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14562 is_relative_to_current = TRUE;
14564 len = STRLEN(p);
14565 if (len > 0 && after_pathsep(p, p + len))
14566 has_trailing_pathsep = TRUE;
14568 q = getnextcomp(p);
14569 if (*q != NUL)
14571 /* Separate the first path component in "p", and keep the
14572 * remainder (beginning with the path separator). */
14573 remain = vim_strsave(q - 1);
14574 q[-1] = NUL;
14577 for (;;)
14579 for (;;)
14581 len = readlink((char *)p, (char *)buf, MAXPATHL);
14582 if (len <= 0)
14583 break;
14584 buf[len] = NUL;
14586 if (limit-- == 0)
14588 vim_free(p);
14589 vim_free(remain);
14590 EMSG(_("E655: Too many symbolic links (cycle?)"));
14591 rettv->vval.v_string = NULL;
14592 goto fail;
14595 /* Ensure that the result will have a trailing path separator
14596 * if the argument has one. */
14597 if (remain == NULL && has_trailing_pathsep)
14598 add_pathsep(buf);
14600 /* Separate the first path component in the link value and
14601 * concatenate the remainders. */
14602 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14603 if (*q != NUL)
14605 if (remain == NULL)
14606 remain = vim_strsave(q - 1);
14607 else
14609 cpy = concat_str(q - 1, remain);
14610 if (cpy != NULL)
14612 vim_free(remain);
14613 remain = cpy;
14616 q[-1] = NUL;
14619 q = gettail(p);
14620 if (q > p && *q == NUL)
14622 /* Ignore trailing path separator. */
14623 q[-1] = NUL;
14624 q = gettail(p);
14626 if (q > p && !mch_isFullName(buf))
14628 /* symlink is relative to directory of argument */
14629 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14630 if (cpy != NULL)
14632 STRCPY(cpy, p);
14633 STRCPY(gettail(cpy), buf);
14634 vim_free(p);
14635 p = cpy;
14638 else
14640 vim_free(p);
14641 p = vim_strsave(buf);
14645 if (remain == NULL)
14646 break;
14648 /* Append the first path component of "remain" to "p". */
14649 q = getnextcomp(remain + 1);
14650 len = q - remain - (*q != NUL);
14651 cpy = vim_strnsave(p, STRLEN(p) + len);
14652 if (cpy != NULL)
14654 STRNCAT(cpy, remain, len);
14655 vim_free(p);
14656 p = cpy;
14658 /* Shorten "remain". */
14659 if (*q != NUL)
14660 STRMOVE(remain, q - 1);
14661 else
14663 vim_free(remain);
14664 remain = NULL;
14668 /* If the result is a relative path name, make it explicitly relative to
14669 * the current directory if and only if the argument had this form. */
14670 if (!vim_ispathsep(*p))
14672 if (is_relative_to_current
14673 && *p != NUL
14674 && !(p[0] == '.'
14675 && (p[1] == NUL
14676 || vim_ispathsep(p[1])
14677 || (p[1] == '.'
14678 && (p[2] == NUL
14679 || vim_ispathsep(p[2]))))))
14681 /* Prepend "./". */
14682 cpy = concat_str((char_u *)"./", p);
14683 if (cpy != NULL)
14685 vim_free(p);
14686 p = cpy;
14689 else if (!is_relative_to_current)
14691 /* Strip leading "./". */
14692 q = p;
14693 while (q[0] == '.' && vim_ispathsep(q[1]))
14694 q += 2;
14695 if (q > p)
14696 STRMOVE(p, p + 2);
14700 /* Ensure that the result will have no trailing path separator
14701 * if the argument had none. But keep "/" or "//". */
14702 if (!has_trailing_pathsep)
14704 q = p + STRLEN(p);
14705 if (after_pathsep(p, q))
14706 *gettail_sep(p) = NUL;
14709 rettv->vval.v_string = p;
14711 # else
14712 rettv->vval.v_string = vim_strsave(p);
14713 # endif
14714 #endif
14716 simplify_filename(rettv->vval.v_string);
14718 #ifdef HAVE_READLINK
14719 fail:
14720 #endif
14721 rettv->v_type = VAR_STRING;
14725 * "reverse({list})" function
14727 static void
14728 f_reverse(argvars, rettv)
14729 typval_T *argvars;
14730 typval_T *rettv;
14732 list_T *l;
14733 listitem_T *li, *ni;
14735 if (argvars[0].v_type != VAR_LIST)
14736 EMSG2(_(e_listarg), "reverse()");
14737 else if ((l = argvars[0].vval.v_list) != NULL
14738 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14740 li = l->lv_last;
14741 l->lv_first = l->lv_last = NULL;
14742 l->lv_len = 0;
14743 while (li != NULL)
14745 ni = li->li_prev;
14746 list_append(l, li);
14747 li = ni;
14749 rettv->vval.v_list = l;
14750 rettv->v_type = VAR_LIST;
14751 ++l->lv_refcount;
14752 l->lv_idx = l->lv_len - l->lv_idx - 1;
14756 #define SP_NOMOVE 0x01 /* don't move cursor */
14757 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14758 #define SP_RETCOUNT 0x04 /* return matchcount */
14759 #define SP_SETPCMARK 0x08 /* set previous context mark */
14760 #define SP_START 0x10 /* accept match at start position */
14761 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14762 #define SP_END 0x40 /* leave cursor at end of match */
14764 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14767 * Get flags for a search function.
14768 * Possibly sets "p_ws".
14769 * Returns BACKWARD, FORWARD or zero (for an error).
14771 static int
14772 get_search_arg(varp, flagsp)
14773 typval_T *varp;
14774 int *flagsp;
14776 int dir = FORWARD;
14777 char_u *flags;
14778 char_u nbuf[NUMBUFLEN];
14779 int mask;
14781 if (varp->v_type != VAR_UNKNOWN)
14783 flags = get_tv_string_buf_chk(varp, nbuf);
14784 if (flags == NULL)
14785 return 0; /* type error; errmsg already given */
14786 while (*flags != NUL)
14788 switch (*flags)
14790 case 'b': dir = BACKWARD; break;
14791 case 'w': p_ws = TRUE; break;
14792 case 'W': p_ws = FALSE; break;
14793 default: mask = 0;
14794 if (flagsp != NULL)
14795 switch (*flags)
14797 case 'c': mask = SP_START; break;
14798 case 'e': mask = SP_END; break;
14799 case 'm': mask = SP_RETCOUNT; break;
14800 case 'n': mask = SP_NOMOVE; break;
14801 case 'p': mask = SP_SUBPAT; break;
14802 case 'r': mask = SP_REPEAT; break;
14803 case 's': mask = SP_SETPCMARK; break;
14805 if (mask == 0)
14807 EMSG2(_(e_invarg2), flags);
14808 dir = 0;
14810 else
14811 *flagsp |= mask;
14813 if (dir == 0)
14814 break;
14815 ++flags;
14818 return dir;
14822 * Shared by search() and searchpos() functions
14824 static int
14825 search_cmn(argvars, match_pos, flagsp)
14826 typval_T *argvars;
14827 pos_T *match_pos;
14828 int *flagsp;
14830 int flags;
14831 char_u *pat;
14832 pos_T pos;
14833 pos_T save_cursor;
14834 int save_p_ws = p_ws;
14835 int dir;
14836 int retval = 0; /* default: FAIL */
14837 long lnum_stop = 0;
14838 proftime_T tm;
14839 #ifdef FEAT_RELTIME
14840 long time_limit = 0;
14841 #endif
14842 int options = SEARCH_KEEP;
14843 int subpatnum;
14845 pat = get_tv_string(&argvars[0]);
14846 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14847 if (dir == 0)
14848 goto theend;
14849 flags = *flagsp;
14850 if (flags & SP_START)
14851 options |= SEARCH_START;
14852 if (flags & SP_END)
14853 options |= SEARCH_END;
14855 /* Optional arguments: line number to stop searching and timeout. */
14856 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14858 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14859 if (lnum_stop < 0)
14860 goto theend;
14861 #ifdef FEAT_RELTIME
14862 if (argvars[3].v_type != VAR_UNKNOWN)
14864 time_limit = get_tv_number_chk(&argvars[3], NULL);
14865 if (time_limit < 0)
14866 goto theend;
14868 #endif
14871 #ifdef FEAT_RELTIME
14872 /* Set the time limit, if there is one. */
14873 profile_setlimit(time_limit, &tm);
14874 #endif
14877 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14878 * Check to make sure only those flags are set.
14879 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14880 * flags cannot be set. Check for that condition also.
14882 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14883 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14885 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14886 goto theend;
14889 pos = save_cursor = curwin->w_cursor;
14890 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14891 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14892 if (subpatnum != FAIL)
14894 if (flags & SP_SUBPAT)
14895 retval = subpatnum;
14896 else
14897 retval = pos.lnum;
14898 if (flags & SP_SETPCMARK)
14899 setpcmark();
14900 curwin->w_cursor = pos;
14901 if (match_pos != NULL)
14903 /* Store the match cursor position */
14904 match_pos->lnum = pos.lnum;
14905 match_pos->col = pos.col + 1;
14907 /* "/$" will put the cursor after the end of the line, may need to
14908 * correct that here */
14909 check_cursor();
14912 /* If 'n' flag is used: restore cursor position. */
14913 if (flags & SP_NOMOVE)
14914 curwin->w_cursor = save_cursor;
14915 else
14916 curwin->w_set_curswant = TRUE;
14917 theend:
14918 p_ws = save_p_ws;
14920 return retval;
14923 #ifdef FEAT_FLOAT
14925 * "round({float})" function
14927 static void
14928 f_round(argvars, rettv)
14929 typval_T *argvars;
14930 typval_T *rettv;
14932 float_T f;
14934 rettv->v_type = VAR_FLOAT;
14935 if (get_float_arg(argvars, &f) == OK)
14936 /* round() is not in C90, use ceil() or floor() instead. */
14937 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14938 else
14939 rettv->vval.v_float = 0.0;
14941 #endif
14944 * "search()" function
14946 static void
14947 f_search(argvars, rettv)
14948 typval_T *argvars;
14949 typval_T *rettv;
14951 int flags = 0;
14953 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14957 * "searchdecl()" function
14959 static void
14960 f_searchdecl(argvars, rettv)
14961 typval_T *argvars;
14962 typval_T *rettv;
14964 int locally = 1;
14965 int thisblock = 0;
14966 int error = FALSE;
14967 char_u *name;
14969 rettv->vval.v_number = 1; /* default: FAIL */
14971 name = get_tv_string_chk(&argvars[0]);
14972 if (argvars[1].v_type != VAR_UNKNOWN)
14974 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14975 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14976 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14978 if (!error && name != NULL)
14979 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14980 locally, thisblock, SEARCH_KEEP) == FAIL;
14984 * Used by searchpair() and searchpairpos()
14986 static int
14987 searchpair_cmn(argvars, match_pos)
14988 typval_T *argvars;
14989 pos_T *match_pos;
14991 char_u *spat, *mpat, *epat;
14992 char_u *skip;
14993 int save_p_ws = p_ws;
14994 int dir;
14995 int flags = 0;
14996 char_u nbuf1[NUMBUFLEN];
14997 char_u nbuf2[NUMBUFLEN];
14998 char_u nbuf3[NUMBUFLEN];
14999 int retval = 0; /* default: FAIL */
15000 long lnum_stop = 0;
15001 long time_limit = 0;
15003 /* Get the three pattern arguments: start, middle, end. */
15004 spat = get_tv_string_chk(&argvars[0]);
15005 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
15006 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
15007 if (spat == NULL || mpat == NULL || epat == NULL)
15008 goto theend; /* type error */
15010 /* Handle the optional fourth argument: flags */
15011 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
15012 if (dir == 0)
15013 goto theend;
15015 /* Don't accept SP_END or SP_SUBPAT.
15016 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
15018 if ((flags & (SP_END | SP_SUBPAT)) != 0
15019 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
15021 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
15022 goto theend;
15025 /* Using 'r' implies 'W', otherwise it doesn't work. */
15026 if (flags & SP_REPEAT)
15027 p_ws = FALSE;
15029 /* Optional fifth argument: skip expression */
15030 if (argvars[3].v_type == VAR_UNKNOWN
15031 || argvars[4].v_type == VAR_UNKNOWN)
15032 skip = (char_u *)"";
15033 else
15035 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
15036 if (argvars[5].v_type != VAR_UNKNOWN)
15038 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
15039 if (lnum_stop < 0)
15040 goto theend;
15041 #ifdef FEAT_RELTIME
15042 if (argvars[6].v_type != VAR_UNKNOWN)
15044 time_limit = get_tv_number_chk(&argvars[6], NULL);
15045 if (time_limit < 0)
15046 goto theend;
15048 #endif
15051 if (skip == NULL)
15052 goto theend; /* type error */
15054 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
15055 match_pos, lnum_stop, time_limit);
15057 theend:
15058 p_ws = save_p_ws;
15060 return retval;
15064 * "searchpair()" function
15066 static void
15067 f_searchpair(argvars, rettv)
15068 typval_T *argvars;
15069 typval_T *rettv;
15071 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15075 * "searchpairpos()" function
15077 static void
15078 f_searchpairpos(argvars, rettv)
15079 typval_T *argvars;
15080 typval_T *rettv;
15082 pos_T match_pos;
15083 int lnum = 0;
15084 int col = 0;
15086 if (rettv_list_alloc(rettv) == FAIL)
15087 return;
15089 if (searchpair_cmn(argvars, &match_pos) > 0)
15091 lnum = match_pos.lnum;
15092 col = match_pos.col;
15095 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15096 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15100 * Search for a start/middle/end thing.
15101 * Used by searchpair(), see its documentation for the details.
15102 * Returns 0 or -1 for no match,
15104 long
15105 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15106 lnum_stop, time_limit)
15107 char_u *spat; /* start pattern */
15108 char_u *mpat; /* middle pattern */
15109 char_u *epat; /* end pattern */
15110 int dir; /* BACKWARD or FORWARD */
15111 char_u *skip; /* skip expression */
15112 int flags; /* SP_SETPCMARK and other SP_ values */
15113 pos_T *match_pos;
15114 linenr_T lnum_stop; /* stop at this line if not zero */
15115 long time_limit; /* stop after this many msec */
15117 char_u *save_cpo;
15118 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15119 long retval = 0;
15120 pos_T pos;
15121 pos_T firstpos;
15122 pos_T foundpos;
15123 pos_T save_cursor;
15124 pos_T save_pos;
15125 int n;
15126 int r;
15127 int nest = 1;
15128 int err;
15129 int options = SEARCH_KEEP;
15130 proftime_T tm;
15132 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15133 save_cpo = p_cpo;
15134 p_cpo = empty_option;
15136 #ifdef FEAT_RELTIME
15137 /* Set the time limit, if there is one. */
15138 profile_setlimit(time_limit, &tm);
15139 #endif
15141 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15142 * start/middle/end (pat3, for the top pair). */
15143 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15144 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15145 if (pat2 == NULL || pat3 == NULL)
15146 goto theend;
15147 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15148 if (*mpat == NUL)
15149 STRCPY(pat3, pat2);
15150 else
15151 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15152 spat, epat, mpat);
15153 if (flags & SP_START)
15154 options |= SEARCH_START;
15156 save_cursor = curwin->w_cursor;
15157 pos = curwin->w_cursor;
15158 clearpos(&firstpos);
15159 clearpos(&foundpos);
15160 pat = pat3;
15161 for (;;)
15163 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15164 options, RE_SEARCH, lnum_stop, &tm);
15165 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15166 /* didn't find it or found the first match again: FAIL */
15167 break;
15169 if (firstpos.lnum == 0)
15170 firstpos = pos;
15171 if (equalpos(pos, foundpos))
15173 /* Found the same position again. Can happen with a pattern that
15174 * has "\zs" at the end and searching backwards. Advance one
15175 * character and try again. */
15176 if (dir == BACKWARD)
15177 decl(&pos);
15178 else
15179 incl(&pos);
15181 foundpos = pos;
15183 /* clear the start flag to avoid getting stuck here */
15184 options &= ~SEARCH_START;
15186 /* If the skip pattern matches, ignore this match. */
15187 if (*skip != NUL)
15189 save_pos = curwin->w_cursor;
15190 curwin->w_cursor = pos;
15191 r = eval_to_bool(skip, &err, NULL, FALSE);
15192 curwin->w_cursor = save_pos;
15193 if (err)
15195 /* Evaluating {skip} caused an error, break here. */
15196 curwin->w_cursor = save_cursor;
15197 retval = -1;
15198 break;
15200 if (r)
15201 continue;
15204 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15206 /* Found end when searching backwards or start when searching
15207 * forward: nested pair. */
15208 ++nest;
15209 pat = pat2; /* nested, don't search for middle */
15211 else
15213 /* Found end when searching forward or start when searching
15214 * backward: end of (nested) pair; or found middle in outer pair. */
15215 if (--nest == 1)
15216 pat = pat3; /* outer level, search for middle */
15219 if (nest == 0)
15221 /* Found the match: return matchcount or line number. */
15222 if (flags & SP_RETCOUNT)
15223 ++retval;
15224 else
15225 retval = pos.lnum;
15226 if (flags & SP_SETPCMARK)
15227 setpcmark();
15228 curwin->w_cursor = pos;
15229 if (!(flags & SP_REPEAT))
15230 break;
15231 nest = 1; /* search for next unmatched */
15235 if (match_pos != NULL)
15237 /* Store the match cursor position */
15238 match_pos->lnum = curwin->w_cursor.lnum;
15239 match_pos->col = curwin->w_cursor.col + 1;
15242 /* If 'n' flag is used or search failed: restore cursor position. */
15243 if ((flags & SP_NOMOVE) || retval == 0)
15244 curwin->w_cursor = save_cursor;
15246 theend:
15247 vim_free(pat2);
15248 vim_free(pat3);
15249 if (p_cpo == empty_option)
15250 p_cpo = save_cpo;
15251 else
15252 /* Darn, evaluating the {skip} expression changed the value. */
15253 free_string_option(save_cpo);
15255 return retval;
15259 * "searchpos()" function
15261 static void
15262 f_searchpos(argvars, rettv)
15263 typval_T *argvars;
15264 typval_T *rettv;
15266 pos_T match_pos;
15267 int lnum = 0;
15268 int col = 0;
15269 int n;
15270 int flags = 0;
15272 if (rettv_list_alloc(rettv) == FAIL)
15273 return;
15275 n = search_cmn(argvars, &match_pos, &flags);
15276 if (n > 0)
15278 lnum = match_pos.lnum;
15279 col = match_pos.col;
15282 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15283 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15284 if (flags & SP_SUBPAT)
15285 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15289 static void
15290 f_server2client(argvars, rettv)
15291 typval_T *argvars UNUSED;
15292 typval_T *rettv;
15294 #ifdef FEAT_CLIENTSERVER
15295 char_u buf[NUMBUFLEN];
15296 char_u *server = get_tv_string_chk(&argvars[0]);
15297 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15299 rettv->vval.v_number = -1;
15300 if (server == NULL || reply == NULL)
15301 return;
15302 if (check_restricted() || check_secure())
15303 return;
15304 # ifdef FEAT_X11
15305 if (check_connection() == FAIL)
15306 return;
15307 # endif
15309 if (serverSendReply(server, reply) < 0)
15311 EMSG(_("E258: Unable to send to client"));
15312 return;
15314 rettv->vval.v_number = 0;
15315 #else
15316 rettv->vval.v_number = -1;
15317 #endif
15320 static void
15321 f_serverlist(argvars, rettv)
15322 typval_T *argvars UNUSED;
15323 typval_T *rettv;
15325 char_u *r = NULL;
15327 #ifdef FEAT_CLIENTSERVER
15328 # ifdef WIN32
15329 r = serverGetVimNames();
15330 # else
15331 make_connection();
15332 if (X_DISPLAY != NULL)
15333 r = serverGetVimNames(X_DISPLAY);
15334 # endif
15335 #endif
15336 rettv->v_type = VAR_STRING;
15337 rettv->vval.v_string = r;
15341 * "setbufvar()" function
15343 static void
15344 f_setbufvar(argvars, rettv)
15345 typval_T *argvars;
15346 typval_T *rettv UNUSED;
15348 buf_T *buf;
15349 aco_save_T aco;
15350 char_u *varname, *bufvarname;
15351 typval_T *varp;
15352 char_u nbuf[NUMBUFLEN];
15354 if (check_restricted() || check_secure())
15355 return;
15356 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15357 varname = get_tv_string_chk(&argvars[1]);
15358 buf = get_buf_tv(&argvars[0]);
15359 varp = &argvars[2];
15361 if (buf != NULL && varname != NULL && varp != NULL)
15363 /* set curbuf to be our buf, temporarily */
15364 aucmd_prepbuf(&aco, buf);
15366 if (*varname == '&')
15368 long numval;
15369 char_u *strval;
15370 int error = FALSE;
15372 ++varname;
15373 numval = get_tv_number_chk(varp, &error);
15374 strval = get_tv_string_buf_chk(varp, nbuf);
15375 if (!error && strval != NULL)
15376 set_option_value(varname, numval, strval, OPT_LOCAL);
15378 else
15380 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15381 if (bufvarname != NULL)
15383 STRCPY(bufvarname, "b:");
15384 STRCPY(bufvarname + 2, varname);
15385 set_var(bufvarname, varp, TRUE);
15386 vim_free(bufvarname);
15390 /* reset notion of buffer */
15391 aucmd_restbuf(&aco);
15396 * "setcmdpos()" function
15398 static void
15399 f_setcmdpos(argvars, rettv)
15400 typval_T *argvars;
15401 typval_T *rettv;
15403 int pos = (int)get_tv_number(&argvars[0]) - 1;
15405 if (pos >= 0)
15406 rettv->vval.v_number = set_cmdline_pos(pos);
15410 * "setline()" function
15412 static void
15413 f_setline(argvars, rettv)
15414 typval_T *argvars;
15415 typval_T *rettv;
15417 linenr_T lnum;
15418 char_u *line = NULL;
15419 list_T *l = NULL;
15420 listitem_T *li = NULL;
15421 long added = 0;
15422 linenr_T lcount = curbuf->b_ml.ml_line_count;
15424 lnum = get_tv_lnum(&argvars[0]);
15425 if (argvars[1].v_type == VAR_LIST)
15427 l = argvars[1].vval.v_list;
15428 li = l->lv_first;
15430 else
15431 line = get_tv_string_chk(&argvars[1]);
15433 /* default result is zero == OK */
15434 for (;;)
15436 if (l != NULL)
15438 /* list argument, get next string */
15439 if (li == NULL)
15440 break;
15441 line = get_tv_string_chk(&li->li_tv);
15442 li = li->li_next;
15445 rettv->vval.v_number = 1; /* FAIL */
15446 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15447 break;
15448 if (lnum <= curbuf->b_ml.ml_line_count)
15450 /* existing line, replace it */
15451 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15453 changed_bytes(lnum, 0);
15454 if (lnum == curwin->w_cursor.lnum)
15455 check_cursor_col();
15456 rettv->vval.v_number = 0; /* OK */
15459 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15461 /* lnum is one past the last line, append the line */
15462 ++added;
15463 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15464 rettv->vval.v_number = 0; /* OK */
15467 if (l == NULL) /* only one string argument */
15468 break;
15469 ++lnum;
15472 if (added > 0)
15473 appended_lines_mark(lcount, added);
15476 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15479 * Used by "setqflist()" and "setloclist()" functions
15481 static void
15482 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15483 win_T *wp UNUSED;
15484 typval_T *list_arg UNUSED;
15485 typval_T *action_arg UNUSED;
15486 typval_T *rettv;
15488 #ifdef FEAT_QUICKFIX
15489 char_u *act;
15490 int action = ' ';
15491 #endif
15493 rettv->vval.v_number = -1;
15495 #ifdef FEAT_QUICKFIX
15496 if (list_arg->v_type != VAR_LIST)
15497 EMSG(_(e_listreq));
15498 else
15500 list_T *l = list_arg->vval.v_list;
15502 if (action_arg->v_type == VAR_STRING)
15504 act = get_tv_string_chk(action_arg);
15505 if (act == NULL)
15506 return; /* type error; errmsg already given */
15507 if (*act == 'a' || *act == 'r')
15508 action = *act;
15511 if (l != NULL && set_errorlist(wp, l, action) == OK)
15512 rettv->vval.v_number = 0;
15514 #endif
15518 * "setloclist()" function
15520 static void
15521 f_setloclist(argvars, rettv)
15522 typval_T *argvars;
15523 typval_T *rettv;
15525 win_T *win;
15527 rettv->vval.v_number = -1;
15529 win = find_win_by_nr(&argvars[0], NULL);
15530 if (win != NULL)
15531 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15535 * "setmatches()" function
15537 static void
15538 f_setmatches(argvars, rettv)
15539 typval_T *argvars;
15540 typval_T *rettv;
15542 #ifdef FEAT_SEARCH_EXTRA
15543 list_T *l;
15544 listitem_T *li;
15545 dict_T *d;
15547 rettv->vval.v_number = -1;
15548 if (argvars[0].v_type != VAR_LIST)
15550 EMSG(_(e_listreq));
15551 return;
15553 if ((l = argvars[0].vval.v_list) != NULL)
15556 /* To some extent make sure that we are dealing with a list from
15557 * "getmatches()". */
15558 li = l->lv_first;
15559 while (li != NULL)
15561 if (li->li_tv.v_type != VAR_DICT
15562 || (d = li->li_tv.vval.v_dict) == NULL)
15564 EMSG(_(e_invarg));
15565 return;
15567 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15568 && dict_find(d, (char_u *)"pattern", -1) != NULL
15569 && dict_find(d, (char_u *)"priority", -1) != NULL
15570 && dict_find(d, (char_u *)"id", -1) != NULL))
15572 EMSG(_(e_invarg));
15573 return;
15575 li = li->li_next;
15578 clear_matches(curwin);
15579 li = l->lv_first;
15580 while (li != NULL)
15582 d = li->li_tv.vval.v_dict;
15583 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15584 get_dict_string(d, (char_u *)"pattern", FALSE),
15585 (int)get_dict_number(d, (char_u *)"priority"),
15586 (int)get_dict_number(d, (char_u *)"id"));
15587 li = li->li_next;
15589 rettv->vval.v_number = 0;
15591 #endif
15595 * "setpos()" function
15597 static void
15598 f_setpos(argvars, rettv)
15599 typval_T *argvars;
15600 typval_T *rettv;
15602 pos_T pos;
15603 int fnum;
15604 char_u *name;
15606 rettv->vval.v_number = -1;
15607 name = get_tv_string_chk(argvars);
15608 if (name != NULL)
15610 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15612 if (--pos.col < 0)
15613 pos.col = 0;
15614 if (name[0] == '.' && name[1] == NUL)
15616 /* set cursor */
15617 if (fnum == curbuf->b_fnum)
15619 curwin->w_cursor = pos;
15620 check_cursor();
15621 rettv->vval.v_number = 0;
15623 else
15624 EMSG(_(e_invarg));
15626 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15628 /* set mark */
15629 if (setmark_pos(name[1], &pos, fnum) == OK)
15630 rettv->vval.v_number = 0;
15632 else
15633 EMSG(_(e_invarg));
15639 * "setqflist()" function
15641 static void
15642 f_setqflist(argvars, rettv)
15643 typval_T *argvars;
15644 typval_T *rettv;
15646 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15650 * "setreg()" function
15652 static void
15653 f_setreg(argvars, rettv)
15654 typval_T *argvars;
15655 typval_T *rettv;
15657 int regname;
15658 char_u *strregname;
15659 char_u *stropt;
15660 char_u *strval;
15661 int append;
15662 char_u yank_type;
15663 long block_len;
15665 block_len = -1;
15666 yank_type = MAUTO;
15667 append = FALSE;
15669 strregname = get_tv_string_chk(argvars);
15670 rettv->vval.v_number = 1; /* FAIL is default */
15672 if (strregname == NULL)
15673 return; /* type error; errmsg already given */
15674 regname = *strregname;
15675 if (regname == 0 || regname == '@')
15676 regname = '"';
15677 else if (regname == '=')
15678 return;
15680 if (argvars[2].v_type != VAR_UNKNOWN)
15682 stropt = get_tv_string_chk(&argvars[2]);
15683 if (stropt == NULL)
15684 return; /* type error */
15685 for (; *stropt != NUL; ++stropt)
15686 switch (*stropt)
15688 case 'a': case 'A': /* append */
15689 append = TRUE;
15690 break;
15691 case 'v': case 'c': /* character-wise selection */
15692 yank_type = MCHAR;
15693 break;
15694 case 'V': case 'l': /* line-wise selection */
15695 yank_type = MLINE;
15696 break;
15697 #ifdef FEAT_VISUAL
15698 case 'b': case Ctrl_V: /* block-wise selection */
15699 yank_type = MBLOCK;
15700 if (VIM_ISDIGIT(stropt[1]))
15702 ++stropt;
15703 block_len = getdigits(&stropt) - 1;
15704 --stropt;
15706 break;
15707 #endif
15711 strval = get_tv_string_chk(&argvars[1]);
15712 if (strval != NULL)
15713 write_reg_contents_ex(regname, strval, -1,
15714 append, yank_type, block_len);
15715 rettv->vval.v_number = 0;
15719 * "settabwinvar()" function
15721 static void
15722 f_settabwinvar(argvars, rettv)
15723 typval_T *argvars;
15724 typval_T *rettv;
15726 setwinvar(argvars, rettv, 1);
15730 * "setwinvar()" function
15732 static void
15733 f_setwinvar(argvars, rettv)
15734 typval_T *argvars;
15735 typval_T *rettv;
15737 setwinvar(argvars, rettv, 0);
15741 * "setwinvar()" and "settabwinvar()" functions
15743 static void
15744 setwinvar(argvars, rettv, off)
15745 typval_T *argvars;
15746 typval_T *rettv UNUSED;
15747 int off;
15749 win_T *win;
15750 #ifdef FEAT_WINDOWS
15751 win_T *save_curwin;
15752 tabpage_T *save_curtab;
15753 #endif
15754 char_u *varname, *winvarname;
15755 typval_T *varp;
15756 char_u nbuf[NUMBUFLEN];
15757 tabpage_T *tp;
15759 if (check_restricted() || check_secure())
15760 return;
15762 #ifdef FEAT_WINDOWS
15763 if (off == 1)
15764 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15765 else
15766 tp = curtab;
15767 #endif
15768 win = find_win_by_nr(&argvars[off], tp);
15769 varname = get_tv_string_chk(&argvars[off + 1]);
15770 varp = &argvars[off + 2];
15772 if (win != NULL && varname != NULL && varp != NULL)
15774 #ifdef FEAT_WINDOWS
15775 /* set curwin to be our win, temporarily */
15776 save_curwin = curwin;
15777 save_curtab = curtab;
15778 goto_tabpage_tp(tp);
15779 if (!win_valid(win))
15780 return;
15781 curwin = win;
15782 curbuf = curwin->w_buffer;
15783 #endif
15785 if (*varname == '&')
15787 long numval;
15788 char_u *strval;
15789 int error = FALSE;
15791 ++varname;
15792 numval = get_tv_number_chk(varp, &error);
15793 strval = get_tv_string_buf_chk(varp, nbuf);
15794 if (!error && strval != NULL)
15795 set_option_value(varname, numval, strval, OPT_LOCAL);
15797 else
15799 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15800 if (winvarname != NULL)
15802 STRCPY(winvarname, "w:");
15803 STRCPY(winvarname + 2, varname);
15804 set_var(winvarname, varp, TRUE);
15805 vim_free(winvarname);
15809 #ifdef FEAT_WINDOWS
15810 /* Restore current tabpage and window, if still valid (autocomands can
15811 * make them invalid). */
15812 if (valid_tabpage(save_curtab))
15813 goto_tabpage_tp(save_curtab);
15814 if (win_valid(save_curwin))
15816 curwin = save_curwin;
15817 curbuf = curwin->w_buffer;
15819 #endif
15824 * "shellescape({string})" function
15826 static void
15827 f_shellescape(argvars, rettv)
15828 typval_T *argvars;
15829 typval_T *rettv;
15831 rettv->vval.v_string = vim_strsave_shellescape(
15832 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15833 rettv->v_type = VAR_STRING;
15837 * "simplify()" function
15839 static void
15840 f_simplify(argvars, rettv)
15841 typval_T *argvars;
15842 typval_T *rettv;
15844 char_u *p;
15846 p = get_tv_string(&argvars[0]);
15847 rettv->vval.v_string = vim_strsave(p);
15848 simplify_filename(rettv->vval.v_string); /* simplify in place */
15849 rettv->v_type = VAR_STRING;
15852 #ifdef FEAT_FLOAT
15854 * "sin()" function
15856 static void
15857 f_sin(argvars, rettv)
15858 typval_T *argvars;
15859 typval_T *rettv;
15861 float_T f;
15863 rettv->v_type = VAR_FLOAT;
15864 if (get_float_arg(argvars, &f) == OK)
15865 rettv->vval.v_float = sin(f);
15866 else
15867 rettv->vval.v_float = 0.0;
15869 #endif
15871 static int
15872 #ifdef __BORLANDC__
15873 _RTLENTRYF
15874 #endif
15875 item_compare __ARGS((const void *s1, const void *s2));
15876 static int
15877 #ifdef __BORLANDC__
15878 _RTLENTRYF
15879 #endif
15880 item_compare2 __ARGS((const void *s1, const void *s2));
15882 static int item_compare_ic;
15883 static char_u *item_compare_func;
15884 static int item_compare_func_err;
15885 #define ITEM_COMPARE_FAIL 999
15888 * Compare functions for f_sort() below.
15890 static int
15891 #ifdef __BORLANDC__
15892 _RTLENTRYF
15893 #endif
15894 item_compare(s1, s2)
15895 const void *s1;
15896 const void *s2;
15898 char_u *p1, *p2;
15899 char_u *tofree1, *tofree2;
15900 int res;
15901 char_u numbuf1[NUMBUFLEN];
15902 char_u numbuf2[NUMBUFLEN];
15904 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15905 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15906 if (p1 == NULL)
15907 p1 = (char_u *)"";
15908 if (p2 == NULL)
15909 p2 = (char_u *)"";
15910 if (item_compare_ic)
15911 res = STRICMP(p1, p2);
15912 else
15913 res = STRCMP(p1, p2);
15914 vim_free(tofree1);
15915 vim_free(tofree2);
15916 return res;
15919 static int
15920 #ifdef __BORLANDC__
15921 _RTLENTRYF
15922 #endif
15923 item_compare2(s1, s2)
15924 const void *s1;
15925 const void *s2;
15927 int res;
15928 typval_T rettv;
15929 typval_T argv[3];
15930 int dummy;
15932 /* shortcut after failure in previous call; compare all items equal */
15933 if (item_compare_func_err)
15934 return 0;
15936 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15937 * in the copy without changing the original list items. */
15938 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15939 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15941 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15942 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15943 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15944 clear_tv(&argv[0]);
15945 clear_tv(&argv[1]);
15947 if (res == FAIL)
15948 res = ITEM_COMPARE_FAIL;
15949 else
15950 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15951 if (item_compare_func_err)
15952 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15953 clear_tv(&rettv);
15954 return res;
15958 * "sort({list})" function
15960 static void
15961 f_sort(argvars, rettv)
15962 typval_T *argvars;
15963 typval_T *rettv;
15965 list_T *l;
15966 listitem_T *li;
15967 listitem_T **ptrs;
15968 long len;
15969 long i;
15971 if (argvars[0].v_type != VAR_LIST)
15972 EMSG2(_(e_listarg), "sort()");
15973 else
15975 l = argvars[0].vval.v_list;
15976 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15977 return;
15978 rettv->vval.v_list = l;
15979 rettv->v_type = VAR_LIST;
15980 ++l->lv_refcount;
15982 len = list_len(l);
15983 if (len <= 1)
15984 return; /* short list sorts pretty quickly */
15986 item_compare_ic = FALSE;
15987 item_compare_func = NULL;
15988 if (argvars[1].v_type != VAR_UNKNOWN)
15990 if (argvars[1].v_type == VAR_FUNC)
15991 item_compare_func = argvars[1].vval.v_string;
15992 else
15994 int error = FALSE;
15996 i = get_tv_number_chk(&argvars[1], &error);
15997 if (error)
15998 return; /* type error; errmsg already given */
15999 if (i == 1)
16000 item_compare_ic = TRUE;
16001 else
16002 item_compare_func = get_tv_string(&argvars[1]);
16006 /* Make an array with each entry pointing to an item in the List. */
16007 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
16008 if (ptrs == NULL)
16009 return;
16010 i = 0;
16011 for (li = l->lv_first; li != NULL; li = li->li_next)
16012 ptrs[i++] = li;
16014 item_compare_func_err = FALSE;
16015 /* test the compare function */
16016 if (item_compare_func != NULL
16017 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
16018 == ITEM_COMPARE_FAIL)
16019 EMSG(_("E702: Sort compare function failed"));
16020 else
16022 /* Sort the array with item pointers. */
16023 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
16024 item_compare_func == NULL ? item_compare : item_compare2);
16026 if (!item_compare_func_err)
16028 /* Clear the List and append the items in the sorted order. */
16029 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
16030 l->lv_len = 0;
16031 for (i = 0; i < len; ++i)
16032 list_append(l, ptrs[i]);
16036 vim_free(ptrs);
16041 * "soundfold({word})" function
16043 static void
16044 f_soundfold(argvars, rettv)
16045 typval_T *argvars;
16046 typval_T *rettv;
16048 char_u *s;
16050 rettv->v_type = VAR_STRING;
16051 s = get_tv_string(&argvars[0]);
16052 #ifdef FEAT_SPELL
16053 rettv->vval.v_string = eval_soundfold(s);
16054 #else
16055 rettv->vval.v_string = vim_strsave(s);
16056 #endif
16060 * "spellbadword()" function
16062 static void
16063 f_spellbadword(argvars, rettv)
16064 typval_T *argvars UNUSED;
16065 typval_T *rettv;
16067 char_u *word = (char_u *)"";
16068 hlf_T attr = HLF_COUNT;
16069 int len = 0;
16071 if (rettv_list_alloc(rettv) == FAIL)
16072 return;
16074 #ifdef FEAT_SPELL
16075 if (argvars[0].v_type == VAR_UNKNOWN)
16077 /* Find the start and length of the badly spelled word. */
16078 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16079 if (len != 0)
16080 word = ml_get_cursor();
16082 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16084 char_u *str = get_tv_string_chk(&argvars[0]);
16085 int capcol = -1;
16087 if (str != NULL)
16089 /* Check the argument for spelling. */
16090 while (*str != NUL)
16092 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16093 if (attr != HLF_COUNT)
16095 word = str;
16096 break;
16098 str += len;
16102 #endif
16104 list_append_string(rettv->vval.v_list, word, len);
16105 list_append_string(rettv->vval.v_list, (char_u *)(
16106 attr == HLF_SPB ? "bad" :
16107 attr == HLF_SPR ? "rare" :
16108 attr == HLF_SPL ? "local" :
16109 attr == HLF_SPC ? "caps" :
16110 ""), -1);
16114 * "spellsuggest()" function
16116 static void
16117 f_spellsuggest(argvars, rettv)
16118 typval_T *argvars UNUSED;
16119 typval_T *rettv;
16121 #ifdef FEAT_SPELL
16122 char_u *str;
16123 int typeerr = FALSE;
16124 int maxcount;
16125 garray_T ga;
16126 int i;
16127 listitem_T *li;
16128 int need_capital = FALSE;
16129 #endif
16131 if (rettv_list_alloc(rettv) == FAIL)
16132 return;
16134 #ifdef FEAT_SPELL
16135 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16137 str = get_tv_string(&argvars[0]);
16138 if (argvars[1].v_type != VAR_UNKNOWN)
16140 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16141 if (maxcount <= 0)
16142 return;
16143 if (argvars[2].v_type != VAR_UNKNOWN)
16145 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16146 if (typeerr)
16147 return;
16150 else
16151 maxcount = 25;
16153 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16155 for (i = 0; i < ga.ga_len; ++i)
16157 str = ((char_u **)ga.ga_data)[i];
16159 li = listitem_alloc();
16160 if (li == NULL)
16161 vim_free(str);
16162 else
16164 li->li_tv.v_type = VAR_STRING;
16165 li->li_tv.v_lock = 0;
16166 li->li_tv.vval.v_string = str;
16167 list_append(rettv->vval.v_list, li);
16170 ga_clear(&ga);
16172 #endif
16175 static void
16176 f_split(argvars, rettv)
16177 typval_T *argvars;
16178 typval_T *rettv;
16180 char_u *str;
16181 char_u *end;
16182 char_u *pat = NULL;
16183 regmatch_T regmatch;
16184 char_u patbuf[NUMBUFLEN];
16185 char_u *save_cpo;
16186 int match;
16187 colnr_T col = 0;
16188 int keepempty = FALSE;
16189 int typeerr = FALSE;
16191 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16192 save_cpo = p_cpo;
16193 p_cpo = (char_u *)"";
16195 str = get_tv_string(&argvars[0]);
16196 if (argvars[1].v_type != VAR_UNKNOWN)
16198 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16199 if (pat == NULL)
16200 typeerr = TRUE;
16201 if (argvars[2].v_type != VAR_UNKNOWN)
16202 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16204 if (pat == NULL || *pat == NUL)
16205 pat = (char_u *)"[\\x01- ]\\+";
16207 if (rettv_list_alloc(rettv) == FAIL)
16208 return;
16209 if (typeerr)
16210 return;
16212 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16213 if (regmatch.regprog != NULL)
16215 regmatch.rm_ic = FALSE;
16216 while (*str != NUL || keepempty)
16218 if (*str == NUL)
16219 match = FALSE; /* empty item at the end */
16220 else
16221 match = vim_regexec_nl(&regmatch, str, col);
16222 if (match)
16223 end = regmatch.startp[0];
16224 else
16225 end = str + STRLEN(str);
16226 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16227 && *str != NUL && match && end < regmatch.endp[0]))
16229 if (list_append_string(rettv->vval.v_list, str,
16230 (int)(end - str)) == FAIL)
16231 break;
16233 if (!match)
16234 break;
16235 /* Advance to just after the match. */
16236 if (regmatch.endp[0] > str)
16237 col = 0;
16238 else
16240 /* Don't get stuck at the same match. */
16241 #ifdef FEAT_MBYTE
16242 col = (*mb_ptr2len)(regmatch.endp[0]);
16243 #else
16244 col = 1;
16245 #endif
16247 str = regmatch.endp[0];
16250 vim_free(regmatch.regprog);
16253 p_cpo = save_cpo;
16256 #ifdef FEAT_FLOAT
16258 * "sqrt()" function
16260 static void
16261 f_sqrt(argvars, rettv)
16262 typval_T *argvars;
16263 typval_T *rettv;
16265 float_T f;
16267 rettv->v_type = VAR_FLOAT;
16268 if (get_float_arg(argvars, &f) == OK)
16269 rettv->vval.v_float = sqrt(f);
16270 else
16271 rettv->vval.v_float = 0.0;
16275 * "str2float()" function
16277 static void
16278 f_str2float(argvars, rettv)
16279 typval_T *argvars;
16280 typval_T *rettv;
16282 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16284 if (*p == '+')
16285 p = skipwhite(p + 1);
16286 (void)string2float(p, &rettv->vval.v_float);
16287 rettv->v_type = VAR_FLOAT;
16289 #endif
16292 * "str2nr()" function
16294 static void
16295 f_str2nr(argvars, rettv)
16296 typval_T *argvars;
16297 typval_T *rettv;
16299 int base = 10;
16300 char_u *p;
16301 long n;
16303 if (argvars[1].v_type != VAR_UNKNOWN)
16305 base = get_tv_number(&argvars[1]);
16306 if (base != 8 && base != 10 && base != 16)
16308 EMSG(_(e_invarg));
16309 return;
16313 p = skipwhite(get_tv_string(&argvars[0]));
16314 if (*p == '+')
16315 p = skipwhite(p + 1);
16316 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16317 rettv->vval.v_number = n;
16320 #ifdef HAVE_STRFTIME
16322 * "strftime({format}[, {time}])" function
16324 static void
16325 f_strftime(argvars, rettv)
16326 typval_T *argvars;
16327 typval_T *rettv;
16329 char_u result_buf[256];
16330 struct tm *curtime;
16331 time_t seconds;
16332 char_u *p;
16334 rettv->v_type = VAR_STRING;
16336 p = get_tv_string(&argvars[0]);
16337 if (argvars[1].v_type == VAR_UNKNOWN)
16338 seconds = time(NULL);
16339 else
16340 seconds = (time_t)get_tv_number(&argvars[1]);
16341 curtime = localtime(&seconds);
16342 /* MSVC returns NULL for an invalid value of seconds. */
16343 if (curtime == NULL)
16344 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16345 else
16347 # ifdef FEAT_MBYTE
16348 vimconv_T conv;
16349 char_u *enc;
16351 conv.vc_type = CONV_NONE;
16352 enc = enc_locale();
16353 convert_setup(&conv, p_enc, enc);
16354 if (conv.vc_type != CONV_NONE)
16355 p = string_convert(&conv, p, NULL);
16356 # endif
16357 if (p != NULL)
16358 (void)strftime((char *)result_buf, sizeof(result_buf),
16359 (char *)p, curtime);
16360 else
16361 result_buf[0] = NUL;
16363 # ifdef FEAT_MBYTE
16364 if (conv.vc_type != CONV_NONE)
16365 vim_free(p);
16366 convert_setup(&conv, enc, p_enc);
16367 if (conv.vc_type != CONV_NONE)
16368 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16369 else
16370 # endif
16371 rettv->vval.v_string = vim_strsave(result_buf);
16373 # ifdef FEAT_MBYTE
16374 /* Release conversion descriptors */
16375 convert_setup(&conv, NULL, NULL);
16376 vim_free(enc);
16377 # endif
16380 #endif
16383 * "stridx()" function
16385 static void
16386 f_stridx(argvars, rettv)
16387 typval_T *argvars;
16388 typval_T *rettv;
16390 char_u buf[NUMBUFLEN];
16391 char_u *needle;
16392 char_u *haystack;
16393 char_u *save_haystack;
16394 char_u *pos;
16395 int start_idx;
16397 needle = get_tv_string_chk(&argvars[1]);
16398 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16399 rettv->vval.v_number = -1;
16400 if (needle == NULL || haystack == NULL)
16401 return; /* type error; errmsg already given */
16403 if (argvars[2].v_type != VAR_UNKNOWN)
16405 int error = FALSE;
16407 start_idx = get_tv_number_chk(&argvars[2], &error);
16408 if (error || start_idx >= (int)STRLEN(haystack))
16409 return;
16410 if (start_idx >= 0)
16411 haystack += start_idx;
16414 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16415 if (pos != NULL)
16416 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16420 * "string()" function
16422 static void
16423 f_string(argvars, rettv)
16424 typval_T *argvars;
16425 typval_T *rettv;
16427 char_u *tofree;
16428 char_u numbuf[NUMBUFLEN];
16430 rettv->v_type = VAR_STRING;
16431 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16432 /* Make a copy if we have a value but it's not in allocated memory. */
16433 if (rettv->vval.v_string != NULL && tofree == NULL)
16434 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16438 * "strlen()" function
16440 static void
16441 f_strlen(argvars, rettv)
16442 typval_T *argvars;
16443 typval_T *rettv;
16445 rettv->vval.v_number = (varnumber_T)(STRLEN(
16446 get_tv_string(&argvars[0])));
16450 * "strpart()" function
16452 static void
16453 f_strpart(argvars, rettv)
16454 typval_T *argvars;
16455 typval_T *rettv;
16457 char_u *p;
16458 int n;
16459 int len;
16460 int slen;
16461 int error = FALSE;
16463 p = get_tv_string(&argvars[0]);
16464 slen = (int)STRLEN(p);
16466 n = get_tv_number_chk(&argvars[1], &error);
16467 if (error)
16468 len = 0;
16469 else if (argvars[2].v_type != VAR_UNKNOWN)
16470 len = get_tv_number(&argvars[2]);
16471 else
16472 len = slen - n; /* default len: all bytes that are available. */
16475 * Only return the overlap between the specified part and the actual
16476 * string.
16478 if (n < 0)
16480 len += n;
16481 n = 0;
16483 else if (n > slen)
16484 n = slen;
16485 if (len < 0)
16486 len = 0;
16487 else if (n + len > slen)
16488 len = slen - n;
16490 rettv->v_type = VAR_STRING;
16491 rettv->vval.v_string = vim_strnsave(p + n, len);
16495 * "strridx()" function
16497 static void
16498 f_strridx(argvars, rettv)
16499 typval_T *argvars;
16500 typval_T *rettv;
16502 char_u buf[NUMBUFLEN];
16503 char_u *needle;
16504 char_u *haystack;
16505 char_u *rest;
16506 char_u *lastmatch = NULL;
16507 int haystack_len, end_idx;
16509 needle = get_tv_string_chk(&argvars[1]);
16510 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16512 rettv->vval.v_number = -1;
16513 if (needle == NULL || haystack == NULL)
16514 return; /* type error; errmsg already given */
16516 haystack_len = (int)STRLEN(haystack);
16517 if (argvars[2].v_type != VAR_UNKNOWN)
16519 /* Third argument: upper limit for index */
16520 end_idx = get_tv_number_chk(&argvars[2], NULL);
16521 if (end_idx < 0)
16522 return; /* can never find a match */
16524 else
16525 end_idx = haystack_len;
16527 if (*needle == NUL)
16529 /* Empty string matches past the end. */
16530 lastmatch = haystack + end_idx;
16532 else
16534 for (rest = haystack; *rest != '\0'; ++rest)
16536 rest = (char_u *)strstr((char *)rest, (char *)needle);
16537 if (rest == NULL || rest > haystack + end_idx)
16538 break;
16539 lastmatch = rest;
16543 if (lastmatch == NULL)
16544 rettv->vval.v_number = -1;
16545 else
16546 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16550 * "strtrans()" function
16552 static void
16553 f_strtrans(argvars, rettv)
16554 typval_T *argvars;
16555 typval_T *rettv;
16557 rettv->v_type = VAR_STRING;
16558 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16562 * "submatch()" function
16564 static void
16565 f_submatch(argvars, rettv)
16566 typval_T *argvars;
16567 typval_T *rettv;
16569 rettv->v_type = VAR_STRING;
16570 rettv->vval.v_string =
16571 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16575 * "substitute()" function
16577 static void
16578 f_substitute(argvars, rettv)
16579 typval_T *argvars;
16580 typval_T *rettv;
16582 char_u patbuf[NUMBUFLEN];
16583 char_u subbuf[NUMBUFLEN];
16584 char_u flagsbuf[NUMBUFLEN];
16586 char_u *str = get_tv_string_chk(&argvars[0]);
16587 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16588 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16589 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16591 rettv->v_type = VAR_STRING;
16592 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16593 rettv->vval.v_string = NULL;
16594 else
16595 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16599 * "synID(lnum, col, trans)" function
16601 static void
16602 f_synID(argvars, rettv)
16603 typval_T *argvars UNUSED;
16604 typval_T *rettv;
16606 int id = 0;
16607 #ifdef FEAT_SYN_HL
16608 long lnum;
16609 long col;
16610 int trans;
16611 int transerr = FALSE;
16613 lnum = get_tv_lnum(argvars); /* -1 on type error */
16614 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16615 trans = get_tv_number_chk(&argvars[2], &transerr);
16617 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16618 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16619 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16620 #endif
16622 rettv->vval.v_number = id;
16626 * "synIDattr(id, what [, mode])" function
16628 static void
16629 f_synIDattr(argvars, rettv)
16630 typval_T *argvars UNUSED;
16631 typval_T *rettv;
16633 char_u *p = NULL;
16634 #ifdef FEAT_SYN_HL
16635 int id;
16636 char_u *what;
16637 char_u *mode;
16638 char_u modebuf[NUMBUFLEN];
16639 int modec;
16641 id = get_tv_number(&argvars[0]);
16642 what = get_tv_string(&argvars[1]);
16643 if (argvars[2].v_type != VAR_UNKNOWN)
16645 mode = get_tv_string_buf(&argvars[2], modebuf);
16646 modec = TOLOWER_ASC(mode[0]);
16647 if (modec != 't' && modec != 'c'
16648 #ifdef FEAT_GUI
16649 && modec != 'g'
16650 #endif
16652 modec = 0; /* replace invalid with current */
16654 else
16656 #ifdef FEAT_GUI
16657 if (gui.in_use)
16658 modec = 'g';
16659 else
16660 #endif
16661 if (t_colors > 1)
16662 modec = 'c';
16663 else
16664 modec = 't';
16668 switch (TOLOWER_ASC(what[0]))
16670 case 'b':
16671 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16672 p = highlight_color(id, what, modec);
16673 else /* bold */
16674 p = highlight_has_attr(id, HL_BOLD, modec);
16675 break;
16677 case 'f': /* fg[#] or font */
16678 p = highlight_color(id, what, modec);
16679 break;
16681 case 'i':
16682 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16683 p = highlight_has_attr(id, HL_INVERSE, modec);
16684 else /* italic */
16685 p = highlight_has_attr(id, HL_ITALIC, modec);
16686 break;
16688 case 'n': /* name */
16689 p = get_highlight_name(NULL, id - 1);
16690 break;
16692 case 'r': /* reverse */
16693 p = highlight_has_attr(id, HL_INVERSE, modec);
16694 break;
16696 case 's':
16697 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16698 p = highlight_color(id, what, modec);
16699 else /* standout */
16700 p = highlight_has_attr(id, HL_STANDOUT, modec);
16701 break;
16703 case 'u':
16704 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16705 /* underline */
16706 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16707 else
16708 /* undercurl */
16709 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16710 break;
16713 if (p != NULL)
16714 p = vim_strsave(p);
16715 #endif
16716 rettv->v_type = VAR_STRING;
16717 rettv->vval.v_string = p;
16721 * "synIDtrans(id)" function
16723 static void
16724 f_synIDtrans(argvars, rettv)
16725 typval_T *argvars UNUSED;
16726 typval_T *rettv;
16728 int id;
16730 #ifdef FEAT_SYN_HL
16731 id = get_tv_number(&argvars[0]);
16733 if (id > 0)
16734 id = syn_get_final_id(id);
16735 else
16736 #endif
16737 id = 0;
16739 rettv->vval.v_number = id;
16743 * "synstack(lnum, col)" function
16745 static void
16746 f_synstack(argvars, rettv)
16747 typval_T *argvars UNUSED;
16748 typval_T *rettv;
16750 #ifdef FEAT_SYN_HL
16751 long lnum;
16752 long col;
16753 int i;
16754 int id;
16755 #endif
16757 rettv->v_type = VAR_LIST;
16758 rettv->vval.v_list = NULL;
16760 #ifdef FEAT_SYN_HL
16761 lnum = get_tv_lnum(argvars); /* -1 on type error */
16762 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16764 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16765 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16766 && rettv_list_alloc(rettv) != FAIL)
16768 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16769 for (i = 0; ; ++i)
16771 id = syn_get_stack_item(i);
16772 if (id < 0)
16773 break;
16774 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16775 break;
16778 #endif
16782 * "system()" function
16784 static void
16785 f_system(argvars, rettv)
16786 typval_T *argvars;
16787 typval_T *rettv;
16789 char_u *res = NULL;
16790 char_u *p;
16791 char_u *infile = NULL;
16792 char_u buf[NUMBUFLEN];
16793 int err = FALSE;
16794 FILE *fd;
16796 if (check_restricted() || check_secure())
16797 goto done;
16799 if (argvars[1].v_type != VAR_UNKNOWN)
16802 * Write the string to a temp file, to be used for input of the shell
16803 * command.
16805 if ((infile = vim_tempname('i')) == NULL)
16807 EMSG(_(e_notmp));
16808 goto done;
16811 fd = mch_fopen((char *)infile, WRITEBIN);
16812 if (fd == NULL)
16814 EMSG2(_(e_notopen), infile);
16815 goto done;
16817 p = get_tv_string_buf_chk(&argvars[1], buf);
16818 if (p == NULL)
16820 fclose(fd);
16821 goto done; /* type error; errmsg already given */
16823 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16824 err = TRUE;
16825 if (fclose(fd) != 0)
16826 err = TRUE;
16827 if (err)
16829 EMSG(_("E677: Error writing temp file"));
16830 goto done;
16834 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16835 SHELL_SILENT | SHELL_COOKED);
16837 #ifdef USE_CR
16838 /* translate <CR> into <NL> */
16839 if (res != NULL)
16841 char_u *s;
16843 for (s = res; *s; ++s)
16845 if (*s == CAR)
16846 *s = NL;
16849 #else
16850 # ifdef USE_CRNL
16851 /* translate <CR><NL> into <NL> */
16852 if (res != NULL)
16854 char_u *s, *d;
16856 d = res;
16857 for (s = res; *s; ++s)
16859 if (s[0] == CAR && s[1] == NL)
16860 ++s;
16861 *d++ = *s;
16863 *d = NUL;
16865 # endif
16866 #endif
16868 done:
16869 if (infile != NULL)
16871 mch_remove(infile);
16872 vim_free(infile);
16874 rettv->v_type = VAR_STRING;
16875 rettv->vval.v_string = res;
16879 * "tabpagebuflist()" function
16881 static void
16882 f_tabpagebuflist(argvars, rettv)
16883 typval_T *argvars UNUSED;
16884 typval_T *rettv UNUSED;
16886 #ifdef FEAT_WINDOWS
16887 tabpage_T *tp;
16888 win_T *wp = NULL;
16890 if (argvars[0].v_type == VAR_UNKNOWN)
16891 wp = firstwin;
16892 else
16894 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16895 if (tp != NULL)
16896 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16898 if (wp != NULL && rettv_list_alloc(rettv) != FAIL)
16900 for (; wp != NULL; wp = wp->w_next)
16901 if (list_append_number(rettv->vval.v_list,
16902 wp->w_buffer->b_fnum) == FAIL)
16903 break;
16905 #endif
16910 * "tabpagenr()" function
16912 static void
16913 f_tabpagenr(argvars, rettv)
16914 typval_T *argvars UNUSED;
16915 typval_T *rettv;
16917 int nr = 1;
16918 #ifdef FEAT_WINDOWS
16919 char_u *arg;
16921 if (argvars[0].v_type != VAR_UNKNOWN)
16923 arg = get_tv_string_chk(&argvars[0]);
16924 nr = 0;
16925 if (arg != NULL)
16927 if (STRCMP(arg, "$") == 0)
16928 nr = tabpage_index(NULL) - 1;
16929 else
16930 EMSG2(_(e_invexpr2), arg);
16933 else
16934 nr = tabpage_index(curtab);
16935 #endif
16936 rettv->vval.v_number = nr;
16940 #ifdef FEAT_WINDOWS
16941 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16944 * Common code for tabpagewinnr() and winnr().
16946 static int
16947 get_winnr(tp, argvar)
16948 tabpage_T *tp;
16949 typval_T *argvar;
16951 win_T *twin;
16952 int nr = 1;
16953 win_T *wp;
16954 char_u *arg;
16956 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16957 if (argvar->v_type != VAR_UNKNOWN)
16959 arg = get_tv_string_chk(argvar);
16960 if (arg == NULL)
16961 nr = 0; /* type error; errmsg already given */
16962 else if (STRCMP(arg, "$") == 0)
16963 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16964 else if (STRCMP(arg, "#") == 0)
16966 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16967 if (twin == NULL)
16968 nr = 0;
16970 else
16972 EMSG2(_(e_invexpr2), arg);
16973 nr = 0;
16977 if (nr > 0)
16978 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16979 wp != twin; wp = wp->w_next)
16981 if (wp == NULL)
16983 /* didn't find it in this tabpage */
16984 nr = 0;
16985 break;
16987 ++nr;
16989 return nr;
16991 #endif
16994 * "tabpagewinnr()" function
16996 static void
16997 f_tabpagewinnr(argvars, rettv)
16998 typval_T *argvars UNUSED;
16999 typval_T *rettv;
17001 int nr = 1;
17002 #ifdef FEAT_WINDOWS
17003 tabpage_T *tp;
17005 tp = find_tabpage((int)get_tv_number(&argvars[0]));
17006 if (tp == NULL)
17007 nr = 0;
17008 else
17009 nr = get_winnr(tp, &argvars[1]);
17010 #endif
17011 rettv->vval.v_number = nr;
17016 * "tagfiles()" function
17018 static void
17019 f_tagfiles(argvars, rettv)
17020 typval_T *argvars UNUSED;
17021 typval_T *rettv;
17023 char_u fname[MAXPATHL + 1];
17024 tagname_T tn;
17025 int first;
17027 if (rettv_list_alloc(rettv) == FAIL)
17028 return;
17030 for (first = TRUE; ; first = FALSE)
17031 if (get_tagfname(&tn, first, fname) == FAIL
17032 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
17033 break;
17034 tagname_free(&tn);
17038 * "taglist()" function
17040 static void
17041 f_taglist(argvars, rettv)
17042 typval_T *argvars;
17043 typval_T *rettv;
17045 char_u *tag_pattern;
17047 tag_pattern = get_tv_string(&argvars[0]);
17049 rettv->vval.v_number = FALSE;
17050 if (*tag_pattern == NUL)
17051 return;
17053 if (rettv_list_alloc(rettv) == OK)
17054 (void)get_tags(rettv->vval.v_list, tag_pattern);
17058 * "tempname()" function
17060 static void
17061 f_tempname(argvars, rettv)
17062 typval_T *argvars UNUSED;
17063 typval_T *rettv;
17065 static int x = 'A';
17067 rettv->v_type = VAR_STRING;
17068 rettv->vval.v_string = vim_tempname(x);
17070 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17071 * names. Skip 'I' and 'O', they are used for shell redirection. */
17074 if (x == 'Z')
17075 x = '0';
17076 else if (x == '9')
17077 x = 'A';
17078 else
17080 #ifdef EBCDIC
17081 if (x == 'I')
17082 x = 'J';
17083 else if (x == 'R')
17084 x = 'S';
17085 else
17086 #endif
17087 ++x;
17089 } while (x == 'I' || x == 'O');
17093 * "test(list)" function: Just checking the walls...
17095 static void
17096 f_test(argvars, rettv)
17097 typval_T *argvars UNUSED;
17098 typval_T *rettv UNUSED;
17100 /* Used for unit testing. Change the code below to your liking. */
17101 #if 0
17102 listitem_T *li;
17103 list_T *l;
17104 char_u *bad, *good;
17106 if (argvars[0].v_type != VAR_LIST)
17107 return;
17108 l = argvars[0].vval.v_list;
17109 if (l == NULL)
17110 return;
17111 li = l->lv_first;
17112 if (li == NULL)
17113 return;
17114 bad = get_tv_string(&li->li_tv);
17115 li = li->li_next;
17116 if (li == NULL)
17117 return;
17118 good = get_tv_string(&li->li_tv);
17119 rettv->vval.v_number = test_edit_score(bad, good);
17120 #endif
17124 * "tolower(string)" function
17126 static void
17127 f_tolower(argvars, rettv)
17128 typval_T *argvars;
17129 typval_T *rettv;
17131 char_u *p;
17133 p = vim_strsave(get_tv_string(&argvars[0]));
17134 rettv->v_type = VAR_STRING;
17135 rettv->vval.v_string = p;
17137 if (p != NULL)
17138 while (*p != NUL)
17140 #ifdef FEAT_MBYTE
17141 int l;
17143 if (enc_utf8)
17145 int c, lc;
17147 c = utf_ptr2char(p);
17148 lc = utf_tolower(c);
17149 l = utf_ptr2len(p);
17150 /* TODO: reallocate string when byte count changes. */
17151 if (utf_char2len(lc) == l)
17152 utf_char2bytes(lc, p);
17153 p += l;
17155 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17156 p += l; /* skip multi-byte character */
17157 else
17158 #endif
17160 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17161 ++p;
17167 * "toupper(string)" function
17169 static void
17170 f_toupper(argvars, rettv)
17171 typval_T *argvars;
17172 typval_T *rettv;
17174 rettv->v_type = VAR_STRING;
17175 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17179 * "tr(string, fromstr, tostr)" function
17181 static void
17182 f_tr(argvars, rettv)
17183 typval_T *argvars;
17184 typval_T *rettv;
17186 char_u *instr;
17187 char_u *fromstr;
17188 char_u *tostr;
17189 char_u *p;
17190 #ifdef FEAT_MBYTE
17191 int inlen;
17192 int fromlen;
17193 int tolen;
17194 int idx;
17195 char_u *cpstr;
17196 int cplen;
17197 int first = TRUE;
17198 #endif
17199 char_u buf[NUMBUFLEN];
17200 char_u buf2[NUMBUFLEN];
17201 garray_T ga;
17203 instr = get_tv_string(&argvars[0]);
17204 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17205 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17207 /* Default return value: empty string. */
17208 rettv->v_type = VAR_STRING;
17209 rettv->vval.v_string = NULL;
17210 if (fromstr == NULL || tostr == NULL)
17211 return; /* type error; errmsg already given */
17212 ga_init2(&ga, (int)sizeof(char), 80);
17214 #ifdef FEAT_MBYTE
17215 if (!has_mbyte)
17216 #endif
17217 /* not multi-byte: fromstr and tostr must be the same length */
17218 if (STRLEN(fromstr) != STRLEN(tostr))
17220 #ifdef FEAT_MBYTE
17221 error:
17222 #endif
17223 EMSG2(_(e_invarg2), fromstr);
17224 ga_clear(&ga);
17225 return;
17228 /* fromstr and tostr have to contain the same number of chars */
17229 while (*instr != NUL)
17231 #ifdef FEAT_MBYTE
17232 if (has_mbyte)
17234 inlen = (*mb_ptr2len)(instr);
17235 cpstr = instr;
17236 cplen = inlen;
17237 idx = 0;
17238 for (p = fromstr; *p != NUL; p += fromlen)
17240 fromlen = (*mb_ptr2len)(p);
17241 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17243 for (p = tostr; *p != NUL; p += tolen)
17245 tolen = (*mb_ptr2len)(p);
17246 if (idx-- == 0)
17248 cplen = tolen;
17249 cpstr = p;
17250 break;
17253 if (*p == NUL) /* tostr is shorter than fromstr */
17254 goto error;
17255 break;
17257 ++idx;
17260 if (first && cpstr == instr)
17262 /* Check that fromstr and tostr have the same number of
17263 * (multi-byte) characters. Done only once when a character
17264 * of instr doesn't appear in fromstr. */
17265 first = FALSE;
17266 for (p = tostr; *p != NUL; p += tolen)
17268 tolen = (*mb_ptr2len)(p);
17269 --idx;
17271 if (idx != 0)
17272 goto error;
17275 ga_grow(&ga, cplen);
17276 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17277 ga.ga_len += cplen;
17279 instr += inlen;
17281 else
17282 #endif
17284 /* When not using multi-byte chars we can do it faster. */
17285 p = vim_strchr(fromstr, *instr);
17286 if (p != NULL)
17287 ga_append(&ga, tostr[p - fromstr]);
17288 else
17289 ga_append(&ga, *instr);
17290 ++instr;
17294 /* add a terminating NUL */
17295 ga_grow(&ga, 1);
17296 ga_append(&ga, NUL);
17298 rettv->vval.v_string = ga.ga_data;
17301 #ifdef FEAT_FLOAT
17303 * "trunc({float})" function
17305 static void
17306 f_trunc(argvars, rettv)
17307 typval_T *argvars;
17308 typval_T *rettv;
17310 float_T f;
17312 rettv->v_type = VAR_FLOAT;
17313 if (get_float_arg(argvars, &f) == OK)
17314 /* trunc() is not in C90, use floor() or ceil() instead. */
17315 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17316 else
17317 rettv->vval.v_float = 0.0;
17319 #endif
17322 * "type(expr)" function
17324 static void
17325 f_type(argvars, rettv)
17326 typval_T *argvars;
17327 typval_T *rettv;
17329 int n;
17331 switch (argvars[0].v_type)
17333 case VAR_NUMBER: n = 0; break;
17334 case VAR_STRING: n = 1; break;
17335 case VAR_FUNC: n = 2; break;
17336 case VAR_LIST: n = 3; break;
17337 case VAR_DICT: n = 4; break;
17338 #ifdef FEAT_FLOAT
17339 case VAR_FLOAT: n = 5; break;
17340 #endif
17341 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17343 rettv->vval.v_number = n;
17347 * "values(dict)" function
17349 static void
17350 f_values(argvars, rettv)
17351 typval_T *argvars;
17352 typval_T *rettv;
17354 dict_list(argvars, rettv, 1);
17358 * "virtcol(string)" function
17360 static void
17361 f_virtcol(argvars, rettv)
17362 typval_T *argvars;
17363 typval_T *rettv;
17365 colnr_T vcol = 0;
17366 pos_T *fp;
17367 int fnum = curbuf->b_fnum;
17369 fp = var2fpos(&argvars[0], FALSE, &fnum);
17370 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17371 && fnum == curbuf->b_fnum)
17373 getvvcol(curwin, fp, NULL, NULL, &vcol);
17374 ++vcol;
17377 rettv->vval.v_number = vcol;
17381 * "visualmode()" function
17383 static void
17384 f_visualmode(argvars, rettv)
17385 typval_T *argvars UNUSED;
17386 typval_T *rettv UNUSED;
17388 #ifdef FEAT_VISUAL
17389 char_u str[2];
17391 rettv->v_type = VAR_STRING;
17392 str[0] = curbuf->b_visual_mode_eval;
17393 str[1] = NUL;
17394 rettv->vval.v_string = vim_strsave(str);
17396 /* A non-zero number or non-empty string argument: reset mode. */
17397 if (non_zero_arg(&argvars[0]))
17398 curbuf->b_visual_mode_eval = NUL;
17399 #endif
17403 * "winbufnr(nr)" function
17405 static void
17406 f_winbufnr(argvars, rettv)
17407 typval_T *argvars;
17408 typval_T *rettv;
17410 win_T *wp;
17412 wp = find_win_by_nr(&argvars[0], NULL);
17413 if (wp == NULL)
17414 rettv->vval.v_number = -1;
17415 else
17416 rettv->vval.v_number = wp->w_buffer->b_fnum;
17420 * "wincol()" function
17422 static void
17423 f_wincol(argvars, rettv)
17424 typval_T *argvars UNUSED;
17425 typval_T *rettv;
17427 validate_cursor();
17428 rettv->vval.v_number = curwin->w_wcol + 1;
17432 * "winheight(nr)" function
17434 static void
17435 f_winheight(argvars, rettv)
17436 typval_T *argvars;
17437 typval_T *rettv;
17439 win_T *wp;
17441 wp = find_win_by_nr(&argvars[0], NULL);
17442 if (wp == NULL)
17443 rettv->vval.v_number = -1;
17444 else
17445 rettv->vval.v_number = wp->w_height;
17449 * "winline()" function
17451 static void
17452 f_winline(argvars, rettv)
17453 typval_T *argvars UNUSED;
17454 typval_T *rettv;
17456 validate_cursor();
17457 rettv->vval.v_number = curwin->w_wrow + 1;
17461 * "winnr()" function
17463 static void
17464 f_winnr(argvars, rettv)
17465 typval_T *argvars UNUSED;
17466 typval_T *rettv;
17468 int nr = 1;
17470 #ifdef FEAT_WINDOWS
17471 nr = get_winnr(curtab, &argvars[0]);
17472 #endif
17473 rettv->vval.v_number = nr;
17477 * "winrestcmd()" function
17479 static void
17480 f_winrestcmd(argvars, rettv)
17481 typval_T *argvars UNUSED;
17482 typval_T *rettv;
17484 #ifdef FEAT_WINDOWS
17485 win_T *wp;
17486 int winnr = 1;
17487 garray_T ga;
17488 char_u buf[50];
17490 ga_init2(&ga, (int)sizeof(char), 70);
17491 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17493 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17494 ga_concat(&ga, buf);
17495 # ifdef FEAT_VERTSPLIT
17496 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17497 ga_concat(&ga, buf);
17498 # endif
17499 ++winnr;
17501 ga_append(&ga, NUL);
17503 rettv->vval.v_string = ga.ga_data;
17504 #else
17505 rettv->vval.v_string = NULL;
17506 #endif
17507 rettv->v_type = VAR_STRING;
17511 * "winrestview()" function
17513 static void
17514 f_winrestview(argvars, rettv)
17515 typval_T *argvars;
17516 typval_T *rettv UNUSED;
17518 dict_T *dict;
17520 if (argvars[0].v_type != VAR_DICT
17521 || (dict = argvars[0].vval.v_dict) == NULL)
17522 EMSG(_(e_invarg));
17523 else
17525 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17526 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17527 #ifdef FEAT_VIRTUALEDIT
17528 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17529 #endif
17530 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17531 curwin->w_set_curswant = FALSE;
17533 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17534 #ifdef FEAT_DIFF
17535 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17536 #endif
17537 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17538 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17540 check_cursor();
17541 changed_cline_bef_curs();
17542 invalidate_botline();
17543 redraw_later(VALID);
17545 if (curwin->w_topline == 0)
17546 curwin->w_topline = 1;
17547 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17548 curwin->w_topline = curbuf->b_ml.ml_line_count;
17549 #ifdef FEAT_DIFF
17550 check_topfill(curwin, TRUE);
17551 #endif
17556 * "winsaveview()" function
17558 static void
17559 f_winsaveview(argvars, rettv)
17560 typval_T *argvars UNUSED;
17561 typval_T *rettv;
17563 dict_T *dict;
17565 dict = dict_alloc();
17566 if (dict == NULL)
17567 return;
17568 rettv->v_type = VAR_DICT;
17569 rettv->vval.v_dict = dict;
17570 ++dict->dv_refcount;
17572 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17573 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17574 #ifdef FEAT_VIRTUALEDIT
17575 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17576 #endif
17577 update_curswant();
17578 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17580 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17581 #ifdef FEAT_DIFF
17582 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17583 #endif
17584 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17585 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17589 * "winwidth(nr)" function
17591 static void
17592 f_winwidth(argvars, rettv)
17593 typval_T *argvars;
17594 typval_T *rettv;
17596 win_T *wp;
17598 wp = find_win_by_nr(&argvars[0], NULL);
17599 if (wp == NULL)
17600 rettv->vval.v_number = -1;
17601 else
17602 #ifdef FEAT_VERTSPLIT
17603 rettv->vval.v_number = wp->w_width;
17604 #else
17605 rettv->vval.v_number = Columns;
17606 #endif
17610 * "writefile()" function
17612 static void
17613 f_writefile(argvars, rettv)
17614 typval_T *argvars;
17615 typval_T *rettv;
17617 int binary = FALSE;
17618 char_u *fname;
17619 FILE *fd;
17620 listitem_T *li;
17621 char_u *s;
17622 int ret = 0;
17623 int c;
17625 if (check_restricted() || check_secure())
17626 return;
17628 if (argvars[0].v_type != VAR_LIST)
17630 EMSG2(_(e_listarg), "writefile()");
17631 return;
17633 if (argvars[0].vval.v_list == NULL)
17634 return;
17636 if (argvars[2].v_type != VAR_UNKNOWN
17637 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17638 binary = TRUE;
17640 /* Always open the file in binary mode, library functions have a mind of
17641 * their own about CR-LF conversion. */
17642 fname = get_tv_string(&argvars[1]);
17643 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17645 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17646 ret = -1;
17648 else
17650 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17651 li = li->li_next)
17653 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17655 if (*s == '\n')
17656 c = putc(NUL, fd);
17657 else
17658 c = putc(*s, fd);
17659 if (c == EOF)
17661 ret = -1;
17662 break;
17665 if (!binary || li->li_next != NULL)
17666 if (putc('\n', fd) == EOF)
17668 ret = -1;
17669 break;
17671 if (ret < 0)
17673 EMSG(_(e_write));
17674 break;
17677 fclose(fd);
17680 rettv->vval.v_number = ret;
17684 * Translate a String variable into a position.
17685 * Returns NULL when there is an error.
17687 static pos_T *
17688 var2fpos(varp, dollar_lnum, fnum)
17689 typval_T *varp;
17690 int dollar_lnum; /* TRUE when $ is last line */
17691 int *fnum; /* set to fnum for '0, 'A, etc. */
17693 char_u *name;
17694 static pos_T pos;
17695 pos_T *pp;
17697 /* Argument can be [lnum, col, coladd]. */
17698 if (varp->v_type == VAR_LIST)
17700 list_T *l;
17701 int len;
17702 int error = FALSE;
17703 listitem_T *li;
17705 l = varp->vval.v_list;
17706 if (l == NULL)
17707 return NULL;
17709 /* Get the line number */
17710 pos.lnum = list_find_nr(l, 0L, &error);
17711 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17712 return NULL; /* invalid line number */
17714 /* Get the column number */
17715 pos.col = list_find_nr(l, 1L, &error);
17716 if (error)
17717 return NULL;
17718 len = (long)STRLEN(ml_get(pos.lnum));
17720 /* We accept "$" for the column number: last column. */
17721 li = list_find(l, 1L);
17722 if (li != NULL && li->li_tv.v_type == VAR_STRING
17723 && li->li_tv.vval.v_string != NULL
17724 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17725 pos.col = len + 1;
17727 /* Accept a position up to the NUL after the line. */
17728 if (pos.col == 0 || (int)pos.col > len + 1)
17729 return NULL; /* invalid column number */
17730 --pos.col;
17732 #ifdef FEAT_VIRTUALEDIT
17733 /* Get the virtual offset. Defaults to zero. */
17734 pos.coladd = list_find_nr(l, 2L, &error);
17735 if (error)
17736 pos.coladd = 0;
17737 #endif
17739 return &pos;
17742 name = get_tv_string_chk(varp);
17743 if (name == NULL)
17744 return NULL;
17745 if (name[0] == '.') /* cursor */
17746 return &curwin->w_cursor;
17747 #ifdef FEAT_VISUAL
17748 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17750 if (VIsual_active)
17751 return &VIsual;
17752 return &curwin->w_cursor;
17754 #endif
17755 if (name[0] == '\'') /* mark */
17757 pp = getmark_fnum(name[1], FALSE, fnum);
17758 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17759 return NULL;
17760 return pp;
17763 #ifdef FEAT_VIRTUALEDIT
17764 pos.coladd = 0;
17765 #endif
17767 if (name[0] == 'w' && dollar_lnum)
17769 pos.col = 0;
17770 if (name[1] == '0') /* "w0": first visible line */
17772 update_topline();
17773 pos.lnum = curwin->w_topline;
17774 return &pos;
17776 else if (name[1] == '$') /* "w$": last visible line */
17778 validate_botline();
17779 pos.lnum = curwin->w_botline - 1;
17780 return &pos;
17783 else if (name[0] == '$') /* last column or line */
17785 if (dollar_lnum)
17787 pos.lnum = curbuf->b_ml.ml_line_count;
17788 pos.col = 0;
17790 else
17792 pos.lnum = curwin->w_cursor.lnum;
17793 pos.col = (colnr_T)STRLEN(ml_get_curline());
17795 return &pos;
17797 return NULL;
17801 * Convert list in "arg" into a position and optional file number.
17802 * When "fnump" is NULL there is no file number, only 3 items.
17803 * Note that the column is passed on as-is, the caller may want to decrement
17804 * it to use 1 for the first column.
17805 * Return FAIL when conversion is not possible, doesn't check the position for
17806 * validity.
17808 static int
17809 list2fpos(arg, posp, fnump)
17810 typval_T *arg;
17811 pos_T *posp;
17812 int *fnump;
17814 list_T *l = arg->vval.v_list;
17815 long i = 0;
17816 long n;
17818 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17819 * when "fnump" isn't NULL and "coladd" is optional. */
17820 if (arg->v_type != VAR_LIST
17821 || l == NULL
17822 || l->lv_len < (fnump == NULL ? 2 : 3)
17823 || l->lv_len > (fnump == NULL ? 3 : 4))
17824 return FAIL;
17826 if (fnump != NULL)
17828 n = list_find_nr(l, i++, NULL); /* fnum */
17829 if (n < 0)
17830 return FAIL;
17831 if (n == 0)
17832 n = curbuf->b_fnum; /* current buffer */
17833 *fnump = n;
17836 n = list_find_nr(l, i++, NULL); /* lnum */
17837 if (n < 0)
17838 return FAIL;
17839 posp->lnum = n;
17841 n = list_find_nr(l, i++, NULL); /* col */
17842 if (n < 0)
17843 return FAIL;
17844 posp->col = n;
17846 #ifdef FEAT_VIRTUALEDIT
17847 n = list_find_nr(l, i, NULL);
17848 if (n < 0)
17849 posp->coladd = 0;
17850 else
17851 posp->coladd = n;
17852 #endif
17854 return OK;
17858 * Get the length of an environment variable name.
17859 * Advance "arg" to the first character after the name.
17860 * Return 0 for error.
17862 static int
17863 get_env_len(arg)
17864 char_u **arg;
17866 char_u *p;
17867 int len;
17869 for (p = *arg; vim_isIDc(*p); ++p)
17871 if (p == *arg) /* no name found */
17872 return 0;
17874 len = (int)(p - *arg);
17875 *arg = p;
17876 return len;
17880 * Get the length of the name of a function or internal variable.
17881 * "arg" is advanced to the first non-white character after the name.
17882 * Return 0 if something is wrong.
17884 static int
17885 get_id_len(arg)
17886 char_u **arg;
17888 char_u *p;
17889 int len;
17891 /* Find the end of the name. */
17892 for (p = *arg; eval_isnamec(*p); ++p)
17894 if (p == *arg) /* no name found */
17895 return 0;
17897 len = (int)(p - *arg);
17898 *arg = skipwhite(p);
17900 return len;
17904 * Get the length of the name of a variable or function.
17905 * Only the name is recognized, does not handle ".key" or "[idx]".
17906 * "arg" is advanced to the first non-white character after the name.
17907 * Return -1 if curly braces expansion failed.
17908 * Return 0 if something else is wrong.
17909 * If the name contains 'magic' {}'s, expand them and return the
17910 * expanded name in an allocated string via 'alias' - caller must free.
17912 static int
17913 get_name_len(arg, alias, evaluate, verbose)
17914 char_u **arg;
17915 char_u **alias;
17916 int evaluate;
17917 int verbose;
17919 int len;
17920 char_u *p;
17921 char_u *expr_start;
17922 char_u *expr_end;
17924 *alias = NULL; /* default to no alias */
17926 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17927 && (*arg)[2] == (int)KE_SNR)
17929 /* hard coded <SNR>, already translated */
17930 *arg += 3;
17931 return get_id_len(arg) + 3;
17933 len = eval_fname_script(*arg);
17934 if (len > 0)
17936 /* literal "<SID>", "s:" or "<SNR>" */
17937 *arg += len;
17941 * Find the end of the name; check for {} construction.
17943 p = find_name_end(*arg, &expr_start, &expr_end,
17944 len > 0 ? 0 : FNE_CHECK_START);
17945 if (expr_start != NULL)
17947 char_u *temp_string;
17949 if (!evaluate)
17951 len += (int)(p - *arg);
17952 *arg = skipwhite(p);
17953 return len;
17957 * Include any <SID> etc in the expanded string:
17958 * Thus the -len here.
17960 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17961 if (temp_string == NULL)
17962 return -1;
17963 *alias = temp_string;
17964 *arg = skipwhite(p);
17965 return (int)STRLEN(temp_string);
17968 len += get_id_len(arg);
17969 if (len == 0 && verbose)
17970 EMSG2(_(e_invexpr2), *arg);
17972 return len;
17976 * Find the end of a variable or function name, taking care of magic braces.
17977 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17978 * start and end of the first magic braces item.
17979 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17980 * Return a pointer to just after the name. Equal to "arg" if there is no
17981 * valid name.
17983 static char_u *
17984 find_name_end(arg, expr_start, expr_end, flags)
17985 char_u *arg;
17986 char_u **expr_start;
17987 char_u **expr_end;
17988 int flags;
17990 int mb_nest = 0;
17991 int br_nest = 0;
17992 char_u *p;
17994 if (expr_start != NULL)
17996 *expr_start = NULL;
17997 *expr_end = NULL;
18000 /* Quick check for valid starting character. */
18001 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
18002 return arg;
18004 for (p = arg; *p != NUL
18005 && (eval_isnamec(*p)
18006 || *p == '{'
18007 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
18008 || mb_nest != 0
18009 || br_nest != 0); mb_ptr_adv(p))
18011 if (*p == '\'')
18013 /* skip over 'string' to avoid counting [ and ] inside it. */
18014 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
18016 if (*p == NUL)
18017 break;
18019 else if (*p == '"')
18021 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
18022 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
18023 if (*p == '\\' && p[1] != NUL)
18024 ++p;
18025 if (*p == NUL)
18026 break;
18029 if (mb_nest == 0)
18031 if (*p == '[')
18032 ++br_nest;
18033 else if (*p == ']')
18034 --br_nest;
18037 if (br_nest == 0)
18039 if (*p == '{')
18041 mb_nest++;
18042 if (expr_start != NULL && *expr_start == NULL)
18043 *expr_start = p;
18045 else if (*p == '}')
18047 mb_nest--;
18048 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18049 *expr_end = p;
18054 return p;
18058 * Expands out the 'magic' {}'s in a variable/function name.
18059 * Note that this can call itself recursively, to deal with
18060 * constructs like foo{bar}{baz}{bam}
18061 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18062 * "in_start" ^
18063 * "expr_start" ^
18064 * "expr_end" ^
18065 * "in_end" ^
18067 * Returns a new allocated string, which the caller must free.
18068 * Returns NULL for failure.
18070 static char_u *
18071 make_expanded_name(in_start, expr_start, expr_end, in_end)
18072 char_u *in_start;
18073 char_u *expr_start;
18074 char_u *expr_end;
18075 char_u *in_end;
18077 char_u c1;
18078 char_u *retval = NULL;
18079 char_u *temp_result;
18080 char_u *nextcmd = NULL;
18082 if (expr_end == NULL || in_end == NULL)
18083 return NULL;
18084 *expr_start = NUL;
18085 *expr_end = NUL;
18086 c1 = *in_end;
18087 *in_end = NUL;
18089 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18090 if (temp_result != NULL && nextcmd == NULL)
18092 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18093 + (in_end - expr_end) + 1));
18094 if (retval != NULL)
18096 STRCPY(retval, in_start);
18097 STRCAT(retval, temp_result);
18098 STRCAT(retval, expr_end + 1);
18101 vim_free(temp_result);
18103 *in_end = c1; /* put char back for error messages */
18104 *expr_start = '{';
18105 *expr_end = '}';
18107 if (retval != NULL)
18109 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18110 if (expr_start != NULL)
18112 /* Further expansion! */
18113 temp_result = make_expanded_name(retval, expr_start,
18114 expr_end, temp_result);
18115 vim_free(retval);
18116 retval = temp_result;
18120 return retval;
18124 * Return TRUE if character "c" can be used in a variable or function name.
18125 * Does not include '{' or '}' for magic braces.
18127 static int
18128 eval_isnamec(c)
18129 int c;
18131 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18135 * Return TRUE if character "c" can be used as the first character in a
18136 * variable or function name (excluding '{' and '}').
18138 static int
18139 eval_isnamec1(c)
18140 int c;
18142 return (ASCII_ISALPHA(c) || c == '_');
18146 * Set number v: variable to "val".
18148 void
18149 set_vim_var_nr(idx, val)
18150 int idx;
18151 long val;
18153 vimvars[idx].vv_nr = val;
18157 * Get number v: variable value.
18159 long
18160 get_vim_var_nr(idx)
18161 int idx;
18163 return vimvars[idx].vv_nr;
18167 * Get string v: variable value. Uses a static buffer, can only be used once.
18169 char_u *
18170 get_vim_var_str(idx)
18171 int idx;
18173 return get_tv_string(&vimvars[idx].vv_tv);
18177 * Get List v: variable value. Caller must take care of reference count when
18178 * needed.
18180 list_T *
18181 get_vim_var_list(idx)
18182 int idx;
18184 return vimvars[idx].vv_list;
18188 * Set v:char to character "c".
18190 void
18191 set_vim_var_char(c)
18192 int c;
18194 #ifdef FEAT_MBYTE
18195 char_u buf[MB_MAXBYTES];
18196 #else
18197 char_u buf[2];
18198 #endif
18200 #ifdef FEAT_MBYTE
18201 if (has_mbyte)
18202 buf[(*mb_char2bytes)(c, buf)] = NUL;
18203 else
18204 #endif
18206 buf[0] = c;
18207 buf[1] = NUL;
18209 set_vim_var_string(VV_CHAR, buf, -1);
18213 * Set v:count to "count" and v:count1 to "count1".
18214 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18216 void
18217 set_vcount(count, count1, set_prevcount)
18218 long count;
18219 long count1;
18220 int set_prevcount;
18222 if (set_prevcount)
18223 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18224 vimvars[VV_COUNT].vv_nr = count;
18225 vimvars[VV_COUNT1].vv_nr = count1;
18229 * Set string v: variable to a copy of "val".
18231 void
18232 set_vim_var_string(idx, val, len)
18233 int idx;
18234 char_u *val;
18235 int len; /* length of "val" to use or -1 (whole string) */
18237 /* Need to do this (at least) once, since we can't initialize a union.
18238 * Will always be invoked when "v:progname" is set. */
18239 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18241 vim_free(vimvars[idx].vv_str);
18242 if (val == NULL)
18243 vimvars[idx].vv_str = NULL;
18244 else if (len == -1)
18245 vimvars[idx].vv_str = vim_strsave(val);
18246 else
18247 vimvars[idx].vv_str = vim_strnsave(val, len);
18251 * Set List v: variable to "val".
18253 void
18254 set_vim_var_list(idx, val)
18255 int idx;
18256 list_T *val;
18258 list_unref(vimvars[idx].vv_list);
18259 vimvars[idx].vv_list = val;
18260 if (val != NULL)
18261 ++val->lv_refcount;
18265 * Set v:register if needed.
18267 void
18268 set_reg_var(c)
18269 int c;
18271 char_u regname;
18273 if (c == 0 || c == ' ')
18274 regname = '"';
18275 else
18276 regname = c;
18277 /* Avoid free/alloc when the value is already right. */
18278 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18279 set_vim_var_string(VV_REG, &regname, 1);
18283 * Get or set v:exception. If "oldval" == NULL, return the current value.
18284 * Otherwise, restore the value to "oldval" and return NULL.
18285 * Must always be called in pairs to save and restore v:exception! Does not
18286 * take care of memory allocations.
18288 char_u *
18289 v_exception(oldval)
18290 char_u *oldval;
18292 if (oldval == NULL)
18293 return vimvars[VV_EXCEPTION].vv_str;
18295 vimvars[VV_EXCEPTION].vv_str = oldval;
18296 return NULL;
18300 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18301 * Otherwise, restore the value to "oldval" and return NULL.
18302 * Must always be called in pairs to save and restore v:throwpoint! Does not
18303 * take care of memory allocations.
18305 char_u *
18306 v_throwpoint(oldval)
18307 char_u *oldval;
18309 if (oldval == NULL)
18310 return vimvars[VV_THROWPOINT].vv_str;
18312 vimvars[VV_THROWPOINT].vv_str = oldval;
18313 return NULL;
18316 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18318 * Set v:cmdarg.
18319 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18320 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18321 * Must always be called in pairs!
18323 char_u *
18324 set_cmdarg(eap, oldarg)
18325 exarg_T *eap;
18326 char_u *oldarg;
18328 char_u *oldval;
18329 char_u *newval;
18330 unsigned len;
18332 oldval = vimvars[VV_CMDARG].vv_str;
18333 if (eap == NULL)
18335 vim_free(oldval);
18336 vimvars[VV_CMDARG].vv_str = oldarg;
18337 return NULL;
18340 if (eap->force_bin == FORCE_BIN)
18341 len = 6;
18342 else if (eap->force_bin == FORCE_NOBIN)
18343 len = 8;
18344 else
18345 len = 0;
18347 if (eap->read_edit)
18348 len += 7;
18350 if (eap->force_ff != 0)
18351 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18352 # ifdef FEAT_MBYTE
18353 if (eap->force_enc != 0)
18354 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18355 if (eap->bad_char != 0)
18356 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18357 # endif
18359 newval = alloc(len + 1);
18360 if (newval == NULL)
18361 return NULL;
18363 if (eap->force_bin == FORCE_BIN)
18364 sprintf((char *)newval, " ++bin");
18365 else if (eap->force_bin == FORCE_NOBIN)
18366 sprintf((char *)newval, " ++nobin");
18367 else
18368 *newval = NUL;
18370 if (eap->read_edit)
18371 STRCAT(newval, " ++edit");
18373 if (eap->force_ff != 0)
18374 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18375 eap->cmd + eap->force_ff);
18376 # ifdef FEAT_MBYTE
18377 if (eap->force_enc != 0)
18378 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18379 eap->cmd + eap->force_enc);
18380 if (eap->bad_char != 0)
18381 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18382 eap->cmd + eap->bad_char);
18383 # endif
18384 vimvars[VV_CMDARG].vv_str = newval;
18385 return oldval;
18387 #endif
18390 * Get the value of internal variable "name".
18391 * Return OK or FAIL.
18393 static int
18394 get_var_tv(name, len, rettv, verbose)
18395 char_u *name;
18396 int len; /* length of "name" */
18397 typval_T *rettv; /* NULL when only checking existence */
18398 int verbose; /* may give error message */
18400 int ret = OK;
18401 typval_T *tv = NULL;
18402 typval_T atv;
18403 dictitem_T *v;
18404 int cc;
18406 /* truncate the name, so that we can use strcmp() */
18407 cc = name[len];
18408 name[len] = NUL;
18411 * Check for "b:changedtick".
18413 if (STRCMP(name, "b:changedtick") == 0)
18415 atv.v_type = VAR_NUMBER;
18416 atv.vval.v_number = curbuf->b_changedtick;
18417 tv = &atv;
18421 * Check for user-defined variables.
18423 else
18425 v = find_var(name, NULL);
18426 if (v != NULL)
18427 tv = &v->di_tv;
18430 if (tv == NULL)
18432 if (rettv != NULL && verbose)
18433 EMSG2(_(e_undefvar), name);
18434 ret = FAIL;
18436 else if (rettv != NULL)
18437 copy_tv(tv, rettv);
18439 name[len] = cc;
18441 return ret;
18445 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18446 * Also handle function call with Funcref variable: func(expr)
18447 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18449 static int
18450 handle_subscript(arg, rettv, evaluate, verbose)
18451 char_u **arg;
18452 typval_T *rettv;
18453 int evaluate; /* do more than finding the end */
18454 int verbose; /* give error messages */
18456 int ret = OK;
18457 dict_T *selfdict = NULL;
18458 char_u *s;
18459 int len;
18460 typval_T functv;
18462 while (ret == OK
18463 && (**arg == '['
18464 || (**arg == '.' && rettv->v_type == VAR_DICT)
18465 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18466 && !vim_iswhite(*(*arg - 1)))
18468 if (**arg == '(')
18470 /* need to copy the funcref so that we can clear rettv */
18471 functv = *rettv;
18472 rettv->v_type = VAR_UNKNOWN;
18474 /* Invoke the function. Recursive! */
18475 s = functv.vval.v_string;
18476 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18477 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18478 &len, evaluate, selfdict);
18480 /* Clear the funcref afterwards, so that deleting it while
18481 * evaluating the arguments is possible (see test55). */
18482 clear_tv(&functv);
18484 /* Stop the expression evaluation when immediately aborting on
18485 * error, or when an interrupt occurred or an exception was thrown
18486 * but not caught. */
18487 if (aborting())
18489 if (ret == OK)
18490 clear_tv(rettv);
18491 ret = FAIL;
18493 dict_unref(selfdict);
18494 selfdict = NULL;
18496 else /* **arg == '[' || **arg == '.' */
18498 dict_unref(selfdict);
18499 if (rettv->v_type == VAR_DICT)
18501 selfdict = rettv->vval.v_dict;
18502 if (selfdict != NULL)
18503 ++selfdict->dv_refcount;
18505 else
18506 selfdict = NULL;
18507 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18509 clear_tv(rettv);
18510 ret = FAIL;
18514 dict_unref(selfdict);
18515 return ret;
18519 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18520 * value).
18522 static typval_T *
18523 alloc_tv()
18525 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18529 * Allocate memory for a variable type-value, and assign a string to it.
18530 * The string "s" must have been allocated, it is consumed.
18531 * Return NULL for out of memory, the variable otherwise.
18533 static typval_T *
18534 alloc_string_tv(s)
18535 char_u *s;
18537 typval_T *rettv;
18539 rettv = alloc_tv();
18540 if (rettv != NULL)
18542 rettv->v_type = VAR_STRING;
18543 rettv->vval.v_string = s;
18545 else
18546 vim_free(s);
18547 return rettv;
18551 * Free the memory for a variable type-value.
18553 void
18554 free_tv(varp)
18555 typval_T *varp;
18557 if (varp != NULL)
18559 switch (varp->v_type)
18561 case VAR_FUNC:
18562 func_unref(varp->vval.v_string);
18563 /*FALLTHROUGH*/
18564 case VAR_STRING:
18565 vim_free(varp->vval.v_string);
18566 break;
18567 case VAR_LIST:
18568 list_unref(varp->vval.v_list);
18569 break;
18570 case VAR_DICT:
18571 dict_unref(varp->vval.v_dict);
18572 break;
18573 case VAR_NUMBER:
18574 #ifdef FEAT_FLOAT
18575 case VAR_FLOAT:
18576 #endif
18577 case VAR_UNKNOWN:
18578 break;
18579 default:
18580 EMSG2(_(e_intern2), "free_tv()");
18581 break;
18583 vim_free(varp);
18588 * Free the memory for a variable value and set the value to NULL or 0.
18590 void
18591 clear_tv(varp)
18592 typval_T *varp;
18594 if (varp != NULL)
18596 switch (varp->v_type)
18598 case VAR_FUNC:
18599 func_unref(varp->vval.v_string);
18600 /*FALLTHROUGH*/
18601 case VAR_STRING:
18602 vim_free(varp->vval.v_string);
18603 varp->vval.v_string = NULL;
18604 break;
18605 case VAR_LIST:
18606 list_unref(varp->vval.v_list);
18607 varp->vval.v_list = NULL;
18608 break;
18609 case VAR_DICT:
18610 dict_unref(varp->vval.v_dict);
18611 varp->vval.v_dict = NULL;
18612 break;
18613 case VAR_NUMBER:
18614 varp->vval.v_number = 0;
18615 break;
18616 #ifdef FEAT_FLOAT
18617 case VAR_FLOAT:
18618 varp->vval.v_float = 0.0;
18619 break;
18620 #endif
18621 case VAR_UNKNOWN:
18622 break;
18623 default:
18624 EMSG2(_(e_intern2), "clear_tv()");
18626 varp->v_lock = 0;
18631 * Set the value of a variable to NULL without freeing items.
18633 static void
18634 init_tv(varp)
18635 typval_T *varp;
18637 if (varp != NULL)
18638 vim_memset(varp, 0, sizeof(typval_T));
18642 * Get the number value of a variable.
18643 * If it is a String variable, uses vim_str2nr().
18644 * For incompatible types, return 0.
18645 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18646 * caller of incompatible types: it sets *denote to TRUE if "denote"
18647 * is not NULL or returns -1 otherwise.
18649 static long
18650 get_tv_number(varp)
18651 typval_T *varp;
18653 int error = FALSE;
18655 return get_tv_number_chk(varp, &error); /* return 0L on error */
18658 long
18659 get_tv_number_chk(varp, denote)
18660 typval_T *varp;
18661 int *denote;
18663 long n = 0L;
18665 switch (varp->v_type)
18667 case VAR_NUMBER:
18668 return (long)(varp->vval.v_number);
18669 #ifdef FEAT_FLOAT
18670 case VAR_FLOAT:
18671 EMSG(_("E805: Using a Float as a Number"));
18672 break;
18673 #endif
18674 case VAR_FUNC:
18675 EMSG(_("E703: Using a Funcref as a Number"));
18676 break;
18677 case VAR_STRING:
18678 if (varp->vval.v_string != NULL)
18679 vim_str2nr(varp->vval.v_string, NULL, NULL,
18680 TRUE, TRUE, &n, NULL);
18681 return n;
18682 case VAR_LIST:
18683 EMSG(_("E745: Using a List as a Number"));
18684 break;
18685 case VAR_DICT:
18686 EMSG(_("E728: Using a Dictionary as a Number"));
18687 break;
18688 default:
18689 EMSG2(_(e_intern2), "get_tv_number()");
18690 break;
18692 if (denote == NULL) /* useful for values that must be unsigned */
18693 n = -1;
18694 else
18695 *denote = TRUE;
18696 return n;
18700 * Get the lnum from the first argument.
18701 * Also accepts ".", "$", etc., but that only works for the current buffer.
18702 * Returns -1 on error.
18704 static linenr_T
18705 get_tv_lnum(argvars)
18706 typval_T *argvars;
18708 typval_T rettv;
18709 linenr_T lnum;
18711 lnum = get_tv_number_chk(&argvars[0], NULL);
18712 if (lnum == 0) /* no valid number, try using line() */
18714 rettv.v_type = VAR_NUMBER;
18715 f_line(argvars, &rettv);
18716 lnum = rettv.vval.v_number;
18717 clear_tv(&rettv);
18719 return lnum;
18723 * Get the lnum from the first argument.
18724 * Also accepts "$", then "buf" is used.
18725 * Returns 0 on error.
18727 static linenr_T
18728 get_tv_lnum_buf(argvars, buf)
18729 typval_T *argvars;
18730 buf_T *buf;
18732 if (argvars[0].v_type == VAR_STRING
18733 && argvars[0].vval.v_string != NULL
18734 && argvars[0].vval.v_string[0] == '$'
18735 && buf != NULL)
18736 return buf->b_ml.ml_line_count;
18737 return get_tv_number_chk(&argvars[0], NULL);
18741 * Get the string value of a variable.
18742 * If it is a Number variable, the number is converted into a string.
18743 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18744 * get_tv_string_buf() uses a given buffer.
18745 * If the String variable has never been set, return an empty string.
18746 * Never returns NULL;
18747 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18748 * NULL on error.
18750 static char_u *
18751 get_tv_string(varp)
18752 typval_T *varp;
18754 static char_u mybuf[NUMBUFLEN];
18756 return get_tv_string_buf(varp, mybuf);
18759 static char_u *
18760 get_tv_string_buf(varp, buf)
18761 typval_T *varp;
18762 char_u *buf;
18764 char_u *res = get_tv_string_buf_chk(varp, buf);
18766 return res != NULL ? res : (char_u *)"";
18769 char_u *
18770 get_tv_string_chk(varp)
18771 typval_T *varp;
18773 static char_u mybuf[NUMBUFLEN];
18775 return get_tv_string_buf_chk(varp, mybuf);
18778 static char_u *
18779 get_tv_string_buf_chk(varp, buf)
18780 typval_T *varp;
18781 char_u *buf;
18783 switch (varp->v_type)
18785 case VAR_NUMBER:
18786 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18787 return buf;
18788 case VAR_FUNC:
18789 EMSG(_("E729: using Funcref as a String"));
18790 break;
18791 case VAR_LIST:
18792 EMSG(_("E730: using List as a String"));
18793 break;
18794 case VAR_DICT:
18795 EMSG(_("E731: using Dictionary as a String"));
18796 break;
18797 #ifdef FEAT_FLOAT
18798 case VAR_FLOAT:
18799 EMSG(_("E806: using Float as a String"));
18800 break;
18801 #endif
18802 case VAR_STRING:
18803 if (varp->vval.v_string != NULL)
18804 return varp->vval.v_string;
18805 return (char_u *)"";
18806 default:
18807 EMSG2(_(e_intern2), "get_tv_string_buf()");
18808 break;
18810 return NULL;
18814 * Find variable "name" in the list of variables.
18815 * Return a pointer to it if found, NULL if not found.
18816 * Careful: "a:0" variables don't have a name.
18817 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18818 * hashtab_T used.
18820 static dictitem_T *
18821 find_var(name, htp)
18822 char_u *name;
18823 hashtab_T **htp;
18825 char_u *varname;
18826 hashtab_T *ht;
18828 ht = find_var_ht(name, &varname);
18829 if (htp != NULL)
18830 *htp = ht;
18831 if (ht == NULL)
18832 return NULL;
18833 return find_var_in_ht(ht, varname, htp != NULL);
18837 * Find variable "varname" in hashtab "ht".
18838 * Returns NULL if not found.
18840 static dictitem_T *
18841 find_var_in_ht(ht, varname, writing)
18842 hashtab_T *ht;
18843 char_u *varname;
18844 int writing;
18846 hashitem_T *hi;
18848 if (*varname == NUL)
18850 /* Must be something like "s:", otherwise "ht" would be NULL. */
18851 switch (varname[-2])
18853 case 's': return &SCRIPT_SV(current_SID).sv_var;
18854 case 'g': return &globvars_var;
18855 case 'v': return &vimvars_var;
18856 case 'b': return &curbuf->b_bufvar;
18857 case 'w': return &curwin->w_winvar;
18858 #ifdef FEAT_WINDOWS
18859 case 't': return &curtab->tp_winvar;
18860 #endif
18861 case 'l': return current_funccal == NULL
18862 ? NULL : &current_funccal->l_vars_var;
18863 case 'a': return current_funccal == NULL
18864 ? NULL : &current_funccal->l_avars_var;
18866 return NULL;
18869 hi = hash_find(ht, varname);
18870 if (HASHITEM_EMPTY(hi))
18872 /* For global variables we may try auto-loading the script. If it
18873 * worked find the variable again. Don't auto-load a script if it was
18874 * loaded already, otherwise it would be loaded every time when
18875 * checking if a function name is a Funcref variable. */
18876 if (ht == &globvarht && !writing
18877 && script_autoload(varname, FALSE) && !aborting())
18878 hi = hash_find(ht, varname);
18879 if (HASHITEM_EMPTY(hi))
18880 return NULL;
18882 return HI2DI(hi);
18886 * Find the hashtab used for a variable name.
18887 * Set "varname" to the start of name without ':'.
18889 static hashtab_T *
18890 find_var_ht(name, varname)
18891 char_u *name;
18892 char_u **varname;
18894 hashitem_T *hi;
18896 if (name[1] != ':')
18898 /* The name must not start with a colon or #. */
18899 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18900 return NULL;
18901 *varname = name;
18903 /* "version" is "v:version" in all scopes */
18904 hi = hash_find(&compat_hashtab, name);
18905 if (!HASHITEM_EMPTY(hi))
18906 return &compat_hashtab;
18908 if (current_funccal == NULL)
18909 return &globvarht; /* global variable */
18910 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18912 *varname = name + 2;
18913 if (*name == 'g') /* global variable */
18914 return &globvarht;
18915 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18917 if (vim_strchr(name + 2, ':') != NULL
18918 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18919 return NULL;
18920 if (*name == 'b') /* buffer variable */
18921 return &curbuf->b_vars.dv_hashtab;
18922 if (*name == 'w') /* window variable */
18923 return &curwin->w_vars.dv_hashtab;
18924 #ifdef FEAT_WINDOWS
18925 if (*name == 't') /* tab page variable */
18926 return &curtab->tp_vars.dv_hashtab;
18927 #endif
18928 if (*name == 'v') /* v: variable */
18929 return &vimvarht;
18930 if (*name == 'a' && current_funccal != NULL) /* function argument */
18931 return &current_funccal->l_avars.dv_hashtab;
18932 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18933 return &current_funccal->l_vars.dv_hashtab;
18934 if (*name == 's' /* script variable */
18935 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18936 return &SCRIPT_VARS(current_SID);
18937 return NULL;
18941 * Get the string value of a (global/local) variable.
18942 * Returns NULL when it doesn't exist.
18944 char_u *
18945 get_var_value(name)
18946 char_u *name;
18948 dictitem_T *v;
18950 v = find_var(name, NULL);
18951 if (v == NULL)
18952 return NULL;
18953 return get_tv_string(&v->di_tv);
18957 * Allocate a new hashtab for a sourced script. It will be used while
18958 * sourcing this script and when executing functions defined in the script.
18960 void
18961 new_script_vars(id)
18962 scid_T id;
18964 int i;
18965 hashtab_T *ht;
18966 scriptvar_T *sv;
18968 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18970 /* Re-allocating ga_data means that an ht_array pointing to
18971 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18972 * at its init value. Also reset "v_dict", it's always the same. */
18973 for (i = 1; i <= ga_scripts.ga_len; ++i)
18975 ht = &SCRIPT_VARS(i);
18976 if (ht->ht_mask == HT_INIT_SIZE - 1)
18977 ht->ht_array = ht->ht_smallarray;
18978 sv = &SCRIPT_SV(i);
18979 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18982 while (ga_scripts.ga_len < id)
18984 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18985 init_var_dict(&sv->sv_dict, &sv->sv_var);
18986 ++ga_scripts.ga_len;
18992 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18993 * point to it.
18995 void
18996 init_var_dict(dict, dict_var)
18997 dict_T *dict;
18998 dictitem_T *dict_var;
19000 hash_init(&dict->dv_hashtab);
19001 dict->dv_refcount = DO_NOT_FREE_CNT;
19002 dict->dv_copyID = 0;
19003 dict_var->di_tv.vval.v_dict = dict;
19004 dict_var->di_tv.v_type = VAR_DICT;
19005 dict_var->di_tv.v_lock = VAR_FIXED;
19006 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
19007 dict_var->di_key[0] = NUL;
19011 * Clean up a list of internal variables.
19012 * Frees all allocated variables and the value they contain.
19013 * Clears hashtab "ht", does not free it.
19015 void
19016 vars_clear(ht)
19017 hashtab_T *ht;
19019 vars_clear_ext(ht, TRUE);
19023 * Like vars_clear(), but only free the value if "free_val" is TRUE.
19025 static void
19026 vars_clear_ext(ht, free_val)
19027 hashtab_T *ht;
19028 int free_val;
19030 int todo;
19031 hashitem_T *hi;
19032 dictitem_T *v;
19034 hash_lock(ht);
19035 todo = (int)ht->ht_used;
19036 for (hi = ht->ht_array; todo > 0; ++hi)
19038 if (!HASHITEM_EMPTY(hi))
19040 --todo;
19042 /* Free the variable. Don't remove it from the hashtab,
19043 * ht_array might change then. hash_clear() takes care of it
19044 * later. */
19045 v = HI2DI(hi);
19046 if (free_val)
19047 clear_tv(&v->di_tv);
19048 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19049 vim_free(v);
19052 hash_clear(ht);
19053 ht->ht_used = 0;
19057 * Delete a variable from hashtab "ht" at item "hi".
19058 * Clear the variable value and free the dictitem.
19060 static void
19061 delete_var(ht, hi)
19062 hashtab_T *ht;
19063 hashitem_T *hi;
19065 dictitem_T *di = HI2DI(hi);
19067 hash_remove(ht, hi);
19068 clear_tv(&di->di_tv);
19069 vim_free(di);
19073 * List the value of one internal variable.
19075 static void
19076 list_one_var(v, prefix, first)
19077 dictitem_T *v;
19078 char_u *prefix;
19079 int *first;
19081 char_u *tofree;
19082 char_u *s;
19083 char_u numbuf[NUMBUFLEN];
19085 current_copyID += COPYID_INC;
19086 s = echo_string(&v->di_tv, &tofree, numbuf, current_copyID);
19087 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19088 s == NULL ? (char_u *)"" : s, first);
19089 vim_free(tofree);
19092 static void
19093 list_one_var_a(prefix, name, type, string, first)
19094 char_u *prefix;
19095 char_u *name;
19096 int type;
19097 char_u *string;
19098 int *first; /* when TRUE clear rest of screen and set to FALSE */
19100 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19101 msg_start();
19102 msg_puts(prefix);
19103 if (name != NULL) /* "a:" vars don't have a name stored */
19104 msg_puts(name);
19105 msg_putchar(' ');
19106 msg_advance(22);
19107 if (type == VAR_NUMBER)
19108 msg_putchar('#');
19109 else if (type == VAR_FUNC)
19110 msg_putchar('*');
19111 else if (type == VAR_LIST)
19113 msg_putchar('[');
19114 if (*string == '[')
19115 ++string;
19117 else if (type == VAR_DICT)
19119 msg_putchar('{');
19120 if (*string == '{')
19121 ++string;
19123 else
19124 msg_putchar(' ');
19126 msg_outtrans(string);
19128 if (type == VAR_FUNC)
19129 msg_puts((char_u *)"()");
19130 if (*first)
19132 msg_clr_eos();
19133 *first = FALSE;
19138 * Set variable "name" to value in "tv".
19139 * If the variable already exists, the value is updated.
19140 * Otherwise the variable is created.
19142 static void
19143 set_var(name, tv, copy)
19144 char_u *name;
19145 typval_T *tv;
19146 int copy; /* make copy of value in "tv" */
19148 dictitem_T *v;
19149 char_u *varname;
19150 hashtab_T *ht;
19151 char_u *p;
19153 ht = find_var_ht(name, &varname);
19154 if (ht == NULL || *varname == NUL)
19156 EMSG2(_(e_illvar), name);
19157 return;
19159 v = find_var_in_ht(ht, varname, TRUE);
19161 if (tv->v_type == VAR_FUNC)
19163 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19164 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19165 ? name[2] : name[0]))
19167 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19168 return;
19170 /* Don't allow hiding a function. When "v" is not NULL we migth be
19171 * assigning another function to the same var, the type is checked
19172 * below. */
19173 if (v == NULL && function_exists(name))
19175 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19176 name);
19177 return;
19181 if (v != NULL)
19183 /* existing variable, need to clear the value */
19184 if (var_check_ro(v->di_flags, name)
19185 || tv_check_lock(v->di_tv.v_lock, name))
19186 return;
19187 if (v->di_tv.v_type != tv->v_type
19188 && !((v->di_tv.v_type == VAR_STRING
19189 || v->di_tv.v_type == VAR_NUMBER)
19190 && (tv->v_type == VAR_STRING
19191 || tv->v_type == VAR_NUMBER))
19192 #ifdef FEAT_FLOAT
19193 && !((v->di_tv.v_type == VAR_NUMBER
19194 || v->di_tv.v_type == VAR_FLOAT)
19195 && (tv->v_type == VAR_NUMBER
19196 || tv->v_type == VAR_FLOAT))
19197 #endif
19200 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19201 return;
19205 * Handle setting internal v: variables separately: we don't change
19206 * the type.
19208 if (ht == &vimvarht)
19210 if (v->di_tv.v_type == VAR_STRING)
19212 vim_free(v->di_tv.vval.v_string);
19213 if (copy || tv->v_type != VAR_STRING)
19214 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19215 else
19217 /* Take over the string to avoid an extra alloc/free. */
19218 v->di_tv.vval.v_string = tv->vval.v_string;
19219 tv->vval.v_string = NULL;
19222 else if (v->di_tv.v_type != VAR_NUMBER)
19223 EMSG2(_(e_intern2), "set_var()");
19224 else
19226 v->di_tv.vval.v_number = get_tv_number(tv);
19227 if (STRCMP(varname, "searchforward") == 0)
19228 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19230 return;
19233 clear_tv(&v->di_tv);
19235 else /* add a new variable */
19237 /* Can't add "v:" variable. */
19238 if (ht == &vimvarht)
19240 EMSG2(_(e_illvar), name);
19241 return;
19244 /* Make sure the variable name is valid. */
19245 for (p = varname; *p != NUL; ++p)
19246 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19247 && *p != AUTOLOAD_CHAR)
19249 EMSG2(_(e_illvar), varname);
19250 return;
19253 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19254 + STRLEN(varname)));
19255 if (v == NULL)
19256 return;
19257 STRCPY(v->di_key, varname);
19258 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19260 vim_free(v);
19261 return;
19263 v->di_flags = 0;
19266 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19267 copy_tv(tv, &v->di_tv);
19268 else
19270 v->di_tv = *tv;
19271 v->di_tv.v_lock = 0;
19272 init_tv(tv);
19277 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19278 * Also give an error message.
19280 static int
19281 var_check_ro(flags, name)
19282 int flags;
19283 char_u *name;
19285 if (flags & DI_FLAGS_RO)
19287 EMSG2(_(e_readonlyvar), name);
19288 return TRUE;
19290 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19292 EMSG2(_(e_readonlysbx), name);
19293 return TRUE;
19295 return FALSE;
19299 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19300 * Also give an error message.
19302 static int
19303 var_check_fixed(flags, name)
19304 int flags;
19305 char_u *name;
19307 if (flags & DI_FLAGS_FIX)
19309 EMSG2(_("E795: Cannot delete variable %s"), name);
19310 return TRUE;
19312 return FALSE;
19316 * Return TRUE if typeval "tv" is set to be locked (immutable).
19317 * Also give an error message, using "name".
19319 static int
19320 tv_check_lock(lock, name)
19321 int lock;
19322 char_u *name;
19324 if (lock & VAR_LOCKED)
19326 EMSG2(_("E741: Value is locked: %s"),
19327 name == NULL ? (char_u *)_("Unknown") : name);
19328 return TRUE;
19330 if (lock & VAR_FIXED)
19332 EMSG2(_("E742: Cannot change value of %s"),
19333 name == NULL ? (char_u *)_("Unknown") : name);
19334 return TRUE;
19336 return FALSE;
19340 * Copy the values from typval_T "from" to typval_T "to".
19341 * When needed allocates string or increases reference count.
19342 * Does not make a copy of a list or dict but copies the reference!
19343 * It is OK for "from" and "to" to point to the same item. This is used to
19344 * make a copy later.
19346 void
19347 copy_tv(from, to)
19348 typval_T *from;
19349 typval_T *to;
19351 to->v_type = from->v_type;
19352 to->v_lock = 0;
19353 switch (from->v_type)
19355 case VAR_NUMBER:
19356 to->vval.v_number = from->vval.v_number;
19357 break;
19358 #ifdef FEAT_FLOAT
19359 case VAR_FLOAT:
19360 to->vval.v_float = from->vval.v_float;
19361 break;
19362 #endif
19363 case VAR_STRING:
19364 case VAR_FUNC:
19365 if (from->vval.v_string == NULL)
19366 to->vval.v_string = NULL;
19367 else
19369 to->vval.v_string = vim_strsave(from->vval.v_string);
19370 if (from->v_type == VAR_FUNC)
19371 func_ref(to->vval.v_string);
19373 break;
19374 case VAR_LIST:
19375 if (from->vval.v_list == NULL)
19376 to->vval.v_list = NULL;
19377 else
19379 to->vval.v_list = from->vval.v_list;
19380 ++to->vval.v_list->lv_refcount;
19382 break;
19383 case VAR_DICT:
19384 if (from->vval.v_dict == NULL)
19385 to->vval.v_dict = NULL;
19386 else
19388 to->vval.v_dict = from->vval.v_dict;
19389 ++to->vval.v_dict->dv_refcount;
19391 break;
19392 default:
19393 EMSG2(_(e_intern2), "copy_tv()");
19394 break;
19399 * Make a copy of an item.
19400 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19401 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19402 * reference to an already copied list/dict can be used.
19403 * Returns FAIL or OK.
19405 static int
19406 item_copy(from, to, deep, copyID)
19407 typval_T *from;
19408 typval_T *to;
19409 int deep;
19410 int copyID;
19412 static int recurse = 0;
19413 int ret = OK;
19415 if (recurse >= DICT_MAXNEST)
19417 EMSG(_("E698: variable nested too deep for making a copy"));
19418 return FAIL;
19420 ++recurse;
19422 switch (from->v_type)
19424 case VAR_NUMBER:
19425 #ifdef FEAT_FLOAT
19426 case VAR_FLOAT:
19427 #endif
19428 case VAR_STRING:
19429 case VAR_FUNC:
19430 copy_tv(from, to);
19431 break;
19432 case VAR_LIST:
19433 to->v_type = VAR_LIST;
19434 to->v_lock = 0;
19435 if (from->vval.v_list == NULL)
19436 to->vval.v_list = NULL;
19437 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19439 /* use the copy made earlier */
19440 to->vval.v_list = from->vval.v_list->lv_copylist;
19441 ++to->vval.v_list->lv_refcount;
19443 else
19444 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19445 if (to->vval.v_list == NULL)
19446 ret = FAIL;
19447 break;
19448 case VAR_DICT:
19449 to->v_type = VAR_DICT;
19450 to->v_lock = 0;
19451 if (from->vval.v_dict == NULL)
19452 to->vval.v_dict = NULL;
19453 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19455 /* use the copy made earlier */
19456 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19457 ++to->vval.v_dict->dv_refcount;
19459 else
19460 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19461 if (to->vval.v_dict == NULL)
19462 ret = FAIL;
19463 break;
19464 default:
19465 EMSG2(_(e_intern2), "item_copy()");
19466 ret = FAIL;
19468 --recurse;
19469 return ret;
19473 * ":echo expr1 ..." print each argument separated with a space, add a
19474 * newline at the end.
19475 * ":echon expr1 ..." print each argument plain.
19477 void
19478 ex_echo(eap)
19479 exarg_T *eap;
19481 char_u *arg = eap->arg;
19482 typval_T rettv;
19483 char_u *tofree;
19484 char_u *p;
19485 int needclr = TRUE;
19486 int atstart = TRUE;
19487 char_u numbuf[NUMBUFLEN];
19489 if (eap->skip)
19490 ++emsg_skip;
19491 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19493 /* If eval1() causes an error message the text from the command may
19494 * still need to be cleared. E.g., "echo 22,44". */
19495 need_clr_eos = needclr;
19497 p = arg;
19498 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19501 * Report the invalid expression unless the expression evaluation
19502 * has been cancelled due to an aborting error, an interrupt, or an
19503 * exception.
19505 if (!aborting())
19506 EMSG2(_(e_invexpr2), p);
19507 need_clr_eos = FALSE;
19508 break;
19510 need_clr_eos = FALSE;
19512 if (!eap->skip)
19514 if (atstart)
19516 atstart = FALSE;
19517 /* Call msg_start() after eval1(), evaluating the expression
19518 * may cause a message to appear. */
19519 if (eap->cmdidx == CMD_echo)
19520 msg_start();
19522 else if (eap->cmdidx == CMD_echo)
19523 msg_puts_attr((char_u *)" ", echo_attr);
19524 current_copyID += COPYID_INC;
19525 p = echo_string(&rettv, &tofree, numbuf, current_copyID);
19526 if (p != NULL)
19527 for ( ; *p != NUL && !got_int; ++p)
19529 if (*p == '\n' || *p == '\r' || *p == TAB)
19531 if (*p != TAB && needclr)
19533 /* remove any text still there from the command */
19534 msg_clr_eos();
19535 needclr = FALSE;
19537 msg_putchar_attr(*p, echo_attr);
19539 else
19541 #ifdef FEAT_MBYTE
19542 if (has_mbyte)
19544 int i = (*mb_ptr2len)(p);
19546 (void)msg_outtrans_len_attr(p, i, echo_attr);
19547 p += i - 1;
19549 else
19550 #endif
19551 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19554 vim_free(tofree);
19556 clear_tv(&rettv);
19557 arg = skipwhite(arg);
19559 eap->nextcmd = check_nextcmd(arg);
19561 if (eap->skip)
19562 --emsg_skip;
19563 else
19565 /* remove text that may still be there from the command */
19566 if (needclr)
19567 msg_clr_eos();
19568 if (eap->cmdidx == CMD_echo)
19569 msg_end();
19574 * ":echohl {name}".
19576 void
19577 ex_echohl(eap)
19578 exarg_T *eap;
19580 int id;
19582 id = syn_name2id(eap->arg);
19583 if (id == 0)
19584 echo_attr = 0;
19585 else
19586 echo_attr = syn_id2attr(id);
19590 * ":execute expr1 ..." execute the result of an expression.
19591 * ":echomsg expr1 ..." Print a message
19592 * ":echoerr expr1 ..." Print an error
19593 * Each gets spaces around each argument and a newline at the end for
19594 * echo commands
19596 void
19597 ex_execute(eap)
19598 exarg_T *eap;
19600 char_u *arg = eap->arg;
19601 typval_T rettv;
19602 int ret = OK;
19603 char_u *p;
19604 garray_T ga;
19605 int len;
19606 int save_did_emsg;
19608 ga_init2(&ga, 1, 80);
19610 if (eap->skip)
19611 ++emsg_skip;
19612 while (*arg != NUL && *arg != '|' && *arg != '\n')
19614 p = arg;
19615 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19618 * Report the invalid expression unless the expression evaluation
19619 * has been cancelled due to an aborting error, an interrupt, or an
19620 * exception.
19622 if (!aborting())
19623 EMSG2(_(e_invexpr2), p);
19624 ret = FAIL;
19625 break;
19628 if (!eap->skip)
19630 p = get_tv_string(&rettv);
19631 len = (int)STRLEN(p);
19632 if (ga_grow(&ga, len + 2) == FAIL)
19634 clear_tv(&rettv);
19635 ret = FAIL;
19636 break;
19638 if (ga.ga_len)
19639 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19640 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19641 ga.ga_len += len;
19644 clear_tv(&rettv);
19645 arg = skipwhite(arg);
19648 if (ret != FAIL && ga.ga_data != NULL)
19650 if (eap->cmdidx == CMD_echomsg)
19652 MSG_ATTR(ga.ga_data, echo_attr);
19653 out_flush();
19655 else if (eap->cmdidx == CMD_echoerr)
19657 /* We don't want to abort following commands, restore did_emsg. */
19658 save_did_emsg = did_emsg;
19659 EMSG((char_u *)ga.ga_data);
19660 if (!force_abort)
19661 did_emsg = save_did_emsg;
19663 else if (eap->cmdidx == CMD_execute)
19664 do_cmdline((char_u *)ga.ga_data,
19665 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19668 ga_clear(&ga);
19670 if (eap->skip)
19671 --emsg_skip;
19673 eap->nextcmd = check_nextcmd(arg);
19677 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19678 * "arg" points to the "&" or '+' when called, to "option" when returning.
19679 * Returns NULL when no option name found. Otherwise pointer to the char
19680 * after the option name.
19682 static char_u *
19683 find_option_end(arg, opt_flags)
19684 char_u **arg;
19685 int *opt_flags;
19687 char_u *p = *arg;
19689 ++p;
19690 if (*p == 'g' && p[1] == ':')
19692 *opt_flags = OPT_GLOBAL;
19693 p += 2;
19695 else if (*p == 'l' && p[1] == ':')
19697 *opt_flags = OPT_LOCAL;
19698 p += 2;
19700 else
19701 *opt_flags = 0;
19703 if (!ASCII_ISALPHA(*p))
19704 return NULL;
19705 *arg = p;
19707 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19708 p += 4; /* termcap option */
19709 else
19710 while (ASCII_ISALPHA(*p))
19711 ++p;
19712 return p;
19716 * ":function"
19718 void
19719 ex_function(eap)
19720 exarg_T *eap;
19722 char_u *theline;
19723 int j;
19724 int c;
19725 int saved_did_emsg;
19726 char_u *name = NULL;
19727 char_u *p;
19728 char_u *arg;
19729 char_u *line_arg = NULL;
19730 garray_T newargs;
19731 garray_T newlines;
19732 int varargs = FALSE;
19733 int mustend = FALSE;
19734 int flags = 0;
19735 ufunc_T *fp;
19736 int indent;
19737 int nesting;
19738 char_u *skip_until = NULL;
19739 dictitem_T *v;
19740 funcdict_T fudi;
19741 static int func_nr = 0; /* number for nameless function */
19742 int paren;
19743 hashtab_T *ht;
19744 int todo;
19745 hashitem_T *hi;
19746 int sourcing_lnum_off;
19749 * ":function" without argument: list functions.
19751 if (ends_excmd(*eap->arg))
19753 if (!eap->skip)
19755 todo = (int)func_hashtab.ht_used;
19756 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19758 if (!HASHITEM_EMPTY(hi))
19760 --todo;
19761 fp = HI2UF(hi);
19762 if (!isdigit(*fp->uf_name))
19763 list_func_head(fp, FALSE);
19767 eap->nextcmd = check_nextcmd(eap->arg);
19768 return;
19772 * ":function /pat": list functions matching pattern.
19774 if (*eap->arg == '/')
19776 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19777 if (!eap->skip)
19779 regmatch_T regmatch;
19781 c = *p;
19782 *p = NUL;
19783 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19784 *p = c;
19785 if (regmatch.regprog != NULL)
19787 regmatch.rm_ic = p_ic;
19789 todo = (int)func_hashtab.ht_used;
19790 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19792 if (!HASHITEM_EMPTY(hi))
19794 --todo;
19795 fp = HI2UF(hi);
19796 if (!isdigit(*fp->uf_name)
19797 && vim_regexec(&regmatch, fp->uf_name, 0))
19798 list_func_head(fp, FALSE);
19801 vim_free(regmatch.regprog);
19804 if (*p == '/')
19805 ++p;
19806 eap->nextcmd = check_nextcmd(p);
19807 return;
19811 * Get the function name. There are these situations:
19812 * func normal function name
19813 * "name" == func, "fudi.fd_dict" == NULL
19814 * dict.func new dictionary entry
19815 * "name" == NULL, "fudi.fd_dict" set,
19816 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19817 * dict.func existing dict entry with a Funcref
19818 * "name" == func, "fudi.fd_dict" set,
19819 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19820 * dict.func existing dict entry that's not a Funcref
19821 * "name" == NULL, "fudi.fd_dict" set,
19822 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19824 p = eap->arg;
19825 name = trans_function_name(&p, eap->skip, 0, &fudi);
19826 paren = (vim_strchr(p, '(') != NULL);
19827 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19830 * Return on an invalid expression in braces, unless the expression
19831 * evaluation has been cancelled due to an aborting error, an
19832 * interrupt, or an exception.
19834 if (!aborting())
19836 if (!eap->skip && fudi.fd_newkey != NULL)
19837 EMSG2(_(e_dictkey), fudi.fd_newkey);
19838 vim_free(fudi.fd_newkey);
19839 return;
19841 else
19842 eap->skip = TRUE;
19845 /* An error in a function call during evaluation of an expression in magic
19846 * braces should not cause the function not to be defined. */
19847 saved_did_emsg = did_emsg;
19848 did_emsg = FALSE;
19851 * ":function func" with only function name: list function.
19853 if (!paren)
19855 if (!ends_excmd(*skipwhite(p)))
19857 EMSG(_(e_trailing));
19858 goto ret_free;
19860 eap->nextcmd = check_nextcmd(p);
19861 if (eap->nextcmd != NULL)
19862 *p = NUL;
19863 if (!eap->skip && !got_int)
19865 fp = find_func(name);
19866 if (fp != NULL)
19868 list_func_head(fp, TRUE);
19869 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19871 if (FUNCLINE(fp, j) == NULL)
19872 continue;
19873 msg_putchar('\n');
19874 msg_outnum((long)(j + 1));
19875 if (j < 9)
19876 msg_putchar(' ');
19877 if (j < 99)
19878 msg_putchar(' ');
19879 msg_prt_line(FUNCLINE(fp, j), FALSE);
19880 out_flush(); /* show a line at a time */
19881 ui_breakcheck();
19883 if (!got_int)
19885 msg_putchar('\n');
19886 msg_puts((char_u *)" endfunction");
19889 else
19890 emsg_funcname(N_("E123: Undefined function: %s"), name);
19892 goto ret_free;
19896 * ":function name(arg1, arg2)" Define function.
19898 p = skipwhite(p);
19899 if (*p != '(')
19901 if (!eap->skip)
19903 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19904 goto ret_free;
19906 /* attempt to continue by skipping some text */
19907 if (vim_strchr(p, '(') != NULL)
19908 p = vim_strchr(p, '(');
19910 p = skipwhite(p + 1);
19912 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19913 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19915 if (!eap->skip)
19917 /* Check the name of the function. Unless it's a dictionary function
19918 * (that we are overwriting). */
19919 if (name != NULL)
19920 arg = name;
19921 else
19922 arg = fudi.fd_newkey;
19923 if (arg != NULL && (fudi.fd_di == NULL
19924 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19926 if (*arg == K_SPECIAL)
19927 j = 3;
19928 else
19929 j = 0;
19930 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19931 : eval_isnamec(arg[j])))
19932 ++j;
19933 if (arg[j] != NUL)
19934 emsg_funcname((char *)e_invarg2, arg);
19939 * Isolate the arguments: "arg1, arg2, ...)"
19941 while (*p != ')')
19943 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19945 varargs = TRUE;
19946 p += 3;
19947 mustend = TRUE;
19949 else
19951 arg = p;
19952 while (ASCII_ISALNUM(*p) || *p == '_')
19953 ++p;
19954 if (arg == p || isdigit(*arg)
19955 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19956 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19958 if (!eap->skip)
19959 EMSG2(_("E125: Illegal argument: %s"), arg);
19960 break;
19962 if (ga_grow(&newargs, 1) == FAIL)
19963 goto erret;
19964 c = *p;
19965 *p = NUL;
19966 arg = vim_strsave(arg);
19967 if (arg == NULL)
19968 goto erret;
19969 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19970 *p = c;
19971 newargs.ga_len++;
19972 if (*p == ',')
19973 ++p;
19974 else
19975 mustend = TRUE;
19977 p = skipwhite(p);
19978 if (mustend && *p != ')')
19980 if (!eap->skip)
19981 EMSG2(_(e_invarg2), eap->arg);
19982 break;
19985 ++p; /* skip the ')' */
19987 /* find extra arguments "range", "dict" and "abort" */
19988 for (;;)
19990 p = skipwhite(p);
19991 if (STRNCMP(p, "range", 5) == 0)
19993 flags |= FC_RANGE;
19994 p += 5;
19996 else if (STRNCMP(p, "dict", 4) == 0)
19998 flags |= FC_DICT;
19999 p += 4;
20001 else if (STRNCMP(p, "abort", 5) == 0)
20003 flags |= FC_ABORT;
20004 p += 5;
20006 else
20007 break;
20010 /* When there is a line break use what follows for the function body.
20011 * Makes 'exe "func Test()\n...\nendfunc"' work. */
20012 if (*p == '\n')
20013 line_arg = p + 1;
20014 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
20015 EMSG(_(e_trailing));
20018 * Read the body of the function, until ":endfunction" is found.
20020 if (KeyTyped)
20022 /* Check if the function already exists, don't let the user type the
20023 * whole function before telling him it doesn't work! For a script we
20024 * need to skip the body to be able to find what follows. */
20025 if (!eap->skip && !eap->forceit)
20027 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
20028 EMSG(_(e_funcdict));
20029 else if (name != NULL && find_func(name) != NULL)
20030 emsg_funcname(e_funcexts, name);
20033 if (!eap->skip && did_emsg)
20034 goto erret;
20036 msg_putchar('\n'); /* don't overwrite the function name */
20037 cmdline_row = msg_row;
20040 indent = 2;
20041 nesting = 0;
20042 for (;;)
20044 msg_scroll = TRUE;
20045 need_wait_return = FALSE;
20046 sourcing_lnum_off = sourcing_lnum;
20048 if (line_arg != NULL)
20050 /* Use eap->arg, split up in parts by line breaks. */
20051 theline = line_arg;
20052 p = vim_strchr(theline, '\n');
20053 if (p == NULL)
20054 line_arg += STRLEN(line_arg);
20055 else
20057 *p = NUL;
20058 line_arg = p + 1;
20061 else if (eap->getline == NULL)
20062 theline = getcmdline(':', 0L, indent);
20063 else
20064 theline = eap->getline(':', eap->cookie, indent);
20065 if (KeyTyped)
20066 lines_left = Rows - 1;
20067 if (theline == NULL)
20069 EMSG(_("E126: Missing :endfunction"));
20070 goto erret;
20073 /* Detect line continuation: sourcing_lnum increased more than one. */
20074 if (sourcing_lnum > sourcing_lnum_off + 1)
20075 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20076 else
20077 sourcing_lnum_off = 0;
20079 if (skip_until != NULL)
20081 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20082 * don't check for ":endfunc". */
20083 if (STRCMP(theline, skip_until) == 0)
20085 vim_free(skip_until);
20086 skip_until = NULL;
20089 else
20091 /* skip ':' and blanks*/
20092 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20095 /* Check for "endfunction". */
20096 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20098 if (line_arg == NULL)
20099 vim_free(theline);
20100 break;
20103 /* Increase indent inside "if", "while", "for" and "try", decrease
20104 * at "end". */
20105 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20106 indent -= 2;
20107 else if (STRNCMP(p, "if", 2) == 0
20108 || STRNCMP(p, "wh", 2) == 0
20109 || STRNCMP(p, "for", 3) == 0
20110 || STRNCMP(p, "try", 3) == 0)
20111 indent += 2;
20113 /* Check for defining a function inside this function. */
20114 if (checkforcmd(&p, "function", 2))
20116 if (*p == '!')
20117 p = skipwhite(p + 1);
20118 p += eval_fname_script(p);
20119 if (ASCII_ISALPHA(*p))
20121 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20122 if (*skipwhite(p) == '(')
20124 ++nesting;
20125 indent += 2;
20130 /* Check for ":append" or ":insert". */
20131 p = skip_range(p, NULL);
20132 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20133 || (p[0] == 'i'
20134 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20135 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20136 skip_until = vim_strsave((char_u *)".");
20138 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20139 arg = skipwhite(skiptowhite(p));
20140 if (arg[0] == '<' && arg[1] =='<'
20141 && ((p[0] == 'p' && p[1] == 'y'
20142 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20143 || (p[0] == 'p' && p[1] == 'e'
20144 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20145 || (p[0] == 't' && p[1] == 'c'
20146 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20147 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20148 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20149 || (p[0] == 'm' && p[1] == 'z'
20150 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20153 /* ":python <<" continues until a dot, like ":append" */
20154 p = skipwhite(arg + 2);
20155 if (*p == NUL)
20156 skip_until = vim_strsave((char_u *)".");
20157 else
20158 skip_until = vim_strsave(p);
20162 /* Add the line to the function. */
20163 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20165 if (line_arg == NULL)
20166 vim_free(theline);
20167 goto erret;
20170 /* Copy the line to newly allocated memory. get_one_sourceline()
20171 * allocates 250 bytes per line, this saves 80% on average. The cost
20172 * is an extra alloc/free. */
20173 p = vim_strsave(theline);
20174 if (p != NULL)
20176 if (line_arg == NULL)
20177 vim_free(theline);
20178 theline = p;
20181 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20183 /* Add NULL lines for continuation lines, so that the line count is
20184 * equal to the index in the growarray. */
20185 while (sourcing_lnum_off-- > 0)
20186 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20188 /* Check for end of eap->arg. */
20189 if (line_arg != NULL && *line_arg == NUL)
20190 line_arg = NULL;
20193 /* Don't define the function when skipping commands or when an error was
20194 * detected. */
20195 if (eap->skip || did_emsg)
20196 goto erret;
20199 * If there are no errors, add the function
20201 if (fudi.fd_dict == NULL)
20203 v = find_var(name, &ht);
20204 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20206 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
20207 name);
20208 goto erret;
20211 fp = find_func(name);
20212 if (fp != NULL)
20214 if (!eap->forceit)
20216 emsg_funcname(e_funcexts, name);
20217 goto erret;
20219 if (fp->uf_calls > 0)
20221 emsg_funcname(N_("E127: Cannot redefine function %s: It is in use"),
20222 name);
20223 goto erret;
20225 /* redefine existing function */
20226 ga_clear_strings(&(fp->uf_args));
20227 ga_clear_strings(&(fp->uf_lines));
20228 vim_free(name);
20229 name = NULL;
20232 else
20234 char numbuf[20];
20236 fp = NULL;
20237 if (fudi.fd_newkey == NULL && !eap->forceit)
20239 EMSG(_(e_funcdict));
20240 goto erret;
20242 if (fudi.fd_di == NULL)
20244 /* Can't add a function to a locked dictionary */
20245 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20246 goto erret;
20248 /* Can't change an existing function if it is locked */
20249 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20250 goto erret;
20252 /* Give the function a sequential number. Can only be used with a
20253 * Funcref! */
20254 vim_free(name);
20255 sprintf(numbuf, "%d", ++func_nr);
20256 name = vim_strsave((char_u *)numbuf);
20257 if (name == NULL)
20258 goto erret;
20261 if (fp == NULL)
20263 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20265 int slen, plen;
20266 char_u *scriptname;
20268 /* Check that the autoload name matches the script name. */
20269 j = FAIL;
20270 if (sourcing_name != NULL)
20272 scriptname = autoload_name(name);
20273 if (scriptname != NULL)
20275 p = vim_strchr(scriptname, '/');
20276 plen = (int)STRLEN(p);
20277 slen = (int)STRLEN(sourcing_name);
20278 if (slen > plen && fnamecmp(p,
20279 sourcing_name + slen - plen) == 0)
20280 j = OK;
20281 vim_free(scriptname);
20284 if (j == FAIL)
20286 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20287 goto erret;
20291 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20292 if (fp == NULL)
20293 goto erret;
20295 if (fudi.fd_dict != NULL)
20297 if (fudi.fd_di == NULL)
20299 /* add new dict entry */
20300 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20301 if (fudi.fd_di == NULL)
20303 vim_free(fp);
20304 goto erret;
20306 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20308 vim_free(fudi.fd_di);
20309 vim_free(fp);
20310 goto erret;
20313 else
20314 /* overwrite existing dict entry */
20315 clear_tv(&fudi.fd_di->di_tv);
20316 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20317 fudi.fd_di->di_tv.v_lock = 0;
20318 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20319 fp->uf_refcount = 1;
20321 /* behave like "dict" was used */
20322 flags |= FC_DICT;
20325 /* insert the new function in the function list */
20326 STRCPY(fp->uf_name, name);
20327 hash_add(&func_hashtab, UF2HIKEY(fp));
20329 fp->uf_args = newargs;
20330 fp->uf_lines = newlines;
20331 #ifdef FEAT_PROFILE
20332 fp->uf_tml_count = NULL;
20333 fp->uf_tml_total = NULL;
20334 fp->uf_tml_self = NULL;
20335 fp->uf_profiling = FALSE;
20336 if (prof_def_func())
20337 func_do_profile(fp);
20338 #endif
20339 fp->uf_varargs = varargs;
20340 fp->uf_flags = flags;
20341 fp->uf_calls = 0;
20342 fp->uf_script_ID = current_SID;
20343 goto ret_free;
20345 erret:
20346 ga_clear_strings(&newargs);
20347 ga_clear_strings(&newlines);
20348 ret_free:
20349 vim_free(skip_until);
20350 vim_free(fudi.fd_newkey);
20351 vim_free(name);
20352 did_emsg |= saved_did_emsg;
20356 * Get a function name, translating "<SID>" and "<SNR>".
20357 * Also handles a Funcref in a List or Dictionary.
20358 * Returns the function name in allocated memory, or NULL for failure.
20359 * flags:
20360 * TFN_INT: internal function name OK
20361 * TFN_QUIET: be quiet
20362 * Advances "pp" to just after the function name (if no error).
20364 static char_u *
20365 trans_function_name(pp, skip, flags, fdp)
20366 char_u **pp;
20367 int skip; /* only find the end, don't evaluate */
20368 int flags;
20369 funcdict_T *fdp; /* return: info about dictionary used */
20371 char_u *name = NULL;
20372 char_u *start;
20373 char_u *end;
20374 int lead;
20375 char_u sid_buf[20];
20376 int len;
20377 lval_T lv;
20379 if (fdp != NULL)
20380 vim_memset(fdp, 0, sizeof(funcdict_T));
20381 start = *pp;
20383 /* Check for hard coded <SNR>: already translated function ID (from a user
20384 * command). */
20385 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20386 && (*pp)[2] == (int)KE_SNR)
20388 *pp += 3;
20389 len = get_id_len(pp) + 3;
20390 return vim_strnsave(start, len);
20393 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20394 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20395 lead = eval_fname_script(start);
20396 if (lead > 2)
20397 start += lead;
20399 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20400 lead > 2 ? 0 : FNE_CHECK_START);
20401 if (end == start)
20403 if (!skip)
20404 EMSG(_("E129: Function name required"));
20405 goto theend;
20407 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20410 * Report an invalid expression in braces, unless the expression
20411 * evaluation has been cancelled due to an aborting error, an
20412 * interrupt, or an exception.
20414 if (!aborting())
20416 if (end != NULL)
20417 EMSG2(_(e_invarg2), start);
20419 else
20420 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20421 goto theend;
20424 if (lv.ll_tv != NULL)
20426 if (fdp != NULL)
20428 fdp->fd_dict = lv.ll_dict;
20429 fdp->fd_newkey = lv.ll_newkey;
20430 lv.ll_newkey = NULL;
20431 fdp->fd_di = lv.ll_di;
20433 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20435 name = vim_strsave(lv.ll_tv->vval.v_string);
20436 *pp = end;
20438 else
20440 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20441 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20442 EMSG(_(e_funcref));
20443 else
20444 *pp = end;
20445 name = NULL;
20447 goto theend;
20450 if (lv.ll_name == NULL)
20452 /* Error found, but continue after the function name. */
20453 *pp = end;
20454 goto theend;
20457 /* Check if the name is a Funcref. If so, use the value. */
20458 if (lv.ll_exp_name != NULL)
20460 len = (int)STRLEN(lv.ll_exp_name);
20461 name = deref_func_name(lv.ll_exp_name, &len);
20462 if (name == lv.ll_exp_name)
20463 name = NULL;
20465 else
20467 len = (int)(end - *pp);
20468 name = deref_func_name(*pp, &len);
20469 if (name == *pp)
20470 name = NULL;
20472 if (name != NULL)
20474 name = vim_strsave(name);
20475 *pp = end;
20476 goto theend;
20479 if (lv.ll_exp_name != NULL)
20481 len = (int)STRLEN(lv.ll_exp_name);
20482 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20483 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20485 /* When there was "s:" already or the name expanded to get a
20486 * leading "s:" then remove it. */
20487 lv.ll_name += 2;
20488 len -= 2;
20489 lead = 2;
20492 else
20494 if (lead == 2) /* skip over "s:" */
20495 lv.ll_name += 2;
20496 len = (int)(end - lv.ll_name);
20500 * Copy the function name to allocated memory.
20501 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20502 * Accept <SNR>123_name() outside a script.
20504 if (skip)
20505 lead = 0; /* do nothing */
20506 else if (lead > 0)
20508 lead = 3;
20509 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20510 || eval_fname_sid(*pp))
20512 /* It's "s:" or "<SID>" */
20513 if (current_SID <= 0)
20515 EMSG(_(e_usingsid));
20516 goto theend;
20518 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20519 lead += (int)STRLEN(sid_buf);
20522 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20524 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20525 goto theend;
20527 name = alloc((unsigned)(len + lead + 1));
20528 if (name != NULL)
20530 if (lead > 0)
20532 name[0] = K_SPECIAL;
20533 name[1] = KS_EXTRA;
20534 name[2] = (int)KE_SNR;
20535 if (lead > 3) /* If it's "<SID>" */
20536 STRCPY(name + 3, sid_buf);
20538 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20539 name[len + lead] = NUL;
20541 *pp = end;
20543 theend:
20544 clear_lval(&lv);
20545 return name;
20549 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20550 * Return 2 if "p" starts with "s:".
20551 * Return 0 otherwise.
20553 static int
20554 eval_fname_script(p)
20555 char_u *p;
20557 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20558 || STRNICMP(p + 1, "SNR>", 4) == 0))
20559 return 5;
20560 if (p[0] == 's' && p[1] == ':')
20561 return 2;
20562 return 0;
20566 * Return TRUE if "p" starts with "<SID>" or "s:".
20567 * Only works if eval_fname_script() returned non-zero for "p"!
20569 static int
20570 eval_fname_sid(p)
20571 char_u *p;
20573 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20577 * List the head of the function: "name(arg1, arg2)".
20579 static void
20580 list_func_head(fp, indent)
20581 ufunc_T *fp;
20582 int indent;
20584 int j;
20586 msg_start();
20587 if (indent)
20588 MSG_PUTS(" ");
20589 MSG_PUTS("function ");
20590 if (fp->uf_name[0] == K_SPECIAL)
20592 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20593 msg_puts(fp->uf_name + 3);
20595 else
20596 msg_puts(fp->uf_name);
20597 msg_putchar('(');
20598 for (j = 0; j < fp->uf_args.ga_len; ++j)
20600 if (j)
20601 MSG_PUTS(", ");
20602 msg_puts(FUNCARG(fp, j));
20604 if (fp->uf_varargs)
20606 if (j)
20607 MSG_PUTS(", ");
20608 MSG_PUTS("...");
20610 msg_putchar(')');
20611 msg_clr_eos();
20612 if (p_verbose > 0)
20613 last_set_msg(fp->uf_script_ID);
20617 * Find a function by name, return pointer to it in ufuncs.
20618 * Return NULL for unknown function.
20620 static ufunc_T *
20621 find_func(name)
20622 char_u *name;
20624 hashitem_T *hi;
20626 hi = hash_find(&func_hashtab, name);
20627 if (!HASHITEM_EMPTY(hi))
20628 return HI2UF(hi);
20629 return NULL;
20632 #if defined(EXITFREE) || defined(PROTO)
20633 void
20634 free_all_functions()
20636 hashitem_T *hi;
20638 /* Need to start all over every time, because func_free() may change the
20639 * hash table. */
20640 while (func_hashtab.ht_used > 0)
20641 for (hi = func_hashtab.ht_array; ; ++hi)
20642 if (!HASHITEM_EMPTY(hi))
20644 func_free(HI2UF(hi));
20645 break;
20648 #endif
20651 * Return TRUE if a function "name" exists.
20653 static int
20654 function_exists(name)
20655 char_u *name;
20657 char_u *nm = name;
20658 char_u *p;
20659 int n = FALSE;
20661 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20662 nm = skipwhite(nm);
20664 /* Only accept "funcname", "funcname ", "funcname (..." and
20665 * "funcname(...", not "funcname!...". */
20666 if (p != NULL && (*nm == NUL || *nm == '('))
20668 if (builtin_function(p))
20669 n = (find_internal_func(p) >= 0);
20670 else
20671 n = (find_func(p) != NULL);
20673 vim_free(p);
20674 return n;
20678 * Return TRUE if "name" looks like a builtin function name: starts with a
20679 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20681 static int
20682 builtin_function(name)
20683 char_u *name;
20685 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20686 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20689 #if defined(FEAT_PROFILE) || defined(PROTO)
20691 * Start profiling function "fp".
20693 static void
20694 func_do_profile(fp)
20695 ufunc_T *fp;
20697 fp->uf_tm_count = 0;
20698 profile_zero(&fp->uf_tm_self);
20699 profile_zero(&fp->uf_tm_total);
20700 if (fp->uf_tml_count == NULL)
20701 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20702 (sizeof(int) * fp->uf_lines.ga_len));
20703 if (fp->uf_tml_total == NULL)
20704 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20705 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20706 if (fp->uf_tml_self == NULL)
20707 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20708 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20709 fp->uf_tml_idx = -1;
20710 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20711 || fp->uf_tml_self == NULL)
20712 return; /* out of memory */
20714 fp->uf_profiling = TRUE;
20718 * Dump the profiling results for all functions in file "fd".
20720 void
20721 func_dump_profile(fd)
20722 FILE *fd;
20724 hashitem_T *hi;
20725 int todo;
20726 ufunc_T *fp;
20727 int i;
20728 ufunc_T **sorttab;
20729 int st_len = 0;
20731 todo = (int)func_hashtab.ht_used;
20732 if (todo == 0)
20733 return; /* nothing to dump */
20735 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20737 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20739 if (!HASHITEM_EMPTY(hi))
20741 --todo;
20742 fp = HI2UF(hi);
20743 if (fp->uf_profiling)
20745 if (sorttab != NULL)
20746 sorttab[st_len++] = fp;
20748 if (fp->uf_name[0] == K_SPECIAL)
20749 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20750 else
20751 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20752 if (fp->uf_tm_count == 1)
20753 fprintf(fd, "Called 1 time\n");
20754 else
20755 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20756 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20757 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20758 fprintf(fd, "\n");
20759 fprintf(fd, "count total (s) self (s)\n");
20761 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20763 if (FUNCLINE(fp, i) == NULL)
20764 continue;
20765 prof_func_line(fd, fp->uf_tml_count[i],
20766 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20767 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20769 fprintf(fd, "\n");
20774 if (sorttab != NULL && st_len > 0)
20776 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20777 prof_total_cmp);
20778 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20779 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20780 prof_self_cmp);
20781 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20784 vim_free(sorttab);
20787 static void
20788 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20789 FILE *fd;
20790 ufunc_T **sorttab;
20791 int st_len;
20792 char *title;
20793 int prefer_self; /* when equal print only self time */
20795 int i;
20796 ufunc_T *fp;
20798 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20799 fprintf(fd, "count total (s) self (s) function\n");
20800 for (i = 0; i < 20 && i < st_len; ++i)
20802 fp = sorttab[i];
20803 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20804 prefer_self);
20805 if (fp->uf_name[0] == K_SPECIAL)
20806 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20807 else
20808 fprintf(fd, " %s()\n", fp->uf_name);
20810 fprintf(fd, "\n");
20814 * Print the count and times for one function or function line.
20816 static void
20817 prof_func_line(fd, count, total, self, prefer_self)
20818 FILE *fd;
20819 int count;
20820 proftime_T *total;
20821 proftime_T *self;
20822 int prefer_self; /* when equal print only self time */
20824 if (count > 0)
20826 fprintf(fd, "%5d ", count);
20827 if (prefer_self && profile_equal(total, self))
20828 fprintf(fd, " ");
20829 else
20830 fprintf(fd, "%s ", profile_msg(total));
20831 if (!prefer_self && profile_equal(total, self))
20832 fprintf(fd, " ");
20833 else
20834 fprintf(fd, "%s ", profile_msg(self));
20836 else
20837 fprintf(fd, " ");
20841 * Compare function for total time sorting.
20843 static int
20844 #ifdef __BORLANDC__
20845 _RTLENTRYF
20846 #endif
20847 prof_total_cmp(s1, s2)
20848 const void *s1;
20849 const void *s2;
20851 ufunc_T *p1, *p2;
20853 p1 = *(ufunc_T **)s1;
20854 p2 = *(ufunc_T **)s2;
20855 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20859 * Compare function for self time sorting.
20861 static int
20862 #ifdef __BORLANDC__
20863 _RTLENTRYF
20864 #endif
20865 prof_self_cmp(s1, s2)
20866 const void *s1;
20867 const void *s2;
20869 ufunc_T *p1, *p2;
20871 p1 = *(ufunc_T **)s1;
20872 p2 = *(ufunc_T **)s2;
20873 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20876 #endif
20879 * If "name" has a package name try autoloading the script for it.
20880 * Return TRUE if a package was loaded.
20882 static int
20883 script_autoload(name, reload)
20884 char_u *name;
20885 int reload; /* load script again when already loaded */
20887 char_u *p;
20888 char_u *scriptname, *tofree;
20889 int ret = FALSE;
20890 int i;
20892 /* If there is no '#' after name[0] there is no package name. */
20893 p = vim_strchr(name, AUTOLOAD_CHAR);
20894 if (p == NULL || p == name)
20895 return FALSE;
20897 tofree = scriptname = autoload_name(name);
20899 /* Find the name in the list of previously loaded package names. Skip
20900 * "autoload/", it's always the same. */
20901 for (i = 0; i < ga_loaded.ga_len; ++i)
20902 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20903 break;
20904 if (!reload && i < ga_loaded.ga_len)
20905 ret = FALSE; /* was loaded already */
20906 else
20908 /* Remember the name if it wasn't loaded already. */
20909 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20911 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20912 tofree = NULL;
20915 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20916 if (source_runtime(scriptname, FALSE) == OK)
20917 ret = TRUE;
20920 vim_free(tofree);
20921 return ret;
20925 * Return the autoload script name for a function or variable name.
20926 * Returns NULL when out of memory.
20928 static char_u *
20929 autoload_name(name)
20930 char_u *name;
20932 char_u *p;
20933 char_u *scriptname;
20935 /* Get the script file name: replace '#' with '/', append ".vim". */
20936 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20937 if (scriptname == NULL)
20938 return FALSE;
20939 STRCPY(scriptname, "autoload/");
20940 STRCAT(scriptname, name);
20941 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20942 STRCAT(scriptname, ".vim");
20943 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20944 *p = '/';
20945 return scriptname;
20948 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20951 * Function given to ExpandGeneric() to obtain the list of user defined
20952 * function names.
20954 char_u *
20955 get_user_func_name(xp, idx)
20956 expand_T *xp;
20957 int idx;
20959 static long_u done;
20960 static hashitem_T *hi;
20961 ufunc_T *fp;
20963 if (idx == 0)
20965 done = 0;
20966 hi = func_hashtab.ht_array;
20968 if (done < func_hashtab.ht_used)
20970 if (done++ > 0)
20971 ++hi;
20972 while (HASHITEM_EMPTY(hi))
20973 ++hi;
20974 fp = HI2UF(hi);
20976 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20977 return fp->uf_name; /* prevents overflow */
20979 cat_func_name(IObuff, fp);
20980 if (xp->xp_context != EXPAND_USER_FUNC)
20982 STRCAT(IObuff, "(");
20983 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20984 STRCAT(IObuff, ")");
20986 return IObuff;
20988 return NULL;
20991 #endif /* FEAT_CMDL_COMPL */
20994 * Copy the function name of "fp" to buffer "buf".
20995 * "buf" must be able to hold the function name plus three bytes.
20996 * Takes care of script-local function names.
20998 static void
20999 cat_func_name(buf, fp)
21000 char_u *buf;
21001 ufunc_T *fp;
21003 if (fp->uf_name[0] == K_SPECIAL)
21005 STRCPY(buf, "<SNR>");
21006 STRCAT(buf, fp->uf_name + 3);
21008 else
21009 STRCPY(buf, fp->uf_name);
21013 * ":delfunction {name}"
21015 void
21016 ex_delfunction(eap)
21017 exarg_T *eap;
21019 ufunc_T *fp = NULL;
21020 char_u *p;
21021 char_u *name;
21022 funcdict_T fudi;
21024 p = eap->arg;
21025 name = trans_function_name(&p, eap->skip, 0, &fudi);
21026 vim_free(fudi.fd_newkey);
21027 if (name == NULL)
21029 if (fudi.fd_dict != NULL && !eap->skip)
21030 EMSG(_(e_funcref));
21031 return;
21033 if (!ends_excmd(*skipwhite(p)))
21035 vim_free(name);
21036 EMSG(_(e_trailing));
21037 return;
21039 eap->nextcmd = check_nextcmd(p);
21040 if (eap->nextcmd != NULL)
21041 *p = NUL;
21043 if (!eap->skip)
21044 fp = find_func(name);
21045 vim_free(name);
21047 if (!eap->skip)
21049 if (fp == NULL)
21051 EMSG2(_(e_nofunc), eap->arg);
21052 return;
21054 if (fp->uf_calls > 0)
21056 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21057 return;
21060 if (fudi.fd_dict != NULL)
21062 /* Delete the dict item that refers to the function, it will
21063 * invoke func_unref() and possibly delete the function. */
21064 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21066 else
21067 func_free(fp);
21072 * Free a function and remove it from the list of functions.
21074 static void
21075 func_free(fp)
21076 ufunc_T *fp;
21078 hashitem_T *hi;
21080 /* clear this function */
21081 ga_clear_strings(&(fp->uf_args));
21082 ga_clear_strings(&(fp->uf_lines));
21083 #ifdef FEAT_PROFILE
21084 vim_free(fp->uf_tml_count);
21085 vim_free(fp->uf_tml_total);
21086 vim_free(fp->uf_tml_self);
21087 #endif
21089 /* remove the function from the function hashtable */
21090 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21091 if (HASHITEM_EMPTY(hi))
21092 EMSG2(_(e_intern2), "func_free()");
21093 else
21094 hash_remove(&func_hashtab, hi);
21096 vim_free(fp);
21100 * Unreference a Function: decrement the reference count and free it when it
21101 * becomes zero. Only for numbered functions.
21103 static void
21104 func_unref(name)
21105 char_u *name;
21107 ufunc_T *fp;
21109 if (name != NULL && isdigit(*name))
21111 fp = find_func(name);
21112 if (fp == NULL)
21113 EMSG2(_(e_intern2), "func_unref()");
21114 else if (--fp->uf_refcount <= 0)
21116 /* Only delete it when it's not being used. Otherwise it's done
21117 * when "uf_calls" becomes zero. */
21118 if (fp->uf_calls == 0)
21119 func_free(fp);
21125 * Count a reference to a Function.
21127 static void
21128 func_ref(name)
21129 char_u *name;
21131 ufunc_T *fp;
21133 if (name != NULL && isdigit(*name))
21135 fp = find_func(name);
21136 if (fp == NULL)
21137 EMSG2(_(e_intern2), "func_ref()");
21138 else
21139 ++fp->uf_refcount;
21144 * Call a user function.
21146 static void
21147 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21148 ufunc_T *fp; /* pointer to function */
21149 int argcount; /* nr of args */
21150 typval_T *argvars; /* arguments */
21151 typval_T *rettv; /* return value */
21152 linenr_T firstline; /* first line of range */
21153 linenr_T lastline; /* last line of range */
21154 dict_T *selfdict; /* Dictionary for "self" */
21156 char_u *save_sourcing_name;
21157 linenr_T save_sourcing_lnum;
21158 scid_T save_current_SID;
21159 funccall_T *fc;
21160 int save_did_emsg;
21161 static int depth = 0;
21162 dictitem_T *v;
21163 int fixvar_idx = 0; /* index in fixvar[] */
21164 int i;
21165 int ai;
21166 char_u numbuf[NUMBUFLEN];
21167 char_u *name;
21168 #ifdef FEAT_PROFILE
21169 proftime_T wait_start;
21170 proftime_T call_start;
21171 #endif
21173 /* If depth of calling is getting too high, don't execute the function */
21174 if (depth >= p_mfd)
21176 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21177 rettv->v_type = VAR_NUMBER;
21178 rettv->vval.v_number = -1;
21179 return;
21181 ++depth;
21183 line_breakcheck(); /* check for CTRL-C hit */
21185 fc = (funccall_T *)alloc(sizeof(funccall_T));
21186 fc->caller = current_funccal;
21187 current_funccal = fc;
21188 fc->func = fp;
21189 fc->rettv = rettv;
21190 rettv->vval.v_number = 0;
21191 fc->linenr = 0;
21192 fc->returned = FALSE;
21193 fc->level = ex_nesting_level;
21194 /* Check if this function has a breakpoint. */
21195 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21196 fc->dbg_tick = debug_tick;
21199 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21200 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21201 * each argument variable and saves a lot of time.
21204 * Init l: variables.
21206 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21207 if (selfdict != NULL)
21209 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21210 * some compiler that checks the destination size. */
21211 v = &fc->fixvar[fixvar_idx++].var;
21212 name = v->di_key;
21213 STRCPY(name, "self");
21214 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21215 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21216 v->di_tv.v_type = VAR_DICT;
21217 v->di_tv.v_lock = 0;
21218 v->di_tv.vval.v_dict = selfdict;
21219 ++selfdict->dv_refcount;
21223 * Init a: variables.
21224 * Set a:0 to "argcount".
21225 * Set a:000 to a list with room for the "..." arguments.
21227 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21228 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21229 (varnumber_T)(argcount - fp->uf_args.ga_len));
21230 /* Use "name" to avoid a warning from some compiler that checks the
21231 * destination size. */
21232 v = &fc->fixvar[fixvar_idx++].var;
21233 name = v->di_key;
21234 STRCPY(name, "000");
21235 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21236 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21237 v->di_tv.v_type = VAR_LIST;
21238 v->di_tv.v_lock = VAR_FIXED;
21239 v->di_tv.vval.v_list = &fc->l_varlist;
21240 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21241 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21242 fc->l_varlist.lv_lock = VAR_FIXED;
21245 * Set a:firstline to "firstline" and a:lastline to "lastline".
21246 * Set a:name to named arguments.
21247 * Set a:N to the "..." arguments.
21249 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21250 (varnumber_T)firstline);
21251 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21252 (varnumber_T)lastline);
21253 for (i = 0; i < argcount; ++i)
21255 ai = i - fp->uf_args.ga_len;
21256 if (ai < 0)
21257 /* named argument a:name */
21258 name = FUNCARG(fp, i);
21259 else
21261 /* "..." argument a:1, a:2, etc. */
21262 sprintf((char *)numbuf, "%d", ai + 1);
21263 name = numbuf;
21265 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21267 v = &fc->fixvar[fixvar_idx++].var;
21268 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21270 else
21272 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21273 + STRLEN(name)));
21274 if (v == NULL)
21275 break;
21276 v->di_flags = DI_FLAGS_RO;
21278 STRCPY(v->di_key, name);
21279 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21281 /* Note: the values are copied directly to avoid alloc/free.
21282 * "argvars" must have VAR_FIXED for v_lock. */
21283 v->di_tv = argvars[i];
21284 v->di_tv.v_lock = VAR_FIXED;
21286 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21288 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21289 fc->l_listitems[ai].li_tv = argvars[i];
21290 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21294 /* Don't redraw while executing the function. */
21295 ++RedrawingDisabled;
21296 save_sourcing_name = sourcing_name;
21297 save_sourcing_lnum = sourcing_lnum;
21298 sourcing_lnum = 1;
21299 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21300 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21301 if (sourcing_name != NULL)
21303 if (save_sourcing_name != NULL
21304 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21305 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21306 else
21307 STRCPY(sourcing_name, "function ");
21308 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21310 if (p_verbose >= 12)
21312 ++no_wait_return;
21313 verbose_enter_scroll();
21315 smsg((char_u *)_("calling %s"), sourcing_name);
21316 if (p_verbose >= 14)
21318 char_u buf[MSG_BUF_LEN];
21319 char_u numbuf2[NUMBUFLEN];
21320 char_u *tofree;
21321 char_u *s;
21323 msg_puts((char_u *)"(");
21324 for (i = 0; i < argcount; ++i)
21326 if (i > 0)
21327 msg_puts((char_u *)", ");
21328 if (argvars[i].v_type == VAR_NUMBER)
21329 msg_outnum((long)argvars[i].vval.v_number);
21330 else
21332 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21333 if (s != NULL)
21335 trunc_string(s, buf, MSG_BUF_CLEN);
21336 msg_puts(buf);
21337 vim_free(tofree);
21341 msg_puts((char_u *)")");
21343 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21345 verbose_leave_scroll();
21346 --no_wait_return;
21349 #ifdef FEAT_PROFILE
21350 if (do_profiling == PROF_YES)
21352 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21353 func_do_profile(fp);
21354 if (fp->uf_profiling
21355 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21357 ++fp->uf_tm_count;
21358 profile_start(&call_start);
21359 profile_zero(&fp->uf_tm_children);
21361 script_prof_save(&wait_start);
21363 #endif
21365 save_current_SID = current_SID;
21366 current_SID = fp->uf_script_ID;
21367 save_did_emsg = did_emsg;
21368 did_emsg = FALSE;
21370 /* call do_cmdline() to execute the lines */
21371 do_cmdline(NULL, get_func_line, (void *)fc,
21372 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21374 --RedrawingDisabled;
21376 /* when the function was aborted because of an error, return -1 */
21377 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21379 clear_tv(rettv);
21380 rettv->v_type = VAR_NUMBER;
21381 rettv->vval.v_number = -1;
21384 #ifdef FEAT_PROFILE
21385 if (do_profiling == PROF_YES && (fp->uf_profiling
21386 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21388 profile_end(&call_start);
21389 profile_sub_wait(&wait_start, &call_start);
21390 profile_add(&fp->uf_tm_total, &call_start);
21391 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21392 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21394 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21395 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21398 #endif
21400 /* when being verbose, mention the return value */
21401 if (p_verbose >= 12)
21403 ++no_wait_return;
21404 verbose_enter_scroll();
21406 if (aborting())
21407 smsg((char_u *)_("%s aborted"), sourcing_name);
21408 else if (fc->rettv->v_type == VAR_NUMBER)
21409 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21410 (long)fc->rettv->vval.v_number);
21411 else
21413 char_u buf[MSG_BUF_LEN];
21414 char_u numbuf2[NUMBUFLEN];
21415 char_u *tofree;
21416 char_u *s;
21418 /* The value may be very long. Skip the middle part, so that we
21419 * have some idea how it starts and ends. smsg() would always
21420 * truncate it at the end. */
21421 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21422 if (s != NULL)
21424 trunc_string(s, buf, MSG_BUF_CLEN);
21425 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21426 vim_free(tofree);
21429 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21431 verbose_leave_scroll();
21432 --no_wait_return;
21435 vim_free(sourcing_name);
21436 sourcing_name = save_sourcing_name;
21437 sourcing_lnum = save_sourcing_lnum;
21438 current_SID = save_current_SID;
21439 #ifdef FEAT_PROFILE
21440 if (do_profiling == PROF_YES)
21441 script_prof_restore(&wait_start);
21442 #endif
21444 if (p_verbose >= 12 && sourcing_name != NULL)
21446 ++no_wait_return;
21447 verbose_enter_scroll();
21449 smsg((char_u *)_("continuing in %s"), sourcing_name);
21450 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21452 verbose_leave_scroll();
21453 --no_wait_return;
21456 did_emsg |= save_did_emsg;
21457 current_funccal = fc->caller;
21458 --depth;
21460 /* If the a:000 list and the l: and a: dicts are not referenced we can
21461 * free the funccall_T and what's in it. */
21462 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21463 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21464 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21466 free_funccal(fc, FALSE);
21468 else
21470 hashitem_T *hi;
21471 listitem_T *li;
21472 int todo;
21474 /* "fc" is still in use. This can happen when returning "a:000" or
21475 * assigning "l:" to a global variable.
21476 * Link "fc" in the list for garbage collection later. */
21477 fc->caller = previous_funccal;
21478 previous_funccal = fc;
21480 /* Make a copy of the a: variables, since we didn't do that above. */
21481 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21482 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21484 if (!HASHITEM_EMPTY(hi))
21486 --todo;
21487 v = HI2DI(hi);
21488 copy_tv(&v->di_tv, &v->di_tv);
21492 /* Make a copy of the a:000 items, since we didn't do that above. */
21493 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21494 copy_tv(&li->li_tv, &li->li_tv);
21499 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21500 * referenced from anywhere that is in use.
21502 static int
21503 can_free_funccal(fc, copyID)
21504 funccall_T *fc;
21505 int copyID;
21507 return (fc->l_varlist.lv_copyID != copyID
21508 && fc->l_vars.dv_copyID != copyID
21509 && fc->l_avars.dv_copyID != copyID);
21513 * Free "fc" and what it contains.
21515 static void
21516 free_funccal(fc, free_val)
21517 funccall_T *fc;
21518 int free_val; /* a: vars were allocated */
21520 listitem_T *li;
21522 /* The a: variables typevals may not have been allocated, only free the
21523 * allocated variables. */
21524 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21526 /* free all l: variables */
21527 vars_clear(&fc->l_vars.dv_hashtab);
21529 /* Free the a:000 variables if they were allocated. */
21530 if (free_val)
21531 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21532 clear_tv(&li->li_tv);
21534 vim_free(fc);
21538 * Add a number variable "name" to dict "dp" with value "nr".
21540 static void
21541 add_nr_var(dp, v, name, nr)
21542 dict_T *dp;
21543 dictitem_T *v;
21544 char *name;
21545 varnumber_T nr;
21547 STRCPY(v->di_key, name);
21548 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21549 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21550 v->di_tv.v_type = VAR_NUMBER;
21551 v->di_tv.v_lock = VAR_FIXED;
21552 v->di_tv.vval.v_number = nr;
21556 * ":return [expr]"
21558 void
21559 ex_return(eap)
21560 exarg_T *eap;
21562 char_u *arg = eap->arg;
21563 typval_T rettv;
21564 int returning = FALSE;
21566 if (current_funccal == NULL)
21568 EMSG(_("E133: :return not inside a function"));
21569 return;
21572 if (eap->skip)
21573 ++emsg_skip;
21575 eap->nextcmd = NULL;
21576 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21577 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21579 if (!eap->skip)
21580 returning = do_return(eap, FALSE, TRUE, &rettv);
21581 else
21582 clear_tv(&rettv);
21584 /* It's safer to return also on error. */
21585 else if (!eap->skip)
21588 * Return unless the expression evaluation has been cancelled due to an
21589 * aborting error, an interrupt, or an exception.
21591 if (!aborting())
21592 returning = do_return(eap, FALSE, TRUE, NULL);
21595 /* When skipping or the return gets pending, advance to the next command
21596 * in this line (!returning). Otherwise, ignore the rest of the line.
21597 * Following lines will be ignored by get_func_line(). */
21598 if (returning)
21599 eap->nextcmd = NULL;
21600 else if (eap->nextcmd == NULL) /* no argument */
21601 eap->nextcmd = check_nextcmd(arg);
21603 if (eap->skip)
21604 --emsg_skip;
21608 * Return from a function. Possibly makes the return pending. Also called
21609 * for a pending return at the ":endtry" or after returning from an extra
21610 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21611 * when called due to a ":return" command. "rettv" may point to a typval_T
21612 * with the return rettv. Returns TRUE when the return can be carried out,
21613 * FALSE when the return gets pending.
21616 do_return(eap, reanimate, is_cmd, rettv)
21617 exarg_T *eap;
21618 int reanimate;
21619 int is_cmd;
21620 void *rettv;
21622 int idx;
21623 struct condstack *cstack = eap->cstack;
21625 if (reanimate)
21626 /* Undo the return. */
21627 current_funccal->returned = FALSE;
21630 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21631 * not in its finally clause (which then is to be executed next) is found.
21632 * In this case, make the ":return" pending for execution at the ":endtry".
21633 * Otherwise, return normally.
21635 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21636 if (idx >= 0)
21638 cstack->cs_pending[idx] = CSTP_RETURN;
21640 if (!is_cmd && !reanimate)
21641 /* A pending return again gets pending. "rettv" points to an
21642 * allocated variable with the rettv of the original ":return"'s
21643 * argument if present or is NULL else. */
21644 cstack->cs_rettv[idx] = rettv;
21645 else
21647 /* When undoing a return in order to make it pending, get the stored
21648 * return rettv. */
21649 if (reanimate)
21650 rettv = current_funccal->rettv;
21652 if (rettv != NULL)
21654 /* Store the value of the pending return. */
21655 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21656 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21657 else
21658 EMSG(_(e_outofmem));
21660 else
21661 cstack->cs_rettv[idx] = NULL;
21663 if (reanimate)
21665 /* The pending return value could be overwritten by a ":return"
21666 * without argument in a finally clause; reset the default
21667 * return value. */
21668 current_funccal->rettv->v_type = VAR_NUMBER;
21669 current_funccal->rettv->vval.v_number = 0;
21672 report_make_pending(CSTP_RETURN, rettv);
21674 else
21676 current_funccal->returned = TRUE;
21678 /* If the return is carried out now, store the return value. For
21679 * a return immediately after reanimation, the value is already
21680 * there. */
21681 if (!reanimate && rettv != NULL)
21683 clear_tv(current_funccal->rettv);
21684 *current_funccal->rettv = *(typval_T *)rettv;
21685 if (!is_cmd)
21686 vim_free(rettv);
21690 return idx < 0;
21694 * Free the variable with a pending return value.
21696 void
21697 discard_pending_return(rettv)
21698 void *rettv;
21700 free_tv((typval_T *)rettv);
21704 * Generate a return command for producing the value of "rettv". The result
21705 * is an allocated string. Used by report_pending() for verbose messages.
21707 char_u *
21708 get_return_cmd(rettv)
21709 void *rettv;
21711 char_u *s = NULL;
21712 char_u *tofree = NULL;
21713 char_u numbuf[NUMBUFLEN];
21715 if (rettv != NULL)
21716 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21717 if (s == NULL)
21718 s = (char_u *)"";
21720 STRCPY(IObuff, ":return ");
21721 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21722 if (STRLEN(s) + 8 >= IOSIZE)
21723 STRCPY(IObuff + IOSIZE - 4, "...");
21724 vim_free(tofree);
21725 return vim_strsave(IObuff);
21729 * Get next function line.
21730 * Called by do_cmdline() to get the next line.
21731 * Returns allocated string, or NULL for end of function.
21733 char_u *
21734 get_func_line(c, cookie, indent)
21735 int c UNUSED;
21736 void *cookie;
21737 int indent UNUSED;
21739 funccall_T *fcp = (funccall_T *)cookie;
21740 ufunc_T *fp = fcp->func;
21741 char_u *retval;
21742 garray_T *gap; /* growarray with function lines */
21744 /* If breakpoints have been added/deleted need to check for it. */
21745 if (fcp->dbg_tick != debug_tick)
21747 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21748 sourcing_lnum);
21749 fcp->dbg_tick = debug_tick;
21751 #ifdef FEAT_PROFILE
21752 if (do_profiling == PROF_YES)
21753 func_line_end(cookie);
21754 #endif
21756 gap = &fp->uf_lines;
21757 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21758 || fcp->returned)
21759 retval = NULL;
21760 else
21762 /* Skip NULL lines (continuation lines). */
21763 while (fcp->linenr < gap->ga_len
21764 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21765 ++fcp->linenr;
21766 if (fcp->linenr >= gap->ga_len)
21767 retval = NULL;
21768 else
21770 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21771 sourcing_lnum = fcp->linenr;
21772 #ifdef FEAT_PROFILE
21773 if (do_profiling == PROF_YES)
21774 func_line_start(cookie);
21775 #endif
21779 /* Did we encounter a breakpoint? */
21780 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21782 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21783 /* Find next breakpoint. */
21784 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21785 sourcing_lnum);
21786 fcp->dbg_tick = debug_tick;
21789 return retval;
21792 #if defined(FEAT_PROFILE) || defined(PROTO)
21794 * Called when starting to read a function line.
21795 * "sourcing_lnum" must be correct!
21796 * When skipping lines it may not actually be executed, but we won't find out
21797 * until later and we need to store the time now.
21799 void
21800 func_line_start(cookie)
21801 void *cookie;
21803 funccall_T *fcp = (funccall_T *)cookie;
21804 ufunc_T *fp = fcp->func;
21806 if (fp->uf_profiling && sourcing_lnum >= 1
21807 && sourcing_lnum <= fp->uf_lines.ga_len)
21809 fp->uf_tml_idx = sourcing_lnum - 1;
21810 /* Skip continuation lines. */
21811 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21812 --fp->uf_tml_idx;
21813 fp->uf_tml_execed = FALSE;
21814 profile_start(&fp->uf_tml_start);
21815 profile_zero(&fp->uf_tml_children);
21816 profile_get_wait(&fp->uf_tml_wait);
21821 * Called when actually executing a function line.
21823 void
21824 func_line_exec(cookie)
21825 void *cookie;
21827 funccall_T *fcp = (funccall_T *)cookie;
21828 ufunc_T *fp = fcp->func;
21830 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21831 fp->uf_tml_execed = TRUE;
21835 * Called when done with a function line.
21837 void
21838 func_line_end(cookie)
21839 void *cookie;
21841 funccall_T *fcp = (funccall_T *)cookie;
21842 ufunc_T *fp = fcp->func;
21844 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21846 if (fp->uf_tml_execed)
21848 ++fp->uf_tml_count[fp->uf_tml_idx];
21849 profile_end(&fp->uf_tml_start);
21850 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21851 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21852 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21853 &fp->uf_tml_children);
21855 fp->uf_tml_idx = -1;
21858 #endif
21861 * Return TRUE if the currently active function should be ended, because a
21862 * return was encountered or an error occurred. Used inside a ":while".
21865 func_has_ended(cookie)
21866 void *cookie;
21868 funccall_T *fcp = (funccall_T *)cookie;
21870 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21871 * an error inside a try conditional. */
21872 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21873 || fcp->returned);
21877 * return TRUE if cookie indicates a function which "abort"s on errors.
21880 func_has_abort(cookie)
21881 void *cookie;
21883 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21886 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21887 typedef enum
21889 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21890 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21891 VAR_FLAVOUR_VIMINFO /* all uppercase */
21892 } var_flavour_T;
21894 static var_flavour_T var_flavour __ARGS((char_u *varname));
21896 static var_flavour_T
21897 var_flavour(varname)
21898 char_u *varname;
21900 char_u *p = varname;
21902 if (ASCII_ISUPPER(*p))
21904 while (*(++p))
21905 if (ASCII_ISLOWER(*p))
21906 return VAR_FLAVOUR_SESSION;
21907 return VAR_FLAVOUR_VIMINFO;
21909 else
21910 return VAR_FLAVOUR_DEFAULT;
21912 #endif
21914 #if defined(FEAT_VIMINFO) || defined(PROTO)
21916 * Restore global vars that start with a capital from the viminfo file
21919 read_viminfo_varlist(virp, writing)
21920 vir_T *virp;
21921 int writing;
21923 char_u *tab;
21924 int type = VAR_NUMBER;
21925 typval_T tv;
21927 if (!writing && (find_viminfo_parameter('!') != NULL))
21929 tab = vim_strchr(virp->vir_line + 1, '\t');
21930 if (tab != NULL)
21932 *tab++ = '\0'; /* isolate the variable name */
21933 if (*tab == 'S') /* string var */
21934 type = VAR_STRING;
21935 #ifdef FEAT_FLOAT
21936 else if (*tab == 'F')
21937 type = VAR_FLOAT;
21938 #endif
21940 tab = vim_strchr(tab, '\t');
21941 if (tab != NULL)
21943 tv.v_type = type;
21944 if (type == VAR_STRING)
21945 tv.vval.v_string = viminfo_readstring(virp,
21946 (int)(tab - virp->vir_line + 1), TRUE);
21947 #ifdef FEAT_FLOAT
21948 else if (type == VAR_FLOAT)
21949 (void)string2float(tab + 1, &tv.vval.v_float);
21950 #endif
21951 else
21952 tv.vval.v_number = atol((char *)tab + 1);
21953 set_var(virp->vir_line + 1, &tv, FALSE);
21954 if (type == VAR_STRING)
21955 vim_free(tv.vval.v_string);
21960 return viminfo_readline(virp);
21964 * Write global vars that start with a capital to the viminfo file
21966 void
21967 write_viminfo_varlist(fp)
21968 FILE *fp;
21970 hashitem_T *hi;
21971 dictitem_T *this_var;
21972 int todo;
21973 char *s;
21974 char_u *p;
21975 char_u *tofree;
21976 char_u numbuf[NUMBUFLEN];
21978 if (find_viminfo_parameter('!') == NULL)
21979 return;
21981 fprintf(fp, _("\n# global variables:\n"));
21983 todo = (int)globvarht.ht_used;
21984 for (hi = globvarht.ht_array; todo > 0; ++hi)
21986 if (!HASHITEM_EMPTY(hi))
21988 --todo;
21989 this_var = HI2DI(hi);
21990 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21992 switch (this_var->di_tv.v_type)
21994 case VAR_STRING: s = "STR"; break;
21995 case VAR_NUMBER: s = "NUM"; break;
21996 #ifdef FEAT_FLOAT
21997 case VAR_FLOAT: s = "FLO"; break;
21998 #endif
21999 default: continue;
22001 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
22002 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
22003 if (p != NULL)
22004 viminfo_writestring(fp, p);
22005 vim_free(tofree);
22010 #endif
22012 #if defined(FEAT_SESSION) || defined(PROTO)
22014 store_session_globals(fd)
22015 FILE *fd;
22017 hashitem_T *hi;
22018 dictitem_T *this_var;
22019 int todo;
22020 char_u *p, *t;
22022 todo = (int)globvarht.ht_used;
22023 for (hi = globvarht.ht_array; todo > 0; ++hi)
22025 if (!HASHITEM_EMPTY(hi))
22027 --todo;
22028 this_var = HI2DI(hi);
22029 if ((this_var->di_tv.v_type == VAR_NUMBER
22030 || this_var->di_tv.v_type == VAR_STRING)
22031 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22033 /* Escape special characters with a backslash. Turn a LF and
22034 * CR into \n and \r. */
22035 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
22036 (char_u *)"\\\"\n\r");
22037 if (p == NULL) /* out of memory */
22038 break;
22039 for (t = p; *t != NUL; ++t)
22040 if (*t == '\n')
22041 *t = 'n';
22042 else if (*t == '\r')
22043 *t = 'r';
22044 if ((fprintf(fd, "let %s = %c%s%c",
22045 this_var->di_key,
22046 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22047 : ' ',
22049 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22050 : ' ') < 0)
22051 || put_eol(fd) == FAIL)
22053 vim_free(p);
22054 return FAIL;
22056 vim_free(p);
22058 #ifdef FEAT_FLOAT
22059 else if (this_var->di_tv.v_type == VAR_FLOAT
22060 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22062 float_T f = this_var->di_tv.vval.v_float;
22063 int sign = ' ';
22065 if (f < 0)
22067 f = -f;
22068 sign = '-';
22070 if ((fprintf(fd, "let %s = %c&%f",
22071 this_var->di_key, sign, f) < 0)
22072 || put_eol(fd) == FAIL)
22073 return FAIL;
22075 #endif
22078 return OK;
22080 #endif
22083 * Display script name where an item was last set.
22084 * Should only be invoked when 'verbose' is non-zero.
22086 void
22087 last_set_msg(scriptID)
22088 scid_T scriptID;
22090 char_u *p;
22092 if (scriptID != 0)
22094 p = home_replace_save(NULL, get_scriptname(scriptID));
22095 if (p != NULL)
22097 verbose_enter();
22098 MSG_PUTS(_("\n\tLast set from "));
22099 MSG_PUTS(p);
22100 vim_free(p);
22101 verbose_leave();
22107 * List v:oldfiles in a nice way.
22109 void
22110 ex_oldfiles(eap)
22111 exarg_T *eap UNUSED;
22113 list_T *l = vimvars[VV_OLDFILES].vv_list;
22114 listitem_T *li;
22115 int nr = 0;
22117 if (l == NULL)
22118 msg((char_u *)_("No old files"));
22119 else
22121 msg_start();
22122 msg_scroll = TRUE;
22123 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22125 msg_outnum((long)++nr);
22126 MSG_PUTS(": ");
22127 msg_outtrans(get_tv_string(&li->li_tv));
22128 msg_putchar('\n');
22129 out_flush(); /* output one line at a time */
22130 ui_breakcheck();
22132 /* Assume "got_int" was set to truncate the listing. */
22133 got_int = FALSE;
22135 #ifdef FEAT_BROWSE_CMD
22136 if (cmdmod.browse)
22138 quit_more = FALSE;
22139 nr = prompt_for_number(FALSE);
22140 msg_starthere();
22141 if (nr > 0)
22143 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22144 (long)nr);
22146 if (p != NULL)
22148 p = expand_env_save(p);
22149 eap->arg = p;
22150 eap->cmdidx = CMD_edit;
22151 cmdmod.browse = FALSE;
22152 do_exedit(eap, NULL);
22153 vim_free(p);
22157 #endif
22161 #endif /* FEAT_EVAL */
22164 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22166 #ifdef WIN3264
22168 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22170 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22171 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22172 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22175 * Get the short path (8.3) for the filename in "fnamep".
22176 * Only works for a valid file name.
22177 * When the path gets longer "fnamep" is changed and the allocated buffer
22178 * is put in "bufp".
22179 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22180 * Returns OK on success, FAIL on failure.
22182 static int
22183 get_short_pathname(fnamep, bufp, fnamelen)
22184 char_u **fnamep;
22185 char_u **bufp;
22186 int *fnamelen;
22188 int l, len;
22189 char_u *newbuf;
22191 len = *fnamelen;
22192 l = GetShortPathName(*fnamep, *fnamep, len);
22193 if (l > len - 1)
22195 /* If that doesn't work (not enough space), then save the string
22196 * and try again with a new buffer big enough. */
22197 newbuf = vim_strnsave(*fnamep, l);
22198 if (newbuf == NULL)
22199 return FAIL;
22201 vim_free(*bufp);
22202 *fnamep = *bufp = newbuf;
22204 /* Really should always succeed, as the buffer is big enough. */
22205 l = GetShortPathName(*fnamep, *fnamep, l+1);
22208 *fnamelen = l;
22209 return OK;
22213 * Get the short path (8.3) for the filename in "fname". The converted
22214 * path is returned in "bufp".
22216 * Some of the directories specified in "fname" may not exist. This function
22217 * will shorten the existing directories at the beginning of the path and then
22218 * append the remaining non-existing path.
22220 * fname - Pointer to the filename to shorten. On return, contains the
22221 * pointer to the shortened pathname
22222 * bufp - Pointer to an allocated buffer for the filename.
22223 * fnamelen - Length of the filename pointed to by fname
22225 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22227 static int
22228 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22229 char_u **fname;
22230 char_u **bufp;
22231 int *fnamelen;
22233 char_u *short_fname, *save_fname, *pbuf_unused;
22234 char_u *endp, *save_endp;
22235 char_u ch;
22236 int old_len, len;
22237 int new_len, sfx_len;
22238 int retval = OK;
22240 /* Make a copy */
22241 old_len = *fnamelen;
22242 save_fname = vim_strnsave(*fname, old_len);
22243 pbuf_unused = NULL;
22244 short_fname = NULL;
22246 endp = save_fname + old_len - 1; /* Find the end of the copy */
22247 save_endp = endp;
22250 * Try shortening the supplied path till it succeeds by removing one
22251 * directory at a time from the tail of the path.
22253 len = 0;
22254 for (;;)
22256 /* go back one path-separator */
22257 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22258 --endp;
22259 if (endp <= save_fname)
22260 break; /* processed the complete path */
22263 * Replace the path separator with a NUL and try to shorten the
22264 * resulting path.
22266 ch = *endp;
22267 *endp = 0;
22268 short_fname = save_fname;
22269 len = (int)STRLEN(short_fname) + 1;
22270 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22272 retval = FAIL;
22273 goto theend;
22275 *endp = ch; /* preserve the string */
22277 if (len > 0)
22278 break; /* successfully shortened the path */
22280 /* failed to shorten the path. Skip the path separator */
22281 --endp;
22284 if (len > 0)
22287 * Succeeded in shortening the path. Now concatenate the shortened
22288 * path with the remaining path at the tail.
22291 /* Compute the length of the new path. */
22292 sfx_len = (int)(save_endp - endp) + 1;
22293 new_len = len + sfx_len;
22295 *fnamelen = new_len;
22296 vim_free(*bufp);
22297 if (new_len > old_len)
22299 /* There is not enough space in the currently allocated string,
22300 * copy it to a buffer big enough. */
22301 *fname = *bufp = vim_strnsave(short_fname, new_len);
22302 if (*fname == NULL)
22304 retval = FAIL;
22305 goto theend;
22308 else
22310 /* Transfer short_fname to the main buffer (it's big enough),
22311 * unless get_short_pathname() did its work in-place. */
22312 *fname = *bufp = save_fname;
22313 if (short_fname != save_fname)
22314 vim_strncpy(save_fname, short_fname, len);
22315 save_fname = NULL;
22318 /* concat the not-shortened part of the path */
22319 vim_strncpy(*fname + len, endp, sfx_len);
22320 (*fname)[new_len] = NUL;
22323 theend:
22324 vim_free(pbuf_unused);
22325 vim_free(save_fname);
22327 return retval;
22331 * Get a pathname for a partial path.
22332 * Returns OK for success, FAIL for failure.
22334 static int
22335 shortpath_for_partial(fnamep, bufp, fnamelen)
22336 char_u **fnamep;
22337 char_u **bufp;
22338 int *fnamelen;
22340 int sepcount, len, tflen;
22341 char_u *p;
22342 char_u *pbuf, *tfname;
22343 int hasTilde;
22345 /* Count up the path separators from the RHS.. so we know which part
22346 * of the path to return. */
22347 sepcount = 0;
22348 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22349 if (vim_ispathsep(*p))
22350 ++sepcount;
22352 /* Need full path first (use expand_env() to remove a "~/") */
22353 hasTilde = (**fnamep == '~');
22354 if (hasTilde)
22355 pbuf = tfname = expand_env_save(*fnamep);
22356 else
22357 pbuf = tfname = FullName_save(*fnamep, FALSE);
22359 len = tflen = (int)STRLEN(tfname);
22361 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22362 return FAIL;
22364 if (len == 0)
22366 /* Don't have a valid filename, so shorten the rest of the
22367 * path if we can. This CAN give us invalid 8.3 filenames, but
22368 * there's not a lot of point in guessing what it might be.
22370 len = tflen;
22371 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22372 return FAIL;
22375 /* Count the paths backward to find the beginning of the desired string. */
22376 for (p = tfname + len - 1; p >= tfname; --p)
22378 #ifdef FEAT_MBYTE
22379 if (has_mbyte)
22380 p -= mb_head_off(tfname, p);
22381 #endif
22382 if (vim_ispathsep(*p))
22384 if (sepcount == 0 || (hasTilde && sepcount == 1))
22385 break;
22386 else
22387 sepcount --;
22390 if (hasTilde)
22392 --p;
22393 if (p >= tfname)
22394 *p = '~';
22395 else
22396 return FAIL;
22398 else
22399 ++p;
22401 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22402 vim_free(*bufp);
22403 *fnamelen = (int)STRLEN(p);
22404 *bufp = pbuf;
22405 *fnamep = p;
22407 return OK;
22409 #endif /* WIN3264 */
22412 * Adjust a filename, according to a string of modifiers.
22413 * *fnamep must be NUL terminated when called. When returning, the length is
22414 * determined by *fnamelen.
22415 * Returns VALID_ flags or -1 for failure.
22416 * When there is an error, *fnamep is set to NULL.
22419 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22420 char_u *src; /* string with modifiers */
22421 int *usedlen; /* characters after src that are used */
22422 char_u **fnamep; /* file name so far */
22423 char_u **bufp; /* buffer for allocated file name or NULL */
22424 int *fnamelen; /* length of fnamep */
22426 int valid = 0;
22427 char_u *tail;
22428 char_u *s, *p, *pbuf;
22429 char_u dirname[MAXPATHL];
22430 int c;
22431 int has_fullname = 0;
22432 #ifdef WIN3264
22433 int has_shortname = 0;
22434 #endif
22436 repeat:
22437 /* ":p" - full path/file_name */
22438 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22440 has_fullname = 1;
22442 valid |= VALID_PATH;
22443 *usedlen += 2;
22445 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22446 if ((*fnamep)[0] == '~'
22447 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22448 && ((*fnamep)[1] == '/'
22449 # ifdef BACKSLASH_IN_FILENAME
22450 || (*fnamep)[1] == '\\'
22451 # endif
22452 || (*fnamep)[1] == NUL)
22454 #endif
22457 *fnamep = expand_env_save(*fnamep);
22458 vim_free(*bufp); /* free any allocated file name */
22459 *bufp = *fnamep;
22460 if (*fnamep == NULL)
22461 return -1;
22464 /* When "/." or "/.." is used: force expansion to get rid of it. */
22465 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22467 if (vim_ispathsep(*p)
22468 && p[1] == '.'
22469 && (p[2] == NUL
22470 || vim_ispathsep(p[2])
22471 || (p[2] == '.'
22472 && (p[3] == NUL || vim_ispathsep(p[3])))))
22473 break;
22476 /* FullName_save() is slow, don't use it when not needed. */
22477 if (*p != NUL || !vim_isAbsName(*fnamep))
22479 *fnamep = FullName_save(*fnamep, *p != NUL);
22480 vim_free(*bufp); /* free any allocated file name */
22481 *bufp = *fnamep;
22482 if (*fnamep == NULL)
22483 return -1;
22486 /* Append a path separator to a directory. */
22487 if (mch_isdir(*fnamep))
22489 /* Make room for one or two extra characters. */
22490 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22491 vim_free(*bufp); /* free any allocated file name */
22492 *bufp = *fnamep;
22493 if (*fnamep == NULL)
22494 return -1;
22495 add_pathsep(*fnamep);
22499 /* ":." - path relative to the current directory */
22500 /* ":~" - path relative to the home directory */
22501 /* ":8" - shortname path - postponed till after */
22502 while (src[*usedlen] == ':'
22503 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22505 *usedlen += 2;
22506 if (c == '8')
22508 #ifdef WIN3264
22509 has_shortname = 1; /* Postpone this. */
22510 #endif
22511 continue;
22513 pbuf = NULL;
22514 /* Need full path first (use expand_env() to remove a "~/") */
22515 if (!has_fullname)
22517 if (c == '.' && **fnamep == '~')
22518 p = pbuf = expand_env_save(*fnamep);
22519 else
22520 p = pbuf = FullName_save(*fnamep, FALSE);
22522 else
22523 p = *fnamep;
22525 has_fullname = 0;
22527 if (p != NULL)
22529 if (c == '.')
22531 mch_dirname(dirname, MAXPATHL);
22532 s = shorten_fname(p, dirname);
22533 if (s != NULL)
22535 *fnamep = s;
22536 if (pbuf != NULL)
22538 vim_free(*bufp); /* free any allocated file name */
22539 *bufp = pbuf;
22540 pbuf = NULL;
22544 else
22546 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22547 /* Only replace it when it starts with '~' */
22548 if (*dirname == '~')
22550 s = vim_strsave(dirname);
22551 if (s != NULL)
22553 *fnamep = s;
22554 vim_free(*bufp);
22555 *bufp = s;
22559 vim_free(pbuf);
22563 tail = gettail(*fnamep);
22564 *fnamelen = (int)STRLEN(*fnamep);
22566 /* ":h" - head, remove "/file_name", can be repeated */
22567 /* Don't remove the first "/" or "c:\" */
22568 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22570 valid |= VALID_HEAD;
22571 *usedlen += 2;
22572 s = get_past_head(*fnamep);
22573 while (tail > s && after_pathsep(s, tail))
22574 mb_ptr_back(*fnamep, tail);
22575 *fnamelen = (int)(tail - *fnamep);
22576 #ifdef VMS
22577 if (*fnamelen > 0)
22578 *fnamelen += 1; /* the path separator is part of the path */
22579 #endif
22580 if (*fnamelen == 0)
22582 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22583 p = vim_strsave((char_u *)".");
22584 if (p == NULL)
22585 return -1;
22586 vim_free(*bufp);
22587 *bufp = *fnamep = tail = p;
22588 *fnamelen = 1;
22590 else
22592 while (tail > s && !after_pathsep(s, tail))
22593 mb_ptr_back(*fnamep, tail);
22597 /* ":8" - shortname */
22598 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22600 *usedlen += 2;
22601 #ifdef WIN3264
22602 has_shortname = 1;
22603 #endif
22606 #ifdef WIN3264
22607 /* Check shortname after we have done 'heads' and before we do 'tails'
22609 if (has_shortname)
22611 pbuf = NULL;
22612 /* Copy the string if it is shortened by :h */
22613 if (*fnamelen < (int)STRLEN(*fnamep))
22615 p = vim_strnsave(*fnamep, *fnamelen);
22616 if (p == 0)
22617 return -1;
22618 vim_free(*bufp);
22619 *bufp = *fnamep = p;
22622 /* Split into two implementations - makes it easier. First is where
22623 * there isn't a full name already, second is where there is.
22625 if (!has_fullname && !vim_isAbsName(*fnamep))
22627 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22628 return -1;
22630 else
22632 int l;
22634 /* Simple case, already have the full-name
22635 * Nearly always shorter, so try first time. */
22636 l = *fnamelen;
22637 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22638 return -1;
22640 if (l == 0)
22642 /* Couldn't find the filename.. search the paths.
22644 l = *fnamelen;
22645 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22646 return -1;
22648 *fnamelen = l;
22651 #endif /* WIN3264 */
22653 /* ":t" - tail, just the basename */
22654 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22656 *usedlen += 2;
22657 *fnamelen -= (int)(tail - *fnamep);
22658 *fnamep = tail;
22661 /* ":e" - extension, can be repeated */
22662 /* ":r" - root, without extension, can be repeated */
22663 while (src[*usedlen] == ':'
22664 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22666 /* find a '.' in the tail:
22667 * - for second :e: before the current fname
22668 * - otherwise: The last '.'
22670 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22671 s = *fnamep - 2;
22672 else
22673 s = *fnamep + *fnamelen - 1;
22674 for ( ; s > tail; --s)
22675 if (s[0] == '.')
22676 break;
22677 if (src[*usedlen + 1] == 'e') /* :e */
22679 if (s > tail)
22681 *fnamelen += (int)(*fnamep - (s + 1));
22682 *fnamep = s + 1;
22683 #ifdef VMS
22684 /* cut version from the extension */
22685 s = *fnamep + *fnamelen - 1;
22686 for ( ; s > *fnamep; --s)
22687 if (s[0] == ';')
22688 break;
22689 if (s > *fnamep)
22690 *fnamelen = s - *fnamep;
22691 #endif
22693 else if (*fnamep <= tail)
22694 *fnamelen = 0;
22696 else /* :r */
22698 if (s > tail) /* remove one extension */
22699 *fnamelen = (int)(s - *fnamep);
22701 *usedlen += 2;
22704 /* ":s?pat?foo?" - substitute */
22705 /* ":gs?pat?foo?" - global substitute */
22706 if (src[*usedlen] == ':'
22707 && (src[*usedlen + 1] == 's'
22708 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22710 char_u *str;
22711 char_u *pat;
22712 char_u *sub;
22713 int sep;
22714 char_u *flags;
22715 int didit = FALSE;
22717 flags = (char_u *)"";
22718 s = src + *usedlen + 2;
22719 if (src[*usedlen + 1] == 'g')
22721 flags = (char_u *)"g";
22722 ++s;
22725 sep = *s++;
22726 if (sep)
22728 /* find end of pattern */
22729 p = vim_strchr(s, sep);
22730 if (p != NULL)
22732 pat = vim_strnsave(s, (int)(p - s));
22733 if (pat != NULL)
22735 s = p + 1;
22736 /* find end of substitution */
22737 p = vim_strchr(s, sep);
22738 if (p != NULL)
22740 sub = vim_strnsave(s, (int)(p - s));
22741 str = vim_strnsave(*fnamep, *fnamelen);
22742 if (sub != NULL && str != NULL)
22744 *usedlen = (int)(p + 1 - src);
22745 s = do_string_sub(str, pat, sub, flags);
22746 if (s != NULL)
22748 *fnamep = s;
22749 *fnamelen = (int)STRLEN(s);
22750 vim_free(*bufp);
22751 *bufp = s;
22752 didit = TRUE;
22755 vim_free(sub);
22756 vim_free(str);
22758 vim_free(pat);
22761 /* after using ":s", repeat all the modifiers */
22762 if (didit)
22763 goto repeat;
22767 return valid;
22771 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22772 * "flags" can be "g" to do a global substitute.
22773 * Returns an allocated string, NULL for error.
22775 char_u *
22776 do_string_sub(str, pat, sub, flags)
22777 char_u *str;
22778 char_u *pat;
22779 char_u *sub;
22780 char_u *flags;
22782 int sublen;
22783 regmatch_T regmatch;
22784 int i;
22785 int do_all;
22786 char_u *tail;
22787 garray_T ga;
22788 char_u *ret;
22789 char_u *save_cpo;
22791 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22792 save_cpo = p_cpo;
22793 p_cpo = empty_option;
22795 ga_init2(&ga, 1, 200);
22797 do_all = (flags[0] == 'g');
22799 regmatch.rm_ic = p_ic;
22800 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22801 if (regmatch.regprog != NULL)
22803 tail = str;
22804 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22807 * Get some space for a temporary buffer to do the substitution
22808 * into. It will contain:
22809 * - The text up to where the match is.
22810 * - The substituted text.
22811 * - The text after the match.
22813 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22814 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22815 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22817 ga_clear(&ga);
22818 break;
22821 /* copy the text up to where the match is */
22822 i = (int)(regmatch.startp[0] - tail);
22823 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22824 /* add the substituted text */
22825 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22826 + ga.ga_len + i, TRUE, TRUE, FALSE);
22827 ga.ga_len += i + sublen - 1;
22828 /* avoid getting stuck on a match with an empty string */
22829 if (tail == regmatch.endp[0])
22831 if (*tail == NUL)
22832 break;
22833 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22834 ++ga.ga_len;
22836 else
22838 tail = regmatch.endp[0];
22839 if (*tail == NUL)
22840 break;
22842 if (!do_all)
22843 break;
22846 if (ga.ga_data != NULL)
22847 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22849 vim_free(regmatch.regprog);
22852 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22853 ga_clear(&ga);
22854 if (p_cpo == empty_option)
22855 p_cpo = save_cpo;
22856 else
22857 /* Darn, evaluating {sub} expression changed the value. */
22858 free_string_option(save_cpo);
22860 return ret;
22863 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */