Merged from the latest developing branch.
[MacVim/KaoriYa.git] / src / eval.c
blobbc86a5594e88b431659648f3619df8d266aba327
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.
133 static int current_copyID = 0;
136 * Array to hold the hashtab with variables local to each sourced script.
137 * Each item holds a variable (nameless) that points to the dict_T.
139 typedef struct
141 dictitem_T sv_var;
142 dict_T sv_dict;
143 } scriptvar_T;
145 static garray_T ga_scripts = {0, 0, sizeof(scriptvar_T), 4, NULL};
146 #define SCRIPT_SV(id) (((scriptvar_T *)ga_scripts.ga_data)[(id) - 1])
147 #define SCRIPT_VARS(id) (SCRIPT_SV(id).sv_dict.dv_hashtab)
149 static int echo_attr = 0; /* attributes used for ":echo" */
151 /* Values for trans_function_name() argument: */
152 #define TFN_INT 1 /* internal function name OK */
153 #define TFN_QUIET 2 /* no error messages */
156 * Structure to hold info for a user function.
158 typedef struct ufunc ufunc_T;
160 struct ufunc
162 int uf_varargs; /* variable nr of arguments */
163 int uf_flags;
164 int uf_calls; /* nr of active calls */
165 garray_T uf_args; /* arguments */
166 garray_T uf_lines; /* function lines */
167 #ifdef FEAT_PROFILE
168 int uf_profiling; /* TRUE when func is being profiled */
169 /* profiling the function as a whole */
170 int uf_tm_count; /* nr of calls */
171 proftime_T uf_tm_total; /* time spent in function + children */
172 proftime_T uf_tm_self; /* time spent in function itself */
173 proftime_T uf_tm_children; /* time spent in children this call */
174 /* profiling the function per line */
175 int *uf_tml_count; /* nr of times line was executed */
176 proftime_T *uf_tml_total; /* time spent in a line + children */
177 proftime_T *uf_tml_self; /* time spent in a line itself */
178 proftime_T uf_tml_start; /* start time for current line */
179 proftime_T uf_tml_children; /* time spent in children for this line */
180 proftime_T uf_tml_wait; /* start wait time for current line */
181 int uf_tml_idx; /* index of line being timed; -1 if none */
182 int uf_tml_execed; /* line being timed was executed */
183 #endif
184 scid_T uf_script_ID; /* ID of script where function was defined,
185 used for s: variables */
186 int uf_refcount; /* for numbered function: reference count */
187 char_u uf_name[1]; /* name of function (actually longer); can
188 start with <SNR>123_ (<SNR> is K_SPECIAL
189 KS_EXTRA KE_SNR) */
192 /* function flags */
193 #define FC_ABORT 1 /* abort function on error */
194 #define FC_RANGE 2 /* function accepts range */
195 #define FC_DICT 4 /* Dict function, uses "self" */
198 * All user-defined functions are found in this hashtable.
200 static hashtab_T func_hashtab;
202 /* The names of packages that once were loaded are remembered. */
203 static garray_T ga_loaded = {0, 0, sizeof(char_u *), 4, NULL};
205 /* list heads for garbage collection */
206 static dict_T *first_dict = NULL; /* list of all dicts */
207 static list_T *first_list = NULL; /* list of all lists */
209 /* From user function to hashitem and back. */
210 static ufunc_T dumuf;
211 #define UF2HIKEY(fp) ((fp)->uf_name)
212 #define HIKEY2UF(p) ((ufunc_T *)(p - (dumuf.uf_name - (char_u *)&dumuf)))
213 #define HI2UF(hi) HIKEY2UF((hi)->hi_key)
215 #define FUNCARG(fp, j) ((char_u **)(fp->uf_args.ga_data))[j]
216 #define FUNCLINE(fp, j) ((char_u **)(fp->uf_lines.ga_data))[j]
218 #define MAX_FUNC_ARGS 20 /* maximum number of function arguments */
219 #define VAR_SHORT_LEN 20 /* short variable name length */
220 #define FIXVAR_CNT 12 /* number of fixed variables */
222 /* structure to hold info for a function that is currently being executed. */
223 typedef struct funccall_S funccall_T;
225 struct funccall_S
227 ufunc_T *func; /* function being called */
228 int linenr; /* next line to be executed */
229 int returned; /* ":return" used */
230 struct /* fixed variables for arguments */
232 dictitem_T var; /* variable (without room for name) */
233 char_u room[VAR_SHORT_LEN]; /* room for the name */
234 } fixvar[FIXVAR_CNT];
235 dict_T l_vars; /* l: local function variables */
236 dictitem_T l_vars_var; /* variable for l: scope */
237 dict_T l_avars; /* a: argument variables */
238 dictitem_T l_avars_var; /* variable for a: scope */
239 list_T l_varlist; /* list for a:000 */
240 listitem_T l_listitems[MAX_FUNC_ARGS]; /* listitems for a:000 */
241 typval_T *rettv; /* return value */
242 linenr_T breakpoint; /* next line with breakpoint or zero */
243 int dbg_tick; /* debug_tick when breakpoint was set */
244 int level; /* top nesting level of executed function */
245 #ifdef FEAT_PROFILE
246 proftime_T prof_child; /* time spent in a child */
247 #endif
248 funccall_T *caller; /* calling function or NULL */
252 * Info used by a ":for" loop.
254 typedef struct
256 int fi_semicolon; /* TRUE if ending in '; var]' */
257 int fi_varcount; /* nr of variables in the list */
258 listwatch_T fi_lw; /* keep an eye on the item used. */
259 list_T *fi_list; /* list being used */
260 } forinfo_T;
263 * Struct used by trans_function_name()
265 typedef struct
267 dict_T *fd_dict; /* Dictionary used */
268 char_u *fd_newkey; /* new key in "dict" in allocated memory */
269 dictitem_T *fd_di; /* Dictionary item used */
270 } funcdict_T;
274 * Array to hold the value of v: variables.
275 * The value is in a dictitem, so that it can also be used in the v: scope.
276 * The reason to use this table anyway is for very quick access to the
277 * variables with the VV_ defines.
279 #include "version.h"
281 /* values for vv_flags: */
282 #define VV_COMPAT 1 /* compatible, also used without "v:" */
283 #define VV_RO 2 /* read-only */
284 #define VV_RO_SBX 4 /* read-only in the sandbox */
286 #define VV_NAME(s, t) s, {{t}}, {0}
288 static struct vimvar
290 char *vv_name; /* name of variable, without v: */
291 dictitem_T vv_di; /* value and name for key */
292 char vv_filler[16]; /* space for LONGEST name below!!! */
293 char vv_flags; /* VV_COMPAT, VV_RO, VV_RO_SBX */
294 } vimvars[VV_LEN] =
297 * The order here must match the VV_ defines in vim.h!
298 * Initializing a union does not work, leave tv.vval empty to get zero's.
300 {VV_NAME("count", VAR_NUMBER), VV_COMPAT+VV_RO},
301 {VV_NAME("count1", VAR_NUMBER), VV_RO},
302 {VV_NAME("prevcount", VAR_NUMBER), VV_RO},
303 {VV_NAME("errmsg", VAR_STRING), VV_COMPAT},
304 {VV_NAME("warningmsg", VAR_STRING), 0},
305 {VV_NAME("statusmsg", VAR_STRING), 0},
306 {VV_NAME("shell_error", VAR_NUMBER), VV_COMPAT+VV_RO},
307 {VV_NAME("this_session", VAR_STRING), VV_COMPAT},
308 {VV_NAME("version", VAR_NUMBER), VV_COMPAT+VV_RO},
309 {VV_NAME("lnum", VAR_NUMBER), VV_RO_SBX},
310 {VV_NAME("termresponse", VAR_STRING), VV_RO},
311 {VV_NAME("fname", VAR_STRING), VV_RO},
312 {VV_NAME("lang", VAR_STRING), VV_RO},
313 {VV_NAME("lc_time", VAR_STRING), VV_RO},
314 {VV_NAME("ctype", VAR_STRING), VV_RO},
315 {VV_NAME("charconvert_from", VAR_STRING), VV_RO},
316 {VV_NAME("charconvert_to", VAR_STRING), VV_RO},
317 {VV_NAME("fname_in", VAR_STRING), VV_RO},
318 {VV_NAME("fname_out", VAR_STRING), VV_RO},
319 {VV_NAME("fname_new", VAR_STRING), VV_RO},
320 {VV_NAME("fname_diff", VAR_STRING), VV_RO},
321 {VV_NAME("cmdarg", VAR_STRING), VV_RO},
322 {VV_NAME("foldstart", VAR_NUMBER), VV_RO_SBX},
323 {VV_NAME("foldend", VAR_NUMBER), VV_RO_SBX},
324 {VV_NAME("folddashes", VAR_STRING), VV_RO_SBX},
325 {VV_NAME("foldlevel", VAR_NUMBER), VV_RO_SBX},
326 {VV_NAME("progname", VAR_STRING), VV_RO},
327 {VV_NAME("servername", VAR_STRING), VV_RO},
328 {VV_NAME("dying", VAR_NUMBER), VV_RO},
329 {VV_NAME("exception", VAR_STRING), VV_RO},
330 {VV_NAME("throwpoint", VAR_STRING), VV_RO},
331 {VV_NAME("register", VAR_STRING), VV_RO},
332 {VV_NAME("cmdbang", VAR_NUMBER), VV_RO},
333 {VV_NAME("insertmode", VAR_STRING), VV_RO},
334 {VV_NAME("val", VAR_UNKNOWN), VV_RO},
335 {VV_NAME("key", VAR_UNKNOWN), VV_RO},
336 {VV_NAME("profiling", VAR_NUMBER), VV_RO},
337 {VV_NAME("fcs_reason", VAR_STRING), VV_RO},
338 {VV_NAME("fcs_choice", VAR_STRING), 0},
339 {VV_NAME("beval_bufnr", VAR_NUMBER), VV_RO},
340 {VV_NAME("beval_winnr", VAR_NUMBER), VV_RO},
341 {VV_NAME("beval_lnum", VAR_NUMBER), VV_RO},
342 {VV_NAME("beval_col", VAR_NUMBER), VV_RO},
343 {VV_NAME("beval_text", VAR_STRING), VV_RO},
344 {VV_NAME("scrollstart", VAR_STRING), 0},
345 {VV_NAME("swapname", VAR_STRING), VV_RO},
346 {VV_NAME("swapchoice", VAR_STRING), 0},
347 {VV_NAME("swapcommand", VAR_STRING), VV_RO},
348 {VV_NAME("char", VAR_STRING), VV_RO},
349 {VV_NAME("mouse_win", VAR_NUMBER), 0},
350 {VV_NAME("mouse_lnum", VAR_NUMBER), 0},
351 {VV_NAME("mouse_col", VAR_NUMBER), 0},
352 {VV_NAME("operator", VAR_STRING), VV_RO},
353 {VV_NAME("searchforward", VAR_NUMBER), 0},
354 {VV_NAME("oldfiles", VAR_LIST), 0},
357 /* shorthand */
358 #define vv_type vv_di.di_tv.v_type
359 #define vv_nr vv_di.di_tv.vval.v_number
360 #define vv_float vv_di.di_tv.vval.v_float
361 #define vv_str vv_di.di_tv.vval.v_string
362 #define vv_list vv_di.di_tv.vval.v_list
363 #define vv_tv vv_di.di_tv
366 * The v: variables are stored in dictionary "vimvardict".
367 * "vimvars_var" is the variable that is used for the "l:" scope.
369 static dict_T vimvardict;
370 static dictitem_T vimvars_var;
371 #define vimvarht vimvardict.dv_hashtab
373 static void prepare_vimvar __ARGS((int idx, typval_T *save_tv));
374 static void restore_vimvar __ARGS((int idx, typval_T *save_tv));
375 #if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
376 static int call_vim_function __ARGS((char_u *func, int argc, char_u **argv, int safe, typval_T *rettv));
377 #endif
378 static int ex_let_vars __ARGS((char_u *arg, typval_T *tv, int copy, int semicolon, int var_count, char_u *nextchars));
379 static char_u *skip_var_list __ARGS((char_u *arg, int *var_count, int *semicolon));
380 static char_u *skip_var_one __ARGS((char_u *arg));
381 static void list_hashtable_vars __ARGS((hashtab_T *ht, char_u *prefix, int empty, int *first));
382 static void list_glob_vars __ARGS((int *first));
383 static void list_buf_vars __ARGS((int *first));
384 static void list_win_vars __ARGS((int *first));
385 #ifdef FEAT_WINDOWS
386 static void list_tab_vars __ARGS((int *first));
387 #endif
388 static void list_vim_vars __ARGS((int *first));
389 static void list_script_vars __ARGS((int *first));
390 static void list_func_vars __ARGS((int *first));
391 static char_u *list_arg_vars __ARGS((exarg_T *eap, char_u *arg, int *first));
392 static char_u *ex_let_one __ARGS((char_u *arg, typval_T *tv, int copy, char_u *endchars, char_u *op));
393 static int check_changedtick __ARGS((char_u *arg));
394 static char_u *get_lval __ARGS((char_u *name, typval_T *rettv, lval_T *lp, int unlet, int skip, int quiet, int fne_flags));
395 static void clear_lval __ARGS((lval_T *lp));
396 static void set_var_lval __ARGS((lval_T *lp, char_u *endp, typval_T *rettv, int copy, char_u *op));
397 static int tv_op __ARGS((typval_T *tv1, typval_T *tv2, char_u *op));
398 static void list_add_watch __ARGS((list_T *l, listwatch_T *lw));
399 static void list_rem_watch __ARGS((list_T *l, listwatch_T *lwrem));
400 static void list_fix_watch __ARGS((list_T *l, listitem_T *item));
401 static void ex_unletlock __ARGS((exarg_T *eap, char_u *argstart, int deep));
402 static int do_unlet_var __ARGS((lval_T *lp, char_u *name_end, int forceit));
403 static int do_lock_var __ARGS((lval_T *lp, char_u *name_end, int deep, int lock));
404 static void item_lock __ARGS((typval_T *tv, int deep, int lock));
405 static int tv_islocked __ARGS((typval_T *tv));
407 static int eval0 __ARGS((char_u *arg, typval_T *rettv, char_u **nextcmd, int evaluate));
408 static int eval1 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
409 static int eval2 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
410 static int eval3 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
411 static int eval4 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
412 static int eval5 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
413 static int eval6 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
414 static int eval7 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
416 static int eval_index __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
417 static int get_option_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
418 static int get_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
419 static int get_lit_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
420 static int get_list_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
421 static int rettv_list_alloc __ARGS((typval_T *rettv));
422 static listitem_T *listitem_alloc __ARGS((void));
423 static void listitem_free __ARGS((listitem_T *item));
424 static void listitem_remove __ARGS((list_T *l, listitem_T *item));
425 static long list_len __ARGS((list_T *l));
426 static int list_equal __ARGS((list_T *l1, list_T *l2, int ic));
427 static int dict_equal __ARGS((dict_T *d1, dict_T *d2, int ic));
428 static int tv_equal __ARGS((typval_T *tv1, typval_T *tv2, int ic));
429 static listitem_T *list_find __ARGS((list_T *l, long n));
430 static long list_find_nr __ARGS((list_T *l, long idx, int *errorp));
431 static long list_idx_of_item __ARGS((list_T *l, listitem_T *item));
432 static void list_append __ARGS((list_T *l, listitem_T *item));
433 static int list_append_tv __ARGS((list_T *l, typval_T *tv));
434 static int list_append_number __ARGS((list_T *l, varnumber_T n));
435 static int list_insert_tv __ARGS((list_T *l, typval_T *tv, listitem_T *item));
436 static int list_extend __ARGS((list_T *l1, list_T *l2, listitem_T *bef));
437 static int list_concat __ARGS((list_T *l1, list_T *l2, typval_T *tv));
438 static list_T *list_copy __ARGS((list_T *orig, int deep, int copyID));
439 static void list_remove __ARGS((list_T *l, listitem_T *item, listitem_T *item2));
440 static char_u *list2string __ARGS((typval_T *tv, int copyID));
441 static int list_join __ARGS((garray_T *gap, list_T *l, char_u *sep, int echo, int copyID));
442 static void set_ref_in_ht __ARGS((hashtab_T *ht, int copyID));
443 static void set_ref_in_list __ARGS((list_T *l, int copyID));
444 static void set_ref_in_item __ARGS((typval_T *tv, int copyID));
445 static void dict_unref __ARGS((dict_T *d));
446 static void dict_free __ARGS((dict_T *d, int recurse));
447 static dictitem_T *dictitem_alloc __ARGS((char_u *key));
448 static dictitem_T *dictitem_copy __ARGS((dictitem_T *org));
449 static void dictitem_remove __ARGS((dict_T *dict, dictitem_T *item));
450 static void dictitem_free __ARGS((dictitem_T *item));
451 static dict_T *dict_copy __ARGS((dict_T *orig, int deep, int copyID));
452 static int dict_add __ARGS((dict_T *d, dictitem_T *item));
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 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
628 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
629 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
630 #ifdef FEAT_FLOAT
631 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
632 #endif
633 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
634 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
635 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
636 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
637 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
642 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
643 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
644 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
645 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
646 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
647 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
648 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
649 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
650 #ifdef FEAT_FLOAT
651 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
652 #endif
653 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
654 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
655 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
656 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
657 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
668 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
669 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
670 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
671 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
672 #ifdef FEAT_FLOAT
673 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
674 #endif
675 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
676 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
677 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
678 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
679 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
680 #ifdef FEAT_FLOAT
681 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
682 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
683 #endif
684 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
685 #ifdef HAVE_STRFTIME
686 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
687 #endif
688 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
689 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
690 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
691 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
692 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
693 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
699 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
700 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
707 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
708 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
709 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
710 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
711 #ifdef FEAT_FLOAT
712 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
713 #endif
714 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
715 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
716 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
717 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
718 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
724 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
725 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
726 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
727 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
729 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
730 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
731 static int get_env_len __ARGS((char_u **arg));
732 static int get_id_len __ARGS((char_u **arg));
733 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
734 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
735 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
736 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
737 valid character */
738 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
739 static int eval_isnamec __ARGS((int c));
740 static int eval_isnamec1 __ARGS((int c));
741 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
742 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
743 static typval_T *alloc_tv __ARGS((void));
744 static typval_T *alloc_string_tv __ARGS((char_u *string));
745 static void init_tv __ARGS((typval_T *varp));
746 static long get_tv_number __ARGS((typval_T *varp));
747 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
748 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
749 static char_u *get_tv_string __ARGS((typval_T *varp));
750 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
751 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
752 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
753 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
754 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
755 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
756 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
757 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
758 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
759 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
760 static int var_check_ro __ARGS((int flags, char_u *name));
761 static int var_check_fixed __ARGS((int flags, char_u *name));
762 static int tv_check_lock __ARGS((int lock, char_u *name));
763 static void copy_tv __ARGS((typval_T *from, typval_T *to));
764 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
765 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
766 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
767 static int eval_fname_script __ARGS((char_u *p));
768 static int eval_fname_sid __ARGS((char_u *p));
769 static void list_func_head __ARGS((ufunc_T *fp, int indent));
770 static ufunc_T *find_func __ARGS((char_u *name));
771 static int function_exists __ARGS((char_u *name));
772 static int builtin_function __ARGS((char_u *name));
773 #ifdef FEAT_PROFILE
774 static void func_do_profile __ARGS((ufunc_T *fp));
775 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
776 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
777 static int
778 # ifdef __BORLANDC__
779 _RTLENTRYF
780 # endif
781 prof_total_cmp __ARGS((const void *s1, const void *s2));
782 static int
783 # ifdef __BORLANDC__
784 _RTLENTRYF
785 # endif
786 prof_self_cmp __ARGS((const void *s1, const void *s2));
787 #endif
788 static int script_autoload __ARGS((char_u *name, int reload));
789 static char_u *autoload_name __ARGS((char_u *name));
790 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
791 static void func_free __ARGS((ufunc_T *fp));
792 static void func_unref __ARGS((char_u *name));
793 static void func_ref __ARGS((char_u *name));
794 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));
795 static int can_free_funccal __ARGS((funccall_T *fc, int copyID)) ;
796 static void free_funccal __ARGS((funccall_T *fc, int free_val));
797 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
798 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
799 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
800 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
801 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
802 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
804 /* Character used as separated in autoload function/variable names. */
805 #define AUTOLOAD_CHAR '#'
808 * Initialize the global and v: variables.
810 void
811 eval_init()
813 int i;
814 struct vimvar *p;
816 init_var_dict(&globvardict, &globvars_var);
817 init_var_dict(&vimvardict, &vimvars_var);
818 hash_init(&compat_hashtab);
819 hash_init(&func_hashtab);
821 for (i = 0; i < VV_LEN; ++i)
823 p = &vimvars[i];
824 STRCPY(p->vv_di.di_key, p->vv_name);
825 if (p->vv_flags & VV_RO)
826 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
827 else if (p->vv_flags & VV_RO_SBX)
828 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
829 else
830 p->vv_di.di_flags = DI_FLAGS_FIX;
832 /* add to v: scope dict, unless the value is not always available */
833 if (p->vv_type != VAR_UNKNOWN)
834 hash_add(&vimvarht, p->vv_di.di_key);
835 if (p->vv_flags & VV_COMPAT)
836 /* add to compat scope dict */
837 hash_add(&compat_hashtab, p->vv_di.di_key);
839 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
842 #if defined(EXITFREE) || defined(PROTO)
843 void
844 eval_clear()
846 int i;
847 struct vimvar *p;
849 for (i = 0; i < VV_LEN; ++i)
851 p = &vimvars[i];
852 if (p->vv_di.di_tv.v_type == VAR_STRING)
854 vim_free(p->vv_str);
855 p->vv_str = NULL;
857 else if (p->vv_di.di_tv.v_type == VAR_LIST)
859 list_unref(p->vv_list);
860 p->vv_list = NULL;
863 hash_clear(&vimvarht);
864 hash_init(&vimvarht); /* garbage_collect() will access it */
865 hash_clear(&compat_hashtab);
867 /* script-local variables */
868 for (i = 1; i <= ga_scripts.ga_len; ++i)
869 vars_clear(&SCRIPT_VARS(i));
870 ga_clear(&ga_scripts);
871 free_scriptnames();
873 /* global variables */
874 vars_clear(&globvarht);
876 /* autoloaded script names */
877 ga_clear_strings(&ga_loaded);
879 /* unreferenced lists and dicts */
880 (void)garbage_collect();
882 /* functions */
883 free_all_functions();
884 hash_clear(&func_hashtab);
886 #endif
889 * Return the name of the executed function.
891 char_u *
892 func_name(cookie)
893 void *cookie;
895 return ((funccall_T *)cookie)->func->uf_name;
899 * Return the address holding the next breakpoint line for a funccall cookie.
901 linenr_T *
902 func_breakpoint(cookie)
903 void *cookie;
905 return &((funccall_T *)cookie)->breakpoint;
909 * Return the address holding the debug tick for a funccall cookie.
911 int *
912 func_dbg_tick(cookie)
913 void *cookie;
915 return &((funccall_T *)cookie)->dbg_tick;
919 * Return the nesting level for a funccall cookie.
922 func_level(cookie)
923 void *cookie;
925 return ((funccall_T *)cookie)->level;
928 /* pointer to funccal for currently active function */
929 funccall_T *current_funccal = NULL;
931 /* pointer to list of previously used funccal, still around because some
932 * item in it is still being used. */
933 funccall_T *previous_funccal = NULL;
936 * Return TRUE when a function was ended by a ":return" command.
939 current_func_returned()
941 return current_funccal->returned;
946 * Set an internal variable to a string value. Creates the variable if it does
947 * not already exist.
949 void
950 set_internal_string_var(name, value)
951 char_u *name;
952 char_u *value;
954 char_u *val;
955 typval_T *tvp;
957 val = vim_strsave(value);
958 if (val != NULL)
960 tvp = alloc_string_tv(val);
961 if (tvp != NULL)
963 set_var(name, tvp, FALSE);
964 free_tv(tvp);
969 static lval_T *redir_lval = NULL;
970 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
971 static char_u *redir_endp = NULL;
972 static char_u *redir_varname = NULL;
975 * Start recording command output to a variable
976 * Returns OK if successfully completed the setup. FAIL otherwise.
979 var_redir_start(name, append)
980 char_u *name;
981 int append; /* append to an existing variable */
983 int save_emsg;
984 int err;
985 typval_T tv;
987 /* Make sure a valid variable name is specified */
988 if (!eval_isnamec1(*name))
990 EMSG(_(e_invarg));
991 return FAIL;
994 redir_varname = vim_strsave(name);
995 if (redir_varname == NULL)
996 return FAIL;
998 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
999 if (redir_lval == NULL)
1001 var_redir_stop();
1002 return FAIL;
1005 /* The output is stored in growarray "redir_ga" until redirection ends. */
1006 ga_init2(&redir_ga, (int)sizeof(char), 500);
1008 /* Parse the variable name (can be a dict or list entry). */
1009 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1010 FNE_CHECK_START);
1011 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1013 if (redir_endp != NULL && *redir_endp != NUL)
1014 /* Trailing characters are present after the variable name */
1015 EMSG(_(e_trailing));
1016 else
1017 EMSG(_(e_invarg));
1018 var_redir_stop();
1019 return FAIL;
1022 /* check if we can write to the variable: set it to or append an empty
1023 * string */
1024 save_emsg = did_emsg;
1025 did_emsg = FALSE;
1026 tv.v_type = VAR_STRING;
1027 tv.vval.v_string = (char_u *)"";
1028 if (append)
1029 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1030 else
1031 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1032 err = did_emsg;
1033 did_emsg |= save_emsg;
1034 if (err)
1036 var_redir_stop();
1037 return FAIL;
1039 if (redir_lval->ll_newkey != NULL)
1041 /* Dictionary item was created, don't do it again. */
1042 vim_free(redir_lval->ll_newkey);
1043 redir_lval->ll_newkey = NULL;
1046 return OK;
1050 * Append "value[value_len]" to the variable set by var_redir_start().
1051 * The actual appending is postponed until redirection ends, because the value
1052 * appended may in fact be the string we write to, changing it may cause freed
1053 * memory to be used:
1054 * :redir => foo
1055 * :let foo
1056 * :redir END
1058 void
1059 var_redir_str(value, value_len)
1060 char_u *value;
1061 int value_len;
1063 int len;
1065 if (redir_lval == NULL)
1066 return;
1068 if (value_len == -1)
1069 len = (int)STRLEN(value); /* Append the entire string */
1070 else
1071 len = value_len; /* Append only "value_len" characters */
1073 if (ga_grow(&redir_ga, len) == OK)
1075 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1076 redir_ga.ga_len += len;
1078 else
1079 var_redir_stop();
1083 * Stop redirecting command output to a variable.
1085 void
1086 var_redir_stop()
1088 typval_T tv;
1090 if (redir_lval != NULL)
1092 /* Append the trailing NUL. */
1093 ga_append(&redir_ga, NUL);
1095 /* Assign the text to the variable. */
1096 tv.v_type = VAR_STRING;
1097 tv.vval.v_string = redir_ga.ga_data;
1098 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1099 vim_free(tv.vval.v_string);
1101 clear_lval(redir_lval);
1102 vim_free(redir_lval);
1103 redir_lval = NULL;
1105 vim_free(redir_varname);
1106 redir_varname = NULL;
1109 # if defined(FEAT_MBYTE) || defined(PROTO)
1111 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1112 char_u *enc_from;
1113 char_u *enc_to;
1114 char_u *fname_from;
1115 char_u *fname_to;
1117 int err = FALSE;
1119 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1120 set_vim_var_string(VV_CC_TO, enc_to, -1);
1121 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1122 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1123 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1124 err = TRUE;
1125 set_vim_var_string(VV_CC_FROM, NULL, -1);
1126 set_vim_var_string(VV_CC_TO, NULL, -1);
1127 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1128 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1130 if (err)
1131 return FAIL;
1132 return OK;
1134 # endif
1136 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1138 eval_printexpr(fname, args)
1139 char_u *fname;
1140 char_u *args;
1142 int err = FALSE;
1144 set_vim_var_string(VV_FNAME_IN, fname, -1);
1145 set_vim_var_string(VV_CMDARG, args, -1);
1146 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1147 err = TRUE;
1148 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1149 set_vim_var_string(VV_CMDARG, NULL, -1);
1151 if (err)
1153 mch_remove(fname);
1154 return FAIL;
1156 return OK;
1158 # endif
1160 # if defined(FEAT_DIFF) || defined(PROTO)
1161 void
1162 eval_diff(origfile, newfile, outfile)
1163 char_u *origfile;
1164 char_u *newfile;
1165 char_u *outfile;
1167 int err = FALSE;
1169 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1170 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1171 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1172 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1173 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1174 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1175 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1178 void
1179 eval_patch(origfile, difffile, outfile)
1180 char_u *origfile;
1181 char_u *difffile;
1182 char_u *outfile;
1184 int err;
1186 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1187 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1188 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1189 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1190 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1191 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1192 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1194 # endif
1197 * Top level evaluation function, returning a boolean.
1198 * Sets "error" to TRUE if there was an error.
1199 * Return TRUE or FALSE.
1202 eval_to_bool(arg, error, nextcmd, skip)
1203 char_u *arg;
1204 int *error;
1205 char_u **nextcmd;
1206 int skip; /* only parse, don't execute */
1208 typval_T tv;
1209 int retval = FALSE;
1211 if (skip)
1212 ++emsg_skip;
1213 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1214 *error = TRUE;
1215 else
1217 *error = FALSE;
1218 if (!skip)
1220 retval = (get_tv_number_chk(&tv, error) != 0);
1221 clear_tv(&tv);
1224 if (skip)
1225 --emsg_skip;
1227 return retval;
1231 * Top level evaluation function, returning a string. If "skip" is TRUE,
1232 * only parsing to "nextcmd" is done, without reporting errors. Return
1233 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1235 char_u *
1236 eval_to_string_skip(arg, nextcmd, skip)
1237 char_u *arg;
1238 char_u **nextcmd;
1239 int skip; /* only parse, don't execute */
1241 typval_T tv;
1242 char_u *retval;
1244 if (skip)
1245 ++emsg_skip;
1246 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1247 retval = NULL;
1248 else
1250 retval = vim_strsave(get_tv_string(&tv));
1251 clear_tv(&tv);
1253 if (skip)
1254 --emsg_skip;
1256 return retval;
1260 * Skip over an expression at "*pp".
1261 * Return FAIL for an error, OK otherwise.
1264 skip_expr(pp)
1265 char_u **pp;
1267 typval_T rettv;
1269 *pp = skipwhite(*pp);
1270 return eval1(pp, &rettv, FALSE);
1274 * Top level evaluation function, returning a string.
1275 * When "convert" is TRUE convert a List into a sequence of lines and convert
1276 * a Float to a String.
1277 * Return pointer to allocated memory, or NULL for failure.
1279 char_u *
1280 eval_to_string(arg, nextcmd, convert)
1281 char_u *arg;
1282 char_u **nextcmd;
1283 int convert;
1285 typval_T tv;
1286 char_u *retval;
1287 garray_T ga;
1288 char_u numbuf[NUMBUFLEN];
1290 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1291 retval = NULL;
1292 else
1294 if (convert && tv.v_type == VAR_LIST)
1296 ga_init2(&ga, (int)sizeof(char), 80);
1297 if (tv.vval.v_list != NULL)
1298 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1299 ga_append(&ga, NUL);
1300 retval = (char_u *)ga.ga_data;
1302 #ifdef FEAT_FLOAT
1303 else if (convert && tv.v_type == VAR_FLOAT)
1305 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1306 retval = vim_strsave(numbuf);
1308 #endif
1309 else
1310 retval = vim_strsave(get_tv_string(&tv));
1311 clear_tv(&tv);
1314 return retval;
1318 * Call eval_to_string() without using current local variables and using
1319 * textlock. When "use_sandbox" is TRUE use the sandbox.
1321 char_u *
1322 eval_to_string_safe(arg, nextcmd, use_sandbox)
1323 char_u *arg;
1324 char_u **nextcmd;
1325 int use_sandbox;
1327 char_u *retval;
1328 void *save_funccalp;
1330 save_funccalp = save_funccal();
1331 if (use_sandbox)
1332 ++sandbox;
1333 ++textlock;
1334 retval = eval_to_string(arg, nextcmd, FALSE);
1335 if (use_sandbox)
1336 --sandbox;
1337 --textlock;
1338 restore_funccal(save_funccalp);
1339 return retval;
1343 * Top level evaluation function, returning a number.
1344 * Evaluates "expr" silently.
1345 * Returns -1 for an error.
1348 eval_to_number(expr)
1349 char_u *expr;
1351 typval_T rettv;
1352 int retval;
1353 char_u *p = skipwhite(expr);
1355 ++emsg_off;
1357 if (eval1(&p, &rettv, TRUE) == FAIL)
1358 retval = -1;
1359 else
1361 retval = get_tv_number_chk(&rettv, NULL);
1362 clear_tv(&rettv);
1364 --emsg_off;
1366 return retval;
1370 * Prepare v: variable "idx" to be used.
1371 * Save the current typeval in "save_tv".
1372 * When not used yet add the variable to the v: hashtable.
1374 static void
1375 prepare_vimvar(idx, save_tv)
1376 int idx;
1377 typval_T *save_tv;
1379 *save_tv = vimvars[idx].vv_tv;
1380 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1381 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1385 * Restore v: variable "idx" to typeval "save_tv".
1386 * When no longer defined, remove the variable from the v: hashtable.
1388 static void
1389 restore_vimvar(idx, save_tv)
1390 int idx;
1391 typval_T *save_tv;
1393 hashitem_T *hi;
1395 vimvars[idx].vv_tv = *save_tv;
1396 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1398 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1399 if (HASHITEM_EMPTY(hi))
1400 EMSG2(_(e_intern2), "restore_vimvar()");
1401 else
1402 hash_remove(&vimvarht, hi);
1406 #if defined(FEAT_SPELL) || defined(PROTO)
1408 * Evaluate an expression to a list with suggestions.
1409 * For the "expr:" part of 'spellsuggest'.
1410 * Returns NULL when there is an error.
1412 list_T *
1413 eval_spell_expr(badword, expr)
1414 char_u *badword;
1415 char_u *expr;
1417 typval_T save_val;
1418 typval_T rettv;
1419 list_T *list = NULL;
1420 char_u *p = skipwhite(expr);
1422 /* Set "v:val" to the bad word. */
1423 prepare_vimvar(VV_VAL, &save_val);
1424 vimvars[VV_VAL].vv_type = VAR_STRING;
1425 vimvars[VV_VAL].vv_str = badword;
1426 if (p_verbose == 0)
1427 ++emsg_off;
1429 if (eval1(&p, &rettv, TRUE) == OK)
1431 if (rettv.v_type != VAR_LIST)
1432 clear_tv(&rettv);
1433 else
1434 list = rettv.vval.v_list;
1437 if (p_verbose == 0)
1438 --emsg_off;
1439 restore_vimvar(VV_VAL, &save_val);
1441 return list;
1445 * "list" is supposed to contain two items: a word and a number. Return the
1446 * word in "pp" and the number as the return value.
1447 * Return -1 if anything isn't right.
1448 * Used to get the good word and score from the eval_spell_expr() result.
1451 get_spellword(list, pp)
1452 list_T *list;
1453 char_u **pp;
1455 listitem_T *li;
1457 li = list->lv_first;
1458 if (li == NULL)
1459 return -1;
1460 *pp = get_tv_string(&li->li_tv);
1462 li = li->li_next;
1463 if (li == NULL)
1464 return -1;
1465 return get_tv_number(&li->li_tv);
1467 #endif
1470 * Top level evaluation function.
1471 * Returns an allocated typval_T with the result.
1472 * Returns NULL when there is an error.
1474 typval_T *
1475 eval_expr(arg, nextcmd)
1476 char_u *arg;
1477 char_u **nextcmd;
1479 typval_T *tv;
1481 tv = (typval_T *)alloc(sizeof(typval_T));
1482 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1484 vim_free(tv);
1485 tv = NULL;
1488 return tv;
1492 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1493 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1495 * Call some vimL function and return the result in "*rettv".
1496 * Uses argv[argc] for the function arguments. Only Number and String
1497 * arguments are currently supported.
1498 * Returns OK or FAIL.
1500 static int
1501 call_vim_function(func, argc, argv, safe, rettv)
1502 char_u *func;
1503 int argc;
1504 char_u **argv;
1505 int safe; /* use the sandbox */
1506 typval_T *rettv;
1508 typval_T *argvars;
1509 long n;
1510 int len;
1511 int i;
1512 int doesrange;
1513 void *save_funccalp = NULL;
1514 int ret;
1516 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1517 if (argvars == NULL)
1518 return FAIL;
1520 for (i = 0; i < argc; i++)
1522 /* Pass a NULL or empty argument as an empty string */
1523 if (argv[i] == NULL || *argv[i] == NUL)
1525 argvars[i].v_type = VAR_STRING;
1526 argvars[i].vval.v_string = (char_u *)"";
1527 continue;
1530 /* Recognize a number argument, the others must be strings. */
1531 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1532 if (len != 0 && len == (int)STRLEN(argv[i]))
1534 argvars[i].v_type = VAR_NUMBER;
1535 argvars[i].vval.v_number = n;
1537 else
1539 argvars[i].v_type = VAR_STRING;
1540 argvars[i].vval.v_string = argv[i];
1544 if (safe)
1546 save_funccalp = save_funccal();
1547 ++sandbox;
1550 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1551 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1552 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1553 &doesrange, TRUE, NULL);
1554 if (safe)
1556 --sandbox;
1557 restore_funccal(save_funccalp);
1559 vim_free(argvars);
1561 if (ret == FAIL)
1562 clear_tv(rettv);
1564 return ret;
1567 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1569 * Call vimL function "func" and return the result as a string.
1570 * Returns NULL when calling the function fails.
1571 * Uses argv[argc] for the function arguments.
1573 void *
1574 call_func_retstr(func, argc, argv, safe)
1575 char_u *func;
1576 int argc;
1577 char_u **argv;
1578 int safe; /* use the sandbox */
1580 typval_T rettv;
1581 char_u *retval;
1583 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1584 return NULL;
1586 retval = vim_strsave(get_tv_string(&rettv));
1587 clear_tv(&rettv);
1588 return retval;
1590 # endif
1592 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1594 * Call vimL function "func" and return the result as a number.
1595 * Returns -1 when calling the function fails.
1596 * Uses argv[argc] for the function arguments.
1598 long
1599 call_func_retnr(func, argc, argv, safe)
1600 char_u *func;
1601 int argc;
1602 char_u **argv;
1603 int safe; /* use the sandbox */
1605 typval_T rettv;
1606 long retval;
1608 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1609 return -1;
1611 retval = get_tv_number_chk(&rettv, NULL);
1612 clear_tv(&rettv);
1613 return retval;
1615 # endif
1618 * Call vimL function "func" and return the result as a List.
1619 * Uses argv[argc] for the function arguments.
1620 * Returns NULL when there is something wrong.
1622 void *
1623 call_func_retlist(func, argc, argv, safe)
1624 char_u *func;
1625 int argc;
1626 char_u **argv;
1627 int safe; /* use the sandbox */
1629 typval_T rettv;
1631 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1632 return NULL;
1634 if (rettv.v_type != VAR_LIST)
1636 clear_tv(&rettv);
1637 return NULL;
1640 return rettv.vval.v_list;
1642 #endif
1646 * Save the current function call pointer, and set it to NULL.
1647 * Used when executing autocommands and for ":source".
1649 void *
1650 save_funccal()
1652 funccall_T *fc = current_funccal;
1654 current_funccal = NULL;
1655 return (void *)fc;
1658 void
1659 restore_funccal(vfc)
1660 void *vfc;
1662 funccall_T *fc = (funccall_T *)vfc;
1664 current_funccal = fc;
1667 #if defined(FEAT_PROFILE) || defined(PROTO)
1669 * Prepare profiling for entering a child or something else that is not
1670 * counted for the script/function itself.
1671 * Should always be called in pair with prof_child_exit().
1673 void
1674 prof_child_enter(tm)
1675 proftime_T *tm; /* place to store waittime */
1677 funccall_T *fc = current_funccal;
1679 if (fc != NULL && fc->func->uf_profiling)
1680 profile_start(&fc->prof_child);
1681 script_prof_save(tm);
1685 * Take care of time spent in a child.
1686 * Should always be called after prof_child_enter().
1688 void
1689 prof_child_exit(tm)
1690 proftime_T *tm; /* where waittime was stored */
1692 funccall_T *fc = current_funccal;
1694 if (fc != NULL && fc->func->uf_profiling)
1696 profile_end(&fc->prof_child);
1697 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1698 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1699 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1701 script_prof_restore(tm);
1703 #endif
1706 #ifdef FEAT_FOLDING
1708 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1709 * it in "*cp". Doesn't give error messages.
1712 eval_foldexpr(arg, cp)
1713 char_u *arg;
1714 int *cp;
1716 typval_T tv;
1717 int retval;
1718 char_u *s;
1719 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1720 OPT_LOCAL);
1722 ++emsg_off;
1723 if (use_sandbox)
1724 ++sandbox;
1725 ++textlock;
1726 *cp = NUL;
1727 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1728 retval = 0;
1729 else
1731 /* If the result is a number, just return the number. */
1732 if (tv.v_type == VAR_NUMBER)
1733 retval = tv.vval.v_number;
1734 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1735 retval = 0;
1736 else
1738 /* If the result is a string, check if there is a non-digit before
1739 * the number. */
1740 s = tv.vval.v_string;
1741 if (!VIM_ISDIGIT(*s) && *s != '-')
1742 *cp = *s++;
1743 retval = atol((char *)s);
1745 clear_tv(&tv);
1747 --emsg_off;
1748 if (use_sandbox)
1749 --sandbox;
1750 --textlock;
1752 return retval;
1754 #endif
1757 * ":let" list all variable values
1758 * ":let var1 var2" list variable values
1759 * ":let var = expr" assignment command.
1760 * ":let var += expr" assignment command.
1761 * ":let var -= expr" assignment command.
1762 * ":let var .= expr" assignment command.
1763 * ":let [var1, var2] = expr" unpack list.
1765 void
1766 ex_let(eap)
1767 exarg_T *eap;
1769 char_u *arg = eap->arg;
1770 char_u *expr = NULL;
1771 typval_T rettv;
1772 int i;
1773 int var_count = 0;
1774 int semicolon = 0;
1775 char_u op[2];
1776 char_u *argend;
1777 int first = TRUE;
1779 argend = skip_var_list(arg, &var_count, &semicolon);
1780 if (argend == NULL)
1781 return;
1782 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1783 --argend;
1784 expr = vim_strchr(argend, '=');
1785 if (expr == NULL)
1788 * ":let" without "=": list variables
1790 if (*arg == '[')
1791 EMSG(_(e_invarg));
1792 else if (!ends_excmd(*arg))
1793 /* ":let var1 var2" */
1794 arg = list_arg_vars(eap, arg, &first);
1795 else if (!eap->skip)
1797 /* ":let" */
1798 list_glob_vars(&first);
1799 list_buf_vars(&first);
1800 list_win_vars(&first);
1801 #ifdef FEAT_WINDOWS
1802 list_tab_vars(&first);
1803 #endif
1804 list_script_vars(&first);
1805 list_func_vars(&first);
1806 list_vim_vars(&first);
1808 eap->nextcmd = check_nextcmd(arg);
1810 else
1812 op[0] = '=';
1813 op[1] = NUL;
1814 if (expr > argend)
1816 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1817 op[0] = expr[-1]; /* +=, -= or .= */
1819 expr = skipwhite(expr + 1);
1821 if (eap->skip)
1822 ++emsg_skip;
1823 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1824 if (eap->skip)
1826 if (i != FAIL)
1827 clear_tv(&rettv);
1828 --emsg_skip;
1830 else if (i != FAIL)
1832 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1833 op);
1834 clear_tv(&rettv);
1840 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1841 * Handles both "var" with any type and "[var, var; var]" with a list type.
1842 * When "nextchars" is not NULL it points to a string with characters that
1843 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1844 * or concatenate.
1845 * Returns OK or FAIL;
1847 static int
1848 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1849 char_u *arg_start;
1850 typval_T *tv;
1851 int copy; /* copy values from "tv", don't move */
1852 int semicolon; /* from skip_var_list() */
1853 int var_count; /* from skip_var_list() */
1854 char_u *nextchars;
1856 char_u *arg = arg_start;
1857 list_T *l;
1858 int i;
1859 listitem_T *item;
1860 typval_T ltv;
1862 if (*arg != '[')
1865 * ":let var = expr" or ":for var in list"
1867 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1868 return FAIL;
1869 return OK;
1873 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1875 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1877 EMSG(_(e_listreq));
1878 return FAIL;
1881 i = list_len(l);
1882 if (semicolon == 0 && var_count < i)
1884 EMSG(_("E687: Less targets than List items"));
1885 return FAIL;
1887 if (var_count - semicolon > i)
1889 EMSG(_("E688: More targets than List items"));
1890 return FAIL;
1893 item = l->lv_first;
1894 while (*arg != ']')
1896 arg = skipwhite(arg + 1);
1897 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1898 item = item->li_next;
1899 if (arg == NULL)
1900 return FAIL;
1902 arg = skipwhite(arg);
1903 if (*arg == ';')
1905 /* Put the rest of the list (may be empty) in the var after ';'.
1906 * Create a new list for this. */
1907 l = list_alloc();
1908 if (l == NULL)
1909 return FAIL;
1910 while (item != NULL)
1912 list_append_tv(l, &item->li_tv);
1913 item = item->li_next;
1916 ltv.v_type = VAR_LIST;
1917 ltv.v_lock = 0;
1918 ltv.vval.v_list = l;
1919 l->lv_refcount = 1;
1921 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1922 (char_u *)"]", nextchars);
1923 clear_tv(&ltv);
1924 if (arg == NULL)
1925 return FAIL;
1926 break;
1928 else if (*arg != ',' && *arg != ']')
1930 EMSG2(_(e_intern2), "ex_let_vars()");
1931 return FAIL;
1935 return OK;
1939 * Skip over assignable variable "var" or list of variables "[var, var]".
1940 * Used for ":let varvar = expr" and ":for varvar in expr".
1941 * For "[var, var]" increment "*var_count" for each variable.
1942 * for "[var, var; var]" set "semicolon".
1943 * Return NULL for an error.
1945 static char_u *
1946 skip_var_list(arg, var_count, semicolon)
1947 char_u *arg;
1948 int *var_count;
1949 int *semicolon;
1951 char_u *p, *s;
1953 if (*arg == '[')
1955 /* "[var, var]": find the matching ']'. */
1956 p = arg;
1957 for (;;)
1959 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1960 s = skip_var_one(p);
1961 if (s == p)
1963 EMSG2(_(e_invarg2), p);
1964 return NULL;
1966 ++*var_count;
1968 p = skipwhite(s);
1969 if (*p == ']')
1970 break;
1971 else if (*p == ';')
1973 if (*semicolon == 1)
1975 EMSG(_("Double ; in list of variables"));
1976 return NULL;
1978 *semicolon = 1;
1980 else if (*p != ',')
1982 EMSG2(_(e_invarg2), p);
1983 return NULL;
1986 return p + 1;
1988 else
1989 return skip_var_one(arg);
1993 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1994 * l[idx].
1996 static char_u *
1997 skip_var_one(arg)
1998 char_u *arg;
2000 if (*arg == '@' && arg[1] != NUL)
2001 return arg + 2;
2002 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2003 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2007 * List variables for hashtab "ht" with prefix "prefix".
2008 * If "empty" is TRUE also list NULL strings as empty strings.
2010 static void
2011 list_hashtable_vars(ht, prefix, empty, first)
2012 hashtab_T *ht;
2013 char_u *prefix;
2014 int empty;
2015 int *first;
2017 hashitem_T *hi;
2018 dictitem_T *di;
2019 int todo;
2021 todo = (int)ht->ht_used;
2022 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2024 if (!HASHITEM_EMPTY(hi))
2026 --todo;
2027 di = HI2DI(hi);
2028 if (empty || di->di_tv.v_type != VAR_STRING
2029 || di->di_tv.vval.v_string != NULL)
2030 list_one_var(di, prefix, first);
2036 * List global variables.
2038 static void
2039 list_glob_vars(first)
2040 int *first;
2042 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2046 * List buffer variables.
2048 static void
2049 list_buf_vars(first)
2050 int *first;
2052 char_u numbuf[NUMBUFLEN];
2054 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2055 TRUE, first);
2057 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2058 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2059 numbuf, first);
2063 * List window variables.
2065 static void
2066 list_win_vars(first)
2067 int *first;
2069 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2070 (char_u *)"w:", TRUE, first);
2073 #ifdef FEAT_WINDOWS
2075 * List tab page variables.
2077 static void
2078 list_tab_vars(first)
2079 int *first;
2081 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2082 (char_u *)"t:", TRUE, first);
2084 #endif
2087 * List Vim variables.
2089 static void
2090 list_vim_vars(first)
2091 int *first;
2093 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2097 * List script-local variables, if there is a script.
2099 static void
2100 list_script_vars(first)
2101 int *first;
2103 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2104 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2105 (char_u *)"s:", FALSE, first);
2109 * List function variables, if there is a function.
2111 static void
2112 list_func_vars(first)
2113 int *first;
2115 if (current_funccal != NULL)
2116 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2117 (char_u *)"l:", FALSE, first);
2121 * List variables in "arg".
2123 static char_u *
2124 list_arg_vars(eap, arg, first)
2125 exarg_T *eap;
2126 char_u *arg;
2127 int *first;
2129 int error = FALSE;
2130 int len;
2131 char_u *name;
2132 char_u *name_start;
2133 char_u *arg_subsc;
2134 char_u *tofree;
2135 typval_T tv;
2137 while (!ends_excmd(*arg) && !got_int)
2139 if (error || eap->skip)
2141 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2142 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2144 emsg_severe = TRUE;
2145 EMSG(_(e_trailing));
2146 break;
2149 else
2151 /* get_name_len() takes care of expanding curly braces */
2152 name_start = name = arg;
2153 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2154 if (len <= 0)
2156 /* This is mainly to keep test 49 working: when expanding
2157 * curly braces fails overrule the exception error message. */
2158 if (len < 0 && !aborting())
2160 emsg_severe = TRUE;
2161 EMSG2(_(e_invarg2), arg);
2162 break;
2164 error = TRUE;
2166 else
2168 if (tofree != NULL)
2169 name = tofree;
2170 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2171 error = TRUE;
2172 else
2174 /* handle d.key, l[idx], f(expr) */
2175 arg_subsc = arg;
2176 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2177 error = TRUE;
2178 else
2180 if (arg == arg_subsc && len == 2 && name[1] == ':')
2182 switch (*name)
2184 case 'g': list_glob_vars(first); break;
2185 case 'b': list_buf_vars(first); break;
2186 case 'w': list_win_vars(first); break;
2187 #ifdef FEAT_WINDOWS
2188 case 't': list_tab_vars(first); break;
2189 #endif
2190 case 'v': list_vim_vars(first); break;
2191 case 's': list_script_vars(first); break;
2192 case 'l': list_func_vars(first); break;
2193 default:
2194 EMSG2(_("E738: Can't list variables for %s"), name);
2197 else
2199 char_u numbuf[NUMBUFLEN];
2200 char_u *tf;
2201 int c;
2202 char_u *s;
2204 s = echo_string(&tv, &tf, numbuf, 0);
2205 c = *arg;
2206 *arg = NUL;
2207 list_one_var_a((char_u *)"",
2208 arg == arg_subsc ? name : name_start,
2209 tv.v_type,
2210 s == NULL ? (char_u *)"" : s,
2211 first);
2212 *arg = c;
2213 vim_free(tf);
2215 clear_tv(&tv);
2220 vim_free(tofree);
2223 arg = skipwhite(arg);
2226 return arg;
2230 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2231 * Returns a pointer to the char just after the var name.
2232 * Returns NULL if there is an error.
2234 static char_u *
2235 ex_let_one(arg, tv, copy, endchars, op)
2236 char_u *arg; /* points to variable name */
2237 typval_T *tv; /* value to assign to variable */
2238 int copy; /* copy value from "tv" */
2239 char_u *endchars; /* valid chars after variable name or NULL */
2240 char_u *op; /* "+", "-", "." or NULL*/
2242 int c1;
2243 char_u *name;
2244 char_u *p;
2245 char_u *arg_end = NULL;
2246 int len;
2247 int opt_flags;
2248 char_u *tofree = NULL;
2251 * ":let $VAR = expr": Set environment variable.
2253 if (*arg == '$')
2255 /* Find the end of the name. */
2256 ++arg;
2257 name = arg;
2258 len = get_env_len(&arg);
2259 if (len == 0)
2260 EMSG2(_(e_invarg2), name - 1);
2261 else
2263 if (op != NULL && (*op == '+' || *op == '-'))
2264 EMSG2(_(e_letwrong), op);
2265 else if (endchars != NULL
2266 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2267 EMSG(_(e_letunexp));
2268 else
2270 c1 = name[len];
2271 name[len] = NUL;
2272 p = get_tv_string_chk(tv);
2273 if (p != NULL && op != NULL && *op == '.')
2275 int mustfree = FALSE;
2276 char_u *s = vim_getenv(name, &mustfree);
2278 if (s != NULL)
2280 p = tofree = concat_str(s, p);
2281 if (mustfree)
2282 vim_free(s);
2285 if (p != NULL)
2287 vim_setenv(name, p);
2288 if (STRICMP(name, "HOME") == 0)
2289 init_homedir();
2290 else if (didset_vim && STRICMP(name, "VIM") == 0)
2291 didset_vim = FALSE;
2292 else if (didset_vimruntime
2293 && STRICMP(name, "VIMRUNTIME") == 0)
2294 didset_vimruntime = FALSE;
2295 arg_end = arg;
2297 name[len] = c1;
2298 vim_free(tofree);
2304 * ":let &option = expr": Set option value.
2305 * ":let &l:option = expr": Set local option value.
2306 * ":let &g:option = expr": Set global option value.
2308 else if (*arg == '&')
2310 /* Find the end of the name. */
2311 p = find_option_end(&arg, &opt_flags);
2312 if (p == NULL || (endchars != NULL
2313 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2314 EMSG(_(e_letunexp));
2315 else
2317 long n;
2318 int opt_type;
2319 long numval;
2320 char_u *stringval = NULL;
2321 char_u *s;
2323 c1 = *p;
2324 *p = NUL;
2326 n = get_tv_number(tv);
2327 s = get_tv_string_chk(tv); /* != NULL if number or string */
2328 if (s != NULL && op != NULL && *op != '=')
2330 opt_type = get_option_value(arg, &numval,
2331 &stringval, opt_flags);
2332 if ((opt_type == 1 && *op == '.')
2333 || (opt_type == 0 && *op != '.'))
2334 EMSG2(_(e_letwrong), op);
2335 else
2337 if (opt_type == 1) /* number */
2339 if (*op == '+')
2340 n = numval + n;
2341 else
2342 n = numval - n;
2344 else if (opt_type == 0 && stringval != NULL) /* string */
2346 s = concat_str(stringval, s);
2347 vim_free(stringval);
2348 stringval = s;
2352 if (s != NULL)
2354 set_option_value(arg, n, s, opt_flags);
2355 arg_end = p;
2357 *p = c1;
2358 vim_free(stringval);
2363 * ":let @r = expr": Set register contents.
2365 else if (*arg == '@')
2367 ++arg;
2368 if (op != NULL && (*op == '+' || *op == '-'))
2369 EMSG2(_(e_letwrong), op);
2370 else if (endchars != NULL
2371 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2372 EMSG(_(e_letunexp));
2373 else
2375 char_u *ptofree = NULL;
2376 char_u *s;
2378 p = get_tv_string_chk(tv);
2379 if (p != NULL && op != NULL && *op == '.')
2381 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2382 if (s != NULL)
2384 p = ptofree = concat_str(s, p);
2385 vim_free(s);
2388 if (p != NULL)
2390 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2391 arg_end = arg + 1;
2393 vim_free(ptofree);
2398 * ":let var = expr": Set internal variable.
2399 * ":let {expr} = expr": Idem, name made with curly braces
2401 else if (eval_isnamec1(*arg) || *arg == '{')
2403 lval_T lv;
2405 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2406 if (p != NULL && lv.ll_name != NULL)
2408 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2409 EMSG(_(e_letunexp));
2410 else
2412 set_var_lval(&lv, p, tv, copy, op);
2413 arg_end = p;
2416 clear_lval(&lv);
2419 else
2420 EMSG2(_(e_invarg2), arg);
2422 return arg_end;
2426 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2428 static int
2429 check_changedtick(arg)
2430 char_u *arg;
2432 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2434 EMSG2(_(e_readonlyvar), arg);
2435 return TRUE;
2437 return FALSE;
2441 * Get an lval: variable, Dict item or List item that can be assigned a value
2442 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2443 * "name.key", "name.key[expr]" etc.
2444 * Indexing only works if "name" is an existing List or Dictionary.
2445 * "name" points to the start of the name.
2446 * If "rettv" is not NULL it points to the value to be assigned.
2447 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2448 * wrong; must end in space or cmd separator.
2450 * Returns a pointer to just after the name, including indexes.
2451 * When an evaluation error occurs "lp->ll_name" is NULL;
2452 * Returns NULL for a parsing error. Still need to free items in "lp"!
2454 static char_u *
2455 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2456 char_u *name;
2457 typval_T *rettv;
2458 lval_T *lp;
2459 int unlet;
2460 int skip;
2461 int quiet; /* don't give error messages */
2462 int fne_flags; /* flags for find_name_end() */
2464 char_u *p;
2465 char_u *expr_start, *expr_end;
2466 int cc;
2467 dictitem_T *v;
2468 typval_T var1;
2469 typval_T var2;
2470 int empty1 = FALSE;
2471 listitem_T *ni;
2472 char_u *key = NULL;
2473 int len;
2474 hashtab_T *ht;
2476 /* Clear everything in "lp". */
2477 vim_memset(lp, 0, sizeof(lval_T));
2479 if (skip)
2481 /* When skipping just find the end of the name. */
2482 lp->ll_name = name;
2483 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2486 /* Find the end of the name. */
2487 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2488 if (expr_start != NULL)
2490 /* Don't expand the name when we already know there is an error. */
2491 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2492 && *p != '[' && *p != '.')
2494 EMSG(_(e_trailing));
2495 return NULL;
2498 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2499 if (lp->ll_exp_name == NULL)
2501 /* Report an invalid expression in braces, unless the
2502 * expression evaluation has been cancelled due to an
2503 * aborting error, an interrupt, or an exception. */
2504 if (!aborting() && !quiet)
2506 emsg_severe = TRUE;
2507 EMSG2(_(e_invarg2), name);
2508 return NULL;
2511 lp->ll_name = lp->ll_exp_name;
2513 else
2514 lp->ll_name = name;
2516 /* Without [idx] or .key we are done. */
2517 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2518 return p;
2520 cc = *p;
2521 *p = NUL;
2522 v = find_var(lp->ll_name, &ht);
2523 if (v == NULL && !quiet)
2524 EMSG2(_(e_undefvar), lp->ll_name);
2525 *p = cc;
2526 if (v == NULL)
2527 return NULL;
2530 * Loop until no more [idx] or .key is following.
2532 lp->ll_tv = &v->di_tv;
2533 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2535 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2536 && !(lp->ll_tv->v_type == VAR_DICT
2537 && lp->ll_tv->vval.v_dict != NULL))
2539 if (!quiet)
2540 EMSG(_("E689: Can only index a List or Dictionary"));
2541 return NULL;
2543 if (lp->ll_range)
2545 if (!quiet)
2546 EMSG(_("E708: [:] must come last"));
2547 return NULL;
2550 len = -1;
2551 if (*p == '.')
2553 key = p + 1;
2554 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2556 if (len == 0)
2558 if (!quiet)
2559 EMSG(_(e_emptykey));
2560 return NULL;
2562 p = key + len;
2564 else
2566 /* Get the index [expr] or the first index [expr: ]. */
2567 p = skipwhite(p + 1);
2568 if (*p == ':')
2569 empty1 = TRUE;
2570 else
2572 empty1 = FALSE;
2573 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2574 return NULL;
2575 if (get_tv_string_chk(&var1) == NULL)
2577 /* not a number or string */
2578 clear_tv(&var1);
2579 return NULL;
2583 /* Optionally get the second index [ :expr]. */
2584 if (*p == ':')
2586 if (lp->ll_tv->v_type == VAR_DICT)
2588 if (!quiet)
2589 EMSG(_(e_dictrange));
2590 if (!empty1)
2591 clear_tv(&var1);
2592 return NULL;
2594 if (rettv != NULL && (rettv->v_type != VAR_LIST
2595 || rettv->vval.v_list == NULL))
2597 if (!quiet)
2598 EMSG(_("E709: [:] requires a List value"));
2599 if (!empty1)
2600 clear_tv(&var1);
2601 return NULL;
2603 p = skipwhite(p + 1);
2604 if (*p == ']')
2605 lp->ll_empty2 = TRUE;
2606 else
2608 lp->ll_empty2 = FALSE;
2609 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2611 if (!empty1)
2612 clear_tv(&var1);
2613 return NULL;
2615 if (get_tv_string_chk(&var2) == NULL)
2617 /* not a number or string */
2618 if (!empty1)
2619 clear_tv(&var1);
2620 clear_tv(&var2);
2621 return NULL;
2624 lp->ll_range = TRUE;
2626 else
2627 lp->ll_range = FALSE;
2629 if (*p != ']')
2631 if (!quiet)
2632 EMSG(_(e_missbrac));
2633 if (!empty1)
2634 clear_tv(&var1);
2635 if (lp->ll_range && !lp->ll_empty2)
2636 clear_tv(&var2);
2637 return NULL;
2640 /* Skip to past ']'. */
2641 ++p;
2644 if (lp->ll_tv->v_type == VAR_DICT)
2646 if (len == -1)
2648 /* "[key]": get key from "var1" */
2649 key = get_tv_string(&var1); /* is number or string */
2650 if (*key == NUL)
2652 if (!quiet)
2653 EMSG(_(e_emptykey));
2654 clear_tv(&var1);
2655 return NULL;
2658 lp->ll_list = NULL;
2659 lp->ll_dict = lp->ll_tv->vval.v_dict;
2660 lp->ll_di = dict_find(lp->ll_dict, key, len);
2661 if (lp->ll_di == NULL)
2663 /* Key does not exist in dict: may need to add it. */
2664 if (*p == '[' || *p == '.' || unlet)
2666 if (!quiet)
2667 EMSG2(_(e_dictkey), key);
2668 if (len == -1)
2669 clear_tv(&var1);
2670 return NULL;
2672 if (len == -1)
2673 lp->ll_newkey = vim_strsave(key);
2674 else
2675 lp->ll_newkey = vim_strnsave(key, len);
2676 if (len == -1)
2677 clear_tv(&var1);
2678 if (lp->ll_newkey == NULL)
2679 p = NULL;
2680 break;
2682 if (len == -1)
2683 clear_tv(&var1);
2684 lp->ll_tv = &lp->ll_di->di_tv;
2686 else
2689 * Get the number and item for the only or first index of the List.
2691 if (empty1)
2692 lp->ll_n1 = 0;
2693 else
2695 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2696 clear_tv(&var1);
2698 lp->ll_dict = NULL;
2699 lp->ll_list = lp->ll_tv->vval.v_list;
2700 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2701 if (lp->ll_li == NULL)
2703 if (lp->ll_n1 < 0)
2705 lp->ll_n1 = 0;
2706 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2709 if (lp->ll_li == NULL)
2711 if (lp->ll_range && !lp->ll_empty2)
2712 clear_tv(&var2);
2713 return NULL;
2717 * May need to find the item or absolute index for the second
2718 * index of a range.
2719 * When no index given: "lp->ll_empty2" is TRUE.
2720 * Otherwise "lp->ll_n2" is set to the second index.
2722 if (lp->ll_range && !lp->ll_empty2)
2724 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2725 clear_tv(&var2);
2726 if (lp->ll_n2 < 0)
2728 ni = list_find(lp->ll_list, lp->ll_n2);
2729 if (ni == NULL)
2730 return NULL;
2731 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2734 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2735 if (lp->ll_n1 < 0)
2736 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2737 if (lp->ll_n2 < lp->ll_n1)
2738 return NULL;
2741 lp->ll_tv = &lp->ll_li->li_tv;
2745 return p;
2749 * Clear lval "lp" that was filled by get_lval().
2751 static void
2752 clear_lval(lp)
2753 lval_T *lp;
2755 vim_free(lp->ll_exp_name);
2756 vim_free(lp->ll_newkey);
2760 * Set a variable that was parsed by get_lval() to "rettv".
2761 * "endp" points to just after the parsed name.
2762 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2764 static void
2765 set_var_lval(lp, endp, rettv, copy, op)
2766 lval_T *lp;
2767 char_u *endp;
2768 typval_T *rettv;
2769 int copy;
2770 char_u *op;
2772 int cc;
2773 listitem_T *ri;
2774 dictitem_T *di;
2776 if (lp->ll_tv == NULL)
2778 if (!check_changedtick(lp->ll_name))
2780 cc = *endp;
2781 *endp = NUL;
2782 if (op != NULL && *op != '=')
2784 typval_T tv;
2786 /* handle +=, -= and .= */
2787 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2788 &tv, TRUE) == OK)
2790 if (tv_op(&tv, rettv, op) == OK)
2791 set_var(lp->ll_name, &tv, FALSE);
2792 clear_tv(&tv);
2795 else
2796 set_var(lp->ll_name, rettv, copy);
2797 *endp = cc;
2800 else if (tv_check_lock(lp->ll_newkey == NULL
2801 ? lp->ll_tv->v_lock
2802 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2804 else if (lp->ll_range)
2807 * Assign the List values to the list items.
2809 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2811 if (op != NULL && *op != '=')
2812 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2813 else
2815 clear_tv(&lp->ll_li->li_tv);
2816 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2818 ri = ri->li_next;
2819 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2820 break;
2821 if (lp->ll_li->li_next == NULL)
2823 /* Need to add an empty item. */
2824 if (list_append_number(lp->ll_list, 0) == FAIL)
2826 ri = NULL;
2827 break;
2830 lp->ll_li = lp->ll_li->li_next;
2831 ++lp->ll_n1;
2833 if (ri != NULL)
2834 EMSG(_("E710: List value has more items than target"));
2835 else if (lp->ll_empty2
2836 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2837 : lp->ll_n1 != lp->ll_n2)
2838 EMSG(_("E711: List value has not enough items"));
2840 else
2843 * Assign to a List or Dictionary item.
2845 if (lp->ll_newkey != NULL)
2847 if (op != NULL && *op != '=')
2849 EMSG2(_(e_letwrong), op);
2850 return;
2853 /* Need to add an item to the Dictionary. */
2854 di = dictitem_alloc(lp->ll_newkey);
2855 if (di == NULL)
2856 return;
2857 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2859 vim_free(di);
2860 return;
2862 lp->ll_tv = &di->di_tv;
2864 else if (op != NULL && *op != '=')
2866 tv_op(lp->ll_tv, rettv, op);
2867 return;
2869 else
2870 clear_tv(lp->ll_tv);
2873 * Assign the value to the variable or list item.
2875 if (copy)
2876 copy_tv(rettv, lp->ll_tv);
2877 else
2879 *lp->ll_tv = *rettv;
2880 lp->ll_tv->v_lock = 0;
2881 init_tv(rettv);
2887 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2888 * Returns OK or FAIL.
2890 static int
2891 tv_op(tv1, tv2, op)
2892 typval_T *tv1;
2893 typval_T *tv2;
2894 char_u *op;
2896 long n;
2897 char_u numbuf[NUMBUFLEN];
2898 char_u *s;
2900 /* Can't do anything with a Funcref or a Dict on the right. */
2901 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2903 switch (tv1->v_type)
2905 case VAR_DICT:
2906 case VAR_FUNC:
2907 break;
2909 case VAR_LIST:
2910 if (*op != '+' || tv2->v_type != VAR_LIST)
2911 break;
2912 /* List += List */
2913 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2914 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2915 return OK;
2917 case VAR_NUMBER:
2918 case VAR_STRING:
2919 if (tv2->v_type == VAR_LIST)
2920 break;
2921 if (*op == '+' || *op == '-')
2923 /* nr += nr or nr -= nr*/
2924 n = get_tv_number(tv1);
2925 #ifdef FEAT_FLOAT
2926 if (tv2->v_type == VAR_FLOAT)
2928 float_T f = n;
2930 if (*op == '+')
2931 f += tv2->vval.v_float;
2932 else
2933 f -= tv2->vval.v_float;
2934 clear_tv(tv1);
2935 tv1->v_type = VAR_FLOAT;
2936 tv1->vval.v_float = f;
2938 else
2939 #endif
2941 if (*op == '+')
2942 n += get_tv_number(tv2);
2943 else
2944 n -= get_tv_number(tv2);
2945 clear_tv(tv1);
2946 tv1->v_type = VAR_NUMBER;
2947 tv1->vval.v_number = n;
2950 else
2952 if (tv2->v_type == VAR_FLOAT)
2953 break;
2955 /* str .= str */
2956 s = get_tv_string(tv1);
2957 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2958 clear_tv(tv1);
2959 tv1->v_type = VAR_STRING;
2960 tv1->vval.v_string = s;
2962 return OK;
2964 #ifdef FEAT_FLOAT
2965 case VAR_FLOAT:
2967 float_T f;
2969 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2970 && tv2->v_type != VAR_NUMBER
2971 && tv2->v_type != VAR_STRING))
2972 break;
2973 if (tv2->v_type == VAR_FLOAT)
2974 f = tv2->vval.v_float;
2975 else
2976 f = get_tv_number(tv2);
2977 if (*op == '+')
2978 tv1->vval.v_float += f;
2979 else
2980 tv1->vval.v_float -= f;
2982 return OK;
2983 #endif
2987 EMSG2(_(e_letwrong), op);
2988 return FAIL;
2992 * Add a watcher to a list.
2994 static void
2995 list_add_watch(l, lw)
2996 list_T *l;
2997 listwatch_T *lw;
2999 lw->lw_next = l->lv_watch;
3000 l->lv_watch = lw;
3004 * Remove a watcher from a list.
3005 * No warning when it isn't found...
3007 static void
3008 list_rem_watch(l, lwrem)
3009 list_T *l;
3010 listwatch_T *lwrem;
3012 listwatch_T *lw, **lwp;
3014 lwp = &l->lv_watch;
3015 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3017 if (lw == lwrem)
3019 *lwp = lw->lw_next;
3020 break;
3022 lwp = &lw->lw_next;
3027 * Just before removing an item from a list: advance watchers to the next
3028 * item.
3030 static void
3031 list_fix_watch(l, item)
3032 list_T *l;
3033 listitem_T *item;
3035 listwatch_T *lw;
3037 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3038 if (lw->lw_item == item)
3039 lw->lw_item = item->li_next;
3043 * Evaluate the expression used in a ":for var in expr" command.
3044 * "arg" points to "var".
3045 * Set "*errp" to TRUE for an error, FALSE otherwise;
3046 * Return a pointer that holds the info. Null when there is an error.
3048 void *
3049 eval_for_line(arg, errp, nextcmdp, skip)
3050 char_u *arg;
3051 int *errp;
3052 char_u **nextcmdp;
3053 int skip;
3055 forinfo_T *fi;
3056 char_u *expr;
3057 typval_T tv;
3058 list_T *l;
3060 *errp = TRUE; /* default: there is an error */
3062 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3063 if (fi == NULL)
3064 return NULL;
3066 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3067 if (expr == NULL)
3068 return fi;
3070 expr = skipwhite(expr);
3071 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3073 EMSG(_("E690: Missing \"in\" after :for"));
3074 return fi;
3077 if (skip)
3078 ++emsg_skip;
3079 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3081 *errp = FALSE;
3082 if (!skip)
3084 l = tv.vval.v_list;
3085 if (tv.v_type != VAR_LIST || l == NULL)
3087 EMSG(_(e_listreq));
3088 clear_tv(&tv);
3090 else
3092 /* No need to increment the refcount, it's already set for the
3093 * list being used in "tv". */
3094 fi->fi_list = l;
3095 list_add_watch(l, &fi->fi_lw);
3096 fi->fi_lw.lw_item = l->lv_first;
3100 if (skip)
3101 --emsg_skip;
3103 return fi;
3107 * Use the first item in a ":for" list. Advance to the next.
3108 * Assign the values to the variable (list). "arg" points to the first one.
3109 * Return TRUE when a valid item was found, FALSE when at end of list or
3110 * something wrong.
3113 next_for_item(fi_void, arg)
3114 void *fi_void;
3115 char_u *arg;
3117 forinfo_T *fi = (forinfo_T *)fi_void;
3118 int result;
3119 listitem_T *item;
3121 item = fi->fi_lw.lw_item;
3122 if (item == NULL)
3123 result = FALSE;
3124 else
3126 fi->fi_lw.lw_item = item->li_next;
3127 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3128 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3130 return result;
3134 * Free the structure used to store info used by ":for".
3136 void
3137 free_for_info(fi_void)
3138 void *fi_void;
3140 forinfo_T *fi = (forinfo_T *)fi_void;
3142 if (fi != NULL && fi->fi_list != NULL)
3144 list_rem_watch(fi->fi_list, &fi->fi_lw);
3145 list_unref(fi->fi_list);
3147 vim_free(fi);
3150 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3152 void
3153 set_context_for_expression(xp, arg, cmdidx)
3154 expand_T *xp;
3155 char_u *arg;
3156 cmdidx_T cmdidx;
3158 int got_eq = FALSE;
3159 int c;
3160 char_u *p;
3162 if (cmdidx == CMD_let)
3164 xp->xp_context = EXPAND_USER_VARS;
3165 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3167 /* ":let var1 var2 ...": find last space. */
3168 for (p = arg + STRLEN(arg); p >= arg; )
3170 xp->xp_pattern = p;
3171 mb_ptr_back(arg, p);
3172 if (vim_iswhite(*p))
3173 break;
3175 return;
3178 else
3179 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3180 : EXPAND_EXPRESSION;
3181 while ((xp->xp_pattern = vim_strpbrk(arg,
3182 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3184 c = *xp->xp_pattern;
3185 if (c == '&')
3187 c = xp->xp_pattern[1];
3188 if (c == '&')
3190 ++xp->xp_pattern;
3191 xp->xp_context = cmdidx != CMD_let || got_eq
3192 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3194 else if (c != ' ')
3196 xp->xp_context = EXPAND_SETTINGS;
3197 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3198 xp->xp_pattern += 2;
3202 else if (c == '$')
3204 /* environment variable */
3205 xp->xp_context = EXPAND_ENV_VARS;
3207 else if (c == '=')
3209 got_eq = TRUE;
3210 xp->xp_context = EXPAND_EXPRESSION;
3212 else if (c == '<'
3213 && xp->xp_context == EXPAND_FUNCTIONS
3214 && vim_strchr(xp->xp_pattern, '(') == NULL)
3216 /* Function name can start with "<SNR>" */
3217 break;
3219 else if (cmdidx != CMD_let || got_eq)
3221 if (c == '"') /* string */
3223 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3224 if (c == '\\' && xp->xp_pattern[1] != NUL)
3225 ++xp->xp_pattern;
3226 xp->xp_context = EXPAND_NOTHING;
3228 else if (c == '\'') /* literal string */
3230 /* Trick: '' is like stopping and starting a literal string. */
3231 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3232 /* skip */ ;
3233 xp->xp_context = EXPAND_NOTHING;
3235 else if (c == '|')
3237 if (xp->xp_pattern[1] == '|')
3239 ++xp->xp_pattern;
3240 xp->xp_context = EXPAND_EXPRESSION;
3242 else
3243 xp->xp_context = EXPAND_COMMANDS;
3245 else
3246 xp->xp_context = EXPAND_EXPRESSION;
3248 else
3249 /* Doesn't look like something valid, expand as an expression
3250 * anyway. */
3251 xp->xp_context = EXPAND_EXPRESSION;
3252 arg = xp->xp_pattern;
3253 if (*arg != NUL)
3254 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3255 /* skip */ ;
3257 xp->xp_pattern = arg;
3260 #endif /* FEAT_CMDL_COMPL */
3263 * ":1,25call func(arg1, arg2)" function call.
3265 void
3266 ex_call(eap)
3267 exarg_T *eap;
3269 char_u *arg = eap->arg;
3270 char_u *startarg;
3271 char_u *name;
3272 char_u *tofree;
3273 int len;
3274 typval_T rettv;
3275 linenr_T lnum;
3276 int doesrange;
3277 int failed = FALSE;
3278 funcdict_T fudi;
3280 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3281 if (fudi.fd_newkey != NULL)
3283 /* Still need to give an error message for missing key. */
3284 EMSG2(_(e_dictkey), fudi.fd_newkey);
3285 vim_free(fudi.fd_newkey);
3287 if (tofree == NULL)
3288 return;
3290 /* Increase refcount on dictionary, it could get deleted when evaluating
3291 * the arguments. */
3292 if (fudi.fd_dict != NULL)
3293 ++fudi.fd_dict->dv_refcount;
3295 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3296 len = (int)STRLEN(tofree);
3297 name = deref_func_name(tofree, &len);
3299 /* Skip white space to allow ":call func ()". Not good, but required for
3300 * backward compatibility. */
3301 startarg = skipwhite(arg);
3302 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3304 if (*startarg != '(')
3306 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3307 goto end;
3311 * When skipping, evaluate the function once, to find the end of the
3312 * arguments.
3313 * When the function takes a range, this is discovered after the first
3314 * call, and the loop is broken.
3316 if (eap->skip)
3318 ++emsg_skip;
3319 lnum = eap->line2; /* do it once, also with an invalid range */
3321 else
3322 lnum = eap->line1;
3323 for ( ; lnum <= eap->line2; ++lnum)
3325 if (!eap->skip && eap->addr_count > 0)
3327 curwin->w_cursor.lnum = lnum;
3328 curwin->w_cursor.col = 0;
3330 arg = startarg;
3331 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3332 eap->line1, eap->line2, &doesrange,
3333 !eap->skip, fudi.fd_dict) == FAIL)
3335 failed = TRUE;
3336 break;
3339 /* Handle a function returning a Funcref, Dictionary or List. */
3340 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3342 failed = TRUE;
3343 break;
3346 clear_tv(&rettv);
3347 if (doesrange || eap->skip)
3348 break;
3350 /* Stop when immediately aborting on error, or when an interrupt
3351 * occurred or an exception was thrown but not caught.
3352 * get_func_tv() returned OK, so that the check for trailing
3353 * characters below is executed. */
3354 if (aborting())
3355 break;
3357 if (eap->skip)
3358 --emsg_skip;
3360 if (!failed)
3362 /* Check for trailing illegal characters and a following command. */
3363 if (!ends_excmd(*arg))
3365 emsg_severe = TRUE;
3366 EMSG(_(e_trailing));
3368 else
3369 eap->nextcmd = check_nextcmd(arg);
3372 end:
3373 dict_unref(fudi.fd_dict);
3374 vim_free(tofree);
3378 * ":unlet[!] var1 ... " command.
3380 void
3381 ex_unlet(eap)
3382 exarg_T *eap;
3384 ex_unletlock(eap, eap->arg, 0);
3388 * ":lockvar" and ":unlockvar" commands
3390 void
3391 ex_lockvar(eap)
3392 exarg_T *eap;
3394 char_u *arg = eap->arg;
3395 int deep = 2;
3397 if (eap->forceit)
3398 deep = -1;
3399 else if (vim_isdigit(*arg))
3401 deep = getdigits(&arg);
3402 arg = skipwhite(arg);
3405 ex_unletlock(eap, arg, deep);
3409 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3411 static void
3412 ex_unletlock(eap, argstart, deep)
3413 exarg_T *eap;
3414 char_u *argstart;
3415 int deep;
3417 char_u *arg = argstart;
3418 char_u *name_end;
3419 int error = FALSE;
3420 lval_T lv;
3424 /* Parse the name and find the end. */
3425 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3426 FNE_CHECK_START);
3427 if (lv.ll_name == NULL)
3428 error = TRUE; /* error but continue parsing */
3429 if (name_end == NULL || (!vim_iswhite(*name_end)
3430 && !ends_excmd(*name_end)))
3432 if (name_end != NULL)
3434 emsg_severe = TRUE;
3435 EMSG(_(e_trailing));
3437 if (!(eap->skip || error))
3438 clear_lval(&lv);
3439 break;
3442 if (!error && !eap->skip)
3444 if (eap->cmdidx == CMD_unlet)
3446 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3447 error = TRUE;
3449 else
3451 if (do_lock_var(&lv, name_end, deep,
3452 eap->cmdidx == CMD_lockvar) == FAIL)
3453 error = TRUE;
3457 if (!eap->skip)
3458 clear_lval(&lv);
3460 arg = skipwhite(name_end);
3461 } while (!ends_excmd(*arg));
3463 eap->nextcmd = check_nextcmd(arg);
3466 static int
3467 do_unlet_var(lp, name_end, forceit)
3468 lval_T *lp;
3469 char_u *name_end;
3470 int forceit;
3472 int ret = OK;
3473 int cc;
3475 if (lp->ll_tv == NULL)
3477 cc = *name_end;
3478 *name_end = NUL;
3480 /* Normal name or expanded name. */
3481 if (check_changedtick(lp->ll_name))
3482 ret = FAIL;
3483 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3484 ret = FAIL;
3485 *name_end = cc;
3487 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3488 return FAIL;
3489 else if (lp->ll_range)
3491 listitem_T *li;
3493 /* Delete a range of List items. */
3494 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3496 li = lp->ll_li->li_next;
3497 listitem_remove(lp->ll_list, lp->ll_li);
3498 lp->ll_li = li;
3499 ++lp->ll_n1;
3502 else
3504 if (lp->ll_list != NULL)
3505 /* unlet a List item. */
3506 listitem_remove(lp->ll_list, lp->ll_li);
3507 else
3508 /* unlet a Dictionary item. */
3509 dictitem_remove(lp->ll_dict, lp->ll_di);
3512 return ret;
3516 * "unlet" a variable. Return OK if it existed, FAIL if not.
3517 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3520 do_unlet(name, forceit)
3521 char_u *name;
3522 int forceit;
3524 hashtab_T *ht;
3525 hashitem_T *hi;
3526 char_u *varname;
3527 dictitem_T *di;
3529 ht = find_var_ht(name, &varname);
3530 if (ht != NULL && *varname != NUL)
3532 hi = hash_find(ht, varname);
3533 if (!HASHITEM_EMPTY(hi))
3535 di = HI2DI(hi);
3536 if (var_check_fixed(di->di_flags, name)
3537 || var_check_ro(di->di_flags, name))
3538 return FAIL;
3539 delete_var(ht, hi);
3540 return OK;
3543 if (forceit)
3544 return OK;
3545 EMSG2(_("E108: No such variable: \"%s\""), name);
3546 return FAIL;
3550 * Lock or unlock variable indicated by "lp".
3551 * "deep" is the levels to go (-1 for unlimited);
3552 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3554 static int
3555 do_lock_var(lp, name_end, deep, lock)
3556 lval_T *lp;
3557 char_u *name_end;
3558 int deep;
3559 int lock;
3561 int ret = OK;
3562 int cc;
3563 dictitem_T *di;
3565 if (deep == 0) /* nothing to do */
3566 return OK;
3568 if (lp->ll_tv == NULL)
3570 cc = *name_end;
3571 *name_end = NUL;
3573 /* Normal name or expanded name. */
3574 if (check_changedtick(lp->ll_name))
3575 ret = FAIL;
3576 else
3578 di = find_var(lp->ll_name, NULL);
3579 if (di == NULL)
3580 ret = FAIL;
3581 else
3583 if (lock)
3584 di->di_flags |= DI_FLAGS_LOCK;
3585 else
3586 di->di_flags &= ~DI_FLAGS_LOCK;
3587 item_lock(&di->di_tv, deep, lock);
3590 *name_end = cc;
3592 else if (lp->ll_range)
3594 listitem_T *li = lp->ll_li;
3596 /* (un)lock a range of List items. */
3597 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3599 item_lock(&li->li_tv, deep, lock);
3600 li = li->li_next;
3601 ++lp->ll_n1;
3604 else if (lp->ll_list != NULL)
3605 /* (un)lock a List item. */
3606 item_lock(&lp->ll_li->li_tv, deep, lock);
3607 else
3608 /* un(lock) a Dictionary item. */
3609 item_lock(&lp->ll_di->di_tv, deep, lock);
3611 return ret;
3615 * Lock or unlock an item. "deep" is nr of levels to go.
3617 static void
3618 item_lock(tv, deep, lock)
3619 typval_T *tv;
3620 int deep;
3621 int lock;
3623 static int recurse = 0;
3624 list_T *l;
3625 listitem_T *li;
3626 dict_T *d;
3627 hashitem_T *hi;
3628 int todo;
3630 if (recurse >= DICT_MAXNEST)
3632 EMSG(_("E743: variable nested too deep for (un)lock"));
3633 return;
3635 if (deep == 0)
3636 return;
3637 ++recurse;
3639 /* lock/unlock the item itself */
3640 if (lock)
3641 tv->v_lock |= VAR_LOCKED;
3642 else
3643 tv->v_lock &= ~VAR_LOCKED;
3645 switch (tv->v_type)
3647 case VAR_LIST:
3648 if ((l = tv->vval.v_list) != NULL)
3650 if (lock)
3651 l->lv_lock |= VAR_LOCKED;
3652 else
3653 l->lv_lock &= ~VAR_LOCKED;
3654 if (deep < 0 || deep > 1)
3655 /* recursive: lock/unlock the items the List contains */
3656 for (li = l->lv_first; li != NULL; li = li->li_next)
3657 item_lock(&li->li_tv, deep - 1, lock);
3659 break;
3660 case VAR_DICT:
3661 if ((d = tv->vval.v_dict) != NULL)
3663 if (lock)
3664 d->dv_lock |= VAR_LOCKED;
3665 else
3666 d->dv_lock &= ~VAR_LOCKED;
3667 if (deep < 0 || deep > 1)
3669 /* recursive: lock/unlock the items the List contains */
3670 todo = (int)d->dv_hashtab.ht_used;
3671 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3673 if (!HASHITEM_EMPTY(hi))
3675 --todo;
3676 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3682 --recurse;
3686 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3687 * or it refers to a List or Dictionary that is locked.
3689 static int
3690 tv_islocked(tv)
3691 typval_T *tv;
3693 return (tv->v_lock & VAR_LOCKED)
3694 || (tv->v_type == VAR_LIST
3695 && tv->vval.v_list != NULL
3696 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3697 || (tv->v_type == VAR_DICT
3698 && tv->vval.v_dict != NULL
3699 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3702 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3704 * Delete all "menutrans_" variables.
3706 void
3707 del_menutrans_vars()
3709 hashitem_T *hi;
3710 int todo;
3712 hash_lock(&globvarht);
3713 todo = (int)globvarht.ht_used;
3714 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3716 if (!HASHITEM_EMPTY(hi))
3718 --todo;
3719 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3720 delete_var(&globvarht, hi);
3723 hash_unlock(&globvarht);
3725 #endif
3727 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3730 * Local string buffer for the next two functions to store a variable name
3731 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3732 * get_user_var_name().
3735 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3737 static char_u *varnamebuf = NULL;
3738 static int varnamebuflen = 0;
3741 * Function to concatenate a prefix and a variable name.
3743 static char_u *
3744 cat_prefix_varname(prefix, name)
3745 int prefix;
3746 char_u *name;
3748 int len;
3750 len = (int)STRLEN(name) + 3;
3751 if (len > varnamebuflen)
3753 vim_free(varnamebuf);
3754 len += 10; /* some additional space */
3755 varnamebuf = alloc(len);
3756 if (varnamebuf == NULL)
3758 varnamebuflen = 0;
3759 return NULL;
3761 varnamebuflen = len;
3763 *varnamebuf = prefix;
3764 varnamebuf[1] = ':';
3765 STRCPY(varnamebuf + 2, name);
3766 return varnamebuf;
3770 * Function given to ExpandGeneric() to obtain the list of user defined
3771 * (global/buffer/window/built-in) variable names.
3773 /*ARGSUSED*/
3774 char_u *
3775 get_user_var_name(xp, idx)
3776 expand_T *xp;
3777 int idx;
3779 static long_u gdone;
3780 static long_u bdone;
3781 static long_u wdone;
3782 #ifdef FEAT_WINDOWS
3783 static long_u tdone;
3784 #endif
3785 static int vidx;
3786 static hashitem_T *hi;
3787 hashtab_T *ht;
3789 if (idx == 0)
3791 gdone = bdone = wdone = vidx = 0;
3792 #ifdef FEAT_WINDOWS
3793 tdone = 0;
3794 #endif
3797 /* Global variables */
3798 if (gdone < globvarht.ht_used)
3800 if (gdone++ == 0)
3801 hi = globvarht.ht_array;
3802 else
3803 ++hi;
3804 while (HASHITEM_EMPTY(hi))
3805 ++hi;
3806 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3807 return cat_prefix_varname('g', hi->hi_key);
3808 return hi->hi_key;
3811 /* b: variables */
3812 ht = &curbuf->b_vars.dv_hashtab;
3813 if (bdone < ht->ht_used)
3815 if (bdone++ == 0)
3816 hi = ht->ht_array;
3817 else
3818 ++hi;
3819 while (HASHITEM_EMPTY(hi))
3820 ++hi;
3821 return cat_prefix_varname('b', hi->hi_key);
3823 if (bdone == ht->ht_used)
3825 ++bdone;
3826 return (char_u *)"b:changedtick";
3829 /* w: variables */
3830 ht = &curwin->w_vars.dv_hashtab;
3831 if (wdone < ht->ht_used)
3833 if (wdone++ == 0)
3834 hi = ht->ht_array;
3835 else
3836 ++hi;
3837 while (HASHITEM_EMPTY(hi))
3838 ++hi;
3839 return cat_prefix_varname('w', hi->hi_key);
3842 #ifdef FEAT_WINDOWS
3843 /* t: variables */
3844 ht = &curtab->tp_vars.dv_hashtab;
3845 if (tdone < ht->ht_used)
3847 if (tdone++ == 0)
3848 hi = ht->ht_array;
3849 else
3850 ++hi;
3851 while (HASHITEM_EMPTY(hi))
3852 ++hi;
3853 return cat_prefix_varname('t', hi->hi_key);
3855 #endif
3857 /* v: variables */
3858 if (vidx < VV_LEN)
3859 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3861 vim_free(varnamebuf);
3862 varnamebuf = NULL;
3863 varnamebuflen = 0;
3864 return NULL;
3867 #endif /* FEAT_CMDL_COMPL */
3870 * types for expressions.
3872 typedef enum
3874 TYPE_UNKNOWN = 0
3875 , TYPE_EQUAL /* == */
3876 , TYPE_NEQUAL /* != */
3877 , TYPE_GREATER /* > */
3878 , TYPE_GEQUAL /* >= */
3879 , TYPE_SMALLER /* < */
3880 , TYPE_SEQUAL /* <= */
3881 , TYPE_MATCH /* =~ */
3882 , TYPE_NOMATCH /* !~ */
3883 } exptype_T;
3886 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3887 * executed. The function may return OK, but the rettv will be of type
3888 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3892 * Handle zero level expression.
3893 * This calls eval1() and handles error message and nextcmd.
3894 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3895 * Note: "rettv.v_lock" is not set.
3896 * Return OK or FAIL.
3898 static int
3899 eval0(arg, rettv, nextcmd, evaluate)
3900 char_u *arg;
3901 typval_T *rettv;
3902 char_u **nextcmd;
3903 int evaluate;
3905 int ret;
3906 char_u *p;
3908 p = skipwhite(arg);
3909 ret = eval1(&p, rettv, evaluate);
3910 if (ret == FAIL || !ends_excmd(*p))
3912 if (ret != FAIL)
3913 clear_tv(rettv);
3915 * Report the invalid expression unless the expression evaluation has
3916 * been cancelled due to an aborting error, an interrupt, or an
3917 * exception.
3919 if (!aborting())
3920 EMSG2(_(e_invexpr2), arg);
3921 ret = FAIL;
3923 if (nextcmd != NULL)
3924 *nextcmd = check_nextcmd(p);
3926 return ret;
3930 * Handle top level expression:
3931 * expr1 ? expr0 : expr0
3933 * "arg" must point to the first non-white of the expression.
3934 * "arg" is advanced to the next non-white after the recognized expression.
3936 * Note: "rettv.v_lock" is not set.
3938 * Return OK or FAIL.
3940 static int
3941 eval1(arg, rettv, evaluate)
3942 char_u **arg;
3943 typval_T *rettv;
3944 int evaluate;
3946 int result;
3947 typval_T var2;
3950 * Get the first variable.
3952 if (eval2(arg, rettv, evaluate) == FAIL)
3953 return FAIL;
3955 if ((*arg)[0] == '?')
3957 result = FALSE;
3958 if (evaluate)
3960 int error = FALSE;
3962 if (get_tv_number_chk(rettv, &error) != 0)
3963 result = TRUE;
3964 clear_tv(rettv);
3965 if (error)
3966 return FAIL;
3970 * Get the second variable.
3972 *arg = skipwhite(*arg + 1);
3973 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3974 return FAIL;
3977 * Check for the ":".
3979 if ((*arg)[0] != ':')
3981 EMSG(_("E109: Missing ':' after '?'"));
3982 if (evaluate && result)
3983 clear_tv(rettv);
3984 return FAIL;
3988 * Get the third variable.
3990 *arg = skipwhite(*arg + 1);
3991 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
3993 if (evaluate && result)
3994 clear_tv(rettv);
3995 return FAIL;
3997 if (evaluate && !result)
3998 *rettv = var2;
4001 return OK;
4005 * Handle first level expression:
4006 * expr2 || expr2 || expr2 logical OR
4008 * "arg" must point to the first non-white of the expression.
4009 * "arg" is advanced to the next non-white after the recognized expression.
4011 * Return OK or FAIL.
4013 static int
4014 eval2(arg, rettv, evaluate)
4015 char_u **arg;
4016 typval_T *rettv;
4017 int evaluate;
4019 typval_T var2;
4020 long result;
4021 int first;
4022 int error = FALSE;
4025 * Get the first variable.
4027 if (eval3(arg, rettv, evaluate) == FAIL)
4028 return FAIL;
4031 * Repeat until there is no following "||".
4033 first = TRUE;
4034 result = FALSE;
4035 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4037 if (evaluate && first)
4039 if (get_tv_number_chk(rettv, &error) != 0)
4040 result = TRUE;
4041 clear_tv(rettv);
4042 if (error)
4043 return FAIL;
4044 first = FALSE;
4048 * Get the second variable.
4050 *arg = skipwhite(*arg + 2);
4051 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4052 return FAIL;
4055 * Compute the result.
4057 if (evaluate && !result)
4059 if (get_tv_number_chk(&var2, &error) != 0)
4060 result = TRUE;
4061 clear_tv(&var2);
4062 if (error)
4063 return FAIL;
4065 if (evaluate)
4067 rettv->v_type = VAR_NUMBER;
4068 rettv->vval.v_number = result;
4072 return OK;
4076 * Handle second level expression:
4077 * expr3 && expr3 && expr3 logical AND
4079 * "arg" must point to the first non-white of the expression.
4080 * "arg" is advanced to the next non-white after the recognized expression.
4082 * Return OK or FAIL.
4084 static int
4085 eval3(arg, rettv, evaluate)
4086 char_u **arg;
4087 typval_T *rettv;
4088 int evaluate;
4090 typval_T var2;
4091 long result;
4092 int first;
4093 int error = FALSE;
4096 * Get the first variable.
4098 if (eval4(arg, rettv, evaluate) == FAIL)
4099 return FAIL;
4102 * Repeat until there is no following "&&".
4104 first = TRUE;
4105 result = TRUE;
4106 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4108 if (evaluate && first)
4110 if (get_tv_number_chk(rettv, &error) == 0)
4111 result = FALSE;
4112 clear_tv(rettv);
4113 if (error)
4114 return FAIL;
4115 first = FALSE;
4119 * Get the second variable.
4121 *arg = skipwhite(*arg + 2);
4122 if (eval4(arg, &var2, evaluate && result) == FAIL)
4123 return FAIL;
4126 * Compute the result.
4128 if (evaluate && result)
4130 if (get_tv_number_chk(&var2, &error) == 0)
4131 result = FALSE;
4132 clear_tv(&var2);
4133 if (error)
4134 return FAIL;
4136 if (evaluate)
4138 rettv->v_type = VAR_NUMBER;
4139 rettv->vval.v_number = result;
4143 return OK;
4147 * Handle third level expression:
4148 * var1 == var2
4149 * var1 =~ var2
4150 * var1 != var2
4151 * var1 !~ var2
4152 * var1 > var2
4153 * var1 >= var2
4154 * var1 < var2
4155 * var1 <= var2
4156 * var1 is var2
4157 * var1 isnot var2
4159 * "arg" must point to the first non-white of the expression.
4160 * "arg" is advanced to the next non-white after the recognized expression.
4162 * Return OK or FAIL.
4164 static int
4165 eval4(arg, rettv, evaluate)
4166 char_u **arg;
4167 typval_T *rettv;
4168 int evaluate;
4170 typval_T var2;
4171 char_u *p;
4172 int i;
4173 exptype_T type = TYPE_UNKNOWN;
4174 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4175 int len = 2;
4176 long n1, n2;
4177 char_u *s1, *s2;
4178 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4179 regmatch_T regmatch;
4180 int ic;
4181 char_u *save_cpo;
4184 * Get the first variable.
4186 if (eval5(arg, rettv, evaluate) == FAIL)
4187 return FAIL;
4189 p = *arg;
4190 switch (p[0])
4192 case '=': if (p[1] == '=')
4193 type = TYPE_EQUAL;
4194 else if (p[1] == '~')
4195 type = TYPE_MATCH;
4196 break;
4197 case '!': if (p[1] == '=')
4198 type = TYPE_NEQUAL;
4199 else if (p[1] == '~')
4200 type = TYPE_NOMATCH;
4201 break;
4202 case '>': if (p[1] != '=')
4204 type = TYPE_GREATER;
4205 len = 1;
4207 else
4208 type = TYPE_GEQUAL;
4209 break;
4210 case '<': if (p[1] != '=')
4212 type = TYPE_SMALLER;
4213 len = 1;
4215 else
4216 type = TYPE_SEQUAL;
4217 break;
4218 case 'i': if (p[1] == 's')
4220 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4221 len = 5;
4222 if (!vim_isIDc(p[len]))
4224 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4225 type_is = TRUE;
4228 break;
4232 * If there is a comparative operator, use it.
4234 if (type != TYPE_UNKNOWN)
4236 /* extra question mark appended: ignore case */
4237 if (p[len] == '?')
4239 ic = TRUE;
4240 ++len;
4242 /* extra '#' appended: match case */
4243 else if (p[len] == '#')
4245 ic = FALSE;
4246 ++len;
4248 /* nothing appended: use 'ignorecase' */
4249 else
4250 ic = p_ic;
4253 * Get the second variable.
4255 *arg = skipwhite(p + len);
4256 if (eval5(arg, &var2, evaluate) == FAIL)
4258 clear_tv(rettv);
4259 return FAIL;
4262 if (evaluate)
4264 if (type_is && rettv->v_type != var2.v_type)
4266 /* For "is" a different type always means FALSE, for "notis"
4267 * it means TRUE. */
4268 n1 = (type == TYPE_NEQUAL);
4270 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4272 if (type_is)
4274 n1 = (rettv->v_type == var2.v_type
4275 && rettv->vval.v_list == var2.vval.v_list);
4276 if (type == TYPE_NEQUAL)
4277 n1 = !n1;
4279 else if (rettv->v_type != var2.v_type
4280 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4282 if (rettv->v_type != var2.v_type)
4283 EMSG(_("E691: Can only compare List with List"));
4284 else
4285 EMSG(_("E692: Invalid operation for Lists"));
4286 clear_tv(rettv);
4287 clear_tv(&var2);
4288 return FAIL;
4290 else
4292 /* Compare two Lists for being equal or unequal. */
4293 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4294 if (type == TYPE_NEQUAL)
4295 n1 = !n1;
4299 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4301 if (type_is)
4303 n1 = (rettv->v_type == var2.v_type
4304 && rettv->vval.v_dict == var2.vval.v_dict);
4305 if (type == TYPE_NEQUAL)
4306 n1 = !n1;
4308 else if (rettv->v_type != var2.v_type
4309 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4311 if (rettv->v_type != var2.v_type)
4312 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4313 else
4314 EMSG(_("E736: Invalid operation for Dictionary"));
4315 clear_tv(rettv);
4316 clear_tv(&var2);
4317 return FAIL;
4319 else
4321 /* Compare two Dictionaries for being equal or unequal. */
4322 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4323 if (type == TYPE_NEQUAL)
4324 n1 = !n1;
4328 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4330 if (rettv->v_type != var2.v_type
4331 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4333 if (rettv->v_type != var2.v_type)
4334 EMSG(_("E693: Can only compare Funcref with Funcref"));
4335 else
4336 EMSG(_("E694: Invalid operation for Funcrefs"));
4337 clear_tv(rettv);
4338 clear_tv(&var2);
4339 return FAIL;
4341 else
4343 /* Compare two Funcrefs for being equal or unequal. */
4344 if (rettv->vval.v_string == NULL
4345 || var2.vval.v_string == NULL)
4346 n1 = FALSE;
4347 else
4348 n1 = STRCMP(rettv->vval.v_string,
4349 var2.vval.v_string) == 0;
4350 if (type == TYPE_NEQUAL)
4351 n1 = !n1;
4355 #ifdef FEAT_FLOAT
4357 * If one of the two variables is a float, compare as a float.
4358 * When using "=~" or "!~", always compare as string.
4360 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4361 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4363 float_T f1, f2;
4365 if (rettv->v_type == VAR_FLOAT)
4366 f1 = rettv->vval.v_float;
4367 else
4368 f1 = get_tv_number(rettv);
4369 if (var2.v_type == VAR_FLOAT)
4370 f2 = var2.vval.v_float;
4371 else
4372 f2 = get_tv_number(&var2);
4373 n1 = FALSE;
4374 switch (type)
4376 case TYPE_EQUAL: n1 = (f1 == f2); break;
4377 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4378 case TYPE_GREATER: n1 = (f1 > f2); break;
4379 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4380 case TYPE_SMALLER: n1 = (f1 < f2); break;
4381 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4382 case TYPE_UNKNOWN:
4383 case TYPE_MATCH:
4384 case TYPE_NOMATCH: break; /* avoid gcc warning */
4387 #endif
4390 * If one of the two variables is a number, compare as a number.
4391 * When using "=~" or "!~", always compare as string.
4393 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4394 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4396 n1 = get_tv_number(rettv);
4397 n2 = get_tv_number(&var2);
4398 switch (type)
4400 case TYPE_EQUAL: n1 = (n1 == n2); break;
4401 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4402 case TYPE_GREATER: n1 = (n1 > n2); break;
4403 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4404 case TYPE_SMALLER: n1 = (n1 < n2); break;
4405 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4406 case TYPE_UNKNOWN:
4407 case TYPE_MATCH:
4408 case TYPE_NOMATCH: break; /* avoid gcc warning */
4411 else
4413 s1 = get_tv_string_buf(rettv, buf1);
4414 s2 = get_tv_string_buf(&var2, buf2);
4415 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4416 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4417 else
4418 i = 0;
4419 n1 = FALSE;
4420 switch (type)
4422 case TYPE_EQUAL: n1 = (i == 0); break;
4423 case TYPE_NEQUAL: n1 = (i != 0); break;
4424 case TYPE_GREATER: n1 = (i > 0); break;
4425 case TYPE_GEQUAL: n1 = (i >= 0); break;
4426 case TYPE_SMALLER: n1 = (i < 0); break;
4427 case TYPE_SEQUAL: n1 = (i <= 0); break;
4429 case TYPE_MATCH:
4430 case TYPE_NOMATCH:
4431 /* avoid 'l' flag in 'cpoptions' */
4432 save_cpo = p_cpo;
4433 p_cpo = (char_u *)"";
4434 regmatch.regprog = vim_regcomp(s2,
4435 RE_MAGIC + RE_STRING);
4436 regmatch.rm_ic = ic;
4437 if (regmatch.regprog != NULL)
4439 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4440 vim_free(regmatch.regprog);
4441 if (type == TYPE_NOMATCH)
4442 n1 = !n1;
4444 p_cpo = save_cpo;
4445 break;
4447 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4450 clear_tv(rettv);
4451 clear_tv(&var2);
4452 rettv->v_type = VAR_NUMBER;
4453 rettv->vval.v_number = n1;
4457 return OK;
4461 * Handle fourth level expression:
4462 * + number addition
4463 * - number subtraction
4464 * . string concatenation
4466 * "arg" must point to the first non-white of the expression.
4467 * "arg" is advanced to the next non-white after the recognized expression.
4469 * Return OK or FAIL.
4471 static int
4472 eval5(arg, rettv, evaluate)
4473 char_u **arg;
4474 typval_T *rettv;
4475 int evaluate;
4477 typval_T var2;
4478 typval_T var3;
4479 int op;
4480 long n1, n2;
4481 #ifdef FEAT_FLOAT
4482 float_T f1 = 0, f2 = 0;
4483 #endif
4484 char_u *s1, *s2;
4485 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4486 char_u *p;
4489 * Get the first variable.
4491 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4492 return FAIL;
4495 * Repeat computing, until no '+', '-' or '.' is following.
4497 for (;;)
4499 op = **arg;
4500 if (op != '+' && op != '-' && op != '.')
4501 break;
4503 if ((op != '+' || rettv->v_type != VAR_LIST)
4504 #ifdef FEAT_FLOAT
4505 && (op == '.' || rettv->v_type != VAR_FLOAT)
4506 #endif
4509 /* For "list + ...", an illegal use of the first operand as
4510 * a number cannot be determined before evaluating the 2nd
4511 * operand: if this is also a list, all is ok.
4512 * For "something . ...", "something - ..." or "non-list + ...",
4513 * we know that the first operand needs to be a string or number
4514 * without evaluating the 2nd operand. So check before to avoid
4515 * side effects after an error. */
4516 if (evaluate && get_tv_string_chk(rettv) == NULL)
4518 clear_tv(rettv);
4519 return FAIL;
4524 * Get the second variable.
4526 *arg = skipwhite(*arg + 1);
4527 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4529 clear_tv(rettv);
4530 return FAIL;
4533 if (evaluate)
4536 * Compute the result.
4538 if (op == '.')
4540 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4541 s2 = get_tv_string_buf_chk(&var2, buf2);
4542 if (s2 == NULL) /* type error ? */
4544 clear_tv(rettv);
4545 clear_tv(&var2);
4546 return FAIL;
4548 p = concat_str(s1, s2);
4549 clear_tv(rettv);
4550 rettv->v_type = VAR_STRING;
4551 rettv->vval.v_string = p;
4553 else if (op == '+' && rettv->v_type == VAR_LIST
4554 && var2.v_type == VAR_LIST)
4556 /* concatenate Lists */
4557 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4558 &var3) == FAIL)
4560 clear_tv(rettv);
4561 clear_tv(&var2);
4562 return FAIL;
4564 clear_tv(rettv);
4565 *rettv = var3;
4567 else
4569 int error = FALSE;
4571 #ifdef FEAT_FLOAT
4572 if (rettv->v_type == VAR_FLOAT)
4574 f1 = rettv->vval.v_float;
4575 n1 = 0;
4577 else
4578 #endif
4580 n1 = get_tv_number_chk(rettv, &error);
4581 if (error)
4583 /* This can only happen for "list + non-list". For
4584 * "non-list + ..." or "something - ...", we returned
4585 * before evaluating the 2nd operand. */
4586 clear_tv(rettv);
4587 return FAIL;
4589 #ifdef FEAT_FLOAT
4590 if (var2.v_type == VAR_FLOAT)
4591 f1 = n1;
4592 #endif
4594 #ifdef FEAT_FLOAT
4595 if (var2.v_type == VAR_FLOAT)
4597 f2 = var2.vval.v_float;
4598 n2 = 0;
4600 else
4601 #endif
4603 n2 = get_tv_number_chk(&var2, &error);
4604 if (error)
4606 clear_tv(rettv);
4607 clear_tv(&var2);
4608 return FAIL;
4610 #ifdef FEAT_FLOAT
4611 if (rettv->v_type == VAR_FLOAT)
4612 f2 = n2;
4613 #endif
4615 clear_tv(rettv);
4617 #ifdef FEAT_FLOAT
4618 /* If there is a float on either side the result is a float. */
4619 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4621 if (op == '+')
4622 f1 = f1 + f2;
4623 else
4624 f1 = f1 - f2;
4625 rettv->v_type = VAR_FLOAT;
4626 rettv->vval.v_float = f1;
4628 else
4629 #endif
4631 if (op == '+')
4632 n1 = n1 + n2;
4633 else
4634 n1 = n1 - n2;
4635 rettv->v_type = VAR_NUMBER;
4636 rettv->vval.v_number = n1;
4639 clear_tv(&var2);
4642 return OK;
4646 * Handle fifth level expression:
4647 * * number multiplication
4648 * / number division
4649 * % number modulo
4651 * "arg" must point to the first non-white of the expression.
4652 * "arg" is advanced to the next non-white after the recognized expression.
4654 * Return OK or FAIL.
4656 static int
4657 eval6(arg, rettv, evaluate, want_string)
4658 char_u **arg;
4659 typval_T *rettv;
4660 int evaluate;
4661 int want_string; /* after "." operator */
4663 typval_T var2;
4664 int op;
4665 long n1, n2;
4666 #ifdef FEAT_FLOAT
4667 int use_float = FALSE;
4668 float_T f1 = 0, f2;
4669 #endif
4670 int error = FALSE;
4673 * Get the first variable.
4675 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4676 return FAIL;
4679 * Repeat computing, until no '*', '/' or '%' is following.
4681 for (;;)
4683 op = **arg;
4684 if (op != '*' && op != '/' && op != '%')
4685 break;
4687 if (evaluate)
4689 #ifdef FEAT_FLOAT
4690 if (rettv->v_type == VAR_FLOAT)
4692 f1 = rettv->vval.v_float;
4693 use_float = TRUE;
4694 n1 = 0;
4696 else
4697 #endif
4698 n1 = get_tv_number_chk(rettv, &error);
4699 clear_tv(rettv);
4700 if (error)
4701 return FAIL;
4703 else
4704 n1 = 0;
4707 * Get the second variable.
4709 *arg = skipwhite(*arg + 1);
4710 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4711 return FAIL;
4713 if (evaluate)
4715 #ifdef FEAT_FLOAT
4716 if (var2.v_type == VAR_FLOAT)
4718 if (!use_float)
4720 f1 = n1;
4721 use_float = TRUE;
4723 f2 = var2.vval.v_float;
4724 n2 = 0;
4726 else
4727 #endif
4729 n2 = get_tv_number_chk(&var2, &error);
4730 clear_tv(&var2);
4731 if (error)
4732 return FAIL;
4733 #ifdef FEAT_FLOAT
4734 if (use_float)
4735 f2 = n2;
4736 #endif
4740 * Compute the result.
4741 * When either side is a float the result is a float.
4743 #ifdef FEAT_FLOAT
4744 if (use_float)
4746 if (op == '*')
4747 f1 = f1 * f2;
4748 else if (op == '/')
4750 /* We rely on the floating point library to handle divide
4751 * by zero to result in "inf" and not a crash. */
4752 f1 = f1 / f2;
4754 else
4756 EMSG(_("E804: Cannot use '%' with Float"));
4757 return FAIL;
4759 rettv->v_type = VAR_FLOAT;
4760 rettv->vval.v_float = f1;
4762 else
4763 #endif
4765 if (op == '*')
4766 n1 = n1 * n2;
4767 else if (op == '/')
4769 if (n2 == 0) /* give an error message? */
4771 if (n1 == 0)
4772 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4773 else if (n1 < 0)
4774 n1 = -0x7fffffffL;
4775 else
4776 n1 = 0x7fffffffL;
4778 else
4779 n1 = n1 / n2;
4781 else
4783 if (n2 == 0) /* give an error message? */
4784 n1 = 0;
4785 else
4786 n1 = n1 % n2;
4788 rettv->v_type = VAR_NUMBER;
4789 rettv->vval.v_number = n1;
4794 return OK;
4798 * Handle sixth level expression:
4799 * number number constant
4800 * "string" string constant
4801 * 'string' literal string constant
4802 * &option-name option value
4803 * @r register contents
4804 * identifier variable value
4805 * function() function call
4806 * $VAR environment variable
4807 * (expression) nested expression
4808 * [expr, expr] List
4809 * {key: val, key: val} Dictionary
4811 * Also handle:
4812 * ! in front logical NOT
4813 * - in front unary minus
4814 * + in front unary plus (ignored)
4815 * trailing [] subscript in String or List
4816 * trailing .name entry in Dictionary
4818 * "arg" must point to the first non-white of the expression.
4819 * "arg" is advanced to the next non-white after the recognized expression.
4821 * Return OK or FAIL.
4823 static int
4824 eval7(arg, rettv, evaluate, want_string)
4825 char_u **arg;
4826 typval_T *rettv;
4827 int evaluate;
4828 int want_string; /* after "." operator */
4830 long n;
4831 int len;
4832 char_u *s;
4833 char_u *start_leader, *end_leader;
4834 int ret = OK;
4835 char_u *alias;
4838 * Initialise variable so that clear_tv() can't mistake this for a
4839 * string and free a string that isn't there.
4841 rettv->v_type = VAR_UNKNOWN;
4844 * Skip '!' and '-' characters. They are handled later.
4846 start_leader = *arg;
4847 while (**arg == '!' || **arg == '-' || **arg == '+')
4848 *arg = skipwhite(*arg + 1);
4849 end_leader = *arg;
4851 switch (**arg)
4854 * Number constant.
4856 case '0':
4857 case '1':
4858 case '2':
4859 case '3':
4860 case '4':
4861 case '5':
4862 case '6':
4863 case '7':
4864 case '8':
4865 case '9':
4867 #ifdef FEAT_FLOAT
4868 char_u *p = skipdigits(*arg + 1);
4869 int get_float = FALSE;
4871 /* We accept a float when the format matches
4872 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4873 * strict to avoid backwards compatibility problems.
4874 * Don't look for a float after the "." operator, so that
4875 * ":let vers = 1.2.3" doesn't fail. */
4876 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4878 get_float = TRUE;
4879 p = skipdigits(p + 2);
4880 if (*p == 'e' || *p == 'E')
4882 ++p;
4883 if (*p == '-' || *p == '+')
4884 ++p;
4885 if (!vim_isdigit(*p))
4886 get_float = FALSE;
4887 else
4888 p = skipdigits(p + 1);
4890 if (ASCII_ISALPHA(*p) || *p == '.')
4891 get_float = FALSE;
4893 if (get_float)
4895 float_T f;
4897 *arg += string2float(*arg, &f);
4898 if (evaluate)
4900 rettv->v_type = VAR_FLOAT;
4901 rettv->vval.v_float = f;
4904 else
4905 #endif
4907 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4908 *arg += len;
4909 if (evaluate)
4911 rettv->v_type = VAR_NUMBER;
4912 rettv->vval.v_number = n;
4915 break;
4919 * String constant: "string".
4921 case '"': ret = get_string_tv(arg, rettv, evaluate);
4922 break;
4925 * Literal string constant: 'str''ing'.
4927 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4928 break;
4931 * List: [expr, expr]
4933 case '[': ret = get_list_tv(arg, rettv, evaluate);
4934 break;
4937 * Dictionary: {key: val, key: val}
4939 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4940 break;
4943 * Option value: &name
4945 case '&': ret = get_option_tv(arg, rettv, evaluate);
4946 break;
4949 * Environment variable: $VAR.
4951 case '$': ret = get_env_tv(arg, rettv, evaluate);
4952 break;
4955 * Register contents: @r.
4957 case '@': ++*arg;
4958 if (evaluate)
4960 rettv->v_type = VAR_STRING;
4961 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4963 if (**arg != NUL)
4964 ++*arg;
4965 break;
4968 * nested expression: (expression).
4970 case '(': *arg = skipwhite(*arg + 1);
4971 ret = eval1(arg, rettv, evaluate); /* recursive! */
4972 if (**arg == ')')
4973 ++*arg;
4974 else if (ret == OK)
4976 EMSG(_("E110: Missing ')'"));
4977 clear_tv(rettv);
4978 ret = FAIL;
4980 break;
4982 default: ret = NOTDONE;
4983 break;
4986 if (ret == NOTDONE)
4989 * Must be a variable or function name.
4990 * Can also be a curly-braces kind of name: {expr}.
4992 s = *arg;
4993 len = get_name_len(arg, &alias, evaluate, TRUE);
4994 if (alias != NULL)
4995 s = alias;
4997 if (len <= 0)
4998 ret = FAIL;
4999 else
5001 if (**arg == '(') /* recursive! */
5003 /* If "s" is the name of a variable of type VAR_FUNC
5004 * use its contents. */
5005 s = deref_func_name(s, &len);
5007 /* Invoke the function. */
5008 ret = get_func_tv(s, len, rettv, arg,
5009 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5010 &len, evaluate, NULL);
5011 /* Stop the expression evaluation when immediately
5012 * aborting on error, or when an interrupt occurred or
5013 * an exception was thrown but not caught. */
5014 if (aborting())
5016 if (ret == OK)
5017 clear_tv(rettv);
5018 ret = FAIL;
5021 else if (evaluate)
5022 ret = get_var_tv(s, len, rettv, TRUE);
5023 else
5024 ret = OK;
5027 if (alias != NULL)
5028 vim_free(alias);
5031 *arg = skipwhite(*arg);
5033 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5034 * expr(expr). */
5035 if (ret == OK)
5036 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5039 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5041 if (ret == OK && evaluate && end_leader > start_leader)
5043 int error = FALSE;
5044 int val = 0;
5045 #ifdef FEAT_FLOAT
5046 float_T f = 0.0;
5048 if (rettv->v_type == VAR_FLOAT)
5049 f = rettv->vval.v_float;
5050 else
5051 #endif
5052 val = get_tv_number_chk(rettv, &error);
5053 if (error)
5055 clear_tv(rettv);
5056 ret = FAIL;
5058 else
5060 while (end_leader > start_leader)
5062 --end_leader;
5063 if (*end_leader == '!')
5065 #ifdef FEAT_FLOAT
5066 if (rettv->v_type == VAR_FLOAT)
5067 f = !f;
5068 else
5069 #endif
5070 val = !val;
5072 else if (*end_leader == '-')
5074 #ifdef FEAT_FLOAT
5075 if (rettv->v_type == VAR_FLOAT)
5076 f = -f;
5077 else
5078 #endif
5079 val = -val;
5082 #ifdef FEAT_FLOAT
5083 if (rettv->v_type == VAR_FLOAT)
5085 clear_tv(rettv);
5086 rettv->vval.v_float = f;
5088 else
5089 #endif
5091 clear_tv(rettv);
5092 rettv->v_type = VAR_NUMBER;
5093 rettv->vval.v_number = val;
5098 return ret;
5102 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5103 * "*arg" points to the '[' or '.'.
5104 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5106 static int
5107 eval_index(arg, rettv, evaluate, verbose)
5108 char_u **arg;
5109 typval_T *rettv;
5110 int evaluate;
5111 int verbose; /* give error messages */
5113 int empty1 = FALSE, empty2 = FALSE;
5114 typval_T var1, var2;
5115 long n1, n2 = 0;
5116 long len = -1;
5117 int range = FALSE;
5118 char_u *s;
5119 char_u *key = NULL;
5121 if (rettv->v_type == VAR_FUNC
5122 #ifdef FEAT_FLOAT
5123 || rettv->v_type == VAR_FLOAT
5124 #endif
5127 if (verbose)
5128 EMSG(_("E695: Cannot index a Funcref"));
5129 return FAIL;
5132 if (**arg == '.')
5135 * dict.name
5137 key = *arg + 1;
5138 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5140 if (len == 0)
5141 return FAIL;
5142 *arg = skipwhite(key + len);
5144 else
5147 * something[idx]
5149 * Get the (first) variable from inside the [].
5151 *arg = skipwhite(*arg + 1);
5152 if (**arg == ':')
5153 empty1 = TRUE;
5154 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5155 return FAIL;
5156 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5158 /* not a number or string */
5159 clear_tv(&var1);
5160 return FAIL;
5164 * Get the second variable from inside the [:].
5166 if (**arg == ':')
5168 range = TRUE;
5169 *arg = skipwhite(*arg + 1);
5170 if (**arg == ']')
5171 empty2 = TRUE;
5172 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5174 if (!empty1)
5175 clear_tv(&var1);
5176 return FAIL;
5178 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5180 /* not a number or string */
5181 if (!empty1)
5182 clear_tv(&var1);
5183 clear_tv(&var2);
5184 return FAIL;
5188 /* Check for the ']'. */
5189 if (**arg != ']')
5191 if (verbose)
5192 EMSG(_(e_missbrac));
5193 clear_tv(&var1);
5194 if (range)
5195 clear_tv(&var2);
5196 return FAIL;
5198 *arg = skipwhite(*arg + 1); /* skip the ']' */
5201 if (evaluate)
5203 n1 = 0;
5204 if (!empty1 && rettv->v_type != VAR_DICT)
5206 n1 = get_tv_number(&var1);
5207 clear_tv(&var1);
5209 if (range)
5211 if (empty2)
5212 n2 = -1;
5213 else
5215 n2 = get_tv_number(&var2);
5216 clear_tv(&var2);
5220 switch (rettv->v_type)
5222 case VAR_NUMBER:
5223 case VAR_STRING:
5224 s = get_tv_string(rettv);
5225 len = (long)STRLEN(s);
5226 if (range)
5228 /* The resulting variable is a substring. If the indexes
5229 * are out of range the result is empty. */
5230 if (n1 < 0)
5232 n1 = len + n1;
5233 if (n1 < 0)
5234 n1 = 0;
5236 if (n2 < 0)
5237 n2 = len + n2;
5238 else if (n2 >= len)
5239 n2 = len;
5240 if (n1 >= len || n2 < 0 || n1 > n2)
5241 s = NULL;
5242 else
5243 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5245 else
5247 /* The resulting variable is a string of a single
5248 * character. If the index is too big or negative the
5249 * result is empty. */
5250 if (n1 >= len || n1 < 0)
5251 s = NULL;
5252 else
5253 s = vim_strnsave(s + n1, 1);
5255 clear_tv(rettv);
5256 rettv->v_type = VAR_STRING;
5257 rettv->vval.v_string = s;
5258 break;
5260 case VAR_LIST:
5261 len = list_len(rettv->vval.v_list);
5262 if (n1 < 0)
5263 n1 = len + n1;
5264 if (!empty1 && (n1 < 0 || n1 >= len))
5266 /* For a range we allow invalid values and return an empty
5267 * list. A list index out of range is an error. */
5268 if (!range)
5270 if (verbose)
5271 EMSGN(_(e_listidx), n1);
5272 return FAIL;
5274 n1 = len;
5276 if (range)
5278 list_T *l;
5279 listitem_T *item;
5281 if (n2 < 0)
5282 n2 = len + n2;
5283 else if (n2 >= len)
5284 n2 = len - 1;
5285 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5286 n2 = -1;
5287 l = list_alloc();
5288 if (l == NULL)
5289 return FAIL;
5290 for (item = list_find(rettv->vval.v_list, n1);
5291 n1 <= n2; ++n1)
5293 if (list_append_tv(l, &item->li_tv) == FAIL)
5295 list_free(l, TRUE);
5296 return FAIL;
5298 item = item->li_next;
5300 clear_tv(rettv);
5301 rettv->v_type = VAR_LIST;
5302 rettv->vval.v_list = l;
5303 ++l->lv_refcount;
5305 else
5307 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5308 clear_tv(rettv);
5309 *rettv = var1;
5311 break;
5313 case VAR_DICT:
5314 if (range)
5316 if (verbose)
5317 EMSG(_(e_dictrange));
5318 if (len == -1)
5319 clear_tv(&var1);
5320 return FAIL;
5323 dictitem_T *item;
5325 if (len == -1)
5327 key = get_tv_string(&var1);
5328 if (*key == NUL)
5330 if (verbose)
5331 EMSG(_(e_emptykey));
5332 clear_tv(&var1);
5333 return FAIL;
5337 item = dict_find(rettv->vval.v_dict, key, (int)len);
5339 if (item == NULL && verbose)
5340 EMSG2(_(e_dictkey), key);
5341 if (len == -1)
5342 clear_tv(&var1);
5343 if (item == NULL)
5344 return FAIL;
5346 copy_tv(&item->di_tv, &var1);
5347 clear_tv(rettv);
5348 *rettv = var1;
5350 break;
5354 return OK;
5358 * Get an option value.
5359 * "arg" points to the '&' or '+' before the option name.
5360 * "arg" is advanced to character after the option name.
5361 * Return OK or FAIL.
5363 static int
5364 get_option_tv(arg, rettv, evaluate)
5365 char_u **arg;
5366 typval_T *rettv; /* when NULL, only check if option exists */
5367 int evaluate;
5369 char_u *option_end;
5370 long numval;
5371 char_u *stringval;
5372 int opt_type;
5373 int c;
5374 int working = (**arg == '+'); /* has("+option") */
5375 int ret = OK;
5376 int opt_flags;
5379 * Isolate the option name and find its value.
5381 option_end = find_option_end(arg, &opt_flags);
5382 if (option_end == NULL)
5384 if (rettv != NULL)
5385 EMSG2(_("E112: Option name missing: %s"), *arg);
5386 return FAIL;
5389 if (!evaluate)
5391 *arg = option_end;
5392 return OK;
5395 c = *option_end;
5396 *option_end = NUL;
5397 opt_type = get_option_value(*arg, &numval,
5398 rettv == NULL ? NULL : &stringval, opt_flags);
5400 if (opt_type == -3) /* invalid name */
5402 if (rettv != NULL)
5403 EMSG2(_("E113: Unknown option: %s"), *arg);
5404 ret = FAIL;
5406 else if (rettv != NULL)
5408 if (opt_type == -2) /* hidden string option */
5410 rettv->v_type = VAR_STRING;
5411 rettv->vval.v_string = NULL;
5413 else if (opt_type == -1) /* hidden number option */
5415 rettv->v_type = VAR_NUMBER;
5416 rettv->vval.v_number = 0;
5418 else if (opt_type == 1) /* number option */
5420 rettv->v_type = VAR_NUMBER;
5421 rettv->vval.v_number = numval;
5423 else /* string option */
5425 rettv->v_type = VAR_STRING;
5426 rettv->vval.v_string = stringval;
5429 else if (working && (opt_type == -2 || opt_type == -1))
5430 ret = FAIL;
5432 *option_end = c; /* put back for error messages */
5433 *arg = option_end;
5435 return ret;
5439 * Allocate a variable for a string constant.
5440 * Return OK or FAIL.
5442 static int
5443 get_string_tv(arg, rettv, evaluate)
5444 char_u **arg;
5445 typval_T *rettv;
5446 int evaluate;
5448 char_u *p;
5449 char_u *name;
5450 int extra = 0;
5453 * Find the end of the string, skipping backslashed characters.
5455 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5457 if (*p == '\\' && p[1] != NUL)
5459 ++p;
5460 /* A "\<x>" form occupies at least 4 characters, and produces up
5461 * to 6 characters: reserve space for 2 extra */
5462 if (*p == '<')
5463 extra += 2;
5467 if (*p != '"')
5469 EMSG2(_("E114: Missing quote: %s"), *arg);
5470 return FAIL;
5473 /* If only parsing, set *arg and return here */
5474 if (!evaluate)
5476 *arg = p + 1;
5477 return OK;
5481 * Copy the string into allocated memory, handling backslashed
5482 * characters.
5484 name = alloc((unsigned)(p - *arg + extra));
5485 if (name == NULL)
5486 return FAIL;
5487 rettv->v_type = VAR_STRING;
5488 rettv->vval.v_string = name;
5490 for (p = *arg + 1; *p != NUL && *p != '"'; )
5492 if (*p == '\\')
5494 switch (*++p)
5496 case 'b': *name++ = BS; ++p; break;
5497 case 'e': *name++ = ESC; ++p; break;
5498 case 'f': *name++ = FF; ++p; break;
5499 case 'n': *name++ = NL; ++p; break;
5500 case 'r': *name++ = CAR; ++p; break;
5501 case 't': *name++ = TAB; ++p; break;
5503 case 'X': /* hex: "\x1", "\x12" */
5504 case 'x':
5505 case 'u': /* Unicode: "\u0023" */
5506 case 'U':
5507 if (vim_isxdigit(p[1]))
5509 int n, nr;
5510 int c = toupper(*p);
5512 if (c == 'X')
5513 n = 2;
5514 else
5515 n = 4;
5516 nr = 0;
5517 while (--n >= 0 && vim_isxdigit(p[1]))
5519 ++p;
5520 nr = (nr << 4) + hex2nr(*p);
5522 ++p;
5523 #ifdef FEAT_MBYTE
5524 /* For "\u" store the number according to
5525 * 'encoding'. */
5526 if (c != 'X')
5527 name += (*mb_char2bytes)(nr, name);
5528 else
5529 #endif
5530 *name++ = nr;
5532 break;
5534 /* octal: "\1", "\12", "\123" */
5535 case '0':
5536 case '1':
5537 case '2':
5538 case '3':
5539 case '4':
5540 case '5':
5541 case '6':
5542 case '7': *name = *p++ - '0';
5543 if (*p >= '0' && *p <= '7')
5545 *name = (*name << 3) + *p++ - '0';
5546 if (*p >= '0' && *p <= '7')
5547 *name = (*name << 3) + *p++ - '0';
5549 ++name;
5550 break;
5552 /* Special key, e.g.: "\<C-W>" */
5553 case '<': extra = trans_special(&p, name, TRUE);
5554 if (extra != 0)
5556 name += extra;
5557 break;
5559 /* FALLTHROUGH */
5561 default: MB_COPY_CHAR(p, name);
5562 break;
5565 else
5566 MB_COPY_CHAR(p, name);
5569 *name = NUL;
5570 *arg = p + 1;
5572 return OK;
5576 * Allocate a variable for a 'str''ing' constant.
5577 * Return OK or FAIL.
5579 static int
5580 get_lit_string_tv(arg, rettv, evaluate)
5581 char_u **arg;
5582 typval_T *rettv;
5583 int evaluate;
5585 char_u *p;
5586 char_u *str;
5587 int reduce = 0;
5590 * Find the end of the string, skipping ''.
5592 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5594 if (*p == '\'')
5596 if (p[1] != '\'')
5597 break;
5598 ++reduce;
5599 ++p;
5603 if (*p != '\'')
5605 EMSG2(_("E115: Missing quote: %s"), *arg);
5606 return FAIL;
5609 /* If only parsing return after setting "*arg" */
5610 if (!evaluate)
5612 *arg = p + 1;
5613 return OK;
5617 * Copy the string into allocated memory, handling '' to ' reduction.
5619 str = alloc((unsigned)((p - *arg) - reduce));
5620 if (str == NULL)
5621 return FAIL;
5622 rettv->v_type = VAR_STRING;
5623 rettv->vval.v_string = str;
5625 for (p = *arg + 1; *p != NUL; )
5627 if (*p == '\'')
5629 if (p[1] != '\'')
5630 break;
5631 ++p;
5633 MB_COPY_CHAR(p, str);
5635 *str = NUL;
5636 *arg = p + 1;
5638 return OK;
5642 * Allocate a variable for a List and fill it from "*arg".
5643 * Return OK or FAIL.
5645 static int
5646 get_list_tv(arg, rettv, evaluate)
5647 char_u **arg;
5648 typval_T *rettv;
5649 int evaluate;
5651 list_T *l = NULL;
5652 typval_T tv;
5653 listitem_T *item;
5655 if (evaluate)
5657 l = list_alloc();
5658 if (l == NULL)
5659 return FAIL;
5662 *arg = skipwhite(*arg + 1);
5663 while (**arg != ']' && **arg != NUL)
5665 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5666 goto failret;
5667 if (evaluate)
5669 item = listitem_alloc();
5670 if (item != NULL)
5672 item->li_tv = tv;
5673 item->li_tv.v_lock = 0;
5674 list_append(l, item);
5676 else
5677 clear_tv(&tv);
5680 if (**arg == ']')
5681 break;
5682 if (**arg != ',')
5684 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5685 goto failret;
5687 *arg = skipwhite(*arg + 1);
5690 if (**arg != ']')
5692 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5693 failret:
5694 if (evaluate)
5695 list_free(l, TRUE);
5696 return FAIL;
5699 *arg = skipwhite(*arg + 1);
5700 if (evaluate)
5702 rettv->v_type = VAR_LIST;
5703 rettv->vval.v_list = l;
5704 ++l->lv_refcount;
5707 return OK;
5711 * Allocate an empty header for a list.
5712 * Caller should take care of the reference count.
5714 list_T *
5715 list_alloc()
5717 list_T *l;
5719 l = (list_T *)alloc_clear(sizeof(list_T));
5720 if (l != NULL)
5722 /* Prepend the list to the list of lists for garbage collection. */
5723 if (first_list != NULL)
5724 first_list->lv_used_prev = l;
5725 l->lv_used_prev = NULL;
5726 l->lv_used_next = first_list;
5727 first_list = l;
5729 return l;
5733 * Allocate an empty list for a return value.
5734 * Returns OK or FAIL.
5736 static int
5737 rettv_list_alloc(rettv)
5738 typval_T *rettv;
5740 list_T *l = list_alloc();
5742 if (l == NULL)
5743 return FAIL;
5745 rettv->vval.v_list = l;
5746 rettv->v_type = VAR_LIST;
5747 ++l->lv_refcount;
5748 return OK;
5752 * Unreference a list: decrement the reference count and free it when it
5753 * becomes zero.
5755 void
5756 list_unref(l)
5757 list_T *l;
5759 if (l != NULL && --l->lv_refcount <= 0)
5760 list_free(l, TRUE);
5764 * Free a list, including all items it points to.
5765 * Ignores the reference count.
5767 void
5768 list_free(l, recurse)
5769 list_T *l;
5770 int recurse; /* Free Lists and Dictionaries recursively. */
5772 listitem_T *item;
5774 /* Remove the list from the list of lists for garbage collection. */
5775 if (l->lv_used_prev == NULL)
5776 first_list = l->lv_used_next;
5777 else
5778 l->lv_used_prev->lv_used_next = l->lv_used_next;
5779 if (l->lv_used_next != NULL)
5780 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5782 for (item = l->lv_first; item != NULL; item = l->lv_first)
5784 /* Remove the item before deleting it. */
5785 l->lv_first = item->li_next;
5786 if (recurse || (item->li_tv.v_type != VAR_LIST
5787 && item->li_tv.v_type != VAR_DICT))
5788 clear_tv(&item->li_tv);
5789 vim_free(item);
5791 vim_free(l);
5795 * Allocate a list item.
5797 static listitem_T *
5798 listitem_alloc()
5800 return (listitem_T *)alloc(sizeof(listitem_T));
5804 * Free a list item. Also clears the value. Does not notify watchers.
5806 static void
5807 listitem_free(item)
5808 listitem_T *item;
5810 clear_tv(&item->li_tv);
5811 vim_free(item);
5815 * Remove a list item from a List and free it. Also clears the value.
5817 static void
5818 listitem_remove(l, item)
5819 list_T *l;
5820 listitem_T *item;
5822 list_remove(l, item, item);
5823 listitem_free(item);
5827 * Get the number of items in a list.
5829 static long
5830 list_len(l)
5831 list_T *l;
5833 if (l == NULL)
5834 return 0L;
5835 return l->lv_len;
5839 * Return TRUE when two lists have exactly the same values.
5841 static int
5842 list_equal(l1, l2, ic)
5843 list_T *l1;
5844 list_T *l2;
5845 int ic; /* ignore case for strings */
5847 listitem_T *item1, *item2;
5849 if (l1 == NULL || l2 == NULL)
5850 return FALSE;
5851 if (l1 == l2)
5852 return TRUE;
5853 if (list_len(l1) != list_len(l2))
5854 return FALSE;
5856 for (item1 = l1->lv_first, item2 = l2->lv_first;
5857 item1 != NULL && item2 != NULL;
5858 item1 = item1->li_next, item2 = item2->li_next)
5859 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5860 return FALSE;
5861 return item1 == NULL && item2 == NULL;
5864 #if defined(FEAT_PYTHON) || defined(PROTO)
5866 * Return the dictitem that an entry in a hashtable points to.
5868 dictitem_T *
5869 dict_lookup(hi)
5870 hashitem_T *hi;
5872 return HI2DI(hi);
5874 #endif
5877 * Return TRUE when two dictionaries have exactly the same key/values.
5879 static int
5880 dict_equal(d1, d2, ic)
5881 dict_T *d1;
5882 dict_T *d2;
5883 int ic; /* ignore case for strings */
5885 hashitem_T *hi;
5886 dictitem_T *item2;
5887 int todo;
5889 if (d1 == NULL || d2 == NULL)
5890 return FALSE;
5891 if (d1 == d2)
5892 return TRUE;
5893 if (dict_len(d1) != dict_len(d2))
5894 return FALSE;
5896 todo = (int)d1->dv_hashtab.ht_used;
5897 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5899 if (!HASHITEM_EMPTY(hi))
5901 item2 = dict_find(d2, hi->hi_key, -1);
5902 if (item2 == NULL)
5903 return FALSE;
5904 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5905 return FALSE;
5906 --todo;
5909 return TRUE;
5913 * Return TRUE if "tv1" and "tv2" have the same value.
5914 * Compares the items just like "==" would compare them, but strings and
5915 * numbers are different. Floats and numbers are also different.
5917 static int
5918 tv_equal(tv1, tv2, ic)
5919 typval_T *tv1;
5920 typval_T *tv2;
5921 int ic; /* ignore case */
5923 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5924 char_u *s1, *s2;
5925 static int recursive = 0; /* cach recursive loops */
5926 int r;
5928 if (tv1->v_type != tv2->v_type)
5929 return FALSE;
5930 /* Catch lists and dicts that have an endless loop by limiting
5931 * recursiveness to 1000. We guess they are equal then. */
5932 if (recursive >= 1000)
5933 return TRUE;
5935 switch (tv1->v_type)
5937 case VAR_LIST:
5938 ++recursive;
5939 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5940 --recursive;
5941 return r;
5943 case VAR_DICT:
5944 ++recursive;
5945 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5946 --recursive;
5947 return r;
5949 case VAR_FUNC:
5950 return (tv1->vval.v_string != NULL
5951 && tv2->vval.v_string != NULL
5952 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5954 case VAR_NUMBER:
5955 return tv1->vval.v_number == tv2->vval.v_number;
5957 #ifdef FEAT_FLOAT
5958 case VAR_FLOAT:
5959 return tv1->vval.v_float == tv2->vval.v_float;
5960 #endif
5962 case VAR_STRING:
5963 s1 = get_tv_string_buf(tv1, buf1);
5964 s2 = get_tv_string_buf(tv2, buf2);
5965 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5968 EMSG2(_(e_intern2), "tv_equal()");
5969 return TRUE;
5973 * Locate item with index "n" in list "l" and return it.
5974 * A negative index is counted from the end; -1 is the last item.
5975 * Returns NULL when "n" is out of range.
5977 static listitem_T *
5978 list_find(l, n)
5979 list_T *l;
5980 long n;
5982 listitem_T *item;
5983 long idx;
5985 if (l == NULL)
5986 return NULL;
5988 /* Negative index is relative to the end. */
5989 if (n < 0)
5990 n = l->lv_len + n;
5992 /* Check for index out of range. */
5993 if (n < 0 || n >= l->lv_len)
5994 return NULL;
5996 /* When there is a cached index may start search from there. */
5997 if (l->lv_idx_item != NULL)
5999 if (n < l->lv_idx / 2)
6001 /* closest to the start of the list */
6002 item = l->lv_first;
6003 idx = 0;
6005 else if (n > (l->lv_idx + l->lv_len) / 2)
6007 /* closest to the end of the list */
6008 item = l->lv_last;
6009 idx = l->lv_len - 1;
6011 else
6013 /* closest to the cached index */
6014 item = l->lv_idx_item;
6015 idx = l->lv_idx;
6018 else
6020 if (n < l->lv_len / 2)
6022 /* closest to the start of the list */
6023 item = l->lv_first;
6024 idx = 0;
6026 else
6028 /* closest to the end of the list */
6029 item = l->lv_last;
6030 idx = l->lv_len - 1;
6034 while (n > idx)
6036 /* search forward */
6037 item = item->li_next;
6038 ++idx;
6040 while (n < idx)
6042 /* search backward */
6043 item = item->li_prev;
6044 --idx;
6047 /* cache the used index */
6048 l->lv_idx = idx;
6049 l->lv_idx_item = item;
6051 return item;
6055 * Get list item "l[idx]" as a number.
6057 static long
6058 list_find_nr(l, idx, errorp)
6059 list_T *l;
6060 long idx;
6061 int *errorp; /* set to TRUE when something wrong */
6063 listitem_T *li;
6065 li = list_find(l, idx);
6066 if (li == NULL)
6068 if (errorp != NULL)
6069 *errorp = TRUE;
6070 return -1L;
6072 return get_tv_number_chk(&li->li_tv, errorp);
6076 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6078 char_u *
6079 list_find_str(l, idx)
6080 list_T *l;
6081 long idx;
6083 listitem_T *li;
6085 li = list_find(l, idx - 1);
6086 if (li == NULL)
6088 EMSGN(_(e_listidx), idx);
6089 return NULL;
6091 return get_tv_string(&li->li_tv);
6095 * Locate "item" list "l" and return its index.
6096 * Returns -1 when "item" is not in the list.
6098 static long
6099 list_idx_of_item(l, item)
6100 list_T *l;
6101 listitem_T *item;
6103 long idx = 0;
6104 listitem_T *li;
6106 if (l == NULL)
6107 return -1;
6108 idx = 0;
6109 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6110 ++idx;
6111 if (li == NULL)
6112 return -1;
6113 return idx;
6117 * Append item "item" to the end of list "l".
6119 static void
6120 list_append(l, item)
6121 list_T *l;
6122 listitem_T *item;
6124 if (l->lv_last == NULL)
6126 /* empty list */
6127 l->lv_first = item;
6128 l->lv_last = item;
6129 item->li_prev = NULL;
6131 else
6133 l->lv_last->li_next = item;
6134 item->li_prev = l->lv_last;
6135 l->lv_last = item;
6137 ++l->lv_len;
6138 item->li_next = NULL;
6142 * Append typval_T "tv" to the end of list "l".
6143 * Return FAIL when out of memory.
6145 static int
6146 list_append_tv(l, tv)
6147 list_T *l;
6148 typval_T *tv;
6150 listitem_T *li = listitem_alloc();
6152 if (li == NULL)
6153 return FAIL;
6154 copy_tv(tv, &li->li_tv);
6155 list_append(l, li);
6156 return OK;
6160 * Add a dictionary to a list. Used by getqflist().
6161 * Return FAIL when out of memory.
6164 list_append_dict(list, dict)
6165 list_T *list;
6166 dict_T *dict;
6168 listitem_T *li = listitem_alloc();
6170 if (li == NULL)
6171 return FAIL;
6172 li->li_tv.v_type = VAR_DICT;
6173 li->li_tv.v_lock = 0;
6174 li->li_tv.vval.v_dict = dict;
6175 list_append(list, li);
6176 ++dict->dv_refcount;
6177 return OK;
6181 * Make a copy of "str" and append it as an item to list "l".
6182 * When "len" >= 0 use "str[len]".
6183 * Returns FAIL when out of memory.
6186 list_append_string(l, str, len)
6187 list_T *l;
6188 char_u *str;
6189 int len;
6191 listitem_T *li = listitem_alloc();
6193 if (li == NULL)
6194 return FAIL;
6195 list_append(l, li);
6196 li->li_tv.v_type = VAR_STRING;
6197 li->li_tv.v_lock = 0;
6198 if (str == NULL)
6199 li->li_tv.vval.v_string = NULL;
6200 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6201 : vim_strsave(str))) == NULL)
6202 return FAIL;
6203 return OK;
6207 * Append "n" to list "l".
6208 * Returns FAIL when out of memory.
6210 static int
6211 list_append_number(l, n)
6212 list_T *l;
6213 varnumber_T n;
6215 listitem_T *li;
6217 li = listitem_alloc();
6218 if (li == NULL)
6219 return FAIL;
6220 li->li_tv.v_type = VAR_NUMBER;
6221 li->li_tv.v_lock = 0;
6222 li->li_tv.vval.v_number = n;
6223 list_append(l, li);
6224 return OK;
6228 * Insert typval_T "tv" in list "l" before "item".
6229 * If "item" is NULL append at the end.
6230 * Return FAIL when out of memory.
6232 static int
6233 list_insert_tv(l, tv, item)
6234 list_T *l;
6235 typval_T *tv;
6236 listitem_T *item;
6238 listitem_T *ni = listitem_alloc();
6240 if (ni == NULL)
6241 return FAIL;
6242 copy_tv(tv, &ni->li_tv);
6243 if (item == NULL)
6244 /* Append new item at end of list. */
6245 list_append(l, ni);
6246 else
6248 /* Insert new item before existing item. */
6249 ni->li_prev = item->li_prev;
6250 ni->li_next = item;
6251 if (item->li_prev == NULL)
6253 l->lv_first = ni;
6254 ++l->lv_idx;
6256 else
6258 item->li_prev->li_next = ni;
6259 l->lv_idx_item = NULL;
6261 item->li_prev = ni;
6262 ++l->lv_len;
6264 return OK;
6268 * Extend "l1" with "l2".
6269 * If "bef" is NULL append at the end, otherwise insert before this item.
6270 * Returns FAIL when out of memory.
6272 static int
6273 list_extend(l1, l2, bef)
6274 list_T *l1;
6275 list_T *l2;
6276 listitem_T *bef;
6278 listitem_T *item;
6279 int todo = l2->lv_len;
6281 /* We also quit the loop when we have inserted the original item count of
6282 * the list, avoid a hang when we extend a list with itself. */
6283 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6284 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6285 return FAIL;
6286 return OK;
6290 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6291 * Return FAIL when out of memory.
6293 static int
6294 list_concat(l1, l2, tv)
6295 list_T *l1;
6296 list_T *l2;
6297 typval_T *tv;
6299 list_T *l;
6301 if (l1 == NULL || l2 == NULL)
6302 return FAIL;
6304 /* make a copy of the first list. */
6305 l = list_copy(l1, FALSE, 0);
6306 if (l == NULL)
6307 return FAIL;
6308 tv->v_type = VAR_LIST;
6309 tv->vval.v_list = l;
6311 /* append all items from the second list */
6312 return list_extend(l, l2, NULL);
6316 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6317 * The refcount of the new list is set to 1.
6318 * See item_copy() for "copyID".
6319 * Returns NULL when out of memory.
6321 static list_T *
6322 list_copy(orig, deep, copyID)
6323 list_T *orig;
6324 int deep;
6325 int copyID;
6327 list_T *copy;
6328 listitem_T *item;
6329 listitem_T *ni;
6331 if (orig == NULL)
6332 return NULL;
6334 copy = list_alloc();
6335 if (copy != NULL)
6337 if (copyID != 0)
6339 /* Do this before adding the items, because one of the items may
6340 * refer back to this list. */
6341 orig->lv_copyID = copyID;
6342 orig->lv_copylist = copy;
6344 for (item = orig->lv_first; item != NULL && !got_int;
6345 item = item->li_next)
6347 ni = listitem_alloc();
6348 if (ni == NULL)
6349 break;
6350 if (deep)
6352 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6354 vim_free(ni);
6355 break;
6358 else
6359 copy_tv(&item->li_tv, &ni->li_tv);
6360 list_append(copy, ni);
6362 ++copy->lv_refcount;
6363 if (item != NULL)
6365 list_unref(copy);
6366 copy = NULL;
6370 return copy;
6374 * Remove items "item" to "item2" from list "l".
6375 * Does not free the listitem or the value!
6377 static void
6378 list_remove(l, item, item2)
6379 list_T *l;
6380 listitem_T *item;
6381 listitem_T *item2;
6383 listitem_T *ip;
6385 /* notify watchers */
6386 for (ip = item; ip != NULL; ip = ip->li_next)
6388 --l->lv_len;
6389 list_fix_watch(l, ip);
6390 if (ip == item2)
6391 break;
6394 if (item2->li_next == NULL)
6395 l->lv_last = item->li_prev;
6396 else
6397 item2->li_next->li_prev = item->li_prev;
6398 if (item->li_prev == NULL)
6399 l->lv_first = item2->li_next;
6400 else
6401 item->li_prev->li_next = item2->li_next;
6402 l->lv_idx_item = NULL;
6406 * Return an allocated string with the string representation of a list.
6407 * May return NULL.
6409 static char_u *
6410 list2string(tv, copyID)
6411 typval_T *tv;
6412 int copyID;
6414 garray_T ga;
6416 if (tv->vval.v_list == NULL)
6417 return NULL;
6418 ga_init2(&ga, (int)sizeof(char), 80);
6419 ga_append(&ga, '[');
6420 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6422 vim_free(ga.ga_data);
6423 return NULL;
6425 ga_append(&ga, ']');
6426 ga_append(&ga, NUL);
6427 return (char_u *)ga.ga_data;
6431 * Join list "l" into a string in "*gap", using separator "sep".
6432 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6433 * Return FAIL or OK.
6435 static int
6436 list_join(gap, l, sep, echo, copyID)
6437 garray_T *gap;
6438 list_T *l;
6439 char_u *sep;
6440 int echo;
6441 int copyID;
6443 int first = TRUE;
6444 char_u *tofree;
6445 char_u numbuf[NUMBUFLEN];
6446 listitem_T *item;
6447 char_u *s;
6449 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6451 if (first)
6452 first = FALSE;
6453 else
6454 ga_concat(gap, sep);
6456 if (echo)
6457 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6458 else
6459 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6460 if (s != NULL)
6461 ga_concat(gap, s);
6462 vim_free(tofree);
6463 if (s == NULL)
6464 return FAIL;
6466 return OK;
6470 * Garbage collection for lists and dictionaries.
6472 * We use reference counts to be able to free most items right away when they
6473 * are no longer used. But for composite items it's possible that it becomes
6474 * unused while the reference count is > 0: When there is a recursive
6475 * reference. Example:
6476 * :let l = [1, 2, 3]
6477 * :let d = {9: l}
6478 * :let l[1] = d
6480 * Since this is quite unusual we handle this with garbage collection: every
6481 * once in a while find out which lists and dicts are not referenced from any
6482 * variable.
6484 * Here is a good reference text about garbage collection (refers to Python
6485 * but it applies to all reference-counting mechanisms):
6486 * http://python.ca/nas/python/gc/
6490 * Do garbage collection for lists and dicts.
6491 * Return TRUE if some memory was freed.
6494 garbage_collect()
6496 dict_T *dd;
6497 list_T *ll;
6498 int copyID = ++current_copyID;
6499 buf_T *buf;
6500 win_T *wp;
6501 int i;
6502 funccall_T *fc, **pfc;
6503 int did_free = FALSE;
6504 #ifdef FEAT_WINDOWS
6505 tabpage_T *tp;
6506 #endif
6508 /* Only do this once. */
6509 want_garbage_collect = FALSE;
6510 may_garbage_collect = FALSE;
6511 garbage_collect_at_exit = FALSE;
6514 * 1. Go through all accessible variables and mark all lists and dicts
6515 * with copyID.
6517 /* script-local variables */
6518 for (i = 1; i <= ga_scripts.ga_len; ++i)
6519 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6521 /* buffer-local variables */
6522 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6523 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6525 /* window-local variables */
6526 FOR_ALL_TAB_WINDOWS(tp, wp)
6527 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6529 #ifdef FEAT_WINDOWS
6530 /* tabpage-local variables */
6531 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6532 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6533 #endif
6535 /* global variables */
6536 set_ref_in_ht(&globvarht, copyID);
6538 /* function-local variables */
6539 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6541 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6542 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6545 /* v: vars */
6546 set_ref_in_ht(&vimvarht, copyID);
6549 * 2. Go through the list of dicts and free items without the copyID.
6551 for (dd = first_dict; dd != NULL; )
6552 if (dd->dv_copyID != copyID)
6554 /* Free the Dictionary and ordinary items it contains, but don't
6555 * recurse into Lists and Dictionaries, they will be in the list
6556 * of dicts or list of lists. */
6557 dict_free(dd, FALSE);
6558 did_free = TRUE;
6560 /* restart, next dict may also have been freed */
6561 dd = first_dict;
6563 else
6564 dd = dd->dv_used_next;
6567 * 3. Go through the list of lists and free items without the copyID.
6568 * But don't free a list that has a watcher (used in a for loop), these
6569 * are not referenced anywhere.
6571 for (ll = first_list; ll != NULL; )
6572 if (ll->lv_copyID != copyID && ll->lv_watch == NULL)
6574 /* Free the List and ordinary items it contains, but don't recurse
6575 * into Lists and Dictionaries, they will be in the list of dicts
6576 * or list of lists. */
6577 list_free(ll, FALSE);
6578 did_free = TRUE;
6580 /* restart, next list may also have been freed */
6581 ll = first_list;
6583 else
6584 ll = ll->lv_used_next;
6586 /* check if any funccal can be freed now */
6587 for (pfc = &previous_funccal; *pfc != NULL; )
6589 if (can_free_funccal(*pfc, copyID))
6591 fc = *pfc;
6592 *pfc = fc->caller;
6593 free_funccal(fc, TRUE);
6594 did_free = TRUE;
6596 else
6597 pfc = &(*pfc)->caller;
6600 return did_free;
6604 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6606 static void
6607 set_ref_in_ht(ht, copyID)
6608 hashtab_T *ht;
6609 int copyID;
6611 int todo;
6612 hashitem_T *hi;
6614 todo = (int)ht->ht_used;
6615 for (hi = ht->ht_array; todo > 0; ++hi)
6616 if (!HASHITEM_EMPTY(hi))
6618 --todo;
6619 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6624 * Mark all lists and dicts referenced through list "l" with "copyID".
6626 static void
6627 set_ref_in_list(l, copyID)
6628 list_T *l;
6629 int copyID;
6631 listitem_T *li;
6633 for (li = l->lv_first; li != NULL; li = li->li_next)
6634 set_ref_in_item(&li->li_tv, copyID);
6638 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6640 static void
6641 set_ref_in_item(tv, copyID)
6642 typval_T *tv;
6643 int copyID;
6645 dict_T *dd;
6646 list_T *ll;
6648 switch (tv->v_type)
6650 case VAR_DICT:
6651 dd = tv->vval.v_dict;
6652 if (dd != NULL && dd->dv_copyID != copyID)
6654 /* Didn't see this dict yet. */
6655 dd->dv_copyID = copyID;
6656 set_ref_in_ht(&dd->dv_hashtab, copyID);
6658 break;
6660 case VAR_LIST:
6661 ll = tv->vval.v_list;
6662 if (ll != NULL && ll->lv_copyID != copyID)
6664 /* Didn't see this list yet. */
6665 ll->lv_copyID = copyID;
6666 set_ref_in_list(ll, copyID);
6668 break;
6670 return;
6674 * Allocate an empty header for a dictionary.
6676 dict_T *
6677 dict_alloc()
6679 dict_T *d;
6681 d = (dict_T *)alloc(sizeof(dict_T));
6682 if (d != NULL)
6684 /* Add the list to the list of dicts for garbage collection. */
6685 if (first_dict != NULL)
6686 first_dict->dv_used_prev = d;
6687 d->dv_used_next = first_dict;
6688 d->dv_used_prev = NULL;
6689 first_dict = d;
6691 hash_init(&d->dv_hashtab);
6692 d->dv_lock = 0;
6693 d->dv_refcount = 0;
6694 d->dv_copyID = 0;
6696 return d;
6700 * Unreference a Dictionary: decrement the reference count and free it when it
6701 * becomes zero.
6703 static void
6704 dict_unref(d)
6705 dict_T *d;
6707 if (d != NULL && --d->dv_refcount <= 0)
6708 dict_free(d, TRUE);
6712 * Free a Dictionary, including all items it contains.
6713 * Ignores the reference count.
6715 static void
6716 dict_free(d, recurse)
6717 dict_T *d;
6718 int recurse; /* Free Lists and Dictionaries recursively. */
6720 int todo;
6721 hashitem_T *hi;
6722 dictitem_T *di;
6724 /* Remove the dict from the list of dicts for garbage collection. */
6725 if (d->dv_used_prev == NULL)
6726 first_dict = d->dv_used_next;
6727 else
6728 d->dv_used_prev->dv_used_next = d->dv_used_next;
6729 if (d->dv_used_next != NULL)
6730 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6732 /* Lock the hashtab, we don't want it to resize while freeing items. */
6733 hash_lock(&d->dv_hashtab);
6734 todo = (int)d->dv_hashtab.ht_used;
6735 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6737 if (!HASHITEM_EMPTY(hi))
6739 /* Remove the item before deleting it, just in case there is
6740 * something recursive causing trouble. */
6741 di = HI2DI(hi);
6742 hash_remove(&d->dv_hashtab, hi);
6743 if (recurse || (di->di_tv.v_type != VAR_LIST
6744 && di->di_tv.v_type != VAR_DICT))
6745 clear_tv(&di->di_tv);
6746 vim_free(di);
6747 --todo;
6750 hash_clear(&d->dv_hashtab);
6751 vim_free(d);
6755 * Allocate a Dictionary item.
6756 * The "key" is copied to the new item.
6757 * Note that the value of the item "di_tv" still needs to be initialized!
6758 * Returns NULL when out of memory.
6760 static dictitem_T *
6761 dictitem_alloc(key)
6762 char_u *key;
6764 dictitem_T *di;
6766 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6767 if (di != NULL)
6769 STRCPY(di->di_key, key);
6770 di->di_flags = 0;
6772 return di;
6776 * Make a copy of a Dictionary item.
6778 static dictitem_T *
6779 dictitem_copy(org)
6780 dictitem_T *org;
6782 dictitem_T *di;
6784 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6785 + STRLEN(org->di_key)));
6786 if (di != NULL)
6788 STRCPY(di->di_key, org->di_key);
6789 di->di_flags = 0;
6790 copy_tv(&org->di_tv, &di->di_tv);
6792 return di;
6796 * Remove item "item" from Dictionary "dict" and free it.
6798 static void
6799 dictitem_remove(dict, item)
6800 dict_T *dict;
6801 dictitem_T *item;
6803 hashitem_T *hi;
6805 hi = hash_find(&dict->dv_hashtab, item->di_key);
6806 if (HASHITEM_EMPTY(hi))
6807 EMSG2(_(e_intern2), "dictitem_remove()");
6808 else
6809 hash_remove(&dict->dv_hashtab, hi);
6810 dictitem_free(item);
6814 * Free a dict item. Also clears the value.
6816 static void
6817 dictitem_free(item)
6818 dictitem_T *item;
6820 clear_tv(&item->di_tv);
6821 vim_free(item);
6825 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6826 * The refcount of the new dict is set to 1.
6827 * See item_copy() for "copyID".
6828 * Returns NULL when out of memory.
6830 static dict_T *
6831 dict_copy(orig, deep, copyID)
6832 dict_T *orig;
6833 int deep;
6834 int copyID;
6836 dict_T *copy;
6837 dictitem_T *di;
6838 int todo;
6839 hashitem_T *hi;
6841 if (orig == NULL)
6842 return NULL;
6844 copy = dict_alloc();
6845 if (copy != NULL)
6847 if (copyID != 0)
6849 orig->dv_copyID = copyID;
6850 orig->dv_copydict = copy;
6852 todo = (int)orig->dv_hashtab.ht_used;
6853 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6855 if (!HASHITEM_EMPTY(hi))
6857 --todo;
6859 di = dictitem_alloc(hi->hi_key);
6860 if (di == NULL)
6861 break;
6862 if (deep)
6864 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6865 copyID) == FAIL)
6867 vim_free(di);
6868 break;
6871 else
6872 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6873 if (dict_add(copy, di) == FAIL)
6875 dictitem_free(di);
6876 break;
6881 ++copy->dv_refcount;
6882 if (todo > 0)
6884 dict_unref(copy);
6885 copy = NULL;
6889 return copy;
6893 * Add item "item" to Dictionary "d".
6894 * Returns FAIL when out of memory and when key already existed.
6896 static int
6897 dict_add(d, item)
6898 dict_T *d;
6899 dictitem_T *item;
6901 return hash_add(&d->dv_hashtab, item->di_key);
6905 * Add a number or string entry to dictionary "d".
6906 * When "str" is NULL use number "nr", otherwise use "str".
6907 * Returns FAIL when out of memory and when key already exists.
6910 dict_add_nr_str(d, key, nr, str)
6911 dict_T *d;
6912 char *key;
6913 long nr;
6914 char_u *str;
6916 dictitem_T *item;
6918 item = dictitem_alloc((char_u *)key);
6919 if (item == NULL)
6920 return FAIL;
6921 item->di_tv.v_lock = 0;
6922 if (str == NULL)
6924 item->di_tv.v_type = VAR_NUMBER;
6925 item->di_tv.vval.v_number = nr;
6927 else
6929 item->di_tv.v_type = VAR_STRING;
6930 item->di_tv.vval.v_string = vim_strsave(str);
6932 if (dict_add(d, item) == FAIL)
6934 dictitem_free(item);
6935 return FAIL;
6937 return OK;
6941 * Get the number of items in a Dictionary.
6943 static long
6944 dict_len(d)
6945 dict_T *d;
6947 if (d == NULL)
6948 return 0L;
6949 return (long)d->dv_hashtab.ht_used;
6953 * Find item "key[len]" in Dictionary "d".
6954 * If "len" is negative use strlen(key).
6955 * Returns NULL when not found.
6957 static dictitem_T *
6958 dict_find(d, key, len)
6959 dict_T *d;
6960 char_u *key;
6961 int len;
6963 #define AKEYLEN 200
6964 char_u buf[AKEYLEN];
6965 char_u *akey;
6966 char_u *tofree = NULL;
6967 hashitem_T *hi;
6969 if (len < 0)
6970 akey = key;
6971 else if (len >= AKEYLEN)
6973 tofree = akey = vim_strnsave(key, len);
6974 if (akey == NULL)
6975 return NULL;
6977 else
6979 /* Avoid a malloc/free by using buf[]. */
6980 vim_strncpy(buf, key, len);
6981 akey = buf;
6984 hi = hash_find(&d->dv_hashtab, akey);
6985 vim_free(tofree);
6986 if (HASHITEM_EMPTY(hi))
6987 return NULL;
6988 return HI2DI(hi);
6992 * Get a string item from a dictionary.
6993 * When "save" is TRUE allocate memory for it.
6994 * Returns NULL if the entry doesn't exist or out of memory.
6996 char_u *
6997 get_dict_string(d, key, save)
6998 dict_T *d;
6999 char_u *key;
7000 int save;
7002 dictitem_T *di;
7003 char_u *s;
7005 di = dict_find(d, key, -1);
7006 if (di == NULL)
7007 return NULL;
7008 s = get_tv_string(&di->di_tv);
7009 if (save && s != NULL)
7010 s = vim_strsave(s);
7011 return s;
7015 * Get a number item from a dictionary.
7016 * Returns 0 if the entry doesn't exist or out of memory.
7018 long
7019 get_dict_number(d, key)
7020 dict_T *d;
7021 char_u *key;
7023 dictitem_T *di;
7025 di = dict_find(d, key, -1);
7026 if (di == NULL)
7027 return 0;
7028 return get_tv_number(&di->di_tv);
7032 * Return an allocated string with the string representation of a Dictionary.
7033 * May return NULL.
7035 static char_u *
7036 dict2string(tv, copyID)
7037 typval_T *tv;
7038 int copyID;
7040 garray_T ga;
7041 int first = TRUE;
7042 char_u *tofree;
7043 char_u numbuf[NUMBUFLEN];
7044 hashitem_T *hi;
7045 char_u *s;
7046 dict_T *d;
7047 int todo;
7049 if ((d = tv->vval.v_dict) == NULL)
7050 return NULL;
7051 ga_init2(&ga, (int)sizeof(char), 80);
7052 ga_append(&ga, '{');
7054 todo = (int)d->dv_hashtab.ht_used;
7055 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7057 if (!HASHITEM_EMPTY(hi))
7059 --todo;
7061 if (first)
7062 first = FALSE;
7063 else
7064 ga_concat(&ga, (char_u *)", ");
7066 tofree = string_quote(hi->hi_key, FALSE);
7067 if (tofree != NULL)
7069 ga_concat(&ga, tofree);
7070 vim_free(tofree);
7072 ga_concat(&ga, (char_u *)": ");
7073 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7074 if (s != NULL)
7075 ga_concat(&ga, s);
7076 vim_free(tofree);
7077 if (s == NULL)
7078 break;
7081 if (todo > 0)
7083 vim_free(ga.ga_data);
7084 return NULL;
7087 ga_append(&ga, '}');
7088 ga_append(&ga, NUL);
7089 return (char_u *)ga.ga_data;
7093 * Allocate a variable for a Dictionary and fill it from "*arg".
7094 * Return OK or FAIL. Returns NOTDONE for {expr}.
7096 static int
7097 get_dict_tv(arg, rettv, evaluate)
7098 char_u **arg;
7099 typval_T *rettv;
7100 int evaluate;
7102 dict_T *d = NULL;
7103 typval_T tvkey;
7104 typval_T tv;
7105 char_u *key = NULL;
7106 dictitem_T *item;
7107 char_u *start = skipwhite(*arg + 1);
7108 char_u buf[NUMBUFLEN];
7111 * First check if it's not a curly-braces thing: {expr}.
7112 * Must do this without evaluating, otherwise a function may be called
7113 * twice. Unfortunately this means we need to call eval1() twice for the
7114 * first item.
7115 * But {} is an empty Dictionary.
7117 if (*start != '}')
7119 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7120 return FAIL;
7121 if (*start == '}')
7122 return NOTDONE;
7125 if (evaluate)
7127 d = dict_alloc();
7128 if (d == NULL)
7129 return FAIL;
7131 tvkey.v_type = VAR_UNKNOWN;
7132 tv.v_type = VAR_UNKNOWN;
7134 *arg = skipwhite(*arg + 1);
7135 while (**arg != '}' && **arg != NUL)
7137 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7138 goto failret;
7139 if (**arg != ':')
7141 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7142 clear_tv(&tvkey);
7143 goto failret;
7145 if (evaluate)
7147 key = get_tv_string_buf_chk(&tvkey, buf);
7148 if (key == NULL || *key == NUL)
7150 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7151 if (key != NULL)
7152 EMSG(_(e_emptykey));
7153 clear_tv(&tvkey);
7154 goto failret;
7158 *arg = skipwhite(*arg + 1);
7159 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7161 if (evaluate)
7162 clear_tv(&tvkey);
7163 goto failret;
7165 if (evaluate)
7167 item = dict_find(d, key, -1);
7168 if (item != NULL)
7170 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7171 clear_tv(&tvkey);
7172 clear_tv(&tv);
7173 goto failret;
7175 item = dictitem_alloc(key);
7176 clear_tv(&tvkey);
7177 if (item != NULL)
7179 item->di_tv = tv;
7180 item->di_tv.v_lock = 0;
7181 if (dict_add(d, item) == FAIL)
7182 dictitem_free(item);
7186 if (**arg == '}')
7187 break;
7188 if (**arg != ',')
7190 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7191 goto failret;
7193 *arg = skipwhite(*arg + 1);
7196 if (**arg != '}')
7198 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7199 failret:
7200 if (evaluate)
7201 dict_free(d, TRUE);
7202 return FAIL;
7205 *arg = skipwhite(*arg + 1);
7206 if (evaluate)
7208 rettv->v_type = VAR_DICT;
7209 rettv->vval.v_dict = d;
7210 ++d->dv_refcount;
7213 return OK;
7217 * Return a string with the string representation of a variable.
7218 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7219 * "numbuf" is used for a number.
7220 * Does not put quotes around strings, as ":echo" displays values.
7221 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7222 * May return NULL.
7224 static char_u *
7225 echo_string(tv, tofree, numbuf, copyID)
7226 typval_T *tv;
7227 char_u **tofree;
7228 char_u *numbuf;
7229 int copyID;
7231 static int recurse = 0;
7232 char_u *r = NULL;
7234 if (recurse >= DICT_MAXNEST)
7236 EMSG(_("E724: variable nested too deep for displaying"));
7237 *tofree = NULL;
7238 return NULL;
7240 ++recurse;
7242 switch (tv->v_type)
7244 case VAR_FUNC:
7245 *tofree = NULL;
7246 r = tv->vval.v_string;
7247 break;
7249 case VAR_LIST:
7250 if (tv->vval.v_list == NULL)
7252 *tofree = NULL;
7253 r = NULL;
7255 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7257 *tofree = NULL;
7258 r = (char_u *)"[...]";
7260 else
7262 tv->vval.v_list->lv_copyID = copyID;
7263 *tofree = list2string(tv, copyID);
7264 r = *tofree;
7266 break;
7268 case VAR_DICT:
7269 if (tv->vval.v_dict == NULL)
7271 *tofree = NULL;
7272 r = NULL;
7274 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7276 *tofree = NULL;
7277 r = (char_u *)"{...}";
7279 else
7281 tv->vval.v_dict->dv_copyID = copyID;
7282 *tofree = dict2string(tv, copyID);
7283 r = *tofree;
7285 break;
7287 case VAR_STRING:
7288 case VAR_NUMBER:
7289 *tofree = NULL;
7290 r = get_tv_string_buf(tv, numbuf);
7291 break;
7293 #ifdef FEAT_FLOAT
7294 case VAR_FLOAT:
7295 *tofree = NULL;
7296 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7297 r = numbuf;
7298 break;
7299 #endif
7301 default:
7302 EMSG2(_(e_intern2), "echo_string()");
7303 *tofree = NULL;
7306 --recurse;
7307 return r;
7311 * Return a string with the string representation of a variable.
7312 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7313 * "numbuf" is used for a number.
7314 * Puts quotes around strings, so that they can be parsed back by eval().
7315 * May return NULL.
7317 static char_u *
7318 tv2string(tv, tofree, numbuf, copyID)
7319 typval_T *tv;
7320 char_u **tofree;
7321 char_u *numbuf;
7322 int copyID;
7324 switch (tv->v_type)
7326 case VAR_FUNC:
7327 *tofree = string_quote(tv->vval.v_string, TRUE);
7328 return *tofree;
7329 case VAR_STRING:
7330 *tofree = string_quote(tv->vval.v_string, FALSE);
7331 return *tofree;
7332 #ifdef FEAT_FLOAT
7333 case VAR_FLOAT:
7334 *tofree = NULL;
7335 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7336 return numbuf;
7337 #endif
7338 case VAR_NUMBER:
7339 case VAR_LIST:
7340 case VAR_DICT:
7341 break;
7342 default:
7343 EMSG2(_(e_intern2), "tv2string()");
7345 return echo_string(tv, tofree, numbuf, copyID);
7349 * Return string "str" in ' quotes, doubling ' characters.
7350 * If "str" is NULL an empty string is assumed.
7351 * If "function" is TRUE make it function('string').
7353 static char_u *
7354 string_quote(str, function)
7355 char_u *str;
7356 int function;
7358 unsigned len;
7359 char_u *p, *r, *s;
7361 len = (function ? 13 : 3);
7362 if (str != NULL)
7364 len += (unsigned)STRLEN(str);
7365 for (p = str; *p != NUL; mb_ptr_adv(p))
7366 if (*p == '\'')
7367 ++len;
7369 s = r = alloc(len);
7370 if (r != NULL)
7372 if (function)
7374 STRCPY(r, "function('");
7375 r += 10;
7377 else
7378 *r++ = '\'';
7379 if (str != NULL)
7380 for (p = str; *p != NUL; )
7382 if (*p == '\'')
7383 *r++ = '\'';
7384 MB_COPY_CHAR(p, r);
7386 *r++ = '\'';
7387 if (function)
7388 *r++ = ')';
7389 *r++ = NUL;
7391 return s;
7394 #ifdef FEAT_FLOAT
7396 * Convert the string "text" to a floating point number.
7397 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7398 * this always uses a decimal point.
7399 * Returns the length of the text that was consumed.
7401 static int
7402 string2float(text, value)
7403 char_u *text;
7404 float_T *value; /* result stored here */
7406 char *s = (char *)text;
7407 float_T f;
7409 f = strtod(s, &s);
7410 *value = f;
7411 return (int)((char_u *)s - text);
7413 #endif
7416 * Get the value of an environment variable.
7417 * "arg" is pointing to the '$'. It is advanced to after the name.
7418 * If the environment variable was not set, silently assume it is empty.
7419 * Always return OK.
7421 static int
7422 get_env_tv(arg, rettv, evaluate)
7423 char_u **arg;
7424 typval_T *rettv;
7425 int evaluate;
7427 char_u *string = NULL;
7428 int len;
7429 int cc;
7430 char_u *name;
7431 int mustfree = FALSE;
7433 ++*arg;
7434 name = *arg;
7435 len = get_env_len(arg);
7436 if (evaluate)
7438 if (len != 0)
7440 cc = name[len];
7441 name[len] = NUL;
7442 /* first try vim_getenv(), fast for normal environment vars */
7443 string = vim_getenv(name, &mustfree);
7444 if (string != NULL && *string != NUL)
7446 if (!mustfree)
7447 string = vim_strsave(string);
7449 else
7451 if (mustfree)
7452 vim_free(string);
7454 /* next try expanding things like $VIM and ${HOME} */
7455 string = expand_env_save(name - 1);
7456 if (string != NULL && *string == '$')
7458 vim_free(string);
7459 string = NULL;
7462 name[len] = cc;
7464 rettv->v_type = VAR_STRING;
7465 rettv->vval.v_string = string;
7468 return OK;
7472 * Array with names and number of arguments of all internal functions
7473 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7475 static struct fst
7477 char *f_name; /* function name */
7478 char f_min_argc; /* minimal number of arguments */
7479 char f_max_argc; /* maximal number of arguments */
7480 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7481 /* implementation of function */
7482 } functions[] =
7484 #ifdef FEAT_FLOAT
7485 {"abs", 1, 1, f_abs},
7486 #endif
7487 {"add", 2, 2, f_add},
7488 {"append", 2, 2, f_append},
7489 {"argc", 0, 0, f_argc},
7490 {"argidx", 0, 0, f_argidx},
7491 {"argv", 0, 1, f_argv},
7492 #ifdef FEAT_FLOAT
7493 {"atan", 1, 1, f_atan},
7494 #endif
7495 {"browse", 4, 4, f_browse},
7496 {"browsedir", 2, 2, f_browsedir},
7497 {"bufexists", 1, 1, f_bufexists},
7498 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7499 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7500 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7501 {"buflisted", 1, 1, f_buflisted},
7502 {"bufloaded", 1, 1, f_bufloaded},
7503 {"bufname", 1, 1, f_bufname},
7504 {"bufnr", 1, 2, f_bufnr},
7505 {"bufwinnr", 1, 1, f_bufwinnr},
7506 {"byte2line", 1, 1, f_byte2line},
7507 {"byteidx", 2, 2, f_byteidx},
7508 {"call", 2, 3, f_call},
7509 #ifdef FEAT_FLOAT
7510 {"ceil", 1, 1, f_ceil},
7511 #endif
7512 {"changenr", 0, 0, f_changenr},
7513 {"char2nr", 1, 1, f_char2nr},
7514 {"cindent", 1, 1, f_cindent},
7515 {"clearmatches", 0, 0, f_clearmatches},
7516 {"col", 1, 1, f_col},
7517 #if defined(FEAT_INS_EXPAND)
7518 {"complete", 2, 2, f_complete},
7519 {"complete_add", 1, 1, f_complete_add},
7520 {"complete_check", 0, 0, f_complete_check},
7521 #endif
7522 {"confirm", 1, 4, f_confirm},
7523 {"copy", 1, 1, f_copy},
7524 #ifdef FEAT_FLOAT
7525 {"cos", 1, 1, f_cos},
7526 #endif
7527 {"count", 2, 4, f_count},
7528 {"cscope_connection",0,3, f_cscope_connection},
7529 {"cursor", 1, 3, f_cursor},
7530 {"deepcopy", 1, 2, f_deepcopy},
7531 {"delete", 1, 1, f_delete},
7532 {"did_filetype", 0, 0, f_did_filetype},
7533 {"diff_filler", 1, 1, f_diff_filler},
7534 {"diff_hlID", 2, 2, f_diff_hlID},
7535 {"empty", 1, 1, f_empty},
7536 {"escape", 2, 2, f_escape},
7537 {"eval", 1, 1, f_eval},
7538 {"eventhandler", 0, 0, f_eventhandler},
7539 {"executable", 1, 1, f_executable},
7540 {"exists", 1, 1, f_exists},
7541 {"expand", 1, 2, f_expand},
7542 {"extend", 2, 3, f_extend},
7543 {"feedkeys", 1, 2, f_feedkeys},
7544 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7545 {"filereadable", 1, 1, f_filereadable},
7546 {"filewritable", 1, 1, f_filewritable},
7547 {"filter", 2, 2, f_filter},
7548 {"finddir", 1, 3, f_finddir},
7549 {"findfile", 1, 3, f_findfile},
7550 #ifdef FEAT_FLOAT
7551 {"float2nr", 1, 1, f_float2nr},
7552 {"floor", 1, 1, f_floor},
7553 #endif
7554 {"fnameescape", 1, 1, f_fnameescape},
7555 {"fnamemodify", 2, 2, f_fnamemodify},
7556 {"foldclosed", 1, 1, f_foldclosed},
7557 {"foldclosedend", 1, 1, f_foldclosedend},
7558 {"foldlevel", 1, 1, f_foldlevel},
7559 {"foldtext", 0, 0, f_foldtext},
7560 {"foldtextresult", 1, 1, f_foldtextresult},
7561 {"foreground", 0, 0, f_foreground},
7562 {"function", 1, 1, f_function},
7563 {"garbagecollect", 0, 1, f_garbagecollect},
7564 {"get", 2, 3, f_get},
7565 {"getbufline", 2, 3, f_getbufline},
7566 {"getbufvar", 2, 2, f_getbufvar},
7567 {"getchar", 0, 1, f_getchar},
7568 {"getcharmod", 0, 0, f_getcharmod},
7569 {"getcmdline", 0, 0, f_getcmdline},
7570 {"getcmdpos", 0, 0, f_getcmdpos},
7571 {"getcmdtype", 0, 0, f_getcmdtype},
7572 {"getcwd", 0, 0, f_getcwd},
7573 {"getfontname", 0, 1, f_getfontname},
7574 {"getfperm", 1, 1, f_getfperm},
7575 {"getfsize", 1, 1, f_getfsize},
7576 {"getftime", 1, 1, f_getftime},
7577 {"getftype", 1, 1, f_getftype},
7578 {"getline", 1, 2, f_getline},
7579 {"getloclist", 1, 1, f_getqflist},
7580 {"getmatches", 0, 0, f_getmatches},
7581 {"getpid", 0, 0, f_getpid},
7582 {"getpos", 1, 1, f_getpos},
7583 {"getqflist", 0, 0, f_getqflist},
7584 {"getreg", 0, 2, f_getreg},
7585 {"getregtype", 0, 1, f_getregtype},
7586 {"gettabwinvar", 3, 3, f_gettabwinvar},
7587 {"getwinposx", 0, 0, f_getwinposx},
7588 {"getwinposy", 0, 0, f_getwinposy},
7589 {"getwinvar", 2, 2, f_getwinvar},
7590 {"glob", 1, 2, f_glob},
7591 {"globpath", 2, 3, f_globpath},
7592 {"has", 1, 1, f_has},
7593 {"has_key", 2, 2, f_has_key},
7594 {"haslocaldir", 0, 0, f_haslocaldir},
7595 {"hasmapto", 1, 3, f_hasmapto},
7596 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7597 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7598 {"histadd", 2, 2, f_histadd},
7599 {"histdel", 1, 2, f_histdel},
7600 {"histget", 1, 2, f_histget},
7601 {"histnr", 1, 1, f_histnr},
7602 {"hlID", 1, 1, f_hlID},
7603 {"hlexists", 1, 1, f_hlexists},
7604 {"hostname", 0, 0, f_hostname},
7605 {"iconv", 3, 3, f_iconv},
7606 {"indent", 1, 1, f_indent},
7607 {"index", 2, 4, f_index},
7608 {"input", 1, 3, f_input},
7609 {"inputdialog", 1, 3, f_inputdialog},
7610 {"inputlist", 1, 1, f_inputlist},
7611 {"inputrestore", 0, 0, f_inputrestore},
7612 {"inputsave", 0, 0, f_inputsave},
7613 {"inputsecret", 1, 2, f_inputsecret},
7614 {"insert", 2, 3, f_insert},
7615 {"isdirectory", 1, 1, f_isdirectory},
7616 {"islocked", 1, 1, f_islocked},
7617 {"items", 1, 1, f_items},
7618 {"join", 1, 2, f_join},
7619 {"keys", 1, 1, f_keys},
7620 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7621 {"len", 1, 1, f_len},
7622 {"libcall", 3, 3, f_libcall},
7623 {"libcallnr", 3, 3, f_libcallnr},
7624 {"line", 1, 1, f_line},
7625 {"line2byte", 1, 1, f_line2byte},
7626 {"lispindent", 1, 1, f_lispindent},
7627 {"localtime", 0, 0, f_localtime},
7628 #ifdef FEAT_FLOAT
7629 {"log10", 1, 1, f_log10},
7630 #endif
7631 {"map", 2, 2, f_map},
7632 {"maparg", 1, 3, f_maparg},
7633 {"mapcheck", 1, 3, f_mapcheck},
7634 {"match", 2, 4, f_match},
7635 {"matchadd", 2, 4, f_matchadd},
7636 {"matcharg", 1, 1, f_matcharg},
7637 {"matchdelete", 1, 1, f_matchdelete},
7638 {"matchend", 2, 4, f_matchend},
7639 {"matchlist", 2, 4, f_matchlist},
7640 {"matchstr", 2, 4, f_matchstr},
7641 {"max", 1, 1, f_max},
7642 {"min", 1, 1, f_min},
7643 #ifdef vim_mkdir
7644 {"mkdir", 1, 3, f_mkdir},
7645 #endif
7646 {"mode", 0, 1, f_mode},
7647 {"nextnonblank", 1, 1, f_nextnonblank},
7648 {"nr2char", 1, 1, f_nr2char},
7649 {"pathshorten", 1, 1, f_pathshorten},
7650 #ifdef FEAT_FLOAT
7651 {"pow", 2, 2, f_pow},
7652 #endif
7653 {"prevnonblank", 1, 1, f_prevnonblank},
7654 {"printf", 2, 19, f_printf},
7655 {"pumvisible", 0, 0, f_pumvisible},
7656 {"range", 1, 3, f_range},
7657 {"readfile", 1, 3, f_readfile},
7658 {"reltime", 0, 2, f_reltime},
7659 {"reltimestr", 1, 1, f_reltimestr},
7660 {"remote_expr", 2, 3, f_remote_expr},
7661 {"remote_foreground", 1, 1, f_remote_foreground},
7662 {"remote_peek", 1, 2, f_remote_peek},
7663 {"remote_read", 1, 1, f_remote_read},
7664 {"remote_send", 2, 3, f_remote_send},
7665 {"remove", 2, 3, f_remove},
7666 {"rename", 2, 2, f_rename},
7667 {"repeat", 2, 2, f_repeat},
7668 {"resolve", 1, 1, f_resolve},
7669 {"reverse", 1, 1, f_reverse},
7670 #ifdef FEAT_FLOAT
7671 {"round", 1, 1, f_round},
7672 #endif
7673 {"search", 1, 4, f_search},
7674 {"searchdecl", 1, 3, f_searchdecl},
7675 {"searchpair", 3, 7, f_searchpair},
7676 {"searchpairpos", 3, 7, f_searchpairpos},
7677 {"searchpos", 1, 4, f_searchpos},
7678 {"server2client", 2, 2, f_server2client},
7679 {"serverlist", 0, 0, f_serverlist},
7680 {"setbufvar", 3, 3, f_setbufvar},
7681 {"setcmdpos", 1, 1, f_setcmdpos},
7682 {"setline", 2, 2, f_setline},
7683 {"setloclist", 2, 3, f_setloclist},
7684 {"setmatches", 1, 1, f_setmatches},
7685 {"setpos", 2, 2, f_setpos},
7686 {"setqflist", 1, 2, f_setqflist},
7687 {"setreg", 2, 3, f_setreg},
7688 {"settabwinvar", 4, 4, f_settabwinvar},
7689 {"setwinvar", 3, 3, f_setwinvar},
7690 {"shellescape", 1, 2, f_shellescape},
7691 {"simplify", 1, 1, f_simplify},
7692 #ifdef FEAT_FLOAT
7693 {"sin", 1, 1, f_sin},
7694 #endif
7695 {"sort", 1, 2, f_sort},
7696 {"soundfold", 1, 1, f_soundfold},
7697 {"spellbadword", 0, 1, f_spellbadword},
7698 {"spellsuggest", 1, 3, f_spellsuggest},
7699 {"split", 1, 3, f_split},
7700 #ifdef FEAT_FLOAT
7701 {"sqrt", 1, 1, f_sqrt},
7702 {"str2float", 1, 1, f_str2float},
7703 #endif
7704 {"str2nr", 1, 2, f_str2nr},
7705 #ifdef HAVE_STRFTIME
7706 {"strftime", 1, 2, f_strftime},
7707 #endif
7708 {"stridx", 2, 3, f_stridx},
7709 {"string", 1, 1, f_string},
7710 {"strlen", 1, 1, f_strlen},
7711 {"strpart", 2, 3, f_strpart},
7712 {"strridx", 2, 3, f_strridx},
7713 {"strtrans", 1, 1, f_strtrans},
7714 {"submatch", 1, 1, f_submatch},
7715 {"substitute", 4, 4, f_substitute},
7716 {"synID", 3, 3, f_synID},
7717 {"synIDattr", 2, 3, f_synIDattr},
7718 {"synIDtrans", 1, 1, f_synIDtrans},
7719 {"synstack", 2, 2, f_synstack},
7720 {"system", 1, 2, f_system},
7721 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7722 {"tabpagenr", 0, 1, f_tabpagenr},
7723 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7724 {"tagfiles", 0, 0, f_tagfiles},
7725 {"taglist", 1, 1, f_taglist},
7726 {"tempname", 0, 0, f_tempname},
7727 {"test", 1, 1, f_test},
7728 {"tolower", 1, 1, f_tolower},
7729 {"toupper", 1, 1, f_toupper},
7730 {"tr", 3, 3, f_tr},
7731 #ifdef FEAT_FLOAT
7732 {"trunc", 1, 1, f_trunc},
7733 #endif
7734 {"type", 1, 1, f_type},
7735 {"values", 1, 1, f_values},
7736 {"virtcol", 1, 1, f_virtcol},
7737 {"visualmode", 0, 1, f_visualmode},
7738 {"winbufnr", 1, 1, f_winbufnr},
7739 {"wincol", 0, 0, f_wincol},
7740 {"winheight", 1, 1, f_winheight},
7741 {"winline", 0, 0, f_winline},
7742 {"winnr", 0, 1, f_winnr},
7743 {"winrestcmd", 0, 0, f_winrestcmd},
7744 {"winrestview", 1, 1, f_winrestview},
7745 {"winsaveview", 0, 0, f_winsaveview},
7746 {"winwidth", 1, 1, f_winwidth},
7747 {"writefile", 2, 3, f_writefile},
7750 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7753 * Function given to ExpandGeneric() to obtain the list of internal
7754 * or user defined function names.
7756 char_u *
7757 get_function_name(xp, idx)
7758 expand_T *xp;
7759 int idx;
7761 static int intidx = -1;
7762 char_u *name;
7764 if (idx == 0)
7765 intidx = -1;
7766 if (intidx < 0)
7768 name = get_user_func_name(xp, idx);
7769 if (name != NULL)
7770 return name;
7772 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7774 STRCPY(IObuff, functions[intidx].f_name);
7775 STRCAT(IObuff, "(");
7776 if (functions[intidx].f_max_argc == 0)
7777 STRCAT(IObuff, ")");
7778 return IObuff;
7781 return NULL;
7785 * Function given to ExpandGeneric() to obtain the list of internal or
7786 * user defined variable or function names.
7788 /*ARGSUSED*/
7789 char_u *
7790 get_expr_name(xp, idx)
7791 expand_T *xp;
7792 int idx;
7794 static int intidx = -1;
7795 char_u *name;
7797 if (idx == 0)
7798 intidx = -1;
7799 if (intidx < 0)
7801 name = get_function_name(xp, idx);
7802 if (name != NULL)
7803 return name;
7805 return get_user_var_name(xp, ++intidx);
7808 #endif /* FEAT_CMDL_COMPL */
7811 * Find internal function in table above.
7812 * Return index, or -1 if not found
7814 static int
7815 find_internal_func(name)
7816 char_u *name; /* name of the function */
7818 int first = 0;
7819 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7820 int cmp;
7821 int x;
7824 * Find the function name in the table. Binary search.
7826 while (first <= last)
7828 x = first + ((unsigned)(last - first) >> 1);
7829 cmp = STRCMP(name, functions[x].f_name);
7830 if (cmp < 0)
7831 last = x - 1;
7832 else if (cmp > 0)
7833 first = x + 1;
7834 else
7835 return x;
7837 return -1;
7841 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7842 * name it contains, otherwise return "name".
7844 static char_u *
7845 deref_func_name(name, lenp)
7846 char_u *name;
7847 int *lenp;
7849 dictitem_T *v;
7850 int cc;
7852 cc = name[*lenp];
7853 name[*lenp] = NUL;
7854 v = find_var(name, NULL);
7855 name[*lenp] = cc;
7856 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7858 if (v->di_tv.vval.v_string == NULL)
7860 *lenp = 0;
7861 return (char_u *)""; /* just in case */
7863 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7864 return v->di_tv.vval.v_string;
7867 return name;
7871 * Allocate a variable for the result of a function.
7872 * Return OK or FAIL.
7874 static int
7875 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7876 evaluate, selfdict)
7877 char_u *name; /* name of the function */
7878 int len; /* length of "name" */
7879 typval_T *rettv;
7880 char_u **arg; /* argument, pointing to the '(' */
7881 linenr_T firstline; /* first line of range */
7882 linenr_T lastline; /* last line of range */
7883 int *doesrange; /* return: function handled range */
7884 int evaluate;
7885 dict_T *selfdict; /* Dictionary for "self" */
7887 char_u *argp;
7888 int ret = OK;
7889 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7890 int argcount = 0; /* number of arguments found */
7893 * Get the arguments.
7895 argp = *arg;
7896 while (argcount < MAX_FUNC_ARGS)
7898 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7899 if (*argp == ')' || *argp == ',' || *argp == NUL)
7900 break;
7901 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7903 ret = FAIL;
7904 break;
7906 ++argcount;
7907 if (*argp != ',')
7908 break;
7910 if (*argp == ')')
7911 ++argp;
7912 else
7913 ret = FAIL;
7915 if (ret == OK)
7916 ret = call_func(name, len, rettv, argcount, argvars,
7917 firstline, lastline, doesrange, evaluate, selfdict);
7918 else if (!aborting())
7920 if (argcount == MAX_FUNC_ARGS)
7921 emsg_funcname("E740: Too many arguments for function %s", name);
7922 else
7923 emsg_funcname("E116: Invalid arguments for function %s", name);
7926 while (--argcount >= 0)
7927 clear_tv(&argvars[argcount]);
7929 *arg = skipwhite(argp);
7930 return ret;
7935 * Call a function with its resolved parameters
7936 * Return OK when the function can't be called, FAIL otherwise.
7937 * Also returns OK when an error was encountered while executing the function.
7939 static int
7940 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7941 doesrange, evaluate, selfdict)
7942 char_u *name; /* name of the function */
7943 int len; /* length of "name" */
7944 typval_T *rettv; /* return value goes here */
7945 int argcount; /* number of "argvars" */
7946 typval_T *argvars; /* vars for arguments, must have "argcount"
7947 PLUS ONE elements! */
7948 linenr_T firstline; /* first line of range */
7949 linenr_T lastline; /* last line of range */
7950 int *doesrange; /* return: function handled range */
7951 int evaluate;
7952 dict_T *selfdict; /* Dictionary for "self" */
7954 int ret = FAIL;
7955 #define ERROR_UNKNOWN 0
7956 #define ERROR_TOOMANY 1
7957 #define ERROR_TOOFEW 2
7958 #define ERROR_SCRIPT 3
7959 #define ERROR_DICT 4
7960 #define ERROR_NONE 5
7961 #define ERROR_OTHER 6
7962 int error = ERROR_NONE;
7963 int i;
7964 int llen;
7965 ufunc_T *fp;
7966 int cc;
7967 #define FLEN_FIXED 40
7968 char_u fname_buf[FLEN_FIXED + 1];
7969 char_u *fname;
7972 * In a script change <SID>name() and s:name() to K_SNR 123_name().
7973 * Change <SNR>123_name() to K_SNR 123_name().
7974 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
7976 cc = name[len];
7977 name[len] = NUL;
7978 llen = eval_fname_script(name);
7979 if (llen > 0)
7981 fname_buf[0] = K_SPECIAL;
7982 fname_buf[1] = KS_EXTRA;
7983 fname_buf[2] = (int)KE_SNR;
7984 i = 3;
7985 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
7987 if (current_SID <= 0)
7988 error = ERROR_SCRIPT;
7989 else
7991 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
7992 i = (int)STRLEN(fname_buf);
7995 if (i + STRLEN(name + llen) < FLEN_FIXED)
7997 STRCPY(fname_buf + i, name + llen);
7998 fname = fname_buf;
8000 else
8002 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8003 if (fname == NULL)
8004 error = ERROR_OTHER;
8005 else
8007 mch_memmove(fname, fname_buf, (size_t)i);
8008 STRCPY(fname + i, name + llen);
8012 else
8013 fname = name;
8015 *doesrange = FALSE;
8018 /* execute the function if no errors detected and executing */
8019 if (evaluate && error == ERROR_NONE)
8021 rettv->v_type = VAR_NUMBER; /* default is number rettv */
8022 error = ERROR_UNKNOWN;
8024 if (!builtin_function(fname))
8027 * User defined function.
8029 fp = find_func(fname);
8031 #ifdef FEAT_AUTOCMD
8032 /* Trigger FuncUndefined event, may load the function. */
8033 if (fp == NULL
8034 && apply_autocmds(EVENT_FUNCUNDEFINED,
8035 fname, fname, TRUE, NULL)
8036 && !aborting())
8038 /* executed an autocommand, search for the function again */
8039 fp = find_func(fname);
8041 #endif
8042 /* Try loading a package. */
8043 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8045 /* loaded a package, search for the function again */
8046 fp = find_func(fname);
8049 if (fp != NULL)
8051 if (fp->uf_flags & FC_RANGE)
8052 *doesrange = TRUE;
8053 if (argcount < fp->uf_args.ga_len)
8054 error = ERROR_TOOFEW;
8055 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8056 error = ERROR_TOOMANY;
8057 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8058 error = ERROR_DICT;
8059 else
8062 * Call the user function.
8063 * Save and restore search patterns, script variables and
8064 * redo buffer.
8066 save_search_patterns();
8067 saveRedobuff();
8068 ++fp->uf_calls;
8069 call_user_func(fp, argcount, argvars, rettv,
8070 firstline, lastline,
8071 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8072 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8073 && fp->uf_refcount <= 0)
8074 /* Function was unreferenced while being used, free it
8075 * now. */
8076 func_free(fp);
8077 restoreRedobuff();
8078 restore_search_patterns();
8079 error = ERROR_NONE;
8083 else
8086 * Find the function name in the table, call its implementation.
8088 i = find_internal_func(fname);
8089 if (i >= 0)
8091 if (argcount < functions[i].f_min_argc)
8092 error = ERROR_TOOFEW;
8093 else if (argcount > functions[i].f_max_argc)
8094 error = ERROR_TOOMANY;
8095 else
8097 argvars[argcount].v_type = VAR_UNKNOWN;
8098 functions[i].f_func(argvars, rettv);
8099 error = ERROR_NONE;
8104 * The function call (or "FuncUndefined" autocommand sequence) might
8105 * have been aborted by an error, an interrupt, or an explicitly thrown
8106 * exception that has not been caught so far. This situation can be
8107 * tested for by calling aborting(). For an error in an internal
8108 * function or for the "E132" error in call_user_func(), however, the
8109 * throw point at which the "force_abort" flag (temporarily reset by
8110 * emsg()) is normally updated has not been reached yet. We need to
8111 * update that flag first to make aborting() reliable.
8113 update_force_abort();
8115 if (error == ERROR_NONE)
8116 ret = OK;
8119 * Report an error unless the argument evaluation or function call has been
8120 * cancelled due to an aborting error, an interrupt, or an exception.
8122 if (!aborting())
8124 switch (error)
8126 case ERROR_UNKNOWN:
8127 emsg_funcname(N_("E117: Unknown function: %s"), name);
8128 break;
8129 case ERROR_TOOMANY:
8130 emsg_funcname(e_toomanyarg, name);
8131 break;
8132 case ERROR_TOOFEW:
8133 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8134 name);
8135 break;
8136 case ERROR_SCRIPT:
8137 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8138 name);
8139 break;
8140 case ERROR_DICT:
8141 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8142 name);
8143 break;
8147 name[len] = cc;
8148 if (fname != name && fname != fname_buf)
8149 vim_free(fname);
8151 return ret;
8155 * Give an error message with a function name. Handle <SNR> things.
8157 static void
8158 emsg_funcname(ermsg, name)
8159 char *ermsg;
8160 char_u *name;
8162 char_u *p;
8164 if (*name == K_SPECIAL)
8165 p = concat_str((char_u *)"<SNR>", name + 3);
8166 else
8167 p = name;
8168 EMSG2(_(ermsg), p);
8169 if (p != name)
8170 vim_free(p);
8174 * Return TRUE for a non-zero Number and a non-empty String.
8176 static int
8177 non_zero_arg(argvars)
8178 typval_T *argvars;
8180 return ((argvars[0].v_type == VAR_NUMBER
8181 && argvars[0].vval.v_number != 0)
8182 || (argvars[0].v_type == VAR_STRING
8183 && argvars[0].vval.v_string != NULL
8184 && *argvars[0].vval.v_string != NUL));
8187 /*********************************************
8188 * Implementation of the built-in functions
8191 #ifdef FEAT_FLOAT
8193 * "abs(expr)" function
8195 static void
8196 f_abs(argvars, rettv)
8197 typval_T *argvars;
8198 typval_T *rettv;
8200 if (argvars[0].v_type == VAR_FLOAT)
8202 rettv->v_type = VAR_FLOAT;
8203 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8205 else
8207 varnumber_T n;
8208 int error = FALSE;
8210 n = get_tv_number_chk(&argvars[0], &error);
8211 if (error)
8212 rettv->vval.v_number = -1;
8213 else if (n > 0)
8214 rettv->vval.v_number = n;
8215 else
8216 rettv->vval.v_number = -n;
8219 #endif
8222 * "add(list, item)" function
8224 static void
8225 f_add(argvars, rettv)
8226 typval_T *argvars;
8227 typval_T *rettv;
8229 list_T *l;
8231 rettv->vval.v_number = 1; /* Default: Failed */
8232 if (argvars[0].v_type == VAR_LIST)
8234 if ((l = argvars[0].vval.v_list) != NULL
8235 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8236 && list_append_tv(l, &argvars[1]) == OK)
8237 copy_tv(&argvars[0], rettv);
8239 else
8240 EMSG(_(e_listreq));
8244 * "append(lnum, string/list)" function
8246 static void
8247 f_append(argvars, rettv)
8248 typval_T *argvars;
8249 typval_T *rettv;
8251 long lnum;
8252 char_u *line;
8253 list_T *l = NULL;
8254 listitem_T *li = NULL;
8255 typval_T *tv;
8256 long added = 0;
8258 lnum = get_tv_lnum(argvars);
8259 if (lnum >= 0
8260 && lnum <= curbuf->b_ml.ml_line_count
8261 && u_save(lnum, lnum + 1) == OK)
8263 if (argvars[1].v_type == VAR_LIST)
8265 l = argvars[1].vval.v_list;
8266 if (l == NULL)
8267 return;
8268 li = l->lv_first;
8270 rettv->vval.v_number = 0; /* Default: Success */
8271 for (;;)
8273 if (l == NULL)
8274 tv = &argvars[1]; /* append a string */
8275 else if (li == NULL)
8276 break; /* end of list */
8277 else
8278 tv = &li->li_tv; /* append item from list */
8279 line = get_tv_string_chk(tv);
8280 if (line == NULL) /* type error */
8282 rettv->vval.v_number = 1; /* Failed */
8283 break;
8285 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8286 ++added;
8287 if (l == NULL)
8288 break;
8289 li = li->li_next;
8292 appended_lines_mark(lnum, added);
8293 if (curwin->w_cursor.lnum > lnum)
8294 curwin->w_cursor.lnum += added;
8296 else
8297 rettv->vval.v_number = 1; /* Failed */
8301 * "argc()" function
8303 /* ARGSUSED */
8304 static void
8305 f_argc(argvars, rettv)
8306 typval_T *argvars;
8307 typval_T *rettv;
8309 rettv->vval.v_number = ARGCOUNT;
8313 * "argidx()" function
8315 /* ARGSUSED */
8316 static void
8317 f_argidx(argvars, rettv)
8318 typval_T *argvars;
8319 typval_T *rettv;
8321 rettv->vval.v_number = curwin->w_arg_idx;
8325 * "argv(nr)" function
8327 static void
8328 f_argv(argvars, rettv)
8329 typval_T *argvars;
8330 typval_T *rettv;
8332 int idx;
8334 if (argvars[0].v_type != VAR_UNKNOWN)
8336 idx = get_tv_number_chk(&argvars[0], NULL);
8337 if (idx >= 0 && idx < ARGCOUNT)
8338 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8339 else
8340 rettv->vval.v_string = NULL;
8341 rettv->v_type = VAR_STRING;
8343 else if (rettv_list_alloc(rettv) == OK)
8344 for (idx = 0; idx < ARGCOUNT; ++idx)
8345 list_append_string(rettv->vval.v_list,
8346 alist_name(&ARGLIST[idx]), -1);
8349 #ifdef FEAT_FLOAT
8350 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8353 * Get the float value of "argvars[0]" into "f".
8354 * Returns FAIL when the argument is not a Number or Float.
8356 static int
8357 get_float_arg(argvars, f)
8358 typval_T *argvars;
8359 float_T *f;
8361 if (argvars[0].v_type == VAR_FLOAT)
8363 *f = argvars[0].vval.v_float;
8364 return OK;
8366 if (argvars[0].v_type == VAR_NUMBER)
8368 *f = (float_T)argvars[0].vval.v_number;
8369 return OK;
8371 EMSG(_("E808: Number or Float required"));
8372 return FAIL;
8376 * "atan()" function
8378 static void
8379 f_atan(argvars, rettv)
8380 typval_T *argvars;
8381 typval_T *rettv;
8383 float_T f;
8385 rettv->v_type = VAR_FLOAT;
8386 if (get_float_arg(argvars, &f) == OK)
8387 rettv->vval.v_float = atan(f);
8388 else
8389 rettv->vval.v_float = 0.0;
8391 #endif
8394 * "browse(save, title, initdir, default)" function
8396 /* ARGSUSED */
8397 static void
8398 f_browse(argvars, rettv)
8399 typval_T *argvars;
8400 typval_T *rettv;
8402 #ifdef FEAT_BROWSE
8403 int save;
8404 char_u *title;
8405 char_u *initdir;
8406 char_u *defname;
8407 char_u buf[NUMBUFLEN];
8408 char_u buf2[NUMBUFLEN];
8409 int error = FALSE;
8411 save = get_tv_number_chk(&argvars[0], &error);
8412 title = get_tv_string_chk(&argvars[1]);
8413 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8414 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8416 if (error || title == NULL || initdir == NULL || defname == NULL)
8417 rettv->vval.v_string = NULL;
8418 else
8419 rettv->vval.v_string =
8420 do_browse(save ? BROWSE_SAVE : 0,
8421 title, defname, NULL, initdir, NULL, curbuf);
8422 #else
8423 rettv->vval.v_string = NULL;
8424 #endif
8425 rettv->v_type = VAR_STRING;
8429 * "browsedir(title, initdir)" function
8431 /* ARGSUSED */
8432 static void
8433 f_browsedir(argvars, rettv)
8434 typval_T *argvars;
8435 typval_T *rettv;
8437 #ifdef FEAT_BROWSE
8438 char_u *title;
8439 char_u *initdir;
8440 char_u buf[NUMBUFLEN];
8442 title = get_tv_string_chk(&argvars[0]);
8443 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8445 if (title == NULL || initdir == NULL)
8446 rettv->vval.v_string = NULL;
8447 else
8448 rettv->vval.v_string = do_browse(BROWSE_DIR,
8449 title, NULL, NULL, initdir, NULL, curbuf);
8450 #else
8451 rettv->vval.v_string = NULL;
8452 #endif
8453 rettv->v_type = VAR_STRING;
8456 static buf_T *find_buffer __ARGS((typval_T *avar));
8459 * Find a buffer by number or exact name.
8461 static buf_T *
8462 find_buffer(avar)
8463 typval_T *avar;
8465 buf_T *buf = NULL;
8467 if (avar->v_type == VAR_NUMBER)
8468 buf = buflist_findnr((int)avar->vval.v_number);
8469 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8471 buf = buflist_findname_exp(avar->vval.v_string);
8472 if (buf == NULL)
8474 /* No full path name match, try a match with a URL or a "nofile"
8475 * buffer, these don't use the full path. */
8476 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8477 if (buf->b_fname != NULL
8478 && (path_with_url(buf->b_fname)
8479 #ifdef FEAT_QUICKFIX
8480 || bt_nofile(buf)
8481 #endif
8483 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8484 break;
8487 return buf;
8491 * "bufexists(expr)" function
8493 static void
8494 f_bufexists(argvars, rettv)
8495 typval_T *argvars;
8496 typval_T *rettv;
8498 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8502 * "buflisted(expr)" function
8504 static void
8505 f_buflisted(argvars, rettv)
8506 typval_T *argvars;
8507 typval_T *rettv;
8509 buf_T *buf;
8511 buf = find_buffer(&argvars[0]);
8512 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8516 * "bufloaded(expr)" function
8518 static void
8519 f_bufloaded(argvars, rettv)
8520 typval_T *argvars;
8521 typval_T *rettv;
8523 buf_T *buf;
8525 buf = find_buffer(&argvars[0]);
8526 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8529 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8532 * Get buffer by number or pattern.
8534 static buf_T *
8535 get_buf_tv(tv)
8536 typval_T *tv;
8538 char_u *name = tv->vval.v_string;
8539 int save_magic;
8540 char_u *save_cpo;
8541 buf_T *buf;
8543 if (tv->v_type == VAR_NUMBER)
8544 return buflist_findnr((int)tv->vval.v_number);
8545 if (tv->v_type != VAR_STRING)
8546 return NULL;
8547 if (name == NULL || *name == NUL)
8548 return curbuf;
8549 if (name[0] == '$' && name[1] == NUL)
8550 return lastbuf;
8552 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8553 save_magic = p_magic;
8554 p_magic = TRUE;
8555 save_cpo = p_cpo;
8556 p_cpo = (char_u *)"";
8558 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8559 TRUE, FALSE));
8561 p_magic = save_magic;
8562 p_cpo = save_cpo;
8564 /* If not found, try expanding the name, like done for bufexists(). */
8565 if (buf == NULL)
8566 buf = find_buffer(tv);
8568 return buf;
8572 * "bufname(expr)" function
8574 static void
8575 f_bufname(argvars, rettv)
8576 typval_T *argvars;
8577 typval_T *rettv;
8579 buf_T *buf;
8581 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8582 ++emsg_off;
8583 buf = get_buf_tv(&argvars[0]);
8584 rettv->v_type = VAR_STRING;
8585 if (buf != NULL && buf->b_fname != NULL)
8586 rettv->vval.v_string = vim_strsave(buf->b_fname);
8587 else
8588 rettv->vval.v_string = NULL;
8589 --emsg_off;
8593 * "bufnr(expr)" function
8595 static void
8596 f_bufnr(argvars, rettv)
8597 typval_T *argvars;
8598 typval_T *rettv;
8600 buf_T *buf;
8601 int error = FALSE;
8602 char_u *name;
8604 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8605 ++emsg_off;
8606 buf = get_buf_tv(&argvars[0]);
8607 --emsg_off;
8609 /* If the buffer isn't found and the second argument is not zero create a
8610 * new buffer. */
8611 if (buf == NULL
8612 && argvars[1].v_type != VAR_UNKNOWN
8613 && get_tv_number_chk(&argvars[1], &error) != 0
8614 && !error
8615 && (name = get_tv_string_chk(&argvars[0])) != NULL
8616 && !error)
8617 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8619 if (buf != NULL)
8620 rettv->vval.v_number = buf->b_fnum;
8621 else
8622 rettv->vval.v_number = -1;
8626 * "bufwinnr(nr)" function
8628 static void
8629 f_bufwinnr(argvars, rettv)
8630 typval_T *argvars;
8631 typval_T *rettv;
8633 #ifdef FEAT_WINDOWS
8634 win_T *wp;
8635 int winnr = 0;
8636 #endif
8637 buf_T *buf;
8639 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8640 ++emsg_off;
8641 buf = get_buf_tv(&argvars[0]);
8642 #ifdef FEAT_WINDOWS
8643 for (wp = firstwin; wp; wp = wp->w_next)
8645 ++winnr;
8646 if (wp->w_buffer == buf)
8647 break;
8649 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8650 #else
8651 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8652 #endif
8653 --emsg_off;
8657 * "byte2line(byte)" function
8659 /*ARGSUSED*/
8660 static void
8661 f_byte2line(argvars, rettv)
8662 typval_T *argvars;
8663 typval_T *rettv;
8665 #ifndef FEAT_BYTEOFF
8666 rettv->vval.v_number = -1;
8667 #else
8668 long boff = 0;
8670 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8671 if (boff < 0)
8672 rettv->vval.v_number = -1;
8673 else
8674 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8675 (linenr_T)0, &boff);
8676 #endif
8680 * "byteidx()" function
8682 /*ARGSUSED*/
8683 static void
8684 f_byteidx(argvars, rettv)
8685 typval_T *argvars;
8686 typval_T *rettv;
8688 #ifdef FEAT_MBYTE
8689 char_u *t;
8690 #endif
8691 char_u *str;
8692 long idx;
8694 str = get_tv_string_chk(&argvars[0]);
8695 idx = get_tv_number_chk(&argvars[1], NULL);
8696 rettv->vval.v_number = -1;
8697 if (str == NULL || idx < 0)
8698 return;
8700 #ifdef FEAT_MBYTE
8701 t = str;
8702 for ( ; idx > 0; idx--)
8704 if (*t == NUL) /* EOL reached */
8705 return;
8706 t += (*mb_ptr2len)(t);
8708 rettv->vval.v_number = (varnumber_T)(t - str);
8709 #else
8710 if ((size_t)idx <= STRLEN(str))
8711 rettv->vval.v_number = idx;
8712 #endif
8716 * "call(func, arglist)" function
8718 static void
8719 f_call(argvars, rettv)
8720 typval_T *argvars;
8721 typval_T *rettv;
8723 char_u *func;
8724 typval_T argv[MAX_FUNC_ARGS + 1];
8725 int argc = 0;
8726 listitem_T *item;
8727 int dummy;
8728 dict_T *selfdict = NULL;
8730 rettv->vval.v_number = 0;
8731 if (argvars[1].v_type != VAR_LIST)
8733 EMSG(_(e_listreq));
8734 return;
8736 if (argvars[1].vval.v_list == NULL)
8737 return;
8739 if (argvars[0].v_type == VAR_FUNC)
8740 func = argvars[0].vval.v_string;
8741 else
8742 func = get_tv_string(&argvars[0]);
8743 if (*func == NUL)
8744 return; /* type error or empty name */
8746 if (argvars[2].v_type != VAR_UNKNOWN)
8748 if (argvars[2].v_type != VAR_DICT)
8750 EMSG(_(e_dictreq));
8751 return;
8753 selfdict = argvars[2].vval.v_dict;
8756 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8757 item = item->li_next)
8759 if (argc == MAX_FUNC_ARGS)
8761 EMSG(_("E699: Too many arguments"));
8762 break;
8764 /* Make a copy of each argument. This is needed to be able to set
8765 * v_lock to VAR_FIXED in the copy without changing the original list.
8767 copy_tv(&item->li_tv, &argv[argc++]);
8770 if (item == NULL)
8771 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8772 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8773 &dummy, TRUE, selfdict);
8775 /* Free the arguments. */
8776 while (argc > 0)
8777 clear_tv(&argv[--argc]);
8780 #ifdef FEAT_FLOAT
8782 * "ceil({float})" function
8784 static void
8785 f_ceil(argvars, rettv)
8786 typval_T *argvars;
8787 typval_T *rettv;
8789 float_T f;
8791 rettv->v_type = VAR_FLOAT;
8792 if (get_float_arg(argvars, &f) == OK)
8793 rettv->vval.v_float = ceil(f);
8794 else
8795 rettv->vval.v_float = 0.0;
8797 #endif
8800 * "changenr()" function
8802 /*ARGSUSED*/
8803 static void
8804 f_changenr(argvars, rettv)
8805 typval_T *argvars;
8806 typval_T *rettv;
8808 rettv->vval.v_number = curbuf->b_u_seq_cur;
8812 * "char2nr(string)" function
8814 static void
8815 f_char2nr(argvars, rettv)
8816 typval_T *argvars;
8817 typval_T *rettv;
8819 #ifdef FEAT_MBYTE
8820 if (has_mbyte)
8821 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8822 else
8823 #endif
8824 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8828 * "cindent(lnum)" function
8830 static void
8831 f_cindent(argvars, rettv)
8832 typval_T *argvars;
8833 typval_T *rettv;
8835 #ifdef FEAT_CINDENT
8836 pos_T pos;
8837 linenr_T lnum;
8839 pos = curwin->w_cursor;
8840 lnum = get_tv_lnum(argvars);
8841 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8843 curwin->w_cursor.lnum = lnum;
8844 rettv->vval.v_number = get_c_indent();
8845 curwin->w_cursor = pos;
8847 else
8848 #endif
8849 rettv->vval.v_number = -1;
8853 * "clearmatches()" function
8855 /*ARGSUSED*/
8856 static void
8857 f_clearmatches(argvars, rettv)
8858 typval_T *argvars;
8859 typval_T *rettv;
8861 #ifdef FEAT_SEARCH_EXTRA
8862 clear_matches(curwin);
8863 #endif
8867 * "col(string)" function
8869 static void
8870 f_col(argvars, rettv)
8871 typval_T *argvars;
8872 typval_T *rettv;
8874 colnr_T col = 0;
8875 pos_T *fp;
8876 int fnum = curbuf->b_fnum;
8878 fp = var2fpos(&argvars[0], FALSE, &fnum);
8879 if (fp != NULL && fnum == curbuf->b_fnum)
8881 if (fp->col == MAXCOL)
8883 /* '> can be MAXCOL, get the length of the line then */
8884 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8885 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8886 else
8887 col = MAXCOL;
8889 else
8891 col = fp->col + 1;
8892 #ifdef FEAT_VIRTUALEDIT
8893 /* col(".") when the cursor is on the NUL at the end of the line
8894 * because of "coladd" can be seen as an extra column. */
8895 if (virtual_active() && fp == &curwin->w_cursor)
8897 char_u *p = ml_get_cursor();
8899 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8900 curwin->w_virtcol - curwin->w_cursor.coladd))
8902 # ifdef FEAT_MBYTE
8903 int l;
8905 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8906 col += l;
8907 # else
8908 if (*p != NUL && p[1] == NUL)
8909 ++col;
8910 # endif
8913 #endif
8916 rettv->vval.v_number = col;
8919 #if defined(FEAT_INS_EXPAND)
8921 * "complete()" function
8923 /*ARGSUSED*/
8924 static void
8925 f_complete(argvars, rettv)
8926 typval_T *argvars;
8927 typval_T *rettv;
8929 int startcol;
8931 if ((State & INSERT) == 0)
8933 EMSG(_("E785: complete() can only be used in Insert mode"));
8934 return;
8937 /* Check for undo allowed here, because if something was already inserted
8938 * the line was already saved for undo and this check isn't done. */
8939 if (!undo_allowed())
8940 return;
8942 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8944 EMSG(_(e_invarg));
8945 return;
8948 startcol = get_tv_number_chk(&argvars[0], NULL);
8949 if (startcol <= 0)
8950 return;
8952 set_completion(startcol - 1, argvars[1].vval.v_list);
8956 * "complete_add()" function
8958 /*ARGSUSED*/
8959 static void
8960 f_complete_add(argvars, rettv)
8961 typval_T *argvars;
8962 typval_T *rettv;
8964 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
8968 * "complete_check()" function
8970 /*ARGSUSED*/
8971 static void
8972 f_complete_check(argvars, rettv)
8973 typval_T *argvars;
8974 typval_T *rettv;
8976 int saved = RedrawingDisabled;
8978 RedrawingDisabled = 0;
8979 ins_compl_check_keys(0);
8980 rettv->vval.v_number = compl_interrupted;
8981 RedrawingDisabled = saved;
8983 #endif
8986 * "confirm(message, buttons[, default [, type]])" function
8988 /*ARGSUSED*/
8989 static void
8990 f_confirm(argvars, rettv)
8991 typval_T *argvars;
8992 typval_T *rettv;
8994 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
8995 char_u *message;
8996 char_u *buttons = NULL;
8997 char_u buf[NUMBUFLEN];
8998 char_u buf2[NUMBUFLEN];
8999 int def = 1;
9000 int type = VIM_GENERIC;
9001 char_u *typestr;
9002 int error = FALSE;
9004 message = get_tv_string_chk(&argvars[0]);
9005 if (message == NULL)
9006 error = TRUE;
9007 if (argvars[1].v_type != VAR_UNKNOWN)
9009 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9010 if (buttons == NULL)
9011 error = TRUE;
9012 if (argvars[2].v_type != VAR_UNKNOWN)
9014 def = get_tv_number_chk(&argvars[2], &error);
9015 if (argvars[3].v_type != VAR_UNKNOWN)
9017 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9018 if (typestr == NULL)
9019 error = TRUE;
9020 else
9022 switch (TOUPPER_ASC(*typestr))
9024 case 'E': type = VIM_ERROR; break;
9025 case 'Q': type = VIM_QUESTION; break;
9026 case 'I': type = VIM_INFO; break;
9027 case 'W': type = VIM_WARNING; break;
9028 case 'G': type = VIM_GENERIC; break;
9035 if (buttons == NULL || *buttons == NUL)
9036 buttons = (char_u *)_("&Ok");
9038 if (error)
9039 rettv->vval.v_number = 0;
9040 else
9041 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9042 def, NULL);
9043 #else
9044 rettv->vval.v_number = 0;
9045 #endif
9049 * "copy()" function
9051 static void
9052 f_copy(argvars, rettv)
9053 typval_T *argvars;
9054 typval_T *rettv;
9056 item_copy(&argvars[0], rettv, FALSE, 0);
9059 #ifdef FEAT_FLOAT
9061 * "cos()" function
9063 static void
9064 f_cos(argvars, rettv)
9065 typval_T *argvars;
9066 typval_T *rettv;
9068 float_T f;
9070 rettv->v_type = VAR_FLOAT;
9071 if (get_float_arg(argvars, &f) == OK)
9072 rettv->vval.v_float = cos(f);
9073 else
9074 rettv->vval.v_float = 0.0;
9076 #endif
9079 * "count()" function
9081 static void
9082 f_count(argvars, rettv)
9083 typval_T *argvars;
9084 typval_T *rettv;
9086 long n = 0;
9087 int ic = FALSE;
9089 if (argvars[0].v_type == VAR_LIST)
9091 listitem_T *li;
9092 list_T *l;
9093 long idx;
9095 if ((l = argvars[0].vval.v_list) != NULL)
9097 li = l->lv_first;
9098 if (argvars[2].v_type != VAR_UNKNOWN)
9100 int error = FALSE;
9102 ic = get_tv_number_chk(&argvars[2], &error);
9103 if (argvars[3].v_type != VAR_UNKNOWN)
9105 idx = get_tv_number_chk(&argvars[3], &error);
9106 if (!error)
9108 li = list_find(l, idx);
9109 if (li == NULL)
9110 EMSGN(_(e_listidx), idx);
9113 if (error)
9114 li = NULL;
9117 for ( ; li != NULL; li = li->li_next)
9118 if (tv_equal(&li->li_tv, &argvars[1], ic))
9119 ++n;
9122 else if (argvars[0].v_type == VAR_DICT)
9124 int todo;
9125 dict_T *d;
9126 hashitem_T *hi;
9128 if ((d = argvars[0].vval.v_dict) != NULL)
9130 int error = FALSE;
9132 if (argvars[2].v_type != VAR_UNKNOWN)
9134 ic = get_tv_number_chk(&argvars[2], &error);
9135 if (argvars[3].v_type != VAR_UNKNOWN)
9136 EMSG(_(e_invarg));
9139 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9140 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9142 if (!HASHITEM_EMPTY(hi))
9144 --todo;
9145 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9146 ++n;
9151 else
9152 EMSG2(_(e_listdictarg), "count()");
9153 rettv->vval.v_number = n;
9157 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9159 * Checks the existence of a cscope connection.
9161 /*ARGSUSED*/
9162 static void
9163 f_cscope_connection(argvars, rettv)
9164 typval_T *argvars;
9165 typval_T *rettv;
9167 #ifdef FEAT_CSCOPE
9168 int num = 0;
9169 char_u *dbpath = NULL;
9170 char_u *prepend = NULL;
9171 char_u buf[NUMBUFLEN];
9173 if (argvars[0].v_type != VAR_UNKNOWN
9174 && argvars[1].v_type != VAR_UNKNOWN)
9176 num = (int)get_tv_number(&argvars[0]);
9177 dbpath = get_tv_string(&argvars[1]);
9178 if (argvars[2].v_type != VAR_UNKNOWN)
9179 prepend = get_tv_string_buf(&argvars[2], buf);
9182 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9183 #else
9184 rettv->vval.v_number = 0;
9185 #endif
9189 * "cursor(lnum, col)" function
9191 * Moves the cursor to the specified line and column
9193 /*ARGSUSED*/
9194 static void
9195 f_cursor(argvars, rettv)
9196 typval_T *argvars;
9197 typval_T *rettv;
9199 long line, col;
9200 #ifdef FEAT_VIRTUALEDIT
9201 long coladd = 0;
9202 #endif
9204 if (argvars[1].v_type == VAR_UNKNOWN)
9206 pos_T pos;
9208 if (list2fpos(argvars, &pos, NULL) == FAIL)
9209 return;
9210 line = pos.lnum;
9211 col = pos.col;
9212 #ifdef FEAT_VIRTUALEDIT
9213 coladd = pos.coladd;
9214 #endif
9216 else
9218 line = get_tv_lnum(argvars);
9219 col = get_tv_number_chk(&argvars[1], NULL);
9220 #ifdef FEAT_VIRTUALEDIT
9221 if (argvars[2].v_type != VAR_UNKNOWN)
9222 coladd = get_tv_number_chk(&argvars[2], NULL);
9223 #endif
9225 if (line < 0 || col < 0
9226 #ifdef FEAT_VIRTUALEDIT
9227 || coladd < 0
9228 #endif
9230 return; /* type error; errmsg already given */
9231 if (line > 0)
9232 curwin->w_cursor.lnum = line;
9233 if (col > 0)
9234 curwin->w_cursor.col = col - 1;
9235 #ifdef FEAT_VIRTUALEDIT
9236 curwin->w_cursor.coladd = coladd;
9237 #endif
9239 /* Make sure the cursor is in a valid position. */
9240 check_cursor();
9241 #ifdef FEAT_MBYTE
9242 /* Correct cursor for multi-byte character. */
9243 if (has_mbyte)
9244 mb_adjust_cursor();
9245 #endif
9247 curwin->w_set_curswant = TRUE;
9251 * "deepcopy()" function
9253 static void
9254 f_deepcopy(argvars, rettv)
9255 typval_T *argvars;
9256 typval_T *rettv;
9258 int noref = 0;
9260 if (argvars[1].v_type != VAR_UNKNOWN)
9261 noref = get_tv_number_chk(&argvars[1], NULL);
9262 if (noref < 0 || noref > 1)
9263 EMSG(_(e_invarg));
9264 else
9265 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? ++current_copyID : 0);
9269 * "delete()" function
9271 static void
9272 f_delete(argvars, rettv)
9273 typval_T *argvars;
9274 typval_T *rettv;
9276 if (check_restricted() || check_secure())
9277 rettv->vval.v_number = -1;
9278 else
9279 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9283 * "did_filetype()" function
9285 /*ARGSUSED*/
9286 static void
9287 f_did_filetype(argvars, rettv)
9288 typval_T *argvars;
9289 typval_T *rettv;
9291 #ifdef FEAT_AUTOCMD
9292 rettv->vval.v_number = did_filetype;
9293 #else
9294 rettv->vval.v_number = 0;
9295 #endif
9299 * "diff_filler()" function
9301 /*ARGSUSED*/
9302 static void
9303 f_diff_filler(argvars, rettv)
9304 typval_T *argvars;
9305 typval_T *rettv;
9307 #ifdef FEAT_DIFF
9308 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9309 #endif
9313 * "diff_hlID()" function
9315 /*ARGSUSED*/
9316 static void
9317 f_diff_hlID(argvars, rettv)
9318 typval_T *argvars;
9319 typval_T *rettv;
9321 #ifdef FEAT_DIFF
9322 linenr_T lnum = get_tv_lnum(argvars);
9323 static linenr_T prev_lnum = 0;
9324 static int changedtick = 0;
9325 static int fnum = 0;
9326 static int change_start = 0;
9327 static int change_end = 0;
9328 static hlf_T hlID = (hlf_T)0;
9329 int filler_lines;
9330 int col;
9332 if (lnum < 0) /* ignore type error in {lnum} arg */
9333 lnum = 0;
9334 if (lnum != prev_lnum
9335 || changedtick != curbuf->b_changedtick
9336 || fnum != curbuf->b_fnum)
9338 /* New line, buffer, change: need to get the values. */
9339 filler_lines = diff_check(curwin, lnum);
9340 if (filler_lines < 0)
9342 if (filler_lines == -1)
9344 change_start = MAXCOL;
9345 change_end = -1;
9346 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9347 hlID = HLF_ADD; /* added line */
9348 else
9349 hlID = HLF_CHD; /* changed line */
9351 else
9352 hlID = HLF_ADD; /* added line */
9354 else
9355 hlID = (hlf_T)0;
9356 prev_lnum = lnum;
9357 changedtick = curbuf->b_changedtick;
9358 fnum = curbuf->b_fnum;
9361 if (hlID == HLF_CHD || hlID == HLF_TXD)
9363 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9364 if (col >= change_start && col <= change_end)
9365 hlID = HLF_TXD; /* changed text */
9366 else
9367 hlID = HLF_CHD; /* changed line */
9369 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9370 #endif
9374 * "empty({expr})" function
9376 static void
9377 f_empty(argvars, rettv)
9378 typval_T *argvars;
9379 typval_T *rettv;
9381 int n;
9383 switch (argvars[0].v_type)
9385 case VAR_STRING:
9386 case VAR_FUNC:
9387 n = argvars[0].vval.v_string == NULL
9388 || *argvars[0].vval.v_string == NUL;
9389 break;
9390 case VAR_NUMBER:
9391 n = argvars[0].vval.v_number == 0;
9392 break;
9393 #ifdef FEAT_FLOAT
9394 case VAR_FLOAT:
9395 n = argvars[0].vval.v_float == 0.0;
9396 break;
9397 #endif
9398 case VAR_LIST:
9399 n = argvars[0].vval.v_list == NULL
9400 || argvars[0].vval.v_list->lv_first == NULL;
9401 break;
9402 case VAR_DICT:
9403 n = argvars[0].vval.v_dict == NULL
9404 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9405 break;
9406 default:
9407 EMSG2(_(e_intern2), "f_empty()");
9408 n = 0;
9411 rettv->vval.v_number = n;
9415 * "escape({string}, {chars})" function
9417 static void
9418 f_escape(argvars, rettv)
9419 typval_T *argvars;
9420 typval_T *rettv;
9422 char_u buf[NUMBUFLEN];
9424 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9425 get_tv_string_buf(&argvars[1], buf));
9426 rettv->v_type = VAR_STRING;
9430 * "eval()" function
9432 /*ARGSUSED*/
9433 static void
9434 f_eval(argvars, rettv)
9435 typval_T *argvars;
9436 typval_T *rettv;
9438 char_u *s;
9440 s = get_tv_string_chk(&argvars[0]);
9441 if (s != NULL)
9442 s = skipwhite(s);
9444 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9446 rettv->v_type = VAR_NUMBER;
9447 rettv->vval.v_number = 0;
9449 else if (*s != NUL)
9450 EMSG(_(e_trailing));
9454 * "eventhandler()" function
9456 /*ARGSUSED*/
9457 static void
9458 f_eventhandler(argvars, rettv)
9459 typval_T *argvars;
9460 typval_T *rettv;
9462 rettv->vval.v_number = vgetc_busy;
9466 * "executable()" function
9468 static void
9469 f_executable(argvars, rettv)
9470 typval_T *argvars;
9471 typval_T *rettv;
9473 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9477 * "exists()" function
9479 static void
9480 f_exists(argvars, rettv)
9481 typval_T *argvars;
9482 typval_T *rettv;
9484 char_u *p;
9485 char_u *name;
9486 int n = FALSE;
9487 int len = 0;
9489 p = get_tv_string(&argvars[0]);
9490 if (*p == '$') /* environment variable */
9492 /* first try "normal" environment variables (fast) */
9493 if (mch_getenv(p + 1) != NULL)
9494 n = TRUE;
9495 else
9497 /* try expanding things like $VIM and ${HOME} */
9498 p = expand_env_save(p);
9499 if (p != NULL && *p != '$')
9500 n = TRUE;
9501 vim_free(p);
9504 else if (*p == '&' || *p == '+') /* option */
9506 n = (get_option_tv(&p, NULL, TRUE) == OK);
9507 if (*skipwhite(p) != NUL)
9508 n = FALSE; /* trailing garbage */
9510 else if (*p == '*') /* internal or user defined function */
9512 n = function_exists(p + 1);
9514 else if (*p == ':')
9516 n = cmd_exists(p + 1);
9518 else if (*p == '#')
9520 #ifdef FEAT_AUTOCMD
9521 if (p[1] == '#')
9522 n = autocmd_supported(p + 2);
9523 else
9524 n = au_exists(p + 1);
9525 #endif
9527 else /* internal variable */
9529 char_u *tofree;
9530 typval_T tv;
9532 /* get_name_len() takes care of expanding curly braces */
9533 name = p;
9534 len = get_name_len(&p, &tofree, TRUE, FALSE);
9535 if (len > 0)
9537 if (tofree != NULL)
9538 name = tofree;
9539 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9540 if (n)
9542 /* handle d.key, l[idx], f(expr) */
9543 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9544 if (n)
9545 clear_tv(&tv);
9548 if (*p != NUL)
9549 n = FALSE;
9551 vim_free(tofree);
9554 rettv->vval.v_number = n;
9558 * "expand()" function
9560 static void
9561 f_expand(argvars, rettv)
9562 typval_T *argvars;
9563 typval_T *rettv;
9565 char_u *s;
9566 int len;
9567 char_u *errormsg;
9568 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9569 expand_T xpc;
9570 int error = FALSE;
9572 rettv->v_type = VAR_STRING;
9573 s = get_tv_string(&argvars[0]);
9574 if (*s == '%' || *s == '#' || *s == '<')
9576 ++emsg_off;
9577 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9578 --emsg_off;
9580 else
9582 /* When the optional second argument is non-zero, don't remove matches
9583 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9584 if (argvars[1].v_type != VAR_UNKNOWN
9585 && get_tv_number_chk(&argvars[1], &error))
9586 flags |= WILD_KEEP_ALL;
9587 if (!error)
9589 ExpandInit(&xpc);
9590 xpc.xp_context = EXPAND_FILES;
9591 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9593 else
9594 rettv->vval.v_string = NULL;
9599 * "extend(list, list [, idx])" function
9600 * "extend(dict, dict [, action])" function
9602 static void
9603 f_extend(argvars, rettv)
9604 typval_T *argvars;
9605 typval_T *rettv;
9607 rettv->vval.v_number = 0;
9608 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9610 list_T *l1, *l2;
9611 listitem_T *item;
9612 long before;
9613 int error = FALSE;
9615 l1 = argvars[0].vval.v_list;
9616 l2 = argvars[1].vval.v_list;
9617 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9618 && l2 != NULL)
9620 if (argvars[2].v_type != VAR_UNKNOWN)
9622 before = get_tv_number_chk(&argvars[2], &error);
9623 if (error)
9624 return; /* type error; errmsg already given */
9626 if (before == l1->lv_len)
9627 item = NULL;
9628 else
9630 item = list_find(l1, before);
9631 if (item == NULL)
9633 EMSGN(_(e_listidx), before);
9634 return;
9638 else
9639 item = NULL;
9640 list_extend(l1, l2, item);
9642 copy_tv(&argvars[0], rettv);
9645 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9647 dict_T *d1, *d2;
9648 dictitem_T *di1;
9649 char_u *action;
9650 int i;
9651 hashitem_T *hi2;
9652 int todo;
9654 d1 = argvars[0].vval.v_dict;
9655 d2 = argvars[1].vval.v_dict;
9656 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9657 && d2 != NULL)
9659 /* Check the third argument. */
9660 if (argvars[2].v_type != VAR_UNKNOWN)
9662 static char *(av[]) = {"keep", "force", "error"};
9664 action = get_tv_string_chk(&argvars[2]);
9665 if (action == NULL)
9666 return; /* type error; errmsg already given */
9667 for (i = 0; i < 3; ++i)
9668 if (STRCMP(action, av[i]) == 0)
9669 break;
9670 if (i == 3)
9672 EMSG2(_(e_invarg2), action);
9673 return;
9676 else
9677 action = (char_u *)"force";
9679 /* Go over all entries in the second dict and add them to the
9680 * first dict. */
9681 todo = (int)d2->dv_hashtab.ht_used;
9682 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9684 if (!HASHITEM_EMPTY(hi2))
9686 --todo;
9687 di1 = dict_find(d1, hi2->hi_key, -1);
9688 if (di1 == NULL)
9690 di1 = dictitem_copy(HI2DI(hi2));
9691 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9692 dictitem_free(di1);
9694 else if (*action == 'e')
9696 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9697 break;
9699 else if (*action == 'f')
9701 clear_tv(&di1->di_tv);
9702 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9707 copy_tv(&argvars[0], rettv);
9710 else
9711 EMSG2(_(e_listdictarg), "extend()");
9715 * "feedkeys()" function
9717 /*ARGSUSED*/
9718 static void
9719 f_feedkeys(argvars, rettv)
9720 typval_T *argvars;
9721 typval_T *rettv;
9723 int remap = TRUE;
9724 char_u *keys, *flags;
9725 char_u nbuf[NUMBUFLEN];
9726 int typed = FALSE;
9727 char_u *keys_esc;
9729 /* This is not allowed in the sandbox. If the commands would still be
9730 * executed in the sandbox it would be OK, but it probably happens later,
9731 * when "sandbox" is no longer set. */
9732 if (check_secure())
9733 return;
9735 rettv->vval.v_number = 0;
9736 keys = get_tv_string(&argvars[0]);
9737 if (*keys != NUL)
9739 if (argvars[1].v_type != VAR_UNKNOWN)
9741 flags = get_tv_string_buf(&argvars[1], nbuf);
9742 for ( ; *flags != NUL; ++flags)
9744 switch (*flags)
9746 case 'n': remap = FALSE; break;
9747 case 'm': remap = TRUE; break;
9748 case 't': typed = TRUE; break;
9753 /* Need to escape K_SPECIAL and CSI before putting the string in the
9754 * typeahead buffer. */
9755 keys_esc = vim_strsave_escape_csi(keys);
9756 if (keys_esc != NULL)
9758 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9759 typebuf.tb_len, !typed, FALSE);
9760 vim_free(keys_esc);
9761 if (vgetc_busy)
9762 typebuf_was_filled = TRUE;
9768 * "filereadable()" function
9770 static void
9771 f_filereadable(argvars, rettv)
9772 typval_T *argvars;
9773 typval_T *rettv;
9775 int fd;
9776 char_u *p;
9777 int n;
9779 #ifndef O_NONBLOCK
9780 # define O_NONBLOCK 0
9781 #endif
9782 p = get_tv_string(&argvars[0]);
9783 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9784 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9786 n = TRUE;
9787 close(fd);
9789 else
9790 n = FALSE;
9792 rettv->vval.v_number = n;
9796 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9797 * rights to write into.
9799 static void
9800 f_filewritable(argvars, rettv)
9801 typval_T *argvars;
9802 typval_T *rettv;
9804 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9807 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9809 static void
9810 findfilendir(argvars, rettv, find_what)
9811 typval_T *argvars;
9812 typval_T *rettv;
9813 int find_what;
9815 #ifdef FEAT_SEARCHPATH
9816 char_u *fname;
9817 char_u *fresult = NULL;
9818 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9819 char_u *p;
9820 char_u pathbuf[NUMBUFLEN];
9821 int count = 1;
9822 int first = TRUE;
9823 int error = FALSE;
9824 #endif
9826 rettv->vval.v_string = NULL;
9827 rettv->v_type = VAR_STRING;
9829 #ifdef FEAT_SEARCHPATH
9830 fname = get_tv_string(&argvars[0]);
9832 if (argvars[1].v_type != VAR_UNKNOWN)
9834 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9835 if (p == NULL)
9836 error = TRUE;
9837 else
9839 if (*p != NUL)
9840 path = p;
9842 if (argvars[2].v_type != VAR_UNKNOWN)
9843 count = get_tv_number_chk(&argvars[2], &error);
9847 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9848 error = TRUE;
9850 if (*fname != NUL && !error)
9854 if (rettv->v_type == VAR_STRING)
9855 vim_free(fresult);
9856 fresult = find_file_in_path_option(first ? fname : NULL,
9857 first ? (int)STRLEN(fname) : 0,
9858 0, first, path,
9859 find_what,
9860 curbuf->b_ffname,
9861 find_what == FINDFILE_DIR
9862 ? (char_u *)"" : curbuf->b_p_sua);
9863 first = FALSE;
9865 if (fresult != NULL && rettv->v_type == VAR_LIST)
9866 list_append_string(rettv->vval.v_list, fresult, -1);
9868 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9871 if (rettv->v_type == VAR_STRING)
9872 rettv->vval.v_string = fresult;
9873 #endif
9876 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9877 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9880 * Implementation of map() and filter().
9882 static void
9883 filter_map(argvars, rettv, map)
9884 typval_T *argvars;
9885 typval_T *rettv;
9886 int map;
9888 char_u buf[NUMBUFLEN];
9889 char_u *expr;
9890 listitem_T *li, *nli;
9891 list_T *l = NULL;
9892 dictitem_T *di;
9893 hashtab_T *ht;
9894 hashitem_T *hi;
9895 dict_T *d = NULL;
9896 typval_T save_val;
9897 typval_T save_key;
9898 int rem;
9899 int todo;
9900 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9901 int save_did_emsg;
9903 rettv->vval.v_number = 0;
9904 if (argvars[0].v_type == VAR_LIST)
9906 if ((l = argvars[0].vval.v_list) == NULL
9907 || (map && tv_check_lock(l->lv_lock, ermsg)))
9908 return;
9910 else if (argvars[0].v_type == VAR_DICT)
9912 if ((d = argvars[0].vval.v_dict) == NULL
9913 || (map && tv_check_lock(d->dv_lock, ermsg)))
9914 return;
9916 else
9918 EMSG2(_(e_listdictarg), ermsg);
9919 return;
9922 expr = get_tv_string_buf_chk(&argvars[1], buf);
9923 /* On type errors, the preceding call has already displayed an error
9924 * message. Avoid a misleading error message for an empty string that
9925 * was not passed as argument. */
9926 if (expr != NULL)
9928 prepare_vimvar(VV_VAL, &save_val);
9929 expr = skipwhite(expr);
9931 /* We reset "did_emsg" to be able to detect whether an error
9932 * occurred during evaluation of the expression. */
9933 save_did_emsg = did_emsg;
9934 did_emsg = FALSE;
9936 if (argvars[0].v_type == VAR_DICT)
9938 prepare_vimvar(VV_KEY, &save_key);
9939 vimvars[VV_KEY].vv_type = VAR_STRING;
9941 ht = &d->dv_hashtab;
9942 hash_lock(ht);
9943 todo = (int)ht->ht_used;
9944 for (hi = ht->ht_array; todo > 0; ++hi)
9946 if (!HASHITEM_EMPTY(hi))
9948 --todo;
9949 di = HI2DI(hi);
9950 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9951 break;
9952 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9953 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9954 || did_emsg)
9955 break;
9956 if (!map && rem)
9957 dictitem_remove(d, di);
9958 clear_tv(&vimvars[VV_KEY].vv_tv);
9961 hash_unlock(ht);
9963 restore_vimvar(VV_KEY, &save_key);
9965 else
9967 for (li = l->lv_first; li != NULL; li = nli)
9969 if (tv_check_lock(li->li_tv.v_lock, ermsg))
9970 break;
9971 nli = li->li_next;
9972 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
9973 || did_emsg)
9974 break;
9975 if (!map && rem)
9976 listitem_remove(l, li);
9980 restore_vimvar(VV_VAL, &save_val);
9982 did_emsg |= save_did_emsg;
9985 copy_tv(&argvars[0], rettv);
9988 static int
9989 filter_map_one(tv, expr, map, remp)
9990 typval_T *tv;
9991 char_u *expr;
9992 int map;
9993 int *remp;
9995 typval_T rettv;
9996 char_u *s;
9997 int retval = FAIL;
9999 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10000 s = expr;
10001 if (eval1(&s, &rettv, TRUE) == FAIL)
10002 goto theend;
10003 if (*s != NUL) /* check for trailing chars after expr */
10005 EMSG2(_(e_invexpr2), s);
10006 goto theend;
10008 if (map)
10010 /* map(): replace the list item value */
10011 clear_tv(tv);
10012 rettv.v_lock = 0;
10013 *tv = rettv;
10015 else
10017 int error = FALSE;
10019 /* filter(): when expr is zero remove the item */
10020 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10021 clear_tv(&rettv);
10022 /* On type error, nothing has been removed; return FAIL to stop the
10023 * loop. The error message was given by get_tv_number_chk(). */
10024 if (error)
10025 goto theend;
10027 retval = OK;
10028 theend:
10029 clear_tv(&vimvars[VV_VAL].vv_tv);
10030 return retval;
10034 * "filter()" function
10036 static void
10037 f_filter(argvars, rettv)
10038 typval_T *argvars;
10039 typval_T *rettv;
10041 filter_map(argvars, rettv, FALSE);
10045 * "finddir({fname}[, {path}[, {count}]])" function
10047 static void
10048 f_finddir(argvars, rettv)
10049 typval_T *argvars;
10050 typval_T *rettv;
10052 findfilendir(argvars, rettv, FINDFILE_DIR);
10056 * "findfile({fname}[, {path}[, {count}]])" function
10058 static void
10059 f_findfile(argvars, rettv)
10060 typval_T *argvars;
10061 typval_T *rettv;
10063 findfilendir(argvars, rettv, FINDFILE_FILE);
10066 #ifdef FEAT_FLOAT
10068 * "float2nr({float})" function
10070 static void
10071 f_float2nr(argvars, rettv)
10072 typval_T *argvars;
10073 typval_T *rettv;
10075 float_T f;
10077 if (get_float_arg(argvars, &f) == OK)
10079 if (f < -0x7fffffff)
10080 rettv->vval.v_number = -0x7fffffff;
10081 else if (f > 0x7fffffff)
10082 rettv->vval.v_number = 0x7fffffff;
10083 else
10084 rettv->vval.v_number = (varnumber_T)f;
10086 else
10087 rettv->vval.v_number = 0;
10091 * "floor({float})" function
10093 static void
10094 f_floor(argvars, rettv)
10095 typval_T *argvars;
10096 typval_T *rettv;
10098 float_T f;
10100 rettv->v_type = VAR_FLOAT;
10101 if (get_float_arg(argvars, &f) == OK)
10102 rettv->vval.v_float = floor(f);
10103 else
10104 rettv->vval.v_float = 0.0;
10106 #endif
10109 * "fnameescape({string})" function
10111 static void
10112 f_fnameescape(argvars, rettv)
10113 typval_T *argvars;
10114 typval_T *rettv;
10116 rettv->vval.v_string = vim_strsave_fnameescape(
10117 get_tv_string(&argvars[0]), FALSE);
10118 rettv->v_type = VAR_STRING;
10122 * "fnamemodify({fname}, {mods})" function
10124 static void
10125 f_fnamemodify(argvars, rettv)
10126 typval_T *argvars;
10127 typval_T *rettv;
10129 char_u *fname;
10130 char_u *mods;
10131 int usedlen = 0;
10132 int len;
10133 char_u *fbuf = NULL;
10134 char_u buf[NUMBUFLEN];
10136 fname = get_tv_string_chk(&argvars[0]);
10137 mods = get_tv_string_buf_chk(&argvars[1], buf);
10138 if (fname == NULL || mods == NULL)
10139 fname = NULL;
10140 else
10142 len = (int)STRLEN(fname);
10143 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10146 rettv->v_type = VAR_STRING;
10147 if (fname == NULL)
10148 rettv->vval.v_string = NULL;
10149 else
10150 rettv->vval.v_string = vim_strnsave(fname, len);
10151 vim_free(fbuf);
10154 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10157 * "foldclosed()" function
10159 static void
10160 foldclosed_both(argvars, rettv, end)
10161 typval_T *argvars;
10162 typval_T *rettv;
10163 int end;
10165 #ifdef FEAT_FOLDING
10166 linenr_T lnum;
10167 linenr_T first, last;
10169 lnum = get_tv_lnum(argvars);
10170 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10172 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10174 if (end)
10175 rettv->vval.v_number = (varnumber_T)last;
10176 else
10177 rettv->vval.v_number = (varnumber_T)first;
10178 return;
10181 #endif
10182 rettv->vval.v_number = -1;
10186 * "foldclosed()" function
10188 static void
10189 f_foldclosed(argvars, rettv)
10190 typval_T *argvars;
10191 typval_T *rettv;
10193 foldclosed_both(argvars, rettv, FALSE);
10197 * "foldclosedend()" function
10199 static void
10200 f_foldclosedend(argvars, rettv)
10201 typval_T *argvars;
10202 typval_T *rettv;
10204 foldclosed_both(argvars, rettv, TRUE);
10208 * "foldlevel()" function
10210 static void
10211 f_foldlevel(argvars, rettv)
10212 typval_T *argvars;
10213 typval_T *rettv;
10215 #ifdef FEAT_FOLDING
10216 linenr_T lnum;
10218 lnum = get_tv_lnum(argvars);
10219 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10220 rettv->vval.v_number = foldLevel(lnum);
10221 else
10222 #endif
10223 rettv->vval.v_number = 0;
10227 * "foldtext()" function
10229 /*ARGSUSED*/
10230 static void
10231 f_foldtext(argvars, rettv)
10232 typval_T *argvars;
10233 typval_T *rettv;
10235 #ifdef FEAT_FOLDING
10236 linenr_T lnum;
10237 char_u *s;
10238 char_u *r;
10239 int len;
10240 char *txt;
10241 #endif
10243 rettv->v_type = VAR_STRING;
10244 rettv->vval.v_string = NULL;
10245 #ifdef FEAT_FOLDING
10246 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10247 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10248 <= curbuf->b_ml.ml_line_count
10249 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10251 /* Find first non-empty line in the fold. */
10252 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10253 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10255 if (!linewhite(lnum))
10256 break;
10257 ++lnum;
10260 /* Find interesting text in this line. */
10261 s = skipwhite(ml_get(lnum));
10262 /* skip C comment-start */
10263 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10265 s = skipwhite(s + 2);
10266 if (*skipwhite(s) == NUL
10267 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10269 s = skipwhite(ml_get(lnum + 1));
10270 if (*s == '*')
10271 s = skipwhite(s + 1);
10274 txt = _("+-%s%3ld lines: ");
10275 r = alloc((unsigned)(STRLEN(txt)
10276 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10277 + 20 /* for %3ld */
10278 + STRLEN(s))); /* concatenated */
10279 if (r != NULL)
10281 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10282 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10283 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10284 len = (int)STRLEN(r);
10285 STRCAT(r, s);
10286 /* remove 'foldmarker' and 'commentstring' */
10287 foldtext_cleanup(r + len);
10288 rettv->vval.v_string = r;
10291 #endif
10295 * "foldtextresult(lnum)" function
10297 /*ARGSUSED*/
10298 static void
10299 f_foldtextresult(argvars, rettv)
10300 typval_T *argvars;
10301 typval_T *rettv;
10303 #ifdef FEAT_FOLDING
10304 linenr_T lnum;
10305 char_u *text;
10306 char_u buf[51];
10307 foldinfo_T foldinfo;
10308 int fold_count;
10309 #endif
10311 rettv->v_type = VAR_STRING;
10312 rettv->vval.v_string = NULL;
10313 #ifdef FEAT_FOLDING
10314 lnum = get_tv_lnum(argvars);
10315 /* treat illegal types and illegal string values for {lnum} the same */
10316 if (lnum < 0)
10317 lnum = 0;
10318 fold_count = foldedCount(curwin, lnum, &foldinfo);
10319 if (fold_count > 0)
10321 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10322 &foldinfo, buf);
10323 if (text == buf)
10324 text = vim_strsave(text);
10325 rettv->vval.v_string = text;
10327 #endif
10331 * "foreground()" function
10333 /*ARGSUSED*/
10334 static void
10335 f_foreground(argvars, rettv)
10336 typval_T *argvars;
10337 typval_T *rettv;
10339 rettv->vval.v_number = 0;
10340 #ifdef FEAT_GUI
10341 if (gui.in_use)
10342 gui_mch_set_foreground();
10343 #else
10344 # ifdef WIN32
10345 win32_set_foreground();
10346 # endif
10347 #endif
10351 * "function()" function
10353 /*ARGSUSED*/
10354 static void
10355 f_function(argvars, rettv)
10356 typval_T *argvars;
10357 typval_T *rettv;
10359 char_u *s;
10361 rettv->vval.v_number = 0;
10362 s = get_tv_string(&argvars[0]);
10363 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10364 EMSG2(_(e_invarg2), s);
10365 /* Don't check an autoload name for existence here. */
10366 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10367 EMSG2(_("E700: Unknown function: %s"), s);
10368 else
10370 rettv->vval.v_string = vim_strsave(s);
10371 rettv->v_type = VAR_FUNC;
10376 * "garbagecollect()" function
10378 /*ARGSUSED*/
10379 static void
10380 f_garbagecollect(argvars, rettv)
10381 typval_T *argvars;
10382 typval_T *rettv;
10384 /* This is postponed until we are back at the toplevel, because we may be
10385 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10386 want_garbage_collect = TRUE;
10388 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10389 garbage_collect_at_exit = TRUE;
10393 * "get()" function
10395 static void
10396 f_get(argvars, rettv)
10397 typval_T *argvars;
10398 typval_T *rettv;
10400 listitem_T *li;
10401 list_T *l;
10402 dictitem_T *di;
10403 dict_T *d;
10404 typval_T *tv = NULL;
10406 if (argvars[0].v_type == VAR_LIST)
10408 if ((l = argvars[0].vval.v_list) != NULL)
10410 int error = FALSE;
10412 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10413 if (!error && li != NULL)
10414 tv = &li->li_tv;
10417 else if (argvars[0].v_type == VAR_DICT)
10419 if ((d = argvars[0].vval.v_dict) != NULL)
10421 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10422 if (di != NULL)
10423 tv = &di->di_tv;
10426 else
10427 EMSG2(_(e_listdictarg), "get()");
10429 if (tv == NULL)
10431 if (argvars[2].v_type == VAR_UNKNOWN)
10432 rettv->vval.v_number = 0;
10433 else
10434 copy_tv(&argvars[2], rettv);
10436 else
10437 copy_tv(tv, rettv);
10440 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10443 * Get line or list of lines from buffer "buf" into "rettv".
10444 * Return a range (from start to end) of lines in rettv from the specified
10445 * buffer.
10446 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10448 static void
10449 get_buffer_lines(buf, start, end, retlist, rettv)
10450 buf_T *buf;
10451 linenr_T start;
10452 linenr_T end;
10453 int retlist;
10454 typval_T *rettv;
10456 char_u *p;
10458 if (retlist)
10460 if (rettv_list_alloc(rettv) == FAIL)
10461 return;
10463 else
10464 rettv->vval.v_number = 0;
10466 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10467 return;
10469 if (!retlist)
10471 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10472 p = ml_get_buf(buf, start, FALSE);
10473 else
10474 p = (char_u *)"";
10476 rettv->v_type = VAR_STRING;
10477 rettv->vval.v_string = vim_strsave(p);
10479 else
10481 if (end < start)
10482 return;
10484 if (start < 1)
10485 start = 1;
10486 if (end > buf->b_ml.ml_line_count)
10487 end = buf->b_ml.ml_line_count;
10488 while (start <= end)
10489 if (list_append_string(rettv->vval.v_list,
10490 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10491 break;
10496 * "getbufline()" function
10498 static void
10499 f_getbufline(argvars, rettv)
10500 typval_T *argvars;
10501 typval_T *rettv;
10503 linenr_T lnum;
10504 linenr_T end;
10505 buf_T *buf;
10507 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10508 ++emsg_off;
10509 buf = get_buf_tv(&argvars[0]);
10510 --emsg_off;
10512 lnum = get_tv_lnum_buf(&argvars[1], buf);
10513 if (argvars[2].v_type == VAR_UNKNOWN)
10514 end = lnum;
10515 else
10516 end = get_tv_lnum_buf(&argvars[2], buf);
10518 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10522 * "getbufvar()" function
10524 static void
10525 f_getbufvar(argvars, rettv)
10526 typval_T *argvars;
10527 typval_T *rettv;
10529 buf_T *buf;
10530 buf_T *save_curbuf;
10531 char_u *varname;
10532 dictitem_T *v;
10534 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10535 varname = get_tv_string_chk(&argvars[1]);
10536 ++emsg_off;
10537 buf = get_buf_tv(&argvars[0]);
10539 rettv->v_type = VAR_STRING;
10540 rettv->vval.v_string = NULL;
10542 if (buf != NULL && varname != NULL)
10544 /* set curbuf to be our buf, temporarily */
10545 save_curbuf = curbuf;
10546 curbuf = buf;
10548 if (*varname == '&') /* buffer-local-option */
10549 get_option_tv(&varname, rettv, TRUE);
10550 else
10552 if (*varname == NUL)
10553 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10554 * scope prefix before the NUL byte is required by
10555 * find_var_in_ht(). */
10556 varname = (char_u *)"b:" + 2;
10557 /* look up the variable */
10558 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10559 if (v != NULL)
10560 copy_tv(&v->di_tv, rettv);
10563 /* restore previous notion of curbuf */
10564 curbuf = save_curbuf;
10567 --emsg_off;
10571 * "getchar()" function
10573 static void
10574 f_getchar(argvars, rettv)
10575 typval_T *argvars;
10576 typval_T *rettv;
10578 varnumber_T n;
10579 int error = FALSE;
10581 /* Position the cursor. Needed after a message that ends in a space. */
10582 windgoto(msg_row, msg_col);
10584 ++no_mapping;
10585 ++allow_keys;
10586 for (;;)
10588 if (argvars[0].v_type == VAR_UNKNOWN)
10589 /* getchar(): blocking wait. */
10590 n = safe_vgetc();
10591 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10592 /* getchar(1): only check if char avail */
10593 n = vpeekc();
10594 else if (error || vpeekc() == NUL)
10595 /* illegal argument or getchar(0) and no char avail: return zero */
10596 n = 0;
10597 else
10598 /* getchar(0) and char avail: return char */
10599 n = safe_vgetc();
10600 if (n == K_IGNORE)
10601 continue;
10602 break;
10604 --no_mapping;
10605 --allow_keys;
10607 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10608 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10609 vimvars[VV_MOUSE_COL].vv_nr = 0;
10611 rettv->vval.v_number = n;
10612 if (IS_SPECIAL(n) || mod_mask != 0)
10614 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10615 int i = 0;
10617 /* Turn a special key into three bytes, plus modifier. */
10618 if (mod_mask != 0)
10620 temp[i++] = K_SPECIAL;
10621 temp[i++] = KS_MODIFIER;
10622 temp[i++] = mod_mask;
10624 if (IS_SPECIAL(n))
10626 temp[i++] = K_SPECIAL;
10627 temp[i++] = K_SECOND(n);
10628 temp[i++] = K_THIRD(n);
10630 #ifdef FEAT_MBYTE
10631 else if (has_mbyte)
10632 i += (*mb_char2bytes)(n, temp + i);
10633 #endif
10634 else
10635 temp[i++] = n;
10636 temp[i++] = NUL;
10637 rettv->v_type = VAR_STRING;
10638 rettv->vval.v_string = vim_strsave(temp);
10640 #ifdef FEAT_MOUSE
10641 if (n == K_LEFTMOUSE
10642 || n == K_LEFTMOUSE_NM
10643 || n == K_LEFTDRAG
10644 || n == K_LEFTRELEASE
10645 || n == K_LEFTRELEASE_NM
10646 || n == K_MIDDLEMOUSE
10647 || n == K_MIDDLEDRAG
10648 || n == K_MIDDLERELEASE
10649 || n == K_RIGHTMOUSE
10650 || n == K_RIGHTDRAG
10651 || n == K_RIGHTRELEASE
10652 || n == K_X1MOUSE
10653 || n == K_X1DRAG
10654 || n == K_X1RELEASE
10655 || n == K_X2MOUSE
10656 || n == K_X2DRAG
10657 || n == K_X2RELEASE
10658 || n == K_MOUSEDOWN
10659 || n == K_MOUSEUP)
10661 int row = mouse_row;
10662 int col = mouse_col;
10663 win_T *win;
10664 linenr_T lnum;
10665 # ifdef FEAT_WINDOWS
10666 win_T *wp;
10667 # endif
10668 int winnr = 1;
10670 if (row >= 0 && col >= 0)
10672 /* Find the window at the mouse coordinates and compute the
10673 * text position. */
10674 win = mouse_find_win(&row, &col);
10675 (void)mouse_comp_pos(win, &row, &col, &lnum);
10676 # ifdef FEAT_WINDOWS
10677 for (wp = firstwin; wp != win; wp = wp->w_next)
10678 ++winnr;
10679 # endif
10680 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10681 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10682 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10685 #endif
10690 * "getcharmod()" function
10692 /*ARGSUSED*/
10693 static void
10694 f_getcharmod(argvars, rettv)
10695 typval_T *argvars;
10696 typval_T *rettv;
10698 rettv->vval.v_number = mod_mask;
10702 * "getcmdline()" function
10704 /*ARGSUSED*/
10705 static void
10706 f_getcmdline(argvars, rettv)
10707 typval_T *argvars;
10708 typval_T *rettv;
10710 rettv->v_type = VAR_STRING;
10711 rettv->vval.v_string = get_cmdline_str();
10715 * "getcmdpos()" function
10717 /*ARGSUSED*/
10718 static void
10719 f_getcmdpos(argvars, rettv)
10720 typval_T *argvars;
10721 typval_T *rettv;
10723 rettv->vval.v_number = get_cmdline_pos() + 1;
10727 * "getcmdtype()" function
10729 /*ARGSUSED*/
10730 static void
10731 f_getcmdtype(argvars, rettv)
10732 typval_T *argvars;
10733 typval_T *rettv;
10735 rettv->v_type = VAR_STRING;
10736 rettv->vval.v_string = alloc(2);
10737 if (rettv->vval.v_string != NULL)
10739 rettv->vval.v_string[0] = get_cmdline_type();
10740 rettv->vval.v_string[1] = NUL;
10745 * "getcwd()" function
10747 /*ARGSUSED*/
10748 static void
10749 f_getcwd(argvars, rettv)
10750 typval_T *argvars;
10751 typval_T *rettv;
10753 char_u cwd[MAXPATHL];
10755 rettv->v_type = VAR_STRING;
10756 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10757 rettv->vval.v_string = NULL;
10758 else
10760 rettv->vval.v_string = vim_strsave(cwd);
10761 #ifdef BACKSLASH_IN_FILENAME
10762 if (rettv->vval.v_string != NULL)
10763 slash_adjust(rettv->vval.v_string);
10764 #endif
10769 * "getfontname()" function
10771 /*ARGSUSED*/
10772 static void
10773 f_getfontname(argvars, rettv)
10774 typval_T *argvars;
10775 typval_T *rettv;
10777 rettv->v_type = VAR_STRING;
10778 rettv->vval.v_string = NULL;
10779 #ifdef FEAT_GUI
10780 if (gui.in_use)
10782 GuiFont font;
10783 char_u *name = NULL;
10785 if (argvars[0].v_type == VAR_UNKNOWN)
10787 /* Get the "Normal" font. Either the name saved by
10788 * hl_set_font_name() or from the font ID. */
10789 font = gui.norm_font;
10790 name = hl_get_font_name();
10792 else
10794 name = get_tv_string(&argvars[0]);
10795 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10796 return;
10797 font = gui_mch_get_font(name, FALSE);
10798 if (font == NOFONT)
10799 return; /* Invalid font name, return empty string. */
10801 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10802 if (argvars[0].v_type != VAR_UNKNOWN)
10803 gui_mch_free_font(font);
10805 #endif
10809 * "getfperm({fname})" function
10811 static void
10812 f_getfperm(argvars, rettv)
10813 typval_T *argvars;
10814 typval_T *rettv;
10816 char_u *fname;
10817 struct stat st;
10818 char_u *perm = NULL;
10819 char_u flags[] = "rwx";
10820 int i;
10822 fname = get_tv_string(&argvars[0]);
10824 rettv->v_type = VAR_STRING;
10825 if (mch_stat((char *)fname, &st) >= 0)
10827 perm = vim_strsave((char_u *)"---------");
10828 if (perm != NULL)
10830 for (i = 0; i < 9; i++)
10832 if (st.st_mode & (1 << (8 - i)))
10833 perm[i] = flags[i % 3];
10837 rettv->vval.v_string = perm;
10841 * "getfsize({fname})" function
10843 static void
10844 f_getfsize(argvars, rettv)
10845 typval_T *argvars;
10846 typval_T *rettv;
10848 char_u *fname;
10849 struct stat st;
10851 fname = get_tv_string(&argvars[0]);
10853 rettv->v_type = VAR_NUMBER;
10855 if (mch_stat((char *)fname, &st) >= 0)
10857 if (mch_isdir(fname))
10858 rettv->vval.v_number = 0;
10859 else
10861 rettv->vval.v_number = (varnumber_T)st.st_size;
10863 /* non-perfect check for overflow */
10864 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10865 rettv->vval.v_number = -2;
10868 else
10869 rettv->vval.v_number = -1;
10873 * "getftime({fname})" function
10875 static void
10876 f_getftime(argvars, rettv)
10877 typval_T *argvars;
10878 typval_T *rettv;
10880 char_u *fname;
10881 struct stat st;
10883 fname = get_tv_string(&argvars[0]);
10885 if (mch_stat((char *)fname, &st) >= 0)
10886 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10887 else
10888 rettv->vval.v_number = -1;
10892 * "getftype({fname})" function
10894 static void
10895 f_getftype(argvars, rettv)
10896 typval_T *argvars;
10897 typval_T *rettv;
10899 char_u *fname;
10900 struct stat st;
10901 char_u *type = NULL;
10902 char *t;
10904 fname = get_tv_string(&argvars[0]);
10906 rettv->v_type = VAR_STRING;
10907 if (mch_lstat((char *)fname, &st) >= 0)
10909 #ifdef S_ISREG
10910 if (S_ISREG(st.st_mode))
10911 t = "file";
10912 else if (S_ISDIR(st.st_mode))
10913 t = "dir";
10914 # ifdef S_ISLNK
10915 else if (S_ISLNK(st.st_mode))
10916 t = "link";
10917 # endif
10918 # ifdef S_ISBLK
10919 else if (S_ISBLK(st.st_mode))
10920 t = "bdev";
10921 # endif
10922 # ifdef S_ISCHR
10923 else if (S_ISCHR(st.st_mode))
10924 t = "cdev";
10925 # endif
10926 # ifdef S_ISFIFO
10927 else if (S_ISFIFO(st.st_mode))
10928 t = "fifo";
10929 # endif
10930 # ifdef S_ISSOCK
10931 else if (S_ISSOCK(st.st_mode))
10932 t = "fifo";
10933 # endif
10934 else
10935 t = "other";
10936 #else
10937 # ifdef S_IFMT
10938 switch (st.st_mode & S_IFMT)
10940 case S_IFREG: t = "file"; break;
10941 case S_IFDIR: t = "dir"; break;
10942 # ifdef S_IFLNK
10943 case S_IFLNK: t = "link"; break;
10944 # endif
10945 # ifdef S_IFBLK
10946 case S_IFBLK: t = "bdev"; break;
10947 # endif
10948 # ifdef S_IFCHR
10949 case S_IFCHR: t = "cdev"; break;
10950 # endif
10951 # ifdef S_IFIFO
10952 case S_IFIFO: t = "fifo"; break;
10953 # endif
10954 # ifdef S_IFSOCK
10955 case S_IFSOCK: t = "socket"; break;
10956 # endif
10957 default: t = "other";
10959 # else
10960 if (mch_isdir(fname))
10961 t = "dir";
10962 else
10963 t = "file";
10964 # endif
10965 #endif
10966 type = vim_strsave((char_u *)t);
10968 rettv->vval.v_string = type;
10972 * "getline(lnum, [end])" function
10974 static void
10975 f_getline(argvars, rettv)
10976 typval_T *argvars;
10977 typval_T *rettv;
10979 linenr_T lnum;
10980 linenr_T end;
10981 int retlist;
10983 lnum = get_tv_lnum(argvars);
10984 if (argvars[1].v_type == VAR_UNKNOWN)
10986 end = 0;
10987 retlist = FALSE;
10989 else
10991 end = get_tv_lnum(&argvars[1]);
10992 retlist = TRUE;
10995 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
10999 * "getmatches()" function
11001 /*ARGSUSED*/
11002 static void
11003 f_getmatches(argvars, rettv)
11004 typval_T *argvars;
11005 typval_T *rettv;
11007 #ifdef FEAT_SEARCH_EXTRA
11008 dict_T *dict;
11009 matchitem_T *cur = curwin->w_match_head;
11011 rettv->vval.v_number = 0;
11013 if (rettv_list_alloc(rettv) == OK)
11015 while (cur != NULL)
11017 dict = dict_alloc();
11018 if (dict == NULL)
11019 return;
11020 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11021 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11022 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11023 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11024 list_append_dict(rettv->vval.v_list, dict);
11025 cur = cur->next;
11028 #endif
11032 * "getpid()" function
11034 /*ARGSUSED*/
11035 static void
11036 f_getpid(argvars, rettv)
11037 typval_T *argvars;
11038 typval_T *rettv;
11040 rettv->vval.v_number = mch_get_pid();
11044 * "getpos(string)" function
11046 static void
11047 f_getpos(argvars, rettv)
11048 typval_T *argvars;
11049 typval_T *rettv;
11051 pos_T *fp;
11052 list_T *l;
11053 int fnum = -1;
11055 if (rettv_list_alloc(rettv) == OK)
11057 l = rettv->vval.v_list;
11058 fp = var2fpos(&argvars[0], TRUE, &fnum);
11059 if (fnum != -1)
11060 list_append_number(l, (varnumber_T)fnum);
11061 else
11062 list_append_number(l, (varnumber_T)0);
11063 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11064 : (varnumber_T)0);
11065 list_append_number(l, (fp != NULL)
11066 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11067 : (varnumber_T)0);
11068 list_append_number(l,
11069 #ifdef FEAT_VIRTUALEDIT
11070 (fp != NULL) ? (varnumber_T)fp->coladd :
11071 #endif
11072 (varnumber_T)0);
11074 else
11075 rettv->vval.v_number = FALSE;
11079 * "getqflist()" and "getloclist()" functions
11081 /*ARGSUSED*/
11082 static void
11083 f_getqflist(argvars, rettv)
11084 typval_T *argvars;
11085 typval_T *rettv;
11087 #ifdef FEAT_QUICKFIX
11088 win_T *wp;
11089 #endif
11091 rettv->vval.v_number = 0;
11092 #ifdef FEAT_QUICKFIX
11093 if (rettv_list_alloc(rettv) == OK)
11095 wp = NULL;
11096 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11098 wp = find_win_by_nr(&argvars[0], NULL);
11099 if (wp == NULL)
11100 return;
11103 (void)get_errorlist(wp, rettv->vval.v_list);
11105 #endif
11109 * "getreg()" function
11111 static void
11112 f_getreg(argvars, rettv)
11113 typval_T *argvars;
11114 typval_T *rettv;
11116 char_u *strregname;
11117 int regname;
11118 int arg2 = FALSE;
11119 int error = FALSE;
11121 if (argvars[0].v_type != VAR_UNKNOWN)
11123 strregname = get_tv_string_chk(&argvars[0]);
11124 error = strregname == NULL;
11125 if (argvars[1].v_type != VAR_UNKNOWN)
11126 arg2 = get_tv_number_chk(&argvars[1], &error);
11128 else
11129 strregname = vimvars[VV_REG].vv_str;
11130 regname = (strregname == NULL ? '"' : *strregname);
11131 if (regname == 0)
11132 regname = '"';
11134 rettv->v_type = VAR_STRING;
11135 rettv->vval.v_string = error ? NULL :
11136 get_reg_contents(regname, TRUE, arg2);
11140 * "getregtype()" function
11142 static void
11143 f_getregtype(argvars, rettv)
11144 typval_T *argvars;
11145 typval_T *rettv;
11147 char_u *strregname;
11148 int regname;
11149 char_u buf[NUMBUFLEN + 2];
11150 long reglen = 0;
11152 if (argvars[0].v_type != VAR_UNKNOWN)
11154 strregname = get_tv_string_chk(&argvars[0]);
11155 if (strregname == NULL) /* type error; errmsg already given */
11157 rettv->v_type = VAR_STRING;
11158 rettv->vval.v_string = NULL;
11159 return;
11162 else
11163 /* Default to v:register */
11164 strregname = vimvars[VV_REG].vv_str;
11166 regname = (strregname == NULL ? '"' : *strregname);
11167 if (regname == 0)
11168 regname = '"';
11170 buf[0] = NUL;
11171 buf[1] = NUL;
11172 switch (get_reg_type(regname, &reglen))
11174 case MLINE: buf[0] = 'V'; break;
11175 case MCHAR: buf[0] = 'v'; break;
11176 #ifdef FEAT_VISUAL
11177 case MBLOCK:
11178 buf[0] = Ctrl_V;
11179 sprintf((char *)buf + 1, "%ld", reglen + 1);
11180 break;
11181 #endif
11183 rettv->v_type = VAR_STRING;
11184 rettv->vval.v_string = vim_strsave(buf);
11188 * "gettabwinvar()" function
11190 static void
11191 f_gettabwinvar(argvars, rettv)
11192 typval_T *argvars;
11193 typval_T *rettv;
11195 getwinvar(argvars, rettv, 1);
11199 * "getwinposx()" function
11201 /*ARGSUSED*/
11202 static void
11203 f_getwinposx(argvars, rettv)
11204 typval_T *argvars;
11205 typval_T *rettv;
11207 rettv->vval.v_number = -1;
11208 #ifdef FEAT_GUI
11209 if (gui.in_use)
11211 int x, y;
11213 if (gui_mch_get_winpos(&x, &y) == OK)
11214 rettv->vval.v_number = x;
11216 #endif
11220 * "getwinposy()" function
11222 /*ARGSUSED*/
11223 static void
11224 f_getwinposy(argvars, rettv)
11225 typval_T *argvars;
11226 typval_T *rettv;
11228 rettv->vval.v_number = -1;
11229 #ifdef FEAT_GUI
11230 if (gui.in_use)
11232 int x, y;
11234 if (gui_mch_get_winpos(&x, &y) == OK)
11235 rettv->vval.v_number = y;
11237 #endif
11241 * Find window specified by "vp" in tabpage "tp".
11243 static win_T *
11244 find_win_by_nr(vp, tp)
11245 typval_T *vp;
11246 tabpage_T *tp; /* NULL for current tab page */
11248 #ifdef FEAT_WINDOWS
11249 win_T *wp;
11250 #endif
11251 int nr;
11253 nr = get_tv_number_chk(vp, NULL);
11255 #ifdef FEAT_WINDOWS
11256 if (nr < 0)
11257 return NULL;
11258 if (nr == 0)
11259 return curwin;
11261 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11262 wp != NULL; wp = wp->w_next)
11263 if (--nr <= 0)
11264 break;
11265 return wp;
11266 #else
11267 if (nr == 0 || nr == 1)
11268 return curwin;
11269 return NULL;
11270 #endif
11274 * "getwinvar()" function
11276 static void
11277 f_getwinvar(argvars, rettv)
11278 typval_T *argvars;
11279 typval_T *rettv;
11281 getwinvar(argvars, rettv, 0);
11285 * getwinvar() and gettabwinvar()
11287 static void
11288 getwinvar(argvars, rettv, off)
11289 typval_T *argvars;
11290 typval_T *rettv;
11291 int off; /* 1 for gettabwinvar() */
11293 win_T *win, *oldcurwin;
11294 char_u *varname;
11295 dictitem_T *v;
11296 tabpage_T *tp;
11298 #ifdef FEAT_WINDOWS
11299 if (off == 1)
11300 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11301 else
11302 tp = curtab;
11303 #endif
11304 win = find_win_by_nr(&argvars[off], tp);
11305 varname = get_tv_string_chk(&argvars[off + 1]);
11306 ++emsg_off;
11308 rettv->v_type = VAR_STRING;
11309 rettv->vval.v_string = NULL;
11311 if (win != NULL && varname != NULL)
11313 /* Set curwin to be our win, temporarily. Also set curbuf, so
11314 * that we can get buffer-local options. */
11315 oldcurwin = curwin;
11316 curwin = win;
11317 curbuf = win->w_buffer;
11319 if (*varname == '&') /* window-local-option */
11320 get_option_tv(&varname, rettv, 1);
11321 else
11323 if (*varname == NUL)
11324 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11325 * scope prefix before the NUL byte is required by
11326 * find_var_in_ht(). */
11327 varname = (char_u *)"w:" + 2;
11328 /* look up the variable */
11329 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11330 if (v != NULL)
11331 copy_tv(&v->di_tv, rettv);
11334 /* restore previous notion of curwin */
11335 curwin = oldcurwin;
11336 curbuf = curwin->w_buffer;
11339 --emsg_off;
11343 * "glob()" function
11345 static void
11346 f_glob(argvars, rettv)
11347 typval_T *argvars;
11348 typval_T *rettv;
11350 int flags = WILD_SILENT|WILD_USE_NL;
11351 expand_T xpc;
11352 int error = FALSE;
11354 /* When the optional second argument is non-zero, don't remove matches
11355 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11356 if (argvars[1].v_type != VAR_UNKNOWN
11357 && get_tv_number_chk(&argvars[1], &error))
11358 flags |= WILD_KEEP_ALL;
11359 rettv->v_type = VAR_STRING;
11360 if (!error)
11362 ExpandInit(&xpc);
11363 xpc.xp_context = EXPAND_FILES;
11364 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11365 NULL, flags, WILD_ALL);
11367 else
11368 rettv->vval.v_string = NULL;
11372 * "globpath()" function
11374 static void
11375 f_globpath(argvars, rettv)
11376 typval_T *argvars;
11377 typval_T *rettv;
11379 int flags = 0;
11380 char_u buf1[NUMBUFLEN];
11381 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11382 int error = FALSE;
11384 /* When the optional second argument is non-zero, don't remove matches
11385 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11386 if (argvars[2].v_type != VAR_UNKNOWN
11387 && get_tv_number_chk(&argvars[2], &error))
11388 flags |= WILD_KEEP_ALL;
11389 rettv->v_type = VAR_STRING;
11390 if (file == NULL || error)
11391 rettv->vval.v_string = NULL;
11392 else
11393 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11394 flags);
11398 * "has()" function
11400 static void
11401 f_has(argvars, rettv)
11402 typval_T *argvars;
11403 typval_T *rettv;
11405 int i;
11406 char_u *name;
11407 int n = FALSE;
11408 static char *(has_list[]) =
11410 #ifdef AMIGA
11411 "amiga",
11412 # ifdef FEAT_ARP
11413 "arp",
11414 # endif
11415 #endif
11416 #ifdef __BEOS__
11417 "beos",
11418 #endif
11419 #ifdef MSDOS
11420 # ifdef DJGPP
11421 "dos32",
11422 # else
11423 "dos16",
11424 # endif
11425 #endif
11426 #ifdef MACOS
11427 "mac",
11428 #endif
11429 #if defined(MACOS_X_UNIX)
11430 "macunix",
11431 #endif
11432 #ifdef OS2
11433 "os2",
11434 #endif
11435 #ifdef __QNX__
11436 "qnx",
11437 #endif
11438 #ifdef RISCOS
11439 "riscos",
11440 #endif
11441 #ifdef UNIX
11442 "unix",
11443 #endif
11444 #ifdef VMS
11445 "vms",
11446 #endif
11447 #ifdef WIN16
11448 "win16",
11449 #endif
11450 #ifdef WIN32
11451 "win32",
11452 #endif
11453 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11454 "win32unix",
11455 #endif
11456 #ifdef WIN64
11457 "win64",
11458 #endif
11459 #ifdef EBCDIC
11460 "ebcdic",
11461 #endif
11462 #ifndef CASE_INSENSITIVE_FILENAME
11463 "fname_case",
11464 #endif
11465 #ifdef FEAT_ARABIC
11466 "arabic",
11467 #endif
11468 #ifdef FEAT_AUTOCMD
11469 "autocmd",
11470 #endif
11471 #ifdef FEAT_BEVAL
11472 "balloon_eval",
11473 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11474 "balloon_multiline",
11475 # endif
11476 #endif
11477 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11478 "builtin_terms",
11479 # ifdef ALL_BUILTIN_TCAPS
11480 "all_builtin_terms",
11481 # endif
11482 #endif
11483 #ifdef FEAT_BYTEOFF
11484 "byte_offset",
11485 #endif
11486 #ifdef FEAT_CINDENT
11487 "cindent",
11488 #endif
11489 #ifdef FEAT_CLIENTSERVER
11490 "clientserver",
11491 #endif
11492 #ifdef FEAT_CLIPBOARD
11493 "clipboard",
11494 #endif
11495 #ifdef FEAT_CMDL_COMPL
11496 "cmdline_compl",
11497 #endif
11498 #ifdef FEAT_CMDHIST
11499 "cmdline_hist",
11500 #endif
11501 #ifdef FEAT_COMMENTS
11502 "comments",
11503 #endif
11504 #ifdef FEAT_CRYPT
11505 "cryptv",
11506 #endif
11507 #ifdef FEAT_CSCOPE
11508 "cscope",
11509 #endif
11510 #ifdef CURSOR_SHAPE
11511 "cursorshape",
11512 #endif
11513 #ifdef DEBUG
11514 "debug",
11515 #endif
11516 #ifdef FEAT_CON_DIALOG
11517 "dialog_con",
11518 #endif
11519 #ifdef FEAT_GUI_DIALOG
11520 "dialog_gui",
11521 #endif
11522 #ifdef FEAT_DIFF
11523 "diff",
11524 #endif
11525 #ifdef FEAT_DIGRAPHS
11526 "digraphs",
11527 #endif
11528 #ifdef FEAT_DND
11529 "dnd",
11530 #endif
11531 #ifdef FEAT_EMACS_TAGS
11532 "emacs_tags",
11533 #endif
11534 "eval", /* always present, of course! */
11535 #ifdef FEAT_EX_EXTRA
11536 "ex_extra",
11537 #endif
11538 #ifdef FEAT_SEARCH_EXTRA
11539 "extra_search",
11540 #endif
11541 #ifdef FEAT_FKMAP
11542 "farsi",
11543 #endif
11544 #ifdef FEAT_SEARCHPATH
11545 "file_in_path",
11546 #endif
11547 #if defined(UNIX) && !defined(USE_SYSTEM)
11548 "filterpipe",
11549 #endif
11550 #ifdef FEAT_FIND_ID
11551 "find_in_path",
11552 #endif
11553 #ifdef FEAT_FLOAT
11554 "float",
11555 #endif
11556 #ifdef FEAT_FOLDING
11557 "folding",
11558 #endif
11559 #ifdef FEAT_FOOTER
11560 "footer",
11561 #endif
11562 #if !defined(USE_SYSTEM) && defined(UNIX)
11563 "fork",
11564 #endif
11565 #ifdef FEAT_GETTEXT
11566 "gettext",
11567 #endif
11568 #ifdef FEAT_GUI
11569 "gui",
11570 #endif
11571 #ifdef FEAT_GUI_ATHENA
11572 # ifdef FEAT_GUI_NEXTAW
11573 "gui_neXtaw",
11574 # else
11575 "gui_athena",
11576 # endif
11577 #endif
11578 #ifdef FEAT_GUI_GTK
11579 "gui_gtk",
11580 # ifdef HAVE_GTK2
11581 "gui_gtk2",
11582 # endif
11583 #endif
11584 #ifdef FEAT_GUI_GNOME
11585 "gui_gnome",
11586 #endif
11587 #ifdef FEAT_GUI_MAC
11588 "gui_mac",
11589 #endif
11590 #ifdef FEAT_GUI_MOTIF
11591 "gui_motif",
11592 #endif
11593 #ifdef FEAT_GUI_PHOTON
11594 "gui_photon",
11595 #endif
11596 #ifdef FEAT_GUI_W16
11597 "gui_win16",
11598 #endif
11599 #ifdef FEAT_GUI_W32
11600 "gui_win32",
11601 #endif
11602 #ifdef FEAT_HANGULIN
11603 "hangul_input",
11604 #endif
11605 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11606 "iconv",
11607 #endif
11608 #ifdef FEAT_INS_EXPAND
11609 "insert_expand",
11610 #endif
11611 #ifdef FEAT_JUMPLIST
11612 "jumplist",
11613 #endif
11614 #ifdef FEAT_KEYMAP
11615 "keymap",
11616 #endif
11617 #ifdef FEAT_LANGMAP
11618 "langmap",
11619 #endif
11620 #ifdef FEAT_LIBCALL
11621 "libcall",
11622 #endif
11623 #ifdef FEAT_LINEBREAK
11624 "linebreak",
11625 #endif
11626 #ifdef FEAT_LISP
11627 "lispindent",
11628 #endif
11629 #ifdef FEAT_LISTCMDS
11630 "listcmds",
11631 #endif
11632 #ifdef FEAT_LOCALMAP
11633 "localmap",
11634 #endif
11635 #ifdef FEAT_MENU
11636 "menu",
11637 #endif
11638 #ifdef FEAT_SESSION
11639 "mksession",
11640 #endif
11641 #ifdef FEAT_MODIFY_FNAME
11642 "modify_fname",
11643 #endif
11644 #ifdef FEAT_MOUSE
11645 "mouse",
11646 #endif
11647 #ifdef FEAT_MOUSESHAPE
11648 "mouseshape",
11649 #endif
11650 #if defined(UNIX) || defined(VMS)
11651 # ifdef FEAT_MOUSE_DEC
11652 "mouse_dec",
11653 # endif
11654 # ifdef FEAT_MOUSE_GPM
11655 "mouse_gpm",
11656 # endif
11657 # ifdef FEAT_MOUSE_JSB
11658 "mouse_jsbterm",
11659 # endif
11660 # ifdef FEAT_MOUSE_NET
11661 "mouse_netterm",
11662 # endif
11663 # ifdef FEAT_MOUSE_PTERM
11664 "mouse_pterm",
11665 # endif
11666 # ifdef FEAT_SYSMOUSE
11667 "mouse_sysmouse",
11668 # endif
11669 # ifdef FEAT_MOUSE_XTERM
11670 "mouse_xterm",
11671 # endif
11672 #endif
11673 #ifdef FEAT_MBYTE
11674 "multi_byte",
11675 #endif
11676 #ifdef FEAT_MBYTE_IME
11677 "multi_byte_ime",
11678 #endif
11679 #ifdef FEAT_MULTI_LANG
11680 "multi_lang",
11681 #endif
11682 #ifdef FEAT_MZSCHEME
11683 #ifndef DYNAMIC_MZSCHEME
11684 "mzscheme",
11685 #endif
11686 #endif
11687 #ifdef FEAT_OLE
11688 "ole",
11689 #endif
11690 #ifdef FEAT_OSFILETYPE
11691 "osfiletype",
11692 #endif
11693 #ifdef FEAT_PATH_EXTRA
11694 "path_extra",
11695 #endif
11696 #ifdef FEAT_PERL
11697 #ifndef DYNAMIC_PERL
11698 "perl",
11699 #endif
11700 #endif
11701 #ifdef FEAT_PYTHON
11702 #ifndef DYNAMIC_PYTHON
11703 "python",
11704 #endif
11705 #endif
11706 #ifdef FEAT_POSTSCRIPT
11707 "postscript",
11708 #endif
11709 #ifdef FEAT_PRINTER
11710 "printer",
11711 #endif
11712 #ifdef FEAT_PROFILE
11713 "profile",
11714 #endif
11715 #ifdef FEAT_RELTIME
11716 "reltime",
11717 #endif
11718 #ifdef FEAT_QUICKFIX
11719 "quickfix",
11720 #endif
11721 #ifdef FEAT_RIGHTLEFT
11722 "rightleft",
11723 #endif
11724 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11725 "ruby",
11726 #endif
11727 #ifdef FEAT_SCROLLBIND
11728 "scrollbind",
11729 #endif
11730 #ifdef FEAT_CMDL_INFO
11731 "showcmd",
11732 "cmdline_info",
11733 #endif
11734 #ifdef FEAT_SIGNS
11735 "signs",
11736 #endif
11737 #ifdef FEAT_SMARTINDENT
11738 "smartindent",
11739 #endif
11740 #ifdef FEAT_SNIFF
11741 "sniff",
11742 #endif
11743 #ifdef FEAT_STL_OPT
11744 "statusline",
11745 #endif
11746 #ifdef FEAT_SUN_WORKSHOP
11747 "sun_workshop",
11748 #endif
11749 #ifdef FEAT_NETBEANS_INTG
11750 "netbeans_intg",
11751 #endif
11752 #ifdef FEAT_SPELL
11753 "spell",
11754 #endif
11755 #ifdef FEAT_SYN_HL
11756 "syntax",
11757 #endif
11758 #if defined(USE_SYSTEM) || !defined(UNIX)
11759 "system",
11760 #endif
11761 #ifdef FEAT_TAG_BINS
11762 "tag_binary",
11763 #endif
11764 #ifdef FEAT_TAG_OLDSTATIC
11765 "tag_old_static",
11766 #endif
11767 #ifdef FEAT_TAG_ANYWHITE
11768 "tag_any_white",
11769 #endif
11770 #ifdef FEAT_TCL
11771 # ifndef DYNAMIC_TCL
11772 "tcl",
11773 # endif
11774 #endif
11775 #ifdef TERMINFO
11776 "terminfo",
11777 #endif
11778 #ifdef FEAT_TERMRESPONSE
11779 "termresponse",
11780 #endif
11781 #ifdef FEAT_TEXTOBJ
11782 "textobjects",
11783 #endif
11784 #ifdef HAVE_TGETENT
11785 "tgetent",
11786 #endif
11787 #ifdef FEAT_TITLE
11788 "title",
11789 #endif
11790 #ifdef FEAT_TOOLBAR
11791 "toolbar",
11792 #endif
11793 #ifdef FEAT_USR_CMDS
11794 "user-commands", /* was accidentally included in 5.4 */
11795 "user_commands",
11796 #endif
11797 #ifdef FEAT_VIMINFO
11798 "viminfo",
11799 #endif
11800 #ifdef FEAT_VERTSPLIT
11801 "vertsplit",
11802 #endif
11803 #ifdef FEAT_VIRTUALEDIT
11804 "virtualedit",
11805 #endif
11806 #ifdef FEAT_VISUAL
11807 "visual",
11808 #endif
11809 #ifdef FEAT_VISUALEXTRA
11810 "visualextra",
11811 #endif
11812 #ifdef FEAT_VREPLACE
11813 "vreplace",
11814 #endif
11815 #ifdef FEAT_WILDIGN
11816 "wildignore",
11817 #endif
11818 #ifdef FEAT_WILDMENU
11819 "wildmenu",
11820 #endif
11821 #ifdef FEAT_WINDOWS
11822 "windows",
11823 #endif
11824 #ifdef FEAT_WAK
11825 "winaltkeys",
11826 #endif
11827 #ifdef FEAT_WRITEBACKUP
11828 "writebackup",
11829 #endif
11830 #ifdef FEAT_XIM
11831 "xim",
11832 #endif
11833 #ifdef FEAT_XFONTSET
11834 "xfontset",
11835 #endif
11836 #ifdef USE_XSMP
11837 "xsmp",
11838 #endif
11839 #ifdef USE_XSMP_INTERACT
11840 "xsmp_interact",
11841 #endif
11842 #ifdef FEAT_XCLIPBOARD
11843 "xterm_clipboard",
11844 #endif
11845 #ifdef FEAT_XTERM_SAVE
11846 "xterm_save",
11847 #endif
11848 #if defined(UNIX) && defined(FEAT_X11)
11849 "X11",
11850 #endif
11851 NULL
11854 name = get_tv_string(&argvars[0]);
11855 for (i = 0; has_list[i] != NULL; ++i)
11856 if (STRICMP(name, has_list[i]) == 0)
11858 n = TRUE;
11859 break;
11862 if (n == FALSE)
11864 if (STRNICMP(name, "patch", 5) == 0)
11865 n = has_patch(atoi((char *)name + 5));
11866 else if (STRICMP(name, "vim_starting") == 0)
11867 n = (starting != 0);
11868 #ifdef FEAT_MBYTE
11869 else if (STRICMP(name, "multi_byte_encoding") == 0)
11870 n = has_mbyte;
11871 #endif
11872 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11873 else if (STRICMP(name, "balloon_multiline") == 0)
11874 n = multiline_balloon_available();
11875 #endif
11876 #ifdef DYNAMIC_TCL
11877 else if (STRICMP(name, "tcl") == 0)
11878 n = tcl_enabled(FALSE);
11879 #endif
11880 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11881 else if (STRICMP(name, "iconv") == 0)
11882 n = iconv_enabled(FALSE);
11883 #endif
11884 #ifdef DYNAMIC_MZSCHEME
11885 else if (STRICMP(name, "mzscheme") == 0)
11886 n = mzscheme_enabled(FALSE);
11887 #endif
11888 #ifdef DYNAMIC_RUBY
11889 else if (STRICMP(name, "ruby") == 0)
11890 n = ruby_enabled(FALSE);
11891 #endif
11892 #ifdef DYNAMIC_PYTHON
11893 else if (STRICMP(name, "python") == 0)
11894 n = python_enabled(FALSE);
11895 #endif
11896 #ifdef DYNAMIC_PERL
11897 else if (STRICMP(name, "perl") == 0)
11898 n = perl_enabled(FALSE);
11899 #endif
11900 #ifdef FEAT_GUI
11901 else if (STRICMP(name, "gui_running") == 0)
11902 n = (gui.in_use || gui.starting);
11903 # ifdef FEAT_GUI_W32
11904 else if (STRICMP(name, "gui_win32s") == 0)
11905 n = gui_is_win32s();
11906 # endif
11907 # ifdef FEAT_BROWSE
11908 else if (STRICMP(name, "browse") == 0)
11909 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11910 # endif
11911 #endif
11912 #ifdef FEAT_SYN_HL
11913 else if (STRICMP(name, "syntax_items") == 0)
11914 n = syntax_present(curbuf);
11915 #endif
11916 #if defined(WIN3264)
11917 else if (STRICMP(name, "win95") == 0)
11918 n = mch_windows95();
11919 #endif
11920 #ifdef FEAT_NETBEANS_INTG
11921 else if (STRICMP(name, "netbeans_enabled") == 0)
11922 n = usingNetbeans;
11923 #endif
11926 rettv->vval.v_number = n;
11930 * "has_key()" function
11932 static void
11933 f_has_key(argvars, rettv)
11934 typval_T *argvars;
11935 typval_T *rettv;
11937 rettv->vval.v_number = 0;
11938 if (argvars[0].v_type != VAR_DICT)
11940 EMSG(_(e_dictreq));
11941 return;
11943 if (argvars[0].vval.v_dict == NULL)
11944 return;
11946 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11947 get_tv_string(&argvars[1]), -1) != NULL;
11951 * "haslocaldir()" function
11953 /*ARGSUSED*/
11954 static void
11955 f_haslocaldir(argvars, rettv)
11956 typval_T *argvars;
11957 typval_T *rettv;
11959 rettv->vval.v_number = (curwin->w_localdir != NULL);
11963 * "hasmapto()" function
11965 static void
11966 f_hasmapto(argvars, rettv)
11967 typval_T *argvars;
11968 typval_T *rettv;
11970 char_u *name;
11971 char_u *mode;
11972 char_u buf[NUMBUFLEN];
11973 int abbr = FALSE;
11975 name = get_tv_string(&argvars[0]);
11976 if (argvars[1].v_type == VAR_UNKNOWN)
11977 mode = (char_u *)"nvo";
11978 else
11980 mode = get_tv_string_buf(&argvars[1], buf);
11981 if (argvars[2].v_type != VAR_UNKNOWN)
11982 abbr = get_tv_number(&argvars[2]);
11985 if (map_to_exists(name, mode, abbr))
11986 rettv->vval.v_number = TRUE;
11987 else
11988 rettv->vval.v_number = FALSE;
11992 * "histadd()" function
11994 /*ARGSUSED*/
11995 static void
11996 f_histadd(argvars, rettv)
11997 typval_T *argvars;
11998 typval_T *rettv;
12000 #ifdef FEAT_CMDHIST
12001 int histype;
12002 char_u *str;
12003 char_u buf[NUMBUFLEN];
12004 #endif
12006 rettv->vval.v_number = FALSE;
12007 if (check_restricted() || check_secure())
12008 return;
12009 #ifdef FEAT_CMDHIST
12010 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12011 histype = str != NULL ? get_histtype(str) : -1;
12012 if (histype >= 0)
12014 str = get_tv_string_buf(&argvars[1], buf);
12015 if (*str != NUL)
12017 add_to_history(histype, str, FALSE, NUL);
12018 rettv->vval.v_number = TRUE;
12019 return;
12022 #endif
12026 * "histdel()" function
12028 /*ARGSUSED*/
12029 static void
12030 f_histdel(argvars, rettv)
12031 typval_T *argvars;
12032 typval_T *rettv;
12034 #ifdef FEAT_CMDHIST
12035 int n;
12036 char_u buf[NUMBUFLEN];
12037 char_u *str;
12039 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12040 if (str == NULL)
12041 n = 0;
12042 else if (argvars[1].v_type == VAR_UNKNOWN)
12043 /* only one argument: clear entire history */
12044 n = clr_history(get_histtype(str));
12045 else if (argvars[1].v_type == VAR_NUMBER)
12046 /* index given: remove that entry */
12047 n = del_history_idx(get_histtype(str),
12048 (int)get_tv_number(&argvars[1]));
12049 else
12050 /* string given: remove all matching entries */
12051 n = del_history_entry(get_histtype(str),
12052 get_tv_string_buf(&argvars[1], buf));
12053 rettv->vval.v_number = n;
12054 #else
12055 rettv->vval.v_number = 0;
12056 #endif
12060 * "histget()" function
12062 /*ARGSUSED*/
12063 static void
12064 f_histget(argvars, rettv)
12065 typval_T *argvars;
12066 typval_T *rettv;
12068 #ifdef FEAT_CMDHIST
12069 int type;
12070 int idx;
12071 char_u *str;
12073 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12074 if (str == NULL)
12075 rettv->vval.v_string = NULL;
12076 else
12078 type = get_histtype(str);
12079 if (argvars[1].v_type == VAR_UNKNOWN)
12080 idx = get_history_idx(type);
12081 else
12082 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12083 /* -1 on type error */
12084 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12086 #else
12087 rettv->vval.v_string = NULL;
12088 #endif
12089 rettv->v_type = VAR_STRING;
12093 * "histnr()" function
12095 /*ARGSUSED*/
12096 static void
12097 f_histnr(argvars, rettv)
12098 typval_T *argvars;
12099 typval_T *rettv;
12101 int i;
12103 #ifdef FEAT_CMDHIST
12104 char_u *history = get_tv_string_chk(&argvars[0]);
12106 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12107 if (i >= HIST_CMD && i < HIST_COUNT)
12108 i = get_history_idx(i);
12109 else
12110 #endif
12111 i = -1;
12112 rettv->vval.v_number = i;
12116 * "highlightID(name)" function
12118 static void
12119 f_hlID(argvars, rettv)
12120 typval_T *argvars;
12121 typval_T *rettv;
12123 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12127 * "highlight_exists()" function
12129 static void
12130 f_hlexists(argvars, rettv)
12131 typval_T *argvars;
12132 typval_T *rettv;
12134 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12138 * "hostname()" function
12140 /*ARGSUSED*/
12141 static void
12142 f_hostname(argvars, rettv)
12143 typval_T *argvars;
12144 typval_T *rettv;
12146 char_u hostname[256];
12148 mch_get_host_name(hostname, 256);
12149 rettv->v_type = VAR_STRING;
12150 rettv->vval.v_string = vim_strsave(hostname);
12154 * iconv() function
12156 /*ARGSUSED*/
12157 static void
12158 f_iconv(argvars, rettv)
12159 typval_T *argvars;
12160 typval_T *rettv;
12162 #ifdef FEAT_MBYTE
12163 char_u buf1[NUMBUFLEN];
12164 char_u buf2[NUMBUFLEN];
12165 char_u *from, *to, *str;
12166 vimconv_T vimconv;
12167 #endif
12169 rettv->v_type = VAR_STRING;
12170 rettv->vval.v_string = NULL;
12172 #ifdef FEAT_MBYTE
12173 str = get_tv_string(&argvars[0]);
12174 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12175 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12176 vimconv.vc_type = CONV_NONE;
12177 convert_setup(&vimconv, from, to);
12179 /* If the encodings are equal, no conversion needed. */
12180 if (vimconv.vc_type == CONV_NONE)
12181 rettv->vval.v_string = vim_strsave(str);
12182 else
12183 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12185 convert_setup(&vimconv, NULL, NULL);
12186 vim_free(from);
12187 vim_free(to);
12188 #endif
12192 * "indent()" function
12194 static void
12195 f_indent(argvars, rettv)
12196 typval_T *argvars;
12197 typval_T *rettv;
12199 linenr_T lnum;
12201 lnum = get_tv_lnum(argvars);
12202 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12203 rettv->vval.v_number = get_indent_lnum(lnum);
12204 else
12205 rettv->vval.v_number = -1;
12209 * "index()" function
12211 static void
12212 f_index(argvars, rettv)
12213 typval_T *argvars;
12214 typval_T *rettv;
12216 list_T *l;
12217 listitem_T *item;
12218 long idx = 0;
12219 int ic = FALSE;
12221 rettv->vval.v_number = -1;
12222 if (argvars[0].v_type != VAR_LIST)
12224 EMSG(_(e_listreq));
12225 return;
12227 l = argvars[0].vval.v_list;
12228 if (l != NULL)
12230 item = l->lv_first;
12231 if (argvars[2].v_type != VAR_UNKNOWN)
12233 int error = FALSE;
12235 /* Start at specified item. Use the cached index that list_find()
12236 * sets, so that a negative number also works. */
12237 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12238 idx = l->lv_idx;
12239 if (argvars[3].v_type != VAR_UNKNOWN)
12240 ic = get_tv_number_chk(&argvars[3], &error);
12241 if (error)
12242 item = NULL;
12245 for ( ; item != NULL; item = item->li_next, ++idx)
12246 if (tv_equal(&item->li_tv, &argvars[1], ic))
12248 rettv->vval.v_number = idx;
12249 break;
12254 static int inputsecret_flag = 0;
12256 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12259 * This function is used by f_input() and f_inputdialog() functions. The third
12260 * argument to f_input() specifies the type of completion to use at the
12261 * prompt. The third argument to f_inputdialog() specifies the value to return
12262 * when the user cancels the prompt.
12264 static void
12265 get_user_input(argvars, rettv, inputdialog)
12266 typval_T *argvars;
12267 typval_T *rettv;
12268 int inputdialog;
12270 char_u *prompt = get_tv_string_chk(&argvars[0]);
12271 char_u *p = NULL;
12272 int c;
12273 char_u buf[NUMBUFLEN];
12274 int cmd_silent_save = cmd_silent;
12275 char_u *defstr = (char_u *)"";
12276 int xp_type = EXPAND_NOTHING;
12277 char_u *xp_arg = NULL;
12279 rettv->v_type = VAR_STRING;
12280 rettv->vval.v_string = NULL;
12282 #ifdef NO_CONSOLE_INPUT
12283 /* While starting up, there is no place to enter text. */
12284 if (no_console_input())
12285 return;
12286 #endif
12288 cmd_silent = FALSE; /* Want to see the prompt. */
12289 if (prompt != NULL)
12291 /* Only the part of the message after the last NL is considered as
12292 * prompt for the command line */
12293 p = vim_strrchr(prompt, '\n');
12294 if (p == NULL)
12295 p = prompt;
12296 else
12298 ++p;
12299 c = *p;
12300 *p = NUL;
12301 msg_start();
12302 msg_clr_eos();
12303 msg_puts_attr(prompt, echo_attr);
12304 msg_didout = FALSE;
12305 msg_starthere();
12306 *p = c;
12308 cmdline_row = msg_row;
12310 if (argvars[1].v_type != VAR_UNKNOWN)
12312 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12313 if (defstr != NULL)
12314 stuffReadbuffSpec(defstr);
12316 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12318 char_u *xp_name;
12319 int xp_namelen;
12320 long argt;
12322 rettv->vval.v_string = NULL;
12324 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12325 if (xp_name == NULL)
12326 return;
12328 xp_namelen = (int)STRLEN(xp_name);
12330 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12331 &xp_arg) == FAIL)
12332 return;
12336 if (defstr != NULL)
12337 rettv->vval.v_string =
12338 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12339 xp_type, xp_arg);
12341 vim_free(xp_arg);
12343 /* since the user typed this, no need to wait for return */
12344 need_wait_return = FALSE;
12345 msg_didout = FALSE;
12347 cmd_silent = cmd_silent_save;
12351 * "input()" function
12352 * Also handles inputsecret() when inputsecret is set.
12354 static void
12355 f_input(argvars, rettv)
12356 typval_T *argvars;
12357 typval_T *rettv;
12359 get_user_input(argvars, rettv, FALSE);
12363 * "inputdialog()" function
12365 static void
12366 f_inputdialog(argvars, rettv)
12367 typval_T *argvars;
12368 typval_T *rettv;
12370 #if defined(FEAT_GUI_TEXTDIALOG)
12371 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12372 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12374 char_u *message;
12375 char_u buf[NUMBUFLEN];
12376 char_u *defstr = (char_u *)"";
12378 message = get_tv_string_chk(&argvars[0]);
12379 if (argvars[1].v_type != VAR_UNKNOWN
12380 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12381 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12382 else
12383 IObuff[0] = NUL;
12384 if (message != NULL && defstr != NULL
12385 && do_dialog(VIM_QUESTION, NULL, message,
12386 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12387 rettv->vval.v_string = vim_strsave(IObuff);
12388 else
12390 if (message != NULL && defstr != NULL
12391 && argvars[1].v_type != VAR_UNKNOWN
12392 && argvars[2].v_type != VAR_UNKNOWN)
12393 rettv->vval.v_string = vim_strsave(
12394 get_tv_string_buf(&argvars[2], buf));
12395 else
12396 rettv->vval.v_string = NULL;
12398 rettv->v_type = VAR_STRING;
12400 else
12401 #endif
12402 get_user_input(argvars, rettv, TRUE);
12406 * "inputlist()" function
12408 static void
12409 f_inputlist(argvars, rettv)
12410 typval_T *argvars;
12411 typval_T *rettv;
12413 listitem_T *li;
12414 int selected;
12415 int mouse_used;
12417 rettv->vval.v_number = 0;
12418 #ifdef NO_CONSOLE_INPUT
12419 /* While starting up, there is no place to enter text. */
12420 if (no_console_input())
12421 return;
12422 #endif
12423 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12425 EMSG2(_(e_listarg), "inputlist()");
12426 return;
12429 msg_start();
12430 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12431 lines_left = Rows; /* avoid more prompt */
12432 msg_scroll = TRUE;
12433 msg_clr_eos();
12435 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12437 msg_puts(get_tv_string(&li->li_tv));
12438 msg_putchar('\n');
12441 /* Ask for choice. */
12442 selected = prompt_for_number(&mouse_used);
12443 if (mouse_used)
12444 selected -= lines_left;
12446 rettv->vval.v_number = selected;
12450 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12453 * "inputrestore()" function
12455 /*ARGSUSED*/
12456 static void
12457 f_inputrestore(argvars, rettv)
12458 typval_T *argvars;
12459 typval_T *rettv;
12461 if (ga_userinput.ga_len > 0)
12463 --ga_userinput.ga_len;
12464 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12465 + ga_userinput.ga_len);
12466 rettv->vval.v_number = 0; /* OK */
12468 else if (p_verbose > 1)
12470 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12471 rettv->vval.v_number = 1; /* Failed */
12476 * "inputsave()" function
12478 /*ARGSUSED*/
12479 static void
12480 f_inputsave(argvars, rettv)
12481 typval_T *argvars;
12482 typval_T *rettv;
12484 /* Add an entry to the stack of typeahead storage. */
12485 if (ga_grow(&ga_userinput, 1) == OK)
12487 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12488 + ga_userinput.ga_len);
12489 ++ga_userinput.ga_len;
12490 rettv->vval.v_number = 0; /* OK */
12492 else
12493 rettv->vval.v_number = 1; /* Failed */
12497 * "inputsecret()" function
12499 static void
12500 f_inputsecret(argvars, rettv)
12501 typval_T *argvars;
12502 typval_T *rettv;
12504 ++cmdline_star;
12505 ++inputsecret_flag;
12506 f_input(argvars, rettv);
12507 --cmdline_star;
12508 --inputsecret_flag;
12512 * "insert()" function
12514 static void
12515 f_insert(argvars, rettv)
12516 typval_T *argvars;
12517 typval_T *rettv;
12519 long before = 0;
12520 listitem_T *item;
12521 list_T *l;
12522 int error = FALSE;
12524 rettv->vval.v_number = 0;
12525 if (argvars[0].v_type != VAR_LIST)
12526 EMSG2(_(e_listarg), "insert()");
12527 else if ((l = argvars[0].vval.v_list) != NULL
12528 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12530 if (argvars[2].v_type != VAR_UNKNOWN)
12531 before = get_tv_number_chk(&argvars[2], &error);
12532 if (error)
12533 return; /* type error; errmsg already given */
12535 if (before == l->lv_len)
12536 item = NULL;
12537 else
12539 item = list_find(l, before);
12540 if (item == NULL)
12542 EMSGN(_(e_listidx), before);
12543 l = NULL;
12546 if (l != NULL)
12548 list_insert_tv(l, &argvars[1], item);
12549 copy_tv(&argvars[0], rettv);
12555 * "isdirectory()" function
12557 static void
12558 f_isdirectory(argvars, rettv)
12559 typval_T *argvars;
12560 typval_T *rettv;
12562 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12566 * "islocked()" function
12568 static void
12569 f_islocked(argvars, rettv)
12570 typval_T *argvars;
12571 typval_T *rettv;
12573 lval_T lv;
12574 char_u *end;
12575 dictitem_T *di;
12577 rettv->vval.v_number = -1;
12578 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12579 FNE_CHECK_START);
12580 if (end != NULL && lv.ll_name != NULL)
12582 if (*end != NUL)
12583 EMSG(_(e_trailing));
12584 else
12586 if (lv.ll_tv == NULL)
12588 if (check_changedtick(lv.ll_name))
12589 rettv->vval.v_number = 1; /* always locked */
12590 else
12592 di = find_var(lv.ll_name, NULL);
12593 if (di != NULL)
12595 /* Consider a variable locked when:
12596 * 1. the variable itself is locked
12597 * 2. the value of the variable is locked.
12598 * 3. the List or Dict value is locked.
12600 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12601 || tv_islocked(&di->di_tv));
12605 else if (lv.ll_range)
12606 EMSG(_("E786: Range not allowed"));
12607 else if (lv.ll_newkey != NULL)
12608 EMSG2(_(e_dictkey), lv.ll_newkey);
12609 else if (lv.ll_list != NULL)
12610 /* List item. */
12611 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12612 else
12613 /* Dictionary item. */
12614 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12618 clear_lval(&lv);
12621 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12624 * Turn a dict into a list:
12625 * "what" == 0: list of keys
12626 * "what" == 1: list of values
12627 * "what" == 2: list of items
12629 static void
12630 dict_list(argvars, rettv, what)
12631 typval_T *argvars;
12632 typval_T *rettv;
12633 int what;
12635 list_T *l2;
12636 dictitem_T *di;
12637 hashitem_T *hi;
12638 listitem_T *li;
12639 listitem_T *li2;
12640 dict_T *d;
12641 int todo;
12643 rettv->vval.v_number = 0;
12644 if (argvars[0].v_type != VAR_DICT)
12646 EMSG(_(e_dictreq));
12647 return;
12649 if ((d = argvars[0].vval.v_dict) == NULL)
12650 return;
12652 if (rettv_list_alloc(rettv) == FAIL)
12653 return;
12655 todo = (int)d->dv_hashtab.ht_used;
12656 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12658 if (!HASHITEM_EMPTY(hi))
12660 --todo;
12661 di = HI2DI(hi);
12663 li = listitem_alloc();
12664 if (li == NULL)
12665 break;
12666 list_append(rettv->vval.v_list, li);
12668 if (what == 0)
12670 /* keys() */
12671 li->li_tv.v_type = VAR_STRING;
12672 li->li_tv.v_lock = 0;
12673 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12675 else if (what == 1)
12677 /* values() */
12678 copy_tv(&di->di_tv, &li->li_tv);
12680 else
12682 /* items() */
12683 l2 = list_alloc();
12684 li->li_tv.v_type = VAR_LIST;
12685 li->li_tv.v_lock = 0;
12686 li->li_tv.vval.v_list = l2;
12687 if (l2 == NULL)
12688 break;
12689 ++l2->lv_refcount;
12691 li2 = listitem_alloc();
12692 if (li2 == NULL)
12693 break;
12694 list_append(l2, li2);
12695 li2->li_tv.v_type = VAR_STRING;
12696 li2->li_tv.v_lock = 0;
12697 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12699 li2 = listitem_alloc();
12700 if (li2 == NULL)
12701 break;
12702 list_append(l2, li2);
12703 copy_tv(&di->di_tv, &li2->li_tv);
12710 * "items(dict)" function
12712 static void
12713 f_items(argvars, rettv)
12714 typval_T *argvars;
12715 typval_T *rettv;
12717 dict_list(argvars, rettv, 2);
12721 * "join()" function
12723 static void
12724 f_join(argvars, rettv)
12725 typval_T *argvars;
12726 typval_T *rettv;
12728 garray_T ga;
12729 char_u *sep;
12731 rettv->vval.v_number = 0;
12732 if (argvars[0].v_type != VAR_LIST)
12734 EMSG(_(e_listreq));
12735 return;
12737 if (argvars[0].vval.v_list == NULL)
12738 return;
12739 if (argvars[1].v_type == VAR_UNKNOWN)
12740 sep = (char_u *)" ";
12741 else
12742 sep = get_tv_string_chk(&argvars[1]);
12744 rettv->v_type = VAR_STRING;
12746 if (sep != NULL)
12748 ga_init2(&ga, (int)sizeof(char), 80);
12749 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12750 ga_append(&ga, NUL);
12751 rettv->vval.v_string = (char_u *)ga.ga_data;
12753 else
12754 rettv->vval.v_string = NULL;
12758 * "keys()" function
12760 static void
12761 f_keys(argvars, rettv)
12762 typval_T *argvars;
12763 typval_T *rettv;
12765 dict_list(argvars, rettv, 0);
12769 * "last_buffer_nr()" function.
12771 /*ARGSUSED*/
12772 static void
12773 f_last_buffer_nr(argvars, rettv)
12774 typval_T *argvars;
12775 typval_T *rettv;
12777 int n = 0;
12778 buf_T *buf;
12780 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12781 if (n < buf->b_fnum)
12782 n = buf->b_fnum;
12784 rettv->vval.v_number = n;
12788 * "len()" function
12790 static void
12791 f_len(argvars, rettv)
12792 typval_T *argvars;
12793 typval_T *rettv;
12795 switch (argvars[0].v_type)
12797 case VAR_STRING:
12798 case VAR_NUMBER:
12799 rettv->vval.v_number = (varnumber_T)STRLEN(
12800 get_tv_string(&argvars[0]));
12801 break;
12802 case VAR_LIST:
12803 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12804 break;
12805 case VAR_DICT:
12806 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12807 break;
12808 default:
12809 EMSG(_("E701: Invalid type for len()"));
12810 break;
12814 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12816 static void
12817 libcall_common(argvars, rettv, type)
12818 typval_T *argvars;
12819 typval_T *rettv;
12820 int type;
12822 #ifdef FEAT_LIBCALL
12823 char_u *string_in;
12824 char_u **string_result;
12825 int nr_result;
12826 #endif
12828 rettv->v_type = type;
12829 if (type == VAR_NUMBER)
12830 rettv->vval.v_number = 0;
12831 else
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 /*ARGSUSED*/
12904 static void
12905 f_line2byte(argvars, rettv)
12906 typval_T *argvars;
12907 typval_T *rettv;
12909 #ifndef FEAT_BYTEOFF
12910 rettv->vval.v_number = -1;
12911 #else
12912 linenr_T lnum;
12914 lnum = get_tv_lnum(argvars);
12915 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12916 rettv->vval.v_number = -1;
12917 else
12918 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12919 if (rettv->vval.v_number >= 0)
12920 ++rettv->vval.v_number;
12921 #endif
12925 * "lispindent(lnum)" function
12927 static void
12928 f_lispindent(argvars, rettv)
12929 typval_T *argvars;
12930 typval_T *rettv;
12932 #ifdef FEAT_LISP
12933 pos_T pos;
12934 linenr_T lnum;
12936 pos = curwin->w_cursor;
12937 lnum = get_tv_lnum(argvars);
12938 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12940 curwin->w_cursor.lnum = lnum;
12941 rettv->vval.v_number = get_lisp_indent();
12942 curwin->w_cursor = pos;
12944 else
12945 #endif
12946 rettv->vval.v_number = -1;
12950 * "localtime()" function
12952 /*ARGSUSED*/
12953 static void
12954 f_localtime(argvars, rettv)
12955 typval_T *argvars;
12956 typval_T *rettv;
12958 rettv->vval.v_number = (varnumber_T)time(NULL);
12961 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12963 static void
12964 get_maparg(argvars, rettv, exact)
12965 typval_T *argvars;
12966 typval_T *rettv;
12967 int exact;
12969 char_u *keys;
12970 char_u *which;
12971 char_u buf[NUMBUFLEN];
12972 char_u *keys_buf = NULL;
12973 char_u *rhs;
12974 int mode;
12975 garray_T ga;
12976 int abbr = FALSE;
12978 /* return empty string for failure */
12979 rettv->v_type = VAR_STRING;
12980 rettv->vval.v_string = NULL;
12982 keys = get_tv_string(&argvars[0]);
12983 if (*keys == NUL)
12984 return;
12986 if (argvars[1].v_type != VAR_UNKNOWN)
12988 which = get_tv_string_buf_chk(&argvars[1], buf);
12989 if (argvars[2].v_type != VAR_UNKNOWN)
12990 abbr = get_tv_number(&argvars[2]);
12992 else
12993 which = (char_u *)"";
12994 if (which == NULL)
12995 return;
12997 mode = get_map_mode(&which, 0);
12999 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
13000 rhs = check_map(keys, mode, exact, FALSE, abbr);
13001 vim_free(keys_buf);
13002 if (rhs != NULL)
13004 ga_init(&ga);
13005 ga.ga_itemsize = 1;
13006 ga.ga_growsize = 40;
13008 while (*rhs != NUL)
13009 ga_concat(&ga, str2special(&rhs, FALSE));
13011 ga_append(&ga, NUL);
13012 rettv->vval.v_string = (char_u *)ga.ga_data;
13016 #ifdef FEAT_FLOAT
13018 * "log10()" function
13020 static void
13021 f_log10(argvars, rettv)
13022 typval_T *argvars;
13023 typval_T *rettv;
13025 float_T f;
13027 rettv->v_type = VAR_FLOAT;
13028 if (get_float_arg(argvars, &f) == OK)
13029 rettv->vval.v_float = log10(f);
13030 else
13031 rettv->vval.v_float = 0.0;
13033 #endif
13036 * "map()" function
13038 static void
13039 f_map(argvars, rettv)
13040 typval_T *argvars;
13041 typval_T *rettv;
13043 filter_map(argvars, rettv, TRUE);
13047 * "maparg()" function
13049 static void
13050 f_maparg(argvars, rettv)
13051 typval_T *argvars;
13052 typval_T *rettv;
13054 get_maparg(argvars, rettv, TRUE);
13058 * "mapcheck()" function
13060 static void
13061 f_mapcheck(argvars, rettv)
13062 typval_T *argvars;
13063 typval_T *rettv;
13065 get_maparg(argvars, rettv, FALSE);
13068 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13070 static void
13071 find_some_match(argvars, rettv, type)
13072 typval_T *argvars;
13073 typval_T *rettv;
13074 int type;
13076 char_u *str = NULL;
13077 char_u *expr = NULL;
13078 char_u *pat;
13079 regmatch_T regmatch;
13080 char_u patbuf[NUMBUFLEN];
13081 char_u strbuf[NUMBUFLEN];
13082 char_u *save_cpo;
13083 long start = 0;
13084 long nth = 1;
13085 colnr_T startcol = 0;
13086 int match = 0;
13087 list_T *l = NULL;
13088 listitem_T *li = NULL;
13089 long idx = 0;
13090 char_u *tofree = NULL;
13092 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13093 save_cpo = p_cpo;
13094 p_cpo = (char_u *)"";
13096 rettv->vval.v_number = -1;
13097 if (type == 3)
13099 /* return empty list when there are no matches */
13100 if (rettv_list_alloc(rettv) == FAIL)
13101 goto theend;
13103 else if (type == 2)
13105 rettv->v_type = VAR_STRING;
13106 rettv->vval.v_string = NULL;
13109 if (argvars[0].v_type == VAR_LIST)
13111 if ((l = argvars[0].vval.v_list) == NULL)
13112 goto theend;
13113 li = l->lv_first;
13115 else
13116 expr = str = get_tv_string(&argvars[0]);
13118 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13119 if (pat == NULL)
13120 goto theend;
13122 if (argvars[2].v_type != VAR_UNKNOWN)
13124 int error = FALSE;
13126 start = get_tv_number_chk(&argvars[2], &error);
13127 if (error)
13128 goto theend;
13129 if (l != NULL)
13131 li = list_find(l, start);
13132 if (li == NULL)
13133 goto theend;
13134 idx = l->lv_idx; /* use the cached index */
13136 else
13138 if (start < 0)
13139 start = 0;
13140 if (start > (long)STRLEN(str))
13141 goto theend;
13142 /* When "count" argument is there ignore matches before "start",
13143 * otherwise skip part of the string. Differs when pattern is "^"
13144 * or "\<". */
13145 if (argvars[3].v_type != VAR_UNKNOWN)
13146 startcol = start;
13147 else
13148 str += start;
13151 if (argvars[3].v_type != VAR_UNKNOWN)
13152 nth = get_tv_number_chk(&argvars[3], &error);
13153 if (error)
13154 goto theend;
13157 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13158 if (regmatch.regprog != NULL)
13160 regmatch.rm_ic = p_ic;
13162 for (;;)
13164 if (l != NULL)
13166 if (li == NULL)
13168 match = FALSE;
13169 break;
13171 vim_free(tofree);
13172 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13173 if (str == NULL)
13174 break;
13177 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13179 if (match && --nth <= 0)
13180 break;
13181 if (l == NULL && !match)
13182 break;
13184 /* Advance to just after the match. */
13185 if (l != NULL)
13187 li = li->li_next;
13188 ++idx;
13190 else
13192 #ifdef FEAT_MBYTE
13193 startcol = (colnr_T)(regmatch.startp[0]
13194 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13195 #else
13196 startcol = regmatch.startp[0] + 1 - str;
13197 #endif
13201 if (match)
13203 if (type == 3)
13205 int i;
13207 /* return list with matched string and submatches */
13208 for (i = 0; i < NSUBEXP; ++i)
13210 if (regmatch.endp[i] == NULL)
13212 if (list_append_string(rettv->vval.v_list,
13213 (char_u *)"", 0) == FAIL)
13214 break;
13216 else if (list_append_string(rettv->vval.v_list,
13217 regmatch.startp[i],
13218 (int)(regmatch.endp[i] - regmatch.startp[i]))
13219 == FAIL)
13220 break;
13223 else if (type == 2)
13225 /* return matched string */
13226 if (l != NULL)
13227 copy_tv(&li->li_tv, rettv);
13228 else
13229 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13230 (int)(regmatch.endp[0] - regmatch.startp[0]));
13232 else if (l != NULL)
13233 rettv->vval.v_number = idx;
13234 else
13236 if (type != 0)
13237 rettv->vval.v_number =
13238 (varnumber_T)(regmatch.startp[0] - str);
13239 else
13240 rettv->vval.v_number =
13241 (varnumber_T)(regmatch.endp[0] - str);
13242 rettv->vval.v_number += (varnumber_T)(str - expr);
13245 vim_free(regmatch.regprog);
13248 theend:
13249 vim_free(tofree);
13250 p_cpo = save_cpo;
13254 * "match()" function
13256 static void
13257 f_match(argvars, rettv)
13258 typval_T *argvars;
13259 typval_T *rettv;
13261 find_some_match(argvars, rettv, 1);
13265 * "matchadd()" function
13267 static void
13268 f_matchadd(argvars, rettv)
13269 typval_T *argvars;
13270 typval_T *rettv;
13272 #ifdef FEAT_SEARCH_EXTRA
13273 char_u buf[NUMBUFLEN];
13274 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13275 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13276 int prio = 10; /* default priority */
13277 int id = -1;
13278 int error = FALSE;
13280 rettv->vval.v_number = -1;
13282 if (grp == NULL || pat == NULL)
13283 return;
13284 if (argvars[2].v_type != VAR_UNKNOWN)
13286 prio = get_tv_number_chk(&argvars[2], &error);
13287 if (argvars[3].v_type != VAR_UNKNOWN)
13288 id = get_tv_number_chk(&argvars[3], &error);
13290 if (error == TRUE)
13291 return;
13292 if (id >= 1 && id <= 3)
13294 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13295 return;
13298 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13299 #endif
13303 * "matcharg()" function
13305 static void
13306 f_matcharg(argvars, rettv)
13307 typval_T *argvars;
13308 typval_T *rettv;
13310 if (rettv_list_alloc(rettv) == OK)
13312 #ifdef FEAT_SEARCH_EXTRA
13313 int id = get_tv_number(&argvars[0]);
13314 matchitem_T *m;
13316 if (id >= 1 && id <= 3)
13318 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13320 list_append_string(rettv->vval.v_list,
13321 syn_id2name(m->hlg_id), -1);
13322 list_append_string(rettv->vval.v_list, m->pattern, -1);
13324 else
13326 list_append_string(rettv->vval.v_list, NUL, -1);
13327 list_append_string(rettv->vval.v_list, NUL, -1);
13330 #endif
13335 * "matchdelete()" function
13337 static void
13338 f_matchdelete(argvars, rettv)
13339 typval_T *argvars;
13340 typval_T *rettv;
13342 #ifdef FEAT_SEARCH_EXTRA
13343 rettv->vval.v_number = match_delete(curwin,
13344 (int)get_tv_number(&argvars[0]), TRUE);
13345 #endif
13349 * "matchend()" function
13351 static void
13352 f_matchend(argvars, rettv)
13353 typval_T *argvars;
13354 typval_T *rettv;
13356 find_some_match(argvars, rettv, 0);
13360 * "matchlist()" function
13362 static void
13363 f_matchlist(argvars, rettv)
13364 typval_T *argvars;
13365 typval_T *rettv;
13367 find_some_match(argvars, rettv, 3);
13371 * "matchstr()" function
13373 static void
13374 f_matchstr(argvars, rettv)
13375 typval_T *argvars;
13376 typval_T *rettv;
13378 find_some_match(argvars, rettv, 2);
13381 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13383 static void
13384 max_min(argvars, rettv, domax)
13385 typval_T *argvars;
13386 typval_T *rettv;
13387 int domax;
13389 long n = 0;
13390 long i;
13391 int error = FALSE;
13393 if (argvars[0].v_type == VAR_LIST)
13395 list_T *l;
13396 listitem_T *li;
13398 l = argvars[0].vval.v_list;
13399 if (l != NULL)
13401 li = l->lv_first;
13402 if (li != NULL)
13404 n = get_tv_number_chk(&li->li_tv, &error);
13405 for (;;)
13407 li = li->li_next;
13408 if (li == NULL)
13409 break;
13410 i = get_tv_number_chk(&li->li_tv, &error);
13411 if (domax ? i > n : i < n)
13412 n = i;
13417 else if (argvars[0].v_type == VAR_DICT)
13419 dict_T *d;
13420 int first = TRUE;
13421 hashitem_T *hi;
13422 int todo;
13424 d = argvars[0].vval.v_dict;
13425 if (d != NULL)
13427 todo = (int)d->dv_hashtab.ht_used;
13428 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13430 if (!HASHITEM_EMPTY(hi))
13432 --todo;
13433 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13434 if (first)
13436 n = i;
13437 first = FALSE;
13439 else if (domax ? i > n : i < n)
13440 n = i;
13445 else
13446 EMSG(_(e_listdictarg));
13447 rettv->vval.v_number = error ? 0 : n;
13451 * "max()" function
13453 static void
13454 f_max(argvars, rettv)
13455 typval_T *argvars;
13456 typval_T *rettv;
13458 max_min(argvars, rettv, TRUE);
13462 * "min()" function
13464 static void
13465 f_min(argvars, rettv)
13466 typval_T *argvars;
13467 typval_T *rettv;
13469 max_min(argvars, rettv, FALSE);
13472 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13475 * Create the directory in which "dir" is located, and higher levels when
13476 * needed.
13478 static int
13479 mkdir_recurse(dir, prot)
13480 char_u *dir;
13481 int prot;
13483 char_u *p;
13484 char_u *updir;
13485 int r = FAIL;
13487 /* Get end of directory name in "dir".
13488 * We're done when it's "/" or "c:/". */
13489 p = gettail_sep(dir);
13490 if (p <= get_past_head(dir))
13491 return OK;
13493 /* If the directory exists we're done. Otherwise: create it.*/
13494 updir = vim_strnsave(dir, (int)(p - dir));
13495 if (updir == NULL)
13496 return FAIL;
13497 if (mch_isdir(updir))
13498 r = OK;
13499 else if (mkdir_recurse(updir, prot) == OK)
13500 r = vim_mkdir_emsg(updir, prot);
13501 vim_free(updir);
13502 return r;
13505 #ifdef vim_mkdir
13507 * "mkdir()" function
13509 static void
13510 f_mkdir(argvars, rettv)
13511 typval_T *argvars;
13512 typval_T *rettv;
13514 char_u *dir;
13515 char_u buf[NUMBUFLEN];
13516 int prot = 0755;
13518 rettv->vval.v_number = FAIL;
13519 if (check_restricted() || check_secure())
13520 return;
13522 dir = get_tv_string_buf(&argvars[0], buf);
13523 if (argvars[1].v_type != VAR_UNKNOWN)
13525 if (argvars[2].v_type != VAR_UNKNOWN)
13526 prot = get_tv_number_chk(&argvars[2], NULL);
13527 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13528 mkdir_recurse(dir, prot);
13530 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13532 #endif
13535 * "mode()" function
13537 /*ARGSUSED*/
13538 static void
13539 f_mode(argvars, rettv)
13540 typval_T *argvars;
13541 typval_T *rettv;
13543 char_u buf[3];
13545 buf[1] = NUL;
13546 buf[2] = NUL;
13548 #ifdef FEAT_VISUAL
13549 if (VIsual_active)
13551 if (VIsual_select)
13552 buf[0] = VIsual_mode + 's' - 'v';
13553 else
13554 buf[0] = VIsual_mode;
13556 else
13557 #endif
13558 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13559 || State == CONFIRM)
13561 buf[0] = 'r';
13562 if (State == ASKMORE)
13563 buf[1] = 'm';
13564 else if (State == CONFIRM)
13565 buf[1] = '?';
13567 else if (State == EXTERNCMD)
13568 buf[0] = '!';
13569 else if (State & INSERT)
13571 #ifdef FEAT_VREPLACE
13572 if (State & VREPLACE_FLAG)
13574 buf[0] = 'R';
13575 buf[1] = 'v';
13577 else
13578 #endif
13579 if (State & REPLACE_FLAG)
13580 buf[0] = 'R';
13581 else
13582 buf[0] = 'i';
13584 else if (State & CMDLINE)
13586 buf[0] = 'c';
13587 if (exmode_active)
13588 buf[1] = 'v';
13590 else if (exmode_active)
13592 buf[0] = 'c';
13593 buf[1] = 'e';
13595 else
13597 buf[0] = 'n';
13598 if (finish_op)
13599 buf[1] = 'o';
13602 /* Clear out the minor mode when the argument is not a non-zero number or
13603 * non-empty string. */
13604 if (!non_zero_arg(&argvars[0]))
13605 buf[1] = NUL;
13607 rettv->vval.v_string = vim_strsave(buf);
13608 rettv->v_type = VAR_STRING;
13612 * "nextnonblank()" function
13614 static void
13615 f_nextnonblank(argvars, rettv)
13616 typval_T *argvars;
13617 typval_T *rettv;
13619 linenr_T lnum;
13621 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13623 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13625 lnum = 0;
13626 break;
13628 if (*skipwhite(ml_get(lnum)) != NUL)
13629 break;
13631 rettv->vval.v_number = lnum;
13635 * "nr2char()" function
13637 static void
13638 f_nr2char(argvars, rettv)
13639 typval_T *argvars;
13640 typval_T *rettv;
13642 char_u buf[NUMBUFLEN];
13644 #ifdef FEAT_MBYTE
13645 if (has_mbyte)
13646 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13647 else
13648 #endif
13650 buf[0] = (char_u)get_tv_number(&argvars[0]);
13651 buf[1] = NUL;
13653 rettv->v_type = VAR_STRING;
13654 rettv->vval.v_string = vim_strsave(buf);
13658 * "pathshorten()" function
13660 static void
13661 f_pathshorten(argvars, rettv)
13662 typval_T *argvars;
13663 typval_T *rettv;
13665 char_u *p;
13667 rettv->v_type = VAR_STRING;
13668 p = get_tv_string_chk(&argvars[0]);
13669 if (p == NULL)
13670 rettv->vval.v_string = NULL;
13671 else
13673 p = vim_strsave(p);
13674 rettv->vval.v_string = p;
13675 if (p != NULL)
13676 shorten_dir(p);
13680 #ifdef FEAT_FLOAT
13682 * "pow()" function
13684 static void
13685 f_pow(argvars, rettv)
13686 typval_T *argvars;
13687 typval_T *rettv;
13689 float_T fx, fy;
13691 rettv->v_type = VAR_FLOAT;
13692 if (get_float_arg(argvars, &fx) == OK
13693 && get_float_arg(&argvars[1], &fy) == OK)
13694 rettv->vval.v_float = pow(fx, fy);
13695 else
13696 rettv->vval.v_float = 0.0;
13698 #endif
13701 * "prevnonblank()" function
13703 static void
13704 f_prevnonblank(argvars, rettv)
13705 typval_T *argvars;
13706 typval_T *rettv;
13708 linenr_T lnum;
13710 lnum = get_tv_lnum(argvars);
13711 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13712 lnum = 0;
13713 else
13714 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13715 --lnum;
13716 rettv->vval.v_number = lnum;
13719 #ifdef HAVE_STDARG_H
13720 /* This dummy va_list is here because:
13721 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13722 * - locally in the function results in a "used before set" warning
13723 * - using va_start() to initialize it gives "function with fixed args" error */
13724 static va_list ap;
13725 #endif
13728 * "printf()" function
13730 static void
13731 f_printf(argvars, rettv)
13732 typval_T *argvars;
13733 typval_T *rettv;
13735 rettv->v_type = VAR_STRING;
13736 rettv->vval.v_string = NULL;
13737 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13739 char_u buf[NUMBUFLEN];
13740 int len;
13741 char_u *s;
13742 int saved_did_emsg = did_emsg;
13743 char *fmt;
13745 /* Get the required length, allocate the buffer and do it for real. */
13746 did_emsg = FALSE;
13747 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13748 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13749 if (!did_emsg)
13751 s = alloc(len + 1);
13752 if (s != NULL)
13754 rettv->vval.v_string = s;
13755 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13758 did_emsg |= saved_did_emsg;
13760 #endif
13764 * "pumvisible()" function
13766 /*ARGSUSED*/
13767 static void
13768 f_pumvisible(argvars, rettv)
13769 typval_T *argvars;
13770 typval_T *rettv;
13772 rettv->vval.v_number = 0;
13773 #ifdef FEAT_INS_EXPAND
13774 if (pum_visible())
13775 rettv->vval.v_number = 1;
13776 #endif
13780 * "range()" function
13782 static void
13783 f_range(argvars, rettv)
13784 typval_T *argvars;
13785 typval_T *rettv;
13787 long start;
13788 long end;
13789 long stride = 1;
13790 long i;
13791 int error = FALSE;
13793 start = get_tv_number_chk(&argvars[0], &error);
13794 if (argvars[1].v_type == VAR_UNKNOWN)
13796 end = start - 1;
13797 start = 0;
13799 else
13801 end = get_tv_number_chk(&argvars[1], &error);
13802 if (argvars[2].v_type != VAR_UNKNOWN)
13803 stride = get_tv_number_chk(&argvars[2], &error);
13806 rettv->vval.v_number = 0;
13807 if (error)
13808 return; /* type error; errmsg already given */
13809 if (stride == 0)
13810 EMSG(_("E726: Stride is zero"));
13811 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13812 EMSG(_("E727: Start past end"));
13813 else
13815 if (rettv_list_alloc(rettv) == OK)
13816 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13817 if (list_append_number(rettv->vval.v_list,
13818 (varnumber_T)i) == FAIL)
13819 break;
13824 * "readfile()" function
13826 static void
13827 f_readfile(argvars, rettv)
13828 typval_T *argvars;
13829 typval_T *rettv;
13831 int binary = FALSE;
13832 char_u *fname;
13833 FILE *fd;
13834 listitem_T *li;
13835 #define FREAD_SIZE 200 /* optimized for text lines */
13836 char_u buf[FREAD_SIZE];
13837 int readlen; /* size of last fread() */
13838 int buflen; /* nr of valid chars in buf[] */
13839 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13840 int tolist; /* first byte in buf[] still to be put in list */
13841 int chop; /* how many CR to chop off */
13842 char_u *prev = NULL; /* previously read bytes, if any */
13843 int prevlen = 0; /* length of "prev" if not NULL */
13844 char_u *s;
13845 int len;
13846 long maxline = MAXLNUM;
13847 long cnt = 0;
13849 if (argvars[1].v_type != VAR_UNKNOWN)
13851 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13852 binary = TRUE;
13853 if (argvars[2].v_type != VAR_UNKNOWN)
13854 maxline = get_tv_number(&argvars[2]);
13857 if (rettv_list_alloc(rettv) == FAIL)
13858 return;
13860 /* Always open the file in binary mode, library functions have a mind of
13861 * their own about CR-LF conversion. */
13862 fname = get_tv_string(&argvars[0]);
13863 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13865 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13866 return;
13869 filtd = 0;
13870 while (cnt < maxline || maxline < 0)
13872 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13873 buflen = filtd + readlen;
13874 tolist = 0;
13875 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13877 if (buf[filtd] == '\n' || readlen <= 0)
13879 /* Only when in binary mode add an empty list item when the
13880 * last line ends in a '\n'. */
13881 if (!binary && readlen == 0 && filtd == 0)
13882 break;
13884 /* Found end-of-line or end-of-file: add a text line to the
13885 * list. */
13886 chop = 0;
13887 if (!binary)
13888 while (filtd - chop - 1 >= tolist
13889 && buf[filtd - chop - 1] == '\r')
13890 ++chop;
13891 len = filtd - tolist - chop;
13892 if (prev == NULL)
13893 s = vim_strnsave(buf + tolist, len);
13894 else
13896 s = alloc((unsigned)(prevlen + len + 1));
13897 if (s != NULL)
13899 mch_memmove(s, prev, prevlen);
13900 vim_free(prev);
13901 prev = NULL;
13902 mch_memmove(s + prevlen, buf + tolist, len);
13903 s[prevlen + len] = NUL;
13906 tolist = filtd + 1;
13908 li = listitem_alloc();
13909 if (li == NULL)
13911 vim_free(s);
13912 break;
13914 li->li_tv.v_type = VAR_STRING;
13915 li->li_tv.v_lock = 0;
13916 li->li_tv.vval.v_string = s;
13917 list_append(rettv->vval.v_list, li);
13919 if (++cnt >= maxline && maxline >= 0)
13920 break;
13921 if (readlen <= 0)
13922 break;
13924 else if (buf[filtd] == NUL)
13925 buf[filtd] = '\n';
13927 if (readlen <= 0)
13928 break;
13930 if (tolist == 0)
13932 /* "buf" is full, need to move text to an allocated buffer */
13933 if (prev == NULL)
13935 prev = vim_strnsave(buf, buflen);
13936 prevlen = buflen;
13938 else
13940 s = alloc((unsigned)(prevlen + buflen));
13941 if (s != NULL)
13943 mch_memmove(s, prev, prevlen);
13944 mch_memmove(s + prevlen, buf, buflen);
13945 vim_free(prev);
13946 prev = s;
13947 prevlen += buflen;
13950 filtd = 0;
13952 else
13954 mch_memmove(buf, buf + tolist, buflen - tolist);
13955 filtd -= tolist;
13960 * For a negative line count use only the lines at the end of the file,
13961 * free the rest.
13963 if (maxline < 0)
13964 while (cnt > -maxline)
13966 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13967 --cnt;
13970 vim_free(prev);
13971 fclose(fd);
13974 #if defined(FEAT_RELTIME)
13975 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13978 * Convert a List to proftime_T.
13979 * Return FAIL when there is something wrong.
13981 static int
13982 list2proftime(arg, tm)
13983 typval_T *arg;
13984 proftime_T *tm;
13986 long n1, n2;
13987 int error = FALSE;
13989 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13990 || arg->vval.v_list->lv_len != 2)
13991 return FAIL;
13992 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13993 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13994 # ifdef WIN3264
13995 tm->HighPart = n1;
13996 tm->LowPart = n2;
13997 # else
13998 tm->tv_sec = n1;
13999 tm->tv_usec = n2;
14000 # endif
14001 return error ? FAIL : OK;
14003 #endif /* FEAT_RELTIME */
14006 * "reltime()" function
14008 static void
14009 f_reltime(argvars, rettv)
14010 typval_T *argvars;
14011 typval_T *rettv;
14013 #ifdef FEAT_RELTIME
14014 proftime_T res;
14015 proftime_T start;
14017 if (argvars[0].v_type == VAR_UNKNOWN)
14019 /* No arguments: get current time. */
14020 profile_start(&res);
14022 else if (argvars[1].v_type == VAR_UNKNOWN)
14024 if (list2proftime(&argvars[0], &res) == FAIL)
14025 return;
14026 profile_end(&res);
14028 else
14030 /* Two arguments: compute the difference. */
14031 if (list2proftime(&argvars[0], &start) == FAIL
14032 || list2proftime(&argvars[1], &res) == FAIL)
14033 return;
14034 profile_sub(&res, &start);
14037 if (rettv_list_alloc(rettv) == OK)
14039 long n1, n2;
14041 # ifdef WIN3264
14042 n1 = res.HighPart;
14043 n2 = res.LowPart;
14044 # else
14045 n1 = res.tv_sec;
14046 n2 = res.tv_usec;
14047 # endif
14048 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14049 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14051 #endif
14055 * "reltimestr()" function
14057 static void
14058 f_reltimestr(argvars, rettv)
14059 typval_T *argvars;
14060 typval_T *rettv;
14062 #ifdef FEAT_RELTIME
14063 proftime_T tm;
14064 #endif
14066 rettv->v_type = VAR_STRING;
14067 rettv->vval.v_string = NULL;
14068 #ifdef FEAT_RELTIME
14069 if (list2proftime(&argvars[0], &tm) == OK)
14070 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14071 #endif
14074 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14075 static void make_connection __ARGS((void));
14076 static int check_connection __ARGS((void));
14078 static void
14079 make_connection()
14081 if (X_DISPLAY == NULL
14082 # ifdef FEAT_GUI
14083 && !gui.in_use
14084 # endif
14087 x_force_connect = TRUE;
14088 setup_term_clip();
14089 x_force_connect = FALSE;
14093 static int
14094 check_connection()
14096 make_connection();
14097 if (X_DISPLAY == NULL)
14099 EMSG(_("E240: No connection to Vim server"));
14100 return FAIL;
14102 return OK;
14104 #endif
14106 #ifdef FEAT_CLIENTSERVER
14107 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14109 static void
14110 remote_common(argvars, rettv, expr)
14111 typval_T *argvars;
14112 typval_T *rettv;
14113 int expr;
14115 char_u *server_name;
14116 char_u *keys;
14117 char_u *r = NULL;
14118 char_u buf[NUMBUFLEN];
14119 # ifdef WIN32
14120 HWND w;
14121 # else
14122 Window w;
14123 # endif
14125 if (check_restricted() || check_secure())
14126 return;
14128 # ifdef FEAT_X11
14129 if (check_connection() == FAIL)
14130 return;
14131 # endif
14133 server_name = get_tv_string_chk(&argvars[0]);
14134 if (server_name == NULL)
14135 return; /* type error; errmsg already given */
14136 keys = get_tv_string_buf(&argvars[1], buf);
14137 # ifdef WIN32
14138 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14139 # else
14140 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14141 < 0)
14142 # endif
14144 if (r != NULL)
14145 EMSG(r); /* sending worked but evaluation failed */
14146 else
14147 EMSG2(_("E241: Unable to send to %s"), server_name);
14148 return;
14151 rettv->vval.v_string = r;
14153 if (argvars[2].v_type != VAR_UNKNOWN)
14155 dictitem_T v;
14156 char_u str[30];
14157 char_u *idvar;
14159 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14160 v.di_tv.v_type = VAR_STRING;
14161 v.di_tv.vval.v_string = vim_strsave(str);
14162 idvar = get_tv_string_chk(&argvars[2]);
14163 if (idvar != NULL)
14164 set_var(idvar, &v.di_tv, FALSE);
14165 vim_free(v.di_tv.vval.v_string);
14168 #endif
14171 * "remote_expr()" function
14173 /*ARGSUSED*/
14174 static void
14175 f_remote_expr(argvars, rettv)
14176 typval_T *argvars;
14177 typval_T *rettv;
14179 rettv->v_type = VAR_STRING;
14180 rettv->vval.v_string = NULL;
14181 #ifdef FEAT_CLIENTSERVER
14182 remote_common(argvars, rettv, TRUE);
14183 #endif
14187 * "remote_foreground()" function
14189 /*ARGSUSED*/
14190 static void
14191 f_remote_foreground(argvars, rettv)
14192 typval_T *argvars;
14193 typval_T *rettv;
14195 rettv->vval.v_number = 0;
14196 #ifdef FEAT_CLIENTSERVER
14197 # ifdef WIN32
14198 /* On Win32 it's done in this application. */
14200 char_u *server_name = get_tv_string_chk(&argvars[0]);
14202 if (server_name != NULL)
14203 serverForeground(server_name);
14205 # else
14206 /* Send a foreground() expression to the server. */
14207 argvars[1].v_type = VAR_STRING;
14208 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14209 argvars[2].v_type = VAR_UNKNOWN;
14210 remote_common(argvars, rettv, TRUE);
14211 vim_free(argvars[1].vval.v_string);
14212 # endif
14213 #endif
14216 /*ARGSUSED*/
14217 static void
14218 f_remote_peek(argvars, rettv)
14219 typval_T *argvars;
14220 typval_T *rettv;
14222 #ifdef FEAT_CLIENTSERVER
14223 dictitem_T v;
14224 char_u *s = NULL;
14225 # ifdef WIN32
14226 long_u n = 0;
14227 # endif
14228 char_u *serverid;
14230 if (check_restricted() || check_secure())
14232 rettv->vval.v_number = -1;
14233 return;
14235 serverid = get_tv_string_chk(&argvars[0]);
14236 if (serverid == NULL)
14238 rettv->vval.v_number = -1;
14239 return; /* type error; errmsg already given */
14241 # ifdef WIN32
14242 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14243 if (n == 0)
14244 rettv->vval.v_number = -1;
14245 else
14247 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14248 rettv->vval.v_number = (s != NULL);
14250 # else
14251 rettv->vval.v_number = 0;
14252 if (check_connection() == FAIL)
14253 return;
14255 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14256 serverStrToWin(serverid), &s);
14257 # endif
14259 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14261 char_u *retvar;
14263 v.di_tv.v_type = VAR_STRING;
14264 v.di_tv.vval.v_string = vim_strsave(s);
14265 retvar = get_tv_string_chk(&argvars[1]);
14266 if (retvar != NULL)
14267 set_var(retvar, &v.di_tv, FALSE);
14268 vim_free(v.di_tv.vval.v_string);
14270 #else
14271 rettv->vval.v_number = -1;
14272 #endif
14275 /*ARGSUSED*/
14276 static void
14277 f_remote_read(argvars, rettv)
14278 typval_T *argvars;
14279 typval_T *rettv;
14281 char_u *r = NULL;
14283 #ifdef FEAT_CLIENTSERVER
14284 char_u *serverid = get_tv_string_chk(&argvars[0]);
14286 if (serverid != NULL && !check_restricted() && !check_secure())
14288 # ifdef WIN32
14289 /* The server's HWND is encoded in the 'id' parameter */
14290 long_u n = 0;
14292 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14293 if (n != 0)
14294 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14295 if (r == NULL)
14296 # else
14297 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14298 serverStrToWin(serverid), &r, FALSE) < 0)
14299 # endif
14300 EMSG(_("E277: Unable to read a server reply"));
14302 #endif
14303 rettv->v_type = VAR_STRING;
14304 rettv->vval.v_string = r;
14308 * "remote_send()" function
14310 /*ARGSUSED*/
14311 static void
14312 f_remote_send(argvars, rettv)
14313 typval_T *argvars;
14314 typval_T *rettv;
14316 rettv->v_type = VAR_STRING;
14317 rettv->vval.v_string = NULL;
14318 #ifdef FEAT_CLIENTSERVER
14319 remote_common(argvars, rettv, FALSE);
14320 #endif
14324 * "remove()" function
14326 static void
14327 f_remove(argvars, rettv)
14328 typval_T *argvars;
14329 typval_T *rettv;
14331 list_T *l;
14332 listitem_T *item, *item2;
14333 listitem_T *li;
14334 long idx;
14335 long end;
14336 char_u *key;
14337 dict_T *d;
14338 dictitem_T *di;
14340 rettv->vval.v_number = 0;
14341 if (argvars[0].v_type == VAR_DICT)
14343 if (argvars[2].v_type != VAR_UNKNOWN)
14344 EMSG2(_(e_toomanyarg), "remove()");
14345 else if ((d = argvars[0].vval.v_dict) != NULL
14346 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14348 key = get_tv_string_chk(&argvars[1]);
14349 if (key != NULL)
14351 di = dict_find(d, key, -1);
14352 if (di == NULL)
14353 EMSG2(_(e_dictkey), key);
14354 else
14356 *rettv = di->di_tv;
14357 init_tv(&di->di_tv);
14358 dictitem_remove(d, di);
14363 else if (argvars[0].v_type != VAR_LIST)
14364 EMSG2(_(e_listdictarg), "remove()");
14365 else if ((l = argvars[0].vval.v_list) != NULL
14366 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14368 int error = FALSE;
14370 idx = get_tv_number_chk(&argvars[1], &error);
14371 if (error)
14372 ; /* type error: do nothing, errmsg already given */
14373 else if ((item = list_find(l, idx)) == NULL)
14374 EMSGN(_(e_listidx), idx);
14375 else
14377 if (argvars[2].v_type == VAR_UNKNOWN)
14379 /* Remove one item, return its value. */
14380 list_remove(l, item, item);
14381 *rettv = item->li_tv;
14382 vim_free(item);
14384 else
14386 /* Remove range of items, return list with values. */
14387 end = get_tv_number_chk(&argvars[2], &error);
14388 if (error)
14389 ; /* type error: do nothing */
14390 else if ((item2 = list_find(l, end)) == NULL)
14391 EMSGN(_(e_listidx), end);
14392 else
14394 int cnt = 0;
14396 for (li = item; li != NULL; li = li->li_next)
14398 ++cnt;
14399 if (li == item2)
14400 break;
14402 if (li == NULL) /* didn't find "item2" after "item" */
14403 EMSG(_(e_invrange));
14404 else
14406 list_remove(l, item, item2);
14407 if (rettv_list_alloc(rettv) == OK)
14409 l = rettv->vval.v_list;
14410 l->lv_first = item;
14411 l->lv_last = item2;
14412 item->li_prev = NULL;
14413 item2->li_next = NULL;
14414 l->lv_len = cnt;
14424 * "rename({from}, {to})" function
14426 static void
14427 f_rename(argvars, rettv)
14428 typval_T *argvars;
14429 typval_T *rettv;
14431 char_u buf[NUMBUFLEN];
14433 if (check_restricted() || check_secure())
14434 rettv->vval.v_number = -1;
14435 else
14436 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14437 get_tv_string_buf(&argvars[1], buf));
14441 * "repeat()" function
14443 /*ARGSUSED*/
14444 static void
14445 f_repeat(argvars, rettv)
14446 typval_T *argvars;
14447 typval_T *rettv;
14449 char_u *p;
14450 int n;
14451 int slen;
14452 int len;
14453 char_u *r;
14454 int i;
14456 n = get_tv_number(&argvars[1]);
14457 if (argvars[0].v_type == VAR_LIST)
14459 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14460 while (n-- > 0)
14461 if (list_extend(rettv->vval.v_list,
14462 argvars[0].vval.v_list, NULL) == FAIL)
14463 break;
14465 else
14467 p = get_tv_string(&argvars[0]);
14468 rettv->v_type = VAR_STRING;
14469 rettv->vval.v_string = NULL;
14471 slen = (int)STRLEN(p);
14472 len = slen * n;
14473 if (len <= 0)
14474 return;
14476 r = alloc(len + 1);
14477 if (r != NULL)
14479 for (i = 0; i < n; i++)
14480 mch_memmove(r + i * slen, p, (size_t)slen);
14481 r[len] = NUL;
14484 rettv->vval.v_string = r;
14489 * "resolve()" function
14491 static void
14492 f_resolve(argvars, rettv)
14493 typval_T *argvars;
14494 typval_T *rettv;
14496 char_u *p;
14498 p = get_tv_string(&argvars[0]);
14499 #ifdef FEAT_SHORTCUT
14501 char_u *v = NULL;
14503 v = mch_resolve_shortcut(p);
14504 if (v != NULL)
14505 rettv->vval.v_string = v;
14506 else
14507 rettv->vval.v_string = vim_strsave(p);
14509 #else
14510 # ifdef HAVE_READLINK
14512 char_u buf[MAXPATHL + 1];
14513 char_u *cpy;
14514 int len;
14515 char_u *remain = NULL;
14516 char_u *q;
14517 int is_relative_to_current = FALSE;
14518 int has_trailing_pathsep = FALSE;
14519 int limit = 100;
14521 p = vim_strsave(p);
14523 if (p[0] == '.' && (vim_ispathsep(p[1])
14524 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14525 is_relative_to_current = TRUE;
14527 len = STRLEN(p);
14528 if (len > 0 && after_pathsep(p, p + len))
14529 has_trailing_pathsep = TRUE;
14531 q = getnextcomp(p);
14532 if (*q != NUL)
14534 /* Separate the first path component in "p", and keep the
14535 * remainder (beginning with the path separator). */
14536 remain = vim_strsave(q - 1);
14537 q[-1] = NUL;
14540 for (;;)
14542 for (;;)
14544 len = readlink((char *)p, (char *)buf, MAXPATHL);
14545 if (len <= 0)
14546 break;
14547 buf[len] = NUL;
14549 if (limit-- == 0)
14551 vim_free(p);
14552 vim_free(remain);
14553 EMSG(_("E655: Too many symbolic links (cycle?)"));
14554 rettv->vval.v_string = NULL;
14555 goto fail;
14558 /* Ensure that the result will have a trailing path separator
14559 * if the argument has one. */
14560 if (remain == NULL && has_trailing_pathsep)
14561 add_pathsep(buf);
14563 /* Separate the first path component in the link value and
14564 * concatenate the remainders. */
14565 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14566 if (*q != NUL)
14568 if (remain == NULL)
14569 remain = vim_strsave(q - 1);
14570 else
14572 cpy = concat_str(q - 1, remain);
14573 if (cpy != NULL)
14575 vim_free(remain);
14576 remain = cpy;
14579 q[-1] = NUL;
14582 q = gettail(p);
14583 if (q > p && *q == NUL)
14585 /* Ignore trailing path separator. */
14586 q[-1] = NUL;
14587 q = gettail(p);
14589 if (q > p && !mch_isFullName(buf))
14591 /* symlink is relative to directory of argument */
14592 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14593 if (cpy != NULL)
14595 STRCPY(cpy, p);
14596 STRCPY(gettail(cpy), buf);
14597 vim_free(p);
14598 p = cpy;
14601 else
14603 vim_free(p);
14604 p = vim_strsave(buf);
14608 if (remain == NULL)
14609 break;
14611 /* Append the first path component of "remain" to "p". */
14612 q = getnextcomp(remain + 1);
14613 len = q - remain - (*q != NUL);
14614 cpy = vim_strnsave(p, STRLEN(p) + len);
14615 if (cpy != NULL)
14617 STRNCAT(cpy, remain, len);
14618 vim_free(p);
14619 p = cpy;
14621 /* Shorten "remain". */
14622 if (*q != NUL)
14623 STRMOVE(remain, q - 1);
14624 else
14626 vim_free(remain);
14627 remain = NULL;
14631 /* If the result is a relative path name, make it explicitly relative to
14632 * the current directory if and only if the argument had this form. */
14633 if (!vim_ispathsep(*p))
14635 if (is_relative_to_current
14636 && *p != NUL
14637 && !(p[0] == '.'
14638 && (p[1] == NUL
14639 || vim_ispathsep(p[1])
14640 || (p[1] == '.'
14641 && (p[2] == NUL
14642 || vim_ispathsep(p[2]))))))
14644 /* Prepend "./". */
14645 cpy = concat_str((char_u *)"./", p);
14646 if (cpy != NULL)
14648 vim_free(p);
14649 p = cpy;
14652 else if (!is_relative_to_current)
14654 /* Strip leading "./". */
14655 q = p;
14656 while (q[0] == '.' && vim_ispathsep(q[1]))
14657 q += 2;
14658 if (q > p)
14659 STRMOVE(p, p + 2);
14663 /* Ensure that the result will have no trailing path separator
14664 * if the argument had none. But keep "/" or "//". */
14665 if (!has_trailing_pathsep)
14667 q = p + STRLEN(p);
14668 if (after_pathsep(p, q))
14669 *gettail_sep(p) = NUL;
14672 rettv->vval.v_string = p;
14674 # else
14675 rettv->vval.v_string = vim_strsave(p);
14676 # endif
14677 #endif
14679 simplify_filename(rettv->vval.v_string);
14681 #ifdef HAVE_READLINK
14682 fail:
14683 #endif
14684 rettv->v_type = VAR_STRING;
14688 * "reverse({list})" function
14690 static void
14691 f_reverse(argvars, rettv)
14692 typval_T *argvars;
14693 typval_T *rettv;
14695 list_T *l;
14696 listitem_T *li, *ni;
14698 rettv->vval.v_number = 0;
14699 if (argvars[0].v_type != VAR_LIST)
14700 EMSG2(_(e_listarg), "reverse()");
14701 else if ((l = argvars[0].vval.v_list) != NULL
14702 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14704 li = l->lv_last;
14705 l->lv_first = l->lv_last = NULL;
14706 l->lv_len = 0;
14707 while (li != NULL)
14709 ni = li->li_prev;
14710 list_append(l, li);
14711 li = ni;
14713 rettv->vval.v_list = l;
14714 rettv->v_type = VAR_LIST;
14715 ++l->lv_refcount;
14716 l->lv_idx = l->lv_len - l->lv_idx - 1;
14720 #define SP_NOMOVE 0x01 /* don't move cursor */
14721 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14722 #define SP_RETCOUNT 0x04 /* return matchcount */
14723 #define SP_SETPCMARK 0x08 /* set previous context mark */
14724 #define SP_START 0x10 /* accept match at start position */
14725 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14726 #define SP_END 0x40 /* leave cursor at end of match */
14728 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14731 * Get flags for a search function.
14732 * Possibly sets "p_ws".
14733 * Returns BACKWARD, FORWARD or zero (for an error).
14735 static int
14736 get_search_arg(varp, flagsp)
14737 typval_T *varp;
14738 int *flagsp;
14740 int dir = FORWARD;
14741 char_u *flags;
14742 char_u nbuf[NUMBUFLEN];
14743 int mask;
14745 if (varp->v_type != VAR_UNKNOWN)
14747 flags = get_tv_string_buf_chk(varp, nbuf);
14748 if (flags == NULL)
14749 return 0; /* type error; errmsg already given */
14750 while (*flags != NUL)
14752 switch (*flags)
14754 case 'b': dir = BACKWARD; break;
14755 case 'w': p_ws = TRUE; break;
14756 case 'W': p_ws = FALSE; break;
14757 default: mask = 0;
14758 if (flagsp != NULL)
14759 switch (*flags)
14761 case 'c': mask = SP_START; break;
14762 case 'e': mask = SP_END; break;
14763 case 'm': mask = SP_RETCOUNT; break;
14764 case 'n': mask = SP_NOMOVE; break;
14765 case 'p': mask = SP_SUBPAT; break;
14766 case 'r': mask = SP_REPEAT; break;
14767 case 's': mask = SP_SETPCMARK; break;
14769 if (mask == 0)
14771 EMSG2(_(e_invarg2), flags);
14772 dir = 0;
14774 else
14775 *flagsp |= mask;
14777 if (dir == 0)
14778 break;
14779 ++flags;
14782 return dir;
14786 * Shared by search() and searchpos() functions
14788 static int
14789 search_cmn(argvars, match_pos, flagsp)
14790 typval_T *argvars;
14791 pos_T *match_pos;
14792 int *flagsp;
14794 int flags;
14795 char_u *pat;
14796 pos_T pos;
14797 pos_T save_cursor;
14798 int save_p_ws = p_ws;
14799 int dir;
14800 int retval = 0; /* default: FAIL */
14801 long lnum_stop = 0;
14802 proftime_T tm;
14803 #ifdef FEAT_RELTIME
14804 long time_limit = 0;
14805 #endif
14806 int options = SEARCH_KEEP;
14807 int subpatnum;
14809 pat = get_tv_string(&argvars[0]);
14810 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14811 if (dir == 0)
14812 goto theend;
14813 flags = *flagsp;
14814 if (flags & SP_START)
14815 options |= SEARCH_START;
14816 if (flags & SP_END)
14817 options |= SEARCH_END;
14819 /* Optional arguments: line number to stop searching and timeout. */
14820 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14822 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14823 if (lnum_stop < 0)
14824 goto theend;
14825 #ifdef FEAT_RELTIME
14826 if (argvars[3].v_type != VAR_UNKNOWN)
14828 time_limit = get_tv_number_chk(&argvars[3], NULL);
14829 if (time_limit < 0)
14830 goto theend;
14832 #endif
14835 #ifdef FEAT_RELTIME
14836 /* Set the time limit, if there is one. */
14837 profile_setlimit(time_limit, &tm);
14838 #endif
14841 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14842 * Check to make sure only those flags are set.
14843 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14844 * flags cannot be set. Check for that condition also.
14846 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14847 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14849 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14850 goto theend;
14853 pos = save_cursor = curwin->w_cursor;
14854 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14855 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14856 if (subpatnum != FAIL)
14858 if (flags & SP_SUBPAT)
14859 retval = subpatnum;
14860 else
14861 retval = pos.lnum;
14862 if (flags & SP_SETPCMARK)
14863 setpcmark();
14864 curwin->w_cursor = pos;
14865 if (match_pos != NULL)
14867 /* Store the match cursor position */
14868 match_pos->lnum = pos.lnum;
14869 match_pos->col = pos.col + 1;
14871 /* "/$" will put the cursor after the end of the line, may need to
14872 * correct that here */
14873 check_cursor();
14876 /* If 'n' flag is used: restore cursor position. */
14877 if (flags & SP_NOMOVE)
14878 curwin->w_cursor = save_cursor;
14879 else
14880 curwin->w_set_curswant = TRUE;
14881 theend:
14882 p_ws = save_p_ws;
14884 return retval;
14887 #ifdef FEAT_FLOAT
14889 * "round({float})" function
14891 static void
14892 f_round(argvars, rettv)
14893 typval_T *argvars;
14894 typval_T *rettv;
14896 float_T f;
14898 rettv->v_type = VAR_FLOAT;
14899 if (get_float_arg(argvars, &f) == OK)
14900 /* round() is not in C90, use ceil() or floor() instead. */
14901 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14902 else
14903 rettv->vval.v_float = 0.0;
14905 #endif
14908 * "search()" function
14910 static void
14911 f_search(argvars, rettv)
14912 typval_T *argvars;
14913 typval_T *rettv;
14915 int flags = 0;
14917 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14921 * "searchdecl()" function
14923 static void
14924 f_searchdecl(argvars, rettv)
14925 typval_T *argvars;
14926 typval_T *rettv;
14928 int locally = 1;
14929 int thisblock = 0;
14930 int error = FALSE;
14931 char_u *name;
14933 rettv->vval.v_number = 1; /* default: FAIL */
14935 name = get_tv_string_chk(&argvars[0]);
14936 if (argvars[1].v_type != VAR_UNKNOWN)
14938 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14939 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14940 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14942 if (!error && name != NULL)
14943 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14944 locally, thisblock, SEARCH_KEEP) == FAIL;
14948 * Used by searchpair() and searchpairpos()
14950 static int
14951 searchpair_cmn(argvars, match_pos)
14952 typval_T *argvars;
14953 pos_T *match_pos;
14955 char_u *spat, *mpat, *epat;
14956 char_u *skip;
14957 int save_p_ws = p_ws;
14958 int dir;
14959 int flags = 0;
14960 char_u nbuf1[NUMBUFLEN];
14961 char_u nbuf2[NUMBUFLEN];
14962 char_u nbuf3[NUMBUFLEN];
14963 int retval = 0; /* default: FAIL */
14964 long lnum_stop = 0;
14965 long time_limit = 0;
14967 /* Get the three pattern arguments: start, middle, end. */
14968 spat = get_tv_string_chk(&argvars[0]);
14969 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14970 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14971 if (spat == NULL || mpat == NULL || epat == NULL)
14972 goto theend; /* type error */
14974 /* Handle the optional fourth argument: flags */
14975 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14976 if (dir == 0)
14977 goto theend;
14979 /* Don't accept SP_END or SP_SUBPAT.
14980 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14982 if ((flags & (SP_END | SP_SUBPAT)) != 0
14983 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14985 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14986 goto theend;
14989 /* Using 'r' implies 'W', otherwise it doesn't work. */
14990 if (flags & SP_REPEAT)
14991 p_ws = FALSE;
14993 /* Optional fifth argument: skip expression */
14994 if (argvars[3].v_type == VAR_UNKNOWN
14995 || argvars[4].v_type == VAR_UNKNOWN)
14996 skip = (char_u *)"";
14997 else
14999 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
15000 if (argvars[5].v_type != VAR_UNKNOWN)
15002 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
15003 if (lnum_stop < 0)
15004 goto theend;
15005 #ifdef FEAT_RELTIME
15006 if (argvars[6].v_type != VAR_UNKNOWN)
15008 time_limit = get_tv_number_chk(&argvars[6], NULL);
15009 if (time_limit < 0)
15010 goto theend;
15012 #endif
15015 if (skip == NULL)
15016 goto theend; /* type error */
15018 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
15019 match_pos, lnum_stop, time_limit);
15021 theend:
15022 p_ws = save_p_ws;
15024 return retval;
15028 * "searchpair()" function
15030 static void
15031 f_searchpair(argvars, rettv)
15032 typval_T *argvars;
15033 typval_T *rettv;
15035 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15039 * "searchpairpos()" function
15041 static void
15042 f_searchpairpos(argvars, rettv)
15043 typval_T *argvars;
15044 typval_T *rettv;
15046 pos_T match_pos;
15047 int lnum = 0;
15048 int col = 0;
15050 rettv->vval.v_number = 0;
15052 if (rettv_list_alloc(rettv) == FAIL)
15053 return;
15055 if (searchpair_cmn(argvars, &match_pos) > 0)
15057 lnum = match_pos.lnum;
15058 col = match_pos.col;
15061 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15062 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15066 * Search for a start/middle/end thing.
15067 * Used by searchpair(), see its documentation for the details.
15068 * Returns 0 or -1 for no match,
15070 long
15071 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15072 lnum_stop, time_limit)
15073 char_u *spat; /* start pattern */
15074 char_u *mpat; /* middle pattern */
15075 char_u *epat; /* end pattern */
15076 int dir; /* BACKWARD or FORWARD */
15077 char_u *skip; /* skip expression */
15078 int flags; /* SP_SETPCMARK and other SP_ values */
15079 pos_T *match_pos;
15080 linenr_T lnum_stop; /* stop at this line if not zero */
15081 long time_limit; /* stop after this many msec */
15083 char_u *save_cpo;
15084 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15085 long retval = 0;
15086 pos_T pos;
15087 pos_T firstpos;
15088 pos_T foundpos;
15089 pos_T save_cursor;
15090 pos_T save_pos;
15091 int n;
15092 int r;
15093 int nest = 1;
15094 int err;
15095 int options = SEARCH_KEEP;
15096 proftime_T tm;
15098 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15099 save_cpo = p_cpo;
15100 p_cpo = empty_option;
15102 #ifdef FEAT_RELTIME
15103 /* Set the time limit, if there is one. */
15104 profile_setlimit(time_limit, &tm);
15105 #endif
15107 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15108 * start/middle/end (pat3, for the top pair). */
15109 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15110 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15111 if (pat2 == NULL || pat3 == NULL)
15112 goto theend;
15113 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15114 if (*mpat == NUL)
15115 STRCPY(pat3, pat2);
15116 else
15117 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15118 spat, epat, mpat);
15119 if (flags & SP_START)
15120 options |= SEARCH_START;
15122 save_cursor = curwin->w_cursor;
15123 pos = curwin->w_cursor;
15124 clearpos(&firstpos);
15125 clearpos(&foundpos);
15126 pat = pat3;
15127 for (;;)
15129 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15130 options, RE_SEARCH, lnum_stop, &tm);
15131 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15132 /* didn't find it or found the first match again: FAIL */
15133 break;
15135 if (firstpos.lnum == 0)
15136 firstpos = pos;
15137 if (equalpos(pos, foundpos))
15139 /* Found the same position again. Can happen with a pattern that
15140 * has "\zs" at the end and searching backwards. Advance one
15141 * character and try again. */
15142 if (dir == BACKWARD)
15143 decl(&pos);
15144 else
15145 incl(&pos);
15147 foundpos = pos;
15149 /* clear the start flag to avoid getting stuck here */
15150 options &= ~SEARCH_START;
15152 /* If the skip pattern matches, ignore this match. */
15153 if (*skip != NUL)
15155 save_pos = curwin->w_cursor;
15156 curwin->w_cursor = pos;
15157 r = eval_to_bool(skip, &err, NULL, FALSE);
15158 curwin->w_cursor = save_pos;
15159 if (err)
15161 /* Evaluating {skip} caused an error, break here. */
15162 curwin->w_cursor = save_cursor;
15163 retval = -1;
15164 break;
15166 if (r)
15167 continue;
15170 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15172 /* Found end when searching backwards or start when searching
15173 * forward: nested pair. */
15174 ++nest;
15175 pat = pat2; /* nested, don't search for middle */
15177 else
15179 /* Found end when searching forward or start when searching
15180 * backward: end of (nested) pair; or found middle in outer pair. */
15181 if (--nest == 1)
15182 pat = pat3; /* outer level, search for middle */
15185 if (nest == 0)
15187 /* Found the match: return matchcount or line number. */
15188 if (flags & SP_RETCOUNT)
15189 ++retval;
15190 else
15191 retval = pos.lnum;
15192 if (flags & SP_SETPCMARK)
15193 setpcmark();
15194 curwin->w_cursor = pos;
15195 if (!(flags & SP_REPEAT))
15196 break;
15197 nest = 1; /* search for next unmatched */
15201 if (match_pos != NULL)
15203 /* Store the match cursor position */
15204 match_pos->lnum = curwin->w_cursor.lnum;
15205 match_pos->col = curwin->w_cursor.col + 1;
15208 /* If 'n' flag is used or search failed: restore cursor position. */
15209 if ((flags & SP_NOMOVE) || retval == 0)
15210 curwin->w_cursor = save_cursor;
15212 theend:
15213 vim_free(pat2);
15214 vim_free(pat3);
15215 if (p_cpo == empty_option)
15216 p_cpo = save_cpo;
15217 else
15218 /* Darn, evaluating the {skip} expression changed the value. */
15219 free_string_option(save_cpo);
15221 return retval;
15225 * "searchpos()" function
15227 static void
15228 f_searchpos(argvars, rettv)
15229 typval_T *argvars;
15230 typval_T *rettv;
15232 pos_T match_pos;
15233 int lnum = 0;
15234 int col = 0;
15235 int n;
15236 int flags = 0;
15238 rettv->vval.v_number = 0;
15240 if (rettv_list_alloc(rettv) == FAIL)
15241 return;
15243 n = search_cmn(argvars, &match_pos, &flags);
15244 if (n > 0)
15246 lnum = match_pos.lnum;
15247 col = match_pos.col;
15250 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15251 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15252 if (flags & SP_SUBPAT)
15253 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15257 /*ARGSUSED*/
15258 static void
15259 f_server2client(argvars, rettv)
15260 typval_T *argvars;
15261 typval_T *rettv;
15263 #ifdef FEAT_CLIENTSERVER
15264 char_u buf[NUMBUFLEN];
15265 char_u *server = get_tv_string_chk(&argvars[0]);
15266 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15268 rettv->vval.v_number = -1;
15269 if (server == NULL || reply == NULL)
15270 return;
15271 if (check_restricted() || check_secure())
15272 return;
15273 # ifdef FEAT_X11
15274 if (check_connection() == FAIL)
15275 return;
15276 # endif
15278 if (serverSendReply(server, reply) < 0)
15280 EMSG(_("E258: Unable to send to client"));
15281 return;
15283 rettv->vval.v_number = 0;
15284 #else
15285 rettv->vval.v_number = -1;
15286 #endif
15289 /*ARGSUSED*/
15290 static void
15291 f_serverlist(argvars, rettv)
15292 typval_T *argvars;
15293 typval_T *rettv;
15295 char_u *r = NULL;
15297 #ifdef FEAT_CLIENTSERVER
15298 # ifdef WIN32
15299 r = serverGetVimNames();
15300 # else
15301 make_connection();
15302 if (X_DISPLAY != NULL)
15303 r = serverGetVimNames(X_DISPLAY);
15304 # endif
15305 #endif
15306 rettv->v_type = VAR_STRING;
15307 rettv->vval.v_string = r;
15311 * "setbufvar()" function
15313 /*ARGSUSED*/
15314 static void
15315 f_setbufvar(argvars, rettv)
15316 typval_T *argvars;
15317 typval_T *rettv;
15319 buf_T *buf;
15320 aco_save_T aco;
15321 char_u *varname, *bufvarname;
15322 typval_T *varp;
15323 char_u nbuf[NUMBUFLEN];
15325 rettv->vval.v_number = 0;
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 rettv->vval.v_number = 0; /* 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 /*ARGSUSED*/
15455 static void
15456 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15457 win_T *wp;
15458 typval_T *list_arg;
15459 typval_T *action_arg;
15460 typval_T *rettv;
15462 #ifdef FEAT_QUICKFIX
15463 char_u *act;
15464 int action = ' ';
15465 #endif
15467 rettv->vval.v_number = -1;
15469 #ifdef FEAT_QUICKFIX
15470 if (list_arg->v_type != VAR_LIST)
15471 EMSG(_(e_listreq));
15472 else
15474 list_T *l = list_arg->vval.v_list;
15476 if (action_arg->v_type == VAR_STRING)
15478 act = get_tv_string_chk(action_arg);
15479 if (act == NULL)
15480 return; /* type error; errmsg already given */
15481 if (*act == 'a' || *act == 'r')
15482 action = *act;
15485 if (l != NULL && set_errorlist(wp, l, action) == OK)
15486 rettv->vval.v_number = 0;
15488 #endif
15492 * "setloclist()" function
15494 /*ARGSUSED*/
15495 static void
15496 f_setloclist(argvars, rettv)
15497 typval_T *argvars;
15498 typval_T *rettv;
15500 win_T *win;
15502 rettv->vval.v_number = -1;
15504 win = find_win_by_nr(&argvars[0], NULL);
15505 if (win != NULL)
15506 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15510 * "setmatches()" function
15512 static void
15513 f_setmatches(argvars, rettv)
15514 typval_T *argvars;
15515 typval_T *rettv;
15517 #ifdef FEAT_SEARCH_EXTRA
15518 list_T *l;
15519 listitem_T *li;
15520 dict_T *d;
15522 rettv->vval.v_number = -1;
15523 if (argvars[0].v_type != VAR_LIST)
15525 EMSG(_(e_listreq));
15526 return;
15528 if ((l = argvars[0].vval.v_list) != NULL)
15531 /* To some extent make sure that we are dealing with a list from
15532 * "getmatches()". */
15533 li = l->lv_first;
15534 while (li != NULL)
15536 if (li->li_tv.v_type != VAR_DICT
15537 || (d = li->li_tv.vval.v_dict) == NULL)
15539 EMSG(_(e_invarg));
15540 return;
15542 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15543 && dict_find(d, (char_u *)"pattern", -1) != NULL
15544 && dict_find(d, (char_u *)"priority", -1) != NULL
15545 && dict_find(d, (char_u *)"id", -1) != NULL))
15547 EMSG(_(e_invarg));
15548 return;
15550 li = li->li_next;
15553 clear_matches(curwin);
15554 li = l->lv_first;
15555 while (li != NULL)
15557 d = li->li_tv.vval.v_dict;
15558 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15559 get_dict_string(d, (char_u *)"pattern", FALSE),
15560 (int)get_dict_number(d, (char_u *)"priority"),
15561 (int)get_dict_number(d, (char_u *)"id"));
15562 li = li->li_next;
15564 rettv->vval.v_number = 0;
15566 #endif
15570 * "setpos()" function
15572 /*ARGSUSED*/
15573 static void
15574 f_setpos(argvars, rettv)
15575 typval_T *argvars;
15576 typval_T *rettv;
15578 pos_T pos;
15579 int fnum;
15580 char_u *name;
15582 rettv->vval.v_number = -1;
15583 name = get_tv_string_chk(argvars);
15584 if (name != NULL)
15586 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15588 --pos.col;
15589 if (name[0] == '.' && name[1] == NUL)
15591 /* set cursor */
15592 if (fnum == curbuf->b_fnum)
15594 curwin->w_cursor = pos;
15595 check_cursor();
15596 rettv->vval.v_number = 0;
15598 else
15599 EMSG(_(e_invarg));
15601 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15603 /* set mark */
15604 if (setmark_pos(name[1], &pos, fnum) == OK)
15605 rettv->vval.v_number = 0;
15607 else
15608 EMSG(_(e_invarg));
15614 * "setqflist()" function
15616 /*ARGSUSED*/
15617 static void
15618 f_setqflist(argvars, rettv)
15619 typval_T *argvars;
15620 typval_T *rettv;
15622 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15626 * "setreg()" function
15628 static void
15629 f_setreg(argvars, rettv)
15630 typval_T *argvars;
15631 typval_T *rettv;
15633 int regname;
15634 char_u *strregname;
15635 char_u *stropt;
15636 char_u *strval;
15637 int append;
15638 char_u yank_type;
15639 long block_len;
15641 block_len = -1;
15642 yank_type = MAUTO;
15643 append = FALSE;
15645 strregname = get_tv_string_chk(argvars);
15646 rettv->vval.v_number = 1; /* FAIL is default */
15648 if (strregname == NULL)
15649 return; /* type error; errmsg already given */
15650 regname = *strregname;
15651 if (regname == 0 || regname == '@')
15652 regname = '"';
15653 else if (regname == '=')
15654 return;
15656 if (argvars[2].v_type != VAR_UNKNOWN)
15658 stropt = get_tv_string_chk(&argvars[2]);
15659 if (stropt == NULL)
15660 return; /* type error */
15661 for (; *stropt != NUL; ++stropt)
15662 switch (*stropt)
15664 case 'a': case 'A': /* append */
15665 append = TRUE;
15666 break;
15667 case 'v': case 'c': /* character-wise selection */
15668 yank_type = MCHAR;
15669 break;
15670 case 'V': case 'l': /* line-wise selection */
15671 yank_type = MLINE;
15672 break;
15673 #ifdef FEAT_VISUAL
15674 case 'b': case Ctrl_V: /* block-wise selection */
15675 yank_type = MBLOCK;
15676 if (VIM_ISDIGIT(stropt[1]))
15678 ++stropt;
15679 block_len = getdigits(&stropt) - 1;
15680 --stropt;
15682 break;
15683 #endif
15687 strval = get_tv_string_chk(&argvars[1]);
15688 if (strval != NULL)
15689 write_reg_contents_ex(regname, strval, -1,
15690 append, yank_type, block_len);
15691 rettv->vval.v_number = 0;
15695 * "settabwinvar()" function
15697 static void
15698 f_settabwinvar(argvars, rettv)
15699 typval_T *argvars;
15700 typval_T *rettv;
15702 setwinvar(argvars, rettv, 1);
15706 * "setwinvar()" function
15708 static void
15709 f_setwinvar(argvars, rettv)
15710 typval_T *argvars;
15711 typval_T *rettv;
15713 setwinvar(argvars, rettv, 0);
15717 * "setwinvar()" and "settabwinvar()" functions
15719 static void
15720 setwinvar(argvars, rettv, off)
15721 typval_T *argvars;
15722 typval_T *rettv;
15723 int off;
15725 win_T *win;
15726 #ifdef FEAT_WINDOWS
15727 win_T *save_curwin;
15728 tabpage_T *save_curtab;
15729 #endif
15730 char_u *varname, *winvarname;
15731 typval_T *varp;
15732 char_u nbuf[NUMBUFLEN];
15733 tabpage_T *tp;
15735 rettv->vval.v_number = 0;
15737 if (check_restricted() || check_secure())
15738 return;
15740 #ifdef FEAT_WINDOWS
15741 if (off == 1)
15742 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15743 else
15744 tp = curtab;
15745 #endif
15746 win = find_win_by_nr(&argvars[off], tp);
15747 varname = get_tv_string_chk(&argvars[off + 1]);
15748 varp = &argvars[off + 2];
15750 if (win != NULL && varname != NULL && varp != NULL)
15752 #ifdef FEAT_WINDOWS
15753 /* set curwin to be our win, temporarily */
15754 save_curwin = curwin;
15755 save_curtab = curtab;
15756 goto_tabpage_tp(tp);
15757 if (!win_valid(win))
15758 return;
15759 curwin = win;
15760 curbuf = curwin->w_buffer;
15761 #endif
15763 if (*varname == '&')
15765 long numval;
15766 char_u *strval;
15767 int error = FALSE;
15769 ++varname;
15770 numval = get_tv_number_chk(varp, &error);
15771 strval = get_tv_string_buf_chk(varp, nbuf);
15772 if (!error && strval != NULL)
15773 set_option_value(varname, numval, strval, OPT_LOCAL);
15775 else
15777 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15778 if (winvarname != NULL)
15780 STRCPY(winvarname, "w:");
15781 STRCPY(winvarname + 2, varname);
15782 set_var(winvarname, varp, TRUE);
15783 vim_free(winvarname);
15787 #ifdef FEAT_WINDOWS
15788 /* Restore current tabpage and window, if still valid (autocomands can
15789 * make them invalid). */
15790 if (valid_tabpage(save_curtab))
15791 goto_tabpage_tp(save_curtab);
15792 if (win_valid(save_curwin))
15794 curwin = save_curwin;
15795 curbuf = curwin->w_buffer;
15797 #endif
15802 * "shellescape({string})" function
15804 static void
15805 f_shellescape(argvars, rettv)
15806 typval_T *argvars;
15807 typval_T *rettv;
15809 rettv->vval.v_string = vim_strsave_shellescape(
15810 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15811 rettv->v_type = VAR_STRING;
15815 * "simplify()" function
15817 static void
15818 f_simplify(argvars, rettv)
15819 typval_T *argvars;
15820 typval_T *rettv;
15822 char_u *p;
15824 p = get_tv_string(&argvars[0]);
15825 rettv->vval.v_string = vim_strsave(p);
15826 simplify_filename(rettv->vval.v_string); /* simplify in place */
15827 rettv->v_type = VAR_STRING;
15830 #ifdef FEAT_FLOAT
15832 * "sin()" function
15834 static void
15835 f_sin(argvars, rettv)
15836 typval_T *argvars;
15837 typval_T *rettv;
15839 float_T f;
15841 rettv->v_type = VAR_FLOAT;
15842 if (get_float_arg(argvars, &f) == OK)
15843 rettv->vval.v_float = sin(f);
15844 else
15845 rettv->vval.v_float = 0.0;
15847 #endif
15849 static int
15850 #ifdef __BORLANDC__
15851 _RTLENTRYF
15852 #endif
15853 item_compare __ARGS((const void *s1, const void *s2));
15854 static int
15855 #ifdef __BORLANDC__
15856 _RTLENTRYF
15857 #endif
15858 item_compare2 __ARGS((const void *s1, const void *s2));
15860 static int item_compare_ic;
15861 static char_u *item_compare_func;
15862 static int item_compare_func_err;
15863 #define ITEM_COMPARE_FAIL 999
15866 * Compare functions for f_sort() below.
15868 static int
15869 #ifdef __BORLANDC__
15870 _RTLENTRYF
15871 #endif
15872 item_compare(s1, s2)
15873 const void *s1;
15874 const void *s2;
15876 char_u *p1, *p2;
15877 char_u *tofree1, *tofree2;
15878 int res;
15879 char_u numbuf1[NUMBUFLEN];
15880 char_u numbuf2[NUMBUFLEN];
15882 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15883 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15884 if (p1 == NULL)
15885 p1 = (char_u *)"";
15886 if (p2 == NULL)
15887 p2 = (char_u *)"";
15888 if (item_compare_ic)
15889 res = STRICMP(p1, p2);
15890 else
15891 res = STRCMP(p1, p2);
15892 vim_free(tofree1);
15893 vim_free(tofree2);
15894 return res;
15897 static int
15898 #ifdef __BORLANDC__
15899 _RTLENTRYF
15900 #endif
15901 item_compare2(s1, s2)
15902 const void *s1;
15903 const void *s2;
15905 int res;
15906 typval_T rettv;
15907 typval_T argv[3];
15908 int dummy;
15910 /* shortcut after failure in previous call; compare all items equal */
15911 if (item_compare_func_err)
15912 return 0;
15914 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15915 * in the copy without changing the original list items. */
15916 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15917 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15919 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15920 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15921 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15922 clear_tv(&argv[0]);
15923 clear_tv(&argv[1]);
15925 if (res == FAIL)
15926 res = ITEM_COMPARE_FAIL;
15927 else
15928 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15929 if (item_compare_func_err)
15930 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15931 clear_tv(&rettv);
15932 return res;
15936 * "sort({list})" function
15938 static void
15939 f_sort(argvars, rettv)
15940 typval_T *argvars;
15941 typval_T *rettv;
15943 list_T *l;
15944 listitem_T *li;
15945 listitem_T **ptrs;
15946 long len;
15947 long i;
15949 rettv->vval.v_number = 0;
15950 if (argvars[0].v_type != VAR_LIST)
15951 EMSG2(_(e_listarg), "sort()");
15952 else
15954 l = argvars[0].vval.v_list;
15955 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15956 return;
15957 rettv->vval.v_list = l;
15958 rettv->v_type = VAR_LIST;
15959 ++l->lv_refcount;
15961 len = list_len(l);
15962 if (len <= 1)
15963 return; /* short list sorts pretty quickly */
15965 item_compare_ic = FALSE;
15966 item_compare_func = NULL;
15967 if (argvars[1].v_type != VAR_UNKNOWN)
15969 if (argvars[1].v_type == VAR_FUNC)
15970 item_compare_func = argvars[1].vval.v_string;
15971 else
15973 int error = FALSE;
15975 i = get_tv_number_chk(&argvars[1], &error);
15976 if (error)
15977 return; /* type error; errmsg already given */
15978 if (i == 1)
15979 item_compare_ic = TRUE;
15980 else
15981 item_compare_func = get_tv_string(&argvars[1]);
15985 /* Make an array with each entry pointing to an item in the List. */
15986 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15987 if (ptrs == NULL)
15988 return;
15989 i = 0;
15990 for (li = l->lv_first; li != NULL; li = li->li_next)
15991 ptrs[i++] = li;
15993 item_compare_func_err = FALSE;
15994 /* test the compare function */
15995 if (item_compare_func != NULL
15996 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15997 == ITEM_COMPARE_FAIL)
15998 EMSG(_("E702: Sort compare function failed"));
15999 else
16001 /* Sort the array with item pointers. */
16002 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
16003 item_compare_func == NULL ? item_compare : item_compare2);
16005 if (!item_compare_func_err)
16007 /* Clear the List and append the items in the sorted order. */
16008 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
16009 l->lv_len = 0;
16010 for (i = 0; i < len; ++i)
16011 list_append(l, ptrs[i]);
16015 vim_free(ptrs);
16020 * "soundfold({word})" function
16022 static void
16023 f_soundfold(argvars, rettv)
16024 typval_T *argvars;
16025 typval_T *rettv;
16027 char_u *s;
16029 rettv->v_type = VAR_STRING;
16030 s = get_tv_string(&argvars[0]);
16031 #ifdef FEAT_SPELL
16032 rettv->vval.v_string = eval_soundfold(s);
16033 #else
16034 rettv->vval.v_string = vim_strsave(s);
16035 #endif
16039 * "spellbadword()" function
16041 /* ARGSUSED */
16042 static void
16043 f_spellbadword(argvars, rettv)
16044 typval_T *argvars;
16045 typval_T *rettv;
16047 char_u *word = (char_u *)"";
16048 hlf_T attr = HLF_COUNT;
16049 int len = 0;
16051 if (rettv_list_alloc(rettv) == FAIL)
16052 return;
16054 #ifdef FEAT_SPELL
16055 if (argvars[0].v_type == VAR_UNKNOWN)
16057 /* Find the start and length of the badly spelled word. */
16058 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16059 if (len != 0)
16060 word = ml_get_cursor();
16062 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16064 char_u *str = get_tv_string_chk(&argvars[0]);
16065 int capcol = -1;
16067 if (str != NULL)
16069 /* Check the argument for spelling. */
16070 while (*str != NUL)
16072 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16073 if (attr != HLF_COUNT)
16075 word = str;
16076 break;
16078 str += len;
16082 #endif
16084 list_append_string(rettv->vval.v_list, word, len);
16085 list_append_string(rettv->vval.v_list, (char_u *)(
16086 attr == HLF_SPB ? "bad" :
16087 attr == HLF_SPR ? "rare" :
16088 attr == HLF_SPL ? "local" :
16089 attr == HLF_SPC ? "caps" :
16090 ""), -1);
16094 * "spellsuggest()" function
16096 /*ARGSUSED*/
16097 static void
16098 f_spellsuggest(argvars, rettv)
16099 typval_T *argvars;
16100 typval_T *rettv;
16102 #ifdef FEAT_SPELL
16103 char_u *str;
16104 int typeerr = FALSE;
16105 int maxcount;
16106 garray_T ga;
16107 int i;
16108 listitem_T *li;
16109 int need_capital = FALSE;
16110 #endif
16112 if (rettv_list_alloc(rettv) == FAIL)
16113 return;
16115 #ifdef FEAT_SPELL
16116 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16118 str = get_tv_string(&argvars[0]);
16119 if (argvars[1].v_type != VAR_UNKNOWN)
16121 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16122 if (maxcount <= 0)
16123 return;
16124 if (argvars[2].v_type != VAR_UNKNOWN)
16126 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16127 if (typeerr)
16128 return;
16131 else
16132 maxcount = 25;
16134 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16136 for (i = 0; i < ga.ga_len; ++i)
16138 str = ((char_u **)ga.ga_data)[i];
16140 li = listitem_alloc();
16141 if (li == NULL)
16142 vim_free(str);
16143 else
16145 li->li_tv.v_type = VAR_STRING;
16146 li->li_tv.v_lock = 0;
16147 li->li_tv.vval.v_string = str;
16148 list_append(rettv->vval.v_list, li);
16151 ga_clear(&ga);
16153 #endif
16156 static void
16157 f_split(argvars, rettv)
16158 typval_T *argvars;
16159 typval_T *rettv;
16161 char_u *str;
16162 char_u *end;
16163 char_u *pat = NULL;
16164 regmatch_T regmatch;
16165 char_u patbuf[NUMBUFLEN];
16166 char_u *save_cpo;
16167 int match;
16168 colnr_T col = 0;
16169 int keepempty = FALSE;
16170 int typeerr = FALSE;
16172 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16173 save_cpo = p_cpo;
16174 p_cpo = (char_u *)"";
16176 str = get_tv_string(&argvars[0]);
16177 if (argvars[1].v_type != VAR_UNKNOWN)
16179 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16180 if (pat == NULL)
16181 typeerr = TRUE;
16182 if (argvars[2].v_type != VAR_UNKNOWN)
16183 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16185 if (pat == NULL || *pat == NUL)
16186 pat = (char_u *)"[\\x01- ]\\+";
16188 if (rettv_list_alloc(rettv) == FAIL)
16189 return;
16190 if (typeerr)
16191 return;
16193 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16194 if (regmatch.regprog != NULL)
16196 regmatch.rm_ic = FALSE;
16197 while (*str != NUL || keepempty)
16199 if (*str == NUL)
16200 match = FALSE; /* empty item at the end */
16201 else
16202 match = vim_regexec_nl(&regmatch, str, col);
16203 if (match)
16204 end = regmatch.startp[0];
16205 else
16206 end = str + STRLEN(str);
16207 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16208 && *str != NUL && match && end < regmatch.endp[0]))
16210 if (list_append_string(rettv->vval.v_list, str,
16211 (int)(end - str)) == FAIL)
16212 break;
16214 if (!match)
16215 break;
16216 /* Advance to just after the match. */
16217 if (regmatch.endp[0] > str)
16218 col = 0;
16219 else
16221 /* Don't get stuck at the same match. */
16222 #ifdef FEAT_MBYTE
16223 col = (*mb_ptr2len)(regmatch.endp[0]);
16224 #else
16225 col = 1;
16226 #endif
16228 str = regmatch.endp[0];
16231 vim_free(regmatch.regprog);
16234 p_cpo = save_cpo;
16237 #ifdef FEAT_FLOAT
16239 * "sqrt()" function
16241 static void
16242 f_sqrt(argvars, rettv)
16243 typval_T *argvars;
16244 typval_T *rettv;
16246 float_T f;
16248 rettv->v_type = VAR_FLOAT;
16249 if (get_float_arg(argvars, &f) == OK)
16250 rettv->vval.v_float = sqrt(f);
16251 else
16252 rettv->vval.v_float = 0.0;
16256 * "str2float()" function
16258 static void
16259 f_str2float(argvars, rettv)
16260 typval_T *argvars;
16261 typval_T *rettv;
16263 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16265 if (*p == '+')
16266 p = skipwhite(p + 1);
16267 (void)string2float(p, &rettv->vval.v_float);
16268 rettv->v_type = VAR_FLOAT;
16270 #endif
16273 * "str2nr()" function
16275 static void
16276 f_str2nr(argvars, rettv)
16277 typval_T *argvars;
16278 typval_T *rettv;
16280 int base = 10;
16281 char_u *p;
16282 long n;
16284 if (argvars[1].v_type != VAR_UNKNOWN)
16286 base = get_tv_number(&argvars[1]);
16287 if (base != 8 && base != 10 && base != 16)
16289 EMSG(_(e_invarg));
16290 return;
16294 p = skipwhite(get_tv_string(&argvars[0]));
16295 if (*p == '+')
16296 p = skipwhite(p + 1);
16297 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16298 rettv->vval.v_number = n;
16301 #ifdef HAVE_STRFTIME
16303 * "strftime({format}[, {time}])" function
16305 static void
16306 f_strftime(argvars, rettv)
16307 typval_T *argvars;
16308 typval_T *rettv;
16310 char_u result_buf[256];
16311 struct tm *curtime;
16312 time_t seconds;
16313 char_u *p;
16315 rettv->v_type = VAR_STRING;
16317 p = get_tv_string(&argvars[0]);
16318 if (argvars[1].v_type == VAR_UNKNOWN)
16319 seconds = time(NULL);
16320 else
16321 seconds = (time_t)get_tv_number(&argvars[1]);
16322 curtime = localtime(&seconds);
16323 /* MSVC returns NULL for an invalid value of seconds. */
16324 if (curtime == NULL)
16325 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16326 else
16328 # ifdef FEAT_MBYTE
16329 vimconv_T conv;
16330 char_u *enc;
16332 conv.vc_type = CONV_NONE;
16333 enc = enc_locale();
16334 convert_setup(&conv, p_enc, enc);
16335 if (conv.vc_type != CONV_NONE)
16336 p = string_convert(&conv, p, NULL);
16337 # endif
16338 if (p != NULL)
16339 (void)strftime((char *)result_buf, sizeof(result_buf),
16340 (char *)p, curtime);
16341 else
16342 result_buf[0] = NUL;
16344 # ifdef FEAT_MBYTE
16345 if (conv.vc_type != CONV_NONE)
16346 vim_free(p);
16347 convert_setup(&conv, enc, p_enc);
16348 if (conv.vc_type != CONV_NONE)
16349 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16350 else
16351 # endif
16352 rettv->vval.v_string = vim_strsave(result_buf);
16354 # ifdef FEAT_MBYTE
16355 /* Release conversion descriptors */
16356 convert_setup(&conv, NULL, NULL);
16357 vim_free(enc);
16358 # endif
16361 #endif
16364 * "stridx()" function
16366 static void
16367 f_stridx(argvars, rettv)
16368 typval_T *argvars;
16369 typval_T *rettv;
16371 char_u buf[NUMBUFLEN];
16372 char_u *needle;
16373 char_u *haystack;
16374 char_u *save_haystack;
16375 char_u *pos;
16376 int start_idx;
16378 needle = get_tv_string_chk(&argvars[1]);
16379 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16380 rettv->vval.v_number = -1;
16381 if (needle == NULL || haystack == NULL)
16382 return; /* type error; errmsg already given */
16384 if (argvars[2].v_type != VAR_UNKNOWN)
16386 int error = FALSE;
16388 start_idx = get_tv_number_chk(&argvars[2], &error);
16389 if (error || start_idx >= (int)STRLEN(haystack))
16390 return;
16391 if (start_idx >= 0)
16392 haystack += start_idx;
16395 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16396 if (pos != NULL)
16397 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16401 * "string()" function
16403 static void
16404 f_string(argvars, rettv)
16405 typval_T *argvars;
16406 typval_T *rettv;
16408 char_u *tofree;
16409 char_u numbuf[NUMBUFLEN];
16411 rettv->v_type = VAR_STRING;
16412 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16413 /* Make a copy if we have a value but it's not in allocated memory. */
16414 if (rettv->vval.v_string != NULL && tofree == NULL)
16415 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16419 * "strlen()" function
16421 static void
16422 f_strlen(argvars, rettv)
16423 typval_T *argvars;
16424 typval_T *rettv;
16426 rettv->vval.v_number = (varnumber_T)(STRLEN(
16427 get_tv_string(&argvars[0])));
16431 * "strpart()" function
16433 static void
16434 f_strpart(argvars, rettv)
16435 typval_T *argvars;
16436 typval_T *rettv;
16438 char_u *p;
16439 int n;
16440 int len;
16441 int slen;
16442 int error = FALSE;
16444 p = get_tv_string(&argvars[0]);
16445 slen = (int)STRLEN(p);
16447 n = get_tv_number_chk(&argvars[1], &error);
16448 if (error)
16449 len = 0;
16450 else if (argvars[2].v_type != VAR_UNKNOWN)
16451 len = get_tv_number(&argvars[2]);
16452 else
16453 len = slen - n; /* default len: all bytes that are available. */
16456 * Only return the overlap between the specified part and the actual
16457 * string.
16459 if (n < 0)
16461 len += n;
16462 n = 0;
16464 else if (n > slen)
16465 n = slen;
16466 if (len < 0)
16467 len = 0;
16468 else if (n + len > slen)
16469 len = slen - n;
16471 rettv->v_type = VAR_STRING;
16472 rettv->vval.v_string = vim_strnsave(p + n, len);
16476 * "strridx()" function
16478 static void
16479 f_strridx(argvars, rettv)
16480 typval_T *argvars;
16481 typval_T *rettv;
16483 char_u buf[NUMBUFLEN];
16484 char_u *needle;
16485 char_u *haystack;
16486 char_u *rest;
16487 char_u *lastmatch = NULL;
16488 int haystack_len, end_idx;
16490 needle = get_tv_string_chk(&argvars[1]);
16491 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16493 rettv->vval.v_number = -1;
16494 if (needle == NULL || haystack == NULL)
16495 return; /* type error; errmsg already given */
16497 haystack_len = (int)STRLEN(haystack);
16498 if (argvars[2].v_type != VAR_UNKNOWN)
16500 /* Third argument: upper limit for index */
16501 end_idx = get_tv_number_chk(&argvars[2], NULL);
16502 if (end_idx < 0)
16503 return; /* can never find a match */
16505 else
16506 end_idx = haystack_len;
16508 if (*needle == NUL)
16510 /* Empty string matches past the end. */
16511 lastmatch = haystack + end_idx;
16513 else
16515 for (rest = haystack; *rest != '\0'; ++rest)
16517 rest = (char_u *)strstr((char *)rest, (char *)needle);
16518 if (rest == NULL || rest > haystack + end_idx)
16519 break;
16520 lastmatch = rest;
16524 if (lastmatch == NULL)
16525 rettv->vval.v_number = -1;
16526 else
16527 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16531 * "strtrans()" function
16533 static void
16534 f_strtrans(argvars, rettv)
16535 typval_T *argvars;
16536 typval_T *rettv;
16538 rettv->v_type = VAR_STRING;
16539 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16543 * "submatch()" function
16545 static void
16546 f_submatch(argvars, rettv)
16547 typval_T *argvars;
16548 typval_T *rettv;
16550 rettv->v_type = VAR_STRING;
16551 rettv->vval.v_string =
16552 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16556 * "substitute()" function
16558 static void
16559 f_substitute(argvars, rettv)
16560 typval_T *argvars;
16561 typval_T *rettv;
16563 char_u patbuf[NUMBUFLEN];
16564 char_u subbuf[NUMBUFLEN];
16565 char_u flagsbuf[NUMBUFLEN];
16567 char_u *str = get_tv_string_chk(&argvars[0]);
16568 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16569 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16570 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16572 rettv->v_type = VAR_STRING;
16573 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16574 rettv->vval.v_string = NULL;
16575 else
16576 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16580 * "synID(lnum, col, trans)" function
16582 /*ARGSUSED*/
16583 static void
16584 f_synID(argvars, rettv)
16585 typval_T *argvars;
16586 typval_T *rettv;
16588 int id = 0;
16589 #ifdef FEAT_SYN_HL
16590 long lnum;
16591 long col;
16592 int trans;
16593 int transerr = FALSE;
16595 lnum = get_tv_lnum(argvars); /* -1 on type error */
16596 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16597 trans = get_tv_number_chk(&argvars[2], &transerr);
16599 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16600 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16601 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16602 #endif
16604 rettv->vval.v_number = id;
16608 * "synIDattr(id, what [, mode])" function
16610 /*ARGSUSED*/
16611 static void
16612 f_synIDattr(argvars, rettv)
16613 typval_T *argvars;
16614 typval_T *rettv;
16616 char_u *p = NULL;
16617 #ifdef FEAT_SYN_HL
16618 int id;
16619 char_u *what;
16620 char_u *mode;
16621 char_u modebuf[NUMBUFLEN];
16622 int modec;
16624 id = get_tv_number(&argvars[0]);
16625 what = get_tv_string(&argvars[1]);
16626 if (argvars[2].v_type != VAR_UNKNOWN)
16628 mode = get_tv_string_buf(&argvars[2], modebuf);
16629 modec = TOLOWER_ASC(mode[0]);
16630 if (modec != 't' && modec != 'c'
16631 #ifdef FEAT_GUI
16632 && modec != 'g'
16633 #endif
16635 modec = 0; /* replace invalid with current */
16637 else
16639 #ifdef FEAT_GUI
16640 if (gui.in_use)
16641 modec = 'g';
16642 else
16643 #endif
16644 if (t_colors > 1)
16645 modec = 'c';
16646 else
16647 modec = 't';
16651 switch (TOLOWER_ASC(what[0]))
16653 case 'b':
16654 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16655 p = highlight_color(id, what, modec);
16656 else /* bold */
16657 p = highlight_has_attr(id, HL_BOLD, modec);
16658 break;
16660 case 'f': /* fg[#] */
16661 p = highlight_color(id, what, modec);
16662 break;
16664 case 'i':
16665 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16666 p = highlight_has_attr(id, HL_INVERSE, modec);
16667 else /* italic */
16668 p = highlight_has_attr(id, HL_ITALIC, modec);
16669 break;
16671 case 'n': /* name */
16672 p = get_highlight_name(NULL, id - 1);
16673 break;
16675 case 'r': /* reverse */
16676 p = highlight_has_attr(id, HL_INVERSE, modec);
16677 break;
16679 case 's':
16680 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16681 p = highlight_color(id, what, modec);
16682 else /* standout */
16683 p = highlight_has_attr(id, HL_STANDOUT, modec);
16684 break;
16686 case 'u':
16687 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16688 /* underline */
16689 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16690 else
16691 /* undercurl */
16692 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16693 break;
16696 if (p != NULL)
16697 p = vim_strsave(p);
16698 #endif
16699 rettv->v_type = VAR_STRING;
16700 rettv->vval.v_string = p;
16704 * "synIDtrans(id)" function
16706 /*ARGSUSED*/
16707 static void
16708 f_synIDtrans(argvars, rettv)
16709 typval_T *argvars;
16710 typval_T *rettv;
16712 int id;
16714 #ifdef FEAT_SYN_HL
16715 id = get_tv_number(&argvars[0]);
16717 if (id > 0)
16718 id = syn_get_final_id(id);
16719 else
16720 #endif
16721 id = 0;
16723 rettv->vval.v_number = id;
16727 * "synstack(lnum, col)" function
16729 /*ARGSUSED*/
16730 static void
16731 f_synstack(argvars, rettv)
16732 typval_T *argvars;
16733 typval_T *rettv;
16735 #ifdef FEAT_SYN_HL
16736 long lnum;
16737 long col;
16738 int i;
16739 int id;
16740 #endif
16742 rettv->v_type = VAR_LIST;
16743 rettv->vval.v_list = NULL;
16745 #ifdef FEAT_SYN_HL
16746 lnum = get_tv_lnum(argvars); /* -1 on type error */
16747 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16749 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16750 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16751 && rettv_list_alloc(rettv) != FAIL)
16753 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16754 for (i = 0; ; ++i)
16756 id = syn_get_stack_item(i);
16757 if (id < 0)
16758 break;
16759 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16760 break;
16763 #endif
16767 * "system()" function
16769 static void
16770 f_system(argvars, rettv)
16771 typval_T *argvars;
16772 typval_T *rettv;
16774 char_u *res = NULL;
16775 char_u *p;
16776 char_u *infile = NULL;
16777 char_u buf[NUMBUFLEN];
16778 int err = FALSE;
16779 FILE *fd;
16781 if (check_restricted() || check_secure())
16782 goto done;
16784 if (argvars[1].v_type != VAR_UNKNOWN)
16787 * Write the string to a temp file, to be used for input of the shell
16788 * command.
16790 if ((infile = vim_tempname('i')) == NULL)
16792 EMSG(_(e_notmp));
16793 goto done;
16796 fd = mch_fopen((char *)infile, WRITEBIN);
16797 if (fd == NULL)
16799 EMSG2(_(e_notopen), infile);
16800 goto done;
16802 p = get_tv_string_buf_chk(&argvars[1], buf);
16803 if (p == NULL)
16805 fclose(fd);
16806 goto done; /* type error; errmsg already given */
16808 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16809 err = TRUE;
16810 if (fclose(fd) != 0)
16811 err = TRUE;
16812 if (err)
16814 EMSG(_("E677: Error writing temp file"));
16815 goto done;
16819 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16820 SHELL_SILENT | SHELL_COOKED);
16822 #ifdef USE_CR
16823 /* translate <CR> into <NL> */
16824 if (res != NULL)
16826 char_u *s;
16828 for (s = res; *s; ++s)
16830 if (*s == CAR)
16831 *s = NL;
16834 #else
16835 # ifdef USE_CRNL
16836 /* translate <CR><NL> into <NL> */
16837 if (res != NULL)
16839 char_u *s, *d;
16841 d = res;
16842 for (s = res; *s; ++s)
16844 if (s[0] == CAR && s[1] == NL)
16845 ++s;
16846 *d++ = *s;
16848 *d = NUL;
16850 # endif
16851 #endif
16853 done:
16854 if (infile != NULL)
16856 mch_remove(infile);
16857 vim_free(infile);
16859 rettv->v_type = VAR_STRING;
16860 rettv->vval.v_string = res;
16864 * "tabpagebuflist()" function
16866 /* ARGSUSED */
16867 static void
16868 f_tabpagebuflist(argvars, rettv)
16869 typval_T *argvars;
16870 typval_T *rettv;
16872 #ifndef FEAT_WINDOWS
16873 rettv->vval.v_number = 0;
16874 #else
16875 tabpage_T *tp;
16876 win_T *wp = NULL;
16878 if (argvars[0].v_type == VAR_UNKNOWN)
16879 wp = firstwin;
16880 else
16882 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16883 if (tp != NULL)
16884 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16886 if (wp == NULL)
16887 rettv->vval.v_number = 0;
16888 else
16890 if (rettv_list_alloc(rettv) == FAIL)
16891 rettv->vval.v_number = 0;
16892 else
16894 for (; wp != NULL; wp = wp->w_next)
16895 if (list_append_number(rettv->vval.v_list,
16896 wp->w_buffer->b_fnum) == FAIL)
16897 break;
16900 #endif
16905 * "tabpagenr()" function
16907 /* ARGSUSED */
16908 static void
16909 f_tabpagenr(argvars, rettv)
16910 typval_T *argvars;
16911 typval_T *rettv;
16913 int nr = 1;
16914 #ifdef FEAT_WINDOWS
16915 char_u *arg;
16917 if (argvars[0].v_type != VAR_UNKNOWN)
16919 arg = get_tv_string_chk(&argvars[0]);
16920 nr = 0;
16921 if (arg != NULL)
16923 if (STRCMP(arg, "$") == 0)
16924 nr = tabpage_index(NULL) - 1;
16925 else
16926 EMSG2(_(e_invexpr2), arg);
16929 else
16930 nr = tabpage_index(curtab);
16931 #endif
16932 rettv->vval.v_number = nr;
16936 #ifdef FEAT_WINDOWS
16937 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16940 * Common code for tabpagewinnr() and winnr().
16942 static int
16943 get_winnr(tp, argvar)
16944 tabpage_T *tp;
16945 typval_T *argvar;
16947 win_T *twin;
16948 int nr = 1;
16949 win_T *wp;
16950 char_u *arg;
16952 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16953 if (argvar->v_type != VAR_UNKNOWN)
16955 arg = get_tv_string_chk(argvar);
16956 if (arg == NULL)
16957 nr = 0; /* type error; errmsg already given */
16958 else if (STRCMP(arg, "$") == 0)
16959 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16960 else if (STRCMP(arg, "#") == 0)
16962 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16963 if (twin == NULL)
16964 nr = 0;
16966 else
16968 EMSG2(_(e_invexpr2), arg);
16969 nr = 0;
16973 if (nr > 0)
16974 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16975 wp != twin; wp = wp->w_next)
16977 if (wp == NULL)
16979 /* didn't find it in this tabpage */
16980 nr = 0;
16981 break;
16983 ++nr;
16985 return nr;
16987 #endif
16990 * "tabpagewinnr()" function
16992 /* ARGSUSED */
16993 static void
16994 f_tabpagewinnr(argvars, rettv)
16995 typval_T *argvars;
16996 typval_T *rettv;
16998 int nr = 1;
16999 #ifdef FEAT_WINDOWS
17000 tabpage_T *tp;
17002 tp = find_tabpage((int)get_tv_number(&argvars[0]));
17003 if (tp == NULL)
17004 nr = 0;
17005 else
17006 nr = get_winnr(tp, &argvars[1]);
17007 #endif
17008 rettv->vval.v_number = nr;
17013 * "tagfiles()" function
17015 /*ARGSUSED*/
17016 static void
17017 f_tagfiles(argvars, rettv)
17018 typval_T *argvars;
17019 typval_T *rettv;
17021 char_u fname[MAXPATHL + 1];
17022 tagname_T tn;
17023 int first;
17025 if (rettv_list_alloc(rettv) == FAIL)
17027 rettv->vval.v_number = 0;
17028 return;
17031 for (first = TRUE; ; first = FALSE)
17032 if (get_tagfname(&tn, first, fname) == FAIL
17033 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
17034 break;
17035 tagname_free(&tn);
17039 * "taglist()" function
17041 static void
17042 f_taglist(argvars, rettv)
17043 typval_T *argvars;
17044 typval_T *rettv;
17046 char_u *tag_pattern;
17048 tag_pattern = get_tv_string(&argvars[0]);
17050 rettv->vval.v_number = FALSE;
17051 if (*tag_pattern == NUL)
17052 return;
17054 if (rettv_list_alloc(rettv) == OK)
17055 (void)get_tags(rettv->vval.v_list, tag_pattern);
17059 * "tempname()" function
17061 /*ARGSUSED*/
17062 static void
17063 f_tempname(argvars, rettv)
17064 typval_T *argvars;
17065 typval_T *rettv;
17067 static int x = 'A';
17069 rettv->v_type = VAR_STRING;
17070 rettv->vval.v_string = vim_tempname(x);
17072 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17073 * names. Skip 'I' and 'O', they are used for shell redirection. */
17076 if (x == 'Z')
17077 x = '0';
17078 else if (x == '9')
17079 x = 'A';
17080 else
17082 #ifdef EBCDIC
17083 if (x == 'I')
17084 x = 'J';
17085 else if (x == 'R')
17086 x = 'S';
17087 else
17088 #endif
17089 ++x;
17091 } while (x == 'I' || x == 'O');
17095 * "test(list)" function: Just checking the walls...
17097 /*ARGSUSED*/
17098 static void
17099 f_test(argvars, rettv)
17100 typval_T *argvars;
17101 typval_T *rettv;
17103 /* Used for unit testing. Change the code below to your liking. */
17104 #if 0
17105 listitem_T *li;
17106 list_T *l;
17107 char_u *bad, *good;
17109 if (argvars[0].v_type != VAR_LIST)
17110 return;
17111 l = argvars[0].vval.v_list;
17112 if (l == NULL)
17113 return;
17114 li = l->lv_first;
17115 if (li == NULL)
17116 return;
17117 bad = get_tv_string(&li->li_tv);
17118 li = li->li_next;
17119 if (li == NULL)
17120 return;
17121 good = get_tv_string(&li->li_tv);
17122 rettv->vval.v_number = test_edit_score(bad, good);
17123 #endif
17127 * "tolower(string)" function
17129 static void
17130 f_tolower(argvars, rettv)
17131 typval_T *argvars;
17132 typval_T *rettv;
17134 char_u *p;
17136 p = vim_strsave(get_tv_string(&argvars[0]));
17137 rettv->v_type = VAR_STRING;
17138 rettv->vval.v_string = p;
17140 if (p != NULL)
17141 while (*p != NUL)
17143 #ifdef FEAT_MBYTE
17144 int l;
17146 if (enc_utf8)
17148 int c, lc;
17150 c = utf_ptr2char(p);
17151 lc = utf_tolower(c);
17152 l = utf_ptr2len(p);
17153 /* TODO: reallocate string when byte count changes. */
17154 if (utf_char2len(lc) == l)
17155 utf_char2bytes(lc, p);
17156 p += l;
17158 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17159 p += l; /* skip multi-byte character */
17160 else
17161 #endif
17163 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17164 ++p;
17170 * "toupper(string)" function
17172 static void
17173 f_toupper(argvars, rettv)
17174 typval_T *argvars;
17175 typval_T *rettv;
17177 rettv->v_type = VAR_STRING;
17178 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17182 * "tr(string, fromstr, tostr)" function
17184 static void
17185 f_tr(argvars, rettv)
17186 typval_T *argvars;
17187 typval_T *rettv;
17189 char_u *instr;
17190 char_u *fromstr;
17191 char_u *tostr;
17192 char_u *p;
17193 #ifdef FEAT_MBYTE
17194 int inlen;
17195 int fromlen;
17196 int tolen;
17197 int idx;
17198 char_u *cpstr;
17199 int cplen;
17200 int first = TRUE;
17201 #endif
17202 char_u buf[NUMBUFLEN];
17203 char_u buf2[NUMBUFLEN];
17204 garray_T ga;
17206 instr = get_tv_string(&argvars[0]);
17207 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17208 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17210 /* Default return value: empty string. */
17211 rettv->v_type = VAR_STRING;
17212 rettv->vval.v_string = NULL;
17213 if (fromstr == NULL || tostr == NULL)
17214 return; /* type error; errmsg already given */
17215 ga_init2(&ga, (int)sizeof(char), 80);
17217 #ifdef FEAT_MBYTE
17218 if (!has_mbyte)
17219 #endif
17220 /* not multi-byte: fromstr and tostr must be the same length */
17221 if (STRLEN(fromstr) != STRLEN(tostr))
17223 #ifdef FEAT_MBYTE
17224 error:
17225 #endif
17226 EMSG2(_(e_invarg2), fromstr);
17227 ga_clear(&ga);
17228 return;
17231 /* fromstr and tostr have to contain the same number of chars */
17232 while (*instr != NUL)
17234 #ifdef FEAT_MBYTE
17235 if (has_mbyte)
17237 inlen = (*mb_ptr2len)(instr);
17238 cpstr = instr;
17239 cplen = inlen;
17240 idx = 0;
17241 for (p = fromstr; *p != NUL; p += fromlen)
17243 fromlen = (*mb_ptr2len)(p);
17244 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17246 for (p = tostr; *p != NUL; p += tolen)
17248 tolen = (*mb_ptr2len)(p);
17249 if (idx-- == 0)
17251 cplen = tolen;
17252 cpstr = p;
17253 break;
17256 if (*p == NUL) /* tostr is shorter than fromstr */
17257 goto error;
17258 break;
17260 ++idx;
17263 if (first && cpstr == instr)
17265 /* Check that fromstr and tostr have the same number of
17266 * (multi-byte) characters. Done only once when a character
17267 * of instr doesn't appear in fromstr. */
17268 first = FALSE;
17269 for (p = tostr; *p != NUL; p += tolen)
17271 tolen = (*mb_ptr2len)(p);
17272 --idx;
17274 if (idx != 0)
17275 goto error;
17278 ga_grow(&ga, cplen);
17279 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17280 ga.ga_len += cplen;
17282 instr += inlen;
17284 else
17285 #endif
17287 /* When not using multi-byte chars we can do it faster. */
17288 p = vim_strchr(fromstr, *instr);
17289 if (p != NULL)
17290 ga_append(&ga, tostr[p - fromstr]);
17291 else
17292 ga_append(&ga, *instr);
17293 ++instr;
17297 /* add a terminating NUL */
17298 ga_grow(&ga, 1);
17299 ga_append(&ga, NUL);
17301 rettv->vval.v_string = ga.ga_data;
17304 #ifdef FEAT_FLOAT
17306 * "trunc({float})" function
17308 static void
17309 f_trunc(argvars, rettv)
17310 typval_T *argvars;
17311 typval_T *rettv;
17313 float_T f;
17315 rettv->v_type = VAR_FLOAT;
17316 if (get_float_arg(argvars, &f) == OK)
17317 /* trunc() is not in C90, use floor() or ceil() instead. */
17318 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17319 else
17320 rettv->vval.v_float = 0.0;
17322 #endif
17325 * "type(expr)" function
17327 static void
17328 f_type(argvars, rettv)
17329 typval_T *argvars;
17330 typval_T *rettv;
17332 int n;
17334 switch (argvars[0].v_type)
17336 case VAR_NUMBER: n = 0; break;
17337 case VAR_STRING: n = 1; break;
17338 case VAR_FUNC: n = 2; break;
17339 case VAR_LIST: n = 3; break;
17340 case VAR_DICT: n = 4; break;
17341 #ifdef FEAT_FLOAT
17342 case VAR_FLOAT: n = 5; break;
17343 #endif
17344 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17346 rettv->vval.v_number = n;
17350 * "values(dict)" function
17352 static void
17353 f_values(argvars, rettv)
17354 typval_T *argvars;
17355 typval_T *rettv;
17357 dict_list(argvars, rettv, 1);
17361 * "virtcol(string)" function
17363 static void
17364 f_virtcol(argvars, rettv)
17365 typval_T *argvars;
17366 typval_T *rettv;
17368 colnr_T vcol = 0;
17369 pos_T *fp;
17370 int fnum = curbuf->b_fnum;
17372 fp = var2fpos(&argvars[0], FALSE, &fnum);
17373 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17374 && fnum == curbuf->b_fnum)
17376 getvvcol(curwin, fp, NULL, NULL, &vcol);
17377 ++vcol;
17380 rettv->vval.v_number = vcol;
17384 * "visualmode()" function
17386 /*ARGSUSED*/
17387 static void
17388 f_visualmode(argvars, rettv)
17389 typval_T *argvars;
17390 typval_T *rettv;
17392 #ifdef FEAT_VISUAL
17393 char_u str[2];
17395 rettv->v_type = VAR_STRING;
17396 str[0] = curbuf->b_visual_mode_eval;
17397 str[1] = NUL;
17398 rettv->vval.v_string = vim_strsave(str);
17400 /* A non-zero number or non-empty string argument: reset mode. */
17401 if (non_zero_arg(&argvars[0]))
17402 curbuf->b_visual_mode_eval = NUL;
17403 #else
17404 rettv->vval.v_number = 0; /* return anything, it won't work anyway */
17405 #endif
17409 * "winbufnr(nr)" function
17411 static void
17412 f_winbufnr(argvars, rettv)
17413 typval_T *argvars;
17414 typval_T *rettv;
17416 win_T *wp;
17418 wp = find_win_by_nr(&argvars[0], NULL);
17419 if (wp == NULL)
17420 rettv->vval.v_number = -1;
17421 else
17422 rettv->vval.v_number = wp->w_buffer->b_fnum;
17426 * "wincol()" function
17428 /*ARGSUSED*/
17429 static void
17430 f_wincol(argvars, rettv)
17431 typval_T *argvars;
17432 typval_T *rettv;
17434 validate_cursor();
17435 rettv->vval.v_number = curwin->w_wcol + 1;
17439 * "winheight(nr)" function
17441 static void
17442 f_winheight(argvars, rettv)
17443 typval_T *argvars;
17444 typval_T *rettv;
17446 win_T *wp;
17448 wp = find_win_by_nr(&argvars[0], NULL);
17449 if (wp == NULL)
17450 rettv->vval.v_number = -1;
17451 else
17452 rettv->vval.v_number = wp->w_height;
17456 * "winline()" function
17458 /*ARGSUSED*/
17459 static void
17460 f_winline(argvars, rettv)
17461 typval_T *argvars;
17462 typval_T *rettv;
17464 validate_cursor();
17465 rettv->vval.v_number = curwin->w_wrow + 1;
17469 * "winnr()" function
17471 /* ARGSUSED */
17472 static void
17473 f_winnr(argvars, rettv)
17474 typval_T *argvars;
17475 typval_T *rettv;
17477 int nr = 1;
17479 #ifdef FEAT_WINDOWS
17480 nr = get_winnr(curtab, &argvars[0]);
17481 #endif
17482 rettv->vval.v_number = nr;
17486 * "winrestcmd()" function
17488 /* ARGSUSED */
17489 static void
17490 f_winrestcmd(argvars, rettv)
17491 typval_T *argvars;
17492 typval_T *rettv;
17494 #ifdef FEAT_WINDOWS
17495 win_T *wp;
17496 int winnr = 1;
17497 garray_T ga;
17498 char_u buf[50];
17500 ga_init2(&ga, (int)sizeof(char), 70);
17501 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17503 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17504 ga_concat(&ga, buf);
17505 # ifdef FEAT_VERTSPLIT
17506 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17507 ga_concat(&ga, buf);
17508 # endif
17509 ++winnr;
17511 ga_append(&ga, NUL);
17513 rettv->vval.v_string = ga.ga_data;
17514 #else
17515 rettv->vval.v_string = NULL;
17516 #endif
17517 rettv->v_type = VAR_STRING;
17521 * "winrestview()" function
17523 /* ARGSUSED */
17524 static void
17525 f_winrestview(argvars, rettv)
17526 typval_T *argvars;
17527 typval_T *rettv;
17529 dict_T *dict;
17531 if (argvars[0].v_type != VAR_DICT
17532 || (dict = argvars[0].vval.v_dict) == NULL)
17533 EMSG(_(e_invarg));
17534 else
17536 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17537 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17538 #ifdef FEAT_VIRTUALEDIT
17539 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17540 #endif
17541 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17542 curwin->w_set_curswant = FALSE;
17544 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17545 #ifdef FEAT_DIFF
17546 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17547 #endif
17548 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17549 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17551 check_cursor();
17552 changed_cline_bef_curs();
17553 invalidate_botline();
17554 redraw_later(VALID);
17556 if (curwin->w_topline == 0)
17557 curwin->w_topline = 1;
17558 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17559 curwin->w_topline = curbuf->b_ml.ml_line_count;
17560 #ifdef FEAT_DIFF
17561 check_topfill(curwin, TRUE);
17562 #endif
17567 * "winsaveview()" function
17569 /* ARGSUSED */
17570 static void
17571 f_winsaveview(argvars, rettv)
17572 typval_T *argvars;
17573 typval_T *rettv;
17575 dict_T *dict;
17577 dict = dict_alloc();
17578 if (dict == NULL)
17579 return;
17580 rettv->v_type = VAR_DICT;
17581 rettv->vval.v_dict = dict;
17582 ++dict->dv_refcount;
17584 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17585 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17586 #ifdef FEAT_VIRTUALEDIT
17587 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17588 #endif
17589 update_curswant();
17590 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17592 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17593 #ifdef FEAT_DIFF
17594 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17595 #endif
17596 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17597 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17601 * "winwidth(nr)" function
17603 static void
17604 f_winwidth(argvars, rettv)
17605 typval_T *argvars;
17606 typval_T *rettv;
17608 win_T *wp;
17610 wp = find_win_by_nr(&argvars[0], NULL);
17611 if (wp == NULL)
17612 rettv->vval.v_number = -1;
17613 else
17614 #ifdef FEAT_VERTSPLIT
17615 rettv->vval.v_number = wp->w_width;
17616 #else
17617 rettv->vval.v_number = Columns;
17618 #endif
17622 * "writefile()" function
17624 static void
17625 f_writefile(argvars, rettv)
17626 typval_T *argvars;
17627 typval_T *rettv;
17629 int binary = FALSE;
17630 char_u *fname;
17631 FILE *fd;
17632 listitem_T *li;
17633 char_u *s;
17634 int ret = 0;
17635 int c;
17637 if (check_restricted() || check_secure())
17638 return;
17640 if (argvars[0].v_type != VAR_LIST)
17642 EMSG2(_(e_listarg), "writefile()");
17643 return;
17645 if (argvars[0].vval.v_list == NULL)
17646 return;
17648 if (argvars[2].v_type != VAR_UNKNOWN
17649 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17650 binary = TRUE;
17652 /* Always open the file in binary mode, library functions have a mind of
17653 * their own about CR-LF conversion. */
17654 fname = get_tv_string(&argvars[1]);
17655 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17657 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17658 ret = -1;
17660 else
17662 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17663 li = li->li_next)
17665 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17667 if (*s == '\n')
17668 c = putc(NUL, fd);
17669 else
17670 c = putc(*s, fd);
17671 if (c == EOF)
17673 ret = -1;
17674 break;
17677 if (!binary || li->li_next != NULL)
17678 if (putc('\n', fd) == EOF)
17680 ret = -1;
17681 break;
17683 if (ret < 0)
17685 EMSG(_(e_write));
17686 break;
17689 fclose(fd);
17692 rettv->vval.v_number = ret;
17696 * Translate a String variable into a position.
17697 * Returns NULL when there is an error.
17699 static pos_T *
17700 var2fpos(varp, dollar_lnum, fnum)
17701 typval_T *varp;
17702 int dollar_lnum; /* TRUE when $ is last line */
17703 int *fnum; /* set to fnum for '0, 'A, etc. */
17705 char_u *name;
17706 static pos_T pos;
17707 pos_T *pp;
17709 /* Argument can be [lnum, col, coladd]. */
17710 if (varp->v_type == VAR_LIST)
17712 list_T *l;
17713 int len;
17714 int error = FALSE;
17715 listitem_T *li;
17717 l = varp->vval.v_list;
17718 if (l == NULL)
17719 return NULL;
17721 /* Get the line number */
17722 pos.lnum = list_find_nr(l, 0L, &error);
17723 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17724 return NULL; /* invalid line number */
17726 /* Get the column number */
17727 pos.col = list_find_nr(l, 1L, &error);
17728 if (error)
17729 return NULL;
17730 len = (long)STRLEN(ml_get(pos.lnum));
17732 /* We accept "$" for the column number: last column. */
17733 li = list_find(l, 1L);
17734 if (li != NULL && li->li_tv.v_type == VAR_STRING
17735 && li->li_tv.vval.v_string != NULL
17736 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17737 pos.col = len + 1;
17739 /* Accept a position up to the NUL after the line. */
17740 if (pos.col == 0 || (int)pos.col > len + 1)
17741 return NULL; /* invalid column number */
17742 --pos.col;
17744 #ifdef FEAT_VIRTUALEDIT
17745 /* Get the virtual offset. Defaults to zero. */
17746 pos.coladd = list_find_nr(l, 2L, &error);
17747 if (error)
17748 pos.coladd = 0;
17749 #endif
17751 return &pos;
17754 name = get_tv_string_chk(varp);
17755 if (name == NULL)
17756 return NULL;
17757 if (name[0] == '.') /* cursor */
17758 return &curwin->w_cursor;
17759 #ifdef FEAT_VISUAL
17760 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17762 if (VIsual_active)
17763 return &VIsual;
17764 return &curwin->w_cursor;
17766 #endif
17767 if (name[0] == '\'') /* mark */
17769 pp = getmark_fnum(name[1], FALSE, fnum);
17770 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17771 return NULL;
17772 return pp;
17775 #ifdef FEAT_VIRTUALEDIT
17776 pos.coladd = 0;
17777 #endif
17779 if (name[0] == 'w' && dollar_lnum)
17781 pos.col = 0;
17782 if (name[1] == '0') /* "w0": first visible line */
17784 update_topline();
17785 pos.lnum = curwin->w_topline;
17786 return &pos;
17788 else if (name[1] == '$') /* "w$": last visible line */
17790 validate_botline();
17791 pos.lnum = curwin->w_botline - 1;
17792 return &pos;
17795 else if (name[0] == '$') /* last column or line */
17797 if (dollar_lnum)
17799 pos.lnum = curbuf->b_ml.ml_line_count;
17800 pos.col = 0;
17802 else
17804 pos.lnum = curwin->w_cursor.lnum;
17805 pos.col = (colnr_T)STRLEN(ml_get_curline());
17807 return &pos;
17809 return NULL;
17813 * Convert list in "arg" into a position and optional file number.
17814 * When "fnump" is NULL there is no file number, only 3 items.
17815 * Note that the column is passed on as-is, the caller may want to decrement
17816 * it to use 1 for the first column.
17817 * Return FAIL when conversion is not possible, doesn't check the position for
17818 * validity.
17820 static int
17821 list2fpos(arg, posp, fnump)
17822 typval_T *arg;
17823 pos_T *posp;
17824 int *fnump;
17826 list_T *l = arg->vval.v_list;
17827 long i = 0;
17828 long n;
17830 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17831 * when "fnump" isn't NULL and "coladd" is optional. */
17832 if (arg->v_type != VAR_LIST
17833 || l == NULL
17834 || l->lv_len < (fnump == NULL ? 2 : 3)
17835 || l->lv_len > (fnump == NULL ? 3 : 4))
17836 return FAIL;
17838 if (fnump != NULL)
17840 n = list_find_nr(l, i++, NULL); /* fnum */
17841 if (n < 0)
17842 return FAIL;
17843 if (n == 0)
17844 n = curbuf->b_fnum; /* current buffer */
17845 *fnump = n;
17848 n = list_find_nr(l, i++, NULL); /* lnum */
17849 if (n < 0)
17850 return FAIL;
17851 posp->lnum = n;
17853 n = list_find_nr(l, i++, NULL); /* col */
17854 if (n < 0)
17855 return FAIL;
17856 posp->col = n;
17858 #ifdef FEAT_VIRTUALEDIT
17859 n = list_find_nr(l, i, NULL);
17860 if (n < 0)
17861 posp->coladd = 0;
17862 else
17863 posp->coladd = n;
17864 #endif
17866 return OK;
17870 * Get the length of an environment variable name.
17871 * Advance "arg" to the first character after the name.
17872 * Return 0 for error.
17874 static int
17875 get_env_len(arg)
17876 char_u **arg;
17878 char_u *p;
17879 int len;
17881 for (p = *arg; vim_isIDc(*p); ++p)
17883 if (p == *arg) /* no name found */
17884 return 0;
17886 len = (int)(p - *arg);
17887 *arg = p;
17888 return len;
17892 * Get the length of the name of a function or internal variable.
17893 * "arg" is advanced to the first non-white character after the name.
17894 * Return 0 if something is wrong.
17896 static int
17897 get_id_len(arg)
17898 char_u **arg;
17900 char_u *p;
17901 int len;
17903 /* Find the end of the name. */
17904 for (p = *arg; eval_isnamec(*p); ++p)
17906 if (p == *arg) /* no name found */
17907 return 0;
17909 len = (int)(p - *arg);
17910 *arg = skipwhite(p);
17912 return len;
17916 * Get the length of the name of a variable or function.
17917 * Only the name is recognized, does not handle ".key" or "[idx]".
17918 * "arg" is advanced to the first non-white character after the name.
17919 * Return -1 if curly braces expansion failed.
17920 * Return 0 if something else is wrong.
17921 * If the name contains 'magic' {}'s, expand them and return the
17922 * expanded name in an allocated string via 'alias' - caller must free.
17924 static int
17925 get_name_len(arg, alias, evaluate, verbose)
17926 char_u **arg;
17927 char_u **alias;
17928 int evaluate;
17929 int verbose;
17931 int len;
17932 char_u *p;
17933 char_u *expr_start;
17934 char_u *expr_end;
17936 *alias = NULL; /* default to no alias */
17938 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17939 && (*arg)[2] == (int)KE_SNR)
17941 /* hard coded <SNR>, already translated */
17942 *arg += 3;
17943 return get_id_len(arg) + 3;
17945 len = eval_fname_script(*arg);
17946 if (len > 0)
17948 /* literal "<SID>", "s:" or "<SNR>" */
17949 *arg += len;
17953 * Find the end of the name; check for {} construction.
17955 p = find_name_end(*arg, &expr_start, &expr_end,
17956 len > 0 ? 0 : FNE_CHECK_START);
17957 if (expr_start != NULL)
17959 char_u *temp_string;
17961 if (!evaluate)
17963 len += (int)(p - *arg);
17964 *arg = skipwhite(p);
17965 return len;
17969 * Include any <SID> etc in the expanded string:
17970 * Thus the -len here.
17972 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17973 if (temp_string == NULL)
17974 return -1;
17975 *alias = temp_string;
17976 *arg = skipwhite(p);
17977 return (int)STRLEN(temp_string);
17980 len += get_id_len(arg);
17981 if (len == 0 && verbose)
17982 EMSG2(_(e_invexpr2), *arg);
17984 return len;
17988 * Find the end of a variable or function name, taking care of magic braces.
17989 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17990 * start and end of the first magic braces item.
17991 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17992 * Return a pointer to just after the name. Equal to "arg" if there is no
17993 * valid name.
17995 static char_u *
17996 find_name_end(arg, expr_start, expr_end, flags)
17997 char_u *arg;
17998 char_u **expr_start;
17999 char_u **expr_end;
18000 int flags;
18002 int mb_nest = 0;
18003 int br_nest = 0;
18004 char_u *p;
18006 if (expr_start != NULL)
18008 *expr_start = NULL;
18009 *expr_end = NULL;
18012 /* Quick check for valid starting character. */
18013 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
18014 return arg;
18016 for (p = arg; *p != NUL
18017 && (eval_isnamec(*p)
18018 || *p == '{'
18019 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
18020 || mb_nest != 0
18021 || br_nest != 0); mb_ptr_adv(p))
18023 if (*p == '\'')
18025 /* skip over 'string' to avoid counting [ and ] inside it. */
18026 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
18028 if (*p == NUL)
18029 break;
18031 else if (*p == '"')
18033 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
18034 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
18035 if (*p == '\\' && p[1] != NUL)
18036 ++p;
18037 if (*p == NUL)
18038 break;
18041 if (mb_nest == 0)
18043 if (*p == '[')
18044 ++br_nest;
18045 else if (*p == ']')
18046 --br_nest;
18049 if (br_nest == 0)
18051 if (*p == '{')
18053 mb_nest++;
18054 if (expr_start != NULL && *expr_start == NULL)
18055 *expr_start = p;
18057 else if (*p == '}')
18059 mb_nest--;
18060 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18061 *expr_end = p;
18066 return p;
18070 * Expands out the 'magic' {}'s in a variable/function name.
18071 * Note that this can call itself recursively, to deal with
18072 * constructs like foo{bar}{baz}{bam}
18073 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18074 * "in_start" ^
18075 * "expr_start" ^
18076 * "expr_end" ^
18077 * "in_end" ^
18079 * Returns a new allocated string, which the caller must free.
18080 * Returns NULL for failure.
18082 static char_u *
18083 make_expanded_name(in_start, expr_start, expr_end, in_end)
18084 char_u *in_start;
18085 char_u *expr_start;
18086 char_u *expr_end;
18087 char_u *in_end;
18089 char_u c1;
18090 char_u *retval = NULL;
18091 char_u *temp_result;
18092 char_u *nextcmd = NULL;
18094 if (expr_end == NULL || in_end == NULL)
18095 return NULL;
18096 *expr_start = NUL;
18097 *expr_end = NUL;
18098 c1 = *in_end;
18099 *in_end = NUL;
18101 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18102 if (temp_result != NULL && nextcmd == NULL)
18104 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18105 + (in_end - expr_end) + 1));
18106 if (retval != NULL)
18108 STRCPY(retval, in_start);
18109 STRCAT(retval, temp_result);
18110 STRCAT(retval, expr_end + 1);
18113 vim_free(temp_result);
18115 *in_end = c1; /* put char back for error messages */
18116 *expr_start = '{';
18117 *expr_end = '}';
18119 if (retval != NULL)
18121 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18122 if (expr_start != NULL)
18124 /* Further expansion! */
18125 temp_result = make_expanded_name(retval, expr_start,
18126 expr_end, temp_result);
18127 vim_free(retval);
18128 retval = temp_result;
18132 return retval;
18136 * Return TRUE if character "c" can be used in a variable or function name.
18137 * Does not include '{' or '}' for magic braces.
18139 static int
18140 eval_isnamec(c)
18141 int c;
18143 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18147 * Return TRUE if character "c" can be used as the first character in a
18148 * variable or function name (excluding '{' and '}').
18150 static int
18151 eval_isnamec1(c)
18152 int c;
18154 return (ASCII_ISALPHA(c) || c == '_');
18158 * Set number v: variable to "val".
18160 void
18161 set_vim_var_nr(idx, val)
18162 int idx;
18163 long val;
18165 vimvars[idx].vv_nr = val;
18169 * Get number v: variable value.
18171 long
18172 get_vim_var_nr(idx)
18173 int idx;
18175 return vimvars[idx].vv_nr;
18179 * Get string v: variable value. Uses a static buffer, can only be used once.
18181 char_u *
18182 get_vim_var_str(idx)
18183 int idx;
18185 return get_tv_string(&vimvars[idx].vv_tv);
18189 * Get List v: variable value. Caller must take care of reference count when
18190 * needed.
18192 list_T *
18193 get_vim_var_list(idx)
18194 int idx;
18196 return vimvars[idx].vv_list;
18200 * Set v:count to "count" and v:count1 to "count1".
18201 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18203 void
18204 set_vcount(count, count1, set_prevcount)
18205 long count;
18206 long count1;
18207 int set_prevcount;
18209 if (set_prevcount)
18210 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18211 vimvars[VV_COUNT].vv_nr = count;
18212 vimvars[VV_COUNT1].vv_nr = count1;
18216 * Set string v: variable to a copy of "val".
18218 void
18219 set_vim_var_string(idx, val, len)
18220 int idx;
18221 char_u *val;
18222 int len; /* length of "val" to use or -1 (whole string) */
18224 /* Need to do this (at least) once, since we can't initialize a union.
18225 * Will always be invoked when "v:progname" is set. */
18226 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18228 vim_free(vimvars[idx].vv_str);
18229 if (val == NULL)
18230 vimvars[idx].vv_str = NULL;
18231 else if (len == -1)
18232 vimvars[idx].vv_str = vim_strsave(val);
18233 else
18234 vimvars[idx].vv_str = vim_strnsave(val, len);
18238 * Set List v: variable to "val".
18240 void
18241 set_vim_var_list(idx, val)
18242 int idx;
18243 list_T *val;
18245 list_unref(vimvars[idx].vv_list);
18246 vimvars[idx].vv_list = val;
18247 if (val != NULL)
18248 ++val->lv_refcount;
18252 * Set v:register if needed.
18254 void
18255 set_reg_var(c)
18256 int c;
18258 char_u regname;
18260 if (c == 0 || c == ' ')
18261 regname = '"';
18262 else
18263 regname = c;
18264 /* Avoid free/alloc when the value is already right. */
18265 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18266 set_vim_var_string(VV_REG, &regname, 1);
18270 * Get or set v:exception. If "oldval" == NULL, return the current value.
18271 * Otherwise, restore the value to "oldval" and return NULL.
18272 * Must always be called in pairs to save and restore v:exception! Does not
18273 * take care of memory allocations.
18275 char_u *
18276 v_exception(oldval)
18277 char_u *oldval;
18279 if (oldval == NULL)
18280 return vimvars[VV_EXCEPTION].vv_str;
18282 vimvars[VV_EXCEPTION].vv_str = oldval;
18283 return NULL;
18287 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18288 * Otherwise, restore the value to "oldval" and return NULL.
18289 * Must always be called in pairs to save and restore v:throwpoint! Does not
18290 * take care of memory allocations.
18292 char_u *
18293 v_throwpoint(oldval)
18294 char_u *oldval;
18296 if (oldval == NULL)
18297 return vimvars[VV_THROWPOINT].vv_str;
18299 vimvars[VV_THROWPOINT].vv_str = oldval;
18300 return NULL;
18303 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18305 * Set v:cmdarg.
18306 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18307 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18308 * Must always be called in pairs!
18310 char_u *
18311 set_cmdarg(eap, oldarg)
18312 exarg_T *eap;
18313 char_u *oldarg;
18315 char_u *oldval;
18316 char_u *newval;
18317 unsigned len;
18319 oldval = vimvars[VV_CMDARG].vv_str;
18320 if (eap == NULL)
18322 vim_free(oldval);
18323 vimvars[VV_CMDARG].vv_str = oldarg;
18324 return NULL;
18327 if (eap->force_bin == FORCE_BIN)
18328 len = 6;
18329 else if (eap->force_bin == FORCE_NOBIN)
18330 len = 8;
18331 else
18332 len = 0;
18334 if (eap->read_edit)
18335 len += 7;
18337 if (eap->force_ff != 0)
18338 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18339 # ifdef FEAT_MBYTE
18340 if (eap->force_enc != 0)
18341 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18342 if (eap->bad_char != 0)
18343 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18344 # endif
18346 newval = alloc(len + 1);
18347 if (newval == NULL)
18348 return NULL;
18350 if (eap->force_bin == FORCE_BIN)
18351 sprintf((char *)newval, " ++bin");
18352 else if (eap->force_bin == FORCE_NOBIN)
18353 sprintf((char *)newval, " ++nobin");
18354 else
18355 *newval = NUL;
18357 if (eap->read_edit)
18358 STRCAT(newval, " ++edit");
18360 if (eap->force_ff != 0)
18361 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18362 eap->cmd + eap->force_ff);
18363 # ifdef FEAT_MBYTE
18364 if (eap->force_enc != 0)
18365 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18366 eap->cmd + eap->force_enc);
18367 if (eap->bad_char != 0)
18368 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18369 eap->cmd + eap->bad_char);
18370 # endif
18371 vimvars[VV_CMDARG].vv_str = newval;
18372 return oldval;
18374 #endif
18377 * Get the value of internal variable "name".
18378 * Return OK or FAIL.
18380 static int
18381 get_var_tv(name, len, rettv, verbose)
18382 char_u *name;
18383 int len; /* length of "name" */
18384 typval_T *rettv; /* NULL when only checking existence */
18385 int verbose; /* may give error message */
18387 int ret = OK;
18388 typval_T *tv = NULL;
18389 typval_T atv;
18390 dictitem_T *v;
18391 int cc;
18393 /* truncate the name, so that we can use strcmp() */
18394 cc = name[len];
18395 name[len] = NUL;
18398 * Check for "b:changedtick".
18400 if (STRCMP(name, "b:changedtick") == 0)
18402 atv.v_type = VAR_NUMBER;
18403 atv.vval.v_number = curbuf->b_changedtick;
18404 tv = &atv;
18408 * Check for user-defined variables.
18410 else
18412 v = find_var(name, NULL);
18413 if (v != NULL)
18414 tv = &v->di_tv;
18417 if (tv == NULL)
18419 if (rettv != NULL && verbose)
18420 EMSG2(_(e_undefvar), name);
18421 ret = FAIL;
18423 else if (rettv != NULL)
18424 copy_tv(tv, rettv);
18426 name[len] = cc;
18428 return ret;
18432 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18433 * Also handle function call with Funcref variable: func(expr)
18434 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18436 static int
18437 handle_subscript(arg, rettv, evaluate, verbose)
18438 char_u **arg;
18439 typval_T *rettv;
18440 int evaluate; /* do more than finding the end */
18441 int verbose; /* give error messages */
18443 int ret = OK;
18444 dict_T *selfdict = NULL;
18445 char_u *s;
18446 int len;
18447 typval_T functv;
18449 while (ret == OK
18450 && (**arg == '['
18451 || (**arg == '.' && rettv->v_type == VAR_DICT)
18452 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18453 && !vim_iswhite(*(*arg - 1)))
18455 if (**arg == '(')
18457 /* need to copy the funcref so that we can clear rettv */
18458 functv = *rettv;
18459 rettv->v_type = VAR_UNKNOWN;
18461 /* Invoke the function. Recursive! */
18462 s = functv.vval.v_string;
18463 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18464 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18465 &len, evaluate, selfdict);
18467 /* Clear the funcref afterwards, so that deleting it while
18468 * evaluating the arguments is possible (see test55). */
18469 clear_tv(&functv);
18471 /* Stop the expression evaluation when immediately aborting on
18472 * error, or when an interrupt occurred or an exception was thrown
18473 * but not caught. */
18474 if (aborting())
18476 if (ret == OK)
18477 clear_tv(rettv);
18478 ret = FAIL;
18480 dict_unref(selfdict);
18481 selfdict = NULL;
18483 else /* **arg == '[' || **arg == '.' */
18485 dict_unref(selfdict);
18486 if (rettv->v_type == VAR_DICT)
18488 selfdict = rettv->vval.v_dict;
18489 if (selfdict != NULL)
18490 ++selfdict->dv_refcount;
18492 else
18493 selfdict = NULL;
18494 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18496 clear_tv(rettv);
18497 ret = FAIL;
18501 dict_unref(selfdict);
18502 return ret;
18506 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18507 * value).
18509 static typval_T *
18510 alloc_tv()
18512 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18516 * Allocate memory for a variable type-value, and assign a string to it.
18517 * The string "s" must have been allocated, it is consumed.
18518 * Return NULL for out of memory, the variable otherwise.
18520 static typval_T *
18521 alloc_string_tv(s)
18522 char_u *s;
18524 typval_T *rettv;
18526 rettv = alloc_tv();
18527 if (rettv != NULL)
18529 rettv->v_type = VAR_STRING;
18530 rettv->vval.v_string = s;
18532 else
18533 vim_free(s);
18534 return rettv;
18538 * Free the memory for a variable type-value.
18540 void
18541 free_tv(varp)
18542 typval_T *varp;
18544 if (varp != NULL)
18546 switch (varp->v_type)
18548 case VAR_FUNC:
18549 func_unref(varp->vval.v_string);
18550 /*FALLTHROUGH*/
18551 case VAR_STRING:
18552 vim_free(varp->vval.v_string);
18553 break;
18554 case VAR_LIST:
18555 list_unref(varp->vval.v_list);
18556 break;
18557 case VAR_DICT:
18558 dict_unref(varp->vval.v_dict);
18559 break;
18560 case VAR_NUMBER:
18561 #ifdef FEAT_FLOAT
18562 case VAR_FLOAT:
18563 #endif
18564 case VAR_UNKNOWN:
18565 break;
18566 default:
18567 EMSG2(_(e_intern2), "free_tv()");
18568 break;
18570 vim_free(varp);
18575 * Free the memory for a variable value and set the value to NULL or 0.
18577 void
18578 clear_tv(varp)
18579 typval_T *varp;
18581 if (varp != NULL)
18583 switch (varp->v_type)
18585 case VAR_FUNC:
18586 func_unref(varp->vval.v_string);
18587 /*FALLTHROUGH*/
18588 case VAR_STRING:
18589 vim_free(varp->vval.v_string);
18590 varp->vval.v_string = NULL;
18591 break;
18592 case VAR_LIST:
18593 list_unref(varp->vval.v_list);
18594 varp->vval.v_list = NULL;
18595 break;
18596 case VAR_DICT:
18597 dict_unref(varp->vval.v_dict);
18598 varp->vval.v_dict = NULL;
18599 break;
18600 case VAR_NUMBER:
18601 varp->vval.v_number = 0;
18602 break;
18603 #ifdef FEAT_FLOAT
18604 case VAR_FLOAT:
18605 varp->vval.v_float = 0.0;
18606 break;
18607 #endif
18608 case VAR_UNKNOWN:
18609 break;
18610 default:
18611 EMSG2(_(e_intern2), "clear_tv()");
18613 varp->v_lock = 0;
18618 * Set the value of a variable to NULL without freeing items.
18620 static void
18621 init_tv(varp)
18622 typval_T *varp;
18624 if (varp != NULL)
18625 vim_memset(varp, 0, sizeof(typval_T));
18629 * Get the number value of a variable.
18630 * If it is a String variable, uses vim_str2nr().
18631 * For incompatible types, return 0.
18632 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18633 * caller of incompatible types: it sets *denote to TRUE if "denote"
18634 * is not NULL or returns -1 otherwise.
18636 static long
18637 get_tv_number(varp)
18638 typval_T *varp;
18640 int error = FALSE;
18642 return get_tv_number_chk(varp, &error); /* return 0L on error */
18645 long
18646 get_tv_number_chk(varp, denote)
18647 typval_T *varp;
18648 int *denote;
18650 long n = 0L;
18652 switch (varp->v_type)
18654 case VAR_NUMBER:
18655 return (long)(varp->vval.v_number);
18656 #ifdef FEAT_FLOAT
18657 case VAR_FLOAT:
18658 EMSG(_("E805: Using a Float as a Number"));
18659 break;
18660 #endif
18661 case VAR_FUNC:
18662 EMSG(_("E703: Using a Funcref as a Number"));
18663 break;
18664 case VAR_STRING:
18665 if (varp->vval.v_string != NULL)
18666 vim_str2nr(varp->vval.v_string, NULL, NULL,
18667 TRUE, TRUE, &n, NULL);
18668 return n;
18669 case VAR_LIST:
18670 EMSG(_("E745: Using a List as a Number"));
18671 break;
18672 case VAR_DICT:
18673 EMSG(_("E728: Using a Dictionary as a Number"));
18674 break;
18675 default:
18676 EMSG2(_(e_intern2), "get_tv_number()");
18677 break;
18679 if (denote == NULL) /* useful for values that must be unsigned */
18680 n = -1;
18681 else
18682 *denote = TRUE;
18683 return n;
18687 * Get the lnum from the first argument.
18688 * Also accepts ".", "$", etc., but that only works for the current buffer.
18689 * Returns -1 on error.
18691 static linenr_T
18692 get_tv_lnum(argvars)
18693 typval_T *argvars;
18695 typval_T rettv;
18696 linenr_T lnum;
18698 lnum = get_tv_number_chk(&argvars[0], NULL);
18699 if (lnum == 0) /* no valid number, try using line() */
18701 rettv.v_type = VAR_NUMBER;
18702 f_line(argvars, &rettv);
18703 lnum = rettv.vval.v_number;
18704 clear_tv(&rettv);
18706 return lnum;
18710 * Get the lnum from the first argument.
18711 * Also accepts "$", then "buf" is used.
18712 * Returns 0 on error.
18714 static linenr_T
18715 get_tv_lnum_buf(argvars, buf)
18716 typval_T *argvars;
18717 buf_T *buf;
18719 if (argvars[0].v_type == VAR_STRING
18720 && argvars[0].vval.v_string != NULL
18721 && argvars[0].vval.v_string[0] == '$'
18722 && buf != NULL)
18723 return buf->b_ml.ml_line_count;
18724 return get_tv_number_chk(&argvars[0], NULL);
18728 * Get the string value of a variable.
18729 * If it is a Number variable, the number is converted into a string.
18730 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18731 * get_tv_string_buf() uses a given buffer.
18732 * If the String variable has never been set, return an empty string.
18733 * Never returns NULL;
18734 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18735 * NULL on error.
18737 static char_u *
18738 get_tv_string(varp)
18739 typval_T *varp;
18741 static char_u mybuf[NUMBUFLEN];
18743 return get_tv_string_buf(varp, mybuf);
18746 static char_u *
18747 get_tv_string_buf(varp, buf)
18748 typval_T *varp;
18749 char_u *buf;
18751 char_u *res = get_tv_string_buf_chk(varp, buf);
18753 return res != NULL ? res : (char_u *)"";
18756 char_u *
18757 get_tv_string_chk(varp)
18758 typval_T *varp;
18760 static char_u mybuf[NUMBUFLEN];
18762 return get_tv_string_buf_chk(varp, mybuf);
18765 static char_u *
18766 get_tv_string_buf_chk(varp, buf)
18767 typval_T *varp;
18768 char_u *buf;
18770 switch (varp->v_type)
18772 case VAR_NUMBER:
18773 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18774 return buf;
18775 case VAR_FUNC:
18776 EMSG(_("E729: using Funcref as a String"));
18777 break;
18778 case VAR_LIST:
18779 EMSG(_("E730: using List as a String"));
18780 break;
18781 case VAR_DICT:
18782 EMSG(_("E731: using Dictionary as a String"));
18783 break;
18784 #ifdef FEAT_FLOAT
18785 case VAR_FLOAT:
18786 EMSG(_("E806: using Float as a String"));
18787 break;
18788 #endif
18789 case VAR_STRING:
18790 if (varp->vval.v_string != NULL)
18791 return varp->vval.v_string;
18792 return (char_u *)"";
18793 default:
18794 EMSG2(_(e_intern2), "get_tv_string_buf()");
18795 break;
18797 return NULL;
18801 * Find variable "name" in the list of variables.
18802 * Return a pointer to it if found, NULL if not found.
18803 * Careful: "a:0" variables don't have a name.
18804 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18805 * hashtab_T used.
18807 static dictitem_T *
18808 find_var(name, htp)
18809 char_u *name;
18810 hashtab_T **htp;
18812 char_u *varname;
18813 hashtab_T *ht;
18815 ht = find_var_ht(name, &varname);
18816 if (htp != NULL)
18817 *htp = ht;
18818 if (ht == NULL)
18819 return NULL;
18820 return find_var_in_ht(ht, varname, htp != NULL);
18824 * Find variable "varname" in hashtab "ht".
18825 * Returns NULL if not found.
18827 static dictitem_T *
18828 find_var_in_ht(ht, varname, writing)
18829 hashtab_T *ht;
18830 char_u *varname;
18831 int writing;
18833 hashitem_T *hi;
18835 if (*varname == NUL)
18837 /* Must be something like "s:", otherwise "ht" would be NULL. */
18838 switch (varname[-2])
18840 case 's': return &SCRIPT_SV(current_SID).sv_var;
18841 case 'g': return &globvars_var;
18842 case 'v': return &vimvars_var;
18843 case 'b': return &curbuf->b_bufvar;
18844 case 'w': return &curwin->w_winvar;
18845 #ifdef FEAT_WINDOWS
18846 case 't': return &curtab->tp_winvar;
18847 #endif
18848 case 'l': return current_funccal == NULL
18849 ? NULL : &current_funccal->l_vars_var;
18850 case 'a': return current_funccal == NULL
18851 ? NULL : &current_funccal->l_avars_var;
18853 return NULL;
18856 hi = hash_find(ht, varname);
18857 if (HASHITEM_EMPTY(hi))
18859 /* For global variables we may try auto-loading the script. If it
18860 * worked find the variable again. Don't auto-load a script if it was
18861 * loaded already, otherwise it would be loaded every time when
18862 * checking if a function name is a Funcref variable. */
18863 if (ht == &globvarht && !writing
18864 && script_autoload(varname, FALSE) && !aborting())
18865 hi = hash_find(ht, varname);
18866 if (HASHITEM_EMPTY(hi))
18867 return NULL;
18869 return HI2DI(hi);
18873 * Find the hashtab used for a variable name.
18874 * Set "varname" to the start of name without ':'.
18876 static hashtab_T *
18877 find_var_ht(name, varname)
18878 char_u *name;
18879 char_u **varname;
18881 hashitem_T *hi;
18883 if (name[1] != ':')
18885 /* The name must not start with a colon or #. */
18886 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18887 return NULL;
18888 *varname = name;
18890 /* "version" is "v:version" in all scopes */
18891 hi = hash_find(&compat_hashtab, name);
18892 if (!HASHITEM_EMPTY(hi))
18893 return &compat_hashtab;
18895 if (current_funccal == NULL)
18896 return &globvarht; /* global variable */
18897 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18899 *varname = name + 2;
18900 if (*name == 'g') /* global variable */
18901 return &globvarht;
18902 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18904 if (vim_strchr(name + 2, ':') != NULL
18905 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18906 return NULL;
18907 if (*name == 'b') /* buffer variable */
18908 return &curbuf->b_vars.dv_hashtab;
18909 if (*name == 'w') /* window variable */
18910 return &curwin->w_vars.dv_hashtab;
18911 #ifdef FEAT_WINDOWS
18912 if (*name == 't') /* tab page variable */
18913 return &curtab->tp_vars.dv_hashtab;
18914 #endif
18915 if (*name == 'v') /* v: variable */
18916 return &vimvarht;
18917 if (*name == 'a' && current_funccal != NULL) /* function argument */
18918 return &current_funccal->l_avars.dv_hashtab;
18919 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18920 return &current_funccal->l_vars.dv_hashtab;
18921 if (*name == 's' /* script variable */
18922 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18923 return &SCRIPT_VARS(current_SID);
18924 return NULL;
18928 * Get the string value of a (global/local) variable.
18929 * Returns NULL when it doesn't exist.
18931 char_u *
18932 get_var_value(name)
18933 char_u *name;
18935 dictitem_T *v;
18937 v = find_var(name, NULL);
18938 if (v == NULL)
18939 return NULL;
18940 return get_tv_string(&v->di_tv);
18944 * Allocate a new hashtab for a sourced script. It will be used while
18945 * sourcing this script and when executing functions defined in the script.
18947 void
18948 new_script_vars(id)
18949 scid_T id;
18951 int i;
18952 hashtab_T *ht;
18953 scriptvar_T *sv;
18955 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18957 /* Re-allocating ga_data means that an ht_array pointing to
18958 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18959 * at its init value. Also reset "v_dict", it's always the same. */
18960 for (i = 1; i <= ga_scripts.ga_len; ++i)
18962 ht = &SCRIPT_VARS(i);
18963 if (ht->ht_mask == HT_INIT_SIZE - 1)
18964 ht->ht_array = ht->ht_smallarray;
18965 sv = &SCRIPT_SV(i);
18966 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18969 while (ga_scripts.ga_len < id)
18971 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18972 init_var_dict(&sv->sv_dict, &sv->sv_var);
18973 ++ga_scripts.ga_len;
18979 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18980 * point to it.
18982 void
18983 init_var_dict(dict, dict_var)
18984 dict_T *dict;
18985 dictitem_T *dict_var;
18987 hash_init(&dict->dv_hashtab);
18988 dict->dv_refcount = DO_NOT_FREE_CNT;
18989 dict_var->di_tv.vval.v_dict = dict;
18990 dict_var->di_tv.v_type = VAR_DICT;
18991 dict_var->di_tv.v_lock = VAR_FIXED;
18992 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18993 dict_var->di_key[0] = NUL;
18997 * Clean up a list of internal variables.
18998 * Frees all allocated variables and the value they contain.
18999 * Clears hashtab "ht", does not free it.
19001 void
19002 vars_clear(ht)
19003 hashtab_T *ht;
19005 vars_clear_ext(ht, TRUE);
19009 * Like vars_clear(), but only free the value if "free_val" is TRUE.
19011 static void
19012 vars_clear_ext(ht, free_val)
19013 hashtab_T *ht;
19014 int free_val;
19016 int todo;
19017 hashitem_T *hi;
19018 dictitem_T *v;
19020 hash_lock(ht);
19021 todo = (int)ht->ht_used;
19022 for (hi = ht->ht_array; todo > 0; ++hi)
19024 if (!HASHITEM_EMPTY(hi))
19026 --todo;
19028 /* Free the variable. Don't remove it from the hashtab,
19029 * ht_array might change then. hash_clear() takes care of it
19030 * later. */
19031 v = HI2DI(hi);
19032 if (free_val)
19033 clear_tv(&v->di_tv);
19034 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19035 vim_free(v);
19038 hash_clear(ht);
19039 ht->ht_used = 0;
19043 * Delete a variable from hashtab "ht" at item "hi".
19044 * Clear the variable value and free the dictitem.
19046 static void
19047 delete_var(ht, hi)
19048 hashtab_T *ht;
19049 hashitem_T *hi;
19051 dictitem_T *di = HI2DI(hi);
19053 hash_remove(ht, hi);
19054 clear_tv(&di->di_tv);
19055 vim_free(di);
19059 * List the value of one internal variable.
19061 static void
19062 list_one_var(v, prefix, first)
19063 dictitem_T *v;
19064 char_u *prefix;
19065 int *first;
19067 char_u *tofree;
19068 char_u *s;
19069 char_u numbuf[NUMBUFLEN];
19071 s = echo_string(&v->di_tv, &tofree, numbuf, ++current_copyID);
19072 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19073 s == NULL ? (char_u *)"" : s, first);
19074 vim_free(tofree);
19077 static void
19078 list_one_var_a(prefix, name, type, string, first)
19079 char_u *prefix;
19080 char_u *name;
19081 int type;
19082 char_u *string;
19083 int *first; /* when TRUE clear rest of screen and set to FALSE */
19085 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19086 msg_start();
19087 msg_puts(prefix);
19088 if (name != NULL) /* "a:" vars don't have a name stored */
19089 msg_puts(name);
19090 msg_putchar(' ');
19091 msg_advance(22);
19092 if (type == VAR_NUMBER)
19093 msg_putchar('#');
19094 else if (type == VAR_FUNC)
19095 msg_putchar('*');
19096 else if (type == VAR_LIST)
19098 msg_putchar('[');
19099 if (*string == '[')
19100 ++string;
19102 else if (type == VAR_DICT)
19104 msg_putchar('{');
19105 if (*string == '{')
19106 ++string;
19108 else
19109 msg_putchar(' ');
19111 msg_outtrans(string);
19113 if (type == VAR_FUNC)
19114 msg_puts((char_u *)"()");
19115 if (*first)
19117 msg_clr_eos();
19118 *first = FALSE;
19123 * Set variable "name" to value in "tv".
19124 * If the variable already exists, the value is updated.
19125 * Otherwise the variable is created.
19127 static void
19128 set_var(name, tv, copy)
19129 char_u *name;
19130 typval_T *tv;
19131 int copy; /* make copy of value in "tv" */
19133 dictitem_T *v;
19134 char_u *varname;
19135 hashtab_T *ht;
19136 char_u *p;
19138 if (tv->v_type == VAR_FUNC)
19140 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19141 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19142 ? name[2] : name[0]))
19144 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19145 return;
19147 if (function_exists(name))
19149 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19150 name);
19151 return;
19155 ht = find_var_ht(name, &varname);
19156 if (ht == NULL || *varname == NUL)
19158 EMSG2(_(e_illvar), name);
19159 return;
19162 v = find_var_in_ht(ht, varname, TRUE);
19163 if (v != NULL)
19165 /* existing variable, need to clear the value */
19166 if (var_check_ro(v->di_flags, name)
19167 || tv_check_lock(v->di_tv.v_lock, name))
19168 return;
19169 if (v->di_tv.v_type != tv->v_type
19170 && !((v->di_tv.v_type == VAR_STRING
19171 || v->di_tv.v_type == VAR_NUMBER)
19172 && (tv->v_type == VAR_STRING
19173 || tv->v_type == VAR_NUMBER))
19174 #ifdef FEAT_FLOAT
19175 && !((v->di_tv.v_type == VAR_NUMBER
19176 || v->di_tv.v_type == VAR_FLOAT)
19177 && (tv->v_type == VAR_NUMBER
19178 || tv->v_type == VAR_FLOAT))
19179 #endif
19182 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19183 return;
19187 * Handle setting internal v: variables separately: we don't change
19188 * the type.
19190 if (ht == &vimvarht)
19192 if (v->di_tv.v_type == VAR_STRING)
19194 vim_free(v->di_tv.vval.v_string);
19195 if (copy || tv->v_type != VAR_STRING)
19196 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19197 else
19199 /* Take over the string to avoid an extra alloc/free. */
19200 v->di_tv.vval.v_string = tv->vval.v_string;
19201 tv->vval.v_string = NULL;
19204 else if (v->di_tv.v_type != VAR_NUMBER)
19205 EMSG2(_(e_intern2), "set_var()");
19206 else
19208 v->di_tv.vval.v_number = get_tv_number(tv);
19209 if (STRCMP(varname, "searchforward") == 0)
19210 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19212 return;
19215 clear_tv(&v->di_tv);
19217 else /* add a new variable */
19219 /* Can't add "v:" variable. */
19220 if (ht == &vimvarht)
19222 EMSG2(_(e_illvar), name);
19223 return;
19226 /* Make sure the variable name is valid. */
19227 for (p = varname; *p != NUL; ++p)
19228 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19229 && *p != AUTOLOAD_CHAR)
19231 EMSG2(_(e_illvar), varname);
19232 return;
19235 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19236 + STRLEN(varname)));
19237 if (v == NULL)
19238 return;
19239 STRCPY(v->di_key, varname);
19240 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19242 vim_free(v);
19243 return;
19245 v->di_flags = 0;
19248 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19249 copy_tv(tv, &v->di_tv);
19250 else
19252 v->di_tv = *tv;
19253 v->di_tv.v_lock = 0;
19254 init_tv(tv);
19259 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19260 * Also give an error message.
19262 static int
19263 var_check_ro(flags, name)
19264 int flags;
19265 char_u *name;
19267 if (flags & DI_FLAGS_RO)
19269 EMSG2(_(e_readonlyvar), name);
19270 return TRUE;
19272 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19274 EMSG2(_(e_readonlysbx), name);
19275 return TRUE;
19277 return FALSE;
19281 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19282 * Also give an error message.
19284 static int
19285 var_check_fixed(flags, name)
19286 int flags;
19287 char_u *name;
19289 if (flags & DI_FLAGS_FIX)
19291 EMSG2(_("E795: Cannot delete variable %s"), name);
19292 return TRUE;
19294 return FALSE;
19298 * Return TRUE if typeval "tv" is set to be locked (immutable).
19299 * Also give an error message, using "name".
19301 static int
19302 tv_check_lock(lock, name)
19303 int lock;
19304 char_u *name;
19306 if (lock & VAR_LOCKED)
19308 EMSG2(_("E741: Value is locked: %s"),
19309 name == NULL ? (char_u *)_("Unknown") : name);
19310 return TRUE;
19312 if (lock & VAR_FIXED)
19314 EMSG2(_("E742: Cannot change value of %s"),
19315 name == NULL ? (char_u *)_("Unknown") : name);
19316 return TRUE;
19318 return FALSE;
19322 * Copy the values from typval_T "from" to typval_T "to".
19323 * When needed allocates string or increases reference count.
19324 * Does not make a copy of a list or dict but copies the reference!
19325 * It is OK for "from" and "to" to point to the same item. This is used to
19326 * make a copy later.
19328 static void
19329 copy_tv(from, to)
19330 typval_T *from;
19331 typval_T *to;
19333 to->v_type = from->v_type;
19334 to->v_lock = 0;
19335 switch (from->v_type)
19337 case VAR_NUMBER:
19338 to->vval.v_number = from->vval.v_number;
19339 break;
19340 #ifdef FEAT_FLOAT
19341 case VAR_FLOAT:
19342 to->vval.v_float = from->vval.v_float;
19343 break;
19344 #endif
19345 case VAR_STRING:
19346 case VAR_FUNC:
19347 if (from->vval.v_string == NULL)
19348 to->vval.v_string = NULL;
19349 else
19351 to->vval.v_string = vim_strsave(from->vval.v_string);
19352 if (from->v_type == VAR_FUNC)
19353 func_ref(to->vval.v_string);
19355 break;
19356 case VAR_LIST:
19357 if (from->vval.v_list == NULL)
19358 to->vval.v_list = NULL;
19359 else
19361 to->vval.v_list = from->vval.v_list;
19362 ++to->vval.v_list->lv_refcount;
19364 break;
19365 case VAR_DICT:
19366 if (from->vval.v_dict == NULL)
19367 to->vval.v_dict = NULL;
19368 else
19370 to->vval.v_dict = from->vval.v_dict;
19371 ++to->vval.v_dict->dv_refcount;
19373 break;
19374 default:
19375 EMSG2(_(e_intern2), "copy_tv()");
19376 break;
19381 * Make a copy of an item.
19382 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19383 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19384 * reference to an already copied list/dict can be used.
19385 * Returns FAIL or OK.
19387 static int
19388 item_copy(from, to, deep, copyID)
19389 typval_T *from;
19390 typval_T *to;
19391 int deep;
19392 int copyID;
19394 static int recurse = 0;
19395 int ret = OK;
19397 if (recurse >= DICT_MAXNEST)
19399 EMSG(_("E698: variable nested too deep for making a copy"));
19400 return FAIL;
19402 ++recurse;
19404 switch (from->v_type)
19406 case VAR_NUMBER:
19407 #ifdef FEAT_FLOAT
19408 case VAR_FLOAT:
19409 #endif
19410 case VAR_STRING:
19411 case VAR_FUNC:
19412 copy_tv(from, to);
19413 break;
19414 case VAR_LIST:
19415 to->v_type = VAR_LIST;
19416 to->v_lock = 0;
19417 if (from->vval.v_list == NULL)
19418 to->vval.v_list = NULL;
19419 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19421 /* use the copy made earlier */
19422 to->vval.v_list = from->vval.v_list->lv_copylist;
19423 ++to->vval.v_list->lv_refcount;
19425 else
19426 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19427 if (to->vval.v_list == NULL)
19428 ret = FAIL;
19429 break;
19430 case VAR_DICT:
19431 to->v_type = VAR_DICT;
19432 to->v_lock = 0;
19433 if (from->vval.v_dict == NULL)
19434 to->vval.v_dict = NULL;
19435 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19437 /* use the copy made earlier */
19438 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19439 ++to->vval.v_dict->dv_refcount;
19441 else
19442 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19443 if (to->vval.v_dict == NULL)
19444 ret = FAIL;
19445 break;
19446 default:
19447 EMSG2(_(e_intern2), "item_copy()");
19448 ret = FAIL;
19450 --recurse;
19451 return ret;
19455 * ":echo expr1 ..." print each argument separated with a space, add a
19456 * newline at the end.
19457 * ":echon expr1 ..." print each argument plain.
19459 void
19460 ex_echo(eap)
19461 exarg_T *eap;
19463 char_u *arg = eap->arg;
19464 typval_T rettv;
19465 char_u *tofree;
19466 char_u *p;
19467 int needclr = TRUE;
19468 int atstart = TRUE;
19469 char_u numbuf[NUMBUFLEN];
19471 if (eap->skip)
19472 ++emsg_skip;
19473 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19475 /* If eval1() causes an error message the text from the command may
19476 * still need to be cleared. E.g., "echo 22,44". */
19477 need_clr_eos = needclr;
19479 p = arg;
19480 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19483 * Report the invalid expression unless the expression evaluation
19484 * has been cancelled due to an aborting error, an interrupt, or an
19485 * exception.
19487 if (!aborting())
19488 EMSG2(_(e_invexpr2), p);
19489 need_clr_eos = FALSE;
19490 break;
19492 need_clr_eos = FALSE;
19494 if (!eap->skip)
19496 if (atstart)
19498 atstart = FALSE;
19499 /* Call msg_start() after eval1(), evaluating the expression
19500 * may cause a message to appear. */
19501 if (eap->cmdidx == CMD_echo)
19502 msg_start();
19504 else if (eap->cmdidx == CMD_echo)
19505 msg_puts_attr((char_u *)" ", echo_attr);
19506 p = echo_string(&rettv, &tofree, numbuf, ++current_copyID);
19507 if (p != NULL)
19508 for ( ; *p != NUL && !got_int; ++p)
19510 if (*p == '\n' || *p == '\r' || *p == TAB)
19512 if (*p != TAB && needclr)
19514 /* remove any text still there from the command */
19515 msg_clr_eos();
19516 needclr = FALSE;
19518 msg_putchar_attr(*p, echo_attr);
19520 else
19522 #ifdef FEAT_MBYTE
19523 if (has_mbyte)
19525 int i = (*mb_ptr2len)(p);
19527 (void)msg_outtrans_len_attr(p, i, echo_attr);
19528 p += i - 1;
19530 else
19531 #endif
19532 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19535 vim_free(tofree);
19537 clear_tv(&rettv);
19538 arg = skipwhite(arg);
19540 eap->nextcmd = check_nextcmd(arg);
19542 if (eap->skip)
19543 --emsg_skip;
19544 else
19546 /* remove text that may still be there from the command */
19547 if (needclr)
19548 msg_clr_eos();
19549 if (eap->cmdidx == CMD_echo)
19550 msg_end();
19555 * ":echohl {name}".
19557 void
19558 ex_echohl(eap)
19559 exarg_T *eap;
19561 int id;
19563 id = syn_name2id(eap->arg);
19564 if (id == 0)
19565 echo_attr = 0;
19566 else
19567 echo_attr = syn_id2attr(id);
19571 * ":execute expr1 ..." execute the result of an expression.
19572 * ":echomsg expr1 ..." Print a message
19573 * ":echoerr expr1 ..." Print an error
19574 * Each gets spaces around each argument and a newline at the end for
19575 * echo commands
19577 void
19578 ex_execute(eap)
19579 exarg_T *eap;
19581 char_u *arg = eap->arg;
19582 typval_T rettv;
19583 int ret = OK;
19584 char_u *p;
19585 garray_T ga;
19586 int len;
19587 int save_did_emsg;
19589 ga_init2(&ga, 1, 80);
19591 if (eap->skip)
19592 ++emsg_skip;
19593 while (*arg != NUL && *arg != '|' && *arg != '\n')
19595 p = arg;
19596 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19599 * Report the invalid expression unless the expression evaluation
19600 * has been cancelled due to an aborting error, an interrupt, or an
19601 * exception.
19603 if (!aborting())
19604 EMSG2(_(e_invexpr2), p);
19605 ret = FAIL;
19606 break;
19609 if (!eap->skip)
19611 p = get_tv_string(&rettv);
19612 len = (int)STRLEN(p);
19613 if (ga_grow(&ga, len + 2) == FAIL)
19615 clear_tv(&rettv);
19616 ret = FAIL;
19617 break;
19619 if (ga.ga_len)
19620 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19621 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19622 ga.ga_len += len;
19625 clear_tv(&rettv);
19626 arg = skipwhite(arg);
19629 if (ret != FAIL && ga.ga_data != NULL)
19631 if (eap->cmdidx == CMD_echomsg)
19633 MSG_ATTR(ga.ga_data, echo_attr);
19634 out_flush();
19636 else if (eap->cmdidx == CMD_echoerr)
19638 /* We don't want to abort following commands, restore did_emsg. */
19639 save_did_emsg = did_emsg;
19640 EMSG((char_u *)ga.ga_data);
19641 if (!force_abort)
19642 did_emsg = save_did_emsg;
19644 else if (eap->cmdidx == CMD_execute)
19645 do_cmdline((char_u *)ga.ga_data,
19646 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19649 ga_clear(&ga);
19651 if (eap->skip)
19652 --emsg_skip;
19654 eap->nextcmd = check_nextcmd(arg);
19658 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19659 * "arg" points to the "&" or '+' when called, to "option" when returning.
19660 * Returns NULL when no option name found. Otherwise pointer to the char
19661 * after the option name.
19663 static char_u *
19664 find_option_end(arg, opt_flags)
19665 char_u **arg;
19666 int *opt_flags;
19668 char_u *p = *arg;
19670 ++p;
19671 if (*p == 'g' && p[1] == ':')
19673 *opt_flags = OPT_GLOBAL;
19674 p += 2;
19676 else if (*p == 'l' && p[1] == ':')
19678 *opt_flags = OPT_LOCAL;
19679 p += 2;
19681 else
19682 *opt_flags = 0;
19684 if (!ASCII_ISALPHA(*p))
19685 return NULL;
19686 *arg = p;
19688 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19689 p += 4; /* termcap option */
19690 else
19691 while (ASCII_ISALPHA(*p))
19692 ++p;
19693 return p;
19697 * ":function"
19699 void
19700 ex_function(eap)
19701 exarg_T *eap;
19703 char_u *theline;
19704 int j;
19705 int c;
19706 int saved_did_emsg;
19707 char_u *name = NULL;
19708 char_u *p;
19709 char_u *arg;
19710 char_u *line_arg = NULL;
19711 garray_T newargs;
19712 garray_T newlines;
19713 int varargs = FALSE;
19714 int mustend = FALSE;
19715 int flags = 0;
19716 ufunc_T *fp;
19717 int indent;
19718 int nesting;
19719 char_u *skip_until = NULL;
19720 dictitem_T *v;
19721 funcdict_T fudi;
19722 static int func_nr = 0; /* number for nameless function */
19723 int paren;
19724 hashtab_T *ht;
19725 int todo;
19726 hashitem_T *hi;
19727 int sourcing_lnum_off;
19730 * ":function" without argument: list functions.
19732 if (ends_excmd(*eap->arg))
19734 if (!eap->skip)
19736 todo = (int)func_hashtab.ht_used;
19737 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19739 if (!HASHITEM_EMPTY(hi))
19741 --todo;
19742 fp = HI2UF(hi);
19743 if (!isdigit(*fp->uf_name))
19744 list_func_head(fp, FALSE);
19748 eap->nextcmd = check_nextcmd(eap->arg);
19749 return;
19753 * ":function /pat": list functions matching pattern.
19755 if (*eap->arg == '/')
19757 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19758 if (!eap->skip)
19760 regmatch_T regmatch;
19762 c = *p;
19763 *p = NUL;
19764 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19765 *p = c;
19766 if (regmatch.regprog != NULL)
19768 regmatch.rm_ic = p_ic;
19770 todo = (int)func_hashtab.ht_used;
19771 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19773 if (!HASHITEM_EMPTY(hi))
19775 --todo;
19776 fp = HI2UF(hi);
19777 if (!isdigit(*fp->uf_name)
19778 && vim_regexec(&regmatch, fp->uf_name, 0))
19779 list_func_head(fp, FALSE);
19784 if (*p == '/')
19785 ++p;
19786 eap->nextcmd = check_nextcmd(p);
19787 return;
19791 * Get the function name. There are these situations:
19792 * func normal function name
19793 * "name" == func, "fudi.fd_dict" == NULL
19794 * dict.func new dictionary entry
19795 * "name" == NULL, "fudi.fd_dict" set,
19796 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19797 * dict.func existing dict entry with a Funcref
19798 * "name" == func, "fudi.fd_dict" set,
19799 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19800 * dict.func existing dict entry that's not a Funcref
19801 * "name" == NULL, "fudi.fd_dict" set,
19802 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19804 p = eap->arg;
19805 name = trans_function_name(&p, eap->skip, 0, &fudi);
19806 paren = (vim_strchr(p, '(') != NULL);
19807 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19810 * Return on an invalid expression in braces, unless the expression
19811 * evaluation has been cancelled due to an aborting error, an
19812 * interrupt, or an exception.
19814 if (!aborting())
19816 if (!eap->skip && fudi.fd_newkey != NULL)
19817 EMSG2(_(e_dictkey), fudi.fd_newkey);
19818 vim_free(fudi.fd_newkey);
19819 return;
19821 else
19822 eap->skip = TRUE;
19825 /* An error in a function call during evaluation of an expression in magic
19826 * braces should not cause the function not to be defined. */
19827 saved_did_emsg = did_emsg;
19828 did_emsg = FALSE;
19831 * ":function func" with only function name: list function.
19833 if (!paren)
19835 if (!ends_excmd(*skipwhite(p)))
19837 EMSG(_(e_trailing));
19838 goto ret_free;
19840 eap->nextcmd = check_nextcmd(p);
19841 if (eap->nextcmd != NULL)
19842 *p = NUL;
19843 if (!eap->skip && !got_int)
19845 fp = find_func(name);
19846 if (fp != NULL)
19848 list_func_head(fp, TRUE);
19849 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19851 if (FUNCLINE(fp, j) == NULL)
19852 continue;
19853 msg_putchar('\n');
19854 msg_outnum((long)(j + 1));
19855 if (j < 9)
19856 msg_putchar(' ');
19857 if (j < 99)
19858 msg_putchar(' ');
19859 msg_prt_line(FUNCLINE(fp, j), FALSE);
19860 out_flush(); /* show a line at a time */
19861 ui_breakcheck();
19863 if (!got_int)
19865 msg_putchar('\n');
19866 msg_puts((char_u *)" endfunction");
19869 else
19870 emsg_funcname("E123: Undefined function: %s", name);
19872 goto ret_free;
19876 * ":function name(arg1, arg2)" Define function.
19878 p = skipwhite(p);
19879 if (*p != '(')
19881 if (!eap->skip)
19883 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19884 goto ret_free;
19886 /* attempt to continue by skipping some text */
19887 if (vim_strchr(p, '(') != NULL)
19888 p = vim_strchr(p, '(');
19890 p = skipwhite(p + 1);
19892 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19893 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19895 if (!eap->skip)
19897 /* Check the name of the function. Unless it's a dictionary function
19898 * (that we are overwriting). */
19899 if (name != NULL)
19900 arg = name;
19901 else
19902 arg = fudi.fd_newkey;
19903 if (arg != NULL && (fudi.fd_di == NULL
19904 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19906 if (*arg == K_SPECIAL)
19907 j = 3;
19908 else
19909 j = 0;
19910 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19911 : eval_isnamec(arg[j])))
19912 ++j;
19913 if (arg[j] != NUL)
19914 emsg_funcname(_(e_invarg2), arg);
19919 * Isolate the arguments: "arg1, arg2, ...)"
19921 while (*p != ')')
19923 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19925 varargs = TRUE;
19926 p += 3;
19927 mustend = TRUE;
19929 else
19931 arg = p;
19932 while (ASCII_ISALNUM(*p) || *p == '_')
19933 ++p;
19934 if (arg == p || isdigit(*arg)
19935 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19936 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19938 if (!eap->skip)
19939 EMSG2(_("E125: Illegal argument: %s"), arg);
19940 break;
19942 if (ga_grow(&newargs, 1) == FAIL)
19943 goto erret;
19944 c = *p;
19945 *p = NUL;
19946 arg = vim_strsave(arg);
19947 if (arg == NULL)
19948 goto erret;
19949 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19950 *p = c;
19951 newargs.ga_len++;
19952 if (*p == ',')
19953 ++p;
19954 else
19955 mustend = TRUE;
19957 p = skipwhite(p);
19958 if (mustend && *p != ')')
19960 if (!eap->skip)
19961 EMSG2(_(e_invarg2), eap->arg);
19962 break;
19965 ++p; /* skip the ')' */
19967 /* find extra arguments "range", "dict" and "abort" */
19968 for (;;)
19970 p = skipwhite(p);
19971 if (STRNCMP(p, "range", 5) == 0)
19973 flags |= FC_RANGE;
19974 p += 5;
19976 else if (STRNCMP(p, "dict", 4) == 0)
19978 flags |= FC_DICT;
19979 p += 4;
19981 else if (STRNCMP(p, "abort", 5) == 0)
19983 flags |= FC_ABORT;
19984 p += 5;
19986 else
19987 break;
19990 /* When there is a line break use what follows for the function body.
19991 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19992 if (*p == '\n')
19993 line_arg = p + 1;
19994 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19995 EMSG(_(e_trailing));
19998 * Read the body of the function, until ":endfunction" is found.
20000 if (KeyTyped)
20002 /* Check if the function already exists, don't let the user type the
20003 * whole function before telling him it doesn't work! For a script we
20004 * need to skip the body to be able to find what follows. */
20005 if (!eap->skip && !eap->forceit)
20007 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
20008 EMSG(_(e_funcdict));
20009 else if (name != NULL && find_func(name) != NULL)
20010 emsg_funcname(e_funcexts, name);
20013 if (!eap->skip && did_emsg)
20014 goto erret;
20016 msg_putchar('\n'); /* don't overwrite the function name */
20017 cmdline_row = msg_row;
20020 indent = 2;
20021 nesting = 0;
20022 for (;;)
20024 msg_scroll = TRUE;
20025 need_wait_return = FALSE;
20026 sourcing_lnum_off = sourcing_lnum;
20028 if (line_arg != NULL)
20030 /* Use eap->arg, split up in parts by line breaks. */
20031 theline = line_arg;
20032 p = vim_strchr(theline, '\n');
20033 if (p == NULL)
20034 line_arg += STRLEN(line_arg);
20035 else
20037 *p = NUL;
20038 line_arg = p + 1;
20041 else if (eap->getline == NULL)
20042 theline = getcmdline(':', 0L, indent);
20043 else
20044 theline = eap->getline(':', eap->cookie, indent);
20045 if (KeyTyped)
20046 lines_left = Rows - 1;
20047 if (theline == NULL)
20049 EMSG(_("E126: Missing :endfunction"));
20050 goto erret;
20053 /* Detect line continuation: sourcing_lnum increased more than one. */
20054 if (sourcing_lnum > sourcing_lnum_off + 1)
20055 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20056 else
20057 sourcing_lnum_off = 0;
20059 if (skip_until != NULL)
20061 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20062 * don't check for ":endfunc". */
20063 if (STRCMP(theline, skip_until) == 0)
20065 vim_free(skip_until);
20066 skip_until = NULL;
20069 else
20071 /* skip ':' and blanks*/
20072 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20075 /* Check for "endfunction". */
20076 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20078 if (line_arg == NULL)
20079 vim_free(theline);
20080 break;
20083 /* Increase indent inside "if", "while", "for" and "try", decrease
20084 * at "end". */
20085 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20086 indent -= 2;
20087 else if (STRNCMP(p, "if", 2) == 0
20088 || STRNCMP(p, "wh", 2) == 0
20089 || STRNCMP(p, "for", 3) == 0
20090 || STRNCMP(p, "try", 3) == 0)
20091 indent += 2;
20093 /* Check for defining a function inside this function. */
20094 if (checkforcmd(&p, "function", 2))
20096 if (*p == '!')
20097 p = skipwhite(p + 1);
20098 p += eval_fname_script(p);
20099 if (ASCII_ISALPHA(*p))
20101 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20102 if (*skipwhite(p) == '(')
20104 ++nesting;
20105 indent += 2;
20110 /* Check for ":append" or ":insert". */
20111 p = skip_range(p, NULL);
20112 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20113 || (p[0] == 'i'
20114 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20115 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20116 skip_until = vim_strsave((char_u *)".");
20118 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20119 arg = skipwhite(skiptowhite(p));
20120 if (arg[0] == '<' && arg[1] =='<'
20121 && ((p[0] == 'p' && p[1] == 'y'
20122 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20123 || (p[0] == 'p' && p[1] == 'e'
20124 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20125 || (p[0] == 't' && p[1] == 'c'
20126 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20127 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20128 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20129 || (p[0] == 'm' && p[1] == 'z'
20130 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20133 /* ":python <<" continues until a dot, like ":append" */
20134 p = skipwhite(arg + 2);
20135 if (*p == NUL)
20136 skip_until = vim_strsave((char_u *)".");
20137 else
20138 skip_until = vim_strsave(p);
20142 /* Add the line to the function. */
20143 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20145 if (line_arg == NULL)
20146 vim_free(theline);
20147 goto erret;
20150 /* Copy the line to newly allocated memory. get_one_sourceline()
20151 * allocates 250 bytes per line, this saves 80% on average. The cost
20152 * is an extra alloc/free. */
20153 p = vim_strsave(theline);
20154 if (p != NULL)
20156 if (line_arg == NULL)
20157 vim_free(theline);
20158 theline = p;
20161 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20163 /* Add NULL lines for continuation lines, so that the line count is
20164 * equal to the index in the growarray. */
20165 while (sourcing_lnum_off-- > 0)
20166 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20168 /* Check for end of eap->arg. */
20169 if (line_arg != NULL && *line_arg == NUL)
20170 line_arg = NULL;
20173 /* Don't define the function when skipping commands or when an error was
20174 * detected. */
20175 if (eap->skip || did_emsg)
20176 goto erret;
20179 * If there are no errors, add the function
20181 if (fudi.fd_dict == NULL)
20183 v = find_var(name, &ht);
20184 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20186 emsg_funcname("E707: Function name conflicts with variable: %s",
20187 name);
20188 goto erret;
20191 fp = find_func(name);
20192 if (fp != NULL)
20194 if (!eap->forceit)
20196 emsg_funcname(e_funcexts, name);
20197 goto erret;
20199 if (fp->uf_calls > 0)
20201 emsg_funcname("E127: Cannot redefine function %s: It is in use",
20202 name);
20203 goto erret;
20205 /* redefine existing function */
20206 ga_clear_strings(&(fp->uf_args));
20207 ga_clear_strings(&(fp->uf_lines));
20208 vim_free(name);
20209 name = NULL;
20212 else
20214 char numbuf[20];
20216 fp = NULL;
20217 if (fudi.fd_newkey == NULL && !eap->forceit)
20219 EMSG(_(e_funcdict));
20220 goto erret;
20222 if (fudi.fd_di == NULL)
20224 /* Can't add a function to a locked dictionary */
20225 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20226 goto erret;
20228 /* Can't change an existing function if it is locked */
20229 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20230 goto erret;
20232 /* Give the function a sequential number. Can only be used with a
20233 * Funcref! */
20234 vim_free(name);
20235 sprintf(numbuf, "%d", ++func_nr);
20236 name = vim_strsave((char_u *)numbuf);
20237 if (name == NULL)
20238 goto erret;
20241 if (fp == NULL)
20243 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20245 int slen, plen;
20246 char_u *scriptname;
20248 /* Check that the autoload name matches the script name. */
20249 j = FAIL;
20250 if (sourcing_name != NULL)
20252 scriptname = autoload_name(name);
20253 if (scriptname != NULL)
20255 p = vim_strchr(scriptname, '/');
20256 plen = (int)STRLEN(p);
20257 slen = (int)STRLEN(sourcing_name);
20258 if (slen > plen && fnamecmp(p,
20259 sourcing_name + slen - plen) == 0)
20260 j = OK;
20261 vim_free(scriptname);
20264 if (j == FAIL)
20266 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20267 goto erret;
20271 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20272 if (fp == NULL)
20273 goto erret;
20275 if (fudi.fd_dict != NULL)
20277 if (fudi.fd_di == NULL)
20279 /* add new dict entry */
20280 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20281 if (fudi.fd_di == NULL)
20283 vim_free(fp);
20284 goto erret;
20286 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20288 vim_free(fudi.fd_di);
20289 vim_free(fp);
20290 goto erret;
20293 else
20294 /* overwrite existing dict entry */
20295 clear_tv(&fudi.fd_di->di_tv);
20296 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20297 fudi.fd_di->di_tv.v_lock = 0;
20298 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20299 fp->uf_refcount = 1;
20301 /* behave like "dict" was used */
20302 flags |= FC_DICT;
20305 /* insert the new function in the function list */
20306 STRCPY(fp->uf_name, name);
20307 hash_add(&func_hashtab, UF2HIKEY(fp));
20309 fp->uf_args = newargs;
20310 fp->uf_lines = newlines;
20311 #ifdef FEAT_PROFILE
20312 fp->uf_tml_count = NULL;
20313 fp->uf_tml_total = NULL;
20314 fp->uf_tml_self = NULL;
20315 fp->uf_profiling = FALSE;
20316 if (prof_def_func())
20317 func_do_profile(fp);
20318 #endif
20319 fp->uf_varargs = varargs;
20320 fp->uf_flags = flags;
20321 fp->uf_calls = 0;
20322 fp->uf_script_ID = current_SID;
20323 goto ret_free;
20325 erret:
20326 ga_clear_strings(&newargs);
20327 ga_clear_strings(&newlines);
20328 ret_free:
20329 vim_free(skip_until);
20330 vim_free(fudi.fd_newkey);
20331 vim_free(name);
20332 did_emsg |= saved_did_emsg;
20336 * Get a function name, translating "<SID>" and "<SNR>".
20337 * Also handles a Funcref in a List or Dictionary.
20338 * Returns the function name in allocated memory, or NULL for failure.
20339 * flags:
20340 * TFN_INT: internal function name OK
20341 * TFN_QUIET: be quiet
20342 * Advances "pp" to just after the function name (if no error).
20344 static char_u *
20345 trans_function_name(pp, skip, flags, fdp)
20346 char_u **pp;
20347 int skip; /* only find the end, don't evaluate */
20348 int flags;
20349 funcdict_T *fdp; /* return: info about dictionary used */
20351 char_u *name = NULL;
20352 char_u *start;
20353 char_u *end;
20354 int lead;
20355 char_u sid_buf[20];
20356 int len;
20357 lval_T lv;
20359 if (fdp != NULL)
20360 vim_memset(fdp, 0, sizeof(funcdict_T));
20361 start = *pp;
20363 /* Check for hard coded <SNR>: already translated function ID (from a user
20364 * command). */
20365 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20366 && (*pp)[2] == (int)KE_SNR)
20368 *pp += 3;
20369 len = get_id_len(pp) + 3;
20370 return vim_strnsave(start, len);
20373 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20374 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20375 lead = eval_fname_script(start);
20376 if (lead > 2)
20377 start += lead;
20379 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20380 lead > 2 ? 0 : FNE_CHECK_START);
20381 if (end == start)
20383 if (!skip)
20384 EMSG(_("E129: Function name required"));
20385 goto theend;
20387 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20390 * Report an invalid expression in braces, unless the expression
20391 * evaluation has been cancelled due to an aborting error, an
20392 * interrupt, or an exception.
20394 if (!aborting())
20396 if (end != NULL)
20397 EMSG2(_(e_invarg2), start);
20399 else
20400 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20401 goto theend;
20404 if (lv.ll_tv != NULL)
20406 if (fdp != NULL)
20408 fdp->fd_dict = lv.ll_dict;
20409 fdp->fd_newkey = lv.ll_newkey;
20410 lv.ll_newkey = NULL;
20411 fdp->fd_di = lv.ll_di;
20413 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20415 name = vim_strsave(lv.ll_tv->vval.v_string);
20416 *pp = end;
20418 else
20420 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20421 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20422 EMSG(_(e_funcref));
20423 else
20424 *pp = end;
20425 name = NULL;
20427 goto theend;
20430 if (lv.ll_name == NULL)
20432 /* Error found, but continue after the function name. */
20433 *pp = end;
20434 goto theend;
20437 /* Check if the name is a Funcref. If so, use the value. */
20438 if (lv.ll_exp_name != NULL)
20440 len = (int)STRLEN(lv.ll_exp_name);
20441 name = deref_func_name(lv.ll_exp_name, &len);
20442 if (name == lv.ll_exp_name)
20443 name = NULL;
20445 else
20447 len = (int)(end - *pp);
20448 name = deref_func_name(*pp, &len);
20449 if (name == *pp)
20450 name = NULL;
20452 if (name != NULL)
20454 name = vim_strsave(name);
20455 *pp = end;
20456 goto theend;
20459 if (lv.ll_exp_name != NULL)
20461 len = (int)STRLEN(lv.ll_exp_name);
20462 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20463 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20465 /* When there was "s:" already or the name expanded to get a
20466 * leading "s:" then remove it. */
20467 lv.ll_name += 2;
20468 len -= 2;
20469 lead = 2;
20472 else
20474 if (lead == 2) /* skip over "s:" */
20475 lv.ll_name += 2;
20476 len = (int)(end - lv.ll_name);
20480 * Copy the function name to allocated memory.
20481 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20482 * Accept <SNR>123_name() outside a script.
20484 if (skip)
20485 lead = 0; /* do nothing */
20486 else if (lead > 0)
20488 lead = 3;
20489 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20490 || eval_fname_sid(*pp))
20492 /* It's "s:" or "<SID>" */
20493 if (current_SID <= 0)
20495 EMSG(_(e_usingsid));
20496 goto theend;
20498 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20499 lead += (int)STRLEN(sid_buf);
20502 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20504 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20505 goto theend;
20507 name = alloc((unsigned)(len + lead + 1));
20508 if (name != NULL)
20510 if (lead > 0)
20512 name[0] = K_SPECIAL;
20513 name[1] = KS_EXTRA;
20514 name[2] = (int)KE_SNR;
20515 if (lead > 3) /* If it's "<SID>" */
20516 STRCPY(name + 3, sid_buf);
20518 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20519 name[len + lead] = NUL;
20521 *pp = end;
20523 theend:
20524 clear_lval(&lv);
20525 return name;
20529 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20530 * Return 2 if "p" starts with "s:".
20531 * Return 0 otherwise.
20533 static int
20534 eval_fname_script(p)
20535 char_u *p;
20537 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20538 || STRNICMP(p + 1, "SNR>", 4) == 0))
20539 return 5;
20540 if (p[0] == 's' && p[1] == ':')
20541 return 2;
20542 return 0;
20546 * Return TRUE if "p" starts with "<SID>" or "s:".
20547 * Only works if eval_fname_script() returned non-zero for "p"!
20549 static int
20550 eval_fname_sid(p)
20551 char_u *p;
20553 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20557 * List the head of the function: "name(arg1, arg2)".
20559 static void
20560 list_func_head(fp, indent)
20561 ufunc_T *fp;
20562 int indent;
20564 int j;
20566 msg_start();
20567 if (indent)
20568 MSG_PUTS(" ");
20569 MSG_PUTS("function ");
20570 if (fp->uf_name[0] == K_SPECIAL)
20572 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20573 msg_puts(fp->uf_name + 3);
20575 else
20576 msg_puts(fp->uf_name);
20577 msg_putchar('(');
20578 for (j = 0; j < fp->uf_args.ga_len; ++j)
20580 if (j)
20581 MSG_PUTS(", ");
20582 msg_puts(FUNCARG(fp, j));
20584 if (fp->uf_varargs)
20586 if (j)
20587 MSG_PUTS(", ");
20588 MSG_PUTS("...");
20590 msg_putchar(')');
20591 msg_clr_eos();
20592 if (p_verbose > 0)
20593 last_set_msg(fp->uf_script_ID);
20597 * Find a function by name, return pointer to it in ufuncs.
20598 * Return NULL for unknown function.
20600 static ufunc_T *
20601 find_func(name)
20602 char_u *name;
20604 hashitem_T *hi;
20606 hi = hash_find(&func_hashtab, name);
20607 if (!HASHITEM_EMPTY(hi))
20608 return HI2UF(hi);
20609 return NULL;
20612 #if defined(EXITFREE) || defined(PROTO)
20613 void
20614 free_all_functions()
20616 hashitem_T *hi;
20618 /* Need to start all over every time, because func_free() may change the
20619 * hash table. */
20620 while (func_hashtab.ht_used > 0)
20621 for (hi = func_hashtab.ht_array; ; ++hi)
20622 if (!HASHITEM_EMPTY(hi))
20624 func_free(HI2UF(hi));
20625 break;
20628 #endif
20631 * Return TRUE if a function "name" exists.
20633 static int
20634 function_exists(name)
20635 char_u *name;
20637 char_u *nm = name;
20638 char_u *p;
20639 int n = FALSE;
20641 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20642 nm = skipwhite(nm);
20644 /* Only accept "funcname", "funcname ", "funcname (..." and
20645 * "funcname(...", not "funcname!...". */
20646 if (p != NULL && (*nm == NUL || *nm == '('))
20648 if (builtin_function(p))
20649 n = (find_internal_func(p) >= 0);
20650 else
20651 n = (find_func(p) != NULL);
20653 vim_free(p);
20654 return n;
20658 * Return TRUE if "name" looks like a builtin function name: starts with a
20659 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20661 static int
20662 builtin_function(name)
20663 char_u *name;
20665 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20666 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20669 #if defined(FEAT_PROFILE) || defined(PROTO)
20671 * Start profiling function "fp".
20673 static void
20674 func_do_profile(fp)
20675 ufunc_T *fp;
20677 fp->uf_tm_count = 0;
20678 profile_zero(&fp->uf_tm_self);
20679 profile_zero(&fp->uf_tm_total);
20680 if (fp->uf_tml_count == NULL)
20681 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20682 (sizeof(int) * fp->uf_lines.ga_len));
20683 if (fp->uf_tml_total == NULL)
20684 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20685 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20686 if (fp->uf_tml_self == NULL)
20687 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20688 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20689 fp->uf_tml_idx = -1;
20690 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20691 || fp->uf_tml_self == NULL)
20692 return; /* out of memory */
20694 fp->uf_profiling = TRUE;
20698 * Dump the profiling results for all functions in file "fd".
20700 void
20701 func_dump_profile(fd)
20702 FILE *fd;
20704 hashitem_T *hi;
20705 int todo;
20706 ufunc_T *fp;
20707 int i;
20708 ufunc_T **sorttab;
20709 int st_len = 0;
20711 todo = (int)func_hashtab.ht_used;
20712 if (todo == 0)
20713 return; /* nothing to dump */
20715 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20717 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20719 if (!HASHITEM_EMPTY(hi))
20721 --todo;
20722 fp = HI2UF(hi);
20723 if (fp->uf_profiling)
20725 if (sorttab != NULL)
20726 sorttab[st_len++] = fp;
20728 if (fp->uf_name[0] == K_SPECIAL)
20729 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20730 else
20731 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20732 if (fp->uf_tm_count == 1)
20733 fprintf(fd, "Called 1 time\n");
20734 else
20735 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20736 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20737 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20738 fprintf(fd, "\n");
20739 fprintf(fd, "count total (s) self (s)\n");
20741 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20743 if (FUNCLINE(fp, i) == NULL)
20744 continue;
20745 prof_func_line(fd, fp->uf_tml_count[i],
20746 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20747 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20749 fprintf(fd, "\n");
20754 if (sorttab != NULL && st_len > 0)
20756 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20757 prof_total_cmp);
20758 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20759 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20760 prof_self_cmp);
20761 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20764 vim_free(sorttab);
20767 static void
20768 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20769 FILE *fd;
20770 ufunc_T **sorttab;
20771 int st_len;
20772 char *title;
20773 int prefer_self; /* when equal print only self time */
20775 int i;
20776 ufunc_T *fp;
20778 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20779 fprintf(fd, "count total (s) self (s) function\n");
20780 for (i = 0; i < 20 && i < st_len; ++i)
20782 fp = sorttab[i];
20783 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20784 prefer_self);
20785 if (fp->uf_name[0] == K_SPECIAL)
20786 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20787 else
20788 fprintf(fd, " %s()\n", fp->uf_name);
20790 fprintf(fd, "\n");
20794 * Print the count and times for one function or function line.
20796 static void
20797 prof_func_line(fd, count, total, self, prefer_self)
20798 FILE *fd;
20799 int count;
20800 proftime_T *total;
20801 proftime_T *self;
20802 int prefer_self; /* when equal print only self time */
20804 if (count > 0)
20806 fprintf(fd, "%5d ", count);
20807 if (prefer_self && profile_equal(total, self))
20808 fprintf(fd, " ");
20809 else
20810 fprintf(fd, "%s ", profile_msg(total));
20811 if (!prefer_self && profile_equal(total, self))
20812 fprintf(fd, " ");
20813 else
20814 fprintf(fd, "%s ", profile_msg(self));
20816 else
20817 fprintf(fd, " ");
20821 * Compare function for total time sorting.
20823 static int
20824 #ifdef __BORLANDC__
20825 _RTLENTRYF
20826 #endif
20827 prof_total_cmp(s1, s2)
20828 const void *s1;
20829 const void *s2;
20831 ufunc_T *p1, *p2;
20833 p1 = *(ufunc_T **)s1;
20834 p2 = *(ufunc_T **)s2;
20835 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20839 * Compare function for self time sorting.
20841 static int
20842 #ifdef __BORLANDC__
20843 _RTLENTRYF
20844 #endif
20845 prof_self_cmp(s1, s2)
20846 const void *s1;
20847 const void *s2;
20849 ufunc_T *p1, *p2;
20851 p1 = *(ufunc_T **)s1;
20852 p2 = *(ufunc_T **)s2;
20853 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20856 #endif
20859 * If "name" has a package name try autoloading the script for it.
20860 * Return TRUE if a package was loaded.
20862 static int
20863 script_autoload(name, reload)
20864 char_u *name;
20865 int reload; /* load script again when already loaded */
20867 char_u *p;
20868 char_u *scriptname, *tofree;
20869 int ret = FALSE;
20870 int i;
20872 /* If there is no '#' after name[0] there is no package name. */
20873 p = vim_strchr(name, AUTOLOAD_CHAR);
20874 if (p == NULL || p == name)
20875 return FALSE;
20877 tofree = scriptname = autoload_name(name);
20879 /* Find the name in the list of previously loaded package names. Skip
20880 * "autoload/", it's always the same. */
20881 for (i = 0; i < ga_loaded.ga_len; ++i)
20882 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20883 break;
20884 if (!reload && i < ga_loaded.ga_len)
20885 ret = FALSE; /* was loaded already */
20886 else
20888 /* Remember the name if it wasn't loaded already. */
20889 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20891 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20892 tofree = NULL;
20895 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20896 if (source_runtime(scriptname, FALSE) == OK)
20897 ret = TRUE;
20900 vim_free(tofree);
20901 return ret;
20905 * Return the autoload script name for a function or variable name.
20906 * Returns NULL when out of memory.
20908 static char_u *
20909 autoload_name(name)
20910 char_u *name;
20912 char_u *p;
20913 char_u *scriptname;
20915 /* Get the script file name: replace '#' with '/', append ".vim". */
20916 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20917 if (scriptname == NULL)
20918 return FALSE;
20919 STRCPY(scriptname, "autoload/");
20920 STRCAT(scriptname, name);
20921 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20922 STRCAT(scriptname, ".vim");
20923 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20924 *p = '/';
20925 return scriptname;
20928 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20931 * Function given to ExpandGeneric() to obtain the list of user defined
20932 * function names.
20934 char_u *
20935 get_user_func_name(xp, idx)
20936 expand_T *xp;
20937 int idx;
20939 static long_u done;
20940 static hashitem_T *hi;
20941 ufunc_T *fp;
20943 if (idx == 0)
20945 done = 0;
20946 hi = func_hashtab.ht_array;
20948 if (done < func_hashtab.ht_used)
20950 if (done++ > 0)
20951 ++hi;
20952 while (HASHITEM_EMPTY(hi))
20953 ++hi;
20954 fp = HI2UF(hi);
20956 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20957 return fp->uf_name; /* prevents overflow */
20959 cat_func_name(IObuff, fp);
20960 if (xp->xp_context != EXPAND_USER_FUNC)
20962 STRCAT(IObuff, "(");
20963 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20964 STRCAT(IObuff, ")");
20966 return IObuff;
20968 return NULL;
20971 #endif /* FEAT_CMDL_COMPL */
20974 * Copy the function name of "fp" to buffer "buf".
20975 * "buf" must be able to hold the function name plus three bytes.
20976 * Takes care of script-local function names.
20978 static void
20979 cat_func_name(buf, fp)
20980 char_u *buf;
20981 ufunc_T *fp;
20983 if (fp->uf_name[0] == K_SPECIAL)
20985 STRCPY(buf, "<SNR>");
20986 STRCAT(buf, fp->uf_name + 3);
20988 else
20989 STRCPY(buf, fp->uf_name);
20993 * ":delfunction {name}"
20995 void
20996 ex_delfunction(eap)
20997 exarg_T *eap;
20999 ufunc_T *fp = NULL;
21000 char_u *p;
21001 char_u *name;
21002 funcdict_T fudi;
21004 p = eap->arg;
21005 name = trans_function_name(&p, eap->skip, 0, &fudi);
21006 vim_free(fudi.fd_newkey);
21007 if (name == NULL)
21009 if (fudi.fd_dict != NULL && !eap->skip)
21010 EMSG(_(e_funcref));
21011 return;
21013 if (!ends_excmd(*skipwhite(p)))
21015 vim_free(name);
21016 EMSG(_(e_trailing));
21017 return;
21019 eap->nextcmd = check_nextcmd(p);
21020 if (eap->nextcmd != NULL)
21021 *p = NUL;
21023 if (!eap->skip)
21024 fp = find_func(name);
21025 vim_free(name);
21027 if (!eap->skip)
21029 if (fp == NULL)
21031 EMSG2(_(e_nofunc), eap->arg);
21032 return;
21034 if (fp->uf_calls > 0)
21036 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21037 return;
21040 if (fudi.fd_dict != NULL)
21042 /* Delete the dict item that refers to the function, it will
21043 * invoke func_unref() and possibly delete the function. */
21044 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21046 else
21047 func_free(fp);
21052 * Free a function and remove it from the list of functions.
21054 static void
21055 func_free(fp)
21056 ufunc_T *fp;
21058 hashitem_T *hi;
21060 /* clear this function */
21061 ga_clear_strings(&(fp->uf_args));
21062 ga_clear_strings(&(fp->uf_lines));
21063 #ifdef FEAT_PROFILE
21064 vim_free(fp->uf_tml_count);
21065 vim_free(fp->uf_tml_total);
21066 vim_free(fp->uf_tml_self);
21067 #endif
21069 /* remove the function from the function hashtable */
21070 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21071 if (HASHITEM_EMPTY(hi))
21072 EMSG2(_(e_intern2), "func_free()");
21073 else
21074 hash_remove(&func_hashtab, hi);
21076 vim_free(fp);
21080 * Unreference a Function: decrement the reference count and free it when it
21081 * becomes zero. Only for numbered functions.
21083 static void
21084 func_unref(name)
21085 char_u *name;
21087 ufunc_T *fp;
21089 if (name != NULL && isdigit(*name))
21091 fp = find_func(name);
21092 if (fp == NULL)
21093 EMSG2(_(e_intern2), "func_unref()");
21094 else if (--fp->uf_refcount <= 0)
21096 /* Only delete it when it's not being used. Otherwise it's done
21097 * when "uf_calls" becomes zero. */
21098 if (fp->uf_calls == 0)
21099 func_free(fp);
21105 * Count a reference to a Function.
21107 static void
21108 func_ref(name)
21109 char_u *name;
21111 ufunc_T *fp;
21113 if (name != NULL && isdigit(*name))
21115 fp = find_func(name);
21116 if (fp == NULL)
21117 EMSG2(_(e_intern2), "func_ref()");
21118 else
21119 ++fp->uf_refcount;
21124 * Call a user function.
21126 static void
21127 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21128 ufunc_T *fp; /* pointer to function */
21129 int argcount; /* nr of args */
21130 typval_T *argvars; /* arguments */
21131 typval_T *rettv; /* return value */
21132 linenr_T firstline; /* first line of range */
21133 linenr_T lastline; /* last line of range */
21134 dict_T *selfdict; /* Dictionary for "self" */
21136 char_u *save_sourcing_name;
21137 linenr_T save_sourcing_lnum;
21138 scid_T save_current_SID;
21139 funccall_T *fc;
21140 int save_did_emsg;
21141 static int depth = 0;
21142 dictitem_T *v;
21143 int fixvar_idx = 0; /* index in fixvar[] */
21144 int i;
21145 int ai;
21146 char_u numbuf[NUMBUFLEN];
21147 char_u *name;
21148 #ifdef FEAT_PROFILE
21149 proftime_T wait_start;
21150 proftime_T call_start;
21151 #endif
21153 /* If depth of calling is getting too high, don't execute the function */
21154 if (depth >= p_mfd)
21156 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21157 rettv->v_type = VAR_NUMBER;
21158 rettv->vval.v_number = -1;
21159 return;
21161 ++depth;
21163 line_breakcheck(); /* check for CTRL-C hit */
21165 fc = (funccall_T *)alloc(sizeof(funccall_T));
21166 fc->caller = current_funccal;
21167 current_funccal = fc;
21168 fc->func = fp;
21169 fc->rettv = rettv;
21170 rettv->vval.v_number = 0;
21171 fc->linenr = 0;
21172 fc->returned = FALSE;
21173 fc->level = ex_nesting_level;
21174 /* Check if this function has a breakpoint. */
21175 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21176 fc->dbg_tick = debug_tick;
21179 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21180 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21181 * each argument variable and saves a lot of time.
21184 * Init l: variables.
21186 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21187 if (selfdict != NULL)
21189 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21190 * some compiler that checks the destination size. */
21191 v = &fc->fixvar[fixvar_idx++].var;
21192 name = v->di_key;
21193 STRCPY(name, "self");
21194 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21195 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21196 v->di_tv.v_type = VAR_DICT;
21197 v->di_tv.v_lock = 0;
21198 v->di_tv.vval.v_dict = selfdict;
21199 ++selfdict->dv_refcount;
21203 * Init a: variables.
21204 * Set a:0 to "argcount".
21205 * Set a:000 to a list with room for the "..." arguments.
21207 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21208 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21209 (varnumber_T)(argcount - fp->uf_args.ga_len));
21210 /* Use "name" to avoid a warning from some compiler that checks the
21211 * destination size. */
21212 v = &fc->fixvar[fixvar_idx++].var;
21213 name = v->di_key;
21214 STRCPY(name, "000");
21215 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21216 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21217 v->di_tv.v_type = VAR_LIST;
21218 v->di_tv.v_lock = VAR_FIXED;
21219 v->di_tv.vval.v_list = &fc->l_varlist;
21220 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21221 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21222 fc->l_varlist.lv_lock = VAR_FIXED;
21225 * Set a:firstline to "firstline" and a:lastline to "lastline".
21226 * Set a:name to named arguments.
21227 * Set a:N to the "..." arguments.
21229 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21230 (varnumber_T)firstline);
21231 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21232 (varnumber_T)lastline);
21233 for (i = 0; i < argcount; ++i)
21235 ai = i - fp->uf_args.ga_len;
21236 if (ai < 0)
21237 /* named argument a:name */
21238 name = FUNCARG(fp, i);
21239 else
21241 /* "..." argument a:1, a:2, etc. */
21242 sprintf((char *)numbuf, "%d", ai + 1);
21243 name = numbuf;
21245 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21247 v = &fc->fixvar[fixvar_idx++].var;
21248 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21250 else
21252 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21253 + STRLEN(name)));
21254 if (v == NULL)
21255 break;
21256 v->di_flags = DI_FLAGS_RO;
21258 STRCPY(v->di_key, name);
21259 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21261 /* Note: the values are copied directly to avoid alloc/free.
21262 * "argvars" must have VAR_FIXED for v_lock. */
21263 v->di_tv = argvars[i];
21264 v->di_tv.v_lock = VAR_FIXED;
21266 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21268 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21269 fc->l_listitems[ai].li_tv = argvars[i];
21270 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21274 /* Don't redraw while executing the function. */
21275 ++RedrawingDisabled;
21276 save_sourcing_name = sourcing_name;
21277 save_sourcing_lnum = sourcing_lnum;
21278 sourcing_lnum = 1;
21279 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21280 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21281 if (sourcing_name != NULL)
21283 if (save_sourcing_name != NULL
21284 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21285 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21286 else
21287 STRCPY(sourcing_name, "function ");
21288 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21290 if (p_verbose >= 12)
21292 ++no_wait_return;
21293 verbose_enter_scroll();
21295 smsg((char_u *)_("calling %s"), sourcing_name);
21296 if (p_verbose >= 14)
21298 char_u buf[MSG_BUF_LEN];
21299 char_u numbuf2[NUMBUFLEN];
21300 char_u *tofree;
21301 char_u *s;
21303 msg_puts((char_u *)"(");
21304 for (i = 0; i < argcount; ++i)
21306 if (i > 0)
21307 msg_puts((char_u *)", ");
21308 if (argvars[i].v_type == VAR_NUMBER)
21309 msg_outnum((long)argvars[i].vval.v_number);
21310 else
21312 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21313 if (s != NULL)
21315 trunc_string(s, buf, MSG_BUF_CLEN);
21316 msg_puts(buf);
21317 vim_free(tofree);
21321 msg_puts((char_u *)")");
21323 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21325 verbose_leave_scroll();
21326 --no_wait_return;
21329 #ifdef FEAT_PROFILE
21330 if (do_profiling == PROF_YES)
21332 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21333 func_do_profile(fp);
21334 if (fp->uf_profiling
21335 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21337 ++fp->uf_tm_count;
21338 profile_start(&call_start);
21339 profile_zero(&fp->uf_tm_children);
21341 script_prof_save(&wait_start);
21343 #endif
21345 save_current_SID = current_SID;
21346 current_SID = fp->uf_script_ID;
21347 save_did_emsg = did_emsg;
21348 did_emsg = FALSE;
21350 /* call do_cmdline() to execute the lines */
21351 do_cmdline(NULL, get_func_line, (void *)fc,
21352 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21354 --RedrawingDisabled;
21356 /* when the function was aborted because of an error, return -1 */
21357 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21359 clear_tv(rettv);
21360 rettv->v_type = VAR_NUMBER;
21361 rettv->vval.v_number = -1;
21364 #ifdef FEAT_PROFILE
21365 if (do_profiling == PROF_YES && (fp->uf_profiling
21366 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21368 profile_end(&call_start);
21369 profile_sub_wait(&wait_start, &call_start);
21370 profile_add(&fp->uf_tm_total, &call_start);
21371 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21372 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21374 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21375 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21378 #endif
21380 /* when being verbose, mention the return value */
21381 if (p_verbose >= 12)
21383 ++no_wait_return;
21384 verbose_enter_scroll();
21386 if (aborting())
21387 smsg((char_u *)_("%s aborted"), sourcing_name);
21388 else if (fc->rettv->v_type == VAR_NUMBER)
21389 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21390 (long)fc->rettv->vval.v_number);
21391 else
21393 char_u buf[MSG_BUF_LEN];
21394 char_u numbuf2[NUMBUFLEN];
21395 char_u *tofree;
21396 char_u *s;
21398 /* The value may be very long. Skip the middle part, so that we
21399 * have some idea how it starts and ends. smsg() would always
21400 * truncate it at the end. */
21401 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21402 if (s != NULL)
21404 trunc_string(s, buf, MSG_BUF_CLEN);
21405 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21406 vim_free(tofree);
21409 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21411 verbose_leave_scroll();
21412 --no_wait_return;
21415 vim_free(sourcing_name);
21416 sourcing_name = save_sourcing_name;
21417 sourcing_lnum = save_sourcing_lnum;
21418 current_SID = save_current_SID;
21419 #ifdef FEAT_PROFILE
21420 if (do_profiling == PROF_YES)
21421 script_prof_restore(&wait_start);
21422 #endif
21424 if (p_verbose >= 12 && sourcing_name != NULL)
21426 ++no_wait_return;
21427 verbose_enter_scroll();
21429 smsg((char_u *)_("continuing in %s"), sourcing_name);
21430 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21432 verbose_leave_scroll();
21433 --no_wait_return;
21436 did_emsg |= save_did_emsg;
21437 current_funccal = fc->caller;
21438 --depth;
21440 /* if the a:000 list and the a: dict are not referenced we can free the
21441 * funccall_T and what's in it. */
21442 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21443 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21444 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21446 free_funccal(fc, FALSE);
21448 else
21450 hashitem_T *hi;
21451 listitem_T *li;
21452 int todo;
21454 /* "fc" is still in use. This can happen when returning "a:000" or
21455 * assigning "l:" to a global variable.
21456 * Link "fc" in the list for garbage collection later. */
21457 fc->caller = previous_funccal;
21458 previous_funccal = fc;
21460 /* Make a copy of the a: variables, since we didn't do that above. */
21461 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21462 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21464 if (!HASHITEM_EMPTY(hi))
21466 --todo;
21467 v = HI2DI(hi);
21468 copy_tv(&v->di_tv, &v->di_tv);
21472 /* Make a copy of the a:000 items, since we didn't do that above. */
21473 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21474 copy_tv(&li->li_tv, &li->li_tv);
21479 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21480 * referenced from anywyere.
21482 static int
21483 can_free_funccal(fc, copyID)
21484 funccall_T *fc;
21485 int copyID;
21487 return (fc->l_varlist.lv_copyID != copyID
21488 && fc->l_vars.dv_copyID != copyID
21489 && fc->l_avars.dv_copyID != copyID);
21493 * Free "fc" and what it contains.
21495 static void
21496 free_funccal(fc, free_val)
21497 funccall_T *fc;
21498 int free_val; /* a: vars were allocated */
21500 listitem_T *li;
21502 /* The a: variables typevals may not have been allocated, only free the
21503 * allocated variables. */
21504 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21506 /* free all l: variables */
21507 vars_clear(&fc->l_vars.dv_hashtab);
21509 /* Free the a:000 variables if they were allocated. */
21510 if (free_val)
21511 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21512 clear_tv(&li->li_tv);
21514 vim_free(fc);
21518 * Add a number variable "name" to dict "dp" with value "nr".
21520 static void
21521 add_nr_var(dp, v, name, nr)
21522 dict_T *dp;
21523 dictitem_T *v;
21524 char *name;
21525 varnumber_T nr;
21527 STRCPY(v->di_key, name);
21528 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21529 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21530 v->di_tv.v_type = VAR_NUMBER;
21531 v->di_tv.v_lock = VAR_FIXED;
21532 v->di_tv.vval.v_number = nr;
21536 * ":return [expr]"
21538 void
21539 ex_return(eap)
21540 exarg_T *eap;
21542 char_u *arg = eap->arg;
21543 typval_T rettv;
21544 int returning = FALSE;
21546 if (current_funccal == NULL)
21548 EMSG(_("E133: :return not inside a function"));
21549 return;
21552 if (eap->skip)
21553 ++emsg_skip;
21555 eap->nextcmd = NULL;
21556 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21557 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21559 if (!eap->skip)
21560 returning = do_return(eap, FALSE, TRUE, &rettv);
21561 else
21562 clear_tv(&rettv);
21564 /* It's safer to return also on error. */
21565 else if (!eap->skip)
21568 * Return unless the expression evaluation has been cancelled due to an
21569 * aborting error, an interrupt, or an exception.
21571 if (!aborting())
21572 returning = do_return(eap, FALSE, TRUE, NULL);
21575 /* When skipping or the return gets pending, advance to the next command
21576 * in this line (!returning). Otherwise, ignore the rest of the line.
21577 * Following lines will be ignored by get_func_line(). */
21578 if (returning)
21579 eap->nextcmd = NULL;
21580 else if (eap->nextcmd == NULL) /* no argument */
21581 eap->nextcmd = check_nextcmd(arg);
21583 if (eap->skip)
21584 --emsg_skip;
21588 * Return from a function. Possibly makes the return pending. Also called
21589 * for a pending return at the ":endtry" or after returning from an extra
21590 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21591 * when called due to a ":return" command. "rettv" may point to a typval_T
21592 * with the return rettv. Returns TRUE when the return can be carried out,
21593 * FALSE when the return gets pending.
21596 do_return(eap, reanimate, is_cmd, rettv)
21597 exarg_T *eap;
21598 int reanimate;
21599 int is_cmd;
21600 void *rettv;
21602 int idx;
21603 struct condstack *cstack = eap->cstack;
21605 if (reanimate)
21606 /* Undo the return. */
21607 current_funccal->returned = FALSE;
21610 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21611 * not in its finally clause (which then is to be executed next) is found.
21612 * In this case, make the ":return" pending for execution at the ":endtry".
21613 * Otherwise, return normally.
21615 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21616 if (idx >= 0)
21618 cstack->cs_pending[idx] = CSTP_RETURN;
21620 if (!is_cmd && !reanimate)
21621 /* A pending return again gets pending. "rettv" points to an
21622 * allocated variable with the rettv of the original ":return"'s
21623 * argument if present or is NULL else. */
21624 cstack->cs_rettv[idx] = rettv;
21625 else
21627 /* When undoing a return in order to make it pending, get the stored
21628 * return rettv. */
21629 if (reanimate)
21630 rettv = current_funccal->rettv;
21632 if (rettv != NULL)
21634 /* Store the value of the pending return. */
21635 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21636 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21637 else
21638 EMSG(_(e_outofmem));
21640 else
21641 cstack->cs_rettv[idx] = NULL;
21643 if (reanimate)
21645 /* The pending return value could be overwritten by a ":return"
21646 * without argument in a finally clause; reset the default
21647 * return value. */
21648 current_funccal->rettv->v_type = VAR_NUMBER;
21649 current_funccal->rettv->vval.v_number = 0;
21652 report_make_pending(CSTP_RETURN, rettv);
21654 else
21656 current_funccal->returned = TRUE;
21658 /* If the return is carried out now, store the return value. For
21659 * a return immediately after reanimation, the value is already
21660 * there. */
21661 if (!reanimate && rettv != NULL)
21663 clear_tv(current_funccal->rettv);
21664 *current_funccal->rettv = *(typval_T *)rettv;
21665 if (!is_cmd)
21666 vim_free(rettv);
21670 return idx < 0;
21674 * Free the variable with a pending return value.
21676 void
21677 discard_pending_return(rettv)
21678 void *rettv;
21680 free_tv((typval_T *)rettv);
21684 * Generate a return command for producing the value of "rettv". The result
21685 * is an allocated string. Used by report_pending() for verbose messages.
21687 char_u *
21688 get_return_cmd(rettv)
21689 void *rettv;
21691 char_u *s = NULL;
21692 char_u *tofree = NULL;
21693 char_u numbuf[NUMBUFLEN];
21695 if (rettv != NULL)
21696 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21697 if (s == NULL)
21698 s = (char_u *)"";
21700 STRCPY(IObuff, ":return ");
21701 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21702 if (STRLEN(s) + 8 >= IOSIZE)
21703 STRCPY(IObuff + IOSIZE - 4, "...");
21704 vim_free(tofree);
21705 return vim_strsave(IObuff);
21709 * Get next function line.
21710 * Called by do_cmdline() to get the next line.
21711 * Returns allocated string, or NULL for end of function.
21713 /* ARGSUSED */
21714 char_u *
21715 get_func_line(c, cookie, indent)
21716 int c; /* not used */
21717 void *cookie;
21718 int indent; /* not used */
21720 funccall_T *fcp = (funccall_T *)cookie;
21721 ufunc_T *fp = fcp->func;
21722 char_u *retval;
21723 garray_T *gap; /* growarray with function lines */
21725 /* If breakpoints have been added/deleted need to check for it. */
21726 if (fcp->dbg_tick != debug_tick)
21728 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21729 sourcing_lnum);
21730 fcp->dbg_tick = debug_tick;
21732 #ifdef FEAT_PROFILE
21733 if (do_profiling == PROF_YES)
21734 func_line_end(cookie);
21735 #endif
21737 gap = &fp->uf_lines;
21738 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21739 || fcp->returned)
21740 retval = NULL;
21741 else
21743 /* Skip NULL lines (continuation lines). */
21744 while (fcp->linenr < gap->ga_len
21745 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21746 ++fcp->linenr;
21747 if (fcp->linenr >= gap->ga_len)
21748 retval = NULL;
21749 else
21751 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21752 sourcing_lnum = fcp->linenr;
21753 #ifdef FEAT_PROFILE
21754 if (do_profiling == PROF_YES)
21755 func_line_start(cookie);
21756 #endif
21760 /* Did we encounter a breakpoint? */
21761 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21763 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21764 /* Find next breakpoint. */
21765 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21766 sourcing_lnum);
21767 fcp->dbg_tick = debug_tick;
21770 return retval;
21773 #if defined(FEAT_PROFILE) || defined(PROTO)
21775 * Called when starting to read a function line.
21776 * "sourcing_lnum" must be correct!
21777 * When skipping lines it may not actually be executed, but we won't find out
21778 * until later and we need to store the time now.
21780 void
21781 func_line_start(cookie)
21782 void *cookie;
21784 funccall_T *fcp = (funccall_T *)cookie;
21785 ufunc_T *fp = fcp->func;
21787 if (fp->uf_profiling && sourcing_lnum >= 1
21788 && sourcing_lnum <= fp->uf_lines.ga_len)
21790 fp->uf_tml_idx = sourcing_lnum - 1;
21791 /* Skip continuation lines. */
21792 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21793 --fp->uf_tml_idx;
21794 fp->uf_tml_execed = FALSE;
21795 profile_start(&fp->uf_tml_start);
21796 profile_zero(&fp->uf_tml_children);
21797 profile_get_wait(&fp->uf_tml_wait);
21802 * Called when actually executing a function line.
21804 void
21805 func_line_exec(cookie)
21806 void *cookie;
21808 funccall_T *fcp = (funccall_T *)cookie;
21809 ufunc_T *fp = fcp->func;
21811 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21812 fp->uf_tml_execed = TRUE;
21816 * Called when done with a function line.
21818 void
21819 func_line_end(cookie)
21820 void *cookie;
21822 funccall_T *fcp = (funccall_T *)cookie;
21823 ufunc_T *fp = fcp->func;
21825 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21827 if (fp->uf_tml_execed)
21829 ++fp->uf_tml_count[fp->uf_tml_idx];
21830 profile_end(&fp->uf_tml_start);
21831 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21832 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21833 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21834 &fp->uf_tml_children);
21836 fp->uf_tml_idx = -1;
21839 #endif
21842 * Return TRUE if the currently active function should be ended, because a
21843 * return was encountered or an error occurred. Used inside a ":while".
21846 func_has_ended(cookie)
21847 void *cookie;
21849 funccall_T *fcp = (funccall_T *)cookie;
21851 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21852 * an error inside a try conditional. */
21853 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21854 || fcp->returned);
21858 * return TRUE if cookie indicates a function which "abort"s on errors.
21861 func_has_abort(cookie)
21862 void *cookie;
21864 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21867 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21868 typedef enum
21870 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21871 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21872 VAR_FLAVOUR_VIMINFO /* all uppercase */
21873 } var_flavour_T;
21875 static var_flavour_T var_flavour __ARGS((char_u *varname));
21877 static var_flavour_T
21878 var_flavour(varname)
21879 char_u *varname;
21881 char_u *p = varname;
21883 if (ASCII_ISUPPER(*p))
21885 while (*(++p))
21886 if (ASCII_ISLOWER(*p))
21887 return VAR_FLAVOUR_SESSION;
21888 return VAR_FLAVOUR_VIMINFO;
21890 else
21891 return VAR_FLAVOUR_DEFAULT;
21893 #endif
21895 #if defined(FEAT_VIMINFO) || defined(PROTO)
21897 * Restore global vars that start with a capital from the viminfo file
21900 read_viminfo_varlist(virp, writing)
21901 vir_T *virp;
21902 int writing;
21904 char_u *tab;
21905 int type = VAR_NUMBER;
21906 typval_T tv;
21908 if (!writing && (find_viminfo_parameter('!') != NULL))
21910 tab = vim_strchr(virp->vir_line + 1, '\t');
21911 if (tab != NULL)
21913 *tab++ = '\0'; /* isolate the variable name */
21914 if (*tab == 'S') /* string var */
21915 type = VAR_STRING;
21916 #ifdef FEAT_FLOAT
21917 else if (*tab == 'F')
21918 type = VAR_FLOAT;
21919 #endif
21921 tab = vim_strchr(tab, '\t');
21922 if (tab != NULL)
21924 tv.v_type = type;
21925 if (type == VAR_STRING)
21926 tv.vval.v_string = viminfo_readstring(virp,
21927 (int)(tab - virp->vir_line + 1), TRUE);
21928 #ifdef FEAT_FLOAT
21929 else if (type == VAR_FLOAT)
21930 (void)string2float(tab + 1, &tv.vval.v_float);
21931 #endif
21932 else
21933 tv.vval.v_number = atol((char *)tab + 1);
21934 set_var(virp->vir_line + 1, &tv, FALSE);
21935 if (type == VAR_STRING)
21936 vim_free(tv.vval.v_string);
21941 return viminfo_readline(virp);
21945 * Write global vars that start with a capital to the viminfo file
21947 void
21948 write_viminfo_varlist(fp)
21949 FILE *fp;
21951 hashitem_T *hi;
21952 dictitem_T *this_var;
21953 int todo;
21954 char *s;
21955 char_u *p;
21956 char_u *tofree;
21957 char_u numbuf[NUMBUFLEN];
21959 if (find_viminfo_parameter('!') == NULL)
21960 return;
21962 fprintf(fp, _("\n# global variables:\n"));
21964 todo = (int)globvarht.ht_used;
21965 for (hi = globvarht.ht_array; todo > 0; ++hi)
21967 if (!HASHITEM_EMPTY(hi))
21969 --todo;
21970 this_var = HI2DI(hi);
21971 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21973 switch (this_var->di_tv.v_type)
21975 case VAR_STRING: s = "STR"; break;
21976 case VAR_NUMBER: s = "NUM"; break;
21977 #ifdef FEAT_FLOAT
21978 case VAR_FLOAT: s = "FLO"; break;
21979 #endif
21980 default: continue;
21982 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21983 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21984 if (p != NULL)
21985 viminfo_writestring(fp, p);
21986 vim_free(tofree);
21991 #endif
21993 #if defined(FEAT_SESSION) || defined(PROTO)
21995 store_session_globals(fd)
21996 FILE *fd;
21998 hashitem_T *hi;
21999 dictitem_T *this_var;
22000 int todo;
22001 char_u *p, *t;
22003 todo = (int)globvarht.ht_used;
22004 for (hi = globvarht.ht_array; todo > 0; ++hi)
22006 if (!HASHITEM_EMPTY(hi))
22008 --todo;
22009 this_var = HI2DI(hi);
22010 if ((this_var->di_tv.v_type == VAR_NUMBER
22011 || this_var->di_tv.v_type == VAR_STRING)
22012 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22014 /* Escape special characters with a backslash. Turn a LF and
22015 * CR into \n and \r. */
22016 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
22017 (char_u *)"\\\"\n\r");
22018 if (p == NULL) /* out of memory */
22019 break;
22020 for (t = p; *t != NUL; ++t)
22021 if (*t == '\n')
22022 *t = 'n';
22023 else if (*t == '\r')
22024 *t = 'r';
22025 if ((fprintf(fd, "let %s = %c%s%c",
22026 this_var->di_key,
22027 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22028 : ' ',
22030 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22031 : ' ') < 0)
22032 || put_eol(fd) == FAIL)
22034 vim_free(p);
22035 return FAIL;
22037 vim_free(p);
22039 #ifdef FEAT_FLOAT
22040 else if (this_var->di_tv.v_type == VAR_FLOAT
22041 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22043 float_T f = this_var->di_tv.vval.v_float;
22044 int sign = ' ';
22046 if (f < 0)
22048 f = -f;
22049 sign = '-';
22051 if ((fprintf(fd, "let %s = %c&%f",
22052 this_var->di_key, sign, f) < 0)
22053 || put_eol(fd) == FAIL)
22054 return FAIL;
22056 #endif
22059 return OK;
22061 #endif
22064 * Display script name where an item was last set.
22065 * Should only be invoked when 'verbose' is non-zero.
22067 void
22068 last_set_msg(scriptID)
22069 scid_T scriptID;
22071 char_u *p;
22073 if (scriptID != 0)
22075 p = home_replace_save(NULL, get_scriptname(scriptID));
22076 if (p != NULL)
22078 verbose_enter();
22079 MSG_PUTS(_("\n\tLast set from "));
22080 MSG_PUTS(p);
22081 vim_free(p);
22082 verbose_leave();
22088 * List v:oldfiles in a nice way.
22090 /*ARGSUSED*/
22091 void
22092 ex_oldfiles(eap)
22093 exarg_T *eap;
22095 list_T *l = vimvars[VV_OLDFILES].vv_list;
22096 listitem_T *li;
22097 int nr = 0;
22099 if (l == NULL)
22100 msg((char_u *)_("No old files"));
22101 else
22103 msg_start();
22104 msg_scroll = TRUE;
22105 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22107 msg_outnum((long)++nr);
22108 MSG_PUTS(": ");
22109 msg_outtrans(get_tv_string(&li->li_tv));
22110 msg_putchar('\n');
22111 out_flush(); /* output one line at a time */
22112 ui_breakcheck();
22114 /* Assume "got_int" was set to truncate the listing. */
22115 got_int = FALSE;
22117 #ifdef FEAT_BROWSE_CMD
22118 if (cmdmod.browse)
22120 quit_more = FALSE;
22121 nr = prompt_for_number(FALSE);
22122 msg_starthere();
22123 if (nr > 0)
22125 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22126 (long)nr);
22128 if (p != NULL)
22130 p = expand_env_save(p);
22131 eap->arg = p;
22132 eap->cmdidx = CMD_edit;
22133 cmdmod.browse = FALSE;
22134 do_exedit(eap, NULL);
22135 vim_free(p);
22139 #endif
22143 #endif /* FEAT_EVAL */
22146 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22148 #ifdef WIN3264
22150 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22152 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22153 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22154 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22157 * Get the short path (8.3) for the filename in "fnamep".
22158 * Only works for a valid file name.
22159 * When the path gets longer "fnamep" is changed and the allocated buffer
22160 * is put in "bufp".
22161 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22162 * Returns OK on success, FAIL on failure.
22164 static int
22165 get_short_pathname(fnamep, bufp, fnamelen)
22166 char_u **fnamep;
22167 char_u **bufp;
22168 int *fnamelen;
22170 int l, len;
22171 char_u *newbuf;
22173 len = *fnamelen;
22174 l = GetShortPathName(*fnamep, *fnamep, len);
22175 if (l > len - 1)
22177 /* If that doesn't work (not enough space), then save the string
22178 * and try again with a new buffer big enough. */
22179 newbuf = vim_strnsave(*fnamep, l);
22180 if (newbuf == NULL)
22181 return FAIL;
22183 vim_free(*bufp);
22184 *fnamep = *bufp = newbuf;
22186 /* Really should always succeed, as the buffer is big enough. */
22187 l = GetShortPathName(*fnamep, *fnamep, l+1);
22190 *fnamelen = l;
22191 return OK;
22195 * Get the short path (8.3) for the filename in "fname". The converted
22196 * path is returned in "bufp".
22198 * Some of the directories specified in "fname" may not exist. This function
22199 * will shorten the existing directories at the beginning of the path and then
22200 * append the remaining non-existing path.
22202 * fname - Pointer to the filename to shorten. On return, contains the
22203 * pointer to the shortened pathname
22204 * bufp - Pointer to an allocated buffer for the filename.
22205 * fnamelen - Length of the filename pointed to by fname
22207 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22209 static int
22210 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22211 char_u **fname;
22212 char_u **bufp;
22213 int *fnamelen;
22215 char_u *short_fname, *save_fname, *pbuf_unused;
22216 char_u *endp, *save_endp;
22217 char_u ch;
22218 int old_len, len;
22219 int new_len, sfx_len;
22220 int retval = OK;
22222 /* Make a copy */
22223 old_len = *fnamelen;
22224 save_fname = vim_strnsave(*fname, old_len);
22225 pbuf_unused = NULL;
22226 short_fname = NULL;
22228 endp = save_fname + old_len - 1; /* Find the end of the copy */
22229 save_endp = endp;
22232 * Try shortening the supplied path till it succeeds by removing one
22233 * directory at a time from the tail of the path.
22235 len = 0;
22236 for (;;)
22238 /* go back one path-separator */
22239 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22240 --endp;
22241 if (endp <= save_fname)
22242 break; /* processed the complete path */
22245 * Replace the path separator with a NUL and try to shorten the
22246 * resulting path.
22248 ch = *endp;
22249 *endp = 0;
22250 short_fname = save_fname;
22251 len = (int)STRLEN(short_fname) + 1;
22252 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22254 retval = FAIL;
22255 goto theend;
22257 *endp = ch; /* preserve the string */
22259 if (len > 0)
22260 break; /* successfully shortened the path */
22262 /* failed to shorten the path. Skip the path separator */
22263 --endp;
22266 if (len > 0)
22269 * Succeeded in shortening the path. Now concatenate the shortened
22270 * path with the remaining path at the tail.
22273 /* Compute the length of the new path. */
22274 sfx_len = (int)(save_endp - endp) + 1;
22275 new_len = len + sfx_len;
22277 *fnamelen = new_len;
22278 vim_free(*bufp);
22279 if (new_len > old_len)
22281 /* There is not enough space in the currently allocated string,
22282 * copy it to a buffer big enough. */
22283 *fname = *bufp = vim_strnsave(short_fname, new_len);
22284 if (*fname == NULL)
22286 retval = FAIL;
22287 goto theend;
22290 else
22292 /* Transfer short_fname to the main buffer (it's big enough),
22293 * unless get_short_pathname() did its work in-place. */
22294 *fname = *bufp = save_fname;
22295 if (short_fname != save_fname)
22296 vim_strncpy(save_fname, short_fname, len);
22297 save_fname = NULL;
22300 /* concat the not-shortened part of the path */
22301 vim_strncpy(*fname + len, endp, sfx_len);
22302 (*fname)[new_len] = NUL;
22305 theend:
22306 vim_free(pbuf_unused);
22307 vim_free(save_fname);
22309 return retval;
22313 * Get a pathname for a partial path.
22314 * Returns OK for success, FAIL for failure.
22316 static int
22317 shortpath_for_partial(fnamep, bufp, fnamelen)
22318 char_u **fnamep;
22319 char_u **bufp;
22320 int *fnamelen;
22322 int sepcount, len, tflen;
22323 char_u *p;
22324 char_u *pbuf, *tfname;
22325 int hasTilde;
22327 /* Count up the path separators from the RHS.. so we know which part
22328 * of the path to return. */
22329 sepcount = 0;
22330 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22331 if (vim_ispathsep(*p))
22332 ++sepcount;
22334 /* Need full path first (use expand_env() to remove a "~/") */
22335 hasTilde = (**fnamep == '~');
22336 if (hasTilde)
22337 pbuf = tfname = expand_env_save(*fnamep);
22338 else
22339 pbuf = tfname = FullName_save(*fnamep, FALSE);
22341 len = tflen = (int)STRLEN(tfname);
22343 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22344 return FAIL;
22346 if (len == 0)
22348 /* Don't have a valid filename, so shorten the rest of the
22349 * path if we can. This CAN give us invalid 8.3 filenames, but
22350 * there's not a lot of point in guessing what it might be.
22352 len = tflen;
22353 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22354 return FAIL;
22357 /* Count the paths backward to find the beginning of the desired string. */
22358 for (p = tfname + len - 1; p >= tfname; --p)
22360 #ifdef FEAT_MBYTE
22361 if (has_mbyte)
22362 p -= mb_head_off(tfname, p);
22363 #endif
22364 if (vim_ispathsep(*p))
22366 if (sepcount == 0 || (hasTilde && sepcount == 1))
22367 break;
22368 else
22369 sepcount --;
22372 if (hasTilde)
22374 --p;
22375 if (p >= tfname)
22376 *p = '~';
22377 else
22378 return FAIL;
22380 else
22381 ++p;
22383 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22384 vim_free(*bufp);
22385 *fnamelen = (int)STRLEN(p);
22386 *bufp = pbuf;
22387 *fnamep = p;
22389 return OK;
22391 #endif /* WIN3264 */
22394 * Adjust a filename, according to a string of modifiers.
22395 * *fnamep must be NUL terminated when called. When returning, the length is
22396 * determined by *fnamelen.
22397 * Returns VALID_ flags or -1 for failure.
22398 * When there is an error, *fnamep is set to NULL.
22401 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22402 char_u *src; /* string with modifiers */
22403 int *usedlen; /* characters after src that are used */
22404 char_u **fnamep; /* file name so far */
22405 char_u **bufp; /* buffer for allocated file name or NULL */
22406 int *fnamelen; /* length of fnamep */
22408 int valid = 0;
22409 char_u *tail;
22410 char_u *s, *p, *pbuf;
22411 char_u dirname[MAXPATHL];
22412 int c;
22413 int has_fullname = 0;
22414 #ifdef WIN3264
22415 int has_shortname = 0;
22416 #endif
22418 repeat:
22419 /* ":p" - full path/file_name */
22420 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22422 has_fullname = 1;
22424 valid |= VALID_PATH;
22425 *usedlen += 2;
22427 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22428 if ((*fnamep)[0] == '~'
22429 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22430 && ((*fnamep)[1] == '/'
22431 # ifdef BACKSLASH_IN_FILENAME
22432 || (*fnamep)[1] == '\\'
22433 # endif
22434 || (*fnamep)[1] == NUL)
22436 #endif
22439 *fnamep = expand_env_save(*fnamep);
22440 vim_free(*bufp); /* free any allocated file name */
22441 *bufp = *fnamep;
22442 if (*fnamep == NULL)
22443 return -1;
22446 /* When "/." or "/.." is used: force expansion to get rid of it. */
22447 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22449 if (vim_ispathsep(*p)
22450 && p[1] == '.'
22451 && (p[2] == NUL
22452 || vim_ispathsep(p[2])
22453 || (p[2] == '.'
22454 && (p[3] == NUL || vim_ispathsep(p[3])))))
22455 break;
22458 /* FullName_save() is slow, don't use it when not needed. */
22459 if (*p != NUL || !vim_isAbsName(*fnamep))
22461 *fnamep = FullName_save(*fnamep, *p != NUL);
22462 vim_free(*bufp); /* free any allocated file name */
22463 *bufp = *fnamep;
22464 if (*fnamep == NULL)
22465 return -1;
22468 /* Append a path separator to a directory. */
22469 if (mch_isdir(*fnamep))
22471 /* Make room for one or two extra characters. */
22472 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22473 vim_free(*bufp); /* free any allocated file name */
22474 *bufp = *fnamep;
22475 if (*fnamep == NULL)
22476 return -1;
22477 add_pathsep(*fnamep);
22481 /* ":." - path relative to the current directory */
22482 /* ":~" - path relative to the home directory */
22483 /* ":8" - shortname path - postponed till after */
22484 while (src[*usedlen] == ':'
22485 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22487 *usedlen += 2;
22488 if (c == '8')
22490 #ifdef WIN3264
22491 has_shortname = 1; /* Postpone this. */
22492 #endif
22493 continue;
22495 pbuf = NULL;
22496 /* Need full path first (use expand_env() to remove a "~/") */
22497 if (!has_fullname)
22499 if (c == '.' && **fnamep == '~')
22500 p = pbuf = expand_env_save(*fnamep);
22501 else
22502 p = pbuf = FullName_save(*fnamep, FALSE);
22504 else
22505 p = *fnamep;
22507 has_fullname = 0;
22509 if (p != NULL)
22511 if (c == '.')
22513 mch_dirname(dirname, MAXPATHL);
22514 s = shorten_fname(p, dirname);
22515 if (s != NULL)
22517 *fnamep = s;
22518 if (pbuf != NULL)
22520 vim_free(*bufp); /* free any allocated file name */
22521 *bufp = pbuf;
22522 pbuf = NULL;
22526 else
22528 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22529 /* Only replace it when it starts with '~' */
22530 if (*dirname == '~')
22532 s = vim_strsave(dirname);
22533 if (s != NULL)
22535 *fnamep = s;
22536 vim_free(*bufp);
22537 *bufp = s;
22541 vim_free(pbuf);
22545 tail = gettail(*fnamep);
22546 *fnamelen = (int)STRLEN(*fnamep);
22548 /* ":h" - head, remove "/file_name", can be repeated */
22549 /* Don't remove the first "/" or "c:\" */
22550 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22552 valid |= VALID_HEAD;
22553 *usedlen += 2;
22554 s = get_past_head(*fnamep);
22555 while (tail > s && after_pathsep(s, tail))
22556 mb_ptr_back(*fnamep, tail);
22557 *fnamelen = (int)(tail - *fnamep);
22558 #ifdef VMS
22559 if (*fnamelen > 0)
22560 *fnamelen += 1; /* the path separator is part of the path */
22561 #endif
22562 if (*fnamelen == 0)
22564 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22565 p = vim_strsave((char_u *)".");
22566 if (p == NULL)
22567 return -1;
22568 vim_free(*bufp);
22569 *bufp = *fnamep = tail = p;
22570 *fnamelen = 1;
22572 else
22574 while (tail > s && !after_pathsep(s, tail))
22575 mb_ptr_back(*fnamep, tail);
22579 /* ":8" - shortname */
22580 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22582 *usedlen += 2;
22583 #ifdef WIN3264
22584 has_shortname = 1;
22585 #endif
22588 #ifdef WIN3264
22589 /* Check shortname after we have done 'heads' and before we do 'tails'
22591 if (has_shortname)
22593 pbuf = NULL;
22594 /* Copy the string if it is shortened by :h */
22595 if (*fnamelen < (int)STRLEN(*fnamep))
22597 p = vim_strnsave(*fnamep, *fnamelen);
22598 if (p == 0)
22599 return -1;
22600 vim_free(*bufp);
22601 *bufp = *fnamep = p;
22604 /* Split into two implementations - makes it easier. First is where
22605 * there isn't a full name already, second is where there is.
22607 if (!has_fullname && !vim_isAbsName(*fnamep))
22609 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22610 return -1;
22612 else
22614 int l;
22616 /* Simple case, already have the full-name
22617 * Nearly always shorter, so try first time. */
22618 l = *fnamelen;
22619 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22620 return -1;
22622 if (l == 0)
22624 /* Couldn't find the filename.. search the paths.
22626 l = *fnamelen;
22627 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22628 return -1;
22630 *fnamelen = l;
22633 #endif /* WIN3264 */
22635 /* ":t" - tail, just the basename */
22636 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22638 *usedlen += 2;
22639 *fnamelen -= (int)(tail - *fnamep);
22640 *fnamep = tail;
22643 /* ":e" - extension, can be repeated */
22644 /* ":r" - root, without extension, can be repeated */
22645 while (src[*usedlen] == ':'
22646 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22648 /* find a '.' in the tail:
22649 * - for second :e: before the current fname
22650 * - otherwise: The last '.'
22652 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22653 s = *fnamep - 2;
22654 else
22655 s = *fnamep + *fnamelen - 1;
22656 for ( ; s > tail; --s)
22657 if (s[0] == '.')
22658 break;
22659 if (src[*usedlen + 1] == 'e') /* :e */
22661 if (s > tail)
22663 *fnamelen += (int)(*fnamep - (s + 1));
22664 *fnamep = s + 1;
22665 #ifdef VMS
22666 /* cut version from the extension */
22667 s = *fnamep + *fnamelen - 1;
22668 for ( ; s > *fnamep; --s)
22669 if (s[0] == ';')
22670 break;
22671 if (s > *fnamep)
22672 *fnamelen = s - *fnamep;
22673 #endif
22675 else if (*fnamep <= tail)
22676 *fnamelen = 0;
22678 else /* :r */
22680 if (s > tail) /* remove one extension */
22681 *fnamelen = (int)(s - *fnamep);
22683 *usedlen += 2;
22686 /* ":s?pat?foo?" - substitute */
22687 /* ":gs?pat?foo?" - global substitute */
22688 if (src[*usedlen] == ':'
22689 && (src[*usedlen + 1] == 's'
22690 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22692 char_u *str;
22693 char_u *pat;
22694 char_u *sub;
22695 int sep;
22696 char_u *flags;
22697 int didit = FALSE;
22699 flags = (char_u *)"";
22700 s = src + *usedlen + 2;
22701 if (src[*usedlen + 1] == 'g')
22703 flags = (char_u *)"g";
22704 ++s;
22707 sep = *s++;
22708 if (sep)
22710 /* find end of pattern */
22711 p = vim_strchr(s, sep);
22712 if (p != NULL)
22714 pat = vim_strnsave(s, (int)(p - s));
22715 if (pat != NULL)
22717 s = p + 1;
22718 /* find end of substitution */
22719 p = vim_strchr(s, sep);
22720 if (p != NULL)
22722 sub = vim_strnsave(s, (int)(p - s));
22723 str = vim_strnsave(*fnamep, *fnamelen);
22724 if (sub != NULL && str != NULL)
22726 *usedlen = (int)(p + 1 - src);
22727 s = do_string_sub(str, pat, sub, flags);
22728 if (s != NULL)
22730 *fnamep = s;
22731 *fnamelen = (int)STRLEN(s);
22732 vim_free(*bufp);
22733 *bufp = s;
22734 didit = TRUE;
22737 vim_free(sub);
22738 vim_free(str);
22740 vim_free(pat);
22743 /* after using ":s", repeat all the modifiers */
22744 if (didit)
22745 goto repeat;
22749 return valid;
22753 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22754 * "flags" can be "g" to do a global substitute.
22755 * Returns an allocated string, NULL for error.
22757 char_u *
22758 do_string_sub(str, pat, sub, flags)
22759 char_u *str;
22760 char_u *pat;
22761 char_u *sub;
22762 char_u *flags;
22764 int sublen;
22765 regmatch_T regmatch;
22766 int i;
22767 int do_all;
22768 char_u *tail;
22769 garray_T ga;
22770 char_u *ret;
22771 char_u *save_cpo;
22773 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22774 save_cpo = p_cpo;
22775 p_cpo = empty_option;
22777 ga_init2(&ga, 1, 200);
22779 do_all = (flags[0] == 'g');
22781 regmatch.rm_ic = p_ic;
22782 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22783 if (regmatch.regprog != NULL)
22785 tail = str;
22786 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22789 * Get some space for a temporary buffer to do the substitution
22790 * into. It will contain:
22791 * - The text up to where the match is.
22792 * - The substituted text.
22793 * - The text after the match.
22795 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22796 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22797 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22799 ga_clear(&ga);
22800 break;
22803 /* copy the text up to where the match is */
22804 i = (int)(regmatch.startp[0] - tail);
22805 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22806 /* add the substituted text */
22807 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22808 + ga.ga_len + i, TRUE, TRUE, FALSE);
22809 ga.ga_len += i + sublen - 1;
22810 /* avoid getting stuck on a match with an empty string */
22811 if (tail == regmatch.endp[0])
22813 if (*tail == NUL)
22814 break;
22815 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22816 ++ga.ga_len;
22818 else
22820 tail = regmatch.endp[0];
22821 if (*tail == NUL)
22822 break;
22824 if (!do_all)
22825 break;
22828 if (ga.ga_data != NULL)
22829 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22831 vim_free(regmatch.regprog);
22834 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22835 ga_clear(&ga);
22836 if (p_cpo == empty_option)
22837 p_cpo = save_cpo;
22838 else
22839 /* Darn, evaluating {sub} expression changed the value. */
22840 free_string_option(save_cpo);
22842 return ret;
22845 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */