[7.2.216] Two error messages have the same number E812.
[vim_extended.git] / src / eval.c
blobf94178d6643c9d8762a90f786694da3b577cfa14
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 /* Make sure a valid variable name is specified */
992 if (!eval_isnamec1(*name))
994 EMSG(_(e_invarg));
995 return FAIL;
998 redir_varname = vim_strsave(name);
999 if (redir_varname == NULL)
1000 return FAIL;
1002 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
1003 if (redir_lval == NULL)
1005 var_redir_stop();
1006 return FAIL;
1009 /* The output is stored in growarray "redir_ga" until redirection ends. */
1010 ga_init2(&redir_ga, (int)sizeof(char), 500);
1012 /* Parse the variable name (can be a dict or list entry). */
1013 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1014 FNE_CHECK_START);
1015 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1017 if (redir_endp != NULL && *redir_endp != NUL)
1018 /* Trailing characters are present after the variable name */
1019 EMSG(_(e_trailing));
1020 else
1021 EMSG(_(e_invarg));
1022 var_redir_stop();
1023 return FAIL;
1026 /* check if we can write to the variable: set it to or append an empty
1027 * string */
1028 save_emsg = did_emsg;
1029 did_emsg = FALSE;
1030 tv.v_type = VAR_STRING;
1031 tv.vval.v_string = (char_u *)"";
1032 if (append)
1033 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1034 else
1035 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1036 err = did_emsg;
1037 did_emsg |= save_emsg;
1038 if (err)
1040 var_redir_stop();
1041 return FAIL;
1043 if (redir_lval->ll_newkey != NULL)
1045 /* Dictionary item was created, don't do it again. */
1046 vim_free(redir_lval->ll_newkey);
1047 redir_lval->ll_newkey = NULL;
1050 return OK;
1054 * Append "value[value_len]" to the variable set by var_redir_start().
1055 * The actual appending is postponed until redirection ends, because the value
1056 * appended may in fact be the string we write to, changing it may cause freed
1057 * memory to be used:
1058 * :redir => foo
1059 * :let foo
1060 * :redir END
1062 void
1063 var_redir_str(value, value_len)
1064 char_u *value;
1065 int value_len;
1067 int len;
1069 if (redir_lval == NULL)
1070 return;
1072 if (value_len == -1)
1073 len = (int)STRLEN(value); /* Append the entire string */
1074 else
1075 len = value_len; /* Append only "value_len" characters */
1077 if (ga_grow(&redir_ga, len) == OK)
1079 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1080 redir_ga.ga_len += len;
1082 else
1083 var_redir_stop();
1087 * Stop redirecting command output to a variable.
1089 void
1090 var_redir_stop()
1092 typval_T tv;
1094 if (redir_lval != NULL)
1096 /* Append the trailing NUL. */
1097 ga_append(&redir_ga, NUL);
1099 /* Assign the text to the variable. */
1100 tv.v_type = VAR_STRING;
1101 tv.vval.v_string = redir_ga.ga_data;
1102 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1103 vim_free(tv.vval.v_string);
1105 clear_lval(redir_lval);
1106 vim_free(redir_lval);
1107 redir_lval = NULL;
1109 vim_free(redir_varname);
1110 redir_varname = NULL;
1113 # if defined(FEAT_MBYTE) || defined(PROTO)
1115 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1116 char_u *enc_from;
1117 char_u *enc_to;
1118 char_u *fname_from;
1119 char_u *fname_to;
1121 int err = FALSE;
1123 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1124 set_vim_var_string(VV_CC_TO, enc_to, -1);
1125 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1126 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1127 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1128 err = TRUE;
1129 set_vim_var_string(VV_CC_FROM, NULL, -1);
1130 set_vim_var_string(VV_CC_TO, NULL, -1);
1131 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1132 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1134 if (err)
1135 return FAIL;
1136 return OK;
1138 # endif
1140 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1142 eval_printexpr(fname, args)
1143 char_u *fname;
1144 char_u *args;
1146 int err = FALSE;
1148 set_vim_var_string(VV_FNAME_IN, fname, -1);
1149 set_vim_var_string(VV_CMDARG, args, -1);
1150 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1151 err = TRUE;
1152 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1153 set_vim_var_string(VV_CMDARG, NULL, -1);
1155 if (err)
1157 mch_remove(fname);
1158 return FAIL;
1160 return OK;
1162 # endif
1164 # if defined(FEAT_DIFF) || defined(PROTO)
1165 void
1166 eval_diff(origfile, newfile, outfile)
1167 char_u *origfile;
1168 char_u *newfile;
1169 char_u *outfile;
1171 int err = FALSE;
1173 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1174 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1175 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1176 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1177 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1178 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1179 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1182 void
1183 eval_patch(origfile, difffile, outfile)
1184 char_u *origfile;
1185 char_u *difffile;
1186 char_u *outfile;
1188 int err;
1190 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1191 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1192 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1193 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1194 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1195 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1196 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1198 # endif
1201 * Top level evaluation function, returning a boolean.
1202 * Sets "error" to TRUE if there was an error.
1203 * Return TRUE or FALSE.
1206 eval_to_bool(arg, error, nextcmd, skip)
1207 char_u *arg;
1208 int *error;
1209 char_u **nextcmd;
1210 int skip; /* only parse, don't execute */
1212 typval_T tv;
1213 int retval = FALSE;
1215 if (skip)
1216 ++emsg_skip;
1217 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1218 *error = TRUE;
1219 else
1221 *error = FALSE;
1222 if (!skip)
1224 retval = (get_tv_number_chk(&tv, error) != 0);
1225 clear_tv(&tv);
1228 if (skip)
1229 --emsg_skip;
1231 return retval;
1235 * Top level evaluation function, returning a string. If "skip" is TRUE,
1236 * only parsing to "nextcmd" is done, without reporting errors. Return
1237 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1239 char_u *
1240 eval_to_string_skip(arg, nextcmd, skip)
1241 char_u *arg;
1242 char_u **nextcmd;
1243 int skip; /* only parse, don't execute */
1245 typval_T tv;
1246 char_u *retval;
1248 if (skip)
1249 ++emsg_skip;
1250 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1251 retval = NULL;
1252 else
1254 retval = vim_strsave(get_tv_string(&tv));
1255 clear_tv(&tv);
1257 if (skip)
1258 --emsg_skip;
1260 return retval;
1264 * Skip over an expression at "*pp".
1265 * Return FAIL for an error, OK otherwise.
1268 skip_expr(pp)
1269 char_u **pp;
1271 typval_T rettv;
1273 *pp = skipwhite(*pp);
1274 return eval1(pp, &rettv, FALSE);
1278 * Top level evaluation function, returning a string.
1279 * When "convert" is TRUE convert a List into a sequence of lines and convert
1280 * a Float to a String.
1281 * Return pointer to allocated memory, or NULL for failure.
1283 char_u *
1284 eval_to_string(arg, nextcmd, convert)
1285 char_u *arg;
1286 char_u **nextcmd;
1287 int convert;
1289 typval_T tv;
1290 char_u *retval;
1291 garray_T ga;
1292 #ifdef FEAT_FLOAT
1293 char_u numbuf[NUMBUFLEN];
1294 #endif
1296 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1297 retval = NULL;
1298 else
1300 if (convert && tv.v_type == VAR_LIST)
1302 ga_init2(&ga, (int)sizeof(char), 80);
1303 if (tv.vval.v_list != NULL)
1304 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1305 ga_append(&ga, NUL);
1306 retval = (char_u *)ga.ga_data;
1308 #ifdef FEAT_FLOAT
1309 else if (convert && tv.v_type == VAR_FLOAT)
1311 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1312 retval = vim_strsave(numbuf);
1314 #endif
1315 else
1316 retval = vim_strsave(get_tv_string(&tv));
1317 clear_tv(&tv);
1320 return retval;
1324 * Call eval_to_string() without using current local variables and using
1325 * textlock. When "use_sandbox" is TRUE use the sandbox.
1327 char_u *
1328 eval_to_string_safe(arg, nextcmd, use_sandbox)
1329 char_u *arg;
1330 char_u **nextcmd;
1331 int use_sandbox;
1333 char_u *retval;
1334 void *save_funccalp;
1336 save_funccalp = save_funccal();
1337 if (use_sandbox)
1338 ++sandbox;
1339 ++textlock;
1340 retval = eval_to_string(arg, nextcmd, FALSE);
1341 if (use_sandbox)
1342 --sandbox;
1343 --textlock;
1344 restore_funccal(save_funccalp);
1345 return retval;
1349 * Top level evaluation function, returning a number.
1350 * Evaluates "expr" silently.
1351 * Returns -1 for an error.
1354 eval_to_number(expr)
1355 char_u *expr;
1357 typval_T rettv;
1358 int retval;
1359 char_u *p = skipwhite(expr);
1361 ++emsg_off;
1363 if (eval1(&p, &rettv, TRUE) == FAIL)
1364 retval = -1;
1365 else
1367 retval = get_tv_number_chk(&rettv, NULL);
1368 clear_tv(&rettv);
1370 --emsg_off;
1372 return retval;
1376 * Prepare v: variable "idx" to be used.
1377 * Save the current typeval in "save_tv".
1378 * When not used yet add the variable to the v: hashtable.
1380 static void
1381 prepare_vimvar(idx, save_tv)
1382 int idx;
1383 typval_T *save_tv;
1385 *save_tv = vimvars[idx].vv_tv;
1386 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1387 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1391 * Restore v: variable "idx" to typeval "save_tv".
1392 * When no longer defined, remove the variable from the v: hashtable.
1394 static void
1395 restore_vimvar(idx, save_tv)
1396 int idx;
1397 typval_T *save_tv;
1399 hashitem_T *hi;
1401 vimvars[idx].vv_tv = *save_tv;
1402 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1404 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1405 if (HASHITEM_EMPTY(hi))
1406 EMSG2(_(e_intern2), "restore_vimvar()");
1407 else
1408 hash_remove(&vimvarht, hi);
1412 #if defined(FEAT_SPELL) || defined(PROTO)
1414 * Evaluate an expression to a list with suggestions.
1415 * For the "expr:" part of 'spellsuggest'.
1416 * Returns NULL when there is an error.
1418 list_T *
1419 eval_spell_expr(badword, expr)
1420 char_u *badword;
1421 char_u *expr;
1423 typval_T save_val;
1424 typval_T rettv;
1425 list_T *list = NULL;
1426 char_u *p = skipwhite(expr);
1428 /* Set "v:val" to the bad word. */
1429 prepare_vimvar(VV_VAL, &save_val);
1430 vimvars[VV_VAL].vv_type = VAR_STRING;
1431 vimvars[VV_VAL].vv_str = badword;
1432 if (p_verbose == 0)
1433 ++emsg_off;
1435 if (eval1(&p, &rettv, TRUE) == OK)
1437 if (rettv.v_type != VAR_LIST)
1438 clear_tv(&rettv);
1439 else
1440 list = rettv.vval.v_list;
1443 if (p_verbose == 0)
1444 --emsg_off;
1445 restore_vimvar(VV_VAL, &save_val);
1447 return list;
1451 * "list" is supposed to contain two items: a word and a number. Return the
1452 * word in "pp" and the number as the return value.
1453 * Return -1 if anything isn't right.
1454 * Used to get the good word and score from the eval_spell_expr() result.
1457 get_spellword(list, pp)
1458 list_T *list;
1459 char_u **pp;
1461 listitem_T *li;
1463 li = list->lv_first;
1464 if (li == NULL)
1465 return -1;
1466 *pp = get_tv_string(&li->li_tv);
1468 li = li->li_next;
1469 if (li == NULL)
1470 return -1;
1471 return get_tv_number(&li->li_tv);
1473 #endif
1476 * Top level evaluation function.
1477 * Returns an allocated typval_T with the result.
1478 * Returns NULL when there is an error.
1480 typval_T *
1481 eval_expr(arg, nextcmd)
1482 char_u *arg;
1483 char_u **nextcmd;
1485 typval_T *tv;
1487 tv = (typval_T *)alloc(sizeof(typval_T));
1488 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1490 vim_free(tv);
1491 tv = NULL;
1494 return tv;
1498 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1499 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1501 * Call some vimL function and return the result in "*rettv".
1502 * Uses argv[argc] for the function arguments. Only Number and String
1503 * arguments are currently supported.
1504 * Returns OK or FAIL.
1506 static int
1507 call_vim_function(func, argc, argv, safe, rettv)
1508 char_u *func;
1509 int argc;
1510 char_u **argv;
1511 int safe; /* use the sandbox */
1512 typval_T *rettv;
1514 typval_T *argvars;
1515 long n;
1516 int len;
1517 int i;
1518 int doesrange;
1519 void *save_funccalp = NULL;
1520 int ret;
1522 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1523 if (argvars == NULL)
1524 return FAIL;
1526 for (i = 0; i < argc; i++)
1528 /* Pass a NULL or empty argument as an empty string */
1529 if (argv[i] == NULL || *argv[i] == NUL)
1531 argvars[i].v_type = VAR_STRING;
1532 argvars[i].vval.v_string = (char_u *)"";
1533 continue;
1536 /* Recognize a number argument, the others must be strings. */
1537 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1538 if (len != 0 && len == (int)STRLEN(argv[i]))
1540 argvars[i].v_type = VAR_NUMBER;
1541 argvars[i].vval.v_number = n;
1543 else
1545 argvars[i].v_type = VAR_STRING;
1546 argvars[i].vval.v_string = argv[i];
1550 if (safe)
1552 save_funccalp = save_funccal();
1553 ++sandbox;
1556 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1557 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1558 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1559 &doesrange, TRUE, NULL);
1560 if (safe)
1562 --sandbox;
1563 restore_funccal(save_funccalp);
1565 vim_free(argvars);
1567 if (ret == FAIL)
1568 clear_tv(rettv);
1570 return ret;
1573 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1575 * Call vimL function "func" and return the result as a string.
1576 * Returns NULL when calling the function fails.
1577 * Uses argv[argc] for the function arguments.
1579 void *
1580 call_func_retstr(func, argc, argv, safe)
1581 char_u *func;
1582 int argc;
1583 char_u **argv;
1584 int safe; /* use the sandbox */
1586 typval_T rettv;
1587 char_u *retval;
1589 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1590 return NULL;
1592 retval = vim_strsave(get_tv_string(&rettv));
1593 clear_tv(&rettv);
1594 return retval;
1596 # endif
1598 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1600 * Call vimL function "func" and return the result as a number.
1601 * Returns -1 when calling the function fails.
1602 * Uses argv[argc] for the function arguments.
1604 long
1605 call_func_retnr(func, argc, argv, safe)
1606 char_u *func;
1607 int argc;
1608 char_u **argv;
1609 int safe; /* use the sandbox */
1611 typval_T rettv;
1612 long retval;
1614 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1615 return -1;
1617 retval = get_tv_number_chk(&rettv, NULL);
1618 clear_tv(&rettv);
1619 return retval;
1621 # endif
1624 * Call vimL function "func" and return the result as a List.
1625 * Uses argv[argc] for the function arguments.
1626 * Returns NULL when there is something wrong.
1628 void *
1629 call_func_retlist(func, argc, argv, safe)
1630 char_u *func;
1631 int argc;
1632 char_u **argv;
1633 int safe; /* use the sandbox */
1635 typval_T rettv;
1637 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1638 return NULL;
1640 if (rettv.v_type != VAR_LIST)
1642 clear_tv(&rettv);
1643 return NULL;
1646 return rettv.vval.v_list;
1648 #endif
1652 * Save the current function call pointer, and set it to NULL.
1653 * Used when executing autocommands and for ":source".
1655 void *
1656 save_funccal()
1658 funccall_T *fc = current_funccal;
1660 current_funccal = NULL;
1661 return (void *)fc;
1664 void
1665 restore_funccal(vfc)
1666 void *vfc;
1668 funccall_T *fc = (funccall_T *)vfc;
1670 current_funccal = fc;
1673 #if defined(FEAT_PROFILE) || defined(PROTO)
1675 * Prepare profiling for entering a child or something else that is not
1676 * counted for the script/function itself.
1677 * Should always be called in pair with prof_child_exit().
1679 void
1680 prof_child_enter(tm)
1681 proftime_T *tm; /* place to store waittime */
1683 funccall_T *fc = current_funccal;
1685 if (fc != NULL && fc->func->uf_profiling)
1686 profile_start(&fc->prof_child);
1687 script_prof_save(tm);
1691 * Take care of time spent in a child.
1692 * Should always be called after prof_child_enter().
1694 void
1695 prof_child_exit(tm)
1696 proftime_T *tm; /* where waittime was stored */
1698 funccall_T *fc = current_funccal;
1700 if (fc != NULL && fc->func->uf_profiling)
1702 profile_end(&fc->prof_child);
1703 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1704 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1705 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1707 script_prof_restore(tm);
1709 #endif
1712 #ifdef FEAT_FOLDING
1714 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1715 * it in "*cp". Doesn't give error messages.
1718 eval_foldexpr(arg, cp)
1719 char_u *arg;
1720 int *cp;
1722 typval_T tv;
1723 int retval;
1724 char_u *s;
1725 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1726 OPT_LOCAL);
1728 ++emsg_off;
1729 if (use_sandbox)
1730 ++sandbox;
1731 ++textlock;
1732 *cp = NUL;
1733 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1734 retval = 0;
1735 else
1737 /* If the result is a number, just return the number. */
1738 if (tv.v_type == VAR_NUMBER)
1739 retval = tv.vval.v_number;
1740 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1741 retval = 0;
1742 else
1744 /* If the result is a string, check if there is a non-digit before
1745 * the number. */
1746 s = tv.vval.v_string;
1747 if (!VIM_ISDIGIT(*s) && *s != '-')
1748 *cp = *s++;
1749 retval = atol((char *)s);
1751 clear_tv(&tv);
1753 --emsg_off;
1754 if (use_sandbox)
1755 --sandbox;
1756 --textlock;
1758 return retval;
1760 #endif
1763 * ":let" list all variable values
1764 * ":let var1 var2" list variable values
1765 * ":let var = expr" assignment command.
1766 * ":let var += expr" assignment command.
1767 * ":let var -= expr" assignment command.
1768 * ":let var .= expr" assignment command.
1769 * ":let [var1, var2] = expr" unpack list.
1771 void
1772 ex_let(eap)
1773 exarg_T *eap;
1775 char_u *arg = eap->arg;
1776 char_u *expr = NULL;
1777 typval_T rettv;
1778 int i;
1779 int var_count = 0;
1780 int semicolon = 0;
1781 char_u op[2];
1782 char_u *argend;
1783 int first = TRUE;
1785 argend = skip_var_list(arg, &var_count, &semicolon);
1786 if (argend == NULL)
1787 return;
1788 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1789 --argend;
1790 expr = vim_strchr(argend, '=');
1791 if (expr == NULL)
1794 * ":let" without "=": list variables
1796 if (*arg == '[')
1797 EMSG(_(e_invarg));
1798 else if (!ends_excmd(*arg))
1799 /* ":let var1 var2" */
1800 arg = list_arg_vars(eap, arg, &first);
1801 else if (!eap->skip)
1803 /* ":let" */
1804 list_glob_vars(&first);
1805 list_buf_vars(&first);
1806 list_win_vars(&first);
1807 #ifdef FEAT_WINDOWS
1808 list_tab_vars(&first);
1809 #endif
1810 list_script_vars(&first);
1811 list_func_vars(&first);
1812 list_vim_vars(&first);
1814 eap->nextcmd = check_nextcmd(arg);
1816 else
1818 op[0] = '=';
1819 op[1] = NUL;
1820 if (expr > argend)
1822 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1823 op[0] = expr[-1]; /* +=, -= or .= */
1825 expr = skipwhite(expr + 1);
1827 if (eap->skip)
1828 ++emsg_skip;
1829 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1830 if (eap->skip)
1832 if (i != FAIL)
1833 clear_tv(&rettv);
1834 --emsg_skip;
1836 else if (i != FAIL)
1838 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1839 op);
1840 clear_tv(&rettv);
1846 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1847 * Handles both "var" with any type and "[var, var; var]" with a list type.
1848 * When "nextchars" is not NULL it points to a string with characters that
1849 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1850 * or concatenate.
1851 * Returns OK or FAIL;
1853 static int
1854 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1855 char_u *arg_start;
1856 typval_T *tv;
1857 int copy; /* copy values from "tv", don't move */
1858 int semicolon; /* from skip_var_list() */
1859 int var_count; /* from skip_var_list() */
1860 char_u *nextchars;
1862 char_u *arg = arg_start;
1863 list_T *l;
1864 int i;
1865 listitem_T *item;
1866 typval_T ltv;
1868 if (*arg != '[')
1871 * ":let var = expr" or ":for var in list"
1873 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1874 return FAIL;
1875 return OK;
1879 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1881 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1883 EMSG(_(e_listreq));
1884 return FAIL;
1887 i = list_len(l);
1888 if (semicolon == 0 && var_count < i)
1890 EMSG(_("E687: Less targets than List items"));
1891 return FAIL;
1893 if (var_count - semicolon > i)
1895 EMSG(_("E688: More targets than List items"));
1896 return FAIL;
1899 item = l->lv_first;
1900 while (*arg != ']')
1902 arg = skipwhite(arg + 1);
1903 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1904 item = item->li_next;
1905 if (arg == NULL)
1906 return FAIL;
1908 arg = skipwhite(arg);
1909 if (*arg == ';')
1911 /* Put the rest of the list (may be empty) in the var after ';'.
1912 * Create a new list for this. */
1913 l = list_alloc();
1914 if (l == NULL)
1915 return FAIL;
1916 while (item != NULL)
1918 list_append_tv(l, &item->li_tv);
1919 item = item->li_next;
1922 ltv.v_type = VAR_LIST;
1923 ltv.v_lock = 0;
1924 ltv.vval.v_list = l;
1925 l->lv_refcount = 1;
1927 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1928 (char_u *)"]", nextchars);
1929 clear_tv(&ltv);
1930 if (arg == NULL)
1931 return FAIL;
1932 break;
1934 else if (*arg != ',' && *arg != ']')
1936 EMSG2(_(e_intern2), "ex_let_vars()");
1937 return FAIL;
1941 return OK;
1945 * Skip over assignable variable "var" or list of variables "[var, var]".
1946 * Used for ":let varvar = expr" and ":for varvar in expr".
1947 * For "[var, var]" increment "*var_count" for each variable.
1948 * for "[var, var; var]" set "semicolon".
1949 * Return NULL for an error.
1951 static char_u *
1952 skip_var_list(arg, var_count, semicolon)
1953 char_u *arg;
1954 int *var_count;
1955 int *semicolon;
1957 char_u *p, *s;
1959 if (*arg == '[')
1961 /* "[var, var]": find the matching ']'. */
1962 p = arg;
1963 for (;;)
1965 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1966 s = skip_var_one(p);
1967 if (s == p)
1969 EMSG2(_(e_invarg2), p);
1970 return NULL;
1972 ++*var_count;
1974 p = skipwhite(s);
1975 if (*p == ']')
1976 break;
1977 else if (*p == ';')
1979 if (*semicolon == 1)
1981 EMSG(_("Double ; in list of variables"));
1982 return NULL;
1984 *semicolon = 1;
1986 else if (*p != ',')
1988 EMSG2(_(e_invarg2), p);
1989 return NULL;
1992 return p + 1;
1994 else
1995 return skip_var_one(arg);
1999 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
2000 * l[idx].
2002 static char_u *
2003 skip_var_one(arg)
2004 char_u *arg;
2006 if (*arg == '@' && arg[1] != NUL)
2007 return arg + 2;
2008 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2009 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2013 * List variables for hashtab "ht" with prefix "prefix".
2014 * If "empty" is TRUE also list NULL strings as empty strings.
2016 static void
2017 list_hashtable_vars(ht, prefix, empty, first)
2018 hashtab_T *ht;
2019 char_u *prefix;
2020 int empty;
2021 int *first;
2023 hashitem_T *hi;
2024 dictitem_T *di;
2025 int todo;
2027 todo = (int)ht->ht_used;
2028 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2030 if (!HASHITEM_EMPTY(hi))
2032 --todo;
2033 di = HI2DI(hi);
2034 if (empty || di->di_tv.v_type != VAR_STRING
2035 || di->di_tv.vval.v_string != NULL)
2036 list_one_var(di, prefix, first);
2042 * List global variables.
2044 static void
2045 list_glob_vars(first)
2046 int *first;
2048 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2052 * List buffer variables.
2054 static void
2055 list_buf_vars(first)
2056 int *first;
2058 char_u numbuf[NUMBUFLEN];
2060 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2061 TRUE, first);
2063 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2064 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2065 numbuf, first);
2069 * List window variables.
2071 static void
2072 list_win_vars(first)
2073 int *first;
2075 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2076 (char_u *)"w:", TRUE, first);
2079 #ifdef FEAT_WINDOWS
2081 * List tab page variables.
2083 static void
2084 list_tab_vars(first)
2085 int *first;
2087 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2088 (char_u *)"t:", TRUE, first);
2090 #endif
2093 * List Vim variables.
2095 static void
2096 list_vim_vars(first)
2097 int *first;
2099 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2103 * List script-local variables, if there is a script.
2105 static void
2106 list_script_vars(first)
2107 int *first;
2109 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2110 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2111 (char_u *)"s:", FALSE, first);
2115 * List function variables, if there is a function.
2117 static void
2118 list_func_vars(first)
2119 int *first;
2121 if (current_funccal != NULL)
2122 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2123 (char_u *)"l:", FALSE, first);
2127 * List variables in "arg".
2129 static char_u *
2130 list_arg_vars(eap, arg, first)
2131 exarg_T *eap;
2132 char_u *arg;
2133 int *first;
2135 int error = FALSE;
2136 int len;
2137 char_u *name;
2138 char_u *name_start;
2139 char_u *arg_subsc;
2140 char_u *tofree;
2141 typval_T tv;
2143 while (!ends_excmd(*arg) && !got_int)
2145 if (error || eap->skip)
2147 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2148 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2150 emsg_severe = TRUE;
2151 EMSG(_(e_trailing));
2152 break;
2155 else
2157 /* get_name_len() takes care of expanding curly braces */
2158 name_start = name = arg;
2159 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2160 if (len <= 0)
2162 /* This is mainly to keep test 49 working: when expanding
2163 * curly braces fails overrule the exception error message. */
2164 if (len < 0 && !aborting())
2166 emsg_severe = TRUE;
2167 EMSG2(_(e_invarg2), arg);
2168 break;
2170 error = TRUE;
2172 else
2174 if (tofree != NULL)
2175 name = tofree;
2176 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2177 error = TRUE;
2178 else
2180 /* handle d.key, l[idx], f(expr) */
2181 arg_subsc = arg;
2182 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2183 error = TRUE;
2184 else
2186 if (arg == arg_subsc && len == 2 && name[1] == ':')
2188 switch (*name)
2190 case 'g': list_glob_vars(first); break;
2191 case 'b': list_buf_vars(first); break;
2192 case 'w': list_win_vars(first); break;
2193 #ifdef FEAT_WINDOWS
2194 case 't': list_tab_vars(first); break;
2195 #endif
2196 case 'v': list_vim_vars(first); break;
2197 case 's': list_script_vars(first); break;
2198 case 'l': list_func_vars(first); break;
2199 default:
2200 EMSG2(_("E738: Can't list variables for %s"), name);
2203 else
2205 char_u numbuf[NUMBUFLEN];
2206 char_u *tf;
2207 int c;
2208 char_u *s;
2210 s = echo_string(&tv, &tf, numbuf, 0);
2211 c = *arg;
2212 *arg = NUL;
2213 list_one_var_a((char_u *)"",
2214 arg == arg_subsc ? name : name_start,
2215 tv.v_type,
2216 s == NULL ? (char_u *)"" : s,
2217 first);
2218 *arg = c;
2219 vim_free(tf);
2221 clear_tv(&tv);
2226 vim_free(tofree);
2229 arg = skipwhite(arg);
2232 return arg;
2236 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2237 * Returns a pointer to the char just after the var name.
2238 * Returns NULL if there is an error.
2240 static char_u *
2241 ex_let_one(arg, tv, copy, endchars, op)
2242 char_u *arg; /* points to variable name */
2243 typval_T *tv; /* value to assign to variable */
2244 int copy; /* copy value from "tv" */
2245 char_u *endchars; /* valid chars after variable name or NULL */
2246 char_u *op; /* "+", "-", "." or NULL*/
2248 int c1;
2249 char_u *name;
2250 char_u *p;
2251 char_u *arg_end = NULL;
2252 int len;
2253 int opt_flags;
2254 char_u *tofree = NULL;
2257 * ":let $VAR = expr": Set environment variable.
2259 if (*arg == '$')
2261 /* Find the end of the name. */
2262 ++arg;
2263 name = arg;
2264 len = get_env_len(&arg);
2265 if (len == 0)
2266 EMSG2(_(e_invarg2), name - 1);
2267 else
2269 if (op != NULL && (*op == '+' || *op == '-'))
2270 EMSG2(_(e_letwrong), op);
2271 else if (endchars != NULL
2272 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2273 EMSG(_(e_letunexp));
2274 else
2276 c1 = name[len];
2277 name[len] = NUL;
2278 p = get_tv_string_chk(tv);
2279 if (p != NULL && op != NULL && *op == '.')
2281 int mustfree = FALSE;
2282 char_u *s = vim_getenv(name, &mustfree);
2284 if (s != NULL)
2286 p = tofree = concat_str(s, p);
2287 if (mustfree)
2288 vim_free(s);
2291 if (p != NULL)
2293 vim_setenv(name, p);
2294 if (STRICMP(name, "HOME") == 0)
2295 init_homedir();
2296 else if (didset_vim && STRICMP(name, "VIM") == 0)
2297 didset_vim = FALSE;
2298 else if (didset_vimruntime
2299 && STRICMP(name, "VIMRUNTIME") == 0)
2300 didset_vimruntime = FALSE;
2301 arg_end = arg;
2303 name[len] = c1;
2304 vim_free(tofree);
2310 * ":let &option = expr": Set option value.
2311 * ":let &l:option = expr": Set local option value.
2312 * ":let &g:option = expr": Set global option value.
2314 else if (*arg == '&')
2316 /* Find the end of the name. */
2317 p = find_option_end(&arg, &opt_flags);
2318 if (p == NULL || (endchars != NULL
2319 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2320 EMSG(_(e_letunexp));
2321 else
2323 long n;
2324 int opt_type;
2325 long numval;
2326 char_u *stringval = NULL;
2327 char_u *s;
2329 c1 = *p;
2330 *p = NUL;
2332 n = get_tv_number(tv);
2333 s = get_tv_string_chk(tv); /* != NULL if number or string */
2334 if (s != NULL && op != NULL && *op != '=')
2336 opt_type = get_option_value(arg, &numval,
2337 &stringval, opt_flags);
2338 if ((opt_type == 1 && *op == '.')
2339 || (opt_type == 0 && *op != '.'))
2340 EMSG2(_(e_letwrong), op);
2341 else
2343 if (opt_type == 1) /* number */
2345 if (*op == '+')
2346 n = numval + n;
2347 else
2348 n = numval - n;
2350 else if (opt_type == 0 && stringval != NULL) /* string */
2352 s = concat_str(stringval, s);
2353 vim_free(stringval);
2354 stringval = s;
2358 if (s != NULL)
2360 set_option_value(arg, n, s, opt_flags);
2361 arg_end = p;
2363 *p = c1;
2364 vim_free(stringval);
2369 * ":let @r = expr": Set register contents.
2371 else if (*arg == '@')
2373 ++arg;
2374 if (op != NULL && (*op == '+' || *op == '-'))
2375 EMSG2(_(e_letwrong), op);
2376 else if (endchars != NULL
2377 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2378 EMSG(_(e_letunexp));
2379 else
2381 char_u *ptofree = NULL;
2382 char_u *s;
2384 p = get_tv_string_chk(tv);
2385 if (p != NULL && op != NULL && *op == '.')
2387 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2388 if (s != NULL)
2390 p = ptofree = concat_str(s, p);
2391 vim_free(s);
2394 if (p != NULL)
2396 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2397 arg_end = arg + 1;
2399 vim_free(ptofree);
2404 * ":let var = expr": Set internal variable.
2405 * ":let {expr} = expr": Idem, name made with curly braces
2407 else if (eval_isnamec1(*arg) || *arg == '{')
2409 lval_T lv;
2411 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2412 if (p != NULL && lv.ll_name != NULL)
2414 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2415 EMSG(_(e_letunexp));
2416 else
2418 set_var_lval(&lv, p, tv, copy, op);
2419 arg_end = p;
2422 clear_lval(&lv);
2425 else
2426 EMSG2(_(e_invarg2), arg);
2428 return arg_end;
2432 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2434 static int
2435 check_changedtick(arg)
2436 char_u *arg;
2438 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2440 EMSG2(_(e_readonlyvar), arg);
2441 return TRUE;
2443 return FALSE;
2447 * Get an lval: variable, Dict item or List item that can be assigned a value
2448 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2449 * "name.key", "name.key[expr]" etc.
2450 * Indexing only works if "name" is an existing List or Dictionary.
2451 * "name" points to the start of the name.
2452 * If "rettv" is not NULL it points to the value to be assigned.
2453 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2454 * wrong; must end in space or cmd separator.
2456 * Returns a pointer to just after the name, including indexes.
2457 * When an evaluation error occurs "lp->ll_name" is NULL;
2458 * Returns NULL for a parsing error. Still need to free items in "lp"!
2460 static char_u *
2461 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2462 char_u *name;
2463 typval_T *rettv;
2464 lval_T *lp;
2465 int unlet;
2466 int skip;
2467 int quiet; /* don't give error messages */
2468 int fne_flags; /* flags for find_name_end() */
2470 char_u *p;
2471 char_u *expr_start, *expr_end;
2472 int cc;
2473 dictitem_T *v;
2474 typval_T var1;
2475 typval_T var2;
2476 int empty1 = FALSE;
2477 listitem_T *ni;
2478 char_u *key = NULL;
2479 int len;
2480 hashtab_T *ht;
2482 /* Clear everything in "lp". */
2483 vim_memset(lp, 0, sizeof(lval_T));
2485 if (skip)
2487 /* When skipping just find the end of the name. */
2488 lp->ll_name = name;
2489 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2492 /* Find the end of the name. */
2493 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2494 if (expr_start != NULL)
2496 /* Don't expand the name when we already know there is an error. */
2497 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2498 && *p != '[' && *p != '.')
2500 EMSG(_(e_trailing));
2501 return NULL;
2504 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2505 if (lp->ll_exp_name == NULL)
2507 /* Report an invalid expression in braces, unless the
2508 * expression evaluation has been cancelled due to an
2509 * aborting error, an interrupt, or an exception. */
2510 if (!aborting() && !quiet)
2512 emsg_severe = TRUE;
2513 EMSG2(_(e_invarg2), name);
2514 return NULL;
2517 lp->ll_name = lp->ll_exp_name;
2519 else
2520 lp->ll_name = name;
2522 /* Without [idx] or .key we are done. */
2523 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2524 return p;
2526 cc = *p;
2527 *p = NUL;
2528 v = find_var(lp->ll_name, &ht);
2529 if (v == NULL && !quiet)
2530 EMSG2(_(e_undefvar), lp->ll_name);
2531 *p = cc;
2532 if (v == NULL)
2533 return NULL;
2536 * Loop until no more [idx] or .key is following.
2538 lp->ll_tv = &v->di_tv;
2539 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2541 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2542 && !(lp->ll_tv->v_type == VAR_DICT
2543 && lp->ll_tv->vval.v_dict != NULL))
2545 if (!quiet)
2546 EMSG(_("E689: Can only index a List or Dictionary"));
2547 return NULL;
2549 if (lp->ll_range)
2551 if (!quiet)
2552 EMSG(_("E708: [:] must come last"));
2553 return NULL;
2556 len = -1;
2557 if (*p == '.')
2559 key = p + 1;
2560 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2562 if (len == 0)
2564 if (!quiet)
2565 EMSG(_(e_emptykey));
2566 return NULL;
2568 p = key + len;
2570 else
2572 /* Get the index [expr] or the first index [expr: ]. */
2573 p = skipwhite(p + 1);
2574 if (*p == ':')
2575 empty1 = TRUE;
2576 else
2578 empty1 = FALSE;
2579 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2580 return NULL;
2581 if (get_tv_string_chk(&var1) == NULL)
2583 /* not a number or string */
2584 clear_tv(&var1);
2585 return NULL;
2589 /* Optionally get the second index [ :expr]. */
2590 if (*p == ':')
2592 if (lp->ll_tv->v_type == VAR_DICT)
2594 if (!quiet)
2595 EMSG(_(e_dictrange));
2596 if (!empty1)
2597 clear_tv(&var1);
2598 return NULL;
2600 if (rettv != NULL && (rettv->v_type != VAR_LIST
2601 || rettv->vval.v_list == NULL))
2603 if (!quiet)
2604 EMSG(_("E709: [:] requires a List value"));
2605 if (!empty1)
2606 clear_tv(&var1);
2607 return NULL;
2609 p = skipwhite(p + 1);
2610 if (*p == ']')
2611 lp->ll_empty2 = TRUE;
2612 else
2614 lp->ll_empty2 = FALSE;
2615 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2617 if (!empty1)
2618 clear_tv(&var1);
2619 return NULL;
2621 if (get_tv_string_chk(&var2) == NULL)
2623 /* not a number or string */
2624 if (!empty1)
2625 clear_tv(&var1);
2626 clear_tv(&var2);
2627 return NULL;
2630 lp->ll_range = TRUE;
2632 else
2633 lp->ll_range = FALSE;
2635 if (*p != ']')
2637 if (!quiet)
2638 EMSG(_(e_missbrac));
2639 if (!empty1)
2640 clear_tv(&var1);
2641 if (lp->ll_range && !lp->ll_empty2)
2642 clear_tv(&var2);
2643 return NULL;
2646 /* Skip to past ']'. */
2647 ++p;
2650 if (lp->ll_tv->v_type == VAR_DICT)
2652 if (len == -1)
2654 /* "[key]": get key from "var1" */
2655 key = get_tv_string(&var1); /* is number or string */
2656 if (*key == NUL)
2658 if (!quiet)
2659 EMSG(_(e_emptykey));
2660 clear_tv(&var1);
2661 return NULL;
2664 lp->ll_list = NULL;
2665 lp->ll_dict = lp->ll_tv->vval.v_dict;
2666 lp->ll_di = dict_find(lp->ll_dict, key, len);
2667 if (lp->ll_di == NULL)
2669 /* Key does not exist in dict: may need to add it. */
2670 if (*p == '[' || *p == '.' || unlet)
2672 if (!quiet)
2673 EMSG2(_(e_dictkey), key);
2674 if (len == -1)
2675 clear_tv(&var1);
2676 return NULL;
2678 if (len == -1)
2679 lp->ll_newkey = vim_strsave(key);
2680 else
2681 lp->ll_newkey = vim_strnsave(key, len);
2682 if (len == -1)
2683 clear_tv(&var1);
2684 if (lp->ll_newkey == NULL)
2685 p = NULL;
2686 break;
2688 if (len == -1)
2689 clear_tv(&var1);
2690 lp->ll_tv = &lp->ll_di->di_tv;
2692 else
2695 * Get the number and item for the only or first index of the List.
2697 if (empty1)
2698 lp->ll_n1 = 0;
2699 else
2701 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2702 clear_tv(&var1);
2704 lp->ll_dict = NULL;
2705 lp->ll_list = lp->ll_tv->vval.v_list;
2706 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2707 if (lp->ll_li == NULL)
2709 if (lp->ll_n1 < 0)
2711 lp->ll_n1 = 0;
2712 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2715 if (lp->ll_li == NULL)
2717 if (lp->ll_range && !lp->ll_empty2)
2718 clear_tv(&var2);
2719 return NULL;
2723 * May need to find the item or absolute index for the second
2724 * index of a range.
2725 * When no index given: "lp->ll_empty2" is TRUE.
2726 * Otherwise "lp->ll_n2" is set to the second index.
2728 if (lp->ll_range && !lp->ll_empty2)
2730 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2731 clear_tv(&var2);
2732 if (lp->ll_n2 < 0)
2734 ni = list_find(lp->ll_list, lp->ll_n2);
2735 if (ni == NULL)
2736 return NULL;
2737 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2740 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2741 if (lp->ll_n1 < 0)
2742 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2743 if (lp->ll_n2 < lp->ll_n1)
2744 return NULL;
2747 lp->ll_tv = &lp->ll_li->li_tv;
2751 return p;
2755 * Clear lval "lp" that was filled by get_lval().
2757 static void
2758 clear_lval(lp)
2759 lval_T *lp;
2761 vim_free(lp->ll_exp_name);
2762 vim_free(lp->ll_newkey);
2766 * Set a variable that was parsed by get_lval() to "rettv".
2767 * "endp" points to just after the parsed name.
2768 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2770 static void
2771 set_var_lval(lp, endp, rettv, copy, op)
2772 lval_T *lp;
2773 char_u *endp;
2774 typval_T *rettv;
2775 int copy;
2776 char_u *op;
2778 int cc;
2779 listitem_T *ri;
2780 dictitem_T *di;
2782 if (lp->ll_tv == NULL)
2784 if (!check_changedtick(lp->ll_name))
2786 cc = *endp;
2787 *endp = NUL;
2788 if (op != NULL && *op != '=')
2790 typval_T tv;
2792 /* handle +=, -= and .= */
2793 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2794 &tv, TRUE) == OK)
2796 if (tv_op(&tv, rettv, op) == OK)
2797 set_var(lp->ll_name, &tv, FALSE);
2798 clear_tv(&tv);
2801 else
2802 set_var(lp->ll_name, rettv, copy);
2803 *endp = cc;
2806 else if (tv_check_lock(lp->ll_newkey == NULL
2807 ? lp->ll_tv->v_lock
2808 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2810 else if (lp->ll_range)
2813 * Assign the List values to the list items.
2815 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2817 if (op != NULL && *op != '=')
2818 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2819 else
2821 clear_tv(&lp->ll_li->li_tv);
2822 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2824 ri = ri->li_next;
2825 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2826 break;
2827 if (lp->ll_li->li_next == NULL)
2829 /* Need to add an empty item. */
2830 if (list_append_number(lp->ll_list, 0) == FAIL)
2832 ri = NULL;
2833 break;
2836 lp->ll_li = lp->ll_li->li_next;
2837 ++lp->ll_n1;
2839 if (ri != NULL)
2840 EMSG(_("E710: List value has more items than target"));
2841 else if (lp->ll_empty2
2842 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2843 : lp->ll_n1 != lp->ll_n2)
2844 EMSG(_("E711: List value has not enough items"));
2846 else
2849 * Assign to a List or Dictionary item.
2851 if (lp->ll_newkey != NULL)
2853 if (op != NULL && *op != '=')
2855 EMSG2(_(e_letwrong), op);
2856 return;
2859 /* Need to add an item to the Dictionary. */
2860 di = dictitem_alloc(lp->ll_newkey);
2861 if (di == NULL)
2862 return;
2863 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2865 vim_free(di);
2866 return;
2868 lp->ll_tv = &di->di_tv;
2870 else if (op != NULL && *op != '=')
2872 tv_op(lp->ll_tv, rettv, op);
2873 return;
2875 else
2876 clear_tv(lp->ll_tv);
2879 * Assign the value to the variable or list item.
2881 if (copy)
2882 copy_tv(rettv, lp->ll_tv);
2883 else
2885 *lp->ll_tv = *rettv;
2886 lp->ll_tv->v_lock = 0;
2887 init_tv(rettv);
2893 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2894 * Returns OK or FAIL.
2896 static int
2897 tv_op(tv1, tv2, op)
2898 typval_T *tv1;
2899 typval_T *tv2;
2900 char_u *op;
2902 long n;
2903 char_u numbuf[NUMBUFLEN];
2904 char_u *s;
2906 /* Can't do anything with a Funcref or a Dict on the right. */
2907 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2909 switch (tv1->v_type)
2911 case VAR_DICT:
2912 case VAR_FUNC:
2913 break;
2915 case VAR_LIST:
2916 if (*op != '+' || tv2->v_type != VAR_LIST)
2917 break;
2918 /* List += List */
2919 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2920 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2921 return OK;
2923 case VAR_NUMBER:
2924 case VAR_STRING:
2925 if (tv2->v_type == VAR_LIST)
2926 break;
2927 if (*op == '+' || *op == '-')
2929 /* nr += nr or nr -= nr*/
2930 n = get_tv_number(tv1);
2931 #ifdef FEAT_FLOAT
2932 if (tv2->v_type == VAR_FLOAT)
2934 float_T f = n;
2936 if (*op == '+')
2937 f += tv2->vval.v_float;
2938 else
2939 f -= tv2->vval.v_float;
2940 clear_tv(tv1);
2941 tv1->v_type = VAR_FLOAT;
2942 tv1->vval.v_float = f;
2944 else
2945 #endif
2947 if (*op == '+')
2948 n += get_tv_number(tv2);
2949 else
2950 n -= get_tv_number(tv2);
2951 clear_tv(tv1);
2952 tv1->v_type = VAR_NUMBER;
2953 tv1->vval.v_number = n;
2956 else
2958 if (tv2->v_type == VAR_FLOAT)
2959 break;
2961 /* str .= str */
2962 s = get_tv_string(tv1);
2963 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2964 clear_tv(tv1);
2965 tv1->v_type = VAR_STRING;
2966 tv1->vval.v_string = s;
2968 return OK;
2970 #ifdef FEAT_FLOAT
2971 case VAR_FLOAT:
2973 float_T f;
2975 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2976 && tv2->v_type != VAR_NUMBER
2977 && tv2->v_type != VAR_STRING))
2978 break;
2979 if (tv2->v_type == VAR_FLOAT)
2980 f = tv2->vval.v_float;
2981 else
2982 f = get_tv_number(tv2);
2983 if (*op == '+')
2984 tv1->vval.v_float += f;
2985 else
2986 tv1->vval.v_float -= f;
2988 return OK;
2989 #endif
2993 EMSG2(_(e_letwrong), op);
2994 return FAIL;
2998 * Add a watcher to a list.
3000 static void
3001 list_add_watch(l, lw)
3002 list_T *l;
3003 listwatch_T *lw;
3005 lw->lw_next = l->lv_watch;
3006 l->lv_watch = lw;
3010 * Remove a watcher from a list.
3011 * No warning when it isn't found...
3013 static void
3014 list_rem_watch(l, lwrem)
3015 list_T *l;
3016 listwatch_T *lwrem;
3018 listwatch_T *lw, **lwp;
3020 lwp = &l->lv_watch;
3021 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3023 if (lw == lwrem)
3025 *lwp = lw->lw_next;
3026 break;
3028 lwp = &lw->lw_next;
3033 * Just before removing an item from a list: advance watchers to the next
3034 * item.
3036 static void
3037 list_fix_watch(l, item)
3038 list_T *l;
3039 listitem_T *item;
3041 listwatch_T *lw;
3043 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3044 if (lw->lw_item == item)
3045 lw->lw_item = item->li_next;
3049 * Evaluate the expression used in a ":for var in expr" command.
3050 * "arg" points to "var".
3051 * Set "*errp" to TRUE for an error, FALSE otherwise;
3052 * Return a pointer that holds the info. Null when there is an error.
3054 void *
3055 eval_for_line(arg, errp, nextcmdp, skip)
3056 char_u *arg;
3057 int *errp;
3058 char_u **nextcmdp;
3059 int skip;
3061 forinfo_T *fi;
3062 char_u *expr;
3063 typval_T tv;
3064 list_T *l;
3066 *errp = TRUE; /* default: there is an error */
3068 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3069 if (fi == NULL)
3070 return NULL;
3072 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3073 if (expr == NULL)
3074 return fi;
3076 expr = skipwhite(expr);
3077 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3079 EMSG(_("E690: Missing \"in\" after :for"));
3080 return fi;
3083 if (skip)
3084 ++emsg_skip;
3085 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3087 *errp = FALSE;
3088 if (!skip)
3090 l = tv.vval.v_list;
3091 if (tv.v_type != VAR_LIST || l == NULL)
3093 EMSG(_(e_listreq));
3094 clear_tv(&tv);
3096 else
3098 /* No need to increment the refcount, it's already set for the
3099 * list being used in "tv". */
3100 fi->fi_list = l;
3101 list_add_watch(l, &fi->fi_lw);
3102 fi->fi_lw.lw_item = l->lv_first;
3106 if (skip)
3107 --emsg_skip;
3109 return fi;
3113 * Use the first item in a ":for" list. Advance to the next.
3114 * Assign the values to the variable (list). "arg" points to the first one.
3115 * Return TRUE when a valid item was found, FALSE when at end of list or
3116 * something wrong.
3119 next_for_item(fi_void, arg)
3120 void *fi_void;
3121 char_u *arg;
3123 forinfo_T *fi = (forinfo_T *)fi_void;
3124 int result;
3125 listitem_T *item;
3127 item = fi->fi_lw.lw_item;
3128 if (item == NULL)
3129 result = FALSE;
3130 else
3132 fi->fi_lw.lw_item = item->li_next;
3133 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3134 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3136 return result;
3140 * Free the structure used to store info used by ":for".
3142 void
3143 free_for_info(fi_void)
3144 void *fi_void;
3146 forinfo_T *fi = (forinfo_T *)fi_void;
3148 if (fi != NULL && fi->fi_list != NULL)
3150 list_rem_watch(fi->fi_list, &fi->fi_lw);
3151 list_unref(fi->fi_list);
3153 vim_free(fi);
3156 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3158 void
3159 set_context_for_expression(xp, arg, cmdidx)
3160 expand_T *xp;
3161 char_u *arg;
3162 cmdidx_T cmdidx;
3164 int got_eq = FALSE;
3165 int c;
3166 char_u *p;
3168 if (cmdidx == CMD_let)
3170 xp->xp_context = EXPAND_USER_VARS;
3171 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3173 /* ":let var1 var2 ...": find last space. */
3174 for (p = arg + STRLEN(arg); p >= arg; )
3176 xp->xp_pattern = p;
3177 mb_ptr_back(arg, p);
3178 if (vim_iswhite(*p))
3179 break;
3181 return;
3184 else
3185 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3186 : EXPAND_EXPRESSION;
3187 while ((xp->xp_pattern = vim_strpbrk(arg,
3188 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3190 c = *xp->xp_pattern;
3191 if (c == '&')
3193 c = xp->xp_pattern[1];
3194 if (c == '&')
3196 ++xp->xp_pattern;
3197 xp->xp_context = cmdidx != CMD_let || got_eq
3198 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3200 else if (c != ' ')
3202 xp->xp_context = EXPAND_SETTINGS;
3203 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3204 xp->xp_pattern += 2;
3208 else if (c == '$')
3210 /* environment variable */
3211 xp->xp_context = EXPAND_ENV_VARS;
3213 else if (c == '=')
3215 got_eq = TRUE;
3216 xp->xp_context = EXPAND_EXPRESSION;
3218 else if (c == '<'
3219 && xp->xp_context == EXPAND_FUNCTIONS
3220 && vim_strchr(xp->xp_pattern, '(') == NULL)
3222 /* Function name can start with "<SNR>" */
3223 break;
3225 else if (cmdidx != CMD_let || got_eq)
3227 if (c == '"') /* string */
3229 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3230 if (c == '\\' && xp->xp_pattern[1] != NUL)
3231 ++xp->xp_pattern;
3232 xp->xp_context = EXPAND_NOTHING;
3234 else if (c == '\'') /* literal string */
3236 /* Trick: '' is like stopping and starting a literal string. */
3237 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3238 /* skip */ ;
3239 xp->xp_context = EXPAND_NOTHING;
3241 else if (c == '|')
3243 if (xp->xp_pattern[1] == '|')
3245 ++xp->xp_pattern;
3246 xp->xp_context = EXPAND_EXPRESSION;
3248 else
3249 xp->xp_context = EXPAND_COMMANDS;
3251 else
3252 xp->xp_context = EXPAND_EXPRESSION;
3254 else
3255 /* Doesn't look like something valid, expand as an expression
3256 * anyway. */
3257 xp->xp_context = EXPAND_EXPRESSION;
3258 arg = xp->xp_pattern;
3259 if (*arg != NUL)
3260 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3261 /* skip */ ;
3263 xp->xp_pattern = arg;
3266 #endif /* FEAT_CMDL_COMPL */
3269 * ":1,25call func(arg1, arg2)" function call.
3271 void
3272 ex_call(eap)
3273 exarg_T *eap;
3275 char_u *arg = eap->arg;
3276 char_u *startarg;
3277 char_u *name;
3278 char_u *tofree;
3279 int len;
3280 typval_T rettv;
3281 linenr_T lnum;
3282 int doesrange;
3283 int failed = FALSE;
3284 funcdict_T fudi;
3286 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3287 if (fudi.fd_newkey != NULL)
3289 /* Still need to give an error message for missing key. */
3290 EMSG2(_(e_dictkey), fudi.fd_newkey);
3291 vim_free(fudi.fd_newkey);
3293 if (tofree == NULL)
3294 return;
3296 /* Increase refcount on dictionary, it could get deleted when evaluating
3297 * the arguments. */
3298 if (fudi.fd_dict != NULL)
3299 ++fudi.fd_dict->dv_refcount;
3301 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3302 len = (int)STRLEN(tofree);
3303 name = deref_func_name(tofree, &len);
3305 /* Skip white space to allow ":call func ()". Not good, but required for
3306 * backward compatibility. */
3307 startarg = skipwhite(arg);
3308 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3310 if (*startarg != '(')
3312 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3313 goto end;
3317 * When skipping, evaluate the function once, to find the end of the
3318 * arguments.
3319 * When the function takes a range, this is discovered after the first
3320 * call, and the loop is broken.
3322 if (eap->skip)
3324 ++emsg_skip;
3325 lnum = eap->line2; /* do it once, also with an invalid range */
3327 else
3328 lnum = eap->line1;
3329 for ( ; lnum <= eap->line2; ++lnum)
3331 if (!eap->skip && eap->addr_count > 0)
3333 curwin->w_cursor.lnum = lnum;
3334 curwin->w_cursor.col = 0;
3336 arg = startarg;
3337 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3338 eap->line1, eap->line2, &doesrange,
3339 !eap->skip, fudi.fd_dict) == FAIL)
3341 failed = TRUE;
3342 break;
3345 /* Handle a function returning a Funcref, Dictionary or List. */
3346 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3348 failed = TRUE;
3349 break;
3352 clear_tv(&rettv);
3353 if (doesrange || eap->skip)
3354 break;
3356 /* Stop when immediately aborting on error, or when an interrupt
3357 * occurred or an exception was thrown but not caught.
3358 * get_func_tv() returned OK, so that the check for trailing
3359 * characters below is executed. */
3360 if (aborting())
3361 break;
3363 if (eap->skip)
3364 --emsg_skip;
3366 if (!failed)
3368 /* Check for trailing illegal characters and a following command. */
3369 if (!ends_excmd(*arg))
3371 emsg_severe = TRUE;
3372 EMSG(_(e_trailing));
3374 else
3375 eap->nextcmd = check_nextcmd(arg);
3378 end:
3379 dict_unref(fudi.fd_dict);
3380 vim_free(tofree);
3384 * ":unlet[!] var1 ... " command.
3386 void
3387 ex_unlet(eap)
3388 exarg_T *eap;
3390 ex_unletlock(eap, eap->arg, 0);
3394 * ":lockvar" and ":unlockvar" commands
3396 void
3397 ex_lockvar(eap)
3398 exarg_T *eap;
3400 char_u *arg = eap->arg;
3401 int deep = 2;
3403 if (eap->forceit)
3404 deep = -1;
3405 else if (vim_isdigit(*arg))
3407 deep = getdigits(&arg);
3408 arg = skipwhite(arg);
3411 ex_unletlock(eap, arg, deep);
3415 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3417 static void
3418 ex_unletlock(eap, argstart, deep)
3419 exarg_T *eap;
3420 char_u *argstart;
3421 int deep;
3423 char_u *arg = argstart;
3424 char_u *name_end;
3425 int error = FALSE;
3426 lval_T lv;
3430 /* Parse the name and find the end. */
3431 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3432 FNE_CHECK_START);
3433 if (lv.ll_name == NULL)
3434 error = TRUE; /* error but continue parsing */
3435 if (name_end == NULL || (!vim_iswhite(*name_end)
3436 && !ends_excmd(*name_end)))
3438 if (name_end != NULL)
3440 emsg_severe = TRUE;
3441 EMSG(_(e_trailing));
3443 if (!(eap->skip || error))
3444 clear_lval(&lv);
3445 break;
3448 if (!error && !eap->skip)
3450 if (eap->cmdidx == CMD_unlet)
3452 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3453 error = TRUE;
3455 else
3457 if (do_lock_var(&lv, name_end, deep,
3458 eap->cmdidx == CMD_lockvar) == FAIL)
3459 error = TRUE;
3463 if (!eap->skip)
3464 clear_lval(&lv);
3466 arg = skipwhite(name_end);
3467 } while (!ends_excmd(*arg));
3469 eap->nextcmd = check_nextcmd(arg);
3472 static int
3473 do_unlet_var(lp, name_end, forceit)
3474 lval_T *lp;
3475 char_u *name_end;
3476 int forceit;
3478 int ret = OK;
3479 int cc;
3481 if (lp->ll_tv == NULL)
3483 cc = *name_end;
3484 *name_end = NUL;
3486 /* Normal name or expanded name. */
3487 if (check_changedtick(lp->ll_name))
3488 ret = FAIL;
3489 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3490 ret = FAIL;
3491 *name_end = cc;
3493 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3494 return FAIL;
3495 else if (lp->ll_range)
3497 listitem_T *li;
3499 /* Delete a range of List items. */
3500 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3502 li = lp->ll_li->li_next;
3503 listitem_remove(lp->ll_list, lp->ll_li);
3504 lp->ll_li = li;
3505 ++lp->ll_n1;
3508 else
3510 if (lp->ll_list != NULL)
3511 /* unlet a List item. */
3512 listitem_remove(lp->ll_list, lp->ll_li);
3513 else
3514 /* unlet a Dictionary item. */
3515 dictitem_remove(lp->ll_dict, lp->ll_di);
3518 return ret;
3522 * "unlet" a variable. Return OK if it existed, FAIL if not.
3523 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3526 do_unlet(name, forceit)
3527 char_u *name;
3528 int forceit;
3530 hashtab_T *ht;
3531 hashitem_T *hi;
3532 char_u *varname;
3533 dictitem_T *di;
3535 ht = find_var_ht(name, &varname);
3536 if (ht != NULL && *varname != NUL)
3538 hi = hash_find(ht, varname);
3539 if (!HASHITEM_EMPTY(hi))
3541 di = HI2DI(hi);
3542 if (var_check_fixed(di->di_flags, name)
3543 || var_check_ro(di->di_flags, name))
3544 return FAIL;
3545 delete_var(ht, hi);
3546 return OK;
3549 if (forceit)
3550 return OK;
3551 EMSG2(_("E108: No such variable: \"%s\""), name);
3552 return FAIL;
3556 * Lock or unlock variable indicated by "lp".
3557 * "deep" is the levels to go (-1 for unlimited);
3558 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3560 static int
3561 do_lock_var(lp, name_end, deep, lock)
3562 lval_T *lp;
3563 char_u *name_end;
3564 int deep;
3565 int lock;
3567 int ret = OK;
3568 int cc;
3569 dictitem_T *di;
3571 if (deep == 0) /* nothing to do */
3572 return OK;
3574 if (lp->ll_tv == NULL)
3576 cc = *name_end;
3577 *name_end = NUL;
3579 /* Normal name or expanded name. */
3580 if (check_changedtick(lp->ll_name))
3581 ret = FAIL;
3582 else
3584 di = find_var(lp->ll_name, NULL);
3585 if (di == NULL)
3586 ret = FAIL;
3587 else
3589 if (lock)
3590 di->di_flags |= DI_FLAGS_LOCK;
3591 else
3592 di->di_flags &= ~DI_FLAGS_LOCK;
3593 item_lock(&di->di_tv, deep, lock);
3596 *name_end = cc;
3598 else if (lp->ll_range)
3600 listitem_T *li = lp->ll_li;
3602 /* (un)lock a range of List items. */
3603 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3605 item_lock(&li->li_tv, deep, lock);
3606 li = li->li_next;
3607 ++lp->ll_n1;
3610 else if (lp->ll_list != NULL)
3611 /* (un)lock a List item. */
3612 item_lock(&lp->ll_li->li_tv, deep, lock);
3613 else
3614 /* un(lock) a Dictionary item. */
3615 item_lock(&lp->ll_di->di_tv, deep, lock);
3617 return ret;
3621 * Lock or unlock an item. "deep" is nr of levels to go.
3623 static void
3624 item_lock(tv, deep, lock)
3625 typval_T *tv;
3626 int deep;
3627 int lock;
3629 static int recurse = 0;
3630 list_T *l;
3631 listitem_T *li;
3632 dict_T *d;
3633 hashitem_T *hi;
3634 int todo;
3636 if (recurse >= DICT_MAXNEST)
3638 EMSG(_("E743: variable nested too deep for (un)lock"));
3639 return;
3641 if (deep == 0)
3642 return;
3643 ++recurse;
3645 /* lock/unlock the item itself */
3646 if (lock)
3647 tv->v_lock |= VAR_LOCKED;
3648 else
3649 tv->v_lock &= ~VAR_LOCKED;
3651 switch (tv->v_type)
3653 case VAR_LIST:
3654 if ((l = tv->vval.v_list) != NULL)
3656 if (lock)
3657 l->lv_lock |= VAR_LOCKED;
3658 else
3659 l->lv_lock &= ~VAR_LOCKED;
3660 if (deep < 0 || deep > 1)
3661 /* recursive: lock/unlock the items the List contains */
3662 for (li = l->lv_first; li != NULL; li = li->li_next)
3663 item_lock(&li->li_tv, deep - 1, lock);
3665 break;
3666 case VAR_DICT:
3667 if ((d = tv->vval.v_dict) != NULL)
3669 if (lock)
3670 d->dv_lock |= VAR_LOCKED;
3671 else
3672 d->dv_lock &= ~VAR_LOCKED;
3673 if (deep < 0 || deep > 1)
3675 /* recursive: lock/unlock the items the List contains */
3676 todo = (int)d->dv_hashtab.ht_used;
3677 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3679 if (!HASHITEM_EMPTY(hi))
3681 --todo;
3682 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3688 --recurse;
3692 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3693 * or it refers to a List or Dictionary that is locked.
3695 static int
3696 tv_islocked(tv)
3697 typval_T *tv;
3699 return (tv->v_lock & VAR_LOCKED)
3700 || (tv->v_type == VAR_LIST
3701 && tv->vval.v_list != NULL
3702 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3703 || (tv->v_type == VAR_DICT
3704 && tv->vval.v_dict != NULL
3705 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3708 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3710 * Delete all "menutrans_" variables.
3712 void
3713 del_menutrans_vars()
3715 hashitem_T *hi;
3716 int todo;
3718 hash_lock(&globvarht);
3719 todo = (int)globvarht.ht_used;
3720 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3722 if (!HASHITEM_EMPTY(hi))
3724 --todo;
3725 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3726 delete_var(&globvarht, hi);
3729 hash_unlock(&globvarht);
3731 #endif
3733 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3736 * Local string buffer for the next two functions to store a variable name
3737 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3738 * get_user_var_name().
3741 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3743 static char_u *varnamebuf = NULL;
3744 static int varnamebuflen = 0;
3747 * Function to concatenate a prefix and a variable name.
3749 static char_u *
3750 cat_prefix_varname(prefix, name)
3751 int prefix;
3752 char_u *name;
3754 int len;
3756 len = (int)STRLEN(name) + 3;
3757 if (len > varnamebuflen)
3759 vim_free(varnamebuf);
3760 len += 10; /* some additional space */
3761 varnamebuf = alloc(len);
3762 if (varnamebuf == NULL)
3764 varnamebuflen = 0;
3765 return NULL;
3767 varnamebuflen = len;
3769 *varnamebuf = prefix;
3770 varnamebuf[1] = ':';
3771 STRCPY(varnamebuf + 2, name);
3772 return varnamebuf;
3776 * Function given to ExpandGeneric() to obtain the list of user defined
3777 * (global/buffer/window/built-in) variable names.
3779 char_u *
3780 get_user_var_name(xp, idx)
3781 expand_T *xp;
3782 int idx;
3784 static long_u gdone;
3785 static long_u bdone;
3786 static long_u wdone;
3787 #ifdef FEAT_WINDOWS
3788 static long_u tdone;
3789 #endif
3790 static int vidx;
3791 static hashitem_T *hi;
3792 hashtab_T *ht;
3794 if (idx == 0)
3796 gdone = bdone = wdone = vidx = 0;
3797 #ifdef FEAT_WINDOWS
3798 tdone = 0;
3799 #endif
3802 /* Global variables */
3803 if (gdone < globvarht.ht_used)
3805 if (gdone++ == 0)
3806 hi = globvarht.ht_array;
3807 else
3808 ++hi;
3809 while (HASHITEM_EMPTY(hi))
3810 ++hi;
3811 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3812 return cat_prefix_varname('g', hi->hi_key);
3813 return hi->hi_key;
3816 /* b: variables */
3817 ht = &curbuf->b_vars.dv_hashtab;
3818 if (bdone < ht->ht_used)
3820 if (bdone++ == 0)
3821 hi = ht->ht_array;
3822 else
3823 ++hi;
3824 while (HASHITEM_EMPTY(hi))
3825 ++hi;
3826 return cat_prefix_varname('b', hi->hi_key);
3828 if (bdone == ht->ht_used)
3830 ++bdone;
3831 return (char_u *)"b:changedtick";
3834 /* w: variables */
3835 ht = &curwin->w_vars.dv_hashtab;
3836 if (wdone < ht->ht_used)
3838 if (wdone++ == 0)
3839 hi = ht->ht_array;
3840 else
3841 ++hi;
3842 while (HASHITEM_EMPTY(hi))
3843 ++hi;
3844 return cat_prefix_varname('w', hi->hi_key);
3847 #ifdef FEAT_WINDOWS
3848 /* t: variables */
3849 ht = &curtab->tp_vars.dv_hashtab;
3850 if (tdone < ht->ht_used)
3852 if (tdone++ == 0)
3853 hi = ht->ht_array;
3854 else
3855 ++hi;
3856 while (HASHITEM_EMPTY(hi))
3857 ++hi;
3858 return cat_prefix_varname('t', hi->hi_key);
3860 #endif
3862 /* v: variables */
3863 if (vidx < VV_LEN)
3864 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3866 vim_free(varnamebuf);
3867 varnamebuf = NULL;
3868 varnamebuflen = 0;
3869 return NULL;
3872 #endif /* FEAT_CMDL_COMPL */
3875 * types for expressions.
3877 typedef enum
3879 TYPE_UNKNOWN = 0
3880 , TYPE_EQUAL /* == */
3881 , TYPE_NEQUAL /* != */
3882 , TYPE_GREATER /* > */
3883 , TYPE_GEQUAL /* >= */
3884 , TYPE_SMALLER /* < */
3885 , TYPE_SEQUAL /* <= */
3886 , TYPE_MATCH /* =~ */
3887 , TYPE_NOMATCH /* !~ */
3888 } exptype_T;
3891 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3892 * executed. The function may return OK, but the rettv will be of type
3893 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3897 * Handle zero level expression.
3898 * This calls eval1() and handles error message and nextcmd.
3899 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3900 * Note: "rettv.v_lock" is not set.
3901 * Return OK or FAIL.
3903 static int
3904 eval0(arg, rettv, nextcmd, evaluate)
3905 char_u *arg;
3906 typval_T *rettv;
3907 char_u **nextcmd;
3908 int evaluate;
3910 int ret;
3911 char_u *p;
3913 p = skipwhite(arg);
3914 ret = eval1(&p, rettv, evaluate);
3915 if (ret == FAIL || !ends_excmd(*p))
3917 if (ret != FAIL)
3918 clear_tv(rettv);
3920 * Report the invalid expression unless the expression evaluation has
3921 * been cancelled due to an aborting error, an interrupt, or an
3922 * exception.
3924 if (!aborting())
3925 EMSG2(_(e_invexpr2), arg);
3926 ret = FAIL;
3928 if (nextcmd != NULL)
3929 *nextcmd = check_nextcmd(p);
3931 return ret;
3935 * Handle top level expression:
3936 * expr2 ? expr1 : expr1
3938 * "arg" must point to the first non-white of the expression.
3939 * "arg" is advanced to the next non-white after the recognized expression.
3941 * Note: "rettv.v_lock" is not set.
3943 * Return OK or FAIL.
3945 static int
3946 eval1(arg, rettv, evaluate)
3947 char_u **arg;
3948 typval_T *rettv;
3949 int evaluate;
3951 int result;
3952 typval_T var2;
3955 * Get the first variable.
3957 if (eval2(arg, rettv, evaluate) == FAIL)
3958 return FAIL;
3960 if ((*arg)[0] == '?')
3962 result = FALSE;
3963 if (evaluate)
3965 int error = FALSE;
3967 if (get_tv_number_chk(rettv, &error) != 0)
3968 result = TRUE;
3969 clear_tv(rettv);
3970 if (error)
3971 return FAIL;
3975 * Get the second variable.
3977 *arg = skipwhite(*arg + 1);
3978 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3979 return FAIL;
3982 * Check for the ":".
3984 if ((*arg)[0] != ':')
3986 EMSG(_("E109: Missing ':' after '?'"));
3987 if (evaluate && result)
3988 clear_tv(rettv);
3989 return FAIL;
3993 * Get the third variable.
3995 *arg = skipwhite(*arg + 1);
3996 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
3998 if (evaluate && result)
3999 clear_tv(rettv);
4000 return FAIL;
4002 if (evaluate && !result)
4003 *rettv = var2;
4006 return OK;
4010 * Handle first level expression:
4011 * expr2 || expr2 || expr2 logical OR
4013 * "arg" must point to the first non-white of the expression.
4014 * "arg" is advanced to the next non-white after the recognized expression.
4016 * Return OK or FAIL.
4018 static int
4019 eval2(arg, rettv, evaluate)
4020 char_u **arg;
4021 typval_T *rettv;
4022 int evaluate;
4024 typval_T var2;
4025 long result;
4026 int first;
4027 int error = FALSE;
4030 * Get the first variable.
4032 if (eval3(arg, rettv, evaluate) == FAIL)
4033 return FAIL;
4036 * Repeat until there is no following "||".
4038 first = TRUE;
4039 result = FALSE;
4040 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4042 if (evaluate && first)
4044 if (get_tv_number_chk(rettv, &error) != 0)
4045 result = TRUE;
4046 clear_tv(rettv);
4047 if (error)
4048 return FAIL;
4049 first = FALSE;
4053 * Get the second variable.
4055 *arg = skipwhite(*arg + 2);
4056 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4057 return FAIL;
4060 * Compute the result.
4062 if (evaluate && !result)
4064 if (get_tv_number_chk(&var2, &error) != 0)
4065 result = TRUE;
4066 clear_tv(&var2);
4067 if (error)
4068 return FAIL;
4070 if (evaluate)
4072 rettv->v_type = VAR_NUMBER;
4073 rettv->vval.v_number = result;
4077 return OK;
4081 * Handle second level expression:
4082 * expr3 && expr3 && expr3 logical AND
4084 * "arg" must point to the first non-white of the expression.
4085 * "arg" is advanced to the next non-white after the recognized expression.
4087 * Return OK or FAIL.
4089 static int
4090 eval3(arg, rettv, evaluate)
4091 char_u **arg;
4092 typval_T *rettv;
4093 int evaluate;
4095 typval_T var2;
4096 long result;
4097 int first;
4098 int error = FALSE;
4101 * Get the first variable.
4103 if (eval4(arg, rettv, evaluate) == FAIL)
4104 return FAIL;
4107 * Repeat until there is no following "&&".
4109 first = TRUE;
4110 result = TRUE;
4111 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4113 if (evaluate && first)
4115 if (get_tv_number_chk(rettv, &error) == 0)
4116 result = FALSE;
4117 clear_tv(rettv);
4118 if (error)
4119 return FAIL;
4120 first = FALSE;
4124 * Get the second variable.
4126 *arg = skipwhite(*arg + 2);
4127 if (eval4(arg, &var2, evaluate && result) == FAIL)
4128 return FAIL;
4131 * Compute the result.
4133 if (evaluate && result)
4135 if (get_tv_number_chk(&var2, &error) == 0)
4136 result = FALSE;
4137 clear_tv(&var2);
4138 if (error)
4139 return FAIL;
4141 if (evaluate)
4143 rettv->v_type = VAR_NUMBER;
4144 rettv->vval.v_number = result;
4148 return OK;
4152 * Handle third level expression:
4153 * var1 == var2
4154 * var1 =~ var2
4155 * var1 != var2
4156 * var1 !~ var2
4157 * var1 > var2
4158 * var1 >= var2
4159 * var1 < var2
4160 * var1 <= var2
4161 * var1 is var2
4162 * var1 isnot var2
4164 * "arg" must point to the first non-white of the expression.
4165 * "arg" is advanced to the next non-white after the recognized expression.
4167 * Return OK or FAIL.
4169 static int
4170 eval4(arg, rettv, evaluate)
4171 char_u **arg;
4172 typval_T *rettv;
4173 int evaluate;
4175 typval_T var2;
4176 char_u *p;
4177 int i;
4178 exptype_T type = TYPE_UNKNOWN;
4179 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4180 int len = 2;
4181 long n1, n2;
4182 char_u *s1, *s2;
4183 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4184 regmatch_T regmatch;
4185 int ic;
4186 char_u *save_cpo;
4189 * Get the first variable.
4191 if (eval5(arg, rettv, evaluate) == FAIL)
4192 return FAIL;
4194 p = *arg;
4195 switch (p[0])
4197 case '=': if (p[1] == '=')
4198 type = TYPE_EQUAL;
4199 else if (p[1] == '~')
4200 type = TYPE_MATCH;
4201 break;
4202 case '!': if (p[1] == '=')
4203 type = TYPE_NEQUAL;
4204 else if (p[1] == '~')
4205 type = TYPE_NOMATCH;
4206 break;
4207 case '>': if (p[1] != '=')
4209 type = TYPE_GREATER;
4210 len = 1;
4212 else
4213 type = TYPE_GEQUAL;
4214 break;
4215 case '<': if (p[1] != '=')
4217 type = TYPE_SMALLER;
4218 len = 1;
4220 else
4221 type = TYPE_SEQUAL;
4222 break;
4223 case 'i': if (p[1] == 's')
4225 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4226 len = 5;
4227 if (!vim_isIDc(p[len]))
4229 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4230 type_is = TRUE;
4233 break;
4237 * If there is a comparative operator, use it.
4239 if (type != TYPE_UNKNOWN)
4241 /* extra question mark appended: ignore case */
4242 if (p[len] == '?')
4244 ic = TRUE;
4245 ++len;
4247 /* extra '#' appended: match case */
4248 else if (p[len] == '#')
4250 ic = FALSE;
4251 ++len;
4253 /* nothing appended: use 'ignorecase' */
4254 else
4255 ic = p_ic;
4258 * Get the second variable.
4260 *arg = skipwhite(p + len);
4261 if (eval5(arg, &var2, evaluate) == FAIL)
4263 clear_tv(rettv);
4264 return FAIL;
4267 if (evaluate)
4269 if (type_is && rettv->v_type != var2.v_type)
4271 /* For "is" a different type always means FALSE, for "notis"
4272 * it means TRUE. */
4273 n1 = (type == TYPE_NEQUAL);
4275 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4277 if (type_is)
4279 n1 = (rettv->v_type == var2.v_type
4280 && rettv->vval.v_list == var2.vval.v_list);
4281 if (type == TYPE_NEQUAL)
4282 n1 = !n1;
4284 else if (rettv->v_type != var2.v_type
4285 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4287 if (rettv->v_type != var2.v_type)
4288 EMSG(_("E691: Can only compare List with List"));
4289 else
4290 EMSG(_("E692: Invalid operation for Lists"));
4291 clear_tv(rettv);
4292 clear_tv(&var2);
4293 return FAIL;
4295 else
4297 /* Compare two Lists for being equal or unequal. */
4298 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4299 if (type == TYPE_NEQUAL)
4300 n1 = !n1;
4304 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4306 if (type_is)
4308 n1 = (rettv->v_type == var2.v_type
4309 && rettv->vval.v_dict == var2.vval.v_dict);
4310 if (type == TYPE_NEQUAL)
4311 n1 = !n1;
4313 else if (rettv->v_type != var2.v_type
4314 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4316 if (rettv->v_type != var2.v_type)
4317 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4318 else
4319 EMSG(_("E736: Invalid operation for Dictionary"));
4320 clear_tv(rettv);
4321 clear_tv(&var2);
4322 return FAIL;
4324 else
4326 /* Compare two Dictionaries for being equal or unequal. */
4327 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4328 if (type == TYPE_NEQUAL)
4329 n1 = !n1;
4333 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4335 if (rettv->v_type != var2.v_type
4336 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4338 if (rettv->v_type != var2.v_type)
4339 EMSG(_("E693: Can only compare Funcref with Funcref"));
4340 else
4341 EMSG(_("E694: Invalid operation for Funcrefs"));
4342 clear_tv(rettv);
4343 clear_tv(&var2);
4344 return FAIL;
4346 else
4348 /* Compare two Funcrefs for being equal or unequal. */
4349 if (rettv->vval.v_string == NULL
4350 || var2.vval.v_string == NULL)
4351 n1 = FALSE;
4352 else
4353 n1 = STRCMP(rettv->vval.v_string,
4354 var2.vval.v_string) == 0;
4355 if (type == TYPE_NEQUAL)
4356 n1 = !n1;
4360 #ifdef FEAT_FLOAT
4362 * If one of the two variables is a float, compare as a float.
4363 * When using "=~" or "!~", always compare as string.
4365 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4366 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4368 float_T f1, f2;
4370 if (rettv->v_type == VAR_FLOAT)
4371 f1 = rettv->vval.v_float;
4372 else
4373 f1 = get_tv_number(rettv);
4374 if (var2.v_type == VAR_FLOAT)
4375 f2 = var2.vval.v_float;
4376 else
4377 f2 = get_tv_number(&var2);
4378 n1 = FALSE;
4379 switch (type)
4381 case TYPE_EQUAL: n1 = (f1 == f2); break;
4382 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4383 case TYPE_GREATER: n1 = (f1 > f2); break;
4384 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4385 case TYPE_SMALLER: n1 = (f1 < f2); break;
4386 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4387 case TYPE_UNKNOWN:
4388 case TYPE_MATCH:
4389 case TYPE_NOMATCH: break; /* avoid gcc warning */
4392 #endif
4395 * If one of the two variables is a number, compare as a number.
4396 * When using "=~" or "!~", always compare as string.
4398 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4399 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4401 n1 = get_tv_number(rettv);
4402 n2 = get_tv_number(&var2);
4403 switch (type)
4405 case TYPE_EQUAL: n1 = (n1 == n2); break;
4406 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4407 case TYPE_GREATER: n1 = (n1 > n2); break;
4408 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4409 case TYPE_SMALLER: n1 = (n1 < n2); break;
4410 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4411 case TYPE_UNKNOWN:
4412 case TYPE_MATCH:
4413 case TYPE_NOMATCH: break; /* avoid gcc warning */
4416 else
4418 s1 = get_tv_string_buf(rettv, buf1);
4419 s2 = get_tv_string_buf(&var2, buf2);
4420 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4421 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4422 else
4423 i = 0;
4424 n1 = FALSE;
4425 switch (type)
4427 case TYPE_EQUAL: n1 = (i == 0); break;
4428 case TYPE_NEQUAL: n1 = (i != 0); break;
4429 case TYPE_GREATER: n1 = (i > 0); break;
4430 case TYPE_GEQUAL: n1 = (i >= 0); break;
4431 case TYPE_SMALLER: n1 = (i < 0); break;
4432 case TYPE_SEQUAL: n1 = (i <= 0); break;
4434 case TYPE_MATCH:
4435 case TYPE_NOMATCH:
4436 /* avoid 'l' flag in 'cpoptions' */
4437 save_cpo = p_cpo;
4438 p_cpo = (char_u *)"";
4439 regmatch.regprog = vim_regcomp(s2,
4440 RE_MAGIC + RE_STRING);
4441 regmatch.rm_ic = ic;
4442 if (regmatch.regprog != NULL)
4444 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4445 vim_free(regmatch.regprog);
4446 if (type == TYPE_NOMATCH)
4447 n1 = !n1;
4449 p_cpo = save_cpo;
4450 break;
4452 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4455 clear_tv(rettv);
4456 clear_tv(&var2);
4457 rettv->v_type = VAR_NUMBER;
4458 rettv->vval.v_number = n1;
4462 return OK;
4466 * Handle fourth level expression:
4467 * + number addition
4468 * - number subtraction
4469 * . string concatenation
4471 * "arg" must point to the first non-white of the expression.
4472 * "arg" is advanced to the next non-white after the recognized expression.
4474 * Return OK or FAIL.
4476 static int
4477 eval5(arg, rettv, evaluate)
4478 char_u **arg;
4479 typval_T *rettv;
4480 int evaluate;
4482 typval_T var2;
4483 typval_T var3;
4484 int op;
4485 long n1, n2;
4486 #ifdef FEAT_FLOAT
4487 float_T f1 = 0, f2 = 0;
4488 #endif
4489 char_u *s1, *s2;
4490 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4491 char_u *p;
4494 * Get the first variable.
4496 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4497 return FAIL;
4500 * Repeat computing, until no '+', '-' or '.' is following.
4502 for (;;)
4504 op = **arg;
4505 if (op != '+' && op != '-' && op != '.')
4506 break;
4508 if ((op != '+' || rettv->v_type != VAR_LIST)
4509 #ifdef FEAT_FLOAT
4510 && (op == '.' || rettv->v_type != VAR_FLOAT)
4511 #endif
4514 /* For "list + ...", an illegal use of the first operand as
4515 * a number cannot be determined before evaluating the 2nd
4516 * operand: if this is also a list, all is ok.
4517 * For "something . ...", "something - ..." or "non-list + ...",
4518 * we know that the first operand needs to be a string or number
4519 * without evaluating the 2nd operand. So check before to avoid
4520 * side effects after an error. */
4521 if (evaluate && get_tv_string_chk(rettv) == NULL)
4523 clear_tv(rettv);
4524 return FAIL;
4529 * Get the second variable.
4531 *arg = skipwhite(*arg + 1);
4532 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4534 clear_tv(rettv);
4535 return FAIL;
4538 if (evaluate)
4541 * Compute the result.
4543 if (op == '.')
4545 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4546 s2 = get_tv_string_buf_chk(&var2, buf2);
4547 if (s2 == NULL) /* type error ? */
4549 clear_tv(rettv);
4550 clear_tv(&var2);
4551 return FAIL;
4553 p = concat_str(s1, s2);
4554 clear_tv(rettv);
4555 rettv->v_type = VAR_STRING;
4556 rettv->vval.v_string = p;
4558 else if (op == '+' && rettv->v_type == VAR_LIST
4559 && var2.v_type == VAR_LIST)
4561 /* concatenate Lists */
4562 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4563 &var3) == FAIL)
4565 clear_tv(rettv);
4566 clear_tv(&var2);
4567 return FAIL;
4569 clear_tv(rettv);
4570 *rettv = var3;
4572 else
4574 int error = FALSE;
4576 #ifdef FEAT_FLOAT
4577 if (rettv->v_type == VAR_FLOAT)
4579 f1 = rettv->vval.v_float;
4580 n1 = 0;
4582 else
4583 #endif
4585 n1 = get_tv_number_chk(rettv, &error);
4586 if (error)
4588 /* This can only happen for "list + non-list". For
4589 * "non-list + ..." or "something - ...", we returned
4590 * before evaluating the 2nd operand. */
4591 clear_tv(rettv);
4592 return FAIL;
4594 #ifdef FEAT_FLOAT
4595 if (var2.v_type == VAR_FLOAT)
4596 f1 = n1;
4597 #endif
4599 #ifdef FEAT_FLOAT
4600 if (var2.v_type == VAR_FLOAT)
4602 f2 = var2.vval.v_float;
4603 n2 = 0;
4605 else
4606 #endif
4608 n2 = get_tv_number_chk(&var2, &error);
4609 if (error)
4611 clear_tv(rettv);
4612 clear_tv(&var2);
4613 return FAIL;
4615 #ifdef FEAT_FLOAT
4616 if (rettv->v_type == VAR_FLOAT)
4617 f2 = n2;
4618 #endif
4620 clear_tv(rettv);
4622 #ifdef FEAT_FLOAT
4623 /* If there is a float on either side the result is a float. */
4624 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4626 if (op == '+')
4627 f1 = f1 + f2;
4628 else
4629 f1 = f1 - f2;
4630 rettv->v_type = VAR_FLOAT;
4631 rettv->vval.v_float = f1;
4633 else
4634 #endif
4636 if (op == '+')
4637 n1 = n1 + n2;
4638 else
4639 n1 = n1 - n2;
4640 rettv->v_type = VAR_NUMBER;
4641 rettv->vval.v_number = n1;
4644 clear_tv(&var2);
4647 return OK;
4651 * Handle fifth level expression:
4652 * * number multiplication
4653 * / number division
4654 * % number modulo
4656 * "arg" must point to the first non-white of the expression.
4657 * "arg" is advanced to the next non-white after the recognized expression.
4659 * Return OK or FAIL.
4661 static int
4662 eval6(arg, rettv, evaluate, want_string)
4663 char_u **arg;
4664 typval_T *rettv;
4665 int evaluate;
4666 int want_string; /* after "." operator */
4668 typval_T var2;
4669 int op;
4670 long n1, n2;
4671 #ifdef FEAT_FLOAT
4672 int use_float = FALSE;
4673 float_T f1 = 0, f2;
4674 #endif
4675 int error = FALSE;
4678 * Get the first variable.
4680 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4681 return FAIL;
4684 * Repeat computing, until no '*', '/' or '%' is following.
4686 for (;;)
4688 op = **arg;
4689 if (op != '*' && op != '/' && op != '%')
4690 break;
4692 if (evaluate)
4694 #ifdef FEAT_FLOAT
4695 if (rettv->v_type == VAR_FLOAT)
4697 f1 = rettv->vval.v_float;
4698 use_float = TRUE;
4699 n1 = 0;
4701 else
4702 #endif
4703 n1 = get_tv_number_chk(rettv, &error);
4704 clear_tv(rettv);
4705 if (error)
4706 return FAIL;
4708 else
4709 n1 = 0;
4712 * Get the second variable.
4714 *arg = skipwhite(*arg + 1);
4715 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4716 return FAIL;
4718 if (evaluate)
4720 #ifdef FEAT_FLOAT
4721 if (var2.v_type == VAR_FLOAT)
4723 if (!use_float)
4725 f1 = n1;
4726 use_float = TRUE;
4728 f2 = var2.vval.v_float;
4729 n2 = 0;
4731 else
4732 #endif
4734 n2 = get_tv_number_chk(&var2, &error);
4735 clear_tv(&var2);
4736 if (error)
4737 return FAIL;
4738 #ifdef FEAT_FLOAT
4739 if (use_float)
4740 f2 = n2;
4741 #endif
4745 * Compute the result.
4746 * When either side is a float the result is a float.
4748 #ifdef FEAT_FLOAT
4749 if (use_float)
4751 if (op == '*')
4752 f1 = f1 * f2;
4753 else if (op == '/')
4755 /* We rely on the floating point library to handle divide
4756 * by zero to result in "inf" and not a crash. */
4757 f1 = f1 / f2;
4759 else
4761 EMSG(_("E804: Cannot use '%' with Float"));
4762 return FAIL;
4764 rettv->v_type = VAR_FLOAT;
4765 rettv->vval.v_float = f1;
4767 else
4768 #endif
4770 if (op == '*')
4771 n1 = n1 * n2;
4772 else if (op == '/')
4774 if (n2 == 0) /* give an error message? */
4776 if (n1 == 0)
4777 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4778 else if (n1 < 0)
4779 n1 = -0x7fffffffL;
4780 else
4781 n1 = 0x7fffffffL;
4783 else
4784 n1 = n1 / n2;
4786 else
4788 if (n2 == 0) /* give an error message? */
4789 n1 = 0;
4790 else
4791 n1 = n1 % n2;
4793 rettv->v_type = VAR_NUMBER;
4794 rettv->vval.v_number = n1;
4799 return OK;
4803 * Handle sixth level expression:
4804 * number number constant
4805 * "string" string constant
4806 * 'string' literal string constant
4807 * &option-name option value
4808 * @r register contents
4809 * identifier variable value
4810 * function() function call
4811 * $VAR environment variable
4812 * (expression) nested expression
4813 * [expr, expr] List
4814 * {key: val, key: val} Dictionary
4816 * Also handle:
4817 * ! in front logical NOT
4818 * - in front unary minus
4819 * + in front unary plus (ignored)
4820 * trailing [] subscript in String or List
4821 * trailing .name entry in Dictionary
4823 * "arg" must point to the first non-white of the expression.
4824 * "arg" is advanced to the next non-white after the recognized expression.
4826 * Return OK or FAIL.
4828 static int
4829 eval7(arg, rettv, evaluate, want_string)
4830 char_u **arg;
4831 typval_T *rettv;
4832 int evaluate;
4833 int want_string; /* after "." operator */
4835 long n;
4836 int len;
4837 char_u *s;
4838 char_u *start_leader, *end_leader;
4839 int ret = OK;
4840 char_u *alias;
4843 * Initialise variable so that clear_tv() can't mistake this for a
4844 * string and free a string that isn't there.
4846 rettv->v_type = VAR_UNKNOWN;
4849 * Skip '!' and '-' characters. They are handled later.
4851 start_leader = *arg;
4852 while (**arg == '!' || **arg == '-' || **arg == '+')
4853 *arg = skipwhite(*arg + 1);
4854 end_leader = *arg;
4856 switch (**arg)
4859 * Number constant.
4861 case '0':
4862 case '1':
4863 case '2':
4864 case '3':
4865 case '4':
4866 case '5':
4867 case '6':
4868 case '7':
4869 case '8':
4870 case '9':
4872 #ifdef FEAT_FLOAT
4873 char_u *p = skipdigits(*arg + 1);
4874 int get_float = FALSE;
4876 /* We accept a float when the format matches
4877 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4878 * strict to avoid backwards compatibility problems.
4879 * Don't look for a float after the "." operator, so that
4880 * ":let vers = 1.2.3" doesn't fail. */
4881 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4883 get_float = TRUE;
4884 p = skipdigits(p + 2);
4885 if (*p == 'e' || *p == 'E')
4887 ++p;
4888 if (*p == '-' || *p == '+')
4889 ++p;
4890 if (!vim_isdigit(*p))
4891 get_float = FALSE;
4892 else
4893 p = skipdigits(p + 1);
4895 if (ASCII_ISALPHA(*p) || *p == '.')
4896 get_float = FALSE;
4898 if (get_float)
4900 float_T f;
4902 *arg += string2float(*arg, &f);
4903 if (evaluate)
4905 rettv->v_type = VAR_FLOAT;
4906 rettv->vval.v_float = f;
4909 else
4910 #endif
4912 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4913 *arg += len;
4914 if (evaluate)
4916 rettv->v_type = VAR_NUMBER;
4917 rettv->vval.v_number = n;
4920 break;
4924 * String constant: "string".
4926 case '"': ret = get_string_tv(arg, rettv, evaluate);
4927 break;
4930 * Literal string constant: 'str''ing'.
4932 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4933 break;
4936 * List: [expr, expr]
4938 case '[': ret = get_list_tv(arg, rettv, evaluate);
4939 break;
4942 * Dictionary: {key: val, key: val}
4944 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4945 break;
4948 * Option value: &name
4950 case '&': ret = get_option_tv(arg, rettv, evaluate);
4951 break;
4954 * Environment variable: $VAR.
4956 case '$': ret = get_env_tv(arg, rettv, evaluate);
4957 break;
4960 * Register contents: @r.
4962 case '@': ++*arg;
4963 if (evaluate)
4965 rettv->v_type = VAR_STRING;
4966 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4968 if (**arg != NUL)
4969 ++*arg;
4970 break;
4973 * nested expression: (expression).
4975 case '(': *arg = skipwhite(*arg + 1);
4976 ret = eval1(arg, rettv, evaluate); /* recursive! */
4977 if (**arg == ')')
4978 ++*arg;
4979 else if (ret == OK)
4981 EMSG(_("E110: Missing ')'"));
4982 clear_tv(rettv);
4983 ret = FAIL;
4985 break;
4987 default: ret = NOTDONE;
4988 break;
4991 if (ret == NOTDONE)
4994 * Must be a variable or function name.
4995 * Can also be a curly-braces kind of name: {expr}.
4997 s = *arg;
4998 len = get_name_len(arg, &alias, evaluate, TRUE);
4999 if (alias != NULL)
5000 s = alias;
5002 if (len <= 0)
5003 ret = FAIL;
5004 else
5006 if (**arg == '(') /* recursive! */
5008 /* If "s" is the name of a variable of type VAR_FUNC
5009 * use its contents. */
5010 s = deref_func_name(s, &len);
5012 /* Invoke the function. */
5013 ret = get_func_tv(s, len, rettv, arg,
5014 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5015 &len, evaluate, NULL);
5016 /* Stop the expression evaluation when immediately
5017 * aborting on error, or when an interrupt occurred or
5018 * an exception was thrown but not caught. */
5019 if (aborting())
5021 if (ret == OK)
5022 clear_tv(rettv);
5023 ret = FAIL;
5026 else if (evaluate)
5027 ret = get_var_tv(s, len, rettv, TRUE);
5028 else
5029 ret = OK;
5032 if (alias != NULL)
5033 vim_free(alias);
5036 *arg = skipwhite(*arg);
5038 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5039 * expr(expr). */
5040 if (ret == OK)
5041 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5044 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5046 if (ret == OK && evaluate && end_leader > start_leader)
5048 int error = FALSE;
5049 int val = 0;
5050 #ifdef FEAT_FLOAT
5051 float_T f = 0.0;
5053 if (rettv->v_type == VAR_FLOAT)
5054 f = rettv->vval.v_float;
5055 else
5056 #endif
5057 val = get_tv_number_chk(rettv, &error);
5058 if (error)
5060 clear_tv(rettv);
5061 ret = FAIL;
5063 else
5065 while (end_leader > start_leader)
5067 --end_leader;
5068 if (*end_leader == '!')
5070 #ifdef FEAT_FLOAT
5071 if (rettv->v_type == VAR_FLOAT)
5072 f = !f;
5073 else
5074 #endif
5075 val = !val;
5077 else if (*end_leader == '-')
5079 #ifdef FEAT_FLOAT
5080 if (rettv->v_type == VAR_FLOAT)
5081 f = -f;
5082 else
5083 #endif
5084 val = -val;
5087 #ifdef FEAT_FLOAT
5088 if (rettv->v_type == VAR_FLOAT)
5090 clear_tv(rettv);
5091 rettv->vval.v_float = f;
5093 else
5094 #endif
5096 clear_tv(rettv);
5097 rettv->v_type = VAR_NUMBER;
5098 rettv->vval.v_number = val;
5103 return ret;
5107 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5108 * "*arg" points to the '[' or '.'.
5109 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5111 static int
5112 eval_index(arg, rettv, evaluate, verbose)
5113 char_u **arg;
5114 typval_T *rettv;
5115 int evaluate;
5116 int verbose; /* give error messages */
5118 int empty1 = FALSE, empty2 = FALSE;
5119 typval_T var1, var2;
5120 long n1, n2 = 0;
5121 long len = -1;
5122 int range = FALSE;
5123 char_u *s;
5124 char_u *key = NULL;
5126 if (rettv->v_type == VAR_FUNC
5127 #ifdef FEAT_FLOAT
5128 || rettv->v_type == VAR_FLOAT
5129 #endif
5132 if (verbose)
5133 EMSG(_("E695: Cannot index a Funcref"));
5134 return FAIL;
5137 if (**arg == '.')
5140 * dict.name
5142 key = *arg + 1;
5143 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5145 if (len == 0)
5146 return FAIL;
5147 *arg = skipwhite(key + len);
5149 else
5152 * something[idx]
5154 * Get the (first) variable from inside the [].
5156 *arg = skipwhite(*arg + 1);
5157 if (**arg == ':')
5158 empty1 = TRUE;
5159 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5160 return FAIL;
5161 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5163 /* not a number or string */
5164 clear_tv(&var1);
5165 return FAIL;
5169 * Get the second variable from inside the [:].
5171 if (**arg == ':')
5173 range = TRUE;
5174 *arg = skipwhite(*arg + 1);
5175 if (**arg == ']')
5176 empty2 = TRUE;
5177 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5179 if (!empty1)
5180 clear_tv(&var1);
5181 return FAIL;
5183 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5185 /* not a number or string */
5186 if (!empty1)
5187 clear_tv(&var1);
5188 clear_tv(&var2);
5189 return FAIL;
5193 /* Check for the ']'. */
5194 if (**arg != ']')
5196 if (verbose)
5197 EMSG(_(e_missbrac));
5198 clear_tv(&var1);
5199 if (range)
5200 clear_tv(&var2);
5201 return FAIL;
5203 *arg = skipwhite(*arg + 1); /* skip the ']' */
5206 if (evaluate)
5208 n1 = 0;
5209 if (!empty1 && rettv->v_type != VAR_DICT)
5211 n1 = get_tv_number(&var1);
5212 clear_tv(&var1);
5214 if (range)
5216 if (empty2)
5217 n2 = -1;
5218 else
5220 n2 = get_tv_number(&var2);
5221 clear_tv(&var2);
5225 switch (rettv->v_type)
5227 case VAR_NUMBER:
5228 case VAR_STRING:
5229 s = get_tv_string(rettv);
5230 len = (long)STRLEN(s);
5231 if (range)
5233 /* The resulting variable is a substring. If the indexes
5234 * are out of range the result is empty. */
5235 if (n1 < 0)
5237 n1 = len + n1;
5238 if (n1 < 0)
5239 n1 = 0;
5241 if (n2 < 0)
5242 n2 = len + n2;
5243 else if (n2 >= len)
5244 n2 = len;
5245 if (n1 >= len || n2 < 0 || n1 > n2)
5246 s = NULL;
5247 else
5248 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5250 else
5252 /* The resulting variable is a string of a single
5253 * character. If the index is too big or negative the
5254 * result is empty. */
5255 if (n1 >= len || n1 < 0)
5256 s = NULL;
5257 else
5258 s = vim_strnsave(s + n1, 1);
5260 clear_tv(rettv);
5261 rettv->v_type = VAR_STRING;
5262 rettv->vval.v_string = s;
5263 break;
5265 case VAR_LIST:
5266 len = list_len(rettv->vval.v_list);
5267 if (n1 < 0)
5268 n1 = len + n1;
5269 if (!empty1 && (n1 < 0 || n1 >= len))
5271 /* For a range we allow invalid values and return an empty
5272 * list. A list index out of range is an error. */
5273 if (!range)
5275 if (verbose)
5276 EMSGN(_(e_listidx), n1);
5277 return FAIL;
5279 n1 = len;
5281 if (range)
5283 list_T *l;
5284 listitem_T *item;
5286 if (n2 < 0)
5287 n2 = len + n2;
5288 else if (n2 >= len)
5289 n2 = len - 1;
5290 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5291 n2 = -1;
5292 l = list_alloc();
5293 if (l == NULL)
5294 return FAIL;
5295 for (item = list_find(rettv->vval.v_list, n1);
5296 n1 <= n2; ++n1)
5298 if (list_append_tv(l, &item->li_tv) == FAIL)
5300 list_free(l, TRUE);
5301 return FAIL;
5303 item = item->li_next;
5305 clear_tv(rettv);
5306 rettv->v_type = VAR_LIST;
5307 rettv->vval.v_list = l;
5308 ++l->lv_refcount;
5310 else
5312 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5313 clear_tv(rettv);
5314 *rettv = var1;
5316 break;
5318 case VAR_DICT:
5319 if (range)
5321 if (verbose)
5322 EMSG(_(e_dictrange));
5323 if (len == -1)
5324 clear_tv(&var1);
5325 return FAIL;
5328 dictitem_T *item;
5330 if (len == -1)
5332 key = get_tv_string(&var1);
5333 if (*key == NUL)
5335 if (verbose)
5336 EMSG(_(e_emptykey));
5337 clear_tv(&var1);
5338 return FAIL;
5342 item = dict_find(rettv->vval.v_dict, key, (int)len);
5344 if (item == NULL && verbose)
5345 EMSG2(_(e_dictkey), key);
5346 if (len == -1)
5347 clear_tv(&var1);
5348 if (item == NULL)
5349 return FAIL;
5351 copy_tv(&item->di_tv, &var1);
5352 clear_tv(rettv);
5353 *rettv = var1;
5355 break;
5359 return OK;
5363 * Get an option value.
5364 * "arg" points to the '&' or '+' before the option name.
5365 * "arg" is advanced to character after the option name.
5366 * Return OK or FAIL.
5368 static int
5369 get_option_tv(arg, rettv, evaluate)
5370 char_u **arg;
5371 typval_T *rettv; /* when NULL, only check if option exists */
5372 int evaluate;
5374 char_u *option_end;
5375 long numval;
5376 char_u *stringval;
5377 int opt_type;
5378 int c;
5379 int working = (**arg == '+'); /* has("+option") */
5380 int ret = OK;
5381 int opt_flags;
5384 * Isolate the option name and find its value.
5386 option_end = find_option_end(arg, &opt_flags);
5387 if (option_end == NULL)
5389 if (rettv != NULL)
5390 EMSG2(_("E112: Option name missing: %s"), *arg);
5391 return FAIL;
5394 if (!evaluate)
5396 *arg = option_end;
5397 return OK;
5400 c = *option_end;
5401 *option_end = NUL;
5402 opt_type = get_option_value(*arg, &numval,
5403 rettv == NULL ? NULL : &stringval, opt_flags);
5405 if (opt_type == -3) /* invalid name */
5407 if (rettv != NULL)
5408 EMSG2(_("E113: Unknown option: %s"), *arg);
5409 ret = FAIL;
5411 else if (rettv != NULL)
5413 if (opt_type == -2) /* hidden string option */
5415 rettv->v_type = VAR_STRING;
5416 rettv->vval.v_string = NULL;
5418 else if (opt_type == -1) /* hidden number option */
5420 rettv->v_type = VAR_NUMBER;
5421 rettv->vval.v_number = 0;
5423 else if (opt_type == 1) /* number option */
5425 rettv->v_type = VAR_NUMBER;
5426 rettv->vval.v_number = numval;
5428 else /* string option */
5430 rettv->v_type = VAR_STRING;
5431 rettv->vval.v_string = stringval;
5434 else if (working && (opt_type == -2 || opt_type == -1))
5435 ret = FAIL;
5437 *option_end = c; /* put back for error messages */
5438 *arg = option_end;
5440 return ret;
5444 * Allocate a variable for a string constant.
5445 * Return OK or FAIL.
5447 static int
5448 get_string_tv(arg, rettv, evaluate)
5449 char_u **arg;
5450 typval_T *rettv;
5451 int evaluate;
5453 char_u *p;
5454 char_u *name;
5455 int extra = 0;
5458 * Find the end of the string, skipping backslashed characters.
5460 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5462 if (*p == '\\' && p[1] != NUL)
5464 ++p;
5465 /* A "\<x>" form occupies at least 4 characters, and produces up
5466 * to 6 characters: reserve space for 2 extra */
5467 if (*p == '<')
5468 extra += 2;
5472 if (*p != '"')
5474 EMSG2(_("E114: Missing quote: %s"), *arg);
5475 return FAIL;
5478 /* If only parsing, set *arg and return here */
5479 if (!evaluate)
5481 *arg = p + 1;
5482 return OK;
5486 * Copy the string into allocated memory, handling backslashed
5487 * characters.
5489 name = alloc((unsigned)(p - *arg + extra));
5490 if (name == NULL)
5491 return FAIL;
5492 rettv->v_type = VAR_STRING;
5493 rettv->vval.v_string = name;
5495 for (p = *arg + 1; *p != NUL && *p != '"'; )
5497 if (*p == '\\')
5499 switch (*++p)
5501 case 'b': *name++ = BS; ++p; break;
5502 case 'e': *name++ = ESC; ++p; break;
5503 case 'f': *name++ = FF; ++p; break;
5504 case 'n': *name++ = NL; ++p; break;
5505 case 'r': *name++ = CAR; ++p; break;
5506 case 't': *name++ = TAB; ++p; break;
5508 case 'X': /* hex: "\x1", "\x12" */
5509 case 'x':
5510 case 'u': /* Unicode: "\u0023" */
5511 case 'U':
5512 if (vim_isxdigit(p[1]))
5514 int n, nr;
5515 int c = toupper(*p);
5517 if (c == 'X')
5518 n = 2;
5519 else
5520 n = 4;
5521 nr = 0;
5522 while (--n >= 0 && vim_isxdigit(p[1]))
5524 ++p;
5525 nr = (nr << 4) + hex2nr(*p);
5527 ++p;
5528 #ifdef FEAT_MBYTE
5529 /* For "\u" store the number according to
5530 * 'encoding'. */
5531 if (c != 'X')
5532 name += (*mb_char2bytes)(nr, name);
5533 else
5534 #endif
5535 *name++ = nr;
5537 break;
5539 /* octal: "\1", "\12", "\123" */
5540 case '0':
5541 case '1':
5542 case '2':
5543 case '3':
5544 case '4':
5545 case '5':
5546 case '6':
5547 case '7': *name = *p++ - '0';
5548 if (*p >= '0' && *p <= '7')
5550 *name = (*name << 3) + *p++ - '0';
5551 if (*p >= '0' && *p <= '7')
5552 *name = (*name << 3) + *p++ - '0';
5554 ++name;
5555 break;
5557 /* Special key, e.g.: "\<C-W>" */
5558 case '<': extra = trans_special(&p, name, TRUE);
5559 if (extra != 0)
5561 name += extra;
5562 break;
5564 /* FALLTHROUGH */
5566 default: MB_COPY_CHAR(p, name);
5567 break;
5570 else
5571 MB_COPY_CHAR(p, name);
5574 *name = NUL;
5575 *arg = p + 1;
5577 return OK;
5581 * Allocate a variable for a 'str''ing' constant.
5582 * Return OK or FAIL.
5584 static int
5585 get_lit_string_tv(arg, rettv, evaluate)
5586 char_u **arg;
5587 typval_T *rettv;
5588 int evaluate;
5590 char_u *p;
5591 char_u *str;
5592 int reduce = 0;
5595 * Find the end of the string, skipping ''.
5597 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5599 if (*p == '\'')
5601 if (p[1] != '\'')
5602 break;
5603 ++reduce;
5604 ++p;
5608 if (*p != '\'')
5610 EMSG2(_("E115: Missing quote: %s"), *arg);
5611 return FAIL;
5614 /* If only parsing return after setting "*arg" */
5615 if (!evaluate)
5617 *arg = p + 1;
5618 return OK;
5622 * Copy the string into allocated memory, handling '' to ' reduction.
5624 str = alloc((unsigned)((p - *arg) - reduce));
5625 if (str == NULL)
5626 return FAIL;
5627 rettv->v_type = VAR_STRING;
5628 rettv->vval.v_string = str;
5630 for (p = *arg + 1; *p != NUL; )
5632 if (*p == '\'')
5634 if (p[1] != '\'')
5635 break;
5636 ++p;
5638 MB_COPY_CHAR(p, str);
5640 *str = NUL;
5641 *arg = p + 1;
5643 return OK;
5647 * Allocate a variable for a List and fill it from "*arg".
5648 * Return OK or FAIL.
5650 static int
5651 get_list_tv(arg, rettv, evaluate)
5652 char_u **arg;
5653 typval_T *rettv;
5654 int evaluate;
5656 list_T *l = NULL;
5657 typval_T tv;
5658 listitem_T *item;
5660 if (evaluate)
5662 l = list_alloc();
5663 if (l == NULL)
5664 return FAIL;
5667 *arg = skipwhite(*arg + 1);
5668 while (**arg != ']' && **arg != NUL)
5670 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5671 goto failret;
5672 if (evaluate)
5674 item = listitem_alloc();
5675 if (item != NULL)
5677 item->li_tv = tv;
5678 item->li_tv.v_lock = 0;
5679 list_append(l, item);
5681 else
5682 clear_tv(&tv);
5685 if (**arg == ']')
5686 break;
5687 if (**arg != ',')
5689 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5690 goto failret;
5692 *arg = skipwhite(*arg + 1);
5695 if (**arg != ']')
5697 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5698 failret:
5699 if (evaluate)
5700 list_free(l, TRUE);
5701 return FAIL;
5704 *arg = skipwhite(*arg + 1);
5705 if (evaluate)
5707 rettv->v_type = VAR_LIST;
5708 rettv->vval.v_list = l;
5709 ++l->lv_refcount;
5712 return OK;
5716 * Allocate an empty header for a list.
5717 * Caller should take care of the reference count.
5719 list_T *
5720 list_alloc()
5722 list_T *l;
5724 l = (list_T *)alloc_clear(sizeof(list_T));
5725 if (l != NULL)
5727 /* Prepend the list to the list of lists for garbage collection. */
5728 if (first_list != NULL)
5729 first_list->lv_used_prev = l;
5730 l->lv_used_prev = NULL;
5731 l->lv_used_next = first_list;
5732 first_list = l;
5734 return l;
5738 * Allocate an empty list for a return value.
5739 * Returns OK or FAIL.
5741 static int
5742 rettv_list_alloc(rettv)
5743 typval_T *rettv;
5745 list_T *l = list_alloc();
5747 if (l == NULL)
5748 return FAIL;
5750 rettv->vval.v_list = l;
5751 rettv->v_type = VAR_LIST;
5752 ++l->lv_refcount;
5753 return OK;
5757 * Unreference a list: decrement the reference count and free it when it
5758 * becomes zero.
5760 void
5761 list_unref(l)
5762 list_T *l;
5764 if (l != NULL && --l->lv_refcount <= 0)
5765 list_free(l, TRUE);
5769 * Free a list, including all items it points to.
5770 * Ignores the reference count.
5772 void
5773 list_free(l, recurse)
5774 list_T *l;
5775 int recurse; /* Free Lists and Dictionaries recursively. */
5777 listitem_T *item;
5779 /* Remove the list from the list of lists for garbage collection. */
5780 if (l->lv_used_prev == NULL)
5781 first_list = l->lv_used_next;
5782 else
5783 l->lv_used_prev->lv_used_next = l->lv_used_next;
5784 if (l->lv_used_next != NULL)
5785 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5787 for (item = l->lv_first; item != NULL; item = l->lv_first)
5789 /* Remove the item before deleting it. */
5790 l->lv_first = item->li_next;
5791 if (recurse || (item->li_tv.v_type != VAR_LIST
5792 && item->li_tv.v_type != VAR_DICT))
5793 clear_tv(&item->li_tv);
5794 vim_free(item);
5796 vim_free(l);
5800 * Allocate a list item.
5802 static listitem_T *
5803 listitem_alloc()
5805 return (listitem_T *)alloc(sizeof(listitem_T));
5809 * Free a list item. Also clears the value. Does not notify watchers.
5811 static void
5812 listitem_free(item)
5813 listitem_T *item;
5815 clear_tv(&item->li_tv);
5816 vim_free(item);
5820 * Remove a list item from a List and free it. Also clears the value.
5822 static void
5823 listitem_remove(l, item)
5824 list_T *l;
5825 listitem_T *item;
5827 list_remove(l, item, item);
5828 listitem_free(item);
5832 * Get the number of items in a list.
5834 static long
5835 list_len(l)
5836 list_T *l;
5838 if (l == NULL)
5839 return 0L;
5840 return l->lv_len;
5844 * Return TRUE when two lists have exactly the same values.
5846 static int
5847 list_equal(l1, l2, ic)
5848 list_T *l1;
5849 list_T *l2;
5850 int ic; /* ignore case for strings */
5852 listitem_T *item1, *item2;
5854 if (l1 == NULL || l2 == NULL)
5855 return FALSE;
5856 if (l1 == l2)
5857 return TRUE;
5858 if (list_len(l1) != list_len(l2))
5859 return FALSE;
5861 for (item1 = l1->lv_first, item2 = l2->lv_first;
5862 item1 != NULL && item2 != NULL;
5863 item1 = item1->li_next, item2 = item2->li_next)
5864 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5865 return FALSE;
5866 return item1 == NULL && item2 == NULL;
5869 #if defined(FEAT_PYTHON) || defined(FEAT_MZSCHEME) || defined(PROTO)
5871 * Return the dictitem that an entry in a hashtable points to.
5873 dictitem_T *
5874 dict_lookup(hi)
5875 hashitem_T *hi;
5877 return HI2DI(hi);
5879 #endif
5882 * Return TRUE when two dictionaries have exactly the same key/values.
5884 static int
5885 dict_equal(d1, d2, ic)
5886 dict_T *d1;
5887 dict_T *d2;
5888 int ic; /* ignore case for strings */
5890 hashitem_T *hi;
5891 dictitem_T *item2;
5892 int todo;
5894 if (d1 == NULL || d2 == NULL)
5895 return FALSE;
5896 if (d1 == d2)
5897 return TRUE;
5898 if (dict_len(d1) != dict_len(d2))
5899 return FALSE;
5901 todo = (int)d1->dv_hashtab.ht_used;
5902 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5904 if (!HASHITEM_EMPTY(hi))
5906 item2 = dict_find(d2, hi->hi_key, -1);
5907 if (item2 == NULL)
5908 return FALSE;
5909 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5910 return FALSE;
5911 --todo;
5914 return TRUE;
5918 * Return TRUE if "tv1" and "tv2" have the same value.
5919 * Compares the items just like "==" would compare them, but strings and
5920 * numbers are different. Floats and numbers are also different.
5922 static int
5923 tv_equal(tv1, tv2, ic)
5924 typval_T *tv1;
5925 typval_T *tv2;
5926 int ic; /* ignore case */
5928 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5929 char_u *s1, *s2;
5930 static int recursive = 0; /* cach recursive loops */
5931 int r;
5933 if (tv1->v_type != tv2->v_type)
5934 return FALSE;
5935 /* Catch lists and dicts that have an endless loop by limiting
5936 * recursiveness to 1000. We guess they are equal then. */
5937 if (recursive >= 1000)
5938 return TRUE;
5940 switch (tv1->v_type)
5942 case VAR_LIST:
5943 ++recursive;
5944 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5945 --recursive;
5946 return r;
5948 case VAR_DICT:
5949 ++recursive;
5950 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5951 --recursive;
5952 return r;
5954 case VAR_FUNC:
5955 return (tv1->vval.v_string != NULL
5956 && tv2->vval.v_string != NULL
5957 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5959 case VAR_NUMBER:
5960 return tv1->vval.v_number == tv2->vval.v_number;
5962 #ifdef FEAT_FLOAT
5963 case VAR_FLOAT:
5964 return tv1->vval.v_float == tv2->vval.v_float;
5965 #endif
5967 case VAR_STRING:
5968 s1 = get_tv_string_buf(tv1, buf1);
5969 s2 = get_tv_string_buf(tv2, buf2);
5970 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5973 EMSG2(_(e_intern2), "tv_equal()");
5974 return TRUE;
5978 * Locate item with index "n" in list "l" and return it.
5979 * A negative index is counted from the end; -1 is the last item.
5980 * Returns NULL when "n" is out of range.
5982 static listitem_T *
5983 list_find(l, n)
5984 list_T *l;
5985 long n;
5987 listitem_T *item;
5988 long idx;
5990 if (l == NULL)
5991 return NULL;
5993 /* Negative index is relative to the end. */
5994 if (n < 0)
5995 n = l->lv_len + n;
5997 /* Check for index out of range. */
5998 if (n < 0 || n >= l->lv_len)
5999 return NULL;
6001 /* When there is a cached index may start search from there. */
6002 if (l->lv_idx_item != NULL)
6004 if (n < l->lv_idx / 2)
6006 /* closest to the start of the list */
6007 item = l->lv_first;
6008 idx = 0;
6010 else if (n > (l->lv_idx + l->lv_len) / 2)
6012 /* closest to the end of the list */
6013 item = l->lv_last;
6014 idx = l->lv_len - 1;
6016 else
6018 /* closest to the cached index */
6019 item = l->lv_idx_item;
6020 idx = l->lv_idx;
6023 else
6025 if (n < l->lv_len / 2)
6027 /* closest to the start of the list */
6028 item = l->lv_first;
6029 idx = 0;
6031 else
6033 /* closest to the end of the list */
6034 item = l->lv_last;
6035 idx = l->lv_len - 1;
6039 while (n > idx)
6041 /* search forward */
6042 item = item->li_next;
6043 ++idx;
6045 while (n < idx)
6047 /* search backward */
6048 item = item->li_prev;
6049 --idx;
6052 /* cache the used index */
6053 l->lv_idx = idx;
6054 l->lv_idx_item = item;
6056 return item;
6060 * Get list item "l[idx]" as a number.
6062 static long
6063 list_find_nr(l, idx, errorp)
6064 list_T *l;
6065 long idx;
6066 int *errorp; /* set to TRUE when something wrong */
6068 listitem_T *li;
6070 li = list_find(l, idx);
6071 if (li == NULL)
6073 if (errorp != NULL)
6074 *errorp = TRUE;
6075 return -1L;
6077 return get_tv_number_chk(&li->li_tv, errorp);
6081 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6083 char_u *
6084 list_find_str(l, idx)
6085 list_T *l;
6086 long idx;
6088 listitem_T *li;
6090 li = list_find(l, idx - 1);
6091 if (li == NULL)
6093 EMSGN(_(e_listidx), idx);
6094 return NULL;
6096 return get_tv_string(&li->li_tv);
6100 * Locate "item" list "l" and return its index.
6101 * Returns -1 when "item" is not in the list.
6103 static long
6104 list_idx_of_item(l, item)
6105 list_T *l;
6106 listitem_T *item;
6108 long idx = 0;
6109 listitem_T *li;
6111 if (l == NULL)
6112 return -1;
6113 idx = 0;
6114 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6115 ++idx;
6116 if (li == NULL)
6117 return -1;
6118 return idx;
6122 * Append item "item" to the end of list "l".
6124 static void
6125 list_append(l, item)
6126 list_T *l;
6127 listitem_T *item;
6129 if (l->lv_last == NULL)
6131 /* empty list */
6132 l->lv_first = item;
6133 l->lv_last = item;
6134 item->li_prev = NULL;
6136 else
6138 l->lv_last->li_next = item;
6139 item->li_prev = l->lv_last;
6140 l->lv_last = item;
6142 ++l->lv_len;
6143 item->li_next = NULL;
6147 * Append typval_T "tv" to the end of list "l".
6148 * Return FAIL when out of memory.
6150 static int
6151 list_append_tv(l, tv)
6152 list_T *l;
6153 typval_T *tv;
6155 listitem_T *li = listitem_alloc();
6157 if (li == NULL)
6158 return FAIL;
6159 copy_tv(tv, &li->li_tv);
6160 list_append(l, li);
6161 return OK;
6165 * Add a dictionary to a list. Used by getqflist().
6166 * Return FAIL when out of memory.
6169 list_append_dict(list, dict)
6170 list_T *list;
6171 dict_T *dict;
6173 listitem_T *li = listitem_alloc();
6175 if (li == NULL)
6176 return FAIL;
6177 li->li_tv.v_type = VAR_DICT;
6178 li->li_tv.v_lock = 0;
6179 li->li_tv.vval.v_dict = dict;
6180 list_append(list, li);
6181 ++dict->dv_refcount;
6182 return OK;
6186 * Make a copy of "str" and append it as an item to list "l".
6187 * When "len" >= 0 use "str[len]".
6188 * Returns FAIL when out of memory.
6191 list_append_string(l, str, len)
6192 list_T *l;
6193 char_u *str;
6194 int len;
6196 listitem_T *li = listitem_alloc();
6198 if (li == NULL)
6199 return FAIL;
6200 list_append(l, li);
6201 li->li_tv.v_type = VAR_STRING;
6202 li->li_tv.v_lock = 0;
6203 if (str == NULL)
6204 li->li_tv.vval.v_string = NULL;
6205 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6206 : vim_strsave(str))) == NULL)
6207 return FAIL;
6208 return OK;
6212 * Append "n" to list "l".
6213 * Returns FAIL when out of memory.
6215 static int
6216 list_append_number(l, n)
6217 list_T *l;
6218 varnumber_T n;
6220 listitem_T *li;
6222 li = listitem_alloc();
6223 if (li == NULL)
6224 return FAIL;
6225 li->li_tv.v_type = VAR_NUMBER;
6226 li->li_tv.v_lock = 0;
6227 li->li_tv.vval.v_number = n;
6228 list_append(l, li);
6229 return OK;
6233 * Insert typval_T "tv" in list "l" before "item".
6234 * If "item" is NULL append at the end.
6235 * Return FAIL when out of memory.
6237 static int
6238 list_insert_tv(l, tv, item)
6239 list_T *l;
6240 typval_T *tv;
6241 listitem_T *item;
6243 listitem_T *ni = listitem_alloc();
6245 if (ni == NULL)
6246 return FAIL;
6247 copy_tv(tv, &ni->li_tv);
6248 if (item == NULL)
6249 /* Append new item at end of list. */
6250 list_append(l, ni);
6251 else
6253 /* Insert new item before existing item. */
6254 ni->li_prev = item->li_prev;
6255 ni->li_next = item;
6256 if (item->li_prev == NULL)
6258 l->lv_first = ni;
6259 ++l->lv_idx;
6261 else
6263 item->li_prev->li_next = ni;
6264 l->lv_idx_item = NULL;
6266 item->li_prev = ni;
6267 ++l->lv_len;
6269 return OK;
6273 * Extend "l1" with "l2".
6274 * If "bef" is NULL append at the end, otherwise insert before this item.
6275 * Returns FAIL when out of memory.
6277 static int
6278 list_extend(l1, l2, bef)
6279 list_T *l1;
6280 list_T *l2;
6281 listitem_T *bef;
6283 listitem_T *item;
6284 int todo = l2->lv_len;
6286 /* We also quit the loop when we have inserted the original item count of
6287 * the list, avoid a hang when we extend a list with itself. */
6288 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6289 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6290 return FAIL;
6291 return OK;
6295 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6296 * Return FAIL when out of memory.
6298 static int
6299 list_concat(l1, l2, tv)
6300 list_T *l1;
6301 list_T *l2;
6302 typval_T *tv;
6304 list_T *l;
6306 if (l1 == NULL || l2 == NULL)
6307 return FAIL;
6309 /* make a copy of the first list. */
6310 l = list_copy(l1, FALSE, 0);
6311 if (l == NULL)
6312 return FAIL;
6313 tv->v_type = VAR_LIST;
6314 tv->vval.v_list = l;
6316 /* append all items from the second list */
6317 return list_extend(l, l2, NULL);
6321 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6322 * The refcount of the new list is set to 1.
6323 * See item_copy() for "copyID".
6324 * Returns NULL when out of memory.
6326 static list_T *
6327 list_copy(orig, deep, copyID)
6328 list_T *orig;
6329 int deep;
6330 int copyID;
6332 list_T *copy;
6333 listitem_T *item;
6334 listitem_T *ni;
6336 if (orig == NULL)
6337 return NULL;
6339 copy = list_alloc();
6340 if (copy != NULL)
6342 if (copyID != 0)
6344 /* Do this before adding the items, because one of the items may
6345 * refer back to this list. */
6346 orig->lv_copyID = copyID;
6347 orig->lv_copylist = copy;
6349 for (item = orig->lv_first; item != NULL && !got_int;
6350 item = item->li_next)
6352 ni = listitem_alloc();
6353 if (ni == NULL)
6354 break;
6355 if (deep)
6357 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6359 vim_free(ni);
6360 break;
6363 else
6364 copy_tv(&item->li_tv, &ni->li_tv);
6365 list_append(copy, ni);
6367 ++copy->lv_refcount;
6368 if (item != NULL)
6370 list_unref(copy);
6371 copy = NULL;
6375 return copy;
6379 * Remove items "item" to "item2" from list "l".
6380 * Does not free the listitem or the value!
6382 static void
6383 list_remove(l, item, item2)
6384 list_T *l;
6385 listitem_T *item;
6386 listitem_T *item2;
6388 listitem_T *ip;
6390 /* notify watchers */
6391 for (ip = item; ip != NULL; ip = ip->li_next)
6393 --l->lv_len;
6394 list_fix_watch(l, ip);
6395 if (ip == item2)
6396 break;
6399 if (item2->li_next == NULL)
6400 l->lv_last = item->li_prev;
6401 else
6402 item2->li_next->li_prev = item->li_prev;
6403 if (item->li_prev == NULL)
6404 l->lv_first = item2->li_next;
6405 else
6406 item->li_prev->li_next = item2->li_next;
6407 l->lv_idx_item = NULL;
6411 * Return an allocated string with the string representation of a list.
6412 * May return NULL.
6414 static char_u *
6415 list2string(tv, copyID)
6416 typval_T *tv;
6417 int copyID;
6419 garray_T ga;
6421 if (tv->vval.v_list == NULL)
6422 return NULL;
6423 ga_init2(&ga, (int)sizeof(char), 80);
6424 ga_append(&ga, '[');
6425 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6427 vim_free(ga.ga_data);
6428 return NULL;
6430 ga_append(&ga, ']');
6431 ga_append(&ga, NUL);
6432 return (char_u *)ga.ga_data;
6436 * Join list "l" into a string in "*gap", using separator "sep".
6437 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6438 * Return FAIL or OK.
6440 static int
6441 list_join(gap, l, sep, echo, copyID)
6442 garray_T *gap;
6443 list_T *l;
6444 char_u *sep;
6445 int echo;
6446 int copyID;
6448 int first = TRUE;
6449 char_u *tofree;
6450 char_u numbuf[NUMBUFLEN];
6451 listitem_T *item;
6452 char_u *s;
6454 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6456 if (first)
6457 first = FALSE;
6458 else
6459 ga_concat(gap, sep);
6461 if (echo)
6462 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6463 else
6464 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6465 if (s != NULL)
6466 ga_concat(gap, s);
6467 vim_free(tofree);
6468 if (s == NULL)
6469 return FAIL;
6471 return OK;
6475 * Garbage collection for lists and dictionaries.
6477 * We use reference counts to be able to free most items right away when they
6478 * are no longer used. But for composite items it's possible that it becomes
6479 * unused while the reference count is > 0: When there is a recursive
6480 * reference. Example:
6481 * :let l = [1, 2, 3]
6482 * :let d = {9: l}
6483 * :let l[1] = d
6485 * Since this is quite unusual we handle this with garbage collection: every
6486 * once in a while find out which lists and dicts are not referenced from any
6487 * variable.
6489 * Here is a good reference text about garbage collection (refers to Python
6490 * but it applies to all reference-counting mechanisms):
6491 * http://python.ca/nas/python/gc/
6495 * Do garbage collection for lists and dicts.
6496 * Return TRUE if some memory was freed.
6499 garbage_collect()
6501 int copyID;
6502 buf_T *buf;
6503 win_T *wp;
6504 int i;
6505 funccall_T *fc, **pfc;
6506 int did_free;
6507 int did_free_funccal = FALSE;
6508 #ifdef FEAT_WINDOWS
6509 tabpage_T *tp;
6510 #endif
6512 /* Only do this once. */
6513 want_garbage_collect = FALSE;
6514 may_garbage_collect = FALSE;
6515 garbage_collect_at_exit = FALSE;
6517 /* We advance by two because we add one for items referenced through
6518 * previous_funccal. */
6519 current_copyID += COPYID_INC;
6520 copyID = current_copyID;
6523 * 1. Go through all accessible variables and mark all lists and dicts
6524 * with copyID.
6527 /* Don't free variables in the previous_funccal list unless they are only
6528 * referenced through previous_funccal. This must be first, because if
6529 * the item is referenced elsewhere the funccal must not be freed. */
6530 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
6532 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1);
6533 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1);
6536 /* script-local variables */
6537 for (i = 1; i <= ga_scripts.ga_len; ++i)
6538 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6540 /* buffer-local variables */
6541 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6542 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6544 /* window-local variables */
6545 FOR_ALL_TAB_WINDOWS(tp, wp)
6546 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6548 #ifdef FEAT_WINDOWS
6549 /* tabpage-local variables */
6550 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6551 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6552 #endif
6554 /* global variables */
6555 set_ref_in_ht(&globvarht, copyID);
6557 /* function-local variables */
6558 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6560 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6561 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6564 /* v: vars */
6565 set_ref_in_ht(&vimvarht, copyID);
6568 * 2. Free lists and dictionaries that are not referenced.
6570 did_free = free_unref_items(copyID);
6573 * 3. Check if any funccal can be freed now.
6575 for (pfc = &previous_funccal; *pfc != NULL; )
6577 if (can_free_funccal(*pfc, copyID))
6579 fc = *pfc;
6580 *pfc = fc->caller;
6581 free_funccal(fc, TRUE);
6582 did_free = TRUE;
6583 did_free_funccal = TRUE;
6585 else
6586 pfc = &(*pfc)->caller;
6588 if (did_free_funccal)
6589 /* When a funccal was freed some more items might be garbage
6590 * collected, so run again. */
6591 (void)garbage_collect();
6593 return did_free;
6597 * Free lists and dictionaries that are no longer referenced.
6599 static int
6600 free_unref_items(copyID)
6601 int copyID;
6603 dict_T *dd;
6604 list_T *ll;
6605 int did_free = FALSE;
6608 * Go through the list of dicts and free items without the copyID.
6610 for (dd = first_dict; dd != NULL; )
6611 if ((dd->dv_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
6613 /* Free the Dictionary and ordinary items it contains, but don't
6614 * recurse into Lists and Dictionaries, they will be in the list
6615 * of dicts or list of lists. */
6616 dict_free(dd, FALSE);
6617 did_free = TRUE;
6619 /* restart, next dict may also have been freed */
6620 dd = first_dict;
6622 else
6623 dd = dd->dv_used_next;
6626 * Go through the list of lists and free items without the copyID.
6627 * But don't free a list that has a watcher (used in a for loop), these
6628 * are not referenced anywhere.
6630 for (ll = first_list; ll != NULL; )
6631 if ((ll->lv_copyID & COPYID_MASK) != (copyID & COPYID_MASK)
6632 && ll->lv_watch == NULL)
6634 /* Free the List and ordinary items it contains, but don't recurse
6635 * into Lists and Dictionaries, they will be in the list of dicts
6636 * or list of lists. */
6637 list_free(ll, FALSE);
6638 did_free = TRUE;
6640 /* restart, next list may also have been freed */
6641 ll = first_list;
6643 else
6644 ll = ll->lv_used_next;
6646 return did_free;
6650 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6652 static void
6653 set_ref_in_ht(ht, copyID)
6654 hashtab_T *ht;
6655 int copyID;
6657 int todo;
6658 hashitem_T *hi;
6660 todo = (int)ht->ht_used;
6661 for (hi = ht->ht_array; todo > 0; ++hi)
6662 if (!HASHITEM_EMPTY(hi))
6664 --todo;
6665 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6670 * Mark all lists and dicts referenced through list "l" with "copyID".
6672 static void
6673 set_ref_in_list(l, copyID)
6674 list_T *l;
6675 int copyID;
6677 listitem_T *li;
6679 for (li = l->lv_first; li != NULL; li = li->li_next)
6680 set_ref_in_item(&li->li_tv, copyID);
6684 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6686 static void
6687 set_ref_in_item(tv, copyID)
6688 typval_T *tv;
6689 int copyID;
6691 dict_T *dd;
6692 list_T *ll;
6694 switch (tv->v_type)
6696 case VAR_DICT:
6697 dd = tv->vval.v_dict;
6698 if (dd != NULL && dd->dv_copyID != copyID)
6700 /* Didn't see this dict yet. */
6701 dd->dv_copyID = copyID;
6702 set_ref_in_ht(&dd->dv_hashtab, copyID);
6704 break;
6706 case VAR_LIST:
6707 ll = tv->vval.v_list;
6708 if (ll != NULL && ll->lv_copyID != copyID)
6710 /* Didn't see this list yet. */
6711 ll->lv_copyID = copyID;
6712 set_ref_in_list(ll, copyID);
6714 break;
6716 return;
6720 * Allocate an empty header for a dictionary.
6722 dict_T *
6723 dict_alloc()
6725 dict_T *d;
6727 d = (dict_T *)alloc(sizeof(dict_T));
6728 if (d != NULL)
6730 /* Add the list to the list of dicts for garbage collection. */
6731 if (first_dict != NULL)
6732 first_dict->dv_used_prev = d;
6733 d->dv_used_next = first_dict;
6734 d->dv_used_prev = NULL;
6735 first_dict = d;
6737 hash_init(&d->dv_hashtab);
6738 d->dv_lock = 0;
6739 d->dv_refcount = 0;
6740 d->dv_copyID = 0;
6742 return d;
6746 * Unreference a Dictionary: decrement the reference count and free it when it
6747 * becomes zero.
6749 static void
6750 dict_unref(d)
6751 dict_T *d;
6753 if (d != NULL && --d->dv_refcount <= 0)
6754 dict_free(d, TRUE);
6758 * Free a Dictionary, including all items it contains.
6759 * Ignores the reference count.
6761 static void
6762 dict_free(d, recurse)
6763 dict_T *d;
6764 int recurse; /* Free Lists and Dictionaries recursively. */
6766 int todo;
6767 hashitem_T *hi;
6768 dictitem_T *di;
6770 /* Remove the dict from the list of dicts for garbage collection. */
6771 if (d->dv_used_prev == NULL)
6772 first_dict = d->dv_used_next;
6773 else
6774 d->dv_used_prev->dv_used_next = d->dv_used_next;
6775 if (d->dv_used_next != NULL)
6776 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6778 /* Lock the hashtab, we don't want it to resize while freeing items. */
6779 hash_lock(&d->dv_hashtab);
6780 todo = (int)d->dv_hashtab.ht_used;
6781 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6783 if (!HASHITEM_EMPTY(hi))
6785 /* Remove the item before deleting it, just in case there is
6786 * something recursive causing trouble. */
6787 di = HI2DI(hi);
6788 hash_remove(&d->dv_hashtab, hi);
6789 if (recurse || (di->di_tv.v_type != VAR_LIST
6790 && di->di_tv.v_type != VAR_DICT))
6791 clear_tv(&di->di_tv);
6792 vim_free(di);
6793 --todo;
6796 hash_clear(&d->dv_hashtab);
6797 vim_free(d);
6801 * Allocate a Dictionary item.
6802 * The "key" is copied to the new item.
6803 * Note that the value of the item "di_tv" still needs to be initialized!
6804 * Returns NULL when out of memory.
6806 static dictitem_T *
6807 dictitem_alloc(key)
6808 char_u *key;
6810 dictitem_T *di;
6812 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6813 if (di != NULL)
6815 STRCPY(di->di_key, key);
6816 di->di_flags = 0;
6818 return di;
6822 * Make a copy of a Dictionary item.
6824 static dictitem_T *
6825 dictitem_copy(org)
6826 dictitem_T *org;
6828 dictitem_T *di;
6830 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6831 + STRLEN(org->di_key)));
6832 if (di != NULL)
6834 STRCPY(di->di_key, org->di_key);
6835 di->di_flags = 0;
6836 copy_tv(&org->di_tv, &di->di_tv);
6838 return di;
6842 * Remove item "item" from Dictionary "dict" and free it.
6844 static void
6845 dictitem_remove(dict, item)
6846 dict_T *dict;
6847 dictitem_T *item;
6849 hashitem_T *hi;
6851 hi = hash_find(&dict->dv_hashtab, item->di_key);
6852 if (HASHITEM_EMPTY(hi))
6853 EMSG2(_(e_intern2), "dictitem_remove()");
6854 else
6855 hash_remove(&dict->dv_hashtab, hi);
6856 dictitem_free(item);
6860 * Free a dict item. Also clears the value.
6862 static void
6863 dictitem_free(item)
6864 dictitem_T *item;
6866 clear_tv(&item->di_tv);
6867 vim_free(item);
6871 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6872 * The refcount of the new dict is set to 1.
6873 * See item_copy() for "copyID".
6874 * Returns NULL when out of memory.
6876 static dict_T *
6877 dict_copy(orig, deep, copyID)
6878 dict_T *orig;
6879 int deep;
6880 int copyID;
6882 dict_T *copy;
6883 dictitem_T *di;
6884 int todo;
6885 hashitem_T *hi;
6887 if (orig == NULL)
6888 return NULL;
6890 copy = dict_alloc();
6891 if (copy != NULL)
6893 if (copyID != 0)
6895 orig->dv_copyID = copyID;
6896 orig->dv_copydict = copy;
6898 todo = (int)orig->dv_hashtab.ht_used;
6899 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6901 if (!HASHITEM_EMPTY(hi))
6903 --todo;
6905 di = dictitem_alloc(hi->hi_key);
6906 if (di == NULL)
6907 break;
6908 if (deep)
6910 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6911 copyID) == FAIL)
6913 vim_free(di);
6914 break;
6917 else
6918 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6919 if (dict_add(copy, di) == FAIL)
6921 dictitem_free(di);
6922 break;
6927 ++copy->dv_refcount;
6928 if (todo > 0)
6930 dict_unref(copy);
6931 copy = NULL;
6935 return copy;
6939 * Add item "item" to Dictionary "d".
6940 * Returns FAIL when out of memory and when key already existed.
6942 static int
6943 dict_add(d, item)
6944 dict_T *d;
6945 dictitem_T *item;
6947 return hash_add(&d->dv_hashtab, item->di_key);
6951 * Add a number or string entry to dictionary "d".
6952 * When "str" is NULL use number "nr", otherwise use "str".
6953 * Returns FAIL when out of memory and when key already exists.
6956 dict_add_nr_str(d, key, nr, str)
6957 dict_T *d;
6958 char *key;
6959 long nr;
6960 char_u *str;
6962 dictitem_T *item;
6964 item = dictitem_alloc((char_u *)key);
6965 if (item == NULL)
6966 return FAIL;
6967 item->di_tv.v_lock = 0;
6968 if (str == NULL)
6970 item->di_tv.v_type = VAR_NUMBER;
6971 item->di_tv.vval.v_number = nr;
6973 else
6975 item->di_tv.v_type = VAR_STRING;
6976 item->di_tv.vval.v_string = vim_strsave(str);
6978 if (dict_add(d, item) == FAIL)
6980 dictitem_free(item);
6981 return FAIL;
6983 return OK;
6987 * Get the number of items in a Dictionary.
6989 static long
6990 dict_len(d)
6991 dict_T *d;
6993 if (d == NULL)
6994 return 0L;
6995 return (long)d->dv_hashtab.ht_used;
6999 * Find item "key[len]" in Dictionary "d".
7000 * If "len" is negative use strlen(key).
7001 * Returns NULL when not found.
7003 static dictitem_T *
7004 dict_find(d, key, len)
7005 dict_T *d;
7006 char_u *key;
7007 int len;
7009 #define AKEYLEN 200
7010 char_u buf[AKEYLEN];
7011 char_u *akey;
7012 char_u *tofree = NULL;
7013 hashitem_T *hi;
7015 if (len < 0)
7016 akey = key;
7017 else if (len >= AKEYLEN)
7019 tofree = akey = vim_strnsave(key, len);
7020 if (akey == NULL)
7021 return NULL;
7023 else
7025 /* Avoid a malloc/free by using buf[]. */
7026 vim_strncpy(buf, key, len);
7027 akey = buf;
7030 hi = hash_find(&d->dv_hashtab, akey);
7031 vim_free(tofree);
7032 if (HASHITEM_EMPTY(hi))
7033 return NULL;
7034 return HI2DI(hi);
7038 * Get a string item from a dictionary.
7039 * When "save" is TRUE allocate memory for it.
7040 * Returns NULL if the entry doesn't exist or out of memory.
7042 char_u *
7043 get_dict_string(d, key, save)
7044 dict_T *d;
7045 char_u *key;
7046 int save;
7048 dictitem_T *di;
7049 char_u *s;
7051 di = dict_find(d, key, -1);
7052 if (di == NULL)
7053 return NULL;
7054 s = get_tv_string(&di->di_tv);
7055 if (save && s != NULL)
7056 s = vim_strsave(s);
7057 return s;
7061 * Get a number item from a dictionary.
7062 * Returns 0 if the entry doesn't exist or out of memory.
7064 long
7065 get_dict_number(d, key)
7066 dict_T *d;
7067 char_u *key;
7069 dictitem_T *di;
7071 di = dict_find(d, key, -1);
7072 if (di == NULL)
7073 return 0;
7074 return get_tv_number(&di->di_tv);
7078 * Return an allocated string with the string representation of a Dictionary.
7079 * May return NULL.
7081 static char_u *
7082 dict2string(tv, copyID)
7083 typval_T *tv;
7084 int copyID;
7086 garray_T ga;
7087 int first = TRUE;
7088 char_u *tofree;
7089 char_u numbuf[NUMBUFLEN];
7090 hashitem_T *hi;
7091 char_u *s;
7092 dict_T *d;
7093 int todo;
7095 if ((d = tv->vval.v_dict) == NULL)
7096 return NULL;
7097 ga_init2(&ga, (int)sizeof(char), 80);
7098 ga_append(&ga, '{');
7100 todo = (int)d->dv_hashtab.ht_used;
7101 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7103 if (!HASHITEM_EMPTY(hi))
7105 --todo;
7107 if (first)
7108 first = FALSE;
7109 else
7110 ga_concat(&ga, (char_u *)", ");
7112 tofree = string_quote(hi->hi_key, FALSE);
7113 if (tofree != NULL)
7115 ga_concat(&ga, tofree);
7116 vim_free(tofree);
7118 ga_concat(&ga, (char_u *)": ");
7119 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7120 if (s != NULL)
7121 ga_concat(&ga, s);
7122 vim_free(tofree);
7123 if (s == NULL)
7124 break;
7127 if (todo > 0)
7129 vim_free(ga.ga_data);
7130 return NULL;
7133 ga_append(&ga, '}');
7134 ga_append(&ga, NUL);
7135 return (char_u *)ga.ga_data;
7139 * Allocate a variable for a Dictionary and fill it from "*arg".
7140 * Return OK or FAIL. Returns NOTDONE for {expr}.
7142 static int
7143 get_dict_tv(arg, rettv, evaluate)
7144 char_u **arg;
7145 typval_T *rettv;
7146 int evaluate;
7148 dict_T *d = NULL;
7149 typval_T tvkey;
7150 typval_T tv;
7151 char_u *key = NULL;
7152 dictitem_T *item;
7153 char_u *start = skipwhite(*arg + 1);
7154 char_u buf[NUMBUFLEN];
7157 * First check if it's not a curly-braces thing: {expr}.
7158 * Must do this without evaluating, otherwise a function may be called
7159 * twice. Unfortunately this means we need to call eval1() twice for the
7160 * first item.
7161 * But {} is an empty Dictionary.
7163 if (*start != '}')
7165 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7166 return FAIL;
7167 if (*start == '}')
7168 return NOTDONE;
7171 if (evaluate)
7173 d = dict_alloc();
7174 if (d == NULL)
7175 return FAIL;
7177 tvkey.v_type = VAR_UNKNOWN;
7178 tv.v_type = VAR_UNKNOWN;
7180 *arg = skipwhite(*arg + 1);
7181 while (**arg != '}' && **arg != NUL)
7183 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7184 goto failret;
7185 if (**arg != ':')
7187 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7188 clear_tv(&tvkey);
7189 goto failret;
7191 if (evaluate)
7193 key = get_tv_string_buf_chk(&tvkey, buf);
7194 if (key == NULL || *key == NUL)
7196 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7197 if (key != NULL)
7198 EMSG(_(e_emptykey));
7199 clear_tv(&tvkey);
7200 goto failret;
7204 *arg = skipwhite(*arg + 1);
7205 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7207 if (evaluate)
7208 clear_tv(&tvkey);
7209 goto failret;
7211 if (evaluate)
7213 item = dict_find(d, key, -1);
7214 if (item != NULL)
7216 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7217 clear_tv(&tvkey);
7218 clear_tv(&tv);
7219 goto failret;
7221 item = dictitem_alloc(key);
7222 clear_tv(&tvkey);
7223 if (item != NULL)
7225 item->di_tv = tv;
7226 item->di_tv.v_lock = 0;
7227 if (dict_add(d, item) == FAIL)
7228 dictitem_free(item);
7232 if (**arg == '}')
7233 break;
7234 if (**arg != ',')
7236 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7237 goto failret;
7239 *arg = skipwhite(*arg + 1);
7242 if (**arg != '}')
7244 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7245 failret:
7246 if (evaluate)
7247 dict_free(d, TRUE);
7248 return FAIL;
7251 *arg = skipwhite(*arg + 1);
7252 if (evaluate)
7254 rettv->v_type = VAR_DICT;
7255 rettv->vval.v_dict = d;
7256 ++d->dv_refcount;
7259 return OK;
7263 * Return a string with the string representation of a variable.
7264 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7265 * "numbuf" is used for a number.
7266 * Does not put quotes around strings, as ":echo" displays values.
7267 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7268 * May return NULL.
7270 static char_u *
7271 echo_string(tv, tofree, numbuf, copyID)
7272 typval_T *tv;
7273 char_u **tofree;
7274 char_u *numbuf;
7275 int copyID;
7277 static int recurse = 0;
7278 char_u *r = NULL;
7280 if (recurse >= DICT_MAXNEST)
7282 EMSG(_("E724: variable nested too deep for displaying"));
7283 *tofree = NULL;
7284 return NULL;
7286 ++recurse;
7288 switch (tv->v_type)
7290 case VAR_FUNC:
7291 *tofree = NULL;
7292 r = tv->vval.v_string;
7293 break;
7295 case VAR_LIST:
7296 if (tv->vval.v_list == NULL)
7298 *tofree = NULL;
7299 r = NULL;
7301 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7303 *tofree = NULL;
7304 r = (char_u *)"[...]";
7306 else
7308 tv->vval.v_list->lv_copyID = copyID;
7309 *tofree = list2string(tv, copyID);
7310 r = *tofree;
7312 break;
7314 case VAR_DICT:
7315 if (tv->vval.v_dict == NULL)
7317 *tofree = NULL;
7318 r = NULL;
7320 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7322 *tofree = NULL;
7323 r = (char_u *)"{...}";
7325 else
7327 tv->vval.v_dict->dv_copyID = copyID;
7328 *tofree = dict2string(tv, copyID);
7329 r = *tofree;
7331 break;
7333 case VAR_STRING:
7334 case VAR_NUMBER:
7335 *tofree = NULL;
7336 r = get_tv_string_buf(tv, numbuf);
7337 break;
7339 #ifdef FEAT_FLOAT
7340 case VAR_FLOAT:
7341 *tofree = NULL;
7342 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7343 r = numbuf;
7344 break;
7345 #endif
7347 default:
7348 EMSG2(_(e_intern2), "echo_string()");
7349 *tofree = NULL;
7352 --recurse;
7353 return r;
7357 * Return a string with the string representation of a variable.
7358 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7359 * "numbuf" is used for a number.
7360 * Puts quotes around strings, so that they can be parsed back by eval().
7361 * May return NULL.
7363 static char_u *
7364 tv2string(tv, tofree, numbuf, copyID)
7365 typval_T *tv;
7366 char_u **tofree;
7367 char_u *numbuf;
7368 int copyID;
7370 switch (tv->v_type)
7372 case VAR_FUNC:
7373 *tofree = string_quote(tv->vval.v_string, TRUE);
7374 return *tofree;
7375 case VAR_STRING:
7376 *tofree = string_quote(tv->vval.v_string, FALSE);
7377 return *tofree;
7378 #ifdef FEAT_FLOAT
7379 case VAR_FLOAT:
7380 *tofree = NULL;
7381 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7382 return numbuf;
7383 #endif
7384 case VAR_NUMBER:
7385 case VAR_LIST:
7386 case VAR_DICT:
7387 break;
7388 default:
7389 EMSG2(_(e_intern2), "tv2string()");
7391 return echo_string(tv, tofree, numbuf, copyID);
7395 * Return string "str" in ' quotes, doubling ' characters.
7396 * If "str" is NULL an empty string is assumed.
7397 * If "function" is TRUE make it function('string').
7399 static char_u *
7400 string_quote(str, function)
7401 char_u *str;
7402 int function;
7404 unsigned len;
7405 char_u *p, *r, *s;
7407 len = (function ? 13 : 3);
7408 if (str != NULL)
7410 len += (unsigned)STRLEN(str);
7411 for (p = str; *p != NUL; mb_ptr_adv(p))
7412 if (*p == '\'')
7413 ++len;
7415 s = r = alloc(len);
7416 if (r != NULL)
7418 if (function)
7420 STRCPY(r, "function('");
7421 r += 10;
7423 else
7424 *r++ = '\'';
7425 if (str != NULL)
7426 for (p = str; *p != NUL; )
7428 if (*p == '\'')
7429 *r++ = '\'';
7430 MB_COPY_CHAR(p, r);
7432 *r++ = '\'';
7433 if (function)
7434 *r++ = ')';
7435 *r++ = NUL;
7437 return s;
7440 #ifdef FEAT_FLOAT
7442 * Convert the string "text" to a floating point number.
7443 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7444 * this always uses a decimal point.
7445 * Returns the length of the text that was consumed.
7447 static int
7448 string2float(text, value)
7449 char_u *text;
7450 float_T *value; /* result stored here */
7452 char *s = (char *)text;
7453 float_T f;
7455 f = strtod(s, &s);
7456 *value = f;
7457 return (int)((char_u *)s - text);
7459 #endif
7462 * Get the value of an environment variable.
7463 * "arg" is pointing to the '$'. It is advanced to after the name.
7464 * If the environment variable was not set, silently assume it is empty.
7465 * Always return OK.
7467 static int
7468 get_env_tv(arg, rettv, evaluate)
7469 char_u **arg;
7470 typval_T *rettv;
7471 int evaluate;
7473 char_u *string = NULL;
7474 int len;
7475 int cc;
7476 char_u *name;
7477 int mustfree = FALSE;
7479 ++*arg;
7480 name = *arg;
7481 len = get_env_len(arg);
7482 if (evaluate)
7484 if (len != 0)
7486 cc = name[len];
7487 name[len] = NUL;
7488 /* first try vim_getenv(), fast for normal environment vars */
7489 string = vim_getenv(name, &mustfree);
7490 if (string != NULL && *string != NUL)
7492 if (!mustfree)
7493 string = vim_strsave(string);
7495 else
7497 if (mustfree)
7498 vim_free(string);
7500 /* next try expanding things like $VIM and ${HOME} */
7501 string = expand_env_save(name - 1);
7502 if (string != NULL && *string == '$')
7504 vim_free(string);
7505 string = NULL;
7508 name[len] = cc;
7510 rettv->v_type = VAR_STRING;
7511 rettv->vval.v_string = string;
7514 return OK;
7518 * Array with names and number of arguments of all internal functions
7519 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7521 static struct fst
7523 char *f_name; /* function name */
7524 char f_min_argc; /* minimal number of arguments */
7525 char f_max_argc; /* maximal number of arguments */
7526 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7527 /* implementation of function */
7528 } functions[] =
7530 #ifdef FEAT_FLOAT
7531 {"abs", 1, 1, f_abs},
7532 #endif
7533 {"add", 2, 2, f_add},
7534 {"append", 2, 2, f_append},
7535 {"argc", 0, 0, f_argc},
7536 {"argidx", 0, 0, f_argidx},
7537 {"argv", 0, 1, f_argv},
7538 #ifdef FEAT_FLOAT
7539 {"atan", 1, 1, f_atan},
7540 #endif
7541 {"browse", 4, 4, f_browse},
7542 {"browsedir", 2, 2, f_browsedir},
7543 {"bufexists", 1, 1, f_bufexists},
7544 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7545 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7546 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7547 {"buflisted", 1, 1, f_buflisted},
7548 {"bufloaded", 1, 1, f_bufloaded},
7549 {"bufname", 1, 1, f_bufname},
7550 {"bufnr", 1, 2, f_bufnr},
7551 {"bufwinnr", 1, 1, f_bufwinnr},
7552 {"byte2line", 1, 1, f_byte2line},
7553 {"byteidx", 2, 2, f_byteidx},
7554 {"call", 2, 3, f_call},
7555 #ifdef FEAT_FLOAT
7556 {"ceil", 1, 1, f_ceil},
7557 #endif
7558 {"changenr", 0, 0, f_changenr},
7559 {"char2nr", 1, 1, f_char2nr},
7560 {"cindent", 1, 1, f_cindent},
7561 {"clearmatches", 0, 0, f_clearmatches},
7562 {"col", 1, 1, f_col},
7563 #if defined(FEAT_INS_EXPAND)
7564 {"complete", 2, 2, f_complete},
7565 {"complete_add", 1, 1, f_complete_add},
7566 {"complete_check", 0, 0, f_complete_check},
7567 #endif
7568 {"confirm", 1, 4, f_confirm},
7569 {"copy", 1, 1, f_copy},
7570 #ifdef FEAT_FLOAT
7571 {"cos", 1, 1, f_cos},
7572 #endif
7573 {"count", 2, 4, f_count},
7574 {"cscope_connection",0,3, f_cscope_connection},
7575 {"cursor", 1, 3, f_cursor},
7576 {"deepcopy", 1, 2, f_deepcopy},
7577 {"delete", 1, 1, f_delete},
7578 {"did_filetype", 0, 0, f_did_filetype},
7579 {"diff_filler", 1, 1, f_diff_filler},
7580 {"diff_hlID", 2, 2, f_diff_hlID},
7581 {"empty", 1, 1, f_empty},
7582 {"escape", 2, 2, f_escape},
7583 {"eval", 1, 1, f_eval},
7584 {"eventhandler", 0, 0, f_eventhandler},
7585 {"executable", 1, 1, f_executable},
7586 {"exists", 1, 1, f_exists},
7587 {"expand", 1, 2, f_expand},
7588 {"extend", 2, 3, f_extend},
7589 {"feedkeys", 1, 2, f_feedkeys},
7590 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7591 {"filereadable", 1, 1, f_filereadable},
7592 {"filewritable", 1, 1, f_filewritable},
7593 {"filter", 2, 2, f_filter},
7594 {"finddir", 1, 3, f_finddir},
7595 {"findfile", 1, 3, f_findfile},
7596 #ifdef FEAT_FLOAT
7597 {"float2nr", 1, 1, f_float2nr},
7598 {"floor", 1, 1, f_floor},
7599 #endif
7600 {"fnameescape", 1, 1, f_fnameescape},
7601 {"fnamemodify", 2, 2, f_fnamemodify},
7602 {"foldclosed", 1, 1, f_foldclosed},
7603 {"foldclosedend", 1, 1, f_foldclosedend},
7604 {"foldlevel", 1, 1, f_foldlevel},
7605 {"foldtext", 0, 0, f_foldtext},
7606 {"foldtextresult", 1, 1, f_foldtextresult},
7607 {"foreground", 0, 0, f_foreground},
7608 {"function", 1, 1, f_function},
7609 {"garbagecollect", 0, 1, f_garbagecollect},
7610 {"get", 2, 3, f_get},
7611 {"getbufline", 2, 3, f_getbufline},
7612 {"getbufvar", 2, 2, f_getbufvar},
7613 {"getchar", 0, 1, f_getchar},
7614 {"getcharmod", 0, 0, f_getcharmod},
7615 {"getcmdline", 0, 0, f_getcmdline},
7616 {"getcmdpos", 0, 0, f_getcmdpos},
7617 {"getcmdtype", 0, 0, f_getcmdtype},
7618 {"getcwd", 0, 0, f_getcwd},
7619 {"getfontname", 0, 1, f_getfontname},
7620 {"getfperm", 1, 1, f_getfperm},
7621 {"getfsize", 1, 1, f_getfsize},
7622 {"getftime", 1, 1, f_getftime},
7623 {"getftype", 1, 1, f_getftype},
7624 {"getline", 1, 2, f_getline},
7625 {"getloclist", 1, 1, f_getqflist},
7626 {"getmatches", 0, 0, f_getmatches},
7627 {"getpid", 0, 0, f_getpid},
7628 {"getpos", 1, 1, f_getpos},
7629 {"getqflist", 0, 0, f_getqflist},
7630 {"getreg", 0, 2, f_getreg},
7631 {"getregtype", 0, 1, f_getregtype},
7632 {"gettabwinvar", 3, 3, f_gettabwinvar},
7633 {"getwinposx", 0, 0, f_getwinposx},
7634 {"getwinposy", 0, 0, f_getwinposy},
7635 {"getwinvar", 2, 2, f_getwinvar},
7636 {"glob", 1, 2, f_glob},
7637 {"globpath", 2, 3, f_globpath},
7638 {"has", 1, 1, f_has},
7639 {"has_key", 2, 2, f_has_key},
7640 {"haslocaldir", 0, 0, f_haslocaldir},
7641 {"hasmapto", 1, 3, f_hasmapto},
7642 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7643 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7644 {"histadd", 2, 2, f_histadd},
7645 {"histdel", 1, 2, f_histdel},
7646 {"histget", 1, 2, f_histget},
7647 {"histnr", 1, 1, f_histnr},
7648 {"hlID", 1, 1, f_hlID},
7649 {"hlexists", 1, 1, f_hlexists},
7650 {"hostname", 0, 0, f_hostname},
7651 {"iconv", 3, 3, f_iconv},
7652 {"indent", 1, 1, f_indent},
7653 {"index", 2, 4, f_index},
7654 {"input", 1, 3, f_input},
7655 {"inputdialog", 1, 3, f_inputdialog},
7656 {"inputlist", 1, 1, f_inputlist},
7657 {"inputrestore", 0, 0, f_inputrestore},
7658 {"inputsave", 0, 0, f_inputsave},
7659 {"inputsecret", 1, 2, f_inputsecret},
7660 {"insert", 2, 3, f_insert},
7661 {"isdirectory", 1, 1, f_isdirectory},
7662 {"islocked", 1, 1, f_islocked},
7663 {"items", 1, 1, f_items},
7664 {"join", 1, 2, f_join},
7665 {"keys", 1, 1, f_keys},
7666 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7667 {"len", 1, 1, f_len},
7668 {"libcall", 3, 3, f_libcall},
7669 {"libcallnr", 3, 3, f_libcallnr},
7670 {"line", 1, 1, f_line},
7671 {"line2byte", 1, 1, f_line2byte},
7672 {"lispindent", 1, 1, f_lispindent},
7673 {"localtime", 0, 0, f_localtime},
7674 #ifdef FEAT_FLOAT
7675 {"log10", 1, 1, f_log10},
7676 #endif
7677 {"map", 2, 2, f_map},
7678 {"maparg", 1, 3, f_maparg},
7679 {"mapcheck", 1, 3, f_mapcheck},
7680 {"match", 2, 4, f_match},
7681 {"matchadd", 2, 4, f_matchadd},
7682 {"matcharg", 1, 1, f_matcharg},
7683 {"matchdelete", 1, 1, f_matchdelete},
7684 {"matchend", 2, 4, f_matchend},
7685 {"matchlist", 2, 4, f_matchlist},
7686 {"matchstr", 2, 4, f_matchstr},
7687 {"max", 1, 1, f_max},
7688 {"min", 1, 1, f_min},
7689 #ifdef vim_mkdir
7690 {"mkdir", 1, 3, f_mkdir},
7691 #endif
7692 {"mode", 0, 1, f_mode},
7693 {"nextnonblank", 1, 1, f_nextnonblank},
7694 {"nr2char", 1, 1, f_nr2char},
7695 {"pathshorten", 1, 1, f_pathshorten},
7696 #ifdef FEAT_FLOAT
7697 {"pow", 2, 2, f_pow},
7698 #endif
7699 {"prevnonblank", 1, 1, f_prevnonblank},
7700 {"printf", 2, 19, f_printf},
7701 {"pumvisible", 0, 0, f_pumvisible},
7702 {"range", 1, 3, f_range},
7703 {"readfile", 1, 3, f_readfile},
7704 {"reltime", 0, 2, f_reltime},
7705 {"reltimestr", 1, 1, f_reltimestr},
7706 {"remote_expr", 2, 3, f_remote_expr},
7707 {"remote_foreground", 1, 1, f_remote_foreground},
7708 {"remote_peek", 1, 2, f_remote_peek},
7709 {"remote_read", 1, 1, f_remote_read},
7710 {"remote_send", 2, 3, f_remote_send},
7711 {"remove", 2, 3, f_remove},
7712 {"rename", 2, 2, f_rename},
7713 {"repeat", 2, 2, f_repeat},
7714 {"resolve", 1, 1, f_resolve},
7715 {"reverse", 1, 1, f_reverse},
7716 #ifdef FEAT_FLOAT
7717 {"round", 1, 1, f_round},
7718 #endif
7719 {"search", 1, 4, f_search},
7720 {"searchdecl", 1, 3, f_searchdecl},
7721 {"searchpair", 3, 7, f_searchpair},
7722 {"searchpairpos", 3, 7, f_searchpairpos},
7723 {"searchpos", 1, 4, f_searchpos},
7724 {"server2client", 2, 2, f_server2client},
7725 {"serverlist", 0, 0, f_serverlist},
7726 {"setbufvar", 3, 3, f_setbufvar},
7727 {"setcmdpos", 1, 1, f_setcmdpos},
7728 {"setline", 2, 2, f_setline},
7729 {"setloclist", 2, 3, f_setloclist},
7730 {"setmatches", 1, 1, f_setmatches},
7731 {"setpos", 2, 2, f_setpos},
7732 {"setqflist", 1, 2, f_setqflist},
7733 {"setreg", 2, 3, f_setreg},
7734 {"settabwinvar", 4, 4, f_settabwinvar},
7735 {"setwinvar", 3, 3, f_setwinvar},
7736 {"shellescape", 1, 2, f_shellescape},
7737 {"simplify", 1, 1, f_simplify},
7738 #ifdef FEAT_FLOAT
7739 {"sin", 1, 1, f_sin},
7740 #endif
7741 {"sort", 1, 2, f_sort},
7742 {"soundfold", 1, 1, f_soundfold},
7743 {"spellbadword", 0, 1, f_spellbadword},
7744 {"spellsuggest", 1, 3, f_spellsuggest},
7745 {"split", 1, 3, f_split},
7746 #ifdef FEAT_FLOAT
7747 {"sqrt", 1, 1, f_sqrt},
7748 {"str2float", 1, 1, f_str2float},
7749 #endif
7750 {"str2nr", 1, 2, f_str2nr},
7751 #ifdef HAVE_STRFTIME
7752 {"strftime", 1, 2, f_strftime},
7753 #endif
7754 {"stridx", 2, 3, f_stridx},
7755 {"string", 1, 1, f_string},
7756 {"strlen", 1, 1, f_strlen},
7757 {"strpart", 2, 3, f_strpart},
7758 {"strridx", 2, 3, f_strridx},
7759 {"strtrans", 1, 1, f_strtrans},
7760 {"submatch", 1, 1, f_submatch},
7761 {"substitute", 4, 4, f_substitute},
7762 {"synID", 3, 3, f_synID},
7763 {"synIDattr", 2, 3, f_synIDattr},
7764 {"synIDtrans", 1, 1, f_synIDtrans},
7765 {"synstack", 2, 2, f_synstack},
7766 {"system", 1, 2, f_system},
7767 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7768 {"tabpagenr", 0, 1, f_tabpagenr},
7769 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7770 {"tagfiles", 0, 0, f_tagfiles},
7771 {"taglist", 1, 1, f_taglist},
7772 {"tempname", 0, 0, f_tempname},
7773 {"test", 1, 1, f_test},
7774 {"tolower", 1, 1, f_tolower},
7775 {"toupper", 1, 1, f_toupper},
7776 {"tr", 3, 3, f_tr},
7777 #ifdef FEAT_FLOAT
7778 {"trunc", 1, 1, f_trunc},
7779 #endif
7780 {"type", 1, 1, f_type},
7781 {"values", 1, 1, f_values},
7782 {"virtcol", 1, 1, f_virtcol},
7783 {"visualmode", 0, 1, f_visualmode},
7784 {"winbufnr", 1, 1, f_winbufnr},
7785 {"wincol", 0, 0, f_wincol},
7786 {"winheight", 1, 1, f_winheight},
7787 {"winline", 0, 0, f_winline},
7788 {"winnr", 0, 1, f_winnr},
7789 {"winrestcmd", 0, 0, f_winrestcmd},
7790 {"winrestview", 1, 1, f_winrestview},
7791 {"winsaveview", 0, 0, f_winsaveview},
7792 {"winwidth", 1, 1, f_winwidth},
7793 {"writefile", 2, 3, f_writefile},
7796 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7799 * Function given to ExpandGeneric() to obtain the list of internal
7800 * or user defined function names.
7802 char_u *
7803 get_function_name(xp, idx)
7804 expand_T *xp;
7805 int idx;
7807 static int intidx = -1;
7808 char_u *name;
7810 if (idx == 0)
7811 intidx = -1;
7812 if (intidx < 0)
7814 name = get_user_func_name(xp, idx);
7815 if (name != NULL)
7816 return name;
7818 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7820 STRCPY(IObuff, functions[intidx].f_name);
7821 STRCAT(IObuff, "(");
7822 if (functions[intidx].f_max_argc == 0)
7823 STRCAT(IObuff, ")");
7824 return IObuff;
7827 return NULL;
7831 * Function given to ExpandGeneric() to obtain the list of internal or
7832 * user defined variable or function names.
7834 char_u *
7835 get_expr_name(xp, idx)
7836 expand_T *xp;
7837 int idx;
7839 static int intidx = -1;
7840 char_u *name;
7842 if (idx == 0)
7843 intidx = -1;
7844 if (intidx < 0)
7846 name = get_function_name(xp, idx);
7847 if (name != NULL)
7848 return name;
7850 return get_user_var_name(xp, ++intidx);
7853 #endif /* FEAT_CMDL_COMPL */
7856 * Find internal function in table above.
7857 * Return index, or -1 if not found
7859 static int
7860 find_internal_func(name)
7861 char_u *name; /* name of the function */
7863 int first = 0;
7864 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7865 int cmp;
7866 int x;
7869 * Find the function name in the table. Binary search.
7871 while (first <= last)
7873 x = first + ((unsigned)(last - first) >> 1);
7874 cmp = STRCMP(name, functions[x].f_name);
7875 if (cmp < 0)
7876 last = x - 1;
7877 else if (cmp > 0)
7878 first = x + 1;
7879 else
7880 return x;
7882 return -1;
7886 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7887 * name it contains, otherwise return "name".
7889 static char_u *
7890 deref_func_name(name, lenp)
7891 char_u *name;
7892 int *lenp;
7894 dictitem_T *v;
7895 int cc;
7897 cc = name[*lenp];
7898 name[*lenp] = NUL;
7899 v = find_var(name, NULL);
7900 name[*lenp] = cc;
7901 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7903 if (v->di_tv.vval.v_string == NULL)
7905 *lenp = 0;
7906 return (char_u *)""; /* just in case */
7908 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7909 return v->di_tv.vval.v_string;
7912 return name;
7916 * Allocate a variable for the result of a function.
7917 * Return OK or FAIL.
7919 static int
7920 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7921 evaluate, selfdict)
7922 char_u *name; /* name of the function */
7923 int len; /* length of "name" */
7924 typval_T *rettv;
7925 char_u **arg; /* argument, pointing to the '(' */
7926 linenr_T firstline; /* first line of range */
7927 linenr_T lastline; /* last line of range */
7928 int *doesrange; /* return: function handled range */
7929 int evaluate;
7930 dict_T *selfdict; /* Dictionary for "self" */
7932 char_u *argp;
7933 int ret = OK;
7934 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7935 int argcount = 0; /* number of arguments found */
7938 * Get the arguments.
7940 argp = *arg;
7941 while (argcount < MAX_FUNC_ARGS)
7943 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7944 if (*argp == ')' || *argp == ',' || *argp == NUL)
7945 break;
7946 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7948 ret = FAIL;
7949 break;
7951 ++argcount;
7952 if (*argp != ',')
7953 break;
7955 if (*argp == ')')
7956 ++argp;
7957 else
7958 ret = FAIL;
7960 if (ret == OK)
7961 ret = call_func(name, len, rettv, argcount, argvars,
7962 firstline, lastline, doesrange, evaluate, selfdict);
7963 else if (!aborting())
7965 if (argcount == MAX_FUNC_ARGS)
7966 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
7967 else
7968 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
7971 while (--argcount >= 0)
7972 clear_tv(&argvars[argcount]);
7974 *arg = skipwhite(argp);
7975 return ret;
7980 * Call a function with its resolved parameters
7981 * Return OK when the function can't be called, FAIL otherwise.
7982 * Also returns OK when an error was encountered while executing the function.
7984 static int
7985 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7986 doesrange, evaluate, selfdict)
7987 char_u *name; /* name of the function */
7988 int len; /* length of "name" */
7989 typval_T *rettv; /* return value goes here */
7990 int argcount; /* number of "argvars" */
7991 typval_T *argvars; /* vars for arguments, must have "argcount"
7992 PLUS ONE elements! */
7993 linenr_T firstline; /* first line of range */
7994 linenr_T lastline; /* last line of range */
7995 int *doesrange; /* return: function handled range */
7996 int evaluate;
7997 dict_T *selfdict; /* Dictionary for "self" */
7999 int ret = FAIL;
8000 #define ERROR_UNKNOWN 0
8001 #define ERROR_TOOMANY 1
8002 #define ERROR_TOOFEW 2
8003 #define ERROR_SCRIPT 3
8004 #define ERROR_DICT 4
8005 #define ERROR_NONE 5
8006 #define ERROR_OTHER 6
8007 int error = ERROR_NONE;
8008 int i;
8009 int llen;
8010 ufunc_T *fp;
8011 int cc;
8012 #define FLEN_FIXED 40
8013 char_u fname_buf[FLEN_FIXED + 1];
8014 char_u *fname;
8017 * In a script change <SID>name() and s:name() to K_SNR 123_name().
8018 * Change <SNR>123_name() to K_SNR 123_name().
8019 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
8021 cc = name[len];
8022 name[len] = NUL;
8023 llen = eval_fname_script(name);
8024 if (llen > 0)
8026 fname_buf[0] = K_SPECIAL;
8027 fname_buf[1] = KS_EXTRA;
8028 fname_buf[2] = (int)KE_SNR;
8029 i = 3;
8030 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
8032 if (current_SID <= 0)
8033 error = ERROR_SCRIPT;
8034 else
8036 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
8037 i = (int)STRLEN(fname_buf);
8040 if (i + STRLEN(name + llen) < FLEN_FIXED)
8042 STRCPY(fname_buf + i, name + llen);
8043 fname = fname_buf;
8045 else
8047 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8048 if (fname == NULL)
8049 error = ERROR_OTHER;
8050 else
8052 mch_memmove(fname, fname_buf, (size_t)i);
8053 STRCPY(fname + i, name + llen);
8057 else
8058 fname = name;
8060 *doesrange = FALSE;
8063 /* execute the function if no errors detected and executing */
8064 if (evaluate && error == ERROR_NONE)
8066 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */
8067 rettv->vval.v_number = 0;
8068 error = ERROR_UNKNOWN;
8070 if (!builtin_function(fname))
8073 * User defined function.
8075 fp = find_func(fname);
8077 #ifdef FEAT_AUTOCMD
8078 /* Trigger FuncUndefined event, may load the function. */
8079 if (fp == NULL
8080 && apply_autocmds(EVENT_FUNCUNDEFINED,
8081 fname, fname, TRUE, NULL)
8082 && !aborting())
8084 /* executed an autocommand, search for the function again */
8085 fp = find_func(fname);
8087 #endif
8088 /* Try loading a package. */
8089 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8091 /* loaded a package, search for the function again */
8092 fp = find_func(fname);
8095 if (fp != NULL)
8097 if (fp->uf_flags & FC_RANGE)
8098 *doesrange = TRUE;
8099 if (argcount < fp->uf_args.ga_len)
8100 error = ERROR_TOOFEW;
8101 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8102 error = ERROR_TOOMANY;
8103 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8104 error = ERROR_DICT;
8105 else
8108 * Call the user function.
8109 * Save and restore search patterns, script variables and
8110 * redo buffer.
8112 save_search_patterns();
8113 saveRedobuff();
8114 ++fp->uf_calls;
8115 call_user_func(fp, argcount, argvars, rettv,
8116 firstline, lastline,
8117 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8118 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8119 && fp->uf_refcount <= 0)
8120 /* Function was unreferenced while being used, free it
8121 * now. */
8122 func_free(fp);
8123 restoreRedobuff();
8124 restore_search_patterns();
8125 error = ERROR_NONE;
8129 else
8132 * Find the function name in the table, call its implementation.
8134 i = find_internal_func(fname);
8135 if (i >= 0)
8137 if (argcount < functions[i].f_min_argc)
8138 error = ERROR_TOOFEW;
8139 else if (argcount > functions[i].f_max_argc)
8140 error = ERROR_TOOMANY;
8141 else
8143 argvars[argcount].v_type = VAR_UNKNOWN;
8144 functions[i].f_func(argvars, rettv);
8145 error = ERROR_NONE;
8150 * The function call (or "FuncUndefined" autocommand sequence) might
8151 * have been aborted by an error, an interrupt, or an explicitly thrown
8152 * exception that has not been caught so far. This situation can be
8153 * tested for by calling aborting(). For an error in an internal
8154 * function or for the "E132" error in call_user_func(), however, the
8155 * throw point at which the "force_abort" flag (temporarily reset by
8156 * emsg()) is normally updated has not been reached yet. We need to
8157 * update that flag first to make aborting() reliable.
8159 update_force_abort();
8161 if (error == ERROR_NONE)
8162 ret = OK;
8165 * Report an error unless the argument evaluation or function call has been
8166 * cancelled due to an aborting error, an interrupt, or an exception.
8168 if (!aborting())
8170 switch (error)
8172 case ERROR_UNKNOWN:
8173 emsg_funcname(N_("E117: Unknown function: %s"), name);
8174 break;
8175 case ERROR_TOOMANY:
8176 emsg_funcname(e_toomanyarg, name);
8177 break;
8178 case ERROR_TOOFEW:
8179 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8180 name);
8181 break;
8182 case ERROR_SCRIPT:
8183 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8184 name);
8185 break;
8186 case ERROR_DICT:
8187 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8188 name);
8189 break;
8193 name[len] = cc;
8194 if (fname != name && fname != fname_buf)
8195 vim_free(fname);
8197 return ret;
8201 * Give an error message with a function name. Handle <SNR> things.
8202 * "ermsg" is to be passed without translation, use N_() instead of _().
8204 static void
8205 emsg_funcname(ermsg, name)
8206 char *ermsg;
8207 char_u *name;
8209 char_u *p;
8211 if (*name == K_SPECIAL)
8212 p = concat_str((char_u *)"<SNR>", name + 3);
8213 else
8214 p = name;
8215 EMSG2(_(ermsg), p);
8216 if (p != name)
8217 vim_free(p);
8221 * Return TRUE for a non-zero Number and a non-empty String.
8223 static int
8224 non_zero_arg(argvars)
8225 typval_T *argvars;
8227 return ((argvars[0].v_type == VAR_NUMBER
8228 && argvars[0].vval.v_number != 0)
8229 || (argvars[0].v_type == VAR_STRING
8230 && argvars[0].vval.v_string != NULL
8231 && *argvars[0].vval.v_string != NUL));
8234 /*********************************************
8235 * Implementation of the built-in functions
8238 #ifdef FEAT_FLOAT
8240 * "abs(expr)" function
8242 static void
8243 f_abs(argvars, rettv)
8244 typval_T *argvars;
8245 typval_T *rettv;
8247 if (argvars[0].v_type == VAR_FLOAT)
8249 rettv->v_type = VAR_FLOAT;
8250 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8252 else
8254 varnumber_T n;
8255 int error = FALSE;
8257 n = get_tv_number_chk(&argvars[0], &error);
8258 if (error)
8259 rettv->vval.v_number = -1;
8260 else if (n > 0)
8261 rettv->vval.v_number = n;
8262 else
8263 rettv->vval.v_number = -n;
8266 #endif
8269 * "add(list, item)" function
8271 static void
8272 f_add(argvars, rettv)
8273 typval_T *argvars;
8274 typval_T *rettv;
8276 list_T *l;
8278 rettv->vval.v_number = 1; /* Default: Failed */
8279 if (argvars[0].v_type == VAR_LIST)
8281 if ((l = argvars[0].vval.v_list) != NULL
8282 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8283 && list_append_tv(l, &argvars[1]) == OK)
8284 copy_tv(&argvars[0], rettv);
8286 else
8287 EMSG(_(e_listreq));
8291 * "append(lnum, string/list)" function
8293 static void
8294 f_append(argvars, rettv)
8295 typval_T *argvars;
8296 typval_T *rettv;
8298 long lnum;
8299 char_u *line;
8300 list_T *l = NULL;
8301 listitem_T *li = NULL;
8302 typval_T *tv;
8303 long added = 0;
8305 lnum = get_tv_lnum(argvars);
8306 if (lnum >= 0
8307 && lnum <= curbuf->b_ml.ml_line_count
8308 && u_save(lnum, lnum + 1) == OK)
8310 if (argvars[1].v_type == VAR_LIST)
8312 l = argvars[1].vval.v_list;
8313 if (l == NULL)
8314 return;
8315 li = l->lv_first;
8317 for (;;)
8319 if (l == NULL)
8320 tv = &argvars[1]; /* append a string */
8321 else if (li == NULL)
8322 break; /* end of list */
8323 else
8324 tv = &li->li_tv; /* append item from list */
8325 line = get_tv_string_chk(tv);
8326 if (line == NULL) /* type error */
8328 rettv->vval.v_number = 1; /* Failed */
8329 break;
8331 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8332 ++added;
8333 if (l == NULL)
8334 break;
8335 li = li->li_next;
8338 appended_lines_mark(lnum, added);
8339 if (curwin->w_cursor.lnum > lnum)
8340 curwin->w_cursor.lnum += added;
8342 else
8343 rettv->vval.v_number = 1; /* Failed */
8347 * "argc()" function
8349 static void
8350 f_argc(argvars, rettv)
8351 typval_T *argvars UNUSED;
8352 typval_T *rettv;
8354 rettv->vval.v_number = ARGCOUNT;
8358 * "argidx()" function
8360 static void
8361 f_argidx(argvars, rettv)
8362 typval_T *argvars UNUSED;
8363 typval_T *rettv;
8365 rettv->vval.v_number = curwin->w_arg_idx;
8369 * "argv(nr)" function
8371 static void
8372 f_argv(argvars, rettv)
8373 typval_T *argvars;
8374 typval_T *rettv;
8376 int idx;
8378 if (argvars[0].v_type != VAR_UNKNOWN)
8380 idx = get_tv_number_chk(&argvars[0], NULL);
8381 if (idx >= 0 && idx < ARGCOUNT)
8382 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8383 else
8384 rettv->vval.v_string = NULL;
8385 rettv->v_type = VAR_STRING;
8387 else if (rettv_list_alloc(rettv) == OK)
8388 for (idx = 0; idx < ARGCOUNT; ++idx)
8389 list_append_string(rettv->vval.v_list,
8390 alist_name(&ARGLIST[idx]), -1);
8393 #ifdef FEAT_FLOAT
8394 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8397 * Get the float value of "argvars[0]" into "f".
8398 * Returns FAIL when the argument is not a Number or Float.
8400 static int
8401 get_float_arg(argvars, f)
8402 typval_T *argvars;
8403 float_T *f;
8405 if (argvars[0].v_type == VAR_FLOAT)
8407 *f = argvars[0].vval.v_float;
8408 return OK;
8410 if (argvars[0].v_type == VAR_NUMBER)
8412 *f = (float_T)argvars[0].vval.v_number;
8413 return OK;
8415 EMSG(_("E808: Number or Float required"));
8416 return FAIL;
8420 * "atan()" function
8422 static void
8423 f_atan(argvars, rettv)
8424 typval_T *argvars;
8425 typval_T *rettv;
8427 float_T f;
8429 rettv->v_type = VAR_FLOAT;
8430 if (get_float_arg(argvars, &f) == OK)
8431 rettv->vval.v_float = atan(f);
8432 else
8433 rettv->vval.v_float = 0.0;
8435 #endif
8438 * "browse(save, title, initdir, default)" function
8440 static void
8441 f_browse(argvars, rettv)
8442 typval_T *argvars UNUSED;
8443 typval_T *rettv;
8445 #ifdef FEAT_BROWSE
8446 int save;
8447 char_u *title;
8448 char_u *initdir;
8449 char_u *defname;
8450 char_u buf[NUMBUFLEN];
8451 char_u buf2[NUMBUFLEN];
8452 int error = FALSE;
8454 save = get_tv_number_chk(&argvars[0], &error);
8455 title = get_tv_string_chk(&argvars[1]);
8456 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8457 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8459 if (error || title == NULL || initdir == NULL || defname == NULL)
8460 rettv->vval.v_string = NULL;
8461 else
8462 rettv->vval.v_string =
8463 do_browse(save ? BROWSE_SAVE : 0,
8464 title, defname, NULL, initdir, NULL, curbuf);
8465 #else
8466 rettv->vval.v_string = NULL;
8467 #endif
8468 rettv->v_type = VAR_STRING;
8472 * "browsedir(title, initdir)" function
8474 static void
8475 f_browsedir(argvars, rettv)
8476 typval_T *argvars UNUSED;
8477 typval_T *rettv;
8479 #ifdef FEAT_BROWSE
8480 char_u *title;
8481 char_u *initdir;
8482 char_u buf[NUMBUFLEN];
8484 title = get_tv_string_chk(&argvars[0]);
8485 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8487 if (title == NULL || initdir == NULL)
8488 rettv->vval.v_string = NULL;
8489 else
8490 rettv->vval.v_string = do_browse(BROWSE_DIR,
8491 title, NULL, NULL, initdir, NULL, curbuf);
8492 #else
8493 rettv->vval.v_string = NULL;
8494 #endif
8495 rettv->v_type = VAR_STRING;
8498 static buf_T *find_buffer __ARGS((typval_T *avar));
8501 * Find a buffer by number or exact name.
8503 static buf_T *
8504 find_buffer(avar)
8505 typval_T *avar;
8507 buf_T *buf = NULL;
8509 if (avar->v_type == VAR_NUMBER)
8510 buf = buflist_findnr((int)avar->vval.v_number);
8511 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8513 buf = buflist_findname_exp(avar->vval.v_string);
8514 if (buf == NULL)
8516 /* No full path name match, try a match with a URL or a "nofile"
8517 * buffer, these don't use the full path. */
8518 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8519 if (buf->b_fname != NULL
8520 && (path_with_url(buf->b_fname)
8521 #ifdef FEAT_QUICKFIX
8522 || bt_nofile(buf)
8523 #endif
8525 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8526 break;
8529 return buf;
8533 * "bufexists(expr)" function
8535 static void
8536 f_bufexists(argvars, rettv)
8537 typval_T *argvars;
8538 typval_T *rettv;
8540 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8544 * "buflisted(expr)" function
8546 static void
8547 f_buflisted(argvars, rettv)
8548 typval_T *argvars;
8549 typval_T *rettv;
8551 buf_T *buf;
8553 buf = find_buffer(&argvars[0]);
8554 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8558 * "bufloaded(expr)" function
8560 static void
8561 f_bufloaded(argvars, rettv)
8562 typval_T *argvars;
8563 typval_T *rettv;
8565 buf_T *buf;
8567 buf = find_buffer(&argvars[0]);
8568 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8571 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8574 * Get buffer by number or pattern.
8576 static buf_T *
8577 get_buf_tv(tv)
8578 typval_T *tv;
8580 char_u *name = tv->vval.v_string;
8581 int save_magic;
8582 char_u *save_cpo;
8583 buf_T *buf;
8585 if (tv->v_type == VAR_NUMBER)
8586 return buflist_findnr((int)tv->vval.v_number);
8587 if (tv->v_type != VAR_STRING)
8588 return NULL;
8589 if (name == NULL || *name == NUL)
8590 return curbuf;
8591 if (name[0] == '$' && name[1] == NUL)
8592 return lastbuf;
8594 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8595 save_magic = p_magic;
8596 p_magic = TRUE;
8597 save_cpo = p_cpo;
8598 p_cpo = (char_u *)"";
8600 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8601 TRUE, FALSE));
8603 p_magic = save_magic;
8604 p_cpo = save_cpo;
8606 /* If not found, try expanding the name, like done for bufexists(). */
8607 if (buf == NULL)
8608 buf = find_buffer(tv);
8610 return buf;
8614 * "bufname(expr)" function
8616 static void
8617 f_bufname(argvars, rettv)
8618 typval_T *argvars;
8619 typval_T *rettv;
8621 buf_T *buf;
8623 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8624 ++emsg_off;
8625 buf = get_buf_tv(&argvars[0]);
8626 rettv->v_type = VAR_STRING;
8627 if (buf != NULL && buf->b_fname != NULL)
8628 rettv->vval.v_string = vim_strsave(buf->b_fname);
8629 else
8630 rettv->vval.v_string = NULL;
8631 --emsg_off;
8635 * "bufnr(expr)" function
8637 static void
8638 f_bufnr(argvars, rettv)
8639 typval_T *argvars;
8640 typval_T *rettv;
8642 buf_T *buf;
8643 int error = FALSE;
8644 char_u *name;
8646 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8647 ++emsg_off;
8648 buf = get_buf_tv(&argvars[0]);
8649 --emsg_off;
8651 /* If the buffer isn't found and the second argument is not zero create a
8652 * new buffer. */
8653 if (buf == NULL
8654 && argvars[1].v_type != VAR_UNKNOWN
8655 && get_tv_number_chk(&argvars[1], &error) != 0
8656 && !error
8657 && (name = get_tv_string_chk(&argvars[0])) != NULL
8658 && !error)
8659 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8661 if (buf != NULL)
8662 rettv->vval.v_number = buf->b_fnum;
8663 else
8664 rettv->vval.v_number = -1;
8668 * "bufwinnr(nr)" function
8670 static void
8671 f_bufwinnr(argvars, rettv)
8672 typval_T *argvars;
8673 typval_T *rettv;
8675 #ifdef FEAT_WINDOWS
8676 win_T *wp;
8677 int winnr = 0;
8678 #endif
8679 buf_T *buf;
8681 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8682 ++emsg_off;
8683 buf = get_buf_tv(&argvars[0]);
8684 #ifdef FEAT_WINDOWS
8685 for (wp = firstwin; wp; wp = wp->w_next)
8687 ++winnr;
8688 if (wp->w_buffer == buf)
8689 break;
8691 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8692 #else
8693 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8694 #endif
8695 --emsg_off;
8699 * "byte2line(byte)" function
8701 static void
8702 f_byte2line(argvars, rettv)
8703 typval_T *argvars UNUSED;
8704 typval_T *rettv;
8706 #ifndef FEAT_BYTEOFF
8707 rettv->vval.v_number = -1;
8708 #else
8709 long boff = 0;
8711 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8712 if (boff < 0)
8713 rettv->vval.v_number = -1;
8714 else
8715 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8716 (linenr_T)0, &boff);
8717 #endif
8721 * "byteidx()" function
8723 static void
8724 f_byteidx(argvars, rettv)
8725 typval_T *argvars;
8726 typval_T *rettv;
8728 #ifdef FEAT_MBYTE
8729 char_u *t;
8730 #endif
8731 char_u *str;
8732 long idx;
8734 str = get_tv_string_chk(&argvars[0]);
8735 idx = get_tv_number_chk(&argvars[1], NULL);
8736 rettv->vval.v_number = -1;
8737 if (str == NULL || idx < 0)
8738 return;
8740 #ifdef FEAT_MBYTE
8741 t = str;
8742 for ( ; idx > 0; idx--)
8744 if (*t == NUL) /* EOL reached */
8745 return;
8746 t += (*mb_ptr2len)(t);
8748 rettv->vval.v_number = (varnumber_T)(t - str);
8749 #else
8750 if ((size_t)idx <= STRLEN(str))
8751 rettv->vval.v_number = idx;
8752 #endif
8756 * "call(func, arglist)" function
8758 static void
8759 f_call(argvars, rettv)
8760 typval_T *argvars;
8761 typval_T *rettv;
8763 char_u *func;
8764 typval_T argv[MAX_FUNC_ARGS + 1];
8765 int argc = 0;
8766 listitem_T *item;
8767 int dummy;
8768 dict_T *selfdict = NULL;
8770 if (argvars[1].v_type != VAR_LIST)
8772 EMSG(_(e_listreq));
8773 return;
8775 if (argvars[1].vval.v_list == NULL)
8776 return;
8778 if (argvars[0].v_type == VAR_FUNC)
8779 func = argvars[0].vval.v_string;
8780 else
8781 func = get_tv_string(&argvars[0]);
8782 if (*func == NUL)
8783 return; /* type error or empty name */
8785 if (argvars[2].v_type != VAR_UNKNOWN)
8787 if (argvars[2].v_type != VAR_DICT)
8789 EMSG(_(e_dictreq));
8790 return;
8792 selfdict = argvars[2].vval.v_dict;
8795 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8796 item = item->li_next)
8798 if (argc == MAX_FUNC_ARGS)
8800 EMSG(_("E699: Too many arguments"));
8801 break;
8803 /* Make a copy of each argument. This is needed to be able to set
8804 * v_lock to VAR_FIXED in the copy without changing the original list.
8806 copy_tv(&item->li_tv, &argv[argc++]);
8809 if (item == NULL)
8810 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8811 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8812 &dummy, TRUE, selfdict);
8814 /* Free the arguments. */
8815 while (argc > 0)
8816 clear_tv(&argv[--argc]);
8819 #ifdef FEAT_FLOAT
8821 * "ceil({float})" function
8823 static void
8824 f_ceil(argvars, rettv)
8825 typval_T *argvars;
8826 typval_T *rettv;
8828 float_T f;
8830 rettv->v_type = VAR_FLOAT;
8831 if (get_float_arg(argvars, &f) == OK)
8832 rettv->vval.v_float = ceil(f);
8833 else
8834 rettv->vval.v_float = 0.0;
8836 #endif
8839 * "changenr()" function
8841 static void
8842 f_changenr(argvars, rettv)
8843 typval_T *argvars UNUSED;
8844 typval_T *rettv;
8846 rettv->vval.v_number = curbuf->b_u_seq_cur;
8850 * "char2nr(string)" function
8852 static void
8853 f_char2nr(argvars, rettv)
8854 typval_T *argvars;
8855 typval_T *rettv;
8857 #ifdef FEAT_MBYTE
8858 if (has_mbyte)
8859 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8860 else
8861 #endif
8862 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8866 * "cindent(lnum)" function
8868 static void
8869 f_cindent(argvars, rettv)
8870 typval_T *argvars;
8871 typval_T *rettv;
8873 #ifdef FEAT_CINDENT
8874 pos_T pos;
8875 linenr_T lnum;
8877 pos = curwin->w_cursor;
8878 lnum = get_tv_lnum(argvars);
8879 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8881 curwin->w_cursor.lnum = lnum;
8882 rettv->vval.v_number = get_c_indent();
8883 curwin->w_cursor = pos;
8885 else
8886 #endif
8887 rettv->vval.v_number = -1;
8891 * "clearmatches()" function
8893 static void
8894 f_clearmatches(argvars, rettv)
8895 typval_T *argvars UNUSED;
8896 typval_T *rettv UNUSED;
8898 #ifdef FEAT_SEARCH_EXTRA
8899 clear_matches(curwin);
8900 #endif
8904 * "col(string)" function
8906 static void
8907 f_col(argvars, rettv)
8908 typval_T *argvars;
8909 typval_T *rettv;
8911 colnr_T col = 0;
8912 pos_T *fp;
8913 int fnum = curbuf->b_fnum;
8915 fp = var2fpos(&argvars[0], FALSE, &fnum);
8916 if (fp != NULL && fnum == curbuf->b_fnum)
8918 if (fp->col == MAXCOL)
8920 /* '> can be MAXCOL, get the length of the line then */
8921 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8922 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8923 else
8924 col = MAXCOL;
8926 else
8928 col = fp->col + 1;
8929 #ifdef FEAT_VIRTUALEDIT
8930 /* col(".") when the cursor is on the NUL at the end of the line
8931 * because of "coladd" can be seen as an extra column. */
8932 if (virtual_active() && fp == &curwin->w_cursor)
8934 char_u *p = ml_get_cursor();
8936 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8937 curwin->w_virtcol - curwin->w_cursor.coladd))
8939 # ifdef FEAT_MBYTE
8940 int l;
8942 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8943 col += l;
8944 # else
8945 if (*p != NUL && p[1] == NUL)
8946 ++col;
8947 # endif
8950 #endif
8953 rettv->vval.v_number = col;
8956 #if defined(FEAT_INS_EXPAND)
8958 * "complete()" function
8960 static void
8961 f_complete(argvars, rettv)
8962 typval_T *argvars;
8963 typval_T *rettv UNUSED;
8965 int startcol;
8967 if ((State & INSERT) == 0)
8969 EMSG(_("E785: complete() can only be used in Insert mode"));
8970 return;
8973 /* Check for undo allowed here, because if something was already inserted
8974 * the line was already saved for undo and this check isn't done. */
8975 if (!undo_allowed())
8976 return;
8978 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8980 EMSG(_(e_invarg));
8981 return;
8984 startcol = get_tv_number_chk(&argvars[0], NULL);
8985 if (startcol <= 0)
8986 return;
8988 set_completion(startcol - 1, argvars[1].vval.v_list);
8992 * "complete_add()" function
8994 static void
8995 f_complete_add(argvars, rettv)
8996 typval_T *argvars;
8997 typval_T *rettv;
8999 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
9003 * "complete_check()" function
9005 static void
9006 f_complete_check(argvars, rettv)
9007 typval_T *argvars UNUSED;
9008 typval_T *rettv;
9010 int saved = RedrawingDisabled;
9012 RedrawingDisabled = 0;
9013 ins_compl_check_keys(0);
9014 rettv->vval.v_number = compl_interrupted;
9015 RedrawingDisabled = saved;
9017 #endif
9020 * "confirm(message, buttons[, default [, type]])" function
9022 static void
9023 f_confirm(argvars, rettv)
9024 typval_T *argvars UNUSED;
9025 typval_T *rettv UNUSED;
9027 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
9028 char_u *message;
9029 char_u *buttons = NULL;
9030 char_u buf[NUMBUFLEN];
9031 char_u buf2[NUMBUFLEN];
9032 int def = 1;
9033 int type = VIM_GENERIC;
9034 char_u *typestr;
9035 int error = FALSE;
9037 message = get_tv_string_chk(&argvars[0]);
9038 if (message == NULL)
9039 error = TRUE;
9040 if (argvars[1].v_type != VAR_UNKNOWN)
9042 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9043 if (buttons == NULL)
9044 error = TRUE;
9045 if (argvars[2].v_type != VAR_UNKNOWN)
9047 def = get_tv_number_chk(&argvars[2], &error);
9048 if (argvars[3].v_type != VAR_UNKNOWN)
9050 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9051 if (typestr == NULL)
9052 error = TRUE;
9053 else
9055 switch (TOUPPER_ASC(*typestr))
9057 case 'E': type = VIM_ERROR; break;
9058 case 'Q': type = VIM_QUESTION; break;
9059 case 'I': type = VIM_INFO; break;
9060 case 'W': type = VIM_WARNING; break;
9061 case 'G': type = VIM_GENERIC; break;
9068 if (buttons == NULL || *buttons == NUL)
9069 buttons = (char_u *)_("&Ok");
9071 if (!error)
9072 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9073 def, NULL);
9074 #endif
9078 * "copy()" function
9080 static void
9081 f_copy(argvars, rettv)
9082 typval_T *argvars;
9083 typval_T *rettv;
9085 item_copy(&argvars[0], rettv, FALSE, 0);
9088 #ifdef FEAT_FLOAT
9090 * "cos()" function
9092 static void
9093 f_cos(argvars, rettv)
9094 typval_T *argvars;
9095 typval_T *rettv;
9097 float_T f;
9099 rettv->v_type = VAR_FLOAT;
9100 if (get_float_arg(argvars, &f) == OK)
9101 rettv->vval.v_float = cos(f);
9102 else
9103 rettv->vval.v_float = 0.0;
9105 #endif
9108 * "count()" function
9110 static void
9111 f_count(argvars, rettv)
9112 typval_T *argvars;
9113 typval_T *rettv;
9115 long n = 0;
9116 int ic = FALSE;
9118 if (argvars[0].v_type == VAR_LIST)
9120 listitem_T *li;
9121 list_T *l;
9122 long idx;
9124 if ((l = argvars[0].vval.v_list) != NULL)
9126 li = l->lv_first;
9127 if (argvars[2].v_type != VAR_UNKNOWN)
9129 int error = FALSE;
9131 ic = get_tv_number_chk(&argvars[2], &error);
9132 if (argvars[3].v_type != VAR_UNKNOWN)
9134 idx = get_tv_number_chk(&argvars[3], &error);
9135 if (!error)
9137 li = list_find(l, idx);
9138 if (li == NULL)
9139 EMSGN(_(e_listidx), idx);
9142 if (error)
9143 li = NULL;
9146 for ( ; li != NULL; li = li->li_next)
9147 if (tv_equal(&li->li_tv, &argvars[1], ic))
9148 ++n;
9151 else if (argvars[0].v_type == VAR_DICT)
9153 int todo;
9154 dict_T *d;
9155 hashitem_T *hi;
9157 if ((d = argvars[0].vval.v_dict) != NULL)
9159 int error = FALSE;
9161 if (argvars[2].v_type != VAR_UNKNOWN)
9163 ic = get_tv_number_chk(&argvars[2], &error);
9164 if (argvars[3].v_type != VAR_UNKNOWN)
9165 EMSG(_(e_invarg));
9168 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9169 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9171 if (!HASHITEM_EMPTY(hi))
9173 --todo;
9174 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9175 ++n;
9180 else
9181 EMSG2(_(e_listdictarg), "count()");
9182 rettv->vval.v_number = n;
9186 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9188 * Checks the existence of a cscope connection.
9190 static void
9191 f_cscope_connection(argvars, rettv)
9192 typval_T *argvars UNUSED;
9193 typval_T *rettv UNUSED;
9195 #ifdef FEAT_CSCOPE
9196 int num = 0;
9197 char_u *dbpath = NULL;
9198 char_u *prepend = NULL;
9199 char_u buf[NUMBUFLEN];
9201 if (argvars[0].v_type != VAR_UNKNOWN
9202 && argvars[1].v_type != VAR_UNKNOWN)
9204 num = (int)get_tv_number(&argvars[0]);
9205 dbpath = get_tv_string(&argvars[1]);
9206 if (argvars[2].v_type != VAR_UNKNOWN)
9207 prepend = get_tv_string_buf(&argvars[2], buf);
9210 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9211 #endif
9215 * "cursor(lnum, col)" function
9217 * Moves the cursor to the specified line and column.
9218 * Returns 0 when the position could be set, -1 otherwise.
9220 static void
9221 f_cursor(argvars, rettv)
9222 typval_T *argvars;
9223 typval_T *rettv;
9225 long line, col;
9226 #ifdef FEAT_VIRTUALEDIT
9227 long coladd = 0;
9228 #endif
9230 rettv->vval.v_number = -1;
9231 if (argvars[1].v_type == VAR_UNKNOWN)
9233 pos_T pos;
9235 if (list2fpos(argvars, &pos, NULL) == FAIL)
9236 return;
9237 line = pos.lnum;
9238 col = pos.col;
9239 #ifdef FEAT_VIRTUALEDIT
9240 coladd = pos.coladd;
9241 #endif
9243 else
9245 line = get_tv_lnum(argvars);
9246 col = get_tv_number_chk(&argvars[1], NULL);
9247 #ifdef FEAT_VIRTUALEDIT
9248 if (argvars[2].v_type != VAR_UNKNOWN)
9249 coladd = get_tv_number_chk(&argvars[2], NULL);
9250 #endif
9252 if (line < 0 || col < 0
9253 #ifdef FEAT_VIRTUALEDIT
9254 || coladd < 0
9255 #endif
9257 return; /* type error; errmsg already given */
9258 if (line > 0)
9259 curwin->w_cursor.lnum = line;
9260 if (col > 0)
9261 curwin->w_cursor.col = col - 1;
9262 #ifdef FEAT_VIRTUALEDIT
9263 curwin->w_cursor.coladd = coladd;
9264 #endif
9266 /* Make sure the cursor is in a valid position. */
9267 check_cursor();
9268 #ifdef FEAT_MBYTE
9269 /* Correct cursor for multi-byte character. */
9270 if (has_mbyte)
9271 mb_adjust_cursor();
9272 #endif
9274 curwin->w_set_curswant = TRUE;
9275 rettv->vval.v_number = 0;
9279 * "deepcopy()" function
9281 static void
9282 f_deepcopy(argvars, rettv)
9283 typval_T *argvars;
9284 typval_T *rettv;
9286 int noref = 0;
9288 if (argvars[1].v_type != VAR_UNKNOWN)
9289 noref = get_tv_number_chk(&argvars[1], NULL);
9290 if (noref < 0 || noref > 1)
9291 EMSG(_(e_invarg));
9292 else
9294 current_copyID += COPYID_INC;
9295 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? current_copyID : 0);
9300 * "delete()" function
9302 static void
9303 f_delete(argvars, rettv)
9304 typval_T *argvars;
9305 typval_T *rettv;
9307 if (check_restricted() || check_secure())
9308 rettv->vval.v_number = -1;
9309 else
9310 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9314 * "did_filetype()" function
9316 static void
9317 f_did_filetype(argvars, rettv)
9318 typval_T *argvars UNUSED;
9319 typval_T *rettv UNUSED;
9321 #ifdef FEAT_AUTOCMD
9322 rettv->vval.v_number = did_filetype;
9323 #endif
9327 * "diff_filler()" function
9329 static void
9330 f_diff_filler(argvars, rettv)
9331 typval_T *argvars UNUSED;
9332 typval_T *rettv UNUSED;
9334 #ifdef FEAT_DIFF
9335 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9336 #endif
9340 * "diff_hlID()" function
9342 static void
9343 f_diff_hlID(argvars, rettv)
9344 typval_T *argvars UNUSED;
9345 typval_T *rettv UNUSED;
9347 #ifdef FEAT_DIFF
9348 linenr_T lnum = get_tv_lnum(argvars);
9349 static linenr_T prev_lnum = 0;
9350 static int changedtick = 0;
9351 static int fnum = 0;
9352 static int change_start = 0;
9353 static int change_end = 0;
9354 static hlf_T hlID = (hlf_T)0;
9355 int filler_lines;
9356 int col;
9358 if (lnum < 0) /* ignore type error in {lnum} arg */
9359 lnum = 0;
9360 if (lnum != prev_lnum
9361 || changedtick != curbuf->b_changedtick
9362 || fnum != curbuf->b_fnum)
9364 /* New line, buffer, change: need to get the values. */
9365 filler_lines = diff_check(curwin, lnum);
9366 if (filler_lines < 0)
9368 if (filler_lines == -1)
9370 change_start = MAXCOL;
9371 change_end = -1;
9372 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9373 hlID = HLF_ADD; /* added line */
9374 else
9375 hlID = HLF_CHD; /* changed line */
9377 else
9378 hlID = HLF_ADD; /* added line */
9380 else
9381 hlID = (hlf_T)0;
9382 prev_lnum = lnum;
9383 changedtick = curbuf->b_changedtick;
9384 fnum = curbuf->b_fnum;
9387 if (hlID == HLF_CHD || hlID == HLF_TXD)
9389 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9390 if (col >= change_start && col <= change_end)
9391 hlID = HLF_TXD; /* changed text */
9392 else
9393 hlID = HLF_CHD; /* changed line */
9395 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9396 #endif
9400 * "empty({expr})" function
9402 static void
9403 f_empty(argvars, rettv)
9404 typval_T *argvars;
9405 typval_T *rettv;
9407 int n;
9409 switch (argvars[0].v_type)
9411 case VAR_STRING:
9412 case VAR_FUNC:
9413 n = argvars[0].vval.v_string == NULL
9414 || *argvars[0].vval.v_string == NUL;
9415 break;
9416 case VAR_NUMBER:
9417 n = argvars[0].vval.v_number == 0;
9418 break;
9419 #ifdef FEAT_FLOAT
9420 case VAR_FLOAT:
9421 n = argvars[0].vval.v_float == 0.0;
9422 break;
9423 #endif
9424 case VAR_LIST:
9425 n = argvars[0].vval.v_list == NULL
9426 || argvars[0].vval.v_list->lv_first == NULL;
9427 break;
9428 case VAR_DICT:
9429 n = argvars[0].vval.v_dict == NULL
9430 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9431 break;
9432 default:
9433 EMSG2(_(e_intern2), "f_empty()");
9434 n = 0;
9437 rettv->vval.v_number = n;
9441 * "escape({string}, {chars})" function
9443 static void
9444 f_escape(argvars, rettv)
9445 typval_T *argvars;
9446 typval_T *rettv;
9448 char_u buf[NUMBUFLEN];
9450 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9451 get_tv_string_buf(&argvars[1], buf));
9452 rettv->v_type = VAR_STRING;
9456 * "eval()" function
9458 static void
9459 f_eval(argvars, rettv)
9460 typval_T *argvars;
9461 typval_T *rettv;
9463 char_u *s;
9465 s = get_tv_string_chk(&argvars[0]);
9466 if (s != NULL)
9467 s = skipwhite(s);
9469 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9471 rettv->v_type = VAR_NUMBER;
9472 rettv->vval.v_number = 0;
9474 else if (*s != NUL)
9475 EMSG(_(e_trailing));
9479 * "eventhandler()" function
9481 static void
9482 f_eventhandler(argvars, rettv)
9483 typval_T *argvars UNUSED;
9484 typval_T *rettv;
9486 rettv->vval.v_number = vgetc_busy;
9490 * "executable()" function
9492 static void
9493 f_executable(argvars, rettv)
9494 typval_T *argvars;
9495 typval_T *rettv;
9497 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9501 * "exists()" function
9503 static void
9504 f_exists(argvars, rettv)
9505 typval_T *argvars;
9506 typval_T *rettv;
9508 char_u *p;
9509 char_u *name;
9510 int n = FALSE;
9511 int len = 0;
9513 p = get_tv_string(&argvars[0]);
9514 if (*p == '$') /* environment variable */
9516 /* first try "normal" environment variables (fast) */
9517 if (mch_getenv(p + 1) != NULL)
9518 n = TRUE;
9519 else
9521 /* try expanding things like $VIM and ${HOME} */
9522 p = expand_env_save(p);
9523 if (p != NULL && *p != '$')
9524 n = TRUE;
9525 vim_free(p);
9528 else if (*p == '&' || *p == '+') /* option */
9530 n = (get_option_tv(&p, NULL, TRUE) == OK);
9531 if (*skipwhite(p) != NUL)
9532 n = FALSE; /* trailing garbage */
9534 else if (*p == '*') /* internal or user defined function */
9536 n = function_exists(p + 1);
9538 else if (*p == ':')
9540 n = cmd_exists(p + 1);
9542 else if (*p == '#')
9544 #ifdef FEAT_AUTOCMD
9545 if (p[1] == '#')
9546 n = autocmd_supported(p + 2);
9547 else
9548 n = au_exists(p + 1);
9549 #endif
9551 else /* internal variable */
9553 char_u *tofree;
9554 typval_T tv;
9556 /* get_name_len() takes care of expanding curly braces */
9557 name = p;
9558 len = get_name_len(&p, &tofree, TRUE, FALSE);
9559 if (len > 0)
9561 if (tofree != NULL)
9562 name = tofree;
9563 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9564 if (n)
9566 /* handle d.key, l[idx], f(expr) */
9567 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9568 if (n)
9569 clear_tv(&tv);
9572 if (*p != NUL)
9573 n = FALSE;
9575 vim_free(tofree);
9578 rettv->vval.v_number = n;
9582 * "expand()" function
9584 static void
9585 f_expand(argvars, rettv)
9586 typval_T *argvars;
9587 typval_T *rettv;
9589 char_u *s;
9590 int len;
9591 char_u *errormsg;
9592 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9593 expand_T xpc;
9594 int error = FALSE;
9596 rettv->v_type = VAR_STRING;
9597 s = get_tv_string(&argvars[0]);
9598 if (*s == '%' || *s == '#' || *s == '<')
9600 ++emsg_off;
9601 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9602 --emsg_off;
9604 else
9606 /* When the optional second argument is non-zero, don't remove matches
9607 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9608 if (argvars[1].v_type != VAR_UNKNOWN
9609 && get_tv_number_chk(&argvars[1], &error))
9610 flags |= WILD_KEEP_ALL;
9611 if (!error)
9613 ExpandInit(&xpc);
9614 xpc.xp_context = EXPAND_FILES;
9615 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9617 else
9618 rettv->vval.v_string = NULL;
9623 * "extend(list, list [, idx])" function
9624 * "extend(dict, dict [, action])" function
9626 static void
9627 f_extend(argvars, rettv)
9628 typval_T *argvars;
9629 typval_T *rettv;
9631 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9633 list_T *l1, *l2;
9634 listitem_T *item;
9635 long before;
9636 int error = FALSE;
9638 l1 = argvars[0].vval.v_list;
9639 l2 = argvars[1].vval.v_list;
9640 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9641 && l2 != NULL)
9643 if (argvars[2].v_type != VAR_UNKNOWN)
9645 before = get_tv_number_chk(&argvars[2], &error);
9646 if (error)
9647 return; /* type error; errmsg already given */
9649 if (before == l1->lv_len)
9650 item = NULL;
9651 else
9653 item = list_find(l1, before);
9654 if (item == NULL)
9656 EMSGN(_(e_listidx), before);
9657 return;
9661 else
9662 item = NULL;
9663 list_extend(l1, l2, item);
9665 copy_tv(&argvars[0], rettv);
9668 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9670 dict_T *d1, *d2;
9671 dictitem_T *di1;
9672 char_u *action;
9673 int i;
9674 hashitem_T *hi2;
9675 int todo;
9677 d1 = argvars[0].vval.v_dict;
9678 d2 = argvars[1].vval.v_dict;
9679 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9680 && d2 != NULL)
9682 /* Check the third argument. */
9683 if (argvars[2].v_type != VAR_UNKNOWN)
9685 static char *(av[]) = {"keep", "force", "error"};
9687 action = get_tv_string_chk(&argvars[2]);
9688 if (action == NULL)
9689 return; /* type error; errmsg already given */
9690 for (i = 0; i < 3; ++i)
9691 if (STRCMP(action, av[i]) == 0)
9692 break;
9693 if (i == 3)
9695 EMSG2(_(e_invarg2), action);
9696 return;
9699 else
9700 action = (char_u *)"force";
9702 /* Go over all entries in the second dict and add them to the
9703 * first dict. */
9704 todo = (int)d2->dv_hashtab.ht_used;
9705 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9707 if (!HASHITEM_EMPTY(hi2))
9709 --todo;
9710 di1 = dict_find(d1, hi2->hi_key, -1);
9711 if (di1 == NULL)
9713 di1 = dictitem_copy(HI2DI(hi2));
9714 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9715 dictitem_free(di1);
9717 else if (*action == 'e')
9719 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9720 break;
9722 else if (*action == 'f')
9724 clear_tv(&di1->di_tv);
9725 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9730 copy_tv(&argvars[0], rettv);
9733 else
9734 EMSG2(_(e_listdictarg), "extend()");
9738 * "feedkeys()" function
9740 static void
9741 f_feedkeys(argvars, rettv)
9742 typval_T *argvars;
9743 typval_T *rettv UNUSED;
9745 int remap = TRUE;
9746 char_u *keys, *flags;
9747 char_u nbuf[NUMBUFLEN];
9748 int typed = FALSE;
9749 char_u *keys_esc;
9751 /* This is not allowed in the sandbox. If the commands would still be
9752 * executed in the sandbox it would be OK, but it probably happens later,
9753 * when "sandbox" is no longer set. */
9754 if (check_secure())
9755 return;
9757 keys = get_tv_string(&argvars[0]);
9758 if (*keys != NUL)
9760 if (argvars[1].v_type != VAR_UNKNOWN)
9762 flags = get_tv_string_buf(&argvars[1], nbuf);
9763 for ( ; *flags != NUL; ++flags)
9765 switch (*flags)
9767 case 'n': remap = FALSE; break;
9768 case 'm': remap = TRUE; break;
9769 case 't': typed = TRUE; break;
9774 /* Need to escape K_SPECIAL and CSI before putting the string in the
9775 * typeahead buffer. */
9776 keys_esc = vim_strsave_escape_csi(keys);
9777 if (keys_esc != NULL)
9779 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9780 typebuf.tb_len, !typed, FALSE);
9781 vim_free(keys_esc);
9782 if (vgetc_busy)
9783 typebuf_was_filled = TRUE;
9789 * "filereadable()" function
9791 static void
9792 f_filereadable(argvars, rettv)
9793 typval_T *argvars;
9794 typval_T *rettv;
9796 int fd;
9797 char_u *p;
9798 int n;
9800 #ifndef O_NONBLOCK
9801 # define O_NONBLOCK 0
9802 #endif
9803 p = get_tv_string(&argvars[0]);
9804 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9805 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9807 n = TRUE;
9808 close(fd);
9810 else
9811 n = FALSE;
9813 rettv->vval.v_number = n;
9817 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9818 * rights to write into.
9820 static void
9821 f_filewritable(argvars, rettv)
9822 typval_T *argvars;
9823 typval_T *rettv;
9825 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9828 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9830 static void
9831 findfilendir(argvars, rettv, find_what)
9832 typval_T *argvars;
9833 typval_T *rettv;
9834 int find_what;
9836 #ifdef FEAT_SEARCHPATH
9837 char_u *fname;
9838 char_u *fresult = NULL;
9839 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9840 char_u *p;
9841 char_u pathbuf[NUMBUFLEN];
9842 int count = 1;
9843 int first = TRUE;
9844 int error = FALSE;
9845 #endif
9847 rettv->vval.v_string = NULL;
9848 rettv->v_type = VAR_STRING;
9850 #ifdef FEAT_SEARCHPATH
9851 fname = get_tv_string(&argvars[0]);
9853 if (argvars[1].v_type != VAR_UNKNOWN)
9855 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9856 if (p == NULL)
9857 error = TRUE;
9858 else
9860 if (*p != NUL)
9861 path = p;
9863 if (argvars[2].v_type != VAR_UNKNOWN)
9864 count = get_tv_number_chk(&argvars[2], &error);
9868 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9869 error = TRUE;
9871 if (*fname != NUL && !error)
9875 if (rettv->v_type == VAR_STRING)
9876 vim_free(fresult);
9877 fresult = find_file_in_path_option(first ? fname : NULL,
9878 first ? (int)STRLEN(fname) : 0,
9879 0, first, path,
9880 find_what,
9881 curbuf->b_ffname,
9882 find_what == FINDFILE_DIR
9883 ? (char_u *)"" : curbuf->b_p_sua);
9884 first = FALSE;
9886 if (fresult != NULL && rettv->v_type == VAR_LIST)
9887 list_append_string(rettv->vval.v_list, fresult, -1);
9889 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9892 if (rettv->v_type == VAR_STRING)
9893 rettv->vval.v_string = fresult;
9894 #endif
9897 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9898 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9901 * Implementation of map() and filter().
9903 static void
9904 filter_map(argvars, rettv, map)
9905 typval_T *argvars;
9906 typval_T *rettv;
9907 int map;
9909 char_u buf[NUMBUFLEN];
9910 char_u *expr;
9911 listitem_T *li, *nli;
9912 list_T *l = NULL;
9913 dictitem_T *di;
9914 hashtab_T *ht;
9915 hashitem_T *hi;
9916 dict_T *d = NULL;
9917 typval_T save_val;
9918 typval_T save_key;
9919 int rem;
9920 int todo;
9921 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9922 int save_did_emsg;
9924 if (argvars[0].v_type == VAR_LIST)
9926 if ((l = argvars[0].vval.v_list) == NULL
9927 || (map && tv_check_lock(l->lv_lock, ermsg)))
9928 return;
9930 else if (argvars[0].v_type == VAR_DICT)
9932 if ((d = argvars[0].vval.v_dict) == NULL
9933 || (map && tv_check_lock(d->dv_lock, ermsg)))
9934 return;
9936 else
9938 EMSG2(_(e_listdictarg), ermsg);
9939 return;
9942 expr = get_tv_string_buf_chk(&argvars[1], buf);
9943 /* On type errors, the preceding call has already displayed an error
9944 * message. Avoid a misleading error message for an empty string that
9945 * was not passed as argument. */
9946 if (expr != NULL)
9948 prepare_vimvar(VV_VAL, &save_val);
9949 expr = skipwhite(expr);
9951 /* We reset "did_emsg" to be able to detect whether an error
9952 * occurred during evaluation of the expression. */
9953 save_did_emsg = did_emsg;
9954 did_emsg = FALSE;
9956 if (argvars[0].v_type == VAR_DICT)
9958 prepare_vimvar(VV_KEY, &save_key);
9959 vimvars[VV_KEY].vv_type = VAR_STRING;
9961 ht = &d->dv_hashtab;
9962 hash_lock(ht);
9963 todo = (int)ht->ht_used;
9964 for (hi = ht->ht_array; todo > 0; ++hi)
9966 if (!HASHITEM_EMPTY(hi))
9968 --todo;
9969 di = HI2DI(hi);
9970 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9971 break;
9972 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9973 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9974 || did_emsg)
9975 break;
9976 if (!map && rem)
9977 dictitem_remove(d, di);
9978 clear_tv(&vimvars[VV_KEY].vv_tv);
9981 hash_unlock(ht);
9983 restore_vimvar(VV_KEY, &save_key);
9985 else
9987 for (li = l->lv_first; li != NULL; li = nli)
9989 if (tv_check_lock(li->li_tv.v_lock, ermsg))
9990 break;
9991 nli = li->li_next;
9992 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
9993 || did_emsg)
9994 break;
9995 if (!map && rem)
9996 listitem_remove(l, li);
10000 restore_vimvar(VV_VAL, &save_val);
10002 did_emsg |= save_did_emsg;
10005 copy_tv(&argvars[0], rettv);
10008 static int
10009 filter_map_one(tv, expr, map, remp)
10010 typval_T *tv;
10011 char_u *expr;
10012 int map;
10013 int *remp;
10015 typval_T rettv;
10016 char_u *s;
10017 int retval = FAIL;
10019 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10020 s = expr;
10021 if (eval1(&s, &rettv, TRUE) == FAIL)
10022 goto theend;
10023 if (*s != NUL) /* check for trailing chars after expr */
10025 EMSG2(_(e_invexpr2), s);
10026 goto theend;
10028 if (map)
10030 /* map(): replace the list item value */
10031 clear_tv(tv);
10032 rettv.v_lock = 0;
10033 *tv = rettv;
10035 else
10037 int error = FALSE;
10039 /* filter(): when expr is zero remove the item */
10040 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10041 clear_tv(&rettv);
10042 /* On type error, nothing has been removed; return FAIL to stop the
10043 * loop. The error message was given by get_tv_number_chk(). */
10044 if (error)
10045 goto theend;
10047 retval = OK;
10048 theend:
10049 clear_tv(&vimvars[VV_VAL].vv_tv);
10050 return retval;
10054 * "filter()" function
10056 static void
10057 f_filter(argvars, rettv)
10058 typval_T *argvars;
10059 typval_T *rettv;
10061 filter_map(argvars, rettv, FALSE);
10065 * "finddir({fname}[, {path}[, {count}]])" function
10067 static void
10068 f_finddir(argvars, rettv)
10069 typval_T *argvars;
10070 typval_T *rettv;
10072 findfilendir(argvars, rettv, FINDFILE_DIR);
10076 * "findfile({fname}[, {path}[, {count}]])" function
10078 static void
10079 f_findfile(argvars, rettv)
10080 typval_T *argvars;
10081 typval_T *rettv;
10083 findfilendir(argvars, rettv, FINDFILE_FILE);
10086 #ifdef FEAT_FLOAT
10088 * "float2nr({float})" function
10090 static void
10091 f_float2nr(argvars, rettv)
10092 typval_T *argvars;
10093 typval_T *rettv;
10095 float_T f;
10097 if (get_float_arg(argvars, &f) == OK)
10099 if (f < -0x7fffffff)
10100 rettv->vval.v_number = -0x7fffffff;
10101 else if (f > 0x7fffffff)
10102 rettv->vval.v_number = 0x7fffffff;
10103 else
10104 rettv->vval.v_number = (varnumber_T)f;
10109 * "floor({float})" function
10111 static void
10112 f_floor(argvars, rettv)
10113 typval_T *argvars;
10114 typval_T *rettv;
10116 float_T f;
10118 rettv->v_type = VAR_FLOAT;
10119 if (get_float_arg(argvars, &f) == OK)
10120 rettv->vval.v_float = floor(f);
10121 else
10122 rettv->vval.v_float = 0.0;
10124 #endif
10127 * "fnameescape({string})" function
10129 static void
10130 f_fnameescape(argvars, rettv)
10131 typval_T *argvars;
10132 typval_T *rettv;
10134 rettv->vval.v_string = vim_strsave_fnameescape(
10135 get_tv_string(&argvars[0]), FALSE);
10136 rettv->v_type = VAR_STRING;
10140 * "fnamemodify({fname}, {mods})" function
10142 static void
10143 f_fnamemodify(argvars, rettv)
10144 typval_T *argvars;
10145 typval_T *rettv;
10147 char_u *fname;
10148 char_u *mods;
10149 int usedlen = 0;
10150 int len;
10151 char_u *fbuf = NULL;
10152 char_u buf[NUMBUFLEN];
10154 fname = get_tv_string_chk(&argvars[0]);
10155 mods = get_tv_string_buf_chk(&argvars[1], buf);
10156 if (fname == NULL || mods == NULL)
10157 fname = NULL;
10158 else
10160 len = (int)STRLEN(fname);
10161 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10164 rettv->v_type = VAR_STRING;
10165 if (fname == NULL)
10166 rettv->vval.v_string = NULL;
10167 else
10168 rettv->vval.v_string = vim_strnsave(fname, len);
10169 vim_free(fbuf);
10172 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10175 * "foldclosed()" function
10177 static void
10178 foldclosed_both(argvars, rettv, end)
10179 typval_T *argvars;
10180 typval_T *rettv;
10181 int end;
10183 #ifdef FEAT_FOLDING
10184 linenr_T lnum;
10185 linenr_T first, last;
10187 lnum = get_tv_lnum(argvars);
10188 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10190 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10192 if (end)
10193 rettv->vval.v_number = (varnumber_T)last;
10194 else
10195 rettv->vval.v_number = (varnumber_T)first;
10196 return;
10199 #endif
10200 rettv->vval.v_number = -1;
10204 * "foldclosed()" function
10206 static void
10207 f_foldclosed(argvars, rettv)
10208 typval_T *argvars;
10209 typval_T *rettv;
10211 foldclosed_both(argvars, rettv, FALSE);
10215 * "foldclosedend()" function
10217 static void
10218 f_foldclosedend(argvars, rettv)
10219 typval_T *argvars;
10220 typval_T *rettv;
10222 foldclosed_both(argvars, rettv, TRUE);
10226 * "foldlevel()" function
10228 static void
10229 f_foldlevel(argvars, rettv)
10230 typval_T *argvars;
10231 typval_T *rettv;
10233 #ifdef FEAT_FOLDING
10234 linenr_T lnum;
10236 lnum = get_tv_lnum(argvars);
10237 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10238 rettv->vval.v_number = foldLevel(lnum);
10239 #endif
10243 * "foldtext()" function
10245 static void
10246 f_foldtext(argvars, rettv)
10247 typval_T *argvars UNUSED;
10248 typval_T *rettv;
10250 #ifdef FEAT_FOLDING
10251 linenr_T lnum;
10252 char_u *s;
10253 char_u *r;
10254 int len;
10255 char *txt;
10256 #endif
10258 rettv->v_type = VAR_STRING;
10259 rettv->vval.v_string = NULL;
10260 #ifdef FEAT_FOLDING
10261 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10262 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10263 <= curbuf->b_ml.ml_line_count
10264 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10266 /* Find first non-empty line in the fold. */
10267 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10268 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10270 if (!linewhite(lnum))
10271 break;
10272 ++lnum;
10275 /* Find interesting text in this line. */
10276 s = skipwhite(ml_get(lnum));
10277 /* skip C comment-start */
10278 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10280 s = skipwhite(s + 2);
10281 if (*skipwhite(s) == NUL
10282 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10284 s = skipwhite(ml_get(lnum + 1));
10285 if (*s == '*')
10286 s = skipwhite(s + 1);
10289 txt = _("+-%s%3ld lines: ");
10290 r = alloc((unsigned)(STRLEN(txt)
10291 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10292 + 20 /* for %3ld */
10293 + STRLEN(s))); /* concatenated */
10294 if (r != NULL)
10296 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10297 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10298 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10299 len = (int)STRLEN(r);
10300 STRCAT(r, s);
10301 /* remove 'foldmarker' and 'commentstring' */
10302 foldtext_cleanup(r + len);
10303 rettv->vval.v_string = r;
10306 #endif
10310 * "foldtextresult(lnum)" function
10312 static void
10313 f_foldtextresult(argvars, rettv)
10314 typval_T *argvars UNUSED;
10315 typval_T *rettv;
10317 #ifdef FEAT_FOLDING
10318 linenr_T lnum;
10319 char_u *text;
10320 char_u buf[51];
10321 foldinfo_T foldinfo;
10322 int fold_count;
10323 #endif
10325 rettv->v_type = VAR_STRING;
10326 rettv->vval.v_string = NULL;
10327 #ifdef FEAT_FOLDING
10328 lnum = get_tv_lnum(argvars);
10329 /* treat illegal types and illegal string values for {lnum} the same */
10330 if (lnum < 0)
10331 lnum = 0;
10332 fold_count = foldedCount(curwin, lnum, &foldinfo);
10333 if (fold_count > 0)
10335 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10336 &foldinfo, buf);
10337 if (text == buf)
10338 text = vim_strsave(text);
10339 rettv->vval.v_string = text;
10341 #endif
10345 * "foreground()" function
10347 static void
10348 f_foreground(argvars, rettv)
10349 typval_T *argvars UNUSED;
10350 typval_T *rettv UNUSED;
10352 #ifdef FEAT_GUI
10353 if (gui.in_use)
10354 gui_mch_set_foreground();
10355 #else
10356 # ifdef WIN32
10357 win32_set_foreground();
10358 # endif
10359 #endif
10363 * "function()" function
10365 static void
10366 f_function(argvars, rettv)
10367 typval_T *argvars;
10368 typval_T *rettv;
10370 char_u *s;
10372 s = get_tv_string(&argvars[0]);
10373 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10374 EMSG2(_(e_invarg2), s);
10375 /* Don't check an autoload name for existence here. */
10376 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10377 EMSG2(_("E700: Unknown function: %s"), s);
10378 else
10380 rettv->vval.v_string = vim_strsave(s);
10381 rettv->v_type = VAR_FUNC;
10386 * "garbagecollect()" function
10388 static void
10389 f_garbagecollect(argvars, rettv)
10390 typval_T *argvars;
10391 typval_T *rettv UNUSED;
10393 /* This is postponed until we are back at the toplevel, because we may be
10394 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10395 want_garbage_collect = TRUE;
10397 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10398 garbage_collect_at_exit = TRUE;
10402 * "get()" function
10404 static void
10405 f_get(argvars, rettv)
10406 typval_T *argvars;
10407 typval_T *rettv;
10409 listitem_T *li;
10410 list_T *l;
10411 dictitem_T *di;
10412 dict_T *d;
10413 typval_T *tv = NULL;
10415 if (argvars[0].v_type == VAR_LIST)
10417 if ((l = argvars[0].vval.v_list) != NULL)
10419 int error = FALSE;
10421 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10422 if (!error && li != NULL)
10423 tv = &li->li_tv;
10426 else if (argvars[0].v_type == VAR_DICT)
10428 if ((d = argvars[0].vval.v_dict) != NULL)
10430 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10431 if (di != NULL)
10432 tv = &di->di_tv;
10435 else
10436 EMSG2(_(e_listdictarg), "get()");
10438 if (tv == NULL)
10440 if (argvars[2].v_type != VAR_UNKNOWN)
10441 copy_tv(&argvars[2], rettv);
10443 else
10444 copy_tv(tv, rettv);
10447 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10450 * Get line or list of lines from buffer "buf" into "rettv".
10451 * Return a range (from start to end) of lines in rettv from the specified
10452 * buffer.
10453 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10455 static void
10456 get_buffer_lines(buf, start, end, retlist, rettv)
10457 buf_T *buf;
10458 linenr_T start;
10459 linenr_T end;
10460 int retlist;
10461 typval_T *rettv;
10463 char_u *p;
10465 if (retlist && rettv_list_alloc(rettv) == FAIL)
10466 return;
10468 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10469 return;
10471 if (!retlist)
10473 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10474 p = ml_get_buf(buf, start, FALSE);
10475 else
10476 p = (char_u *)"";
10478 rettv->v_type = VAR_STRING;
10479 rettv->vval.v_string = vim_strsave(p);
10481 else
10483 if (end < start)
10484 return;
10486 if (start < 1)
10487 start = 1;
10488 if (end > buf->b_ml.ml_line_count)
10489 end = buf->b_ml.ml_line_count;
10490 while (start <= end)
10491 if (list_append_string(rettv->vval.v_list,
10492 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10493 break;
10498 * "getbufline()" function
10500 static void
10501 f_getbufline(argvars, rettv)
10502 typval_T *argvars;
10503 typval_T *rettv;
10505 linenr_T lnum;
10506 linenr_T end;
10507 buf_T *buf;
10509 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10510 ++emsg_off;
10511 buf = get_buf_tv(&argvars[0]);
10512 --emsg_off;
10514 lnum = get_tv_lnum_buf(&argvars[1], buf);
10515 if (argvars[2].v_type == VAR_UNKNOWN)
10516 end = lnum;
10517 else
10518 end = get_tv_lnum_buf(&argvars[2], buf);
10520 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10524 * "getbufvar()" function
10526 static void
10527 f_getbufvar(argvars, rettv)
10528 typval_T *argvars;
10529 typval_T *rettv;
10531 buf_T *buf;
10532 buf_T *save_curbuf;
10533 char_u *varname;
10534 dictitem_T *v;
10536 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10537 varname = get_tv_string_chk(&argvars[1]);
10538 ++emsg_off;
10539 buf = get_buf_tv(&argvars[0]);
10541 rettv->v_type = VAR_STRING;
10542 rettv->vval.v_string = NULL;
10544 if (buf != NULL && varname != NULL)
10546 /* set curbuf to be our buf, temporarily */
10547 save_curbuf = curbuf;
10548 curbuf = buf;
10550 if (*varname == '&') /* buffer-local-option */
10551 get_option_tv(&varname, rettv, TRUE);
10552 else
10554 if (*varname == NUL)
10555 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10556 * scope prefix before the NUL byte is required by
10557 * find_var_in_ht(). */
10558 varname = (char_u *)"b:" + 2;
10559 /* look up the variable */
10560 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10561 if (v != NULL)
10562 copy_tv(&v->di_tv, rettv);
10565 /* restore previous notion of curbuf */
10566 curbuf = save_curbuf;
10569 --emsg_off;
10573 * "getchar()" function
10575 static void
10576 f_getchar(argvars, rettv)
10577 typval_T *argvars;
10578 typval_T *rettv;
10580 varnumber_T n;
10581 int error = FALSE;
10583 /* Position the cursor. Needed after a message that ends in a space. */
10584 windgoto(msg_row, msg_col);
10586 ++no_mapping;
10587 ++allow_keys;
10588 for (;;)
10590 if (argvars[0].v_type == VAR_UNKNOWN)
10591 /* getchar(): blocking wait. */
10592 n = safe_vgetc();
10593 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10594 /* getchar(1): only check if char avail */
10595 n = vpeekc();
10596 else if (error || vpeekc() == NUL)
10597 /* illegal argument or getchar(0) and no char avail: return zero */
10598 n = 0;
10599 else
10600 /* getchar(0) and char avail: return char */
10601 n = safe_vgetc();
10602 if (n == K_IGNORE)
10603 continue;
10604 break;
10606 --no_mapping;
10607 --allow_keys;
10609 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10610 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10611 vimvars[VV_MOUSE_COL].vv_nr = 0;
10613 rettv->vval.v_number = n;
10614 if (IS_SPECIAL(n) || mod_mask != 0)
10616 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10617 int i = 0;
10619 /* Turn a special key into three bytes, plus modifier. */
10620 if (mod_mask != 0)
10622 temp[i++] = K_SPECIAL;
10623 temp[i++] = KS_MODIFIER;
10624 temp[i++] = mod_mask;
10626 if (IS_SPECIAL(n))
10628 temp[i++] = K_SPECIAL;
10629 temp[i++] = K_SECOND(n);
10630 temp[i++] = K_THIRD(n);
10632 #ifdef FEAT_MBYTE
10633 else if (has_mbyte)
10634 i += (*mb_char2bytes)(n, temp + i);
10635 #endif
10636 else
10637 temp[i++] = n;
10638 temp[i++] = NUL;
10639 rettv->v_type = VAR_STRING;
10640 rettv->vval.v_string = vim_strsave(temp);
10642 #ifdef FEAT_MOUSE
10643 if (n == K_LEFTMOUSE
10644 || n == K_LEFTMOUSE_NM
10645 || n == K_LEFTDRAG
10646 || n == K_LEFTRELEASE
10647 || n == K_LEFTRELEASE_NM
10648 || n == K_MIDDLEMOUSE
10649 || n == K_MIDDLEDRAG
10650 || n == K_MIDDLERELEASE
10651 || n == K_RIGHTMOUSE
10652 || n == K_RIGHTDRAG
10653 || n == K_RIGHTRELEASE
10654 || n == K_X1MOUSE
10655 || n == K_X1DRAG
10656 || n == K_X1RELEASE
10657 || n == K_X2MOUSE
10658 || n == K_X2DRAG
10659 || n == K_X2RELEASE
10660 || n == K_MOUSEDOWN
10661 || n == K_MOUSEUP)
10663 int row = mouse_row;
10664 int col = mouse_col;
10665 win_T *win;
10666 linenr_T lnum;
10667 # ifdef FEAT_WINDOWS
10668 win_T *wp;
10669 # endif
10670 int winnr = 1;
10672 if (row >= 0 && col >= 0)
10674 /* Find the window at the mouse coordinates and compute the
10675 * text position. */
10676 win = mouse_find_win(&row, &col);
10677 (void)mouse_comp_pos(win, &row, &col, &lnum);
10678 # ifdef FEAT_WINDOWS
10679 for (wp = firstwin; wp != win; wp = wp->w_next)
10680 ++winnr;
10681 # endif
10682 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10683 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10684 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10687 #endif
10692 * "getcharmod()" function
10694 static void
10695 f_getcharmod(argvars, rettv)
10696 typval_T *argvars UNUSED;
10697 typval_T *rettv;
10699 rettv->vval.v_number = mod_mask;
10703 * "getcmdline()" function
10705 static void
10706 f_getcmdline(argvars, rettv)
10707 typval_T *argvars UNUSED;
10708 typval_T *rettv;
10710 rettv->v_type = VAR_STRING;
10711 rettv->vval.v_string = get_cmdline_str();
10715 * "getcmdpos()" function
10717 static void
10718 f_getcmdpos(argvars, rettv)
10719 typval_T *argvars UNUSED;
10720 typval_T *rettv;
10722 rettv->vval.v_number = get_cmdline_pos() + 1;
10726 * "getcmdtype()" function
10728 static void
10729 f_getcmdtype(argvars, rettv)
10730 typval_T *argvars UNUSED;
10731 typval_T *rettv;
10733 rettv->v_type = VAR_STRING;
10734 rettv->vval.v_string = alloc(2);
10735 if (rettv->vval.v_string != NULL)
10737 rettv->vval.v_string[0] = get_cmdline_type();
10738 rettv->vval.v_string[1] = NUL;
10743 * "getcwd()" function
10745 static void
10746 f_getcwd(argvars, rettv)
10747 typval_T *argvars UNUSED;
10748 typval_T *rettv;
10750 char_u cwd[MAXPATHL];
10752 rettv->v_type = VAR_STRING;
10753 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10754 rettv->vval.v_string = NULL;
10755 else
10757 rettv->vval.v_string = vim_strsave(cwd);
10758 #ifdef BACKSLASH_IN_FILENAME
10759 if (rettv->vval.v_string != NULL)
10760 slash_adjust(rettv->vval.v_string);
10761 #endif
10766 * "getfontname()" function
10768 static void
10769 f_getfontname(argvars, rettv)
10770 typval_T *argvars UNUSED;
10771 typval_T *rettv;
10773 rettv->v_type = VAR_STRING;
10774 rettv->vval.v_string = NULL;
10775 #ifdef FEAT_GUI
10776 if (gui.in_use)
10778 GuiFont font;
10779 char_u *name = NULL;
10781 if (argvars[0].v_type == VAR_UNKNOWN)
10783 /* Get the "Normal" font. Either the name saved by
10784 * hl_set_font_name() or from the font ID. */
10785 font = gui.norm_font;
10786 name = hl_get_font_name();
10788 else
10790 name = get_tv_string(&argvars[0]);
10791 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10792 return;
10793 font = gui_mch_get_font(name, FALSE);
10794 if (font == NOFONT)
10795 return; /* Invalid font name, return empty string. */
10797 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10798 if (argvars[0].v_type != VAR_UNKNOWN)
10799 gui_mch_free_font(font);
10801 #endif
10805 * "getfperm({fname})" function
10807 static void
10808 f_getfperm(argvars, rettv)
10809 typval_T *argvars;
10810 typval_T *rettv;
10812 char_u *fname;
10813 struct stat st;
10814 char_u *perm = NULL;
10815 char_u flags[] = "rwx";
10816 int i;
10818 fname = get_tv_string(&argvars[0]);
10820 rettv->v_type = VAR_STRING;
10821 if (mch_stat((char *)fname, &st) >= 0)
10823 perm = vim_strsave((char_u *)"---------");
10824 if (perm != NULL)
10826 for (i = 0; i < 9; i++)
10828 if (st.st_mode & (1 << (8 - i)))
10829 perm[i] = flags[i % 3];
10833 rettv->vval.v_string = perm;
10837 * "getfsize({fname})" function
10839 static void
10840 f_getfsize(argvars, rettv)
10841 typval_T *argvars;
10842 typval_T *rettv;
10844 char_u *fname;
10845 struct stat st;
10847 fname = get_tv_string(&argvars[0]);
10849 rettv->v_type = VAR_NUMBER;
10851 if (mch_stat((char *)fname, &st) >= 0)
10853 if (mch_isdir(fname))
10854 rettv->vval.v_number = 0;
10855 else
10857 rettv->vval.v_number = (varnumber_T)st.st_size;
10859 /* non-perfect check for overflow */
10860 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10861 rettv->vval.v_number = -2;
10864 else
10865 rettv->vval.v_number = -1;
10869 * "getftime({fname})" function
10871 static void
10872 f_getftime(argvars, rettv)
10873 typval_T *argvars;
10874 typval_T *rettv;
10876 char_u *fname;
10877 struct stat st;
10879 fname = get_tv_string(&argvars[0]);
10881 if (mch_stat((char *)fname, &st) >= 0)
10882 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10883 else
10884 rettv->vval.v_number = -1;
10888 * "getftype({fname})" function
10890 static void
10891 f_getftype(argvars, rettv)
10892 typval_T *argvars;
10893 typval_T *rettv;
10895 char_u *fname;
10896 struct stat st;
10897 char_u *type = NULL;
10898 char *t;
10900 fname = get_tv_string(&argvars[0]);
10902 rettv->v_type = VAR_STRING;
10903 if (mch_lstat((char *)fname, &st) >= 0)
10905 #ifdef S_ISREG
10906 if (S_ISREG(st.st_mode))
10907 t = "file";
10908 else if (S_ISDIR(st.st_mode))
10909 t = "dir";
10910 # ifdef S_ISLNK
10911 else if (S_ISLNK(st.st_mode))
10912 t = "link";
10913 # endif
10914 # ifdef S_ISBLK
10915 else if (S_ISBLK(st.st_mode))
10916 t = "bdev";
10917 # endif
10918 # ifdef S_ISCHR
10919 else if (S_ISCHR(st.st_mode))
10920 t = "cdev";
10921 # endif
10922 # ifdef S_ISFIFO
10923 else if (S_ISFIFO(st.st_mode))
10924 t = "fifo";
10925 # endif
10926 # ifdef S_ISSOCK
10927 else if (S_ISSOCK(st.st_mode))
10928 t = "fifo";
10929 # endif
10930 else
10931 t = "other";
10932 #else
10933 # ifdef S_IFMT
10934 switch (st.st_mode & S_IFMT)
10936 case S_IFREG: t = "file"; break;
10937 case S_IFDIR: t = "dir"; break;
10938 # ifdef S_IFLNK
10939 case S_IFLNK: t = "link"; break;
10940 # endif
10941 # ifdef S_IFBLK
10942 case S_IFBLK: t = "bdev"; break;
10943 # endif
10944 # ifdef S_IFCHR
10945 case S_IFCHR: t = "cdev"; break;
10946 # endif
10947 # ifdef S_IFIFO
10948 case S_IFIFO: t = "fifo"; break;
10949 # endif
10950 # ifdef S_IFSOCK
10951 case S_IFSOCK: t = "socket"; break;
10952 # endif
10953 default: t = "other";
10955 # else
10956 if (mch_isdir(fname))
10957 t = "dir";
10958 else
10959 t = "file";
10960 # endif
10961 #endif
10962 type = vim_strsave((char_u *)t);
10964 rettv->vval.v_string = type;
10968 * "getline(lnum, [end])" function
10970 static void
10971 f_getline(argvars, rettv)
10972 typval_T *argvars;
10973 typval_T *rettv;
10975 linenr_T lnum;
10976 linenr_T end;
10977 int retlist;
10979 lnum = get_tv_lnum(argvars);
10980 if (argvars[1].v_type == VAR_UNKNOWN)
10982 end = 0;
10983 retlist = FALSE;
10985 else
10987 end = get_tv_lnum(&argvars[1]);
10988 retlist = TRUE;
10991 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
10995 * "getmatches()" function
10997 static void
10998 f_getmatches(argvars, rettv)
10999 typval_T *argvars UNUSED;
11000 typval_T *rettv;
11002 #ifdef FEAT_SEARCH_EXTRA
11003 dict_T *dict;
11004 matchitem_T *cur = curwin->w_match_head;
11006 if (rettv_list_alloc(rettv) == OK)
11008 while (cur != NULL)
11010 dict = dict_alloc();
11011 if (dict == NULL)
11012 return;
11013 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11014 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11015 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11016 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11017 list_append_dict(rettv->vval.v_list, dict);
11018 cur = cur->next;
11021 #endif
11025 * "getpid()" function
11027 static void
11028 f_getpid(argvars, rettv)
11029 typval_T *argvars UNUSED;
11030 typval_T *rettv;
11032 rettv->vval.v_number = mch_get_pid();
11036 * "getpos(string)" function
11038 static void
11039 f_getpos(argvars, rettv)
11040 typval_T *argvars;
11041 typval_T *rettv;
11043 pos_T *fp;
11044 list_T *l;
11045 int fnum = -1;
11047 if (rettv_list_alloc(rettv) == OK)
11049 l = rettv->vval.v_list;
11050 fp = var2fpos(&argvars[0], TRUE, &fnum);
11051 if (fnum != -1)
11052 list_append_number(l, (varnumber_T)fnum);
11053 else
11054 list_append_number(l, (varnumber_T)0);
11055 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11056 : (varnumber_T)0);
11057 list_append_number(l, (fp != NULL)
11058 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11059 : (varnumber_T)0);
11060 list_append_number(l,
11061 #ifdef FEAT_VIRTUALEDIT
11062 (fp != NULL) ? (varnumber_T)fp->coladd :
11063 #endif
11064 (varnumber_T)0);
11066 else
11067 rettv->vval.v_number = FALSE;
11071 * "getqflist()" and "getloclist()" functions
11073 static void
11074 f_getqflist(argvars, rettv)
11075 typval_T *argvars UNUSED;
11076 typval_T *rettv UNUSED;
11078 #ifdef FEAT_QUICKFIX
11079 win_T *wp;
11080 #endif
11082 #ifdef FEAT_QUICKFIX
11083 if (rettv_list_alloc(rettv) == OK)
11085 wp = NULL;
11086 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11088 wp = find_win_by_nr(&argvars[0], NULL);
11089 if (wp == NULL)
11090 return;
11093 (void)get_errorlist(wp, rettv->vval.v_list);
11095 #endif
11099 * "getreg()" function
11101 static void
11102 f_getreg(argvars, rettv)
11103 typval_T *argvars;
11104 typval_T *rettv;
11106 char_u *strregname;
11107 int regname;
11108 int arg2 = FALSE;
11109 int error = FALSE;
11111 if (argvars[0].v_type != VAR_UNKNOWN)
11113 strregname = get_tv_string_chk(&argvars[0]);
11114 error = strregname == NULL;
11115 if (argvars[1].v_type != VAR_UNKNOWN)
11116 arg2 = get_tv_number_chk(&argvars[1], &error);
11118 else
11119 strregname = vimvars[VV_REG].vv_str;
11120 regname = (strregname == NULL ? '"' : *strregname);
11121 if (regname == 0)
11122 regname = '"';
11124 rettv->v_type = VAR_STRING;
11125 rettv->vval.v_string = error ? NULL :
11126 get_reg_contents(regname, TRUE, arg2);
11130 * "getregtype()" function
11132 static void
11133 f_getregtype(argvars, rettv)
11134 typval_T *argvars;
11135 typval_T *rettv;
11137 char_u *strregname;
11138 int regname;
11139 char_u buf[NUMBUFLEN + 2];
11140 long reglen = 0;
11142 if (argvars[0].v_type != VAR_UNKNOWN)
11144 strregname = get_tv_string_chk(&argvars[0]);
11145 if (strregname == NULL) /* type error; errmsg already given */
11147 rettv->v_type = VAR_STRING;
11148 rettv->vval.v_string = NULL;
11149 return;
11152 else
11153 /* Default to v:register */
11154 strregname = vimvars[VV_REG].vv_str;
11156 regname = (strregname == NULL ? '"' : *strregname);
11157 if (regname == 0)
11158 regname = '"';
11160 buf[0] = NUL;
11161 buf[1] = NUL;
11162 switch (get_reg_type(regname, &reglen))
11164 case MLINE: buf[0] = 'V'; break;
11165 case MCHAR: buf[0] = 'v'; break;
11166 #ifdef FEAT_VISUAL
11167 case MBLOCK:
11168 buf[0] = Ctrl_V;
11169 sprintf((char *)buf + 1, "%ld", reglen + 1);
11170 break;
11171 #endif
11173 rettv->v_type = VAR_STRING;
11174 rettv->vval.v_string = vim_strsave(buf);
11178 * "gettabwinvar()" function
11180 static void
11181 f_gettabwinvar(argvars, rettv)
11182 typval_T *argvars;
11183 typval_T *rettv;
11185 getwinvar(argvars, rettv, 1);
11189 * "getwinposx()" function
11191 static void
11192 f_getwinposx(argvars, rettv)
11193 typval_T *argvars UNUSED;
11194 typval_T *rettv;
11196 rettv->vval.v_number = -1;
11197 #ifdef FEAT_GUI
11198 if (gui.in_use)
11200 int x, y;
11202 if (gui_mch_get_winpos(&x, &y) == OK)
11203 rettv->vval.v_number = x;
11205 #endif
11209 * "getwinposy()" function
11211 static void
11212 f_getwinposy(argvars, rettv)
11213 typval_T *argvars UNUSED;
11214 typval_T *rettv;
11216 rettv->vval.v_number = -1;
11217 #ifdef FEAT_GUI
11218 if (gui.in_use)
11220 int x, y;
11222 if (gui_mch_get_winpos(&x, &y) == OK)
11223 rettv->vval.v_number = y;
11225 #endif
11229 * Find window specified by "vp" in tabpage "tp".
11231 static win_T *
11232 find_win_by_nr(vp, tp)
11233 typval_T *vp;
11234 tabpage_T *tp; /* NULL for current tab page */
11236 #ifdef FEAT_WINDOWS
11237 win_T *wp;
11238 #endif
11239 int nr;
11241 nr = get_tv_number_chk(vp, NULL);
11243 #ifdef FEAT_WINDOWS
11244 if (nr < 0)
11245 return NULL;
11246 if (nr == 0)
11247 return curwin;
11249 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11250 wp != NULL; wp = wp->w_next)
11251 if (--nr <= 0)
11252 break;
11253 return wp;
11254 #else
11255 if (nr == 0 || nr == 1)
11256 return curwin;
11257 return NULL;
11258 #endif
11262 * "getwinvar()" function
11264 static void
11265 f_getwinvar(argvars, rettv)
11266 typval_T *argvars;
11267 typval_T *rettv;
11269 getwinvar(argvars, rettv, 0);
11273 * getwinvar() and gettabwinvar()
11275 static void
11276 getwinvar(argvars, rettv, off)
11277 typval_T *argvars;
11278 typval_T *rettv;
11279 int off; /* 1 for gettabwinvar() */
11281 win_T *win, *oldcurwin;
11282 char_u *varname;
11283 dictitem_T *v;
11284 tabpage_T *tp;
11286 #ifdef FEAT_WINDOWS
11287 if (off == 1)
11288 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11289 else
11290 tp = curtab;
11291 #endif
11292 win = find_win_by_nr(&argvars[off], tp);
11293 varname = get_tv_string_chk(&argvars[off + 1]);
11294 ++emsg_off;
11296 rettv->v_type = VAR_STRING;
11297 rettv->vval.v_string = NULL;
11299 if (win != NULL && varname != NULL)
11301 /* Set curwin to be our win, temporarily. Also set curbuf, so
11302 * that we can get buffer-local options. */
11303 oldcurwin = curwin;
11304 curwin = win;
11305 curbuf = win->w_buffer;
11307 if (*varname == '&') /* window-local-option */
11308 get_option_tv(&varname, rettv, 1);
11309 else
11311 if (*varname == NUL)
11312 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11313 * scope prefix before the NUL byte is required by
11314 * find_var_in_ht(). */
11315 varname = (char_u *)"w:" + 2;
11316 /* look up the variable */
11317 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11318 if (v != NULL)
11319 copy_tv(&v->di_tv, rettv);
11322 /* restore previous notion of curwin */
11323 curwin = oldcurwin;
11324 curbuf = curwin->w_buffer;
11327 --emsg_off;
11331 * "glob()" function
11333 static void
11334 f_glob(argvars, rettv)
11335 typval_T *argvars;
11336 typval_T *rettv;
11338 int flags = WILD_SILENT|WILD_USE_NL;
11339 expand_T xpc;
11340 int error = FALSE;
11342 /* When the optional second argument is non-zero, don't remove matches
11343 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11344 if (argvars[1].v_type != VAR_UNKNOWN
11345 && get_tv_number_chk(&argvars[1], &error))
11346 flags |= WILD_KEEP_ALL;
11347 rettv->v_type = VAR_STRING;
11348 if (!error)
11350 ExpandInit(&xpc);
11351 xpc.xp_context = EXPAND_FILES;
11352 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11353 NULL, flags, WILD_ALL);
11355 else
11356 rettv->vval.v_string = NULL;
11360 * "globpath()" function
11362 static void
11363 f_globpath(argvars, rettv)
11364 typval_T *argvars;
11365 typval_T *rettv;
11367 int flags = 0;
11368 char_u buf1[NUMBUFLEN];
11369 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11370 int error = FALSE;
11372 /* When the optional second argument is non-zero, don't remove matches
11373 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11374 if (argvars[2].v_type != VAR_UNKNOWN
11375 && get_tv_number_chk(&argvars[2], &error))
11376 flags |= WILD_KEEP_ALL;
11377 rettv->v_type = VAR_STRING;
11378 if (file == NULL || error)
11379 rettv->vval.v_string = NULL;
11380 else
11381 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11382 flags);
11386 * "has()" function
11388 static void
11389 f_has(argvars, rettv)
11390 typval_T *argvars;
11391 typval_T *rettv;
11393 int i;
11394 char_u *name;
11395 int n = FALSE;
11396 static char *(has_list[]) =
11398 #ifdef AMIGA
11399 "amiga",
11400 # ifdef FEAT_ARP
11401 "arp",
11402 # endif
11403 #endif
11404 #ifdef __BEOS__
11405 "beos",
11406 #endif
11407 #ifdef MSDOS
11408 # ifdef DJGPP
11409 "dos32",
11410 # else
11411 "dos16",
11412 # endif
11413 #endif
11414 #ifdef MACOS
11415 "mac",
11416 #endif
11417 #if defined(MACOS_X_UNIX)
11418 "macunix",
11419 #endif
11420 #ifdef OS2
11421 "os2",
11422 #endif
11423 #ifdef __QNX__
11424 "qnx",
11425 #endif
11426 #ifdef RISCOS
11427 "riscos",
11428 #endif
11429 #ifdef UNIX
11430 "unix",
11431 #endif
11432 #ifdef VMS
11433 "vms",
11434 #endif
11435 #ifdef WIN16
11436 "win16",
11437 #endif
11438 #ifdef WIN32
11439 "win32",
11440 #endif
11441 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11442 "win32unix",
11443 #endif
11444 #ifdef WIN64
11445 "win64",
11446 #endif
11447 #ifdef EBCDIC
11448 "ebcdic",
11449 #endif
11450 #ifndef CASE_INSENSITIVE_FILENAME
11451 "fname_case",
11452 #endif
11453 #ifdef FEAT_ARABIC
11454 "arabic",
11455 #endif
11456 #ifdef FEAT_AUTOCMD
11457 "autocmd",
11458 #endif
11459 #ifdef FEAT_BEVAL
11460 "balloon_eval",
11461 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11462 "balloon_multiline",
11463 # endif
11464 #endif
11465 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11466 "builtin_terms",
11467 # ifdef ALL_BUILTIN_TCAPS
11468 "all_builtin_terms",
11469 # endif
11470 #endif
11471 #ifdef FEAT_BYTEOFF
11472 "byte_offset",
11473 #endif
11474 #ifdef FEAT_CINDENT
11475 "cindent",
11476 #endif
11477 #ifdef FEAT_CLIENTSERVER
11478 "clientserver",
11479 #endif
11480 #ifdef FEAT_CLIPBOARD
11481 "clipboard",
11482 #endif
11483 #ifdef FEAT_CMDL_COMPL
11484 "cmdline_compl",
11485 #endif
11486 #ifdef FEAT_CMDHIST
11487 "cmdline_hist",
11488 #endif
11489 #ifdef FEAT_COMMENTS
11490 "comments",
11491 #endif
11492 #ifdef FEAT_CRYPT
11493 "cryptv",
11494 #endif
11495 #ifdef FEAT_CSCOPE
11496 "cscope",
11497 #endif
11498 #ifdef CURSOR_SHAPE
11499 "cursorshape",
11500 #endif
11501 #ifdef DEBUG
11502 "debug",
11503 #endif
11504 #ifdef FEAT_CON_DIALOG
11505 "dialog_con",
11506 #endif
11507 #ifdef FEAT_GUI_DIALOG
11508 "dialog_gui",
11509 #endif
11510 #ifdef FEAT_DIFF
11511 "diff",
11512 #endif
11513 #ifdef FEAT_DIGRAPHS
11514 "digraphs",
11515 #endif
11516 #ifdef FEAT_DND
11517 "dnd",
11518 #endif
11519 #ifdef FEAT_EMACS_TAGS
11520 "emacs_tags",
11521 #endif
11522 "eval", /* always present, of course! */
11523 #ifdef FEAT_EX_EXTRA
11524 "ex_extra",
11525 #endif
11526 #ifdef FEAT_SEARCH_EXTRA
11527 "extra_search",
11528 #endif
11529 #ifdef FEAT_FKMAP
11530 "farsi",
11531 #endif
11532 #ifdef FEAT_SEARCHPATH
11533 "file_in_path",
11534 #endif
11535 #if defined(UNIX) && !defined(USE_SYSTEM)
11536 "filterpipe",
11537 #endif
11538 #ifdef FEAT_FIND_ID
11539 "find_in_path",
11540 #endif
11541 #ifdef FEAT_FLOAT
11542 "float",
11543 #endif
11544 #ifdef FEAT_FOLDING
11545 "folding",
11546 #endif
11547 #ifdef FEAT_FOOTER
11548 "footer",
11549 #endif
11550 #if !defined(USE_SYSTEM) && defined(UNIX)
11551 "fork",
11552 #endif
11553 #ifdef FEAT_GETTEXT
11554 "gettext",
11555 #endif
11556 #ifdef FEAT_GUI
11557 "gui",
11558 #endif
11559 #ifdef FEAT_GUI_ATHENA
11560 # ifdef FEAT_GUI_NEXTAW
11561 "gui_neXtaw",
11562 # else
11563 "gui_athena",
11564 # endif
11565 #endif
11566 #ifdef FEAT_GUI_GTK
11567 "gui_gtk",
11568 # ifdef HAVE_GTK2
11569 "gui_gtk2",
11570 # endif
11571 #endif
11572 #ifdef FEAT_GUI_GNOME
11573 "gui_gnome",
11574 #endif
11575 #ifdef FEAT_GUI_MAC
11576 "gui_mac",
11577 #endif
11578 #ifdef FEAT_GUI_MOTIF
11579 "gui_motif",
11580 #endif
11581 #ifdef FEAT_GUI_PHOTON
11582 "gui_photon",
11583 #endif
11584 #ifdef FEAT_GUI_W16
11585 "gui_win16",
11586 #endif
11587 #ifdef FEAT_GUI_W32
11588 "gui_win32",
11589 #endif
11590 #ifdef FEAT_HANGULIN
11591 "hangul_input",
11592 #endif
11593 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11594 "iconv",
11595 #endif
11596 #ifdef FEAT_INS_EXPAND
11597 "insert_expand",
11598 #endif
11599 #ifdef FEAT_JUMPLIST
11600 "jumplist",
11601 #endif
11602 #ifdef FEAT_KEYMAP
11603 "keymap",
11604 #endif
11605 #ifdef FEAT_LANGMAP
11606 "langmap",
11607 #endif
11608 #ifdef FEAT_LIBCALL
11609 "libcall",
11610 #endif
11611 #ifdef FEAT_LINEBREAK
11612 "linebreak",
11613 #endif
11614 #ifdef FEAT_LISP
11615 "lispindent",
11616 #endif
11617 #ifdef FEAT_LISTCMDS
11618 "listcmds",
11619 #endif
11620 #ifdef FEAT_LOCALMAP
11621 "localmap",
11622 #endif
11623 #ifdef FEAT_MENU
11624 "menu",
11625 #endif
11626 #ifdef FEAT_SESSION
11627 "mksession",
11628 #endif
11629 #ifdef FEAT_MODIFY_FNAME
11630 "modify_fname",
11631 #endif
11632 #ifdef FEAT_MOUSE
11633 "mouse",
11634 #endif
11635 #ifdef FEAT_MOUSESHAPE
11636 "mouseshape",
11637 #endif
11638 #if defined(UNIX) || defined(VMS)
11639 # ifdef FEAT_MOUSE_DEC
11640 "mouse_dec",
11641 # endif
11642 # ifdef FEAT_MOUSE_GPM
11643 "mouse_gpm",
11644 # endif
11645 # ifdef FEAT_MOUSE_JSB
11646 "mouse_jsbterm",
11647 # endif
11648 # ifdef FEAT_MOUSE_NET
11649 "mouse_netterm",
11650 # endif
11651 # ifdef FEAT_MOUSE_PTERM
11652 "mouse_pterm",
11653 # endif
11654 # ifdef FEAT_SYSMOUSE
11655 "mouse_sysmouse",
11656 # endif
11657 # ifdef FEAT_MOUSE_XTERM
11658 "mouse_xterm",
11659 # endif
11660 #endif
11661 #ifdef FEAT_MBYTE
11662 "multi_byte",
11663 #endif
11664 #ifdef FEAT_MBYTE_IME
11665 "multi_byte_ime",
11666 #endif
11667 #ifdef FEAT_MULTI_LANG
11668 "multi_lang",
11669 #endif
11670 #ifdef FEAT_MZSCHEME
11671 #ifndef DYNAMIC_MZSCHEME
11672 "mzscheme",
11673 #endif
11674 #endif
11675 #ifdef FEAT_OLE
11676 "ole",
11677 #endif
11678 #ifdef FEAT_OSFILETYPE
11679 "osfiletype",
11680 #endif
11681 #ifdef FEAT_PATH_EXTRA
11682 "path_extra",
11683 #endif
11684 #ifdef FEAT_PERL
11685 #ifndef DYNAMIC_PERL
11686 "perl",
11687 #endif
11688 #endif
11689 #ifdef FEAT_PYTHON
11690 #ifndef DYNAMIC_PYTHON
11691 "python",
11692 #endif
11693 #endif
11694 #ifdef FEAT_POSTSCRIPT
11695 "postscript",
11696 #endif
11697 #ifdef FEAT_PRINTER
11698 "printer",
11699 #endif
11700 #ifdef FEAT_PROFILE
11701 "profile",
11702 #endif
11703 #ifdef FEAT_RELTIME
11704 "reltime",
11705 #endif
11706 #ifdef FEAT_QUICKFIX
11707 "quickfix",
11708 #endif
11709 #ifdef FEAT_RIGHTLEFT
11710 "rightleft",
11711 #endif
11712 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11713 "ruby",
11714 #endif
11715 #ifdef FEAT_SCROLLBIND
11716 "scrollbind",
11717 #endif
11718 #ifdef FEAT_CMDL_INFO
11719 "showcmd",
11720 "cmdline_info",
11721 #endif
11722 #ifdef FEAT_SIGNS
11723 "signs",
11724 #endif
11725 #ifdef FEAT_SMARTINDENT
11726 "smartindent",
11727 #endif
11728 #ifdef FEAT_SNIFF
11729 "sniff",
11730 #endif
11731 #ifdef FEAT_STL_OPT
11732 "statusline",
11733 #endif
11734 #ifdef FEAT_SUN_WORKSHOP
11735 "sun_workshop",
11736 #endif
11737 #ifdef FEAT_NETBEANS_INTG
11738 "netbeans_intg",
11739 #endif
11740 #ifdef FEAT_SPELL
11741 "spell",
11742 #endif
11743 #ifdef FEAT_SYN_HL
11744 "syntax",
11745 #endif
11746 #if defined(USE_SYSTEM) || !defined(UNIX)
11747 "system",
11748 #endif
11749 #ifdef FEAT_TAG_BINS
11750 "tag_binary",
11751 #endif
11752 #ifdef FEAT_TAG_OLDSTATIC
11753 "tag_old_static",
11754 #endif
11755 #ifdef FEAT_TAG_ANYWHITE
11756 "tag_any_white",
11757 #endif
11758 #ifdef FEAT_TCL
11759 # ifndef DYNAMIC_TCL
11760 "tcl",
11761 # endif
11762 #endif
11763 #ifdef TERMINFO
11764 "terminfo",
11765 #endif
11766 #ifdef FEAT_TERMRESPONSE
11767 "termresponse",
11768 #endif
11769 #ifdef FEAT_TEXTOBJ
11770 "textobjects",
11771 #endif
11772 #ifdef HAVE_TGETENT
11773 "tgetent",
11774 #endif
11775 #ifdef FEAT_TITLE
11776 "title",
11777 #endif
11778 #ifdef FEAT_TOOLBAR
11779 "toolbar",
11780 #endif
11781 #ifdef FEAT_USR_CMDS
11782 "user-commands", /* was accidentally included in 5.4 */
11783 "user_commands",
11784 #endif
11785 #ifdef FEAT_VIMINFO
11786 "viminfo",
11787 #endif
11788 #ifdef FEAT_VERTSPLIT
11789 "vertsplit",
11790 #endif
11791 #ifdef FEAT_VIRTUALEDIT
11792 "virtualedit",
11793 #endif
11794 #ifdef FEAT_VISUAL
11795 "visual",
11796 #endif
11797 #ifdef FEAT_VISUALEXTRA
11798 "visualextra",
11799 #endif
11800 #ifdef FEAT_VREPLACE
11801 "vreplace",
11802 #endif
11803 #ifdef FEAT_WILDIGN
11804 "wildignore",
11805 #endif
11806 #ifdef FEAT_WILDMENU
11807 "wildmenu",
11808 #endif
11809 #ifdef FEAT_WINDOWS
11810 "windows",
11811 #endif
11812 #ifdef FEAT_WAK
11813 "winaltkeys",
11814 #endif
11815 #ifdef FEAT_WRITEBACKUP
11816 "writebackup",
11817 #endif
11818 #ifdef FEAT_XIM
11819 "xim",
11820 #endif
11821 #ifdef FEAT_XFONTSET
11822 "xfontset",
11823 #endif
11824 #ifdef USE_XSMP
11825 "xsmp",
11826 #endif
11827 #ifdef USE_XSMP_INTERACT
11828 "xsmp_interact",
11829 #endif
11830 #ifdef FEAT_XCLIPBOARD
11831 "xterm_clipboard",
11832 #endif
11833 #ifdef FEAT_XTERM_SAVE
11834 "xterm_save",
11835 #endif
11836 #if defined(UNIX) && defined(FEAT_X11)
11837 "X11",
11838 #endif
11839 NULL
11842 name = get_tv_string(&argvars[0]);
11843 for (i = 0; has_list[i] != NULL; ++i)
11844 if (STRICMP(name, has_list[i]) == 0)
11846 n = TRUE;
11847 break;
11850 if (n == FALSE)
11852 if (STRNICMP(name, "patch", 5) == 0)
11853 n = has_patch(atoi((char *)name + 5));
11854 else if (STRICMP(name, "vim_starting") == 0)
11855 n = (starting != 0);
11856 #ifdef FEAT_MBYTE
11857 else if (STRICMP(name, "multi_byte_encoding") == 0)
11858 n = has_mbyte;
11859 #endif
11860 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11861 else if (STRICMP(name, "balloon_multiline") == 0)
11862 n = multiline_balloon_available();
11863 #endif
11864 #ifdef DYNAMIC_TCL
11865 else if (STRICMP(name, "tcl") == 0)
11866 n = tcl_enabled(FALSE);
11867 #endif
11868 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11869 else if (STRICMP(name, "iconv") == 0)
11870 n = iconv_enabled(FALSE);
11871 #endif
11872 #ifdef DYNAMIC_MZSCHEME
11873 else if (STRICMP(name, "mzscheme") == 0)
11874 n = mzscheme_enabled(FALSE);
11875 #endif
11876 #ifdef DYNAMIC_RUBY
11877 else if (STRICMP(name, "ruby") == 0)
11878 n = ruby_enabled(FALSE);
11879 #endif
11880 #ifdef DYNAMIC_PYTHON
11881 else if (STRICMP(name, "python") == 0)
11882 n = python_enabled(FALSE);
11883 #endif
11884 #ifdef DYNAMIC_PERL
11885 else if (STRICMP(name, "perl") == 0)
11886 n = perl_enabled(FALSE);
11887 #endif
11888 #ifdef FEAT_GUI
11889 else if (STRICMP(name, "gui_running") == 0)
11890 n = (gui.in_use || gui.starting);
11891 # ifdef FEAT_GUI_W32
11892 else if (STRICMP(name, "gui_win32s") == 0)
11893 n = gui_is_win32s();
11894 # endif
11895 # ifdef FEAT_BROWSE
11896 else if (STRICMP(name, "browse") == 0)
11897 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11898 # endif
11899 #endif
11900 #ifdef FEAT_SYN_HL
11901 else if (STRICMP(name, "syntax_items") == 0)
11902 n = syntax_present(curbuf);
11903 #endif
11904 #if defined(WIN3264)
11905 else if (STRICMP(name, "win95") == 0)
11906 n = mch_windows95();
11907 #endif
11908 #ifdef FEAT_NETBEANS_INTG
11909 else if (STRICMP(name, "netbeans_enabled") == 0)
11910 n = usingNetbeans;
11911 #endif
11914 rettv->vval.v_number = n;
11918 * "has_key()" function
11920 static void
11921 f_has_key(argvars, rettv)
11922 typval_T *argvars;
11923 typval_T *rettv;
11925 if (argvars[0].v_type != VAR_DICT)
11927 EMSG(_(e_dictreq));
11928 return;
11930 if (argvars[0].vval.v_dict == NULL)
11931 return;
11933 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11934 get_tv_string(&argvars[1]), -1) != NULL;
11938 * "haslocaldir()" function
11940 static void
11941 f_haslocaldir(argvars, rettv)
11942 typval_T *argvars UNUSED;
11943 typval_T *rettv;
11945 rettv->vval.v_number = (curwin->w_localdir != NULL);
11949 * "hasmapto()" function
11951 static void
11952 f_hasmapto(argvars, rettv)
11953 typval_T *argvars;
11954 typval_T *rettv;
11956 char_u *name;
11957 char_u *mode;
11958 char_u buf[NUMBUFLEN];
11959 int abbr = FALSE;
11961 name = get_tv_string(&argvars[0]);
11962 if (argvars[1].v_type == VAR_UNKNOWN)
11963 mode = (char_u *)"nvo";
11964 else
11966 mode = get_tv_string_buf(&argvars[1], buf);
11967 if (argvars[2].v_type != VAR_UNKNOWN)
11968 abbr = get_tv_number(&argvars[2]);
11971 if (map_to_exists(name, mode, abbr))
11972 rettv->vval.v_number = TRUE;
11973 else
11974 rettv->vval.v_number = FALSE;
11978 * "histadd()" function
11980 static void
11981 f_histadd(argvars, rettv)
11982 typval_T *argvars UNUSED;
11983 typval_T *rettv;
11985 #ifdef FEAT_CMDHIST
11986 int histype;
11987 char_u *str;
11988 char_u buf[NUMBUFLEN];
11989 #endif
11991 rettv->vval.v_number = FALSE;
11992 if (check_restricted() || check_secure())
11993 return;
11994 #ifdef FEAT_CMDHIST
11995 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11996 histype = str != NULL ? get_histtype(str) : -1;
11997 if (histype >= 0)
11999 str = get_tv_string_buf(&argvars[1], buf);
12000 if (*str != NUL)
12002 add_to_history(histype, str, FALSE, NUL);
12003 rettv->vval.v_number = TRUE;
12004 return;
12007 #endif
12011 * "histdel()" function
12013 static void
12014 f_histdel(argvars, rettv)
12015 typval_T *argvars UNUSED;
12016 typval_T *rettv UNUSED;
12018 #ifdef FEAT_CMDHIST
12019 int n;
12020 char_u buf[NUMBUFLEN];
12021 char_u *str;
12023 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12024 if (str == NULL)
12025 n = 0;
12026 else if (argvars[1].v_type == VAR_UNKNOWN)
12027 /* only one argument: clear entire history */
12028 n = clr_history(get_histtype(str));
12029 else if (argvars[1].v_type == VAR_NUMBER)
12030 /* index given: remove that entry */
12031 n = del_history_idx(get_histtype(str),
12032 (int)get_tv_number(&argvars[1]));
12033 else
12034 /* string given: remove all matching entries */
12035 n = del_history_entry(get_histtype(str),
12036 get_tv_string_buf(&argvars[1], buf));
12037 rettv->vval.v_number = n;
12038 #endif
12042 * "histget()" function
12044 static void
12045 f_histget(argvars, rettv)
12046 typval_T *argvars UNUSED;
12047 typval_T *rettv;
12049 #ifdef FEAT_CMDHIST
12050 int type;
12051 int idx;
12052 char_u *str;
12054 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12055 if (str == NULL)
12056 rettv->vval.v_string = NULL;
12057 else
12059 type = get_histtype(str);
12060 if (argvars[1].v_type == VAR_UNKNOWN)
12061 idx = get_history_idx(type);
12062 else
12063 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12064 /* -1 on type error */
12065 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12067 #else
12068 rettv->vval.v_string = NULL;
12069 #endif
12070 rettv->v_type = VAR_STRING;
12074 * "histnr()" function
12076 static void
12077 f_histnr(argvars, rettv)
12078 typval_T *argvars UNUSED;
12079 typval_T *rettv;
12081 int i;
12083 #ifdef FEAT_CMDHIST
12084 char_u *history = get_tv_string_chk(&argvars[0]);
12086 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12087 if (i >= HIST_CMD && i < HIST_COUNT)
12088 i = get_history_idx(i);
12089 else
12090 #endif
12091 i = -1;
12092 rettv->vval.v_number = i;
12096 * "highlightID(name)" function
12098 static void
12099 f_hlID(argvars, rettv)
12100 typval_T *argvars;
12101 typval_T *rettv;
12103 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12107 * "highlight_exists()" function
12109 static void
12110 f_hlexists(argvars, rettv)
12111 typval_T *argvars;
12112 typval_T *rettv;
12114 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12118 * "hostname()" function
12120 static void
12121 f_hostname(argvars, rettv)
12122 typval_T *argvars UNUSED;
12123 typval_T *rettv;
12125 char_u hostname[256];
12127 mch_get_host_name(hostname, 256);
12128 rettv->v_type = VAR_STRING;
12129 rettv->vval.v_string = vim_strsave(hostname);
12133 * iconv() function
12135 static void
12136 f_iconv(argvars, rettv)
12137 typval_T *argvars UNUSED;
12138 typval_T *rettv;
12140 #ifdef FEAT_MBYTE
12141 char_u buf1[NUMBUFLEN];
12142 char_u buf2[NUMBUFLEN];
12143 char_u *from, *to, *str;
12144 vimconv_T vimconv;
12145 #endif
12147 rettv->v_type = VAR_STRING;
12148 rettv->vval.v_string = NULL;
12150 #ifdef FEAT_MBYTE
12151 str = get_tv_string(&argvars[0]);
12152 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12153 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12154 vimconv.vc_type = CONV_NONE;
12155 convert_setup(&vimconv, from, to);
12157 /* If the encodings are equal, no conversion needed. */
12158 if (vimconv.vc_type == CONV_NONE)
12159 rettv->vval.v_string = vim_strsave(str);
12160 else
12161 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12163 convert_setup(&vimconv, NULL, NULL);
12164 vim_free(from);
12165 vim_free(to);
12166 #endif
12170 * "indent()" function
12172 static void
12173 f_indent(argvars, rettv)
12174 typval_T *argvars;
12175 typval_T *rettv;
12177 linenr_T lnum;
12179 lnum = get_tv_lnum(argvars);
12180 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12181 rettv->vval.v_number = get_indent_lnum(lnum);
12182 else
12183 rettv->vval.v_number = -1;
12187 * "index()" function
12189 static void
12190 f_index(argvars, rettv)
12191 typval_T *argvars;
12192 typval_T *rettv;
12194 list_T *l;
12195 listitem_T *item;
12196 long idx = 0;
12197 int ic = FALSE;
12199 rettv->vval.v_number = -1;
12200 if (argvars[0].v_type != VAR_LIST)
12202 EMSG(_(e_listreq));
12203 return;
12205 l = argvars[0].vval.v_list;
12206 if (l != NULL)
12208 item = l->lv_first;
12209 if (argvars[2].v_type != VAR_UNKNOWN)
12211 int error = FALSE;
12213 /* Start at specified item. Use the cached index that list_find()
12214 * sets, so that a negative number also works. */
12215 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12216 idx = l->lv_idx;
12217 if (argvars[3].v_type != VAR_UNKNOWN)
12218 ic = get_tv_number_chk(&argvars[3], &error);
12219 if (error)
12220 item = NULL;
12223 for ( ; item != NULL; item = item->li_next, ++idx)
12224 if (tv_equal(&item->li_tv, &argvars[1], ic))
12226 rettv->vval.v_number = idx;
12227 break;
12232 static int inputsecret_flag = 0;
12234 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12237 * This function is used by f_input() and f_inputdialog() functions. The third
12238 * argument to f_input() specifies the type of completion to use at the
12239 * prompt. The third argument to f_inputdialog() specifies the value to return
12240 * when the user cancels the prompt.
12242 static void
12243 get_user_input(argvars, rettv, inputdialog)
12244 typval_T *argvars;
12245 typval_T *rettv;
12246 int inputdialog;
12248 char_u *prompt = get_tv_string_chk(&argvars[0]);
12249 char_u *p = NULL;
12250 int c;
12251 char_u buf[NUMBUFLEN];
12252 int cmd_silent_save = cmd_silent;
12253 char_u *defstr = (char_u *)"";
12254 int xp_type = EXPAND_NOTHING;
12255 char_u *xp_arg = NULL;
12257 rettv->v_type = VAR_STRING;
12258 rettv->vval.v_string = NULL;
12260 #ifdef NO_CONSOLE_INPUT
12261 /* While starting up, there is no place to enter text. */
12262 if (no_console_input())
12263 return;
12264 #endif
12266 cmd_silent = FALSE; /* Want to see the prompt. */
12267 if (prompt != NULL)
12269 /* Only the part of the message after the last NL is considered as
12270 * prompt for the command line */
12271 p = vim_strrchr(prompt, '\n');
12272 if (p == NULL)
12273 p = prompt;
12274 else
12276 ++p;
12277 c = *p;
12278 *p = NUL;
12279 msg_start();
12280 msg_clr_eos();
12281 msg_puts_attr(prompt, echo_attr);
12282 msg_didout = FALSE;
12283 msg_starthere();
12284 *p = c;
12286 cmdline_row = msg_row;
12288 if (argvars[1].v_type != VAR_UNKNOWN)
12290 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12291 if (defstr != NULL)
12292 stuffReadbuffSpec(defstr);
12294 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12296 char_u *xp_name;
12297 int xp_namelen;
12298 long argt;
12300 rettv->vval.v_string = NULL;
12302 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12303 if (xp_name == NULL)
12304 return;
12306 xp_namelen = (int)STRLEN(xp_name);
12308 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12309 &xp_arg) == FAIL)
12310 return;
12314 if (defstr != NULL)
12315 rettv->vval.v_string =
12316 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12317 xp_type, xp_arg);
12319 vim_free(xp_arg);
12321 /* since the user typed this, no need to wait for return */
12322 need_wait_return = FALSE;
12323 msg_didout = FALSE;
12325 cmd_silent = cmd_silent_save;
12329 * "input()" function
12330 * Also handles inputsecret() when inputsecret is set.
12332 static void
12333 f_input(argvars, rettv)
12334 typval_T *argvars;
12335 typval_T *rettv;
12337 get_user_input(argvars, rettv, FALSE);
12341 * "inputdialog()" function
12343 static void
12344 f_inputdialog(argvars, rettv)
12345 typval_T *argvars;
12346 typval_T *rettv;
12348 #if defined(FEAT_GUI_TEXTDIALOG)
12349 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12350 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12352 char_u *message;
12353 char_u buf[NUMBUFLEN];
12354 char_u *defstr = (char_u *)"";
12356 message = get_tv_string_chk(&argvars[0]);
12357 if (argvars[1].v_type != VAR_UNKNOWN
12358 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12359 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12360 else
12361 IObuff[0] = NUL;
12362 if (message != NULL && defstr != NULL
12363 && do_dialog(VIM_QUESTION, NULL, message,
12364 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12365 rettv->vval.v_string = vim_strsave(IObuff);
12366 else
12368 if (message != NULL && defstr != NULL
12369 && argvars[1].v_type != VAR_UNKNOWN
12370 && argvars[2].v_type != VAR_UNKNOWN)
12371 rettv->vval.v_string = vim_strsave(
12372 get_tv_string_buf(&argvars[2], buf));
12373 else
12374 rettv->vval.v_string = NULL;
12376 rettv->v_type = VAR_STRING;
12378 else
12379 #endif
12380 get_user_input(argvars, rettv, TRUE);
12384 * "inputlist()" function
12386 static void
12387 f_inputlist(argvars, rettv)
12388 typval_T *argvars;
12389 typval_T *rettv;
12391 listitem_T *li;
12392 int selected;
12393 int mouse_used;
12395 #ifdef NO_CONSOLE_INPUT
12396 /* While starting up, there is no place to enter text. */
12397 if (no_console_input())
12398 return;
12399 #endif
12400 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12402 EMSG2(_(e_listarg), "inputlist()");
12403 return;
12406 msg_start();
12407 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12408 lines_left = Rows; /* avoid more prompt */
12409 msg_scroll = TRUE;
12410 msg_clr_eos();
12412 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12414 msg_puts(get_tv_string(&li->li_tv));
12415 msg_putchar('\n');
12418 /* Ask for choice. */
12419 selected = prompt_for_number(&mouse_used);
12420 if (mouse_used)
12421 selected -= lines_left;
12423 rettv->vval.v_number = selected;
12427 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12430 * "inputrestore()" function
12432 static void
12433 f_inputrestore(argvars, rettv)
12434 typval_T *argvars UNUSED;
12435 typval_T *rettv;
12437 if (ga_userinput.ga_len > 0)
12439 --ga_userinput.ga_len;
12440 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12441 + ga_userinput.ga_len);
12442 /* default return is zero == OK */
12444 else if (p_verbose > 1)
12446 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12447 rettv->vval.v_number = 1; /* Failed */
12452 * "inputsave()" function
12454 static void
12455 f_inputsave(argvars, rettv)
12456 typval_T *argvars UNUSED;
12457 typval_T *rettv;
12459 /* Add an entry to the stack of typeahead storage. */
12460 if (ga_grow(&ga_userinput, 1) == OK)
12462 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12463 + ga_userinput.ga_len);
12464 ++ga_userinput.ga_len;
12465 /* default return is zero == OK */
12467 else
12468 rettv->vval.v_number = 1; /* Failed */
12472 * "inputsecret()" function
12474 static void
12475 f_inputsecret(argvars, rettv)
12476 typval_T *argvars;
12477 typval_T *rettv;
12479 ++cmdline_star;
12480 ++inputsecret_flag;
12481 f_input(argvars, rettv);
12482 --cmdline_star;
12483 --inputsecret_flag;
12487 * "insert()" function
12489 static void
12490 f_insert(argvars, rettv)
12491 typval_T *argvars;
12492 typval_T *rettv;
12494 long before = 0;
12495 listitem_T *item;
12496 list_T *l;
12497 int error = FALSE;
12499 if (argvars[0].v_type != VAR_LIST)
12500 EMSG2(_(e_listarg), "insert()");
12501 else if ((l = argvars[0].vval.v_list) != NULL
12502 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12504 if (argvars[2].v_type != VAR_UNKNOWN)
12505 before = get_tv_number_chk(&argvars[2], &error);
12506 if (error)
12507 return; /* type error; errmsg already given */
12509 if (before == l->lv_len)
12510 item = NULL;
12511 else
12513 item = list_find(l, before);
12514 if (item == NULL)
12516 EMSGN(_(e_listidx), before);
12517 l = NULL;
12520 if (l != NULL)
12522 list_insert_tv(l, &argvars[1], item);
12523 copy_tv(&argvars[0], rettv);
12529 * "isdirectory()" function
12531 static void
12532 f_isdirectory(argvars, rettv)
12533 typval_T *argvars;
12534 typval_T *rettv;
12536 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12540 * "islocked()" function
12542 static void
12543 f_islocked(argvars, rettv)
12544 typval_T *argvars;
12545 typval_T *rettv;
12547 lval_T lv;
12548 char_u *end;
12549 dictitem_T *di;
12551 rettv->vval.v_number = -1;
12552 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12553 FNE_CHECK_START);
12554 if (end != NULL && lv.ll_name != NULL)
12556 if (*end != NUL)
12557 EMSG(_(e_trailing));
12558 else
12560 if (lv.ll_tv == NULL)
12562 if (check_changedtick(lv.ll_name))
12563 rettv->vval.v_number = 1; /* always locked */
12564 else
12566 di = find_var(lv.ll_name, NULL);
12567 if (di != NULL)
12569 /* Consider a variable locked when:
12570 * 1. the variable itself is locked
12571 * 2. the value of the variable is locked.
12572 * 3. the List or Dict value is locked.
12574 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12575 || tv_islocked(&di->di_tv));
12579 else if (lv.ll_range)
12580 EMSG(_("E786: Range not allowed"));
12581 else if (lv.ll_newkey != NULL)
12582 EMSG2(_(e_dictkey), lv.ll_newkey);
12583 else if (lv.ll_list != NULL)
12584 /* List item. */
12585 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12586 else
12587 /* Dictionary item. */
12588 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12592 clear_lval(&lv);
12595 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12598 * Turn a dict into a list:
12599 * "what" == 0: list of keys
12600 * "what" == 1: list of values
12601 * "what" == 2: list of items
12603 static void
12604 dict_list(argvars, rettv, what)
12605 typval_T *argvars;
12606 typval_T *rettv;
12607 int what;
12609 list_T *l2;
12610 dictitem_T *di;
12611 hashitem_T *hi;
12612 listitem_T *li;
12613 listitem_T *li2;
12614 dict_T *d;
12615 int todo;
12617 if (argvars[0].v_type != VAR_DICT)
12619 EMSG(_(e_dictreq));
12620 return;
12622 if ((d = argvars[0].vval.v_dict) == NULL)
12623 return;
12625 if (rettv_list_alloc(rettv) == FAIL)
12626 return;
12628 todo = (int)d->dv_hashtab.ht_used;
12629 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12631 if (!HASHITEM_EMPTY(hi))
12633 --todo;
12634 di = HI2DI(hi);
12636 li = listitem_alloc();
12637 if (li == NULL)
12638 break;
12639 list_append(rettv->vval.v_list, li);
12641 if (what == 0)
12643 /* keys() */
12644 li->li_tv.v_type = VAR_STRING;
12645 li->li_tv.v_lock = 0;
12646 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12648 else if (what == 1)
12650 /* values() */
12651 copy_tv(&di->di_tv, &li->li_tv);
12653 else
12655 /* items() */
12656 l2 = list_alloc();
12657 li->li_tv.v_type = VAR_LIST;
12658 li->li_tv.v_lock = 0;
12659 li->li_tv.vval.v_list = l2;
12660 if (l2 == NULL)
12661 break;
12662 ++l2->lv_refcount;
12664 li2 = listitem_alloc();
12665 if (li2 == NULL)
12666 break;
12667 list_append(l2, li2);
12668 li2->li_tv.v_type = VAR_STRING;
12669 li2->li_tv.v_lock = 0;
12670 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12672 li2 = listitem_alloc();
12673 if (li2 == NULL)
12674 break;
12675 list_append(l2, li2);
12676 copy_tv(&di->di_tv, &li2->li_tv);
12683 * "items(dict)" function
12685 static void
12686 f_items(argvars, rettv)
12687 typval_T *argvars;
12688 typval_T *rettv;
12690 dict_list(argvars, rettv, 2);
12694 * "join()" function
12696 static void
12697 f_join(argvars, rettv)
12698 typval_T *argvars;
12699 typval_T *rettv;
12701 garray_T ga;
12702 char_u *sep;
12704 if (argvars[0].v_type != VAR_LIST)
12706 EMSG(_(e_listreq));
12707 return;
12709 if (argvars[0].vval.v_list == NULL)
12710 return;
12711 if (argvars[1].v_type == VAR_UNKNOWN)
12712 sep = (char_u *)" ";
12713 else
12714 sep = get_tv_string_chk(&argvars[1]);
12716 rettv->v_type = VAR_STRING;
12718 if (sep != NULL)
12720 ga_init2(&ga, (int)sizeof(char), 80);
12721 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12722 ga_append(&ga, NUL);
12723 rettv->vval.v_string = (char_u *)ga.ga_data;
12725 else
12726 rettv->vval.v_string = NULL;
12730 * "keys()" function
12732 static void
12733 f_keys(argvars, rettv)
12734 typval_T *argvars;
12735 typval_T *rettv;
12737 dict_list(argvars, rettv, 0);
12741 * "last_buffer_nr()" function.
12743 static void
12744 f_last_buffer_nr(argvars, rettv)
12745 typval_T *argvars UNUSED;
12746 typval_T *rettv;
12748 int n = 0;
12749 buf_T *buf;
12751 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12752 if (n < buf->b_fnum)
12753 n = buf->b_fnum;
12755 rettv->vval.v_number = n;
12759 * "len()" function
12761 static void
12762 f_len(argvars, rettv)
12763 typval_T *argvars;
12764 typval_T *rettv;
12766 switch (argvars[0].v_type)
12768 case VAR_STRING:
12769 case VAR_NUMBER:
12770 rettv->vval.v_number = (varnumber_T)STRLEN(
12771 get_tv_string(&argvars[0]));
12772 break;
12773 case VAR_LIST:
12774 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12775 break;
12776 case VAR_DICT:
12777 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12778 break;
12779 default:
12780 EMSG(_("E701: Invalid type for len()"));
12781 break;
12785 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12787 static void
12788 libcall_common(argvars, rettv, type)
12789 typval_T *argvars;
12790 typval_T *rettv;
12791 int type;
12793 #ifdef FEAT_LIBCALL
12794 char_u *string_in;
12795 char_u **string_result;
12796 int nr_result;
12797 #endif
12799 rettv->v_type = type;
12800 if (type != VAR_NUMBER)
12801 rettv->vval.v_string = NULL;
12803 if (check_restricted() || check_secure())
12804 return;
12806 #ifdef FEAT_LIBCALL
12807 /* The first two args must be strings, otherwise its meaningless */
12808 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12810 string_in = NULL;
12811 if (argvars[2].v_type == VAR_STRING)
12812 string_in = argvars[2].vval.v_string;
12813 if (type == VAR_NUMBER)
12814 string_result = NULL;
12815 else
12816 string_result = &rettv->vval.v_string;
12817 if (mch_libcall(argvars[0].vval.v_string,
12818 argvars[1].vval.v_string,
12819 string_in,
12820 argvars[2].vval.v_number,
12821 string_result,
12822 &nr_result) == OK
12823 && type == VAR_NUMBER)
12824 rettv->vval.v_number = nr_result;
12826 #endif
12830 * "libcall()" function
12832 static void
12833 f_libcall(argvars, rettv)
12834 typval_T *argvars;
12835 typval_T *rettv;
12837 libcall_common(argvars, rettv, VAR_STRING);
12841 * "libcallnr()" function
12843 static void
12844 f_libcallnr(argvars, rettv)
12845 typval_T *argvars;
12846 typval_T *rettv;
12848 libcall_common(argvars, rettv, VAR_NUMBER);
12852 * "line(string)" function
12854 static void
12855 f_line(argvars, rettv)
12856 typval_T *argvars;
12857 typval_T *rettv;
12859 linenr_T lnum = 0;
12860 pos_T *fp;
12861 int fnum;
12863 fp = var2fpos(&argvars[0], TRUE, &fnum);
12864 if (fp != NULL)
12865 lnum = fp->lnum;
12866 rettv->vval.v_number = lnum;
12870 * "line2byte(lnum)" function
12872 static void
12873 f_line2byte(argvars, rettv)
12874 typval_T *argvars UNUSED;
12875 typval_T *rettv;
12877 #ifndef FEAT_BYTEOFF
12878 rettv->vval.v_number = -1;
12879 #else
12880 linenr_T lnum;
12882 lnum = get_tv_lnum(argvars);
12883 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12884 rettv->vval.v_number = -1;
12885 else
12886 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12887 if (rettv->vval.v_number >= 0)
12888 ++rettv->vval.v_number;
12889 #endif
12893 * "lispindent(lnum)" function
12895 static void
12896 f_lispindent(argvars, rettv)
12897 typval_T *argvars;
12898 typval_T *rettv;
12900 #ifdef FEAT_LISP
12901 pos_T pos;
12902 linenr_T lnum;
12904 pos = curwin->w_cursor;
12905 lnum = get_tv_lnum(argvars);
12906 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12908 curwin->w_cursor.lnum = lnum;
12909 rettv->vval.v_number = get_lisp_indent();
12910 curwin->w_cursor = pos;
12912 else
12913 #endif
12914 rettv->vval.v_number = -1;
12918 * "localtime()" function
12920 static void
12921 f_localtime(argvars, rettv)
12922 typval_T *argvars UNUSED;
12923 typval_T *rettv;
12925 rettv->vval.v_number = (varnumber_T)time(NULL);
12928 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12930 static void
12931 get_maparg(argvars, rettv, exact)
12932 typval_T *argvars;
12933 typval_T *rettv;
12934 int exact;
12936 char_u *keys;
12937 char_u *which;
12938 char_u buf[NUMBUFLEN];
12939 char_u *keys_buf = NULL;
12940 char_u *rhs;
12941 int mode;
12942 garray_T ga;
12943 int abbr = FALSE;
12945 /* return empty string for failure */
12946 rettv->v_type = VAR_STRING;
12947 rettv->vval.v_string = NULL;
12949 keys = get_tv_string(&argvars[0]);
12950 if (*keys == NUL)
12951 return;
12953 if (argvars[1].v_type != VAR_UNKNOWN)
12955 which = get_tv_string_buf_chk(&argvars[1], buf);
12956 if (argvars[2].v_type != VAR_UNKNOWN)
12957 abbr = get_tv_number(&argvars[2]);
12959 else
12960 which = (char_u *)"";
12961 if (which == NULL)
12962 return;
12964 mode = get_map_mode(&which, 0);
12966 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12967 rhs = check_map(keys, mode, exact, FALSE, abbr);
12968 vim_free(keys_buf);
12969 if (rhs != NULL)
12971 ga_init(&ga);
12972 ga.ga_itemsize = 1;
12973 ga.ga_growsize = 40;
12975 while (*rhs != NUL)
12976 ga_concat(&ga, str2special(&rhs, FALSE));
12978 ga_append(&ga, NUL);
12979 rettv->vval.v_string = (char_u *)ga.ga_data;
12983 #ifdef FEAT_FLOAT
12985 * "log10()" function
12987 static void
12988 f_log10(argvars, rettv)
12989 typval_T *argvars;
12990 typval_T *rettv;
12992 float_T f;
12994 rettv->v_type = VAR_FLOAT;
12995 if (get_float_arg(argvars, &f) == OK)
12996 rettv->vval.v_float = log10(f);
12997 else
12998 rettv->vval.v_float = 0.0;
13000 #endif
13003 * "map()" function
13005 static void
13006 f_map(argvars, rettv)
13007 typval_T *argvars;
13008 typval_T *rettv;
13010 filter_map(argvars, rettv, TRUE);
13014 * "maparg()" function
13016 static void
13017 f_maparg(argvars, rettv)
13018 typval_T *argvars;
13019 typval_T *rettv;
13021 get_maparg(argvars, rettv, TRUE);
13025 * "mapcheck()" function
13027 static void
13028 f_mapcheck(argvars, rettv)
13029 typval_T *argvars;
13030 typval_T *rettv;
13032 get_maparg(argvars, rettv, FALSE);
13035 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13037 static void
13038 find_some_match(argvars, rettv, type)
13039 typval_T *argvars;
13040 typval_T *rettv;
13041 int type;
13043 char_u *str = NULL;
13044 char_u *expr = NULL;
13045 char_u *pat;
13046 regmatch_T regmatch;
13047 char_u patbuf[NUMBUFLEN];
13048 char_u strbuf[NUMBUFLEN];
13049 char_u *save_cpo;
13050 long start = 0;
13051 long nth = 1;
13052 colnr_T startcol = 0;
13053 int match = 0;
13054 list_T *l = NULL;
13055 listitem_T *li = NULL;
13056 long idx = 0;
13057 char_u *tofree = NULL;
13059 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13060 save_cpo = p_cpo;
13061 p_cpo = (char_u *)"";
13063 rettv->vval.v_number = -1;
13064 if (type == 3)
13066 /* return empty list when there are no matches */
13067 if (rettv_list_alloc(rettv) == FAIL)
13068 goto theend;
13070 else if (type == 2)
13072 rettv->v_type = VAR_STRING;
13073 rettv->vval.v_string = NULL;
13076 if (argvars[0].v_type == VAR_LIST)
13078 if ((l = argvars[0].vval.v_list) == NULL)
13079 goto theend;
13080 li = l->lv_first;
13082 else
13083 expr = str = get_tv_string(&argvars[0]);
13085 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13086 if (pat == NULL)
13087 goto theend;
13089 if (argvars[2].v_type != VAR_UNKNOWN)
13091 int error = FALSE;
13093 start = get_tv_number_chk(&argvars[2], &error);
13094 if (error)
13095 goto theend;
13096 if (l != NULL)
13098 li = list_find(l, start);
13099 if (li == NULL)
13100 goto theend;
13101 idx = l->lv_idx; /* use the cached index */
13103 else
13105 if (start < 0)
13106 start = 0;
13107 if (start > (long)STRLEN(str))
13108 goto theend;
13109 /* When "count" argument is there ignore matches before "start",
13110 * otherwise skip part of the string. Differs when pattern is "^"
13111 * or "\<". */
13112 if (argvars[3].v_type != VAR_UNKNOWN)
13113 startcol = start;
13114 else
13115 str += start;
13118 if (argvars[3].v_type != VAR_UNKNOWN)
13119 nth = get_tv_number_chk(&argvars[3], &error);
13120 if (error)
13121 goto theend;
13124 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13125 if (regmatch.regprog != NULL)
13127 regmatch.rm_ic = p_ic;
13129 for (;;)
13131 if (l != NULL)
13133 if (li == NULL)
13135 match = FALSE;
13136 break;
13138 vim_free(tofree);
13139 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13140 if (str == NULL)
13141 break;
13144 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13146 if (match && --nth <= 0)
13147 break;
13148 if (l == NULL && !match)
13149 break;
13151 /* Advance to just after the match. */
13152 if (l != NULL)
13154 li = li->li_next;
13155 ++idx;
13157 else
13159 #ifdef FEAT_MBYTE
13160 startcol = (colnr_T)(regmatch.startp[0]
13161 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13162 #else
13163 startcol = regmatch.startp[0] + 1 - str;
13164 #endif
13168 if (match)
13170 if (type == 3)
13172 int i;
13174 /* return list with matched string and submatches */
13175 for (i = 0; i < NSUBEXP; ++i)
13177 if (regmatch.endp[i] == NULL)
13179 if (list_append_string(rettv->vval.v_list,
13180 (char_u *)"", 0) == FAIL)
13181 break;
13183 else if (list_append_string(rettv->vval.v_list,
13184 regmatch.startp[i],
13185 (int)(regmatch.endp[i] - regmatch.startp[i]))
13186 == FAIL)
13187 break;
13190 else if (type == 2)
13192 /* return matched string */
13193 if (l != NULL)
13194 copy_tv(&li->li_tv, rettv);
13195 else
13196 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13197 (int)(regmatch.endp[0] - regmatch.startp[0]));
13199 else if (l != NULL)
13200 rettv->vval.v_number = idx;
13201 else
13203 if (type != 0)
13204 rettv->vval.v_number =
13205 (varnumber_T)(regmatch.startp[0] - str);
13206 else
13207 rettv->vval.v_number =
13208 (varnumber_T)(regmatch.endp[0] - str);
13209 rettv->vval.v_number += (varnumber_T)(str - expr);
13212 vim_free(regmatch.regprog);
13215 theend:
13216 vim_free(tofree);
13217 p_cpo = save_cpo;
13221 * "match()" function
13223 static void
13224 f_match(argvars, rettv)
13225 typval_T *argvars;
13226 typval_T *rettv;
13228 find_some_match(argvars, rettv, 1);
13232 * "matchadd()" function
13234 static void
13235 f_matchadd(argvars, rettv)
13236 typval_T *argvars;
13237 typval_T *rettv;
13239 #ifdef FEAT_SEARCH_EXTRA
13240 char_u buf[NUMBUFLEN];
13241 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13242 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13243 int prio = 10; /* default priority */
13244 int id = -1;
13245 int error = FALSE;
13247 rettv->vval.v_number = -1;
13249 if (grp == NULL || pat == NULL)
13250 return;
13251 if (argvars[2].v_type != VAR_UNKNOWN)
13253 prio = get_tv_number_chk(&argvars[2], &error);
13254 if (argvars[3].v_type != VAR_UNKNOWN)
13255 id = get_tv_number_chk(&argvars[3], &error);
13257 if (error == TRUE)
13258 return;
13259 if (id >= 1 && id <= 3)
13261 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13262 return;
13265 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13266 #endif
13270 * "matcharg()" function
13272 static void
13273 f_matcharg(argvars, rettv)
13274 typval_T *argvars;
13275 typval_T *rettv;
13277 if (rettv_list_alloc(rettv) == OK)
13279 #ifdef FEAT_SEARCH_EXTRA
13280 int id = get_tv_number(&argvars[0]);
13281 matchitem_T *m;
13283 if (id >= 1 && id <= 3)
13285 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13287 list_append_string(rettv->vval.v_list,
13288 syn_id2name(m->hlg_id), -1);
13289 list_append_string(rettv->vval.v_list, m->pattern, -1);
13291 else
13293 list_append_string(rettv->vval.v_list, NUL, -1);
13294 list_append_string(rettv->vval.v_list, NUL, -1);
13297 #endif
13302 * "matchdelete()" function
13304 static void
13305 f_matchdelete(argvars, rettv)
13306 typval_T *argvars;
13307 typval_T *rettv;
13309 #ifdef FEAT_SEARCH_EXTRA
13310 rettv->vval.v_number = match_delete(curwin,
13311 (int)get_tv_number(&argvars[0]), TRUE);
13312 #endif
13316 * "matchend()" function
13318 static void
13319 f_matchend(argvars, rettv)
13320 typval_T *argvars;
13321 typval_T *rettv;
13323 find_some_match(argvars, rettv, 0);
13327 * "matchlist()" function
13329 static void
13330 f_matchlist(argvars, rettv)
13331 typval_T *argvars;
13332 typval_T *rettv;
13334 find_some_match(argvars, rettv, 3);
13338 * "matchstr()" function
13340 static void
13341 f_matchstr(argvars, rettv)
13342 typval_T *argvars;
13343 typval_T *rettv;
13345 find_some_match(argvars, rettv, 2);
13348 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13350 static void
13351 max_min(argvars, rettv, domax)
13352 typval_T *argvars;
13353 typval_T *rettv;
13354 int domax;
13356 long n = 0;
13357 long i;
13358 int error = FALSE;
13360 if (argvars[0].v_type == VAR_LIST)
13362 list_T *l;
13363 listitem_T *li;
13365 l = argvars[0].vval.v_list;
13366 if (l != NULL)
13368 li = l->lv_first;
13369 if (li != NULL)
13371 n = get_tv_number_chk(&li->li_tv, &error);
13372 for (;;)
13374 li = li->li_next;
13375 if (li == NULL)
13376 break;
13377 i = get_tv_number_chk(&li->li_tv, &error);
13378 if (domax ? i > n : i < n)
13379 n = i;
13384 else if (argvars[0].v_type == VAR_DICT)
13386 dict_T *d;
13387 int first = TRUE;
13388 hashitem_T *hi;
13389 int todo;
13391 d = argvars[0].vval.v_dict;
13392 if (d != NULL)
13394 todo = (int)d->dv_hashtab.ht_used;
13395 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13397 if (!HASHITEM_EMPTY(hi))
13399 --todo;
13400 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13401 if (first)
13403 n = i;
13404 first = FALSE;
13406 else if (domax ? i > n : i < n)
13407 n = i;
13412 else
13413 EMSG(_(e_listdictarg));
13414 rettv->vval.v_number = error ? 0 : n;
13418 * "max()" function
13420 static void
13421 f_max(argvars, rettv)
13422 typval_T *argvars;
13423 typval_T *rettv;
13425 max_min(argvars, rettv, TRUE);
13429 * "min()" function
13431 static void
13432 f_min(argvars, rettv)
13433 typval_T *argvars;
13434 typval_T *rettv;
13436 max_min(argvars, rettv, FALSE);
13439 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13442 * Create the directory in which "dir" is located, and higher levels when
13443 * needed.
13445 static int
13446 mkdir_recurse(dir, prot)
13447 char_u *dir;
13448 int prot;
13450 char_u *p;
13451 char_u *updir;
13452 int r = FAIL;
13454 /* Get end of directory name in "dir".
13455 * We're done when it's "/" or "c:/". */
13456 p = gettail_sep(dir);
13457 if (p <= get_past_head(dir))
13458 return OK;
13460 /* If the directory exists we're done. Otherwise: create it.*/
13461 updir = vim_strnsave(dir, (int)(p - dir));
13462 if (updir == NULL)
13463 return FAIL;
13464 if (mch_isdir(updir))
13465 r = OK;
13466 else if (mkdir_recurse(updir, prot) == OK)
13467 r = vim_mkdir_emsg(updir, prot);
13468 vim_free(updir);
13469 return r;
13472 #ifdef vim_mkdir
13474 * "mkdir()" function
13476 static void
13477 f_mkdir(argvars, rettv)
13478 typval_T *argvars;
13479 typval_T *rettv;
13481 char_u *dir;
13482 char_u buf[NUMBUFLEN];
13483 int prot = 0755;
13485 rettv->vval.v_number = FAIL;
13486 if (check_restricted() || check_secure())
13487 return;
13489 dir = get_tv_string_buf(&argvars[0], buf);
13490 if (argvars[1].v_type != VAR_UNKNOWN)
13492 if (argvars[2].v_type != VAR_UNKNOWN)
13493 prot = get_tv_number_chk(&argvars[2], NULL);
13494 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13495 mkdir_recurse(dir, prot);
13497 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13499 #endif
13502 * "mode()" function
13504 static void
13505 f_mode(argvars, rettv)
13506 typval_T *argvars;
13507 typval_T *rettv;
13509 char_u buf[3];
13511 buf[1] = NUL;
13512 buf[2] = NUL;
13514 #ifdef FEAT_VISUAL
13515 if (VIsual_active)
13517 if (VIsual_select)
13518 buf[0] = VIsual_mode + 's' - 'v';
13519 else
13520 buf[0] = VIsual_mode;
13522 else
13523 #endif
13524 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13525 || State == CONFIRM)
13527 buf[0] = 'r';
13528 if (State == ASKMORE)
13529 buf[1] = 'm';
13530 else if (State == CONFIRM)
13531 buf[1] = '?';
13533 else if (State == EXTERNCMD)
13534 buf[0] = '!';
13535 else if (State & INSERT)
13537 #ifdef FEAT_VREPLACE
13538 if (State & VREPLACE_FLAG)
13540 buf[0] = 'R';
13541 buf[1] = 'v';
13543 else
13544 #endif
13545 if (State & REPLACE_FLAG)
13546 buf[0] = 'R';
13547 else
13548 buf[0] = 'i';
13550 else if (State & CMDLINE)
13552 buf[0] = 'c';
13553 if (exmode_active)
13554 buf[1] = 'v';
13556 else if (exmode_active)
13558 buf[0] = 'c';
13559 buf[1] = 'e';
13561 else
13563 buf[0] = 'n';
13564 if (finish_op)
13565 buf[1] = 'o';
13568 /* Clear out the minor mode when the argument is not a non-zero number or
13569 * non-empty string. */
13570 if (!non_zero_arg(&argvars[0]))
13571 buf[1] = NUL;
13573 rettv->vval.v_string = vim_strsave(buf);
13574 rettv->v_type = VAR_STRING;
13578 * "nextnonblank()" function
13580 static void
13581 f_nextnonblank(argvars, rettv)
13582 typval_T *argvars;
13583 typval_T *rettv;
13585 linenr_T lnum;
13587 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13589 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13591 lnum = 0;
13592 break;
13594 if (*skipwhite(ml_get(lnum)) != NUL)
13595 break;
13597 rettv->vval.v_number = lnum;
13601 * "nr2char()" function
13603 static void
13604 f_nr2char(argvars, rettv)
13605 typval_T *argvars;
13606 typval_T *rettv;
13608 char_u buf[NUMBUFLEN];
13610 #ifdef FEAT_MBYTE
13611 if (has_mbyte)
13612 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13613 else
13614 #endif
13616 buf[0] = (char_u)get_tv_number(&argvars[0]);
13617 buf[1] = NUL;
13619 rettv->v_type = VAR_STRING;
13620 rettv->vval.v_string = vim_strsave(buf);
13624 * "pathshorten()" function
13626 static void
13627 f_pathshorten(argvars, rettv)
13628 typval_T *argvars;
13629 typval_T *rettv;
13631 char_u *p;
13633 rettv->v_type = VAR_STRING;
13634 p = get_tv_string_chk(&argvars[0]);
13635 if (p == NULL)
13636 rettv->vval.v_string = NULL;
13637 else
13639 p = vim_strsave(p);
13640 rettv->vval.v_string = p;
13641 if (p != NULL)
13642 shorten_dir(p);
13646 #ifdef FEAT_FLOAT
13648 * "pow()" function
13650 static void
13651 f_pow(argvars, rettv)
13652 typval_T *argvars;
13653 typval_T *rettv;
13655 float_T fx, fy;
13657 rettv->v_type = VAR_FLOAT;
13658 if (get_float_arg(argvars, &fx) == OK
13659 && get_float_arg(&argvars[1], &fy) == OK)
13660 rettv->vval.v_float = pow(fx, fy);
13661 else
13662 rettv->vval.v_float = 0.0;
13664 #endif
13667 * "prevnonblank()" function
13669 static void
13670 f_prevnonblank(argvars, rettv)
13671 typval_T *argvars;
13672 typval_T *rettv;
13674 linenr_T lnum;
13676 lnum = get_tv_lnum(argvars);
13677 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13678 lnum = 0;
13679 else
13680 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13681 --lnum;
13682 rettv->vval.v_number = lnum;
13685 #ifdef HAVE_STDARG_H
13686 /* This dummy va_list is here because:
13687 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13688 * - locally in the function results in a "used before set" warning
13689 * - using va_start() to initialize it gives "function with fixed args" error */
13690 static va_list ap;
13691 #endif
13694 * "printf()" function
13696 static void
13697 f_printf(argvars, rettv)
13698 typval_T *argvars;
13699 typval_T *rettv;
13701 rettv->v_type = VAR_STRING;
13702 rettv->vval.v_string = NULL;
13703 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13705 char_u buf[NUMBUFLEN];
13706 int len;
13707 char_u *s;
13708 int saved_did_emsg = did_emsg;
13709 char *fmt;
13711 /* Get the required length, allocate the buffer and do it for real. */
13712 did_emsg = FALSE;
13713 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13714 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13715 if (!did_emsg)
13717 s = alloc(len + 1);
13718 if (s != NULL)
13720 rettv->vval.v_string = s;
13721 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13724 did_emsg |= saved_did_emsg;
13726 #endif
13730 * "pumvisible()" function
13732 static void
13733 f_pumvisible(argvars, rettv)
13734 typval_T *argvars UNUSED;
13735 typval_T *rettv UNUSED;
13737 #ifdef FEAT_INS_EXPAND
13738 if (pum_visible())
13739 rettv->vval.v_number = 1;
13740 #endif
13744 * "range()" function
13746 static void
13747 f_range(argvars, rettv)
13748 typval_T *argvars;
13749 typval_T *rettv;
13751 long start;
13752 long end;
13753 long stride = 1;
13754 long i;
13755 int error = FALSE;
13757 start = get_tv_number_chk(&argvars[0], &error);
13758 if (argvars[1].v_type == VAR_UNKNOWN)
13760 end = start - 1;
13761 start = 0;
13763 else
13765 end = get_tv_number_chk(&argvars[1], &error);
13766 if (argvars[2].v_type != VAR_UNKNOWN)
13767 stride = get_tv_number_chk(&argvars[2], &error);
13770 if (error)
13771 return; /* type error; errmsg already given */
13772 if (stride == 0)
13773 EMSG(_("E726: Stride is zero"));
13774 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13775 EMSG(_("E727: Start past end"));
13776 else
13778 if (rettv_list_alloc(rettv) == OK)
13779 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13780 if (list_append_number(rettv->vval.v_list,
13781 (varnumber_T)i) == FAIL)
13782 break;
13787 * "readfile()" function
13789 static void
13790 f_readfile(argvars, rettv)
13791 typval_T *argvars;
13792 typval_T *rettv;
13794 int binary = FALSE;
13795 char_u *fname;
13796 FILE *fd;
13797 listitem_T *li;
13798 #define FREAD_SIZE 200 /* optimized for text lines */
13799 char_u buf[FREAD_SIZE];
13800 int readlen; /* size of last fread() */
13801 int buflen; /* nr of valid chars in buf[] */
13802 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13803 int tolist; /* first byte in buf[] still to be put in list */
13804 int chop; /* how many CR to chop off */
13805 char_u *prev = NULL; /* previously read bytes, if any */
13806 int prevlen = 0; /* length of "prev" if not NULL */
13807 char_u *s;
13808 int len;
13809 long maxline = MAXLNUM;
13810 long cnt = 0;
13812 if (argvars[1].v_type != VAR_UNKNOWN)
13814 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13815 binary = TRUE;
13816 if (argvars[2].v_type != VAR_UNKNOWN)
13817 maxline = get_tv_number(&argvars[2]);
13820 if (rettv_list_alloc(rettv) == FAIL)
13821 return;
13823 /* Always open the file in binary mode, library functions have a mind of
13824 * their own about CR-LF conversion. */
13825 fname = get_tv_string(&argvars[0]);
13826 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13828 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13829 return;
13832 filtd = 0;
13833 while (cnt < maxline || maxline < 0)
13835 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13836 buflen = filtd + readlen;
13837 tolist = 0;
13838 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13840 if (buf[filtd] == '\n' || readlen <= 0)
13842 /* Only when in binary mode add an empty list item when the
13843 * last line ends in a '\n'. */
13844 if (!binary && readlen == 0 && filtd == 0)
13845 break;
13847 /* Found end-of-line or end-of-file: add a text line to the
13848 * list. */
13849 chop = 0;
13850 if (!binary)
13851 while (filtd - chop - 1 >= tolist
13852 && buf[filtd - chop - 1] == '\r')
13853 ++chop;
13854 len = filtd - tolist - chop;
13855 if (prev == NULL)
13856 s = vim_strnsave(buf + tolist, len);
13857 else
13859 s = alloc((unsigned)(prevlen + len + 1));
13860 if (s != NULL)
13862 mch_memmove(s, prev, prevlen);
13863 vim_free(prev);
13864 prev = NULL;
13865 mch_memmove(s + prevlen, buf + tolist, len);
13866 s[prevlen + len] = NUL;
13869 tolist = filtd + 1;
13871 li = listitem_alloc();
13872 if (li == NULL)
13874 vim_free(s);
13875 break;
13877 li->li_tv.v_type = VAR_STRING;
13878 li->li_tv.v_lock = 0;
13879 li->li_tv.vval.v_string = s;
13880 list_append(rettv->vval.v_list, li);
13882 if (++cnt >= maxline && maxline >= 0)
13883 break;
13884 if (readlen <= 0)
13885 break;
13887 else if (buf[filtd] == NUL)
13888 buf[filtd] = '\n';
13890 if (readlen <= 0)
13891 break;
13893 if (tolist == 0)
13895 /* "buf" is full, need to move text to an allocated buffer */
13896 if (prev == NULL)
13898 prev = vim_strnsave(buf, buflen);
13899 prevlen = buflen;
13901 else
13903 s = alloc((unsigned)(prevlen + buflen));
13904 if (s != NULL)
13906 mch_memmove(s, prev, prevlen);
13907 mch_memmove(s + prevlen, buf, buflen);
13908 vim_free(prev);
13909 prev = s;
13910 prevlen += buflen;
13913 filtd = 0;
13915 else
13917 mch_memmove(buf, buf + tolist, buflen - tolist);
13918 filtd -= tolist;
13923 * For a negative line count use only the lines at the end of the file,
13924 * free the rest.
13926 if (maxline < 0)
13927 while (cnt > -maxline)
13929 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13930 --cnt;
13933 vim_free(prev);
13934 fclose(fd);
13937 #if defined(FEAT_RELTIME)
13938 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13941 * Convert a List to proftime_T.
13942 * Return FAIL when there is something wrong.
13944 static int
13945 list2proftime(arg, tm)
13946 typval_T *arg;
13947 proftime_T *tm;
13949 long n1, n2;
13950 int error = FALSE;
13952 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13953 || arg->vval.v_list->lv_len != 2)
13954 return FAIL;
13955 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13956 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13957 # ifdef WIN3264
13958 tm->HighPart = n1;
13959 tm->LowPart = n2;
13960 # else
13961 tm->tv_sec = n1;
13962 tm->tv_usec = n2;
13963 # endif
13964 return error ? FAIL : OK;
13966 #endif /* FEAT_RELTIME */
13969 * "reltime()" function
13971 static void
13972 f_reltime(argvars, rettv)
13973 typval_T *argvars;
13974 typval_T *rettv;
13976 #ifdef FEAT_RELTIME
13977 proftime_T res;
13978 proftime_T start;
13980 if (argvars[0].v_type == VAR_UNKNOWN)
13982 /* No arguments: get current time. */
13983 profile_start(&res);
13985 else if (argvars[1].v_type == VAR_UNKNOWN)
13987 if (list2proftime(&argvars[0], &res) == FAIL)
13988 return;
13989 profile_end(&res);
13991 else
13993 /* Two arguments: compute the difference. */
13994 if (list2proftime(&argvars[0], &start) == FAIL
13995 || list2proftime(&argvars[1], &res) == FAIL)
13996 return;
13997 profile_sub(&res, &start);
14000 if (rettv_list_alloc(rettv) == OK)
14002 long n1, n2;
14004 # ifdef WIN3264
14005 n1 = res.HighPart;
14006 n2 = res.LowPart;
14007 # else
14008 n1 = res.tv_sec;
14009 n2 = res.tv_usec;
14010 # endif
14011 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14012 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14014 #endif
14018 * "reltimestr()" function
14020 static void
14021 f_reltimestr(argvars, rettv)
14022 typval_T *argvars;
14023 typval_T *rettv;
14025 #ifdef FEAT_RELTIME
14026 proftime_T tm;
14027 #endif
14029 rettv->v_type = VAR_STRING;
14030 rettv->vval.v_string = NULL;
14031 #ifdef FEAT_RELTIME
14032 if (list2proftime(&argvars[0], &tm) == OK)
14033 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14034 #endif
14037 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14038 static void make_connection __ARGS((void));
14039 static int check_connection __ARGS((void));
14041 static void
14042 make_connection()
14044 if (X_DISPLAY == NULL
14045 # ifdef FEAT_GUI
14046 && !gui.in_use
14047 # endif
14050 x_force_connect = TRUE;
14051 setup_term_clip();
14052 x_force_connect = FALSE;
14056 static int
14057 check_connection()
14059 make_connection();
14060 if (X_DISPLAY == NULL)
14062 EMSG(_("E240: No connection to Vim server"));
14063 return FAIL;
14065 return OK;
14067 #endif
14069 #ifdef FEAT_CLIENTSERVER
14070 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14072 static void
14073 remote_common(argvars, rettv, expr)
14074 typval_T *argvars;
14075 typval_T *rettv;
14076 int expr;
14078 char_u *server_name;
14079 char_u *keys;
14080 char_u *r = NULL;
14081 char_u buf[NUMBUFLEN];
14082 # ifdef WIN32
14083 HWND w;
14084 # else
14085 Window w;
14086 # endif
14088 if (check_restricted() || check_secure())
14089 return;
14091 # ifdef FEAT_X11
14092 if (check_connection() == FAIL)
14093 return;
14094 # endif
14096 server_name = get_tv_string_chk(&argvars[0]);
14097 if (server_name == NULL)
14098 return; /* type error; errmsg already given */
14099 keys = get_tv_string_buf(&argvars[1], buf);
14100 # ifdef WIN32
14101 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14102 # else
14103 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14104 < 0)
14105 # endif
14107 if (r != NULL)
14108 EMSG(r); /* sending worked but evaluation failed */
14109 else
14110 EMSG2(_("E241: Unable to send to %s"), server_name);
14111 return;
14114 rettv->vval.v_string = r;
14116 if (argvars[2].v_type != VAR_UNKNOWN)
14118 dictitem_T v;
14119 char_u str[30];
14120 char_u *idvar;
14122 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14123 v.di_tv.v_type = VAR_STRING;
14124 v.di_tv.vval.v_string = vim_strsave(str);
14125 idvar = get_tv_string_chk(&argvars[2]);
14126 if (idvar != NULL)
14127 set_var(idvar, &v.di_tv, FALSE);
14128 vim_free(v.di_tv.vval.v_string);
14131 #endif
14134 * "remote_expr()" function
14136 static void
14137 f_remote_expr(argvars, rettv)
14138 typval_T *argvars UNUSED;
14139 typval_T *rettv;
14141 rettv->v_type = VAR_STRING;
14142 rettv->vval.v_string = NULL;
14143 #ifdef FEAT_CLIENTSERVER
14144 remote_common(argvars, rettv, TRUE);
14145 #endif
14149 * "remote_foreground()" function
14151 static void
14152 f_remote_foreground(argvars, rettv)
14153 typval_T *argvars UNUSED;
14154 typval_T *rettv UNUSED;
14156 #ifdef FEAT_CLIENTSERVER
14157 # ifdef WIN32
14158 /* On Win32 it's done in this application. */
14160 char_u *server_name = get_tv_string_chk(&argvars[0]);
14162 if (server_name != NULL)
14163 serverForeground(server_name);
14165 # else
14166 /* Send a foreground() expression to the server. */
14167 argvars[1].v_type = VAR_STRING;
14168 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14169 argvars[2].v_type = VAR_UNKNOWN;
14170 remote_common(argvars, rettv, TRUE);
14171 vim_free(argvars[1].vval.v_string);
14172 # endif
14173 #endif
14176 static void
14177 f_remote_peek(argvars, rettv)
14178 typval_T *argvars UNUSED;
14179 typval_T *rettv;
14181 #ifdef FEAT_CLIENTSERVER
14182 dictitem_T v;
14183 char_u *s = NULL;
14184 # ifdef WIN32
14185 long_u n = 0;
14186 # endif
14187 char_u *serverid;
14189 if (check_restricted() || check_secure())
14191 rettv->vval.v_number = -1;
14192 return;
14194 serverid = get_tv_string_chk(&argvars[0]);
14195 if (serverid == NULL)
14197 rettv->vval.v_number = -1;
14198 return; /* type error; errmsg already given */
14200 # ifdef WIN32
14201 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14202 if (n == 0)
14203 rettv->vval.v_number = -1;
14204 else
14206 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14207 rettv->vval.v_number = (s != NULL);
14209 # else
14210 if (check_connection() == FAIL)
14211 return;
14213 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14214 serverStrToWin(serverid), &s);
14215 # endif
14217 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14219 char_u *retvar;
14221 v.di_tv.v_type = VAR_STRING;
14222 v.di_tv.vval.v_string = vim_strsave(s);
14223 retvar = get_tv_string_chk(&argvars[1]);
14224 if (retvar != NULL)
14225 set_var(retvar, &v.di_tv, FALSE);
14226 vim_free(v.di_tv.vval.v_string);
14228 #else
14229 rettv->vval.v_number = -1;
14230 #endif
14233 static void
14234 f_remote_read(argvars, rettv)
14235 typval_T *argvars UNUSED;
14236 typval_T *rettv;
14238 char_u *r = NULL;
14240 #ifdef FEAT_CLIENTSERVER
14241 char_u *serverid = get_tv_string_chk(&argvars[0]);
14243 if (serverid != NULL && !check_restricted() && !check_secure())
14245 # ifdef WIN32
14246 /* The server's HWND is encoded in the 'id' parameter */
14247 long_u n = 0;
14249 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14250 if (n != 0)
14251 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14252 if (r == NULL)
14253 # else
14254 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14255 serverStrToWin(serverid), &r, FALSE) < 0)
14256 # endif
14257 EMSG(_("E277: Unable to read a server reply"));
14259 #endif
14260 rettv->v_type = VAR_STRING;
14261 rettv->vval.v_string = r;
14265 * "remote_send()" function
14267 static void
14268 f_remote_send(argvars, rettv)
14269 typval_T *argvars UNUSED;
14270 typval_T *rettv;
14272 rettv->v_type = VAR_STRING;
14273 rettv->vval.v_string = NULL;
14274 #ifdef FEAT_CLIENTSERVER
14275 remote_common(argvars, rettv, FALSE);
14276 #endif
14280 * "remove()" function
14282 static void
14283 f_remove(argvars, rettv)
14284 typval_T *argvars;
14285 typval_T *rettv;
14287 list_T *l;
14288 listitem_T *item, *item2;
14289 listitem_T *li;
14290 long idx;
14291 long end;
14292 char_u *key;
14293 dict_T *d;
14294 dictitem_T *di;
14296 if (argvars[0].v_type == VAR_DICT)
14298 if (argvars[2].v_type != VAR_UNKNOWN)
14299 EMSG2(_(e_toomanyarg), "remove()");
14300 else if ((d = argvars[0].vval.v_dict) != NULL
14301 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14303 key = get_tv_string_chk(&argvars[1]);
14304 if (key != NULL)
14306 di = dict_find(d, key, -1);
14307 if (di == NULL)
14308 EMSG2(_(e_dictkey), key);
14309 else
14311 *rettv = di->di_tv;
14312 init_tv(&di->di_tv);
14313 dictitem_remove(d, di);
14318 else if (argvars[0].v_type != VAR_LIST)
14319 EMSG2(_(e_listdictarg), "remove()");
14320 else if ((l = argvars[0].vval.v_list) != NULL
14321 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14323 int error = FALSE;
14325 idx = get_tv_number_chk(&argvars[1], &error);
14326 if (error)
14327 ; /* type error: do nothing, errmsg already given */
14328 else if ((item = list_find(l, idx)) == NULL)
14329 EMSGN(_(e_listidx), idx);
14330 else
14332 if (argvars[2].v_type == VAR_UNKNOWN)
14334 /* Remove one item, return its value. */
14335 list_remove(l, item, item);
14336 *rettv = item->li_tv;
14337 vim_free(item);
14339 else
14341 /* Remove range of items, return list with values. */
14342 end = get_tv_number_chk(&argvars[2], &error);
14343 if (error)
14344 ; /* type error: do nothing */
14345 else if ((item2 = list_find(l, end)) == NULL)
14346 EMSGN(_(e_listidx), end);
14347 else
14349 int cnt = 0;
14351 for (li = item; li != NULL; li = li->li_next)
14353 ++cnt;
14354 if (li == item2)
14355 break;
14357 if (li == NULL) /* didn't find "item2" after "item" */
14358 EMSG(_(e_invrange));
14359 else
14361 list_remove(l, item, item2);
14362 if (rettv_list_alloc(rettv) == OK)
14364 l = rettv->vval.v_list;
14365 l->lv_first = item;
14366 l->lv_last = item2;
14367 item->li_prev = NULL;
14368 item2->li_next = NULL;
14369 l->lv_len = cnt;
14379 * "rename({from}, {to})" function
14381 static void
14382 f_rename(argvars, rettv)
14383 typval_T *argvars;
14384 typval_T *rettv;
14386 char_u buf[NUMBUFLEN];
14388 if (check_restricted() || check_secure())
14389 rettv->vval.v_number = -1;
14390 else
14391 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14392 get_tv_string_buf(&argvars[1], buf));
14396 * "repeat()" function
14398 static void
14399 f_repeat(argvars, rettv)
14400 typval_T *argvars;
14401 typval_T *rettv;
14403 char_u *p;
14404 int n;
14405 int slen;
14406 int len;
14407 char_u *r;
14408 int i;
14410 n = get_tv_number(&argvars[1]);
14411 if (argvars[0].v_type == VAR_LIST)
14413 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14414 while (n-- > 0)
14415 if (list_extend(rettv->vval.v_list,
14416 argvars[0].vval.v_list, NULL) == FAIL)
14417 break;
14419 else
14421 p = get_tv_string(&argvars[0]);
14422 rettv->v_type = VAR_STRING;
14423 rettv->vval.v_string = NULL;
14425 slen = (int)STRLEN(p);
14426 len = slen * n;
14427 if (len <= 0)
14428 return;
14430 r = alloc(len + 1);
14431 if (r != NULL)
14433 for (i = 0; i < n; i++)
14434 mch_memmove(r + i * slen, p, (size_t)slen);
14435 r[len] = NUL;
14438 rettv->vval.v_string = r;
14443 * "resolve()" function
14445 static void
14446 f_resolve(argvars, rettv)
14447 typval_T *argvars;
14448 typval_T *rettv;
14450 char_u *p;
14452 p = get_tv_string(&argvars[0]);
14453 #ifdef FEAT_SHORTCUT
14455 char_u *v = NULL;
14457 v = mch_resolve_shortcut(p);
14458 if (v != NULL)
14459 rettv->vval.v_string = v;
14460 else
14461 rettv->vval.v_string = vim_strsave(p);
14463 #else
14464 # ifdef HAVE_READLINK
14466 char_u buf[MAXPATHL + 1];
14467 char_u *cpy;
14468 int len;
14469 char_u *remain = NULL;
14470 char_u *q;
14471 int is_relative_to_current = FALSE;
14472 int has_trailing_pathsep = FALSE;
14473 int limit = 100;
14475 p = vim_strsave(p);
14477 if (p[0] == '.' && (vim_ispathsep(p[1])
14478 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14479 is_relative_to_current = TRUE;
14481 len = STRLEN(p);
14482 if (len > 0 && after_pathsep(p, p + len))
14483 has_trailing_pathsep = TRUE;
14485 q = getnextcomp(p);
14486 if (*q != NUL)
14488 /* Separate the first path component in "p", and keep the
14489 * remainder (beginning with the path separator). */
14490 remain = vim_strsave(q - 1);
14491 q[-1] = NUL;
14494 for (;;)
14496 for (;;)
14498 len = readlink((char *)p, (char *)buf, MAXPATHL);
14499 if (len <= 0)
14500 break;
14501 buf[len] = NUL;
14503 if (limit-- == 0)
14505 vim_free(p);
14506 vim_free(remain);
14507 EMSG(_("E655: Too many symbolic links (cycle?)"));
14508 rettv->vval.v_string = NULL;
14509 goto fail;
14512 /* Ensure that the result will have a trailing path separator
14513 * if the argument has one. */
14514 if (remain == NULL && has_trailing_pathsep)
14515 add_pathsep(buf);
14517 /* Separate the first path component in the link value and
14518 * concatenate the remainders. */
14519 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14520 if (*q != NUL)
14522 if (remain == NULL)
14523 remain = vim_strsave(q - 1);
14524 else
14526 cpy = concat_str(q - 1, remain);
14527 if (cpy != NULL)
14529 vim_free(remain);
14530 remain = cpy;
14533 q[-1] = NUL;
14536 q = gettail(p);
14537 if (q > p && *q == NUL)
14539 /* Ignore trailing path separator. */
14540 q[-1] = NUL;
14541 q = gettail(p);
14543 if (q > p && !mch_isFullName(buf))
14545 /* symlink is relative to directory of argument */
14546 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14547 if (cpy != NULL)
14549 STRCPY(cpy, p);
14550 STRCPY(gettail(cpy), buf);
14551 vim_free(p);
14552 p = cpy;
14555 else
14557 vim_free(p);
14558 p = vim_strsave(buf);
14562 if (remain == NULL)
14563 break;
14565 /* Append the first path component of "remain" to "p". */
14566 q = getnextcomp(remain + 1);
14567 len = q - remain - (*q != NUL);
14568 cpy = vim_strnsave(p, STRLEN(p) + len);
14569 if (cpy != NULL)
14571 STRNCAT(cpy, remain, len);
14572 vim_free(p);
14573 p = cpy;
14575 /* Shorten "remain". */
14576 if (*q != NUL)
14577 STRMOVE(remain, q - 1);
14578 else
14580 vim_free(remain);
14581 remain = NULL;
14585 /* If the result is a relative path name, make it explicitly relative to
14586 * the current directory if and only if the argument had this form. */
14587 if (!vim_ispathsep(*p))
14589 if (is_relative_to_current
14590 && *p != NUL
14591 && !(p[0] == '.'
14592 && (p[1] == NUL
14593 || vim_ispathsep(p[1])
14594 || (p[1] == '.'
14595 && (p[2] == NUL
14596 || vim_ispathsep(p[2]))))))
14598 /* Prepend "./". */
14599 cpy = concat_str((char_u *)"./", p);
14600 if (cpy != NULL)
14602 vim_free(p);
14603 p = cpy;
14606 else if (!is_relative_to_current)
14608 /* Strip leading "./". */
14609 q = p;
14610 while (q[0] == '.' && vim_ispathsep(q[1]))
14611 q += 2;
14612 if (q > p)
14613 STRMOVE(p, p + 2);
14617 /* Ensure that the result will have no trailing path separator
14618 * if the argument had none. But keep "/" or "//". */
14619 if (!has_trailing_pathsep)
14621 q = p + STRLEN(p);
14622 if (after_pathsep(p, q))
14623 *gettail_sep(p) = NUL;
14626 rettv->vval.v_string = p;
14628 # else
14629 rettv->vval.v_string = vim_strsave(p);
14630 # endif
14631 #endif
14633 simplify_filename(rettv->vval.v_string);
14635 #ifdef HAVE_READLINK
14636 fail:
14637 #endif
14638 rettv->v_type = VAR_STRING;
14642 * "reverse({list})" function
14644 static void
14645 f_reverse(argvars, rettv)
14646 typval_T *argvars;
14647 typval_T *rettv;
14649 list_T *l;
14650 listitem_T *li, *ni;
14652 if (argvars[0].v_type != VAR_LIST)
14653 EMSG2(_(e_listarg), "reverse()");
14654 else if ((l = argvars[0].vval.v_list) != NULL
14655 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14657 li = l->lv_last;
14658 l->lv_first = l->lv_last = NULL;
14659 l->lv_len = 0;
14660 while (li != NULL)
14662 ni = li->li_prev;
14663 list_append(l, li);
14664 li = ni;
14666 rettv->vval.v_list = l;
14667 rettv->v_type = VAR_LIST;
14668 ++l->lv_refcount;
14669 l->lv_idx = l->lv_len - l->lv_idx - 1;
14673 #define SP_NOMOVE 0x01 /* don't move cursor */
14674 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14675 #define SP_RETCOUNT 0x04 /* return matchcount */
14676 #define SP_SETPCMARK 0x08 /* set previous context mark */
14677 #define SP_START 0x10 /* accept match at start position */
14678 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14679 #define SP_END 0x40 /* leave cursor at end of match */
14681 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14684 * Get flags for a search function.
14685 * Possibly sets "p_ws".
14686 * Returns BACKWARD, FORWARD or zero (for an error).
14688 static int
14689 get_search_arg(varp, flagsp)
14690 typval_T *varp;
14691 int *flagsp;
14693 int dir = FORWARD;
14694 char_u *flags;
14695 char_u nbuf[NUMBUFLEN];
14696 int mask;
14698 if (varp->v_type != VAR_UNKNOWN)
14700 flags = get_tv_string_buf_chk(varp, nbuf);
14701 if (flags == NULL)
14702 return 0; /* type error; errmsg already given */
14703 while (*flags != NUL)
14705 switch (*flags)
14707 case 'b': dir = BACKWARD; break;
14708 case 'w': p_ws = TRUE; break;
14709 case 'W': p_ws = FALSE; break;
14710 default: mask = 0;
14711 if (flagsp != NULL)
14712 switch (*flags)
14714 case 'c': mask = SP_START; break;
14715 case 'e': mask = SP_END; break;
14716 case 'm': mask = SP_RETCOUNT; break;
14717 case 'n': mask = SP_NOMOVE; break;
14718 case 'p': mask = SP_SUBPAT; break;
14719 case 'r': mask = SP_REPEAT; break;
14720 case 's': mask = SP_SETPCMARK; break;
14722 if (mask == 0)
14724 EMSG2(_(e_invarg2), flags);
14725 dir = 0;
14727 else
14728 *flagsp |= mask;
14730 if (dir == 0)
14731 break;
14732 ++flags;
14735 return dir;
14739 * Shared by search() and searchpos() functions
14741 static int
14742 search_cmn(argvars, match_pos, flagsp)
14743 typval_T *argvars;
14744 pos_T *match_pos;
14745 int *flagsp;
14747 int flags;
14748 char_u *pat;
14749 pos_T pos;
14750 pos_T save_cursor;
14751 int save_p_ws = p_ws;
14752 int dir;
14753 int retval = 0; /* default: FAIL */
14754 long lnum_stop = 0;
14755 proftime_T tm;
14756 #ifdef FEAT_RELTIME
14757 long time_limit = 0;
14758 #endif
14759 int options = SEARCH_KEEP;
14760 int subpatnum;
14762 pat = get_tv_string(&argvars[0]);
14763 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14764 if (dir == 0)
14765 goto theend;
14766 flags = *flagsp;
14767 if (flags & SP_START)
14768 options |= SEARCH_START;
14769 if (flags & SP_END)
14770 options |= SEARCH_END;
14772 /* Optional arguments: line number to stop searching and timeout. */
14773 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14775 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14776 if (lnum_stop < 0)
14777 goto theend;
14778 #ifdef FEAT_RELTIME
14779 if (argvars[3].v_type != VAR_UNKNOWN)
14781 time_limit = get_tv_number_chk(&argvars[3], NULL);
14782 if (time_limit < 0)
14783 goto theend;
14785 #endif
14788 #ifdef FEAT_RELTIME
14789 /* Set the time limit, if there is one. */
14790 profile_setlimit(time_limit, &tm);
14791 #endif
14794 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14795 * Check to make sure only those flags are set.
14796 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14797 * flags cannot be set. Check for that condition also.
14799 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14800 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14802 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14803 goto theend;
14806 pos = save_cursor = curwin->w_cursor;
14807 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14808 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14809 if (subpatnum != FAIL)
14811 if (flags & SP_SUBPAT)
14812 retval = subpatnum;
14813 else
14814 retval = pos.lnum;
14815 if (flags & SP_SETPCMARK)
14816 setpcmark();
14817 curwin->w_cursor = pos;
14818 if (match_pos != NULL)
14820 /* Store the match cursor position */
14821 match_pos->lnum = pos.lnum;
14822 match_pos->col = pos.col + 1;
14824 /* "/$" will put the cursor after the end of the line, may need to
14825 * correct that here */
14826 check_cursor();
14829 /* If 'n' flag is used: restore cursor position. */
14830 if (flags & SP_NOMOVE)
14831 curwin->w_cursor = save_cursor;
14832 else
14833 curwin->w_set_curswant = TRUE;
14834 theend:
14835 p_ws = save_p_ws;
14837 return retval;
14840 #ifdef FEAT_FLOAT
14842 * "round({float})" function
14844 static void
14845 f_round(argvars, rettv)
14846 typval_T *argvars;
14847 typval_T *rettv;
14849 float_T f;
14851 rettv->v_type = VAR_FLOAT;
14852 if (get_float_arg(argvars, &f) == OK)
14853 /* round() is not in C90, use ceil() or floor() instead. */
14854 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14855 else
14856 rettv->vval.v_float = 0.0;
14858 #endif
14861 * "search()" function
14863 static void
14864 f_search(argvars, rettv)
14865 typval_T *argvars;
14866 typval_T *rettv;
14868 int flags = 0;
14870 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14874 * "searchdecl()" function
14876 static void
14877 f_searchdecl(argvars, rettv)
14878 typval_T *argvars;
14879 typval_T *rettv;
14881 int locally = 1;
14882 int thisblock = 0;
14883 int error = FALSE;
14884 char_u *name;
14886 rettv->vval.v_number = 1; /* default: FAIL */
14888 name = get_tv_string_chk(&argvars[0]);
14889 if (argvars[1].v_type != VAR_UNKNOWN)
14891 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14892 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14893 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14895 if (!error && name != NULL)
14896 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14897 locally, thisblock, SEARCH_KEEP) == FAIL;
14901 * Used by searchpair() and searchpairpos()
14903 static int
14904 searchpair_cmn(argvars, match_pos)
14905 typval_T *argvars;
14906 pos_T *match_pos;
14908 char_u *spat, *mpat, *epat;
14909 char_u *skip;
14910 int save_p_ws = p_ws;
14911 int dir;
14912 int flags = 0;
14913 char_u nbuf1[NUMBUFLEN];
14914 char_u nbuf2[NUMBUFLEN];
14915 char_u nbuf3[NUMBUFLEN];
14916 int retval = 0; /* default: FAIL */
14917 long lnum_stop = 0;
14918 long time_limit = 0;
14920 /* Get the three pattern arguments: start, middle, end. */
14921 spat = get_tv_string_chk(&argvars[0]);
14922 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14923 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14924 if (spat == NULL || mpat == NULL || epat == NULL)
14925 goto theend; /* type error */
14927 /* Handle the optional fourth argument: flags */
14928 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14929 if (dir == 0)
14930 goto theend;
14932 /* Don't accept SP_END or SP_SUBPAT.
14933 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14935 if ((flags & (SP_END | SP_SUBPAT)) != 0
14936 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14938 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14939 goto theend;
14942 /* Using 'r' implies 'W', otherwise it doesn't work. */
14943 if (flags & SP_REPEAT)
14944 p_ws = FALSE;
14946 /* Optional fifth argument: skip expression */
14947 if (argvars[3].v_type == VAR_UNKNOWN
14948 || argvars[4].v_type == VAR_UNKNOWN)
14949 skip = (char_u *)"";
14950 else
14952 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14953 if (argvars[5].v_type != VAR_UNKNOWN)
14955 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
14956 if (lnum_stop < 0)
14957 goto theend;
14958 #ifdef FEAT_RELTIME
14959 if (argvars[6].v_type != VAR_UNKNOWN)
14961 time_limit = get_tv_number_chk(&argvars[6], NULL);
14962 if (time_limit < 0)
14963 goto theend;
14965 #endif
14968 if (skip == NULL)
14969 goto theend; /* type error */
14971 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
14972 match_pos, lnum_stop, time_limit);
14974 theend:
14975 p_ws = save_p_ws;
14977 return retval;
14981 * "searchpair()" function
14983 static void
14984 f_searchpair(argvars, rettv)
14985 typval_T *argvars;
14986 typval_T *rettv;
14988 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
14992 * "searchpairpos()" function
14994 static void
14995 f_searchpairpos(argvars, rettv)
14996 typval_T *argvars;
14997 typval_T *rettv;
14999 pos_T match_pos;
15000 int lnum = 0;
15001 int col = 0;
15003 if (rettv_list_alloc(rettv) == FAIL)
15004 return;
15006 if (searchpair_cmn(argvars, &match_pos) > 0)
15008 lnum = match_pos.lnum;
15009 col = match_pos.col;
15012 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15013 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15017 * Search for a start/middle/end thing.
15018 * Used by searchpair(), see its documentation for the details.
15019 * Returns 0 or -1 for no match,
15021 long
15022 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15023 lnum_stop, time_limit)
15024 char_u *spat; /* start pattern */
15025 char_u *mpat; /* middle pattern */
15026 char_u *epat; /* end pattern */
15027 int dir; /* BACKWARD or FORWARD */
15028 char_u *skip; /* skip expression */
15029 int flags; /* SP_SETPCMARK and other SP_ values */
15030 pos_T *match_pos;
15031 linenr_T lnum_stop; /* stop at this line if not zero */
15032 long time_limit; /* stop after this many msec */
15034 char_u *save_cpo;
15035 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15036 long retval = 0;
15037 pos_T pos;
15038 pos_T firstpos;
15039 pos_T foundpos;
15040 pos_T save_cursor;
15041 pos_T save_pos;
15042 int n;
15043 int r;
15044 int nest = 1;
15045 int err;
15046 int options = SEARCH_KEEP;
15047 proftime_T tm;
15049 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15050 save_cpo = p_cpo;
15051 p_cpo = empty_option;
15053 #ifdef FEAT_RELTIME
15054 /* Set the time limit, if there is one. */
15055 profile_setlimit(time_limit, &tm);
15056 #endif
15058 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15059 * start/middle/end (pat3, for the top pair). */
15060 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15061 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15062 if (pat2 == NULL || pat3 == NULL)
15063 goto theend;
15064 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15065 if (*mpat == NUL)
15066 STRCPY(pat3, pat2);
15067 else
15068 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15069 spat, epat, mpat);
15070 if (flags & SP_START)
15071 options |= SEARCH_START;
15073 save_cursor = curwin->w_cursor;
15074 pos = curwin->w_cursor;
15075 clearpos(&firstpos);
15076 clearpos(&foundpos);
15077 pat = pat3;
15078 for (;;)
15080 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15081 options, RE_SEARCH, lnum_stop, &tm);
15082 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15083 /* didn't find it or found the first match again: FAIL */
15084 break;
15086 if (firstpos.lnum == 0)
15087 firstpos = pos;
15088 if (equalpos(pos, foundpos))
15090 /* Found the same position again. Can happen with a pattern that
15091 * has "\zs" at the end and searching backwards. Advance one
15092 * character and try again. */
15093 if (dir == BACKWARD)
15094 decl(&pos);
15095 else
15096 incl(&pos);
15098 foundpos = pos;
15100 /* clear the start flag to avoid getting stuck here */
15101 options &= ~SEARCH_START;
15103 /* If the skip pattern matches, ignore this match. */
15104 if (*skip != NUL)
15106 save_pos = curwin->w_cursor;
15107 curwin->w_cursor = pos;
15108 r = eval_to_bool(skip, &err, NULL, FALSE);
15109 curwin->w_cursor = save_pos;
15110 if (err)
15112 /* Evaluating {skip} caused an error, break here. */
15113 curwin->w_cursor = save_cursor;
15114 retval = -1;
15115 break;
15117 if (r)
15118 continue;
15121 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15123 /* Found end when searching backwards or start when searching
15124 * forward: nested pair. */
15125 ++nest;
15126 pat = pat2; /* nested, don't search for middle */
15128 else
15130 /* Found end when searching forward or start when searching
15131 * backward: end of (nested) pair; or found middle in outer pair. */
15132 if (--nest == 1)
15133 pat = pat3; /* outer level, search for middle */
15136 if (nest == 0)
15138 /* Found the match: return matchcount or line number. */
15139 if (flags & SP_RETCOUNT)
15140 ++retval;
15141 else
15142 retval = pos.lnum;
15143 if (flags & SP_SETPCMARK)
15144 setpcmark();
15145 curwin->w_cursor = pos;
15146 if (!(flags & SP_REPEAT))
15147 break;
15148 nest = 1; /* search for next unmatched */
15152 if (match_pos != NULL)
15154 /* Store the match cursor position */
15155 match_pos->lnum = curwin->w_cursor.lnum;
15156 match_pos->col = curwin->w_cursor.col + 1;
15159 /* If 'n' flag is used or search failed: restore cursor position. */
15160 if ((flags & SP_NOMOVE) || retval == 0)
15161 curwin->w_cursor = save_cursor;
15163 theend:
15164 vim_free(pat2);
15165 vim_free(pat3);
15166 if (p_cpo == empty_option)
15167 p_cpo = save_cpo;
15168 else
15169 /* Darn, evaluating the {skip} expression changed the value. */
15170 free_string_option(save_cpo);
15172 return retval;
15176 * "searchpos()" function
15178 static void
15179 f_searchpos(argvars, rettv)
15180 typval_T *argvars;
15181 typval_T *rettv;
15183 pos_T match_pos;
15184 int lnum = 0;
15185 int col = 0;
15186 int n;
15187 int flags = 0;
15189 if (rettv_list_alloc(rettv) == FAIL)
15190 return;
15192 n = search_cmn(argvars, &match_pos, &flags);
15193 if (n > 0)
15195 lnum = match_pos.lnum;
15196 col = match_pos.col;
15199 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15200 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15201 if (flags & SP_SUBPAT)
15202 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15206 static void
15207 f_server2client(argvars, rettv)
15208 typval_T *argvars UNUSED;
15209 typval_T *rettv;
15211 #ifdef FEAT_CLIENTSERVER
15212 char_u buf[NUMBUFLEN];
15213 char_u *server = get_tv_string_chk(&argvars[0]);
15214 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15216 rettv->vval.v_number = -1;
15217 if (server == NULL || reply == NULL)
15218 return;
15219 if (check_restricted() || check_secure())
15220 return;
15221 # ifdef FEAT_X11
15222 if (check_connection() == FAIL)
15223 return;
15224 # endif
15226 if (serverSendReply(server, reply) < 0)
15228 EMSG(_("E258: Unable to send to client"));
15229 return;
15231 rettv->vval.v_number = 0;
15232 #else
15233 rettv->vval.v_number = -1;
15234 #endif
15237 static void
15238 f_serverlist(argvars, rettv)
15239 typval_T *argvars UNUSED;
15240 typval_T *rettv;
15242 char_u *r = NULL;
15244 #ifdef FEAT_CLIENTSERVER
15245 # ifdef WIN32
15246 r = serverGetVimNames();
15247 # else
15248 make_connection();
15249 if (X_DISPLAY != NULL)
15250 r = serverGetVimNames(X_DISPLAY);
15251 # endif
15252 #endif
15253 rettv->v_type = VAR_STRING;
15254 rettv->vval.v_string = r;
15258 * "setbufvar()" function
15260 static void
15261 f_setbufvar(argvars, rettv)
15262 typval_T *argvars;
15263 typval_T *rettv UNUSED;
15265 buf_T *buf;
15266 aco_save_T aco;
15267 char_u *varname, *bufvarname;
15268 typval_T *varp;
15269 char_u nbuf[NUMBUFLEN];
15271 if (check_restricted() || check_secure())
15272 return;
15273 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15274 varname = get_tv_string_chk(&argvars[1]);
15275 buf = get_buf_tv(&argvars[0]);
15276 varp = &argvars[2];
15278 if (buf != NULL && varname != NULL && varp != NULL)
15280 /* set curbuf to be our buf, temporarily */
15281 aucmd_prepbuf(&aco, buf);
15283 if (*varname == '&')
15285 long numval;
15286 char_u *strval;
15287 int error = FALSE;
15289 ++varname;
15290 numval = get_tv_number_chk(varp, &error);
15291 strval = get_tv_string_buf_chk(varp, nbuf);
15292 if (!error && strval != NULL)
15293 set_option_value(varname, numval, strval, OPT_LOCAL);
15295 else
15297 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15298 if (bufvarname != NULL)
15300 STRCPY(bufvarname, "b:");
15301 STRCPY(bufvarname + 2, varname);
15302 set_var(bufvarname, varp, TRUE);
15303 vim_free(bufvarname);
15307 /* reset notion of buffer */
15308 aucmd_restbuf(&aco);
15313 * "setcmdpos()" function
15315 static void
15316 f_setcmdpos(argvars, rettv)
15317 typval_T *argvars;
15318 typval_T *rettv;
15320 int pos = (int)get_tv_number(&argvars[0]) - 1;
15322 if (pos >= 0)
15323 rettv->vval.v_number = set_cmdline_pos(pos);
15327 * "setline()" function
15329 static void
15330 f_setline(argvars, rettv)
15331 typval_T *argvars;
15332 typval_T *rettv;
15334 linenr_T lnum;
15335 char_u *line = NULL;
15336 list_T *l = NULL;
15337 listitem_T *li = NULL;
15338 long added = 0;
15339 linenr_T lcount = curbuf->b_ml.ml_line_count;
15341 lnum = get_tv_lnum(&argvars[0]);
15342 if (argvars[1].v_type == VAR_LIST)
15344 l = argvars[1].vval.v_list;
15345 li = l->lv_first;
15347 else
15348 line = get_tv_string_chk(&argvars[1]);
15350 /* default result is zero == OK */
15351 for (;;)
15353 if (l != NULL)
15355 /* list argument, get next string */
15356 if (li == NULL)
15357 break;
15358 line = get_tv_string_chk(&li->li_tv);
15359 li = li->li_next;
15362 rettv->vval.v_number = 1; /* FAIL */
15363 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15364 break;
15365 if (lnum <= curbuf->b_ml.ml_line_count)
15367 /* existing line, replace it */
15368 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15370 changed_bytes(lnum, 0);
15371 if (lnum == curwin->w_cursor.lnum)
15372 check_cursor_col();
15373 rettv->vval.v_number = 0; /* OK */
15376 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15378 /* lnum is one past the last line, append the line */
15379 ++added;
15380 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15381 rettv->vval.v_number = 0; /* OK */
15384 if (l == NULL) /* only one string argument */
15385 break;
15386 ++lnum;
15389 if (added > 0)
15390 appended_lines_mark(lcount, added);
15393 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15396 * Used by "setqflist()" and "setloclist()" functions
15398 static void
15399 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15400 win_T *wp UNUSED;
15401 typval_T *list_arg UNUSED;
15402 typval_T *action_arg UNUSED;
15403 typval_T *rettv;
15405 #ifdef FEAT_QUICKFIX
15406 char_u *act;
15407 int action = ' ';
15408 #endif
15410 rettv->vval.v_number = -1;
15412 #ifdef FEAT_QUICKFIX
15413 if (list_arg->v_type != VAR_LIST)
15414 EMSG(_(e_listreq));
15415 else
15417 list_T *l = list_arg->vval.v_list;
15419 if (action_arg->v_type == VAR_STRING)
15421 act = get_tv_string_chk(action_arg);
15422 if (act == NULL)
15423 return; /* type error; errmsg already given */
15424 if (*act == 'a' || *act == 'r')
15425 action = *act;
15428 if (l != NULL && set_errorlist(wp, l, action) == OK)
15429 rettv->vval.v_number = 0;
15431 #endif
15435 * "setloclist()" function
15437 static void
15438 f_setloclist(argvars, rettv)
15439 typval_T *argvars;
15440 typval_T *rettv;
15442 win_T *win;
15444 rettv->vval.v_number = -1;
15446 win = find_win_by_nr(&argvars[0], NULL);
15447 if (win != NULL)
15448 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15452 * "setmatches()" function
15454 static void
15455 f_setmatches(argvars, rettv)
15456 typval_T *argvars;
15457 typval_T *rettv;
15459 #ifdef FEAT_SEARCH_EXTRA
15460 list_T *l;
15461 listitem_T *li;
15462 dict_T *d;
15464 rettv->vval.v_number = -1;
15465 if (argvars[0].v_type != VAR_LIST)
15467 EMSG(_(e_listreq));
15468 return;
15470 if ((l = argvars[0].vval.v_list) != NULL)
15473 /* To some extent make sure that we are dealing with a list from
15474 * "getmatches()". */
15475 li = l->lv_first;
15476 while (li != NULL)
15478 if (li->li_tv.v_type != VAR_DICT
15479 || (d = li->li_tv.vval.v_dict) == NULL)
15481 EMSG(_(e_invarg));
15482 return;
15484 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15485 && dict_find(d, (char_u *)"pattern", -1) != NULL
15486 && dict_find(d, (char_u *)"priority", -1) != NULL
15487 && dict_find(d, (char_u *)"id", -1) != NULL))
15489 EMSG(_(e_invarg));
15490 return;
15492 li = li->li_next;
15495 clear_matches(curwin);
15496 li = l->lv_first;
15497 while (li != NULL)
15499 d = li->li_tv.vval.v_dict;
15500 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15501 get_dict_string(d, (char_u *)"pattern", FALSE),
15502 (int)get_dict_number(d, (char_u *)"priority"),
15503 (int)get_dict_number(d, (char_u *)"id"));
15504 li = li->li_next;
15506 rettv->vval.v_number = 0;
15508 #endif
15512 * "setpos()" function
15514 static void
15515 f_setpos(argvars, rettv)
15516 typval_T *argvars;
15517 typval_T *rettv;
15519 pos_T pos;
15520 int fnum;
15521 char_u *name;
15523 rettv->vval.v_number = -1;
15524 name = get_tv_string_chk(argvars);
15525 if (name != NULL)
15527 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15529 --pos.col;
15530 if (name[0] == '.' && name[1] == NUL)
15532 /* set cursor */
15533 if (fnum == curbuf->b_fnum)
15535 curwin->w_cursor = pos;
15536 check_cursor();
15537 rettv->vval.v_number = 0;
15539 else
15540 EMSG(_(e_invarg));
15542 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15544 /* set mark */
15545 if (setmark_pos(name[1], &pos, fnum) == OK)
15546 rettv->vval.v_number = 0;
15548 else
15549 EMSG(_(e_invarg));
15555 * "setqflist()" function
15557 static void
15558 f_setqflist(argvars, rettv)
15559 typval_T *argvars;
15560 typval_T *rettv;
15562 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15566 * "setreg()" function
15568 static void
15569 f_setreg(argvars, rettv)
15570 typval_T *argvars;
15571 typval_T *rettv;
15573 int regname;
15574 char_u *strregname;
15575 char_u *stropt;
15576 char_u *strval;
15577 int append;
15578 char_u yank_type;
15579 long block_len;
15581 block_len = -1;
15582 yank_type = MAUTO;
15583 append = FALSE;
15585 strregname = get_tv_string_chk(argvars);
15586 rettv->vval.v_number = 1; /* FAIL is default */
15588 if (strregname == NULL)
15589 return; /* type error; errmsg already given */
15590 regname = *strregname;
15591 if (regname == 0 || regname == '@')
15592 regname = '"';
15593 else if (regname == '=')
15594 return;
15596 if (argvars[2].v_type != VAR_UNKNOWN)
15598 stropt = get_tv_string_chk(&argvars[2]);
15599 if (stropt == NULL)
15600 return; /* type error */
15601 for (; *stropt != NUL; ++stropt)
15602 switch (*stropt)
15604 case 'a': case 'A': /* append */
15605 append = TRUE;
15606 break;
15607 case 'v': case 'c': /* character-wise selection */
15608 yank_type = MCHAR;
15609 break;
15610 case 'V': case 'l': /* line-wise selection */
15611 yank_type = MLINE;
15612 break;
15613 #ifdef FEAT_VISUAL
15614 case 'b': case Ctrl_V: /* block-wise selection */
15615 yank_type = MBLOCK;
15616 if (VIM_ISDIGIT(stropt[1]))
15618 ++stropt;
15619 block_len = getdigits(&stropt) - 1;
15620 --stropt;
15622 break;
15623 #endif
15627 strval = get_tv_string_chk(&argvars[1]);
15628 if (strval != NULL)
15629 write_reg_contents_ex(regname, strval, -1,
15630 append, yank_type, block_len);
15631 rettv->vval.v_number = 0;
15635 * "settabwinvar()" function
15637 static void
15638 f_settabwinvar(argvars, rettv)
15639 typval_T *argvars;
15640 typval_T *rettv;
15642 setwinvar(argvars, rettv, 1);
15646 * "setwinvar()" function
15648 static void
15649 f_setwinvar(argvars, rettv)
15650 typval_T *argvars;
15651 typval_T *rettv;
15653 setwinvar(argvars, rettv, 0);
15657 * "setwinvar()" and "settabwinvar()" functions
15659 static void
15660 setwinvar(argvars, rettv, off)
15661 typval_T *argvars;
15662 typval_T *rettv UNUSED;
15663 int off;
15665 win_T *win;
15666 #ifdef FEAT_WINDOWS
15667 win_T *save_curwin;
15668 tabpage_T *save_curtab;
15669 #endif
15670 char_u *varname, *winvarname;
15671 typval_T *varp;
15672 char_u nbuf[NUMBUFLEN];
15673 tabpage_T *tp;
15675 if (check_restricted() || check_secure())
15676 return;
15678 #ifdef FEAT_WINDOWS
15679 if (off == 1)
15680 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15681 else
15682 tp = curtab;
15683 #endif
15684 win = find_win_by_nr(&argvars[off], tp);
15685 varname = get_tv_string_chk(&argvars[off + 1]);
15686 varp = &argvars[off + 2];
15688 if (win != NULL && varname != NULL && varp != NULL)
15690 #ifdef FEAT_WINDOWS
15691 /* set curwin to be our win, temporarily */
15692 save_curwin = curwin;
15693 save_curtab = curtab;
15694 goto_tabpage_tp(tp);
15695 if (!win_valid(win))
15696 return;
15697 curwin = win;
15698 curbuf = curwin->w_buffer;
15699 #endif
15701 if (*varname == '&')
15703 long numval;
15704 char_u *strval;
15705 int error = FALSE;
15707 ++varname;
15708 numval = get_tv_number_chk(varp, &error);
15709 strval = get_tv_string_buf_chk(varp, nbuf);
15710 if (!error && strval != NULL)
15711 set_option_value(varname, numval, strval, OPT_LOCAL);
15713 else
15715 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15716 if (winvarname != NULL)
15718 STRCPY(winvarname, "w:");
15719 STRCPY(winvarname + 2, varname);
15720 set_var(winvarname, varp, TRUE);
15721 vim_free(winvarname);
15725 #ifdef FEAT_WINDOWS
15726 /* Restore current tabpage and window, if still valid (autocomands can
15727 * make them invalid). */
15728 if (valid_tabpage(save_curtab))
15729 goto_tabpage_tp(save_curtab);
15730 if (win_valid(save_curwin))
15732 curwin = save_curwin;
15733 curbuf = curwin->w_buffer;
15735 #endif
15740 * "shellescape({string})" function
15742 static void
15743 f_shellescape(argvars, rettv)
15744 typval_T *argvars;
15745 typval_T *rettv;
15747 rettv->vval.v_string = vim_strsave_shellescape(
15748 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15749 rettv->v_type = VAR_STRING;
15753 * "simplify()" function
15755 static void
15756 f_simplify(argvars, rettv)
15757 typval_T *argvars;
15758 typval_T *rettv;
15760 char_u *p;
15762 p = get_tv_string(&argvars[0]);
15763 rettv->vval.v_string = vim_strsave(p);
15764 simplify_filename(rettv->vval.v_string); /* simplify in place */
15765 rettv->v_type = VAR_STRING;
15768 #ifdef FEAT_FLOAT
15770 * "sin()" function
15772 static void
15773 f_sin(argvars, rettv)
15774 typval_T *argvars;
15775 typval_T *rettv;
15777 float_T f;
15779 rettv->v_type = VAR_FLOAT;
15780 if (get_float_arg(argvars, &f) == OK)
15781 rettv->vval.v_float = sin(f);
15782 else
15783 rettv->vval.v_float = 0.0;
15785 #endif
15787 static int
15788 #ifdef __BORLANDC__
15789 _RTLENTRYF
15790 #endif
15791 item_compare __ARGS((const void *s1, const void *s2));
15792 static int
15793 #ifdef __BORLANDC__
15794 _RTLENTRYF
15795 #endif
15796 item_compare2 __ARGS((const void *s1, const void *s2));
15798 static int item_compare_ic;
15799 static char_u *item_compare_func;
15800 static int item_compare_func_err;
15801 #define ITEM_COMPARE_FAIL 999
15804 * Compare functions for f_sort() below.
15806 static int
15807 #ifdef __BORLANDC__
15808 _RTLENTRYF
15809 #endif
15810 item_compare(s1, s2)
15811 const void *s1;
15812 const void *s2;
15814 char_u *p1, *p2;
15815 char_u *tofree1, *tofree2;
15816 int res;
15817 char_u numbuf1[NUMBUFLEN];
15818 char_u numbuf2[NUMBUFLEN];
15820 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15821 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15822 if (p1 == NULL)
15823 p1 = (char_u *)"";
15824 if (p2 == NULL)
15825 p2 = (char_u *)"";
15826 if (item_compare_ic)
15827 res = STRICMP(p1, p2);
15828 else
15829 res = STRCMP(p1, p2);
15830 vim_free(tofree1);
15831 vim_free(tofree2);
15832 return res;
15835 static int
15836 #ifdef __BORLANDC__
15837 _RTLENTRYF
15838 #endif
15839 item_compare2(s1, s2)
15840 const void *s1;
15841 const void *s2;
15843 int res;
15844 typval_T rettv;
15845 typval_T argv[3];
15846 int dummy;
15848 /* shortcut after failure in previous call; compare all items equal */
15849 if (item_compare_func_err)
15850 return 0;
15852 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15853 * in the copy without changing the original list items. */
15854 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15855 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15857 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15858 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15859 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15860 clear_tv(&argv[0]);
15861 clear_tv(&argv[1]);
15863 if (res == FAIL)
15864 res = ITEM_COMPARE_FAIL;
15865 else
15866 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15867 if (item_compare_func_err)
15868 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15869 clear_tv(&rettv);
15870 return res;
15874 * "sort({list})" function
15876 static void
15877 f_sort(argvars, rettv)
15878 typval_T *argvars;
15879 typval_T *rettv;
15881 list_T *l;
15882 listitem_T *li;
15883 listitem_T **ptrs;
15884 long len;
15885 long i;
15887 if (argvars[0].v_type != VAR_LIST)
15888 EMSG2(_(e_listarg), "sort()");
15889 else
15891 l = argvars[0].vval.v_list;
15892 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15893 return;
15894 rettv->vval.v_list = l;
15895 rettv->v_type = VAR_LIST;
15896 ++l->lv_refcount;
15898 len = list_len(l);
15899 if (len <= 1)
15900 return; /* short list sorts pretty quickly */
15902 item_compare_ic = FALSE;
15903 item_compare_func = NULL;
15904 if (argvars[1].v_type != VAR_UNKNOWN)
15906 if (argvars[1].v_type == VAR_FUNC)
15907 item_compare_func = argvars[1].vval.v_string;
15908 else
15910 int error = FALSE;
15912 i = get_tv_number_chk(&argvars[1], &error);
15913 if (error)
15914 return; /* type error; errmsg already given */
15915 if (i == 1)
15916 item_compare_ic = TRUE;
15917 else
15918 item_compare_func = get_tv_string(&argvars[1]);
15922 /* Make an array with each entry pointing to an item in the List. */
15923 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15924 if (ptrs == NULL)
15925 return;
15926 i = 0;
15927 for (li = l->lv_first; li != NULL; li = li->li_next)
15928 ptrs[i++] = li;
15930 item_compare_func_err = FALSE;
15931 /* test the compare function */
15932 if (item_compare_func != NULL
15933 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15934 == ITEM_COMPARE_FAIL)
15935 EMSG(_("E702: Sort compare function failed"));
15936 else
15938 /* Sort the array with item pointers. */
15939 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15940 item_compare_func == NULL ? item_compare : item_compare2);
15942 if (!item_compare_func_err)
15944 /* Clear the List and append the items in the sorted order. */
15945 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15946 l->lv_len = 0;
15947 for (i = 0; i < len; ++i)
15948 list_append(l, ptrs[i]);
15952 vim_free(ptrs);
15957 * "soundfold({word})" function
15959 static void
15960 f_soundfold(argvars, rettv)
15961 typval_T *argvars;
15962 typval_T *rettv;
15964 char_u *s;
15966 rettv->v_type = VAR_STRING;
15967 s = get_tv_string(&argvars[0]);
15968 #ifdef FEAT_SPELL
15969 rettv->vval.v_string = eval_soundfold(s);
15970 #else
15971 rettv->vval.v_string = vim_strsave(s);
15972 #endif
15976 * "spellbadword()" function
15978 static void
15979 f_spellbadword(argvars, rettv)
15980 typval_T *argvars UNUSED;
15981 typval_T *rettv;
15983 char_u *word = (char_u *)"";
15984 hlf_T attr = HLF_COUNT;
15985 int len = 0;
15987 if (rettv_list_alloc(rettv) == FAIL)
15988 return;
15990 #ifdef FEAT_SPELL
15991 if (argvars[0].v_type == VAR_UNKNOWN)
15993 /* Find the start and length of the badly spelled word. */
15994 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
15995 if (len != 0)
15996 word = ml_get_cursor();
15998 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16000 char_u *str = get_tv_string_chk(&argvars[0]);
16001 int capcol = -1;
16003 if (str != NULL)
16005 /* Check the argument for spelling. */
16006 while (*str != NUL)
16008 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16009 if (attr != HLF_COUNT)
16011 word = str;
16012 break;
16014 str += len;
16018 #endif
16020 list_append_string(rettv->vval.v_list, word, len);
16021 list_append_string(rettv->vval.v_list, (char_u *)(
16022 attr == HLF_SPB ? "bad" :
16023 attr == HLF_SPR ? "rare" :
16024 attr == HLF_SPL ? "local" :
16025 attr == HLF_SPC ? "caps" :
16026 ""), -1);
16030 * "spellsuggest()" function
16032 static void
16033 f_spellsuggest(argvars, rettv)
16034 typval_T *argvars UNUSED;
16035 typval_T *rettv;
16037 #ifdef FEAT_SPELL
16038 char_u *str;
16039 int typeerr = FALSE;
16040 int maxcount;
16041 garray_T ga;
16042 int i;
16043 listitem_T *li;
16044 int need_capital = FALSE;
16045 #endif
16047 if (rettv_list_alloc(rettv) == FAIL)
16048 return;
16050 #ifdef FEAT_SPELL
16051 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16053 str = get_tv_string(&argvars[0]);
16054 if (argvars[1].v_type != VAR_UNKNOWN)
16056 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16057 if (maxcount <= 0)
16058 return;
16059 if (argvars[2].v_type != VAR_UNKNOWN)
16061 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16062 if (typeerr)
16063 return;
16066 else
16067 maxcount = 25;
16069 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16071 for (i = 0; i < ga.ga_len; ++i)
16073 str = ((char_u **)ga.ga_data)[i];
16075 li = listitem_alloc();
16076 if (li == NULL)
16077 vim_free(str);
16078 else
16080 li->li_tv.v_type = VAR_STRING;
16081 li->li_tv.v_lock = 0;
16082 li->li_tv.vval.v_string = str;
16083 list_append(rettv->vval.v_list, li);
16086 ga_clear(&ga);
16088 #endif
16091 static void
16092 f_split(argvars, rettv)
16093 typval_T *argvars;
16094 typval_T *rettv;
16096 char_u *str;
16097 char_u *end;
16098 char_u *pat = NULL;
16099 regmatch_T regmatch;
16100 char_u patbuf[NUMBUFLEN];
16101 char_u *save_cpo;
16102 int match;
16103 colnr_T col = 0;
16104 int keepempty = FALSE;
16105 int typeerr = FALSE;
16107 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16108 save_cpo = p_cpo;
16109 p_cpo = (char_u *)"";
16111 str = get_tv_string(&argvars[0]);
16112 if (argvars[1].v_type != VAR_UNKNOWN)
16114 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16115 if (pat == NULL)
16116 typeerr = TRUE;
16117 if (argvars[2].v_type != VAR_UNKNOWN)
16118 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16120 if (pat == NULL || *pat == NUL)
16121 pat = (char_u *)"[\\x01- ]\\+";
16123 if (rettv_list_alloc(rettv) == FAIL)
16124 return;
16125 if (typeerr)
16126 return;
16128 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16129 if (regmatch.regprog != NULL)
16131 regmatch.rm_ic = FALSE;
16132 while (*str != NUL || keepempty)
16134 if (*str == NUL)
16135 match = FALSE; /* empty item at the end */
16136 else
16137 match = vim_regexec_nl(&regmatch, str, col);
16138 if (match)
16139 end = regmatch.startp[0];
16140 else
16141 end = str + STRLEN(str);
16142 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16143 && *str != NUL && match && end < regmatch.endp[0]))
16145 if (list_append_string(rettv->vval.v_list, str,
16146 (int)(end - str)) == FAIL)
16147 break;
16149 if (!match)
16150 break;
16151 /* Advance to just after the match. */
16152 if (regmatch.endp[0] > str)
16153 col = 0;
16154 else
16156 /* Don't get stuck at the same match. */
16157 #ifdef FEAT_MBYTE
16158 col = (*mb_ptr2len)(regmatch.endp[0]);
16159 #else
16160 col = 1;
16161 #endif
16163 str = regmatch.endp[0];
16166 vim_free(regmatch.regprog);
16169 p_cpo = save_cpo;
16172 #ifdef FEAT_FLOAT
16174 * "sqrt()" function
16176 static void
16177 f_sqrt(argvars, rettv)
16178 typval_T *argvars;
16179 typval_T *rettv;
16181 float_T f;
16183 rettv->v_type = VAR_FLOAT;
16184 if (get_float_arg(argvars, &f) == OK)
16185 rettv->vval.v_float = sqrt(f);
16186 else
16187 rettv->vval.v_float = 0.0;
16191 * "str2float()" function
16193 static void
16194 f_str2float(argvars, rettv)
16195 typval_T *argvars;
16196 typval_T *rettv;
16198 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16200 if (*p == '+')
16201 p = skipwhite(p + 1);
16202 (void)string2float(p, &rettv->vval.v_float);
16203 rettv->v_type = VAR_FLOAT;
16205 #endif
16208 * "str2nr()" function
16210 static void
16211 f_str2nr(argvars, rettv)
16212 typval_T *argvars;
16213 typval_T *rettv;
16215 int base = 10;
16216 char_u *p;
16217 long n;
16219 if (argvars[1].v_type != VAR_UNKNOWN)
16221 base = get_tv_number(&argvars[1]);
16222 if (base != 8 && base != 10 && base != 16)
16224 EMSG(_(e_invarg));
16225 return;
16229 p = skipwhite(get_tv_string(&argvars[0]));
16230 if (*p == '+')
16231 p = skipwhite(p + 1);
16232 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16233 rettv->vval.v_number = n;
16236 #ifdef HAVE_STRFTIME
16238 * "strftime({format}[, {time}])" function
16240 static void
16241 f_strftime(argvars, rettv)
16242 typval_T *argvars;
16243 typval_T *rettv;
16245 char_u result_buf[256];
16246 struct tm *curtime;
16247 time_t seconds;
16248 char_u *p;
16250 rettv->v_type = VAR_STRING;
16252 p = get_tv_string(&argvars[0]);
16253 if (argvars[1].v_type == VAR_UNKNOWN)
16254 seconds = time(NULL);
16255 else
16256 seconds = (time_t)get_tv_number(&argvars[1]);
16257 curtime = localtime(&seconds);
16258 /* MSVC returns NULL for an invalid value of seconds. */
16259 if (curtime == NULL)
16260 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16261 else
16263 # ifdef FEAT_MBYTE
16264 vimconv_T conv;
16265 char_u *enc;
16267 conv.vc_type = CONV_NONE;
16268 enc = enc_locale();
16269 convert_setup(&conv, p_enc, enc);
16270 if (conv.vc_type != CONV_NONE)
16271 p = string_convert(&conv, p, NULL);
16272 # endif
16273 if (p != NULL)
16274 (void)strftime((char *)result_buf, sizeof(result_buf),
16275 (char *)p, curtime);
16276 else
16277 result_buf[0] = NUL;
16279 # ifdef FEAT_MBYTE
16280 if (conv.vc_type != CONV_NONE)
16281 vim_free(p);
16282 convert_setup(&conv, enc, p_enc);
16283 if (conv.vc_type != CONV_NONE)
16284 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16285 else
16286 # endif
16287 rettv->vval.v_string = vim_strsave(result_buf);
16289 # ifdef FEAT_MBYTE
16290 /* Release conversion descriptors */
16291 convert_setup(&conv, NULL, NULL);
16292 vim_free(enc);
16293 # endif
16296 #endif
16299 * "stridx()" function
16301 static void
16302 f_stridx(argvars, rettv)
16303 typval_T *argvars;
16304 typval_T *rettv;
16306 char_u buf[NUMBUFLEN];
16307 char_u *needle;
16308 char_u *haystack;
16309 char_u *save_haystack;
16310 char_u *pos;
16311 int start_idx;
16313 needle = get_tv_string_chk(&argvars[1]);
16314 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16315 rettv->vval.v_number = -1;
16316 if (needle == NULL || haystack == NULL)
16317 return; /* type error; errmsg already given */
16319 if (argvars[2].v_type != VAR_UNKNOWN)
16321 int error = FALSE;
16323 start_idx = get_tv_number_chk(&argvars[2], &error);
16324 if (error || start_idx >= (int)STRLEN(haystack))
16325 return;
16326 if (start_idx >= 0)
16327 haystack += start_idx;
16330 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16331 if (pos != NULL)
16332 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16336 * "string()" function
16338 static void
16339 f_string(argvars, rettv)
16340 typval_T *argvars;
16341 typval_T *rettv;
16343 char_u *tofree;
16344 char_u numbuf[NUMBUFLEN];
16346 rettv->v_type = VAR_STRING;
16347 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16348 /* Make a copy if we have a value but it's not in allocated memory. */
16349 if (rettv->vval.v_string != NULL && tofree == NULL)
16350 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16354 * "strlen()" function
16356 static void
16357 f_strlen(argvars, rettv)
16358 typval_T *argvars;
16359 typval_T *rettv;
16361 rettv->vval.v_number = (varnumber_T)(STRLEN(
16362 get_tv_string(&argvars[0])));
16366 * "strpart()" function
16368 static void
16369 f_strpart(argvars, rettv)
16370 typval_T *argvars;
16371 typval_T *rettv;
16373 char_u *p;
16374 int n;
16375 int len;
16376 int slen;
16377 int error = FALSE;
16379 p = get_tv_string(&argvars[0]);
16380 slen = (int)STRLEN(p);
16382 n = get_tv_number_chk(&argvars[1], &error);
16383 if (error)
16384 len = 0;
16385 else if (argvars[2].v_type != VAR_UNKNOWN)
16386 len = get_tv_number(&argvars[2]);
16387 else
16388 len = slen - n; /* default len: all bytes that are available. */
16391 * Only return the overlap between the specified part and the actual
16392 * string.
16394 if (n < 0)
16396 len += n;
16397 n = 0;
16399 else if (n > slen)
16400 n = slen;
16401 if (len < 0)
16402 len = 0;
16403 else if (n + len > slen)
16404 len = slen - n;
16406 rettv->v_type = VAR_STRING;
16407 rettv->vval.v_string = vim_strnsave(p + n, len);
16411 * "strridx()" function
16413 static void
16414 f_strridx(argvars, rettv)
16415 typval_T *argvars;
16416 typval_T *rettv;
16418 char_u buf[NUMBUFLEN];
16419 char_u *needle;
16420 char_u *haystack;
16421 char_u *rest;
16422 char_u *lastmatch = NULL;
16423 int haystack_len, end_idx;
16425 needle = get_tv_string_chk(&argvars[1]);
16426 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16428 rettv->vval.v_number = -1;
16429 if (needle == NULL || haystack == NULL)
16430 return; /* type error; errmsg already given */
16432 haystack_len = (int)STRLEN(haystack);
16433 if (argvars[2].v_type != VAR_UNKNOWN)
16435 /* Third argument: upper limit for index */
16436 end_idx = get_tv_number_chk(&argvars[2], NULL);
16437 if (end_idx < 0)
16438 return; /* can never find a match */
16440 else
16441 end_idx = haystack_len;
16443 if (*needle == NUL)
16445 /* Empty string matches past the end. */
16446 lastmatch = haystack + end_idx;
16448 else
16450 for (rest = haystack; *rest != '\0'; ++rest)
16452 rest = (char_u *)strstr((char *)rest, (char *)needle);
16453 if (rest == NULL || rest > haystack + end_idx)
16454 break;
16455 lastmatch = rest;
16459 if (lastmatch == NULL)
16460 rettv->vval.v_number = -1;
16461 else
16462 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16466 * "strtrans()" function
16468 static void
16469 f_strtrans(argvars, rettv)
16470 typval_T *argvars;
16471 typval_T *rettv;
16473 rettv->v_type = VAR_STRING;
16474 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16478 * "submatch()" function
16480 static void
16481 f_submatch(argvars, rettv)
16482 typval_T *argvars;
16483 typval_T *rettv;
16485 rettv->v_type = VAR_STRING;
16486 rettv->vval.v_string =
16487 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16491 * "substitute()" function
16493 static void
16494 f_substitute(argvars, rettv)
16495 typval_T *argvars;
16496 typval_T *rettv;
16498 char_u patbuf[NUMBUFLEN];
16499 char_u subbuf[NUMBUFLEN];
16500 char_u flagsbuf[NUMBUFLEN];
16502 char_u *str = get_tv_string_chk(&argvars[0]);
16503 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16504 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16505 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16507 rettv->v_type = VAR_STRING;
16508 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16509 rettv->vval.v_string = NULL;
16510 else
16511 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16515 * "synID(lnum, col, trans)" function
16517 static void
16518 f_synID(argvars, rettv)
16519 typval_T *argvars UNUSED;
16520 typval_T *rettv;
16522 int id = 0;
16523 #ifdef FEAT_SYN_HL
16524 long lnum;
16525 long col;
16526 int trans;
16527 int transerr = FALSE;
16529 lnum = get_tv_lnum(argvars); /* -1 on type error */
16530 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16531 trans = get_tv_number_chk(&argvars[2], &transerr);
16533 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16534 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16535 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16536 #endif
16538 rettv->vval.v_number = id;
16542 * "synIDattr(id, what [, mode])" function
16544 static void
16545 f_synIDattr(argvars, rettv)
16546 typval_T *argvars UNUSED;
16547 typval_T *rettv;
16549 char_u *p = NULL;
16550 #ifdef FEAT_SYN_HL
16551 int id;
16552 char_u *what;
16553 char_u *mode;
16554 char_u modebuf[NUMBUFLEN];
16555 int modec;
16557 id = get_tv_number(&argvars[0]);
16558 what = get_tv_string(&argvars[1]);
16559 if (argvars[2].v_type != VAR_UNKNOWN)
16561 mode = get_tv_string_buf(&argvars[2], modebuf);
16562 modec = TOLOWER_ASC(mode[0]);
16563 if (modec != 't' && modec != 'c'
16564 #ifdef FEAT_GUI
16565 && modec != 'g'
16566 #endif
16568 modec = 0; /* replace invalid with current */
16570 else
16572 #ifdef FEAT_GUI
16573 if (gui.in_use)
16574 modec = 'g';
16575 else
16576 #endif
16577 if (t_colors > 1)
16578 modec = 'c';
16579 else
16580 modec = 't';
16584 switch (TOLOWER_ASC(what[0]))
16586 case 'b':
16587 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16588 p = highlight_color(id, what, modec);
16589 else /* bold */
16590 p = highlight_has_attr(id, HL_BOLD, modec);
16591 break;
16593 case 'f': /* fg[#] */
16594 p = highlight_color(id, what, modec);
16595 break;
16597 case 'i':
16598 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16599 p = highlight_has_attr(id, HL_INVERSE, modec);
16600 else /* italic */
16601 p = highlight_has_attr(id, HL_ITALIC, modec);
16602 break;
16604 case 'n': /* name */
16605 p = get_highlight_name(NULL, id - 1);
16606 break;
16608 case 'r': /* reverse */
16609 p = highlight_has_attr(id, HL_INVERSE, modec);
16610 break;
16612 case 's':
16613 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16614 p = highlight_color(id, what, modec);
16615 else /* standout */
16616 p = highlight_has_attr(id, HL_STANDOUT, modec);
16617 break;
16619 case 'u':
16620 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16621 /* underline */
16622 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16623 else
16624 /* undercurl */
16625 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16626 break;
16629 if (p != NULL)
16630 p = vim_strsave(p);
16631 #endif
16632 rettv->v_type = VAR_STRING;
16633 rettv->vval.v_string = p;
16637 * "synIDtrans(id)" function
16639 static void
16640 f_synIDtrans(argvars, rettv)
16641 typval_T *argvars UNUSED;
16642 typval_T *rettv;
16644 int id;
16646 #ifdef FEAT_SYN_HL
16647 id = get_tv_number(&argvars[0]);
16649 if (id > 0)
16650 id = syn_get_final_id(id);
16651 else
16652 #endif
16653 id = 0;
16655 rettv->vval.v_number = id;
16659 * "synstack(lnum, col)" function
16661 static void
16662 f_synstack(argvars, rettv)
16663 typval_T *argvars UNUSED;
16664 typval_T *rettv;
16666 #ifdef FEAT_SYN_HL
16667 long lnum;
16668 long col;
16669 int i;
16670 int id;
16671 #endif
16673 rettv->v_type = VAR_LIST;
16674 rettv->vval.v_list = NULL;
16676 #ifdef FEAT_SYN_HL
16677 lnum = get_tv_lnum(argvars); /* -1 on type error */
16678 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16680 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16681 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16682 && rettv_list_alloc(rettv) != FAIL)
16684 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16685 for (i = 0; ; ++i)
16687 id = syn_get_stack_item(i);
16688 if (id < 0)
16689 break;
16690 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16691 break;
16694 #endif
16698 * "system()" function
16700 static void
16701 f_system(argvars, rettv)
16702 typval_T *argvars;
16703 typval_T *rettv;
16705 char_u *res = NULL;
16706 char_u *p;
16707 char_u *infile = NULL;
16708 char_u buf[NUMBUFLEN];
16709 int err = FALSE;
16710 FILE *fd;
16712 if (check_restricted() || check_secure())
16713 goto done;
16715 if (argvars[1].v_type != VAR_UNKNOWN)
16718 * Write the string to a temp file, to be used for input of the shell
16719 * command.
16721 if ((infile = vim_tempname('i')) == NULL)
16723 EMSG(_(e_notmp));
16724 goto done;
16727 fd = mch_fopen((char *)infile, WRITEBIN);
16728 if (fd == NULL)
16730 EMSG2(_(e_notopen), infile);
16731 goto done;
16733 p = get_tv_string_buf_chk(&argvars[1], buf);
16734 if (p == NULL)
16736 fclose(fd);
16737 goto done; /* type error; errmsg already given */
16739 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16740 err = TRUE;
16741 if (fclose(fd) != 0)
16742 err = TRUE;
16743 if (err)
16745 EMSG(_("E677: Error writing temp file"));
16746 goto done;
16750 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16751 SHELL_SILENT | SHELL_COOKED);
16753 #ifdef USE_CR
16754 /* translate <CR> into <NL> */
16755 if (res != NULL)
16757 char_u *s;
16759 for (s = res; *s; ++s)
16761 if (*s == CAR)
16762 *s = NL;
16765 #else
16766 # ifdef USE_CRNL
16767 /* translate <CR><NL> into <NL> */
16768 if (res != NULL)
16770 char_u *s, *d;
16772 d = res;
16773 for (s = res; *s; ++s)
16775 if (s[0] == CAR && s[1] == NL)
16776 ++s;
16777 *d++ = *s;
16779 *d = NUL;
16781 # endif
16782 #endif
16784 done:
16785 if (infile != NULL)
16787 mch_remove(infile);
16788 vim_free(infile);
16790 rettv->v_type = VAR_STRING;
16791 rettv->vval.v_string = res;
16795 * "tabpagebuflist()" function
16797 static void
16798 f_tabpagebuflist(argvars, rettv)
16799 typval_T *argvars UNUSED;
16800 typval_T *rettv UNUSED;
16802 #ifdef FEAT_WINDOWS
16803 tabpage_T *tp;
16804 win_T *wp = NULL;
16806 if (argvars[0].v_type == VAR_UNKNOWN)
16807 wp = firstwin;
16808 else
16810 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16811 if (tp != NULL)
16812 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16814 if (wp != NULL && rettv_list_alloc(rettv) != FAIL)
16816 for (; wp != NULL; wp = wp->w_next)
16817 if (list_append_number(rettv->vval.v_list,
16818 wp->w_buffer->b_fnum) == FAIL)
16819 break;
16821 #endif
16826 * "tabpagenr()" function
16828 static void
16829 f_tabpagenr(argvars, rettv)
16830 typval_T *argvars UNUSED;
16831 typval_T *rettv;
16833 int nr = 1;
16834 #ifdef FEAT_WINDOWS
16835 char_u *arg;
16837 if (argvars[0].v_type != VAR_UNKNOWN)
16839 arg = get_tv_string_chk(&argvars[0]);
16840 nr = 0;
16841 if (arg != NULL)
16843 if (STRCMP(arg, "$") == 0)
16844 nr = tabpage_index(NULL) - 1;
16845 else
16846 EMSG2(_(e_invexpr2), arg);
16849 else
16850 nr = tabpage_index(curtab);
16851 #endif
16852 rettv->vval.v_number = nr;
16856 #ifdef FEAT_WINDOWS
16857 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16860 * Common code for tabpagewinnr() and winnr().
16862 static int
16863 get_winnr(tp, argvar)
16864 tabpage_T *tp;
16865 typval_T *argvar;
16867 win_T *twin;
16868 int nr = 1;
16869 win_T *wp;
16870 char_u *arg;
16872 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16873 if (argvar->v_type != VAR_UNKNOWN)
16875 arg = get_tv_string_chk(argvar);
16876 if (arg == NULL)
16877 nr = 0; /* type error; errmsg already given */
16878 else if (STRCMP(arg, "$") == 0)
16879 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16880 else if (STRCMP(arg, "#") == 0)
16882 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16883 if (twin == NULL)
16884 nr = 0;
16886 else
16888 EMSG2(_(e_invexpr2), arg);
16889 nr = 0;
16893 if (nr > 0)
16894 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16895 wp != twin; wp = wp->w_next)
16897 if (wp == NULL)
16899 /* didn't find it in this tabpage */
16900 nr = 0;
16901 break;
16903 ++nr;
16905 return nr;
16907 #endif
16910 * "tabpagewinnr()" function
16912 static void
16913 f_tabpagewinnr(argvars, rettv)
16914 typval_T *argvars UNUSED;
16915 typval_T *rettv;
16917 int nr = 1;
16918 #ifdef FEAT_WINDOWS
16919 tabpage_T *tp;
16921 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16922 if (tp == NULL)
16923 nr = 0;
16924 else
16925 nr = get_winnr(tp, &argvars[1]);
16926 #endif
16927 rettv->vval.v_number = nr;
16932 * "tagfiles()" function
16934 static void
16935 f_tagfiles(argvars, rettv)
16936 typval_T *argvars UNUSED;
16937 typval_T *rettv;
16939 char_u fname[MAXPATHL + 1];
16940 tagname_T tn;
16941 int first;
16943 if (rettv_list_alloc(rettv) == FAIL)
16944 return;
16946 for (first = TRUE; ; first = FALSE)
16947 if (get_tagfname(&tn, first, fname) == FAIL
16948 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
16949 break;
16950 tagname_free(&tn);
16954 * "taglist()" function
16956 static void
16957 f_taglist(argvars, rettv)
16958 typval_T *argvars;
16959 typval_T *rettv;
16961 char_u *tag_pattern;
16963 tag_pattern = get_tv_string(&argvars[0]);
16965 rettv->vval.v_number = FALSE;
16966 if (*tag_pattern == NUL)
16967 return;
16969 if (rettv_list_alloc(rettv) == OK)
16970 (void)get_tags(rettv->vval.v_list, tag_pattern);
16974 * "tempname()" function
16976 static void
16977 f_tempname(argvars, rettv)
16978 typval_T *argvars UNUSED;
16979 typval_T *rettv;
16981 static int x = 'A';
16983 rettv->v_type = VAR_STRING;
16984 rettv->vval.v_string = vim_tempname(x);
16986 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
16987 * names. Skip 'I' and 'O', they are used for shell redirection. */
16990 if (x == 'Z')
16991 x = '0';
16992 else if (x == '9')
16993 x = 'A';
16994 else
16996 #ifdef EBCDIC
16997 if (x == 'I')
16998 x = 'J';
16999 else if (x == 'R')
17000 x = 'S';
17001 else
17002 #endif
17003 ++x;
17005 } while (x == 'I' || x == 'O');
17009 * "test(list)" function: Just checking the walls...
17011 static void
17012 f_test(argvars, rettv)
17013 typval_T *argvars UNUSED;
17014 typval_T *rettv UNUSED;
17016 /* Used for unit testing. Change the code below to your liking. */
17017 #if 0
17018 listitem_T *li;
17019 list_T *l;
17020 char_u *bad, *good;
17022 if (argvars[0].v_type != VAR_LIST)
17023 return;
17024 l = argvars[0].vval.v_list;
17025 if (l == NULL)
17026 return;
17027 li = l->lv_first;
17028 if (li == NULL)
17029 return;
17030 bad = get_tv_string(&li->li_tv);
17031 li = li->li_next;
17032 if (li == NULL)
17033 return;
17034 good = get_tv_string(&li->li_tv);
17035 rettv->vval.v_number = test_edit_score(bad, good);
17036 #endif
17040 * "tolower(string)" function
17042 static void
17043 f_tolower(argvars, rettv)
17044 typval_T *argvars;
17045 typval_T *rettv;
17047 char_u *p;
17049 p = vim_strsave(get_tv_string(&argvars[0]));
17050 rettv->v_type = VAR_STRING;
17051 rettv->vval.v_string = p;
17053 if (p != NULL)
17054 while (*p != NUL)
17056 #ifdef FEAT_MBYTE
17057 int l;
17059 if (enc_utf8)
17061 int c, lc;
17063 c = utf_ptr2char(p);
17064 lc = utf_tolower(c);
17065 l = utf_ptr2len(p);
17066 /* TODO: reallocate string when byte count changes. */
17067 if (utf_char2len(lc) == l)
17068 utf_char2bytes(lc, p);
17069 p += l;
17071 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17072 p += l; /* skip multi-byte character */
17073 else
17074 #endif
17076 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17077 ++p;
17083 * "toupper(string)" function
17085 static void
17086 f_toupper(argvars, rettv)
17087 typval_T *argvars;
17088 typval_T *rettv;
17090 rettv->v_type = VAR_STRING;
17091 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17095 * "tr(string, fromstr, tostr)" function
17097 static void
17098 f_tr(argvars, rettv)
17099 typval_T *argvars;
17100 typval_T *rettv;
17102 char_u *instr;
17103 char_u *fromstr;
17104 char_u *tostr;
17105 char_u *p;
17106 #ifdef FEAT_MBYTE
17107 int inlen;
17108 int fromlen;
17109 int tolen;
17110 int idx;
17111 char_u *cpstr;
17112 int cplen;
17113 int first = TRUE;
17114 #endif
17115 char_u buf[NUMBUFLEN];
17116 char_u buf2[NUMBUFLEN];
17117 garray_T ga;
17119 instr = get_tv_string(&argvars[0]);
17120 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17121 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17123 /* Default return value: empty string. */
17124 rettv->v_type = VAR_STRING;
17125 rettv->vval.v_string = NULL;
17126 if (fromstr == NULL || tostr == NULL)
17127 return; /* type error; errmsg already given */
17128 ga_init2(&ga, (int)sizeof(char), 80);
17130 #ifdef FEAT_MBYTE
17131 if (!has_mbyte)
17132 #endif
17133 /* not multi-byte: fromstr and tostr must be the same length */
17134 if (STRLEN(fromstr) != STRLEN(tostr))
17136 #ifdef FEAT_MBYTE
17137 error:
17138 #endif
17139 EMSG2(_(e_invarg2), fromstr);
17140 ga_clear(&ga);
17141 return;
17144 /* fromstr and tostr have to contain the same number of chars */
17145 while (*instr != NUL)
17147 #ifdef FEAT_MBYTE
17148 if (has_mbyte)
17150 inlen = (*mb_ptr2len)(instr);
17151 cpstr = instr;
17152 cplen = inlen;
17153 idx = 0;
17154 for (p = fromstr; *p != NUL; p += fromlen)
17156 fromlen = (*mb_ptr2len)(p);
17157 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17159 for (p = tostr; *p != NUL; p += tolen)
17161 tolen = (*mb_ptr2len)(p);
17162 if (idx-- == 0)
17164 cplen = tolen;
17165 cpstr = p;
17166 break;
17169 if (*p == NUL) /* tostr is shorter than fromstr */
17170 goto error;
17171 break;
17173 ++idx;
17176 if (first && cpstr == instr)
17178 /* Check that fromstr and tostr have the same number of
17179 * (multi-byte) characters. Done only once when a character
17180 * of instr doesn't appear in fromstr. */
17181 first = FALSE;
17182 for (p = tostr; *p != NUL; p += tolen)
17184 tolen = (*mb_ptr2len)(p);
17185 --idx;
17187 if (idx != 0)
17188 goto error;
17191 ga_grow(&ga, cplen);
17192 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17193 ga.ga_len += cplen;
17195 instr += inlen;
17197 else
17198 #endif
17200 /* When not using multi-byte chars we can do it faster. */
17201 p = vim_strchr(fromstr, *instr);
17202 if (p != NULL)
17203 ga_append(&ga, tostr[p - fromstr]);
17204 else
17205 ga_append(&ga, *instr);
17206 ++instr;
17210 /* add a terminating NUL */
17211 ga_grow(&ga, 1);
17212 ga_append(&ga, NUL);
17214 rettv->vval.v_string = ga.ga_data;
17217 #ifdef FEAT_FLOAT
17219 * "trunc({float})" function
17221 static void
17222 f_trunc(argvars, rettv)
17223 typval_T *argvars;
17224 typval_T *rettv;
17226 float_T f;
17228 rettv->v_type = VAR_FLOAT;
17229 if (get_float_arg(argvars, &f) == OK)
17230 /* trunc() is not in C90, use floor() or ceil() instead. */
17231 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17232 else
17233 rettv->vval.v_float = 0.0;
17235 #endif
17238 * "type(expr)" function
17240 static void
17241 f_type(argvars, rettv)
17242 typval_T *argvars;
17243 typval_T *rettv;
17245 int n;
17247 switch (argvars[0].v_type)
17249 case VAR_NUMBER: n = 0; break;
17250 case VAR_STRING: n = 1; break;
17251 case VAR_FUNC: n = 2; break;
17252 case VAR_LIST: n = 3; break;
17253 case VAR_DICT: n = 4; break;
17254 #ifdef FEAT_FLOAT
17255 case VAR_FLOAT: n = 5; break;
17256 #endif
17257 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17259 rettv->vval.v_number = n;
17263 * "values(dict)" function
17265 static void
17266 f_values(argvars, rettv)
17267 typval_T *argvars;
17268 typval_T *rettv;
17270 dict_list(argvars, rettv, 1);
17274 * "virtcol(string)" function
17276 static void
17277 f_virtcol(argvars, rettv)
17278 typval_T *argvars;
17279 typval_T *rettv;
17281 colnr_T vcol = 0;
17282 pos_T *fp;
17283 int fnum = curbuf->b_fnum;
17285 fp = var2fpos(&argvars[0], FALSE, &fnum);
17286 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17287 && fnum == curbuf->b_fnum)
17289 getvvcol(curwin, fp, NULL, NULL, &vcol);
17290 ++vcol;
17293 rettv->vval.v_number = vcol;
17297 * "visualmode()" function
17299 static void
17300 f_visualmode(argvars, rettv)
17301 typval_T *argvars UNUSED;
17302 typval_T *rettv UNUSED;
17304 #ifdef FEAT_VISUAL
17305 char_u str[2];
17307 rettv->v_type = VAR_STRING;
17308 str[0] = curbuf->b_visual_mode_eval;
17309 str[1] = NUL;
17310 rettv->vval.v_string = vim_strsave(str);
17312 /* A non-zero number or non-empty string argument: reset mode. */
17313 if (non_zero_arg(&argvars[0]))
17314 curbuf->b_visual_mode_eval = NUL;
17315 #endif
17319 * "winbufnr(nr)" function
17321 static void
17322 f_winbufnr(argvars, rettv)
17323 typval_T *argvars;
17324 typval_T *rettv;
17326 win_T *wp;
17328 wp = find_win_by_nr(&argvars[0], NULL);
17329 if (wp == NULL)
17330 rettv->vval.v_number = -1;
17331 else
17332 rettv->vval.v_number = wp->w_buffer->b_fnum;
17336 * "wincol()" function
17338 static void
17339 f_wincol(argvars, rettv)
17340 typval_T *argvars UNUSED;
17341 typval_T *rettv;
17343 validate_cursor();
17344 rettv->vval.v_number = curwin->w_wcol + 1;
17348 * "winheight(nr)" function
17350 static void
17351 f_winheight(argvars, rettv)
17352 typval_T *argvars;
17353 typval_T *rettv;
17355 win_T *wp;
17357 wp = find_win_by_nr(&argvars[0], NULL);
17358 if (wp == NULL)
17359 rettv->vval.v_number = -1;
17360 else
17361 rettv->vval.v_number = wp->w_height;
17365 * "winline()" function
17367 static void
17368 f_winline(argvars, rettv)
17369 typval_T *argvars UNUSED;
17370 typval_T *rettv;
17372 validate_cursor();
17373 rettv->vval.v_number = curwin->w_wrow + 1;
17377 * "winnr()" function
17379 static void
17380 f_winnr(argvars, rettv)
17381 typval_T *argvars UNUSED;
17382 typval_T *rettv;
17384 int nr = 1;
17386 #ifdef FEAT_WINDOWS
17387 nr = get_winnr(curtab, &argvars[0]);
17388 #endif
17389 rettv->vval.v_number = nr;
17393 * "winrestcmd()" function
17395 static void
17396 f_winrestcmd(argvars, rettv)
17397 typval_T *argvars UNUSED;
17398 typval_T *rettv;
17400 #ifdef FEAT_WINDOWS
17401 win_T *wp;
17402 int winnr = 1;
17403 garray_T ga;
17404 char_u buf[50];
17406 ga_init2(&ga, (int)sizeof(char), 70);
17407 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17409 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17410 ga_concat(&ga, buf);
17411 # ifdef FEAT_VERTSPLIT
17412 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17413 ga_concat(&ga, buf);
17414 # endif
17415 ++winnr;
17417 ga_append(&ga, NUL);
17419 rettv->vval.v_string = ga.ga_data;
17420 #else
17421 rettv->vval.v_string = NULL;
17422 #endif
17423 rettv->v_type = VAR_STRING;
17427 * "winrestview()" function
17429 static void
17430 f_winrestview(argvars, rettv)
17431 typval_T *argvars;
17432 typval_T *rettv UNUSED;
17434 dict_T *dict;
17436 if (argvars[0].v_type != VAR_DICT
17437 || (dict = argvars[0].vval.v_dict) == NULL)
17438 EMSG(_(e_invarg));
17439 else
17441 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17442 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17443 #ifdef FEAT_VIRTUALEDIT
17444 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17445 #endif
17446 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17447 curwin->w_set_curswant = FALSE;
17449 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17450 #ifdef FEAT_DIFF
17451 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17452 #endif
17453 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17454 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17456 check_cursor();
17457 changed_cline_bef_curs();
17458 invalidate_botline();
17459 redraw_later(VALID);
17461 if (curwin->w_topline == 0)
17462 curwin->w_topline = 1;
17463 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17464 curwin->w_topline = curbuf->b_ml.ml_line_count;
17465 #ifdef FEAT_DIFF
17466 check_topfill(curwin, TRUE);
17467 #endif
17472 * "winsaveview()" function
17474 static void
17475 f_winsaveview(argvars, rettv)
17476 typval_T *argvars UNUSED;
17477 typval_T *rettv;
17479 dict_T *dict;
17481 dict = dict_alloc();
17482 if (dict == NULL)
17483 return;
17484 rettv->v_type = VAR_DICT;
17485 rettv->vval.v_dict = dict;
17486 ++dict->dv_refcount;
17488 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17489 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17490 #ifdef FEAT_VIRTUALEDIT
17491 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17492 #endif
17493 update_curswant();
17494 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17496 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17497 #ifdef FEAT_DIFF
17498 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17499 #endif
17500 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17501 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17505 * "winwidth(nr)" function
17507 static void
17508 f_winwidth(argvars, rettv)
17509 typval_T *argvars;
17510 typval_T *rettv;
17512 win_T *wp;
17514 wp = find_win_by_nr(&argvars[0], NULL);
17515 if (wp == NULL)
17516 rettv->vval.v_number = -1;
17517 else
17518 #ifdef FEAT_VERTSPLIT
17519 rettv->vval.v_number = wp->w_width;
17520 #else
17521 rettv->vval.v_number = Columns;
17522 #endif
17526 * "writefile()" function
17528 static void
17529 f_writefile(argvars, rettv)
17530 typval_T *argvars;
17531 typval_T *rettv;
17533 int binary = FALSE;
17534 char_u *fname;
17535 FILE *fd;
17536 listitem_T *li;
17537 char_u *s;
17538 int ret = 0;
17539 int c;
17541 if (check_restricted() || check_secure())
17542 return;
17544 if (argvars[0].v_type != VAR_LIST)
17546 EMSG2(_(e_listarg), "writefile()");
17547 return;
17549 if (argvars[0].vval.v_list == NULL)
17550 return;
17552 if (argvars[2].v_type != VAR_UNKNOWN
17553 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17554 binary = TRUE;
17556 /* Always open the file in binary mode, library functions have a mind of
17557 * their own about CR-LF conversion. */
17558 fname = get_tv_string(&argvars[1]);
17559 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17561 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17562 ret = -1;
17564 else
17566 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17567 li = li->li_next)
17569 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17571 if (*s == '\n')
17572 c = putc(NUL, fd);
17573 else
17574 c = putc(*s, fd);
17575 if (c == EOF)
17577 ret = -1;
17578 break;
17581 if (!binary || li->li_next != NULL)
17582 if (putc('\n', fd) == EOF)
17584 ret = -1;
17585 break;
17587 if (ret < 0)
17589 EMSG(_(e_write));
17590 break;
17593 fclose(fd);
17596 rettv->vval.v_number = ret;
17600 * Translate a String variable into a position.
17601 * Returns NULL when there is an error.
17603 static pos_T *
17604 var2fpos(varp, dollar_lnum, fnum)
17605 typval_T *varp;
17606 int dollar_lnum; /* TRUE when $ is last line */
17607 int *fnum; /* set to fnum for '0, 'A, etc. */
17609 char_u *name;
17610 static pos_T pos;
17611 pos_T *pp;
17613 /* Argument can be [lnum, col, coladd]. */
17614 if (varp->v_type == VAR_LIST)
17616 list_T *l;
17617 int len;
17618 int error = FALSE;
17619 listitem_T *li;
17621 l = varp->vval.v_list;
17622 if (l == NULL)
17623 return NULL;
17625 /* Get the line number */
17626 pos.lnum = list_find_nr(l, 0L, &error);
17627 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17628 return NULL; /* invalid line number */
17630 /* Get the column number */
17631 pos.col = list_find_nr(l, 1L, &error);
17632 if (error)
17633 return NULL;
17634 len = (long)STRLEN(ml_get(pos.lnum));
17636 /* We accept "$" for the column number: last column. */
17637 li = list_find(l, 1L);
17638 if (li != NULL && li->li_tv.v_type == VAR_STRING
17639 && li->li_tv.vval.v_string != NULL
17640 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17641 pos.col = len + 1;
17643 /* Accept a position up to the NUL after the line. */
17644 if (pos.col == 0 || (int)pos.col > len + 1)
17645 return NULL; /* invalid column number */
17646 --pos.col;
17648 #ifdef FEAT_VIRTUALEDIT
17649 /* Get the virtual offset. Defaults to zero. */
17650 pos.coladd = list_find_nr(l, 2L, &error);
17651 if (error)
17652 pos.coladd = 0;
17653 #endif
17655 return &pos;
17658 name = get_tv_string_chk(varp);
17659 if (name == NULL)
17660 return NULL;
17661 if (name[0] == '.') /* cursor */
17662 return &curwin->w_cursor;
17663 #ifdef FEAT_VISUAL
17664 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17666 if (VIsual_active)
17667 return &VIsual;
17668 return &curwin->w_cursor;
17670 #endif
17671 if (name[0] == '\'') /* mark */
17673 pp = getmark_fnum(name[1], FALSE, fnum);
17674 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17675 return NULL;
17676 return pp;
17679 #ifdef FEAT_VIRTUALEDIT
17680 pos.coladd = 0;
17681 #endif
17683 if (name[0] == 'w' && dollar_lnum)
17685 pos.col = 0;
17686 if (name[1] == '0') /* "w0": first visible line */
17688 update_topline();
17689 pos.lnum = curwin->w_topline;
17690 return &pos;
17692 else if (name[1] == '$') /* "w$": last visible line */
17694 validate_botline();
17695 pos.lnum = curwin->w_botline - 1;
17696 return &pos;
17699 else if (name[0] == '$') /* last column or line */
17701 if (dollar_lnum)
17703 pos.lnum = curbuf->b_ml.ml_line_count;
17704 pos.col = 0;
17706 else
17708 pos.lnum = curwin->w_cursor.lnum;
17709 pos.col = (colnr_T)STRLEN(ml_get_curline());
17711 return &pos;
17713 return NULL;
17717 * Convert list in "arg" into a position and optional file number.
17718 * When "fnump" is NULL there is no file number, only 3 items.
17719 * Note that the column is passed on as-is, the caller may want to decrement
17720 * it to use 1 for the first column.
17721 * Return FAIL when conversion is not possible, doesn't check the position for
17722 * validity.
17724 static int
17725 list2fpos(arg, posp, fnump)
17726 typval_T *arg;
17727 pos_T *posp;
17728 int *fnump;
17730 list_T *l = arg->vval.v_list;
17731 long i = 0;
17732 long n;
17734 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17735 * when "fnump" isn't NULL and "coladd" is optional. */
17736 if (arg->v_type != VAR_LIST
17737 || l == NULL
17738 || l->lv_len < (fnump == NULL ? 2 : 3)
17739 || l->lv_len > (fnump == NULL ? 3 : 4))
17740 return FAIL;
17742 if (fnump != NULL)
17744 n = list_find_nr(l, i++, NULL); /* fnum */
17745 if (n < 0)
17746 return FAIL;
17747 if (n == 0)
17748 n = curbuf->b_fnum; /* current buffer */
17749 *fnump = n;
17752 n = list_find_nr(l, i++, NULL); /* lnum */
17753 if (n < 0)
17754 return FAIL;
17755 posp->lnum = n;
17757 n = list_find_nr(l, i++, NULL); /* col */
17758 if (n < 0)
17759 return FAIL;
17760 posp->col = n;
17762 #ifdef FEAT_VIRTUALEDIT
17763 n = list_find_nr(l, i, NULL);
17764 if (n < 0)
17765 posp->coladd = 0;
17766 else
17767 posp->coladd = n;
17768 #endif
17770 return OK;
17774 * Get the length of an environment variable name.
17775 * Advance "arg" to the first character after the name.
17776 * Return 0 for error.
17778 static int
17779 get_env_len(arg)
17780 char_u **arg;
17782 char_u *p;
17783 int len;
17785 for (p = *arg; vim_isIDc(*p); ++p)
17787 if (p == *arg) /* no name found */
17788 return 0;
17790 len = (int)(p - *arg);
17791 *arg = p;
17792 return len;
17796 * Get the length of the name of a function or internal variable.
17797 * "arg" is advanced to the first non-white character after the name.
17798 * Return 0 if something is wrong.
17800 static int
17801 get_id_len(arg)
17802 char_u **arg;
17804 char_u *p;
17805 int len;
17807 /* Find the end of the name. */
17808 for (p = *arg; eval_isnamec(*p); ++p)
17810 if (p == *arg) /* no name found */
17811 return 0;
17813 len = (int)(p - *arg);
17814 *arg = skipwhite(p);
17816 return len;
17820 * Get the length of the name of a variable or function.
17821 * Only the name is recognized, does not handle ".key" or "[idx]".
17822 * "arg" is advanced to the first non-white character after the name.
17823 * Return -1 if curly braces expansion failed.
17824 * Return 0 if something else is wrong.
17825 * If the name contains 'magic' {}'s, expand them and return the
17826 * expanded name in an allocated string via 'alias' - caller must free.
17828 static int
17829 get_name_len(arg, alias, evaluate, verbose)
17830 char_u **arg;
17831 char_u **alias;
17832 int evaluate;
17833 int verbose;
17835 int len;
17836 char_u *p;
17837 char_u *expr_start;
17838 char_u *expr_end;
17840 *alias = NULL; /* default to no alias */
17842 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17843 && (*arg)[2] == (int)KE_SNR)
17845 /* hard coded <SNR>, already translated */
17846 *arg += 3;
17847 return get_id_len(arg) + 3;
17849 len = eval_fname_script(*arg);
17850 if (len > 0)
17852 /* literal "<SID>", "s:" or "<SNR>" */
17853 *arg += len;
17857 * Find the end of the name; check for {} construction.
17859 p = find_name_end(*arg, &expr_start, &expr_end,
17860 len > 0 ? 0 : FNE_CHECK_START);
17861 if (expr_start != NULL)
17863 char_u *temp_string;
17865 if (!evaluate)
17867 len += (int)(p - *arg);
17868 *arg = skipwhite(p);
17869 return len;
17873 * Include any <SID> etc in the expanded string:
17874 * Thus the -len here.
17876 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17877 if (temp_string == NULL)
17878 return -1;
17879 *alias = temp_string;
17880 *arg = skipwhite(p);
17881 return (int)STRLEN(temp_string);
17884 len += get_id_len(arg);
17885 if (len == 0 && verbose)
17886 EMSG2(_(e_invexpr2), *arg);
17888 return len;
17892 * Find the end of a variable or function name, taking care of magic braces.
17893 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17894 * start and end of the first magic braces item.
17895 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17896 * Return a pointer to just after the name. Equal to "arg" if there is no
17897 * valid name.
17899 static char_u *
17900 find_name_end(arg, expr_start, expr_end, flags)
17901 char_u *arg;
17902 char_u **expr_start;
17903 char_u **expr_end;
17904 int flags;
17906 int mb_nest = 0;
17907 int br_nest = 0;
17908 char_u *p;
17910 if (expr_start != NULL)
17912 *expr_start = NULL;
17913 *expr_end = NULL;
17916 /* Quick check for valid starting character. */
17917 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17918 return arg;
17920 for (p = arg; *p != NUL
17921 && (eval_isnamec(*p)
17922 || *p == '{'
17923 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17924 || mb_nest != 0
17925 || br_nest != 0); mb_ptr_adv(p))
17927 if (*p == '\'')
17929 /* skip over 'string' to avoid counting [ and ] inside it. */
17930 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17932 if (*p == NUL)
17933 break;
17935 else if (*p == '"')
17937 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17938 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17939 if (*p == '\\' && p[1] != NUL)
17940 ++p;
17941 if (*p == NUL)
17942 break;
17945 if (mb_nest == 0)
17947 if (*p == '[')
17948 ++br_nest;
17949 else if (*p == ']')
17950 --br_nest;
17953 if (br_nest == 0)
17955 if (*p == '{')
17957 mb_nest++;
17958 if (expr_start != NULL && *expr_start == NULL)
17959 *expr_start = p;
17961 else if (*p == '}')
17963 mb_nest--;
17964 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
17965 *expr_end = p;
17970 return p;
17974 * Expands out the 'magic' {}'s in a variable/function name.
17975 * Note that this can call itself recursively, to deal with
17976 * constructs like foo{bar}{baz}{bam}
17977 * The four pointer arguments point to "foo{expre}ss{ion}bar"
17978 * "in_start" ^
17979 * "expr_start" ^
17980 * "expr_end" ^
17981 * "in_end" ^
17983 * Returns a new allocated string, which the caller must free.
17984 * Returns NULL for failure.
17986 static char_u *
17987 make_expanded_name(in_start, expr_start, expr_end, in_end)
17988 char_u *in_start;
17989 char_u *expr_start;
17990 char_u *expr_end;
17991 char_u *in_end;
17993 char_u c1;
17994 char_u *retval = NULL;
17995 char_u *temp_result;
17996 char_u *nextcmd = NULL;
17998 if (expr_end == NULL || in_end == NULL)
17999 return NULL;
18000 *expr_start = NUL;
18001 *expr_end = NUL;
18002 c1 = *in_end;
18003 *in_end = NUL;
18005 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18006 if (temp_result != NULL && nextcmd == NULL)
18008 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18009 + (in_end - expr_end) + 1));
18010 if (retval != NULL)
18012 STRCPY(retval, in_start);
18013 STRCAT(retval, temp_result);
18014 STRCAT(retval, expr_end + 1);
18017 vim_free(temp_result);
18019 *in_end = c1; /* put char back for error messages */
18020 *expr_start = '{';
18021 *expr_end = '}';
18023 if (retval != NULL)
18025 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18026 if (expr_start != NULL)
18028 /* Further expansion! */
18029 temp_result = make_expanded_name(retval, expr_start,
18030 expr_end, temp_result);
18031 vim_free(retval);
18032 retval = temp_result;
18036 return retval;
18040 * Return TRUE if character "c" can be used in a variable or function name.
18041 * Does not include '{' or '}' for magic braces.
18043 static int
18044 eval_isnamec(c)
18045 int c;
18047 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18051 * Return TRUE if character "c" can be used as the first character in a
18052 * variable or function name (excluding '{' and '}').
18054 static int
18055 eval_isnamec1(c)
18056 int c;
18058 return (ASCII_ISALPHA(c) || c == '_');
18062 * Set number v: variable to "val".
18064 void
18065 set_vim_var_nr(idx, val)
18066 int idx;
18067 long val;
18069 vimvars[idx].vv_nr = val;
18073 * Get number v: variable value.
18075 long
18076 get_vim_var_nr(idx)
18077 int idx;
18079 return vimvars[idx].vv_nr;
18083 * Get string v: variable value. Uses a static buffer, can only be used once.
18085 char_u *
18086 get_vim_var_str(idx)
18087 int idx;
18089 return get_tv_string(&vimvars[idx].vv_tv);
18093 * Get List v: variable value. Caller must take care of reference count when
18094 * needed.
18096 list_T *
18097 get_vim_var_list(idx)
18098 int idx;
18100 return vimvars[idx].vv_list;
18104 * Set v:count to "count" and v:count1 to "count1".
18105 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18107 void
18108 set_vcount(count, count1, set_prevcount)
18109 long count;
18110 long count1;
18111 int set_prevcount;
18113 if (set_prevcount)
18114 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18115 vimvars[VV_COUNT].vv_nr = count;
18116 vimvars[VV_COUNT1].vv_nr = count1;
18120 * Set string v: variable to a copy of "val".
18122 void
18123 set_vim_var_string(idx, val, len)
18124 int idx;
18125 char_u *val;
18126 int len; /* length of "val" to use or -1 (whole string) */
18128 /* Need to do this (at least) once, since we can't initialize a union.
18129 * Will always be invoked when "v:progname" is set. */
18130 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18132 vim_free(vimvars[idx].vv_str);
18133 if (val == NULL)
18134 vimvars[idx].vv_str = NULL;
18135 else if (len == -1)
18136 vimvars[idx].vv_str = vim_strsave(val);
18137 else
18138 vimvars[idx].vv_str = vim_strnsave(val, len);
18142 * Set List v: variable to "val".
18144 void
18145 set_vim_var_list(idx, val)
18146 int idx;
18147 list_T *val;
18149 list_unref(vimvars[idx].vv_list);
18150 vimvars[idx].vv_list = val;
18151 if (val != NULL)
18152 ++val->lv_refcount;
18156 * Set v:register if needed.
18158 void
18159 set_reg_var(c)
18160 int c;
18162 char_u regname;
18164 if (c == 0 || c == ' ')
18165 regname = '"';
18166 else
18167 regname = c;
18168 /* Avoid free/alloc when the value is already right. */
18169 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18170 set_vim_var_string(VV_REG, &regname, 1);
18174 * Get or set v:exception. If "oldval" == NULL, return the current value.
18175 * Otherwise, restore the value to "oldval" and return NULL.
18176 * Must always be called in pairs to save and restore v:exception! Does not
18177 * take care of memory allocations.
18179 char_u *
18180 v_exception(oldval)
18181 char_u *oldval;
18183 if (oldval == NULL)
18184 return vimvars[VV_EXCEPTION].vv_str;
18186 vimvars[VV_EXCEPTION].vv_str = oldval;
18187 return NULL;
18191 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18192 * Otherwise, restore the value to "oldval" and return NULL.
18193 * Must always be called in pairs to save and restore v:throwpoint! Does not
18194 * take care of memory allocations.
18196 char_u *
18197 v_throwpoint(oldval)
18198 char_u *oldval;
18200 if (oldval == NULL)
18201 return vimvars[VV_THROWPOINT].vv_str;
18203 vimvars[VV_THROWPOINT].vv_str = oldval;
18204 return NULL;
18207 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18209 * Set v:cmdarg.
18210 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18211 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18212 * Must always be called in pairs!
18214 char_u *
18215 set_cmdarg(eap, oldarg)
18216 exarg_T *eap;
18217 char_u *oldarg;
18219 char_u *oldval;
18220 char_u *newval;
18221 unsigned len;
18223 oldval = vimvars[VV_CMDARG].vv_str;
18224 if (eap == NULL)
18226 vim_free(oldval);
18227 vimvars[VV_CMDARG].vv_str = oldarg;
18228 return NULL;
18231 if (eap->force_bin == FORCE_BIN)
18232 len = 6;
18233 else if (eap->force_bin == FORCE_NOBIN)
18234 len = 8;
18235 else
18236 len = 0;
18238 if (eap->read_edit)
18239 len += 7;
18241 if (eap->force_ff != 0)
18242 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18243 # ifdef FEAT_MBYTE
18244 if (eap->force_enc != 0)
18245 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18246 if (eap->bad_char != 0)
18247 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18248 # endif
18250 newval = alloc(len + 1);
18251 if (newval == NULL)
18252 return NULL;
18254 if (eap->force_bin == FORCE_BIN)
18255 sprintf((char *)newval, " ++bin");
18256 else if (eap->force_bin == FORCE_NOBIN)
18257 sprintf((char *)newval, " ++nobin");
18258 else
18259 *newval = NUL;
18261 if (eap->read_edit)
18262 STRCAT(newval, " ++edit");
18264 if (eap->force_ff != 0)
18265 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18266 eap->cmd + eap->force_ff);
18267 # ifdef FEAT_MBYTE
18268 if (eap->force_enc != 0)
18269 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18270 eap->cmd + eap->force_enc);
18271 if (eap->bad_char != 0)
18272 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18273 eap->cmd + eap->bad_char);
18274 # endif
18275 vimvars[VV_CMDARG].vv_str = newval;
18276 return oldval;
18278 #endif
18281 * Get the value of internal variable "name".
18282 * Return OK or FAIL.
18284 static int
18285 get_var_tv(name, len, rettv, verbose)
18286 char_u *name;
18287 int len; /* length of "name" */
18288 typval_T *rettv; /* NULL when only checking existence */
18289 int verbose; /* may give error message */
18291 int ret = OK;
18292 typval_T *tv = NULL;
18293 typval_T atv;
18294 dictitem_T *v;
18295 int cc;
18297 /* truncate the name, so that we can use strcmp() */
18298 cc = name[len];
18299 name[len] = NUL;
18302 * Check for "b:changedtick".
18304 if (STRCMP(name, "b:changedtick") == 0)
18306 atv.v_type = VAR_NUMBER;
18307 atv.vval.v_number = curbuf->b_changedtick;
18308 tv = &atv;
18312 * Check for user-defined variables.
18314 else
18316 v = find_var(name, NULL);
18317 if (v != NULL)
18318 tv = &v->di_tv;
18321 if (tv == NULL)
18323 if (rettv != NULL && verbose)
18324 EMSG2(_(e_undefvar), name);
18325 ret = FAIL;
18327 else if (rettv != NULL)
18328 copy_tv(tv, rettv);
18330 name[len] = cc;
18332 return ret;
18336 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18337 * Also handle function call with Funcref variable: func(expr)
18338 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18340 static int
18341 handle_subscript(arg, rettv, evaluate, verbose)
18342 char_u **arg;
18343 typval_T *rettv;
18344 int evaluate; /* do more than finding the end */
18345 int verbose; /* give error messages */
18347 int ret = OK;
18348 dict_T *selfdict = NULL;
18349 char_u *s;
18350 int len;
18351 typval_T functv;
18353 while (ret == OK
18354 && (**arg == '['
18355 || (**arg == '.' && rettv->v_type == VAR_DICT)
18356 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18357 && !vim_iswhite(*(*arg - 1)))
18359 if (**arg == '(')
18361 /* need to copy the funcref so that we can clear rettv */
18362 functv = *rettv;
18363 rettv->v_type = VAR_UNKNOWN;
18365 /* Invoke the function. Recursive! */
18366 s = functv.vval.v_string;
18367 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18368 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18369 &len, evaluate, selfdict);
18371 /* Clear the funcref afterwards, so that deleting it while
18372 * evaluating the arguments is possible (see test55). */
18373 clear_tv(&functv);
18375 /* Stop the expression evaluation when immediately aborting on
18376 * error, or when an interrupt occurred or an exception was thrown
18377 * but not caught. */
18378 if (aborting())
18380 if (ret == OK)
18381 clear_tv(rettv);
18382 ret = FAIL;
18384 dict_unref(selfdict);
18385 selfdict = NULL;
18387 else /* **arg == '[' || **arg == '.' */
18389 dict_unref(selfdict);
18390 if (rettv->v_type == VAR_DICT)
18392 selfdict = rettv->vval.v_dict;
18393 if (selfdict != NULL)
18394 ++selfdict->dv_refcount;
18396 else
18397 selfdict = NULL;
18398 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18400 clear_tv(rettv);
18401 ret = FAIL;
18405 dict_unref(selfdict);
18406 return ret;
18410 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18411 * value).
18413 static typval_T *
18414 alloc_tv()
18416 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18420 * Allocate memory for a variable type-value, and assign a string to it.
18421 * The string "s" must have been allocated, it is consumed.
18422 * Return NULL for out of memory, the variable otherwise.
18424 static typval_T *
18425 alloc_string_tv(s)
18426 char_u *s;
18428 typval_T *rettv;
18430 rettv = alloc_tv();
18431 if (rettv != NULL)
18433 rettv->v_type = VAR_STRING;
18434 rettv->vval.v_string = s;
18436 else
18437 vim_free(s);
18438 return rettv;
18442 * Free the memory for a variable type-value.
18444 void
18445 free_tv(varp)
18446 typval_T *varp;
18448 if (varp != NULL)
18450 switch (varp->v_type)
18452 case VAR_FUNC:
18453 func_unref(varp->vval.v_string);
18454 /*FALLTHROUGH*/
18455 case VAR_STRING:
18456 vim_free(varp->vval.v_string);
18457 break;
18458 case VAR_LIST:
18459 list_unref(varp->vval.v_list);
18460 break;
18461 case VAR_DICT:
18462 dict_unref(varp->vval.v_dict);
18463 break;
18464 case VAR_NUMBER:
18465 #ifdef FEAT_FLOAT
18466 case VAR_FLOAT:
18467 #endif
18468 case VAR_UNKNOWN:
18469 break;
18470 default:
18471 EMSG2(_(e_intern2), "free_tv()");
18472 break;
18474 vim_free(varp);
18479 * Free the memory for a variable value and set the value to NULL or 0.
18481 void
18482 clear_tv(varp)
18483 typval_T *varp;
18485 if (varp != NULL)
18487 switch (varp->v_type)
18489 case VAR_FUNC:
18490 func_unref(varp->vval.v_string);
18491 /*FALLTHROUGH*/
18492 case VAR_STRING:
18493 vim_free(varp->vval.v_string);
18494 varp->vval.v_string = NULL;
18495 break;
18496 case VAR_LIST:
18497 list_unref(varp->vval.v_list);
18498 varp->vval.v_list = NULL;
18499 break;
18500 case VAR_DICT:
18501 dict_unref(varp->vval.v_dict);
18502 varp->vval.v_dict = NULL;
18503 break;
18504 case VAR_NUMBER:
18505 varp->vval.v_number = 0;
18506 break;
18507 #ifdef FEAT_FLOAT
18508 case VAR_FLOAT:
18509 varp->vval.v_float = 0.0;
18510 break;
18511 #endif
18512 case VAR_UNKNOWN:
18513 break;
18514 default:
18515 EMSG2(_(e_intern2), "clear_tv()");
18517 varp->v_lock = 0;
18522 * Set the value of a variable to NULL without freeing items.
18524 static void
18525 init_tv(varp)
18526 typval_T *varp;
18528 if (varp != NULL)
18529 vim_memset(varp, 0, sizeof(typval_T));
18533 * Get the number value of a variable.
18534 * If it is a String variable, uses vim_str2nr().
18535 * For incompatible types, return 0.
18536 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18537 * caller of incompatible types: it sets *denote to TRUE if "denote"
18538 * is not NULL or returns -1 otherwise.
18540 static long
18541 get_tv_number(varp)
18542 typval_T *varp;
18544 int error = FALSE;
18546 return get_tv_number_chk(varp, &error); /* return 0L on error */
18549 long
18550 get_tv_number_chk(varp, denote)
18551 typval_T *varp;
18552 int *denote;
18554 long n = 0L;
18556 switch (varp->v_type)
18558 case VAR_NUMBER:
18559 return (long)(varp->vval.v_number);
18560 #ifdef FEAT_FLOAT
18561 case VAR_FLOAT:
18562 EMSG(_("E805: Using a Float as a Number"));
18563 break;
18564 #endif
18565 case VAR_FUNC:
18566 EMSG(_("E703: Using a Funcref as a Number"));
18567 break;
18568 case VAR_STRING:
18569 if (varp->vval.v_string != NULL)
18570 vim_str2nr(varp->vval.v_string, NULL, NULL,
18571 TRUE, TRUE, &n, NULL);
18572 return n;
18573 case VAR_LIST:
18574 EMSG(_("E745: Using a List as a Number"));
18575 break;
18576 case VAR_DICT:
18577 EMSG(_("E728: Using a Dictionary as a Number"));
18578 break;
18579 default:
18580 EMSG2(_(e_intern2), "get_tv_number()");
18581 break;
18583 if (denote == NULL) /* useful for values that must be unsigned */
18584 n = -1;
18585 else
18586 *denote = TRUE;
18587 return n;
18591 * Get the lnum from the first argument.
18592 * Also accepts ".", "$", etc., but that only works for the current buffer.
18593 * Returns -1 on error.
18595 static linenr_T
18596 get_tv_lnum(argvars)
18597 typval_T *argvars;
18599 typval_T rettv;
18600 linenr_T lnum;
18602 lnum = get_tv_number_chk(&argvars[0], NULL);
18603 if (lnum == 0) /* no valid number, try using line() */
18605 rettv.v_type = VAR_NUMBER;
18606 f_line(argvars, &rettv);
18607 lnum = rettv.vval.v_number;
18608 clear_tv(&rettv);
18610 return lnum;
18614 * Get the lnum from the first argument.
18615 * Also accepts "$", then "buf" is used.
18616 * Returns 0 on error.
18618 static linenr_T
18619 get_tv_lnum_buf(argvars, buf)
18620 typval_T *argvars;
18621 buf_T *buf;
18623 if (argvars[0].v_type == VAR_STRING
18624 && argvars[0].vval.v_string != NULL
18625 && argvars[0].vval.v_string[0] == '$'
18626 && buf != NULL)
18627 return buf->b_ml.ml_line_count;
18628 return get_tv_number_chk(&argvars[0], NULL);
18632 * Get the string value of a variable.
18633 * If it is a Number variable, the number is converted into a string.
18634 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18635 * get_tv_string_buf() uses a given buffer.
18636 * If the String variable has never been set, return an empty string.
18637 * Never returns NULL;
18638 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18639 * NULL on error.
18641 static char_u *
18642 get_tv_string(varp)
18643 typval_T *varp;
18645 static char_u mybuf[NUMBUFLEN];
18647 return get_tv_string_buf(varp, mybuf);
18650 static char_u *
18651 get_tv_string_buf(varp, buf)
18652 typval_T *varp;
18653 char_u *buf;
18655 char_u *res = get_tv_string_buf_chk(varp, buf);
18657 return res != NULL ? res : (char_u *)"";
18660 char_u *
18661 get_tv_string_chk(varp)
18662 typval_T *varp;
18664 static char_u mybuf[NUMBUFLEN];
18666 return get_tv_string_buf_chk(varp, mybuf);
18669 static char_u *
18670 get_tv_string_buf_chk(varp, buf)
18671 typval_T *varp;
18672 char_u *buf;
18674 switch (varp->v_type)
18676 case VAR_NUMBER:
18677 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18678 return buf;
18679 case VAR_FUNC:
18680 EMSG(_("E729: using Funcref as a String"));
18681 break;
18682 case VAR_LIST:
18683 EMSG(_("E730: using List as a String"));
18684 break;
18685 case VAR_DICT:
18686 EMSG(_("E731: using Dictionary as a String"));
18687 break;
18688 #ifdef FEAT_FLOAT
18689 case VAR_FLOAT:
18690 EMSG(_("E806: using Float as a String"));
18691 break;
18692 #endif
18693 case VAR_STRING:
18694 if (varp->vval.v_string != NULL)
18695 return varp->vval.v_string;
18696 return (char_u *)"";
18697 default:
18698 EMSG2(_(e_intern2), "get_tv_string_buf()");
18699 break;
18701 return NULL;
18705 * Find variable "name" in the list of variables.
18706 * Return a pointer to it if found, NULL if not found.
18707 * Careful: "a:0" variables don't have a name.
18708 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18709 * hashtab_T used.
18711 static dictitem_T *
18712 find_var(name, htp)
18713 char_u *name;
18714 hashtab_T **htp;
18716 char_u *varname;
18717 hashtab_T *ht;
18719 ht = find_var_ht(name, &varname);
18720 if (htp != NULL)
18721 *htp = ht;
18722 if (ht == NULL)
18723 return NULL;
18724 return find_var_in_ht(ht, varname, htp != NULL);
18728 * Find variable "varname" in hashtab "ht".
18729 * Returns NULL if not found.
18731 static dictitem_T *
18732 find_var_in_ht(ht, varname, writing)
18733 hashtab_T *ht;
18734 char_u *varname;
18735 int writing;
18737 hashitem_T *hi;
18739 if (*varname == NUL)
18741 /* Must be something like "s:", otherwise "ht" would be NULL. */
18742 switch (varname[-2])
18744 case 's': return &SCRIPT_SV(current_SID).sv_var;
18745 case 'g': return &globvars_var;
18746 case 'v': return &vimvars_var;
18747 case 'b': return &curbuf->b_bufvar;
18748 case 'w': return &curwin->w_winvar;
18749 #ifdef FEAT_WINDOWS
18750 case 't': return &curtab->tp_winvar;
18751 #endif
18752 case 'l': return current_funccal == NULL
18753 ? NULL : &current_funccal->l_vars_var;
18754 case 'a': return current_funccal == NULL
18755 ? NULL : &current_funccal->l_avars_var;
18757 return NULL;
18760 hi = hash_find(ht, varname);
18761 if (HASHITEM_EMPTY(hi))
18763 /* For global variables we may try auto-loading the script. If it
18764 * worked find the variable again. Don't auto-load a script if it was
18765 * loaded already, otherwise it would be loaded every time when
18766 * checking if a function name is a Funcref variable. */
18767 if (ht == &globvarht && !writing
18768 && script_autoload(varname, FALSE) && !aborting())
18769 hi = hash_find(ht, varname);
18770 if (HASHITEM_EMPTY(hi))
18771 return NULL;
18773 return HI2DI(hi);
18777 * Find the hashtab used for a variable name.
18778 * Set "varname" to the start of name without ':'.
18780 static hashtab_T *
18781 find_var_ht(name, varname)
18782 char_u *name;
18783 char_u **varname;
18785 hashitem_T *hi;
18787 if (name[1] != ':')
18789 /* The name must not start with a colon or #. */
18790 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18791 return NULL;
18792 *varname = name;
18794 /* "version" is "v:version" in all scopes */
18795 hi = hash_find(&compat_hashtab, name);
18796 if (!HASHITEM_EMPTY(hi))
18797 return &compat_hashtab;
18799 if (current_funccal == NULL)
18800 return &globvarht; /* global variable */
18801 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18803 *varname = name + 2;
18804 if (*name == 'g') /* global variable */
18805 return &globvarht;
18806 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18808 if (vim_strchr(name + 2, ':') != NULL
18809 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18810 return NULL;
18811 if (*name == 'b') /* buffer variable */
18812 return &curbuf->b_vars.dv_hashtab;
18813 if (*name == 'w') /* window variable */
18814 return &curwin->w_vars.dv_hashtab;
18815 #ifdef FEAT_WINDOWS
18816 if (*name == 't') /* tab page variable */
18817 return &curtab->tp_vars.dv_hashtab;
18818 #endif
18819 if (*name == 'v') /* v: variable */
18820 return &vimvarht;
18821 if (*name == 'a' && current_funccal != NULL) /* function argument */
18822 return &current_funccal->l_avars.dv_hashtab;
18823 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18824 return &current_funccal->l_vars.dv_hashtab;
18825 if (*name == 's' /* script variable */
18826 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18827 return &SCRIPT_VARS(current_SID);
18828 return NULL;
18832 * Get the string value of a (global/local) variable.
18833 * Returns NULL when it doesn't exist.
18835 char_u *
18836 get_var_value(name)
18837 char_u *name;
18839 dictitem_T *v;
18841 v = find_var(name, NULL);
18842 if (v == NULL)
18843 return NULL;
18844 return get_tv_string(&v->di_tv);
18848 * Allocate a new hashtab for a sourced script. It will be used while
18849 * sourcing this script and when executing functions defined in the script.
18851 void
18852 new_script_vars(id)
18853 scid_T id;
18855 int i;
18856 hashtab_T *ht;
18857 scriptvar_T *sv;
18859 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18861 /* Re-allocating ga_data means that an ht_array pointing to
18862 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18863 * at its init value. Also reset "v_dict", it's always the same. */
18864 for (i = 1; i <= ga_scripts.ga_len; ++i)
18866 ht = &SCRIPT_VARS(i);
18867 if (ht->ht_mask == HT_INIT_SIZE - 1)
18868 ht->ht_array = ht->ht_smallarray;
18869 sv = &SCRIPT_SV(i);
18870 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18873 while (ga_scripts.ga_len < id)
18875 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18876 init_var_dict(&sv->sv_dict, &sv->sv_var);
18877 ++ga_scripts.ga_len;
18883 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18884 * point to it.
18886 void
18887 init_var_dict(dict, dict_var)
18888 dict_T *dict;
18889 dictitem_T *dict_var;
18891 hash_init(&dict->dv_hashtab);
18892 dict->dv_refcount = DO_NOT_FREE_CNT;
18893 dict->dv_copyID = 0;
18894 dict_var->di_tv.vval.v_dict = dict;
18895 dict_var->di_tv.v_type = VAR_DICT;
18896 dict_var->di_tv.v_lock = VAR_FIXED;
18897 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18898 dict_var->di_key[0] = NUL;
18902 * Clean up a list of internal variables.
18903 * Frees all allocated variables and the value they contain.
18904 * Clears hashtab "ht", does not free it.
18906 void
18907 vars_clear(ht)
18908 hashtab_T *ht;
18910 vars_clear_ext(ht, TRUE);
18914 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18916 static void
18917 vars_clear_ext(ht, free_val)
18918 hashtab_T *ht;
18919 int free_val;
18921 int todo;
18922 hashitem_T *hi;
18923 dictitem_T *v;
18925 hash_lock(ht);
18926 todo = (int)ht->ht_used;
18927 for (hi = ht->ht_array; todo > 0; ++hi)
18929 if (!HASHITEM_EMPTY(hi))
18931 --todo;
18933 /* Free the variable. Don't remove it from the hashtab,
18934 * ht_array might change then. hash_clear() takes care of it
18935 * later. */
18936 v = HI2DI(hi);
18937 if (free_val)
18938 clear_tv(&v->di_tv);
18939 if ((v->di_flags & DI_FLAGS_FIX) == 0)
18940 vim_free(v);
18943 hash_clear(ht);
18944 ht->ht_used = 0;
18948 * Delete a variable from hashtab "ht" at item "hi".
18949 * Clear the variable value and free the dictitem.
18951 static void
18952 delete_var(ht, hi)
18953 hashtab_T *ht;
18954 hashitem_T *hi;
18956 dictitem_T *di = HI2DI(hi);
18958 hash_remove(ht, hi);
18959 clear_tv(&di->di_tv);
18960 vim_free(di);
18964 * List the value of one internal variable.
18966 static void
18967 list_one_var(v, prefix, first)
18968 dictitem_T *v;
18969 char_u *prefix;
18970 int *first;
18972 char_u *tofree;
18973 char_u *s;
18974 char_u numbuf[NUMBUFLEN];
18976 current_copyID += COPYID_INC;
18977 s = echo_string(&v->di_tv, &tofree, numbuf, current_copyID);
18978 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
18979 s == NULL ? (char_u *)"" : s, first);
18980 vim_free(tofree);
18983 static void
18984 list_one_var_a(prefix, name, type, string, first)
18985 char_u *prefix;
18986 char_u *name;
18987 int type;
18988 char_u *string;
18989 int *first; /* when TRUE clear rest of screen and set to FALSE */
18991 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
18992 msg_start();
18993 msg_puts(prefix);
18994 if (name != NULL) /* "a:" vars don't have a name stored */
18995 msg_puts(name);
18996 msg_putchar(' ');
18997 msg_advance(22);
18998 if (type == VAR_NUMBER)
18999 msg_putchar('#');
19000 else if (type == VAR_FUNC)
19001 msg_putchar('*');
19002 else if (type == VAR_LIST)
19004 msg_putchar('[');
19005 if (*string == '[')
19006 ++string;
19008 else if (type == VAR_DICT)
19010 msg_putchar('{');
19011 if (*string == '{')
19012 ++string;
19014 else
19015 msg_putchar(' ');
19017 msg_outtrans(string);
19019 if (type == VAR_FUNC)
19020 msg_puts((char_u *)"()");
19021 if (*first)
19023 msg_clr_eos();
19024 *first = FALSE;
19029 * Set variable "name" to value in "tv".
19030 * If the variable already exists, the value is updated.
19031 * Otherwise the variable is created.
19033 static void
19034 set_var(name, tv, copy)
19035 char_u *name;
19036 typval_T *tv;
19037 int copy; /* make copy of value in "tv" */
19039 dictitem_T *v;
19040 char_u *varname;
19041 hashtab_T *ht;
19042 char_u *p;
19044 if (tv->v_type == VAR_FUNC)
19046 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19047 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19048 ? name[2] : name[0]))
19050 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19051 return;
19053 if (function_exists(name))
19055 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19056 name);
19057 return;
19061 ht = find_var_ht(name, &varname);
19062 if (ht == NULL || *varname == NUL)
19064 EMSG2(_(e_illvar), name);
19065 return;
19068 v = find_var_in_ht(ht, varname, TRUE);
19069 if (v != NULL)
19071 /* existing variable, need to clear the value */
19072 if (var_check_ro(v->di_flags, name)
19073 || tv_check_lock(v->di_tv.v_lock, name))
19074 return;
19075 if (v->di_tv.v_type != tv->v_type
19076 && !((v->di_tv.v_type == VAR_STRING
19077 || v->di_tv.v_type == VAR_NUMBER)
19078 && (tv->v_type == VAR_STRING
19079 || tv->v_type == VAR_NUMBER))
19080 #ifdef FEAT_FLOAT
19081 && !((v->di_tv.v_type == VAR_NUMBER
19082 || v->di_tv.v_type == VAR_FLOAT)
19083 && (tv->v_type == VAR_NUMBER
19084 || tv->v_type == VAR_FLOAT))
19085 #endif
19088 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19089 return;
19093 * Handle setting internal v: variables separately: we don't change
19094 * the type.
19096 if (ht == &vimvarht)
19098 if (v->di_tv.v_type == VAR_STRING)
19100 vim_free(v->di_tv.vval.v_string);
19101 if (copy || tv->v_type != VAR_STRING)
19102 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19103 else
19105 /* Take over the string to avoid an extra alloc/free. */
19106 v->di_tv.vval.v_string = tv->vval.v_string;
19107 tv->vval.v_string = NULL;
19110 else if (v->di_tv.v_type != VAR_NUMBER)
19111 EMSG2(_(e_intern2), "set_var()");
19112 else
19114 v->di_tv.vval.v_number = get_tv_number(tv);
19115 if (STRCMP(varname, "searchforward") == 0)
19116 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19118 return;
19121 clear_tv(&v->di_tv);
19123 else /* add a new variable */
19125 /* Can't add "v:" variable. */
19126 if (ht == &vimvarht)
19128 EMSG2(_(e_illvar), name);
19129 return;
19132 /* Make sure the variable name is valid. */
19133 for (p = varname; *p != NUL; ++p)
19134 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19135 && *p != AUTOLOAD_CHAR)
19137 EMSG2(_(e_illvar), varname);
19138 return;
19141 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19142 + STRLEN(varname)));
19143 if (v == NULL)
19144 return;
19145 STRCPY(v->di_key, varname);
19146 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19148 vim_free(v);
19149 return;
19151 v->di_flags = 0;
19154 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19155 copy_tv(tv, &v->di_tv);
19156 else
19158 v->di_tv = *tv;
19159 v->di_tv.v_lock = 0;
19160 init_tv(tv);
19165 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19166 * Also give an error message.
19168 static int
19169 var_check_ro(flags, name)
19170 int flags;
19171 char_u *name;
19173 if (flags & DI_FLAGS_RO)
19175 EMSG2(_(e_readonlyvar), name);
19176 return TRUE;
19178 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19180 EMSG2(_(e_readonlysbx), name);
19181 return TRUE;
19183 return FALSE;
19187 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19188 * Also give an error message.
19190 static int
19191 var_check_fixed(flags, name)
19192 int flags;
19193 char_u *name;
19195 if (flags & DI_FLAGS_FIX)
19197 EMSG2(_("E795: Cannot delete variable %s"), name);
19198 return TRUE;
19200 return FALSE;
19204 * Return TRUE if typeval "tv" is set to be locked (immutable).
19205 * Also give an error message, using "name".
19207 static int
19208 tv_check_lock(lock, name)
19209 int lock;
19210 char_u *name;
19212 if (lock & VAR_LOCKED)
19214 EMSG2(_("E741: Value is locked: %s"),
19215 name == NULL ? (char_u *)_("Unknown") : name);
19216 return TRUE;
19218 if (lock & VAR_FIXED)
19220 EMSG2(_("E742: Cannot change value of %s"),
19221 name == NULL ? (char_u *)_("Unknown") : name);
19222 return TRUE;
19224 return FALSE;
19228 * Copy the values from typval_T "from" to typval_T "to".
19229 * When needed allocates string or increases reference count.
19230 * Does not make a copy of a list or dict but copies the reference!
19231 * It is OK for "from" and "to" to point to the same item. This is used to
19232 * make a copy later.
19234 static void
19235 copy_tv(from, to)
19236 typval_T *from;
19237 typval_T *to;
19239 to->v_type = from->v_type;
19240 to->v_lock = 0;
19241 switch (from->v_type)
19243 case VAR_NUMBER:
19244 to->vval.v_number = from->vval.v_number;
19245 break;
19246 #ifdef FEAT_FLOAT
19247 case VAR_FLOAT:
19248 to->vval.v_float = from->vval.v_float;
19249 break;
19250 #endif
19251 case VAR_STRING:
19252 case VAR_FUNC:
19253 if (from->vval.v_string == NULL)
19254 to->vval.v_string = NULL;
19255 else
19257 to->vval.v_string = vim_strsave(from->vval.v_string);
19258 if (from->v_type == VAR_FUNC)
19259 func_ref(to->vval.v_string);
19261 break;
19262 case VAR_LIST:
19263 if (from->vval.v_list == NULL)
19264 to->vval.v_list = NULL;
19265 else
19267 to->vval.v_list = from->vval.v_list;
19268 ++to->vval.v_list->lv_refcount;
19270 break;
19271 case VAR_DICT:
19272 if (from->vval.v_dict == NULL)
19273 to->vval.v_dict = NULL;
19274 else
19276 to->vval.v_dict = from->vval.v_dict;
19277 ++to->vval.v_dict->dv_refcount;
19279 break;
19280 default:
19281 EMSG2(_(e_intern2), "copy_tv()");
19282 break;
19287 * Make a copy of an item.
19288 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19289 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19290 * reference to an already copied list/dict can be used.
19291 * Returns FAIL or OK.
19293 static int
19294 item_copy(from, to, deep, copyID)
19295 typval_T *from;
19296 typval_T *to;
19297 int deep;
19298 int copyID;
19300 static int recurse = 0;
19301 int ret = OK;
19303 if (recurse >= DICT_MAXNEST)
19305 EMSG(_("E698: variable nested too deep for making a copy"));
19306 return FAIL;
19308 ++recurse;
19310 switch (from->v_type)
19312 case VAR_NUMBER:
19313 #ifdef FEAT_FLOAT
19314 case VAR_FLOAT:
19315 #endif
19316 case VAR_STRING:
19317 case VAR_FUNC:
19318 copy_tv(from, to);
19319 break;
19320 case VAR_LIST:
19321 to->v_type = VAR_LIST;
19322 to->v_lock = 0;
19323 if (from->vval.v_list == NULL)
19324 to->vval.v_list = NULL;
19325 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19327 /* use the copy made earlier */
19328 to->vval.v_list = from->vval.v_list->lv_copylist;
19329 ++to->vval.v_list->lv_refcount;
19331 else
19332 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19333 if (to->vval.v_list == NULL)
19334 ret = FAIL;
19335 break;
19336 case VAR_DICT:
19337 to->v_type = VAR_DICT;
19338 to->v_lock = 0;
19339 if (from->vval.v_dict == NULL)
19340 to->vval.v_dict = NULL;
19341 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19343 /* use the copy made earlier */
19344 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19345 ++to->vval.v_dict->dv_refcount;
19347 else
19348 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19349 if (to->vval.v_dict == NULL)
19350 ret = FAIL;
19351 break;
19352 default:
19353 EMSG2(_(e_intern2), "item_copy()");
19354 ret = FAIL;
19356 --recurse;
19357 return ret;
19361 * ":echo expr1 ..." print each argument separated with a space, add a
19362 * newline at the end.
19363 * ":echon expr1 ..." print each argument plain.
19365 void
19366 ex_echo(eap)
19367 exarg_T *eap;
19369 char_u *arg = eap->arg;
19370 typval_T rettv;
19371 char_u *tofree;
19372 char_u *p;
19373 int needclr = TRUE;
19374 int atstart = TRUE;
19375 char_u numbuf[NUMBUFLEN];
19377 if (eap->skip)
19378 ++emsg_skip;
19379 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19381 /* If eval1() causes an error message the text from the command may
19382 * still need to be cleared. E.g., "echo 22,44". */
19383 need_clr_eos = needclr;
19385 p = arg;
19386 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19389 * Report the invalid expression unless the expression evaluation
19390 * has been cancelled due to an aborting error, an interrupt, or an
19391 * exception.
19393 if (!aborting())
19394 EMSG2(_(e_invexpr2), p);
19395 need_clr_eos = FALSE;
19396 break;
19398 need_clr_eos = FALSE;
19400 if (!eap->skip)
19402 if (atstart)
19404 atstart = FALSE;
19405 /* Call msg_start() after eval1(), evaluating the expression
19406 * may cause a message to appear. */
19407 if (eap->cmdidx == CMD_echo)
19408 msg_start();
19410 else if (eap->cmdidx == CMD_echo)
19411 msg_puts_attr((char_u *)" ", echo_attr);
19412 current_copyID += COPYID_INC;
19413 p = echo_string(&rettv, &tofree, numbuf, current_copyID);
19414 if (p != NULL)
19415 for ( ; *p != NUL && !got_int; ++p)
19417 if (*p == '\n' || *p == '\r' || *p == TAB)
19419 if (*p != TAB && needclr)
19421 /* remove any text still there from the command */
19422 msg_clr_eos();
19423 needclr = FALSE;
19425 msg_putchar_attr(*p, echo_attr);
19427 else
19429 #ifdef FEAT_MBYTE
19430 if (has_mbyte)
19432 int i = (*mb_ptr2len)(p);
19434 (void)msg_outtrans_len_attr(p, i, echo_attr);
19435 p += i - 1;
19437 else
19438 #endif
19439 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19442 vim_free(tofree);
19444 clear_tv(&rettv);
19445 arg = skipwhite(arg);
19447 eap->nextcmd = check_nextcmd(arg);
19449 if (eap->skip)
19450 --emsg_skip;
19451 else
19453 /* remove text that may still be there from the command */
19454 if (needclr)
19455 msg_clr_eos();
19456 if (eap->cmdidx == CMD_echo)
19457 msg_end();
19462 * ":echohl {name}".
19464 void
19465 ex_echohl(eap)
19466 exarg_T *eap;
19468 int id;
19470 id = syn_name2id(eap->arg);
19471 if (id == 0)
19472 echo_attr = 0;
19473 else
19474 echo_attr = syn_id2attr(id);
19478 * ":execute expr1 ..." execute the result of an expression.
19479 * ":echomsg expr1 ..." Print a message
19480 * ":echoerr expr1 ..." Print an error
19481 * Each gets spaces around each argument and a newline at the end for
19482 * echo commands
19484 void
19485 ex_execute(eap)
19486 exarg_T *eap;
19488 char_u *arg = eap->arg;
19489 typval_T rettv;
19490 int ret = OK;
19491 char_u *p;
19492 garray_T ga;
19493 int len;
19494 int save_did_emsg;
19496 ga_init2(&ga, 1, 80);
19498 if (eap->skip)
19499 ++emsg_skip;
19500 while (*arg != NUL && *arg != '|' && *arg != '\n')
19502 p = arg;
19503 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19506 * Report the invalid expression unless the expression evaluation
19507 * has been cancelled due to an aborting error, an interrupt, or an
19508 * exception.
19510 if (!aborting())
19511 EMSG2(_(e_invexpr2), p);
19512 ret = FAIL;
19513 break;
19516 if (!eap->skip)
19518 p = get_tv_string(&rettv);
19519 len = (int)STRLEN(p);
19520 if (ga_grow(&ga, len + 2) == FAIL)
19522 clear_tv(&rettv);
19523 ret = FAIL;
19524 break;
19526 if (ga.ga_len)
19527 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19528 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19529 ga.ga_len += len;
19532 clear_tv(&rettv);
19533 arg = skipwhite(arg);
19536 if (ret != FAIL && ga.ga_data != NULL)
19538 if (eap->cmdidx == CMD_echomsg)
19540 MSG_ATTR(ga.ga_data, echo_attr);
19541 out_flush();
19543 else if (eap->cmdidx == CMD_echoerr)
19545 /* We don't want to abort following commands, restore did_emsg. */
19546 save_did_emsg = did_emsg;
19547 EMSG((char_u *)ga.ga_data);
19548 if (!force_abort)
19549 did_emsg = save_did_emsg;
19551 else if (eap->cmdidx == CMD_execute)
19552 do_cmdline((char_u *)ga.ga_data,
19553 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19556 ga_clear(&ga);
19558 if (eap->skip)
19559 --emsg_skip;
19561 eap->nextcmd = check_nextcmd(arg);
19565 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19566 * "arg" points to the "&" or '+' when called, to "option" when returning.
19567 * Returns NULL when no option name found. Otherwise pointer to the char
19568 * after the option name.
19570 static char_u *
19571 find_option_end(arg, opt_flags)
19572 char_u **arg;
19573 int *opt_flags;
19575 char_u *p = *arg;
19577 ++p;
19578 if (*p == 'g' && p[1] == ':')
19580 *opt_flags = OPT_GLOBAL;
19581 p += 2;
19583 else if (*p == 'l' && p[1] == ':')
19585 *opt_flags = OPT_LOCAL;
19586 p += 2;
19588 else
19589 *opt_flags = 0;
19591 if (!ASCII_ISALPHA(*p))
19592 return NULL;
19593 *arg = p;
19595 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19596 p += 4; /* termcap option */
19597 else
19598 while (ASCII_ISALPHA(*p))
19599 ++p;
19600 return p;
19604 * ":function"
19606 void
19607 ex_function(eap)
19608 exarg_T *eap;
19610 char_u *theline;
19611 int j;
19612 int c;
19613 int saved_did_emsg;
19614 char_u *name = NULL;
19615 char_u *p;
19616 char_u *arg;
19617 char_u *line_arg = NULL;
19618 garray_T newargs;
19619 garray_T newlines;
19620 int varargs = FALSE;
19621 int mustend = FALSE;
19622 int flags = 0;
19623 ufunc_T *fp;
19624 int indent;
19625 int nesting;
19626 char_u *skip_until = NULL;
19627 dictitem_T *v;
19628 funcdict_T fudi;
19629 static int func_nr = 0; /* number for nameless function */
19630 int paren;
19631 hashtab_T *ht;
19632 int todo;
19633 hashitem_T *hi;
19634 int sourcing_lnum_off;
19637 * ":function" without argument: list functions.
19639 if (ends_excmd(*eap->arg))
19641 if (!eap->skip)
19643 todo = (int)func_hashtab.ht_used;
19644 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19646 if (!HASHITEM_EMPTY(hi))
19648 --todo;
19649 fp = HI2UF(hi);
19650 if (!isdigit(*fp->uf_name))
19651 list_func_head(fp, FALSE);
19655 eap->nextcmd = check_nextcmd(eap->arg);
19656 return;
19660 * ":function /pat": list functions matching pattern.
19662 if (*eap->arg == '/')
19664 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19665 if (!eap->skip)
19667 regmatch_T regmatch;
19669 c = *p;
19670 *p = NUL;
19671 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19672 *p = c;
19673 if (regmatch.regprog != NULL)
19675 regmatch.rm_ic = p_ic;
19677 todo = (int)func_hashtab.ht_used;
19678 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19680 if (!HASHITEM_EMPTY(hi))
19682 --todo;
19683 fp = HI2UF(hi);
19684 if (!isdigit(*fp->uf_name)
19685 && vim_regexec(&regmatch, fp->uf_name, 0))
19686 list_func_head(fp, FALSE);
19689 vim_free(regmatch.regprog);
19692 if (*p == '/')
19693 ++p;
19694 eap->nextcmd = check_nextcmd(p);
19695 return;
19699 * Get the function name. There are these situations:
19700 * func normal function name
19701 * "name" == func, "fudi.fd_dict" == NULL
19702 * dict.func new dictionary entry
19703 * "name" == NULL, "fudi.fd_dict" set,
19704 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19705 * dict.func existing dict entry with a Funcref
19706 * "name" == func, "fudi.fd_dict" set,
19707 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19708 * dict.func existing dict entry that's not a Funcref
19709 * "name" == NULL, "fudi.fd_dict" set,
19710 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19712 p = eap->arg;
19713 name = trans_function_name(&p, eap->skip, 0, &fudi);
19714 paren = (vim_strchr(p, '(') != NULL);
19715 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19718 * Return on an invalid expression in braces, unless the expression
19719 * evaluation has been cancelled due to an aborting error, an
19720 * interrupt, or an exception.
19722 if (!aborting())
19724 if (!eap->skip && fudi.fd_newkey != NULL)
19725 EMSG2(_(e_dictkey), fudi.fd_newkey);
19726 vim_free(fudi.fd_newkey);
19727 return;
19729 else
19730 eap->skip = TRUE;
19733 /* An error in a function call during evaluation of an expression in magic
19734 * braces should not cause the function not to be defined. */
19735 saved_did_emsg = did_emsg;
19736 did_emsg = FALSE;
19739 * ":function func" with only function name: list function.
19741 if (!paren)
19743 if (!ends_excmd(*skipwhite(p)))
19745 EMSG(_(e_trailing));
19746 goto ret_free;
19748 eap->nextcmd = check_nextcmd(p);
19749 if (eap->nextcmd != NULL)
19750 *p = NUL;
19751 if (!eap->skip && !got_int)
19753 fp = find_func(name);
19754 if (fp != NULL)
19756 list_func_head(fp, TRUE);
19757 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19759 if (FUNCLINE(fp, j) == NULL)
19760 continue;
19761 msg_putchar('\n');
19762 msg_outnum((long)(j + 1));
19763 if (j < 9)
19764 msg_putchar(' ');
19765 if (j < 99)
19766 msg_putchar(' ');
19767 msg_prt_line(FUNCLINE(fp, j), FALSE);
19768 out_flush(); /* show a line at a time */
19769 ui_breakcheck();
19771 if (!got_int)
19773 msg_putchar('\n');
19774 msg_puts((char_u *)" endfunction");
19777 else
19778 emsg_funcname(N_("E123: Undefined function: %s"), name);
19780 goto ret_free;
19784 * ":function name(arg1, arg2)" Define function.
19786 p = skipwhite(p);
19787 if (*p != '(')
19789 if (!eap->skip)
19791 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19792 goto ret_free;
19794 /* attempt to continue by skipping some text */
19795 if (vim_strchr(p, '(') != NULL)
19796 p = vim_strchr(p, '(');
19798 p = skipwhite(p + 1);
19800 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19801 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19803 if (!eap->skip)
19805 /* Check the name of the function. Unless it's a dictionary function
19806 * (that we are overwriting). */
19807 if (name != NULL)
19808 arg = name;
19809 else
19810 arg = fudi.fd_newkey;
19811 if (arg != NULL && (fudi.fd_di == NULL
19812 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19814 if (*arg == K_SPECIAL)
19815 j = 3;
19816 else
19817 j = 0;
19818 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19819 : eval_isnamec(arg[j])))
19820 ++j;
19821 if (arg[j] != NUL)
19822 emsg_funcname((char *)e_invarg2, arg);
19827 * Isolate the arguments: "arg1, arg2, ...)"
19829 while (*p != ')')
19831 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19833 varargs = TRUE;
19834 p += 3;
19835 mustend = TRUE;
19837 else
19839 arg = p;
19840 while (ASCII_ISALNUM(*p) || *p == '_')
19841 ++p;
19842 if (arg == p || isdigit(*arg)
19843 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19844 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19846 if (!eap->skip)
19847 EMSG2(_("E125: Illegal argument: %s"), arg);
19848 break;
19850 if (ga_grow(&newargs, 1) == FAIL)
19851 goto erret;
19852 c = *p;
19853 *p = NUL;
19854 arg = vim_strsave(arg);
19855 if (arg == NULL)
19856 goto erret;
19857 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19858 *p = c;
19859 newargs.ga_len++;
19860 if (*p == ',')
19861 ++p;
19862 else
19863 mustend = TRUE;
19865 p = skipwhite(p);
19866 if (mustend && *p != ')')
19868 if (!eap->skip)
19869 EMSG2(_(e_invarg2), eap->arg);
19870 break;
19873 ++p; /* skip the ')' */
19875 /* find extra arguments "range", "dict" and "abort" */
19876 for (;;)
19878 p = skipwhite(p);
19879 if (STRNCMP(p, "range", 5) == 0)
19881 flags |= FC_RANGE;
19882 p += 5;
19884 else if (STRNCMP(p, "dict", 4) == 0)
19886 flags |= FC_DICT;
19887 p += 4;
19889 else if (STRNCMP(p, "abort", 5) == 0)
19891 flags |= FC_ABORT;
19892 p += 5;
19894 else
19895 break;
19898 /* When there is a line break use what follows for the function body.
19899 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19900 if (*p == '\n')
19901 line_arg = p + 1;
19902 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19903 EMSG(_(e_trailing));
19906 * Read the body of the function, until ":endfunction" is found.
19908 if (KeyTyped)
19910 /* Check if the function already exists, don't let the user type the
19911 * whole function before telling him it doesn't work! For a script we
19912 * need to skip the body to be able to find what follows. */
19913 if (!eap->skip && !eap->forceit)
19915 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19916 EMSG(_(e_funcdict));
19917 else if (name != NULL && find_func(name) != NULL)
19918 emsg_funcname(e_funcexts, name);
19921 if (!eap->skip && did_emsg)
19922 goto erret;
19924 msg_putchar('\n'); /* don't overwrite the function name */
19925 cmdline_row = msg_row;
19928 indent = 2;
19929 nesting = 0;
19930 for (;;)
19932 msg_scroll = TRUE;
19933 need_wait_return = FALSE;
19934 sourcing_lnum_off = sourcing_lnum;
19936 if (line_arg != NULL)
19938 /* Use eap->arg, split up in parts by line breaks. */
19939 theline = line_arg;
19940 p = vim_strchr(theline, '\n');
19941 if (p == NULL)
19942 line_arg += STRLEN(line_arg);
19943 else
19945 *p = NUL;
19946 line_arg = p + 1;
19949 else if (eap->getline == NULL)
19950 theline = getcmdline(':', 0L, indent);
19951 else
19952 theline = eap->getline(':', eap->cookie, indent);
19953 if (KeyTyped)
19954 lines_left = Rows - 1;
19955 if (theline == NULL)
19957 EMSG(_("E126: Missing :endfunction"));
19958 goto erret;
19961 /* Detect line continuation: sourcing_lnum increased more than one. */
19962 if (sourcing_lnum > sourcing_lnum_off + 1)
19963 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
19964 else
19965 sourcing_lnum_off = 0;
19967 if (skip_until != NULL)
19969 /* between ":append" and "." and between ":python <<EOF" and "EOF"
19970 * don't check for ":endfunc". */
19971 if (STRCMP(theline, skip_until) == 0)
19973 vim_free(skip_until);
19974 skip_until = NULL;
19977 else
19979 /* skip ':' and blanks*/
19980 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
19983 /* Check for "endfunction". */
19984 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
19986 if (line_arg == NULL)
19987 vim_free(theline);
19988 break;
19991 /* Increase indent inside "if", "while", "for" and "try", decrease
19992 * at "end". */
19993 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
19994 indent -= 2;
19995 else if (STRNCMP(p, "if", 2) == 0
19996 || STRNCMP(p, "wh", 2) == 0
19997 || STRNCMP(p, "for", 3) == 0
19998 || STRNCMP(p, "try", 3) == 0)
19999 indent += 2;
20001 /* Check for defining a function inside this function. */
20002 if (checkforcmd(&p, "function", 2))
20004 if (*p == '!')
20005 p = skipwhite(p + 1);
20006 p += eval_fname_script(p);
20007 if (ASCII_ISALPHA(*p))
20009 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20010 if (*skipwhite(p) == '(')
20012 ++nesting;
20013 indent += 2;
20018 /* Check for ":append" or ":insert". */
20019 p = skip_range(p, NULL);
20020 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20021 || (p[0] == 'i'
20022 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20023 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20024 skip_until = vim_strsave((char_u *)".");
20026 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20027 arg = skipwhite(skiptowhite(p));
20028 if (arg[0] == '<' && arg[1] =='<'
20029 && ((p[0] == 'p' && p[1] == 'y'
20030 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20031 || (p[0] == 'p' && p[1] == 'e'
20032 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20033 || (p[0] == 't' && p[1] == 'c'
20034 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20035 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20036 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20037 || (p[0] == 'm' && p[1] == 'z'
20038 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20041 /* ":python <<" continues until a dot, like ":append" */
20042 p = skipwhite(arg + 2);
20043 if (*p == NUL)
20044 skip_until = vim_strsave((char_u *)".");
20045 else
20046 skip_until = vim_strsave(p);
20050 /* Add the line to the function. */
20051 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20053 if (line_arg == NULL)
20054 vim_free(theline);
20055 goto erret;
20058 /* Copy the line to newly allocated memory. get_one_sourceline()
20059 * allocates 250 bytes per line, this saves 80% on average. The cost
20060 * is an extra alloc/free. */
20061 p = vim_strsave(theline);
20062 if (p != NULL)
20064 if (line_arg == NULL)
20065 vim_free(theline);
20066 theline = p;
20069 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20071 /* Add NULL lines for continuation lines, so that the line count is
20072 * equal to the index in the growarray. */
20073 while (sourcing_lnum_off-- > 0)
20074 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20076 /* Check for end of eap->arg. */
20077 if (line_arg != NULL && *line_arg == NUL)
20078 line_arg = NULL;
20081 /* Don't define the function when skipping commands or when an error was
20082 * detected. */
20083 if (eap->skip || did_emsg)
20084 goto erret;
20087 * If there are no errors, add the function
20089 if (fudi.fd_dict == NULL)
20091 v = find_var(name, &ht);
20092 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20094 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
20095 name);
20096 goto erret;
20099 fp = find_func(name);
20100 if (fp != NULL)
20102 if (!eap->forceit)
20104 emsg_funcname(e_funcexts, name);
20105 goto erret;
20107 if (fp->uf_calls > 0)
20109 emsg_funcname(N_("E127: Cannot redefine function %s: It is in use"),
20110 name);
20111 goto erret;
20113 /* redefine existing function */
20114 ga_clear_strings(&(fp->uf_args));
20115 ga_clear_strings(&(fp->uf_lines));
20116 vim_free(name);
20117 name = NULL;
20120 else
20122 char numbuf[20];
20124 fp = NULL;
20125 if (fudi.fd_newkey == NULL && !eap->forceit)
20127 EMSG(_(e_funcdict));
20128 goto erret;
20130 if (fudi.fd_di == NULL)
20132 /* Can't add a function to a locked dictionary */
20133 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20134 goto erret;
20136 /* Can't change an existing function if it is locked */
20137 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20138 goto erret;
20140 /* Give the function a sequential number. Can only be used with a
20141 * Funcref! */
20142 vim_free(name);
20143 sprintf(numbuf, "%d", ++func_nr);
20144 name = vim_strsave((char_u *)numbuf);
20145 if (name == NULL)
20146 goto erret;
20149 if (fp == NULL)
20151 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20153 int slen, plen;
20154 char_u *scriptname;
20156 /* Check that the autoload name matches the script name. */
20157 j = FAIL;
20158 if (sourcing_name != NULL)
20160 scriptname = autoload_name(name);
20161 if (scriptname != NULL)
20163 p = vim_strchr(scriptname, '/');
20164 plen = (int)STRLEN(p);
20165 slen = (int)STRLEN(sourcing_name);
20166 if (slen > plen && fnamecmp(p,
20167 sourcing_name + slen - plen) == 0)
20168 j = OK;
20169 vim_free(scriptname);
20172 if (j == FAIL)
20174 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20175 goto erret;
20179 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20180 if (fp == NULL)
20181 goto erret;
20183 if (fudi.fd_dict != NULL)
20185 if (fudi.fd_di == NULL)
20187 /* add new dict entry */
20188 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20189 if (fudi.fd_di == NULL)
20191 vim_free(fp);
20192 goto erret;
20194 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20196 vim_free(fudi.fd_di);
20197 vim_free(fp);
20198 goto erret;
20201 else
20202 /* overwrite existing dict entry */
20203 clear_tv(&fudi.fd_di->di_tv);
20204 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20205 fudi.fd_di->di_tv.v_lock = 0;
20206 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20207 fp->uf_refcount = 1;
20209 /* behave like "dict" was used */
20210 flags |= FC_DICT;
20213 /* insert the new function in the function list */
20214 STRCPY(fp->uf_name, name);
20215 hash_add(&func_hashtab, UF2HIKEY(fp));
20217 fp->uf_args = newargs;
20218 fp->uf_lines = newlines;
20219 #ifdef FEAT_PROFILE
20220 fp->uf_tml_count = NULL;
20221 fp->uf_tml_total = NULL;
20222 fp->uf_tml_self = NULL;
20223 fp->uf_profiling = FALSE;
20224 if (prof_def_func())
20225 func_do_profile(fp);
20226 #endif
20227 fp->uf_varargs = varargs;
20228 fp->uf_flags = flags;
20229 fp->uf_calls = 0;
20230 fp->uf_script_ID = current_SID;
20231 goto ret_free;
20233 erret:
20234 ga_clear_strings(&newargs);
20235 ga_clear_strings(&newlines);
20236 ret_free:
20237 vim_free(skip_until);
20238 vim_free(fudi.fd_newkey);
20239 vim_free(name);
20240 did_emsg |= saved_did_emsg;
20244 * Get a function name, translating "<SID>" and "<SNR>".
20245 * Also handles a Funcref in a List or Dictionary.
20246 * Returns the function name in allocated memory, or NULL for failure.
20247 * flags:
20248 * TFN_INT: internal function name OK
20249 * TFN_QUIET: be quiet
20250 * Advances "pp" to just after the function name (if no error).
20252 static char_u *
20253 trans_function_name(pp, skip, flags, fdp)
20254 char_u **pp;
20255 int skip; /* only find the end, don't evaluate */
20256 int flags;
20257 funcdict_T *fdp; /* return: info about dictionary used */
20259 char_u *name = NULL;
20260 char_u *start;
20261 char_u *end;
20262 int lead;
20263 char_u sid_buf[20];
20264 int len;
20265 lval_T lv;
20267 if (fdp != NULL)
20268 vim_memset(fdp, 0, sizeof(funcdict_T));
20269 start = *pp;
20271 /* Check for hard coded <SNR>: already translated function ID (from a user
20272 * command). */
20273 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20274 && (*pp)[2] == (int)KE_SNR)
20276 *pp += 3;
20277 len = get_id_len(pp) + 3;
20278 return vim_strnsave(start, len);
20281 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20282 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20283 lead = eval_fname_script(start);
20284 if (lead > 2)
20285 start += lead;
20287 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20288 lead > 2 ? 0 : FNE_CHECK_START);
20289 if (end == start)
20291 if (!skip)
20292 EMSG(_("E129: Function name required"));
20293 goto theend;
20295 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20298 * Report an invalid expression in braces, unless the expression
20299 * evaluation has been cancelled due to an aborting error, an
20300 * interrupt, or an exception.
20302 if (!aborting())
20304 if (end != NULL)
20305 EMSG2(_(e_invarg2), start);
20307 else
20308 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20309 goto theend;
20312 if (lv.ll_tv != NULL)
20314 if (fdp != NULL)
20316 fdp->fd_dict = lv.ll_dict;
20317 fdp->fd_newkey = lv.ll_newkey;
20318 lv.ll_newkey = NULL;
20319 fdp->fd_di = lv.ll_di;
20321 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20323 name = vim_strsave(lv.ll_tv->vval.v_string);
20324 *pp = end;
20326 else
20328 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20329 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20330 EMSG(_(e_funcref));
20331 else
20332 *pp = end;
20333 name = NULL;
20335 goto theend;
20338 if (lv.ll_name == NULL)
20340 /* Error found, but continue after the function name. */
20341 *pp = end;
20342 goto theend;
20345 /* Check if the name is a Funcref. If so, use the value. */
20346 if (lv.ll_exp_name != NULL)
20348 len = (int)STRLEN(lv.ll_exp_name);
20349 name = deref_func_name(lv.ll_exp_name, &len);
20350 if (name == lv.ll_exp_name)
20351 name = NULL;
20353 else
20355 len = (int)(end - *pp);
20356 name = deref_func_name(*pp, &len);
20357 if (name == *pp)
20358 name = NULL;
20360 if (name != NULL)
20362 name = vim_strsave(name);
20363 *pp = end;
20364 goto theend;
20367 if (lv.ll_exp_name != NULL)
20369 len = (int)STRLEN(lv.ll_exp_name);
20370 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20371 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20373 /* When there was "s:" already or the name expanded to get a
20374 * leading "s:" then remove it. */
20375 lv.ll_name += 2;
20376 len -= 2;
20377 lead = 2;
20380 else
20382 if (lead == 2) /* skip over "s:" */
20383 lv.ll_name += 2;
20384 len = (int)(end - lv.ll_name);
20388 * Copy the function name to allocated memory.
20389 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20390 * Accept <SNR>123_name() outside a script.
20392 if (skip)
20393 lead = 0; /* do nothing */
20394 else if (lead > 0)
20396 lead = 3;
20397 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20398 || eval_fname_sid(*pp))
20400 /* It's "s:" or "<SID>" */
20401 if (current_SID <= 0)
20403 EMSG(_(e_usingsid));
20404 goto theend;
20406 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20407 lead += (int)STRLEN(sid_buf);
20410 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20412 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20413 goto theend;
20415 name = alloc((unsigned)(len + lead + 1));
20416 if (name != NULL)
20418 if (lead > 0)
20420 name[0] = K_SPECIAL;
20421 name[1] = KS_EXTRA;
20422 name[2] = (int)KE_SNR;
20423 if (lead > 3) /* If it's "<SID>" */
20424 STRCPY(name + 3, sid_buf);
20426 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20427 name[len + lead] = NUL;
20429 *pp = end;
20431 theend:
20432 clear_lval(&lv);
20433 return name;
20437 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20438 * Return 2 if "p" starts with "s:".
20439 * Return 0 otherwise.
20441 static int
20442 eval_fname_script(p)
20443 char_u *p;
20445 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20446 || STRNICMP(p + 1, "SNR>", 4) == 0))
20447 return 5;
20448 if (p[0] == 's' && p[1] == ':')
20449 return 2;
20450 return 0;
20454 * Return TRUE if "p" starts with "<SID>" or "s:".
20455 * Only works if eval_fname_script() returned non-zero for "p"!
20457 static int
20458 eval_fname_sid(p)
20459 char_u *p;
20461 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20465 * List the head of the function: "name(arg1, arg2)".
20467 static void
20468 list_func_head(fp, indent)
20469 ufunc_T *fp;
20470 int indent;
20472 int j;
20474 msg_start();
20475 if (indent)
20476 MSG_PUTS(" ");
20477 MSG_PUTS("function ");
20478 if (fp->uf_name[0] == K_SPECIAL)
20480 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20481 msg_puts(fp->uf_name + 3);
20483 else
20484 msg_puts(fp->uf_name);
20485 msg_putchar('(');
20486 for (j = 0; j < fp->uf_args.ga_len; ++j)
20488 if (j)
20489 MSG_PUTS(", ");
20490 msg_puts(FUNCARG(fp, j));
20492 if (fp->uf_varargs)
20494 if (j)
20495 MSG_PUTS(", ");
20496 MSG_PUTS("...");
20498 msg_putchar(')');
20499 msg_clr_eos();
20500 if (p_verbose > 0)
20501 last_set_msg(fp->uf_script_ID);
20505 * Find a function by name, return pointer to it in ufuncs.
20506 * Return NULL for unknown function.
20508 static ufunc_T *
20509 find_func(name)
20510 char_u *name;
20512 hashitem_T *hi;
20514 hi = hash_find(&func_hashtab, name);
20515 if (!HASHITEM_EMPTY(hi))
20516 return HI2UF(hi);
20517 return NULL;
20520 #if defined(EXITFREE) || defined(PROTO)
20521 void
20522 free_all_functions()
20524 hashitem_T *hi;
20526 /* Need to start all over every time, because func_free() may change the
20527 * hash table. */
20528 while (func_hashtab.ht_used > 0)
20529 for (hi = func_hashtab.ht_array; ; ++hi)
20530 if (!HASHITEM_EMPTY(hi))
20532 func_free(HI2UF(hi));
20533 break;
20536 #endif
20539 * Return TRUE if a function "name" exists.
20541 static int
20542 function_exists(name)
20543 char_u *name;
20545 char_u *nm = name;
20546 char_u *p;
20547 int n = FALSE;
20549 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20550 nm = skipwhite(nm);
20552 /* Only accept "funcname", "funcname ", "funcname (..." and
20553 * "funcname(...", not "funcname!...". */
20554 if (p != NULL && (*nm == NUL || *nm == '('))
20556 if (builtin_function(p))
20557 n = (find_internal_func(p) >= 0);
20558 else
20559 n = (find_func(p) != NULL);
20561 vim_free(p);
20562 return n;
20566 * Return TRUE if "name" looks like a builtin function name: starts with a
20567 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20569 static int
20570 builtin_function(name)
20571 char_u *name;
20573 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20574 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20577 #if defined(FEAT_PROFILE) || defined(PROTO)
20579 * Start profiling function "fp".
20581 static void
20582 func_do_profile(fp)
20583 ufunc_T *fp;
20585 fp->uf_tm_count = 0;
20586 profile_zero(&fp->uf_tm_self);
20587 profile_zero(&fp->uf_tm_total);
20588 if (fp->uf_tml_count == NULL)
20589 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20590 (sizeof(int) * fp->uf_lines.ga_len));
20591 if (fp->uf_tml_total == NULL)
20592 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20593 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20594 if (fp->uf_tml_self == NULL)
20595 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20596 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20597 fp->uf_tml_idx = -1;
20598 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20599 || fp->uf_tml_self == NULL)
20600 return; /* out of memory */
20602 fp->uf_profiling = TRUE;
20606 * Dump the profiling results for all functions in file "fd".
20608 void
20609 func_dump_profile(fd)
20610 FILE *fd;
20612 hashitem_T *hi;
20613 int todo;
20614 ufunc_T *fp;
20615 int i;
20616 ufunc_T **sorttab;
20617 int st_len = 0;
20619 todo = (int)func_hashtab.ht_used;
20620 if (todo == 0)
20621 return; /* nothing to dump */
20623 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20625 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20627 if (!HASHITEM_EMPTY(hi))
20629 --todo;
20630 fp = HI2UF(hi);
20631 if (fp->uf_profiling)
20633 if (sorttab != NULL)
20634 sorttab[st_len++] = fp;
20636 if (fp->uf_name[0] == K_SPECIAL)
20637 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20638 else
20639 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20640 if (fp->uf_tm_count == 1)
20641 fprintf(fd, "Called 1 time\n");
20642 else
20643 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20644 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20645 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20646 fprintf(fd, "\n");
20647 fprintf(fd, "count total (s) self (s)\n");
20649 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20651 if (FUNCLINE(fp, i) == NULL)
20652 continue;
20653 prof_func_line(fd, fp->uf_tml_count[i],
20654 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20655 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20657 fprintf(fd, "\n");
20662 if (sorttab != NULL && st_len > 0)
20664 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20665 prof_total_cmp);
20666 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20667 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20668 prof_self_cmp);
20669 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20672 vim_free(sorttab);
20675 static void
20676 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20677 FILE *fd;
20678 ufunc_T **sorttab;
20679 int st_len;
20680 char *title;
20681 int prefer_self; /* when equal print only self time */
20683 int i;
20684 ufunc_T *fp;
20686 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20687 fprintf(fd, "count total (s) self (s) function\n");
20688 for (i = 0; i < 20 && i < st_len; ++i)
20690 fp = sorttab[i];
20691 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20692 prefer_self);
20693 if (fp->uf_name[0] == K_SPECIAL)
20694 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20695 else
20696 fprintf(fd, " %s()\n", fp->uf_name);
20698 fprintf(fd, "\n");
20702 * Print the count and times for one function or function line.
20704 static void
20705 prof_func_line(fd, count, total, self, prefer_self)
20706 FILE *fd;
20707 int count;
20708 proftime_T *total;
20709 proftime_T *self;
20710 int prefer_self; /* when equal print only self time */
20712 if (count > 0)
20714 fprintf(fd, "%5d ", count);
20715 if (prefer_self && profile_equal(total, self))
20716 fprintf(fd, " ");
20717 else
20718 fprintf(fd, "%s ", profile_msg(total));
20719 if (!prefer_self && profile_equal(total, self))
20720 fprintf(fd, " ");
20721 else
20722 fprintf(fd, "%s ", profile_msg(self));
20724 else
20725 fprintf(fd, " ");
20729 * Compare function for total time sorting.
20731 static int
20732 #ifdef __BORLANDC__
20733 _RTLENTRYF
20734 #endif
20735 prof_total_cmp(s1, s2)
20736 const void *s1;
20737 const void *s2;
20739 ufunc_T *p1, *p2;
20741 p1 = *(ufunc_T **)s1;
20742 p2 = *(ufunc_T **)s2;
20743 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20747 * Compare function for self time sorting.
20749 static int
20750 #ifdef __BORLANDC__
20751 _RTLENTRYF
20752 #endif
20753 prof_self_cmp(s1, s2)
20754 const void *s1;
20755 const void *s2;
20757 ufunc_T *p1, *p2;
20759 p1 = *(ufunc_T **)s1;
20760 p2 = *(ufunc_T **)s2;
20761 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20764 #endif
20767 * If "name" has a package name try autoloading the script for it.
20768 * Return TRUE if a package was loaded.
20770 static int
20771 script_autoload(name, reload)
20772 char_u *name;
20773 int reload; /* load script again when already loaded */
20775 char_u *p;
20776 char_u *scriptname, *tofree;
20777 int ret = FALSE;
20778 int i;
20780 /* If there is no '#' after name[0] there is no package name. */
20781 p = vim_strchr(name, AUTOLOAD_CHAR);
20782 if (p == NULL || p == name)
20783 return FALSE;
20785 tofree = scriptname = autoload_name(name);
20787 /* Find the name in the list of previously loaded package names. Skip
20788 * "autoload/", it's always the same. */
20789 for (i = 0; i < ga_loaded.ga_len; ++i)
20790 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20791 break;
20792 if (!reload && i < ga_loaded.ga_len)
20793 ret = FALSE; /* was loaded already */
20794 else
20796 /* Remember the name if it wasn't loaded already. */
20797 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20799 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20800 tofree = NULL;
20803 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20804 if (source_runtime(scriptname, FALSE) == OK)
20805 ret = TRUE;
20808 vim_free(tofree);
20809 return ret;
20813 * Return the autoload script name for a function or variable name.
20814 * Returns NULL when out of memory.
20816 static char_u *
20817 autoload_name(name)
20818 char_u *name;
20820 char_u *p;
20821 char_u *scriptname;
20823 /* Get the script file name: replace '#' with '/', append ".vim". */
20824 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20825 if (scriptname == NULL)
20826 return FALSE;
20827 STRCPY(scriptname, "autoload/");
20828 STRCAT(scriptname, name);
20829 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20830 STRCAT(scriptname, ".vim");
20831 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20832 *p = '/';
20833 return scriptname;
20836 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20839 * Function given to ExpandGeneric() to obtain the list of user defined
20840 * function names.
20842 char_u *
20843 get_user_func_name(xp, idx)
20844 expand_T *xp;
20845 int idx;
20847 static long_u done;
20848 static hashitem_T *hi;
20849 ufunc_T *fp;
20851 if (idx == 0)
20853 done = 0;
20854 hi = func_hashtab.ht_array;
20856 if (done < func_hashtab.ht_used)
20858 if (done++ > 0)
20859 ++hi;
20860 while (HASHITEM_EMPTY(hi))
20861 ++hi;
20862 fp = HI2UF(hi);
20864 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20865 return fp->uf_name; /* prevents overflow */
20867 cat_func_name(IObuff, fp);
20868 if (xp->xp_context != EXPAND_USER_FUNC)
20870 STRCAT(IObuff, "(");
20871 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20872 STRCAT(IObuff, ")");
20874 return IObuff;
20876 return NULL;
20879 #endif /* FEAT_CMDL_COMPL */
20882 * Copy the function name of "fp" to buffer "buf".
20883 * "buf" must be able to hold the function name plus three bytes.
20884 * Takes care of script-local function names.
20886 static void
20887 cat_func_name(buf, fp)
20888 char_u *buf;
20889 ufunc_T *fp;
20891 if (fp->uf_name[0] == K_SPECIAL)
20893 STRCPY(buf, "<SNR>");
20894 STRCAT(buf, fp->uf_name + 3);
20896 else
20897 STRCPY(buf, fp->uf_name);
20901 * ":delfunction {name}"
20903 void
20904 ex_delfunction(eap)
20905 exarg_T *eap;
20907 ufunc_T *fp = NULL;
20908 char_u *p;
20909 char_u *name;
20910 funcdict_T fudi;
20912 p = eap->arg;
20913 name = trans_function_name(&p, eap->skip, 0, &fudi);
20914 vim_free(fudi.fd_newkey);
20915 if (name == NULL)
20917 if (fudi.fd_dict != NULL && !eap->skip)
20918 EMSG(_(e_funcref));
20919 return;
20921 if (!ends_excmd(*skipwhite(p)))
20923 vim_free(name);
20924 EMSG(_(e_trailing));
20925 return;
20927 eap->nextcmd = check_nextcmd(p);
20928 if (eap->nextcmd != NULL)
20929 *p = NUL;
20931 if (!eap->skip)
20932 fp = find_func(name);
20933 vim_free(name);
20935 if (!eap->skip)
20937 if (fp == NULL)
20939 EMSG2(_(e_nofunc), eap->arg);
20940 return;
20942 if (fp->uf_calls > 0)
20944 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
20945 return;
20948 if (fudi.fd_dict != NULL)
20950 /* Delete the dict item that refers to the function, it will
20951 * invoke func_unref() and possibly delete the function. */
20952 dictitem_remove(fudi.fd_dict, fudi.fd_di);
20954 else
20955 func_free(fp);
20960 * Free a function and remove it from the list of functions.
20962 static void
20963 func_free(fp)
20964 ufunc_T *fp;
20966 hashitem_T *hi;
20968 /* clear this function */
20969 ga_clear_strings(&(fp->uf_args));
20970 ga_clear_strings(&(fp->uf_lines));
20971 #ifdef FEAT_PROFILE
20972 vim_free(fp->uf_tml_count);
20973 vim_free(fp->uf_tml_total);
20974 vim_free(fp->uf_tml_self);
20975 #endif
20977 /* remove the function from the function hashtable */
20978 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
20979 if (HASHITEM_EMPTY(hi))
20980 EMSG2(_(e_intern2), "func_free()");
20981 else
20982 hash_remove(&func_hashtab, hi);
20984 vim_free(fp);
20988 * Unreference a Function: decrement the reference count and free it when it
20989 * becomes zero. Only for numbered functions.
20991 static void
20992 func_unref(name)
20993 char_u *name;
20995 ufunc_T *fp;
20997 if (name != NULL && isdigit(*name))
20999 fp = find_func(name);
21000 if (fp == NULL)
21001 EMSG2(_(e_intern2), "func_unref()");
21002 else if (--fp->uf_refcount <= 0)
21004 /* Only delete it when it's not being used. Otherwise it's done
21005 * when "uf_calls" becomes zero. */
21006 if (fp->uf_calls == 0)
21007 func_free(fp);
21013 * Count a reference to a Function.
21015 static void
21016 func_ref(name)
21017 char_u *name;
21019 ufunc_T *fp;
21021 if (name != NULL && isdigit(*name))
21023 fp = find_func(name);
21024 if (fp == NULL)
21025 EMSG2(_(e_intern2), "func_ref()");
21026 else
21027 ++fp->uf_refcount;
21032 * Call a user function.
21034 static void
21035 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21036 ufunc_T *fp; /* pointer to function */
21037 int argcount; /* nr of args */
21038 typval_T *argvars; /* arguments */
21039 typval_T *rettv; /* return value */
21040 linenr_T firstline; /* first line of range */
21041 linenr_T lastline; /* last line of range */
21042 dict_T *selfdict; /* Dictionary for "self" */
21044 char_u *save_sourcing_name;
21045 linenr_T save_sourcing_lnum;
21046 scid_T save_current_SID;
21047 funccall_T *fc;
21048 int save_did_emsg;
21049 static int depth = 0;
21050 dictitem_T *v;
21051 int fixvar_idx = 0; /* index in fixvar[] */
21052 int i;
21053 int ai;
21054 char_u numbuf[NUMBUFLEN];
21055 char_u *name;
21056 #ifdef FEAT_PROFILE
21057 proftime_T wait_start;
21058 proftime_T call_start;
21059 #endif
21061 /* If depth of calling is getting too high, don't execute the function */
21062 if (depth >= p_mfd)
21064 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21065 rettv->v_type = VAR_NUMBER;
21066 rettv->vval.v_number = -1;
21067 return;
21069 ++depth;
21071 line_breakcheck(); /* check for CTRL-C hit */
21073 fc = (funccall_T *)alloc(sizeof(funccall_T));
21074 fc->caller = current_funccal;
21075 current_funccal = fc;
21076 fc->func = fp;
21077 fc->rettv = rettv;
21078 rettv->vval.v_number = 0;
21079 fc->linenr = 0;
21080 fc->returned = FALSE;
21081 fc->level = ex_nesting_level;
21082 /* Check if this function has a breakpoint. */
21083 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21084 fc->dbg_tick = debug_tick;
21087 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21088 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21089 * each argument variable and saves a lot of time.
21092 * Init l: variables.
21094 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21095 if (selfdict != NULL)
21097 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21098 * some compiler that checks the destination size. */
21099 v = &fc->fixvar[fixvar_idx++].var;
21100 name = v->di_key;
21101 STRCPY(name, "self");
21102 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21103 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21104 v->di_tv.v_type = VAR_DICT;
21105 v->di_tv.v_lock = 0;
21106 v->di_tv.vval.v_dict = selfdict;
21107 ++selfdict->dv_refcount;
21111 * Init a: variables.
21112 * Set a:0 to "argcount".
21113 * Set a:000 to a list with room for the "..." arguments.
21115 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21116 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21117 (varnumber_T)(argcount - fp->uf_args.ga_len));
21118 /* Use "name" to avoid a warning from some compiler that checks the
21119 * destination size. */
21120 v = &fc->fixvar[fixvar_idx++].var;
21121 name = v->di_key;
21122 STRCPY(name, "000");
21123 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21124 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21125 v->di_tv.v_type = VAR_LIST;
21126 v->di_tv.v_lock = VAR_FIXED;
21127 v->di_tv.vval.v_list = &fc->l_varlist;
21128 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21129 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21130 fc->l_varlist.lv_lock = VAR_FIXED;
21133 * Set a:firstline to "firstline" and a:lastline to "lastline".
21134 * Set a:name to named arguments.
21135 * Set a:N to the "..." arguments.
21137 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21138 (varnumber_T)firstline);
21139 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21140 (varnumber_T)lastline);
21141 for (i = 0; i < argcount; ++i)
21143 ai = i - fp->uf_args.ga_len;
21144 if (ai < 0)
21145 /* named argument a:name */
21146 name = FUNCARG(fp, i);
21147 else
21149 /* "..." argument a:1, a:2, etc. */
21150 sprintf((char *)numbuf, "%d", ai + 1);
21151 name = numbuf;
21153 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21155 v = &fc->fixvar[fixvar_idx++].var;
21156 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21158 else
21160 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21161 + STRLEN(name)));
21162 if (v == NULL)
21163 break;
21164 v->di_flags = DI_FLAGS_RO;
21166 STRCPY(v->di_key, name);
21167 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21169 /* Note: the values are copied directly to avoid alloc/free.
21170 * "argvars" must have VAR_FIXED for v_lock. */
21171 v->di_tv = argvars[i];
21172 v->di_tv.v_lock = VAR_FIXED;
21174 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21176 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21177 fc->l_listitems[ai].li_tv = argvars[i];
21178 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21182 /* Don't redraw while executing the function. */
21183 ++RedrawingDisabled;
21184 save_sourcing_name = sourcing_name;
21185 save_sourcing_lnum = sourcing_lnum;
21186 sourcing_lnum = 1;
21187 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21188 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21189 if (sourcing_name != NULL)
21191 if (save_sourcing_name != NULL
21192 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21193 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21194 else
21195 STRCPY(sourcing_name, "function ");
21196 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21198 if (p_verbose >= 12)
21200 ++no_wait_return;
21201 verbose_enter_scroll();
21203 smsg((char_u *)_("calling %s"), sourcing_name);
21204 if (p_verbose >= 14)
21206 char_u buf[MSG_BUF_LEN];
21207 char_u numbuf2[NUMBUFLEN];
21208 char_u *tofree;
21209 char_u *s;
21211 msg_puts((char_u *)"(");
21212 for (i = 0; i < argcount; ++i)
21214 if (i > 0)
21215 msg_puts((char_u *)", ");
21216 if (argvars[i].v_type == VAR_NUMBER)
21217 msg_outnum((long)argvars[i].vval.v_number);
21218 else
21220 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21221 if (s != NULL)
21223 trunc_string(s, buf, MSG_BUF_CLEN);
21224 msg_puts(buf);
21225 vim_free(tofree);
21229 msg_puts((char_u *)")");
21231 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21233 verbose_leave_scroll();
21234 --no_wait_return;
21237 #ifdef FEAT_PROFILE
21238 if (do_profiling == PROF_YES)
21240 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21241 func_do_profile(fp);
21242 if (fp->uf_profiling
21243 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21245 ++fp->uf_tm_count;
21246 profile_start(&call_start);
21247 profile_zero(&fp->uf_tm_children);
21249 script_prof_save(&wait_start);
21251 #endif
21253 save_current_SID = current_SID;
21254 current_SID = fp->uf_script_ID;
21255 save_did_emsg = did_emsg;
21256 did_emsg = FALSE;
21258 /* call do_cmdline() to execute the lines */
21259 do_cmdline(NULL, get_func_line, (void *)fc,
21260 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21262 --RedrawingDisabled;
21264 /* when the function was aborted because of an error, return -1 */
21265 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21267 clear_tv(rettv);
21268 rettv->v_type = VAR_NUMBER;
21269 rettv->vval.v_number = -1;
21272 #ifdef FEAT_PROFILE
21273 if (do_profiling == PROF_YES && (fp->uf_profiling
21274 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21276 profile_end(&call_start);
21277 profile_sub_wait(&wait_start, &call_start);
21278 profile_add(&fp->uf_tm_total, &call_start);
21279 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21280 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21282 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21283 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21286 #endif
21288 /* when being verbose, mention the return value */
21289 if (p_verbose >= 12)
21291 ++no_wait_return;
21292 verbose_enter_scroll();
21294 if (aborting())
21295 smsg((char_u *)_("%s aborted"), sourcing_name);
21296 else if (fc->rettv->v_type == VAR_NUMBER)
21297 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21298 (long)fc->rettv->vval.v_number);
21299 else
21301 char_u buf[MSG_BUF_LEN];
21302 char_u numbuf2[NUMBUFLEN];
21303 char_u *tofree;
21304 char_u *s;
21306 /* The value may be very long. Skip the middle part, so that we
21307 * have some idea how it starts and ends. smsg() would always
21308 * truncate it at the end. */
21309 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21310 if (s != NULL)
21312 trunc_string(s, buf, MSG_BUF_CLEN);
21313 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21314 vim_free(tofree);
21317 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21319 verbose_leave_scroll();
21320 --no_wait_return;
21323 vim_free(sourcing_name);
21324 sourcing_name = save_sourcing_name;
21325 sourcing_lnum = save_sourcing_lnum;
21326 current_SID = save_current_SID;
21327 #ifdef FEAT_PROFILE
21328 if (do_profiling == PROF_YES)
21329 script_prof_restore(&wait_start);
21330 #endif
21332 if (p_verbose >= 12 && sourcing_name != NULL)
21334 ++no_wait_return;
21335 verbose_enter_scroll();
21337 smsg((char_u *)_("continuing in %s"), sourcing_name);
21338 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21340 verbose_leave_scroll();
21341 --no_wait_return;
21344 did_emsg |= save_did_emsg;
21345 current_funccal = fc->caller;
21346 --depth;
21348 /* If the a:000 list and the l: and a: dicts are not referenced we can
21349 * free the funccall_T and what's in it. */
21350 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21351 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21352 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21354 free_funccal(fc, FALSE);
21356 else
21358 hashitem_T *hi;
21359 listitem_T *li;
21360 int todo;
21362 /* "fc" is still in use. This can happen when returning "a:000" or
21363 * assigning "l:" to a global variable.
21364 * Link "fc" in the list for garbage collection later. */
21365 fc->caller = previous_funccal;
21366 previous_funccal = fc;
21368 /* Make a copy of the a: variables, since we didn't do that above. */
21369 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21370 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21372 if (!HASHITEM_EMPTY(hi))
21374 --todo;
21375 v = HI2DI(hi);
21376 copy_tv(&v->di_tv, &v->di_tv);
21380 /* Make a copy of the a:000 items, since we didn't do that above. */
21381 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21382 copy_tv(&li->li_tv, &li->li_tv);
21387 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21388 * referenced from anywhere that is in use.
21390 static int
21391 can_free_funccal(fc, copyID)
21392 funccall_T *fc;
21393 int copyID;
21395 return (fc->l_varlist.lv_copyID != copyID
21396 && fc->l_vars.dv_copyID != copyID
21397 && fc->l_avars.dv_copyID != copyID);
21401 * Free "fc" and what it contains.
21403 static void
21404 free_funccal(fc, free_val)
21405 funccall_T *fc;
21406 int free_val; /* a: vars were allocated */
21408 listitem_T *li;
21410 /* The a: variables typevals may not have been allocated, only free the
21411 * allocated variables. */
21412 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21414 /* free all l: variables */
21415 vars_clear(&fc->l_vars.dv_hashtab);
21417 /* Free the a:000 variables if they were allocated. */
21418 if (free_val)
21419 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21420 clear_tv(&li->li_tv);
21422 vim_free(fc);
21426 * Add a number variable "name" to dict "dp" with value "nr".
21428 static void
21429 add_nr_var(dp, v, name, nr)
21430 dict_T *dp;
21431 dictitem_T *v;
21432 char *name;
21433 varnumber_T nr;
21435 STRCPY(v->di_key, name);
21436 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21437 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21438 v->di_tv.v_type = VAR_NUMBER;
21439 v->di_tv.v_lock = VAR_FIXED;
21440 v->di_tv.vval.v_number = nr;
21444 * ":return [expr]"
21446 void
21447 ex_return(eap)
21448 exarg_T *eap;
21450 char_u *arg = eap->arg;
21451 typval_T rettv;
21452 int returning = FALSE;
21454 if (current_funccal == NULL)
21456 EMSG(_("E133: :return not inside a function"));
21457 return;
21460 if (eap->skip)
21461 ++emsg_skip;
21463 eap->nextcmd = NULL;
21464 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21465 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21467 if (!eap->skip)
21468 returning = do_return(eap, FALSE, TRUE, &rettv);
21469 else
21470 clear_tv(&rettv);
21472 /* It's safer to return also on error. */
21473 else if (!eap->skip)
21476 * Return unless the expression evaluation has been cancelled due to an
21477 * aborting error, an interrupt, or an exception.
21479 if (!aborting())
21480 returning = do_return(eap, FALSE, TRUE, NULL);
21483 /* When skipping or the return gets pending, advance to the next command
21484 * in this line (!returning). Otherwise, ignore the rest of the line.
21485 * Following lines will be ignored by get_func_line(). */
21486 if (returning)
21487 eap->nextcmd = NULL;
21488 else if (eap->nextcmd == NULL) /* no argument */
21489 eap->nextcmd = check_nextcmd(arg);
21491 if (eap->skip)
21492 --emsg_skip;
21496 * Return from a function. Possibly makes the return pending. Also called
21497 * for a pending return at the ":endtry" or after returning from an extra
21498 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21499 * when called due to a ":return" command. "rettv" may point to a typval_T
21500 * with the return rettv. Returns TRUE when the return can be carried out,
21501 * FALSE when the return gets pending.
21504 do_return(eap, reanimate, is_cmd, rettv)
21505 exarg_T *eap;
21506 int reanimate;
21507 int is_cmd;
21508 void *rettv;
21510 int idx;
21511 struct condstack *cstack = eap->cstack;
21513 if (reanimate)
21514 /* Undo the return. */
21515 current_funccal->returned = FALSE;
21518 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21519 * not in its finally clause (which then is to be executed next) is found.
21520 * In this case, make the ":return" pending for execution at the ":endtry".
21521 * Otherwise, return normally.
21523 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21524 if (idx >= 0)
21526 cstack->cs_pending[idx] = CSTP_RETURN;
21528 if (!is_cmd && !reanimate)
21529 /* A pending return again gets pending. "rettv" points to an
21530 * allocated variable with the rettv of the original ":return"'s
21531 * argument if present or is NULL else. */
21532 cstack->cs_rettv[idx] = rettv;
21533 else
21535 /* When undoing a return in order to make it pending, get the stored
21536 * return rettv. */
21537 if (reanimate)
21538 rettv = current_funccal->rettv;
21540 if (rettv != NULL)
21542 /* Store the value of the pending return. */
21543 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21544 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21545 else
21546 EMSG(_(e_outofmem));
21548 else
21549 cstack->cs_rettv[idx] = NULL;
21551 if (reanimate)
21553 /* The pending return value could be overwritten by a ":return"
21554 * without argument in a finally clause; reset the default
21555 * return value. */
21556 current_funccal->rettv->v_type = VAR_NUMBER;
21557 current_funccal->rettv->vval.v_number = 0;
21560 report_make_pending(CSTP_RETURN, rettv);
21562 else
21564 current_funccal->returned = TRUE;
21566 /* If the return is carried out now, store the return value. For
21567 * a return immediately after reanimation, the value is already
21568 * there. */
21569 if (!reanimate && rettv != NULL)
21571 clear_tv(current_funccal->rettv);
21572 *current_funccal->rettv = *(typval_T *)rettv;
21573 if (!is_cmd)
21574 vim_free(rettv);
21578 return idx < 0;
21582 * Free the variable with a pending return value.
21584 void
21585 discard_pending_return(rettv)
21586 void *rettv;
21588 free_tv((typval_T *)rettv);
21592 * Generate a return command for producing the value of "rettv". The result
21593 * is an allocated string. Used by report_pending() for verbose messages.
21595 char_u *
21596 get_return_cmd(rettv)
21597 void *rettv;
21599 char_u *s = NULL;
21600 char_u *tofree = NULL;
21601 char_u numbuf[NUMBUFLEN];
21603 if (rettv != NULL)
21604 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21605 if (s == NULL)
21606 s = (char_u *)"";
21608 STRCPY(IObuff, ":return ");
21609 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21610 if (STRLEN(s) + 8 >= IOSIZE)
21611 STRCPY(IObuff + IOSIZE - 4, "...");
21612 vim_free(tofree);
21613 return vim_strsave(IObuff);
21617 * Get next function line.
21618 * Called by do_cmdline() to get the next line.
21619 * Returns allocated string, or NULL for end of function.
21621 char_u *
21622 get_func_line(c, cookie, indent)
21623 int c UNUSED;
21624 void *cookie;
21625 int indent UNUSED;
21627 funccall_T *fcp = (funccall_T *)cookie;
21628 ufunc_T *fp = fcp->func;
21629 char_u *retval;
21630 garray_T *gap; /* growarray with function lines */
21632 /* If breakpoints have been added/deleted need to check for it. */
21633 if (fcp->dbg_tick != debug_tick)
21635 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21636 sourcing_lnum);
21637 fcp->dbg_tick = debug_tick;
21639 #ifdef FEAT_PROFILE
21640 if (do_profiling == PROF_YES)
21641 func_line_end(cookie);
21642 #endif
21644 gap = &fp->uf_lines;
21645 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21646 || fcp->returned)
21647 retval = NULL;
21648 else
21650 /* Skip NULL lines (continuation lines). */
21651 while (fcp->linenr < gap->ga_len
21652 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21653 ++fcp->linenr;
21654 if (fcp->linenr >= gap->ga_len)
21655 retval = NULL;
21656 else
21658 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21659 sourcing_lnum = fcp->linenr;
21660 #ifdef FEAT_PROFILE
21661 if (do_profiling == PROF_YES)
21662 func_line_start(cookie);
21663 #endif
21667 /* Did we encounter a breakpoint? */
21668 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21670 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21671 /* Find next breakpoint. */
21672 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21673 sourcing_lnum);
21674 fcp->dbg_tick = debug_tick;
21677 return retval;
21680 #if defined(FEAT_PROFILE) || defined(PROTO)
21682 * Called when starting to read a function line.
21683 * "sourcing_lnum" must be correct!
21684 * When skipping lines it may not actually be executed, but we won't find out
21685 * until later and we need to store the time now.
21687 void
21688 func_line_start(cookie)
21689 void *cookie;
21691 funccall_T *fcp = (funccall_T *)cookie;
21692 ufunc_T *fp = fcp->func;
21694 if (fp->uf_profiling && sourcing_lnum >= 1
21695 && sourcing_lnum <= fp->uf_lines.ga_len)
21697 fp->uf_tml_idx = sourcing_lnum - 1;
21698 /* Skip continuation lines. */
21699 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21700 --fp->uf_tml_idx;
21701 fp->uf_tml_execed = FALSE;
21702 profile_start(&fp->uf_tml_start);
21703 profile_zero(&fp->uf_tml_children);
21704 profile_get_wait(&fp->uf_tml_wait);
21709 * Called when actually executing a function line.
21711 void
21712 func_line_exec(cookie)
21713 void *cookie;
21715 funccall_T *fcp = (funccall_T *)cookie;
21716 ufunc_T *fp = fcp->func;
21718 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21719 fp->uf_tml_execed = TRUE;
21723 * Called when done with a function line.
21725 void
21726 func_line_end(cookie)
21727 void *cookie;
21729 funccall_T *fcp = (funccall_T *)cookie;
21730 ufunc_T *fp = fcp->func;
21732 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21734 if (fp->uf_tml_execed)
21736 ++fp->uf_tml_count[fp->uf_tml_idx];
21737 profile_end(&fp->uf_tml_start);
21738 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21739 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21740 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21741 &fp->uf_tml_children);
21743 fp->uf_tml_idx = -1;
21746 #endif
21749 * Return TRUE if the currently active function should be ended, because a
21750 * return was encountered or an error occurred. Used inside a ":while".
21753 func_has_ended(cookie)
21754 void *cookie;
21756 funccall_T *fcp = (funccall_T *)cookie;
21758 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21759 * an error inside a try conditional. */
21760 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21761 || fcp->returned);
21765 * return TRUE if cookie indicates a function which "abort"s on errors.
21768 func_has_abort(cookie)
21769 void *cookie;
21771 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21774 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21775 typedef enum
21777 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21778 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21779 VAR_FLAVOUR_VIMINFO /* all uppercase */
21780 } var_flavour_T;
21782 static var_flavour_T var_flavour __ARGS((char_u *varname));
21784 static var_flavour_T
21785 var_flavour(varname)
21786 char_u *varname;
21788 char_u *p = varname;
21790 if (ASCII_ISUPPER(*p))
21792 while (*(++p))
21793 if (ASCII_ISLOWER(*p))
21794 return VAR_FLAVOUR_SESSION;
21795 return VAR_FLAVOUR_VIMINFO;
21797 else
21798 return VAR_FLAVOUR_DEFAULT;
21800 #endif
21802 #if defined(FEAT_VIMINFO) || defined(PROTO)
21804 * Restore global vars that start with a capital from the viminfo file
21807 read_viminfo_varlist(virp, writing)
21808 vir_T *virp;
21809 int writing;
21811 char_u *tab;
21812 int type = VAR_NUMBER;
21813 typval_T tv;
21815 if (!writing && (find_viminfo_parameter('!') != NULL))
21817 tab = vim_strchr(virp->vir_line + 1, '\t');
21818 if (tab != NULL)
21820 *tab++ = '\0'; /* isolate the variable name */
21821 if (*tab == 'S') /* string var */
21822 type = VAR_STRING;
21823 #ifdef FEAT_FLOAT
21824 else if (*tab == 'F')
21825 type = VAR_FLOAT;
21826 #endif
21828 tab = vim_strchr(tab, '\t');
21829 if (tab != NULL)
21831 tv.v_type = type;
21832 if (type == VAR_STRING)
21833 tv.vval.v_string = viminfo_readstring(virp,
21834 (int)(tab - virp->vir_line + 1), TRUE);
21835 #ifdef FEAT_FLOAT
21836 else if (type == VAR_FLOAT)
21837 (void)string2float(tab + 1, &tv.vval.v_float);
21838 #endif
21839 else
21840 tv.vval.v_number = atol((char *)tab + 1);
21841 set_var(virp->vir_line + 1, &tv, FALSE);
21842 if (type == VAR_STRING)
21843 vim_free(tv.vval.v_string);
21848 return viminfo_readline(virp);
21852 * Write global vars that start with a capital to the viminfo file
21854 void
21855 write_viminfo_varlist(fp)
21856 FILE *fp;
21858 hashitem_T *hi;
21859 dictitem_T *this_var;
21860 int todo;
21861 char *s;
21862 char_u *p;
21863 char_u *tofree;
21864 char_u numbuf[NUMBUFLEN];
21866 if (find_viminfo_parameter('!') == NULL)
21867 return;
21869 fprintf(fp, _("\n# global variables:\n"));
21871 todo = (int)globvarht.ht_used;
21872 for (hi = globvarht.ht_array; todo > 0; ++hi)
21874 if (!HASHITEM_EMPTY(hi))
21876 --todo;
21877 this_var = HI2DI(hi);
21878 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21880 switch (this_var->di_tv.v_type)
21882 case VAR_STRING: s = "STR"; break;
21883 case VAR_NUMBER: s = "NUM"; break;
21884 #ifdef FEAT_FLOAT
21885 case VAR_FLOAT: s = "FLO"; break;
21886 #endif
21887 default: continue;
21889 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21890 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21891 if (p != NULL)
21892 viminfo_writestring(fp, p);
21893 vim_free(tofree);
21898 #endif
21900 #if defined(FEAT_SESSION) || defined(PROTO)
21902 store_session_globals(fd)
21903 FILE *fd;
21905 hashitem_T *hi;
21906 dictitem_T *this_var;
21907 int todo;
21908 char_u *p, *t;
21910 todo = (int)globvarht.ht_used;
21911 for (hi = globvarht.ht_array; todo > 0; ++hi)
21913 if (!HASHITEM_EMPTY(hi))
21915 --todo;
21916 this_var = HI2DI(hi);
21917 if ((this_var->di_tv.v_type == VAR_NUMBER
21918 || this_var->di_tv.v_type == VAR_STRING)
21919 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21921 /* Escape special characters with a backslash. Turn a LF and
21922 * CR into \n and \r. */
21923 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
21924 (char_u *)"\\\"\n\r");
21925 if (p == NULL) /* out of memory */
21926 break;
21927 for (t = p; *t != NUL; ++t)
21928 if (*t == '\n')
21929 *t = 'n';
21930 else if (*t == '\r')
21931 *t = 'r';
21932 if ((fprintf(fd, "let %s = %c%s%c",
21933 this_var->di_key,
21934 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21935 : ' ',
21937 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21938 : ' ') < 0)
21939 || put_eol(fd) == FAIL)
21941 vim_free(p);
21942 return FAIL;
21944 vim_free(p);
21946 #ifdef FEAT_FLOAT
21947 else if (this_var->di_tv.v_type == VAR_FLOAT
21948 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21950 float_T f = this_var->di_tv.vval.v_float;
21951 int sign = ' ';
21953 if (f < 0)
21955 f = -f;
21956 sign = '-';
21958 if ((fprintf(fd, "let %s = %c&%f",
21959 this_var->di_key, sign, f) < 0)
21960 || put_eol(fd) == FAIL)
21961 return FAIL;
21963 #endif
21966 return OK;
21968 #endif
21971 * Display script name where an item was last set.
21972 * Should only be invoked when 'verbose' is non-zero.
21974 void
21975 last_set_msg(scriptID)
21976 scid_T scriptID;
21978 char_u *p;
21980 if (scriptID != 0)
21982 p = home_replace_save(NULL, get_scriptname(scriptID));
21983 if (p != NULL)
21985 verbose_enter();
21986 MSG_PUTS(_("\n\tLast set from "));
21987 MSG_PUTS(p);
21988 vim_free(p);
21989 verbose_leave();
21995 * List v:oldfiles in a nice way.
21997 void
21998 ex_oldfiles(eap)
21999 exarg_T *eap UNUSED;
22001 list_T *l = vimvars[VV_OLDFILES].vv_list;
22002 listitem_T *li;
22003 int nr = 0;
22005 if (l == NULL)
22006 msg((char_u *)_("No old files"));
22007 else
22009 msg_start();
22010 msg_scroll = TRUE;
22011 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22013 msg_outnum((long)++nr);
22014 MSG_PUTS(": ");
22015 msg_outtrans(get_tv_string(&li->li_tv));
22016 msg_putchar('\n');
22017 out_flush(); /* output one line at a time */
22018 ui_breakcheck();
22020 /* Assume "got_int" was set to truncate the listing. */
22021 got_int = FALSE;
22023 #ifdef FEAT_BROWSE_CMD
22024 if (cmdmod.browse)
22026 quit_more = FALSE;
22027 nr = prompt_for_number(FALSE);
22028 msg_starthere();
22029 if (nr > 0)
22031 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22032 (long)nr);
22034 if (p != NULL)
22036 p = expand_env_save(p);
22037 eap->arg = p;
22038 eap->cmdidx = CMD_edit;
22039 cmdmod.browse = FALSE;
22040 do_exedit(eap, NULL);
22041 vim_free(p);
22045 #endif
22049 #endif /* FEAT_EVAL */
22052 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22054 #ifdef WIN3264
22056 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22058 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22059 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22060 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22063 * Get the short path (8.3) for the filename in "fnamep".
22064 * Only works for a valid file name.
22065 * When the path gets longer "fnamep" is changed and the allocated buffer
22066 * is put in "bufp".
22067 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22068 * Returns OK on success, FAIL on failure.
22070 static int
22071 get_short_pathname(fnamep, bufp, fnamelen)
22072 char_u **fnamep;
22073 char_u **bufp;
22074 int *fnamelen;
22076 int l, len;
22077 char_u *newbuf;
22079 len = *fnamelen;
22080 l = GetShortPathName(*fnamep, *fnamep, len);
22081 if (l > len - 1)
22083 /* If that doesn't work (not enough space), then save the string
22084 * and try again with a new buffer big enough. */
22085 newbuf = vim_strnsave(*fnamep, l);
22086 if (newbuf == NULL)
22087 return FAIL;
22089 vim_free(*bufp);
22090 *fnamep = *bufp = newbuf;
22092 /* Really should always succeed, as the buffer is big enough. */
22093 l = GetShortPathName(*fnamep, *fnamep, l+1);
22096 *fnamelen = l;
22097 return OK;
22101 * Get the short path (8.3) for the filename in "fname". The converted
22102 * path is returned in "bufp".
22104 * Some of the directories specified in "fname" may not exist. This function
22105 * will shorten the existing directories at the beginning of the path and then
22106 * append the remaining non-existing path.
22108 * fname - Pointer to the filename to shorten. On return, contains the
22109 * pointer to the shortened pathname
22110 * bufp - Pointer to an allocated buffer for the filename.
22111 * fnamelen - Length of the filename pointed to by fname
22113 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22115 static int
22116 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22117 char_u **fname;
22118 char_u **bufp;
22119 int *fnamelen;
22121 char_u *short_fname, *save_fname, *pbuf_unused;
22122 char_u *endp, *save_endp;
22123 char_u ch;
22124 int old_len, len;
22125 int new_len, sfx_len;
22126 int retval = OK;
22128 /* Make a copy */
22129 old_len = *fnamelen;
22130 save_fname = vim_strnsave(*fname, old_len);
22131 pbuf_unused = NULL;
22132 short_fname = NULL;
22134 endp = save_fname + old_len - 1; /* Find the end of the copy */
22135 save_endp = endp;
22138 * Try shortening the supplied path till it succeeds by removing one
22139 * directory at a time from the tail of the path.
22141 len = 0;
22142 for (;;)
22144 /* go back one path-separator */
22145 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22146 --endp;
22147 if (endp <= save_fname)
22148 break; /* processed the complete path */
22151 * Replace the path separator with a NUL and try to shorten the
22152 * resulting path.
22154 ch = *endp;
22155 *endp = 0;
22156 short_fname = save_fname;
22157 len = (int)STRLEN(short_fname) + 1;
22158 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22160 retval = FAIL;
22161 goto theend;
22163 *endp = ch; /* preserve the string */
22165 if (len > 0)
22166 break; /* successfully shortened the path */
22168 /* failed to shorten the path. Skip the path separator */
22169 --endp;
22172 if (len > 0)
22175 * Succeeded in shortening the path. Now concatenate the shortened
22176 * path with the remaining path at the tail.
22179 /* Compute the length of the new path. */
22180 sfx_len = (int)(save_endp - endp) + 1;
22181 new_len = len + sfx_len;
22183 *fnamelen = new_len;
22184 vim_free(*bufp);
22185 if (new_len > old_len)
22187 /* There is not enough space in the currently allocated string,
22188 * copy it to a buffer big enough. */
22189 *fname = *bufp = vim_strnsave(short_fname, new_len);
22190 if (*fname == NULL)
22192 retval = FAIL;
22193 goto theend;
22196 else
22198 /* Transfer short_fname to the main buffer (it's big enough),
22199 * unless get_short_pathname() did its work in-place. */
22200 *fname = *bufp = save_fname;
22201 if (short_fname != save_fname)
22202 vim_strncpy(save_fname, short_fname, len);
22203 save_fname = NULL;
22206 /* concat the not-shortened part of the path */
22207 vim_strncpy(*fname + len, endp, sfx_len);
22208 (*fname)[new_len] = NUL;
22211 theend:
22212 vim_free(pbuf_unused);
22213 vim_free(save_fname);
22215 return retval;
22219 * Get a pathname for a partial path.
22220 * Returns OK for success, FAIL for failure.
22222 static int
22223 shortpath_for_partial(fnamep, bufp, fnamelen)
22224 char_u **fnamep;
22225 char_u **bufp;
22226 int *fnamelen;
22228 int sepcount, len, tflen;
22229 char_u *p;
22230 char_u *pbuf, *tfname;
22231 int hasTilde;
22233 /* Count up the path separators from the RHS.. so we know which part
22234 * of the path to return. */
22235 sepcount = 0;
22236 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22237 if (vim_ispathsep(*p))
22238 ++sepcount;
22240 /* Need full path first (use expand_env() to remove a "~/") */
22241 hasTilde = (**fnamep == '~');
22242 if (hasTilde)
22243 pbuf = tfname = expand_env_save(*fnamep);
22244 else
22245 pbuf = tfname = FullName_save(*fnamep, FALSE);
22247 len = tflen = (int)STRLEN(tfname);
22249 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22250 return FAIL;
22252 if (len == 0)
22254 /* Don't have a valid filename, so shorten the rest of the
22255 * path if we can. This CAN give us invalid 8.3 filenames, but
22256 * there's not a lot of point in guessing what it might be.
22258 len = tflen;
22259 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22260 return FAIL;
22263 /* Count the paths backward to find the beginning of the desired string. */
22264 for (p = tfname + len - 1; p >= tfname; --p)
22266 #ifdef FEAT_MBYTE
22267 if (has_mbyte)
22268 p -= mb_head_off(tfname, p);
22269 #endif
22270 if (vim_ispathsep(*p))
22272 if (sepcount == 0 || (hasTilde && sepcount == 1))
22273 break;
22274 else
22275 sepcount --;
22278 if (hasTilde)
22280 --p;
22281 if (p >= tfname)
22282 *p = '~';
22283 else
22284 return FAIL;
22286 else
22287 ++p;
22289 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22290 vim_free(*bufp);
22291 *fnamelen = (int)STRLEN(p);
22292 *bufp = pbuf;
22293 *fnamep = p;
22295 return OK;
22297 #endif /* WIN3264 */
22300 * Adjust a filename, according to a string of modifiers.
22301 * *fnamep must be NUL terminated when called. When returning, the length is
22302 * determined by *fnamelen.
22303 * Returns VALID_ flags or -1 for failure.
22304 * When there is an error, *fnamep is set to NULL.
22307 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22308 char_u *src; /* string with modifiers */
22309 int *usedlen; /* characters after src that are used */
22310 char_u **fnamep; /* file name so far */
22311 char_u **bufp; /* buffer for allocated file name or NULL */
22312 int *fnamelen; /* length of fnamep */
22314 int valid = 0;
22315 char_u *tail;
22316 char_u *s, *p, *pbuf;
22317 char_u dirname[MAXPATHL];
22318 int c;
22319 int has_fullname = 0;
22320 #ifdef WIN3264
22321 int has_shortname = 0;
22322 #endif
22324 repeat:
22325 /* ":p" - full path/file_name */
22326 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22328 has_fullname = 1;
22330 valid |= VALID_PATH;
22331 *usedlen += 2;
22333 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22334 if ((*fnamep)[0] == '~'
22335 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22336 && ((*fnamep)[1] == '/'
22337 # ifdef BACKSLASH_IN_FILENAME
22338 || (*fnamep)[1] == '\\'
22339 # endif
22340 || (*fnamep)[1] == NUL)
22342 #endif
22345 *fnamep = expand_env_save(*fnamep);
22346 vim_free(*bufp); /* free any allocated file name */
22347 *bufp = *fnamep;
22348 if (*fnamep == NULL)
22349 return -1;
22352 /* When "/." or "/.." is used: force expansion to get rid of it. */
22353 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22355 if (vim_ispathsep(*p)
22356 && p[1] == '.'
22357 && (p[2] == NUL
22358 || vim_ispathsep(p[2])
22359 || (p[2] == '.'
22360 && (p[3] == NUL || vim_ispathsep(p[3])))))
22361 break;
22364 /* FullName_save() is slow, don't use it when not needed. */
22365 if (*p != NUL || !vim_isAbsName(*fnamep))
22367 *fnamep = FullName_save(*fnamep, *p != NUL);
22368 vim_free(*bufp); /* free any allocated file name */
22369 *bufp = *fnamep;
22370 if (*fnamep == NULL)
22371 return -1;
22374 /* Append a path separator to a directory. */
22375 if (mch_isdir(*fnamep))
22377 /* Make room for one or two extra characters. */
22378 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22379 vim_free(*bufp); /* free any allocated file name */
22380 *bufp = *fnamep;
22381 if (*fnamep == NULL)
22382 return -1;
22383 add_pathsep(*fnamep);
22387 /* ":." - path relative to the current directory */
22388 /* ":~" - path relative to the home directory */
22389 /* ":8" - shortname path - postponed till after */
22390 while (src[*usedlen] == ':'
22391 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22393 *usedlen += 2;
22394 if (c == '8')
22396 #ifdef WIN3264
22397 has_shortname = 1; /* Postpone this. */
22398 #endif
22399 continue;
22401 pbuf = NULL;
22402 /* Need full path first (use expand_env() to remove a "~/") */
22403 if (!has_fullname)
22405 if (c == '.' && **fnamep == '~')
22406 p = pbuf = expand_env_save(*fnamep);
22407 else
22408 p = pbuf = FullName_save(*fnamep, FALSE);
22410 else
22411 p = *fnamep;
22413 has_fullname = 0;
22415 if (p != NULL)
22417 if (c == '.')
22419 mch_dirname(dirname, MAXPATHL);
22420 s = shorten_fname(p, dirname);
22421 if (s != NULL)
22423 *fnamep = s;
22424 if (pbuf != NULL)
22426 vim_free(*bufp); /* free any allocated file name */
22427 *bufp = pbuf;
22428 pbuf = NULL;
22432 else
22434 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22435 /* Only replace it when it starts with '~' */
22436 if (*dirname == '~')
22438 s = vim_strsave(dirname);
22439 if (s != NULL)
22441 *fnamep = s;
22442 vim_free(*bufp);
22443 *bufp = s;
22447 vim_free(pbuf);
22451 tail = gettail(*fnamep);
22452 *fnamelen = (int)STRLEN(*fnamep);
22454 /* ":h" - head, remove "/file_name", can be repeated */
22455 /* Don't remove the first "/" or "c:\" */
22456 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22458 valid |= VALID_HEAD;
22459 *usedlen += 2;
22460 s = get_past_head(*fnamep);
22461 while (tail > s && after_pathsep(s, tail))
22462 mb_ptr_back(*fnamep, tail);
22463 *fnamelen = (int)(tail - *fnamep);
22464 #ifdef VMS
22465 if (*fnamelen > 0)
22466 *fnamelen += 1; /* the path separator is part of the path */
22467 #endif
22468 if (*fnamelen == 0)
22470 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22471 p = vim_strsave((char_u *)".");
22472 if (p == NULL)
22473 return -1;
22474 vim_free(*bufp);
22475 *bufp = *fnamep = tail = p;
22476 *fnamelen = 1;
22478 else
22480 while (tail > s && !after_pathsep(s, tail))
22481 mb_ptr_back(*fnamep, tail);
22485 /* ":8" - shortname */
22486 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22488 *usedlen += 2;
22489 #ifdef WIN3264
22490 has_shortname = 1;
22491 #endif
22494 #ifdef WIN3264
22495 /* Check shortname after we have done 'heads' and before we do 'tails'
22497 if (has_shortname)
22499 pbuf = NULL;
22500 /* Copy the string if it is shortened by :h */
22501 if (*fnamelen < (int)STRLEN(*fnamep))
22503 p = vim_strnsave(*fnamep, *fnamelen);
22504 if (p == 0)
22505 return -1;
22506 vim_free(*bufp);
22507 *bufp = *fnamep = p;
22510 /* Split into two implementations - makes it easier. First is where
22511 * there isn't a full name already, second is where there is.
22513 if (!has_fullname && !vim_isAbsName(*fnamep))
22515 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22516 return -1;
22518 else
22520 int l;
22522 /* Simple case, already have the full-name
22523 * Nearly always shorter, so try first time. */
22524 l = *fnamelen;
22525 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22526 return -1;
22528 if (l == 0)
22530 /* Couldn't find the filename.. search the paths.
22532 l = *fnamelen;
22533 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22534 return -1;
22536 *fnamelen = l;
22539 #endif /* WIN3264 */
22541 /* ":t" - tail, just the basename */
22542 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22544 *usedlen += 2;
22545 *fnamelen -= (int)(tail - *fnamep);
22546 *fnamep = tail;
22549 /* ":e" - extension, can be repeated */
22550 /* ":r" - root, without extension, can be repeated */
22551 while (src[*usedlen] == ':'
22552 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22554 /* find a '.' in the tail:
22555 * - for second :e: before the current fname
22556 * - otherwise: The last '.'
22558 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22559 s = *fnamep - 2;
22560 else
22561 s = *fnamep + *fnamelen - 1;
22562 for ( ; s > tail; --s)
22563 if (s[0] == '.')
22564 break;
22565 if (src[*usedlen + 1] == 'e') /* :e */
22567 if (s > tail)
22569 *fnamelen += (int)(*fnamep - (s + 1));
22570 *fnamep = s + 1;
22571 #ifdef VMS
22572 /* cut version from the extension */
22573 s = *fnamep + *fnamelen - 1;
22574 for ( ; s > *fnamep; --s)
22575 if (s[0] == ';')
22576 break;
22577 if (s > *fnamep)
22578 *fnamelen = s - *fnamep;
22579 #endif
22581 else if (*fnamep <= tail)
22582 *fnamelen = 0;
22584 else /* :r */
22586 if (s > tail) /* remove one extension */
22587 *fnamelen = (int)(s - *fnamep);
22589 *usedlen += 2;
22592 /* ":s?pat?foo?" - substitute */
22593 /* ":gs?pat?foo?" - global substitute */
22594 if (src[*usedlen] == ':'
22595 && (src[*usedlen + 1] == 's'
22596 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22598 char_u *str;
22599 char_u *pat;
22600 char_u *sub;
22601 int sep;
22602 char_u *flags;
22603 int didit = FALSE;
22605 flags = (char_u *)"";
22606 s = src + *usedlen + 2;
22607 if (src[*usedlen + 1] == 'g')
22609 flags = (char_u *)"g";
22610 ++s;
22613 sep = *s++;
22614 if (sep)
22616 /* find end of pattern */
22617 p = vim_strchr(s, sep);
22618 if (p != NULL)
22620 pat = vim_strnsave(s, (int)(p - s));
22621 if (pat != NULL)
22623 s = p + 1;
22624 /* find end of substitution */
22625 p = vim_strchr(s, sep);
22626 if (p != NULL)
22628 sub = vim_strnsave(s, (int)(p - s));
22629 str = vim_strnsave(*fnamep, *fnamelen);
22630 if (sub != NULL && str != NULL)
22632 *usedlen = (int)(p + 1 - src);
22633 s = do_string_sub(str, pat, sub, flags);
22634 if (s != NULL)
22636 *fnamep = s;
22637 *fnamelen = (int)STRLEN(s);
22638 vim_free(*bufp);
22639 *bufp = s;
22640 didit = TRUE;
22643 vim_free(sub);
22644 vim_free(str);
22646 vim_free(pat);
22649 /* after using ":s", repeat all the modifiers */
22650 if (didit)
22651 goto repeat;
22655 return valid;
22659 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22660 * "flags" can be "g" to do a global substitute.
22661 * Returns an allocated string, NULL for error.
22663 char_u *
22664 do_string_sub(str, pat, sub, flags)
22665 char_u *str;
22666 char_u *pat;
22667 char_u *sub;
22668 char_u *flags;
22670 int sublen;
22671 regmatch_T regmatch;
22672 int i;
22673 int do_all;
22674 char_u *tail;
22675 garray_T ga;
22676 char_u *ret;
22677 char_u *save_cpo;
22679 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22680 save_cpo = p_cpo;
22681 p_cpo = empty_option;
22683 ga_init2(&ga, 1, 200);
22685 do_all = (flags[0] == 'g');
22687 regmatch.rm_ic = p_ic;
22688 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22689 if (regmatch.regprog != NULL)
22691 tail = str;
22692 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22695 * Get some space for a temporary buffer to do the substitution
22696 * into. It will contain:
22697 * - The text up to where the match is.
22698 * - The substituted text.
22699 * - The text after the match.
22701 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22702 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22703 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22705 ga_clear(&ga);
22706 break;
22709 /* copy the text up to where the match is */
22710 i = (int)(regmatch.startp[0] - tail);
22711 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22712 /* add the substituted text */
22713 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22714 + ga.ga_len + i, TRUE, TRUE, FALSE);
22715 ga.ga_len += i + sublen - 1;
22716 /* avoid getting stuck on a match with an empty string */
22717 if (tail == regmatch.endp[0])
22719 if (*tail == NUL)
22720 break;
22721 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22722 ++ga.ga_len;
22724 else
22726 tail = regmatch.endp[0];
22727 if (*tail == NUL)
22728 break;
22730 if (!do_all)
22731 break;
22734 if (ga.ga_data != NULL)
22735 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22737 vim_free(regmatch.regprog);
22740 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22741 ga_clear(&ga);
22742 if (p_cpo == empty_option)
22743 p_cpo = save_cpo;
22744 else
22745 /* Darn, evaluating {sub} expression changed the value. */
22746 free_string_option(save_cpo);
22748 return ret;
22751 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */