Merge branch 'vim'
[MacVim.git] / src / eval.c
blob8accdd6bab2b5a791a719ef28c468b9eb0f2a5d8
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
11 * eval.c: Expression evaluation.
13 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
14 # include "vimio.h" /* for mch_open(), must be before vim.h */
15 #endif
17 #include "vim.h"
19 #if defined(FEAT_EVAL) || defined(PROTO)
21 #ifdef AMIGA
22 # include <time.h> /* for strftime() */
23 #endif
25 #ifdef MACOS
26 # include <time.h> /* for time_t */
27 #endif
29 #if defined(FEAT_FLOAT) && defined(HAVE_MATH_H)
30 # include <math.h>
31 #endif
33 #define DICT_MAXNEST 100 /* maximum nesting of lists and dicts */
35 #define DO_NOT_FREE_CNT 99999 /* refcount for dict or list that should not
36 be freed. */
39 * In a hashtab item "hi_key" points to "di_key" in a dictitem.
40 * This avoids adding a pointer to the hashtab item.
41 * DI2HIKEY() converts a dictitem pointer to a hashitem key pointer.
42 * HIKEY2DI() converts a hashitem key pointer to a dictitem pointer.
43 * HI2DI() converts a hashitem pointer to a dictitem pointer.
45 static dictitem_T dumdi;
46 #define DI2HIKEY(di) ((di)->di_key)
47 #define HIKEY2DI(p) ((dictitem_T *)(p - (dumdi.di_key - (char_u *)&dumdi)))
48 #define HI2DI(hi) HIKEY2DI((hi)->hi_key)
51 * Structure returned by get_lval() and used by set_var_lval().
52 * For a plain name:
53 * "name" points to the variable name.
54 * "exp_name" is NULL.
55 * "tv" is NULL
56 * For a magic braces name:
57 * "name" points to the expanded variable name.
58 * "exp_name" is non-NULL, to be freed later.
59 * "tv" is NULL
60 * For an index in a list:
61 * "name" points to the (expanded) variable name.
62 * "exp_name" NULL or non-NULL, to be freed later.
63 * "tv" points to the (first) list item value
64 * "li" points to the (first) list item
65 * "range", "n1", "n2" and "empty2" indicate what items are used.
66 * For an existing Dict item:
67 * "name" points to the (expanded) variable name.
68 * "exp_name" NULL or non-NULL, to be freed later.
69 * "tv" points to the dict item value
70 * "newkey" is NULL
71 * For a non-existing Dict item:
72 * "name" points to the (expanded) variable name.
73 * "exp_name" NULL or non-NULL, to be freed later.
74 * "tv" points to the Dictionary typval_T
75 * "newkey" is the key for the new item.
77 typedef struct lval_S
79 char_u *ll_name; /* start of variable name (can be NULL) */
80 char_u *ll_exp_name; /* NULL or expanded name in allocated memory. */
81 typval_T *ll_tv; /* Typeval of item being used. If "newkey"
82 isn't NULL it's the Dict to which to add
83 the item. */
84 listitem_T *ll_li; /* The list item or NULL. */
85 list_T *ll_list; /* The list or NULL. */
86 int ll_range; /* TRUE when a [i:j] range was used */
87 long ll_n1; /* First index for list */
88 long ll_n2; /* Second index for list range */
89 int ll_empty2; /* Second index is empty: [i:] */
90 dict_T *ll_dict; /* The Dictionary or NULL */
91 dictitem_T *ll_di; /* The dictitem or NULL */
92 char_u *ll_newkey; /* New key for Dict in alloc. mem or NULL. */
93 } lval_T;
96 static char *e_letunexp = N_("E18: Unexpected characters in :let");
97 static char *e_listidx = N_("E684: list index out of range: %ld");
98 static char *e_undefvar = N_("E121: Undefined variable: %s");
99 static char *e_missbrac = N_("E111: Missing ']'");
100 static char *e_listarg = N_("E686: Argument of %s must be a List");
101 static char *e_listdictarg = N_("E712: Argument of %s must be a List or Dictionary");
102 static char *e_emptykey = N_("E713: Cannot use empty key for Dictionary");
103 static char *e_listreq = N_("E714: List required");
104 static char *e_dictreq = N_("E715: Dictionary required");
105 static char *e_toomanyarg = N_("E118: Too many arguments for function: %s");
106 static char *e_dictkey = N_("E716: Key not present in Dictionary: %s");
107 static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
108 static char *e_funcdict = N_("E717: Dictionary entry already exists");
109 static char *e_funcref = N_("E718: Funcref required");
110 static char *e_dictrange = N_("E719: Cannot use [:] with a Dictionary");
111 static char *e_letwrong = N_("E734: Wrong variable type for %s=");
112 static char *e_nofunc = N_("E130: Unknown function: %s");
113 static char *e_illvar = N_("E461: Illegal variable name: %s");
116 * All user-defined global variables are stored in dictionary "globvardict".
117 * "globvars_var" is the variable that is used for "g:".
119 static dict_T globvardict;
120 static dictitem_T globvars_var;
121 #define globvarht globvardict.dv_hashtab
124 * Old Vim variables such as "v:version" are also available without the "v:".
125 * Also in functions. We need a special hashtable for them.
127 static hashtab_T compat_hashtab;
130 * When recursively copying lists and dicts we need to remember which ones we
131 * have done to avoid endless recursiveness. This unique ID is used for that.
132 * The last bit is used for previous_funccal, ignored when comparing.
134 static int current_copyID = 0;
135 #define COPYID_INC 2
136 #define COPYID_MASK (~0x1)
139 * Array to hold the hashtab with variables local to each sourced script.
140 * Each item holds a variable (nameless) that points to the dict_T.
142 typedef struct
144 dictitem_T sv_var;
145 dict_T sv_dict;
146 } scriptvar_T;
148 static garray_T ga_scripts = {0, 0, sizeof(scriptvar_T), 4, NULL};
149 #define SCRIPT_SV(id) (((scriptvar_T *)ga_scripts.ga_data)[(id) - 1])
150 #define SCRIPT_VARS(id) (SCRIPT_SV(id).sv_dict.dv_hashtab)
152 static int echo_attr = 0; /* attributes used for ":echo" */
154 /* Values for trans_function_name() argument: */
155 #define TFN_INT 1 /* internal function name OK */
156 #define TFN_QUIET 2 /* no error messages */
159 * Structure to hold info for a user function.
161 typedef struct ufunc ufunc_T;
163 struct ufunc
165 int uf_varargs; /* variable nr of arguments */
166 int uf_flags;
167 int uf_calls; /* nr of active calls */
168 garray_T uf_args; /* arguments */
169 garray_T uf_lines; /* function lines */
170 #ifdef FEAT_PROFILE
171 int uf_profiling; /* TRUE when func is being profiled */
172 /* profiling the function as a whole */
173 int uf_tm_count; /* nr of calls */
174 proftime_T uf_tm_total; /* time spent in function + children */
175 proftime_T uf_tm_self; /* time spent in function itself */
176 proftime_T uf_tm_children; /* time spent in children this call */
177 /* profiling the function per line */
178 int *uf_tml_count; /* nr of times line was executed */
179 proftime_T *uf_tml_total; /* time spent in a line + children */
180 proftime_T *uf_tml_self; /* time spent in a line itself */
181 proftime_T uf_tml_start; /* start time for current line */
182 proftime_T uf_tml_children; /* time spent in children for this line */
183 proftime_T uf_tml_wait; /* start wait time for current line */
184 int uf_tml_idx; /* index of line being timed; -1 if none */
185 int uf_tml_execed; /* line being timed was executed */
186 #endif
187 scid_T uf_script_ID; /* ID of script where function was defined,
188 used for s: variables */
189 int uf_refcount; /* for numbered function: reference count */
190 char_u uf_name[1]; /* name of function (actually longer); can
191 start with <SNR>123_ (<SNR> is K_SPECIAL
192 KS_EXTRA KE_SNR) */
195 /* function flags */
196 #define FC_ABORT 1 /* abort function on error */
197 #define FC_RANGE 2 /* function accepts range */
198 #define FC_DICT 4 /* Dict function, uses "self" */
201 * All user-defined functions are found in this hashtable.
203 static hashtab_T func_hashtab;
205 /* The names of packages that once were loaded are remembered. */
206 static garray_T ga_loaded = {0, 0, sizeof(char_u *), 4, NULL};
208 /* list heads for garbage collection */
209 static dict_T *first_dict = NULL; /* list of all dicts */
210 static list_T *first_list = NULL; /* list of all lists */
212 /* From user function to hashitem and back. */
213 static ufunc_T dumuf;
214 #define UF2HIKEY(fp) ((fp)->uf_name)
215 #define HIKEY2UF(p) ((ufunc_T *)(p - (dumuf.uf_name - (char_u *)&dumuf)))
216 #define HI2UF(hi) HIKEY2UF((hi)->hi_key)
218 #define FUNCARG(fp, j) ((char_u **)(fp->uf_args.ga_data))[j]
219 #define FUNCLINE(fp, j) ((char_u **)(fp->uf_lines.ga_data))[j]
221 #define MAX_FUNC_ARGS 20 /* maximum number of function arguments */
222 #define VAR_SHORT_LEN 20 /* short variable name length */
223 #define FIXVAR_CNT 12 /* number of fixed variables */
225 /* structure to hold info for a function that is currently being executed. */
226 typedef struct funccall_S funccall_T;
228 struct funccall_S
230 ufunc_T *func; /* function being called */
231 int linenr; /* next line to be executed */
232 int returned; /* ":return" used */
233 struct /* fixed variables for arguments */
235 dictitem_T var; /* variable (without room for name) */
236 char_u room[VAR_SHORT_LEN]; /* room for the name */
237 } fixvar[FIXVAR_CNT];
238 dict_T l_vars; /* l: local function variables */
239 dictitem_T l_vars_var; /* variable for l: scope */
240 dict_T l_avars; /* a: argument variables */
241 dictitem_T l_avars_var; /* variable for a: scope */
242 list_T l_varlist; /* list for a:000 */
243 listitem_T l_listitems[MAX_FUNC_ARGS]; /* listitems for a:000 */
244 typval_T *rettv; /* return value */
245 linenr_T breakpoint; /* next line with breakpoint or zero */
246 int dbg_tick; /* debug_tick when breakpoint was set */
247 int level; /* top nesting level of executed function */
248 #ifdef FEAT_PROFILE
249 proftime_T prof_child; /* time spent in a child */
250 #endif
251 funccall_T *caller; /* calling function or NULL */
255 * Info used by a ":for" loop.
257 typedef struct
259 int fi_semicolon; /* TRUE if ending in '; var]' */
260 int fi_varcount; /* nr of variables in the list */
261 listwatch_T fi_lw; /* keep an eye on the item used. */
262 list_T *fi_list; /* list being used */
263 } forinfo_T;
266 * Struct used by trans_function_name()
268 typedef struct
270 dict_T *fd_dict; /* Dictionary used */
271 char_u *fd_newkey; /* new key in "dict" in allocated memory */
272 dictitem_T *fd_di; /* Dictionary item used */
273 } funcdict_T;
277 * Array to hold the value of v: variables.
278 * The value is in a dictitem, so that it can also be used in the v: scope.
279 * The reason to use this table anyway is for very quick access to the
280 * variables with the VV_ defines.
282 #include "version.h"
284 /* values for vv_flags: */
285 #define VV_COMPAT 1 /* compatible, also used without "v:" */
286 #define VV_RO 2 /* read-only */
287 #define VV_RO_SBX 4 /* read-only in the sandbox */
289 #define VV_NAME(s, t) s, {{t, 0, {0}}, 0, {0}}, {0}
291 static struct vimvar
293 char *vv_name; /* name of variable, without v: */
294 dictitem_T vv_di; /* value and name for key */
295 char vv_filler[16]; /* space for LONGEST name below!!! */
296 char vv_flags; /* VV_COMPAT, VV_RO, VV_RO_SBX */
297 } vimvars[VV_LEN] =
300 * The order here must match the VV_ defines in vim.h!
301 * Initializing a union does not work, leave tv.vval empty to get zero's.
303 {VV_NAME("count", VAR_NUMBER), VV_COMPAT+VV_RO},
304 {VV_NAME("count1", VAR_NUMBER), VV_RO},
305 {VV_NAME("prevcount", VAR_NUMBER), VV_RO},
306 {VV_NAME("errmsg", VAR_STRING), VV_COMPAT},
307 {VV_NAME("warningmsg", VAR_STRING), 0},
308 {VV_NAME("statusmsg", VAR_STRING), 0},
309 {VV_NAME("shell_error", VAR_NUMBER), VV_COMPAT+VV_RO},
310 {VV_NAME("this_session", VAR_STRING), VV_COMPAT},
311 {VV_NAME("version", VAR_NUMBER), VV_COMPAT+VV_RO},
312 {VV_NAME("lnum", VAR_NUMBER), VV_RO_SBX},
313 {VV_NAME("termresponse", VAR_STRING), VV_RO},
314 {VV_NAME("fname", VAR_STRING), VV_RO},
315 {VV_NAME("lang", VAR_STRING), VV_RO},
316 {VV_NAME("lc_time", VAR_STRING), VV_RO},
317 {VV_NAME("ctype", VAR_STRING), VV_RO},
318 {VV_NAME("charconvert_from", VAR_STRING), VV_RO},
319 {VV_NAME("charconvert_to", VAR_STRING), VV_RO},
320 {VV_NAME("fname_in", VAR_STRING), VV_RO},
321 {VV_NAME("fname_out", VAR_STRING), VV_RO},
322 {VV_NAME("fname_new", VAR_STRING), VV_RO},
323 {VV_NAME("fname_diff", VAR_STRING), VV_RO},
324 {VV_NAME("cmdarg", VAR_STRING), VV_RO},
325 {VV_NAME("foldstart", VAR_NUMBER), VV_RO_SBX},
326 {VV_NAME("foldend", VAR_NUMBER), VV_RO_SBX},
327 {VV_NAME("folddashes", VAR_STRING), VV_RO_SBX},
328 {VV_NAME("foldlevel", VAR_NUMBER), VV_RO_SBX},
329 {VV_NAME("progname", VAR_STRING), VV_RO},
330 {VV_NAME("servername", VAR_STRING), VV_RO},
331 {VV_NAME("dying", VAR_NUMBER), VV_RO},
332 {VV_NAME("exception", VAR_STRING), VV_RO},
333 {VV_NAME("throwpoint", VAR_STRING), VV_RO},
334 {VV_NAME("register", VAR_STRING), VV_RO},
335 {VV_NAME("cmdbang", VAR_NUMBER), VV_RO},
336 {VV_NAME("insertmode", VAR_STRING), VV_RO},
337 {VV_NAME("val", VAR_UNKNOWN), VV_RO},
338 {VV_NAME("key", VAR_UNKNOWN), VV_RO},
339 {VV_NAME("profiling", VAR_NUMBER), VV_RO},
340 {VV_NAME("fcs_reason", VAR_STRING), VV_RO},
341 {VV_NAME("fcs_choice", VAR_STRING), 0},
342 {VV_NAME("beval_bufnr", VAR_NUMBER), VV_RO},
343 {VV_NAME("beval_winnr", VAR_NUMBER), VV_RO},
344 {VV_NAME("beval_lnum", VAR_NUMBER), VV_RO},
345 {VV_NAME("beval_col", VAR_NUMBER), VV_RO},
346 {VV_NAME("beval_text", VAR_STRING), VV_RO},
347 {VV_NAME("scrollstart", VAR_STRING), 0},
348 {VV_NAME("swapname", VAR_STRING), VV_RO},
349 {VV_NAME("swapchoice", VAR_STRING), 0},
350 {VV_NAME("swapcommand", VAR_STRING), VV_RO},
351 {VV_NAME("char", VAR_STRING), VV_RO},
352 {VV_NAME("mouse_win", VAR_NUMBER), 0},
353 {VV_NAME("mouse_lnum", VAR_NUMBER), 0},
354 {VV_NAME("mouse_col", VAR_NUMBER), 0},
355 {VV_NAME("operator", VAR_STRING), VV_RO},
356 {VV_NAME("searchforward", VAR_NUMBER), 0},
357 {VV_NAME("oldfiles", VAR_LIST), 0},
360 /* shorthand */
361 #define vv_type vv_di.di_tv.v_type
362 #define vv_nr vv_di.di_tv.vval.v_number
363 #define vv_float vv_di.di_tv.vval.v_float
364 #define vv_str vv_di.di_tv.vval.v_string
365 #define vv_list vv_di.di_tv.vval.v_list
366 #define vv_tv vv_di.di_tv
369 * The v: variables are stored in dictionary "vimvardict".
370 * "vimvars_var" is the variable that is used for the "l:" scope.
372 static dict_T vimvardict;
373 static dictitem_T vimvars_var;
374 #define vimvarht vimvardict.dv_hashtab
376 static void prepare_vimvar __ARGS((int idx, typval_T *save_tv));
377 static void restore_vimvar __ARGS((int idx, typval_T *save_tv));
378 #if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
379 static int call_vim_function __ARGS((char_u *func, int argc, char_u **argv, int safe, typval_T *rettv));
380 #endif
381 static int ex_let_vars __ARGS((char_u *arg, typval_T *tv, int copy, int semicolon, int var_count, char_u *nextchars));
382 static char_u *skip_var_list __ARGS((char_u *arg, int *var_count, int *semicolon));
383 static char_u *skip_var_one __ARGS((char_u *arg));
384 static void list_hashtable_vars __ARGS((hashtab_T *ht, char_u *prefix, int empty, int *first));
385 static void list_glob_vars __ARGS((int *first));
386 static void list_buf_vars __ARGS((int *first));
387 static void list_win_vars __ARGS((int *first));
388 #ifdef FEAT_WINDOWS
389 static void list_tab_vars __ARGS((int *first));
390 #endif
391 static void list_vim_vars __ARGS((int *first));
392 static void list_script_vars __ARGS((int *first));
393 static void list_func_vars __ARGS((int *first));
394 static char_u *list_arg_vars __ARGS((exarg_T *eap, char_u *arg, int *first));
395 static char_u *ex_let_one __ARGS((char_u *arg, typval_T *tv, int copy, char_u *endchars, char_u *op));
396 static int check_changedtick __ARGS((char_u *arg));
397 static char_u *get_lval __ARGS((char_u *name, typval_T *rettv, lval_T *lp, int unlet, int skip, int quiet, int fne_flags));
398 static void clear_lval __ARGS((lval_T *lp));
399 static void set_var_lval __ARGS((lval_T *lp, char_u *endp, typval_T *rettv, int copy, char_u *op));
400 static int tv_op __ARGS((typval_T *tv1, typval_T *tv2, char_u *op));
401 static void list_add_watch __ARGS((list_T *l, listwatch_T *lw));
402 static void list_rem_watch __ARGS((list_T *l, listwatch_T *lwrem));
403 static void list_fix_watch __ARGS((list_T *l, listitem_T *item));
404 static void ex_unletlock __ARGS((exarg_T *eap, char_u *argstart, int deep));
405 static int do_unlet_var __ARGS((lval_T *lp, char_u *name_end, int forceit));
406 static int do_lock_var __ARGS((lval_T *lp, char_u *name_end, int deep, int lock));
407 static void item_lock __ARGS((typval_T *tv, int deep, int lock));
408 static int tv_islocked __ARGS((typval_T *tv));
410 static int eval0 __ARGS((char_u *arg, typval_T *rettv, char_u **nextcmd, int evaluate));
411 static int eval1 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
412 static int eval2 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
413 static int eval3 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
414 static int eval4 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
415 static int eval5 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
416 static int eval6 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
417 static int eval7 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
419 static int eval_index __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
420 static int get_option_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
421 static int get_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
422 static int get_lit_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
423 static int get_list_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
424 static int rettv_list_alloc __ARGS((typval_T *rettv));
425 static listitem_T *listitem_alloc __ARGS((void));
426 static void listitem_free __ARGS((listitem_T *item));
427 static void listitem_remove __ARGS((list_T *l, listitem_T *item));
428 static long list_len __ARGS((list_T *l));
429 static int list_equal __ARGS((list_T *l1, list_T *l2, int ic));
430 static int dict_equal __ARGS((dict_T *d1, dict_T *d2, int ic));
431 static int tv_equal __ARGS((typval_T *tv1, typval_T *tv2, int ic));
432 static listitem_T *list_find __ARGS((list_T *l, long n));
433 static long list_find_nr __ARGS((list_T *l, long idx, int *errorp));
434 static long list_idx_of_item __ARGS((list_T *l, listitem_T *item));
435 static void list_append __ARGS((list_T *l, listitem_T *item));
436 static int list_append_number __ARGS((list_T *l, varnumber_T n));
437 static int list_insert_tv __ARGS((list_T *l, typval_T *tv, listitem_T *item));
438 static int list_extend __ARGS((list_T *l1, list_T *l2, listitem_T *bef));
439 static int list_concat __ARGS((list_T *l1, list_T *l2, typval_T *tv));
440 static list_T *list_copy __ARGS((list_T *orig, int deep, int copyID));
441 static void list_remove __ARGS((list_T *l, listitem_T *item, listitem_T *item2));
442 static char_u *list2string __ARGS((typval_T *tv, int copyID));
443 static int list_join __ARGS((garray_T *gap, list_T *l, char_u *sep, int echo, int copyID));
444 static int free_unref_items __ARGS((int copyID));
445 static void set_ref_in_ht __ARGS((hashtab_T *ht, int copyID));
446 static void set_ref_in_list __ARGS((list_T *l, int copyID));
447 static void set_ref_in_item __ARGS((typval_T *tv, int copyID));
448 static void dict_unref __ARGS((dict_T *d));
449 static void dict_free __ARGS((dict_T *d, int recurse));
450 static dictitem_T *dictitem_copy __ARGS((dictitem_T *org));
451 static void dictitem_remove __ARGS((dict_T *dict, dictitem_T *item));
452 static dict_T *dict_copy __ARGS((dict_T *orig, int deep, int copyID));
453 static long dict_len __ARGS((dict_T *d));
454 static dictitem_T *dict_find __ARGS((dict_T *d, char_u *key, int len));
455 static char_u *dict2string __ARGS((typval_T *tv, int copyID));
456 static int get_dict_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
457 static char_u *echo_string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
458 static char_u *tv2string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
459 static char_u *string_quote __ARGS((char_u *str, int function));
460 #ifdef FEAT_FLOAT
461 static int string2float __ARGS((char_u *text, float_T *value));
462 #endif
463 static int get_env_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
464 static int find_internal_func __ARGS((char_u *name));
465 static char_u *deref_func_name __ARGS((char_u *name, int *lenp));
466 static int get_func_tv __ARGS((char_u *name, int len, typval_T *rettv, char_u **arg, linenr_T firstline, linenr_T lastline, int *doesrange, int evaluate, dict_T *selfdict));
467 static int call_func __ARGS((char_u *name, int len, typval_T *rettv, int argcount, typval_T *argvars, linenr_T firstline, linenr_T lastline, int *doesrange, int evaluate, dict_T *selfdict));
468 static void emsg_funcname __ARGS((char *ermsg, char_u *name));
469 static int non_zero_arg __ARGS((typval_T *argvars));
471 #ifdef FEAT_FLOAT
472 static void f_abs __ARGS((typval_T *argvars, typval_T *rettv));
473 #endif
474 static void f_add __ARGS((typval_T *argvars, typval_T *rettv));
475 static void f_append __ARGS((typval_T *argvars, typval_T *rettv));
476 static void f_argc __ARGS((typval_T *argvars, typval_T *rettv));
477 static void f_argidx __ARGS((typval_T *argvars, typval_T *rettv));
478 static void f_argv __ARGS((typval_T *argvars, typval_T *rettv));
479 #ifdef FEAT_FLOAT
480 static void f_atan __ARGS((typval_T *argvars, typval_T *rettv));
481 #endif
482 static void f_browse __ARGS((typval_T *argvars, typval_T *rettv));
483 static void f_browsedir __ARGS((typval_T *argvars, typval_T *rettv));
484 static void f_bufexists __ARGS((typval_T *argvars, typval_T *rettv));
485 static void f_buflisted __ARGS((typval_T *argvars, typval_T *rettv));
486 static void f_bufloaded __ARGS((typval_T *argvars, typval_T *rettv));
487 static void f_bufname __ARGS((typval_T *argvars, typval_T *rettv));
488 static void f_bufnr __ARGS((typval_T *argvars, typval_T *rettv));
489 static void f_bufwinnr __ARGS((typval_T *argvars, typval_T *rettv));
490 static void f_byte2line __ARGS((typval_T *argvars, typval_T *rettv));
491 static void f_byteidx __ARGS((typval_T *argvars, typval_T *rettv));
492 static void f_call __ARGS((typval_T *argvars, typval_T *rettv));
493 #ifdef FEAT_FLOAT
494 static void f_ceil __ARGS((typval_T *argvars, typval_T *rettv));
495 #endif
496 static void f_changenr __ARGS((typval_T *argvars, typval_T *rettv));
497 static void f_char2nr __ARGS((typval_T *argvars, typval_T *rettv));
498 static void f_cindent __ARGS((typval_T *argvars, typval_T *rettv));
499 static void f_clearmatches __ARGS((typval_T *argvars, typval_T *rettv));
500 static void f_col __ARGS((typval_T *argvars, typval_T *rettv));
501 #if defined(FEAT_INS_EXPAND)
502 static void f_complete __ARGS((typval_T *argvars, typval_T *rettv));
503 static void f_complete_add __ARGS((typval_T *argvars, typval_T *rettv));
504 static void f_complete_check __ARGS((typval_T *argvars, typval_T *rettv));
505 #endif
506 static void f_confirm __ARGS((typval_T *argvars, typval_T *rettv));
507 static void f_copy __ARGS((typval_T *argvars, typval_T *rettv));
508 #ifdef FEAT_FLOAT
509 static void f_cos __ARGS((typval_T *argvars, typval_T *rettv));
510 #endif
511 static void f_count __ARGS((typval_T *argvars, typval_T *rettv));
512 static void f_cscope_connection __ARGS((typval_T *argvars, typval_T *rettv));
513 static void f_cursor __ARGS((typval_T *argsvars, typval_T *rettv));
514 static void f_deepcopy __ARGS((typval_T *argvars, typval_T *rettv));
515 static void f_delete __ARGS((typval_T *argvars, typval_T *rettv));
516 static void f_did_filetype __ARGS((typval_T *argvars, typval_T *rettv));
517 static void f_diff_filler __ARGS((typval_T *argvars, typval_T *rettv));
518 static void f_diff_hlID __ARGS((typval_T *argvars, typval_T *rettv));
519 static void f_empty __ARGS((typval_T *argvars, typval_T *rettv));
520 static void f_escape __ARGS((typval_T *argvars, typval_T *rettv));
521 static void f_eval __ARGS((typval_T *argvars, typval_T *rettv));
522 static void f_eventhandler __ARGS((typval_T *argvars, typval_T *rettv));
523 static void f_executable __ARGS((typval_T *argvars, typval_T *rettv));
524 static void f_exists __ARGS((typval_T *argvars, typval_T *rettv));
525 static void f_expand __ARGS((typval_T *argvars, typval_T *rettv));
526 static void f_extend __ARGS((typval_T *argvars, typval_T *rettv));
527 static void f_feedkeys __ARGS((typval_T *argvars, typval_T *rettv));
528 static void f_filereadable __ARGS((typval_T *argvars, typval_T *rettv));
529 static void f_filewritable __ARGS((typval_T *argvars, typval_T *rettv));
530 static void f_filter __ARGS((typval_T *argvars, typval_T *rettv));
531 static void f_finddir __ARGS((typval_T *argvars, typval_T *rettv));
532 static void f_findfile __ARGS((typval_T *argvars, typval_T *rettv));
533 #ifdef FEAT_FLOAT
534 static void f_float2nr __ARGS((typval_T *argvars, typval_T *rettv));
535 static void f_floor __ARGS((typval_T *argvars, typval_T *rettv));
536 #endif
537 static void f_fnameescape __ARGS((typval_T *argvars, typval_T *rettv));
538 static void f_fnamemodify __ARGS((typval_T *argvars, typval_T *rettv));
539 static void f_foldclosed __ARGS((typval_T *argvars, typval_T *rettv));
540 static void f_foldclosedend __ARGS((typval_T *argvars, typval_T *rettv));
541 static void f_foldlevel __ARGS((typval_T *argvars, typval_T *rettv));
542 static void f_foldtext __ARGS((typval_T *argvars, typval_T *rettv));
543 static void f_foldtextresult __ARGS((typval_T *argvars, typval_T *rettv));
544 static void f_foreground __ARGS((typval_T *argvars, typval_T *rettv));
545 static void f_function __ARGS((typval_T *argvars, typval_T *rettv));
546 static void f_garbagecollect __ARGS((typval_T *argvars, typval_T *rettv));
547 static void f_get __ARGS((typval_T *argvars, typval_T *rettv));
548 static void f_getbufline __ARGS((typval_T *argvars, typval_T *rettv));
549 static void f_getbufvar __ARGS((typval_T *argvars, typval_T *rettv));
550 static void f_getchar __ARGS((typval_T *argvars, typval_T *rettv));
551 static void f_getcharmod __ARGS((typval_T *argvars, typval_T *rettv));
552 static void f_getcmdline __ARGS((typval_T *argvars, typval_T *rettv));
553 static void f_getcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
554 static void f_getcmdtype __ARGS((typval_T *argvars, typval_T *rettv));
555 static void f_getcwd __ARGS((typval_T *argvars, typval_T *rettv));
556 static void f_getfontname __ARGS((typval_T *argvars, typval_T *rettv));
557 static void f_getfperm __ARGS((typval_T *argvars, typval_T *rettv));
558 static void f_getfsize __ARGS((typval_T *argvars, typval_T *rettv));
559 static void f_getftime __ARGS((typval_T *argvars, typval_T *rettv));
560 static void f_getftype __ARGS((typval_T *argvars, typval_T *rettv));
561 static void f_getline __ARGS((typval_T *argvars, typval_T *rettv));
562 static void f_getmatches __ARGS((typval_T *argvars, typval_T *rettv));
563 static void f_getpid __ARGS((typval_T *argvars, typval_T *rettv));
564 static void f_getpos __ARGS((typval_T *argvars, typval_T *rettv));
565 static void f_getqflist __ARGS((typval_T *argvars, typval_T *rettv));
566 static void f_getreg __ARGS((typval_T *argvars, typval_T *rettv));
567 static void f_getregtype __ARGS((typval_T *argvars, typval_T *rettv));
568 static void f_gettabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
569 static void f_getwinposx __ARGS((typval_T *argvars, typval_T *rettv));
570 static void f_getwinposy __ARGS((typval_T *argvars, typval_T *rettv));
571 static void f_getwinvar __ARGS((typval_T *argvars, typval_T *rettv));
572 static void f_glob __ARGS((typval_T *argvars, typval_T *rettv));
573 static void f_globpath __ARGS((typval_T *argvars, typval_T *rettv));
574 static void f_has __ARGS((typval_T *argvars, typval_T *rettv));
575 static void f_has_key __ARGS((typval_T *argvars, typval_T *rettv));
576 static void f_haslocaldir __ARGS((typval_T *argvars, typval_T *rettv));
577 static void f_hasmapto __ARGS((typval_T *argvars, typval_T *rettv));
578 static void f_histadd __ARGS((typval_T *argvars, typval_T *rettv));
579 static void f_histdel __ARGS((typval_T *argvars, typval_T *rettv));
580 static void f_histget __ARGS((typval_T *argvars, typval_T *rettv));
581 static void f_histnr __ARGS((typval_T *argvars, typval_T *rettv));
582 static void f_hlID __ARGS((typval_T *argvars, typval_T *rettv));
583 static void f_hlexists __ARGS((typval_T *argvars, typval_T *rettv));
584 static void f_hostname __ARGS((typval_T *argvars, typval_T *rettv));
585 static void f_iconv __ARGS((typval_T *argvars, typval_T *rettv));
586 static void f_indent __ARGS((typval_T *argvars, typval_T *rettv));
587 static void f_index __ARGS((typval_T *argvars, typval_T *rettv));
588 static void f_input __ARGS((typval_T *argvars, typval_T *rettv));
589 static void f_inputdialog __ARGS((typval_T *argvars, typval_T *rettv));
590 static void f_inputlist __ARGS((typval_T *argvars, typval_T *rettv));
591 static void f_inputrestore __ARGS((typval_T *argvars, typval_T *rettv));
592 static void f_inputsave __ARGS((typval_T *argvars, typval_T *rettv));
593 static void f_inputsecret __ARGS((typval_T *argvars, typval_T *rettv));
594 static void f_insert __ARGS((typval_T *argvars, typval_T *rettv));
595 static void f_isdirectory __ARGS((typval_T *argvars, typval_T *rettv));
596 static void f_islocked __ARGS((typval_T *argvars, typval_T *rettv));
597 static void f_items __ARGS((typval_T *argvars, typval_T *rettv));
598 static void f_join __ARGS((typval_T *argvars, typval_T *rettv));
599 static void f_keys __ARGS((typval_T *argvars, typval_T *rettv));
600 static void f_last_buffer_nr __ARGS((typval_T *argvars, typval_T *rettv));
601 static void f_len __ARGS((typval_T *argvars, typval_T *rettv));
602 static void f_libcall __ARGS((typval_T *argvars, typval_T *rettv));
603 static void f_libcallnr __ARGS((typval_T *argvars, typval_T *rettv));
604 static void f_line __ARGS((typval_T *argvars, typval_T *rettv));
605 static void f_line2byte __ARGS((typval_T *argvars, typval_T *rettv));
606 static void f_lispindent __ARGS((typval_T *argvars, typval_T *rettv));
607 static void f_localtime __ARGS((typval_T *argvars, typval_T *rettv));
608 #ifdef FEAT_FLOAT
609 static void f_log10 __ARGS((typval_T *argvars, typval_T *rettv));
610 #endif
611 static void f_map __ARGS((typval_T *argvars, typval_T *rettv));
612 static void f_maparg __ARGS((typval_T *argvars, typval_T *rettv));
613 static void f_mapcheck __ARGS((typval_T *argvars, typval_T *rettv));
614 static void f_match __ARGS((typval_T *argvars, typval_T *rettv));
615 static void f_matchadd __ARGS((typval_T *argvars, typval_T *rettv));
616 static void f_matcharg __ARGS((typval_T *argvars, typval_T *rettv));
617 static void f_matchdelete __ARGS((typval_T *argvars, typval_T *rettv));
618 static void f_matchend __ARGS((typval_T *argvars, typval_T *rettv));
619 static void f_matchlist __ARGS((typval_T *argvars, typval_T *rettv));
620 static void f_matchstr __ARGS((typval_T *argvars, typval_T *rettv));
621 static void f_max __ARGS((typval_T *argvars, typval_T *rettv));
622 static void f_min __ARGS((typval_T *argvars, typval_T *rettv));
623 #ifdef vim_mkdir
624 static void f_mkdir __ARGS((typval_T *argvars, typval_T *rettv));
625 #endif
626 static void f_mode __ARGS((typval_T *argvars, typval_T *rettv));
627 #ifdef FEAT_MZSCHEME
628 static void f_mzeval __ARGS((typval_T *argvars, typval_T *rettv));
629 #endif
630 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
631 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
632 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
633 #ifdef FEAT_FLOAT
634 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
635 #endif
636 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
637 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
642 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
643 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
644 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
645 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
646 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
647 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
648 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
649 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
650 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
651 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
652 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
653 #ifdef FEAT_FLOAT
654 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
655 #endif
656 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
657 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
668 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
669 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
670 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
671 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
672 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
673 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
674 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
675 #ifdef FEAT_FLOAT
676 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
677 #endif
678 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
679 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
680 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
681 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
682 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
683 #ifdef FEAT_FLOAT
684 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
685 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
686 #endif
687 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
688 #ifdef HAVE_STRFTIME
689 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
690 #endif
691 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
692 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
693 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
699 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
700 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
707 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
708 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
709 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
710 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
711 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
712 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
713 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
714 #ifdef FEAT_FLOAT
715 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
716 #endif
717 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
718 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
724 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
725 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
726 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
727 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
728 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
729 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
730 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
732 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
733 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
734 static int get_env_len __ARGS((char_u **arg));
735 static int get_id_len __ARGS((char_u **arg));
736 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
737 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
738 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
739 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
740 valid character */
741 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
742 static int eval_isnamec __ARGS((int c));
743 static int eval_isnamec1 __ARGS((int c));
744 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
745 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
746 static typval_T *alloc_tv __ARGS((void));
747 static typval_T *alloc_string_tv __ARGS((char_u *string));
748 static void init_tv __ARGS((typval_T *varp));
749 static long get_tv_number __ARGS((typval_T *varp));
750 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
751 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
752 static char_u *get_tv_string __ARGS((typval_T *varp));
753 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
754 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
755 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
756 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
757 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
758 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
759 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
760 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
761 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
762 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
763 static int var_check_ro __ARGS((int flags, char_u *name));
764 static int var_check_fixed __ARGS((int flags, char_u *name));
765 static int tv_check_lock __ARGS((int lock, char_u *name));
766 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
767 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
768 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
769 static int eval_fname_script __ARGS((char_u *p));
770 static int eval_fname_sid __ARGS((char_u *p));
771 static void list_func_head __ARGS((ufunc_T *fp, int indent));
772 static ufunc_T *find_func __ARGS((char_u *name));
773 static int function_exists __ARGS((char_u *name));
774 static int builtin_function __ARGS((char_u *name));
775 #ifdef FEAT_PROFILE
776 static void func_do_profile __ARGS((ufunc_T *fp));
777 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
778 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
779 static int
780 # ifdef __BORLANDC__
781 _RTLENTRYF
782 # endif
783 prof_total_cmp __ARGS((const void *s1, const void *s2));
784 static int
785 # ifdef __BORLANDC__
786 _RTLENTRYF
787 # endif
788 prof_self_cmp __ARGS((const void *s1, const void *s2));
789 #endif
790 static int script_autoload __ARGS((char_u *name, int reload));
791 static char_u *autoload_name __ARGS((char_u *name));
792 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
793 static void func_free __ARGS((ufunc_T *fp));
794 static void func_unref __ARGS((char_u *name));
795 static void func_ref __ARGS((char_u *name));
796 static void call_user_func __ARGS((ufunc_T *fp, int argcount, typval_T *argvars, typval_T *rettv, linenr_T firstline, linenr_T lastline, dict_T *selfdict));
797 static int can_free_funccal __ARGS((funccall_T *fc, int copyID)) ;
798 static void free_funccal __ARGS((funccall_T *fc, int free_val));
799 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
800 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
801 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
802 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
803 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
804 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
806 /* Character used as separated in autoload function/variable names. */
807 #define AUTOLOAD_CHAR '#'
810 * Initialize the global and v: variables.
812 void
813 eval_init()
815 int i;
816 struct vimvar *p;
818 init_var_dict(&globvardict, &globvars_var);
819 init_var_dict(&vimvardict, &vimvars_var);
820 hash_init(&compat_hashtab);
821 hash_init(&func_hashtab);
823 for (i = 0; i < VV_LEN; ++i)
825 p = &vimvars[i];
826 STRCPY(p->vv_di.di_key, p->vv_name);
827 if (p->vv_flags & VV_RO)
828 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
829 else if (p->vv_flags & VV_RO_SBX)
830 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
831 else
832 p->vv_di.di_flags = DI_FLAGS_FIX;
834 /* add to v: scope dict, unless the value is not always available */
835 if (p->vv_type != VAR_UNKNOWN)
836 hash_add(&vimvarht, p->vv_di.di_key);
837 if (p->vv_flags & VV_COMPAT)
838 /* add to compat scope dict */
839 hash_add(&compat_hashtab, p->vv_di.di_key);
841 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
844 #if defined(EXITFREE) || defined(PROTO)
845 void
846 eval_clear()
848 int i;
849 struct vimvar *p;
851 for (i = 0; i < VV_LEN; ++i)
853 p = &vimvars[i];
854 if (p->vv_di.di_tv.v_type == VAR_STRING)
856 vim_free(p->vv_str);
857 p->vv_str = NULL;
859 else if (p->vv_di.di_tv.v_type == VAR_LIST)
861 list_unref(p->vv_list);
862 p->vv_list = NULL;
865 hash_clear(&vimvarht);
866 hash_init(&vimvarht); /* garbage_collect() will access it */
867 hash_clear(&compat_hashtab);
869 /* script-local variables */
870 for (i = 1; i <= ga_scripts.ga_len; ++i)
871 vars_clear(&SCRIPT_VARS(i));
872 ga_clear(&ga_scripts);
873 free_scriptnames();
875 /* global variables */
876 vars_clear(&globvarht);
878 /* autoloaded script names */
879 ga_clear_strings(&ga_loaded);
881 /* unreferenced lists and dicts */
882 (void)garbage_collect();
884 /* functions */
885 free_all_functions();
886 hash_clear(&func_hashtab);
888 #endif
891 * Return the name of the executed function.
893 char_u *
894 func_name(cookie)
895 void *cookie;
897 return ((funccall_T *)cookie)->func->uf_name;
901 * Return the address holding the next breakpoint line for a funccall cookie.
903 linenr_T *
904 func_breakpoint(cookie)
905 void *cookie;
907 return &((funccall_T *)cookie)->breakpoint;
911 * Return the address holding the debug tick for a funccall cookie.
913 int *
914 func_dbg_tick(cookie)
915 void *cookie;
917 return &((funccall_T *)cookie)->dbg_tick;
921 * Return the nesting level for a funccall cookie.
924 func_level(cookie)
925 void *cookie;
927 return ((funccall_T *)cookie)->level;
930 /* pointer to funccal for currently active function */
931 funccall_T *current_funccal = NULL;
933 /* pointer to list of previously used funccal, still around because some
934 * item in it is still being used. */
935 funccall_T *previous_funccal = NULL;
938 * Return TRUE when a function was ended by a ":return" command.
941 current_func_returned()
943 return current_funccal->returned;
948 * Set an internal variable to a string value. Creates the variable if it does
949 * not already exist.
951 void
952 set_internal_string_var(name, value)
953 char_u *name;
954 char_u *value;
956 char_u *val;
957 typval_T *tvp;
959 val = vim_strsave(value);
960 if (val != NULL)
962 tvp = alloc_string_tv(val);
963 if (tvp != NULL)
965 set_var(name, tvp, FALSE);
966 free_tv(tvp);
971 static lval_T *redir_lval = NULL;
972 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
973 static char_u *redir_endp = NULL;
974 static char_u *redir_varname = NULL;
977 * Start recording command output to a variable
978 * Returns OK if successfully completed the setup. FAIL otherwise.
981 var_redir_start(name, append)
982 char_u *name;
983 int append; /* append to an existing variable */
985 int save_emsg;
986 int err;
987 typval_T tv;
989 /* Catch a bad name early. */
990 if (!eval_isnamec1(*name))
992 EMSG(_(e_invarg));
993 return FAIL;
996 /* Make a copy of the name, it is used in redir_lval until redir ends. */
997 redir_varname = vim_strsave(name);
998 if (redir_varname == NULL)
999 return FAIL;
1001 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
1002 if (redir_lval == NULL)
1004 var_redir_stop();
1005 return FAIL;
1008 /* The output is stored in growarray "redir_ga" until redirection ends. */
1009 ga_init2(&redir_ga, (int)sizeof(char), 500);
1011 /* Parse the variable name (can be a dict or list entry). */
1012 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1013 FNE_CHECK_START);
1014 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1016 if (redir_endp != NULL && *redir_endp != NUL)
1017 /* Trailing characters are present after the variable name */
1018 EMSG(_(e_trailing));
1019 else
1020 EMSG(_(e_invarg));
1021 redir_endp = NULL; /* don't store a value, only cleanup */
1022 var_redir_stop();
1023 return FAIL;
1026 /* check if we can write to the variable: set it to or append an empty
1027 * string */
1028 save_emsg = did_emsg;
1029 did_emsg = FALSE;
1030 tv.v_type = VAR_STRING;
1031 tv.vval.v_string = (char_u *)"";
1032 if (append)
1033 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1034 else
1035 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1036 err = did_emsg;
1037 did_emsg |= save_emsg;
1038 if (err)
1040 redir_endp = NULL; /* don't store a value, only cleanup */
1041 var_redir_stop();
1042 return FAIL;
1044 if (redir_lval->ll_newkey != NULL)
1046 /* Dictionary item was created, don't do it again. */
1047 vim_free(redir_lval->ll_newkey);
1048 redir_lval->ll_newkey = NULL;
1051 return OK;
1055 * Append "value[value_len]" to the variable set by var_redir_start().
1056 * The actual appending is postponed until redirection ends, because the value
1057 * appended may in fact be the string we write to, changing it may cause freed
1058 * memory to be used:
1059 * :redir => foo
1060 * :let foo
1061 * :redir END
1063 void
1064 var_redir_str(value, value_len)
1065 char_u *value;
1066 int value_len;
1068 int len;
1070 if (redir_lval == NULL)
1071 return;
1073 if (value_len == -1)
1074 len = (int)STRLEN(value); /* Append the entire string */
1075 else
1076 len = value_len; /* Append only "value_len" characters */
1078 if (ga_grow(&redir_ga, len) == OK)
1080 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1081 redir_ga.ga_len += len;
1083 else
1084 var_redir_stop();
1088 * Stop redirecting command output to a variable.
1089 * Frees the allocated memory.
1091 void
1092 var_redir_stop()
1094 typval_T tv;
1096 if (redir_lval != NULL)
1098 /* If there was no error: assign the text to the variable. */
1099 if (redir_endp != NULL)
1101 ga_append(&redir_ga, NUL); /* Append the trailing NUL. */
1102 tv.v_type = VAR_STRING;
1103 tv.vval.v_string = redir_ga.ga_data;
1104 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1107 /* free the collected output */
1108 vim_free(redir_ga.ga_data);
1109 redir_ga.ga_data = NULL;
1111 clear_lval(redir_lval);
1112 vim_free(redir_lval);
1113 redir_lval = NULL;
1115 vim_free(redir_varname);
1116 redir_varname = NULL;
1119 # if defined(FEAT_MBYTE) || defined(PROTO)
1121 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1122 char_u *enc_from;
1123 char_u *enc_to;
1124 char_u *fname_from;
1125 char_u *fname_to;
1127 int err = FALSE;
1129 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1130 set_vim_var_string(VV_CC_TO, enc_to, -1);
1131 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1132 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1133 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1134 err = TRUE;
1135 set_vim_var_string(VV_CC_FROM, NULL, -1);
1136 set_vim_var_string(VV_CC_TO, NULL, -1);
1137 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1138 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1140 if (err)
1141 return FAIL;
1142 return OK;
1144 # endif
1146 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1148 eval_printexpr(fname, args)
1149 char_u *fname;
1150 char_u *args;
1152 int err = FALSE;
1154 set_vim_var_string(VV_FNAME_IN, fname, -1);
1155 set_vim_var_string(VV_CMDARG, args, -1);
1156 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1157 err = TRUE;
1158 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1159 set_vim_var_string(VV_CMDARG, NULL, -1);
1161 if (err)
1163 mch_remove(fname);
1164 return FAIL;
1166 return OK;
1168 # endif
1170 # if defined(FEAT_DIFF) || defined(PROTO)
1171 void
1172 eval_diff(origfile, newfile, outfile)
1173 char_u *origfile;
1174 char_u *newfile;
1175 char_u *outfile;
1177 int err = FALSE;
1179 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1180 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1181 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1182 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1183 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1184 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1185 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1188 void
1189 eval_patch(origfile, difffile, outfile)
1190 char_u *origfile;
1191 char_u *difffile;
1192 char_u *outfile;
1194 int err;
1196 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1197 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1198 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1199 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1200 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1201 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1202 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1204 # endif
1207 * Top level evaluation function, returning a boolean.
1208 * Sets "error" to TRUE if there was an error.
1209 * Return TRUE or FALSE.
1212 eval_to_bool(arg, error, nextcmd, skip)
1213 char_u *arg;
1214 int *error;
1215 char_u **nextcmd;
1216 int skip; /* only parse, don't execute */
1218 typval_T tv;
1219 int retval = FALSE;
1221 if (skip)
1222 ++emsg_skip;
1223 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1224 *error = TRUE;
1225 else
1227 *error = FALSE;
1228 if (!skip)
1230 retval = (get_tv_number_chk(&tv, error) != 0);
1231 clear_tv(&tv);
1234 if (skip)
1235 --emsg_skip;
1237 return retval;
1241 * Top level evaluation function, returning a string. If "skip" is TRUE,
1242 * only parsing to "nextcmd" is done, without reporting errors. Return
1243 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1245 char_u *
1246 eval_to_string_skip(arg, nextcmd, skip)
1247 char_u *arg;
1248 char_u **nextcmd;
1249 int skip; /* only parse, don't execute */
1251 typval_T tv;
1252 char_u *retval;
1254 if (skip)
1255 ++emsg_skip;
1256 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1257 retval = NULL;
1258 else
1260 retval = vim_strsave(get_tv_string(&tv));
1261 clear_tv(&tv);
1263 if (skip)
1264 --emsg_skip;
1266 return retval;
1270 * Skip over an expression at "*pp".
1271 * Return FAIL for an error, OK otherwise.
1274 skip_expr(pp)
1275 char_u **pp;
1277 typval_T rettv;
1279 *pp = skipwhite(*pp);
1280 return eval1(pp, &rettv, FALSE);
1284 * Top level evaluation function, returning a string.
1285 * When "convert" is TRUE convert a List into a sequence of lines and convert
1286 * a Float to a String.
1287 * Return pointer to allocated memory, or NULL for failure.
1289 char_u *
1290 eval_to_string(arg, nextcmd, convert)
1291 char_u *arg;
1292 char_u **nextcmd;
1293 int convert;
1295 typval_T tv;
1296 char_u *retval;
1297 garray_T ga;
1298 #ifdef FEAT_FLOAT
1299 char_u numbuf[NUMBUFLEN];
1300 #endif
1302 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1303 retval = NULL;
1304 else
1306 if (convert && tv.v_type == VAR_LIST)
1308 ga_init2(&ga, (int)sizeof(char), 80);
1309 if (tv.vval.v_list != NULL)
1310 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1311 ga_append(&ga, NUL);
1312 retval = (char_u *)ga.ga_data;
1314 #ifdef FEAT_FLOAT
1315 else if (convert && tv.v_type == VAR_FLOAT)
1317 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1318 retval = vim_strsave(numbuf);
1320 #endif
1321 else
1322 retval = vim_strsave(get_tv_string(&tv));
1323 clear_tv(&tv);
1326 return retval;
1330 * Call eval_to_string() without using current local variables and using
1331 * textlock. When "use_sandbox" is TRUE use the sandbox.
1333 char_u *
1334 eval_to_string_safe(arg, nextcmd, use_sandbox)
1335 char_u *arg;
1336 char_u **nextcmd;
1337 int use_sandbox;
1339 char_u *retval;
1340 void *save_funccalp;
1342 save_funccalp = save_funccal();
1343 if (use_sandbox)
1344 ++sandbox;
1345 ++textlock;
1346 retval = eval_to_string(arg, nextcmd, FALSE);
1347 if (use_sandbox)
1348 --sandbox;
1349 --textlock;
1350 restore_funccal(save_funccalp);
1351 return retval;
1355 * Top level evaluation function, returning a number.
1356 * Evaluates "expr" silently.
1357 * Returns -1 for an error.
1360 eval_to_number(expr)
1361 char_u *expr;
1363 typval_T rettv;
1364 int retval;
1365 char_u *p = skipwhite(expr);
1367 ++emsg_off;
1369 if (eval1(&p, &rettv, TRUE) == FAIL)
1370 retval = -1;
1371 else
1373 retval = get_tv_number_chk(&rettv, NULL);
1374 clear_tv(&rettv);
1376 --emsg_off;
1378 return retval;
1382 * Prepare v: variable "idx" to be used.
1383 * Save the current typeval in "save_tv".
1384 * When not used yet add the variable to the v: hashtable.
1386 static void
1387 prepare_vimvar(idx, save_tv)
1388 int idx;
1389 typval_T *save_tv;
1391 *save_tv = vimvars[idx].vv_tv;
1392 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1393 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1397 * Restore v: variable "idx" to typeval "save_tv".
1398 * When no longer defined, remove the variable from the v: hashtable.
1400 static void
1401 restore_vimvar(idx, save_tv)
1402 int idx;
1403 typval_T *save_tv;
1405 hashitem_T *hi;
1407 vimvars[idx].vv_tv = *save_tv;
1408 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1410 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1411 if (HASHITEM_EMPTY(hi))
1412 EMSG2(_(e_intern2), "restore_vimvar()");
1413 else
1414 hash_remove(&vimvarht, hi);
1418 #if defined(FEAT_SPELL) || defined(PROTO)
1420 * Evaluate an expression to a list with suggestions.
1421 * For the "expr:" part of 'spellsuggest'.
1422 * Returns NULL when there is an error.
1424 list_T *
1425 eval_spell_expr(badword, expr)
1426 char_u *badword;
1427 char_u *expr;
1429 typval_T save_val;
1430 typval_T rettv;
1431 list_T *list = NULL;
1432 char_u *p = skipwhite(expr);
1434 /* Set "v:val" to the bad word. */
1435 prepare_vimvar(VV_VAL, &save_val);
1436 vimvars[VV_VAL].vv_type = VAR_STRING;
1437 vimvars[VV_VAL].vv_str = badword;
1438 if (p_verbose == 0)
1439 ++emsg_off;
1441 if (eval1(&p, &rettv, TRUE) == OK)
1443 if (rettv.v_type != VAR_LIST)
1444 clear_tv(&rettv);
1445 else
1446 list = rettv.vval.v_list;
1449 if (p_verbose == 0)
1450 --emsg_off;
1451 restore_vimvar(VV_VAL, &save_val);
1453 return list;
1457 * "list" is supposed to contain two items: a word and a number. Return the
1458 * word in "pp" and the number as the return value.
1459 * Return -1 if anything isn't right.
1460 * Used to get the good word and score from the eval_spell_expr() result.
1463 get_spellword(list, pp)
1464 list_T *list;
1465 char_u **pp;
1467 listitem_T *li;
1469 li = list->lv_first;
1470 if (li == NULL)
1471 return -1;
1472 *pp = get_tv_string(&li->li_tv);
1474 li = li->li_next;
1475 if (li == NULL)
1476 return -1;
1477 return get_tv_number(&li->li_tv);
1479 #endif
1482 * Top level evaluation function.
1483 * Returns an allocated typval_T with the result.
1484 * Returns NULL when there is an error.
1486 typval_T *
1487 eval_expr(arg, nextcmd)
1488 char_u *arg;
1489 char_u **nextcmd;
1491 typval_T *tv;
1493 tv = (typval_T *)alloc(sizeof(typval_T));
1494 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1496 vim_free(tv);
1497 tv = NULL;
1500 return tv;
1504 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1505 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1507 * Call some vimL function and return the result in "*rettv".
1508 * Uses argv[argc] for the function arguments. Only Number and String
1509 * arguments are currently supported.
1510 * Returns OK or FAIL.
1512 static int
1513 call_vim_function(func, argc, argv, safe, rettv)
1514 char_u *func;
1515 int argc;
1516 char_u **argv;
1517 int safe; /* use the sandbox */
1518 typval_T *rettv;
1520 typval_T *argvars;
1521 long n;
1522 int len;
1523 int i;
1524 int doesrange;
1525 void *save_funccalp = NULL;
1526 int ret;
1528 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1529 if (argvars == NULL)
1530 return FAIL;
1532 for (i = 0; i < argc; i++)
1534 /* Pass a NULL or empty argument as an empty string */
1535 if (argv[i] == NULL || *argv[i] == NUL)
1537 argvars[i].v_type = VAR_STRING;
1538 argvars[i].vval.v_string = (char_u *)"";
1539 continue;
1542 /* Recognize a number argument, the others must be strings. */
1543 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1544 if (len != 0 && len == (int)STRLEN(argv[i]))
1546 argvars[i].v_type = VAR_NUMBER;
1547 argvars[i].vval.v_number = n;
1549 else
1551 argvars[i].v_type = VAR_STRING;
1552 argvars[i].vval.v_string = argv[i];
1556 if (safe)
1558 save_funccalp = save_funccal();
1559 ++sandbox;
1562 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1563 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1564 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1565 &doesrange, TRUE, NULL);
1566 if (safe)
1568 --sandbox;
1569 restore_funccal(save_funccalp);
1571 vim_free(argvars);
1573 if (ret == FAIL)
1574 clear_tv(rettv);
1576 return ret;
1579 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1581 * Call vimL function "func" and return the result as a string.
1582 * Returns NULL when calling the function fails.
1583 * Uses argv[argc] for the function arguments.
1585 void *
1586 call_func_retstr(func, argc, argv, safe)
1587 char_u *func;
1588 int argc;
1589 char_u **argv;
1590 int safe; /* use the sandbox */
1592 typval_T rettv;
1593 char_u *retval;
1595 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1596 return NULL;
1598 retval = vim_strsave(get_tv_string(&rettv));
1599 clear_tv(&rettv);
1600 return retval;
1602 # endif
1604 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1606 * Call vimL function "func" and return the result as a number.
1607 * Returns -1 when calling the function fails.
1608 * Uses argv[argc] for the function arguments.
1610 long
1611 call_func_retnr(func, argc, argv, safe)
1612 char_u *func;
1613 int argc;
1614 char_u **argv;
1615 int safe; /* use the sandbox */
1617 typval_T rettv;
1618 long retval;
1620 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1621 return -1;
1623 retval = get_tv_number_chk(&rettv, NULL);
1624 clear_tv(&rettv);
1625 return retval;
1627 # endif
1630 * Call vimL function "func" and return the result as a List.
1631 * Uses argv[argc] for the function arguments.
1632 * Returns NULL when there is something wrong.
1634 void *
1635 call_func_retlist(func, argc, argv, safe)
1636 char_u *func;
1637 int argc;
1638 char_u **argv;
1639 int safe; /* use the sandbox */
1641 typval_T rettv;
1643 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1644 return NULL;
1646 if (rettv.v_type != VAR_LIST)
1648 clear_tv(&rettv);
1649 return NULL;
1652 return rettv.vval.v_list;
1654 #endif
1658 * Save the current function call pointer, and set it to NULL.
1659 * Used when executing autocommands and for ":source".
1661 void *
1662 save_funccal()
1664 funccall_T *fc = current_funccal;
1666 current_funccal = NULL;
1667 return (void *)fc;
1670 void
1671 restore_funccal(vfc)
1672 void *vfc;
1674 funccall_T *fc = (funccall_T *)vfc;
1676 current_funccal = fc;
1679 #if defined(FEAT_PROFILE) || defined(PROTO)
1681 * Prepare profiling for entering a child or something else that is not
1682 * counted for the script/function itself.
1683 * Should always be called in pair with prof_child_exit().
1685 void
1686 prof_child_enter(tm)
1687 proftime_T *tm; /* place to store waittime */
1689 funccall_T *fc = current_funccal;
1691 if (fc != NULL && fc->func->uf_profiling)
1692 profile_start(&fc->prof_child);
1693 script_prof_save(tm);
1697 * Take care of time spent in a child.
1698 * Should always be called after prof_child_enter().
1700 void
1701 prof_child_exit(tm)
1702 proftime_T *tm; /* where waittime was stored */
1704 funccall_T *fc = current_funccal;
1706 if (fc != NULL && fc->func->uf_profiling)
1708 profile_end(&fc->prof_child);
1709 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1710 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1711 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1713 script_prof_restore(tm);
1715 #endif
1718 #ifdef FEAT_FOLDING
1720 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1721 * it in "*cp". Doesn't give error messages.
1724 eval_foldexpr(arg, cp)
1725 char_u *arg;
1726 int *cp;
1728 typval_T tv;
1729 int retval;
1730 char_u *s;
1731 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1732 OPT_LOCAL);
1734 ++emsg_off;
1735 if (use_sandbox)
1736 ++sandbox;
1737 ++textlock;
1738 *cp = NUL;
1739 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1740 retval = 0;
1741 else
1743 /* If the result is a number, just return the number. */
1744 if (tv.v_type == VAR_NUMBER)
1745 retval = tv.vval.v_number;
1746 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1747 retval = 0;
1748 else
1750 /* If the result is a string, check if there is a non-digit before
1751 * the number. */
1752 s = tv.vval.v_string;
1753 if (!VIM_ISDIGIT(*s) && *s != '-')
1754 *cp = *s++;
1755 retval = atol((char *)s);
1757 clear_tv(&tv);
1759 --emsg_off;
1760 if (use_sandbox)
1761 --sandbox;
1762 --textlock;
1764 return retval;
1766 #endif
1769 * ":let" list all variable values
1770 * ":let var1 var2" list variable values
1771 * ":let var = expr" assignment command.
1772 * ":let var += expr" assignment command.
1773 * ":let var -= expr" assignment command.
1774 * ":let var .= expr" assignment command.
1775 * ":let [var1, var2] = expr" unpack list.
1777 void
1778 ex_let(eap)
1779 exarg_T *eap;
1781 char_u *arg = eap->arg;
1782 char_u *expr = NULL;
1783 typval_T rettv;
1784 int i;
1785 int var_count = 0;
1786 int semicolon = 0;
1787 char_u op[2];
1788 char_u *argend;
1789 int first = TRUE;
1791 argend = skip_var_list(arg, &var_count, &semicolon);
1792 if (argend == NULL)
1793 return;
1794 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1795 --argend;
1796 expr = vim_strchr(argend, '=');
1797 if (expr == NULL)
1800 * ":let" without "=": list variables
1802 if (*arg == '[')
1803 EMSG(_(e_invarg));
1804 else if (!ends_excmd(*arg))
1805 /* ":let var1 var2" */
1806 arg = list_arg_vars(eap, arg, &first);
1807 else if (!eap->skip)
1809 /* ":let" */
1810 list_glob_vars(&first);
1811 list_buf_vars(&first);
1812 list_win_vars(&first);
1813 #ifdef FEAT_WINDOWS
1814 list_tab_vars(&first);
1815 #endif
1816 list_script_vars(&first);
1817 list_func_vars(&first);
1818 list_vim_vars(&first);
1820 eap->nextcmd = check_nextcmd(arg);
1822 else
1824 op[0] = '=';
1825 op[1] = NUL;
1826 if (expr > argend)
1828 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1829 op[0] = expr[-1]; /* +=, -= or .= */
1831 expr = skipwhite(expr + 1);
1833 if (eap->skip)
1834 ++emsg_skip;
1835 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1836 if (eap->skip)
1838 if (i != FAIL)
1839 clear_tv(&rettv);
1840 --emsg_skip;
1842 else if (i != FAIL)
1844 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1845 op);
1846 clear_tv(&rettv);
1852 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1853 * Handles both "var" with any type and "[var, var; var]" with a list type.
1854 * When "nextchars" is not NULL it points to a string with characters that
1855 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1856 * or concatenate.
1857 * Returns OK or FAIL;
1859 static int
1860 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1861 char_u *arg_start;
1862 typval_T *tv;
1863 int copy; /* copy values from "tv", don't move */
1864 int semicolon; /* from skip_var_list() */
1865 int var_count; /* from skip_var_list() */
1866 char_u *nextchars;
1868 char_u *arg = arg_start;
1869 list_T *l;
1870 int i;
1871 listitem_T *item;
1872 typval_T ltv;
1874 if (*arg != '[')
1877 * ":let var = expr" or ":for var in list"
1879 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1880 return FAIL;
1881 return OK;
1885 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1887 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1889 EMSG(_(e_listreq));
1890 return FAIL;
1893 i = list_len(l);
1894 if (semicolon == 0 && var_count < i)
1896 EMSG(_("E687: Less targets than List items"));
1897 return FAIL;
1899 if (var_count - semicolon > i)
1901 EMSG(_("E688: More targets than List items"));
1902 return FAIL;
1905 item = l->lv_first;
1906 while (*arg != ']')
1908 arg = skipwhite(arg + 1);
1909 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1910 item = item->li_next;
1911 if (arg == NULL)
1912 return FAIL;
1914 arg = skipwhite(arg);
1915 if (*arg == ';')
1917 /* Put the rest of the list (may be empty) in the var after ';'.
1918 * Create a new list for this. */
1919 l = list_alloc();
1920 if (l == NULL)
1921 return FAIL;
1922 while (item != NULL)
1924 list_append_tv(l, &item->li_tv);
1925 item = item->li_next;
1928 ltv.v_type = VAR_LIST;
1929 ltv.v_lock = 0;
1930 ltv.vval.v_list = l;
1931 l->lv_refcount = 1;
1933 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1934 (char_u *)"]", nextchars);
1935 clear_tv(&ltv);
1936 if (arg == NULL)
1937 return FAIL;
1938 break;
1940 else if (*arg != ',' && *arg != ']')
1942 EMSG2(_(e_intern2), "ex_let_vars()");
1943 return FAIL;
1947 return OK;
1951 * Skip over assignable variable "var" or list of variables "[var, var]".
1952 * Used for ":let varvar = expr" and ":for varvar in expr".
1953 * For "[var, var]" increment "*var_count" for each variable.
1954 * for "[var, var; var]" set "semicolon".
1955 * Return NULL for an error.
1957 static char_u *
1958 skip_var_list(arg, var_count, semicolon)
1959 char_u *arg;
1960 int *var_count;
1961 int *semicolon;
1963 char_u *p, *s;
1965 if (*arg == '[')
1967 /* "[var, var]": find the matching ']'. */
1968 p = arg;
1969 for (;;)
1971 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1972 s = skip_var_one(p);
1973 if (s == p)
1975 EMSG2(_(e_invarg2), p);
1976 return NULL;
1978 ++*var_count;
1980 p = skipwhite(s);
1981 if (*p == ']')
1982 break;
1983 else if (*p == ';')
1985 if (*semicolon == 1)
1987 EMSG(_("Double ; in list of variables"));
1988 return NULL;
1990 *semicolon = 1;
1992 else if (*p != ',')
1994 EMSG2(_(e_invarg2), p);
1995 return NULL;
1998 return p + 1;
2000 else
2001 return skip_var_one(arg);
2005 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
2006 * l[idx].
2008 static char_u *
2009 skip_var_one(arg)
2010 char_u *arg;
2012 if (*arg == '@' && arg[1] != NUL)
2013 return arg + 2;
2014 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2015 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2019 * List variables for hashtab "ht" with prefix "prefix".
2020 * If "empty" is TRUE also list NULL strings as empty strings.
2022 static void
2023 list_hashtable_vars(ht, prefix, empty, first)
2024 hashtab_T *ht;
2025 char_u *prefix;
2026 int empty;
2027 int *first;
2029 hashitem_T *hi;
2030 dictitem_T *di;
2031 int todo;
2033 todo = (int)ht->ht_used;
2034 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2036 if (!HASHITEM_EMPTY(hi))
2038 --todo;
2039 di = HI2DI(hi);
2040 if (empty || di->di_tv.v_type != VAR_STRING
2041 || di->di_tv.vval.v_string != NULL)
2042 list_one_var(di, prefix, first);
2048 * List global variables.
2050 static void
2051 list_glob_vars(first)
2052 int *first;
2054 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2058 * List buffer variables.
2060 static void
2061 list_buf_vars(first)
2062 int *first;
2064 char_u numbuf[NUMBUFLEN];
2066 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2067 TRUE, first);
2069 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2070 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2071 numbuf, first);
2075 * List window variables.
2077 static void
2078 list_win_vars(first)
2079 int *first;
2081 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2082 (char_u *)"w:", TRUE, first);
2085 #ifdef FEAT_WINDOWS
2087 * List tab page variables.
2089 static void
2090 list_tab_vars(first)
2091 int *first;
2093 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2094 (char_u *)"t:", TRUE, first);
2096 #endif
2099 * List Vim variables.
2101 static void
2102 list_vim_vars(first)
2103 int *first;
2105 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2109 * List script-local variables, if there is a script.
2111 static void
2112 list_script_vars(first)
2113 int *first;
2115 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2116 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2117 (char_u *)"s:", FALSE, first);
2121 * List function variables, if there is a function.
2123 static void
2124 list_func_vars(first)
2125 int *first;
2127 if (current_funccal != NULL)
2128 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2129 (char_u *)"l:", FALSE, first);
2133 * List variables in "arg".
2135 static char_u *
2136 list_arg_vars(eap, arg, first)
2137 exarg_T *eap;
2138 char_u *arg;
2139 int *first;
2141 int error = FALSE;
2142 int len;
2143 char_u *name;
2144 char_u *name_start;
2145 char_u *arg_subsc;
2146 char_u *tofree;
2147 typval_T tv;
2149 while (!ends_excmd(*arg) && !got_int)
2151 if (error || eap->skip)
2153 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2154 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2156 emsg_severe = TRUE;
2157 EMSG(_(e_trailing));
2158 break;
2161 else
2163 /* get_name_len() takes care of expanding curly braces */
2164 name_start = name = arg;
2165 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2166 if (len <= 0)
2168 /* This is mainly to keep test 49 working: when expanding
2169 * curly braces fails overrule the exception error message. */
2170 if (len < 0 && !aborting())
2172 emsg_severe = TRUE;
2173 EMSG2(_(e_invarg2), arg);
2174 break;
2176 error = TRUE;
2178 else
2180 if (tofree != NULL)
2181 name = tofree;
2182 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2183 error = TRUE;
2184 else
2186 /* handle d.key, l[idx], f(expr) */
2187 arg_subsc = arg;
2188 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2189 error = TRUE;
2190 else
2192 if (arg == arg_subsc && len == 2 && name[1] == ':')
2194 switch (*name)
2196 case 'g': list_glob_vars(first); break;
2197 case 'b': list_buf_vars(first); break;
2198 case 'w': list_win_vars(first); break;
2199 #ifdef FEAT_WINDOWS
2200 case 't': list_tab_vars(first); break;
2201 #endif
2202 case 'v': list_vim_vars(first); break;
2203 case 's': list_script_vars(first); break;
2204 case 'l': list_func_vars(first); break;
2205 default:
2206 EMSG2(_("E738: Can't list variables for %s"), name);
2209 else
2211 char_u numbuf[NUMBUFLEN];
2212 char_u *tf;
2213 int c;
2214 char_u *s;
2216 s = echo_string(&tv, &tf, numbuf, 0);
2217 c = *arg;
2218 *arg = NUL;
2219 list_one_var_a((char_u *)"",
2220 arg == arg_subsc ? name : name_start,
2221 tv.v_type,
2222 s == NULL ? (char_u *)"" : s,
2223 first);
2224 *arg = c;
2225 vim_free(tf);
2227 clear_tv(&tv);
2232 vim_free(tofree);
2235 arg = skipwhite(arg);
2238 return arg;
2242 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2243 * Returns a pointer to the char just after the var name.
2244 * Returns NULL if there is an error.
2246 static char_u *
2247 ex_let_one(arg, tv, copy, endchars, op)
2248 char_u *arg; /* points to variable name */
2249 typval_T *tv; /* value to assign to variable */
2250 int copy; /* copy value from "tv" */
2251 char_u *endchars; /* valid chars after variable name or NULL */
2252 char_u *op; /* "+", "-", "." or NULL*/
2254 int c1;
2255 char_u *name;
2256 char_u *p;
2257 char_u *arg_end = NULL;
2258 int len;
2259 int opt_flags;
2260 char_u *tofree = NULL;
2263 * ":let $VAR = expr": Set environment variable.
2265 if (*arg == '$')
2267 /* Find the end of the name. */
2268 ++arg;
2269 name = arg;
2270 len = get_env_len(&arg);
2271 if (len == 0)
2272 EMSG2(_(e_invarg2), name - 1);
2273 else
2275 if (op != NULL && (*op == '+' || *op == '-'))
2276 EMSG2(_(e_letwrong), op);
2277 else if (endchars != NULL
2278 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2279 EMSG(_(e_letunexp));
2280 else
2282 c1 = name[len];
2283 name[len] = NUL;
2284 p = get_tv_string_chk(tv);
2285 if (p != NULL && op != NULL && *op == '.')
2287 int mustfree = FALSE;
2288 char_u *s = vim_getenv(name, &mustfree);
2290 if (s != NULL)
2292 p = tofree = concat_str(s, p);
2293 if (mustfree)
2294 vim_free(s);
2297 if (p != NULL)
2299 vim_setenv(name, p);
2300 if (STRICMP(name, "HOME") == 0)
2301 init_homedir();
2302 else if (didset_vim && STRICMP(name, "VIM") == 0)
2303 didset_vim = FALSE;
2304 else if (didset_vimruntime
2305 && STRICMP(name, "VIMRUNTIME") == 0)
2306 didset_vimruntime = FALSE;
2307 arg_end = arg;
2309 name[len] = c1;
2310 vim_free(tofree);
2316 * ":let &option = expr": Set option value.
2317 * ":let &l:option = expr": Set local option value.
2318 * ":let &g:option = expr": Set global option value.
2320 else if (*arg == '&')
2322 /* Find the end of the name. */
2323 p = find_option_end(&arg, &opt_flags);
2324 if (p == NULL || (endchars != NULL
2325 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2326 EMSG(_(e_letunexp));
2327 else
2329 long n;
2330 int opt_type;
2331 long numval;
2332 char_u *stringval = NULL;
2333 char_u *s;
2335 c1 = *p;
2336 *p = NUL;
2338 n = get_tv_number(tv);
2339 s = get_tv_string_chk(tv); /* != NULL if number or string */
2340 if (s != NULL && op != NULL && *op != '=')
2342 opt_type = get_option_value(arg, &numval,
2343 &stringval, opt_flags);
2344 if ((opt_type == 1 && *op == '.')
2345 || (opt_type == 0 && *op != '.'))
2346 EMSG2(_(e_letwrong), op);
2347 else
2349 if (opt_type == 1) /* number */
2351 if (*op == '+')
2352 n = numval + n;
2353 else
2354 n = numval - n;
2356 else if (opt_type == 0 && stringval != NULL) /* string */
2358 s = concat_str(stringval, s);
2359 vim_free(stringval);
2360 stringval = s;
2364 if (s != NULL)
2366 set_option_value(arg, n, s, opt_flags);
2367 arg_end = p;
2369 *p = c1;
2370 vim_free(stringval);
2375 * ":let @r = expr": Set register contents.
2377 else if (*arg == '@')
2379 ++arg;
2380 if (op != NULL && (*op == '+' || *op == '-'))
2381 EMSG2(_(e_letwrong), op);
2382 else if (endchars != NULL
2383 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2384 EMSG(_(e_letunexp));
2385 else
2387 char_u *ptofree = NULL;
2388 char_u *s;
2390 p = get_tv_string_chk(tv);
2391 if (p != NULL && op != NULL && *op == '.')
2393 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2394 if (s != NULL)
2396 p = ptofree = concat_str(s, p);
2397 vim_free(s);
2400 if (p != NULL)
2402 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2403 arg_end = arg + 1;
2405 vim_free(ptofree);
2410 * ":let var = expr": Set internal variable.
2411 * ":let {expr} = expr": Idem, name made with curly braces
2413 else if (eval_isnamec1(*arg) || *arg == '{')
2415 lval_T lv;
2417 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2418 if (p != NULL && lv.ll_name != NULL)
2420 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2421 EMSG(_(e_letunexp));
2422 else
2424 set_var_lval(&lv, p, tv, copy, op);
2425 arg_end = p;
2428 clear_lval(&lv);
2431 else
2432 EMSG2(_(e_invarg2), arg);
2434 return arg_end;
2438 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2440 static int
2441 check_changedtick(arg)
2442 char_u *arg;
2444 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2446 EMSG2(_(e_readonlyvar), arg);
2447 return TRUE;
2449 return FALSE;
2453 * Get an lval: variable, Dict item or List item that can be assigned a value
2454 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2455 * "name.key", "name.key[expr]" etc.
2456 * Indexing only works if "name" is an existing List or Dictionary.
2457 * "name" points to the start of the name.
2458 * If "rettv" is not NULL it points to the value to be assigned.
2459 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2460 * wrong; must end in space or cmd separator.
2462 * Returns a pointer to just after the name, including indexes.
2463 * When an evaluation error occurs "lp->ll_name" is NULL;
2464 * Returns NULL for a parsing error. Still need to free items in "lp"!
2466 static char_u *
2467 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2468 char_u *name;
2469 typval_T *rettv;
2470 lval_T *lp;
2471 int unlet;
2472 int skip;
2473 int quiet; /* don't give error messages */
2474 int fne_flags; /* flags for find_name_end() */
2476 char_u *p;
2477 char_u *expr_start, *expr_end;
2478 int cc;
2479 dictitem_T *v;
2480 typval_T var1;
2481 typval_T var2;
2482 int empty1 = FALSE;
2483 listitem_T *ni;
2484 char_u *key = NULL;
2485 int len;
2486 hashtab_T *ht;
2488 /* Clear everything in "lp". */
2489 vim_memset(lp, 0, sizeof(lval_T));
2491 if (skip)
2493 /* When skipping just find the end of the name. */
2494 lp->ll_name = name;
2495 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2498 /* Find the end of the name. */
2499 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2500 if (expr_start != NULL)
2502 /* Don't expand the name when we already know there is an error. */
2503 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2504 && *p != '[' && *p != '.')
2506 EMSG(_(e_trailing));
2507 return NULL;
2510 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2511 if (lp->ll_exp_name == NULL)
2513 /* Report an invalid expression in braces, unless the
2514 * expression evaluation has been cancelled due to an
2515 * aborting error, an interrupt, or an exception. */
2516 if (!aborting() && !quiet)
2518 emsg_severe = TRUE;
2519 EMSG2(_(e_invarg2), name);
2520 return NULL;
2523 lp->ll_name = lp->ll_exp_name;
2525 else
2526 lp->ll_name = name;
2528 /* Without [idx] or .key we are done. */
2529 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2530 return p;
2532 cc = *p;
2533 *p = NUL;
2534 v = find_var(lp->ll_name, &ht);
2535 if (v == NULL && !quiet)
2536 EMSG2(_(e_undefvar), lp->ll_name);
2537 *p = cc;
2538 if (v == NULL)
2539 return NULL;
2542 * Loop until no more [idx] or .key is following.
2544 lp->ll_tv = &v->di_tv;
2545 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2547 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2548 && !(lp->ll_tv->v_type == VAR_DICT
2549 && lp->ll_tv->vval.v_dict != NULL))
2551 if (!quiet)
2552 EMSG(_("E689: Can only index a List or Dictionary"));
2553 return NULL;
2555 if (lp->ll_range)
2557 if (!quiet)
2558 EMSG(_("E708: [:] must come last"));
2559 return NULL;
2562 len = -1;
2563 if (*p == '.')
2565 key = p + 1;
2566 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2568 if (len == 0)
2570 if (!quiet)
2571 EMSG(_(e_emptykey));
2572 return NULL;
2574 p = key + len;
2576 else
2578 /* Get the index [expr] or the first index [expr: ]. */
2579 p = skipwhite(p + 1);
2580 if (*p == ':')
2581 empty1 = TRUE;
2582 else
2584 empty1 = FALSE;
2585 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2586 return NULL;
2587 if (get_tv_string_chk(&var1) == NULL)
2589 /* not a number or string */
2590 clear_tv(&var1);
2591 return NULL;
2595 /* Optionally get the second index [ :expr]. */
2596 if (*p == ':')
2598 if (lp->ll_tv->v_type == VAR_DICT)
2600 if (!quiet)
2601 EMSG(_(e_dictrange));
2602 if (!empty1)
2603 clear_tv(&var1);
2604 return NULL;
2606 if (rettv != NULL && (rettv->v_type != VAR_LIST
2607 || rettv->vval.v_list == NULL))
2609 if (!quiet)
2610 EMSG(_("E709: [:] requires a List value"));
2611 if (!empty1)
2612 clear_tv(&var1);
2613 return NULL;
2615 p = skipwhite(p + 1);
2616 if (*p == ']')
2617 lp->ll_empty2 = TRUE;
2618 else
2620 lp->ll_empty2 = FALSE;
2621 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2623 if (!empty1)
2624 clear_tv(&var1);
2625 return NULL;
2627 if (get_tv_string_chk(&var2) == NULL)
2629 /* not a number or string */
2630 if (!empty1)
2631 clear_tv(&var1);
2632 clear_tv(&var2);
2633 return NULL;
2636 lp->ll_range = TRUE;
2638 else
2639 lp->ll_range = FALSE;
2641 if (*p != ']')
2643 if (!quiet)
2644 EMSG(_(e_missbrac));
2645 if (!empty1)
2646 clear_tv(&var1);
2647 if (lp->ll_range && !lp->ll_empty2)
2648 clear_tv(&var2);
2649 return NULL;
2652 /* Skip to past ']'. */
2653 ++p;
2656 if (lp->ll_tv->v_type == VAR_DICT)
2658 if (len == -1)
2660 /* "[key]": get key from "var1" */
2661 key = get_tv_string(&var1); /* is number or string */
2662 if (*key == NUL)
2664 if (!quiet)
2665 EMSG(_(e_emptykey));
2666 clear_tv(&var1);
2667 return NULL;
2670 lp->ll_list = NULL;
2671 lp->ll_dict = lp->ll_tv->vval.v_dict;
2672 lp->ll_di = dict_find(lp->ll_dict, key, len);
2673 if (lp->ll_di == NULL)
2675 /* Key does not exist in dict: may need to add it. */
2676 if (*p == '[' || *p == '.' || unlet)
2678 if (!quiet)
2679 EMSG2(_(e_dictkey), key);
2680 if (len == -1)
2681 clear_tv(&var1);
2682 return NULL;
2684 if (len == -1)
2685 lp->ll_newkey = vim_strsave(key);
2686 else
2687 lp->ll_newkey = vim_strnsave(key, len);
2688 if (len == -1)
2689 clear_tv(&var1);
2690 if (lp->ll_newkey == NULL)
2691 p = NULL;
2692 break;
2694 if (len == -1)
2695 clear_tv(&var1);
2696 lp->ll_tv = &lp->ll_di->di_tv;
2698 else
2701 * Get the number and item for the only or first index of the List.
2703 if (empty1)
2704 lp->ll_n1 = 0;
2705 else
2707 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2708 clear_tv(&var1);
2710 lp->ll_dict = NULL;
2711 lp->ll_list = lp->ll_tv->vval.v_list;
2712 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2713 if (lp->ll_li == NULL)
2715 if (lp->ll_n1 < 0)
2717 lp->ll_n1 = 0;
2718 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2721 if (lp->ll_li == NULL)
2723 if (lp->ll_range && !lp->ll_empty2)
2724 clear_tv(&var2);
2725 return NULL;
2729 * May need to find the item or absolute index for the second
2730 * index of a range.
2731 * When no index given: "lp->ll_empty2" is TRUE.
2732 * Otherwise "lp->ll_n2" is set to the second index.
2734 if (lp->ll_range && !lp->ll_empty2)
2736 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2737 clear_tv(&var2);
2738 if (lp->ll_n2 < 0)
2740 ni = list_find(lp->ll_list, lp->ll_n2);
2741 if (ni == NULL)
2742 return NULL;
2743 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2746 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2747 if (lp->ll_n1 < 0)
2748 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2749 if (lp->ll_n2 < lp->ll_n1)
2750 return NULL;
2753 lp->ll_tv = &lp->ll_li->li_tv;
2757 return p;
2761 * Clear lval "lp" that was filled by get_lval().
2763 static void
2764 clear_lval(lp)
2765 lval_T *lp;
2767 vim_free(lp->ll_exp_name);
2768 vim_free(lp->ll_newkey);
2772 * Set a variable that was parsed by get_lval() to "rettv".
2773 * "endp" points to just after the parsed name.
2774 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2776 static void
2777 set_var_lval(lp, endp, rettv, copy, op)
2778 lval_T *lp;
2779 char_u *endp;
2780 typval_T *rettv;
2781 int copy;
2782 char_u *op;
2784 int cc;
2785 listitem_T *ri;
2786 dictitem_T *di;
2788 if (lp->ll_tv == NULL)
2790 if (!check_changedtick(lp->ll_name))
2792 cc = *endp;
2793 *endp = NUL;
2794 if (op != NULL && *op != '=')
2796 typval_T tv;
2798 /* handle +=, -= and .= */
2799 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2800 &tv, TRUE) == OK)
2802 if (tv_op(&tv, rettv, op) == OK)
2803 set_var(lp->ll_name, &tv, FALSE);
2804 clear_tv(&tv);
2807 else
2808 set_var(lp->ll_name, rettv, copy);
2809 *endp = cc;
2812 else if (tv_check_lock(lp->ll_newkey == NULL
2813 ? lp->ll_tv->v_lock
2814 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2816 else if (lp->ll_range)
2819 * Assign the List values to the list items.
2821 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2823 if (op != NULL && *op != '=')
2824 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2825 else
2827 clear_tv(&lp->ll_li->li_tv);
2828 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2830 ri = ri->li_next;
2831 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2832 break;
2833 if (lp->ll_li->li_next == NULL)
2835 /* Need to add an empty item. */
2836 if (list_append_number(lp->ll_list, 0) == FAIL)
2838 ri = NULL;
2839 break;
2842 lp->ll_li = lp->ll_li->li_next;
2843 ++lp->ll_n1;
2845 if (ri != NULL)
2846 EMSG(_("E710: List value has more items than target"));
2847 else if (lp->ll_empty2
2848 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2849 : lp->ll_n1 != lp->ll_n2)
2850 EMSG(_("E711: List value has not enough items"));
2852 else
2855 * Assign to a List or Dictionary item.
2857 if (lp->ll_newkey != NULL)
2859 if (op != NULL && *op != '=')
2861 EMSG2(_(e_letwrong), op);
2862 return;
2865 /* Need to add an item to the Dictionary. */
2866 di = dictitem_alloc(lp->ll_newkey);
2867 if (di == NULL)
2868 return;
2869 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2871 vim_free(di);
2872 return;
2874 lp->ll_tv = &di->di_tv;
2876 else if (op != NULL && *op != '=')
2878 tv_op(lp->ll_tv, rettv, op);
2879 return;
2881 else
2882 clear_tv(lp->ll_tv);
2885 * Assign the value to the variable or list item.
2887 if (copy)
2888 copy_tv(rettv, lp->ll_tv);
2889 else
2891 *lp->ll_tv = *rettv;
2892 lp->ll_tv->v_lock = 0;
2893 init_tv(rettv);
2899 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2900 * Returns OK or FAIL.
2902 static int
2903 tv_op(tv1, tv2, op)
2904 typval_T *tv1;
2905 typval_T *tv2;
2906 char_u *op;
2908 long n;
2909 char_u numbuf[NUMBUFLEN];
2910 char_u *s;
2912 /* Can't do anything with a Funcref or a Dict on the right. */
2913 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2915 switch (tv1->v_type)
2917 case VAR_DICT:
2918 case VAR_FUNC:
2919 break;
2921 case VAR_LIST:
2922 if (*op != '+' || tv2->v_type != VAR_LIST)
2923 break;
2924 /* List += List */
2925 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2926 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2927 return OK;
2929 case VAR_NUMBER:
2930 case VAR_STRING:
2931 if (tv2->v_type == VAR_LIST)
2932 break;
2933 if (*op == '+' || *op == '-')
2935 /* nr += nr or nr -= nr*/
2936 n = get_tv_number(tv1);
2937 #ifdef FEAT_FLOAT
2938 if (tv2->v_type == VAR_FLOAT)
2940 float_T f = n;
2942 if (*op == '+')
2943 f += tv2->vval.v_float;
2944 else
2945 f -= tv2->vval.v_float;
2946 clear_tv(tv1);
2947 tv1->v_type = VAR_FLOAT;
2948 tv1->vval.v_float = f;
2950 else
2951 #endif
2953 if (*op == '+')
2954 n += get_tv_number(tv2);
2955 else
2956 n -= get_tv_number(tv2);
2957 clear_tv(tv1);
2958 tv1->v_type = VAR_NUMBER;
2959 tv1->vval.v_number = n;
2962 else
2964 if (tv2->v_type == VAR_FLOAT)
2965 break;
2967 /* str .= str */
2968 s = get_tv_string(tv1);
2969 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2970 clear_tv(tv1);
2971 tv1->v_type = VAR_STRING;
2972 tv1->vval.v_string = s;
2974 return OK;
2976 #ifdef FEAT_FLOAT
2977 case VAR_FLOAT:
2979 float_T f;
2981 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2982 && tv2->v_type != VAR_NUMBER
2983 && tv2->v_type != VAR_STRING))
2984 break;
2985 if (tv2->v_type == VAR_FLOAT)
2986 f = tv2->vval.v_float;
2987 else
2988 f = get_tv_number(tv2);
2989 if (*op == '+')
2990 tv1->vval.v_float += f;
2991 else
2992 tv1->vval.v_float -= f;
2994 return OK;
2995 #endif
2999 EMSG2(_(e_letwrong), op);
3000 return FAIL;
3004 * Add a watcher to a list.
3006 static void
3007 list_add_watch(l, lw)
3008 list_T *l;
3009 listwatch_T *lw;
3011 lw->lw_next = l->lv_watch;
3012 l->lv_watch = lw;
3016 * Remove a watcher from a list.
3017 * No warning when it isn't found...
3019 static void
3020 list_rem_watch(l, lwrem)
3021 list_T *l;
3022 listwatch_T *lwrem;
3024 listwatch_T *lw, **lwp;
3026 lwp = &l->lv_watch;
3027 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3029 if (lw == lwrem)
3031 *lwp = lw->lw_next;
3032 break;
3034 lwp = &lw->lw_next;
3039 * Just before removing an item from a list: advance watchers to the next
3040 * item.
3042 static void
3043 list_fix_watch(l, item)
3044 list_T *l;
3045 listitem_T *item;
3047 listwatch_T *lw;
3049 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3050 if (lw->lw_item == item)
3051 lw->lw_item = item->li_next;
3055 * Evaluate the expression used in a ":for var in expr" command.
3056 * "arg" points to "var".
3057 * Set "*errp" to TRUE for an error, FALSE otherwise;
3058 * Return a pointer that holds the info. Null when there is an error.
3060 void *
3061 eval_for_line(arg, errp, nextcmdp, skip)
3062 char_u *arg;
3063 int *errp;
3064 char_u **nextcmdp;
3065 int skip;
3067 forinfo_T *fi;
3068 char_u *expr;
3069 typval_T tv;
3070 list_T *l;
3072 *errp = TRUE; /* default: there is an error */
3074 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3075 if (fi == NULL)
3076 return NULL;
3078 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3079 if (expr == NULL)
3080 return fi;
3082 expr = skipwhite(expr);
3083 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3085 EMSG(_("E690: Missing \"in\" after :for"));
3086 return fi;
3089 if (skip)
3090 ++emsg_skip;
3091 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3093 *errp = FALSE;
3094 if (!skip)
3096 l = tv.vval.v_list;
3097 if (tv.v_type != VAR_LIST || l == NULL)
3099 EMSG(_(e_listreq));
3100 clear_tv(&tv);
3102 else
3104 /* No need to increment the refcount, it's already set for the
3105 * list being used in "tv". */
3106 fi->fi_list = l;
3107 list_add_watch(l, &fi->fi_lw);
3108 fi->fi_lw.lw_item = l->lv_first;
3112 if (skip)
3113 --emsg_skip;
3115 return fi;
3119 * Use the first item in a ":for" list. Advance to the next.
3120 * Assign the values to the variable (list). "arg" points to the first one.
3121 * Return TRUE when a valid item was found, FALSE when at end of list or
3122 * something wrong.
3125 next_for_item(fi_void, arg)
3126 void *fi_void;
3127 char_u *arg;
3129 forinfo_T *fi = (forinfo_T *)fi_void;
3130 int result;
3131 listitem_T *item;
3133 item = fi->fi_lw.lw_item;
3134 if (item == NULL)
3135 result = FALSE;
3136 else
3138 fi->fi_lw.lw_item = item->li_next;
3139 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3140 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3142 return result;
3146 * Free the structure used to store info used by ":for".
3148 void
3149 free_for_info(fi_void)
3150 void *fi_void;
3152 forinfo_T *fi = (forinfo_T *)fi_void;
3154 if (fi != NULL && fi->fi_list != NULL)
3156 list_rem_watch(fi->fi_list, &fi->fi_lw);
3157 list_unref(fi->fi_list);
3159 vim_free(fi);
3162 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3164 void
3165 set_context_for_expression(xp, arg, cmdidx)
3166 expand_T *xp;
3167 char_u *arg;
3168 cmdidx_T cmdidx;
3170 int got_eq = FALSE;
3171 int c;
3172 char_u *p;
3174 if (cmdidx == CMD_let)
3176 xp->xp_context = EXPAND_USER_VARS;
3177 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3179 /* ":let var1 var2 ...": find last space. */
3180 for (p = arg + STRLEN(arg); p >= arg; )
3182 xp->xp_pattern = p;
3183 mb_ptr_back(arg, p);
3184 if (vim_iswhite(*p))
3185 break;
3187 return;
3190 else
3191 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3192 : EXPAND_EXPRESSION;
3193 while ((xp->xp_pattern = vim_strpbrk(arg,
3194 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3196 c = *xp->xp_pattern;
3197 if (c == '&')
3199 c = xp->xp_pattern[1];
3200 if (c == '&')
3202 ++xp->xp_pattern;
3203 xp->xp_context = cmdidx != CMD_let || got_eq
3204 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3206 else if (c != ' ')
3208 xp->xp_context = EXPAND_SETTINGS;
3209 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3210 xp->xp_pattern += 2;
3214 else if (c == '$')
3216 /* environment variable */
3217 xp->xp_context = EXPAND_ENV_VARS;
3219 else if (c == '=')
3221 got_eq = TRUE;
3222 xp->xp_context = EXPAND_EXPRESSION;
3224 else if (c == '<'
3225 && xp->xp_context == EXPAND_FUNCTIONS
3226 && vim_strchr(xp->xp_pattern, '(') == NULL)
3228 /* Function name can start with "<SNR>" */
3229 break;
3231 else if (cmdidx != CMD_let || got_eq)
3233 if (c == '"') /* string */
3235 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3236 if (c == '\\' && xp->xp_pattern[1] != NUL)
3237 ++xp->xp_pattern;
3238 xp->xp_context = EXPAND_NOTHING;
3240 else if (c == '\'') /* literal string */
3242 /* Trick: '' is like stopping and starting a literal string. */
3243 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3244 /* skip */ ;
3245 xp->xp_context = EXPAND_NOTHING;
3247 else if (c == '|')
3249 if (xp->xp_pattern[1] == '|')
3251 ++xp->xp_pattern;
3252 xp->xp_context = EXPAND_EXPRESSION;
3254 else
3255 xp->xp_context = EXPAND_COMMANDS;
3257 else
3258 xp->xp_context = EXPAND_EXPRESSION;
3260 else
3261 /* Doesn't look like something valid, expand as an expression
3262 * anyway. */
3263 xp->xp_context = EXPAND_EXPRESSION;
3264 arg = xp->xp_pattern;
3265 if (*arg != NUL)
3266 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3267 /* skip */ ;
3269 xp->xp_pattern = arg;
3272 #endif /* FEAT_CMDL_COMPL */
3275 * ":1,25call func(arg1, arg2)" function call.
3277 void
3278 ex_call(eap)
3279 exarg_T *eap;
3281 char_u *arg = eap->arg;
3282 char_u *startarg;
3283 char_u *name;
3284 char_u *tofree;
3285 int len;
3286 typval_T rettv;
3287 linenr_T lnum;
3288 int doesrange;
3289 int failed = FALSE;
3290 funcdict_T fudi;
3292 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3293 if (fudi.fd_newkey != NULL)
3295 /* Still need to give an error message for missing key. */
3296 EMSG2(_(e_dictkey), fudi.fd_newkey);
3297 vim_free(fudi.fd_newkey);
3299 if (tofree == NULL)
3300 return;
3302 /* Increase refcount on dictionary, it could get deleted when evaluating
3303 * the arguments. */
3304 if (fudi.fd_dict != NULL)
3305 ++fudi.fd_dict->dv_refcount;
3307 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3308 len = (int)STRLEN(tofree);
3309 name = deref_func_name(tofree, &len);
3311 /* Skip white space to allow ":call func ()". Not good, but required for
3312 * backward compatibility. */
3313 startarg = skipwhite(arg);
3314 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3316 if (*startarg != '(')
3318 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3319 goto end;
3323 * When skipping, evaluate the function once, to find the end of the
3324 * arguments.
3325 * When the function takes a range, this is discovered after the first
3326 * call, and the loop is broken.
3328 if (eap->skip)
3330 ++emsg_skip;
3331 lnum = eap->line2; /* do it once, also with an invalid range */
3333 else
3334 lnum = eap->line1;
3335 for ( ; lnum <= eap->line2; ++lnum)
3337 if (!eap->skip && eap->addr_count > 0)
3339 curwin->w_cursor.lnum = lnum;
3340 curwin->w_cursor.col = 0;
3342 arg = startarg;
3343 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3344 eap->line1, eap->line2, &doesrange,
3345 !eap->skip, fudi.fd_dict) == FAIL)
3347 failed = TRUE;
3348 break;
3351 /* Handle a function returning a Funcref, Dictionary or List. */
3352 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3354 failed = TRUE;
3355 break;
3358 clear_tv(&rettv);
3359 if (doesrange || eap->skip)
3360 break;
3362 /* Stop when immediately aborting on error, or when an interrupt
3363 * occurred or an exception was thrown but not caught.
3364 * get_func_tv() returned OK, so that the check for trailing
3365 * characters below is executed. */
3366 if (aborting())
3367 break;
3369 if (eap->skip)
3370 --emsg_skip;
3372 if (!failed)
3374 /* Check for trailing illegal characters and a following command. */
3375 if (!ends_excmd(*arg))
3377 emsg_severe = TRUE;
3378 EMSG(_(e_trailing));
3380 else
3381 eap->nextcmd = check_nextcmd(arg);
3384 end:
3385 dict_unref(fudi.fd_dict);
3386 vim_free(tofree);
3390 * ":unlet[!] var1 ... " command.
3392 void
3393 ex_unlet(eap)
3394 exarg_T *eap;
3396 ex_unletlock(eap, eap->arg, 0);
3400 * ":lockvar" and ":unlockvar" commands
3402 void
3403 ex_lockvar(eap)
3404 exarg_T *eap;
3406 char_u *arg = eap->arg;
3407 int deep = 2;
3409 if (eap->forceit)
3410 deep = -1;
3411 else if (vim_isdigit(*arg))
3413 deep = getdigits(&arg);
3414 arg = skipwhite(arg);
3417 ex_unletlock(eap, arg, deep);
3421 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3423 static void
3424 ex_unletlock(eap, argstart, deep)
3425 exarg_T *eap;
3426 char_u *argstart;
3427 int deep;
3429 char_u *arg = argstart;
3430 char_u *name_end;
3431 int error = FALSE;
3432 lval_T lv;
3436 /* Parse the name and find the end. */
3437 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3438 FNE_CHECK_START);
3439 if (lv.ll_name == NULL)
3440 error = TRUE; /* error but continue parsing */
3441 if (name_end == NULL || (!vim_iswhite(*name_end)
3442 && !ends_excmd(*name_end)))
3444 if (name_end != NULL)
3446 emsg_severe = TRUE;
3447 EMSG(_(e_trailing));
3449 if (!(eap->skip || error))
3450 clear_lval(&lv);
3451 break;
3454 if (!error && !eap->skip)
3456 if (eap->cmdidx == CMD_unlet)
3458 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3459 error = TRUE;
3461 else
3463 if (do_lock_var(&lv, name_end, deep,
3464 eap->cmdidx == CMD_lockvar) == FAIL)
3465 error = TRUE;
3469 if (!eap->skip)
3470 clear_lval(&lv);
3472 arg = skipwhite(name_end);
3473 } while (!ends_excmd(*arg));
3475 eap->nextcmd = check_nextcmd(arg);
3478 static int
3479 do_unlet_var(lp, name_end, forceit)
3480 lval_T *lp;
3481 char_u *name_end;
3482 int forceit;
3484 int ret = OK;
3485 int cc;
3487 if (lp->ll_tv == NULL)
3489 cc = *name_end;
3490 *name_end = NUL;
3492 /* Normal name or expanded name. */
3493 if (check_changedtick(lp->ll_name))
3494 ret = FAIL;
3495 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3496 ret = FAIL;
3497 *name_end = cc;
3499 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3500 return FAIL;
3501 else if (lp->ll_range)
3503 listitem_T *li;
3505 /* Delete a range of List items. */
3506 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3508 li = lp->ll_li->li_next;
3509 listitem_remove(lp->ll_list, lp->ll_li);
3510 lp->ll_li = li;
3511 ++lp->ll_n1;
3514 else
3516 if (lp->ll_list != NULL)
3517 /* unlet a List item. */
3518 listitem_remove(lp->ll_list, lp->ll_li);
3519 else
3520 /* unlet a Dictionary item. */
3521 dictitem_remove(lp->ll_dict, lp->ll_di);
3524 return ret;
3528 * "unlet" a variable. Return OK if it existed, FAIL if not.
3529 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3532 do_unlet(name, forceit)
3533 char_u *name;
3534 int forceit;
3536 hashtab_T *ht;
3537 hashitem_T *hi;
3538 char_u *varname;
3539 dictitem_T *di;
3541 ht = find_var_ht(name, &varname);
3542 if (ht != NULL && *varname != NUL)
3544 hi = hash_find(ht, varname);
3545 if (!HASHITEM_EMPTY(hi))
3547 di = HI2DI(hi);
3548 if (var_check_fixed(di->di_flags, name)
3549 || var_check_ro(di->di_flags, name))
3550 return FAIL;
3551 delete_var(ht, hi);
3552 return OK;
3555 if (forceit)
3556 return OK;
3557 EMSG2(_("E108: No such variable: \"%s\""), name);
3558 return FAIL;
3562 * Lock or unlock variable indicated by "lp".
3563 * "deep" is the levels to go (-1 for unlimited);
3564 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3566 static int
3567 do_lock_var(lp, name_end, deep, lock)
3568 lval_T *lp;
3569 char_u *name_end;
3570 int deep;
3571 int lock;
3573 int ret = OK;
3574 int cc;
3575 dictitem_T *di;
3577 if (deep == 0) /* nothing to do */
3578 return OK;
3580 if (lp->ll_tv == NULL)
3582 cc = *name_end;
3583 *name_end = NUL;
3585 /* Normal name or expanded name. */
3586 if (check_changedtick(lp->ll_name))
3587 ret = FAIL;
3588 else
3590 di = find_var(lp->ll_name, NULL);
3591 if (di == NULL)
3592 ret = FAIL;
3593 else
3595 if (lock)
3596 di->di_flags |= DI_FLAGS_LOCK;
3597 else
3598 di->di_flags &= ~DI_FLAGS_LOCK;
3599 item_lock(&di->di_tv, deep, lock);
3602 *name_end = cc;
3604 else if (lp->ll_range)
3606 listitem_T *li = lp->ll_li;
3608 /* (un)lock a range of List items. */
3609 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3611 item_lock(&li->li_tv, deep, lock);
3612 li = li->li_next;
3613 ++lp->ll_n1;
3616 else if (lp->ll_list != NULL)
3617 /* (un)lock a List item. */
3618 item_lock(&lp->ll_li->li_tv, deep, lock);
3619 else
3620 /* un(lock) a Dictionary item. */
3621 item_lock(&lp->ll_di->di_tv, deep, lock);
3623 return ret;
3627 * Lock or unlock an item. "deep" is nr of levels to go.
3629 static void
3630 item_lock(tv, deep, lock)
3631 typval_T *tv;
3632 int deep;
3633 int lock;
3635 static int recurse = 0;
3636 list_T *l;
3637 listitem_T *li;
3638 dict_T *d;
3639 hashitem_T *hi;
3640 int todo;
3642 if (recurse >= DICT_MAXNEST)
3644 EMSG(_("E743: variable nested too deep for (un)lock"));
3645 return;
3647 if (deep == 0)
3648 return;
3649 ++recurse;
3651 /* lock/unlock the item itself */
3652 if (lock)
3653 tv->v_lock |= VAR_LOCKED;
3654 else
3655 tv->v_lock &= ~VAR_LOCKED;
3657 switch (tv->v_type)
3659 case VAR_LIST:
3660 if ((l = tv->vval.v_list) != NULL)
3662 if (lock)
3663 l->lv_lock |= VAR_LOCKED;
3664 else
3665 l->lv_lock &= ~VAR_LOCKED;
3666 if (deep < 0 || deep > 1)
3667 /* recursive: lock/unlock the items the List contains */
3668 for (li = l->lv_first; li != NULL; li = li->li_next)
3669 item_lock(&li->li_tv, deep - 1, lock);
3671 break;
3672 case VAR_DICT:
3673 if ((d = tv->vval.v_dict) != NULL)
3675 if (lock)
3676 d->dv_lock |= VAR_LOCKED;
3677 else
3678 d->dv_lock &= ~VAR_LOCKED;
3679 if (deep < 0 || deep > 1)
3681 /* recursive: lock/unlock the items the List contains */
3682 todo = (int)d->dv_hashtab.ht_used;
3683 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3685 if (!HASHITEM_EMPTY(hi))
3687 --todo;
3688 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3694 --recurse;
3698 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3699 * or it refers to a List or Dictionary that is locked.
3701 static int
3702 tv_islocked(tv)
3703 typval_T *tv;
3705 return (tv->v_lock & VAR_LOCKED)
3706 || (tv->v_type == VAR_LIST
3707 && tv->vval.v_list != NULL
3708 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3709 || (tv->v_type == VAR_DICT
3710 && tv->vval.v_dict != NULL
3711 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3714 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3716 * Delete all "menutrans_" variables.
3718 void
3719 del_menutrans_vars()
3721 hashitem_T *hi;
3722 int todo;
3724 hash_lock(&globvarht);
3725 todo = (int)globvarht.ht_used;
3726 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3728 if (!HASHITEM_EMPTY(hi))
3730 --todo;
3731 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3732 delete_var(&globvarht, hi);
3735 hash_unlock(&globvarht);
3737 #endif
3739 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3742 * Local string buffer for the next two functions to store a variable name
3743 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3744 * get_user_var_name().
3747 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3749 static char_u *varnamebuf = NULL;
3750 static int varnamebuflen = 0;
3753 * Function to concatenate a prefix and a variable name.
3755 static char_u *
3756 cat_prefix_varname(prefix, name)
3757 int prefix;
3758 char_u *name;
3760 int len;
3762 len = (int)STRLEN(name) + 3;
3763 if (len > varnamebuflen)
3765 vim_free(varnamebuf);
3766 len += 10; /* some additional space */
3767 varnamebuf = alloc(len);
3768 if (varnamebuf == NULL)
3770 varnamebuflen = 0;
3771 return NULL;
3773 varnamebuflen = len;
3775 *varnamebuf = prefix;
3776 varnamebuf[1] = ':';
3777 STRCPY(varnamebuf + 2, name);
3778 return varnamebuf;
3782 * Function given to ExpandGeneric() to obtain the list of user defined
3783 * (global/buffer/window/built-in) variable names.
3785 char_u *
3786 get_user_var_name(xp, idx)
3787 expand_T *xp;
3788 int idx;
3790 static long_u gdone;
3791 static long_u bdone;
3792 static long_u wdone;
3793 #ifdef FEAT_WINDOWS
3794 static long_u tdone;
3795 #endif
3796 static int vidx;
3797 static hashitem_T *hi;
3798 hashtab_T *ht;
3800 if (idx == 0)
3802 gdone = bdone = wdone = vidx = 0;
3803 #ifdef FEAT_WINDOWS
3804 tdone = 0;
3805 #endif
3808 /* Global variables */
3809 if (gdone < globvarht.ht_used)
3811 if (gdone++ == 0)
3812 hi = globvarht.ht_array;
3813 else
3814 ++hi;
3815 while (HASHITEM_EMPTY(hi))
3816 ++hi;
3817 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3818 return cat_prefix_varname('g', hi->hi_key);
3819 return hi->hi_key;
3822 /* b: variables */
3823 ht = &curbuf->b_vars.dv_hashtab;
3824 if (bdone < ht->ht_used)
3826 if (bdone++ == 0)
3827 hi = ht->ht_array;
3828 else
3829 ++hi;
3830 while (HASHITEM_EMPTY(hi))
3831 ++hi;
3832 return cat_prefix_varname('b', hi->hi_key);
3834 if (bdone == ht->ht_used)
3836 ++bdone;
3837 return (char_u *)"b:changedtick";
3840 /* w: variables */
3841 ht = &curwin->w_vars.dv_hashtab;
3842 if (wdone < ht->ht_used)
3844 if (wdone++ == 0)
3845 hi = ht->ht_array;
3846 else
3847 ++hi;
3848 while (HASHITEM_EMPTY(hi))
3849 ++hi;
3850 return cat_prefix_varname('w', hi->hi_key);
3853 #ifdef FEAT_WINDOWS
3854 /* t: variables */
3855 ht = &curtab->tp_vars.dv_hashtab;
3856 if (tdone < ht->ht_used)
3858 if (tdone++ == 0)
3859 hi = ht->ht_array;
3860 else
3861 ++hi;
3862 while (HASHITEM_EMPTY(hi))
3863 ++hi;
3864 return cat_prefix_varname('t', hi->hi_key);
3866 #endif
3868 /* v: variables */
3869 if (vidx < VV_LEN)
3870 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3872 vim_free(varnamebuf);
3873 varnamebuf = NULL;
3874 varnamebuflen = 0;
3875 return NULL;
3878 #endif /* FEAT_CMDL_COMPL */
3881 * types for expressions.
3883 typedef enum
3885 TYPE_UNKNOWN = 0
3886 , TYPE_EQUAL /* == */
3887 , TYPE_NEQUAL /* != */
3888 , TYPE_GREATER /* > */
3889 , TYPE_GEQUAL /* >= */
3890 , TYPE_SMALLER /* < */
3891 , TYPE_SEQUAL /* <= */
3892 , TYPE_MATCH /* =~ */
3893 , TYPE_NOMATCH /* !~ */
3894 } exptype_T;
3897 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3898 * executed. The function may return OK, but the rettv will be of type
3899 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3903 * Handle zero level expression.
3904 * This calls eval1() and handles error message and nextcmd.
3905 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3906 * Note: "rettv.v_lock" is not set.
3907 * Return OK or FAIL.
3909 static int
3910 eval0(arg, rettv, nextcmd, evaluate)
3911 char_u *arg;
3912 typval_T *rettv;
3913 char_u **nextcmd;
3914 int evaluate;
3916 int ret;
3917 char_u *p;
3919 p = skipwhite(arg);
3920 ret = eval1(&p, rettv, evaluate);
3921 if (ret == FAIL || !ends_excmd(*p))
3923 if (ret != FAIL)
3924 clear_tv(rettv);
3926 * Report the invalid expression unless the expression evaluation has
3927 * been cancelled due to an aborting error, an interrupt, or an
3928 * exception.
3930 if (!aborting())
3931 EMSG2(_(e_invexpr2), arg);
3932 ret = FAIL;
3934 if (nextcmd != NULL)
3935 *nextcmd = check_nextcmd(p);
3937 return ret;
3941 * Handle top level expression:
3942 * expr2 ? expr1 : expr1
3944 * "arg" must point to the first non-white of the expression.
3945 * "arg" is advanced to the next non-white after the recognized expression.
3947 * Note: "rettv.v_lock" is not set.
3949 * Return OK or FAIL.
3951 static int
3952 eval1(arg, rettv, evaluate)
3953 char_u **arg;
3954 typval_T *rettv;
3955 int evaluate;
3957 int result;
3958 typval_T var2;
3961 * Get the first variable.
3963 if (eval2(arg, rettv, evaluate) == FAIL)
3964 return FAIL;
3966 if ((*arg)[0] == '?')
3968 result = FALSE;
3969 if (evaluate)
3971 int error = FALSE;
3973 if (get_tv_number_chk(rettv, &error) != 0)
3974 result = TRUE;
3975 clear_tv(rettv);
3976 if (error)
3977 return FAIL;
3981 * Get the second variable.
3983 *arg = skipwhite(*arg + 1);
3984 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3985 return FAIL;
3988 * Check for the ":".
3990 if ((*arg)[0] != ':')
3992 EMSG(_("E109: Missing ':' after '?'"));
3993 if (evaluate && result)
3994 clear_tv(rettv);
3995 return FAIL;
3999 * Get the third variable.
4001 *arg = skipwhite(*arg + 1);
4002 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
4004 if (evaluate && result)
4005 clear_tv(rettv);
4006 return FAIL;
4008 if (evaluate && !result)
4009 *rettv = var2;
4012 return OK;
4016 * Handle first level expression:
4017 * expr2 || expr2 || expr2 logical OR
4019 * "arg" must point to the first non-white of the expression.
4020 * "arg" is advanced to the next non-white after the recognized expression.
4022 * Return OK or FAIL.
4024 static int
4025 eval2(arg, rettv, evaluate)
4026 char_u **arg;
4027 typval_T *rettv;
4028 int evaluate;
4030 typval_T var2;
4031 long result;
4032 int first;
4033 int error = FALSE;
4036 * Get the first variable.
4038 if (eval3(arg, rettv, evaluate) == FAIL)
4039 return FAIL;
4042 * Repeat until there is no following "||".
4044 first = TRUE;
4045 result = FALSE;
4046 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4048 if (evaluate && first)
4050 if (get_tv_number_chk(rettv, &error) != 0)
4051 result = TRUE;
4052 clear_tv(rettv);
4053 if (error)
4054 return FAIL;
4055 first = FALSE;
4059 * Get the second variable.
4061 *arg = skipwhite(*arg + 2);
4062 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4063 return FAIL;
4066 * Compute the result.
4068 if (evaluate && !result)
4070 if (get_tv_number_chk(&var2, &error) != 0)
4071 result = TRUE;
4072 clear_tv(&var2);
4073 if (error)
4074 return FAIL;
4076 if (evaluate)
4078 rettv->v_type = VAR_NUMBER;
4079 rettv->vval.v_number = result;
4083 return OK;
4087 * Handle second level expression:
4088 * expr3 && expr3 && expr3 logical AND
4090 * "arg" must point to the first non-white of the expression.
4091 * "arg" is advanced to the next non-white after the recognized expression.
4093 * Return OK or FAIL.
4095 static int
4096 eval3(arg, rettv, evaluate)
4097 char_u **arg;
4098 typval_T *rettv;
4099 int evaluate;
4101 typval_T var2;
4102 long result;
4103 int first;
4104 int error = FALSE;
4107 * Get the first variable.
4109 if (eval4(arg, rettv, evaluate) == FAIL)
4110 return FAIL;
4113 * Repeat until there is no following "&&".
4115 first = TRUE;
4116 result = TRUE;
4117 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4119 if (evaluate && first)
4121 if (get_tv_number_chk(rettv, &error) == 0)
4122 result = FALSE;
4123 clear_tv(rettv);
4124 if (error)
4125 return FAIL;
4126 first = FALSE;
4130 * Get the second variable.
4132 *arg = skipwhite(*arg + 2);
4133 if (eval4(arg, &var2, evaluate && result) == FAIL)
4134 return FAIL;
4137 * Compute the result.
4139 if (evaluate && result)
4141 if (get_tv_number_chk(&var2, &error) == 0)
4142 result = FALSE;
4143 clear_tv(&var2);
4144 if (error)
4145 return FAIL;
4147 if (evaluate)
4149 rettv->v_type = VAR_NUMBER;
4150 rettv->vval.v_number = result;
4154 return OK;
4158 * Handle third level expression:
4159 * var1 == var2
4160 * var1 =~ var2
4161 * var1 != var2
4162 * var1 !~ var2
4163 * var1 > var2
4164 * var1 >= var2
4165 * var1 < var2
4166 * var1 <= var2
4167 * var1 is var2
4168 * var1 isnot var2
4170 * "arg" must point to the first non-white of the expression.
4171 * "arg" is advanced to the next non-white after the recognized expression.
4173 * Return OK or FAIL.
4175 static int
4176 eval4(arg, rettv, evaluate)
4177 char_u **arg;
4178 typval_T *rettv;
4179 int evaluate;
4181 typval_T var2;
4182 char_u *p;
4183 int i;
4184 exptype_T type = TYPE_UNKNOWN;
4185 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4186 int len = 2;
4187 long n1, n2;
4188 char_u *s1, *s2;
4189 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4190 regmatch_T regmatch;
4191 int ic;
4192 char_u *save_cpo;
4195 * Get the first variable.
4197 if (eval5(arg, rettv, evaluate) == FAIL)
4198 return FAIL;
4200 p = *arg;
4201 switch (p[0])
4203 case '=': if (p[1] == '=')
4204 type = TYPE_EQUAL;
4205 else if (p[1] == '~')
4206 type = TYPE_MATCH;
4207 break;
4208 case '!': if (p[1] == '=')
4209 type = TYPE_NEQUAL;
4210 else if (p[1] == '~')
4211 type = TYPE_NOMATCH;
4212 break;
4213 case '>': if (p[1] != '=')
4215 type = TYPE_GREATER;
4216 len = 1;
4218 else
4219 type = TYPE_GEQUAL;
4220 break;
4221 case '<': if (p[1] != '=')
4223 type = TYPE_SMALLER;
4224 len = 1;
4226 else
4227 type = TYPE_SEQUAL;
4228 break;
4229 case 'i': if (p[1] == 's')
4231 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4232 len = 5;
4233 if (!vim_isIDc(p[len]))
4235 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4236 type_is = TRUE;
4239 break;
4243 * If there is a comparative operator, use it.
4245 if (type != TYPE_UNKNOWN)
4247 /* extra question mark appended: ignore case */
4248 if (p[len] == '?')
4250 ic = TRUE;
4251 ++len;
4253 /* extra '#' appended: match case */
4254 else if (p[len] == '#')
4256 ic = FALSE;
4257 ++len;
4259 /* nothing appended: use 'ignorecase' */
4260 else
4261 ic = p_ic;
4264 * Get the second variable.
4266 *arg = skipwhite(p + len);
4267 if (eval5(arg, &var2, evaluate) == FAIL)
4269 clear_tv(rettv);
4270 return FAIL;
4273 if (evaluate)
4275 if (type_is && rettv->v_type != var2.v_type)
4277 /* For "is" a different type always means FALSE, for "notis"
4278 * it means TRUE. */
4279 n1 = (type == TYPE_NEQUAL);
4281 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4283 if (type_is)
4285 n1 = (rettv->v_type == var2.v_type
4286 && rettv->vval.v_list == var2.vval.v_list);
4287 if (type == TYPE_NEQUAL)
4288 n1 = !n1;
4290 else if (rettv->v_type != var2.v_type
4291 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4293 if (rettv->v_type != var2.v_type)
4294 EMSG(_("E691: Can only compare List with List"));
4295 else
4296 EMSG(_("E692: Invalid operation for Lists"));
4297 clear_tv(rettv);
4298 clear_tv(&var2);
4299 return FAIL;
4301 else
4303 /* Compare two Lists for being equal or unequal. */
4304 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4305 if (type == TYPE_NEQUAL)
4306 n1 = !n1;
4310 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4312 if (type_is)
4314 n1 = (rettv->v_type == var2.v_type
4315 && rettv->vval.v_dict == var2.vval.v_dict);
4316 if (type == TYPE_NEQUAL)
4317 n1 = !n1;
4319 else if (rettv->v_type != var2.v_type
4320 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4322 if (rettv->v_type != var2.v_type)
4323 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4324 else
4325 EMSG(_("E736: Invalid operation for Dictionary"));
4326 clear_tv(rettv);
4327 clear_tv(&var2);
4328 return FAIL;
4330 else
4332 /* Compare two Dictionaries for being equal or unequal. */
4333 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4334 if (type == TYPE_NEQUAL)
4335 n1 = !n1;
4339 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4341 if (rettv->v_type != var2.v_type
4342 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4344 if (rettv->v_type != var2.v_type)
4345 EMSG(_("E693: Can only compare Funcref with Funcref"));
4346 else
4347 EMSG(_("E694: Invalid operation for Funcrefs"));
4348 clear_tv(rettv);
4349 clear_tv(&var2);
4350 return FAIL;
4352 else
4354 /* Compare two Funcrefs for being equal or unequal. */
4355 if (rettv->vval.v_string == NULL
4356 || var2.vval.v_string == NULL)
4357 n1 = FALSE;
4358 else
4359 n1 = STRCMP(rettv->vval.v_string,
4360 var2.vval.v_string) == 0;
4361 if (type == TYPE_NEQUAL)
4362 n1 = !n1;
4366 #ifdef FEAT_FLOAT
4368 * If one of the two variables is a float, compare as a float.
4369 * When using "=~" or "!~", always compare as string.
4371 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4372 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4374 float_T f1, f2;
4376 if (rettv->v_type == VAR_FLOAT)
4377 f1 = rettv->vval.v_float;
4378 else
4379 f1 = get_tv_number(rettv);
4380 if (var2.v_type == VAR_FLOAT)
4381 f2 = var2.vval.v_float;
4382 else
4383 f2 = get_tv_number(&var2);
4384 n1 = FALSE;
4385 switch (type)
4387 case TYPE_EQUAL: n1 = (f1 == f2); break;
4388 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4389 case TYPE_GREATER: n1 = (f1 > f2); break;
4390 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4391 case TYPE_SMALLER: n1 = (f1 < f2); break;
4392 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4393 case TYPE_UNKNOWN:
4394 case TYPE_MATCH:
4395 case TYPE_NOMATCH: break; /* avoid gcc warning */
4398 #endif
4401 * If one of the two variables is a number, compare as a number.
4402 * When using "=~" or "!~", always compare as string.
4404 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4405 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4407 n1 = get_tv_number(rettv);
4408 n2 = get_tv_number(&var2);
4409 switch (type)
4411 case TYPE_EQUAL: n1 = (n1 == n2); break;
4412 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4413 case TYPE_GREATER: n1 = (n1 > n2); break;
4414 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4415 case TYPE_SMALLER: n1 = (n1 < n2); break;
4416 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4417 case TYPE_UNKNOWN:
4418 case TYPE_MATCH:
4419 case TYPE_NOMATCH: break; /* avoid gcc warning */
4422 else
4424 s1 = get_tv_string_buf(rettv, buf1);
4425 s2 = get_tv_string_buf(&var2, buf2);
4426 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4427 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4428 else
4429 i = 0;
4430 n1 = FALSE;
4431 switch (type)
4433 case TYPE_EQUAL: n1 = (i == 0); break;
4434 case TYPE_NEQUAL: n1 = (i != 0); break;
4435 case TYPE_GREATER: n1 = (i > 0); break;
4436 case TYPE_GEQUAL: n1 = (i >= 0); break;
4437 case TYPE_SMALLER: n1 = (i < 0); break;
4438 case TYPE_SEQUAL: n1 = (i <= 0); break;
4440 case TYPE_MATCH:
4441 case TYPE_NOMATCH:
4442 /* avoid 'l' flag in 'cpoptions' */
4443 save_cpo = p_cpo;
4444 p_cpo = (char_u *)"";
4445 regmatch.regprog = vim_regcomp(s2,
4446 RE_MAGIC + RE_STRING);
4447 regmatch.rm_ic = ic;
4448 if (regmatch.regprog != NULL)
4450 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4451 vim_free(regmatch.regprog);
4452 if (type == TYPE_NOMATCH)
4453 n1 = !n1;
4455 p_cpo = save_cpo;
4456 break;
4458 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4461 clear_tv(rettv);
4462 clear_tv(&var2);
4463 rettv->v_type = VAR_NUMBER;
4464 rettv->vval.v_number = n1;
4468 return OK;
4472 * Handle fourth level expression:
4473 * + number addition
4474 * - number subtraction
4475 * . string concatenation
4477 * "arg" must point to the first non-white of the expression.
4478 * "arg" is advanced to the next non-white after the recognized expression.
4480 * Return OK or FAIL.
4482 static int
4483 eval5(arg, rettv, evaluate)
4484 char_u **arg;
4485 typval_T *rettv;
4486 int evaluate;
4488 typval_T var2;
4489 typval_T var3;
4490 int op;
4491 long n1, n2;
4492 #ifdef FEAT_FLOAT
4493 float_T f1 = 0, f2 = 0;
4494 #endif
4495 char_u *s1, *s2;
4496 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4497 char_u *p;
4500 * Get the first variable.
4502 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4503 return FAIL;
4506 * Repeat computing, until no '+', '-' or '.' is following.
4508 for (;;)
4510 op = **arg;
4511 if (op != '+' && op != '-' && op != '.')
4512 break;
4514 if ((op != '+' || rettv->v_type != VAR_LIST)
4515 #ifdef FEAT_FLOAT
4516 && (op == '.' || rettv->v_type != VAR_FLOAT)
4517 #endif
4520 /* For "list + ...", an illegal use of the first operand as
4521 * a number cannot be determined before evaluating the 2nd
4522 * operand: if this is also a list, all is ok.
4523 * For "something . ...", "something - ..." or "non-list + ...",
4524 * we know that the first operand needs to be a string or number
4525 * without evaluating the 2nd operand. So check before to avoid
4526 * side effects after an error. */
4527 if (evaluate && get_tv_string_chk(rettv) == NULL)
4529 clear_tv(rettv);
4530 return FAIL;
4535 * Get the second variable.
4537 *arg = skipwhite(*arg + 1);
4538 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4540 clear_tv(rettv);
4541 return FAIL;
4544 if (evaluate)
4547 * Compute the result.
4549 if (op == '.')
4551 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4552 s2 = get_tv_string_buf_chk(&var2, buf2);
4553 if (s2 == NULL) /* type error ? */
4555 clear_tv(rettv);
4556 clear_tv(&var2);
4557 return FAIL;
4559 p = concat_str(s1, s2);
4560 clear_tv(rettv);
4561 rettv->v_type = VAR_STRING;
4562 rettv->vval.v_string = p;
4564 else if (op == '+' && rettv->v_type == VAR_LIST
4565 && var2.v_type == VAR_LIST)
4567 /* concatenate Lists */
4568 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4569 &var3) == FAIL)
4571 clear_tv(rettv);
4572 clear_tv(&var2);
4573 return FAIL;
4575 clear_tv(rettv);
4576 *rettv = var3;
4578 else
4580 int error = FALSE;
4582 #ifdef FEAT_FLOAT
4583 if (rettv->v_type == VAR_FLOAT)
4585 f1 = rettv->vval.v_float;
4586 n1 = 0;
4588 else
4589 #endif
4591 n1 = get_tv_number_chk(rettv, &error);
4592 if (error)
4594 /* This can only happen for "list + non-list". For
4595 * "non-list + ..." or "something - ...", we returned
4596 * before evaluating the 2nd operand. */
4597 clear_tv(rettv);
4598 return FAIL;
4600 #ifdef FEAT_FLOAT
4601 if (var2.v_type == VAR_FLOAT)
4602 f1 = n1;
4603 #endif
4605 #ifdef FEAT_FLOAT
4606 if (var2.v_type == VAR_FLOAT)
4608 f2 = var2.vval.v_float;
4609 n2 = 0;
4611 else
4612 #endif
4614 n2 = get_tv_number_chk(&var2, &error);
4615 if (error)
4617 clear_tv(rettv);
4618 clear_tv(&var2);
4619 return FAIL;
4621 #ifdef FEAT_FLOAT
4622 if (rettv->v_type == VAR_FLOAT)
4623 f2 = n2;
4624 #endif
4626 clear_tv(rettv);
4628 #ifdef FEAT_FLOAT
4629 /* If there is a float on either side the result is a float. */
4630 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4632 if (op == '+')
4633 f1 = f1 + f2;
4634 else
4635 f1 = f1 - f2;
4636 rettv->v_type = VAR_FLOAT;
4637 rettv->vval.v_float = f1;
4639 else
4640 #endif
4642 if (op == '+')
4643 n1 = n1 + n2;
4644 else
4645 n1 = n1 - n2;
4646 rettv->v_type = VAR_NUMBER;
4647 rettv->vval.v_number = n1;
4650 clear_tv(&var2);
4653 return OK;
4657 * Handle fifth level expression:
4658 * * number multiplication
4659 * / number division
4660 * % number modulo
4662 * "arg" must point to the first non-white of the expression.
4663 * "arg" is advanced to the next non-white after the recognized expression.
4665 * Return OK or FAIL.
4667 static int
4668 eval6(arg, rettv, evaluate, want_string)
4669 char_u **arg;
4670 typval_T *rettv;
4671 int evaluate;
4672 int want_string; /* after "." operator */
4674 typval_T var2;
4675 int op;
4676 long n1, n2;
4677 #ifdef FEAT_FLOAT
4678 int use_float = FALSE;
4679 float_T f1 = 0, f2;
4680 #endif
4681 int error = FALSE;
4684 * Get the first variable.
4686 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4687 return FAIL;
4690 * Repeat computing, until no '*', '/' or '%' is following.
4692 for (;;)
4694 op = **arg;
4695 if (op != '*' && op != '/' && op != '%')
4696 break;
4698 if (evaluate)
4700 #ifdef FEAT_FLOAT
4701 if (rettv->v_type == VAR_FLOAT)
4703 f1 = rettv->vval.v_float;
4704 use_float = TRUE;
4705 n1 = 0;
4707 else
4708 #endif
4709 n1 = get_tv_number_chk(rettv, &error);
4710 clear_tv(rettv);
4711 if (error)
4712 return FAIL;
4714 else
4715 n1 = 0;
4718 * Get the second variable.
4720 *arg = skipwhite(*arg + 1);
4721 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4722 return FAIL;
4724 if (evaluate)
4726 #ifdef FEAT_FLOAT
4727 if (var2.v_type == VAR_FLOAT)
4729 if (!use_float)
4731 f1 = n1;
4732 use_float = TRUE;
4734 f2 = var2.vval.v_float;
4735 n2 = 0;
4737 else
4738 #endif
4740 n2 = get_tv_number_chk(&var2, &error);
4741 clear_tv(&var2);
4742 if (error)
4743 return FAIL;
4744 #ifdef FEAT_FLOAT
4745 if (use_float)
4746 f2 = n2;
4747 #endif
4751 * Compute the result.
4752 * When either side is a float the result is a float.
4754 #ifdef FEAT_FLOAT
4755 if (use_float)
4757 if (op == '*')
4758 f1 = f1 * f2;
4759 else if (op == '/')
4761 /* We rely on the floating point library to handle divide
4762 * by zero to result in "inf" and not a crash. */
4763 f1 = f1 / f2;
4765 else
4767 EMSG(_("E804: Cannot use '%' with Float"));
4768 return FAIL;
4770 rettv->v_type = VAR_FLOAT;
4771 rettv->vval.v_float = f1;
4773 else
4774 #endif
4776 if (op == '*')
4777 n1 = n1 * n2;
4778 else if (op == '/')
4780 if (n2 == 0) /* give an error message? */
4782 if (n1 == 0)
4783 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4784 else if (n1 < 0)
4785 n1 = -0x7fffffffL;
4786 else
4787 n1 = 0x7fffffffL;
4789 else
4790 n1 = n1 / n2;
4792 else
4794 if (n2 == 0) /* give an error message? */
4795 n1 = 0;
4796 else
4797 n1 = n1 % n2;
4799 rettv->v_type = VAR_NUMBER;
4800 rettv->vval.v_number = n1;
4805 return OK;
4809 * Handle sixth level expression:
4810 * number number constant
4811 * "string" string constant
4812 * 'string' literal string constant
4813 * &option-name option value
4814 * @r register contents
4815 * identifier variable value
4816 * function() function call
4817 * $VAR environment variable
4818 * (expression) nested expression
4819 * [expr, expr] List
4820 * {key: val, key: val} Dictionary
4822 * Also handle:
4823 * ! in front logical NOT
4824 * - in front unary minus
4825 * + in front unary plus (ignored)
4826 * trailing [] subscript in String or List
4827 * trailing .name entry in Dictionary
4829 * "arg" must point to the first non-white of the expression.
4830 * "arg" is advanced to the next non-white after the recognized expression.
4832 * Return OK or FAIL.
4834 static int
4835 eval7(arg, rettv, evaluate, want_string)
4836 char_u **arg;
4837 typval_T *rettv;
4838 int evaluate;
4839 int want_string; /* after "." operator */
4841 long n;
4842 int len;
4843 char_u *s;
4844 char_u *start_leader, *end_leader;
4845 int ret = OK;
4846 char_u *alias;
4849 * Initialise variable so that clear_tv() can't mistake this for a
4850 * string and free a string that isn't there.
4852 rettv->v_type = VAR_UNKNOWN;
4855 * Skip '!' and '-' characters. They are handled later.
4857 start_leader = *arg;
4858 while (**arg == '!' || **arg == '-' || **arg == '+')
4859 *arg = skipwhite(*arg + 1);
4860 end_leader = *arg;
4862 switch (**arg)
4865 * Number constant.
4867 case '0':
4868 case '1':
4869 case '2':
4870 case '3':
4871 case '4':
4872 case '5':
4873 case '6':
4874 case '7':
4875 case '8':
4876 case '9':
4878 #ifdef FEAT_FLOAT
4879 char_u *p = skipdigits(*arg + 1);
4880 int get_float = FALSE;
4882 /* We accept a float when the format matches
4883 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4884 * strict to avoid backwards compatibility problems.
4885 * Don't look for a float after the "." operator, so that
4886 * ":let vers = 1.2.3" doesn't fail. */
4887 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4889 get_float = TRUE;
4890 p = skipdigits(p + 2);
4891 if (*p == 'e' || *p == 'E')
4893 ++p;
4894 if (*p == '-' || *p == '+')
4895 ++p;
4896 if (!vim_isdigit(*p))
4897 get_float = FALSE;
4898 else
4899 p = skipdigits(p + 1);
4901 if (ASCII_ISALPHA(*p) || *p == '.')
4902 get_float = FALSE;
4904 if (get_float)
4906 float_T f;
4908 *arg += string2float(*arg, &f);
4909 if (evaluate)
4911 rettv->v_type = VAR_FLOAT;
4912 rettv->vval.v_float = f;
4915 else
4916 #endif
4918 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4919 *arg += len;
4920 if (evaluate)
4922 rettv->v_type = VAR_NUMBER;
4923 rettv->vval.v_number = n;
4926 break;
4930 * String constant: "string".
4932 case '"': ret = get_string_tv(arg, rettv, evaluate);
4933 break;
4936 * Literal string constant: 'str''ing'.
4938 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4939 break;
4942 * List: [expr, expr]
4944 case '[': ret = get_list_tv(arg, rettv, evaluate);
4945 break;
4948 * Dictionary: {key: val, key: val}
4950 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4951 break;
4954 * Option value: &name
4956 case '&': ret = get_option_tv(arg, rettv, evaluate);
4957 break;
4960 * Environment variable: $VAR.
4962 case '$': ret = get_env_tv(arg, rettv, evaluate);
4963 break;
4966 * Register contents: @r.
4968 case '@': ++*arg;
4969 if (evaluate)
4971 rettv->v_type = VAR_STRING;
4972 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4974 if (**arg != NUL)
4975 ++*arg;
4976 break;
4979 * nested expression: (expression).
4981 case '(': *arg = skipwhite(*arg + 1);
4982 ret = eval1(arg, rettv, evaluate); /* recursive! */
4983 if (**arg == ')')
4984 ++*arg;
4985 else if (ret == OK)
4987 EMSG(_("E110: Missing ')'"));
4988 clear_tv(rettv);
4989 ret = FAIL;
4991 break;
4993 default: ret = NOTDONE;
4994 break;
4997 if (ret == NOTDONE)
5000 * Must be a variable or function name.
5001 * Can also be a curly-braces kind of name: {expr}.
5003 s = *arg;
5004 len = get_name_len(arg, &alias, evaluate, TRUE);
5005 if (alias != NULL)
5006 s = alias;
5008 if (len <= 0)
5009 ret = FAIL;
5010 else
5012 if (**arg == '(') /* recursive! */
5014 /* If "s" is the name of a variable of type VAR_FUNC
5015 * use its contents. */
5016 s = deref_func_name(s, &len);
5018 /* Invoke the function. */
5019 ret = get_func_tv(s, len, rettv, arg,
5020 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5021 &len, evaluate, NULL);
5022 /* Stop the expression evaluation when immediately
5023 * aborting on error, or when an interrupt occurred or
5024 * an exception was thrown but not caught. */
5025 if (aborting())
5027 if (ret == OK)
5028 clear_tv(rettv);
5029 ret = FAIL;
5032 else if (evaluate)
5033 ret = get_var_tv(s, len, rettv, TRUE);
5034 else
5035 ret = OK;
5038 if (alias != NULL)
5039 vim_free(alias);
5042 *arg = skipwhite(*arg);
5044 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5045 * expr(expr). */
5046 if (ret == OK)
5047 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5050 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5052 if (ret == OK && evaluate && end_leader > start_leader)
5054 int error = FALSE;
5055 int val = 0;
5056 #ifdef FEAT_FLOAT
5057 float_T f = 0.0;
5059 if (rettv->v_type == VAR_FLOAT)
5060 f = rettv->vval.v_float;
5061 else
5062 #endif
5063 val = get_tv_number_chk(rettv, &error);
5064 if (error)
5066 clear_tv(rettv);
5067 ret = FAIL;
5069 else
5071 while (end_leader > start_leader)
5073 --end_leader;
5074 if (*end_leader == '!')
5076 #ifdef FEAT_FLOAT
5077 if (rettv->v_type == VAR_FLOAT)
5078 f = !f;
5079 else
5080 #endif
5081 val = !val;
5083 else if (*end_leader == '-')
5085 #ifdef FEAT_FLOAT
5086 if (rettv->v_type == VAR_FLOAT)
5087 f = -f;
5088 else
5089 #endif
5090 val = -val;
5093 #ifdef FEAT_FLOAT
5094 if (rettv->v_type == VAR_FLOAT)
5096 clear_tv(rettv);
5097 rettv->vval.v_float = f;
5099 else
5100 #endif
5102 clear_tv(rettv);
5103 rettv->v_type = VAR_NUMBER;
5104 rettv->vval.v_number = val;
5109 return ret;
5113 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5114 * "*arg" points to the '[' or '.'.
5115 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5117 static int
5118 eval_index(arg, rettv, evaluate, verbose)
5119 char_u **arg;
5120 typval_T *rettv;
5121 int evaluate;
5122 int verbose; /* give error messages */
5124 int empty1 = FALSE, empty2 = FALSE;
5125 typval_T var1, var2;
5126 long n1, n2 = 0;
5127 long len = -1;
5128 int range = FALSE;
5129 char_u *s;
5130 char_u *key = NULL;
5132 if (rettv->v_type == VAR_FUNC
5133 #ifdef FEAT_FLOAT
5134 || rettv->v_type == VAR_FLOAT
5135 #endif
5138 if (verbose)
5139 EMSG(_("E695: Cannot index a Funcref"));
5140 return FAIL;
5143 if (**arg == '.')
5146 * dict.name
5148 key = *arg + 1;
5149 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5151 if (len == 0)
5152 return FAIL;
5153 *arg = skipwhite(key + len);
5155 else
5158 * something[idx]
5160 * Get the (first) variable from inside the [].
5162 *arg = skipwhite(*arg + 1);
5163 if (**arg == ':')
5164 empty1 = TRUE;
5165 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5166 return FAIL;
5167 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5169 /* not a number or string */
5170 clear_tv(&var1);
5171 return FAIL;
5175 * Get the second variable from inside the [:].
5177 if (**arg == ':')
5179 range = TRUE;
5180 *arg = skipwhite(*arg + 1);
5181 if (**arg == ']')
5182 empty2 = TRUE;
5183 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5185 if (!empty1)
5186 clear_tv(&var1);
5187 return FAIL;
5189 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5191 /* not a number or string */
5192 if (!empty1)
5193 clear_tv(&var1);
5194 clear_tv(&var2);
5195 return FAIL;
5199 /* Check for the ']'. */
5200 if (**arg != ']')
5202 if (verbose)
5203 EMSG(_(e_missbrac));
5204 clear_tv(&var1);
5205 if (range)
5206 clear_tv(&var2);
5207 return FAIL;
5209 *arg = skipwhite(*arg + 1); /* skip the ']' */
5212 if (evaluate)
5214 n1 = 0;
5215 if (!empty1 && rettv->v_type != VAR_DICT)
5217 n1 = get_tv_number(&var1);
5218 clear_tv(&var1);
5220 if (range)
5222 if (empty2)
5223 n2 = -1;
5224 else
5226 n2 = get_tv_number(&var2);
5227 clear_tv(&var2);
5231 switch (rettv->v_type)
5233 case VAR_NUMBER:
5234 case VAR_STRING:
5235 s = get_tv_string(rettv);
5236 len = (long)STRLEN(s);
5237 if (range)
5239 /* The resulting variable is a substring. If the indexes
5240 * are out of range the result is empty. */
5241 if (n1 < 0)
5243 n1 = len + n1;
5244 if (n1 < 0)
5245 n1 = 0;
5247 if (n2 < 0)
5248 n2 = len + n2;
5249 else if (n2 >= len)
5250 n2 = len;
5251 if (n1 >= len || n2 < 0 || n1 > n2)
5252 s = NULL;
5253 else
5254 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5256 else
5258 /* The resulting variable is a string of a single
5259 * character. If the index is too big or negative the
5260 * result is empty. */
5261 if (n1 >= len || n1 < 0)
5262 s = NULL;
5263 else
5264 s = vim_strnsave(s + n1, 1);
5266 clear_tv(rettv);
5267 rettv->v_type = VAR_STRING;
5268 rettv->vval.v_string = s;
5269 break;
5271 case VAR_LIST:
5272 len = list_len(rettv->vval.v_list);
5273 if (n1 < 0)
5274 n1 = len + n1;
5275 if (!empty1 && (n1 < 0 || n1 >= len))
5277 /* For a range we allow invalid values and return an empty
5278 * list. A list index out of range is an error. */
5279 if (!range)
5281 if (verbose)
5282 EMSGN(_(e_listidx), n1);
5283 return FAIL;
5285 n1 = len;
5287 if (range)
5289 list_T *l;
5290 listitem_T *item;
5292 if (n2 < 0)
5293 n2 = len + n2;
5294 else if (n2 >= len)
5295 n2 = len - 1;
5296 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5297 n2 = -1;
5298 l = list_alloc();
5299 if (l == NULL)
5300 return FAIL;
5301 for (item = list_find(rettv->vval.v_list, n1);
5302 n1 <= n2; ++n1)
5304 if (list_append_tv(l, &item->li_tv) == FAIL)
5306 list_free(l, TRUE);
5307 return FAIL;
5309 item = item->li_next;
5311 clear_tv(rettv);
5312 rettv->v_type = VAR_LIST;
5313 rettv->vval.v_list = l;
5314 ++l->lv_refcount;
5316 else
5318 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5319 clear_tv(rettv);
5320 *rettv = var1;
5322 break;
5324 case VAR_DICT:
5325 if (range)
5327 if (verbose)
5328 EMSG(_(e_dictrange));
5329 if (len == -1)
5330 clear_tv(&var1);
5331 return FAIL;
5334 dictitem_T *item;
5336 if (len == -1)
5338 key = get_tv_string(&var1);
5339 if (*key == NUL)
5341 if (verbose)
5342 EMSG(_(e_emptykey));
5343 clear_tv(&var1);
5344 return FAIL;
5348 item = dict_find(rettv->vval.v_dict, key, (int)len);
5350 if (item == NULL && verbose)
5351 EMSG2(_(e_dictkey), key);
5352 if (len == -1)
5353 clear_tv(&var1);
5354 if (item == NULL)
5355 return FAIL;
5357 copy_tv(&item->di_tv, &var1);
5358 clear_tv(rettv);
5359 *rettv = var1;
5361 break;
5365 return OK;
5369 * Get an option value.
5370 * "arg" points to the '&' or '+' before the option name.
5371 * "arg" is advanced to character after the option name.
5372 * Return OK or FAIL.
5374 static int
5375 get_option_tv(arg, rettv, evaluate)
5376 char_u **arg;
5377 typval_T *rettv; /* when NULL, only check if option exists */
5378 int evaluate;
5380 char_u *option_end;
5381 long numval;
5382 char_u *stringval;
5383 int opt_type;
5384 int c;
5385 int working = (**arg == '+'); /* has("+option") */
5386 int ret = OK;
5387 int opt_flags;
5390 * Isolate the option name and find its value.
5392 option_end = find_option_end(arg, &opt_flags);
5393 if (option_end == NULL)
5395 if (rettv != NULL)
5396 EMSG2(_("E112: Option name missing: %s"), *arg);
5397 return FAIL;
5400 if (!evaluate)
5402 *arg = option_end;
5403 return OK;
5406 c = *option_end;
5407 *option_end = NUL;
5408 opt_type = get_option_value(*arg, &numval,
5409 rettv == NULL ? NULL : &stringval, opt_flags);
5411 if (opt_type == -3) /* invalid name */
5413 if (rettv != NULL)
5414 EMSG2(_("E113: Unknown option: %s"), *arg);
5415 ret = FAIL;
5417 else if (rettv != NULL)
5419 if (opt_type == -2) /* hidden string option */
5421 rettv->v_type = VAR_STRING;
5422 rettv->vval.v_string = NULL;
5424 else if (opt_type == -1) /* hidden number option */
5426 rettv->v_type = VAR_NUMBER;
5427 rettv->vval.v_number = 0;
5429 else if (opt_type == 1) /* number option */
5431 rettv->v_type = VAR_NUMBER;
5432 rettv->vval.v_number = numval;
5434 else /* string option */
5436 rettv->v_type = VAR_STRING;
5437 rettv->vval.v_string = stringval;
5440 else if (working && (opt_type == -2 || opt_type == -1))
5441 ret = FAIL;
5443 *option_end = c; /* put back for error messages */
5444 *arg = option_end;
5446 return ret;
5450 * Allocate a variable for a string constant.
5451 * Return OK or FAIL.
5453 static int
5454 get_string_tv(arg, rettv, evaluate)
5455 char_u **arg;
5456 typval_T *rettv;
5457 int evaluate;
5459 char_u *p;
5460 char_u *name;
5461 int extra = 0;
5464 * Find the end of the string, skipping backslashed characters.
5466 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5468 if (*p == '\\' && p[1] != NUL)
5470 ++p;
5471 /* A "\<x>" form occupies at least 4 characters, and produces up
5472 * to 6 characters: reserve space for 2 extra */
5473 if (*p == '<')
5474 extra += 2;
5478 if (*p != '"')
5480 EMSG2(_("E114: Missing quote: %s"), *arg);
5481 return FAIL;
5484 /* If only parsing, set *arg and return here */
5485 if (!evaluate)
5487 *arg = p + 1;
5488 return OK;
5492 * Copy the string into allocated memory, handling backslashed
5493 * characters.
5495 name = alloc((unsigned)(p - *arg + extra));
5496 if (name == NULL)
5497 return FAIL;
5498 rettv->v_type = VAR_STRING;
5499 rettv->vval.v_string = name;
5501 for (p = *arg + 1; *p != NUL && *p != '"'; )
5503 if (*p == '\\')
5505 switch (*++p)
5507 case 'b': *name++ = BS; ++p; break;
5508 case 'e': *name++ = ESC; ++p; break;
5509 case 'f': *name++ = FF; ++p; break;
5510 case 'n': *name++ = NL; ++p; break;
5511 case 'r': *name++ = CAR; ++p; break;
5512 case 't': *name++ = TAB; ++p; break;
5514 case 'X': /* hex: "\x1", "\x12" */
5515 case 'x':
5516 case 'u': /* Unicode: "\u0023" */
5517 case 'U':
5518 if (vim_isxdigit(p[1]))
5520 int n, nr;
5521 int c = toupper(*p);
5523 if (c == 'X')
5524 n = 2;
5525 else
5526 n = 4;
5527 nr = 0;
5528 while (--n >= 0 && vim_isxdigit(p[1]))
5530 ++p;
5531 nr = (nr << 4) + hex2nr(*p);
5533 ++p;
5534 #ifdef FEAT_MBYTE
5535 /* For "\u" store the number according to
5536 * 'encoding'. */
5537 if (c != 'X')
5538 name += (*mb_char2bytes)(nr, name);
5539 else
5540 #endif
5541 *name++ = nr;
5543 break;
5545 /* octal: "\1", "\12", "\123" */
5546 case '0':
5547 case '1':
5548 case '2':
5549 case '3':
5550 case '4':
5551 case '5':
5552 case '6':
5553 case '7': *name = *p++ - '0';
5554 if (*p >= '0' && *p <= '7')
5556 *name = (*name << 3) + *p++ - '0';
5557 if (*p >= '0' && *p <= '7')
5558 *name = (*name << 3) + *p++ - '0';
5560 ++name;
5561 break;
5563 /* Special key, e.g.: "\<C-W>" */
5564 case '<': extra = trans_special(&p, name, TRUE);
5565 if (extra != 0)
5567 name += extra;
5568 break;
5570 /* FALLTHROUGH */
5572 default: MB_COPY_CHAR(p, name);
5573 break;
5576 else
5577 MB_COPY_CHAR(p, name);
5580 *name = NUL;
5581 *arg = p + 1;
5583 return OK;
5587 * Allocate a variable for a 'str''ing' constant.
5588 * Return OK or FAIL.
5590 static int
5591 get_lit_string_tv(arg, rettv, evaluate)
5592 char_u **arg;
5593 typval_T *rettv;
5594 int evaluate;
5596 char_u *p;
5597 char_u *str;
5598 int reduce = 0;
5601 * Find the end of the string, skipping ''.
5603 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5605 if (*p == '\'')
5607 if (p[1] != '\'')
5608 break;
5609 ++reduce;
5610 ++p;
5614 if (*p != '\'')
5616 EMSG2(_("E115: Missing quote: %s"), *arg);
5617 return FAIL;
5620 /* If only parsing return after setting "*arg" */
5621 if (!evaluate)
5623 *arg = p + 1;
5624 return OK;
5628 * Copy the string into allocated memory, handling '' to ' reduction.
5630 str = alloc((unsigned)((p - *arg) - reduce));
5631 if (str == NULL)
5632 return FAIL;
5633 rettv->v_type = VAR_STRING;
5634 rettv->vval.v_string = str;
5636 for (p = *arg + 1; *p != NUL; )
5638 if (*p == '\'')
5640 if (p[1] != '\'')
5641 break;
5642 ++p;
5644 MB_COPY_CHAR(p, str);
5646 *str = NUL;
5647 *arg = p + 1;
5649 return OK;
5653 * Allocate a variable for a List and fill it from "*arg".
5654 * Return OK or FAIL.
5656 static int
5657 get_list_tv(arg, rettv, evaluate)
5658 char_u **arg;
5659 typval_T *rettv;
5660 int evaluate;
5662 list_T *l = NULL;
5663 typval_T tv;
5664 listitem_T *item;
5666 if (evaluate)
5668 l = list_alloc();
5669 if (l == NULL)
5670 return FAIL;
5673 *arg = skipwhite(*arg + 1);
5674 while (**arg != ']' && **arg != NUL)
5676 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5677 goto failret;
5678 if (evaluate)
5680 item = listitem_alloc();
5681 if (item != NULL)
5683 item->li_tv = tv;
5684 item->li_tv.v_lock = 0;
5685 list_append(l, item);
5687 else
5688 clear_tv(&tv);
5691 if (**arg == ']')
5692 break;
5693 if (**arg != ',')
5695 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5696 goto failret;
5698 *arg = skipwhite(*arg + 1);
5701 if (**arg != ']')
5703 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5704 failret:
5705 if (evaluate)
5706 list_free(l, TRUE);
5707 return FAIL;
5710 *arg = skipwhite(*arg + 1);
5711 if (evaluate)
5713 rettv->v_type = VAR_LIST;
5714 rettv->vval.v_list = l;
5715 ++l->lv_refcount;
5718 return OK;
5722 * Allocate an empty header for a list.
5723 * Caller should take care of the reference count.
5725 list_T *
5726 list_alloc()
5728 list_T *l;
5730 l = (list_T *)alloc_clear(sizeof(list_T));
5731 if (l != NULL)
5733 /* Prepend the list to the list of lists for garbage collection. */
5734 if (first_list != NULL)
5735 first_list->lv_used_prev = l;
5736 l->lv_used_prev = NULL;
5737 l->lv_used_next = first_list;
5738 first_list = l;
5740 return l;
5744 * Allocate an empty list for a return value.
5745 * Returns OK or FAIL.
5747 static int
5748 rettv_list_alloc(rettv)
5749 typval_T *rettv;
5751 list_T *l = list_alloc();
5753 if (l == NULL)
5754 return FAIL;
5756 rettv->vval.v_list = l;
5757 rettv->v_type = VAR_LIST;
5758 ++l->lv_refcount;
5759 return OK;
5763 * Unreference a list: decrement the reference count and free it when it
5764 * becomes zero.
5766 void
5767 list_unref(l)
5768 list_T *l;
5770 if (l != NULL && --l->lv_refcount <= 0)
5771 list_free(l, TRUE);
5775 * Free a list, including all items it points to.
5776 * Ignores the reference count.
5778 void
5779 list_free(l, recurse)
5780 list_T *l;
5781 int recurse; /* Free Lists and Dictionaries recursively. */
5783 listitem_T *item;
5785 /* Remove the list from the list of lists for garbage collection. */
5786 if (l->lv_used_prev == NULL)
5787 first_list = l->lv_used_next;
5788 else
5789 l->lv_used_prev->lv_used_next = l->lv_used_next;
5790 if (l->lv_used_next != NULL)
5791 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5793 for (item = l->lv_first; item != NULL; item = l->lv_first)
5795 /* Remove the item before deleting it. */
5796 l->lv_first = item->li_next;
5797 if (recurse || (item->li_tv.v_type != VAR_LIST
5798 && item->li_tv.v_type != VAR_DICT))
5799 clear_tv(&item->li_tv);
5800 vim_free(item);
5802 vim_free(l);
5806 * Allocate a list item.
5808 static listitem_T *
5809 listitem_alloc()
5811 return (listitem_T *)alloc(sizeof(listitem_T));
5815 * Free a list item. Also clears the value. Does not notify watchers.
5817 static void
5818 listitem_free(item)
5819 listitem_T *item;
5821 clear_tv(&item->li_tv);
5822 vim_free(item);
5826 * Remove a list item from a List and free it. Also clears the value.
5828 static void
5829 listitem_remove(l, item)
5830 list_T *l;
5831 listitem_T *item;
5833 list_remove(l, item, item);
5834 listitem_free(item);
5838 * Get the number of items in a list.
5840 static long
5841 list_len(l)
5842 list_T *l;
5844 if (l == NULL)
5845 return 0L;
5846 return l->lv_len;
5850 * Return TRUE when two lists have exactly the same values.
5852 static int
5853 list_equal(l1, l2, ic)
5854 list_T *l1;
5855 list_T *l2;
5856 int ic; /* ignore case for strings */
5858 listitem_T *item1, *item2;
5860 if (l1 == NULL || l2 == NULL)
5861 return FALSE;
5862 if (l1 == l2)
5863 return TRUE;
5864 if (list_len(l1) != list_len(l2))
5865 return FALSE;
5867 for (item1 = l1->lv_first, item2 = l2->lv_first;
5868 item1 != NULL && item2 != NULL;
5869 item1 = item1->li_next, item2 = item2->li_next)
5870 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5871 return FALSE;
5872 return item1 == NULL && item2 == NULL;
5875 #if defined(FEAT_RUBY) || defined(FEAT_PYTHON) || defined(FEAT_MZSCHEME) \
5876 || defined(PROTO) || defined(FEAT_GUI_MACVIM)
5878 * Return the dictitem that an entry in a hashtable points to.
5880 dictitem_T *
5881 dict_lookup(hi)
5882 hashitem_T *hi;
5884 return HI2DI(hi);
5886 #endif
5889 * Return TRUE when two dictionaries have exactly the same key/values.
5891 static int
5892 dict_equal(d1, d2, ic)
5893 dict_T *d1;
5894 dict_T *d2;
5895 int ic; /* ignore case for strings */
5897 hashitem_T *hi;
5898 dictitem_T *item2;
5899 int todo;
5901 if (d1 == NULL || d2 == NULL)
5902 return FALSE;
5903 if (d1 == d2)
5904 return TRUE;
5905 if (dict_len(d1) != dict_len(d2))
5906 return FALSE;
5908 todo = (int)d1->dv_hashtab.ht_used;
5909 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5911 if (!HASHITEM_EMPTY(hi))
5913 item2 = dict_find(d2, hi->hi_key, -1);
5914 if (item2 == NULL)
5915 return FALSE;
5916 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5917 return FALSE;
5918 --todo;
5921 return TRUE;
5925 * Return TRUE if "tv1" and "tv2" have the same value.
5926 * Compares the items just like "==" would compare them, but strings and
5927 * numbers are different. Floats and numbers are also different.
5929 static int
5930 tv_equal(tv1, tv2, ic)
5931 typval_T *tv1;
5932 typval_T *tv2;
5933 int ic; /* ignore case */
5935 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5936 char_u *s1, *s2;
5937 static int recursive = 0; /* cach recursive loops */
5938 int r;
5940 if (tv1->v_type != tv2->v_type)
5941 return FALSE;
5942 /* Catch lists and dicts that have an endless loop by limiting
5943 * recursiveness to 1000. We guess they are equal then. */
5944 if (recursive >= 1000)
5945 return TRUE;
5947 switch (tv1->v_type)
5949 case VAR_LIST:
5950 ++recursive;
5951 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5952 --recursive;
5953 return r;
5955 case VAR_DICT:
5956 ++recursive;
5957 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5958 --recursive;
5959 return r;
5961 case VAR_FUNC:
5962 return (tv1->vval.v_string != NULL
5963 && tv2->vval.v_string != NULL
5964 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5966 case VAR_NUMBER:
5967 return tv1->vval.v_number == tv2->vval.v_number;
5969 #ifdef FEAT_FLOAT
5970 case VAR_FLOAT:
5971 return tv1->vval.v_float == tv2->vval.v_float;
5972 #endif
5974 case VAR_STRING:
5975 s1 = get_tv_string_buf(tv1, buf1);
5976 s2 = get_tv_string_buf(tv2, buf2);
5977 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5980 EMSG2(_(e_intern2), "tv_equal()");
5981 return TRUE;
5985 * Locate item with index "n" in list "l" and return it.
5986 * A negative index is counted from the end; -1 is the last item.
5987 * Returns NULL when "n" is out of range.
5989 static listitem_T *
5990 list_find(l, n)
5991 list_T *l;
5992 long n;
5994 listitem_T *item;
5995 long idx;
5997 if (l == NULL)
5998 return NULL;
6000 /* Negative index is relative to the end. */
6001 if (n < 0)
6002 n = l->lv_len + n;
6004 /* Check for index out of range. */
6005 if (n < 0 || n >= l->lv_len)
6006 return NULL;
6008 /* When there is a cached index may start search from there. */
6009 if (l->lv_idx_item != NULL)
6011 if (n < l->lv_idx / 2)
6013 /* closest to the start of the list */
6014 item = l->lv_first;
6015 idx = 0;
6017 else if (n > (l->lv_idx + l->lv_len) / 2)
6019 /* closest to the end of the list */
6020 item = l->lv_last;
6021 idx = l->lv_len - 1;
6023 else
6025 /* closest to the cached index */
6026 item = l->lv_idx_item;
6027 idx = l->lv_idx;
6030 else
6032 if (n < l->lv_len / 2)
6034 /* closest to the start of the list */
6035 item = l->lv_first;
6036 idx = 0;
6038 else
6040 /* closest to the end of the list */
6041 item = l->lv_last;
6042 idx = l->lv_len - 1;
6046 while (n > idx)
6048 /* search forward */
6049 item = item->li_next;
6050 ++idx;
6052 while (n < idx)
6054 /* search backward */
6055 item = item->li_prev;
6056 --idx;
6059 /* cache the used index */
6060 l->lv_idx = idx;
6061 l->lv_idx_item = item;
6063 return item;
6067 * Get list item "l[idx]" as a number.
6069 static long
6070 list_find_nr(l, idx, errorp)
6071 list_T *l;
6072 long idx;
6073 int *errorp; /* set to TRUE when something wrong */
6075 listitem_T *li;
6077 li = list_find(l, idx);
6078 if (li == NULL)
6080 if (errorp != NULL)
6081 *errorp = TRUE;
6082 return -1L;
6084 return get_tv_number_chk(&li->li_tv, errorp);
6088 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6090 char_u *
6091 list_find_str(l, idx)
6092 list_T *l;
6093 long idx;
6095 listitem_T *li;
6097 li = list_find(l, idx - 1);
6098 if (li == NULL)
6100 EMSGN(_(e_listidx), idx);
6101 return NULL;
6103 return get_tv_string(&li->li_tv);
6107 * Locate "item" list "l" and return its index.
6108 * Returns -1 when "item" is not in the list.
6110 static long
6111 list_idx_of_item(l, item)
6112 list_T *l;
6113 listitem_T *item;
6115 long idx = 0;
6116 listitem_T *li;
6118 if (l == NULL)
6119 return -1;
6120 idx = 0;
6121 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6122 ++idx;
6123 if (li == NULL)
6124 return -1;
6125 return idx;
6129 * Append item "item" to the end of list "l".
6131 static void
6132 list_append(l, item)
6133 list_T *l;
6134 listitem_T *item;
6136 if (l->lv_last == NULL)
6138 /* empty list */
6139 l->lv_first = item;
6140 l->lv_last = item;
6141 item->li_prev = NULL;
6143 else
6145 l->lv_last->li_next = item;
6146 item->li_prev = l->lv_last;
6147 l->lv_last = item;
6149 ++l->lv_len;
6150 item->li_next = NULL;
6154 * Append typval_T "tv" to the end of list "l".
6155 * Return FAIL when out of memory.
6158 list_append_tv(l, tv)
6159 list_T *l;
6160 typval_T *tv;
6162 listitem_T *li = listitem_alloc();
6164 if (li == NULL)
6165 return FAIL;
6166 copy_tv(tv, &li->li_tv);
6167 list_append(l, li);
6168 return OK;
6172 * Add a dictionary to a list. Used by getqflist().
6173 * Return FAIL when out of memory.
6176 list_append_dict(list, dict)
6177 list_T *list;
6178 dict_T *dict;
6180 listitem_T *li = listitem_alloc();
6182 if (li == NULL)
6183 return FAIL;
6184 li->li_tv.v_type = VAR_DICT;
6185 li->li_tv.v_lock = 0;
6186 li->li_tv.vval.v_dict = dict;
6187 list_append(list, li);
6188 ++dict->dv_refcount;
6189 return OK;
6193 * Make a copy of "str" and append it as an item to list "l".
6194 * When "len" >= 0 use "str[len]".
6195 * Returns FAIL when out of memory.
6198 list_append_string(l, str, len)
6199 list_T *l;
6200 char_u *str;
6201 int len;
6203 listitem_T *li = listitem_alloc();
6205 if (li == NULL)
6206 return FAIL;
6207 list_append(l, li);
6208 li->li_tv.v_type = VAR_STRING;
6209 li->li_tv.v_lock = 0;
6210 if (str == NULL)
6211 li->li_tv.vval.v_string = NULL;
6212 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6213 : vim_strsave(str))) == NULL)
6214 return FAIL;
6215 return OK;
6219 * Append "n" to list "l".
6220 * Returns FAIL when out of memory.
6222 static int
6223 list_append_number(l, n)
6224 list_T *l;
6225 varnumber_T n;
6227 listitem_T *li;
6229 li = listitem_alloc();
6230 if (li == NULL)
6231 return FAIL;
6232 li->li_tv.v_type = VAR_NUMBER;
6233 li->li_tv.v_lock = 0;
6234 li->li_tv.vval.v_number = n;
6235 list_append(l, li);
6236 return OK;
6240 * Insert typval_T "tv" in list "l" before "item".
6241 * If "item" is NULL append at the end.
6242 * Return FAIL when out of memory.
6244 static int
6245 list_insert_tv(l, tv, item)
6246 list_T *l;
6247 typval_T *tv;
6248 listitem_T *item;
6250 listitem_T *ni = listitem_alloc();
6252 if (ni == NULL)
6253 return FAIL;
6254 copy_tv(tv, &ni->li_tv);
6255 if (item == NULL)
6256 /* Append new item at end of list. */
6257 list_append(l, ni);
6258 else
6260 /* Insert new item before existing item. */
6261 ni->li_prev = item->li_prev;
6262 ni->li_next = item;
6263 if (item->li_prev == NULL)
6265 l->lv_first = ni;
6266 ++l->lv_idx;
6268 else
6270 item->li_prev->li_next = ni;
6271 l->lv_idx_item = NULL;
6273 item->li_prev = ni;
6274 ++l->lv_len;
6276 return OK;
6280 * Extend "l1" with "l2".
6281 * If "bef" is NULL append at the end, otherwise insert before this item.
6282 * Returns FAIL when out of memory.
6284 static int
6285 list_extend(l1, l2, bef)
6286 list_T *l1;
6287 list_T *l2;
6288 listitem_T *bef;
6290 listitem_T *item;
6291 int todo = l2->lv_len;
6293 /* We also quit the loop when we have inserted the original item count of
6294 * the list, avoid a hang when we extend a list with itself. */
6295 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6296 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6297 return FAIL;
6298 return OK;
6302 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6303 * Return FAIL when out of memory.
6305 static int
6306 list_concat(l1, l2, tv)
6307 list_T *l1;
6308 list_T *l2;
6309 typval_T *tv;
6311 list_T *l;
6313 if (l1 == NULL || l2 == NULL)
6314 return FAIL;
6316 /* make a copy of the first list. */
6317 l = list_copy(l1, FALSE, 0);
6318 if (l == NULL)
6319 return FAIL;
6320 tv->v_type = VAR_LIST;
6321 tv->vval.v_list = l;
6323 /* append all items from the second list */
6324 return list_extend(l, l2, NULL);
6328 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6329 * The refcount of the new list is set to 1.
6330 * See item_copy() for "copyID".
6331 * Returns NULL when out of memory.
6333 static list_T *
6334 list_copy(orig, deep, copyID)
6335 list_T *orig;
6336 int deep;
6337 int copyID;
6339 list_T *copy;
6340 listitem_T *item;
6341 listitem_T *ni;
6343 if (orig == NULL)
6344 return NULL;
6346 copy = list_alloc();
6347 if (copy != NULL)
6349 if (copyID != 0)
6351 /* Do this before adding the items, because one of the items may
6352 * refer back to this list. */
6353 orig->lv_copyID = copyID;
6354 orig->lv_copylist = copy;
6356 for (item = orig->lv_first; item != NULL && !got_int;
6357 item = item->li_next)
6359 ni = listitem_alloc();
6360 if (ni == NULL)
6361 break;
6362 if (deep)
6364 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6366 vim_free(ni);
6367 break;
6370 else
6371 copy_tv(&item->li_tv, &ni->li_tv);
6372 list_append(copy, ni);
6374 ++copy->lv_refcount;
6375 if (item != NULL)
6377 list_unref(copy);
6378 copy = NULL;
6382 return copy;
6386 * Remove items "item" to "item2" from list "l".
6387 * Does not free the listitem or the value!
6389 static void
6390 list_remove(l, item, item2)
6391 list_T *l;
6392 listitem_T *item;
6393 listitem_T *item2;
6395 listitem_T *ip;
6397 /* notify watchers */
6398 for (ip = item; ip != NULL; ip = ip->li_next)
6400 --l->lv_len;
6401 list_fix_watch(l, ip);
6402 if (ip == item2)
6403 break;
6406 if (item2->li_next == NULL)
6407 l->lv_last = item->li_prev;
6408 else
6409 item2->li_next->li_prev = item->li_prev;
6410 if (item->li_prev == NULL)
6411 l->lv_first = item2->li_next;
6412 else
6413 item->li_prev->li_next = item2->li_next;
6414 l->lv_idx_item = NULL;
6418 * Return an allocated string with the string representation of a list.
6419 * May return NULL.
6421 static char_u *
6422 list2string(tv, copyID)
6423 typval_T *tv;
6424 int copyID;
6426 garray_T ga;
6428 if (tv->vval.v_list == NULL)
6429 return NULL;
6430 ga_init2(&ga, (int)sizeof(char), 80);
6431 ga_append(&ga, '[');
6432 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6434 vim_free(ga.ga_data);
6435 return NULL;
6437 ga_append(&ga, ']');
6438 ga_append(&ga, NUL);
6439 return (char_u *)ga.ga_data;
6443 * Join list "l" into a string in "*gap", using separator "sep".
6444 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6445 * Return FAIL or OK.
6447 static int
6448 list_join(gap, l, sep, echo, copyID)
6449 garray_T *gap;
6450 list_T *l;
6451 char_u *sep;
6452 int echo;
6453 int copyID;
6455 int first = TRUE;
6456 char_u *tofree;
6457 char_u numbuf[NUMBUFLEN];
6458 listitem_T *item;
6459 char_u *s;
6461 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6463 if (first)
6464 first = FALSE;
6465 else
6466 ga_concat(gap, sep);
6468 if (echo)
6469 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6470 else
6471 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6472 if (s != NULL)
6473 ga_concat(gap, s);
6474 vim_free(tofree);
6475 if (s == NULL)
6476 return FAIL;
6477 line_breakcheck();
6479 return OK;
6483 * Garbage collection for lists and dictionaries.
6485 * We use reference counts to be able to free most items right away when they
6486 * are no longer used. But for composite items it's possible that it becomes
6487 * unused while the reference count is > 0: When there is a recursive
6488 * reference. Example:
6489 * :let l = [1, 2, 3]
6490 * :let d = {9: l}
6491 * :let l[1] = d
6493 * Since this is quite unusual we handle this with garbage collection: every
6494 * once in a while find out which lists and dicts are not referenced from any
6495 * variable.
6497 * Here is a good reference text about garbage collection (refers to Python
6498 * but it applies to all reference-counting mechanisms):
6499 * http://python.ca/nas/python/gc/
6503 * Do garbage collection for lists and dicts.
6504 * Return TRUE if some memory was freed.
6507 garbage_collect()
6509 int copyID;
6510 buf_T *buf;
6511 win_T *wp;
6512 int i;
6513 funccall_T *fc, **pfc;
6514 int did_free;
6515 int did_free_funccal = FALSE;
6516 #ifdef FEAT_WINDOWS
6517 tabpage_T *tp;
6518 #endif
6520 /* Only do this once. */
6521 want_garbage_collect = FALSE;
6522 may_garbage_collect = FALSE;
6523 garbage_collect_at_exit = FALSE;
6525 /* We advance by two because we add one for items referenced through
6526 * previous_funccal. */
6527 current_copyID += COPYID_INC;
6528 copyID = current_copyID;
6531 * 1. Go through all accessible variables and mark all lists and dicts
6532 * with copyID.
6535 /* Don't free variables in the previous_funccal list unless they are only
6536 * referenced through previous_funccal. This must be first, because if
6537 * the item is referenced elsewhere the funccal must not be freed. */
6538 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
6540 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1);
6541 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1);
6544 /* script-local variables */
6545 for (i = 1; i <= ga_scripts.ga_len; ++i)
6546 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6548 /* buffer-local variables */
6549 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6550 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6552 /* window-local variables */
6553 FOR_ALL_TAB_WINDOWS(tp, wp)
6554 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6556 #ifdef FEAT_WINDOWS
6557 /* tabpage-local variables */
6558 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6559 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6560 #endif
6562 /* global variables */
6563 set_ref_in_ht(&globvarht, copyID);
6565 /* function-local variables */
6566 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6568 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6569 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6572 /* v: vars */
6573 set_ref_in_ht(&vimvarht, copyID);
6576 * 2. Free lists and dictionaries that are not referenced.
6578 did_free = free_unref_items(copyID);
6581 * 3. Check if any funccal can be freed now.
6583 for (pfc = &previous_funccal; *pfc != NULL; )
6585 if (can_free_funccal(*pfc, copyID))
6587 fc = *pfc;
6588 *pfc = fc->caller;
6589 free_funccal(fc, TRUE);
6590 did_free = TRUE;
6591 did_free_funccal = TRUE;
6593 else
6594 pfc = &(*pfc)->caller;
6596 if (did_free_funccal)
6597 /* When a funccal was freed some more items might be garbage
6598 * collected, so run again. */
6599 (void)garbage_collect();
6601 return did_free;
6605 * Free lists and dictionaries that are no longer referenced.
6607 static int
6608 free_unref_items(copyID)
6609 int copyID;
6611 dict_T *dd;
6612 list_T *ll;
6613 int did_free = FALSE;
6616 * Go through the list of dicts and free items without the copyID.
6618 for (dd = first_dict; dd != NULL; )
6619 if ((dd->dv_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
6621 /* Free the Dictionary and ordinary items it contains, but don't
6622 * recurse into Lists and Dictionaries, they will be in the list
6623 * of dicts or list of lists. */
6624 dict_free(dd, FALSE);
6625 did_free = TRUE;
6627 /* restart, next dict may also have been freed */
6628 dd = first_dict;
6630 else
6631 dd = dd->dv_used_next;
6634 * Go through the list of lists and free items without the copyID.
6635 * But don't free a list that has a watcher (used in a for loop), these
6636 * are not referenced anywhere.
6638 for (ll = first_list; ll != NULL; )
6639 if ((ll->lv_copyID & COPYID_MASK) != (copyID & COPYID_MASK)
6640 && ll->lv_watch == NULL)
6642 /* Free the List and ordinary items it contains, but don't recurse
6643 * into Lists and Dictionaries, they will be in the list of dicts
6644 * or list of lists. */
6645 list_free(ll, FALSE);
6646 did_free = TRUE;
6648 /* restart, next list may also have been freed */
6649 ll = first_list;
6651 else
6652 ll = ll->lv_used_next;
6654 return did_free;
6658 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6660 static void
6661 set_ref_in_ht(ht, copyID)
6662 hashtab_T *ht;
6663 int copyID;
6665 int todo;
6666 hashitem_T *hi;
6668 todo = (int)ht->ht_used;
6669 for (hi = ht->ht_array; todo > 0; ++hi)
6670 if (!HASHITEM_EMPTY(hi))
6672 --todo;
6673 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6678 * Mark all lists and dicts referenced through list "l" with "copyID".
6680 static void
6681 set_ref_in_list(l, copyID)
6682 list_T *l;
6683 int copyID;
6685 listitem_T *li;
6687 for (li = l->lv_first; li != NULL; li = li->li_next)
6688 set_ref_in_item(&li->li_tv, copyID);
6692 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6694 static void
6695 set_ref_in_item(tv, copyID)
6696 typval_T *tv;
6697 int copyID;
6699 dict_T *dd;
6700 list_T *ll;
6702 switch (tv->v_type)
6704 case VAR_DICT:
6705 dd = tv->vval.v_dict;
6706 if (dd != NULL && dd->dv_copyID != copyID)
6708 /* Didn't see this dict yet. */
6709 dd->dv_copyID = copyID;
6710 set_ref_in_ht(&dd->dv_hashtab, copyID);
6712 break;
6714 case VAR_LIST:
6715 ll = tv->vval.v_list;
6716 if (ll != NULL && ll->lv_copyID != copyID)
6718 /* Didn't see this list yet. */
6719 ll->lv_copyID = copyID;
6720 set_ref_in_list(ll, copyID);
6722 break;
6724 return;
6728 * Allocate an empty header for a dictionary.
6730 dict_T *
6731 dict_alloc()
6733 dict_T *d;
6735 d = (dict_T *)alloc(sizeof(dict_T));
6736 if (d != NULL)
6738 /* Add the list to the list of dicts for garbage collection. */
6739 if (first_dict != NULL)
6740 first_dict->dv_used_prev = d;
6741 d->dv_used_next = first_dict;
6742 d->dv_used_prev = NULL;
6743 first_dict = d;
6745 hash_init(&d->dv_hashtab);
6746 d->dv_lock = 0;
6747 d->dv_refcount = 0;
6748 d->dv_copyID = 0;
6750 return d;
6754 * Unreference a Dictionary: decrement the reference count and free it when it
6755 * becomes zero.
6757 static void
6758 dict_unref(d)
6759 dict_T *d;
6761 if (d != NULL && --d->dv_refcount <= 0)
6762 dict_free(d, TRUE);
6766 * Free a Dictionary, including all items it contains.
6767 * Ignores the reference count.
6769 static void
6770 dict_free(d, recurse)
6771 dict_T *d;
6772 int recurse; /* Free Lists and Dictionaries recursively. */
6774 int todo;
6775 hashitem_T *hi;
6776 dictitem_T *di;
6778 /* Remove the dict from the list of dicts for garbage collection. */
6779 if (d->dv_used_prev == NULL)
6780 first_dict = d->dv_used_next;
6781 else
6782 d->dv_used_prev->dv_used_next = d->dv_used_next;
6783 if (d->dv_used_next != NULL)
6784 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6786 /* Lock the hashtab, we don't want it to resize while freeing items. */
6787 hash_lock(&d->dv_hashtab);
6788 todo = (int)d->dv_hashtab.ht_used;
6789 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6791 if (!HASHITEM_EMPTY(hi))
6793 /* Remove the item before deleting it, just in case there is
6794 * something recursive causing trouble. */
6795 di = HI2DI(hi);
6796 hash_remove(&d->dv_hashtab, hi);
6797 if (recurse || (di->di_tv.v_type != VAR_LIST
6798 && di->di_tv.v_type != VAR_DICT))
6799 clear_tv(&di->di_tv);
6800 vim_free(di);
6801 --todo;
6804 hash_clear(&d->dv_hashtab);
6805 vim_free(d);
6809 * Allocate a Dictionary item.
6810 * The "key" is copied to the new item.
6811 * Note that the value of the item "di_tv" still needs to be initialized!
6812 * Returns NULL when out of memory.
6814 dictitem_T *
6815 dictitem_alloc(key)
6816 char_u *key;
6818 dictitem_T *di;
6820 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6821 if (di != NULL)
6823 STRCPY(di->di_key, key);
6824 di->di_flags = 0;
6826 return di;
6830 * Make a copy of a Dictionary item.
6832 static dictitem_T *
6833 dictitem_copy(org)
6834 dictitem_T *org;
6836 dictitem_T *di;
6838 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6839 + STRLEN(org->di_key)));
6840 if (di != NULL)
6842 STRCPY(di->di_key, org->di_key);
6843 di->di_flags = 0;
6844 copy_tv(&org->di_tv, &di->di_tv);
6846 return di;
6850 * Remove item "item" from Dictionary "dict" and free it.
6852 static void
6853 dictitem_remove(dict, item)
6854 dict_T *dict;
6855 dictitem_T *item;
6857 hashitem_T *hi;
6859 hi = hash_find(&dict->dv_hashtab, item->di_key);
6860 if (HASHITEM_EMPTY(hi))
6861 EMSG2(_(e_intern2), "dictitem_remove()");
6862 else
6863 hash_remove(&dict->dv_hashtab, hi);
6864 dictitem_free(item);
6868 * Free a dict item. Also clears the value.
6870 void
6871 dictitem_free(item)
6872 dictitem_T *item;
6874 clear_tv(&item->di_tv);
6875 vim_free(item);
6879 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6880 * The refcount of the new dict is set to 1.
6881 * See item_copy() for "copyID".
6882 * Returns NULL when out of memory.
6884 static dict_T *
6885 dict_copy(orig, deep, copyID)
6886 dict_T *orig;
6887 int deep;
6888 int copyID;
6890 dict_T *copy;
6891 dictitem_T *di;
6892 int todo;
6893 hashitem_T *hi;
6895 if (orig == NULL)
6896 return NULL;
6898 copy = dict_alloc();
6899 if (copy != NULL)
6901 if (copyID != 0)
6903 orig->dv_copyID = copyID;
6904 orig->dv_copydict = copy;
6906 todo = (int)orig->dv_hashtab.ht_used;
6907 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6909 if (!HASHITEM_EMPTY(hi))
6911 --todo;
6913 di = dictitem_alloc(hi->hi_key);
6914 if (di == NULL)
6915 break;
6916 if (deep)
6918 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6919 copyID) == FAIL)
6921 vim_free(di);
6922 break;
6925 else
6926 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6927 if (dict_add(copy, di) == FAIL)
6929 dictitem_free(di);
6930 break;
6935 ++copy->dv_refcount;
6936 if (todo > 0)
6938 dict_unref(copy);
6939 copy = NULL;
6943 return copy;
6947 * Add item "item" to Dictionary "d".
6948 * Returns FAIL when out of memory and when key already existed.
6951 dict_add(d, item)
6952 dict_T *d;
6953 dictitem_T *item;
6955 return hash_add(&d->dv_hashtab, item->di_key);
6959 * Add a number or string entry to dictionary "d".
6960 * When "str" is NULL use number "nr", otherwise use "str".
6961 * Returns FAIL when out of memory and when key already exists.
6964 dict_add_nr_str(d, key, nr, str)
6965 dict_T *d;
6966 char *key;
6967 long nr;
6968 char_u *str;
6970 dictitem_T *item;
6972 item = dictitem_alloc((char_u *)key);
6973 if (item == NULL)
6974 return FAIL;
6975 item->di_tv.v_lock = 0;
6976 if (str == NULL)
6978 item->di_tv.v_type = VAR_NUMBER;
6979 item->di_tv.vval.v_number = nr;
6981 else
6983 item->di_tv.v_type = VAR_STRING;
6984 item->di_tv.vval.v_string = vim_strsave(str);
6986 if (dict_add(d, item) == FAIL)
6988 dictitem_free(item);
6989 return FAIL;
6991 return OK;
6995 * Get the number of items in a Dictionary.
6997 static long
6998 dict_len(d)
6999 dict_T *d;
7001 if (d == NULL)
7002 return 0L;
7003 return (long)d->dv_hashtab.ht_used;
7007 * Find item "key[len]" in Dictionary "d".
7008 * If "len" is negative use strlen(key).
7009 * Returns NULL when not found.
7011 static dictitem_T *
7012 dict_find(d, key, len)
7013 dict_T *d;
7014 char_u *key;
7015 int len;
7017 #define AKEYLEN 200
7018 char_u buf[AKEYLEN];
7019 char_u *akey;
7020 char_u *tofree = NULL;
7021 hashitem_T *hi;
7023 if (len < 0)
7024 akey = key;
7025 else if (len >= AKEYLEN)
7027 tofree = akey = vim_strnsave(key, len);
7028 if (akey == NULL)
7029 return NULL;
7031 else
7033 /* Avoid a malloc/free by using buf[]. */
7034 vim_strncpy(buf, key, len);
7035 akey = buf;
7038 hi = hash_find(&d->dv_hashtab, akey);
7039 vim_free(tofree);
7040 if (HASHITEM_EMPTY(hi))
7041 return NULL;
7042 return HI2DI(hi);
7046 * Get a string item from a dictionary.
7047 * When "save" is TRUE allocate memory for it.
7048 * Returns NULL if the entry doesn't exist or out of memory.
7050 char_u *
7051 get_dict_string(d, key, save)
7052 dict_T *d;
7053 char_u *key;
7054 int save;
7056 dictitem_T *di;
7057 char_u *s;
7059 di = dict_find(d, key, -1);
7060 if (di == NULL)
7061 return NULL;
7062 s = get_tv_string(&di->di_tv);
7063 if (save && s != NULL)
7064 s = vim_strsave(s);
7065 return s;
7069 * Get a number item from a dictionary.
7070 * Returns 0 if the entry doesn't exist or out of memory.
7072 long
7073 get_dict_number(d, key)
7074 dict_T *d;
7075 char_u *key;
7077 dictitem_T *di;
7079 di = dict_find(d, key, -1);
7080 if (di == NULL)
7081 return 0;
7082 return get_tv_number(&di->di_tv);
7086 * Return an allocated string with the string representation of a Dictionary.
7087 * May return NULL.
7089 static char_u *
7090 dict2string(tv, copyID)
7091 typval_T *tv;
7092 int copyID;
7094 garray_T ga;
7095 int first = TRUE;
7096 char_u *tofree;
7097 char_u numbuf[NUMBUFLEN];
7098 hashitem_T *hi;
7099 char_u *s;
7100 dict_T *d;
7101 int todo;
7103 if ((d = tv->vval.v_dict) == NULL)
7104 return NULL;
7105 ga_init2(&ga, (int)sizeof(char), 80);
7106 ga_append(&ga, '{');
7108 todo = (int)d->dv_hashtab.ht_used;
7109 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7111 if (!HASHITEM_EMPTY(hi))
7113 --todo;
7115 if (first)
7116 first = FALSE;
7117 else
7118 ga_concat(&ga, (char_u *)", ");
7120 tofree = string_quote(hi->hi_key, FALSE);
7121 if (tofree != NULL)
7123 ga_concat(&ga, tofree);
7124 vim_free(tofree);
7126 ga_concat(&ga, (char_u *)": ");
7127 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7128 if (s != NULL)
7129 ga_concat(&ga, s);
7130 vim_free(tofree);
7131 if (s == NULL)
7132 break;
7135 if (todo > 0)
7137 vim_free(ga.ga_data);
7138 return NULL;
7141 ga_append(&ga, '}');
7142 ga_append(&ga, NUL);
7143 return (char_u *)ga.ga_data;
7147 * Allocate a variable for a Dictionary and fill it from "*arg".
7148 * Return OK or FAIL. Returns NOTDONE for {expr}.
7150 static int
7151 get_dict_tv(arg, rettv, evaluate)
7152 char_u **arg;
7153 typval_T *rettv;
7154 int evaluate;
7156 dict_T *d = NULL;
7157 typval_T tvkey;
7158 typval_T tv;
7159 char_u *key = NULL;
7160 dictitem_T *item;
7161 char_u *start = skipwhite(*arg + 1);
7162 char_u buf[NUMBUFLEN];
7165 * First check if it's not a curly-braces thing: {expr}.
7166 * Must do this without evaluating, otherwise a function may be called
7167 * twice. Unfortunately this means we need to call eval1() twice for the
7168 * first item.
7169 * But {} is an empty Dictionary.
7171 if (*start != '}')
7173 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7174 return FAIL;
7175 if (*start == '}')
7176 return NOTDONE;
7179 if (evaluate)
7181 d = dict_alloc();
7182 if (d == NULL)
7183 return FAIL;
7185 tvkey.v_type = VAR_UNKNOWN;
7186 tv.v_type = VAR_UNKNOWN;
7188 *arg = skipwhite(*arg + 1);
7189 while (**arg != '}' && **arg != NUL)
7191 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7192 goto failret;
7193 if (**arg != ':')
7195 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7196 clear_tv(&tvkey);
7197 goto failret;
7199 if (evaluate)
7201 key = get_tv_string_buf_chk(&tvkey, buf);
7202 if (key == NULL || *key == NUL)
7204 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7205 if (key != NULL)
7206 EMSG(_(e_emptykey));
7207 clear_tv(&tvkey);
7208 goto failret;
7212 *arg = skipwhite(*arg + 1);
7213 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7215 if (evaluate)
7216 clear_tv(&tvkey);
7217 goto failret;
7219 if (evaluate)
7221 item = dict_find(d, key, -1);
7222 if (item != NULL)
7224 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7225 clear_tv(&tvkey);
7226 clear_tv(&tv);
7227 goto failret;
7229 item = dictitem_alloc(key);
7230 clear_tv(&tvkey);
7231 if (item != NULL)
7233 item->di_tv = tv;
7234 item->di_tv.v_lock = 0;
7235 if (dict_add(d, item) == FAIL)
7236 dictitem_free(item);
7240 if (**arg == '}')
7241 break;
7242 if (**arg != ',')
7244 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7245 goto failret;
7247 *arg = skipwhite(*arg + 1);
7250 if (**arg != '}')
7252 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7253 failret:
7254 if (evaluate)
7255 dict_free(d, TRUE);
7256 return FAIL;
7259 *arg = skipwhite(*arg + 1);
7260 if (evaluate)
7262 rettv->v_type = VAR_DICT;
7263 rettv->vval.v_dict = d;
7264 ++d->dv_refcount;
7267 return OK;
7271 * Return a string with the string representation of a variable.
7272 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7273 * "numbuf" is used for a number.
7274 * Does not put quotes around strings, as ":echo" displays values.
7275 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7276 * May return NULL.
7278 static char_u *
7279 echo_string(tv, tofree, numbuf, copyID)
7280 typval_T *tv;
7281 char_u **tofree;
7282 char_u *numbuf;
7283 int copyID;
7285 static int recurse = 0;
7286 char_u *r = NULL;
7288 if (recurse >= DICT_MAXNEST)
7290 EMSG(_("E724: variable nested too deep for displaying"));
7291 *tofree = NULL;
7292 return NULL;
7294 ++recurse;
7296 switch (tv->v_type)
7298 case VAR_FUNC:
7299 *tofree = NULL;
7300 r = tv->vval.v_string;
7301 break;
7303 case VAR_LIST:
7304 if (tv->vval.v_list == NULL)
7306 *tofree = NULL;
7307 r = NULL;
7309 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7311 *tofree = NULL;
7312 r = (char_u *)"[...]";
7314 else
7316 tv->vval.v_list->lv_copyID = copyID;
7317 *tofree = list2string(tv, copyID);
7318 r = *tofree;
7320 break;
7322 case VAR_DICT:
7323 if (tv->vval.v_dict == NULL)
7325 *tofree = NULL;
7326 r = NULL;
7328 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7330 *tofree = NULL;
7331 r = (char_u *)"{...}";
7333 else
7335 tv->vval.v_dict->dv_copyID = copyID;
7336 *tofree = dict2string(tv, copyID);
7337 r = *tofree;
7339 break;
7341 case VAR_STRING:
7342 case VAR_NUMBER:
7343 *tofree = NULL;
7344 r = get_tv_string_buf(tv, numbuf);
7345 break;
7347 #ifdef FEAT_FLOAT
7348 case VAR_FLOAT:
7349 *tofree = NULL;
7350 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7351 r = numbuf;
7352 break;
7353 #endif
7355 default:
7356 EMSG2(_(e_intern2), "echo_string()");
7357 *tofree = NULL;
7360 --recurse;
7361 return r;
7365 * Return a string with the string representation of a variable.
7366 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7367 * "numbuf" is used for a number.
7368 * Puts quotes around strings, so that they can be parsed back by eval().
7369 * May return NULL.
7371 static char_u *
7372 tv2string(tv, tofree, numbuf, copyID)
7373 typval_T *tv;
7374 char_u **tofree;
7375 char_u *numbuf;
7376 int copyID;
7378 switch (tv->v_type)
7380 case VAR_FUNC:
7381 *tofree = string_quote(tv->vval.v_string, TRUE);
7382 return *tofree;
7383 case VAR_STRING:
7384 *tofree = string_quote(tv->vval.v_string, FALSE);
7385 return *tofree;
7386 #ifdef FEAT_FLOAT
7387 case VAR_FLOAT:
7388 *tofree = NULL;
7389 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7390 return numbuf;
7391 #endif
7392 case VAR_NUMBER:
7393 case VAR_LIST:
7394 case VAR_DICT:
7395 break;
7396 default:
7397 EMSG2(_(e_intern2), "tv2string()");
7399 return echo_string(tv, tofree, numbuf, copyID);
7403 * Return string "str" in ' quotes, doubling ' characters.
7404 * If "str" is NULL an empty string is assumed.
7405 * If "function" is TRUE make it function('string').
7407 static char_u *
7408 string_quote(str, function)
7409 char_u *str;
7410 int function;
7412 unsigned len;
7413 char_u *p, *r, *s;
7415 len = (function ? 13 : 3);
7416 if (str != NULL)
7418 len += (unsigned)STRLEN(str);
7419 for (p = str; *p != NUL; mb_ptr_adv(p))
7420 if (*p == '\'')
7421 ++len;
7423 s = r = alloc(len);
7424 if (r != NULL)
7426 if (function)
7428 STRCPY(r, "function('");
7429 r += 10;
7431 else
7432 *r++ = '\'';
7433 if (str != NULL)
7434 for (p = str; *p != NUL; )
7436 if (*p == '\'')
7437 *r++ = '\'';
7438 MB_COPY_CHAR(p, r);
7440 *r++ = '\'';
7441 if (function)
7442 *r++ = ')';
7443 *r++ = NUL;
7445 return s;
7448 #ifdef FEAT_FLOAT
7450 * Convert the string "text" to a floating point number.
7451 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7452 * this always uses a decimal point.
7453 * Returns the length of the text that was consumed.
7455 static int
7456 string2float(text, value)
7457 char_u *text;
7458 float_T *value; /* result stored here */
7460 char *s = (char *)text;
7461 float_T f;
7463 f = strtod(s, &s);
7464 *value = f;
7465 return (int)((char_u *)s - text);
7467 #endif
7470 * Get the value of an environment variable.
7471 * "arg" is pointing to the '$'. It is advanced to after the name.
7472 * If the environment variable was not set, silently assume it is empty.
7473 * Always return OK.
7475 static int
7476 get_env_tv(arg, rettv, evaluate)
7477 char_u **arg;
7478 typval_T *rettv;
7479 int evaluate;
7481 char_u *string = NULL;
7482 int len;
7483 int cc;
7484 char_u *name;
7485 int mustfree = FALSE;
7487 ++*arg;
7488 name = *arg;
7489 len = get_env_len(arg);
7490 if (evaluate)
7492 if (len != 0)
7494 cc = name[len];
7495 name[len] = NUL;
7496 /* first try vim_getenv(), fast for normal environment vars */
7497 string = vim_getenv(name, &mustfree);
7498 if (string != NULL && *string != NUL)
7500 if (!mustfree)
7501 string = vim_strsave(string);
7503 else
7505 if (mustfree)
7506 vim_free(string);
7508 /* next try expanding things like $VIM and ${HOME} */
7509 string = expand_env_save(name - 1);
7510 if (string != NULL && *string == '$')
7512 vim_free(string);
7513 string = NULL;
7516 name[len] = cc;
7518 rettv->v_type = VAR_STRING;
7519 rettv->vval.v_string = string;
7522 return OK;
7526 * Array with names and number of arguments of all internal functions
7527 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7529 static struct fst
7531 char *f_name; /* function name */
7532 char f_min_argc; /* minimal number of arguments */
7533 char f_max_argc; /* maximal number of arguments */
7534 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7535 /* implementation of function */
7536 } functions[] =
7538 #ifdef FEAT_FLOAT
7539 {"abs", 1, 1, f_abs},
7540 #endif
7541 {"add", 2, 2, f_add},
7542 {"append", 2, 2, f_append},
7543 {"argc", 0, 0, f_argc},
7544 {"argidx", 0, 0, f_argidx},
7545 {"argv", 0, 1, f_argv},
7546 #ifdef FEAT_FLOAT
7547 {"atan", 1, 1, f_atan},
7548 #endif
7549 {"browse", 4, 4, f_browse},
7550 {"browsedir", 2, 2, f_browsedir},
7551 {"bufexists", 1, 1, f_bufexists},
7552 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7553 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7554 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7555 {"buflisted", 1, 1, f_buflisted},
7556 {"bufloaded", 1, 1, f_bufloaded},
7557 {"bufname", 1, 1, f_bufname},
7558 {"bufnr", 1, 2, f_bufnr},
7559 {"bufwinnr", 1, 1, f_bufwinnr},
7560 {"byte2line", 1, 1, f_byte2line},
7561 {"byteidx", 2, 2, f_byteidx},
7562 {"call", 2, 3, f_call},
7563 #ifdef FEAT_FLOAT
7564 {"ceil", 1, 1, f_ceil},
7565 #endif
7566 {"changenr", 0, 0, f_changenr},
7567 {"char2nr", 1, 1, f_char2nr},
7568 {"cindent", 1, 1, f_cindent},
7569 {"clearmatches", 0, 0, f_clearmatches},
7570 {"col", 1, 1, f_col},
7571 #if defined(FEAT_INS_EXPAND)
7572 {"complete", 2, 2, f_complete},
7573 {"complete_add", 1, 1, f_complete_add},
7574 {"complete_check", 0, 0, f_complete_check},
7575 #endif
7576 {"confirm", 1, 4, f_confirm},
7577 {"copy", 1, 1, f_copy},
7578 #ifdef FEAT_FLOAT
7579 {"cos", 1, 1, f_cos},
7580 #endif
7581 {"count", 2, 4, f_count},
7582 {"cscope_connection",0,3, f_cscope_connection},
7583 {"cursor", 1, 3, f_cursor},
7584 {"deepcopy", 1, 2, f_deepcopy},
7585 {"delete", 1, 1, f_delete},
7586 {"did_filetype", 0, 0, f_did_filetype},
7587 {"diff_filler", 1, 1, f_diff_filler},
7588 {"diff_hlID", 2, 2, f_diff_hlID},
7589 {"empty", 1, 1, f_empty},
7590 {"escape", 2, 2, f_escape},
7591 {"eval", 1, 1, f_eval},
7592 {"eventhandler", 0, 0, f_eventhandler},
7593 {"executable", 1, 1, f_executable},
7594 {"exists", 1, 1, f_exists},
7595 {"expand", 1, 2, f_expand},
7596 {"extend", 2, 3, f_extend},
7597 {"feedkeys", 1, 2, f_feedkeys},
7598 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7599 {"filereadable", 1, 1, f_filereadable},
7600 {"filewritable", 1, 1, f_filewritable},
7601 {"filter", 2, 2, f_filter},
7602 {"finddir", 1, 3, f_finddir},
7603 {"findfile", 1, 3, f_findfile},
7604 #ifdef FEAT_FLOAT
7605 {"float2nr", 1, 1, f_float2nr},
7606 {"floor", 1, 1, f_floor},
7607 #endif
7608 {"fnameescape", 1, 1, f_fnameescape},
7609 {"fnamemodify", 2, 2, f_fnamemodify},
7610 {"foldclosed", 1, 1, f_foldclosed},
7611 {"foldclosedend", 1, 1, f_foldclosedend},
7612 {"foldlevel", 1, 1, f_foldlevel},
7613 {"foldtext", 0, 0, f_foldtext},
7614 {"foldtextresult", 1, 1, f_foldtextresult},
7615 {"foreground", 0, 0, f_foreground},
7616 {"function", 1, 1, f_function},
7617 {"garbagecollect", 0, 1, f_garbagecollect},
7618 {"get", 2, 3, f_get},
7619 {"getbufline", 2, 3, f_getbufline},
7620 {"getbufvar", 2, 2, f_getbufvar},
7621 {"getchar", 0, 1, f_getchar},
7622 {"getcharmod", 0, 0, f_getcharmod},
7623 {"getcmdline", 0, 0, f_getcmdline},
7624 {"getcmdpos", 0, 0, f_getcmdpos},
7625 {"getcmdtype", 0, 0, f_getcmdtype},
7626 {"getcwd", 0, 0, f_getcwd},
7627 {"getfontname", 0, 1, f_getfontname},
7628 {"getfperm", 1, 1, f_getfperm},
7629 {"getfsize", 1, 1, f_getfsize},
7630 {"getftime", 1, 1, f_getftime},
7631 {"getftype", 1, 1, f_getftype},
7632 {"getline", 1, 2, f_getline},
7633 {"getloclist", 1, 1, f_getqflist},
7634 {"getmatches", 0, 0, f_getmatches},
7635 {"getpid", 0, 0, f_getpid},
7636 {"getpos", 1, 1, f_getpos},
7637 {"getqflist", 0, 0, f_getqflist},
7638 {"getreg", 0, 2, f_getreg},
7639 {"getregtype", 0, 1, f_getregtype},
7640 {"gettabwinvar", 3, 3, f_gettabwinvar},
7641 {"getwinposx", 0, 0, f_getwinposx},
7642 {"getwinposy", 0, 0, f_getwinposy},
7643 {"getwinvar", 2, 2, f_getwinvar},
7644 {"glob", 1, 2, f_glob},
7645 {"globpath", 2, 3, f_globpath},
7646 {"has", 1, 1, f_has},
7647 {"has_key", 2, 2, f_has_key},
7648 {"haslocaldir", 0, 0, f_haslocaldir},
7649 {"hasmapto", 1, 3, f_hasmapto},
7650 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7651 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7652 {"histadd", 2, 2, f_histadd},
7653 {"histdel", 1, 2, f_histdel},
7654 {"histget", 1, 2, f_histget},
7655 {"histnr", 1, 1, f_histnr},
7656 {"hlID", 1, 1, f_hlID},
7657 {"hlexists", 1, 1, f_hlexists},
7658 {"hostname", 0, 0, f_hostname},
7659 {"iconv", 3, 3, f_iconv},
7660 {"indent", 1, 1, f_indent},
7661 {"index", 2, 4, f_index},
7662 {"input", 1, 3, f_input},
7663 {"inputdialog", 1, 3, f_inputdialog},
7664 {"inputlist", 1, 1, f_inputlist},
7665 {"inputrestore", 0, 0, f_inputrestore},
7666 {"inputsave", 0, 0, f_inputsave},
7667 {"inputsecret", 1, 2, f_inputsecret},
7668 {"insert", 2, 3, f_insert},
7669 {"isdirectory", 1, 1, f_isdirectory},
7670 {"islocked", 1, 1, f_islocked},
7671 {"items", 1, 1, f_items},
7672 {"join", 1, 2, f_join},
7673 {"keys", 1, 1, f_keys},
7674 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7675 {"len", 1, 1, f_len},
7676 {"libcall", 3, 3, f_libcall},
7677 {"libcallnr", 3, 3, f_libcallnr},
7678 {"line", 1, 1, f_line},
7679 {"line2byte", 1, 1, f_line2byte},
7680 {"lispindent", 1, 1, f_lispindent},
7681 {"localtime", 0, 0, f_localtime},
7682 #ifdef FEAT_FLOAT
7683 {"log10", 1, 1, f_log10},
7684 #endif
7685 {"map", 2, 2, f_map},
7686 {"maparg", 1, 3, f_maparg},
7687 {"mapcheck", 1, 3, f_mapcheck},
7688 {"match", 2, 4, f_match},
7689 {"matchadd", 2, 4, f_matchadd},
7690 {"matcharg", 1, 1, f_matcharg},
7691 {"matchdelete", 1, 1, f_matchdelete},
7692 {"matchend", 2, 4, f_matchend},
7693 {"matchlist", 2, 4, f_matchlist},
7694 {"matchstr", 2, 4, f_matchstr},
7695 {"max", 1, 1, f_max},
7696 {"min", 1, 1, f_min},
7697 #ifdef vim_mkdir
7698 {"mkdir", 1, 3, f_mkdir},
7699 #endif
7700 {"mode", 0, 1, f_mode},
7701 #ifdef FEAT_MZSCHEME
7702 {"mzeval", 1, 1, f_mzeval},
7703 #endif
7704 {"nextnonblank", 1, 1, f_nextnonblank},
7705 {"nr2char", 1, 1, f_nr2char},
7706 {"pathshorten", 1, 1, f_pathshorten},
7707 #ifdef FEAT_FLOAT
7708 {"pow", 2, 2, f_pow},
7709 #endif
7710 {"prevnonblank", 1, 1, f_prevnonblank},
7711 {"printf", 2, 19, f_printf},
7712 {"pumvisible", 0, 0, f_pumvisible},
7713 {"range", 1, 3, f_range},
7714 {"readfile", 1, 3, f_readfile},
7715 {"reltime", 0, 2, f_reltime},
7716 {"reltimestr", 1, 1, f_reltimestr},
7717 {"remote_expr", 2, 3, f_remote_expr},
7718 {"remote_foreground", 1, 1, f_remote_foreground},
7719 {"remote_peek", 1, 2, f_remote_peek},
7720 {"remote_read", 1, 1, f_remote_read},
7721 {"remote_send", 2, 3, f_remote_send},
7722 {"remove", 2, 3, f_remove},
7723 {"rename", 2, 2, f_rename},
7724 {"repeat", 2, 2, f_repeat},
7725 {"resolve", 1, 1, f_resolve},
7726 {"reverse", 1, 1, f_reverse},
7727 #ifdef FEAT_FLOAT
7728 {"round", 1, 1, f_round},
7729 #endif
7730 {"search", 1, 4, f_search},
7731 {"searchdecl", 1, 3, f_searchdecl},
7732 {"searchpair", 3, 7, f_searchpair},
7733 {"searchpairpos", 3, 7, f_searchpairpos},
7734 {"searchpos", 1, 4, f_searchpos},
7735 {"server2client", 2, 2, f_server2client},
7736 {"serverlist", 0, 0, f_serverlist},
7737 {"setbufvar", 3, 3, f_setbufvar},
7738 {"setcmdpos", 1, 1, f_setcmdpos},
7739 {"setline", 2, 2, f_setline},
7740 {"setloclist", 2, 3, f_setloclist},
7741 {"setmatches", 1, 1, f_setmatches},
7742 {"setpos", 2, 2, f_setpos},
7743 {"setqflist", 1, 2, f_setqflist},
7744 {"setreg", 2, 3, f_setreg},
7745 {"settabwinvar", 4, 4, f_settabwinvar},
7746 {"setwinvar", 3, 3, f_setwinvar},
7747 {"shellescape", 1, 2, f_shellescape},
7748 {"simplify", 1, 1, f_simplify},
7749 #ifdef FEAT_FLOAT
7750 {"sin", 1, 1, f_sin},
7751 #endif
7752 {"sort", 1, 2, f_sort},
7753 {"soundfold", 1, 1, f_soundfold},
7754 {"spellbadword", 0, 1, f_spellbadword},
7755 {"spellsuggest", 1, 3, f_spellsuggest},
7756 {"split", 1, 3, f_split},
7757 #ifdef FEAT_FLOAT
7758 {"sqrt", 1, 1, f_sqrt},
7759 {"str2float", 1, 1, f_str2float},
7760 #endif
7761 {"str2nr", 1, 2, f_str2nr},
7762 #ifdef HAVE_STRFTIME
7763 {"strftime", 1, 2, f_strftime},
7764 #endif
7765 {"stridx", 2, 3, f_stridx},
7766 {"string", 1, 1, f_string},
7767 {"strlen", 1, 1, f_strlen},
7768 {"strpart", 2, 3, f_strpart},
7769 {"strridx", 2, 3, f_strridx},
7770 {"strtrans", 1, 1, f_strtrans},
7771 {"submatch", 1, 1, f_submatch},
7772 {"substitute", 4, 4, f_substitute},
7773 {"synID", 3, 3, f_synID},
7774 {"synIDattr", 2, 3, f_synIDattr},
7775 {"synIDtrans", 1, 1, f_synIDtrans},
7776 {"synstack", 2, 2, f_synstack},
7777 {"system", 1, 2, f_system},
7778 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7779 {"tabpagenr", 0, 1, f_tabpagenr},
7780 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7781 {"tagfiles", 0, 0, f_tagfiles},
7782 {"taglist", 1, 1, f_taglist},
7783 {"tempname", 0, 0, f_tempname},
7784 {"test", 1, 1, f_test},
7785 {"tolower", 1, 1, f_tolower},
7786 {"toupper", 1, 1, f_toupper},
7787 {"tr", 3, 3, f_tr},
7788 #ifdef FEAT_FLOAT
7789 {"trunc", 1, 1, f_trunc},
7790 #endif
7791 {"type", 1, 1, f_type},
7792 {"values", 1, 1, f_values},
7793 {"virtcol", 1, 1, f_virtcol},
7794 {"visualmode", 0, 1, f_visualmode},
7795 {"winbufnr", 1, 1, f_winbufnr},
7796 {"wincol", 0, 0, f_wincol},
7797 {"winheight", 1, 1, f_winheight},
7798 {"winline", 0, 0, f_winline},
7799 {"winnr", 0, 1, f_winnr},
7800 {"winrestcmd", 0, 0, f_winrestcmd},
7801 {"winrestview", 1, 1, f_winrestview},
7802 {"winsaveview", 0, 0, f_winsaveview},
7803 {"winwidth", 1, 1, f_winwidth},
7804 {"writefile", 2, 3, f_writefile},
7807 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7810 * Function given to ExpandGeneric() to obtain the list of internal
7811 * or user defined function names.
7813 char_u *
7814 get_function_name(xp, idx)
7815 expand_T *xp;
7816 int idx;
7818 static int intidx = -1;
7819 char_u *name;
7821 if (idx == 0)
7822 intidx = -1;
7823 if (intidx < 0)
7825 name = get_user_func_name(xp, idx);
7826 if (name != NULL)
7827 return name;
7829 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7831 STRCPY(IObuff, functions[intidx].f_name);
7832 STRCAT(IObuff, "(");
7833 if (functions[intidx].f_max_argc == 0)
7834 STRCAT(IObuff, ")");
7835 return IObuff;
7838 return NULL;
7842 * Function given to ExpandGeneric() to obtain the list of internal or
7843 * user defined variable or function names.
7845 char_u *
7846 get_expr_name(xp, idx)
7847 expand_T *xp;
7848 int idx;
7850 static int intidx = -1;
7851 char_u *name;
7853 if (idx == 0)
7854 intidx = -1;
7855 if (intidx < 0)
7857 name = get_function_name(xp, idx);
7858 if (name != NULL)
7859 return name;
7861 return get_user_var_name(xp, ++intidx);
7864 #endif /* FEAT_CMDL_COMPL */
7867 * Find internal function in table above.
7868 * Return index, or -1 if not found
7870 static int
7871 find_internal_func(name)
7872 char_u *name; /* name of the function */
7874 int first = 0;
7875 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7876 int cmp;
7877 int x;
7880 * Find the function name in the table. Binary search.
7882 while (first <= last)
7884 x = first + ((unsigned)(last - first) >> 1);
7885 cmp = STRCMP(name, functions[x].f_name);
7886 if (cmp < 0)
7887 last = x - 1;
7888 else if (cmp > 0)
7889 first = x + 1;
7890 else
7891 return x;
7893 return -1;
7897 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7898 * name it contains, otherwise return "name".
7900 static char_u *
7901 deref_func_name(name, lenp)
7902 char_u *name;
7903 int *lenp;
7905 dictitem_T *v;
7906 int cc;
7908 cc = name[*lenp];
7909 name[*lenp] = NUL;
7910 v = find_var(name, NULL);
7911 name[*lenp] = cc;
7912 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7914 if (v->di_tv.vval.v_string == NULL)
7916 *lenp = 0;
7917 return (char_u *)""; /* just in case */
7919 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7920 return v->di_tv.vval.v_string;
7923 return name;
7927 * Allocate a variable for the result of a function.
7928 * Return OK or FAIL.
7930 static int
7931 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7932 evaluate, selfdict)
7933 char_u *name; /* name of the function */
7934 int len; /* length of "name" */
7935 typval_T *rettv;
7936 char_u **arg; /* argument, pointing to the '(' */
7937 linenr_T firstline; /* first line of range */
7938 linenr_T lastline; /* last line of range */
7939 int *doesrange; /* return: function handled range */
7940 int evaluate;
7941 dict_T *selfdict; /* Dictionary for "self" */
7943 char_u *argp;
7944 int ret = OK;
7945 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7946 int argcount = 0; /* number of arguments found */
7949 * Get the arguments.
7951 argp = *arg;
7952 while (argcount < MAX_FUNC_ARGS)
7954 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7955 if (*argp == ')' || *argp == ',' || *argp == NUL)
7956 break;
7957 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7959 ret = FAIL;
7960 break;
7962 ++argcount;
7963 if (*argp != ',')
7964 break;
7966 if (*argp == ')')
7967 ++argp;
7968 else
7969 ret = FAIL;
7971 if (ret == OK)
7972 ret = call_func(name, len, rettv, argcount, argvars,
7973 firstline, lastline, doesrange, evaluate, selfdict);
7974 else if (!aborting())
7976 if (argcount == MAX_FUNC_ARGS)
7977 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
7978 else
7979 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
7982 while (--argcount >= 0)
7983 clear_tv(&argvars[argcount]);
7985 *arg = skipwhite(argp);
7986 return ret;
7991 * Call a function with its resolved parameters
7992 * Return OK when the function can't be called, FAIL otherwise.
7993 * Also returns OK when an error was encountered while executing the function.
7995 static int
7996 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7997 doesrange, evaluate, selfdict)
7998 char_u *name; /* name of the function */
7999 int len; /* length of "name" */
8000 typval_T *rettv; /* return value goes here */
8001 int argcount; /* number of "argvars" */
8002 typval_T *argvars; /* vars for arguments, must have "argcount"
8003 PLUS ONE elements! */
8004 linenr_T firstline; /* first line of range */
8005 linenr_T lastline; /* last line of range */
8006 int *doesrange; /* return: function handled range */
8007 int evaluate;
8008 dict_T *selfdict; /* Dictionary for "self" */
8010 int ret = FAIL;
8011 #define ERROR_UNKNOWN 0
8012 #define ERROR_TOOMANY 1
8013 #define ERROR_TOOFEW 2
8014 #define ERROR_SCRIPT 3
8015 #define ERROR_DICT 4
8016 #define ERROR_NONE 5
8017 #define ERROR_OTHER 6
8018 int error = ERROR_NONE;
8019 int i;
8020 int llen;
8021 ufunc_T *fp;
8022 int cc;
8023 #define FLEN_FIXED 40
8024 char_u fname_buf[FLEN_FIXED + 1];
8025 char_u *fname;
8028 * In a script change <SID>name() and s:name() to K_SNR 123_name().
8029 * Change <SNR>123_name() to K_SNR 123_name().
8030 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
8032 cc = name[len];
8033 name[len] = NUL;
8034 llen = eval_fname_script(name);
8035 if (llen > 0)
8037 fname_buf[0] = K_SPECIAL;
8038 fname_buf[1] = KS_EXTRA;
8039 fname_buf[2] = (int)KE_SNR;
8040 i = 3;
8041 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
8043 if (current_SID <= 0)
8044 error = ERROR_SCRIPT;
8045 else
8047 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
8048 i = (int)STRLEN(fname_buf);
8051 if (i + STRLEN(name + llen) < FLEN_FIXED)
8053 STRCPY(fname_buf + i, name + llen);
8054 fname = fname_buf;
8056 else
8058 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8059 if (fname == NULL)
8060 error = ERROR_OTHER;
8061 else
8063 mch_memmove(fname, fname_buf, (size_t)i);
8064 STRCPY(fname + i, name + llen);
8068 else
8069 fname = name;
8071 *doesrange = FALSE;
8074 /* execute the function if no errors detected and executing */
8075 if (evaluate && error == ERROR_NONE)
8077 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */
8078 rettv->vval.v_number = 0;
8079 error = ERROR_UNKNOWN;
8081 if (!builtin_function(fname))
8084 * User defined function.
8086 fp = find_func(fname);
8088 #ifdef FEAT_AUTOCMD
8089 /* Trigger FuncUndefined event, may load the function. */
8090 if (fp == NULL
8091 && apply_autocmds(EVENT_FUNCUNDEFINED,
8092 fname, fname, TRUE, NULL)
8093 && !aborting())
8095 /* executed an autocommand, search for the function again */
8096 fp = find_func(fname);
8098 #endif
8099 /* Try loading a package. */
8100 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8102 /* loaded a package, search for the function again */
8103 fp = find_func(fname);
8106 if (fp != NULL)
8108 if (fp->uf_flags & FC_RANGE)
8109 *doesrange = TRUE;
8110 if (argcount < fp->uf_args.ga_len)
8111 error = ERROR_TOOFEW;
8112 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8113 error = ERROR_TOOMANY;
8114 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8115 error = ERROR_DICT;
8116 else
8119 * Call the user function.
8120 * Save and restore search patterns, script variables and
8121 * redo buffer.
8123 save_search_patterns();
8124 saveRedobuff();
8125 ++fp->uf_calls;
8126 call_user_func(fp, argcount, argvars, rettv,
8127 firstline, lastline,
8128 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8129 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8130 && fp->uf_refcount <= 0)
8131 /* Function was unreferenced while being used, free it
8132 * now. */
8133 func_free(fp);
8134 restoreRedobuff();
8135 restore_search_patterns();
8136 error = ERROR_NONE;
8140 else
8143 * Find the function name in the table, call its implementation.
8145 i = find_internal_func(fname);
8146 if (i >= 0)
8148 if (argcount < functions[i].f_min_argc)
8149 error = ERROR_TOOFEW;
8150 else if (argcount > functions[i].f_max_argc)
8151 error = ERROR_TOOMANY;
8152 else
8154 argvars[argcount].v_type = VAR_UNKNOWN;
8155 functions[i].f_func(argvars, rettv);
8156 error = ERROR_NONE;
8161 * The function call (or "FuncUndefined" autocommand sequence) might
8162 * have been aborted by an error, an interrupt, or an explicitly thrown
8163 * exception that has not been caught so far. This situation can be
8164 * tested for by calling aborting(). For an error in an internal
8165 * function or for the "E132" error in call_user_func(), however, the
8166 * throw point at which the "force_abort" flag (temporarily reset by
8167 * emsg()) is normally updated has not been reached yet. We need to
8168 * update that flag first to make aborting() reliable.
8170 update_force_abort();
8172 if (error == ERROR_NONE)
8173 ret = OK;
8176 * Report an error unless the argument evaluation or function call has been
8177 * cancelled due to an aborting error, an interrupt, or an exception.
8179 if (!aborting())
8181 switch (error)
8183 case ERROR_UNKNOWN:
8184 emsg_funcname(N_("E117: Unknown function: %s"), name);
8185 break;
8186 case ERROR_TOOMANY:
8187 emsg_funcname(e_toomanyarg, name);
8188 break;
8189 case ERROR_TOOFEW:
8190 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8191 name);
8192 break;
8193 case ERROR_SCRIPT:
8194 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8195 name);
8196 break;
8197 case ERROR_DICT:
8198 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8199 name);
8200 break;
8204 name[len] = cc;
8205 if (fname != name && fname != fname_buf)
8206 vim_free(fname);
8208 return ret;
8212 * Give an error message with a function name. Handle <SNR> things.
8213 * "ermsg" is to be passed without translation, use N_() instead of _().
8215 static void
8216 emsg_funcname(ermsg, name)
8217 char *ermsg;
8218 char_u *name;
8220 char_u *p;
8222 if (*name == K_SPECIAL)
8223 p = concat_str((char_u *)"<SNR>", name + 3);
8224 else
8225 p = name;
8226 EMSG2(_(ermsg), p);
8227 if (p != name)
8228 vim_free(p);
8232 * Return TRUE for a non-zero Number and a non-empty String.
8234 static int
8235 non_zero_arg(argvars)
8236 typval_T *argvars;
8238 return ((argvars[0].v_type == VAR_NUMBER
8239 && argvars[0].vval.v_number != 0)
8240 || (argvars[0].v_type == VAR_STRING
8241 && argvars[0].vval.v_string != NULL
8242 && *argvars[0].vval.v_string != NUL));
8245 /*********************************************
8246 * Implementation of the built-in functions
8249 #ifdef FEAT_FLOAT
8251 * "abs(expr)" function
8253 static void
8254 f_abs(argvars, rettv)
8255 typval_T *argvars;
8256 typval_T *rettv;
8258 if (argvars[0].v_type == VAR_FLOAT)
8260 rettv->v_type = VAR_FLOAT;
8261 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8263 else
8265 varnumber_T n;
8266 int error = FALSE;
8268 n = get_tv_number_chk(&argvars[0], &error);
8269 if (error)
8270 rettv->vval.v_number = -1;
8271 else if (n > 0)
8272 rettv->vval.v_number = n;
8273 else
8274 rettv->vval.v_number = -n;
8277 #endif
8280 * "add(list, item)" function
8282 static void
8283 f_add(argvars, rettv)
8284 typval_T *argvars;
8285 typval_T *rettv;
8287 list_T *l;
8289 rettv->vval.v_number = 1; /* Default: Failed */
8290 if (argvars[0].v_type == VAR_LIST)
8292 if ((l = argvars[0].vval.v_list) != NULL
8293 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8294 && list_append_tv(l, &argvars[1]) == OK)
8295 copy_tv(&argvars[0], rettv);
8297 else
8298 EMSG(_(e_listreq));
8302 * "append(lnum, string/list)" function
8304 static void
8305 f_append(argvars, rettv)
8306 typval_T *argvars;
8307 typval_T *rettv;
8309 long lnum;
8310 char_u *line;
8311 list_T *l = NULL;
8312 listitem_T *li = NULL;
8313 typval_T *tv;
8314 long added = 0;
8316 lnum = get_tv_lnum(argvars);
8317 if (lnum >= 0
8318 && lnum <= curbuf->b_ml.ml_line_count
8319 && u_save(lnum, lnum + 1) == OK)
8321 if (argvars[1].v_type == VAR_LIST)
8323 l = argvars[1].vval.v_list;
8324 if (l == NULL)
8325 return;
8326 li = l->lv_first;
8328 for (;;)
8330 if (l == NULL)
8331 tv = &argvars[1]; /* append a string */
8332 else if (li == NULL)
8333 break; /* end of list */
8334 else
8335 tv = &li->li_tv; /* append item from list */
8336 line = get_tv_string_chk(tv);
8337 if (line == NULL) /* type error */
8339 rettv->vval.v_number = 1; /* Failed */
8340 break;
8342 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8343 ++added;
8344 if (l == NULL)
8345 break;
8346 li = li->li_next;
8349 appended_lines_mark(lnum, added);
8350 if (curwin->w_cursor.lnum > lnum)
8351 curwin->w_cursor.lnum += added;
8353 else
8354 rettv->vval.v_number = 1; /* Failed */
8358 * "argc()" function
8360 static void
8361 f_argc(argvars, rettv)
8362 typval_T *argvars UNUSED;
8363 typval_T *rettv;
8365 rettv->vval.v_number = ARGCOUNT;
8369 * "argidx()" function
8371 static void
8372 f_argidx(argvars, rettv)
8373 typval_T *argvars UNUSED;
8374 typval_T *rettv;
8376 rettv->vval.v_number = curwin->w_arg_idx;
8380 * "argv(nr)" function
8382 static void
8383 f_argv(argvars, rettv)
8384 typval_T *argvars;
8385 typval_T *rettv;
8387 int idx;
8389 if (argvars[0].v_type != VAR_UNKNOWN)
8391 idx = get_tv_number_chk(&argvars[0], NULL);
8392 if (idx >= 0 && idx < ARGCOUNT)
8393 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8394 else
8395 rettv->vval.v_string = NULL;
8396 rettv->v_type = VAR_STRING;
8398 else if (rettv_list_alloc(rettv) == OK)
8399 for (idx = 0; idx < ARGCOUNT; ++idx)
8400 list_append_string(rettv->vval.v_list,
8401 alist_name(&ARGLIST[idx]), -1);
8404 #ifdef FEAT_FLOAT
8405 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8408 * Get the float value of "argvars[0]" into "f".
8409 * Returns FAIL when the argument is not a Number or Float.
8411 static int
8412 get_float_arg(argvars, f)
8413 typval_T *argvars;
8414 float_T *f;
8416 if (argvars[0].v_type == VAR_FLOAT)
8418 *f = argvars[0].vval.v_float;
8419 return OK;
8421 if (argvars[0].v_type == VAR_NUMBER)
8423 *f = (float_T)argvars[0].vval.v_number;
8424 return OK;
8426 EMSG(_("E808: Number or Float required"));
8427 return FAIL;
8431 * "atan()" function
8433 static void
8434 f_atan(argvars, rettv)
8435 typval_T *argvars;
8436 typval_T *rettv;
8438 float_T f;
8440 rettv->v_type = VAR_FLOAT;
8441 if (get_float_arg(argvars, &f) == OK)
8442 rettv->vval.v_float = atan(f);
8443 else
8444 rettv->vval.v_float = 0.0;
8446 #endif
8449 * "browse(save, title, initdir, default)" function
8451 static void
8452 f_browse(argvars, rettv)
8453 typval_T *argvars UNUSED;
8454 typval_T *rettv;
8456 #ifdef FEAT_BROWSE
8457 int save;
8458 char_u *title;
8459 char_u *initdir;
8460 char_u *defname;
8461 char_u buf[NUMBUFLEN];
8462 char_u buf2[NUMBUFLEN];
8463 int error = FALSE;
8465 save = get_tv_number_chk(&argvars[0], &error);
8466 title = get_tv_string_chk(&argvars[1]);
8467 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8468 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8470 if (error || title == NULL || initdir == NULL || defname == NULL)
8471 rettv->vval.v_string = NULL;
8472 else
8473 rettv->vval.v_string =
8474 do_browse(save ? BROWSE_SAVE : 0,
8475 title, defname, NULL, initdir, NULL, curbuf);
8476 #else
8477 rettv->vval.v_string = NULL;
8478 #endif
8479 rettv->v_type = VAR_STRING;
8483 * "browsedir(title, initdir)" function
8485 static void
8486 f_browsedir(argvars, rettv)
8487 typval_T *argvars UNUSED;
8488 typval_T *rettv;
8490 #ifdef FEAT_BROWSE
8491 char_u *title;
8492 char_u *initdir;
8493 char_u buf[NUMBUFLEN];
8495 title = get_tv_string_chk(&argvars[0]);
8496 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8498 if (title == NULL || initdir == NULL)
8499 rettv->vval.v_string = NULL;
8500 else
8501 rettv->vval.v_string = do_browse(BROWSE_DIR,
8502 title, NULL, NULL, initdir, NULL, curbuf);
8503 #else
8504 rettv->vval.v_string = NULL;
8505 #endif
8506 rettv->v_type = VAR_STRING;
8509 static buf_T *find_buffer __ARGS((typval_T *avar));
8512 * Find a buffer by number or exact name.
8514 static buf_T *
8515 find_buffer(avar)
8516 typval_T *avar;
8518 buf_T *buf = NULL;
8520 if (avar->v_type == VAR_NUMBER)
8521 buf = buflist_findnr((int)avar->vval.v_number);
8522 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8524 buf = buflist_findname_exp(avar->vval.v_string);
8525 if (buf == NULL)
8527 /* No full path name match, try a match with a URL or a "nofile"
8528 * buffer, these don't use the full path. */
8529 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8530 if (buf->b_fname != NULL
8531 && (path_with_url(buf->b_fname)
8532 #ifdef FEAT_QUICKFIX
8533 || bt_nofile(buf)
8534 #endif
8536 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8537 break;
8540 return buf;
8544 * "bufexists(expr)" function
8546 static void
8547 f_bufexists(argvars, rettv)
8548 typval_T *argvars;
8549 typval_T *rettv;
8551 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8555 * "buflisted(expr)" function
8557 static void
8558 f_buflisted(argvars, rettv)
8559 typval_T *argvars;
8560 typval_T *rettv;
8562 buf_T *buf;
8564 buf = find_buffer(&argvars[0]);
8565 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8569 * "bufloaded(expr)" function
8571 static void
8572 f_bufloaded(argvars, rettv)
8573 typval_T *argvars;
8574 typval_T *rettv;
8576 buf_T *buf;
8578 buf = find_buffer(&argvars[0]);
8579 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8582 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8585 * Get buffer by number or pattern.
8587 static buf_T *
8588 get_buf_tv(tv)
8589 typval_T *tv;
8591 char_u *name = tv->vval.v_string;
8592 int save_magic;
8593 char_u *save_cpo;
8594 buf_T *buf;
8596 if (tv->v_type == VAR_NUMBER)
8597 return buflist_findnr((int)tv->vval.v_number);
8598 if (tv->v_type != VAR_STRING)
8599 return NULL;
8600 if (name == NULL || *name == NUL)
8601 return curbuf;
8602 if (name[0] == '$' && name[1] == NUL)
8603 return lastbuf;
8605 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8606 save_magic = p_magic;
8607 p_magic = TRUE;
8608 save_cpo = p_cpo;
8609 p_cpo = (char_u *)"";
8611 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8612 TRUE, FALSE));
8614 p_magic = save_magic;
8615 p_cpo = save_cpo;
8617 /* If not found, try expanding the name, like done for bufexists(). */
8618 if (buf == NULL)
8619 buf = find_buffer(tv);
8621 return buf;
8625 * "bufname(expr)" function
8627 static void
8628 f_bufname(argvars, rettv)
8629 typval_T *argvars;
8630 typval_T *rettv;
8632 buf_T *buf;
8634 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8635 ++emsg_off;
8636 buf = get_buf_tv(&argvars[0]);
8637 rettv->v_type = VAR_STRING;
8638 if (buf != NULL && buf->b_fname != NULL)
8639 rettv->vval.v_string = vim_strsave(buf->b_fname);
8640 else
8641 rettv->vval.v_string = NULL;
8642 --emsg_off;
8646 * "bufnr(expr)" function
8648 static void
8649 f_bufnr(argvars, rettv)
8650 typval_T *argvars;
8651 typval_T *rettv;
8653 buf_T *buf;
8654 int error = FALSE;
8655 char_u *name;
8657 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8658 ++emsg_off;
8659 buf = get_buf_tv(&argvars[0]);
8660 --emsg_off;
8662 /* If the buffer isn't found and the second argument is not zero create a
8663 * new buffer. */
8664 if (buf == NULL
8665 && argvars[1].v_type != VAR_UNKNOWN
8666 && get_tv_number_chk(&argvars[1], &error) != 0
8667 && !error
8668 && (name = get_tv_string_chk(&argvars[0])) != NULL
8669 && !error)
8670 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8672 if (buf != NULL)
8673 rettv->vval.v_number = buf->b_fnum;
8674 else
8675 rettv->vval.v_number = -1;
8679 * "bufwinnr(nr)" function
8681 static void
8682 f_bufwinnr(argvars, rettv)
8683 typval_T *argvars;
8684 typval_T *rettv;
8686 #ifdef FEAT_WINDOWS
8687 win_T *wp;
8688 int winnr = 0;
8689 #endif
8690 buf_T *buf;
8692 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8693 ++emsg_off;
8694 buf = get_buf_tv(&argvars[0]);
8695 #ifdef FEAT_WINDOWS
8696 for (wp = firstwin; wp; wp = wp->w_next)
8698 ++winnr;
8699 if (wp->w_buffer == buf)
8700 break;
8702 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8703 #else
8704 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8705 #endif
8706 --emsg_off;
8710 * "byte2line(byte)" function
8712 static void
8713 f_byte2line(argvars, rettv)
8714 typval_T *argvars UNUSED;
8715 typval_T *rettv;
8717 #ifndef FEAT_BYTEOFF
8718 rettv->vval.v_number = -1;
8719 #else
8720 long boff = 0;
8722 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8723 if (boff < 0)
8724 rettv->vval.v_number = -1;
8725 else
8726 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8727 (linenr_T)0, &boff);
8728 #endif
8732 * "byteidx()" function
8734 static void
8735 f_byteidx(argvars, rettv)
8736 typval_T *argvars;
8737 typval_T *rettv;
8739 #ifdef FEAT_MBYTE
8740 char_u *t;
8741 #endif
8742 char_u *str;
8743 long idx;
8745 str = get_tv_string_chk(&argvars[0]);
8746 idx = get_tv_number_chk(&argvars[1], NULL);
8747 rettv->vval.v_number = -1;
8748 if (str == NULL || idx < 0)
8749 return;
8751 #ifdef FEAT_MBYTE
8752 t = str;
8753 for ( ; idx > 0; idx--)
8755 if (*t == NUL) /* EOL reached */
8756 return;
8757 t += (*mb_ptr2len)(t);
8759 rettv->vval.v_number = (varnumber_T)(t - str);
8760 #else
8761 if ((size_t)idx <= STRLEN(str))
8762 rettv->vval.v_number = idx;
8763 #endif
8767 * "call(func, arglist)" function
8769 static void
8770 f_call(argvars, rettv)
8771 typval_T *argvars;
8772 typval_T *rettv;
8774 char_u *func;
8775 typval_T argv[MAX_FUNC_ARGS + 1];
8776 int argc = 0;
8777 listitem_T *item;
8778 int dummy;
8779 dict_T *selfdict = NULL;
8781 if (argvars[1].v_type != VAR_LIST)
8783 EMSG(_(e_listreq));
8784 return;
8786 if (argvars[1].vval.v_list == NULL)
8787 return;
8789 if (argvars[0].v_type == VAR_FUNC)
8790 func = argvars[0].vval.v_string;
8791 else
8792 func = get_tv_string(&argvars[0]);
8793 if (*func == NUL)
8794 return; /* type error or empty name */
8796 if (argvars[2].v_type != VAR_UNKNOWN)
8798 if (argvars[2].v_type != VAR_DICT)
8800 EMSG(_(e_dictreq));
8801 return;
8803 selfdict = argvars[2].vval.v_dict;
8806 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8807 item = item->li_next)
8809 if (argc == MAX_FUNC_ARGS)
8811 EMSG(_("E699: Too many arguments"));
8812 break;
8814 /* Make a copy of each argument. This is needed to be able to set
8815 * v_lock to VAR_FIXED in the copy without changing the original list.
8817 copy_tv(&item->li_tv, &argv[argc++]);
8820 if (item == NULL)
8821 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8822 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8823 &dummy, TRUE, selfdict);
8825 /* Free the arguments. */
8826 while (argc > 0)
8827 clear_tv(&argv[--argc]);
8830 #ifdef FEAT_FLOAT
8832 * "ceil({float})" function
8834 static void
8835 f_ceil(argvars, rettv)
8836 typval_T *argvars;
8837 typval_T *rettv;
8839 float_T f;
8841 rettv->v_type = VAR_FLOAT;
8842 if (get_float_arg(argvars, &f) == OK)
8843 rettv->vval.v_float = ceil(f);
8844 else
8845 rettv->vval.v_float = 0.0;
8847 #endif
8850 * "changenr()" function
8852 static void
8853 f_changenr(argvars, rettv)
8854 typval_T *argvars UNUSED;
8855 typval_T *rettv;
8857 rettv->vval.v_number = curbuf->b_u_seq_cur;
8861 * "char2nr(string)" function
8863 static void
8864 f_char2nr(argvars, rettv)
8865 typval_T *argvars;
8866 typval_T *rettv;
8868 #ifdef FEAT_MBYTE
8869 if (has_mbyte)
8870 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8871 else
8872 #endif
8873 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8877 * "cindent(lnum)" function
8879 static void
8880 f_cindent(argvars, rettv)
8881 typval_T *argvars;
8882 typval_T *rettv;
8884 #ifdef FEAT_CINDENT
8885 pos_T pos;
8886 linenr_T lnum;
8888 pos = curwin->w_cursor;
8889 lnum = get_tv_lnum(argvars);
8890 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8892 curwin->w_cursor.lnum = lnum;
8893 rettv->vval.v_number = get_c_indent();
8894 curwin->w_cursor = pos;
8896 else
8897 #endif
8898 rettv->vval.v_number = -1;
8902 * "clearmatches()" function
8904 static void
8905 f_clearmatches(argvars, rettv)
8906 typval_T *argvars UNUSED;
8907 typval_T *rettv UNUSED;
8909 #ifdef FEAT_SEARCH_EXTRA
8910 clear_matches(curwin);
8911 #endif
8915 * "col(string)" function
8917 static void
8918 f_col(argvars, rettv)
8919 typval_T *argvars;
8920 typval_T *rettv;
8922 colnr_T col = 0;
8923 pos_T *fp;
8924 int fnum = curbuf->b_fnum;
8926 fp = var2fpos(&argvars[0], FALSE, &fnum);
8927 if (fp != NULL && fnum == curbuf->b_fnum)
8929 if (fp->col == MAXCOL)
8931 /* '> can be MAXCOL, get the length of the line then */
8932 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8933 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8934 else
8935 col = MAXCOL;
8937 else
8939 col = fp->col + 1;
8940 #ifdef FEAT_VIRTUALEDIT
8941 /* col(".") when the cursor is on the NUL at the end of the line
8942 * because of "coladd" can be seen as an extra column. */
8943 if (virtual_active() && fp == &curwin->w_cursor)
8945 char_u *p = ml_get_cursor();
8947 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8948 curwin->w_virtcol - curwin->w_cursor.coladd))
8950 # ifdef FEAT_MBYTE
8951 int l;
8953 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8954 col += l;
8955 # else
8956 if (*p != NUL && p[1] == NUL)
8957 ++col;
8958 # endif
8961 #endif
8964 rettv->vval.v_number = col;
8967 #if defined(FEAT_INS_EXPAND)
8969 * "complete()" function
8971 static void
8972 f_complete(argvars, rettv)
8973 typval_T *argvars;
8974 typval_T *rettv UNUSED;
8976 int startcol;
8978 if ((State & INSERT) == 0)
8980 EMSG(_("E785: complete() can only be used in Insert mode"));
8981 return;
8984 /* Check for undo allowed here, because if something was already inserted
8985 * the line was already saved for undo and this check isn't done. */
8986 if (!undo_allowed())
8987 return;
8989 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8991 EMSG(_(e_invarg));
8992 return;
8995 startcol = get_tv_number_chk(&argvars[0], NULL);
8996 if (startcol <= 0)
8997 return;
8999 set_completion(startcol - 1, argvars[1].vval.v_list);
9003 * "complete_add()" function
9005 static void
9006 f_complete_add(argvars, rettv)
9007 typval_T *argvars;
9008 typval_T *rettv;
9010 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
9014 * "complete_check()" function
9016 static void
9017 f_complete_check(argvars, rettv)
9018 typval_T *argvars UNUSED;
9019 typval_T *rettv;
9021 int saved = RedrawingDisabled;
9023 RedrawingDisabled = 0;
9024 ins_compl_check_keys(0);
9025 rettv->vval.v_number = compl_interrupted;
9026 RedrawingDisabled = saved;
9028 #endif
9031 * "confirm(message, buttons[, default [, type]])" function
9033 static void
9034 f_confirm(argvars, rettv)
9035 typval_T *argvars UNUSED;
9036 typval_T *rettv UNUSED;
9038 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
9039 char_u *message;
9040 char_u *buttons = NULL;
9041 char_u buf[NUMBUFLEN];
9042 char_u buf2[NUMBUFLEN];
9043 int def = 1;
9044 int type = VIM_GENERIC;
9045 char_u *typestr;
9046 int error = FALSE;
9048 message = get_tv_string_chk(&argvars[0]);
9049 if (message == NULL)
9050 error = TRUE;
9051 if (argvars[1].v_type != VAR_UNKNOWN)
9053 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9054 if (buttons == NULL)
9055 error = TRUE;
9056 if (argvars[2].v_type != VAR_UNKNOWN)
9058 def = get_tv_number_chk(&argvars[2], &error);
9059 if (argvars[3].v_type != VAR_UNKNOWN)
9061 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9062 if (typestr == NULL)
9063 error = TRUE;
9064 else
9066 switch (TOUPPER_ASC(*typestr))
9068 case 'E': type = VIM_ERROR; break;
9069 case 'Q': type = VIM_QUESTION; break;
9070 case 'I': type = VIM_INFO; break;
9071 case 'W': type = VIM_WARNING; break;
9072 case 'G': type = VIM_GENERIC; break;
9079 if (buttons == NULL || *buttons == NUL)
9080 buttons = (char_u *)_("&Ok");
9082 if (!error)
9083 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9084 def, NULL);
9085 #endif
9089 * "copy()" function
9091 static void
9092 f_copy(argvars, rettv)
9093 typval_T *argvars;
9094 typval_T *rettv;
9096 item_copy(&argvars[0], rettv, FALSE, 0);
9099 #ifdef FEAT_FLOAT
9101 * "cos()" function
9103 static void
9104 f_cos(argvars, rettv)
9105 typval_T *argvars;
9106 typval_T *rettv;
9108 float_T f;
9110 rettv->v_type = VAR_FLOAT;
9111 if (get_float_arg(argvars, &f) == OK)
9112 rettv->vval.v_float = cos(f);
9113 else
9114 rettv->vval.v_float = 0.0;
9116 #endif
9119 * "count()" function
9121 static void
9122 f_count(argvars, rettv)
9123 typval_T *argvars;
9124 typval_T *rettv;
9126 long n = 0;
9127 int ic = FALSE;
9129 if (argvars[0].v_type == VAR_LIST)
9131 listitem_T *li;
9132 list_T *l;
9133 long idx;
9135 if ((l = argvars[0].vval.v_list) != NULL)
9137 li = l->lv_first;
9138 if (argvars[2].v_type != VAR_UNKNOWN)
9140 int error = FALSE;
9142 ic = get_tv_number_chk(&argvars[2], &error);
9143 if (argvars[3].v_type != VAR_UNKNOWN)
9145 idx = get_tv_number_chk(&argvars[3], &error);
9146 if (!error)
9148 li = list_find(l, idx);
9149 if (li == NULL)
9150 EMSGN(_(e_listidx), idx);
9153 if (error)
9154 li = NULL;
9157 for ( ; li != NULL; li = li->li_next)
9158 if (tv_equal(&li->li_tv, &argvars[1], ic))
9159 ++n;
9162 else if (argvars[0].v_type == VAR_DICT)
9164 int todo;
9165 dict_T *d;
9166 hashitem_T *hi;
9168 if ((d = argvars[0].vval.v_dict) != NULL)
9170 int error = FALSE;
9172 if (argvars[2].v_type != VAR_UNKNOWN)
9174 ic = get_tv_number_chk(&argvars[2], &error);
9175 if (argvars[3].v_type != VAR_UNKNOWN)
9176 EMSG(_(e_invarg));
9179 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9180 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9182 if (!HASHITEM_EMPTY(hi))
9184 --todo;
9185 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9186 ++n;
9191 else
9192 EMSG2(_(e_listdictarg), "count()");
9193 rettv->vval.v_number = n;
9197 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9199 * Checks the existence of a cscope connection.
9201 static void
9202 f_cscope_connection(argvars, rettv)
9203 typval_T *argvars UNUSED;
9204 typval_T *rettv UNUSED;
9206 #ifdef FEAT_CSCOPE
9207 int num = 0;
9208 char_u *dbpath = NULL;
9209 char_u *prepend = NULL;
9210 char_u buf[NUMBUFLEN];
9212 if (argvars[0].v_type != VAR_UNKNOWN
9213 && argvars[1].v_type != VAR_UNKNOWN)
9215 num = (int)get_tv_number(&argvars[0]);
9216 dbpath = get_tv_string(&argvars[1]);
9217 if (argvars[2].v_type != VAR_UNKNOWN)
9218 prepend = get_tv_string_buf(&argvars[2], buf);
9221 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9222 #endif
9226 * "cursor(lnum, col)" function
9228 * Moves the cursor to the specified line and column.
9229 * Returns 0 when the position could be set, -1 otherwise.
9231 static void
9232 f_cursor(argvars, rettv)
9233 typval_T *argvars;
9234 typval_T *rettv;
9236 long line, col;
9237 #ifdef FEAT_VIRTUALEDIT
9238 long coladd = 0;
9239 #endif
9241 rettv->vval.v_number = -1;
9242 if (argvars[1].v_type == VAR_UNKNOWN)
9244 pos_T pos;
9246 if (list2fpos(argvars, &pos, NULL) == FAIL)
9247 return;
9248 line = pos.lnum;
9249 col = pos.col;
9250 #ifdef FEAT_VIRTUALEDIT
9251 coladd = pos.coladd;
9252 #endif
9254 else
9256 line = get_tv_lnum(argvars);
9257 col = get_tv_number_chk(&argvars[1], NULL);
9258 #ifdef FEAT_VIRTUALEDIT
9259 if (argvars[2].v_type != VAR_UNKNOWN)
9260 coladd = get_tv_number_chk(&argvars[2], NULL);
9261 #endif
9263 if (line < 0 || col < 0
9264 #ifdef FEAT_VIRTUALEDIT
9265 || coladd < 0
9266 #endif
9268 return; /* type error; errmsg already given */
9269 if (line > 0)
9270 curwin->w_cursor.lnum = line;
9271 if (col > 0)
9272 curwin->w_cursor.col = col - 1;
9273 #ifdef FEAT_VIRTUALEDIT
9274 curwin->w_cursor.coladd = coladd;
9275 #endif
9277 /* Make sure the cursor is in a valid position. */
9278 check_cursor();
9279 #ifdef FEAT_MBYTE
9280 /* Correct cursor for multi-byte character. */
9281 if (has_mbyte)
9282 mb_adjust_cursor();
9283 #endif
9285 curwin->w_set_curswant = TRUE;
9286 rettv->vval.v_number = 0;
9290 * "deepcopy()" function
9292 static void
9293 f_deepcopy(argvars, rettv)
9294 typval_T *argvars;
9295 typval_T *rettv;
9297 int noref = 0;
9299 if (argvars[1].v_type != VAR_UNKNOWN)
9300 noref = get_tv_number_chk(&argvars[1], NULL);
9301 if (noref < 0 || noref > 1)
9302 EMSG(_(e_invarg));
9303 else
9305 current_copyID += COPYID_INC;
9306 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? current_copyID : 0);
9311 * "delete()" function
9313 static void
9314 f_delete(argvars, rettv)
9315 typval_T *argvars;
9316 typval_T *rettv;
9318 if (check_restricted() || check_secure())
9319 rettv->vval.v_number = -1;
9320 else
9321 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9325 * "did_filetype()" function
9327 static void
9328 f_did_filetype(argvars, rettv)
9329 typval_T *argvars UNUSED;
9330 typval_T *rettv UNUSED;
9332 #ifdef FEAT_AUTOCMD
9333 rettv->vval.v_number = did_filetype;
9334 #endif
9338 * "diff_filler()" function
9340 static void
9341 f_diff_filler(argvars, rettv)
9342 typval_T *argvars UNUSED;
9343 typval_T *rettv UNUSED;
9345 #ifdef FEAT_DIFF
9346 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9347 #endif
9351 * "diff_hlID()" function
9353 static void
9354 f_diff_hlID(argvars, rettv)
9355 typval_T *argvars UNUSED;
9356 typval_T *rettv UNUSED;
9358 #ifdef FEAT_DIFF
9359 linenr_T lnum = get_tv_lnum(argvars);
9360 static linenr_T prev_lnum = 0;
9361 static int changedtick = 0;
9362 static int fnum = 0;
9363 static int change_start = 0;
9364 static int change_end = 0;
9365 static hlf_T hlID = (hlf_T)0;
9366 int filler_lines;
9367 int col;
9369 if (lnum < 0) /* ignore type error in {lnum} arg */
9370 lnum = 0;
9371 if (lnum != prev_lnum
9372 || changedtick != curbuf->b_changedtick
9373 || fnum != curbuf->b_fnum)
9375 /* New line, buffer, change: need to get the values. */
9376 filler_lines = diff_check(curwin, lnum);
9377 if (filler_lines < 0)
9379 if (filler_lines == -1)
9381 change_start = MAXCOL;
9382 change_end = -1;
9383 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9384 hlID = HLF_ADD; /* added line */
9385 else
9386 hlID = HLF_CHD; /* changed line */
9388 else
9389 hlID = HLF_ADD; /* added line */
9391 else
9392 hlID = (hlf_T)0;
9393 prev_lnum = lnum;
9394 changedtick = curbuf->b_changedtick;
9395 fnum = curbuf->b_fnum;
9398 if (hlID == HLF_CHD || hlID == HLF_TXD)
9400 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9401 if (col >= change_start && col <= change_end)
9402 hlID = HLF_TXD; /* changed text */
9403 else
9404 hlID = HLF_CHD; /* changed line */
9406 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9407 #endif
9411 * "empty({expr})" function
9413 static void
9414 f_empty(argvars, rettv)
9415 typval_T *argvars;
9416 typval_T *rettv;
9418 int n;
9420 switch (argvars[0].v_type)
9422 case VAR_STRING:
9423 case VAR_FUNC:
9424 n = argvars[0].vval.v_string == NULL
9425 || *argvars[0].vval.v_string == NUL;
9426 break;
9427 case VAR_NUMBER:
9428 n = argvars[0].vval.v_number == 0;
9429 break;
9430 #ifdef FEAT_FLOAT
9431 case VAR_FLOAT:
9432 n = argvars[0].vval.v_float == 0.0;
9433 break;
9434 #endif
9435 case VAR_LIST:
9436 n = argvars[0].vval.v_list == NULL
9437 || argvars[0].vval.v_list->lv_first == NULL;
9438 break;
9439 case VAR_DICT:
9440 n = argvars[0].vval.v_dict == NULL
9441 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9442 break;
9443 default:
9444 EMSG2(_(e_intern2), "f_empty()");
9445 n = 0;
9448 rettv->vval.v_number = n;
9452 * "escape({string}, {chars})" function
9454 static void
9455 f_escape(argvars, rettv)
9456 typval_T *argvars;
9457 typval_T *rettv;
9459 char_u buf[NUMBUFLEN];
9461 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9462 get_tv_string_buf(&argvars[1], buf));
9463 rettv->v_type = VAR_STRING;
9467 * "eval()" function
9469 static void
9470 f_eval(argvars, rettv)
9471 typval_T *argvars;
9472 typval_T *rettv;
9474 char_u *s;
9476 s = get_tv_string_chk(&argvars[0]);
9477 if (s != NULL)
9478 s = skipwhite(s);
9480 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9482 rettv->v_type = VAR_NUMBER;
9483 rettv->vval.v_number = 0;
9485 else if (*s != NUL)
9486 EMSG(_(e_trailing));
9490 * "eventhandler()" function
9492 static void
9493 f_eventhandler(argvars, rettv)
9494 typval_T *argvars UNUSED;
9495 typval_T *rettv;
9497 rettv->vval.v_number = vgetc_busy;
9501 * "executable()" function
9503 static void
9504 f_executable(argvars, rettv)
9505 typval_T *argvars;
9506 typval_T *rettv;
9508 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9512 * "exists()" function
9514 static void
9515 f_exists(argvars, rettv)
9516 typval_T *argvars;
9517 typval_T *rettv;
9519 char_u *p;
9520 char_u *name;
9521 int n = FALSE;
9522 int len = 0;
9524 p = get_tv_string(&argvars[0]);
9525 if (*p == '$') /* environment variable */
9527 /* first try "normal" environment variables (fast) */
9528 if (mch_getenv(p + 1) != NULL)
9529 n = TRUE;
9530 else
9532 /* try expanding things like $VIM and ${HOME} */
9533 p = expand_env_save(p);
9534 if (p != NULL && *p != '$')
9535 n = TRUE;
9536 vim_free(p);
9539 else if (*p == '&' || *p == '+') /* option */
9541 n = (get_option_tv(&p, NULL, TRUE) == OK);
9542 if (*skipwhite(p) != NUL)
9543 n = FALSE; /* trailing garbage */
9545 else if (*p == '*') /* internal or user defined function */
9547 n = function_exists(p + 1);
9549 else if (*p == ':')
9551 n = cmd_exists(p + 1);
9553 else if (*p == '#')
9555 #ifdef FEAT_AUTOCMD
9556 if (p[1] == '#')
9557 n = autocmd_supported(p + 2);
9558 else
9559 n = au_exists(p + 1);
9560 #endif
9562 else /* internal variable */
9564 char_u *tofree;
9565 typval_T tv;
9567 /* get_name_len() takes care of expanding curly braces */
9568 name = p;
9569 len = get_name_len(&p, &tofree, TRUE, FALSE);
9570 if (len > 0)
9572 if (tofree != NULL)
9573 name = tofree;
9574 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9575 if (n)
9577 /* handle d.key, l[idx], f(expr) */
9578 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9579 if (n)
9580 clear_tv(&tv);
9583 if (*p != NUL)
9584 n = FALSE;
9586 vim_free(tofree);
9589 rettv->vval.v_number = n;
9593 * "expand()" function
9595 static void
9596 f_expand(argvars, rettv)
9597 typval_T *argvars;
9598 typval_T *rettv;
9600 char_u *s;
9601 int len;
9602 char_u *errormsg;
9603 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9604 expand_T xpc;
9605 int error = FALSE;
9607 rettv->v_type = VAR_STRING;
9608 s = get_tv_string(&argvars[0]);
9609 if (*s == '%' || *s == '#' || *s == '<')
9611 ++emsg_off;
9612 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9613 --emsg_off;
9615 else
9617 /* When the optional second argument is non-zero, don't remove matches
9618 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9619 if (argvars[1].v_type != VAR_UNKNOWN
9620 && get_tv_number_chk(&argvars[1], &error))
9621 flags |= WILD_KEEP_ALL;
9622 if (!error)
9624 ExpandInit(&xpc);
9625 xpc.xp_context = EXPAND_FILES;
9626 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9628 else
9629 rettv->vval.v_string = NULL;
9634 * "extend(list, list [, idx])" function
9635 * "extend(dict, dict [, action])" function
9637 static void
9638 f_extend(argvars, rettv)
9639 typval_T *argvars;
9640 typval_T *rettv;
9642 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9644 list_T *l1, *l2;
9645 listitem_T *item;
9646 long before;
9647 int error = FALSE;
9649 l1 = argvars[0].vval.v_list;
9650 l2 = argvars[1].vval.v_list;
9651 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9652 && l2 != NULL)
9654 if (argvars[2].v_type != VAR_UNKNOWN)
9656 before = get_tv_number_chk(&argvars[2], &error);
9657 if (error)
9658 return; /* type error; errmsg already given */
9660 if (before == l1->lv_len)
9661 item = NULL;
9662 else
9664 item = list_find(l1, before);
9665 if (item == NULL)
9667 EMSGN(_(e_listidx), before);
9668 return;
9672 else
9673 item = NULL;
9674 list_extend(l1, l2, item);
9676 copy_tv(&argvars[0], rettv);
9679 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9681 dict_T *d1, *d2;
9682 dictitem_T *di1;
9683 char_u *action;
9684 int i;
9685 hashitem_T *hi2;
9686 int todo;
9688 d1 = argvars[0].vval.v_dict;
9689 d2 = argvars[1].vval.v_dict;
9690 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9691 && d2 != NULL)
9693 /* Check the third argument. */
9694 if (argvars[2].v_type != VAR_UNKNOWN)
9696 static char *(av[]) = {"keep", "force", "error"};
9698 action = get_tv_string_chk(&argvars[2]);
9699 if (action == NULL)
9700 return; /* type error; errmsg already given */
9701 for (i = 0; i < 3; ++i)
9702 if (STRCMP(action, av[i]) == 0)
9703 break;
9704 if (i == 3)
9706 EMSG2(_(e_invarg2), action);
9707 return;
9710 else
9711 action = (char_u *)"force";
9713 /* Go over all entries in the second dict and add them to the
9714 * first dict. */
9715 todo = (int)d2->dv_hashtab.ht_used;
9716 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9718 if (!HASHITEM_EMPTY(hi2))
9720 --todo;
9721 di1 = dict_find(d1, hi2->hi_key, -1);
9722 if (di1 == NULL)
9724 di1 = dictitem_copy(HI2DI(hi2));
9725 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9726 dictitem_free(di1);
9728 else if (*action == 'e')
9730 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9731 break;
9733 else if (*action == 'f')
9735 clear_tv(&di1->di_tv);
9736 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9741 copy_tv(&argvars[0], rettv);
9744 else
9745 EMSG2(_(e_listdictarg), "extend()");
9749 * "feedkeys()" function
9751 static void
9752 f_feedkeys(argvars, rettv)
9753 typval_T *argvars;
9754 typval_T *rettv UNUSED;
9756 int remap = TRUE;
9757 char_u *keys, *flags;
9758 char_u nbuf[NUMBUFLEN];
9759 int typed = FALSE;
9760 char_u *keys_esc;
9762 /* This is not allowed in the sandbox. If the commands would still be
9763 * executed in the sandbox it would be OK, but it probably happens later,
9764 * when "sandbox" is no longer set. */
9765 if (check_secure())
9766 return;
9768 keys = get_tv_string(&argvars[0]);
9769 if (*keys != NUL)
9771 if (argvars[1].v_type != VAR_UNKNOWN)
9773 flags = get_tv_string_buf(&argvars[1], nbuf);
9774 for ( ; *flags != NUL; ++flags)
9776 switch (*flags)
9778 case 'n': remap = FALSE; break;
9779 case 'm': remap = TRUE; break;
9780 case 't': typed = TRUE; break;
9785 /* Need to escape K_SPECIAL and CSI before putting the string in the
9786 * typeahead buffer. */
9787 keys_esc = vim_strsave_escape_csi(keys);
9788 if (keys_esc != NULL)
9790 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9791 typebuf.tb_len, !typed, FALSE);
9792 vim_free(keys_esc);
9793 if (vgetc_busy)
9794 typebuf_was_filled = TRUE;
9800 * "filereadable()" function
9802 static void
9803 f_filereadable(argvars, rettv)
9804 typval_T *argvars;
9805 typval_T *rettv;
9807 int fd;
9808 char_u *p;
9809 int n;
9811 #ifndef O_NONBLOCK
9812 # define O_NONBLOCK 0
9813 #endif
9814 p = get_tv_string(&argvars[0]);
9815 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9816 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9818 n = TRUE;
9819 close(fd);
9821 else
9822 n = FALSE;
9824 rettv->vval.v_number = n;
9828 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9829 * rights to write into.
9831 static void
9832 f_filewritable(argvars, rettv)
9833 typval_T *argvars;
9834 typval_T *rettv;
9836 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9839 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9841 static void
9842 findfilendir(argvars, rettv, find_what)
9843 typval_T *argvars;
9844 typval_T *rettv;
9845 int find_what;
9847 #ifdef FEAT_SEARCHPATH
9848 char_u *fname;
9849 char_u *fresult = NULL;
9850 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9851 char_u *p;
9852 char_u pathbuf[NUMBUFLEN];
9853 int count = 1;
9854 int first = TRUE;
9855 int error = FALSE;
9856 #endif
9858 rettv->vval.v_string = NULL;
9859 rettv->v_type = VAR_STRING;
9861 #ifdef FEAT_SEARCHPATH
9862 fname = get_tv_string(&argvars[0]);
9864 if (argvars[1].v_type != VAR_UNKNOWN)
9866 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9867 if (p == NULL)
9868 error = TRUE;
9869 else
9871 if (*p != NUL)
9872 path = p;
9874 if (argvars[2].v_type != VAR_UNKNOWN)
9875 count = get_tv_number_chk(&argvars[2], &error);
9879 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9880 error = TRUE;
9882 if (*fname != NUL && !error)
9886 if (rettv->v_type == VAR_STRING)
9887 vim_free(fresult);
9888 fresult = find_file_in_path_option(first ? fname : NULL,
9889 first ? (int)STRLEN(fname) : 0,
9890 0, first, path,
9891 find_what,
9892 curbuf->b_ffname,
9893 find_what == FINDFILE_DIR
9894 ? (char_u *)"" : curbuf->b_p_sua);
9895 first = FALSE;
9897 if (fresult != NULL && rettv->v_type == VAR_LIST)
9898 list_append_string(rettv->vval.v_list, fresult, -1);
9900 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9903 if (rettv->v_type == VAR_STRING)
9904 rettv->vval.v_string = fresult;
9905 #endif
9908 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9909 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9912 * Implementation of map() and filter().
9914 static void
9915 filter_map(argvars, rettv, map)
9916 typval_T *argvars;
9917 typval_T *rettv;
9918 int map;
9920 char_u buf[NUMBUFLEN];
9921 char_u *expr;
9922 listitem_T *li, *nli;
9923 list_T *l = NULL;
9924 dictitem_T *di;
9925 hashtab_T *ht;
9926 hashitem_T *hi;
9927 dict_T *d = NULL;
9928 typval_T save_val;
9929 typval_T save_key;
9930 int rem;
9931 int todo;
9932 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9933 int save_did_emsg;
9934 int index = 0;
9936 if (argvars[0].v_type == VAR_LIST)
9938 if ((l = argvars[0].vval.v_list) == NULL
9939 || (map && tv_check_lock(l->lv_lock, ermsg)))
9940 return;
9942 else if (argvars[0].v_type == VAR_DICT)
9944 if ((d = argvars[0].vval.v_dict) == NULL
9945 || (map && tv_check_lock(d->dv_lock, ermsg)))
9946 return;
9948 else
9950 EMSG2(_(e_listdictarg), ermsg);
9951 return;
9954 expr = get_tv_string_buf_chk(&argvars[1], buf);
9955 /* On type errors, the preceding call has already displayed an error
9956 * message. Avoid a misleading error message for an empty string that
9957 * was not passed as argument. */
9958 if (expr != NULL)
9960 prepare_vimvar(VV_VAL, &save_val);
9961 expr = skipwhite(expr);
9963 /* We reset "did_emsg" to be able to detect whether an error
9964 * occurred during evaluation of the expression. */
9965 save_did_emsg = did_emsg;
9966 did_emsg = FALSE;
9968 prepare_vimvar(VV_KEY, &save_key);
9969 if (argvars[0].v_type == VAR_DICT)
9971 vimvars[VV_KEY].vv_type = VAR_STRING;
9973 ht = &d->dv_hashtab;
9974 hash_lock(ht);
9975 todo = (int)ht->ht_used;
9976 for (hi = ht->ht_array; todo > 0; ++hi)
9978 if (!HASHITEM_EMPTY(hi))
9980 --todo;
9981 di = HI2DI(hi);
9982 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9983 break;
9984 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9985 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9986 || did_emsg)
9987 break;
9988 if (!map && rem)
9989 dictitem_remove(d, di);
9990 clear_tv(&vimvars[VV_KEY].vv_tv);
9993 hash_unlock(ht);
9995 else
9997 vimvars[VV_KEY].vv_type = VAR_NUMBER;
9999 for (li = l->lv_first; li != NULL; li = nli)
10001 if (tv_check_lock(li->li_tv.v_lock, ermsg))
10002 break;
10003 nli = li->li_next;
10004 vimvars[VV_KEY].vv_nr = index;
10005 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
10006 || did_emsg)
10007 break;
10008 if (!map && rem)
10009 listitem_remove(l, li);
10010 ++index;
10014 restore_vimvar(VV_KEY, &save_key);
10015 restore_vimvar(VV_VAL, &save_val);
10017 did_emsg |= save_did_emsg;
10020 copy_tv(&argvars[0], rettv);
10023 static int
10024 filter_map_one(tv, expr, map, remp)
10025 typval_T *tv;
10026 char_u *expr;
10027 int map;
10028 int *remp;
10030 typval_T rettv;
10031 char_u *s;
10032 int retval = FAIL;
10034 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10035 s = expr;
10036 if (eval1(&s, &rettv, TRUE) == FAIL)
10037 goto theend;
10038 if (*s != NUL) /* check for trailing chars after expr */
10040 EMSG2(_(e_invexpr2), s);
10041 goto theend;
10043 if (map)
10045 /* map(): replace the list item value */
10046 clear_tv(tv);
10047 rettv.v_lock = 0;
10048 *tv = rettv;
10050 else
10052 int error = FALSE;
10054 /* filter(): when expr is zero remove the item */
10055 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10056 clear_tv(&rettv);
10057 /* On type error, nothing has been removed; return FAIL to stop the
10058 * loop. The error message was given by get_tv_number_chk(). */
10059 if (error)
10060 goto theend;
10062 retval = OK;
10063 theend:
10064 clear_tv(&vimvars[VV_VAL].vv_tv);
10065 return retval;
10069 * "filter()" function
10071 static void
10072 f_filter(argvars, rettv)
10073 typval_T *argvars;
10074 typval_T *rettv;
10076 filter_map(argvars, rettv, FALSE);
10080 * "finddir({fname}[, {path}[, {count}]])" function
10082 static void
10083 f_finddir(argvars, rettv)
10084 typval_T *argvars;
10085 typval_T *rettv;
10087 findfilendir(argvars, rettv, FINDFILE_DIR);
10091 * "findfile({fname}[, {path}[, {count}]])" function
10093 static void
10094 f_findfile(argvars, rettv)
10095 typval_T *argvars;
10096 typval_T *rettv;
10098 findfilendir(argvars, rettv, FINDFILE_FILE);
10101 #ifdef FEAT_FLOAT
10103 * "float2nr({float})" function
10105 static void
10106 f_float2nr(argvars, rettv)
10107 typval_T *argvars;
10108 typval_T *rettv;
10110 float_T f;
10112 if (get_float_arg(argvars, &f) == OK)
10114 if (f < -0x7fffffff)
10115 rettv->vval.v_number = -0x7fffffff;
10116 else if (f > 0x7fffffff)
10117 rettv->vval.v_number = 0x7fffffff;
10118 else
10119 rettv->vval.v_number = (varnumber_T)f;
10124 * "floor({float})" function
10126 static void
10127 f_floor(argvars, rettv)
10128 typval_T *argvars;
10129 typval_T *rettv;
10131 float_T f;
10133 rettv->v_type = VAR_FLOAT;
10134 if (get_float_arg(argvars, &f) == OK)
10135 rettv->vval.v_float = floor(f);
10136 else
10137 rettv->vval.v_float = 0.0;
10139 #endif
10142 * "fnameescape({string})" function
10144 static void
10145 f_fnameescape(argvars, rettv)
10146 typval_T *argvars;
10147 typval_T *rettv;
10149 rettv->vval.v_string = vim_strsave_fnameescape(
10150 get_tv_string(&argvars[0]), FALSE);
10151 rettv->v_type = VAR_STRING;
10155 * "fnamemodify({fname}, {mods})" function
10157 static void
10158 f_fnamemodify(argvars, rettv)
10159 typval_T *argvars;
10160 typval_T *rettv;
10162 char_u *fname;
10163 char_u *mods;
10164 int usedlen = 0;
10165 int len;
10166 char_u *fbuf = NULL;
10167 char_u buf[NUMBUFLEN];
10169 fname = get_tv_string_chk(&argvars[0]);
10170 mods = get_tv_string_buf_chk(&argvars[1], buf);
10171 if (fname == NULL || mods == NULL)
10172 fname = NULL;
10173 else
10175 len = (int)STRLEN(fname);
10176 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10179 rettv->v_type = VAR_STRING;
10180 if (fname == NULL)
10181 rettv->vval.v_string = NULL;
10182 else
10183 rettv->vval.v_string = vim_strnsave(fname, len);
10184 vim_free(fbuf);
10187 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10190 * "foldclosed()" function
10192 static void
10193 foldclosed_both(argvars, rettv, end)
10194 typval_T *argvars;
10195 typval_T *rettv;
10196 int end;
10198 #ifdef FEAT_FOLDING
10199 linenr_T lnum;
10200 linenr_T first, last;
10202 lnum = get_tv_lnum(argvars);
10203 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10205 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10207 if (end)
10208 rettv->vval.v_number = (varnumber_T)last;
10209 else
10210 rettv->vval.v_number = (varnumber_T)first;
10211 return;
10214 #endif
10215 rettv->vval.v_number = -1;
10219 * "foldclosed()" function
10221 static void
10222 f_foldclosed(argvars, rettv)
10223 typval_T *argvars;
10224 typval_T *rettv;
10226 foldclosed_both(argvars, rettv, FALSE);
10230 * "foldclosedend()" function
10232 static void
10233 f_foldclosedend(argvars, rettv)
10234 typval_T *argvars;
10235 typval_T *rettv;
10237 foldclosed_both(argvars, rettv, TRUE);
10241 * "foldlevel()" function
10243 static void
10244 f_foldlevel(argvars, rettv)
10245 typval_T *argvars;
10246 typval_T *rettv;
10248 #ifdef FEAT_FOLDING
10249 linenr_T lnum;
10251 lnum = get_tv_lnum(argvars);
10252 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10253 rettv->vval.v_number = foldLevel(lnum);
10254 #endif
10258 * "foldtext()" function
10260 static void
10261 f_foldtext(argvars, rettv)
10262 typval_T *argvars UNUSED;
10263 typval_T *rettv;
10265 #ifdef FEAT_FOLDING
10266 linenr_T lnum;
10267 char_u *s;
10268 char_u *r;
10269 int len;
10270 char *txt;
10271 #endif
10273 rettv->v_type = VAR_STRING;
10274 rettv->vval.v_string = NULL;
10275 #ifdef FEAT_FOLDING
10276 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10277 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10278 <= curbuf->b_ml.ml_line_count
10279 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10281 /* Find first non-empty line in the fold. */
10282 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10283 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10285 if (!linewhite(lnum))
10286 break;
10287 ++lnum;
10290 /* Find interesting text in this line. */
10291 s = skipwhite(ml_get(lnum));
10292 /* skip C comment-start */
10293 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10295 s = skipwhite(s + 2);
10296 if (*skipwhite(s) == NUL
10297 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10299 s = skipwhite(ml_get(lnum + 1));
10300 if (*s == '*')
10301 s = skipwhite(s + 1);
10304 txt = _("+-%s%3ld lines: ");
10305 r = alloc((unsigned)(STRLEN(txt)
10306 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10307 + 20 /* for %3ld */
10308 + STRLEN(s))); /* concatenated */
10309 if (r != NULL)
10311 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10312 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10313 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10314 len = (int)STRLEN(r);
10315 STRCAT(r, s);
10316 /* remove 'foldmarker' and 'commentstring' */
10317 foldtext_cleanup(r + len);
10318 rettv->vval.v_string = r;
10321 #endif
10325 * "foldtextresult(lnum)" function
10327 static void
10328 f_foldtextresult(argvars, rettv)
10329 typval_T *argvars UNUSED;
10330 typval_T *rettv;
10332 #ifdef FEAT_FOLDING
10333 linenr_T lnum;
10334 char_u *text;
10335 char_u buf[51];
10336 foldinfo_T foldinfo;
10337 int fold_count;
10338 #endif
10340 rettv->v_type = VAR_STRING;
10341 rettv->vval.v_string = NULL;
10342 #ifdef FEAT_FOLDING
10343 lnum = get_tv_lnum(argvars);
10344 /* treat illegal types and illegal string values for {lnum} the same */
10345 if (lnum < 0)
10346 lnum = 0;
10347 fold_count = foldedCount(curwin, lnum, &foldinfo);
10348 if (fold_count > 0)
10350 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10351 &foldinfo, buf);
10352 if (text == buf)
10353 text = vim_strsave(text);
10354 rettv->vval.v_string = text;
10356 #endif
10360 * "foreground()" function
10362 static void
10363 f_foreground(argvars, rettv)
10364 typval_T *argvars UNUSED;
10365 typval_T *rettv UNUSED;
10367 #ifdef FEAT_GUI
10368 if (gui.in_use)
10369 gui_mch_set_foreground();
10370 #else
10371 # ifdef WIN32
10372 win32_set_foreground();
10373 # endif
10374 #endif
10378 * "function()" function
10380 static void
10381 f_function(argvars, rettv)
10382 typval_T *argvars;
10383 typval_T *rettv;
10385 char_u *s;
10387 s = get_tv_string(&argvars[0]);
10388 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10389 EMSG2(_(e_invarg2), s);
10390 /* Don't check an autoload name for existence here. */
10391 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10392 EMSG2(_("E700: Unknown function: %s"), s);
10393 else
10395 rettv->vval.v_string = vim_strsave(s);
10396 rettv->v_type = VAR_FUNC;
10401 * "garbagecollect()" function
10403 static void
10404 f_garbagecollect(argvars, rettv)
10405 typval_T *argvars;
10406 typval_T *rettv UNUSED;
10408 /* This is postponed until we are back at the toplevel, because we may be
10409 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10410 want_garbage_collect = TRUE;
10412 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10413 garbage_collect_at_exit = TRUE;
10417 * "get()" function
10419 static void
10420 f_get(argvars, rettv)
10421 typval_T *argvars;
10422 typval_T *rettv;
10424 listitem_T *li;
10425 list_T *l;
10426 dictitem_T *di;
10427 dict_T *d;
10428 typval_T *tv = NULL;
10430 if (argvars[0].v_type == VAR_LIST)
10432 if ((l = argvars[0].vval.v_list) != NULL)
10434 int error = FALSE;
10436 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10437 if (!error && li != NULL)
10438 tv = &li->li_tv;
10441 else if (argvars[0].v_type == VAR_DICT)
10443 if ((d = argvars[0].vval.v_dict) != NULL)
10445 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10446 if (di != NULL)
10447 tv = &di->di_tv;
10450 else
10451 EMSG2(_(e_listdictarg), "get()");
10453 if (tv == NULL)
10455 if (argvars[2].v_type != VAR_UNKNOWN)
10456 copy_tv(&argvars[2], rettv);
10458 else
10459 copy_tv(tv, rettv);
10462 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10465 * Get line or list of lines from buffer "buf" into "rettv".
10466 * Return a range (from start to end) of lines in rettv from the specified
10467 * buffer.
10468 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10470 static void
10471 get_buffer_lines(buf, start, end, retlist, rettv)
10472 buf_T *buf;
10473 linenr_T start;
10474 linenr_T end;
10475 int retlist;
10476 typval_T *rettv;
10478 char_u *p;
10480 if (retlist && rettv_list_alloc(rettv) == FAIL)
10481 return;
10483 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10484 return;
10486 if (!retlist)
10488 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10489 p = ml_get_buf(buf, start, FALSE);
10490 else
10491 p = (char_u *)"";
10493 rettv->v_type = VAR_STRING;
10494 rettv->vval.v_string = vim_strsave(p);
10496 else
10498 if (end < start)
10499 return;
10501 if (start < 1)
10502 start = 1;
10503 if (end > buf->b_ml.ml_line_count)
10504 end = buf->b_ml.ml_line_count;
10505 while (start <= end)
10506 if (list_append_string(rettv->vval.v_list,
10507 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10508 break;
10513 * "getbufline()" function
10515 static void
10516 f_getbufline(argvars, rettv)
10517 typval_T *argvars;
10518 typval_T *rettv;
10520 linenr_T lnum;
10521 linenr_T end;
10522 buf_T *buf;
10524 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10525 ++emsg_off;
10526 buf = get_buf_tv(&argvars[0]);
10527 --emsg_off;
10529 lnum = get_tv_lnum_buf(&argvars[1], buf);
10530 if (argvars[2].v_type == VAR_UNKNOWN)
10531 end = lnum;
10532 else
10533 end = get_tv_lnum_buf(&argvars[2], buf);
10535 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10539 * "getbufvar()" function
10541 static void
10542 f_getbufvar(argvars, rettv)
10543 typval_T *argvars;
10544 typval_T *rettv;
10546 buf_T *buf;
10547 buf_T *save_curbuf;
10548 char_u *varname;
10549 dictitem_T *v;
10551 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10552 varname = get_tv_string_chk(&argvars[1]);
10553 ++emsg_off;
10554 buf = get_buf_tv(&argvars[0]);
10556 rettv->v_type = VAR_STRING;
10557 rettv->vval.v_string = NULL;
10559 if (buf != NULL && varname != NULL)
10561 /* set curbuf to be our buf, temporarily */
10562 save_curbuf = curbuf;
10563 curbuf = buf;
10565 if (*varname == '&') /* buffer-local-option */
10566 get_option_tv(&varname, rettv, TRUE);
10567 else
10569 if (*varname == NUL)
10570 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10571 * scope prefix before the NUL byte is required by
10572 * find_var_in_ht(). */
10573 varname = (char_u *)"b:" + 2;
10574 /* look up the variable */
10575 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10576 if (v != NULL)
10577 copy_tv(&v->di_tv, rettv);
10580 /* restore previous notion of curbuf */
10581 curbuf = save_curbuf;
10584 --emsg_off;
10588 * "getchar()" function
10590 static void
10591 f_getchar(argvars, rettv)
10592 typval_T *argvars;
10593 typval_T *rettv;
10595 varnumber_T n;
10596 int error = FALSE;
10598 /* Position the cursor. Needed after a message that ends in a space. */
10599 windgoto(msg_row, msg_col);
10601 ++no_mapping;
10602 ++allow_keys;
10603 for (;;)
10605 if (argvars[0].v_type == VAR_UNKNOWN)
10606 /* getchar(): blocking wait. */
10607 n = safe_vgetc();
10608 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10609 /* getchar(1): only check if char avail */
10610 n = vpeekc();
10611 else if (error || vpeekc() == NUL)
10612 /* illegal argument or getchar(0) and no char avail: return zero */
10613 n = 0;
10614 else
10615 /* getchar(0) and char avail: return char */
10616 n = safe_vgetc();
10617 if (n == K_IGNORE)
10618 continue;
10619 break;
10621 --no_mapping;
10622 --allow_keys;
10624 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10625 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10626 vimvars[VV_MOUSE_COL].vv_nr = 0;
10628 rettv->vval.v_number = n;
10629 if (IS_SPECIAL(n) || mod_mask != 0)
10631 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10632 int i = 0;
10634 /* Turn a special key into three bytes, plus modifier. */
10635 if (mod_mask != 0)
10637 temp[i++] = K_SPECIAL;
10638 temp[i++] = KS_MODIFIER;
10639 temp[i++] = mod_mask;
10641 if (IS_SPECIAL(n))
10643 temp[i++] = K_SPECIAL;
10644 temp[i++] = K_SECOND(n);
10645 temp[i++] = K_THIRD(n);
10647 #ifdef FEAT_MBYTE
10648 else if (has_mbyte)
10649 i += (*mb_char2bytes)(n, temp + i);
10650 #endif
10651 else
10652 temp[i++] = n;
10653 temp[i++] = NUL;
10654 rettv->v_type = VAR_STRING;
10655 rettv->vval.v_string = vim_strsave(temp);
10657 #ifdef FEAT_MOUSE
10658 if (n == K_LEFTMOUSE
10659 || n == K_LEFTMOUSE_NM
10660 || n == K_LEFTDRAG
10661 || n == K_LEFTRELEASE
10662 || n == K_LEFTRELEASE_NM
10663 || n == K_MIDDLEMOUSE
10664 || n == K_MIDDLEDRAG
10665 || n == K_MIDDLERELEASE
10666 || n == K_RIGHTMOUSE
10667 || n == K_RIGHTDRAG
10668 || n == K_RIGHTRELEASE
10669 || n == K_X1MOUSE
10670 || n == K_X1DRAG
10671 || n == K_X1RELEASE
10672 || n == K_X2MOUSE
10673 || n == K_X2DRAG
10674 || n == K_X2RELEASE
10675 || n == K_MOUSEDOWN
10676 || n == K_MOUSEUP)
10678 int row = mouse_row;
10679 int col = mouse_col;
10680 win_T *win;
10681 linenr_T lnum;
10682 # ifdef FEAT_WINDOWS
10683 win_T *wp;
10684 # endif
10685 int winnr = 1;
10687 if (row >= 0 && col >= 0)
10689 /* Find the window at the mouse coordinates and compute the
10690 * text position. */
10691 win = mouse_find_win(&row, &col);
10692 (void)mouse_comp_pos(win, &row, &col, &lnum);
10693 # ifdef FEAT_WINDOWS
10694 for (wp = firstwin; wp != win; wp = wp->w_next)
10695 ++winnr;
10696 # endif
10697 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10698 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10699 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10702 #endif
10707 * "getcharmod()" function
10709 static void
10710 f_getcharmod(argvars, rettv)
10711 typval_T *argvars UNUSED;
10712 typval_T *rettv;
10714 rettv->vval.v_number = mod_mask;
10718 * "getcmdline()" function
10720 static void
10721 f_getcmdline(argvars, rettv)
10722 typval_T *argvars UNUSED;
10723 typval_T *rettv;
10725 rettv->v_type = VAR_STRING;
10726 rettv->vval.v_string = get_cmdline_str();
10730 * "getcmdpos()" function
10732 static void
10733 f_getcmdpos(argvars, rettv)
10734 typval_T *argvars UNUSED;
10735 typval_T *rettv;
10737 rettv->vval.v_number = get_cmdline_pos() + 1;
10741 * "getcmdtype()" function
10743 static void
10744 f_getcmdtype(argvars, rettv)
10745 typval_T *argvars UNUSED;
10746 typval_T *rettv;
10748 rettv->v_type = VAR_STRING;
10749 rettv->vval.v_string = alloc(2);
10750 if (rettv->vval.v_string != NULL)
10752 rettv->vval.v_string[0] = get_cmdline_type();
10753 rettv->vval.v_string[1] = NUL;
10758 * "getcwd()" function
10760 static void
10761 f_getcwd(argvars, rettv)
10762 typval_T *argvars UNUSED;
10763 typval_T *rettv;
10765 char_u cwd[MAXPATHL];
10767 rettv->v_type = VAR_STRING;
10768 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10769 rettv->vval.v_string = NULL;
10770 else
10772 rettv->vval.v_string = vim_strsave(cwd);
10773 #ifdef BACKSLASH_IN_FILENAME
10774 if (rettv->vval.v_string != NULL)
10775 slash_adjust(rettv->vval.v_string);
10776 #endif
10781 * "getfontname()" function
10783 static void
10784 f_getfontname(argvars, rettv)
10785 typval_T *argvars UNUSED;
10786 typval_T *rettv;
10788 rettv->v_type = VAR_STRING;
10789 rettv->vval.v_string = NULL;
10790 #ifdef FEAT_GUI
10791 if (gui.in_use)
10793 GuiFont font;
10794 char_u *name = NULL;
10796 if (argvars[0].v_type == VAR_UNKNOWN)
10798 /* Get the "Normal" font. Either the name saved by
10799 * hl_set_font_name() or from the font ID. */
10800 font = gui.norm_font;
10801 name = hl_get_font_name();
10803 else
10805 name = get_tv_string(&argvars[0]);
10806 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10807 return;
10808 font = gui_mch_get_font(name, FALSE);
10809 if (font == NOFONT)
10810 return; /* Invalid font name, return empty string. */
10812 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10813 if (argvars[0].v_type != VAR_UNKNOWN)
10814 gui_mch_free_font(font);
10816 #endif
10820 * "getfperm({fname})" function
10822 static void
10823 f_getfperm(argvars, rettv)
10824 typval_T *argvars;
10825 typval_T *rettv;
10827 char_u *fname;
10828 struct stat st;
10829 char_u *perm = NULL;
10830 char_u flags[] = "rwx";
10831 int i;
10833 fname = get_tv_string(&argvars[0]);
10835 rettv->v_type = VAR_STRING;
10836 if (mch_stat((char *)fname, &st) >= 0)
10838 perm = vim_strsave((char_u *)"---------");
10839 if (perm != NULL)
10841 for (i = 0; i < 9; i++)
10843 if (st.st_mode & (1 << (8 - i)))
10844 perm[i] = flags[i % 3];
10848 rettv->vval.v_string = perm;
10852 * "getfsize({fname})" function
10854 static void
10855 f_getfsize(argvars, rettv)
10856 typval_T *argvars;
10857 typval_T *rettv;
10859 char_u *fname;
10860 struct stat st;
10862 fname = get_tv_string(&argvars[0]);
10864 rettv->v_type = VAR_NUMBER;
10866 if (mch_stat((char *)fname, &st) >= 0)
10868 if (mch_isdir(fname))
10869 rettv->vval.v_number = 0;
10870 else
10872 rettv->vval.v_number = (varnumber_T)st.st_size;
10874 /* non-perfect check for overflow */
10875 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10876 rettv->vval.v_number = -2;
10879 else
10880 rettv->vval.v_number = -1;
10884 * "getftime({fname})" function
10886 static void
10887 f_getftime(argvars, rettv)
10888 typval_T *argvars;
10889 typval_T *rettv;
10891 char_u *fname;
10892 struct stat st;
10894 fname = get_tv_string(&argvars[0]);
10896 if (mch_stat((char *)fname, &st) >= 0)
10897 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10898 else
10899 rettv->vval.v_number = -1;
10903 * "getftype({fname})" function
10905 static void
10906 f_getftype(argvars, rettv)
10907 typval_T *argvars;
10908 typval_T *rettv;
10910 char_u *fname;
10911 struct stat st;
10912 char_u *type = NULL;
10913 char *t;
10915 fname = get_tv_string(&argvars[0]);
10917 rettv->v_type = VAR_STRING;
10918 if (mch_lstat((char *)fname, &st) >= 0)
10920 #ifdef S_ISREG
10921 if (S_ISREG(st.st_mode))
10922 t = "file";
10923 else if (S_ISDIR(st.st_mode))
10924 t = "dir";
10925 # ifdef S_ISLNK
10926 else if (S_ISLNK(st.st_mode))
10927 t = "link";
10928 # endif
10929 # ifdef S_ISBLK
10930 else if (S_ISBLK(st.st_mode))
10931 t = "bdev";
10932 # endif
10933 # ifdef S_ISCHR
10934 else if (S_ISCHR(st.st_mode))
10935 t = "cdev";
10936 # endif
10937 # ifdef S_ISFIFO
10938 else if (S_ISFIFO(st.st_mode))
10939 t = "fifo";
10940 # endif
10941 # ifdef S_ISSOCK
10942 else if (S_ISSOCK(st.st_mode))
10943 t = "fifo";
10944 # endif
10945 else
10946 t = "other";
10947 #else
10948 # ifdef S_IFMT
10949 switch (st.st_mode & S_IFMT)
10951 case S_IFREG: t = "file"; break;
10952 case S_IFDIR: t = "dir"; break;
10953 # ifdef S_IFLNK
10954 case S_IFLNK: t = "link"; break;
10955 # endif
10956 # ifdef S_IFBLK
10957 case S_IFBLK: t = "bdev"; break;
10958 # endif
10959 # ifdef S_IFCHR
10960 case S_IFCHR: t = "cdev"; break;
10961 # endif
10962 # ifdef S_IFIFO
10963 case S_IFIFO: t = "fifo"; break;
10964 # endif
10965 # ifdef S_IFSOCK
10966 case S_IFSOCK: t = "socket"; break;
10967 # endif
10968 default: t = "other";
10970 # else
10971 if (mch_isdir(fname))
10972 t = "dir";
10973 else
10974 t = "file";
10975 # endif
10976 #endif
10977 type = vim_strsave((char_u *)t);
10979 rettv->vval.v_string = type;
10983 * "getline(lnum, [end])" function
10985 static void
10986 f_getline(argvars, rettv)
10987 typval_T *argvars;
10988 typval_T *rettv;
10990 linenr_T lnum;
10991 linenr_T end;
10992 int retlist;
10994 lnum = get_tv_lnum(argvars);
10995 if (argvars[1].v_type == VAR_UNKNOWN)
10997 end = 0;
10998 retlist = FALSE;
11000 else
11002 end = get_tv_lnum(&argvars[1]);
11003 retlist = TRUE;
11006 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
11010 * "getmatches()" function
11012 static void
11013 f_getmatches(argvars, rettv)
11014 typval_T *argvars UNUSED;
11015 typval_T *rettv;
11017 #ifdef FEAT_SEARCH_EXTRA
11018 dict_T *dict;
11019 matchitem_T *cur = curwin->w_match_head;
11021 if (rettv_list_alloc(rettv) == OK)
11023 while (cur != NULL)
11025 dict = dict_alloc();
11026 if (dict == NULL)
11027 return;
11028 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11029 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11030 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11031 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11032 list_append_dict(rettv->vval.v_list, dict);
11033 cur = cur->next;
11036 #endif
11040 * "getpid()" function
11042 static void
11043 f_getpid(argvars, rettv)
11044 typval_T *argvars UNUSED;
11045 typval_T *rettv;
11047 rettv->vval.v_number = mch_get_pid();
11051 * "getpos(string)" function
11053 static void
11054 f_getpos(argvars, rettv)
11055 typval_T *argvars;
11056 typval_T *rettv;
11058 pos_T *fp;
11059 list_T *l;
11060 int fnum = -1;
11062 if (rettv_list_alloc(rettv) == OK)
11064 l = rettv->vval.v_list;
11065 fp = var2fpos(&argvars[0], TRUE, &fnum);
11066 if (fnum != -1)
11067 list_append_number(l, (varnumber_T)fnum);
11068 else
11069 list_append_number(l, (varnumber_T)0);
11070 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11071 : (varnumber_T)0);
11072 list_append_number(l, (fp != NULL)
11073 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11074 : (varnumber_T)0);
11075 list_append_number(l,
11076 #ifdef FEAT_VIRTUALEDIT
11077 (fp != NULL) ? (varnumber_T)fp->coladd :
11078 #endif
11079 (varnumber_T)0);
11081 else
11082 rettv->vval.v_number = FALSE;
11086 * "getqflist()" and "getloclist()" functions
11088 static void
11089 f_getqflist(argvars, rettv)
11090 typval_T *argvars UNUSED;
11091 typval_T *rettv UNUSED;
11093 #ifdef FEAT_QUICKFIX
11094 win_T *wp;
11095 #endif
11097 #ifdef FEAT_QUICKFIX
11098 if (rettv_list_alloc(rettv) == OK)
11100 wp = NULL;
11101 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11103 wp = find_win_by_nr(&argvars[0], NULL);
11104 if (wp == NULL)
11105 return;
11108 (void)get_errorlist(wp, rettv->vval.v_list);
11110 #endif
11114 * "getreg()" function
11116 static void
11117 f_getreg(argvars, rettv)
11118 typval_T *argvars;
11119 typval_T *rettv;
11121 char_u *strregname;
11122 int regname;
11123 int arg2 = FALSE;
11124 int error = FALSE;
11126 if (argvars[0].v_type != VAR_UNKNOWN)
11128 strregname = get_tv_string_chk(&argvars[0]);
11129 error = strregname == NULL;
11130 if (argvars[1].v_type != VAR_UNKNOWN)
11131 arg2 = get_tv_number_chk(&argvars[1], &error);
11133 else
11134 strregname = vimvars[VV_REG].vv_str;
11135 regname = (strregname == NULL ? '"' : *strregname);
11136 if (regname == 0)
11137 regname = '"';
11139 rettv->v_type = VAR_STRING;
11140 rettv->vval.v_string = error ? NULL :
11141 get_reg_contents(regname, TRUE, arg2);
11145 * "getregtype()" function
11147 static void
11148 f_getregtype(argvars, rettv)
11149 typval_T *argvars;
11150 typval_T *rettv;
11152 char_u *strregname;
11153 int regname;
11154 char_u buf[NUMBUFLEN + 2];
11155 long reglen = 0;
11157 if (argvars[0].v_type != VAR_UNKNOWN)
11159 strregname = get_tv_string_chk(&argvars[0]);
11160 if (strregname == NULL) /* type error; errmsg already given */
11162 rettv->v_type = VAR_STRING;
11163 rettv->vval.v_string = NULL;
11164 return;
11167 else
11168 /* Default to v:register */
11169 strregname = vimvars[VV_REG].vv_str;
11171 regname = (strregname == NULL ? '"' : *strregname);
11172 if (regname == 0)
11173 regname = '"';
11175 buf[0] = NUL;
11176 buf[1] = NUL;
11177 switch (get_reg_type(regname, &reglen))
11179 case MLINE: buf[0] = 'V'; break;
11180 case MCHAR: buf[0] = 'v'; break;
11181 #ifdef FEAT_VISUAL
11182 case MBLOCK:
11183 buf[0] = Ctrl_V;
11184 sprintf((char *)buf + 1, "%ld", reglen + 1);
11185 break;
11186 #endif
11188 rettv->v_type = VAR_STRING;
11189 rettv->vval.v_string = vim_strsave(buf);
11193 * "gettabwinvar()" function
11195 static void
11196 f_gettabwinvar(argvars, rettv)
11197 typval_T *argvars;
11198 typval_T *rettv;
11200 getwinvar(argvars, rettv, 1);
11204 * "getwinposx()" function
11206 static void
11207 f_getwinposx(argvars, rettv)
11208 typval_T *argvars UNUSED;
11209 typval_T *rettv;
11211 rettv->vval.v_number = -1;
11212 #ifdef FEAT_GUI
11213 if (gui.in_use)
11215 int x, y;
11217 if (gui_mch_get_winpos(&x, &y) == OK)
11218 rettv->vval.v_number = x;
11220 #endif
11224 * "getwinposy()" function
11226 static void
11227 f_getwinposy(argvars, rettv)
11228 typval_T *argvars UNUSED;
11229 typval_T *rettv;
11231 rettv->vval.v_number = -1;
11232 #ifdef FEAT_GUI
11233 if (gui.in_use)
11235 int x, y;
11237 if (gui_mch_get_winpos(&x, &y) == OK)
11238 rettv->vval.v_number = y;
11240 #endif
11244 * Find window specified by "vp" in tabpage "tp".
11246 static win_T *
11247 find_win_by_nr(vp, tp)
11248 typval_T *vp;
11249 tabpage_T *tp; /* NULL for current tab page */
11251 #ifdef FEAT_WINDOWS
11252 win_T *wp;
11253 #endif
11254 int nr;
11256 nr = get_tv_number_chk(vp, NULL);
11258 #ifdef FEAT_WINDOWS
11259 if (nr < 0)
11260 return NULL;
11261 if (nr == 0)
11262 return curwin;
11264 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11265 wp != NULL; wp = wp->w_next)
11266 if (--nr <= 0)
11267 break;
11268 return wp;
11269 #else
11270 if (nr == 0 || nr == 1)
11271 return curwin;
11272 return NULL;
11273 #endif
11277 * "getwinvar()" function
11279 static void
11280 f_getwinvar(argvars, rettv)
11281 typval_T *argvars;
11282 typval_T *rettv;
11284 getwinvar(argvars, rettv, 0);
11288 * getwinvar() and gettabwinvar()
11290 static void
11291 getwinvar(argvars, rettv, off)
11292 typval_T *argvars;
11293 typval_T *rettv;
11294 int off; /* 1 for gettabwinvar() */
11296 win_T *win, *oldcurwin;
11297 char_u *varname;
11298 dictitem_T *v;
11299 tabpage_T *tp;
11301 #ifdef FEAT_WINDOWS
11302 if (off == 1)
11303 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11304 else
11305 tp = curtab;
11306 #endif
11307 win = find_win_by_nr(&argvars[off], tp);
11308 varname = get_tv_string_chk(&argvars[off + 1]);
11309 ++emsg_off;
11311 rettv->v_type = VAR_STRING;
11312 rettv->vval.v_string = NULL;
11314 if (win != NULL && varname != NULL)
11316 /* Set curwin to be our win, temporarily. Also set curbuf, so
11317 * that we can get buffer-local options. */
11318 oldcurwin = curwin;
11319 curwin = win;
11320 curbuf = win->w_buffer;
11322 if (*varname == '&') /* window-local-option */
11323 get_option_tv(&varname, rettv, 1);
11324 else
11326 if (*varname == NUL)
11327 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11328 * scope prefix before the NUL byte is required by
11329 * find_var_in_ht(). */
11330 varname = (char_u *)"w:" + 2;
11331 /* look up the variable */
11332 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11333 if (v != NULL)
11334 copy_tv(&v->di_tv, rettv);
11337 /* restore previous notion of curwin */
11338 curwin = oldcurwin;
11339 curbuf = curwin->w_buffer;
11342 --emsg_off;
11346 * "glob()" function
11348 static void
11349 f_glob(argvars, rettv)
11350 typval_T *argvars;
11351 typval_T *rettv;
11353 int flags = WILD_SILENT|WILD_USE_NL;
11354 expand_T xpc;
11355 int error = FALSE;
11357 /* When the optional second argument is non-zero, don't remove matches
11358 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11359 if (argvars[1].v_type != VAR_UNKNOWN
11360 && get_tv_number_chk(&argvars[1], &error))
11361 flags |= WILD_KEEP_ALL;
11362 rettv->v_type = VAR_STRING;
11363 if (!error)
11365 ExpandInit(&xpc);
11366 xpc.xp_context = EXPAND_FILES;
11367 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11368 NULL, flags, WILD_ALL);
11370 else
11371 rettv->vval.v_string = NULL;
11375 * "globpath()" function
11377 static void
11378 f_globpath(argvars, rettv)
11379 typval_T *argvars;
11380 typval_T *rettv;
11382 int flags = 0;
11383 char_u buf1[NUMBUFLEN];
11384 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11385 int error = FALSE;
11387 /* When the optional second argument is non-zero, don't remove matches
11388 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11389 if (argvars[2].v_type != VAR_UNKNOWN
11390 && get_tv_number_chk(&argvars[2], &error))
11391 flags |= WILD_KEEP_ALL;
11392 rettv->v_type = VAR_STRING;
11393 if (file == NULL || error)
11394 rettv->vval.v_string = NULL;
11395 else
11396 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11397 flags);
11401 * "has()" function
11403 static void
11404 f_has(argvars, rettv)
11405 typval_T *argvars;
11406 typval_T *rettv;
11408 int i;
11409 char_u *name;
11410 int n = FALSE;
11411 static char *(has_list[]) =
11413 #ifdef AMIGA
11414 "amiga",
11415 # ifdef FEAT_ARP
11416 "arp",
11417 # endif
11418 #endif
11419 #ifdef __BEOS__
11420 "beos",
11421 #endif
11422 #ifdef MSDOS
11423 # ifdef DJGPP
11424 "dos32",
11425 # else
11426 "dos16",
11427 # endif
11428 #endif
11429 #ifdef MACOS
11430 "mac",
11431 #endif
11432 #if defined(MACOS_X_UNIX)
11433 "macunix",
11434 #endif
11435 #ifdef OS2
11436 "os2",
11437 #endif
11438 #ifdef __QNX__
11439 "qnx",
11440 #endif
11441 #ifdef RISCOS
11442 "riscos",
11443 #endif
11444 #ifdef UNIX
11445 "unix",
11446 #endif
11447 #ifdef VMS
11448 "vms",
11449 #endif
11450 #ifdef WIN16
11451 "win16",
11452 #endif
11453 #ifdef WIN32
11454 "win32",
11455 #endif
11456 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11457 "win32unix",
11458 #endif
11459 #if defined(WIN64) || defined(_WIN64)
11460 "win64",
11461 #endif
11462 #ifdef EBCDIC
11463 "ebcdic",
11464 #endif
11465 #ifndef CASE_INSENSITIVE_FILENAME
11466 "fname_case",
11467 #endif
11468 #ifdef FEAT_ARABIC
11469 "arabic",
11470 #endif
11471 #ifdef FEAT_AUTOCMD
11472 "autocmd",
11473 #endif
11474 #ifdef FEAT_BEVAL
11475 "balloon_eval",
11476 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11477 "balloon_multiline",
11478 # endif
11479 #endif
11480 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11481 "builtin_terms",
11482 # ifdef ALL_BUILTIN_TCAPS
11483 "all_builtin_terms",
11484 # endif
11485 #endif
11486 #ifdef FEAT_BYTEOFF
11487 "byte_offset",
11488 #endif
11489 #ifdef FEAT_CINDENT
11490 "cindent",
11491 #endif
11492 #ifdef FEAT_CLIENTSERVER
11493 "clientserver",
11494 #endif
11495 #ifdef FEAT_CLIPBOARD
11496 "clipboard",
11497 #endif
11498 #ifdef FEAT_CMDL_COMPL
11499 "cmdline_compl",
11500 #endif
11501 #ifdef FEAT_CMDHIST
11502 "cmdline_hist",
11503 #endif
11504 #ifdef FEAT_COMMENTS
11505 "comments",
11506 #endif
11507 #ifdef FEAT_CRYPT
11508 "cryptv",
11509 #endif
11510 #ifdef FEAT_CSCOPE
11511 "cscope",
11512 #endif
11513 #ifdef CURSOR_SHAPE
11514 "cursorshape",
11515 #endif
11516 #ifdef DEBUG
11517 "debug",
11518 #endif
11519 #ifdef FEAT_CON_DIALOG
11520 "dialog_con",
11521 #endif
11522 #ifdef FEAT_GUI_DIALOG
11523 "dialog_gui",
11524 #endif
11525 #ifdef FEAT_DIFF
11526 "diff",
11527 #endif
11528 #ifdef FEAT_DIGRAPHS
11529 "digraphs",
11530 #endif
11531 #ifdef FEAT_DND
11532 "dnd",
11533 #endif
11534 #ifdef FEAT_EMACS_TAGS
11535 "emacs_tags",
11536 #endif
11537 "eval", /* always present, of course! */
11538 #ifdef FEAT_EX_EXTRA
11539 "ex_extra",
11540 #endif
11541 #ifdef FEAT_SEARCH_EXTRA
11542 "extra_search",
11543 #endif
11544 #ifdef FEAT_FKMAP
11545 "farsi",
11546 #endif
11547 #ifdef FEAT_SEARCHPATH
11548 "file_in_path",
11549 #endif
11550 #if defined(UNIX) && !defined(USE_SYSTEM)
11551 "filterpipe",
11552 #endif
11553 #ifdef FEAT_FIND_ID
11554 "find_in_path",
11555 #endif
11556 #ifdef FEAT_FLOAT
11557 "float",
11558 #endif
11559 #ifdef FEAT_FOLDING
11560 "folding",
11561 #endif
11562 #ifdef FEAT_FOOTER
11563 "footer",
11564 #endif
11565 #if !defined(USE_SYSTEM) && defined(UNIX)
11566 "fork",
11567 #endif
11568 #ifdef FEAT_FULLSCREEN
11569 "fullscreen",
11570 #endif
11571 #ifdef FEAT_GETTEXT
11572 "gettext",
11573 #endif
11574 #ifdef FEAT_GUI
11575 "gui",
11576 #endif
11577 #ifdef FEAT_GUI_ATHENA
11578 # ifdef FEAT_GUI_NEXTAW
11579 "gui_neXtaw",
11580 # else
11581 "gui_athena",
11582 # endif
11583 #endif
11584 #ifdef FEAT_GUI_GTK
11585 "gui_gtk",
11586 # ifdef HAVE_GTK2
11587 "gui_gtk2",
11588 # endif
11589 #endif
11590 #ifdef FEAT_GUI_GNOME
11591 "gui_gnome",
11592 #endif
11593 #ifdef FEAT_GUI_MAC
11594 "gui_mac",
11595 #endif
11596 #ifdef FEAT_GUI_MACVIM
11597 "gui_macvim",
11598 #endif
11599 #ifdef FEAT_GUI_MOTIF
11600 "gui_motif",
11601 #endif
11602 #ifdef FEAT_GUI_PHOTON
11603 "gui_photon",
11604 #endif
11605 #ifdef FEAT_GUI_W16
11606 "gui_win16",
11607 #endif
11608 #ifdef FEAT_GUI_W32
11609 "gui_win32",
11610 #endif
11611 #ifdef FEAT_HANGULIN
11612 "hangul_input",
11613 #endif
11614 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11615 "iconv",
11616 #endif
11617 #ifdef FEAT_INS_EXPAND
11618 "insert_expand",
11619 #endif
11620 #ifdef FEAT_JUMPLIST
11621 "jumplist",
11622 #endif
11623 #ifdef FEAT_KEYMAP
11624 "keymap",
11625 #endif
11626 #ifdef FEAT_LANGMAP
11627 "langmap",
11628 #endif
11629 #ifdef FEAT_LIBCALL
11630 "libcall",
11631 #endif
11632 #ifdef FEAT_LINEBREAK
11633 "linebreak",
11634 #endif
11635 #ifdef FEAT_LISP
11636 "lispindent",
11637 #endif
11638 #ifdef FEAT_LISTCMDS
11639 "listcmds",
11640 #endif
11641 #ifdef FEAT_LOCALMAP
11642 "localmap",
11643 #endif
11644 #ifdef FEAT_MENU
11645 "menu",
11646 #endif
11647 #ifdef FEAT_SESSION
11648 "mksession",
11649 #endif
11650 #ifdef FEAT_MODIFY_FNAME
11651 "modify_fname",
11652 #endif
11653 #ifdef FEAT_MOUSE
11654 "mouse",
11655 #endif
11656 #ifdef FEAT_MOUSESHAPE
11657 "mouseshape",
11658 #endif
11659 #if defined(UNIX) || defined(VMS)
11660 # ifdef FEAT_MOUSE_DEC
11661 "mouse_dec",
11662 # endif
11663 # ifdef FEAT_MOUSE_GPM
11664 "mouse_gpm",
11665 # endif
11666 # ifdef FEAT_MOUSE_JSB
11667 "mouse_jsbterm",
11668 # endif
11669 # ifdef FEAT_MOUSE_NET
11670 "mouse_netterm",
11671 # endif
11672 # ifdef FEAT_MOUSE_PTERM
11673 "mouse_pterm",
11674 # endif
11675 # ifdef FEAT_SYSMOUSE
11676 "mouse_sysmouse",
11677 # endif
11678 # ifdef FEAT_MOUSE_XTERM
11679 "mouse_xterm",
11680 # endif
11681 #endif
11682 #ifdef FEAT_MBYTE
11683 "multi_byte",
11684 #endif
11685 #ifdef FEAT_MBYTE_IME
11686 "multi_byte_ime",
11687 #endif
11688 #ifdef FEAT_MULTI_LANG
11689 "multi_lang",
11690 #endif
11691 #ifdef FEAT_MZSCHEME
11692 #ifndef DYNAMIC_MZSCHEME
11693 "mzscheme",
11694 #endif
11695 #endif
11696 #ifdef FEAT_OLE
11697 "ole",
11698 #endif
11699 #ifdef FEAT_OSFILETYPE
11700 "osfiletype",
11701 #endif
11702 #ifdef FEAT_PATH_EXTRA
11703 "path_extra",
11704 #endif
11705 #ifdef FEAT_PERL
11706 #ifndef DYNAMIC_PERL
11707 "perl",
11708 #endif
11709 #endif
11710 #ifdef FEAT_PYTHON
11711 #ifndef DYNAMIC_PYTHON
11712 "python",
11713 #endif
11714 #endif
11715 #ifdef FEAT_POSTSCRIPT
11716 "postscript",
11717 #endif
11718 #ifdef FEAT_PRINTER
11719 "printer",
11720 #endif
11721 #ifdef FEAT_PROFILE
11722 "profile",
11723 #endif
11724 #ifdef FEAT_RELTIME
11725 "reltime",
11726 #endif
11727 #ifdef FEAT_QUICKFIX
11728 "quickfix",
11729 #endif
11730 #ifdef FEAT_RIGHTLEFT
11731 "rightleft",
11732 #endif
11733 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11734 "ruby",
11735 #endif
11736 #ifdef FEAT_SCROLLBIND
11737 "scrollbind",
11738 #endif
11739 #ifdef FEAT_CMDL_INFO
11740 "showcmd",
11741 "cmdline_info",
11742 #endif
11743 #ifdef FEAT_SIGNS
11744 "signs",
11745 #endif
11746 #ifdef FEAT_SMARTINDENT
11747 "smartindent",
11748 #endif
11749 #ifdef FEAT_SNIFF
11750 "sniff",
11751 #endif
11752 #ifdef STARTUPTIME
11753 "startuptime",
11754 #endif
11755 #ifdef FEAT_STL_OPT
11756 "statusline",
11757 #endif
11758 #ifdef FEAT_SUN_WORKSHOP
11759 "sun_workshop",
11760 #endif
11761 #ifdef FEAT_NETBEANS_INTG
11762 "netbeans_intg",
11763 #endif
11764 #ifdef FEAT_ODB_EDITOR
11765 "odbeditor",
11766 #endif
11767 #ifdef FEAT_SPELL
11768 "spell",
11769 #endif
11770 #ifdef FEAT_SYN_HL
11771 "syntax",
11772 #endif
11773 #if defined(USE_SYSTEM) || !defined(UNIX)
11774 "system",
11775 #endif
11776 #ifdef FEAT_TAG_BINS
11777 "tag_binary",
11778 #endif
11779 #ifdef FEAT_TAG_OLDSTATIC
11780 "tag_old_static",
11781 #endif
11782 #ifdef FEAT_TAG_ANYWHITE
11783 "tag_any_white",
11784 #endif
11785 #ifdef FEAT_TCL
11786 # ifndef DYNAMIC_TCL
11787 "tcl",
11788 # endif
11789 #endif
11790 #ifdef TERMINFO
11791 "terminfo",
11792 #endif
11793 #ifdef FEAT_TERMRESPONSE
11794 "termresponse",
11795 #endif
11796 #ifdef FEAT_TEXTOBJ
11797 "textobjects",
11798 #endif
11799 #ifdef HAVE_TGETENT
11800 "tgetent",
11801 #endif
11802 #ifdef FEAT_TITLE
11803 "title",
11804 #endif
11805 #ifdef FEAT_TOOLBAR
11806 "toolbar",
11807 #endif
11808 #ifdef FEAT_TRANSPARENCY
11809 "transparency",
11810 #endif
11811 #ifdef FEAT_USR_CMDS
11812 "user-commands", /* was accidentally included in 5.4 */
11813 "user_commands",
11814 #endif
11815 #ifdef FEAT_VIMINFO
11816 "viminfo",
11817 #endif
11818 #ifdef FEAT_VERTSPLIT
11819 "vertsplit",
11820 #endif
11821 #ifdef FEAT_VIRTUALEDIT
11822 "virtualedit",
11823 #endif
11824 #ifdef FEAT_VISUAL
11825 "visual",
11826 #endif
11827 #ifdef FEAT_VISUALEXTRA
11828 "visualextra",
11829 #endif
11830 #ifdef FEAT_VREPLACE
11831 "vreplace",
11832 #endif
11833 #ifdef FEAT_WILDIGN
11834 "wildignore",
11835 #endif
11836 #ifdef FEAT_WILDMENU
11837 "wildmenu",
11838 #endif
11839 #ifdef FEAT_WINDOWS
11840 "windows",
11841 #endif
11842 #ifdef FEAT_WAK
11843 "winaltkeys",
11844 #endif
11845 #ifdef FEAT_WRITEBACKUP
11846 "writebackup",
11847 #endif
11848 #ifdef FEAT_XIM
11849 "xim",
11850 #endif
11851 #ifdef FEAT_XFONTSET
11852 "xfontset",
11853 #endif
11854 #ifdef USE_XSMP
11855 "xsmp",
11856 #endif
11857 #ifdef USE_XSMP_INTERACT
11858 "xsmp_interact",
11859 #endif
11860 #ifdef FEAT_XCLIPBOARD
11861 "xterm_clipboard",
11862 #endif
11863 #ifdef FEAT_XTERM_SAVE
11864 "xterm_save",
11865 #endif
11866 #if defined(UNIX) && defined(FEAT_X11)
11867 "X11",
11868 #endif
11869 NULL
11872 name = get_tv_string(&argvars[0]);
11873 for (i = 0; has_list[i] != NULL; ++i)
11874 if (STRICMP(name, has_list[i]) == 0)
11876 n = TRUE;
11877 break;
11880 if (n == FALSE)
11882 if (STRNICMP(name, "patch", 5) == 0)
11883 n = has_patch(atoi((char *)name + 5));
11884 else if (STRICMP(name, "vim_starting") == 0)
11885 n = (starting != 0);
11886 #ifdef FEAT_MBYTE
11887 else if (STRICMP(name, "multi_byte_encoding") == 0)
11888 n = has_mbyte;
11889 #endif
11890 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11891 else if (STRICMP(name, "balloon_multiline") == 0)
11892 n = multiline_balloon_available();
11893 #endif
11894 #ifdef DYNAMIC_TCL
11895 else if (STRICMP(name, "tcl") == 0)
11896 n = tcl_enabled(FALSE);
11897 #endif
11898 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11899 else if (STRICMP(name, "iconv") == 0)
11900 n = iconv_enabled(FALSE);
11901 #endif
11902 #ifdef DYNAMIC_MZSCHEME
11903 else if (STRICMP(name, "mzscheme") == 0)
11904 n = mzscheme_enabled(FALSE);
11905 #endif
11906 #ifdef DYNAMIC_RUBY
11907 else if (STRICMP(name, "ruby") == 0)
11908 n = ruby_enabled(FALSE);
11909 #endif
11910 #ifdef DYNAMIC_PYTHON
11911 else if (STRICMP(name, "python") == 0)
11912 n = python_enabled(FALSE);
11913 #endif
11914 #ifdef DYNAMIC_PERL
11915 else if (STRICMP(name, "perl") == 0)
11916 n = perl_enabled(FALSE);
11917 #endif
11918 #ifdef FEAT_GUI
11919 else if (STRICMP(name, "gui_running") == 0)
11920 n = (gui.in_use || gui.starting);
11921 # ifdef FEAT_GUI_W32
11922 else if (STRICMP(name, "gui_win32s") == 0)
11923 n = gui_is_win32s();
11924 # endif
11925 # ifdef FEAT_BROWSE
11926 else if (STRICMP(name, "browse") == 0)
11927 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11928 # endif
11929 #endif
11930 #ifdef FEAT_SYN_HL
11931 else if (STRICMP(name, "syntax_items") == 0)
11932 n = syntax_present(curbuf);
11933 #endif
11934 #if defined(WIN3264)
11935 else if (STRICMP(name, "win95") == 0)
11936 n = mch_windows95();
11937 #endif
11938 #ifdef FEAT_NETBEANS_INTG
11939 else if (STRICMP(name, "netbeans_enabled") == 0)
11940 n = usingNetbeans;
11941 #endif
11944 rettv->vval.v_number = n;
11948 * "has_key()" function
11950 static void
11951 f_has_key(argvars, rettv)
11952 typval_T *argvars;
11953 typval_T *rettv;
11955 if (argvars[0].v_type != VAR_DICT)
11957 EMSG(_(e_dictreq));
11958 return;
11960 if (argvars[0].vval.v_dict == NULL)
11961 return;
11963 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11964 get_tv_string(&argvars[1]), -1) != NULL;
11968 * "haslocaldir()" function
11970 static void
11971 f_haslocaldir(argvars, rettv)
11972 typval_T *argvars UNUSED;
11973 typval_T *rettv;
11975 rettv->vval.v_number = (curwin->w_localdir != NULL);
11979 * "hasmapto()" function
11981 static void
11982 f_hasmapto(argvars, rettv)
11983 typval_T *argvars;
11984 typval_T *rettv;
11986 char_u *name;
11987 char_u *mode;
11988 char_u buf[NUMBUFLEN];
11989 int abbr = FALSE;
11991 name = get_tv_string(&argvars[0]);
11992 if (argvars[1].v_type == VAR_UNKNOWN)
11993 mode = (char_u *)"nvo";
11994 else
11996 mode = get_tv_string_buf(&argvars[1], buf);
11997 if (argvars[2].v_type != VAR_UNKNOWN)
11998 abbr = get_tv_number(&argvars[2]);
12001 if (map_to_exists(name, mode, abbr))
12002 rettv->vval.v_number = TRUE;
12003 else
12004 rettv->vval.v_number = FALSE;
12008 * "histadd()" function
12010 static void
12011 f_histadd(argvars, rettv)
12012 typval_T *argvars UNUSED;
12013 typval_T *rettv;
12015 #ifdef FEAT_CMDHIST
12016 int histype;
12017 char_u *str;
12018 char_u buf[NUMBUFLEN];
12019 #endif
12021 rettv->vval.v_number = FALSE;
12022 if (check_restricted() || check_secure())
12023 return;
12024 #ifdef FEAT_CMDHIST
12025 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12026 histype = str != NULL ? get_histtype(str) : -1;
12027 if (histype >= 0)
12029 str = get_tv_string_buf(&argvars[1], buf);
12030 if (*str != NUL)
12032 init_history();
12033 add_to_history(histype, str, FALSE, NUL);
12034 rettv->vval.v_number = TRUE;
12035 return;
12038 #endif
12042 * "histdel()" function
12044 static void
12045 f_histdel(argvars, rettv)
12046 typval_T *argvars UNUSED;
12047 typval_T *rettv UNUSED;
12049 #ifdef FEAT_CMDHIST
12050 int n;
12051 char_u buf[NUMBUFLEN];
12052 char_u *str;
12054 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12055 if (str == NULL)
12056 n = 0;
12057 else if (argvars[1].v_type == VAR_UNKNOWN)
12058 /* only one argument: clear entire history */
12059 n = clr_history(get_histtype(str));
12060 else if (argvars[1].v_type == VAR_NUMBER)
12061 /* index given: remove that entry */
12062 n = del_history_idx(get_histtype(str),
12063 (int)get_tv_number(&argvars[1]));
12064 else
12065 /* string given: remove all matching entries */
12066 n = del_history_entry(get_histtype(str),
12067 get_tv_string_buf(&argvars[1], buf));
12068 rettv->vval.v_number = n;
12069 #endif
12073 * "histget()" function
12075 static void
12076 f_histget(argvars, rettv)
12077 typval_T *argvars UNUSED;
12078 typval_T *rettv;
12080 #ifdef FEAT_CMDHIST
12081 int type;
12082 int idx;
12083 char_u *str;
12085 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12086 if (str == NULL)
12087 rettv->vval.v_string = NULL;
12088 else
12090 type = get_histtype(str);
12091 if (argvars[1].v_type == VAR_UNKNOWN)
12092 idx = get_history_idx(type);
12093 else
12094 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12095 /* -1 on type error */
12096 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12098 #else
12099 rettv->vval.v_string = NULL;
12100 #endif
12101 rettv->v_type = VAR_STRING;
12105 * "histnr()" function
12107 static void
12108 f_histnr(argvars, rettv)
12109 typval_T *argvars UNUSED;
12110 typval_T *rettv;
12112 int i;
12114 #ifdef FEAT_CMDHIST
12115 char_u *history = get_tv_string_chk(&argvars[0]);
12117 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12118 if (i >= HIST_CMD && i < HIST_COUNT)
12119 i = get_history_idx(i);
12120 else
12121 #endif
12122 i = -1;
12123 rettv->vval.v_number = i;
12127 * "highlightID(name)" function
12129 static void
12130 f_hlID(argvars, rettv)
12131 typval_T *argvars;
12132 typval_T *rettv;
12134 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12138 * "highlight_exists()" function
12140 static void
12141 f_hlexists(argvars, rettv)
12142 typval_T *argvars;
12143 typval_T *rettv;
12145 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12149 * "hostname()" function
12151 static void
12152 f_hostname(argvars, rettv)
12153 typval_T *argvars UNUSED;
12154 typval_T *rettv;
12156 char_u hostname[256];
12158 mch_get_host_name(hostname, 256);
12159 rettv->v_type = VAR_STRING;
12160 rettv->vval.v_string = vim_strsave(hostname);
12164 * iconv() function
12166 static void
12167 f_iconv(argvars, rettv)
12168 typval_T *argvars UNUSED;
12169 typval_T *rettv;
12171 #ifdef FEAT_MBYTE
12172 char_u buf1[NUMBUFLEN];
12173 char_u buf2[NUMBUFLEN];
12174 char_u *from, *to, *str;
12175 vimconv_T vimconv;
12176 #endif
12178 rettv->v_type = VAR_STRING;
12179 rettv->vval.v_string = NULL;
12181 #ifdef FEAT_MBYTE
12182 str = get_tv_string(&argvars[0]);
12183 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12184 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12185 vimconv.vc_type = CONV_NONE;
12186 convert_setup(&vimconv, from, to);
12188 /* If the encodings are equal, no conversion needed. */
12189 if (vimconv.vc_type == CONV_NONE)
12190 rettv->vval.v_string = vim_strsave(str);
12191 else
12192 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12194 convert_setup(&vimconv, NULL, NULL);
12195 vim_free(from);
12196 vim_free(to);
12197 #endif
12201 * "indent()" function
12203 static void
12204 f_indent(argvars, rettv)
12205 typval_T *argvars;
12206 typval_T *rettv;
12208 linenr_T lnum;
12210 lnum = get_tv_lnum(argvars);
12211 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12212 rettv->vval.v_number = get_indent_lnum(lnum);
12213 else
12214 rettv->vval.v_number = -1;
12218 * "index()" function
12220 static void
12221 f_index(argvars, rettv)
12222 typval_T *argvars;
12223 typval_T *rettv;
12225 list_T *l;
12226 listitem_T *item;
12227 long idx = 0;
12228 int ic = FALSE;
12230 rettv->vval.v_number = -1;
12231 if (argvars[0].v_type != VAR_LIST)
12233 EMSG(_(e_listreq));
12234 return;
12236 l = argvars[0].vval.v_list;
12237 if (l != NULL)
12239 item = l->lv_first;
12240 if (argvars[2].v_type != VAR_UNKNOWN)
12242 int error = FALSE;
12244 /* Start at specified item. Use the cached index that list_find()
12245 * sets, so that a negative number also works. */
12246 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12247 idx = l->lv_idx;
12248 if (argvars[3].v_type != VAR_UNKNOWN)
12249 ic = get_tv_number_chk(&argvars[3], &error);
12250 if (error)
12251 item = NULL;
12254 for ( ; item != NULL; item = item->li_next, ++idx)
12255 if (tv_equal(&item->li_tv, &argvars[1], ic))
12257 rettv->vval.v_number = idx;
12258 break;
12263 static int inputsecret_flag = 0;
12265 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12268 * This function is used by f_input() and f_inputdialog() functions. The third
12269 * argument to f_input() specifies the type of completion to use at the
12270 * prompt. The third argument to f_inputdialog() specifies the value to return
12271 * when the user cancels the prompt.
12273 static void
12274 get_user_input(argvars, rettv, inputdialog)
12275 typval_T *argvars;
12276 typval_T *rettv;
12277 int inputdialog;
12279 char_u *prompt = get_tv_string_chk(&argvars[0]);
12280 char_u *p = NULL;
12281 int c;
12282 char_u buf[NUMBUFLEN];
12283 int cmd_silent_save = cmd_silent;
12284 char_u *defstr = (char_u *)"";
12285 int xp_type = EXPAND_NOTHING;
12286 char_u *xp_arg = NULL;
12288 rettv->v_type = VAR_STRING;
12289 rettv->vval.v_string = NULL;
12291 #ifdef NO_CONSOLE_INPUT
12292 /* While starting up, there is no place to enter text. */
12293 if (no_console_input())
12294 return;
12295 #endif
12297 cmd_silent = FALSE; /* Want to see the prompt. */
12298 if (prompt != NULL)
12300 /* Only the part of the message after the last NL is considered as
12301 * prompt for the command line */
12302 p = vim_strrchr(prompt, '\n');
12303 if (p == NULL)
12304 p = prompt;
12305 else
12307 ++p;
12308 c = *p;
12309 *p = NUL;
12310 msg_start();
12311 msg_clr_eos();
12312 msg_puts_attr(prompt, echo_attr);
12313 msg_didout = FALSE;
12314 msg_starthere();
12315 *p = c;
12317 cmdline_row = msg_row;
12319 if (argvars[1].v_type != VAR_UNKNOWN)
12321 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12322 if (defstr != NULL)
12323 stuffReadbuffSpec(defstr);
12325 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12327 char_u *xp_name;
12328 int xp_namelen;
12329 long argt;
12331 rettv->vval.v_string = NULL;
12333 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12334 if (xp_name == NULL)
12335 return;
12337 xp_namelen = (int)STRLEN(xp_name);
12339 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12340 &xp_arg) == FAIL)
12341 return;
12345 if (defstr != NULL)
12346 rettv->vval.v_string =
12347 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12348 xp_type, xp_arg);
12350 vim_free(xp_arg);
12352 /* since the user typed this, no need to wait for return */
12353 need_wait_return = FALSE;
12354 msg_didout = FALSE;
12356 cmd_silent = cmd_silent_save;
12360 * "input()" function
12361 * Also handles inputsecret() when inputsecret is set.
12363 static void
12364 f_input(argvars, rettv)
12365 typval_T *argvars;
12366 typval_T *rettv;
12368 get_user_input(argvars, rettv, FALSE);
12372 * "inputdialog()" function
12374 static void
12375 f_inputdialog(argvars, rettv)
12376 typval_T *argvars;
12377 typval_T *rettv;
12379 #if defined(FEAT_GUI_TEXTDIALOG)
12380 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12381 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12383 char_u *message;
12384 char_u buf[NUMBUFLEN];
12385 char_u *defstr = (char_u *)"";
12387 message = get_tv_string_chk(&argvars[0]);
12388 if (argvars[1].v_type != VAR_UNKNOWN
12389 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12390 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12391 else
12392 IObuff[0] = NUL;
12393 if (message != NULL && defstr != NULL
12394 && do_dialog(VIM_QUESTION, NULL, message,
12395 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12396 rettv->vval.v_string = vim_strsave(IObuff);
12397 else
12399 if (message != NULL && defstr != NULL
12400 && argvars[1].v_type != VAR_UNKNOWN
12401 && argvars[2].v_type != VAR_UNKNOWN)
12402 rettv->vval.v_string = vim_strsave(
12403 get_tv_string_buf(&argvars[2], buf));
12404 else
12405 rettv->vval.v_string = NULL;
12407 rettv->v_type = VAR_STRING;
12409 else
12410 #endif
12411 get_user_input(argvars, rettv, TRUE);
12415 * "inputlist()" function
12417 static void
12418 f_inputlist(argvars, rettv)
12419 typval_T *argvars;
12420 typval_T *rettv;
12422 listitem_T *li;
12423 int selected;
12424 int mouse_used;
12426 #ifdef NO_CONSOLE_INPUT
12427 /* While starting up, there is no place to enter text. */
12428 if (no_console_input())
12429 return;
12430 #endif
12431 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12433 EMSG2(_(e_listarg), "inputlist()");
12434 return;
12437 msg_start();
12438 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12439 lines_left = Rows; /* avoid more prompt */
12440 msg_scroll = TRUE;
12441 msg_clr_eos();
12443 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12445 msg_puts(get_tv_string(&li->li_tv));
12446 msg_putchar('\n');
12449 /* Ask for choice. */
12450 selected = prompt_for_number(&mouse_used);
12451 if (mouse_used)
12452 selected -= lines_left;
12454 rettv->vval.v_number = selected;
12458 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12461 * "inputrestore()" function
12463 static void
12464 f_inputrestore(argvars, rettv)
12465 typval_T *argvars UNUSED;
12466 typval_T *rettv;
12468 if (ga_userinput.ga_len > 0)
12470 --ga_userinput.ga_len;
12471 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12472 + ga_userinput.ga_len);
12473 /* default return is zero == OK */
12475 else if (p_verbose > 1)
12477 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12478 rettv->vval.v_number = 1; /* Failed */
12483 * "inputsave()" function
12485 static void
12486 f_inputsave(argvars, rettv)
12487 typval_T *argvars UNUSED;
12488 typval_T *rettv;
12490 /* Add an entry to the stack of typeahead storage. */
12491 if (ga_grow(&ga_userinput, 1) == OK)
12493 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12494 + ga_userinput.ga_len);
12495 ++ga_userinput.ga_len;
12496 /* default return is zero == OK */
12498 else
12499 rettv->vval.v_number = 1; /* Failed */
12503 * "inputsecret()" function
12505 static void
12506 f_inputsecret(argvars, rettv)
12507 typval_T *argvars;
12508 typval_T *rettv;
12510 ++cmdline_star;
12511 ++inputsecret_flag;
12512 f_input(argvars, rettv);
12513 --cmdline_star;
12514 --inputsecret_flag;
12518 * "insert()" function
12520 static void
12521 f_insert(argvars, rettv)
12522 typval_T *argvars;
12523 typval_T *rettv;
12525 long before = 0;
12526 listitem_T *item;
12527 list_T *l;
12528 int error = FALSE;
12530 if (argvars[0].v_type != VAR_LIST)
12531 EMSG2(_(e_listarg), "insert()");
12532 else if ((l = argvars[0].vval.v_list) != NULL
12533 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12535 if (argvars[2].v_type != VAR_UNKNOWN)
12536 before = get_tv_number_chk(&argvars[2], &error);
12537 if (error)
12538 return; /* type error; errmsg already given */
12540 if (before == l->lv_len)
12541 item = NULL;
12542 else
12544 item = list_find(l, before);
12545 if (item == NULL)
12547 EMSGN(_(e_listidx), before);
12548 l = NULL;
12551 if (l != NULL)
12553 list_insert_tv(l, &argvars[1], item);
12554 copy_tv(&argvars[0], rettv);
12560 * "isdirectory()" function
12562 static void
12563 f_isdirectory(argvars, rettv)
12564 typval_T *argvars;
12565 typval_T *rettv;
12567 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12571 * "islocked()" function
12573 static void
12574 f_islocked(argvars, rettv)
12575 typval_T *argvars;
12576 typval_T *rettv;
12578 lval_T lv;
12579 char_u *end;
12580 dictitem_T *di;
12582 rettv->vval.v_number = -1;
12583 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12584 FNE_CHECK_START);
12585 if (end != NULL && lv.ll_name != NULL)
12587 if (*end != NUL)
12588 EMSG(_(e_trailing));
12589 else
12591 if (lv.ll_tv == NULL)
12593 if (check_changedtick(lv.ll_name))
12594 rettv->vval.v_number = 1; /* always locked */
12595 else
12597 di = find_var(lv.ll_name, NULL);
12598 if (di != NULL)
12600 /* Consider a variable locked when:
12601 * 1. the variable itself is locked
12602 * 2. the value of the variable is locked.
12603 * 3. the List or Dict value is locked.
12605 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12606 || tv_islocked(&di->di_tv));
12610 else if (lv.ll_range)
12611 EMSG(_("E786: Range not allowed"));
12612 else if (lv.ll_newkey != NULL)
12613 EMSG2(_(e_dictkey), lv.ll_newkey);
12614 else if (lv.ll_list != NULL)
12615 /* List item. */
12616 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12617 else
12618 /* Dictionary item. */
12619 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12623 clear_lval(&lv);
12626 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12629 * Turn a dict into a list:
12630 * "what" == 0: list of keys
12631 * "what" == 1: list of values
12632 * "what" == 2: list of items
12634 static void
12635 dict_list(argvars, rettv, what)
12636 typval_T *argvars;
12637 typval_T *rettv;
12638 int what;
12640 list_T *l2;
12641 dictitem_T *di;
12642 hashitem_T *hi;
12643 listitem_T *li;
12644 listitem_T *li2;
12645 dict_T *d;
12646 int todo;
12648 if (argvars[0].v_type != VAR_DICT)
12650 EMSG(_(e_dictreq));
12651 return;
12653 if ((d = argvars[0].vval.v_dict) == NULL)
12654 return;
12656 if (rettv_list_alloc(rettv) == FAIL)
12657 return;
12659 todo = (int)d->dv_hashtab.ht_used;
12660 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12662 if (!HASHITEM_EMPTY(hi))
12664 --todo;
12665 di = HI2DI(hi);
12667 li = listitem_alloc();
12668 if (li == NULL)
12669 break;
12670 list_append(rettv->vval.v_list, li);
12672 if (what == 0)
12674 /* keys() */
12675 li->li_tv.v_type = VAR_STRING;
12676 li->li_tv.v_lock = 0;
12677 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12679 else if (what == 1)
12681 /* values() */
12682 copy_tv(&di->di_tv, &li->li_tv);
12684 else
12686 /* items() */
12687 l2 = list_alloc();
12688 li->li_tv.v_type = VAR_LIST;
12689 li->li_tv.v_lock = 0;
12690 li->li_tv.vval.v_list = l2;
12691 if (l2 == NULL)
12692 break;
12693 ++l2->lv_refcount;
12695 li2 = listitem_alloc();
12696 if (li2 == NULL)
12697 break;
12698 list_append(l2, li2);
12699 li2->li_tv.v_type = VAR_STRING;
12700 li2->li_tv.v_lock = 0;
12701 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12703 li2 = listitem_alloc();
12704 if (li2 == NULL)
12705 break;
12706 list_append(l2, li2);
12707 copy_tv(&di->di_tv, &li2->li_tv);
12714 * "items(dict)" function
12716 static void
12717 f_items(argvars, rettv)
12718 typval_T *argvars;
12719 typval_T *rettv;
12721 dict_list(argvars, rettv, 2);
12725 * "join()" function
12727 static void
12728 f_join(argvars, rettv)
12729 typval_T *argvars;
12730 typval_T *rettv;
12732 garray_T ga;
12733 char_u *sep;
12735 if (argvars[0].v_type != VAR_LIST)
12737 EMSG(_(e_listreq));
12738 return;
12740 if (argvars[0].vval.v_list == NULL)
12741 return;
12742 if (argvars[1].v_type == VAR_UNKNOWN)
12743 sep = (char_u *)" ";
12744 else
12745 sep = get_tv_string_chk(&argvars[1]);
12747 rettv->v_type = VAR_STRING;
12749 if (sep != NULL)
12751 ga_init2(&ga, (int)sizeof(char), 80);
12752 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12753 ga_append(&ga, NUL);
12754 rettv->vval.v_string = (char_u *)ga.ga_data;
12756 else
12757 rettv->vval.v_string = NULL;
12761 * "keys()" function
12763 static void
12764 f_keys(argvars, rettv)
12765 typval_T *argvars;
12766 typval_T *rettv;
12768 dict_list(argvars, rettv, 0);
12772 * "last_buffer_nr()" function.
12774 static void
12775 f_last_buffer_nr(argvars, rettv)
12776 typval_T *argvars UNUSED;
12777 typval_T *rettv;
12779 int n = 0;
12780 buf_T *buf;
12782 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12783 if (n < buf->b_fnum)
12784 n = buf->b_fnum;
12786 rettv->vval.v_number = n;
12790 * "len()" function
12792 static void
12793 f_len(argvars, rettv)
12794 typval_T *argvars;
12795 typval_T *rettv;
12797 switch (argvars[0].v_type)
12799 case VAR_STRING:
12800 case VAR_NUMBER:
12801 rettv->vval.v_number = (varnumber_T)STRLEN(
12802 get_tv_string(&argvars[0]));
12803 break;
12804 case VAR_LIST:
12805 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12806 break;
12807 case VAR_DICT:
12808 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12809 break;
12810 default:
12811 EMSG(_("E701: Invalid type for len()"));
12812 break;
12816 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12818 static void
12819 libcall_common(argvars, rettv, type)
12820 typval_T *argvars;
12821 typval_T *rettv;
12822 int type;
12824 #ifdef FEAT_LIBCALL
12825 char_u *string_in;
12826 char_u **string_result;
12827 int nr_result;
12828 #endif
12830 rettv->v_type = type;
12831 if (type != VAR_NUMBER)
12832 rettv->vval.v_string = NULL;
12834 if (check_restricted() || check_secure())
12835 return;
12837 #ifdef FEAT_LIBCALL
12838 /* The first two args must be strings, otherwise its meaningless */
12839 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12841 string_in = NULL;
12842 if (argvars[2].v_type == VAR_STRING)
12843 string_in = argvars[2].vval.v_string;
12844 if (type == VAR_NUMBER)
12845 string_result = NULL;
12846 else
12847 string_result = &rettv->vval.v_string;
12848 if (mch_libcall(argvars[0].vval.v_string,
12849 argvars[1].vval.v_string,
12850 string_in,
12851 argvars[2].vval.v_number,
12852 string_result,
12853 &nr_result) == OK
12854 && type == VAR_NUMBER)
12855 rettv->vval.v_number = nr_result;
12857 #endif
12861 * "libcall()" function
12863 static void
12864 f_libcall(argvars, rettv)
12865 typval_T *argvars;
12866 typval_T *rettv;
12868 libcall_common(argvars, rettv, VAR_STRING);
12872 * "libcallnr()" function
12874 static void
12875 f_libcallnr(argvars, rettv)
12876 typval_T *argvars;
12877 typval_T *rettv;
12879 libcall_common(argvars, rettv, VAR_NUMBER);
12883 * "line(string)" function
12885 static void
12886 f_line(argvars, rettv)
12887 typval_T *argvars;
12888 typval_T *rettv;
12890 linenr_T lnum = 0;
12891 pos_T *fp;
12892 int fnum;
12894 fp = var2fpos(&argvars[0], TRUE, &fnum);
12895 if (fp != NULL)
12896 lnum = fp->lnum;
12897 rettv->vval.v_number = lnum;
12901 * "line2byte(lnum)" function
12903 static void
12904 f_line2byte(argvars, rettv)
12905 typval_T *argvars UNUSED;
12906 typval_T *rettv;
12908 #ifndef FEAT_BYTEOFF
12909 rettv->vval.v_number = -1;
12910 #else
12911 linenr_T lnum;
12913 lnum = get_tv_lnum(argvars);
12914 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12915 rettv->vval.v_number = -1;
12916 else
12917 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12918 if (rettv->vval.v_number >= 0)
12919 ++rettv->vval.v_number;
12920 #endif
12924 * "lispindent(lnum)" function
12926 static void
12927 f_lispindent(argvars, rettv)
12928 typval_T *argvars;
12929 typval_T *rettv;
12931 #ifdef FEAT_LISP
12932 pos_T pos;
12933 linenr_T lnum;
12935 pos = curwin->w_cursor;
12936 lnum = get_tv_lnum(argvars);
12937 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12939 curwin->w_cursor.lnum = lnum;
12940 rettv->vval.v_number = get_lisp_indent();
12941 curwin->w_cursor = pos;
12943 else
12944 #endif
12945 rettv->vval.v_number = -1;
12949 * "localtime()" function
12951 static void
12952 f_localtime(argvars, rettv)
12953 typval_T *argvars UNUSED;
12954 typval_T *rettv;
12956 rettv->vval.v_number = (varnumber_T)time(NULL);
12959 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12961 static void
12962 get_maparg(argvars, rettv, exact)
12963 typval_T *argvars;
12964 typval_T *rettv;
12965 int exact;
12967 char_u *keys;
12968 char_u *which;
12969 char_u buf[NUMBUFLEN];
12970 char_u *keys_buf = NULL;
12971 char_u *rhs;
12972 int mode;
12973 garray_T ga;
12974 int abbr = FALSE;
12976 /* return empty string for failure */
12977 rettv->v_type = VAR_STRING;
12978 rettv->vval.v_string = NULL;
12980 keys = get_tv_string(&argvars[0]);
12981 if (*keys == NUL)
12982 return;
12984 if (argvars[1].v_type != VAR_UNKNOWN)
12986 which = get_tv_string_buf_chk(&argvars[1], buf);
12987 if (argvars[2].v_type != VAR_UNKNOWN)
12988 abbr = get_tv_number(&argvars[2]);
12990 else
12991 which = (char_u *)"";
12992 if (which == NULL)
12993 return;
12995 mode = get_map_mode(&which, 0);
12997 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12998 rhs = check_map(keys, mode, exact, FALSE, abbr);
12999 vim_free(keys_buf);
13000 if (rhs != NULL)
13002 ga_init(&ga);
13003 ga.ga_itemsize = 1;
13004 ga.ga_growsize = 40;
13006 while (*rhs != NUL)
13007 ga_concat(&ga, str2special(&rhs, FALSE));
13009 ga_append(&ga, NUL);
13010 rettv->vval.v_string = (char_u *)ga.ga_data;
13014 #ifdef FEAT_FLOAT
13016 * "log10()" function
13018 static void
13019 f_log10(argvars, rettv)
13020 typval_T *argvars;
13021 typval_T *rettv;
13023 float_T f;
13025 rettv->v_type = VAR_FLOAT;
13026 if (get_float_arg(argvars, &f) == OK)
13027 rettv->vval.v_float = log10(f);
13028 else
13029 rettv->vval.v_float = 0.0;
13031 #endif
13034 * "map()" function
13036 static void
13037 f_map(argvars, rettv)
13038 typval_T *argvars;
13039 typval_T *rettv;
13041 filter_map(argvars, rettv, TRUE);
13045 * "maparg()" function
13047 static void
13048 f_maparg(argvars, rettv)
13049 typval_T *argvars;
13050 typval_T *rettv;
13052 get_maparg(argvars, rettv, TRUE);
13056 * "mapcheck()" function
13058 static void
13059 f_mapcheck(argvars, rettv)
13060 typval_T *argvars;
13061 typval_T *rettv;
13063 get_maparg(argvars, rettv, FALSE);
13066 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13068 static void
13069 find_some_match(argvars, rettv, type)
13070 typval_T *argvars;
13071 typval_T *rettv;
13072 int type;
13074 char_u *str = NULL;
13075 char_u *expr = NULL;
13076 char_u *pat;
13077 regmatch_T regmatch;
13078 char_u patbuf[NUMBUFLEN];
13079 char_u strbuf[NUMBUFLEN];
13080 char_u *save_cpo;
13081 long start = 0;
13082 long nth = 1;
13083 colnr_T startcol = 0;
13084 int match = 0;
13085 list_T *l = NULL;
13086 listitem_T *li = NULL;
13087 long idx = 0;
13088 char_u *tofree = NULL;
13090 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13091 save_cpo = p_cpo;
13092 p_cpo = (char_u *)"";
13094 rettv->vval.v_number = -1;
13095 if (type == 3)
13097 /* return empty list when there are no matches */
13098 if (rettv_list_alloc(rettv) == FAIL)
13099 goto theend;
13101 else if (type == 2)
13103 rettv->v_type = VAR_STRING;
13104 rettv->vval.v_string = NULL;
13107 if (argvars[0].v_type == VAR_LIST)
13109 if ((l = argvars[0].vval.v_list) == NULL)
13110 goto theend;
13111 li = l->lv_first;
13113 else
13114 expr = str = get_tv_string(&argvars[0]);
13116 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13117 if (pat == NULL)
13118 goto theend;
13120 if (argvars[2].v_type != VAR_UNKNOWN)
13122 int error = FALSE;
13124 start = get_tv_number_chk(&argvars[2], &error);
13125 if (error)
13126 goto theend;
13127 if (l != NULL)
13129 li = list_find(l, start);
13130 if (li == NULL)
13131 goto theend;
13132 idx = l->lv_idx; /* use the cached index */
13134 else
13136 if (start < 0)
13137 start = 0;
13138 if (start > (long)STRLEN(str))
13139 goto theend;
13140 /* When "count" argument is there ignore matches before "start",
13141 * otherwise skip part of the string. Differs when pattern is "^"
13142 * or "\<". */
13143 if (argvars[3].v_type != VAR_UNKNOWN)
13144 startcol = start;
13145 else
13146 str += start;
13149 if (argvars[3].v_type != VAR_UNKNOWN)
13150 nth = get_tv_number_chk(&argvars[3], &error);
13151 if (error)
13152 goto theend;
13155 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13156 if (regmatch.regprog != NULL)
13158 regmatch.rm_ic = p_ic;
13160 for (;;)
13162 if (l != NULL)
13164 if (li == NULL)
13166 match = FALSE;
13167 break;
13169 vim_free(tofree);
13170 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13171 if (str == NULL)
13172 break;
13175 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13177 if (match && --nth <= 0)
13178 break;
13179 if (l == NULL && !match)
13180 break;
13182 /* Advance to just after the match. */
13183 if (l != NULL)
13185 li = li->li_next;
13186 ++idx;
13188 else
13190 #ifdef FEAT_MBYTE
13191 startcol = (colnr_T)(regmatch.startp[0]
13192 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13193 #else
13194 startcol = regmatch.startp[0] + 1 - str;
13195 #endif
13199 if (match)
13201 if (type == 3)
13203 int i;
13205 /* return list with matched string and submatches */
13206 for (i = 0; i < NSUBEXP; ++i)
13208 if (regmatch.endp[i] == NULL)
13210 if (list_append_string(rettv->vval.v_list,
13211 (char_u *)"", 0) == FAIL)
13212 break;
13214 else if (list_append_string(rettv->vval.v_list,
13215 regmatch.startp[i],
13216 (int)(regmatch.endp[i] - regmatch.startp[i]))
13217 == FAIL)
13218 break;
13221 else if (type == 2)
13223 /* return matched string */
13224 if (l != NULL)
13225 copy_tv(&li->li_tv, rettv);
13226 else
13227 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13228 (int)(regmatch.endp[0] - regmatch.startp[0]));
13230 else if (l != NULL)
13231 rettv->vval.v_number = idx;
13232 else
13234 if (type != 0)
13235 rettv->vval.v_number =
13236 (varnumber_T)(regmatch.startp[0] - str);
13237 else
13238 rettv->vval.v_number =
13239 (varnumber_T)(regmatch.endp[0] - str);
13240 rettv->vval.v_number += (varnumber_T)(str - expr);
13243 vim_free(regmatch.regprog);
13246 theend:
13247 vim_free(tofree);
13248 p_cpo = save_cpo;
13252 * "match()" function
13254 static void
13255 f_match(argvars, rettv)
13256 typval_T *argvars;
13257 typval_T *rettv;
13259 find_some_match(argvars, rettv, 1);
13263 * "matchadd()" function
13265 static void
13266 f_matchadd(argvars, rettv)
13267 typval_T *argvars;
13268 typval_T *rettv;
13270 #ifdef FEAT_SEARCH_EXTRA
13271 char_u buf[NUMBUFLEN];
13272 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13273 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13274 int prio = 10; /* default priority */
13275 int id = -1;
13276 int error = FALSE;
13278 rettv->vval.v_number = -1;
13280 if (grp == NULL || pat == NULL)
13281 return;
13282 if (argvars[2].v_type != VAR_UNKNOWN)
13284 prio = get_tv_number_chk(&argvars[2], &error);
13285 if (argvars[3].v_type != VAR_UNKNOWN)
13286 id = get_tv_number_chk(&argvars[3], &error);
13288 if (error == TRUE)
13289 return;
13290 if (id >= 1 && id <= 3)
13292 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13293 return;
13296 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13297 #endif
13301 * "matcharg()" function
13303 static void
13304 f_matcharg(argvars, rettv)
13305 typval_T *argvars;
13306 typval_T *rettv;
13308 if (rettv_list_alloc(rettv) == OK)
13310 #ifdef FEAT_SEARCH_EXTRA
13311 int id = get_tv_number(&argvars[0]);
13312 matchitem_T *m;
13314 if (id >= 1 && id <= 3)
13316 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13318 list_append_string(rettv->vval.v_list,
13319 syn_id2name(m->hlg_id), -1);
13320 list_append_string(rettv->vval.v_list, m->pattern, -1);
13322 else
13324 list_append_string(rettv->vval.v_list, NUL, -1);
13325 list_append_string(rettv->vval.v_list, NUL, -1);
13328 #endif
13333 * "matchdelete()" function
13335 static void
13336 f_matchdelete(argvars, rettv)
13337 typval_T *argvars;
13338 typval_T *rettv;
13340 #ifdef FEAT_SEARCH_EXTRA
13341 rettv->vval.v_number = match_delete(curwin,
13342 (int)get_tv_number(&argvars[0]), TRUE);
13343 #endif
13347 * "matchend()" function
13349 static void
13350 f_matchend(argvars, rettv)
13351 typval_T *argvars;
13352 typval_T *rettv;
13354 find_some_match(argvars, rettv, 0);
13358 * "matchlist()" function
13360 static void
13361 f_matchlist(argvars, rettv)
13362 typval_T *argvars;
13363 typval_T *rettv;
13365 find_some_match(argvars, rettv, 3);
13369 * "matchstr()" function
13371 static void
13372 f_matchstr(argvars, rettv)
13373 typval_T *argvars;
13374 typval_T *rettv;
13376 find_some_match(argvars, rettv, 2);
13379 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13381 static void
13382 max_min(argvars, rettv, domax)
13383 typval_T *argvars;
13384 typval_T *rettv;
13385 int domax;
13387 long n = 0;
13388 long i;
13389 int error = FALSE;
13391 if (argvars[0].v_type == VAR_LIST)
13393 list_T *l;
13394 listitem_T *li;
13396 l = argvars[0].vval.v_list;
13397 if (l != NULL)
13399 li = l->lv_first;
13400 if (li != NULL)
13402 n = get_tv_number_chk(&li->li_tv, &error);
13403 for (;;)
13405 li = li->li_next;
13406 if (li == NULL)
13407 break;
13408 i = get_tv_number_chk(&li->li_tv, &error);
13409 if (domax ? i > n : i < n)
13410 n = i;
13415 else if (argvars[0].v_type == VAR_DICT)
13417 dict_T *d;
13418 int first = TRUE;
13419 hashitem_T *hi;
13420 int todo;
13422 d = argvars[0].vval.v_dict;
13423 if (d != NULL)
13425 todo = (int)d->dv_hashtab.ht_used;
13426 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13428 if (!HASHITEM_EMPTY(hi))
13430 --todo;
13431 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13432 if (first)
13434 n = i;
13435 first = FALSE;
13437 else if (domax ? i > n : i < n)
13438 n = i;
13443 else
13444 EMSG(_(e_listdictarg));
13445 rettv->vval.v_number = error ? 0 : n;
13449 * "max()" function
13451 static void
13452 f_max(argvars, rettv)
13453 typval_T *argvars;
13454 typval_T *rettv;
13456 max_min(argvars, rettv, TRUE);
13460 * "min()" function
13462 static void
13463 f_min(argvars, rettv)
13464 typval_T *argvars;
13465 typval_T *rettv;
13467 max_min(argvars, rettv, FALSE);
13470 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13473 * Create the directory in which "dir" is located, and higher levels when
13474 * needed.
13476 static int
13477 mkdir_recurse(dir, prot)
13478 char_u *dir;
13479 int prot;
13481 char_u *p;
13482 char_u *updir;
13483 int r = FAIL;
13485 /* Get end of directory name in "dir".
13486 * We're done when it's "/" or "c:/". */
13487 p = gettail_sep(dir);
13488 if (p <= get_past_head(dir))
13489 return OK;
13491 /* If the directory exists we're done. Otherwise: create it.*/
13492 updir = vim_strnsave(dir, (int)(p - dir));
13493 if (updir == NULL)
13494 return FAIL;
13495 if (mch_isdir(updir))
13496 r = OK;
13497 else if (mkdir_recurse(updir, prot) == OK)
13498 r = vim_mkdir_emsg(updir, prot);
13499 vim_free(updir);
13500 return r;
13503 #ifdef vim_mkdir
13505 * "mkdir()" function
13507 static void
13508 f_mkdir(argvars, rettv)
13509 typval_T *argvars;
13510 typval_T *rettv;
13512 char_u *dir;
13513 char_u buf[NUMBUFLEN];
13514 int prot = 0755;
13516 rettv->vval.v_number = FAIL;
13517 if (check_restricted() || check_secure())
13518 return;
13520 dir = get_tv_string_buf(&argvars[0], buf);
13521 if (argvars[1].v_type != VAR_UNKNOWN)
13523 if (argvars[2].v_type != VAR_UNKNOWN)
13524 prot = get_tv_number_chk(&argvars[2], NULL);
13525 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13526 mkdir_recurse(dir, prot);
13528 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13530 #endif
13533 * "mode()" function
13535 static void
13536 f_mode(argvars, rettv)
13537 typval_T *argvars;
13538 typval_T *rettv;
13540 char_u buf[3];
13542 buf[1] = NUL;
13543 buf[2] = NUL;
13545 #ifdef FEAT_VISUAL
13546 if (VIsual_active)
13548 if (VIsual_select)
13549 buf[0] = VIsual_mode + 's' - 'v';
13550 else
13551 buf[0] = VIsual_mode;
13553 else
13554 #endif
13555 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13556 || State == CONFIRM)
13558 buf[0] = 'r';
13559 if (State == ASKMORE)
13560 buf[1] = 'm';
13561 else if (State == CONFIRM)
13562 buf[1] = '?';
13564 else if (State == EXTERNCMD)
13565 buf[0] = '!';
13566 else if (State & INSERT)
13568 #ifdef FEAT_VREPLACE
13569 if (State & VREPLACE_FLAG)
13571 buf[0] = 'R';
13572 buf[1] = 'v';
13574 else
13575 #endif
13576 if (State & REPLACE_FLAG)
13577 buf[0] = 'R';
13578 else
13579 buf[0] = 'i';
13581 else if (State & CMDLINE)
13583 buf[0] = 'c';
13584 if (exmode_active)
13585 buf[1] = 'v';
13587 else if (exmode_active)
13589 buf[0] = 'c';
13590 buf[1] = 'e';
13592 else
13594 buf[0] = 'n';
13595 if (finish_op)
13596 buf[1] = 'o';
13599 /* Clear out the minor mode when the argument is not a non-zero number or
13600 * non-empty string. */
13601 if (!non_zero_arg(&argvars[0]))
13602 buf[1] = NUL;
13604 rettv->vval.v_string = vim_strsave(buf);
13605 rettv->v_type = VAR_STRING;
13608 #ifdef FEAT_MZSCHEME
13610 * "mzeval()" function
13612 static void
13613 f_mzeval(argvars, rettv)
13614 typval_T *argvars;
13615 typval_T *rettv;
13617 char_u *str;
13618 char_u buf[NUMBUFLEN];
13620 str = get_tv_string_buf(&argvars[0], buf);
13621 do_mzeval(str, rettv);
13623 #endif
13626 * "nextnonblank()" function
13628 static void
13629 f_nextnonblank(argvars, rettv)
13630 typval_T *argvars;
13631 typval_T *rettv;
13633 linenr_T lnum;
13635 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13637 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13639 lnum = 0;
13640 break;
13642 if (*skipwhite(ml_get(lnum)) != NUL)
13643 break;
13645 rettv->vval.v_number = lnum;
13649 * "nr2char()" function
13651 static void
13652 f_nr2char(argvars, rettv)
13653 typval_T *argvars;
13654 typval_T *rettv;
13656 char_u buf[NUMBUFLEN];
13658 #ifdef FEAT_MBYTE
13659 if (has_mbyte)
13660 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13661 else
13662 #endif
13664 buf[0] = (char_u)get_tv_number(&argvars[0]);
13665 buf[1] = NUL;
13667 rettv->v_type = VAR_STRING;
13668 rettv->vval.v_string = vim_strsave(buf);
13672 * "pathshorten()" function
13674 static void
13675 f_pathshorten(argvars, rettv)
13676 typval_T *argvars;
13677 typval_T *rettv;
13679 char_u *p;
13681 rettv->v_type = VAR_STRING;
13682 p = get_tv_string_chk(&argvars[0]);
13683 if (p == NULL)
13684 rettv->vval.v_string = NULL;
13685 else
13687 p = vim_strsave(p);
13688 rettv->vval.v_string = p;
13689 if (p != NULL)
13690 shorten_dir(p);
13694 #ifdef FEAT_FLOAT
13696 * "pow()" function
13698 static void
13699 f_pow(argvars, rettv)
13700 typval_T *argvars;
13701 typval_T *rettv;
13703 float_T fx, fy;
13705 rettv->v_type = VAR_FLOAT;
13706 if (get_float_arg(argvars, &fx) == OK
13707 && get_float_arg(&argvars[1], &fy) == OK)
13708 rettv->vval.v_float = pow(fx, fy);
13709 else
13710 rettv->vval.v_float = 0.0;
13712 #endif
13715 * "prevnonblank()" function
13717 static void
13718 f_prevnonblank(argvars, rettv)
13719 typval_T *argvars;
13720 typval_T *rettv;
13722 linenr_T lnum;
13724 lnum = get_tv_lnum(argvars);
13725 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13726 lnum = 0;
13727 else
13728 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13729 --lnum;
13730 rettv->vval.v_number = lnum;
13733 #ifdef HAVE_STDARG_H
13734 /* This dummy va_list is here because:
13735 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13736 * - locally in the function results in a "used before set" warning
13737 * - using va_start() to initialize it gives "function with fixed args" error */
13738 static va_list ap;
13739 #endif
13742 * "printf()" function
13744 static void
13745 f_printf(argvars, rettv)
13746 typval_T *argvars;
13747 typval_T *rettv;
13749 rettv->v_type = VAR_STRING;
13750 rettv->vval.v_string = NULL;
13751 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13753 char_u buf[NUMBUFLEN];
13754 int len;
13755 char_u *s;
13756 int saved_did_emsg = did_emsg;
13757 char *fmt;
13759 /* Get the required length, allocate the buffer and do it for real. */
13760 did_emsg = FALSE;
13761 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13762 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13763 if (!did_emsg)
13765 s = alloc(len + 1);
13766 if (s != NULL)
13768 rettv->vval.v_string = s;
13769 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13772 did_emsg |= saved_did_emsg;
13774 #endif
13778 * "pumvisible()" function
13780 static void
13781 f_pumvisible(argvars, rettv)
13782 typval_T *argvars UNUSED;
13783 typval_T *rettv UNUSED;
13785 #ifdef FEAT_INS_EXPAND
13786 if (pum_visible())
13787 rettv->vval.v_number = 1;
13788 #endif
13792 * "range()" function
13794 static void
13795 f_range(argvars, rettv)
13796 typval_T *argvars;
13797 typval_T *rettv;
13799 long start;
13800 long end;
13801 long stride = 1;
13802 long i;
13803 int error = FALSE;
13805 start = get_tv_number_chk(&argvars[0], &error);
13806 if (argvars[1].v_type == VAR_UNKNOWN)
13808 end = start - 1;
13809 start = 0;
13811 else
13813 end = get_tv_number_chk(&argvars[1], &error);
13814 if (argvars[2].v_type != VAR_UNKNOWN)
13815 stride = get_tv_number_chk(&argvars[2], &error);
13818 if (error)
13819 return; /* type error; errmsg already given */
13820 if (stride == 0)
13821 EMSG(_("E726: Stride is zero"));
13822 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13823 EMSG(_("E727: Start past end"));
13824 else
13826 if (rettv_list_alloc(rettv) == OK)
13827 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13828 if (list_append_number(rettv->vval.v_list,
13829 (varnumber_T)i) == FAIL)
13830 break;
13835 * "readfile()" function
13837 static void
13838 f_readfile(argvars, rettv)
13839 typval_T *argvars;
13840 typval_T *rettv;
13842 int binary = FALSE;
13843 char_u *fname;
13844 FILE *fd;
13845 listitem_T *li;
13846 #define FREAD_SIZE 200 /* optimized for text lines */
13847 char_u buf[FREAD_SIZE];
13848 int readlen; /* size of last fread() */
13849 int buflen; /* nr of valid chars in buf[] */
13850 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13851 int tolist; /* first byte in buf[] still to be put in list */
13852 int chop; /* how many CR to chop off */
13853 char_u *prev = NULL; /* previously read bytes, if any */
13854 int prevlen = 0; /* length of "prev" if not NULL */
13855 char_u *s;
13856 int len;
13857 long maxline = MAXLNUM;
13858 long cnt = 0;
13860 if (argvars[1].v_type != VAR_UNKNOWN)
13862 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13863 binary = TRUE;
13864 if (argvars[2].v_type != VAR_UNKNOWN)
13865 maxline = get_tv_number(&argvars[2]);
13868 if (rettv_list_alloc(rettv) == FAIL)
13869 return;
13871 /* Always open the file in binary mode, library functions have a mind of
13872 * their own about CR-LF conversion. */
13873 fname = get_tv_string(&argvars[0]);
13874 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13876 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13877 return;
13880 filtd = 0;
13881 while (cnt < maxline || maxline < 0)
13883 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13884 buflen = filtd + readlen;
13885 tolist = 0;
13886 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13888 if (buf[filtd] == '\n' || readlen <= 0)
13890 /* Only when in binary mode add an empty list item when the
13891 * last line ends in a '\n'. */
13892 if (!binary && readlen == 0 && filtd == 0)
13893 break;
13895 /* Found end-of-line or end-of-file: add a text line to the
13896 * list. */
13897 chop = 0;
13898 if (!binary)
13899 while (filtd - chop - 1 >= tolist
13900 && buf[filtd - chop - 1] == '\r')
13901 ++chop;
13902 len = filtd - tolist - chop;
13903 if (prev == NULL)
13904 s = vim_strnsave(buf + tolist, len);
13905 else
13907 s = alloc((unsigned)(prevlen + len + 1));
13908 if (s != NULL)
13910 mch_memmove(s, prev, prevlen);
13911 vim_free(prev);
13912 prev = NULL;
13913 mch_memmove(s + prevlen, buf + tolist, len);
13914 s[prevlen + len] = NUL;
13917 tolist = filtd + 1;
13919 li = listitem_alloc();
13920 if (li == NULL)
13922 vim_free(s);
13923 break;
13925 li->li_tv.v_type = VAR_STRING;
13926 li->li_tv.v_lock = 0;
13927 li->li_tv.vval.v_string = s;
13928 list_append(rettv->vval.v_list, li);
13930 if (++cnt >= maxline && maxline >= 0)
13931 break;
13932 if (readlen <= 0)
13933 break;
13935 else if (buf[filtd] == NUL)
13936 buf[filtd] = '\n';
13938 if (readlen <= 0)
13939 break;
13941 if (tolist == 0)
13943 /* "buf" is full, need to move text to an allocated buffer */
13944 if (prev == NULL)
13946 prev = vim_strnsave(buf, buflen);
13947 prevlen = buflen;
13949 else
13951 s = alloc((unsigned)(prevlen + buflen));
13952 if (s != NULL)
13954 mch_memmove(s, prev, prevlen);
13955 mch_memmove(s + prevlen, buf, buflen);
13956 vim_free(prev);
13957 prev = s;
13958 prevlen += buflen;
13961 filtd = 0;
13963 else
13965 mch_memmove(buf, buf + tolist, buflen - tolist);
13966 filtd -= tolist;
13971 * For a negative line count use only the lines at the end of the file,
13972 * free the rest.
13974 if (maxline < 0)
13975 while (cnt > -maxline)
13977 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13978 --cnt;
13981 vim_free(prev);
13982 fclose(fd);
13985 #if defined(FEAT_RELTIME)
13986 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13989 * Convert a List to proftime_T.
13990 * Return FAIL when there is something wrong.
13992 static int
13993 list2proftime(arg, tm)
13994 typval_T *arg;
13995 proftime_T *tm;
13997 long n1, n2;
13998 int error = FALSE;
14000 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
14001 || arg->vval.v_list->lv_len != 2)
14002 return FAIL;
14003 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
14004 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
14005 # ifdef WIN3264
14006 tm->HighPart = n1;
14007 tm->LowPart = n2;
14008 # else
14009 tm->tv_sec = n1;
14010 tm->tv_usec = n2;
14011 # endif
14012 return error ? FAIL : OK;
14014 #endif /* FEAT_RELTIME */
14017 * "reltime()" function
14019 static void
14020 f_reltime(argvars, rettv)
14021 typval_T *argvars;
14022 typval_T *rettv;
14024 #ifdef FEAT_RELTIME
14025 proftime_T res;
14026 proftime_T start;
14028 if (argvars[0].v_type == VAR_UNKNOWN)
14030 /* No arguments: get current time. */
14031 profile_start(&res);
14033 else if (argvars[1].v_type == VAR_UNKNOWN)
14035 if (list2proftime(&argvars[0], &res) == FAIL)
14036 return;
14037 profile_end(&res);
14039 else
14041 /* Two arguments: compute the difference. */
14042 if (list2proftime(&argvars[0], &start) == FAIL
14043 || list2proftime(&argvars[1], &res) == FAIL)
14044 return;
14045 profile_sub(&res, &start);
14048 if (rettv_list_alloc(rettv) == OK)
14050 long n1, n2;
14052 # ifdef WIN3264
14053 n1 = res.HighPart;
14054 n2 = res.LowPart;
14055 # else
14056 n1 = res.tv_sec;
14057 n2 = res.tv_usec;
14058 # endif
14059 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14060 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14062 #endif
14066 * "reltimestr()" function
14068 static void
14069 f_reltimestr(argvars, rettv)
14070 typval_T *argvars;
14071 typval_T *rettv;
14073 #ifdef FEAT_RELTIME
14074 proftime_T tm;
14075 #endif
14077 rettv->v_type = VAR_STRING;
14078 rettv->vval.v_string = NULL;
14079 #ifdef FEAT_RELTIME
14080 if (list2proftime(&argvars[0], &tm) == OK)
14081 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14082 #endif
14085 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14086 static void make_connection __ARGS((void));
14087 static int check_connection __ARGS((void));
14089 static void
14090 make_connection()
14092 if (X_DISPLAY == NULL
14093 # ifdef FEAT_GUI
14094 && !gui.in_use
14095 # endif
14098 x_force_connect = TRUE;
14099 setup_term_clip();
14100 x_force_connect = FALSE;
14104 static int
14105 check_connection()
14107 make_connection();
14108 if (X_DISPLAY == NULL)
14110 EMSG(_("E240: No connection to Vim server"));
14111 return FAIL;
14113 return OK;
14115 #endif
14117 #ifdef FEAT_CLIENTSERVER
14118 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14120 static void
14121 remote_common(argvars, rettv, expr)
14122 typval_T *argvars;
14123 typval_T *rettv;
14124 int expr;
14126 char_u *server_name;
14127 char_u *keys;
14128 char_u *r = NULL;
14129 char_u buf[NUMBUFLEN];
14130 # ifdef WIN32
14131 HWND w;
14132 # elif defined(FEAT_X11)
14133 Window w;
14134 # elif defined(MAC_CLIENTSERVER)
14135 int w; // This is the port number ('w' is a bit confusing)
14136 # endif
14138 if (check_restricted() || check_secure())
14139 return;
14141 # ifdef FEAT_X11
14142 if (check_connection() == FAIL)
14143 return;
14144 # endif
14146 server_name = get_tv_string_chk(&argvars[0]);
14147 if (server_name == NULL)
14148 return; /* type error; errmsg already given */
14149 keys = get_tv_string_buf(&argvars[1], buf);
14150 # ifdef WIN32
14151 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14152 # elif defined(FEAT_X11)
14153 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14154 < 0)
14155 # elif defined(MAC_CLIENTSERVER)
14156 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14157 # endif
14159 if (r != NULL)
14160 EMSG(r); /* sending worked but evaluation failed */
14161 else
14162 EMSG2(_("E241: Unable to send to %s"), server_name);
14163 return;
14166 rettv->vval.v_string = r;
14168 if (argvars[2].v_type != VAR_UNKNOWN)
14170 dictitem_T v;
14171 char_u str[30];
14172 char_u *idvar;
14174 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14175 v.di_tv.v_type = VAR_STRING;
14176 v.di_tv.vval.v_string = vim_strsave(str);
14177 idvar = get_tv_string_chk(&argvars[2]);
14178 if (idvar != NULL)
14179 set_var(idvar, &v.di_tv, FALSE);
14180 vim_free(v.di_tv.vval.v_string);
14183 #endif
14186 * "remote_expr()" function
14188 static void
14189 f_remote_expr(argvars, rettv)
14190 typval_T *argvars UNUSED;
14191 typval_T *rettv;
14193 rettv->v_type = VAR_STRING;
14194 rettv->vval.v_string = NULL;
14195 #ifdef FEAT_CLIENTSERVER
14196 remote_common(argvars, rettv, TRUE);
14197 #endif
14201 * "remote_foreground()" function
14203 static void
14204 f_remote_foreground(argvars, rettv)
14205 typval_T *argvars UNUSED;
14206 typval_T *rettv UNUSED;
14208 #ifdef FEAT_CLIENTSERVER
14209 # ifdef WIN32
14210 /* On Win32 it's done in this application. */
14212 char_u *server_name = get_tv_string_chk(&argvars[0]);
14214 if (server_name != NULL)
14215 serverForeground(server_name);
14217 # elif defined(FEAT_X11) || defined(MAC_CLIENTSERVER)
14218 /* Send a foreground() expression to the server. */
14219 argvars[1].v_type = VAR_STRING;
14220 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14221 argvars[2].v_type = VAR_UNKNOWN;
14222 remote_common(argvars, rettv, TRUE);
14223 vim_free(argvars[1].vval.v_string);
14224 # endif
14225 #endif
14228 static void
14229 f_remote_peek(argvars, rettv)
14230 typval_T *argvars UNUSED;
14231 typval_T *rettv;
14233 #ifdef FEAT_CLIENTSERVER
14234 dictitem_T v;
14235 char_u *s = NULL;
14236 # ifdef WIN32
14237 long_u n = 0;
14238 # endif
14239 char_u *serverid;
14241 if (check_restricted() || check_secure())
14243 rettv->vval.v_number = -1;
14244 return;
14246 serverid = get_tv_string_chk(&argvars[0]);
14247 if (serverid == NULL)
14249 rettv->vval.v_number = -1;
14250 return; /* type error; errmsg already given */
14252 # ifdef WIN32
14253 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14254 if (n == 0)
14255 rettv->vval.v_number = -1;
14256 else
14258 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14259 rettv->vval.v_number = (s != NULL);
14261 # elif defined(FEAT_X11)
14262 if (check_connection() == FAIL)
14263 return;
14265 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14266 serverStrToWin(serverid), &s);
14267 # elif defined(MAC_CLIENTSERVER)
14268 rettv->vval.v_number = serverPeekReply(serverStrToPort(serverid), &s);
14269 # endif
14271 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14273 char_u *retvar;
14275 v.di_tv.v_type = VAR_STRING;
14276 v.di_tv.vval.v_string = vim_strsave(s);
14277 retvar = get_tv_string_chk(&argvars[1]);
14278 if (retvar != NULL)
14279 set_var(retvar, &v.di_tv, FALSE);
14280 vim_free(v.di_tv.vval.v_string);
14282 #else
14283 rettv->vval.v_number = -1;
14284 #endif
14287 static void
14288 f_remote_read(argvars, rettv)
14289 typval_T *argvars UNUSED;
14290 typval_T *rettv;
14292 char_u *r = NULL;
14294 #ifdef FEAT_CLIENTSERVER
14295 char_u *serverid = get_tv_string_chk(&argvars[0]);
14297 if (serverid != NULL && !check_restricted() && !check_secure())
14299 # ifdef WIN32
14300 /* The server's HWND is encoded in the 'id' parameter */
14301 long_u n = 0;
14303 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14304 if (n != 0)
14305 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14306 if (r == NULL)
14307 # elif defined(FEAT_X11)
14308 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14309 serverStrToWin(serverid), &r, FALSE) < 0)
14310 # elif defined(MAC_CLIENTSERVER)
14311 if (serverReadReply(serverStrToPort(serverid), &r) < 0)
14312 # endif
14313 EMSG(_("E277: Unable to read a server reply"));
14315 #endif
14316 rettv->v_type = VAR_STRING;
14317 rettv->vval.v_string = r;
14321 * "remote_send()" function
14323 static void
14324 f_remote_send(argvars, rettv)
14325 typval_T *argvars UNUSED;
14326 typval_T *rettv;
14328 rettv->v_type = VAR_STRING;
14329 rettv->vval.v_string = NULL;
14330 #ifdef FEAT_CLIENTSERVER
14331 remote_common(argvars, rettv, FALSE);
14332 #endif
14336 * "remove()" function
14338 static void
14339 f_remove(argvars, rettv)
14340 typval_T *argvars;
14341 typval_T *rettv;
14343 list_T *l;
14344 listitem_T *item, *item2;
14345 listitem_T *li;
14346 long idx;
14347 long end;
14348 char_u *key;
14349 dict_T *d;
14350 dictitem_T *di;
14352 if (argvars[0].v_type == VAR_DICT)
14354 if (argvars[2].v_type != VAR_UNKNOWN)
14355 EMSG2(_(e_toomanyarg), "remove()");
14356 else if ((d = argvars[0].vval.v_dict) != NULL
14357 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14359 key = get_tv_string_chk(&argvars[1]);
14360 if (key != NULL)
14362 di = dict_find(d, key, -1);
14363 if (di == NULL)
14364 EMSG2(_(e_dictkey), key);
14365 else
14367 *rettv = di->di_tv;
14368 init_tv(&di->di_tv);
14369 dictitem_remove(d, di);
14374 else if (argvars[0].v_type != VAR_LIST)
14375 EMSG2(_(e_listdictarg), "remove()");
14376 else if ((l = argvars[0].vval.v_list) != NULL
14377 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14379 int error = FALSE;
14381 idx = get_tv_number_chk(&argvars[1], &error);
14382 if (error)
14383 ; /* type error: do nothing, errmsg already given */
14384 else if ((item = list_find(l, idx)) == NULL)
14385 EMSGN(_(e_listidx), idx);
14386 else
14388 if (argvars[2].v_type == VAR_UNKNOWN)
14390 /* Remove one item, return its value. */
14391 list_remove(l, item, item);
14392 *rettv = item->li_tv;
14393 vim_free(item);
14395 else
14397 /* Remove range of items, return list with values. */
14398 end = get_tv_number_chk(&argvars[2], &error);
14399 if (error)
14400 ; /* type error: do nothing */
14401 else if ((item2 = list_find(l, end)) == NULL)
14402 EMSGN(_(e_listidx), end);
14403 else
14405 int cnt = 0;
14407 for (li = item; li != NULL; li = li->li_next)
14409 ++cnt;
14410 if (li == item2)
14411 break;
14413 if (li == NULL) /* didn't find "item2" after "item" */
14414 EMSG(_(e_invrange));
14415 else
14417 list_remove(l, item, item2);
14418 if (rettv_list_alloc(rettv) == OK)
14420 l = rettv->vval.v_list;
14421 l->lv_first = item;
14422 l->lv_last = item2;
14423 item->li_prev = NULL;
14424 item2->li_next = NULL;
14425 l->lv_len = cnt;
14435 * "rename({from}, {to})" function
14437 static void
14438 f_rename(argvars, rettv)
14439 typval_T *argvars;
14440 typval_T *rettv;
14442 char_u buf[NUMBUFLEN];
14444 if (check_restricted() || check_secure())
14445 rettv->vval.v_number = -1;
14446 else
14447 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14448 get_tv_string_buf(&argvars[1], buf));
14452 * "repeat()" function
14454 static void
14455 f_repeat(argvars, rettv)
14456 typval_T *argvars;
14457 typval_T *rettv;
14459 char_u *p;
14460 int n;
14461 int slen;
14462 int len;
14463 char_u *r;
14464 int i;
14466 n = get_tv_number(&argvars[1]);
14467 if (argvars[0].v_type == VAR_LIST)
14469 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14470 while (n-- > 0)
14471 if (list_extend(rettv->vval.v_list,
14472 argvars[0].vval.v_list, NULL) == FAIL)
14473 break;
14475 else
14477 p = get_tv_string(&argvars[0]);
14478 rettv->v_type = VAR_STRING;
14479 rettv->vval.v_string = NULL;
14481 slen = (int)STRLEN(p);
14482 len = slen * n;
14483 if (len <= 0)
14484 return;
14486 r = alloc(len + 1);
14487 if (r != NULL)
14489 for (i = 0; i < n; i++)
14490 mch_memmove(r + i * slen, p, (size_t)slen);
14491 r[len] = NUL;
14494 rettv->vval.v_string = r;
14499 * "resolve()" function
14501 static void
14502 f_resolve(argvars, rettv)
14503 typval_T *argvars;
14504 typval_T *rettv;
14506 char_u *p;
14508 p = get_tv_string(&argvars[0]);
14509 #ifdef FEAT_SHORTCUT
14511 char_u *v = NULL;
14513 v = mch_resolve_shortcut(p);
14514 if (v != NULL)
14515 rettv->vval.v_string = v;
14516 else
14517 rettv->vval.v_string = vim_strsave(p);
14519 #else
14520 # ifdef HAVE_READLINK
14522 char_u buf[MAXPATHL + 1];
14523 char_u *cpy;
14524 int len;
14525 char_u *remain = NULL;
14526 char_u *q;
14527 int is_relative_to_current = FALSE;
14528 int has_trailing_pathsep = FALSE;
14529 int limit = 100;
14531 p = vim_strsave(p);
14533 if (p[0] == '.' && (vim_ispathsep(p[1])
14534 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14535 is_relative_to_current = TRUE;
14537 len = STRLEN(p);
14538 if (len > 0 && after_pathsep(p, p + len))
14539 has_trailing_pathsep = TRUE;
14541 q = getnextcomp(p);
14542 if (*q != NUL)
14544 /* Separate the first path component in "p", and keep the
14545 * remainder (beginning with the path separator). */
14546 remain = vim_strsave(q - 1);
14547 q[-1] = NUL;
14550 for (;;)
14552 for (;;)
14554 len = readlink((char *)p, (char *)buf, MAXPATHL);
14555 if (len <= 0)
14556 break;
14557 buf[len] = NUL;
14559 if (limit-- == 0)
14561 vim_free(p);
14562 vim_free(remain);
14563 EMSG(_("E655: Too many symbolic links (cycle?)"));
14564 rettv->vval.v_string = NULL;
14565 goto fail;
14568 /* Ensure that the result will have a trailing path separator
14569 * if the argument has one. */
14570 if (remain == NULL && has_trailing_pathsep)
14571 add_pathsep(buf);
14573 /* Separate the first path component in the link value and
14574 * concatenate the remainders. */
14575 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14576 if (*q != NUL)
14578 if (remain == NULL)
14579 remain = vim_strsave(q - 1);
14580 else
14582 cpy = concat_str(q - 1, remain);
14583 if (cpy != NULL)
14585 vim_free(remain);
14586 remain = cpy;
14589 q[-1] = NUL;
14592 q = gettail(p);
14593 if (q > p && *q == NUL)
14595 /* Ignore trailing path separator. */
14596 q[-1] = NUL;
14597 q = gettail(p);
14599 if (q > p && !mch_isFullName(buf))
14601 /* symlink is relative to directory of argument */
14602 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14603 if (cpy != NULL)
14605 STRCPY(cpy, p);
14606 STRCPY(gettail(cpy), buf);
14607 vim_free(p);
14608 p = cpy;
14611 else
14613 vim_free(p);
14614 p = vim_strsave(buf);
14618 if (remain == NULL)
14619 break;
14621 /* Append the first path component of "remain" to "p". */
14622 q = getnextcomp(remain + 1);
14623 len = q - remain - (*q != NUL);
14624 cpy = vim_strnsave(p, STRLEN(p) + len);
14625 if (cpy != NULL)
14627 STRNCAT(cpy, remain, len);
14628 vim_free(p);
14629 p = cpy;
14631 /* Shorten "remain". */
14632 if (*q != NUL)
14633 STRMOVE(remain, q - 1);
14634 else
14636 vim_free(remain);
14637 remain = NULL;
14641 /* If the result is a relative path name, make it explicitly relative to
14642 * the current directory if and only if the argument had this form. */
14643 if (!vim_ispathsep(*p))
14645 if (is_relative_to_current
14646 && *p != NUL
14647 && !(p[0] == '.'
14648 && (p[1] == NUL
14649 || vim_ispathsep(p[1])
14650 || (p[1] == '.'
14651 && (p[2] == NUL
14652 || vim_ispathsep(p[2]))))))
14654 /* Prepend "./". */
14655 cpy = concat_str((char_u *)"./", p);
14656 if (cpy != NULL)
14658 vim_free(p);
14659 p = cpy;
14662 else if (!is_relative_to_current)
14664 /* Strip leading "./". */
14665 q = p;
14666 while (q[0] == '.' && vim_ispathsep(q[1]))
14667 q += 2;
14668 if (q > p)
14669 STRMOVE(p, p + 2);
14673 /* Ensure that the result will have no trailing path separator
14674 * if the argument had none. But keep "/" or "//". */
14675 if (!has_trailing_pathsep)
14677 q = p + STRLEN(p);
14678 if (after_pathsep(p, q))
14679 *gettail_sep(p) = NUL;
14682 rettv->vval.v_string = p;
14684 # else
14685 rettv->vval.v_string = vim_strsave(p);
14686 # endif
14687 #endif
14689 simplify_filename(rettv->vval.v_string);
14691 #ifdef HAVE_READLINK
14692 fail:
14693 #endif
14694 rettv->v_type = VAR_STRING;
14698 * "reverse({list})" function
14700 static void
14701 f_reverse(argvars, rettv)
14702 typval_T *argvars;
14703 typval_T *rettv;
14705 list_T *l;
14706 listitem_T *li, *ni;
14708 if (argvars[0].v_type != VAR_LIST)
14709 EMSG2(_(e_listarg), "reverse()");
14710 else if ((l = argvars[0].vval.v_list) != NULL
14711 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14713 li = l->lv_last;
14714 l->lv_first = l->lv_last = NULL;
14715 l->lv_len = 0;
14716 while (li != NULL)
14718 ni = li->li_prev;
14719 list_append(l, li);
14720 li = ni;
14722 rettv->vval.v_list = l;
14723 rettv->v_type = VAR_LIST;
14724 ++l->lv_refcount;
14725 l->lv_idx = l->lv_len - l->lv_idx - 1;
14729 #define SP_NOMOVE 0x01 /* don't move cursor */
14730 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14731 #define SP_RETCOUNT 0x04 /* return matchcount */
14732 #define SP_SETPCMARK 0x08 /* set previous context mark */
14733 #define SP_START 0x10 /* accept match at start position */
14734 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14735 #define SP_END 0x40 /* leave cursor at end of match */
14737 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14740 * Get flags for a search function.
14741 * Possibly sets "p_ws".
14742 * Returns BACKWARD, FORWARD or zero (for an error).
14744 static int
14745 get_search_arg(varp, flagsp)
14746 typval_T *varp;
14747 int *flagsp;
14749 int dir = FORWARD;
14750 char_u *flags;
14751 char_u nbuf[NUMBUFLEN];
14752 int mask;
14754 if (varp->v_type != VAR_UNKNOWN)
14756 flags = get_tv_string_buf_chk(varp, nbuf);
14757 if (flags == NULL)
14758 return 0; /* type error; errmsg already given */
14759 while (*flags != NUL)
14761 switch (*flags)
14763 case 'b': dir = BACKWARD; break;
14764 case 'w': p_ws = TRUE; break;
14765 case 'W': p_ws = FALSE; break;
14766 default: mask = 0;
14767 if (flagsp != NULL)
14768 switch (*flags)
14770 case 'c': mask = SP_START; break;
14771 case 'e': mask = SP_END; break;
14772 case 'm': mask = SP_RETCOUNT; break;
14773 case 'n': mask = SP_NOMOVE; break;
14774 case 'p': mask = SP_SUBPAT; break;
14775 case 'r': mask = SP_REPEAT; break;
14776 case 's': mask = SP_SETPCMARK; break;
14778 if (mask == 0)
14780 EMSG2(_(e_invarg2), flags);
14781 dir = 0;
14783 else
14784 *flagsp |= mask;
14786 if (dir == 0)
14787 break;
14788 ++flags;
14791 return dir;
14795 * Shared by search() and searchpos() functions
14797 static int
14798 search_cmn(argvars, match_pos, flagsp)
14799 typval_T *argvars;
14800 pos_T *match_pos;
14801 int *flagsp;
14803 int flags;
14804 char_u *pat;
14805 pos_T pos;
14806 pos_T save_cursor;
14807 int save_p_ws = p_ws;
14808 int dir;
14809 int retval = 0; /* default: FAIL */
14810 long lnum_stop = 0;
14811 proftime_T tm;
14812 #ifdef FEAT_RELTIME
14813 long time_limit = 0;
14814 #endif
14815 int options = SEARCH_KEEP;
14816 int subpatnum;
14818 pat = get_tv_string(&argvars[0]);
14819 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14820 if (dir == 0)
14821 goto theend;
14822 flags = *flagsp;
14823 if (flags & SP_START)
14824 options |= SEARCH_START;
14825 if (flags & SP_END)
14826 options |= SEARCH_END;
14828 /* Optional arguments: line number to stop searching and timeout. */
14829 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14831 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14832 if (lnum_stop < 0)
14833 goto theend;
14834 #ifdef FEAT_RELTIME
14835 if (argvars[3].v_type != VAR_UNKNOWN)
14837 time_limit = get_tv_number_chk(&argvars[3], NULL);
14838 if (time_limit < 0)
14839 goto theend;
14841 #endif
14844 #ifdef FEAT_RELTIME
14845 /* Set the time limit, if there is one. */
14846 profile_setlimit(time_limit, &tm);
14847 #endif
14850 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14851 * Check to make sure only those flags are set.
14852 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14853 * flags cannot be set. Check for that condition also.
14855 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14856 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14858 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14859 goto theend;
14862 pos = save_cursor = curwin->w_cursor;
14863 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14864 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14865 if (subpatnum != FAIL)
14867 if (flags & SP_SUBPAT)
14868 retval = subpatnum;
14869 else
14870 retval = pos.lnum;
14871 if (flags & SP_SETPCMARK)
14872 setpcmark();
14873 curwin->w_cursor = pos;
14874 if (match_pos != NULL)
14876 /* Store the match cursor position */
14877 match_pos->lnum = pos.lnum;
14878 match_pos->col = pos.col + 1;
14880 /* "/$" will put the cursor after the end of the line, may need to
14881 * correct that here */
14882 check_cursor();
14885 /* If 'n' flag is used: restore cursor position. */
14886 if (flags & SP_NOMOVE)
14887 curwin->w_cursor = save_cursor;
14888 else
14889 curwin->w_set_curswant = TRUE;
14890 theend:
14891 p_ws = save_p_ws;
14893 return retval;
14896 #ifdef FEAT_FLOAT
14898 * "round({float})" function
14900 static void
14901 f_round(argvars, rettv)
14902 typval_T *argvars;
14903 typval_T *rettv;
14905 float_T f;
14907 rettv->v_type = VAR_FLOAT;
14908 if (get_float_arg(argvars, &f) == OK)
14909 /* round() is not in C90, use ceil() or floor() instead. */
14910 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14911 else
14912 rettv->vval.v_float = 0.0;
14914 #endif
14917 * "search()" function
14919 static void
14920 f_search(argvars, rettv)
14921 typval_T *argvars;
14922 typval_T *rettv;
14924 int flags = 0;
14926 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14930 * "searchdecl()" function
14932 static void
14933 f_searchdecl(argvars, rettv)
14934 typval_T *argvars;
14935 typval_T *rettv;
14937 int locally = 1;
14938 int thisblock = 0;
14939 int error = FALSE;
14940 char_u *name;
14942 rettv->vval.v_number = 1; /* default: FAIL */
14944 name = get_tv_string_chk(&argvars[0]);
14945 if (argvars[1].v_type != VAR_UNKNOWN)
14947 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14948 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14949 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14951 if (!error && name != NULL)
14952 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14953 locally, thisblock, SEARCH_KEEP) == FAIL;
14957 * Used by searchpair() and searchpairpos()
14959 static int
14960 searchpair_cmn(argvars, match_pos)
14961 typval_T *argvars;
14962 pos_T *match_pos;
14964 char_u *spat, *mpat, *epat;
14965 char_u *skip;
14966 int save_p_ws = p_ws;
14967 int dir;
14968 int flags = 0;
14969 char_u nbuf1[NUMBUFLEN];
14970 char_u nbuf2[NUMBUFLEN];
14971 char_u nbuf3[NUMBUFLEN];
14972 int retval = 0; /* default: FAIL */
14973 long lnum_stop = 0;
14974 long time_limit = 0;
14976 /* Get the three pattern arguments: start, middle, end. */
14977 spat = get_tv_string_chk(&argvars[0]);
14978 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14979 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14980 if (spat == NULL || mpat == NULL || epat == NULL)
14981 goto theend; /* type error */
14983 /* Handle the optional fourth argument: flags */
14984 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14985 if (dir == 0)
14986 goto theend;
14988 /* Don't accept SP_END or SP_SUBPAT.
14989 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14991 if ((flags & (SP_END | SP_SUBPAT)) != 0
14992 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14994 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14995 goto theend;
14998 /* Using 'r' implies 'W', otherwise it doesn't work. */
14999 if (flags & SP_REPEAT)
15000 p_ws = FALSE;
15002 /* Optional fifth argument: skip expression */
15003 if (argvars[3].v_type == VAR_UNKNOWN
15004 || argvars[4].v_type == VAR_UNKNOWN)
15005 skip = (char_u *)"";
15006 else
15008 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
15009 if (argvars[5].v_type != VAR_UNKNOWN)
15011 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
15012 if (lnum_stop < 0)
15013 goto theend;
15014 #ifdef FEAT_RELTIME
15015 if (argvars[6].v_type != VAR_UNKNOWN)
15017 time_limit = get_tv_number_chk(&argvars[6], NULL);
15018 if (time_limit < 0)
15019 goto theend;
15021 #endif
15024 if (skip == NULL)
15025 goto theend; /* type error */
15027 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
15028 match_pos, lnum_stop, time_limit);
15030 theend:
15031 p_ws = save_p_ws;
15033 return retval;
15037 * "searchpair()" function
15039 static void
15040 f_searchpair(argvars, rettv)
15041 typval_T *argvars;
15042 typval_T *rettv;
15044 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15048 * "searchpairpos()" function
15050 static void
15051 f_searchpairpos(argvars, rettv)
15052 typval_T *argvars;
15053 typval_T *rettv;
15055 pos_T match_pos;
15056 int lnum = 0;
15057 int col = 0;
15059 if (rettv_list_alloc(rettv) == FAIL)
15060 return;
15062 if (searchpair_cmn(argvars, &match_pos) > 0)
15064 lnum = match_pos.lnum;
15065 col = match_pos.col;
15068 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15069 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15073 * Search for a start/middle/end thing.
15074 * Used by searchpair(), see its documentation for the details.
15075 * Returns 0 or -1 for no match,
15077 long
15078 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15079 lnum_stop, time_limit)
15080 char_u *spat; /* start pattern */
15081 char_u *mpat; /* middle pattern */
15082 char_u *epat; /* end pattern */
15083 int dir; /* BACKWARD or FORWARD */
15084 char_u *skip; /* skip expression */
15085 int flags; /* SP_SETPCMARK and other SP_ values */
15086 pos_T *match_pos;
15087 linenr_T lnum_stop; /* stop at this line if not zero */
15088 long time_limit; /* stop after this many msec */
15090 char_u *save_cpo;
15091 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15092 long retval = 0;
15093 pos_T pos;
15094 pos_T firstpos;
15095 pos_T foundpos;
15096 pos_T save_cursor;
15097 pos_T save_pos;
15098 int n;
15099 int r;
15100 int nest = 1;
15101 int err;
15102 int options = SEARCH_KEEP;
15103 proftime_T tm;
15105 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15106 save_cpo = p_cpo;
15107 p_cpo = empty_option;
15109 #ifdef FEAT_RELTIME
15110 /* Set the time limit, if there is one. */
15111 profile_setlimit(time_limit, &tm);
15112 #endif
15114 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15115 * start/middle/end (pat3, for the top pair). */
15116 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15117 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15118 if (pat2 == NULL || pat3 == NULL)
15119 goto theend;
15120 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15121 if (*mpat == NUL)
15122 STRCPY(pat3, pat2);
15123 else
15124 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15125 spat, epat, mpat);
15126 if (flags & SP_START)
15127 options |= SEARCH_START;
15129 save_cursor = curwin->w_cursor;
15130 pos = curwin->w_cursor;
15131 clearpos(&firstpos);
15132 clearpos(&foundpos);
15133 pat = pat3;
15134 for (;;)
15136 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15137 options, RE_SEARCH, lnum_stop, &tm);
15138 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15139 /* didn't find it or found the first match again: FAIL */
15140 break;
15142 if (firstpos.lnum == 0)
15143 firstpos = pos;
15144 if (equalpos(pos, foundpos))
15146 /* Found the same position again. Can happen with a pattern that
15147 * has "\zs" at the end and searching backwards. Advance one
15148 * character and try again. */
15149 if (dir == BACKWARD)
15150 decl(&pos);
15151 else
15152 incl(&pos);
15154 foundpos = pos;
15156 /* clear the start flag to avoid getting stuck here */
15157 options &= ~SEARCH_START;
15159 /* If the skip pattern matches, ignore this match. */
15160 if (*skip != NUL)
15162 save_pos = curwin->w_cursor;
15163 curwin->w_cursor = pos;
15164 r = eval_to_bool(skip, &err, NULL, FALSE);
15165 curwin->w_cursor = save_pos;
15166 if (err)
15168 /* Evaluating {skip} caused an error, break here. */
15169 curwin->w_cursor = save_cursor;
15170 retval = -1;
15171 break;
15173 if (r)
15174 continue;
15177 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15179 /* Found end when searching backwards or start when searching
15180 * forward: nested pair. */
15181 ++nest;
15182 pat = pat2; /* nested, don't search for middle */
15184 else
15186 /* Found end when searching forward or start when searching
15187 * backward: end of (nested) pair; or found middle in outer pair. */
15188 if (--nest == 1)
15189 pat = pat3; /* outer level, search for middle */
15192 if (nest == 0)
15194 /* Found the match: return matchcount or line number. */
15195 if (flags & SP_RETCOUNT)
15196 ++retval;
15197 else
15198 retval = pos.lnum;
15199 if (flags & SP_SETPCMARK)
15200 setpcmark();
15201 curwin->w_cursor = pos;
15202 if (!(flags & SP_REPEAT))
15203 break;
15204 nest = 1; /* search for next unmatched */
15208 if (match_pos != NULL)
15210 /* Store the match cursor position */
15211 match_pos->lnum = curwin->w_cursor.lnum;
15212 match_pos->col = curwin->w_cursor.col + 1;
15215 /* If 'n' flag is used or search failed: restore cursor position. */
15216 if ((flags & SP_NOMOVE) || retval == 0)
15217 curwin->w_cursor = save_cursor;
15219 theend:
15220 vim_free(pat2);
15221 vim_free(pat3);
15222 if (p_cpo == empty_option)
15223 p_cpo = save_cpo;
15224 else
15225 /* Darn, evaluating the {skip} expression changed the value. */
15226 free_string_option(save_cpo);
15228 return retval;
15232 * "searchpos()" function
15234 static void
15235 f_searchpos(argvars, rettv)
15236 typval_T *argvars;
15237 typval_T *rettv;
15239 pos_T match_pos;
15240 int lnum = 0;
15241 int col = 0;
15242 int n;
15243 int flags = 0;
15245 if (rettv_list_alloc(rettv) == FAIL)
15246 return;
15248 n = search_cmn(argvars, &match_pos, &flags);
15249 if (n > 0)
15251 lnum = match_pos.lnum;
15252 col = match_pos.col;
15255 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15256 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15257 if (flags & SP_SUBPAT)
15258 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15262 static void
15263 f_server2client(argvars, rettv)
15264 typval_T *argvars UNUSED;
15265 typval_T *rettv;
15267 #ifdef FEAT_CLIENTSERVER
15268 char_u buf[NUMBUFLEN];
15269 char_u *server = get_tv_string_chk(&argvars[0]);
15270 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15272 rettv->vval.v_number = -1;
15273 if (server == NULL || reply == NULL)
15274 return;
15275 if (check_restricted() || check_secure())
15276 return;
15277 # ifdef FEAT_X11
15278 if (check_connection() == FAIL)
15279 return;
15280 # endif
15282 if (serverSendReply(server, reply) < 0)
15284 EMSG(_("E258: Unable to send to client"));
15285 return;
15287 rettv->vval.v_number = 0;
15288 #else
15289 rettv->vval.v_number = -1;
15290 #endif
15293 static void
15294 f_serverlist(argvars, rettv)
15295 typval_T *argvars UNUSED;
15296 typval_T *rettv;
15298 char_u *r = NULL;
15300 #ifdef FEAT_CLIENTSERVER
15301 # if defined(WIN32) || defined(MAC_CLIENTSERVER)
15302 r = serverGetVimNames();
15303 # elif defined(FEAT_X11)
15304 make_connection();
15305 if (X_DISPLAY != NULL)
15306 r = serverGetVimNames(X_DISPLAY);
15307 # endif
15308 #endif
15309 rettv->v_type = VAR_STRING;
15310 rettv->vval.v_string = r;
15314 * "setbufvar()" function
15316 static void
15317 f_setbufvar(argvars, rettv)
15318 typval_T *argvars;
15319 typval_T *rettv UNUSED;
15321 buf_T *buf;
15322 aco_save_T aco;
15323 char_u *varname, *bufvarname;
15324 typval_T *varp;
15325 char_u nbuf[NUMBUFLEN];
15327 if (check_restricted() || check_secure())
15328 return;
15329 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15330 varname = get_tv_string_chk(&argvars[1]);
15331 buf = get_buf_tv(&argvars[0]);
15332 varp = &argvars[2];
15334 if (buf != NULL && varname != NULL && varp != NULL)
15336 /* set curbuf to be our buf, temporarily */
15337 aucmd_prepbuf(&aco, buf);
15339 if (*varname == '&')
15341 long numval;
15342 char_u *strval;
15343 int error = FALSE;
15345 ++varname;
15346 numval = get_tv_number_chk(varp, &error);
15347 strval = get_tv_string_buf_chk(varp, nbuf);
15348 if (!error && strval != NULL)
15349 set_option_value(varname, numval, strval, OPT_LOCAL);
15351 else
15353 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15354 if (bufvarname != NULL)
15356 STRCPY(bufvarname, "b:");
15357 STRCPY(bufvarname + 2, varname);
15358 set_var(bufvarname, varp, TRUE);
15359 vim_free(bufvarname);
15363 /* reset notion of buffer */
15364 aucmd_restbuf(&aco);
15369 * "setcmdpos()" function
15371 static void
15372 f_setcmdpos(argvars, rettv)
15373 typval_T *argvars;
15374 typval_T *rettv;
15376 int pos = (int)get_tv_number(&argvars[0]) - 1;
15378 if (pos >= 0)
15379 rettv->vval.v_number = set_cmdline_pos(pos);
15383 * "setline()" function
15385 static void
15386 f_setline(argvars, rettv)
15387 typval_T *argvars;
15388 typval_T *rettv;
15390 linenr_T lnum;
15391 char_u *line = NULL;
15392 list_T *l = NULL;
15393 listitem_T *li = NULL;
15394 long added = 0;
15395 linenr_T lcount = curbuf->b_ml.ml_line_count;
15397 lnum = get_tv_lnum(&argvars[0]);
15398 if (argvars[1].v_type == VAR_LIST)
15400 l = argvars[1].vval.v_list;
15401 li = l->lv_first;
15403 else
15404 line = get_tv_string_chk(&argvars[1]);
15406 /* default result is zero == OK */
15407 for (;;)
15409 if (l != NULL)
15411 /* list argument, get next string */
15412 if (li == NULL)
15413 break;
15414 line = get_tv_string_chk(&li->li_tv);
15415 li = li->li_next;
15418 rettv->vval.v_number = 1; /* FAIL */
15419 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15420 break;
15421 if (lnum <= curbuf->b_ml.ml_line_count)
15423 /* existing line, replace it */
15424 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15426 changed_bytes(lnum, 0);
15427 if (lnum == curwin->w_cursor.lnum)
15428 check_cursor_col();
15429 rettv->vval.v_number = 0; /* OK */
15432 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15434 /* lnum is one past the last line, append the line */
15435 ++added;
15436 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15437 rettv->vval.v_number = 0; /* OK */
15440 if (l == NULL) /* only one string argument */
15441 break;
15442 ++lnum;
15445 if (added > 0)
15446 appended_lines_mark(lcount, added);
15449 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15452 * Used by "setqflist()" and "setloclist()" functions
15454 static void
15455 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15456 win_T *wp UNUSED;
15457 typval_T *list_arg UNUSED;
15458 typval_T *action_arg UNUSED;
15459 typval_T *rettv;
15461 #ifdef FEAT_QUICKFIX
15462 char_u *act;
15463 int action = ' ';
15464 #endif
15466 rettv->vval.v_number = -1;
15468 #ifdef FEAT_QUICKFIX
15469 if (list_arg->v_type != VAR_LIST)
15470 EMSG(_(e_listreq));
15471 else
15473 list_T *l = list_arg->vval.v_list;
15475 if (action_arg->v_type == VAR_STRING)
15477 act = get_tv_string_chk(action_arg);
15478 if (act == NULL)
15479 return; /* type error; errmsg already given */
15480 if (*act == 'a' || *act == 'r')
15481 action = *act;
15484 if (l != NULL && set_errorlist(wp, l, action) == OK)
15485 rettv->vval.v_number = 0;
15487 #endif
15491 * "setloclist()" function
15493 static void
15494 f_setloclist(argvars, rettv)
15495 typval_T *argvars;
15496 typval_T *rettv;
15498 win_T *win;
15500 rettv->vval.v_number = -1;
15502 win = find_win_by_nr(&argvars[0], NULL);
15503 if (win != NULL)
15504 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15508 * "setmatches()" function
15510 static void
15511 f_setmatches(argvars, rettv)
15512 typval_T *argvars;
15513 typval_T *rettv;
15515 #ifdef FEAT_SEARCH_EXTRA
15516 list_T *l;
15517 listitem_T *li;
15518 dict_T *d;
15520 rettv->vval.v_number = -1;
15521 if (argvars[0].v_type != VAR_LIST)
15523 EMSG(_(e_listreq));
15524 return;
15526 if ((l = argvars[0].vval.v_list) != NULL)
15529 /* To some extent make sure that we are dealing with a list from
15530 * "getmatches()". */
15531 li = l->lv_first;
15532 while (li != NULL)
15534 if (li->li_tv.v_type != VAR_DICT
15535 || (d = li->li_tv.vval.v_dict) == NULL)
15537 EMSG(_(e_invarg));
15538 return;
15540 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15541 && dict_find(d, (char_u *)"pattern", -1) != NULL
15542 && dict_find(d, (char_u *)"priority", -1) != NULL
15543 && dict_find(d, (char_u *)"id", -1) != NULL))
15545 EMSG(_(e_invarg));
15546 return;
15548 li = li->li_next;
15551 clear_matches(curwin);
15552 li = l->lv_first;
15553 while (li != NULL)
15555 d = li->li_tv.vval.v_dict;
15556 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15557 get_dict_string(d, (char_u *)"pattern", FALSE),
15558 (int)get_dict_number(d, (char_u *)"priority"),
15559 (int)get_dict_number(d, (char_u *)"id"));
15560 li = li->li_next;
15562 rettv->vval.v_number = 0;
15564 #endif
15568 * "setpos()" function
15570 static void
15571 f_setpos(argvars, rettv)
15572 typval_T *argvars;
15573 typval_T *rettv;
15575 pos_T pos;
15576 int fnum;
15577 char_u *name;
15579 rettv->vval.v_number = -1;
15580 name = get_tv_string_chk(argvars);
15581 if (name != NULL)
15583 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15585 if (--pos.col < 0)
15586 pos.col = 0;
15587 if (name[0] == '.' && name[1] == NUL)
15589 /* set cursor */
15590 if (fnum == curbuf->b_fnum)
15592 curwin->w_cursor = pos;
15593 check_cursor();
15594 rettv->vval.v_number = 0;
15596 else
15597 EMSG(_(e_invarg));
15599 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15601 /* set mark */
15602 if (setmark_pos(name[1], &pos, fnum) == OK)
15603 rettv->vval.v_number = 0;
15605 else
15606 EMSG(_(e_invarg));
15612 * "setqflist()" function
15614 static void
15615 f_setqflist(argvars, rettv)
15616 typval_T *argvars;
15617 typval_T *rettv;
15619 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15623 * "setreg()" function
15625 static void
15626 f_setreg(argvars, rettv)
15627 typval_T *argvars;
15628 typval_T *rettv;
15630 int regname;
15631 char_u *strregname;
15632 char_u *stropt;
15633 char_u *strval;
15634 int append;
15635 char_u yank_type;
15636 long block_len;
15638 block_len = -1;
15639 yank_type = MAUTO;
15640 append = FALSE;
15642 strregname = get_tv_string_chk(argvars);
15643 rettv->vval.v_number = 1; /* FAIL is default */
15645 if (strregname == NULL)
15646 return; /* type error; errmsg already given */
15647 regname = *strregname;
15648 if (regname == 0 || regname == '@')
15649 regname = '"';
15650 else if (regname == '=')
15651 return;
15653 if (argvars[2].v_type != VAR_UNKNOWN)
15655 stropt = get_tv_string_chk(&argvars[2]);
15656 if (stropt == NULL)
15657 return; /* type error */
15658 for (; *stropt != NUL; ++stropt)
15659 switch (*stropt)
15661 case 'a': case 'A': /* append */
15662 append = TRUE;
15663 break;
15664 case 'v': case 'c': /* character-wise selection */
15665 yank_type = MCHAR;
15666 break;
15667 case 'V': case 'l': /* line-wise selection */
15668 yank_type = MLINE;
15669 break;
15670 #ifdef FEAT_VISUAL
15671 case 'b': case Ctrl_V: /* block-wise selection */
15672 yank_type = MBLOCK;
15673 if (VIM_ISDIGIT(stropt[1]))
15675 ++stropt;
15676 block_len = getdigits(&stropt) - 1;
15677 --stropt;
15679 break;
15680 #endif
15684 strval = get_tv_string_chk(&argvars[1]);
15685 if (strval != NULL)
15686 write_reg_contents_ex(regname, strval, -1,
15687 append, yank_type, block_len);
15688 rettv->vval.v_number = 0;
15692 * "settabwinvar()" function
15694 static void
15695 f_settabwinvar(argvars, rettv)
15696 typval_T *argvars;
15697 typval_T *rettv;
15699 setwinvar(argvars, rettv, 1);
15703 * "setwinvar()" function
15705 static void
15706 f_setwinvar(argvars, rettv)
15707 typval_T *argvars;
15708 typval_T *rettv;
15710 setwinvar(argvars, rettv, 0);
15714 * "setwinvar()" and "settabwinvar()" functions
15716 static void
15717 setwinvar(argvars, rettv, off)
15718 typval_T *argvars;
15719 typval_T *rettv UNUSED;
15720 int off;
15722 win_T *win;
15723 #ifdef FEAT_WINDOWS
15724 win_T *save_curwin;
15725 tabpage_T *save_curtab;
15726 #endif
15727 char_u *varname, *winvarname;
15728 typval_T *varp;
15729 char_u nbuf[NUMBUFLEN];
15730 tabpage_T *tp;
15732 if (check_restricted() || check_secure())
15733 return;
15735 #ifdef FEAT_WINDOWS
15736 if (off == 1)
15737 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15738 else
15739 tp = curtab;
15740 #endif
15741 win = find_win_by_nr(&argvars[off], tp);
15742 varname = get_tv_string_chk(&argvars[off + 1]);
15743 varp = &argvars[off + 2];
15745 if (win != NULL && varname != NULL && varp != NULL)
15747 #ifdef FEAT_WINDOWS
15748 /* set curwin to be our win, temporarily */
15749 save_curwin = curwin;
15750 save_curtab = curtab;
15751 goto_tabpage_tp(tp);
15752 if (!win_valid(win))
15753 return;
15754 curwin = win;
15755 curbuf = curwin->w_buffer;
15756 #endif
15758 if (*varname == '&')
15760 long numval;
15761 char_u *strval;
15762 int error = FALSE;
15764 ++varname;
15765 numval = get_tv_number_chk(varp, &error);
15766 strval = get_tv_string_buf_chk(varp, nbuf);
15767 if (!error && strval != NULL)
15768 set_option_value(varname, numval, strval, OPT_LOCAL);
15770 else
15772 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15773 if (winvarname != NULL)
15775 STRCPY(winvarname, "w:");
15776 STRCPY(winvarname + 2, varname);
15777 set_var(winvarname, varp, TRUE);
15778 vim_free(winvarname);
15782 #ifdef FEAT_WINDOWS
15783 /* Restore current tabpage and window, if still valid (autocomands can
15784 * make them invalid). */
15785 if (valid_tabpage(save_curtab))
15786 goto_tabpage_tp(save_curtab);
15787 if (win_valid(save_curwin))
15789 curwin = save_curwin;
15790 curbuf = curwin->w_buffer;
15792 #endif
15797 * "shellescape({string})" function
15799 static void
15800 f_shellescape(argvars, rettv)
15801 typval_T *argvars;
15802 typval_T *rettv;
15804 rettv->vval.v_string = vim_strsave_shellescape(
15805 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15806 rettv->v_type = VAR_STRING;
15810 * "simplify()" function
15812 static void
15813 f_simplify(argvars, rettv)
15814 typval_T *argvars;
15815 typval_T *rettv;
15817 char_u *p;
15819 p = get_tv_string(&argvars[0]);
15820 rettv->vval.v_string = vim_strsave(p);
15821 simplify_filename(rettv->vval.v_string); /* simplify in place */
15822 rettv->v_type = VAR_STRING;
15825 #ifdef FEAT_FLOAT
15827 * "sin()" function
15829 static void
15830 f_sin(argvars, rettv)
15831 typval_T *argvars;
15832 typval_T *rettv;
15834 float_T f;
15836 rettv->v_type = VAR_FLOAT;
15837 if (get_float_arg(argvars, &f) == OK)
15838 rettv->vval.v_float = sin(f);
15839 else
15840 rettv->vval.v_float = 0.0;
15842 #endif
15844 static int
15845 #ifdef __BORLANDC__
15846 _RTLENTRYF
15847 #endif
15848 item_compare __ARGS((const void *s1, const void *s2));
15849 static int
15850 #ifdef __BORLANDC__
15851 _RTLENTRYF
15852 #endif
15853 item_compare2 __ARGS((const void *s1, const void *s2));
15855 static int item_compare_ic;
15856 static char_u *item_compare_func;
15857 static int item_compare_func_err;
15858 #define ITEM_COMPARE_FAIL 999
15861 * Compare functions for f_sort() below.
15863 static int
15864 #ifdef __BORLANDC__
15865 _RTLENTRYF
15866 #endif
15867 item_compare(s1, s2)
15868 const void *s1;
15869 const void *s2;
15871 char_u *p1, *p2;
15872 char_u *tofree1, *tofree2;
15873 int res;
15874 char_u numbuf1[NUMBUFLEN];
15875 char_u numbuf2[NUMBUFLEN];
15877 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15878 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15879 if (p1 == NULL)
15880 p1 = (char_u *)"";
15881 if (p2 == NULL)
15882 p2 = (char_u *)"";
15883 if (item_compare_ic)
15884 res = STRICMP(p1, p2);
15885 else
15886 res = STRCMP(p1, p2);
15887 vim_free(tofree1);
15888 vim_free(tofree2);
15889 return res;
15892 static int
15893 #ifdef __BORLANDC__
15894 _RTLENTRYF
15895 #endif
15896 item_compare2(s1, s2)
15897 const void *s1;
15898 const void *s2;
15900 int res;
15901 typval_T rettv;
15902 typval_T argv[3];
15903 int dummy;
15905 /* shortcut after failure in previous call; compare all items equal */
15906 if (item_compare_func_err)
15907 return 0;
15909 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15910 * in the copy without changing the original list items. */
15911 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15912 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15914 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15915 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15916 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15917 clear_tv(&argv[0]);
15918 clear_tv(&argv[1]);
15920 if (res == FAIL)
15921 res = ITEM_COMPARE_FAIL;
15922 else
15923 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15924 if (item_compare_func_err)
15925 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15926 clear_tv(&rettv);
15927 return res;
15931 * "sort({list})" function
15933 static void
15934 f_sort(argvars, rettv)
15935 typval_T *argvars;
15936 typval_T *rettv;
15938 list_T *l;
15939 listitem_T *li;
15940 listitem_T **ptrs;
15941 long len;
15942 long i;
15944 if (argvars[0].v_type != VAR_LIST)
15945 EMSG2(_(e_listarg), "sort()");
15946 else
15948 l = argvars[0].vval.v_list;
15949 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15950 return;
15951 rettv->vval.v_list = l;
15952 rettv->v_type = VAR_LIST;
15953 ++l->lv_refcount;
15955 len = list_len(l);
15956 if (len <= 1)
15957 return; /* short list sorts pretty quickly */
15959 item_compare_ic = FALSE;
15960 item_compare_func = NULL;
15961 if (argvars[1].v_type != VAR_UNKNOWN)
15963 if (argvars[1].v_type == VAR_FUNC)
15964 item_compare_func = argvars[1].vval.v_string;
15965 else
15967 int error = FALSE;
15969 i = get_tv_number_chk(&argvars[1], &error);
15970 if (error)
15971 return; /* type error; errmsg already given */
15972 if (i == 1)
15973 item_compare_ic = TRUE;
15974 else
15975 item_compare_func = get_tv_string(&argvars[1]);
15979 /* Make an array with each entry pointing to an item in the List. */
15980 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15981 if (ptrs == NULL)
15982 return;
15983 i = 0;
15984 for (li = l->lv_first; li != NULL; li = li->li_next)
15985 ptrs[i++] = li;
15987 item_compare_func_err = FALSE;
15988 /* test the compare function */
15989 if (item_compare_func != NULL
15990 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15991 == ITEM_COMPARE_FAIL)
15992 EMSG(_("E702: Sort compare function failed"));
15993 else
15995 /* Sort the array with item pointers. */
15996 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15997 item_compare_func == NULL ? item_compare : item_compare2);
15999 if (!item_compare_func_err)
16001 /* Clear the List and append the items in the sorted order. */
16002 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
16003 l->lv_len = 0;
16004 for (i = 0; i < len; ++i)
16005 list_append(l, ptrs[i]);
16009 vim_free(ptrs);
16014 * "soundfold({word})" function
16016 static void
16017 f_soundfold(argvars, rettv)
16018 typval_T *argvars;
16019 typval_T *rettv;
16021 char_u *s;
16023 rettv->v_type = VAR_STRING;
16024 s = get_tv_string(&argvars[0]);
16025 #ifdef FEAT_SPELL
16026 rettv->vval.v_string = eval_soundfold(s);
16027 #else
16028 rettv->vval.v_string = vim_strsave(s);
16029 #endif
16033 * "spellbadword()" function
16035 static void
16036 f_spellbadword(argvars, rettv)
16037 typval_T *argvars UNUSED;
16038 typval_T *rettv;
16040 char_u *word = (char_u *)"";
16041 hlf_T attr = HLF_COUNT;
16042 int len = 0;
16044 if (rettv_list_alloc(rettv) == FAIL)
16045 return;
16047 #ifdef FEAT_SPELL
16048 if (argvars[0].v_type == VAR_UNKNOWN)
16050 /* Find the start and length of the badly spelled word. */
16051 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16052 if (len != 0)
16053 word = ml_get_cursor();
16055 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16057 char_u *str = get_tv_string_chk(&argvars[0]);
16058 int capcol = -1;
16060 if (str != NULL)
16062 /* Check the argument for spelling. */
16063 while (*str != NUL)
16065 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16066 if (attr != HLF_COUNT)
16068 word = str;
16069 break;
16071 str += len;
16075 #endif
16077 list_append_string(rettv->vval.v_list, word, len);
16078 list_append_string(rettv->vval.v_list, (char_u *)(
16079 attr == HLF_SPB ? "bad" :
16080 attr == HLF_SPR ? "rare" :
16081 attr == HLF_SPL ? "local" :
16082 attr == HLF_SPC ? "caps" :
16083 ""), -1);
16087 * "spellsuggest()" function
16089 static void
16090 f_spellsuggest(argvars, rettv)
16091 typval_T *argvars UNUSED;
16092 typval_T *rettv;
16094 #ifdef FEAT_SPELL
16095 char_u *str;
16096 int typeerr = FALSE;
16097 int maxcount;
16098 garray_T ga;
16099 int i;
16100 listitem_T *li;
16101 int need_capital = FALSE;
16102 #endif
16104 if (rettv_list_alloc(rettv) == FAIL)
16105 return;
16107 #ifdef FEAT_SPELL
16108 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16110 str = get_tv_string(&argvars[0]);
16111 if (argvars[1].v_type != VAR_UNKNOWN)
16113 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16114 if (maxcount <= 0)
16115 return;
16116 if (argvars[2].v_type != VAR_UNKNOWN)
16118 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16119 if (typeerr)
16120 return;
16123 else
16124 maxcount = 25;
16126 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16128 for (i = 0; i < ga.ga_len; ++i)
16130 str = ((char_u **)ga.ga_data)[i];
16132 li = listitem_alloc();
16133 if (li == NULL)
16134 vim_free(str);
16135 else
16137 li->li_tv.v_type = VAR_STRING;
16138 li->li_tv.v_lock = 0;
16139 li->li_tv.vval.v_string = str;
16140 list_append(rettv->vval.v_list, li);
16143 ga_clear(&ga);
16145 #endif
16148 static void
16149 f_split(argvars, rettv)
16150 typval_T *argvars;
16151 typval_T *rettv;
16153 char_u *str;
16154 char_u *end;
16155 char_u *pat = NULL;
16156 regmatch_T regmatch;
16157 char_u patbuf[NUMBUFLEN];
16158 char_u *save_cpo;
16159 int match;
16160 colnr_T col = 0;
16161 int keepempty = FALSE;
16162 int typeerr = FALSE;
16164 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16165 save_cpo = p_cpo;
16166 p_cpo = (char_u *)"";
16168 str = get_tv_string(&argvars[0]);
16169 if (argvars[1].v_type != VAR_UNKNOWN)
16171 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16172 if (pat == NULL)
16173 typeerr = TRUE;
16174 if (argvars[2].v_type != VAR_UNKNOWN)
16175 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16177 if (pat == NULL || *pat == NUL)
16178 pat = (char_u *)"[\\x01- ]\\+";
16180 if (rettv_list_alloc(rettv) == FAIL)
16181 return;
16182 if (typeerr)
16183 return;
16185 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16186 if (regmatch.regprog != NULL)
16188 regmatch.rm_ic = FALSE;
16189 while (*str != NUL || keepempty)
16191 if (*str == NUL)
16192 match = FALSE; /* empty item at the end */
16193 else
16194 match = vim_regexec_nl(&regmatch, str, col);
16195 if (match)
16196 end = regmatch.startp[0];
16197 else
16198 end = str + STRLEN(str);
16199 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16200 && *str != NUL && match && end < regmatch.endp[0]))
16202 if (list_append_string(rettv->vval.v_list, str,
16203 (int)(end - str)) == FAIL)
16204 break;
16206 if (!match)
16207 break;
16208 /* Advance to just after the match. */
16209 if (regmatch.endp[0] > str)
16210 col = 0;
16211 else
16213 /* Don't get stuck at the same match. */
16214 #ifdef FEAT_MBYTE
16215 col = (*mb_ptr2len)(regmatch.endp[0]);
16216 #else
16217 col = 1;
16218 #endif
16220 str = regmatch.endp[0];
16223 vim_free(regmatch.regprog);
16226 p_cpo = save_cpo;
16229 #ifdef FEAT_FLOAT
16231 * "sqrt()" function
16233 static void
16234 f_sqrt(argvars, rettv)
16235 typval_T *argvars;
16236 typval_T *rettv;
16238 float_T f;
16240 rettv->v_type = VAR_FLOAT;
16241 if (get_float_arg(argvars, &f) == OK)
16242 rettv->vval.v_float = sqrt(f);
16243 else
16244 rettv->vval.v_float = 0.0;
16248 * "str2float()" function
16250 static void
16251 f_str2float(argvars, rettv)
16252 typval_T *argvars;
16253 typval_T *rettv;
16255 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16257 if (*p == '+')
16258 p = skipwhite(p + 1);
16259 (void)string2float(p, &rettv->vval.v_float);
16260 rettv->v_type = VAR_FLOAT;
16262 #endif
16265 * "str2nr()" function
16267 static void
16268 f_str2nr(argvars, rettv)
16269 typval_T *argvars;
16270 typval_T *rettv;
16272 int base = 10;
16273 char_u *p;
16274 long n;
16276 if (argvars[1].v_type != VAR_UNKNOWN)
16278 base = get_tv_number(&argvars[1]);
16279 if (base != 8 && base != 10 && base != 16)
16281 EMSG(_(e_invarg));
16282 return;
16286 p = skipwhite(get_tv_string(&argvars[0]));
16287 if (*p == '+')
16288 p = skipwhite(p + 1);
16289 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16290 rettv->vval.v_number = n;
16293 #ifdef HAVE_STRFTIME
16295 * "strftime({format}[, {time}])" function
16297 static void
16298 f_strftime(argvars, rettv)
16299 typval_T *argvars;
16300 typval_T *rettv;
16302 char_u result_buf[256];
16303 struct tm *curtime;
16304 time_t seconds;
16305 char_u *p;
16307 rettv->v_type = VAR_STRING;
16309 p = get_tv_string(&argvars[0]);
16310 if (argvars[1].v_type == VAR_UNKNOWN)
16311 seconds = time(NULL);
16312 else
16313 seconds = (time_t)get_tv_number(&argvars[1]);
16314 curtime = localtime(&seconds);
16315 /* MSVC returns NULL for an invalid value of seconds. */
16316 if (curtime == NULL)
16317 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16318 else
16320 # ifdef FEAT_MBYTE
16321 vimconv_T conv;
16322 char_u *enc;
16324 conv.vc_type = CONV_NONE;
16325 enc = enc_locale();
16326 convert_setup(&conv, p_enc, enc);
16327 if (conv.vc_type != CONV_NONE)
16328 p = string_convert(&conv, p, NULL);
16329 # endif
16330 if (p != NULL)
16331 (void)strftime((char *)result_buf, sizeof(result_buf),
16332 (char *)p, curtime);
16333 else
16334 result_buf[0] = NUL;
16336 # ifdef FEAT_MBYTE
16337 if (conv.vc_type != CONV_NONE)
16338 vim_free(p);
16339 convert_setup(&conv, enc, p_enc);
16340 if (conv.vc_type != CONV_NONE)
16341 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16342 else
16343 # endif
16344 rettv->vval.v_string = vim_strsave(result_buf);
16346 # ifdef FEAT_MBYTE
16347 /* Release conversion descriptors */
16348 convert_setup(&conv, NULL, NULL);
16349 vim_free(enc);
16350 # endif
16353 #endif
16356 * "stridx()" function
16358 static void
16359 f_stridx(argvars, rettv)
16360 typval_T *argvars;
16361 typval_T *rettv;
16363 char_u buf[NUMBUFLEN];
16364 char_u *needle;
16365 char_u *haystack;
16366 char_u *save_haystack;
16367 char_u *pos;
16368 int start_idx;
16370 needle = get_tv_string_chk(&argvars[1]);
16371 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16372 rettv->vval.v_number = -1;
16373 if (needle == NULL || haystack == NULL)
16374 return; /* type error; errmsg already given */
16376 if (argvars[2].v_type != VAR_UNKNOWN)
16378 int error = FALSE;
16380 start_idx = get_tv_number_chk(&argvars[2], &error);
16381 if (error || start_idx >= (int)STRLEN(haystack))
16382 return;
16383 if (start_idx >= 0)
16384 haystack += start_idx;
16387 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16388 if (pos != NULL)
16389 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16393 * "string()" function
16395 static void
16396 f_string(argvars, rettv)
16397 typval_T *argvars;
16398 typval_T *rettv;
16400 char_u *tofree;
16401 char_u numbuf[NUMBUFLEN];
16403 rettv->v_type = VAR_STRING;
16404 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16405 /* Make a copy if we have a value but it's not in allocated memory. */
16406 if (rettv->vval.v_string != NULL && tofree == NULL)
16407 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16411 * "strlen()" function
16413 static void
16414 f_strlen(argvars, rettv)
16415 typval_T *argvars;
16416 typval_T *rettv;
16418 rettv->vval.v_number = (varnumber_T)(STRLEN(
16419 get_tv_string(&argvars[0])));
16423 * "strpart()" function
16425 static void
16426 f_strpart(argvars, rettv)
16427 typval_T *argvars;
16428 typval_T *rettv;
16430 char_u *p;
16431 int n;
16432 int len;
16433 int slen;
16434 int error = FALSE;
16436 p = get_tv_string(&argvars[0]);
16437 slen = (int)STRLEN(p);
16439 n = get_tv_number_chk(&argvars[1], &error);
16440 if (error)
16441 len = 0;
16442 else if (argvars[2].v_type != VAR_UNKNOWN)
16443 len = get_tv_number(&argvars[2]);
16444 else
16445 len = slen - n; /* default len: all bytes that are available. */
16448 * Only return the overlap between the specified part and the actual
16449 * string.
16451 if (n < 0)
16453 len += n;
16454 n = 0;
16456 else if (n > slen)
16457 n = slen;
16458 if (len < 0)
16459 len = 0;
16460 else if (n + len > slen)
16461 len = slen - n;
16463 rettv->v_type = VAR_STRING;
16464 rettv->vval.v_string = vim_strnsave(p + n, len);
16468 * "strridx()" function
16470 static void
16471 f_strridx(argvars, rettv)
16472 typval_T *argvars;
16473 typval_T *rettv;
16475 char_u buf[NUMBUFLEN];
16476 char_u *needle;
16477 char_u *haystack;
16478 char_u *rest;
16479 char_u *lastmatch = NULL;
16480 int haystack_len, end_idx;
16482 needle = get_tv_string_chk(&argvars[1]);
16483 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16485 rettv->vval.v_number = -1;
16486 if (needle == NULL || haystack == NULL)
16487 return; /* type error; errmsg already given */
16489 haystack_len = (int)STRLEN(haystack);
16490 if (argvars[2].v_type != VAR_UNKNOWN)
16492 /* Third argument: upper limit for index */
16493 end_idx = get_tv_number_chk(&argvars[2], NULL);
16494 if (end_idx < 0)
16495 return; /* can never find a match */
16497 else
16498 end_idx = haystack_len;
16500 if (*needle == NUL)
16502 /* Empty string matches past the end. */
16503 lastmatch = haystack + end_idx;
16505 else
16507 for (rest = haystack; *rest != '\0'; ++rest)
16509 rest = (char_u *)strstr((char *)rest, (char *)needle);
16510 if (rest == NULL || rest > haystack + end_idx)
16511 break;
16512 lastmatch = rest;
16516 if (lastmatch == NULL)
16517 rettv->vval.v_number = -1;
16518 else
16519 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16523 * "strtrans()" function
16525 static void
16526 f_strtrans(argvars, rettv)
16527 typval_T *argvars;
16528 typval_T *rettv;
16530 rettv->v_type = VAR_STRING;
16531 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16535 * "submatch()" function
16537 static void
16538 f_submatch(argvars, rettv)
16539 typval_T *argvars;
16540 typval_T *rettv;
16542 rettv->v_type = VAR_STRING;
16543 rettv->vval.v_string =
16544 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16548 * "substitute()" function
16550 static void
16551 f_substitute(argvars, rettv)
16552 typval_T *argvars;
16553 typval_T *rettv;
16555 char_u patbuf[NUMBUFLEN];
16556 char_u subbuf[NUMBUFLEN];
16557 char_u flagsbuf[NUMBUFLEN];
16559 char_u *str = get_tv_string_chk(&argvars[0]);
16560 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16561 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16562 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16564 rettv->v_type = VAR_STRING;
16565 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16566 rettv->vval.v_string = NULL;
16567 else
16568 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16572 * "synID(lnum, col, trans)" function
16574 static void
16575 f_synID(argvars, rettv)
16576 typval_T *argvars UNUSED;
16577 typval_T *rettv;
16579 int id = 0;
16580 #ifdef FEAT_SYN_HL
16581 long lnum;
16582 long col;
16583 int trans;
16584 int transerr = FALSE;
16586 lnum = get_tv_lnum(argvars); /* -1 on type error */
16587 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16588 trans = get_tv_number_chk(&argvars[2], &transerr);
16590 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16591 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16592 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16593 #endif
16595 rettv->vval.v_number = id;
16599 * "synIDattr(id, what [, mode])" function
16601 static void
16602 f_synIDattr(argvars, rettv)
16603 typval_T *argvars UNUSED;
16604 typval_T *rettv;
16606 char_u *p = NULL;
16607 #ifdef FEAT_SYN_HL
16608 int id;
16609 char_u *what;
16610 char_u *mode;
16611 char_u modebuf[NUMBUFLEN];
16612 int modec;
16614 id = get_tv_number(&argvars[0]);
16615 what = get_tv_string(&argvars[1]);
16616 if (argvars[2].v_type != VAR_UNKNOWN)
16618 mode = get_tv_string_buf(&argvars[2], modebuf);
16619 modec = TOLOWER_ASC(mode[0]);
16620 if (modec != 't' && modec != 'c'
16621 #ifdef FEAT_GUI
16622 && modec != 'g'
16623 #endif
16625 modec = 0; /* replace invalid with current */
16627 else
16629 #ifdef FEAT_GUI
16630 if (gui.in_use)
16631 modec = 'g';
16632 else
16633 #endif
16634 if (t_colors > 1)
16635 modec = 'c';
16636 else
16637 modec = 't';
16641 switch (TOLOWER_ASC(what[0]))
16643 case 'b':
16644 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16645 p = highlight_color(id, what, modec);
16646 else /* bold */
16647 p = highlight_has_attr(id, HL_BOLD, modec);
16648 break;
16650 case 'f': /* fg[#] or font */
16651 p = highlight_color(id, what, modec);
16652 break;
16654 case 'i':
16655 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16656 p = highlight_has_attr(id, HL_INVERSE, modec);
16657 else /* italic */
16658 p = highlight_has_attr(id, HL_ITALIC, modec);
16659 break;
16661 case 'n': /* name */
16662 p = get_highlight_name(NULL, id - 1);
16663 break;
16665 case 'r': /* reverse */
16666 p = highlight_has_attr(id, HL_INVERSE, modec);
16667 break;
16669 case 's':
16670 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16671 p = highlight_color(id, what, modec);
16672 else /* standout */
16673 p = highlight_has_attr(id, HL_STANDOUT, modec);
16674 break;
16676 case 'u':
16677 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16678 /* underline */
16679 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16680 else
16681 /* undercurl */
16682 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16683 break;
16686 if (p != NULL)
16687 p = vim_strsave(p);
16688 #endif
16689 rettv->v_type = VAR_STRING;
16690 rettv->vval.v_string = p;
16694 * "synIDtrans(id)" function
16696 static void
16697 f_synIDtrans(argvars, rettv)
16698 typval_T *argvars UNUSED;
16699 typval_T *rettv;
16701 int id;
16703 #ifdef FEAT_SYN_HL
16704 id = get_tv_number(&argvars[0]);
16706 if (id > 0)
16707 id = syn_get_final_id(id);
16708 else
16709 #endif
16710 id = 0;
16712 rettv->vval.v_number = id;
16716 * "synstack(lnum, col)" function
16718 static void
16719 f_synstack(argvars, rettv)
16720 typval_T *argvars UNUSED;
16721 typval_T *rettv;
16723 #ifdef FEAT_SYN_HL
16724 long lnum;
16725 long col;
16726 int i;
16727 int id;
16728 #endif
16730 rettv->v_type = VAR_LIST;
16731 rettv->vval.v_list = NULL;
16733 #ifdef FEAT_SYN_HL
16734 lnum = get_tv_lnum(argvars); /* -1 on type error */
16735 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16737 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16738 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16739 && rettv_list_alloc(rettv) != FAIL)
16741 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16742 for (i = 0; ; ++i)
16744 id = syn_get_stack_item(i);
16745 if (id < 0)
16746 break;
16747 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16748 break;
16751 #endif
16755 * "system()" function
16757 static void
16758 f_system(argvars, rettv)
16759 typval_T *argvars;
16760 typval_T *rettv;
16762 char_u *res = NULL;
16763 char_u *p;
16764 char_u *infile = NULL;
16765 char_u buf[NUMBUFLEN];
16766 int err = FALSE;
16767 FILE *fd;
16769 if (check_restricted() || check_secure())
16770 goto done;
16772 if (argvars[1].v_type != VAR_UNKNOWN)
16775 * Write the string to a temp file, to be used for input of the shell
16776 * command.
16778 if ((infile = vim_tempname('i')) == NULL)
16780 EMSG(_(e_notmp));
16781 goto done;
16784 fd = mch_fopen((char *)infile, WRITEBIN);
16785 if (fd == NULL)
16787 EMSG2(_(e_notopen), infile);
16788 goto done;
16790 p = get_tv_string_buf_chk(&argvars[1], buf);
16791 if (p == NULL)
16793 fclose(fd);
16794 goto done; /* type error; errmsg already given */
16796 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16797 err = TRUE;
16798 if (fclose(fd) != 0)
16799 err = TRUE;
16800 if (err)
16802 EMSG(_("E677: Error writing temp file"));
16803 goto done;
16807 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16808 SHELL_SILENT | SHELL_COOKED);
16810 #ifdef USE_CR
16811 /* translate <CR> into <NL> */
16812 if (res != NULL)
16814 char_u *s;
16816 for (s = res; *s; ++s)
16818 if (*s == CAR)
16819 *s = NL;
16822 #else
16823 # ifdef USE_CRNL
16824 /* translate <CR><NL> into <NL> */
16825 if (res != NULL)
16827 char_u *s, *d;
16829 d = res;
16830 for (s = res; *s; ++s)
16832 if (s[0] == CAR && s[1] == NL)
16833 ++s;
16834 *d++ = *s;
16836 *d = NUL;
16838 # endif
16839 #endif
16841 done:
16842 if (infile != NULL)
16844 mch_remove(infile);
16845 vim_free(infile);
16847 rettv->v_type = VAR_STRING;
16848 rettv->vval.v_string = res;
16852 * "tabpagebuflist()" function
16854 static void
16855 f_tabpagebuflist(argvars, rettv)
16856 typval_T *argvars UNUSED;
16857 typval_T *rettv UNUSED;
16859 #ifdef FEAT_WINDOWS
16860 tabpage_T *tp;
16861 win_T *wp = NULL;
16863 if (argvars[0].v_type == VAR_UNKNOWN)
16864 wp = firstwin;
16865 else
16867 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16868 if (tp != NULL)
16869 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16871 if (wp != NULL && rettv_list_alloc(rettv) != FAIL)
16873 for (; wp != NULL; wp = wp->w_next)
16874 if (list_append_number(rettv->vval.v_list,
16875 wp->w_buffer->b_fnum) == FAIL)
16876 break;
16878 #endif
16883 * "tabpagenr()" function
16885 static void
16886 f_tabpagenr(argvars, rettv)
16887 typval_T *argvars UNUSED;
16888 typval_T *rettv;
16890 int nr = 1;
16891 #ifdef FEAT_WINDOWS
16892 char_u *arg;
16894 if (argvars[0].v_type != VAR_UNKNOWN)
16896 arg = get_tv_string_chk(&argvars[0]);
16897 nr = 0;
16898 if (arg != NULL)
16900 if (STRCMP(arg, "$") == 0)
16901 nr = tabpage_index(NULL) - 1;
16902 else
16903 EMSG2(_(e_invexpr2), arg);
16906 else
16907 nr = tabpage_index(curtab);
16908 #endif
16909 rettv->vval.v_number = nr;
16913 #ifdef FEAT_WINDOWS
16914 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16917 * Common code for tabpagewinnr() and winnr().
16919 static int
16920 get_winnr(tp, argvar)
16921 tabpage_T *tp;
16922 typval_T *argvar;
16924 win_T *twin;
16925 int nr = 1;
16926 win_T *wp;
16927 char_u *arg;
16929 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16930 if (argvar->v_type != VAR_UNKNOWN)
16932 arg = get_tv_string_chk(argvar);
16933 if (arg == NULL)
16934 nr = 0; /* type error; errmsg already given */
16935 else if (STRCMP(arg, "$") == 0)
16936 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16937 else if (STRCMP(arg, "#") == 0)
16939 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16940 if (twin == NULL)
16941 nr = 0;
16943 else
16945 EMSG2(_(e_invexpr2), arg);
16946 nr = 0;
16950 if (nr > 0)
16951 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16952 wp != twin; wp = wp->w_next)
16954 if (wp == NULL)
16956 /* didn't find it in this tabpage */
16957 nr = 0;
16958 break;
16960 ++nr;
16962 return nr;
16964 #endif
16967 * "tabpagewinnr()" function
16969 static void
16970 f_tabpagewinnr(argvars, rettv)
16971 typval_T *argvars UNUSED;
16972 typval_T *rettv;
16974 int nr = 1;
16975 #ifdef FEAT_WINDOWS
16976 tabpage_T *tp;
16978 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16979 if (tp == NULL)
16980 nr = 0;
16981 else
16982 nr = get_winnr(tp, &argvars[1]);
16983 #endif
16984 rettv->vval.v_number = nr;
16989 * "tagfiles()" function
16991 static void
16992 f_tagfiles(argvars, rettv)
16993 typval_T *argvars UNUSED;
16994 typval_T *rettv;
16996 char_u fname[MAXPATHL + 1];
16997 tagname_T tn;
16998 int first;
17000 if (rettv_list_alloc(rettv) == FAIL)
17001 return;
17003 for (first = TRUE; ; first = FALSE)
17004 if (get_tagfname(&tn, first, fname) == FAIL
17005 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
17006 break;
17007 tagname_free(&tn);
17011 * "taglist()" function
17013 static void
17014 f_taglist(argvars, rettv)
17015 typval_T *argvars;
17016 typval_T *rettv;
17018 char_u *tag_pattern;
17020 tag_pattern = get_tv_string(&argvars[0]);
17022 rettv->vval.v_number = FALSE;
17023 if (*tag_pattern == NUL)
17024 return;
17026 if (rettv_list_alloc(rettv) == OK)
17027 (void)get_tags(rettv->vval.v_list, tag_pattern);
17031 * "tempname()" function
17033 static void
17034 f_tempname(argvars, rettv)
17035 typval_T *argvars UNUSED;
17036 typval_T *rettv;
17038 static int x = 'A';
17040 rettv->v_type = VAR_STRING;
17041 rettv->vval.v_string = vim_tempname(x);
17043 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17044 * names. Skip 'I' and 'O', they are used for shell redirection. */
17047 if (x == 'Z')
17048 x = '0';
17049 else if (x == '9')
17050 x = 'A';
17051 else
17053 #ifdef EBCDIC
17054 if (x == 'I')
17055 x = 'J';
17056 else if (x == 'R')
17057 x = 'S';
17058 else
17059 #endif
17060 ++x;
17062 } while (x == 'I' || x == 'O');
17066 * "test(list)" function: Just checking the walls...
17068 static void
17069 f_test(argvars, rettv)
17070 typval_T *argvars UNUSED;
17071 typval_T *rettv UNUSED;
17073 /* Used for unit testing. Change the code below to your liking. */
17074 #if 0
17075 listitem_T *li;
17076 list_T *l;
17077 char_u *bad, *good;
17079 if (argvars[0].v_type != VAR_LIST)
17080 return;
17081 l = argvars[0].vval.v_list;
17082 if (l == NULL)
17083 return;
17084 li = l->lv_first;
17085 if (li == NULL)
17086 return;
17087 bad = get_tv_string(&li->li_tv);
17088 li = li->li_next;
17089 if (li == NULL)
17090 return;
17091 good = get_tv_string(&li->li_tv);
17092 rettv->vval.v_number = test_edit_score(bad, good);
17093 #endif
17097 * "tolower(string)" function
17099 static void
17100 f_tolower(argvars, rettv)
17101 typval_T *argvars;
17102 typval_T *rettv;
17104 char_u *p;
17106 p = vim_strsave(get_tv_string(&argvars[0]));
17107 rettv->v_type = VAR_STRING;
17108 rettv->vval.v_string = p;
17110 if (p != NULL)
17111 while (*p != NUL)
17113 #ifdef FEAT_MBYTE
17114 int l;
17116 if (enc_utf8)
17118 int c, lc;
17120 c = utf_ptr2char(p);
17121 lc = utf_tolower(c);
17122 l = utf_ptr2len(p);
17123 /* TODO: reallocate string when byte count changes. */
17124 if (utf_char2len(lc) == l)
17125 utf_char2bytes(lc, p);
17126 p += l;
17128 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17129 p += l; /* skip multi-byte character */
17130 else
17131 #endif
17133 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17134 ++p;
17140 * "toupper(string)" function
17142 static void
17143 f_toupper(argvars, rettv)
17144 typval_T *argvars;
17145 typval_T *rettv;
17147 rettv->v_type = VAR_STRING;
17148 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17152 * "tr(string, fromstr, tostr)" function
17154 static void
17155 f_tr(argvars, rettv)
17156 typval_T *argvars;
17157 typval_T *rettv;
17159 char_u *instr;
17160 char_u *fromstr;
17161 char_u *tostr;
17162 char_u *p;
17163 #ifdef FEAT_MBYTE
17164 int inlen;
17165 int fromlen;
17166 int tolen;
17167 int idx;
17168 char_u *cpstr;
17169 int cplen;
17170 int first = TRUE;
17171 #endif
17172 char_u buf[NUMBUFLEN];
17173 char_u buf2[NUMBUFLEN];
17174 garray_T ga;
17176 instr = get_tv_string(&argvars[0]);
17177 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17178 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17180 /* Default return value: empty string. */
17181 rettv->v_type = VAR_STRING;
17182 rettv->vval.v_string = NULL;
17183 if (fromstr == NULL || tostr == NULL)
17184 return; /* type error; errmsg already given */
17185 ga_init2(&ga, (int)sizeof(char), 80);
17187 #ifdef FEAT_MBYTE
17188 if (!has_mbyte)
17189 #endif
17190 /* not multi-byte: fromstr and tostr must be the same length */
17191 if (STRLEN(fromstr) != STRLEN(tostr))
17193 #ifdef FEAT_MBYTE
17194 error:
17195 #endif
17196 EMSG2(_(e_invarg2), fromstr);
17197 ga_clear(&ga);
17198 return;
17201 /* fromstr and tostr have to contain the same number of chars */
17202 while (*instr != NUL)
17204 #ifdef FEAT_MBYTE
17205 if (has_mbyte)
17207 inlen = (*mb_ptr2len)(instr);
17208 cpstr = instr;
17209 cplen = inlen;
17210 idx = 0;
17211 for (p = fromstr; *p != NUL; p += fromlen)
17213 fromlen = (*mb_ptr2len)(p);
17214 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17216 for (p = tostr; *p != NUL; p += tolen)
17218 tolen = (*mb_ptr2len)(p);
17219 if (idx-- == 0)
17221 cplen = tolen;
17222 cpstr = p;
17223 break;
17226 if (*p == NUL) /* tostr is shorter than fromstr */
17227 goto error;
17228 break;
17230 ++idx;
17233 if (first && cpstr == instr)
17235 /* Check that fromstr and tostr have the same number of
17236 * (multi-byte) characters. Done only once when a character
17237 * of instr doesn't appear in fromstr. */
17238 first = FALSE;
17239 for (p = tostr; *p != NUL; p += tolen)
17241 tolen = (*mb_ptr2len)(p);
17242 --idx;
17244 if (idx != 0)
17245 goto error;
17248 ga_grow(&ga, cplen);
17249 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17250 ga.ga_len += cplen;
17252 instr += inlen;
17254 else
17255 #endif
17257 /* When not using multi-byte chars we can do it faster. */
17258 p = vim_strchr(fromstr, *instr);
17259 if (p != NULL)
17260 ga_append(&ga, tostr[p - fromstr]);
17261 else
17262 ga_append(&ga, *instr);
17263 ++instr;
17267 /* add a terminating NUL */
17268 ga_grow(&ga, 1);
17269 ga_append(&ga, NUL);
17271 rettv->vval.v_string = ga.ga_data;
17274 #ifdef FEAT_FLOAT
17276 * "trunc({float})" function
17278 static void
17279 f_trunc(argvars, rettv)
17280 typval_T *argvars;
17281 typval_T *rettv;
17283 float_T f;
17285 rettv->v_type = VAR_FLOAT;
17286 if (get_float_arg(argvars, &f) == OK)
17287 /* trunc() is not in C90, use floor() or ceil() instead. */
17288 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17289 else
17290 rettv->vval.v_float = 0.0;
17292 #endif
17295 * "type(expr)" function
17297 static void
17298 f_type(argvars, rettv)
17299 typval_T *argvars;
17300 typval_T *rettv;
17302 int n;
17304 switch (argvars[0].v_type)
17306 case VAR_NUMBER: n = 0; break;
17307 case VAR_STRING: n = 1; break;
17308 case VAR_FUNC: n = 2; break;
17309 case VAR_LIST: n = 3; break;
17310 case VAR_DICT: n = 4; break;
17311 #ifdef FEAT_FLOAT
17312 case VAR_FLOAT: n = 5; break;
17313 #endif
17314 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17316 rettv->vval.v_number = n;
17320 * "values(dict)" function
17322 static void
17323 f_values(argvars, rettv)
17324 typval_T *argvars;
17325 typval_T *rettv;
17327 dict_list(argvars, rettv, 1);
17331 * "virtcol(string)" function
17333 static void
17334 f_virtcol(argvars, rettv)
17335 typval_T *argvars;
17336 typval_T *rettv;
17338 colnr_T vcol = 0;
17339 pos_T *fp;
17340 int fnum = curbuf->b_fnum;
17342 fp = var2fpos(&argvars[0], FALSE, &fnum);
17343 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17344 && fnum == curbuf->b_fnum)
17346 getvvcol(curwin, fp, NULL, NULL, &vcol);
17347 ++vcol;
17350 rettv->vval.v_number = vcol;
17354 * "visualmode()" function
17356 static void
17357 f_visualmode(argvars, rettv)
17358 typval_T *argvars UNUSED;
17359 typval_T *rettv UNUSED;
17361 #ifdef FEAT_VISUAL
17362 char_u str[2];
17364 rettv->v_type = VAR_STRING;
17365 str[0] = curbuf->b_visual_mode_eval;
17366 str[1] = NUL;
17367 rettv->vval.v_string = vim_strsave(str);
17369 /* A non-zero number or non-empty string argument: reset mode. */
17370 if (non_zero_arg(&argvars[0]))
17371 curbuf->b_visual_mode_eval = NUL;
17372 #endif
17376 * "winbufnr(nr)" function
17378 static void
17379 f_winbufnr(argvars, rettv)
17380 typval_T *argvars;
17381 typval_T *rettv;
17383 win_T *wp;
17385 wp = find_win_by_nr(&argvars[0], NULL);
17386 if (wp == NULL)
17387 rettv->vval.v_number = -1;
17388 else
17389 rettv->vval.v_number = wp->w_buffer->b_fnum;
17393 * "wincol()" function
17395 static void
17396 f_wincol(argvars, rettv)
17397 typval_T *argvars UNUSED;
17398 typval_T *rettv;
17400 validate_cursor();
17401 rettv->vval.v_number = curwin->w_wcol + 1;
17405 * "winheight(nr)" function
17407 static void
17408 f_winheight(argvars, rettv)
17409 typval_T *argvars;
17410 typval_T *rettv;
17412 win_T *wp;
17414 wp = find_win_by_nr(&argvars[0], NULL);
17415 if (wp == NULL)
17416 rettv->vval.v_number = -1;
17417 else
17418 rettv->vval.v_number = wp->w_height;
17422 * "winline()" function
17424 static void
17425 f_winline(argvars, rettv)
17426 typval_T *argvars UNUSED;
17427 typval_T *rettv;
17429 validate_cursor();
17430 rettv->vval.v_number = curwin->w_wrow + 1;
17434 * "winnr()" function
17436 static void
17437 f_winnr(argvars, rettv)
17438 typval_T *argvars UNUSED;
17439 typval_T *rettv;
17441 int nr = 1;
17443 #ifdef FEAT_WINDOWS
17444 nr = get_winnr(curtab, &argvars[0]);
17445 #endif
17446 rettv->vval.v_number = nr;
17450 * "winrestcmd()" function
17452 static void
17453 f_winrestcmd(argvars, rettv)
17454 typval_T *argvars UNUSED;
17455 typval_T *rettv;
17457 #ifdef FEAT_WINDOWS
17458 win_T *wp;
17459 int winnr = 1;
17460 garray_T ga;
17461 char_u buf[50];
17463 ga_init2(&ga, (int)sizeof(char), 70);
17464 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17466 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17467 ga_concat(&ga, buf);
17468 # ifdef FEAT_VERTSPLIT
17469 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17470 ga_concat(&ga, buf);
17471 # endif
17472 ++winnr;
17474 ga_append(&ga, NUL);
17476 rettv->vval.v_string = ga.ga_data;
17477 #else
17478 rettv->vval.v_string = NULL;
17479 #endif
17480 rettv->v_type = VAR_STRING;
17484 * "winrestview()" function
17486 static void
17487 f_winrestview(argvars, rettv)
17488 typval_T *argvars;
17489 typval_T *rettv UNUSED;
17491 dict_T *dict;
17493 if (argvars[0].v_type != VAR_DICT
17494 || (dict = argvars[0].vval.v_dict) == NULL)
17495 EMSG(_(e_invarg));
17496 else
17498 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17499 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17500 #ifdef FEAT_VIRTUALEDIT
17501 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17502 #endif
17503 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17504 curwin->w_set_curswant = FALSE;
17506 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17507 #ifdef FEAT_DIFF
17508 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17509 #endif
17510 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17511 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17513 check_cursor();
17514 changed_cline_bef_curs();
17515 invalidate_botline();
17516 redraw_later(VALID);
17518 if (curwin->w_topline == 0)
17519 curwin->w_topline = 1;
17520 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17521 curwin->w_topline = curbuf->b_ml.ml_line_count;
17522 #ifdef FEAT_DIFF
17523 check_topfill(curwin, TRUE);
17524 #endif
17529 * "winsaveview()" function
17531 static void
17532 f_winsaveview(argvars, rettv)
17533 typval_T *argvars UNUSED;
17534 typval_T *rettv;
17536 dict_T *dict;
17538 dict = dict_alloc();
17539 if (dict == NULL)
17540 return;
17541 rettv->v_type = VAR_DICT;
17542 rettv->vval.v_dict = dict;
17543 ++dict->dv_refcount;
17545 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17546 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17547 #ifdef FEAT_VIRTUALEDIT
17548 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17549 #endif
17550 update_curswant();
17551 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17553 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17554 #ifdef FEAT_DIFF
17555 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17556 #endif
17557 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17558 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17562 * "winwidth(nr)" function
17564 static void
17565 f_winwidth(argvars, rettv)
17566 typval_T *argvars;
17567 typval_T *rettv;
17569 win_T *wp;
17571 wp = find_win_by_nr(&argvars[0], NULL);
17572 if (wp == NULL)
17573 rettv->vval.v_number = -1;
17574 else
17575 #ifdef FEAT_VERTSPLIT
17576 rettv->vval.v_number = wp->w_width;
17577 #else
17578 rettv->vval.v_number = Columns;
17579 #endif
17583 * "writefile()" function
17585 static void
17586 f_writefile(argvars, rettv)
17587 typval_T *argvars;
17588 typval_T *rettv;
17590 int binary = FALSE;
17591 char_u *fname;
17592 FILE *fd;
17593 listitem_T *li;
17594 char_u *s;
17595 int ret = 0;
17596 int c;
17598 if (check_restricted() || check_secure())
17599 return;
17601 if (argvars[0].v_type != VAR_LIST)
17603 EMSG2(_(e_listarg), "writefile()");
17604 return;
17606 if (argvars[0].vval.v_list == NULL)
17607 return;
17609 if (argvars[2].v_type != VAR_UNKNOWN
17610 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17611 binary = TRUE;
17613 /* Always open the file in binary mode, library functions have a mind of
17614 * their own about CR-LF conversion. */
17615 fname = get_tv_string(&argvars[1]);
17616 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17618 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17619 ret = -1;
17621 else
17623 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17624 li = li->li_next)
17626 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17628 if (*s == '\n')
17629 c = putc(NUL, fd);
17630 else
17631 c = putc(*s, fd);
17632 if (c == EOF)
17634 ret = -1;
17635 break;
17638 if (!binary || li->li_next != NULL)
17639 if (putc('\n', fd) == EOF)
17641 ret = -1;
17642 break;
17644 if (ret < 0)
17646 EMSG(_(e_write));
17647 break;
17650 fclose(fd);
17653 rettv->vval.v_number = ret;
17657 * Translate a String variable into a position.
17658 * Returns NULL when there is an error.
17660 static pos_T *
17661 var2fpos(varp, dollar_lnum, fnum)
17662 typval_T *varp;
17663 int dollar_lnum; /* TRUE when $ is last line */
17664 int *fnum; /* set to fnum for '0, 'A, etc. */
17666 char_u *name;
17667 static pos_T pos;
17668 pos_T *pp;
17670 /* Argument can be [lnum, col, coladd]. */
17671 if (varp->v_type == VAR_LIST)
17673 list_T *l;
17674 int len;
17675 int error = FALSE;
17676 listitem_T *li;
17678 l = varp->vval.v_list;
17679 if (l == NULL)
17680 return NULL;
17682 /* Get the line number */
17683 pos.lnum = list_find_nr(l, 0L, &error);
17684 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17685 return NULL; /* invalid line number */
17687 /* Get the column number */
17688 pos.col = list_find_nr(l, 1L, &error);
17689 if (error)
17690 return NULL;
17691 len = (long)STRLEN(ml_get(pos.lnum));
17693 /* We accept "$" for the column number: last column. */
17694 li = list_find(l, 1L);
17695 if (li != NULL && li->li_tv.v_type == VAR_STRING
17696 && li->li_tv.vval.v_string != NULL
17697 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17698 pos.col = len + 1;
17700 /* Accept a position up to the NUL after the line. */
17701 if (pos.col == 0 || (int)pos.col > len + 1)
17702 return NULL; /* invalid column number */
17703 --pos.col;
17705 #ifdef FEAT_VIRTUALEDIT
17706 /* Get the virtual offset. Defaults to zero. */
17707 pos.coladd = list_find_nr(l, 2L, &error);
17708 if (error)
17709 pos.coladd = 0;
17710 #endif
17712 return &pos;
17715 name = get_tv_string_chk(varp);
17716 if (name == NULL)
17717 return NULL;
17718 if (name[0] == '.') /* cursor */
17719 return &curwin->w_cursor;
17720 #ifdef FEAT_VISUAL
17721 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17723 if (VIsual_active)
17724 return &VIsual;
17725 return &curwin->w_cursor;
17727 #endif
17728 if (name[0] == '\'') /* mark */
17730 pp = getmark_fnum(name[1], FALSE, fnum);
17731 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17732 return NULL;
17733 return pp;
17736 #ifdef FEAT_VIRTUALEDIT
17737 pos.coladd = 0;
17738 #endif
17740 if (name[0] == 'w' && dollar_lnum)
17742 pos.col = 0;
17743 if (name[1] == '0') /* "w0": first visible line */
17745 update_topline();
17746 pos.lnum = curwin->w_topline;
17747 return &pos;
17749 else if (name[1] == '$') /* "w$": last visible line */
17751 validate_botline();
17752 pos.lnum = curwin->w_botline - 1;
17753 return &pos;
17756 else if (name[0] == '$') /* last column or line */
17758 if (dollar_lnum)
17760 pos.lnum = curbuf->b_ml.ml_line_count;
17761 pos.col = 0;
17763 else
17765 pos.lnum = curwin->w_cursor.lnum;
17766 pos.col = (colnr_T)STRLEN(ml_get_curline());
17768 return &pos;
17770 return NULL;
17774 * Convert list in "arg" into a position and optional file number.
17775 * When "fnump" is NULL there is no file number, only 3 items.
17776 * Note that the column is passed on as-is, the caller may want to decrement
17777 * it to use 1 for the first column.
17778 * Return FAIL when conversion is not possible, doesn't check the position for
17779 * validity.
17781 static int
17782 list2fpos(arg, posp, fnump)
17783 typval_T *arg;
17784 pos_T *posp;
17785 int *fnump;
17787 list_T *l = arg->vval.v_list;
17788 long i = 0;
17789 long n;
17791 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17792 * when "fnump" isn't NULL and "coladd" is optional. */
17793 if (arg->v_type != VAR_LIST
17794 || l == NULL
17795 || l->lv_len < (fnump == NULL ? 2 : 3)
17796 || l->lv_len > (fnump == NULL ? 3 : 4))
17797 return FAIL;
17799 if (fnump != NULL)
17801 n = list_find_nr(l, i++, NULL); /* fnum */
17802 if (n < 0)
17803 return FAIL;
17804 if (n == 0)
17805 n = curbuf->b_fnum; /* current buffer */
17806 *fnump = n;
17809 n = list_find_nr(l, i++, NULL); /* lnum */
17810 if (n < 0)
17811 return FAIL;
17812 posp->lnum = n;
17814 n = list_find_nr(l, i++, NULL); /* col */
17815 if (n < 0)
17816 return FAIL;
17817 posp->col = n;
17819 #ifdef FEAT_VIRTUALEDIT
17820 n = list_find_nr(l, i, NULL);
17821 if (n < 0)
17822 posp->coladd = 0;
17823 else
17824 posp->coladd = n;
17825 #endif
17827 return OK;
17831 * Get the length of an environment variable name.
17832 * Advance "arg" to the first character after the name.
17833 * Return 0 for error.
17835 static int
17836 get_env_len(arg)
17837 char_u **arg;
17839 char_u *p;
17840 int len;
17842 for (p = *arg; vim_isIDc(*p); ++p)
17844 if (p == *arg) /* no name found */
17845 return 0;
17847 len = (int)(p - *arg);
17848 *arg = p;
17849 return len;
17853 * Get the length of the name of a function or internal variable.
17854 * "arg" is advanced to the first non-white character after the name.
17855 * Return 0 if something is wrong.
17857 static int
17858 get_id_len(arg)
17859 char_u **arg;
17861 char_u *p;
17862 int len;
17864 /* Find the end of the name. */
17865 for (p = *arg; eval_isnamec(*p); ++p)
17867 if (p == *arg) /* no name found */
17868 return 0;
17870 len = (int)(p - *arg);
17871 *arg = skipwhite(p);
17873 return len;
17877 * Get the length of the name of a variable or function.
17878 * Only the name is recognized, does not handle ".key" or "[idx]".
17879 * "arg" is advanced to the first non-white character after the name.
17880 * Return -1 if curly braces expansion failed.
17881 * Return 0 if something else is wrong.
17882 * If the name contains 'magic' {}'s, expand them and return the
17883 * expanded name in an allocated string via 'alias' - caller must free.
17885 static int
17886 get_name_len(arg, alias, evaluate, verbose)
17887 char_u **arg;
17888 char_u **alias;
17889 int evaluate;
17890 int verbose;
17892 int len;
17893 char_u *p;
17894 char_u *expr_start;
17895 char_u *expr_end;
17897 *alias = NULL; /* default to no alias */
17899 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17900 && (*arg)[2] == (int)KE_SNR)
17902 /* hard coded <SNR>, already translated */
17903 *arg += 3;
17904 return get_id_len(arg) + 3;
17906 len = eval_fname_script(*arg);
17907 if (len > 0)
17909 /* literal "<SID>", "s:" or "<SNR>" */
17910 *arg += len;
17914 * Find the end of the name; check for {} construction.
17916 p = find_name_end(*arg, &expr_start, &expr_end,
17917 len > 0 ? 0 : FNE_CHECK_START);
17918 if (expr_start != NULL)
17920 char_u *temp_string;
17922 if (!evaluate)
17924 len += (int)(p - *arg);
17925 *arg = skipwhite(p);
17926 return len;
17930 * Include any <SID> etc in the expanded string:
17931 * Thus the -len here.
17933 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17934 if (temp_string == NULL)
17935 return -1;
17936 *alias = temp_string;
17937 *arg = skipwhite(p);
17938 return (int)STRLEN(temp_string);
17941 len += get_id_len(arg);
17942 if (len == 0 && verbose)
17943 EMSG2(_(e_invexpr2), *arg);
17945 return len;
17949 * Find the end of a variable or function name, taking care of magic braces.
17950 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17951 * start and end of the first magic braces item.
17952 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17953 * Return a pointer to just after the name. Equal to "arg" if there is no
17954 * valid name.
17956 static char_u *
17957 find_name_end(arg, expr_start, expr_end, flags)
17958 char_u *arg;
17959 char_u **expr_start;
17960 char_u **expr_end;
17961 int flags;
17963 int mb_nest = 0;
17964 int br_nest = 0;
17965 char_u *p;
17967 if (expr_start != NULL)
17969 *expr_start = NULL;
17970 *expr_end = NULL;
17973 /* Quick check for valid starting character. */
17974 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17975 return arg;
17977 for (p = arg; *p != NUL
17978 && (eval_isnamec(*p)
17979 || *p == '{'
17980 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17981 || mb_nest != 0
17982 || br_nest != 0); mb_ptr_adv(p))
17984 if (*p == '\'')
17986 /* skip over 'string' to avoid counting [ and ] inside it. */
17987 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17989 if (*p == NUL)
17990 break;
17992 else if (*p == '"')
17994 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17995 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17996 if (*p == '\\' && p[1] != NUL)
17997 ++p;
17998 if (*p == NUL)
17999 break;
18002 if (mb_nest == 0)
18004 if (*p == '[')
18005 ++br_nest;
18006 else if (*p == ']')
18007 --br_nest;
18010 if (br_nest == 0)
18012 if (*p == '{')
18014 mb_nest++;
18015 if (expr_start != NULL && *expr_start == NULL)
18016 *expr_start = p;
18018 else if (*p == '}')
18020 mb_nest--;
18021 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18022 *expr_end = p;
18027 return p;
18031 * Expands out the 'magic' {}'s in a variable/function name.
18032 * Note that this can call itself recursively, to deal with
18033 * constructs like foo{bar}{baz}{bam}
18034 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18035 * "in_start" ^
18036 * "expr_start" ^
18037 * "expr_end" ^
18038 * "in_end" ^
18040 * Returns a new allocated string, which the caller must free.
18041 * Returns NULL for failure.
18043 static char_u *
18044 make_expanded_name(in_start, expr_start, expr_end, in_end)
18045 char_u *in_start;
18046 char_u *expr_start;
18047 char_u *expr_end;
18048 char_u *in_end;
18050 char_u c1;
18051 char_u *retval = NULL;
18052 char_u *temp_result;
18053 char_u *nextcmd = NULL;
18055 if (expr_end == NULL || in_end == NULL)
18056 return NULL;
18057 *expr_start = NUL;
18058 *expr_end = NUL;
18059 c1 = *in_end;
18060 *in_end = NUL;
18062 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18063 if (temp_result != NULL && nextcmd == NULL)
18065 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18066 + (in_end - expr_end) + 1));
18067 if (retval != NULL)
18069 STRCPY(retval, in_start);
18070 STRCAT(retval, temp_result);
18071 STRCAT(retval, expr_end + 1);
18074 vim_free(temp_result);
18076 *in_end = c1; /* put char back for error messages */
18077 *expr_start = '{';
18078 *expr_end = '}';
18080 if (retval != NULL)
18082 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18083 if (expr_start != NULL)
18085 /* Further expansion! */
18086 temp_result = make_expanded_name(retval, expr_start,
18087 expr_end, temp_result);
18088 vim_free(retval);
18089 retval = temp_result;
18093 return retval;
18097 * Return TRUE if character "c" can be used in a variable or function name.
18098 * Does not include '{' or '}' for magic braces.
18100 static int
18101 eval_isnamec(c)
18102 int c;
18104 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18108 * Return TRUE if character "c" can be used as the first character in a
18109 * variable or function name (excluding '{' and '}').
18111 static int
18112 eval_isnamec1(c)
18113 int c;
18115 return (ASCII_ISALPHA(c) || c == '_');
18119 * Set number v: variable to "val".
18121 void
18122 set_vim_var_nr(idx, val)
18123 int idx;
18124 long val;
18126 vimvars[idx].vv_nr = val;
18130 * Get number v: variable value.
18132 long
18133 get_vim_var_nr(idx)
18134 int idx;
18136 return vimvars[idx].vv_nr;
18140 * Get string v: variable value. Uses a static buffer, can only be used once.
18142 char_u *
18143 get_vim_var_str(idx)
18144 int idx;
18146 return get_tv_string(&vimvars[idx].vv_tv);
18150 * Get List v: variable value. Caller must take care of reference count when
18151 * needed.
18153 list_T *
18154 get_vim_var_list(idx)
18155 int idx;
18157 return vimvars[idx].vv_list;
18161 * Set v:char to character "c".
18163 void
18164 set_vim_var_char(c)
18165 int c;
18167 #ifdef FEAT_MBYTE
18168 char_u buf[MB_MAXBYTES];
18169 #else
18170 char_u buf[2];
18171 #endif
18173 #ifdef FEAT_MBYTE
18174 if (has_mbyte)
18175 buf[(*mb_char2bytes)(c, buf)] = NUL;
18176 else
18177 #endif
18179 buf[0] = c;
18180 buf[1] = NUL;
18182 set_vim_var_string(VV_CHAR, buf, -1);
18186 * Set v:count to "count" and v:count1 to "count1".
18187 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18189 void
18190 set_vcount(count, count1, set_prevcount)
18191 long count;
18192 long count1;
18193 int set_prevcount;
18195 if (set_prevcount)
18196 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18197 vimvars[VV_COUNT].vv_nr = count;
18198 vimvars[VV_COUNT1].vv_nr = count1;
18202 * Set string v: variable to a copy of "val".
18204 void
18205 set_vim_var_string(idx, val, len)
18206 int idx;
18207 char_u *val;
18208 int len; /* length of "val" to use or -1 (whole string) */
18210 /* Need to do this (at least) once, since we can't initialize a union.
18211 * Will always be invoked when "v:progname" is set. */
18212 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18214 vim_free(vimvars[idx].vv_str);
18215 if (val == NULL)
18216 vimvars[idx].vv_str = NULL;
18217 else if (len == -1)
18218 vimvars[idx].vv_str = vim_strsave(val);
18219 else
18220 vimvars[idx].vv_str = vim_strnsave(val, len);
18224 * Set List v: variable to "val".
18226 void
18227 set_vim_var_list(idx, val)
18228 int idx;
18229 list_T *val;
18231 list_unref(vimvars[idx].vv_list);
18232 vimvars[idx].vv_list = val;
18233 if (val != NULL)
18234 ++val->lv_refcount;
18238 * Set v:register if needed.
18240 void
18241 set_reg_var(c)
18242 int c;
18244 char_u regname;
18246 if (c == 0 || c == ' ')
18247 regname = '"';
18248 else
18249 regname = c;
18250 /* Avoid free/alloc when the value is already right. */
18251 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18252 set_vim_var_string(VV_REG, &regname, 1);
18256 * Get or set v:exception. If "oldval" == NULL, return the current value.
18257 * Otherwise, restore the value to "oldval" and return NULL.
18258 * Must always be called in pairs to save and restore v:exception! Does not
18259 * take care of memory allocations.
18261 char_u *
18262 v_exception(oldval)
18263 char_u *oldval;
18265 if (oldval == NULL)
18266 return vimvars[VV_EXCEPTION].vv_str;
18268 vimvars[VV_EXCEPTION].vv_str = oldval;
18269 return NULL;
18273 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18274 * Otherwise, restore the value to "oldval" and return NULL.
18275 * Must always be called in pairs to save and restore v:throwpoint! Does not
18276 * take care of memory allocations.
18278 char_u *
18279 v_throwpoint(oldval)
18280 char_u *oldval;
18282 if (oldval == NULL)
18283 return vimvars[VV_THROWPOINT].vv_str;
18285 vimvars[VV_THROWPOINT].vv_str = oldval;
18286 return NULL;
18289 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18291 * Set v:cmdarg.
18292 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18293 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18294 * Must always be called in pairs!
18296 char_u *
18297 set_cmdarg(eap, oldarg)
18298 exarg_T *eap;
18299 char_u *oldarg;
18301 char_u *oldval;
18302 char_u *newval;
18303 unsigned len;
18305 oldval = vimvars[VV_CMDARG].vv_str;
18306 if (eap == NULL)
18308 vim_free(oldval);
18309 vimvars[VV_CMDARG].vv_str = oldarg;
18310 return NULL;
18313 if (eap->force_bin == FORCE_BIN)
18314 len = 6;
18315 else if (eap->force_bin == FORCE_NOBIN)
18316 len = 8;
18317 else
18318 len = 0;
18320 if (eap->read_edit)
18321 len += 7;
18323 if (eap->force_ff != 0)
18324 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18325 # ifdef FEAT_MBYTE
18326 if (eap->force_enc != 0)
18327 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18328 if (eap->bad_char != 0)
18329 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18330 # endif
18332 newval = alloc(len + 1);
18333 if (newval == NULL)
18334 return NULL;
18336 if (eap->force_bin == FORCE_BIN)
18337 sprintf((char *)newval, " ++bin");
18338 else if (eap->force_bin == FORCE_NOBIN)
18339 sprintf((char *)newval, " ++nobin");
18340 else
18341 *newval = NUL;
18343 if (eap->read_edit)
18344 STRCAT(newval, " ++edit");
18346 if (eap->force_ff != 0)
18347 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18348 eap->cmd + eap->force_ff);
18349 # ifdef FEAT_MBYTE
18350 if (eap->force_enc != 0)
18351 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18352 eap->cmd + eap->force_enc);
18353 if (eap->bad_char != 0)
18354 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18355 eap->cmd + eap->bad_char);
18356 # endif
18357 vimvars[VV_CMDARG].vv_str = newval;
18358 return oldval;
18360 #endif
18363 * Get the value of internal variable "name".
18364 * Return OK or FAIL.
18366 static int
18367 get_var_tv(name, len, rettv, verbose)
18368 char_u *name;
18369 int len; /* length of "name" */
18370 typval_T *rettv; /* NULL when only checking existence */
18371 int verbose; /* may give error message */
18373 int ret = OK;
18374 typval_T *tv = NULL;
18375 typval_T atv;
18376 dictitem_T *v;
18377 int cc;
18379 /* truncate the name, so that we can use strcmp() */
18380 cc = name[len];
18381 name[len] = NUL;
18384 * Check for "b:changedtick".
18386 if (STRCMP(name, "b:changedtick") == 0)
18388 atv.v_type = VAR_NUMBER;
18389 atv.vval.v_number = curbuf->b_changedtick;
18390 tv = &atv;
18394 * Check for user-defined variables.
18396 else
18398 v = find_var(name, NULL);
18399 if (v != NULL)
18400 tv = &v->di_tv;
18403 if (tv == NULL)
18405 if (rettv != NULL && verbose)
18406 EMSG2(_(e_undefvar), name);
18407 ret = FAIL;
18409 else if (rettv != NULL)
18410 copy_tv(tv, rettv);
18412 name[len] = cc;
18414 return ret;
18418 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18419 * Also handle function call with Funcref variable: func(expr)
18420 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18422 static int
18423 handle_subscript(arg, rettv, evaluate, verbose)
18424 char_u **arg;
18425 typval_T *rettv;
18426 int evaluate; /* do more than finding the end */
18427 int verbose; /* give error messages */
18429 int ret = OK;
18430 dict_T *selfdict = NULL;
18431 char_u *s;
18432 int len;
18433 typval_T functv;
18435 while (ret == OK
18436 && (**arg == '['
18437 || (**arg == '.' && rettv->v_type == VAR_DICT)
18438 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18439 && !vim_iswhite(*(*arg - 1)))
18441 if (**arg == '(')
18443 /* need to copy the funcref so that we can clear rettv */
18444 functv = *rettv;
18445 rettv->v_type = VAR_UNKNOWN;
18447 /* Invoke the function. Recursive! */
18448 s = functv.vval.v_string;
18449 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18450 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18451 &len, evaluate, selfdict);
18453 /* Clear the funcref afterwards, so that deleting it while
18454 * evaluating the arguments is possible (see test55). */
18455 clear_tv(&functv);
18457 /* Stop the expression evaluation when immediately aborting on
18458 * error, or when an interrupt occurred or an exception was thrown
18459 * but not caught. */
18460 if (aborting())
18462 if (ret == OK)
18463 clear_tv(rettv);
18464 ret = FAIL;
18466 dict_unref(selfdict);
18467 selfdict = NULL;
18469 else /* **arg == '[' || **arg == '.' */
18471 dict_unref(selfdict);
18472 if (rettv->v_type == VAR_DICT)
18474 selfdict = rettv->vval.v_dict;
18475 if (selfdict != NULL)
18476 ++selfdict->dv_refcount;
18478 else
18479 selfdict = NULL;
18480 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18482 clear_tv(rettv);
18483 ret = FAIL;
18487 dict_unref(selfdict);
18488 return ret;
18492 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18493 * value).
18495 static typval_T *
18496 alloc_tv()
18498 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18502 * Allocate memory for a variable type-value, and assign a string to it.
18503 * The string "s" must have been allocated, it is consumed.
18504 * Return NULL for out of memory, the variable otherwise.
18506 static typval_T *
18507 alloc_string_tv(s)
18508 char_u *s;
18510 typval_T *rettv;
18512 rettv = alloc_tv();
18513 if (rettv != NULL)
18515 rettv->v_type = VAR_STRING;
18516 rettv->vval.v_string = s;
18518 else
18519 vim_free(s);
18520 return rettv;
18524 * Free the memory for a variable type-value.
18526 void
18527 free_tv(varp)
18528 typval_T *varp;
18530 if (varp != NULL)
18532 switch (varp->v_type)
18534 case VAR_FUNC:
18535 func_unref(varp->vval.v_string);
18536 /*FALLTHROUGH*/
18537 case VAR_STRING:
18538 vim_free(varp->vval.v_string);
18539 break;
18540 case VAR_LIST:
18541 list_unref(varp->vval.v_list);
18542 break;
18543 case VAR_DICT:
18544 dict_unref(varp->vval.v_dict);
18545 break;
18546 case VAR_NUMBER:
18547 #ifdef FEAT_FLOAT
18548 case VAR_FLOAT:
18549 #endif
18550 case VAR_UNKNOWN:
18551 break;
18552 default:
18553 EMSG2(_(e_intern2), "free_tv()");
18554 break;
18556 vim_free(varp);
18561 * Free the memory for a variable value and set the value to NULL or 0.
18563 void
18564 clear_tv(varp)
18565 typval_T *varp;
18567 if (varp != NULL)
18569 switch (varp->v_type)
18571 case VAR_FUNC:
18572 func_unref(varp->vval.v_string);
18573 /*FALLTHROUGH*/
18574 case VAR_STRING:
18575 vim_free(varp->vval.v_string);
18576 varp->vval.v_string = NULL;
18577 break;
18578 case VAR_LIST:
18579 list_unref(varp->vval.v_list);
18580 varp->vval.v_list = NULL;
18581 break;
18582 case VAR_DICT:
18583 dict_unref(varp->vval.v_dict);
18584 varp->vval.v_dict = NULL;
18585 break;
18586 case VAR_NUMBER:
18587 varp->vval.v_number = 0;
18588 break;
18589 #ifdef FEAT_FLOAT
18590 case VAR_FLOAT:
18591 varp->vval.v_float = 0.0;
18592 break;
18593 #endif
18594 case VAR_UNKNOWN:
18595 break;
18596 default:
18597 EMSG2(_(e_intern2), "clear_tv()");
18599 varp->v_lock = 0;
18604 * Set the value of a variable to NULL without freeing items.
18606 static void
18607 init_tv(varp)
18608 typval_T *varp;
18610 if (varp != NULL)
18611 vim_memset(varp, 0, sizeof(typval_T));
18615 * Get the number value of a variable.
18616 * If it is a String variable, uses vim_str2nr().
18617 * For incompatible types, return 0.
18618 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18619 * caller of incompatible types: it sets *denote to TRUE if "denote"
18620 * is not NULL or returns -1 otherwise.
18622 static long
18623 get_tv_number(varp)
18624 typval_T *varp;
18626 int error = FALSE;
18628 return get_tv_number_chk(varp, &error); /* return 0L on error */
18631 long
18632 get_tv_number_chk(varp, denote)
18633 typval_T *varp;
18634 int *denote;
18636 long n = 0L;
18638 switch (varp->v_type)
18640 case VAR_NUMBER:
18641 return (long)(varp->vval.v_number);
18642 #ifdef FEAT_FLOAT
18643 case VAR_FLOAT:
18644 EMSG(_("E805: Using a Float as a Number"));
18645 break;
18646 #endif
18647 case VAR_FUNC:
18648 EMSG(_("E703: Using a Funcref as a Number"));
18649 break;
18650 case VAR_STRING:
18651 if (varp->vval.v_string != NULL)
18652 vim_str2nr(varp->vval.v_string, NULL, NULL,
18653 TRUE, TRUE, &n, NULL);
18654 return n;
18655 case VAR_LIST:
18656 EMSG(_("E745: Using a List as a Number"));
18657 break;
18658 case VAR_DICT:
18659 EMSG(_("E728: Using a Dictionary as a Number"));
18660 break;
18661 default:
18662 EMSG2(_(e_intern2), "get_tv_number()");
18663 break;
18665 if (denote == NULL) /* useful for values that must be unsigned */
18666 n = -1;
18667 else
18668 *denote = TRUE;
18669 return n;
18673 * Get the lnum from the first argument.
18674 * Also accepts ".", "$", etc., but that only works for the current buffer.
18675 * Returns -1 on error.
18677 static linenr_T
18678 get_tv_lnum(argvars)
18679 typval_T *argvars;
18681 typval_T rettv;
18682 linenr_T lnum;
18684 lnum = get_tv_number_chk(&argvars[0], NULL);
18685 if (lnum == 0) /* no valid number, try using line() */
18687 rettv.v_type = VAR_NUMBER;
18688 f_line(argvars, &rettv);
18689 lnum = rettv.vval.v_number;
18690 clear_tv(&rettv);
18692 return lnum;
18696 * Get the lnum from the first argument.
18697 * Also accepts "$", then "buf" is used.
18698 * Returns 0 on error.
18700 static linenr_T
18701 get_tv_lnum_buf(argvars, buf)
18702 typval_T *argvars;
18703 buf_T *buf;
18705 if (argvars[0].v_type == VAR_STRING
18706 && argvars[0].vval.v_string != NULL
18707 && argvars[0].vval.v_string[0] == '$'
18708 && buf != NULL)
18709 return buf->b_ml.ml_line_count;
18710 return get_tv_number_chk(&argvars[0], NULL);
18714 * Get the string value of a variable.
18715 * If it is a Number variable, the number is converted into a string.
18716 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18717 * get_tv_string_buf() uses a given buffer.
18718 * If the String variable has never been set, return an empty string.
18719 * Never returns NULL;
18720 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18721 * NULL on error.
18723 static char_u *
18724 get_tv_string(varp)
18725 typval_T *varp;
18727 static char_u mybuf[NUMBUFLEN];
18729 return get_tv_string_buf(varp, mybuf);
18732 static char_u *
18733 get_tv_string_buf(varp, buf)
18734 typval_T *varp;
18735 char_u *buf;
18737 char_u *res = get_tv_string_buf_chk(varp, buf);
18739 return res != NULL ? res : (char_u *)"";
18742 char_u *
18743 get_tv_string_chk(varp)
18744 typval_T *varp;
18746 static char_u mybuf[NUMBUFLEN];
18748 return get_tv_string_buf_chk(varp, mybuf);
18751 static char_u *
18752 get_tv_string_buf_chk(varp, buf)
18753 typval_T *varp;
18754 char_u *buf;
18756 switch (varp->v_type)
18758 case VAR_NUMBER:
18759 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18760 return buf;
18761 case VAR_FUNC:
18762 EMSG(_("E729: using Funcref as a String"));
18763 break;
18764 case VAR_LIST:
18765 EMSG(_("E730: using List as a String"));
18766 break;
18767 case VAR_DICT:
18768 EMSG(_("E731: using Dictionary as a String"));
18769 break;
18770 #ifdef FEAT_FLOAT
18771 case VAR_FLOAT:
18772 EMSG(_("E806: using Float as a String"));
18773 break;
18774 #endif
18775 case VAR_STRING:
18776 if (varp->vval.v_string != NULL)
18777 return varp->vval.v_string;
18778 return (char_u *)"";
18779 default:
18780 EMSG2(_(e_intern2), "get_tv_string_buf()");
18781 break;
18783 return NULL;
18787 * Find variable "name" in the list of variables.
18788 * Return a pointer to it if found, NULL if not found.
18789 * Careful: "a:0" variables don't have a name.
18790 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18791 * hashtab_T used.
18793 static dictitem_T *
18794 find_var(name, htp)
18795 char_u *name;
18796 hashtab_T **htp;
18798 char_u *varname;
18799 hashtab_T *ht;
18801 ht = find_var_ht(name, &varname);
18802 if (htp != NULL)
18803 *htp = ht;
18804 if (ht == NULL)
18805 return NULL;
18806 return find_var_in_ht(ht, varname, htp != NULL);
18810 * Find variable "varname" in hashtab "ht".
18811 * Returns NULL if not found.
18813 static dictitem_T *
18814 find_var_in_ht(ht, varname, writing)
18815 hashtab_T *ht;
18816 char_u *varname;
18817 int writing;
18819 hashitem_T *hi;
18821 if (*varname == NUL)
18823 /* Must be something like "s:", otherwise "ht" would be NULL. */
18824 switch (varname[-2])
18826 case 's': return &SCRIPT_SV(current_SID).sv_var;
18827 case 'g': return &globvars_var;
18828 case 'v': return &vimvars_var;
18829 case 'b': return &curbuf->b_bufvar;
18830 case 'w': return &curwin->w_winvar;
18831 #ifdef FEAT_WINDOWS
18832 case 't': return &curtab->tp_winvar;
18833 #endif
18834 case 'l': return current_funccal == NULL
18835 ? NULL : &current_funccal->l_vars_var;
18836 case 'a': return current_funccal == NULL
18837 ? NULL : &current_funccal->l_avars_var;
18839 return NULL;
18842 hi = hash_find(ht, varname);
18843 if (HASHITEM_EMPTY(hi))
18845 /* For global variables we may try auto-loading the script. If it
18846 * worked find the variable again. Don't auto-load a script if it was
18847 * loaded already, otherwise it would be loaded every time when
18848 * checking if a function name is a Funcref variable. */
18849 if (ht == &globvarht && !writing
18850 && script_autoload(varname, FALSE) && !aborting())
18851 hi = hash_find(ht, varname);
18852 if (HASHITEM_EMPTY(hi))
18853 return NULL;
18855 return HI2DI(hi);
18859 * Find the hashtab used for a variable name.
18860 * Set "varname" to the start of name without ':'.
18862 static hashtab_T *
18863 find_var_ht(name, varname)
18864 char_u *name;
18865 char_u **varname;
18867 hashitem_T *hi;
18869 if (name[1] != ':')
18871 /* The name must not start with a colon or #. */
18872 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18873 return NULL;
18874 *varname = name;
18876 /* "version" is "v:version" in all scopes */
18877 hi = hash_find(&compat_hashtab, name);
18878 if (!HASHITEM_EMPTY(hi))
18879 return &compat_hashtab;
18881 if (current_funccal == NULL)
18882 return &globvarht; /* global variable */
18883 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18885 *varname = name + 2;
18886 if (*name == 'g') /* global variable */
18887 return &globvarht;
18888 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18890 if (vim_strchr(name + 2, ':') != NULL
18891 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18892 return NULL;
18893 if (*name == 'b') /* buffer variable */
18894 return &curbuf->b_vars.dv_hashtab;
18895 if (*name == 'w') /* window variable */
18896 return &curwin->w_vars.dv_hashtab;
18897 #ifdef FEAT_WINDOWS
18898 if (*name == 't') /* tab page variable */
18899 return &curtab->tp_vars.dv_hashtab;
18900 #endif
18901 if (*name == 'v') /* v: variable */
18902 return &vimvarht;
18903 if (*name == 'a' && current_funccal != NULL) /* function argument */
18904 return &current_funccal->l_avars.dv_hashtab;
18905 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18906 return &current_funccal->l_vars.dv_hashtab;
18907 if (*name == 's' /* script variable */
18908 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18909 return &SCRIPT_VARS(current_SID);
18910 return NULL;
18914 * Get the string value of a (global/local) variable.
18915 * Returns NULL when it doesn't exist.
18917 char_u *
18918 get_var_value(name)
18919 char_u *name;
18921 dictitem_T *v;
18923 v = find_var(name, NULL);
18924 if (v == NULL)
18925 return NULL;
18926 return get_tv_string(&v->di_tv);
18930 * Allocate a new hashtab for a sourced script. It will be used while
18931 * sourcing this script and when executing functions defined in the script.
18933 void
18934 new_script_vars(id)
18935 scid_T id;
18937 int i;
18938 hashtab_T *ht;
18939 scriptvar_T *sv;
18941 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18943 /* Re-allocating ga_data means that an ht_array pointing to
18944 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18945 * at its init value. Also reset "v_dict", it's always the same. */
18946 for (i = 1; i <= ga_scripts.ga_len; ++i)
18948 ht = &SCRIPT_VARS(i);
18949 if (ht->ht_mask == HT_INIT_SIZE - 1)
18950 ht->ht_array = ht->ht_smallarray;
18951 sv = &SCRIPT_SV(i);
18952 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18955 while (ga_scripts.ga_len < id)
18957 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18958 init_var_dict(&sv->sv_dict, &sv->sv_var);
18959 ++ga_scripts.ga_len;
18965 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18966 * point to it.
18968 void
18969 init_var_dict(dict, dict_var)
18970 dict_T *dict;
18971 dictitem_T *dict_var;
18973 hash_init(&dict->dv_hashtab);
18974 dict->dv_refcount = DO_NOT_FREE_CNT;
18975 dict->dv_copyID = 0;
18976 dict_var->di_tv.vval.v_dict = dict;
18977 dict_var->di_tv.v_type = VAR_DICT;
18978 dict_var->di_tv.v_lock = VAR_FIXED;
18979 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18980 dict_var->di_key[0] = NUL;
18984 * Clean up a list of internal variables.
18985 * Frees all allocated variables and the value they contain.
18986 * Clears hashtab "ht", does not free it.
18988 void
18989 vars_clear(ht)
18990 hashtab_T *ht;
18992 vars_clear_ext(ht, TRUE);
18996 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18998 static void
18999 vars_clear_ext(ht, free_val)
19000 hashtab_T *ht;
19001 int free_val;
19003 int todo;
19004 hashitem_T *hi;
19005 dictitem_T *v;
19007 hash_lock(ht);
19008 todo = (int)ht->ht_used;
19009 for (hi = ht->ht_array; todo > 0; ++hi)
19011 if (!HASHITEM_EMPTY(hi))
19013 --todo;
19015 /* Free the variable. Don't remove it from the hashtab,
19016 * ht_array might change then. hash_clear() takes care of it
19017 * later. */
19018 v = HI2DI(hi);
19019 if (free_val)
19020 clear_tv(&v->di_tv);
19021 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19022 vim_free(v);
19025 hash_clear(ht);
19026 ht->ht_used = 0;
19030 * Delete a variable from hashtab "ht" at item "hi".
19031 * Clear the variable value and free the dictitem.
19033 static void
19034 delete_var(ht, hi)
19035 hashtab_T *ht;
19036 hashitem_T *hi;
19038 dictitem_T *di = HI2DI(hi);
19040 hash_remove(ht, hi);
19041 clear_tv(&di->di_tv);
19042 vim_free(di);
19046 * List the value of one internal variable.
19048 static void
19049 list_one_var(v, prefix, first)
19050 dictitem_T *v;
19051 char_u *prefix;
19052 int *first;
19054 char_u *tofree;
19055 char_u *s;
19056 char_u numbuf[NUMBUFLEN];
19058 current_copyID += COPYID_INC;
19059 s = echo_string(&v->di_tv, &tofree, numbuf, current_copyID);
19060 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19061 s == NULL ? (char_u *)"" : s, first);
19062 vim_free(tofree);
19065 static void
19066 list_one_var_a(prefix, name, type, string, first)
19067 char_u *prefix;
19068 char_u *name;
19069 int type;
19070 char_u *string;
19071 int *first; /* when TRUE clear rest of screen and set to FALSE */
19073 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19074 msg_start();
19075 msg_puts(prefix);
19076 if (name != NULL) /* "a:" vars don't have a name stored */
19077 msg_puts(name);
19078 msg_putchar(' ');
19079 msg_advance(22);
19080 if (type == VAR_NUMBER)
19081 msg_putchar('#');
19082 else if (type == VAR_FUNC)
19083 msg_putchar('*');
19084 else if (type == VAR_LIST)
19086 msg_putchar('[');
19087 if (*string == '[')
19088 ++string;
19090 else if (type == VAR_DICT)
19092 msg_putchar('{');
19093 if (*string == '{')
19094 ++string;
19096 else
19097 msg_putchar(' ');
19099 msg_outtrans(string);
19101 if (type == VAR_FUNC)
19102 msg_puts((char_u *)"()");
19103 if (*first)
19105 msg_clr_eos();
19106 *first = FALSE;
19111 * Set variable "name" to value in "tv".
19112 * If the variable already exists, the value is updated.
19113 * Otherwise the variable is created.
19115 static void
19116 set_var(name, tv, copy)
19117 char_u *name;
19118 typval_T *tv;
19119 int copy; /* make copy of value in "tv" */
19121 dictitem_T *v;
19122 char_u *varname;
19123 hashtab_T *ht;
19124 char_u *p;
19126 ht = find_var_ht(name, &varname);
19127 if (ht == NULL || *varname == NUL)
19129 EMSG2(_(e_illvar), name);
19130 return;
19132 v = find_var_in_ht(ht, varname, TRUE);
19134 if (tv->v_type == VAR_FUNC)
19136 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19137 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19138 ? name[2] : name[0]))
19140 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19141 return;
19143 /* Don't allow hiding a function. When "v" is not NULL we migth be
19144 * assigning another function to the same var, the type is checked
19145 * below. */
19146 if (v == NULL && function_exists(name))
19148 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19149 name);
19150 return;
19154 if (v != NULL)
19156 /* existing variable, need to clear the value */
19157 if (var_check_ro(v->di_flags, name)
19158 || tv_check_lock(v->di_tv.v_lock, name))
19159 return;
19160 if (v->di_tv.v_type != tv->v_type
19161 && !((v->di_tv.v_type == VAR_STRING
19162 || v->di_tv.v_type == VAR_NUMBER)
19163 && (tv->v_type == VAR_STRING
19164 || tv->v_type == VAR_NUMBER))
19165 #ifdef FEAT_FLOAT
19166 && !((v->di_tv.v_type == VAR_NUMBER
19167 || v->di_tv.v_type == VAR_FLOAT)
19168 && (tv->v_type == VAR_NUMBER
19169 || tv->v_type == VAR_FLOAT))
19170 #endif
19173 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19174 return;
19178 * Handle setting internal v: variables separately: we don't change
19179 * the type.
19181 if (ht == &vimvarht)
19183 if (v->di_tv.v_type == VAR_STRING)
19185 vim_free(v->di_tv.vval.v_string);
19186 if (copy || tv->v_type != VAR_STRING)
19187 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19188 else
19190 /* Take over the string to avoid an extra alloc/free. */
19191 v->di_tv.vval.v_string = tv->vval.v_string;
19192 tv->vval.v_string = NULL;
19195 else if (v->di_tv.v_type != VAR_NUMBER)
19196 EMSG2(_(e_intern2), "set_var()");
19197 else
19199 v->di_tv.vval.v_number = get_tv_number(tv);
19200 if (STRCMP(varname, "searchforward") == 0)
19201 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19203 return;
19206 clear_tv(&v->di_tv);
19208 else /* add a new variable */
19210 /* Can't add "v:" variable. */
19211 if (ht == &vimvarht)
19213 EMSG2(_(e_illvar), name);
19214 return;
19217 /* Make sure the variable name is valid. */
19218 for (p = varname; *p != NUL; ++p)
19219 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19220 && *p != AUTOLOAD_CHAR)
19222 EMSG2(_(e_illvar), varname);
19223 return;
19226 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19227 + STRLEN(varname)));
19228 if (v == NULL)
19229 return;
19230 STRCPY(v->di_key, varname);
19231 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19233 vim_free(v);
19234 return;
19236 v->di_flags = 0;
19239 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19240 copy_tv(tv, &v->di_tv);
19241 else
19243 v->di_tv = *tv;
19244 v->di_tv.v_lock = 0;
19245 init_tv(tv);
19250 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19251 * Also give an error message.
19253 static int
19254 var_check_ro(flags, name)
19255 int flags;
19256 char_u *name;
19258 if (flags & DI_FLAGS_RO)
19260 EMSG2(_(e_readonlyvar), name);
19261 return TRUE;
19263 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19265 EMSG2(_(e_readonlysbx), name);
19266 return TRUE;
19268 return FALSE;
19272 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19273 * Also give an error message.
19275 static int
19276 var_check_fixed(flags, name)
19277 int flags;
19278 char_u *name;
19280 if (flags & DI_FLAGS_FIX)
19282 EMSG2(_("E795: Cannot delete variable %s"), name);
19283 return TRUE;
19285 return FALSE;
19289 * Return TRUE if typeval "tv" is set to be locked (immutable).
19290 * Also give an error message, using "name".
19292 static int
19293 tv_check_lock(lock, name)
19294 int lock;
19295 char_u *name;
19297 if (lock & VAR_LOCKED)
19299 EMSG2(_("E741: Value is locked: %s"),
19300 name == NULL ? (char_u *)_("Unknown") : name);
19301 return TRUE;
19303 if (lock & VAR_FIXED)
19305 EMSG2(_("E742: Cannot change value of %s"),
19306 name == NULL ? (char_u *)_("Unknown") : name);
19307 return TRUE;
19309 return FALSE;
19313 * Copy the values from typval_T "from" to typval_T "to".
19314 * When needed allocates string or increases reference count.
19315 * Does not make a copy of a list or dict but copies the reference!
19316 * It is OK for "from" and "to" to point to the same item. This is used to
19317 * make a copy later.
19319 void
19320 copy_tv(from, to)
19321 typval_T *from;
19322 typval_T *to;
19324 to->v_type = from->v_type;
19325 to->v_lock = 0;
19326 switch (from->v_type)
19328 case VAR_NUMBER:
19329 to->vval.v_number = from->vval.v_number;
19330 break;
19331 #ifdef FEAT_FLOAT
19332 case VAR_FLOAT:
19333 to->vval.v_float = from->vval.v_float;
19334 break;
19335 #endif
19336 case VAR_STRING:
19337 case VAR_FUNC:
19338 if (from->vval.v_string == NULL)
19339 to->vval.v_string = NULL;
19340 else
19342 to->vval.v_string = vim_strsave(from->vval.v_string);
19343 if (from->v_type == VAR_FUNC)
19344 func_ref(to->vval.v_string);
19346 break;
19347 case VAR_LIST:
19348 if (from->vval.v_list == NULL)
19349 to->vval.v_list = NULL;
19350 else
19352 to->vval.v_list = from->vval.v_list;
19353 ++to->vval.v_list->lv_refcount;
19355 break;
19356 case VAR_DICT:
19357 if (from->vval.v_dict == NULL)
19358 to->vval.v_dict = NULL;
19359 else
19361 to->vval.v_dict = from->vval.v_dict;
19362 ++to->vval.v_dict->dv_refcount;
19364 break;
19365 default:
19366 EMSG2(_(e_intern2), "copy_tv()");
19367 break;
19372 * Make a copy of an item.
19373 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19374 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19375 * reference to an already copied list/dict can be used.
19376 * Returns FAIL or OK.
19378 static int
19379 item_copy(from, to, deep, copyID)
19380 typval_T *from;
19381 typval_T *to;
19382 int deep;
19383 int copyID;
19385 static int recurse = 0;
19386 int ret = OK;
19388 if (recurse >= DICT_MAXNEST)
19390 EMSG(_("E698: variable nested too deep for making a copy"));
19391 return FAIL;
19393 ++recurse;
19395 switch (from->v_type)
19397 case VAR_NUMBER:
19398 #ifdef FEAT_FLOAT
19399 case VAR_FLOAT:
19400 #endif
19401 case VAR_STRING:
19402 case VAR_FUNC:
19403 copy_tv(from, to);
19404 break;
19405 case VAR_LIST:
19406 to->v_type = VAR_LIST;
19407 to->v_lock = 0;
19408 if (from->vval.v_list == NULL)
19409 to->vval.v_list = NULL;
19410 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19412 /* use the copy made earlier */
19413 to->vval.v_list = from->vval.v_list->lv_copylist;
19414 ++to->vval.v_list->lv_refcount;
19416 else
19417 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19418 if (to->vval.v_list == NULL)
19419 ret = FAIL;
19420 break;
19421 case VAR_DICT:
19422 to->v_type = VAR_DICT;
19423 to->v_lock = 0;
19424 if (from->vval.v_dict == NULL)
19425 to->vval.v_dict = NULL;
19426 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19428 /* use the copy made earlier */
19429 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19430 ++to->vval.v_dict->dv_refcount;
19432 else
19433 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19434 if (to->vval.v_dict == NULL)
19435 ret = FAIL;
19436 break;
19437 default:
19438 EMSG2(_(e_intern2), "item_copy()");
19439 ret = FAIL;
19441 --recurse;
19442 return ret;
19446 * ":echo expr1 ..." print each argument separated with a space, add a
19447 * newline at the end.
19448 * ":echon expr1 ..." print each argument plain.
19450 void
19451 ex_echo(eap)
19452 exarg_T *eap;
19454 char_u *arg = eap->arg;
19455 typval_T rettv;
19456 char_u *tofree;
19457 char_u *p;
19458 int needclr = TRUE;
19459 int atstart = TRUE;
19460 char_u numbuf[NUMBUFLEN];
19462 if (eap->skip)
19463 ++emsg_skip;
19464 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19466 /* If eval1() causes an error message the text from the command may
19467 * still need to be cleared. E.g., "echo 22,44". */
19468 need_clr_eos = needclr;
19470 p = arg;
19471 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19474 * Report the invalid expression unless the expression evaluation
19475 * has been cancelled due to an aborting error, an interrupt, or an
19476 * exception.
19478 if (!aborting())
19479 EMSG2(_(e_invexpr2), p);
19480 need_clr_eos = FALSE;
19481 break;
19483 need_clr_eos = FALSE;
19485 if (!eap->skip)
19487 if (atstart)
19489 atstart = FALSE;
19490 /* Call msg_start() after eval1(), evaluating the expression
19491 * may cause a message to appear. */
19492 if (eap->cmdidx == CMD_echo)
19493 msg_start();
19495 else if (eap->cmdidx == CMD_echo)
19496 msg_puts_attr((char_u *)" ", echo_attr);
19497 current_copyID += COPYID_INC;
19498 p = echo_string(&rettv, &tofree, numbuf, current_copyID);
19499 if (p != NULL)
19500 for ( ; *p != NUL && !got_int; ++p)
19502 if (*p == '\n' || *p == '\r' || *p == TAB)
19504 if (*p != TAB && needclr)
19506 /* remove any text still there from the command */
19507 msg_clr_eos();
19508 needclr = FALSE;
19510 msg_putchar_attr(*p, echo_attr);
19512 else
19514 #ifdef FEAT_MBYTE
19515 if (has_mbyte)
19517 int i = (*mb_ptr2len)(p);
19519 (void)msg_outtrans_len_attr(p, i, echo_attr);
19520 p += i - 1;
19522 else
19523 #endif
19524 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19527 vim_free(tofree);
19529 clear_tv(&rettv);
19530 arg = skipwhite(arg);
19532 eap->nextcmd = check_nextcmd(arg);
19534 if (eap->skip)
19535 --emsg_skip;
19536 else
19538 /* remove text that may still be there from the command */
19539 if (needclr)
19540 msg_clr_eos();
19541 if (eap->cmdidx == CMD_echo)
19542 msg_end();
19547 * ":echohl {name}".
19549 void
19550 ex_echohl(eap)
19551 exarg_T *eap;
19553 int id;
19555 id = syn_name2id(eap->arg);
19556 if (id == 0)
19557 echo_attr = 0;
19558 else
19559 echo_attr = syn_id2attr(id);
19563 * ":execute expr1 ..." execute the result of an expression.
19564 * ":echomsg expr1 ..." Print a message
19565 * ":echoerr expr1 ..." Print an error
19566 * Each gets spaces around each argument and a newline at the end for
19567 * echo commands
19569 void
19570 ex_execute(eap)
19571 exarg_T *eap;
19573 char_u *arg = eap->arg;
19574 typval_T rettv;
19575 int ret = OK;
19576 char_u *p;
19577 garray_T ga;
19578 int len;
19579 int save_did_emsg;
19581 ga_init2(&ga, 1, 80);
19583 if (eap->skip)
19584 ++emsg_skip;
19585 while (*arg != NUL && *arg != '|' && *arg != '\n')
19587 p = arg;
19588 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19591 * Report the invalid expression unless the expression evaluation
19592 * has been cancelled due to an aborting error, an interrupt, or an
19593 * exception.
19595 if (!aborting())
19596 EMSG2(_(e_invexpr2), p);
19597 ret = FAIL;
19598 break;
19601 if (!eap->skip)
19603 p = get_tv_string(&rettv);
19604 len = (int)STRLEN(p);
19605 if (ga_grow(&ga, len + 2) == FAIL)
19607 clear_tv(&rettv);
19608 ret = FAIL;
19609 break;
19611 if (ga.ga_len)
19612 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19613 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19614 ga.ga_len += len;
19617 clear_tv(&rettv);
19618 arg = skipwhite(arg);
19621 if (ret != FAIL && ga.ga_data != NULL)
19623 if (eap->cmdidx == CMD_echomsg)
19625 MSG_ATTR(ga.ga_data, echo_attr);
19626 out_flush();
19628 else if (eap->cmdidx == CMD_echoerr)
19630 /* We don't want to abort following commands, restore did_emsg. */
19631 save_did_emsg = did_emsg;
19632 EMSG((char_u *)ga.ga_data);
19633 if (!force_abort)
19634 did_emsg = save_did_emsg;
19636 else if (eap->cmdidx == CMD_execute)
19637 do_cmdline((char_u *)ga.ga_data,
19638 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19641 ga_clear(&ga);
19643 if (eap->skip)
19644 --emsg_skip;
19646 eap->nextcmd = check_nextcmd(arg);
19650 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19651 * "arg" points to the "&" or '+' when called, to "option" when returning.
19652 * Returns NULL when no option name found. Otherwise pointer to the char
19653 * after the option name.
19655 static char_u *
19656 find_option_end(arg, opt_flags)
19657 char_u **arg;
19658 int *opt_flags;
19660 char_u *p = *arg;
19662 ++p;
19663 if (*p == 'g' && p[1] == ':')
19665 *opt_flags = OPT_GLOBAL;
19666 p += 2;
19668 else if (*p == 'l' && p[1] == ':')
19670 *opt_flags = OPT_LOCAL;
19671 p += 2;
19673 else
19674 *opt_flags = 0;
19676 if (!ASCII_ISALPHA(*p))
19677 return NULL;
19678 *arg = p;
19680 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19681 p += 4; /* termcap option */
19682 else
19683 while (ASCII_ISALPHA(*p))
19684 ++p;
19685 return p;
19689 * ":function"
19691 void
19692 ex_function(eap)
19693 exarg_T *eap;
19695 char_u *theline;
19696 int j;
19697 int c;
19698 int saved_did_emsg;
19699 char_u *name = NULL;
19700 char_u *p;
19701 char_u *arg;
19702 char_u *line_arg = NULL;
19703 garray_T newargs;
19704 garray_T newlines;
19705 int varargs = FALSE;
19706 int mustend = FALSE;
19707 int flags = 0;
19708 ufunc_T *fp;
19709 int indent;
19710 int nesting;
19711 char_u *skip_until = NULL;
19712 dictitem_T *v;
19713 funcdict_T fudi;
19714 static int func_nr = 0; /* number for nameless function */
19715 int paren;
19716 hashtab_T *ht;
19717 int todo;
19718 hashitem_T *hi;
19719 int sourcing_lnum_off;
19722 * ":function" without argument: list functions.
19724 if (ends_excmd(*eap->arg))
19726 if (!eap->skip)
19728 todo = (int)func_hashtab.ht_used;
19729 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19731 if (!HASHITEM_EMPTY(hi))
19733 --todo;
19734 fp = HI2UF(hi);
19735 if (!isdigit(*fp->uf_name))
19736 list_func_head(fp, FALSE);
19740 eap->nextcmd = check_nextcmd(eap->arg);
19741 return;
19745 * ":function /pat": list functions matching pattern.
19747 if (*eap->arg == '/')
19749 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19750 if (!eap->skip)
19752 regmatch_T regmatch;
19754 c = *p;
19755 *p = NUL;
19756 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19757 *p = c;
19758 if (regmatch.regprog != NULL)
19760 regmatch.rm_ic = p_ic;
19762 todo = (int)func_hashtab.ht_used;
19763 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19765 if (!HASHITEM_EMPTY(hi))
19767 --todo;
19768 fp = HI2UF(hi);
19769 if (!isdigit(*fp->uf_name)
19770 && vim_regexec(&regmatch, fp->uf_name, 0))
19771 list_func_head(fp, FALSE);
19774 vim_free(regmatch.regprog);
19777 if (*p == '/')
19778 ++p;
19779 eap->nextcmd = check_nextcmd(p);
19780 return;
19784 * Get the function name. There are these situations:
19785 * func normal function name
19786 * "name" == func, "fudi.fd_dict" == NULL
19787 * dict.func new dictionary entry
19788 * "name" == NULL, "fudi.fd_dict" set,
19789 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19790 * dict.func existing dict entry with a Funcref
19791 * "name" == func, "fudi.fd_dict" set,
19792 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19793 * dict.func existing dict entry that's not a Funcref
19794 * "name" == NULL, "fudi.fd_dict" set,
19795 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19797 p = eap->arg;
19798 name = trans_function_name(&p, eap->skip, 0, &fudi);
19799 paren = (vim_strchr(p, '(') != NULL);
19800 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19803 * Return on an invalid expression in braces, unless the expression
19804 * evaluation has been cancelled due to an aborting error, an
19805 * interrupt, or an exception.
19807 if (!aborting())
19809 if (!eap->skip && fudi.fd_newkey != NULL)
19810 EMSG2(_(e_dictkey), fudi.fd_newkey);
19811 vim_free(fudi.fd_newkey);
19812 return;
19814 else
19815 eap->skip = TRUE;
19818 /* An error in a function call during evaluation of an expression in magic
19819 * braces should not cause the function not to be defined. */
19820 saved_did_emsg = did_emsg;
19821 did_emsg = FALSE;
19824 * ":function func" with only function name: list function.
19826 if (!paren)
19828 if (!ends_excmd(*skipwhite(p)))
19830 EMSG(_(e_trailing));
19831 goto ret_free;
19833 eap->nextcmd = check_nextcmd(p);
19834 if (eap->nextcmd != NULL)
19835 *p = NUL;
19836 if (!eap->skip && !got_int)
19838 fp = find_func(name);
19839 if (fp != NULL)
19841 list_func_head(fp, TRUE);
19842 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19844 if (FUNCLINE(fp, j) == NULL)
19845 continue;
19846 msg_putchar('\n');
19847 msg_outnum((long)(j + 1));
19848 if (j < 9)
19849 msg_putchar(' ');
19850 if (j < 99)
19851 msg_putchar(' ');
19852 msg_prt_line(FUNCLINE(fp, j), FALSE);
19853 out_flush(); /* show a line at a time */
19854 ui_breakcheck();
19856 if (!got_int)
19858 msg_putchar('\n');
19859 msg_puts((char_u *)" endfunction");
19862 else
19863 emsg_funcname(N_("E123: Undefined function: %s"), name);
19865 goto ret_free;
19869 * ":function name(arg1, arg2)" Define function.
19871 p = skipwhite(p);
19872 if (*p != '(')
19874 if (!eap->skip)
19876 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19877 goto ret_free;
19879 /* attempt to continue by skipping some text */
19880 if (vim_strchr(p, '(') != NULL)
19881 p = vim_strchr(p, '(');
19883 p = skipwhite(p + 1);
19885 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19886 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19888 if (!eap->skip)
19890 /* Check the name of the function. Unless it's a dictionary function
19891 * (that we are overwriting). */
19892 if (name != NULL)
19893 arg = name;
19894 else
19895 arg = fudi.fd_newkey;
19896 if (arg != NULL && (fudi.fd_di == NULL
19897 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19899 if (*arg == K_SPECIAL)
19900 j = 3;
19901 else
19902 j = 0;
19903 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19904 : eval_isnamec(arg[j])))
19905 ++j;
19906 if (arg[j] != NUL)
19907 emsg_funcname((char *)e_invarg2, arg);
19912 * Isolate the arguments: "arg1, arg2, ...)"
19914 while (*p != ')')
19916 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19918 varargs = TRUE;
19919 p += 3;
19920 mustend = TRUE;
19922 else
19924 arg = p;
19925 while (ASCII_ISALNUM(*p) || *p == '_')
19926 ++p;
19927 if (arg == p || isdigit(*arg)
19928 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19929 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19931 if (!eap->skip)
19932 EMSG2(_("E125: Illegal argument: %s"), arg);
19933 break;
19935 if (ga_grow(&newargs, 1) == FAIL)
19936 goto erret;
19937 c = *p;
19938 *p = NUL;
19939 arg = vim_strsave(arg);
19940 if (arg == NULL)
19941 goto erret;
19942 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19943 *p = c;
19944 newargs.ga_len++;
19945 if (*p == ',')
19946 ++p;
19947 else
19948 mustend = TRUE;
19950 p = skipwhite(p);
19951 if (mustend && *p != ')')
19953 if (!eap->skip)
19954 EMSG2(_(e_invarg2), eap->arg);
19955 break;
19958 ++p; /* skip the ')' */
19960 /* find extra arguments "range", "dict" and "abort" */
19961 for (;;)
19963 p = skipwhite(p);
19964 if (STRNCMP(p, "range", 5) == 0)
19966 flags |= FC_RANGE;
19967 p += 5;
19969 else if (STRNCMP(p, "dict", 4) == 0)
19971 flags |= FC_DICT;
19972 p += 4;
19974 else if (STRNCMP(p, "abort", 5) == 0)
19976 flags |= FC_ABORT;
19977 p += 5;
19979 else
19980 break;
19983 /* When there is a line break use what follows for the function body.
19984 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19985 if (*p == '\n')
19986 line_arg = p + 1;
19987 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19988 EMSG(_(e_trailing));
19991 * Read the body of the function, until ":endfunction" is found.
19993 if (KeyTyped)
19995 /* Check if the function already exists, don't let the user type the
19996 * whole function before telling him it doesn't work! For a script we
19997 * need to skip the body to be able to find what follows. */
19998 if (!eap->skip && !eap->forceit)
20000 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
20001 EMSG(_(e_funcdict));
20002 else if (name != NULL && find_func(name) != NULL)
20003 emsg_funcname(e_funcexts, name);
20006 if (!eap->skip && did_emsg)
20007 goto erret;
20009 msg_putchar('\n'); /* don't overwrite the function name */
20010 cmdline_row = msg_row;
20013 indent = 2;
20014 nesting = 0;
20015 for (;;)
20017 msg_scroll = TRUE;
20018 need_wait_return = FALSE;
20019 sourcing_lnum_off = sourcing_lnum;
20021 if (line_arg != NULL)
20023 /* Use eap->arg, split up in parts by line breaks. */
20024 theline = line_arg;
20025 p = vim_strchr(theline, '\n');
20026 if (p == NULL)
20027 line_arg += STRLEN(line_arg);
20028 else
20030 *p = NUL;
20031 line_arg = p + 1;
20034 else if (eap->getline == NULL)
20035 theline = getcmdline(':', 0L, indent);
20036 else
20037 theline = eap->getline(':', eap->cookie, indent);
20038 if (KeyTyped)
20039 lines_left = Rows - 1;
20040 if (theline == NULL)
20042 EMSG(_("E126: Missing :endfunction"));
20043 goto erret;
20046 /* Detect line continuation: sourcing_lnum increased more than one. */
20047 if (sourcing_lnum > sourcing_lnum_off + 1)
20048 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20049 else
20050 sourcing_lnum_off = 0;
20052 if (skip_until != NULL)
20054 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20055 * don't check for ":endfunc". */
20056 if (STRCMP(theline, skip_until) == 0)
20058 vim_free(skip_until);
20059 skip_until = NULL;
20062 else
20064 /* skip ':' and blanks*/
20065 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20068 /* Check for "endfunction". */
20069 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20071 if (line_arg == NULL)
20072 vim_free(theline);
20073 break;
20076 /* Increase indent inside "if", "while", "for" and "try", decrease
20077 * at "end". */
20078 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20079 indent -= 2;
20080 else if (STRNCMP(p, "if", 2) == 0
20081 || STRNCMP(p, "wh", 2) == 0
20082 || STRNCMP(p, "for", 3) == 0
20083 || STRNCMP(p, "try", 3) == 0)
20084 indent += 2;
20086 /* Check for defining a function inside this function. */
20087 if (checkforcmd(&p, "function", 2))
20089 if (*p == '!')
20090 p = skipwhite(p + 1);
20091 p += eval_fname_script(p);
20092 if (ASCII_ISALPHA(*p))
20094 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20095 if (*skipwhite(p) == '(')
20097 ++nesting;
20098 indent += 2;
20103 /* Check for ":append" or ":insert". */
20104 p = skip_range(p, NULL);
20105 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20106 || (p[0] == 'i'
20107 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20108 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20109 skip_until = vim_strsave((char_u *)".");
20111 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20112 arg = skipwhite(skiptowhite(p));
20113 if (arg[0] == '<' && arg[1] =='<'
20114 && ((p[0] == 'p' && p[1] == 'y'
20115 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20116 || (p[0] == 'p' && p[1] == 'e'
20117 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20118 || (p[0] == 't' && p[1] == 'c'
20119 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20120 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20121 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20122 || (p[0] == 'm' && p[1] == 'z'
20123 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20126 /* ":python <<" continues until a dot, like ":append" */
20127 p = skipwhite(arg + 2);
20128 if (*p == NUL)
20129 skip_until = vim_strsave((char_u *)".");
20130 else
20131 skip_until = vim_strsave(p);
20135 /* Add the line to the function. */
20136 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20138 if (line_arg == NULL)
20139 vim_free(theline);
20140 goto erret;
20143 /* Copy the line to newly allocated memory. get_one_sourceline()
20144 * allocates 250 bytes per line, this saves 80% on average. The cost
20145 * is an extra alloc/free. */
20146 p = vim_strsave(theline);
20147 if (p != NULL)
20149 if (line_arg == NULL)
20150 vim_free(theline);
20151 theline = p;
20154 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20156 /* Add NULL lines for continuation lines, so that the line count is
20157 * equal to the index in the growarray. */
20158 while (sourcing_lnum_off-- > 0)
20159 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20161 /* Check for end of eap->arg. */
20162 if (line_arg != NULL && *line_arg == NUL)
20163 line_arg = NULL;
20166 /* Don't define the function when skipping commands or when an error was
20167 * detected. */
20168 if (eap->skip || did_emsg)
20169 goto erret;
20172 * If there are no errors, add the function
20174 if (fudi.fd_dict == NULL)
20176 v = find_var(name, &ht);
20177 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20179 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
20180 name);
20181 goto erret;
20184 fp = find_func(name);
20185 if (fp != NULL)
20187 if (!eap->forceit)
20189 emsg_funcname(e_funcexts, name);
20190 goto erret;
20192 if (fp->uf_calls > 0)
20194 emsg_funcname(N_("E127: Cannot redefine function %s: It is in use"),
20195 name);
20196 goto erret;
20198 /* redefine existing function */
20199 ga_clear_strings(&(fp->uf_args));
20200 ga_clear_strings(&(fp->uf_lines));
20201 vim_free(name);
20202 name = NULL;
20205 else
20207 char numbuf[20];
20209 fp = NULL;
20210 if (fudi.fd_newkey == NULL && !eap->forceit)
20212 EMSG(_(e_funcdict));
20213 goto erret;
20215 if (fudi.fd_di == NULL)
20217 /* Can't add a function to a locked dictionary */
20218 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20219 goto erret;
20221 /* Can't change an existing function if it is locked */
20222 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20223 goto erret;
20225 /* Give the function a sequential number. Can only be used with a
20226 * Funcref! */
20227 vim_free(name);
20228 sprintf(numbuf, "%d", ++func_nr);
20229 name = vim_strsave((char_u *)numbuf);
20230 if (name == NULL)
20231 goto erret;
20234 if (fp == NULL)
20236 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20238 int slen, plen;
20239 char_u *scriptname;
20241 /* Check that the autoload name matches the script name. */
20242 j = FAIL;
20243 if (sourcing_name != NULL)
20245 scriptname = autoload_name(name);
20246 if (scriptname != NULL)
20248 p = vim_strchr(scriptname, '/');
20249 plen = (int)STRLEN(p);
20250 slen = (int)STRLEN(sourcing_name);
20251 if (slen > plen && fnamecmp(p,
20252 sourcing_name + slen - plen) == 0)
20253 j = OK;
20254 vim_free(scriptname);
20257 if (j == FAIL)
20259 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20260 goto erret;
20264 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20265 if (fp == NULL)
20266 goto erret;
20268 if (fudi.fd_dict != NULL)
20270 if (fudi.fd_di == NULL)
20272 /* add new dict entry */
20273 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20274 if (fudi.fd_di == NULL)
20276 vim_free(fp);
20277 goto erret;
20279 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20281 vim_free(fudi.fd_di);
20282 vim_free(fp);
20283 goto erret;
20286 else
20287 /* overwrite existing dict entry */
20288 clear_tv(&fudi.fd_di->di_tv);
20289 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20290 fudi.fd_di->di_tv.v_lock = 0;
20291 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20292 fp->uf_refcount = 1;
20294 /* behave like "dict" was used */
20295 flags |= FC_DICT;
20298 /* insert the new function in the function list */
20299 STRCPY(fp->uf_name, name);
20300 hash_add(&func_hashtab, UF2HIKEY(fp));
20302 fp->uf_args = newargs;
20303 fp->uf_lines = newlines;
20304 #ifdef FEAT_PROFILE
20305 fp->uf_tml_count = NULL;
20306 fp->uf_tml_total = NULL;
20307 fp->uf_tml_self = NULL;
20308 fp->uf_profiling = FALSE;
20309 if (prof_def_func())
20310 func_do_profile(fp);
20311 #endif
20312 fp->uf_varargs = varargs;
20313 fp->uf_flags = flags;
20314 fp->uf_calls = 0;
20315 fp->uf_script_ID = current_SID;
20316 goto ret_free;
20318 erret:
20319 ga_clear_strings(&newargs);
20320 ga_clear_strings(&newlines);
20321 ret_free:
20322 vim_free(skip_until);
20323 vim_free(fudi.fd_newkey);
20324 vim_free(name);
20325 did_emsg |= saved_did_emsg;
20329 * Get a function name, translating "<SID>" and "<SNR>".
20330 * Also handles a Funcref in a List or Dictionary.
20331 * Returns the function name in allocated memory, or NULL for failure.
20332 * flags:
20333 * TFN_INT: internal function name OK
20334 * TFN_QUIET: be quiet
20335 * Advances "pp" to just after the function name (if no error).
20337 static char_u *
20338 trans_function_name(pp, skip, flags, fdp)
20339 char_u **pp;
20340 int skip; /* only find the end, don't evaluate */
20341 int flags;
20342 funcdict_T *fdp; /* return: info about dictionary used */
20344 char_u *name = NULL;
20345 char_u *start;
20346 char_u *end;
20347 int lead;
20348 char_u sid_buf[20];
20349 int len;
20350 lval_T lv;
20352 if (fdp != NULL)
20353 vim_memset(fdp, 0, sizeof(funcdict_T));
20354 start = *pp;
20356 /* Check for hard coded <SNR>: already translated function ID (from a user
20357 * command). */
20358 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20359 && (*pp)[2] == (int)KE_SNR)
20361 *pp += 3;
20362 len = get_id_len(pp) + 3;
20363 return vim_strnsave(start, len);
20366 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20367 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20368 lead = eval_fname_script(start);
20369 if (lead > 2)
20370 start += lead;
20372 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20373 lead > 2 ? 0 : FNE_CHECK_START);
20374 if (end == start)
20376 if (!skip)
20377 EMSG(_("E129: Function name required"));
20378 goto theend;
20380 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20383 * Report an invalid expression in braces, unless the expression
20384 * evaluation has been cancelled due to an aborting error, an
20385 * interrupt, or an exception.
20387 if (!aborting())
20389 if (end != NULL)
20390 EMSG2(_(e_invarg2), start);
20392 else
20393 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20394 goto theend;
20397 if (lv.ll_tv != NULL)
20399 if (fdp != NULL)
20401 fdp->fd_dict = lv.ll_dict;
20402 fdp->fd_newkey = lv.ll_newkey;
20403 lv.ll_newkey = NULL;
20404 fdp->fd_di = lv.ll_di;
20406 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20408 name = vim_strsave(lv.ll_tv->vval.v_string);
20409 *pp = end;
20411 else
20413 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20414 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20415 EMSG(_(e_funcref));
20416 else
20417 *pp = end;
20418 name = NULL;
20420 goto theend;
20423 if (lv.ll_name == NULL)
20425 /* Error found, but continue after the function name. */
20426 *pp = end;
20427 goto theend;
20430 /* Check if the name is a Funcref. If so, use the value. */
20431 if (lv.ll_exp_name != NULL)
20433 len = (int)STRLEN(lv.ll_exp_name);
20434 name = deref_func_name(lv.ll_exp_name, &len);
20435 if (name == lv.ll_exp_name)
20436 name = NULL;
20438 else
20440 len = (int)(end - *pp);
20441 name = deref_func_name(*pp, &len);
20442 if (name == *pp)
20443 name = NULL;
20445 if (name != NULL)
20447 name = vim_strsave(name);
20448 *pp = end;
20449 goto theend;
20452 if (lv.ll_exp_name != NULL)
20454 len = (int)STRLEN(lv.ll_exp_name);
20455 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20456 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20458 /* When there was "s:" already or the name expanded to get a
20459 * leading "s:" then remove it. */
20460 lv.ll_name += 2;
20461 len -= 2;
20462 lead = 2;
20465 else
20467 if (lead == 2) /* skip over "s:" */
20468 lv.ll_name += 2;
20469 len = (int)(end - lv.ll_name);
20473 * Copy the function name to allocated memory.
20474 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20475 * Accept <SNR>123_name() outside a script.
20477 if (skip)
20478 lead = 0; /* do nothing */
20479 else if (lead > 0)
20481 lead = 3;
20482 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20483 || eval_fname_sid(*pp))
20485 /* It's "s:" or "<SID>" */
20486 if (current_SID <= 0)
20488 EMSG(_(e_usingsid));
20489 goto theend;
20491 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20492 lead += (int)STRLEN(sid_buf);
20495 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20497 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20498 goto theend;
20500 name = alloc((unsigned)(len + lead + 1));
20501 if (name != NULL)
20503 if (lead > 0)
20505 name[0] = K_SPECIAL;
20506 name[1] = KS_EXTRA;
20507 name[2] = (int)KE_SNR;
20508 if (lead > 3) /* If it's "<SID>" */
20509 STRCPY(name + 3, sid_buf);
20511 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20512 name[len + lead] = NUL;
20514 *pp = end;
20516 theend:
20517 clear_lval(&lv);
20518 return name;
20522 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20523 * Return 2 if "p" starts with "s:".
20524 * Return 0 otherwise.
20526 static int
20527 eval_fname_script(p)
20528 char_u *p;
20530 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20531 || STRNICMP(p + 1, "SNR>", 4) == 0))
20532 return 5;
20533 if (p[0] == 's' && p[1] == ':')
20534 return 2;
20535 return 0;
20539 * Return TRUE if "p" starts with "<SID>" or "s:".
20540 * Only works if eval_fname_script() returned non-zero for "p"!
20542 static int
20543 eval_fname_sid(p)
20544 char_u *p;
20546 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20550 * List the head of the function: "name(arg1, arg2)".
20552 static void
20553 list_func_head(fp, indent)
20554 ufunc_T *fp;
20555 int indent;
20557 int j;
20559 msg_start();
20560 if (indent)
20561 MSG_PUTS(" ");
20562 MSG_PUTS("function ");
20563 if (fp->uf_name[0] == K_SPECIAL)
20565 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20566 msg_puts(fp->uf_name + 3);
20568 else
20569 msg_puts(fp->uf_name);
20570 msg_putchar('(');
20571 for (j = 0; j < fp->uf_args.ga_len; ++j)
20573 if (j)
20574 MSG_PUTS(", ");
20575 msg_puts(FUNCARG(fp, j));
20577 if (fp->uf_varargs)
20579 if (j)
20580 MSG_PUTS(", ");
20581 MSG_PUTS("...");
20583 msg_putchar(')');
20584 msg_clr_eos();
20585 if (p_verbose > 0)
20586 last_set_msg(fp->uf_script_ID);
20590 * Find a function by name, return pointer to it in ufuncs.
20591 * Return NULL for unknown function.
20593 static ufunc_T *
20594 find_func(name)
20595 char_u *name;
20597 hashitem_T *hi;
20599 hi = hash_find(&func_hashtab, name);
20600 if (!HASHITEM_EMPTY(hi))
20601 return HI2UF(hi);
20602 return NULL;
20605 #if defined(EXITFREE) || defined(PROTO)
20606 void
20607 free_all_functions()
20609 hashitem_T *hi;
20611 /* Need to start all over every time, because func_free() may change the
20612 * hash table. */
20613 while (func_hashtab.ht_used > 0)
20614 for (hi = func_hashtab.ht_array; ; ++hi)
20615 if (!HASHITEM_EMPTY(hi))
20617 func_free(HI2UF(hi));
20618 break;
20621 #endif
20624 * Return TRUE if a function "name" exists.
20626 static int
20627 function_exists(name)
20628 char_u *name;
20630 char_u *nm = name;
20631 char_u *p;
20632 int n = FALSE;
20634 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20635 nm = skipwhite(nm);
20637 /* Only accept "funcname", "funcname ", "funcname (..." and
20638 * "funcname(...", not "funcname!...". */
20639 if (p != NULL && (*nm == NUL || *nm == '('))
20641 if (builtin_function(p))
20642 n = (find_internal_func(p) >= 0);
20643 else
20644 n = (find_func(p) != NULL);
20646 vim_free(p);
20647 return n;
20651 * Return TRUE if "name" looks like a builtin function name: starts with a
20652 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20654 static int
20655 builtin_function(name)
20656 char_u *name;
20658 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20659 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20662 #if defined(FEAT_PROFILE) || defined(PROTO)
20664 * Start profiling function "fp".
20666 static void
20667 func_do_profile(fp)
20668 ufunc_T *fp;
20670 fp->uf_tm_count = 0;
20671 profile_zero(&fp->uf_tm_self);
20672 profile_zero(&fp->uf_tm_total);
20673 if (fp->uf_tml_count == NULL)
20674 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20675 (sizeof(int) * fp->uf_lines.ga_len));
20676 if (fp->uf_tml_total == NULL)
20677 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20678 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20679 if (fp->uf_tml_self == NULL)
20680 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20681 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20682 fp->uf_tml_idx = -1;
20683 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20684 || fp->uf_tml_self == NULL)
20685 return; /* out of memory */
20687 fp->uf_profiling = TRUE;
20691 * Dump the profiling results for all functions in file "fd".
20693 void
20694 func_dump_profile(fd)
20695 FILE *fd;
20697 hashitem_T *hi;
20698 int todo;
20699 ufunc_T *fp;
20700 int i;
20701 ufunc_T **sorttab;
20702 int st_len = 0;
20704 todo = (int)func_hashtab.ht_used;
20705 if (todo == 0)
20706 return; /* nothing to dump */
20708 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20710 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20712 if (!HASHITEM_EMPTY(hi))
20714 --todo;
20715 fp = HI2UF(hi);
20716 if (fp->uf_profiling)
20718 if (sorttab != NULL)
20719 sorttab[st_len++] = fp;
20721 if (fp->uf_name[0] == K_SPECIAL)
20722 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20723 else
20724 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20725 if (fp->uf_tm_count == 1)
20726 fprintf(fd, "Called 1 time\n");
20727 else
20728 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20729 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20730 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20731 fprintf(fd, "\n");
20732 fprintf(fd, "count total (s) self (s)\n");
20734 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20736 if (FUNCLINE(fp, i) == NULL)
20737 continue;
20738 prof_func_line(fd, fp->uf_tml_count[i],
20739 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20740 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20742 fprintf(fd, "\n");
20747 if (sorttab != NULL && st_len > 0)
20749 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20750 prof_total_cmp);
20751 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20752 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20753 prof_self_cmp);
20754 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20757 vim_free(sorttab);
20760 static void
20761 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20762 FILE *fd;
20763 ufunc_T **sorttab;
20764 int st_len;
20765 char *title;
20766 int prefer_self; /* when equal print only self time */
20768 int i;
20769 ufunc_T *fp;
20771 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20772 fprintf(fd, "count total (s) self (s) function\n");
20773 for (i = 0; i < 20 && i < st_len; ++i)
20775 fp = sorttab[i];
20776 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20777 prefer_self);
20778 if (fp->uf_name[0] == K_SPECIAL)
20779 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20780 else
20781 fprintf(fd, " %s()\n", fp->uf_name);
20783 fprintf(fd, "\n");
20787 * Print the count and times for one function or function line.
20789 static void
20790 prof_func_line(fd, count, total, self, prefer_self)
20791 FILE *fd;
20792 int count;
20793 proftime_T *total;
20794 proftime_T *self;
20795 int prefer_self; /* when equal print only self time */
20797 if (count > 0)
20799 fprintf(fd, "%5d ", count);
20800 if (prefer_self && profile_equal(total, self))
20801 fprintf(fd, " ");
20802 else
20803 fprintf(fd, "%s ", profile_msg(total));
20804 if (!prefer_self && profile_equal(total, self))
20805 fprintf(fd, " ");
20806 else
20807 fprintf(fd, "%s ", profile_msg(self));
20809 else
20810 fprintf(fd, " ");
20814 * Compare function for total time sorting.
20816 static int
20817 #ifdef __BORLANDC__
20818 _RTLENTRYF
20819 #endif
20820 prof_total_cmp(s1, s2)
20821 const void *s1;
20822 const void *s2;
20824 ufunc_T *p1, *p2;
20826 p1 = *(ufunc_T **)s1;
20827 p2 = *(ufunc_T **)s2;
20828 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20832 * Compare function for self time sorting.
20834 static int
20835 #ifdef __BORLANDC__
20836 _RTLENTRYF
20837 #endif
20838 prof_self_cmp(s1, s2)
20839 const void *s1;
20840 const void *s2;
20842 ufunc_T *p1, *p2;
20844 p1 = *(ufunc_T **)s1;
20845 p2 = *(ufunc_T **)s2;
20846 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20849 #endif
20852 * If "name" has a package name try autoloading the script for it.
20853 * Return TRUE if a package was loaded.
20855 static int
20856 script_autoload(name, reload)
20857 char_u *name;
20858 int reload; /* load script again when already loaded */
20860 char_u *p;
20861 char_u *scriptname, *tofree;
20862 int ret = FALSE;
20863 int i;
20865 /* If there is no '#' after name[0] there is no package name. */
20866 p = vim_strchr(name, AUTOLOAD_CHAR);
20867 if (p == NULL || p == name)
20868 return FALSE;
20870 tofree = scriptname = autoload_name(name);
20872 /* Find the name in the list of previously loaded package names. Skip
20873 * "autoload/", it's always the same. */
20874 for (i = 0; i < ga_loaded.ga_len; ++i)
20875 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20876 break;
20877 if (!reload && i < ga_loaded.ga_len)
20878 ret = FALSE; /* was loaded already */
20879 else
20881 /* Remember the name if it wasn't loaded already. */
20882 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20884 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20885 tofree = NULL;
20888 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20889 if (source_runtime(scriptname, FALSE) == OK)
20890 ret = TRUE;
20893 vim_free(tofree);
20894 return ret;
20898 * Return the autoload script name for a function or variable name.
20899 * Returns NULL when out of memory.
20901 static char_u *
20902 autoload_name(name)
20903 char_u *name;
20905 char_u *p;
20906 char_u *scriptname;
20908 /* Get the script file name: replace '#' with '/', append ".vim". */
20909 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20910 if (scriptname == NULL)
20911 return FALSE;
20912 STRCPY(scriptname, "autoload/");
20913 STRCAT(scriptname, name);
20914 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20915 STRCAT(scriptname, ".vim");
20916 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20917 *p = '/';
20918 return scriptname;
20921 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20924 * Function given to ExpandGeneric() to obtain the list of user defined
20925 * function names.
20927 char_u *
20928 get_user_func_name(xp, idx)
20929 expand_T *xp;
20930 int idx;
20932 static long_u done;
20933 static hashitem_T *hi;
20934 ufunc_T *fp;
20936 if (idx == 0)
20938 done = 0;
20939 hi = func_hashtab.ht_array;
20941 if (done < func_hashtab.ht_used)
20943 if (done++ > 0)
20944 ++hi;
20945 while (HASHITEM_EMPTY(hi))
20946 ++hi;
20947 fp = HI2UF(hi);
20949 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20950 return fp->uf_name; /* prevents overflow */
20952 cat_func_name(IObuff, fp);
20953 if (xp->xp_context != EXPAND_USER_FUNC)
20955 STRCAT(IObuff, "(");
20956 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20957 STRCAT(IObuff, ")");
20959 return IObuff;
20961 return NULL;
20964 #endif /* FEAT_CMDL_COMPL */
20967 * Copy the function name of "fp" to buffer "buf".
20968 * "buf" must be able to hold the function name plus three bytes.
20969 * Takes care of script-local function names.
20971 static void
20972 cat_func_name(buf, fp)
20973 char_u *buf;
20974 ufunc_T *fp;
20976 if (fp->uf_name[0] == K_SPECIAL)
20978 STRCPY(buf, "<SNR>");
20979 STRCAT(buf, fp->uf_name + 3);
20981 else
20982 STRCPY(buf, fp->uf_name);
20986 * ":delfunction {name}"
20988 void
20989 ex_delfunction(eap)
20990 exarg_T *eap;
20992 ufunc_T *fp = NULL;
20993 char_u *p;
20994 char_u *name;
20995 funcdict_T fudi;
20997 p = eap->arg;
20998 name = trans_function_name(&p, eap->skip, 0, &fudi);
20999 vim_free(fudi.fd_newkey);
21000 if (name == NULL)
21002 if (fudi.fd_dict != NULL && !eap->skip)
21003 EMSG(_(e_funcref));
21004 return;
21006 if (!ends_excmd(*skipwhite(p)))
21008 vim_free(name);
21009 EMSG(_(e_trailing));
21010 return;
21012 eap->nextcmd = check_nextcmd(p);
21013 if (eap->nextcmd != NULL)
21014 *p = NUL;
21016 if (!eap->skip)
21017 fp = find_func(name);
21018 vim_free(name);
21020 if (!eap->skip)
21022 if (fp == NULL)
21024 EMSG2(_(e_nofunc), eap->arg);
21025 return;
21027 if (fp->uf_calls > 0)
21029 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21030 return;
21033 if (fudi.fd_dict != NULL)
21035 /* Delete the dict item that refers to the function, it will
21036 * invoke func_unref() and possibly delete the function. */
21037 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21039 else
21040 func_free(fp);
21045 * Free a function and remove it from the list of functions.
21047 static void
21048 func_free(fp)
21049 ufunc_T *fp;
21051 hashitem_T *hi;
21053 /* clear this function */
21054 ga_clear_strings(&(fp->uf_args));
21055 ga_clear_strings(&(fp->uf_lines));
21056 #ifdef FEAT_PROFILE
21057 vim_free(fp->uf_tml_count);
21058 vim_free(fp->uf_tml_total);
21059 vim_free(fp->uf_tml_self);
21060 #endif
21062 /* remove the function from the function hashtable */
21063 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21064 if (HASHITEM_EMPTY(hi))
21065 EMSG2(_(e_intern2), "func_free()");
21066 else
21067 hash_remove(&func_hashtab, hi);
21069 vim_free(fp);
21073 * Unreference a Function: decrement the reference count and free it when it
21074 * becomes zero. Only for numbered functions.
21076 static void
21077 func_unref(name)
21078 char_u *name;
21080 ufunc_T *fp;
21082 if (name != NULL && isdigit(*name))
21084 fp = find_func(name);
21085 if (fp == NULL)
21086 EMSG2(_(e_intern2), "func_unref()");
21087 else if (--fp->uf_refcount <= 0)
21089 /* Only delete it when it's not being used. Otherwise it's done
21090 * when "uf_calls" becomes zero. */
21091 if (fp->uf_calls == 0)
21092 func_free(fp);
21098 * Count a reference to a Function.
21100 static void
21101 func_ref(name)
21102 char_u *name;
21104 ufunc_T *fp;
21106 if (name != NULL && isdigit(*name))
21108 fp = find_func(name);
21109 if (fp == NULL)
21110 EMSG2(_(e_intern2), "func_ref()");
21111 else
21112 ++fp->uf_refcount;
21117 * Call a user function.
21119 static void
21120 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21121 ufunc_T *fp; /* pointer to function */
21122 int argcount; /* nr of args */
21123 typval_T *argvars; /* arguments */
21124 typval_T *rettv; /* return value */
21125 linenr_T firstline; /* first line of range */
21126 linenr_T lastline; /* last line of range */
21127 dict_T *selfdict; /* Dictionary for "self" */
21129 char_u *save_sourcing_name;
21130 linenr_T save_sourcing_lnum;
21131 scid_T save_current_SID;
21132 funccall_T *fc;
21133 int save_did_emsg;
21134 static int depth = 0;
21135 dictitem_T *v;
21136 int fixvar_idx = 0; /* index in fixvar[] */
21137 int i;
21138 int ai;
21139 char_u numbuf[NUMBUFLEN];
21140 char_u *name;
21141 #ifdef FEAT_PROFILE
21142 proftime_T wait_start;
21143 proftime_T call_start;
21144 #endif
21146 /* If depth of calling is getting too high, don't execute the function */
21147 if (depth >= p_mfd)
21149 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21150 rettv->v_type = VAR_NUMBER;
21151 rettv->vval.v_number = -1;
21152 return;
21154 ++depth;
21156 line_breakcheck(); /* check for CTRL-C hit */
21158 fc = (funccall_T *)alloc(sizeof(funccall_T));
21159 fc->caller = current_funccal;
21160 current_funccal = fc;
21161 fc->func = fp;
21162 fc->rettv = rettv;
21163 rettv->vval.v_number = 0;
21164 fc->linenr = 0;
21165 fc->returned = FALSE;
21166 fc->level = ex_nesting_level;
21167 /* Check if this function has a breakpoint. */
21168 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21169 fc->dbg_tick = debug_tick;
21172 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21173 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21174 * each argument variable and saves a lot of time.
21177 * Init l: variables.
21179 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21180 if (selfdict != NULL)
21182 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21183 * some compiler that checks the destination size. */
21184 v = &fc->fixvar[fixvar_idx++].var;
21185 name = v->di_key;
21186 STRCPY(name, "self");
21187 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21188 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21189 v->di_tv.v_type = VAR_DICT;
21190 v->di_tv.v_lock = 0;
21191 v->di_tv.vval.v_dict = selfdict;
21192 ++selfdict->dv_refcount;
21196 * Init a: variables.
21197 * Set a:0 to "argcount".
21198 * Set a:000 to a list with room for the "..." arguments.
21200 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21201 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21202 (varnumber_T)(argcount - fp->uf_args.ga_len));
21203 /* Use "name" to avoid a warning from some compiler that checks the
21204 * destination size. */
21205 v = &fc->fixvar[fixvar_idx++].var;
21206 name = v->di_key;
21207 STRCPY(name, "000");
21208 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21209 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21210 v->di_tv.v_type = VAR_LIST;
21211 v->di_tv.v_lock = VAR_FIXED;
21212 v->di_tv.vval.v_list = &fc->l_varlist;
21213 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21214 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21215 fc->l_varlist.lv_lock = VAR_FIXED;
21218 * Set a:firstline to "firstline" and a:lastline to "lastline".
21219 * Set a:name to named arguments.
21220 * Set a:N to the "..." arguments.
21222 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21223 (varnumber_T)firstline);
21224 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21225 (varnumber_T)lastline);
21226 for (i = 0; i < argcount; ++i)
21228 ai = i - fp->uf_args.ga_len;
21229 if (ai < 0)
21230 /* named argument a:name */
21231 name = FUNCARG(fp, i);
21232 else
21234 /* "..." argument a:1, a:2, etc. */
21235 sprintf((char *)numbuf, "%d", ai + 1);
21236 name = numbuf;
21238 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21240 v = &fc->fixvar[fixvar_idx++].var;
21241 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21243 else
21245 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21246 + STRLEN(name)));
21247 if (v == NULL)
21248 break;
21249 v->di_flags = DI_FLAGS_RO;
21251 STRCPY(v->di_key, name);
21252 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21254 /* Note: the values are copied directly to avoid alloc/free.
21255 * "argvars" must have VAR_FIXED for v_lock. */
21256 v->di_tv = argvars[i];
21257 v->di_tv.v_lock = VAR_FIXED;
21259 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21261 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21262 fc->l_listitems[ai].li_tv = argvars[i];
21263 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21267 /* Don't redraw while executing the function. */
21268 ++RedrawingDisabled;
21269 save_sourcing_name = sourcing_name;
21270 save_sourcing_lnum = sourcing_lnum;
21271 sourcing_lnum = 1;
21272 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21273 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21274 if (sourcing_name != NULL)
21276 if (save_sourcing_name != NULL
21277 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21278 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21279 else
21280 STRCPY(sourcing_name, "function ");
21281 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21283 if (p_verbose >= 12)
21285 ++no_wait_return;
21286 verbose_enter_scroll();
21288 smsg((char_u *)_("calling %s"), sourcing_name);
21289 if (p_verbose >= 14)
21291 char_u buf[MSG_BUF_LEN];
21292 char_u numbuf2[NUMBUFLEN];
21293 char_u *tofree;
21294 char_u *s;
21296 msg_puts((char_u *)"(");
21297 for (i = 0; i < argcount; ++i)
21299 if (i > 0)
21300 msg_puts((char_u *)", ");
21301 if (argvars[i].v_type == VAR_NUMBER)
21302 msg_outnum((long)argvars[i].vval.v_number);
21303 else
21305 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21306 if (s != NULL)
21308 trunc_string(s, buf, MSG_BUF_CLEN);
21309 msg_puts(buf);
21310 vim_free(tofree);
21314 msg_puts((char_u *)")");
21316 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21318 verbose_leave_scroll();
21319 --no_wait_return;
21322 #ifdef FEAT_PROFILE
21323 if (do_profiling == PROF_YES)
21325 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21326 func_do_profile(fp);
21327 if (fp->uf_profiling
21328 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21330 ++fp->uf_tm_count;
21331 profile_start(&call_start);
21332 profile_zero(&fp->uf_tm_children);
21334 script_prof_save(&wait_start);
21336 #endif
21338 save_current_SID = current_SID;
21339 current_SID = fp->uf_script_ID;
21340 save_did_emsg = did_emsg;
21341 did_emsg = FALSE;
21343 /* call do_cmdline() to execute the lines */
21344 do_cmdline(NULL, get_func_line, (void *)fc,
21345 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21347 --RedrawingDisabled;
21349 /* when the function was aborted because of an error, return -1 */
21350 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21352 clear_tv(rettv);
21353 rettv->v_type = VAR_NUMBER;
21354 rettv->vval.v_number = -1;
21357 #ifdef FEAT_PROFILE
21358 if (do_profiling == PROF_YES && (fp->uf_profiling
21359 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21361 profile_end(&call_start);
21362 profile_sub_wait(&wait_start, &call_start);
21363 profile_add(&fp->uf_tm_total, &call_start);
21364 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21365 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21367 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21368 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21371 #endif
21373 /* when being verbose, mention the return value */
21374 if (p_verbose >= 12)
21376 ++no_wait_return;
21377 verbose_enter_scroll();
21379 if (aborting())
21380 smsg((char_u *)_("%s aborted"), sourcing_name);
21381 else if (fc->rettv->v_type == VAR_NUMBER)
21382 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21383 (long)fc->rettv->vval.v_number);
21384 else
21386 char_u buf[MSG_BUF_LEN];
21387 char_u numbuf2[NUMBUFLEN];
21388 char_u *tofree;
21389 char_u *s;
21391 /* The value may be very long. Skip the middle part, so that we
21392 * have some idea how it starts and ends. smsg() would always
21393 * truncate it at the end. */
21394 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21395 if (s != NULL)
21397 trunc_string(s, buf, MSG_BUF_CLEN);
21398 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21399 vim_free(tofree);
21402 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21404 verbose_leave_scroll();
21405 --no_wait_return;
21408 vim_free(sourcing_name);
21409 sourcing_name = save_sourcing_name;
21410 sourcing_lnum = save_sourcing_lnum;
21411 current_SID = save_current_SID;
21412 #ifdef FEAT_PROFILE
21413 if (do_profiling == PROF_YES)
21414 script_prof_restore(&wait_start);
21415 #endif
21417 if (p_verbose >= 12 && sourcing_name != NULL)
21419 ++no_wait_return;
21420 verbose_enter_scroll();
21422 smsg((char_u *)_("continuing in %s"), sourcing_name);
21423 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21425 verbose_leave_scroll();
21426 --no_wait_return;
21429 did_emsg |= save_did_emsg;
21430 current_funccal = fc->caller;
21431 --depth;
21433 /* If the a:000 list and the l: and a: dicts are not referenced we can
21434 * free the funccall_T and what's in it. */
21435 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21436 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21437 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21439 free_funccal(fc, FALSE);
21441 else
21443 hashitem_T *hi;
21444 listitem_T *li;
21445 int todo;
21447 /* "fc" is still in use. This can happen when returning "a:000" or
21448 * assigning "l:" to a global variable.
21449 * Link "fc" in the list for garbage collection later. */
21450 fc->caller = previous_funccal;
21451 previous_funccal = fc;
21453 /* Make a copy of the a: variables, since we didn't do that above. */
21454 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21455 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21457 if (!HASHITEM_EMPTY(hi))
21459 --todo;
21460 v = HI2DI(hi);
21461 copy_tv(&v->di_tv, &v->di_tv);
21465 /* Make a copy of the a:000 items, since we didn't do that above. */
21466 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21467 copy_tv(&li->li_tv, &li->li_tv);
21472 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21473 * referenced from anywhere that is in use.
21475 static int
21476 can_free_funccal(fc, copyID)
21477 funccall_T *fc;
21478 int copyID;
21480 return (fc->l_varlist.lv_copyID != copyID
21481 && fc->l_vars.dv_copyID != copyID
21482 && fc->l_avars.dv_copyID != copyID);
21486 * Free "fc" and what it contains.
21488 static void
21489 free_funccal(fc, free_val)
21490 funccall_T *fc;
21491 int free_val; /* a: vars were allocated */
21493 listitem_T *li;
21495 /* The a: variables typevals may not have been allocated, only free the
21496 * allocated variables. */
21497 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21499 /* free all l: variables */
21500 vars_clear(&fc->l_vars.dv_hashtab);
21502 /* Free the a:000 variables if they were allocated. */
21503 if (free_val)
21504 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21505 clear_tv(&li->li_tv);
21507 vim_free(fc);
21511 * Add a number variable "name" to dict "dp" with value "nr".
21513 static void
21514 add_nr_var(dp, v, name, nr)
21515 dict_T *dp;
21516 dictitem_T *v;
21517 char *name;
21518 varnumber_T nr;
21520 STRCPY(v->di_key, name);
21521 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21522 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21523 v->di_tv.v_type = VAR_NUMBER;
21524 v->di_tv.v_lock = VAR_FIXED;
21525 v->di_tv.vval.v_number = nr;
21529 * ":return [expr]"
21531 void
21532 ex_return(eap)
21533 exarg_T *eap;
21535 char_u *arg = eap->arg;
21536 typval_T rettv;
21537 int returning = FALSE;
21539 if (current_funccal == NULL)
21541 EMSG(_("E133: :return not inside a function"));
21542 return;
21545 if (eap->skip)
21546 ++emsg_skip;
21548 eap->nextcmd = NULL;
21549 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21550 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21552 if (!eap->skip)
21553 returning = do_return(eap, FALSE, TRUE, &rettv);
21554 else
21555 clear_tv(&rettv);
21557 /* It's safer to return also on error. */
21558 else if (!eap->skip)
21561 * Return unless the expression evaluation has been cancelled due to an
21562 * aborting error, an interrupt, or an exception.
21564 if (!aborting())
21565 returning = do_return(eap, FALSE, TRUE, NULL);
21568 /* When skipping or the return gets pending, advance to the next command
21569 * in this line (!returning). Otherwise, ignore the rest of the line.
21570 * Following lines will be ignored by get_func_line(). */
21571 if (returning)
21572 eap->nextcmd = NULL;
21573 else if (eap->nextcmd == NULL) /* no argument */
21574 eap->nextcmd = check_nextcmd(arg);
21576 if (eap->skip)
21577 --emsg_skip;
21581 * Return from a function. Possibly makes the return pending. Also called
21582 * for a pending return at the ":endtry" or after returning from an extra
21583 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21584 * when called due to a ":return" command. "rettv" may point to a typval_T
21585 * with the return rettv. Returns TRUE when the return can be carried out,
21586 * FALSE when the return gets pending.
21589 do_return(eap, reanimate, is_cmd, rettv)
21590 exarg_T *eap;
21591 int reanimate;
21592 int is_cmd;
21593 void *rettv;
21595 int idx;
21596 struct condstack *cstack = eap->cstack;
21598 if (reanimate)
21599 /* Undo the return. */
21600 current_funccal->returned = FALSE;
21603 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21604 * not in its finally clause (which then is to be executed next) is found.
21605 * In this case, make the ":return" pending for execution at the ":endtry".
21606 * Otherwise, return normally.
21608 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21609 if (idx >= 0)
21611 cstack->cs_pending[idx] = CSTP_RETURN;
21613 if (!is_cmd && !reanimate)
21614 /* A pending return again gets pending. "rettv" points to an
21615 * allocated variable with the rettv of the original ":return"'s
21616 * argument if present or is NULL else. */
21617 cstack->cs_rettv[idx] = rettv;
21618 else
21620 /* When undoing a return in order to make it pending, get the stored
21621 * return rettv. */
21622 if (reanimate)
21623 rettv = current_funccal->rettv;
21625 if (rettv != NULL)
21627 /* Store the value of the pending return. */
21628 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21629 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21630 else
21631 EMSG(_(e_outofmem));
21633 else
21634 cstack->cs_rettv[idx] = NULL;
21636 if (reanimate)
21638 /* The pending return value could be overwritten by a ":return"
21639 * without argument in a finally clause; reset the default
21640 * return value. */
21641 current_funccal->rettv->v_type = VAR_NUMBER;
21642 current_funccal->rettv->vval.v_number = 0;
21645 report_make_pending(CSTP_RETURN, rettv);
21647 else
21649 current_funccal->returned = TRUE;
21651 /* If the return is carried out now, store the return value. For
21652 * a return immediately after reanimation, the value is already
21653 * there. */
21654 if (!reanimate && rettv != NULL)
21656 clear_tv(current_funccal->rettv);
21657 *current_funccal->rettv = *(typval_T *)rettv;
21658 if (!is_cmd)
21659 vim_free(rettv);
21663 return idx < 0;
21667 * Free the variable with a pending return value.
21669 void
21670 discard_pending_return(rettv)
21671 void *rettv;
21673 free_tv((typval_T *)rettv);
21677 * Generate a return command for producing the value of "rettv". The result
21678 * is an allocated string. Used by report_pending() for verbose messages.
21680 char_u *
21681 get_return_cmd(rettv)
21682 void *rettv;
21684 char_u *s = NULL;
21685 char_u *tofree = NULL;
21686 char_u numbuf[NUMBUFLEN];
21688 if (rettv != NULL)
21689 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21690 if (s == NULL)
21691 s = (char_u *)"";
21693 STRCPY(IObuff, ":return ");
21694 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21695 if (STRLEN(s) + 8 >= IOSIZE)
21696 STRCPY(IObuff + IOSIZE - 4, "...");
21697 vim_free(tofree);
21698 return vim_strsave(IObuff);
21702 * Get next function line.
21703 * Called by do_cmdline() to get the next line.
21704 * Returns allocated string, or NULL for end of function.
21706 char_u *
21707 get_func_line(c, cookie, indent)
21708 int c UNUSED;
21709 void *cookie;
21710 int indent UNUSED;
21712 funccall_T *fcp = (funccall_T *)cookie;
21713 ufunc_T *fp = fcp->func;
21714 char_u *retval;
21715 garray_T *gap; /* growarray with function lines */
21717 /* If breakpoints have been added/deleted need to check for it. */
21718 if (fcp->dbg_tick != debug_tick)
21720 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21721 sourcing_lnum);
21722 fcp->dbg_tick = debug_tick;
21724 #ifdef FEAT_PROFILE
21725 if (do_profiling == PROF_YES)
21726 func_line_end(cookie);
21727 #endif
21729 gap = &fp->uf_lines;
21730 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21731 || fcp->returned)
21732 retval = NULL;
21733 else
21735 /* Skip NULL lines (continuation lines). */
21736 while (fcp->linenr < gap->ga_len
21737 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21738 ++fcp->linenr;
21739 if (fcp->linenr >= gap->ga_len)
21740 retval = NULL;
21741 else
21743 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21744 sourcing_lnum = fcp->linenr;
21745 #ifdef FEAT_PROFILE
21746 if (do_profiling == PROF_YES)
21747 func_line_start(cookie);
21748 #endif
21752 /* Did we encounter a breakpoint? */
21753 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21755 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21756 /* Find next breakpoint. */
21757 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21758 sourcing_lnum);
21759 fcp->dbg_tick = debug_tick;
21762 return retval;
21765 #if defined(FEAT_PROFILE) || defined(PROTO)
21767 * Called when starting to read a function line.
21768 * "sourcing_lnum" must be correct!
21769 * When skipping lines it may not actually be executed, but we won't find out
21770 * until later and we need to store the time now.
21772 void
21773 func_line_start(cookie)
21774 void *cookie;
21776 funccall_T *fcp = (funccall_T *)cookie;
21777 ufunc_T *fp = fcp->func;
21779 if (fp->uf_profiling && sourcing_lnum >= 1
21780 && sourcing_lnum <= fp->uf_lines.ga_len)
21782 fp->uf_tml_idx = sourcing_lnum - 1;
21783 /* Skip continuation lines. */
21784 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21785 --fp->uf_tml_idx;
21786 fp->uf_tml_execed = FALSE;
21787 profile_start(&fp->uf_tml_start);
21788 profile_zero(&fp->uf_tml_children);
21789 profile_get_wait(&fp->uf_tml_wait);
21794 * Called when actually executing a function line.
21796 void
21797 func_line_exec(cookie)
21798 void *cookie;
21800 funccall_T *fcp = (funccall_T *)cookie;
21801 ufunc_T *fp = fcp->func;
21803 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21804 fp->uf_tml_execed = TRUE;
21808 * Called when done with a function line.
21810 void
21811 func_line_end(cookie)
21812 void *cookie;
21814 funccall_T *fcp = (funccall_T *)cookie;
21815 ufunc_T *fp = fcp->func;
21817 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21819 if (fp->uf_tml_execed)
21821 ++fp->uf_tml_count[fp->uf_tml_idx];
21822 profile_end(&fp->uf_tml_start);
21823 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21824 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21825 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21826 &fp->uf_tml_children);
21828 fp->uf_tml_idx = -1;
21831 #endif
21834 * Return TRUE if the currently active function should be ended, because a
21835 * return was encountered or an error occurred. Used inside a ":while".
21838 func_has_ended(cookie)
21839 void *cookie;
21841 funccall_T *fcp = (funccall_T *)cookie;
21843 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21844 * an error inside a try conditional. */
21845 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21846 || fcp->returned);
21850 * return TRUE if cookie indicates a function which "abort"s on errors.
21853 func_has_abort(cookie)
21854 void *cookie;
21856 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21859 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21860 typedef enum
21862 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21863 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21864 VAR_FLAVOUR_VIMINFO /* all uppercase */
21865 } var_flavour_T;
21867 static var_flavour_T var_flavour __ARGS((char_u *varname));
21869 static var_flavour_T
21870 var_flavour(varname)
21871 char_u *varname;
21873 char_u *p = varname;
21875 if (ASCII_ISUPPER(*p))
21877 while (*(++p))
21878 if (ASCII_ISLOWER(*p))
21879 return VAR_FLAVOUR_SESSION;
21880 return VAR_FLAVOUR_VIMINFO;
21882 else
21883 return VAR_FLAVOUR_DEFAULT;
21885 #endif
21887 #if defined(FEAT_VIMINFO) || defined(PROTO)
21889 * Restore global vars that start with a capital from the viminfo file
21892 read_viminfo_varlist(virp, writing)
21893 vir_T *virp;
21894 int writing;
21896 char_u *tab;
21897 int type = VAR_NUMBER;
21898 typval_T tv;
21900 if (!writing && (find_viminfo_parameter('!') != NULL))
21902 tab = vim_strchr(virp->vir_line + 1, '\t');
21903 if (tab != NULL)
21905 *tab++ = '\0'; /* isolate the variable name */
21906 if (*tab == 'S') /* string var */
21907 type = VAR_STRING;
21908 #ifdef FEAT_FLOAT
21909 else if (*tab == 'F')
21910 type = VAR_FLOAT;
21911 #endif
21913 tab = vim_strchr(tab, '\t');
21914 if (tab != NULL)
21916 tv.v_type = type;
21917 if (type == VAR_STRING)
21918 tv.vval.v_string = viminfo_readstring(virp,
21919 (int)(tab - virp->vir_line + 1), TRUE);
21920 #ifdef FEAT_FLOAT
21921 else if (type == VAR_FLOAT)
21922 (void)string2float(tab + 1, &tv.vval.v_float);
21923 #endif
21924 else
21925 tv.vval.v_number = atol((char *)tab + 1);
21926 set_var(virp->vir_line + 1, &tv, FALSE);
21927 if (type == VAR_STRING)
21928 vim_free(tv.vval.v_string);
21933 return viminfo_readline(virp);
21937 * Write global vars that start with a capital to the viminfo file
21939 void
21940 write_viminfo_varlist(fp)
21941 FILE *fp;
21943 hashitem_T *hi;
21944 dictitem_T *this_var;
21945 int todo;
21946 char *s;
21947 char_u *p;
21948 char_u *tofree;
21949 char_u numbuf[NUMBUFLEN];
21951 if (find_viminfo_parameter('!') == NULL)
21952 return;
21954 fprintf(fp, _("\n# global variables:\n"));
21956 todo = (int)globvarht.ht_used;
21957 for (hi = globvarht.ht_array; todo > 0; ++hi)
21959 if (!HASHITEM_EMPTY(hi))
21961 --todo;
21962 this_var = HI2DI(hi);
21963 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21965 switch (this_var->di_tv.v_type)
21967 case VAR_STRING: s = "STR"; break;
21968 case VAR_NUMBER: s = "NUM"; break;
21969 #ifdef FEAT_FLOAT
21970 case VAR_FLOAT: s = "FLO"; break;
21971 #endif
21972 default: continue;
21974 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21975 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21976 if (p != NULL)
21977 viminfo_writestring(fp, p);
21978 vim_free(tofree);
21983 #endif
21985 #if defined(FEAT_SESSION) || defined(PROTO)
21987 store_session_globals(fd)
21988 FILE *fd;
21990 hashitem_T *hi;
21991 dictitem_T *this_var;
21992 int todo;
21993 char_u *p, *t;
21995 todo = (int)globvarht.ht_used;
21996 for (hi = globvarht.ht_array; todo > 0; ++hi)
21998 if (!HASHITEM_EMPTY(hi))
22000 --todo;
22001 this_var = HI2DI(hi);
22002 if ((this_var->di_tv.v_type == VAR_NUMBER
22003 || this_var->di_tv.v_type == VAR_STRING)
22004 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22006 /* Escape special characters with a backslash. Turn a LF and
22007 * CR into \n and \r. */
22008 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
22009 (char_u *)"\\\"\n\r");
22010 if (p == NULL) /* out of memory */
22011 break;
22012 for (t = p; *t != NUL; ++t)
22013 if (*t == '\n')
22014 *t = 'n';
22015 else if (*t == '\r')
22016 *t = 'r';
22017 if ((fprintf(fd, "let %s = %c%s%c",
22018 this_var->di_key,
22019 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22020 : ' ',
22022 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22023 : ' ') < 0)
22024 || put_eol(fd) == FAIL)
22026 vim_free(p);
22027 return FAIL;
22029 vim_free(p);
22031 #ifdef FEAT_FLOAT
22032 else if (this_var->di_tv.v_type == VAR_FLOAT
22033 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22035 float_T f = this_var->di_tv.vval.v_float;
22036 int sign = ' ';
22038 if (f < 0)
22040 f = -f;
22041 sign = '-';
22043 if ((fprintf(fd, "let %s = %c&%f",
22044 this_var->di_key, sign, f) < 0)
22045 || put_eol(fd) == FAIL)
22046 return FAIL;
22048 #endif
22051 return OK;
22053 #endif
22056 * Display script name where an item was last set.
22057 * Should only be invoked when 'verbose' is non-zero.
22059 void
22060 last_set_msg(scriptID)
22061 scid_T scriptID;
22063 char_u *p;
22065 if (scriptID != 0)
22067 p = home_replace_save(NULL, get_scriptname(scriptID));
22068 if (p != NULL)
22070 verbose_enter();
22071 MSG_PUTS(_("\n\tLast set from "));
22072 MSG_PUTS(p);
22073 vim_free(p);
22074 verbose_leave();
22080 * List v:oldfiles in a nice way.
22082 void
22083 ex_oldfiles(eap)
22084 exarg_T *eap UNUSED;
22086 list_T *l = vimvars[VV_OLDFILES].vv_list;
22087 listitem_T *li;
22088 int nr = 0;
22090 if (l == NULL)
22091 msg((char_u *)_("No old files"));
22092 else
22094 msg_start();
22095 msg_scroll = TRUE;
22096 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22098 msg_outnum((long)++nr);
22099 MSG_PUTS(": ");
22100 msg_outtrans(get_tv_string(&li->li_tv));
22101 msg_putchar('\n');
22102 out_flush(); /* output one line at a time */
22103 ui_breakcheck();
22105 /* Assume "got_int" was set to truncate the listing. */
22106 got_int = FALSE;
22108 #ifdef FEAT_BROWSE_CMD
22109 if (cmdmod.browse)
22111 quit_more = FALSE;
22112 nr = prompt_for_number(FALSE);
22113 msg_starthere();
22114 if (nr > 0)
22116 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22117 (long)nr);
22119 if (p != NULL)
22121 p = expand_env_save(p);
22122 eap->arg = p;
22123 eap->cmdidx = CMD_edit;
22124 cmdmod.browse = FALSE;
22125 do_exedit(eap, NULL);
22126 vim_free(p);
22130 #endif
22134 #endif /* FEAT_EVAL */
22137 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22139 #ifdef WIN3264
22141 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22143 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22144 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22145 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22148 * Get the short path (8.3) for the filename in "fnamep".
22149 * Only works for a valid file name.
22150 * When the path gets longer "fnamep" is changed and the allocated buffer
22151 * is put in "bufp".
22152 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22153 * Returns OK on success, FAIL on failure.
22155 static int
22156 get_short_pathname(fnamep, bufp, fnamelen)
22157 char_u **fnamep;
22158 char_u **bufp;
22159 int *fnamelen;
22161 int l, len;
22162 char_u *newbuf;
22164 len = *fnamelen;
22165 l = GetShortPathName(*fnamep, *fnamep, len);
22166 if (l > len - 1)
22168 /* If that doesn't work (not enough space), then save the string
22169 * and try again with a new buffer big enough. */
22170 newbuf = vim_strnsave(*fnamep, l);
22171 if (newbuf == NULL)
22172 return FAIL;
22174 vim_free(*bufp);
22175 *fnamep = *bufp = newbuf;
22177 /* Really should always succeed, as the buffer is big enough. */
22178 l = GetShortPathName(*fnamep, *fnamep, l+1);
22181 *fnamelen = l;
22182 return OK;
22186 * Get the short path (8.3) for the filename in "fname". The converted
22187 * path is returned in "bufp".
22189 * Some of the directories specified in "fname" may not exist. This function
22190 * will shorten the existing directories at the beginning of the path and then
22191 * append the remaining non-existing path.
22193 * fname - Pointer to the filename to shorten. On return, contains the
22194 * pointer to the shortened pathname
22195 * bufp - Pointer to an allocated buffer for the filename.
22196 * fnamelen - Length of the filename pointed to by fname
22198 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22200 static int
22201 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22202 char_u **fname;
22203 char_u **bufp;
22204 int *fnamelen;
22206 char_u *short_fname, *save_fname, *pbuf_unused;
22207 char_u *endp, *save_endp;
22208 char_u ch;
22209 int old_len, len;
22210 int new_len, sfx_len;
22211 int retval = OK;
22213 /* Make a copy */
22214 old_len = *fnamelen;
22215 save_fname = vim_strnsave(*fname, old_len);
22216 pbuf_unused = NULL;
22217 short_fname = NULL;
22219 endp = save_fname + old_len - 1; /* Find the end of the copy */
22220 save_endp = endp;
22223 * Try shortening the supplied path till it succeeds by removing one
22224 * directory at a time from the tail of the path.
22226 len = 0;
22227 for (;;)
22229 /* go back one path-separator */
22230 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22231 --endp;
22232 if (endp <= save_fname)
22233 break; /* processed the complete path */
22236 * Replace the path separator with a NUL and try to shorten the
22237 * resulting path.
22239 ch = *endp;
22240 *endp = 0;
22241 short_fname = save_fname;
22242 len = (int)STRLEN(short_fname) + 1;
22243 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22245 retval = FAIL;
22246 goto theend;
22248 *endp = ch; /* preserve the string */
22250 if (len > 0)
22251 break; /* successfully shortened the path */
22253 /* failed to shorten the path. Skip the path separator */
22254 --endp;
22257 if (len > 0)
22260 * Succeeded in shortening the path. Now concatenate the shortened
22261 * path with the remaining path at the tail.
22264 /* Compute the length of the new path. */
22265 sfx_len = (int)(save_endp - endp) + 1;
22266 new_len = len + sfx_len;
22268 *fnamelen = new_len;
22269 vim_free(*bufp);
22270 if (new_len > old_len)
22272 /* There is not enough space in the currently allocated string,
22273 * copy it to a buffer big enough. */
22274 *fname = *bufp = vim_strnsave(short_fname, new_len);
22275 if (*fname == NULL)
22277 retval = FAIL;
22278 goto theend;
22281 else
22283 /* Transfer short_fname to the main buffer (it's big enough),
22284 * unless get_short_pathname() did its work in-place. */
22285 *fname = *bufp = save_fname;
22286 if (short_fname != save_fname)
22287 vim_strncpy(save_fname, short_fname, len);
22288 save_fname = NULL;
22291 /* concat the not-shortened part of the path */
22292 vim_strncpy(*fname + len, endp, sfx_len);
22293 (*fname)[new_len] = NUL;
22296 theend:
22297 vim_free(pbuf_unused);
22298 vim_free(save_fname);
22300 return retval;
22304 * Get a pathname for a partial path.
22305 * Returns OK for success, FAIL for failure.
22307 static int
22308 shortpath_for_partial(fnamep, bufp, fnamelen)
22309 char_u **fnamep;
22310 char_u **bufp;
22311 int *fnamelen;
22313 int sepcount, len, tflen;
22314 char_u *p;
22315 char_u *pbuf, *tfname;
22316 int hasTilde;
22318 /* Count up the path separators from the RHS.. so we know which part
22319 * of the path to return. */
22320 sepcount = 0;
22321 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22322 if (vim_ispathsep(*p))
22323 ++sepcount;
22325 /* Need full path first (use expand_env() to remove a "~/") */
22326 hasTilde = (**fnamep == '~');
22327 if (hasTilde)
22328 pbuf = tfname = expand_env_save(*fnamep);
22329 else
22330 pbuf = tfname = FullName_save(*fnamep, FALSE);
22332 len = tflen = (int)STRLEN(tfname);
22334 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22335 return FAIL;
22337 if (len == 0)
22339 /* Don't have a valid filename, so shorten the rest of the
22340 * path if we can. This CAN give us invalid 8.3 filenames, but
22341 * there's not a lot of point in guessing what it might be.
22343 len = tflen;
22344 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22345 return FAIL;
22348 /* Count the paths backward to find the beginning of the desired string. */
22349 for (p = tfname + len - 1; p >= tfname; --p)
22351 #ifdef FEAT_MBYTE
22352 if (has_mbyte)
22353 p -= mb_head_off(tfname, p);
22354 #endif
22355 if (vim_ispathsep(*p))
22357 if (sepcount == 0 || (hasTilde && sepcount == 1))
22358 break;
22359 else
22360 sepcount --;
22363 if (hasTilde)
22365 --p;
22366 if (p >= tfname)
22367 *p = '~';
22368 else
22369 return FAIL;
22371 else
22372 ++p;
22374 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22375 vim_free(*bufp);
22376 *fnamelen = (int)STRLEN(p);
22377 *bufp = pbuf;
22378 *fnamep = p;
22380 return OK;
22382 #endif /* WIN3264 */
22385 * Adjust a filename, according to a string of modifiers.
22386 * *fnamep must be NUL terminated when called. When returning, the length is
22387 * determined by *fnamelen.
22388 * Returns VALID_ flags or -1 for failure.
22389 * When there is an error, *fnamep is set to NULL.
22392 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22393 char_u *src; /* string with modifiers */
22394 int *usedlen; /* characters after src that are used */
22395 char_u **fnamep; /* file name so far */
22396 char_u **bufp; /* buffer for allocated file name or NULL */
22397 int *fnamelen; /* length of fnamep */
22399 int valid = 0;
22400 char_u *tail;
22401 char_u *s, *p, *pbuf;
22402 char_u dirname[MAXPATHL];
22403 int c;
22404 int has_fullname = 0;
22405 #ifdef WIN3264
22406 int has_shortname = 0;
22407 #endif
22409 repeat:
22410 /* ":p" - full path/file_name */
22411 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22413 has_fullname = 1;
22415 valid |= VALID_PATH;
22416 *usedlen += 2;
22418 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22419 if ((*fnamep)[0] == '~'
22420 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22421 && ((*fnamep)[1] == '/'
22422 # ifdef BACKSLASH_IN_FILENAME
22423 || (*fnamep)[1] == '\\'
22424 # endif
22425 || (*fnamep)[1] == NUL)
22427 #endif
22430 *fnamep = expand_env_save(*fnamep);
22431 vim_free(*bufp); /* free any allocated file name */
22432 *bufp = *fnamep;
22433 if (*fnamep == NULL)
22434 return -1;
22437 /* When "/." or "/.." is used: force expansion to get rid of it. */
22438 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22440 if (vim_ispathsep(*p)
22441 && p[1] == '.'
22442 && (p[2] == NUL
22443 || vim_ispathsep(p[2])
22444 || (p[2] == '.'
22445 && (p[3] == NUL || vim_ispathsep(p[3])))))
22446 break;
22449 /* FullName_save() is slow, don't use it when not needed. */
22450 if (*p != NUL || !vim_isAbsName(*fnamep))
22452 *fnamep = FullName_save(*fnamep, *p != NUL);
22453 vim_free(*bufp); /* free any allocated file name */
22454 *bufp = *fnamep;
22455 if (*fnamep == NULL)
22456 return -1;
22459 /* Append a path separator to a directory. */
22460 if (mch_isdir(*fnamep))
22462 /* Make room for one or two extra characters. */
22463 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22464 vim_free(*bufp); /* free any allocated file name */
22465 *bufp = *fnamep;
22466 if (*fnamep == NULL)
22467 return -1;
22468 add_pathsep(*fnamep);
22472 /* ":." - path relative to the current directory */
22473 /* ":~" - path relative to the home directory */
22474 /* ":8" - shortname path - postponed till after */
22475 while (src[*usedlen] == ':'
22476 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22478 *usedlen += 2;
22479 if (c == '8')
22481 #ifdef WIN3264
22482 has_shortname = 1; /* Postpone this. */
22483 #endif
22484 continue;
22486 pbuf = NULL;
22487 /* Need full path first (use expand_env() to remove a "~/") */
22488 if (!has_fullname)
22490 if (c == '.' && **fnamep == '~')
22491 p = pbuf = expand_env_save(*fnamep);
22492 else
22493 p = pbuf = FullName_save(*fnamep, FALSE);
22495 else
22496 p = *fnamep;
22498 has_fullname = 0;
22500 if (p != NULL)
22502 if (c == '.')
22504 mch_dirname(dirname, MAXPATHL);
22505 s = shorten_fname(p, dirname);
22506 if (s != NULL)
22508 *fnamep = s;
22509 if (pbuf != NULL)
22511 vim_free(*bufp); /* free any allocated file name */
22512 *bufp = pbuf;
22513 pbuf = NULL;
22517 else
22519 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22520 /* Only replace it when it starts with '~' */
22521 if (*dirname == '~')
22523 s = vim_strsave(dirname);
22524 if (s != NULL)
22526 *fnamep = s;
22527 vim_free(*bufp);
22528 *bufp = s;
22532 vim_free(pbuf);
22536 tail = gettail(*fnamep);
22537 *fnamelen = (int)STRLEN(*fnamep);
22539 /* ":h" - head, remove "/file_name", can be repeated */
22540 /* Don't remove the first "/" or "c:\" */
22541 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22543 valid |= VALID_HEAD;
22544 *usedlen += 2;
22545 s = get_past_head(*fnamep);
22546 while (tail > s && after_pathsep(s, tail))
22547 mb_ptr_back(*fnamep, tail);
22548 *fnamelen = (int)(tail - *fnamep);
22549 #ifdef VMS
22550 if (*fnamelen > 0)
22551 *fnamelen += 1; /* the path separator is part of the path */
22552 #endif
22553 if (*fnamelen == 0)
22555 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22556 p = vim_strsave((char_u *)".");
22557 if (p == NULL)
22558 return -1;
22559 vim_free(*bufp);
22560 *bufp = *fnamep = tail = p;
22561 *fnamelen = 1;
22563 else
22565 while (tail > s && !after_pathsep(s, tail))
22566 mb_ptr_back(*fnamep, tail);
22570 /* ":8" - shortname */
22571 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22573 *usedlen += 2;
22574 #ifdef WIN3264
22575 has_shortname = 1;
22576 #endif
22579 #ifdef WIN3264
22580 /* Check shortname after we have done 'heads' and before we do 'tails'
22582 if (has_shortname)
22584 pbuf = NULL;
22585 /* Copy the string if it is shortened by :h */
22586 if (*fnamelen < (int)STRLEN(*fnamep))
22588 p = vim_strnsave(*fnamep, *fnamelen);
22589 if (p == 0)
22590 return -1;
22591 vim_free(*bufp);
22592 *bufp = *fnamep = p;
22595 /* Split into two implementations - makes it easier. First is where
22596 * there isn't a full name already, second is where there is.
22598 if (!has_fullname && !vim_isAbsName(*fnamep))
22600 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22601 return -1;
22603 else
22605 int l;
22607 /* Simple case, already have the full-name
22608 * Nearly always shorter, so try first time. */
22609 l = *fnamelen;
22610 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22611 return -1;
22613 if (l == 0)
22615 /* Couldn't find the filename.. search the paths.
22617 l = *fnamelen;
22618 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22619 return -1;
22621 *fnamelen = l;
22624 #endif /* WIN3264 */
22626 /* ":t" - tail, just the basename */
22627 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22629 *usedlen += 2;
22630 *fnamelen -= (int)(tail - *fnamep);
22631 *fnamep = tail;
22634 /* ":e" - extension, can be repeated */
22635 /* ":r" - root, without extension, can be repeated */
22636 while (src[*usedlen] == ':'
22637 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22639 /* find a '.' in the tail:
22640 * - for second :e: before the current fname
22641 * - otherwise: The last '.'
22643 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22644 s = *fnamep - 2;
22645 else
22646 s = *fnamep + *fnamelen - 1;
22647 for ( ; s > tail; --s)
22648 if (s[0] == '.')
22649 break;
22650 if (src[*usedlen + 1] == 'e') /* :e */
22652 if (s > tail)
22654 *fnamelen += (int)(*fnamep - (s + 1));
22655 *fnamep = s + 1;
22656 #ifdef VMS
22657 /* cut version from the extension */
22658 s = *fnamep + *fnamelen - 1;
22659 for ( ; s > *fnamep; --s)
22660 if (s[0] == ';')
22661 break;
22662 if (s > *fnamep)
22663 *fnamelen = s - *fnamep;
22664 #endif
22666 else if (*fnamep <= tail)
22667 *fnamelen = 0;
22669 else /* :r */
22671 if (s > tail) /* remove one extension */
22672 *fnamelen = (int)(s - *fnamep);
22674 *usedlen += 2;
22677 /* ":s?pat?foo?" - substitute */
22678 /* ":gs?pat?foo?" - global substitute */
22679 if (src[*usedlen] == ':'
22680 && (src[*usedlen + 1] == 's'
22681 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22683 char_u *str;
22684 char_u *pat;
22685 char_u *sub;
22686 int sep;
22687 char_u *flags;
22688 int didit = FALSE;
22690 flags = (char_u *)"";
22691 s = src + *usedlen + 2;
22692 if (src[*usedlen + 1] == 'g')
22694 flags = (char_u *)"g";
22695 ++s;
22698 sep = *s++;
22699 if (sep)
22701 /* find end of pattern */
22702 p = vim_strchr(s, sep);
22703 if (p != NULL)
22705 pat = vim_strnsave(s, (int)(p - s));
22706 if (pat != NULL)
22708 s = p + 1;
22709 /* find end of substitution */
22710 p = vim_strchr(s, sep);
22711 if (p != NULL)
22713 sub = vim_strnsave(s, (int)(p - s));
22714 str = vim_strnsave(*fnamep, *fnamelen);
22715 if (sub != NULL && str != NULL)
22717 *usedlen = (int)(p + 1 - src);
22718 s = do_string_sub(str, pat, sub, flags);
22719 if (s != NULL)
22721 *fnamep = s;
22722 *fnamelen = (int)STRLEN(s);
22723 vim_free(*bufp);
22724 *bufp = s;
22725 didit = TRUE;
22728 vim_free(sub);
22729 vim_free(str);
22731 vim_free(pat);
22734 /* after using ":s", repeat all the modifiers */
22735 if (didit)
22736 goto repeat;
22740 return valid;
22744 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22745 * "flags" can be "g" to do a global substitute.
22746 * Returns an allocated string, NULL for error.
22748 char_u *
22749 do_string_sub(str, pat, sub, flags)
22750 char_u *str;
22751 char_u *pat;
22752 char_u *sub;
22753 char_u *flags;
22755 int sublen;
22756 regmatch_T regmatch;
22757 int i;
22758 int do_all;
22759 char_u *tail;
22760 garray_T ga;
22761 char_u *ret;
22762 char_u *save_cpo;
22764 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22765 save_cpo = p_cpo;
22766 p_cpo = empty_option;
22768 ga_init2(&ga, 1, 200);
22770 do_all = (flags[0] == 'g');
22772 regmatch.rm_ic = p_ic;
22773 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22774 if (regmatch.regprog != NULL)
22776 tail = str;
22777 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22780 * Get some space for a temporary buffer to do the substitution
22781 * into. It will contain:
22782 * - The text up to where the match is.
22783 * - The substituted text.
22784 * - The text after the match.
22786 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22787 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22788 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22790 ga_clear(&ga);
22791 break;
22794 /* copy the text up to where the match is */
22795 i = (int)(regmatch.startp[0] - tail);
22796 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22797 /* add the substituted text */
22798 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22799 + ga.ga_len + i, TRUE, TRUE, FALSE);
22800 ga.ga_len += i + sublen - 1;
22801 /* avoid getting stuck on a match with an empty string */
22802 if (tail == regmatch.endp[0])
22804 if (*tail == NUL)
22805 break;
22806 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22807 ++ga.ga_len;
22809 else
22811 tail = regmatch.endp[0];
22812 if (*tail == NUL)
22813 break;
22815 if (!do_all)
22816 break;
22819 if (ga.ga_data != NULL)
22820 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22822 vim_free(regmatch.regprog);
22825 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22826 ga_clear(&ga);
22827 if (p_cpo == empty_option)
22828 p_cpo = save_cpo;
22829 else
22830 /* Darn, evaluating {sub} expression changed the value. */
22831 free_string_option(save_cpo);
22833 return ret;
22836 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */