Merge branch 'vim'
[MacVim.git] / src / eval.c
blob7011f89ea93389a8acfd75d9637c18a1e7cb293c
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_tv __ARGS((list_T *l, typval_T *tv));
437 static int list_append_number __ARGS((list_T *l, varnumber_T n));
438 static int list_insert_tv __ARGS((list_T *l, typval_T *tv, listitem_T *item));
439 static int list_extend __ARGS((list_T *l1, list_T *l2, listitem_T *bef));
440 static int list_concat __ARGS((list_T *l1, list_T *l2, typval_T *tv));
441 static list_T *list_copy __ARGS((list_T *orig, int deep, int copyID));
442 static void list_remove __ARGS((list_T *l, listitem_T *item, listitem_T *item2));
443 static char_u *list2string __ARGS((typval_T *tv, int copyID));
444 static int list_join __ARGS((garray_T *gap, list_T *l, char_u *sep, int echo, int copyID));
445 static int free_unref_items __ARGS((int copyID));
446 static void set_ref_in_ht __ARGS((hashtab_T *ht, int copyID));
447 static void set_ref_in_list __ARGS((list_T *l, int copyID));
448 static void set_ref_in_item __ARGS((typval_T *tv, int copyID));
449 static void dict_unref __ARGS((dict_T *d));
450 static void dict_free __ARGS((dict_T *d, int recurse));
451 static dictitem_T *dictitem_alloc __ARGS((char_u *key));
452 static dictitem_T *dictitem_copy __ARGS((dictitem_T *org));
453 static void dictitem_remove __ARGS((dict_T *dict, dictitem_T *item));
454 static void dictitem_free __ARGS((dictitem_T *item));
455 static dict_T *dict_copy __ARGS((dict_T *orig, int deep, int copyID));
456 static int dict_add __ARGS((dict_T *d, dictitem_T *item));
457 static long dict_len __ARGS((dict_T *d));
458 static dictitem_T *dict_find __ARGS((dict_T *d, char_u *key, int len));
459 static char_u *dict2string __ARGS((typval_T *tv, int copyID));
460 static int get_dict_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
461 static char_u *echo_string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
462 static char_u *tv2string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
463 static char_u *string_quote __ARGS((char_u *str, int function));
464 #ifdef FEAT_FLOAT
465 static int string2float __ARGS((char_u *text, float_T *value));
466 #endif
467 static int get_env_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
468 static int find_internal_func __ARGS((char_u *name));
469 static char_u *deref_func_name __ARGS((char_u *name, int *lenp));
470 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));
471 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));
472 static void emsg_funcname __ARGS((char *ermsg, char_u *name));
473 static int non_zero_arg __ARGS((typval_T *argvars));
475 #ifdef FEAT_FLOAT
476 static void f_abs __ARGS((typval_T *argvars, typval_T *rettv));
477 #endif
478 static void f_add __ARGS((typval_T *argvars, typval_T *rettv));
479 static void f_append __ARGS((typval_T *argvars, typval_T *rettv));
480 static void f_argc __ARGS((typval_T *argvars, typval_T *rettv));
481 static void f_argidx __ARGS((typval_T *argvars, typval_T *rettv));
482 static void f_argv __ARGS((typval_T *argvars, typval_T *rettv));
483 #ifdef FEAT_FLOAT
484 static void f_atan __ARGS((typval_T *argvars, typval_T *rettv));
485 #endif
486 static void f_browse __ARGS((typval_T *argvars, typval_T *rettv));
487 static void f_browsedir __ARGS((typval_T *argvars, typval_T *rettv));
488 static void f_bufexists __ARGS((typval_T *argvars, typval_T *rettv));
489 static void f_buflisted __ARGS((typval_T *argvars, typval_T *rettv));
490 static void f_bufloaded __ARGS((typval_T *argvars, typval_T *rettv));
491 static void f_bufname __ARGS((typval_T *argvars, typval_T *rettv));
492 static void f_bufnr __ARGS((typval_T *argvars, typval_T *rettv));
493 static void f_bufwinnr __ARGS((typval_T *argvars, typval_T *rettv));
494 static void f_byte2line __ARGS((typval_T *argvars, typval_T *rettv));
495 static void f_byteidx __ARGS((typval_T *argvars, typval_T *rettv));
496 static void f_call __ARGS((typval_T *argvars, typval_T *rettv));
497 #ifdef FEAT_FLOAT
498 static void f_ceil __ARGS((typval_T *argvars, typval_T *rettv));
499 #endif
500 static void f_changenr __ARGS((typval_T *argvars, typval_T *rettv));
501 static void f_char2nr __ARGS((typval_T *argvars, typval_T *rettv));
502 static void f_cindent __ARGS((typval_T *argvars, typval_T *rettv));
503 static void f_clearmatches __ARGS((typval_T *argvars, typval_T *rettv));
504 static void f_col __ARGS((typval_T *argvars, typval_T *rettv));
505 #if defined(FEAT_INS_EXPAND)
506 static void f_complete __ARGS((typval_T *argvars, typval_T *rettv));
507 static void f_complete_add __ARGS((typval_T *argvars, typval_T *rettv));
508 static void f_complete_check __ARGS((typval_T *argvars, typval_T *rettv));
509 #endif
510 static void f_confirm __ARGS((typval_T *argvars, typval_T *rettv));
511 static void f_copy __ARGS((typval_T *argvars, typval_T *rettv));
512 #ifdef FEAT_FLOAT
513 static void f_cos __ARGS((typval_T *argvars, typval_T *rettv));
514 #endif
515 static void f_count __ARGS((typval_T *argvars, typval_T *rettv));
516 static void f_cscope_connection __ARGS((typval_T *argvars, typval_T *rettv));
517 static void f_cursor __ARGS((typval_T *argsvars, typval_T *rettv));
518 static void f_deepcopy __ARGS((typval_T *argvars, typval_T *rettv));
519 static void f_delete __ARGS((typval_T *argvars, typval_T *rettv));
520 static void f_did_filetype __ARGS((typval_T *argvars, typval_T *rettv));
521 static void f_diff_filler __ARGS((typval_T *argvars, typval_T *rettv));
522 static void f_diff_hlID __ARGS((typval_T *argvars, typval_T *rettv));
523 static void f_empty __ARGS((typval_T *argvars, typval_T *rettv));
524 static void f_escape __ARGS((typval_T *argvars, typval_T *rettv));
525 static void f_eval __ARGS((typval_T *argvars, typval_T *rettv));
526 static void f_eventhandler __ARGS((typval_T *argvars, typval_T *rettv));
527 static void f_executable __ARGS((typval_T *argvars, typval_T *rettv));
528 static void f_exists __ARGS((typval_T *argvars, typval_T *rettv));
529 static void f_expand __ARGS((typval_T *argvars, typval_T *rettv));
530 static void f_extend __ARGS((typval_T *argvars, typval_T *rettv));
531 static void f_feedkeys __ARGS((typval_T *argvars, typval_T *rettv));
532 static void f_filereadable __ARGS((typval_T *argvars, typval_T *rettv));
533 static void f_filewritable __ARGS((typval_T *argvars, typval_T *rettv));
534 static void f_filter __ARGS((typval_T *argvars, typval_T *rettv));
535 static void f_finddir __ARGS((typval_T *argvars, typval_T *rettv));
536 static void f_findfile __ARGS((typval_T *argvars, typval_T *rettv));
537 #ifdef FEAT_FLOAT
538 static void f_float2nr __ARGS((typval_T *argvars, typval_T *rettv));
539 static void f_floor __ARGS((typval_T *argvars, typval_T *rettv));
540 #endif
541 static void f_fnameescape __ARGS((typval_T *argvars, typval_T *rettv));
542 static void f_fnamemodify __ARGS((typval_T *argvars, typval_T *rettv));
543 static void f_foldclosed __ARGS((typval_T *argvars, typval_T *rettv));
544 static void f_foldclosedend __ARGS((typval_T *argvars, typval_T *rettv));
545 static void f_foldlevel __ARGS((typval_T *argvars, typval_T *rettv));
546 static void f_foldtext __ARGS((typval_T *argvars, typval_T *rettv));
547 static void f_foldtextresult __ARGS((typval_T *argvars, typval_T *rettv));
548 static void f_foreground __ARGS((typval_T *argvars, typval_T *rettv));
549 static void f_function __ARGS((typval_T *argvars, typval_T *rettv));
550 static void f_garbagecollect __ARGS((typval_T *argvars, typval_T *rettv));
551 static void f_get __ARGS((typval_T *argvars, typval_T *rettv));
552 static void f_getbufline __ARGS((typval_T *argvars, typval_T *rettv));
553 static void f_getbufvar __ARGS((typval_T *argvars, typval_T *rettv));
554 static void f_getchar __ARGS((typval_T *argvars, typval_T *rettv));
555 static void f_getcharmod __ARGS((typval_T *argvars, typval_T *rettv));
556 static void f_getcmdline __ARGS((typval_T *argvars, typval_T *rettv));
557 static void f_getcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
558 static void f_getcmdtype __ARGS((typval_T *argvars, typval_T *rettv));
559 static void f_getcwd __ARGS((typval_T *argvars, typval_T *rettv));
560 static void f_getfontname __ARGS((typval_T *argvars, typval_T *rettv));
561 static void f_getfperm __ARGS((typval_T *argvars, typval_T *rettv));
562 static void f_getfsize __ARGS((typval_T *argvars, typval_T *rettv));
563 static void f_getftime __ARGS((typval_T *argvars, typval_T *rettv));
564 static void f_getftype __ARGS((typval_T *argvars, typval_T *rettv));
565 static void f_getline __ARGS((typval_T *argvars, typval_T *rettv));
566 static void f_getmatches __ARGS((typval_T *argvars, typval_T *rettv));
567 static void f_getpid __ARGS((typval_T *argvars, typval_T *rettv));
568 static void f_getpos __ARGS((typval_T *argvars, typval_T *rettv));
569 static void f_getqflist __ARGS((typval_T *argvars, typval_T *rettv));
570 static void f_getreg __ARGS((typval_T *argvars, typval_T *rettv));
571 static void f_getregtype __ARGS((typval_T *argvars, typval_T *rettv));
572 static void f_gettabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
573 static void f_getwinposx __ARGS((typval_T *argvars, typval_T *rettv));
574 static void f_getwinposy __ARGS((typval_T *argvars, typval_T *rettv));
575 static void f_getwinvar __ARGS((typval_T *argvars, typval_T *rettv));
576 static void f_glob __ARGS((typval_T *argvars, typval_T *rettv));
577 static void f_globpath __ARGS((typval_T *argvars, typval_T *rettv));
578 static void f_has __ARGS((typval_T *argvars, typval_T *rettv));
579 static void f_has_key __ARGS((typval_T *argvars, typval_T *rettv));
580 static void f_haslocaldir __ARGS((typval_T *argvars, typval_T *rettv));
581 static void f_hasmapto __ARGS((typval_T *argvars, typval_T *rettv));
582 static void f_histadd __ARGS((typval_T *argvars, typval_T *rettv));
583 static void f_histdel __ARGS((typval_T *argvars, typval_T *rettv));
584 static void f_histget __ARGS((typval_T *argvars, typval_T *rettv));
585 static void f_histnr __ARGS((typval_T *argvars, typval_T *rettv));
586 static void f_hlID __ARGS((typval_T *argvars, typval_T *rettv));
587 static void f_hlexists __ARGS((typval_T *argvars, typval_T *rettv));
588 static void f_hostname __ARGS((typval_T *argvars, typval_T *rettv));
589 static void f_iconv __ARGS((typval_T *argvars, typval_T *rettv));
590 static void f_indent __ARGS((typval_T *argvars, typval_T *rettv));
591 static void f_index __ARGS((typval_T *argvars, typval_T *rettv));
592 static void f_input __ARGS((typval_T *argvars, typval_T *rettv));
593 static void f_inputdialog __ARGS((typval_T *argvars, typval_T *rettv));
594 static void f_inputlist __ARGS((typval_T *argvars, typval_T *rettv));
595 static void f_inputrestore __ARGS((typval_T *argvars, typval_T *rettv));
596 static void f_inputsave __ARGS((typval_T *argvars, typval_T *rettv));
597 static void f_inputsecret __ARGS((typval_T *argvars, typval_T *rettv));
598 static void f_insert __ARGS((typval_T *argvars, typval_T *rettv));
599 static void f_isdirectory __ARGS((typval_T *argvars, typval_T *rettv));
600 static void f_islocked __ARGS((typval_T *argvars, typval_T *rettv));
601 static void f_items __ARGS((typval_T *argvars, typval_T *rettv));
602 static void f_join __ARGS((typval_T *argvars, typval_T *rettv));
603 static void f_keys __ARGS((typval_T *argvars, typval_T *rettv));
604 static void f_last_buffer_nr __ARGS((typval_T *argvars, typval_T *rettv));
605 static void f_len __ARGS((typval_T *argvars, typval_T *rettv));
606 static void f_libcall __ARGS((typval_T *argvars, typval_T *rettv));
607 static void f_libcallnr __ARGS((typval_T *argvars, typval_T *rettv));
608 static void f_line __ARGS((typval_T *argvars, typval_T *rettv));
609 static void f_line2byte __ARGS((typval_T *argvars, typval_T *rettv));
610 static void f_lispindent __ARGS((typval_T *argvars, typval_T *rettv));
611 static void f_localtime __ARGS((typval_T *argvars, typval_T *rettv));
612 #ifdef FEAT_FLOAT
613 static void f_log10 __ARGS((typval_T *argvars, typval_T *rettv));
614 #endif
615 static void f_map __ARGS((typval_T *argvars, typval_T *rettv));
616 static void f_maparg __ARGS((typval_T *argvars, typval_T *rettv));
617 static void f_mapcheck __ARGS((typval_T *argvars, typval_T *rettv));
618 static void f_match __ARGS((typval_T *argvars, typval_T *rettv));
619 static void f_matchadd __ARGS((typval_T *argvars, typval_T *rettv));
620 static void f_matcharg __ARGS((typval_T *argvars, typval_T *rettv));
621 static void f_matchdelete __ARGS((typval_T *argvars, typval_T *rettv));
622 static void f_matchend __ARGS((typval_T *argvars, typval_T *rettv));
623 static void f_matchlist __ARGS((typval_T *argvars, typval_T *rettv));
624 static void f_matchstr __ARGS((typval_T *argvars, typval_T *rettv));
625 static void f_max __ARGS((typval_T *argvars, typval_T *rettv));
626 static void f_min __ARGS((typval_T *argvars, typval_T *rettv));
627 #ifdef vim_mkdir
628 static void f_mkdir __ARGS((typval_T *argvars, typval_T *rettv));
629 #endif
630 static void f_mode __ARGS((typval_T *argvars, typval_T *rettv));
631 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
632 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
633 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
634 #ifdef FEAT_FLOAT
635 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
636 #endif
637 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
642 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
643 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
644 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
645 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
646 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
647 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
648 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
649 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
650 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
651 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
652 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
653 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
654 #ifdef FEAT_FLOAT
655 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
656 #endif
657 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
668 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
669 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
670 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
671 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
672 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
673 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
674 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
675 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
676 #ifdef FEAT_FLOAT
677 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
678 #endif
679 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
680 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
681 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
682 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
683 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
684 #ifdef FEAT_FLOAT
685 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
686 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
687 #endif
688 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
689 #ifdef HAVE_STRFTIME
690 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
691 #endif
692 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
693 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
699 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
700 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
707 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
708 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
709 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
710 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
711 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
712 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
713 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
714 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
715 #ifdef FEAT_FLOAT
716 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
717 #endif
718 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
724 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
725 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
726 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
727 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
728 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
729 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
730 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
731 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
733 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
734 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
735 static int get_env_len __ARGS((char_u **arg));
736 static int get_id_len __ARGS((char_u **arg));
737 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
738 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
739 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
740 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
741 valid character */
742 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
743 static int eval_isnamec __ARGS((int c));
744 static int eval_isnamec1 __ARGS((int c));
745 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
746 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
747 static typval_T *alloc_tv __ARGS((void));
748 static typval_T *alloc_string_tv __ARGS((char_u *string));
749 static void init_tv __ARGS((typval_T *varp));
750 static long get_tv_number __ARGS((typval_T *varp));
751 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
752 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
753 static char_u *get_tv_string __ARGS((typval_T *varp));
754 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
755 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
756 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
757 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
758 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
759 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
760 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
761 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
762 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
763 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
764 static int var_check_ro __ARGS((int flags, char_u *name));
765 static int var_check_fixed __ARGS((int flags, char_u *name));
766 static int tv_check_lock __ARGS((int lock, char_u *name));
767 static void copy_tv __ARGS((typval_T *from, typval_T *to));
768 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
769 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
770 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
771 static int eval_fname_script __ARGS((char_u *p));
772 static int eval_fname_sid __ARGS((char_u *p));
773 static void list_func_head __ARGS((ufunc_T *fp, int indent));
774 static ufunc_T *find_func __ARGS((char_u *name));
775 static int function_exists __ARGS((char_u *name));
776 static int builtin_function __ARGS((char_u *name));
777 #ifdef FEAT_PROFILE
778 static void func_do_profile __ARGS((ufunc_T *fp));
779 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
780 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
781 static int
782 # ifdef __BORLANDC__
783 _RTLENTRYF
784 # endif
785 prof_total_cmp __ARGS((const void *s1, const void *s2));
786 static int
787 # ifdef __BORLANDC__
788 _RTLENTRYF
789 # endif
790 prof_self_cmp __ARGS((const void *s1, const void *s2));
791 #endif
792 static int script_autoload __ARGS((char_u *name, int reload));
793 static char_u *autoload_name __ARGS((char_u *name));
794 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
795 static void func_free __ARGS((ufunc_T *fp));
796 static void func_unref __ARGS((char_u *name));
797 static void func_ref __ARGS((char_u *name));
798 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));
799 static int can_free_funccal __ARGS((funccall_T *fc, int copyID)) ;
800 static void free_funccal __ARGS((funccall_T *fc, int free_val));
801 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
802 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
803 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
804 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
805 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
806 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
808 /* Character used as separated in autoload function/variable names. */
809 #define AUTOLOAD_CHAR '#'
812 * Initialize the global and v: variables.
814 void
815 eval_init()
817 int i;
818 struct vimvar *p;
820 init_var_dict(&globvardict, &globvars_var);
821 init_var_dict(&vimvardict, &vimvars_var);
822 hash_init(&compat_hashtab);
823 hash_init(&func_hashtab);
825 for (i = 0; i < VV_LEN; ++i)
827 p = &vimvars[i];
828 STRCPY(p->vv_di.di_key, p->vv_name);
829 if (p->vv_flags & VV_RO)
830 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
831 else if (p->vv_flags & VV_RO_SBX)
832 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
833 else
834 p->vv_di.di_flags = DI_FLAGS_FIX;
836 /* add to v: scope dict, unless the value is not always available */
837 if (p->vv_type != VAR_UNKNOWN)
838 hash_add(&vimvarht, p->vv_di.di_key);
839 if (p->vv_flags & VV_COMPAT)
840 /* add to compat scope dict */
841 hash_add(&compat_hashtab, p->vv_di.di_key);
843 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
846 #if defined(EXITFREE) || defined(PROTO)
847 void
848 eval_clear()
850 int i;
851 struct vimvar *p;
853 for (i = 0; i < VV_LEN; ++i)
855 p = &vimvars[i];
856 if (p->vv_di.di_tv.v_type == VAR_STRING)
858 vim_free(p->vv_str);
859 p->vv_str = NULL;
861 else if (p->vv_di.di_tv.v_type == VAR_LIST)
863 list_unref(p->vv_list);
864 p->vv_list = NULL;
867 hash_clear(&vimvarht);
868 hash_init(&vimvarht); /* garbage_collect() will access it */
869 hash_clear(&compat_hashtab);
871 /* script-local variables */
872 for (i = 1; i <= ga_scripts.ga_len; ++i)
873 vars_clear(&SCRIPT_VARS(i));
874 ga_clear(&ga_scripts);
875 free_scriptnames();
877 /* global variables */
878 vars_clear(&globvarht);
880 /* autoloaded script names */
881 ga_clear_strings(&ga_loaded);
883 /* unreferenced lists and dicts */
884 (void)garbage_collect();
886 /* functions */
887 free_all_functions();
888 hash_clear(&func_hashtab);
890 #endif
893 * Return the name of the executed function.
895 char_u *
896 func_name(cookie)
897 void *cookie;
899 return ((funccall_T *)cookie)->func->uf_name;
903 * Return the address holding the next breakpoint line for a funccall cookie.
905 linenr_T *
906 func_breakpoint(cookie)
907 void *cookie;
909 return &((funccall_T *)cookie)->breakpoint;
913 * Return the address holding the debug tick for a funccall cookie.
915 int *
916 func_dbg_tick(cookie)
917 void *cookie;
919 return &((funccall_T *)cookie)->dbg_tick;
923 * Return the nesting level for a funccall cookie.
926 func_level(cookie)
927 void *cookie;
929 return ((funccall_T *)cookie)->level;
932 /* pointer to funccal for currently active function */
933 funccall_T *current_funccal = NULL;
935 /* pointer to list of previously used funccal, still around because some
936 * item in it is still being used. */
937 funccall_T *previous_funccal = NULL;
940 * Return TRUE when a function was ended by a ":return" command.
943 current_func_returned()
945 return current_funccal->returned;
950 * Set an internal variable to a string value. Creates the variable if it does
951 * not already exist.
953 void
954 set_internal_string_var(name, value)
955 char_u *name;
956 char_u *value;
958 char_u *val;
959 typval_T *tvp;
961 val = vim_strsave(value);
962 if (val != NULL)
964 tvp = alloc_string_tv(val);
965 if (tvp != NULL)
967 set_var(name, tvp, FALSE);
968 free_tv(tvp);
973 static lval_T *redir_lval = NULL;
974 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
975 static char_u *redir_endp = NULL;
976 static char_u *redir_varname = NULL;
979 * Start recording command output to a variable
980 * Returns OK if successfully completed the setup. FAIL otherwise.
983 var_redir_start(name, append)
984 char_u *name;
985 int append; /* append to an existing variable */
987 int save_emsg;
988 int err;
989 typval_T tv;
991 /* Catch a bad name early. */
992 if (!eval_isnamec1(*name))
994 EMSG(_(e_invarg));
995 return FAIL;
998 /* Make a copy of the name, it is used in redir_lval until redir ends. */
999 redir_varname = vim_strsave(name);
1000 if (redir_varname == NULL)
1001 return FAIL;
1003 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
1004 if (redir_lval == NULL)
1006 var_redir_stop();
1007 return FAIL;
1010 /* The output is stored in growarray "redir_ga" until redirection ends. */
1011 ga_init2(&redir_ga, (int)sizeof(char), 500);
1013 /* Parse the variable name (can be a dict or list entry). */
1014 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1015 FNE_CHECK_START);
1016 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1018 if (redir_endp != NULL && *redir_endp != NUL)
1019 /* Trailing characters are present after the variable name */
1020 EMSG(_(e_trailing));
1021 else
1022 EMSG(_(e_invarg));
1023 redir_endp = NULL; /* don't store a value, only cleanup */
1024 var_redir_stop();
1025 return FAIL;
1028 /* check if we can write to the variable: set it to or append an empty
1029 * string */
1030 save_emsg = did_emsg;
1031 did_emsg = FALSE;
1032 tv.v_type = VAR_STRING;
1033 tv.vval.v_string = (char_u *)"";
1034 if (append)
1035 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1036 else
1037 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1038 err = did_emsg;
1039 did_emsg |= save_emsg;
1040 if (err)
1042 redir_endp = NULL; /* don't store a value, only cleanup */
1043 var_redir_stop();
1044 return FAIL;
1046 if (redir_lval->ll_newkey != NULL)
1048 /* Dictionary item was created, don't do it again. */
1049 vim_free(redir_lval->ll_newkey);
1050 redir_lval->ll_newkey = NULL;
1053 return OK;
1057 * Append "value[value_len]" to the variable set by var_redir_start().
1058 * The actual appending is postponed until redirection ends, because the value
1059 * appended may in fact be the string we write to, changing it may cause freed
1060 * memory to be used:
1061 * :redir => foo
1062 * :let foo
1063 * :redir END
1065 void
1066 var_redir_str(value, value_len)
1067 char_u *value;
1068 int value_len;
1070 int len;
1072 if (redir_lval == NULL)
1073 return;
1075 if (value_len == -1)
1076 len = (int)STRLEN(value); /* Append the entire string */
1077 else
1078 len = value_len; /* Append only "value_len" characters */
1080 if (ga_grow(&redir_ga, len) == OK)
1082 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1083 redir_ga.ga_len += len;
1085 else
1086 var_redir_stop();
1090 * Stop redirecting command output to a variable.
1091 * Frees the allocated memory.
1093 void
1094 var_redir_stop()
1096 typval_T tv;
1098 if (redir_lval != NULL)
1100 /* If there was no error: assign the text to the variable. */
1101 if (redir_endp != NULL)
1103 ga_append(&redir_ga, NUL); /* Append the trailing NUL. */
1104 tv.v_type = VAR_STRING;
1105 tv.vval.v_string = redir_ga.ga_data;
1106 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1109 /* free the collected output */
1110 vim_free(redir_ga.ga_data);
1111 redir_ga.ga_data = NULL;
1113 clear_lval(redir_lval);
1114 vim_free(redir_lval);
1115 redir_lval = NULL;
1117 vim_free(redir_varname);
1118 redir_varname = NULL;
1121 # if defined(FEAT_MBYTE) || defined(PROTO)
1123 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1124 char_u *enc_from;
1125 char_u *enc_to;
1126 char_u *fname_from;
1127 char_u *fname_to;
1129 int err = FALSE;
1131 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1132 set_vim_var_string(VV_CC_TO, enc_to, -1);
1133 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1134 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1135 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1136 err = TRUE;
1137 set_vim_var_string(VV_CC_FROM, NULL, -1);
1138 set_vim_var_string(VV_CC_TO, NULL, -1);
1139 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1140 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1142 if (err)
1143 return FAIL;
1144 return OK;
1146 # endif
1148 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1150 eval_printexpr(fname, args)
1151 char_u *fname;
1152 char_u *args;
1154 int err = FALSE;
1156 set_vim_var_string(VV_FNAME_IN, fname, -1);
1157 set_vim_var_string(VV_CMDARG, args, -1);
1158 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1159 err = TRUE;
1160 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1161 set_vim_var_string(VV_CMDARG, NULL, -1);
1163 if (err)
1165 mch_remove(fname);
1166 return FAIL;
1168 return OK;
1170 # endif
1172 # if defined(FEAT_DIFF) || defined(PROTO)
1173 void
1174 eval_diff(origfile, newfile, outfile)
1175 char_u *origfile;
1176 char_u *newfile;
1177 char_u *outfile;
1179 int err = FALSE;
1181 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1182 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1183 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1184 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1185 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1186 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1187 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1190 void
1191 eval_patch(origfile, difffile, outfile)
1192 char_u *origfile;
1193 char_u *difffile;
1194 char_u *outfile;
1196 int err;
1198 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1199 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1200 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1201 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1202 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1203 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1204 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1206 # endif
1209 * Top level evaluation function, returning a boolean.
1210 * Sets "error" to TRUE if there was an error.
1211 * Return TRUE or FALSE.
1214 eval_to_bool(arg, error, nextcmd, skip)
1215 char_u *arg;
1216 int *error;
1217 char_u **nextcmd;
1218 int skip; /* only parse, don't execute */
1220 typval_T tv;
1221 int retval = FALSE;
1223 if (skip)
1224 ++emsg_skip;
1225 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1226 *error = TRUE;
1227 else
1229 *error = FALSE;
1230 if (!skip)
1232 retval = (get_tv_number_chk(&tv, error) != 0);
1233 clear_tv(&tv);
1236 if (skip)
1237 --emsg_skip;
1239 return retval;
1243 * Top level evaluation function, returning a string. If "skip" is TRUE,
1244 * only parsing to "nextcmd" is done, without reporting errors. Return
1245 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1247 char_u *
1248 eval_to_string_skip(arg, nextcmd, skip)
1249 char_u *arg;
1250 char_u **nextcmd;
1251 int skip; /* only parse, don't execute */
1253 typval_T tv;
1254 char_u *retval;
1256 if (skip)
1257 ++emsg_skip;
1258 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1259 retval = NULL;
1260 else
1262 retval = vim_strsave(get_tv_string(&tv));
1263 clear_tv(&tv);
1265 if (skip)
1266 --emsg_skip;
1268 return retval;
1272 * Skip over an expression at "*pp".
1273 * Return FAIL for an error, OK otherwise.
1276 skip_expr(pp)
1277 char_u **pp;
1279 typval_T rettv;
1281 *pp = skipwhite(*pp);
1282 return eval1(pp, &rettv, FALSE);
1286 * Top level evaluation function, returning a string.
1287 * When "convert" is TRUE convert a List into a sequence of lines and convert
1288 * a Float to a String.
1289 * Return pointer to allocated memory, or NULL for failure.
1291 char_u *
1292 eval_to_string(arg, nextcmd, convert)
1293 char_u *arg;
1294 char_u **nextcmd;
1295 int convert;
1297 typval_T tv;
1298 char_u *retval;
1299 garray_T ga;
1300 #ifdef FEAT_FLOAT
1301 char_u numbuf[NUMBUFLEN];
1302 #endif
1304 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1305 retval = NULL;
1306 else
1308 if (convert && tv.v_type == VAR_LIST)
1310 ga_init2(&ga, (int)sizeof(char), 80);
1311 if (tv.vval.v_list != NULL)
1312 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1313 ga_append(&ga, NUL);
1314 retval = (char_u *)ga.ga_data;
1316 #ifdef FEAT_FLOAT
1317 else if (convert && tv.v_type == VAR_FLOAT)
1319 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1320 retval = vim_strsave(numbuf);
1322 #endif
1323 else
1324 retval = vim_strsave(get_tv_string(&tv));
1325 clear_tv(&tv);
1328 return retval;
1332 * Call eval_to_string() without using current local variables and using
1333 * textlock. When "use_sandbox" is TRUE use the sandbox.
1335 char_u *
1336 eval_to_string_safe(arg, nextcmd, use_sandbox)
1337 char_u *arg;
1338 char_u **nextcmd;
1339 int use_sandbox;
1341 char_u *retval;
1342 void *save_funccalp;
1344 save_funccalp = save_funccal();
1345 if (use_sandbox)
1346 ++sandbox;
1347 ++textlock;
1348 retval = eval_to_string(arg, nextcmd, FALSE);
1349 if (use_sandbox)
1350 --sandbox;
1351 --textlock;
1352 restore_funccal(save_funccalp);
1353 return retval;
1357 * Top level evaluation function, returning a number.
1358 * Evaluates "expr" silently.
1359 * Returns -1 for an error.
1362 eval_to_number(expr)
1363 char_u *expr;
1365 typval_T rettv;
1366 int retval;
1367 char_u *p = skipwhite(expr);
1369 ++emsg_off;
1371 if (eval1(&p, &rettv, TRUE) == FAIL)
1372 retval = -1;
1373 else
1375 retval = get_tv_number_chk(&rettv, NULL);
1376 clear_tv(&rettv);
1378 --emsg_off;
1380 return retval;
1384 * Prepare v: variable "idx" to be used.
1385 * Save the current typeval in "save_tv".
1386 * When not used yet add the variable to the v: hashtable.
1388 static void
1389 prepare_vimvar(idx, save_tv)
1390 int idx;
1391 typval_T *save_tv;
1393 *save_tv = vimvars[idx].vv_tv;
1394 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1395 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1399 * Restore v: variable "idx" to typeval "save_tv".
1400 * When no longer defined, remove the variable from the v: hashtable.
1402 static void
1403 restore_vimvar(idx, save_tv)
1404 int idx;
1405 typval_T *save_tv;
1407 hashitem_T *hi;
1409 vimvars[idx].vv_tv = *save_tv;
1410 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1412 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1413 if (HASHITEM_EMPTY(hi))
1414 EMSG2(_(e_intern2), "restore_vimvar()");
1415 else
1416 hash_remove(&vimvarht, hi);
1420 #if defined(FEAT_SPELL) || defined(PROTO)
1422 * Evaluate an expression to a list with suggestions.
1423 * For the "expr:" part of 'spellsuggest'.
1424 * Returns NULL when there is an error.
1426 list_T *
1427 eval_spell_expr(badword, expr)
1428 char_u *badword;
1429 char_u *expr;
1431 typval_T save_val;
1432 typval_T rettv;
1433 list_T *list = NULL;
1434 char_u *p = skipwhite(expr);
1436 /* Set "v:val" to the bad word. */
1437 prepare_vimvar(VV_VAL, &save_val);
1438 vimvars[VV_VAL].vv_type = VAR_STRING;
1439 vimvars[VV_VAL].vv_str = badword;
1440 if (p_verbose == 0)
1441 ++emsg_off;
1443 if (eval1(&p, &rettv, TRUE) == OK)
1445 if (rettv.v_type != VAR_LIST)
1446 clear_tv(&rettv);
1447 else
1448 list = rettv.vval.v_list;
1451 if (p_verbose == 0)
1452 --emsg_off;
1453 restore_vimvar(VV_VAL, &save_val);
1455 return list;
1459 * "list" is supposed to contain two items: a word and a number. Return the
1460 * word in "pp" and the number as the return value.
1461 * Return -1 if anything isn't right.
1462 * Used to get the good word and score from the eval_spell_expr() result.
1465 get_spellword(list, pp)
1466 list_T *list;
1467 char_u **pp;
1469 listitem_T *li;
1471 li = list->lv_first;
1472 if (li == NULL)
1473 return -1;
1474 *pp = get_tv_string(&li->li_tv);
1476 li = li->li_next;
1477 if (li == NULL)
1478 return -1;
1479 return get_tv_number(&li->li_tv);
1481 #endif
1484 * Top level evaluation function.
1485 * Returns an allocated typval_T with the result.
1486 * Returns NULL when there is an error.
1488 typval_T *
1489 eval_expr(arg, nextcmd)
1490 char_u *arg;
1491 char_u **nextcmd;
1493 typval_T *tv;
1495 tv = (typval_T *)alloc(sizeof(typval_T));
1496 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1498 vim_free(tv);
1499 tv = NULL;
1502 return tv;
1506 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1507 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1509 * Call some vimL function and return the result in "*rettv".
1510 * Uses argv[argc] for the function arguments. Only Number and String
1511 * arguments are currently supported.
1512 * Returns OK or FAIL.
1514 static int
1515 call_vim_function(func, argc, argv, safe, rettv)
1516 char_u *func;
1517 int argc;
1518 char_u **argv;
1519 int safe; /* use the sandbox */
1520 typval_T *rettv;
1522 typval_T *argvars;
1523 long n;
1524 int len;
1525 int i;
1526 int doesrange;
1527 void *save_funccalp = NULL;
1528 int ret;
1530 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1531 if (argvars == NULL)
1532 return FAIL;
1534 for (i = 0; i < argc; i++)
1536 /* Pass a NULL or empty argument as an empty string */
1537 if (argv[i] == NULL || *argv[i] == NUL)
1539 argvars[i].v_type = VAR_STRING;
1540 argvars[i].vval.v_string = (char_u *)"";
1541 continue;
1544 /* Recognize a number argument, the others must be strings. */
1545 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1546 if (len != 0 && len == (int)STRLEN(argv[i]))
1548 argvars[i].v_type = VAR_NUMBER;
1549 argvars[i].vval.v_number = n;
1551 else
1553 argvars[i].v_type = VAR_STRING;
1554 argvars[i].vval.v_string = argv[i];
1558 if (safe)
1560 save_funccalp = save_funccal();
1561 ++sandbox;
1564 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1565 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1566 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1567 &doesrange, TRUE, NULL);
1568 if (safe)
1570 --sandbox;
1571 restore_funccal(save_funccalp);
1573 vim_free(argvars);
1575 if (ret == FAIL)
1576 clear_tv(rettv);
1578 return ret;
1581 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1583 * Call vimL function "func" and return the result as a string.
1584 * Returns NULL when calling the function fails.
1585 * Uses argv[argc] for the function arguments.
1587 void *
1588 call_func_retstr(func, argc, argv, safe)
1589 char_u *func;
1590 int argc;
1591 char_u **argv;
1592 int safe; /* use the sandbox */
1594 typval_T rettv;
1595 char_u *retval;
1597 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1598 return NULL;
1600 retval = vim_strsave(get_tv_string(&rettv));
1601 clear_tv(&rettv);
1602 return retval;
1604 # endif
1606 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1608 * Call vimL function "func" and return the result as a number.
1609 * Returns -1 when calling the function fails.
1610 * Uses argv[argc] for the function arguments.
1612 long
1613 call_func_retnr(func, argc, argv, safe)
1614 char_u *func;
1615 int argc;
1616 char_u **argv;
1617 int safe; /* use the sandbox */
1619 typval_T rettv;
1620 long retval;
1622 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1623 return -1;
1625 retval = get_tv_number_chk(&rettv, NULL);
1626 clear_tv(&rettv);
1627 return retval;
1629 # endif
1632 * Call vimL function "func" and return the result as a List.
1633 * Uses argv[argc] for the function arguments.
1634 * Returns NULL when there is something wrong.
1636 void *
1637 call_func_retlist(func, argc, argv, safe)
1638 char_u *func;
1639 int argc;
1640 char_u **argv;
1641 int safe; /* use the sandbox */
1643 typval_T rettv;
1645 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1646 return NULL;
1648 if (rettv.v_type != VAR_LIST)
1650 clear_tv(&rettv);
1651 return NULL;
1654 return rettv.vval.v_list;
1656 #endif
1660 * Save the current function call pointer, and set it to NULL.
1661 * Used when executing autocommands and for ":source".
1663 void *
1664 save_funccal()
1666 funccall_T *fc = current_funccal;
1668 current_funccal = NULL;
1669 return (void *)fc;
1672 void
1673 restore_funccal(vfc)
1674 void *vfc;
1676 funccall_T *fc = (funccall_T *)vfc;
1678 current_funccal = fc;
1681 #if defined(FEAT_PROFILE) || defined(PROTO)
1683 * Prepare profiling for entering a child or something else that is not
1684 * counted for the script/function itself.
1685 * Should always be called in pair with prof_child_exit().
1687 void
1688 prof_child_enter(tm)
1689 proftime_T *tm; /* place to store waittime */
1691 funccall_T *fc = current_funccal;
1693 if (fc != NULL && fc->func->uf_profiling)
1694 profile_start(&fc->prof_child);
1695 script_prof_save(tm);
1699 * Take care of time spent in a child.
1700 * Should always be called after prof_child_enter().
1702 void
1703 prof_child_exit(tm)
1704 proftime_T *tm; /* where waittime was stored */
1706 funccall_T *fc = current_funccal;
1708 if (fc != NULL && fc->func->uf_profiling)
1710 profile_end(&fc->prof_child);
1711 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1712 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1713 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1715 script_prof_restore(tm);
1717 #endif
1720 #ifdef FEAT_FOLDING
1722 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1723 * it in "*cp". Doesn't give error messages.
1726 eval_foldexpr(arg, cp)
1727 char_u *arg;
1728 int *cp;
1730 typval_T tv;
1731 int retval;
1732 char_u *s;
1733 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1734 OPT_LOCAL);
1736 ++emsg_off;
1737 if (use_sandbox)
1738 ++sandbox;
1739 ++textlock;
1740 *cp = NUL;
1741 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1742 retval = 0;
1743 else
1745 /* If the result is a number, just return the number. */
1746 if (tv.v_type == VAR_NUMBER)
1747 retval = tv.vval.v_number;
1748 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1749 retval = 0;
1750 else
1752 /* If the result is a string, check if there is a non-digit before
1753 * the number. */
1754 s = tv.vval.v_string;
1755 if (!VIM_ISDIGIT(*s) && *s != '-')
1756 *cp = *s++;
1757 retval = atol((char *)s);
1759 clear_tv(&tv);
1761 --emsg_off;
1762 if (use_sandbox)
1763 --sandbox;
1764 --textlock;
1766 return retval;
1768 #endif
1771 * ":let" list all variable values
1772 * ":let var1 var2" list variable values
1773 * ":let var = expr" assignment command.
1774 * ":let var += expr" assignment command.
1775 * ":let var -= expr" assignment command.
1776 * ":let var .= expr" assignment command.
1777 * ":let [var1, var2] = expr" unpack list.
1779 void
1780 ex_let(eap)
1781 exarg_T *eap;
1783 char_u *arg = eap->arg;
1784 char_u *expr = NULL;
1785 typval_T rettv;
1786 int i;
1787 int var_count = 0;
1788 int semicolon = 0;
1789 char_u op[2];
1790 char_u *argend;
1791 int first = TRUE;
1793 argend = skip_var_list(arg, &var_count, &semicolon);
1794 if (argend == NULL)
1795 return;
1796 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1797 --argend;
1798 expr = vim_strchr(argend, '=');
1799 if (expr == NULL)
1802 * ":let" without "=": list variables
1804 if (*arg == '[')
1805 EMSG(_(e_invarg));
1806 else if (!ends_excmd(*arg))
1807 /* ":let var1 var2" */
1808 arg = list_arg_vars(eap, arg, &first);
1809 else if (!eap->skip)
1811 /* ":let" */
1812 list_glob_vars(&first);
1813 list_buf_vars(&first);
1814 list_win_vars(&first);
1815 #ifdef FEAT_WINDOWS
1816 list_tab_vars(&first);
1817 #endif
1818 list_script_vars(&first);
1819 list_func_vars(&first);
1820 list_vim_vars(&first);
1822 eap->nextcmd = check_nextcmd(arg);
1824 else
1826 op[0] = '=';
1827 op[1] = NUL;
1828 if (expr > argend)
1830 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1831 op[0] = expr[-1]; /* +=, -= or .= */
1833 expr = skipwhite(expr + 1);
1835 if (eap->skip)
1836 ++emsg_skip;
1837 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1838 if (eap->skip)
1840 if (i != FAIL)
1841 clear_tv(&rettv);
1842 --emsg_skip;
1844 else if (i != FAIL)
1846 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1847 op);
1848 clear_tv(&rettv);
1854 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1855 * Handles both "var" with any type and "[var, var; var]" with a list type.
1856 * When "nextchars" is not NULL it points to a string with characters that
1857 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1858 * or concatenate.
1859 * Returns OK or FAIL;
1861 static int
1862 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1863 char_u *arg_start;
1864 typval_T *tv;
1865 int copy; /* copy values from "tv", don't move */
1866 int semicolon; /* from skip_var_list() */
1867 int var_count; /* from skip_var_list() */
1868 char_u *nextchars;
1870 char_u *arg = arg_start;
1871 list_T *l;
1872 int i;
1873 listitem_T *item;
1874 typval_T ltv;
1876 if (*arg != '[')
1879 * ":let var = expr" or ":for var in list"
1881 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1882 return FAIL;
1883 return OK;
1887 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1889 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1891 EMSG(_(e_listreq));
1892 return FAIL;
1895 i = list_len(l);
1896 if (semicolon == 0 && var_count < i)
1898 EMSG(_("E687: Less targets than List items"));
1899 return FAIL;
1901 if (var_count - semicolon > i)
1903 EMSG(_("E688: More targets than List items"));
1904 return FAIL;
1907 item = l->lv_first;
1908 while (*arg != ']')
1910 arg = skipwhite(arg + 1);
1911 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1912 item = item->li_next;
1913 if (arg == NULL)
1914 return FAIL;
1916 arg = skipwhite(arg);
1917 if (*arg == ';')
1919 /* Put the rest of the list (may be empty) in the var after ';'.
1920 * Create a new list for this. */
1921 l = list_alloc();
1922 if (l == NULL)
1923 return FAIL;
1924 while (item != NULL)
1926 list_append_tv(l, &item->li_tv);
1927 item = item->li_next;
1930 ltv.v_type = VAR_LIST;
1931 ltv.v_lock = 0;
1932 ltv.vval.v_list = l;
1933 l->lv_refcount = 1;
1935 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1936 (char_u *)"]", nextchars);
1937 clear_tv(&ltv);
1938 if (arg == NULL)
1939 return FAIL;
1940 break;
1942 else if (*arg != ',' && *arg != ']')
1944 EMSG2(_(e_intern2), "ex_let_vars()");
1945 return FAIL;
1949 return OK;
1953 * Skip over assignable variable "var" or list of variables "[var, var]".
1954 * Used for ":let varvar = expr" and ":for varvar in expr".
1955 * For "[var, var]" increment "*var_count" for each variable.
1956 * for "[var, var; var]" set "semicolon".
1957 * Return NULL for an error.
1959 static char_u *
1960 skip_var_list(arg, var_count, semicolon)
1961 char_u *arg;
1962 int *var_count;
1963 int *semicolon;
1965 char_u *p, *s;
1967 if (*arg == '[')
1969 /* "[var, var]": find the matching ']'. */
1970 p = arg;
1971 for (;;)
1973 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1974 s = skip_var_one(p);
1975 if (s == p)
1977 EMSG2(_(e_invarg2), p);
1978 return NULL;
1980 ++*var_count;
1982 p = skipwhite(s);
1983 if (*p == ']')
1984 break;
1985 else if (*p == ';')
1987 if (*semicolon == 1)
1989 EMSG(_("Double ; in list of variables"));
1990 return NULL;
1992 *semicolon = 1;
1994 else if (*p != ',')
1996 EMSG2(_(e_invarg2), p);
1997 return NULL;
2000 return p + 1;
2002 else
2003 return skip_var_one(arg);
2007 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
2008 * l[idx].
2010 static char_u *
2011 skip_var_one(arg)
2012 char_u *arg;
2014 if (*arg == '@' && arg[1] != NUL)
2015 return arg + 2;
2016 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2017 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2021 * List variables for hashtab "ht" with prefix "prefix".
2022 * If "empty" is TRUE also list NULL strings as empty strings.
2024 static void
2025 list_hashtable_vars(ht, prefix, empty, first)
2026 hashtab_T *ht;
2027 char_u *prefix;
2028 int empty;
2029 int *first;
2031 hashitem_T *hi;
2032 dictitem_T *di;
2033 int todo;
2035 todo = (int)ht->ht_used;
2036 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2038 if (!HASHITEM_EMPTY(hi))
2040 --todo;
2041 di = HI2DI(hi);
2042 if (empty || di->di_tv.v_type != VAR_STRING
2043 || di->di_tv.vval.v_string != NULL)
2044 list_one_var(di, prefix, first);
2050 * List global variables.
2052 static void
2053 list_glob_vars(first)
2054 int *first;
2056 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2060 * List buffer variables.
2062 static void
2063 list_buf_vars(first)
2064 int *first;
2066 char_u numbuf[NUMBUFLEN];
2068 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2069 TRUE, first);
2071 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2072 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2073 numbuf, first);
2077 * List window variables.
2079 static void
2080 list_win_vars(first)
2081 int *first;
2083 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2084 (char_u *)"w:", TRUE, first);
2087 #ifdef FEAT_WINDOWS
2089 * List tab page variables.
2091 static void
2092 list_tab_vars(first)
2093 int *first;
2095 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2096 (char_u *)"t:", TRUE, first);
2098 #endif
2101 * List Vim variables.
2103 static void
2104 list_vim_vars(first)
2105 int *first;
2107 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2111 * List script-local variables, if there is a script.
2113 static void
2114 list_script_vars(first)
2115 int *first;
2117 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2118 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2119 (char_u *)"s:", FALSE, first);
2123 * List function variables, if there is a function.
2125 static void
2126 list_func_vars(first)
2127 int *first;
2129 if (current_funccal != NULL)
2130 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2131 (char_u *)"l:", FALSE, first);
2135 * List variables in "arg".
2137 static char_u *
2138 list_arg_vars(eap, arg, first)
2139 exarg_T *eap;
2140 char_u *arg;
2141 int *first;
2143 int error = FALSE;
2144 int len;
2145 char_u *name;
2146 char_u *name_start;
2147 char_u *arg_subsc;
2148 char_u *tofree;
2149 typval_T tv;
2151 while (!ends_excmd(*arg) && !got_int)
2153 if (error || eap->skip)
2155 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2156 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2158 emsg_severe = TRUE;
2159 EMSG(_(e_trailing));
2160 break;
2163 else
2165 /* get_name_len() takes care of expanding curly braces */
2166 name_start = name = arg;
2167 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2168 if (len <= 0)
2170 /* This is mainly to keep test 49 working: when expanding
2171 * curly braces fails overrule the exception error message. */
2172 if (len < 0 && !aborting())
2174 emsg_severe = TRUE;
2175 EMSG2(_(e_invarg2), arg);
2176 break;
2178 error = TRUE;
2180 else
2182 if (tofree != NULL)
2183 name = tofree;
2184 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2185 error = TRUE;
2186 else
2188 /* handle d.key, l[idx], f(expr) */
2189 arg_subsc = arg;
2190 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2191 error = TRUE;
2192 else
2194 if (arg == arg_subsc && len == 2 && name[1] == ':')
2196 switch (*name)
2198 case 'g': list_glob_vars(first); break;
2199 case 'b': list_buf_vars(first); break;
2200 case 'w': list_win_vars(first); break;
2201 #ifdef FEAT_WINDOWS
2202 case 't': list_tab_vars(first); break;
2203 #endif
2204 case 'v': list_vim_vars(first); break;
2205 case 's': list_script_vars(first); break;
2206 case 'l': list_func_vars(first); break;
2207 default:
2208 EMSG2(_("E738: Can't list variables for %s"), name);
2211 else
2213 char_u numbuf[NUMBUFLEN];
2214 char_u *tf;
2215 int c;
2216 char_u *s;
2218 s = echo_string(&tv, &tf, numbuf, 0);
2219 c = *arg;
2220 *arg = NUL;
2221 list_one_var_a((char_u *)"",
2222 arg == arg_subsc ? name : name_start,
2223 tv.v_type,
2224 s == NULL ? (char_u *)"" : s,
2225 first);
2226 *arg = c;
2227 vim_free(tf);
2229 clear_tv(&tv);
2234 vim_free(tofree);
2237 arg = skipwhite(arg);
2240 return arg;
2244 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2245 * Returns a pointer to the char just after the var name.
2246 * Returns NULL if there is an error.
2248 static char_u *
2249 ex_let_one(arg, tv, copy, endchars, op)
2250 char_u *arg; /* points to variable name */
2251 typval_T *tv; /* value to assign to variable */
2252 int copy; /* copy value from "tv" */
2253 char_u *endchars; /* valid chars after variable name or NULL */
2254 char_u *op; /* "+", "-", "." or NULL*/
2256 int c1;
2257 char_u *name;
2258 char_u *p;
2259 char_u *arg_end = NULL;
2260 int len;
2261 int opt_flags;
2262 char_u *tofree = NULL;
2265 * ":let $VAR = expr": Set environment variable.
2267 if (*arg == '$')
2269 /* Find the end of the name. */
2270 ++arg;
2271 name = arg;
2272 len = get_env_len(&arg);
2273 if (len == 0)
2274 EMSG2(_(e_invarg2), name - 1);
2275 else
2277 if (op != NULL && (*op == '+' || *op == '-'))
2278 EMSG2(_(e_letwrong), op);
2279 else if (endchars != NULL
2280 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2281 EMSG(_(e_letunexp));
2282 else
2284 c1 = name[len];
2285 name[len] = NUL;
2286 p = get_tv_string_chk(tv);
2287 if (p != NULL && op != NULL && *op == '.')
2289 int mustfree = FALSE;
2290 char_u *s = vim_getenv(name, &mustfree);
2292 if (s != NULL)
2294 p = tofree = concat_str(s, p);
2295 if (mustfree)
2296 vim_free(s);
2299 if (p != NULL)
2301 vim_setenv(name, p);
2302 if (STRICMP(name, "HOME") == 0)
2303 init_homedir();
2304 else if (didset_vim && STRICMP(name, "VIM") == 0)
2305 didset_vim = FALSE;
2306 else if (didset_vimruntime
2307 && STRICMP(name, "VIMRUNTIME") == 0)
2308 didset_vimruntime = FALSE;
2309 arg_end = arg;
2311 name[len] = c1;
2312 vim_free(tofree);
2318 * ":let &option = expr": Set option value.
2319 * ":let &l:option = expr": Set local option value.
2320 * ":let &g:option = expr": Set global option value.
2322 else if (*arg == '&')
2324 /* Find the end of the name. */
2325 p = find_option_end(&arg, &opt_flags);
2326 if (p == NULL || (endchars != NULL
2327 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2328 EMSG(_(e_letunexp));
2329 else
2331 long n;
2332 int opt_type;
2333 long numval;
2334 char_u *stringval = NULL;
2335 char_u *s;
2337 c1 = *p;
2338 *p = NUL;
2340 n = get_tv_number(tv);
2341 s = get_tv_string_chk(tv); /* != NULL if number or string */
2342 if (s != NULL && op != NULL && *op != '=')
2344 opt_type = get_option_value(arg, &numval,
2345 &stringval, opt_flags);
2346 if ((opt_type == 1 && *op == '.')
2347 || (opt_type == 0 && *op != '.'))
2348 EMSG2(_(e_letwrong), op);
2349 else
2351 if (opt_type == 1) /* number */
2353 if (*op == '+')
2354 n = numval + n;
2355 else
2356 n = numval - n;
2358 else if (opt_type == 0 && stringval != NULL) /* string */
2360 s = concat_str(stringval, s);
2361 vim_free(stringval);
2362 stringval = s;
2366 if (s != NULL)
2368 set_option_value(arg, n, s, opt_flags);
2369 arg_end = p;
2371 *p = c1;
2372 vim_free(stringval);
2377 * ":let @r = expr": Set register contents.
2379 else if (*arg == '@')
2381 ++arg;
2382 if (op != NULL && (*op == '+' || *op == '-'))
2383 EMSG2(_(e_letwrong), op);
2384 else if (endchars != NULL
2385 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2386 EMSG(_(e_letunexp));
2387 else
2389 char_u *ptofree = NULL;
2390 char_u *s;
2392 p = get_tv_string_chk(tv);
2393 if (p != NULL && op != NULL && *op == '.')
2395 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2396 if (s != NULL)
2398 p = ptofree = concat_str(s, p);
2399 vim_free(s);
2402 if (p != NULL)
2404 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2405 arg_end = arg + 1;
2407 vim_free(ptofree);
2412 * ":let var = expr": Set internal variable.
2413 * ":let {expr} = expr": Idem, name made with curly braces
2415 else if (eval_isnamec1(*arg) || *arg == '{')
2417 lval_T lv;
2419 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2420 if (p != NULL && lv.ll_name != NULL)
2422 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2423 EMSG(_(e_letunexp));
2424 else
2426 set_var_lval(&lv, p, tv, copy, op);
2427 arg_end = p;
2430 clear_lval(&lv);
2433 else
2434 EMSG2(_(e_invarg2), arg);
2436 return arg_end;
2440 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2442 static int
2443 check_changedtick(arg)
2444 char_u *arg;
2446 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2448 EMSG2(_(e_readonlyvar), arg);
2449 return TRUE;
2451 return FALSE;
2455 * Get an lval: variable, Dict item or List item that can be assigned a value
2456 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2457 * "name.key", "name.key[expr]" etc.
2458 * Indexing only works if "name" is an existing List or Dictionary.
2459 * "name" points to the start of the name.
2460 * If "rettv" is not NULL it points to the value to be assigned.
2461 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2462 * wrong; must end in space or cmd separator.
2464 * Returns a pointer to just after the name, including indexes.
2465 * When an evaluation error occurs "lp->ll_name" is NULL;
2466 * Returns NULL for a parsing error. Still need to free items in "lp"!
2468 static char_u *
2469 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2470 char_u *name;
2471 typval_T *rettv;
2472 lval_T *lp;
2473 int unlet;
2474 int skip;
2475 int quiet; /* don't give error messages */
2476 int fne_flags; /* flags for find_name_end() */
2478 char_u *p;
2479 char_u *expr_start, *expr_end;
2480 int cc;
2481 dictitem_T *v;
2482 typval_T var1;
2483 typval_T var2;
2484 int empty1 = FALSE;
2485 listitem_T *ni;
2486 char_u *key = NULL;
2487 int len;
2488 hashtab_T *ht;
2490 /* Clear everything in "lp". */
2491 vim_memset(lp, 0, sizeof(lval_T));
2493 if (skip)
2495 /* When skipping just find the end of the name. */
2496 lp->ll_name = name;
2497 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2500 /* Find the end of the name. */
2501 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2502 if (expr_start != NULL)
2504 /* Don't expand the name when we already know there is an error. */
2505 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2506 && *p != '[' && *p != '.')
2508 EMSG(_(e_trailing));
2509 return NULL;
2512 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2513 if (lp->ll_exp_name == NULL)
2515 /* Report an invalid expression in braces, unless the
2516 * expression evaluation has been cancelled due to an
2517 * aborting error, an interrupt, or an exception. */
2518 if (!aborting() && !quiet)
2520 emsg_severe = TRUE;
2521 EMSG2(_(e_invarg2), name);
2522 return NULL;
2525 lp->ll_name = lp->ll_exp_name;
2527 else
2528 lp->ll_name = name;
2530 /* Without [idx] or .key we are done. */
2531 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2532 return p;
2534 cc = *p;
2535 *p = NUL;
2536 v = find_var(lp->ll_name, &ht);
2537 if (v == NULL && !quiet)
2538 EMSG2(_(e_undefvar), lp->ll_name);
2539 *p = cc;
2540 if (v == NULL)
2541 return NULL;
2544 * Loop until no more [idx] or .key is following.
2546 lp->ll_tv = &v->di_tv;
2547 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2549 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2550 && !(lp->ll_tv->v_type == VAR_DICT
2551 && lp->ll_tv->vval.v_dict != NULL))
2553 if (!quiet)
2554 EMSG(_("E689: Can only index a List or Dictionary"));
2555 return NULL;
2557 if (lp->ll_range)
2559 if (!quiet)
2560 EMSG(_("E708: [:] must come last"));
2561 return NULL;
2564 len = -1;
2565 if (*p == '.')
2567 key = p + 1;
2568 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2570 if (len == 0)
2572 if (!quiet)
2573 EMSG(_(e_emptykey));
2574 return NULL;
2576 p = key + len;
2578 else
2580 /* Get the index [expr] or the first index [expr: ]. */
2581 p = skipwhite(p + 1);
2582 if (*p == ':')
2583 empty1 = TRUE;
2584 else
2586 empty1 = FALSE;
2587 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2588 return NULL;
2589 if (get_tv_string_chk(&var1) == NULL)
2591 /* not a number or string */
2592 clear_tv(&var1);
2593 return NULL;
2597 /* Optionally get the second index [ :expr]. */
2598 if (*p == ':')
2600 if (lp->ll_tv->v_type == VAR_DICT)
2602 if (!quiet)
2603 EMSG(_(e_dictrange));
2604 if (!empty1)
2605 clear_tv(&var1);
2606 return NULL;
2608 if (rettv != NULL && (rettv->v_type != VAR_LIST
2609 || rettv->vval.v_list == NULL))
2611 if (!quiet)
2612 EMSG(_("E709: [:] requires a List value"));
2613 if (!empty1)
2614 clear_tv(&var1);
2615 return NULL;
2617 p = skipwhite(p + 1);
2618 if (*p == ']')
2619 lp->ll_empty2 = TRUE;
2620 else
2622 lp->ll_empty2 = FALSE;
2623 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2625 if (!empty1)
2626 clear_tv(&var1);
2627 return NULL;
2629 if (get_tv_string_chk(&var2) == NULL)
2631 /* not a number or string */
2632 if (!empty1)
2633 clear_tv(&var1);
2634 clear_tv(&var2);
2635 return NULL;
2638 lp->ll_range = TRUE;
2640 else
2641 lp->ll_range = FALSE;
2643 if (*p != ']')
2645 if (!quiet)
2646 EMSG(_(e_missbrac));
2647 if (!empty1)
2648 clear_tv(&var1);
2649 if (lp->ll_range && !lp->ll_empty2)
2650 clear_tv(&var2);
2651 return NULL;
2654 /* Skip to past ']'. */
2655 ++p;
2658 if (lp->ll_tv->v_type == VAR_DICT)
2660 if (len == -1)
2662 /* "[key]": get key from "var1" */
2663 key = get_tv_string(&var1); /* is number or string */
2664 if (*key == NUL)
2666 if (!quiet)
2667 EMSG(_(e_emptykey));
2668 clear_tv(&var1);
2669 return NULL;
2672 lp->ll_list = NULL;
2673 lp->ll_dict = lp->ll_tv->vval.v_dict;
2674 lp->ll_di = dict_find(lp->ll_dict, key, len);
2675 if (lp->ll_di == NULL)
2677 /* Key does not exist in dict: may need to add it. */
2678 if (*p == '[' || *p == '.' || unlet)
2680 if (!quiet)
2681 EMSG2(_(e_dictkey), key);
2682 if (len == -1)
2683 clear_tv(&var1);
2684 return NULL;
2686 if (len == -1)
2687 lp->ll_newkey = vim_strsave(key);
2688 else
2689 lp->ll_newkey = vim_strnsave(key, len);
2690 if (len == -1)
2691 clear_tv(&var1);
2692 if (lp->ll_newkey == NULL)
2693 p = NULL;
2694 break;
2696 if (len == -1)
2697 clear_tv(&var1);
2698 lp->ll_tv = &lp->ll_di->di_tv;
2700 else
2703 * Get the number and item for the only or first index of the List.
2705 if (empty1)
2706 lp->ll_n1 = 0;
2707 else
2709 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2710 clear_tv(&var1);
2712 lp->ll_dict = NULL;
2713 lp->ll_list = lp->ll_tv->vval.v_list;
2714 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2715 if (lp->ll_li == NULL)
2717 if (lp->ll_n1 < 0)
2719 lp->ll_n1 = 0;
2720 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2723 if (lp->ll_li == NULL)
2725 if (lp->ll_range && !lp->ll_empty2)
2726 clear_tv(&var2);
2727 return NULL;
2731 * May need to find the item or absolute index for the second
2732 * index of a range.
2733 * When no index given: "lp->ll_empty2" is TRUE.
2734 * Otherwise "lp->ll_n2" is set to the second index.
2736 if (lp->ll_range && !lp->ll_empty2)
2738 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2739 clear_tv(&var2);
2740 if (lp->ll_n2 < 0)
2742 ni = list_find(lp->ll_list, lp->ll_n2);
2743 if (ni == NULL)
2744 return NULL;
2745 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2748 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2749 if (lp->ll_n1 < 0)
2750 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2751 if (lp->ll_n2 < lp->ll_n1)
2752 return NULL;
2755 lp->ll_tv = &lp->ll_li->li_tv;
2759 return p;
2763 * Clear lval "lp" that was filled by get_lval().
2765 static void
2766 clear_lval(lp)
2767 lval_T *lp;
2769 vim_free(lp->ll_exp_name);
2770 vim_free(lp->ll_newkey);
2774 * Set a variable that was parsed by get_lval() to "rettv".
2775 * "endp" points to just after the parsed name.
2776 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2778 static void
2779 set_var_lval(lp, endp, rettv, copy, op)
2780 lval_T *lp;
2781 char_u *endp;
2782 typval_T *rettv;
2783 int copy;
2784 char_u *op;
2786 int cc;
2787 listitem_T *ri;
2788 dictitem_T *di;
2790 if (lp->ll_tv == NULL)
2792 if (!check_changedtick(lp->ll_name))
2794 cc = *endp;
2795 *endp = NUL;
2796 if (op != NULL && *op != '=')
2798 typval_T tv;
2800 /* handle +=, -= and .= */
2801 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2802 &tv, TRUE) == OK)
2804 if (tv_op(&tv, rettv, op) == OK)
2805 set_var(lp->ll_name, &tv, FALSE);
2806 clear_tv(&tv);
2809 else
2810 set_var(lp->ll_name, rettv, copy);
2811 *endp = cc;
2814 else if (tv_check_lock(lp->ll_newkey == NULL
2815 ? lp->ll_tv->v_lock
2816 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2818 else if (lp->ll_range)
2821 * Assign the List values to the list items.
2823 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2825 if (op != NULL && *op != '=')
2826 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2827 else
2829 clear_tv(&lp->ll_li->li_tv);
2830 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2832 ri = ri->li_next;
2833 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2834 break;
2835 if (lp->ll_li->li_next == NULL)
2837 /* Need to add an empty item. */
2838 if (list_append_number(lp->ll_list, 0) == FAIL)
2840 ri = NULL;
2841 break;
2844 lp->ll_li = lp->ll_li->li_next;
2845 ++lp->ll_n1;
2847 if (ri != NULL)
2848 EMSG(_("E710: List value has more items than target"));
2849 else if (lp->ll_empty2
2850 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2851 : lp->ll_n1 != lp->ll_n2)
2852 EMSG(_("E711: List value has not enough items"));
2854 else
2857 * Assign to a List or Dictionary item.
2859 if (lp->ll_newkey != NULL)
2861 if (op != NULL && *op != '=')
2863 EMSG2(_(e_letwrong), op);
2864 return;
2867 /* Need to add an item to the Dictionary. */
2868 di = dictitem_alloc(lp->ll_newkey);
2869 if (di == NULL)
2870 return;
2871 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2873 vim_free(di);
2874 return;
2876 lp->ll_tv = &di->di_tv;
2878 else if (op != NULL && *op != '=')
2880 tv_op(lp->ll_tv, rettv, op);
2881 return;
2883 else
2884 clear_tv(lp->ll_tv);
2887 * Assign the value to the variable or list item.
2889 if (copy)
2890 copy_tv(rettv, lp->ll_tv);
2891 else
2893 *lp->ll_tv = *rettv;
2894 lp->ll_tv->v_lock = 0;
2895 init_tv(rettv);
2901 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2902 * Returns OK or FAIL.
2904 static int
2905 tv_op(tv1, tv2, op)
2906 typval_T *tv1;
2907 typval_T *tv2;
2908 char_u *op;
2910 long n;
2911 char_u numbuf[NUMBUFLEN];
2912 char_u *s;
2914 /* Can't do anything with a Funcref or a Dict on the right. */
2915 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2917 switch (tv1->v_type)
2919 case VAR_DICT:
2920 case VAR_FUNC:
2921 break;
2923 case VAR_LIST:
2924 if (*op != '+' || tv2->v_type != VAR_LIST)
2925 break;
2926 /* List += List */
2927 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2928 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2929 return OK;
2931 case VAR_NUMBER:
2932 case VAR_STRING:
2933 if (tv2->v_type == VAR_LIST)
2934 break;
2935 if (*op == '+' || *op == '-')
2937 /* nr += nr or nr -= nr*/
2938 n = get_tv_number(tv1);
2939 #ifdef FEAT_FLOAT
2940 if (tv2->v_type == VAR_FLOAT)
2942 float_T f = n;
2944 if (*op == '+')
2945 f += tv2->vval.v_float;
2946 else
2947 f -= tv2->vval.v_float;
2948 clear_tv(tv1);
2949 tv1->v_type = VAR_FLOAT;
2950 tv1->vval.v_float = f;
2952 else
2953 #endif
2955 if (*op == '+')
2956 n += get_tv_number(tv2);
2957 else
2958 n -= get_tv_number(tv2);
2959 clear_tv(tv1);
2960 tv1->v_type = VAR_NUMBER;
2961 tv1->vval.v_number = n;
2964 else
2966 if (tv2->v_type == VAR_FLOAT)
2967 break;
2969 /* str .= str */
2970 s = get_tv_string(tv1);
2971 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2972 clear_tv(tv1);
2973 tv1->v_type = VAR_STRING;
2974 tv1->vval.v_string = s;
2976 return OK;
2978 #ifdef FEAT_FLOAT
2979 case VAR_FLOAT:
2981 float_T f;
2983 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2984 && tv2->v_type != VAR_NUMBER
2985 && tv2->v_type != VAR_STRING))
2986 break;
2987 if (tv2->v_type == VAR_FLOAT)
2988 f = tv2->vval.v_float;
2989 else
2990 f = get_tv_number(tv2);
2991 if (*op == '+')
2992 tv1->vval.v_float += f;
2993 else
2994 tv1->vval.v_float -= f;
2996 return OK;
2997 #endif
3001 EMSG2(_(e_letwrong), op);
3002 return FAIL;
3006 * Add a watcher to a list.
3008 static void
3009 list_add_watch(l, lw)
3010 list_T *l;
3011 listwatch_T *lw;
3013 lw->lw_next = l->lv_watch;
3014 l->lv_watch = lw;
3018 * Remove a watcher from a list.
3019 * No warning when it isn't found...
3021 static void
3022 list_rem_watch(l, lwrem)
3023 list_T *l;
3024 listwatch_T *lwrem;
3026 listwatch_T *lw, **lwp;
3028 lwp = &l->lv_watch;
3029 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3031 if (lw == lwrem)
3033 *lwp = lw->lw_next;
3034 break;
3036 lwp = &lw->lw_next;
3041 * Just before removing an item from a list: advance watchers to the next
3042 * item.
3044 static void
3045 list_fix_watch(l, item)
3046 list_T *l;
3047 listitem_T *item;
3049 listwatch_T *lw;
3051 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3052 if (lw->lw_item == item)
3053 lw->lw_item = item->li_next;
3057 * Evaluate the expression used in a ":for var in expr" command.
3058 * "arg" points to "var".
3059 * Set "*errp" to TRUE for an error, FALSE otherwise;
3060 * Return a pointer that holds the info. Null when there is an error.
3062 void *
3063 eval_for_line(arg, errp, nextcmdp, skip)
3064 char_u *arg;
3065 int *errp;
3066 char_u **nextcmdp;
3067 int skip;
3069 forinfo_T *fi;
3070 char_u *expr;
3071 typval_T tv;
3072 list_T *l;
3074 *errp = TRUE; /* default: there is an error */
3076 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3077 if (fi == NULL)
3078 return NULL;
3080 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3081 if (expr == NULL)
3082 return fi;
3084 expr = skipwhite(expr);
3085 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3087 EMSG(_("E690: Missing \"in\" after :for"));
3088 return fi;
3091 if (skip)
3092 ++emsg_skip;
3093 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3095 *errp = FALSE;
3096 if (!skip)
3098 l = tv.vval.v_list;
3099 if (tv.v_type != VAR_LIST || l == NULL)
3101 EMSG(_(e_listreq));
3102 clear_tv(&tv);
3104 else
3106 /* No need to increment the refcount, it's already set for the
3107 * list being used in "tv". */
3108 fi->fi_list = l;
3109 list_add_watch(l, &fi->fi_lw);
3110 fi->fi_lw.lw_item = l->lv_first;
3114 if (skip)
3115 --emsg_skip;
3117 return fi;
3121 * Use the first item in a ":for" list. Advance to the next.
3122 * Assign the values to the variable (list). "arg" points to the first one.
3123 * Return TRUE when a valid item was found, FALSE when at end of list or
3124 * something wrong.
3127 next_for_item(fi_void, arg)
3128 void *fi_void;
3129 char_u *arg;
3131 forinfo_T *fi = (forinfo_T *)fi_void;
3132 int result;
3133 listitem_T *item;
3135 item = fi->fi_lw.lw_item;
3136 if (item == NULL)
3137 result = FALSE;
3138 else
3140 fi->fi_lw.lw_item = item->li_next;
3141 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3142 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3144 return result;
3148 * Free the structure used to store info used by ":for".
3150 void
3151 free_for_info(fi_void)
3152 void *fi_void;
3154 forinfo_T *fi = (forinfo_T *)fi_void;
3156 if (fi != NULL && fi->fi_list != NULL)
3158 list_rem_watch(fi->fi_list, &fi->fi_lw);
3159 list_unref(fi->fi_list);
3161 vim_free(fi);
3164 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3166 void
3167 set_context_for_expression(xp, arg, cmdidx)
3168 expand_T *xp;
3169 char_u *arg;
3170 cmdidx_T cmdidx;
3172 int got_eq = FALSE;
3173 int c;
3174 char_u *p;
3176 if (cmdidx == CMD_let)
3178 xp->xp_context = EXPAND_USER_VARS;
3179 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3181 /* ":let var1 var2 ...": find last space. */
3182 for (p = arg + STRLEN(arg); p >= arg; )
3184 xp->xp_pattern = p;
3185 mb_ptr_back(arg, p);
3186 if (vim_iswhite(*p))
3187 break;
3189 return;
3192 else
3193 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3194 : EXPAND_EXPRESSION;
3195 while ((xp->xp_pattern = vim_strpbrk(arg,
3196 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3198 c = *xp->xp_pattern;
3199 if (c == '&')
3201 c = xp->xp_pattern[1];
3202 if (c == '&')
3204 ++xp->xp_pattern;
3205 xp->xp_context = cmdidx != CMD_let || got_eq
3206 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3208 else if (c != ' ')
3210 xp->xp_context = EXPAND_SETTINGS;
3211 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3212 xp->xp_pattern += 2;
3216 else if (c == '$')
3218 /* environment variable */
3219 xp->xp_context = EXPAND_ENV_VARS;
3221 else if (c == '=')
3223 got_eq = TRUE;
3224 xp->xp_context = EXPAND_EXPRESSION;
3226 else if (c == '<'
3227 && xp->xp_context == EXPAND_FUNCTIONS
3228 && vim_strchr(xp->xp_pattern, '(') == NULL)
3230 /* Function name can start with "<SNR>" */
3231 break;
3233 else if (cmdidx != CMD_let || got_eq)
3235 if (c == '"') /* string */
3237 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3238 if (c == '\\' && xp->xp_pattern[1] != NUL)
3239 ++xp->xp_pattern;
3240 xp->xp_context = EXPAND_NOTHING;
3242 else if (c == '\'') /* literal string */
3244 /* Trick: '' is like stopping and starting a literal string. */
3245 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3246 /* skip */ ;
3247 xp->xp_context = EXPAND_NOTHING;
3249 else if (c == '|')
3251 if (xp->xp_pattern[1] == '|')
3253 ++xp->xp_pattern;
3254 xp->xp_context = EXPAND_EXPRESSION;
3256 else
3257 xp->xp_context = EXPAND_COMMANDS;
3259 else
3260 xp->xp_context = EXPAND_EXPRESSION;
3262 else
3263 /* Doesn't look like something valid, expand as an expression
3264 * anyway. */
3265 xp->xp_context = EXPAND_EXPRESSION;
3266 arg = xp->xp_pattern;
3267 if (*arg != NUL)
3268 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3269 /* skip */ ;
3271 xp->xp_pattern = arg;
3274 #endif /* FEAT_CMDL_COMPL */
3277 * ":1,25call func(arg1, arg2)" function call.
3279 void
3280 ex_call(eap)
3281 exarg_T *eap;
3283 char_u *arg = eap->arg;
3284 char_u *startarg;
3285 char_u *name;
3286 char_u *tofree;
3287 int len;
3288 typval_T rettv;
3289 linenr_T lnum;
3290 int doesrange;
3291 int failed = FALSE;
3292 funcdict_T fudi;
3294 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3295 if (fudi.fd_newkey != NULL)
3297 /* Still need to give an error message for missing key. */
3298 EMSG2(_(e_dictkey), fudi.fd_newkey);
3299 vim_free(fudi.fd_newkey);
3301 if (tofree == NULL)
3302 return;
3304 /* Increase refcount on dictionary, it could get deleted when evaluating
3305 * the arguments. */
3306 if (fudi.fd_dict != NULL)
3307 ++fudi.fd_dict->dv_refcount;
3309 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3310 len = (int)STRLEN(tofree);
3311 name = deref_func_name(tofree, &len);
3313 /* Skip white space to allow ":call func ()". Not good, but required for
3314 * backward compatibility. */
3315 startarg = skipwhite(arg);
3316 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3318 if (*startarg != '(')
3320 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3321 goto end;
3325 * When skipping, evaluate the function once, to find the end of the
3326 * arguments.
3327 * When the function takes a range, this is discovered after the first
3328 * call, and the loop is broken.
3330 if (eap->skip)
3332 ++emsg_skip;
3333 lnum = eap->line2; /* do it once, also with an invalid range */
3335 else
3336 lnum = eap->line1;
3337 for ( ; lnum <= eap->line2; ++lnum)
3339 if (!eap->skip && eap->addr_count > 0)
3341 curwin->w_cursor.lnum = lnum;
3342 curwin->w_cursor.col = 0;
3344 arg = startarg;
3345 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3346 eap->line1, eap->line2, &doesrange,
3347 !eap->skip, fudi.fd_dict) == FAIL)
3349 failed = TRUE;
3350 break;
3353 /* Handle a function returning a Funcref, Dictionary or List. */
3354 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3356 failed = TRUE;
3357 break;
3360 clear_tv(&rettv);
3361 if (doesrange || eap->skip)
3362 break;
3364 /* Stop when immediately aborting on error, or when an interrupt
3365 * occurred or an exception was thrown but not caught.
3366 * get_func_tv() returned OK, so that the check for trailing
3367 * characters below is executed. */
3368 if (aborting())
3369 break;
3371 if (eap->skip)
3372 --emsg_skip;
3374 if (!failed)
3376 /* Check for trailing illegal characters and a following command. */
3377 if (!ends_excmd(*arg))
3379 emsg_severe = TRUE;
3380 EMSG(_(e_trailing));
3382 else
3383 eap->nextcmd = check_nextcmd(arg);
3386 end:
3387 dict_unref(fudi.fd_dict);
3388 vim_free(tofree);
3392 * ":unlet[!] var1 ... " command.
3394 void
3395 ex_unlet(eap)
3396 exarg_T *eap;
3398 ex_unletlock(eap, eap->arg, 0);
3402 * ":lockvar" and ":unlockvar" commands
3404 void
3405 ex_lockvar(eap)
3406 exarg_T *eap;
3408 char_u *arg = eap->arg;
3409 int deep = 2;
3411 if (eap->forceit)
3412 deep = -1;
3413 else if (vim_isdigit(*arg))
3415 deep = getdigits(&arg);
3416 arg = skipwhite(arg);
3419 ex_unletlock(eap, arg, deep);
3423 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3425 static void
3426 ex_unletlock(eap, argstart, deep)
3427 exarg_T *eap;
3428 char_u *argstart;
3429 int deep;
3431 char_u *arg = argstart;
3432 char_u *name_end;
3433 int error = FALSE;
3434 lval_T lv;
3438 /* Parse the name and find the end. */
3439 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3440 FNE_CHECK_START);
3441 if (lv.ll_name == NULL)
3442 error = TRUE; /* error but continue parsing */
3443 if (name_end == NULL || (!vim_iswhite(*name_end)
3444 && !ends_excmd(*name_end)))
3446 if (name_end != NULL)
3448 emsg_severe = TRUE;
3449 EMSG(_(e_trailing));
3451 if (!(eap->skip || error))
3452 clear_lval(&lv);
3453 break;
3456 if (!error && !eap->skip)
3458 if (eap->cmdidx == CMD_unlet)
3460 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3461 error = TRUE;
3463 else
3465 if (do_lock_var(&lv, name_end, deep,
3466 eap->cmdidx == CMD_lockvar) == FAIL)
3467 error = TRUE;
3471 if (!eap->skip)
3472 clear_lval(&lv);
3474 arg = skipwhite(name_end);
3475 } while (!ends_excmd(*arg));
3477 eap->nextcmd = check_nextcmd(arg);
3480 static int
3481 do_unlet_var(lp, name_end, forceit)
3482 lval_T *lp;
3483 char_u *name_end;
3484 int forceit;
3486 int ret = OK;
3487 int cc;
3489 if (lp->ll_tv == NULL)
3491 cc = *name_end;
3492 *name_end = NUL;
3494 /* Normal name or expanded name. */
3495 if (check_changedtick(lp->ll_name))
3496 ret = FAIL;
3497 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3498 ret = FAIL;
3499 *name_end = cc;
3501 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3502 return FAIL;
3503 else if (lp->ll_range)
3505 listitem_T *li;
3507 /* Delete a range of List items. */
3508 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3510 li = lp->ll_li->li_next;
3511 listitem_remove(lp->ll_list, lp->ll_li);
3512 lp->ll_li = li;
3513 ++lp->ll_n1;
3516 else
3518 if (lp->ll_list != NULL)
3519 /* unlet a List item. */
3520 listitem_remove(lp->ll_list, lp->ll_li);
3521 else
3522 /* unlet a Dictionary item. */
3523 dictitem_remove(lp->ll_dict, lp->ll_di);
3526 return ret;
3530 * "unlet" a variable. Return OK if it existed, FAIL if not.
3531 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3534 do_unlet(name, forceit)
3535 char_u *name;
3536 int forceit;
3538 hashtab_T *ht;
3539 hashitem_T *hi;
3540 char_u *varname;
3541 dictitem_T *di;
3543 ht = find_var_ht(name, &varname);
3544 if (ht != NULL && *varname != NUL)
3546 hi = hash_find(ht, varname);
3547 if (!HASHITEM_EMPTY(hi))
3549 di = HI2DI(hi);
3550 if (var_check_fixed(di->di_flags, name)
3551 || var_check_ro(di->di_flags, name))
3552 return FAIL;
3553 delete_var(ht, hi);
3554 return OK;
3557 if (forceit)
3558 return OK;
3559 EMSG2(_("E108: No such variable: \"%s\""), name);
3560 return FAIL;
3564 * Lock or unlock variable indicated by "lp".
3565 * "deep" is the levels to go (-1 for unlimited);
3566 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3568 static int
3569 do_lock_var(lp, name_end, deep, lock)
3570 lval_T *lp;
3571 char_u *name_end;
3572 int deep;
3573 int lock;
3575 int ret = OK;
3576 int cc;
3577 dictitem_T *di;
3579 if (deep == 0) /* nothing to do */
3580 return OK;
3582 if (lp->ll_tv == NULL)
3584 cc = *name_end;
3585 *name_end = NUL;
3587 /* Normal name or expanded name. */
3588 if (check_changedtick(lp->ll_name))
3589 ret = FAIL;
3590 else
3592 di = find_var(lp->ll_name, NULL);
3593 if (di == NULL)
3594 ret = FAIL;
3595 else
3597 if (lock)
3598 di->di_flags |= DI_FLAGS_LOCK;
3599 else
3600 di->di_flags &= ~DI_FLAGS_LOCK;
3601 item_lock(&di->di_tv, deep, lock);
3604 *name_end = cc;
3606 else if (lp->ll_range)
3608 listitem_T *li = lp->ll_li;
3610 /* (un)lock a range of List items. */
3611 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3613 item_lock(&li->li_tv, deep, lock);
3614 li = li->li_next;
3615 ++lp->ll_n1;
3618 else if (lp->ll_list != NULL)
3619 /* (un)lock a List item. */
3620 item_lock(&lp->ll_li->li_tv, deep, lock);
3621 else
3622 /* un(lock) a Dictionary item. */
3623 item_lock(&lp->ll_di->di_tv, deep, lock);
3625 return ret;
3629 * Lock or unlock an item. "deep" is nr of levels to go.
3631 static void
3632 item_lock(tv, deep, lock)
3633 typval_T *tv;
3634 int deep;
3635 int lock;
3637 static int recurse = 0;
3638 list_T *l;
3639 listitem_T *li;
3640 dict_T *d;
3641 hashitem_T *hi;
3642 int todo;
3644 if (recurse >= DICT_MAXNEST)
3646 EMSG(_("E743: variable nested too deep for (un)lock"));
3647 return;
3649 if (deep == 0)
3650 return;
3651 ++recurse;
3653 /* lock/unlock the item itself */
3654 if (lock)
3655 tv->v_lock |= VAR_LOCKED;
3656 else
3657 tv->v_lock &= ~VAR_LOCKED;
3659 switch (tv->v_type)
3661 case VAR_LIST:
3662 if ((l = tv->vval.v_list) != NULL)
3664 if (lock)
3665 l->lv_lock |= VAR_LOCKED;
3666 else
3667 l->lv_lock &= ~VAR_LOCKED;
3668 if (deep < 0 || deep > 1)
3669 /* recursive: lock/unlock the items the List contains */
3670 for (li = l->lv_first; li != NULL; li = li->li_next)
3671 item_lock(&li->li_tv, deep - 1, lock);
3673 break;
3674 case VAR_DICT:
3675 if ((d = tv->vval.v_dict) != NULL)
3677 if (lock)
3678 d->dv_lock |= VAR_LOCKED;
3679 else
3680 d->dv_lock &= ~VAR_LOCKED;
3681 if (deep < 0 || deep > 1)
3683 /* recursive: lock/unlock the items the List contains */
3684 todo = (int)d->dv_hashtab.ht_used;
3685 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3687 if (!HASHITEM_EMPTY(hi))
3689 --todo;
3690 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3696 --recurse;
3700 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3701 * or it refers to a List or Dictionary that is locked.
3703 static int
3704 tv_islocked(tv)
3705 typval_T *tv;
3707 return (tv->v_lock & VAR_LOCKED)
3708 || (tv->v_type == VAR_LIST
3709 && tv->vval.v_list != NULL
3710 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3711 || (tv->v_type == VAR_DICT
3712 && tv->vval.v_dict != NULL
3713 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3716 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3718 * Delete all "menutrans_" variables.
3720 void
3721 del_menutrans_vars()
3723 hashitem_T *hi;
3724 int todo;
3726 hash_lock(&globvarht);
3727 todo = (int)globvarht.ht_used;
3728 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3730 if (!HASHITEM_EMPTY(hi))
3732 --todo;
3733 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3734 delete_var(&globvarht, hi);
3737 hash_unlock(&globvarht);
3739 #endif
3741 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3744 * Local string buffer for the next two functions to store a variable name
3745 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3746 * get_user_var_name().
3749 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3751 static char_u *varnamebuf = NULL;
3752 static int varnamebuflen = 0;
3755 * Function to concatenate a prefix and a variable name.
3757 static char_u *
3758 cat_prefix_varname(prefix, name)
3759 int prefix;
3760 char_u *name;
3762 int len;
3764 len = (int)STRLEN(name) + 3;
3765 if (len > varnamebuflen)
3767 vim_free(varnamebuf);
3768 len += 10; /* some additional space */
3769 varnamebuf = alloc(len);
3770 if (varnamebuf == NULL)
3772 varnamebuflen = 0;
3773 return NULL;
3775 varnamebuflen = len;
3777 *varnamebuf = prefix;
3778 varnamebuf[1] = ':';
3779 STRCPY(varnamebuf + 2, name);
3780 return varnamebuf;
3784 * Function given to ExpandGeneric() to obtain the list of user defined
3785 * (global/buffer/window/built-in) variable names.
3787 char_u *
3788 get_user_var_name(xp, idx)
3789 expand_T *xp;
3790 int idx;
3792 static long_u gdone;
3793 static long_u bdone;
3794 static long_u wdone;
3795 #ifdef FEAT_WINDOWS
3796 static long_u tdone;
3797 #endif
3798 static int vidx;
3799 static hashitem_T *hi;
3800 hashtab_T *ht;
3802 if (idx == 0)
3804 gdone = bdone = wdone = vidx = 0;
3805 #ifdef FEAT_WINDOWS
3806 tdone = 0;
3807 #endif
3810 /* Global variables */
3811 if (gdone < globvarht.ht_used)
3813 if (gdone++ == 0)
3814 hi = globvarht.ht_array;
3815 else
3816 ++hi;
3817 while (HASHITEM_EMPTY(hi))
3818 ++hi;
3819 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3820 return cat_prefix_varname('g', hi->hi_key);
3821 return hi->hi_key;
3824 /* b: variables */
3825 ht = &curbuf->b_vars.dv_hashtab;
3826 if (bdone < ht->ht_used)
3828 if (bdone++ == 0)
3829 hi = ht->ht_array;
3830 else
3831 ++hi;
3832 while (HASHITEM_EMPTY(hi))
3833 ++hi;
3834 return cat_prefix_varname('b', hi->hi_key);
3836 if (bdone == ht->ht_used)
3838 ++bdone;
3839 return (char_u *)"b:changedtick";
3842 /* w: variables */
3843 ht = &curwin->w_vars.dv_hashtab;
3844 if (wdone < ht->ht_used)
3846 if (wdone++ == 0)
3847 hi = ht->ht_array;
3848 else
3849 ++hi;
3850 while (HASHITEM_EMPTY(hi))
3851 ++hi;
3852 return cat_prefix_varname('w', hi->hi_key);
3855 #ifdef FEAT_WINDOWS
3856 /* t: variables */
3857 ht = &curtab->tp_vars.dv_hashtab;
3858 if (tdone < ht->ht_used)
3860 if (tdone++ == 0)
3861 hi = ht->ht_array;
3862 else
3863 ++hi;
3864 while (HASHITEM_EMPTY(hi))
3865 ++hi;
3866 return cat_prefix_varname('t', hi->hi_key);
3868 #endif
3870 /* v: variables */
3871 if (vidx < VV_LEN)
3872 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3874 vim_free(varnamebuf);
3875 varnamebuf = NULL;
3876 varnamebuflen = 0;
3877 return NULL;
3880 #endif /* FEAT_CMDL_COMPL */
3883 * types for expressions.
3885 typedef enum
3887 TYPE_UNKNOWN = 0
3888 , TYPE_EQUAL /* == */
3889 , TYPE_NEQUAL /* != */
3890 , TYPE_GREATER /* > */
3891 , TYPE_GEQUAL /* >= */
3892 , TYPE_SMALLER /* < */
3893 , TYPE_SEQUAL /* <= */
3894 , TYPE_MATCH /* =~ */
3895 , TYPE_NOMATCH /* !~ */
3896 } exptype_T;
3899 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3900 * executed. The function may return OK, but the rettv will be of type
3901 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3905 * Handle zero level expression.
3906 * This calls eval1() and handles error message and nextcmd.
3907 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3908 * Note: "rettv.v_lock" is not set.
3909 * Return OK or FAIL.
3911 static int
3912 eval0(arg, rettv, nextcmd, evaluate)
3913 char_u *arg;
3914 typval_T *rettv;
3915 char_u **nextcmd;
3916 int evaluate;
3918 int ret;
3919 char_u *p;
3921 p = skipwhite(arg);
3922 ret = eval1(&p, rettv, evaluate);
3923 if (ret == FAIL || !ends_excmd(*p))
3925 if (ret != FAIL)
3926 clear_tv(rettv);
3928 * Report the invalid expression unless the expression evaluation has
3929 * been cancelled due to an aborting error, an interrupt, or an
3930 * exception.
3932 if (!aborting())
3933 EMSG2(_(e_invexpr2), arg);
3934 ret = FAIL;
3936 if (nextcmd != NULL)
3937 *nextcmd = check_nextcmd(p);
3939 return ret;
3943 * Handle top level expression:
3944 * expr2 ? expr1 : expr1
3946 * "arg" must point to the first non-white of the expression.
3947 * "arg" is advanced to the next non-white after the recognized expression.
3949 * Note: "rettv.v_lock" is not set.
3951 * Return OK or FAIL.
3953 static int
3954 eval1(arg, rettv, evaluate)
3955 char_u **arg;
3956 typval_T *rettv;
3957 int evaluate;
3959 int result;
3960 typval_T var2;
3963 * Get the first variable.
3965 if (eval2(arg, rettv, evaluate) == FAIL)
3966 return FAIL;
3968 if ((*arg)[0] == '?')
3970 result = FALSE;
3971 if (evaluate)
3973 int error = FALSE;
3975 if (get_tv_number_chk(rettv, &error) != 0)
3976 result = TRUE;
3977 clear_tv(rettv);
3978 if (error)
3979 return FAIL;
3983 * Get the second variable.
3985 *arg = skipwhite(*arg + 1);
3986 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3987 return FAIL;
3990 * Check for the ":".
3992 if ((*arg)[0] != ':')
3994 EMSG(_("E109: Missing ':' after '?'"));
3995 if (evaluate && result)
3996 clear_tv(rettv);
3997 return FAIL;
4001 * Get the third variable.
4003 *arg = skipwhite(*arg + 1);
4004 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
4006 if (evaluate && result)
4007 clear_tv(rettv);
4008 return FAIL;
4010 if (evaluate && !result)
4011 *rettv = var2;
4014 return OK;
4018 * Handle first level expression:
4019 * expr2 || expr2 || expr2 logical OR
4021 * "arg" must point to the first non-white of the expression.
4022 * "arg" is advanced to the next non-white after the recognized expression.
4024 * Return OK or FAIL.
4026 static int
4027 eval2(arg, rettv, evaluate)
4028 char_u **arg;
4029 typval_T *rettv;
4030 int evaluate;
4032 typval_T var2;
4033 long result;
4034 int first;
4035 int error = FALSE;
4038 * Get the first variable.
4040 if (eval3(arg, rettv, evaluate) == FAIL)
4041 return FAIL;
4044 * Repeat until there is no following "||".
4046 first = TRUE;
4047 result = FALSE;
4048 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4050 if (evaluate && first)
4052 if (get_tv_number_chk(rettv, &error) != 0)
4053 result = TRUE;
4054 clear_tv(rettv);
4055 if (error)
4056 return FAIL;
4057 first = FALSE;
4061 * Get the second variable.
4063 *arg = skipwhite(*arg + 2);
4064 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4065 return FAIL;
4068 * Compute the result.
4070 if (evaluate && !result)
4072 if (get_tv_number_chk(&var2, &error) != 0)
4073 result = TRUE;
4074 clear_tv(&var2);
4075 if (error)
4076 return FAIL;
4078 if (evaluate)
4080 rettv->v_type = VAR_NUMBER;
4081 rettv->vval.v_number = result;
4085 return OK;
4089 * Handle second level expression:
4090 * expr3 && expr3 && expr3 logical AND
4092 * "arg" must point to the first non-white of the expression.
4093 * "arg" is advanced to the next non-white after the recognized expression.
4095 * Return OK or FAIL.
4097 static int
4098 eval3(arg, rettv, evaluate)
4099 char_u **arg;
4100 typval_T *rettv;
4101 int evaluate;
4103 typval_T var2;
4104 long result;
4105 int first;
4106 int error = FALSE;
4109 * Get the first variable.
4111 if (eval4(arg, rettv, evaluate) == FAIL)
4112 return FAIL;
4115 * Repeat until there is no following "&&".
4117 first = TRUE;
4118 result = TRUE;
4119 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4121 if (evaluate && first)
4123 if (get_tv_number_chk(rettv, &error) == 0)
4124 result = FALSE;
4125 clear_tv(rettv);
4126 if (error)
4127 return FAIL;
4128 first = FALSE;
4132 * Get the second variable.
4134 *arg = skipwhite(*arg + 2);
4135 if (eval4(arg, &var2, evaluate && result) == FAIL)
4136 return FAIL;
4139 * Compute the result.
4141 if (evaluate && result)
4143 if (get_tv_number_chk(&var2, &error) == 0)
4144 result = FALSE;
4145 clear_tv(&var2);
4146 if (error)
4147 return FAIL;
4149 if (evaluate)
4151 rettv->v_type = VAR_NUMBER;
4152 rettv->vval.v_number = result;
4156 return OK;
4160 * Handle third level expression:
4161 * var1 == var2
4162 * var1 =~ var2
4163 * var1 != var2
4164 * var1 !~ var2
4165 * var1 > var2
4166 * var1 >= var2
4167 * var1 < var2
4168 * var1 <= var2
4169 * var1 is var2
4170 * var1 isnot var2
4172 * "arg" must point to the first non-white of the expression.
4173 * "arg" is advanced to the next non-white after the recognized expression.
4175 * Return OK or FAIL.
4177 static int
4178 eval4(arg, rettv, evaluate)
4179 char_u **arg;
4180 typval_T *rettv;
4181 int evaluate;
4183 typval_T var2;
4184 char_u *p;
4185 int i;
4186 exptype_T type = TYPE_UNKNOWN;
4187 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4188 int len = 2;
4189 long n1, n2;
4190 char_u *s1, *s2;
4191 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4192 regmatch_T regmatch;
4193 int ic;
4194 char_u *save_cpo;
4197 * Get the first variable.
4199 if (eval5(arg, rettv, evaluate) == FAIL)
4200 return FAIL;
4202 p = *arg;
4203 switch (p[0])
4205 case '=': if (p[1] == '=')
4206 type = TYPE_EQUAL;
4207 else if (p[1] == '~')
4208 type = TYPE_MATCH;
4209 break;
4210 case '!': if (p[1] == '=')
4211 type = TYPE_NEQUAL;
4212 else if (p[1] == '~')
4213 type = TYPE_NOMATCH;
4214 break;
4215 case '>': if (p[1] != '=')
4217 type = TYPE_GREATER;
4218 len = 1;
4220 else
4221 type = TYPE_GEQUAL;
4222 break;
4223 case '<': if (p[1] != '=')
4225 type = TYPE_SMALLER;
4226 len = 1;
4228 else
4229 type = TYPE_SEQUAL;
4230 break;
4231 case 'i': if (p[1] == 's')
4233 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4234 len = 5;
4235 if (!vim_isIDc(p[len]))
4237 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4238 type_is = TRUE;
4241 break;
4245 * If there is a comparative operator, use it.
4247 if (type != TYPE_UNKNOWN)
4249 /* extra question mark appended: ignore case */
4250 if (p[len] == '?')
4252 ic = TRUE;
4253 ++len;
4255 /* extra '#' appended: match case */
4256 else if (p[len] == '#')
4258 ic = FALSE;
4259 ++len;
4261 /* nothing appended: use 'ignorecase' */
4262 else
4263 ic = p_ic;
4266 * Get the second variable.
4268 *arg = skipwhite(p + len);
4269 if (eval5(arg, &var2, evaluate) == FAIL)
4271 clear_tv(rettv);
4272 return FAIL;
4275 if (evaluate)
4277 if (type_is && rettv->v_type != var2.v_type)
4279 /* For "is" a different type always means FALSE, for "notis"
4280 * it means TRUE. */
4281 n1 = (type == TYPE_NEQUAL);
4283 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4285 if (type_is)
4287 n1 = (rettv->v_type == var2.v_type
4288 && rettv->vval.v_list == var2.vval.v_list);
4289 if (type == TYPE_NEQUAL)
4290 n1 = !n1;
4292 else if (rettv->v_type != var2.v_type
4293 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4295 if (rettv->v_type != var2.v_type)
4296 EMSG(_("E691: Can only compare List with List"));
4297 else
4298 EMSG(_("E692: Invalid operation for Lists"));
4299 clear_tv(rettv);
4300 clear_tv(&var2);
4301 return FAIL;
4303 else
4305 /* Compare two Lists for being equal or unequal. */
4306 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4307 if (type == TYPE_NEQUAL)
4308 n1 = !n1;
4312 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4314 if (type_is)
4316 n1 = (rettv->v_type == var2.v_type
4317 && rettv->vval.v_dict == var2.vval.v_dict);
4318 if (type == TYPE_NEQUAL)
4319 n1 = !n1;
4321 else if (rettv->v_type != var2.v_type
4322 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4324 if (rettv->v_type != var2.v_type)
4325 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4326 else
4327 EMSG(_("E736: Invalid operation for Dictionary"));
4328 clear_tv(rettv);
4329 clear_tv(&var2);
4330 return FAIL;
4332 else
4334 /* Compare two Dictionaries for being equal or unequal. */
4335 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4336 if (type == TYPE_NEQUAL)
4337 n1 = !n1;
4341 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4343 if (rettv->v_type != var2.v_type
4344 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4346 if (rettv->v_type != var2.v_type)
4347 EMSG(_("E693: Can only compare Funcref with Funcref"));
4348 else
4349 EMSG(_("E694: Invalid operation for Funcrefs"));
4350 clear_tv(rettv);
4351 clear_tv(&var2);
4352 return FAIL;
4354 else
4356 /* Compare two Funcrefs for being equal or unequal. */
4357 if (rettv->vval.v_string == NULL
4358 || var2.vval.v_string == NULL)
4359 n1 = FALSE;
4360 else
4361 n1 = STRCMP(rettv->vval.v_string,
4362 var2.vval.v_string) == 0;
4363 if (type == TYPE_NEQUAL)
4364 n1 = !n1;
4368 #ifdef FEAT_FLOAT
4370 * If one of the two variables is a float, compare as a float.
4371 * When using "=~" or "!~", always compare as string.
4373 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4374 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4376 float_T f1, f2;
4378 if (rettv->v_type == VAR_FLOAT)
4379 f1 = rettv->vval.v_float;
4380 else
4381 f1 = get_tv_number(rettv);
4382 if (var2.v_type == VAR_FLOAT)
4383 f2 = var2.vval.v_float;
4384 else
4385 f2 = get_tv_number(&var2);
4386 n1 = FALSE;
4387 switch (type)
4389 case TYPE_EQUAL: n1 = (f1 == f2); break;
4390 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4391 case TYPE_GREATER: n1 = (f1 > f2); break;
4392 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4393 case TYPE_SMALLER: n1 = (f1 < f2); break;
4394 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4395 case TYPE_UNKNOWN:
4396 case TYPE_MATCH:
4397 case TYPE_NOMATCH: break; /* avoid gcc warning */
4400 #endif
4403 * If one of the two variables is a number, compare as a number.
4404 * When using "=~" or "!~", always compare as string.
4406 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4407 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4409 n1 = get_tv_number(rettv);
4410 n2 = get_tv_number(&var2);
4411 switch (type)
4413 case TYPE_EQUAL: n1 = (n1 == n2); break;
4414 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4415 case TYPE_GREATER: n1 = (n1 > n2); break;
4416 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4417 case TYPE_SMALLER: n1 = (n1 < n2); break;
4418 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4419 case TYPE_UNKNOWN:
4420 case TYPE_MATCH:
4421 case TYPE_NOMATCH: break; /* avoid gcc warning */
4424 else
4426 s1 = get_tv_string_buf(rettv, buf1);
4427 s2 = get_tv_string_buf(&var2, buf2);
4428 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4429 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4430 else
4431 i = 0;
4432 n1 = FALSE;
4433 switch (type)
4435 case TYPE_EQUAL: n1 = (i == 0); break;
4436 case TYPE_NEQUAL: n1 = (i != 0); break;
4437 case TYPE_GREATER: n1 = (i > 0); break;
4438 case TYPE_GEQUAL: n1 = (i >= 0); break;
4439 case TYPE_SMALLER: n1 = (i < 0); break;
4440 case TYPE_SEQUAL: n1 = (i <= 0); break;
4442 case TYPE_MATCH:
4443 case TYPE_NOMATCH:
4444 /* avoid 'l' flag in 'cpoptions' */
4445 save_cpo = p_cpo;
4446 p_cpo = (char_u *)"";
4447 regmatch.regprog = vim_regcomp(s2,
4448 RE_MAGIC + RE_STRING);
4449 regmatch.rm_ic = ic;
4450 if (regmatch.regprog != NULL)
4452 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4453 vim_free(regmatch.regprog);
4454 if (type == TYPE_NOMATCH)
4455 n1 = !n1;
4457 p_cpo = save_cpo;
4458 break;
4460 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4463 clear_tv(rettv);
4464 clear_tv(&var2);
4465 rettv->v_type = VAR_NUMBER;
4466 rettv->vval.v_number = n1;
4470 return OK;
4474 * Handle fourth level expression:
4475 * + number addition
4476 * - number subtraction
4477 * . string concatenation
4479 * "arg" must point to the first non-white of the expression.
4480 * "arg" is advanced to the next non-white after the recognized expression.
4482 * Return OK or FAIL.
4484 static int
4485 eval5(arg, rettv, evaluate)
4486 char_u **arg;
4487 typval_T *rettv;
4488 int evaluate;
4490 typval_T var2;
4491 typval_T var3;
4492 int op;
4493 long n1, n2;
4494 #ifdef FEAT_FLOAT
4495 float_T f1 = 0, f2 = 0;
4496 #endif
4497 char_u *s1, *s2;
4498 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4499 char_u *p;
4502 * Get the first variable.
4504 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4505 return FAIL;
4508 * Repeat computing, until no '+', '-' or '.' is following.
4510 for (;;)
4512 op = **arg;
4513 if (op != '+' && op != '-' && op != '.')
4514 break;
4516 if ((op != '+' || rettv->v_type != VAR_LIST)
4517 #ifdef FEAT_FLOAT
4518 && (op == '.' || rettv->v_type != VAR_FLOAT)
4519 #endif
4522 /* For "list + ...", an illegal use of the first operand as
4523 * a number cannot be determined before evaluating the 2nd
4524 * operand: if this is also a list, all is ok.
4525 * For "something . ...", "something - ..." or "non-list + ...",
4526 * we know that the first operand needs to be a string or number
4527 * without evaluating the 2nd operand. So check before to avoid
4528 * side effects after an error. */
4529 if (evaluate && get_tv_string_chk(rettv) == NULL)
4531 clear_tv(rettv);
4532 return FAIL;
4537 * Get the second variable.
4539 *arg = skipwhite(*arg + 1);
4540 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4542 clear_tv(rettv);
4543 return FAIL;
4546 if (evaluate)
4549 * Compute the result.
4551 if (op == '.')
4553 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4554 s2 = get_tv_string_buf_chk(&var2, buf2);
4555 if (s2 == NULL) /* type error ? */
4557 clear_tv(rettv);
4558 clear_tv(&var2);
4559 return FAIL;
4561 p = concat_str(s1, s2);
4562 clear_tv(rettv);
4563 rettv->v_type = VAR_STRING;
4564 rettv->vval.v_string = p;
4566 else if (op == '+' && rettv->v_type == VAR_LIST
4567 && var2.v_type == VAR_LIST)
4569 /* concatenate Lists */
4570 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4571 &var3) == FAIL)
4573 clear_tv(rettv);
4574 clear_tv(&var2);
4575 return FAIL;
4577 clear_tv(rettv);
4578 *rettv = var3;
4580 else
4582 int error = FALSE;
4584 #ifdef FEAT_FLOAT
4585 if (rettv->v_type == VAR_FLOAT)
4587 f1 = rettv->vval.v_float;
4588 n1 = 0;
4590 else
4591 #endif
4593 n1 = get_tv_number_chk(rettv, &error);
4594 if (error)
4596 /* This can only happen for "list + non-list". For
4597 * "non-list + ..." or "something - ...", we returned
4598 * before evaluating the 2nd operand. */
4599 clear_tv(rettv);
4600 return FAIL;
4602 #ifdef FEAT_FLOAT
4603 if (var2.v_type == VAR_FLOAT)
4604 f1 = n1;
4605 #endif
4607 #ifdef FEAT_FLOAT
4608 if (var2.v_type == VAR_FLOAT)
4610 f2 = var2.vval.v_float;
4611 n2 = 0;
4613 else
4614 #endif
4616 n2 = get_tv_number_chk(&var2, &error);
4617 if (error)
4619 clear_tv(rettv);
4620 clear_tv(&var2);
4621 return FAIL;
4623 #ifdef FEAT_FLOAT
4624 if (rettv->v_type == VAR_FLOAT)
4625 f2 = n2;
4626 #endif
4628 clear_tv(rettv);
4630 #ifdef FEAT_FLOAT
4631 /* If there is a float on either side the result is a float. */
4632 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4634 if (op == '+')
4635 f1 = f1 + f2;
4636 else
4637 f1 = f1 - f2;
4638 rettv->v_type = VAR_FLOAT;
4639 rettv->vval.v_float = f1;
4641 else
4642 #endif
4644 if (op == '+')
4645 n1 = n1 + n2;
4646 else
4647 n1 = n1 - n2;
4648 rettv->v_type = VAR_NUMBER;
4649 rettv->vval.v_number = n1;
4652 clear_tv(&var2);
4655 return OK;
4659 * Handle fifth level expression:
4660 * * number multiplication
4661 * / number division
4662 * % number modulo
4664 * "arg" must point to the first non-white of the expression.
4665 * "arg" is advanced to the next non-white after the recognized expression.
4667 * Return OK or FAIL.
4669 static int
4670 eval6(arg, rettv, evaluate, want_string)
4671 char_u **arg;
4672 typval_T *rettv;
4673 int evaluate;
4674 int want_string; /* after "." operator */
4676 typval_T var2;
4677 int op;
4678 long n1, n2;
4679 #ifdef FEAT_FLOAT
4680 int use_float = FALSE;
4681 float_T f1 = 0, f2;
4682 #endif
4683 int error = FALSE;
4686 * Get the first variable.
4688 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4689 return FAIL;
4692 * Repeat computing, until no '*', '/' or '%' is following.
4694 for (;;)
4696 op = **arg;
4697 if (op != '*' && op != '/' && op != '%')
4698 break;
4700 if (evaluate)
4702 #ifdef FEAT_FLOAT
4703 if (rettv->v_type == VAR_FLOAT)
4705 f1 = rettv->vval.v_float;
4706 use_float = TRUE;
4707 n1 = 0;
4709 else
4710 #endif
4711 n1 = get_tv_number_chk(rettv, &error);
4712 clear_tv(rettv);
4713 if (error)
4714 return FAIL;
4716 else
4717 n1 = 0;
4720 * Get the second variable.
4722 *arg = skipwhite(*arg + 1);
4723 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4724 return FAIL;
4726 if (evaluate)
4728 #ifdef FEAT_FLOAT
4729 if (var2.v_type == VAR_FLOAT)
4731 if (!use_float)
4733 f1 = n1;
4734 use_float = TRUE;
4736 f2 = var2.vval.v_float;
4737 n2 = 0;
4739 else
4740 #endif
4742 n2 = get_tv_number_chk(&var2, &error);
4743 clear_tv(&var2);
4744 if (error)
4745 return FAIL;
4746 #ifdef FEAT_FLOAT
4747 if (use_float)
4748 f2 = n2;
4749 #endif
4753 * Compute the result.
4754 * When either side is a float the result is a float.
4756 #ifdef FEAT_FLOAT
4757 if (use_float)
4759 if (op == '*')
4760 f1 = f1 * f2;
4761 else if (op == '/')
4763 /* We rely on the floating point library to handle divide
4764 * by zero to result in "inf" and not a crash. */
4765 f1 = f1 / f2;
4767 else
4769 EMSG(_("E804: Cannot use '%' with Float"));
4770 return FAIL;
4772 rettv->v_type = VAR_FLOAT;
4773 rettv->vval.v_float = f1;
4775 else
4776 #endif
4778 if (op == '*')
4779 n1 = n1 * n2;
4780 else if (op == '/')
4782 if (n2 == 0) /* give an error message? */
4784 if (n1 == 0)
4785 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4786 else if (n1 < 0)
4787 n1 = -0x7fffffffL;
4788 else
4789 n1 = 0x7fffffffL;
4791 else
4792 n1 = n1 / n2;
4794 else
4796 if (n2 == 0) /* give an error message? */
4797 n1 = 0;
4798 else
4799 n1 = n1 % n2;
4801 rettv->v_type = VAR_NUMBER;
4802 rettv->vval.v_number = n1;
4807 return OK;
4811 * Handle sixth level expression:
4812 * number number constant
4813 * "string" string constant
4814 * 'string' literal string constant
4815 * &option-name option value
4816 * @r register contents
4817 * identifier variable value
4818 * function() function call
4819 * $VAR environment variable
4820 * (expression) nested expression
4821 * [expr, expr] List
4822 * {key: val, key: val} Dictionary
4824 * Also handle:
4825 * ! in front logical NOT
4826 * - in front unary minus
4827 * + in front unary plus (ignored)
4828 * trailing [] subscript in String or List
4829 * trailing .name entry in Dictionary
4831 * "arg" must point to the first non-white of the expression.
4832 * "arg" is advanced to the next non-white after the recognized expression.
4834 * Return OK or FAIL.
4836 static int
4837 eval7(arg, rettv, evaluate, want_string)
4838 char_u **arg;
4839 typval_T *rettv;
4840 int evaluate;
4841 int want_string; /* after "." operator */
4843 long n;
4844 int len;
4845 char_u *s;
4846 char_u *start_leader, *end_leader;
4847 int ret = OK;
4848 char_u *alias;
4851 * Initialise variable so that clear_tv() can't mistake this for a
4852 * string and free a string that isn't there.
4854 rettv->v_type = VAR_UNKNOWN;
4857 * Skip '!' and '-' characters. They are handled later.
4859 start_leader = *arg;
4860 while (**arg == '!' || **arg == '-' || **arg == '+')
4861 *arg = skipwhite(*arg + 1);
4862 end_leader = *arg;
4864 switch (**arg)
4867 * Number constant.
4869 case '0':
4870 case '1':
4871 case '2':
4872 case '3':
4873 case '4':
4874 case '5':
4875 case '6':
4876 case '7':
4877 case '8':
4878 case '9':
4880 #ifdef FEAT_FLOAT
4881 char_u *p = skipdigits(*arg + 1);
4882 int get_float = FALSE;
4884 /* We accept a float when the format matches
4885 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4886 * strict to avoid backwards compatibility problems.
4887 * Don't look for a float after the "." operator, so that
4888 * ":let vers = 1.2.3" doesn't fail. */
4889 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4891 get_float = TRUE;
4892 p = skipdigits(p + 2);
4893 if (*p == 'e' || *p == 'E')
4895 ++p;
4896 if (*p == '-' || *p == '+')
4897 ++p;
4898 if (!vim_isdigit(*p))
4899 get_float = FALSE;
4900 else
4901 p = skipdigits(p + 1);
4903 if (ASCII_ISALPHA(*p) || *p == '.')
4904 get_float = FALSE;
4906 if (get_float)
4908 float_T f;
4910 *arg += string2float(*arg, &f);
4911 if (evaluate)
4913 rettv->v_type = VAR_FLOAT;
4914 rettv->vval.v_float = f;
4917 else
4918 #endif
4920 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4921 *arg += len;
4922 if (evaluate)
4924 rettv->v_type = VAR_NUMBER;
4925 rettv->vval.v_number = n;
4928 break;
4932 * String constant: "string".
4934 case '"': ret = get_string_tv(arg, rettv, evaluate);
4935 break;
4938 * Literal string constant: 'str''ing'.
4940 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4941 break;
4944 * List: [expr, expr]
4946 case '[': ret = get_list_tv(arg, rettv, evaluate);
4947 break;
4950 * Dictionary: {key: val, key: val}
4952 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4953 break;
4956 * Option value: &name
4958 case '&': ret = get_option_tv(arg, rettv, evaluate);
4959 break;
4962 * Environment variable: $VAR.
4964 case '$': ret = get_env_tv(arg, rettv, evaluate);
4965 break;
4968 * Register contents: @r.
4970 case '@': ++*arg;
4971 if (evaluate)
4973 rettv->v_type = VAR_STRING;
4974 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4976 if (**arg != NUL)
4977 ++*arg;
4978 break;
4981 * nested expression: (expression).
4983 case '(': *arg = skipwhite(*arg + 1);
4984 ret = eval1(arg, rettv, evaluate); /* recursive! */
4985 if (**arg == ')')
4986 ++*arg;
4987 else if (ret == OK)
4989 EMSG(_("E110: Missing ')'"));
4990 clear_tv(rettv);
4991 ret = FAIL;
4993 break;
4995 default: ret = NOTDONE;
4996 break;
4999 if (ret == NOTDONE)
5002 * Must be a variable or function name.
5003 * Can also be a curly-braces kind of name: {expr}.
5005 s = *arg;
5006 len = get_name_len(arg, &alias, evaluate, TRUE);
5007 if (alias != NULL)
5008 s = alias;
5010 if (len <= 0)
5011 ret = FAIL;
5012 else
5014 if (**arg == '(') /* recursive! */
5016 /* If "s" is the name of a variable of type VAR_FUNC
5017 * use its contents. */
5018 s = deref_func_name(s, &len);
5020 /* Invoke the function. */
5021 ret = get_func_tv(s, len, rettv, arg,
5022 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5023 &len, evaluate, NULL);
5024 /* Stop the expression evaluation when immediately
5025 * aborting on error, or when an interrupt occurred or
5026 * an exception was thrown but not caught. */
5027 if (aborting())
5029 if (ret == OK)
5030 clear_tv(rettv);
5031 ret = FAIL;
5034 else if (evaluate)
5035 ret = get_var_tv(s, len, rettv, TRUE);
5036 else
5037 ret = OK;
5040 if (alias != NULL)
5041 vim_free(alias);
5044 *arg = skipwhite(*arg);
5046 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5047 * expr(expr). */
5048 if (ret == OK)
5049 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5052 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5054 if (ret == OK && evaluate && end_leader > start_leader)
5056 int error = FALSE;
5057 int val = 0;
5058 #ifdef FEAT_FLOAT
5059 float_T f = 0.0;
5061 if (rettv->v_type == VAR_FLOAT)
5062 f = rettv->vval.v_float;
5063 else
5064 #endif
5065 val = get_tv_number_chk(rettv, &error);
5066 if (error)
5068 clear_tv(rettv);
5069 ret = FAIL;
5071 else
5073 while (end_leader > start_leader)
5075 --end_leader;
5076 if (*end_leader == '!')
5078 #ifdef FEAT_FLOAT
5079 if (rettv->v_type == VAR_FLOAT)
5080 f = !f;
5081 else
5082 #endif
5083 val = !val;
5085 else if (*end_leader == '-')
5087 #ifdef FEAT_FLOAT
5088 if (rettv->v_type == VAR_FLOAT)
5089 f = -f;
5090 else
5091 #endif
5092 val = -val;
5095 #ifdef FEAT_FLOAT
5096 if (rettv->v_type == VAR_FLOAT)
5098 clear_tv(rettv);
5099 rettv->vval.v_float = f;
5101 else
5102 #endif
5104 clear_tv(rettv);
5105 rettv->v_type = VAR_NUMBER;
5106 rettv->vval.v_number = val;
5111 return ret;
5115 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5116 * "*arg" points to the '[' or '.'.
5117 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5119 static int
5120 eval_index(arg, rettv, evaluate, verbose)
5121 char_u **arg;
5122 typval_T *rettv;
5123 int evaluate;
5124 int verbose; /* give error messages */
5126 int empty1 = FALSE, empty2 = FALSE;
5127 typval_T var1, var2;
5128 long n1, n2 = 0;
5129 long len = -1;
5130 int range = FALSE;
5131 char_u *s;
5132 char_u *key = NULL;
5134 if (rettv->v_type == VAR_FUNC
5135 #ifdef FEAT_FLOAT
5136 || rettv->v_type == VAR_FLOAT
5137 #endif
5140 if (verbose)
5141 EMSG(_("E695: Cannot index a Funcref"));
5142 return FAIL;
5145 if (**arg == '.')
5148 * dict.name
5150 key = *arg + 1;
5151 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5153 if (len == 0)
5154 return FAIL;
5155 *arg = skipwhite(key + len);
5157 else
5160 * something[idx]
5162 * Get the (first) variable from inside the [].
5164 *arg = skipwhite(*arg + 1);
5165 if (**arg == ':')
5166 empty1 = TRUE;
5167 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5168 return FAIL;
5169 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5171 /* not a number or string */
5172 clear_tv(&var1);
5173 return FAIL;
5177 * Get the second variable from inside the [:].
5179 if (**arg == ':')
5181 range = TRUE;
5182 *arg = skipwhite(*arg + 1);
5183 if (**arg == ']')
5184 empty2 = TRUE;
5185 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5187 if (!empty1)
5188 clear_tv(&var1);
5189 return FAIL;
5191 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5193 /* not a number or string */
5194 if (!empty1)
5195 clear_tv(&var1);
5196 clear_tv(&var2);
5197 return FAIL;
5201 /* Check for the ']'. */
5202 if (**arg != ']')
5204 if (verbose)
5205 EMSG(_(e_missbrac));
5206 clear_tv(&var1);
5207 if (range)
5208 clear_tv(&var2);
5209 return FAIL;
5211 *arg = skipwhite(*arg + 1); /* skip the ']' */
5214 if (evaluate)
5216 n1 = 0;
5217 if (!empty1 && rettv->v_type != VAR_DICT)
5219 n1 = get_tv_number(&var1);
5220 clear_tv(&var1);
5222 if (range)
5224 if (empty2)
5225 n2 = -1;
5226 else
5228 n2 = get_tv_number(&var2);
5229 clear_tv(&var2);
5233 switch (rettv->v_type)
5235 case VAR_NUMBER:
5236 case VAR_STRING:
5237 s = get_tv_string(rettv);
5238 len = (long)STRLEN(s);
5239 if (range)
5241 /* The resulting variable is a substring. If the indexes
5242 * are out of range the result is empty. */
5243 if (n1 < 0)
5245 n1 = len + n1;
5246 if (n1 < 0)
5247 n1 = 0;
5249 if (n2 < 0)
5250 n2 = len + n2;
5251 else if (n2 >= len)
5252 n2 = len;
5253 if (n1 >= len || n2 < 0 || n1 > n2)
5254 s = NULL;
5255 else
5256 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5258 else
5260 /* The resulting variable is a string of a single
5261 * character. If the index is too big or negative the
5262 * result is empty. */
5263 if (n1 >= len || n1 < 0)
5264 s = NULL;
5265 else
5266 s = vim_strnsave(s + n1, 1);
5268 clear_tv(rettv);
5269 rettv->v_type = VAR_STRING;
5270 rettv->vval.v_string = s;
5271 break;
5273 case VAR_LIST:
5274 len = list_len(rettv->vval.v_list);
5275 if (n1 < 0)
5276 n1 = len + n1;
5277 if (!empty1 && (n1 < 0 || n1 >= len))
5279 /* For a range we allow invalid values and return an empty
5280 * list. A list index out of range is an error. */
5281 if (!range)
5283 if (verbose)
5284 EMSGN(_(e_listidx), n1);
5285 return FAIL;
5287 n1 = len;
5289 if (range)
5291 list_T *l;
5292 listitem_T *item;
5294 if (n2 < 0)
5295 n2 = len + n2;
5296 else if (n2 >= len)
5297 n2 = len - 1;
5298 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5299 n2 = -1;
5300 l = list_alloc();
5301 if (l == NULL)
5302 return FAIL;
5303 for (item = list_find(rettv->vval.v_list, n1);
5304 n1 <= n2; ++n1)
5306 if (list_append_tv(l, &item->li_tv) == FAIL)
5308 list_free(l, TRUE);
5309 return FAIL;
5311 item = item->li_next;
5313 clear_tv(rettv);
5314 rettv->v_type = VAR_LIST;
5315 rettv->vval.v_list = l;
5316 ++l->lv_refcount;
5318 else
5320 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5321 clear_tv(rettv);
5322 *rettv = var1;
5324 break;
5326 case VAR_DICT:
5327 if (range)
5329 if (verbose)
5330 EMSG(_(e_dictrange));
5331 if (len == -1)
5332 clear_tv(&var1);
5333 return FAIL;
5336 dictitem_T *item;
5338 if (len == -1)
5340 key = get_tv_string(&var1);
5341 if (*key == NUL)
5343 if (verbose)
5344 EMSG(_(e_emptykey));
5345 clear_tv(&var1);
5346 return FAIL;
5350 item = dict_find(rettv->vval.v_dict, key, (int)len);
5352 if (item == NULL && verbose)
5353 EMSG2(_(e_dictkey), key);
5354 if (len == -1)
5355 clear_tv(&var1);
5356 if (item == NULL)
5357 return FAIL;
5359 copy_tv(&item->di_tv, &var1);
5360 clear_tv(rettv);
5361 *rettv = var1;
5363 break;
5367 return OK;
5371 * Get an option value.
5372 * "arg" points to the '&' or '+' before the option name.
5373 * "arg" is advanced to character after the option name.
5374 * Return OK or FAIL.
5376 static int
5377 get_option_tv(arg, rettv, evaluate)
5378 char_u **arg;
5379 typval_T *rettv; /* when NULL, only check if option exists */
5380 int evaluate;
5382 char_u *option_end;
5383 long numval;
5384 char_u *stringval;
5385 int opt_type;
5386 int c;
5387 int working = (**arg == '+'); /* has("+option") */
5388 int ret = OK;
5389 int opt_flags;
5392 * Isolate the option name and find its value.
5394 option_end = find_option_end(arg, &opt_flags);
5395 if (option_end == NULL)
5397 if (rettv != NULL)
5398 EMSG2(_("E112: Option name missing: %s"), *arg);
5399 return FAIL;
5402 if (!evaluate)
5404 *arg = option_end;
5405 return OK;
5408 c = *option_end;
5409 *option_end = NUL;
5410 opt_type = get_option_value(*arg, &numval,
5411 rettv == NULL ? NULL : &stringval, opt_flags);
5413 if (opt_type == -3) /* invalid name */
5415 if (rettv != NULL)
5416 EMSG2(_("E113: Unknown option: %s"), *arg);
5417 ret = FAIL;
5419 else if (rettv != NULL)
5421 if (opt_type == -2) /* hidden string option */
5423 rettv->v_type = VAR_STRING;
5424 rettv->vval.v_string = NULL;
5426 else if (opt_type == -1) /* hidden number option */
5428 rettv->v_type = VAR_NUMBER;
5429 rettv->vval.v_number = 0;
5431 else if (opt_type == 1) /* number option */
5433 rettv->v_type = VAR_NUMBER;
5434 rettv->vval.v_number = numval;
5436 else /* string option */
5438 rettv->v_type = VAR_STRING;
5439 rettv->vval.v_string = stringval;
5442 else if (working && (opt_type == -2 || opt_type == -1))
5443 ret = FAIL;
5445 *option_end = c; /* put back for error messages */
5446 *arg = option_end;
5448 return ret;
5452 * Allocate a variable for a string constant.
5453 * Return OK or FAIL.
5455 static int
5456 get_string_tv(arg, rettv, evaluate)
5457 char_u **arg;
5458 typval_T *rettv;
5459 int evaluate;
5461 char_u *p;
5462 char_u *name;
5463 int extra = 0;
5466 * Find the end of the string, skipping backslashed characters.
5468 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5470 if (*p == '\\' && p[1] != NUL)
5472 ++p;
5473 /* A "\<x>" form occupies at least 4 characters, and produces up
5474 * to 6 characters: reserve space for 2 extra */
5475 if (*p == '<')
5476 extra += 2;
5480 if (*p != '"')
5482 EMSG2(_("E114: Missing quote: %s"), *arg);
5483 return FAIL;
5486 /* If only parsing, set *arg and return here */
5487 if (!evaluate)
5489 *arg = p + 1;
5490 return OK;
5494 * Copy the string into allocated memory, handling backslashed
5495 * characters.
5497 name = alloc((unsigned)(p - *arg + extra));
5498 if (name == NULL)
5499 return FAIL;
5500 rettv->v_type = VAR_STRING;
5501 rettv->vval.v_string = name;
5503 for (p = *arg + 1; *p != NUL && *p != '"'; )
5505 if (*p == '\\')
5507 switch (*++p)
5509 case 'b': *name++ = BS; ++p; break;
5510 case 'e': *name++ = ESC; ++p; break;
5511 case 'f': *name++ = FF; ++p; break;
5512 case 'n': *name++ = NL; ++p; break;
5513 case 'r': *name++ = CAR; ++p; break;
5514 case 't': *name++ = TAB; ++p; break;
5516 case 'X': /* hex: "\x1", "\x12" */
5517 case 'x':
5518 case 'u': /* Unicode: "\u0023" */
5519 case 'U':
5520 if (vim_isxdigit(p[1]))
5522 int n, nr;
5523 int c = toupper(*p);
5525 if (c == 'X')
5526 n = 2;
5527 else
5528 n = 4;
5529 nr = 0;
5530 while (--n >= 0 && vim_isxdigit(p[1]))
5532 ++p;
5533 nr = (nr << 4) + hex2nr(*p);
5535 ++p;
5536 #ifdef FEAT_MBYTE
5537 /* For "\u" store the number according to
5538 * 'encoding'. */
5539 if (c != 'X')
5540 name += (*mb_char2bytes)(nr, name);
5541 else
5542 #endif
5543 *name++ = nr;
5545 break;
5547 /* octal: "\1", "\12", "\123" */
5548 case '0':
5549 case '1':
5550 case '2':
5551 case '3':
5552 case '4':
5553 case '5':
5554 case '6':
5555 case '7': *name = *p++ - '0';
5556 if (*p >= '0' && *p <= '7')
5558 *name = (*name << 3) + *p++ - '0';
5559 if (*p >= '0' && *p <= '7')
5560 *name = (*name << 3) + *p++ - '0';
5562 ++name;
5563 break;
5565 /* Special key, e.g.: "\<C-W>" */
5566 case '<': extra = trans_special(&p, name, TRUE);
5567 if (extra != 0)
5569 name += extra;
5570 break;
5572 /* FALLTHROUGH */
5574 default: MB_COPY_CHAR(p, name);
5575 break;
5578 else
5579 MB_COPY_CHAR(p, name);
5582 *name = NUL;
5583 *arg = p + 1;
5585 return OK;
5589 * Allocate a variable for a 'str''ing' constant.
5590 * Return OK or FAIL.
5592 static int
5593 get_lit_string_tv(arg, rettv, evaluate)
5594 char_u **arg;
5595 typval_T *rettv;
5596 int evaluate;
5598 char_u *p;
5599 char_u *str;
5600 int reduce = 0;
5603 * Find the end of the string, skipping ''.
5605 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5607 if (*p == '\'')
5609 if (p[1] != '\'')
5610 break;
5611 ++reduce;
5612 ++p;
5616 if (*p != '\'')
5618 EMSG2(_("E115: Missing quote: %s"), *arg);
5619 return FAIL;
5622 /* If only parsing return after setting "*arg" */
5623 if (!evaluate)
5625 *arg = p + 1;
5626 return OK;
5630 * Copy the string into allocated memory, handling '' to ' reduction.
5632 str = alloc((unsigned)((p - *arg) - reduce));
5633 if (str == NULL)
5634 return FAIL;
5635 rettv->v_type = VAR_STRING;
5636 rettv->vval.v_string = str;
5638 for (p = *arg + 1; *p != NUL; )
5640 if (*p == '\'')
5642 if (p[1] != '\'')
5643 break;
5644 ++p;
5646 MB_COPY_CHAR(p, str);
5648 *str = NUL;
5649 *arg = p + 1;
5651 return OK;
5655 * Allocate a variable for a List and fill it from "*arg".
5656 * Return OK or FAIL.
5658 static int
5659 get_list_tv(arg, rettv, evaluate)
5660 char_u **arg;
5661 typval_T *rettv;
5662 int evaluate;
5664 list_T *l = NULL;
5665 typval_T tv;
5666 listitem_T *item;
5668 if (evaluate)
5670 l = list_alloc();
5671 if (l == NULL)
5672 return FAIL;
5675 *arg = skipwhite(*arg + 1);
5676 while (**arg != ']' && **arg != NUL)
5678 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5679 goto failret;
5680 if (evaluate)
5682 item = listitem_alloc();
5683 if (item != NULL)
5685 item->li_tv = tv;
5686 item->li_tv.v_lock = 0;
5687 list_append(l, item);
5689 else
5690 clear_tv(&tv);
5693 if (**arg == ']')
5694 break;
5695 if (**arg != ',')
5697 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5698 goto failret;
5700 *arg = skipwhite(*arg + 1);
5703 if (**arg != ']')
5705 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5706 failret:
5707 if (evaluate)
5708 list_free(l, TRUE);
5709 return FAIL;
5712 *arg = skipwhite(*arg + 1);
5713 if (evaluate)
5715 rettv->v_type = VAR_LIST;
5716 rettv->vval.v_list = l;
5717 ++l->lv_refcount;
5720 return OK;
5724 * Allocate an empty header for a list.
5725 * Caller should take care of the reference count.
5727 list_T *
5728 list_alloc()
5730 list_T *l;
5732 l = (list_T *)alloc_clear(sizeof(list_T));
5733 if (l != NULL)
5735 /* Prepend the list to the list of lists for garbage collection. */
5736 if (first_list != NULL)
5737 first_list->lv_used_prev = l;
5738 l->lv_used_prev = NULL;
5739 l->lv_used_next = first_list;
5740 first_list = l;
5742 return l;
5746 * Allocate an empty list for a return value.
5747 * Returns OK or FAIL.
5749 static int
5750 rettv_list_alloc(rettv)
5751 typval_T *rettv;
5753 list_T *l = list_alloc();
5755 if (l == NULL)
5756 return FAIL;
5758 rettv->vval.v_list = l;
5759 rettv->v_type = VAR_LIST;
5760 ++l->lv_refcount;
5761 return OK;
5765 * Unreference a list: decrement the reference count and free it when it
5766 * becomes zero.
5768 void
5769 list_unref(l)
5770 list_T *l;
5772 if (l != NULL && --l->lv_refcount <= 0)
5773 list_free(l, TRUE);
5777 * Free a list, including all items it points to.
5778 * Ignores the reference count.
5780 void
5781 list_free(l, recurse)
5782 list_T *l;
5783 int recurse; /* Free Lists and Dictionaries recursively. */
5785 listitem_T *item;
5787 /* Remove the list from the list of lists for garbage collection. */
5788 if (l->lv_used_prev == NULL)
5789 first_list = l->lv_used_next;
5790 else
5791 l->lv_used_prev->lv_used_next = l->lv_used_next;
5792 if (l->lv_used_next != NULL)
5793 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5795 for (item = l->lv_first; item != NULL; item = l->lv_first)
5797 /* Remove the item before deleting it. */
5798 l->lv_first = item->li_next;
5799 if (recurse || (item->li_tv.v_type != VAR_LIST
5800 && item->li_tv.v_type != VAR_DICT))
5801 clear_tv(&item->li_tv);
5802 vim_free(item);
5804 vim_free(l);
5808 * Allocate a list item.
5810 static listitem_T *
5811 listitem_alloc()
5813 return (listitem_T *)alloc(sizeof(listitem_T));
5817 * Free a list item. Also clears the value. Does not notify watchers.
5819 static void
5820 listitem_free(item)
5821 listitem_T *item;
5823 clear_tv(&item->li_tv);
5824 vim_free(item);
5828 * Remove a list item from a List and free it. Also clears the value.
5830 static void
5831 listitem_remove(l, item)
5832 list_T *l;
5833 listitem_T *item;
5835 list_remove(l, item, item);
5836 listitem_free(item);
5840 * Get the number of items in a list.
5842 static long
5843 list_len(l)
5844 list_T *l;
5846 if (l == NULL)
5847 return 0L;
5848 return l->lv_len;
5852 * Return TRUE when two lists have exactly the same values.
5854 static int
5855 list_equal(l1, l2, ic)
5856 list_T *l1;
5857 list_T *l2;
5858 int ic; /* ignore case for strings */
5860 listitem_T *item1, *item2;
5862 if (l1 == NULL || l2 == NULL)
5863 return FALSE;
5864 if (l1 == l2)
5865 return TRUE;
5866 if (list_len(l1) != list_len(l2))
5867 return FALSE;
5869 for (item1 = l1->lv_first, item2 = l2->lv_first;
5870 item1 != NULL && item2 != NULL;
5871 item1 = item1->li_next, item2 = item2->li_next)
5872 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5873 return FALSE;
5874 return item1 == NULL && item2 == NULL;
5877 #if defined(FEAT_PYTHON) || defined(FEAT_MZSCHEME) || defined(PROTO) \
5878 || defined(FEAT_GUI_MACVIM)
5880 * Return the dictitem that an entry in a hashtable points to.
5882 dictitem_T *
5883 dict_lookup(hi)
5884 hashitem_T *hi;
5886 return HI2DI(hi);
5888 #endif
5891 * Return TRUE when two dictionaries have exactly the same key/values.
5893 static int
5894 dict_equal(d1, d2, ic)
5895 dict_T *d1;
5896 dict_T *d2;
5897 int ic; /* ignore case for strings */
5899 hashitem_T *hi;
5900 dictitem_T *item2;
5901 int todo;
5903 if (d1 == NULL || d2 == NULL)
5904 return FALSE;
5905 if (d1 == d2)
5906 return TRUE;
5907 if (dict_len(d1) != dict_len(d2))
5908 return FALSE;
5910 todo = (int)d1->dv_hashtab.ht_used;
5911 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5913 if (!HASHITEM_EMPTY(hi))
5915 item2 = dict_find(d2, hi->hi_key, -1);
5916 if (item2 == NULL)
5917 return FALSE;
5918 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5919 return FALSE;
5920 --todo;
5923 return TRUE;
5927 * Return TRUE if "tv1" and "tv2" have the same value.
5928 * Compares the items just like "==" would compare them, but strings and
5929 * numbers are different. Floats and numbers are also different.
5931 static int
5932 tv_equal(tv1, tv2, ic)
5933 typval_T *tv1;
5934 typval_T *tv2;
5935 int ic; /* ignore case */
5937 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5938 char_u *s1, *s2;
5939 static int recursive = 0; /* cach recursive loops */
5940 int r;
5942 if (tv1->v_type != tv2->v_type)
5943 return FALSE;
5944 /* Catch lists and dicts that have an endless loop by limiting
5945 * recursiveness to 1000. We guess they are equal then. */
5946 if (recursive >= 1000)
5947 return TRUE;
5949 switch (tv1->v_type)
5951 case VAR_LIST:
5952 ++recursive;
5953 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5954 --recursive;
5955 return r;
5957 case VAR_DICT:
5958 ++recursive;
5959 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5960 --recursive;
5961 return r;
5963 case VAR_FUNC:
5964 return (tv1->vval.v_string != NULL
5965 && tv2->vval.v_string != NULL
5966 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5968 case VAR_NUMBER:
5969 return tv1->vval.v_number == tv2->vval.v_number;
5971 #ifdef FEAT_FLOAT
5972 case VAR_FLOAT:
5973 return tv1->vval.v_float == tv2->vval.v_float;
5974 #endif
5976 case VAR_STRING:
5977 s1 = get_tv_string_buf(tv1, buf1);
5978 s2 = get_tv_string_buf(tv2, buf2);
5979 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5982 EMSG2(_(e_intern2), "tv_equal()");
5983 return TRUE;
5987 * Locate item with index "n" in list "l" and return it.
5988 * A negative index is counted from the end; -1 is the last item.
5989 * Returns NULL when "n" is out of range.
5991 static listitem_T *
5992 list_find(l, n)
5993 list_T *l;
5994 long n;
5996 listitem_T *item;
5997 long idx;
5999 if (l == NULL)
6000 return NULL;
6002 /* Negative index is relative to the end. */
6003 if (n < 0)
6004 n = l->lv_len + n;
6006 /* Check for index out of range. */
6007 if (n < 0 || n >= l->lv_len)
6008 return NULL;
6010 /* When there is a cached index may start search from there. */
6011 if (l->lv_idx_item != NULL)
6013 if (n < l->lv_idx / 2)
6015 /* closest to the start of the list */
6016 item = l->lv_first;
6017 idx = 0;
6019 else if (n > (l->lv_idx + l->lv_len) / 2)
6021 /* closest to the end of the list */
6022 item = l->lv_last;
6023 idx = l->lv_len - 1;
6025 else
6027 /* closest to the cached index */
6028 item = l->lv_idx_item;
6029 idx = l->lv_idx;
6032 else
6034 if (n < l->lv_len / 2)
6036 /* closest to the start of the list */
6037 item = l->lv_first;
6038 idx = 0;
6040 else
6042 /* closest to the end of the list */
6043 item = l->lv_last;
6044 idx = l->lv_len - 1;
6048 while (n > idx)
6050 /* search forward */
6051 item = item->li_next;
6052 ++idx;
6054 while (n < idx)
6056 /* search backward */
6057 item = item->li_prev;
6058 --idx;
6061 /* cache the used index */
6062 l->lv_idx = idx;
6063 l->lv_idx_item = item;
6065 return item;
6069 * Get list item "l[idx]" as a number.
6071 static long
6072 list_find_nr(l, idx, errorp)
6073 list_T *l;
6074 long idx;
6075 int *errorp; /* set to TRUE when something wrong */
6077 listitem_T *li;
6079 li = list_find(l, idx);
6080 if (li == NULL)
6082 if (errorp != NULL)
6083 *errorp = TRUE;
6084 return -1L;
6086 return get_tv_number_chk(&li->li_tv, errorp);
6090 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6092 char_u *
6093 list_find_str(l, idx)
6094 list_T *l;
6095 long idx;
6097 listitem_T *li;
6099 li = list_find(l, idx - 1);
6100 if (li == NULL)
6102 EMSGN(_(e_listidx), idx);
6103 return NULL;
6105 return get_tv_string(&li->li_tv);
6109 * Locate "item" list "l" and return its index.
6110 * Returns -1 when "item" is not in the list.
6112 static long
6113 list_idx_of_item(l, item)
6114 list_T *l;
6115 listitem_T *item;
6117 long idx = 0;
6118 listitem_T *li;
6120 if (l == NULL)
6121 return -1;
6122 idx = 0;
6123 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6124 ++idx;
6125 if (li == NULL)
6126 return -1;
6127 return idx;
6131 * Append item "item" to the end of list "l".
6133 static void
6134 list_append(l, item)
6135 list_T *l;
6136 listitem_T *item;
6138 if (l->lv_last == NULL)
6140 /* empty list */
6141 l->lv_first = item;
6142 l->lv_last = item;
6143 item->li_prev = NULL;
6145 else
6147 l->lv_last->li_next = item;
6148 item->li_prev = l->lv_last;
6149 l->lv_last = item;
6151 ++l->lv_len;
6152 item->li_next = NULL;
6156 * Append typval_T "tv" to the end of list "l".
6157 * Return FAIL when out of memory.
6159 static int
6160 list_append_tv(l, tv)
6161 list_T *l;
6162 typval_T *tv;
6164 listitem_T *li = listitem_alloc();
6166 if (li == NULL)
6167 return FAIL;
6168 copy_tv(tv, &li->li_tv);
6169 list_append(l, li);
6170 return OK;
6174 * Add a dictionary to a list. Used by getqflist().
6175 * Return FAIL when out of memory.
6178 list_append_dict(list, dict)
6179 list_T *list;
6180 dict_T *dict;
6182 listitem_T *li = listitem_alloc();
6184 if (li == NULL)
6185 return FAIL;
6186 li->li_tv.v_type = VAR_DICT;
6187 li->li_tv.v_lock = 0;
6188 li->li_tv.vval.v_dict = dict;
6189 list_append(list, li);
6190 ++dict->dv_refcount;
6191 return OK;
6195 * Make a copy of "str" and append it as an item to list "l".
6196 * When "len" >= 0 use "str[len]".
6197 * Returns FAIL when out of memory.
6200 list_append_string(l, str, len)
6201 list_T *l;
6202 char_u *str;
6203 int len;
6205 listitem_T *li = listitem_alloc();
6207 if (li == NULL)
6208 return FAIL;
6209 list_append(l, li);
6210 li->li_tv.v_type = VAR_STRING;
6211 li->li_tv.v_lock = 0;
6212 if (str == NULL)
6213 li->li_tv.vval.v_string = NULL;
6214 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6215 : vim_strsave(str))) == NULL)
6216 return FAIL;
6217 return OK;
6221 * Append "n" to list "l".
6222 * Returns FAIL when out of memory.
6224 static int
6225 list_append_number(l, n)
6226 list_T *l;
6227 varnumber_T n;
6229 listitem_T *li;
6231 li = listitem_alloc();
6232 if (li == NULL)
6233 return FAIL;
6234 li->li_tv.v_type = VAR_NUMBER;
6235 li->li_tv.v_lock = 0;
6236 li->li_tv.vval.v_number = n;
6237 list_append(l, li);
6238 return OK;
6242 * Insert typval_T "tv" in list "l" before "item".
6243 * If "item" is NULL append at the end.
6244 * Return FAIL when out of memory.
6246 static int
6247 list_insert_tv(l, tv, item)
6248 list_T *l;
6249 typval_T *tv;
6250 listitem_T *item;
6252 listitem_T *ni = listitem_alloc();
6254 if (ni == NULL)
6255 return FAIL;
6256 copy_tv(tv, &ni->li_tv);
6257 if (item == NULL)
6258 /* Append new item at end of list. */
6259 list_append(l, ni);
6260 else
6262 /* Insert new item before existing item. */
6263 ni->li_prev = item->li_prev;
6264 ni->li_next = item;
6265 if (item->li_prev == NULL)
6267 l->lv_first = ni;
6268 ++l->lv_idx;
6270 else
6272 item->li_prev->li_next = ni;
6273 l->lv_idx_item = NULL;
6275 item->li_prev = ni;
6276 ++l->lv_len;
6278 return OK;
6282 * Extend "l1" with "l2".
6283 * If "bef" is NULL append at the end, otherwise insert before this item.
6284 * Returns FAIL when out of memory.
6286 static int
6287 list_extend(l1, l2, bef)
6288 list_T *l1;
6289 list_T *l2;
6290 listitem_T *bef;
6292 listitem_T *item;
6293 int todo = l2->lv_len;
6295 /* We also quit the loop when we have inserted the original item count of
6296 * the list, avoid a hang when we extend a list with itself. */
6297 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6298 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6299 return FAIL;
6300 return OK;
6304 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6305 * Return FAIL when out of memory.
6307 static int
6308 list_concat(l1, l2, tv)
6309 list_T *l1;
6310 list_T *l2;
6311 typval_T *tv;
6313 list_T *l;
6315 if (l1 == NULL || l2 == NULL)
6316 return FAIL;
6318 /* make a copy of the first list. */
6319 l = list_copy(l1, FALSE, 0);
6320 if (l == NULL)
6321 return FAIL;
6322 tv->v_type = VAR_LIST;
6323 tv->vval.v_list = l;
6325 /* append all items from the second list */
6326 return list_extend(l, l2, NULL);
6330 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6331 * The refcount of the new list is set to 1.
6332 * See item_copy() for "copyID".
6333 * Returns NULL when out of memory.
6335 static list_T *
6336 list_copy(orig, deep, copyID)
6337 list_T *orig;
6338 int deep;
6339 int copyID;
6341 list_T *copy;
6342 listitem_T *item;
6343 listitem_T *ni;
6345 if (orig == NULL)
6346 return NULL;
6348 copy = list_alloc();
6349 if (copy != NULL)
6351 if (copyID != 0)
6353 /* Do this before adding the items, because one of the items may
6354 * refer back to this list. */
6355 orig->lv_copyID = copyID;
6356 orig->lv_copylist = copy;
6358 for (item = orig->lv_first; item != NULL && !got_int;
6359 item = item->li_next)
6361 ni = listitem_alloc();
6362 if (ni == NULL)
6363 break;
6364 if (deep)
6366 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6368 vim_free(ni);
6369 break;
6372 else
6373 copy_tv(&item->li_tv, &ni->li_tv);
6374 list_append(copy, ni);
6376 ++copy->lv_refcount;
6377 if (item != NULL)
6379 list_unref(copy);
6380 copy = NULL;
6384 return copy;
6388 * Remove items "item" to "item2" from list "l".
6389 * Does not free the listitem or the value!
6391 static void
6392 list_remove(l, item, item2)
6393 list_T *l;
6394 listitem_T *item;
6395 listitem_T *item2;
6397 listitem_T *ip;
6399 /* notify watchers */
6400 for (ip = item; ip != NULL; ip = ip->li_next)
6402 --l->lv_len;
6403 list_fix_watch(l, ip);
6404 if (ip == item2)
6405 break;
6408 if (item2->li_next == NULL)
6409 l->lv_last = item->li_prev;
6410 else
6411 item2->li_next->li_prev = item->li_prev;
6412 if (item->li_prev == NULL)
6413 l->lv_first = item2->li_next;
6414 else
6415 item->li_prev->li_next = item2->li_next;
6416 l->lv_idx_item = NULL;
6420 * Return an allocated string with the string representation of a list.
6421 * May return NULL.
6423 static char_u *
6424 list2string(tv, copyID)
6425 typval_T *tv;
6426 int copyID;
6428 garray_T ga;
6430 if (tv->vval.v_list == NULL)
6431 return NULL;
6432 ga_init2(&ga, (int)sizeof(char), 80);
6433 ga_append(&ga, '[');
6434 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6436 vim_free(ga.ga_data);
6437 return NULL;
6439 ga_append(&ga, ']');
6440 ga_append(&ga, NUL);
6441 return (char_u *)ga.ga_data;
6445 * Join list "l" into a string in "*gap", using separator "sep".
6446 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6447 * Return FAIL or OK.
6449 static int
6450 list_join(gap, l, sep, echo, copyID)
6451 garray_T *gap;
6452 list_T *l;
6453 char_u *sep;
6454 int echo;
6455 int copyID;
6457 int first = TRUE;
6458 char_u *tofree;
6459 char_u numbuf[NUMBUFLEN];
6460 listitem_T *item;
6461 char_u *s;
6463 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6465 if (first)
6466 first = FALSE;
6467 else
6468 ga_concat(gap, sep);
6470 if (echo)
6471 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6472 else
6473 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6474 if (s != NULL)
6475 ga_concat(gap, s);
6476 vim_free(tofree);
6477 if (s == NULL)
6478 return FAIL;
6480 return OK;
6484 * Garbage collection for lists and dictionaries.
6486 * We use reference counts to be able to free most items right away when they
6487 * are no longer used. But for composite items it's possible that it becomes
6488 * unused while the reference count is > 0: When there is a recursive
6489 * reference. Example:
6490 * :let l = [1, 2, 3]
6491 * :let d = {9: l}
6492 * :let l[1] = d
6494 * Since this is quite unusual we handle this with garbage collection: every
6495 * once in a while find out which lists and dicts are not referenced from any
6496 * variable.
6498 * Here is a good reference text about garbage collection (refers to Python
6499 * but it applies to all reference-counting mechanisms):
6500 * http://python.ca/nas/python/gc/
6504 * Do garbage collection for lists and dicts.
6505 * Return TRUE if some memory was freed.
6508 garbage_collect()
6510 int copyID;
6511 buf_T *buf;
6512 win_T *wp;
6513 int i;
6514 funccall_T *fc, **pfc;
6515 int did_free;
6516 int did_free_funccal = FALSE;
6517 #ifdef FEAT_WINDOWS
6518 tabpage_T *tp;
6519 #endif
6521 /* Only do this once. */
6522 want_garbage_collect = FALSE;
6523 may_garbage_collect = FALSE;
6524 garbage_collect_at_exit = FALSE;
6526 /* We advance by two because we add one for items referenced through
6527 * previous_funccal. */
6528 current_copyID += COPYID_INC;
6529 copyID = current_copyID;
6532 * 1. Go through all accessible variables and mark all lists and dicts
6533 * with copyID.
6536 /* Don't free variables in the previous_funccal list unless they are only
6537 * referenced through previous_funccal. This must be first, because if
6538 * the item is referenced elsewhere the funccal must not be freed. */
6539 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
6541 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1);
6542 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1);
6545 /* script-local variables */
6546 for (i = 1; i <= ga_scripts.ga_len; ++i)
6547 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6549 /* buffer-local variables */
6550 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6551 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6553 /* window-local variables */
6554 FOR_ALL_TAB_WINDOWS(tp, wp)
6555 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6557 #ifdef FEAT_WINDOWS
6558 /* tabpage-local variables */
6559 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6560 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6561 #endif
6563 /* global variables */
6564 set_ref_in_ht(&globvarht, copyID);
6566 /* function-local variables */
6567 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6569 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6570 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6573 /* v: vars */
6574 set_ref_in_ht(&vimvarht, copyID);
6577 * 2. Free lists and dictionaries that are not referenced.
6579 did_free = free_unref_items(copyID);
6582 * 3. Check if any funccal can be freed now.
6584 for (pfc = &previous_funccal; *pfc != NULL; )
6586 if (can_free_funccal(*pfc, copyID))
6588 fc = *pfc;
6589 *pfc = fc->caller;
6590 free_funccal(fc, TRUE);
6591 did_free = TRUE;
6592 did_free_funccal = TRUE;
6594 else
6595 pfc = &(*pfc)->caller;
6597 if (did_free_funccal)
6598 /* When a funccal was freed some more items might be garbage
6599 * collected, so run again. */
6600 (void)garbage_collect();
6602 return did_free;
6606 * Free lists and dictionaries that are no longer referenced.
6608 static int
6609 free_unref_items(copyID)
6610 int copyID;
6612 dict_T *dd;
6613 list_T *ll;
6614 int did_free = FALSE;
6617 * Go through the list of dicts and free items without the copyID.
6619 for (dd = first_dict; dd != NULL; )
6620 if ((dd->dv_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
6622 /* Free the Dictionary and ordinary items it contains, but don't
6623 * recurse into Lists and Dictionaries, they will be in the list
6624 * of dicts or list of lists. */
6625 dict_free(dd, FALSE);
6626 did_free = TRUE;
6628 /* restart, next dict may also have been freed */
6629 dd = first_dict;
6631 else
6632 dd = dd->dv_used_next;
6635 * Go through the list of lists and free items without the copyID.
6636 * But don't free a list that has a watcher (used in a for loop), these
6637 * are not referenced anywhere.
6639 for (ll = first_list; ll != NULL; )
6640 if ((ll->lv_copyID & COPYID_MASK) != (copyID & COPYID_MASK)
6641 && ll->lv_watch == NULL)
6643 /* Free the List and ordinary items it contains, but don't recurse
6644 * into Lists and Dictionaries, they will be in the list of dicts
6645 * or list of lists. */
6646 list_free(ll, FALSE);
6647 did_free = TRUE;
6649 /* restart, next list may also have been freed */
6650 ll = first_list;
6652 else
6653 ll = ll->lv_used_next;
6655 return did_free;
6659 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6661 static void
6662 set_ref_in_ht(ht, copyID)
6663 hashtab_T *ht;
6664 int copyID;
6666 int todo;
6667 hashitem_T *hi;
6669 todo = (int)ht->ht_used;
6670 for (hi = ht->ht_array; todo > 0; ++hi)
6671 if (!HASHITEM_EMPTY(hi))
6673 --todo;
6674 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6679 * Mark all lists and dicts referenced through list "l" with "copyID".
6681 static void
6682 set_ref_in_list(l, copyID)
6683 list_T *l;
6684 int copyID;
6686 listitem_T *li;
6688 for (li = l->lv_first; li != NULL; li = li->li_next)
6689 set_ref_in_item(&li->li_tv, copyID);
6693 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6695 static void
6696 set_ref_in_item(tv, copyID)
6697 typval_T *tv;
6698 int copyID;
6700 dict_T *dd;
6701 list_T *ll;
6703 switch (tv->v_type)
6705 case VAR_DICT:
6706 dd = tv->vval.v_dict;
6707 if (dd != NULL && dd->dv_copyID != copyID)
6709 /* Didn't see this dict yet. */
6710 dd->dv_copyID = copyID;
6711 set_ref_in_ht(&dd->dv_hashtab, copyID);
6713 break;
6715 case VAR_LIST:
6716 ll = tv->vval.v_list;
6717 if (ll != NULL && ll->lv_copyID != copyID)
6719 /* Didn't see this list yet. */
6720 ll->lv_copyID = copyID;
6721 set_ref_in_list(ll, copyID);
6723 break;
6725 return;
6729 * Allocate an empty header for a dictionary.
6731 dict_T *
6732 dict_alloc()
6734 dict_T *d;
6736 d = (dict_T *)alloc(sizeof(dict_T));
6737 if (d != NULL)
6739 /* Add the list to the list of dicts for garbage collection. */
6740 if (first_dict != NULL)
6741 first_dict->dv_used_prev = d;
6742 d->dv_used_next = first_dict;
6743 d->dv_used_prev = NULL;
6744 first_dict = d;
6746 hash_init(&d->dv_hashtab);
6747 d->dv_lock = 0;
6748 d->dv_refcount = 0;
6749 d->dv_copyID = 0;
6751 return d;
6755 * Unreference a Dictionary: decrement the reference count and free it when it
6756 * becomes zero.
6758 static void
6759 dict_unref(d)
6760 dict_T *d;
6762 if (d != NULL && --d->dv_refcount <= 0)
6763 dict_free(d, TRUE);
6767 * Free a Dictionary, including all items it contains.
6768 * Ignores the reference count.
6770 static void
6771 dict_free(d, recurse)
6772 dict_T *d;
6773 int recurse; /* Free Lists and Dictionaries recursively. */
6775 int todo;
6776 hashitem_T *hi;
6777 dictitem_T *di;
6779 /* Remove the dict from the list of dicts for garbage collection. */
6780 if (d->dv_used_prev == NULL)
6781 first_dict = d->dv_used_next;
6782 else
6783 d->dv_used_prev->dv_used_next = d->dv_used_next;
6784 if (d->dv_used_next != NULL)
6785 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6787 /* Lock the hashtab, we don't want it to resize while freeing items. */
6788 hash_lock(&d->dv_hashtab);
6789 todo = (int)d->dv_hashtab.ht_used;
6790 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6792 if (!HASHITEM_EMPTY(hi))
6794 /* Remove the item before deleting it, just in case there is
6795 * something recursive causing trouble. */
6796 di = HI2DI(hi);
6797 hash_remove(&d->dv_hashtab, hi);
6798 if (recurse || (di->di_tv.v_type != VAR_LIST
6799 && di->di_tv.v_type != VAR_DICT))
6800 clear_tv(&di->di_tv);
6801 vim_free(di);
6802 --todo;
6805 hash_clear(&d->dv_hashtab);
6806 vim_free(d);
6810 * Allocate a Dictionary item.
6811 * The "key" is copied to the new item.
6812 * Note that the value of the item "di_tv" still needs to be initialized!
6813 * Returns NULL when out of memory.
6815 static dictitem_T *
6816 dictitem_alloc(key)
6817 char_u *key;
6819 dictitem_T *di;
6821 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6822 if (di != NULL)
6824 STRCPY(di->di_key, key);
6825 di->di_flags = 0;
6827 return di;
6831 * Make a copy of a Dictionary item.
6833 static dictitem_T *
6834 dictitem_copy(org)
6835 dictitem_T *org;
6837 dictitem_T *di;
6839 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6840 + STRLEN(org->di_key)));
6841 if (di != NULL)
6843 STRCPY(di->di_key, org->di_key);
6844 di->di_flags = 0;
6845 copy_tv(&org->di_tv, &di->di_tv);
6847 return di;
6851 * Remove item "item" from Dictionary "dict" and free it.
6853 static void
6854 dictitem_remove(dict, item)
6855 dict_T *dict;
6856 dictitem_T *item;
6858 hashitem_T *hi;
6860 hi = hash_find(&dict->dv_hashtab, item->di_key);
6861 if (HASHITEM_EMPTY(hi))
6862 EMSG2(_(e_intern2), "dictitem_remove()");
6863 else
6864 hash_remove(&dict->dv_hashtab, hi);
6865 dictitem_free(item);
6869 * Free a dict item. Also clears the value.
6871 static void
6872 dictitem_free(item)
6873 dictitem_T *item;
6875 clear_tv(&item->di_tv);
6876 vim_free(item);
6880 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6881 * The refcount of the new dict is set to 1.
6882 * See item_copy() for "copyID".
6883 * Returns NULL when out of memory.
6885 static dict_T *
6886 dict_copy(orig, deep, copyID)
6887 dict_T *orig;
6888 int deep;
6889 int copyID;
6891 dict_T *copy;
6892 dictitem_T *di;
6893 int todo;
6894 hashitem_T *hi;
6896 if (orig == NULL)
6897 return NULL;
6899 copy = dict_alloc();
6900 if (copy != NULL)
6902 if (copyID != 0)
6904 orig->dv_copyID = copyID;
6905 orig->dv_copydict = copy;
6907 todo = (int)orig->dv_hashtab.ht_used;
6908 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6910 if (!HASHITEM_EMPTY(hi))
6912 --todo;
6914 di = dictitem_alloc(hi->hi_key);
6915 if (di == NULL)
6916 break;
6917 if (deep)
6919 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6920 copyID) == FAIL)
6922 vim_free(di);
6923 break;
6926 else
6927 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6928 if (dict_add(copy, di) == FAIL)
6930 dictitem_free(di);
6931 break;
6936 ++copy->dv_refcount;
6937 if (todo > 0)
6939 dict_unref(copy);
6940 copy = NULL;
6944 return copy;
6948 * Add item "item" to Dictionary "d".
6949 * Returns FAIL when out of memory and when key already existed.
6951 static int
6952 dict_add(d, item)
6953 dict_T *d;
6954 dictitem_T *item;
6956 return hash_add(&d->dv_hashtab, item->di_key);
6960 * Add a number or string entry to dictionary "d".
6961 * When "str" is NULL use number "nr", otherwise use "str".
6962 * Returns FAIL when out of memory and when key already exists.
6965 dict_add_nr_str(d, key, nr, str)
6966 dict_T *d;
6967 char *key;
6968 long nr;
6969 char_u *str;
6971 dictitem_T *item;
6973 item = dictitem_alloc((char_u *)key);
6974 if (item == NULL)
6975 return FAIL;
6976 item->di_tv.v_lock = 0;
6977 if (str == NULL)
6979 item->di_tv.v_type = VAR_NUMBER;
6980 item->di_tv.vval.v_number = nr;
6982 else
6984 item->di_tv.v_type = VAR_STRING;
6985 item->di_tv.vval.v_string = vim_strsave(str);
6987 if (dict_add(d, item) == FAIL)
6989 dictitem_free(item);
6990 return FAIL;
6992 return OK;
6996 * Get the number of items in a Dictionary.
6998 static long
6999 dict_len(d)
7000 dict_T *d;
7002 if (d == NULL)
7003 return 0L;
7004 return (long)d->dv_hashtab.ht_used;
7008 * Find item "key[len]" in Dictionary "d".
7009 * If "len" is negative use strlen(key).
7010 * Returns NULL when not found.
7012 static dictitem_T *
7013 dict_find(d, key, len)
7014 dict_T *d;
7015 char_u *key;
7016 int len;
7018 #define AKEYLEN 200
7019 char_u buf[AKEYLEN];
7020 char_u *akey;
7021 char_u *tofree = NULL;
7022 hashitem_T *hi;
7024 if (len < 0)
7025 akey = key;
7026 else if (len >= AKEYLEN)
7028 tofree = akey = vim_strnsave(key, len);
7029 if (akey == NULL)
7030 return NULL;
7032 else
7034 /* Avoid a malloc/free by using buf[]. */
7035 vim_strncpy(buf, key, len);
7036 akey = buf;
7039 hi = hash_find(&d->dv_hashtab, akey);
7040 vim_free(tofree);
7041 if (HASHITEM_EMPTY(hi))
7042 return NULL;
7043 return HI2DI(hi);
7047 * Get a string item from a dictionary.
7048 * When "save" is TRUE allocate memory for it.
7049 * Returns NULL if the entry doesn't exist or out of memory.
7051 char_u *
7052 get_dict_string(d, key, save)
7053 dict_T *d;
7054 char_u *key;
7055 int save;
7057 dictitem_T *di;
7058 char_u *s;
7060 di = dict_find(d, key, -1);
7061 if (di == NULL)
7062 return NULL;
7063 s = get_tv_string(&di->di_tv);
7064 if (save && s != NULL)
7065 s = vim_strsave(s);
7066 return s;
7070 * Get a number item from a dictionary.
7071 * Returns 0 if the entry doesn't exist or out of memory.
7073 long
7074 get_dict_number(d, key)
7075 dict_T *d;
7076 char_u *key;
7078 dictitem_T *di;
7080 di = dict_find(d, key, -1);
7081 if (di == NULL)
7082 return 0;
7083 return get_tv_number(&di->di_tv);
7087 * Return an allocated string with the string representation of a Dictionary.
7088 * May return NULL.
7090 static char_u *
7091 dict2string(tv, copyID)
7092 typval_T *tv;
7093 int copyID;
7095 garray_T ga;
7096 int first = TRUE;
7097 char_u *tofree;
7098 char_u numbuf[NUMBUFLEN];
7099 hashitem_T *hi;
7100 char_u *s;
7101 dict_T *d;
7102 int todo;
7104 if ((d = tv->vval.v_dict) == NULL)
7105 return NULL;
7106 ga_init2(&ga, (int)sizeof(char), 80);
7107 ga_append(&ga, '{');
7109 todo = (int)d->dv_hashtab.ht_used;
7110 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7112 if (!HASHITEM_EMPTY(hi))
7114 --todo;
7116 if (first)
7117 first = FALSE;
7118 else
7119 ga_concat(&ga, (char_u *)", ");
7121 tofree = string_quote(hi->hi_key, FALSE);
7122 if (tofree != NULL)
7124 ga_concat(&ga, tofree);
7125 vim_free(tofree);
7127 ga_concat(&ga, (char_u *)": ");
7128 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7129 if (s != NULL)
7130 ga_concat(&ga, s);
7131 vim_free(tofree);
7132 if (s == NULL)
7133 break;
7136 if (todo > 0)
7138 vim_free(ga.ga_data);
7139 return NULL;
7142 ga_append(&ga, '}');
7143 ga_append(&ga, NUL);
7144 return (char_u *)ga.ga_data;
7148 * Allocate a variable for a Dictionary and fill it from "*arg".
7149 * Return OK or FAIL. Returns NOTDONE for {expr}.
7151 static int
7152 get_dict_tv(arg, rettv, evaluate)
7153 char_u **arg;
7154 typval_T *rettv;
7155 int evaluate;
7157 dict_T *d = NULL;
7158 typval_T tvkey;
7159 typval_T tv;
7160 char_u *key = NULL;
7161 dictitem_T *item;
7162 char_u *start = skipwhite(*arg + 1);
7163 char_u buf[NUMBUFLEN];
7166 * First check if it's not a curly-braces thing: {expr}.
7167 * Must do this without evaluating, otherwise a function may be called
7168 * twice. Unfortunately this means we need to call eval1() twice for the
7169 * first item.
7170 * But {} is an empty Dictionary.
7172 if (*start != '}')
7174 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7175 return FAIL;
7176 if (*start == '}')
7177 return NOTDONE;
7180 if (evaluate)
7182 d = dict_alloc();
7183 if (d == NULL)
7184 return FAIL;
7186 tvkey.v_type = VAR_UNKNOWN;
7187 tv.v_type = VAR_UNKNOWN;
7189 *arg = skipwhite(*arg + 1);
7190 while (**arg != '}' && **arg != NUL)
7192 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7193 goto failret;
7194 if (**arg != ':')
7196 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7197 clear_tv(&tvkey);
7198 goto failret;
7200 if (evaluate)
7202 key = get_tv_string_buf_chk(&tvkey, buf);
7203 if (key == NULL || *key == NUL)
7205 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7206 if (key != NULL)
7207 EMSG(_(e_emptykey));
7208 clear_tv(&tvkey);
7209 goto failret;
7213 *arg = skipwhite(*arg + 1);
7214 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7216 if (evaluate)
7217 clear_tv(&tvkey);
7218 goto failret;
7220 if (evaluate)
7222 item = dict_find(d, key, -1);
7223 if (item != NULL)
7225 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7226 clear_tv(&tvkey);
7227 clear_tv(&tv);
7228 goto failret;
7230 item = dictitem_alloc(key);
7231 clear_tv(&tvkey);
7232 if (item != NULL)
7234 item->di_tv = tv;
7235 item->di_tv.v_lock = 0;
7236 if (dict_add(d, item) == FAIL)
7237 dictitem_free(item);
7241 if (**arg == '}')
7242 break;
7243 if (**arg != ',')
7245 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7246 goto failret;
7248 *arg = skipwhite(*arg + 1);
7251 if (**arg != '}')
7253 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7254 failret:
7255 if (evaluate)
7256 dict_free(d, TRUE);
7257 return FAIL;
7260 *arg = skipwhite(*arg + 1);
7261 if (evaluate)
7263 rettv->v_type = VAR_DICT;
7264 rettv->vval.v_dict = d;
7265 ++d->dv_refcount;
7268 return OK;
7272 * Return a string with the string representation of a variable.
7273 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7274 * "numbuf" is used for a number.
7275 * Does not put quotes around strings, as ":echo" displays values.
7276 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7277 * May return NULL.
7279 static char_u *
7280 echo_string(tv, tofree, numbuf, copyID)
7281 typval_T *tv;
7282 char_u **tofree;
7283 char_u *numbuf;
7284 int copyID;
7286 static int recurse = 0;
7287 char_u *r = NULL;
7289 if (recurse >= DICT_MAXNEST)
7291 EMSG(_("E724: variable nested too deep for displaying"));
7292 *tofree = NULL;
7293 return NULL;
7295 ++recurse;
7297 switch (tv->v_type)
7299 case VAR_FUNC:
7300 *tofree = NULL;
7301 r = tv->vval.v_string;
7302 break;
7304 case VAR_LIST:
7305 if (tv->vval.v_list == NULL)
7307 *tofree = NULL;
7308 r = NULL;
7310 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7312 *tofree = NULL;
7313 r = (char_u *)"[...]";
7315 else
7317 tv->vval.v_list->lv_copyID = copyID;
7318 *tofree = list2string(tv, copyID);
7319 r = *tofree;
7321 break;
7323 case VAR_DICT:
7324 if (tv->vval.v_dict == NULL)
7326 *tofree = NULL;
7327 r = NULL;
7329 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7331 *tofree = NULL;
7332 r = (char_u *)"{...}";
7334 else
7336 tv->vval.v_dict->dv_copyID = copyID;
7337 *tofree = dict2string(tv, copyID);
7338 r = *tofree;
7340 break;
7342 case VAR_STRING:
7343 case VAR_NUMBER:
7344 *tofree = NULL;
7345 r = get_tv_string_buf(tv, numbuf);
7346 break;
7348 #ifdef FEAT_FLOAT
7349 case VAR_FLOAT:
7350 *tofree = NULL;
7351 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7352 r = numbuf;
7353 break;
7354 #endif
7356 default:
7357 EMSG2(_(e_intern2), "echo_string()");
7358 *tofree = NULL;
7361 --recurse;
7362 return r;
7366 * Return a string with the string representation of a variable.
7367 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7368 * "numbuf" is used for a number.
7369 * Puts quotes around strings, so that they can be parsed back by eval().
7370 * May return NULL.
7372 static char_u *
7373 tv2string(tv, tofree, numbuf, copyID)
7374 typval_T *tv;
7375 char_u **tofree;
7376 char_u *numbuf;
7377 int copyID;
7379 switch (tv->v_type)
7381 case VAR_FUNC:
7382 *tofree = string_quote(tv->vval.v_string, TRUE);
7383 return *tofree;
7384 case VAR_STRING:
7385 *tofree = string_quote(tv->vval.v_string, FALSE);
7386 return *tofree;
7387 #ifdef FEAT_FLOAT
7388 case VAR_FLOAT:
7389 *tofree = NULL;
7390 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7391 return numbuf;
7392 #endif
7393 case VAR_NUMBER:
7394 case VAR_LIST:
7395 case VAR_DICT:
7396 break;
7397 default:
7398 EMSG2(_(e_intern2), "tv2string()");
7400 return echo_string(tv, tofree, numbuf, copyID);
7404 * Return string "str" in ' quotes, doubling ' characters.
7405 * If "str" is NULL an empty string is assumed.
7406 * If "function" is TRUE make it function('string').
7408 static char_u *
7409 string_quote(str, function)
7410 char_u *str;
7411 int function;
7413 unsigned len;
7414 char_u *p, *r, *s;
7416 len = (function ? 13 : 3);
7417 if (str != NULL)
7419 len += (unsigned)STRLEN(str);
7420 for (p = str; *p != NUL; mb_ptr_adv(p))
7421 if (*p == '\'')
7422 ++len;
7424 s = r = alloc(len);
7425 if (r != NULL)
7427 if (function)
7429 STRCPY(r, "function('");
7430 r += 10;
7432 else
7433 *r++ = '\'';
7434 if (str != NULL)
7435 for (p = str; *p != NUL; )
7437 if (*p == '\'')
7438 *r++ = '\'';
7439 MB_COPY_CHAR(p, r);
7441 *r++ = '\'';
7442 if (function)
7443 *r++ = ')';
7444 *r++ = NUL;
7446 return s;
7449 #ifdef FEAT_FLOAT
7451 * Convert the string "text" to a floating point number.
7452 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7453 * this always uses a decimal point.
7454 * Returns the length of the text that was consumed.
7456 static int
7457 string2float(text, value)
7458 char_u *text;
7459 float_T *value; /* result stored here */
7461 char *s = (char *)text;
7462 float_T f;
7464 f = strtod(s, &s);
7465 *value = f;
7466 return (int)((char_u *)s - text);
7468 #endif
7471 * Get the value of an environment variable.
7472 * "arg" is pointing to the '$'. It is advanced to after the name.
7473 * If the environment variable was not set, silently assume it is empty.
7474 * Always return OK.
7476 static int
7477 get_env_tv(arg, rettv, evaluate)
7478 char_u **arg;
7479 typval_T *rettv;
7480 int evaluate;
7482 char_u *string = NULL;
7483 int len;
7484 int cc;
7485 char_u *name;
7486 int mustfree = FALSE;
7488 ++*arg;
7489 name = *arg;
7490 len = get_env_len(arg);
7491 if (evaluate)
7493 if (len != 0)
7495 cc = name[len];
7496 name[len] = NUL;
7497 /* first try vim_getenv(), fast for normal environment vars */
7498 string = vim_getenv(name, &mustfree);
7499 if (string != NULL && *string != NUL)
7501 if (!mustfree)
7502 string = vim_strsave(string);
7504 else
7506 if (mustfree)
7507 vim_free(string);
7509 /* next try expanding things like $VIM and ${HOME} */
7510 string = expand_env_save(name - 1);
7511 if (string != NULL && *string == '$')
7513 vim_free(string);
7514 string = NULL;
7517 name[len] = cc;
7519 rettv->v_type = VAR_STRING;
7520 rettv->vval.v_string = string;
7523 return OK;
7527 * Array with names and number of arguments of all internal functions
7528 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7530 static struct fst
7532 char *f_name; /* function name */
7533 char f_min_argc; /* minimal number of arguments */
7534 char f_max_argc; /* maximal number of arguments */
7535 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7536 /* implementation of function */
7537 } functions[] =
7539 #ifdef FEAT_FLOAT
7540 {"abs", 1, 1, f_abs},
7541 #endif
7542 {"add", 2, 2, f_add},
7543 {"append", 2, 2, f_append},
7544 {"argc", 0, 0, f_argc},
7545 {"argidx", 0, 0, f_argidx},
7546 {"argv", 0, 1, f_argv},
7547 #ifdef FEAT_FLOAT
7548 {"atan", 1, 1, f_atan},
7549 #endif
7550 {"browse", 4, 4, f_browse},
7551 {"browsedir", 2, 2, f_browsedir},
7552 {"bufexists", 1, 1, f_bufexists},
7553 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7554 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7555 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7556 {"buflisted", 1, 1, f_buflisted},
7557 {"bufloaded", 1, 1, f_bufloaded},
7558 {"bufname", 1, 1, f_bufname},
7559 {"bufnr", 1, 2, f_bufnr},
7560 {"bufwinnr", 1, 1, f_bufwinnr},
7561 {"byte2line", 1, 1, f_byte2line},
7562 {"byteidx", 2, 2, f_byteidx},
7563 {"call", 2, 3, f_call},
7564 #ifdef FEAT_FLOAT
7565 {"ceil", 1, 1, f_ceil},
7566 #endif
7567 {"changenr", 0, 0, f_changenr},
7568 {"char2nr", 1, 1, f_char2nr},
7569 {"cindent", 1, 1, f_cindent},
7570 {"clearmatches", 0, 0, f_clearmatches},
7571 {"col", 1, 1, f_col},
7572 #if defined(FEAT_INS_EXPAND)
7573 {"complete", 2, 2, f_complete},
7574 {"complete_add", 1, 1, f_complete_add},
7575 {"complete_check", 0, 0, f_complete_check},
7576 #endif
7577 {"confirm", 1, 4, f_confirm},
7578 {"copy", 1, 1, f_copy},
7579 #ifdef FEAT_FLOAT
7580 {"cos", 1, 1, f_cos},
7581 #endif
7582 {"count", 2, 4, f_count},
7583 {"cscope_connection",0,3, f_cscope_connection},
7584 {"cursor", 1, 3, f_cursor},
7585 {"deepcopy", 1, 2, f_deepcopy},
7586 {"delete", 1, 1, f_delete},
7587 {"did_filetype", 0, 0, f_did_filetype},
7588 {"diff_filler", 1, 1, f_diff_filler},
7589 {"diff_hlID", 2, 2, f_diff_hlID},
7590 {"empty", 1, 1, f_empty},
7591 {"escape", 2, 2, f_escape},
7592 {"eval", 1, 1, f_eval},
7593 {"eventhandler", 0, 0, f_eventhandler},
7594 {"executable", 1, 1, f_executable},
7595 {"exists", 1, 1, f_exists},
7596 {"expand", 1, 2, f_expand},
7597 {"extend", 2, 3, f_extend},
7598 {"feedkeys", 1, 2, f_feedkeys},
7599 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7600 {"filereadable", 1, 1, f_filereadable},
7601 {"filewritable", 1, 1, f_filewritable},
7602 {"filter", 2, 2, f_filter},
7603 {"finddir", 1, 3, f_finddir},
7604 {"findfile", 1, 3, f_findfile},
7605 #ifdef FEAT_FLOAT
7606 {"float2nr", 1, 1, f_float2nr},
7607 {"floor", 1, 1, f_floor},
7608 #endif
7609 {"fnameescape", 1, 1, f_fnameescape},
7610 {"fnamemodify", 2, 2, f_fnamemodify},
7611 {"foldclosed", 1, 1, f_foldclosed},
7612 {"foldclosedend", 1, 1, f_foldclosedend},
7613 {"foldlevel", 1, 1, f_foldlevel},
7614 {"foldtext", 0, 0, f_foldtext},
7615 {"foldtextresult", 1, 1, f_foldtextresult},
7616 {"foreground", 0, 0, f_foreground},
7617 {"function", 1, 1, f_function},
7618 {"garbagecollect", 0, 1, f_garbagecollect},
7619 {"get", 2, 3, f_get},
7620 {"getbufline", 2, 3, f_getbufline},
7621 {"getbufvar", 2, 2, f_getbufvar},
7622 {"getchar", 0, 1, f_getchar},
7623 {"getcharmod", 0, 0, f_getcharmod},
7624 {"getcmdline", 0, 0, f_getcmdline},
7625 {"getcmdpos", 0, 0, f_getcmdpos},
7626 {"getcmdtype", 0, 0, f_getcmdtype},
7627 {"getcwd", 0, 0, f_getcwd},
7628 {"getfontname", 0, 1, f_getfontname},
7629 {"getfperm", 1, 1, f_getfperm},
7630 {"getfsize", 1, 1, f_getfsize},
7631 {"getftime", 1, 1, f_getftime},
7632 {"getftype", 1, 1, f_getftype},
7633 {"getline", 1, 2, f_getline},
7634 {"getloclist", 1, 1, f_getqflist},
7635 {"getmatches", 0, 0, f_getmatches},
7636 {"getpid", 0, 0, f_getpid},
7637 {"getpos", 1, 1, f_getpos},
7638 {"getqflist", 0, 0, f_getqflist},
7639 {"getreg", 0, 2, f_getreg},
7640 {"getregtype", 0, 1, f_getregtype},
7641 {"gettabwinvar", 3, 3, f_gettabwinvar},
7642 {"getwinposx", 0, 0, f_getwinposx},
7643 {"getwinposy", 0, 0, f_getwinposy},
7644 {"getwinvar", 2, 2, f_getwinvar},
7645 {"glob", 1, 2, f_glob},
7646 {"globpath", 2, 3, f_globpath},
7647 {"has", 1, 1, f_has},
7648 {"has_key", 2, 2, f_has_key},
7649 {"haslocaldir", 0, 0, f_haslocaldir},
7650 {"hasmapto", 1, 3, f_hasmapto},
7651 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7652 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7653 {"histadd", 2, 2, f_histadd},
7654 {"histdel", 1, 2, f_histdel},
7655 {"histget", 1, 2, f_histget},
7656 {"histnr", 1, 1, f_histnr},
7657 {"hlID", 1, 1, f_hlID},
7658 {"hlexists", 1, 1, f_hlexists},
7659 {"hostname", 0, 0, f_hostname},
7660 {"iconv", 3, 3, f_iconv},
7661 {"indent", 1, 1, f_indent},
7662 {"index", 2, 4, f_index},
7663 {"input", 1, 3, f_input},
7664 {"inputdialog", 1, 3, f_inputdialog},
7665 {"inputlist", 1, 1, f_inputlist},
7666 {"inputrestore", 0, 0, f_inputrestore},
7667 {"inputsave", 0, 0, f_inputsave},
7668 {"inputsecret", 1, 2, f_inputsecret},
7669 {"insert", 2, 3, f_insert},
7670 {"isdirectory", 1, 1, f_isdirectory},
7671 {"islocked", 1, 1, f_islocked},
7672 {"items", 1, 1, f_items},
7673 {"join", 1, 2, f_join},
7674 {"keys", 1, 1, f_keys},
7675 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7676 {"len", 1, 1, f_len},
7677 {"libcall", 3, 3, f_libcall},
7678 {"libcallnr", 3, 3, f_libcallnr},
7679 {"line", 1, 1, f_line},
7680 {"line2byte", 1, 1, f_line2byte},
7681 {"lispindent", 1, 1, f_lispindent},
7682 {"localtime", 0, 0, f_localtime},
7683 #ifdef FEAT_FLOAT
7684 {"log10", 1, 1, f_log10},
7685 #endif
7686 {"map", 2, 2, f_map},
7687 {"maparg", 1, 3, f_maparg},
7688 {"mapcheck", 1, 3, f_mapcheck},
7689 {"match", 2, 4, f_match},
7690 {"matchadd", 2, 4, f_matchadd},
7691 {"matcharg", 1, 1, f_matcharg},
7692 {"matchdelete", 1, 1, f_matchdelete},
7693 {"matchend", 2, 4, f_matchend},
7694 {"matchlist", 2, 4, f_matchlist},
7695 {"matchstr", 2, 4, f_matchstr},
7696 {"max", 1, 1, f_max},
7697 {"min", 1, 1, f_min},
7698 #ifdef vim_mkdir
7699 {"mkdir", 1, 3, f_mkdir},
7700 #endif
7701 {"mode", 0, 1, f_mode},
7702 {"nextnonblank", 1, 1, f_nextnonblank},
7703 {"nr2char", 1, 1, f_nr2char},
7704 {"pathshorten", 1, 1, f_pathshorten},
7705 #ifdef FEAT_FLOAT
7706 {"pow", 2, 2, f_pow},
7707 #endif
7708 {"prevnonblank", 1, 1, f_prevnonblank},
7709 {"printf", 2, 19, f_printf},
7710 {"pumvisible", 0, 0, f_pumvisible},
7711 {"range", 1, 3, f_range},
7712 {"readfile", 1, 3, f_readfile},
7713 {"reltime", 0, 2, f_reltime},
7714 {"reltimestr", 1, 1, f_reltimestr},
7715 {"remote_expr", 2, 3, f_remote_expr},
7716 {"remote_foreground", 1, 1, f_remote_foreground},
7717 {"remote_peek", 1, 2, f_remote_peek},
7718 {"remote_read", 1, 1, f_remote_read},
7719 {"remote_send", 2, 3, f_remote_send},
7720 {"remove", 2, 3, f_remove},
7721 {"rename", 2, 2, f_rename},
7722 {"repeat", 2, 2, f_repeat},
7723 {"resolve", 1, 1, f_resolve},
7724 {"reverse", 1, 1, f_reverse},
7725 #ifdef FEAT_FLOAT
7726 {"round", 1, 1, f_round},
7727 #endif
7728 {"search", 1, 4, f_search},
7729 {"searchdecl", 1, 3, f_searchdecl},
7730 {"searchpair", 3, 7, f_searchpair},
7731 {"searchpairpos", 3, 7, f_searchpairpos},
7732 {"searchpos", 1, 4, f_searchpos},
7733 {"server2client", 2, 2, f_server2client},
7734 {"serverlist", 0, 0, f_serverlist},
7735 {"setbufvar", 3, 3, f_setbufvar},
7736 {"setcmdpos", 1, 1, f_setcmdpos},
7737 {"setline", 2, 2, f_setline},
7738 {"setloclist", 2, 3, f_setloclist},
7739 {"setmatches", 1, 1, f_setmatches},
7740 {"setpos", 2, 2, f_setpos},
7741 {"setqflist", 1, 2, f_setqflist},
7742 {"setreg", 2, 3, f_setreg},
7743 {"settabwinvar", 4, 4, f_settabwinvar},
7744 {"setwinvar", 3, 3, f_setwinvar},
7745 {"shellescape", 1, 2, f_shellescape},
7746 {"simplify", 1, 1, f_simplify},
7747 #ifdef FEAT_FLOAT
7748 {"sin", 1, 1, f_sin},
7749 #endif
7750 {"sort", 1, 2, f_sort},
7751 {"soundfold", 1, 1, f_soundfold},
7752 {"spellbadword", 0, 1, f_spellbadword},
7753 {"spellsuggest", 1, 3, f_spellsuggest},
7754 {"split", 1, 3, f_split},
7755 #ifdef FEAT_FLOAT
7756 {"sqrt", 1, 1, f_sqrt},
7757 {"str2float", 1, 1, f_str2float},
7758 #endif
7759 {"str2nr", 1, 2, f_str2nr},
7760 #ifdef HAVE_STRFTIME
7761 {"strftime", 1, 2, f_strftime},
7762 #endif
7763 {"stridx", 2, 3, f_stridx},
7764 {"string", 1, 1, f_string},
7765 {"strlen", 1, 1, f_strlen},
7766 {"strpart", 2, 3, f_strpart},
7767 {"strridx", 2, 3, f_strridx},
7768 {"strtrans", 1, 1, f_strtrans},
7769 {"submatch", 1, 1, f_submatch},
7770 {"substitute", 4, 4, f_substitute},
7771 {"synID", 3, 3, f_synID},
7772 {"synIDattr", 2, 3, f_synIDattr},
7773 {"synIDtrans", 1, 1, f_synIDtrans},
7774 {"synstack", 2, 2, f_synstack},
7775 {"system", 1, 2, f_system},
7776 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7777 {"tabpagenr", 0, 1, f_tabpagenr},
7778 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7779 {"tagfiles", 0, 0, f_tagfiles},
7780 {"taglist", 1, 1, f_taglist},
7781 {"tempname", 0, 0, f_tempname},
7782 {"test", 1, 1, f_test},
7783 {"tolower", 1, 1, f_tolower},
7784 {"toupper", 1, 1, f_toupper},
7785 {"tr", 3, 3, f_tr},
7786 #ifdef FEAT_FLOAT
7787 {"trunc", 1, 1, f_trunc},
7788 #endif
7789 {"type", 1, 1, f_type},
7790 {"values", 1, 1, f_values},
7791 {"virtcol", 1, 1, f_virtcol},
7792 {"visualmode", 0, 1, f_visualmode},
7793 {"winbufnr", 1, 1, f_winbufnr},
7794 {"wincol", 0, 0, f_wincol},
7795 {"winheight", 1, 1, f_winheight},
7796 {"winline", 0, 0, f_winline},
7797 {"winnr", 0, 1, f_winnr},
7798 {"winrestcmd", 0, 0, f_winrestcmd},
7799 {"winrestview", 1, 1, f_winrestview},
7800 {"winsaveview", 0, 0, f_winsaveview},
7801 {"winwidth", 1, 1, f_winwidth},
7802 {"writefile", 2, 3, f_writefile},
7805 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7808 * Function given to ExpandGeneric() to obtain the list of internal
7809 * or user defined function names.
7811 char_u *
7812 get_function_name(xp, idx)
7813 expand_T *xp;
7814 int idx;
7816 static int intidx = -1;
7817 char_u *name;
7819 if (idx == 0)
7820 intidx = -1;
7821 if (intidx < 0)
7823 name = get_user_func_name(xp, idx);
7824 if (name != NULL)
7825 return name;
7827 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7829 STRCPY(IObuff, functions[intidx].f_name);
7830 STRCAT(IObuff, "(");
7831 if (functions[intidx].f_max_argc == 0)
7832 STRCAT(IObuff, ")");
7833 return IObuff;
7836 return NULL;
7840 * Function given to ExpandGeneric() to obtain the list of internal or
7841 * user defined variable or function names.
7843 char_u *
7844 get_expr_name(xp, idx)
7845 expand_T *xp;
7846 int idx;
7848 static int intidx = -1;
7849 char_u *name;
7851 if (idx == 0)
7852 intidx = -1;
7853 if (intidx < 0)
7855 name = get_function_name(xp, idx);
7856 if (name != NULL)
7857 return name;
7859 return get_user_var_name(xp, ++intidx);
7862 #endif /* FEAT_CMDL_COMPL */
7865 * Find internal function in table above.
7866 * Return index, or -1 if not found
7868 static int
7869 find_internal_func(name)
7870 char_u *name; /* name of the function */
7872 int first = 0;
7873 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7874 int cmp;
7875 int x;
7878 * Find the function name in the table. Binary search.
7880 while (first <= last)
7882 x = first + ((unsigned)(last - first) >> 1);
7883 cmp = STRCMP(name, functions[x].f_name);
7884 if (cmp < 0)
7885 last = x - 1;
7886 else if (cmp > 0)
7887 first = x + 1;
7888 else
7889 return x;
7891 return -1;
7895 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7896 * name it contains, otherwise return "name".
7898 static char_u *
7899 deref_func_name(name, lenp)
7900 char_u *name;
7901 int *lenp;
7903 dictitem_T *v;
7904 int cc;
7906 cc = name[*lenp];
7907 name[*lenp] = NUL;
7908 v = find_var(name, NULL);
7909 name[*lenp] = cc;
7910 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7912 if (v->di_tv.vval.v_string == NULL)
7914 *lenp = 0;
7915 return (char_u *)""; /* just in case */
7917 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7918 return v->di_tv.vval.v_string;
7921 return name;
7925 * Allocate a variable for the result of a function.
7926 * Return OK or FAIL.
7928 static int
7929 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7930 evaluate, selfdict)
7931 char_u *name; /* name of the function */
7932 int len; /* length of "name" */
7933 typval_T *rettv;
7934 char_u **arg; /* argument, pointing to the '(' */
7935 linenr_T firstline; /* first line of range */
7936 linenr_T lastline; /* last line of range */
7937 int *doesrange; /* return: function handled range */
7938 int evaluate;
7939 dict_T *selfdict; /* Dictionary for "self" */
7941 char_u *argp;
7942 int ret = OK;
7943 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7944 int argcount = 0; /* number of arguments found */
7947 * Get the arguments.
7949 argp = *arg;
7950 while (argcount < MAX_FUNC_ARGS)
7952 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7953 if (*argp == ')' || *argp == ',' || *argp == NUL)
7954 break;
7955 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7957 ret = FAIL;
7958 break;
7960 ++argcount;
7961 if (*argp != ',')
7962 break;
7964 if (*argp == ')')
7965 ++argp;
7966 else
7967 ret = FAIL;
7969 if (ret == OK)
7970 ret = call_func(name, len, rettv, argcount, argvars,
7971 firstline, lastline, doesrange, evaluate, selfdict);
7972 else if (!aborting())
7974 if (argcount == MAX_FUNC_ARGS)
7975 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
7976 else
7977 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
7980 while (--argcount >= 0)
7981 clear_tv(&argvars[argcount]);
7983 *arg = skipwhite(argp);
7984 return ret;
7989 * Call a function with its resolved parameters
7990 * Return OK when the function can't be called, FAIL otherwise.
7991 * Also returns OK when an error was encountered while executing the function.
7993 static int
7994 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7995 doesrange, evaluate, selfdict)
7996 char_u *name; /* name of the function */
7997 int len; /* length of "name" */
7998 typval_T *rettv; /* return value goes here */
7999 int argcount; /* number of "argvars" */
8000 typval_T *argvars; /* vars for arguments, must have "argcount"
8001 PLUS ONE elements! */
8002 linenr_T firstline; /* first line of range */
8003 linenr_T lastline; /* last line of range */
8004 int *doesrange; /* return: function handled range */
8005 int evaluate;
8006 dict_T *selfdict; /* Dictionary for "self" */
8008 int ret = FAIL;
8009 #define ERROR_UNKNOWN 0
8010 #define ERROR_TOOMANY 1
8011 #define ERROR_TOOFEW 2
8012 #define ERROR_SCRIPT 3
8013 #define ERROR_DICT 4
8014 #define ERROR_NONE 5
8015 #define ERROR_OTHER 6
8016 int error = ERROR_NONE;
8017 int i;
8018 int llen;
8019 ufunc_T *fp;
8020 int cc;
8021 #define FLEN_FIXED 40
8022 char_u fname_buf[FLEN_FIXED + 1];
8023 char_u *fname;
8026 * In a script change <SID>name() and s:name() to K_SNR 123_name().
8027 * Change <SNR>123_name() to K_SNR 123_name().
8028 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
8030 cc = name[len];
8031 name[len] = NUL;
8032 llen = eval_fname_script(name);
8033 if (llen > 0)
8035 fname_buf[0] = K_SPECIAL;
8036 fname_buf[1] = KS_EXTRA;
8037 fname_buf[2] = (int)KE_SNR;
8038 i = 3;
8039 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
8041 if (current_SID <= 0)
8042 error = ERROR_SCRIPT;
8043 else
8045 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
8046 i = (int)STRLEN(fname_buf);
8049 if (i + STRLEN(name + llen) < FLEN_FIXED)
8051 STRCPY(fname_buf + i, name + llen);
8052 fname = fname_buf;
8054 else
8056 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8057 if (fname == NULL)
8058 error = ERROR_OTHER;
8059 else
8061 mch_memmove(fname, fname_buf, (size_t)i);
8062 STRCPY(fname + i, name + llen);
8066 else
8067 fname = name;
8069 *doesrange = FALSE;
8072 /* execute the function if no errors detected and executing */
8073 if (evaluate && error == ERROR_NONE)
8075 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */
8076 rettv->vval.v_number = 0;
8077 error = ERROR_UNKNOWN;
8079 if (!builtin_function(fname))
8082 * User defined function.
8084 fp = find_func(fname);
8086 #ifdef FEAT_AUTOCMD
8087 /* Trigger FuncUndefined event, may load the function. */
8088 if (fp == NULL
8089 && apply_autocmds(EVENT_FUNCUNDEFINED,
8090 fname, fname, TRUE, NULL)
8091 && !aborting())
8093 /* executed an autocommand, search for the function again */
8094 fp = find_func(fname);
8096 #endif
8097 /* Try loading a package. */
8098 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8100 /* loaded a package, search for the function again */
8101 fp = find_func(fname);
8104 if (fp != NULL)
8106 if (fp->uf_flags & FC_RANGE)
8107 *doesrange = TRUE;
8108 if (argcount < fp->uf_args.ga_len)
8109 error = ERROR_TOOFEW;
8110 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8111 error = ERROR_TOOMANY;
8112 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8113 error = ERROR_DICT;
8114 else
8117 * Call the user function.
8118 * Save and restore search patterns, script variables and
8119 * redo buffer.
8121 save_search_patterns();
8122 saveRedobuff();
8123 ++fp->uf_calls;
8124 call_user_func(fp, argcount, argvars, rettv,
8125 firstline, lastline,
8126 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8127 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8128 && fp->uf_refcount <= 0)
8129 /* Function was unreferenced while being used, free it
8130 * now. */
8131 func_free(fp);
8132 restoreRedobuff();
8133 restore_search_patterns();
8134 error = ERROR_NONE;
8138 else
8141 * Find the function name in the table, call its implementation.
8143 i = find_internal_func(fname);
8144 if (i >= 0)
8146 if (argcount < functions[i].f_min_argc)
8147 error = ERROR_TOOFEW;
8148 else if (argcount > functions[i].f_max_argc)
8149 error = ERROR_TOOMANY;
8150 else
8152 argvars[argcount].v_type = VAR_UNKNOWN;
8153 functions[i].f_func(argvars, rettv);
8154 error = ERROR_NONE;
8159 * The function call (or "FuncUndefined" autocommand sequence) might
8160 * have been aborted by an error, an interrupt, or an explicitly thrown
8161 * exception that has not been caught so far. This situation can be
8162 * tested for by calling aborting(). For an error in an internal
8163 * function or for the "E132" error in call_user_func(), however, the
8164 * throw point at which the "force_abort" flag (temporarily reset by
8165 * emsg()) is normally updated has not been reached yet. We need to
8166 * update that flag first to make aborting() reliable.
8168 update_force_abort();
8170 if (error == ERROR_NONE)
8171 ret = OK;
8174 * Report an error unless the argument evaluation or function call has been
8175 * cancelled due to an aborting error, an interrupt, or an exception.
8177 if (!aborting())
8179 switch (error)
8181 case ERROR_UNKNOWN:
8182 emsg_funcname(N_("E117: Unknown function: %s"), name);
8183 break;
8184 case ERROR_TOOMANY:
8185 emsg_funcname(e_toomanyarg, name);
8186 break;
8187 case ERROR_TOOFEW:
8188 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8189 name);
8190 break;
8191 case ERROR_SCRIPT:
8192 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8193 name);
8194 break;
8195 case ERROR_DICT:
8196 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8197 name);
8198 break;
8202 name[len] = cc;
8203 if (fname != name && fname != fname_buf)
8204 vim_free(fname);
8206 return ret;
8210 * Give an error message with a function name. Handle <SNR> things.
8211 * "ermsg" is to be passed without translation, use N_() instead of _().
8213 static void
8214 emsg_funcname(ermsg, name)
8215 char *ermsg;
8216 char_u *name;
8218 char_u *p;
8220 if (*name == K_SPECIAL)
8221 p = concat_str((char_u *)"<SNR>", name + 3);
8222 else
8223 p = name;
8224 EMSG2(_(ermsg), p);
8225 if (p != name)
8226 vim_free(p);
8230 * Return TRUE for a non-zero Number and a non-empty String.
8232 static int
8233 non_zero_arg(argvars)
8234 typval_T *argvars;
8236 return ((argvars[0].v_type == VAR_NUMBER
8237 && argvars[0].vval.v_number != 0)
8238 || (argvars[0].v_type == VAR_STRING
8239 && argvars[0].vval.v_string != NULL
8240 && *argvars[0].vval.v_string != NUL));
8243 /*********************************************
8244 * Implementation of the built-in functions
8247 #ifdef FEAT_FLOAT
8249 * "abs(expr)" function
8251 static void
8252 f_abs(argvars, rettv)
8253 typval_T *argvars;
8254 typval_T *rettv;
8256 if (argvars[0].v_type == VAR_FLOAT)
8258 rettv->v_type = VAR_FLOAT;
8259 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8261 else
8263 varnumber_T n;
8264 int error = FALSE;
8266 n = get_tv_number_chk(&argvars[0], &error);
8267 if (error)
8268 rettv->vval.v_number = -1;
8269 else if (n > 0)
8270 rettv->vval.v_number = n;
8271 else
8272 rettv->vval.v_number = -n;
8275 #endif
8278 * "add(list, item)" function
8280 static void
8281 f_add(argvars, rettv)
8282 typval_T *argvars;
8283 typval_T *rettv;
8285 list_T *l;
8287 rettv->vval.v_number = 1; /* Default: Failed */
8288 if (argvars[0].v_type == VAR_LIST)
8290 if ((l = argvars[0].vval.v_list) != NULL
8291 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8292 && list_append_tv(l, &argvars[1]) == OK)
8293 copy_tv(&argvars[0], rettv);
8295 else
8296 EMSG(_(e_listreq));
8300 * "append(lnum, string/list)" function
8302 static void
8303 f_append(argvars, rettv)
8304 typval_T *argvars;
8305 typval_T *rettv;
8307 long lnum;
8308 char_u *line;
8309 list_T *l = NULL;
8310 listitem_T *li = NULL;
8311 typval_T *tv;
8312 long added = 0;
8314 lnum = get_tv_lnum(argvars);
8315 if (lnum >= 0
8316 && lnum <= curbuf->b_ml.ml_line_count
8317 && u_save(lnum, lnum + 1) == OK)
8319 if (argvars[1].v_type == VAR_LIST)
8321 l = argvars[1].vval.v_list;
8322 if (l == NULL)
8323 return;
8324 li = l->lv_first;
8326 for (;;)
8328 if (l == NULL)
8329 tv = &argvars[1]; /* append a string */
8330 else if (li == NULL)
8331 break; /* end of list */
8332 else
8333 tv = &li->li_tv; /* append item from list */
8334 line = get_tv_string_chk(tv);
8335 if (line == NULL) /* type error */
8337 rettv->vval.v_number = 1; /* Failed */
8338 break;
8340 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8341 ++added;
8342 if (l == NULL)
8343 break;
8344 li = li->li_next;
8347 appended_lines_mark(lnum, added);
8348 if (curwin->w_cursor.lnum > lnum)
8349 curwin->w_cursor.lnum += added;
8351 else
8352 rettv->vval.v_number = 1; /* Failed */
8356 * "argc()" function
8358 static void
8359 f_argc(argvars, rettv)
8360 typval_T *argvars UNUSED;
8361 typval_T *rettv;
8363 rettv->vval.v_number = ARGCOUNT;
8367 * "argidx()" function
8369 static void
8370 f_argidx(argvars, rettv)
8371 typval_T *argvars UNUSED;
8372 typval_T *rettv;
8374 rettv->vval.v_number = curwin->w_arg_idx;
8378 * "argv(nr)" function
8380 static void
8381 f_argv(argvars, rettv)
8382 typval_T *argvars;
8383 typval_T *rettv;
8385 int idx;
8387 if (argvars[0].v_type != VAR_UNKNOWN)
8389 idx = get_tv_number_chk(&argvars[0], NULL);
8390 if (idx >= 0 && idx < ARGCOUNT)
8391 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8392 else
8393 rettv->vval.v_string = NULL;
8394 rettv->v_type = VAR_STRING;
8396 else if (rettv_list_alloc(rettv) == OK)
8397 for (idx = 0; idx < ARGCOUNT; ++idx)
8398 list_append_string(rettv->vval.v_list,
8399 alist_name(&ARGLIST[idx]), -1);
8402 #ifdef FEAT_FLOAT
8403 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8406 * Get the float value of "argvars[0]" into "f".
8407 * Returns FAIL when the argument is not a Number or Float.
8409 static int
8410 get_float_arg(argvars, f)
8411 typval_T *argvars;
8412 float_T *f;
8414 if (argvars[0].v_type == VAR_FLOAT)
8416 *f = argvars[0].vval.v_float;
8417 return OK;
8419 if (argvars[0].v_type == VAR_NUMBER)
8421 *f = (float_T)argvars[0].vval.v_number;
8422 return OK;
8424 EMSG(_("E808: Number or Float required"));
8425 return FAIL;
8429 * "atan()" function
8431 static void
8432 f_atan(argvars, rettv)
8433 typval_T *argvars;
8434 typval_T *rettv;
8436 float_T f;
8438 rettv->v_type = VAR_FLOAT;
8439 if (get_float_arg(argvars, &f) == OK)
8440 rettv->vval.v_float = atan(f);
8441 else
8442 rettv->vval.v_float = 0.0;
8444 #endif
8447 * "browse(save, title, initdir, default)" function
8449 static void
8450 f_browse(argvars, rettv)
8451 typval_T *argvars UNUSED;
8452 typval_T *rettv;
8454 #ifdef FEAT_BROWSE
8455 int save;
8456 char_u *title;
8457 char_u *initdir;
8458 char_u *defname;
8459 char_u buf[NUMBUFLEN];
8460 char_u buf2[NUMBUFLEN];
8461 int error = FALSE;
8463 save = get_tv_number_chk(&argvars[0], &error);
8464 title = get_tv_string_chk(&argvars[1]);
8465 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8466 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8468 if (error || title == NULL || initdir == NULL || defname == NULL)
8469 rettv->vval.v_string = NULL;
8470 else
8471 rettv->vval.v_string =
8472 do_browse(save ? BROWSE_SAVE : 0,
8473 title, defname, NULL, initdir, NULL, curbuf);
8474 #else
8475 rettv->vval.v_string = NULL;
8476 #endif
8477 rettv->v_type = VAR_STRING;
8481 * "browsedir(title, initdir)" function
8483 static void
8484 f_browsedir(argvars, rettv)
8485 typval_T *argvars UNUSED;
8486 typval_T *rettv;
8488 #ifdef FEAT_BROWSE
8489 char_u *title;
8490 char_u *initdir;
8491 char_u buf[NUMBUFLEN];
8493 title = get_tv_string_chk(&argvars[0]);
8494 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8496 if (title == NULL || initdir == NULL)
8497 rettv->vval.v_string = NULL;
8498 else
8499 rettv->vval.v_string = do_browse(BROWSE_DIR,
8500 title, NULL, NULL, initdir, NULL, curbuf);
8501 #else
8502 rettv->vval.v_string = NULL;
8503 #endif
8504 rettv->v_type = VAR_STRING;
8507 static buf_T *find_buffer __ARGS((typval_T *avar));
8510 * Find a buffer by number or exact name.
8512 static buf_T *
8513 find_buffer(avar)
8514 typval_T *avar;
8516 buf_T *buf = NULL;
8518 if (avar->v_type == VAR_NUMBER)
8519 buf = buflist_findnr((int)avar->vval.v_number);
8520 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8522 buf = buflist_findname_exp(avar->vval.v_string);
8523 if (buf == NULL)
8525 /* No full path name match, try a match with a URL or a "nofile"
8526 * buffer, these don't use the full path. */
8527 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8528 if (buf->b_fname != NULL
8529 && (path_with_url(buf->b_fname)
8530 #ifdef FEAT_QUICKFIX
8531 || bt_nofile(buf)
8532 #endif
8534 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8535 break;
8538 return buf;
8542 * "bufexists(expr)" function
8544 static void
8545 f_bufexists(argvars, rettv)
8546 typval_T *argvars;
8547 typval_T *rettv;
8549 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8553 * "buflisted(expr)" function
8555 static void
8556 f_buflisted(argvars, rettv)
8557 typval_T *argvars;
8558 typval_T *rettv;
8560 buf_T *buf;
8562 buf = find_buffer(&argvars[0]);
8563 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8567 * "bufloaded(expr)" function
8569 static void
8570 f_bufloaded(argvars, rettv)
8571 typval_T *argvars;
8572 typval_T *rettv;
8574 buf_T *buf;
8576 buf = find_buffer(&argvars[0]);
8577 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8580 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8583 * Get buffer by number or pattern.
8585 static buf_T *
8586 get_buf_tv(tv)
8587 typval_T *tv;
8589 char_u *name = tv->vval.v_string;
8590 int save_magic;
8591 char_u *save_cpo;
8592 buf_T *buf;
8594 if (tv->v_type == VAR_NUMBER)
8595 return buflist_findnr((int)tv->vval.v_number);
8596 if (tv->v_type != VAR_STRING)
8597 return NULL;
8598 if (name == NULL || *name == NUL)
8599 return curbuf;
8600 if (name[0] == '$' && name[1] == NUL)
8601 return lastbuf;
8603 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8604 save_magic = p_magic;
8605 p_magic = TRUE;
8606 save_cpo = p_cpo;
8607 p_cpo = (char_u *)"";
8609 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8610 TRUE, FALSE));
8612 p_magic = save_magic;
8613 p_cpo = save_cpo;
8615 /* If not found, try expanding the name, like done for bufexists(). */
8616 if (buf == NULL)
8617 buf = find_buffer(tv);
8619 return buf;
8623 * "bufname(expr)" function
8625 static void
8626 f_bufname(argvars, rettv)
8627 typval_T *argvars;
8628 typval_T *rettv;
8630 buf_T *buf;
8632 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8633 ++emsg_off;
8634 buf = get_buf_tv(&argvars[0]);
8635 rettv->v_type = VAR_STRING;
8636 if (buf != NULL && buf->b_fname != NULL)
8637 rettv->vval.v_string = vim_strsave(buf->b_fname);
8638 else
8639 rettv->vval.v_string = NULL;
8640 --emsg_off;
8644 * "bufnr(expr)" function
8646 static void
8647 f_bufnr(argvars, rettv)
8648 typval_T *argvars;
8649 typval_T *rettv;
8651 buf_T *buf;
8652 int error = FALSE;
8653 char_u *name;
8655 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8656 ++emsg_off;
8657 buf = get_buf_tv(&argvars[0]);
8658 --emsg_off;
8660 /* If the buffer isn't found and the second argument is not zero create a
8661 * new buffer. */
8662 if (buf == NULL
8663 && argvars[1].v_type != VAR_UNKNOWN
8664 && get_tv_number_chk(&argvars[1], &error) != 0
8665 && !error
8666 && (name = get_tv_string_chk(&argvars[0])) != NULL
8667 && !error)
8668 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8670 if (buf != NULL)
8671 rettv->vval.v_number = buf->b_fnum;
8672 else
8673 rettv->vval.v_number = -1;
8677 * "bufwinnr(nr)" function
8679 static void
8680 f_bufwinnr(argvars, rettv)
8681 typval_T *argvars;
8682 typval_T *rettv;
8684 #ifdef FEAT_WINDOWS
8685 win_T *wp;
8686 int winnr = 0;
8687 #endif
8688 buf_T *buf;
8690 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8691 ++emsg_off;
8692 buf = get_buf_tv(&argvars[0]);
8693 #ifdef FEAT_WINDOWS
8694 for (wp = firstwin; wp; wp = wp->w_next)
8696 ++winnr;
8697 if (wp->w_buffer == buf)
8698 break;
8700 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8701 #else
8702 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8703 #endif
8704 --emsg_off;
8708 * "byte2line(byte)" function
8710 static void
8711 f_byte2line(argvars, rettv)
8712 typval_T *argvars UNUSED;
8713 typval_T *rettv;
8715 #ifndef FEAT_BYTEOFF
8716 rettv->vval.v_number = -1;
8717 #else
8718 long boff = 0;
8720 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8721 if (boff < 0)
8722 rettv->vval.v_number = -1;
8723 else
8724 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8725 (linenr_T)0, &boff);
8726 #endif
8730 * "byteidx()" function
8732 static void
8733 f_byteidx(argvars, rettv)
8734 typval_T *argvars;
8735 typval_T *rettv;
8737 #ifdef FEAT_MBYTE
8738 char_u *t;
8739 #endif
8740 char_u *str;
8741 long idx;
8743 str = get_tv_string_chk(&argvars[0]);
8744 idx = get_tv_number_chk(&argvars[1], NULL);
8745 rettv->vval.v_number = -1;
8746 if (str == NULL || idx < 0)
8747 return;
8749 #ifdef FEAT_MBYTE
8750 t = str;
8751 for ( ; idx > 0; idx--)
8753 if (*t == NUL) /* EOL reached */
8754 return;
8755 t += (*mb_ptr2len)(t);
8757 rettv->vval.v_number = (varnumber_T)(t - str);
8758 #else
8759 if ((size_t)idx <= STRLEN(str))
8760 rettv->vval.v_number = idx;
8761 #endif
8765 * "call(func, arglist)" function
8767 static void
8768 f_call(argvars, rettv)
8769 typval_T *argvars;
8770 typval_T *rettv;
8772 char_u *func;
8773 typval_T argv[MAX_FUNC_ARGS + 1];
8774 int argc = 0;
8775 listitem_T *item;
8776 int dummy;
8777 dict_T *selfdict = NULL;
8779 if (argvars[1].v_type != VAR_LIST)
8781 EMSG(_(e_listreq));
8782 return;
8784 if (argvars[1].vval.v_list == NULL)
8785 return;
8787 if (argvars[0].v_type == VAR_FUNC)
8788 func = argvars[0].vval.v_string;
8789 else
8790 func = get_tv_string(&argvars[0]);
8791 if (*func == NUL)
8792 return; /* type error or empty name */
8794 if (argvars[2].v_type != VAR_UNKNOWN)
8796 if (argvars[2].v_type != VAR_DICT)
8798 EMSG(_(e_dictreq));
8799 return;
8801 selfdict = argvars[2].vval.v_dict;
8804 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8805 item = item->li_next)
8807 if (argc == MAX_FUNC_ARGS)
8809 EMSG(_("E699: Too many arguments"));
8810 break;
8812 /* Make a copy of each argument. This is needed to be able to set
8813 * v_lock to VAR_FIXED in the copy without changing the original list.
8815 copy_tv(&item->li_tv, &argv[argc++]);
8818 if (item == NULL)
8819 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8820 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8821 &dummy, TRUE, selfdict);
8823 /* Free the arguments. */
8824 while (argc > 0)
8825 clear_tv(&argv[--argc]);
8828 #ifdef FEAT_FLOAT
8830 * "ceil({float})" function
8832 static void
8833 f_ceil(argvars, rettv)
8834 typval_T *argvars;
8835 typval_T *rettv;
8837 float_T f;
8839 rettv->v_type = VAR_FLOAT;
8840 if (get_float_arg(argvars, &f) == OK)
8841 rettv->vval.v_float = ceil(f);
8842 else
8843 rettv->vval.v_float = 0.0;
8845 #endif
8848 * "changenr()" function
8850 static void
8851 f_changenr(argvars, rettv)
8852 typval_T *argvars UNUSED;
8853 typval_T *rettv;
8855 rettv->vval.v_number = curbuf->b_u_seq_cur;
8859 * "char2nr(string)" function
8861 static void
8862 f_char2nr(argvars, rettv)
8863 typval_T *argvars;
8864 typval_T *rettv;
8866 #ifdef FEAT_MBYTE
8867 if (has_mbyte)
8868 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8869 else
8870 #endif
8871 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8875 * "cindent(lnum)" function
8877 static void
8878 f_cindent(argvars, rettv)
8879 typval_T *argvars;
8880 typval_T *rettv;
8882 #ifdef FEAT_CINDENT
8883 pos_T pos;
8884 linenr_T lnum;
8886 pos = curwin->w_cursor;
8887 lnum = get_tv_lnum(argvars);
8888 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8890 curwin->w_cursor.lnum = lnum;
8891 rettv->vval.v_number = get_c_indent();
8892 curwin->w_cursor = pos;
8894 else
8895 #endif
8896 rettv->vval.v_number = -1;
8900 * "clearmatches()" function
8902 static void
8903 f_clearmatches(argvars, rettv)
8904 typval_T *argvars UNUSED;
8905 typval_T *rettv UNUSED;
8907 #ifdef FEAT_SEARCH_EXTRA
8908 clear_matches(curwin);
8909 #endif
8913 * "col(string)" function
8915 static void
8916 f_col(argvars, rettv)
8917 typval_T *argvars;
8918 typval_T *rettv;
8920 colnr_T col = 0;
8921 pos_T *fp;
8922 int fnum = curbuf->b_fnum;
8924 fp = var2fpos(&argvars[0], FALSE, &fnum);
8925 if (fp != NULL && fnum == curbuf->b_fnum)
8927 if (fp->col == MAXCOL)
8929 /* '> can be MAXCOL, get the length of the line then */
8930 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8931 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8932 else
8933 col = MAXCOL;
8935 else
8937 col = fp->col + 1;
8938 #ifdef FEAT_VIRTUALEDIT
8939 /* col(".") when the cursor is on the NUL at the end of the line
8940 * because of "coladd" can be seen as an extra column. */
8941 if (virtual_active() && fp == &curwin->w_cursor)
8943 char_u *p = ml_get_cursor();
8945 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8946 curwin->w_virtcol - curwin->w_cursor.coladd))
8948 # ifdef FEAT_MBYTE
8949 int l;
8951 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8952 col += l;
8953 # else
8954 if (*p != NUL && p[1] == NUL)
8955 ++col;
8956 # endif
8959 #endif
8962 rettv->vval.v_number = col;
8965 #if defined(FEAT_INS_EXPAND)
8967 * "complete()" function
8969 static void
8970 f_complete(argvars, rettv)
8971 typval_T *argvars;
8972 typval_T *rettv UNUSED;
8974 int startcol;
8976 if ((State & INSERT) == 0)
8978 EMSG(_("E785: complete() can only be used in Insert mode"));
8979 return;
8982 /* Check for undo allowed here, because if something was already inserted
8983 * the line was already saved for undo and this check isn't done. */
8984 if (!undo_allowed())
8985 return;
8987 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8989 EMSG(_(e_invarg));
8990 return;
8993 startcol = get_tv_number_chk(&argvars[0], NULL);
8994 if (startcol <= 0)
8995 return;
8997 set_completion(startcol - 1, argvars[1].vval.v_list);
9001 * "complete_add()" function
9003 static void
9004 f_complete_add(argvars, rettv)
9005 typval_T *argvars;
9006 typval_T *rettv;
9008 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
9012 * "complete_check()" function
9014 static void
9015 f_complete_check(argvars, rettv)
9016 typval_T *argvars UNUSED;
9017 typval_T *rettv;
9019 int saved = RedrawingDisabled;
9021 RedrawingDisabled = 0;
9022 ins_compl_check_keys(0);
9023 rettv->vval.v_number = compl_interrupted;
9024 RedrawingDisabled = saved;
9026 #endif
9029 * "confirm(message, buttons[, default [, type]])" function
9031 static void
9032 f_confirm(argvars, rettv)
9033 typval_T *argvars UNUSED;
9034 typval_T *rettv UNUSED;
9036 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
9037 char_u *message;
9038 char_u *buttons = NULL;
9039 char_u buf[NUMBUFLEN];
9040 char_u buf2[NUMBUFLEN];
9041 int def = 1;
9042 int type = VIM_GENERIC;
9043 char_u *typestr;
9044 int error = FALSE;
9046 message = get_tv_string_chk(&argvars[0]);
9047 if (message == NULL)
9048 error = TRUE;
9049 if (argvars[1].v_type != VAR_UNKNOWN)
9051 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9052 if (buttons == NULL)
9053 error = TRUE;
9054 if (argvars[2].v_type != VAR_UNKNOWN)
9056 def = get_tv_number_chk(&argvars[2], &error);
9057 if (argvars[3].v_type != VAR_UNKNOWN)
9059 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9060 if (typestr == NULL)
9061 error = TRUE;
9062 else
9064 switch (TOUPPER_ASC(*typestr))
9066 case 'E': type = VIM_ERROR; break;
9067 case 'Q': type = VIM_QUESTION; break;
9068 case 'I': type = VIM_INFO; break;
9069 case 'W': type = VIM_WARNING; break;
9070 case 'G': type = VIM_GENERIC; break;
9077 if (buttons == NULL || *buttons == NUL)
9078 buttons = (char_u *)_("&Ok");
9080 if (!error)
9081 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9082 def, NULL);
9083 #endif
9087 * "copy()" function
9089 static void
9090 f_copy(argvars, rettv)
9091 typval_T *argvars;
9092 typval_T *rettv;
9094 item_copy(&argvars[0], rettv, FALSE, 0);
9097 #ifdef FEAT_FLOAT
9099 * "cos()" function
9101 static void
9102 f_cos(argvars, rettv)
9103 typval_T *argvars;
9104 typval_T *rettv;
9106 float_T f;
9108 rettv->v_type = VAR_FLOAT;
9109 if (get_float_arg(argvars, &f) == OK)
9110 rettv->vval.v_float = cos(f);
9111 else
9112 rettv->vval.v_float = 0.0;
9114 #endif
9117 * "count()" function
9119 static void
9120 f_count(argvars, rettv)
9121 typval_T *argvars;
9122 typval_T *rettv;
9124 long n = 0;
9125 int ic = FALSE;
9127 if (argvars[0].v_type == VAR_LIST)
9129 listitem_T *li;
9130 list_T *l;
9131 long idx;
9133 if ((l = argvars[0].vval.v_list) != NULL)
9135 li = l->lv_first;
9136 if (argvars[2].v_type != VAR_UNKNOWN)
9138 int error = FALSE;
9140 ic = get_tv_number_chk(&argvars[2], &error);
9141 if (argvars[3].v_type != VAR_UNKNOWN)
9143 idx = get_tv_number_chk(&argvars[3], &error);
9144 if (!error)
9146 li = list_find(l, idx);
9147 if (li == NULL)
9148 EMSGN(_(e_listidx), idx);
9151 if (error)
9152 li = NULL;
9155 for ( ; li != NULL; li = li->li_next)
9156 if (tv_equal(&li->li_tv, &argvars[1], ic))
9157 ++n;
9160 else if (argvars[0].v_type == VAR_DICT)
9162 int todo;
9163 dict_T *d;
9164 hashitem_T *hi;
9166 if ((d = argvars[0].vval.v_dict) != NULL)
9168 int error = FALSE;
9170 if (argvars[2].v_type != VAR_UNKNOWN)
9172 ic = get_tv_number_chk(&argvars[2], &error);
9173 if (argvars[3].v_type != VAR_UNKNOWN)
9174 EMSG(_(e_invarg));
9177 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9178 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9180 if (!HASHITEM_EMPTY(hi))
9182 --todo;
9183 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9184 ++n;
9189 else
9190 EMSG2(_(e_listdictarg), "count()");
9191 rettv->vval.v_number = n;
9195 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9197 * Checks the existence of a cscope connection.
9199 static void
9200 f_cscope_connection(argvars, rettv)
9201 typval_T *argvars UNUSED;
9202 typval_T *rettv UNUSED;
9204 #ifdef FEAT_CSCOPE
9205 int num = 0;
9206 char_u *dbpath = NULL;
9207 char_u *prepend = NULL;
9208 char_u buf[NUMBUFLEN];
9210 if (argvars[0].v_type != VAR_UNKNOWN
9211 && argvars[1].v_type != VAR_UNKNOWN)
9213 num = (int)get_tv_number(&argvars[0]);
9214 dbpath = get_tv_string(&argvars[1]);
9215 if (argvars[2].v_type != VAR_UNKNOWN)
9216 prepend = get_tv_string_buf(&argvars[2], buf);
9219 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9220 #endif
9224 * "cursor(lnum, col)" function
9226 * Moves the cursor to the specified line and column.
9227 * Returns 0 when the position could be set, -1 otherwise.
9229 static void
9230 f_cursor(argvars, rettv)
9231 typval_T *argvars;
9232 typval_T *rettv;
9234 long line, col;
9235 #ifdef FEAT_VIRTUALEDIT
9236 long coladd = 0;
9237 #endif
9239 rettv->vval.v_number = -1;
9240 if (argvars[1].v_type == VAR_UNKNOWN)
9242 pos_T pos;
9244 if (list2fpos(argvars, &pos, NULL) == FAIL)
9245 return;
9246 line = pos.lnum;
9247 col = pos.col;
9248 #ifdef FEAT_VIRTUALEDIT
9249 coladd = pos.coladd;
9250 #endif
9252 else
9254 line = get_tv_lnum(argvars);
9255 col = get_tv_number_chk(&argvars[1], NULL);
9256 #ifdef FEAT_VIRTUALEDIT
9257 if (argvars[2].v_type != VAR_UNKNOWN)
9258 coladd = get_tv_number_chk(&argvars[2], NULL);
9259 #endif
9261 if (line < 0 || col < 0
9262 #ifdef FEAT_VIRTUALEDIT
9263 || coladd < 0
9264 #endif
9266 return; /* type error; errmsg already given */
9267 if (line > 0)
9268 curwin->w_cursor.lnum = line;
9269 if (col > 0)
9270 curwin->w_cursor.col = col - 1;
9271 #ifdef FEAT_VIRTUALEDIT
9272 curwin->w_cursor.coladd = coladd;
9273 #endif
9275 /* Make sure the cursor is in a valid position. */
9276 check_cursor();
9277 #ifdef FEAT_MBYTE
9278 /* Correct cursor for multi-byte character. */
9279 if (has_mbyte)
9280 mb_adjust_cursor();
9281 #endif
9283 curwin->w_set_curswant = TRUE;
9284 rettv->vval.v_number = 0;
9288 * "deepcopy()" function
9290 static void
9291 f_deepcopy(argvars, rettv)
9292 typval_T *argvars;
9293 typval_T *rettv;
9295 int noref = 0;
9297 if (argvars[1].v_type != VAR_UNKNOWN)
9298 noref = get_tv_number_chk(&argvars[1], NULL);
9299 if (noref < 0 || noref > 1)
9300 EMSG(_(e_invarg));
9301 else
9303 current_copyID += COPYID_INC;
9304 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? current_copyID : 0);
9309 * "delete()" function
9311 static void
9312 f_delete(argvars, rettv)
9313 typval_T *argvars;
9314 typval_T *rettv;
9316 if (check_restricted() || check_secure())
9317 rettv->vval.v_number = -1;
9318 else
9319 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9323 * "did_filetype()" function
9325 static void
9326 f_did_filetype(argvars, rettv)
9327 typval_T *argvars UNUSED;
9328 typval_T *rettv UNUSED;
9330 #ifdef FEAT_AUTOCMD
9331 rettv->vval.v_number = did_filetype;
9332 #endif
9336 * "diff_filler()" function
9338 static void
9339 f_diff_filler(argvars, rettv)
9340 typval_T *argvars UNUSED;
9341 typval_T *rettv UNUSED;
9343 #ifdef FEAT_DIFF
9344 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9345 #endif
9349 * "diff_hlID()" function
9351 static void
9352 f_diff_hlID(argvars, rettv)
9353 typval_T *argvars UNUSED;
9354 typval_T *rettv UNUSED;
9356 #ifdef FEAT_DIFF
9357 linenr_T lnum = get_tv_lnum(argvars);
9358 static linenr_T prev_lnum = 0;
9359 static int changedtick = 0;
9360 static int fnum = 0;
9361 static int change_start = 0;
9362 static int change_end = 0;
9363 static hlf_T hlID = (hlf_T)0;
9364 int filler_lines;
9365 int col;
9367 if (lnum < 0) /* ignore type error in {lnum} arg */
9368 lnum = 0;
9369 if (lnum != prev_lnum
9370 || changedtick != curbuf->b_changedtick
9371 || fnum != curbuf->b_fnum)
9373 /* New line, buffer, change: need to get the values. */
9374 filler_lines = diff_check(curwin, lnum);
9375 if (filler_lines < 0)
9377 if (filler_lines == -1)
9379 change_start = MAXCOL;
9380 change_end = -1;
9381 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9382 hlID = HLF_ADD; /* added line */
9383 else
9384 hlID = HLF_CHD; /* changed line */
9386 else
9387 hlID = HLF_ADD; /* added line */
9389 else
9390 hlID = (hlf_T)0;
9391 prev_lnum = lnum;
9392 changedtick = curbuf->b_changedtick;
9393 fnum = curbuf->b_fnum;
9396 if (hlID == HLF_CHD || hlID == HLF_TXD)
9398 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9399 if (col >= change_start && col <= change_end)
9400 hlID = HLF_TXD; /* changed text */
9401 else
9402 hlID = HLF_CHD; /* changed line */
9404 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9405 #endif
9409 * "empty({expr})" function
9411 static void
9412 f_empty(argvars, rettv)
9413 typval_T *argvars;
9414 typval_T *rettv;
9416 int n;
9418 switch (argvars[0].v_type)
9420 case VAR_STRING:
9421 case VAR_FUNC:
9422 n = argvars[0].vval.v_string == NULL
9423 || *argvars[0].vval.v_string == NUL;
9424 break;
9425 case VAR_NUMBER:
9426 n = argvars[0].vval.v_number == 0;
9427 break;
9428 #ifdef FEAT_FLOAT
9429 case VAR_FLOAT:
9430 n = argvars[0].vval.v_float == 0.0;
9431 break;
9432 #endif
9433 case VAR_LIST:
9434 n = argvars[0].vval.v_list == NULL
9435 || argvars[0].vval.v_list->lv_first == NULL;
9436 break;
9437 case VAR_DICT:
9438 n = argvars[0].vval.v_dict == NULL
9439 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9440 break;
9441 default:
9442 EMSG2(_(e_intern2), "f_empty()");
9443 n = 0;
9446 rettv->vval.v_number = n;
9450 * "escape({string}, {chars})" function
9452 static void
9453 f_escape(argvars, rettv)
9454 typval_T *argvars;
9455 typval_T *rettv;
9457 char_u buf[NUMBUFLEN];
9459 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9460 get_tv_string_buf(&argvars[1], buf));
9461 rettv->v_type = VAR_STRING;
9465 * "eval()" function
9467 static void
9468 f_eval(argvars, rettv)
9469 typval_T *argvars;
9470 typval_T *rettv;
9472 char_u *s;
9474 s = get_tv_string_chk(&argvars[0]);
9475 if (s != NULL)
9476 s = skipwhite(s);
9478 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9480 rettv->v_type = VAR_NUMBER;
9481 rettv->vval.v_number = 0;
9483 else if (*s != NUL)
9484 EMSG(_(e_trailing));
9488 * "eventhandler()" function
9490 static void
9491 f_eventhandler(argvars, rettv)
9492 typval_T *argvars UNUSED;
9493 typval_T *rettv;
9495 rettv->vval.v_number = vgetc_busy;
9499 * "executable()" function
9501 static void
9502 f_executable(argvars, rettv)
9503 typval_T *argvars;
9504 typval_T *rettv;
9506 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9510 * "exists()" function
9512 static void
9513 f_exists(argvars, rettv)
9514 typval_T *argvars;
9515 typval_T *rettv;
9517 char_u *p;
9518 char_u *name;
9519 int n = FALSE;
9520 int len = 0;
9522 p = get_tv_string(&argvars[0]);
9523 if (*p == '$') /* environment variable */
9525 /* first try "normal" environment variables (fast) */
9526 if (mch_getenv(p + 1) != NULL)
9527 n = TRUE;
9528 else
9530 /* try expanding things like $VIM and ${HOME} */
9531 p = expand_env_save(p);
9532 if (p != NULL && *p != '$')
9533 n = TRUE;
9534 vim_free(p);
9537 else if (*p == '&' || *p == '+') /* option */
9539 n = (get_option_tv(&p, NULL, TRUE) == OK);
9540 if (*skipwhite(p) != NUL)
9541 n = FALSE; /* trailing garbage */
9543 else if (*p == '*') /* internal or user defined function */
9545 n = function_exists(p + 1);
9547 else if (*p == ':')
9549 n = cmd_exists(p + 1);
9551 else if (*p == '#')
9553 #ifdef FEAT_AUTOCMD
9554 if (p[1] == '#')
9555 n = autocmd_supported(p + 2);
9556 else
9557 n = au_exists(p + 1);
9558 #endif
9560 else /* internal variable */
9562 char_u *tofree;
9563 typval_T tv;
9565 /* get_name_len() takes care of expanding curly braces */
9566 name = p;
9567 len = get_name_len(&p, &tofree, TRUE, FALSE);
9568 if (len > 0)
9570 if (tofree != NULL)
9571 name = tofree;
9572 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9573 if (n)
9575 /* handle d.key, l[idx], f(expr) */
9576 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9577 if (n)
9578 clear_tv(&tv);
9581 if (*p != NUL)
9582 n = FALSE;
9584 vim_free(tofree);
9587 rettv->vval.v_number = n;
9591 * "expand()" function
9593 static void
9594 f_expand(argvars, rettv)
9595 typval_T *argvars;
9596 typval_T *rettv;
9598 char_u *s;
9599 int len;
9600 char_u *errormsg;
9601 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9602 expand_T xpc;
9603 int error = FALSE;
9605 rettv->v_type = VAR_STRING;
9606 s = get_tv_string(&argvars[0]);
9607 if (*s == '%' || *s == '#' || *s == '<')
9609 ++emsg_off;
9610 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9611 --emsg_off;
9613 else
9615 /* When the optional second argument is non-zero, don't remove matches
9616 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9617 if (argvars[1].v_type != VAR_UNKNOWN
9618 && get_tv_number_chk(&argvars[1], &error))
9619 flags |= WILD_KEEP_ALL;
9620 if (!error)
9622 ExpandInit(&xpc);
9623 xpc.xp_context = EXPAND_FILES;
9624 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9626 else
9627 rettv->vval.v_string = NULL;
9632 * "extend(list, list [, idx])" function
9633 * "extend(dict, dict [, action])" function
9635 static void
9636 f_extend(argvars, rettv)
9637 typval_T *argvars;
9638 typval_T *rettv;
9640 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9642 list_T *l1, *l2;
9643 listitem_T *item;
9644 long before;
9645 int error = FALSE;
9647 l1 = argvars[0].vval.v_list;
9648 l2 = argvars[1].vval.v_list;
9649 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9650 && l2 != NULL)
9652 if (argvars[2].v_type != VAR_UNKNOWN)
9654 before = get_tv_number_chk(&argvars[2], &error);
9655 if (error)
9656 return; /* type error; errmsg already given */
9658 if (before == l1->lv_len)
9659 item = NULL;
9660 else
9662 item = list_find(l1, before);
9663 if (item == NULL)
9665 EMSGN(_(e_listidx), before);
9666 return;
9670 else
9671 item = NULL;
9672 list_extend(l1, l2, item);
9674 copy_tv(&argvars[0], rettv);
9677 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9679 dict_T *d1, *d2;
9680 dictitem_T *di1;
9681 char_u *action;
9682 int i;
9683 hashitem_T *hi2;
9684 int todo;
9686 d1 = argvars[0].vval.v_dict;
9687 d2 = argvars[1].vval.v_dict;
9688 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9689 && d2 != NULL)
9691 /* Check the third argument. */
9692 if (argvars[2].v_type != VAR_UNKNOWN)
9694 static char *(av[]) = {"keep", "force", "error"};
9696 action = get_tv_string_chk(&argvars[2]);
9697 if (action == NULL)
9698 return; /* type error; errmsg already given */
9699 for (i = 0; i < 3; ++i)
9700 if (STRCMP(action, av[i]) == 0)
9701 break;
9702 if (i == 3)
9704 EMSG2(_(e_invarg2), action);
9705 return;
9708 else
9709 action = (char_u *)"force";
9711 /* Go over all entries in the second dict and add them to the
9712 * first dict. */
9713 todo = (int)d2->dv_hashtab.ht_used;
9714 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9716 if (!HASHITEM_EMPTY(hi2))
9718 --todo;
9719 di1 = dict_find(d1, hi2->hi_key, -1);
9720 if (di1 == NULL)
9722 di1 = dictitem_copy(HI2DI(hi2));
9723 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9724 dictitem_free(di1);
9726 else if (*action == 'e')
9728 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9729 break;
9731 else if (*action == 'f')
9733 clear_tv(&di1->di_tv);
9734 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9739 copy_tv(&argvars[0], rettv);
9742 else
9743 EMSG2(_(e_listdictarg), "extend()");
9747 * "feedkeys()" function
9749 static void
9750 f_feedkeys(argvars, rettv)
9751 typval_T *argvars;
9752 typval_T *rettv UNUSED;
9754 int remap = TRUE;
9755 char_u *keys, *flags;
9756 char_u nbuf[NUMBUFLEN];
9757 int typed = FALSE;
9758 char_u *keys_esc;
9760 /* This is not allowed in the sandbox. If the commands would still be
9761 * executed in the sandbox it would be OK, but it probably happens later,
9762 * when "sandbox" is no longer set. */
9763 if (check_secure())
9764 return;
9766 keys = get_tv_string(&argvars[0]);
9767 if (*keys != NUL)
9769 if (argvars[1].v_type != VAR_UNKNOWN)
9771 flags = get_tv_string_buf(&argvars[1], nbuf);
9772 for ( ; *flags != NUL; ++flags)
9774 switch (*flags)
9776 case 'n': remap = FALSE; break;
9777 case 'm': remap = TRUE; break;
9778 case 't': typed = TRUE; break;
9783 /* Need to escape K_SPECIAL and CSI before putting the string in the
9784 * typeahead buffer. */
9785 keys_esc = vim_strsave_escape_csi(keys);
9786 if (keys_esc != NULL)
9788 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9789 typebuf.tb_len, !typed, FALSE);
9790 vim_free(keys_esc);
9791 if (vgetc_busy)
9792 typebuf_was_filled = TRUE;
9798 * "filereadable()" function
9800 static void
9801 f_filereadable(argvars, rettv)
9802 typval_T *argvars;
9803 typval_T *rettv;
9805 int fd;
9806 char_u *p;
9807 int n;
9809 #ifndef O_NONBLOCK
9810 # define O_NONBLOCK 0
9811 #endif
9812 p = get_tv_string(&argvars[0]);
9813 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9814 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9816 n = TRUE;
9817 close(fd);
9819 else
9820 n = FALSE;
9822 rettv->vval.v_number = n;
9826 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9827 * rights to write into.
9829 static void
9830 f_filewritable(argvars, rettv)
9831 typval_T *argvars;
9832 typval_T *rettv;
9834 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9837 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9839 static void
9840 findfilendir(argvars, rettv, find_what)
9841 typval_T *argvars;
9842 typval_T *rettv;
9843 int find_what;
9845 #ifdef FEAT_SEARCHPATH
9846 char_u *fname;
9847 char_u *fresult = NULL;
9848 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9849 char_u *p;
9850 char_u pathbuf[NUMBUFLEN];
9851 int count = 1;
9852 int first = TRUE;
9853 int error = FALSE;
9854 #endif
9856 rettv->vval.v_string = NULL;
9857 rettv->v_type = VAR_STRING;
9859 #ifdef FEAT_SEARCHPATH
9860 fname = get_tv_string(&argvars[0]);
9862 if (argvars[1].v_type != VAR_UNKNOWN)
9864 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9865 if (p == NULL)
9866 error = TRUE;
9867 else
9869 if (*p != NUL)
9870 path = p;
9872 if (argvars[2].v_type != VAR_UNKNOWN)
9873 count = get_tv_number_chk(&argvars[2], &error);
9877 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9878 error = TRUE;
9880 if (*fname != NUL && !error)
9884 if (rettv->v_type == VAR_STRING)
9885 vim_free(fresult);
9886 fresult = find_file_in_path_option(first ? fname : NULL,
9887 first ? (int)STRLEN(fname) : 0,
9888 0, first, path,
9889 find_what,
9890 curbuf->b_ffname,
9891 find_what == FINDFILE_DIR
9892 ? (char_u *)"" : curbuf->b_p_sua);
9893 first = FALSE;
9895 if (fresult != NULL && rettv->v_type == VAR_LIST)
9896 list_append_string(rettv->vval.v_list, fresult, -1);
9898 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9901 if (rettv->v_type == VAR_STRING)
9902 rettv->vval.v_string = fresult;
9903 #endif
9906 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9907 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9910 * Implementation of map() and filter().
9912 static void
9913 filter_map(argvars, rettv, map)
9914 typval_T *argvars;
9915 typval_T *rettv;
9916 int map;
9918 char_u buf[NUMBUFLEN];
9919 char_u *expr;
9920 listitem_T *li, *nli;
9921 list_T *l = NULL;
9922 dictitem_T *di;
9923 hashtab_T *ht;
9924 hashitem_T *hi;
9925 dict_T *d = NULL;
9926 typval_T save_val;
9927 typval_T save_key;
9928 int rem;
9929 int todo;
9930 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9931 int save_did_emsg;
9932 int index = 0;
9934 if (argvars[0].v_type == VAR_LIST)
9936 if ((l = argvars[0].vval.v_list) == NULL
9937 || (map && tv_check_lock(l->lv_lock, ermsg)))
9938 return;
9940 else if (argvars[0].v_type == VAR_DICT)
9942 if ((d = argvars[0].vval.v_dict) == NULL
9943 || (map && tv_check_lock(d->dv_lock, ermsg)))
9944 return;
9946 else
9948 EMSG2(_(e_listdictarg), ermsg);
9949 return;
9952 expr = get_tv_string_buf_chk(&argvars[1], buf);
9953 /* On type errors, the preceding call has already displayed an error
9954 * message. Avoid a misleading error message for an empty string that
9955 * was not passed as argument. */
9956 if (expr != NULL)
9958 prepare_vimvar(VV_VAL, &save_val);
9959 expr = skipwhite(expr);
9961 /* We reset "did_emsg" to be able to detect whether an error
9962 * occurred during evaluation of the expression. */
9963 save_did_emsg = did_emsg;
9964 did_emsg = FALSE;
9966 prepare_vimvar(VV_KEY, &save_key);
9967 if (argvars[0].v_type == VAR_DICT)
9969 vimvars[VV_KEY].vv_type = VAR_STRING;
9971 ht = &d->dv_hashtab;
9972 hash_lock(ht);
9973 todo = (int)ht->ht_used;
9974 for (hi = ht->ht_array; todo > 0; ++hi)
9976 if (!HASHITEM_EMPTY(hi))
9978 --todo;
9979 di = HI2DI(hi);
9980 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9981 break;
9982 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9983 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9984 || did_emsg)
9985 break;
9986 if (!map && rem)
9987 dictitem_remove(d, di);
9988 clear_tv(&vimvars[VV_KEY].vv_tv);
9991 hash_unlock(ht);
9993 else
9995 vimvars[VV_KEY].vv_type = VAR_NUMBER;
9997 for (li = l->lv_first; li != NULL; li = nli)
9999 if (tv_check_lock(li->li_tv.v_lock, ermsg))
10000 break;
10001 nli = li->li_next;
10002 vimvars[VV_KEY].vv_nr = index;
10003 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
10004 || did_emsg)
10005 break;
10006 if (!map && rem)
10007 listitem_remove(l, li);
10008 ++index;
10012 restore_vimvar(VV_KEY, &save_key);
10013 restore_vimvar(VV_VAL, &save_val);
10015 did_emsg |= save_did_emsg;
10018 copy_tv(&argvars[0], rettv);
10021 static int
10022 filter_map_one(tv, expr, map, remp)
10023 typval_T *tv;
10024 char_u *expr;
10025 int map;
10026 int *remp;
10028 typval_T rettv;
10029 char_u *s;
10030 int retval = FAIL;
10032 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10033 s = expr;
10034 if (eval1(&s, &rettv, TRUE) == FAIL)
10035 goto theend;
10036 if (*s != NUL) /* check for trailing chars after expr */
10038 EMSG2(_(e_invexpr2), s);
10039 goto theend;
10041 if (map)
10043 /* map(): replace the list item value */
10044 clear_tv(tv);
10045 rettv.v_lock = 0;
10046 *tv = rettv;
10048 else
10050 int error = FALSE;
10052 /* filter(): when expr is zero remove the item */
10053 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10054 clear_tv(&rettv);
10055 /* On type error, nothing has been removed; return FAIL to stop the
10056 * loop. The error message was given by get_tv_number_chk(). */
10057 if (error)
10058 goto theend;
10060 retval = OK;
10061 theend:
10062 clear_tv(&vimvars[VV_VAL].vv_tv);
10063 return retval;
10067 * "filter()" function
10069 static void
10070 f_filter(argvars, rettv)
10071 typval_T *argvars;
10072 typval_T *rettv;
10074 filter_map(argvars, rettv, FALSE);
10078 * "finddir({fname}[, {path}[, {count}]])" function
10080 static void
10081 f_finddir(argvars, rettv)
10082 typval_T *argvars;
10083 typval_T *rettv;
10085 findfilendir(argvars, rettv, FINDFILE_DIR);
10089 * "findfile({fname}[, {path}[, {count}]])" function
10091 static void
10092 f_findfile(argvars, rettv)
10093 typval_T *argvars;
10094 typval_T *rettv;
10096 findfilendir(argvars, rettv, FINDFILE_FILE);
10099 #ifdef FEAT_FLOAT
10101 * "float2nr({float})" function
10103 static void
10104 f_float2nr(argvars, rettv)
10105 typval_T *argvars;
10106 typval_T *rettv;
10108 float_T f;
10110 if (get_float_arg(argvars, &f) == OK)
10112 if (f < -0x7fffffff)
10113 rettv->vval.v_number = -0x7fffffff;
10114 else if (f > 0x7fffffff)
10115 rettv->vval.v_number = 0x7fffffff;
10116 else
10117 rettv->vval.v_number = (varnumber_T)f;
10122 * "floor({float})" function
10124 static void
10125 f_floor(argvars, rettv)
10126 typval_T *argvars;
10127 typval_T *rettv;
10129 float_T f;
10131 rettv->v_type = VAR_FLOAT;
10132 if (get_float_arg(argvars, &f) == OK)
10133 rettv->vval.v_float = floor(f);
10134 else
10135 rettv->vval.v_float = 0.0;
10137 #endif
10140 * "fnameescape({string})" function
10142 static void
10143 f_fnameescape(argvars, rettv)
10144 typval_T *argvars;
10145 typval_T *rettv;
10147 rettv->vval.v_string = vim_strsave_fnameescape(
10148 get_tv_string(&argvars[0]), FALSE);
10149 rettv->v_type = VAR_STRING;
10153 * "fnamemodify({fname}, {mods})" function
10155 static void
10156 f_fnamemodify(argvars, rettv)
10157 typval_T *argvars;
10158 typval_T *rettv;
10160 char_u *fname;
10161 char_u *mods;
10162 int usedlen = 0;
10163 int len;
10164 char_u *fbuf = NULL;
10165 char_u buf[NUMBUFLEN];
10167 fname = get_tv_string_chk(&argvars[0]);
10168 mods = get_tv_string_buf_chk(&argvars[1], buf);
10169 if (fname == NULL || mods == NULL)
10170 fname = NULL;
10171 else
10173 len = (int)STRLEN(fname);
10174 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10177 rettv->v_type = VAR_STRING;
10178 if (fname == NULL)
10179 rettv->vval.v_string = NULL;
10180 else
10181 rettv->vval.v_string = vim_strnsave(fname, len);
10182 vim_free(fbuf);
10185 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10188 * "foldclosed()" function
10190 static void
10191 foldclosed_both(argvars, rettv, end)
10192 typval_T *argvars;
10193 typval_T *rettv;
10194 int end;
10196 #ifdef FEAT_FOLDING
10197 linenr_T lnum;
10198 linenr_T first, last;
10200 lnum = get_tv_lnum(argvars);
10201 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10203 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10205 if (end)
10206 rettv->vval.v_number = (varnumber_T)last;
10207 else
10208 rettv->vval.v_number = (varnumber_T)first;
10209 return;
10212 #endif
10213 rettv->vval.v_number = -1;
10217 * "foldclosed()" function
10219 static void
10220 f_foldclosed(argvars, rettv)
10221 typval_T *argvars;
10222 typval_T *rettv;
10224 foldclosed_both(argvars, rettv, FALSE);
10228 * "foldclosedend()" function
10230 static void
10231 f_foldclosedend(argvars, rettv)
10232 typval_T *argvars;
10233 typval_T *rettv;
10235 foldclosed_both(argvars, rettv, TRUE);
10239 * "foldlevel()" function
10241 static void
10242 f_foldlevel(argvars, rettv)
10243 typval_T *argvars;
10244 typval_T *rettv;
10246 #ifdef FEAT_FOLDING
10247 linenr_T lnum;
10249 lnum = get_tv_lnum(argvars);
10250 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10251 rettv->vval.v_number = foldLevel(lnum);
10252 #endif
10256 * "foldtext()" function
10258 static void
10259 f_foldtext(argvars, rettv)
10260 typval_T *argvars UNUSED;
10261 typval_T *rettv;
10263 #ifdef FEAT_FOLDING
10264 linenr_T lnum;
10265 char_u *s;
10266 char_u *r;
10267 int len;
10268 char *txt;
10269 #endif
10271 rettv->v_type = VAR_STRING;
10272 rettv->vval.v_string = NULL;
10273 #ifdef FEAT_FOLDING
10274 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10275 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10276 <= curbuf->b_ml.ml_line_count
10277 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10279 /* Find first non-empty line in the fold. */
10280 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10281 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10283 if (!linewhite(lnum))
10284 break;
10285 ++lnum;
10288 /* Find interesting text in this line. */
10289 s = skipwhite(ml_get(lnum));
10290 /* skip C comment-start */
10291 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10293 s = skipwhite(s + 2);
10294 if (*skipwhite(s) == NUL
10295 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10297 s = skipwhite(ml_get(lnum + 1));
10298 if (*s == '*')
10299 s = skipwhite(s + 1);
10302 txt = _("+-%s%3ld lines: ");
10303 r = alloc((unsigned)(STRLEN(txt)
10304 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10305 + 20 /* for %3ld */
10306 + STRLEN(s))); /* concatenated */
10307 if (r != NULL)
10309 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10310 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10311 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10312 len = (int)STRLEN(r);
10313 STRCAT(r, s);
10314 /* remove 'foldmarker' and 'commentstring' */
10315 foldtext_cleanup(r + len);
10316 rettv->vval.v_string = r;
10319 #endif
10323 * "foldtextresult(lnum)" function
10325 static void
10326 f_foldtextresult(argvars, rettv)
10327 typval_T *argvars UNUSED;
10328 typval_T *rettv;
10330 #ifdef FEAT_FOLDING
10331 linenr_T lnum;
10332 char_u *text;
10333 char_u buf[51];
10334 foldinfo_T foldinfo;
10335 int fold_count;
10336 #endif
10338 rettv->v_type = VAR_STRING;
10339 rettv->vval.v_string = NULL;
10340 #ifdef FEAT_FOLDING
10341 lnum = get_tv_lnum(argvars);
10342 /* treat illegal types and illegal string values for {lnum} the same */
10343 if (lnum < 0)
10344 lnum = 0;
10345 fold_count = foldedCount(curwin, lnum, &foldinfo);
10346 if (fold_count > 0)
10348 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10349 &foldinfo, buf);
10350 if (text == buf)
10351 text = vim_strsave(text);
10352 rettv->vval.v_string = text;
10354 #endif
10358 * "foreground()" function
10360 static void
10361 f_foreground(argvars, rettv)
10362 typval_T *argvars UNUSED;
10363 typval_T *rettv UNUSED;
10365 #ifdef FEAT_GUI
10366 if (gui.in_use)
10367 gui_mch_set_foreground();
10368 #else
10369 # ifdef WIN32
10370 win32_set_foreground();
10371 # endif
10372 #endif
10376 * "function()" function
10378 static void
10379 f_function(argvars, rettv)
10380 typval_T *argvars;
10381 typval_T *rettv;
10383 char_u *s;
10385 s = get_tv_string(&argvars[0]);
10386 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10387 EMSG2(_(e_invarg2), s);
10388 /* Don't check an autoload name for existence here. */
10389 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10390 EMSG2(_("E700: Unknown function: %s"), s);
10391 else
10393 rettv->vval.v_string = vim_strsave(s);
10394 rettv->v_type = VAR_FUNC;
10399 * "garbagecollect()" function
10401 static void
10402 f_garbagecollect(argvars, rettv)
10403 typval_T *argvars;
10404 typval_T *rettv UNUSED;
10406 /* This is postponed until we are back at the toplevel, because we may be
10407 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10408 want_garbage_collect = TRUE;
10410 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10411 garbage_collect_at_exit = TRUE;
10415 * "get()" function
10417 static void
10418 f_get(argvars, rettv)
10419 typval_T *argvars;
10420 typval_T *rettv;
10422 listitem_T *li;
10423 list_T *l;
10424 dictitem_T *di;
10425 dict_T *d;
10426 typval_T *tv = NULL;
10428 if (argvars[0].v_type == VAR_LIST)
10430 if ((l = argvars[0].vval.v_list) != NULL)
10432 int error = FALSE;
10434 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10435 if (!error && li != NULL)
10436 tv = &li->li_tv;
10439 else if (argvars[0].v_type == VAR_DICT)
10441 if ((d = argvars[0].vval.v_dict) != NULL)
10443 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10444 if (di != NULL)
10445 tv = &di->di_tv;
10448 else
10449 EMSG2(_(e_listdictarg), "get()");
10451 if (tv == NULL)
10453 if (argvars[2].v_type != VAR_UNKNOWN)
10454 copy_tv(&argvars[2], rettv);
10456 else
10457 copy_tv(tv, rettv);
10460 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10463 * Get line or list of lines from buffer "buf" into "rettv".
10464 * Return a range (from start to end) of lines in rettv from the specified
10465 * buffer.
10466 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10468 static void
10469 get_buffer_lines(buf, start, end, retlist, rettv)
10470 buf_T *buf;
10471 linenr_T start;
10472 linenr_T end;
10473 int retlist;
10474 typval_T *rettv;
10476 char_u *p;
10478 if (retlist && rettv_list_alloc(rettv) == FAIL)
10479 return;
10481 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10482 return;
10484 if (!retlist)
10486 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10487 p = ml_get_buf(buf, start, FALSE);
10488 else
10489 p = (char_u *)"";
10491 rettv->v_type = VAR_STRING;
10492 rettv->vval.v_string = vim_strsave(p);
10494 else
10496 if (end < start)
10497 return;
10499 if (start < 1)
10500 start = 1;
10501 if (end > buf->b_ml.ml_line_count)
10502 end = buf->b_ml.ml_line_count;
10503 while (start <= end)
10504 if (list_append_string(rettv->vval.v_list,
10505 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10506 break;
10511 * "getbufline()" function
10513 static void
10514 f_getbufline(argvars, rettv)
10515 typval_T *argvars;
10516 typval_T *rettv;
10518 linenr_T lnum;
10519 linenr_T end;
10520 buf_T *buf;
10522 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10523 ++emsg_off;
10524 buf = get_buf_tv(&argvars[0]);
10525 --emsg_off;
10527 lnum = get_tv_lnum_buf(&argvars[1], buf);
10528 if (argvars[2].v_type == VAR_UNKNOWN)
10529 end = lnum;
10530 else
10531 end = get_tv_lnum_buf(&argvars[2], buf);
10533 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10537 * "getbufvar()" function
10539 static void
10540 f_getbufvar(argvars, rettv)
10541 typval_T *argvars;
10542 typval_T *rettv;
10544 buf_T *buf;
10545 buf_T *save_curbuf;
10546 char_u *varname;
10547 dictitem_T *v;
10549 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10550 varname = get_tv_string_chk(&argvars[1]);
10551 ++emsg_off;
10552 buf = get_buf_tv(&argvars[0]);
10554 rettv->v_type = VAR_STRING;
10555 rettv->vval.v_string = NULL;
10557 if (buf != NULL && varname != NULL)
10559 /* set curbuf to be our buf, temporarily */
10560 save_curbuf = curbuf;
10561 curbuf = buf;
10563 if (*varname == '&') /* buffer-local-option */
10564 get_option_tv(&varname, rettv, TRUE);
10565 else
10567 if (*varname == NUL)
10568 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10569 * scope prefix before the NUL byte is required by
10570 * find_var_in_ht(). */
10571 varname = (char_u *)"b:" + 2;
10572 /* look up the variable */
10573 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10574 if (v != NULL)
10575 copy_tv(&v->di_tv, rettv);
10578 /* restore previous notion of curbuf */
10579 curbuf = save_curbuf;
10582 --emsg_off;
10586 * "getchar()" function
10588 static void
10589 f_getchar(argvars, rettv)
10590 typval_T *argvars;
10591 typval_T *rettv;
10593 varnumber_T n;
10594 int error = FALSE;
10596 /* Position the cursor. Needed after a message that ends in a space. */
10597 windgoto(msg_row, msg_col);
10599 ++no_mapping;
10600 ++allow_keys;
10601 for (;;)
10603 if (argvars[0].v_type == VAR_UNKNOWN)
10604 /* getchar(): blocking wait. */
10605 n = safe_vgetc();
10606 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10607 /* getchar(1): only check if char avail */
10608 n = vpeekc();
10609 else if (error || vpeekc() == NUL)
10610 /* illegal argument or getchar(0) and no char avail: return zero */
10611 n = 0;
10612 else
10613 /* getchar(0) and char avail: return char */
10614 n = safe_vgetc();
10615 if (n == K_IGNORE)
10616 continue;
10617 break;
10619 --no_mapping;
10620 --allow_keys;
10622 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10623 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10624 vimvars[VV_MOUSE_COL].vv_nr = 0;
10626 rettv->vval.v_number = n;
10627 if (IS_SPECIAL(n) || mod_mask != 0)
10629 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10630 int i = 0;
10632 /* Turn a special key into three bytes, plus modifier. */
10633 if (mod_mask != 0)
10635 temp[i++] = K_SPECIAL;
10636 temp[i++] = KS_MODIFIER;
10637 temp[i++] = mod_mask;
10639 if (IS_SPECIAL(n))
10641 temp[i++] = K_SPECIAL;
10642 temp[i++] = K_SECOND(n);
10643 temp[i++] = K_THIRD(n);
10645 #ifdef FEAT_MBYTE
10646 else if (has_mbyte)
10647 i += (*mb_char2bytes)(n, temp + i);
10648 #endif
10649 else
10650 temp[i++] = n;
10651 temp[i++] = NUL;
10652 rettv->v_type = VAR_STRING;
10653 rettv->vval.v_string = vim_strsave(temp);
10655 #ifdef FEAT_MOUSE
10656 if (n == K_LEFTMOUSE
10657 || n == K_LEFTMOUSE_NM
10658 || n == K_LEFTDRAG
10659 || n == K_LEFTRELEASE
10660 || n == K_LEFTRELEASE_NM
10661 || n == K_MIDDLEMOUSE
10662 || n == K_MIDDLEDRAG
10663 || n == K_MIDDLERELEASE
10664 || n == K_RIGHTMOUSE
10665 || n == K_RIGHTDRAG
10666 || n == K_RIGHTRELEASE
10667 || n == K_X1MOUSE
10668 || n == K_X1DRAG
10669 || n == K_X1RELEASE
10670 || n == K_X2MOUSE
10671 || n == K_X2DRAG
10672 || n == K_X2RELEASE
10673 || n == K_MOUSEDOWN
10674 || n == K_MOUSEUP)
10676 int row = mouse_row;
10677 int col = mouse_col;
10678 win_T *win;
10679 linenr_T lnum;
10680 # ifdef FEAT_WINDOWS
10681 win_T *wp;
10682 # endif
10683 int winnr = 1;
10685 if (row >= 0 && col >= 0)
10687 /* Find the window at the mouse coordinates and compute the
10688 * text position. */
10689 win = mouse_find_win(&row, &col);
10690 (void)mouse_comp_pos(win, &row, &col, &lnum);
10691 # ifdef FEAT_WINDOWS
10692 for (wp = firstwin; wp != win; wp = wp->w_next)
10693 ++winnr;
10694 # endif
10695 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10696 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10697 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10700 #endif
10705 * "getcharmod()" function
10707 static void
10708 f_getcharmod(argvars, rettv)
10709 typval_T *argvars UNUSED;
10710 typval_T *rettv;
10712 rettv->vval.v_number = mod_mask;
10716 * "getcmdline()" function
10718 static void
10719 f_getcmdline(argvars, rettv)
10720 typval_T *argvars UNUSED;
10721 typval_T *rettv;
10723 rettv->v_type = VAR_STRING;
10724 rettv->vval.v_string = get_cmdline_str();
10728 * "getcmdpos()" function
10730 static void
10731 f_getcmdpos(argvars, rettv)
10732 typval_T *argvars UNUSED;
10733 typval_T *rettv;
10735 rettv->vval.v_number = get_cmdline_pos() + 1;
10739 * "getcmdtype()" function
10741 static void
10742 f_getcmdtype(argvars, rettv)
10743 typval_T *argvars UNUSED;
10744 typval_T *rettv;
10746 rettv->v_type = VAR_STRING;
10747 rettv->vval.v_string = alloc(2);
10748 if (rettv->vval.v_string != NULL)
10750 rettv->vval.v_string[0] = get_cmdline_type();
10751 rettv->vval.v_string[1] = NUL;
10756 * "getcwd()" function
10758 static void
10759 f_getcwd(argvars, rettv)
10760 typval_T *argvars UNUSED;
10761 typval_T *rettv;
10763 char_u cwd[MAXPATHL];
10765 rettv->v_type = VAR_STRING;
10766 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10767 rettv->vval.v_string = NULL;
10768 else
10770 rettv->vval.v_string = vim_strsave(cwd);
10771 #ifdef BACKSLASH_IN_FILENAME
10772 if (rettv->vval.v_string != NULL)
10773 slash_adjust(rettv->vval.v_string);
10774 #endif
10779 * "getfontname()" function
10781 static void
10782 f_getfontname(argvars, rettv)
10783 typval_T *argvars UNUSED;
10784 typval_T *rettv;
10786 rettv->v_type = VAR_STRING;
10787 rettv->vval.v_string = NULL;
10788 #ifdef FEAT_GUI
10789 if (gui.in_use)
10791 GuiFont font;
10792 char_u *name = NULL;
10794 if (argvars[0].v_type == VAR_UNKNOWN)
10796 /* Get the "Normal" font. Either the name saved by
10797 * hl_set_font_name() or from the font ID. */
10798 font = gui.norm_font;
10799 name = hl_get_font_name();
10801 else
10803 name = get_tv_string(&argvars[0]);
10804 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10805 return;
10806 font = gui_mch_get_font(name, FALSE);
10807 if (font == NOFONT)
10808 return; /* Invalid font name, return empty string. */
10810 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10811 if (argvars[0].v_type != VAR_UNKNOWN)
10812 gui_mch_free_font(font);
10814 #endif
10818 * "getfperm({fname})" function
10820 static void
10821 f_getfperm(argvars, rettv)
10822 typval_T *argvars;
10823 typval_T *rettv;
10825 char_u *fname;
10826 struct stat st;
10827 char_u *perm = NULL;
10828 char_u flags[] = "rwx";
10829 int i;
10831 fname = get_tv_string(&argvars[0]);
10833 rettv->v_type = VAR_STRING;
10834 if (mch_stat((char *)fname, &st) >= 0)
10836 perm = vim_strsave((char_u *)"---------");
10837 if (perm != NULL)
10839 for (i = 0; i < 9; i++)
10841 if (st.st_mode & (1 << (8 - i)))
10842 perm[i] = flags[i % 3];
10846 rettv->vval.v_string = perm;
10850 * "getfsize({fname})" function
10852 static void
10853 f_getfsize(argvars, rettv)
10854 typval_T *argvars;
10855 typval_T *rettv;
10857 char_u *fname;
10858 struct stat st;
10860 fname = get_tv_string(&argvars[0]);
10862 rettv->v_type = VAR_NUMBER;
10864 if (mch_stat((char *)fname, &st) >= 0)
10866 if (mch_isdir(fname))
10867 rettv->vval.v_number = 0;
10868 else
10870 rettv->vval.v_number = (varnumber_T)st.st_size;
10872 /* non-perfect check for overflow */
10873 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10874 rettv->vval.v_number = -2;
10877 else
10878 rettv->vval.v_number = -1;
10882 * "getftime({fname})" function
10884 static void
10885 f_getftime(argvars, rettv)
10886 typval_T *argvars;
10887 typval_T *rettv;
10889 char_u *fname;
10890 struct stat st;
10892 fname = get_tv_string(&argvars[0]);
10894 if (mch_stat((char *)fname, &st) >= 0)
10895 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10896 else
10897 rettv->vval.v_number = -1;
10901 * "getftype({fname})" function
10903 static void
10904 f_getftype(argvars, rettv)
10905 typval_T *argvars;
10906 typval_T *rettv;
10908 char_u *fname;
10909 struct stat st;
10910 char_u *type = NULL;
10911 char *t;
10913 fname = get_tv_string(&argvars[0]);
10915 rettv->v_type = VAR_STRING;
10916 if (mch_lstat((char *)fname, &st) >= 0)
10918 #ifdef S_ISREG
10919 if (S_ISREG(st.st_mode))
10920 t = "file";
10921 else if (S_ISDIR(st.st_mode))
10922 t = "dir";
10923 # ifdef S_ISLNK
10924 else if (S_ISLNK(st.st_mode))
10925 t = "link";
10926 # endif
10927 # ifdef S_ISBLK
10928 else if (S_ISBLK(st.st_mode))
10929 t = "bdev";
10930 # endif
10931 # ifdef S_ISCHR
10932 else if (S_ISCHR(st.st_mode))
10933 t = "cdev";
10934 # endif
10935 # ifdef S_ISFIFO
10936 else if (S_ISFIFO(st.st_mode))
10937 t = "fifo";
10938 # endif
10939 # ifdef S_ISSOCK
10940 else if (S_ISSOCK(st.st_mode))
10941 t = "fifo";
10942 # endif
10943 else
10944 t = "other";
10945 #else
10946 # ifdef S_IFMT
10947 switch (st.st_mode & S_IFMT)
10949 case S_IFREG: t = "file"; break;
10950 case S_IFDIR: t = "dir"; break;
10951 # ifdef S_IFLNK
10952 case S_IFLNK: t = "link"; break;
10953 # endif
10954 # ifdef S_IFBLK
10955 case S_IFBLK: t = "bdev"; break;
10956 # endif
10957 # ifdef S_IFCHR
10958 case S_IFCHR: t = "cdev"; break;
10959 # endif
10960 # ifdef S_IFIFO
10961 case S_IFIFO: t = "fifo"; break;
10962 # endif
10963 # ifdef S_IFSOCK
10964 case S_IFSOCK: t = "socket"; break;
10965 # endif
10966 default: t = "other";
10968 # else
10969 if (mch_isdir(fname))
10970 t = "dir";
10971 else
10972 t = "file";
10973 # endif
10974 #endif
10975 type = vim_strsave((char_u *)t);
10977 rettv->vval.v_string = type;
10981 * "getline(lnum, [end])" function
10983 static void
10984 f_getline(argvars, rettv)
10985 typval_T *argvars;
10986 typval_T *rettv;
10988 linenr_T lnum;
10989 linenr_T end;
10990 int retlist;
10992 lnum = get_tv_lnum(argvars);
10993 if (argvars[1].v_type == VAR_UNKNOWN)
10995 end = 0;
10996 retlist = FALSE;
10998 else
11000 end = get_tv_lnum(&argvars[1]);
11001 retlist = TRUE;
11004 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
11008 * "getmatches()" function
11010 static void
11011 f_getmatches(argvars, rettv)
11012 typval_T *argvars UNUSED;
11013 typval_T *rettv;
11015 #ifdef FEAT_SEARCH_EXTRA
11016 dict_T *dict;
11017 matchitem_T *cur = curwin->w_match_head;
11019 if (rettv_list_alloc(rettv) == OK)
11021 while (cur != NULL)
11023 dict = dict_alloc();
11024 if (dict == NULL)
11025 return;
11026 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11027 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11028 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11029 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11030 list_append_dict(rettv->vval.v_list, dict);
11031 cur = cur->next;
11034 #endif
11038 * "getpid()" function
11040 static void
11041 f_getpid(argvars, rettv)
11042 typval_T *argvars UNUSED;
11043 typval_T *rettv;
11045 rettv->vval.v_number = mch_get_pid();
11049 * "getpos(string)" function
11051 static void
11052 f_getpos(argvars, rettv)
11053 typval_T *argvars;
11054 typval_T *rettv;
11056 pos_T *fp;
11057 list_T *l;
11058 int fnum = -1;
11060 if (rettv_list_alloc(rettv) == OK)
11062 l = rettv->vval.v_list;
11063 fp = var2fpos(&argvars[0], TRUE, &fnum);
11064 if (fnum != -1)
11065 list_append_number(l, (varnumber_T)fnum);
11066 else
11067 list_append_number(l, (varnumber_T)0);
11068 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11069 : (varnumber_T)0);
11070 list_append_number(l, (fp != NULL)
11071 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11072 : (varnumber_T)0);
11073 list_append_number(l,
11074 #ifdef FEAT_VIRTUALEDIT
11075 (fp != NULL) ? (varnumber_T)fp->coladd :
11076 #endif
11077 (varnumber_T)0);
11079 else
11080 rettv->vval.v_number = FALSE;
11084 * "getqflist()" and "getloclist()" functions
11086 static void
11087 f_getqflist(argvars, rettv)
11088 typval_T *argvars UNUSED;
11089 typval_T *rettv UNUSED;
11091 #ifdef FEAT_QUICKFIX
11092 win_T *wp;
11093 #endif
11095 #ifdef FEAT_QUICKFIX
11096 if (rettv_list_alloc(rettv) == OK)
11098 wp = NULL;
11099 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11101 wp = find_win_by_nr(&argvars[0], NULL);
11102 if (wp == NULL)
11103 return;
11106 (void)get_errorlist(wp, rettv->vval.v_list);
11108 #endif
11112 * "getreg()" function
11114 static void
11115 f_getreg(argvars, rettv)
11116 typval_T *argvars;
11117 typval_T *rettv;
11119 char_u *strregname;
11120 int regname;
11121 int arg2 = FALSE;
11122 int error = FALSE;
11124 if (argvars[0].v_type != VAR_UNKNOWN)
11126 strregname = get_tv_string_chk(&argvars[0]);
11127 error = strregname == NULL;
11128 if (argvars[1].v_type != VAR_UNKNOWN)
11129 arg2 = get_tv_number_chk(&argvars[1], &error);
11131 else
11132 strregname = vimvars[VV_REG].vv_str;
11133 regname = (strregname == NULL ? '"' : *strregname);
11134 if (regname == 0)
11135 regname = '"';
11137 rettv->v_type = VAR_STRING;
11138 rettv->vval.v_string = error ? NULL :
11139 get_reg_contents(regname, TRUE, arg2);
11143 * "getregtype()" function
11145 static void
11146 f_getregtype(argvars, rettv)
11147 typval_T *argvars;
11148 typval_T *rettv;
11150 char_u *strregname;
11151 int regname;
11152 char_u buf[NUMBUFLEN + 2];
11153 long reglen = 0;
11155 if (argvars[0].v_type != VAR_UNKNOWN)
11157 strregname = get_tv_string_chk(&argvars[0]);
11158 if (strregname == NULL) /* type error; errmsg already given */
11160 rettv->v_type = VAR_STRING;
11161 rettv->vval.v_string = NULL;
11162 return;
11165 else
11166 /* Default to v:register */
11167 strregname = vimvars[VV_REG].vv_str;
11169 regname = (strregname == NULL ? '"' : *strregname);
11170 if (regname == 0)
11171 regname = '"';
11173 buf[0] = NUL;
11174 buf[1] = NUL;
11175 switch (get_reg_type(regname, &reglen))
11177 case MLINE: buf[0] = 'V'; break;
11178 case MCHAR: buf[0] = 'v'; break;
11179 #ifdef FEAT_VISUAL
11180 case MBLOCK:
11181 buf[0] = Ctrl_V;
11182 sprintf((char *)buf + 1, "%ld", reglen + 1);
11183 break;
11184 #endif
11186 rettv->v_type = VAR_STRING;
11187 rettv->vval.v_string = vim_strsave(buf);
11191 * "gettabwinvar()" function
11193 static void
11194 f_gettabwinvar(argvars, rettv)
11195 typval_T *argvars;
11196 typval_T *rettv;
11198 getwinvar(argvars, rettv, 1);
11202 * "getwinposx()" function
11204 static void
11205 f_getwinposx(argvars, rettv)
11206 typval_T *argvars UNUSED;
11207 typval_T *rettv;
11209 rettv->vval.v_number = -1;
11210 #ifdef FEAT_GUI
11211 if (gui.in_use)
11213 int x, y;
11215 if (gui_mch_get_winpos(&x, &y) == OK)
11216 rettv->vval.v_number = x;
11218 #endif
11222 * "getwinposy()" function
11224 static void
11225 f_getwinposy(argvars, rettv)
11226 typval_T *argvars UNUSED;
11227 typval_T *rettv;
11229 rettv->vval.v_number = -1;
11230 #ifdef FEAT_GUI
11231 if (gui.in_use)
11233 int x, y;
11235 if (gui_mch_get_winpos(&x, &y) == OK)
11236 rettv->vval.v_number = y;
11238 #endif
11242 * Find window specified by "vp" in tabpage "tp".
11244 static win_T *
11245 find_win_by_nr(vp, tp)
11246 typval_T *vp;
11247 tabpage_T *tp; /* NULL for current tab page */
11249 #ifdef FEAT_WINDOWS
11250 win_T *wp;
11251 #endif
11252 int nr;
11254 nr = get_tv_number_chk(vp, NULL);
11256 #ifdef FEAT_WINDOWS
11257 if (nr < 0)
11258 return NULL;
11259 if (nr == 0)
11260 return curwin;
11262 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11263 wp != NULL; wp = wp->w_next)
11264 if (--nr <= 0)
11265 break;
11266 return wp;
11267 #else
11268 if (nr == 0 || nr == 1)
11269 return curwin;
11270 return NULL;
11271 #endif
11275 * "getwinvar()" function
11277 static void
11278 f_getwinvar(argvars, rettv)
11279 typval_T *argvars;
11280 typval_T *rettv;
11282 getwinvar(argvars, rettv, 0);
11286 * getwinvar() and gettabwinvar()
11288 static void
11289 getwinvar(argvars, rettv, off)
11290 typval_T *argvars;
11291 typval_T *rettv;
11292 int off; /* 1 for gettabwinvar() */
11294 win_T *win, *oldcurwin;
11295 char_u *varname;
11296 dictitem_T *v;
11297 tabpage_T *tp;
11299 #ifdef FEAT_WINDOWS
11300 if (off == 1)
11301 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11302 else
11303 tp = curtab;
11304 #endif
11305 win = find_win_by_nr(&argvars[off], tp);
11306 varname = get_tv_string_chk(&argvars[off + 1]);
11307 ++emsg_off;
11309 rettv->v_type = VAR_STRING;
11310 rettv->vval.v_string = NULL;
11312 if (win != NULL && varname != NULL)
11314 /* Set curwin to be our win, temporarily. Also set curbuf, so
11315 * that we can get buffer-local options. */
11316 oldcurwin = curwin;
11317 curwin = win;
11318 curbuf = win->w_buffer;
11320 if (*varname == '&') /* window-local-option */
11321 get_option_tv(&varname, rettv, 1);
11322 else
11324 if (*varname == NUL)
11325 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11326 * scope prefix before the NUL byte is required by
11327 * find_var_in_ht(). */
11328 varname = (char_u *)"w:" + 2;
11329 /* look up the variable */
11330 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11331 if (v != NULL)
11332 copy_tv(&v->di_tv, rettv);
11335 /* restore previous notion of curwin */
11336 curwin = oldcurwin;
11337 curbuf = curwin->w_buffer;
11340 --emsg_off;
11344 * "glob()" function
11346 static void
11347 f_glob(argvars, rettv)
11348 typval_T *argvars;
11349 typval_T *rettv;
11351 int flags = WILD_SILENT|WILD_USE_NL;
11352 expand_T xpc;
11353 int error = FALSE;
11355 /* When the optional second argument is non-zero, don't remove matches
11356 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11357 if (argvars[1].v_type != VAR_UNKNOWN
11358 && get_tv_number_chk(&argvars[1], &error))
11359 flags |= WILD_KEEP_ALL;
11360 rettv->v_type = VAR_STRING;
11361 if (!error)
11363 ExpandInit(&xpc);
11364 xpc.xp_context = EXPAND_FILES;
11365 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11366 NULL, flags, WILD_ALL);
11368 else
11369 rettv->vval.v_string = NULL;
11373 * "globpath()" function
11375 static void
11376 f_globpath(argvars, rettv)
11377 typval_T *argvars;
11378 typval_T *rettv;
11380 int flags = 0;
11381 char_u buf1[NUMBUFLEN];
11382 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11383 int error = FALSE;
11385 /* When the optional second argument is non-zero, don't remove matches
11386 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11387 if (argvars[2].v_type != VAR_UNKNOWN
11388 && get_tv_number_chk(&argvars[2], &error))
11389 flags |= WILD_KEEP_ALL;
11390 rettv->v_type = VAR_STRING;
11391 if (file == NULL || error)
11392 rettv->vval.v_string = NULL;
11393 else
11394 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11395 flags);
11399 * "has()" function
11401 static void
11402 f_has(argvars, rettv)
11403 typval_T *argvars;
11404 typval_T *rettv;
11406 int i;
11407 char_u *name;
11408 int n = FALSE;
11409 static char *(has_list[]) =
11411 #ifdef AMIGA
11412 "amiga",
11413 # ifdef FEAT_ARP
11414 "arp",
11415 # endif
11416 #endif
11417 #ifdef __BEOS__
11418 "beos",
11419 #endif
11420 #ifdef MSDOS
11421 # ifdef DJGPP
11422 "dos32",
11423 # else
11424 "dos16",
11425 # endif
11426 #endif
11427 #ifdef MACOS
11428 "mac",
11429 #endif
11430 #if defined(MACOS_X_UNIX)
11431 "macunix",
11432 #endif
11433 #ifdef OS2
11434 "os2",
11435 #endif
11436 #ifdef __QNX__
11437 "qnx",
11438 #endif
11439 #ifdef RISCOS
11440 "riscos",
11441 #endif
11442 #ifdef UNIX
11443 "unix",
11444 #endif
11445 #ifdef VMS
11446 "vms",
11447 #endif
11448 #ifdef WIN16
11449 "win16",
11450 #endif
11451 #ifdef WIN32
11452 "win32",
11453 #endif
11454 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11455 "win32unix",
11456 #endif
11457 #ifdef WIN64
11458 "win64",
11459 #endif
11460 #ifdef EBCDIC
11461 "ebcdic",
11462 #endif
11463 #ifndef CASE_INSENSITIVE_FILENAME
11464 "fname_case",
11465 #endif
11466 #ifdef FEAT_ARABIC
11467 "arabic",
11468 #endif
11469 #ifdef FEAT_AUTOCMD
11470 "autocmd",
11471 #endif
11472 #ifdef FEAT_BEVAL
11473 "balloon_eval",
11474 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11475 "balloon_multiline",
11476 # endif
11477 #endif
11478 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11479 "builtin_terms",
11480 # ifdef ALL_BUILTIN_TCAPS
11481 "all_builtin_terms",
11482 # endif
11483 #endif
11484 #ifdef FEAT_BYTEOFF
11485 "byte_offset",
11486 #endif
11487 #ifdef FEAT_CINDENT
11488 "cindent",
11489 #endif
11490 #ifdef FEAT_CLIENTSERVER
11491 "clientserver",
11492 #endif
11493 #ifdef FEAT_CLIPBOARD
11494 "clipboard",
11495 #endif
11496 #ifdef FEAT_CMDL_COMPL
11497 "cmdline_compl",
11498 #endif
11499 #ifdef FEAT_CMDHIST
11500 "cmdline_hist",
11501 #endif
11502 #ifdef FEAT_COMMENTS
11503 "comments",
11504 #endif
11505 #ifdef FEAT_CRYPT
11506 "cryptv",
11507 #endif
11508 #ifdef FEAT_CSCOPE
11509 "cscope",
11510 #endif
11511 #ifdef CURSOR_SHAPE
11512 "cursorshape",
11513 #endif
11514 #ifdef DEBUG
11515 "debug",
11516 #endif
11517 #ifdef FEAT_CON_DIALOG
11518 "dialog_con",
11519 #endif
11520 #ifdef FEAT_GUI_DIALOG
11521 "dialog_gui",
11522 #endif
11523 #ifdef FEAT_DIFF
11524 "diff",
11525 #endif
11526 #ifdef FEAT_DIGRAPHS
11527 "digraphs",
11528 #endif
11529 #ifdef FEAT_DND
11530 "dnd",
11531 #endif
11532 #ifdef FEAT_EMACS_TAGS
11533 "emacs_tags",
11534 #endif
11535 "eval", /* always present, of course! */
11536 #ifdef FEAT_EX_EXTRA
11537 "ex_extra",
11538 #endif
11539 #ifdef FEAT_SEARCH_EXTRA
11540 "extra_search",
11541 #endif
11542 #ifdef FEAT_FKMAP
11543 "farsi",
11544 #endif
11545 #ifdef FEAT_SEARCHPATH
11546 "file_in_path",
11547 #endif
11548 #if defined(UNIX) && !defined(USE_SYSTEM)
11549 "filterpipe",
11550 #endif
11551 #ifdef FEAT_FIND_ID
11552 "find_in_path",
11553 #endif
11554 #ifdef FEAT_FLOAT
11555 "float",
11556 #endif
11557 #ifdef FEAT_FOLDING
11558 "folding",
11559 #endif
11560 #ifdef FEAT_FOOTER
11561 "footer",
11562 #endif
11563 #if !defined(USE_SYSTEM) && defined(UNIX)
11564 "fork",
11565 #endif
11566 #ifdef FEAT_FULLSCREEN
11567 "fullscreen",
11568 #endif
11569 #ifdef FEAT_GETTEXT
11570 "gettext",
11571 #endif
11572 #ifdef FEAT_GUI
11573 "gui",
11574 #endif
11575 #ifdef FEAT_GUI_ATHENA
11576 # ifdef FEAT_GUI_NEXTAW
11577 "gui_neXtaw",
11578 # else
11579 "gui_athena",
11580 # endif
11581 #endif
11582 #ifdef FEAT_GUI_GTK
11583 "gui_gtk",
11584 # ifdef HAVE_GTK2
11585 "gui_gtk2",
11586 # endif
11587 #endif
11588 #ifdef FEAT_GUI_GNOME
11589 "gui_gnome",
11590 #endif
11591 #ifdef FEAT_GUI_MAC
11592 "gui_mac",
11593 #endif
11594 #ifdef FEAT_GUI_MACVIM
11595 "gui_macvim",
11596 #endif
11597 #ifdef FEAT_GUI_MOTIF
11598 "gui_motif",
11599 #endif
11600 #ifdef FEAT_GUI_PHOTON
11601 "gui_photon",
11602 #endif
11603 #ifdef FEAT_GUI_W16
11604 "gui_win16",
11605 #endif
11606 #ifdef FEAT_GUI_W32
11607 "gui_win32",
11608 #endif
11609 #ifdef FEAT_HANGULIN
11610 "hangul_input",
11611 #endif
11612 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11613 "iconv",
11614 #endif
11615 #ifdef FEAT_INS_EXPAND
11616 "insert_expand",
11617 #endif
11618 #ifdef FEAT_JUMPLIST
11619 "jumplist",
11620 #endif
11621 #ifdef FEAT_KEYMAP
11622 "keymap",
11623 #endif
11624 #ifdef FEAT_LANGMAP
11625 "langmap",
11626 #endif
11627 #ifdef FEAT_LIBCALL
11628 "libcall",
11629 #endif
11630 #ifdef FEAT_LINEBREAK
11631 "linebreak",
11632 #endif
11633 #ifdef FEAT_LISP
11634 "lispindent",
11635 #endif
11636 #ifdef FEAT_LISTCMDS
11637 "listcmds",
11638 #endif
11639 #ifdef FEAT_LOCALMAP
11640 "localmap",
11641 #endif
11642 #ifdef FEAT_MENU
11643 "menu",
11644 #endif
11645 #ifdef FEAT_SESSION
11646 "mksession",
11647 #endif
11648 #ifdef FEAT_MODIFY_FNAME
11649 "modify_fname",
11650 #endif
11651 #ifdef FEAT_MOUSE
11652 "mouse",
11653 #endif
11654 #ifdef FEAT_MOUSESHAPE
11655 "mouseshape",
11656 #endif
11657 #if defined(UNIX) || defined(VMS)
11658 # ifdef FEAT_MOUSE_DEC
11659 "mouse_dec",
11660 # endif
11661 # ifdef FEAT_MOUSE_GPM
11662 "mouse_gpm",
11663 # endif
11664 # ifdef FEAT_MOUSE_JSB
11665 "mouse_jsbterm",
11666 # endif
11667 # ifdef FEAT_MOUSE_NET
11668 "mouse_netterm",
11669 # endif
11670 # ifdef FEAT_MOUSE_PTERM
11671 "mouse_pterm",
11672 # endif
11673 # ifdef FEAT_SYSMOUSE
11674 "mouse_sysmouse",
11675 # endif
11676 # ifdef FEAT_MOUSE_XTERM
11677 "mouse_xterm",
11678 # endif
11679 #endif
11680 #ifdef FEAT_MBYTE
11681 "multi_byte",
11682 #endif
11683 #ifdef FEAT_MBYTE_IME
11684 "multi_byte_ime",
11685 #endif
11686 #ifdef FEAT_MULTI_LANG
11687 "multi_lang",
11688 #endif
11689 #ifdef FEAT_MZSCHEME
11690 #ifndef DYNAMIC_MZSCHEME
11691 "mzscheme",
11692 #endif
11693 #endif
11694 #ifdef FEAT_OLE
11695 "ole",
11696 #endif
11697 #ifdef FEAT_OSFILETYPE
11698 "osfiletype",
11699 #endif
11700 #ifdef FEAT_PATH_EXTRA
11701 "path_extra",
11702 #endif
11703 #ifdef FEAT_PERL
11704 #ifndef DYNAMIC_PERL
11705 "perl",
11706 #endif
11707 #endif
11708 #ifdef FEAT_PYTHON
11709 #ifndef DYNAMIC_PYTHON
11710 "python",
11711 #endif
11712 #endif
11713 #ifdef FEAT_POSTSCRIPT
11714 "postscript",
11715 #endif
11716 #ifdef FEAT_PRINTER
11717 "printer",
11718 #endif
11719 #ifdef FEAT_PROFILE
11720 "profile",
11721 #endif
11722 #ifdef FEAT_RELTIME
11723 "reltime",
11724 #endif
11725 #ifdef FEAT_QUICKFIX
11726 "quickfix",
11727 #endif
11728 #ifdef FEAT_RIGHTLEFT
11729 "rightleft",
11730 #endif
11731 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11732 "ruby",
11733 #endif
11734 #ifdef FEAT_SCROLLBIND
11735 "scrollbind",
11736 #endif
11737 #ifdef FEAT_CMDL_INFO
11738 "showcmd",
11739 "cmdline_info",
11740 #endif
11741 #ifdef FEAT_SIGNS
11742 "signs",
11743 #endif
11744 #ifdef FEAT_SMARTINDENT
11745 "smartindent",
11746 #endif
11747 #ifdef FEAT_SNIFF
11748 "sniff",
11749 #endif
11750 #ifdef STARTUPTIME
11751 "startuptime",
11752 #endif
11753 #ifdef FEAT_STL_OPT
11754 "statusline",
11755 #endif
11756 #ifdef FEAT_SUN_WORKSHOP
11757 "sun_workshop",
11758 #endif
11759 #ifdef FEAT_NETBEANS_INTG
11760 "netbeans_intg",
11761 #endif
11762 #ifdef FEAT_ODB_EDITOR
11763 "odbeditor",
11764 #endif
11765 #ifdef FEAT_SPELL
11766 "spell",
11767 #endif
11768 #ifdef FEAT_SYN_HL
11769 "syntax",
11770 #endif
11771 #if defined(USE_SYSTEM) || !defined(UNIX)
11772 "system",
11773 #endif
11774 #ifdef FEAT_TAG_BINS
11775 "tag_binary",
11776 #endif
11777 #ifdef FEAT_TAG_OLDSTATIC
11778 "tag_old_static",
11779 #endif
11780 #ifdef FEAT_TAG_ANYWHITE
11781 "tag_any_white",
11782 #endif
11783 #ifdef FEAT_TCL
11784 # ifndef DYNAMIC_TCL
11785 "tcl",
11786 # endif
11787 #endif
11788 #ifdef TERMINFO
11789 "terminfo",
11790 #endif
11791 #ifdef FEAT_TERMRESPONSE
11792 "termresponse",
11793 #endif
11794 #ifdef FEAT_TEXTOBJ
11795 "textobjects",
11796 #endif
11797 #ifdef HAVE_TGETENT
11798 "tgetent",
11799 #endif
11800 #ifdef FEAT_TITLE
11801 "title",
11802 #endif
11803 #ifdef FEAT_TOOLBAR
11804 "toolbar",
11805 #endif
11806 #ifdef FEAT_TRANSPARENCY
11807 "transparency",
11808 #endif
11809 #ifdef FEAT_USR_CMDS
11810 "user-commands", /* was accidentally included in 5.4 */
11811 "user_commands",
11812 #endif
11813 #ifdef FEAT_VIMINFO
11814 "viminfo",
11815 #endif
11816 #ifdef FEAT_VERTSPLIT
11817 "vertsplit",
11818 #endif
11819 #ifdef FEAT_VIRTUALEDIT
11820 "virtualedit",
11821 #endif
11822 #ifdef FEAT_VISUAL
11823 "visual",
11824 #endif
11825 #ifdef FEAT_VISUALEXTRA
11826 "visualextra",
11827 #endif
11828 #ifdef FEAT_VREPLACE
11829 "vreplace",
11830 #endif
11831 #ifdef FEAT_WILDIGN
11832 "wildignore",
11833 #endif
11834 #ifdef FEAT_WILDMENU
11835 "wildmenu",
11836 #endif
11837 #ifdef FEAT_WINDOWS
11838 "windows",
11839 #endif
11840 #ifdef FEAT_WAK
11841 "winaltkeys",
11842 #endif
11843 #ifdef FEAT_WRITEBACKUP
11844 "writebackup",
11845 #endif
11846 #ifdef FEAT_XIM
11847 "xim",
11848 #endif
11849 #ifdef FEAT_XFONTSET
11850 "xfontset",
11851 #endif
11852 #ifdef USE_XSMP
11853 "xsmp",
11854 #endif
11855 #ifdef USE_XSMP_INTERACT
11856 "xsmp_interact",
11857 #endif
11858 #ifdef FEAT_XCLIPBOARD
11859 "xterm_clipboard",
11860 #endif
11861 #ifdef FEAT_XTERM_SAVE
11862 "xterm_save",
11863 #endif
11864 #if defined(UNIX) && defined(FEAT_X11)
11865 "X11",
11866 #endif
11867 NULL
11870 name = get_tv_string(&argvars[0]);
11871 for (i = 0; has_list[i] != NULL; ++i)
11872 if (STRICMP(name, has_list[i]) == 0)
11874 n = TRUE;
11875 break;
11878 if (n == FALSE)
11880 if (STRNICMP(name, "patch", 5) == 0)
11881 n = has_patch(atoi((char *)name + 5));
11882 else if (STRICMP(name, "vim_starting") == 0)
11883 n = (starting != 0);
11884 #ifdef FEAT_MBYTE
11885 else if (STRICMP(name, "multi_byte_encoding") == 0)
11886 n = has_mbyte;
11887 #endif
11888 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11889 else if (STRICMP(name, "balloon_multiline") == 0)
11890 n = multiline_balloon_available();
11891 #endif
11892 #ifdef DYNAMIC_TCL
11893 else if (STRICMP(name, "tcl") == 0)
11894 n = tcl_enabled(FALSE);
11895 #endif
11896 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11897 else if (STRICMP(name, "iconv") == 0)
11898 n = iconv_enabled(FALSE);
11899 #endif
11900 #ifdef DYNAMIC_MZSCHEME
11901 else if (STRICMP(name, "mzscheme") == 0)
11902 n = mzscheme_enabled(FALSE);
11903 #endif
11904 #ifdef DYNAMIC_RUBY
11905 else if (STRICMP(name, "ruby") == 0)
11906 n = ruby_enabled(FALSE);
11907 #endif
11908 #ifdef DYNAMIC_PYTHON
11909 else if (STRICMP(name, "python") == 0)
11910 n = python_enabled(FALSE);
11911 #endif
11912 #ifdef DYNAMIC_PERL
11913 else if (STRICMP(name, "perl") == 0)
11914 n = perl_enabled(FALSE);
11915 #endif
11916 #ifdef FEAT_GUI
11917 else if (STRICMP(name, "gui_running") == 0)
11918 n = (gui.in_use || gui.starting);
11919 # ifdef FEAT_GUI_W32
11920 else if (STRICMP(name, "gui_win32s") == 0)
11921 n = gui_is_win32s();
11922 # endif
11923 # ifdef FEAT_BROWSE
11924 else if (STRICMP(name, "browse") == 0)
11925 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11926 # endif
11927 #endif
11928 #ifdef FEAT_SYN_HL
11929 else if (STRICMP(name, "syntax_items") == 0)
11930 n = syntax_present(curbuf);
11931 #endif
11932 #if defined(WIN3264)
11933 else if (STRICMP(name, "win95") == 0)
11934 n = mch_windows95();
11935 #endif
11936 #ifdef FEAT_NETBEANS_INTG
11937 else if (STRICMP(name, "netbeans_enabled") == 0)
11938 n = usingNetbeans;
11939 #endif
11942 rettv->vval.v_number = n;
11946 * "has_key()" function
11948 static void
11949 f_has_key(argvars, rettv)
11950 typval_T *argvars;
11951 typval_T *rettv;
11953 if (argvars[0].v_type != VAR_DICT)
11955 EMSG(_(e_dictreq));
11956 return;
11958 if (argvars[0].vval.v_dict == NULL)
11959 return;
11961 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11962 get_tv_string(&argvars[1]), -1) != NULL;
11966 * "haslocaldir()" function
11968 static void
11969 f_haslocaldir(argvars, rettv)
11970 typval_T *argvars UNUSED;
11971 typval_T *rettv;
11973 rettv->vval.v_number = (curwin->w_localdir != NULL);
11977 * "hasmapto()" function
11979 static void
11980 f_hasmapto(argvars, rettv)
11981 typval_T *argvars;
11982 typval_T *rettv;
11984 char_u *name;
11985 char_u *mode;
11986 char_u buf[NUMBUFLEN];
11987 int abbr = FALSE;
11989 name = get_tv_string(&argvars[0]);
11990 if (argvars[1].v_type == VAR_UNKNOWN)
11991 mode = (char_u *)"nvo";
11992 else
11994 mode = get_tv_string_buf(&argvars[1], buf);
11995 if (argvars[2].v_type != VAR_UNKNOWN)
11996 abbr = get_tv_number(&argvars[2]);
11999 if (map_to_exists(name, mode, abbr))
12000 rettv->vval.v_number = TRUE;
12001 else
12002 rettv->vval.v_number = FALSE;
12006 * "histadd()" function
12008 static void
12009 f_histadd(argvars, rettv)
12010 typval_T *argvars UNUSED;
12011 typval_T *rettv;
12013 #ifdef FEAT_CMDHIST
12014 int histype;
12015 char_u *str;
12016 char_u buf[NUMBUFLEN];
12017 #endif
12019 rettv->vval.v_number = FALSE;
12020 if (check_restricted() || check_secure())
12021 return;
12022 #ifdef FEAT_CMDHIST
12023 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12024 histype = str != NULL ? get_histtype(str) : -1;
12025 if (histype >= 0)
12027 str = get_tv_string_buf(&argvars[1], buf);
12028 if (*str != NUL)
12030 add_to_history(histype, str, FALSE, NUL);
12031 rettv->vval.v_number = TRUE;
12032 return;
12035 #endif
12039 * "histdel()" function
12041 static void
12042 f_histdel(argvars, rettv)
12043 typval_T *argvars UNUSED;
12044 typval_T *rettv UNUSED;
12046 #ifdef FEAT_CMDHIST
12047 int n;
12048 char_u buf[NUMBUFLEN];
12049 char_u *str;
12051 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12052 if (str == NULL)
12053 n = 0;
12054 else if (argvars[1].v_type == VAR_UNKNOWN)
12055 /* only one argument: clear entire history */
12056 n = clr_history(get_histtype(str));
12057 else if (argvars[1].v_type == VAR_NUMBER)
12058 /* index given: remove that entry */
12059 n = del_history_idx(get_histtype(str),
12060 (int)get_tv_number(&argvars[1]));
12061 else
12062 /* string given: remove all matching entries */
12063 n = del_history_entry(get_histtype(str),
12064 get_tv_string_buf(&argvars[1], buf));
12065 rettv->vval.v_number = n;
12066 #endif
12070 * "histget()" function
12072 static void
12073 f_histget(argvars, rettv)
12074 typval_T *argvars UNUSED;
12075 typval_T *rettv;
12077 #ifdef FEAT_CMDHIST
12078 int type;
12079 int idx;
12080 char_u *str;
12082 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12083 if (str == NULL)
12084 rettv->vval.v_string = NULL;
12085 else
12087 type = get_histtype(str);
12088 if (argvars[1].v_type == VAR_UNKNOWN)
12089 idx = get_history_idx(type);
12090 else
12091 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12092 /* -1 on type error */
12093 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12095 #else
12096 rettv->vval.v_string = NULL;
12097 #endif
12098 rettv->v_type = VAR_STRING;
12102 * "histnr()" function
12104 static void
12105 f_histnr(argvars, rettv)
12106 typval_T *argvars UNUSED;
12107 typval_T *rettv;
12109 int i;
12111 #ifdef FEAT_CMDHIST
12112 char_u *history = get_tv_string_chk(&argvars[0]);
12114 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12115 if (i >= HIST_CMD && i < HIST_COUNT)
12116 i = get_history_idx(i);
12117 else
12118 #endif
12119 i = -1;
12120 rettv->vval.v_number = i;
12124 * "highlightID(name)" function
12126 static void
12127 f_hlID(argvars, rettv)
12128 typval_T *argvars;
12129 typval_T *rettv;
12131 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12135 * "highlight_exists()" function
12137 static void
12138 f_hlexists(argvars, rettv)
12139 typval_T *argvars;
12140 typval_T *rettv;
12142 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12146 * "hostname()" function
12148 static void
12149 f_hostname(argvars, rettv)
12150 typval_T *argvars UNUSED;
12151 typval_T *rettv;
12153 char_u hostname[256];
12155 mch_get_host_name(hostname, 256);
12156 rettv->v_type = VAR_STRING;
12157 rettv->vval.v_string = vim_strsave(hostname);
12161 * iconv() function
12163 static void
12164 f_iconv(argvars, rettv)
12165 typval_T *argvars UNUSED;
12166 typval_T *rettv;
12168 #ifdef FEAT_MBYTE
12169 char_u buf1[NUMBUFLEN];
12170 char_u buf2[NUMBUFLEN];
12171 char_u *from, *to, *str;
12172 vimconv_T vimconv;
12173 #endif
12175 rettv->v_type = VAR_STRING;
12176 rettv->vval.v_string = NULL;
12178 #ifdef FEAT_MBYTE
12179 str = get_tv_string(&argvars[0]);
12180 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12181 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12182 vimconv.vc_type = CONV_NONE;
12183 convert_setup(&vimconv, from, to);
12185 /* If the encodings are equal, no conversion needed. */
12186 if (vimconv.vc_type == CONV_NONE)
12187 rettv->vval.v_string = vim_strsave(str);
12188 else
12189 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12191 convert_setup(&vimconv, NULL, NULL);
12192 vim_free(from);
12193 vim_free(to);
12194 #endif
12198 * "indent()" function
12200 static void
12201 f_indent(argvars, rettv)
12202 typval_T *argvars;
12203 typval_T *rettv;
12205 linenr_T lnum;
12207 lnum = get_tv_lnum(argvars);
12208 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12209 rettv->vval.v_number = get_indent_lnum(lnum);
12210 else
12211 rettv->vval.v_number = -1;
12215 * "index()" function
12217 static void
12218 f_index(argvars, rettv)
12219 typval_T *argvars;
12220 typval_T *rettv;
12222 list_T *l;
12223 listitem_T *item;
12224 long idx = 0;
12225 int ic = FALSE;
12227 rettv->vval.v_number = -1;
12228 if (argvars[0].v_type != VAR_LIST)
12230 EMSG(_(e_listreq));
12231 return;
12233 l = argvars[0].vval.v_list;
12234 if (l != NULL)
12236 item = l->lv_first;
12237 if (argvars[2].v_type != VAR_UNKNOWN)
12239 int error = FALSE;
12241 /* Start at specified item. Use the cached index that list_find()
12242 * sets, so that a negative number also works. */
12243 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12244 idx = l->lv_idx;
12245 if (argvars[3].v_type != VAR_UNKNOWN)
12246 ic = get_tv_number_chk(&argvars[3], &error);
12247 if (error)
12248 item = NULL;
12251 for ( ; item != NULL; item = item->li_next, ++idx)
12252 if (tv_equal(&item->li_tv, &argvars[1], ic))
12254 rettv->vval.v_number = idx;
12255 break;
12260 static int inputsecret_flag = 0;
12262 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12265 * This function is used by f_input() and f_inputdialog() functions. The third
12266 * argument to f_input() specifies the type of completion to use at the
12267 * prompt. The third argument to f_inputdialog() specifies the value to return
12268 * when the user cancels the prompt.
12270 static void
12271 get_user_input(argvars, rettv, inputdialog)
12272 typval_T *argvars;
12273 typval_T *rettv;
12274 int inputdialog;
12276 char_u *prompt = get_tv_string_chk(&argvars[0]);
12277 char_u *p = NULL;
12278 int c;
12279 char_u buf[NUMBUFLEN];
12280 int cmd_silent_save = cmd_silent;
12281 char_u *defstr = (char_u *)"";
12282 int xp_type = EXPAND_NOTHING;
12283 char_u *xp_arg = NULL;
12285 rettv->v_type = VAR_STRING;
12286 rettv->vval.v_string = NULL;
12288 #ifdef NO_CONSOLE_INPUT
12289 /* While starting up, there is no place to enter text. */
12290 if (no_console_input())
12291 return;
12292 #endif
12294 cmd_silent = FALSE; /* Want to see the prompt. */
12295 if (prompt != NULL)
12297 /* Only the part of the message after the last NL is considered as
12298 * prompt for the command line */
12299 p = vim_strrchr(prompt, '\n');
12300 if (p == NULL)
12301 p = prompt;
12302 else
12304 ++p;
12305 c = *p;
12306 *p = NUL;
12307 msg_start();
12308 msg_clr_eos();
12309 msg_puts_attr(prompt, echo_attr);
12310 msg_didout = FALSE;
12311 msg_starthere();
12312 *p = c;
12314 cmdline_row = msg_row;
12316 if (argvars[1].v_type != VAR_UNKNOWN)
12318 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12319 if (defstr != NULL)
12320 stuffReadbuffSpec(defstr);
12322 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12324 char_u *xp_name;
12325 int xp_namelen;
12326 long argt;
12328 rettv->vval.v_string = NULL;
12330 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12331 if (xp_name == NULL)
12332 return;
12334 xp_namelen = (int)STRLEN(xp_name);
12336 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12337 &xp_arg) == FAIL)
12338 return;
12342 if (defstr != NULL)
12343 rettv->vval.v_string =
12344 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12345 xp_type, xp_arg);
12347 vim_free(xp_arg);
12349 /* since the user typed this, no need to wait for return */
12350 need_wait_return = FALSE;
12351 msg_didout = FALSE;
12353 cmd_silent = cmd_silent_save;
12357 * "input()" function
12358 * Also handles inputsecret() when inputsecret is set.
12360 static void
12361 f_input(argvars, rettv)
12362 typval_T *argvars;
12363 typval_T *rettv;
12365 get_user_input(argvars, rettv, FALSE);
12369 * "inputdialog()" function
12371 static void
12372 f_inputdialog(argvars, rettv)
12373 typval_T *argvars;
12374 typval_T *rettv;
12376 #if defined(FEAT_GUI_TEXTDIALOG)
12377 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12378 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12380 char_u *message;
12381 char_u buf[NUMBUFLEN];
12382 char_u *defstr = (char_u *)"";
12384 message = get_tv_string_chk(&argvars[0]);
12385 if (argvars[1].v_type != VAR_UNKNOWN
12386 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12387 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12388 else
12389 IObuff[0] = NUL;
12390 if (message != NULL && defstr != NULL
12391 && do_dialog(VIM_QUESTION, NULL, message,
12392 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12393 rettv->vval.v_string = vim_strsave(IObuff);
12394 else
12396 if (message != NULL && defstr != NULL
12397 && argvars[1].v_type != VAR_UNKNOWN
12398 && argvars[2].v_type != VAR_UNKNOWN)
12399 rettv->vval.v_string = vim_strsave(
12400 get_tv_string_buf(&argvars[2], buf));
12401 else
12402 rettv->vval.v_string = NULL;
12404 rettv->v_type = VAR_STRING;
12406 else
12407 #endif
12408 get_user_input(argvars, rettv, TRUE);
12412 * "inputlist()" function
12414 static void
12415 f_inputlist(argvars, rettv)
12416 typval_T *argvars;
12417 typval_T *rettv;
12419 listitem_T *li;
12420 int selected;
12421 int mouse_used;
12423 #ifdef NO_CONSOLE_INPUT
12424 /* While starting up, there is no place to enter text. */
12425 if (no_console_input())
12426 return;
12427 #endif
12428 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12430 EMSG2(_(e_listarg), "inputlist()");
12431 return;
12434 msg_start();
12435 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12436 lines_left = Rows; /* avoid more prompt */
12437 msg_scroll = TRUE;
12438 msg_clr_eos();
12440 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12442 msg_puts(get_tv_string(&li->li_tv));
12443 msg_putchar('\n');
12446 /* Ask for choice. */
12447 selected = prompt_for_number(&mouse_used);
12448 if (mouse_used)
12449 selected -= lines_left;
12451 rettv->vval.v_number = selected;
12455 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12458 * "inputrestore()" function
12460 static void
12461 f_inputrestore(argvars, rettv)
12462 typval_T *argvars UNUSED;
12463 typval_T *rettv;
12465 if (ga_userinput.ga_len > 0)
12467 --ga_userinput.ga_len;
12468 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12469 + ga_userinput.ga_len);
12470 /* default return is zero == OK */
12472 else if (p_verbose > 1)
12474 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12475 rettv->vval.v_number = 1; /* Failed */
12480 * "inputsave()" function
12482 static void
12483 f_inputsave(argvars, rettv)
12484 typval_T *argvars UNUSED;
12485 typval_T *rettv;
12487 /* Add an entry to the stack of typeahead storage. */
12488 if (ga_grow(&ga_userinput, 1) == OK)
12490 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12491 + ga_userinput.ga_len);
12492 ++ga_userinput.ga_len;
12493 /* default return is zero == OK */
12495 else
12496 rettv->vval.v_number = 1; /* Failed */
12500 * "inputsecret()" function
12502 static void
12503 f_inputsecret(argvars, rettv)
12504 typval_T *argvars;
12505 typval_T *rettv;
12507 ++cmdline_star;
12508 ++inputsecret_flag;
12509 f_input(argvars, rettv);
12510 --cmdline_star;
12511 --inputsecret_flag;
12515 * "insert()" function
12517 static void
12518 f_insert(argvars, rettv)
12519 typval_T *argvars;
12520 typval_T *rettv;
12522 long before = 0;
12523 listitem_T *item;
12524 list_T *l;
12525 int error = FALSE;
12527 if (argvars[0].v_type != VAR_LIST)
12528 EMSG2(_(e_listarg), "insert()");
12529 else if ((l = argvars[0].vval.v_list) != NULL
12530 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12532 if (argvars[2].v_type != VAR_UNKNOWN)
12533 before = get_tv_number_chk(&argvars[2], &error);
12534 if (error)
12535 return; /* type error; errmsg already given */
12537 if (before == l->lv_len)
12538 item = NULL;
12539 else
12541 item = list_find(l, before);
12542 if (item == NULL)
12544 EMSGN(_(e_listidx), before);
12545 l = NULL;
12548 if (l != NULL)
12550 list_insert_tv(l, &argvars[1], item);
12551 copy_tv(&argvars[0], rettv);
12557 * "isdirectory()" function
12559 static void
12560 f_isdirectory(argvars, rettv)
12561 typval_T *argvars;
12562 typval_T *rettv;
12564 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12568 * "islocked()" function
12570 static void
12571 f_islocked(argvars, rettv)
12572 typval_T *argvars;
12573 typval_T *rettv;
12575 lval_T lv;
12576 char_u *end;
12577 dictitem_T *di;
12579 rettv->vval.v_number = -1;
12580 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12581 FNE_CHECK_START);
12582 if (end != NULL && lv.ll_name != NULL)
12584 if (*end != NUL)
12585 EMSG(_(e_trailing));
12586 else
12588 if (lv.ll_tv == NULL)
12590 if (check_changedtick(lv.ll_name))
12591 rettv->vval.v_number = 1; /* always locked */
12592 else
12594 di = find_var(lv.ll_name, NULL);
12595 if (di != NULL)
12597 /* Consider a variable locked when:
12598 * 1. the variable itself is locked
12599 * 2. the value of the variable is locked.
12600 * 3. the List or Dict value is locked.
12602 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12603 || tv_islocked(&di->di_tv));
12607 else if (lv.ll_range)
12608 EMSG(_("E786: Range not allowed"));
12609 else if (lv.ll_newkey != NULL)
12610 EMSG2(_(e_dictkey), lv.ll_newkey);
12611 else if (lv.ll_list != NULL)
12612 /* List item. */
12613 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12614 else
12615 /* Dictionary item. */
12616 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12620 clear_lval(&lv);
12623 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12626 * Turn a dict into a list:
12627 * "what" == 0: list of keys
12628 * "what" == 1: list of values
12629 * "what" == 2: list of items
12631 static void
12632 dict_list(argvars, rettv, what)
12633 typval_T *argvars;
12634 typval_T *rettv;
12635 int what;
12637 list_T *l2;
12638 dictitem_T *di;
12639 hashitem_T *hi;
12640 listitem_T *li;
12641 listitem_T *li2;
12642 dict_T *d;
12643 int todo;
12645 if (argvars[0].v_type != VAR_DICT)
12647 EMSG(_(e_dictreq));
12648 return;
12650 if ((d = argvars[0].vval.v_dict) == NULL)
12651 return;
12653 if (rettv_list_alloc(rettv) == FAIL)
12654 return;
12656 todo = (int)d->dv_hashtab.ht_used;
12657 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12659 if (!HASHITEM_EMPTY(hi))
12661 --todo;
12662 di = HI2DI(hi);
12664 li = listitem_alloc();
12665 if (li == NULL)
12666 break;
12667 list_append(rettv->vval.v_list, li);
12669 if (what == 0)
12671 /* keys() */
12672 li->li_tv.v_type = VAR_STRING;
12673 li->li_tv.v_lock = 0;
12674 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12676 else if (what == 1)
12678 /* values() */
12679 copy_tv(&di->di_tv, &li->li_tv);
12681 else
12683 /* items() */
12684 l2 = list_alloc();
12685 li->li_tv.v_type = VAR_LIST;
12686 li->li_tv.v_lock = 0;
12687 li->li_tv.vval.v_list = l2;
12688 if (l2 == NULL)
12689 break;
12690 ++l2->lv_refcount;
12692 li2 = listitem_alloc();
12693 if (li2 == NULL)
12694 break;
12695 list_append(l2, li2);
12696 li2->li_tv.v_type = VAR_STRING;
12697 li2->li_tv.v_lock = 0;
12698 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12700 li2 = listitem_alloc();
12701 if (li2 == NULL)
12702 break;
12703 list_append(l2, li2);
12704 copy_tv(&di->di_tv, &li2->li_tv);
12711 * "items(dict)" function
12713 static void
12714 f_items(argvars, rettv)
12715 typval_T *argvars;
12716 typval_T *rettv;
12718 dict_list(argvars, rettv, 2);
12722 * "join()" function
12724 static void
12725 f_join(argvars, rettv)
12726 typval_T *argvars;
12727 typval_T *rettv;
12729 garray_T ga;
12730 char_u *sep;
12732 if (argvars[0].v_type != VAR_LIST)
12734 EMSG(_(e_listreq));
12735 return;
12737 if (argvars[0].vval.v_list == NULL)
12738 return;
12739 if (argvars[1].v_type == VAR_UNKNOWN)
12740 sep = (char_u *)" ";
12741 else
12742 sep = get_tv_string_chk(&argvars[1]);
12744 rettv->v_type = VAR_STRING;
12746 if (sep != NULL)
12748 ga_init2(&ga, (int)sizeof(char), 80);
12749 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12750 ga_append(&ga, NUL);
12751 rettv->vval.v_string = (char_u *)ga.ga_data;
12753 else
12754 rettv->vval.v_string = NULL;
12758 * "keys()" function
12760 static void
12761 f_keys(argvars, rettv)
12762 typval_T *argvars;
12763 typval_T *rettv;
12765 dict_list(argvars, rettv, 0);
12769 * "last_buffer_nr()" function.
12771 static void
12772 f_last_buffer_nr(argvars, rettv)
12773 typval_T *argvars UNUSED;
12774 typval_T *rettv;
12776 int n = 0;
12777 buf_T *buf;
12779 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12780 if (n < buf->b_fnum)
12781 n = buf->b_fnum;
12783 rettv->vval.v_number = n;
12787 * "len()" function
12789 static void
12790 f_len(argvars, rettv)
12791 typval_T *argvars;
12792 typval_T *rettv;
12794 switch (argvars[0].v_type)
12796 case VAR_STRING:
12797 case VAR_NUMBER:
12798 rettv->vval.v_number = (varnumber_T)STRLEN(
12799 get_tv_string(&argvars[0]));
12800 break;
12801 case VAR_LIST:
12802 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12803 break;
12804 case VAR_DICT:
12805 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12806 break;
12807 default:
12808 EMSG(_("E701: Invalid type for len()"));
12809 break;
12813 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12815 static void
12816 libcall_common(argvars, rettv, type)
12817 typval_T *argvars;
12818 typval_T *rettv;
12819 int type;
12821 #ifdef FEAT_LIBCALL
12822 char_u *string_in;
12823 char_u **string_result;
12824 int nr_result;
12825 #endif
12827 rettv->v_type = type;
12828 if (type != VAR_NUMBER)
12829 rettv->vval.v_string = NULL;
12831 if (check_restricted() || check_secure())
12832 return;
12834 #ifdef FEAT_LIBCALL
12835 /* The first two args must be strings, otherwise its meaningless */
12836 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12838 string_in = NULL;
12839 if (argvars[2].v_type == VAR_STRING)
12840 string_in = argvars[2].vval.v_string;
12841 if (type == VAR_NUMBER)
12842 string_result = NULL;
12843 else
12844 string_result = &rettv->vval.v_string;
12845 if (mch_libcall(argvars[0].vval.v_string,
12846 argvars[1].vval.v_string,
12847 string_in,
12848 argvars[2].vval.v_number,
12849 string_result,
12850 &nr_result) == OK
12851 && type == VAR_NUMBER)
12852 rettv->vval.v_number = nr_result;
12854 #endif
12858 * "libcall()" function
12860 static void
12861 f_libcall(argvars, rettv)
12862 typval_T *argvars;
12863 typval_T *rettv;
12865 libcall_common(argvars, rettv, VAR_STRING);
12869 * "libcallnr()" function
12871 static void
12872 f_libcallnr(argvars, rettv)
12873 typval_T *argvars;
12874 typval_T *rettv;
12876 libcall_common(argvars, rettv, VAR_NUMBER);
12880 * "line(string)" function
12882 static void
12883 f_line(argvars, rettv)
12884 typval_T *argvars;
12885 typval_T *rettv;
12887 linenr_T lnum = 0;
12888 pos_T *fp;
12889 int fnum;
12891 fp = var2fpos(&argvars[0], TRUE, &fnum);
12892 if (fp != NULL)
12893 lnum = fp->lnum;
12894 rettv->vval.v_number = lnum;
12898 * "line2byte(lnum)" function
12900 static void
12901 f_line2byte(argvars, rettv)
12902 typval_T *argvars UNUSED;
12903 typval_T *rettv;
12905 #ifndef FEAT_BYTEOFF
12906 rettv->vval.v_number = -1;
12907 #else
12908 linenr_T lnum;
12910 lnum = get_tv_lnum(argvars);
12911 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12912 rettv->vval.v_number = -1;
12913 else
12914 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12915 if (rettv->vval.v_number >= 0)
12916 ++rettv->vval.v_number;
12917 #endif
12921 * "lispindent(lnum)" function
12923 static void
12924 f_lispindent(argvars, rettv)
12925 typval_T *argvars;
12926 typval_T *rettv;
12928 #ifdef FEAT_LISP
12929 pos_T pos;
12930 linenr_T lnum;
12932 pos = curwin->w_cursor;
12933 lnum = get_tv_lnum(argvars);
12934 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12936 curwin->w_cursor.lnum = lnum;
12937 rettv->vval.v_number = get_lisp_indent();
12938 curwin->w_cursor = pos;
12940 else
12941 #endif
12942 rettv->vval.v_number = -1;
12946 * "localtime()" function
12948 static void
12949 f_localtime(argvars, rettv)
12950 typval_T *argvars UNUSED;
12951 typval_T *rettv;
12953 rettv->vval.v_number = (varnumber_T)time(NULL);
12956 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12958 static void
12959 get_maparg(argvars, rettv, exact)
12960 typval_T *argvars;
12961 typval_T *rettv;
12962 int exact;
12964 char_u *keys;
12965 char_u *which;
12966 char_u buf[NUMBUFLEN];
12967 char_u *keys_buf = NULL;
12968 char_u *rhs;
12969 int mode;
12970 garray_T ga;
12971 int abbr = FALSE;
12973 /* return empty string for failure */
12974 rettv->v_type = VAR_STRING;
12975 rettv->vval.v_string = NULL;
12977 keys = get_tv_string(&argvars[0]);
12978 if (*keys == NUL)
12979 return;
12981 if (argvars[1].v_type != VAR_UNKNOWN)
12983 which = get_tv_string_buf_chk(&argvars[1], buf);
12984 if (argvars[2].v_type != VAR_UNKNOWN)
12985 abbr = get_tv_number(&argvars[2]);
12987 else
12988 which = (char_u *)"";
12989 if (which == NULL)
12990 return;
12992 mode = get_map_mode(&which, 0);
12994 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12995 rhs = check_map(keys, mode, exact, FALSE, abbr);
12996 vim_free(keys_buf);
12997 if (rhs != NULL)
12999 ga_init(&ga);
13000 ga.ga_itemsize = 1;
13001 ga.ga_growsize = 40;
13003 while (*rhs != NUL)
13004 ga_concat(&ga, str2special(&rhs, FALSE));
13006 ga_append(&ga, NUL);
13007 rettv->vval.v_string = (char_u *)ga.ga_data;
13011 #ifdef FEAT_FLOAT
13013 * "log10()" function
13015 static void
13016 f_log10(argvars, rettv)
13017 typval_T *argvars;
13018 typval_T *rettv;
13020 float_T f;
13022 rettv->v_type = VAR_FLOAT;
13023 if (get_float_arg(argvars, &f) == OK)
13024 rettv->vval.v_float = log10(f);
13025 else
13026 rettv->vval.v_float = 0.0;
13028 #endif
13031 * "map()" function
13033 static void
13034 f_map(argvars, rettv)
13035 typval_T *argvars;
13036 typval_T *rettv;
13038 filter_map(argvars, rettv, TRUE);
13042 * "maparg()" function
13044 static void
13045 f_maparg(argvars, rettv)
13046 typval_T *argvars;
13047 typval_T *rettv;
13049 get_maparg(argvars, rettv, TRUE);
13053 * "mapcheck()" function
13055 static void
13056 f_mapcheck(argvars, rettv)
13057 typval_T *argvars;
13058 typval_T *rettv;
13060 get_maparg(argvars, rettv, FALSE);
13063 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13065 static void
13066 find_some_match(argvars, rettv, type)
13067 typval_T *argvars;
13068 typval_T *rettv;
13069 int type;
13071 char_u *str = NULL;
13072 char_u *expr = NULL;
13073 char_u *pat;
13074 regmatch_T regmatch;
13075 char_u patbuf[NUMBUFLEN];
13076 char_u strbuf[NUMBUFLEN];
13077 char_u *save_cpo;
13078 long start = 0;
13079 long nth = 1;
13080 colnr_T startcol = 0;
13081 int match = 0;
13082 list_T *l = NULL;
13083 listitem_T *li = NULL;
13084 long idx = 0;
13085 char_u *tofree = NULL;
13087 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13088 save_cpo = p_cpo;
13089 p_cpo = (char_u *)"";
13091 rettv->vval.v_number = -1;
13092 if (type == 3)
13094 /* return empty list when there are no matches */
13095 if (rettv_list_alloc(rettv) == FAIL)
13096 goto theend;
13098 else if (type == 2)
13100 rettv->v_type = VAR_STRING;
13101 rettv->vval.v_string = NULL;
13104 if (argvars[0].v_type == VAR_LIST)
13106 if ((l = argvars[0].vval.v_list) == NULL)
13107 goto theend;
13108 li = l->lv_first;
13110 else
13111 expr = str = get_tv_string(&argvars[0]);
13113 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13114 if (pat == NULL)
13115 goto theend;
13117 if (argvars[2].v_type != VAR_UNKNOWN)
13119 int error = FALSE;
13121 start = get_tv_number_chk(&argvars[2], &error);
13122 if (error)
13123 goto theend;
13124 if (l != NULL)
13126 li = list_find(l, start);
13127 if (li == NULL)
13128 goto theend;
13129 idx = l->lv_idx; /* use the cached index */
13131 else
13133 if (start < 0)
13134 start = 0;
13135 if (start > (long)STRLEN(str))
13136 goto theend;
13137 /* When "count" argument is there ignore matches before "start",
13138 * otherwise skip part of the string. Differs when pattern is "^"
13139 * or "\<". */
13140 if (argvars[3].v_type != VAR_UNKNOWN)
13141 startcol = start;
13142 else
13143 str += start;
13146 if (argvars[3].v_type != VAR_UNKNOWN)
13147 nth = get_tv_number_chk(&argvars[3], &error);
13148 if (error)
13149 goto theend;
13152 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13153 if (regmatch.regprog != NULL)
13155 regmatch.rm_ic = p_ic;
13157 for (;;)
13159 if (l != NULL)
13161 if (li == NULL)
13163 match = FALSE;
13164 break;
13166 vim_free(tofree);
13167 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13168 if (str == NULL)
13169 break;
13172 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13174 if (match && --nth <= 0)
13175 break;
13176 if (l == NULL && !match)
13177 break;
13179 /* Advance to just after the match. */
13180 if (l != NULL)
13182 li = li->li_next;
13183 ++idx;
13185 else
13187 #ifdef FEAT_MBYTE
13188 startcol = (colnr_T)(regmatch.startp[0]
13189 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13190 #else
13191 startcol = regmatch.startp[0] + 1 - str;
13192 #endif
13196 if (match)
13198 if (type == 3)
13200 int i;
13202 /* return list with matched string and submatches */
13203 for (i = 0; i < NSUBEXP; ++i)
13205 if (regmatch.endp[i] == NULL)
13207 if (list_append_string(rettv->vval.v_list,
13208 (char_u *)"", 0) == FAIL)
13209 break;
13211 else if (list_append_string(rettv->vval.v_list,
13212 regmatch.startp[i],
13213 (int)(regmatch.endp[i] - regmatch.startp[i]))
13214 == FAIL)
13215 break;
13218 else if (type == 2)
13220 /* return matched string */
13221 if (l != NULL)
13222 copy_tv(&li->li_tv, rettv);
13223 else
13224 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13225 (int)(regmatch.endp[0] - regmatch.startp[0]));
13227 else if (l != NULL)
13228 rettv->vval.v_number = idx;
13229 else
13231 if (type != 0)
13232 rettv->vval.v_number =
13233 (varnumber_T)(regmatch.startp[0] - str);
13234 else
13235 rettv->vval.v_number =
13236 (varnumber_T)(regmatch.endp[0] - str);
13237 rettv->vval.v_number += (varnumber_T)(str - expr);
13240 vim_free(regmatch.regprog);
13243 theend:
13244 vim_free(tofree);
13245 p_cpo = save_cpo;
13249 * "match()" function
13251 static void
13252 f_match(argvars, rettv)
13253 typval_T *argvars;
13254 typval_T *rettv;
13256 find_some_match(argvars, rettv, 1);
13260 * "matchadd()" function
13262 static void
13263 f_matchadd(argvars, rettv)
13264 typval_T *argvars;
13265 typval_T *rettv;
13267 #ifdef FEAT_SEARCH_EXTRA
13268 char_u buf[NUMBUFLEN];
13269 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13270 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13271 int prio = 10; /* default priority */
13272 int id = -1;
13273 int error = FALSE;
13275 rettv->vval.v_number = -1;
13277 if (grp == NULL || pat == NULL)
13278 return;
13279 if (argvars[2].v_type != VAR_UNKNOWN)
13281 prio = get_tv_number_chk(&argvars[2], &error);
13282 if (argvars[3].v_type != VAR_UNKNOWN)
13283 id = get_tv_number_chk(&argvars[3], &error);
13285 if (error == TRUE)
13286 return;
13287 if (id >= 1 && id <= 3)
13289 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13290 return;
13293 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13294 #endif
13298 * "matcharg()" function
13300 static void
13301 f_matcharg(argvars, rettv)
13302 typval_T *argvars;
13303 typval_T *rettv;
13305 if (rettv_list_alloc(rettv) == OK)
13307 #ifdef FEAT_SEARCH_EXTRA
13308 int id = get_tv_number(&argvars[0]);
13309 matchitem_T *m;
13311 if (id >= 1 && id <= 3)
13313 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13315 list_append_string(rettv->vval.v_list,
13316 syn_id2name(m->hlg_id), -1);
13317 list_append_string(rettv->vval.v_list, m->pattern, -1);
13319 else
13321 list_append_string(rettv->vval.v_list, NUL, -1);
13322 list_append_string(rettv->vval.v_list, NUL, -1);
13325 #endif
13330 * "matchdelete()" function
13332 static void
13333 f_matchdelete(argvars, rettv)
13334 typval_T *argvars;
13335 typval_T *rettv;
13337 #ifdef FEAT_SEARCH_EXTRA
13338 rettv->vval.v_number = match_delete(curwin,
13339 (int)get_tv_number(&argvars[0]), TRUE);
13340 #endif
13344 * "matchend()" function
13346 static void
13347 f_matchend(argvars, rettv)
13348 typval_T *argvars;
13349 typval_T *rettv;
13351 find_some_match(argvars, rettv, 0);
13355 * "matchlist()" function
13357 static void
13358 f_matchlist(argvars, rettv)
13359 typval_T *argvars;
13360 typval_T *rettv;
13362 find_some_match(argvars, rettv, 3);
13366 * "matchstr()" function
13368 static void
13369 f_matchstr(argvars, rettv)
13370 typval_T *argvars;
13371 typval_T *rettv;
13373 find_some_match(argvars, rettv, 2);
13376 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13378 static void
13379 max_min(argvars, rettv, domax)
13380 typval_T *argvars;
13381 typval_T *rettv;
13382 int domax;
13384 long n = 0;
13385 long i;
13386 int error = FALSE;
13388 if (argvars[0].v_type == VAR_LIST)
13390 list_T *l;
13391 listitem_T *li;
13393 l = argvars[0].vval.v_list;
13394 if (l != NULL)
13396 li = l->lv_first;
13397 if (li != NULL)
13399 n = get_tv_number_chk(&li->li_tv, &error);
13400 for (;;)
13402 li = li->li_next;
13403 if (li == NULL)
13404 break;
13405 i = get_tv_number_chk(&li->li_tv, &error);
13406 if (domax ? i > n : i < n)
13407 n = i;
13412 else if (argvars[0].v_type == VAR_DICT)
13414 dict_T *d;
13415 int first = TRUE;
13416 hashitem_T *hi;
13417 int todo;
13419 d = argvars[0].vval.v_dict;
13420 if (d != NULL)
13422 todo = (int)d->dv_hashtab.ht_used;
13423 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13425 if (!HASHITEM_EMPTY(hi))
13427 --todo;
13428 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13429 if (first)
13431 n = i;
13432 first = FALSE;
13434 else if (domax ? i > n : i < n)
13435 n = i;
13440 else
13441 EMSG(_(e_listdictarg));
13442 rettv->vval.v_number = error ? 0 : n;
13446 * "max()" function
13448 static void
13449 f_max(argvars, rettv)
13450 typval_T *argvars;
13451 typval_T *rettv;
13453 max_min(argvars, rettv, TRUE);
13457 * "min()" function
13459 static void
13460 f_min(argvars, rettv)
13461 typval_T *argvars;
13462 typval_T *rettv;
13464 max_min(argvars, rettv, FALSE);
13467 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13470 * Create the directory in which "dir" is located, and higher levels when
13471 * needed.
13473 static int
13474 mkdir_recurse(dir, prot)
13475 char_u *dir;
13476 int prot;
13478 char_u *p;
13479 char_u *updir;
13480 int r = FAIL;
13482 /* Get end of directory name in "dir".
13483 * We're done when it's "/" or "c:/". */
13484 p = gettail_sep(dir);
13485 if (p <= get_past_head(dir))
13486 return OK;
13488 /* If the directory exists we're done. Otherwise: create it.*/
13489 updir = vim_strnsave(dir, (int)(p - dir));
13490 if (updir == NULL)
13491 return FAIL;
13492 if (mch_isdir(updir))
13493 r = OK;
13494 else if (mkdir_recurse(updir, prot) == OK)
13495 r = vim_mkdir_emsg(updir, prot);
13496 vim_free(updir);
13497 return r;
13500 #ifdef vim_mkdir
13502 * "mkdir()" function
13504 static void
13505 f_mkdir(argvars, rettv)
13506 typval_T *argvars;
13507 typval_T *rettv;
13509 char_u *dir;
13510 char_u buf[NUMBUFLEN];
13511 int prot = 0755;
13513 rettv->vval.v_number = FAIL;
13514 if (check_restricted() || check_secure())
13515 return;
13517 dir = get_tv_string_buf(&argvars[0], buf);
13518 if (argvars[1].v_type != VAR_UNKNOWN)
13520 if (argvars[2].v_type != VAR_UNKNOWN)
13521 prot = get_tv_number_chk(&argvars[2], NULL);
13522 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13523 mkdir_recurse(dir, prot);
13525 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13527 #endif
13530 * "mode()" function
13532 static void
13533 f_mode(argvars, rettv)
13534 typval_T *argvars;
13535 typval_T *rettv;
13537 char_u buf[3];
13539 buf[1] = NUL;
13540 buf[2] = NUL;
13542 #ifdef FEAT_VISUAL
13543 if (VIsual_active)
13545 if (VIsual_select)
13546 buf[0] = VIsual_mode + 's' - 'v';
13547 else
13548 buf[0] = VIsual_mode;
13550 else
13551 #endif
13552 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13553 || State == CONFIRM)
13555 buf[0] = 'r';
13556 if (State == ASKMORE)
13557 buf[1] = 'm';
13558 else if (State == CONFIRM)
13559 buf[1] = '?';
13561 else if (State == EXTERNCMD)
13562 buf[0] = '!';
13563 else if (State & INSERT)
13565 #ifdef FEAT_VREPLACE
13566 if (State & VREPLACE_FLAG)
13568 buf[0] = 'R';
13569 buf[1] = 'v';
13571 else
13572 #endif
13573 if (State & REPLACE_FLAG)
13574 buf[0] = 'R';
13575 else
13576 buf[0] = 'i';
13578 else if (State & CMDLINE)
13580 buf[0] = 'c';
13581 if (exmode_active)
13582 buf[1] = 'v';
13584 else if (exmode_active)
13586 buf[0] = 'c';
13587 buf[1] = 'e';
13589 else
13591 buf[0] = 'n';
13592 if (finish_op)
13593 buf[1] = 'o';
13596 /* Clear out the minor mode when the argument is not a non-zero number or
13597 * non-empty string. */
13598 if (!non_zero_arg(&argvars[0]))
13599 buf[1] = NUL;
13601 rettv->vval.v_string = vim_strsave(buf);
13602 rettv->v_type = VAR_STRING;
13606 * "nextnonblank()" function
13608 static void
13609 f_nextnonblank(argvars, rettv)
13610 typval_T *argvars;
13611 typval_T *rettv;
13613 linenr_T lnum;
13615 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13617 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13619 lnum = 0;
13620 break;
13622 if (*skipwhite(ml_get(lnum)) != NUL)
13623 break;
13625 rettv->vval.v_number = lnum;
13629 * "nr2char()" function
13631 static void
13632 f_nr2char(argvars, rettv)
13633 typval_T *argvars;
13634 typval_T *rettv;
13636 char_u buf[NUMBUFLEN];
13638 #ifdef FEAT_MBYTE
13639 if (has_mbyte)
13640 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13641 else
13642 #endif
13644 buf[0] = (char_u)get_tv_number(&argvars[0]);
13645 buf[1] = NUL;
13647 rettv->v_type = VAR_STRING;
13648 rettv->vval.v_string = vim_strsave(buf);
13652 * "pathshorten()" function
13654 static void
13655 f_pathshorten(argvars, rettv)
13656 typval_T *argvars;
13657 typval_T *rettv;
13659 char_u *p;
13661 rettv->v_type = VAR_STRING;
13662 p = get_tv_string_chk(&argvars[0]);
13663 if (p == NULL)
13664 rettv->vval.v_string = NULL;
13665 else
13667 p = vim_strsave(p);
13668 rettv->vval.v_string = p;
13669 if (p != NULL)
13670 shorten_dir(p);
13674 #ifdef FEAT_FLOAT
13676 * "pow()" function
13678 static void
13679 f_pow(argvars, rettv)
13680 typval_T *argvars;
13681 typval_T *rettv;
13683 float_T fx, fy;
13685 rettv->v_type = VAR_FLOAT;
13686 if (get_float_arg(argvars, &fx) == OK
13687 && get_float_arg(&argvars[1], &fy) == OK)
13688 rettv->vval.v_float = pow(fx, fy);
13689 else
13690 rettv->vval.v_float = 0.0;
13692 #endif
13695 * "prevnonblank()" function
13697 static void
13698 f_prevnonblank(argvars, rettv)
13699 typval_T *argvars;
13700 typval_T *rettv;
13702 linenr_T lnum;
13704 lnum = get_tv_lnum(argvars);
13705 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13706 lnum = 0;
13707 else
13708 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13709 --lnum;
13710 rettv->vval.v_number = lnum;
13713 #ifdef HAVE_STDARG_H
13714 /* This dummy va_list is here because:
13715 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13716 * - locally in the function results in a "used before set" warning
13717 * - using va_start() to initialize it gives "function with fixed args" error */
13718 static va_list ap;
13719 #endif
13722 * "printf()" function
13724 static void
13725 f_printf(argvars, rettv)
13726 typval_T *argvars;
13727 typval_T *rettv;
13729 rettv->v_type = VAR_STRING;
13730 rettv->vval.v_string = NULL;
13731 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13733 char_u buf[NUMBUFLEN];
13734 int len;
13735 char_u *s;
13736 int saved_did_emsg = did_emsg;
13737 char *fmt;
13739 /* Get the required length, allocate the buffer and do it for real. */
13740 did_emsg = FALSE;
13741 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13742 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13743 if (!did_emsg)
13745 s = alloc(len + 1);
13746 if (s != NULL)
13748 rettv->vval.v_string = s;
13749 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13752 did_emsg |= saved_did_emsg;
13754 #endif
13758 * "pumvisible()" function
13760 static void
13761 f_pumvisible(argvars, rettv)
13762 typval_T *argvars UNUSED;
13763 typval_T *rettv UNUSED;
13765 #ifdef FEAT_INS_EXPAND
13766 if (pum_visible())
13767 rettv->vval.v_number = 1;
13768 #endif
13772 * "range()" function
13774 static void
13775 f_range(argvars, rettv)
13776 typval_T *argvars;
13777 typval_T *rettv;
13779 long start;
13780 long end;
13781 long stride = 1;
13782 long i;
13783 int error = FALSE;
13785 start = get_tv_number_chk(&argvars[0], &error);
13786 if (argvars[1].v_type == VAR_UNKNOWN)
13788 end = start - 1;
13789 start = 0;
13791 else
13793 end = get_tv_number_chk(&argvars[1], &error);
13794 if (argvars[2].v_type != VAR_UNKNOWN)
13795 stride = get_tv_number_chk(&argvars[2], &error);
13798 if (error)
13799 return; /* type error; errmsg already given */
13800 if (stride == 0)
13801 EMSG(_("E726: Stride is zero"));
13802 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13803 EMSG(_("E727: Start past end"));
13804 else
13806 if (rettv_list_alloc(rettv) == OK)
13807 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13808 if (list_append_number(rettv->vval.v_list,
13809 (varnumber_T)i) == FAIL)
13810 break;
13815 * "readfile()" function
13817 static void
13818 f_readfile(argvars, rettv)
13819 typval_T *argvars;
13820 typval_T *rettv;
13822 int binary = FALSE;
13823 char_u *fname;
13824 FILE *fd;
13825 listitem_T *li;
13826 #define FREAD_SIZE 200 /* optimized for text lines */
13827 char_u buf[FREAD_SIZE];
13828 int readlen; /* size of last fread() */
13829 int buflen; /* nr of valid chars in buf[] */
13830 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13831 int tolist; /* first byte in buf[] still to be put in list */
13832 int chop; /* how many CR to chop off */
13833 char_u *prev = NULL; /* previously read bytes, if any */
13834 int prevlen = 0; /* length of "prev" if not NULL */
13835 char_u *s;
13836 int len;
13837 long maxline = MAXLNUM;
13838 long cnt = 0;
13840 if (argvars[1].v_type != VAR_UNKNOWN)
13842 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13843 binary = TRUE;
13844 if (argvars[2].v_type != VAR_UNKNOWN)
13845 maxline = get_tv_number(&argvars[2]);
13848 if (rettv_list_alloc(rettv) == FAIL)
13849 return;
13851 /* Always open the file in binary mode, library functions have a mind of
13852 * their own about CR-LF conversion. */
13853 fname = get_tv_string(&argvars[0]);
13854 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13856 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13857 return;
13860 filtd = 0;
13861 while (cnt < maxline || maxline < 0)
13863 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13864 buflen = filtd + readlen;
13865 tolist = 0;
13866 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13868 if (buf[filtd] == '\n' || readlen <= 0)
13870 /* Only when in binary mode add an empty list item when the
13871 * last line ends in a '\n'. */
13872 if (!binary && readlen == 0 && filtd == 0)
13873 break;
13875 /* Found end-of-line or end-of-file: add a text line to the
13876 * list. */
13877 chop = 0;
13878 if (!binary)
13879 while (filtd - chop - 1 >= tolist
13880 && buf[filtd - chop - 1] == '\r')
13881 ++chop;
13882 len = filtd - tolist - chop;
13883 if (prev == NULL)
13884 s = vim_strnsave(buf + tolist, len);
13885 else
13887 s = alloc((unsigned)(prevlen + len + 1));
13888 if (s != NULL)
13890 mch_memmove(s, prev, prevlen);
13891 vim_free(prev);
13892 prev = NULL;
13893 mch_memmove(s + prevlen, buf + tolist, len);
13894 s[prevlen + len] = NUL;
13897 tolist = filtd + 1;
13899 li = listitem_alloc();
13900 if (li == NULL)
13902 vim_free(s);
13903 break;
13905 li->li_tv.v_type = VAR_STRING;
13906 li->li_tv.v_lock = 0;
13907 li->li_tv.vval.v_string = s;
13908 list_append(rettv->vval.v_list, li);
13910 if (++cnt >= maxline && maxline >= 0)
13911 break;
13912 if (readlen <= 0)
13913 break;
13915 else if (buf[filtd] == NUL)
13916 buf[filtd] = '\n';
13918 if (readlen <= 0)
13919 break;
13921 if (tolist == 0)
13923 /* "buf" is full, need to move text to an allocated buffer */
13924 if (prev == NULL)
13926 prev = vim_strnsave(buf, buflen);
13927 prevlen = buflen;
13929 else
13931 s = alloc((unsigned)(prevlen + buflen));
13932 if (s != NULL)
13934 mch_memmove(s, prev, prevlen);
13935 mch_memmove(s + prevlen, buf, buflen);
13936 vim_free(prev);
13937 prev = s;
13938 prevlen += buflen;
13941 filtd = 0;
13943 else
13945 mch_memmove(buf, buf + tolist, buflen - tolist);
13946 filtd -= tolist;
13951 * For a negative line count use only the lines at the end of the file,
13952 * free the rest.
13954 if (maxline < 0)
13955 while (cnt > -maxline)
13957 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13958 --cnt;
13961 vim_free(prev);
13962 fclose(fd);
13965 #if defined(FEAT_RELTIME)
13966 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13969 * Convert a List to proftime_T.
13970 * Return FAIL when there is something wrong.
13972 static int
13973 list2proftime(arg, tm)
13974 typval_T *arg;
13975 proftime_T *tm;
13977 long n1, n2;
13978 int error = FALSE;
13980 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13981 || arg->vval.v_list->lv_len != 2)
13982 return FAIL;
13983 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13984 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13985 # ifdef WIN3264
13986 tm->HighPart = n1;
13987 tm->LowPart = n2;
13988 # else
13989 tm->tv_sec = n1;
13990 tm->tv_usec = n2;
13991 # endif
13992 return error ? FAIL : OK;
13994 #endif /* FEAT_RELTIME */
13997 * "reltime()" function
13999 static void
14000 f_reltime(argvars, rettv)
14001 typval_T *argvars;
14002 typval_T *rettv;
14004 #ifdef FEAT_RELTIME
14005 proftime_T res;
14006 proftime_T start;
14008 if (argvars[0].v_type == VAR_UNKNOWN)
14010 /* No arguments: get current time. */
14011 profile_start(&res);
14013 else if (argvars[1].v_type == VAR_UNKNOWN)
14015 if (list2proftime(&argvars[0], &res) == FAIL)
14016 return;
14017 profile_end(&res);
14019 else
14021 /* Two arguments: compute the difference. */
14022 if (list2proftime(&argvars[0], &start) == FAIL
14023 || list2proftime(&argvars[1], &res) == FAIL)
14024 return;
14025 profile_sub(&res, &start);
14028 if (rettv_list_alloc(rettv) == OK)
14030 long n1, n2;
14032 # ifdef WIN3264
14033 n1 = res.HighPart;
14034 n2 = res.LowPart;
14035 # else
14036 n1 = res.tv_sec;
14037 n2 = res.tv_usec;
14038 # endif
14039 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14040 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14042 #endif
14046 * "reltimestr()" function
14048 static void
14049 f_reltimestr(argvars, rettv)
14050 typval_T *argvars;
14051 typval_T *rettv;
14053 #ifdef FEAT_RELTIME
14054 proftime_T tm;
14055 #endif
14057 rettv->v_type = VAR_STRING;
14058 rettv->vval.v_string = NULL;
14059 #ifdef FEAT_RELTIME
14060 if (list2proftime(&argvars[0], &tm) == OK)
14061 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14062 #endif
14065 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14066 static void make_connection __ARGS((void));
14067 static int check_connection __ARGS((void));
14069 static void
14070 make_connection()
14072 if (X_DISPLAY == NULL
14073 # ifdef FEAT_GUI
14074 && !gui.in_use
14075 # endif
14078 x_force_connect = TRUE;
14079 setup_term_clip();
14080 x_force_connect = FALSE;
14084 static int
14085 check_connection()
14087 make_connection();
14088 if (X_DISPLAY == NULL)
14090 EMSG(_("E240: No connection to Vim server"));
14091 return FAIL;
14093 return OK;
14095 #endif
14097 #ifdef FEAT_CLIENTSERVER
14098 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14100 static void
14101 remote_common(argvars, rettv, expr)
14102 typval_T *argvars;
14103 typval_T *rettv;
14104 int expr;
14106 char_u *server_name;
14107 char_u *keys;
14108 char_u *r = NULL;
14109 char_u buf[NUMBUFLEN];
14110 # ifdef WIN32
14111 HWND w;
14112 # elif defined(FEAT_X11)
14113 Window w;
14114 # elif defined(MAC_CLIENTSERVER)
14115 int w; // This is the port number ('w' is a bit confusing)
14116 # endif
14118 if (check_restricted() || check_secure())
14119 return;
14121 # ifdef FEAT_X11
14122 if (check_connection() == FAIL)
14123 return;
14124 # endif
14126 server_name = get_tv_string_chk(&argvars[0]);
14127 if (server_name == NULL)
14128 return; /* type error; errmsg already given */
14129 keys = get_tv_string_buf(&argvars[1], buf);
14130 # ifdef WIN32
14131 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14132 # elif defined(FEAT_X11)
14133 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14134 < 0)
14135 # elif defined(MAC_CLIENTSERVER)
14136 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14137 # endif
14139 if (r != NULL)
14140 EMSG(r); /* sending worked but evaluation failed */
14141 else
14142 EMSG2(_("E241: Unable to send to %s"), server_name);
14143 return;
14146 rettv->vval.v_string = r;
14148 if (argvars[2].v_type != VAR_UNKNOWN)
14150 dictitem_T v;
14151 char_u str[30];
14152 char_u *idvar;
14154 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14155 v.di_tv.v_type = VAR_STRING;
14156 v.di_tv.vval.v_string = vim_strsave(str);
14157 idvar = get_tv_string_chk(&argvars[2]);
14158 if (idvar != NULL)
14159 set_var(idvar, &v.di_tv, FALSE);
14160 vim_free(v.di_tv.vval.v_string);
14163 #endif
14166 * "remote_expr()" function
14168 static void
14169 f_remote_expr(argvars, rettv)
14170 typval_T *argvars UNUSED;
14171 typval_T *rettv;
14173 rettv->v_type = VAR_STRING;
14174 rettv->vval.v_string = NULL;
14175 #ifdef FEAT_CLIENTSERVER
14176 remote_common(argvars, rettv, TRUE);
14177 #endif
14181 * "remote_foreground()" function
14183 static void
14184 f_remote_foreground(argvars, rettv)
14185 typval_T *argvars UNUSED;
14186 typval_T *rettv UNUSED;
14188 #ifdef FEAT_CLIENTSERVER
14189 # ifdef WIN32
14190 /* On Win32 it's done in this application. */
14192 char_u *server_name = get_tv_string_chk(&argvars[0]);
14194 if (server_name != NULL)
14195 serverForeground(server_name);
14197 # elif defined(FEAT_X11) || defined(MAC_CLIENTSERVER)
14198 /* Send a foreground() expression to the server. */
14199 argvars[1].v_type = VAR_STRING;
14200 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14201 argvars[2].v_type = VAR_UNKNOWN;
14202 remote_common(argvars, rettv, TRUE);
14203 vim_free(argvars[1].vval.v_string);
14204 # endif
14205 #endif
14208 static void
14209 f_remote_peek(argvars, rettv)
14210 typval_T *argvars UNUSED;
14211 typval_T *rettv;
14213 #ifdef FEAT_CLIENTSERVER
14214 dictitem_T v;
14215 char_u *s = NULL;
14216 # ifdef WIN32
14217 long_u n = 0;
14218 # endif
14219 char_u *serverid;
14221 if (check_restricted() || check_secure())
14223 rettv->vval.v_number = -1;
14224 return;
14226 serverid = get_tv_string_chk(&argvars[0]);
14227 if (serverid == NULL)
14229 rettv->vval.v_number = -1;
14230 return; /* type error; errmsg already given */
14232 # ifdef WIN32
14233 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14234 if (n == 0)
14235 rettv->vval.v_number = -1;
14236 else
14238 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14239 rettv->vval.v_number = (s != NULL);
14241 # elif defined(FEAT_X11)
14242 if (check_connection() == FAIL)
14243 return;
14245 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14246 serverStrToWin(serverid), &s);
14247 # elif defined(MAC_CLIENTSERVER)
14248 rettv->vval.v_number = serverPeekReply(serverStrToPort(serverid), &s);
14249 # endif
14251 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14253 char_u *retvar;
14255 v.di_tv.v_type = VAR_STRING;
14256 v.di_tv.vval.v_string = vim_strsave(s);
14257 retvar = get_tv_string_chk(&argvars[1]);
14258 if (retvar != NULL)
14259 set_var(retvar, &v.di_tv, FALSE);
14260 vim_free(v.di_tv.vval.v_string);
14262 #else
14263 rettv->vval.v_number = -1;
14264 #endif
14267 static void
14268 f_remote_read(argvars, rettv)
14269 typval_T *argvars UNUSED;
14270 typval_T *rettv;
14272 char_u *r = NULL;
14274 #ifdef FEAT_CLIENTSERVER
14275 char_u *serverid = get_tv_string_chk(&argvars[0]);
14277 if (serverid != NULL && !check_restricted() && !check_secure())
14279 # ifdef WIN32
14280 /* The server's HWND is encoded in the 'id' parameter */
14281 long_u n = 0;
14283 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14284 if (n != 0)
14285 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14286 if (r == NULL)
14287 # elif defined(FEAT_X11)
14288 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14289 serverStrToWin(serverid), &r, FALSE) < 0)
14290 # elif defined(MAC_CLIENTSERVER)
14291 if (serverReadReply(serverStrToPort(serverid), &r) < 0)
14292 # endif
14293 EMSG(_("E277: Unable to read a server reply"));
14295 #endif
14296 rettv->v_type = VAR_STRING;
14297 rettv->vval.v_string = r;
14301 * "remote_send()" function
14303 static void
14304 f_remote_send(argvars, rettv)
14305 typval_T *argvars UNUSED;
14306 typval_T *rettv;
14308 rettv->v_type = VAR_STRING;
14309 rettv->vval.v_string = NULL;
14310 #ifdef FEAT_CLIENTSERVER
14311 remote_common(argvars, rettv, FALSE);
14312 #endif
14316 * "remove()" function
14318 static void
14319 f_remove(argvars, rettv)
14320 typval_T *argvars;
14321 typval_T *rettv;
14323 list_T *l;
14324 listitem_T *item, *item2;
14325 listitem_T *li;
14326 long idx;
14327 long end;
14328 char_u *key;
14329 dict_T *d;
14330 dictitem_T *di;
14332 if (argvars[0].v_type == VAR_DICT)
14334 if (argvars[2].v_type != VAR_UNKNOWN)
14335 EMSG2(_(e_toomanyarg), "remove()");
14336 else if ((d = argvars[0].vval.v_dict) != NULL
14337 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14339 key = get_tv_string_chk(&argvars[1]);
14340 if (key != NULL)
14342 di = dict_find(d, key, -1);
14343 if (di == NULL)
14344 EMSG2(_(e_dictkey), key);
14345 else
14347 *rettv = di->di_tv;
14348 init_tv(&di->di_tv);
14349 dictitem_remove(d, di);
14354 else if (argvars[0].v_type != VAR_LIST)
14355 EMSG2(_(e_listdictarg), "remove()");
14356 else if ((l = argvars[0].vval.v_list) != NULL
14357 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14359 int error = FALSE;
14361 idx = get_tv_number_chk(&argvars[1], &error);
14362 if (error)
14363 ; /* type error: do nothing, errmsg already given */
14364 else if ((item = list_find(l, idx)) == NULL)
14365 EMSGN(_(e_listidx), idx);
14366 else
14368 if (argvars[2].v_type == VAR_UNKNOWN)
14370 /* Remove one item, return its value. */
14371 list_remove(l, item, item);
14372 *rettv = item->li_tv;
14373 vim_free(item);
14375 else
14377 /* Remove range of items, return list with values. */
14378 end = get_tv_number_chk(&argvars[2], &error);
14379 if (error)
14380 ; /* type error: do nothing */
14381 else if ((item2 = list_find(l, end)) == NULL)
14382 EMSGN(_(e_listidx), end);
14383 else
14385 int cnt = 0;
14387 for (li = item; li != NULL; li = li->li_next)
14389 ++cnt;
14390 if (li == item2)
14391 break;
14393 if (li == NULL) /* didn't find "item2" after "item" */
14394 EMSG(_(e_invrange));
14395 else
14397 list_remove(l, item, item2);
14398 if (rettv_list_alloc(rettv) == OK)
14400 l = rettv->vval.v_list;
14401 l->lv_first = item;
14402 l->lv_last = item2;
14403 item->li_prev = NULL;
14404 item2->li_next = NULL;
14405 l->lv_len = cnt;
14415 * "rename({from}, {to})" function
14417 static void
14418 f_rename(argvars, rettv)
14419 typval_T *argvars;
14420 typval_T *rettv;
14422 char_u buf[NUMBUFLEN];
14424 if (check_restricted() || check_secure())
14425 rettv->vval.v_number = -1;
14426 else
14427 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14428 get_tv_string_buf(&argvars[1], buf));
14432 * "repeat()" function
14434 static void
14435 f_repeat(argvars, rettv)
14436 typval_T *argvars;
14437 typval_T *rettv;
14439 char_u *p;
14440 int n;
14441 int slen;
14442 int len;
14443 char_u *r;
14444 int i;
14446 n = get_tv_number(&argvars[1]);
14447 if (argvars[0].v_type == VAR_LIST)
14449 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14450 while (n-- > 0)
14451 if (list_extend(rettv->vval.v_list,
14452 argvars[0].vval.v_list, NULL) == FAIL)
14453 break;
14455 else
14457 p = get_tv_string(&argvars[0]);
14458 rettv->v_type = VAR_STRING;
14459 rettv->vval.v_string = NULL;
14461 slen = (int)STRLEN(p);
14462 len = slen * n;
14463 if (len <= 0)
14464 return;
14466 r = alloc(len + 1);
14467 if (r != NULL)
14469 for (i = 0; i < n; i++)
14470 mch_memmove(r + i * slen, p, (size_t)slen);
14471 r[len] = NUL;
14474 rettv->vval.v_string = r;
14479 * "resolve()" function
14481 static void
14482 f_resolve(argvars, rettv)
14483 typval_T *argvars;
14484 typval_T *rettv;
14486 char_u *p;
14488 p = get_tv_string(&argvars[0]);
14489 #ifdef FEAT_SHORTCUT
14491 char_u *v = NULL;
14493 v = mch_resolve_shortcut(p);
14494 if (v != NULL)
14495 rettv->vval.v_string = v;
14496 else
14497 rettv->vval.v_string = vim_strsave(p);
14499 #else
14500 # ifdef HAVE_READLINK
14502 char_u buf[MAXPATHL + 1];
14503 char_u *cpy;
14504 int len;
14505 char_u *remain = NULL;
14506 char_u *q;
14507 int is_relative_to_current = FALSE;
14508 int has_trailing_pathsep = FALSE;
14509 int limit = 100;
14511 p = vim_strsave(p);
14513 if (p[0] == '.' && (vim_ispathsep(p[1])
14514 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14515 is_relative_to_current = TRUE;
14517 len = STRLEN(p);
14518 if (len > 0 && after_pathsep(p, p + len))
14519 has_trailing_pathsep = TRUE;
14521 q = getnextcomp(p);
14522 if (*q != NUL)
14524 /* Separate the first path component in "p", and keep the
14525 * remainder (beginning with the path separator). */
14526 remain = vim_strsave(q - 1);
14527 q[-1] = NUL;
14530 for (;;)
14532 for (;;)
14534 len = readlink((char *)p, (char *)buf, MAXPATHL);
14535 if (len <= 0)
14536 break;
14537 buf[len] = NUL;
14539 if (limit-- == 0)
14541 vim_free(p);
14542 vim_free(remain);
14543 EMSG(_("E655: Too many symbolic links (cycle?)"));
14544 rettv->vval.v_string = NULL;
14545 goto fail;
14548 /* Ensure that the result will have a trailing path separator
14549 * if the argument has one. */
14550 if (remain == NULL && has_trailing_pathsep)
14551 add_pathsep(buf);
14553 /* Separate the first path component in the link value and
14554 * concatenate the remainders. */
14555 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14556 if (*q != NUL)
14558 if (remain == NULL)
14559 remain = vim_strsave(q - 1);
14560 else
14562 cpy = concat_str(q - 1, remain);
14563 if (cpy != NULL)
14565 vim_free(remain);
14566 remain = cpy;
14569 q[-1] = NUL;
14572 q = gettail(p);
14573 if (q > p && *q == NUL)
14575 /* Ignore trailing path separator. */
14576 q[-1] = NUL;
14577 q = gettail(p);
14579 if (q > p && !mch_isFullName(buf))
14581 /* symlink is relative to directory of argument */
14582 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14583 if (cpy != NULL)
14585 STRCPY(cpy, p);
14586 STRCPY(gettail(cpy), buf);
14587 vim_free(p);
14588 p = cpy;
14591 else
14593 vim_free(p);
14594 p = vim_strsave(buf);
14598 if (remain == NULL)
14599 break;
14601 /* Append the first path component of "remain" to "p". */
14602 q = getnextcomp(remain + 1);
14603 len = q - remain - (*q != NUL);
14604 cpy = vim_strnsave(p, STRLEN(p) + len);
14605 if (cpy != NULL)
14607 STRNCAT(cpy, remain, len);
14608 vim_free(p);
14609 p = cpy;
14611 /* Shorten "remain". */
14612 if (*q != NUL)
14613 STRMOVE(remain, q - 1);
14614 else
14616 vim_free(remain);
14617 remain = NULL;
14621 /* If the result is a relative path name, make it explicitly relative to
14622 * the current directory if and only if the argument had this form. */
14623 if (!vim_ispathsep(*p))
14625 if (is_relative_to_current
14626 && *p != NUL
14627 && !(p[0] == '.'
14628 && (p[1] == NUL
14629 || vim_ispathsep(p[1])
14630 || (p[1] == '.'
14631 && (p[2] == NUL
14632 || vim_ispathsep(p[2]))))))
14634 /* Prepend "./". */
14635 cpy = concat_str((char_u *)"./", p);
14636 if (cpy != NULL)
14638 vim_free(p);
14639 p = cpy;
14642 else if (!is_relative_to_current)
14644 /* Strip leading "./". */
14645 q = p;
14646 while (q[0] == '.' && vim_ispathsep(q[1]))
14647 q += 2;
14648 if (q > p)
14649 STRMOVE(p, p + 2);
14653 /* Ensure that the result will have no trailing path separator
14654 * if the argument had none. But keep "/" or "//". */
14655 if (!has_trailing_pathsep)
14657 q = p + STRLEN(p);
14658 if (after_pathsep(p, q))
14659 *gettail_sep(p) = NUL;
14662 rettv->vval.v_string = p;
14664 # else
14665 rettv->vval.v_string = vim_strsave(p);
14666 # endif
14667 #endif
14669 simplify_filename(rettv->vval.v_string);
14671 #ifdef HAVE_READLINK
14672 fail:
14673 #endif
14674 rettv->v_type = VAR_STRING;
14678 * "reverse({list})" function
14680 static void
14681 f_reverse(argvars, rettv)
14682 typval_T *argvars;
14683 typval_T *rettv;
14685 list_T *l;
14686 listitem_T *li, *ni;
14688 if (argvars[0].v_type != VAR_LIST)
14689 EMSG2(_(e_listarg), "reverse()");
14690 else if ((l = argvars[0].vval.v_list) != NULL
14691 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14693 li = l->lv_last;
14694 l->lv_first = l->lv_last = NULL;
14695 l->lv_len = 0;
14696 while (li != NULL)
14698 ni = li->li_prev;
14699 list_append(l, li);
14700 li = ni;
14702 rettv->vval.v_list = l;
14703 rettv->v_type = VAR_LIST;
14704 ++l->lv_refcount;
14705 l->lv_idx = l->lv_len - l->lv_idx - 1;
14709 #define SP_NOMOVE 0x01 /* don't move cursor */
14710 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14711 #define SP_RETCOUNT 0x04 /* return matchcount */
14712 #define SP_SETPCMARK 0x08 /* set previous context mark */
14713 #define SP_START 0x10 /* accept match at start position */
14714 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14715 #define SP_END 0x40 /* leave cursor at end of match */
14717 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14720 * Get flags for a search function.
14721 * Possibly sets "p_ws".
14722 * Returns BACKWARD, FORWARD or zero (for an error).
14724 static int
14725 get_search_arg(varp, flagsp)
14726 typval_T *varp;
14727 int *flagsp;
14729 int dir = FORWARD;
14730 char_u *flags;
14731 char_u nbuf[NUMBUFLEN];
14732 int mask;
14734 if (varp->v_type != VAR_UNKNOWN)
14736 flags = get_tv_string_buf_chk(varp, nbuf);
14737 if (flags == NULL)
14738 return 0; /* type error; errmsg already given */
14739 while (*flags != NUL)
14741 switch (*flags)
14743 case 'b': dir = BACKWARD; break;
14744 case 'w': p_ws = TRUE; break;
14745 case 'W': p_ws = FALSE; break;
14746 default: mask = 0;
14747 if (flagsp != NULL)
14748 switch (*flags)
14750 case 'c': mask = SP_START; break;
14751 case 'e': mask = SP_END; break;
14752 case 'm': mask = SP_RETCOUNT; break;
14753 case 'n': mask = SP_NOMOVE; break;
14754 case 'p': mask = SP_SUBPAT; break;
14755 case 'r': mask = SP_REPEAT; break;
14756 case 's': mask = SP_SETPCMARK; break;
14758 if (mask == 0)
14760 EMSG2(_(e_invarg2), flags);
14761 dir = 0;
14763 else
14764 *flagsp |= mask;
14766 if (dir == 0)
14767 break;
14768 ++flags;
14771 return dir;
14775 * Shared by search() and searchpos() functions
14777 static int
14778 search_cmn(argvars, match_pos, flagsp)
14779 typval_T *argvars;
14780 pos_T *match_pos;
14781 int *flagsp;
14783 int flags;
14784 char_u *pat;
14785 pos_T pos;
14786 pos_T save_cursor;
14787 int save_p_ws = p_ws;
14788 int dir;
14789 int retval = 0; /* default: FAIL */
14790 long lnum_stop = 0;
14791 proftime_T tm;
14792 #ifdef FEAT_RELTIME
14793 long time_limit = 0;
14794 #endif
14795 int options = SEARCH_KEEP;
14796 int subpatnum;
14798 pat = get_tv_string(&argvars[0]);
14799 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14800 if (dir == 0)
14801 goto theend;
14802 flags = *flagsp;
14803 if (flags & SP_START)
14804 options |= SEARCH_START;
14805 if (flags & SP_END)
14806 options |= SEARCH_END;
14808 /* Optional arguments: line number to stop searching and timeout. */
14809 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14811 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14812 if (lnum_stop < 0)
14813 goto theend;
14814 #ifdef FEAT_RELTIME
14815 if (argvars[3].v_type != VAR_UNKNOWN)
14817 time_limit = get_tv_number_chk(&argvars[3], NULL);
14818 if (time_limit < 0)
14819 goto theend;
14821 #endif
14824 #ifdef FEAT_RELTIME
14825 /* Set the time limit, if there is one. */
14826 profile_setlimit(time_limit, &tm);
14827 #endif
14830 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14831 * Check to make sure only those flags are set.
14832 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14833 * flags cannot be set. Check for that condition also.
14835 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14836 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14838 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14839 goto theend;
14842 pos = save_cursor = curwin->w_cursor;
14843 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14844 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14845 if (subpatnum != FAIL)
14847 if (flags & SP_SUBPAT)
14848 retval = subpatnum;
14849 else
14850 retval = pos.lnum;
14851 if (flags & SP_SETPCMARK)
14852 setpcmark();
14853 curwin->w_cursor = pos;
14854 if (match_pos != NULL)
14856 /* Store the match cursor position */
14857 match_pos->lnum = pos.lnum;
14858 match_pos->col = pos.col + 1;
14860 /* "/$" will put the cursor after the end of the line, may need to
14861 * correct that here */
14862 check_cursor();
14865 /* If 'n' flag is used: restore cursor position. */
14866 if (flags & SP_NOMOVE)
14867 curwin->w_cursor = save_cursor;
14868 else
14869 curwin->w_set_curswant = TRUE;
14870 theend:
14871 p_ws = save_p_ws;
14873 return retval;
14876 #ifdef FEAT_FLOAT
14878 * "round({float})" function
14880 static void
14881 f_round(argvars, rettv)
14882 typval_T *argvars;
14883 typval_T *rettv;
14885 float_T f;
14887 rettv->v_type = VAR_FLOAT;
14888 if (get_float_arg(argvars, &f) == OK)
14889 /* round() is not in C90, use ceil() or floor() instead. */
14890 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14891 else
14892 rettv->vval.v_float = 0.0;
14894 #endif
14897 * "search()" function
14899 static void
14900 f_search(argvars, rettv)
14901 typval_T *argvars;
14902 typval_T *rettv;
14904 int flags = 0;
14906 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14910 * "searchdecl()" function
14912 static void
14913 f_searchdecl(argvars, rettv)
14914 typval_T *argvars;
14915 typval_T *rettv;
14917 int locally = 1;
14918 int thisblock = 0;
14919 int error = FALSE;
14920 char_u *name;
14922 rettv->vval.v_number = 1; /* default: FAIL */
14924 name = get_tv_string_chk(&argvars[0]);
14925 if (argvars[1].v_type != VAR_UNKNOWN)
14927 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14928 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14929 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14931 if (!error && name != NULL)
14932 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14933 locally, thisblock, SEARCH_KEEP) == FAIL;
14937 * Used by searchpair() and searchpairpos()
14939 static int
14940 searchpair_cmn(argvars, match_pos)
14941 typval_T *argvars;
14942 pos_T *match_pos;
14944 char_u *spat, *mpat, *epat;
14945 char_u *skip;
14946 int save_p_ws = p_ws;
14947 int dir;
14948 int flags = 0;
14949 char_u nbuf1[NUMBUFLEN];
14950 char_u nbuf2[NUMBUFLEN];
14951 char_u nbuf3[NUMBUFLEN];
14952 int retval = 0; /* default: FAIL */
14953 long lnum_stop = 0;
14954 long time_limit = 0;
14956 /* Get the three pattern arguments: start, middle, end. */
14957 spat = get_tv_string_chk(&argvars[0]);
14958 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14959 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14960 if (spat == NULL || mpat == NULL || epat == NULL)
14961 goto theend; /* type error */
14963 /* Handle the optional fourth argument: flags */
14964 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14965 if (dir == 0)
14966 goto theend;
14968 /* Don't accept SP_END or SP_SUBPAT.
14969 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14971 if ((flags & (SP_END | SP_SUBPAT)) != 0
14972 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14974 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14975 goto theend;
14978 /* Using 'r' implies 'W', otherwise it doesn't work. */
14979 if (flags & SP_REPEAT)
14980 p_ws = FALSE;
14982 /* Optional fifth argument: skip expression */
14983 if (argvars[3].v_type == VAR_UNKNOWN
14984 || argvars[4].v_type == VAR_UNKNOWN)
14985 skip = (char_u *)"";
14986 else
14988 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14989 if (argvars[5].v_type != VAR_UNKNOWN)
14991 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
14992 if (lnum_stop < 0)
14993 goto theend;
14994 #ifdef FEAT_RELTIME
14995 if (argvars[6].v_type != VAR_UNKNOWN)
14997 time_limit = get_tv_number_chk(&argvars[6], NULL);
14998 if (time_limit < 0)
14999 goto theend;
15001 #endif
15004 if (skip == NULL)
15005 goto theend; /* type error */
15007 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
15008 match_pos, lnum_stop, time_limit);
15010 theend:
15011 p_ws = save_p_ws;
15013 return retval;
15017 * "searchpair()" function
15019 static void
15020 f_searchpair(argvars, rettv)
15021 typval_T *argvars;
15022 typval_T *rettv;
15024 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15028 * "searchpairpos()" function
15030 static void
15031 f_searchpairpos(argvars, rettv)
15032 typval_T *argvars;
15033 typval_T *rettv;
15035 pos_T match_pos;
15036 int lnum = 0;
15037 int col = 0;
15039 if (rettv_list_alloc(rettv) == FAIL)
15040 return;
15042 if (searchpair_cmn(argvars, &match_pos) > 0)
15044 lnum = match_pos.lnum;
15045 col = match_pos.col;
15048 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15049 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15053 * Search for a start/middle/end thing.
15054 * Used by searchpair(), see its documentation for the details.
15055 * Returns 0 or -1 for no match,
15057 long
15058 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15059 lnum_stop, time_limit)
15060 char_u *spat; /* start pattern */
15061 char_u *mpat; /* middle pattern */
15062 char_u *epat; /* end pattern */
15063 int dir; /* BACKWARD or FORWARD */
15064 char_u *skip; /* skip expression */
15065 int flags; /* SP_SETPCMARK and other SP_ values */
15066 pos_T *match_pos;
15067 linenr_T lnum_stop; /* stop at this line if not zero */
15068 long time_limit; /* stop after this many msec */
15070 char_u *save_cpo;
15071 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15072 long retval = 0;
15073 pos_T pos;
15074 pos_T firstpos;
15075 pos_T foundpos;
15076 pos_T save_cursor;
15077 pos_T save_pos;
15078 int n;
15079 int r;
15080 int nest = 1;
15081 int err;
15082 int options = SEARCH_KEEP;
15083 proftime_T tm;
15085 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15086 save_cpo = p_cpo;
15087 p_cpo = empty_option;
15089 #ifdef FEAT_RELTIME
15090 /* Set the time limit, if there is one. */
15091 profile_setlimit(time_limit, &tm);
15092 #endif
15094 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15095 * start/middle/end (pat3, for the top pair). */
15096 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15097 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15098 if (pat2 == NULL || pat3 == NULL)
15099 goto theend;
15100 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15101 if (*mpat == NUL)
15102 STRCPY(pat3, pat2);
15103 else
15104 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15105 spat, epat, mpat);
15106 if (flags & SP_START)
15107 options |= SEARCH_START;
15109 save_cursor = curwin->w_cursor;
15110 pos = curwin->w_cursor;
15111 clearpos(&firstpos);
15112 clearpos(&foundpos);
15113 pat = pat3;
15114 for (;;)
15116 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15117 options, RE_SEARCH, lnum_stop, &tm);
15118 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15119 /* didn't find it or found the first match again: FAIL */
15120 break;
15122 if (firstpos.lnum == 0)
15123 firstpos = pos;
15124 if (equalpos(pos, foundpos))
15126 /* Found the same position again. Can happen with a pattern that
15127 * has "\zs" at the end and searching backwards. Advance one
15128 * character and try again. */
15129 if (dir == BACKWARD)
15130 decl(&pos);
15131 else
15132 incl(&pos);
15134 foundpos = pos;
15136 /* clear the start flag to avoid getting stuck here */
15137 options &= ~SEARCH_START;
15139 /* If the skip pattern matches, ignore this match. */
15140 if (*skip != NUL)
15142 save_pos = curwin->w_cursor;
15143 curwin->w_cursor = pos;
15144 r = eval_to_bool(skip, &err, NULL, FALSE);
15145 curwin->w_cursor = save_pos;
15146 if (err)
15148 /* Evaluating {skip} caused an error, break here. */
15149 curwin->w_cursor = save_cursor;
15150 retval = -1;
15151 break;
15153 if (r)
15154 continue;
15157 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15159 /* Found end when searching backwards or start when searching
15160 * forward: nested pair. */
15161 ++nest;
15162 pat = pat2; /* nested, don't search for middle */
15164 else
15166 /* Found end when searching forward or start when searching
15167 * backward: end of (nested) pair; or found middle in outer pair. */
15168 if (--nest == 1)
15169 pat = pat3; /* outer level, search for middle */
15172 if (nest == 0)
15174 /* Found the match: return matchcount or line number. */
15175 if (flags & SP_RETCOUNT)
15176 ++retval;
15177 else
15178 retval = pos.lnum;
15179 if (flags & SP_SETPCMARK)
15180 setpcmark();
15181 curwin->w_cursor = pos;
15182 if (!(flags & SP_REPEAT))
15183 break;
15184 nest = 1; /* search for next unmatched */
15188 if (match_pos != NULL)
15190 /* Store the match cursor position */
15191 match_pos->lnum = curwin->w_cursor.lnum;
15192 match_pos->col = curwin->w_cursor.col + 1;
15195 /* If 'n' flag is used or search failed: restore cursor position. */
15196 if ((flags & SP_NOMOVE) || retval == 0)
15197 curwin->w_cursor = save_cursor;
15199 theend:
15200 vim_free(pat2);
15201 vim_free(pat3);
15202 if (p_cpo == empty_option)
15203 p_cpo = save_cpo;
15204 else
15205 /* Darn, evaluating the {skip} expression changed the value. */
15206 free_string_option(save_cpo);
15208 return retval;
15212 * "searchpos()" function
15214 static void
15215 f_searchpos(argvars, rettv)
15216 typval_T *argvars;
15217 typval_T *rettv;
15219 pos_T match_pos;
15220 int lnum = 0;
15221 int col = 0;
15222 int n;
15223 int flags = 0;
15225 if (rettv_list_alloc(rettv) == FAIL)
15226 return;
15228 n = search_cmn(argvars, &match_pos, &flags);
15229 if (n > 0)
15231 lnum = match_pos.lnum;
15232 col = match_pos.col;
15235 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15236 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15237 if (flags & SP_SUBPAT)
15238 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15242 static void
15243 f_server2client(argvars, rettv)
15244 typval_T *argvars UNUSED;
15245 typval_T *rettv;
15247 #ifdef FEAT_CLIENTSERVER
15248 char_u buf[NUMBUFLEN];
15249 char_u *server = get_tv_string_chk(&argvars[0]);
15250 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15252 rettv->vval.v_number = -1;
15253 if (server == NULL || reply == NULL)
15254 return;
15255 if (check_restricted() || check_secure())
15256 return;
15257 # ifdef FEAT_X11
15258 if (check_connection() == FAIL)
15259 return;
15260 # endif
15262 if (serverSendReply(server, reply) < 0)
15264 EMSG(_("E258: Unable to send to client"));
15265 return;
15267 rettv->vval.v_number = 0;
15268 #else
15269 rettv->vval.v_number = -1;
15270 #endif
15273 static void
15274 f_serverlist(argvars, rettv)
15275 typval_T *argvars UNUSED;
15276 typval_T *rettv;
15278 char_u *r = NULL;
15280 #ifdef FEAT_CLIENTSERVER
15281 # if defined(WIN32) || defined(MAC_CLIENTSERVER)
15282 r = serverGetVimNames();
15283 # elif defined(FEAT_X11)
15284 make_connection();
15285 if (X_DISPLAY != NULL)
15286 r = serverGetVimNames(X_DISPLAY);
15287 # endif
15288 #endif
15289 rettv->v_type = VAR_STRING;
15290 rettv->vval.v_string = r;
15294 * "setbufvar()" function
15296 static void
15297 f_setbufvar(argvars, rettv)
15298 typval_T *argvars;
15299 typval_T *rettv UNUSED;
15301 buf_T *buf;
15302 aco_save_T aco;
15303 char_u *varname, *bufvarname;
15304 typval_T *varp;
15305 char_u nbuf[NUMBUFLEN];
15307 if (check_restricted() || check_secure())
15308 return;
15309 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15310 varname = get_tv_string_chk(&argvars[1]);
15311 buf = get_buf_tv(&argvars[0]);
15312 varp = &argvars[2];
15314 if (buf != NULL && varname != NULL && varp != NULL)
15316 /* set curbuf to be our buf, temporarily */
15317 aucmd_prepbuf(&aco, buf);
15319 if (*varname == '&')
15321 long numval;
15322 char_u *strval;
15323 int error = FALSE;
15325 ++varname;
15326 numval = get_tv_number_chk(varp, &error);
15327 strval = get_tv_string_buf_chk(varp, nbuf);
15328 if (!error && strval != NULL)
15329 set_option_value(varname, numval, strval, OPT_LOCAL);
15331 else
15333 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15334 if (bufvarname != NULL)
15336 STRCPY(bufvarname, "b:");
15337 STRCPY(bufvarname + 2, varname);
15338 set_var(bufvarname, varp, TRUE);
15339 vim_free(bufvarname);
15343 /* reset notion of buffer */
15344 aucmd_restbuf(&aco);
15349 * "setcmdpos()" function
15351 static void
15352 f_setcmdpos(argvars, rettv)
15353 typval_T *argvars;
15354 typval_T *rettv;
15356 int pos = (int)get_tv_number(&argvars[0]) - 1;
15358 if (pos >= 0)
15359 rettv->vval.v_number = set_cmdline_pos(pos);
15363 * "setline()" function
15365 static void
15366 f_setline(argvars, rettv)
15367 typval_T *argvars;
15368 typval_T *rettv;
15370 linenr_T lnum;
15371 char_u *line = NULL;
15372 list_T *l = NULL;
15373 listitem_T *li = NULL;
15374 long added = 0;
15375 linenr_T lcount = curbuf->b_ml.ml_line_count;
15377 lnum = get_tv_lnum(&argvars[0]);
15378 if (argvars[1].v_type == VAR_LIST)
15380 l = argvars[1].vval.v_list;
15381 li = l->lv_first;
15383 else
15384 line = get_tv_string_chk(&argvars[1]);
15386 /* default result is zero == OK */
15387 for (;;)
15389 if (l != NULL)
15391 /* list argument, get next string */
15392 if (li == NULL)
15393 break;
15394 line = get_tv_string_chk(&li->li_tv);
15395 li = li->li_next;
15398 rettv->vval.v_number = 1; /* FAIL */
15399 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15400 break;
15401 if (lnum <= curbuf->b_ml.ml_line_count)
15403 /* existing line, replace it */
15404 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15406 changed_bytes(lnum, 0);
15407 if (lnum == curwin->w_cursor.lnum)
15408 check_cursor_col();
15409 rettv->vval.v_number = 0; /* OK */
15412 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15414 /* lnum is one past the last line, append the line */
15415 ++added;
15416 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15417 rettv->vval.v_number = 0; /* OK */
15420 if (l == NULL) /* only one string argument */
15421 break;
15422 ++lnum;
15425 if (added > 0)
15426 appended_lines_mark(lcount, added);
15429 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15432 * Used by "setqflist()" and "setloclist()" functions
15434 static void
15435 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15436 win_T *wp UNUSED;
15437 typval_T *list_arg UNUSED;
15438 typval_T *action_arg UNUSED;
15439 typval_T *rettv;
15441 #ifdef FEAT_QUICKFIX
15442 char_u *act;
15443 int action = ' ';
15444 #endif
15446 rettv->vval.v_number = -1;
15448 #ifdef FEAT_QUICKFIX
15449 if (list_arg->v_type != VAR_LIST)
15450 EMSG(_(e_listreq));
15451 else
15453 list_T *l = list_arg->vval.v_list;
15455 if (action_arg->v_type == VAR_STRING)
15457 act = get_tv_string_chk(action_arg);
15458 if (act == NULL)
15459 return; /* type error; errmsg already given */
15460 if (*act == 'a' || *act == 'r')
15461 action = *act;
15464 if (l != NULL && set_errorlist(wp, l, action) == OK)
15465 rettv->vval.v_number = 0;
15467 #endif
15471 * "setloclist()" function
15473 static void
15474 f_setloclist(argvars, rettv)
15475 typval_T *argvars;
15476 typval_T *rettv;
15478 win_T *win;
15480 rettv->vval.v_number = -1;
15482 win = find_win_by_nr(&argvars[0], NULL);
15483 if (win != NULL)
15484 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15488 * "setmatches()" function
15490 static void
15491 f_setmatches(argvars, rettv)
15492 typval_T *argvars;
15493 typval_T *rettv;
15495 #ifdef FEAT_SEARCH_EXTRA
15496 list_T *l;
15497 listitem_T *li;
15498 dict_T *d;
15500 rettv->vval.v_number = -1;
15501 if (argvars[0].v_type != VAR_LIST)
15503 EMSG(_(e_listreq));
15504 return;
15506 if ((l = argvars[0].vval.v_list) != NULL)
15509 /* To some extent make sure that we are dealing with a list from
15510 * "getmatches()". */
15511 li = l->lv_first;
15512 while (li != NULL)
15514 if (li->li_tv.v_type != VAR_DICT
15515 || (d = li->li_tv.vval.v_dict) == NULL)
15517 EMSG(_(e_invarg));
15518 return;
15520 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15521 && dict_find(d, (char_u *)"pattern", -1) != NULL
15522 && dict_find(d, (char_u *)"priority", -1) != NULL
15523 && dict_find(d, (char_u *)"id", -1) != NULL))
15525 EMSG(_(e_invarg));
15526 return;
15528 li = li->li_next;
15531 clear_matches(curwin);
15532 li = l->lv_first;
15533 while (li != NULL)
15535 d = li->li_tv.vval.v_dict;
15536 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15537 get_dict_string(d, (char_u *)"pattern", FALSE),
15538 (int)get_dict_number(d, (char_u *)"priority"),
15539 (int)get_dict_number(d, (char_u *)"id"));
15540 li = li->li_next;
15542 rettv->vval.v_number = 0;
15544 #endif
15548 * "setpos()" function
15550 static void
15551 f_setpos(argvars, rettv)
15552 typval_T *argvars;
15553 typval_T *rettv;
15555 pos_T pos;
15556 int fnum;
15557 char_u *name;
15559 rettv->vval.v_number = -1;
15560 name = get_tv_string_chk(argvars);
15561 if (name != NULL)
15563 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15565 --pos.col;
15566 if (name[0] == '.' && name[1] == NUL)
15568 /* set cursor */
15569 if (fnum == curbuf->b_fnum)
15571 curwin->w_cursor = pos;
15572 check_cursor();
15573 rettv->vval.v_number = 0;
15575 else
15576 EMSG(_(e_invarg));
15578 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15580 /* set mark */
15581 if (setmark_pos(name[1], &pos, fnum) == OK)
15582 rettv->vval.v_number = 0;
15584 else
15585 EMSG(_(e_invarg));
15591 * "setqflist()" function
15593 static void
15594 f_setqflist(argvars, rettv)
15595 typval_T *argvars;
15596 typval_T *rettv;
15598 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15602 * "setreg()" function
15604 static void
15605 f_setreg(argvars, rettv)
15606 typval_T *argvars;
15607 typval_T *rettv;
15609 int regname;
15610 char_u *strregname;
15611 char_u *stropt;
15612 char_u *strval;
15613 int append;
15614 char_u yank_type;
15615 long block_len;
15617 block_len = -1;
15618 yank_type = MAUTO;
15619 append = FALSE;
15621 strregname = get_tv_string_chk(argvars);
15622 rettv->vval.v_number = 1; /* FAIL is default */
15624 if (strregname == NULL)
15625 return; /* type error; errmsg already given */
15626 regname = *strregname;
15627 if (regname == 0 || regname == '@')
15628 regname = '"';
15629 else if (regname == '=')
15630 return;
15632 if (argvars[2].v_type != VAR_UNKNOWN)
15634 stropt = get_tv_string_chk(&argvars[2]);
15635 if (stropt == NULL)
15636 return; /* type error */
15637 for (; *stropt != NUL; ++stropt)
15638 switch (*stropt)
15640 case 'a': case 'A': /* append */
15641 append = TRUE;
15642 break;
15643 case 'v': case 'c': /* character-wise selection */
15644 yank_type = MCHAR;
15645 break;
15646 case 'V': case 'l': /* line-wise selection */
15647 yank_type = MLINE;
15648 break;
15649 #ifdef FEAT_VISUAL
15650 case 'b': case Ctrl_V: /* block-wise selection */
15651 yank_type = MBLOCK;
15652 if (VIM_ISDIGIT(stropt[1]))
15654 ++stropt;
15655 block_len = getdigits(&stropt) - 1;
15656 --stropt;
15658 break;
15659 #endif
15663 strval = get_tv_string_chk(&argvars[1]);
15664 if (strval != NULL)
15665 write_reg_contents_ex(regname, strval, -1,
15666 append, yank_type, block_len);
15667 rettv->vval.v_number = 0;
15671 * "settabwinvar()" function
15673 static void
15674 f_settabwinvar(argvars, rettv)
15675 typval_T *argvars;
15676 typval_T *rettv;
15678 setwinvar(argvars, rettv, 1);
15682 * "setwinvar()" function
15684 static void
15685 f_setwinvar(argvars, rettv)
15686 typval_T *argvars;
15687 typval_T *rettv;
15689 setwinvar(argvars, rettv, 0);
15693 * "setwinvar()" and "settabwinvar()" functions
15695 static void
15696 setwinvar(argvars, rettv, off)
15697 typval_T *argvars;
15698 typval_T *rettv UNUSED;
15699 int off;
15701 win_T *win;
15702 #ifdef FEAT_WINDOWS
15703 win_T *save_curwin;
15704 tabpage_T *save_curtab;
15705 #endif
15706 char_u *varname, *winvarname;
15707 typval_T *varp;
15708 char_u nbuf[NUMBUFLEN];
15709 tabpage_T *tp;
15711 if (check_restricted() || check_secure())
15712 return;
15714 #ifdef FEAT_WINDOWS
15715 if (off == 1)
15716 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15717 else
15718 tp = curtab;
15719 #endif
15720 win = find_win_by_nr(&argvars[off], tp);
15721 varname = get_tv_string_chk(&argvars[off + 1]);
15722 varp = &argvars[off + 2];
15724 if (win != NULL && varname != NULL && varp != NULL)
15726 #ifdef FEAT_WINDOWS
15727 /* set curwin to be our win, temporarily */
15728 save_curwin = curwin;
15729 save_curtab = curtab;
15730 goto_tabpage_tp(tp);
15731 if (!win_valid(win))
15732 return;
15733 curwin = win;
15734 curbuf = curwin->w_buffer;
15735 #endif
15737 if (*varname == '&')
15739 long numval;
15740 char_u *strval;
15741 int error = FALSE;
15743 ++varname;
15744 numval = get_tv_number_chk(varp, &error);
15745 strval = get_tv_string_buf_chk(varp, nbuf);
15746 if (!error && strval != NULL)
15747 set_option_value(varname, numval, strval, OPT_LOCAL);
15749 else
15751 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15752 if (winvarname != NULL)
15754 STRCPY(winvarname, "w:");
15755 STRCPY(winvarname + 2, varname);
15756 set_var(winvarname, varp, TRUE);
15757 vim_free(winvarname);
15761 #ifdef FEAT_WINDOWS
15762 /* Restore current tabpage and window, if still valid (autocomands can
15763 * make them invalid). */
15764 if (valid_tabpage(save_curtab))
15765 goto_tabpage_tp(save_curtab);
15766 if (win_valid(save_curwin))
15768 curwin = save_curwin;
15769 curbuf = curwin->w_buffer;
15771 #endif
15776 * "shellescape({string})" function
15778 static void
15779 f_shellescape(argvars, rettv)
15780 typval_T *argvars;
15781 typval_T *rettv;
15783 rettv->vval.v_string = vim_strsave_shellescape(
15784 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15785 rettv->v_type = VAR_STRING;
15789 * "simplify()" function
15791 static void
15792 f_simplify(argvars, rettv)
15793 typval_T *argvars;
15794 typval_T *rettv;
15796 char_u *p;
15798 p = get_tv_string(&argvars[0]);
15799 rettv->vval.v_string = vim_strsave(p);
15800 simplify_filename(rettv->vval.v_string); /* simplify in place */
15801 rettv->v_type = VAR_STRING;
15804 #ifdef FEAT_FLOAT
15806 * "sin()" function
15808 static void
15809 f_sin(argvars, rettv)
15810 typval_T *argvars;
15811 typval_T *rettv;
15813 float_T f;
15815 rettv->v_type = VAR_FLOAT;
15816 if (get_float_arg(argvars, &f) == OK)
15817 rettv->vval.v_float = sin(f);
15818 else
15819 rettv->vval.v_float = 0.0;
15821 #endif
15823 static int
15824 #ifdef __BORLANDC__
15825 _RTLENTRYF
15826 #endif
15827 item_compare __ARGS((const void *s1, const void *s2));
15828 static int
15829 #ifdef __BORLANDC__
15830 _RTLENTRYF
15831 #endif
15832 item_compare2 __ARGS((const void *s1, const void *s2));
15834 static int item_compare_ic;
15835 static char_u *item_compare_func;
15836 static int item_compare_func_err;
15837 #define ITEM_COMPARE_FAIL 999
15840 * Compare functions for f_sort() below.
15842 static int
15843 #ifdef __BORLANDC__
15844 _RTLENTRYF
15845 #endif
15846 item_compare(s1, s2)
15847 const void *s1;
15848 const void *s2;
15850 char_u *p1, *p2;
15851 char_u *tofree1, *tofree2;
15852 int res;
15853 char_u numbuf1[NUMBUFLEN];
15854 char_u numbuf2[NUMBUFLEN];
15856 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15857 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15858 if (p1 == NULL)
15859 p1 = (char_u *)"";
15860 if (p2 == NULL)
15861 p2 = (char_u *)"";
15862 if (item_compare_ic)
15863 res = STRICMP(p1, p2);
15864 else
15865 res = STRCMP(p1, p2);
15866 vim_free(tofree1);
15867 vim_free(tofree2);
15868 return res;
15871 static int
15872 #ifdef __BORLANDC__
15873 _RTLENTRYF
15874 #endif
15875 item_compare2(s1, s2)
15876 const void *s1;
15877 const void *s2;
15879 int res;
15880 typval_T rettv;
15881 typval_T argv[3];
15882 int dummy;
15884 /* shortcut after failure in previous call; compare all items equal */
15885 if (item_compare_func_err)
15886 return 0;
15888 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15889 * in the copy without changing the original list items. */
15890 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15891 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15893 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15894 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15895 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15896 clear_tv(&argv[0]);
15897 clear_tv(&argv[1]);
15899 if (res == FAIL)
15900 res = ITEM_COMPARE_FAIL;
15901 else
15902 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15903 if (item_compare_func_err)
15904 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15905 clear_tv(&rettv);
15906 return res;
15910 * "sort({list})" function
15912 static void
15913 f_sort(argvars, rettv)
15914 typval_T *argvars;
15915 typval_T *rettv;
15917 list_T *l;
15918 listitem_T *li;
15919 listitem_T **ptrs;
15920 long len;
15921 long i;
15923 if (argvars[0].v_type != VAR_LIST)
15924 EMSG2(_(e_listarg), "sort()");
15925 else
15927 l = argvars[0].vval.v_list;
15928 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15929 return;
15930 rettv->vval.v_list = l;
15931 rettv->v_type = VAR_LIST;
15932 ++l->lv_refcount;
15934 len = list_len(l);
15935 if (len <= 1)
15936 return; /* short list sorts pretty quickly */
15938 item_compare_ic = FALSE;
15939 item_compare_func = NULL;
15940 if (argvars[1].v_type != VAR_UNKNOWN)
15942 if (argvars[1].v_type == VAR_FUNC)
15943 item_compare_func = argvars[1].vval.v_string;
15944 else
15946 int error = FALSE;
15948 i = get_tv_number_chk(&argvars[1], &error);
15949 if (error)
15950 return; /* type error; errmsg already given */
15951 if (i == 1)
15952 item_compare_ic = TRUE;
15953 else
15954 item_compare_func = get_tv_string(&argvars[1]);
15958 /* Make an array with each entry pointing to an item in the List. */
15959 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15960 if (ptrs == NULL)
15961 return;
15962 i = 0;
15963 for (li = l->lv_first; li != NULL; li = li->li_next)
15964 ptrs[i++] = li;
15966 item_compare_func_err = FALSE;
15967 /* test the compare function */
15968 if (item_compare_func != NULL
15969 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15970 == ITEM_COMPARE_FAIL)
15971 EMSG(_("E702: Sort compare function failed"));
15972 else
15974 /* Sort the array with item pointers. */
15975 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15976 item_compare_func == NULL ? item_compare : item_compare2);
15978 if (!item_compare_func_err)
15980 /* Clear the List and append the items in the sorted order. */
15981 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15982 l->lv_len = 0;
15983 for (i = 0; i < len; ++i)
15984 list_append(l, ptrs[i]);
15988 vim_free(ptrs);
15993 * "soundfold({word})" function
15995 static void
15996 f_soundfold(argvars, rettv)
15997 typval_T *argvars;
15998 typval_T *rettv;
16000 char_u *s;
16002 rettv->v_type = VAR_STRING;
16003 s = get_tv_string(&argvars[0]);
16004 #ifdef FEAT_SPELL
16005 rettv->vval.v_string = eval_soundfold(s);
16006 #else
16007 rettv->vval.v_string = vim_strsave(s);
16008 #endif
16012 * "spellbadword()" function
16014 static void
16015 f_spellbadword(argvars, rettv)
16016 typval_T *argvars UNUSED;
16017 typval_T *rettv;
16019 char_u *word = (char_u *)"";
16020 hlf_T attr = HLF_COUNT;
16021 int len = 0;
16023 if (rettv_list_alloc(rettv) == FAIL)
16024 return;
16026 #ifdef FEAT_SPELL
16027 if (argvars[0].v_type == VAR_UNKNOWN)
16029 /* Find the start and length of the badly spelled word. */
16030 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16031 if (len != 0)
16032 word = ml_get_cursor();
16034 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16036 char_u *str = get_tv_string_chk(&argvars[0]);
16037 int capcol = -1;
16039 if (str != NULL)
16041 /* Check the argument for spelling. */
16042 while (*str != NUL)
16044 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16045 if (attr != HLF_COUNT)
16047 word = str;
16048 break;
16050 str += len;
16054 #endif
16056 list_append_string(rettv->vval.v_list, word, len);
16057 list_append_string(rettv->vval.v_list, (char_u *)(
16058 attr == HLF_SPB ? "bad" :
16059 attr == HLF_SPR ? "rare" :
16060 attr == HLF_SPL ? "local" :
16061 attr == HLF_SPC ? "caps" :
16062 ""), -1);
16066 * "spellsuggest()" function
16068 static void
16069 f_spellsuggest(argvars, rettv)
16070 typval_T *argvars UNUSED;
16071 typval_T *rettv;
16073 #ifdef FEAT_SPELL
16074 char_u *str;
16075 int typeerr = FALSE;
16076 int maxcount;
16077 garray_T ga;
16078 int i;
16079 listitem_T *li;
16080 int need_capital = FALSE;
16081 #endif
16083 if (rettv_list_alloc(rettv) == FAIL)
16084 return;
16086 #ifdef FEAT_SPELL
16087 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16089 str = get_tv_string(&argvars[0]);
16090 if (argvars[1].v_type != VAR_UNKNOWN)
16092 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16093 if (maxcount <= 0)
16094 return;
16095 if (argvars[2].v_type != VAR_UNKNOWN)
16097 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16098 if (typeerr)
16099 return;
16102 else
16103 maxcount = 25;
16105 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16107 for (i = 0; i < ga.ga_len; ++i)
16109 str = ((char_u **)ga.ga_data)[i];
16111 li = listitem_alloc();
16112 if (li == NULL)
16113 vim_free(str);
16114 else
16116 li->li_tv.v_type = VAR_STRING;
16117 li->li_tv.v_lock = 0;
16118 li->li_tv.vval.v_string = str;
16119 list_append(rettv->vval.v_list, li);
16122 ga_clear(&ga);
16124 #endif
16127 static void
16128 f_split(argvars, rettv)
16129 typval_T *argvars;
16130 typval_T *rettv;
16132 char_u *str;
16133 char_u *end;
16134 char_u *pat = NULL;
16135 regmatch_T regmatch;
16136 char_u patbuf[NUMBUFLEN];
16137 char_u *save_cpo;
16138 int match;
16139 colnr_T col = 0;
16140 int keepempty = FALSE;
16141 int typeerr = FALSE;
16143 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16144 save_cpo = p_cpo;
16145 p_cpo = (char_u *)"";
16147 str = get_tv_string(&argvars[0]);
16148 if (argvars[1].v_type != VAR_UNKNOWN)
16150 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16151 if (pat == NULL)
16152 typeerr = TRUE;
16153 if (argvars[2].v_type != VAR_UNKNOWN)
16154 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16156 if (pat == NULL || *pat == NUL)
16157 pat = (char_u *)"[\\x01- ]\\+";
16159 if (rettv_list_alloc(rettv) == FAIL)
16160 return;
16161 if (typeerr)
16162 return;
16164 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16165 if (regmatch.regprog != NULL)
16167 regmatch.rm_ic = FALSE;
16168 while (*str != NUL || keepempty)
16170 if (*str == NUL)
16171 match = FALSE; /* empty item at the end */
16172 else
16173 match = vim_regexec_nl(&regmatch, str, col);
16174 if (match)
16175 end = regmatch.startp[0];
16176 else
16177 end = str + STRLEN(str);
16178 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16179 && *str != NUL && match && end < regmatch.endp[0]))
16181 if (list_append_string(rettv->vval.v_list, str,
16182 (int)(end - str)) == FAIL)
16183 break;
16185 if (!match)
16186 break;
16187 /* Advance to just after the match. */
16188 if (regmatch.endp[0] > str)
16189 col = 0;
16190 else
16192 /* Don't get stuck at the same match. */
16193 #ifdef FEAT_MBYTE
16194 col = (*mb_ptr2len)(regmatch.endp[0]);
16195 #else
16196 col = 1;
16197 #endif
16199 str = regmatch.endp[0];
16202 vim_free(regmatch.regprog);
16205 p_cpo = save_cpo;
16208 #ifdef FEAT_FLOAT
16210 * "sqrt()" function
16212 static void
16213 f_sqrt(argvars, rettv)
16214 typval_T *argvars;
16215 typval_T *rettv;
16217 float_T f;
16219 rettv->v_type = VAR_FLOAT;
16220 if (get_float_arg(argvars, &f) == OK)
16221 rettv->vval.v_float = sqrt(f);
16222 else
16223 rettv->vval.v_float = 0.0;
16227 * "str2float()" function
16229 static void
16230 f_str2float(argvars, rettv)
16231 typval_T *argvars;
16232 typval_T *rettv;
16234 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16236 if (*p == '+')
16237 p = skipwhite(p + 1);
16238 (void)string2float(p, &rettv->vval.v_float);
16239 rettv->v_type = VAR_FLOAT;
16241 #endif
16244 * "str2nr()" function
16246 static void
16247 f_str2nr(argvars, rettv)
16248 typval_T *argvars;
16249 typval_T *rettv;
16251 int base = 10;
16252 char_u *p;
16253 long n;
16255 if (argvars[1].v_type != VAR_UNKNOWN)
16257 base = get_tv_number(&argvars[1]);
16258 if (base != 8 && base != 10 && base != 16)
16260 EMSG(_(e_invarg));
16261 return;
16265 p = skipwhite(get_tv_string(&argvars[0]));
16266 if (*p == '+')
16267 p = skipwhite(p + 1);
16268 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16269 rettv->vval.v_number = n;
16272 #ifdef HAVE_STRFTIME
16274 * "strftime({format}[, {time}])" function
16276 static void
16277 f_strftime(argvars, rettv)
16278 typval_T *argvars;
16279 typval_T *rettv;
16281 char_u result_buf[256];
16282 struct tm *curtime;
16283 time_t seconds;
16284 char_u *p;
16286 rettv->v_type = VAR_STRING;
16288 p = get_tv_string(&argvars[0]);
16289 if (argvars[1].v_type == VAR_UNKNOWN)
16290 seconds = time(NULL);
16291 else
16292 seconds = (time_t)get_tv_number(&argvars[1]);
16293 curtime = localtime(&seconds);
16294 /* MSVC returns NULL for an invalid value of seconds. */
16295 if (curtime == NULL)
16296 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16297 else
16299 # ifdef FEAT_MBYTE
16300 vimconv_T conv;
16301 char_u *enc;
16303 conv.vc_type = CONV_NONE;
16304 enc = enc_locale();
16305 convert_setup(&conv, p_enc, enc);
16306 if (conv.vc_type != CONV_NONE)
16307 p = string_convert(&conv, p, NULL);
16308 # endif
16309 if (p != NULL)
16310 (void)strftime((char *)result_buf, sizeof(result_buf),
16311 (char *)p, curtime);
16312 else
16313 result_buf[0] = NUL;
16315 # ifdef FEAT_MBYTE
16316 if (conv.vc_type != CONV_NONE)
16317 vim_free(p);
16318 convert_setup(&conv, enc, p_enc);
16319 if (conv.vc_type != CONV_NONE)
16320 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16321 else
16322 # endif
16323 rettv->vval.v_string = vim_strsave(result_buf);
16325 # ifdef FEAT_MBYTE
16326 /* Release conversion descriptors */
16327 convert_setup(&conv, NULL, NULL);
16328 vim_free(enc);
16329 # endif
16332 #endif
16335 * "stridx()" function
16337 static void
16338 f_stridx(argvars, rettv)
16339 typval_T *argvars;
16340 typval_T *rettv;
16342 char_u buf[NUMBUFLEN];
16343 char_u *needle;
16344 char_u *haystack;
16345 char_u *save_haystack;
16346 char_u *pos;
16347 int start_idx;
16349 needle = get_tv_string_chk(&argvars[1]);
16350 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16351 rettv->vval.v_number = -1;
16352 if (needle == NULL || haystack == NULL)
16353 return; /* type error; errmsg already given */
16355 if (argvars[2].v_type != VAR_UNKNOWN)
16357 int error = FALSE;
16359 start_idx = get_tv_number_chk(&argvars[2], &error);
16360 if (error || start_idx >= (int)STRLEN(haystack))
16361 return;
16362 if (start_idx >= 0)
16363 haystack += start_idx;
16366 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16367 if (pos != NULL)
16368 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16372 * "string()" function
16374 static void
16375 f_string(argvars, rettv)
16376 typval_T *argvars;
16377 typval_T *rettv;
16379 char_u *tofree;
16380 char_u numbuf[NUMBUFLEN];
16382 rettv->v_type = VAR_STRING;
16383 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16384 /* Make a copy if we have a value but it's not in allocated memory. */
16385 if (rettv->vval.v_string != NULL && tofree == NULL)
16386 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16390 * "strlen()" function
16392 static void
16393 f_strlen(argvars, rettv)
16394 typval_T *argvars;
16395 typval_T *rettv;
16397 rettv->vval.v_number = (varnumber_T)(STRLEN(
16398 get_tv_string(&argvars[0])));
16402 * "strpart()" function
16404 static void
16405 f_strpart(argvars, rettv)
16406 typval_T *argvars;
16407 typval_T *rettv;
16409 char_u *p;
16410 int n;
16411 int len;
16412 int slen;
16413 int error = FALSE;
16415 p = get_tv_string(&argvars[0]);
16416 slen = (int)STRLEN(p);
16418 n = get_tv_number_chk(&argvars[1], &error);
16419 if (error)
16420 len = 0;
16421 else if (argvars[2].v_type != VAR_UNKNOWN)
16422 len = get_tv_number(&argvars[2]);
16423 else
16424 len = slen - n; /* default len: all bytes that are available. */
16427 * Only return the overlap between the specified part and the actual
16428 * string.
16430 if (n < 0)
16432 len += n;
16433 n = 0;
16435 else if (n > slen)
16436 n = slen;
16437 if (len < 0)
16438 len = 0;
16439 else if (n + len > slen)
16440 len = slen - n;
16442 rettv->v_type = VAR_STRING;
16443 rettv->vval.v_string = vim_strnsave(p + n, len);
16447 * "strridx()" function
16449 static void
16450 f_strridx(argvars, rettv)
16451 typval_T *argvars;
16452 typval_T *rettv;
16454 char_u buf[NUMBUFLEN];
16455 char_u *needle;
16456 char_u *haystack;
16457 char_u *rest;
16458 char_u *lastmatch = NULL;
16459 int haystack_len, end_idx;
16461 needle = get_tv_string_chk(&argvars[1]);
16462 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16464 rettv->vval.v_number = -1;
16465 if (needle == NULL || haystack == NULL)
16466 return; /* type error; errmsg already given */
16468 haystack_len = (int)STRLEN(haystack);
16469 if (argvars[2].v_type != VAR_UNKNOWN)
16471 /* Third argument: upper limit for index */
16472 end_idx = get_tv_number_chk(&argvars[2], NULL);
16473 if (end_idx < 0)
16474 return; /* can never find a match */
16476 else
16477 end_idx = haystack_len;
16479 if (*needle == NUL)
16481 /* Empty string matches past the end. */
16482 lastmatch = haystack + end_idx;
16484 else
16486 for (rest = haystack; *rest != '\0'; ++rest)
16488 rest = (char_u *)strstr((char *)rest, (char *)needle);
16489 if (rest == NULL || rest > haystack + end_idx)
16490 break;
16491 lastmatch = rest;
16495 if (lastmatch == NULL)
16496 rettv->vval.v_number = -1;
16497 else
16498 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16502 * "strtrans()" function
16504 static void
16505 f_strtrans(argvars, rettv)
16506 typval_T *argvars;
16507 typval_T *rettv;
16509 rettv->v_type = VAR_STRING;
16510 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16514 * "submatch()" function
16516 static void
16517 f_submatch(argvars, rettv)
16518 typval_T *argvars;
16519 typval_T *rettv;
16521 rettv->v_type = VAR_STRING;
16522 rettv->vval.v_string =
16523 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16527 * "substitute()" function
16529 static void
16530 f_substitute(argvars, rettv)
16531 typval_T *argvars;
16532 typval_T *rettv;
16534 char_u patbuf[NUMBUFLEN];
16535 char_u subbuf[NUMBUFLEN];
16536 char_u flagsbuf[NUMBUFLEN];
16538 char_u *str = get_tv_string_chk(&argvars[0]);
16539 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16540 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16541 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16543 rettv->v_type = VAR_STRING;
16544 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16545 rettv->vval.v_string = NULL;
16546 else
16547 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16551 * "synID(lnum, col, trans)" function
16553 static void
16554 f_synID(argvars, rettv)
16555 typval_T *argvars UNUSED;
16556 typval_T *rettv;
16558 int id = 0;
16559 #ifdef FEAT_SYN_HL
16560 long lnum;
16561 long col;
16562 int trans;
16563 int transerr = FALSE;
16565 lnum = get_tv_lnum(argvars); /* -1 on type error */
16566 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16567 trans = get_tv_number_chk(&argvars[2], &transerr);
16569 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16570 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16571 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16572 #endif
16574 rettv->vval.v_number = id;
16578 * "synIDattr(id, what [, mode])" function
16580 static void
16581 f_synIDattr(argvars, rettv)
16582 typval_T *argvars UNUSED;
16583 typval_T *rettv;
16585 char_u *p = NULL;
16586 #ifdef FEAT_SYN_HL
16587 int id;
16588 char_u *what;
16589 char_u *mode;
16590 char_u modebuf[NUMBUFLEN];
16591 int modec;
16593 id = get_tv_number(&argvars[0]);
16594 what = get_tv_string(&argvars[1]);
16595 if (argvars[2].v_type != VAR_UNKNOWN)
16597 mode = get_tv_string_buf(&argvars[2], modebuf);
16598 modec = TOLOWER_ASC(mode[0]);
16599 if (modec != 't' && modec != 'c'
16600 #ifdef FEAT_GUI
16601 && modec != 'g'
16602 #endif
16604 modec = 0; /* replace invalid with current */
16606 else
16608 #ifdef FEAT_GUI
16609 if (gui.in_use)
16610 modec = 'g';
16611 else
16612 #endif
16613 if (t_colors > 1)
16614 modec = 'c';
16615 else
16616 modec = 't';
16620 switch (TOLOWER_ASC(what[0]))
16622 case 'b':
16623 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16624 p = highlight_color(id, what, modec);
16625 else /* bold */
16626 p = highlight_has_attr(id, HL_BOLD, modec);
16627 break;
16629 case 'f': /* fg[#] */
16630 p = highlight_color(id, what, modec);
16631 break;
16633 case 'i':
16634 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16635 p = highlight_has_attr(id, HL_INVERSE, modec);
16636 else /* italic */
16637 p = highlight_has_attr(id, HL_ITALIC, modec);
16638 break;
16640 case 'n': /* name */
16641 p = get_highlight_name(NULL, id - 1);
16642 break;
16644 case 'r': /* reverse */
16645 p = highlight_has_attr(id, HL_INVERSE, modec);
16646 break;
16648 case 's':
16649 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16650 p = highlight_color(id, what, modec);
16651 else /* standout */
16652 p = highlight_has_attr(id, HL_STANDOUT, modec);
16653 break;
16655 case 'u':
16656 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16657 /* underline */
16658 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16659 else
16660 /* undercurl */
16661 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16662 break;
16665 if (p != NULL)
16666 p = vim_strsave(p);
16667 #endif
16668 rettv->v_type = VAR_STRING;
16669 rettv->vval.v_string = p;
16673 * "synIDtrans(id)" function
16675 static void
16676 f_synIDtrans(argvars, rettv)
16677 typval_T *argvars UNUSED;
16678 typval_T *rettv;
16680 int id;
16682 #ifdef FEAT_SYN_HL
16683 id = get_tv_number(&argvars[0]);
16685 if (id > 0)
16686 id = syn_get_final_id(id);
16687 else
16688 #endif
16689 id = 0;
16691 rettv->vval.v_number = id;
16695 * "synstack(lnum, col)" function
16697 static void
16698 f_synstack(argvars, rettv)
16699 typval_T *argvars UNUSED;
16700 typval_T *rettv;
16702 #ifdef FEAT_SYN_HL
16703 long lnum;
16704 long col;
16705 int i;
16706 int id;
16707 #endif
16709 rettv->v_type = VAR_LIST;
16710 rettv->vval.v_list = NULL;
16712 #ifdef FEAT_SYN_HL
16713 lnum = get_tv_lnum(argvars); /* -1 on type error */
16714 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16716 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16717 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16718 && rettv_list_alloc(rettv) != FAIL)
16720 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16721 for (i = 0; ; ++i)
16723 id = syn_get_stack_item(i);
16724 if (id < 0)
16725 break;
16726 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16727 break;
16730 #endif
16734 * "system()" function
16736 static void
16737 f_system(argvars, rettv)
16738 typval_T *argvars;
16739 typval_T *rettv;
16741 char_u *res = NULL;
16742 char_u *p;
16743 char_u *infile = NULL;
16744 char_u buf[NUMBUFLEN];
16745 int err = FALSE;
16746 FILE *fd;
16748 if (check_restricted() || check_secure())
16749 goto done;
16751 if (argvars[1].v_type != VAR_UNKNOWN)
16754 * Write the string to a temp file, to be used for input of the shell
16755 * command.
16757 if ((infile = vim_tempname('i')) == NULL)
16759 EMSG(_(e_notmp));
16760 goto done;
16763 fd = mch_fopen((char *)infile, WRITEBIN);
16764 if (fd == NULL)
16766 EMSG2(_(e_notopen), infile);
16767 goto done;
16769 p = get_tv_string_buf_chk(&argvars[1], buf);
16770 if (p == NULL)
16772 fclose(fd);
16773 goto done; /* type error; errmsg already given */
16775 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16776 err = TRUE;
16777 if (fclose(fd) != 0)
16778 err = TRUE;
16779 if (err)
16781 EMSG(_("E677: Error writing temp file"));
16782 goto done;
16786 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16787 SHELL_SILENT | SHELL_COOKED);
16789 #ifdef USE_CR
16790 /* translate <CR> into <NL> */
16791 if (res != NULL)
16793 char_u *s;
16795 for (s = res; *s; ++s)
16797 if (*s == CAR)
16798 *s = NL;
16801 #else
16802 # ifdef USE_CRNL
16803 /* translate <CR><NL> into <NL> */
16804 if (res != NULL)
16806 char_u *s, *d;
16808 d = res;
16809 for (s = res; *s; ++s)
16811 if (s[0] == CAR && s[1] == NL)
16812 ++s;
16813 *d++ = *s;
16815 *d = NUL;
16817 # endif
16818 #endif
16820 done:
16821 if (infile != NULL)
16823 mch_remove(infile);
16824 vim_free(infile);
16826 rettv->v_type = VAR_STRING;
16827 rettv->vval.v_string = res;
16831 * "tabpagebuflist()" function
16833 static void
16834 f_tabpagebuflist(argvars, rettv)
16835 typval_T *argvars UNUSED;
16836 typval_T *rettv UNUSED;
16838 #ifdef FEAT_WINDOWS
16839 tabpage_T *tp;
16840 win_T *wp = NULL;
16842 if (argvars[0].v_type == VAR_UNKNOWN)
16843 wp = firstwin;
16844 else
16846 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16847 if (tp != NULL)
16848 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16850 if (wp != NULL && rettv_list_alloc(rettv) != FAIL)
16852 for (; wp != NULL; wp = wp->w_next)
16853 if (list_append_number(rettv->vval.v_list,
16854 wp->w_buffer->b_fnum) == FAIL)
16855 break;
16857 #endif
16862 * "tabpagenr()" function
16864 static void
16865 f_tabpagenr(argvars, rettv)
16866 typval_T *argvars UNUSED;
16867 typval_T *rettv;
16869 int nr = 1;
16870 #ifdef FEAT_WINDOWS
16871 char_u *arg;
16873 if (argvars[0].v_type != VAR_UNKNOWN)
16875 arg = get_tv_string_chk(&argvars[0]);
16876 nr = 0;
16877 if (arg != NULL)
16879 if (STRCMP(arg, "$") == 0)
16880 nr = tabpage_index(NULL) - 1;
16881 else
16882 EMSG2(_(e_invexpr2), arg);
16885 else
16886 nr = tabpage_index(curtab);
16887 #endif
16888 rettv->vval.v_number = nr;
16892 #ifdef FEAT_WINDOWS
16893 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16896 * Common code for tabpagewinnr() and winnr().
16898 static int
16899 get_winnr(tp, argvar)
16900 tabpage_T *tp;
16901 typval_T *argvar;
16903 win_T *twin;
16904 int nr = 1;
16905 win_T *wp;
16906 char_u *arg;
16908 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16909 if (argvar->v_type != VAR_UNKNOWN)
16911 arg = get_tv_string_chk(argvar);
16912 if (arg == NULL)
16913 nr = 0; /* type error; errmsg already given */
16914 else if (STRCMP(arg, "$") == 0)
16915 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16916 else if (STRCMP(arg, "#") == 0)
16918 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16919 if (twin == NULL)
16920 nr = 0;
16922 else
16924 EMSG2(_(e_invexpr2), arg);
16925 nr = 0;
16929 if (nr > 0)
16930 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16931 wp != twin; wp = wp->w_next)
16933 if (wp == NULL)
16935 /* didn't find it in this tabpage */
16936 nr = 0;
16937 break;
16939 ++nr;
16941 return nr;
16943 #endif
16946 * "tabpagewinnr()" function
16948 static void
16949 f_tabpagewinnr(argvars, rettv)
16950 typval_T *argvars UNUSED;
16951 typval_T *rettv;
16953 int nr = 1;
16954 #ifdef FEAT_WINDOWS
16955 tabpage_T *tp;
16957 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16958 if (tp == NULL)
16959 nr = 0;
16960 else
16961 nr = get_winnr(tp, &argvars[1]);
16962 #endif
16963 rettv->vval.v_number = nr;
16968 * "tagfiles()" function
16970 static void
16971 f_tagfiles(argvars, rettv)
16972 typval_T *argvars UNUSED;
16973 typval_T *rettv;
16975 char_u fname[MAXPATHL + 1];
16976 tagname_T tn;
16977 int first;
16979 if (rettv_list_alloc(rettv) == FAIL)
16980 return;
16982 for (first = TRUE; ; first = FALSE)
16983 if (get_tagfname(&tn, first, fname) == FAIL
16984 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
16985 break;
16986 tagname_free(&tn);
16990 * "taglist()" function
16992 static void
16993 f_taglist(argvars, rettv)
16994 typval_T *argvars;
16995 typval_T *rettv;
16997 char_u *tag_pattern;
16999 tag_pattern = get_tv_string(&argvars[0]);
17001 rettv->vval.v_number = FALSE;
17002 if (*tag_pattern == NUL)
17003 return;
17005 if (rettv_list_alloc(rettv) == OK)
17006 (void)get_tags(rettv->vval.v_list, tag_pattern);
17010 * "tempname()" function
17012 static void
17013 f_tempname(argvars, rettv)
17014 typval_T *argvars UNUSED;
17015 typval_T *rettv;
17017 static int x = 'A';
17019 rettv->v_type = VAR_STRING;
17020 rettv->vval.v_string = vim_tempname(x);
17022 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17023 * names. Skip 'I' and 'O', they are used for shell redirection. */
17026 if (x == 'Z')
17027 x = '0';
17028 else if (x == '9')
17029 x = 'A';
17030 else
17032 #ifdef EBCDIC
17033 if (x == 'I')
17034 x = 'J';
17035 else if (x == 'R')
17036 x = 'S';
17037 else
17038 #endif
17039 ++x;
17041 } while (x == 'I' || x == 'O');
17045 * "test(list)" function: Just checking the walls...
17047 static void
17048 f_test(argvars, rettv)
17049 typval_T *argvars UNUSED;
17050 typval_T *rettv UNUSED;
17052 /* Used for unit testing. Change the code below to your liking. */
17053 #if 0
17054 listitem_T *li;
17055 list_T *l;
17056 char_u *bad, *good;
17058 if (argvars[0].v_type != VAR_LIST)
17059 return;
17060 l = argvars[0].vval.v_list;
17061 if (l == NULL)
17062 return;
17063 li = l->lv_first;
17064 if (li == NULL)
17065 return;
17066 bad = get_tv_string(&li->li_tv);
17067 li = li->li_next;
17068 if (li == NULL)
17069 return;
17070 good = get_tv_string(&li->li_tv);
17071 rettv->vval.v_number = test_edit_score(bad, good);
17072 #endif
17076 * "tolower(string)" function
17078 static void
17079 f_tolower(argvars, rettv)
17080 typval_T *argvars;
17081 typval_T *rettv;
17083 char_u *p;
17085 p = vim_strsave(get_tv_string(&argvars[0]));
17086 rettv->v_type = VAR_STRING;
17087 rettv->vval.v_string = p;
17089 if (p != NULL)
17090 while (*p != NUL)
17092 #ifdef FEAT_MBYTE
17093 int l;
17095 if (enc_utf8)
17097 int c, lc;
17099 c = utf_ptr2char(p);
17100 lc = utf_tolower(c);
17101 l = utf_ptr2len(p);
17102 /* TODO: reallocate string when byte count changes. */
17103 if (utf_char2len(lc) == l)
17104 utf_char2bytes(lc, p);
17105 p += l;
17107 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17108 p += l; /* skip multi-byte character */
17109 else
17110 #endif
17112 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17113 ++p;
17119 * "toupper(string)" function
17121 static void
17122 f_toupper(argvars, rettv)
17123 typval_T *argvars;
17124 typval_T *rettv;
17126 rettv->v_type = VAR_STRING;
17127 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17131 * "tr(string, fromstr, tostr)" function
17133 static void
17134 f_tr(argvars, rettv)
17135 typval_T *argvars;
17136 typval_T *rettv;
17138 char_u *instr;
17139 char_u *fromstr;
17140 char_u *tostr;
17141 char_u *p;
17142 #ifdef FEAT_MBYTE
17143 int inlen;
17144 int fromlen;
17145 int tolen;
17146 int idx;
17147 char_u *cpstr;
17148 int cplen;
17149 int first = TRUE;
17150 #endif
17151 char_u buf[NUMBUFLEN];
17152 char_u buf2[NUMBUFLEN];
17153 garray_T ga;
17155 instr = get_tv_string(&argvars[0]);
17156 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17157 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17159 /* Default return value: empty string. */
17160 rettv->v_type = VAR_STRING;
17161 rettv->vval.v_string = NULL;
17162 if (fromstr == NULL || tostr == NULL)
17163 return; /* type error; errmsg already given */
17164 ga_init2(&ga, (int)sizeof(char), 80);
17166 #ifdef FEAT_MBYTE
17167 if (!has_mbyte)
17168 #endif
17169 /* not multi-byte: fromstr and tostr must be the same length */
17170 if (STRLEN(fromstr) != STRLEN(tostr))
17172 #ifdef FEAT_MBYTE
17173 error:
17174 #endif
17175 EMSG2(_(e_invarg2), fromstr);
17176 ga_clear(&ga);
17177 return;
17180 /* fromstr and tostr have to contain the same number of chars */
17181 while (*instr != NUL)
17183 #ifdef FEAT_MBYTE
17184 if (has_mbyte)
17186 inlen = (*mb_ptr2len)(instr);
17187 cpstr = instr;
17188 cplen = inlen;
17189 idx = 0;
17190 for (p = fromstr; *p != NUL; p += fromlen)
17192 fromlen = (*mb_ptr2len)(p);
17193 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17195 for (p = tostr; *p != NUL; p += tolen)
17197 tolen = (*mb_ptr2len)(p);
17198 if (idx-- == 0)
17200 cplen = tolen;
17201 cpstr = p;
17202 break;
17205 if (*p == NUL) /* tostr is shorter than fromstr */
17206 goto error;
17207 break;
17209 ++idx;
17212 if (first && cpstr == instr)
17214 /* Check that fromstr and tostr have the same number of
17215 * (multi-byte) characters. Done only once when a character
17216 * of instr doesn't appear in fromstr. */
17217 first = FALSE;
17218 for (p = tostr; *p != NUL; p += tolen)
17220 tolen = (*mb_ptr2len)(p);
17221 --idx;
17223 if (idx != 0)
17224 goto error;
17227 ga_grow(&ga, cplen);
17228 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17229 ga.ga_len += cplen;
17231 instr += inlen;
17233 else
17234 #endif
17236 /* When not using multi-byte chars we can do it faster. */
17237 p = vim_strchr(fromstr, *instr);
17238 if (p != NULL)
17239 ga_append(&ga, tostr[p - fromstr]);
17240 else
17241 ga_append(&ga, *instr);
17242 ++instr;
17246 /* add a terminating NUL */
17247 ga_grow(&ga, 1);
17248 ga_append(&ga, NUL);
17250 rettv->vval.v_string = ga.ga_data;
17253 #ifdef FEAT_FLOAT
17255 * "trunc({float})" function
17257 static void
17258 f_trunc(argvars, rettv)
17259 typval_T *argvars;
17260 typval_T *rettv;
17262 float_T f;
17264 rettv->v_type = VAR_FLOAT;
17265 if (get_float_arg(argvars, &f) == OK)
17266 /* trunc() is not in C90, use floor() or ceil() instead. */
17267 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17268 else
17269 rettv->vval.v_float = 0.0;
17271 #endif
17274 * "type(expr)" function
17276 static void
17277 f_type(argvars, rettv)
17278 typval_T *argvars;
17279 typval_T *rettv;
17281 int n;
17283 switch (argvars[0].v_type)
17285 case VAR_NUMBER: n = 0; break;
17286 case VAR_STRING: n = 1; break;
17287 case VAR_FUNC: n = 2; break;
17288 case VAR_LIST: n = 3; break;
17289 case VAR_DICT: n = 4; break;
17290 #ifdef FEAT_FLOAT
17291 case VAR_FLOAT: n = 5; break;
17292 #endif
17293 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17295 rettv->vval.v_number = n;
17299 * "values(dict)" function
17301 static void
17302 f_values(argvars, rettv)
17303 typval_T *argvars;
17304 typval_T *rettv;
17306 dict_list(argvars, rettv, 1);
17310 * "virtcol(string)" function
17312 static void
17313 f_virtcol(argvars, rettv)
17314 typval_T *argvars;
17315 typval_T *rettv;
17317 colnr_T vcol = 0;
17318 pos_T *fp;
17319 int fnum = curbuf->b_fnum;
17321 fp = var2fpos(&argvars[0], FALSE, &fnum);
17322 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17323 && fnum == curbuf->b_fnum)
17325 getvvcol(curwin, fp, NULL, NULL, &vcol);
17326 ++vcol;
17329 rettv->vval.v_number = vcol;
17333 * "visualmode()" function
17335 static void
17336 f_visualmode(argvars, rettv)
17337 typval_T *argvars UNUSED;
17338 typval_T *rettv UNUSED;
17340 #ifdef FEAT_VISUAL
17341 char_u str[2];
17343 rettv->v_type = VAR_STRING;
17344 str[0] = curbuf->b_visual_mode_eval;
17345 str[1] = NUL;
17346 rettv->vval.v_string = vim_strsave(str);
17348 /* A non-zero number or non-empty string argument: reset mode. */
17349 if (non_zero_arg(&argvars[0]))
17350 curbuf->b_visual_mode_eval = NUL;
17351 #endif
17355 * "winbufnr(nr)" function
17357 static void
17358 f_winbufnr(argvars, rettv)
17359 typval_T *argvars;
17360 typval_T *rettv;
17362 win_T *wp;
17364 wp = find_win_by_nr(&argvars[0], NULL);
17365 if (wp == NULL)
17366 rettv->vval.v_number = -1;
17367 else
17368 rettv->vval.v_number = wp->w_buffer->b_fnum;
17372 * "wincol()" function
17374 static void
17375 f_wincol(argvars, rettv)
17376 typval_T *argvars UNUSED;
17377 typval_T *rettv;
17379 validate_cursor();
17380 rettv->vval.v_number = curwin->w_wcol + 1;
17384 * "winheight(nr)" function
17386 static void
17387 f_winheight(argvars, rettv)
17388 typval_T *argvars;
17389 typval_T *rettv;
17391 win_T *wp;
17393 wp = find_win_by_nr(&argvars[0], NULL);
17394 if (wp == NULL)
17395 rettv->vval.v_number = -1;
17396 else
17397 rettv->vval.v_number = wp->w_height;
17401 * "winline()" function
17403 static void
17404 f_winline(argvars, rettv)
17405 typval_T *argvars UNUSED;
17406 typval_T *rettv;
17408 validate_cursor();
17409 rettv->vval.v_number = curwin->w_wrow + 1;
17413 * "winnr()" function
17415 static void
17416 f_winnr(argvars, rettv)
17417 typval_T *argvars UNUSED;
17418 typval_T *rettv;
17420 int nr = 1;
17422 #ifdef FEAT_WINDOWS
17423 nr = get_winnr(curtab, &argvars[0]);
17424 #endif
17425 rettv->vval.v_number = nr;
17429 * "winrestcmd()" function
17431 static void
17432 f_winrestcmd(argvars, rettv)
17433 typval_T *argvars UNUSED;
17434 typval_T *rettv;
17436 #ifdef FEAT_WINDOWS
17437 win_T *wp;
17438 int winnr = 1;
17439 garray_T ga;
17440 char_u buf[50];
17442 ga_init2(&ga, (int)sizeof(char), 70);
17443 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17445 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17446 ga_concat(&ga, buf);
17447 # ifdef FEAT_VERTSPLIT
17448 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17449 ga_concat(&ga, buf);
17450 # endif
17451 ++winnr;
17453 ga_append(&ga, NUL);
17455 rettv->vval.v_string = ga.ga_data;
17456 #else
17457 rettv->vval.v_string = NULL;
17458 #endif
17459 rettv->v_type = VAR_STRING;
17463 * "winrestview()" function
17465 static void
17466 f_winrestview(argvars, rettv)
17467 typval_T *argvars;
17468 typval_T *rettv UNUSED;
17470 dict_T *dict;
17472 if (argvars[0].v_type != VAR_DICT
17473 || (dict = argvars[0].vval.v_dict) == NULL)
17474 EMSG(_(e_invarg));
17475 else
17477 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17478 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17479 #ifdef FEAT_VIRTUALEDIT
17480 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17481 #endif
17482 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17483 curwin->w_set_curswant = FALSE;
17485 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17486 #ifdef FEAT_DIFF
17487 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17488 #endif
17489 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17490 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17492 check_cursor();
17493 changed_cline_bef_curs();
17494 invalidate_botline();
17495 redraw_later(VALID);
17497 if (curwin->w_topline == 0)
17498 curwin->w_topline = 1;
17499 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17500 curwin->w_topline = curbuf->b_ml.ml_line_count;
17501 #ifdef FEAT_DIFF
17502 check_topfill(curwin, TRUE);
17503 #endif
17508 * "winsaveview()" function
17510 static void
17511 f_winsaveview(argvars, rettv)
17512 typval_T *argvars UNUSED;
17513 typval_T *rettv;
17515 dict_T *dict;
17517 dict = dict_alloc();
17518 if (dict == NULL)
17519 return;
17520 rettv->v_type = VAR_DICT;
17521 rettv->vval.v_dict = dict;
17522 ++dict->dv_refcount;
17524 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17525 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17526 #ifdef FEAT_VIRTUALEDIT
17527 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17528 #endif
17529 update_curswant();
17530 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17532 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17533 #ifdef FEAT_DIFF
17534 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17535 #endif
17536 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17537 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17541 * "winwidth(nr)" function
17543 static void
17544 f_winwidth(argvars, rettv)
17545 typval_T *argvars;
17546 typval_T *rettv;
17548 win_T *wp;
17550 wp = find_win_by_nr(&argvars[0], NULL);
17551 if (wp == NULL)
17552 rettv->vval.v_number = -1;
17553 else
17554 #ifdef FEAT_VERTSPLIT
17555 rettv->vval.v_number = wp->w_width;
17556 #else
17557 rettv->vval.v_number = Columns;
17558 #endif
17562 * "writefile()" function
17564 static void
17565 f_writefile(argvars, rettv)
17566 typval_T *argvars;
17567 typval_T *rettv;
17569 int binary = FALSE;
17570 char_u *fname;
17571 FILE *fd;
17572 listitem_T *li;
17573 char_u *s;
17574 int ret = 0;
17575 int c;
17577 if (check_restricted() || check_secure())
17578 return;
17580 if (argvars[0].v_type != VAR_LIST)
17582 EMSG2(_(e_listarg), "writefile()");
17583 return;
17585 if (argvars[0].vval.v_list == NULL)
17586 return;
17588 if (argvars[2].v_type != VAR_UNKNOWN
17589 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17590 binary = TRUE;
17592 /* Always open the file in binary mode, library functions have a mind of
17593 * their own about CR-LF conversion. */
17594 fname = get_tv_string(&argvars[1]);
17595 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17597 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17598 ret = -1;
17600 else
17602 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17603 li = li->li_next)
17605 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17607 if (*s == '\n')
17608 c = putc(NUL, fd);
17609 else
17610 c = putc(*s, fd);
17611 if (c == EOF)
17613 ret = -1;
17614 break;
17617 if (!binary || li->li_next != NULL)
17618 if (putc('\n', fd) == EOF)
17620 ret = -1;
17621 break;
17623 if (ret < 0)
17625 EMSG(_(e_write));
17626 break;
17629 fclose(fd);
17632 rettv->vval.v_number = ret;
17636 * Translate a String variable into a position.
17637 * Returns NULL when there is an error.
17639 static pos_T *
17640 var2fpos(varp, dollar_lnum, fnum)
17641 typval_T *varp;
17642 int dollar_lnum; /* TRUE when $ is last line */
17643 int *fnum; /* set to fnum for '0, 'A, etc. */
17645 char_u *name;
17646 static pos_T pos;
17647 pos_T *pp;
17649 /* Argument can be [lnum, col, coladd]. */
17650 if (varp->v_type == VAR_LIST)
17652 list_T *l;
17653 int len;
17654 int error = FALSE;
17655 listitem_T *li;
17657 l = varp->vval.v_list;
17658 if (l == NULL)
17659 return NULL;
17661 /* Get the line number */
17662 pos.lnum = list_find_nr(l, 0L, &error);
17663 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17664 return NULL; /* invalid line number */
17666 /* Get the column number */
17667 pos.col = list_find_nr(l, 1L, &error);
17668 if (error)
17669 return NULL;
17670 len = (long)STRLEN(ml_get(pos.lnum));
17672 /* We accept "$" for the column number: last column. */
17673 li = list_find(l, 1L);
17674 if (li != NULL && li->li_tv.v_type == VAR_STRING
17675 && li->li_tv.vval.v_string != NULL
17676 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17677 pos.col = len + 1;
17679 /* Accept a position up to the NUL after the line. */
17680 if (pos.col == 0 || (int)pos.col > len + 1)
17681 return NULL; /* invalid column number */
17682 --pos.col;
17684 #ifdef FEAT_VIRTUALEDIT
17685 /* Get the virtual offset. Defaults to zero. */
17686 pos.coladd = list_find_nr(l, 2L, &error);
17687 if (error)
17688 pos.coladd = 0;
17689 #endif
17691 return &pos;
17694 name = get_tv_string_chk(varp);
17695 if (name == NULL)
17696 return NULL;
17697 if (name[0] == '.') /* cursor */
17698 return &curwin->w_cursor;
17699 #ifdef FEAT_VISUAL
17700 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17702 if (VIsual_active)
17703 return &VIsual;
17704 return &curwin->w_cursor;
17706 #endif
17707 if (name[0] == '\'') /* mark */
17709 pp = getmark_fnum(name[1], FALSE, fnum);
17710 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17711 return NULL;
17712 return pp;
17715 #ifdef FEAT_VIRTUALEDIT
17716 pos.coladd = 0;
17717 #endif
17719 if (name[0] == 'w' && dollar_lnum)
17721 pos.col = 0;
17722 if (name[1] == '0') /* "w0": first visible line */
17724 update_topline();
17725 pos.lnum = curwin->w_topline;
17726 return &pos;
17728 else if (name[1] == '$') /* "w$": last visible line */
17730 validate_botline();
17731 pos.lnum = curwin->w_botline - 1;
17732 return &pos;
17735 else if (name[0] == '$') /* last column or line */
17737 if (dollar_lnum)
17739 pos.lnum = curbuf->b_ml.ml_line_count;
17740 pos.col = 0;
17742 else
17744 pos.lnum = curwin->w_cursor.lnum;
17745 pos.col = (colnr_T)STRLEN(ml_get_curline());
17747 return &pos;
17749 return NULL;
17753 * Convert list in "arg" into a position and optional file number.
17754 * When "fnump" is NULL there is no file number, only 3 items.
17755 * Note that the column is passed on as-is, the caller may want to decrement
17756 * it to use 1 for the first column.
17757 * Return FAIL when conversion is not possible, doesn't check the position for
17758 * validity.
17760 static int
17761 list2fpos(arg, posp, fnump)
17762 typval_T *arg;
17763 pos_T *posp;
17764 int *fnump;
17766 list_T *l = arg->vval.v_list;
17767 long i = 0;
17768 long n;
17770 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17771 * when "fnump" isn't NULL and "coladd" is optional. */
17772 if (arg->v_type != VAR_LIST
17773 || l == NULL
17774 || l->lv_len < (fnump == NULL ? 2 : 3)
17775 || l->lv_len > (fnump == NULL ? 3 : 4))
17776 return FAIL;
17778 if (fnump != NULL)
17780 n = list_find_nr(l, i++, NULL); /* fnum */
17781 if (n < 0)
17782 return FAIL;
17783 if (n == 0)
17784 n = curbuf->b_fnum; /* current buffer */
17785 *fnump = n;
17788 n = list_find_nr(l, i++, NULL); /* lnum */
17789 if (n < 0)
17790 return FAIL;
17791 posp->lnum = n;
17793 n = list_find_nr(l, i++, NULL); /* col */
17794 if (n < 0)
17795 return FAIL;
17796 posp->col = n;
17798 #ifdef FEAT_VIRTUALEDIT
17799 n = list_find_nr(l, i, NULL);
17800 if (n < 0)
17801 posp->coladd = 0;
17802 else
17803 posp->coladd = n;
17804 #endif
17806 return OK;
17810 * Get the length of an environment variable name.
17811 * Advance "arg" to the first character after the name.
17812 * Return 0 for error.
17814 static int
17815 get_env_len(arg)
17816 char_u **arg;
17818 char_u *p;
17819 int len;
17821 for (p = *arg; vim_isIDc(*p); ++p)
17823 if (p == *arg) /* no name found */
17824 return 0;
17826 len = (int)(p - *arg);
17827 *arg = p;
17828 return len;
17832 * Get the length of the name of a function or internal variable.
17833 * "arg" is advanced to the first non-white character after the name.
17834 * Return 0 if something is wrong.
17836 static int
17837 get_id_len(arg)
17838 char_u **arg;
17840 char_u *p;
17841 int len;
17843 /* Find the end of the name. */
17844 for (p = *arg; eval_isnamec(*p); ++p)
17846 if (p == *arg) /* no name found */
17847 return 0;
17849 len = (int)(p - *arg);
17850 *arg = skipwhite(p);
17852 return len;
17856 * Get the length of the name of a variable or function.
17857 * Only the name is recognized, does not handle ".key" or "[idx]".
17858 * "arg" is advanced to the first non-white character after the name.
17859 * Return -1 if curly braces expansion failed.
17860 * Return 0 if something else is wrong.
17861 * If the name contains 'magic' {}'s, expand them and return the
17862 * expanded name in an allocated string via 'alias' - caller must free.
17864 static int
17865 get_name_len(arg, alias, evaluate, verbose)
17866 char_u **arg;
17867 char_u **alias;
17868 int evaluate;
17869 int verbose;
17871 int len;
17872 char_u *p;
17873 char_u *expr_start;
17874 char_u *expr_end;
17876 *alias = NULL; /* default to no alias */
17878 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17879 && (*arg)[2] == (int)KE_SNR)
17881 /* hard coded <SNR>, already translated */
17882 *arg += 3;
17883 return get_id_len(arg) + 3;
17885 len = eval_fname_script(*arg);
17886 if (len > 0)
17888 /* literal "<SID>", "s:" or "<SNR>" */
17889 *arg += len;
17893 * Find the end of the name; check for {} construction.
17895 p = find_name_end(*arg, &expr_start, &expr_end,
17896 len > 0 ? 0 : FNE_CHECK_START);
17897 if (expr_start != NULL)
17899 char_u *temp_string;
17901 if (!evaluate)
17903 len += (int)(p - *arg);
17904 *arg = skipwhite(p);
17905 return len;
17909 * Include any <SID> etc in the expanded string:
17910 * Thus the -len here.
17912 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17913 if (temp_string == NULL)
17914 return -1;
17915 *alias = temp_string;
17916 *arg = skipwhite(p);
17917 return (int)STRLEN(temp_string);
17920 len += get_id_len(arg);
17921 if (len == 0 && verbose)
17922 EMSG2(_(e_invexpr2), *arg);
17924 return len;
17928 * Find the end of a variable or function name, taking care of magic braces.
17929 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17930 * start and end of the first magic braces item.
17931 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17932 * Return a pointer to just after the name. Equal to "arg" if there is no
17933 * valid name.
17935 static char_u *
17936 find_name_end(arg, expr_start, expr_end, flags)
17937 char_u *arg;
17938 char_u **expr_start;
17939 char_u **expr_end;
17940 int flags;
17942 int mb_nest = 0;
17943 int br_nest = 0;
17944 char_u *p;
17946 if (expr_start != NULL)
17948 *expr_start = NULL;
17949 *expr_end = NULL;
17952 /* Quick check for valid starting character. */
17953 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17954 return arg;
17956 for (p = arg; *p != NUL
17957 && (eval_isnamec(*p)
17958 || *p == '{'
17959 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17960 || mb_nest != 0
17961 || br_nest != 0); mb_ptr_adv(p))
17963 if (*p == '\'')
17965 /* skip over 'string' to avoid counting [ and ] inside it. */
17966 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17968 if (*p == NUL)
17969 break;
17971 else if (*p == '"')
17973 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17974 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17975 if (*p == '\\' && p[1] != NUL)
17976 ++p;
17977 if (*p == NUL)
17978 break;
17981 if (mb_nest == 0)
17983 if (*p == '[')
17984 ++br_nest;
17985 else if (*p == ']')
17986 --br_nest;
17989 if (br_nest == 0)
17991 if (*p == '{')
17993 mb_nest++;
17994 if (expr_start != NULL && *expr_start == NULL)
17995 *expr_start = p;
17997 else if (*p == '}')
17999 mb_nest--;
18000 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18001 *expr_end = p;
18006 return p;
18010 * Expands out the 'magic' {}'s in a variable/function name.
18011 * Note that this can call itself recursively, to deal with
18012 * constructs like foo{bar}{baz}{bam}
18013 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18014 * "in_start" ^
18015 * "expr_start" ^
18016 * "expr_end" ^
18017 * "in_end" ^
18019 * Returns a new allocated string, which the caller must free.
18020 * Returns NULL for failure.
18022 static char_u *
18023 make_expanded_name(in_start, expr_start, expr_end, in_end)
18024 char_u *in_start;
18025 char_u *expr_start;
18026 char_u *expr_end;
18027 char_u *in_end;
18029 char_u c1;
18030 char_u *retval = NULL;
18031 char_u *temp_result;
18032 char_u *nextcmd = NULL;
18034 if (expr_end == NULL || in_end == NULL)
18035 return NULL;
18036 *expr_start = NUL;
18037 *expr_end = NUL;
18038 c1 = *in_end;
18039 *in_end = NUL;
18041 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18042 if (temp_result != NULL && nextcmd == NULL)
18044 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18045 + (in_end - expr_end) + 1));
18046 if (retval != NULL)
18048 STRCPY(retval, in_start);
18049 STRCAT(retval, temp_result);
18050 STRCAT(retval, expr_end + 1);
18053 vim_free(temp_result);
18055 *in_end = c1; /* put char back for error messages */
18056 *expr_start = '{';
18057 *expr_end = '}';
18059 if (retval != NULL)
18061 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18062 if (expr_start != NULL)
18064 /* Further expansion! */
18065 temp_result = make_expanded_name(retval, expr_start,
18066 expr_end, temp_result);
18067 vim_free(retval);
18068 retval = temp_result;
18072 return retval;
18076 * Return TRUE if character "c" can be used in a variable or function name.
18077 * Does not include '{' or '}' for magic braces.
18079 static int
18080 eval_isnamec(c)
18081 int c;
18083 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18087 * Return TRUE if character "c" can be used as the first character in a
18088 * variable or function name (excluding '{' and '}').
18090 static int
18091 eval_isnamec1(c)
18092 int c;
18094 return (ASCII_ISALPHA(c) || c == '_');
18098 * Set number v: variable to "val".
18100 void
18101 set_vim_var_nr(idx, val)
18102 int idx;
18103 long val;
18105 vimvars[idx].vv_nr = val;
18109 * Get number v: variable value.
18111 long
18112 get_vim_var_nr(idx)
18113 int idx;
18115 return vimvars[idx].vv_nr;
18119 * Get string v: variable value. Uses a static buffer, can only be used once.
18121 char_u *
18122 get_vim_var_str(idx)
18123 int idx;
18125 return get_tv_string(&vimvars[idx].vv_tv);
18129 * Get List v: variable value. Caller must take care of reference count when
18130 * needed.
18132 list_T *
18133 get_vim_var_list(idx)
18134 int idx;
18136 return vimvars[idx].vv_list;
18140 * Set v:char to character "c".
18142 void
18143 set_vim_var_char(c)
18144 int c;
18146 #ifdef FEAT_MBYTE
18147 char_u buf[MB_MAXBYTES];
18148 #else
18149 char_u buf[2];
18150 #endif
18152 #ifdef FEAT_MBYTE
18153 if (has_mbyte)
18154 buf[(*mb_char2bytes)(c, buf)] = NUL;
18155 else
18156 #endif
18158 buf[0] = c;
18159 buf[1] = NUL;
18161 set_vim_var_string(VV_CHAR, buf, -1);
18165 * Set v:count to "count" and v:count1 to "count1".
18166 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18168 void
18169 set_vcount(count, count1, set_prevcount)
18170 long count;
18171 long count1;
18172 int set_prevcount;
18174 if (set_prevcount)
18175 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18176 vimvars[VV_COUNT].vv_nr = count;
18177 vimvars[VV_COUNT1].vv_nr = count1;
18181 * Set string v: variable to a copy of "val".
18183 void
18184 set_vim_var_string(idx, val, len)
18185 int idx;
18186 char_u *val;
18187 int len; /* length of "val" to use or -1 (whole string) */
18189 /* Need to do this (at least) once, since we can't initialize a union.
18190 * Will always be invoked when "v:progname" is set. */
18191 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18193 vim_free(vimvars[idx].vv_str);
18194 if (val == NULL)
18195 vimvars[idx].vv_str = NULL;
18196 else if (len == -1)
18197 vimvars[idx].vv_str = vim_strsave(val);
18198 else
18199 vimvars[idx].vv_str = vim_strnsave(val, len);
18203 * Set List v: variable to "val".
18205 void
18206 set_vim_var_list(idx, val)
18207 int idx;
18208 list_T *val;
18210 list_unref(vimvars[idx].vv_list);
18211 vimvars[idx].vv_list = val;
18212 if (val != NULL)
18213 ++val->lv_refcount;
18217 * Set v:register if needed.
18219 void
18220 set_reg_var(c)
18221 int c;
18223 char_u regname;
18225 if (c == 0 || c == ' ')
18226 regname = '"';
18227 else
18228 regname = c;
18229 /* Avoid free/alloc when the value is already right. */
18230 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18231 set_vim_var_string(VV_REG, &regname, 1);
18235 * Get or set v:exception. If "oldval" == NULL, return the current value.
18236 * Otherwise, restore the value to "oldval" and return NULL.
18237 * Must always be called in pairs to save and restore v:exception! Does not
18238 * take care of memory allocations.
18240 char_u *
18241 v_exception(oldval)
18242 char_u *oldval;
18244 if (oldval == NULL)
18245 return vimvars[VV_EXCEPTION].vv_str;
18247 vimvars[VV_EXCEPTION].vv_str = oldval;
18248 return NULL;
18252 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18253 * Otherwise, restore the value to "oldval" and return NULL.
18254 * Must always be called in pairs to save and restore v:throwpoint! Does not
18255 * take care of memory allocations.
18257 char_u *
18258 v_throwpoint(oldval)
18259 char_u *oldval;
18261 if (oldval == NULL)
18262 return vimvars[VV_THROWPOINT].vv_str;
18264 vimvars[VV_THROWPOINT].vv_str = oldval;
18265 return NULL;
18268 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18270 * Set v:cmdarg.
18271 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18272 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18273 * Must always be called in pairs!
18275 char_u *
18276 set_cmdarg(eap, oldarg)
18277 exarg_T *eap;
18278 char_u *oldarg;
18280 char_u *oldval;
18281 char_u *newval;
18282 unsigned len;
18284 oldval = vimvars[VV_CMDARG].vv_str;
18285 if (eap == NULL)
18287 vim_free(oldval);
18288 vimvars[VV_CMDARG].vv_str = oldarg;
18289 return NULL;
18292 if (eap->force_bin == FORCE_BIN)
18293 len = 6;
18294 else if (eap->force_bin == FORCE_NOBIN)
18295 len = 8;
18296 else
18297 len = 0;
18299 if (eap->read_edit)
18300 len += 7;
18302 if (eap->force_ff != 0)
18303 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18304 # ifdef FEAT_MBYTE
18305 if (eap->force_enc != 0)
18306 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18307 if (eap->bad_char != 0)
18308 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18309 # endif
18311 newval = alloc(len + 1);
18312 if (newval == NULL)
18313 return NULL;
18315 if (eap->force_bin == FORCE_BIN)
18316 sprintf((char *)newval, " ++bin");
18317 else if (eap->force_bin == FORCE_NOBIN)
18318 sprintf((char *)newval, " ++nobin");
18319 else
18320 *newval = NUL;
18322 if (eap->read_edit)
18323 STRCAT(newval, " ++edit");
18325 if (eap->force_ff != 0)
18326 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18327 eap->cmd + eap->force_ff);
18328 # ifdef FEAT_MBYTE
18329 if (eap->force_enc != 0)
18330 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18331 eap->cmd + eap->force_enc);
18332 if (eap->bad_char != 0)
18333 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18334 eap->cmd + eap->bad_char);
18335 # endif
18336 vimvars[VV_CMDARG].vv_str = newval;
18337 return oldval;
18339 #endif
18342 * Get the value of internal variable "name".
18343 * Return OK or FAIL.
18345 static int
18346 get_var_tv(name, len, rettv, verbose)
18347 char_u *name;
18348 int len; /* length of "name" */
18349 typval_T *rettv; /* NULL when only checking existence */
18350 int verbose; /* may give error message */
18352 int ret = OK;
18353 typval_T *tv = NULL;
18354 typval_T atv;
18355 dictitem_T *v;
18356 int cc;
18358 /* truncate the name, so that we can use strcmp() */
18359 cc = name[len];
18360 name[len] = NUL;
18363 * Check for "b:changedtick".
18365 if (STRCMP(name, "b:changedtick") == 0)
18367 atv.v_type = VAR_NUMBER;
18368 atv.vval.v_number = curbuf->b_changedtick;
18369 tv = &atv;
18373 * Check for user-defined variables.
18375 else
18377 v = find_var(name, NULL);
18378 if (v != NULL)
18379 tv = &v->di_tv;
18382 if (tv == NULL)
18384 if (rettv != NULL && verbose)
18385 EMSG2(_(e_undefvar), name);
18386 ret = FAIL;
18388 else if (rettv != NULL)
18389 copy_tv(tv, rettv);
18391 name[len] = cc;
18393 return ret;
18397 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18398 * Also handle function call with Funcref variable: func(expr)
18399 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18401 static int
18402 handle_subscript(arg, rettv, evaluate, verbose)
18403 char_u **arg;
18404 typval_T *rettv;
18405 int evaluate; /* do more than finding the end */
18406 int verbose; /* give error messages */
18408 int ret = OK;
18409 dict_T *selfdict = NULL;
18410 char_u *s;
18411 int len;
18412 typval_T functv;
18414 while (ret == OK
18415 && (**arg == '['
18416 || (**arg == '.' && rettv->v_type == VAR_DICT)
18417 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18418 && !vim_iswhite(*(*arg - 1)))
18420 if (**arg == '(')
18422 /* need to copy the funcref so that we can clear rettv */
18423 functv = *rettv;
18424 rettv->v_type = VAR_UNKNOWN;
18426 /* Invoke the function. Recursive! */
18427 s = functv.vval.v_string;
18428 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18429 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18430 &len, evaluate, selfdict);
18432 /* Clear the funcref afterwards, so that deleting it while
18433 * evaluating the arguments is possible (see test55). */
18434 clear_tv(&functv);
18436 /* Stop the expression evaluation when immediately aborting on
18437 * error, or when an interrupt occurred or an exception was thrown
18438 * but not caught. */
18439 if (aborting())
18441 if (ret == OK)
18442 clear_tv(rettv);
18443 ret = FAIL;
18445 dict_unref(selfdict);
18446 selfdict = NULL;
18448 else /* **arg == '[' || **arg == '.' */
18450 dict_unref(selfdict);
18451 if (rettv->v_type == VAR_DICT)
18453 selfdict = rettv->vval.v_dict;
18454 if (selfdict != NULL)
18455 ++selfdict->dv_refcount;
18457 else
18458 selfdict = NULL;
18459 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18461 clear_tv(rettv);
18462 ret = FAIL;
18466 dict_unref(selfdict);
18467 return ret;
18471 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18472 * value).
18474 static typval_T *
18475 alloc_tv()
18477 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18481 * Allocate memory for a variable type-value, and assign a string to it.
18482 * The string "s" must have been allocated, it is consumed.
18483 * Return NULL for out of memory, the variable otherwise.
18485 static typval_T *
18486 alloc_string_tv(s)
18487 char_u *s;
18489 typval_T *rettv;
18491 rettv = alloc_tv();
18492 if (rettv != NULL)
18494 rettv->v_type = VAR_STRING;
18495 rettv->vval.v_string = s;
18497 else
18498 vim_free(s);
18499 return rettv;
18503 * Free the memory for a variable type-value.
18505 void
18506 free_tv(varp)
18507 typval_T *varp;
18509 if (varp != NULL)
18511 switch (varp->v_type)
18513 case VAR_FUNC:
18514 func_unref(varp->vval.v_string);
18515 /*FALLTHROUGH*/
18516 case VAR_STRING:
18517 vim_free(varp->vval.v_string);
18518 break;
18519 case VAR_LIST:
18520 list_unref(varp->vval.v_list);
18521 break;
18522 case VAR_DICT:
18523 dict_unref(varp->vval.v_dict);
18524 break;
18525 case VAR_NUMBER:
18526 #ifdef FEAT_FLOAT
18527 case VAR_FLOAT:
18528 #endif
18529 case VAR_UNKNOWN:
18530 break;
18531 default:
18532 EMSG2(_(e_intern2), "free_tv()");
18533 break;
18535 vim_free(varp);
18540 * Free the memory for a variable value and set the value to NULL or 0.
18542 void
18543 clear_tv(varp)
18544 typval_T *varp;
18546 if (varp != NULL)
18548 switch (varp->v_type)
18550 case VAR_FUNC:
18551 func_unref(varp->vval.v_string);
18552 /*FALLTHROUGH*/
18553 case VAR_STRING:
18554 vim_free(varp->vval.v_string);
18555 varp->vval.v_string = NULL;
18556 break;
18557 case VAR_LIST:
18558 list_unref(varp->vval.v_list);
18559 varp->vval.v_list = NULL;
18560 break;
18561 case VAR_DICT:
18562 dict_unref(varp->vval.v_dict);
18563 varp->vval.v_dict = NULL;
18564 break;
18565 case VAR_NUMBER:
18566 varp->vval.v_number = 0;
18567 break;
18568 #ifdef FEAT_FLOAT
18569 case VAR_FLOAT:
18570 varp->vval.v_float = 0.0;
18571 break;
18572 #endif
18573 case VAR_UNKNOWN:
18574 break;
18575 default:
18576 EMSG2(_(e_intern2), "clear_tv()");
18578 varp->v_lock = 0;
18583 * Set the value of a variable to NULL without freeing items.
18585 static void
18586 init_tv(varp)
18587 typval_T *varp;
18589 if (varp != NULL)
18590 vim_memset(varp, 0, sizeof(typval_T));
18594 * Get the number value of a variable.
18595 * If it is a String variable, uses vim_str2nr().
18596 * For incompatible types, return 0.
18597 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18598 * caller of incompatible types: it sets *denote to TRUE if "denote"
18599 * is not NULL or returns -1 otherwise.
18601 static long
18602 get_tv_number(varp)
18603 typval_T *varp;
18605 int error = FALSE;
18607 return get_tv_number_chk(varp, &error); /* return 0L on error */
18610 long
18611 get_tv_number_chk(varp, denote)
18612 typval_T *varp;
18613 int *denote;
18615 long n = 0L;
18617 switch (varp->v_type)
18619 case VAR_NUMBER:
18620 return (long)(varp->vval.v_number);
18621 #ifdef FEAT_FLOAT
18622 case VAR_FLOAT:
18623 EMSG(_("E805: Using a Float as a Number"));
18624 break;
18625 #endif
18626 case VAR_FUNC:
18627 EMSG(_("E703: Using a Funcref as a Number"));
18628 break;
18629 case VAR_STRING:
18630 if (varp->vval.v_string != NULL)
18631 vim_str2nr(varp->vval.v_string, NULL, NULL,
18632 TRUE, TRUE, &n, NULL);
18633 return n;
18634 case VAR_LIST:
18635 EMSG(_("E745: Using a List as a Number"));
18636 break;
18637 case VAR_DICT:
18638 EMSG(_("E728: Using a Dictionary as a Number"));
18639 break;
18640 default:
18641 EMSG2(_(e_intern2), "get_tv_number()");
18642 break;
18644 if (denote == NULL) /* useful for values that must be unsigned */
18645 n = -1;
18646 else
18647 *denote = TRUE;
18648 return n;
18652 * Get the lnum from the first argument.
18653 * Also accepts ".", "$", etc., but that only works for the current buffer.
18654 * Returns -1 on error.
18656 static linenr_T
18657 get_tv_lnum(argvars)
18658 typval_T *argvars;
18660 typval_T rettv;
18661 linenr_T lnum;
18663 lnum = get_tv_number_chk(&argvars[0], NULL);
18664 if (lnum == 0) /* no valid number, try using line() */
18666 rettv.v_type = VAR_NUMBER;
18667 f_line(argvars, &rettv);
18668 lnum = rettv.vval.v_number;
18669 clear_tv(&rettv);
18671 return lnum;
18675 * Get the lnum from the first argument.
18676 * Also accepts "$", then "buf" is used.
18677 * Returns 0 on error.
18679 static linenr_T
18680 get_tv_lnum_buf(argvars, buf)
18681 typval_T *argvars;
18682 buf_T *buf;
18684 if (argvars[0].v_type == VAR_STRING
18685 && argvars[0].vval.v_string != NULL
18686 && argvars[0].vval.v_string[0] == '$'
18687 && buf != NULL)
18688 return buf->b_ml.ml_line_count;
18689 return get_tv_number_chk(&argvars[0], NULL);
18693 * Get the string value of a variable.
18694 * If it is a Number variable, the number is converted into a string.
18695 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18696 * get_tv_string_buf() uses a given buffer.
18697 * If the String variable has never been set, return an empty string.
18698 * Never returns NULL;
18699 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18700 * NULL on error.
18702 static char_u *
18703 get_tv_string(varp)
18704 typval_T *varp;
18706 static char_u mybuf[NUMBUFLEN];
18708 return get_tv_string_buf(varp, mybuf);
18711 static char_u *
18712 get_tv_string_buf(varp, buf)
18713 typval_T *varp;
18714 char_u *buf;
18716 char_u *res = get_tv_string_buf_chk(varp, buf);
18718 return res != NULL ? res : (char_u *)"";
18721 char_u *
18722 get_tv_string_chk(varp)
18723 typval_T *varp;
18725 static char_u mybuf[NUMBUFLEN];
18727 return get_tv_string_buf_chk(varp, mybuf);
18730 static char_u *
18731 get_tv_string_buf_chk(varp, buf)
18732 typval_T *varp;
18733 char_u *buf;
18735 switch (varp->v_type)
18737 case VAR_NUMBER:
18738 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18739 return buf;
18740 case VAR_FUNC:
18741 EMSG(_("E729: using Funcref as a String"));
18742 break;
18743 case VAR_LIST:
18744 EMSG(_("E730: using List as a String"));
18745 break;
18746 case VAR_DICT:
18747 EMSG(_("E731: using Dictionary as a String"));
18748 break;
18749 #ifdef FEAT_FLOAT
18750 case VAR_FLOAT:
18751 EMSG(_("E806: using Float as a String"));
18752 break;
18753 #endif
18754 case VAR_STRING:
18755 if (varp->vval.v_string != NULL)
18756 return varp->vval.v_string;
18757 return (char_u *)"";
18758 default:
18759 EMSG2(_(e_intern2), "get_tv_string_buf()");
18760 break;
18762 return NULL;
18766 * Find variable "name" in the list of variables.
18767 * Return a pointer to it if found, NULL if not found.
18768 * Careful: "a:0" variables don't have a name.
18769 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18770 * hashtab_T used.
18772 static dictitem_T *
18773 find_var(name, htp)
18774 char_u *name;
18775 hashtab_T **htp;
18777 char_u *varname;
18778 hashtab_T *ht;
18780 ht = find_var_ht(name, &varname);
18781 if (htp != NULL)
18782 *htp = ht;
18783 if (ht == NULL)
18784 return NULL;
18785 return find_var_in_ht(ht, varname, htp != NULL);
18789 * Find variable "varname" in hashtab "ht".
18790 * Returns NULL if not found.
18792 static dictitem_T *
18793 find_var_in_ht(ht, varname, writing)
18794 hashtab_T *ht;
18795 char_u *varname;
18796 int writing;
18798 hashitem_T *hi;
18800 if (*varname == NUL)
18802 /* Must be something like "s:", otherwise "ht" would be NULL. */
18803 switch (varname[-2])
18805 case 's': return &SCRIPT_SV(current_SID).sv_var;
18806 case 'g': return &globvars_var;
18807 case 'v': return &vimvars_var;
18808 case 'b': return &curbuf->b_bufvar;
18809 case 'w': return &curwin->w_winvar;
18810 #ifdef FEAT_WINDOWS
18811 case 't': return &curtab->tp_winvar;
18812 #endif
18813 case 'l': return current_funccal == NULL
18814 ? NULL : &current_funccal->l_vars_var;
18815 case 'a': return current_funccal == NULL
18816 ? NULL : &current_funccal->l_avars_var;
18818 return NULL;
18821 hi = hash_find(ht, varname);
18822 if (HASHITEM_EMPTY(hi))
18824 /* For global variables we may try auto-loading the script. If it
18825 * worked find the variable again. Don't auto-load a script if it was
18826 * loaded already, otherwise it would be loaded every time when
18827 * checking if a function name is a Funcref variable. */
18828 if (ht == &globvarht && !writing
18829 && script_autoload(varname, FALSE) && !aborting())
18830 hi = hash_find(ht, varname);
18831 if (HASHITEM_EMPTY(hi))
18832 return NULL;
18834 return HI2DI(hi);
18838 * Find the hashtab used for a variable name.
18839 * Set "varname" to the start of name without ':'.
18841 static hashtab_T *
18842 find_var_ht(name, varname)
18843 char_u *name;
18844 char_u **varname;
18846 hashitem_T *hi;
18848 if (name[1] != ':')
18850 /* The name must not start with a colon or #. */
18851 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18852 return NULL;
18853 *varname = name;
18855 /* "version" is "v:version" in all scopes */
18856 hi = hash_find(&compat_hashtab, name);
18857 if (!HASHITEM_EMPTY(hi))
18858 return &compat_hashtab;
18860 if (current_funccal == NULL)
18861 return &globvarht; /* global variable */
18862 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18864 *varname = name + 2;
18865 if (*name == 'g') /* global variable */
18866 return &globvarht;
18867 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18869 if (vim_strchr(name + 2, ':') != NULL
18870 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18871 return NULL;
18872 if (*name == 'b') /* buffer variable */
18873 return &curbuf->b_vars.dv_hashtab;
18874 if (*name == 'w') /* window variable */
18875 return &curwin->w_vars.dv_hashtab;
18876 #ifdef FEAT_WINDOWS
18877 if (*name == 't') /* tab page variable */
18878 return &curtab->tp_vars.dv_hashtab;
18879 #endif
18880 if (*name == 'v') /* v: variable */
18881 return &vimvarht;
18882 if (*name == 'a' && current_funccal != NULL) /* function argument */
18883 return &current_funccal->l_avars.dv_hashtab;
18884 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18885 return &current_funccal->l_vars.dv_hashtab;
18886 if (*name == 's' /* script variable */
18887 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18888 return &SCRIPT_VARS(current_SID);
18889 return NULL;
18893 * Get the string value of a (global/local) variable.
18894 * Returns NULL when it doesn't exist.
18896 char_u *
18897 get_var_value(name)
18898 char_u *name;
18900 dictitem_T *v;
18902 v = find_var(name, NULL);
18903 if (v == NULL)
18904 return NULL;
18905 return get_tv_string(&v->di_tv);
18909 * Allocate a new hashtab for a sourced script. It will be used while
18910 * sourcing this script and when executing functions defined in the script.
18912 void
18913 new_script_vars(id)
18914 scid_T id;
18916 int i;
18917 hashtab_T *ht;
18918 scriptvar_T *sv;
18920 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18922 /* Re-allocating ga_data means that an ht_array pointing to
18923 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18924 * at its init value. Also reset "v_dict", it's always the same. */
18925 for (i = 1; i <= ga_scripts.ga_len; ++i)
18927 ht = &SCRIPT_VARS(i);
18928 if (ht->ht_mask == HT_INIT_SIZE - 1)
18929 ht->ht_array = ht->ht_smallarray;
18930 sv = &SCRIPT_SV(i);
18931 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18934 while (ga_scripts.ga_len < id)
18936 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18937 init_var_dict(&sv->sv_dict, &sv->sv_var);
18938 ++ga_scripts.ga_len;
18944 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18945 * point to it.
18947 void
18948 init_var_dict(dict, dict_var)
18949 dict_T *dict;
18950 dictitem_T *dict_var;
18952 hash_init(&dict->dv_hashtab);
18953 dict->dv_refcount = DO_NOT_FREE_CNT;
18954 dict->dv_copyID = 0;
18955 dict_var->di_tv.vval.v_dict = dict;
18956 dict_var->di_tv.v_type = VAR_DICT;
18957 dict_var->di_tv.v_lock = VAR_FIXED;
18958 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18959 dict_var->di_key[0] = NUL;
18963 * Clean up a list of internal variables.
18964 * Frees all allocated variables and the value they contain.
18965 * Clears hashtab "ht", does not free it.
18967 void
18968 vars_clear(ht)
18969 hashtab_T *ht;
18971 vars_clear_ext(ht, TRUE);
18975 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18977 static void
18978 vars_clear_ext(ht, free_val)
18979 hashtab_T *ht;
18980 int free_val;
18982 int todo;
18983 hashitem_T *hi;
18984 dictitem_T *v;
18986 hash_lock(ht);
18987 todo = (int)ht->ht_used;
18988 for (hi = ht->ht_array; todo > 0; ++hi)
18990 if (!HASHITEM_EMPTY(hi))
18992 --todo;
18994 /* Free the variable. Don't remove it from the hashtab,
18995 * ht_array might change then. hash_clear() takes care of it
18996 * later. */
18997 v = HI2DI(hi);
18998 if (free_val)
18999 clear_tv(&v->di_tv);
19000 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19001 vim_free(v);
19004 hash_clear(ht);
19005 ht->ht_used = 0;
19009 * Delete a variable from hashtab "ht" at item "hi".
19010 * Clear the variable value and free the dictitem.
19012 static void
19013 delete_var(ht, hi)
19014 hashtab_T *ht;
19015 hashitem_T *hi;
19017 dictitem_T *di = HI2DI(hi);
19019 hash_remove(ht, hi);
19020 clear_tv(&di->di_tv);
19021 vim_free(di);
19025 * List the value of one internal variable.
19027 static void
19028 list_one_var(v, prefix, first)
19029 dictitem_T *v;
19030 char_u *prefix;
19031 int *first;
19033 char_u *tofree;
19034 char_u *s;
19035 char_u numbuf[NUMBUFLEN];
19037 current_copyID += COPYID_INC;
19038 s = echo_string(&v->di_tv, &tofree, numbuf, current_copyID);
19039 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19040 s == NULL ? (char_u *)"" : s, first);
19041 vim_free(tofree);
19044 static void
19045 list_one_var_a(prefix, name, type, string, first)
19046 char_u *prefix;
19047 char_u *name;
19048 int type;
19049 char_u *string;
19050 int *first; /* when TRUE clear rest of screen and set to FALSE */
19052 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19053 msg_start();
19054 msg_puts(prefix);
19055 if (name != NULL) /* "a:" vars don't have a name stored */
19056 msg_puts(name);
19057 msg_putchar(' ');
19058 msg_advance(22);
19059 if (type == VAR_NUMBER)
19060 msg_putchar('#');
19061 else if (type == VAR_FUNC)
19062 msg_putchar('*');
19063 else if (type == VAR_LIST)
19065 msg_putchar('[');
19066 if (*string == '[')
19067 ++string;
19069 else if (type == VAR_DICT)
19071 msg_putchar('{');
19072 if (*string == '{')
19073 ++string;
19075 else
19076 msg_putchar(' ');
19078 msg_outtrans(string);
19080 if (type == VAR_FUNC)
19081 msg_puts((char_u *)"()");
19082 if (*first)
19084 msg_clr_eos();
19085 *first = FALSE;
19090 * Set variable "name" to value in "tv".
19091 * If the variable already exists, the value is updated.
19092 * Otherwise the variable is created.
19094 static void
19095 set_var(name, tv, copy)
19096 char_u *name;
19097 typval_T *tv;
19098 int copy; /* make copy of value in "tv" */
19100 dictitem_T *v;
19101 char_u *varname;
19102 hashtab_T *ht;
19103 char_u *p;
19105 if (tv->v_type == VAR_FUNC)
19107 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19108 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19109 ? name[2] : name[0]))
19111 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19112 return;
19114 if (function_exists(name))
19116 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19117 name);
19118 return;
19122 ht = find_var_ht(name, &varname);
19123 if (ht == NULL || *varname == NUL)
19125 EMSG2(_(e_illvar), name);
19126 return;
19129 v = find_var_in_ht(ht, varname, TRUE);
19130 if (v != NULL)
19132 /* existing variable, need to clear the value */
19133 if (var_check_ro(v->di_flags, name)
19134 || tv_check_lock(v->di_tv.v_lock, name))
19135 return;
19136 if (v->di_tv.v_type != tv->v_type
19137 && !((v->di_tv.v_type == VAR_STRING
19138 || v->di_tv.v_type == VAR_NUMBER)
19139 && (tv->v_type == VAR_STRING
19140 || tv->v_type == VAR_NUMBER))
19141 #ifdef FEAT_FLOAT
19142 && !((v->di_tv.v_type == VAR_NUMBER
19143 || v->di_tv.v_type == VAR_FLOAT)
19144 && (tv->v_type == VAR_NUMBER
19145 || tv->v_type == VAR_FLOAT))
19146 #endif
19149 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19150 return;
19154 * Handle setting internal v: variables separately: we don't change
19155 * the type.
19157 if (ht == &vimvarht)
19159 if (v->di_tv.v_type == VAR_STRING)
19161 vim_free(v->di_tv.vval.v_string);
19162 if (copy || tv->v_type != VAR_STRING)
19163 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19164 else
19166 /* Take over the string to avoid an extra alloc/free. */
19167 v->di_tv.vval.v_string = tv->vval.v_string;
19168 tv->vval.v_string = NULL;
19171 else if (v->di_tv.v_type != VAR_NUMBER)
19172 EMSG2(_(e_intern2), "set_var()");
19173 else
19175 v->di_tv.vval.v_number = get_tv_number(tv);
19176 if (STRCMP(varname, "searchforward") == 0)
19177 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19179 return;
19182 clear_tv(&v->di_tv);
19184 else /* add a new variable */
19186 /* Can't add "v:" variable. */
19187 if (ht == &vimvarht)
19189 EMSG2(_(e_illvar), name);
19190 return;
19193 /* Make sure the variable name is valid. */
19194 for (p = varname; *p != NUL; ++p)
19195 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19196 && *p != AUTOLOAD_CHAR)
19198 EMSG2(_(e_illvar), varname);
19199 return;
19202 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19203 + STRLEN(varname)));
19204 if (v == NULL)
19205 return;
19206 STRCPY(v->di_key, varname);
19207 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19209 vim_free(v);
19210 return;
19212 v->di_flags = 0;
19215 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19216 copy_tv(tv, &v->di_tv);
19217 else
19219 v->di_tv = *tv;
19220 v->di_tv.v_lock = 0;
19221 init_tv(tv);
19226 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19227 * Also give an error message.
19229 static int
19230 var_check_ro(flags, name)
19231 int flags;
19232 char_u *name;
19234 if (flags & DI_FLAGS_RO)
19236 EMSG2(_(e_readonlyvar), name);
19237 return TRUE;
19239 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19241 EMSG2(_(e_readonlysbx), name);
19242 return TRUE;
19244 return FALSE;
19248 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19249 * Also give an error message.
19251 static int
19252 var_check_fixed(flags, name)
19253 int flags;
19254 char_u *name;
19256 if (flags & DI_FLAGS_FIX)
19258 EMSG2(_("E795: Cannot delete variable %s"), name);
19259 return TRUE;
19261 return FALSE;
19265 * Return TRUE if typeval "tv" is set to be locked (immutable).
19266 * Also give an error message, using "name".
19268 static int
19269 tv_check_lock(lock, name)
19270 int lock;
19271 char_u *name;
19273 if (lock & VAR_LOCKED)
19275 EMSG2(_("E741: Value is locked: %s"),
19276 name == NULL ? (char_u *)_("Unknown") : name);
19277 return TRUE;
19279 if (lock & VAR_FIXED)
19281 EMSG2(_("E742: Cannot change value of %s"),
19282 name == NULL ? (char_u *)_("Unknown") : name);
19283 return TRUE;
19285 return FALSE;
19289 * Copy the values from typval_T "from" to typval_T "to".
19290 * When needed allocates string or increases reference count.
19291 * Does not make a copy of a list or dict but copies the reference!
19292 * It is OK for "from" and "to" to point to the same item. This is used to
19293 * make a copy later.
19295 static void
19296 copy_tv(from, to)
19297 typval_T *from;
19298 typval_T *to;
19300 to->v_type = from->v_type;
19301 to->v_lock = 0;
19302 switch (from->v_type)
19304 case VAR_NUMBER:
19305 to->vval.v_number = from->vval.v_number;
19306 break;
19307 #ifdef FEAT_FLOAT
19308 case VAR_FLOAT:
19309 to->vval.v_float = from->vval.v_float;
19310 break;
19311 #endif
19312 case VAR_STRING:
19313 case VAR_FUNC:
19314 if (from->vval.v_string == NULL)
19315 to->vval.v_string = NULL;
19316 else
19318 to->vval.v_string = vim_strsave(from->vval.v_string);
19319 if (from->v_type == VAR_FUNC)
19320 func_ref(to->vval.v_string);
19322 break;
19323 case VAR_LIST:
19324 if (from->vval.v_list == NULL)
19325 to->vval.v_list = NULL;
19326 else
19328 to->vval.v_list = from->vval.v_list;
19329 ++to->vval.v_list->lv_refcount;
19331 break;
19332 case VAR_DICT:
19333 if (from->vval.v_dict == NULL)
19334 to->vval.v_dict = NULL;
19335 else
19337 to->vval.v_dict = from->vval.v_dict;
19338 ++to->vval.v_dict->dv_refcount;
19340 break;
19341 default:
19342 EMSG2(_(e_intern2), "copy_tv()");
19343 break;
19348 * Make a copy of an item.
19349 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19350 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19351 * reference to an already copied list/dict can be used.
19352 * Returns FAIL or OK.
19354 static int
19355 item_copy(from, to, deep, copyID)
19356 typval_T *from;
19357 typval_T *to;
19358 int deep;
19359 int copyID;
19361 static int recurse = 0;
19362 int ret = OK;
19364 if (recurse >= DICT_MAXNEST)
19366 EMSG(_("E698: variable nested too deep for making a copy"));
19367 return FAIL;
19369 ++recurse;
19371 switch (from->v_type)
19373 case VAR_NUMBER:
19374 #ifdef FEAT_FLOAT
19375 case VAR_FLOAT:
19376 #endif
19377 case VAR_STRING:
19378 case VAR_FUNC:
19379 copy_tv(from, to);
19380 break;
19381 case VAR_LIST:
19382 to->v_type = VAR_LIST;
19383 to->v_lock = 0;
19384 if (from->vval.v_list == NULL)
19385 to->vval.v_list = NULL;
19386 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19388 /* use the copy made earlier */
19389 to->vval.v_list = from->vval.v_list->lv_copylist;
19390 ++to->vval.v_list->lv_refcount;
19392 else
19393 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19394 if (to->vval.v_list == NULL)
19395 ret = FAIL;
19396 break;
19397 case VAR_DICT:
19398 to->v_type = VAR_DICT;
19399 to->v_lock = 0;
19400 if (from->vval.v_dict == NULL)
19401 to->vval.v_dict = NULL;
19402 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19404 /* use the copy made earlier */
19405 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19406 ++to->vval.v_dict->dv_refcount;
19408 else
19409 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19410 if (to->vval.v_dict == NULL)
19411 ret = FAIL;
19412 break;
19413 default:
19414 EMSG2(_(e_intern2), "item_copy()");
19415 ret = FAIL;
19417 --recurse;
19418 return ret;
19422 * ":echo expr1 ..." print each argument separated with a space, add a
19423 * newline at the end.
19424 * ":echon expr1 ..." print each argument plain.
19426 void
19427 ex_echo(eap)
19428 exarg_T *eap;
19430 char_u *arg = eap->arg;
19431 typval_T rettv;
19432 char_u *tofree;
19433 char_u *p;
19434 int needclr = TRUE;
19435 int atstart = TRUE;
19436 char_u numbuf[NUMBUFLEN];
19438 if (eap->skip)
19439 ++emsg_skip;
19440 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19442 /* If eval1() causes an error message the text from the command may
19443 * still need to be cleared. E.g., "echo 22,44". */
19444 need_clr_eos = needclr;
19446 p = arg;
19447 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19450 * Report the invalid expression unless the expression evaluation
19451 * has been cancelled due to an aborting error, an interrupt, or an
19452 * exception.
19454 if (!aborting())
19455 EMSG2(_(e_invexpr2), p);
19456 need_clr_eos = FALSE;
19457 break;
19459 need_clr_eos = FALSE;
19461 if (!eap->skip)
19463 if (atstart)
19465 atstart = FALSE;
19466 /* Call msg_start() after eval1(), evaluating the expression
19467 * may cause a message to appear. */
19468 if (eap->cmdidx == CMD_echo)
19469 msg_start();
19471 else if (eap->cmdidx == CMD_echo)
19472 msg_puts_attr((char_u *)" ", echo_attr);
19473 current_copyID += COPYID_INC;
19474 p = echo_string(&rettv, &tofree, numbuf, current_copyID);
19475 if (p != NULL)
19476 for ( ; *p != NUL && !got_int; ++p)
19478 if (*p == '\n' || *p == '\r' || *p == TAB)
19480 if (*p != TAB && needclr)
19482 /* remove any text still there from the command */
19483 msg_clr_eos();
19484 needclr = FALSE;
19486 msg_putchar_attr(*p, echo_attr);
19488 else
19490 #ifdef FEAT_MBYTE
19491 if (has_mbyte)
19493 int i = (*mb_ptr2len)(p);
19495 (void)msg_outtrans_len_attr(p, i, echo_attr);
19496 p += i - 1;
19498 else
19499 #endif
19500 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19503 vim_free(tofree);
19505 clear_tv(&rettv);
19506 arg = skipwhite(arg);
19508 eap->nextcmd = check_nextcmd(arg);
19510 if (eap->skip)
19511 --emsg_skip;
19512 else
19514 /* remove text that may still be there from the command */
19515 if (needclr)
19516 msg_clr_eos();
19517 if (eap->cmdidx == CMD_echo)
19518 msg_end();
19523 * ":echohl {name}".
19525 void
19526 ex_echohl(eap)
19527 exarg_T *eap;
19529 int id;
19531 id = syn_name2id(eap->arg);
19532 if (id == 0)
19533 echo_attr = 0;
19534 else
19535 echo_attr = syn_id2attr(id);
19539 * ":execute expr1 ..." execute the result of an expression.
19540 * ":echomsg expr1 ..." Print a message
19541 * ":echoerr expr1 ..." Print an error
19542 * Each gets spaces around each argument and a newline at the end for
19543 * echo commands
19545 void
19546 ex_execute(eap)
19547 exarg_T *eap;
19549 char_u *arg = eap->arg;
19550 typval_T rettv;
19551 int ret = OK;
19552 char_u *p;
19553 garray_T ga;
19554 int len;
19555 int save_did_emsg;
19557 ga_init2(&ga, 1, 80);
19559 if (eap->skip)
19560 ++emsg_skip;
19561 while (*arg != NUL && *arg != '|' && *arg != '\n')
19563 p = arg;
19564 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19567 * Report the invalid expression unless the expression evaluation
19568 * has been cancelled due to an aborting error, an interrupt, or an
19569 * exception.
19571 if (!aborting())
19572 EMSG2(_(e_invexpr2), p);
19573 ret = FAIL;
19574 break;
19577 if (!eap->skip)
19579 p = get_tv_string(&rettv);
19580 len = (int)STRLEN(p);
19581 if (ga_grow(&ga, len + 2) == FAIL)
19583 clear_tv(&rettv);
19584 ret = FAIL;
19585 break;
19587 if (ga.ga_len)
19588 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19589 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19590 ga.ga_len += len;
19593 clear_tv(&rettv);
19594 arg = skipwhite(arg);
19597 if (ret != FAIL && ga.ga_data != NULL)
19599 if (eap->cmdidx == CMD_echomsg)
19601 MSG_ATTR(ga.ga_data, echo_attr);
19602 out_flush();
19604 else if (eap->cmdidx == CMD_echoerr)
19606 /* We don't want to abort following commands, restore did_emsg. */
19607 save_did_emsg = did_emsg;
19608 EMSG((char_u *)ga.ga_data);
19609 if (!force_abort)
19610 did_emsg = save_did_emsg;
19612 else if (eap->cmdidx == CMD_execute)
19613 do_cmdline((char_u *)ga.ga_data,
19614 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19617 ga_clear(&ga);
19619 if (eap->skip)
19620 --emsg_skip;
19622 eap->nextcmd = check_nextcmd(arg);
19626 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19627 * "arg" points to the "&" or '+' when called, to "option" when returning.
19628 * Returns NULL when no option name found. Otherwise pointer to the char
19629 * after the option name.
19631 static char_u *
19632 find_option_end(arg, opt_flags)
19633 char_u **arg;
19634 int *opt_flags;
19636 char_u *p = *arg;
19638 ++p;
19639 if (*p == 'g' && p[1] == ':')
19641 *opt_flags = OPT_GLOBAL;
19642 p += 2;
19644 else if (*p == 'l' && p[1] == ':')
19646 *opt_flags = OPT_LOCAL;
19647 p += 2;
19649 else
19650 *opt_flags = 0;
19652 if (!ASCII_ISALPHA(*p))
19653 return NULL;
19654 *arg = p;
19656 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19657 p += 4; /* termcap option */
19658 else
19659 while (ASCII_ISALPHA(*p))
19660 ++p;
19661 return p;
19665 * ":function"
19667 void
19668 ex_function(eap)
19669 exarg_T *eap;
19671 char_u *theline;
19672 int j;
19673 int c;
19674 int saved_did_emsg;
19675 char_u *name = NULL;
19676 char_u *p;
19677 char_u *arg;
19678 char_u *line_arg = NULL;
19679 garray_T newargs;
19680 garray_T newlines;
19681 int varargs = FALSE;
19682 int mustend = FALSE;
19683 int flags = 0;
19684 ufunc_T *fp;
19685 int indent;
19686 int nesting;
19687 char_u *skip_until = NULL;
19688 dictitem_T *v;
19689 funcdict_T fudi;
19690 static int func_nr = 0; /* number for nameless function */
19691 int paren;
19692 hashtab_T *ht;
19693 int todo;
19694 hashitem_T *hi;
19695 int sourcing_lnum_off;
19698 * ":function" without argument: list functions.
19700 if (ends_excmd(*eap->arg))
19702 if (!eap->skip)
19704 todo = (int)func_hashtab.ht_used;
19705 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19707 if (!HASHITEM_EMPTY(hi))
19709 --todo;
19710 fp = HI2UF(hi);
19711 if (!isdigit(*fp->uf_name))
19712 list_func_head(fp, FALSE);
19716 eap->nextcmd = check_nextcmd(eap->arg);
19717 return;
19721 * ":function /pat": list functions matching pattern.
19723 if (*eap->arg == '/')
19725 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19726 if (!eap->skip)
19728 regmatch_T regmatch;
19730 c = *p;
19731 *p = NUL;
19732 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19733 *p = c;
19734 if (regmatch.regprog != NULL)
19736 regmatch.rm_ic = p_ic;
19738 todo = (int)func_hashtab.ht_used;
19739 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19741 if (!HASHITEM_EMPTY(hi))
19743 --todo;
19744 fp = HI2UF(hi);
19745 if (!isdigit(*fp->uf_name)
19746 && vim_regexec(&regmatch, fp->uf_name, 0))
19747 list_func_head(fp, FALSE);
19750 vim_free(regmatch.regprog);
19753 if (*p == '/')
19754 ++p;
19755 eap->nextcmd = check_nextcmd(p);
19756 return;
19760 * Get the function name. There are these situations:
19761 * func normal function name
19762 * "name" == func, "fudi.fd_dict" == NULL
19763 * dict.func new dictionary entry
19764 * "name" == NULL, "fudi.fd_dict" set,
19765 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19766 * dict.func existing dict entry with a Funcref
19767 * "name" == func, "fudi.fd_dict" set,
19768 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19769 * dict.func existing dict entry that's not a Funcref
19770 * "name" == NULL, "fudi.fd_dict" set,
19771 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19773 p = eap->arg;
19774 name = trans_function_name(&p, eap->skip, 0, &fudi);
19775 paren = (vim_strchr(p, '(') != NULL);
19776 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19779 * Return on an invalid expression in braces, unless the expression
19780 * evaluation has been cancelled due to an aborting error, an
19781 * interrupt, or an exception.
19783 if (!aborting())
19785 if (!eap->skip && fudi.fd_newkey != NULL)
19786 EMSG2(_(e_dictkey), fudi.fd_newkey);
19787 vim_free(fudi.fd_newkey);
19788 return;
19790 else
19791 eap->skip = TRUE;
19794 /* An error in a function call during evaluation of an expression in magic
19795 * braces should not cause the function not to be defined. */
19796 saved_did_emsg = did_emsg;
19797 did_emsg = FALSE;
19800 * ":function func" with only function name: list function.
19802 if (!paren)
19804 if (!ends_excmd(*skipwhite(p)))
19806 EMSG(_(e_trailing));
19807 goto ret_free;
19809 eap->nextcmd = check_nextcmd(p);
19810 if (eap->nextcmd != NULL)
19811 *p = NUL;
19812 if (!eap->skip && !got_int)
19814 fp = find_func(name);
19815 if (fp != NULL)
19817 list_func_head(fp, TRUE);
19818 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19820 if (FUNCLINE(fp, j) == NULL)
19821 continue;
19822 msg_putchar('\n');
19823 msg_outnum((long)(j + 1));
19824 if (j < 9)
19825 msg_putchar(' ');
19826 if (j < 99)
19827 msg_putchar(' ');
19828 msg_prt_line(FUNCLINE(fp, j), FALSE);
19829 out_flush(); /* show a line at a time */
19830 ui_breakcheck();
19832 if (!got_int)
19834 msg_putchar('\n');
19835 msg_puts((char_u *)" endfunction");
19838 else
19839 emsg_funcname(N_("E123: Undefined function: %s"), name);
19841 goto ret_free;
19845 * ":function name(arg1, arg2)" Define function.
19847 p = skipwhite(p);
19848 if (*p != '(')
19850 if (!eap->skip)
19852 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19853 goto ret_free;
19855 /* attempt to continue by skipping some text */
19856 if (vim_strchr(p, '(') != NULL)
19857 p = vim_strchr(p, '(');
19859 p = skipwhite(p + 1);
19861 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19862 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19864 if (!eap->skip)
19866 /* Check the name of the function. Unless it's a dictionary function
19867 * (that we are overwriting). */
19868 if (name != NULL)
19869 arg = name;
19870 else
19871 arg = fudi.fd_newkey;
19872 if (arg != NULL && (fudi.fd_di == NULL
19873 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19875 if (*arg == K_SPECIAL)
19876 j = 3;
19877 else
19878 j = 0;
19879 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19880 : eval_isnamec(arg[j])))
19881 ++j;
19882 if (arg[j] != NUL)
19883 emsg_funcname((char *)e_invarg2, arg);
19888 * Isolate the arguments: "arg1, arg2, ...)"
19890 while (*p != ')')
19892 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19894 varargs = TRUE;
19895 p += 3;
19896 mustend = TRUE;
19898 else
19900 arg = p;
19901 while (ASCII_ISALNUM(*p) || *p == '_')
19902 ++p;
19903 if (arg == p || isdigit(*arg)
19904 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19905 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19907 if (!eap->skip)
19908 EMSG2(_("E125: Illegal argument: %s"), arg);
19909 break;
19911 if (ga_grow(&newargs, 1) == FAIL)
19912 goto erret;
19913 c = *p;
19914 *p = NUL;
19915 arg = vim_strsave(arg);
19916 if (arg == NULL)
19917 goto erret;
19918 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19919 *p = c;
19920 newargs.ga_len++;
19921 if (*p == ',')
19922 ++p;
19923 else
19924 mustend = TRUE;
19926 p = skipwhite(p);
19927 if (mustend && *p != ')')
19929 if (!eap->skip)
19930 EMSG2(_(e_invarg2), eap->arg);
19931 break;
19934 ++p; /* skip the ')' */
19936 /* find extra arguments "range", "dict" and "abort" */
19937 for (;;)
19939 p = skipwhite(p);
19940 if (STRNCMP(p, "range", 5) == 0)
19942 flags |= FC_RANGE;
19943 p += 5;
19945 else if (STRNCMP(p, "dict", 4) == 0)
19947 flags |= FC_DICT;
19948 p += 4;
19950 else if (STRNCMP(p, "abort", 5) == 0)
19952 flags |= FC_ABORT;
19953 p += 5;
19955 else
19956 break;
19959 /* When there is a line break use what follows for the function body.
19960 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19961 if (*p == '\n')
19962 line_arg = p + 1;
19963 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19964 EMSG(_(e_trailing));
19967 * Read the body of the function, until ":endfunction" is found.
19969 if (KeyTyped)
19971 /* Check if the function already exists, don't let the user type the
19972 * whole function before telling him it doesn't work! For a script we
19973 * need to skip the body to be able to find what follows. */
19974 if (!eap->skip && !eap->forceit)
19976 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19977 EMSG(_(e_funcdict));
19978 else if (name != NULL && find_func(name) != NULL)
19979 emsg_funcname(e_funcexts, name);
19982 if (!eap->skip && did_emsg)
19983 goto erret;
19985 msg_putchar('\n'); /* don't overwrite the function name */
19986 cmdline_row = msg_row;
19989 indent = 2;
19990 nesting = 0;
19991 for (;;)
19993 msg_scroll = TRUE;
19994 need_wait_return = FALSE;
19995 sourcing_lnum_off = sourcing_lnum;
19997 if (line_arg != NULL)
19999 /* Use eap->arg, split up in parts by line breaks. */
20000 theline = line_arg;
20001 p = vim_strchr(theline, '\n');
20002 if (p == NULL)
20003 line_arg += STRLEN(line_arg);
20004 else
20006 *p = NUL;
20007 line_arg = p + 1;
20010 else if (eap->getline == NULL)
20011 theline = getcmdline(':', 0L, indent);
20012 else
20013 theline = eap->getline(':', eap->cookie, indent);
20014 if (KeyTyped)
20015 lines_left = Rows - 1;
20016 if (theline == NULL)
20018 EMSG(_("E126: Missing :endfunction"));
20019 goto erret;
20022 /* Detect line continuation: sourcing_lnum increased more than one. */
20023 if (sourcing_lnum > sourcing_lnum_off + 1)
20024 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20025 else
20026 sourcing_lnum_off = 0;
20028 if (skip_until != NULL)
20030 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20031 * don't check for ":endfunc". */
20032 if (STRCMP(theline, skip_until) == 0)
20034 vim_free(skip_until);
20035 skip_until = NULL;
20038 else
20040 /* skip ':' and blanks*/
20041 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20044 /* Check for "endfunction". */
20045 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20047 if (line_arg == NULL)
20048 vim_free(theline);
20049 break;
20052 /* Increase indent inside "if", "while", "for" and "try", decrease
20053 * at "end". */
20054 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20055 indent -= 2;
20056 else if (STRNCMP(p, "if", 2) == 0
20057 || STRNCMP(p, "wh", 2) == 0
20058 || STRNCMP(p, "for", 3) == 0
20059 || STRNCMP(p, "try", 3) == 0)
20060 indent += 2;
20062 /* Check for defining a function inside this function. */
20063 if (checkforcmd(&p, "function", 2))
20065 if (*p == '!')
20066 p = skipwhite(p + 1);
20067 p += eval_fname_script(p);
20068 if (ASCII_ISALPHA(*p))
20070 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20071 if (*skipwhite(p) == '(')
20073 ++nesting;
20074 indent += 2;
20079 /* Check for ":append" or ":insert". */
20080 p = skip_range(p, NULL);
20081 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20082 || (p[0] == 'i'
20083 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20084 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20085 skip_until = vim_strsave((char_u *)".");
20087 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20088 arg = skipwhite(skiptowhite(p));
20089 if (arg[0] == '<' && arg[1] =='<'
20090 && ((p[0] == 'p' && p[1] == 'y'
20091 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20092 || (p[0] == 'p' && p[1] == 'e'
20093 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20094 || (p[0] == 't' && p[1] == 'c'
20095 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20096 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20097 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20098 || (p[0] == 'm' && p[1] == 'z'
20099 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20102 /* ":python <<" continues until a dot, like ":append" */
20103 p = skipwhite(arg + 2);
20104 if (*p == NUL)
20105 skip_until = vim_strsave((char_u *)".");
20106 else
20107 skip_until = vim_strsave(p);
20111 /* Add the line to the function. */
20112 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20114 if (line_arg == NULL)
20115 vim_free(theline);
20116 goto erret;
20119 /* Copy the line to newly allocated memory. get_one_sourceline()
20120 * allocates 250 bytes per line, this saves 80% on average. The cost
20121 * is an extra alloc/free. */
20122 p = vim_strsave(theline);
20123 if (p != NULL)
20125 if (line_arg == NULL)
20126 vim_free(theline);
20127 theline = p;
20130 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20132 /* Add NULL lines for continuation lines, so that the line count is
20133 * equal to the index in the growarray. */
20134 while (sourcing_lnum_off-- > 0)
20135 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20137 /* Check for end of eap->arg. */
20138 if (line_arg != NULL && *line_arg == NUL)
20139 line_arg = NULL;
20142 /* Don't define the function when skipping commands or when an error was
20143 * detected. */
20144 if (eap->skip || did_emsg)
20145 goto erret;
20148 * If there are no errors, add the function
20150 if (fudi.fd_dict == NULL)
20152 v = find_var(name, &ht);
20153 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20155 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
20156 name);
20157 goto erret;
20160 fp = find_func(name);
20161 if (fp != NULL)
20163 if (!eap->forceit)
20165 emsg_funcname(e_funcexts, name);
20166 goto erret;
20168 if (fp->uf_calls > 0)
20170 emsg_funcname(N_("E127: Cannot redefine function %s: It is in use"),
20171 name);
20172 goto erret;
20174 /* redefine existing function */
20175 ga_clear_strings(&(fp->uf_args));
20176 ga_clear_strings(&(fp->uf_lines));
20177 vim_free(name);
20178 name = NULL;
20181 else
20183 char numbuf[20];
20185 fp = NULL;
20186 if (fudi.fd_newkey == NULL && !eap->forceit)
20188 EMSG(_(e_funcdict));
20189 goto erret;
20191 if (fudi.fd_di == NULL)
20193 /* Can't add a function to a locked dictionary */
20194 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20195 goto erret;
20197 /* Can't change an existing function if it is locked */
20198 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20199 goto erret;
20201 /* Give the function a sequential number. Can only be used with a
20202 * Funcref! */
20203 vim_free(name);
20204 sprintf(numbuf, "%d", ++func_nr);
20205 name = vim_strsave((char_u *)numbuf);
20206 if (name == NULL)
20207 goto erret;
20210 if (fp == NULL)
20212 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20214 int slen, plen;
20215 char_u *scriptname;
20217 /* Check that the autoload name matches the script name. */
20218 j = FAIL;
20219 if (sourcing_name != NULL)
20221 scriptname = autoload_name(name);
20222 if (scriptname != NULL)
20224 p = vim_strchr(scriptname, '/');
20225 plen = (int)STRLEN(p);
20226 slen = (int)STRLEN(sourcing_name);
20227 if (slen > plen && fnamecmp(p,
20228 sourcing_name + slen - plen) == 0)
20229 j = OK;
20230 vim_free(scriptname);
20233 if (j == FAIL)
20235 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20236 goto erret;
20240 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20241 if (fp == NULL)
20242 goto erret;
20244 if (fudi.fd_dict != NULL)
20246 if (fudi.fd_di == NULL)
20248 /* add new dict entry */
20249 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20250 if (fudi.fd_di == NULL)
20252 vim_free(fp);
20253 goto erret;
20255 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20257 vim_free(fudi.fd_di);
20258 vim_free(fp);
20259 goto erret;
20262 else
20263 /* overwrite existing dict entry */
20264 clear_tv(&fudi.fd_di->di_tv);
20265 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20266 fudi.fd_di->di_tv.v_lock = 0;
20267 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20268 fp->uf_refcount = 1;
20270 /* behave like "dict" was used */
20271 flags |= FC_DICT;
20274 /* insert the new function in the function list */
20275 STRCPY(fp->uf_name, name);
20276 hash_add(&func_hashtab, UF2HIKEY(fp));
20278 fp->uf_args = newargs;
20279 fp->uf_lines = newlines;
20280 #ifdef FEAT_PROFILE
20281 fp->uf_tml_count = NULL;
20282 fp->uf_tml_total = NULL;
20283 fp->uf_tml_self = NULL;
20284 fp->uf_profiling = FALSE;
20285 if (prof_def_func())
20286 func_do_profile(fp);
20287 #endif
20288 fp->uf_varargs = varargs;
20289 fp->uf_flags = flags;
20290 fp->uf_calls = 0;
20291 fp->uf_script_ID = current_SID;
20292 goto ret_free;
20294 erret:
20295 ga_clear_strings(&newargs);
20296 ga_clear_strings(&newlines);
20297 ret_free:
20298 vim_free(skip_until);
20299 vim_free(fudi.fd_newkey);
20300 vim_free(name);
20301 did_emsg |= saved_did_emsg;
20305 * Get a function name, translating "<SID>" and "<SNR>".
20306 * Also handles a Funcref in a List or Dictionary.
20307 * Returns the function name in allocated memory, or NULL for failure.
20308 * flags:
20309 * TFN_INT: internal function name OK
20310 * TFN_QUIET: be quiet
20311 * Advances "pp" to just after the function name (if no error).
20313 static char_u *
20314 trans_function_name(pp, skip, flags, fdp)
20315 char_u **pp;
20316 int skip; /* only find the end, don't evaluate */
20317 int flags;
20318 funcdict_T *fdp; /* return: info about dictionary used */
20320 char_u *name = NULL;
20321 char_u *start;
20322 char_u *end;
20323 int lead;
20324 char_u sid_buf[20];
20325 int len;
20326 lval_T lv;
20328 if (fdp != NULL)
20329 vim_memset(fdp, 0, sizeof(funcdict_T));
20330 start = *pp;
20332 /* Check for hard coded <SNR>: already translated function ID (from a user
20333 * command). */
20334 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20335 && (*pp)[2] == (int)KE_SNR)
20337 *pp += 3;
20338 len = get_id_len(pp) + 3;
20339 return vim_strnsave(start, len);
20342 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20343 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20344 lead = eval_fname_script(start);
20345 if (lead > 2)
20346 start += lead;
20348 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20349 lead > 2 ? 0 : FNE_CHECK_START);
20350 if (end == start)
20352 if (!skip)
20353 EMSG(_("E129: Function name required"));
20354 goto theend;
20356 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20359 * Report an invalid expression in braces, unless the expression
20360 * evaluation has been cancelled due to an aborting error, an
20361 * interrupt, or an exception.
20363 if (!aborting())
20365 if (end != NULL)
20366 EMSG2(_(e_invarg2), start);
20368 else
20369 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20370 goto theend;
20373 if (lv.ll_tv != NULL)
20375 if (fdp != NULL)
20377 fdp->fd_dict = lv.ll_dict;
20378 fdp->fd_newkey = lv.ll_newkey;
20379 lv.ll_newkey = NULL;
20380 fdp->fd_di = lv.ll_di;
20382 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20384 name = vim_strsave(lv.ll_tv->vval.v_string);
20385 *pp = end;
20387 else
20389 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20390 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20391 EMSG(_(e_funcref));
20392 else
20393 *pp = end;
20394 name = NULL;
20396 goto theend;
20399 if (lv.ll_name == NULL)
20401 /* Error found, but continue after the function name. */
20402 *pp = end;
20403 goto theend;
20406 /* Check if the name is a Funcref. If so, use the value. */
20407 if (lv.ll_exp_name != NULL)
20409 len = (int)STRLEN(lv.ll_exp_name);
20410 name = deref_func_name(lv.ll_exp_name, &len);
20411 if (name == lv.ll_exp_name)
20412 name = NULL;
20414 else
20416 len = (int)(end - *pp);
20417 name = deref_func_name(*pp, &len);
20418 if (name == *pp)
20419 name = NULL;
20421 if (name != NULL)
20423 name = vim_strsave(name);
20424 *pp = end;
20425 goto theend;
20428 if (lv.ll_exp_name != NULL)
20430 len = (int)STRLEN(lv.ll_exp_name);
20431 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20432 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20434 /* When there was "s:" already or the name expanded to get a
20435 * leading "s:" then remove it. */
20436 lv.ll_name += 2;
20437 len -= 2;
20438 lead = 2;
20441 else
20443 if (lead == 2) /* skip over "s:" */
20444 lv.ll_name += 2;
20445 len = (int)(end - lv.ll_name);
20449 * Copy the function name to allocated memory.
20450 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20451 * Accept <SNR>123_name() outside a script.
20453 if (skip)
20454 lead = 0; /* do nothing */
20455 else if (lead > 0)
20457 lead = 3;
20458 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20459 || eval_fname_sid(*pp))
20461 /* It's "s:" or "<SID>" */
20462 if (current_SID <= 0)
20464 EMSG(_(e_usingsid));
20465 goto theend;
20467 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20468 lead += (int)STRLEN(sid_buf);
20471 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20473 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20474 goto theend;
20476 name = alloc((unsigned)(len + lead + 1));
20477 if (name != NULL)
20479 if (lead > 0)
20481 name[0] = K_SPECIAL;
20482 name[1] = KS_EXTRA;
20483 name[2] = (int)KE_SNR;
20484 if (lead > 3) /* If it's "<SID>" */
20485 STRCPY(name + 3, sid_buf);
20487 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20488 name[len + lead] = NUL;
20490 *pp = end;
20492 theend:
20493 clear_lval(&lv);
20494 return name;
20498 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20499 * Return 2 if "p" starts with "s:".
20500 * Return 0 otherwise.
20502 static int
20503 eval_fname_script(p)
20504 char_u *p;
20506 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20507 || STRNICMP(p + 1, "SNR>", 4) == 0))
20508 return 5;
20509 if (p[0] == 's' && p[1] == ':')
20510 return 2;
20511 return 0;
20515 * Return TRUE if "p" starts with "<SID>" or "s:".
20516 * Only works if eval_fname_script() returned non-zero for "p"!
20518 static int
20519 eval_fname_sid(p)
20520 char_u *p;
20522 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20526 * List the head of the function: "name(arg1, arg2)".
20528 static void
20529 list_func_head(fp, indent)
20530 ufunc_T *fp;
20531 int indent;
20533 int j;
20535 msg_start();
20536 if (indent)
20537 MSG_PUTS(" ");
20538 MSG_PUTS("function ");
20539 if (fp->uf_name[0] == K_SPECIAL)
20541 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20542 msg_puts(fp->uf_name + 3);
20544 else
20545 msg_puts(fp->uf_name);
20546 msg_putchar('(');
20547 for (j = 0; j < fp->uf_args.ga_len; ++j)
20549 if (j)
20550 MSG_PUTS(", ");
20551 msg_puts(FUNCARG(fp, j));
20553 if (fp->uf_varargs)
20555 if (j)
20556 MSG_PUTS(", ");
20557 MSG_PUTS("...");
20559 msg_putchar(')');
20560 msg_clr_eos();
20561 if (p_verbose > 0)
20562 last_set_msg(fp->uf_script_ID);
20566 * Find a function by name, return pointer to it in ufuncs.
20567 * Return NULL for unknown function.
20569 static ufunc_T *
20570 find_func(name)
20571 char_u *name;
20573 hashitem_T *hi;
20575 hi = hash_find(&func_hashtab, name);
20576 if (!HASHITEM_EMPTY(hi))
20577 return HI2UF(hi);
20578 return NULL;
20581 #if defined(EXITFREE) || defined(PROTO)
20582 void
20583 free_all_functions()
20585 hashitem_T *hi;
20587 /* Need to start all over every time, because func_free() may change the
20588 * hash table. */
20589 while (func_hashtab.ht_used > 0)
20590 for (hi = func_hashtab.ht_array; ; ++hi)
20591 if (!HASHITEM_EMPTY(hi))
20593 func_free(HI2UF(hi));
20594 break;
20597 #endif
20600 * Return TRUE if a function "name" exists.
20602 static int
20603 function_exists(name)
20604 char_u *name;
20606 char_u *nm = name;
20607 char_u *p;
20608 int n = FALSE;
20610 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20611 nm = skipwhite(nm);
20613 /* Only accept "funcname", "funcname ", "funcname (..." and
20614 * "funcname(...", not "funcname!...". */
20615 if (p != NULL && (*nm == NUL || *nm == '('))
20617 if (builtin_function(p))
20618 n = (find_internal_func(p) >= 0);
20619 else
20620 n = (find_func(p) != NULL);
20622 vim_free(p);
20623 return n;
20627 * Return TRUE if "name" looks like a builtin function name: starts with a
20628 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20630 static int
20631 builtin_function(name)
20632 char_u *name;
20634 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20635 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20638 #if defined(FEAT_PROFILE) || defined(PROTO)
20640 * Start profiling function "fp".
20642 static void
20643 func_do_profile(fp)
20644 ufunc_T *fp;
20646 fp->uf_tm_count = 0;
20647 profile_zero(&fp->uf_tm_self);
20648 profile_zero(&fp->uf_tm_total);
20649 if (fp->uf_tml_count == NULL)
20650 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20651 (sizeof(int) * fp->uf_lines.ga_len));
20652 if (fp->uf_tml_total == NULL)
20653 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20654 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20655 if (fp->uf_tml_self == NULL)
20656 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20657 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20658 fp->uf_tml_idx = -1;
20659 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20660 || fp->uf_tml_self == NULL)
20661 return; /* out of memory */
20663 fp->uf_profiling = TRUE;
20667 * Dump the profiling results for all functions in file "fd".
20669 void
20670 func_dump_profile(fd)
20671 FILE *fd;
20673 hashitem_T *hi;
20674 int todo;
20675 ufunc_T *fp;
20676 int i;
20677 ufunc_T **sorttab;
20678 int st_len = 0;
20680 todo = (int)func_hashtab.ht_used;
20681 if (todo == 0)
20682 return; /* nothing to dump */
20684 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20686 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20688 if (!HASHITEM_EMPTY(hi))
20690 --todo;
20691 fp = HI2UF(hi);
20692 if (fp->uf_profiling)
20694 if (sorttab != NULL)
20695 sorttab[st_len++] = fp;
20697 if (fp->uf_name[0] == K_SPECIAL)
20698 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20699 else
20700 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20701 if (fp->uf_tm_count == 1)
20702 fprintf(fd, "Called 1 time\n");
20703 else
20704 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20705 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20706 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20707 fprintf(fd, "\n");
20708 fprintf(fd, "count total (s) self (s)\n");
20710 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20712 if (FUNCLINE(fp, i) == NULL)
20713 continue;
20714 prof_func_line(fd, fp->uf_tml_count[i],
20715 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20716 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20718 fprintf(fd, "\n");
20723 if (sorttab != NULL && st_len > 0)
20725 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20726 prof_total_cmp);
20727 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20728 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20729 prof_self_cmp);
20730 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20733 vim_free(sorttab);
20736 static void
20737 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20738 FILE *fd;
20739 ufunc_T **sorttab;
20740 int st_len;
20741 char *title;
20742 int prefer_self; /* when equal print only self time */
20744 int i;
20745 ufunc_T *fp;
20747 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20748 fprintf(fd, "count total (s) self (s) function\n");
20749 for (i = 0; i < 20 && i < st_len; ++i)
20751 fp = sorttab[i];
20752 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20753 prefer_self);
20754 if (fp->uf_name[0] == K_SPECIAL)
20755 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20756 else
20757 fprintf(fd, " %s()\n", fp->uf_name);
20759 fprintf(fd, "\n");
20763 * Print the count and times for one function or function line.
20765 static void
20766 prof_func_line(fd, count, total, self, prefer_self)
20767 FILE *fd;
20768 int count;
20769 proftime_T *total;
20770 proftime_T *self;
20771 int prefer_self; /* when equal print only self time */
20773 if (count > 0)
20775 fprintf(fd, "%5d ", count);
20776 if (prefer_self && profile_equal(total, self))
20777 fprintf(fd, " ");
20778 else
20779 fprintf(fd, "%s ", profile_msg(total));
20780 if (!prefer_self && profile_equal(total, self))
20781 fprintf(fd, " ");
20782 else
20783 fprintf(fd, "%s ", profile_msg(self));
20785 else
20786 fprintf(fd, " ");
20790 * Compare function for total time sorting.
20792 static int
20793 #ifdef __BORLANDC__
20794 _RTLENTRYF
20795 #endif
20796 prof_total_cmp(s1, s2)
20797 const void *s1;
20798 const void *s2;
20800 ufunc_T *p1, *p2;
20802 p1 = *(ufunc_T **)s1;
20803 p2 = *(ufunc_T **)s2;
20804 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20808 * Compare function for self time sorting.
20810 static int
20811 #ifdef __BORLANDC__
20812 _RTLENTRYF
20813 #endif
20814 prof_self_cmp(s1, s2)
20815 const void *s1;
20816 const void *s2;
20818 ufunc_T *p1, *p2;
20820 p1 = *(ufunc_T **)s1;
20821 p2 = *(ufunc_T **)s2;
20822 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20825 #endif
20828 * If "name" has a package name try autoloading the script for it.
20829 * Return TRUE if a package was loaded.
20831 static int
20832 script_autoload(name, reload)
20833 char_u *name;
20834 int reload; /* load script again when already loaded */
20836 char_u *p;
20837 char_u *scriptname, *tofree;
20838 int ret = FALSE;
20839 int i;
20841 /* If there is no '#' after name[0] there is no package name. */
20842 p = vim_strchr(name, AUTOLOAD_CHAR);
20843 if (p == NULL || p == name)
20844 return FALSE;
20846 tofree = scriptname = autoload_name(name);
20848 /* Find the name in the list of previously loaded package names. Skip
20849 * "autoload/", it's always the same. */
20850 for (i = 0; i < ga_loaded.ga_len; ++i)
20851 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20852 break;
20853 if (!reload && i < ga_loaded.ga_len)
20854 ret = FALSE; /* was loaded already */
20855 else
20857 /* Remember the name if it wasn't loaded already. */
20858 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20860 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20861 tofree = NULL;
20864 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20865 if (source_runtime(scriptname, FALSE) == OK)
20866 ret = TRUE;
20869 vim_free(tofree);
20870 return ret;
20874 * Return the autoload script name for a function or variable name.
20875 * Returns NULL when out of memory.
20877 static char_u *
20878 autoload_name(name)
20879 char_u *name;
20881 char_u *p;
20882 char_u *scriptname;
20884 /* Get the script file name: replace '#' with '/', append ".vim". */
20885 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20886 if (scriptname == NULL)
20887 return FALSE;
20888 STRCPY(scriptname, "autoload/");
20889 STRCAT(scriptname, name);
20890 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20891 STRCAT(scriptname, ".vim");
20892 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20893 *p = '/';
20894 return scriptname;
20897 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20900 * Function given to ExpandGeneric() to obtain the list of user defined
20901 * function names.
20903 char_u *
20904 get_user_func_name(xp, idx)
20905 expand_T *xp;
20906 int idx;
20908 static long_u done;
20909 static hashitem_T *hi;
20910 ufunc_T *fp;
20912 if (idx == 0)
20914 done = 0;
20915 hi = func_hashtab.ht_array;
20917 if (done < func_hashtab.ht_used)
20919 if (done++ > 0)
20920 ++hi;
20921 while (HASHITEM_EMPTY(hi))
20922 ++hi;
20923 fp = HI2UF(hi);
20925 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20926 return fp->uf_name; /* prevents overflow */
20928 cat_func_name(IObuff, fp);
20929 if (xp->xp_context != EXPAND_USER_FUNC)
20931 STRCAT(IObuff, "(");
20932 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20933 STRCAT(IObuff, ")");
20935 return IObuff;
20937 return NULL;
20940 #endif /* FEAT_CMDL_COMPL */
20943 * Copy the function name of "fp" to buffer "buf".
20944 * "buf" must be able to hold the function name plus three bytes.
20945 * Takes care of script-local function names.
20947 static void
20948 cat_func_name(buf, fp)
20949 char_u *buf;
20950 ufunc_T *fp;
20952 if (fp->uf_name[0] == K_SPECIAL)
20954 STRCPY(buf, "<SNR>");
20955 STRCAT(buf, fp->uf_name + 3);
20957 else
20958 STRCPY(buf, fp->uf_name);
20962 * ":delfunction {name}"
20964 void
20965 ex_delfunction(eap)
20966 exarg_T *eap;
20968 ufunc_T *fp = NULL;
20969 char_u *p;
20970 char_u *name;
20971 funcdict_T fudi;
20973 p = eap->arg;
20974 name = trans_function_name(&p, eap->skip, 0, &fudi);
20975 vim_free(fudi.fd_newkey);
20976 if (name == NULL)
20978 if (fudi.fd_dict != NULL && !eap->skip)
20979 EMSG(_(e_funcref));
20980 return;
20982 if (!ends_excmd(*skipwhite(p)))
20984 vim_free(name);
20985 EMSG(_(e_trailing));
20986 return;
20988 eap->nextcmd = check_nextcmd(p);
20989 if (eap->nextcmd != NULL)
20990 *p = NUL;
20992 if (!eap->skip)
20993 fp = find_func(name);
20994 vim_free(name);
20996 if (!eap->skip)
20998 if (fp == NULL)
21000 EMSG2(_(e_nofunc), eap->arg);
21001 return;
21003 if (fp->uf_calls > 0)
21005 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21006 return;
21009 if (fudi.fd_dict != NULL)
21011 /* Delete the dict item that refers to the function, it will
21012 * invoke func_unref() and possibly delete the function. */
21013 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21015 else
21016 func_free(fp);
21021 * Free a function and remove it from the list of functions.
21023 static void
21024 func_free(fp)
21025 ufunc_T *fp;
21027 hashitem_T *hi;
21029 /* clear this function */
21030 ga_clear_strings(&(fp->uf_args));
21031 ga_clear_strings(&(fp->uf_lines));
21032 #ifdef FEAT_PROFILE
21033 vim_free(fp->uf_tml_count);
21034 vim_free(fp->uf_tml_total);
21035 vim_free(fp->uf_tml_self);
21036 #endif
21038 /* remove the function from the function hashtable */
21039 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21040 if (HASHITEM_EMPTY(hi))
21041 EMSG2(_(e_intern2), "func_free()");
21042 else
21043 hash_remove(&func_hashtab, hi);
21045 vim_free(fp);
21049 * Unreference a Function: decrement the reference count and free it when it
21050 * becomes zero. Only for numbered functions.
21052 static void
21053 func_unref(name)
21054 char_u *name;
21056 ufunc_T *fp;
21058 if (name != NULL && isdigit(*name))
21060 fp = find_func(name);
21061 if (fp == NULL)
21062 EMSG2(_(e_intern2), "func_unref()");
21063 else if (--fp->uf_refcount <= 0)
21065 /* Only delete it when it's not being used. Otherwise it's done
21066 * when "uf_calls" becomes zero. */
21067 if (fp->uf_calls == 0)
21068 func_free(fp);
21074 * Count a reference to a Function.
21076 static void
21077 func_ref(name)
21078 char_u *name;
21080 ufunc_T *fp;
21082 if (name != NULL && isdigit(*name))
21084 fp = find_func(name);
21085 if (fp == NULL)
21086 EMSG2(_(e_intern2), "func_ref()");
21087 else
21088 ++fp->uf_refcount;
21093 * Call a user function.
21095 static void
21096 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21097 ufunc_T *fp; /* pointer to function */
21098 int argcount; /* nr of args */
21099 typval_T *argvars; /* arguments */
21100 typval_T *rettv; /* return value */
21101 linenr_T firstline; /* first line of range */
21102 linenr_T lastline; /* last line of range */
21103 dict_T *selfdict; /* Dictionary for "self" */
21105 char_u *save_sourcing_name;
21106 linenr_T save_sourcing_lnum;
21107 scid_T save_current_SID;
21108 funccall_T *fc;
21109 int save_did_emsg;
21110 static int depth = 0;
21111 dictitem_T *v;
21112 int fixvar_idx = 0; /* index in fixvar[] */
21113 int i;
21114 int ai;
21115 char_u numbuf[NUMBUFLEN];
21116 char_u *name;
21117 #ifdef FEAT_PROFILE
21118 proftime_T wait_start;
21119 proftime_T call_start;
21120 #endif
21122 /* If depth of calling is getting too high, don't execute the function */
21123 if (depth >= p_mfd)
21125 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21126 rettv->v_type = VAR_NUMBER;
21127 rettv->vval.v_number = -1;
21128 return;
21130 ++depth;
21132 line_breakcheck(); /* check for CTRL-C hit */
21134 fc = (funccall_T *)alloc(sizeof(funccall_T));
21135 fc->caller = current_funccal;
21136 current_funccal = fc;
21137 fc->func = fp;
21138 fc->rettv = rettv;
21139 rettv->vval.v_number = 0;
21140 fc->linenr = 0;
21141 fc->returned = FALSE;
21142 fc->level = ex_nesting_level;
21143 /* Check if this function has a breakpoint. */
21144 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21145 fc->dbg_tick = debug_tick;
21148 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21149 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21150 * each argument variable and saves a lot of time.
21153 * Init l: variables.
21155 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21156 if (selfdict != NULL)
21158 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21159 * some compiler that checks the destination size. */
21160 v = &fc->fixvar[fixvar_idx++].var;
21161 name = v->di_key;
21162 STRCPY(name, "self");
21163 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21164 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21165 v->di_tv.v_type = VAR_DICT;
21166 v->di_tv.v_lock = 0;
21167 v->di_tv.vval.v_dict = selfdict;
21168 ++selfdict->dv_refcount;
21172 * Init a: variables.
21173 * Set a:0 to "argcount".
21174 * Set a:000 to a list with room for the "..." arguments.
21176 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21177 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21178 (varnumber_T)(argcount - fp->uf_args.ga_len));
21179 /* Use "name" to avoid a warning from some compiler that checks the
21180 * destination size. */
21181 v = &fc->fixvar[fixvar_idx++].var;
21182 name = v->di_key;
21183 STRCPY(name, "000");
21184 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21185 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21186 v->di_tv.v_type = VAR_LIST;
21187 v->di_tv.v_lock = VAR_FIXED;
21188 v->di_tv.vval.v_list = &fc->l_varlist;
21189 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21190 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21191 fc->l_varlist.lv_lock = VAR_FIXED;
21194 * Set a:firstline to "firstline" and a:lastline to "lastline".
21195 * Set a:name to named arguments.
21196 * Set a:N to the "..." arguments.
21198 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21199 (varnumber_T)firstline);
21200 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21201 (varnumber_T)lastline);
21202 for (i = 0; i < argcount; ++i)
21204 ai = i - fp->uf_args.ga_len;
21205 if (ai < 0)
21206 /* named argument a:name */
21207 name = FUNCARG(fp, i);
21208 else
21210 /* "..." argument a:1, a:2, etc. */
21211 sprintf((char *)numbuf, "%d", ai + 1);
21212 name = numbuf;
21214 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21216 v = &fc->fixvar[fixvar_idx++].var;
21217 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21219 else
21221 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21222 + STRLEN(name)));
21223 if (v == NULL)
21224 break;
21225 v->di_flags = DI_FLAGS_RO;
21227 STRCPY(v->di_key, name);
21228 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21230 /* Note: the values are copied directly to avoid alloc/free.
21231 * "argvars" must have VAR_FIXED for v_lock. */
21232 v->di_tv = argvars[i];
21233 v->di_tv.v_lock = VAR_FIXED;
21235 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21237 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21238 fc->l_listitems[ai].li_tv = argvars[i];
21239 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21243 /* Don't redraw while executing the function. */
21244 ++RedrawingDisabled;
21245 save_sourcing_name = sourcing_name;
21246 save_sourcing_lnum = sourcing_lnum;
21247 sourcing_lnum = 1;
21248 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21249 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21250 if (sourcing_name != NULL)
21252 if (save_sourcing_name != NULL
21253 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21254 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21255 else
21256 STRCPY(sourcing_name, "function ");
21257 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21259 if (p_verbose >= 12)
21261 ++no_wait_return;
21262 verbose_enter_scroll();
21264 smsg((char_u *)_("calling %s"), sourcing_name);
21265 if (p_verbose >= 14)
21267 char_u buf[MSG_BUF_LEN];
21268 char_u numbuf2[NUMBUFLEN];
21269 char_u *tofree;
21270 char_u *s;
21272 msg_puts((char_u *)"(");
21273 for (i = 0; i < argcount; ++i)
21275 if (i > 0)
21276 msg_puts((char_u *)", ");
21277 if (argvars[i].v_type == VAR_NUMBER)
21278 msg_outnum((long)argvars[i].vval.v_number);
21279 else
21281 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21282 if (s != NULL)
21284 trunc_string(s, buf, MSG_BUF_CLEN);
21285 msg_puts(buf);
21286 vim_free(tofree);
21290 msg_puts((char_u *)")");
21292 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21294 verbose_leave_scroll();
21295 --no_wait_return;
21298 #ifdef FEAT_PROFILE
21299 if (do_profiling == PROF_YES)
21301 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21302 func_do_profile(fp);
21303 if (fp->uf_profiling
21304 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21306 ++fp->uf_tm_count;
21307 profile_start(&call_start);
21308 profile_zero(&fp->uf_tm_children);
21310 script_prof_save(&wait_start);
21312 #endif
21314 save_current_SID = current_SID;
21315 current_SID = fp->uf_script_ID;
21316 save_did_emsg = did_emsg;
21317 did_emsg = FALSE;
21319 /* call do_cmdline() to execute the lines */
21320 do_cmdline(NULL, get_func_line, (void *)fc,
21321 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21323 --RedrawingDisabled;
21325 /* when the function was aborted because of an error, return -1 */
21326 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21328 clear_tv(rettv);
21329 rettv->v_type = VAR_NUMBER;
21330 rettv->vval.v_number = -1;
21333 #ifdef FEAT_PROFILE
21334 if (do_profiling == PROF_YES && (fp->uf_profiling
21335 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21337 profile_end(&call_start);
21338 profile_sub_wait(&wait_start, &call_start);
21339 profile_add(&fp->uf_tm_total, &call_start);
21340 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21341 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21343 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21344 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21347 #endif
21349 /* when being verbose, mention the return value */
21350 if (p_verbose >= 12)
21352 ++no_wait_return;
21353 verbose_enter_scroll();
21355 if (aborting())
21356 smsg((char_u *)_("%s aborted"), sourcing_name);
21357 else if (fc->rettv->v_type == VAR_NUMBER)
21358 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21359 (long)fc->rettv->vval.v_number);
21360 else
21362 char_u buf[MSG_BUF_LEN];
21363 char_u numbuf2[NUMBUFLEN];
21364 char_u *tofree;
21365 char_u *s;
21367 /* The value may be very long. Skip the middle part, so that we
21368 * have some idea how it starts and ends. smsg() would always
21369 * truncate it at the end. */
21370 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21371 if (s != NULL)
21373 trunc_string(s, buf, MSG_BUF_CLEN);
21374 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21375 vim_free(tofree);
21378 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21380 verbose_leave_scroll();
21381 --no_wait_return;
21384 vim_free(sourcing_name);
21385 sourcing_name = save_sourcing_name;
21386 sourcing_lnum = save_sourcing_lnum;
21387 current_SID = save_current_SID;
21388 #ifdef FEAT_PROFILE
21389 if (do_profiling == PROF_YES)
21390 script_prof_restore(&wait_start);
21391 #endif
21393 if (p_verbose >= 12 && sourcing_name != NULL)
21395 ++no_wait_return;
21396 verbose_enter_scroll();
21398 smsg((char_u *)_("continuing in %s"), sourcing_name);
21399 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21401 verbose_leave_scroll();
21402 --no_wait_return;
21405 did_emsg |= save_did_emsg;
21406 current_funccal = fc->caller;
21407 --depth;
21409 /* If the a:000 list and the l: and a: dicts are not referenced we can
21410 * free the funccall_T and what's in it. */
21411 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21412 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21413 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21415 free_funccal(fc, FALSE);
21417 else
21419 hashitem_T *hi;
21420 listitem_T *li;
21421 int todo;
21423 /* "fc" is still in use. This can happen when returning "a:000" or
21424 * assigning "l:" to a global variable.
21425 * Link "fc" in the list for garbage collection later. */
21426 fc->caller = previous_funccal;
21427 previous_funccal = fc;
21429 /* Make a copy of the a: variables, since we didn't do that above. */
21430 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21431 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21433 if (!HASHITEM_EMPTY(hi))
21435 --todo;
21436 v = HI2DI(hi);
21437 copy_tv(&v->di_tv, &v->di_tv);
21441 /* Make a copy of the a:000 items, since we didn't do that above. */
21442 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21443 copy_tv(&li->li_tv, &li->li_tv);
21448 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21449 * referenced from anywhere that is in use.
21451 static int
21452 can_free_funccal(fc, copyID)
21453 funccall_T *fc;
21454 int copyID;
21456 return (fc->l_varlist.lv_copyID != copyID
21457 && fc->l_vars.dv_copyID != copyID
21458 && fc->l_avars.dv_copyID != copyID);
21462 * Free "fc" and what it contains.
21464 static void
21465 free_funccal(fc, free_val)
21466 funccall_T *fc;
21467 int free_val; /* a: vars were allocated */
21469 listitem_T *li;
21471 /* The a: variables typevals may not have been allocated, only free the
21472 * allocated variables. */
21473 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21475 /* free all l: variables */
21476 vars_clear(&fc->l_vars.dv_hashtab);
21478 /* Free the a:000 variables if they were allocated. */
21479 if (free_val)
21480 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21481 clear_tv(&li->li_tv);
21483 vim_free(fc);
21487 * Add a number variable "name" to dict "dp" with value "nr".
21489 static void
21490 add_nr_var(dp, v, name, nr)
21491 dict_T *dp;
21492 dictitem_T *v;
21493 char *name;
21494 varnumber_T nr;
21496 STRCPY(v->di_key, name);
21497 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21498 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21499 v->di_tv.v_type = VAR_NUMBER;
21500 v->di_tv.v_lock = VAR_FIXED;
21501 v->di_tv.vval.v_number = nr;
21505 * ":return [expr]"
21507 void
21508 ex_return(eap)
21509 exarg_T *eap;
21511 char_u *arg = eap->arg;
21512 typval_T rettv;
21513 int returning = FALSE;
21515 if (current_funccal == NULL)
21517 EMSG(_("E133: :return not inside a function"));
21518 return;
21521 if (eap->skip)
21522 ++emsg_skip;
21524 eap->nextcmd = NULL;
21525 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21526 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21528 if (!eap->skip)
21529 returning = do_return(eap, FALSE, TRUE, &rettv);
21530 else
21531 clear_tv(&rettv);
21533 /* It's safer to return also on error. */
21534 else if (!eap->skip)
21537 * Return unless the expression evaluation has been cancelled due to an
21538 * aborting error, an interrupt, or an exception.
21540 if (!aborting())
21541 returning = do_return(eap, FALSE, TRUE, NULL);
21544 /* When skipping or the return gets pending, advance to the next command
21545 * in this line (!returning). Otherwise, ignore the rest of the line.
21546 * Following lines will be ignored by get_func_line(). */
21547 if (returning)
21548 eap->nextcmd = NULL;
21549 else if (eap->nextcmd == NULL) /* no argument */
21550 eap->nextcmd = check_nextcmd(arg);
21552 if (eap->skip)
21553 --emsg_skip;
21557 * Return from a function. Possibly makes the return pending. Also called
21558 * for a pending return at the ":endtry" or after returning from an extra
21559 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21560 * when called due to a ":return" command. "rettv" may point to a typval_T
21561 * with the return rettv. Returns TRUE when the return can be carried out,
21562 * FALSE when the return gets pending.
21565 do_return(eap, reanimate, is_cmd, rettv)
21566 exarg_T *eap;
21567 int reanimate;
21568 int is_cmd;
21569 void *rettv;
21571 int idx;
21572 struct condstack *cstack = eap->cstack;
21574 if (reanimate)
21575 /* Undo the return. */
21576 current_funccal->returned = FALSE;
21579 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21580 * not in its finally clause (which then is to be executed next) is found.
21581 * In this case, make the ":return" pending for execution at the ":endtry".
21582 * Otherwise, return normally.
21584 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21585 if (idx >= 0)
21587 cstack->cs_pending[idx] = CSTP_RETURN;
21589 if (!is_cmd && !reanimate)
21590 /* A pending return again gets pending. "rettv" points to an
21591 * allocated variable with the rettv of the original ":return"'s
21592 * argument if present or is NULL else. */
21593 cstack->cs_rettv[idx] = rettv;
21594 else
21596 /* When undoing a return in order to make it pending, get the stored
21597 * return rettv. */
21598 if (reanimate)
21599 rettv = current_funccal->rettv;
21601 if (rettv != NULL)
21603 /* Store the value of the pending return. */
21604 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21605 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21606 else
21607 EMSG(_(e_outofmem));
21609 else
21610 cstack->cs_rettv[idx] = NULL;
21612 if (reanimate)
21614 /* The pending return value could be overwritten by a ":return"
21615 * without argument in a finally clause; reset the default
21616 * return value. */
21617 current_funccal->rettv->v_type = VAR_NUMBER;
21618 current_funccal->rettv->vval.v_number = 0;
21621 report_make_pending(CSTP_RETURN, rettv);
21623 else
21625 current_funccal->returned = TRUE;
21627 /* If the return is carried out now, store the return value. For
21628 * a return immediately after reanimation, the value is already
21629 * there. */
21630 if (!reanimate && rettv != NULL)
21632 clear_tv(current_funccal->rettv);
21633 *current_funccal->rettv = *(typval_T *)rettv;
21634 if (!is_cmd)
21635 vim_free(rettv);
21639 return idx < 0;
21643 * Free the variable with a pending return value.
21645 void
21646 discard_pending_return(rettv)
21647 void *rettv;
21649 free_tv((typval_T *)rettv);
21653 * Generate a return command for producing the value of "rettv". The result
21654 * is an allocated string. Used by report_pending() for verbose messages.
21656 char_u *
21657 get_return_cmd(rettv)
21658 void *rettv;
21660 char_u *s = NULL;
21661 char_u *tofree = NULL;
21662 char_u numbuf[NUMBUFLEN];
21664 if (rettv != NULL)
21665 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21666 if (s == NULL)
21667 s = (char_u *)"";
21669 STRCPY(IObuff, ":return ");
21670 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21671 if (STRLEN(s) + 8 >= IOSIZE)
21672 STRCPY(IObuff + IOSIZE - 4, "...");
21673 vim_free(tofree);
21674 return vim_strsave(IObuff);
21678 * Get next function line.
21679 * Called by do_cmdline() to get the next line.
21680 * Returns allocated string, or NULL for end of function.
21682 char_u *
21683 get_func_line(c, cookie, indent)
21684 int c UNUSED;
21685 void *cookie;
21686 int indent UNUSED;
21688 funccall_T *fcp = (funccall_T *)cookie;
21689 ufunc_T *fp = fcp->func;
21690 char_u *retval;
21691 garray_T *gap; /* growarray with function lines */
21693 /* If breakpoints have been added/deleted need to check for it. */
21694 if (fcp->dbg_tick != debug_tick)
21696 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21697 sourcing_lnum);
21698 fcp->dbg_tick = debug_tick;
21700 #ifdef FEAT_PROFILE
21701 if (do_profiling == PROF_YES)
21702 func_line_end(cookie);
21703 #endif
21705 gap = &fp->uf_lines;
21706 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21707 || fcp->returned)
21708 retval = NULL;
21709 else
21711 /* Skip NULL lines (continuation lines). */
21712 while (fcp->linenr < gap->ga_len
21713 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21714 ++fcp->linenr;
21715 if (fcp->linenr >= gap->ga_len)
21716 retval = NULL;
21717 else
21719 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21720 sourcing_lnum = fcp->linenr;
21721 #ifdef FEAT_PROFILE
21722 if (do_profiling == PROF_YES)
21723 func_line_start(cookie);
21724 #endif
21728 /* Did we encounter a breakpoint? */
21729 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21731 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21732 /* Find next breakpoint. */
21733 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21734 sourcing_lnum);
21735 fcp->dbg_tick = debug_tick;
21738 return retval;
21741 #if defined(FEAT_PROFILE) || defined(PROTO)
21743 * Called when starting to read a function line.
21744 * "sourcing_lnum" must be correct!
21745 * When skipping lines it may not actually be executed, but we won't find out
21746 * until later and we need to store the time now.
21748 void
21749 func_line_start(cookie)
21750 void *cookie;
21752 funccall_T *fcp = (funccall_T *)cookie;
21753 ufunc_T *fp = fcp->func;
21755 if (fp->uf_profiling && sourcing_lnum >= 1
21756 && sourcing_lnum <= fp->uf_lines.ga_len)
21758 fp->uf_tml_idx = sourcing_lnum - 1;
21759 /* Skip continuation lines. */
21760 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21761 --fp->uf_tml_idx;
21762 fp->uf_tml_execed = FALSE;
21763 profile_start(&fp->uf_tml_start);
21764 profile_zero(&fp->uf_tml_children);
21765 profile_get_wait(&fp->uf_tml_wait);
21770 * Called when actually executing a function line.
21772 void
21773 func_line_exec(cookie)
21774 void *cookie;
21776 funccall_T *fcp = (funccall_T *)cookie;
21777 ufunc_T *fp = fcp->func;
21779 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21780 fp->uf_tml_execed = TRUE;
21784 * Called when done with a function line.
21786 void
21787 func_line_end(cookie)
21788 void *cookie;
21790 funccall_T *fcp = (funccall_T *)cookie;
21791 ufunc_T *fp = fcp->func;
21793 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21795 if (fp->uf_tml_execed)
21797 ++fp->uf_tml_count[fp->uf_tml_idx];
21798 profile_end(&fp->uf_tml_start);
21799 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21800 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21801 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21802 &fp->uf_tml_children);
21804 fp->uf_tml_idx = -1;
21807 #endif
21810 * Return TRUE if the currently active function should be ended, because a
21811 * return was encountered or an error occurred. Used inside a ":while".
21814 func_has_ended(cookie)
21815 void *cookie;
21817 funccall_T *fcp = (funccall_T *)cookie;
21819 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21820 * an error inside a try conditional. */
21821 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21822 || fcp->returned);
21826 * return TRUE if cookie indicates a function which "abort"s on errors.
21829 func_has_abort(cookie)
21830 void *cookie;
21832 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21835 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21836 typedef enum
21838 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21839 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21840 VAR_FLAVOUR_VIMINFO /* all uppercase */
21841 } var_flavour_T;
21843 static var_flavour_T var_flavour __ARGS((char_u *varname));
21845 static var_flavour_T
21846 var_flavour(varname)
21847 char_u *varname;
21849 char_u *p = varname;
21851 if (ASCII_ISUPPER(*p))
21853 while (*(++p))
21854 if (ASCII_ISLOWER(*p))
21855 return VAR_FLAVOUR_SESSION;
21856 return VAR_FLAVOUR_VIMINFO;
21858 else
21859 return VAR_FLAVOUR_DEFAULT;
21861 #endif
21863 #if defined(FEAT_VIMINFO) || defined(PROTO)
21865 * Restore global vars that start with a capital from the viminfo file
21868 read_viminfo_varlist(virp, writing)
21869 vir_T *virp;
21870 int writing;
21872 char_u *tab;
21873 int type = VAR_NUMBER;
21874 typval_T tv;
21876 if (!writing && (find_viminfo_parameter('!') != NULL))
21878 tab = vim_strchr(virp->vir_line + 1, '\t');
21879 if (tab != NULL)
21881 *tab++ = '\0'; /* isolate the variable name */
21882 if (*tab == 'S') /* string var */
21883 type = VAR_STRING;
21884 #ifdef FEAT_FLOAT
21885 else if (*tab == 'F')
21886 type = VAR_FLOAT;
21887 #endif
21889 tab = vim_strchr(tab, '\t');
21890 if (tab != NULL)
21892 tv.v_type = type;
21893 if (type == VAR_STRING)
21894 tv.vval.v_string = viminfo_readstring(virp,
21895 (int)(tab - virp->vir_line + 1), TRUE);
21896 #ifdef FEAT_FLOAT
21897 else if (type == VAR_FLOAT)
21898 (void)string2float(tab + 1, &tv.vval.v_float);
21899 #endif
21900 else
21901 tv.vval.v_number = atol((char *)tab + 1);
21902 set_var(virp->vir_line + 1, &tv, FALSE);
21903 if (type == VAR_STRING)
21904 vim_free(tv.vval.v_string);
21909 return viminfo_readline(virp);
21913 * Write global vars that start with a capital to the viminfo file
21915 void
21916 write_viminfo_varlist(fp)
21917 FILE *fp;
21919 hashitem_T *hi;
21920 dictitem_T *this_var;
21921 int todo;
21922 char *s;
21923 char_u *p;
21924 char_u *tofree;
21925 char_u numbuf[NUMBUFLEN];
21927 if (find_viminfo_parameter('!') == NULL)
21928 return;
21930 fprintf(fp, _("\n# global variables:\n"));
21932 todo = (int)globvarht.ht_used;
21933 for (hi = globvarht.ht_array; todo > 0; ++hi)
21935 if (!HASHITEM_EMPTY(hi))
21937 --todo;
21938 this_var = HI2DI(hi);
21939 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21941 switch (this_var->di_tv.v_type)
21943 case VAR_STRING: s = "STR"; break;
21944 case VAR_NUMBER: s = "NUM"; break;
21945 #ifdef FEAT_FLOAT
21946 case VAR_FLOAT: s = "FLO"; break;
21947 #endif
21948 default: continue;
21950 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21951 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21952 if (p != NULL)
21953 viminfo_writestring(fp, p);
21954 vim_free(tofree);
21959 #endif
21961 #if defined(FEAT_SESSION) || defined(PROTO)
21963 store_session_globals(fd)
21964 FILE *fd;
21966 hashitem_T *hi;
21967 dictitem_T *this_var;
21968 int todo;
21969 char_u *p, *t;
21971 todo = (int)globvarht.ht_used;
21972 for (hi = globvarht.ht_array; todo > 0; ++hi)
21974 if (!HASHITEM_EMPTY(hi))
21976 --todo;
21977 this_var = HI2DI(hi);
21978 if ((this_var->di_tv.v_type == VAR_NUMBER
21979 || this_var->di_tv.v_type == VAR_STRING)
21980 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21982 /* Escape special characters with a backslash. Turn a LF and
21983 * CR into \n and \r. */
21984 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
21985 (char_u *)"\\\"\n\r");
21986 if (p == NULL) /* out of memory */
21987 break;
21988 for (t = p; *t != NUL; ++t)
21989 if (*t == '\n')
21990 *t = 'n';
21991 else if (*t == '\r')
21992 *t = 'r';
21993 if ((fprintf(fd, "let %s = %c%s%c",
21994 this_var->di_key,
21995 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21996 : ' ',
21998 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21999 : ' ') < 0)
22000 || put_eol(fd) == FAIL)
22002 vim_free(p);
22003 return FAIL;
22005 vim_free(p);
22007 #ifdef FEAT_FLOAT
22008 else if (this_var->di_tv.v_type == VAR_FLOAT
22009 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22011 float_T f = this_var->di_tv.vval.v_float;
22012 int sign = ' ';
22014 if (f < 0)
22016 f = -f;
22017 sign = '-';
22019 if ((fprintf(fd, "let %s = %c&%f",
22020 this_var->di_key, sign, f) < 0)
22021 || put_eol(fd) == FAIL)
22022 return FAIL;
22024 #endif
22027 return OK;
22029 #endif
22032 * Display script name where an item was last set.
22033 * Should only be invoked when 'verbose' is non-zero.
22035 void
22036 last_set_msg(scriptID)
22037 scid_T scriptID;
22039 char_u *p;
22041 if (scriptID != 0)
22043 p = home_replace_save(NULL, get_scriptname(scriptID));
22044 if (p != NULL)
22046 verbose_enter();
22047 MSG_PUTS(_("\n\tLast set from "));
22048 MSG_PUTS(p);
22049 vim_free(p);
22050 verbose_leave();
22056 * List v:oldfiles in a nice way.
22058 void
22059 ex_oldfiles(eap)
22060 exarg_T *eap UNUSED;
22062 list_T *l = vimvars[VV_OLDFILES].vv_list;
22063 listitem_T *li;
22064 int nr = 0;
22066 if (l == NULL)
22067 msg((char_u *)_("No old files"));
22068 else
22070 msg_start();
22071 msg_scroll = TRUE;
22072 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22074 msg_outnum((long)++nr);
22075 MSG_PUTS(": ");
22076 msg_outtrans(get_tv_string(&li->li_tv));
22077 msg_putchar('\n');
22078 out_flush(); /* output one line at a time */
22079 ui_breakcheck();
22081 /* Assume "got_int" was set to truncate the listing. */
22082 got_int = FALSE;
22084 #ifdef FEAT_BROWSE_CMD
22085 if (cmdmod.browse)
22087 quit_more = FALSE;
22088 nr = prompt_for_number(FALSE);
22089 msg_starthere();
22090 if (nr > 0)
22092 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22093 (long)nr);
22095 if (p != NULL)
22097 p = expand_env_save(p);
22098 eap->arg = p;
22099 eap->cmdidx = CMD_edit;
22100 cmdmod.browse = FALSE;
22101 do_exedit(eap, NULL);
22102 vim_free(p);
22106 #endif
22110 #endif /* FEAT_EVAL */
22113 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22115 #ifdef WIN3264
22117 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22119 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22120 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22121 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22124 * Get the short path (8.3) for the filename in "fnamep".
22125 * Only works for a valid file name.
22126 * When the path gets longer "fnamep" is changed and the allocated buffer
22127 * is put in "bufp".
22128 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22129 * Returns OK on success, FAIL on failure.
22131 static int
22132 get_short_pathname(fnamep, bufp, fnamelen)
22133 char_u **fnamep;
22134 char_u **bufp;
22135 int *fnamelen;
22137 int l, len;
22138 char_u *newbuf;
22140 len = *fnamelen;
22141 l = GetShortPathName(*fnamep, *fnamep, len);
22142 if (l > len - 1)
22144 /* If that doesn't work (not enough space), then save the string
22145 * and try again with a new buffer big enough. */
22146 newbuf = vim_strnsave(*fnamep, l);
22147 if (newbuf == NULL)
22148 return FAIL;
22150 vim_free(*bufp);
22151 *fnamep = *bufp = newbuf;
22153 /* Really should always succeed, as the buffer is big enough. */
22154 l = GetShortPathName(*fnamep, *fnamep, l+1);
22157 *fnamelen = l;
22158 return OK;
22162 * Get the short path (8.3) for the filename in "fname". The converted
22163 * path is returned in "bufp".
22165 * Some of the directories specified in "fname" may not exist. This function
22166 * will shorten the existing directories at the beginning of the path and then
22167 * append the remaining non-existing path.
22169 * fname - Pointer to the filename to shorten. On return, contains the
22170 * pointer to the shortened pathname
22171 * bufp - Pointer to an allocated buffer for the filename.
22172 * fnamelen - Length of the filename pointed to by fname
22174 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22176 static int
22177 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22178 char_u **fname;
22179 char_u **bufp;
22180 int *fnamelen;
22182 char_u *short_fname, *save_fname, *pbuf_unused;
22183 char_u *endp, *save_endp;
22184 char_u ch;
22185 int old_len, len;
22186 int new_len, sfx_len;
22187 int retval = OK;
22189 /* Make a copy */
22190 old_len = *fnamelen;
22191 save_fname = vim_strnsave(*fname, old_len);
22192 pbuf_unused = NULL;
22193 short_fname = NULL;
22195 endp = save_fname + old_len - 1; /* Find the end of the copy */
22196 save_endp = endp;
22199 * Try shortening the supplied path till it succeeds by removing one
22200 * directory at a time from the tail of the path.
22202 len = 0;
22203 for (;;)
22205 /* go back one path-separator */
22206 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22207 --endp;
22208 if (endp <= save_fname)
22209 break; /* processed the complete path */
22212 * Replace the path separator with a NUL and try to shorten the
22213 * resulting path.
22215 ch = *endp;
22216 *endp = 0;
22217 short_fname = save_fname;
22218 len = (int)STRLEN(short_fname) + 1;
22219 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22221 retval = FAIL;
22222 goto theend;
22224 *endp = ch; /* preserve the string */
22226 if (len > 0)
22227 break; /* successfully shortened the path */
22229 /* failed to shorten the path. Skip the path separator */
22230 --endp;
22233 if (len > 0)
22236 * Succeeded in shortening the path. Now concatenate the shortened
22237 * path with the remaining path at the tail.
22240 /* Compute the length of the new path. */
22241 sfx_len = (int)(save_endp - endp) + 1;
22242 new_len = len + sfx_len;
22244 *fnamelen = new_len;
22245 vim_free(*bufp);
22246 if (new_len > old_len)
22248 /* There is not enough space in the currently allocated string,
22249 * copy it to a buffer big enough. */
22250 *fname = *bufp = vim_strnsave(short_fname, new_len);
22251 if (*fname == NULL)
22253 retval = FAIL;
22254 goto theend;
22257 else
22259 /* Transfer short_fname to the main buffer (it's big enough),
22260 * unless get_short_pathname() did its work in-place. */
22261 *fname = *bufp = save_fname;
22262 if (short_fname != save_fname)
22263 vim_strncpy(save_fname, short_fname, len);
22264 save_fname = NULL;
22267 /* concat the not-shortened part of the path */
22268 vim_strncpy(*fname + len, endp, sfx_len);
22269 (*fname)[new_len] = NUL;
22272 theend:
22273 vim_free(pbuf_unused);
22274 vim_free(save_fname);
22276 return retval;
22280 * Get a pathname for a partial path.
22281 * Returns OK for success, FAIL for failure.
22283 static int
22284 shortpath_for_partial(fnamep, bufp, fnamelen)
22285 char_u **fnamep;
22286 char_u **bufp;
22287 int *fnamelen;
22289 int sepcount, len, tflen;
22290 char_u *p;
22291 char_u *pbuf, *tfname;
22292 int hasTilde;
22294 /* Count up the path separators from the RHS.. so we know which part
22295 * of the path to return. */
22296 sepcount = 0;
22297 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22298 if (vim_ispathsep(*p))
22299 ++sepcount;
22301 /* Need full path first (use expand_env() to remove a "~/") */
22302 hasTilde = (**fnamep == '~');
22303 if (hasTilde)
22304 pbuf = tfname = expand_env_save(*fnamep);
22305 else
22306 pbuf = tfname = FullName_save(*fnamep, FALSE);
22308 len = tflen = (int)STRLEN(tfname);
22310 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22311 return FAIL;
22313 if (len == 0)
22315 /* Don't have a valid filename, so shorten the rest of the
22316 * path if we can. This CAN give us invalid 8.3 filenames, but
22317 * there's not a lot of point in guessing what it might be.
22319 len = tflen;
22320 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22321 return FAIL;
22324 /* Count the paths backward to find the beginning of the desired string. */
22325 for (p = tfname + len - 1; p >= tfname; --p)
22327 #ifdef FEAT_MBYTE
22328 if (has_mbyte)
22329 p -= mb_head_off(tfname, p);
22330 #endif
22331 if (vim_ispathsep(*p))
22333 if (sepcount == 0 || (hasTilde && sepcount == 1))
22334 break;
22335 else
22336 sepcount --;
22339 if (hasTilde)
22341 --p;
22342 if (p >= tfname)
22343 *p = '~';
22344 else
22345 return FAIL;
22347 else
22348 ++p;
22350 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22351 vim_free(*bufp);
22352 *fnamelen = (int)STRLEN(p);
22353 *bufp = pbuf;
22354 *fnamep = p;
22356 return OK;
22358 #endif /* WIN3264 */
22361 * Adjust a filename, according to a string of modifiers.
22362 * *fnamep must be NUL terminated when called. When returning, the length is
22363 * determined by *fnamelen.
22364 * Returns VALID_ flags or -1 for failure.
22365 * When there is an error, *fnamep is set to NULL.
22368 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22369 char_u *src; /* string with modifiers */
22370 int *usedlen; /* characters after src that are used */
22371 char_u **fnamep; /* file name so far */
22372 char_u **bufp; /* buffer for allocated file name or NULL */
22373 int *fnamelen; /* length of fnamep */
22375 int valid = 0;
22376 char_u *tail;
22377 char_u *s, *p, *pbuf;
22378 char_u dirname[MAXPATHL];
22379 int c;
22380 int has_fullname = 0;
22381 #ifdef WIN3264
22382 int has_shortname = 0;
22383 #endif
22385 repeat:
22386 /* ":p" - full path/file_name */
22387 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22389 has_fullname = 1;
22391 valid |= VALID_PATH;
22392 *usedlen += 2;
22394 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22395 if ((*fnamep)[0] == '~'
22396 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22397 && ((*fnamep)[1] == '/'
22398 # ifdef BACKSLASH_IN_FILENAME
22399 || (*fnamep)[1] == '\\'
22400 # endif
22401 || (*fnamep)[1] == NUL)
22403 #endif
22406 *fnamep = expand_env_save(*fnamep);
22407 vim_free(*bufp); /* free any allocated file name */
22408 *bufp = *fnamep;
22409 if (*fnamep == NULL)
22410 return -1;
22413 /* When "/." or "/.." is used: force expansion to get rid of it. */
22414 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22416 if (vim_ispathsep(*p)
22417 && p[1] == '.'
22418 && (p[2] == NUL
22419 || vim_ispathsep(p[2])
22420 || (p[2] == '.'
22421 && (p[3] == NUL || vim_ispathsep(p[3])))))
22422 break;
22425 /* FullName_save() is slow, don't use it when not needed. */
22426 if (*p != NUL || !vim_isAbsName(*fnamep))
22428 *fnamep = FullName_save(*fnamep, *p != NUL);
22429 vim_free(*bufp); /* free any allocated file name */
22430 *bufp = *fnamep;
22431 if (*fnamep == NULL)
22432 return -1;
22435 /* Append a path separator to a directory. */
22436 if (mch_isdir(*fnamep))
22438 /* Make room for one or two extra characters. */
22439 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22440 vim_free(*bufp); /* free any allocated file name */
22441 *bufp = *fnamep;
22442 if (*fnamep == NULL)
22443 return -1;
22444 add_pathsep(*fnamep);
22448 /* ":." - path relative to the current directory */
22449 /* ":~" - path relative to the home directory */
22450 /* ":8" - shortname path - postponed till after */
22451 while (src[*usedlen] == ':'
22452 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22454 *usedlen += 2;
22455 if (c == '8')
22457 #ifdef WIN3264
22458 has_shortname = 1; /* Postpone this. */
22459 #endif
22460 continue;
22462 pbuf = NULL;
22463 /* Need full path first (use expand_env() to remove a "~/") */
22464 if (!has_fullname)
22466 if (c == '.' && **fnamep == '~')
22467 p = pbuf = expand_env_save(*fnamep);
22468 else
22469 p = pbuf = FullName_save(*fnamep, FALSE);
22471 else
22472 p = *fnamep;
22474 has_fullname = 0;
22476 if (p != NULL)
22478 if (c == '.')
22480 mch_dirname(dirname, MAXPATHL);
22481 s = shorten_fname(p, dirname);
22482 if (s != NULL)
22484 *fnamep = s;
22485 if (pbuf != NULL)
22487 vim_free(*bufp); /* free any allocated file name */
22488 *bufp = pbuf;
22489 pbuf = NULL;
22493 else
22495 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22496 /* Only replace it when it starts with '~' */
22497 if (*dirname == '~')
22499 s = vim_strsave(dirname);
22500 if (s != NULL)
22502 *fnamep = s;
22503 vim_free(*bufp);
22504 *bufp = s;
22508 vim_free(pbuf);
22512 tail = gettail(*fnamep);
22513 *fnamelen = (int)STRLEN(*fnamep);
22515 /* ":h" - head, remove "/file_name", can be repeated */
22516 /* Don't remove the first "/" or "c:\" */
22517 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22519 valid |= VALID_HEAD;
22520 *usedlen += 2;
22521 s = get_past_head(*fnamep);
22522 while (tail > s && after_pathsep(s, tail))
22523 mb_ptr_back(*fnamep, tail);
22524 *fnamelen = (int)(tail - *fnamep);
22525 #ifdef VMS
22526 if (*fnamelen > 0)
22527 *fnamelen += 1; /* the path separator is part of the path */
22528 #endif
22529 if (*fnamelen == 0)
22531 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22532 p = vim_strsave((char_u *)".");
22533 if (p == NULL)
22534 return -1;
22535 vim_free(*bufp);
22536 *bufp = *fnamep = tail = p;
22537 *fnamelen = 1;
22539 else
22541 while (tail > s && !after_pathsep(s, tail))
22542 mb_ptr_back(*fnamep, tail);
22546 /* ":8" - shortname */
22547 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22549 *usedlen += 2;
22550 #ifdef WIN3264
22551 has_shortname = 1;
22552 #endif
22555 #ifdef WIN3264
22556 /* Check shortname after we have done 'heads' and before we do 'tails'
22558 if (has_shortname)
22560 pbuf = NULL;
22561 /* Copy the string if it is shortened by :h */
22562 if (*fnamelen < (int)STRLEN(*fnamep))
22564 p = vim_strnsave(*fnamep, *fnamelen);
22565 if (p == 0)
22566 return -1;
22567 vim_free(*bufp);
22568 *bufp = *fnamep = p;
22571 /* Split into two implementations - makes it easier. First is where
22572 * there isn't a full name already, second is where there is.
22574 if (!has_fullname && !vim_isAbsName(*fnamep))
22576 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22577 return -1;
22579 else
22581 int l;
22583 /* Simple case, already have the full-name
22584 * Nearly always shorter, so try first time. */
22585 l = *fnamelen;
22586 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22587 return -1;
22589 if (l == 0)
22591 /* Couldn't find the filename.. search the paths.
22593 l = *fnamelen;
22594 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22595 return -1;
22597 *fnamelen = l;
22600 #endif /* WIN3264 */
22602 /* ":t" - tail, just the basename */
22603 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22605 *usedlen += 2;
22606 *fnamelen -= (int)(tail - *fnamep);
22607 *fnamep = tail;
22610 /* ":e" - extension, can be repeated */
22611 /* ":r" - root, without extension, can be repeated */
22612 while (src[*usedlen] == ':'
22613 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22615 /* find a '.' in the tail:
22616 * - for second :e: before the current fname
22617 * - otherwise: The last '.'
22619 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22620 s = *fnamep - 2;
22621 else
22622 s = *fnamep + *fnamelen - 1;
22623 for ( ; s > tail; --s)
22624 if (s[0] == '.')
22625 break;
22626 if (src[*usedlen + 1] == 'e') /* :e */
22628 if (s > tail)
22630 *fnamelen += (int)(*fnamep - (s + 1));
22631 *fnamep = s + 1;
22632 #ifdef VMS
22633 /* cut version from the extension */
22634 s = *fnamep + *fnamelen - 1;
22635 for ( ; s > *fnamep; --s)
22636 if (s[0] == ';')
22637 break;
22638 if (s > *fnamep)
22639 *fnamelen = s - *fnamep;
22640 #endif
22642 else if (*fnamep <= tail)
22643 *fnamelen = 0;
22645 else /* :r */
22647 if (s > tail) /* remove one extension */
22648 *fnamelen = (int)(s - *fnamep);
22650 *usedlen += 2;
22653 /* ":s?pat?foo?" - substitute */
22654 /* ":gs?pat?foo?" - global substitute */
22655 if (src[*usedlen] == ':'
22656 && (src[*usedlen + 1] == 's'
22657 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22659 char_u *str;
22660 char_u *pat;
22661 char_u *sub;
22662 int sep;
22663 char_u *flags;
22664 int didit = FALSE;
22666 flags = (char_u *)"";
22667 s = src + *usedlen + 2;
22668 if (src[*usedlen + 1] == 'g')
22670 flags = (char_u *)"g";
22671 ++s;
22674 sep = *s++;
22675 if (sep)
22677 /* find end of pattern */
22678 p = vim_strchr(s, sep);
22679 if (p != NULL)
22681 pat = vim_strnsave(s, (int)(p - s));
22682 if (pat != NULL)
22684 s = p + 1;
22685 /* find end of substitution */
22686 p = vim_strchr(s, sep);
22687 if (p != NULL)
22689 sub = vim_strnsave(s, (int)(p - s));
22690 str = vim_strnsave(*fnamep, *fnamelen);
22691 if (sub != NULL && str != NULL)
22693 *usedlen = (int)(p + 1 - src);
22694 s = do_string_sub(str, pat, sub, flags);
22695 if (s != NULL)
22697 *fnamep = s;
22698 *fnamelen = (int)STRLEN(s);
22699 vim_free(*bufp);
22700 *bufp = s;
22701 didit = TRUE;
22704 vim_free(sub);
22705 vim_free(str);
22707 vim_free(pat);
22710 /* after using ":s", repeat all the modifiers */
22711 if (didit)
22712 goto repeat;
22716 return valid;
22720 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22721 * "flags" can be "g" to do a global substitute.
22722 * Returns an allocated string, NULL for error.
22724 char_u *
22725 do_string_sub(str, pat, sub, flags)
22726 char_u *str;
22727 char_u *pat;
22728 char_u *sub;
22729 char_u *flags;
22731 int sublen;
22732 regmatch_T regmatch;
22733 int i;
22734 int do_all;
22735 char_u *tail;
22736 garray_T ga;
22737 char_u *ret;
22738 char_u *save_cpo;
22740 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22741 save_cpo = p_cpo;
22742 p_cpo = empty_option;
22744 ga_init2(&ga, 1, 200);
22746 do_all = (flags[0] == 'g');
22748 regmatch.rm_ic = p_ic;
22749 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22750 if (regmatch.regprog != NULL)
22752 tail = str;
22753 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22756 * Get some space for a temporary buffer to do the substitution
22757 * into. It will contain:
22758 * - The text up to where the match is.
22759 * - The substituted text.
22760 * - The text after the match.
22762 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22763 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22764 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22766 ga_clear(&ga);
22767 break;
22770 /* copy the text up to where the match is */
22771 i = (int)(regmatch.startp[0] - tail);
22772 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22773 /* add the substituted text */
22774 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22775 + ga.ga_len + i, TRUE, TRUE, FALSE);
22776 ga.ga_len += i + sublen - 1;
22777 /* avoid getting stuck on a match with an empty string */
22778 if (tail == regmatch.endp[0])
22780 if (*tail == NUL)
22781 break;
22782 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22783 ++ga.ga_len;
22785 else
22787 tail = regmatch.endp[0];
22788 if (*tail == NUL)
22789 break;
22791 if (!do_all)
22792 break;
22795 if (ga.ga_data != NULL)
22796 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22798 vim_free(regmatch.regprog);
22801 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22802 ga_clear(&ga);
22803 if (p_cpo == empty_option)
22804 p_cpo = save_cpo;
22805 else
22806 /* Darn, evaluating {sub} expression changed the value. */
22807 free_string_option(save_cpo);
22809 return ret;
22812 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */