Merged from the latest developing branch.
[MacVim.git] / src / eval.c
blobbf0c3030f765f907bb7b24f6265ae36ba5b0f498
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}
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 it 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);
6567 /* Free lists and dictionaries that are not referenced. */
6568 did_free = free_unref_items(copyID);
6570 /* check if any funccal can be freed now */
6571 for (pfc = &previous_funccal; *pfc != NULL; )
6573 if (can_free_funccal(*pfc, copyID))
6575 fc = *pfc;
6576 *pfc = fc->caller;
6577 free_funccal(fc, TRUE);
6578 did_free = TRUE;
6579 did_free_funccal = TRUE;
6581 else
6582 pfc = &(*pfc)->caller;
6584 if (did_free_funccal)
6585 /* When a funccal was freed some more items might be garbage
6586 * collected, so run again. */
6587 (void)garbage_collect();
6589 return did_free;
6593 * Free lists and dictionaries that are no longer referenced.
6595 static int
6596 free_unref_items(copyID)
6597 int copyID;
6599 dict_T *dd;
6600 list_T *ll;
6601 int did_free = FALSE;
6604 * Go through the list of dicts and free items without the copyID.
6606 for (dd = first_dict; dd != NULL; )
6607 if ((dd->dv_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
6609 /* Free the Dictionary and ordinary items it contains, but don't
6610 * recurse into Lists and Dictionaries, they will be in the list
6611 * of dicts or list of lists. */
6612 dict_free(dd, FALSE);
6613 did_free = TRUE;
6615 /* restart, next dict may also have been freed */
6616 dd = first_dict;
6618 else
6619 dd = dd->dv_used_next;
6622 * Go through the list of lists and free items without the copyID.
6623 * But don't free a list that has a watcher (used in a for loop), these
6624 * are not referenced anywhere.
6626 for (ll = first_list; ll != NULL; )
6627 if ((ll->lv_copyID & COPYID_MASK) != (copyID & COPYID_MASK)
6628 && ll->lv_watch == NULL)
6630 /* Free the List and ordinary items it contains, but don't recurse
6631 * into Lists and Dictionaries, they will be in the list of dicts
6632 * or list of lists. */
6633 list_free(ll, FALSE);
6634 did_free = TRUE;
6636 /* restart, next list may also have been freed */
6637 ll = first_list;
6639 else
6640 ll = ll->lv_used_next;
6642 return did_free;
6646 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6648 static void
6649 set_ref_in_ht(ht, copyID)
6650 hashtab_T *ht;
6651 int copyID;
6653 int todo;
6654 hashitem_T *hi;
6656 todo = (int)ht->ht_used;
6657 for (hi = ht->ht_array; todo > 0; ++hi)
6658 if (!HASHITEM_EMPTY(hi))
6660 --todo;
6661 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6666 * Mark all lists and dicts referenced through list "l" with "copyID".
6668 static void
6669 set_ref_in_list(l, copyID)
6670 list_T *l;
6671 int copyID;
6673 listitem_T *li;
6675 for (li = l->lv_first; li != NULL; li = li->li_next)
6676 set_ref_in_item(&li->li_tv, copyID);
6680 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6682 static void
6683 set_ref_in_item(tv, copyID)
6684 typval_T *tv;
6685 int copyID;
6687 dict_T *dd;
6688 list_T *ll;
6690 switch (tv->v_type)
6692 case VAR_DICT:
6693 dd = tv->vval.v_dict;
6694 if (dd != NULL && dd->dv_copyID != copyID)
6696 /* Didn't see this dict yet. */
6697 dd->dv_copyID = copyID;
6698 set_ref_in_ht(&dd->dv_hashtab, copyID);
6700 break;
6702 case VAR_LIST:
6703 ll = tv->vval.v_list;
6704 if (ll != NULL && ll->lv_copyID != copyID)
6706 /* Didn't see this list yet. */
6707 ll->lv_copyID = copyID;
6708 set_ref_in_list(ll, copyID);
6710 break;
6712 return;
6716 * Allocate an empty header for a dictionary.
6718 dict_T *
6719 dict_alloc()
6721 dict_T *d;
6723 d = (dict_T *)alloc(sizeof(dict_T));
6724 if (d != NULL)
6726 /* Add the list to the list of dicts for garbage collection. */
6727 if (first_dict != NULL)
6728 first_dict->dv_used_prev = d;
6729 d->dv_used_next = first_dict;
6730 d->dv_used_prev = NULL;
6731 first_dict = d;
6733 hash_init(&d->dv_hashtab);
6734 d->dv_lock = 0;
6735 d->dv_refcount = 0;
6736 d->dv_copyID = 0;
6738 return d;
6742 * Unreference a Dictionary: decrement the reference count and free it when it
6743 * becomes zero.
6745 static void
6746 dict_unref(d)
6747 dict_T *d;
6749 if (d != NULL && --d->dv_refcount <= 0)
6750 dict_free(d, TRUE);
6754 * Free a Dictionary, including all items it contains.
6755 * Ignores the reference count.
6757 static void
6758 dict_free(d, recurse)
6759 dict_T *d;
6760 int recurse; /* Free Lists and Dictionaries recursively. */
6762 int todo;
6763 hashitem_T *hi;
6764 dictitem_T *di;
6766 /* Remove the dict from the list of dicts for garbage collection. */
6767 if (d->dv_used_prev == NULL)
6768 first_dict = d->dv_used_next;
6769 else
6770 d->dv_used_prev->dv_used_next = d->dv_used_next;
6771 if (d->dv_used_next != NULL)
6772 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6774 /* Lock the hashtab, we don't want it to resize while freeing items. */
6775 hash_lock(&d->dv_hashtab);
6776 todo = (int)d->dv_hashtab.ht_used;
6777 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6779 if (!HASHITEM_EMPTY(hi))
6781 /* Remove the item before deleting it, just in case there is
6782 * something recursive causing trouble. */
6783 di = HI2DI(hi);
6784 hash_remove(&d->dv_hashtab, hi);
6785 if (recurse || (di->di_tv.v_type != VAR_LIST
6786 && di->di_tv.v_type != VAR_DICT))
6787 clear_tv(&di->di_tv);
6788 vim_free(di);
6789 --todo;
6792 hash_clear(&d->dv_hashtab);
6793 vim_free(d);
6797 * Allocate a Dictionary item.
6798 * The "key" is copied to the new item.
6799 * Note that the value of the item "di_tv" still needs to be initialized!
6800 * Returns NULL when out of memory.
6802 static dictitem_T *
6803 dictitem_alloc(key)
6804 char_u *key;
6806 dictitem_T *di;
6808 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6809 if (di != NULL)
6811 STRCPY(di->di_key, key);
6812 di->di_flags = 0;
6814 return di;
6818 * Make a copy of a Dictionary item.
6820 static dictitem_T *
6821 dictitem_copy(org)
6822 dictitem_T *org;
6824 dictitem_T *di;
6826 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6827 + STRLEN(org->di_key)));
6828 if (di != NULL)
6830 STRCPY(di->di_key, org->di_key);
6831 di->di_flags = 0;
6832 copy_tv(&org->di_tv, &di->di_tv);
6834 return di;
6838 * Remove item "item" from Dictionary "dict" and free it.
6840 static void
6841 dictitem_remove(dict, item)
6842 dict_T *dict;
6843 dictitem_T *item;
6845 hashitem_T *hi;
6847 hi = hash_find(&dict->dv_hashtab, item->di_key);
6848 if (HASHITEM_EMPTY(hi))
6849 EMSG2(_(e_intern2), "dictitem_remove()");
6850 else
6851 hash_remove(&dict->dv_hashtab, hi);
6852 dictitem_free(item);
6856 * Free a dict item. Also clears the value.
6858 static void
6859 dictitem_free(item)
6860 dictitem_T *item;
6862 clear_tv(&item->di_tv);
6863 vim_free(item);
6867 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6868 * The refcount of the new dict is set to 1.
6869 * See item_copy() for "copyID".
6870 * Returns NULL when out of memory.
6872 static dict_T *
6873 dict_copy(orig, deep, copyID)
6874 dict_T *orig;
6875 int deep;
6876 int copyID;
6878 dict_T *copy;
6879 dictitem_T *di;
6880 int todo;
6881 hashitem_T *hi;
6883 if (orig == NULL)
6884 return NULL;
6886 copy = dict_alloc();
6887 if (copy != NULL)
6889 if (copyID != 0)
6891 orig->dv_copyID = copyID;
6892 orig->dv_copydict = copy;
6894 todo = (int)orig->dv_hashtab.ht_used;
6895 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6897 if (!HASHITEM_EMPTY(hi))
6899 --todo;
6901 di = dictitem_alloc(hi->hi_key);
6902 if (di == NULL)
6903 break;
6904 if (deep)
6906 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6907 copyID) == FAIL)
6909 vim_free(di);
6910 break;
6913 else
6914 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6915 if (dict_add(copy, di) == FAIL)
6917 dictitem_free(di);
6918 break;
6923 ++copy->dv_refcount;
6924 if (todo > 0)
6926 dict_unref(copy);
6927 copy = NULL;
6931 return copy;
6935 * Add item "item" to Dictionary "d".
6936 * Returns FAIL when out of memory and when key already existed.
6938 static int
6939 dict_add(d, item)
6940 dict_T *d;
6941 dictitem_T *item;
6943 return hash_add(&d->dv_hashtab, item->di_key);
6947 * Add a number or string entry to dictionary "d".
6948 * When "str" is NULL use number "nr", otherwise use "str".
6949 * Returns FAIL when out of memory and when key already exists.
6952 dict_add_nr_str(d, key, nr, str)
6953 dict_T *d;
6954 char *key;
6955 long nr;
6956 char_u *str;
6958 dictitem_T *item;
6960 item = dictitem_alloc((char_u *)key);
6961 if (item == NULL)
6962 return FAIL;
6963 item->di_tv.v_lock = 0;
6964 if (str == NULL)
6966 item->di_tv.v_type = VAR_NUMBER;
6967 item->di_tv.vval.v_number = nr;
6969 else
6971 item->di_tv.v_type = VAR_STRING;
6972 item->di_tv.vval.v_string = vim_strsave(str);
6974 if (dict_add(d, item) == FAIL)
6976 dictitem_free(item);
6977 return FAIL;
6979 return OK;
6983 * Get the number of items in a Dictionary.
6985 static long
6986 dict_len(d)
6987 dict_T *d;
6989 if (d == NULL)
6990 return 0L;
6991 return (long)d->dv_hashtab.ht_used;
6995 * Find item "key[len]" in Dictionary "d".
6996 * If "len" is negative use strlen(key).
6997 * Returns NULL when not found.
6999 static dictitem_T *
7000 dict_find(d, key, len)
7001 dict_T *d;
7002 char_u *key;
7003 int len;
7005 #define AKEYLEN 200
7006 char_u buf[AKEYLEN];
7007 char_u *akey;
7008 char_u *tofree = NULL;
7009 hashitem_T *hi;
7011 if (len < 0)
7012 akey = key;
7013 else if (len >= AKEYLEN)
7015 tofree = akey = vim_strnsave(key, len);
7016 if (akey == NULL)
7017 return NULL;
7019 else
7021 /* Avoid a malloc/free by using buf[]. */
7022 vim_strncpy(buf, key, len);
7023 akey = buf;
7026 hi = hash_find(&d->dv_hashtab, akey);
7027 vim_free(tofree);
7028 if (HASHITEM_EMPTY(hi))
7029 return NULL;
7030 return HI2DI(hi);
7034 * Get a string item from a dictionary.
7035 * When "save" is TRUE allocate memory for it.
7036 * Returns NULL if the entry doesn't exist or out of memory.
7038 char_u *
7039 get_dict_string(d, key, save)
7040 dict_T *d;
7041 char_u *key;
7042 int save;
7044 dictitem_T *di;
7045 char_u *s;
7047 di = dict_find(d, key, -1);
7048 if (di == NULL)
7049 return NULL;
7050 s = get_tv_string(&di->di_tv);
7051 if (save && s != NULL)
7052 s = vim_strsave(s);
7053 return s;
7057 * Get a number item from a dictionary.
7058 * Returns 0 if the entry doesn't exist or out of memory.
7060 long
7061 get_dict_number(d, key)
7062 dict_T *d;
7063 char_u *key;
7065 dictitem_T *di;
7067 di = dict_find(d, key, -1);
7068 if (di == NULL)
7069 return 0;
7070 return get_tv_number(&di->di_tv);
7074 * Return an allocated string with the string representation of a Dictionary.
7075 * May return NULL.
7077 static char_u *
7078 dict2string(tv, copyID)
7079 typval_T *tv;
7080 int copyID;
7082 garray_T ga;
7083 int first = TRUE;
7084 char_u *tofree;
7085 char_u numbuf[NUMBUFLEN];
7086 hashitem_T *hi;
7087 char_u *s;
7088 dict_T *d;
7089 int todo;
7091 if ((d = tv->vval.v_dict) == NULL)
7092 return NULL;
7093 ga_init2(&ga, (int)sizeof(char), 80);
7094 ga_append(&ga, '{');
7096 todo = (int)d->dv_hashtab.ht_used;
7097 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7099 if (!HASHITEM_EMPTY(hi))
7101 --todo;
7103 if (first)
7104 first = FALSE;
7105 else
7106 ga_concat(&ga, (char_u *)", ");
7108 tofree = string_quote(hi->hi_key, FALSE);
7109 if (tofree != NULL)
7111 ga_concat(&ga, tofree);
7112 vim_free(tofree);
7114 ga_concat(&ga, (char_u *)": ");
7115 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7116 if (s != NULL)
7117 ga_concat(&ga, s);
7118 vim_free(tofree);
7119 if (s == NULL)
7120 break;
7123 if (todo > 0)
7125 vim_free(ga.ga_data);
7126 return NULL;
7129 ga_append(&ga, '}');
7130 ga_append(&ga, NUL);
7131 return (char_u *)ga.ga_data;
7135 * Allocate a variable for a Dictionary and fill it from "*arg".
7136 * Return OK or FAIL. Returns NOTDONE for {expr}.
7138 static int
7139 get_dict_tv(arg, rettv, evaluate)
7140 char_u **arg;
7141 typval_T *rettv;
7142 int evaluate;
7144 dict_T *d = NULL;
7145 typval_T tvkey;
7146 typval_T tv;
7147 char_u *key = NULL;
7148 dictitem_T *item;
7149 char_u *start = skipwhite(*arg + 1);
7150 char_u buf[NUMBUFLEN];
7153 * First check if it's not a curly-braces thing: {expr}.
7154 * Must do this without evaluating, otherwise a function may be called
7155 * twice. Unfortunately this means we need to call eval1() twice for the
7156 * first item.
7157 * But {} is an empty Dictionary.
7159 if (*start != '}')
7161 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7162 return FAIL;
7163 if (*start == '}')
7164 return NOTDONE;
7167 if (evaluate)
7169 d = dict_alloc();
7170 if (d == NULL)
7171 return FAIL;
7173 tvkey.v_type = VAR_UNKNOWN;
7174 tv.v_type = VAR_UNKNOWN;
7176 *arg = skipwhite(*arg + 1);
7177 while (**arg != '}' && **arg != NUL)
7179 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7180 goto failret;
7181 if (**arg != ':')
7183 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7184 clear_tv(&tvkey);
7185 goto failret;
7187 if (evaluate)
7189 key = get_tv_string_buf_chk(&tvkey, buf);
7190 if (key == NULL || *key == NUL)
7192 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7193 if (key != NULL)
7194 EMSG(_(e_emptykey));
7195 clear_tv(&tvkey);
7196 goto failret;
7200 *arg = skipwhite(*arg + 1);
7201 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7203 if (evaluate)
7204 clear_tv(&tvkey);
7205 goto failret;
7207 if (evaluate)
7209 item = dict_find(d, key, -1);
7210 if (item != NULL)
7212 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7213 clear_tv(&tvkey);
7214 clear_tv(&tv);
7215 goto failret;
7217 item = dictitem_alloc(key);
7218 clear_tv(&tvkey);
7219 if (item != NULL)
7221 item->di_tv = tv;
7222 item->di_tv.v_lock = 0;
7223 if (dict_add(d, item) == FAIL)
7224 dictitem_free(item);
7228 if (**arg == '}')
7229 break;
7230 if (**arg != ',')
7232 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7233 goto failret;
7235 *arg = skipwhite(*arg + 1);
7238 if (**arg != '}')
7240 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7241 failret:
7242 if (evaluate)
7243 dict_free(d, TRUE);
7244 return FAIL;
7247 *arg = skipwhite(*arg + 1);
7248 if (evaluate)
7250 rettv->v_type = VAR_DICT;
7251 rettv->vval.v_dict = d;
7252 ++d->dv_refcount;
7255 return OK;
7259 * Return a string with the string representation of a variable.
7260 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7261 * "numbuf" is used for a number.
7262 * Does not put quotes around strings, as ":echo" displays values.
7263 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7264 * May return NULL.
7266 static char_u *
7267 echo_string(tv, tofree, numbuf, copyID)
7268 typval_T *tv;
7269 char_u **tofree;
7270 char_u *numbuf;
7271 int copyID;
7273 static int recurse = 0;
7274 char_u *r = NULL;
7276 if (recurse >= DICT_MAXNEST)
7278 EMSG(_("E724: variable nested too deep for displaying"));
7279 *tofree = NULL;
7280 return NULL;
7282 ++recurse;
7284 switch (tv->v_type)
7286 case VAR_FUNC:
7287 *tofree = NULL;
7288 r = tv->vval.v_string;
7289 break;
7291 case VAR_LIST:
7292 if (tv->vval.v_list == NULL)
7294 *tofree = NULL;
7295 r = NULL;
7297 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7299 *tofree = NULL;
7300 r = (char_u *)"[...]";
7302 else
7304 tv->vval.v_list->lv_copyID = copyID;
7305 *tofree = list2string(tv, copyID);
7306 r = *tofree;
7308 break;
7310 case VAR_DICT:
7311 if (tv->vval.v_dict == NULL)
7313 *tofree = NULL;
7314 r = NULL;
7316 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7318 *tofree = NULL;
7319 r = (char_u *)"{...}";
7321 else
7323 tv->vval.v_dict->dv_copyID = copyID;
7324 *tofree = dict2string(tv, copyID);
7325 r = *tofree;
7327 break;
7329 case VAR_STRING:
7330 case VAR_NUMBER:
7331 *tofree = NULL;
7332 r = get_tv_string_buf(tv, numbuf);
7333 break;
7335 #ifdef FEAT_FLOAT
7336 case VAR_FLOAT:
7337 *tofree = NULL;
7338 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7339 r = numbuf;
7340 break;
7341 #endif
7343 default:
7344 EMSG2(_(e_intern2), "echo_string()");
7345 *tofree = NULL;
7348 --recurse;
7349 return r;
7353 * Return a string with the string representation of a variable.
7354 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7355 * "numbuf" is used for a number.
7356 * Puts quotes around strings, so that they can be parsed back by eval().
7357 * May return NULL.
7359 static char_u *
7360 tv2string(tv, tofree, numbuf, copyID)
7361 typval_T *tv;
7362 char_u **tofree;
7363 char_u *numbuf;
7364 int copyID;
7366 switch (tv->v_type)
7368 case VAR_FUNC:
7369 *tofree = string_quote(tv->vval.v_string, TRUE);
7370 return *tofree;
7371 case VAR_STRING:
7372 *tofree = string_quote(tv->vval.v_string, FALSE);
7373 return *tofree;
7374 #ifdef FEAT_FLOAT
7375 case VAR_FLOAT:
7376 *tofree = NULL;
7377 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7378 return numbuf;
7379 #endif
7380 case VAR_NUMBER:
7381 case VAR_LIST:
7382 case VAR_DICT:
7383 break;
7384 default:
7385 EMSG2(_(e_intern2), "tv2string()");
7387 return echo_string(tv, tofree, numbuf, copyID);
7391 * Return string "str" in ' quotes, doubling ' characters.
7392 * If "str" is NULL an empty string is assumed.
7393 * If "function" is TRUE make it function('string').
7395 static char_u *
7396 string_quote(str, function)
7397 char_u *str;
7398 int function;
7400 unsigned len;
7401 char_u *p, *r, *s;
7403 len = (function ? 13 : 3);
7404 if (str != NULL)
7406 len += (unsigned)STRLEN(str);
7407 for (p = str; *p != NUL; mb_ptr_adv(p))
7408 if (*p == '\'')
7409 ++len;
7411 s = r = alloc(len);
7412 if (r != NULL)
7414 if (function)
7416 STRCPY(r, "function('");
7417 r += 10;
7419 else
7420 *r++ = '\'';
7421 if (str != NULL)
7422 for (p = str; *p != NUL; )
7424 if (*p == '\'')
7425 *r++ = '\'';
7426 MB_COPY_CHAR(p, r);
7428 *r++ = '\'';
7429 if (function)
7430 *r++ = ')';
7431 *r++ = NUL;
7433 return s;
7436 #ifdef FEAT_FLOAT
7438 * Convert the string "text" to a floating point number.
7439 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7440 * this always uses a decimal point.
7441 * Returns the length of the text that was consumed.
7443 static int
7444 string2float(text, value)
7445 char_u *text;
7446 float_T *value; /* result stored here */
7448 char *s = (char *)text;
7449 float_T f;
7451 f = strtod(s, &s);
7452 *value = f;
7453 return (int)((char_u *)s - text);
7455 #endif
7458 * Get the value of an environment variable.
7459 * "arg" is pointing to the '$'. It is advanced to after the name.
7460 * If the environment variable was not set, silently assume it is empty.
7461 * Always return OK.
7463 static int
7464 get_env_tv(arg, rettv, evaluate)
7465 char_u **arg;
7466 typval_T *rettv;
7467 int evaluate;
7469 char_u *string = NULL;
7470 int len;
7471 int cc;
7472 char_u *name;
7473 int mustfree = FALSE;
7475 ++*arg;
7476 name = *arg;
7477 len = get_env_len(arg);
7478 if (evaluate)
7480 if (len != 0)
7482 cc = name[len];
7483 name[len] = NUL;
7484 /* first try vim_getenv(), fast for normal environment vars */
7485 string = vim_getenv(name, &mustfree);
7486 if (string != NULL && *string != NUL)
7488 if (!mustfree)
7489 string = vim_strsave(string);
7491 else
7493 if (mustfree)
7494 vim_free(string);
7496 /* next try expanding things like $VIM and ${HOME} */
7497 string = expand_env_save(name - 1);
7498 if (string != NULL && *string == '$')
7500 vim_free(string);
7501 string = NULL;
7504 name[len] = cc;
7506 rettv->v_type = VAR_STRING;
7507 rettv->vval.v_string = string;
7510 return OK;
7514 * Array with names and number of arguments of all internal functions
7515 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7517 static struct fst
7519 char *f_name; /* function name */
7520 char f_min_argc; /* minimal number of arguments */
7521 char f_max_argc; /* maximal number of arguments */
7522 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7523 /* implementation of function */
7524 } functions[] =
7526 #ifdef FEAT_FLOAT
7527 {"abs", 1, 1, f_abs},
7528 #endif
7529 {"add", 2, 2, f_add},
7530 {"append", 2, 2, f_append},
7531 {"argc", 0, 0, f_argc},
7532 {"argidx", 0, 0, f_argidx},
7533 {"argv", 0, 1, f_argv},
7534 #ifdef FEAT_FLOAT
7535 {"atan", 1, 1, f_atan},
7536 #endif
7537 {"browse", 4, 4, f_browse},
7538 {"browsedir", 2, 2, f_browsedir},
7539 {"bufexists", 1, 1, f_bufexists},
7540 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7541 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7542 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7543 {"buflisted", 1, 1, f_buflisted},
7544 {"bufloaded", 1, 1, f_bufloaded},
7545 {"bufname", 1, 1, f_bufname},
7546 {"bufnr", 1, 2, f_bufnr},
7547 {"bufwinnr", 1, 1, f_bufwinnr},
7548 {"byte2line", 1, 1, f_byte2line},
7549 {"byteidx", 2, 2, f_byteidx},
7550 {"call", 2, 3, f_call},
7551 #ifdef FEAT_FLOAT
7552 {"ceil", 1, 1, f_ceil},
7553 #endif
7554 {"changenr", 0, 0, f_changenr},
7555 {"char2nr", 1, 1, f_char2nr},
7556 {"cindent", 1, 1, f_cindent},
7557 {"clearmatches", 0, 0, f_clearmatches},
7558 {"col", 1, 1, f_col},
7559 #if defined(FEAT_INS_EXPAND)
7560 {"complete", 2, 2, f_complete},
7561 {"complete_add", 1, 1, f_complete_add},
7562 {"complete_check", 0, 0, f_complete_check},
7563 #endif
7564 {"confirm", 1, 4, f_confirm},
7565 {"copy", 1, 1, f_copy},
7566 #ifdef FEAT_FLOAT
7567 {"cos", 1, 1, f_cos},
7568 #endif
7569 {"count", 2, 4, f_count},
7570 {"cscope_connection",0,3, f_cscope_connection},
7571 {"cursor", 1, 3, f_cursor},
7572 {"deepcopy", 1, 2, f_deepcopy},
7573 {"delete", 1, 1, f_delete},
7574 {"did_filetype", 0, 0, f_did_filetype},
7575 {"diff_filler", 1, 1, f_diff_filler},
7576 {"diff_hlID", 2, 2, f_diff_hlID},
7577 {"empty", 1, 1, f_empty},
7578 {"escape", 2, 2, f_escape},
7579 {"eval", 1, 1, f_eval},
7580 {"eventhandler", 0, 0, f_eventhandler},
7581 {"executable", 1, 1, f_executable},
7582 {"exists", 1, 1, f_exists},
7583 {"expand", 1, 2, f_expand},
7584 {"extend", 2, 3, f_extend},
7585 {"feedkeys", 1, 2, f_feedkeys},
7586 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7587 {"filereadable", 1, 1, f_filereadable},
7588 {"filewritable", 1, 1, f_filewritable},
7589 {"filter", 2, 2, f_filter},
7590 {"finddir", 1, 3, f_finddir},
7591 {"findfile", 1, 3, f_findfile},
7592 #ifdef FEAT_FLOAT
7593 {"float2nr", 1, 1, f_float2nr},
7594 {"floor", 1, 1, f_floor},
7595 #endif
7596 {"fnameescape", 1, 1, f_fnameescape},
7597 {"fnamemodify", 2, 2, f_fnamemodify},
7598 {"foldclosed", 1, 1, f_foldclosed},
7599 {"foldclosedend", 1, 1, f_foldclosedend},
7600 {"foldlevel", 1, 1, f_foldlevel},
7601 {"foldtext", 0, 0, f_foldtext},
7602 {"foldtextresult", 1, 1, f_foldtextresult},
7603 {"foreground", 0, 0, f_foreground},
7604 {"function", 1, 1, f_function},
7605 {"garbagecollect", 0, 1, f_garbagecollect},
7606 {"get", 2, 3, f_get},
7607 {"getbufline", 2, 3, f_getbufline},
7608 {"getbufvar", 2, 2, f_getbufvar},
7609 {"getchar", 0, 1, f_getchar},
7610 {"getcharmod", 0, 0, f_getcharmod},
7611 {"getcmdline", 0, 0, f_getcmdline},
7612 {"getcmdpos", 0, 0, f_getcmdpos},
7613 {"getcmdtype", 0, 0, f_getcmdtype},
7614 {"getcwd", 0, 0, f_getcwd},
7615 {"getfontname", 0, 1, f_getfontname},
7616 {"getfperm", 1, 1, f_getfperm},
7617 {"getfsize", 1, 1, f_getfsize},
7618 {"getftime", 1, 1, f_getftime},
7619 {"getftype", 1, 1, f_getftype},
7620 {"getline", 1, 2, f_getline},
7621 {"getloclist", 1, 1, f_getqflist},
7622 {"getmatches", 0, 0, f_getmatches},
7623 {"getpid", 0, 0, f_getpid},
7624 {"getpos", 1, 1, f_getpos},
7625 {"getqflist", 0, 0, f_getqflist},
7626 {"getreg", 0, 2, f_getreg},
7627 {"getregtype", 0, 1, f_getregtype},
7628 {"gettabwinvar", 3, 3, f_gettabwinvar},
7629 {"getwinposx", 0, 0, f_getwinposx},
7630 {"getwinposy", 0, 0, f_getwinposy},
7631 {"getwinvar", 2, 2, f_getwinvar},
7632 {"glob", 1, 2, f_glob},
7633 {"globpath", 2, 3, f_globpath},
7634 {"has", 1, 1, f_has},
7635 {"has_key", 2, 2, f_has_key},
7636 {"haslocaldir", 0, 0, f_haslocaldir},
7637 {"hasmapto", 1, 3, f_hasmapto},
7638 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7639 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7640 {"histadd", 2, 2, f_histadd},
7641 {"histdel", 1, 2, f_histdel},
7642 {"histget", 1, 2, f_histget},
7643 {"histnr", 1, 1, f_histnr},
7644 {"hlID", 1, 1, f_hlID},
7645 {"hlexists", 1, 1, f_hlexists},
7646 {"hostname", 0, 0, f_hostname},
7647 {"iconv", 3, 3, f_iconv},
7648 {"indent", 1, 1, f_indent},
7649 {"index", 2, 4, f_index},
7650 {"input", 1, 3, f_input},
7651 {"inputdialog", 1, 3, f_inputdialog},
7652 {"inputlist", 1, 1, f_inputlist},
7653 {"inputrestore", 0, 0, f_inputrestore},
7654 {"inputsave", 0, 0, f_inputsave},
7655 {"inputsecret", 1, 2, f_inputsecret},
7656 {"insert", 2, 3, f_insert},
7657 {"isdirectory", 1, 1, f_isdirectory},
7658 {"islocked", 1, 1, f_islocked},
7659 {"items", 1, 1, f_items},
7660 {"join", 1, 2, f_join},
7661 {"keys", 1, 1, f_keys},
7662 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7663 {"len", 1, 1, f_len},
7664 {"libcall", 3, 3, f_libcall},
7665 {"libcallnr", 3, 3, f_libcallnr},
7666 {"line", 1, 1, f_line},
7667 {"line2byte", 1, 1, f_line2byte},
7668 {"lispindent", 1, 1, f_lispindent},
7669 {"localtime", 0, 0, f_localtime},
7670 #ifdef FEAT_FLOAT
7671 {"log10", 1, 1, f_log10},
7672 #endif
7673 {"map", 2, 2, f_map},
7674 {"maparg", 1, 3, f_maparg},
7675 {"mapcheck", 1, 3, f_mapcheck},
7676 {"match", 2, 4, f_match},
7677 {"matchadd", 2, 4, f_matchadd},
7678 {"matcharg", 1, 1, f_matcharg},
7679 {"matchdelete", 1, 1, f_matchdelete},
7680 {"matchend", 2, 4, f_matchend},
7681 {"matchlist", 2, 4, f_matchlist},
7682 {"matchstr", 2, 4, f_matchstr},
7683 {"max", 1, 1, f_max},
7684 {"min", 1, 1, f_min},
7685 #ifdef vim_mkdir
7686 {"mkdir", 1, 3, f_mkdir},
7687 #endif
7688 {"mode", 0, 1, f_mode},
7689 {"nextnonblank", 1, 1, f_nextnonblank},
7690 {"nr2char", 1, 1, f_nr2char},
7691 {"pathshorten", 1, 1, f_pathshorten},
7692 #ifdef FEAT_FLOAT
7693 {"pow", 2, 2, f_pow},
7694 #endif
7695 {"prevnonblank", 1, 1, f_prevnonblank},
7696 {"printf", 2, 19, f_printf},
7697 {"pumvisible", 0, 0, f_pumvisible},
7698 {"range", 1, 3, f_range},
7699 {"readfile", 1, 3, f_readfile},
7700 {"reltime", 0, 2, f_reltime},
7701 {"reltimestr", 1, 1, f_reltimestr},
7702 {"remote_expr", 2, 3, f_remote_expr},
7703 {"remote_foreground", 1, 1, f_remote_foreground},
7704 {"remote_peek", 1, 2, f_remote_peek},
7705 {"remote_read", 1, 1, f_remote_read},
7706 {"remote_send", 2, 3, f_remote_send},
7707 {"remove", 2, 3, f_remove},
7708 {"rename", 2, 2, f_rename},
7709 {"repeat", 2, 2, f_repeat},
7710 {"resolve", 1, 1, f_resolve},
7711 {"reverse", 1, 1, f_reverse},
7712 #ifdef FEAT_FLOAT
7713 {"round", 1, 1, f_round},
7714 #endif
7715 {"search", 1, 4, f_search},
7716 {"searchdecl", 1, 3, f_searchdecl},
7717 {"searchpair", 3, 7, f_searchpair},
7718 {"searchpairpos", 3, 7, f_searchpairpos},
7719 {"searchpos", 1, 4, f_searchpos},
7720 {"server2client", 2, 2, f_server2client},
7721 {"serverlist", 0, 0, f_serverlist},
7722 {"setbufvar", 3, 3, f_setbufvar},
7723 {"setcmdpos", 1, 1, f_setcmdpos},
7724 {"setline", 2, 2, f_setline},
7725 {"setloclist", 2, 3, f_setloclist},
7726 {"setmatches", 1, 1, f_setmatches},
7727 {"setpos", 2, 2, f_setpos},
7728 {"setqflist", 1, 2, f_setqflist},
7729 {"setreg", 2, 3, f_setreg},
7730 {"settabwinvar", 4, 4, f_settabwinvar},
7731 {"setwinvar", 3, 3, f_setwinvar},
7732 {"shellescape", 1, 2, f_shellescape},
7733 {"simplify", 1, 1, f_simplify},
7734 #ifdef FEAT_FLOAT
7735 {"sin", 1, 1, f_sin},
7736 #endif
7737 {"sort", 1, 2, f_sort},
7738 {"soundfold", 1, 1, f_soundfold},
7739 {"spellbadword", 0, 1, f_spellbadword},
7740 {"spellsuggest", 1, 3, f_spellsuggest},
7741 {"split", 1, 3, f_split},
7742 #ifdef FEAT_FLOAT
7743 {"sqrt", 1, 1, f_sqrt},
7744 {"str2float", 1, 1, f_str2float},
7745 #endif
7746 {"str2nr", 1, 2, f_str2nr},
7747 #ifdef HAVE_STRFTIME
7748 {"strftime", 1, 2, f_strftime},
7749 #endif
7750 {"stridx", 2, 3, f_stridx},
7751 {"string", 1, 1, f_string},
7752 {"strlen", 1, 1, f_strlen},
7753 {"strpart", 2, 3, f_strpart},
7754 {"strridx", 2, 3, f_strridx},
7755 {"strtrans", 1, 1, f_strtrans},
7756 {"submatch", 1, 1, f_submatch},
7757 {"substitute", 4, 4, f_substitute},
7758 {"synID", 3, 3, f_synID},
7759 {"synIDattr", 2, 3, f_synIDattr},
7760 {"synIDtrans", 1, 1, f_synIDtrans},
7761 {"synstack", 2, 2, f_synstack},
7762 {"system", 1, 2, f_system},
7763 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7764 {"tabpagenr", 0, 1, f_tabpagenr},
7765 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7766 {"tagfiles", 0, 0, f_tagfiles},
7767 {"taglist", 1, 1, f_taglist},
7768 {"tempname", 0, 0, f_tempname},
7769 {"test", 1, 1, f_test},
7770 {"tolower", 1, 1, f_tolower},
7771 {"toupper", 1, 1, f_toupper},
7772 {"tr", 3, 3, f_tr},
7773 #ifdef FEAT_FLOAT
7774 {"trunc", 1, 1, f_trunc},
7775 #endif
7776 {"type", 1, 1, f_type},
7777 {"values", 1, 1, f_values},
7778 {"virtcol", 1, 1, f_virtcol},
7779 {"visualmode", 0, 1, f_visualmode},
7780 {"winbufnr", 1, 1, f_winbufnr},
7781 {"wincol", 0, 0, f_wincol},
7782 {"winheight", 1, 1, f_winheight},
7783 {"winline", 0, 0, f_winline},
7784 {"winnr", 0, 1, f_winnr},
7785 {"winrestcmd", 0, 0, f_winrestcmd},
7786 {"winrestview", 1, 1, f_winrestview},
7787 {"winsaveview", 0, 0, f_winsaveview},
7788 {"winwidth", 1, 1, f_winwidth},
7789 {"writefile", 2, 3, f_writefile},
7792 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7795 * Function given to ExpandGeneric() to obtain the list of internal
7796 * or user defined function names.
7798 char_u *
7799 get_function_name(xp, idx)
7800 expand_T *xp;
7801 int idx;
7803 static int intidx = -1;
7804 char_u *name;
7806 if (idx == 0)
7807 intidx = -1;
7808 if (intidx < 0)
7810 name = get_user_func_name(xp, idx);
7811 if (name != NULL)
7812 return name;
7814 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7816 STRCPY(IObuff, functions[intidx].f_name);
7817 STRCAT(IObuff, "(");
7818 if (functions[intidx].f_max_argc == 0)
7819 STRCAT(IObuff, ")");
7820 return IObuff;
7823 return NULL;
7827 * Function given to ExpandGeneric() to obtain the list of internal or
7828 * user defined variable or function names.
7830 char_u *
7831 get_expr_name(xp, idx)
7832 expand_T *xp;
7833 int idx;
7835 static int intidx = -1;
7836 char_u *name;
7838 if (idx == 0)
7839 intidx = -1;
7840 if (intidx < 0)
7842 name = get_function_name(xp, idx);
7843 if (name != NULL)
7844 return name;
7846 return get_user_var_name(xp, ++intidx);
7849 #endif /* FEAT_CMDL_COMPL */
7852 * Find internal function in table above.
7853 * Return index, or -1 if not found
7855 static int
7856 find_internal_func(name)
7857 char_u *name; /* name of the function */
7859 int first = 0;
7860 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7861 int cmp;
7862 int x;
7865 * Find the function name in the table. Binary search.
7867 while (first <= last)
7869 x = first + ((unsigned)(last - first) >> 1);
7870 cmp = STRCMP(name, functions[x].f_name);
7871 if (cmp < 0)
7872 last = x - 1;
7873 else if (cmp > 0)
7874 first = x + 1;
7875 else
7876 return x;
7878 return -1;
7882 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7883 * name it contains, otherwise return "name".
7885 static char_u *
7886 deref_func_name(name, lenp)
7887 char_u *name;
7888 int *lenp;
7890 dictitem_T *v;
7891 int cc;
7893 cc = name[*lenp];
7894 name[*lenp] = NUL;
7895 v = find_var(name, NULL);
7896 name[*lenp] = cc;
7897 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7899 if (v->di_tv.vval.v_string == NULL)
7901 *lenp = 0;
7902 return (char_u *)""; /* just in case */
7904 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7905 return v->di_tv.vval.v_string;
7908 return name;
7912 * Allocate a variable for the result of a function.
7913 * Return OK or FAIL.
7915 static int
7916 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7917 evaluate, selfdict)
7918 char_u *name; /* name of the function */
7919 int len; /* length of "name" */
7920 typval_T *rettv;
7921 char_u **arg; /* argument, pointing to the '(' */
7922 linenr_T firstline; /* first line of range */
7923 linenr_T lastline; /* last line of range */
7924 int *doesrange; /* return: function handled range */
7925 int evaluate;
7926 dict_T *selfdict; /* Dictionary for "self" */
7928 char_u *argp;
7929 int ret = OK;
7930 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7931 int argcount = 0; /* number of arguments found */
7934 * Get the arguments.
7936 argp = *arg;
7937 while (argcount < MAX_FUNC_ARGS)
7939 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7940 if (*argp == ')' || *argp == ',' || *argp == NUL)
7941 break;
7942 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7944 ret = FAIL;
7945 break;
7947 ++argcount;
7948 if (*argp != ',')
7949 break;
7951 if (*argp == ')')
7952 ++argp;
7953 else
7954 ret = FAIL;
7956 if (ret == OK)
7957 ret = call_func(name, len, rettv, argcount, argvars,
7958 firstline, lastline, doesrange, evaluate, selfdict);
7959 else if (!aborting())
7961 if (argcount == MAX_FUNC_ARGS)
7962 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
7963 else
7964 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
7967 while (--argcount >= 0)
7968 clear_tv(&argvars[argcount]);
7970 *arg = skipwhite(argp);
7971 return ret;
7976 * Call a function with its resolved parameters
7977 * Return OK when the function can't be called, FAIL otherwise.
7978 * Also returns OK when an error was encountered while executing the function.
7980 static int
7981 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7982 doesrange, evaluate, selfdict)
7983 char_u *name; /* name of the function */
7984 int len; /* length of "name" */
7985 typval_T *rettv; /* return value goes here */
7986 int argcount; /* number of "argvars" */
7987 typval_T *argvars; /* vars for arguments, must have "argcount"
7988 PLUS ONE elements! */
7989 linenr_T firstline; /* first line of range */
7990 linenr_T lastline; /* last line of range */
7991 int *doesrange; /* return: function handled range */
7992 int evaluate;
7993 dict_T *selfdict; /* Dictionary for "self" */
7995 int ret = FAIL;
7996 #define ERROR_UNKNOWN 0
7997 #define ERROR_TOOMANY 1
7998 #define ERROR_TOOFEW 2
7999 #define ERROR_SCRIPT 3
8000 #define ERROR_DICT 4
8001 #define ERROR_NONE 5
8002 #define ERROR_OTHER 6
8003 int error = ERROR_NONE;
8004 int i;
8005 int llen;
8006 ufunc_T *fp;
8007 int cc;
8008 #define FLEN_FIXED 40
8009 char_u fname_buf[FLEN_FIXED + 1];
8010 char_u *fname;
8013 * In a script change <SID>name() and s:name() to K_SNR 123_name().
8014 * Change <SNR>123_name() to K_SNR 123_name().
8015 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
8017 cc = name[len];
8018 name[len] = NUL;
8019 llen = eval_fname_script(name);
8020 if (llen > 0)
8022 fname_buf[0] = K_SPECIAL;
8023 fname_buf[1] = KS_EXTRA;
8024 fname_buf[2] = (int)KE_SNR;
8025 i = 3;
8026 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
8028 if (current_SID <= 0)
8029 error = ERROR_SCRIPT;
8030 else
8032 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
8033 i = (int)STRLEN(fname_buf);
8036 if (i + STRLEN(name + llen) < FLEN_FIXED)
8038 STRCPY(fname_buf + i, name + llen);
8039 fname = fname_buf;
8041 else
8043 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8044 if (fname == NULL)
8045 error = ERROR_OTHER;
8046 else
8048 mch_memmove(fname, fname_buf, (size_t)i);
8049 STRCPY(fname + i, name + llen);
8053 else
8054 fname = name;
8056 *doesrange = FALSE;
8059 /* execute the function if no errors detected and executing */
8060 if (evaluate && error == ERROR_NONE)
8062 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */
8063 rettv->vval.v_number = 0;
8064 error = ERROR_UNKNOWN;
8066 if (!builtin_function(fname))
8069 * User defined function.
8071 fp = find_func(fname);
8073 #ifdef FEAT_AUTOCMD
8074 /* Trigger FuncUndefined event, may load the function. */
8075 if (fp == NULL
8076 && apply_autocmds(EVENT_FUNCUNDEFINED,
8077 fname, fname, TRUE, NULL)
8078 && !aborting())
8080 /* executed an autocommand, search for the function again */
8081 fp = find_func(fname);
8083 #endif
8084 /* Try loading a package. */
8085 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8087 /* loaded a package, search for the function again */
8088 fp = find_func(fname);
8091 if (fp != NULL)
8093 if (fp->uf_flags & FC_RANGE)
8094 *doesrange = TRUE;
8095 if (argcount < fp->uf_args.ga_len)
8096 error = ERROR_TOOFEW;
8097 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8098 error = ERROR_TOOMANY;
8099 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8100 error = ERROR_DICT;
8101 else
8104 * Call the user function.
8105 * Save and restore search patterns, script variables and
8106 * redo buffer.
8108 save_search_patterns();
8109 saveRedobuff();
8110 ++fp->uf_calls;
8111 call_user_func(fp, argcount, argvars, rettv,
8112 firstline, lastline,
8113 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8114 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8115 && fp->uf_refcount <= 0)
8116 /* Function was unreferenced while being used, free it
8117 * now. */
8118 func_free(fp);
8119 restoreRedobuff();
8120 restore_search_patterns();
8121 error = ERROR_NONE;
8125 else
8128 * Find the function name in the table, call its implementation.
8130 i = find_internal_func(fname);
8131 if (i >= 0)
8133 if (argcount < functions[i].f_min_argc)
8134 error = ERROR_TOOFEW;
8135 else if (argcount > functions[i].f_max_argc)
8136 error = ERROR_TOOMANY;
8137 else
8139 argvars[argcount].v_type = VAR_UNKNOWN;
8140 functions[i].f_func(argvars, rettv);
8141 error = ERROR_NONE;
8146 * The function call (or "FuncUndefined" autocommand sequence) might
8147 * have been aborted by an error, an interrupt, or an explicitly thrown
8148 * exception that has not been caught so far. This situation can be
8149 * tested for by calling aborting(). For an error in an internal
8150 * function or for the "E132" error in call_user_func(), however, the
8151 * throw point at which the "force_abort" flag (temporarily reset by
8152 * emsg()) is normally updated has not been reached yet. We need to
8153 * update that flag first to make aborting() reliable.
8155 update_force_abort();
8157 if (error == ERROR_NONE)
8158 ret = OK;
8161 * Report an error unless the argument evaluation or function call has been
8162 * cancelled due to an aborting error, an interrupt, or an exception.
8164 if (!aborting())
8166 switch (error)
8168 case ERROR_UNKNOWN:
8169 emsg_funcname(N_("E117: Unknown function: %s"), name);
8170 break;
8171 case ERROR_TOOMANY:
8172 emsg_funcname(e_toomanyarg, name);
8173 break;
8174 case ERROR_TOOFEW:
8175 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8176 name);
8177 break;
8178 case ERROR_SCRIPT:
8179 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8180 name);
8181 break;
8182 case ERROR_DICT:
8183 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8184 name);
8185 break;
8189 name[len] = cc;
8190 if (fname != name && fname != fname_buf)
8191 vim_free(fname);
8193 return ret;
8197 * Give an error message with a function name. Handle <SNR> things.
8198 * "ermsg" is to be passed without translation, use N_() instead of _().
8200 static void
8201 emsg_funcname(ermsg, name)
8202 char *ermsg;
8203 char_u *name;
8205 char_u *p;
8207 if (*name == K_SPECIAL)
8208 p = concat_str((char_u *)"<SNR>", name + 3);
8209 else
8210 p = name;
8211 EMSG2(_(ermsg), p);
8212 if (p != name)
8213 vim_free(p);
8217 * Return TRUE for a non-zero Number and a non-empty String.
8219 static int
8220 non_zero_arg(argvars)
8221 typval_T *argvars;
8223 return ((argvars[0].v_type == VAR_NUMBER
8224 && argvars[0].vval.v_number != 0)
8225 || (argvars[0].v_type == VAR_STRING
8226 && argvars[0].vval.v_string != NULL
8227 && *argvars[0].vval.v_string != NUL));
8230 /*********************************************
8231 * Implementation of the built-in functions
8234 #ifdef FEAT_FLOAT
8236 * "abs(expr)" function
8238 static void
8239 f_abs(argvars, rettv)
8240 typval_T *argvars;
8241 typval_T *rettv;
8243 if (argvars[0].v_type == VAR_FLOAT)
8245 rettv->v_type = VAR_FLOAT;
8246 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8248 else
8250 varnumber_T n;
8251 int error = FALSE;
8253 n = get_tv_number_chk(&argvars[0], &error);
8254 if (error)
8255 rettv->vval.v_number = -1;
8256 else if (n > 0)
8257 rettv->vval.v_number = n;
8258 else
8259 rettv->vval.v_number = -n;
8262 #endif
8265 * "add(list, item)" function
8267 static void
8268 f_add(argvars, rettv)
8269 typval_T *argvars;
8270 typval_T *rettv;
8272 list_T *l;
8274 rettv->vval.v_number = 1; /* Default: Failed */
8275 if (argvars[0].v_type == VAR_LIST)
8277 if ((l = argvars[0].vval.v_list) != NULL
8278 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8279 && list_append_tv(l, &argvars[1]) == OK)
8280 copy_tv(&argvars[0], rettv);
8282 else
8283 EMSG(_(e_listreq));
8287 * "append(lnum, string/list)" function
8289 static void
8290 f_append(argvars, rettv)
8291 typval_T *argvars;
8292 typval_T *rettv;
8294 long lnum;
8295 char_u *line;
8296 list_T *l = NULL;
8297 listitem_T *li = NULL;
8298 typval_T *tv;
8299 long added = 0;
8301 lnum = get_tv_lnum(argvars);
8302 if (lnum >= 0
8303 && lnum <= curbuf->b_ml.ml_line_count
8304 && u_save(lnum, lnum + 1) == OK)
8306 if (argvars[1].v_type == VAR_LIST)
8308 l = argvars[1].vval.v_list;
8309 if (l == NULL)
8310 return;
8311 li = l->lv_first;
8313 for (;;)
8315 if (l == NULL)
8316 tv = &argvars[1]; /* append a string */
8317 else if (li == NULL)
8318 break; /* end of list */
8319 else
8320 tv = &li->li_tv; /* append item from list */
8321 line = get_tv_string_chk(tv);
8322 if (line == NULL) /* type error */
8324 rettv->vval.v_number = 1; /* Failed */
8325 break;
8327 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8328 ++added;
8329 if (l == NULL)
8330 break;
8331 li = li->li_next;
8334 appended_lines_mark(lnum, added);
8335 if (curwin->w_cursor.lnum > lnum)
8336 curwin->w_cursor.lnum += added;
8338 else
8339 rettv->vval.v_number = 1; /* Failed */
8343 * "argc()" function
8345 static void
8346 f_argc(argvars, rettv)
8347 typval_T *argvars UNUSED;
8348 typval_T *rettv;
8350 rettv->vval.v_number = ARGCOUNT;
8354 * "argidx()" function
8356 static void
8357 f_argidx(argvars, rettv)
8358 typval_T *argvars UNUSED;
8359 typval_T *rettv;
8361 rettv->vval.v_number = curwin->w_arg_idx;
8365 * "argv(nr)" function
8367 static void
8368 f_argv(argvars, rettv)
8369 typval_T *argvars;
8370 typval_T *rettv;
8372 int idx;
8374 if (argvars[0].v_type != VAR_UNKNOWN)
8376 idx = get_tv_number_chk(&argvars[0], NULL);
8377 if (idx >= 0 && idx < ARGCOUNT)
8378 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8379 else
8380 rettv->vval.v_string = NULL;
8381 rettv->v_type = VAR_STRING;
8383 else if (rettv_list_alloc(rettv) == OK)
8384 for (idx = 0; idx < ARGCOUNT; ++idx)
8385 list_append_string(rettv->vval.v_list,
8386 alist_name(&ARGLIST[idx]), -1);
8389 #ifdef FEAT_FLOAT
8390 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8393 * Get the float value of "argvars[0]" into "f".
8394 * Returns FAIL when the argument is not a Number or Float.
8396 static int
8397 get_float_arg(argvars, f)
8398 typval_T *argvars;
8399 float_T *f;
8401 if (argvars[0].v_type == VAR_FLOAT)
8403 *f = argvars[0].vval.v_float;
8404 return OK;
8406 if (argvars[0].v_type == VAR_NUMBER)
8408 *f = (float_T)argvars[0].vval.v_number;
8409 return OK;
8411 EMSG(_("E808: Number or Float required"));
8412 return FAIL;
8416 * "atan()" function
8418 static void
8419 f_atan(argvars, rettv)
8420 typval_T *argvars;
8421 typval_T *rettv;
8423 float_T f;
8425 rettv->v_type = VAR_FLOAT;
8426 if (get_float_arg(argvars, &f) == OK)
8427 rettv->vval.v_float = atan(f);
8428 else
8429 rettv->vval.v_float = 0.0;
8431 #endif
8434 * "browse(save, title, initdir, default)" function
8436 static void
8437 f_browse(argvars, rettv)
8438 typval_T *argvars UNUSED;
8439 typval_T *rettv;
8441 #ifdef FEAT_BROWSE
8442 int save;
8443 char_u *title;
8444 char_u *initdir;
8445 char_u *defname;
8446 char_u buf[NUMBUFLEN];
8447 char_u buf2[NUMBUFLEN];
8448 int error = FALSE;
8450 save = get_tv_number_chk(&argvars[0], &error);
8451 title = get_tv_string_chk(&argvars[1]);
8452 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8453 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8455 if (error || title == NULL || initdir == NULL || defname == NULL)
8456 rettv->vval.v_string = NULL;
8457 else
8458 rettv->vval.v_string =
8459 do_browse(save ? BROWSE_SAVE : 0,
8460 title, defname, NULL, initdir, NULL, curbuf);
8461 #else
8462 rettv->vval.v_string = NULL;
8463 #endif
8464 rettv->v_type = VAR_STRING;
8468 * "browsedir(title, initdir)" function
8470 static void
8471 f_browsedir(argvars, rettv)
8472 typval_T *argvars UNUSED;
8473 typval_T *rettv;
8475 #ifdef FEAT_BROWSE
8476 char_u *title;
8477 char_u *initdir;
8478 char_u buf[NUMBUFLEN];
8480 title = get_tv_string_chk(&argvars[0]);
8481 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8483 if (title == NULL || initdir == NULL)
8484 rettv->vval.v_string = NULL;
8485 else
8486 rettv->vval.v_string = do_browse(BROWSE_DIR,
8487 title, NULL, NULL, initdir, NULL, curbuf);
8488 #else
8489 rettv->vval.v_string = NULL;
8490 #endif
8491 rettv->v_type = VAR_STRING;
8494 static buf_T *find_buffer __ARGS((typval_T *avar));
8497 * Find a buffer by number or exact name.
8499 static buf_T *
8500 find_buffer(avar)
8501 typval_T *avar;
8503 buf_T *buf = NULL;
8505 if (avar->v_type == VAR_NUMBER)
8506 buf = buflist_findnr((int)avar->vval.v_number);
8507 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8509 buf = buflist_findname_exp(avar->vval.v_string);
8510 if (buf == NULL)
8512 /* No full path name match, try a match with a URL or a "nofile"
8513 * buffer, these don't use the full path. */
8514 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8515 if (buf->b_fname != NULL
8516 && (path_with_url(buf->b_fname)
8517 #ifdef FEAT_QUICKFIX
8518 || bt_nofile(buf)
8519 #endif
8521 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8522 break;
8525 return buf;
8529 * "bufexists(expr)" function
8531 static void
8532 f_bufexists(argvars, rettv)
8533 typval_T *argvars;
8534 typval_T *rettv;
8536 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8540 * "buflisted(expr)" function
8542 static void
8543 f_buflisted(argvars, rettv)
8544 typval_T *argvars;
8545 typval_T *rettv;
8547 buf_T *buf;
8549 buf = find_buffer(&argvars[0]);
8550 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8554 * "bufloaded(expr)" function
8556 static void
8557 f_bufloaded(argvars, rettv)
8558 typval_T *argvars;
8559 typval_T *rettv;
8561 buf_T *buf;
8563 buf = find_buffer(&argvars[0]);
8564 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8567 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8570 * Get buffer by number or pattern.
8572 static buf_T *
8573 get_buf_tv(tv)
8574 typval_T *tv;
8576 char_u *name = tv->vval.v_string;
8577 int save_magic;
8578 char_u *save_cpo;
8579 buf_T *buf;
8581 if (tv->v_type == VAR_NUMBER)
8582 return buflist_findnr((int)tv->vval.v_number);
8583 if (tv->v_type != VAR_STRING)
8584 return NULL;
8585 if (name == NULL || *name == NUL)
8586 return curbuf;
8587 if (name[0] == '$' && name[1] == NUL)
8588 return lastbuf;
8590 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8591 save_magic = p_magic;
8592 p_magic = TRUE;
8593 save_cpo = p_cpo;
8594 p_cpo = (char_u *)"";
8596 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8597 TRUE, FALSE));
8599 p_magic = save_magic;
8600 p_cpo = save_cpo;
8602 /* If not found, try expanding the name, like done for bufexists(). */
8603 if (buf == NULL)
8604 buf = find_buffer(tv);
8606 return buf;
8610 * "bufname(expr)" function
8612 static void
8613 f_bufname(argvars, rettv)
8614 typval_T *argvars;
8615 typval_T *rettv;
8617 buf_T *buf;
8619 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8620 ++emsg_off;
8621 buf = get_buf_tv(&argvars[0]);
8622 rettv->v_type = VAR_STRING;
8623 if (buf != NULL && buf->b_fname != NULL)
8624 rettv->vval.v_string = vim_strsave(buf->b_fname);
8625 else
8626 rettv->vval.v_string = NULL;
8627 --emsg_off;
8631 * "bufnr(expr)" function
8633 static void
8634 f_bufnr(argvars, rettv)
8635 typval_T *argvars;
8636 typval_T *rettv;
8638 buf_T *buf;
8639 int error = FALSE;
8640 char_u *name;
8642 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8643 ++emsg_off;
8644 buf = get_buf_tv(&argvars[0]);
8645 --emsg_off;
8647 /* If the buffer isn't found and the second argument is not zero create a
8648 * new buffer. */
8649 if (buf == NULL
8650 && argvars[1].v_type != VAR_UNKNOWN
8651 && get_tv_number_chk(&argvars[1], &error) != 0
8652 && !error
8653 && (name = get_tv_string_chk(&argvars[0])) != NULL
8654 && !error)
8655 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8657 if (buf != NULL)
8658 rettv->vval.v_number = buf->b_fnum;
8659 else
8660 rettv->vval.v_number = -1;
8664 * "bufwinnr(nr)" function
8666 static void
8667 f_bufwinnr(argvars, rettv)
8668 typval_T *argvars;
8669 typval_T *rettv;
8671 #ifdef FEAT_WINDOWS
8672 win_T *wp;
8673 int winnr = 0;
8674 #endif
8675 buf_T *buf;
8677 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8678 ++emsg_off;
8679 buf = get_buf_tv(&argvars[0]);
8680 #ifdef FEAT_WINDOWS
8681 for (wp = firstwin; wp; wp = wp->w_next)
8683 ++winnr;
8684 if (wp->w_buffer == buf)
8685 break;
8687 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8688 #else
8689 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8690 #endif
8691 --emsg_off;
8695 * "byte2line(byte)" function
8697 static void
8698 f_byte2line(argvars, rettv)
8699 typval_T *argvars UNUSED;
8700 typval_T *rettv;
8702 #ifndef FEAT_BYTEOFF
8703 rettv->vval.v_number = -1;
8704 #else
8705 long boff = 0;
8707 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8708 if (boff < 0)
8709 rettv->vval.v_number = -1;
8710 else
8711 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8712 (linenr_T)0, &boff);
8713 #endif
8717 * "byteidx()" function
8719 static void
8720 f_byteidx(argvars, rettv)
8721 typval_T *argvars;
8722 typval_T *rettv;
8724 #ifdef FEAT_MBYTE
8725 char_u *t;
8726 #endif
8727 char_u *str;
8728 long idx;
8730 str = get_tv_string_chk(&argvars[0]);
8731 idx = get_tv_number_chk(&argvars[1], NULL);
8732 rettv->vval.v_number = -1;
8733 if (str == NULL || idx < 0)
8734 return;
8736 #ifdef FEAT_MBYTE
8737 t = str;
8738 for ( ; idx > 0; idx--)
8740 if (*t == NUL) /* EOL reached */
8741 return;
8742 t += (*mb_ptr2len)(t);
8744 rettv->vval.v_number = (varnumber_T)(t - str);
8745 #else
8746 if ((size_t)idx <= STRLEN(str))
8747 rettv->vval.v_number = idx;
8748 #endif
8752 * "call(func, arglist)" function
8754 static void
8755 f_call(argvars, rettv)
8756 typval_T *argvars;
8757 typval_T *rettv;
8759 char_u *func;
8760 typval_T argv[MAX_FUNC_ARGS + 1];
8761 int argc = 0;
8762 listitem_T *item;
8763 int dummy;
8764 dict_T *selfdict = NULL;
8766 if (argvars[1].v_type != VAR_LIST)
8768 EMSG(_(e_listreq));
8769 return;
8771 if (argvars[1].vval.v_list == NULL)
8772 return;
8774 if (argvars[0].v_type == VAR_FUNC)
8775 func = argvars[0].vval.v_string;
8776 else
8777 func = get_tv_string(&argvars[0]);
8778 if (*func == NUL)
8779 return; /* type error or empty name */
8781 if (argvars[2].v_type != VAR_UNKNOWN)
8783 if (argvars[2].v_type != VAR_DICT)
8785 EMSG(_(e_dictreq));
8786 return;
8788 selfdict = argvars[2].vval.v_dict;
8791 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8792 item = item->li_next)
8794 if (argc == MAX_FUNC_ARGS)
8796 EMSG(_("E699: Too many arguments"));
8797 break;
8799 /* Make a copy of each argument. This is needed to be able to set
8800 * v_lock to VAR_FIXED in the copy without changing the original list.
8802 copy_tv(&item->li_tv, &argv[argc++]);
8805 if (item == NULL)
8806 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8807 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8808 &dummy, TRUE, selfdict);
8810 /* Free the arguments. */
8811 while (argc > 0)
8812 clear_tv(&argv[--argc]);
8815 #ifdef FEAT_FLOAT
8817 * "ceil({float})" function
8819 static void
8820 f_ceil(argvars, rettv)
8821 typval_T *argvars;
8822 typval_T *rettv;
8824 float_T f;
8826 rettv->v_type = VAR_FLOAT;
8827 if (get_float_arg(argvars, &f) == OK)
8828 rettv->vval.v_float = ceil(f);
8829 else
8830 rettv->vval.v_float = 0.0;
8832 #endif
8835 * "changenr()" function
8837 static void
8838 f_changenr(argvars, rettv)
8839 typval_T *argvars UNUSED;
8840 typval_T *rettv;
8842 rettv->vval.v_number = curbuf->b_u_seq_cur;
8846 * "char2nr(string)" function
8848 static void
8849 f_char2nr(argvars, rettv)
8850 typval_T *argvars;
8851 typval_T *rettv;
8853 #ifdef FEAT_MBYTE
8854 if (has_mbyte)
8855 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8856 else
8857 #endif
8858 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8862 * "cindent(lnum)" function
8864 static void
8865 f_cindent(argvars, rettv)
8866 typval_T *argvars;
8867 typval_T *rettv;
8869 #ifdef FEAT_CINDENT
8870 pos_T pos;
8871 linenr_T lnum;
8873 pos = curwin->w_cursor;
8874 lnum = get_tv_lnum(argvars);
8875 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8877 curwin->w_cursor.lnum = lnum;
8878 rettv->vval.v_number = get_c_indent();
8879 curwin->w_cursor = pos;
8881 else
8882 #endif
8883 rettv->vval.v_number = -1;
8887 * "clearmatches()" function
8889 static void
8890 f_clearmatches(argvars, rettv)
8891 typval_T *argvars UNUSED;
8892 typval_T *rettv UNUSED;
8894 #ifdef FEAT_SEARCH_EXTRA
8895 clear_matches(curwin);
8896 #endif
8900 * "col(string)" function
8902 static void
8903 f_col(argvars, rettv)
8904 typval_T *argvars;
8905 typval_T *rettv;
8907 colnr_T col = 0;
8908 pos_T *fp;
8909 int fnum = curbuf->b_fnum;
8911 fp = var2fpos(&argvars[0], FALSE, &fnum);
8912 if (fp != NULL && fnum == curbuf->b_fnum)
8914 if (fp->col == MAXCOL)
8916 /* '> can be MAXCOL, get the length of the line then */
8917 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8918 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8919 else
8920 col = MAXCOL;
8922 else
8924 col = fp->col + 1;
8925 #ifdef FEAT_VIRTUALEDIT
8926 /* col(".") when the cursor is on the NUL at the end of the line
8927 * because of "coladd" can be seen as an extra column. */
8928 if (virtual_active() && fp == &curwin->w_cursor)
8930 char_u *p = ml_get_cursor();
8932 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8933 curwin->w_virtcol - curwin->w_cursor.coladd))
8935 # ifdef FEAT_MBYTE
8936 int l;
8938 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8939 col += l;
8940 # else
8941 if (*p != NUL && p[1] == NUL)
8942 ++col;
8943 # endif
8946 #endif
8949 rettv->vval.v_number = col;
8952 #if defined(FEAT_INS_EXPAND)
8954 * "complete()" function
8956 static void
8957 f_complete(argvars, rettv)
8958 typval_T *argvars;
8959 typval_T *rettv UNUSED;
8961 int startcol;
8963 if ((State & INSERT) == 0)
8965 EMSG(_("E785: complete() can only be used in Insert mode"));
8966 return;
8969 /* Check for undo allowed here, because if something was already inserted
8970 * the line was already saved for undo and this check isn't done. */
8971 if (!undo_allowed())
8972 return;
8974 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8976 EMSG(_(e_invarg));
8977 return;
8980 startcol = get_tv_number_chk(&argvars[0], NULL);
8981 if (startcol <= 0)
8982 return;
8984 set_completion(startcol - 1, argvars[1].vval.v_list);
8988 * "complete_add()" function
8990 static void
8991 f_complete_add(argvars, rettv)
8992 typval_T *argvars;
8993 typval_T *rettv;
8995 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
8999 * "complete_check()" function
9001 static void
9002 f_complete_check(argvars, rettv)
9003 typval_T *argvars UNUSED;
9004 typval_T *rettv;
9006 int saved = RedrawingDisabled;
9008 RedrawingDisabled = 0;
9009 ins_compl_check_keys(0);
9010 rettv->vval.v_number = compl_interrupted;
9011 RedrawingDisabled = saved;
9013 #endif
9016 * "confirm(message, buttons[, default [, type]])" function
9018 static void
9019 f_confirm(argvars, rettv)
9020 typval_T *argvars UNUSED;
9021 typval_T *rettv UNUSED;
9023 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
9024 char_u *message;
9025 char_u *buttons = NULL;
9026 char_u buf[NUMBUFLEN];
9027 char_u buf2[NUMBUFLEN];
9028 int def = 1;
9029 int type = VIM_GENERIC;
9030 char_u *typestr;
9031 int error = FALSE;
9033 message = get_tv_string_chk(&argvars[0]);
9034 if (message == NULL)
9035 error = TRUE;
9036 if (argvars[1].v_type != VAR_UNKNOWN)
9038 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9039 if (buttons == NULL)
9040 error = TRUE;
9041 if (argvars[2].v_type != VAR_UNKNOWN)
9043 def = get_tv_number_chk(&argvars[2], &error);
9044 if (argvars[3].v_type != VAR_UNKNOWN)
9046 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9047 if (typestr == NULL)
9048 error = TRUE;
9049 else
9051 switch (TOUPPER_ASC(*typestr))
9053 case 'E': type = VIM_ERROR; break;
9054 case 'Q': type = VIM_QUESTION; break;
9055 case 'I': type = VIM_INFO; break;
9056 case 'W': type = VIM_WARNING; break;
9057 case 'G': type = VIM_GENERIC; break;
9064 if (buttons == NULL || *buttons == NUL)
9065 buttons = (char_u *)_("&Ok");
9067 if (!error)
9068 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9069 def, NULL);
9070 #endif
9074 * "copy()" function
9076 static void
9077 f_copy(argvars, rettv)
9078 typval_T *argvars;
9079 typval_T *rettv;
9081 item_copy(&argvars[0], rettv, FALSE, 0);
9084 #ifdef FEAT_FLOAT
9086 * "cos()" function
9088 static void
9089 f_cos(argvars, rettv)
9090 typval_T *argvars;
9091 typval_T *rettv;
9093 float_T f;
9095 rettv->v_type = VAR_FLOAT;
9096 if (get_float_arg(argvars, &f) == OK)
9097 rettv->vval.v_float = cos(f);
9098 else
9099 rettv->vval.v_float = 0.0;
9101 #endif
9104 * "count()" function
9106 static void
9107 f_count(argvars, rettv)
9108 typval_T *argvars;
9109 typval_T *rettv;
9111 long n = 0;
9112 int ic = FALSE;
9114 if (argvars[0].v_type == VAR_LIST)
9116 listitem_T *li;
9117 list_T *l;
9118 long idx;
9120 if ((l = argvars[0].vval.v_list) != NULL)
9122 li = l->lv_first;
9123 if (argvars[2].v_type != VAR_UNKNOWN)
9125 int error = FALSE;
9127 ic = get_tv_number_chk(&argvars[2], &error);
9128 if (argvars[3].v_type != VAR_UNKNOWN)
9130 idx = get_tv_number_chk(&argvars[3], &error);
9131 if (!error)
9133 li = list_find(l, idx);
9134 if (li == NULL)
9135 EMSGN(_(e_listidx), idx);
9138 if (error)
9139 li = NULL;
9142 for ( ; li != NULL; li = li->li_next)
9143 if (tv_equal(&li->li_tv, &argvars[1], ic))
9144 ++n;
9147 else if (argvars[0].v_type == VAR_DICT)
9149 int todo;
9150 dict_T *d;
9151 hashitem_T *hi;
9153 if ((d = argvars[0].vval.v_dict) != NULL)
9155 int error = FALSE;
9157 if (argvars[2].v_type != VAR_UNKNOWN)
9159 ic = get_tv_number_chk(&argvars[2], &error);
9160 if (argvars[3].v_type != VAR_UNKNOWN)
9161 EMSG(_(e_invarg));
9164 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9165 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9167 if (!HASHITEM_EMPTY(hi))
9169 --todo;
9170 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9171 ++n;
9176 else
9177 EMSG2(_(e_listdictarg), "count()");
9178 rettv->vval.v_number = n;
9182 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9184 * Checks the existence of a cscope connection.
9186 static void
9187 f_cscope_connection(argvars, rettv)
9188 typval_T *argvars UNUSED;
9189 typval_T *rettv UNUSED;
9191 #ifdef FEAT_CSCOPE
9192 int num = 0;
9193 char_u *dbpath = NULL;
9194 char_u *prepend = NULL;
9195 char_u buf[NUMBUFLEN];
9197 if (argvars[0].v_type != VAR_UNKNOWN
9198 && argvars[1].v_type != VAR_UNKNOWN)
9200 num = (int)get_tv_number(&argvars[0]);
9201 dbpath = get_tv_string(&argvars[1]);
9202 if (argvars[2].v_type != VAR_UNKNOWN)
9203 prepend = get_tv_string_buf(&argvars[2], buf);
9206 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9207 #endif
9211 * "cursor(lnum, col)" function
9213 * Moves the cursor to the specified line and column.
9214 * Returns 0 when the position could be set, -1 otherwise.
9216 static void
9217 f_cursor(argvars, rettv)
9218 typval_T *argvars;
9219 typval_T *rettv;
9221 long line, col;
9222 #ifdef FEAT_VIRTUALEDIT
9223 long coladd = 0;
9224 #endif
9226 rettv->vval.v_number = -1;
9227 if (argvars[1].v_type == VAR_UNKNOWN)
9229 pos_T pos;
9231 if (list2fpos(argvars, &pos, NULL) == FAIL)
9232 return;
9233 line = pos.lnum;
9234 col = pos.col;
9235 #ifdef FEAT_VIRTUALEDIT
9236 coladd = pos.coladd;
9237 #endif
9239 else
9241 line = get_tv_lnum(argvars);
9242 col = get_tv_number_chk(&argvars[1], NULL);
9243 #ifdef FEAT_VIRTUALEDIT
9244 if (argvars[2].v_type != VAR_UNKNOWN)
9245 coladd = get_tv_number_chk(&argvars[2], NULL);
9246 #endif
9248 if (line < 0 || col < 0
9249 #ifdef FEAT_VIRTUALEDIT
9250 || coladd < 0
9251 #endif
9253 return; /* type error; errmsg already given */
9254 if (line > 0)
9255 curwin->w_cursor.lnum = line;
9256 if (col > 0)
9257 curwin->w_cursor.col = col - 1;
9258 #ifdef FEAT_VIRTUALEDIT
9259 curwin->w_cursor.coladd = coladd;
9260 #endif
9262 /* Make sure the cursor is in a valid position. */
9263 check_cursor();
9264 #ifdef FEAT_MBYTE
9265 /* Correct cursor for multi-byte character. */
9266 if (has_mbyte)
9267 mb_adjust_cursor();
9268 #endif
9270 curwin->w_set_curswant = TRUE;
9271 rettv->vval.v_number = 0;
9275 * "deepcopy()" function
9277 static void
9278 f_deepcopy(argvars, rettv)
9279 typval_T *argvars;
9280 typval_T *rettv;
9282 int noref = 0;
9284 if (argvars[1].v_type != VAR_UNKNOWN)
9285 noref = get_tv_number_chk(&argvars[1], NULL);
9286 if (noref < 0 || noref > 1)
9287 EMSG(_(e_invarg));
9288 else
9289 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? ++current_copyID : 0);
9293 * "delete()" function
9295 static void
9296 f_delete(argvars, rettv)
9297 typval_T *argvars;
9298 typval_T *rettv;
9300 if (check_restricted() || check_secure())
9301 rettv->vval.v_number = -1;
9302 else
9303 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9307 * "did_filetype()" function
9309 static void
9310 f_did_filetype(argvars, rettv)
9311 typval_T *argvars UNUSED;
9312 typval_T *rettv UNUSED;
9314 #ifdef FEAT_AUTOCMD
9315 rettv->vval.v_number = did_filetype;
9316 #endif
9320 * "diff_filler()" function
9322 static void
9323 f_diff_filler(argvars, rettv)
9324 typval_T *argvars UNUSED;
9325 typval_T *rettv UNUSED;
9327 #ifdef FEAT_DIFF
9328 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9329 #endif
9333 * "diff_hlID()" function
9335 static void
9336 f_diff_hlID(argvars, rettv)
9337 typval_T *argvars UNUSED;
9338 typval_T *rettv UNUSED;
9340 #ifdef FEAT_DIFF
9341 linenr_T lnum = get_tv_lnum(argvars);
9342 static linenr_T prev_lnum = 0;
9343 static int changedtick = 0;
9344 static int fnum = 0;
9345 static int change_start = 0;
9346 static int change_end = 0;
9347 static hlf_T hlID = (hlf_T)0;
9348 int filler_lines;
9349 int col;
9351 if (lnum < 0) /* ignore type error in {lnum} arg */
9352 lnum = 0;
9353 if (lnum != prev_lnum
9354 || changedtick != curbuf->b_changedtick
9355 || fnum != curbuf->b_fnum)
9357 /* New line, buffer, change: need to get the values. */
9358 filler_lines = diff_check(curwin, lnum);
9359 if (filler_lines < 0)
9361 if (filler_lines == -1)
9363 change_start = MAXCOL;
9364 change_end = -1;
9365 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9366 hlID = HLF_ADD; /* added line */
9367 else
9368 hlID = HLF_CHD; /* changed line */
9370 else
9371 hlID = HLF_ADD; /* added line */
9373 else
9374 hlID = (hlf_T)0;
9375 prev_lnum = lnum;
9376 changedtick = curbuf->b_changedtick;
9377 fnum = curbuf->b_fnum;
9380 if (hlID == HLF_CHD || hlID == HLF_TXD)
9382 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9383 if (col >= change_start && col <= change_end)
9384 hlID = HLF_TXD; /* changed text */
9385 else
9386 hlID = HLF_CHD; /* changed line */
9388 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9389 #endif
9393 * "empty({expr})" function
9395 static void
9396 f_empty(argvars, rettv)
9397 typval_T *argvars;
9398 typval_T *rettv;
9400 int n;
9402 switch (argvars[0].v_type)
9404 case VAR_STRING:
9405 case VAR_FUNC:
9406 n = argvars[0].vval.v_string == NULL
9407 || *argvars[0].vval.v_string == NUL;
9408 break;
9409 case VAR_NUMBER:
9410 n = argvars[0].vval.v_number == 0;
9411 break;
9412 #ifdef FEAT_FLOAT
9413 case VAR_FLOAT:
9414 n = argvars[0].vval.v_float == 0.0;
9415 break;
9416 #endif
9417 case VAR_LIST:
9418 n = argvars[0].vval.v_list == NULL
9419 || argvars[0].vval.v_list->lv_first == NULL;
9420 break;
9421 case VAR_DICT:
9422 n = argvars[0].vval.v_dict == NULL
9423 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9424 break;
9425 default:
9426 EMSG2(_(e_intern2), "f_empty()");
9427 n = 0;
9430 rettv->vval.v_number = n;
9434 * "escape({string}, {chars})" function
9436 static void
9437 f_escape(argvars, rettv)
9438 typval_T *argvars;
9439 typval_T *rettv;
9441 char_u buf[NUMBUFLEN];
9443 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9444 get_tv_string_buf(&argvars[1], buf));
9445 rettv->v_type = VAR_STRING;
9449 * "eval()" function
9451 static void
9452 f_eval(argvars, rettv)
9453 typval_T *argvars;
9454 typval_T *rettv;
9456 char_u *s;
9458 s = get_tv_string_chk(&argvars[0]);
9459 if (s != NULL)
9460 s = skipwhite(s);
9462 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9464 rettv->v_type = VAR_NUMBER;
9465 rettv->vval.v_number = 0;
9467 else if (*s != NUL)
9468 EMSG(_(e_trailing));
9472 * "eventhandler()" function
9474 static void
9475 f_eventhandler(argvars, rettv)
9476 typval_T *argvars UNUSED;
9477 typval_T *rettv;
9479 rettv->vval.v_number = vgetc_busy;
9483 * "executable()" function
9485 static void
9486 f_executable(argvars, rettv)
9487 typval_T *argvars;
9488 typval_T *rettv;
9490 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9494 * "exists()" function
9496 static void
9497 f_exists(argvars, rettv)
9498 typval_T *argvars;
9499 typval_T *rettv;
9501 char_u *p;
9502 char_u *name;
9503 int n = FALSE;
9504 int len = 0;
9506 p = get_tv_string(&argvars[0]);
9507 if (*p == '$') /* environment variable */
9509 /* first try "normal" environment variables (fast) */
9510 if (mch_getenv(p + 1) != NULL)
9511 n = TRUE;
9512 else
9514 /* try expanding things like $VIM and ${HOME} */
9515 p = expand_env_save(p);
9516 if (p != NULL && *p != '$')
9517 n = TRUE;
9518 vim_free(p);
9521 else if (*p == '&' || *p == '+') /* option */
9523 n = (get_option_tv(&p, NULL, TRUE) == OK);
9524 if (*skipwhite(p) != NUL)
9525 n = FALSE; /* trailing garbage */
9527 else if (*p == '*') /* internal or user defined function */
9529 n = function_exists(p + 1);
9531 else if (*p == ':')
9533 n = cmd_exists(p + 1);
9535 else if (*p == '#')
9537 #ifdef FEAT_AUTOCMD
9538 if (p[1] == '#')
9539 n = autocmd_supported(p + 2);
9540 else
9541 n = au_exists(p + 1);
9542 #endif
9544 else /* internal variable */
9546 char_u *tofree;
9547 typval_T tv;
9549 /* get_name_len() takes care of expanding curly braces */
9550 name = p;
9551 len = get_name_len(&p, &tofree, TRUE, FALSE);
9552 if (len > 0)
9554 if (tofree != NULL)
9555 name = tofree;
9556 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9557 if (n)
9559 /* handle d.key, l[idx], f(expr) */
9560 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9561 if (n)
9562 clear_tv(&tv);
9565 if (*p != NUL)
9566 n = FALSE;
9568 vim_free(tofree);
9571 rettv->vval.v_number = n;
9575 * "expand()" function
9577 static void
9578 f_expand(argvars, rettv)
9579 typval_T *argvars;
9580 typval_T *rettv;
9582 char_u *s;
9583 int len;
9584 char_u *errormsg;
9585 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9586 expand_T xpc;
9587 int error = FALSE;
9589 rettv->v_type = VAR_STRING;
9590 s = get_tv_string(&argvars[0]);
9591 if (*s == '%' || *s == '#' || *s == '<')
9593 ++emsg_off;
9594 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9595 --emsg_off;
9597 else
9599 /* When the optional second argument is non-zero, don't remove matches
9600 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9601 if (argvars[1].v_type != VAR_UNKNOWN
9602 && get_tv_number_chk(&argvars[1], &error))
9603 flags |= WILD_KEEP_ALL;
9604 if (!error)
9606 ExpandInit(&xpc);
9607 xpc.xp_context = EXPAND_FILES;
9608 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9610 else
9611 rettv->vval.v_string = NULL;
9616 * "extend(list, list [, idx])" function
9617 * "extend(dict, dict [, action])" function
9619 static void
9620 f_extend(argvars, rettv)
9621 typval_T *argvars;
9622 typval_T *rettv;
9624 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9626 list_T *l1, *l2;
9627 listitem_T *item;
9628 long before;
9629 int error = FALSE;
9631 l1 = argvars[0].vval.v_list;
9632 l2 = argvars[1].vval.v_list;
9633 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9634 && l2 != NULL)
9636 if (argvars[2].v_type != VAR_UNKNOWN)
9638 before = get_tv_number_chk(&argvars[2], &error);
9639 if (error)
9640 return; /* type error; errmsg already given */
9642 if (before == l1->lv_len)
9643 item = NULL;
9644 else
9646 item = list_find(l1, before);
9647 if (item == NULL)
9649 EMSGN(_(e_listidx), before);
9650 return;
9654 else
9655 item = NULL;
9656 list_extend(l1, l2, item);
9658 copy_tv(&argvars[0], rettv);
9661 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9663 dict_T *d1, *d2;
9664 dictitem_T *di1;
9665 char_u *action;
9666 int i;
9667 hashitem_T *hi2;
9668 int todo;
9670 d1 = argvars[0].vval.v_dict;
9671 d2 = argvars[1].vval.v_dict;
9672 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9673 && d2 != NULL)
9675 /* Check the third argument. */
9676 if (argvars[2].v_type != VAR_UNKNOWN)
9678 static char *(av[]) = {"keep", "force", "error"};
9680 action = get_tv_string_chk(&argvars[2]);
9681 if (action == NULL)
9682 return; /* type error; errmsg already given */
9683 for (i = 0; i < 3; ++i)
9684 if (STRCMP(action, av[i]) == 0)
9685 break;
9686 if (i == 3)
9688 EMSG2(_(e_invarg2), action);
9689 return;
9692 else
9693 action = (char_u *)"force";
9695 /* Go over all entries in the second dict and add them to the
9696 * first dict. */
9697 todo = (int)d2->dv_hashtab.ht_used;
9698 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9700 if (!HASHITEM_EMPTY(hi2))
9702 --todo;
9703 di1 = dict_find(d1, hi2->hi_key, -1);
9704 if (di1 == NULL)
9706 di1 = dictitem_copy(HI2DI(hi2));
9707 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9708 dictitem_free(di1);
9710 else if (*action == 'e')
9712 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9713 break;
9715 else if (*action == 'f')
9717 clear_tv(&di1->di_tv);
9718 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9723 copy_tv(&argvars[0], rettv);
9726 else
9727 EMSG2(_(e_listdictarg), "extend()");
9731 * "feedkeys()" function
9733 static void
9734 f_feedkeys(argvars, rettv)
9735 typval_T *argvars;
9736 typval_T *rettv UNUSED;
9738 int remap = TRUE;
9739 char_u *keys, *flags;
9740 char_u nbuf[NUMBUFLEN];
9741 int typed = FALSE;
9742 char_u *keys_esc;
9744 /* This is not allowed in the sandbox. If the commands would still be
9745 * executed in the sandbox it would be OK, but it probably happens later,
9746 * when "sandbox" is no longer set. */
9747 if (check_secure())
9748 return;
9750 keys = get_tv_string(&argvars[0]);
9751 if (*keys != NUL)
9753 if (argvars[1].v_type != VAR_UNKNOWN)
9755 flags = get_tv_string_buf(&argvars[1], nbuf);
9756 for ( ; *flags != NUL; ++flags)
9758 switch (*flags)
9760 case 'n': remap = FALSE; break;
9761 case 'm': remap = TRUE; break;
9762 case 't': typed = TRUE; break;
9767 /* Need to escape K_SPECIAL and CSI before putting the string in the
9768 * typeahead buffer. */
9769 keys_esc = vim_strsave_escape_csi(keys);
9770 if (keys_esc != NULL)
9772 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9773 typebuf.tb_len, !typed, FALSE);
9774 vim_free(keys_esc);
9775 if (vgetc_busy)
9776 typebuf_was_filled = TRUE;
9782 * "filereadable()" function
9784 static void
9785 f_filereadable(argvars, rettv)
9786 typval_T *argvars;
9787 typval_T *rettv;
9789 int fd;
9790 char_u *p;
9791 int n;
9793 #ifndef O_NONBLOCK
9794 # define O_NONBLOCK 0
9795 #endif
9796 p = get_tv_string(&argvars[0]);
9797 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9798 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9800 n = TRUE;
9801 close(fd);
9803 else
9804 n = FALSE;
9806 rettv->vval.v_number = n;
9810 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9811 * rights to write into.
9813 static void
9814 f_filewritable(argvars, rettv)
9815 typval_T *argvars;
9816 typval_T *rettv;
9818 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9821 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9823 static void
9824 findfilendir(argvars, rettv, find_what)
9825 typval_T *argvars;
9826 typval_T *rettv;
9827 int find_what;
9829 #ifdef FEAT_SEARCHPATH
9830 char_u *fname;
9831 char_u *fresult = NULL;
9832 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9833 char_u *p;
9834 char_u pathbuf[NUMBUFLEN];
9835 int count = 1;
9836 int first = TRUE;
9837 int error = FALSE;
9838 #endif
9840 rettv->vval.v_string = NULL;
9841 rettv->v_type = VAR_STRING;
9843 #ifdef FEAT_SEARCHPATH
9844 fname = get_tv_string(&argvars[0]);
9846 if (argvars[1].v_type != VAR_UNKNOWN)
9848 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9849 if (p == NULL)
9850 error = TRUE;
9851 else
9853 if (*p != NUL)
9854 path = p;
9856 if (argvars[2].v_type != VAR_UNKNOWN)
9857 count = get_tv_number_chk(&argvars[2], &error);
9861 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9862 error = TRUE;
9864 if (*fname != NUL && !error)
9868 if (rettv->v_type == VAR_STRING)
9869 vim_free(fresult);
9870 fresult = find_file_in_path_option(first ? fname : NULL,
9871 first ? (int)STRLEN(fname) : 0,
9872 0, first, path,
9873 find_what,
9874 curbuf->b_ffname,
9875 find_what == FINDFILE_DIR
9876 ? (char_u *)"" : curbuf->b_p_sua);
9877 first = FALSE;
9879 if (fresult != NULL && rettv->v_type == VAR_LIST)
9880 list_append_string(rettv->vval.v_list, fresult, -1);
9882 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9885 if (rettv->v_type == VAR_STRING)
9886 rettv->vval.v_string = fresult;
9887 #endif
9890 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9891 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9894 * Implementation of map() and filter().
9896 static void
9897 filter_map(argvars, rettv, map)
9898 typval_T *argvars;
9899 typval_T *rettv;
9900 int map;
9902 char_u buf[NUMBUFLEN];
9903 char_u *expr;
9904 listitem_T *li, *nli;
9905 list_T *l = NULL;
9906 dictitem_T *di;
9907 hashtab_T *ht;
9908 hashitem_T *hi;
9909 dict_T *d = NULL;
9910 typval_T save_val;
9911 typval_T save_key;
9912 int rem;
9913 int todo;
9914 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9915 int save_did_emsg;
9917 if (argvars[0].v_type == VAR_LIST)
9919 if ((l = argvars[0].vval.v_list) == NULL
9920 || (map && tv_check_lock(l->lv_lock, ermsg)))
9921 return;
9923 else if (argvars[0].v_type == VAR_DICT)
9925 if ((d = argvars[0].vval.v_dict) == NULL
9926 || (map && tv_check_lock(d->dv_lock, ermsg)))
9927 return;
9929 else
9931 EMSG2(_(e_listdictarg), ermsg);
9932 return;
9935 expr = get_tv_string_buf_chk(&argvars[1], buf);
9936 /* On type errors, the preceding call has already displayed an error
9937 * message. Avoid a misleading error message for an empty string that
9938 * was not passed as argument. */
9939 if (expr != NULL)
9941 prepare_vimvar(VV_VAL, &save_val);
9942 expr = skipwhite(expr);
9944 /* We reset "did_emsg" to be able to detect whether an error
9945 * occurred during evaluation of the expression. */
9946 save_did_emsg = did_emsg;
9947 did_emsg = FALSE;
9949 if (argvars[0].v_type == VAR_DICT)
9951 prepare_vimvar(VV_KEY, &save_key);
9952 vimvars[VV_KEY].vv_type = VAR_STRING;
9954 ht = &d->dv_hashtab;
9955 hash_lock(ht);
9956 todo = (int)ht->ht_used;
9957 for (hi = ht->ht_array; todo > 0; ++hi)
9959 if (!HASHITEM_EMPTY(hi))
9961 --todo;
9962 di = HI2DI(hi);
9963 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9964 break;
9965 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9966 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9967 || did_emsg)
9968 break;
9969 if (!map && rem)
9970 dictitem_remove(d, di);
9971 clear_tv(&vimvars[VV_KEY].vv_tv);
9974 hash_unlock(ht);
9976 restore_vimvar(VV_KEY, &save_key);
9978 else
9980 for (li = l->lv_first; li != NULL; li = nli)
9982 if (tv_check_lock(li->li_tv.v_lock, ermsg))
9983 break;
9984 nli = li->li_next;
9985 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
9986 || did_emsg)
9987 break;
9988 if (!map && rem)
9989 listitem_remove(l, li);
9993 restore_vimvar(VV_VAL, &save_val);
9995 did_emsg |= save_did_emsg;
9998 copy_tv(&argvars[0], rettv);
10001 static int
10002 filter_map_one(tv, expr, map, remp)
10003 typval_T *tv;
10004 char_u *expr;
10005 int map;
10006 int *remp;
10008 typval_T rettv;
10009 char_u *s;
10010 int retval = FAIL;
10012 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10013 s = expr;
10014 if (eval1(&s, &rettv, TRUE) == FAIL)
10015 goto theend;
10016 if (*s != NUL) /* check for trailing chars after expr */
10018 EMSG2(_(e_invexpr2), s);
10019 goto theend;
10021 if (map)
10023 /* map(): replace the list item value */
10024 clear_tv(tv);
10025 rettv.v_lock = 0;
10026 *tv = rettv;
10028 else
10030 int error = FALSE;
10032 /* filter(): when expr is zero remove the item */
10033 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10034 clear_tv(&rettv);
10035 /* On type error, nothing has been removed; return FAIL to stop the
10036 * loop. The error message was given by get_tv_number_chk(). */
10037 if (error)
10038 goto theend;
10040 retval = OK;
10041 theend:
10042 clear_tv(&vimvars[VV_VAL].vv_tv);
10043 return retval;
10047 * "filter()" function
10049 static void
10050 f_filter(argvars, rettv)
10051 typval_T *argvars;
10052 typval_T *rettv;
10054 filter_map(argvars, rettv, FALSE);
10058 * "finddir({fname}[, {path}[, {count}]])" function
10060 static void
10061 f_finddir(argvars, rettv)
10062 typval_T *argvars;
10063 typval_T *rettv;
10065 findfilendir(argvars, rettv, FINDFILE_DIR);
10069 * "findfile({fname}[, {path}[, {count}]])" function
10071 static void
10072 f_findfile(argvars, rettv)
10073 typval_T *argvars;
10074 typval_T *rettv;
10076 findfilendir(argvars, rettv, FINDFILE_FILE);
10079 #ifdef FEAT_FLOAT
10081 * "float2nr({float})" function
10083 static void
10084 f_float2nr(argvars, rettv)
10085 typval_T *argvars;
10086 typval_T *rettv;
10088 float_T f;
10090 if (get_float_arg(argvars, &f) == OK)
10092 if (f < -0x7fffffff)
10093 rettv->vval.v_number = -0x7fffffff;
10094 else if (f > 0x7fffffff)
10095 rettv->vval.v_number = 0x7fffffff;
10096 else
10097 rettv->vval.v_number = (varnumber_T)f;
10102 * "floor({float})" function
10104 static void
10105 f_floor(argvars, rettv)
10106 typval_T *argvars;
10107 typval_T *rettv;
10109 float_T f;
10111 rettv->v_type = VAR_FLOAT;
10112 if (get_float_arg(argvars, &f) == OK)
10113 rettv->vval.v_float = floor(f);
10114 else
10115 rettv->vval.v_float = 0.0;
10117 #endif
10120 * "fnameescape({string})" function
10122 static void
10123 f_fnameescape(argvars, rettv)
10124 typval_T *argvars;
10125 typval_T *rettv;
10127 rettv->vval.v_string = vim_strsave_fnameescape(
10128 get_tv_string(&argvars[0]), FALSE);
10129 rettv->v_type = VAR_STRING;
10133 * "fnamemodify({fname}, {mods})" function
10135 static void
10136 f_fnamemodify(argvars, rettv)
10137 typval_T *argvars;
10138 typval_T *rettv;
10140 char_u *fname;
10141 char_u *mods;
10142 int usedlen = 0;
10143 int len;
10144 char_u *fbuf = NULL;
10145 char_u buf[NUMBUFLEN];
10147 fname = get_tv_string_chk(&argvars[0]);
10148 mods = get_tv_string_buf_chk(&argvars[1], buf);
10149 if (fname == NULL || mods == NULL)
10150 fname = NULL;
10151 else
10153 len = (int)STRLEN(fname);
10154 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10157 rettv->v_type = VAR_STRING;
10158 if (fname == NULL)
10159 rettv->vval.v_string = NULL;
10160 else
10161 rettv->vval.v_string = vim_strnsave(fname, len);
10162 vim_free(fbuf);
10165 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10168 * "foldclosed()" function
10170 static void
10171 foldclosed_both(argvars, rettv, end)
10172 typval_T *argvars;
10173 typval_T *rettv;
10174 int end;
10176 #ifdef FEAT_FOLDING
10177 linenr_T lnum;
10178 linenr_T first, last;
10180 lnum = get_tv_lnum(argvars);
10181 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10183 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10185 if (end)
10186 rettv->vval.v_number = (varnumber_T)last;
10187 else
10188 rettv->vval.v_number = (varnumber_T)first;
10189 return;
10192 #endif
10193 rettv->vval.v_number = -1;
10197 * "foldclosed()" function
10199 static void
10200 f_foldclosed(argvars, rettv)
10201 typval_T *argvars;
10202 typval_T *rettv;
10204 foldclosed_both(argvars, rettv, FALSE);
10208 * "foldclosedend()" function
10210 static void
10211 f_foldclosedend(argvars, rettv)
10212 typval_T *argvars;
10213 typval_T *rettv;
10215 foldclosed_both(argvars, rettv, TRUE);
10219 * "foldlevel()" function
10221 static void
10222 f_foldlevel(argvars, rettv)
10223 typval_T *argvars;
10224 typval_T *rettv;
10226 #ifdef FEAT_FOLDING
10227 linenr_T lnum;
10229 lnum = get_tv_lnum(argvars);
10230 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10231 rettv->vval.v_number = foldLevel(lnum);
10232 #endif
10236 * "foldtext()" function
10238 static void
10239 f_foldtext(argvars, rettv)
10240 typval_T *argvars UNUSED;
10241 typval_T *rettv;
10243 #ifdef FEAT_FOLDING
10244 linenr_T lnum;
10245 char_u *s;
10246 char_u *r;
10247 int len;
10248 char *txt;
10249 #endif
10251 rettv->v_type = VAR_STRING;
10252 rettv->vval.v_string = NULL;
10253 #ifdef FEAT_FOLDING
10254 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10255 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10256 <= curbuf->b_ml.ml_line_count
10257 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10259 /* Find first non-empty line in the fold. */
10260 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10261 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10263 if (!linewhite(lnum))
10264 break;
10265 ++lnum;
10268 /* Find interesting text in this line. */
10269 s = skipwhite(ml_get(lnum));
10270 /* skip C comment-start */
10271 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10273 s = skipwhite(s + 2);
10274 if (*skipwhite(s) == NUL
10275 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10277 s = skipwhite(ml_get(lnum + 1));
10278 if (*s == '*')
10279 s = skipwhite(s + 1);
10282 txt = _("+-%s%3ld lines: ");
10283 r = alloc((unsigned)(STRLEN(txt)
10284 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10285 + 20 /* for %3ld */
10286 + STRLEN(s))); /* concatenated */
10287 if (r != NULL)
10289 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10290 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10291 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10292 len = (int)STRLEN(r);
10293 STRCAT(r, s);
10294 /* remove 'foldmarker' and 'commentstring' */
10295 foldtext_cleanup(r + len);
10296 rettv->vval.v_string = r;
10299 #endif
10303 * "foldtextresult(lnum)" function
10305 static void
10306 f_foldtextresult(argvars, rettv)
10307 typval_T *argvars UNUSED;
10308 typval_T *rettv;
10310 #ifdef FEAT_FOLDING
10311 linenr_T lnum;
10312 char_u *text;
10313 char_u buf[51];
10314 foldinfo_T foldinfo;
10315 int fold_count;
10316 #endif
10318 rettv->v_type = VAR_STRING;
10319 rettv->vval.v_string = NULL;
10320 #ifdef FEAT_FOLDING
10321 lnum = get_tv_lnum(argvars);
10322 /* treat illegal types and illegal string values for {lnum} the same */
10323 if (lnum < 0)
10324 lnum = 0;
10325 fold_count = foldedCount(curwin, lnum, &foldinfo);
10326 if (fold_count > 0)
10328 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10329 &foldinfo, buf);
10330 if (text == buf)
10331 text = vim_strsave(text);
10332 rettv->vval.v_string = text;
10334 #endif
10338 * "foreground()" function
10340 static void
10341 f_foreground(argvars, rettv)
10342 typval_T *argvars UNUSED;
10343 typval_T *rettv UNUSED;
10345 #ifdef FEAT_GUI
10346 if (gui.in_use)
10347 gui_mch_set_foreground();
10348 #else
10349 # ifdef WIN32
10350 win32_set_foreground();
10351 # endif
10352 #endif
10356 * "function()" function
10358 static void
10359 f_function(argvars, rettv)
10360 typval_T *argvars;
10361 typval_T *rettv;
10363 char_u *s;
10365 s = get_tv_string(&argvars[0]);
10366 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10367 EMSG2(_(e_invarg2), s);
10368 /* Don't check an autoload name for existence here. */
10369 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10370 EMSG2(_("E700: Unknown function: %s"), s);
10371 else
10373 rettv->vval.v_string = vim_strsave(s);
10374 rettv->v_type = VAR_FUNC;
10379 * "garbagecollect()" function
10381 static void
10382 f_garbagecollect(argvars, rettv)
10383 typval_T *argvars;
10384 typval_T *rettv UNUSED;
10386 /* This is postponed until we are back at the toplevel, because we may be
10387 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10388 want_garbage_collect = TRUE;
10390 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10391 garbage_collect_at_exit = TRUE;
10395 * "get()" function
10397 static void
10398 f_get(argvars, rettv)
10399 typval_T *argvars;
10400 typval_T *rettv;
10402 listitem_T *li;
10403 list_T *l;
10404 dictitem_T *di;
10405 dict_T *d;
10406 typval_T *tv = NULL;
10408 if (argvars[0].v_type == VAR_LIST)
10410 if ((l = argvars[0].vval.v_list) != NULL)
10412 int error = FALSE;
10414 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10415 if (!error && li != NULL)
10416 tv = &li->li_tv;
10419 else if (argvars[0].v_type == VAR_DICT)
10421 if ((d = argvars[0].vval.v_dict) != NULL)
10423 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10424 if (di != NULL)
10425 tv = &di->di_tv;
10428 else
10429 EMSG2(_(e_listdictarg), "get()");
10431 if (tv == NULL)
10433 if (argvars[2].v_type != VAR_UNKNOWN)
10434 copy_tv(&argvars[2], rettv);
10436 else
10437 copy_tv(tv, rettv);
10440 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10443 * Get line or list of lines from buffer "buf" into "rettv".
10444 * Return a range (from start to end) of lines in rettv from the specified
10445 * buffer.
10446 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10448 static void
10449 get_buffer_lines(buf, start, end, retlist, rettv)
10450 buf_T *buf;
10451 linenr_T start;
10452 linenr_T end;
10453 int retlist;
10454 typval_T *rettv;
10456 char_u *p;
10458 if (retlist && rettv_list_alloc(rettv) == FAIL)
10459 return;
10461 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10462 return;
10464 if (!retlist)
10466 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10467 p = ml_get_buf(buf, start, FALSE);
10468 else
10469 p = (char_u *)"";
10471 rettv->v_type = VAR_STRING;
10472 rettv->vval.v_string = vim_strsave(p);
10474 else
10476 if (end < start)
10477 return;
10479 if (start < 1)
10480 start = 1;
10481 if (end > buf->b_ml.ml_line_count)
10482 end = buf->b_ml.ml_line_count;
10483 while (start <= end)
10484 if (list_append_string(rettv->vval.v_list,
10485 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10486 break;
10491 * "getbufline()" function
10493 static void
10494 f_getbufline(argvars, rettv)
10495 typval_T *argvars;
10496 typval_T *rettv;
10498 linenr_T lnum;
10499 linenr_T end;
10500 buf_T *buf;
10502 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10503 ++emsg_off;
10504 buf = get_buf_tv(&argvars[0]);
10505 --emsg_off;
10507 lnum = get_tv_lnum_buf(&argvars[1], buf);
10508 if (argvars[2].v_type == VAR_UNKNOWN)
10509 end = lnum;
10510 else
10511 end = get_tv_lnum_buf(&argvars[2], buf);
10513 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10517 * "getbufvar()" function
10519 static void
10520 f_getbufvar(argvars, rettv)
10521 typval_T *argvars;
10522 typval_T *rettv;
10524 buf_T *buf;
10525 buf_T *save_curbuf;
10526 char_u *varname;
10527 dictitem_T *v;
10529 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10530 varname = get_tv_string_chk(&argvars[1]);
10531 ++emsg_off;
10532 buf = get_buf_tv(&argvars[0]);
10534 rettv->v_type = VAR_STRING;
10535 rettv->vval.v_string = NULL;
10537 if (buf != NULL && varname != NULL)
10539 /* set curbuf to be our buf, temporarily */
10540 save_curbuf = curbuf;
10541 curbuf = buf;
10543 if (*varname == '&') /* buffer-local-option */
10544 get_option_tv(&varname, rettv, TRUE);
10545 else
10547 if (*varname == NUL)
10548 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10549 * scope prefix before the NUL byte is required by
10550 * find_var_in_ht(). */
10551 varname = (char_u *)"b:" + 2;
10552 /* look up the variable */
10553 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10554 if (v != NULL)
10555 copy_tv(&v->di_tv, rettv);
10558 /* restore previous notion of curbuf */
10559 curbuf = save_curbuf;
10562 --emsg_off;
10566 * "getchar()" function
10568 static void
10569 f_getchar(argvars, rettv)
10570 typval_T *argvars;
10571 typval_T *rettv;
10573 varnumber_T n;
10574 int error = FALSE;
10576 /* Position the cursor. Needed after a message that ends in a space. */
10577 windgoto(msg_row, msg_col);
10579 ++no_mapping;
10580 ++allow_keys;
10581 for (;;)
10583 if (argvars[0].v_type == VAR_UNKNOWN)
10584 /* getchar(): blocking wait. */
10585 n = safe_vgetc();
10586 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10587 /* getchar(1): only check if char avail */
10588 n = vpeekc();
10589 else if (error || vpeekc() == NUL)
10590 /* illegal argument or getchar(0) and no char avail: return zero */
10591 n = 0;
10592 else
10593 /* getchar(0) and char avail: return char */
10594 n = safe_vgetc();
10595 if (n == K_IGNORE)
10596 continue;
10597 break;
10599 --no_mapping;
10600 --allow_keys;
10602 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10603 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10604 vimvars[VV_MOUSE_COL].vv_nr = 0;
10606 rettv->vval.v_number = n;
10607 if (IS_SPECIAL(n) || mod_mask != 0)
10609 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10610 int i = 0;
10612 /* Turn a special key into three bytes, plus modifier. */
10613 if (mod_mask != 0)
10615 temp[i++] = K_SPECIAL;
10616 temp[i++] = KS_MODIFIER;
10617 temp[i++] = mod_mask;
10619 if (IS_SPECIAL(n))
10621 temp[i++] = K_SPECIAL;
10622 temp[i++] = K_SECOND(n);
10623 temp[i++] = K_THIRD(n);
10625 #ifdef FEAT_MBYTE
10626 else if (has_mbyte)
10627 i += (*mb_char2bytes)(n, temp + i);
10628 #endif
10629 else
10630 temp[i++] = n;
10631 temp[i++] = NUL;
10632 rettv->v_type = VAR_STRING;
10633 rettv->vval.v_string = vim_strsave(temp);
10635 #ifdef FEAT_MOUSE
10636 if (n == K_LEFTMOUSE
10637 || n == K_LEFTMOUSE_NM
10638 || n == K_LEFTDRAG
10639 || n == K_LEFTRELEASE
10640 || n == K_LEFTRELEASE_NM
10641 || n == K_MIDDLEMOUSE
10642 || n == K_MIDDLEDRAG
10643 || n == K_MIDDLERELEASE
10644 || n == K_RIGHTMOUSE
10645 || n == K_RIGHTDRAG
10646 || n == K_RIGHTRELEASE
10647 || n == K_X1MOUSE
10648 || n == K_X1DRAG
10649 || n == K_X1RELEASE
10650 || n == K_X2MOUSE
10651 || n == K_X2DRAG
10652 || n == K_X2RELEASE
10653 || n == K_MOUSEDOWN
10654 || n == K_MOUSEUP)
10656 int row = mouse_row;
10657 int col = mouse_col;
10658 win_T *win;
10659 linenr_T lnum;
10660 # ifdef FEAT_WINDOWS
10661 win_T *wp;
10662 # endif
10663 int winnr = 1;
10665 if (row >= 0 && col >= 0)
10667 /* Find the window at the mouse coordinates and compute the
10668 * text position. */
10669 win = mouse_find_win(&row, &col);
10670 (void)mouse_comp_pos(win, &row, &col, &lnum);
10671 # ifdef FEAT_WINDOWS
10672 for (wp = firstwin; wp != win; wp = wp->w_next)
10673 ++winnr;
10674 # endif
10675 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10676 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10677 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10680 #endif
10685 * "getcharmod()" function
10687 static void
10688 f_getcharmod(argvars, rettv)
10689 typval_T *argvars UNUSED;
10690 typval_T *rettv;
10692 rettv->vval.v_number = mod_mask;
10696 * "getcmdline()" function
10698 static void
10699 f_getcmdline(argvars, rettv)
10700 typval_T *argvars UNUSED;
10701 typval_T *rettv;
10703 rettv->v_type = VAR_STRING;
10704 rettv->vval.v_string = get_cmdline_str();
10708 * "getcmdpos()" function
10710 static void
10711 f_getcmdpos(argvars, rettv)
10712 typval_T *argvars UNUSED;
10713 typval_T *rettv;
10715 rettv->vval.v_number = get_cmdline_pos() + 1;
10719 * "getcmdtype()" function
10721 static void
10722 f_getcmdtype(argvars, rettv)
10723 typval_T *argvars UNUSED;
10724 typval_T *rettv;
10726 rettv->v_type = VAR_STRING;
10727 rettv->vval.v_string = alloc(2);
10728 if (rettv->vval.v_string != NULL)
10730 rettv->vval.v_string[0] = get_cmdline_type();
10731 rettv->vval.v_string[1] = NUL;
10736 * "getcwd()" function
10738 static void
10739 f_getcwd(argvars, rettv)
10740 typval_T *argvars UNUSED;
10741 typval_T *rettv;
10743 char_u cwd[MAXPATHL];
10745 rettv->v_type = VAR_STRING;
10746 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10747 rettv->vval.v_string = NULL;
10748 else
10750 rettv->vval.v_string = vim_strsave(cwd);
10751 #ifdef BACKSLASH_IN_FILENAME
10752 if (rettv->vval.v_string != NULL)
10753 slash_adjust(rettv->vval.v_string);
10754 #endif
10759 * "getfontname()" function
10761 static void
10762 f_getfontname(argvars, rettv)
10763 typval_T *argvars UNUSED;
10764 typval_T *rettv;
10766 rettv->v_type = VAR_STRING;
10767 rettv->vval.v_string = NULL;
10768 #ifdef FEAT_GUI
10769 if (gui.in_use)
10771 GuiFont font;
10772 char_u *name = NULL;
10774 if (argvars[0].v_type == VAR_UNKNOWN)
10776 /* Get the "Normal" font. Either the name saved by
10777 * hl_set_font_name() or from the font ID. */
10778 font = gui.norm_font;
10779 name = hl_get_font_name();
10781 else
10783 name = get_tv_string(&argvars[0]);
10784 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10785 return;
10786 font = gui_mch_get_font(name, FALSE);
10787 if (font == NOFONT)
10788 return; /* Invalid font name, return empty string. */
10790 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10791 if (argvars[0].v_type != VAR_UNKNOWN)
10792 gui_mch_free_font(font);
10794 #endif
10798 * "getfperm({fname})" function
10800 static void
10801 f_getfperm(argvars, rettv)
10802 typval_T *argvars;
10803 typval_T *rettv;
10805 char_u *fname;
10806 struct stat st;
10807 char_u *perm = NULL;
10808 char_u flags[] = "rwx";
10809 int i;
10811 fname = get_tv_string(&argvars[0]);
10813 rettv->v_type = VAR_STRING;
10814 if (mch_stat((char *)fname, &st) >= 0)
10816 perm = vim_strsave((char_u *)"---------");
10817 if (perm != NULL)
10819 for (i = 0; i < 9; i++)
10821 if (st.st_mode & (1 << (8 - i)))
10822 perm[i] = flags[i % 3];
10826 rettv->vval.v_string = perm;
10830 * "getfsize({fname})" function
10832 static void
10833 f_getfsize(argvars, rettv)
10834 typval_T *argvars;
10835 typval_T *rettv;
10837 char_u *fname;
10838 struct stat st;
10840 fname = get_tv_string(&argvars[0]);
10842 rettv->v_type = VAR_NUMBER;
10844 if (mch_stat((char *)fname, &st) >= 0)
10846 if (mch_isdir(fname))
10847 rettv->vval.v_number = 0;
10848 else
10850 rettv->vval.v_number = (varnumber_T)st.st_size;
10852 /* non-perfect check for overflow */
10853 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10854 rettv->vval.v_number = -2;
10857 else
10858 rettv->vval.v_number = -1;
10862 * "getftime({fname})" function
10864 static void
10865 f_getftime(argvars, rettv)
10866 typval_T *argvars;
10867 typval_T *rettv;
10869 char_u *fname;
10870 struct stat st;
10872 fname = get_tv_string(&argvars[0]);
10874 if (mch_stat((char *)fname, &st) >= 0)
10875 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10876 else
10877 rettv->vval.v_number = -1;
10881 * "getftype({fname})" function
10883 static void
10884 f_getftype(argvars, rettv)
10885 typval_T *argvars;
10886 typval_T *rettv;
10888 char_u *fname;
10889 struct stat st;
10890 char_u *type = NULL;
10891 char *t;
10893 fname = get_tv_string(&argvars[0]);
10895 rettv->v_type = VAR_STRING;
10896 if (mch_lstat((char *)fname, &st) >= 0)
10898 #ifdef S_ISREG
10899 if (S_ISREG(st.st_mode))
10900 t = "file";
10901 else if (S_ISDIR(st.st_mode))
10902 t = "dir";
10903 # ifdef S_ISLNK
10904 else if (S_ISLNK(st.st_mode))
10905 t = "link";
10906 # endif
10907 # ifdef S_ISBLK
10908 else if (S_ISBLK(st.st_mode))
10909 t = "bdev";
10910 # endif
10911 # ifdef S_ISCHR
10912 else if (S_ISCHR(st.st_mode))
10913 t = "cdev";
10914 # endif
10915 # ifdef S_ISFIFO
10916 else if (S_ISFIFO(st.st_mode))
10917 t = "fifo";
10918 # endif
10919 # ifdef S_ISSOCK
10920 else if (S_ISSOCK(st.st_mode))
10921 t = "fifo";
10922 # endif
10923 else
10924 t = "other";
10925 #else
10926 # ifdef S_IFMT
10927 switch (st.st_mode & S_IFMT)
10929 case S_IFREG: t = "file"; break;
10930 case S_IFDIR: t = "dir"; break;
10931 # ifdef S_IFLNK
10932 case S_IFLNK: t = "link"; break;
10933 # endif
10934 # ifdef S_IFBLK
10935 case S_IFBLK: t = "bdev"; break;
10936 # endif
10937 # ifdef S_IFCHR
10938 case S_IFCHR: t = "cdev"; break;
10939 # endif
10940 # ifdef S_IFIFO
10941 case S_IFIFO: t = "fifo"; break;
10942 # endif
10943 # ifdef S_IFSOCK
10944 case S_IFSOCK: t = "socket"; break;
10945 # endif
10946 default: t = "other";
10948 # else
10949 if (mch_isdir(fname))
10950 t = "dir";
10951 else
10952 t = "file";
10953 # endif
10954 #endif
10955 type = vim_strsave((char_u *)t);
10957 rettv->vval.v_string = type;
10961 * "getline(lnum, [end])" function
10963 static void
10964 f_getline(argvars, rettv)
10965 typval_T *argvars;
10966 typval_T *rettv;
10968 linenr_T lnum;
10969 linenr_T end;
10970 int retlist;
10972 lnum = get_tv_lnum(argvars);
10973 if (argvars[1].v_type == VAR_UNKNOWN)
10975 end = 0;
10976 retlist = FALSE;
10978 else
10980 end = get_tv_lnum(&argvars[1]);
10981 retlist = TRUE;
10984 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
10988 * "getmatches()" function
10990 static void
10991 f_getmatches(argvars, rettv)
10992 typval_T *argvars UNUSED;
10993 typval_T *rettv;
10995 #ifdef FEAT_SEARCH_EXTRA
10996 dict_T *dict;
10997 matchitem_T *cur = curwin->w_match_head;
10999 if (rettv_list_alloc(rettv) == OK)
11001 while (cur != NULL)
11003 dict = dict_alloc();
11004 if (dict == NULL)
11005 return;
11006 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11007 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11008 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11009 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11010 list_append_dict(rettv->vval.v_list, dict);
11011 cur = cur->next;
11014 #endif
11018 * "getpid()" function
11020 static void
11021 f_getpid(argvars, rettv)
11022 typval_T *argvars UNUSED;
11023 typval_T *rettv;
11025 rettv->vval.v_number = mch_get_pid();
11029 * "getpos(string)" function
11031 static void
11032 f_getpos(argvars, rettv)
11033 typval_T *argvars;
11034 typval_T *rettv;
11036 pos_T *fp;
11037 list_T *l;
11038 int fnum = -1;
11040 if (rettv_list_alloc(rettv) == OK)
11042 l = rettv->vval.v_list;
11043 fp = var2fpos(&argvars[0], TRUE, &fnum);
11044 if (fnum != -1)
11045 list_append_number(l, (varnumber_T)fnum);
11046 else
11047 list_append_number(l, (varnumber_T)0);
11048 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11049 : (varnumber_T)0);
11050 list_append_number(l, (fp != NULL)
11051 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11052 : (varnumber_T)0);
11053 list_append_number(l,
11054 #ifdef FEAT_VIRTUALEDIT
11055 (fp != NULL) ? (varnumber_T)fp->coladd :
11056 #endif
11057 (varnumber_T)0);
11059 else
11060 rettv->vval.v_number = FALSE;
11064 * "getqflist()" and "getloclist()" functions
11066 static void
11067 f_getqflist(argvars, rettv)
11068 typval_T *argvars UNUSED;
11069 typval_T *rettv UNUSED;
11071 #ifdef FEAT_QUICKFIX
11072 win_T *wp;
11073 #endif
11075 #ifdef FEAT_QUICKFIX
11076 if (rettv_list_alloc(rettv) == OK)
11078 wp = NULL;
11079 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11081 wp = find_win_by_nr(&argvars[0], NULL);
11082 if (wp == NULL)
11083 return;
11086 (void)get_errorlist(wp, rettv->vval.v_list);
11088 #endif
11092 * "getreg()" function
11094 static void
11095 f_getreg(argvars, rettv)
11096 typval_T *argvars;
11097 typval_T *rettv;
11099 char_u *strregname;
11100 int regname;
11101 int arg2 = FALSE;
11102 int error = FALSE;
11104 if (argvars[0].v_type != VAR_UNKNOWN)
11106 strregname = get_tv_string_chk(&argvars[0]);
11107 error = strregname == NULL;
11108 if (argvars[1].v_type != VAR_UNKNOWN)
11109 arg2 = get_tv_number_chk(&argvars[1], &error);
11111 else
11112 strregname = vimvars[VV_REG].vv_str;
11113 regname = (strregname == NULL ? '"' : *strregname);
11114 if (regname == 0)
11115 regname = '"';
11117 rettv->v_type = VAR_STRING;
11118 rettv->vval.v_string = error ? NULL :
11119 get_reg_contents(regname, TRUE, arg2);
11123 * "getregtype()" function
11125 static void
11126 f_getregtype(argvars, rettv)
11127 typval_T *argvars;
11128 typval_T *rettv;
11130 char_u *strregname;
11131 int regname;
11132 char_u buf[NUMBUFLEN + 2];
11133 long reglen = 0;
11135 if (argvars[0].v_type != VAR_UNKNOWN)
11137 strregname = get_tv_string_chk(&argvars[0]);
11138 if (strregname == NULL) /* type error; errmsg already given */
11140 rettv->v_type = VAR_STRING;
11141 rettv->vval.v_string = NULL;
11142 return;
11145 else
11146 /* Default to v:register */
11147 strregname = vimvars[VV_REG].vv_str;
11149 regname = (strregname == NULL ? '"' : *strregname);
11150 if (regname == 0)
11151 regname = '"';
11153 buf[0] = NUL;
11154 buf[1] = NUL;
11155 switch (get_reg_type(regname, &reglen))
11157 case MLINE: buf[0] = 'V'; break;
11158 case MCHAR: buf[0] = 'v'; break;
11159 #ifdef FEAT_VISUAL
11160 case MBLOCK:
11161 buf[0] = Ctrl_V;
11162 sprintf((char *)buf + 1, "%ld", reglen + 1);
11163 break;
11164 #endif
11166 rettv->v_type = VAR_STRING;
11167 rettv->vval.v_string = vim_strsave(buf);
11171 * "gettabwinvar()" function
11173 static void
11174 f_gettabwinvar(argvars, rettv)
11175 typval_T *argvars;
11176 typval_T *rettv;
11178 getwinvar(argvars, rettv, 1);
11182 * "getwinposx()" function
11184 static void
11185 f_getwinposx(argvars, rettv)
11186 typval_T *argvars UNUSED;
11187 typval_T *rettv;
11189 rettv->vval.v_number = -1;
11190 #ifdef FEAT_GUI
11191 if (gui.in_use)
11193 int x, y;
11195 if (gui_mch_get_winpos(&x, &y) == OK)
11196 rettv->vval.v_number = x;
11198 #endif
11202 * "getwinposy()" function
11204 static void
11205 f_getwinposy(argvars, rettv)
11206 typval_T *argvars UNUSED;
11207 typval_T *rettv;
11209 rettv->vval.v_number = -1;
11210 #ifdef FEAT_GUI
11211 if (gui.in_use)
11213 int x, y;
11215 if (gui_mch_get_winpos(&x, &y) == OK)
11216 rettv->vval.v_number = y;
11218 #endif
11222 * Find window specified by "vp" in tabpage "tp".
11224 static win_T *
11225 find_win_by_nr(vp, tp)
11226 typval_T *vp;
11227 tabpage_T *tp; /* NULL for current tab page */
11229 #ifdef FEAT_WINDOWS
11230 win_T *wp;
11231 #endif
11232 int nr;
11234 nr = get_tv_number_chk(vp, NULL);
11236 #ifdef FEAT_WINDOWS
11237 if (nr < 0)
11238 return NULL;
11239 if (nr == 0)
11240 return curwin;
11242 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11243 wp != NULL; wp = wp->w_next)
11244 if (--nr <= 0)
11245 break;
11246 return wp;
11247 #else
11248 if (nr == 0 || nr == 1)
11249 return curwin;
11250 return NULL;
11251 #endif
11255 * "getwinvar()" function
11257 static void
11258 f_getwinvar(argvars, rettv)
11259 typval_T *argvars;
11260 typval_T *rettv;
11262 getwinvar(argvars, rettv, 0);
11266 * getwinvar() and gettabwinvar()
11268 static void
11269 getwinvar(argvars, rettv, off)
11270 typval_T *argvars;
11271 typval_T *rettv;
11272 int off; /* 1 for gettabwinvar() */
11274 win_T *win, *oldcurwin;
11275 char_u *varname;
11276 dictitem_T *v;
11277 tabpage_T *tp;
11279 #ifdef FEAT_WINDOWS
11280 if (off == 1)
11281 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11282 else
11283 tp = curtab;
11284 #endif
11285 win = find_win_by_nr(&argvars[off], tp);
11286 varname = get_tv_string_chk(&argvars[off + 1]);
11287 ++emsg_off;
11289 rettv->v_type = VAR_STRING;
11290 rettv->vval.v_string = NULL;
11292 if (win != NULL && varname != NULL)
11294 /* Set curwin to be our win, temporarily. Also set curbuf, so
11295 * that we can get buffer-local options. */
11296 oldcurwin = curwin;
11297 curwin = win;
11298 curbuf = win->w_buffer;
11300 if (*varname == '&') /* window-local-option */
11301 get_option_tv(&varname, rettv, 1);
11302 else
11304 if (*varname == NUL)
11305 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11306 * scope prefix before the NUL byte is required by
11307 * find_var_in_ht(). */
11308 varname = (char_u *)"w:" + 2;
11309 /* look up the variable */
11310 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11311 if (v != NULL)
11312 copy_tv(&v->di_tv, rettv);
11315 /* restore previous notion of curwin */
11316 curwin = oldcurwin;
11317 curbuf = curwin->w_buffer;
11320 --emsg_off;
11324 * "glob()" function
11326 static void
11327 f_glob(argvars, rettv)
11328 typval_T *argvars;
11329 typval_T *rettv;
11331 int flags = WILD_SILENT|WILD_USE_NL;
11332 expand_T xpc;
11333 int error = FALSE;
11335 /* When the optional second argument is non-zero, don't remove matches
11336 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11337 if (argvars[1].v_type != VAR_UNKNOWN
11338 && get_tv_number_chk(&argvars[1], &error))
11339 flags |= WILD_KEEP_ALL;
11340 rettv->v_type = VAR_STRING;
11341 if (!error)
11343 ExpandInit(&xpc);
11344 xpc.xp_context = EXPAND_FILES;
11345 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11346 NULL, flags, WILD_ALL);
11348 else
11349 rettv->vval.v_string = NULL;
11353 * "globpath()" function
11355 static void
11356 f_globpath(argvars, rettv)
11357 typval_T *argvars;
11358 typval_T *rettv;
11360 int flags = 0;
11361 char_u buf1[NUMBUFLEN];
11362 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11363 int error = FALSE;
11365 /* When the optional second argument is non-zero, don't remove matches
11366 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11367 if (argvars[2].v_type != VAR_UNKNOWN
11368 && get_tv_number_chk(&argvars[2], &error))
11369 flags |= WILD_KEEP_ALL;
11370 rettv->v_type = VAR_STRING;
11371 if (file == NULL || error)
11372 rettv->vval.v_string = NULL;
11373 else
11374 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11375 flags);
11379 * "has()" function
11381 static void
11382 f_has(argvars, rettv)
11383 typval_T *argvars;
11384 typval_T *rettv;
11386 int i;
11387 char_u *name;
11388 int n = FALSE;
11389 static char *(has_list[]) =
11391 #ifdef AMIGA
11392 "amiga",
11393 # ifdef FEAT_ARP
11394 "arp",
11395 # endif
11396 #endif
11397 #ifdef __BEOS__
11398 "beos",
11399 #endif
11400 #ifdef MSDOS
11401 # ifdef DJGPP
11402 "dos32",
11403 # else
11404 "dos16",
11405 # endif
11406 #endif
11407 #ifdef MACOS
11408 "mac",
11409 #endif
11410 #if defined(MACOS_X_UNIX)
11411 "macunix",
11412 #endif
11413 #ifdef OS2
11414 "os2",
11415 #endif
11416 #ifdef __QNX__
11417 "qnx",
11418 #endif
11419 #ifdef RISCOS
11420 "riscos",
11421 #endif
11422 #ifdef UNIX
11423 "unix",
11424 #endif
11425 #ifdef VMS
11426 "vms",
11427 #endif
11428 #ifdef WIN16
11429 "win16",
11430 #endif
11431 #ifdef WIN32
11432 "win32",
11433 #endif
11434 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11435 "win32unix",
11436 #endif
11437 #ifdef WIN64
11438 "win64",
11439 #endif
11440 #ifdef EBCDIC
11441 "ebcdic",
11442 #endif
11443 #ifndef CASE_INSENSITIVE_FILENAME
11444 "fname_case",
11445 #endif
11446 #ifdef FEAT_ARABIC
11447 "arabic",
11448 #endif
11449 #ifdef FEAT_AUTOCMD
11450 "autocmd",
11451 #endif
11452 #ifdef FEAT_BEVAL
11453 "balloon_eval",
11454 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11455 "balloon_multiline",
11456 # endif
11457 #endif
11458 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11459 "builtin_terms",
11460 # ifdef ALL_BUILTIN_TCAPS
11461 "all_builtin_terms",
11462 # endif
11463 #endif
11464 #ifdef FEAT_BYTEOFF
11465 "byte_offset",
11466 #endif
11467 #ifdef FEAT_CINDENT
11468 "cindent",
11469 #endif
11470 #ifdef FEAT_CLIENTSERVER
11471 "clientserver",
11472 #endif
11473 #ifdef FEAT_CLIPBOARD
11474 "clipboard",
11475 #endif
11476 #ifdef FEAT_CMDL_COMPL
11477 "cmdline_compl",
11478 #endif
11479 #ifdef FEAT_CMDHIST
11480 "cmdline_hist",
11481 #endif
11482 #ifdef FEAT_COMMENTS
11483 "comments",
11484 #endif
11485 #ifdef FEAT_CRYPT
11486 "cryptv",
11487 #endif
11488 #ifdef FEAT_CSCOPE
11489 "cscope",
11490 #endif
11491 #ifdef CURSOR_SHAPE
11492 "cursorshape",
11493 #endif
11494 #ifdef DEBUG
11495 "debug",
11496 #endif
11497 #ifdef FEAT_CON_DIALOG
11498 "dialog_con",
11499 #endif
11500 #ifdef FEAT_GUI_DIALOG
11501 "dialog_gui",
11502 #endif
11503 #ifdef FEAT_DIFF
11504 "diff",
11505 #endif
11506 #ifdef FEAT_DIGRAPHS
11507 "digraphs",
11508 #endif
11509 #ifdef FEAT_DND
11510 "dnd",
11511 #endif
11512 #ifdef FEAT_EMACS_TAGS
11513 "emacs_tags",
11514 #endif
11515 "eval", /* always present, of course! */
11516 #ifdef FEAT_EX_EXTRA
11517 "ex_extra",
11518 #endif
11519 #ifdef FEAT_SEARCH_EXTRA
11520 "extra_search",
11521 #endif
11522 #ifdef FEAT_FKMAP
11523 "farsi",
11524 #endif
11525 #ifdef FEAT_SEARCHPATH
11526 "file_in_path",
11527 #endif
11528 #if defined(UNIX) && !defined(USE_SYSTEM)
11529 "filterpipe",
11530 #endif
11531 #ifdef FEAT_FIND_ID
11532 "find_in_path",
11533 #endif
11534 #ifdef FEAT_FLOAT
11535 "float",
11536 #endif
11537 #ifdef FEAT_FOLDING
11538 "folding",
11539 #endif
11540 #ifdef FEAT_FOOTER
11541 "footer",
11542 #endif
11543 #if !defined(USE_SYSTEM) && defined(UNIX)
11544 "fork",
11545 #endif
11546 #ifdef FEAT_GETTEXT
11547 "gettext",
11548 #endif
11549 #ifdef FEAT_GUI
11550 "gui",
11551 #endif
11552 #ifdef FEAT_GUI_ATHENA
11553 # ifdef FEAT_GUI_NEXTAW
11554 "gui_neXtaw",
11555 # else
11556 "gui_athena",
11557 # endif
11558 #endif
11559 #ifdef FEAT_GUI_GTK
11560 "gui_gtk",
11561 # ifdef HAVE_GTK2
11562 "gui_gtk2",
11563 # endif
11564 #endif
11565 #ifdef FEAT_GUI_GNOME
11566 "gui_gnome",
11567 #endif
11568 #ifdef FEAT_GUI_MAC
11569 "gui_mac",
11570 #endif
11571 #ifdef FEAT_GUI_MOTIF
11572 "gui_motif",
11573 #endif
11574 #ifdef FEAT_GUI_PHOTON
11575 "gui_photon",
11576 #endif
11577 #ifdef FEAT_GUI_W16
11578 "gui_win16",
11579 #endif
11580 #ifdef FEAT_GUI_W32
11581 "gui_win32",
11582 #endif
11583 #ifdef FEAT_HANGULIN
11584 "hangul_input",
11585 #endif
11586 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11587 "iconv",
11588 #endif
11589 #ifdef FEAT_INS_EXPAND
11590 "insert_expand",
11591 #endif
11592 #ifdef FEAT_JUMPLIST
11593 "jumplist",
11594 #endif
11595 #ifdef FEAT_KEYMAP
11596 "keymap",
11597 #endif
11598 #ifdef FEAT_LANGMAP
11599 "langmap",
11600 #endif
11601 #ifdef FEAT_LIBCALL
11602 "libcall",
11603 #endif
11604 #ifdef FEAT_LINEBREAK
11605 "linebreak",
11606 #endif
11607 #ifdef FEAT_LISP
11608 "lispindent",
11609 #endif
11610 #ifdef FEAT_LISTCMDS
11611 "listcmds",
11612 #endif
11613 #ifdef FEAT_LOCALMAP
11614 "localmap",
11615 #endif
11616 #ifdef FEAT_MENU
11617 "menu",
11618 #endif
11619 #ifdef FEAT_SESSION
11620 "mksession",
11621 #endif
11622 #ifdef FEAT_MODIFY_FNAME
11623 "modify_fname",
11624 #endif
11625 #ifdef FEAT_MOUSE
11626 "mouse",
11627 #endif
11628 #ifdef FEAT_MOUSESHAPE
11629 "mouseshape",
11630 #endif
11631 #if defined(UNIX) || defined(VMS)
11632 # ifdef FEAT_MOUSE_DEC
11633 "mouse_dec",
11634 # endif
11635 # ifdef FEAT_MOUSE_GPM
11636 "mouse_gpm",
11637 # endif
11638 # ifdef FEAT_MOUSE_JSB
11639 "mouse_jsbterm",
11640 # endif
11641 # ifdef FEAT_MOUSE_NET
11642 "mouse_netterm",
11643 # endif
11644 # ifdef FEAT_MOUSE_PTERM
11645 "mouse_pterm",
11646 # endif
11647 # ifdef FEAT_SYSMOUSE
11648 "mouse_sysmouse",
11649 # endif
11650 # ifdef FEAT_MOUSE_XTERM
11651 "mouse_xterm",
11652 # endif
11653 #endif
11654 #ifdef FEAT_MBYTE
11655 "multi_byte",
11656 #endif
11657 #ifdef FEAT_MBYTE_IME
11658 "multi_byte_ime",
11659 #endif
11660 #ifdef FEAT_MULTI_LANG
11661 "multi_lang",
11662 #endif
11663 #ifdef FEAT_MZSCHEME
11664 #ifndef DYNAMIC_MZSCHEME
11665 "mzscheme",
11666 #endif
11667 #endif
11668 #ifdef FEAT_OLE
11669 "ole",
11670 #endif
11671 #ifdef FEAT_OSFILETYPE
11672 "osfiletype",
11673 #endif
11674 #ifdef FEAT_PATH_EXTRA
11675 "path_extra",
11676 #endif
11677 #ifdef FEAT_PERL
11678 #ifndef DYNAMIC_PERL
11679 "perl",
11680 #endif
11681 #endif
11682 #ifdef FEAT_PYTHON
11683 #ifndef DYNAMIC_PYTHON
11684 "python",
11685 #endif
11686 #endif
11687 #ifdef FEAT_POSTSCRIPT
11688 "postscript",
11689 #endif
11690 #ifdef FEAT_PRINTER
11691 "printer",
11692 #endif
11693 #ifdef FEAT_PROFILE
11694 "profile",
11695 #endif
11696 #ifdef FEAT_RELTIME
11697 "reltime",
11698 #endif
11699 #ifdef FEAT_QUICKFIX
11700 "quickfix",
11701 #endif
11702 #ifdef FEAT_RIGHTLEFT
11703 "rightleft",
11704 #endif
11705 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11706 "ruby",
11707 #endif
11708 #ifdef FEAT_SCROLLBIND
11709 "scrollbind",
11710 #endif
11711 #ifdef FEAT_CMDL_INFO
11712 "showcmd",
11713 "cmdline_info",
11714 #endif
11715 #ifdef FEAT_SIGNS
11716 "signs",
11717 #endif
11718 #ifdef FEAT_SMARTINDENT
11719 "smartindent",
11720 #endif
11721 #ifdef FEAT_SNIFF
11722 "sniff",
11723 #endif
11724 #ifdef FEAT_STL_OPT
11725 "statusline",
11726 #endif
11727 #ifdef FEAT_SUN_WORKSHOP
11728 "sun_workshop",
11729 #endif
11730 #ifdef FEAT_NETBEANS_INTG
11731 "netbeans_intg",
11732 #endif
11733 #ifdef FEAT_SPELL
11734 "spell",
11735 #endif
11736 #ifdef FEAT_SYN_HL
11737 "syntax",
11738 #endif
11739 #if defined(USE_SYSTEM) || !defined(UNIX)
11740 "system",
11741 #endif
11742 #ifdef FEAT_TAG_BINS
11743 "tag_binary",
11744 #endif
11745 #ifdef FEAT_TAG_OLDSTATIC
11746 "tag_old_static",
11747 #endif
11748 #ifdef FEAT_TAG_ANYWHITE
11749 "tag_any_white",
11750 #endif
11751 #ifdef FEAT_TCL
11752 # ifndef DYNAMIC_TCL
11753 "tcl",
11754 # endif
11755 #endif
11756 #ifdef TERMINFO
11757 "terminfo",
11758 #endif
11759 #ifdef FEAT_TERMRESPONSE
11760 "termresponse",
11761 #endif
11762 #ifdef FEAT_TEXTOBJ
11763 "textobjects",
11764 #endif
11765 #ifdef HAVE_TGETENT
11766 "tgetent",
11767 #endif
11768 #ifdef FEAT_TITLE
11769 "title",
11770 #endif
11771 #ifdef FEAT_TOOLBAR
11772 "toolbar",
11773 #endif
11774 #ifdef FEAT_USR_CMDS
11775 "user-commands", /* was accidentally included in 5.4 */
11776 "user_commands",
11777 #endif
11778 #ifdef FEAT_VIMINFO
11779 "viminfo",
11780 #endif
11781 #ifdef FEAT_VERTSPLIT
11782 "vertsplit",
11783 #endif
11784 #ifdef FEAT_VIRTUALEDIT
11785 "virtualedit",
11786 #endif
11787 #ifdef FEAT_VISUAL
11788 "visual",
11789 #endif
11790 #ifdef FEAT_VISUALEXTRA
11791 "visualextra",
11792 #endif
11793 #ifdef FEAT_VREPLACE
11794 "vreplace",
11795 #endif
11796 #ifdef FEAT_WILDIGN
11797 "wildignore",
11798 #endif
11799 #ifdef FEAT_WILDMENU
11800 "wildmenu",
11801 #endif
11802 #ifdef FEAT_WINDOWS
11803 "windows",
11804 #endif
11805 #ifdef FEAT_WAK
11806 "winaltkeys",
11807 #endif
11808 #ifdef FEAT_WRITEBACKUP
11809 "writebackup",
11810 #endif
11811 #ifdef FEAT_XIM
11812 "xim",
11813 #endif
11814 #ifdef FEAT_XFONTSET
11815 "xfontset",
11816 #endif
11817 #ifdef USE_XSMP
11818 "xsmp",
11819 #endif
11820 #ifdef USE_XSMP_INTERACT
11821 "xsmp_interact",
11822 #endif
11823 #ifdef FEAT_XCLIPBOARD
11824 "xterm_clipboard",
11825 #endif
11826 #ifdef FEAT_XTERM_SAVE
11827 "xterm_save",
11828 #endif
11829 #if defined(UNIX) && defined(FEAT_X11)
11830 "X11",
11831 #endif
11832 NULL
11835 name = get_tv_string(&argvars[0]);
11836 for (i = 0; has_list[i] != NULL; ++i)
11837 if (STRICMP(name, has_list[i]) == 0)
11839 n = TRUE;
11840 break;
11843 if (n == FALSE)
11845 if (STRNICMP(name, "patch", 5) == 0)
11846 n = has_patch(atoi((char *)name + 5));
11847 else if (STRICMP(name, "vim_starting") == 0)
11848 n = (starting != 0);
11849 #ifdef FEAT_MBYTE
11850 else if (STRICMP(name, "multi_byte_encoding") == 0)
11851 n = has_mbyte;
11852 #endif
11853 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11854 else if (STRICMP(name, "balloon_multiline") == 0)
11855 n = multiline_balloon_available();
11856 #endif
11857 #ifdef DYNAMIC_TCL
11858 else if (STRICMP(name, "tcl") == 0)
11859 n = tcl_enabled(FALSE);
11860 #endif
11861 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11862 else if (STRICMP(name, "iconv") == 0)
11863 n = iconv_enabled(FALSE);
11864 #endif
11865 #ifdef DYNAMIC_MZSCHEME
11866 else if (STRICMP(name, "mzscheme") == 0)
11867 n = mzscheme_enabled(FALSE);
11868 #endif
11869 #ifdef DYNAMIC_RUBY
11870 else if (STRICMP(name, "ruby") == 0)
11871 n = ruby_enabled(FALSE);
11872 #endif
11873 #ifdef DYNAMIC_PYTHON
11874 else if (STRICMP(name, "python") == 0)
11875 n = python_enabled(FALSE);
11876 #endif
11877 #ifdef DYNAMIC_PERL
11878 else if (STRICMP(name, "perl") == 0)
11879 n = perl_enabled(FALSE);
11880 #endif
11881 #ifdef FEAT_GUI
11882 else if (STRICMP(name, "gui_running") == 0)
11883 n = (gui.in_use || gui.starting);
11884 # ifdef FEAT_GUI_W32
11885 else if (STRICMP(name, "gui_win32s") == 0)
11886 n = gui_is_win32s();
11887 # endif
11888 # ifdef FEAT_BROWSE
11889 else if (STRICMP(name, "browse") == 0)
11890 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11891 # endif
11892 #endif
11893 #ifdef FEAT_SYN_HL
11894 else if (STRICMP(name, "syntax_items") == 0)
11895 n = syntax_present(curbuf);
11896 #endif
11897 #if defined(WIN3264)
11898 else if (STRICMP(name, "win95") == 0)
11899 n = mch_windows95();
11900 #endif
11901 #ifdef FEAT_NETBEANS_INTG
11902 else if (STRICMP(name, "netbeans_enabled") == 0)
11903 n = usingNetbeans;
11904 #endif
11907 rettv->vval.v_number = n;
11911 * "has_key()" function
11913 static void
11914 f_has_key(argvars, rettv)
11915 typval_T *argvars;
11916 typval_T *rettv;
11918 if (argvars[0].v_type != VAR_DICT)
11920 EMSG(_(e_dictreq));
11921 return;
11923 if (argvars[0].vval.v_dict == NULL)
11924 return;
11926 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11927 get_tv_string(&argvars[1]), -1) != NULL;
11931 * "haslocaldir()" function
11933 static void
11934 f_haslocaldir(argvars, rettv)
11935 typval_T *argvars UNUSED;
11936 typval_T *rettv;
11938 rettv->vval.v_number = (curwin->w_localdir != NULL);
11942 * "hasmapto()" function
11944 static void
11945 f_hasmapto(argvars, rettv)
11946 typval_T *argvars;
11947 typval_T *rettv;
11949 char_u *name;
11950 char_u *mode;
11951 char_u buf[NUMBUFLEN];
11952 int abbr = FALSE;
11954 name = get_tv_string(&argvars[0]);
11955 if (argvars[1].v_type == VAR_UNKNOWN)
11956 mode = (char_u *)"nvo";
11957 else
11959 mode = get_tv_string_buf(&argvars[1], buf);
11960 if (argvars[2].v_type != VAR_UNKNOWN)
11961 abbr = get_tv_number(&argvars[2]);
11964 if (map_to_exists(name, mode, abbr))
11965 rettv->vval.v_number = TRUE;
11966 else
11967 rettv->vval.v_number = FALSE;
11971 * "histadd()" function
11973 static void
11974 f_histadd(argvars, rettv)
11975 typval_T *argvars UNUSED;
11976 typval_T *rettv;
11978 #ifdef FEAT_CMDHIST
11979 int histype;
11980 char_u *str;
11981 char_u buf[NUMBUFLEN];
11982 #endif
11984 rettv->vval.v_number = FALSE;
11985 if (check_restricted() || check_secure())
11986 return;
11987 #ifdef FEAT_CMDHIST
11988 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11989 histype = str != NULL ? get_histtype(str) : -1;
11990 if (histype >= 0)
11992 str = get_tv_string_buf(&argvars[1], buf);
11993 if (*str != NUL)
11995 add_to_history(histype, str, FALSE, NUL);
11996 rettv->vval.v_number = TRUE;
11997 return;
12000 #endif
12004 * "histdel()" function
12006 static void
12007 f_histdel(argvars, rettv)
12008 typval_T *argvars UNUSED;
12009 typval_T *rettv UNUSED;
12011 #ifdef FEAT_CMDHIST
12012 int n;
12013 char_u buf[NUMBUFLEN];
12014 char_u *str;
12016 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12017 if (str == NULL)
12018 n = 0;
12019 else if (argvars[1].v_type == VAR_UNKNOWN)
12020 /* only one argument: clear entire history */
12021 n = clr_history(get_histtype(str));
12022 else if (argvars[1].v_type == VAR_NUMBER)
12023 /* index given: remove that entry */
12024 n = del_history_idx(get_histtype(str),
12025 (int)get_tv_number(&argvars[1]));
12026 else
12027 /* string given: remove all matching entries */
12028 n = del_history_entry(get_histtype(str),
12029 get_tv_string_buf(&argvars[1], buf));
12030 rettv->vval.v_number = n;
12031 #endif
12035 * "histget()" function
12037 static void
12038 f_histget(argvars, rettv)
12039 typval_T *argvars UNUSED;
12040 typval_T *rettv;
12042 #ifdef FEAT_CMDHIST
12043 int type;
12044 int idx;
12045 char_u *str;
12047 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12048 if (str == NULL)
12049 rettv->vval.v_string = NULL;
12050 else
12052 type = get_histtype(str);
12053 if (argvars[1].v_type == VAR_UNKNOWN)
12054 idx = get_history_idx(type);
12055 else
12056 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12057 /* -1 on type error */
12058 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12060 #else
12061 rettv->vval.v_string = NULL;
12062 #endif
12063 rettv->v_type = VAR_STRING;
12067 * "histnr()" function
12069 static void
12070 f_histnr(argvars, rettv)
12071 typval_T *argvars UNUSED;
12072 typval_T *rettv;
12074 int i;
12076 #ifdef FEAT_CMDHIST
12077 char_u *history = get_tv_string_chk(&argvars[0]);
12079 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12080 if (i >= HIST_CMD && i < HIST_COUNT)
12081 i = get_history_idx(i);
12082 else
12083 #endif
12084 i = -1;
12085 rettv->vval.v_number = i;
12089 * "highlightID(name)" function
12091 static void
12092 f_hlID(argvars, rettv)
12093 typval_T *argvars;
12094 typval_T *rettv;
12096 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12100 * "highlight_exists()" function
12102 static void
12103 f_hlexists(argvars, rettv)
12104 typval_T *argvars;
12105 typval_T *rettv;
12107 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12111 * "hostname()" function
12113 static void
12114 f_hostname(argvars, rettv)
12115 typval_T *argvars UNUSED;
12116 typval_T *rettv;
12118 char_u hostname[256];
12120 mch_get_host_name(hostname, 256);
12121 rettv->v_type = VAR_STRING;
12122 rettv->vval.v_string = vim_strsave(hostname);
12126 * iconv() function
12128 static void
12129 f_iconv(argvars, rettv)
12130 typval_T *argvars UNUSED;
12131 typval_T *rettv;
12133 #ifdef FEAT_MBYTE
12134 char_u buf1[NUMBUFLEN];
12135 char_u buf2[NUMBUFLEN];
12136 char_u *from, *to, *str;
12137 vimconv_T vimconv;
12138 #endif
12140 rettv->v_type = VAR_STRING;
12141 rettv->vval.v_string = NULL;
12143 #ifdef FEAT_MBYTE
12144 str = get_tv_string(&argvars[0]);
12145 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12146 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12147 vimconv.vc_type = CONV_NONE;
12148 convert_setup(&vimconv, from, to);
12150 /* If the encodings are equal, no conversion needed. */
12151 if (vimconv.vc_type == CONV_NONE)
12152 rettv->vval.v_string = vim_strsave(str);
12153 else
12154 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12156 convert_setup(&vimconv, NULL, NULL);
12157 vim_free(from);
12158 vim_free(to);
12159 #endif
12163 * "indent()" function
12165 static void
12166 f_indent(argvars, rettv)
12167 typval_T *argvars;
12168 typval_T *rettv;
12170 linenr_T lnum;
12172 lnum = get_tv_lnum(argvars);
12173 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12174 rettv->vval.v_number = get_indent_lnum(lnum);
12175 else
12176 rettv->vval.v_number = -1;
12180 * "index()" function
12182 static void
12183 f_index(argvars, rettv)
12184 typval_T *argvars;
12185 typval_T *rettv;
12187 list_T *l;
12188 listitem_T *item;
12189 long idx = 0;
12190 int ic = FALSE;
12192 rettv->vval.v_number = -1;
12193 if (argvars[0].v_type != VAR_LIST)
12195 EMSG(_(e_listreq));
12196 return;
12198 l = argvars[0].vval.v_list;
12199 if (l != NULL)
12201 item = l->lv_first;
12202 if (argvars[2].v_type != VAR_UNKNOWN)
12204 int error = FALSE;
12206 /* Start at specified item. Use the cached index that list_find()
12207 * sets, so that a negative number also works. */
12208 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12209 idx = l->lv_idx;
12210 if (argvars[3].v_type != VAR_UNKNOWN)
12211 ic = get_tv_number_chk(&argvars[3], &error);
12212 if (error)
12213 item = NULL;
12216 for ( ; item != NULL; item = item->li_next, ++idx)
12217 if (tv_equal(&item->li_tv, &argvars[1], ic))
12219 rettv->vval.v_number = idx;
12220 break;
12225 static int inputsecret_flag = 0;
12227 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12230 * This function is used by f_input() and f_inputdialog() functions. The third
12231 * argument to f_input() specifies the type of completion to use at the
12232 * prompt. The third argument to f_inputdialog() specifies the value to return
12233 * when the user cancels the prompt.
12235 static void
12236 get_user_input(argvars, rettv, inputdialog)
12237 typval_T *argvars;
12238 typval_T *rettv;
12239 int inputdialog;
12241 char_u *prompt = get_tv_string_chk(&argvars[0]);
12242 char_u *p = NULL;
12243 int c;
12244 char_u buf[NUMBUFLEN];
12245 int cmd_silent_save = cmd_silent;
12246 char_u *defstr = (char_u *)"";
12247 int xp_type = EXPAND_NOTHING;
12248 char_u *xp_arg = NULL;
12250 rettv->v_type = VAR_STRING;
12251 rettv->vval.v_string = NULL;
12253 #ifdef NO_CONSOLE_INPUT
12254 /* While starting up, there is no place to enter text. */
12255 if (no_console_input())
12256 return;
12257 #endif
12259 cmd_silent = FALSE; /* Want to see the prompt. */
12260 if (prompt != NULL)
12262 /* Only the part of the message after the last NL is considered as
12263 * prompt for the command line */
12264 p = vim_strrchr(prompt, '\n');
12265 if (p == NULL)
12266 p = prompt;
12267 else
12269 ++p;
12270 c = *p;
12271 *p = NUL;
12272 msg_start();
12273 msg_clr_eos();
12274 msg_puts_attr(prompt, echo_attr);
12275 msg_didout = FALSE;
12276 msg_starthere();
12277 *p = c;
12279 cmdline_row = msg_row;
12281 if (argvars[1].v_type != VAR_UNKNOWN)
12283 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12284 if (defstr != NULL)
12285 stuffReadbuffSpec(defstr);
12287 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12289 char_u *xp_name;
12290 int xp_namelen;
12291 long argt;
12293 rettv->vval.v_string = NULL;
12295 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12296 if (xp_name == NULL)
12297 return;
12299 xp_namelen = (int)STRLEN(xp_name);
12301 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12302 &xp_arg) == FAIL)
12303 return;
12307 if (defstr != NULL)
12308 rettv->vval.v_string =
12309 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12310 xp_type, xp_arg);
12312 vim_free(xp_arg);
12314 /* since the user typed this, no need to wait for return */
12315 need_wait_return = FALSE;
12316 msg_didout = FALSE;
12318 cmd_silent = cmd_silent_save;
12322 * "input()" function
12323 * Also handles inputsecret() when inputsecret is set.
12325 static void
12326 f_input(argvars, rettv)
12327 typval_T *argvars;
12328 typval_T *rettv;
12330 get_user_input(argvars, rettv, FALSE);
12334 * "inputdialog()" function
12336 static void
12337 f_inputdialog(argvars, rettv)
12338 typval_T *argvars;
12339 typval_T *rettv;
12341 #if defined(FEAT_GUI_TEXTDIALOG)
12342 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12343 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12345 char_u *message;
12346 char_u buf[NUMBUFLEN];
12347 char_u *defstr = (char_u *)"";
12349 message = get_tv_string_chk(&argvars[0]);
12350 if (argvars[1].v_type != VAR_UNKNOWN
12351 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12352 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12353 else
12354 IObuff[0] = NUL;
12355 if (message != NULL && defstr != NULL
12356 && do_dialog(VIM_QUESTION, NULL, message,
12357 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12358 rettv->vval.v_string = vim_strsave(IObuff);
12359 else
12361 if (message != NULL && defstr != NULL
12362 && argvars[1].v_type != VAR_UNKNOWN
12363 && argvars[2].v_type != VAR_UNKNOWN)
12364 rettv->vval.v_string = vim_strsave(
12365 get_tv_string_buf(&argvars[2], buf));
12366 else
12367 rettv->vval.v_string = NULL;
12369 rettv->v_type = VAR_STRING;
12371 else
12372 #endif
12373 get_user_input(argvars, rettv, TRUE);
12377 * "inputlist()" function
12379 static void
12380 f_inputlist(argvars, rettv)
12381 typval_T *argvars;
12382 typval_T *rettv;
12384 listitem_T *li;
12385 int selected;
12386 int mouse_used;
12388 #ifdef NO_CONSOLE_INPUT
12389 /* While starting up, there is no place to enter text. */
12390 if (no_console_input())
12391 return;
12392 #endif
12393 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12395 EMSG2(_(e_listarg), "inputlist()");
12396 return;
12399 msg_start();
12400 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12401 lines_left = Rows; /* avoid more prompt */
12402 msg_scroll = TRUE;
12403 msg_clr_eos();
12405 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12407 msg_puts(get_tv_string(&li->li_tv));
12408 msg_putchar('\n');
12411 /* Ask for choice. */
12412 selected = prompt_for_number(&mouse_used);
12413 if (mouse_used)
12414 selected -= lines_left;
12416 rettv->vval.v_number = selected;
12420 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12423 * "inputrestore()" function
12425 static void
12426 f_inputrestore(argvars, rettv)
12427 typval_T *argvars UNUSED;
12428 typval_T *rettv;
12430 if (ga_userinput.ga_len > 0)
12432 --ga_userinput.ga_len;
12433 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12434 + ga_userinput.ga_len);
12435 /* default return is zero == OK */
12437 else if (p_verbose > 1)
12439 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12440 rettv->vval.v_number = 1; /* Failed */
12445 * "inputsave()" function
12447 static void
12448 f_inputsave(argvars, rettv)
12449 typval_T *argvars UNUSED;
12450 typval_T *rettv;
12452 /* Add an entry to the stack of typeahead storage. */
12453 if (ga_grow(&ga_userinput, 1) == OK)
12455 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12456 + ga_userinput.ga_len);
12457 ++ga_userinput.ga_len;
12458 /* default return is zero == OK */
12460 else
12461 rettv->vval.v_number = 1; /* Failed */
12465 * "inputsecret()" function
12467 static void
12468 f_inputsecret(argvars, rettv)
12469 typval_T *argvars;
12470 typval_T *rettv;
12472 ++cmdline_star;
12473 ++inputsecret_flag;
12474 f_input(argvars, rettv);
12475 --cmdline_star;
12476 --inputsecret_flag;
12480 * "insert()" function
12482 static void
12483 f_insert(argvars, rettv)
12484 typval_T *argvars;
12485 typval_T *rettv;
12487 long before = 0;
12488 listitem_T *item;
12489 list_T *l;
12490 int error = FALSE;
12492 if (argvars[0].v_type != VAR_LIST)
12493 EMSG2(_(e_listarg), "insert()");
12494 else if ((l = argvars[0].vval.v_list) != NULL
12495 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12497 if (argvars[2].v_type != VAR_UNKNOWN)
12498 before = get_tv_number_chk(&argvars[2], &error);
12499 if (error)
12500 return; /* type error; errmsg already given */
12502 if (before == l->lv_len)
12503 item = NULL;
12504 else
12506 item = list_find(l, before);
12507 if (item == NULL)
12509 EMSGN(_(e_listidx), before);
12510 l = NULL;
12513 if (l != NULL)
12515 list_insert_tv(l, &argvars[1], item);
12516 copy_tv(&argvars[0], rettv);
12522 * "isdirectory()" function
12524 static void
12525 f_isdirectory(argvars, rettv)
12526 typval_T *argvars;
12527 typval_T *rettv;
12529 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12533 * "islocked()" function
12535 static void
12536 f_islocked(argvars, rettv)
12537 typval_T *argvars;
12538 typval_T *rettv;
12540 lval_T lv;
12541 char_u *end;
12542 dictitem_T *di;
12544 rettv->vval.v_number = -1;
12545 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12546 FNE_CHECK_START);
12547 if (end != NULL && lv.ll_name != NULL)
12549 if (*end != NUL)
12550 EMSG(_(e_trailing));
12551 else
12553 if (lv.ll_tv == NULL)
12555 if (check_changedtick(lv.ll_name))
12556 rettv->vval.v_number = 1; /* always locked */
12557 else
12559 di = find_var(lv.ll_name, NULL);
12560 if (di != NULL)
12562 /* Consider a variable locked when:
12563 * 1. the variable itself is locked
12564 * 2. the value of the variable is locked.
12565 * 3. the List or Dict value is locked.
12567 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12568 || tv_islocked(&di->di_tv));
12572 else if (lv.ll_range)
12573 EMSG(_("E786: Range not allowed"));
12574 else if (lv.ll_newkey != NULL)
12575 EMSG2(_(e_dictkey), lv.ll_newkey);
12576 else if (lv.ll_list != NULL)
12577 /* List item. */
12578 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12579 else
12580 /* Dictionary item. */
12581 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12585 clear_lval(&lv);
12588 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12591 * Turn a dict into a list:
12592 * "what" == 0: list of keys
12593 * "what" == 1: list of values
12594 * "what" == 2: list of items
12596 static void
12597 dict_list(argvars, rettv, what)
12598 typval_T *argvars;
12599 typval_T *rettv;
12600 int what;
12602 list_T *l2;
12603 dictitem_T *di;
12604 hashitem_T *hi;
12605 listitem_T *li;
12606 listitem_T *li2;
12607 dict_T *d;
12608 int todo;
12610 if (argvars[0].v_type != VAR_DICT)
12612 EMSG(_(e_dictreq));
12613 return;
12615 if ((d = argvars[0].vval.v_dict) == NULL)
12616 return;
12618 if (rettv_list_alloc(rettv) == FAIL)
12619 return;
12621 todo = (int)d->dv_hashtab.ht_used;
12622 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12624 if (!HASHITEM_EMPTY(hi))
12626 --todo;
12627 di = HI2DI(hi);
12629 li = listitem_alloc();
12630 if (li == NULL)
12631 break;
12632 list_append(rettv->vval.v_list, li);
12634 if (what == 0)
12636 /* keys() */
12637 li->li_tv.v_type = VAR_STRING;
12638 li->li_tv.v_lock = 0;
12639 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12641 else if (what == 1)
12643 /* values() */
12644 copy_tv(&di->di_tv, &li->li_tv);
12646 else
12648 /* items() */
12649 l2 = list_alloc();
12650 li->li_tv.v_type = VAR_LIST;
12651 li->li_tv.v_lock = 0;
12652 li->li_tv.vval.v_list = l2;
12653 if (l2 == NULL)
12654 break;
12655 ++l2->lv_refcount;
12657 li2 = listitem_alloc();
12658 if (li2 == NULL)
12659 break;
12660 list_append(l2, li2);
12661 li2->li_tv.v_type = VAR_STRING;
12662 li2->li_tv.v_lock = 0;
12663 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12665 li2 = listitem_alloc();
12666 if (li2 == NULL)
12667 break;
12668 list_append(l2, li2);
12669 copy_tv(&di->di_tv, &li2->li_tv);
12676 * "items(dict)" function
12678 static void
12679 f_items(argvars, rettv)
12680 typval_T *argvars;
12681 typval_T *rettv;
12683 dict_list(argvars, rettv, 2);
12687 * "join()" function
12689 static void
12690 f_join(argvars, rettv)
12691 typval_T *argvars;
12692 typval_T *rettv;
12694 garray_T ga;
12695 char_u *sep;
12697 if (argvars[0].v_type != VAR_LIST)
12699 EMSG(_(e_listreq));
12700 return;
12702 if (argvars[0].vval.v_list == NULL)
12703 return;
12704 if (argvars[1].v_type == VAR_UNKNOWN)
12705 sep = (char_u *)" ";
12706 else
12707 sep = get_tv_string_chk(&argvars[1]);
12709 rettv->v_type = VAR_STRING;
12711 if (sep != NULL)
12713 ga_init2(&ga, (int)sizeof(char), 80);
12714 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12715 ga_append(&ga, NUL);
12716 rettv->vval.v_string = (char_u *)ga.ga_data;
12718 else
12719 rettv->vval.v_string = NULL;
12723 * "keys()" function
12725 static void
12726 f_keys(argvars, rettv)
12727 typval_T *argvars;
12728 typval_T *rettv;
12730 dict_list(argvars, rettv, 0);
12734 * "last_buffer_nr()" function.
12736 static void
12737 f_last_buffer_nr(argvars, rettv)
12738 typval_T *argvars UNUSED;
12739 typval_T *rettv;
12741 int n = 0;
12742 buf_T *buf;
12744 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12745 if (n < buf->b_fnum)
12746 n = buf->b_fnum;
12748 rettv->vval.v_number = n;
12752 * "len()" function
12754 static void
12755 f_len(argvars, rettv)
12756 typval_T *argvars;
12757 typval_T *rettv;
12759 switch (argvars[0].v_type)
12761 case VAR_STRING:
12762 case VAR_NUMBER:
12763 rettv->vval.v_number = (varnumber_T)STRLEN(
12764 get_tv_string(&argvars[0]));
12765 break;
12766 case VAR_LIST:
12767 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12768 break;
12769 case VAR_DICT:
12770 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12771 break;
12772 default:
12773 EMSG(_("E701: Invalid type for len()"));
12774 break;
12778 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12780 static void
12781 libcall_common(argvars, rettv, type)
12782 typval_T *argvars;
12783 typval_T *rettv;
12784 int type;
12786 #ifdef FEAT_LIBCALL
12787 char_u *string_in;
12788 char_u **string_result;
12789 int nr_result;
12790 #endif
12792 rettv->v_type = type;
12793 if (type != VAR_NUMBER)
12794 rettv->vval.v_string = NULL;
12796 if (check_restricted() || check_secure())
12797 return;
12799 #ifdef FEAT_LIBCALL
12800 /* The first two args must be strings, otherwise its meaningless */
12801 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12803 string_in = NULL;
12804 if (argvars[2].v_type == VAR_STRING)
12805 string_in = argvars[2].vval.v_string;
12806 if (type == VAR_NUMBER)
12807 string_result = NULL;
12808 else
12809 string_result = &rettv->vval.v_string;
12810 if (mch_libcall(argvars[0].vval.v_string,
12811 argvars[1].vval.v_string,
12812 string_in,
12813 argvars[2].vval.v_number,
12814 string_result,
12815 &nr_result) == OK
12816 && type == VAR_NUMBER)
12817 rettv->vval.v_number = nr_result;
12819 #endif
12823 * "libcall()" function
12825 static void
12826 f_libcall(argvars, rettv)
12827 typval_T *argvars;
12828 typval_T *rettv;
12830 libcall_common(argvars, rettv, VAR_STRING);
12834 * "libcallnr()" function
12836 static void
12837 f_libcallnr(argvars, rettv)
12838 typval_T *argvars;
12839 typval_T *rettv;
12841 libcall_common(argvars, rettv, VAR_NUMBER);
12845 * "line(string)" function
12847 static void
12848 f_line(argvars, rettv)
12849 typval_T *argvars;
12850 typval_T *rettv;
12852 linenr_T lnum = 0;
12853 pos_T *fp;
12854 int fnum;
12856 fp = var2fpos(&argvars[0], TRUE, &fnum);
12857 if (fp != NULL)
12858 lnum = fp->lnum;
12859 rettv->vval.v_number = lnum;
12863 * "line2byte(lnum)" function
12865 static void
12866 f_line2byte(argvars, rettv)
12867 typval_T *argvars UNUSED;
12868 typval_T *rettv;
12870 #ifndef FEAT_BYTEOFF
12871 rettv->vval.v_number = -1;
12872 #else
12873 linenr_T lnum;
12875 lnum = get_tv_lnum(argvars);
12876 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12877 rettv->vval.v_number = -1;
12878 else
12879 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12880 if (rettv->vval.v_number >= 0)
12881 ++rettv->vval.v_number;
12882 #endif
12886 * "lispindent(lnum)" function
12888 static void
12889 f_lispindent(argvars, rettv)
12890 typval_T *argvars;
12891 typval_T *rettv;
12893 #ifdef FEAT_LISP
12894 pos_T pos;
12895 linenr_T lnum;
12897 pos = curwin->w_cursor;
12898 lnum = get_tv_lnum(argvars);
12899 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12901 curwin->w_cursor.lnum = lnum;
12902 rettv->vval.v_number = get_lisp_indent();
12903 curwin->w_cursor = pos;
12905 else
12906 #endif
12907 rettv->vval.v_number = -1;
12911 * "localtime()" function
12913 static void
12914 f_localtime(argvars, rettv)
12915 typval_T *argvars UNUSED;
12916 typval_T *rettv;
12918 rettv->vval.v_number = (varnumber_T)time(NULL);
12921 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12923 static void
12924 get_maparg(argvars, rettv, exact)
12925 typval_T *argvars;
12926 typval_T *rettv;
12927 int exact;
12929 char_u *keys;
12930 char_u *which;
12931 char_u buf[NUMBUFLEN];
12932 char_u *keys_buf = NULL;
12933 char_u *rhs;
12934 int mode;
12935 garray_T ga;
12936 int abbr = FALSE;
12938 /* return empty string for failure */
12939 rettv->v_type = VAR_STRING;
12940 rettv->vval.v_string = NULL;
12942 keys = get_tv_string(&argvars[0]);
12943 if (*keys == NUL)
12944 return;
12946 if (argvars[1].v_type != VAR_UNKNOWN)
12948 which = get_tv_string_buf_chk(&argvars[1], buf);
12949 if (argvars[2].v_type != VAR_UNKNOWN)
12950 abbr = get_tv_number(&argvars[2]);
12952 else
12953 which = (char_u *)"";
12954 if (which == NULL)
12955 return;
12957 mode = get_map_mode(&which, 0);
12959 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12960 rhs = check_map(keys, mode, exact, FALSE, abbr);
12961 vim_free(keys_buf);
12962 if (rhs != NULL)
12964 ga_init(&ga);
12965 ga.ga_itemsize = 1;
12966 ga.ga_growsize = 40;
12968 while (*rhs != NUL)
12969 ga_concat(&ga, str2special(&rhs, FALSE));
12971 ga_append(&ga, NUL);
12972 rettv->vval.v_string = (char_u *)ga.ga_data;
12976 #ifdef FEAT_FLOAT
12978 * "log10()" function
12980 static void
12981 f_log10(argvars, rettv)
12982 typval_T *argvars;
12983 typval_T *rettv;
12985 float_T f;
12987 rettv->v_type = VAR_FLOAT;
12988 if (get_float_arg(argvars, &f) == OK)
12989 rettv->vval.v_float = log10(f);
12990 else
12991 rettv->vval.v_float = 0.0;
12993 #endif
12996 * "map()" function
12998 static void
12999 f_map(argvars, rettv)
13000 typval_T *argvars;
13001 typval_T *rettv;
13003 filter_map(argvars, rettv, TRUE);
13007 * "maparg()" function
13009 static void
13010 f_maparg(argvars, rettv)
13011 typval_T *argvars;
13012 typval_T *rettv;
13014 get_maparg(argvars, rettv, TRUE);
13018 * "mapcheck()" function
13020 static void
13021 f_mapcheck(argvars, rettv)
13022 typval_T *argvars;
13023 typval_T *rettv;
13025 get_maparg(argvars, rettv, FALSE);
13028 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13030 static void
13031 find_some_match(argvars, rettv, type)
13032 typval_T *argvars;
13033 typval_T *rettv;
13034 int type;
13036 char_u *str = NULL;
13037 char_u *expr = NULL;
13038 char_u *pat;
13039 regmatch_T regmatch;
13040 char_u patbuf[NUMBUFLEN];
13041 char_u strbuf[NUMBUFLEN];
13042 char_u *save_cpo;
13043 long start = 0;
13044 long nth = 1;
13045 colnr_T startcol = 0;
13046 int match = 0;
13047 list_T *l = NULL;
13048 listitem_T *li = NULL;
13049 long idx = 0;
13050 char_u *tofree = NULL;
13052 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13053 save_cpo = p_cpo;
13054 p_cpo = (char_u *)"";
13056 rettv->vval.v_number = -1;
13057 if (type == 3)
13059 /* return empty list when there are no matches */
13060 if (rettv_list_alloc(rettv) == FAIL)
13061 goto theend;
13063 else if (type == 2)
13065 rettv->v_type = VAR_STRING;
13066 rettv->vval.v_string = NULL;
13069 if (argvars[0].v_type == VAR_LIST)
13071 if ((l = argvars[0].vval.v_list) == NULL)
13072 goto theend;
13073 li = l->lv_first;
13075 else
13076 expr = str = get_tv_string(&argvars[0]);
13078 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13079 if (pat == NULL)
13080 goto theend;
13082 if (argvars[2].v_type != VAR_UNKNOWN)
13084 int error = FALSE;
13086 start = get_tv_number_chk(&argvars[2], &error);
13087 if (error)
13088 goto theend;
13089 if (l != NULL)
13091 li = list_find(l, start);
13092 if (li == NULL)
13093 goto theend;
13094 idx = l->lv_idx; /* use the cached index */
13096 else
13098 if (start < 0)
13099 start = 0;
13100 if (start > (long)STRLEN(str))
13101 goto theend;
13102 /* When "count" argument is there ignore matches before "start",
13103 * otherwise skip part of the string. Differs when pattern is "^"
13104 * or "\<". */
13105 if (argvars[3].v_type != VAR_UNKNOWN)
13106 startcol = start;
13107 else
13108 str += start;
13111 if (argvars[3].v_type != VAR_UNKNOWN)
13112 nth = get_tv_number_chk(&argvars[3], &error);
13113 if (error)
13114 goto theend;
13117 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13118 if (regmatch.regprog != NULL)
13120 regmatch.rm_ic = p_ic;
13122 for (;;)
13124 if (l != NULL)
13126 if (li == NULL)
13128 match = FALSE;
13129 break;
13131 vim_free(tofree);
13132 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13133 if (str == NULL)
13134 break;
13137 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13139 if (match && --nth <= 0)
13140 break;
13141 if (l == NULL && !match)
13142 break;
13144 /* Advance to just after the match. */
13145 if (l != NULL)
13147 li = li->li_next;
13148 ++idx;
13150 else
13152 #ifdef FEAT_MBYTE
13153 startcol = (colnr_T)(regmatch.startp[0]
13154 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13155 #else
13156 startcol = regmatch.startp[0] + 1 - str;
13157 #endif
13161 if (match)
13163 if (type == 3)
13165 int i;
13167 /* return list with matched string and submatches */
13168 for (i = 0; i < NSUBEXP; ++i)
13170 if (regmatch.endp[i] == NULL)
13172 if (list_append_string(rettv->vval.v_list,
13173 (char_u *)"", 0) == FAIL)
13174 break;
13176 else if (list_append_string(rettv->vval.v_list,
13177 regmatch.startp[i],
13178 (int)(regmatch.endp[i] - regmatch.startp[i]))
13179 == FAIL)
13180 break;
13183 else if (type == 2)
13185 /* return matched string */
13186 if (l != NULL)
13187 copy_tv(&li->li_tv, rettv);
13188 else
13189 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13190 (int)(regmatch.endp[0] - regmatch.startp[0]));
13192 else if (l != NULL)
13193 rettv->vval.v_number = idx;
13194 else
13196 if (type != 0)
13197 rettv->vval.v_number =
13198 (varnumber_T)(regmatch.startp[0] - str);
13199 else
13200 rettv->vval.v_number =
13201 (varnumber_T)(regmatch.endp[0] - str);
13202 rettv->vval.v_number += (varnumber_T)(str - expr);
13205 vim_free(regmatch.regprog);
13208 theend:
13209 vim_free(tofree);
13210 p_cpo = save_cpo;
13214 * "match()" function
13216 static void
13217 f_match(argvars, rettv)
13218 typval_T *argvars;
13219 typval_T *rettv;
13221 find_some_match(argvars, rettv, 1);
13225 * "matchadd()" function
13227 static void
13228 f_matchadd(argvars, rettv)
13229 typval_T *argvars;
13230 typval_T *rettv;
13232 #ifdef FEAT_SEARCH_EXTRA
13233 char_u buf[NUMBUFLEN];
13234 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13235 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13236 int prio = 10; /* default priority */
13237 int id = -1;
13238 int error = FALSE;
13240 rettv->vval.v_number = -1;
13242 if (grp == NULL || pat == NULL)
13243 return;
13244 if (argvars[2].v_type != VAR_UNKNOWN)
13246 prio = get_tv_number_chk(&argvars[2], &error);
13247 if (argvars[3].v_type != VAR_UNKNOWN)
13248 id = get_tv_number_chk(&argvars[3], &error);
13250 if (error == TRUE)
13251 return;
13252 if (id >= 1 && id <= 3)
13254 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13255 return;
13258 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13259 #endif
13263 * "matcharg()" function
13265 static void
13266 f_matcharg(argvars, rettv)
13267 typval_T *argvars;
13268 typval_T *rettv;
13270 if (rettv_list_alloc(rettv) == OK)
13272 #ifdef FEAT_SEARCH_EXTRA
13273 int id = get_tv_number(&argvars[0]);
13274 matchitem_T *m;
13276 if (id >= 1 && id <= 3)
13278 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13280 list_append_string(rettv->vval.v_list,
13281 syn_id2name(m->hlg_id), -1);
13282 list_append_string(rettv->vval.v_list, m->pattern, -1);
13284 else
13286 list_append_string(rettv->vval.v_list, NUL, -1);
13287 list_append_string(rettv->vval.v_list, NUL, -1);
13290 #endif
13295 * "matchdelete()" function
13297 static void
13298 f_matchdelete(argvars, rettv)
13299 typval_T *argvars;
13300 typval_T *rettv;
13302 #ifdef FEAT_SEARCH_EXTRA
13303 rettv->vval.v_number = match_delete(curwin,
13304 (int)get_tv_number(&argvars[0]), TRUE);
13305 #endif
13309 * "matchend()" function
13311 static void
13312 f_matchend(argvars, rettv)
13313 typval_T *argvars;
13314 typval_T *rettv;
13316 find_some_match(argvars, rettv, 0);
13320 * "matchlist()" function
13322 static void
13323 f_matchlist(argvars, rettv)
13324 typval_T *argvars;
13325 typval_T *rettv;
13327 find_some_match(argvars, rettv, 3);
13331 * "matchstr()" function
13333 static void
13334 f_matchstr(argvars, rettv)
13335 typval_T *argvars;
13336 typval_T *rettv;
13338 find_some_match(argvars, rettv, 2);
13341 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13343 static void
13344 max_min(argvars, rettv, domax)
13345 typval_T *argvars;
13346 typval_T *rettv;
13347 int domax;
13349 long n = 0;
13350 long i;
13351 int error = FALSE;
13353 if (argvars[0].v_type == VAR_LIST)
13355 list_T *l;
13356 listitem_T *li;
13358 l = argvars[0].vval.v_list;
13359 if (l != NULL)
13361 li = l->lv_first;
13362 if (li != NULL)
13364 n = get_tv_number_chk(&li->li_tv, &error);
13365 for (;;)
13367 li = li->li_next;
13368 if (li == NULL)
13369 break;
13370 i = get_tv_number_chk(&li->li_tv, &error);
13371 if (domax ? i > n : i < n)
13372 n = i;
13377 else if (argvars[0].v_type == VAR_DICT)
13379 dict_T *d;
13380 int first = TRUE;
13381 hashitem_T *hi;
13382 int todo;
13384 d = argvars[0].vval.v_dict;
13385 if (d != NULL)
13387 todo = (int)d->dv_hashtab.ht_used;
13388 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13390 if (!HASHITEM_EMPTY(hi))
13392 --todo;
13393 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13394 if (first)
13396 n = i;
13397 first = FALSE;
13399 else if (domax ? i > n : i < n)
13400 n = i;
13405 else
13406 EMSG(_(e_listdictarg));
13407 rettv->vval.v_number = error ? 0 : n;
13411 * "max()" function
13413 static void
13414 f_max(argvars, rettv)
13415 typval_T *argvars;
13416 typval_T *rettv;
13418 max_min(argvars, rettv, TRUE);
13422 * "min()" function
13424 static void
13425 f_min(argvars, rettv)
13426 typval_T *argvars;
13427 typval_T *rettv;
13429 max_min(argvars, rettv, FALSE);
13432 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13435 * Create the directory in which "dir" is located, and higher levels when
13436 * needed.
13438 static int
13439 mkdir_recurse(dir, prot)
13440 char_u *dir;
13441 int prot;
13443 char_u *p;
13444 char_u *updir;
13445 int r = FAIL;
13447 /* Get end of directory name in "dir".
13448 * We're done when it's "/" or "c:/". */
13449 p = gettail_sep(dir);
13450 if (p <= get_past_head(dir))
13451 return OK;
13453 /* If the directory exists we're done. Otherwise: create it.*/
13454 updir = vim_strnsave(dir, (int)(p - dir));
13455 if (updir == NULL)
13456 return FAIL;
13457 if (mch_isdir(updir))
13458 r = OK;
13459 else if (mkdir_recurse(updir, prot) == OK)
13460 r = vim_mkdir_emsg(updir, prot);
13461 vim_free(updir);
13462 return r;
13465 #ifdef vim_mkdir
13467 * "mkdir()" function
13469 static void
13470 f_mkdir(argvars, rettv)
13471 typval_T *argvars;
13472 typval_T *rettv;
13474 char_u *dir;
13475 char_u buf[NUMBUFLEN];
13476 int prot = 0755;
13478 rettv->vval.v_number = FAIL;
13479 if (check_restricted() || check_secure())
13480 return;
13482 dir = get_tv_string_buf(&argvars[0], buf);
13483 if (argvars[1].v_type != VAR_UNKNOWN)
13485 if (argvars[2].v_type != VAR_UNKNOWN)
13486 prot = get_tv_number_chk(&argvars[2], NULL);
13487 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13488 mkdir_recurse(dir, prot);
13490 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13492 #endif
13495 * "mode()" function
13497 static void
13498 f_mode(argvars, rettv)
13499 typval_T *argvars;
13500 typval_T *rettv;
13502 char_u buf[3];
13504 buf[1] = NUL;
13505 buf[2] = NUL;
13507 #ifdef FEAT_VISUAL
13508 if (VIsual_active)
13510 if (VIsual_select)
13511 buf[0] = VIsual_mode + 's' - 'v';
13512 else
13513 buf[0] = VIsual_mode;
13515 else
13516 #endif
13517 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13518 || State == CONFIRM)
13520 buf[0] = 'r';
13521 if (State == ASKMORE)
13522 buf[1] = 'm';
13523 else if (State == CONFIRM)
13524 buf[1] = '?';
13526 else if (State == EXTERNCMD)
13527 buf[0] = '!';
13528 else if (State & INSERT)
13530 #ifdef FEAT_VREPLACE
13531 if (State & VREPLACE_FLAG)
13533 buf[0] = 'R';
13534 buf[1] = 'v';
13536 else
13537 #endif
13538 if (State & REPLACE_FLAG)
13539 buf[0] = 'R';
13540 else
13541 buf[0] = 'i';
13543 else if (State & CMDLINE)
13545 buf[0] = 'c';
13546 if (exmode_active)
13547 buf[1] = 'v';
13549 else if (exmode_active)
13551 buf[0] = 'c';
13552 buf[1] = 'e';
13554 else
13556 buf[0] = 'n';
13557 if (finish_op)
13558 buf[1] = 'o';
13561 /* Clear out the minor mode when the argument is not a non-zero number or
13562 * non-empty string. */
13563 if (!non_zero_arg(&argvars[0]))
13564 buf[1] = NUL;
13566 rettv->vval.v_string = vim_strsave(buf);
13567 rettv->v_type = VAR_STRING;
13571 * "nextnonblank()" function
13573 static void
13574 f_nextnonblank(argvars, rettv)
13575 typval_T *argvars;
13576 typval_T *rettv;
13578 linenr_T lnum;
13580 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13582 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13584 lnum = 0;
13585 break;
13587 if (*skipwhite(ml_get(lnum)) != NUL)
13588 break;
13590 rettv->vval.v_number = lnum;
13594 * "nr2char()" function
13596 static void
13597 f_nr2char(argvars, rettv)
13598 typval_T *argvars;
13599 typval_T *rettv;
13601 char_u buf[NUMBUFLEN];
13603 #ifdef FEAT_MBYTE
13604 if (has_mbyte)
13605 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13606 else
13607 #endif
13609 buf[0] = (char_u)get_tv_number(&argvars[0]);
13610 buf[1] = NUL;
13612 rettv->v_type = VAR_STRING;
13613 rettv->vval.v_string = vim_strsave(buf);
13617 * "pathshorten()" function
13619 static void
13620 f_pathshorten(argvars, rettv)
13621 typval_T *argvars;
13622 typval_T *rettv;
13624 char_u *p;
13626 rettv->v_type = VAR_STRING;
13627 p = get_tv_string_chk(&argvars[0]);
13628 if (p == NULL)
13629 rettv->vval.v_string = NULL;
13630 else
13632 p = vim_strsave(p);
13633 rettv->vval.v_string = p;
13634 if (p != NULL)
13635 shorten_dir(p);
13639 #ifdef FEAT_FLOAT
13641 * "pow()" function
13643 static void
13644 f_pow(argvars, rettv)
13645 typval_T *argvars;
13646 typval_T *rettv;
13648 float_T fx, fy;
13650 rettv->v_type = VAR_FLOAT;
13651 if (get_float_arg(argvars, &fx) == OK
13652 && get_float_arg(&argvars[1], &fy) == OK)
13653 rettv->vval.v_float = pow(fx, fy);
13654 else
13655 rettv->vval.v_float = 0.0;
13657 #endif
13660 * "prevnonblank()" function
13662 static void
13663 f_prevnonblank(argvars, rettv)
13664 typval_T *argvars;
13665 typval_T *rettv;
13667 linenr_T lnum;
13669 lnum = get_tv_lnum(argvars);
13670 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13671 lnum = 0;
13672 else
13673 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13674 --lnum;
13675 rettv->vval.v_number = lnum;
13678 #ifdef HAVE_STDARG_H
13679 /* This dummy va_list is here because:
13680 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13681 * - locally in the function results in a "used before set" warning
13682 * - using va_start() to initialize it gives "function with fixed args" error */
13683 static va_list ap;
13684 #endif
13687 * "printf()" function
13689 static void
13690 f_printf(argvars, rettv)
13691 typval_T *argvars;
13692 typval_T *rettv;
13694 rettv->v_type = VAR_STRING;
13695 rettv->vval.v_string = NULL;
13696 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13698 char_u buf[NUMBUFLEN];
13699 int len;
13700 char_u *s;
13701 int saved_did_emsg = did_emsg;
13702 char *fmt;
13704 /* Get the required length, allocate the buffer and do it for real. */
13705 did_emsg = FALSE;
13706 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13707 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13708 if (!did_emsg)
13710 s = alloc(len + 1);
13711 if (s != NULL)
13713 rettv->vval.v_string = s;
13714 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13717 did_emsg |= saved_did_emsg;
13719 #endif
13723 * "pumvisible()" function
13725 static void
13726 f_pumvisible(argvars, rettv)
13727 typval_T *argvars UNUSED;
13728 typval_T *rettv UNUSED;
13730 #ifdef FEAT_INS_EXPAND
13731 if (pum_visible())
13732 rettv->vval.v_number = 1;
13733 #endif
13737 * "range()" function
13739 static void
13740 f_range(argvars, rettv)
13741 typval_T *argvars;
13742 typval_T *rettv;
13744 long start;
13745 long end;
13746 long stride = 1;
13747 long i;
13748 int error = FALSE;
13750 start = get_tv_number_chk(&argvars[0], &error);
13751 if (argvars[1].v_type == VAR_UNKNOWN)
13753 end = start - 1;
13754 start = 0;
13756 else
13758 end = get_tv_number_chk(&argvars[1], &error);
13759 if (argvars[2].v_type != VAR_UNKNOWN)
13760 stride = get_tv_number_chk(&argvars[2], &error);
13763 if (error)
13764 return; /* type error; errmsg already given */
13765 if (stride == 0)
13766 EMSG(_("E726: Stride is zero"));
13767 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13768 EMSG(_("E727: Start past end"));
13769 else
13771 if (rettv_list_alloc(rettv) == OK)
13772 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13773 if (list_append_number(rettv->vval.v_list,
13774 (varnumber_T)i) == FAIL)
13775 break;
13780 * "readfile()" function
13782 static void
13783 f_readfile(argvars, rettv)
13784 typval_T *argvars;
13785 typval_T *rettv;
13787 int binary = FALSE;
13788 char_u *fname;
13789 FILE *fd;
13790 listitem_T *li;
13791 #define FREAD_SIZE 200 /* optimized for text lines */
13792 char_u buf[FREAD_SIZE];
13793 int readlen; /* size of last fread() */
13794 int buflen; /* nr of valid chars in buf[] */
13795 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13796 int tolist; /* first byte in buf[] still to be put in list */
13797 int chop; /* how many CR to chop off */
13798 char_u *prev = NULL; /* previously read bytes, if any */
13799 int prevlen = 0; /* length of "prev" if not NULL */
13800 char_u *s;
13801 int len;
13802 long maxline = MAXLNUM;
13803 long cnt = 0;
13805 if (argvars[1].v_type != VAR_UNKNOWN)
13807 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13808 binary = TRUE;
13809 if (argvars[2].v_type != VAR_UNKNOWN)
13810 maxline = get_tv_number(&argvars[2]);
13813 if (rettv_list_alloc(rettv) == FAIL)
13814 return;
13816 /* Always open the file in binary mode, library functions have a mind of
13817 * their own about CR-LF conversion. */
13818 fname = get_tv_string(&argvars[0]);
13819 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13821 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13822 return;
13825 filtd = 0;
13826 while (cnt < maxline || maxline < 0)
13828 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13829 buflen = filtd + readlen;
13830 tolist = 0;
13831 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13833 if (buf[filtd] == '\n' || readlen <= 0)
13835 /* Only when in binary mode add an empty list item when the
13836 * last line ends in a '\n'. */
13837 if (!binary && readlen == 0 && filtd == 0)
13838 break;
13840 /* Found end-of-line or end-of-file: add a text line to the
13841 * list. */
13842 chop = 0;
13843 if (!binary)
13844 while (filtd - chop - 1 >= tolist
13845 && buf[filtd - chop - 1] == '\r')
13846 ++chop;
13847 len = filtd - tolist - chop;
13848 if (prev == NULL)
13849 s = vim_strnsave(buf + tolist, len);
13850 else
13852 s = alloc((unsigned)(prevlen + len + 1));
13853 if (s != NULL)
13855 mch_memmove(s, prev, prevlen);
13856 vim_free(prev);
13857 prev = NULL;
13858 mch_memmove(s + prevlen, buf + tolist, len);
13859 s[prevlen + len] = NUL;
13862 tolist = filtd + 1;
13864 li = listitem_alloc();
13865 if (li == NULL)
13867 vim_free(s);
13868 break;
13870 li->li_tv.v_type = VAR_STRING;
13871 li->li_tv.v_lock = 0;
13872 li->li_tv.vval.v_string = s;
13873 list_append(rettv->vval.v_list, li);
13875 if (++cnt >= maxline && maxline >= 0)
13876 break;
13877 if (readlen <= 0)
13878 break;
13880 else if (buf[filtd] == NUL)
13881 buf[filtd] = '\n';
13883 if (readlen <= 0)
13884 break;
13886 if (tolist == 0)
13888 /* "buf" is full, need to move text to an allocated buffer */
13889 if (prev == NULL)
13891 prev = vim_strnsave(buf, buflen);
13892 prevlen = buflen;
13894 else
13896 s = alloc((unsigned)(prevlen + buflen));
13897 if (s != NULL)
13899 mch_memmove(s, prev, prevlen);
13900 mch_memmove(s + prevlen, buf, buflen);
13901 vim_free(prev);
13902 prev = s;
13903 prevlen += buflen;
13906 filtd = 0;
13908 else
13910 mch_memmove(buf, buf + tolist, buflen - tolist);
13911 filtd -= tolist;
13916 * For a negative line count use only the lines at the end of the file,
13917 * free the rest.
13919 if (maxline < 0)
13920 while (cnt > -maxline)
13922 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13923 --cnt;
13926 vim_free(prev);
13927 fclose(fd);
13930 #if defined(FEAT_RELTIME)
13931 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13934 * Convert a List to proftime_T.
13935 * Return FAIL when there is something wrong.
13937 static int
13938 list2proftime(arg, tm)
13939 typval_T *arg;
13940 proftime_T *tm;
13942 long n1, n2;
13943 int error = FALSE;
13945 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13946 || arg->vval.v_list->lv_len != 2)
13947 return FAIL;
13948 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13949 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13950 # ifdef WIN3264
13951 tm->HighPart = n1;
13952 tm->LowPart = n2;
13953 # else
13954 tm->tv_sec = n1;
13955 tm->tv_usec = n2;
13956 # endif
13957 return error ? FAIL : OK;
13959 #endif /* FEAT_RELTIME */
13962 * "reltime()" function
13964 static void
13965 f_reltime(argvars, rettv)
13966 typval_T *argvars;
13967 typval_T *rettv;
13969 #ifdef FEAT_RELTIME
13970 proftime_T res;
13971 proftime_T start;
13973 if (argvars[0].v_type == VAR_UNKNOWN)
13975 /* No arguments: get current time. */
13976 profile_start(&res);
13978 else if (argvars[1].v_type == VAR_UNKNOWN)
13980 if (list2proftime(&argvars[0], &res) == FAIL)
13981 return;
13982 profile_end(&res);
13984 else
13986 /* Two arguments: compute the difference. */
13987 if (list2proftime(&argvars[0], &start) == FAIL
13988 || list2proftime(&argvars[1], &res) == FAIL)
13989 return;
13990 profile_sub(&res, &start);
13993 if (rettv_list_alloc(rettv) == OK)
13995 long n1, n2;
13997 # ifdef WIN3264
13998 n1 = res.HighPart;
13999 n2 = res.LowPart;
14000 # else
14001 n1 = res.tv_sec;
14002 n2 = res.tv_usec;
14003 # endif
14004 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14005 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14007 #endif
14011 * "reltimestr()" function
14013 static void
14014 f_reltimestr(argvars, rettv)
14015 typval_T *argvars;
14016 typval_T *rettv;
14018 #ifdef FEAT_RELTIME
14019 proftime_T tm;
14020 #endif
14022 rettv->v_type = VAR_STRING;
14023 rettv->vval.v_string = NULL;
14024 #ifdef FEAT_RELTIME
14025 if (list2proftime(&argvars[0], &tm) == OK)
14026 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14027 #endif
14030 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14031 static void make_connection __ARGS((void));
14032 static int check_connection __ARGS((void));
14034 static void
14035 make_connection()
14037 if (X_DISPLAY == NULL
14038 # ifdef FEAT_GUI
14039 && !gui.in_use
14040 # endif
14043 x_force_connect = TRUE;
14044 setup_term_clip();
14045 x_force_connect = FALSE;
14049 static int
14050 check_connection()
14052 make_connection();
14053 if (X_DISPLAY == NULL)
14055 EMSG(_("E240: No connection to Vim server"));
14056 return FAIL;
14058 return OK;
14060 #endif
14062 #ifdef FEAT_CLIENTSERVER
14063 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14065 static void
14066 remote_common(argvars, rettv, expr)
14067 typval_T *argvars;
14068 typval_T *rettv;
14069 int expr;
14071 char_u *server_name;
14072 char_u *keys;
14073 char_u *r = NULL;
14074 char_u buf[NUMBUFLEN];
14075 # ifdef WIN32
14076 HWND w;
14077 # else
14078 Window w;
14079 # endif
14081 if (check_restricted() || check_secure())
14082 return;
14084 # ifdef FEAT_X11
14085 if (check_connection() == FAIL)
14086 return;
14087 # endif
14089 server_name = get_tv_string_chk(&argvars[0]);
14090 if (server_name == NULL)
14091 return; /* type error; errmsg already given */
14092 keys = get_tv_string_buf(&argvars[1], buf);
14093 # ifdef WIN32
14094 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14095 # else
14096 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14097 < 0)
14098 # endif
14100 if (r != NULL)
14101 EMSG(r); /* sending worked but evaluation failed */
14102 else
14103 EMSG2(_("E241: Unable to send to %s"), server_name);
14104 return;
14107 rettv->vval.v_string = r;
14109 if (argvars[2].v_type != VAR_UNKNOWN)
14111 dictitem_T v;
14112 char_u str[30];
14113 char_u *idvar;
14115 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14116 v.di_tv.v_type = VAR_STRING;
14117 v.di_tv.vval.v_string = vim_strsave(str);
14118 idvar = get_tv_string_chk(&argvars[2]);
14119 if (idvar != NULL)
14120 set_var(idvar, &v.di_tv, FALSE);
14121 vim_free(v.di_tv.vval.v_string);
14124 #endif
14127 * "remote_expr()" function
14129 static void
14130 f_remote_expr(argvars, rettv)
14131 typval_T *argvars UNUSED;
14132 typval_T *rettv;
14134 rettv->v_type = VAR_STRING;
14135 rettv->vval.v_string = NULL;
14136 #ifdef FEAT_CLIENTSERVER
14137 remote_common(argvars, rettv, TRUE);
14138 #endif
14142 * "remote_foreground()" function
14144 static void
14145 f_remote_foreground(argvars, rettv)
14146 typval_T *argvars UNUSED;
14147 typval_T *rettv UNUSED;
14149 #ifdef FEAT_CLIENTSERVER
14150 # ifdef WIN32
14151 /* On Win32 it's done in this application. */
14153 char_u *server_name = get_tv_string_chk(&argvars[0]);
14155 if (server_name != NULL)
14156 serverForeground(server_name);
14158 # else
14159 /* Send a foreground() expression to the server. */
14160 argvars[1].v_type = VAR_STRING;
14161 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14162 argvars[2].v_type = VAR_UNKNOWN;
14163 remote_common(argvars, rettv, TRUE);
14164 vim_free(argvars[1].vval.v_string);
14165 # endif
14166 #endif
14169 static void
14170 f_remote_peek(argvars, rettv)
14171 typval_T *argvars UNUSED;
14172 typval_T *rettv;
14174 #ifdef FEAT_CLIENTSERVER
14175 dictitem_T v;
14176 char_u *s = NULL;
14177 # ifdef WIN32
14178 long_u n = 0;
14179 # endif
14180 char_u *serverid;
14182 if (check_restricted() || check_secure())
14184 rettv->vval.v_number = -1;
14185 return;
14187 serverid = get_tv_string_chk(&argvars[0]);
14188 if (serverid == NULL)
14190 rettv->vval.v_number = -1;
14191 return; /* type error; errmsg already given */
14193 # ifdef WIN32
14194 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14195 if (n == 0)
14196 rettv->vval.v_number = -1;
14197 else
14199 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14200 rettv->vval.v_number = (s != NULL);
14202 # else
14203 if (check_connection() == FAIL)
14204 return;
14206 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14207 serverStrToWin(serverid), &s);
14208 # endif
14210 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14212 char_u *retvar;
14214 v.di_tv.v_type = VAR_STRING;
14215 v.di_tv.vval.v_string = vim_strsave(s);
14216 retvar = get_tv_string_chk(&argvars[1]);
14217 if (retvar != NULL)
14218 set_var(retvar, &v.di_tv, FALSE);
14219 vim_free(v.di_tv.vval.v_string);
14221 #else
14222 rettv->vval.v_number = -1;
14223 #endif
14226 static void
14227 f_remote_read(argvars, rettv)
14228 typval_T *argvars UNUSED;
14229 typval_T *rettv;
14231 char_u *r = NULL;
14233 #ifdef FEAT_CLIENTSERVER
14234 char_u *serverid = get_tv_string_chk(&argvars[0]);
14236 if (serverid != NULL && !check_restricted() && !check_secure())
14238 # ifdef WIN32
14239 /* The server's HWND is encoded in the 'id' parameter */
14240 long_u n = 0;
14242 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14243 if (n != 0)
14244 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14245 if (r == NULL)
14246 # else
14247 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14248 serverStrToWin(serverid), &r, FALSE) < 0)
14249 # endif
14250 EMSG(_("E277: Unable to read a server reply"));
14252 #endif
14253 rettv->v_type = VAR_STRING;
14254 rettv->vval.v_string = r;
14258 * "remote_send()" function
14260 static void
14261 f_remote_send(argvars, rettv)
14262 typval_T *argvars UNUSED;
14263 typval_T *rettv;
14265 rettv->v_type = VAR_STRING;
14266 rettv->vval.v_string = NULL;
14267 #ifdef FEAT_CLIENTSERVER
14268 remote_common(argvars, rettv, FALSE);
14269 #endif
14273 * "remove()" function
14275 static void
14276 f_remove(argvars, rettv)
14277 typval_T *argvars;
14278 typval_T *rettv;
14280 list_T *l;
14281 listitem_T *item, *item2;
14282 listitem_T *li;
14283 long idx;
14284 long end;
14285 char_u *key;
14286 dict_T *d;
14287 dictitem_T *di;
14289 if (argvars[0].v_type == VAR_DICT)
14291 if (argvars[2].v_type != VAR_UNKNOWN)
14292 EMSG2(_(e_toomanyarg), "remove()");
14293 else if ((d = argvars[0].vval.v_dict) != NULL
14294 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14296 key = get_tv_string_chk(&argvars[1]);
14297 if (key != NULL)
14299 di = dict_find(d, key, -1);
14300 if (di == NULL)
14301 EMSG2(_(e_dictkey), key);
14302 else
14304 *rettv = di->di_tv;
14305 init_tv(&di->di_tv);
14306 dictitem_remove(d, di);
14311 else if (argvars[0].v_type != VAR_LIST)
14312 EMSG2(_(e_listdictarg), "remove()");
14313 else if ((l = argvars[0].vval.v_list) != NULL
14314 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14316 int error = FALSE;
14318 idx = get_tv_number_chk(&argvars[1], &error);
14319 if (error)
14320 ; /* type error: do nothing, errmsg already given */
14321 else if ((item = list_find(l, idx)) == NULL)
14322 EMSGN(_(e_listidx), idx);
14323 else
14325 if (argvars[2].v_type == VAR_UNKNOWN)
14327 /* Remove one item, return its value. */
14328 list_remove(l, item, item);
14329 *rettv = item->li_tv;
14330 vim_free(item);
14332 else
14334 /* Remove range of items, return list with values. */
14335 end = get_tv_number_chk(&argvars[2], &error);
14336 if (error)
14337 ; /* type error: do nothing */
14338 else if ((item2 = list_find(l, end)) == NULL)
14339 EMSGN(_(e_listidx), end);
14340 else
14342 int cnt = 0;
14344 for (li = item; li != NULL; li = li->li_next)
14346 ++cnt;
14347 if (li == item2)
14348 break;
14350 if (li == NULL) /* didn't find "item2" after "item" */
14351 EMSG(_(e_invrange));
14352 else
14354 list_remove(l, item, item2);
14355 if (rettv_list_alloc(rettv) == OK)
14357 l = rettv->vval.v_list;
14358 l->lv_first = item;
14359 l->lv_last = item2;
14360 item->li_prev = NULL;
14361 item2->li_next = NULL;
14362 l->lv_len = cnt;
14372 * "rename({from}, {to})" function
14374 static void
14375 f_rename(argvars, rettv)
14376 typval_T *argvars;
14377 typval_T *rettv;
14379 char_u buf[NUMBUFLEN];
14381 if (check_restricted() || check_secure())
14382 rettv->vval.v_number = -1;
14383 else
14384 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14385 get_tv_string_buf(&argvars[1], buf));
14389 * "repeat()" function
14391 static void
14392 f_repeat(argvars, rettv)
14393 typval_T *argvars;
14394 typval_T *rettv;
14396 char_u *p;
14397 int n;
14398 int slen;
14399 int len;
14400 char_u *r;
14401 int i;
14403 n = get_tv_number(&argvars[1]);
14404 if (argvars[0].v_type == VAR_LIST)
14406 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14407 while (n-- > 0)
14408 if (list_extend(rettv->vval.v_list,
14409 argvars[0].vval.v_list, NULL) == FAIL)
14410 break;
14412 else
14414 p = get_tv_string(&argvars[0]);
14415 rettv->v_type = VAR_STRING;
14416 rettv->vval.v_string = NULL;
14418 slen = (int)STRLEN(p);
14419 len = slen * n;
14420 if (len <= 0)
14421 return;
14423 r = alloc(len + 1);
14424 if (r != NULL)
14426 for (i = 0; i < n; i++)
14427 mch_memmove(r + i * slen, p, (size_t)slen);
14428 r[len] = NUL;
14431 rettv->vval.v_string = r;
14436 * "resolve()" function
14438 static void
14439 f_resolve(argvars, rettv)
14440 typval_T *argvars;
14441 typval_T *rettv;
14443 char_u *p;
14445 p = get_tv_string(&argvars[0]);
14446 #ifdef FEAT_SHORTCUT
14448 char_u *v = NULL;
14450 v = mch_resolve_shortcut(p);
14451 if (v != NULL)
14452 rettv->vval.v_string = v;
14453 else
14454 rettv->vval.v_string = vim_strsave(p);
14456 #else
14457 # ifdef HAVE_READLINK
14459 char_u buf[MAXPATHL + 1];
14460 char_u *cpy;
14461 int len;
14462 char_u *remain = NULL;
14463 char_u *q;
14464 int is_relative_to_current = FALSE;
14465 int has_trailing_pathsep = FALSE;
14466 int limit = 100;
14468 p = vim_strsave(p);
14470 if (p[0] == '.' && (vim_ispathsep(p[1])
14471 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14472 is_relative_to_current = TRUE;
14474 len = STRLEN(p);
14475 if (len > 0 && after_pathsep(p, p + len))
14476 has_trailing_pathsep = TRUE;
14478 q = getnextcomp(p);
14479 if (*q != NUL)
14481 /* Separate the first path component in "p", and keep the
14482 * remainder (beginning with the path separator). */
14483 remain = vim_strsave(q - 1);
14484 q[-1] = NUL;
14487 for (;;)
14489 for (;;)
14491 len = readlink((char *)p, (char *)buf, MAXPATHL);
14492 if (len <= 0)
14493 break;
14494 buf[len] = NUL;
14496 if (limit-- == 0)
14498 vim_free(p);
14499 vim_free(remain);
14500 EMSG(_("E655: Too many symbolic links (cycle?)"));
14501 rettv->vval.v_string = NULL;
14502 goto fail;
14505 /* Ensure that the result will have a trailing path separator
14506 * if the argument has one. */
14507 if (remain == NULL && has_trailing_pathsep)
14508 add_pathsep(buf);
14510 /* Separate the first path component in the link value and
14511 * concatenate the remainders. */
14512 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14513 if (*q != NUL)
14515 if (remain == NULL)
14516 remain = vim_strsave(q - 1);
14517 else
14519 cpy = concat_str(q - 1, remain);
14520 if (cpy != NULL)
14522 vim_free(remain);
14523 remain = cpy;
14526 q[-1] = NUL;
14529 q = gettail(p);
14530 if (q > p && *q == NUL)
14532 /* Ignore trailing path separator. */
14533 q[-1] = NUL;
14534 q = gettail(p);
14536 if (q > p && !mch_isFullName(buf))
14538 /* symlink is relative to directory of argument */
14539 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14540 if (cpy != NULL)
14542 STRCPY(cpy, p);
14543 STRCPY(gettail(cpy), buf);
14544 vim_free(p);
14545 p = cpy;
14548 else
14550 vim_free(p);
14551 p = vim_strsave(buf);
14555 if (remain == NULL)
14556 break;
14558 /* Append the first path component of "remain" to "p". */
14559 q = getnextcomp(remain + 1);
14560 len = q - remain - (*q != NUL);
14561 cpy = vim_strnsave(p, STRLEN(p) + len);
14562 if (cpy != NULL)
14564 STRNCAT(cpy, remain, len);
14565 vim_free(p);
14566 p = cpy;
14568 /* Shorten "remain". */
14569 if (*q != NUL)
14570 STRMOVE(remain, q - 1);
14571 else
14573 vim_free(remain);
14574 remain = NULL;
14578 /* If the result is a relative path name, make it explicitly relative to
14579 * the current directory if and only if the argument had this form. */
14580 if (!vim_ispathsep(*p))
14582 if (is_relative_to_current
14583 && *p != NUL
14584 && !(p[0] == '.'
14585 && (p[1] == NUL
14586 || vim_ispathsep(p[1])
14587 || (p[1] == '.'
14588 && (p[2] == NUL
14589 || vim_ispathsep(p[2]))))))
14591 /* Prepend "./". */
14592 cpy = concat_str((char_u *)"./", p);
14593 if (cpy != NULL)
14595 vim_free(p);
14596 p = cpy;
14599 else if (!is_relative_to_current)
14601 /* Strip leading "./". */
14602 q = p;
14603 while (q[0] == '.' && vim_ispathsep(q[1]))
14604 q += 2;
14605 if (q > p)
14606 STRMOVE(p, p + 2);
14610 /* Ensure that the result will have no trailing path separator
14611 * if the argument had none. But keep "/" or "//". */
14612 if (!has_trailing_pathsep)
14614 q = p + STRLEN(p);
14615 if (after_pathsep(p, q))
14616 *gettail_sep(p) = NUL;
14619 rettv->vval.v_string = p;
14621 # else
14622 rettv->vval.v_string = vim_strsave(p);
14623 # endif
14624 #endif
14626 simplify_filename(rettv->vval.v_string);
14628 #ifdef HAVE_READLINK
14629 fail:
14630 #endif
14631 rettv->v_type = VAR_STRING;
14635 * "reverse({list})" function
14637 static void
14638 f_reverse(argvars, rettv)
14639 typval_T *argvars;
14640 typval_T *rettv;
14642 list_T *l;
14643 listitem_T *li, *ni;
14645 if (argvars[0].v_type != VAR_LIST)
14646 EMSG2(_(e_listarg), "reverse()");
14647 else if ((l = argvars[0].vval.v_list) != NULL
14648 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14650 li = l->lv_last;
14651 l->lv_first = l->lv_last = NULL;
14652 l->lv_len = 0;
14653 while (li != NULL)
14655 ni = li->li_prev;
14656 list_append(l, li);
14657 li = ni;
14659 rettv->vval.v_list = l;
14660 rettv->v_type = VAR_LIST;
14661 ++l->lv_refcount;
14662 l->lv_idx = l->lv_len - l->lv_idx - 1;
14666 #define SP_NOMOVE 0x01 /* don't move cursor */
14667 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14668 #define SP_RETCOUNT 0x04 /* return matchcount */
14669 #define SP_SETPCMARK 0x08 /* set previous context mark */
14670 #define SP_START 0x10 /* accept match at start position */
14671 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14672 #define SP_END 0x40 /* leave cursor at end of match */
14674 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14677 * Get flags for a search function.
14678 * Possibly sets "p_ws".
14679 * Returns BACKWARD, FORWARD or zero (for an error).
14681 static int
14682 get_search_arg(varp, flagsp)
14683 typval_T *varp;
14684 int *flagsp;
14686 int dir = FORWARD;
14687 char_u *flags;
14688 char_u nbuf[NUMBUFLEN];
14689 int mask;
14691 if (varp->v_type != VAR_UNKNOWN)
14693 flags = get_tv_string_buf_chk(varp, nbuf);
14694 if (flags == NULL)
14695 return 0; /* type error; errmsg already given */
14696 while (*flags != NUL)
14698 switch (*flags)
14700 case 'b': dir = BACKWARD; break;
14701 case 'w': p_ws = TRUE; break;
14702 case 'W': p_ws = FALSE; break;
14703 default: mask = 0;
14704 if (flagsp != NULL)
14705 switch (*flags)
14707 case 'c': mask = SP_START; break;
14708 case 'e': mask = SP_END; break;
14709 case 'm': mask = SP_RETCOUNT; break;
14710 case 'n': mask = SP_NOMOVE; break;
14711 case 'p': mask = SP_SUBPAT; break;
14712 case 'r': mask = SP_REPEAT; break;
14713 case 's': mask = SP_SETPCMARK; break;
14715 if (mask == 0)
14717 EMSG2(_(e_invarg2), flags);
14718 dir = 0;
14720 else
14721 *flagsp |= mask;
14723 if (dir == 0)
14724 break;
14725 ++flags;
14728 return dir;
14732 * Shared by search() and searchpos() functions
14734 static int
14735 search_cmn(argvars, match_pos, flagsp)
14736 typval_T *argvars;
14737 pos_T *match_pos;
14738 int *flagsp;
14740 int flags;
14741 char_u *pat;
14742 pos_T pos;
14743 pos_T save_cursor;
14744 int save_p_ws = p_ws;
14745 int dir;
14746 int retval = 0; /* default: FAIL */
14747 long lnum_stop = 0;
14748 proftime_T tm;
14749 #ifdef FEAT_RELTIME
14750 long time_limit = 0;
14751 #endif
14752 int options = SEARCH_KEEP;
14753 int subpatnum;
14755 pat = get_tv_string(&argvars[0]);
14756 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14757 if (dir == 0)
14758 goto theend;
14759 flags = *flagsp;
14760 if (flags & SP_START)
14761 options |= SEARCH_START;
14762 if (flags & SP_END)
14763 options |= SEARCH_END;
14765 /* Optional arguments: line number to stop searching and timeout. */
14766 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14768 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14769 if (lnum_stop < 0)
14770 goto theend;
14771 #ifdef FEAT_RELTIME
14772 if (argvars[3].v_type != VAR_UNKNOWN)
14774 time_limit = get_tv_number_chk(&argvars[3], NULL);
14775 if (time_limit < 0)
14776 goto theend;
14778 #endif
14781 #ifdef FEAT_RELTIME
14782 /* Set the time limit, if there is one. */
14783 profile_setlimit(time_limit, &tm);
14784 #endif
14787 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14788 * Check to make sure only those flags are set.
14789 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14790 * flags cannot be set. Check for that condition also.
14792 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14793 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14795 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14796 goto theend;
14799 pos = save_cursor = curwin->w_cursor;
14800 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14801 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14802 if (subpatnum != FAIL)
14804 if (flags & SP_SUBPAT)
14805 retval = subpatnum;
14806 else
14807 retval = pos.lnum;
14808 if (flags & SP_SETPCMARK)
14809 setpcmark();
14810 curwin->w_cursor = pos;
14811 if (match_pos != NULL)
14813 /* Store the match cursor position */
14814 match_pos->lnum = pos.lnum;
14815 match_pos->col = pos.col + 1;
14817 /* "/$" will put the cursor after the end of the line, may need to
14818 * correct that here */
14819 check_cursor();
14822 /* If 'n' flag is used: restore cursor position. */
14823 if (flags & SP_NOMOVE)
14824 curwin->w_cursor = save_cursor;
14825 else
14826 curwin->w_set_curswant = TRUE;
14827 theend:
14828 p_ws = save_p_ws;
14830 return retval;
14833 #ifdef FEAT_FLOAT
14835 * "round({float})" function
14837 static void
14838 f_round(argvars, rettv)
14839 typval_T *argvars;
14840 typval_T *rettv;
14842 float_T f;
14844 rettv->v_type = VAR_FLOAT;
14845 if (get_float_arg(argvars, &f) == OK)
14846 /* round() is not in C90, use ceil() or floor() instead. */
14847 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14848 else
14849 rettv->vval.v_float = 0.0;
14851 #endif
14854 * "search()" function
14856 static void
14857 f_search(argvars, rettv)
14858 typval_T *argvars;
14859 typval_T *rettv;
14861 int flags = 0;
14863 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14867 * "searchdecl()" function
14869 static void
14870 f_searchdecl(argvars, rettv)
14871 typval_T *argvars;
14872 typval_T *rettv;
14874 int locally = 1;
14875 int thisblock = 0;
14876 int error = FALSE;
14877 char_u *name;
14879 rettv->vval.v_number = 1; /* default: FAIL */
14881 name = get_tv_string_chk(&argvars[0]);
14882 if (argvars[1].v_type != VAR_UNKNOWN)
14884 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14885 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14886 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14888 if (!error && name != NULL)
14889 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14890 locally, thisblock, SEARCH_KEEP) == FAIL;
14894 * Used by searchpair() and searchpairpos()
14896 static int
14897 searchpair_cmn(argvars, match_pos)
14898 typval_T *argvars;
14899 pos_T *match_pos;
14901 char_u *spat, *mpat, *epat;
14902 char_u *skip;
14903 int save_p_ws = p_ws;
14904 int dir;
14905 int flags = 0;
14906 char_u nbuf1[NUMBUFLEN];
14907 char_u nbuf2[NUMBUFLEN];
14908 char_u nbuf3[NUMBUFLEN];
14909 int retval = 0; /* default: FAIL */
14910 long lnum_stop = 0;
14911 long time_limit = 0;
14913 /* Get the three pattern arguments: start, middle, end. */
14914 spat = get_tv_string_chk(&argvars[0]);
14915 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14916 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14917 if (spat == NULL || mpat == NULL || epat == NULL)
14918 goto theend; /* type error */
14920 /* Handle the optional fourth argument: flags */
14921 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14922 if (dir == 0)
14923 goto theend;
14925 /* Don't accept SP_END or SP_SUBPAT.
14926 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14928 if ((flags & (SP_END | SP_SUBPAT)) != 0
14929 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14931 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14932 goto theend;
14935 /* Using 'r' implies 'W', otherwise it doesn't work. */
14936 if (flags & SP_REPEAT)
14937 p_ws = FALSE;
14939 /* Optional fifth argument: skip expression */
14940 if (argvars[3].v_type == VAR_UNKNOWN
14941 || argvars[4].v_type == VAR_UNKNOWN)
14942 skip = (char_u *)"";
14943 else
14945 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14946 if (argvars[5].v_type != VAR_UNKNOWN)
14948 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
14949 if (lnum_stop < 0)
14950 goto theend;
14951 #ifdef FEAT_RELTIME
14952 if (argvars[6].v_type != VAR_UNKNOWN)
14954 time_limit = get_tv_number_chk(&argvars[6], NULL);
14955 if (time_limit < 0)
14956 goto theend;
14958 #endif
14961 if (skip == NULL)
14962 goto theend; /* type error */
14964 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
14965 match_pos, lnum_stop, time_limit);
14967 theend:
14968 p_ws = save_p_ws;
14970 return retval;
14974 * "searchpair()" function
14976 static void
14977 f_searchpair(argvars, rettv)
14978 typval_T *argvars;
14979 typval_T *rettv;
14981 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
14985 * "searchpairpos()" function
14987 static void
14988 f_searchpairpos(argvars, rettv)
14989 typval_T *argvars;
14990 typval_T *rettv;
14992 pos_T match_pos;
14993 int lnum = 0;
14994 int col = 0;
14996 if (rettv_list_alloc(rettv) == FAIL)
14997 return;
14999 if (searchpair_cmn(argvars, &match_pos) > 0)
15001 lnum = match_pos.lnum;
15002 col = match_pos.col;
15005 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15006 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15010 * Search for a start/middle/end thing.
15011 * Used by searchpair(), see its documentation for the details.
15012 * Returns 0 or -1 for no match,
15014 long
15015 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15016 lnum_stop, time_limit)
15017 char_u *spat; /* start pattern */
15018 char_u *mpat; /* middle pattern */
15019 char_u *epat; /* end pattern */
15020 int dir; /* BACKWARD or FORWARD */
15021 char_u *skip; /* skip expression */
15022 int flags; /* SP_SETPCMARK and other SP_ values */
15023 pos_T *match_pos;
15024 linenr_T lnum_stop; /* stop at this line if not zero */
15025 long time_limit; /* stop after this many msec */
15027 char_u *save_cpo;
15028 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15029 long retval = 0;
15030 pos_T pos;
15031 pos_T firstpos;
15032 pos_T foundpos;
15033 pos_T save_cursor;
15034 pos_T save_pos;
15035 int n;
15036 int r;
15037 int nest = 1;
15038 int err;
15039 int options = SEARCH_KEEP;
15040 proftime_T tm;
15042 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15043 save_cpo = p_cpo;
15044 p_cpo = empty_option;
15046 #ifdef FEAT_RELTIME
15047 /* Set the time limit, if there is one. */
15048 profile_setlimit(time_limit, &tm);
15049 #endif
15051 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15052 * start/middle/end (pat3, for the top pair). */
15053 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15054 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15055 if (pat2 == NULL || pat3 == NULL)
15056 goto theend;
15057 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15058 if (*mpat == NUL)
15059 STRCPY(pat3, pat2);
15060 else
15061 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15062 spat, epat, mpat);
15063 if (flags & SP_START)
15064 options |= SEARCH_START;
15066 save_cursor = curwin->w_cursor;
15067 pos = curwin->w_cursor;
15068 clearpos(&firstpos);
15069 clearpos(&foundpos);
15070 pat = pat3;
15071 for (;;)
15073 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15074 options, RE_SEARCH, lnum_stop, &tm);
15075 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15076 /* didn't find it or found the first match again: FAIL */
15077 break;
15079 if (firstpos.lnum == 0)
15080 firstpos = pos;
15081 if (equalpos(pos, foundpos))
15083 /* Found the same position again. Can happen with a pattern that
15084 * has "\zs" at the end and searching backwards. Advance one
15085 * character and try again. */
15086 if (dir == BACKWARD)
15087 decl(&pos);
15088 else
15089 incl(&pos);
15091 foundpos = pos;
15093 /* clear the start flag to avoid getting stuck here */
15094 options &= ~SEARCH_START;
15096 /* If the skip pattern matches, ignore this match. */
15097 if (*skip != NUL)
15099 save_pos = curwin->w_cursor;
15100 curwin->w_cursor = pos;
15101 r = eval_to_bool(skip, &err, NULL, FALSE);
15102 curwin->w_cursor = save_pos;
15103 if (err)
15105 /* Evaluating {skip} caused an error, break here. */
15106 curwin->w_cursor = save_cursor;
15107 retval = -1;
15108 break;
15110 if (r)
15111 continue;
15114 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15116 /* Found end when searching backwards or start when searching
15117 * forward: nested pair. */
15118 ++nest;
15119 pat = pat2; /* nested, don't search for middle */
15121 else
15123 /* Found end when searching forward or start when searching
15124 * backward: end of (nested) pair; or found middle in outer pair. */
15125 if (--nest == 1)
15126 pat = pat3; /* outer level, search for middle */
15129 if (nest == 0)
15131 /* Found the match: return matchcount or line number. */
15132 if (flags & SP_RETCOUNT)
15133 ++retval;
15134 else
15135 retval = pos.lnum;
15136 if (flags & SP_SETPCMARK)
15137 setpcmark();
15138 curwin->w_cursor = pos;
15139 if (!(flags & SP_REPEAT))
15140 break;
15141 nest = 1; /* search for next unmatched */
15145 if (match_pos != NULL)
15147 /* Store the match cursor position */
15148 match_pos->lnum = curwin->w_cursor.lnum;
15149 match_pos->col = curwin->w_cursor.col + 1;
15152 /* If 'n' flag is used or search failed: restore cursor position. */
15153 if ((flags & SP_NOMOVE) || retval == 0)
15154 curwin->w_cursor = save_cursor;
15156 theend:
15157 vim_free(pat2);
15158 vim_free(pat3);
15159 if (p_cpo == empty_option)
15160 p_cpo = save_cpo;
15161 else
15162 /* Darn, evaluating the {skip} expression changed the value. */
15163 free_string_option(save_cpo);
15165 return retval;
15169 * "searchpos()" function
15171 static void
15172 f_searchpos(argvars, rettv)
15173 typval_T *argvars;
15174 typval_T *rettv;
15176 pos_T match_pos;
15177 int lnum = 0;
15178 int col = 0;
15179 int n;
15180 int flags = 0;
15182 if (rettv_list_alloc(rettv) == FAIL)
15183 return;
15185 n = search_cmn(argvars, &match_pos, &flags);
15186 if (n > 0)
15188 lnum = match_pos.lnum;
15189 col = match_pos.col;
15192 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15193 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15194 if (flags & SP_SUBPAT)
15195 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15199 static void
15200 f_server2client(argvars, rettv)
15201 typval_T *argvars UNUSED;
15202 typval_T *rettv;
15204 #ifdef FEAT_CLIENTSERVER
15205 char_u buf[NUMBUFLEN];
15206 char_u *server = get_tv_string_chk(&argvars[0]);
15207 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15209 rettv->vval.v_number = -1;
15210 if (server == NULL || reply == NULL)
15211 return;
15212 if (check_restricted() || check_secure())
15213 return;
15214 # ifdef FEAT_X11
15215 if (check_connection() == FAIL)
15216 return;
15217 # endif
15219 if (serverSendReply(server, reply) < 0)
15221 EMSG(_("E258: Unable to send to client"));
15222 return;
15224 rettv->vval.v_number = 0;
15225 #else
15226 rettv->vval.v_number = -1;
15227 #endif
15230 static void
15231 f_serverlist(argvars, rettv)
15232 typval_T *argvars UNUSED;
15233 typval_T *rettv;
15235 char_u *r = NULL;
15237 #ifdef FEAT_CLIENTSERVER
15238 # ifdef WIN32
15239 r = serverGetVimNames();
15240 # else
15241 make_connection();
15242 if (X_DISPLAY != NULL)
15243 r = serverGetVimNames(X_DISPLAY);
15244 # endif
15245 #endif
15246 rettv->v_type = VAR_STRING;
15247 rettv->vval.v_string = r;
15251 * "setbufvar()" function
15253 static void
15254 f_setbufvar(argvars, rettv)
15255 typval_T *argvars;
15256 typval_T *rettv UNUSED;
15258 buf_T *buf;
15259 aco_save_T aco;
15260 char_u *varname, *bufvarname;
15261 typval_T *varp;
15262 char_u nbuf[NUMBUFLEN];
15264 if (check_restricted() || check_secure())
15265 return;
15266 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15267 varname = get_tv_string_chk(&argvars[1]);
15268 buf = get_buf_tv(&argvars[0]);
15269 varp = &argvars[2];
15271 if (buf != NULL && varname != NULL && varp != NULL)
15273 /* set curbuf to be our buf, temporarily */
15274 aucmd_prepbuf(&aco, buf);
15276 if (*varname == '&')
15278 long numval;
15279 char_u *strval;
15280 int error = FALSE;
15282 ++varname;
15283 numval = get_tv_number_chk(varp, &error);
15284 strval = get_tv_string_buf_chk(varp, nbuf);
15285 if (!error && strval != NULL)
15286 set_option_value(varname, numval, strval, OPT_LOCAL);
15288 else
15290 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15291 if (bufvarname != NULL)
15293 STRCPY(bufvarname, "b:");
15294 STRCPY(bufvarname + 2, varname);
15295 set_var(bufvarname, varp, TRUE);
15296 vim_free(bufvarname);
15300 /* reset notion of buffer */
15301 aucmd_restbuf(&aco);
15306 * "setcmdpos()" function
15308 static void
15309 f_setcmdpos(argvars, rettv)
15310 typval_T *argvars;
15311 typval_T *rettv;
15313 int pos = (int)get_tv_number(&argvars[0]) - 1;
15315 if (pos >= 0)
15316 rettv->vval.v_number = set_cmdline_pos(pos);
15320 * "setline()" function
15322 static void
15323 f_setline(argvars, rettv)
15324 typval_T *argvars;
15325 typval_T *rettv;
15327 linenr_T lnum;
15328 char_u *line = NULL;
15329 list_T *l = NULL;
15330 listitem_T *li = NULL;
15331 long added = 0;
15332 linenr_T lcount = curbuf->b_ml.ml_line_count;
15334 lnum = get_tv_lnum(&argvars[0]);
15335 if (argvars[1].v_type == VAR_LIST)
15337 l = argvars[1].vval.v_list;
15338 li = l->lv_first;
15340 else
15341 line = get_tv_string_chk(&argvars[1]);
15343 /* default result is zero == OK */
15344 for (;;)
15346 if (l != NULL)
15348 /* list argument, get next string */
15349 if (li == NULL)
15350 break;
15351 line = get_tv_string_chk(&li->li_tv);
15352 li = li->li_next;
15355 rettv->vval.v_number = 1; /* FAIL */
15356 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15357 break;
15358 if (lnum <= curbuf->b_ml.ml_line_count)
15360 /* existing line, replace it */
15361 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15363 changed_bytes(lnum, 0);
15364 if (lnum == curwin->w_cursor.lnum)
15365 check_cursor_col();
15366 rettv->vval.v_number = 0; /* OK */
15369 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15371 /* lnum is one past the last line, append the line */
15372 ++added;
15373 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15374 rettv->vval.v_number = 0; /* OK */
15377 if (l == NULL) /* only one string argument */
15378 break;
15379 ++lnum;
15382 if (added > 0)
15383 appended_lines_mark(lcount, added);
15386 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15389 * Used by "setqflist()" and "setloclist()" functions
15391 static void
15392 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15393 win_T *wp UNUSED;
15394 typval_T *list_arg UNUSED;
15395 typval_T *action_arg UNUSED;
15396 typval_T *rettv;
15398 #ifdef FEAT_QUICKFIX
15399 char_u *act;
15400 int action = ' ';
15401 #endif
15403 rettv->vval.v_number = -1;
15405 #ifdef FEAT_QUICKFIX
15406 if (list_arg->v_type != VAR_LIST)
15407 EMSG(_(e_listreq));
15408 else
15410 list_T *l = list_arg->vval.v_list;
15412 if (action_arg->v_type == VAR_STRING)
15414 act = get_tv_string_chk(action_arg);
15415 if (act == NULL)
15416 return; /* type error; errmsg already given */
15417 if (*act == 'a' || *act == 'r')
15418 action = *act;
15421 if (l != NULL && set_errorlist(wp, l, action) == OK)
15422 rettv->vval.v_number = 0;
15424 #endif
15428 * "setloclist()" function
15430 static void
15431 f_setloclist(argvars, rettv)
15432 typval_T *argvars;
15433 typval_T *rettv;
15435 win_T *win;
15437 rettv->vval.v_number = -1;
15439 win = find_win_by_nr(&argvars[0], NULL);
15440 if (win != NULL)
15441 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15445 * "setmatches()" function
15447 static void
15448 f_setmatches(argvars, rettv)
15449 typval_T *argvars;
15450 typval_T *rettv;
15452 #ifdef FEAT_SEARCH_EXTRA
15453 list_T *l;
15454 listitem_T *li;
15455 dict_T *d;
15457 rettv->vval.v_number = -1;
15458 if (argvars[0].v_type != VAR_LIST)
15460 EMSG(_(e_listreq));
15461 return;
15463 if ((l = argvars[0].vval.v_list) != NULL)
15466 /* To some extent make sure that we are dealing with a list from
15467 * "getmatches()". */
15468 li = l->lv_first;
15469 while (li != NULL)
15471 if (li->li_tv.v_type != VAR_DICT
15472 || (d = li->li_tv.vval.v_dict) == NULL)
15474 EMSG(_(e_invarg));
15475 return;
15477 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15478 && dict_find(d, (char_u *)"pattern", -1) != NULL
15479 && dict_find(d, (char_u *)"priority", -1) != NULL
15480 && dict_find(d, (char_u *)"id", -1) != NULL))
15482 EMSG(_(e_invarg));
15483 return;
15485 li = li->li_next;
15488 clear_matches(curwin);
15489 li = l->lv_first;
15490 while (li != NULL)
15492 d = li->li_tv.vval.v_dict;
15493 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15494 get_dict_string(d, (char_u *)"pattern", FALSE),
15495 (int)get_dict_number(d, (char_u *)"priority"),
15496 (int)get_dict_number(d, (char_u *)"id"));
15497 li = li->li_next;
15499 rettv->vval.v_number = 0;
15501 #endif
15505 * "setpos()" function
15507 static void
15508 f_setpos(argvars, rettv)
15509 typval_T *argvars;
15510 typval_T *rettv;
15512 pos_T pos;
15513 int fnum;
15514 char_u *name;
15516 rettv->vval.v_number = -1;
15517 name = get_tv_string_chk(argvars);
15518 if (name != NULL)
15520 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15522 --pos.col;
15523 if (name[0] == '.' && name[1] == NUL)
15525 /* set cursor */
15526 if (fnum == curbuf->b_fnum)
15528 curwin->w_cursor = pos;
15529 check_cursor();
15530 rettv->vval.v_number = 0;
15532 else
15533 EMSG(_(e_invarg));
15535 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15537 /* set mark */
15538 if (setmark_pos(name[1], &pos, fnum) == OK)
15539 rettv->vval.v_number = 0;
15541 else
15542 EMSG(_(e_invarg));
15548 * "setqflist()" function
15550 static void
15551 f_setqflist(argvars, rettv)
15552 typval_T *argvars;
15553 typval_T *rettv;
15555 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15559 * "setreg()" function
15561 static void
15562 f_setreg(argvars, rettv)
15563 typval_T *argvars;
15564 typval_T *rettv;
15566 int regname;
15567 char_u *strregname;
15568 char_u *stropt;
15569 char_u *strval;
15570 int append;
15571 char_u yank_type;
15572 long block_len;
15574 block_len = -1;
15575 yank_type = MAUTO;
15576 append = FALSE;
15578 strregname = get_tv_string_chk(argvars);
15579 rettv->vval.v_number = 1; /* FAIL is default */
15581 if (strregname == NULL)
15582 return; /* type error; errmsg already given */
15583 regname = *strregname;
15584 if (regname == 0 || regname == '@')
15585 regname = '"';
15586 else if (regname == '=')
15587 return;
15589 if (argvars[2].v_type != VAR_UNKNOWN)
15591 stropt = get_tv_string_chk(&argvars[2]);
15592 if (stropt == NULL)
15593 return; /* type error */
15594 for (; *stropt != NUL; ++stropt)
15595 switch (*stropt)
15597 case 'a': case 'A': /* append */
15598 append = TRUE;
15599 break;
15600 case 'v': case 'c': /* character-wise selection */
15601 yank_type = MCHAR;
15602 break;
15603 case 'V': case 'l': /* line-wise selection */
15604 yank_type = MLINE;
15605 break;
15606 #ifdef FEAT_VISUAL
15607 case 'b': case Ctrl_V: /* block-wise selection */
15608 yank_type = MBLOCK;
15609 if (VIM_ISDIGIT(stropt[1]))
15611 ++stropt;
15612 block_len = getdigits(&stropt) - 1;
15613 --stropt;
15615 break;
15616 #endif
15620 strval = get_tv_string_chk(&argvars[1]);
15621 if (strval != NULL)
15622 write_reg_contents_ex(regname, strval, -1,
15623 append, yank_type, block_len);
15624 rettv->vval.v_number = 0;
15628 * "settabwinvar()" function
15630 static void
15631 f_settabwinvar(argvars, rettv)
15632 typval_T *argvars;
15633 typval_T *rettv;
15635 setwinvar(argvars, rettv, 1);
15639 * "setwinvar()" function
15641 static void
15642 f_setwinvar(argvars, rettv)
15643 typval_T *argvars;
15644 typval_T *rettv;
15646 setwinvar(argvars, rettv, 0);
15650 * "setwinvar()" and "settabwinvar()" functions
15652 static void
15653 setwinvar(argvars, rettv, off)
15654 typval_T *argvars;
15655 typval_T *rettv UNUSED;
15656 int off;
15658 win_T *win;
15659 #ifdef FEAT_WINDOWS
15660 win_T *save_curwin;
15661 tabpage_T *save_curtab;
15662 #endif
15663 char_u *varname, *winvarname;
15664 typval_T *varp;
15665 char_u nbuf[NUMBUFLEN];
15666 tabpage_T *tp;
15668 if (check_restricted() || check_secure())
15669 return;
15671 #ifdef FEAT_WINDOWS
15672 if (off == 1)
15673 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15674 else
15675 tp = curtab;
15676 #endif
15677 win = find_win_by_nr(&argvars[off], tp);
15678 varname = get_tv_string_chk(&argvars[off + 1]);
15679 varp = &argvars[off + 2];
15681 if (win != NULL && varname != NULL && varp != NULL)
15683 #ifdef FEAT_WINDOWS
15684 /* set curwin to be our win, temporarily */
15685 save_curwin = curwin;
15686 save_curtab = curtab;
15687 goto_tabpage_tp(tp);
15688 if (!win_valid(win))
15689 return;
15690 curwin = win;
15691 curbuf = curwin->w_buffer;
15692 #endif
15694 if (*varname == '&')
15696 long numval;
15697 char_u *strval;
15698 int error = FALSE;
15700 ++varname;
15701 numval = get_tv_number_chk(varp, &error);
15702 strval = get_tv_string_buf_chk(varp, nbuf);
15703 if (!error && strval != NULL)
15704 set_option_value(varname, numval, strval, OPT_LOCAL);
15706 else
15708 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15709 if (winvarname != NULL)
15711 STRCPY(winvarname, "w:");
15712 STRCPY(winvarname + 2, varname);
15713 set_var(winvarname, varp, TRUE);
15714 vim_free(winvarname);
15718 #ifdef FEAT_WINDOWS
15719 /* Restore current tabpage and window, if still valid (autocomands can
15720 * make them invalid). */
15721 if (valid_tabpage(save_curtab))
15722 goto_tabpage_tp(save_curtab);
15723 if (win_valid(save_curwin))
15725 curwin = save_curwin;
15726 curbuf = curwin->w_buffer;
15728 #endif
15733 * "shellescape({string})" function
15735 static void
15736 f_shellescape(argvars, rettv)
15737 typval_T *argvars;
15738 typval_T *rettv;
15740 rettv->vval.v_string = vim_strsave_shellescape(
15741 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15742 rettv->v_type = VAR_STRING;
15746 * "simplify()" function
15748 static void
15749 f_simplify(argvars, rettv)
15750 typval_T *argvars;
15751 typval_T *rettv;
15753 char_u *p;
15755 p = get_tv_string(&argvars[0]);
15756 rettv->vval.v_string = vim_strsave(p);
15757 simplify_filename(rettv->vval.v_string); /* simplify in place */
15758 rettv->v_type = VAR_STRING;
15761 #ifdef FEAT_FLOAT
15763 * "sin()" function
15765 static void
15766 f_sin(argvars, rettv)
15767 typval_T *argvars;
15768 typval_T *rettv;
15770 float_T f;
15772 rettv->v_type = VAR_FLOAT;
15773 if (get_float_arg(argvars, &f) == OK)
15774 rettv->vval.v_float = sin(f);
15775 else
15776 rettv->vval.v_float = 0.0;
15778 #endif
15780 static int
15781 #ifdef __BORLANDC__
15782 _RTLENTRYF
15783 #endif
15784 item_compare __ARGS((const void *s1, const void *s2));
15785 static int
15786 #ifdef __BORLANDC__
15787 _RTLENTRYF
15788 #endif
15789 item_compare2 __ARGS((const void *s1, const void *s2));
15791 static int item_compare_ic;
15792 static char_u *item_compare_func;
15793 static int item_compare_func_err;
15794 #define ITEM_COMPARE_FAIL 999
15797 * Compare functions for f_sort() below.
15799 static int
15800 #ifdef __BORLANDC__
15801 _RTLENTRYF
15802 #endif
15803 item_compare(s1, s2)
15804 const void *s1;
15805 const void *s2;
15807 char_u *p1, *p2;
15808 char_u *tofree1, *tofree2;
15809 int res;
15810 char_u numbuf1[NUMBUFLEN];
15811 char_u numbuf2[NUMBUFLEN];
15813 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15814 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15815 if (p1 == NULL)
15816 p1 = (char_u *)"";
15817 if (p2 == NULL)
15818 p2 = (char_u *)"";
15819 if (item_compare_ic)
15820 res = STRICMP(p1, p2);
15821 else
15822 res = STRCMP(p1, p2);
15823 vim_free(tofree1);
15824 vim_free(tofree2);
15825 return res;
15828 static int
15829 #ifdef __BORLANDC__
15830 _RTLENTRYF
15831 #endif
15832 item_compare2(s1, s2)
15833 const void *s1;
15834 const void *s2;
15836 int res;
15837 typval_T rettv;
15838 typval_T argv[3];
15839 int dummy;
15841 /* shortcut after failure in previous call; compare all items equal */
15842 if (item_compare_func_err)
15843 return 0;
15845 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15846 * in the copy without changing the original list items. */
15847 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15848 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15850 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15851 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15852 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15853 clear_tv(&argv[0]);
15854 clear_tv(&argv[1]);
15856 if (res == FAIL)
15857 res = ITEM_COMPARE_FAIL;
15858 else
15859 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15860 if (item_compare_func_err)
15861 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15862 clear_tv(&rettv);
15863 return res;
15867 * "sort({list})" function
15869 static void
15870 f_sort(argvars, rettv)
15871 typval_T *argvars;
15872 typval_T *rettv;
15874 list_T *l;
15875 listitem_T *li;
15876 listitem_T **ptrs;
15877 long len;
15878 long i;
15880 if (argvars[0].v_type != VAR_LIST)
15881 EMSG2(_(e_listarg), "sort()");
15882 else
15884 l = argvars[0].vval.v_list;
15885 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15886 return;
15887 rettv->vval.v_list = l;
15888 rettv->v_type = VAR_LIST;
15889 ++l->lv_refcount;
15891 len = list_len(l);
15892 if (len <= 1)
15893 return; /* short list sorts pretty quickly */
15895 item_compare_ic = FALSE;
15896 item_compare_func = NULL;
15897 if (argvars[1].v_type != VAR_UNKNOWN)
15899 if (argvars[1].v_type == VAR_FUNC)
15900 item_compare_func = argvars[1].vval.v_string;
15901 else
15903 int error = FALSE;
15905 i = get_tv_number_chk(&argvars[1], &error);
15906 if (error)
15907 return; /* type error; errmsg already given */
15908 if (i == 1)
15909 item_compare_ic = TRUE;
15910 else
15911 item_compare_func = get_tv_string(&argvars[1]);
15915 /* Make an array with each entry pointing to an item in the List. */
15916 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15917 if (ptrs == NULL)
15918 return;
15919 i = 0;
15920 for (li = l->lv_first; li != NULL; li = li->li_next)
15921 ptrs[i++] = li;
15923 item_compare_func_err = FALSE;
15924 /* test the compare function */
15925 if (item_compare_func != NULL
15926 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15927 == ITEM_COMPARE_FAIL)
15928 EMSG(_("E702: Sort compare function failed"));
15929 else
15931 /* Sort the array with item pointers. */
15932 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15933 item_compare_func == NULL ? item_compare : item_compare2);
15935 if (!item_compare_func_err)
15937 /* Clear the List and append the items in the sorted order. */
15938 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15939 l->lv_len = 0;
15940 for (i = 0; i < len; ++i)
15941 list_append(l, ptrs[i]);
15945 vim_free(ptrs);
15950 * "soundfold({word})" function
15952 static void
15953 f_soundfold(argvars, rettv)
15954 typval_T *argvars;
15955 typval_T *rettv;
15957 char_u *s;
15959 rettv->v_type = VAR_STRING;
15960 s = get_tv_string(&argvars[0]);
15961 #ifdef FEAT_SPELL
15962 rettv->vval.v_string = eval_soundfold(s);
15963 #else
15964 rettv->vval.v_string = vim_strsave(s);
15965 #endif
15969 * "spellbadword()" function
15971 static void
15972 f_spellbadword(argvars, rettv)
15973 typval_T *argvars UNUSED;
15974 typval_T *rettv;
15976 char_u *word = (char_u *)"";
15977 hlf_T attr = HLF_COUNT;
15978 int len = 0;
15980 if (rettv_list_alloc(rettv) == FAIL)
15981 return;
15983 #ifdef FEAT_SPELL
15984 if (argvars[0].v_type == VAR_UNKNOWN)
15986 /* Find the start and length of the badly spelled word. */
15987 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
15988 if (len != 0)
15989 word = ml_get_cursor();
15991 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
15993 char_u *str = get_tv_string_chk(&argvars[0]);
15994 int capcol = -1;
15996 if (str != NULL)
15998 /* Check the argument for spelling. */
15999 while (*str != NUL)
16001 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16002 if (attr != HLF_COUNT)
16004 word = str;
16005 break;
16007 str += len;
16011 #endif
16013 list_append_string(rettv->vval.v_list, word, len);
16014 list_append_string(rettv->vval.v_list, (char_u *)(
16015 attr == HLF_SPB ? "bad" :
16016 attr == HLF_SPR ? "rare" :
16017 attr == HLF_SPL ? "local" :
16018 attr == HLF_SPC ? "caps" :
16019 ""), -1);
16023 * "spellsuggest()" function
16025 static void
16026 f_spellsuggest(argvars, rettv)
16027 typval_T *argvars UNUSED;
16028 typval_T *rettv;
16030 #ifdef FEAT_SPELL
16031 char_u *str;
16032 int typeerr = FALSE;
16033 int maxcount;
16034 garray_T ga;
16035 int i;
16036 listitem_T *li;
16037 int need_capital = FALSE;
16038 #endif
16040 if (rettv_list_alloc(rettv) == FAIL)
16041 return;
16043 #ifdef FEAT_SPELL
16044 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16046 str = get_tv_string(&argvars[0]);
16047 if (argvars[1].v_type != VAR_UNKNOWN)
16049 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16050 if (maxcount <= 0)
16051 return;
16052 if (argvars[2].v_type != VAR_UNKNOWN)
16054 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16055 if (typeerr)
16056 return;
16059 else
16060 maxcount = 25;
16062 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16064 for (i = 0; i < ga.ga_len; ++i)
16066 str = ((char_u **)ga.ga_data)[i];
16068 li = listitem_alloc();
16069 if (li == NULL)
16070 vim_free(str);
16071 else
16073 li->li_tv.v_type = VAR_STRING;
16074 li->li_tv.v_lock = 0;
16075 li->li_tv.vval.v_string = str;
16076 list_append(rettv->vval.v_list, li);
16079 ga_clear(&ga);
16081 #endif
16084 static void
16085 f_split(argvars, rettv)
16086 typval_T *argvars;
16087 typval_T *rettv;
16089 char_u *str;
16090 char_u *end;
16091 char_u *pat = NULL;
16092 regmatch_T regmatch;
16093 char_u patbuf[NUMBUFLEN];
16094 char_u *save_cpo;
16095 int match;
16096 colnr_T col = 0;
16097 int keepempty = FALSE;
16098 int typeerr = FALSE;
16100 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16101 save_cpo = p_cpo;
16102 p_cpo = (char_u *)"";
16104 str = get_tv_string(&argvars[0]);
16105 if (argvars[1].v_type != VAR_UNKNOWN)
16107 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16108 if (pat == NULL)
16109 typeerr = TRUE;
16110 if (argvars[2].v_type != VAR_UNKNOWN)
16111 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16113 if (pat == NULL || *pat == NUL)
16114 pat = (char_u *)"[\\x01- ]\\+";
16116 if (rettv_list_alloc(rettv) == FAIL)
16117 return;
16118 if (typeerr)
16119 return;
16121 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16122 if (regmatch.regprog != NULL)
16124 regmatch.rm_ic = FALSE;
16125 while (*str != NUL || keepempty)
16127 if (*str == NUL)
16128 match = FALSE; /* empty item at the end */
16129 else
16130 match = vim_regexec_nl(&regmatch, str, col);
16131 if (match)
16132 end = regmatch.startp[0];
16133 else
16134 end = str + STRLEN(str);
16135 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16136 && *str != NUL && match && end < regmatch.endp[0]))
16138 if (list_append_string(rettv->vval.v_list, str,
16139 (int)(end - str)) == FAIL)
16140 break;
16142 if (!match)
16143 break;
16144 /* Advance to just after the match. */
16145 if (regmatch.endp[0] > str)
16146 col = 0;
16147 else
16149 /* Don't get stuck at the same match. */
16150 #ifdef FEAT_MBYTE
16151 col = (*mb_ptr2len)(regmatch.endp[0]);
16152 #else
16153 col = 1;
16154 #endif
16156 str = regmatch.endp[0];
16159 vim_free(regmatch.regprog);
16162 p_cpo = save_cpo;
16165 #ifdef FEAT_FLOAT
16167 * "sqrt()" function
16169 static void
16170 f_sqrt(argvars, rettv)
16171 typval_T *argvars;
16172 typval_T *rettv;
16174 float_T f;
16176 rettv->v_type = VAR_FLOAT;
16177 if (get_float_arg(argvars, &f) == OK)
16178 rettv->vval.v_float = sqrt(f);
16179 else
16180 rettv->vval.v_float = 0.0;
16184 * "str2float()" function
16186 static void
16187 f_str2float(argvars, rettv)
16188 typval_T *argvars;
16189 typval_T *rettv;
16191 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16193 if (*p == '+')
16194 p = skipwhite(p + 1);
16195 (void)string2float(p, &rettv->vval.v_float);
16196 rettv->v_type = VAR_FLOAT;
16198 #endif
16201 * "str2nr()" function
16203 static void
16204 f_str2nr(argvars, rettv)
16205 typval_T *argvars;
16206 typval_T *rettv;
16208 int base = 10;
16209 char_u *p;
16210 long n;
16212 if (argvars[1].v_type != VAR_UNKNOWN)
16214 base = get_tv_number(&argvars[1]);
16215 if (base != 8 && base != 10 && base != 16)
16217 EMSG(_(e_invarg));
16218 return;
16222 p = skipwhite(get_tv_string(&argvars[0]));
16223 if (*p == '+')
16224 p = skipwhite(p + 1);
16225 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16226 rettv->vval.v_number = n;
16229 #ifdef HAVE_STRFTIME
16231 * "strftime({format}[, {time}])" function
16233 static void
16234 f_strftime(argvars, rettv)
16235 typval_T *argvars;
16236 typval_T *rettv;
16238 char_u result_buf[256];
16239 struct tm *curtime;
16240 time_t seconds;
16241 char_u *p;
16243 rettv->v_type = VAR_STRING;
16245 p = get_tv_string(&argvars[0]);
16246 if (argvars[1].v_type == VAR_UNKNOWN)
16247 seconds = time(NULL);
16248 else
16249 seconds = (time_t)get_tv_number(&argvars[1]);
16250 curtime = localtime(&seconds);
16251 /* MSVC returns NULL for an invalid value of seconds. */
16252 if (curtime == NULL)
16253 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16254 else
16256 # ifdef FEAT_MBYTE
16257 vimconv_T conv;
16258 char_u *enc;
16260 conv.vc_type = CONV_NONE;
16261 enc = enc_locale();
16262 convert_setup(&conv, p_enc, enc);
16263 if (conv.vc_type != CONV_NONE)
16264 p = string_convert(&conv, p, NULL);
16265 # endif
16266 if (p != NULL)
16267 (void)strftime((char *)result_buf, sizeof(result_buf),
16268 (char *)p, curtime);
16269 else
16270 result_buf[0] = NUL;
16272 # ifdef FEAT_MBYTE
16273 if (conv.vc_type != CONV_NONE)
16274 vim_free(p);
16275 convert_setup(&conv, enc, p_enc);
16276 if (conv.vc_type != CONV_NONE)
16277 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16278 else
16279 # endif
16280 rettv->vval.v_string = vim_strsave(result_buf);
16282 # ifdef FEAT_MBYTE
16283 /* Release conversion descriptors */
16284 convert_setup(&conv, NULL, NULL);
16285 vim_free(enc);
16286 # endif
16289 #endif
16292 * "stridx()" function
16294 static void
16295 f_stridx(argvars, rettv)
16296 typval_T *argvars;
16297 typval_T *rettv;
16299 char_u buf[NUMBUFLEN];
16300 char_u *needle;
16301 char_u *haystack;
16302 char_u *save_haystack;
16303 char_u *pos;
16304 int start_idx;
16306 needle = get_tv_string_chk(&argvars[1]);
16307 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16308 rettv->vval.v_number = -1;
16309 if (needle == NULL || haystack == NULL)
16310 return; /* type error; errmsg already given */
16312 if (argvars[2].v_type != VAR_UNKNOWN)
16314 int error = FALSE;
16316 start_idx = get_tv_number_chk(&argvars[2], &error);
16317 if (error || start_idx >= (int)STRLEN(haystack))
16318 return;
16319 if (start_idx >= 0)
16320 haystack += start_idx;
16323 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16324 if (pos != NULL)
16325 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16329 * "string()" function
16331 static void
16332 f_string(argvars, rettv)
16333 typval_T *argvars;
16334 typval_T *rettv;
16336 char_u *tofree;
16337 char_u numbuf[NUMBUFLEN];
16339 rettv->v_type = VAR_STRING;
16340 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16341 /* Make a copy if we have a value but it's not in allocated memory. */
16342 if (rettv->vval.v_string != NULL && tofree == NULL)
16343 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16347 * "strlen()" function
16349 static void
16350 f_strlen(argvars, rettv)
16351 typval_T *argvars;
16352 typval_T *rettv;
16354 rettv->vval.v_number = (varnumber_T)(STRLEN(
16355 get_tv_string(&argvars[0])));
16359 * "strpart()" function
16361 static void
16362 f_strpart(argvars, rettv)
16363 typval_T *argvars;
16364 typval_T *rettv;
16366 char_u *p;
16367 int n;
16368 int len;
16369 int slen;
16370 int error = FALSE;
16372 p = get_tv_string(&argvars[0]);
16373 slen = (int)STRLEN(p);
16375 n = get_tv_number_chk(&argvars[1], &error);
16376 if (error)
16377 len = 0;
16378 else if (argvars[2].v_type != VAR_UNKNOWN)
16379 len = get_tv_number(&argvars[2]);
16380 else
16381 len = slen - n; /* default len: all bytes that are available. */
16384 * Only return the overlap between the specified part and the actual
16385 * string.
16387 if (n < 0)
16389 len += n;
16390 n = 0;
16392 else if (n > slen)
16393 n = slen;
16394 if (len < 0)
16395 len = 0;
16396 else if (n + len > slen)
16397 len = slen - n;
16399 rettv->v_type = VAR_STRING;
16400 rettv->vval.v_string = vim_strnsave(p + n, len);
16404 * "strridx()" function
16406 static void
16407 f_strridx(argvars, rettv)
16408 typval_T *argvars;
16409 typval_T *rettv;
16411 char_u buf[NUMBUFLEN];
16412 char_u *needle;
16413 char_u *haystack;
16414 char_u *rest;
16415 char_u *lastmatch = NULL;
16416 int haystack_len, end_idx;
16418 needle = get_tv_string_chk(&argvars[1]);
16419 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16421 rettv->vval.v_number = -1;
16422 if (needle == NULL || haystack == NULL)
16423 return; /* type error; errmsg already given */
16425 haystack_len = (int)STRLEN(haystack);
16426 if (argvars[2].v_type != VAR_UNKNOWN)
16428 /* Third argument: upper limit for index */
16429 end_idx = get_tv_number_chk(&argvars[2], NULL);
16430 if (end_idx < 0)
16431 return; /* can never find a match */
16433 else
16434 end_idx = haystack_len;
16436 if (*needle == NUL)
16438 /* Empty string matches past the end. */
16439 lastmatch = haystack + end_idx;
16441 else
16443 for (rest = haystack; *rest != '\0'; ++rest)
16445 rest = (char_u *)strstr((char *)rest, (char *)needle);
16446 if (rest == NULL || rest > haystack + end_idx)
16447 break;
16448 lastmatch = rest;
16452 if (lastmatch == NULL)
16453 rettv->vval.v_number = -1;
16454 else
16455 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16459 * "strtrans()" function
16461 static void
16462 f_strtrans(argvars, rettv)
16463 typval_T *argvars;
16464 typval_T *rettv;
16466 rettv->v_type = VAR_STRING;
16467 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16471 * "submatch()" function
16473 static void
16474 f_submatch(argvars, rettv)
16475 typval_T *argvars;
16476 typval_T *rettv;
16478 rettv->v_type = VAR_STRING;
16479 rettv->vval.v_string =
16480 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16484 * "substitute()" function
16486 static void
16487 f_substitute(argvars, rettv)
16488 typval_T *argvars;
16489 typval_T *rettv;
16491 char_u patbuf[NUMBUFLEN];
16492 char_u subbuf[NUMBUFLEN];
16493 char_u flagsbuf[NUMBUFLEN];
16495 char_u *str = get_tv_string_chk(&argvars[0]);
16496 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16497 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16498 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16500 rettv->v_type = VAR_STRING;
16501 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16502 rettv->vval.v_string = NULL;
16503 else
16504 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16508 * "synID(lnum, col, trans)" function
16510 static void
16511 f_synID(argvars, rettv)
16512 typval_T *argvars UNUSED;
16513 typval_T *rettv;
16515 int id = 0;
16516 #ifdef FEAT_SYN_HL
16517 long lnum;
16518 long col;
16519 int trans;
16520 int transerr = FALSE;
16522 lnum = get_tv_lnum(argvars); /* -1 on type error */
16523 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16524 trans = get_tv_number_chk(&argvars[2], &transerr);
16526 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16527 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16528 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16529 #endif
16531 rettv->vval.v_number = id;
16535 * "synIDattr(id, what [, mode])" function
16537 static void
16538 f_synIDattr(argvars, rettv)
16539 typval_T *argvars UNUSED;
16540 typval_T *rettv;
16542 char_u *p = NULL;
16543 #ifdef FEAT_SYN_HL
16544 int id;
16545 char_u *what;
16546 char_u *mode;
16547 char_u modebuf[NUMBUFLEN];
16548 int modec;
16550 id = get_tv_number(&argvars[0]);
16551 what = get_tv_string(&argvars[1]);
16552 if (argvars[2].v_type != VAR_UNKNOWN)
16554 mode = get_tv_string_buf(&argvars[2], modebuf);
16555 modec = TOLOWER_ASC(mode[0]);
16556 if (modec != 't' && modec != 'c'
16557 #ifdef FEAT_GUI
16558 && modec != 'g'
16559 #endif
16561 modec = 0; /* replace invalid with current */
16563 else
16565 #ifdef FEAT_GUI
16566 if (gui.in_use)
16567 modec = 'g';
16568 else
16569 #endif
16570 if (t_colors > 1)
16571 modec = 'c';
16572 else
16573 modec = 't';
16577 switch (TOLOWER_ASC(what[0]))
16579 case 'b':
16580 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16581 p = highlight_color(id, what, modec);
16582 else /* bold */
16583 p = highlight_has_attr(id, HL_BOLD, modec);
16584 break;
16586 case 'f': /* fg[#] */
16587 p = highlight_color(id, what, modec);
16588 break;
16590 case 'i':
16591 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16592 p = highlight_has_attr(id, HL_INVERSE, modec);
16593 else /* italic */
16594 p = highlight_has_attr(id, HL_ITALIC, modec);
16595 break;
16597 case 'n': /* name */
16598 p = get_highlight_name(NULL, id - 1);
16599 break;
16601 case 'r': /* reverse */
16602 p = highlight_has_attr(id, HL_INVERSE, modec);
16603 break;
16605 case 's':
16606 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16607 p = highlight_color(id, what, modec);
16608 else /* standout */
16609 p = highlight_has_attr(id, HL_STANDOUT, modec);
16610 break;
16612 case 'u':
16613 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16614 /* underline */
16615 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16616 else
16617 /* undercurl */
16618 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16619 break;
16622 if (p != NULL)
16623 p = vim_strsave(p);
16624 #endif
16625 rettv->v_type = VAR_STRING;
16626 rettv->vval.v_string = p;
16630 * "synIDtrans(id)" function
16632 static void
16633 f_synIDtrans(argvars, rettv)
16634 typval_T *argvars UNUSED;
16635 typval_T *rettv;
16637 int id;
16639 #ifdef FEAT_SYN_HL
16640 id = get_tv_number(&argvars[0]);
16642 if (id > 0)
16643 id = syn_get_final_id(id);
16644 else
16645 #endif
16646 id = 0;
16648 rettv->vval.v_number = id;
16652 * "synstack(lnum, col)" function
16654 static void
16655 f_synstack(argvars, rettv)
16656 typval_T *argvars UNUSED;
16657 typval_T *rettv;
16659 #ifdef FEAT_SYN_HL
16660 long lnum;
16661 long col;
16662 int i;
16663 int id;
16664 #endif
16666 rettv->v_type = VAR_LIST;
16667 rettv->vval.v_list = NULL;
16669 #ifdef FEAT_SYN_HL
16670 lnum = get_tv_lnum(argvars); /* -1 on type error */
16671 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16673 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16674 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16675 && rettv_list_alloc(rettv) != FAIL)
16677 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16678 for (i = 0; ; ++i)
16680 id = syn_get_stack_item(i);
16681 if (id < 0)
16682 break;
16683 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16684 break;
16687 #endif
16691 * "system()" function
16693 static void
16694 f_system(argvars, rettv)
16695 typval_T *argvars;
16696 typval_T *rettv;
16698 char_u *res = NULL;
16699 char_u *p;
16700 char_u *infile = NULL;
16701 char_u buf[NUMBUFLEN];
16702 int err = FALSE;
16703 FILE *fd;
16705 if (check_restricted() || check_secure())
16706 goto done;
16708 if (argvars[1].v_type != VAR_UNKNOWN)
16711 * Write the string to a temp file, to be used for input of the shell
16712 * command.
16714 if ((infile = vim_tempname('i')) == NULL)
16716 EMSG(_(e_notmp));
16717 goto done;
16720 fd = mch_fopen((char *)infile, WRITEBIN);
16721 if (fd == NULL)
16723 EMSG2(_(e_notopen), infile);
16724 goto done;
16726 p = get_tv_string_buf_chk(&argvars[1], buf);
16727 if (p == NULL)
16729 fclose(fd);
16730 goto done; /* type error; errmsg already given */
16732 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16733 err = TRUE;
16734 if (fclose(fd) != 0)
16735 err = TRUE;
16736 if (err)
16738 EMSG(_("E677: Error writing temp file"));
16739 goto done;
16743 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16744 SHELL_SILENT | SHELL_COOKED);
16746 #ifdef USE_CR
16747 /* translate <CR> into <NL> */
16748 if (res != NULL)
16750 char_u *s;
16752 for (s = res; *s; ++s)
16754 if (*s == CAR)
16755 *s = NL;
16758 #else
16759 # ifdef USE_CRNL
16760 /* translate <CR><NL> into <NL> */
16761 if (res != NULL)
16763 char_u *s, *d;
16765 d = res;
16766 for (s = res; *s; ++s)
16768 if (s[0] == CAR && s[1] == NL)
16769 ++s;
16770 *d++ = *s;
16772 *d = NUL;
16774 # endif
16775 #endif
16777 done:
16778 if (infile != NULL)
16780 mch_remove(infile);
16781 vim_free(infile);
16783 rettv->v_type = VAR_STRING;
16784 rettv->vval.v_string = res;
16788 * "tabpagebuflist()" function
16790 static void
16791 f_tabpagebuflist(argvars, rettv)
16792 typval_T *argvars UNUSED;
16793 typval_T *rettv UNUSED;
16795 #ifdef FEAT_WINDOWS
16796 tabpage_T *tp;
16797 win_T *wp = NULL;
16799 if (argvars[0].v_type == VAR_UNKNOWN)
16800 wp = firstwin;
16801 else
16803 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16804 if (tp != NULL)
16805 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16807 if (wp != NULL && rettv_list_alloc(rettv) != FAIL)
16809 for (; wp != NULL; wp = wp->w_next)
16810 if (list_append_number(rettv->vval.v_list,
16811 wp->w_buffer->b_fnum) == FAIL)
16812 break;
16814 #endif
16819 * "tabpagenr()" function
16821 static void
16822 f_tabpagenr(argvars, rettv)
16823 typval_T *argvars UNUSED;
16824 typval_T *rettv;
16826 int nr = 1;
16827 #ifdef FEAT_WINDOWS
16828 char_u *arg;
16830 if (argvars[0].v_type != VAR_UNKNOWN)
16832 arg = get_tv_string_chk(&argvars[0]);
16833 nr = 0;
16834 if (arg != NULL)
16836 if (STRCMP(arg, "$") == 0)
16837 nr = tabpage_index(NULL) - 1;
16838 else
16839 EMSG2(_(e_invexpr2), arg);
16842 else
16843 nr = tabpage_index(curtab);
16844 #endif
16845 rettv->vval.v_number = nr;
16849 #ifdef FEAT_WINDOWS
16850 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16853 * Common code for tabpagewinnr() and winnr().
16855 static int
16856 get_winnr(tp, argvar)
16857 tabpage_T *tp;
16858 typval_T *argvar;
16860 win_T *twin;
16861 int nr = 1;
16862 win_T *wp;
16863 char_u *arg;
16865 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16866 if (argvar->v_type != VAR_UNKNOWN)
16868 arg = get_tv_string_chk(argvar);
16869 if (arg == NULL)
16870 nr = 0; /* type error; errmsg already given */
16871 else if (STRCMP(arg, "$") == 0)
16872 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16873 else if (STRCMP(arg, "#") == 0)
16875 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16876 if (twin == NULL)
16877 nr = 0;
16879 else
16881 EMSG2(_(e_invexpr2), arg);
16882 nr = 0;
16886 if (nr > 0)
16887 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16888 wp != twin; wp = wp->w_next)
16890 if (wp == NULL)
16892 /* didn't find it in this tabpage */
16893 nr = 0;
16894 break;
16896 ++nr;
16898 return nr;
16900 #endif
16903 * "tabpagewinnr()" function
16905 static void
16906 f_tabpagewinnr(argvars, rettv)
16907 typval_T *argvars UNUSED;
16908 typval_T *rettv;
16910 int nr = 1;
16911 #ifdef FEAT_WINDOWS
16912 tabpage_T *tp;
16914 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16915 if (tp == NULL)
16916 nr = 0;
16917 else
16918 nr = get_winnr(tp, &argvars[1]);
16919 #endif
16920 rettv->vval.v_number = nr;
16925 * "tagfiles()" function
16927 static void
16928 f_tagfiles(argvars, rettv)
16929 typval_T *argvars UNUSED;
16930 typval_T *rettv;
16932 char_u fname[MAXPATHL + 1];
16933 tagname_T tn;
16934 int first;
16936 if (rettv_list_alloc(rettv) == FAIL)
16937 return;
16939 for (first = TRUE; ; first = FALSE)
16940 if (get_tagfname(&tn, first, fname) == FAIL
16941 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
16942 break;
16943 tagname_free(&tn);
16947 * "taglist()" function
16949 static void
16950 f_taglist(argvars, rettv)
16951 typval_T *argvars;
16952 typval_T *rettv;
16954 char_u *tag_pattern;
16956 tag_pattern = get_tv_string(&argvars[0]);
16958 rettv->vval.v_number = FALSE;
16959 if (*tag_pattern == NUL)
16960 return;
16962 if (rettv_list_alloc(rettv) == OK)
16963 (void)get_tags(rettv->vval.v_list, tag_pattern);
16967 * "tempname()" function
16969 static void
16970 f_tempname(argvars, rettv)
16971 typval_T *argvars UNUSED;
16972 typval_T *rettv;
16974 static int x = 'A';
16976 rettv->v_type = VAR_STRING;
16977 rettv->vval.v_string = vim_tempname(x);
16979 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
16980 * names. Skip 'I' and 'O', they are used for shell redirection. */
16983 if (x == 'Z')
16984 x = '0';
16985 else if (x == '9')
16986 x = 'A';
16987 else
16989 #ifdef EBCDIC
16990 if (x == 'I')
16991 x = 'J';
16992 else if (x == 'R')
16993 x = 'S';
16994 else
16995 #endif
16996 ++x;
16998 } while (x == 'I' || x == 'O');
17002 * "test(list)" function: Just checking the walls...
17004 static void
17005 f_test(argvars, rettv)
17006 typval_T *argvars UNUSED;
17007 typval_T *rettv UNUSED;
17009 /* Used for unit testing. Change the code below to your liking. */
17010 #if 0
17011 listitem_T *li;
17012 list_T *l;
17013 char_u *bad, *good;
17015 if (argvars[0].v_type != VAR_LIST)
17016 return;
17017 l = argvars[0].vval.v_list;
17018 if (l == NULL)
17019 return;
17020 li = l->lv_first;
17021 if (li == NULL)
17022 return;
17023 bad = get_tv_string(&li->li_tv);
17024 li = li->li_next;
17025 if (li == NULL)
17026 return;
17027 good = get_tv_string(&li->li_tv);
17028 rettv->vval.v_number = test_edit_score(bad, good);
17029 #endif
17033 * "tolower(string)" function
17035 static void
17036 f_tolower(argvars, rettv)
17037 typval_T *argvars;
17038 typval_T *rettv;
17040 char_u *p;
17042 p = vim_strsave(get_tv_string(&argvars[0]));
17043 rettv->v_type = VAR_STRING;
17044 rettv->vval.v_string = p;
17046 if (p != NULL)
17047 while (*p != NUL)
17049 #ifdef FEAT_MBYTE
17050 int l;
17052 if (enc_utf8)
17054 int c, lc;
17056 c = utf_ptr2char(p);
17057 lc = utf_tolower(c);
17058 l = utf_ptr2len(p);
17059 /* TODO: reallocate string when byte count changes. */
17060 if (utf_char2len(lc) == l)
17061 utf_char2bytes(lc, p);
17062 p += l;
17064 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17065 p += l; /* skip multi-byte character */
17066 else
17067 #endif
17069 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17070 ++p;
17076 * "toupper(string)" function
17078 static void
17079 f_toupper(argvars, rettv)
17080 typval_T *argvars;
17081 typval_T *rettv;
17083 rettv->v_type = VAR_STRING;
17084 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17088 * "tr(string, fromstr, tostr)" function
17090 static void
17091 f_tr(argvars, rettv)
17092 typval_T *argvars;
17093 typval_T *rettv;
17095 char_u *instr;
17096 char_u *fromstr;
17097 char_u *tostr;
17098 char_u *p;
17099 #ifdef FEAT_MBYTE
17100 int inlen;
17101 int fromlen;
17102 int tolen;
17103 int idx;
17104 char_u *cpstr;
17105 int cplen;
17106 int first = TRUE;
17107 #endif
17108 char_u buf[NUMBUFLEN];
17109 char_u buf2[NUMBUFLEN];
17110 garray_T ga;
17112 instr = get_tv_string(&argvars[0]);
17113 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17114 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17116 /* Default return value: empty string. */
17117 rettv->v_type = VAR_STRING;
17118 rettv->vval.v_string = NULL;
17119 if (fromstr == NULL || tostr == NULL)
17120 return; /* type error; errmsg already given */
17121 ga_init2(&ga, (int)sizeof(char), 80);
17123 #ifdef FEAT_MBYTE
17124 if (!has_mbyte)
17125 #endif
17126 /* not multi-byte: fromstr and tostr must be the same length */
17127 if (STRLEN(fromstr) != STRLEN(tostr))
17129 #ifdef FEAT_MBYTE
17130 error:
17131 #endif
17132 EMSG2(_(e_invarg2), fromstr);
17133 ga_clear(&ga);
17134 return;
17137 /* fromstr and tostr have to contain the same number of chars */
17138 while (*instr != NUL)
17140 #ifdef FEAT_MBYTE
17141 if (has_mbyte)
17143 inlen = (*mb_ptr2len)(instr);
17144 cpstr = instr;
17145 cplen = inlen;
17146 idx = 0;
17147 for (p = fromstr; *p != NUL; p += fromlen)
17149 fromlen = (*mb_ptr2len)(p);
17150 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17152 for (p = tostr; *p != NUL; p += tolen)
17154 tolen = (*mb_ptr2len)(p);
17155 if (idx-- == 0)
17157 cplen = tolen;
17158 cpstr = p;
17159 break;
17162 if (*p == NUL) /* tostr is shorter than fromstr */
17163 goto error;
17164 break;
17166 ++idx;
17169 if (first && cpstr == instr)
17171 /* Check that fromstr and tostr have the same number of
17172 * (multi-byte) characters. Done only once when a character
17173 * of instr doesn't appear in fromstr. */
17174 first = FALSE;
17175 for (p = tostr; *p != NUL; p += tolen)
17177 tolen = (*mb_ptr2len)(p);
17178 --idx;
17180 if (idx != 0)
17181 goto error;
17184 ga_grow(&ga, cplen);
17185 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17186 ga.ga_len += cplen;
17188 instr += inlen;
17190 else
17191 #endif
17193 /* When not using multi-byte chars we can do it faster. */
17194 p = vim_strchr(fromstr, *instr);
17195 if (p != NULL)
17196 ga_append(&ga, tostr[p - fromstr]);
17197 else
17198 ga_append(&ga, *instr);
17199 ++instr;
17203 /* add a terminating NUL */
17204 ga_grow(&ga, 1);
17205 ga_append(&ga, NUL);
17207 rettv->vval.v_string = ga.ga_data;
17210 #ifdef FEAT_FLOAT
17212 * "trunc({float})" function
17214 static void
17215 f_trunc(argvars, rettv)
17216 typval_T *argvars;
17217 typval_T *rettv;
17219 float_T f;
17221 rettv->v_type = VAR_FLOAT;
17222 if (get_float_arg(argvars, &f) == OK)
17223 /* trunc() is not in C90, use floor() or ceil() instead. */
17224 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17225 else
17226 rettv->vval.v_float = 0.0;
17228 #endif
17231 * "type(expr)" function
17233 static void
17234 f_type(argvars, rettv)
17235 typval_T *argvars;
17236 typval_T *rettv;
17238 int n;
17240 switch (argvars[0].v_type)
17242 case VAR_NUMBER: n = 0; break;
17243 case VAR_STRING: n = 1; break;
17244 case VAR_FUNC: n = 2; break;
17245 case VAR_LIST: n = 3; break;
17246 case VAR_DICT: n = 4; break;
17247 #ifdef FEAT_FLOAT
17248 case VAR_FLOAT: n = 5; break;
17249 #endif
17250 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17252 rettv->vval.v_number = n;
17256 * "values(dict)" function
17258 static void
17259 f_values(argvars, rettv)
17260 typval_T *argvars;
17261 typval_T *rettv;
17263 dict_list(argvars, rettv, 1);
17267 * "virtcol(string)" function
17269 static void
17270 f_virtcol(argvars, rettv)
17271 typval_T *argvars;
17272 typval_T *rettv;
17274 colnr_T vcol = 0;
17275 pos_T *fp;
17276 int fnum = curbuf->b_fnum;
17278 fp = var2fpos(&argvars[0], FALSE, &fnum);
17279 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17280 && fnum == curbuf->b_fnum)
17282 getvvcol(curwin, fp, NULL, NULL, &vcol);
17283 ++vcol;
17286 rettv->vval.v_number = vcol;
17290 * "visualmode()" function
17292 static void
17293 f_visualmode(argvars, rettv)
17294 typval_T *argvars UNUSED;
17295 typval_T *rettv UNUSED;
17297 #ifdef FEAT_VISUAL
17298 char_u str[2];
17300 rettv->v_type = VAR_STRING;
17301 str[0] = curbuf->b_visual_mode_eval;
17302 str[1] = NUL;
17303 rettv->vval.v_string = vim_strsave(str);
17305 /* A non-zero number or non-empty string argument: reset mode. */
17306 if (non_zero_arg(&argvars[0]))
17307 curbuf->b_visual_mode_eval = NUL;
17308 #endif
17312 * "winbufnr(nr)" function
17314 static void
17315 f_winbufnr(argvars, rettv)
17316 typval_T *argvars;
17317 typval_T *rettv;
17319 win_T *wp;
17321 wp = find_win_by_nr(&argvars[0], NULL);
17322 if (wp == NULL)
17323 rettv->vval.v_number = -1;
17324 else
17325 rettv->vval.v_number = wp->w_buffer->b_fnum;
17329 * "wincol()" function
17331 static void
17332 f_wincol(argvars, rettv)
17333 typval_T *argvars UNUSED;
17334 typval_T *rettv;
17336 validate_cursor();
17337 rettv->vval.v_number = curwin->w_wcol + 1;
17341 * "winheight(nr)" function
17343 static void
17344 f_winheight(argvars, rettv)
17345 typval_T *argvars;
17346 typval_T *rettv;
17348 win_T *wp;
17350 wp = find_win_by_nr(&argvars[0], NULL);
17351 if (wp == NULL)
17352 rettv->vval.v_number = -1;
17353 else
17354 rettv->vval.v_number = wp->w_height;
17358 * "winline()" function
17360 static void
17361 f_winline(argvars, rettv)
17362 typval_T *argvars UNUSED;
17363 typval_T *rettv;
17365 validate_cursor();
17366 rettv->vval.v_number = curwin->w_wrow + 1;
17370 * "winnr()" function
17372 static void
17373 f_winnr(argvars, rettv)
17374 typval_T *argvars UNUSED;
17375 typval_T *rettv;
17377 int nr = 1;
17379 #ifdef FEAT_WINDOWS
17380 nr = get_winnr(curtab, &argvars[0]);
17381 #endif
17382 rettv->vval.v_number = nr;
17386 * "winrestcmd()" function
17388 static void
17389 f_winrestcmd(argvars, rettv)
17390 typval_T *argvars UNUSED;
17391 typval_T *rettv;
17393 #ifdef FEAT_WINDOWS
17394 win_T *wp;
17395 int winnr = 1;
17396 garray_T ga;
17397 char_u buf[50];
17399 ga_init2(&ga, (int)sizeof(char), 70);
17400 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17402 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17403 ga_concat(&ga, buf);
17404 # ifdef FEAT_VERTSPLIT
17405 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17406 ga_concat(&ga, buf);
17407 # endif
17408 ++winnr;
17410 ga_append(&ga, NUL);
17412 rettv->vval.v_string = ga.ga_data;
17413 #else
17414 rettv->vval.v_string = NULL;
17415 #endif
17416 rettv->v_type = VAR_STRING;
17420 * "winrestview()" function
17422 static void
17423 f_winrestview(argvars, rettv)
17424 typval_T *argvars;
17425 typval_T *rettv UNUSED;
17427 dict_T *dict;
17429 if (argvars[0].v_type != VAR_DICT
17430 || (dict = argvars[0].vval.v_dict) == NULL)
17431 EMSG(_(e_invarg));
17432 else
17434 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17435 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17436 #ifdef FEAT_VIRTUALEDIT
17437 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17438 #endif
17439 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17440 curwin->w_set_curswant = FALSE;
17442 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17443 #ifdef FEAT_DIFF
17444 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17445 #endif
17446 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17447 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17449 check_cursor();
17450 changed_cline_bef_curs();
17451 invalidate_botline();
17452 redraw_later(VALID);
17454 if (curwin->w_topline == 0)
17455 curwin->w_topline = 1;
17456 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17457 curwin->w_topline = curbuf->b_ml.ml_line_count;
17458 #ifdef FEAT_DIFF
17459 check_topfill(curwin, TRUE);
17460 #endif
17465 * "winsaveview()" function
17467 static void
17468 f_winsaveview(argvars, rettv)
17469 typval_T *argvars UNUSED;
17470 typval_T *rettv;
17472 dict_T *dict;
17474 dict = dict_alloc();
17475 if (dict == NULL)
17476 return;
17477 rettv->v_type = VAR_DICT;
17478 rettv->vval.v_dict = dict;
17479 ++dict->dv_refcount;
17481 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17482 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17483 #ifdef FEAT_VIRTUALEDIT
17484 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17485 #endif
17486 update_curswant();
17487 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17489 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17490 #ifdef FEAT_DIFF
17491 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17492 #endif
17493 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17494 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17498 * "winwidth(nr)" function
17500 static void
17501 f_winwidth(argvars, rettv)
17502 typval_T *argvars;
17503 typval_T *rettv;
17505 win_T *wp;
17507 wp = find_win_by_nr(&argvars[0], NULL);
17508 if (wp == NULL)
17509 rettv->vval.v_number = -1;
17510 else
17511 #ifdef FEAT_VERTSPLIT
17512 rettv->vval.v_number = wp->w_width;
17513 #else
17514 rettv->vval.v_number = Columns;
17515 #endif
17519 * "writefile()" function
17521 static void
17522 f_writefile(argvars, rettv)
17523 typval_T *argvars;
17524 typval_T *rettv;
17526 int binary = FALSE;
17527 char_u *fname;
17528 FILE *fd;
17529 listitem_T *li;
17530 char_u *s;
17531 int ret = 0;
17532 int c;
17534 if (check_restricted() || check_secure())
17535 return;
17537 if (argvars[0].v_type != VAR_LIST)
17539 EMSG2(_(e_listarg), "writefile()");
17540 return;
17542 if (argvars[0].vval.v_list == NULL)
17543 return;
17545 if (argvars[2].v_type != VAR_UNKNOWN
17546 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17547 binary = TRUE;
17549 /* Always open the file in binary mode, library functions have a mind of
17550 * their own about CR-LF conversion. */
17551 fname = get_tv_string(&argvars[1]);
17552 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17554 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17555 ret = -1;
17557 else
17559 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17560 li = li->li_next)
17562 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17564 if (*s == '\n')
17565 c = putc(NUL, fd);
17566 else
17567 c = putc(*s, fd);
17568 if (c == EOF)
17570 ret = -1;
17571 break;
17574 if (!binary || li->li_next != NULL)
17575 if (putc('\n', fd) == EOF)
17577 ret = -1;
17578 break;
17580 if (ret < 0)
17582 EMSG(_(e_write));
17583 break;
17586 fclose(fd);
17589 rettv->vval.v_number = ret;
17593 * Translate a String variable into a position.
17594 * Returns NULL when there is an error.
17596 static pos_T *
17597 var2fpos(varp, dollar_lnum, fnum)
17598 typval_T *varp;
17599 int dollar_lnum; /* TRUE when $ is last line */
17600 int *fnum; /* set to fnum for '0, 'A, etc. */
17602 char_u *name;
17603 static pos_T pos;
17604 pos_T *pp;
17606 /* Argument can be [lnum, col, coladd]. */
17607 if (varp->v_type == VAR_LIST)
17609 list_T *l;
17610 int len;
17611 int error = FALSE;
17612 listitem_T *li;
17614 l = varp->vval.v_list;
17615 if (l == NULL)
17616 return NULL;
17618 /* Get the line number */
17619 pos.lnum = list_find_nr(l, 0L, &error);
17620 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17621 return NULL; /* invalid line number */
17623 /* Get the column number */
17624 pos.col = list_find_nr(l, 1L, &error);
17625 if (error)
17626 return NULL;
17627 len = (long)STRLEN(ml_get(pos.lnum));
17629 /* We accept "$" for the column number: last column. */
17630 li = list_find(l, 1L);
17631 if (li != NULL && li->li_tv.v_type == VAR_STRING
17632 && li->li_tv.vval.v_string != NULL
17633 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17634 pos.col = len + 1;
17636 /* Accept a position up to the NUL after the line. */
17637 if (pos.col == 0 || (int)pos.col > len + 1)
17638 return NULL; /* invalid column number */
17639 --pos.col;
17641 #ifdef FEAT_VIRTUALEDIT
17642 /* Get the virtual offset. Defaults to zero. */
17643 pos.coladd = list_find_nr(l, 2L, &error);
17644 if (error)
17645 pos.coladd = 0;
17646 #endif
17648 return &pos;
17651 name = get_tv_string_chk(varp);
17652 if (name == NULL)
17653 return NULL;
17654 if (name[0] == '.') /* cursor */
17655 return &curwin->w_cursor;
17656 #ifdef FEAT_VISUAL
17657 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17659 if (VIsual_active)
17660 return &VIsual;
17661 return &curwin->w_cursor;
17663 #endif
17664 if (name[0] == '\'') /* mark */
17666 pp = getmark_fnum(name[1], FALSE, fnum);
17667 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17668 return NULL;
17669 return pp;
17672 #ifdef FEAT_VIRTUALEDIT
17673 pos.coladd = 0;
17674 #endif
17676 if (name[0] == 'w' && dollar_lnum)
17678 pos.col = 0;
17679 if (name[1] == '0') /* "w0": first visible line */
17681 update_topline();
17682 pos.lnum = curwin->w_topline;
17683 return &pos;
17685 else if (name[1] == '$') /* "w$": last visible line */
17687 validate_botline();
17688 pos.lnum = curwin->w_botline - 1;
17689 return &pos;
17692 else if (name[0] == '$') /* last column or line */
17694 if (dollar_lnum)
17696 pos.lnum = curbuf->b_ml.ml_line_count;
17697 pos.col = 0;
17699 else
17701 pos.lnum = curwin->w_cursor.lnum;
17702 pos.col = (colnr_T)STRLEN(ml_get_curline());
17704 return &pos;
17706 return NULL;
17710 * Convert list in "arg" into a position and optional file number.
17711 * When "fnump" is NULL there is no file number, only 3 items.
17712 * Note that the column is passed on as-is, the caller may want to decrement
17713 * it to use 1 for the first column.
17714 * Return FAIL when conversion is not possible, doesn't check the position for
17715 * validity.
17717 static int
17718 list2fpos(arg, posp, fnump)
17719 typval_T *arg;
17720 pos_T *posp;
17721 int *fnump;
17723 list_T *l = arg->vval.v_list;
17724 long i = 0;
17725 long n;
17727 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17728 * when "fnump" isn't NULL and "coladd" is optional. */
17729 if (arg->v_type != VAR_LIST
17730 || l == NULL
17731 || l->lv_len < (fnump == NULL ? 2 : 3)
17732 || l->lv_len > (fnump == NULL ? 3 : 4))
17733 return FAIL;
17735 if (fnump != NULL)
17737 n = list_find_nr(l, i++, NULL); /* fnum */
17738 if (n < 0)
17739 return FAIL;
17740 if (n == 0)
17741 n = curbuf->b_fnum; /* current buffer */
17742 *fnump = n;
17745 n = list_find_nr(l, i++, NULL); /* lnum */
17746 if (n < 0)
17747 return FAIL;
17748 posp->lnum = n;
17750 n = list_find_nr(l, i++, NULL); /* col */
17751 if (n < 0)
17752 return FAIL;
17753 posp->col = n;
17755 #ifdef FEAT_VIRTUALEDIT
17756 n = list_find_nr(l, i, NULL);
17757 if (n < 0)
17758 posp->coladd = 0;
17759 else
17760 posp->coladd = n;
17761 #endif
17763 return OK;
17767 * Get the length of an environment variable name.
17768 * Advance "arg" to the first character after the name.
17769 * Return 0 for error.
17771 static int
17772 get_env_len(arg)
17773 char_u **arg;
17775 char_u *p;
17776 int len;
17778 for (p = *arg; vim_isIDc(*p); ++p)
17780 if (p == *arg) /* no name found */
17781 return 0;
17783 len = (int)(p - *arg);
17784 *arg = p;
17785 return len;
17789 * Get the length of the name of a function or internal variable.
17790 * "arg" is advanced to the first non-white character after the name.
17791 * Return 0 if something is wrong.
17793 static int
17794 get_id_len(arg)
17795 char_u **arg;
17797 char_u *p;
17798 int len;
17800 /* Find the end of the name. */
17801 for (p = *arg; eval_isnamec(*p); ++p)
17803 if (p == *arg) /* no name found */
17804 return 0;
17806 len = (int)(p - *arg);
17807 *arg = skipwhite(p);
17809 return len;
17813 * Get the length of the name of a variable or function.
17814 * Only the name is recognized, does not handle ".key" or "[idx]".
17815 * "arg" is advanced to the first non-white character after the name.
17816 * Return -1 if curly braces expansion failed.
17817 * Return 0 if something else is wrong.
17818 * If the name contains 'magic' {}'s, expand them and return the
17819 * expanded name in an allocated string via 'alias' - caller must free.
17821 static int
17822 get_name_len(arg, alias, evaluate, verbose)
17823 char_u **arg;
17824 char_u **alias;
17825 int evaluate;
17826 int verbose;
17828 int len;
17829 char_u *p;
17830 char_u *expr_start;
17831 char_u *expr_end;
17833 *alias = NULL; /* default to no alias */
17835 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17836 && (*arg)[2] == (int)KE_SNR)
17838 /* hard coded <SNR>, already translated */
17839 *arg += 3;
17840 return get_id_len(arg) + 3;
17842 len = eval_fname_script(*arg);
17843 if (len > 0)
17845 /* literal "<SID>", "s:" or "<SNR>" */
17846 *arg += len;
17850 * Find the end of the name; check for {} construction.
17852 p = find_name_end(*arg, &expr_start, &expr_end,
17853 len > 0 ? 0 : FNE_CHECK_START);
17854 if (expr_start != NULL)
17856 char_u *temp_string;
17858 if (!evaluate)
17860 len += (int)(p - *arg);
17861 *arg = skipwhite(p);
17862 return len;
17866 * Include any <SID> etc in the expanded string:
17867 * Thus the -len here.
17869 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17870 if (temp_string == NULL)
17871 return -1;
17872 *alias = temp_string;
17873 *arg = skipwhite(p);
17874 return (int)STRLEN(temp_string);
17877 len += get_id_len(arg);
17878 if (len == 0 && verbose)
17879 EMSG2(_(e_invexpr2), *arg);
17881 return len;
17885 * Find the end of a variable or function name, taking care of magic braces.
17886 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17887 * start and end of the first magic braces item.
17888 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17889 * Return a pointer to just after the name. Equal to "arg" if there is no
17890 * valid name.
17892 static char_u *
17893 find_name_end(arg, expr_start, expr_end, flags)
17894 char_u *arg;
17895 char_u **expr_start;
17896 char_u **expr_end;
17897 int flags;
17899 int mb_nest = 0;
17900 int br_nest = 0;
17901 char_u *p;
17903 if (expr_start != NULL)
17905 *expr_start = NULL;
17906 *expr_end = NULL;
17909 /* Quick check for valid starting character. */
17910 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17911 return arg;
17913 for (p = arg; *p != NUL
17914 && (eval_isnamec(*p)
17915 || *p == '{'
17916 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17917 || mb_nest != 0
17918 || br_nest != 0); mb_ptr_adv(p))
17920 if (*p == '\'')
17922 /* skip over 'string' to avoid counting [ and ] inside it. */
17923 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17925 if (*p == NUL)
17926 break;
17928 else if (*p == '"')
17930 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17931 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17932 if (*p == '\\' && p[1] != NUL)
17933 ++p;
17934 if (*p == NUL)
17935 break;
17938 if (mb_nest == 0)
17940 if (*p == '[')
17941 ++br_nest;
17942 else if (*p == ']')
17943 --br_nest;
17946 if (br_nest == 0)
17948 if (*p == '{')
17950 mb_nest++;
17951 if (expr_start != NULL && *expr_start == NULL)
17952 *expr_start = p;
17954 else if (*p == '}')
17956 mb_nest--;
17957 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
17958 *expr_end = p;
17963 return p;
17967 * Expands out the 'magic' {}'s in a variable/function name.
17968 * Note that this can call itself recursively, to deal with
17969 * constructs like foo{bar}{baz}{bam}
17970 * The four pointer arguments point to "foo{expre}ss{ion}bar"
17971 * "in_start" ^
17972 * "expr_start" ^
17973 * "expr_end" ^
17974 * "in_end" ^
17976 * Returns a new allocated string, which the caller must free.
17977 * Returns NULL for failure.
17979 static char_u *
17980 make_expanded_name(in_start, expr_start, expr_end, in_end)
17981 char_u *in_start;
17982 char_u *expr_start;
17983 char_u *expr_end;
17984 char_u *in_end;
17986 char_u c1;
17987 char_u *retval = NULL;
17988 char_u *temp_result;
17989 char_u *nextcmd = NULL;
17991 if (expr_end == NULL || in_end == NULL)
17992 return NULL;
17993 *expr_start = NUL;
17994 *expr_end = NUL;
17995 c1 = *in_end;
17996 *in_end = NUL;
17998 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
17999 if (temp_result != NULL && nextcmd == NULL)
18001 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18002 + (in_end - expr_end) + 1));
18003 if (retval != NULL)
18005 STRCPY(retval, in_start);
18006 STRCAT(retval, temp_result);
18007 STRCAT(retval, expr_end + 1);
18010 vim_free(temp_result);
18012 *in_end = c1; /* put char back for error messages */
18013 *expr_start = '{';
18014 *expr_end = '}';
18016 if (retval != NULL)
18018 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18019 if (expr_start != NULL)
18021 /* Further expansion! */
18022 temp_result = make_expanded_name(retval, expr_start,
18023 expr_end, temp_result);
18024 vim_free(retval);
18025 retval = temp_result;
18029 return retval;
18033 * Return TRUE if character "c" can be used in a variable or function name.
18034 * Does not include '{' or '}' for magic braces.
18036 static int
18037 eval_isnamec(c)
18038 int c;
18040 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18044 * Return TRUE if character "c" can be used as the first character in a
18045 * variable or function name (excluding '{' and '}').
18047 static int
18048 eval_isnamec1(c)
18049 int c;
18051 return (ASCII_ISALPHA(c) || c == '_');
18055 * Set number v: variable to "val".
18057 void
18058 set_vim_var_nr(idx, val)
18059 int idx;
18060 long val;
18062 vimvars[idx].vv_nr = val;
18066 * Get number v: variable value.
18068 long
18069 get_vim_var_nr(idx)
18070 int idx;
18072 return vimvars[idx].vv_nr;
18076 * Get string v: variable value. Uses a static buffer, can only be used once.
18078 char_u *
18079 get_vim_var_str(idx)
18080 int idx;
18082 return get_tv_string(&vimvars[idx].vv_tv);
18086 * Get List v: variable value. Caller must take care of reference count when
18087 * needed.
18089 list_T *
18090 get_vim_var_list(idx)
18091 int idx;
18093 return vimvars[idx].vv_list;
18097 * Set v:count to "count" and v:count1 to "count1".
18098 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18100 void
18101 set_vcount(count, count1, set_prevcount)
18102 long count;
18103 long count1;
18104 int set_prevcount;
18106 if (set_prevcount)
18107 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18108 vimvars[VV_COUNT].vv_nr = count;
18109 vimvars[VV_COUNT1].vv_nr = count1;
18113 * Set string v: variable to a copy of "val".
18115 void
18116 set_vim_var_string(idx, val, len)
18117 int idx;
18118 char_u *val;
18119 int len; /* length of "val" to use or -1 (whole string) */
18121 /* Need to do this (at least) once, since we can't initialize a union.
18122 * Will always be invoked when "v:progname" is set. */
18123 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18125 vim_free(vimvars[idx].vv_str);
18126 if (val == NULL)
18127 vimvars[idx].vv_str = NULL;
18128 else if (len == -1)
18129 vimvars[idx].vv_str = vim_strsave(val);
18130 else
18131 vimvars[idx].vv_str = vim_strnsave(val, len);
18135 * Set List v: variable to "val".
18137 void
18138 set_vim_var_list(idx, val)
18139 int idx;
18140 list_T *val;
18142 list_unref(vimvars[idx].vv_list);
18143 vimvars[idx].vv_list = val;
18144 if (val != NULL)
18145 ++val->lv_refcount;
18149 * Set v:register if needed.
18151 void
18152 set_reg_var(c)
18153 int c;
18155 char_u regname;
18157 if (c == 0 || c == ' ')
18158 regname = '"';
18159 else
18160 regname = c;
18161 /* Avoid free/alloc when the value is already right. */
18162 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18163 set_vim_var_string(VV_REG, &regname, 1);
18167 * Get or set v:exception. If "oldval" == NULL, return the current value.
18168 * Otherwise, restore the value to "oldval" and return NULL.
18169 * Must always be called in pairs to save and restore v:exception! Does not
18170 * take care of memory allocations.
18172 char_u *
18173 v_exception(oldval)
18174 char_u *oldval;
18176 if (oldval == NULL)
18177 return vimvars[VV_EXCEPTION].vv_str;
18179 vimvars[VV_EXCEPTION].vv_str = oldval;
18180 return NULL;
18184 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18185 * Otherwise, restore the value to "oldval" and return NULL.
18186 * Must always be called in pairs to save and restore v:throwpoint! Does not
18187 * take care of memory allocations.
18189 char_u *
18190 v_throwpoint(oldval)
18191 char_u *oldval;
18193 if (oldval == NULL)
18194 return vimvars[VV_THROWPOINT].vv_str;
18196 vimvars[VV_THROWPOINT].vv_str = oldval;
18197 return NULL;
18200 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18202 * Set v:cmdarg.
18203 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18204 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18205 * Must always be called in pairs!
18207 char_u *
18208 set_cmdarg(eap, oldarg)
18209 exarg_T *eap;
18210 char_u *oldarg;
18212 char_u *oldval;
18213 char_u *newval;
18214 unsigned len;
18216 oldval = vimvars[VV_CMDARG].vv_str;
18217 if (eap == NULL)
18219 vim_free(oldval);
18220 vimvars[VV_CMDARG].vv_str = oldarg;
18221 return NULL;
18224 if (eap->force_bin == FORCE_BIN)
18225 len = 6;
18226 else if (eap->force_bin == FORCE_NOBIN)
18227 len = 8;
18228 else
18229 len = 0;
18231 if (eap->read_edit)
18232 len += 7;
18234 if (eap->force_ff != 0)
18235 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18236 # ifdef FEAT_MBYTE
18237 if (eap->force_enc != 0)
18238 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18239 if (eap->bad_char != 0)
18240 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18241 # endif
18243 newval = alloc(len + 1);
18244 if (newval == NULL)
18245 return NULL;
18247 if (eap->force_bin == FORCE_BIN)
18248 sprintf((char *)newval, " ++bin");
18249 else if (eap->force_bin == FORCE_NOBIN)
18250 sprintf((char *)newval, " ++nobin");
18251 else
18252 *newval = NUL;
18254 if (eap->read_edit)
18255 STRCAT(newval, " ++edit");
18257 if (eap->force_ff != 0)
18258 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18259 eap->cmd + eap->force_ff);
18260 # ifdef FEAT_MBYTE
18261 if (eap->force_enc != 0)
18262 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18263 eap->cmd + eap->force_enc);
18264 if (eap->bad_char != 0)
18265 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18266 eap->cmd + eap->bad_char);
18267 # endif
18268 vimvars[VV_CMDARG].vv_str = newval;
18269 return oldval;
18271 #endif
18274 * Get the value of internal variable "name".
18275 * Return OK or FAIL.
18277 static int
18278 get_var_tv(name, len, rettv, verbose)
18279 char_u *name;
18280 int len; /* length of "name" */
18281 typval_T *rettv; /* NULL when only checking existence */
18282 int verbose; /* may give error message */
18284 int ret = OK;
18285 typval_T *tv = NULL;
18286 typval_T atv;
18287 dictitem_T *v;
18288 int cc;
18290 /* truncate the name, so that we can use strcmp() */
18291 cc = name[len];
18292 name[len] = NUL;
18295 * Check for "b:changedtick".
18297 if (STRCMP(name, "b:changedtick") == 0)
18299 atv.v_type = VAR_NUMBER;
18300 atv.vval.v_number = curbuf->b_changedtick;
18301 tv = &atv;
18305 * Check for user-defined variables.
18307 else
18309 v = find_var(name, NULL);
18310 if (v != NULL)
18311 tv = &v->di_tv;
18314 if (tv == NULL)
18316 if (rettv != NULL && verbose)
18317 EMSG2(_(e_undefvar), name);
18318 ret = FAIL;
18320 else if (rettv != NULL)
18321 copy_tv(tv, rettv);
18323 name[len] = cc;
18325 return ret;
18329 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18330 * Also handle function call with Funcref variable: func(expr)
18331 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18333 static int
18334 handle_subscript(arg, rettv, evaluate, verbose)
18335 char_u **arg;
18336 typval_T *rettv;
18337 int evaluate; /* do more than finding the end */
18338 int verbose; /* give error messages */
18340 int ret = OK;
18341 dict_T *selfdict = NULL;
18342 char_u *s;
18343 int len;
18344 typval_T functv;
18346 while (ret == OK
18347 && (**arg == '['
18348 || (**arg == '.' && rettv->v_type == VAR_DICT)
18349 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18350 && !vim_iswhite(*(*arg - 1)))
18352 if (**arg == '(')
18354 /* need to copy the funcref so that we can clear rettv */
18355 functv = *rettv;
18356 rettv->v_type = VAR_UNKNOWN;
18358 /* Invoke the function. Recursive! */
18359 s = functv.vval.v_string;
18360 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18361 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18362 &len, evaluate, selfdict);
18364 /* Clear the funcref afterwards, so that deleting it while
18365 * evaluating the arguments is possible (see test55). */
18366 clear_tv(&functv);
18368 /* Stop the expression evaluation when immediately aborting on
18369 * error, or when an interrupt occurred or an exception was thrown
18370 * but not caught. */
18371 if (aborting())
18373 if (ret == OK)
18374 clear_tv(rettv);
18375 ret = FAIL;
18377 dict_unref(selfdict);
18378 selfdict = NULL;
18380 else /* **arg == '[' || **arg == '.' */
18382 dict_unref(selfdict);
18383 if (rettv->v_type == VAR_DICT)
18385 selfdict = rettv->vval.v_dict;
18386 if (selfdict != NULL)
18387 ++selfdict->dv_refcount;
18389 else
18390 selfdict = NULL;
18391 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18393 clear_tv(rettv);
18394 ret = FAIL;
18398 dict_unref(selfdict);
18399 return ret;
18403 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18404 * value).
18406 static typval_T *
18407 alloc_tv()
18409 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18413 * Allocate memory for a variable type-value, and assign a string to it.
18414 * The string "s" must have been allocated, it is consumed.
18415 * Return NULL for out of memory, the variable otherwise.
18417 static typval_T *
18418 alloc_string_tv(s)
18419 char_u *s;
18421 typval_T *rettv;
18423 rettv = alloc_tv();
18424 if (rettv != NULL)
18426 rettv->v_type = VAR_STRING;
18427 rettv->vval.v_string = s;
18429 else
18430 vim_free(s);
18431 return rettv;
18435 * Free the memory for a variable type-value.
18437 void
18438 free_tv(varp)
18439 typval_T *varp;
18441 if (varp != NULL)
18443 switch (varp->v_type)
18445 case VAR_FUNC:
18446 func_unref(varp->vval.v_string);
18447 /*FALLTHROUGH*/
18448 case VAR_STRING:
18449 vim_free(varp->vval.v_string);
18450 break;
18451 case VAR_LIST:
18452 list_unref(varp->vval.v_list);
18453 break;
18454 case VAR_DICT:
18455 dict_unref(varp->vval.v_dict);
18456 break;
18457 case VAR_NUMBER:
18458 #ifdef FEAT_FLOAT
18459 case VAR_FLOAT:
18460 #endif
18461 case VAR_UNKNOWN:
18462 break;
18463 default:
18464 EMSG2(_(e_intern2), "free_tv()");
18465 break;
18467 vim_free(varp);
18472 * Free the memory for a variable value and set the value to NULL or 0.
18474 void
18475 clear_tv(varp)
18476 typval_T *varp;
18478 if (varp != NULL)
18480 switch (varp->v_type)
18482 case VAR_FUNC:
18483 func_unref(varp->vval.v_string);
18484 /*FALLTHROUGH*/
18485 case VAR_STRING:
18486 vim_free(varp->vval.v_string);
18487 varp->vval.v_string = NULL;
18488 break;
18489 case VAR_LIST:
18490 list_unref(varp->vval.v_list);
18491 varp->vval.v_list = NULL;
18492 break;
18493 case VAR_DICT:
18494 dict_unref(varp->vval.v_dict);
18495 varp->vval.v_dict = NULL;
18496 break;
18497 case VAR_NUMBER:
18498 varp->vval.v_number = 0;
18499 break;
18500 #ifdef FEAT_FLOAT
18501 case VAR_FLOAT:
18502 varp->vval.v_float = 0.0;
18503 break;
18504 #endif
18505 case VAR_UNKNOWN:
18506 break;
18507 default:
18508 EMSG2(_(e_intern2), "clear_tv()");
18510 varp->v_lock = 0;
18515 * Set the value of a variable to NULL without freeing items.
18517 static void
18518 init_tv(varp)
18519 typval_T *varp;
18521 if (varp != NULL)
18522 vim_memset(varp, 0, sizeof(typval_T));
18526 * Get the number value of a variable.
18527 * If it is a String variable, uses vim_str2nr().
18528 * For incompatible types, return 0.
18529 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18530 * caller of incompatible types: it sets *denote to TRUE if "denote"
18531 * is not NULL or returns -1 otherwise.
18533 static long
18534 get_tv_number(varp)
18535 typval_T *varp;
18537 int error = FALSE;
18539 return get_tv_number_chk(varp, &error); /* return 0L on error */
18542 long
18543 get_tv_number_chk(varp, denote)
18544 typval_T *varp;
18545 int *denote;
18547 long n = 0L;
18549 switch (varp->v_type)
18551 case VAR_NUMBER:
18552 return (long)(varp->vval.v_number);
18553 #ifdef FEAT_FLOAT
18554 case VAR_FLOAT:
18555 EMSG(_("E805: Using a Float as a Number"));
18556 break;
18557 #endif
18558 case VAR_FUNC:
18559 EMSG(_("E703: Using a Funcref as a Number"));
18560 break;
18561 case VAR_STRING:
18562 if (varp->vval.v_string != NULL)
18563 vim_str2nr(varp->vval.v_string, NULL, NULL,
18564 TRUE, TRUE, &n, NULL);
18565 return n;
18566 case VAR_LIST:
18567 EMSG(_("E745: Using a List as a Number"));
18568 break;
18569 case VAR_DICT:
18570 EMSG(_("E728: Using a Dictionary as a Number"));
18571 break;
18572 default:
18573 EMSG2(_(e_intern2), "get_tv_number()");
18574 break;
18576 if (denote == NULL) /* useful for values that must be unsigned */
18577 n = -1;
18578 else
18579 *denote = TRUE;
18580 return n;
18584 * Get the lnum from the first argument.
18585 * Also accepts ".", "$", etc., but that only works for the current buffer.
18586 * Returns -1 on error.
18588 static linenr_T
18589 get_tv_lnum(argvars)
18590 typval_T *argvars;
18592 typval_T rettv;
18593 linenr_T lnum;
18595 lnum = get_tv_number_chk(&argvars[0], NULL);
18596 if (lnum == 0) /* no valid number, try using line() */
18598 rettv.v_type = VAR_NUMBER;
18599 f_line(argvars, &rettv);
18600 lnum = rettv.vval.v_number;
18601 clear_tv(&rettv);
18603 return lnum;
18607 * Get the lnum from the first argument.
18608 * Also accepts "$", then "buf" is used.
18609 * Returns 0 on error.
18611 static linenr_T
18612 get_tv_lnum_buf(argvars, buf)
18613 typval_T *argvars;
18614 buf_T *buf;
18616 if (argvars[0].v_type == VAR_STRING
18617 && argvars[0].vval.v_string != NULL
18618 && argvars[0].vval.v_string[0] == '$'
18619 && buf != NULL)
18620 return buf->b_ml.ml_line_count;
18621 return get_tv_number_chk(&argvars[0], NULL);
18625 * Get the string value of a variable.
18626 * If it is a Number variable, the number is converted into a string.
18627 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18628 * get_tv_string_buf() uses a given buffer.
18629 * If the String variable has never been set, return an empty string.
18630 * Never returns NULL;
18631 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18632 * NULL on error.
18634 static char_u *
18635 get_tv_string(varp)
18636 typval_T *varp;
18638 static char_u mybuf[NUMBUFLEN];
18640 return get_tv_string_buf(varp, mybuf);
18643 static char_u *
18644 get_tv_string_buf(varp, buf)
18645 typval_T *varp;
18646 char_u *buf;
18648 char_u *res = get_tv_string_buf_chk(varp, buf);
18650 return res != NULL ? res : (char_u *)"";
18653 char_u *
18654 get_tv_string_chk(varp)
18655 typval_T *varp;
18657 static char_u mybuf[NUMBUFLEN];
18659 return get_tv_string_buf_chk(varp, mybuf);
18662 static char_u *
18663 get_tv_string_buf_chk(varp, buf)
18664 typval_T *varp;
18665 char_u *buf;
18667 switch (varp->v_type)
18669 case VAR_NUMBER:
18670 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18671 return buf;
18672 case VAR_FUNC:
18673 EMSG(_("E729: using Funcref as a String"));
18674 break;
18675 case VAR_LIST:
18676 EMSG(_("E730: using List as a String"));
18677 break;
18678 case VAR_DICT:
18679 EMSG(_("E731: using Dictionary as a String"));
18680 break;
18681 #ifdef FEAT_FLOAT
18682 case VAR_FLOAT:
18683 EMSG(_("E806: using Float as a String"));
18684 break;
18685 #endif
18686 case VAR_STRING:
18687 if (varp->vval.v_string != NULL)
18688 return varp->vval.v_string;
18689 return (char_u *)"";
18690 default:
18691 EMSG2(_(e_intern2), "get_tv_string_buf()");
18692 break;
18694 return NULL;
18698 * Find variable "name" in the list of variables.
18699 * Return a pointer to it if found, NULL if not found.
18700 * Careful: "a:0" variables don't have a name.
18701 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18702 * hashtab_T used.
18704 static dictitem_T *
18705 find_var(name, htp)
18706 char_u *name;
18707 hashtab_T **htp;
18709 char_u *varname;
18710 hashtab_T *ht;
18712 ht = find_var_ht(name, &varname);
18713 if (htp != NULL)
18714 *htp = ht;
18715 if (ht == NULL)
18716 return NULL;
18717 return find_var_in_ht(ht, varname, htp != NULL);
18721 * Find variable "varname" in hashtab "ht".
18722 * Returns NULL if not found.
18724 static dictitem_T *
18725 find_var_in_ht(ht, varname, writing)
18726 hashtab_T *ht;
18727 char_u *varname;
18728 int writing;
18730 hashitem_T *hi;
18732 if (*varname == NUL)
18734 /* Must be something like "s:", otherwise "ht" would be NULL. */
18735 switch (varname[-2])
18737 case 's': return &SCRIPT_SV(current_SID).sv_var;
18738 case 'g': return &globvars_var;
18739 case 'v': return &vimvars_var;
18740 case 'b': return &curbuf->b_bufvar;
18741 case 'w': return &curwin->w_winvar;
18742 #ifdef FEAT_WINDOWS
18743 case 't': return &curtab->tp_winvar;
18744 #endif
18745 case 'l': return current_funccal == NULL
18746 ? NULL : &current_funccal->l_vars_var;
18747 case 'a': return current_funccal == NULL
18748 ? NULL : &current_funccal->l_avars_var;
18750 return NULL;
18753 hi = hash_find(ht, varname);
18754 if (HASHITEM_EMPTY(hi))
18756 /* For global variables we may try auto-loading the script. If it
18757 * worked find the variable again. Don't auto-load a script if it was
18758 * loaded already, otherwise it would be loaded every time when
18759 * checking if a function name is a Funcref variable. */
18760 if (ht == &globvarht && !writing
18761 && script_autoload(varname, FALSE) && !aborting())
18762 hi = hash_find(ht, varname);
18763 if (HASHITEM_EMPTY(hi))
18764 return NULL;
18766 return HI2DI(hi);
18770 * Find the hashtab used for a variable name.
18771 * Set "varname" to the start of name without ':'.
18773 static hashtab_T *
18774 find_var_ht(name, varname)
18775 char_u *name;
18776 char_u **varname;
18778 hashitem_T *hi;
18780 if (name[1] != ':')
18782 /* The name must not start with a colon or #. */
18783 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18784 return NULL;
18785 *varname = name;
18787 /* "version" is "v:version" in all scopes */
18788 hi = hash_find(&compat_hashtab, name);
18789 if (!HASHITEM_EMPTY(hi))
18790 return &compat_hashtab;
18792 if (current_funccal == NULL)
18793 return &globvarht; /* global variable */
18794 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18796 *varname = name + 2;
18797 if (*name == 'g') /* global variable */
18798 return &globvarht;
18799 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18801 if (vim_strchr(name + 2, ':') != NULL
18802 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18803 return NULL;
18804 if (*name == 'b') /* buffer variable */
18805 return &curbuf->b_vars.dv_hashtab;
18806 if (*name == 'w') /* window variable */
18807 return &curwin->w_vars.dv_hashtab;
18808 #ifdef FEAT_WINDOWS
18809 if (*name == 't') /* tab page variable */
18810 return &curtab->tp_vars.dv_hashtab;
18811 #endif
18812 if (*name == 'v') /* v: variable */
18813 return &vimvarht;
18814 if (*name == 'a' && current_funccal != NULL) /* function argument */
18815 return &current_funccal->l_avars.dv_hashtab;
18816 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18817 return &current_funccal->l_vars.dv_hashtab;
18818 if (*name == 's' /* script variable */
18819 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18820 return &SCRIPT_VARS(current_SID);
18821 return NULL;
18825 * Get the string value of a (global/local) variable.
18826 * Returns NULL when it doesn't exist.
18828 char_u *
18829 get_var_value(name)
18830 char_u *name;
18832 dictitem_T *v;
18834 v = find_var(name, NULL);
18835 if (v == NULL)
18836 return NULL;
18837 return get_tv_string(&v->di_tv);
18841 * Allocate a new hashtab for a sourced script. It will be used while
18842 * sourcing this script and when executing functions defined in the script.
18844 void
18845 new_script_vars(id)
18846 scid_T id;
18848 int i;
18849 hashtab_T *ht;
18850 scriptvar_T *sv;
18852 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18854 /* Re-allocating ga_data means that an ht_array pointing to
18855 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18856 * at its init value. Also reset "v_dict", it's always the same. */
18857 for (i = 1; i <= ga_scripts.ga_len; ++i)
18859 ht = &SCRIPT_VARS(i);
18860 if (ht->ht_mask == HT_INIT_SIZE - 1)
18861 ht->ht_array = ht->ht_smallarray;
18862 sv = &SCRIPT_SV(i);
18863 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18866 while (ga_scripts.ga_len < id)
18868 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18869 init_var_dict(&sv->sv_dict, &sv->sv_var);
18870 ++ga_scripts.ga_len;
18876 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18877 * point to it.
18879 void
18880 init_var_dict(dict, dict_var)
18881 dict_T *dict;
18882 dictitem_T *dict_var;
18884 hash_init(&dict->dv_hashtab);
18885 dict->dv_refcount = DO_NOT_FREE_CNT;
18886 dict->dv_copyID = 0;
18887 dict_var->di_tv.vval.v_dict = dict;
18888 dict_var->di_tv.v_type = VAR_DICT;
18889 dict_var->di_tv.v_lock = VAR_FIXED;
18890 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18891 dict_var->di_key[0] = NUL;
18895 * Clean up a list of internal variables.
18896 * Frees all allocated variables and the value they contain.
18897 * Clears hashtab "ht", does not free it.
18899 void
18900 vars_clear(ht)
18901 hashtab_T *ht;
18903 vars_clear_ext(ht, TRUE);
18907 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18909 static void
18910 vars_clear_ext(ht, free_val)
18911 hashtab_T *ht;
18912 int free_val;
18914 int todo;
18915 hashitem_T *hi;
18916 dictitem_T *v;
18918 hash_lock(ht);
18919 todo = (int)ht->ht_used;
18920 for (hi = ht->ht_array; todo > 0; ++hi)
18922 if (!HASHITEM_EMPTY(hi))
18924 --todo;
18926 /* Free the variable. Don't remove it from the hashtab,
18927 * ht_array might change then. hash_clear() takes care of it
18928 * later. */
18929 v = HI2DI(hi);
18930 if (free_val)
18931 clear_tv(&v->di_tv);
18932 if ((v->di_flags & DI_FLAGS_FIX) == 0)
18933 vim_free(v);
18936 hash_clear(ht);
18937 ht->ht_used = 0;
18941 * Delete a variable from hashtab "ht" at item "hi".
18942 * Clear the variable value and free the dictitem.
18944 static void
18945 delete_var(ht, hi)
18946 hashtab_T *ht;
18947 hashitem_T *hi;
18949 dictitem_T *di = HI2DI(hi);
18951 hash_remove(ht, hi);
18952 clear_tv(&di->di_tv);
18953 vim_free(di);
18957 * List the value of one internal variable.
18959 static void
18960 list_one_var(v, prefix, first)
18961 dictitem_T *v;
18962 char_u *prefix;
18963 int *first;
18965 char_u *tofree;
18966 char_u *s;
18967 char_u numbuf[NUMBUFLEN];
18969 s = echo_string(&v->di_tv, &tofree, numbuf, ++current_copyID);
18970 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
18971 s == NULL ? (char_u *)"" : s, first);
18972 vim_free(tofree);
18975 static void
18976 list_one_var_a(prefix, name, type, string, first)
18977 char_u *prefix;
18978 char_u *name;
18979 int type;
18980 char_u *string;
18981 int *first; /* when TRUE clear rest of screen and set to FALSE */
18983 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
18984 msg_start();
18985 msg_puts(prefix);
18986 if (name != NULL) /* "a:" vars don't have a name stored */
18987 msg_puts(name);
18988 msg_putchar(' ');
18989 msg_advance(22);
18990 if (type == VAR_NUMBER)
18991 msg_putchar('#');
18992 else if (type == VAR_FUNC)
18993 msg_putchar('*');
18994 else if (type == VAR_LIST)
18996 msg_putchar('[');
18997 if (*string == '[')
18998 ++string;
19000 else if (type == VAR_DICT)
19002 msg_putchar('{');
19003 if (*string == '{')
19004 ++string;
19006 else
19007 msg_putchar(' ');
19009 msg_outtrans(string);
19011 if (type == VAR_FUNC)
19012 msg_puts((char_u *)"()");
19013 if (*first)
19015 msg_clr_eos();
19016 *first = FALSE;
19021 * Set variable "name" to value in "tv".
19022 * If the variable already exists, the value is updated.
19023 * Otherwise the variable is created.
19025 static void
19026 set_var(name, tv, copy)
19027 char_u *name;
19028 typval_T *tv;
19029 int copy; /* make copy of value in "tv" */
19031 dictitem_T *v;
19032 char_u *varname;
19033 hashtab_T *ht;
19034 char_u *p;
19036 if (tv->v_type == VAR_FUNC)
19038 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19039 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19040 ? name[2] : name[0]))
19042 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19043 return;
19045 if (function_exists(name))
19047 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19048 name);
19049 return;
19053 ht = find_var_ht(name, &varname);
19054 if (ht == NULL || *varname == NUL)
19056 EMSG2(_(e_illvar), name);
19057 return;
19060 v = find_var_in_ht(ht, varname, TRUE);
19061 if (v != NULL)
19063 /* existing variable, need to clear the value */
19064 if (var_check_ro(v->di_flags, name)
19065 || tv_check_lock(v->di_tv.v_lock, name))
19066 return;
19067 if (v->di_tv.v_type != tv->v_type
19068 && !((v->di_tv.v_type == VAR_STRING
19069 || v->di_tv.v_type == VAR_NUMBER)
19070 && (tv->v_type == VAR_STRING
19071 || tv->v_type == VAR_NUMBER))
19072 #ifdef FEAT_FLOAT
19073 && !((v->di_tv.v_type == VAR_NUMBER
19074 || v->di_tv.v_type == VAR_FLOAT)
19075 && (tv->v_type == VAR_NUMBER
19076 || tv->v_type == VAR_FLOAT))
19077 #endif
19080 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19081 return;
19085 * Handle setting internal v: variables separately: we don't change
19086 * the type.
19088 if (ht == &vimvarht)
19090 if (v->di_tv.v_type == VAR_STRING)
19092 vim_free(v->di_tv.vval.v_string);
19093 if (copy || tv->v_type != VAR_STRING)
19094 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19095 else
19097 /* Take over the string to avoid an extra alloc/free. */
19098 v->di_tv.vval.v_string = tv->vval.v_string;
19099 tv->vval.v_string = NULL;
19102 else if (v->di_tv.v_type != VAR_NUMBER)
19103 EMSG2(_(e_intern2), "set_var()");
19104 else
19106 v->di_tv.vval.v_number = get_tv_number(tv);
19107 if (STRCMP(varname, "searchforward") == 0)
19108 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19110 return;
19113 clear_tv(&v->di_tv);
19115 else /* add a new variable */
19117 /* Can't add "v:" variable. */
19118 if (ht == &vimvarht)
19120 EMSG2(_(e_illvar), name);
19121 return;
19124 /* Make sure the variable name is valid. */
19125 for (p = varname; *p != NUL; ++p)
19126 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19127 && *p != AUTOLOAD_CHAR)
19129 EMSG2(_(e_illvar), varname);
19130 return;
19133 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19134 + STRLEN(varname)));
19135 if (v == NULL)
19136 return;
19137 STRCPY(v->di_key, varname);
19138 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19140 vim_free(v);
19141 return;
19143 v->di_flags = 0;
19146 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19147 copy_tv(tv, &v->di_tv);
19148 else
19150 v->di_tv = *tv;
19151 v->di_tv.v_lock = 0;
19152 init_tv(tv);
19157 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19158 * Also give an error message.
19160 static int
19161 var_check_ro(flags, name)
19162 int flags;
19163 char_u *name;
19165 if (flags & DI_FLAGS_RO)
19167 EMSG2(_(e_readonlyvar), name);
19168 return TRUE;
19170 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19172 EMSG2(_(e_readonlysbx), name);
19173 return TRUE;
19175 return FALSE;
19179 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19180 * Also give an error message.
19182 static int
19183 var_check_fixed(flags, name)
19184 int flags;
19185 char_u *name;
19187 if (flags & DI_FLAGS_FIX)
19189 EMSG2(_("E795: Cannot delete variable %s"), name);
19190 return TRUE;
19192 return FALSE;
19196 * Return TRUE if typeval "tv" is set to be locked (immutable).
19197 * Also give an error message, using "name".
19199 static int
19200 tv_check_lock(lock, name)
19201 int lock;
19202 char_u *name;
19204 if (lock & VAR_LOCKED)
19206 EMSG2(_("E741: Value is locked: %s"),
19207 name == NULL ? (char_u *)_("Unknown") : name);
19208 return TRUE;
19210 if (lock & VAR_FIXED)
19212 EMSG2(_("E742: Cannot change value of %s"),
19213 name == NULL ? (char_u *)_("Unknown") : name);
19214 return TRUE;
19216 return FALSE;
19220 * Copy the values from typval_T "from" to typval_T "to".
19221 * When needed allocates string or increases reference count.
19222 * Does not make a copy of a list or dict but copies the reference!
19223 * It is OK for "from" and "to" to point to the same item. This is used to
19224 * make a copy later.
19226 static void
19227 copy_tv(from, to)
19228 typval_T *from;
19229 typval_T *to;
19231 to->v_type = from->v_type;
19232 to->v_lock = 0;
19233 switch (from->v_type)
19235 case VAR_NUMBER:
19236 to->vval.v_number = from->vval.v_number;
19237 break;
19238 #ifdef FEAT_FLOAT
19239 case VAR_FLOAT:
19240 to->vval.v_float = from->vval.v_float;
19241 break;
19242 #endif
19243 case VAR_STRING:
19244 case VAR_FUNC:
19245 if (from->vval.v_string == NULL)
19246 to->vval.v_string = NULL;
19247 else
19249 to->vval.v_string = vim_strsave(from->vval.v_string);
19250 if (from->v_type == VAR_FUNC)
19251 func_ref(to->vval.v_string);
19253 break;
19254 case VAR_LIST:
19255 if (from->vval.v_list == NULL)
19256 to->vval.v_list = NULL;
19257 else
19259 to->vval.v_list = from->vval.v_list;
19260 ++to->vval.v_list->lv_refcount;
19262 break;
19263 case VAR_DICT:
19264 if (from->vval.v_dict == NULL)
19265 to->vval.v_dict = NULL;
19266 else
19268 to->vval.v_dict = from->vval.v_dict;
19269 ++to->vval.v_dict->dv_refcount;
19271 break;
19272 default:
19273 EMSG2(_(e_intern2), "copy_tv()");
19274 break;
19279 * Make a copy of an item.
19280 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19281 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19282 * reference to an already copied list/dict can be used.
19283 * Returns FAIL or OK.
19285 static int
19286 item_copy(from, to, deep, copyID)
19287 typval_T *from;
19288 typval_T *to;
19289 int deep;
19290 int copyID;
19292 static int recurse = 0;
19293 int ret = OK;
19295 if (recurse >= DICT_MAXNEST)
19297 EMSG(_("E698: variable nested too deep for making a copy"));
19298 return FAIL;
19300 ++recurse;
19302 switch (from->v_type)
19304 case VAR_NUMBER:
19305 #ifdef FEAT_FLOAT
19306 case VAR_FLOAT:
19307 #endif
19308 case VAR_STRING:
19309 case VAR_FUNC:
19310 copy_tv(from, to);
19311 break;
19312 case VAR_LIST:
19313 to->v_type = VAR_LIST;
19314 to->v_lock = 0;
19315 if (from->vval.v_list == NULL)
19316 to->vval.v_list = NULL;
19317 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19319 /* use the copy made earlier */
19320 to->vval.v_list = from->vval.v_list->lv_copylist;
19321 ++to->vval.v_list->lv_refcount;
19323 else
19324 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19325 if (to->vval.v_list == NULL)
19326 ret = FAIL;
19327 break;
19328 case VAR_DICT:
19329 to->v_type = VAR_DICT;
19330 to->v_lock = 0;
19331 if (from->vval.v_dict == NULL)
19332 to->vval.v_dict = NULL;
19333 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19335 /* use the copy made earlier */
19336 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19337 ++to->vval.v_dict->dv_refcount;
19339 else
19340 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19341 if (to->vval.v_dict == NULL)
19342 ret = FAIL;
19343 break;
19344 default:
19345 EMSG2(_(e_intern2), "item_copy()");
19346 ret = FAIL;
19348 --recurse;
19349 return ret;
19353 * ":echo expr1 ..." print each argument separated with a space, add a
19354 * newline at the end.
19355 * ":echon expr1 ..." print each argument plain.
19357 void
19358 ex_echo(eap)
19359 exarg_T *eap;
19361 char_u *arg = eap->arg;
19362 typval_T rettv;
19363 char_u *tofree;
19364 char_u *p;
19365 int needclr = TRUE;
19366 int atstart = TRUE;
19367 char_u numbuf[NUMBUFLEN];
19369 if (eap->skip)
19370 ++emsg_skip;
19371 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19373 /* If eval1() causes an error message the text from the command may
19374 * still need to be cleared. E.g., "echo 22,44". */
19375 need_clr_eos = needclr;
19377 p = arg;
19378 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19381 * Report the invalid expression unless the expression evaluation
19382 * has been cancelled due to an aborting error, an interrupt, or an
19383 * exception.
19385 if (!aborting())
19386 EMSG2(_(e_invexpr2), p);
19387 need_clr_eos = FALSE;
19388 break;
19390 need_clr_eos = FALSE;
19392 if (!eap->skip)
19394 if (atstart)
19396 atstart = FALSE;
19397 /* Call msg_start() after eval1(), evaluating the expression
19398 * may cause a message to appear. */
19399 if (eap->cmdidx == CMD_echo)
19400 msg_start();
19402 else if (eap->cmdidx == CMD_echo)
19403 msg_puts_attr((char_u *)" ", echo_attr);
19404 p = echo_string(&rettv, &tofree, numbuf, ++current_copyID);
19405 if (p != NULL)
19406 for ( ; *p != NUL && !got_int; ++p)
19408 if (*p == '\n' || *p == '\r' || *p == TAB)
19410 if (*p != TAB && needclr)
19412 /* remove any text still there from the command */
19413 msg_clr_eos();
19414 needclr = FALSE;
19416 msg_putchar_attr(*p, echo_attr);
19418 else
19420 #ifdef FEAT_MBYTE
19421 if (has_mbyte)
19423 int i = (*mb_ptr2len)(p);
19425 (void)msg_outtrans_len_attr(p, i, echo_attr);
19426 p += i - 1;
19428 else
19429 #endif
19430 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19433 vim_free(tofree);
19435 clear_tv(&rettv);
19436 arg = skipwhite(arg);
19438 eap->nextcmd = check_nextcmd(arg);
19440 if (eap->skip)
19441 --emsg_skip;
19442 else
19444 /* remove text that may still be there from the command */
19445 if (needclr)
19446 msg_clr_eos();
19447 if (eap->cmdidx == CMD_echo)
19448 msg_end();
19453 * ":echohl {name}".
19455 void
19456 ex_echohl(eap)
19457 exarg_T *eap;
19459 int id;
19461 id = syn_name2id(eap->arg);
19462 if (id == 0)
19463 echo_attr = 0;
19464 else
19465 echo_attr = syn_id2attr(id);
19469 * ":execute expr1 ..." execute the result of an expression.
19470 * ":echomsg expr1 ..." Print a message
19471 * ":echoerr expr1 ..." Print an error
19472 * Each gets spaces around each argument and a newline at the end for
19473 * echo commands
19475 void
19476 ex_execute(eap)
19477 exarg_T *eap;
19479 char_u *arg = eap->arg;
19480 typval_T rettv;
19481 int ret = OK;
19482 char_u *p;
19483 garray_T ga;
19484 int len;
19485 int save_did_emsg;
19487 ga_init2(&ga, 1, 80);
19489 if (eap->skip)
19490 ++emsg_skip;
19491 while (*arg != NUL && *arg != '|' && *arg != '\n')
19493 p = arg;
19494 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19497 * Report the invalid expression unless the expression evaluation
19498 * has been cancelled due to an aborting error, an interrupt, or an
19499 * exception.
19501 if (!aborting())
19502 EMSG2(_(e_invexpr2), p);
19503 ret = FAIL;
19504 break;
19507 if (!eap->skip)
19509 p = get_tv_string(&rettv);
19510 len = (int)STRLEN(p);
19511 if (ga_grow(&ga, len + 2) == FAIL)
19513 clear_tv(&rettv);
19514 ret = FAIL;
19515 break;
19517 if (ga.ga_len)
19518 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19519 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19520 ga.ga_len += len;
19523 clear_tv(&rettv);
19524 arg = skipwhite(arg);
19527 if (ret != FAIL && ga.ga_data != NULL)
19529 if (eap->cmdidx == CMD_echomsg)
19531 MSG_ATTR(ga.ga_data, echo_attr);
19532 out_flush();
19534 else if (eap->cmdidx == CMD_echoerr)
19536 /* We don't want to abort following commands, restore did_emsg. */
19537 save_did_emsg = did_emsg;
19538 EMSG((char_u *)ga.ga_data);
19539 if (!force_abort)
19540 did_emsg = save_did_emsg;
19542 else if (eap->cmdidx == CMD_execute)
19543 do_cmdline((char_u *)ga.ga_data,
19544 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19547 ga_clear(&ga);
19549 if (eap->skip)
19550 --emsg_skip;
19552 eap->nextcmd = check_nextcmd(arg);
19556 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19557 * "arg" points to the "&" or '+' when called, to "option" when returning.
19558 * Returns NULL when no option name found. Otherwise pointer to the char
19559 * after the option name.
19561 static char_u *
19562 find_option_end(arg, opt_flags)
19563 char_u **arg;
19564 int *opt_flags;
19566 char_u *p = *arg;
19568 ++p;
19569 if (*p == 'g' && p[1] == ':')
19571 *opt_flags = OPT_GLOBAL;
19572 p += 2;
19574 else if (*p == 'l' && p[1] == ':')
19576 *opt_flags = OPT_LOCAL;
19577 p += 2;
19579 else
19580 *opt_flags = 0;
19582 if (!ASCII_ISALPHA(*p))
19583 return NULL;
19584 *arg = p;
19586 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19587 p += 4; /* termcap option */
19588 else
19589 while (ASCII_ISALPHA(*p))
19590 ++p;
19591 return p;
19595 * ":function"
19597 void
19598 ex_function(eap)
19599 exarg_T *eap;
19601 char_u *theline;
19602 int j;
19603 int c;
19604 int saved_did_emsg;
19605 char_u *name = NULL;
19606 char_u *p;
19607 char_u *arg;
19608 char_u *line_arg = NULL;
19609 garray_T newargs;
19610 garray_T newlines;
19611 int varargs = FALSE;
19612 int mustend = FALSE;
19613 int flags = 0;
19614 ufunc_T *fp;
19615 int indent;
19616 int nesting;
19617 char_u *skip_until = NULL;
19618 dictitem_T *v;
19619 funcdict_T fudi;
19620 static int func_nr = 0; /* number for nameless function */
19621 int paren;
19622 hashtab_T *ht;
19623 int todo;
19624 hashitem_T *hi;
19625 int sourcing_lnum_off;
19628 * ":function" without argument: list functions.
19630 if (ends_excmd(*eap->arg))
19632 if (!eap->skip)
19634 todo = (int)func_hashtab.ht_used;
19635 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19637 if (!HASHITEM_EMPTY(hi))
19639 --todo;
19640 fp = HI2UF(hi);
19641 if (!isdigit(*fp->uf_name))
19642 list_func_head(fp, FALSE);
19646 eap->nextcmd = check_nextcmd(eap->arg);
19647 return;
19651 * ":function /pat": list functions matching pattern.
19653 if (*eap->arg == '/')
19655 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19656 if (!eap->skip)
19658 regmatch_T regmatch;
19660 c = *p;
19661 *p = NUL;
19662 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19663 *p = c;
19664 if (regmatch.regprog != NULL)
19666 regmatch.rm_ic = p_ic;
19668 todo = (int)func_hashtab.ht_used;
19669 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19671 if (!HASHITEM_EMPTY(hi))
19673 --todo;
19674 fp = HI2UF(hi);
19675 if (!isdigit(*fp->uf_name)
19676 && vim_regexec(&regmatch, fp->uf_name, 0))
19677 list_func_head(fp, FALSE);
19680 vim_free(regmatch.regprog);
19683 if (*p == '/')
19684 ++p;
19685 eap->nextcmd = check_nextcmd(p);
19686 return;
19690 * Get the function name. There are these situations:
19691 * func normal function name
19692 * "name" == func, "fudi.fd_dict" == NULL
19693 * dict.func new dictionary entry
19694 * "name" == NULL, "fudi.fd_dict" set,
19695 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19696 * dict.func existing dict entry with a Funcref
19697 * "name" == func, "fudi.fd_dict" set,
19698 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19699 * dict.func existing dict entry that's not a Funcref
19700 * "name" == NULL, "fudi.fd_dict" set,
19701 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19703 p = eap->arg;
19704 name = trans_function_name(&p, eap->skip, 0, &fudi);
19705 paren = (vim_strchr(p, '(') != NULL);
19706 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19709 * Return on an invalid expression in braces, unless the expression
19710 * evaluation has been cancelled due to an aborting error, an
19711 * interrupt, or an exception.
19713 if (!aborting())
19715 if (!eap->skip && fudi.fd_newkey != NULL)
19716 EMSG2(_(e_dictkey), fudi.fd_newkey);
19717 vim_free(fudi.fd_newkey);
19718 return;
19720 else
19721 eap->skip = TRUE;
19724 /* An error in a function call during evaluation of an expression in magic
19725 * braces should not cause the function not to be defined. */
19726 saved_did_emsg = did_emsg;
19727 did_emsg = FALSE;
19730 * ":function func" with only function name: list function.
19732 if (!paren)
19734 if (!ends_excmd(*skipwhite(p)))
19736 EMSG(_(e_trailing));
19737 goto ret_free;
19739 eap->nextcmd = check_nextcmd(p);
19740 if (eap->nextcmd != NULL)
19741 *p = NUL;
19742 if (!eap->skip && !got_int)
19744 fp = find_func(name);
19745 if (fp != NULL)
19747 list_func_head(fp, TRUE);
19748 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19750 if (FUNCLINE(fp, j) == NULL)
19751 continue;
19752 msg_putchar('\n');
19753 msg_outnum((long)(j + 1));
19754 if (j < 9)
19755 msg_putchar(' ');
19756 if (j < 99)
19757 msg_putchar(' ');
19758 msg_prt_line(FUNCLINE(fp, j), FALSE);
19759 out_flush(); /* show a line at a time */
19760 ui_breakcheck();
19762 if (!got_int)
19764 msg_putchar('\n');
19765 msg_puts((char_u *)" endfunction");
19768 else
19769 emsg_funcname(N_("E123: Undefined function: %s"), name);
19771 goto ret_free;
19775 * ":function name(arg1, arg2)" Define function.
19777 p = skipwhite(p);
19778 if (*p != '(')
19780 if (!eap->skip)
19782 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19783 goto ret_free;
19785 /* attempt to continue by skipping some text */
19786 if (vim_strchr(p, '(') != NULL)
19787 p = vim_strchr(p, '(');
19789 p = skipwhite(p + 1);
19791 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19792 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19794 if (!eap->skip)
19796 /* Check the name of the function. Unless it's a dictionary function
19797 * (that we are overwriting). */
19798 if (name != NULL)
19799 arg = name;
19800 else
19801 arg = fudi.fd_newkey;
19802 if (arg != NULL && (fudi.fd_di == NULL
19803 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19805 if (*arg == K_SPECIAL)
19806 j = 3;
19807 else
19808 j = 0;
19809 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19810 : eval_isnamec(arg[j])))
19811 ++j;
19812 if (arg[j] != NUL)
19813 emsg_funcname((char *)e_invarg2, arg);
19818 * Isolate the arguments: "arg1, arg2, ...)"
19820 while (*p != ')')
19822 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19824 varargs = TRUE;
19825 p += 3;
19826 mustend = TRUE;
19828 else
19830 arg = p;
19831 while (ASCII_ISALNUM(*p) || *p == '_')
19832 ++p;
19833 if (arg == p || isdigit(*arg)
19834 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19835 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19837 if (!eap->skip)
19838 EMSG2(_("E125: Illegal argument: %s"), arg);
19839 break;
19841 if (ga_grow(&newargs, 1) == FAIL)
19842 goto erret;
19843 c = *p;
19844 *p = NUL;
19845 arg = vim_strsave(arg);
19846 if (arg == NULL)
19847 goto erret;
19848 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19849 *p = c;
19850 newargs.ga_len++;
19851 if (*p == ',')
19852 ++p;
19853 else
19854 mustend = TRUE;
19856 p = skipwhite(p);
19857 if (mustend && *p != ')')
19859 if (!eap->skip)
19860 EMSG2(_(e_invarg2), eap->arg);
19861 break;
19864 ++p; /* skip the ')' */
19866 /* find extra arguments "range", "dict" and "abort" */
19867 for (;;)
19869 p = skipwhite(p);
19870 if (STRNCMP(p, "range", 5) == 0)
19872 flags |= FC_RANGE;
19873 p += 5;
19875 else if (STRNCMP(p, "dict", 4) == 0)
19877 flags |= FC_DICT;
19878 p += 4;
19880 else if (STRNCMP(p, "abort", 5) == 0)
19882 flags |= FC_ABORT;
19883 p += 5;
19885 else
19886 break;
19889 /* When there is a line break use what follows for the function body.
19890 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19891 if (*p == '\n')
19892 line_arg = p + 1;
19893 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19894 EMSG(_(e_trailing));
19897 * Read the body of the function, until ":endfunction" is found.
19899 if (KeyTyped)
19901 /* Check if the function already exists, don't let the user type the
19902 * whole function before telling him it doesn't work! For a script we
19903 * need to skip the body to be able to find what follows. */
19904 if (!eap->skip && !eap->forceit)
19906 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19907 EMSG(_(e_funcdict));
19908 else if (name != NULL && find_func(name) != NULL)
19909 emsg_funcname(e_funcexts, name);
19912 if (!eap->skip && did_emsg)
19913 goto erret;
19915 msg_putchar('\n'); /* don't overwrite the function name */
19916 cmdline_row = msg_row;
19919 indent = 2;
19920 nesting = 0;
19921 for (;;)
19923 msg_scroll = TRUE;
19924 need_wait_return = FALSE;
19925 sourcing_lnum_off = sourcing_lnum;
19927 if (line_arg != NULL)
19929 /* Use eap->arg, split up in parts by line breaks. */
19930 theline = line_arg;
19931 p = vim_strchr(theline, '\n');
19932 if (p == NULL)
19933 line_arg += STRLEN(line_arg);
19934 else
19936 *p = NUL;
19937 line_arg = p + 1;
19940 else if (eap->getline == NULL)
19941 theline = getcmdline(':', 0L, indent);
19942 else
19943 theline = eap->getline(':', eap->cookie, indent);
19944 if (KeyTyped)
19945 lines_left = Rows - 1;
19946 if (theline == NULL)
19948 EMSG(_("E126: Missing :endfunction"));
19949 goto erret;
19952 /* Detect line continuation: sourcing_lnum increased more than one. */
19953 if (sourcing_lnum > sourcing_lnum_off + 1)
19954 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
19955 else
19956 sourcing_lnum_off = 0;
19958 if (skip_until != NULL)
19960 /* between ":append" and "." and between ":python <<EOF" and "EOF"
19961 * don't check for ":endfunc". */
19962 if (STRCMP(theline, skip_until) == 0)
19964 vim_free(skip_until);
19965 skip_until = NULL;
19968 else
19970 /* skip ':' and blanks*/
19971 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
19974 /* Check for "endfunction". */
19975 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
19977 if (line_arg == NULL)
19978 vim_free(theline);
19979 break;
19982 /* Increase indent inside "if", "while", "for" and "try", decrease
19983 * at "end". */
19984 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
19985 indent -= 2;
19986 else if (STRNCMP(p, "if", 2) == 0
19987 || STRNCMP(p, "wh", 2) == 0
19988 || STRNCMP(p, "for", 3) == 0
19989 || STRNCMP(p, "try", 3) == 0)
19990 indent += 2;
19992 /* Check for defining a function inside this function. */
19993 if (checkforcmd(&p, "function", 2))
19995 if (*p == '!')
19996 p = skipwhite(p + 1);
19997 p += eval_fname_script(p);
19998 if (ASCII_ISALPHA(*p))
20000 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20001 if (*skipwhite(p) == '(')
20003 ++nesting;
20004 indent += 2;
20009 /* Check for ":append" or ":insert". */
20010 p = skip_range(p, NULL);
20011 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20012 || (p[0] == 'i'
20013 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20014 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20015 skip_until = vim_strsave((char_u *)".");
20017 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20018 arg = skipwhite(skiptowhite(p));
20019 if (arg[0] == '<' && arg[1] =='<'
20020 && ((p[0] == 'p' && p[1] == 'y'
20021 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20022 || (p[0] == 'p' && p[1] == 'e'
20023 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20024 || (p[0] == 't' && p[1] == 'c'
20025 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20026 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20027 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20028 || (p[0] == 'm' && p[1] == 'z'
20029 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20032 /* ":python <<" continues until a dot, like ":append" */
20033 p = skipwhite(arg + 2);
20034 if (*p == NUL)
20035 skip_until = vim_strsave((char_u *)".");
20036 else
20037 skip_until = vim_strsave(p);
20041 /* Add the line to the function. */
20042 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20044 if (line_arg == NULL)
20045 vim_free(theline);
20046 goto erret;
20049 /* Copy the line to newly allocated memory. get_one_sourceline()
20050 * allocates 250 bytes per line, this saves 80% on average. The cost
20051 * is an extra alloc/free. */
20052 p = vim_strsave(theline);
20053 if (p != NULL)
20055 if (line_arg == NULL)
20056 vim_free(theline);
20057 theline = p;
20060 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20062 /* Add NULL lines for continuation lines, so that the line count is
20063 * equal to the index in the growarray. */
20064 while (sourcing_lnum_off-- > 0)
20065 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20067 /* Check for end of eap->arg. */
20068 if (line_arg != NULL && *line_arg == NUL)
20069 line_arg = NULL;
20072 /* Don't define the function when skipping commands or when an error was
20073 * detected. */
20074 if (eap->skip || did_emsg)
20075 goto erret;
20078 * If there are no errors, add the function
20080 if (fudi.fd_dict == NULL)
20082 v = find_var(name, &ht);
20083 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20085 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
20086 name);
20087 goto erret;
20090 fp = find_func(name);
20091 if (fp != NULL)
20093 if (!eap->forceit)
20095 emsg_funcname(e_funcexts, name);
20096 goto erret;
20098 if (fp->uf_calls > 0)
20100 emsg_funcname(N_("E127: Cannot redefine function %s: It is in use"),
20101 name);
20102 goto erret;
20104 /* redefine existing function */
20105 ga_clear_strings(&(fp->uf_args));
20106 ga_clear_strings(&(fp->uf_lines));
20107 vim_free(name);
20108 name = NULL;
20111 else
20113 char numbuf[20];
20115 fp = NULL;
20116 if (fudi.fd_newkey == NULL && !eap->forceit)
20118 EMSG(_(e_funcdict));
20119 goto erret;
20121 if (fudi.fd_di == NULL)
20123 /* Can't add a function to a locked dictionary */
20124 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20125 goto erret;
20127 /* Can't change an existing function if it is locked */
20128 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20129 goto erret;
20131 /* Give the function a sequential number. Can only be used with a
20132 * Funcref! */
20133 vim_free(name);
20134 sprintf(numbuf, "%d", ++func_nr);
20135 name = vim_strsave((char_u *)numbuf);
20136 if (name == NULL)
20137 goto erret;
20140 if (fp == NULL)
20142 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20144 int slen, plen;
20145 char_u *scriptname;
20147 /* Check that the autoload name matches the script name. */
20148 j = FAIL;
20149 if (sourcing_name != NULL)
20151 scriptname = autoload_name(name);
20152 if (scriptname != NULL)
20154 p = vim_strchr(scriptname, '/');
20155 plen = (int)STRLEN(p);
20156 slen = (int)STRLEN(sourcing_name);
20157 if (slen > plen && fnamecmp(p,
20158 sourcing_name + slen - plen) == 0)
20159 j = OK;
20160 vim_free(scriptname);
20163 if (j == FAIL)
20165 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20166 goto erret;
20170 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20171 if (fp == NULL)
20172 goto erret;
20174 if (fudi.fd_dict != NULL)
20176 if (fudi.fd_di == NULL)
20178 /* add new dict entry */
20179 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20180 if (fudi.fd_di == NULL)
20182 vim_free(fp);
20183 goto erret;
20185 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20187 vim_free(fudi.fd_di);
20188 vim_free(fp);
20189 goto erret;
20192 else
20193 /* overwrite existing dict entry */
20194 clear_tv(&fudi.fd_di->di_tv);
20195 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20196 fudi.fd_di->di_tv.v_lock = 0;
20197 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20198 fp->uf_refcount = 1;
20200 /* behave like "dict" was used */
20201 flags |= FC_DICT;
20204 /* insert the new function in the function list */
20205 STRCPY(fp->uf_name, name);
20206 hash_add(&func_hashtab, UF2HIKEY(fp));
20208 fp->uf_args = newargs;
20209 fp->uf_lines = newlines;
20210 #ifdef FEAT_PROFILE
20211 fp->uf_tml_count = NULL;
20212 fp->uf_tml_total = NULL;
20213 fp->uf_tml_self = NULL;
20214 fp->uf_profiling = FALSE;
20215 if (prof_def_func())
20216 func_do_profile(fp);
20217 #endif
20218 fp->uf_varargs = varargs;
20219 fp->uf_flags = flags;
20220 fp->uf_calls = 0;
20221 fp->uf_script_ID = current_SID;
20222 goto ret_free;
20224 erret:
20225 ga_clear_strings(&newargs);
20226 ga_clear_strings(&newlines);
20227 ret_free:
20228 vim_free(skip_until);
20229 vim_free(fudi.fd_newkey);
20230 vim_free(name);
20231 did_emsg |= saved_did_emsg;
20235 * Get a function name, translating "<SID>" and "<SNR>".
20236 * Also handles a Funcref in a List or Dictionary.
20237 * Returns the function name in allocated memory, or NULL for failure.
20238 * flags:
20239 * TFN_INT: internal function name OK
20240 * TFN_QUIET: be quiet
20241 * Advances "pp" to just after the function name (if no error).
20243 static char_u *
20244 trans_function_name(pp, skip, flags, fdp)
20245 char_u **pp;
20246 int skip; /* only find the end, don't evaluate */
20247 int flags;
20248 funcdict_T *fdp; /* return: info about dictionary used */
20250 char_u *name = NULL;
20251 char_u *start;
20252 char_u *end;
20253 int lead;
20254 char_u sid_buf[20];
20255 int len;
20256 lval_T lv;
20258 if (fdp != NULL)
20259 vim_memset(fdp, 0, sizeof(funcdict_T));
20260 start = *pp;
20262 /* Check for hard coded <SNR>: already translated function ID (from a user
20263 * command). */
20264 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20265 && (*pp)[2] == (int)KE_SNR)
20267 *pp += 3;
20268 len = get_id_len(pp) + 3;
20269 return vim_strnsave(start, len);
20272 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20273 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20274 lead = eval_fname_script(start);
20275 if (lead > 2)
20276 start += lead;
20278 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20279 lead > 2 ? 0 : FNE_CHECK_START);
20280 if (end == start)
20282 if (!skip)
20283 EMSG(_("E129: Function name required"));
20284 goto theend;
20286 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20289 * Report an invalid expression in braces, unless the expression
20290 * evaluation has been cancelled due to an aborting error, an
20291 * interrupt, or an exception.
20293 if (!aborting())
20295 if (end != NULL)
20296 EMSG2(_(e_invarg2), start);
20298 else
20299 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20300 goto theend;
20303 if (lv.ll_tv != NULL)
20305 if (fdp != NULL)
20307 fdp->fd_dict = lv.ll_dict;
20308 fdp->fd_newkey = lv.ll_newkey;
20309 lv.ll_newkey = NULL;
20310 fdp->fd_di = lv.ll_di;
20312 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20314 name = vim_strsave(lv.ll_tv->vval.v_string);
20315 *pp = end;
20317 else
20319 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20320 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20321 EMSG(_(e_funcref));
20322 else
20323 *pp = end;
20324 name = NULL;
20326 goto theend;
20329 if (lv.ll_name == NULL)
20331 /* Error found, but continue after the function name. */
20332 *pp = end;
20333 goto theend;
20336 /* Check if the name is a Funcref. If so, use the value. */
20337 if (lv.ll_exp_name != NULL)
20339 len = (int)STRLEN(lv.ll_exp_name);
20340 name = deref_func_name(lv.ll_exp_name, &len);
20341 if (name == lv.ll_exp_name)
20342 name = NULL;
20344 else
20346 len = (int)(end - *pp);
20347 name = deref_func_name(*pp, &len);
20348 if (name == *pp)
20349 name = NULL;
20351 if (name != NULL)
20353 name = vim_strsave(name);
20354 *pp = end;
20355 goto theend;
20358 if (lv.ll_exp_name != NULL)
20360 len = (int)STRLEN(lv.ll_exp_name);
20361 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20362 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20364 /* When there was "s:" already or the name expanded to get a
20365 * leading "s:" then remove it. */
20366 lv.ll_name += 2;
20367 len -= 2;
20368 lead = 2;
20371 else
20373 if (lead == 2) /* skip over "s:" */
20374 lv.ll_name += 2;
20375 len = (int)(end - lv.ll_name);
20379 * Copy the function name to allocated memory.
20380 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20381 * Accept <SNR>123_name() outside a script.
20383 if (skip)
20384 lead = 0; /* do nothing */
20385 else if (lead > 0)
20387 lead = 3;
20388 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20389 || eval_fname_sid(*pp))
20391 /* It's "s:" or "<SID>" */
20392 if (current_SID <= 0)
20394 EMSG(_(e_usingsid));
20395 goto theend;
20397 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20398 lead += (int)STRLEN(sid_buf);
20401 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20403 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20404 goto theend;
20406 name = alloc((unsigned)(len + lead + 1));
20407 if (name != NULL)
20409 if (lead > 0)
20411 name[0] = K_SPECIAL;
20412 name[1] = KS_EXTRA;
20413 name[2] = (int)KE_SNR;
20414 if (lead > 3) /* If it's "<SID>" */
20415 STRCPY(name + 3, sid_buf);
20417 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20418 name[len + lead] = NUL;
20420 *pp = end;
20422 theend:
20423 clear_lval(&lv);
20424 return name;
20428 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20429 * Return 2 if "p" starts with "s:".
20430 * Return 0 otherwise.
20432 static int
20433 eval_fname_script(p)
20434 char_u *p;
20436 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20437 || STRNICMP(p + 1, "SNR>", 4) == 0))
20438 return 5;
20439 if (p[0] == 's' && p[1] == ':')
20440 return 2;
20441 return 0;
20445 * Return TRUE if "p" starts with "<SID>" or "s:".
20446 * Only works if eval_fname_script() returned non-zero for "p"!
20448 static int
20449 eval_fname_sid(p)
20450 char_u *p;
20452 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20456 * List the head of the function: "name(arg1, arg2)".
20458 static void
20459 list_func_head(fp, indent)
20460 ufunc_T *fp;
20461 int indent;
20463 int j;
20465 msg_start();
20466 if (indent)
20467 MSG_PUTS(" ");
20468 MSG_PUTS("function ");
20469 if (fp->uf_name[0] == K_SPECIAL)
20471 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20472 msg_puts(fp->uf_name + 3);
20474 else
20475 msg_puts(fp->uf_name);
20476 msg_putchar('(');
20477 for (j = 0; j < fp->uf_args.ga_len; ++j)
20479 if (j)
20480 MSG_PUTS(", ");
20481 msg_puts(FUNCARG(fp, j));
20483 if (fp->uf_varargs)
20485 if (j)
20486 MSG_PUTS(", ");
20487 MSG_PUTS("...");
20489 msg_putchar(')');
20490 msg_clr_eos();
20491 if (p_verbose > 0)
20492 last_set_msg(fp->uf_script_ID);
20496 * Find a function by name, return pointer to it in ufuncs.
20497 * Return NULL for unknown function.
20499 static ufunc_T *
20500 find_func(name)
20501 char_u *name;
20503 hashitem_T *hi;
20505 hi = hash_find(&func_hashtab, name);
20506 if (!HASHITEM_EMPTY(hi))
20507 return HI2UF(hi);
20508 return NULL;
20511 #if defined(EXITFREE) || defined(PROTO)
20512 void
20513 free_all_functions()
20515 hashitem_T *hi;
20517 /* Need to start all over every time, because func_free() may change the
20518 * hash table. */
20519 while (func_hashtab.ht_used > 0)
20520 for (hi = func_hashtab.ht_array; ; ++hi)
20521 if (!HASHITEM_EMPTY(hi))
20523 func_free(HI2UF(hi));
20524 break;
20527 #endif
20530 * Return TRUE if a function "name" exists.
20532 static int
20533 function_exists(name)
20534 char_u *name;
20536 char_u *nm = name;
20537 char_u *p;
20538 int n = FALSE;
20540 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20541 nm = skipwhite(nm);
20543 /* Only accept "funcname", "funcname ", "funcname (..." and
20544 * "funcname(...", not "funcname!...". */
20545 if (p != NULL && (*nm == NUL || *nm == '('))
20547 if (builtin_function(p))
20548 n = (find_internal_func(p) >= 0);
20549 else
20550 n = (find_func(p) != NULL);
20552 vim_free(p);
20553 return n;
20557 * Return TRUE if "name" looks like a builtin function name: starts with a
20558 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20560 static int
20561 builtin_function(name)
20562 char_u *name;
20564 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20565 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20568 #if defined(FEAT_PROFILE) || defined(PROTO)
20570 * Start profiling function "fp".
20572 static void
20573 func_do_profile(fp)
20574 ufunc_T *fp;
20576 fp->uf_tm_count = 0;
20577 profile_zero(&fp->uf_tm_self);
20578 profile_zero(&fp->uf_tm_total);
20579 if (fp->uf_tml_count == NULL)
20580 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20581 (sizeof(int) * fp->uf_lines.ga_len));
20582 if (fp->uf_tml_total == NULL)
20583 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20584 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20585 if (fp->uf_tml_self == NULL)
20586 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20587 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20588 fp->uf_tml_idx = -1;
20589 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20590 || fp->uf_tml_self == NULL)
20591 return; /* out of memory */
20593 fp->uf_profiling = TRUE;
20597 * Dump the profiling results for all functions in file "fd".
20599 void
20600 func_dump_profile(fd)
20601 FILE *fd;
20603 hashitem_T *hi;
20604 int todo;
20605 ufunc_T *fp;
20606 int i;
20607 ufunc_T **sorttab;
20608 int st_len = 0;
20610 todo = (int)func_hashtab.ht_used;
20611 if (todo == 0)
20612 return; /* nothing to dump */
20614 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20616 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20618 if (!HASHITEM_EMPTY(hi))
20620 --todo;
20621 fp = HI2UF(hi);
20622 if (fp->uf_profiling)
20624 if (sorttab != NULL)
20625 sorttab[st_len++] = fp;
20627 if (fp->uf_name[0] == K_SPECIAL)
20628 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20629 else
20630 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20631 if (fp->uf_tm_count == 1)
20632 fprintf(fd, "Called 1 time\n");
20633 else
20634 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20635 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20636 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20637 fprintf(fd, "\n");
20638 fprintf(fd, "count total (s) self (s)\n");
20640 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20642 if (FUNCLINE(fp, i) == NULL)
20643 continue;
20644 prof_func_line(fd, fp->uf_tml_count[i],
20645 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20646 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20648 fprintf(fd, "\n");
20653 if (sorttab != NULL && st_len > 0)
20655 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20656 prof_total_cmp);
20657 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20658 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20659 prof_self_cmp);
20660 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20663 vim_free(sorttab);
20666 static void
20667 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20668 FILE *fd;
20669 ufunc_T **sorttab;
20670 int st_len;
20671 char *title;
20672 int prefer_self; /* when equal print only self time */
20674 int i;
20675 ufunc_T *fp;
20677 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20678 fprintf(fd, "count total (s) self (s) function\n");
20679 for (i = 0; i < 20 && i < st_len; ++i)
20681 fp = sorttab[i];
20682 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20683 prefer_self);
20684 if (fp->uf_name[0] == K_SPECIAL)
20685 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20686 else
20687 fprintf(fd, " %s()\n", fp->uf_name);
20689 fprintf(fd, "\n");
20693 * Print the count and times for one function or function line.
20695 static void
20696 prof_func_line(fd, count, total, self, prefer_self)
20697 FILE *fd;
20698 int count;
20699 proftime_T *total;
20700 proftime_T *self;
20701 int prefer_self; /* when equal print only self time */
20703 if (count > 0)
20705 fprintf(fd, "%5d ", count);
20706 if (prefer_self && profile_equal(total, self))
20707 fprintf(fd, " ");
20708 else
20709 fprintf(fd, "%s ", profile_msg(total));
20710 if (!prefer_self && profile_equal(total, self))
20711 fprintf(fd, " ");
20712 else
20713 fprintf(fd, "%s ", profile_msg(self));
20715 else
20716 fprintf(fd, " ");
20720 * Compare function for total time sorting.
20722 static int
20723 #ifdef __BORLANDC__
20724 _RTLENTRYF
20725 #endif
20726 prof_total_cmp(s1, s2)
20727 const void *s1;
20728 const void *s2;
20730 ufunc_T *p1, *p2;
20732 p1 = *(ufunc_T **)s1;
20733 p2 = *(ufunc_T **)s2;
20734 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20738 * Compare function for self time sorting.
20740 static int
20741 #ifdef __BORLANDC__
20742 _RTLENTRYF
20743 #endif
20744 prof_self_cmp(s1, s2)
20745 const void *s1;
20746 const void *s2;
20748 ufunc_T *p1, *p2;
20750 p1 = *(ufunc_T **)s1;
20751 p2 = *(ufunc_T **)s2;
20752 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20755 #endif
20758 * If "name" has a package name try autoloading the script for it.
20759 * Return TRUE if a package was loaded.
20761 static int
20762 script_autoload(name, reload)
20763 char_u *name;
20764 int reload; /* load script again when already loaded */
20766 char_u *p;
20767 char_u *scriptname, *tofree;
20768 int ret = FALSE;
20769 int i;
20771 /* If there is no '#' after name[0] there is no package name. */
20772 p = vim_strchr(name, AUTOLOAD_CHAR);
20773 if (p == NULL || p == name)
20774 return FALSE;
20776 tofree = scriptname = autoload_name(name);
20778 /* Find the name in the list of previously loaded package names. Skip
20779 * "autoload/", it's always the same. */
20780 for (i = 0; i < ga_loaded.ga_len; ++i)
20781 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20782 break;
20783 if (!reload && i < ga_loaded.ga_len)
20784 ret = FALSE; /* was loaded already */
20785 else
20787 /* Remember the name if it wasn't loaded already. */
20788 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20790 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20791 tofree = NULL;
20794 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20795 if (source_runtime(scriptname, FALSE) == OK)
20796 ret = TRUE;
20799 vim_free(tofree);
20800 return ret;
20804 * Return the autoload script name for a function or variable name.
20805 * Returns NULL when out of memory.
20807 static char_u *
20808 autoload_name(name)
20809 char_u *name;
20811 char_u *p;
20812 char_u *scriptname;
20814 /* Get the script file name: replace '#' with '/', append ".vim". */
20815 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20816 if (scriptname == NULL)
20817 return FALSE;
20818 STRCPY(scriptname, "autoload/");
20819 STRCAT(scriptname, name);
20820 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20821 STRCAT(scriptname, ".vim");
20822 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20823 *p = '/';
20824 return scriptname;
20827 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20830 * Function given to ExpandGeneric() to obtain the list of user defined
20831 * function names.
20833 char_u *
20834 get_user_func_name(xp, idx)
20835 expand_T *xp;
20836 int idx;
20838 static long_u done;
20839 static hashitem_T *hi;
20840 ufunc_T *fp;
20842 if (idx == 0)
20844 done = 0;
20845 hi = func_hashtab.ht_array;
20847 if (done < func_hashtab.ht_used)
20849 if (done++ > 0)
20850 ++hi;
20851 while (HASHITEM_EMPTY(hi))
20852 ++hi;
20853 fp = HI2UF(hi);
20855 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20856 return fp->uf_name; /* prevents overflow */
20858 cat_func_name(IObuff, fp);
20859 if (xp->xp_context != EXPAND_USER_FUNC)
20861 STRCAT(IObuff, "(");
20862 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20863 STRCAT(IObuff, ")");
20865 return IObuff;
20867 return NULL;
20870 #endif /* FEAT_CMDL_COMPL */
20873 * Copy the function name of "fp" to buffer "buf".
20874 * "buf" must be able to hold the function name plus three bytes.
20875 * Takes care of script-local function names.
20877 static void
20878 cat_func_name(buf, fp)
20879 char_u *buf;
20880 ufunc_T *fp;
20882 if (fp->uf_name[0] == K_SPECIAL)
20884 STRCPY(buf, "<SNR>");
20885 STRCAT(buf, fp->uf_name + 3);
20887 else
20888 STRCPY(buf, fp->uf_name);
20892 * ":delfunction {name}"
20894 void
20895 ex_delfunction(eap)
20896 exarg_T *eap;
20898 ufunc_T *fp = NULL;
20899 char_u *p;
20900 char_u *name;
20901 funcdict_T fudi;
20903 p = eap->arg;
20904 name = trans_function_name(&p, eap->skip, 0, &fudi);
20905 vim_free(fudi.fd_newkey);
20906 if (name == NULL)
20908 if (fudi.fd_dict != NULL && !eap->skip)
20909 EMSG(_(e_funcref));
20910 return;
20912 if (!ends_excmd(*skipwhite(p)))
20914 vim_free(name);
20915 EMSG(_(e_trailing));
20916 return;
20918 eap->nextcmd = check_nextcmd(p);
20919 if (eap->nextcmd != NULL)
20920 *p = NUL;
20922 if (!eap->skip)
20923 fp = find_func(name);
20924 vim_free(name);
20926 if (!eap->skip)
20928 if (fp == NULL)
20930 EMSG2(_(e_nofunc), eap->arg);
20931 return;
20933 if (fp->uf_calls > 0)
20935 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
20936 return;
20939 if (fudi.fd_dict != NULL)
20941 /* Delete the dict item that refers to the function, it will
20942 * invoke func_unref() and possibly delete the function. */
20943 dictitem_remove(fudi.fd_dict, fudi.fd_di);
20945 else
20946 func_free(fp);
20951 * Free a function and remove it from the list of functions.
20953 static void
20954 func_free(fp)
20955 ufunc_T *fp;
20957 hashitem_T *hi;
20959 /* clear this function */
20960 ga_clear_strings(&(fp->uf_args));
20961 ga_clear_strings(&(fp->uf_lines));
20962 #ifdef FEAT_PROFILE
20963 vim_free(fp->uf_tml_count);
20964 vim_free(fp->uf_tml_total);
20965 vim_free(fp->uf_tml_self);
20966 #endif
20968 /* remove the function from the function hashtable */
20969 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
20970 if (HASHITEM_EMPTY(hi))
20971 EMSG2(_(e_intern2), "func_free()");
20972 else
20973 hash_remove(&func_hashtab, hi);
20975 vim_free(fp);
20979 * Unreference a Function: decrement the reference count and free it when it
20980 * becomes zero. Only for numbered functions.
20982 static void
20983 func_unref(name)
20984 char_u *name;
20986 ufunc_T *fp;
20988 if (name != NULL && isdigit(*name))
20990 fp = find_func(name);
20991 if (fp == NULL)
20992 EMSG2(_(e_intern2), "func_unref()");
20993 else if (--fp->uf_refcount <= 0)
20995 /* Only delete it when it's not being used. Otherwise it's done
20996 * when "uf_calls" becomes zero. */
20997 if (fp->uf_calls == 0)
20998 func_free(fp);
21004 * Count a reference to a Function.
21006 static void
21007 func_ref(name)
21008 char_u *name;
21010 ufunc_T *fp;
21012 if (name != NULL && isdigit(*name))
21014 fp = find_func(name);
21015 if (fp == NULL)
21016 EMSG2(_(e_intern2), "func_ref()");
21017 else
21018 ++fp->uf_refcount;
21023 * Call a user function.
21025 static void
21026 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21027 ufunc_T *fp; /* pointer to function */
21028 int argcount; /* nr of args */
21029 typval_T *argvars; /* arguments */
21030 typval_T *rettv; /* return value */
21031 linenr_T firstline; /* first line of range */
21032 linenr_T lastline; /* last line of range */
21033 dict_T *selfdict; /* Dictionary for "self" */
21035 char_u *save_sourcing_name;
21036 linenr_T save_sourcing_lnum;
21037 scid_T save_current_SID;
21038 funccall_T *fc;
21039 int save_did_emsg;
21040 static int depth = 0;
21041 dictitem_T *v;
21042 int fixvar_idx = 0; /* index in fixvar[] */
21043 int i;
21044 int ai;
21045 char_u numbuf[NUMBUFLEN];
21046 char_u *name;
21047 #ifdef FEAT_PROFILE
21048 proftime_T wait_start;
21049 proftime_T call_start;
21050 #endif
21052 /* If depth of calling is getting too high, don't execute the function */
21053 if (depth >= p_mfd)
21055 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21056 rettv->v_type = VAR_NUMBER;
21057 rettv->vval.v_number = -1;
21058 return;
21060 ++depth;
21062 line_breakcheck(); /* check for CTRL-C hit */
21064 fc = (funccall_T *)alloc(sizeof(funccall_T));
21065 fc->caller = current_funccal;
21066 current_funccal = fc;
21067 fc->func = fp;
21068 fc->rettv = rettv;
21069 rettv->vval.v_number = 0;
21070 fc->linenr = 0;
21071 fc->returned = FALSE;
21072 fc->level = ex_nesting_level;
21073 /* Check if this function has a breakpoint. */
21074 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21075 fc->dbg_tick = debug_tick;
21078 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21079 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21080 * each argument variable and saves a lot of time.
21083 * Init l: variables.
21085 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21086 if (selfdict != NULL)
21088 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21089 * some compiler that checks the destination size. */
21090 v = &fc->fixvar[fixvar_idx++].var;
21091 name = v->di_key;
21092 STRCPY(name, "self");
21093 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21094 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21095 v->di_tv.v_type = VAR_DICT;
21096 v->di_tv.v_lock = 0;
21097 v->di_tv.vval.v_dict = selfdict;
21098 ++selfdict->dv_refcount;
21102 * Init a: variables.
21103 * Set a:0 to "argcount".
21104 * Set a:000 to a list with room for the "..." arguments.
21106 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21107 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21108 (varnumber_T)(argcount - fp->uf_args.ga_len));
21109 /* Use "name" to avoid a warning from some compiler that checks the
21110 * destination size. */
21111 v = &fc->fixvar[fixvar_idx++].var;
21112 name = v->di_key;
21113 STRCPY(name, "000");
21114 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21115 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21116 v->di_tv.v_type = VAR_LIST;
21117 v->di_tv.v_lock = VAR_FIXED;
21118 v->di_tv.vval.v_list = &fc->l_varlist;
21119 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21120 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21121 fc->l_varlist.lv_lock = VAR_FIXED;
21124 * Set a:firstline to "firstline" and a:lastline to "lastline".
21125 * Set a:name to named arguments.
21126 * Set a:N to the "..." arguments.
21128 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21129 (varnumber_T)firstline);
21130 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21131 (varnumber_T)lastline);
21132 for (i = 0; i < argcount; ++i)
21134 ai = i - fp->uf_args.ga_len;
21135 if (ai < 0)
21136 /* named argument a:name */
21137 name = FUNCARG(fp, i);
21138 else
21140 /* "..." argument a:1, a:2, etc. */
21141 sprintf((char *)numbuf, "%d", ai + 1);
21142 name = numbuf;
21144 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21146 v = &fc->fixvar[fixvar_idx++].var;
21147 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21149 else
21151 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21152 + STRLEN(name)));
21153 if (v == NULL)
21154 break;
21155 v->di_flags = DI_FLAGS_RO;
21157 STRCPY(v->di_key, name);
21158 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21160 /* Note: the values are copied directly to avoid alloc/free.
21161 * "argvars" must have VAR_FIXED for v_lock. */
21162 v->di_tv = argvars[i];
21163 v->di_tv.v_lock = VAR_FIXED;
21165 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21167 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21168 fc->l_listitems[ai].li_tv = argvars[i];
21169 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21173 /* Don't redraw while executing the function. */
21174 ++RedrawingDisabled;
21175 save_sourcing_name = sourcing_name;
21176 save_sourcing_lnum = sourcing_lnum;
21177 sourcing_lnum = 1;
21178 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21179 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21180 if (sourcing_name != NULL)
21182 if (save_sourcing_name != NULL
21183 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21184 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21185 else
21186 STRCPY(sourcing_name, "function ");
21187 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21189 if (p_verbose >= 12)
21191 ++no_wait_return;
21192 verbose_enter_scroll();
21194 smsg((char_u *)_("calling %s"), sourcing_name);
21195 if (p_verbose >= 14)
21197 char_u buf[MSG_BUF_LEN];
21198 char_u numbuf2[NUMBUFLEN];
21199 char_u *tofree;
21200 char_u *s;
21202 msg_puts((char_u *)"(");
21203 for (i = 0; i < argcount; ++i)
21205 if (i > 0)
21206 msg_puts((char_u *)", ");
21207 if (argvars[i].v_type == VAR_NUMBER)
21208 msg_outnum((long)argvars[i].vval.v_number);
21209 else
21211 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21212 if (s != NULL)
21214 trunc_string(s, buf, MSG_BUF_CLEN);
21215 msg_puts(buf);
21216 vim_free(tofree);
21220 msg_puts((char_u *)")");
21222 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21224 verbose_leave_scroll();
21225 --no_wait_return;
21228 #ifdef FEAT_PROFILE
21229 if (do_profiling == PROF_YES)
21231 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21232 func_do_profile(fp);
21233 if (fp->uf_profiling
21234 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21236 ++fp->uf_tm_count;
21237 profile_start(&call_start);
21238 profile_zero(&fp->uf_tm_children);
21240 script_prof_save(&wait_start);
21242 #endif
21244 save_current_SID = current_SID;
21245 current_SID = fp->uf_script_ID;
21246 save_did_emsg = did_emsg;
21247 did_emsg = FALSE;
21249 /* call do_cmdline() to execute the lines */
21250 do_cmdline(NULL, get_func_line, (void *)fc,
21251 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21253 --RedrawingDisabled;
21255 /* when the function was aborted because of an error, return -1 */
21256 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21258 clear_tv(rettv);
21259 rettv->v_type = VAR_NUMBER;
21260 rettv->vval.v_number = -1;
21263 #ifdef FEAT_PROFILE
21264 if (do_profiling == PROF_YES && (fp->uf_profiling
21265 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21267 profile_end(&call_start);
21268 profile_sub_wait(&wait_start, &call_start);
21269 profile_add(&fp->uf_tm_total, &call_start);
21270 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21271 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21273 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21274 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21277 #endif
21279 /* when being verbose, mention the return value */
21280 if (p_verbose >= 12)
21282 ++no_wait_return;
21283 verbose_enter_scroll();
21285 if (aborting())
21286 smsg((char_u *)_("%s aborted"), sourcing_name);
21287 else if (fc->rettv->v_type == VAR_NUMBER)
21288 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21289 (long)fc->rettv->vval.v_number);
21290 else
21292 char_u buf[MSG_BUF_LEN];
21293 char_u numbuf2[NUMBUFLEN];
21294 char_u *tofree;
21295 char_u *s;
21297 /* The value may be very long. Skip the middle part, so that we
21298 * have some idea how it starts and ends. smsg() would always
21299 * truncate it at the end. */
21300 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21301 if (s != NULL)
21303 trunc_string(s, buf, MSG_BUF_CLEN);
21304 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21305 vim_free(tofree);
21308 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21310 verbose_leave_scroll();
21311 --no_wait_return;
21314 vim_free(sourcing_name);
21315 sourcing_name = save_sourcing_name;
21316 sourcing_lnum = save_sourcing_lnum;
21317 current_SID = save_current_SID;
21318 #ifdef FEAT_PROFILE
21319 if (do_profiling == PROF_YES)
21320 script_prof_restore(&wait_start);
21321 #endif
21323 if (p_verbose >= 12 && sourcing_name != NULL)
21325 ++no_wait_return;
21326 verbose_enter_scroll();
21328 smsg((char_u *)_("continuing in %s"), sourcing_name);
21329 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21331 verbose_leave_scroll();
21332 --no_wait_return;
21335 did_emsg |= save_did_emsg;
21336 current_funccal = fc->caller;
21337 --depth;
21339 /* If the a:000 list and the l: and a: dicts are not referenced we can
21340 * free the funccall_T and what's in it. */
21341 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21342 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21343 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21345 free_funccal(fc, FALSE);
21347 else
21349 hashitem_T *hi;
21350 listitem_T *li;
21351 int todo;
21353 /* "fc" is still in use. This can happen when returning "a:000" or
21354 * assigning "l:" to a global variable.
21355 * Link "fc" in the list for garbage collection later. */
21356 fc->caller = previous_funccal;
21357 previous_funccal = fc;
21359 /* Make a copy of the a: variables, since we didn't do that above. */
21360 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21361 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21363 if (!HASHITEM_EMPTY(hi))
21365 --todo;
21366 v = HI2DI(hi);
21367 copy_tv(&v->di_tv, &v->di_tv);
21371 /* Make a copy of the a:000 items, since we didn't do that above. */
21372 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21373 copy_tv(&li->li_tv, &li->li_tv);
21378 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21379 * referenced from anywhere that is in use.
21381 static int
21382 can_free_funccal(fc, copyID)
21383 funccall_T *fc;
21384 int copyID;
21386 return (fc->l_varlist.lv_copyID != copyID
21387 && fc->l_vars.dv_copyID != copyID
21388 && fc->l_avars.dv_copyID != copyID);
21392 * Free "fc" and what it contains.
21394 static void
21395 free_funccal(fc, free_val)
21396 funccall_T *fc;
21397 int free_val; /* a: vars were allocated */
21399 listitem_T *li;
21401 /* The a: variables typevals may not have been allocated, only free the
21402 * allocated variables. */
21403 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21405 /* free all l: variables */
21406 vars_clear(&fc->l_vars.dv_hashtab);
21408 /* Free the a:000 variables if they were allocated. */
21409 if (free_val)
21410 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21411 clear_tv(&li->li_tv);
21413 vim_free(fc);
21417 * Add a number variable "name" to dict "dp" with value "nr".
21419 static void
21420 add_nr_var(dp, v, name, nr)
21421 dict_T *dp;
21422 dictitem_T *v;
21423 char *name;
21424 varnumber_T nr;
21426 STRCPY(v->di_key, name);
21427 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21428 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21429 v->di_tv.v_type = VAR_NUMBER;
21430 v->di_tv.v_lock = VAR_FIXED;
21431 v->di_tv.vval.v_number = nr;
21435 * ":return [expr]"
21437 void
21438 ex_return(eap)
21439 exarg_T *eap;
21441 char_u *arg = eap->arg;
21442 typval_T rettv;
21443 int returning = FALSE;
21445 if (current_funccal == NULL)
21447 EMSG(_("E133: :return not inside a function"));
21448 return;
21451 if (eap->skip)
21452 ++emsg_skip;
21454 eap->nextcmd = NULL;
21455 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21456 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21458 if (!eap->skip)
21459 returning = do_return(eap, FALSE, TRUE, &rettv);
21460 else
21461 clear_tv(&rettv);
21463 /* It's safer to return also on error. */
21464 else if (!eap->skip)
21467 * Return unless the expression evaluation has been cancelled due to an
21468 * aborting error, an interrupt, or an exception.
21470 if (!aborting())
21471 returning = do_return(eap, FALSE, TRUE, NULL);
21474 /* When skipping or the return gets pending, advance to the next command
21475 * in this line (!returning). Otherwise, ignore the rest of the line.
21476 * Following lines will be ignored by get_func_line(). */
21477 if (returning)
21478 eap->nextcmd = NULL;
21479 else if (eap->nextcmd == NULL) /* no argument */
21480 eap->nextcmd = check_nextcmd(arg);
21482 if (eap->skip)
21483 --emsg_skip;
21487 * Return from a function. Possibly makes the return pending. Also called
21488 * for a pending return at the ":endtry" or after returning from an extra
21489 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21490 * when called due to a ":return" command. "rettv" may point to a typval_T
21491 * with the return rettv. Returns TRUE when the return can be carried out,
21492 * FALSE when the return gets pending.
21495 do_return(eap, reanimate, is_cmd, rettv)
21496 exarg_T *eap;
21497 int reanimate;
21498 int is_cmd;
21499 void *rettv;
21501 int idx;
21502 struct condstack *cstack = eap->cstack;
21504 if (reanimate)
21505 /* Undo the return. */
21506 current_funccal->returned = FALSE;
21509 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21510 * not in its finally clause (which then is to be executed next) is found.
21511 * In this case, make the ":return" pending for execution at the ":endtry".
21512 * Otherwise, return normally.
21514 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21515 if (idx >= 0)
21517 cstack->cs_pending[idx] = CSTP_RETURN;
21519 if (!is_cmd && !reanimate)
21520 /* A pending return again gets pending. "rettv" points to an
21521 * allocated variable with the rettv of the original ":return"'s
21522 * argument if present or is NULL else. */
21523 cstack->cs_rettv[idx] = rettv;
21524 else
21526 /* When undoing a return in order to make it pending, get the stored
21527 * return rettv. */
21528 if (reanimate)
21529 rettv = current_funccal->rettv;
21531 if (rettv != NULL)
21533 /* Store the value of the pending return. */
21534 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21535 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21536 else
21537 EMSG(_(e_outofmem));
21539 else
21540 cstack->cs_rettv[idx] = NULL;
21542 if (reanimate)
21544 /* The pending return value could be overwritten by a ":return"
21545 * without argument in a finally clause; reset the default
21546 * return value. */
21547 current_funccal->rettv->v_type = VAR_NUMBER;
21548 current_funccal->rettv->vval.v_number = 0;
21551 report_make_pending(CSTP_RETURN, rettv);
21553 else
21555 current_funccal->returned = TRUE;
21557 /* If the return is carried out now, store the return value. For
21558 * a return immediately after reanimation, the value is already
21559 * there. */
21560 if (!reanimate && rettv != NULL)
21562 clear_tv(current_funccal->rettv);
21563 *current_funccal->rettv = *(typval_T *)rettv;
21564 if (!is_cmd)
21565 vim_free(rettv);
21569 return idx < 0;
21573 * Free the variable with a pending return value.
21575 void
21576 discard_pending_return(rettv)
21577 void *rettv;
21579 free_tv((typval_T *)rettv);
21583 * Generate a return command for producing the value of "rettv". The result
21584 * is an allocated string. Used by report_pending() for verbose messages.
21586 char_u *
21587 get_return_cmd(rettv)
21588 void *rettv;
21590 char_u *s = NULL;
21591 char_u *tofree = NULL;
21592 char_u numbuf[NUMBUFLEN];
21594 if (rettv != NULL)
21595 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21596 if (s == NULL)
21597 s = (char_u *)"";
21599 STRCPY(IObuff, ":return ");
21600 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21601 if (STRLEN(s) + 8 >= IOSIZE)
21602 STRCPY(IObuff + IOSIZE - 4, "...");
21603 vim_free(tofree);
21604 return vim_strsave(IObuff);
21608 * Get next function line.
21609 * Called by do_cmdline() to get the next line.
21610 * Returns allocated string, or NULL for end of function.
21612 char_u *
21613 get_func_line(c, cookie, indent)
21614 int c UNUSED;
21615 void *cookie;
21616 int indent UNUSED;
21618 funccall_T *fcp = (funccall_T *)cookie;
21619 ufunc_T *fp = fcp->func;
21620 char_u *retval;
21621 garray_T *gap; /* growarray with function lines */
21623 /* If breakpoints have been added/deleted need to check for it. */
21624 if (fcp->dbg_tick != debug_tick)
21626 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21627 sourcing_lnum);
21628 fcp->dbg_tick = debug_tick;
21630 #ifdef FEAT_PROFILE
21631 if (do_profiling == PROF_YES)
21632 func_line_end(cookie);
21633 #endif
21635 gap = &fp->uf_lines;
21636 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21637 || fcp->returned)
21638 retval = NULL;
21639 else
21641 /* Skip NULL lines (continuation lines). */
21642 while (fcp->linenr < gap->ga_len
21643 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21644 ++fcp->linenr;
21645 if (fcp->linenr >= gap->ga_len)
21646 retval = NULL;
21647 else
21649 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21650 sourcing_lnum = fcp->linenr;
21651 #ifdef FEAT_PROFILE
21652 if (do_profiling == PROF_YES)
21653 func_line_start(cookie);
21654 #endif
21658 /* Did we encounter a breakpoint? */
21659 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21661 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21662 /* Find next breakpoint. */
21663 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21664 sourcing_lnum);
21665 fcp->dbg_tick = debug_tick;
21668 return retval;
21671 #if defined(FEAT_PROFILE) || defined(PROTO)
21673 * Called when starting to read a function line.
21674 * "sourcing_lnum" must be correct!
21675 * When skipping lines it may not actually be executed, but we won't find out
21676 * until later and we need to store the time now.
21678 void
21679 func_line_start(cookie)
21680 void *cookie;
21682 funccall_T *fcp = (funccall_T *)cookie;
21683 ufunc_T *fp = fcp->func;
21685 if (fp->uf_profiling && sourcing_lnum >= 1
21686 && sourcing_lnum <= fp->uf_lines.ga_len)
21688 fp->uf_tml_idx = sourcing_lnum - 1;
21689 /* Skip continuation lines. */
21690 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21691 --fp->uf_tml_idx;
21692 fp->uf_tml_execed = FALSE;
21693 profile_start(&fp->uf_tml_start);
21694 profile_zero(&fp->uf_tml_children);
21695 profile_get_wait(&fp->uf_tml_wait);
21700 * Called when actually executing a function line.
21702 void
21703 func_line_exec(cookie)
21704 void *cookie;
21706 funccall_T *fcp = (funccall_T *)cookie;
21707 ufunc_T *fp = fcp->func;
21709 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21710 fp->uf_tml_execed = TRUE;
21714 * Called when done with a function line.
21716 void
21717 func_line_end(cookie)
21718 void *cookie;
21720 funccall_T *fcp = (funccall_T *)cookie;
21721 ufunc_T *fp = fcp->func;
21723 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21725 if (fp->uf_tml_execed)
21727 ++fp->uf_tml_count[fp->uf_tml_idx];
21728 profile_end(&fp->uf_tml_start);
21729 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21730 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21731 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21732 &fp->uf_tml_children);
21734 fp->uf_tml_idx = -1;
21737 #endif
21740 * Return TRUE if the currently active function should be ended, because a
21741 * return was encountered or an error occurred. Used inside a ":while".
21744 func_has_ended(cookie)
21745 void *cookie;
21747 funccall_T *fcp = (funccall_T *)cookie;
21749 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21750 * an error inside a try conditional. */
21751 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21752 || fcp->returned);
21756 * return TRUE if cookie indicates a function which "abort"s on errors.
21759 func_has_abort(cookie)
21760 void *cookie;
21762 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21765 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21766 typedef enum
21768 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21769 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21770 VAR_FLAVOUR_VIMINFO /* all uppercase */
21771 } var_flavour_T;
21773 static var_flavour_T var_flavour __ARGS((char_u *varname));
21775 static var_flavour_T
21776 var_flavour(varname)
21777 char_u *varname;
21779 char_u *p = varname;
21781 if (ASCII_ISUPPER(*p))
21783 while (*(++p))
21784 if (ASCII_ISLOWER(*p))
21785 return VAR_FLAVOUR_SESSION;
21786 return VAR_FLAVOUR_VIMINFO;
21788 else
21789 return VAR_FLAVOUR_DEFAULT;
21791 #endif
21793 #if defined(FEAT_VIMINFO) || defined(PROTO)
21795 * Restore global vars that start with a capital from the viminfo file
21798 read_viminfo_varlist(virp, writing)
21799 vir_T *virp;
21800 int writing;
21802 char_u *tab;
21803 int type = VAR_NUMBER;
21804 typval_T tv;
21806 if (!writing && (find_viminfo_parameter('!') != NULL))
21808 tab = vim_strchr(virp->vir_line + 1, '\t');
21809 if (tab != NULL)
21811 *tab++ = '\0'; /* isolate the variable name */
21812 if (*tab == 'S') /* string var */
21813 type = VAR_STRING;
21814 #ifdef FEAT_FLOAT
21815 else if (*tab == 'F')
21816 type = VAR_FLOAT;
21817 #endif
21819 tab = vim_strchr(tab, '\t');
21820 if (tab != NULL)
21822 tv.v_type = type;
21823 if (type == VAR_STRING)
21824 tv.vval.v_string = viminfo_readstring(virp,
21825 (int)(tab - virp->vir_line + 1), TRUE);
21826 #ifdef FEAT_FLOAT
21827 else if (type == VAR_FLOAT)
21828 (void)string2float(tab + 1, &tv.vval.v_float);
21829 #endif
21830 else
21831 tv.vval.v_number = atol((char *)tab + 1);
21832 set_var(virp->vir_line + 1, &tv, FALSE);
21833 if (type == VAR_STRING)
21834 vim_free(tv.vval.v_string);
21839 return viminfo_readline(virp);
21843 * Write global vars that start with a capital to the viminfo file
21845 void
21846 write_viminfo_varlist(fp)
21847 FILE *fp;
21849 hashitem_T *hi;
21850 dictitem_T *this_var;
21851 int todo;
21852 char *s;
21853 char_u *p;
21854 char_u *tofree;
21855 char_u numbuf[NUMBUFLEN];
21857 if (find_viminfo_parameter('!') == NULL)
21858 return;
21860 fprintf(fp, _("\n# global variables:\n"));
21862 todo = (int)globvarht.ht_used;
21863 for (hi = globvarht.ht_array; todo > 0; ++hi)
21865 if (!HASHITEM_EMPTY(hi))
21867 --todo;
21868 this_var = HI2DI(hi);
21869 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21871 switch (this_var->di_tv.v_type)
21873 case VAR_STRING: s = "STR"; break;
21874 case VAR_NUMBER: s = "NUM"; break;
21875 #ifdef FEAT_FLOAT
21876 case VAR_FLOAT: s = "FLO"; break;
21877 #endif
21878 default: continue;
21880 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21881 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21882 if (p != NULL)
21883 viminfo_writestring(fp, p);
21884 vim_free(tofree);
21889 #endif
21891 #if defined(FEAT_SESSION) || defined(PROTO)
21893 store_session_globals(fd)
21894 FILE *fd;
21896 hashitem_T *hi;
21897 dictitem_T *this_var;
21898 int todo;
21899 char_u *p, *t;
21901 todo = (int)globvarht.ht_used;
21902 for (hi = globvarht.ht_array; todo > 0; ++hi)
21904 if (!HASHITEM_EMPTY(hi))
21906 --todo;
21907 this_var = HI2DI(hi);
21908 if ((this_var->di_tv.v_type == VAR_NUMBER
21909 || this_var->di_tv.v_type == VAR_STRING)
21910 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21912 /* Escape special characters with a backslash. Turn a LF and
21913 * CR into \n and \r. */
21914 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
21915 (char_u *)"\\\"\n\r");
21916 if (p == NULL) /* out of memory */
21917 break;
21918 for (t = p; *t != NUL; ++t)
21919 if (*t == '\n')
21920 *t = 'n';
21921 else if (*t == '\r')
21922 *t = 'r';
21923 if ((fprintf(fd, "let %s = %c%s%c",
21924 this_var->di_key,
21925 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21926 : ' ',
21928 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21929 : ' ') < 0)
21930 || put_eol(fd) == FAIL)
21932 vim_free(p);
21933 return FAIL;
21935 vim_free(p);
21937 #ifdef FEAT_FLOAT
21938 else if (this_var->di_tv.v_type == VAR_FLOAT
21939 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21941 float_T f = this_var->di_tv.vval.v_float;
21942 int sign = ' ';
21944 if (f < 0)
21946 f = -f;
21947 sign = '-';
21949 if ((fprintf(fd, "let %s = %c&%f",
21950 this_var->di_key, sign, f) < 0)
21951 || put_eol(fd) == FAIL)
21952 return FAIL;
21954 #endif
21957 return OK;
21959 #endif
21962 * Display script name where an item was last set.
21963 * Should only be invoked when 'verbose' is non-zero.
21965 void
21966 last_set_msg(scriptID)
21967 scid_T scriptID;
21969 char_u *p;
21971 if (scriptID != 0)
21973 p = home_replace_save(NULL, get_scriptname(scriptID));
21974 if (p != NULL)
21976 verbose_enter();
21977 MSG_PUTS(_("\n\tLast set from "));
21978 MSG_PUTS(p);
21979 vim_free(p);
21980 verbose_leave();
21986 * List v:oldfiles in a nice way.
21988 void
21989 ex_oldfiles(eap)
21990 exarg_T *eap UNUSED;
21992 list_T *l = vimvars[VV_OLDFILES].vv_list;
21993 listitem_T *li;
21994 int nr = 0;
21996 if (l == NULL)
21997 msg((char_u *)_("No old files"));
21998 else
22000 msg_start();
22001 msg_scroll = TRUE;
22002 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22004 msg_outnum((long)++nr);
22005 MSG_PUTS(": ");
22006 msg_outtrans(get_tv_string(&li->li_tv));
22007 msg_putchar('\n');
22008 out_flush(); /* output one line at a time */
22009 ui_breakcheck();
22011 /* Assume "got_int" was set to truncate the listing. */
22012 got_int = FALSE;
22014 #ifdef FEAT_BROWSE_CMD
22015 if (cmdmod.browse)
22017 quit_more = FALSE;
22018 nr = prompt_for_number(FALSE);
22019 msg_starthere();
22020 if (nr > 0)
22022 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22023 (long)nr);
22025 if (p != NULL)
22027 p = expand_env_save(p);
22028 eap->arg = p;
22029 eap->cmdidx = CMD_edit;
22030 cmdmod.browse = FALSE;
22031 do_exedit(eap, NULL);
22032 vim_free(p);
22036 #endif
22040 #endif /* FEAT_EVAL */
22043 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22045 #ifdef WIN3264
22047 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22049 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22050 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22051 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22054 * Get the short path (8.3) for the filename in "fnamep".
22055 * Only works for a valid file name.
22056 * When the path gets longer "fnamep" is changed and the allocated buffer
22057 * is put in "bufp".
22058 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22059 * Returns OK on success, FAIL on failure.
22061 static int
22062 get_short_pathname(fnamep, bufp, fnamelen)
22063 char_u **fnamep;
22064 char_u **bufp;
22065 int *fnamelen;
22067 int l, len;
22068 char_u *newbuf;
22070 len = *fnamelen;
22071 l = GetShortPathName(*fnamep, *fnamep, len);
22072 if (l > len - 1)
22074 /* If that doesn't work (not enough space), then save the string
22075 * and try again with a new buffer big enough. */
22076 newbuf = vim_strnsave(*fnamep, l);
22077 if (newbuf == NULL)
22078 return FAIL;
22080 vim_free(*bufp);
22081 *fnamep = *bufp = newbuf;
22083 /* Really should always succeed, as the buffer is big enough. */
22084 l = GetShortPathName(*fnamep, *fnamep, l+1);
22087 *fnamelen = l;
22088 return OK;
22092 * Get the short path (8.3) for the filename in "fname". The converted
22093 * path is returned in "bufp".
22095 * Some of the directories specified in "fname" may not exist. This function
22096 * will shorten the existing directories at the beginning of the path and then
22097 * append the remaining non-existing path.
22099 * fname - Pointer to the filename to shorten. On return, contains the
22100 * pointer to the shortened pathname
22101 * bufp - Pointer to an allocated buffer for the filename.
22102 * fnamelen - Length of the filename pointed to by fname
22104 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22106 static int
22107 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22108 char_u **fname;
22109 char_u **bufp;
22110 int *fnamelen;
22112 char_u *short_fname, *save_fname, *pbuf_unused;
22113 char_u *endp, *save_endp;
22114 char_u ch;
22115 int old_len, len;
22116 int new_len, sfx_len;
22117 int retval = OK;
22119 /* Make a copy */
22120 old_len = *fnamelen;
22121 save_fname = vim_strnsave(*fname, old_len);
22122 pbuf_unused = NULL;
22123 short_fname = NULL;
22125 endp = save_fname + old_len - 1; /* Find the end of the copy */
22126 save_endp = endp;
22129 * Try shortening the supplied path till it succeeds by removing one
22130 * directory at a time from the tail of the path.
22132 len = 0;
22133 for (;;)
22135 /* go back one path-separator */
22136 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22137 --endp;
22138 if (endp <= save_fname)
22139 break; /* processed the complete path */
22142 * Replace the path separator with a NUL and try to shorten the
22143 * resulting path.
22145 ch = *endp;
22146 *endp = 0;
22147 short_fname = save_fname;
22148 len = (int)STRLEN(short_fname) + 1;
22149 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22151 retval = FAIL;
22152 goto theend;
22154 *endp = ch; /* preserve the string */
22156 if (len > 0)
22157 break; /* successfully shortened the path */
22159 /* failed to shorten the path. Skip the path separator */
22160 --endp;
22163 if (len > 0)
22166 * Succeeded in shortening the path. Now concatenate the shortened
22167 * path with the remaining path at the tail.
22170 /* Compute the length of the new path. */
22171 sfx_len = (int)(save_endp - endp) + 1;
22172 new_len = len + sfx_len;
22174 *fnamelen = new_len;
22175 vim_free(*bufp);
22176 if (new_len > old_len)
22178 /* There is not enough space in the currently allocated string,
22179 * copy it to a buffer big enough. */
22180 *fname = *bufp = vim_strnsave(short_fname, new_len);
22181 if (*fname == NULL)
22183 retval = FAIL;
22184 goto theend;
22187 else
22189 /* Transfer short_fname to the main buffer (it's big enough),
22190 * unless get_short_pathname() did its work in-place. */
22191 *fname = *bufp = save_fname;
22192 if (short_fname != save_fname)
22193 vim_strncpy(save_fname, short_fname, len);
22194 save_fname = NULL;
22197 /* concat the not-shortened part of the path */
22198 vim_strncpy(*fname + len, endp, sfx_len);
22199 (*fname)[new_len] = NUL;
22202 theend:
22203 vim_free(pbuf_unused);
22204 vim_free(save_fname);
22206 return retval;
22210 * Get a pathname for a partial path.
22211 * Returns OK for success, FAIL for failure.
22213 static int
22214 shortpath_for_partial(fnamep, bufp, fnamelen)
22215 char_u **fnamep;
22216 char_u **bufp;
22217 int *fnamelen;
22219 int sepcount, len, tflen;
22220 char_u *p;
22221 char_u *pbuf, *tfname;
22222 int hasTilde;
22224 /* Count up the path separators from the RHS.. so we know which part
22225 * of the path to return. */
22226 sepcount = 0;
22227 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22228 if (vim_ispathsep(*p))
22229 ++sepcount;
22231 /* Need full path first (use expand_env() to remove a "~/") */
22232 hasTilde = (**fnamep == '~');
22233 if (hasTilde)
22234 pbuf = tfname = expand_env_save(*fnamep);
22235 else
22236 pbuf = tfname = FullName_save(*fnamep, FALSE);
22238 len = tflen = (int)STRLEN(tfname);
22240 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22241 return FAIL;
22243 if (len == 0)
22245 /* Don't have a valid filename, so shorten the rest of the
22246 * path if we can. This CAN give us invalid 8.3 filenames, but
22247 * there's not a lot of point in guessing what it might be.
22249 len = tflen;
22250 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22251 return FAIL;
22254 /* Count the paths backward to find the beginning of the desired string. */
22255 for (p = tfname + len - 1; p >= tfname; --p)
22257 #ifdef FEAT_MBYTE
22258 if (has_mbyte)
22259 p -= mb_head_off(tfname, p);
22260 #endif
22261 if (vim_ispathsep(*p))
22263 if (sepcount == 0 || (hasTilde && sepcount == 1))
22264 break;
22265 else
22266 sepcount --;
22269 if (hasTilde)
22271 --p;
22272 if (p >= tfname)
22273 *p = '~';
22274 else
22275 return FAIL;
22277 else
22278 ++p;
22280 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22281 vim_free(*bufp);
22282 *fnamelen = (int)STRLEN(p);
22283 *bufp = pbuf;
22284 *fnamep = p;
22286 return OK;
22288 #endif /* WIN3264 */
22291 * Adjust a filename, according to a string of modifiers.
22292 * *fnamep must be NUL terminated when called. When returning, the length is
22293 * determined by *fnamelen.
22294 * Returns VALID_ flags or -1 for failure.
22295 * When there is an error, *fnamep is set to NULL.
22298 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22299 char_u *src; /* string with modifiers */
22300 int *usedlen; /* characters after src that are used */
22301 char_u **fnamep; /* file name so far */
22302 char_u **bufp; /* buffer for allocated file name or NULL */
22303 int *fnamelen; /* length of fnamep */
22305 int valid = 0;
22306 char_u *tail;
22307 char_u *s, *p, *pbuf;
22308 char_u dirname[MAXPATHL];
22309 int c;
22310 int has_fullname = 0;
22311 #ifdef WIN3264
22312 int has_shortname = 0;
22313 #endif
22315 repeat:
22316 /* ":p" - full path/file_name */
22317 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22319 has_fullname = 1;
22321 valid |= VALID_PATH;
22322 *usedlen += 2;
22324 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22325 if ((*fnamep)[0] == '~'
22326 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22327 && ((*fnamep)[1] == '/'
22328 # ifdef BACKSLASH_IN_FILENAME
22329 || (*fnamep)[1] == '\\'
22330 # endif
22331 || (*fnamep)[1] == NUL)
22333 #endif
22336 *fnamep = expand_env_save(*fnamep);
22337 vim_free(*bufp); /* free any allocated file name */
22338 *bufp = *fnamep;
22339 if (*fnamep == NULL)
22340 return -1;
22343 /* When "/." or "/.." is used: force expansion to get rid of it. */
22344 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22346 if (vim_ispathsep(*p)
22347 && p[1] == '.'
22348 && (p[2] == NUL
22349 || vim_ispathsep(p[2])
22350 || (p[2] == '.'
22351 && (p[3] == NUL || vim_ispathsep(p[3])))))
22352 break;
22355 /* FullName_save() is slow, don't use it when not needed. */
22356 if (*p != NUL || !vim_isAbsName(*fnamep))
22358 *fnamep = FullName_save(*fnamep, *p != NUL);
22359 vim_free(*bufp); /* free any allocated file name */
22360 *bufp = *fnamep;
22361 if (*fnamep == NULL)
22362 return -1;
22365 /* Append a path separator to a directory. */
22366 if (mch_isdir(*fnamep))
22368 /* Make room for one or two extra characters. */
22369 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22370 vim_free(*bufp); /* free any allocated file name */
22371 *bufp = *fnamep;
22372 if (*fnamep == NULL)
22373 return -1;
22374 add_pathsep(*fnamep);
22378 /* ":." - path relative to the current directory */
22379 /* ":~" - path relative to the home directory */
22380 /* ":8" - shortname path - postponed till after */
22381 while (src[*usedlen] == ':'
22382 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22384 *usedlen += 2;
22385 if (c == '8')
22387 #ifdef WIN3264
22388 has_shortname = 1; /* Postpone this. */
22389 #endif
22390 continue;
22392 pbuf = NULL;
22393 /* Need full path first (use expand_env() to remove a "~/") */
22394 if (!has_fullname)
22396 if (c == '.' && **fnamep == '~')
22397 p = pbuf = expand_env_save(*fnamep);
22398 else
22399 p = pbuf = FullName_save(*fnamep, FALSE);
22401 else
22402 p = *fnamep;
22404 has_fullname = 0;
22406 if (p != NULL)
22408 if (c == '.')
22410 mch_dirname(dirname, MAXPATHL);
22411 s = shorten_fname(p, dirname);
22412 if (s != NULL)
22414 *fnamep = s;
22415 if (pbuf != NULL)
22417 vim_free(*bufp); /* free any allocated file name */
22418 *bufp = pbuf;
22419 pbuf = NULL;
22423 else
22425 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22426 /* Only replace it when it starts with '~' */
22427 if (*dirname == '~')
22429 s = vim_strsave(dirname);
22430 if (s != NULL)
22432 *fnamep = s;
22433 vim_free(*bufp);
22434 *bufp = s;
22438 vim_free(pbuf);
22442 tail = gettail(*fnamep);
22443 *fnamelen = (int)STRLEN(*fnamep);
22445 /* ":h" - head, remove "/file_name", can be repeated */
22446 /* Don't remove the first "/" or "c:\" */
22447 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22449 valid |= VALID_HEAD;
22450 *usedlen += 2;
22451 s = get_past_head(*fnamep);
22452 while (tail > s && after_pathsep(s, tail))
22453 mb_ptr_back(*fnamep, tail);
22454 *fnamelen = (int)(tail - *fnamep);
22455 #ifdef VMS
22456 if (*fnamelen > 0)
22457 *fnamelen += 1; /* the path separator is part of the path */
22458 #endif
22459 if (*fnamelen == 0)
22461 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22462 p = vim_strsave((char_u *)".");
22463 if (p == NULL)
22464 return -1;
22465 vim_free(*bufp);
22466 *bufp = *fnamep = tail = p;
22467 *fnamelen = 1;
22469 else
22471 while (tail > s && !after_pathsep(s, tail))
22472 mb_ptr_back(*fnamep, tail);
22476 /* ":8" - shortname */
22477 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22479 *usedlen += 2;
22480 #ifdef WIN3264
22481 has_shortname = 1;
22482 #endif
22485 #ifdef WIN3264
22486 /* Check shortname after we have done 'heads' and before we do 'tails'
22488 if (has_shortname)
22490 pbuf = NULL;
22491 /* Copy the string if it is shortened by :h */
22492 if (*fnamelen < (int)STRLEN(*fnamep))
22494 p = vim_strnsave(*fnamep, *fnamelen);
22495 if (p == 0)
22496 return -1;
22497 vim_free(*bufp);
22498 *bufp = *fnamep = p;
22501 /* Split into two implementations - makes it easier. First is where
22502 * there isn't a full name already, second is where there is.
22504 if (!has_fullname && !vim_isAbsName(*fnamep))
22506 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22507 return -1;
22509 else
22511 int l;
22513 /* Simple case, already have the full-name
22514 * Nearly always shorter, so try first time. */
22515 l = *fnamelen;
22516 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22517 return -1;
22519 if (l == 0)
22521 /* Couldn't find the filename.. search the paths.
22523 l = *fnamelen;
22524 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22525 return -1;
22527 *fnamelen = l;
22530 #endif /* WIN3264 */
22532 /* ":t" - tail, just the basename */
22533 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22535 *usedlen += 2;
22536 *fnamelen -= (int)(tail - *fnamep);
22537 *fnamep = tail;
22540 /* ":e" - extension, can be repeated */
22541 /* ":r" - root, without extension, can be repeated */
22542 while (src[*usedlen] == ':'
22543 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22545 /* find a '.' in the tail:
22546 * - for second :e: before the current fname
22547 * - otherwise: The last '.'
22549 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22550 s = *fnamep - 2;
22551 else
22552 s = *fnamep + *fnamelen - 1;
22553 for ( ; s > tail; --s)
22554 if (s[0] == '.')
22555 break;
22556 if (src[*usedlen + 1] == 'e') /* :e */
22558 if (s > tail)
22560 *fnamelen += (int)(*fnamep - (s + 1));
22561 *fnamep = s + 1;
22562 #ifdef VMS
22563 /* cut version from the extension */
22564 s = *fnamep + *fnamelen - 1;
22565 for ( ; s > *fnamep; --s)
22566 if (s[0] == ';')
22567 break;
22568 if (s > *fnamep)
22569 *fnamelen = s - *fnamep;
22570 #endif
22572 else if (*fnamep <= tail)
22573 *fnamelen = 0;
22575 else /* :r */
22577 if (s > tail) /* remove one extension */
22578 *fnamelen = (int)(s - *fnamep);
22580 *usedlen += 2;
22583 /* ":s?pat?foo?" - substitute */
22584 /* ":gs?pat?foo?" - global substitute */
22585 if (src[*usedlen] == ':'
22586 && (src[*usedlen + 1] == 's'
22587 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22589 char_u *str;
22590 char_u *pat;
22591 char_u *sub;
22592 int sep;
22593 char_u *flags;
22594 int didit = FALSE;
22596 flags = (char_u *)"";
22597 s = src + *usedlen + 2;
22598 if (src[*usedlen + 1] == 'g')
22600 flags = (char_u *)"g";
22601 ++s;
22604 sep = *s++;
22605 if (sep)
22607 /* find end of pattern */
22608 p = vim_strchr(s, sep);
22609 if (p != NULL)
22611 pat = vim_strnsave(s, (int)(p - s));
22612 if (pat != NULL)
22614 s = p + 1;
22615 /* find end of substitution */
22616 p = vim_strchr(s, sep);
22617 if (p != NULL)
22619 sub = vim_strnsave(s, (int)(p - s));
22620 str = vim_strnsave(*fnamep, *fnamelen);
22621 if (sub != NULL && str != NULL)
22623 *usedlen = (int)(p + 1 - src);
22624 s = do_string_sub(str, pat, sub, flags);
22625 if (s != NULL)
22627 *fnamep = s;
22628 *fnamelen = (int)STRLEN(s);
22629 vim_free(*bufp);
22630 *bufp = s;
22631 didit = TRUE;
22634 vim_free(sub);
22635 vim_free(str);
22637 vim_free(pat);
22640 /* after using ":s", repeat all the modifiers */
22641 if (didit)
22642 goto repeat;
22646 return valid;
22650 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22651 * "flags" can be "g" to do a global substitute.
22652 * Returns an allocated string, NULL for error.
22654 char_u *
22655 do_string_sub(str, pat, sub, flags)
22656 char_u *str;
22657 char_u *pat;
22658 char_u *sub;
22659 char_u *flags;
22661 int sublen;
22662 regmatch_T regmatch;
22663 int i;
22664 int do_all;
22665 char_u *tail;
22666 garray_T ga;
22667 char_u *ret;
22668 char_u *save_cpo;
22670 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22671 save_cpo = p_cpo;
22672 p_cpo = empty_option;
22674 ga_init2(&ga, 1, 200);
22676 do_all = (flags[0] == 'g');
22678 regmatch.rm_ic = p_ic;
22679 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22680 if (regmatch.regprog != NULL)
22682 tail = str;
22683 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22686 * Get some space for a temporary buffer to do the substitution
22687 * into. It will contain:
22688 * - The text up to where the match is.
22689 * - The substituted text.
22690 * - The text after the match.
22692 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22693 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22694 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22696 ga_clear(&ga);
22697 break;
22700 /* copy the text up to where the match is */
22701 i = (int)(regmatch.startp[0] - tail);
22702 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22703 /* add the substituted text */
22704 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22705 + ga.ga_len + i, TRUE, TRUE, FALSE);
22706 ga.ga_len += i + sublen - 1;
22707 /* avoid getting stuck on a match with an empty string */
22708 if (tail == regmatch.endp[0])
22710 if (*tail == NUL)
22711 break;
22712 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22713 ++ga.ga_len;
22715 else
22717 tail = regmatch.endp[0];
22718 if (*tail == NUL)
22719 break;
22721 if (!do_all)
22722 break;
22725 if (ga.ga_data != NULL)
22726 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22728 vim_free(regmatch.regprog);
22731 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22732 ga_clear(&ga);
22733 if (p_cpo == empty_option)
22734 p_cpo = save_cpo;
22735 else
22736 /* Darn, evaluating {sub} expression changed the value. */
22737 free_string_option(save_cpo);
22739 return ret;
22742 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */