Merge branch 'vim' (version 7.2)
[MacVim.git] / src / eval.c
blob5d073c70672df9e2c746ca8568bf0b03026f8c76
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 */
36 * In a hashtab item "hi_key" points to "di_key" in a dictitem.
37 * This avoids adding a pointer to the hashtab item.
38 * DI2HIKEY() converts a dictitem pointer to a hashitem key pointer.
39 * HIKEY2DI() converts a hashitem key pointer to a dictitem pointer.
40 * HI2DI() converts a hashitem pointer to a dictitem pointer.
42 static dictitem_T dumdi;
43 #define DI2HIKEY(di) ((di)->di_key)
44 #define HIKEY2DI(p) ((dictitem_T *)(p - (dumdi.di_key - (char_u *)&dumdi)))
45 #define HI2DI(hi) HIKEY2DI((hi)->hi_key)
48 * Structure returned by get_lval() and used by set_var_lval().
49 * For a plain name:
50 * "name" points to the variable name.
51 * "exp_name" is NULL.
52 * "tv" is NULL
53 * For a magic braces name:
54 * "name" points to the expanded variable name.
55 * "exp_name" is non-NULL, to be freed later.
56 * "tv" is NULL
57 * For an index in a list:
58 * "name" points to the (expanded) variable name.
59 * "exp_name" NULL or non-NULL, to be freed later.
60 * "tv" points to the (first) list item value
61 * "li" points to the (first) list item
62 * "range", "n1", "n2" and "empty2" indicate what items are used.
63 * For an existing Dict item:
64 * "name" points to the (expanded) variable name.
65 * "exp_name" NULL or non-NULL, to be freed later.
66 * "tv" points to the dict item value
67 * "newkey" is NULL
68 * For a non-existing Dict item:
69 * "name" points to the (expanded) variable name.
70 * "exp_name" NULL or non-NULL, to be freed later.
71 * "tv" points to the Dictionary typval_T
72 * "newkey" is the key for the new item.
74 typedef struct lval_S
76 char_u *ll_name; /* start of variable name (can be NULL) */
77 char_u *ll_exp_name; /* NULL or expanded name in allocated memory. */
78 typval_T *ll_tv; /* Typeval of item being used. If "newkey"
79 isn't NULL it's the Dict to which to add
80 the item. */
81 listitem_T *ll_li; /* The list item or NULL. */
82 list_T *ll_list; /* The list or NULL. */
83 int ll_range; /* TRUE when a [i:j] range was used */
84 long ll_n1; /* First index for list */
85 long ll_n2; /* Second index for list range */
86 int ll_empty2; /* Second index is empty: [i:] */
87 dict_T *ll_dict; /* The Dictionary or NULL */
88 dictitem_T *ll_di; /* The dictitem or NULL */
89 char_u *ll_newkey; /* New key for Dict in alloc. mem or NULL. */
90 } lval_T;
93 static char *e_letunexp = N_("E18: Unexpected characters in :let");
94 static char *e_listidx = N_("E684: list index out of range: %ld");
95 static char *e_undefvar = N_("E121: Undefined variable: %s");
96 static char *e_missbrac = N_("E111: Missing ']'");
97 static char *e_listarg = N_("E686: Argument of %s must be a List");
98 static char *e_listdictarg = N_("E712: Argument of %s must be a List or Dictionary");
99 static char *e_emptykey = N_("E713: Cannot use empty key for Dictionary");
100 static char *e_listreq = N_("E714: List required");
101 static char *e_dictreq = N_("E715: Dictionary required");
102 static char *e_toomanyarg = N_("E118: Too many arguments for function: %s");
103 static char *e_dictkey = N_("E716: Key not present in Dictionary: %s");
104 static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
105 static char *e_funcdict = N_("E717: Dictionary entry already exists");
106 static char *e_funcref = N_("E718: Funcref required");
107 static char *e_dictrange = N_("E719: Cannot use [:] with a Dictionary");
108 static char *e_letwrong = N_("E734: Wrong variable type for %s=");
109 static char *e_nofunc = N_("E130: Unknown function: %s");
110 static char *e_illvar = N_("E461: Illegal variable name: %s");
113 * All user-defined global variables are stored in dictionary "globvardict".
114 * "globvars_var" is the variable that is used for "g:".
116 static dict_T globvardict;
117 static dictitem_T globvars_var;
118 #define globvarht globvardict.dv_hashtab
121 * Old Vim variables such as "v:version" are also available without the "v:".
122 * Also in functions. We need a special hashtable for them.
124 static hashtab_T compat_hashtab;
127 * When recursively copying lists and dicts we need to remember which ones we
128 * have done to avoid endless recursiveness. This unique ID is used for that.
130 static int current_copyID = 0;
133 * Array to hold the hashtab with variables local to each sourced script.
134 * Each item holds a variable (nameless) that points to the dict_T.
136 typedef struct
138 dictitem_T sv_var;
139 dict_T sv_dict;
140 } scriptvar_T;
142 static garray_T ga_scripts = {0, 0, sizeof(scriptvar_T), 4, NULL};
143 #define SCRIPT_SV(id) (((scriptvar_T *)ga_scripts.ga_data)[(id) - 1])
144 #define SCRIPT_VARS(id) (SCRIPT_SV(id).sv_dict.dv_hashtab)
146 static int echo_attr = 0; /* attributes used for ":echo" */
148 /* Values for trans_function_name() argument: */
149 #define TFN_INT 1 /* internal function name OK */
150 #define TFN_QUIET 2 /* no error messages */
153 * Structure to hold info for a user function.
155 typedef struct ufunc ufunc_T;
157 struct ufunc
159 int uf_varargs; /* variable nr of arguments */
160 int uf_flags;
161 int uf_calls; /* nr of active calls */
162 garray_T uf_args; /* arguments */
163 garray_T uf_lines; /* function lines */
164 #ifdef FEAT_PROFILE
165 int uf_profiling; /* TRUE when func is being profiled */
166 /* profiling the function as a whole */
167 int uf_tm_count; /* nr of calls */
168 proftime_T uf_tm_total; /* time spent in function + children */
169 proftime_T uf_tm_self; /* time spent in function itself */
170 proftime_T uf_tm_children; /* time spent in children this call */
171 /* profiling the function per line */
172 int *uf_tml_count; /* nr of times line was executed */
173 proftime_T *uf_tml_total; /* time spent in a line + children */
174 proftime_T *uf_tml_self; /* time spent in a line itself */
175 proftime_T uf_tml_start; /* start time for current line */
176 proftime_T uf_tml_children; /* time spent in children for this line */
177 proftime_T uf_tml_wait; /* start wait time for current line */
178 int uf_tml_idx; /* index of line being timed; -1 if none */
179 int uf_tml_execed; /* line being timed was executed */
180 #endif
181 scid_T uf_script_ID; /* ID of script where function was defined,
182 used for s: variables */
183 int uf_refcount; /* for numbered function: reference count */
184 char_u uf_name[1]; /* name of function (actually longer); can
185 start with <SNR>123_ (<SNR> is K_SPECIAL
186 KS_EXTRA KE_SNR) */
189 /* function flags */
190 #define FC_ABORT 1 /* abort function on error */
191 #define FC_RANGE 2 /* function accepts range */
192 #define FC_DICT 4 /* Dict function, uses "self" */
195 * All user-defined functions are found in this hashtable.
197 static hashtab_T func_hashtab;
199 /* The names of packages that once were loaded are remembered. */
200 static garray_T ga_loaded = {0, 0, sizeof(char_u *), 4, NULL};
202 /* list heads for garbage collection */
203 static dict_T *first_dict = NULL; /* list of all dicts */
204 static list_T *first_list = NULL; /* list of all lists */
206 /* From user function to hashitem and back. */
207 static ufunc_T dumuf;
208 #define UF2HIKEY(fp) ((fp)->uf_name)
209 #define HIKEY2UF(p) ((ufunc_T *)(p - (dumuf.uf_name - (char_u *)&dumuf)))
210 #define HI2UF(hi) HIKEY2UF((hi)->hi_key)
212 #define FUNCARG(fp, j) ((char_u **)(fp->uf_args.ga_data))[j]
213 #define FUNCLINE(fp, j) ((char_u **)(fp->uf_lines.ga_data))[j]
215 #define MAX_FUNC_ARGS 20 /* maximum number of function arguments */
216 #define VAR_SHORT_LEN 20 /* short variable name length */
217 #define FIXVAR_CNT 12 /* number of fixed variables */
219 /* structure to hold info for a function that is currently being executed. */
220 typedef struct funccall_S funccall_T;
222 struct funccall_S
224 ufunc_T *func; /* function being called */
225 int linenr; /* next line to be executed */
226 int returned; /* ":return" used */
227 struct /* fixed variables for arguments */
229 dictitem_T var; /* variable (without room for name) */
230 char_u room[VAR_SHORT_LEN]; /* room for the name */
231 } fixvar[FIXVAR_CNT];
232 dict_T l_vars; /* l: local function variables */
233 dictitem_T l_vars_var; /* variable for l: scope */
234 dict_T l_avars; /* a: argument variables */
235 dictitem_T l_avars_var; /* variable for a: scope */
236 list_T l_varlist; /* list for a:000 */
237 listitem_T l_listitems[MAX_FUNC_ARGS]; /* listitems for a:000 */
238 typval_T *rettv; /* return value */
239 linenr_T breakpoint; /* next line with breakpoint or zero */
240 int dbg_tick; /* debug_tick when breakpoint was set */
241 int level; /* top nesting level of executed function */
242 #ifdef FEAT_PROFILE
243 proftime_T prof_child; /* time spent in a child */
244 #endif
245 funccall_T *caller; /* calling function or NULL */
249 * Info used by a ":for" loop.
251 typedef struct
253 int fi_semicolon; /* TRUE if ending in '; var]' */
254 int fi_varcount; /* nr of variables in the list */
255 listwatch_T fi_lw; /* keep an eye on the item used. */
256 list_T *fi_list; /* list being used */
257 } forinfo_T;
260 * Struct used by trans_function_name()
262 typedef struct
264 dict_T *fd_dict; /* Dictionary used */
265 char_u *fd_newkey; /* new key in "dict" in allocated memory */
266 dictitem_T *fd_di; /* Dictionary item used */
267 } funcdict_T;
271 * Array to hold the value of v: variables.
272 * The value is in a dictitem, so that it can also be used in the v: scope.
273 * The reason to use this table anyway is for very quick access to the
274 * variables with the VV_ defines.
276 #include "version.h"
278 /* values for vv_flags: */
279 #define VV_COMPAT 1 /* compatible, also used without "v:" */
280 #define VV_RO 2 /* read-only */
281 #define VV_RO_SBX 4 /* read-only in the sandbox */
283 #define VV_NAME(s, t) s, {{t}}, {0}
285 static struct vimvar
287 char *vv_name; /* name of variable, without v: */
288 dictitem_T vv_di; /* value and name for key */
289 char vv_filler[16]; /* space for LONGEST name below!!! */
290 char vv_flags; /* VV_COMPAT, VV_RO, VV_RO_SBX */
291 } vimvars[VV_LEN] =
294 * The order here must match the VV_ defines in vim.h!
295 * Initializing a union does not work, leave tv.vval empty to get zero's.
297 {VV_NAME("count", VAR_NUMBER), VV_COMPAT+VV_RO},
298 {VV_NAME("count1", VAR_NUMBER), VV_RO},
299 {VV_NAME("prevcount", VAR_NUMBER), VV_RO},
300 {VV_NAME("errmsg", VAR_STRING), VV_COMPAT},
301 {VV_NAME("warningmsg", VAR_STRING), 0},
302 {VV_NAME("statusmsg", VAR_STRING), 0},
303 {VV_NAME("shell_error", VAR_NUMBER), VV_COMPAT+VV_RO},
304 {VV_NAME("this_session", VAR_STRING), VV_COMPAT},
305 {VV_NAME("version", VAR_NUMBER), VV_COMPAT+VV_RO},
306 {VV_NAME("lnum", VAR_NUMBER), VV_RO_SBX},
307 {VV_NAME("termresponse", VAR_STRING), VV_RO},
308 {VV_NAME("fname", VAR_STRING), VV_RO},
309 {VV_NAME("lang", VAR_STRING), VV_RO},
310 {VV_NAME("lc_time", VAR_STRING), VV_RO},
311 {VV_NAME("ctype", VAR_STRING), VV_RO},
312 {VV_NAME("charconvert_from", VAR_STRING), VV_RO},
313 {VV_NAME("charconvert_to", VAR_STRING), VV_RO},
314 {VV_NAME("fname_in", VAR_STRING), VV_RO},
315 {VV_NAME("fname_out", VAR_STRING), VV_RO},
316 {VV_NAME("fname_new", VAR_STRING), VV_RO},
317 {VV_NAME("fname_diff", VAR_STRING), VV_RO},
318 {VV_NAME("cmdarg", VAR_STRING), VV_RO},
319 {VV_NAME("foldstart", VAR_NUMBER), VV_RO_SBX},
320 {VV_NAME("foldend", VAR_NUMBER), VV_RO_SBX},
321 {VV_NAME("folddashes", VAR_STRING), VV_RO_SBX},
322 {VV_NAME("foldlevel", VAR_NUMBER), VV_RO_SBX},
323 {VV_NAME("progname", VAR_STRING), VV_RO},
324 {VV_NAME("servername", VAR_STRING), VV_RO},
325 {VV_NAME("dying", VAR_NUMBER), VV_RO},
326 {VV_NAME("exception", VAR_STRING), VV_RO},
327 {VV_NAME("throwpoint", VAR_STRING), VV_RO},
328 {VV_NAME("register", VAR_STRING), VV_RO},
329 {VV_NAME("cmdbang", VAR_NUMBER), VV_RO},
330 {VV_NAME("insertmode", VAR_STRING), VV_RO},
331 {VV_NAME("val", VAR_UNKNOWN), VV_RO},
332 {VV_NAME("key", VAR_UNKNOWN), VV_RO},
333 {VV_NAME("profiling", VAR_NUMBER), VV_RO},
334 {VV_NAME("fcs_reason", VAR_STRING), VV_RO},
335 {VV_NAME("fcs_choice", VAR_STRING), 0},
336 {VV_NAME("beval_bufnr", VAR_NUMBER), VV_RO},
337 {VV_NAME("beval_winnr", VAR_NUMBER), VV_RO},
338 {VV_NAME("beval_lnum", VAR_NUMBER), VV_RO},
339 {VV_NAME("beval_col", VAR_NUMBER), VV_RO},
340 {VV_NAME("beval_text", VAR_STRING), VV_RO},
341 {VV_NAME("scrollstart", VAR_STRING), 0},
342 {VV_NAME("swapname", VAR_STRING), VV_RO},
343 {VV_NAME("swapchoice", VAR_STRING), 0},
344 {VV_NAME("swapcommand", VAR_STRING), VV_RO},
345 {VV_NAME("char", VAR_STRING), VV_RO},
346 {VV_NAME("mouse_win", VAR_NUMBER), 0},
347 {VV_NAME("mouse_lnum", VAR_NUMBER), 0},
348 {VV_NAME("mouse_col", VAR_NUMBER), 0},
349 {VV_NAME("operator", VAR_STRING), VV_RO},
350 {VV_NAME("searchforward", VAR_NUMBER), 0},
353 /* shorthand */
354 #define vv_type vv_di.di_tv.v_type
355 #define vv_nr vv_di.di_tv.vval.v_number
356 #define vv_float vv_di.di_tv.vval.v_float
357 #define vv_str vv_di.di_tv.vval.v_string
358 #define vv_tv vv_di.di_tv
361 * The v: variables are stored in dictionary "vimvardict".
362 * "vimvars_var" is the variable that is used for the "l:" scope.
364 static dict_T vimvardict;
365 static dictitem_T vimvars_var;
366 #define vimvarht vimvardict.dv_hashtab
368 static void prepare_vimvar __ARGS((int idx, typval_T *save_tv));
369 static void restore_vimvar __ARGS((int idx, typval_T *save_tv));
370 #if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
371 static int call_vim_function __ARGS((char_u *func, int argc, char_u **argv, int safe, typval_T *rettv));
372 #endif
373 static int ex_let_vars __ARGS((char_u *arg, typval_T *tv, int copy, int semicolon, int var_count, char_u *nextchars));
374 static char_u *skip_var_list __ARGS((char_u *arg, int *var_count, int *semicolon));
375 static char_u *skip_var_one __ARGS((char_u *arg));
376 static void list_hashtable_vars __ARGS((hashtab_T *ht, char_u *prefix, int empty, int *first));
377 static void list_glob_vars __ARGS((int *first));
378 static void list_buf_vars __ARGS((int *first));
379 static void list_win_vars __ARGS((int *first));
380 #ifdef FEAT_WINDOWS
381 static void list_tab_vars __ARGS((int *first));
382 #endif
383 static void list_vim_vars __ARGS((int *first));
384 static void list_script_vars __ARGS((int *first));
385 static void list_func_vars __ARGS((int *first));
386 static char_u *list_arg_vars __ARGS((exarg_T *eap, char_u *arg, int *first));
387 static char_u *ex_let_one __ARGS((char_u *arg, typval_T *tv, int copy, char_u *endchars, char_u *op));
388 static int check_changedtick __ARGS((char_u *arg));
389 static char_u *get_lval __ARGS((char_u *name, typval_T *rettv, lval_T *lp, int unlet, int skip, int quiet, int fne_flags));
390 static void clear_lval __ARGS((lval_T *lp));
391 static void set_var_lval __ARGS((lval_T *lp, char_u *endp, typval_T *rettv, int copy, char_u *op));
392 static int tv_op __ARGS((typval_T *tv1, typval_T *tv2, char_u *op));
393 static void list_add_watch __ARGS((list_T *l, listwatch_T *lw));
394 static void list_rem_watch __ARGS((list_T *l, listwatch_T *lwrem));
395 static void list_fix_watch __ARGS((list_T *l, listitem_T *item));
396 static void ex_unletlock __ARGS((exarg_T *eap, char_u *argstart, int deep));
397 static int do_unlet_var __ARGS((lval_T *lp, char_u *name_end, int forceit));
398 static int do_lock_var __ARGS((lval_T *lp, char_u *name_end, int deep, int lock));
399 static void item_lock __ARGS((typval_T *tv, int deep, int lock));
400 static int tv_islocked __ARGS((typval_T *tv));
402 static int eval0 __ARGS((char_u *arg, typval_T *rettv, char_u **nextcmd, int evaluate));
403 static int eval1 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
404 static int eval2 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
405 static int eval3 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
406 static int eval4 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
407 static int eval5 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
408 static int eval6 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
409 static int eval7 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
411 static int eval_index __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
412 static int get_option_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
413 static int get_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
414 static int get_lit_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
415 static int get_list_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
416 static int rettv_list_alloc __ARGS((typval_T *rettv));
417 static listitem_T *listitem_alloc __ARGS((void));
418 static void listitem_free __ARGS((listitem_T *item));
419 static void listitem_remove __ARGS((list_T *l, listitem_T *item));
420 static long list_len __ARGS((list_T *l));
421 static int list_equal __ARGS((list_T *l1, list_T *l2, int ic));
422 static int dict_equal __ARGS((dict_T *d1, dict_T *d2, int ic));
423 static int tv_equal __ARGS((typval_T *tv1, typval_T *tv2, int ic));
424 static listitem_T *list_find __ARGS((list_T *l, long n));
425 static long list_find_nr __ARGS((list_T *l, long idx, int *errorp));
426 static long list_idx_of_item __ARGS((list_T *l, listitem_T *item));
427 static void list_append __ARGS((list_T *l, listitem_T *item));
428 static int list_append_tv __ARGS((list_T *l, typval_T *tv));
429 static int list_append_string __ARGS((list_T *l, char_u *str, int len));
430 static int list_append_number __ARGS((list_T *l, varnumber_T n));
431 static int list_insert_tv __ARGS((list_T *l, typval_T *tv, listitem_T *item));
432 static int list_extend __ARGS((list_T *l1, list_T *l2, listitem_T *bef));
433 static int list_concat __ARGS((list_T *l1, list_T *l2, typval_T *tv));
434 static list_T *list_copy __ARGS((list_T *orig, int deep, int copyID));
435 static void list_remove __ARGS((list_T *l, listitem_T *item, listitem_T *item2));
436 static char_u *list2string __ARGS((typval_T *tv, int copyID));
437 static int list_join __ARGS((garray_T *gap, list_T *l, char_u *sep, int echo, int copyID));
438 static void set_ref_in_ht __ARGS((hashtab_T *ht, int copyID));
439 static void set_ref_in_list __ARGS((list_T *l, int copyID));
440 static void set_ref_in_item __ARGS((typval_T *tv, int copyID));
441 static void dict_unref __ARGS((dict_T *d));
442 static void dict_free __ARGS((dict_T *d, int recurse));
443 static dictitem_T *dictitem_alloc __ARGS((char_u *key));
444 static dictitem_T *dictitem_copy __ARGS((dictitem_T *org));
445 static void dictitem_remove __ARGS((dict_T *dict, dictitem_T *item));
446 static void dictitem_free __ARGS((dictitem_T *item));
447 static dict_T *dict_copy __ARGS((dict_T *orig, int deep, int copyID));
448 static int dict_add __ARGS((dict_T *d, dictitem_T *item));
449 static long dict_len __ARGS((dict_T *d));
450 static dictitem_T *dict_find __ARGS((dict_T *d, char_u *key, int len));
451 static char_u *dict2string __ARGS((typval_T *tv, int copyID));
452 static int get_dict_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
453 static char_u *echo_string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
454 static char_u *tv2string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
455 static char_u *string_quote __ARGS((char_u *str, int function));
456 #ifdef FEAT_FLOAT
457 static int string2float __ARGS((char_u *text, float_T *value));
458 #endif
459 static int get_env_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
460 static int find_internal_func __ARGS((char_u *name));
461 static char_u *deref_func_name __ARGS((char_u *name, int *lenp));
462 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));
463 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));
464 static void emsg_funcname __ARGS((char *ermsg, char_u *name));
465 static int non_zero_arg __ARGS((typval_T *argvars));
467 #ifdef FEAT_FLOAT
468 static void f_abs __ARGS((typval_T *argvars, typval_T *rettv));
469 #endif
470 static void f_add __ARGS((typval_T *argvars, typval_T *rettv));
471 static void f_append __ARGS((typval_T *argvars, typval_T *rettv));
472 static void f_argc __ARGS((typval_T *argvars, typval_T *rettv));
473 static void f_argidx __ARGS((typval_T *argvars, typval_T *rettv));
474 static void f_argv __ARGS((typval_T *argvars, typval_T *rettv));
475 #ifdef FEAT_FLOAT
476 static void f_atan __ARGS((typval_T *argvars, typval_T *rettv));
477 #endif
478 static void f_browse __ARGS((typval_T *argvars, typval_T *rettv));
479 static void f_browsedir __ARGS((typval_T *argvars, typval_T *rettv));
480 static void f_bufexists __ARGS((typval_T *argvars, typval_T *rettv));
481 static void f_buflisted __ARGS((typval_T *argvars, typval_T *rettv));
482 static void f_bufloaded __ARGS((typval_T *argvars, typval_T *rettv));
483 static void f_bufname __ARGS((typval_T *argvars, typval_T *rettv));
484 static void f_bufnr __ARGS((typval_T *argvars, typval_T *rettv));
485 static void f_bufwinnr __ARGS((typval_T *argvars, typval_T *rettv));
486 static void f_byte2line __ARGS((typval_T *argvars, typval_T *rettv));
487 static void f_byteidx __ARGS((typval_T *argvars, typval_T *rettv));
488 static void f_call __ARGS((typval_T *argvars, typval_T *rettv));
489 #ifdef FEAT_FLOAT
490 static void f_ceil __ARGS((typval_T *argvars, typval_T *rettv));
491 #endif
492 static void f_changenr __ARGS((typval_T *argvars, typval_T *rettv));
493 static void f_char2nr __ARGS((typval_T *argvars, typval_T *rettv));
494 static void f_cindent __ARGS((typval_T *argvars, typval_T *rettv));
495 static void f_clearmatches __ARGS((typval_T *argvars, typval_T *rettv));
496 static void f_col __ARGS((typval_T *argvars, typval_T *rettv));
497 #if defined(FEAT_INS_EXPAND)
498 static void f_complete __ARGS((typval_T *argvars, typval_T *rettv));
499 static void f_complete_add __ARGS((typval_T *argvars, typval_T *rettv));
500 static void f_complete_check __ARGS((typval_T *argvars, typval_T *rettv));
501 #endif
502 static void f_confirm __ARGS((typval_T *argvars, typval_T *rettv));
503 static void f_copy __ARGS((typval_T *argvars, typval_T *rettv));
504 #ifdef FEAT_FLOAT
505 static void f_cos __ARGS((typval_T *argvars, typval_T *rettv));
506 #endif
507 static void f_count __ARGS((typval_T *argvars, typval_T *rettv));
508 static void f_cscope_connection __ARGS((typval_T *argvars, typval_T *rettv));
509 static void f_cursor __ARGS((typval_T *argsvars, typval_T *rettv));
510 static void f_deepcopy __ARGS((typval_T *argvars, typval_T *rettv));
511 static void f_delete __ARGS((typval_T *argvars, typval_T *rettv));
512 static void f_did_filetype __ARGS((typval_T *argvars, typval_T *rettv));
513 static void f_diff_filler __ARGS((typval_T *argvars, typval_T *rettv));
514 static void f_diff_hlID __ARGS((typval_T *argvars, typval_T *rettv));
515 static void f_empty __ARGS((typval_T *argvars, typval_T *rettv));
516 static void f_escape __ARGS((typval_T *argvars, typval_T *rettv));
517 static void f_eval __ARGS((typval_T *argvars, typval_T *rettv));
518 static void f_eventhandler __ARGS((typval_T *argvars, typval_T *rettv));
519 static void f_executable __ARGS((typval_T *argvars, typval_T *rettv));
520 static void f_exists __ARGS((typval_T *argvars, typval_T *rettv));
521 static void f_expand __ARGS((typval_T *argvars, typval_T *rettv));
522 static void f_extend __ARGS((typval_T *argvars, typval_T *rettv));
523 static void f_feedkeys __ARGS((typval_T *argvars, typval_T *rettv));
524 static void f_filereadable __ARGS((typval_T *argvars, typval_T *rettv));
525 static void f_filewritable __ARGS((typval_T *argvars, typval_T *rettv));
526 static void f_filter __ARGS((typval_T *argvars, typval_T *rettv));
527 static void f_finddir __ARGS((typval_T *argvars, typval_T *rettv));
528 static void f_findfile __ARGS((typval_T *argvars, typval_T *rettv));
529 #ifdef FEAT_FLOAT
530 static void f_float2nr __ARGS((typval_T *argvars, typval_T *rettv));
531 static void f_floor __ARGS((typval_T *argvars, typval_T *rettv));
532 #endif
533 static void f_fnameescape __ARGS((typval_T *argvars, typval_T *rettv));
534 static void f_fnamemodify __ARGS((typval_T *argvars, typval_T *rettv));
535 static void f_foldclosed __ARGS((typval_T *argvars, typval_T *rettv));
536 static void f_foldclosedend __ARGS((typval_T *argvars, typval_T *rettv));
537 static void f_foldlevel __ARGS((typval_T *argvars, typval_T *rettv));
538 static void f_foldtext __ARGS((typval_T *argvars, typval_T *rettv));
539 static void f_foldtextresult __ARGS((typval_T *argvars, typval_T *rettv));
540 static void f_foreground __ARGS((typval_T *argvars, typval_T *rettv));
541 static void f_function __ARGS((typval_T *argvars, typval_T *rettv));
542 static void f_garbagecollect __ARGS((typval_T *argvars, typval_T *rettv));
543 static void f_get __ARGS((typval_T *argvars, typval_T *rettv));
544 static void f_getbufline __ARGS((typval_T *argvars, typval_T *rettv));
545 static void f_getbufvar __ARGS((typval_T *argvars, typval_T *rettv));
546 static void f_getchar __ARGS((typval_T *argvars, typval_T *rettv));
547 static void f_getcharmod __ARGS((typval_T *argvars, typval_T *rettv));
548 static void f_getcmdline __ARGS((typval_T *argvars, typval_T *rettv));
549 static void f_getcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
550 static void f_getcmdtype __ARGS((typval_T *argvars, typval_T *rettv));
551 static void f_getcwd __ARGS((typval_T *argvars, typval_T *rettv));
552 static void f_getfontname __ARGS((typval_T *argvars, typval_T *rettv));
553 static void f_getfperm __ARGS((typval_T *argvars, typval_T *rettv));
554 static void f_getfsize __ARGS((typval_T *argvars, typval_T *rettv));
555 static void f_getftime __ARGS((typval_T *argvars, typval_T *rettv));
556 static void f_getftype __ARGS((typval_T *argvars, typval_T *rettv));
557 static void f_getline __ARGS((typval_T *argvars, typval_T *rettv));
558 static void f_getmatches __ARGS((typval_T *argvars, typval_T *rettv));
559 static void f_getpid __ARGS((typval_T *argvars, typval_T *rettv));
560 static void f_getpos __ARGS((typval_T *argvars, typval_T *rettv));
561 static void f_getqflist __ARGS((typval_T *argvars, typval_T *rettv));
562 static void f_getreg __ARGS((typval_T *argvars, typval_T *rettv));
563 static void f_getregtype __ARGS((typval_T *argvars, typval_T *rettv));
564 static void f_gettabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
565 static void f_getwinposx __ARGS((typval_T *argvars, typval_T *rettv));
566 static void f_getwinposy __ARGS((typval_T *argvars, typval_T *rettv));
567 static void f_getwinvar __ARGS((typval_T *argvars, typval_T *rettv));
568 static void f_glob __ARGS((typval_T *argvars, typval_T *rettv));
569 static void f_globpath __ARGS((typval_T *argvars, typval_T *rettv));
570 static void f_has __ARGS((typval_T *argvars, typval_T *rettv));
571 static void f_has_key __ARGS((typval_T *argvars, typval_T *rettv));
572 static void f_haslocaldir __ARGS((typval_T *argvars, typval_T *rettv));
573 static void f_hasmapto __ARGS((typval_T *argvars, typval_T *rettv));
574 static void f_histadd __ARGS((typval_T *argvars, typval_T *rettv));
575 static void f_histdel __ARGS((typval_T *argvars, typval_T *rettv));
576 static void f_histget __ARGS((typval_T *argvars, typval_T *rettv));
577 static void f_histnr __ARGS((typval_T *argvars, typval_T *rettv));
578 static void f_hlID __ARGS((typval_T *argvars, typval_T *rettv));
579 static void f_hlexists __ARGS((typval_T *argvars, typval_T *rettv));
580 static void f_hostname __ARGS((typval_T *argvars, typval_T *rettv));
581 static void f_iconv __ARGS((typval_T *argvars, typval_T *rettv));
582 static void f_indent __ARGS((typval_T *argvars, typval_T *rettv));
583 static void f_index __ARGS((typval_T *argvars, typval_T *rettv));
584 static void f_input __ARGS((typval_T *argvars, typval_T *rettv));
585 static void f_inputdialog __ARGS((typval_T *argvars, typval_T *rettv));
586 static void f_inputlist __ARGS((typval_T *argvars, typval_T *rettv));
587 static void f_inputrestore __ARGS((typval_T *argvars, typval_T *rettv));
588 static void f_inputsave __ARGS((typval_T *argvars, typval_T *rettv));
589 static void f_inputsecret __ARGS((typval_T *argvars, typval_T *rettv));
590 static void f_insert __ARGS((typval_T *argvars, typval_T *rettv));
591 static void f_isdirectory __ARGS((typval_T *argvars, typval_T *rettv));
592 static void f_islocked __ARGS((typval_T *argvars, typval_T *rettv));
593 static void f_items __ARGS((typval_T *argvars, typval_T *rettv));
594 static void f_join __ARGS((typval_T *argvars, typval_T *rettv));
595 static void f_keys __ARGS((typval_T *argvars, typval_T *rettv));
596 static void f_last_buffer_nr __ARGS((typval_T *argvars, typval_T *rettv));
597 static void f_len __ARGS((typval_T *argvars, typval_T *rettv));
598 static void f_libcall __ARGS((typval_T *argvars, typval_T *rettv));
599 static void f_libcallnr __ARGS((typval_T *argvars, typval_T *rettv));
600 static void f_line __ARGS((typval_T *argvars, typval_T *rettv));
601 static void f_line2byte __ARGS((typval_T *argvars, typval_T *rettv));
602 static void f_lispindent __ARGS((typval_T *argvars, typval_T *rettv));
603 static void f_localtime __ARGS((typval_T *argvars, typval_T *rettv));
604 #ifdef FEAT_FLOAT
605 static void f_log10 __ARGS((typval_T *argvars, typval_T *rettv));
606 #endif
607 static void f_map __ARGS((typval_T *argvars, typval_T *rettv));
608 static void f_maparg __ARGS((typval_T *argvars, typval_T *rettv));
609 static void f_mapcheck __ARGS((typval_T *argvars, typval_T *rettv));
610 static void f_match __ARGS((typval_T *argvars, typval_T *rettv));
611 static void f_matchadd __ARGS((typval_T *argvars, typval_T *rettv));
612 static void f_matcharg __ARGS((typval_T *argvars, typval_T *rettv));
613 static void f_matchdelete __ARGS((typval_T *argvars, typval_T *rettv));
614 static void f_matchend __ARGS((typval_T *argvars, typval_T *rettv));
615 static void f_matchlist __ARGS((typval_T *argvars, typval_T *rettv));
616 static void f_matchstr __ARGS((typval_T *argvars, typval_T *rettv));
617 static void f_max __ARGS((typval_T *argvars, typval_T *rettv));
618 static void f_min __ARGS((typval_T *argvars, typval_T *rettv));
619 #ifdef vim_mkdir
620 static void f_mkdir __ARGS((typval_T *argvars, typval_T *rettv));
621 #endif
622 static void f_mode __ARGS((typval_T *argvars, typval_T *rettv));
623 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
624 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
625 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
626 #ifdef FEAT_FLOAT
627 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
628 #endif
629 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
630 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
631 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
632 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
633 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
634 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
635 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
636 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
637 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
642 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
643 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
644 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
645 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
646 #ifdef FEAT_FLOAT
647 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
648 #endif
649 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
650 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
651 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
652 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
653 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
654 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
655 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
656 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
657 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
668 #ifdef FEAT_FLOAT
669 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
670 #endif
671 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
672 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
673 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
674 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
675 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
676 #ifdef FEAT_FLOAT
677 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
678 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
679 #endif
680 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
681 #ifdef HAVE_STRFTIME
682 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
683 #endif
684 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
685 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
686 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
687 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
688 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
689 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
690 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
691 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
692 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
693 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
699 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
700 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
707 #ifdef FEAT_FLOAT
708 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
709 #endif
710 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
711 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
712 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
713 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
714 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
715 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
716 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
717 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
718 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
725 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
726 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
727 static int get_env_len __ARGS((char_u **arg));
728 static int get_id_len __ARGS((char_u **arg));
729 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
730 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
731 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
732 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
733 valid character */
734 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
735 static int eval_isnamec __ARGS((int c));
736 static int eval_isnamec1 __ARGS((int c));
737 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
738 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
739 static typval_T *alloc_tv __ARGS((void));
740 static typval_T *alloc_string_tv __ARGS((char_u *string));
741 static void init_tv __ARGS((typval_T *varp));
742 static long get_tv_number __ARGS((typval_T *varp));
743 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
744 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
745 static char_u *get_tv_string __ARGS((typval_T *varp));
746 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
747 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
748 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
749 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
750 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
751 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
752 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
753 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
754 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
755 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
756 static int var_check_ro __ARGS((int flags, char_u *name));
757 static int var_check_fixed __ARGS((int flags, char_u *name));
758 static int tv_check_lock __ARGS((int lock, char_u *name));
759 static void copy_tv __ARGS((typval_T *from, typval_T *to));
760 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
761 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
762 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
763 static int eval_fname_script __ARGS((char_u *p));
764 static int eval_fname_sid __ARGS((char_u *p));
765 static void list_func_head __ARGS((ufunc_T *fp, int indent));
766 static ufunc_T *find_func __ARGS((char_u *name));
767 static int function_exists __ARGS((char_u *name));
768 static int builtin_function __ARGS((char_u *name));
769 #ifdef FEAT_PROFILE
770 static void func_do_profile __ARGS((ufunc_T *fp));
771 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
772 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
773 static int
774 # ifdef __BORLANDC__
775 _RTLENTRYF
776 # endif
777 prof_total_cmp __ARGS((const void *s1, const void *s2));
778 static int
779 # ifdef __BORLANDC__
780 _RTLENTRYF
781 # endif
782 prof_self_cmp __ARGS((const void *s1, const void *s2));
783 #endif
784 static int script_autoload __ARGS((char_u *name, int reload));
785 static char_u *autoload_name __ARGS((char_u *name));
786 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
787 static void func_free __ARGS((ufunc_T *fp));
788 static void func_unref __ARGS((char_u *name));
789 static void func_ref __ARGS((char_u *name));
790 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));
791 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
792 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
793 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
794 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
795 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
796 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
798 /* Character used as separated in autoload function/variable names. */
799 #define AUTOLOAD_CHAR '#'
802 * Initialize the global and v: variables.
804 void
805 eval_init()
807 int i;
808 struct vimvar *p;
810 init_var_dict(&globvardict, &globvars_var);
811 init_var_dict(&vimvardict, &vimvars_var);
812 hash_init(&compat_hashtab);
813 hash_init(&func_hashtab);
815 for (i = 0; i < VV_LEN; ++i)
817 p = &vimvars[i];
818 STRCPY(p->vv_di.di_key, p->vv_name);
819 if (p->vv_flags & VV_RO)
820 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
821 else if (p->vv_flags & VV_RO_SBX)
822 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
823 else
824 p->vv_di.di_flags = DI_FLAGS_FIX;
826 /* add to v: scope dict, unless the value is not always available */
827 if (p->vv_type != VAR_UNKNOWN)
828 hash_add(&vimvarht, p->vv_di.di_key);
829 if (p->vv_flags & VV_COMPAT)
830 /* add to compat scope dict */
831 hash_add(&compat_hashtab, p->vv_di.di_key);
833 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
836 #if defined(EXITFREE) || defined(PROTO)
837 void
838 eval_clear()
840 int i;
841 struct vimvar *p;
843 for (i = 0; i < VV_LEN; ++i)
845 p = &vimvars[i];
846 if (p->vv_di.di_tv.v_type == VAR_STRING)
848 vim_free(p->vv_di.di_tv.vval.v_string);
849 p->vv_di.di_tv.vval.v_string = NULL;
852 hash_clear(&vimvarht);
853 hash_clear(&compat_hashtab);
855 /* script-local variables */
856 for (i = 1; i <= ga_scripts.ga_len; ++i)
857 vars_clear(&SCRIPT_VARS(i));
858 ga_clear(&ga_scripts);
859 free_scriptnames();
861 /* global variables */
862 vars_clear(&globvarht);
864 /* autoloaded script names */
865 ga_clear_strings(&ga_loaded);
867 /* unreferenced lists and dicts */
868 (void)garbage_collect();
870 /* functions */
871 free_all_functions();
872 hash_clear(&func_hashtab);
874 #endif
877 * Return the name of the executed function.
879 char_u *
880 func_name(cookie)
881 void *cookie;
883 return ((funccall_T *)cookie)->func->uf_name;
887 * Return the address holding the next breakpoint line for a funccall cookie.
889 linenr_T *
890 func_breakpoint(cookie)
891 void *cookie;
893 return &((funccall_T *)cookie)->breakpoint;
897 * Return the address holding the debug tick for a funccall cookie.
899 int *
900 func_dbg_tick(cookie)
901 void *cookie;
903 return &((funccall_T *)cookie)->dbg_tick;
907 * Return the nesting level for a funccall cookie.
910 func_level(cookie)
911 void *cookie;
913 return ((funccall_T *)cookie)->level;
916 /* pointer to funccal for currently active function */
917 funccall_T *current_funccal = NULL;
920 * Return TRUE when a function was ended by a ":return" command.
923 current_func_returned()
925 return current_funccal->returned;
930 * Set an internal variable to a string value. Creates the variable if it does
931 * not already exist.
933 void
934 set_internal_string_var(name, value)
935 char_u *name;
936 char_u *value;
938 char_u *val;
939 typval_T *tvp;
941 val = vim_strsave(value);
942 if (val != NULL)
944 tvp = alloc_string_tv(val);
945 if (tvp != NULL)
947 set_var(name, tvp, FALSE);
948 free_tv(tvp);
953 static lval_T *redir_lval = NULL;
954 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
955 static char_u *redir_endp = NULL;
956 static char_u *redir_varname = NULL;
959 * Start recording command output to a variable
960 * Returns OK if successfully completed the setup. FAIL otherwise.
963 var_redir_start(name, append)
964 char_u *name;
965 int append; /* append to an existing variable */
967 int save_emsg;
968 int err;
969 typval_T tv;
971 /* Make sure a valid variable name is specified */
972 if (!eval_isnamec1(*name))
974 EMSG(_(e_invarg));
975 return FAIL;
978 redir_varname = vim_strsave(name);
979 if (redir_varname == NULL)
980 return FAIL;
982 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
983 if (redir_lval == NULL)
985 var_redir_stop();
986 return FAIL;
989 /* The output is stored in growarray "redir_ga" until redirection ends. */
990 ga_init2(&redir_ga, (int)sizeof(char), 500);
992 /* Parse the variable name (can be a dict or list entry). */
993 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
994 FNE_CHECK_START);
995 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
997 if (redir_endp != NULL && *redir_endp != NUL)
998 /* Trailing characters are present after the variable name */
999 EMSG(_(e_trailing));
1000 else
1001 EMSG(_(e_invarg));
1002 var_redir_stop();
1003 return FAIL;
1006 /* check if we can write to the variable: set it to or append an empty
1007 * string */
1008 save_emsg = did_emsg;
1009 did_emsg = FALSE;
1010 tv.v_type = VAR_STRING;
1011 tv.vval.v_string = (char_u *)"";
1012 if (append)
1013 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1014 else
1015 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1016 err = did_emsg;
1017 did_emsg |= save_emsg;
1018 if (err)
1020 var_redir_stop();
1021 return FAIL;
1023 if (redir_lval->ll_newkey != NULL)
1025 /* Dictionary item was created, don't do it again. */
1026 vim_free(redir_lval->ll_newkey);
1027 redir_lval->ll_newkey = NULL;
1030 return OK;
1034 * Append "value[value_len]" to the variable set by var_redir_start().
1035 * The actual appending is postponed until redirection ends, because the value
1036 * appended may in fact be the string we write to, changing it may cause freed
1037 * memory to be used:
1038 * :redir => foo
1039 * :let foo
1040 * :redir END
1042 void
1043 var_redir_str(value, value_len)
1044 char_u *value;
1045 int value_len;
1047 int len;
1049 if (redir_lval == NULL)
1050 return;
1052 if (value_len == -1)
1053 len = (int)STRLEN(value); /* Append the entire string */
1054 else
1055 len = value_len; /* Append only "value_len" characters */
1057 if (ga_grow(&redir_ga, len) == OK)
1059 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1060 redir_ga.ga_len += len;
1062 else
1063 var_redir_stop();
1067 * Stop redirecting command output to a variable.
1069 void
1070 var_redir_stop()
1072 typval_T tv;
1074 if (redir_lval != NULL)
1076 /* Append the trailing NUL. */
1077 ga_append(&redir_ga, NUL);
1079 /* Assign the text to the variable. */
1080 tv.v_type = VAR_STRING;
1081 tv.vval.v_string = redir_ga.ga_data;
1082 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1083 vim_free(tv.vval.v_string);
1085 clear_lval(redir_lval);
1086 vim_free(redir_lval);
1087 redir_lval = NULL;
1089 vim_free(redir_varname);
1090 redir_varname = NULL;
1093 # if defined(FEAT_MBYTE) || defined(PROTO)
1095 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1096 char_u *enc_from;
1097 char_u *enc_to;
1098 char_u *fname_from;
1099 char_u *fname_to;
1101 int err = FALSE;
1103 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1104 set_vim_var_string(VV_CC_TO, enc_to, -1);
1105 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1106 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1107 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1108 err = TRUE;
1109 set_vim_var_string(VV_CC_FROM, NULL, -1);
1110 set_vim_var_string(VV_CC_TO, NULL, -1);
1111 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1112 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1114 if (err)
1115 return FAIL;
1116 return OK;
1118 # endif
1120 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1122 eval_printexpr(fname, args)
1123 char_u *fname;
1124 char_u *args;
1126 int err = FALSE;
1128 set_vim_var_string(VV_FNAME_IN, fname, -1);
1129 set_vim_var_string(VV_CMDARG, args, -1);
1130 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1131 err = TRUE;
1132 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1133 set_vim_var_string(VV_CMDARG, NULL, -1);
1135 if (err)
1137 mch_remove(fname);
1138 return FAIL;
1140 return OK;
1142 # endif
1144 # if defined(FEAT_DIFF) || defined(PROTO)
1145 void
1146 eval_diff(origfile, newfile, outfile)
1147 char_u *origfile;
1148 char_u *newfile;
1149 char_u *outfile;
1151 int err = FALSE;
1153 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1154 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1155 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1156 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1157 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1158 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1159 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1162 void
1163 eval_patch(origfile, difffile, outfile)
1164 char_u *origfile;
1165 char_u *difffile;
1166 char_u *outfile;
1168 int err;
1170 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1171 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1172 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1173 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1174 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1175 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1176 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1178 # endif
1181 * Top level evaluation function, returning a boolean.
1182 * Sets "error" to TRUE if there was an error.
1183 * Return TRUE or FALSE.
1186 eval_to_bool(arg, error, nextcmd, skip)
1187 char_u *arg;
1188 int *error;
1189 char_u **nextcmd;
1190 int skip; /* only parse, don't execute */
1192 typval_T tv;
1193 int retval = FALSE;
1195 if (skip)
1196 ++emsg_skip;
1197 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1198 *error = TRUE;
1199 else
1201 *error = FALSE;
1202 if (!skip)
1204 retval = (get_tv_number_chk(&tv, error) != 0);
1205 clear_tv(&tv);
1208 if (skip)
1209 --emsg_skip;
1211 return retval;
1215 * Top level evaluation function, returning a string. If "skip" is TRUE,
1216 * only parsing to "nextcmd" is done, without reporting errors. Return
1217 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1219 char_u *
1220 eval_to_string_skip(arg, nextcmd, skip)
1221 char_u *arg;
1222 char_u **nextcmd;
1223 int skip; /* only parse, don't execute */
1225 typval_T tv;
1226 char_u *retval;
1228 if (skip)
1229 ++emsg_skip;
1230 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1231 retval = NULL;
1232 else
1234 retval = vim_strsave(get_tv_string(&tv));
1235 clear_tv(&tv);
1237 if (skip)
1238 --emsg_skip;
1240 return retval;
1244 * Skip over an expression at "*pp".
1245 * Return FAIL for an error, OK otherwise.
1248 skip_expr(pp)
1249 char_u **pp;
1251 typval_T rettv;
1253 *pp = skipwhite(*pp);
1254 return eval1(pp, &rettv, FALSE);
1258 * Top level evaluation function, returning a string.
1259 * Return pointer to allocated memory, or NULL for failure.
1261 char_u *
1262 eval_to_string(arg, nextcmd, dolist)
1263 char_u *arg;
1264 char_u **nextcmd;
1265 int dolist; /* turn List into sequence of lines */
1267 typval_T tv;
1268 char_u *retval;
1269 garray_T ga;
1271 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1272 retval = NULL;
1273 else
1275 if (dolist && tv.v_type == VAR_LIST)
1277 ga_init2(&ga, (int)sizeof(char), 80);
1278 if (tv.vval.v_list != NULL)
1279 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1280 ga_append(&ga, NUL);
1281 retval = (char_u *)ga.ga_data;
1283 else
1284 retval = vim_strsave(get_tv_string(&tv));
1285 clear_tv(&tv);
1288 return retval;
1292 * Call eval_to_string() without using current local variables and using
1293 * textlock. When "use_sandbox" is TRUE use the sandbox.
1295 char_u *
1296 eval_to_string_safe(arg, nextcmd, use_sandbox)
1297 char_u *arg;
1298 char_u **nextcmd;
1299 int use_sandbox;
1301 char_u *retval;
1302 void *save_funccalp;
1304 save_funccalp = save_funccal();
1305 if (use_sandbox)
1306 ++sandbox;
1307 ++textlock;
1308 retval = eval_to_string(arg, nextcmd, FALSE);
1309 if (use_sandbox)
1310 --sandbox;
1311 --textlock;
1312 restore_funccal(save_funccalp);
1313 return retval;
1317 * Top level evaluation function, returning a number.
1318 * Evaluates "expr" silently.
1319 * Returns -1 for an error.
1322 eval_to_number(expr)
1323 char_u *expr;
1325 typval_T rettv;
1326 int retval;
1327 char_u *p = skipwhite(expr);
1329 ++emsg_off;
1331 if (eval1(&p, &rettv, TRUE) == FAIL)
1332 retval = -1;
1333 else
1335 retval = get_tv_number_chk(&rettv, NULL);
1336 clear_tv(&rettv);
1338 --emsg_off;
1340 return retval;
1344 * Prepare v: variable "idx" to be used.
1345 * Save the current typeval in "save_tv".
1346 * When not used yet add the variable to the v: hashtable.
1348 static void
1349 prepare_vimvar(idx, save_tv)
1350 int idx;
1351 typval_T *save_tv;
1353 *save_tv = vimvars[idx].vv_tv;
1354 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1355 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1359 * Restore v: variable "idx" to typeval "save_tv".
1360 * When no longer defined, remove the variable from the v: hashtable.
1362 static void
1363 restore_vimvar(idx, save_tv)
1364 int idx;
1365 typval_T *save_tv;
1367 hashitem_T *hi;
1369 vimvars[idx].vv_tv = *save_tv;
1370 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1372 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1373 if (HASHITEM_EMPTY(hi))
1374 EMSG2(_(e_intern2), "restore_vimvar()");
1375 else
1376 hash_remove(&vimvarht, hi);
1380 #if defined(FEAT_SPELL) || defined(PROTO)
1382 * Evaluate an expression to a list with suggestions.
1383 * For the "expr:" part of 'spellsuggest'.
1384 * Returns NULL when there is an error.
1386 list_T *
1387 eval_spell_expr(badword, expr)
1388 char_u *badword;
1389 char_u *expr;
1391 typval_T save_val;
1392 typval_T rettv;
1393 list_T *list = NULL;
1394 char_u *p = skipwhite(expr);
1396 /* Set "v:val" to the bad word. */
1397 prepare_vimvar(VV_VAL, &save_val);
1398 vimvars[VV_VAL].vv_type = VAR_STRING;
1399 vimvars[VV_VAL].vv_str = badword;
1400 if (p_verbose == 0)
1401 ++emsg_off;
1403 if (eval1(&p, &rettv, TRUE) == OK)
1405 if (rettv.v_type != VAR_LIST)
1406 clear_tv(&rettv);
1407 else
1408 list = rettv.vval.v_list;
1411 if (p_verbose == 0)
1412 --emsg_off;
1413 restore_vimvar(VV_VAL, &save_val);
1415 return list;
1419 * "list" is supposed to contain two items: a word and a number. Return the
1420 * word in "pp" and the number as the return value.
1421 * Return -1 if anything isn't right.
1422 * Used to get the good word and score from the eval_spell_expr() result.
1425 get_spellword(list, pp)
1426 list_T *list;
1427 char_u **pp;
1429 listitem_T *li;
1431 li = list->lv_first;
1432 if (li == NULL)
1433 return -1;
1434 *pp = get_tv_string(&li->li_tv);
1436 li = li->li_next;
1437 if (li == NULL)
1438 return -1;
1439 return get_tv_number(&li->li_tv);
1441 #endif
1444 * Top level evaluation function.
1445 * Returns an allocated typval_T with the result.
1446 * Returns NULL when there is an error.
1448 typval_T *
1449 eval_expr(arg, nextcmd)
1450 char_u *arg;
1451 char_u **nextcmd;
1453 typval_T *tv;
1455 tv = (typval_T *)alloc(sizeof(typval_T));
1456 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1458 vim_free(tv);
1459 tv = NULL;
1462 return tv;
1466 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1467 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1469 * Call some vimL function and return the result in "*rettv".
1470 * Uses argv[argc] for the function arguments. Only Number and String
1471 * arguments are currently supported.
1472 * Returns OK or FAIL.
1474 static int
1475 call_vim_function(func, argc, argv, safe, rettv)
1476 char_u *func;
1477 int argc;
1478 char_u **argv;
1479 int safe; /* use the sandbox */
1480 typval_T *rettv;
1482 typval_T *argvars;
1483 long n;
1484 int len;
1485 int i;
1486 int doesrange;
1487 void *save_funccalp = NULL;
1488 int ret;
1490 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1491 if (argvars == NULL)
1492 return FAIL;
1494 for (i = 0; i < argc; i++)
1496 /* Pass a NULL or empty argument as an empty string */
1497 if (argv[i] == NULL || *argv[i] == NUL)
1499 argvars[i].v_type = VAR_STRING;
1500 argvars[i].vval.v_string = (char_u *)"";
1501 continue;
1504 /* Recognize a number argument, the others must be strings. */
1505 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1506 if (len != 0 && len == (int)STRLEN(argv[i]))
1508 argvars[i].v_type = VAR_NUMBER;
1509 argvars[i].vval.v_number = n;
1511 else
1513 argvars[i].v_type = VAR_STRING;
1514 argvars[i].vval.v_string = argv[i];
1518 if (safe)
1520 save_funccalp = save_funccal();
1521 ++sandbox;
1524 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1525 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1526 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1527 &doesrange, TRUE, NULL);
1528 if (safe)
1530 --sandbox;
1531 restore_funccal(save_funccalp);
1533 vim_free(argvars);
1535 if (ret == FAIL)
1536 clear_tv(rettv);
1538 return ret;
1541 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1543 * Call vimL function "func" and return the result as a string.
1544 * Returns NULL when calling the function fails.
1545 * Uses argv[argc] for the function arguments.
1547 void *
1548 call_func_retstr(func, argc, argv, safe)
1549 char_u *func;
1550 int argc;
1551 char_u **argv;
1552 int safe; /* use the sandbox */
1554 typval_T rettv;
1555 char_u *retval;
1557 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1558 return NULL;
1560 retval = vim_strsave(get_tv_string(&rettv));
1561 clear_tv(&rettv);
1562 return retval;
1564 # endif
1566 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1568 * Call vimL function "func" and return the result as a number.
1569 * Returns -1 when calling the function fails.
1570 * Uses argv[argc] for the function arguments.
1572 long
1573 call_func_retnr(func, argc, argv, safe)
1574 char_u *func;
1575 int argc;
1576 char_u **argv;
1577 int safe; /* use the sandbox */
1579 typval_T rettv;
1580 long retval;
1582 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1583 return -1;
1585 retval = get_tv_number_chk(&rettv, NULL);
1586 clear_tv(&rettv);
1587 return retval;
1589 # endif
1592 * Call vimL function "func" and return the result as a List.
1593 * Uses argv[argc] for the function arguments.
1594 * Returns NULL when there is something wrong.
1596 void *
1597 call_func_retlist(func, argc, argv, safe)
1598 char_u *func;
1599 int argc;
1600 char_u **argv;
1601 int safe; /* use the sandbox */
1603 typval_T rettv;
1605 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1606 return NULL;
1608 if (rettv.v_type != VAR_LIST)
1610 clear_tv(&rettv);
1611 return NULL;
1614 return rettv.vval.v_list;
1616 #endif
1620 * Save the current function call pointer, and set it to NULL.
1621 * Used when executing autocommands and for ":source".
1623 void *
1624 save_funccal()
1626 funccall_T *fc = current_funccal;
1628 current_funccal = NULL;
1629 return (void *)fc;
1632 void
1633 restore_funccal(vfc)
1634 void *vfc;
1636 funccall_T *fc = (funccall_T *)vfc;
1638 current_funccal = fc;
1641 #if defined(FEAT_PROFILE) || defined(PROTO)
1643 * Prepare profiling for entering a child or something else that is not
1644 * counted for the script/function itself.
1645 * Should always be called in pair with prof_child_exit().
1647 void
1648 prof_child_enter(tm)
1649 proftime_T *tm; /* place to store waittime */
1651 funccall_T *fc = current_funccal;
1653 if (fc != NULL && fc->func->uf_profiling)
1654 profile_start(&fc->prof_child);
1655 script_prof_save(tm);
1659 * Take care of time spent in a child.
1660 * Should always be called after prof_child_enter().
1662 void
1663 prof_child_exit(tm)
1664 proftime_T *tm; /* where waittime was stored */
1666 funccall_T *fc = current_funccal;
1668 if (fc != NULL && fc->func->uf_profiling)
1670 profile_end(&fc->prof_child);
1671 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1672 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1673 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1675 script_prof_restore(tm);
1677 #endif
1680 #ifdef FEAT_FOLDING
1682 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1683 * it in "*cp". Doesn't give error messages.
1686 eval_foldexpr(arg, cp)
1687 char_u *arg;
1688 int *cp;
1690 typval_T tv;
1691 int retval;
1692 char_u *s;
1693 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1694 OPT_LOCAL);
1696 ++emsg_off;
1697 if (use_sandbox)
1698 ++sandbox;
1699 ++textlock;
1700 *cp = NUL;
1701 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1702 retval = 0;
1703 else
1705 /* If the result is a number, just return the number. */
1706 if (tv.v_type == VAR_NUMBER)
1707 retval = tv.vval.v_number;
1708 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1709 retval = 0;
1710 else
1712 /* If the result is a string, check if there is a non-digit before
1713 * the number. */
1714 s = tv.vval.v_string;
1715 if (!VIM_ISDIGIT(*s) && *s != '-')
1716 *cp = *s++;
1717 retval = atol((char *)s);
1719 clear_tv(&tv);
1721 --emsg_off;
1722 if (use_sandbox)
1723 --sandbox;
1724 --textlock;
1726 return retval;
1728 #endif
1731 * ":let" list all variable values
1732 * ":let var1 var2" list variable values
1733 * ":let var = expr" assignment command.
1734 * ":let var += expr" assignment command.
1735 * ":let var -= expr" assignment command.
1736 * ":let var .= expr" assignment command.
1737 * ":let [var1, var2] = expr" unpack list.
1739 void
1740 ex_let(eap)
1741 exarg_T *eap;
1743 char_u *arg = eap->arg;
1744 char_u *expr = NULL;
1745 typval_T rettv;
1746 int i;
1747 int var_count = 0;
1748 int semicolon = 0;
1749 char_u op[2];
1750 char_u *argend;
1751 int first = TRUE;
1753 argend = skip_var_list(arg, &var_count, &semicolon);
1754 if (argend == NULL)
1755 return;
1756 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1757 --argend;
1758 expr = vim_strchr(argend, '=');
1759 if (expr == NULL)
1762 * ":let" without "=": list variables
1764 if (*arg == '[')
1765 EMSG(_(e_invarg));
1766 else if (!ends_excmd(*arg))
1767 /* ":let var1 var2" */
1768 arg = list_arg_vars(eap, arg, &first);
1769 else if (!eap->skip)
1771 /* ":let" */
1772 list_glob_vars(&first);
1773 list_buf_vars(&first);
1774 list_win_vars(&first);
1775 #ifdef FEAT_WINDOWS
1776 list_tab_vars(&first);
1777 #endif
1778 list_script_vars(&first);
1779 list_func_vars(&first);
1780 list_vim_vars(&first);
1782 eap->nextcmd = check_nextcmd(arg);
1784 else
1786 op[0] = '=';
1787 op[1] = NUL;
1788 if (expr > argend)
1790 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1791 op[0] = expr[-1]; /* +=, -= or .= */
1793 expr = skipwhite(expr + 1);
1795 if (eap->skip)
1796 ++emsg_skip;
1797 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1798 if (eap->skip)
1800 if (i != FAIL)
1801 clear_tv(&rettv);
1802 --emsg_skip;
1804 else if (i != FAIL)
1806 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1807 op);
1808 clear_tv(&rettv);
1814 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1815 * Handles both "var" with any type and "[var, var; var]" with a list type.
1816 * When "nextchars" is not NULL it points to a string with characters that
1817 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1818 * or concatenate.
1819 * Returns OK or FAIL;
1821 static int
1822 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1823 char_u *arg_start;
1824 typval_T *tv;
1825 int copy; /* copy values from "tv", don't move */
1826 int semicolon; /* from skip_var_list() */
1827 int var_count; /* from skip_var_list() */
1828 char_u *nextchars;
1830 char_u *arg = arg_start;
1831 list_T *l;
1832 int i;
1833 listitem_T *item;
1834 typval_T ltv;
1836 if (*arg != '[')
1839 * ":let var = expr" or ":for var in list"
1841 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1842 return FAIL;
1843 return OK;
1847 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1849 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1851 EMSG(_(e_listreq));
1852 return FAIL;
1855 i = list_len(l);
1856 if (semicolon == 0 && var_count < i)
1858 EMSG(_("E687: Less targets than List items"));
1859 return FAIL;
1861 if (var_count - semicolon > i)
1863 EMSG(_("E688: More targets than List items"));
1864 return FAIL;
1867 item = l->lv_first;
1868 while (*arg != ']')
1870 arg = skipwhite(arg + 1);
1871 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1872 item = item->li_next;
1873 if (arg == NULL)
1874 return FAIL;
1876 arg = skipwhite(arg);
1877 if (*arg == ';')
1879 /* Put the rest of the list (may be empty) in the var after ';'.
1880 * Create a new list for this. */
1881 l = list_alloc();
1882 if (l == NULL)
1883 return FAIL;
1884 while (item != NULL)
1886 list_append_tv(l, &item->li_tv);
1887 item = item->li_next;
1890 ltv.v_type = VAR_LIST;
1891 ltv.v_lock = 0;
1892 ltv.vval.v_list = l;
1893 l->lv_refcount = 1;
1895 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1896 (char_u *)"]", nextchars);
1897 clear_tv(&ltv);
1898 if (arg == NULL)
1899 return FAIL;
1900 break;
1902 else if (*arg != ',' && *arg != ']')
1904 EMSG2(_(e_intern2), "ex_let_vars()");
1905 return FAIL;
1909 return OK;
1913 * Skip over assignable variable "var" or list of variables "[var, var]".
1914 * Used for ":let varvar = expr" and ":for varvar in expr".
1915 * For "[var, var]" increment "*var_count" for each variable.
1916 * for "[var, var; var]" set "semicolon".
1917 * Return NULL for an error.
1919 static char_u *
1920 skip_var_list(arg, var_count, semicolon)
1921 char_u *arg;
1922 int *var_count;
1923 int *semicolon;
1925 char_u *p, *s;
1927 if (*arg == '[')
1929 /* "[var, var]": find the matching ']'. */
1930 p = arg;
1931 for (;;)
1933 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1934 s = skip_var_one(p);
1935 if (s == p)
1937 EMSG2(_(e_invarg2), p);
1938 return NULL;
1940 ++*var_count;
1942 p = skipwhite(s);
1943 if (*p == ']')
1944 break;
1945 else if (*p == ';')
1947 if (*semicolon == 1)
1949 EMSG(_("Double ; in list of variables"));
1950 return NULL;
1952 *semicolon = 1;
1954 else if (*p != ',')
1956 EMSG2(_(e_invarg2), p);
1957 return NULL;
1960 return p + 1;
1962 else
1963 return skip_var_one(arg);
1967 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1968 * l[idx].
1970 static char_u *
1971 skip_var_one(arg)
1972 char_u *arg;
1974 if (*arg == '@' && arg[1] != NUL)
1975 return arg + 2;
1976 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
1977 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1981 * List variables for hashtab "ht" with prefix "prefix".
1982 * If "empty" is TRUE also list NULL strings as empty strings.
1984 static void
1985 list_hashtable_vars(ht, prefix, empty, first)
1986 hashtab_T *ht;
1987 char_u *prefix;
1988 int empty;
1989 int *first;
1991 hashitem_T *hi;
1992 dictitem_T *di;
1993 int todo;
1995 todo = (int)ht->ht_used;
1996 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1998 if (!HASHITEM_EMPTY(hi))
2000 --todo;
2001 di = HI2DI(hi);
2002 if (empty || di->di_tv.v_type != VAR_STRING
2003 || di->di_tv.vval.v_string != NULL)
2004 list_one_var(di, prefix, first);
2010 * List global variables.
2012 static void
2013 list_glob_vars(first)
2014 int *first;
2016 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2020 * List buffer variables.
2022 static void
2023 list_buf_vars(first)
2024 int *first;
2026 char_u numbuf[NUMBUFLEN];
2028 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2029 TRUE, first);
2031 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2032 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2033 numbuf, first);
2037 * List window variables.
2039 static void
2040 list_win_vars(first)
2041 int *first;
2043 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2044 (char_u *)"w:", TRUE, first);
2047 #ifdef FEAT_WINDOWS
2049 * List tab page variables.
2051 static void
2052 list_tab_vars(first)
2053 int *first;
2055 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2056 (char_u *)"t:", TRUE, first);
2058 #endif
2061 * List Vim variables.
2063 static void
2064 list_vim_vars(first)
2065 int *first;
2067 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2071 * List script-local variables, if there is a script.
2073 static void
2074 list_script_vars(first)
2075 int *first;
2077 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2078 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2079 (char_u *)"s:", FALSE, first);
2083 * List function variables, if there is a function.
2085 static void
2086 list_func_vars(first)
2087 int *first;
2089 if (current_funccal != NULL)
2090 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2091 (char_u *)"l:", FALSE, first);
2095 * List variables in "arg".
2097 static char_u *
2098 list_arg_vars(eap, arg, first)
2099 exarg_T *eap;
2100 char_u *arg;
2101 int *first;
2103 int error = FALSE;
2104 int len;
2105 char_u *name;
2106 char_u *name_start;
2107 char_u *arg_subsc;
2108 char_u *tofree;
2109 typval_T tv;
2111 while (!ends_excmd(*arg) && !got_int)
2113 if (error || eap->skip)
2115 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2116 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2118 emsg_severe = TRUE;
2119 EMSG(_(e_trailing));
2120 break;
2123 else
2125 /* get_name_len() takes care of expanding curly braces */
2126 name_start = name = arg;
2127 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2128 if (len <= 0)
2130 /* This is mainly to keep test 49 working: when expanding
2131 * curly braces fails overrule the exception error message. */
2132 if (len < 0 && !aborting())
2134 emsg_severe = TRUE;
2135 EMSG2(_(e_invarg2), arg);
2136 break;
2138 error = TRUE;
2140 else
2142 if (tofree != NULL)
2143 name = tofree;
2144 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2145 error = TRUE;
2146 else
2148 /* handle d.key, l[idx], f(expr) */
2149 arg_subsc = arg;
2150 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2151 error = TRUE;
2152 else
2154 if (arg == arg_subsc && len == 2 && name[1] == ':')
2156 switch (*name)
2158 case 'g': list_glob_vars(first); break;
2159 case 'b': list_buf_vars(first); break;
2160 case 'w': list_win_vars(first); break;
2161 #ifdef FEAT_WINDOWS
2162 case 't': list_tab_vars(first); break;
2163 #endif
2164 case 'v': list_vim_vars(first); break;
2165 case 's': list_script_vars(first); break;
2166 case 'l': list_func_vars(first); break;
2167 default:
2168 EMSG2(_("E738: Can't list variables for %s"), name);
2171 else
2173 char_u numbuf[NUMBUFLEN];
2174 char_u *tf;
2175 int c;
2176 char_u *s;
2178 s = echo_string(&tv, &tf, numbuf, 0);
2179 c = *arg;
2180 *arg = NUL;
2181 list_one_var_a((char_u *)"",
2182 arg == arg_subsc ? name : name_start,
2183 tv.v_type,
2184 s == NULL ? (char_u *)"" : s,
2185 first);
2186 *arg = c;
2187 vim_free(tf);
2189 clear_tv(&tv);
2194 vim_free(tofree);
2197 arg = skipwhite(arg);
2200 return arg;
2204 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2205 * Returns a pointer to the char just after the var name.
2206 * Returns NULL if there is an error.
2208 static char_u *
2209 ex_let_one(arg, tv, copy, endchars, op)
2210 char_u *arg; /* points to variable name */
2211 typval_T *tv; /* value to assign to variable */
2212 int copy; /* copy value from "tv" */
2213 char_u *endchars; /* valid chars after variable name or NULL */
2214 char_u *op; /* "+", "-", "." or NULL*/
2216 int c1;
2217 char_u *name;
2218 char_u *p;
2219 char_u *arg_end = NULL;
2220 int len;
2221 int opt_flags;
2222 char_u *tofree = NULL;
2225 * ":let $VAR = expr": Set environment variable.
2227 if (*arg == '$')
2229 /* Find the end of the name. */
2230 ++arg;
2231 name = arg;
2232 len = get_env_len(&arg);
2233 if (len == 0)
2234 EMSG2(_(e_invarg2), name - 1);
2235 else
2237 if (op != NULL && (*op == '+' || *op == '-'))
2238 EMSG2(_(e_letwrong), op);
2239 else if (endchars != NULL
2240 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2241 EMSG(_(e_letunexp));
2242 else
2244 c1 = name[len];
2245 name[len] = NUL;
2246 p = get_tv_string_chk(tv);
2247 if (p != NULL && op != NULL && *op == '.')
2249 int mustfree = FALSE;
2250 char_u *s = vim_getenv(name, &mustfree);
2252 if (s != NULL)
2254 p = tofree = concat_str(s, p);
2255 if (mustfree)
2256 vim_free(s);
2259 if (p != NULL)
2261 vim_setenv(name, p);
2262 if (STRICMP(name, "HOME") == 0)
2263 init_homedir();
2264 else if (didset_vim && STRICMP(name, "VIM") == 0)
2265 didset_vim = FALSE;
2266 else if (didset_vimruntime
2267 && STRICMP(name, "VIMRUNTIME") == 0)
2268 didset_vimruntime = FALSE;
2269 arg_end = arg;
2271 name[len] = c1;
2272 vim_free(tofree);
2278 * ":let &option = expr": Set option value.
2279 * ":let &l:option = expr": Set local option value.
2280 * ":let &g:option = expr": Set global option value.
2282 else if (*arg == '&')
2284 /* Find the end of the name. */
2285 p = find_option_end(&arg, &opt_flags);
2286 if (p == NULL || (endchars != NULL
2287 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2288 EMSG(_(e_letunexp));
2289 else
2291 long n;
2292 int opt_type;
2293 long numval;
2294 char_u *stringval = NULL;
2295 char_u *s;
2297 c1 = *p;
2298 *p = NUL;
2300 n = get_tv_number(tv);
2301 s = get_tv_string_chk(tv); /* != NULL if number or string */
2302 if (s != NULL && op != NULL && *op != '=')
2304 opt_type = get_option_value(arg, &numval,
2305 &stringval, opt_flags);
2306 if ((opt_type == 1 && *op == '.')
2307 || (opt_type == 0 && *op != '.'))
2308 EMSG2(_(e_letwrong), op);
2309 else
2311 if (opt_type == 1) /* number */
2313 if (*op == '+')
2314 n = numval + n;
2315 else
2316 n = numval - n;
2318 else if (opt_type == 0 && stringval != NULL) /* string */
2320 s = concat_str(stringval, s);
2321 vim_free(stringval);
2322 stringval = s;
2326 if (s != NULL)
2328 set_option_value(arg, n, s, opt_flags);
2329 arg_end = p;
2331 *p = c1;
2332 vim_free(stringval);
2337 * ":let @r = expr": Set register contents.
2339 else if (*arg == '@')
2341 ++arg;
2342 if (op != NULL && (*op == '+' || *op == '-'))
2343 EMSG2(_(e_letwrong), op);
2344 else if (endchars != NULL
2345 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2346 EMSG(_(e_letunexp));
2347 else
2349 char_u *ptofree = NULL;
2350 char_u *s;
2352 p = get_tv_string_chk(tv);
2353 if (p != NULL && op != NULL && *op == '.')
2355 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2356 if (s != NULL)
2358 p = ptofree = concat_str(s, p);
2359 vim_free(s);
2362 if (p != NULL)
2364 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2365 arg_end = arg + 1;
2367 vim_free(ptofree);
2372 * ":let var = expr": Set internal variable.
2373 * ":let {expr} = expr": Idem, name made with curly braces
2375 else if (eval_isnamec1(*arg) || *arg == '{')
2377 lval_T lv;
2379 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2380 if (p != NULL && lv.ll_name != NULL)
2382 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2383 EMSG(_(e_letunexp));
2384 else
2386 set_var_lval(&lv, p, tv, copy, op);
2387 arg_end = p;
2390 clear_lval(&lv);
2393 else
2394 EMSG2(_(e_invarg2), arg);
2396 return arg_end;
2400 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2402 static int
2403 check_changedtick(arg)
2404 char_u *arg;
2406 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2408 EMSG2(_(e_readonlyvar), arg);
2409 return TRUE;
2411 return FALSE;
2415 * Get an lval: variable, Dict item or List item that can be assigned a value
2416 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2417 * "name.key", "name.key[expr]" etc.
2418 * Indexing only works if "name" is an existing List or Dictionary.
2419 * "name" points to the start of the name.
2420 * If "rettv" is not NULL it points to the value to be assigned.
2421 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2422 * wrong; must end in space or cmd separator.
2424 * Returns a pointer to just after the name, including indexes.
2425 * When an evaluation error occurs "lp->ll_name" is NULL;
2426 * Returns NULL for a parsing error. Still need to free items in "lp"!
2428 static char_u *
2429 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2430 char_u *name;
2431 typval_T *rettv;
2432 lval_T *lp;
2433 int unlet;
2434 int skip;
2435 int quiet; /* don't give error messages */
2436 int fne_flags; /* flags for find_name_end() */
2438 char_u *p;
2439 char_u *expr_start, *expr_end;
2440 int cc;
2441 dictitem_T *v;
2442 typval_T var1;
2443 typval_T var2;
2444 int empty1 = FALSE;
2445 listitem_T *ni;
2446 char_u *key = NULL;
2447 int len;
2448 hashtab_T *ht;
2450 /* Clear everything in "lp". */
2451 vim_memset(lp, 0, sizeof(lval_T));
2453 if (skip)
2455 /* When skipping just find the end of the name. */
2456 lp->ll_name = name;
2457 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2460 /* Find the end of the name. */
2461 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2462 if (expr_start != NULL)
2464 /* Don't expand the name when we already know there is an error. */
2465 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2466 && *p != '[' && *p != '.')
2468 EMSG(_(e_trailing));
2469 return NULL;
2472 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2473 if (lp->ll_exp_name == NULL)
2475 /* Report an invalid expression in braces, unless the
2476 * expression evaluation has been cancelled due to an
2477 * aborting error, an interrupt, or an exception. */
2478 if (!aborting() && !quiet)
2480 emsg_severe = TRUE;
2481 EMSG2(_(e_invarg2), name);
2482 return NULL;
2485 lp->ll_name = lp->ll_exp_name;
2487 else
2488 lp->ll_name = name;
2490 /* Without [idx] or .key we are done. */
2491 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2492 return p;
2494 cc = *p;
2495 *p = NUL;
2496 v = find_var(lp->ll_name, &ht);
2497 if (v == NULL && !quiet)
2498 EMSG2(_(e_undefvar), lp->ll_name);
2499 *p = cc;
2500 if (v == NULL)
2501 return NULL;
2504 * Loop until no more [idx] or .key is following.
2506 lp->ll_tv = &v->di_tv;
2507 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2509 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2510 && !(lp->ll_tv->v_type == VAR_DICT
2511 && lp->ll_tv->vval.v_dict != NULL))
2513 if (!quiet)
2514 EMSG(_("E689: Can only index a List or Dictionary"));
2515 return NULL;
2517 if (lp->ll_range)
2519 if (!quiet)
2520 EMSG(_("E708: [:] must come last"));
2521 return NULL;
2524 len = -1;
2525 if (*p == '.')
2527 key = p + 1;
2528 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2530 if (len == 0)
2532 if (!quiet)
2533 EMSG(_(e_emptykey));
2534 return NULL;
2536 p = key + len;
2538 else
2540 /* Get the index [expr] or the first index [expr: ]. */
2541 p = skipwhite(p + 1);
2542 if (*p == ':')
2543 empty1 = TRUE;
2544 else
2546 empty1 = FALSE;
2547 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2548 return NULL;
2549 if (get_tv_string_chk(&var1) == NULL)
2551 /* not a number or string */
2552 clear_tv(&var1);
2553 return NULL;
2557 /* Optionally get the second index [ :expr]. */
2558 if (*p == ':')
2560 if (lp->ll_tv->v_type == VAR_DICT)
2562 if (!quiet)
2563 EMSG(_(e_dictrange));
2564 if (!empty1)
2565 clear_tv(&var1);
2566 return NULL;
2568 if (rettv != NULL && (rettv->v_type != VAR_LIST
2569 || rettv->vval.v_list == NULL))
2571 if (!quiet)
2572 EMSG(_("E709: [:] requires a List value"));
2573 if (!empty1)
2574 clear_tv(&var1);
2575 return NULL;
2577 p = skipwhite(p + 1);
2578 if (*p == ']')
2579 lp->ll_empty2 = TRUE;
2580 else
2582 lp->ll_empty2 = FALSE;
2583 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2585 if (!empty1)
2586 clear_tv(&var1);
2587 return NULL;
2589 if (get_tv_string_chk(&var2) == NULL)
2591 /* not a number or string */
2592 if (!empty1)
2593 clear_tv(&var1);
2594 clear_tv(&var2);
2595 return NULL;
2598 lp->ll_range = TRUE;
2600 else
2601 lp->ll_range = FALSE;
2603 if (*p != ']')
2605 if (!quiet)
2606 EMSG(_(e_missbrac));
2607 if (!empty1)
2608 clear_tv(&var1);
2609 if (lp->ll_range && !lp->ll_empty2)
2610 clear_tv(&var2);
2611 return NULL;
2614 /* Skip to past ']'. */
2615 ++p;
2618 if (lp->ll_tv->v_type == VAR_DICT)
2620 if (len == -1)
2622 /* "[key]": get key from "var1" */
2623 key = get_tv_string(&var1); /* is number or string */
2624 if (*key == NUL)
2626 if (!quiet)
2627 EMSG(_(e_emptykey));
2628 clear_tv(&var1);
2629 return NULL;
2632 lp->ll_list = NULL;
2633 lp->ll_dict = lp->ll_tv->vval.v_dict;
2634 lp->ll_di = dict_find(lp->ll_dict, key, len);
2635 if (lp->ll_di == NULL)
2637 /* Key does not exist in dict: may need to add it. */
2638 if (*p == '[' || *p == '.' || unlet)
2640 if (!quiet)
2641 EMSG2(_(e_dictkey), key);
2642 if (len == -1)
2643 clear_tv(&var1);
2644 return NULL;
2646 if (len == -1)
2647 lp->ll_newkey = vim_strsave(key);
2648 else
2649 lp->ll_newkey = vim_strnsave(key, len);
2650 if (len == -1)
2651 clear_tv(&var1);
2652 if (lp->ll_newkey == NULL)
2653 p = NULL;
2654 break;
2656 if (len == -1)
2657 clear_tv(&var1);
2658 lp->ll_tv = &lp->ll_di->di_tv;
2660 else
2663 * Get the number and item for the only or first index of the List.
2665 if (empty1)
2666 lp->ll_n1 = 0;
2667 else
2669 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2670 clear_tv(&var1);
2672 lp->ll_dict = NULL;
2673 lp->ll_list = lp->ll_tv->vval.v_list;
2674 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2675 if (lp->ll_li == NULL)
2677 if (lp->ll_n1 < 0)
2679 lp->ll_n1 = 0;
2680 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2683 if (lp->ll_li == NULL)
2685 if (lp->ll_range && !lp->ll_empty2)
2686 clear_tv(&var2);
2687 return NULL;
2691 * May need to find the item or absolute index for the second
2692 * index of a range.
2693 * When no index given: "lp->ll_empty2" is TRUE.
2694 * Otherwise "lp->ll_n2" is set to the second index.
2696 if (lp->ll_range && !lp->ll_empty2)
2698 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2699 clear_tv(&var2);
2700 if (lp->ll_n2 < 0)
2702 ni = list_find(lp->ll_list, lp->ll_n2);
2703 if (ni == NULL)
2704 return NULL;
2705 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2708 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2709 if (lp->ll_n1 < 0)
2710 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2711 if (lp->ll_n2 < lp->ll_n1)
2712 return NULL;
2715 lp->ll_tv = &lp->ll_li->li_tv;
2719 return p;
2723 * Clear lval "lp" that was filled by get_lval().
2725 static void
2726 clear_lval(lp)
2727 lval_T *lp;
2729 vim_free(lp->ll_exp_name);
2730 vim_free(lp->ll_newkey);
2734 * Set a variable that was parsed by get_lval() to "rettv".
2735 * "endp" points to just after the parsed name.
2736 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2738 static void
2739 set_var_lval(lp, endp, rettv, copy, op)
2740 lval_T *lp;
2741 char_u *endp;
2742 typval_T *rettv;
2743 int copy;
2744 char_u *op;
2746 int cc;
2747 listitem_T *ri;
2748 dictitem_T *di;
2750 if (lp->ll_tv == NULL)
2752 if (!check_changedtick(lp->ll_name))
2754 cc = *endp;
2755 *endp = NUL;
2756 if (op != NULL && *op != '=')
2758 typval_T tv;
2760 /* handle +=, -= and .= */
2761 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2762 &tv, TRUE) == OK)
2764 if (tv_op(&tv, rettv, op) == OK)
2765 set_var(lp->ll_name, &tv, FALSE);
2766 clear_tv(&tv);
2769 else
2770 set_var(lp->ll_name, rettv, copy);
2771 *endp = cc;
2774 else if (tv_check_lock(lp->ll_newkey == NULL
2775 ? lp->ll_tv->v_lock
2776 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2778 else if (lp->ll_range)
2781 * Assign the List values to the list items.
2783 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2785 if (op != NULL && *op != '=')
2786 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2787 else
2789 clear_tv(&lp->ll_li->li_tv);
2790 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2792 ri = ri->li_next;
2793 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2794 break;
2795 if (lp->ll_li->li_next == NULL)
2797 /* Need to add an empty item. */
2798 if (list_append_number(lp->ll_list, 0) == FAIL)
2800 ri = NULL;
2801 break;
2804 lp->ll_li = lp->ll_li->li_next;
2805 ++lp->ll_n1;
2807 if (ri != NULL)
2808 EMSG(_("E710: List value has more items than target"));
2809 else if (lp->ll_empty2
2810 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2811 : lp->ll_n1 != lp->ll_n2)
2812 EMSG(_("E711: List value has not enough items"));
2814 else
2817 * Assign to a List or Dictionary item.
2819 if (lp->ll_newkey != NULL)
2821 if (op != NULL && *op != '=')
2823 EMSG2(_(e_letwrong), op);
2824 return;
2827 /* Need to add an item to the Dictionary. */
2828 di = dictitem_alloc(lp->ll_newkey);
2829 if (di == NULL)
2830 return;
2831 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2833 vim_free(di);
2834 return;
2836 lp->ll_tv = &di->di_tv;
2838 else if (op != NULL && *op != '=')
2840 tv_op(lp->ll_tv, rettv, op);
2841 return;
2843 else
2844 clear_tv(lp->ll_tv);
2847 * Assign the value to the variable or list item.
2849 if (copy)
2850 copy_tv(rettv, lp->ll_tv);
2851 else
2853 *lp->ll_tv = *rettv;
2854 lp->ll_tv->v_lock = 0;
2855 init_tv(rettv);
2861 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2862 * Returns OK or FAIL.
2864 static int
2865 tv_op(tv1, tv2, op)
2866 typval_T *tv1;
2867 typval_T *tv2;
2868 char_u *op;
2870 long n;
2871 char_u numbuf[NUMBUFLEN];
2872 char_u *s;
2874 /* Can't do anything with a Funcref or a Dict on the right. */
2875 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2877 switch (tv1->v_type)
2879 case VAR_DICT:
2880 case VAR_FUNC:
2881 break;
2883 case VAR_LIST:
2884 if (*op != '+' || tv2->v_type != VAR_LIST)
2885 break;
2886 /* List += List */
2887 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2888 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2889 return OK;
2891 case VAR_NUMBER:
2892 case VAR_STRING:
2893 if (tv2->v_type == VAR_LIST)
2894 break;
2895 if (*op == '+' || *op == '-')
2897 /* nr += nr or nr -= nr*/
2898 n = get_tv_number(tv1);
2899 #ifdef FEAT_FLOAT
2900 if (tv2->v_type == VAR_FLOAT)
2902 float_T f = n;
2904 if (*op == '+')
2905 f += tv2->vval.v_float;
2906 else
2907 f -= tv2->vval.v_float;
2908 clear_tv(tv1);
2909 tv1->v_type = VAR_FLOAT;
2910 tv1->vval.v_float = f;
2912 else
2913 #endif
2915 if (*op == '+')
2916 n += get_tv_number(tv2);
2917 else
2918 n -= get_tv_number(tv2);
2919 clear_tv(tv1);
2920 tv1->v_type = VAR_NUMBER;
2921 tv1->vval.v_number = n;
2924 else
2926 if (tv2->v_type == VAR_FLOAT)
2927 break;
2929 /* str .= str */
2930 s = get_tv_string(tv1);
2931 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2932 clear_tv(tv1);
2933 tv1->v_type = VAR_STRING;
2934 tv1->vval.v_string = s;
2936 return OK;
2938 #ifdef FEAT_FLOAT
2939 case VAR_FLOAT:
2941 float_T f;
2943 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2944 && tv2->v_type != VAR_NUMBER
2945 && tv2->v_type != VAR_STRING))
2946 break;
2947 if (tv2->v_type == VAR_FLOAT)
2948 f = tv2->vval.v_float;
2949 else
2950 f = get_tv_number(tv2);
2951 if (*op == '+')
2952 tv1->vval.v_float += f;
2953 else
2954 tv1->vval.v_float -= f;
2956 return OK;
2957 #endif
2961 EMSG2(_(e_letwrong), op);
2962 return FAIL;
2966 * Add a watcher to a list.
2968 static void
2969 list_add_watch(l, lw)
2970 list_T *l;
2971 listwatch_T *lw;
2973 lw->lw_next = l->lv_watch;
2974 l->lv_watch = lw;
2978 * Remove a watcher from a list.
2979 * No warning when it isn't found...
2981 static void
2982 list_rem_watch(l, lwrem)
2983 list_T *l;
2984 listwatch_T *lwrem;
2986 listwatch_T *lw, **lwp;
2988 lwp = &l->lv_watch;
2989 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
2991 if (lw == lwrem)
2993 *lwp = lw->lw_next;
2994 break;
2996 lwp = &lw->lw_next;
3001 * Just before removing an item from a list: advance watchers to the next
3002 * item.
3004 static void
3005 list_fix_watch(l, item)
3006 list_T *l;
3007 listitem_T *item;
3009 listwatch_T *lw;
3011 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3012 if (lw->lw_item == item)
3013 lw->lw_item = item->li_next;
3017 * Evaluate the expression used in a ":for var in expr" command.
3018 * "arg" points to "var".
3019 * Set "*errp" to TRUE for an error, FALSE otherwise;
3020 * Return a pointer that holds the info. Null when there is an error.
3022 void *
3023 eval_for_line(arg, errp, nextcmdp, skip)
3024 char_u *arg;
3025 int *errp;
3026 char_u **nextcmdp;
3027 int skip;
3029 forinfo_T *fi;
3030 char_u *expr;
3031 typval_T tv;
3032 list_T *l;
3034 *errp = TRUE; /* default: there is an error */
3036 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3037 if (fi == NULL)
3038 return NULL;
3040 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3041 if (expr == NULL)
3042 return fi;
3044 expr = skipwhite(expr);
3045 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3047 EMSG(_("E690: Missing \"in\" after :for"));
3048 return fi;
3051 if (skip)
3052 ++emsg_skip;
3053 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3055 *errp = FALSE;
3056 if (!skip)
3058 l = tv.vval.v_list;
3059 if (tv.v_type != VAR_LIST || l == NULL)
3061 EMSG(_(e_listreq));
3062 clear_tv(&tv);
3064 else
3066 /* No need to increment the refcount, it's already set for the
3067 * list being used in "tv". */
3068 fi->fi_list = l;
3069 list_add_watch(l, &fi->fi_lw);
3070 fi->fi_lw.lw_item = l->lv_first;
3074 if (skip)
3075 --emsg_skip;
3077 return fi;
3081 * Use the first item in a ":for" list. Advance to the next.
3082 * Assign the values to the variable (list). "arg" points to the first one.
3083 * Return TRUE when a valid item was found, FALSE when at end of list or
3084 * something wrong.
3087 next_for_item(fi_void, arg)
3088 void *fi_void;
3089 char_u *arg;
3091 forinfo_T *fi = (forinfo_T *)fi_void;
3092 int result;
3093 listitem_T *item;
3095 item = fi->fi_lw.lw_item;
3096 if (item == NULL)
3097 result = FALSE;
3098 else
3100 fi->fi_lw.lw_item = item->li_next;
3101 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3102 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3104 return result;
3108 * Free the structure used to store info used by ":for".
3110 void
3111 free_for_info(fi_void)
3112 void *fi_void;
3114 forinfo_T *fi = (forinfo_T *)fi_void;
3116 if (fi != NULL && fi->fi_list != NULL)
3118 list_rem_watch(fi->fi_list, &fi->fi_lw);
3119 list_unref(fi->fi_list);
3121 vim_free(fi);
3124 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3126 void
3127 set_context_for_expression(xp, arg, cmdidx)
3128 expand_T *xp;
3129 char_u *arg;
3130 cmdidx_T cmdidx;
3132 int got_eq = FALSE;
3133 int c;
3134 char_u *p;
3136 if (cmdidx == CMD_let)
3138 xp->xp_context = EXPAND_USER_VARS;
3139 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3141 /* ":let var1 var2 ...": find last space. */
3142 for (p = arg + STRLEN(arg); p >= arg; )
3144 xp->xp_pattern = p;
3145 mb_ptr_back(arg, p);
3146 if (vim_iswhite(*p))
3147 break;
3149 return;
3152 else
3153 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3154 : EXPAND_EXPRESSION;
3155 while ((xp->xp_pattern = vim_strpbrk(arg,
3156 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3158 c = *xp->xp_pattern;
3159 if (c == '&')
3161 c = xp->xp_pattern[1];
3162 if (c == '&')
3164 ++xp->xp_pattern;
3165 xp->xp_context = cmdidx != CMD_let || got_eq
3166 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3168 else if (c != ' ')
3170 xp->xp_context = EXPAND_SETTINGS;
3171 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3172 xp->xp_pattern += 2;
3176 else if (c == '$')
3178 /* environment variable */
3179 xp->xp_context = EXPAND_ENV_VARS;
3181 else if (c == '=')
3183 got_eq = TRUE;
3184 xp->xp_context = EXPAND_EXPRESSION;
3186 else if (c == '<'
3187 && xp->xp_context == EXPAND_FUNCTIONS
3188 && vim_strchr(xp->xp_pattern, '(') == NULL)
3190 /* Function name can start with "<SNR>" */
3191 break;
3193 else if (cmdidx != CMD_let || got_eq)
3195 if (c == '"') /* string */
3197 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3198 if (c == '\\' && xp->xp_pattern[1] != NUL)
3199 ++xp->xp_pattern;
3200 xp->xp_context = EXPAND_NOTHING;
3202 else if (c == '\'') /* literal string */
3204 /* Trick: '' is like stopping and starting a literal string. */
3205 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3206 /* skip */ ;
3207 xp->xp_context = EXPAND_NOTHING;
3209 else if (c == '|')
3211 if (xp->xp_pattern[1] == '|')
3213 ++xp->xp_pattern;
3214 xp->xp_context = EXPAND_EXPRESSION;
3216 else
3217 xp->xp_context = EXPAND_COMMANDS;
3219 else
3220 xp->xp_context = EXPAND_EXPRESSION;
3222 else
3223 /* Doesn't look like something valid, expand as an expression
3224 * anyway. */
3225 xp->xp_context = EXPAND_EXPRESSION;
3226 arg = xp->xp_pattern;
3227 if (*arg != NUL)
3228 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3229 /* skip */ ;
3231 xp->xp_pattern = arg;
3234 #endif /* FEAT_CMDL_COMPL */
3237 * ":1,25call func(arg1, arg2)" function call.
3239 void
3240 ex_call(eap)
3241 exarg_T *eap;
3243 char_u *arg = eap->arg;
3244 char_u *startarg;
3245 char_u *name;
3246 char_u *tofree;
3247 int len;
3248 typval_T rettv;
3249 linenr_T lnum;
3250 int doesrange;
3251 int failed = FALSE;
3252 funcdict_T fudi;
3254 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3255 if (fudi.fd_newkey != NULL)
3257 /* Still need to give an error message for missing key. */
3258 EMSG2(_(e_dictkey), fudi.fd_newkey);
3259 vim_free(fudi.fd_newkey);
3261 if (tofree == NULL)
3262 return;
3264 /* Increase refcount on dictionary, it could get deleted when evaluating
3265 * the arguments. */
3266 if (fudi.fd_dict != NULL)
3267 ++fudi.fd_dict->dv_refcount;
3269 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3270 len = (int)STRLEN(tofree);
3271 name = deref_func_name(tofree, &len);
3273 /* Skip white space to allow ":call func ()". Not good, but required for
3274 * backward compatibility. */
3275 startarg = skipwhite(arg);
3276 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3278 if (*startarg != '(')
3280 EMSG2(_("E107: Missing braces: %s"), eap->arg);
3281 goto end;
3285 * When skipping, evaluate the function once, to find the end of the
3286 * arguments.
3287 * When the function takes a range, this is discovered after the first
3288 * call, and the loop is broken.
3290 if (eap->skip)
3292 ++emsg_skip;
3293 lnum = eap->line2; /* do it once, also with an invalid range */
3295 else
3296 lnum = eap->line1;
3297 for ( ; lnum <= eap->line2; ++lnum)
3299 if (!eap->skip && eap->addr_count > 0)
3301 curwin->w_cursor.lnum = lnum;
3302 curwin->w_cursor.col = 0;
3304 arg = startarg;
3305 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3306 eap->line1, eap->line2, &doesrange,
3307 !eap->skip, fudi.fd_dict) == FAIL)
3309 failed = TRUE;
3310 break;
3313 /* Handle a function returning a Funcref, Dictionary or List. */
3314 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3316 failed = TRUE;
3317 break;
3320 clear_tv(&rettv);
3321 if (doesrange || eap->skip)
3322 break;
3324 /* Stop when immediately aborting on error, or when an interrupt
3325 * occurred or an exception was thrown but not caught.
3326 * get_func_tv() returned OK, so that the check for trailing
3327 * characters below is executed. */
3328 if (aborting())
3329 break;
3331 if (eap->skip)
3332 --emsg_skip;
3334 if (!failed)
3336 /* Check for trailing illegal characters and a following command. */
3337 if (!ends_excmd(*arg))
3339 emsg_severe = TRUE;
3340 EMSG(_(e_trailing));
3342 else
3343 eap->nextcmd = check_nextcmd(arg);
3346 end:
3347 dict_unref(fudi.fd_dict);
3348 vim_free(tofree);
3352 * ":unlet[!] var1 ... " command.
3354 void
3355 ex_unlet(eap)
3356 exarg_T *eap;
3358 ex_unletlock(eap, eap->arg, 0);
3362 * ":lockvar" and ":unlockvar" commands
3364 void
3365 ex_lockvar(eap)
3366 exarg_T *eap;
3368 char_u *arg = eap->arg;
3369 int deep = 2;
3371 if (eap->forceit)
3372 deep = -1;
3373 else if (vim_isdigit(*arg))
3375 deep = getdigits(&arg);
3376 arg = skipwhite(arg);
3379 ex_unletlock(eap, arg, deep);
3383 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3385 static void
3386 ex_unletlock(eap, argstart, deep)
3387 exarg_T *eap;
3388 char_u *argstart;
3389 int deep;
3391 char_u *arg = argstart;
3392 char_u *name_end;
3393 int error = FALSE;
3394 lval_T lv;
3398 /* Parse the name and find the end. */
3399 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3400 FNE_CHECK_START);
3401 if (lv.ll_name == NULL)
3402 error = TRUE; /* error but continue parsing */
3403 if (name_end == NULL || (!vim_iswhite(*name_end)
3404 && !ends_excmd(*name_end)))
3406 if (name_end != NULL)
3408 emsg_severe = TRUE;
3409 EMSG(_(e_trailing));
3411 if (!(eap->skip || error))
3412 clear_lval(&lv);
3413 break;
3416 if (!error && !eap->skip)
3418 if (eap->cmdidx == CMD_unlet)
3420 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3421 error = TRUE;
3423 else
3425 if (do_lock_var(&lv, name_end, deep,
3426 eap->cmdidx == CMD_lockvar) == FAIL)
3427 error = TRUE;
3431 if (!eap->skip)
3432 clear_lval(&lv);
3434 arg = skipwhite(name_end);
3435 } while (!ends_excmd(*arg));
3437 eap->nextcmd = check_nextcmd(arg);
3440 static int
3441 do_unlet_var(lp, name_end, forceit)
3442 lval_T *lp;
3443 char_u *name_end;
3444 int forceit;
3446 int ret = OK;
3447 int cc;
3449 if (lp->ll_tv == NULL)
3451 cc = *name_end;
3452 *name_end = NUL;
3454 /* Normal name or expanded name. */
3455 if (check_changedtick(lp->ll_name))
3456 ret = FAIL;
3457 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3458 ret = FAIL;
3459 *name_end = cc;
3461 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3462 return FAIL;
3463 else if (lp->ll_range)
3465 listitem_T *li;
3467 /* Delete a range of List items. */
3468 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3470 li = lp->ll_li->li_next;
3471 listitem_remove(lp->ll_list, lp->ll_li);
3472 lp->ll_li = li;
3473 ++lp->ll_n1;
3476 else
3478 if (lp->ll_list != NULL)
3479 /* unlet a List item. */
3480 listitem_remove(lp->ll_list, lp->ll_li);
3481 else
3482 /* unlet a Dictionary item. */
3483 dictitem_remove(lp->ll_dict, lp->ll_di);
3486 return ret;
3490 * "unlet" a variable. Return OK if it existed, FAIL if not.
3491 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3494 do_unlet(name, forceit)
3495 char_u *name;
3496 int forceit;
3498 hashtab_T *ht;
3499 hashitem_T *hi;
3500 char_u *varname;
3501 dictitem_T *di;
3503 ht = find_var_ht(name, &varname);
3504 if (ht != NULL && *varname != NUL)
3506 hi = hash_find(ht, varname);
3507 if (!HASHITEM_EMPTY(hi))
3509 di = HI2DI(hi);
3510 if (var_check_fixed(di->di_flags, name)
3511 || var_check_ro(di->di_flags, name))
3512 return FAIL;
3513 delete_var(ht, hi);
3514 return OK;
3517 if (forceit)
3518 return OK;
3519 EMSG2(_("E108: No such variable: \"%s\""), name);
3520 return FAIL;
3524 * Lock or unlock variable indicated by "lp".
3525 * "deep" is the levels to go (-1 for unlimited);
3526 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3528 static int
3529 do_lock_var(lp, name_end, deep, lock)
3530 lval_T *lp;
3531 char_u *name_end;
3532 int deep;
3533 int lock;
3535 int ret = OK;
3536 int cc;
3537 dictitem_T *di;
3539 if (deep == 0) /* nothing to do */
3540 return OK;
3542 if (lp->ll_tv == NULL)
3544 cc = *name_end;
3545 *name_end = NUL;
3547 /* Normal name or expanded name. */
3548 if (check_changedtick(lp->ll_name))
3549 ret = FAIL;
3550 else
3552 di = find_var(lp->ll_name, NULL);
3553 if (di == NULL)
3554 ret = FAIL;
3555 else
3557 if (lock)
3558 di->di_flags |= DI_FLAGS_LOCK;
3559 else
3560 di->di_flags &= ~DI_FLAGS_LOCK;
3561 item_lock(&di->di_tv, deep, lock);
3564 *name_end = cc;
3566 else if (lp->ll_range)
3568 listitem_T *li = lp->ll_li;
3570 /* (un)lock a range of List items. */
3571 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3573 item_lock(&li->li_tv, deep, lock);
3574 li = li->li_next;
3575 ++lp->ll_n1;
3578 else if (lp->ll_list != NULL)
3579 /* (un)lock a List item. */
3580 item_lock(&lp->ll_li->li_tv, deep, lock);
3581 else
3582 /* un(lock) a Dictionary item. */
3583 item_lock(&lp->ll_di->di_tv, deep, lock);
3585 return ret;
3589 * Lock or unlock an item. "deep" is nr of levels to go.
3591 static void
3592 item_lock(tv, deep, lock)
3593 typval_T *tv;
3594 int deep;
3595 int lock;
3597 static int recurse = 0;
3598 list_T *l;
3599 listitem_T *li;
3600 dict_T *d;
3601 hashitem_T *hi;
3602 int todo;
3604 if (recurse >= DICT_MAXNEST)
3606 EMSG(_("E743: variable nested too deep for (un)lock"));
3607 return;
3609 if (deep == 0)
3610 return;
3611 ++recurse;
3613 /* lock/unlock the item itself */
3614 if (lock)
3615 tv->v_lock |= VAR_LOCKED;
3616 else
3617 tv->v_lock &= ~VAR_LOCKED;
3619 switch (tv->v_type)
3621 case VAR_LIST:
3622 if ((l = tv->vval.v_list) != NULL)
3624 if (lock)
3625 l->lv_lock |= VAR_LOCKED;
3626 else
3627 l->lv_lock &= ~VAR_LOCKED;
3628 if (deep < 0 || deep > 1)
3629 /* recursive: lock/unlock the items the List contains */
3630 for (li = l->lv_first; li != NULL; li = li->li_next)
3631 item_lock(&li->li_tv, deep - 1, lock);
3633 break;
3634 case VAR_DICT:
3635 if ((d = tv->vval.v_dict) != NULL)
3637 if (lock)
3638 d->dv_lock |= VAR_LOCKED;
3639 else
3640 d->dv_lock &= ~VAR_LOCKED;
3641 if (deep < 0 || deep > 1)
3643 /* recursive: lock/unlock the items the List contains */
3644 todo = (int)d->dv_hashtab.ht_used;
3645 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3647 if (!HASHITEM_EMPTY(hi))
3649 --todo;
3650 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3656 --recurse;
3660 * Return TRUE if typeval "tv" is locked: Either tha value is locked itself or
3661 * it refers to a List or Dictionary that is locked.
3663 static int
3664 tv_islocked(tv)
3665 typval_T *tv;
3667 return (tv->v_lock & VAR_LOCKED)
3668 || (tv->v_type == VAR_LIST
3669 && tv->vval.v_list != NULL
3670 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3671 || (tv->v_type == VAR_DICT
3672 && tv->vval.v_dict != NULL
3673 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3676 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3678 * Delete all "menutrans_" variables.
3680 void
3681 del_menutrans_vars()
3683 hashitem_T *hi;
3684 int todo;
3686 hash_lock(&globvarht);
3687 todo = (int)globvarht.ht_used;
3688 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3690 if (!HASHITEM_EMPTY(hi))
3692 --todo;
3693 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3694 delete_var(&globvarht, hi);
3697 hash_unlock(&globvarht);
3699 #endif
3701 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3704 * Local string buffer for the next two functions to store a variable name
3705 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3706 * get_user_var_name().
3709 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3711 static char_u *varnamebuf = NULL;
3712 static int varnamebuflen = 0;
3715 * Function to concatenate a prefix and a variable name.
3717 static char_u *
3718 cat_prefix_varname(prefix, name)
3719 int prefix;
3720 char_u *name;
3722 int len;
3724 len = (int)STRLEN(name) + 3;
3725 if (len > varnamebuflen)
3727 vim_free(varnamebuf);
3728 len += 10; /* some additional space */
3729 varnamebuf = alloc(len);
3730 if (varnamebuf == NULL)
3732 varnamebuflen = 0;
3733 return NULL;
3735 varnamebuflen = len;
3737 *varnamebuf = prefix;
3738 varnamebuf[1] = ':';
3739 STRCPY(varnamebuf + 2, name);
3740 return varnamebuf;
3744 * Function given to ExpandGeneric() to obtain the list of user defined
3745 * (global/buffer/window/built-in) variable names.
3747 /*ARGSUSED*/
3748 char_u *
3749 get_user_var_name(xp, idx)
3750 expand_T *xp;
3751 int idx;
3753 static long_u gdone;
3754 static long_u bdone;
3755 static long_u wdone;
3756 #ifdef FEAT_WINDOWS
3757 static long_u tdone;
3758 #endif
3759 static int vidx;
3760 static hashitem_T *hi;
3761 hashtab_T *ht;
3763 if (idx == 0)
3765 gdone = bdone = wdone = vidx = 0;
3766 #ifdef FEAT_WINDOWS
3767 tdone = 0;
3768 #endif
3771 /* Global variables */
3772 if (gdone < globvarht.ht_used)
3774 if (gdone++ == 0)
3775 hi = globvarht.ht_array;
3776 else
3777 ++hi;
3778 while (HASHITEM_EMPTY(hi))
3779 ++hi;
3780 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3781 return cat_prefix_varname('g', hi->hi_key);
3782 return hi->hi_key;
3785 /* b: variables */
3786 ht = &curbuf->b_vars.dv_hashtab;
3787 if (bdone < ht->ht_used)
3789 if (bdone++ == 0)
3790 hi = ht->ht_array;
3791 else
3792 ++hi;
3793 while (HASHITEM_EMPTY(hi))
3794 ++hi;
3795 return cat_prefix_varname('b', hi->hi_key);
3797 if (bdone == ht->ht_used)
3799 ++bdone;
3800 return (char_u *)"b:changedtick";
3803 /* w: variables */
3804 ht = &curwin->w_vars.dv_hashtab;
3805 if (wdone < ht->ht_used)
3807 if (wdone++ == 0)
3808 hi = ht->ht_array;
3809 else
3810 ++hi;
3811 while (HASHITEM_EMPTY(hi))
3812 ++hi;
3813 return cat_prefix_varname('w', hi->hi_key);
3816 #ifdef FEAT_WINDOWS
3817 /* t: variables */
3818 ht = &curtab->tp_vars.dv_hashtab;
3819 if (tdone < ht->ht_used)
3821 if (tdone++ == 0)
3822 hi = ht->ht_array;
3823 else
3824 ++hi;
3825 while (HASHITEM_EMPTY(hi))
3826 ++hi;
3827 return cat_prefix_varname('t', hi->hi_key);
3829 #endif
3831 /* v: variables */
3832 if (vidx < VV_LEN)
3833 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3835 vim_free(varnamebuf);
3836 varnamebuf = NULL;
3837 varnamebuflen = 0;
3838 return NULL;
3841 #endif /* FEAT_CMDL_COMPL */
3844 * types for expressions.
3846 typedef enum
3848 TYPE_UNKNOWN = 0
3849 , TYPE_EQUAL /* == */
3850 , TYPE_NEQUAL /* != */
3851 , TYPE_GREATER /* > */
3852 , TYPE_GEQUAL /* >= */
3853 , TYPE_SMALLER /* < */
3854 , TYPE_SEQUAL /* <= */
3855 , TYPE_MATCH /* =~ */
3856 , TYPE_NOMATCH /* !~ */
3857 } exptype_T;
3860 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3861 * executed. The function may return OK, but the rettv will be of type
3862 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3866 * Handle zero level expression.
3867 * This calls eval1() and handles error message and nextcmd.
3868 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3869 * Note: "rettv.v_lock" is not set.
3870 * Return OK or FAIL.
3872 static int
3873 eval0(arg, rettv, nextcmd, evaluate)
3874 char_u *arg;
3875 typval_T *rettv;
3876 char_u **nextcmd;
3877 int evaluate;
3879 int ret;
3880 char_u *p;
3882 p = skipwhite(arg);
3883 ret = eval1(&p, rettv, evaluate);
3884 if (ret == FAIL || !ends_excmd(*p))
3886 if (ret != FAIL)
3887 clear_tv(rettv);
3889 * Report the invalid expression unless the expression evaluation has
3890 * been cancelled due to an aborting error, an interrupt, or an
3891 * exception.
3893 if (!aborting())
3894 EMSG2(_(e_invexpr2), arg);
3895 ret = FAIL;
3897 if (nextcmd != NULL)
3898 *nextcmd = check_nextcmd(p);
3900 return ret;
3904 * Handle top level expression:
3905 * expr1 ? expr0 : expr0
3907 * "arg" must point to the first non-white of the expression.
3908 * "arg" is advanced to the next non-white after the recognized expression.
3910 * Note: "rettv.v_lock" is not set.
3912 * Return OK or FAIL.
3914 static int
3915 eval1(arg, rettv, evaluate)
3916 char_u **arg;
3917 typval_T *rettv;
3918 int evaluate;
3920 int result;
3921 typval_T var2;
3924 * Get the first variable.
3926 if (eval2(arg, rettv, evaluate) == FAIL)
3927 return FAIL;
3929 if ((*arg)[0] == '?')
3931 result = FALSE;
3932 if (evaluate)
3934 int error = FALSE;
3936 if (get_tv_number_chk(rettv, &error) != 0)
3937 result = TRUE;
3938 clear_tv(rettv);
3939 if (error)
3940 return FAIL;
3944 * Get the second variable.
3946 *arg = skipwhite(*arg + 1);
3947 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3948 return FAIL;
3951 * Check for the ":".
3953 if ((*arg)[0] != ':')
3955 EMSG(_("E109: Missing ':' after '?'"));
3956 if (evaluate && result)
3957 clear_tv(rettv);
3958 return FAIL;
3962 * Get the third variable.
3964 *arg = skipwhite(*arg + 1);
3965 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
3967 if (evaluate && result)
3968 clear_tv(rettv);
3969 return FAIL;
3971 if (evaluate && !result)
3972 *rettv = var2;
3975 return OK;
3979 * Handle first level expression:
3980 * expr2 || expr2 || expr2 logical OR
3982 * "arg" must point to the first non-white of the expression.
3983 * "arg" is advanced to the next non-white after the recognized expression.
3985 * Return OK or FAIL.
3987 static int
3988 eval2(arg, rettv, evaluate)
3989 char_u **arg;
3990 typval_T *rettv;
3991 int evaluate;
3993 typval_T var2;
3994 long result;
3995 int first;
3996 int error = FALSE;
3999 * Get the first variable.
4001 if (eval3(arg, rettv, evaluate) == FAIL)
4002 return FAIL;
4005 * Repeat until there is no following "||".
4007 first = TRUE;
4008 result = FALSE;
4009 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4011 if (evaluate && first)
4013 if (get_tv_number_chk(rettv, &error) != 0)
4014 result = TRUE;
4015 clear_tv(rettv);
4016 if (error)
4017 return FAIL;
4018 first = FALSE;
4022 * Get the second variable.
4024 *arg = skipwhite(*arg + 2);
4025 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4026 return FAIL;
4029 * Compute the result.
4031 if (evaluate && !result)
4033 if (get_tv_number_chk(&var2, &error) != 0)
4034 result = TRUE;
4035 clear_tv(&var2);
4036 if (error)
4037 return FAIL;
4039 if (evaluate)
4041 rettv->v_type = VAR_NUMBER;
4042 rettv->vval.v_number = result;
4046 return OK;
4050 * Handle second level expression:
4051 * expr3 && expr3 && expr3 logical AND
4053 * "arg" must point to the first non-white of the expression.
4054 * "arg" is advanced to the next non-white after the recognized expression.
4056 * Return OK or FAIL.
4058 static int
4059 eval3(arg, rettv, evaluate)
4060 char_u **arg;
4061 typval_T *rettv;
4062 int evaluate;
4064 typval_T var2;
4065 long result;
4066 int first;
4067 int error = FALSE;
4070 * Get the first variable.
4072 if (eval4(arg, rettv, evaluate) == FAIL)
4073 return FAIL;
4076 * Repeat until there is no following "&&".
4078 first = TRUE;
4079 result = TRUE;
4080 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4082 if (evaluate && first)
4084 if (get_tv_number_chk(rettv, &error) == 0)
4085 result = FALSE;
4086 clear_tv(rettv);
4087 if (error)
4088 return FAIL;
4089 first = FALSE;
4093 * Get the second variable.
4095 *arg = skipwhite(*arg + 2);
4096 if (eval4(arg, &var2, evaluate && result) == FAIL)
4097 return FAIL;
4100 * Compute the result.
4102 if (evaluate && result)
4104 if (get_tv_number_chk(&var2, &error) == 0)
4105 result = FALSE;
4106 clear_tv(&var2);
4107 if (error)
4108 return FAIL;
4110 if (evaluate)
4112 rettv->v_type = VAR_NUMBER;
4113 rettv->vval.v_number = result;
4117 return OK;
4121 * Handle third level expression:
4122 * var1 == var2
4123 * var1 =~ var2
4124 * var1 != var2
4125 * var1 !~ var2
4126 * var1 > var2
4127 * var1 >= var2
4128 * var1 < var2
4129 * var1 <= var2
4130 * var1 is var2
4131 * var1 isnot var2
4133 * "arg" must point to the first non-white of the expression.
4134 * "arg" is advanced to the next non-white after the recognized expression.
4136 * Return OK or FAIL.
4138 static int
4139 eval4(arg, rettv, evaluate)
4140 char_u **arg;
4141 typval_T *rettv;
4142 int evaluate;
4144 typval_T var2;
4145 char_u *p;
4146 int i;
4147 exptype_T type = TYPE_UNKNOWN;
4148 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4149 int len = 2;
4150 long n1, n2;
4151 char_u *s1, *s2;
4152 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4153 regmatch_T regmatch;
4154 int ic;
4155 char_u *save_cpo;
4158 * Get the first variable.
4160 if (eval5(arg, rettv, evaluate) == FAIL)
4161 return FAIL;
4163 p = *arg;
4164 switch (p[0])
4166 case '=': if (p[1] == '=')
4167 type = TYPE_EQUAL;
4168 else if (p[1] == '~')
4169 type = TYPE_MATCH;
4170 break;
4171 case '!': if (p[1] == '=')
4172 type = TYPE_NEQUAL;
4173 else if (p[1] == '~')
4174 type = TYPE_NOMATCH;
4175 break;
4176 case '>': if (p[1] != '=')
4178 type = TYPE_GREATER;
4179 len = 1;
4181 else
4182 type = TYPE_GEQUAL;
4183 break;
4184 case '<': if (p[1] != '=')
4186 type = TYPE_SMALLER;
4187 len = 1;
4189 else
4190 type = TYPE_SEQUAL;
4191 break;
4192 case 'i': if (p[1] == 's')
4194 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4195 len = 5;
4196 if (!vim_isIDc(p[len]))
4198 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4199 type_is = TRUE;
4202 break;
4206 * If there is a comparative operator, use it.
4208 if (type != TYPE_UNKNOWN)
4210 /* extra question mark appended: ignore case */
4211 if (p[len] == '?')
4213 ic = TRUE;
4214 ++len;
4216 /* extra '#' appended: match case */
4217 else if (p[len] == '#')
4219 ic = FALSE;
4220 ++len;
4222 /* nothing appended: use 'ignorecase' */
4223 else
4224 ic = p_ic;
4227 * Get the second variable.
4229 *arg = skipwhite(p + len);
4230 if (eval5(arg, &var2, evaluate) == FAIL)
4232 clear_tv(rettv);
4233 return FAIL;
4236 if (evaluate)
4238 if (type_is && rettv->v_type != var2.v_type)
4240 /* For "is" a different type always means FALSE, for "notis"
4241 * it means TRUE. */
4242 n1 = (type == TYPE_NEQUAL);
4244 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4246 if (type_is)
4248 n1 = (rettv->v_type == var2.v_type
4249 && rettv->vval.v_list == var2.vval.v_list);
4250 if (type == TYPE_NEQUAL)
4251 n1 = !n1;
4253 else if (rettv->v_type != var2.v_type
4254 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4256 if (rettv->v_type != var2.v_type)
4257 EMSG(_("E691: Can only compare List with List"));
4258 else
4259 EMSG(_("E692: Invalid operation for Lists"));
4260 clear_tv(rettv);
4261 clear_tv(&var2);
4262 return FAIL;
4264 else
4266 /* Compare two Lists for being equal or unequal. */
4267 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4268 if (type == TYPE_NEQUAL)
4269 n1 = !n1;
4273 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4275 if (type_is)
4277 n1 = (rettv->v_type == var2.v_type
4278 && rettv->vval.v_dict == var2.vval.v_dict);
4279 if (type == TYPE_NEQUAL)
4280 n1 = !n1;
4282 else if (rettv->v_type != var2.v_type
4283 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4285 if (rettv->v_type != var2.v_type)
4286 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4287 else
4288 EMSG(_("E736: Invalid operation for Dictionary"));
4289 clear_tv(rettv);
4290 clear_tv(&var2);
4291 return FAIL;
4293 else
4295 /* Compare two Dictionaries for being equal or unequal. */
4296 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4297 if (type == TYPE_NEQUAL)
4298 n1 = !n1;
4302 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4304 if (rettv->v_type != var2.v_type
4305 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4307 if (rettv->v_type != var2.v_type)
4308 EMSG(_("E693: Can only compare Funcref with Funcref"));
4309 else
4310 EMSG(_("E694: Invalid operation for Funcrefs"));
4311 clear_tv(rettv);
4312 clear_tv(&var2);
4313 return FAIL;
4315 else
4317 /* Compare two Funcrefs for being equal or unequal. */
4318 if (rettv->vval.v_string == NULL
4319 || var2.vval.v_string == NULL)
4320 n1 = FALSE;
4321 else
4322 n1 = STRCMP(rettv->vval.v_string,
4323 var2.vval.v_string) == 0;
4324 if (type == TYPE_NEQUAL)
4325 n1 = !n1;
4329 #ifdef FEAT_FLOAT
4331 * If one of the two variables is a float, compare as a float.
4332 * When using "=~" or "!~", always compare as string.
4334 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4335 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4337 float_T f1, f2;
4339 if (rettv->v_type == VAR_FLOAT)
4340 f1 = rettv->vval.v_float;
4341 else
4342 f1 = get_tv_number(rettv);
4343 if (var2.v_type == VAR_FLOAT)
4344 f2 = var2.vval.v_float;
4345 else
4346 f2 = get_tv_number(&var2);
4347 n1 = FALSE;
4348 switch (type)
4350 case TYPE_EQUAL: n1 = (f1 == f2); break;
4351 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4352 case TYPE_GREATER: n1 = (f1 > f2); break;
4353 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4354 case TYPE_SMALLER: n1 = (f1 < f2); break;
4355 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4356 case TYPE_UNKNOWN:
4357 case TYPE_MATCH:
4358 case TYPE_NOMATCH: break; /* avoid gcc warning */
4361 #endif
4364 * If one of the two variables is a number, compare as a number.
4365 * When using "=~" or "!~", always compare as string.
4367 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4368 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4370 n1 = get_tv_number(rettv);
4371 n2 = get_tv_number(&var2);
4372 switch (type)
4374 case TYPE_EQUAL: n1 = (n1 == n2); break;
4375 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4376 case TYPE_GREATER: n1 = (n1 > n2); break;
4377 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4378 case TYPE_SMALLER: n1 = (n1 < n2); break;
4379 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4380 case TYPE_UNKNOWN:
4381 case TYPE_MATCH:
4382 case TYPE_NOMATCH: break; /* avoid gcc warning */
4385 else
4387 s1 = get_tv_string_buf(rettv, buf1);
4388 s2 = get_tv_string_buf(&var2, buf2);
4389 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4390 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4391 else
4392 i = 0;
4393 n1 = FALSE;
4394 switch (type)
4396 case TYPE_EQUAL: n1 = (i == 0); break;
4397 case TYPE_NEQUAL: n1 = (i != 0); break;
4398 case TYPE_GREATER: n1 = (i > 0); break;
4399 case TYPE_GEQUAL: n1 = (i >= 0); break;
4400 case TYPE_SMALLER: n1 = (i < 0); break;
4401 case TYPE_SEQUAL: n1 = (i <= 0); break;
4403 case TYPE_MATCH:
4404 case TYPE_NOMATCH:
4405 /* avoid 'l' flag in 'cpoptions' */
4406 save_cpo = p_cpo;
4407 p_cpo = (char_u *)"";
4408 regmatch.regprog = vim_regcomp(s2,
4409 RE_MAGIC + RE_STRING);
4410 regmatch.rm_ic = ic;
4411 if (regmatch.regprog != NULL)
4413 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4414 vim_free(regmatch.regprog);
4415 if (type == TYPE_NOMATCH)
4416 n1 = !n1;
4418 p_cpo = save_cpo;
4419 break;
4421 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4424 clear_tv(rettv);
4425 clear_tv(&var2);
4426 rettv->v_type = VAR_NUMBER;
4427 rettv->vval.v_number = n1;
4431 return OK;
4435 * Handle fourth level expression:
4436 * + number addition
4437 * - number subtraction
4438 * . string concatenation
4440 * "arg" must point to the first non-white of the expression.
4441 * "arg" is advanced to the next non-white after the recognized expression.
4443 * Return OK or FAIL.
4445 static int
4446 eval5(arg, rettv, evaluate)
4447 char_u **arg;
4448 typval_T *rettv;
4449 int evaluate;
4451 typval_T var2;
4452 typval_T var3;
4453 int op;
4454 long n1, n2;
4455 #ifdef FEAT_FLOAT
4456 float_T f1 = 0, f2 = 0;
4457 #endif
4458 char_u *s1, *s2;
4459 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4460 char_u *p;
4463 * Get the first variable.
4465 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4466 return FAIL;
4469 * Repeat computing, until no '+', '-' or '.' is following.
4471 for (;;)
4473 op = **arg;
4474 if (op != '+' && op != '-' && op != '.')
4475 break;
4477 if ((op != '+' || rettv->v_type != VAR_LIST)
4478 #ifdef FEAT_FLOAT
4479 && (op == '.' || rettv->v_type != VAR_FLOAT)
4480 #endif
4483 /* For "list + ...", an illegal use of the first operand as
4484 * a number cannot be determined before evaluating the 2nd
4485 * operand: if this is also a list, all is ok.
4486 * For "something . ...", "something - ..." or "non-list + ...",
4487 * we know that the first operand needs to be a string or number
4488 * without evaluating the 2nd operand. So check before to avoid
4489 * side effects after an error. */
4490 if (evaluate && get_tv_string_chk(rettv) == NULL)
4492 clear_tv(rettv);
4493 return FAIL;
4498 * Get the second variable.
4500 *arg = skipwhite(*arg + 1);
4501 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4503 clear_tv(rettv);
4504 return FAIL;
4507 if (evaluate)
4510 * Compute the result.
4512 if (op == '.')
4514 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4515 s2 = get_tv_string_buf_chk(&var2, buf2);
4516 if (s2 == NULL) /* type error ? */
4518 clear_tv(rettv);
4519 clear_tv(&var2);
4520 return FAIL;
4522 p = concat_str(s1, s2);
4523 clear_tv(rettv);
4524 rettv->v_type = VAR_STRING;
4525 rettv->vval.v_string = p;
4527 else if (op == '+' && rettv->v_type == VAR_LIST
4528 && var2.v_type == VAR_LIST)
4530 /* concatenate Lists */
4531 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4532 &var3) == FAIL)
4534 clear_tv(rettv);
4535 clear_tv(&var2);
4536 return FAIL;
4538 clear_tv(rettv);
4539 *rettv = var3;
4541 else
4543 int error = FALSE;
4545 #ifdef FEAT_FLOAT
4546 if (rettv->v_type == VAR_FLOAT)
4548 f1 = rettv->vval.v_float;
4549 n1 = 0;
4551 else
4552 #endif
4554 n1 = get_tv_number_chk(rettv, &error);
4555 if (error)
4557 /* This can only happen for "list + non-list". For
4558 * "non-list + ..." or "something - ...", we returned
4559 * before evaluating the 2nd operand. */
4560 clear_tv(rettv);
4561 return FAIL;
4563 #ifdef FEAT_FLOAT
4564 if (var2.v_type == VAR_FLOAT)
4565 f1 = n1;
4566 #endif
4568 #ifdef FEAT_FLOAT
4569 if (var2.v_type == VAR_FLOAT)
4571 f2 = var2.vval.v_float;
4572 n2 = 0;
4574 else
4575 #endif
4577 n2 = get_tv_number_chk(&var2, &error);
4578 if (error)
4580 clear_tv(rettv);
4581 clear_tv(&var2);
4582 return FAIL;
4584 #ifdef FEAT_FLOAT
4585 if (rettv->v_type == VAR_FLOAT)
4586 f2 = n2;
4587 #endif
4589 clear_tv(rettv);
4591 #ifdef FEAT_FLOAT
4592 /* If there is a float on either side the result is a float. */
4593 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4595 if (op == '+')
4596 f1 = f1 + f2;
4597 else
4598 f1 = f1 - f2;
4599 rettv->v_type = VAR_FLOAT;
4600 rettv->vval.v_float = f1;
4602 else
4603 #endif
4605 if (op == '+')
4606 n1 = n1 + n2;
4607 else
4608 n1 = n1 - n2;
4609 rettv->v_type = VAR_NUMBER;
4610 rettv->vval.v_number = n1;
4613 clear_tv(&var2);
4616 return OK;
4620 * Handle fifth level expression:
4621 * * number multiplication
4622 * / number division
4623 * % number modulo
4625 * "arg" must point to the first non-white of the expression.
4626 * "arg" is advanced to the next non-white after the recognized expression.
4628 * Return OK or FAIL.
4630 static int
4631 eval6(arg, rettv, evaluate, want_string)
4632 char_u **arg;
4633 typval_T *rettv;
4634 int evaluate;
4635 int want_string; /* after "." operator */
4637 typval_T var2;
4638 int op;
4639 long n1, n2;
4640 #ifdef FEAT_FLOAT
4641 int use_float = FALSE;
4642 float_T f1 = 0, f2;
4643 #endif
4644 int error = FALSE;
4647 * Get the first variable.
4649 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4650 return FAIL;
4653 * Repeat computing, until no '*', '/' or '%' is following.
4655 for (;;)
4657 op = **arg;
4658 if (op != '*' && op != '/' && op != '%')
4659 break;
4661 if (evaluate)
4663 #ifdef FEAT_FLOAT
4664 if (rettv->v_type == VAR_FLOAT)
4666 f1 = rettv->vval.v_float;
4667 use_float = TRUE;
4668 n1 = 0;
4670 else
4671 #endif
4672 n1 = get_tv_number_chk(rettv, &error);
4673 clear_tv(rettv);
4674 if (error)
4675 return FAIL;
4677 else
4678 n1 = 0;
4681 * Get the second variable.
4683 *arg = skipwhite(*arg + 1);
4684 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4685 return FAIL;
4687 if (evaluate)
4689 #ifdef FEAT_FLOAT
4690 if (var2.v_type == VAR_FLOAT)
4692 if (!use_float)
4694 f1 = n1;
4695 use_float = TRUE;
4697 f2 = var2.vval.v_float;
4698 n2 = 0;
4700 else
4701 #endif
4703 n2 = get_tv_number_chk(&var2, &error);
4704 clear_tv(&var2);
4705 if (error)
4706 return FAIL;
4707 #ifdef FEAT_FLOAT
4708 if (use_float)
4709 f2 = n2;
4710 #endif
4714 * Compute the result.
4715 * When either side is a float the result is a float.
4717 #ifdef FEAT_FLOAT
4718 if (use_float)
4720 if (op == '*')
4721 f1 = f1 * f2;
4722 else if (op == '/')
4724 /* We rely on the floating point library to handle divide
4725 * by zero to result in "inf" and not a crash. */
4726 f1 = f1 / f2;
4728 else
4730 EMSG(_("E804: Cannot use '%' with Float"));
4731 return FAIL;
4733 rettv->v_type = VAR_FLOAT;
4734 rettv->vval.v_float = f1;
4736 else
4737 #endif
4739 if (op == '*')
4740 n1 = n1 * n2;
4741 else if (op == '/')
4743 if (n2 == 0) /* give an error message? */
4745 if (n1 == 0)
4746 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4747 else if (n1 < 0)
4748 n1 = -0x7fffffffL;
4749 else
4750 n1 = 0x7fffffffL;
4752 else
4753 n1 = n1 / n2;
4755 else
4757 if (n2 == 0) /* give an error message? */
4758 n1 = 0;
4759 else
4760 n1 = n1 % n2;
4762 rettv->v_type = VAR_NUMBER;
4763 rettv->vval.v_number = n1;
4768 return OK;
4772 * Handle sixth level expression:
4773 * number number constant
4774 * "string" string constant
4775 * 'string' literal string constant
4776 * &option-name option value
4777 * @r register contents
4778 * identifier variable value
4779 * function() function call
4780 * $VAR environment variable
4781 * (expression) nested expression
4782 * [expr, expr] List
4783 * {key: val, key: val} Dictionary
4785 * Also handle:
4786 * ! in front logical NOT
4787 * - in front unary minus
4788 * + in front unary plus (ignored)
4789 * trailing [] subscript in String or List
4790 * trailing .name entry in Dictionary
4792 * "arg" must point to the first non-white of the expression.
4793 * "arg" is advanced to the next non-white after the recognized expression.
4795 * Return OK or FAIL.
4797 static int
4798 eval7(arg, rettv, evaluate, want_string)
4799 char_u **arg;
4800 typval_T *rettv;
4801 int evaluate;
4802 int want_string; /* after "." operator */
4804 long n;
4805 int len;
4806 char_u *s;
4807 char_u *start_leader, *end_leader;
4808 int ret = OK;
4809 char_u *alias;
4812 * Initialise variable so that clear_tv() can't mistake this for a
4813 * string and free a string that isn't there.
4815 rettv->v_type = VAR_UNKNOWN;
4818 * Skip '!' and '-' characters. They are handled later.
4820 start_leader = *arg;
4821 while (**arg == '!' || **arg == '-' || **arg == '+')
4822 *arg = skipwhite(*arg + 1);
4823 end_leader = *arg;
4825 switch (**arg)
4828 * Number constant.
4830 case '0':
4831 case '1':
4832 case '2':
4833 case '3':
4834 case '4':
4835 case '5':
4836 case '6':
4837 case '7':
4838 case '8':
4839 case '9':
4841 #ifdef FEAT_FLOAT
4842 char_u *p = skipdigits(*arg + 1);
4843 int get_float = FALSE;
4845 /* We accept a float when the format matches
4846 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4847 * strict to avoid backwards compatibility problems.
4848 * Don't look for a float after the "." operator, so that
4849 * ":let vers = 1.2.3" doesn't fail. */
4850 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4852 get_float = TRUE;
4853 p = skipdigits(p + 2);
4854 if (*p == 'e' || *p == 'E')
4856 ++p;
4857 if (*p == '-' || *p == '+')
4858 ++p;
4859 if (!vim_isdigit(*p))
4860 get_float = FALSE;
4861 else
4862 p = skipdigits(p + 1);
4864 if (ASCII_ISALPHA(*p) || *p == '.')
4865 get_float = FALSE;
4867 if (get_float)
4869 float_T f;
4871 *arg += string2float(*arg, &f);
4872 if (evaluate)
4874 rettv->v_type = VAR_FLOAT;
4875 rettv->vval.v_float = f;
4878 else
4879 #endif
4881 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4882 *arg += len;
4883 if (evaluate)
4885 rettv->v_type = VAR_NUMBER;
4886 rettv->vval.v_number = n;
4889 break;
4893 * String constant: "string".
4895 case '"': ret = get_string_tv(arg, rettv, evaluate);
4896 break;
4899 * Literal string constant: 'str''ing'.
4901 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4902 break;
4905 * List: [expr, expr]
4907 case '[': ret = get_list_tv(arg, rettv, evaluate);
4908 break;
4911 * Dictionary: {key: val, key: val}
4913 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4914 break;
4917 * Option value: &name
4919 case '&': ret = get_option_tv(arg, rettv, evaluate);
4920 break;
4923 * Environment variable: $VAR.
4925 case '$': ret = get_env_tv(arg, rettv, evaluate);
4926 break;
4929 * Register contents: @r.
4931 case '@': ++*arg;
4932 if (evaluate)
4934 rettv->v_type = VAR_STRING;
4935 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4937 if (**arg != NUL)
4938 ++*arg;
4939 break;
4942 * nested expression: (expression).
4944 case '(': *arg = skipwhite(*arg + 1);
4945 ret = eval1(arg, rettv, evaluate); /* recursive! */
4946 if (**arg == ')')
4947 ++*arg;
4948 else if (ret == OK)
4950 EMSG(_("E110: Missing ')'"));
4951 clear_tv(rettv);
4952 ret = FAIL;
4954 break;
4956 default: ret = NOTDONE;
4957 break;
4960 if (ret == NOTDONE)
4963 * Must be a variable or function name.
4964 * Can also be a curly-braces kind of name: {expr}.
4966 s = *arg;
4967 len = get_name_len(arg, &alias, evaluate, TRUE);
4968 if (alias != NULL)
4969 s = alias;
4971 if (len <= 0)
4972 ret = FAIL;
4973 else
4975 if (**arg == '(') /* recursive! */
4977 /* If "s" is the name of a variable of type VAR_FUNC
4978 * use its contents. */
4979 s = deref_func_name(s, &len);
4981 /* Invoke the function. */
4982 ret = get_func_tv(s, len, rettv, arg,
4983 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
4984 &len, evaluate, NULL);
4985 /* Stop the expression evaluation when immediately
4986 * aborting on error, or when an interrupt occurred or
4987 * an exception was thrown but not caught. */
4988 if (aborting())
4990 if (ret == OK)
4991 clear_tv(rettv);
4992 ret = FAIL;
4995 else if (evaluate)
4996 ret = get_var_tv(s, len, rettv, TRUE);
4997 else
4998 ret = OK;
5001 if (alias != NULL)
5002 vim_free(alias);
5005 *arg = skipwhite(*arg);
5007 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5008 * expr(expr). */
5009 if (ret == OK)
5010 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5013 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5015 if (ret == OK && evaluate && end_leader > start_leader)
5017 int error = FALSE;
5018 int val = 0;
5019 #ifdef FEAT_FLOAT
5020 float_T f = 0.0;
5022 if (rettv->v_type == VAR_FLOAT)
5023 f = rettv->vval.v_float;
5024 else
5025 #endif
5026 val = get_tv_number_chk(rettv, &error);
5027 if (error)
5029 clear_tv(rettv);
5030 ret = FAIL;
5032 else
5034 while (end_leader > start_leader)
5036 --end_leader;
5037 if (*end_leader == '!')
5039 #ifdef FEAT_FLOAT
5040 if (rettv->v_type == VAR_FLOAT)
5041 f = !f;
5042 else
5043 #endif
5044 val = !val;
5046 else if (*end_leader == '-')
5048 #ifdef FEAT_FLOAT
5049 if (rettv->v_type == VAR_FLOAT)
5050 f = -f;
5051 else
5052 #endif
5053 val = -val;
5056 #ifdef FEAT_FLOAT
5057 if (rettv->v_type == VAR_FLOAT)
5059 clear_tv(rettv);
5060 rettv->vval.v_float = f;
5062 else
5063 #endif
5065 clear_tv(rettv);
5066 rettv->v_type = VAR_NUMBER;
5067 rettv->vval.v_number = val;
5072 return ret;
5076 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5077 * "*arg" points to the '[' or '.'.
5078 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5080 static int
5081 eval_index(arg, rettv, evaluate, verbose)
5082 char_u **arg;
5083 typval_T *rettv;
5084 int evaluate;
5085 int verbose; /* give error messages */
5087 int empty1 = FALSE, empty2 = FALSE;
5088 typval_T var1, var2;
5089 long n1, n2 = 0;
5090 long len = -1;
5091 int range = FALSE;
5092 char_u *s;
5093 char_u *key = NULL;
5095 if (rettv->v_type == VAR_FUNC
5096 #ifdef FEAT_FLOAT
5097 || rettv->v_type == VAR_FLOAT
5098 #endif
5101 if (verbose)
5102 EMSG(_("E695: Cannot index a Funcref"));
5103 return FAIL;
5106 if (**arg == '.')
5109 * dict.name
5111 key = *arg + 1;
5112 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5114 if (len == 0)
5115 return FAIL;
5116 *arg = skipwhite(key + len);
5118 else
5121 * something[idx]
5123 * Get the (first) variable from inside the [].
5125 *arg = skipwhite(*arg + 1);
5126 if (**arg == ':')
5127 empty1 = TRUE;
5128 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5129 return FAIL;
5130 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5132 /* not a number or string */
5133 clear_tv(&var1);
5134 return FAIL;
5138 * Get the second variable from inside the [:].
5140 if (**arg == ':')
5142 range = TRUE;
5143 *arg = skipwhite(*arg + 1);
5144 if (**arg == ']')
5145 empty2 = TRUE;
5146 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5148 if (!empty1)
5149 clear_tv(&var1);
5150 return FAIL;
5152 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5154 /* not a number or string */
5155 if (!empty1)
5156 clear_tv(&var1);
5157 clear_tv(&var2);
5158 return FAIL;
5162 /* Check for the ']'. */
5163 if (**arg != ']')
5165 if (verbose)
5166 EMSG(_(e_missbrac));
5167 clear_tv(&var1);
5168 if (range)
5169 clear_tv(&var2);
5170 return FAIL;
5172 *arg = skipwhite(*arg + 1); /* skip the ']' */
5175 if (evaluate)
5177 n1 = 0;
5178 if (!empty1 && rettv->v_type != VAR_DICT)
5180 n1 = get_tv_number(&var1);
5181 clear_tv(&var1);
5183 if (range)
5185 if (empty2)
5186 n2 = -1;
5187 else
5189 n2 = get_tv_number(&var2);
5190 clear_tv(&var2);
5194 switch (rettv->v_type)
5196 case VAR_NUMBER:
5197 case VAR_STRING:
5198 s = get_tv_string(rettv);
5199 len = (long)STRLEN(s);
5200 if (range)
5202 /* The resulting variable is a substring. If the indexes
5203 * are out of range the result is empty. */
5204 if (n1 < 0)
5206 n1 = len + n1;
5207 if (n1 < 0)
5208 n1 = 0;
5210 if (n2 < 0)
5211 n2 = len + n2;
5212 else if (n2 >= len)
5213 n2 = len;
5214 if (n1 >= len || n2 < 0 || n1 > n2)
5215 s = NULL;
5216 else
5217 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5219 else
5221 /* The resulting variable is a string of a single
5222 * character. If the index is too big or negative the
5223 * result is empty. */
5224 if (n1 >= len || n1 < 0)
5225 s = NULL;
5226 else
5227 s = vim_strnsave(s + n1, 1);
5229 clear_tv(rettv);
5230 rettv->v_type = VAR_STRING;
5231 rettv->vval.v_string = s;
5232 break;
5234 case VAR_LIST:
5235 len = list_len(rettv->vval.v_list);
5236 if (n1 < 0)
5237 n1 = len + n1;
5238 if (!empty1 && (n1 < 0 || n1 >= len))
5240 /* For a range we allow invalid values and return an empty
5241 * list. A list index out of range is an error. */
5242 if (!range)
5244 if (verbose)
5245 EMSGN(_(e_listidx), n1);
5246 return FAIL;
5248 n1 = len;
5250 if (range)
5252 list_T *l;
5253 listitem_T *item;
5255 if (n2 < 0)
5256 n2 = len + n2;
5257 else if (n2 >= len)
5258 n2 = len - 1;
5259 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5260 n2 = -1;
5261 l = list_alloc();
5262 if (l == NULL)
5263 return FAIL;
5264 for (item = list_find(rettv->vval.v_list, n1);
5265 n1 <= n2; ++n1)
5267 if (list_append_tv(l, &item->li_tv) == FAIL)
5269 list_free(l, TRUE);
5270 return FAIL;
5272 item = item->li_next;
5274 clear_tv(rettv);
5275 rettv->v_type = VAR_LIST;
5276 rettv->vval.v_list = l;
5277 ++l->lv_refcount;
5279 else
5281 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5282 clear_tv(rettv);
5283 *rettv = var1;
5285 break;
5287 case VAR_DICT:
5288 if (range)
5290 if (verbose)
5291 EMSG(_(e_dictrange));
5292 if (len == -1)
5293 clear_tv(&var1);
5294 return FAIL;
5297 dictitem_T *item;
5299 if (len == -1)
5301 key = get_tv_string(&var1);
5302 if (*key == NUL)
5304 if (verbose)
5305 EMSG(_(e_emptykey));
5306 clear_tv(&var1);
5307 return FAIL;
5311 item = dict_find(rettv->vval.v_dict, key, (int)len);
5313 if (item == NULL && verbose)
5314 EMSG2(_(e_dictkey), key);
5315 if (len == -1)
5316 clear_tv(&var1);
5317 if (item == NULL)
5318 return FAIL;
5320 copy_tv(&item->di_tv, &var1);
5321 clear_tv(rettv);
5322 *rettv = var1;
5324 break;
5328 return OK;
5332 * Get an option value.
5333 * "arg" points to the '&' or '+' before the option name.
5334 * "arg" is advanced to character after the option name.
5335 * Return OK or FAIL.
5337 static int
5338 get_option_tv(arg, rettv, evaluate)
5339 char_u **arg;
5340 typval_T *rettv; /* when NULL, only check if option exists */
5341 int evaluate;
5343 char_u *option_end;
5344 long numval;
5345 char_u *stringval;
5346 int opt_type;
5347 int c;
5348 int working = (**arg == '+'); /* has("+option") */
5349 int ret = OK;
5350 int opt_flags;
5353 * Isolate the option name and find its value.
5355 option_end = find_option_end(arg, &opt_flags);
5356 if (option_end == NULL)
5358 if (rettv != NULL)
5359 EMSG2(_("E112: Option name missing: %s"), *arg);
5360 return FAIL;
5363 if (!evaluate)
5365 *arg = option_end;
5366 return OK;
5369 c = *option_end;
5370 *option_end = NUL;
5371 opt_type = get_option_value(*arg, &numval,
5372 rettv == NULL ? NULL : &stringval, opt_flags);
5374 if (opt_type == -3) /* invalid name */
5376 if (rettv != NULL)
5377 EMSG2(_("E113: Unknown option: %s"), *arg);
5378 ret = FAIL;
5380 else if (rettv != NULL)
5382 if (opt_type == -2) /* hidden string option */
5384 rettv->v_type = VAR_STRING;
5385 rettv->vval.v_string = NULL;
5387 else if (opt_type == -1) /* hidden number option */
5389 rettv->v_type = VAR_NUMBER;
5390 rettv->vval.v_number = 0;
5392 else if (opt_type == 1) /* number option */
5394 rettv->v_type = VAR_NUMBER;
5395 rettv->vval.v_number = numval;
5397 else /* string option */
5399 rettv->v_type = VAR_STRING;
5400 rettv->vval.v_string = stringval;
5403 else if (working && (opt_type == -2 || opt_type == -1))
5404 ret = FAIL;
5406 *option_end = c; /* put back for error messages */
5407 *arg = option_end;
5409 return ret;
5413 * Allocate a variable for a string constant.
5414 * Return OK or FAIL.
5416 static int
5417 get_string_tv(arg, rettv, evaluate)
5418 char_u **arg;
5419 typval_T *rettv;
5420 int evaluate;
5422 char_u *p;
5423 char_u *name;
5424 int extra = 0;
5427 * Find the end of the string, skipping backslashed characters.
5429 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5431 if (*p == '\\' && p[1] != NUL)
5433 ++p;
5434 /* A "\<x>" form occupies at least 4 characters, and produces up
5435 * to 6 characters: reserve space for 2 extra */
5436 if (*p == '<')
5437 extra += 2;
5441 if (*p != '"')
5443 EMSG2(_("E114: Missing quote: %s"), *arg);
5444 return FAIL;
5447 /* If only parsing, set *arg and return here */
5448 if (!evaluate)
5450 *arg = p + 1;
5451 return OK;
5455 * Copy the string into allocated memory, handling backslashed
5456 * characters.
5458 name = alloc((unsigned)(p - *arg + extra));
5459 if (name == NULL)
5460 return FAIL;
5461 rettv->v_type = VAR_STRING;
5462 rettv->vval.v_string = name;
5464 for (p = *arg + 1; *p != NUL && *p != '"'; )
5466 if (*p == '\\')
5468 switch (*++p)
5470 case 'b': *name++ = BS; ++p; break;
5471 case 'e': *name++ = ESC; ++p; break;
5472 case 'f': *name++ = FF; ++p; break;
5473 case 'n': *name++ = NL; ++p; break;
5474 case 'r': *name++ = CAR; ++p; break;
5475 case 't': *name++ = TAB; ++p; break;
5477 case 'X': /* hex: "\x1", "\x12" */
5478 case 'x':
5479 case 'u': /* Unicode: "\u0023" */
5480 case 'U':
5481 if (vim_isxdigit(p[1]))
5483 int n, nr;
5484 int c = toupper(*p);
5486 if (c == 'X')
5487 n = 2;
5488 else
5489 n = 4;
5490 nr = 0;
5491 while (--n >= 0 && vim_isxdigit(p[1]))
5493 ++p;
5494 nr = (nr << 4) + hex2nr(*p);
5496 ++p;
5497 #ifdef FEAT_MBYTE
5498 /* For "\u" store the number according to
5499 * 'encoding'. */
5500 if (c != 'X')
5501 name += (*mb_char2bytes)(nr, name);
5502 else
5503 #endif
5504 *name++ = nr;
5506 break;
5508 /* octal: "\1", "\12", "\123" */
5509 case '0':
5510 case '1':
5511 case '2':
5512 case '3':
5513 case '4':
5514 case '5':
5515 case '6':
5516 case '7': *name = *p++ - '0';
5517 if (*p >= '0' && *p <= '7')
5519 *name = (*name << 3) + *p++ - '0';
5520 if (*p >= '0' && *p <= '7')
5521 *name = (*name << 3) + *p++ - '0';
5523 ++name;
5524 break;
5526 /* Special key, e.g.: "\<C-W>" */
5527 case '<': extra = trans_special(&p, name, TRUE);
5528 if (extra != 0)
5530 name += extra;
5531 break;
5533 /* FALLTHROUGH */
5535 default: MB_COPY_CHAR(p, name);
5536 break;
5539 else
5540 MB_COPY_CHAR(p, name);
5543 *name = NUL;
5544 *arg = p + 1;
5546 return OK;
5550 * Allocate a variable for a 'str''ing' constant.
5551 * Return OK or FAIL.
5553 static int
5554 get_lit_string_tv(arg, rettv, evaluate)
5555 char_u **arg;
5556 typval_T *rettv;
5557 int evaluate;
5559 char_u *p;
5560 char_u *str;
5561 int reduce = 0;
5564 * Find the end of the string, skipping ''.
5566 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5568 if (*p == '\'')
5570 if (p[1] != '\'')
5571 break;
5572 ++reduce;
5573 ++p;
5577 if (*p != '\'')
5579 EMSG2(_("E115: Missing quote: %s"), *arg);
5580 return FAIL;
5583 /* If only parsing return after setting "*arg" */
5584 if (!evaluate)
5586 *arg = p + 1;
5587 return OK;
5591 * Copy the string into allocated memory, handling '' to ' reduction.
5593 str = alloc((unsigned)((p - *arg) - reduce));
5594 if (str == NULL)
5595 return FAIL;
5596 rettv->v_type = VAR_STRING;
5597 rettv->vval.v_string = str;
5599 for (p = *arg + 1; *p != NUL; )
5601 if (*p == '\'')
5603 if (p[1] != '\'')
5604 break;
5605 ++p;
5607 MB_COPY_CHAR(p, str);
5609 *str = NUL;
5610 *arg = p + 1;
5612 return OK;
5616 * Allocate a variable for a List and fill it from "*arg".
5617 * Return OK or FAIL.
5619 static int
5620 get_list_tv(arg, rettv, evaluate)
5621 char_u **arg;
5622 typval_T *rettv;
5623 int evaluate;
5625 list_T *l = NULL;
5626 typval_T tv;
5627 listitem_T *item;
5629 if (evaluate)
5631 l = list_alloc();
5632 if (l == NULL)
5633 return FAIL;
5636 *arg = skipwhite(*arg + 1);
5637 while (**arg != ']' && **arg != NUL)
5639 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5640 goto failret;
5641 if (evaluate)
5643 item = listitem_alloc();
5644 if (item != NULL)
5646 item->li_tv = tv;
5647 item->li_tv.v_lock = 0;
5648 list_append(l, item);
5650 else
5651 clear_tv(&tv);
5654 if (**arg == ']')
5655 break;
5656 if (**arg != ',')
5658 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5659 goto failret;
5661 *arg = skipwhite(*arg + 1);
5664 if (**arg != ']')
5666 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5667 failret:
5668 if (evaluate)
5669 list_free(l, TRUE);
5670 return FAIL;
5673 *arg = skipwhite(*arg + 1);
5674 if (evaluate)
5676 rettv->v_type = VAR_LIST;
5677 rettv->vval.v_list = l;
5678 ++l->lv_refcount;
5681 return OK;
5685 * Allocate an empty header for a list.
5686 * Caller should take care of the reference count.
5688 list_T *
5689 list_alloc()
5691 list_T *l;
5693 l = (list_T *)alloc_clear(sizeof(list_T));
5694 if (l != NULL)
5696 /* Prepend the list to the list of lists for garbage collection. */
5697 if (first_list != NULL)
5698 first_list->lv_used_prev = l;
5699 l->lv_used_prev = NULL;
5700 l->lv_used_next = first_list;
5701 first_list = l;
5703 return l;
5707 * Allocate an empty list for a return value.
5708 * Returns OK or FAIL.
5710 static int
5711 rettv_list_alloc(rettv)
5712 typval_T *rettv;
5714 list_T *l = list_alloc();
5716 if (l == NULL)
5717 return FAIL;
5719 rettv->vval.v_list = l;
5720 rettv->v_type = VAR_LIST;
5721 ++l->lv_refcount;
5722 return OK;
5726 * Unreference a list: decrement the reference count and free it when it
5727 * becomes zero.
5729 void
5730 list_unref(l)
5731 list_T *l;
5733 if (l != NULL && --l->lv_refcount <= 0)
5734 list_free(l, TRUE);
5738 * Free a list, including all items it points to.
5739 * Ignores the reference count.
5741 void
5742 list_free(l, recurse)
5743 list_T *l;
5744 int recurse; /* Free Lists and Dictionaries recursively. */
5746 listitem_T *item;
5748 /* Remove the list from the list of lists for garbage collection. */
5749 if (l->lv_used_prev == NULL)
5750 first_list = l->lv_used_next;
5751 else
5752 l->lv_used_prev->lv_used_next = l->lv_used_next;
5753 if (l->lv_used_next != NULL)
5754 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5756 for (item = l->lv_first; item != NULL; item = l->lv_first)
5758 /* Remove the item before deleting it. */
5759 l->lv_first = item->li_next;
5760 if (recurse || (item->li_tv.v_type != VAR_LIST
5761 && item->li_tv.v_type != VAR_DICT))
5762 clear_tv(&item->li_tv);
5763 vim_free(item);
5765 vim_free(l);
5769 * Allocate a list item.
5771 static listitem_T *
5772 listitem_alloc()
5774 return (listitem_T *)alloc(sizeof(listitem_T));
5778 * Free a list item. Also clears the value. Does not notify watchers.
5780 static void
5781 listitem_free(item)
5782 listitem_T *item;
5784 clear_tv(&item->li_tv);
5785 vim_free(item);
5789 * Remove a list item from a List and free it. Also clears the value.
5791 static void
5792 listitem_remove(l, item)
5793 list_T *l;
5794 listitem_T *item;
5796 list_remove(l, item, item);
5797 listitem_free(item);
5801 * Get the number of items in a list.
5803 static long
5804 list_len(l)
5805 list_T *l;
5807 if (l == NULL)
5808 return 0L;
5809 return l->lv_len;
5813 * Return TRUE when two lists have exactly the same values.
5815 static int
5816 list_equal(l1, l2, ic)
5817 list_T *l1;
5818 list_T *l2;
5819 int ic; /* ignore case for strings */
5821 listitem_T *item1, *item2;
5823 if (l1 == NULL || l2 == NULL)
5824 return FALSE;
5825 if (l1 == l2)
5826 return TRUE;
5827 if (list_len(l1) != list_len(l2))
5828 return FALSE;
5830 for (item1 = l1->lv_first, item2 = l2->lv_first;
5831 item1 != NULL && item2 != NULL;
5832 item1 = item1->li_next, item2 = item2->li_next)
5833 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5834 return FALSE;
5835 return item1 == NULL && item2 == NULL;
5838 #if defined(FEAT_PYTHON) || defined(PROTO) || defined(FEAT_GUI_MACVIM)
5840 * Return the dictitem that an entry in a hashtable points to.
5842 dictitem_T *
5843 dict_lookup(hi)
5844 hashitem_T *hi;
5846 return HI2DI(hi);
5848 #endif
5851 * Return TRUE when two dictionaries have exactly the same key/values.
5853 static int
5854 dict_equal(d1, d2, ic)
5855 dict_T *d1;
5856 dict_T *d2;
5857 int ic; /* ignore case for strings */
5859 hashitem_T *hi;
5860 dictitem_T *item2;
5861 int todo;
5863 if (d1 == NULL || d2 == NULL)
5864 return FALSE;
5865 if (d1 == d2)
5866 return TRUE;
5867 if (dict_len(d1) != dict_len(d2))
5868 return FALSE;
5870 todo = (int)d1->dv_hashtab.ht_used;
5871 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5873 if (!HASHITEM_EMPTY(hi))
5875 item2 = dict_find(d2, hi->hi_key, -1);
5876 if (item2 == NULL)
5877 return FALSE;
5878 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5879 return FALSE;
5880 --todo;
5883 return TRUE;
5887 * Return TRUE if "tv1" and "tv2" have the same value.
5888 * Compares the items just like "==" would compare them, but strings and
5889 * numbers are different. Floats and numbers are also different.
5891 static int
5892 tv_equal(tv1, tv2, ic)
5893 typval_T *tv1;
5894 typval_T *tv2;
5895 int ic; /* ignore case */
5897 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5898 char_u *s1, *s2;
5899 static int recursive = 0; /* cach recursive loops */
5900 int r;
5902 if (tv1->v_type != tv2->v_type)
5903 return FALSE;
5904 /* Catch lists and dicts that have an endless loop by limiting
5905 * recursiveness to 1000. We guess they are equal then. */
5906 if (recursive >= 1000)
5907 return TRUE;
5909 switch (tv1->v_type)
5911 case VAR_LIST:
5912 ++recursive;
5913 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5914 --recursive;
5915 return r;
5917 case VAR_DICT:
5918 ++recursive;
5919 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5920 --recursive;
5921 return r;
5923 case VAR_FUNC:
5924 return (tv1->vval.v_string != NULL
5925 && tv2->vval.v_string != NULL
5926 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5928 case VAR_NUMBER:
5929 return tv1->vval.v_number == tv2->vval.v_number;
5931 #ifdef FEAT_FLOAT
5932 case VAR_FLOAT:
5933 return tv1->vval.v_float == tv2->vval.v_float;
5934 #endif
5936 case VAR_STRING:
5937 s1 = get_tv_string_buf(tv1, buf1);
5938 s2 = get_tv_string_buf(tv2, buf2);
5939 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5942 EMSG2(_(e_intern2), "tv_equal()");
5943 return TRUE;
5947 * Locate item with index "n" in list "l" and return it.
5948 * A negative index is counted from the end; -1 is the last item.
5949 * Returns NULL when "n" is out of range.
5951 static listitem_T *
5952 list_find(l, n)
5953 list_T *l;
5954 long n;
5956 listitem_T *item;
5957 long idx;
5959 if (l == NULL)
5960 return NULL;
5962 /* Negative index is relative to the end. */
5963 if (n < 0)
5964 n = l->lv_len + n;
5966 /* Check for index out of range. */
5967 if (n < 0 || n >= l->lv_len)
5968 return NULL;
5970 /* When there is a cached index may start search from there. */
5971 if (l->lv_idx_item != NULL)
5973 if (n < l->lv_idx / 2)
5975 /* closest to the start of the list */
5976 item = l->lv_first;
5977 idx = 0;
5979 else if (n > (l->lv_idx + l->lv_len) / 2)
5981 /* closest to the end of the list */
5982 item = l->lv_last;
5983 idx = l->lv_len - 1;
5985 else
5987 /* closest to the cached index */
5988 item = l->lv_idx_item;
5989 idx = l->lv_idx;
5992 else
5994 if (n < l->lv_len / 2)
5996 /* closest to the start of the list */
5997 item = l->lv_first;
5998 idx = 0;
6000 else
6002 /* closest to the end of the list */
6003 item = l->lv_last;
6004 idx = l->lv_len - 1;
6008 while (n > idx)
6010 /* search forward */
6011 item = item->li_next;
6012 ++idx;
6014 while (n < idx)
6016 /* search backward */
6017 item = item->li_prev;
6018 --idx;
6021 /* cache the used index */
6022 l->lv_idx = idx;
6023 l->lv_idx_item = item;
6025 return item;
6029 * Get list item "l[idx]" as a number.
6031 static long
6032 list_find_nr(l, idx, errorp)
6033 list_T *l;
6034 long idx;
6035 int *errorp; /* set to TRUE when something wrong */
6037 listitem_T *li;
6039 li = list_find(l, idx);
6040 if (li == NULL)
6042 if (errorp != NULL)
6043 *errorp = TRUE;
6044 return -1L;
6046 return get_tv_number_chk(&li->li_tv, errorp);
6050 * Locate "item" list "l" and return its index.
6051 * Returns -1 when "item" is not in the list.
6053 static long
6054 list_idx_of_item(l, item)
6055 list_T *l;
6056 listitem_T *item;
6058 long idx = 0;
6059 listitem_T *li;
6061 if (l == NULL)
6062 return -1;
6063 idx = 0;
6064 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6065 ++idx;
6066 if (li == NULL)
6067 return -1;
6068 return idx;
6072 * Append item "item" to the end of list "l".
6074 static void
6075 list_append(l, item)
6076 list_T *l;
6077 listitem_T *item;
6079 if (l->lv_last == NULL)
6081 /* empty list */
6082 l->lv_first = item;
6083 l->lv_last = item;
6084 item->li_prev = NULL;
6086 else
6088 l->lv_last->li_next = item;
6089 item->li_prev = l->lv_last;
6090 l->lv_last = item;
6092 ++l->lv_len;
6093 item->li_next = NULL;
6097 * Append typval_T "tv" to the end of list "l".
6098 * Return FAIL when out of memory.
6100 static int
6101 list_append_tv(l, tv)
6102 list_T *l;
6103 typval_T *tv;
6105 listitem_T *li = listitem_alloc();
6107 if (li == NULL)
6108 return FAIL;
6109 copy_tv(tv, &li->li_tv);
6110 list_append(l, li);
6111 return OK;
6115 * Add a dictionary to a list. Used by getqflist().
6116 * Return FAIL when out of memory.
6119 list_append_dict(list, dict)
6120 list_T *list;
6121 dict_T *dict;
6123 listitem_T *li = listitem_alloc();
6125 if (li == NULL)
6126 return FAIL;
6127 li->li_tv.v_type = VAR_DICT;
6128 li->li_tv.v_lock = 0;
6129 li->li_tv.vval.v_dict = dict;
6130 list_append(list, li);
6131 ++dict->dv_refcount;
6132 return OK;
6136 * Make a copy of "str" and append it as an item to list "l".
6137 * When "len" >= 0 use "str[len]".
6138 * Returns FAIL when out of memory.
6140 static int
6141 list_append_string(l, str, len)
6142 list_T *l;
6143 char_u *str;
6144 int len;
6146 listitem_T *li = listitem_alloc();
6148 if (li == NULL)
6149 return FAIL;
6150 list_append(l, li);
6151 li->li_tv.v_type = VAR_STRING;
6152 li->li_tv.v_lock = 0;
6153 if (str == NULL)
6154 li->li_tv.vval.v_string = NULL;
6155 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6156 : vim_strsave(str))) == NULL)
6157 return FAIL;
6158 return OK;
6162 * Append "n" to list "l".
6163 * Returns FAIL when out of memory.
6165 static int
6166 list_append_number(l, n)
6167 list_T *l;
6168 varnumber_T n;
6170 listitem_T *li;
6172 li = listitem_alloc();
6173 if (li == NULL)
6174 return FAIL;
6175 li->li_tv.v_type = VAR_NUMBER;
6176 li->li_tv.v_lock = 0;
6177 li->li_tv.vval.v_number = n;
6178 list_append(l, li);
6179 return OK;
6183 * Insert typval_T "tv" in list "l" before "item".
6184 * If "item" is NULL append at the end.
6185 * Return FAIL when out of memory.
6187 static int
6188 list_insert_tv(l, tv, item)
6189 list_T *l;
6190 typval_T *tv;
6191 listitem_T *item;
6193 listitem_T *ni = listitem_alloc();
6195 if (ni == NULL)
6196 return FAIL;
6197 copy_tv(tv, &ni->li_tv);
6198 if (item == NULL)
6199 /* Append new item at end of list. */
6200 list_append(l, ni);
6201 else
6203 /* Insert new item before existing item. */
6204 ni->li_prev = item->li_prev;
6205 ni->li_next = item;
6206 if (item->li_prev == NULL)
6208 l->lv_first = ni;
6209 ++l->lv_idx;
6211 else
6213 item->li_prev->li_next = ni;
6214 l->lv_idx_item = NULL;
6216 item->li_prev = ni;
6217 ++l->lv_len;
6219 return OK;
6223 * Extend "l1" with "l2".
6224 * If "bef" is NULL append at the end, otherwise insert before this item.
6225 * Returns FAIL when out of memory.
6227 static int
6228 list_extend(l1, l2, bef)
6229 list_T *l1;
6230 list_T *l2;
6231 listitem_T *bef;
6233 listitem_T *item;
6234 int todo = l2->lv_len;
6236 /* We also quit the loop when we have inserted the original item count of
6237 * the list, avoid a hang when we extend a list with itself. */
6238 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6239 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6240 return FAIL;
6241 return OK;
6245 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6246 * Return FAIL when out of memory.
6248 static int
6249 list_concat(l1, l2, tv)
6250 list_T *l1;
6251 list_T *l2;
6252 typval_T *tv;
6254 list_T *l;
6256 if (l1 == NULL || l2 == NULL)
6257 return FAIL;
6259 /* make a copy of the first list. */
6260 l = list_copy(l1, FALSE, 0);
6261 if (l == NULL)
6262 return FAIL;
6263 tv->v_type = VAR_LIST;
6264 tv->vval.v_list = l;
6266 /* append all items from the second list */
6267 return list_extend(l, l2, NULL);
6271 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6272 * The refcount of the new list is set to 1.
6273 * See item_copy() for "copyID".
6274 * Returns NULL when out of memory.
6276 static list_T *
6277 list_copy(orig, deep, copyID)
6278 list_T *orig;
6279 int deep;
6280 int copyID;
6282 list_T *copy;
6283 listitem_T *item;
6284 listitem_T *ni;
6286 if (orig == NULL)
6287 return NULL;
6289 copy = list_alloc();
6290 if (copy != NULL)
6292 if (copyID != 0)
6294 /* Do this before adding the items, because one of the items may
6295 * refer back to this list. */
6296 orig->lv_copyID = copyID;
6297 orig->lv_copylist = copy;
6299 for (item = orig->lv_first; item != NULL && !got_int;
6300 item = item->li_next)
6302 ni = listitem_alloc();
6303 if (ni == NULL)
6304 break;
6305 if (deep)
6307 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6309 vim_free(ni);
6310 break;
6313 else
6314 copy_tv(&item->li_tv, &ni->li_tv);
6315 list_append(copy, ni);
6317 ++copy->lv_refcount;
6318 if (item != NULL)
6320 list_unref(copy);
6321 copy = NULL;
6325 return copy;
6329 * Remove items "item" to "item2" from list "l".
6330 * Does not free the listitem or the value!
6332 static void
6333 list_remove(l, item, item2)
6334 list_T *l;
6335 listitem_T *item;
6336 listitem_T *item2;
6338 listitem_T *ip;
6340 /* notify watchers */
6341 for (ip = item; ip != NULL; ip = ip->li_next)
6343 --l->lv_len;
6344 list_fix_watch(l, ip);
6345 if (ip == item2)
6346 break;
6349 if (item2->li_next == NULL)
6350 l->lv_last = item->li_prev;
6351 else
6352 item2->li_next->li_prev = item->li_prev;
6353 if (item->li_prev == NULL)
6354 l->lv_first = item2->li_next;
6355 else
6356 item->li_prev->li_next = item2->li_next;
6357 l->lv_idx_item = NULL;
6361 * Return an allocated string with the string representation of a list.
6362 * May return NULL.
6364 static char_u *
6365 list2string(tv, copyID)
6366 typval_T *tv;
6367 int copyID;
6369 garray_T ga;
6371 if (tv->vval.v_list == NULL)
6372 return NULL;
6373 ga_init2(&ga, (int)sizeof(char), 80);
6374 ga_append(&ga, '[');
6375 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6377 vim_free(ga.ga_data);
6378 return NULL;
6380 ga_append(&ga, ']');
6381 ga_append(&ga, NUL);
6382 return (char_u *)ga.ga_data;
6386 * Join list "l" into a string in "*gap", using separator "sep".
6387 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6388 * Return FAIL or OK.
6390 static int
6391 list_join(gap, l, sep, echo, copyID)
6392 garray_T *gap;
6393 list_T *l;
6394 char_u *sep;
6395 int echo;
6396 int copyID;
6398 int first = TRUE;
6399 char_u *tofree;
6400 char_u numbuf[NUMBUFLEN];
6401 listitem_T *item;
6402 char_u *s;
6404 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6406 if (first)
6407 first = FALSE;
6408 else
6409 ga_concat(gap, sep);
6411 if (echo)
6412 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6413 else
6414 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6415 if (s != NULL)
6416 ga_concat(gap, s);
6417 vim_free(tofree);
6418 if (s == NULL)
6419 return FAIL;
6421 return OK;
6425 * Garbage collection for lists and dictionaries.
6427 * We use reference counts to be able to free most items right away when they
6428 * are no longer used. But for composite items it's possible that it becomes
6429 * unused while the reference count is > 0: When there is a recursive
6430 * reference. Example:
6431 * :let l = [1, 2, 3]
6432 * :let d = {9: l}
6433 * :let l[1] = d
6435 * Since this is quite unusual we handle this with garbage collection: every
6436 * once in a while find out which lists and dicts are not referenced from any
6437 * variable.
6439 * Here is a good reference text about garbage collection (refers to Python
6440 * but it applies to all reference-counting mechanisms):
6441 * http://python.ca/nas/python/gc/
6445 * Do garbage collection for lists and dicts.
6446 * Return TRUE if some memory was freed.
6449 garbage_collect()
6451 dict_T *dd;
6452 list_T *ll;
6453 int copyID = ++current_copyID;
6454 buf_T *buf;
6455 win_T *wp;
6456 int i;
6457 funccall_T *fc;
6458 int did_free = FALSE;
6459 #ifdef FEAT_WINDOWS
6460 tabpage_T *tp;
6461 #endif
6463 /* Only do this once. */
6464 want_garbage_collect = FALSE;
6465 may_garbage_collect = FALSE;
6466 garbage_collect_at_exit = FALSE;
6469 * 1. Go through all accessible variables and mark all lists and dicts
6470 * with copyID.
6472 /* script-local variables */
6473 for (i = 1; i <= ga_scripts.ga_len; ++i)
6474 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6476 /* buffer-local variables */
6477 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6478 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6480 /* window-local variables */
6481 FOR_ALL_TAB_WINDOWS(tp, wp)
6482 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6484 #ifdef FEAT_WINDOWS
6485 /* tabpage-local variables */
6486 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6487 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6488 #endif
6490 /* global variables */
6491 set_ref_in_ht(&globvarht, copyID);
6493 /* function-local variables */
6494 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6496 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6497 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6501 * 2. Go through the list of dicts and free items without the copyID.
6503 for (dd = first_dict; dd != NULL; )
6504 if (dd->dv_copyID != copyID)
6506 /* Free the Dictionary and ordinary items it contains, but don't
6507 * recurse into Lists and Dictionaries, they will be in the list
6508 * of dicts or list of lists. */
6509 dict_free(dd, FALSE);
6510 did_free = TRUE;
6512 /* restart, next dict may also have been freed */
6513 dd = first_dict;
6515 else
6516 dd = dd->dv_used_next;
6519 * 3. Go through the list of lists and free items without the copyID.
6520 * But don't free a list that has a watcher (used in a for loop), these
6521 * are not referenced anywhere.
6523 for (ll = first_list; ll != NULL; )
6524 if (ll->lv_copyID != copyID && ll->lv_watch == NULL)
6526 /* Free the List and ordinary items it contains, but don't recurse
6527 * into Lists and Dictionaries, they will be in the list of dicts
6528 * or list of lists. */
6529 list_free(ll, FALSE);
6530 did_free = TRUE;
6532 /* restart, next list may also have been freed */
6533 ll = first_list;
6535 else
6536 ll = ll->lv_used_next;
6538 return did_free;
6542 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6544 static void
6545 set_ref_in_ht(ht, copyID)
6546 hashtab_T *ht;
6547 int copyID;
6549 int todo;
6550 hashitem_T *hi;
6552 todo = (int)ht->ht_used;
6553 for (hi = ht->ht_array; todo > 0; ++hi)
6554 if (!HASHITEM_EMPTY(hi))
6556 --todo;
6557 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6562 * Mark all lists and dicts referenced through list "l" with "copyID".
6564 static void
6565 set_ref_in_list(l, copyID)
6566 list_T *l;
6567 int copyID;
6569 listitem_T *li;
6571 for (li = l->lv_first; li != NULL; li = li->li_next)
6572 set_ref_in_item(&li->li_tv, copyID);
6576 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6578 static void
6579 set_ref_in_item(tv, copyID)
6580 typval_T *tv;
6581 int copyID;
6583 dict_T *dd;
6584 list_T *ll;
6586 switch (tv->v_type)
6588 case VAR_DICT:
6589 dd = tv->vval.v_dict;
6590 if (dd->dv_copyID != copyID)
6592 /* Didn't see this dict yet. */
6593 dd->dv_copyID = copyID;
6594 set_ref_in_ht(&dd->dv_hashtab, copyID);
6596 break;
6598 case VAR_LIST:
6599 ll = tv->vval.v_list;
6600 if (ll->lv_copyID != copyID)
6602 /* Didn't see this list yet. */
6603 ll->lv_copyID = copyID;
6604 set_ref_in_list(ll, copyID);
6606 break;
6608 return;
6612 * Allocate an empty header for a dictionary.
6614 dict_T *
6615 dict_alloc()
6617 dict_T *d;
6619 d = (dict_T *)alloc(sizeof(dict_T));
6620 if (d != NULL)
6622 /* Add the list to the list of dicts for garbage collection. */
6623 if (first_dict != NULL)
6624 first_dict->dv_used_prev = d;
6625 d->dv_used_next = first_dict;
6626 d->dv_used_prev = NULL;
6627 first_dict = d;
6629 hash_init(&d->dv_hashtab);
6630 d->dv_lock = 0;
6631 d->dv_refcount = 0;
6632 d->dv_copyID = 0;
6634 return d;
6638 * Unreference a Dictionary: decrement the reference count and free it when it
6639 * becomes zero.
6641 static void
6642 dict_unref(d)
6643 dict_T *d;
6645 if (d != NULL && --d->dv_refcount <= 0)
6646 dict_free(d, TRUE);
6650 * Free a Dictionary, including all items it contains.
6651 * Ignores the reference count.
6653 static void
6654 dict_free(d, recurse)
6655 dict_T *d;
6656 int recurse; /* Free Lists and Dictionaries recursively. */
6658 int todo;
6659 hashitem_T *hi;
6660 dictitem_T *di;
6662 /* Remove the dict from the list of dicts for garbage collection. */
6663 if (d->dv_used_prev == NULL)
6664 first_dict = d->dv_used_next;
6665 else
6666 d->dv_used_prev->dv_used_next = d->dv_used_next;
6667 if (d->dv_used_next != NULL)
6668 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6670 /* Lock the hashtab, we don't want it to resize while freeing items. */
6671 hash_lock(&d->dv_hashtab);
6672 todo = (int)d->dv_hashtab.ht_used;
6673 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6675 if (!HASHITEM_EMPTY(hi))
6677 /* Remove the item before deleting it, just in case there is
6678 * something recursive causing trouble. */
6679 di = HI2DI(hi);
6680 hash_remove(&d->dv_hashtab, hi);
6681 if (recurse || (di->di_tv.v_type != VAR_LIST
6682 && di->di_tv.v_type != VAR_DICT))
6683 clear_tv(&di->di_tv);
6684 vim_free(di);
6685 --todo;
6688 hash_clear(&d->dv_hashtab);
6689 vim_free(d);
6693 * Allocate a Dictionary item.
6694 * The "key" is copied to the new item.
6695 * Note that the value of the item "di_tv" still needs to be initialized!
6696 * Returns NULL when out of memory.
6698 static dictitem_T *
6699 dictitem_alloc(key)
6700 char_u *key;
6702 dictitem_T *di;
6704 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6705 if (di != NULL)
6707 STRCPY(di->di_key, key);
6708 di->di_flags = 0;
6710 return di;
6714 * Make a copy of a Dictionary item.
6716 static dictitem_T *
6717 dictitem_copy(org)
6718 dictitem_T *org;
6720 dictitem_T *di;
6722 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6723 + STRLEN(org->di_key)));
6724 if (di != NULL)
6726 STRCPY(di->di_key, org->di_key);
6727 di->di_flags = 0;
6728 copy_tv(&org->di_tv, &di->di_tv);
6730 return di;
6734 * Remove item "item" from Dictionary "dict" and free it.
6736 static void
6737 dictitem_remove(dict, item)
6738 dict_T *dict;
6739 dictitem_T *item;
6741 hashitem_T *hi;
6743 hi = hash_find(&dict->dv_hashtab, item->di_key);
6744 if (HASHITEM_EMPTY(hi))
6745 EMSG2(_(e_intern2), "dictitem_remove()");
6746 else
6747 hash_remove(&dict->dv_hashtab, hi);
6748 dictitem_free(item);
6752 * Free a dict item. Also clears the value.
6754 static void
6755 dictitem_free(item)
6756 dictitem_T *item;
6758 clear_tv(&item->di_tv);
6759 vim_free(item);
6763 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6764 * The refcount of the new dict is set to 1.
6765 * See item_copy() for "copyID".
6766 * Returns NULL when out of memory.
6768 static dict_T *
6769 dict_copy(orig, deep, copyID)
6770 dict_T *orig;
6771 int deep;
6772 int copyID;
6774 dict_T *copy;
6775 dictitem_T *di;
6776 int todo;
6777 hashitem_T *hi;
6779 if (orig == NULL)
6780 return NULL;
6782 copy = dict_alloc();
6783 if (copy != NULL)
6785 if (copyID != 0)
6787 orig->dv_copyID = copyID;
6788 orig->dv_copydict = copy;
6790 todo = (int)orig->dv_hashtab.ht_used;
6791 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6793 if (!HASHITEM_EMPTY(hi))
6795 --todo;
6797 di = dictitem_alloc(hi->hi_key);
6798 if (di == NULL)
6799 break;
6800 if (deep)
6802 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6803 copyID) == FAIL)
6805 vim_free(di);
6806 break;
6809 else
6810 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6811 if (dict_add(copy, di) == FAIL)
6813 dictitem_free(di);
6814 break;
6819 ++copy->dv_refcount;
6820 if (todo > 0)
6822 dict_unref(copy);
6823 copy = NULL;
6827 return copy;
6831 * Add item "item" to Dictionary "d".
6832 * Returns FAIL when out of memory and when key already existed.
6834 static int
6835 dict_add(d, item)
6836 dict_T *d;
6837 dictitem_T *item;
6839 return hash_add(&d->dv_hashtab, item->di_key);
6843 * Add a number or string entry to dictionary "d".
6844 * When "str" is NULL use number "nr", otherwise use "str".
6845 * Returns FAIL when out of memory and when key already exists.
6848 dict_add_nr_str(d, key, nr, str)
6849 dict_T *d;
6850 char *key;
6851 long nr;
6852 char_u *str;
6854 dictitem_T *item;
6856 item = dictitem_alloc((char_u *)key);
6857 if (item == NULL)
6858 return FAIL;
6859 item->di_tv.v_lock = 0;
6860 if (str == NULL)
6862 item->di_tv.v_type = VAR_NUMBER;
6863 item->di_tv.vval.v_number = nr;
6865 else
6867 item->di_tv.v_type = VAR_STRING;
6868 item->di_tv.vval.v_string = vim_strsave(str);
6870 if (dict_add(d, item) == FAIL)
6872 dictitem_free(item);
6873 return FAIL;
6875 return OK;
6879 * Get the number of items in a Dictionary.
6881 static long
6882 dict_len(d)
6883 dict_T *d;
6885 if (d == NULL)
6886 return 0L;
6887 return (long)d->dv_hashtab.ht_used;
6891 * Find item "key[len]" in Dictionary "d".
6892 * If "len" is negative use strlen(key).
6893 * Returns NULL when not found.
6895 static dictitem_T *
6896 dict_find(d, key, len)
6897 dict_T *d;
6898 char_u *key;
6899 int len;
6901 #define AKEYLEN 200
6902 char_u buf[AKEYLEN];
6903 char_u *akey;
6904 char_u *tofree = NULL;
6905 hashitem_T *hi;
6907 if (len < 0)
6908 akey = key;
6909 else if (len >= AKEYLEN)
6911 tofree = akey = vim_strnsave(key, len);
6912 if (akey == NULL)
6913 return NULL;
6915 else
6917 /* Avoid a malloc/free by using buf[]. */
6918 vim_strncpy(buf, key, len);
6919 akey = buf;
6922 hi = hash_find(&d->dv_hashtab, akey);
6923 vim_free(tofree);
6924 if (HASHITEM_EMPTY(hi))
6925 return NULL;
6926 return HI2DI(hi);
6930 * Get a string item from a dictionary.
6931 * When "save" is TRUE allocate memory for it.
6932 * Returns NULL if the entry doesn't exist or out of memory.
6934 char_u *
6935 get_dict_string(d, key, save)
6936 dict_T *d;
6937 char_u *key;
6938 int save;
6940 dictitem_T *di;
6941 char_u *s;
6943 di = dict_find(d, key, -1);
6944 if (di == NULL)
6945 return NULL;
6946 s = get_tv_string(&di->di_tv);
6947 if (save && s != NULL)
6948 s = vim_strsave(s);
6949 return s;
6953 * Get a number item from a dictionary.
6954 * Returns 0 if the entry doesn't exist or out of memory.
6956 long
6957 get_dict_number(d, key)
6958 dict_T *d;
6959 char_u *key;
6961 dictitem_T *di;
6963 di = dict_find(d, key, -1);
6964 if (di == NULL)
6965 return 0;
6966 return get_tv_number(&di->di_tv);
6970 * Return an allocated string with the string representation of a Dictionary.
6971 * May return NULL.
6973 static char_u *
6974 dict2string(tv, copyID)
6975 typval_T *tv;
6976 int copyID;
6978 garray_T ga;
6979 int first = TRUE;
6980 char_u *tofree;
6981 char_u numbuf[NUMBUFLEN];
6982 hashitem_T *hi;
6983 char_u *s;
6984 dict_T *d;
6985 int todo;
6987 if ((d = tv->vval.v_dict) == NULL)
6988 return NULL;
6989 ga_init2(&ga, (int)sizeof(char), 80);
6990 ga_append(&ga, '{');
6992 todo = (int)d->dv_hashtab.ht_used;
6993 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6995 if (!HASHITEM_EMPTY(hi))
6997 --todo;
6999 if (first)
7000 first = FALSE;
7001 else
7002 ga_concat(&ga, (char_u *)", ");
7004 tofree = string_quote(hi->hi_key, FALSE);
7005 if (tofree != NULL)
7007 ga_concat(&ga, tofree);
7008 vim_free(tofree);
7010 ga_concat(&ga, (char_u *)": ");
7011 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7012 if (s != NULL)
7013 ga_concat(&ga, s);
7014 vim_free(tofree);
7015 if (s == NULL)
7016 break;
7019 if (todo > 0)
7021 vim_free(ga.ga_data);
7022 return NULL;
7025 ga_append(&ga, '}');
7026 ga_append(&ga, NUL);
7027 return (char_u *)ga.ga_data;
7031 * Allocate a variable for a Dictionary and fill it from "*arg".
7032 * Return OK or FAIL. Returns NOTDONE for {expr}.
7034 static int
7035 get_dict_tv(arg, rettv, evaluate)
7036 char_u **arg;
7037 typval_T *rettv;
7038 int evaluate;
7040 dict_T *d = NULL;
7041 typval_T tvkey;
7042 typval_T tv;
7043 char_u *key = NULL;
7044 dictitem_T *item;
7045 char_u *start = skipwhite(*arg + 1);
7046 char_u buf[NUMBUFLEN];
7049 * First check if it's not a curly-braces thing: {expr}.
7050 * Must do this without evaluating, otherwise a function may be called
7051 * twice. Unfortunately this means we need to call eval1() twice for the
7052 * first item.
7053 * But {} is an empty Dictionary.
7055 if (*start != '}')
7057 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7058 return FAIL;
7059 if (*start == '}')
7060 return NOTDONE;
7063 if (evaluate)
7065 d = dict_alloc();
7066 if (d == NULL)
7067 return FAIL;
7069 tvkey.v_type = VAR_UNKNOWN;
7070 tv.v_type = VAR_UNKNOWN;
7072 *arg = skipwhite(*arg + 1);
7073 while (**arg != '}' && **arg != NUL)
7075 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7076 goto failret;
7077 if (**arg != ':')
7079 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7080 clear_tv(&tvkey);
7081 goto failret;
7083 if (evaluate)
7085 key = get_tv_string_buf_chk(&tvkey, buf);
7086 if (key == NULL || *key == NUL)
7088 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7089 if (key != NULL)
7090 EMSG(_(e_emptykey));
7091 clear_tv(&tvkey);
7092 goto failret;
7096 *arg = skipwhite(*arg + 1);
7097 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7099 if (evaluate)
7100 clear_tv(&tvkey);
7101 goto failret;
7103 if (evaluate)
7105 item = dict_find(d, key, -1);
7106 if (item != NULL)
7108 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7109 clear_tv(&tvkey);
7110 clear_tv(&tv);
7111 goto failret;
7113 item = dictitem_alloc(key);
7114 clear_tv(&tvkey);
7115 if (item != NULL)
7117 item->di_tv = tv;
7118 item->di_tv.v_lock = 0;
7119 if (dict_add(d, item) == FAIL)
7120 dictitem_free(item);
7124 if (**arg == '}')
7125 break;
7126 if (**arg != ',')
7128 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7129 goto failret;
7131 *arg = skipwhite(*arg + 1);
7134 if (**arg != '}')
7136 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7137 failret:
7138 if (evaluate)
7139 dict_free(d, TRUE);
7140 return FAIL;
7143 *arg = skipwhite(*arg + 1);
7144 if (evaluate)
7146 rettv->v_type = VAR_DICT;
7147 rettv->vval.v_dict = d;
7148 ++d->dv_refcount;
7151 return OK;
7155 * Return a string with the string representation of a variable.
7156 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7157 * "numbuf" is used for a number.
7158 * Does not put quotes around strings, as ":echo" displays values.
7159 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7160 * May return NULL.
7162 static char_u *
7163 echo_string(tv, tofree, numbuf, copyID)
7164 typval_T *tv;
7165 char_u **tofree;
7166 char_u *numbuf;
7167 int copyID;
7169 static int recurse = 0;
7170 char_u *r = NULL;
7172 if (recurse >= DICT_MAXNEST)
7174 EMSG(_("E724: variable nested too deep for displaying"));
7175 *tofree = NULL;
7176 return NULL;
7178 ++recurse;
7180 switch (tv->v_type)
7182 case VAR_FUNC:
7183 *tofree = NULL;
7184 r = tv->vval.v_string;
7185 break;
7187 case VAR_LIST:
7188 if (tv->vval.v_list == NULL)
7190 *tofree = NULL;
7191 r = NULL;
7193 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7195 *tofree = NULL;
7196 r = (char_u *)"[...]";
7198 else
7200 tv->vval.v_list->lv_copyID = copyID;
7201 *tofree = list2string(tv, copyID);
7202 r = *tofree;
7204 break;
7206 case VAR_DICT:
7207 if (tv->vval.v_dict == NULL)
7209 *tofree = NULL;
7210 r = NULL;
7212 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7214 *tofree = NULL;
7215 r = (char_u *)"{...}";
7217 else
7219 tv->vval.v_dict->dv_copyID = copyID;
7220 *tofree = dict2string(tv, copyID);
7221 r = *tofree;
7223 break;
7225 case VAR_STRING:
7226 case VAR_NUMBER:
7227 *tofree = NULL;
7228 r = get_tv_string_buf(tv, numbuf);
7229 break;
7231 #ifdef FEAT_FLOAT
7232 case VAR_FLOAT:
7233 *tofree = NULL;
7234 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7235 r = numbuf;
7236 break;
7237 #endif
7239 default:
7240 EMSG2(_(e_intern2), "echo_string()");
7241 *tofree = NULL;
7244 --recurse;
7245 return r;
7249 * Return a string with the string representation of a variable.
7250 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7251 * "numbuf" is used for a number.
7252 * Puts quotes around strings, so that they can be parsed back by eval().
7253 * May return NULL.
7255 static char_u *
7256 tv2string(tv, tofree, numbuf, copyID)
7257 typval_T *tv;
7258 char_u **tofree;
7259 char_u *numbuf;
7260 int copyID;
7262 switch (tv->v_type)
7264 case VAR_FUNC:
7265 *tofree = string_quote(tv->vval.v_string, TRUE);
7266 return *tofree;
7267 case VAR_STRING:
7268 *tofree = string_quote(tv->vval.v_string, FALSE);
7269 return *tofree;
7270 #ifdef FEAT_FLOAT
7271 case VAR_FLOAT:
7272 *tofree = NULL;
7273 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7274 return numbuf;
7275 #endif
7276 case VAR_NUMBER:
7277 case VAR_LIST:
7278 case VAR_DICT:
7279 break;
7280 default:
7281 EMSG2(_(e_intern2), "tv2string()");
7283 return echo_string(tv, tofree, numbuf, copyID);
7287 * Return string "str" in ' quotes, doubling ' characters.
7288 * If "str" is NULL an empty string is assumed.
7289 * If "function" is TRUE make it function('string').
7291 static char_u *
7292 string_quote(str, function)
7293 char_u *str;
7294 int function;
7296 unsigned len;
7297 char_u *p, *r, *s;
7299 len = (function ? 13 : 3);
7300 if (str != NULL)
7302 len += (unsigned)STRLEN(str);
7303 for (p = str; *p != NUL; mb_ptr_adv(p))
7304 if (*p == '\'')
7305 ++len;
7307 s = r = alloc(len);
7308 if (r != NULL)
7310 if (function)
7312 STRCPY(r, "function('");
7313 r += 10;
7315 else
7316 *r++ = '\'';
7317 if (str != NULL)
7318 for (p = str; *p != NUL; )
7320 if (*p == '\'')
7321 *r++ = '\'';
7322 MB_COPY_CHAR(p, r);
7324 *r++ = '\'';
7325 if (function)
7326 *r++ = ')';
7327 *r++ = NUL;
7329 return s;
7332 #ifdef FEAT_FLOAT
7334 * Convert the string "text" to a floating point number.
7335 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7336 * this always uses a decimal point.
7337 * Returns the length of the text that was consumed.
7339 static int
7340 string2float(text, value)
7341 char_u *text;
7342 float_T *value; /* result stored here */
7344 char *s = (char *)text;
7345 float_T f;
7347 f = strtod(s, &s);
7348 *value = f;
7349 return (int)((char_u *)s - text);
7351 #endif
7354 * Get the value of an environment variable.
7355 * "arg" is pointing to the '$'. It is advanced to after the name.
7356 * If the environment variable was not set, silently assume it is empty.
7357 * Always return OK.
7359 static int
7360 get_env_tv(arg, rettv, evaluate)
7361 char_u **arg;
7362 typval_T *rettv;
7363 int evaluate;
7365 char_u *string = NULL;
7366 int len;
7367 int cc;
7368 char_u *name;
7369 int mustfree = FALSE;
7371 ++*arg;
7372 name = *arg;
7373 len = get_env_len(arg);
7374 if (evaluate)
7376 if (len != 0)
7378 cc = name[len];
7379 name[len] = NUL;
7380 /* first try vim_getenv(), fast for normal environment vars */
7381 string = vim_getenv(name, &mustfree);
7382 if (string != NULL && *string != NUL)
7384 if (!mustfree)
7385 string = vim_strsave(string);
7387 else
7389 if (mustfree)
7390 vim_free(string);
7392 /* next try expanding things like $VIM and ${HOME} */
7393 string = expand_env_save(name - 1);
7394 if (string != NULL && *string == '$')
7396 vim_free(string);
7397 string = NULL;
7400 name[len] = cc;
7402 rettv->v_type = VAR_STRING;
7403 rettv->vval.v_string = string;
7406 return OK;
7410 * Array with names and number of arguments of all internal functions
7411 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7413 static struct fst
7415 char *f_name; /* function name */
7416 char f_min_argc; /* minimal number of arguments */
7417 char f_max_argc; /* maximal number of arguments */
7418 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7419 /* implementation of function */
7420 } functions[] =
7422 #ifdef FEAT_FLOAT
7423 {"abs", 1, 1, f_abs},
7424 #endif
7425 {"add", 2, 2, f_add},
7426 {"append", 2, 2, f_append},
7427 {"argc", 0, 0, f_argc},
7428 {"argidx", 0, 0, f_argidx},
7429 {"argv", 0, 1, f_argv},
7430 #ifdef FEAT_FLOAT
7431 {"atan", 1, 1, f_atan},
7432 #endif
7433 {"browse", 4, 4, f_browse},
7434 {"browsedir", 2, 2, f_browsedir},
7435 {"bufexists", 1, 1, f_bufexists},
7436 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7437 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7438 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7439 {"buflisted", 1, 1, f_buflisted},
7440 {"bufloaded", 1, 1, f_bufloaded},
7441 {"bufname", 1, 1, f_bufname},
7442 {"bufnr", 1, 2, f_bufnr},
7443 {"bufwinnr", 1, 1, f_bufwinnr},
7444 {"byte2line", 1, 1, f_byte2line},
7445 {"byteidx", 2, 2, f_byteidx},
7446 {"call", 2, 3, f_call},
7447 #ifdef FEAT_FLOAT
7448 {"ceil", 1, 1, f_ceil},
7449 #endif
7450 {"changenr", 0, 0, f_changenr},
7451 {"char2nr", 1, 1, f_char2nr},
7452 {"cindent", 1, 1, f_cindent},
7453 {"clearmatches", 0, 0, f_clearmatches},
7454 {"col", 1, 1, f_col},
7455 #if defined(FEAT_INS_EXPAND)
7456 {"complete", 2, 2, f_complete},
7457 {"complete_add", 1, 1, f_complete_add},
7458 {"complete_check", 0, 0, f_complete_check},
7459 #endif
7460 {"confirm", 1, 4, f_confirm},
7461 {"copy", 1, 1, f_copy},
7462 #ifdef FEAT_FLOAT
7463 {"cos", 1, 1, f_cos},
7464 #endif
7465 {"count", 2, 4, f_count},
7466 {"cscope_connection",0,3, f_cscope_connection},
7467 {"cursor", 1, 3, f_cursor},
7468 {"deepcopy", 1, 2, f_deepcopy},
7469 {"delete", 1, 1, f_delete},
7470 {"did_filetype", 0, 0, f_did_filetype},
7471 {"diff_filler", 1, 1, f_diff_filler},
7472 {"diff_hlID", 2, 2, f_diff_hlID},
7473 {"empty", 1, 1, f_empty},
7474 {"escape", 2, 2, f_escape},
7475 {"eval", 1, 1, f_eval},
7476 {"eventhandler", 0, 0, f_eventhandler},
7477 {"executable", 1, 1, f_executable},
7478 {"exists", 1, 1, f_exists},
7479 {"expand", 1, 2, f_expand},
7480 {"extend", 2, 3, f_extend},
7481 {"feedkeys", 1, 2, f_feedkeys},
7482 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7483 {"filereadable", 1, 1, f_filereadable},
7484 {"filewritable", 1, 1, f_filewritable},
7485 {"filter", 2, 2, f_filter},
7486 {"finddir", 1, 3, f_finddir},
7487 {"findfile", 1, 3, f_findfile},
7488 #ifdef FEAT_FLOAT
7489 {"float2nr", 1, 1, f_float2nr},
7490 {"floor", 1, 1, f_floor},
7491 #endif
7492 {"fnameescape", 1, 1, f_fnameescape},
7493 {"fnamemodify", 2, 2, f_fnamemodify},
7494 {"foldclosed", 1, 1, f_foldclosed},
7495 {"foldclosedend", 1, 1, f_foldclosedend},
7496 {"foldlevel", 1, 1, f_foldlevel},
7497 {"foldtext", 0, 0, f_foldtext},
7498 {"foldtextresult", 1, 1, f_foldtextresult},
7499 {"foreground", 0, 0, f_foreground},
7500 {"function", 1, 1, f_function},
7501 {"garbagecollect", 0, 1, f_garbagecollect},
7502 {"get", 2, 3, f_get},
7503 {"getbufline", 2, 3, f_getbufline},
7504 {"getbufvar", 2, 2, f_getbufvar},
7505 {"getchar", 0, 1, f_getchar},
7506 {"getcharmod", 0, 0, f_getcharmod},
7507 {"getcmdline", 0, 0, f_getcmdline},
7508 {"getcmdpos", 0, 0, f_getcmdpos},
7509 {"getcmdtype", 0, 0, f_getcmdtype},
7510 {"getcwd", 0, 0, f_getcwd},
7511 {"getfontname", 0, 1, f_getfontname},
7512 {"getfperm", 1, 1, f_getfperm},
7513 {"getfsize", 1, 1, f_getfsize},
7514 {"getftime", 1, 1, f_getftime},
7515 {"getftype", 1, 1, f_getftype},
7516 {"getline", 1, 2, f_getline},
7517 {"getloclist", 1, 1, f_getqflist},
7518 {"getmatches", 0, 0, f_getmatches},
7519 {"getpid", 0, 0, f_getpid},
7520 {"getpos", 1, 1, f_getpos},
7521 {"getqflist", 0, 0, f_getqflist},
7522 {"getreg", 0, 2, f_getreg},
7523 {"getregtype", 0, 1, f_getregtype},
7524 {"gettabwinvar", 3, 3, f_gettabwinvar},
7525 {"getwinposx", 0, 0, f_getwinposx},
7526 {"getwinposy", 0, 0, f_getwinposy},
7527 {"getwinvar", 2, 2, f_getwinvar},
7528 {"glob", 1, 1, f_glob},
7529 {"globpath", 2, 2, f_globpath},
7530 {"has", 1, 1, f_has},
7531 {"has_key", 2, 2, f_has_key},
7532 {"haslocaldir", 0, 0, f_haslocaldir},
7533 {"hasmapto", 1, 3, f_hasmapto},
7534 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7535 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7536 {"histadd", 2, 2, f_histadd},
7537 {"histdel", 1, 2, f_histdel},
7538 {"histget", 1, 2, f_histget},
7539 {"histnr", 1, 1, f_histnr},
7540 {"hlID", 1, 1, f_hlID},
7541 {"hlexists", 1, 1, f_hlexists},
7542 {"hostname", 0, 0, f_hostname},
7543 {"iconv", 3, 3, f_iconv},
7544 {"indent", 1, 1, f_indent},
7545 {"index", 2, 4, f_index},
7546 {"input", 1, 3, f_input},
7547 {"inputdialog", 1, 3, f_inputdialog},
7548 {"inputlist", 1, 1, f_inputlist},
7549 {"inputrestore", 0, 0, f_inputrestore},
7550 {"inputsave", 0, 0, f_inputsave},
7551 {"inputsecret", 1, 2, f_inputsecret},
7552 {"insert", 2, 3, f_insert},
7553 {"isdirectory", 1, 1, f_isdirectory},
7554 {"islocked", 1, 1, f_islocked},
7555 {"items", 1, 1, f_items},
7556 {"join", 1, 2, f_join},
7557 {"keys", 1, 1, f_keys},
7558 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7559 {"len", 1, 1, f_len},
7560 {"libcall", 3, 3, f_libcall},
7561 {"libcallnr", 3, 3, f_libcallnr},
7562 {"line", 1, 1, f_line},
7563 {"line2byte", 1, 1, f_line2byte},
7564 {"lispindent", 1, 1, f_lispindent},
7565 {"localtime", 0, 0, f_localtime},
7566 #ifdef FEAT_FLOAT
7567 {"log10", 1, 1, f_log10},
7568 #endif
7569 {"map", 2, 2, f_map},
7570 {"maparg", 1, 3, f_maparg},
7571 {"mapcheck", 1, 3, f_mapcheck},
7572 {"match", 2, 4, f_match},
7573 {"matchadd", 2, 4, f_matchadd},
7574 {"matcharg", 1, 1, f_matcharg},
7575 {"matchdelete", 1, 1, f_matchdelete},
7576 {"matchend", 2, 4, f_matchend},
7577 {"matchlist", 2, 4, f_matchlist},
7578 {"matchstr", 2, 4, f_matchstr},
7579 {"max", 1, 1, f_max},
7580 {"min", 1, 1, f_min},
7581 #ifdef vim_mkdir
7582 {"mkdir", 1, 3, f_mkdir},
7583 #endif
7584 {"mode", 0, 1, f_mode},
7585 {"nextnonblank", 1, 1, f_nextnonblank},
7586 {"nr2char", 1, 1, f_nr2char},
7587 {"pathshorten", 1, 1, f_pathshorten},
7588 #ifdef FEAT_FLOAT
7589 {"pow", 2, 2, f_pow},
7590 #endif
7591 {"prevnonblank", 1, 1, f_prevnonblank},
7592 {"printf", 2, 19, f_printf},
7593 {"pumvisible", 0, 0, f_pumvisible},
7594 {"range", 1, 3, f_range},
7595 {"readfile", 1, 3, f_readfile},
7596 {"reltime", 0, 2, f_reltime},
7597 {"reltimestr", 1, 1, f_reltimestr},
7598 {"remote_expr", 2, 3, f_remote_expr},
7599 {"remote_foreground", 1, 1, f_remote_foreground},
7600 {"remote_peek", 1, 2, f_remote_peek},
7601 {"remote_read", 1, 1, f_remote_read},
7602 {"remote_send", 2, 3, f_remote_send},
7603 {"remove", 2, 3, f_remove},
7604 {"rename", 2, 2, f_rename},
7605 {"repeat", 2, 2, f_repeat},
7606 {"resolve", 1, 1, f_resolve},
7607 {"reverse", 1, 1, f_reverse},
7608 #ifdef FEAT_FLOAT
7609 {"round", 1, 1, f_round},
7610 #endif
7611 {"search", 1, 4, f_search},
7612 {"searchdecl", 1, 3, f_searchdecl},
7613 {"searchpair", 3, 7, f_searchpair},
7614 {"searchpairpos", 3, 7, f_searchpairpos},
7615 {"searchpos", 1, 4, f_searchpos},
7616 {"server2client", 2, 2, f_server2client},
7617 {"serverlist", 0, 0, f_serverlist},
7618 {"setbufvar", 3, 3, f_setbufvar},
7619 {"setcmdpos", 1, 1, f_setcmdpos},
7620 {"setline", 2, 2, f_setline},
7621 {"setloclist", 2, 3, f_setloclist},
7622 {"setmatches", 1, 1, f_setmatches},
7623 {"setpos", 2, 2, f_setpos},
7624 {"setqflist", 1, 2, f_setqflist},
7625 {"setreg", 2, 3, f_setreg},
7626 {"settabwinvar", 4, 4, f_settabwinvar},
7627 {"setwinvar", 3, 3, f_setwinvar},
7628 {"shellescape", 1, 2, f_shellescape},
7629 {"simplify", 1, 1, f_simplify},
7630 #ifdef FEAT_FLOAT
7631 {"sin", 1, 1, f_sin},
7632 #endif
7633 {"sort", 1, 2, f_sort},
7634 {"soundfold", 1, 1, f_soundfold},
7635 {"spellbadword", 0, 1, f_spellbadword},
7636 {"spellsuggest", 1, 3, f_spellsuggest},
7637 {"split", 1, 3, f_split},
7638 #ifdef FEAT_FLOAT
7639 {"sqrt", 1, 1, f_sqrt},
7640 {"str2float", 1, 1, f_str2float},
7641 #endif
7642 {"str2nr", 1, 2, f_str2nr},
7643 #ifdef HAVE_STRFTIME
7644 {"strftime", 1, 2, f_strftime},
7645 #endif
7646 {"stridx", 2, 3, f_stridx},
7647 {"string", 1, 1, f_string},
7648 {"strlen", 1, 1, f_strlen},
7649 {"strpart", 2, 3, f_strpart},
7650 {"strridx", 2, 3, f_strridx},
7651 {"strtrans", 1, 1, f_strtrans},
7652 {"submatch", 1, 1, f_submatch},
7653 {"substitute", 4, 4, f_substitute},
7654 {"synID", 3, 3, f_synID},
7655 {"synIDattr", 2, 3, f_synIDattr},
7656 {"synIDtrans", 1, 1, f_synIDtrans},
7657 {"synstack", 2, 2, f_synstack},
7658 {"system", 1, 2, f_system},
7659 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7660 {"tabpagenr", 0, 1, f_tabpagenr},
7661 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7662 {"tagfiles", 0, 0, f_tagfiles},
7663 {"taglist", 1, 1, f_taglist},
7664 {"tempname", 0, 0, f_tempname},
7665 {"test", 1, 1, f_test},
7666 {"tolower", 1, 1, f_tolower},
7667 {"toupper", 1, 1, f_toupper},
7668 {"tr", 3, 3, f_tr},
7669 #ifdef FEAT_FLOAT
7670 {"trunc", 1, 1, f_trunc},
7671 #endif
7672 {"type", 1, 1, f_type},
7673 {"values", 1, 1, f_values},
7674 {"virtcol", 1, 1, f_virtcol},
7675 {"visualmode", 0, 1, f_visualmode},
7676 {"winbufnr", 1, 1, f_winbufnr},
7677 {"wincol", 0, 0, f_wincol},
7678 {"winheight", 1, 1, f_winheight},
7679 {"winline", 0, 0, f_winline},
7680 {"winnr", 0, 1, f_winnr},
7681 {"winrestcmd", 0, 0, f_winrestcmd},
7682 {"winrestview", 1, 1, f_winrestview},
7683 {"winsaveview", 0, 0, f_winsaveview},
7684 {"winwidth", 1, 1, f_winwidth},
7685 {"writefile", 2, 3, f_writefile},
7688 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7691 * Function given to ExpandGeneric() to obtain the list of internal
7692 * or user defined function names.
7694 char_u *
7695 get_function_name(xp, idx)
7696 expand_T *xp;
7697 int idx;
7699 static int intidx = -1;
7700 char_u *name;
7702 if (idx == 0)
7703 intidx = -1;
7704 if (intidx < 0)
7706 name = get_user_func_name(xp, idx);
7707 if (name != NULL)
7708 return name;
7710 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7712 STRCPY(IObuff, functions[intidx].f_name);
7713 STRCAT(IObuff, "(");
7714 if (functions[intidx].f_max_argc == 0)
7715 STRCAT(IObuff, ")");
7716 return IObuff;
7719 return NULL;
7723 * Function given to ExpandGeneric() to obtain the list of internal or
7724 * user defined variable or function names.
7726 /*ARGSUSED*/
7727 char_u *
7728 get_expr_name(xp, idx)
7729 expand_T *xp;
7730 int idx;
7732 static int intidx = -1;
7733 char_u *name;
7735 if (idx == 0)
7736 intidx = -1;
7737 if (intidx < 0)
7739 name = get_function_name(xp, idx);
7740 if (name != NULL)
7741 return name;
7743 return get_user_var_name(xp, ++intidx);
7746 #endif /* FEAT_CMDL_COMPL */
7749 * Find internal function in table above.
7750 * Return index, or -1 if not found
7752 static int
7753 find_internal_func(name)
7754 char_u *name; /* name of the function */
7756 int first = 0;
7757 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7758 int cmp;
7759 int x;
7762 * Find the function name in the table. Binary search.
7764 while (first <= last)
7766 x = first + ((unsigned)(last - first) >> 1);
7767 cmp = STRCMP(name, functions[x].f_name);
7768 if (cmp < 0)
7769 last = x - 1;
7770 else if (cmp > 0)
7771 first = x + 1;
7772 else
7773 return x;
7775 return -1;
7779 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7780 * name it contains, otherwise return "name".
7782 static char_u *
7783 deref_func_name(name, lenp)
7784 char_u *name;
7785 int *lenp;
7787 dictitem_T *v;
7788 int cc;
7790 cc = name[*lenp];
7791 name[*lenp] = NUL;
7792 v = find_var(name, NULL);
7793 name[*lenp] = cc;
7794 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7796 if (v->di_tv.vval.v_string == NULL)
7798 *lenp = 0;
7799 return (char_u *)""; /* just in case */
7801 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7802 return v->di_tv.vval.v_string;
7805 return name;
7809 * Allocate a variable for the result of a function.
7810 * Return OK or FAIL.
7812 static int
7813 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7814 evaluate, selfdict)
7815 char_u *name; /* name of the function */
7816 int len; /* length of "name" */
7817 typval_T *rettv;
7818 char_u **arg; /* argument, pointing to the '(' */
7819 linenr_T firstline; /* first line of range */
7820 linenr_T lastline; /* last line of range */
7821 int *doesrange; /* return: function handled range */
7822 int evaluate;
7823 dict_T *selfdict; /* Dictionary for "self" */
7825 char_u *argp;
7826 int ret = OK;
7827 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7828 int argcount = 0; /* number of arguments found */
7831 * Get the arguments.
7833 argp = *arg;
7834 while (argcount < MAX_FUNC_ARGS)
7836 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7837 if (*argp == ')' || *argp == ',' || *argp == NUL)
7838 break;
7839 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7841 ret = FAIL;
7842 break;
7844 ++argcount;
7845 if (*argp != ',')
7846 break;
7848 if (*argp == ')')
7849 ++argp;
7850 else
7851 ret = FAIL;
7853 if (ret == OK)
7854 ret = call_func(name, len, rettv, argcount, argvars,
7855 firstline, lastline, doesrange, evaluate, selfdict);
7856 else if (!aborting())
7858 if (argcount == MAX_FUNC_ARGS)
7859 emsg_funcname("E740: Too many arguments for function %s", name);
7860 else
7861 emsg_funcname("E116: Invalid arguments for function %s", name);
7864 while (--argcount >= 0)
7865 clear_tv(&argvars[argcount]);
7867 *arg = skipwhite(argp);
7868 return ret;
7873 * Call a function with its resolved parameters
7874 * Return OK when the function can't be called, FAIL otherwise.
7875 * Also returns OK when an error was encountered while executing the function.
7877 static int
7878 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7879 doesrange, evaluate, selfdict)
7880 char_u *name; /* name of the function */
7881 int len; /* length of "name" */
7882 typval_T *rettv; /* return value goes here */
7883 int argcount; /* number of "argvars" */
7884 typval_T *argvars; /* vars for arguments, must have "argcount"
7885 PLUS ONE elements! */
7886 linenr_T firstline; /* first line of range */
7887 linenr_T lastline; /* last line of range */
7888 int *doesrange; /* return: function handled range */
7889 int evaluate;
7890 dict_T *selfdict; /* Dictionary for "self" */
7892 int ret = FAIL;
7893 #define ERROR_UNKNOWN 0
7894 #define ERROR_TOOMANY 1
7895 #define ERROR_TOOFEW 2
7896 #define ERROR_SCRIPT 3
7897 #define ERROR_DICT 4
7898 #define ERROR_NONE 5
7899 #define ERROR_OTHER 6
7900 int error = ERROR_NONE;
7901 int i;
7902 int llen;
7903 ufunc_T *fp;
7904 int cc;
7905 #define FLEN_FIXED 40
7906 char_u fname_buf[FLEN_FIXED + 1];
7907 char_u *fname;
7910 * In a script change <SID>name() and s:name() to K_SNR 123_name().
7911 * Change <SNR>123_name() to K_SNR 123_name().
7912 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
7914 cc = name[len];
7915 name[len] = NUL;
7916 llen = eval_fname_script(name);
7917 if (llen > 0)
7919 fname_buf[0] = K_SPECIAL;
7920 fname_buf[1] = KS_EXTRA;
7921 fname_buf[2] = (int)KE_SNR;
7922 i = 3;
7923 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
7925 if (current_SID <= 0)
7926 error = ERROR_SCRIPT;
7927 else
7929 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
7930 i = (int)STRLEN(fname_buf);
7933 if (i + STRLEN(name + llen) < FLEN_FIXED)
7935 STRCPY(fname_buf + i, name + llen);
7936 fname = fname_buf;
7938 else
7940 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
7941 if (fname == NULL)
7942 error = ERROR_OTHER;
7943 else
7945 mch_memmove(fname, fname_buf, (size_t)i);
7946 STRCPY(fname + i, name + llen);
7950 else
7951 fname = name;
7953 *doesrange = FALSE;
7956 /* execute the function if no errors detected and executing */
7957 if (evaluate && error == ERROR_NONE)
7959 rettv->v_type = VAR_NUMBER; /* default is number rettv */
7960 error = ERROR_UNKNOWN;
7962 if (!builtin_function(fname))
7965 * User defined function.
7967 fp = find_func(fname);
7969 #ifdef FEAT_AUTOCMD
7970 /* Trigger FuncUndefined event, may load the function. */
7971 if (fp == NULL
7972 && apply_autocmds(EVENT_FUNCUNDEFINED,
7973 fname, fname, TRUE, NULL)
7974 && !aborting())
7976 /* executed an autocommand, search for the function again */
7977 fp = find_func(fname);
7979 #endif
7980 /* Try loading a package. */
7981 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
7983 /* loaded a package, search for the function again */
7984 fp = find_func(fname);
7987 if (fp != NULL)
7989 if (fp->uf_flags & FC_RANGE)
7990 *doesrange = TRUE;
7991 if (argcount < fp->uf_args.ga_len)
7992 error = ERROR_TOOFEW;
7993 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
7994 error = ERROR_TOOMANY;
7995 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
7996 error = ERROR_DICT;
7997 else
8000 * Call the user function.
8001 * Save and restore search patterns, script variables and
8002 * redo buffer.
8004 save_search_patterns();
8005 saveRedobuff();
8006 ++fp->uf_calls;
8007 call_user_func(fp, argcount, argvars, rettv,
8008 firstline, lastline,
8009 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8010 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8011 && fp->uf_refcount <= 0)
8012 /* Function was unreferenced while being used, free it
8013 * now. */
8014 func_free(fp);
8015 restoreRedobuff();
8016 restore_search_patterns();
8017 error = ERROR_NONE;
8021 else
8024 * Find the function name in the table, call its implementation.
8026 i = find_internal_func(fname);
8027 if (i >= 0)
8029 if (argcount < functions[i].f_min_argc)
8030 error = ERROR_TOOFEW;
8031 else if (argcount > functions[i].f_max_argc)
8032 error = ERROR_TOOMANY;
8033 else
8035 argvars[argcount].v_type = VAR_UNKNOWN;
8036 functions[i].f_func(argvars, rettv);
8037 error = ERROR_NONE;
8042 * The function call (or "FuncUndefined" autocommand sequence) might
8043 * have been aborted by an error, an interrupt, or an explicitly thrown
8044 * exception that has not been caught so far. This situation can be
8045 * tested for by calling aborting(). For an error in an internal
8046 * function or for the "E132" error in call_user_func(), however, the
8047 * throw point at which the "force_abort" flag (temporarily reset by
8048 * emsg()) is normally updated has not been reached yet. We need to
8049 * update that flag first to make aborting() reliable.
8051 update_force_abort();
8053 if (error == ERROR_NONE)
8054 ret = OK;
8057 * Report an error unless the argument evaluation or function call has been
8058 * cancelled due to an aborting error, an interrupt, or an exception.
8060 if (!aborting())
8062 switch (error)
8064 case ERROR_UNKNOWN:
8065 emsg_funcname(N_("E117: Unknown function: %s"), name);
8066 break;
8067 case ERROR_TOOMANY:
8068 emsg_funcname(e_toomanyarg, name);
8069 break;
8070 case ERROR_TOOFEW:
8071 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8072 name);
8073 break;
8074 case ERROR_SCRIPT:
8075 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8076 name);
8077 break;
8078 case ERROR_DICT:
8079 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8080 name);
8081 break;
8085 name[len] = cc;
8086 if (fname != name && fname != fname_buf)
8087 vim_free(fname);
8089 return ret;
8093 * Give an error message with a function name. Handle <SNR> things.
8095 static void
8096 emsg_funcname(ermsg, name)
8097 char *ermsg;
8098 char_u *name;
8100 char_u *p;
8102 if (*name == K_SPECIAL)
8103 p = concat_str((char_u *)"<SNR>", name + 3);
8104 else
8105 p = name;
8106 EMSG2(_(ermsg), p);
8107 if (p != name)
8108 vim_free(p);
8112 * Return TRUE for a non-zero Number and a non-empty String.
8114 static int
8115 non_zero_arg(argvars)
8116 typval_T *argvars;
8118 return ((argvars[0].v_type == VAR_NUMBER
8119 && argvars[0].vval.v_number != 0)
8120 || (argvars[0].v_type == VAR_STRING
8121 && argvars[0].vval.v_string != NULL
8122 && *argvars[0].vval.v_string != NUL));
8125 /*********************************************
8126 * Implementation of the built-in functions
8129 #ifdef FEAT_FLOAT
8131 * "abs(expr)" function
8133 static void
8134 f_abs(argvars, rettv)
8135 typval_T *argvars;
8136 typval_T *rettv;
8138 if (argvars[0].v_type == VAR_FLOAT)
8140 rettv->v_type = VAR_FLOAT;
8141 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8143 else
8145 varnumber_T n;
8146 int error = FALSE;
8148 n = get_tv_number_chk(&argvars[0], &error);
8149 if (error)
8150 rettv->vval.v_number = -1;
8151 else if (n > 0)
8152 rettv->vval.v_number = n;
8153 else
8154 rettv->vval.v_number = -n;
8157 #endif
8160 * "add(list, item)" function
8162 static void
8163 f_add(argvars, rettv)
8164 typval_T *argvars;
8165 typval_T *rettv;
8167 list_T *l;
8169 rettv->vval.v_number = 1; /* Default: Failed */
8170 if (argvars[0].v_type == VAR_LIST)
8172 if ((l = argvars[0].vval.v_list) != NULL
8173 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8174 && list_append_tv(l, &argvars[1]) == OK)
8175 copy_tv(&argvars[0], rettv);
8177 else
8178 EMSG(_(e_listreq));
8182 * "append(lnum, string/list)" function
8184 static void
8185 f_append(argvars, rettv)
8186 typval_T *argvars;
8187 typval_T *rettv;
8189 long lnum;
8190 char_u *line;
8191 list_T *l = NULL;
8192 listitem_T *li = NULL;
8193 typval_T *tv;
8194 long added = 0;
8196 lnum = get_tv_lnum(argvars);
8197 if (lnum >= 0
8198 && lnum <= curbuf->b_ml.ml_line_count
8199 && u_save(lnum, lnum + 1) == OK)
8201 if (argvars[1].v_type == VAR_LIST)
8203 l = argvars[1].vval.v_list;
8204 if (l == NULL)
8205 return;
8206 li = l->lv_first;
8208 rettv->vval.v_number = 0; /* Default: Success */
8209 for (;;)
8211 if (l == NULL)
8212 tv = &argvars[1]; /* append a string */
8213 else if (li == NULL)
8214 break; /* end of list */
8215 else
8216 tv = &li->li_tv; /* append item from list */
8217 line = get_tv_string_chk(tv);
8218 if (line == NULL) /* type error */
8220 rettv->vval.v_number = 1; /* Failed */
8221 break;
8223 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8224 ++added;
8225 if (l == NULL)
8226 break;
8227 li = li->li_next;
8230 appended_lines_mark(lnum, added);
8231 if (curwin->w_cursor.lnum > lnum)
8232 curwin->w_cursor.lnum += added;
8234 else
8235 rettv->vval.v_number = 1; /* Failed */
8239 * "argc()" function
8241 /* ARGSUSED */
8242 static void
8243 f_argc(argvars, rettv)
8244 typval_T *argvars;
8245 typval_T *rettv;
8247 rettv->vval.v_number = ARGCOUNT;
8251 * "argidx()" function
8253 /* ARGSUSED */
8254 static void
8255 f_argidx(argvars, rettv)
8256 typval_T *argvars;
8257 typval_T *rettv;
8259 rettv->vval.v_number = curwin->w_arg_idx;
8263 * "argv(nr)" function
8265 static void
8266 f_argv(argvars, rettv)
8267 typval_T *argvars;
8268 typval_T *rettv;
8270 int idx;
8272 if (argvars[0].v_type != VAR_UNKNOWN)
8274 idx = get_tv_number_chk(&argvars[0], NULL);
8275 if (idx >= 0 && idx < ARGCOUNT)
8276 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8277 else
8278 rettv->vval.v_string = NULL;
8279 rettv->v_type = VAR_STRING;
8281 else if (rettv_list_alloc(rettv) == OK)
8282 for (idx = 0; idx < ARGCOUNT; ++idx)
8283 list_append_string(rettv->vval.v_list,
8284 alist_name(&ARGLIST[idx]), -1);
8287 #ifdef FEAT_FLOAT
8288 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8291 * Get the float value of "argvars[0]" into "f".
8292 * Returns FAIL when the argument is not a Number or Float.
8294 static int
8295 get_float_arg(argvars, f)
8296 typval_T *argvars;
8297 float_T *f;
8299 if (argvars[0].v_type == VAR_FLOAT)
8301 *f = argvars[0].vval.v_float;
8302 return OK;
8304 if (argvars[0].v_type == VAR_NUMBER)
8306 *f = (float_T)argvars[0].vval.v_number;
8307 return OK;
8309 EMSG(_("E808: Number or Float required"));
8310 return FAIL;
8314 * "atan()" function
8316 static void
8317 f_atan(argvars, rettv)
8318 typval_T *argvars;
8319 typval_T *rettv;
8321 float_T f;
8323 rettv->v_type = VAR_FLOAT;
8324 if (get_float_arg(argvars, &f) == OK)
8325 rettv->vval.v_float = atan(f);
8326 else
8327 rettv->vval.v_float = 0.0;
8329 #endif
8332 * "browse(save, title, initdir, default)" function
8334 /* ARGSUSED */
8335 static void
8336 f_browse(argvars, rettv)
8337 typval_T *argvars;
8338 typval_T *rettv;
8340 #ifdef FEAT_BROWSE
8341 int save;
8342 char_u *title;
8343 char_u *initdir;
8344 char_u *defname;
8345 char_u buf[NUMBUFLEN];
8346 char_u buf2[NUMBUFLEN];
8347 int error = FALSE;
8349 save = get_tv_number_chk(&argvars[0], &error);
8350 title = get_tv_string_chk(&argvars[1]);
8351 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8352 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8354 if (error || title == NULL || initdir == NULL || defname == NULL)
8355 rettv->vval.v_string = NULL;
8356 else
8357 rettv->vval.v_string =
8358 do_browse(save ? BROWSE_SAVE : 0,
8359 title, defname, NULL, initdir, NULL, curbuf);
8360 #else
8361 rettv->vval.v_string = NULL;
8362 #endif
8363 rettv->v_type = VAR_STRING;
8367 * "browsedir(title, initdir)" function
8369 /* ARGSUSED */
8370 static void
8371 f_browsedir(argvars, rettv)
8372 typval_T *argvars;
8373 typval_T *rettv;
8375 #ifdef FEAT_BROWSE
8376 char_u *title;
8377 char_u *initdir;
8378 char_u buf[NUMBUFLEN];
8380 title = get_tv_string_chk(&argvars[0]);
8381 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8383 if (title == NULL || initdir == NULL)
8384 rettv->vval.v_string = NULL;
8385 else
8386 rettv->vval.v_string = do_browse(BROWSE_DIR,
8387 title, NULL, NULL, initdir, NULL, curbuf);
8388 #else
8389 rettv->vval.v_string = NULL;
8390 #endif
8391 rettv->v_type = VAR_STRING;
8394 static buf_T *find_buffer __ARGS((typval_T *avar));
8397 * Find a buffer by number or exact name.
8399 static buf_T *
8400 find_buffer(avar)
8401 typval_T *avar;
8403 buf_T *buf = NULL;
8405 if (avar->v_type == VAR_NUMBER)
8406 buf = buflist_findnr((int)avar->vval.v_number);
8407 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8409 buf = buflist_findname_exp(avar->vval.v_string);
8410 if (buf == NULL)
8412 /* No full path name match, try a match with a URL or a "nofile"
8413 * buffer, these don't use the full path. */
8414 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8415 if (buf->b_fname != NULL
8416 && (path_with_url(buf->b_fname)
8417 #ifdef FEAT_QUICKFIX
8418 || bt_nofile(buf)
8419 #endif
8421 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8422 break;
8425 return buf;
8429 * "bufexists(expr)" function
8431 static void
8432 f_bufexists(argvars, rettv)
8433 typval_T *argvars;
8434 typval_T *rettv;
8436 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8440 * "buflisted(expr)" function
8442 static void
8443 f_buflisted(argvars, rettv)
8444 typval_T *argvars;
8445 typval_T *rettv;
8447 buf_T *buf;
8449 buf = find_buffer(&argvars[0]);
8450 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8454 * "bufloaded(expr)" function
8456 static void
8457 f_bufloaded(argvars, rettv)
8458 typval_T *argvars;
8459 typval_T *rettv;
8461 buf_T *buf;
8463 buf = find_buffer(&argvars[0]);
8464 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8467 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8470 * Get buffer by number or pattern.
8472 static buf_T *
8473 get_buf_tv(tv)
8474 typval_T *tv;
8476 char_u *name = tv->vval.v_string;
8477 int save_magic;
8478 char_u *save_cpo;
8479 buf_T *buf;
8481 if (tv->v_type == VAR_NUMBER)
8482 return buflist_findnr((int)tv->vval.v_number);
8483 if (tv->v_type != VAR_STRING)
8484 return NULL;
8485 if (name == NULL || *name == NUL)
8486 return curbuf;
8487 if (name[0] == '$' && name[1] == NUL)
8488 return lastbuf;
8490 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8491 save_magic = p_magic;
8492 p_magic = TRUE;
8493 save_cpo = p_cpo;
8494 p_cpo = (char_u *)"";
8496 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8497 TRUE, FALSE));
8499 p_magic = save_magic;
8500 p_cpo = save_cpo;
8502 /* If not found, try expanding the name, like done for bufexists(). */
8503 if (buf == NULL)
8504 buf = find_buffer(tv);
8506 return buf;
8510 * "bufname(expr)" function
8512 static void
8513 f_bufname(argvars, rettv)
8514 typval_T *argvars;
8515 typval_T *rettv;
8517 buf_T *buf;
8519 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8520 ++emsg_off;
8521 buf = get_buf_tv(&argvars[0]);
8522 rettv->v_type = VAR_STRING;
8523 if (buf != NULL && buf->b_fname != NULL)
8524 rettv->vval.v_string = vim_strsave(buf->b_fname);
8525 else
8526 rettv->vval.v_string = NULL;
8527 --emsg_off;
8531 * "bufnr(expr)" function
8533 static void
8534 f_bufnr(argvars, rettv)
8535 typval_T *argvars;
8536 typval_T *rettv;
8538 buf_T *buf;
8539 int error = FALSE;
8540 char_u *name;
8542 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8543 ++emsg_off;
8544 buf = get_buf_tv(&argvars[0]);
8545 --emsg_off;
8547 /* If the buffer isn't found and the second argument is not zero create a
8548 * new buffer. */
8549 if (buf == NULL
8550 && argvars[1].v_type != VAR_UNKNOWN
8551 && get_tv_number_chk(&argvars[1], &error) != 0
8552 && !error
8553 && (name = get_tv_string_chk(&argvars[0])) != NULL
8554 && !error)
8555 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8557 if (buf != NULL)
8558 rettv->vval.v_number = buf->b_fnum;
8559 else
8560 rettv->vval.v_number = -1;
8564 * "bufwinnr(nr)" function
8566 static void
8567 f_bufwinnr(argvars, rettv)
8568 typval_T *argvars;
8569 typval_T *rettv;
8571 #ifdef FEAT_WINDOWS
8572 win_T *wp;
8573 int winnr = 0;
8574 #endif
8575 buf_T *buf;
8577 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8578 ++emsg_off;
8579 buf = get_buf_tv(&argvars[0]);
8580 #ifdef FEAT_WINDOWS
8581 for (wp = firstwin; wp; wp = wp->w_next)
8583 ++winnr;
8584 if (wp->w_buffer == buf)
8585 break;
8587 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8588 #else
8589 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8590 #endif
8591 --emsg_off;
8595 * "byte2line(byte)" function
8597 /*ARGSUSED*/
8598 static void
8599 f_byte2line(argvars, rettv)
8600 typval_T *argvars;
8601 typval_T *rettv;
8603 #ifndef FEAT_BYTEOFF
8604 rettv->vval.v_number = -1;
8605 #else
8606 long boff = 0;
8608 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8609 if (boff < 0)
8610 rettv->vval.v_number = -1;
8611 else
8612 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8613 (linenr_T)0, &boff);
8614 #endif
8618 * "byteidx()" function
8620 /*ARGSUSED*/
8621 static void
8622 f_byteidx(argvars, rettv)
8623 typval_T *argvars;
8624 typval_T *rettv;
8626 #ifdef FEAT_MBYTE
8627 char_u *t;
8628 #endif
8629 char_u *str;
8630 long idx;
8632 str = get_tv_string_chk(&argvars[0]);
8633 idx = get_tv_number_chk(&argvars[1], NULL);
8634 rettv->vval.v_number = -1;
8635 if (str == NULL || idx < 0)
8636 return;
8638 #ifdef FEAT_MBYTE
8639 t = str;
8640 for ( ; idx > 0; idx--)
8642 if (*t == NUL) /* EOL reached */
8643 return;
8644 t += (*mb_ptr2len)(t);
8646 rettv->vval.v_number = (varnumber_T)(t - str);
8647 #else
8648 if ((size_t)idx <= STRLEN(str))
8649 rettv->vval.v_number = idx;
8650 #endif
8654 * "call(func, arglist)" function
8656 static void
8657 f_call(argvars, rettv)
8658 typval_T *argvars;
8659 typval_T *rettv;
8661 char_u *func;
8662 typval_T argv[MAX_FUNC_ARGS + 1];
8663 int argc = 0;
8664 listitem_T *item;
8665 int dummy;
8666 dict_T *selfdict = NULL;
8668 rettv->vval.v_number = 0;
8669 if (argvars[1].v_type != VAR_LIST)
8671 EMSG(_(e_listreq));
8672 return;
8674 if (argvars[1].vval.v_list == NULL)
8675 return;
8677 if (argvars[0].v_type == VAR_FUNC)
8678 func = argvars[0].vval.v_string;
8679 else
8680 func = get_tv_string(&argvars[0]);
8681 if (*func == NUL)
8682 return; /* type error or empty name */
8684 if (argvars[2].v_type != VAR_UNKNOWN)
8686 if (argvars[2].v_type != VAR_DICT)
8688 EMSG(_(e_dictreq));
8689 return;
8691 selfdict = argvars[2].vval.v_dict;
8694 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8695 item = item->li_next)
8697 if (argc == MAX_FUNC_ARGS)
8699 EMSG(_("E699: Too many arguments"));
8700 break;
8702 /* Make a copy of each argument. This is needed to be able to set
8703 * v_lock to VAR_FIXED in the copy without changing the original list.
8705 copy_tv(&item->li_tv, &argv[argc++]);
8708 if (item == NULL)
8709 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8710 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8711 &dummy, TRUE, selfdict);
8713 /* Free the arguments. */
8714 while (argc > 0)
8715 clear_tv(&argv[--argc]);
8718 #ifdef FEAT_FLOAT
8720 * "ceil({float})" function
8722 static void
8723 f_ceil(argvars, rettv)
8724 typval_T *argvars;
8725 typval_T *rettv;
8727 float_T f;
8729 rettv->v_type = VAR_FLOAT;
8730 if (get_float_arg(argvars, &f) == OK)
8731 rettv->vval.v_float = ceil(f);
8732 else
8733 rettv->vval.v_float = 0.0;
8735 #endif
8738 * "changenr()" function
8740 /*ARGSUSED*/
8741 static void
8742 f_changenr(argvars, rettv)
8743 typval_T *argvars;
8744 typval_T *rettv;
8746 rettv->vval.v_number = curbuf->b_u_seq_cur;
8750 * "char2nr(string)" function
8752 static void
8753 f_char2nr(argvars, rettv)
8754 typval_T *argvars;
8755 typval_T *rettv;
8757 #ifdef FEAT_MBYTE
8758 if (has_mbyte)
8759 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8760 else
8761 #endif
8762 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8766 * "cindent(lnum)" function
8768 static void
8769 f_cindent(argvars, rettv)
8770 typval_T *argvars;
8771 typval_T *rettv;
8773 #ifdef FEAT_CINDENT
8774 pos_T pos;
8775 linenr_T lnum;
8777 pos = curwin->w_cursor;
8778 lnum = get_tv_lnum(argvars);
8779 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8781 curwin->w_cursor.lnum = lnum;
8782 rettv->vval.v_number = get_c_indent();
8783 curwin->w_cursor = pos;
8785 else
8786 #endif
8787 rettv->vval.v_number = -1;
8791 * "clearmatches()" function
8793 /*ARGSUSED*/
8794 static void
8795 f_clearmatches(argvars, rettv)
8796 typval_T *argvars;
8797 typval_T *rettv;
8799 #ifdef FEAT_SEARCH_EXTRA
8800 clear_matches(curwin);
8801 #endif
8805 * "col(string)" function
8807 static void
8808 f_col(argvars, rettv)
8809 typval_T *argvars;
8810 typval_T *rettv;
8812 colnr_T col = 0;
8813 pos_T *fp;
8814 int fnum = curbuf->b_fnum;
8816 fp = var2fpos(&argvars[0], FALSE, &fnum);
8817 if (fp != NULL && fnum == curbuf->b_fnum)
8819 if (fp->col == MAXCOL)
8821 /* '> can be MAXCOL, get the length of the line then */
8822 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8823 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8824 else
8825 col = MAXCOL;
8827 else
8829 col = fp->col + 1;
8830 #ifdef FEAT_VIRTUALEDIT
8831 /* col(".") when the cursor is on the NUL at the end of the line
8832 * because of "coladd" can be seen as an extra column. */
8833 if (virtual_active() && fp == &curwin->w_cursor)
8835 char_u *p = ml_get_cursor();
8837 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8838 curwin->w_virtcol - curwin->w_cursor.coladd))
8840 # ifdef FEAT_MBYTE
8841 int l;
8843 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8844 col += l;
8845 # else
8846 if (*p != NUL && p[1] == NUL)
8847 ++col;
8848 # endif
8851 #endif
8854 rettv->vval.v_number = col;
8857 #if defined(FEAT_INS_EXPAND)
8859 * "complete()" function
8861 /*ARGSUSED*/
8862 static void
8863 f_complete(argvars, rettv)
8864 typval_T *argvars;
8865 typval_T *rettv;
8867 int startcol;
8869 if ((State & INSERT) == 0)
8871 EMSG(_("E785: complete() can only be used in Insert mode"));
8872 return;
8875 /* Check for undo allowed here, because if something was already inserted
8876 * the line was already saved for undo and this check isn't done. */
8877 if (!undo_allowed())
8878 return;
8880 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8882 EMSG(_(e_invarg));
8883 return;
8886 startcol = get_tv_number_chk(&argvars[0], NULL);
8887 if (startcol <= 0)
8888 return;
8890 set_completion(startcol - 1, argvars[1].vval.v_list);
8894 * "complete_add()" function
8896 /*ARGSUSED*/
8897 static void
8898 f_complete_add(argvars, rettv)
8899 typval_T *argvars;
8900 typval_T *rettv;
8902 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
8906 * "complete_check()" function
8908 /*ARGSUSED*/
8909 static void
8910 f_complete_check(argvars, rettv)
8911 typval_T *argvars;
8912 typval_T *rettv;
8914 int saved = RedrawingDisabled;
8916 RedrawingDisabled = 0;
8917 ins_compl_check_keys(0);
8918 rettv->vval.v_number = compl_interrupted;
8919 RedrawingDisabled = saved;
8921 #endif
8924 * "confirm(message, buttons[, default [, type]])" function
8926 /*ARGSUSED*/
8927 static void
8928 f_confirm(argvars, rettv)
8929 typval_T *argvars;
8930 typval_T *rettv;
8932 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
8933 char_u *message;
8934 char_u *buttons = NULL;
8935 char_u buf[NUMBUFLEN];
8936 char_u buf2[NUMBUFLEN];
8937 int def = 1;
8938 int type = VIM_GENERIC;
8939 char_u *typestr;
8940 int error = FALSE;
8942 message = get_tv_string_chk(&argvars[0]);
8943 if (message == NULL)
8944 error = TRUE;
8945 if (argvars[1].v_type != VAR_UNKNOWN)
8947 buttons = get_tv_string_buf_chk(&argvars[1], buf);
8948 if (buttons == NULL)
8949 error = TRUE;
8950 if (argvars[2].v_type != VAR_UNKNOWN)
8952 def = get_tv_number_chk(&argvars[2], &error);
8953 if (argvars[3].v_type != VAR_UNKNOWN)
8955 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
8956 if (typestr == NULL)
8957 error = TRUE;
8958 else
8960 switch (TOUPPER_ASC(*typestr))
8962 case 'E': type = VIM_ERROR; break;
8963 case 'Q': type = VIM_QUESTION; break;
8964 case 'I': type = VIM_INFO; break;
8965 case 'W': type = VIM_WARNING; break;
8966 case 'G': type = VIM_GENERIC; break;
8973 if (buttons == NULL || *buttons == NUL)
8974 buttons = (char_u *)_("&Ok");
8976 if (error)
8977 rettv->vval.v_number = 0;
8978 else
8979 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
8980 def, NULL);
8981 #else
8982 rettv->vval.v_number = 0;
8983 #endif
8987 * "copy()" function
8989 static void
8990 f_copy(argvars, rettv)
8991 typval_T *argvars;
8992 typval_T *rettv;
8994 item_copy(&argvars[0], rettv, FALSE, 0);
8997 #ifdef FEAT_FLOAT
8999 * "cos()" function
9001 static void
9002 f_cos(argvars, rettv)
9003 typval_T *argvars;
9004 typval_T *rettv;
9006 float_T f;
9008 rettv->v_type = VAR_FLOAT;
9009 if (get_float_arg(argvars, &f) == OK)
9010 rettv->vval.v_float = cos(f);
9011 else
9012 rettv->vval.v_float = 0.0;
9014 #endif
9017 * "count()" function
9019 static void
9020 f_count(argvars, rettv)
9021 typval_T *argvars;
9022 typval_T *rettv;
9024 long n = 0;
9025 int ic = FALSE;
9027 if (argvars[0].v_type == VAR_LIST)
9029 listitem_T *li;
9030 list_T *l;
9031 long idx;
9033 if ((l = argvars[0].vval.v_list) != NULL)
9035 li = l->lv_first;
9036 if (argvars[2].v_type != VAR_UNKNOWN)
9038 int error = FALSE;
9040 ic = get_tv_number_chk(&argvars[2], &error);
9041 if (argvars[3].v_type != VAR_UNKNOWN)
9043 idx = get_tv_number_chk(&argvars[3], &error);
9044 if (!error)
9046 li = list_find(l, idx);
9047 if (li == NULL)
9048 EMSGN(_(e_listidx), idx);
9051 if (error)
9052 li = NULL;
9055 for ( ; li != NULL; li = li->li_next)
9056 if (tv_equal(&li->li_tv, &argvars[1], ic))
9057 ++n;
9060 else if (argvars[0].v_type == VAR_DICT)
9062 int todo;
9063 dict_T *d;
9064 hashitem_T *hi;
9066 if ((d = argvars[0].vval.v_dict) != NULL)
9068 int error = FALSE;
9070 if (argvars[2].v_type != VAR_UNKNOWN)
9072 ic = get_tv_number_chk(&argvars[2], &error);
9073 if (argvars[3].v_type != VAR_UNKNOWN)
9074 EMSG(_(e_invarg));
9077 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9078 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9080 if (!HASHITEM_EMPTY(hi))
9082 --todo;
9083 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9084 ++n;
9089 else
9090 EMSG2(_(e_listdictarg), "count()");
9091 rettv->vval.v_number = n;
9095 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9097 * Checks the existence of a cscope connection.
9099 /*ARGSUSED*/
9100 static void
9101 f_cscope_connection(argvars, rettv)
9102 typval_T *argvars;
9103 typval_T *rettv;
9105 #ifdef FEAT_CSCOPE
9106 int num = 0;
9107 char_u *dbpath = NULL;
9108 char_u *prepend = NULL;
9109 char_u buf[NUMBUFLEN];
9111 if (argvars[0].v_type != VAR_UNKNOWN
9112 && argvars[1].v_type != VAR_UNKNOWN)
9114 num = (int)get_tv_number(&argvars[0]);
9115 dbpath = get_tv_string(&argvars[1]);
9116 if (argvars[2].v_type != VAR_UNKNOWN)
9117 prepend = get_tv_string_buf(&argvars[2], buf);
9120 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9121 #else
9122 rettv->vval.v_number = 0;
9123 #endif
9127 * "cursor(lnum, col)" function
9129 * Moves the cursor to the specified line and column
9131 /*ARGSUSED*/
9132 static void
9133 f_cursor(argvars, rettv)
9134 typval_T *argvars;
9135 typval_T *rettv;
9137 long line, col;
9138 #ifdef FEAT_VIRTUALEDIT
9139 long coladd = 0;
9140 #endif
9142 if (argvars[1].v_type == VAR_UNKNOWN)
9144 pos_T pos;
9146 if (list2fpos(argvars, &pos, NULL) == FAIL)
9147 return;
9148 line = pos.lnum;
9149 col = pos.col;
9150 #ifdef FEAT_VIRTUALEDIT
9151 coladd = pos.coladd;
9152 #endif
9154 else
9156 line = get_tv_lnum(argvars);
9157 col = get_tv_number_chk(&argvars[1], NULL);
9158 #ifdef FEAT_VIRTUALEDIT
9159 if (argvars[2].v_type != VAR_UNKNOWN)
9160 coladd = get_tv_number_chk(&argvars[2], NULL);
9161 #endif
9163 if (line < 0 || col < 0
9164 #ifdef FEAT_VIRTUALEDIT
9165 || coladd < 0
9166 #endif
9168 return; /* type error; errmsg already given */
9169 if (line > 0)
9170 curwin->w_cursor.lnum = line;
9171 if (col > 0)
9172 curwin->w_cursor.col = col - 1;
9173 #ifdef FEAT_VIRTUALEDIT
9174 curwin->w_cursor.coladd = coladd;
9175 #endif
9177 /* Make sure the cursor is in a valid position. */
9178 check_cursor();
9179 #ifdef FEAT_MBYTE
9180 /* Correct cursor for multi-byte character. */
9181 if (has_mbyte)
9182 mb_adjust_cursor();
9183 #endif
9185 curwin->w_set_curswant = TRUE;
9189 * "deepcopy()" function
9191 static void
9192 f_deepcopy(argvars, rettv)
9193 typval_T *argvars;
9194 typval_T *rettv;
9196 int noref = 0;
9198 if (argvars[1].v_type != VAR_UNKNOWN)
9199 noref = get_tv_number_chk(&argvars[1], NULL);
9200 if (noref < 0 || noref > 1)
9201 EMSG(_(e_invarg));
9202 else
9203 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? ++current_copyID : 0);
9207 * "delete()" function
9209 static void
9210 f_delete(argvars, rettv)
9211 typval_T *argvars;
9212 typval_T *rettv;
9214 if (check_restricted() || check_secure())
9215 rettv->vval.v_number = -1;
9216 else
9217 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9221 * "did_filetype()" function
9223 /*ARGSUSED*/
9224 static void
9225 f_did_filetype(argvars, rettv)
9226 typval_T *argvars;
9227 typval_T *rettv;
9229 #ifdef FEAT_AUTOCMD
9230 rettv->vval.v_number = did_filetype;
9231 #else
9232 rettv->vval.v_number = 0;
9233 #endif
9237 * "diff_filler()" function
9239 /*ARGSUSED*/
9240 static void
9241 f_diff_filler(argvars, rettv)
9242 typval_T *argvars;
9243 typval_T *rettv;
9245 #ifdef FEAT_DIFF
9246 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9247 #endif
9251 * "diff_hlID()" function
9253 /*ARGSUSED*/
9254 static void
9255 f_diff_hlID(argvars, rettv)
9256 typval_T *argvars;
9257 typval_T *rettv;
9259 #ifdef FEAT_DIFF
9260 linenr_T lnum = get_tv_lnum(argvars);
9261 static linenr_T prev_lnum = 0;
9262 static int changedtick = 0;
9263 static int fnum = 0;
9264 static int change_start = 0;
9265 static int change_end = 0;
9266 static hlf_T hlID = (hlf_T)0;
9267 int filler_lines;
9268 int col;
9270 if (lnum < 0) /* ignore type error in {lnum} arg */
9271 lnum = 0;
9272 if (lnum != prev_lnum
9273 || changedtick != curbuf->b_changedtick
9274 || fnum != curbuf->b_fnum)
9276 /* New line, buffer, change: need to get the values. */
9277 filler_lines = diff_check(curwin, lnum);
9278 if (filler_lines < 0)
9280 if (filler_lines == -1)
9282 change_start = MAXCOL;
9283 change_end = -1;
9284 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9285 hlID = HLF_ADD; /* added line */
9286 else
9287 hlID = HLF_CHD; /* changed line */
9289 else
9290 hlID = HLF_ADD; /* added line */
9292 else
9293 hlID = (hlf_T)0;
9294 prev_lnum = lnum;
9295 changedtick = curbuf->b_changedtick;
9296 fnum = curbuf->b_fnum;
9299 if (hlID == HLF_CHD || hlID == HLF_TXD)
9301 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9302 if (col >= change_start && col <= change_end)
9303 hlID = HLF_TXD; /* changed text */
9304 else
9305 hlID = HLF_CHD; /* changed line */
9307 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9308 #endif
9312 * "empty({expr})" function
9314 static void
9315 f_empty(argvars, rettv)
9316 typval_T *argvars;
9317 typval_T *rettv;
9319 int n;
9321 switch (argvars[0].v_type)
9323 case VAR_STRING:
9324 case VAR_FUNC:
9325 n = argvars[0].vval.v_string == NULL
9326 || *argvars[0].vval.v_string == NUL;
9327 break;
9328 case VAR_NUMBER:
9329 n = argvars[0].vval.v_number == 0;
9330 break;
9331 #ifdef FEAT_FLOAT
9332 case VAR_FLOAT:
9333 n = argvars[0].vval.v_float == 0.0;
9334 break;
9335 #endif
9336 case VAR_LIST:
9337 n = argvars[0].vval.v_list == NULL
9338 || argvars[0].vval.v_list->lv_first == NULL;
9339 break;
9340 case VAR_DICT:
9341 n = argvars[0].vval.v_dict == NULL
9342 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9343 break;
9344 default:
9345 EMSG2(_(e_intern2), "f_empty()");
9346 n = 0;
9349 rettv->vval.v_number = n;
9353 * "escape({string}, {chars})" function
9355 static void
9356 f_escape(argvars, rettv)
9357 typval_T *argvars;
9358 typval_T *rettv;
9360 char_u buf[NUMBUFLEN];
9362 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9363 get_tv_string_buf(&argvars[1], buf));
9364 rettv->v_type = VAR_STRING;
9368 * "eval()" function
9370 /*ARGSUSED*/
9371 static void
9372 f_eval(argvars, rettv)
9373 typval_T *argvars;
9374 typval_T *rettv;
9376 char_u *s;
9378 s = get_tv_string_chk(&argvars[0]);
9379 if (s != NULL)
9380 s = skipwhite(s);
9382 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9384 rettv->v_type = VAR_NUMBER;
9385 rettv->vval.v_number = 0;
9387 else if (*s != NUL)
9388 EMSG(_(e_trailing));
9392 * "eventhandler()" function
9394 /*ARGSUSED*/
9395 static void
9396 f_eventhandler(argvars, rettv)
9397 typval_T *argvars;
9398 typval_T *rettv;
9400 rettv->vval.v_number = vgetc_busy;
9404 * "executable()" function
9406 static void
9407 f_executable(argvars, rettv)
9408 typval_T *argvars;
9409 typval_T *rettv;
9411 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9415 * "exists()" function
9417 static void
9418 f_exists(argvars, rettv)
9419 typval_T *argvars;
9420 typval_T *rettv;
9422 char_u *p;
9423 char_u *name;
9424 int n = FALSE;
9425 int len = 0;
9427 p = get_tv_string(&argvars[0]);
9428 if (*p == '$') /* environment variable */
9430 /* first try "normal" environment variables (fast) */
9431 if (mch_getenv(p + 1) != NULL)
9432 n = TRUE;
9433 else
9435 /* try expanding things like $VIM and ${HOME} */
9436 p = expand_env_save(p);
9437 if (p != NULL && *p != '$')
9438 n = TRUE;
9439 vim_free(p);
9442 else if (*p == '&' || *p == '+') /* option */
9444 n = (get_option_tv(&p, NULL, TRUE) == OK);
9445 if (*skipwhite(p) != NUL)
9446 n = FALSE; /* trailing garbage */
9448 else if (*p == '*') /* internal or user defined function */
9450 n = function_exists(p + 1);
9452 else if (*p == ':')
9454 n = cmd_exists(p + 1);
9456 else if (*p == '#')
9458 #ifdef FEAT_AUTOCMD
9459 if (p[1] == '#')
9460 n = autocmd_supported(p + 2);
9461 else
9462 n = au_exists(p + 1);
9463 #endif
9465 else /* internal variable */
9467 char_u *tofree;
9468 typval_T tv;
9470 /* get_name_len() takes care of expanding curly braces */
9471 name = p;
9472 len = get_name_len(&p, &tofree, TRUE, FALSE);
9473 if (len > 0)
9475 if (tofree != NULL)
9476 name = tofree;
9477 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9478 if (n)
9480 /* handle d.key, l[idx], f(expr) */
9481 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9482 if (n)
9483 clear_tv(&tv);
9486 if (*p != NUL)
9487 n = FALSE;
9489 vim_free(tofree);
9492 rettv->vval.v_number = n;
9496 * "expand()" function
9498 static void
9499 f_expand(argvars, rettv)
9500 typval_T *argvars;
9501 typval_T *rettv;
9503 char_u *s;
9504 int len;
9505 char_u *errormsg;
9506 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9507 expand_T xpc;
9508 int error = FALSE;
9510 rettv->v_type = VAR_STRING;
9511 s = get_tv_string(&argvars[0]);
9512 if (*s == '%' || *s == '#' || *s == '<')
9514 ++emsg_off;
9515 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9516 --emsg_off;
9518 else
9520 /* When the optional second argument is non-zero, don't remove matches
9521 * for 'suffixes' and 'wildignore' */
9522 if (argvars[1].v_type != VAR_UNKNOWN
9523 && get_tv_number_chk(&argvars[1], &error))
9524 flags |= WILD_KEEP_ALL;
9525 if (!error)
9527 ExpandInit(&xpc);
9528 xpc.xp_context = EXPAND_FILES;
9529 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9531 else
9532 rettv->vval.v_string = NULL;
9537 * "extend(list, list [, idx])" function
9538 * "extend(dict, dict [, action])" function
9540 static void
9541 f_extend(argvars, rettv)
9542 typval_T *argvars;
9543 typval_T *rettv;
9545 rettv->vval.v_number = 0;
9546 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9548 list_T *l1, *l2;
9549 listitem_T *item;
9550 long before;
9551 int error = FALSE;
9553 l1 = argvars[0].vval.v_list;
9554 l2 = argvars[1].vval.v_list;
9555 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9556 && l2 != NULL)
9558 if (argvars[2].v_type != VAR_UNKNOWN)
9560 before = get_tv_number_chk(&argvars[2], &error);
9561 if (error)
9562 return; /* type error; errmsg already given */
9564 if (before == l1->lv_len)
9565 item = NULL;
9566 else
9568 item = list_find(l1, before);
9569 if (item == NULL)
9571 EMSGN(_(e_listidx), before);
9572 return;
9576 else
9577 item = NULL;
9578 list_extend(l1, l2, item);
9580 copy_tv(&argvars[0], rettv);
9583 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9585 dict_T *d1, *d2;
9586 dictitem_T *di1;
9587 char_u *action;
9588 int i;
9589 hashitem_T *hi2;
9590 int todo;
9592 d1 = argvars[0].vval.v_dict;
9593 d2 = argvars[1].vval.v_dict;
9594 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9595 && d2 != NULL)
9597 /* Check the third argument. */
9598 if (argvars[2].v_type != VAR_UNKNOWN)
9600 static char *(av[]) = {"keep", "force", "error"};
9602 action = get_tv_string_chk(&argvars[2]);
9603 if (action == NULL)
9604 return; /* type error; errmsg already given */
9605 for (i = 0; i < 3; ++i)
9606 if (STRCMP(action, av[i]) == 0)
9607 break;
9608 if (i == 3)
9610 EMSG2(_(e_invarg2), action);
9611 return;
9614 else
9615 action = (char_u *)"force";
9617 /* Go over all entries in the second dict and add them to the
9618 * first dict. */
9619 todo = (int)d2->dv_hashtab.ht_used;
9620 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9622 if (!HASHITEM_EMPTY(hi2))
9624 --todo;
9625 di1 = dict_find(d1, hi2->hi_key, -1);
9626 if (di1 == NULL)
9628 di1 = dictitem_copy(HI2DI(hi2));
9629 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9630 dictitem_free(di1);
9632 else if (*action == 'e')
9634 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9635 break;
9637 else if (*action == 'f')
9639 clear_tv(&di1->di_tv);
9640 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9645 copy_tv(&argvars[0], rettv);
9648 else
9649 EMSG2(_(e_listdictarg), "extend()");
9653 * "feedkeys()" function
9655 /*ARGSUSED*/
9656 static void
9657 f_feedkeys(argvars, rettv)
9658 typval_T *argvars;
9659 typval_T *rettv;
9661 int remap = TRUE;
9662 char_u *keys, *flags;
9663 char_u nbuf[NUMBUFLEN];
9664 int typed = FALSE;
9665 char_u *keys_esc;
9667 /* This is not allowed in the sandbox. If the commands would still be
9668 * executed in the sandbox it would be OK, but it probably happens later,
9669 * when "sandbox" is no longer set. */
9670 if (check_secure())
9671 return;
9673 rettv->vval.v_number = 0;
9674 keys = get_tv_string(&argvars[0]);
9675 if (*keys != NUL)
9677 if (argvars[1].v_type != VAR_UNKNOWN)
9679 flags = get_tv_string_buf(&argvars[1], nbuf);
9680 for ( ; *flags != NUL; ++flags)
9682 switch (*flags)
9684 case 'n': remap = FALSE; break;
9685 case 'm': remap = TRUE; break;
9686 case 't': typed = TRUE; break;
9691 /* Need to escape K_SPECIAL and CSI before putting the string in the
9692 * typeahead buffer. */
9693 keys_esc = vim_strsave_escape_csi(keys);
9694 if (keys_esc != NULL)
9696 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9697 typebuf.tb_len, !typed, FALSE);
9698 vim_free(keys_esc);
9699 if (vgetc_busy)
9700 typebuf_was_filled = TRUE;
9706 * "filereadable()" function
9708 static void
9709 f_filereadable(argvars, rettv)
9710 typval_T *argvars;
9711 typval_T *rettv;
9713 int fd;
9714 char_u *p;
9715 int n;
9717 #ifndef O_NONBLOCK
9718 # define O_NONBLOCK 0
9719 #endif
9720 p = get_tv_string(&argvars[0]);
9721 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9722 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9724 n = TRUE;
9725 close(fd);
9727 else
9728 n = FALSE;
9730 rettv->vval.v_number = n;
9734 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9735 * rights to write into.
9737 static void
9738 f_filewritable(argvars, rettv)
9739 typval_T *argvars;
9740 typval_T *rettv;
9742 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9745 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9747 static void
9748 findfilendir(argvars, rettv, find_what)
9749 typval_T *argvars;
9750 typval_T *rettv;
9751 int find_what;
9753 #ifdef FEAT_SEARCHPATH
9754 char_u *fname;
9755 char_u *fresult = NULL;
9756 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9757 char_u *p;
9758 char_u pathbuf[NUMBUFLEN];
9759 int count = 1;
9760 int first = TRUE;
9761 int error = FALSE;
9762 #endif
9764 rettv->vval.v_string = NULL;
9765 rettv->v_type = VAR_STRING;
9767 #ifdef FEAT_SEARCHPATH
9768 fname = get_tv_string(&argvars[0]);
9770 if (argvars[1].v_type != VAR_UNKNOWN)
9772 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9773 if (p == NULL)
9774 error = TRUE;
9775 else
9777 if (*p != NUL)
9778 path = p;
9780 if (argvars[2].v_type != VAR_UNKNOWN)
9781 count = get_tv_number_chk(&argvars[2], &error);
9785 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9786 error = TRUE;
9788 if (*fname != NUL && !error)
9792 if (rettv->v_type == VAR_STRING)
9793 vim_free(fresult);
9794 fresult = find_file_in_path_option(first ? fname : NULL,
9795 first ? (int)STRLEN(fname) : 0,
9796 0, first, path,
9797 find_what,
9798 curbuf->b_ffname,
9799 find_what == FINDFILE_DIR
9800 ? (char_u *)"" : curbuf->b_p_sua);
9801 first = FALSE;
9803 if (fresult != NULL && rettv->v_type == VAR_LIST)
9804 list_append_string(rettv->vval.v_list, fresult, -1);
9806 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9809 if (rettv->v_type == VAR_STRING)
9810 rettv->vval.v_string = fresult;
9811 #endif
9814 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9815 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9818 * Implementation of map() and filter().
9820 static void
9821 filter_map(argvars, rettv, map)
9822 typval_T *argvars;
9823 typval_T *rettv;
9824 int map;
9826 char_u buf[NUMBUFLEN];
9827 char_u *expr;
9828 listitem_T *li, *nli;
9829 list_T *l = NULL;
9830 dictitem_T *di;
9831 hashtab_T *ht;
9832 hashitem_T *hi;
9833 dict_T *d = NULL;
9834 typval_T save_val;
9835 typval_T save_key;
9836 int rem;
9837 int todo;
9838 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9839 int save_did_emsg;
9841 rettv->vval.v_number = 0;
9842 if (argvars[0].v_type == VAR_LIST)
9844 if ((l = argvars[0].vval.v_list) == NULL
9845 || (map && tv_check_lock(l->lv_lock, ermsg)))
9846 return;
9848 else if (argvars[0].v_type == VAR_DICT)
9850 if ((d = argvars[0].vval.v_dict) == NULL
9851 || (map && tv_check_lock(d->dv_lock, ermsg)))
9852 return;
9854 else
9856 EMSG2(_(e_listdictarg), ermsg);
9857 return;
9860 expr = get_tv_string_buf_chk(&argvars[1], buf);
9861 /* On type errors, the preceding call has already displayed an error
9862 * message. Avoid a misleading error message for an empty string that
9863 * was not passed as argument. */
9864 if (expr != NULL)
9866 prepare_vimvar(VV_VAL, &save_val);
9867 expr = skipwhite(expr);
9869 /* We reset "did_emsg" to be able to detect whether an error
9870 * occurred during evaluation of the expression. */
9871 save_did_emsg = did_emsg;
9872 did_emsg = FALSE;
9874 if (argvars[0].v_type == VAR_DICT)
9876 prepare_vimvar(VV_KEY, &save_key);
9877 vimvars[VV_KEY].vv_type = VAR_STRING;
9879 ht = &d->dv_hashtab;
9880 hash_lock(ht);
9881 todo = (int)ht->ht_used;
9882 for (hi = ht->ht_array; todo > 0; ++hi)
9884 if (!HASHITEM_EMPTY(hi))
9886 --todo;
9887 di = HI2DI(hi);
9888 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9889 break;
9890 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9891 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9892 || did_emsg)
9893 break;
9894 if (!map && rem)
9895 dictitem_remove(d, di);
9896 clear_tv(&vimvars[VV_KEY].vv_tv);
9899 hash_unlock(ht);
9901 restore_vimvar(VV_KEY, &save_key);
9903 else
9905 for (li = l->lv_first; li != NULL; li = nli)
9907 if (tv_check_lock(li->li_tv.v_lock, ermsg))
9908 break;
9909 nli = li->li_next;
9910 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
9911 || did_emsg)
9912 break;
9913 if (!map && rem)
9914 listitem_remove(l, li);
9918 restore_vimvar(VV_VAL, &save_val);
9920 did_emsg |= save_did_emsg;
9923 copy_tv(&argvars[0], rettv);
9926 static int
9927 filter_map_one(tv, expr, map, remp)
9928 typval_T *tv;
9929 char_u *expr;
9930 int map;
9931 int *remp;
9933 typval_T rettv;
9934 char_u *s;
9935 int retval = FAIL;
9937 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
9938 s = expr;
9939 if (eval1(&s, &rettv, TRUE) == FAIL)
9940 goto theend;
9941 if (*s != NUL) /* check for trailing chars after expr */
9943 EMSG2(_(e_invexpr2), s);
9944 goto theend;
9946 if (map)
9948 /* map(): replace the list item value */
9949 clear_tv(tv);
9950 rettv.v_lock = 0;
9951 *tv = rettv;
9953 else
9955 int error = FALSE;
9957 /* filter(): when expr is zero remove the item */
9958 *remp = (get_tv_number_chk(&rettv, &error) == 0);
9959 clear_tv(&rettv);
9960 /* On type error, nothing has been removed; return FAIL to stop the
9961 * loop. The error message was given by get_tv_number_chk(). */
9962 if (error)
9963 goto theend;
9965 retval = OK;
9966 theend:
9967 clear_tv(&vimvars[VV_VAL].vv_tv);
9968 return retval;
9972 * "filter()" function
9974 static void
9975 f_filter(argvars, rettv)
9976 typval_T *argvars;
9977 typval_T *rettv;
9979 filter_map(argvars, rettv, FALSE);
9983 * "finddir({fname}[, {path}[, {count}]])" function
9985 static void
9986 f_finddir(argvars, rettv)
9987 typval_T *argvars;
9988 typval_T *rettv;
9990 findfilendir(argvars, rettv, FINDFILE_DIR);
9994 * "findfile({fname}[, {path}[, {count}]])" function
9996 static void
9997 f_findfile(argvars, rettv)
9998 typval_T *argvars;
9999 typval_T *rettv;
10001 findfilendir(argvars, rettv, FINDFILE_FILE);
10004 #ifdef FEAT_FLOAT
10006 * "float2nr({float})" function
10008 static void
10009 f_float2nr(argvars, rettv)
10010 typval_T *argvars;
10011 typval_T *rettv;
10013 float_T f;
10015 if (get_float_arg(argvars, &f) == OK)
10017 if (f < -0x7fffffff)
10018 rettv->vval.v_number = -0x7fffffff;
10019 else if (f > 0x7fffffff)
10020 rettv->vval.v_number = 0x7fffffff;
10021 else
10022 rettv->vval.v_number = (varnumber_T)f;
10024 else
10025 rettv->vval.v_number = 0;
10029 * "floor({float})" function
10031 static void
10032 f_floor(argvars, rettv)
10033 typval_T *argvars;
10034 typval_T *rettv;
10036 float_T f;
10038 rettv->v_type = VAR_FLOAT;
10039 if (get_float_arg(argvars, &f) == OK)
10040 rettv->vval.v_float = floor(f);
10041 else
10042 rettv->vval.v_float = 0.0;
10044 #endif
10047 * "fnameescape({string})" function
10049 static void
10050 f_fnameescape(argvars, rettv)
10051 typval_T *argvars;
10052 typval_T *rettv;
10054 rettv->vval.v_string = vim_strsave_fnameescape(
10055 get_tv_string(&argvars[0]), FALSE);
10056 rettv->v_type = VAR_STRING;
10060 * "fnamemodify({fname}, {mods})" function
10062 static void
10063 f_fnamemodify(argvars, rettv)
10064 typval_T *argvars;
10065 typval_T *rettv;
10067 char_u *fname;
10068 char_u *mods;
10069 int usedlen = 0;
10070 int len;
10071 char_u *fbuf = NULL;
10072 char_u buf[NUMBUFLEN];
10074 fname = get_tv_string_chk(&argvars[0]);
10075 mods = get_tv_string_buf_chk(&argvars[1], buf);
10076 if (fname == NULL || mods == NULL)
10077 fname = NULL;
10078 else
10080 len = (int)STRLEN(fname);
10081 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10084 rettv->v_type = VAR_STRING;
10085 if (fname == NULL)
10086 rettv->vval.v_string = NULL;
10087 else
10088 rettv->vval.v_string = vim_strnsave(fname, len);
10089 vim_free(fbuf);
10092 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10095 * "foldclosed()" function
10097 static void
10098 foldclosed_both(argvars, rettv, end)
10099 typval_T *argvars;
10100 typval_T *rettv;
10101 int end;
10103 #ifdef FEAT_FOLDING
10104 linenr_T lnum;
10105 linenr_T first, last;
10107 lnum = get_tv_lnum(argvars);
10108 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10110 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10112 if (end)
10113 rettv->vval.v_number = (varnumber_T)last;
10114 else
10115 rettv->vval.v_number = (varnumber_T)first;
10116 return;
10119 #endif
10120 rettv->vval.v_number = -1;
10124 * "foldclosed()" function
10126 static void
10127 f_foldclosed(argvars, rettv)
10128 typval_T *argvars;
10129 typval_T *rettv;
10131 foldclosed_both(argvars, rettv, FALSE);
10135 * "foldclosedend()" function
10137 static void
10138 f_foldclosedend(argvars, rettv)
10139 typval_T *argvars;
10140 typval_T *rettv;
10142 foldclosed_both(argvars, rettv, TRUE);
10146 * "foldlevel()" function
10148 static void
10149 f_foldlevel(argvars, rettv)
10150 typval_T *argvars;
10151 typval_T *rettv;
10153 #ifdef FEAT_FOLDING
10154 linenr_T lnum;
10156 lnum = get_tv_lnum(argvars);
10157 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10158 rettv->vval.v_number = foldLevel(lnum);
10159 else
10160 #endif
10161 rettv->vval.v_number = 0;
10165 * "foldtext()" function
10167 /*ARGSUSED*/
10168 static void
10169 f_foldtext(argvars, rettv)
10170 typval_T *argvars;
10171 typval_T *rettv;
10173 #ifdef FEAT_FOLDING
10174 linenr_T lnum;
10175 char_u *s;
10176 char_u *r;
10177 int len;
10178 char *txt;
10179 #endif
10181 rettv->v_type = VAR_STRING;
10182 rettv->vval.v_string = NULL;
10183 #ifdef FEAT_FOLDING
10184 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10185 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10186 <= curbuf->b_ml.ml_line_count
10187 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10189 /* Find first non-empty line in the fold. */
10190 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10191 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10193 if (!linewhite(lnum))
10194 break;
10195 ++lnum;
10198 /* Find interesting text in this line. */
10199 s = skipwhite(ml_get(lnum));
10200 /* skip C comment-start */
10201 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10203 s = skipwhite(s + 2);
10204 if (*skipwhite(s) == NUL
10205 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10207 s = skipwhite(ml_get(lnum + 1));
10208 if (*s == '*')
10209 s = skipwhite(s + 1);
10212 txt = _("+-%s%3ld lines: ");
10213 r = alloc((unsigned)(STRLEN(txt)
10214 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10215 + 20 /* for %3ld */
10216 + STRLEN(s))); /* concatenated */
10217 if (r != NULL)
10219 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10220 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10221 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10222 len = (int)STRLEN(r);
10223 STRCAT(r, s);
10224 /* remove 'foldmarker' and 'commentstring' */
10225 foldtext_cleanup(r + len);
10226 rettv->vval.v_string = r;
10229 #endif
10233 * "foldtextresult(lnum)" function
10235 /*ARGSUSED*/
10236 static void
10237 f_foldtextresult(argvars, rettv)
10238 typval_T *argvars;
10239 typval_T *rettv;
10241 #ifdef FEAT_FOLDING
10242 linenr_T lnum;
10243 char_u *text;
10244 char_u buf[51];
10245 foldinfo_T foldinfo;
10246 int fold_count;
10247 #endif
10249 rettv->v_type = VAR_STRING;
10250 rettv->vval.v_string = NULL;
10251 #ifdef FEAT_FOLDING
10252 lnum = get_tv_lnum(argvars);
10253 /* treat illegal types and illegal string values for {lnum} the same */
10254 if (lnum < 0)
10255 lnum = 0;
10256 fold_count = foldedCount(curwin, lnum, &foldinfo);
10257 if (fold_count > 0)
10259 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10260 &foldinfo, buf);
10261 if (text == buf)
10262 text = vim_strsave(text);
10263 rettv->vval.v_string = text;
10265 #endif
10269 * "foreground()" function
10271 /*ARGSUSED*/
10272 static void
10273 f_foreground(argvars, rettv)
10274 typval_T *argvars;
10275 typval_T *rettv;
10277 rettv->vval.v_number = 0;
10278 #ifdef FEAT_GUI
10279 if (gui.in_use)
10280 gui_mch_set_foreground();
10281 #else
10282 # ifdef WIN32
10283 win32_set_foreground();
10284 # endif
10285 #endif
10289 * "function()" function
10291 /*ARGSUSED*/
10292 static void
10293 f_function(argvars, rettv)
10294 typval_T *argvars;
10295 typval_T *rettv;
10297 char_u *s;
10299 rettv->vval.v_number = 0;
10300 s = get_tv_string(&argvars[0]);
10301 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10302 EMSG2(_(e_invarg2), s);
10303 else if (!function_exists(s))
10304 EMSG2(_("E700: Unknown function: %s"), s);
10305 else
10307 rettv->vval.v_string = vim_strsave(s);
10308 rettv->v_type = VAR_FUNC;
10313 * "garbagecollect()" function
10315 /*ARGSUSED*/
10316 static void
10317 f_garbagecollect(argvars, rettv)
10318 typval_T *argvars;
10319 typval_T *rettv;
10321 /* This is postponed until we are back at the toplevel, because we may be
10322 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10323 want_garbage_collect = TRUE;
10325 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10326 garbage_collect_at_exit = TRUE;
10330 * "get()" function
10332 static void
10333 f_get(argvars, rettv)
10334 typval_T *argvars;
10335 typval_T *rettv;
10337 listitem_T *li;
10338 list_T *l;
10339 dictitem_T *di;
10340 dict_T *d;
10341 typval_T *tv = NULL;
10343 if (argvars[0].v_type == VAR_LIST)
10345 if ((l = argvars[0].vval.v_list) != NULL)
10347 int error = FALSE;
10349 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10350 if (!error && li != NULL)
10351 tv = &li->li_tv;
10354 else if (argvars[0].v_type == VAR_DICT)
10356 if ((d = argvars[0].vval.v_dict) != NULL)
10358 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10359 if (di != NULL)
10360 tv = &di->di_tv;
10363 else
10364 EMSG2(_(e_listdictarg), "get()");
10366 if (tv == NULL)
10368 if (argvars[2].v_type == VAR_UNKNOWN)
10369 rettv->vval.v_number = 0;
10370 else
10371 copy_tv(&argvars[2], rettv);
10373 else
10374 copy_tv(tv, rettv);
10377 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10380 * Get line or list of lines from buffer "buf" into "rettv".
10381 * Return a range (from start to end) of lines in rettv from the specified
10382 * buffer.
10383 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10385 static void
10386 get_buffer_lines(buf, start, end, retlist, rettv)
10387 buf_T *buf;
10388 linenr_T start;
10389 linenr_T end;
10390 int retlist;
10391 typval_T *rettv;
10393 char_u *p;
10395 if (retlist)
10397 if (rettv_list_alloc(rettv) == FAIL)
10398 return;
10400 else
10401 rettv->vval.v_number = 0;
10403 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10404 return;
10406 if (!retlist)
10408 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10409 p = ml_get_buf(buf, start, FALSE);
10410 else
10411 p = (char_u *)"";
10413 rettv->v_type = VAR_STRING;
10414 rettv->vval.v_string = vim_strsave(p);
10416 else
10418 if (end < start)
10419 return;
10421 if (start < 1)
10422 start = 1;
10423 if (end > buf->b_ml.ml_line_count)
10424 end = buf->b_ml.ml_line_count;
10425 while (start <= end)
10426 if (list_append_string(rettv->vval.v_list,
10427 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10428 break;
10433 * "getbufline()" function
10435 static void
10436 f_getbufline(argvars, rettv)
10437 typval_T *argvars;
10438 typval_T *rettv;
10440 linenr_T lnum;
10441 linenr_T end;
10442 buf_T *buf;
10444 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10445 ++emsg_off;
10446 buf = get_buf_tv(&argvars[0]);
10447 --emsg_off;
10449 lnum = get_tv_lnum_buf(&argvars[1], buf);
10450 if (argvars[2].v_type == VAR_UNKNOWN)
10451 end = lnum;
10452 else
10453 end = get_tv_lnum_buf(&argvars[2], buf);
10455 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10459 * "getbufvar()" function
10461 static void
10462 f_getbufvar(argvars, rettv)
10463 typval_T *argvars;
10464 typval_T *rettv;
10466 buf_T *buf;
10467 buf_T *save_curbuf;
10468 char_u *varname;
10469 dictitem_T *v;
10471 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10472 varname = get_tv_string_chk(&argvars[1]);
10473 ++emsg_off;
10474 buf = get_buf_tv(&argvars[0]);
10476 rettv->v_type = VAR_STRING;
10477 rettv->vval.v_string = NULL;
10479 if (buf != NULL && varname != NULL)
10481 /* set curbuf to be our buf, temporarily */
10482 save_curbuf = curbuf;
10483 curbuf = buf;
10485 if (*varname == '&') /* buffer-local-option */
10486 get_option_tv(&varname, rettv, TRUE);
10487 else
10489 if (*varname == NUL)
10490 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10491 * scope prefix before the NUL byte is required by
10492 * find_var_in_ht(). */
10493 varname = (char_u *)"b:" + 2;
10494 /* look up the variable */
10495 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10496 if (v != NULL)
10497 copy_tv(&v->di_tv, rettv);
10500 /* restore previous notion of curbuf */
10501 curbuf = save_curbuf;
10504 --emsg_off;
10508 * "getchar()" function
10510 static void
10511 f_getchar(argvars, rettv)
10512 typval_T *argvars;
10513 typval_T *rettv;
10515 varnumber_T n;
10516 int error = FALSE;
10518 /* Position the cursor. Needed after a message that ends in a space. */
10519 windgoto(msg_row, msg_col);
10521 ++no_mapping;
10522 ++allow_keys;
10523 for (;;)
10525 if (argvars[0].v_type == VAR_UNKNOWN)
10526 /* getchar(): blocking wait. */
10527 n = safe_vgetc();
10528 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10529 /* getchar(1): only check if char avail */
10530 n = vpeekc();
10531 else if (error || vpeekc() == NUL)
10532 /* illegal argument or getchar(0) and no char avail: return zero */
10533 n = 0;
10534 else
10535 /* getchar(0) and char avail: return char */
10536 n = safe_vgetc();
10537 if (n == K_IGNORE)
10538 continue;
10539 break;
10541 --no_mapping;
10542 --allow_keys;
10544 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10545 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10546 vimvars[VV_MOUSE_COL].vv_nr = 0;
10548 rettv->vval.v_number = n;
10549 if (IS_SPECIAL(n) || mod_mask != 0)
10551 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10552 int i = 0;
10554 /* Turn a special key into three bytes, plus modifier. */
10555 if (mod_mask != 0)
10557 temp[i++] = K_SPECIAL;
10558 temp[i++] = KS_MODIFIER;
10559 temp[i++] = mod_mask;
10561 if (IS_SPECIAL(n))
10563 temp[i++] = K_SPECIAL;
10564 temp[i++] = K_SECOND(n);
10565 temp[i++] = K_THIRD(n);
10567 #ifdef FEAT_MBYTE
10568 else if (has_mbyte)
10569 i += (*mb_char2bytes)(n, temp + i);
10570 #endif
10571 else
10572 temp[i++] = n;
10573 temp[i++] = NUL;
10574 rettv->v_type = VAR_STRING;
10575 rettv->vval.v_string = vim_strsave(temp);
10577 #ifdef FEAT_MOUSE
10578 if (n == K_LEFTMOUSE
10579 || n == K_LEFTMOUSE_NM
10580 || n == K_LEFTDRAG
10581 || n == K_LEFTRELEASE
10582 || n == K_LEFTRELEASE_NM
10583 || n == K_MIDDLEMOUSE
10584 || n == K_MIDDLEDRAG
10585 || n == K_MIDDLERELEASE
10586 || n == K_RIGHTMOUSE
10587 || n == K_RIGHTDRAG
10588 || n == K_RIGHTRELEASE
10589 || n == K_X1MOUSE
10590 || n == K_X1DRAG
10591 || n == K_X1RELEASE
10592 || n == K_X2MOUSE
10593 || n == K_X2DRAG
10594 || n == K_X2RELEASE
10595 || n == K_MOUSEDOWN
10596 || n == K_MOUSEUP)
10598 int row = mouse_row;
10599 int col = mouse_col;
10600 win_T *win;
10601 linenr_T lnum;
10602 # ifdef FEAT_WINDOWS
10603 win_T *wp;
10604 # endif
10605 int n = 1;
10607 if (row >= 0 && col >= 0)
10609 /* Find the window at the mouse coordinates and compute the
10610 * text position. */
10611 win = mouse_find_win(&row, &col);
10612 (void)mouse_comp_pos(win, &row, &col, &lnum);
10613 # ifdef FEAT_WINDOWS
10614 for (wp = firstwin; wp != win; wp = wp->w_next)
10615 ++n;
10616 # endif
10617 vimvars[VV_MOUSE_WIN].vv_nr = n;
10618 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10619 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10622 #endif
10627 * "getcharmod()" function
10629 /*ARGSUSED*/
10630 static void
10631 f_getcharmod(argvars, rettv)
10632 typval_T *argvars;
10633 typval_T *rettv;
10635 rettv->vval.v_number = mod_mask;
10639 * "getcmdline()" function
10641 /*ARGSUSED*/
10642 static void
10643 f_getcmdline(argvars, rettv)
10644 typval_T *argvars;
10645 typval_T *rettv;
10647 rettv->v_type = VAR_STRING;
10648 rettv->vval.v_string = get_cmdline_str();
10652 * "getcmdpos()" function
10654 /*ARGSUSED*/
10655 static void
10656 f_getcmdpos(argvars, rettv)
10657 typval_T *argvars;
10658 typval_T *rettv;
10660 rettv->vval.v_number = get_cmdline_pos() + 1;
10664 * "getcmdtype()" function
10666 /*ARGSUSED*/
10667 static void
10668 f_getcmdtype(argvars, rettv)
10669 typval_T *argvars;
10670 typval_T *rettv;
10672 rettv->v_type = VAR_STRING;
10673 rettv->vval.v_string = alloc(2);
10674 if (rettv->vval.v_string != NULL)
10676 rettv->vval.v_string[0] = get_cmdline_type();
10677 rettv->vval.v_string[1] = NUL;
10682 * "getcwd()" function
10684 /*ARGSUSED*/
10685 static void
10686 f_getcwd(argvars, rettv)
10687 typval_T *argvars;
10688 typval_T *rettv;
10690 char_u cwd[MAXPATHL];
10692 rettv->v_type = VAR_STRING;
10693 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10694 rettv->vval.v_string = NULL;
10695 else
10697 rettv->vval.v_string = vim_strsave(cwd);
10698 #ifdef BACKSLASH_IN_FILENAME
10699 if (rettv->vval.v_string != NULL)
10700 slash_adjust(rettv->vval.v_string);
10701 #endif
10706 * "getfontname()" function
10708 /*ARGSUSED*/
10709 static void
10710 f_getfontname(argvars, rettv)
10711 typval_T *argvars;
10712 typval_T *rettv;
10714 rettv->v_type = VAR_STRING;
10715 rettv->vval.v_string = NULL;
10716 #ifdef FEAT_GUI
10717 if (gui.in_use)
10719 GuiFont font;
10720 char_u *name = NULL;
10722 if (argvars[0].v_type == VAR_UNKNOWN)
10724 /* Get the "Normal" font. Either the name saved by
10725 * hl_set_font_name() or from the font ID. */
10726 font = gui.norm_font;
10727 name = hl_get_font_name();
10729 else
10731 name = get_tv_string(&argvars[0]);
10732 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10733 return;
10734 font = gui_mch_get_font(name, FALSE);
10735 if (font == NOFONT)
10736 return; /* Invalid font name, return empty string. */
10738 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10739 if (argvars[0].v_type != VAR_UNKNOWN)
10740 gui_mch_free_font(font);
10742 #endif
10746 * "getfperm({fname})" function
10748 static void
10749 f_getfperm(argvars, rettv)
10750 typval_T *argvars;
10751 typval_T *rettv;
10753 char_u *fname;
10754 struct stat st;
10755 char_u *perm = NULL;
10756 char_u flags[] = "rwx";
10757 int i;
10759 fname = get_tv_string(&argvars[0]);
10761 rettv->v_type = VAR_STRING;
10762 if (mch_stat((char *)fname, &st) >= 0)
10764 perm = vim_strsave((char_u *)"---------");
10765 if (perm != NULL)
10767 for (i = 0; i < 9; i++)
10769 if (st.st_mode & (1 << (8 - i)))
10770 perm[i] = flags[i % 3];
10774 rettv->vval.v_string = perm;
10778 * "getfsize({fname})" function
10780 static void
10781 f_getfsize(argvars, rettv)
10782 typval_T *argvars;
10783 typval_T *rettv;
10785 char_u *fname;
10786 struct stat st;
10788 fname = get_tv_string(&argvars[0]);
10790 rettv->v_type = VAR_NUMBER;
10792 if (mch_stat((char *)fname, &st) >= 0)
10794 if (mch_isdir(fname))
10795 rettv->vval.v_number = 0;
10796 else
10798 rettv->vval.v_number = (varnumber_T)st.st_size;
10800 /* non-perfect check for overflow */
10801 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10802 rettv->vval.v_number = -2;
10805 else
10806 rettv->vval.v_number = -1;
10810 * "getftime({fname})" function
10812 static void
10813 f_getftime(argvars, rettv)
10814 typval_T *argvars;
10815 typval_T *rettv;
10817 char_u *fname;
10818 struct stat st;
10820 fname = get_tv_string(&argvars[0]);
10822 if (mch_stat((char *)fname, &st) >= 0)
10823 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10824 else
10825 rettv->vval.v_number = -1;
10829 * "getftype({fname})" function
10831 static void
10832 f_getftype(argvars, rettv)
10833 typval_T *argvars;
10834 typval_T *rettv;
10836 char_u *fname;
10837 struct stat st;
10838 char_u *type = NULL;
10839 char *t;
10841 fname = get_tv_string(&argvars[0]);
10843 rettv->v_type = VAR_STRING;
10844 if (mch_lstat((char *)fname, &st) >= 0)
10846 #ifdef S_ISREG
10847 if (S_ISREG(st.st_mode))
10848 t = "file";
10849 else if (S_ISDIR(st.st_mode))
10850 t = "dir";
10851 # ifdef S_ISLNK
10852 else if (S_ISLNK(st.st_mode))
10853 t = "link";
10854 # endif
10855 # ifdef S_ISBLK
10856 else if (S_ISBLK(st.st_mode))
10857 t = "bdev";
10858 # endif
10859 # ifdef S_ISCHR
10860 else if (S_ISCHR(st.st_mode))
10861 t = "cdev";
10862 # endif
10863 # ifdef S_ISFIFO
10864 else if (S_ISFIFO(st.st_mode))
10865 t = "fifo";
10866 # endif
10867 # ifdef S_ISSOCK
10868 else if (S_ISSOCK(st.st_mode))
10869 t = "fifo";
10870 # endif
10871 else
10872 t = "other";
10873 #else
10874 # ifdef S_IFMT
10875 switch (st.st_mode & S_IFMT)
10877 case S_IFREG: t = "file"; break;
10878 case S_IFDIR: t = "dir"; break;
10879 # ifdef S_IFLNK
10880 case S_IFLNK: t = "link"; break;
10881 # endif
10882 # ifdef S_IFBLK
10883 case S_IFBLK: t = "bdev"; break;
10884 # endif
10885 # ifdef S_IFCHR
10886 case S_IFCHR: t = "cdev"; break;
10887 # endif
10888 # ifdef S_IFIFO
10889 case S_IFIFO: t = "fifo"; break;
10890 # endif
10891 # ifdef S_IFSOCK
10892 case S_IFSOCK: t = "socket"; break;
10893 # endif
10894 default: t = "other";
10896 # else
10897 if (mch_isdir(fname))
10898 t = "dir";
10899 else
10900 t = "file";
10901 # endif
10902 #endif
10903 type = vim_strsave((char_u *)t);
10905 rettv->vval.v_string = type;
10909 * "getline(lnum, [end])" function
10911 static void
10912 f_getline(argvars, rettv)
10913 typval_T *argvars;
10914 typval_T *rettv;
10916 linenr_T lnum;
10917 linenr_T end;
10918 int retlist;
10920 lnum = get_tv_lnum(argvars);
10921 if (argvars[1].v_type == VAR_UNKNOWN)
10923 end = 0;
10924 retlist = FALSE;
10926 else
10928 end = get_tv_lnum(&argvars[1]);
10929 retlist = TRUE;
10932 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
10936 * "getmatches()" function
10938 /*ARGSUSED*/
10939 static void
10940 f_getmatches(argvars, rettv)
10941 typval_T *argvars;
10942 typval_T *rettv;
10944 #ifdef FEAT_SEARCH_EXTRA
10945 dict_T *dict;
10946 matchitem_T *cur = curwin->w_match_head;
10948 rettv->vval.v_number = 0;
10950 if (rettv_list_alloc(rettv) == OK)
10952 while (cur != NULL)
10954 dict = dict_alloc();
10955 if (dict == NULL)
10956 return;
10957 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
10958 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
10959 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
10960 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
10961 list_append_dict(rettv->vval.v_list, dict);
10962 cur = cur->next;
10965 #endif
10969 * "getpid()" function
10971 /*ARGSUSED*/
10972 static void
10973 f_getpid(argvars, rettv)
10974 typval_T *argvars;
10975 typval_T *rettv;
10977 rettv->vval.v_number = mch_get_pid();
10981 * "getpos(string)" function
10983 static void
10984 f_getpos(argvars, rettv)
10985 typval_T *argvars;
10986 typval_T *rettv;
10988 pos_T *fp;
10989 list_T *l;
10990 int fnum = -1;
10992 if (rettv_list_alloc(rettv) == OK)
10994 l = rettv->vval.v_list;
10995 fp = var2fpos(&argvars[0], TRUE, &fnum);
10996 if (fnum != -1)
10997 list_append_number(l, (varnumber_T)fnum);
10998 else
10999 list_append_number(l, (varnumber_T)0);
11000 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11001 : (varnumber_T)0);
11002 list_append_number(l, (fp != NULL)
11003 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11004 : (varnumber_T)0);
11005 list_append_number(l,
11006 #ifdef FEAT_VIRTUALEDIT
11007 (fp != NULL) ? (varnumber_T)fp->coladd :
11008 #endif
11009 (varnumber_T)0);
11011 else
11012 rettv->vval.v_number = FALSE;
11016 * "getqflist()" and "getloclist()" functions
11018 /*ARGSUSED*/
11019 static void
11020 f_getqflist(argvars, rettv)
11021 typval_T *argvars;
11022 typval_T *rettv;
11024 #ifdef FEAT_QUICKFIX
11025 win_T *wp;
11026 #endif
11028 rettv->vval.v_number = 0;
11029 #ifdef FEAT_QUICKFIX
11030 if (rettv_list_alloc(rettv) == OK)
11032 wp = NULL;
11033 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11035 wp = find_win_by_nr(&argvars[0], NULL);
11036 if (wp == NULL)
11037 return;
11040 (void)get_errorlist(wp, rettv->vval.v_list);
11042 #endif
11046 * "getreg()" function
11048 static void
11049 f_getreg(argvars, rettv)
11050 typval_T *argvars;
11051 typval_T *rettv;
11053 char_u *strregname;
11054 int regname;
11055 int arg2 = FALSE;
11056 int error = FALSE;
11058 if (argvars[0].v_type != VAR_UNKNOWN)
11060 strregname = get_tv_string_chk(&argvars[0]);
11061 error = strregname == NULL;
11062 if (argvars[1].v_type != VAR_UNKNOWN)
11063 arg2 = get_tv_number_chk(&argvars[1], &error);
11065 else
11066 strregname = vimvars[VV_REG].vv_str;
11067 regname = (strregname == NULL ? '"' : *strregname);
11068 if (regname == 0)
11069 regname = '"';
11071 rettv->v_type = VAR_STRING;
11072 rettv->vval.v_string = error ? NULL :
11073 get_reg_contents(regname, TRUE, arg2);
11077 * "getregtype()" function
11079 static void
11080 f_getregtype(argvars, rettv)
11081 typval_T *argvars;
11082 typval_T *rettv;
11084 char_u *strregname;
11085 int regname;
11086 char_u buf[NUMBUFLEN + 2];
11087 long reglen = 0;
11089 if (argvars[0].v_type != VAR_UNKNOWN)
11091 strregname = get_tv_string_chk(&argvars[0]);
11092 if (strregname == NULL) /* type error; errmsg already given */
11094 rettv->v_type = VAR_STRING;
11095 rettv->vval.v_string = NULL;
11096 return;
11099 else
11100 /* Default to v:register */
11101 strregname = vimvars[VV_REG].vv_str;
11103 regname = (strregname == NULL ? '"' : *strregname);
11104 if (regname == 0)
11105 regname = '"';
11107 buf[0] = NUL;
11108 buf[1] = NUL;
11109 switch (get_reg_type(regname, &reglen))
11111 case MLINE: buf[0] = 'V'; break;
11112 case MCHAR: buf[0] = 'v'; break;
11113 #ifdef FEAT_VISUAL
11114 case MBLOCK:
11115 buf[0] = Ctrl_V;
11116 sprintf((char *)buf + 1, "%ld", reglen + 1);
11117 break;
11118 #endif
11120 rettv->v_type = VAR_STRING;
11121 rettv->vval.v_string = vim_strsave(buf);
11125 * "gettabwinvar()" function
11127 static void
11128 f_gettabwinvar(argvars, rettv)
11129 typval_T *argvars;
11130 typval_T *rettv;
11132 getwinvar(argvars, rettv, 1);
11136 * "getwinposx()" function
11138 /*ARGSUSED*/
11139 static void
11140 f_getwinposx(argvars, rettv)
11141 typval_T *argvars;
11142 typval_T *rettv;
11144 rettv->vval.v_number = -1;
11145 #ifdef FEAT_GUI
11146 if (gui.in_use)
11148 int x, y;
11150 if (gui_mch_get_winpos(&x, &y) == OK)
11151 rettv->vval.v_number = x;
11153 #endif
11157 * "getwinposy()" function
11159 /*ARGSUSED*/
11160 static void
11161 f_getwinposy(argvars, rettv)
11162 typval_T *argvars;
11163 typval_T *rettv;
11165 rettv->vval.v_number = -1;
11166 #ifdef FEAT_GUI
11167 if (gui.in_use)
11169 int x, y;
11171 if (gui_mch_get_winpos(&x, &y) == OK)
11172 rettv->vval.v_number = y;
11174 #endif
11178 * Find window specified by "vp" in tabpage "tp".
11180 static win_T *
11181 find_win_by_nr(vp, tp)
11182 typval_T *vp;
11183 tabpage_T *tp; /* NULL for current tab page */
11185 #ifdef FEAT_WINDOWS
11186 win_T *wp;
11187 #endif
11188 int nr;
11190 nr = get_tv_number_chk(vp, NULL);
11192 #ifdef FEAT_WINDOWS
11193 if (nr < 0)
11194 return NULL;
11195 if (nr == 0)
11196 return curwin;
11198 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11199 wp != NULL; wp = wp->w_next)
11200 if (--nr <= 0)
11201 break;
11202 return wp;
11203 #else
11204 if (nr == 0 || nr == 1)
11205 return curwin;
11206 return NULL;
11207 #endif
11211 * "getwinvar()" function
11213 static void
11214 f_getwinvar(argvars, rettv)
11215 typval_T *argvars;
11216 typval_T *rettv;
11218 getwinvar(argvars, rettv, 0);
11222 * getwinvar() and gettabwinvar()
11224 static void
11225 getwinvar(argvars, rettv, off)
11226 typval_T *argvars;
11227 typval_T *rettv;
11228 int off; /* 1 for gettabwinvar() */
11230 win_T *win, *oldcurwin;
11231 char_u *varname;
11232 dictitem_T *v;
11233 tabpage_T *tp;
11235 #ifdef FEAT_WINDOWS
11236 if (off == 1)
11237 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11238 else
11239 tp = curtab;
11240 #endif
11241 win = find_win_by_nr(&argvars[off], tp);
11242 varname = get_tv_string_chk(&argvars[off + 1]);
11243 ++emsg_off;
11245 rettv->v_type = VAR_STRING;
11246 rettv->vval.v_string = NULL;
11248 if (win != NULL && varname != NULL)
11250 /* Set curwin to be our win, temporarily. Also set curbuf, so
11251 * that we can get buffer-local options. */
11252 oldcurwin = curwin;
11253 curwin = win;
11254 curbuf = win->w_buffer;
11256 if (*varname == '&') /* window-local-option */
11257 get_option_tv(&varname, rettv, 1);
11258 else
11260 if (*varname == NUL)
11261 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11262 * scope prefix before the NUL byte is required by
11263 * find_var_in_ht(). */
11264 varname = (char_u *)"w:" + 2;
11265 /* look up the variable */
11266 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11267 if (v != NULL)
11268 copy_tv(&v->di_tv, rettv);
11271 /* restore previous notion of curwin */
11272 curwin = oldcurwin;
11273 curbuf = curwin->w_buffer;
11276 --emsg_off;
11280 * "glob()" function
11282 static void
11283 f_glob(argvars, rettv)
11284 typval_T *argvars;
11285 typval_T *rettv;
11287 expand_T xpc;
11289 ExpandInit(&xpc);
11290 xpc.xp_context = EXPAND_FILES;
11291 rettv->v_type = VAR_STRING;
11292 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11293 NULL, WILD_USE_NL|WILD_SILENT, WILD_ALL);
11297 * "globpath()" function
11299 static void
11300 f_globpath(argvars, rettv)
11301 typval_T *argvars;
11302 typval_T *rettv;
11304 char_u buf1[NUMBUFLEN];
11305 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11307 rettv->v_type = VAR_STRING;
11308 if (file == NULL)
11309 rettv->vval.v_string = NULL;
11310 else
11311 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file);
11315 * "has()" function
11317 static void
11318 f_has(argvars, rettv)
11319 typval_T *argvars;
11320 typval_T *rettv;
11322 int i;
11323 char_u *name;
11324 int n = FALSE;
11325 static char *(has_list[]) =
11327 #ifdef AMIGA
11328 "amiga",
11329 # ifdef FEAT_ARP
11330 "arp",
11331 # endif
11332 #endif
11333 #ifdef __BEOS__
11334 "beos",
11335 #endif
11336 #ifdef MSDOS
11337 # ifdef DJGPP
11338 "dos32",
11339 # else
11340 "dos16",
11341 # endif
11342 #endif
11343 #ifdef MACOS
11344 "mac",
11345 #endif
11346 #if defined(MACOS_X_UNIX)
11347 "macunix",
11348 #endif
11349 #ifdef OS2
11350 "os2",
11351 #endif
11352 #ifdef __QNX__
11353 "qnx",
11354 #endif
11355 #ifdef RISCOS
11356 "riscos",
11357 #endif
11358 #ifdef UNIX
11359 "unix",
11360 #endif
11361 #ifdef VMS
11362 "vms",
11363 #endif
11364 #ifdef WIN16
11365 "win16",
11366 #endif
11367 #ifdef WIN32
11368 "win32",
11369 #endif
11370 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11371 "win32unix",
11372 #endif
11373 #ifdef WIN64
11374 "win64",
11375 #endif
11376 #ifdef EBCDIC
11377 "ebcdic",
11378 #endif
11379 #ifndef CASE_INSENSITIVE_FILENAME
11380 "fname_case",
11381 #endif
11382 #ifdef FEAT_ARABIC
11383 "arabic",
11384 #endif
11385 #ifdef FEAT_AUTOCMD
11386 "autocmd",
11387 #endif
11388 #ifdef FEAT_BEVAL
11389 "balloon_eval",
11390 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11391 "balloon_multiline",
11392 # endif
11393 #endif
11394 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11395 "builtin_terms",
11396 # ifdef ALL_BUILTIN_TCAPS
11397 "all_builtin_terms",
11398 # endif
11399 #endif
11400 #ifdef FEAT_BYTEOFF
11401 "byte_offset",
11402 #endif
11403 #ifdef FEAT_CINDENT
11404 "cindent",
11405 #endif
11406 #ifdef FEAT_CLIENTSERVER
11407 "clientserver",
11408 #endif
11409 #ifdef FEAT_CLIPBOARD
11410 "clipboard",
11411 #endif
11412 #ifdef FEAT_CMDL_COMPL
11413 "cmdline_compl",
11414 #endif
11415 #ifdef FEAT_CMDHIST
11416 "cmdline_hist",
11417 #endif
11418 #ifdef FEAT_COMMENTS
11419 "comments",
11420 #endif
11421 #ifdef FEAT_CRYPT
11422 "cryptv",
11423 #endif
11424 #ifdef FEAT_CSCOPE
11425 "cscope",
11426 #endif
11427 #ifdef CURSOR_SHAPE
11428 "cursorshape",
11429 #endif
11430 #ifdef DEBUG
11431 "debug",
11432 #endif
11433 #ifdef FEAT_CON_DIALOG
11434 "dialog_con",
11435 #endif
11436 #ifdef FEAT_GUI_DIALOG
11437 "dialog_gui",
11438 #endif
11439 #ifdef FEAT_DIFF
11440 "diff",
11441 #endif
11442 #ifdef FEAT_DIGRAPHS
11443 "digraphs",
11444 #endif
11445 #ifdef FEAT_DND
11446 "dnd",
11447 #endif
11448 #ifdef FEAT_EMACS_TAGS
11449 "emacs_tags",
11450 #endif
11451 "eval", /* always present, of course! */
11452 #ifdef FEAT_EX_EXTRA
11453 "ex_extra",
11454 #endif
11455 #ifdef FEAT_SEARCH_EXTRA
11456 "extra_search",
11457 #endif
11458 #ifdef FEAT_FKMAP
11459 "farsi",
11460 #endif
11461 #ifdef FEAT_SEARCHPATH
11462 "file_in_path",
11463 #endif
11464 #if defined(UNIX) && !defined(USE_SYSTEM)
11465 "filterpipe",
11466 #endif
11467 #ifdef FEAT_FIND_ID
11468 "find_in_path",
11469 #endif
11470 #ifdef FEAT_FLOAT
11471 "float",
11472 #endif
11473 #ifdef FEAT_FOLDING
11474 "folding",
11475 #endif
11476 #ifdef FEAT_FOOTER
11477 "footer",
11478 #endif
11479 #if !defined(USE_SYSTEM) && defined(UNIX)
11480 "fork",
11481 #endif
11482 #ifdef FEAT_FULLSCREEN
11483 "fullscreen",
11484 #endif
11485 #ifdef FEAT_GETTEXT
11486 "gettext",
11487 #endif
11488 #ifdef FEAT_GUI
11489 "gui",
11490 #endif
11491 #ifdef FEAT_GUI_ATHENA
11492 # ifdef FEAT_GUI_NEXTAW
11493 "gui_neXtaw",
11494 # else
11495 "gui_athena",
11496 # endif
11497 #endif
11498 #ifdef FEAT_GUI_GTK
11499 "gui_gtk",
11500 # ifdef HAVE_GTK2
11501 "gui_gtk2",
11502 # endif
11503 #endif
11504 #ifdef FEAT_GUI_GNOME
11505 "gui_gnome",
11506 #endif
11507 #ifdef FEAT_GUI_MAC
11508 "gui_mac",
11509 #endif
11510 #ifdef FEAT_GUI_MACVIM
11511 "gui_macvim",
11512 #endif
11513 #ifdef FEAT_GUI_MOTIF
11514 "gui_motif",
11515 #endif
11516 #ifdef FEAT_GUI_PHOTON
11517 "gui_photon",
11518 #endif
11519 #ifdef FEAT_GUI_W16
11520 "gui_win16",
11521 #endif
11522 #ifdef FEAT_GUI_W32
11523 "gui_win32",
11524 #endif
11525 #ifdef FEAT_HANGULIN
11526 "hangul_input",
11527 #endif
11528 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11529 "iconv",
11530 #endif
11531 #ifdef FEAT_INS_EXPAND
11532 "insert_expand",
11533 #endif
11534 #ifdef FEAT_JUMPLIST
11535 "jumplist",
11536 #endif
11537 #ifdef FEAT_KEYMAP
11538 "keymap",
11539 #endif
11540 #ifdef FEAT_LANGMAP
11541 "langmap",
11542 #endif
11543 #ifdef FEAT_LIBCALL
11544 "libcall",
11545 #endif
11546 #ifdef FEAT_LINEBREAK
11547 "linebreak",
11548 #endif
11549 #ifdef FEAT_LISP
11550 "lispindent",
11551 #endif
11552 #ifdef FEAT_LISTCMDS
11553 "listcmds",
11554 #endif
11555 #ifdef FEAT_LOCALMAP
11556 "localmap",
11557 #endif
11558 #ifdef FEAT_MENU
11559 "menu",
11560 #endif
11561 #ifdef FEAT_SESSION
11562 "mksession",
11563 #endif
11564 #ifdef FEAT_MODIFY_FNAME
11565 "modify_fname",
11566 #endif
11567 #ifdef FEAT_MOUSE
11568 "mouse",
11569 #endif
11570 #ifdef FEAT_MOUSESHAPE
11571 "mouseshape",
11572 #endif
11573 #if defined(UNIX) || defined(VMS)
11574 # ifdef FEAT_MOUSE_DEC
11575 "mouse_dec",
11576 # endif
11577 # ifdef FEAT_MOUSE_GPM
11578 "mouse_gpm",
11579 # endif
11580 # ifdef FEAT_MOUSE_JSB
11581 "mouse_jsbterm",
11582 # endif
11583 # ifdef FEAT_MOUSE_NET
11584 "mouse_netterm",
11585 # endif
11586 # ifdef FEAT_MOUSE_PTERM
11587 "mouse_pterm",
11588 # endif
11589 # ifdef FEAT_SYSMOUSE
11590 "mouse_sysmouse",
11591 # endif
11592 # ifdef FEAT_MOUSE_XTERM
11593 "mouse_xterm",
11594 # endif
11595 #endif
11596 #ifdef FEAT_MBYTE
11597 "multi_byte",
11598 #endif
11599 #ifdef FEAT_MBYTE_IME
11600 "multi_byte_ime",
11601 #endif
11602 #ifdef FEAT_MULTI_LANG
11603 "multi_lang",
11604 #endif
11605 #ifdef FEAT_MZSCHEME
11606 #ifndef DYNAMIC_MZSCHEME
11607 "mzscheme",
11608 #endif
11609 #endif
11610 #ifdef FEAT_OLE
11611 "ole",
11612 #endif
11613 #ifdef FEAT_OSFILETYPE
11614 "osfiletype",
11615 #endif
11616 #ifdef FEAT_PATH_EXTRA
11617 "path_extra",
11618 #endif
11619 #ifdef FEAT_PERL
11620 #ifndef DYNAMIC_PERL
11621 "perl",
11622 #endif
11623 #endif
11624 #ifdef FEAT_PYTHON
11625 #ifndef DYNAMIC_PYTHON
11626 "python",
11627 #endif
11628 #endif
11629 #ifdef FEAT_POSTSCRIPT
11630 "postscript",
11631 #endif
11632 #ifdef FEAT_PRINTER
11633 "printer",
11634 #endif
11635 #ifdef FEAT_PROFILE
11636 "profile",
11637 #endif
11638 #ifdef FEAT_RELTIME
11639 "reltime",
11640 #endif
11641 #ifdef FEAT_QUICKFIX
11642 "quickfix",
11643 #endif
11644 #ifdef FEAT_RIGHTLEFT
11645 "rightleft",
11646 #endif
11647 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11648 "ruby",
11649 #endif
11650 #ifdef FEAT_SCROLLBIND
11651 "scrollbind",
11652 #endif
11653 #ifdef FEAT_CMDL_INFO
11654 "showcmd",
11655 "cmdline_info",
11656 #endif
11657 #ifdef FEAT_SIGNS
11658 "signs",
11659 #endif
11660 #ifdef FEAT_SMARTINDENT
11661 "smartindent",
11662 #endif
11663 #ifdef FEAT_SNIFF
11664 "sniff",
11665 #endif
11666 #ifdef FEAT_STL_OPT
11667 "statusline",
11668 #endif
11669 #ifdef FEAT_SUN_WORKSHOP
11670 "sun_workshop",
11671 #endif
11672 #ifdef FEAT_NETBEANS_INTG
11673 "netbeans_intg",
11674 #endif
11675 #ifdef FEAT_ODB_EDITOR
11676 "odbeditor",
11677 #endif
11678 #ifdef FEAT_SPELL
11679 "spell",
11680 #endif
11681 #ifdef FEAT_SYN_HL
11682 "syntax",
11683 #endif
11684 #if defined(USE_SYSTEM) || !defined(UNIX)
11685 "system",
11686 #endif
11687 #ifdef FEAT_TAG_BINS
11688 "tag_binary",
11689 #endif
11690 #ifdef FEAT_TAG_OLDSTATIC
11691 "tag_old_static",
11692 #endif
11693 #ifdef FEAT_TAG_ANYWHITE
11694 "tag_any_white",
11695 #endif
11696 #ifdef FEAT_TCL
11697 # ifndef DYNAMIC_TCL
11698 "tcl",
11699 # endif
11700 #endif
11701 #ifdef TERMINFO
11702 "terminfo",
11703 #endif
11704 #ifdef FEAT_TERMRESPONSE
11705 "termresponse",
11706 #endif
11707 #ifdef FEAT_TEXTOBJ
11708 "textobjects",
11709 #endif
11710 #ifdef HAVE_TGETENT
11711 "tgetent",
11712 #endif
11713 #ifdef FEAT_TITLE
11714 "title",
11715 #endif
11716 #ifdef FEAT_TOOLBAR
11717 "toolbar",
11718 #endif
11719 #ifdef FEAT_TRANSPARENCY
11720 "transparency",
11721 #endif
11722 #ifdef FEAT_USR_CMDS
11723 "user-commands", /* was accidentally included in 5.4 */
11724 "user_commands",
11725 #endif
11726 #ifdef FEAT_VIMINFO
11727 "viminfo",
11728 #endif
11729 #ifdef FEAT_VERTSPLIT
11730 "vertsplit",
11731 #endif
11732 #ifdef FEAT_VIRTUALEDIT
11733 "virtualedit",
11734 #endif
11735 #ifdef FEAT_VISUAL
11736 "visual",
11737 #endif
11738 #ifdef FEAT_VISUALEXTRA
11739 "visualextra",
11740 #endif
11741 #ifdef FEAT_VREPLACE
11742 "vreplace",
11743 #endif
11744 #ifdef FEAT_WILDIGN
11745 "wildignore",
11746 #endif
11747 #ifdef FEAT_WILDMENU
11748 "wildmenu",
11749 #endif
11750 #ifdef FEAT_WINDOWS
11751 "windows",
11752 #endif
11753 #ifdef FEAT_WAK
11754 "winaltkeys",
11755 #endif
11756 #ifdef FEAT_WRITEBACKUP
11757 "writebackup",
11758 #endif
11759 #ifdef FEAT_XIM
11760 "xim",
11761 #endif
11762 #ifdef FEAT_XFONTSET
11763 "xfontset",
11764 #endif
11765 #ifdef USE_XSMP
11766 "xsmp",
11767 #endif
11768 #ifdef USE_XSMP_INTERACT
11769 "xsmp_interact",
11770 #endif
11771 #ifdef FEAT_XCLIPBOARD
11772 "xterm_clipboard",
11773 #endif
11774 #ifdef FEAT_XTERM_SAVE
11775 "xterm_save",
11776 #endif
11777 #if defined(UNIX) && defined(FEAT_X11)
11778 "X11",
11779 #endif
11780 NULL
11783 name = get_tv_string(&argvars[0]);
11784 for (i = 0; has_list[i] != NULL; ++i)
11785 if (STRICMP(name, has_list[i]) == 0)
11787 n = TRUE;
11788 break;
11791 if (n == FALSE)
11793 if (STRNICMP(name, "patch", 5) == 0)
11794 n = has_patch(atoi((char *)name + 5));
11795 else if (STRICMP(name, "vim_starting") == 0)
11796 n = (starting != 0);
11797 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11798 else if (STRICMP(name, "balloon_multiline") == 0)
11799 n = multiline_balloon_available();
11800 #endif
11801 #ifdef DYNAMIC_TCL
11802 else if (STRICMP(name, "tcl") == 0)
11803 n = tcl_enabled(FALSE);
11804 #endif
11805 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11806 else if (STRICMP(name, "iconv") == 0)
11807 n = iconv_enabled(FALSE);
11808 #endif
11809 #ifdef DYNAMIC_MZSCHEME
11810 else if (STRICMP(name, "mzscheme") == 0)
11811 n = mzscheme_enabled(FALSE);
11812 #endif
11813 #ifdef DYNAMIC_RUBY
11814 else if (STRICMP(name, "ruby") == 0)
11815 n = ruby_enabled(FALSE);
11816 #endif
11817 #ifdef DYNAMIC_PYTHON
11818 else if (STRICMP(name, "python") == 0)
11819 n = python_enabled(FALSE);
11820 #endif
11821 #ifdef DYNAMIC_PERL
11822 else if (STRICMP(name, "perl") == 0)
11823 n = perl_enabled(FALSE);
11824 #endif
11825 #ifdef FEAT_GUI
11826 else if (STRICMP(name, "gui_running") == 0)
11827 n = (gui.in_use || gui.starting);
11828 # ifdef FEAT_GUI_W32
11829 else if (STRICMP(name, "gui_win32s") == 0)
11830 n = gui_is_win32s();
11831 # endif
11832 # ifdef FEAT_BROWSE
11833 else if (STRICMP(name, "browse") == 0)
11834 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11835 # endif
11836 #endif
11837 #ifdef FEAT_SYN_HL
11838 else if (STRICMP(name, "syntax_items") == 0)
11839 n = syntax_present(curbuf);
11840 #endif
11841 #if defined(WIN3264)
11842 else if (STRICMP(name, "win95") == 0)
11843 n = mch_windows95();
11844 #endif
11845 #ifdef FEAT_NETBEANS_INTG
11846 else if (STRICMP(name, "netbeans_enabled") == 0)
11847 n = usingNetbeans;
11848 #endif
11851 rettv->vval.v_number = n;
11855 * "has_key()" function
11857 static void
11858 f_has_key(argvars, rettv)
11859 typval_T *argvars;
11860 typval_T *rettv;
11862 rettv->vval.v_number = 0;
11863 if (argvars[0].v_type != VAR_DICT)
11865 EMSG(_(e_dictreq));
11866 return;
11868 if (argvars[0].vval.v_dict == NULL)
11869 return;
11871 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11872 get_tv_string(&argvars[1]), -1) != NULL;
11876 * "haslocaldir()" function
11878 /*ARGSUSED*/
11879 static void
11880 f_haslocaldir(argvars, rettv)
11881 typval_T *argvars;
11882 typval_T *rettv;
11884 rettv->vval.v_number = (curwin->w_localdir != NULL);
11888 * "hasmapto()" function
11890 static void
11891 f_hasmapto(argvars, rettv)
11892 typval_T *argvars;
11893 typval_T *rettv;
11895 char_u *name;
11896 char_u *mode;
11897 char_u buf[NUMBUFLEN];
11898 int abbr = FALSE;
11900 name = get_tv_string(&argvars[0]);
11901 if (argvars[1].v_type == VAR_UNKNOWN)
11902 mode = (char_u *)"nvo";
11903 else
11905 mode = get_tv_string_buf(&argvars[1], buf);
11906 if (argvars[2].v_type != VAR_UNKNOWN)
11907 abbr = get_tv_number(&argvars[2]);
11910 if (map_to_exists(name, mode, abbr))
11911 rettv->vval.v_number = TRUE;
11912 else
11913 rettv->vval.v_number = FALSE;
11917 * "histadd()" function
11919 /*ARGSUSED*/
11920 static void
11921 f_histadd(argvars, rettv)
11922 typval_T *argvars;
11923 typval_T *rettv;
11925 #ifdef FEAT_CMDHIST
11926 int histype;
11927 char_u *str;
11928 char_u buf[NUMBUFLEN];
11929 #endif
11931 rettv->vval.v_number = FALSE;
11932 if (check_restricted() || check_secure())
11933 return;
11934 #ifdef FEAT_CMDHIST
11935 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11936 histype = str != NULL ? get_histtype(str) : -1;
11937 if (histype >= 0)
11939 str = get_tv_string_buf(&argvars[1], buf);
11940 if (*str != NUL)
11942 add_to_history(histype, str, FALSE, NUL);
11943 rettv->vval.v_number = TRUE;
11944 return;
11947 #endif
11951 * "histdel()" function
11953 /*ARGSUSED*/
11954 static void
11955 f_histdel(argvars, rettv)
11956 typval_T *argvars;
11957 typval_T *rettv;
11959 #ifdef FEAT_CMDHIST
11960 int n;
11961 char_u buf[NUMBUFLEN];
11962 char_u *str;
11964 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11965 if (str == NULL)
11966 n = 0;
11967 else if (argvars[1].v_type == VAR_UNKNOWN)
11968 /* only one argument: clear entire history */
11969 n = clr_history(get_histtype(str));
11970 else if (argvars[1].v_type == VAR_NUMBER)
11971 /* index given: remove that entry */
11972 n = del_history_idx(get_histtype(str),
11973 (int)get_tv_number(&argvars[1]));
11974 else
11975 /* string given: remove all matching entries */
11976 n = del_history_entry(get_histtype(str),
11977 get_tv_string_buf(&argvars[1], buf));
11978 rettv->vval.v_number = n;
11979 #else
11980 rettv->vval.v_number = 0;
11981 #endif
11985 * "histget()" function
11987 /*ARGSUSED*/
11988 static void
11989 f_histget(argvars, rettv)
11990 typval_T *argvars;
11991 typval_T *rettv;
11993 #ifdef FEAT_CMDHIST
11994 int type;
11995 int idx;
11996 char_u *str;
11998 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11999 if (str == NULL)
12000 rettv->vval.v_string = NULL;
12001 else
12003 type = get_histtype(str);
12004 if (argvars[1].v_type == VAR_UNKNOWN)
12005 idx = get_history_idx(type);
12006 else
12007 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12008 /* -1 on type error */
12009 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12011 #else
12012 rettv->vval.v_string = NULL;
12013 #endif
12014 rettv->v_type = VAR_STRING;
12018 * "histnr()" function
12020 /*ARGSUSED*/
12021 static void
12022 f_histnr(argvars, rettv)
12023 typval_T *argvars;
12024 typval_T *rettv;
12026 int i;
12028 #ifdef FEAT_CMDHIST
12029 char_u *history = get_tv_string_chk(&argvars[0]);
12031 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12032 if (i >= HIST_CMD && i < HIST_COUNT)
12033 i = get_history_idx(i);
12034 else
12035 #endif
12036 i = -1;
12037 rettv->vval.v_number = i;
12041 * "highlightID(name)" function
12043 static void
12044 f_hlID(argvars, rettv)
12045 typval_T *argvars;
12046 typval_T *rettv;
12048 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12052 * "highlight_exists()" function
12054 static void
12055 f_hlexists(argvars, rettv)
12056 typval_T *argvars;
12057 typval_T *rettv;
12059 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12063 * "hostname()" function
12065 /*ARGSUSED*/
12066 static void
12067 f_hostname(argvars, rettv)
12068 typval_T *argvars;
12069 typval_T *rettv;
12071 char_u hostname[256];
12073 mch_get_host_name(hostname, 256);
12074 rettv->v_type = VAR_STRING;
12075 rettv->vval.v_string = vim_strsave(hostname);
12079 * iconv() function
12081 /*ARGSUSED*/
12082 static void
12083 f_iconv(argvars, rettv)
12084 typval_T *argvars;
12085 typval_T *rettv;
12087 #ifdef FEAT_MBYTE
12088 char_u buf1[NUMBUFLEN];
12089 char_u buf2[NUMBUFLEN];
12090 char_u *from, *to, *str;
12091 vimconv_T vimconv;
12092 #endif
12094 rettv->v_type = VAR_STRING;
12095 rettv->vval.v_string = NULL;
12097 #ifdef FEAT_MBYTE
12098 str = get_tv_string(&argvars[0]);
12099 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12100 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12101 vimconv.vc_type = CONV_NONE;
12102 convert_setup(&vimconv, from, to);
12104 /* If the encodings are equal, no conversion needed. */
12105 if (vimconv.vc_type == CONV_NONE)
12106 rettv->vval.v_string = vim_strsave(str);
12107 else
12108 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12110 convert_setup(&vimconv, NULL, NULL);
12111 vim_free(from);
12112 vim_free(to);
12113 #endif
12117 * "indent()" function
12119 static void
12120 f_indent(argvars, rettv)
12121 typval_T *argvars;
12122 typval_T *rettv;
12124 linenr_T lnum;
12126 lnum = get_tv_lnum(argvars);
12127 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12128 rettv->vval.v_number = get_indent_lnum(lnum);
12129 else
12130 rettv->vval.v_number = -1;
12134 * "index()" function
12136 static void
12137 f_index(argvars, rettv)
12138 typval_T *argvars;
12139 typval_T *rettv;
12141 list_T *l;
12142 listitem_T *item;
12143 long idx = 0;
12144 int ic = FALSE;
12146 rettv->vval.v_number = -1;
12147 if (argvars[0].v_type != VAR_LIST)
12149 EMSG(_(e_listreq));
12150 return;
12152 l = argvars[0].vval.v_list;
12153 if (l != NULL)
12155 item = l->lv_first;
12156 if (argvars[2].v_type != VAR_UNKNOWN)
12158 int error = FALSE;
12160 /* Start at specified item. Use the cached index that list_find()
12161 * sets, so that a negative number also works. */
12162 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12163 idx = l->lv_idx;
12164 if (argvars[3].v_type != VAR_UNKNOWN)
12165 ic = get_tv_number_chk(&argvars[3], &error);
12166 if (error)
12167 item = NULL;
12170 for ( ; item != NULL; item = item->li_next, ++idx)
12171 if (tv_equal(&item->li_tv, &argvars[1], ic))
12173 rettv->vval.v_number = idx;
12174 break;
12179 static int inputsecret_flag = 0;
12181 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12184 * This function is used by f_input() and f_inputdialog() functions. The third
12185 * argument to f_input() specifies the type of completion to use at the
12186 * prompt. The third argument to f_inputdialog() specifies the value to return
12187 * when the user cancels the prompt.
12189 static void
12190 get_user_input(argvars, rettv, inputdialog)
12191 typval_T *argvars;
12192 typval_T *rettv;
12193 int inputdialog;
12195 char_u *prompt = get_tv_string_chk(&argvars[0]);
12196 char_u *p = NULL;
12197 int c;
12198 char_u buf[NUMBUFLEN];
12199 int cmd_silent_save = cmd_silent;
12200 char_u *defstr = (char_u *)"";
12201 int xp_type = EXPAND_NOTHING;
12202 char_u *xp_arg = NULL;
12204 rettv->v_type = VAR_STRING;
12205 rettv->vval.v_string = NULL;
12207 #ifdef NO_CONSOLE_INPUT
12208 /* While starting up, there is no place to enter text. */
12209 if (no_console_input())
12210 return;
12211 #endif
12213 cmd_silent = FALSE; /* Want to see the prompt. */
12214 if (prompt != NULL)
12216 /* Only the part of the message after the last NL is considered as
12217 * prompt for the command line */
12218 p = vim_strrchr(prompt, '\n');
12219 if (p == NULL)
12220 p = prompt;
12221 else
12223 ++p;
12224 c = *p;
12225 *p = NUL;
12226 msg_start();
12227 msg_clr_eos();
12228 msg_puts_attr(prompt, echo_attr);
12229 msg_didout = FALSE;
12230 msg_starthere();
12231 *p = c;
12233 cmdline_row = msg_row;
12235 if (argvars[1].v_type != VAR_UNKNOWN)
12237 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12238 if (defstr != NULL)
12239 stuffReadbuffSpec(defstr);
12241 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12243 char_u *xp_name;
12244 int xp_namelen;
12245 long argt;
12247 rettv->vval.v_string = NULL;
12249 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12250 if (xp_name == NULL)
12251 return;
12253 xp_namelen = (int)STRLEN(xp_name);
12255 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12256 &xp_arg) == FAIL)
12257 return;
12261 if (defstr != NULL)
12262 rettv->vval.v_string =
12263 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12264 xp_type, xp_arg);
12266 vim_free(xp_arg);
12268 /* since the user typed this, no need to wait for return */
12269 need_wait_return = FALSE;
12270 msg_didout = FALSE;
12272 cmd_silent = cmd_silent_save;
12276 * "input()" function
12277 * Also handles inputsecret() when inputsecret is set.
12279 static void
12280 f_input(argvars, rettv)
12281 typval_T *argvars;
12282 typval_T *rettv;
12284 get_user_input(argvars, rettv, FALSE);
12288 * "inputdialog()" function
12290 static void
12291 f_inputdialog(argvars, rettv)
12292 typval_T *argvars;
12293 typval_T *rettv;
12295 #if defined(FEAT_GUI_TEXTDIALOG)
12296 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12297 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12299 char_u *message;
12300 char_u buf[NUMBUFLEN];
12301 char_u *defstr = (char_u *)"";
12303 message = get_tv_string_chk(&argvars[0]);
12304 if (argvars[1].v_type != VAR_UNKNOWN
12305 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12306 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12307 else
12308 IObuff[0] = NUL;
12309 if (message != NULL && defstr != NULL
12310 && do_dialog(VIM_QUESTION, NULL, message,
12311 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12312 rettv->vval.v_string = vim_strsave(IObuff);
12313 else
12315 if (message != NULL && defstr != NULL
12316 && argvars[1].v_type != VAR_UNKNOWN
12317 && argvars[2].v_type != VAR_UNKNOWN)
12318 rettv->vval.v_string = vim_strsave(
12319 get_tv_string_buf(&argvars[2], buf));
12320 else
12321 rettv->vval.v_string = NULL;
12323 rettv->v_type = VAR_STRING;
12325 else
12326 #endif
12327 get_user_input(argvars, rettv, TRUE);
12331 * "inputlist()" function
12333 static void
12334 f_inputlist(argvars, rettv)
12335 typval_T *argvars;
12336 typval_T *rettv;
12338 listitem_T *li;
12339 int selected;
12340 int mouse_used;
12342 rettv->vval.v_number = 0;
12343 #ifdef NO_CONSOLE_INPUT
12344 /* While starting up, there is no place to enter text. */
12345 if (no_console_input())
12346 return;
12347 #endif
12348 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12350 EMSG2(_(e_listarg), "inputlist()");
12351 return;
12354 msg_start();
12355 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12356 lines_left = Rows; /* avoid more prompt */
12357 msg_scroll = TRUE;
12358 msg_clr_eos();
12360 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12362 msg_puts(get_tv_string(&li->li_tv));
12363 msg_putchar('\n');
12366 /* Ask for choice. */
12367 selected = prompt_for_number(&mouse_used);
12368 if (mouse_used)
12369 selected -= lines_left;
12371 rettv->vval.v_number = selected;
12375 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12378 * "inputrestore()" function
12380 /*ARGSUSED*/
12381 static void
12382 f_inputrestore(argvars, rettv)
12383 typval_T *argvars;
12384 typval_T *rettv;
12386 if (ga_userinput.ga_len > 0)
12388 --ga_userinput.ga_len;
12389 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12390 + ga_userinput.ga_len);
12391 rettv->vval.v_number = 0; /* OK */
12393 else if (p_verbose > 1)
12395 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12396 rettv->vval.v_number = 1; /* Failed */
12401 * "inputsave()" function
12403 /*ARGSUSED*/
12404 static void
12405 f_inputsave(argvars, rettv)
12406 typval_T *argvars;
12407 typval_T *rettv;
12409 /* Add an entry to the stack of typeahead storage. */
12410 if (ga_grow(&ga_userinput, 1) == OK)
12412 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12413 + ga_userinput.ga_len);
12414 ++ga_userinput.ga_len;
12415 rettv->vval.v_number = 0; /* OK */
12417 else
12418 rettv->vval.v_number = 1; /* Failed */
12422 * "inputsecret()" function
12424 static void
12425 f_inputsecret(argvars, rettv)
12426 typval_T *argvars;
12427 typval_T *rettv;
12429 ++cmdline_star;
12430 ++inputsecret_flag;
12431 f_input(argvars, rettv);
12432 --cmdline_star;
12433 --inputsecret_flag;
12437 * "insert()" function
12439 static void
12440 f_insert(argvars, rettv)
12441 typval_T *argvars;
12442 typval_T *rettv;
12444 long before = 0;
12445 listitem_T *item;
12446 list_T *l;
12447 int error = FALSE;
12449 rettv->vval.v_number = 0;
12450 if (argvars[0].v_type != VAR_LIST)
12451 EMSG2(_(e_listarg), "insert()");
12452 else if ((l = argvars[0].vval.v_list) != NULL
12453 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12455 if (argvars[2].v_type != VAR_UNKNOWN)
12456 before = get_tv_number_chk(&argvars[2], &error);
12457 if (error)
12458 return; /* type error; errmsg already given */
12460 if (before == l->lv_len)
12461 item = NULL;
12462 else
12464 item = list_find(l, before);
12465 if (item == NULL)
12467 EMSGN(_(e_listidx), before);
12468 l = NULL;
12471 if (l != NULL)
12473 list_insert_tv(l, &argvars[1], item);
12474 copy_tv(&argvars[0], rettv);
12480 * "isdirectory()" function
12482 static void
12483 f_isdirectory(argvars, rettv)
12484 typval_T *argvars;
12485 typval_T *rettv;
12487 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12491 * "islocked()" function
12493 static void
12494 f_islocked(argvars, rettv)
12495 typval_T *argvars;
12496 typval_T *rettv;
12498 lval_T lv;
12499 char_u *end;
12500 dictitem_T *di;
12502 rettv->vval.v_number = -1;
12503 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12504 FNE_CHECK_START);
12505 if (end != NULL && lv.ll_name != NULL)
12507 if (*end != NUL)
12508 EMSG(_(e_trailing));
12509 else
12511 if (lv.ll_tv == NULL)
12513 if (check_changedtick(lv.ll_name))
12514 rettv->vval.v_number = 1; /* always locked */
12515 else
12517 di = find_var(lv.ll_name, NULL);
12518 if (di != NULL)
12520 /* Consider a variable locked when:
12521 * 1. the variable itself is locked
12522 * 2. the value of the variable is locked.
12523 * 3. the List or Dict value is locked.
12525 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12526 || tv_islocked(&di->di_tv));
12530 else if (lv.ll_range)
12531 EMSG(_("E786: Range not allowed"));
12532 else if (lv.ll_newkey != NULL)
12533 EMSG2(_(e_dictkey), lv.ll_newkey);
12534 else if (lv.ll_list != NULL)
12535 /* List item. */
12536 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12537 else
12538 /* Dictionary item. */
12539 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12543 clear_lval(&lv);
12546 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12549 * Turn a dict into a list:
12550 * "what" == 0: list of keys
12551 * "what" == 1: list of values
12552 * "what" == 2: list of items
12554 static void
12555 dict_list(argvars, rettv, what)
12556 typval_T *argvars;
12557 typval_T *rettv;
12558 int what;
12560 list_T *l2;
12561 dictitem_T *di;
12562 hashitem_T *hi;
12563 listitem_T *li;
12564 listitem_T *li2;
12565 dict_T *d;
12566 int todo;
12568 rettv->vval.v_number = 0;
12569 if (argvars[0].v_type != VAR_DICT)
12571 EMSG(_(e_dictreq));
12572 return;
12574 if ((d = argvars[0].vval.v_dict) == NULL)
12575 return;
12577 if (rettv_list_alloc(rettv) == FAIL)
12578 return;
12580 todo = (int)d->dv_hashtab.ht_used;
12581 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12583 if (!HASHITEM_EMPTY(hi))
12585 --todo;
12586 di = HI2DI(hi);
12588 li = listitem_alloc();
12589 if (li == NULL)
12590 break;
12591 list_append(rettv->vval.v_list, li);
12593 if (what == 0)
12595 /* keys() */
12596 li->li_tv.v_type = VAR_STRING;
12597 li->li_tv.v_lock = 0;
12598 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12600 else if (what == 1)
12602 /* values() */
12603 copy_tv(&di->di_tv, &li->li_tv);
12605 else
12607 /* items() */
12608 l2 = list_alloc();
12609 li->li_tv.v_type = VAR_LIST;
12610 li->li_tv.v_lock = 0;
12611 li->li_tv.vval.v_list = l2;
12612 if (l2 == NULL)
12613 break;
12614 ++l2->lv_refcount;
12616 li2 = listitem_alloc();
12617 if (li2 == NULL)
12618 break;
12619 list_append(l2, li2);
12620 li2->li_tv.v_type = VAR_STRING;
12621 li2->li_tv.v_lock = 0;
12622 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12624 li2 = listitem_alloc();
12625 if (li2 == NULL)
12626 break;
12627 list_append(l2, li2);
12628 copy_tv(&di->di_tv, &li2->li_tv);
12635 * "items(dict)" function
12637 static void
12638 f_items(argvars, rettv)
12639 typval_T *argvars;
12640 typval_T *rettv;
12642 dict_list(argvars, rettv, 2);
12646 * "join()" function
12648 static void
12649 f_join(argvars, rettv)
12650 typval_T *argvars;
12651 typval_T *rettv;
12653 garray_T ga;
12654 char_u *sep;
12656 rettv->vval.v_number = 0;
12657 if (argvars[0].v_type != VAR_LIST)
12659 EMSG(_(e_listreq));
12660 return;
12662 if (argvars[0].vval.v_list == NULL)
12663 return;
12664 if (argvars[1].v_type == VAR_UNKNOWN)
12665 sep = (char_u *)" ";
12666 else
12667 sep = get_tv_string_chk(&argvars[1]);
12669 rettv->v_type = VAR_STRING;
12671 if (sep != NULL)
12673 ga_init2(&ga, (int)sizeof(char), 80);
12674 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12675 ga_append(&ga, NUL);
12676 rettv->vval.v_string = (char_u *)ga.ga_data;
12678 else
12679 rettv->vval.v_string = NULL;
12683 * "keys()" function
12685 static void
12686 f_keys(argvars, rettv)
12687 typval_T *argvars;
12688 typval_T *rettv;
12690 dict_list(argvars, rettv, 0);
12694 * "last_buffer_nr()" function.
12696 /*ARGSUSED*/
12697 static void
12698 f_last_buffer_nr(argvars, rettv)
12699 typval_T *argvars;
12700 typval_T *rettv;
12702 int n = 0;
12703 buf_T *buf;
12705 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12706 if (n < buf->b_fnum)
12707 n = buf->b_fnum;
12709 rettv->vval.v_number = n;
12713 * "len()" function
12715 static void
12716 f_len(argvars, rettv)
12717 typval_T *argvars;
12718 typval_T *rettv;
12720 switch (argvars[0].v_type)
12722 case VAR_STRING:
12723 case VAR_NUMBER:
12724 rettv->vval.v_number = (varnumber_T)STRLEN(
12725 get_tv_string(&argvars[0]));
12726 break;
12727 case VAR_LIST:
12728 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12729 break;
12730 case VAR_DICT:
12731 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12732 break;
12733 default:
12734 EMSG(_("E701: Invalid type for len()"));
12735 break;
12739 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12741 static void
12742 libcall_common(argvars, rettv, type)
12743 typval_T *argvars;
12744 typval_T *rettv;
12745 int type;
12747 #ifdef FEAT_LIBCALL
12748 char_u *string_in;
12749 char_u **string_result;
12750 int nr_result;
12751 #endif
12753 rettv->v_type = type;
12754 if (type == VAR_NUMBER)
12755 rettv->vval.v_number = 0;
12756 else
12757 rettv->vval.v_string = NULL;
12759 if (check_restricted() || check_secure())
12760 return;
12762 #ifdef FEAT_LIBCALL
12763 /* The first two args must be strings, otherwise its meaningless */
12764 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12766 string_in = NULL;
12767 if (argvars[2].v_type == VAR_STRING)
12768 string_in = argvars[2].vval.v_string;
12769 if (type == VAR_NUMBER)
12770 string_result = NULL;
12771 else
12772 string_result = &rettv->vval.v_string;
12773 if (mch_libcall(argvars[0].vval.v_string,
12774 argvars[1].vval.v_string,
12775 string_in,
12776 argvars[2].vval.v_number,
12777 string_result,
12778 &nr_result) == OK
12779 && type == VAR_NUMBER)
12780 rettv->vval.v_number = nr_result;
12782 #endif
12786 * "libcall()" function
12788 static void
12789 f_libcall(argvars, rettv)
12790 typval_T *argvars;
12791 typval_T *rettv;
12793 libcall_common(argvars, rettv, VAR_STRING);
12797 * "libcallnr()" function
12799 static void
12800 f_libcallnr(argvars, rettv)
12801 typval_T *argvars;
12802 typval_T *rettv;
12804 libcall_common(argvars, rettv, VAR_NUMBER);
12808 * "line(string)" function
12810 static void
12811 f_line(argvars, rettv)
12812 typval_T *argvars;
12813 typval_T *rettv;
12815 linenr_T lnum = 0;
12816 pos_T *fp;
12817 int fnum;
12819 fp = var2fpos(&argvars[0], TRUE, &fnum);
12820 if (fp != NULL)
12821 lnum = fp->lnum;
12822 rettv->vval.v_number = lnum;
12826 * "line2byte(lnum)" function
12828 /*ARGSUSED*/
12829 static void
12830 f_line2byte(argvars, rettv)
12831 typval_T *argvars;
12832 typval_T *rettv;
12834 #ifndef FEAT_BYTEOFF
12835 rettv->vval.v_number = -1;
12836 #else
12837 linenr_T lnum;
12839 lnum = get_tv_lnum(argvars);
12840 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12841 rettv->vval.v_number = -1;
12842 else
12843 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12844 if (rettv->vval.v_number >= 0)
12845 ++rettv->vval.v_number;
12846 #endif
12850 * "lispindent(lnum)" function
12852 static void
12853 f_lispindent(argvars, rettv)
12854 typval_T *argvars;
12855 typval_T *rettv;
12857 #ifdef FEAT_LISP
12858 pos_T pos;
12859 linenr_T lnum;
12861 pos = curwin->w_cursor;
12862 lnum = get_tv_lnum(argvars);
12863 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12865 curwin->w_cursor.lnum = lnum;
12866 rettv->vval.v_number = get_lisp_indent();
12867 curwin->w_cursor = pos;
12869 else
12870 #endif
12871 rettv->vval.v_number = -1;
12875 * "localtime()" function
12877 /*ARGSUSED*/
12878 static void
12879 f_localtime(argvars, rettv)
12880 typval_T *argvars;
12881 typval_T *rettv;
12883 rettv->vval.v_number = (varnumber_T)time(NULL);
12886 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12888 static void
12889 get_maparg(argvars, rettv, exact)
12890 typval_T *argvars;
12891 typval_T *rettv;
12892 int exact;
12894 char_u *keys;
12895 char_u *which;
12896 char_u buf[NUMBUFLEN];
12897 char_u *keys_buf = NULL;
12898 char_u *rhs;
12899 int mode;
12900 garray_T ga;
12901 int abbr = FALSE;
12903 /* return empty string for failure */
12904 rettv->v_type = VAR_STRING;
12905 rettv->vval.v_string = NULL;
12907 keys = get_tv_string(&argvars[0]);
12908 if (*keys == NUL)
12909 return;
12911 if (argvars[1].v_type != VAR_UNKNOWN)
12913 which = get_tv_string_buf_chk(&argvars[1], buf);
12914 if (argvars[2].v_type != VAR_UNKNOWN)
12915 abbr = get_tv_number(&argvars[2]);
12917 else
12918 which = (char_u *)"";
12919 if (which == NULL)
12920 return;
12922 mode = get_map_mode(&which, 0);
12924 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12925 rhs = check_map(keys, mode, exact, FALSE, abbr);
12926 vim_free(keys_buf);
12927 if (rhs != NULL)
12929 ga_init(&ga);
12930 ga.ga_itemsize = 1;
12931 ga.ga_growsize = 40;
12933 while (*rhs != NUL)
12934 ga_concat(&ga, str2special(&rhs, FALSE));
12936 ga_append(&ga, NUL);
12937 rettv->vval.v_string = (char_u *)ga.ga_data;
12941 #ifdef FEAT_FLOAT
12943 * "log10()" function
12945 static void
12946 f_log10(argvars, rettv)
12947 typval_T *argvars;
12948 typval_T *rettv;
12950 float_T f;
12952 rettv->v_type = VAR_FLOAT;
12953 if (get_float_arg(argvars, &f) == OK)
12954 rettv->vval.v_float = log10(f);
12955 else
12956 rettv->vval.v_float = 0.0;
12958 #endif
12961 * "map()" function
12963 static void
12964 f_map(argvars, rettv)
12965 typval_T *argvars;
12966 typval_T *rettv;
12968 filter_map(argvars, rettv, TRUE);
12972 * "maparg()" function
12974 static void
12975 f_maparg(argvars, rettv)
12976 typval_T *argvars;
12977 typval_T *rettv;
12979 get_maparg(argvars, rettv, TRUE);
12983 * "mapcheck()" function
12985 static void
12986 f_mapcheck(argvars, rettv)
12987 typval_T *argvars;
12988 typval_T *rettv;
12990 get_maparg(argvars, rettv, FALSE);
12993 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
12995 static void
12996 find_some_match(argvars, rettv, type)
12997 typval_T *argvars;
12998 typval_T *rettv;
12999 int type;
13001 char_u *str = NULL;
13002 char_u *expr = NULL;
13003 char_u *pat;
13004 regmatch_T regmatch;
13005 char_u patbuf[NUMBUFLEN];
13006 char_u strbuf[NUMBUFLEN];
13007 char_u *save_cpo;
13008 long start = 0;
13009 long nth = 1;
13010 colnr_T startcol = 0;
13011 int match = 0;
13012 list_T *l = NULL;
13013 listitem_T *li = NULL;
13014 long idx = 0;
13015 char_u *tofree = NULL;
13017 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13018 save_cpo = p_cpo;
13019 p_cpo = (char_u *)"";
13021 rettv->vval.v_number = -1;
13022 if (type == 3)
13024 /* return empty list when there are no matches */
13025 if (rettv_list_alloc(rettv) == FAIL)
13026 goto theend;
13028 else if (type == 2)
13030 rettv->v_type = VAR_STRING;
13031 rettv->vval.v_string = NULL;
13034 if (argvars[0].v_type == VAR_LIST)
13036 if ((l = argvars[0].vval.v_list) == NULL)
13037 goto theend;
13038 li = l->lv_first;
13040 else
13041 expr = str = get_tv_string(&argvars[0]);
13043 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13044 if (pat == NULL)
13045 goto theend;
13047 if (argvars[2].v_type != VAR_UNKNOWN)
13049 int error = FALSE;
13051 start = get_tv_number_chk(&argvars[2], &error);
13052 if (error)
13053 goto theend;
13054 if (l != NULL)
13056 li = list_find(l, start);
13057 if (li == NULL)
13058 goto theend;
13059 idx = l->lv_idx; /* use the cached index */
13061 else
13063 if (start < 0)
13064 start = 0;
13065 if (start > (long)STRLEN(str))
13066 goto theend;
13067 /* When "count" argument is there ignore matches before "start",
13068 * otherwise skip part of the string. Differs when pattern is "^"
13069 * or "\<". */
13070 if (argvars[3].v_type != VAR_UNKNOWN)
13071 startcol = start;
13072 else
13073 str += start;
13076 if (argvars[3].v_type != VAR_UNKNOWN)
13077 nth = get_tv_number_chk(&argvars[3], &error);
13078 if (error)
13079 goto theend;
13082 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13083 if (regmatch.regprog != NULL)
13085 regmatch.rm_ic = p_ic;
13087 for (;;)
13089 if (l != NULL)
13091 if (li == NULL)
13093 match = FALSE;
13094 break;
13096 vim_free(tofree);
13097 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13098 if (str == NULL)
13099 break;
13102 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13104 if (match && --nth <= 0)
13105 break;
13106 if (l == NULL && !match)
13107 break;
13109 /* Advance to just after the match. */
13110 if (l != NULL)
13112 li = li->li_next;
13113 ++idx;
13115 else
13117 #ifdef FEAT_MBYTE
13118 startcol = (colnr_T)(regmatch.startp[0]
13119 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13120 #else
13121 startcol = regmatch.startp[0] + 1 - str;
13122 #endif
13126 if (match)
13128 if (type == 3)
13130 int i;
13132 /* return list with matched string and submatches */
13133 for (i = 0; i < NSUBEXP; ++i)
13135 if (regmatch.endp[i] == NULL)
13137 if (list_append_string(rettv->vval.v_list,
13138 (char_u *)"", 0) == FAIL)
13139 break;
13141 else if (list_append_string(rettv->vval.v_list,
13142 regmatch.startp[i],
13143 (int)(regmatch.endp[i] - regmatch.startp[i]))
13144 == FAIL)
13145 break;
13148 else if (type == 2)
13150 /* return matched string */
13151 if (l != NULL)
13152 copy_tv(&li->li_tv, rettv);
13153 else
13154 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13155 (int)(regmatch.endp[0] - regmatch.startp[0]));
13157 else if (l != NULL)
13158 rettv->vval.v_number = idx;
13159 else
13161 if (type != 0)
13162 rettv->vval.v_number =
13163 (varnumber_T)(regmatch.startp[0] - str);
13164 else
13165 rettv->vval.v_number =
13166 (varnumber_T)(regmatch.endp[0] - str);
13167 rettv->vval.v_number += (varnumber_T)(str - expr);
13170 vim_free(regmatch.regprog);
13173 theend:
13174 vim_free(tofree);
13175 p_cpo = save_cpo;
13179 * "match()" function
13181 static void
13182 f_match(argvars, rettv)
13183 typval_T *argvars;
13184 typval_T *rettv;
13186 find_some_match(argvars, rettv, 1);
13190 * "matchadd()" function
13192 static void
13193 f_matchadd(argvars, rettv)
13194 typval_T *argvars;
13195 typval_T *rettv;
13197 #ifdef FEAT_SEARCH_EXTRA
13198 char_u buf[NUMBUFLEN];
13199 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13200 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13201 int prio = 10; /* default priority */
13202 int id = -1;
13203 int error = FALSE;
13205 rettv->vval.v_number = -1;
13207 if (grp == NULL || pat == NULL)
13208 return;
13209 if (argvars[2].v_type != VAR_UNKNOWN)
13211 prio = get_tv_number_chk(&argvars[2], &error);
13212 if (argvars[3].v_type != VAR_UNKNOWN)
13213 id = get_tv_number_chk(&argvars[3], &error);
13215 if (error == TRUE)
13216 return;
13217 if (id >= 1 && id <= 3)
13219 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13220 return;
13223 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13224 #endif
13228 * "matcharg()" function
13230 static void
13231 f_matcharg(argvars, rettv)
13232 typval_T *argvars;
13233 typval_T *rettv;
13235 if (rettv_list_alloc(rettv) == OK)
13237 #ifdef FEAT_SEARCH_EXTRA
13238 int id = get_tv_number(&argvars[0]);
13239 matchitem_T *m;
13241 if (id >= 1 && id <= 3)
13243 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13245 list_append_string(rettv->vval.v_list,
13246 syn_id2name(m->hlg_id), -1);
13247 list_append_string(rettv->vval.v_list, m->pattern, -1);
13249 else
13251 list_append_string(rettv->vval.v_list, NUL, -1);
13252 list_append_string(rettv->vval.v_list, NUL, -1);
13255 #endif
13260 * "matchdelete()" function
13262 static void
13263 f_matchdelete(argvars, rettv)
13264 typval_T *argvars;
13265 typval_T *rettv;
13267 #ifdef FEAT_SEARCH_EXTRA
13268 rettv->vval.v_number = match_delete(curwin,
13269 (int)get_tv_number(&argvars[0]), TRUE);
13270 #endif
13274 * "matchend()" function
13276 static void
13277 f_matchend(argvars, rettv)
13278 typval_T *argvars;
13279 typval_T *rettv;
13281 find_some_match(argvars, rettv, 0);
13285 * "matchlist()" function
13287 static void
13288 f_matchlist(argvars, rettv)
13289 typval_T *argvars;
13290 typval_T *rettv;
13292 find_some_match(argvars, rettv, 3);
13296 * "matchstr()" function
13298 static void
13299 f_matchstr(argvars, rettv)
13300 typval_T *argvars;
13301 typval_T *rettv;
13303 find_some_match(argvars, rettv, 2);
13306 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13308 static void
13309 max_min(argvars, rettv, domax)
13310 typval_T *argvars;
13311 typval_T *rettv;
13312 int domax;
13314 long n = 0;
13315 long i;
13316 int error = FALSE;
13318 if (argvars[0].v_type == VAR_LIST)
13320 list_T *l;
13321 listitem_T *li;
13323 l = argvars[0].vval.v_list;
13324 if (l != NULL)
13326 li = l->lv_first;
13327 if (li != NULL)
13329 n = get_tv_number_chk(&li->li_tv, &error);
13330 for (;;)
13332 li = li->li_next;
13333 if (li == NULL)
13334 break;
13335 i = get_tv_number_chk(&li->li_tv, &error);
13336 if (domax ? i > n : i < n)
13337 n = i;
13342 else if (argvars[0].v_type == VAR_DICT)
13344 dict_T *d;
13345 int first = TRUE;
13346 hashitem_T *hi;
13347 int todo;
13349 d = argvars[0].vval.v_dict;
13350 if (d != NULL)
13352 todo = (int)d->dv_hashtab.ht_used;
13353 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13355 if (!HASHITEM_EMPTY(hi))
13357 --todo;
13358 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13359 if (first)
13361 n = i;
13362 first = FALSE;
13364 else if (domax ? i > n : i < n)
13365 n = i;
13370 else
13371 EMSG(_(e_listdictarg));
13372 rettv->vval.v_number = error ? 0 : n;
13376 * "max()" function
13378 static void
13379 f_max(argvars, rettv)
13380 typval_T *argvars;
13381 typval_T *rettv;
13383 max_min(argvars, rettv, TRUE);
13387 * "min()" function
13389 static void
13390 f_min(argvars, rettv)
13391 typval_T *argvars;
13392 typval_T *rettv;
13394 max_min(argvars, rettv, FALSE);
13397 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13400 * Create the directory in which "dir" is located, and higher levels when
13401 * needed.
13403 static int
13404 mkdir_recurse(dir, prot)
13405 char_u *dir;
13406 int prot;
13408 char_u *p;
13409 char_u *updir;
13410 int r = FAIL;
13412 /* Get end of directory name in "dir".
13413 * We're done when it's "/" or "c:/". */
13414 p = gettail_sep(dir);
13415 if (p <= get_past_head(dir))
13416 return OK;
13418 /* If the directory exists we're done. Otherwise: create it.*/
13419 updir = vim_strnsave(dir, (int)(p - dir));
13420 if (updir == NULL)
13421 return FAIL;
13422 if (mch_isdir(updir))
13423 r = OK;
13424 else if (mkdir_recurse(updir, prot) == OK)
13425 r = vim_mkdir_emsg(updir, prot);
13426 vim_free(updir);
13427 return r;
13430 #ifdef vim_mkdir
13432 * "mkdir()" function
13434 static void
13435 f_mkdir(argvars, rettv)
13436 typval_T *argvars;
13437 typval_T *rettv;
13439 char_u *dir;
13440 char_u buf[NUMBUFLEN];
13441 int prot = 0755;
13443 rettv->vval.v_number = FAIL;
13444 if (check_restricted() || check_secure())
13445 return;
13447 dir = get_tv_string_buf(&argvars[0], buf);
13448 if (argvars[1].v_type != VAR_UNKNOWN)
13450 if (argvars[2].v_type != VAR_UNKNOWN)
13451 prot = get_tv_number_chk(&argvars[2], NULL);
13452 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13453 mkdir_recurse(dir, prot);
13455 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13457 #endif
13460 * "mode()" function
13462 /*ARGSUSED*/
13463 static void
13464 f_mode(argvars, rettv)
13465 typval_T *argvars;
13466 typval_T *rettv;
13468 char_u buf[3];
13470 buf[1] = NUL;
13471 buf[2] = NUL;
13473 #ifdef FEAT_VISUAL
13474 if (VIsual_active)
13476 if (VIsual_select)
13477 buf[0] = VIsual_mode + 's' - 'v';
13478 else
13479 buf[0] = VIsual_mode;
13481 else
13482 #endif
13483 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13484 || State == CONFIRM)
13486 buf[0] = 'r';
13487 if (State == ASKMORE)
13488 buf[1] = 'm';
13489 else if (State == CONFIRM)
13490 buf[1] = '?';
13492 else if (State == EXTERNCMD)
13493 buf[0] = '!';
13494 else if (State & INSERT)
13496 #ifdef FEAT_VREPLACE
13497 if (State & VREPLACE_FLAG)
13499 buf[0] = 'R';
13500 buf[1] = 'v';
13502 else
13503 #endif
13504 if (State & REPLACE_FLAG)
13505 buf[0] = 'R';
13506 else
13507 buf[0] = 'i';
13509 else if (State & CMDLINE)
13511 buf[0] = 'c';
13512 if (exmode_active)
13513 buf[1] = 'v';
13515 else if (exmode_active)
13517 buf[0] = 'c';
13518 buf[1] = 'e';
13520 else
13522 buf[0] = 'n';
13523 if (finish_op)
13524 buf[1] = 'o';
13527 /* Clear out the minor mode when the argument is not a non-zero number or
13528 * non-empty string. */
13529 if (!non_zero_arg(&argvars[0]))
13530 buf[1] = NUL;
13532 rettv->vval.v_string = vim_strsave(buf);
13533 rettv->v_type = VAR_STRING;
13537 * "nextnonblank()" function
13539 static void
13540 f_nextnonblank(argvars, rettv)
13541 typval_T *argvars;
13542 typval_T *rettv;
13544 linenr_T lnum;
13546 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13548 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13550 lnum = 0;
13551 break;
13553 if (*skipwhite(ml_get(lnum)) != NUL)
13554 break;
13556 rettv->vval.v_number = lnum;
13560 * "nr2char()" function
13562 static void
13563 f_nr2char(argvars, rettv)
13564 typval_T *argvars;
13565 typval_T *rettv;
13567 char_u buf[NUMBUFLEN];
13569 #ifdef FEAT_MBYTE
13570 if (has_mbyte)
13571 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13572 else
13573 #endif
13575 buf[0] = (char_u)get_tv_number(&argvars[0]);
13576 buf[1] = NUL;
13578 rettv->v_type = VAR_STRING;
13579 rettv->vval.v_string = vim_strsave(buf);
13583 * "pathshorten()" function
13585 static void
13586 f_pathshorten(argvars, rettv)
13587 typval_T *argvars;
13588 typval_T *rettv;
13590 char_u *p;
13592 rettv->v_type = VAR_STRING;
13593 p = get_tv_string_chk(&argvars[0]);
13594 if (p == NULL)
13595 rettv->vval.v_string = NULL;
13596 else
13598 p = vim_strsave(p);
13599 rettv->vval.v_string = p;
13600 if (p != NULL)
13601 shorten_dir(p);
13605 #ifdef FEAT_FLOAT
13607 * "pow()" function
13609 static void
13610 f_pow(argvars, rettv)
13611 typval_T *argvars;
13612 typval_T *rettv;
13614 float_T fx, fy;
13616 rettv->v_type = VAR_FLOAT;
13617 if (get_float_arg(argvars, &fx) == OK
13618 && get_float_arg(&argvars[1], &fy) == OK)
13619 rettv->vval.v_float = pow(fx, fy);
13620 else
13621 rettv->vval.v_float = 0.0;
13623 #endif
13626 * "prevnonblank()" function
13628 static void
13629 f_prevnonblank(argvars, rettv)
13630 typval_T *argvars;
13631 typval_T *rettv;
13633 linenr_T lnum;
13635 lnum = get_tv_lnum(argvars);
13636 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13637 lnum = 0;
13638 else
13639 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13640 --lnum;
13641 rettv->vval.v_number = lnum;
13644 #ifdef HAVE_STDARG_H
13645 /* This dummy va_list is here because:
13646 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13647 * - locally in the function results in a "used before set" warning
13648 * - using va_start() to initialize it gives "function with fixed args" error */
13649 static va_list ap;
13650 #endif
13653 * "printf()" function
13655 static void
13656 f_printf(argvars, rettv)
13657 typval_T *argvars;
13658 typval_T *rettv;
13660 rettv->v_type = VAR_STRING;
13661 rettv->vval.v_string = NULL;
13662 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13664 char_u buf[NUMBUFLEN];
13665 int len;
13666 char_u *s;
13667 int saved_did_emsg = did_emsg;
13668 char *fmt;
13670 /* Get the required length, allocate the buffer and do it for real. */
13671 did_emsg = FALSE;
13672 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13673 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13674 if (!did_emsg)
13676 s = alloc(len + 1);
13677 if (s != NULL)
13679 rettv->vval.v_string = s;
13680 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13683 did_emsg |= saved_did_emsg;
13685 #endif
13689 * "pumvisible()" function
13691 /*ARGSUSED*/
13692 static void
13693 f_pumvisible(argvars, rettv)
13694 typval_T *argvars;
13695 typval_T *rettv;
13697 rettv->vval.v_number = 0;
13698 #ifdef FEAT_INS_EXPAND
13699 if (pum_visible())
13700 rettv->vval.v_number = 1;
13701 #endif
13705 * "range()" function
13707 static void
13708 f_range(argvars, rettv)
13709 typval_T *argvars;
13710 typval_T *rettv;
13712 long start;
13713 long end;
13714 long stride = 1;
13715 long i;
13716 int error = FALSE;
13718 start = get_tv_number_chk(&argvars[0], &error);
13719 if (argvars[1].v_type == VAR_UNKNOWN)
13721 end = start - 1;
13722 start = 0;
13724 else
13726 end = get_tv_number_chk(&argvars[1], &error);
13727 if (argvars[2].v_type != VAR_UNKNOWN)
13728 stride = get_tv_number_chk(&argvars[2], &error);
13731 rettv->vval.v_number = 0;
13732 if (error)
13733 return; /* type error; errmsg already given */
13734 if (stride == 0)
13735 EMSG(_("E726: Stride is zero"));
13736 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13737 EMSG(_("E727: Start past end"));
13738 else
13740 if (rettv_list_alloc(rettv) == OK)
13741 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13742 if (list_append_number(rettv->vval.v_list,
13743 (varnumber_T)i) == FAIL)
13744 break;
13749 * "readfile()" function
13751 static void
13752 f_readfile(argvars, rettv)
13753 typval_T *argvars;
13754 typval_T *rettv;
13756 int binary = FALSE;
13757 char_u *fname;
13758 FILE *fd;
13759 listitem_T *li;
13760 #define FREAD_SIZE 200 /* optimized for text lines */
13761 char_u buf[FREAD_SIZE];
13762 int readlen; /* size of last fread() */
13763 int buflen; /* nr of valid chars in buf[] */
13764 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13765 int tolist; /* first byte in buf[] still to be put in list */
13766 int chop; /* how many CR to chop off */
13767 char_u *prev = NULL; /* previously read bytes, if any */
13768 int prevlen = 0; /* length of "prev" if not NULL */
13769 char_u *s;
13770 int len;
13771 long maxline = MAXLNUM;
13772 long cnt = 0;
13774 if (argvars[1].v_type != VAR_UNKNOWN)
13776 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13777 binary = TRUE;
13778 if (argvars[2].v_type != VAR_UNKNOWN)
13779 maxline = get_tv_number(&argvars[2]);
13782 if (rettv_list_alloc(rettv) == FAIL)
13783 return;
13785 /* Always open the file in binary mode, library functions have a mind of
13786 * their own about CR-LF conversion. */
13787 fname = get_tv_string(&argvars[0]);
13788 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13790 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13791 return;
13794 filtd = 0;
13795 while (cnt < maxline || maxline < 0)
13797 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13798 buflen = filtd + readlen;
13799 tolist = 0;
13800 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13802 if (buf[filtd] == '\n' || readlen <= 0)
13804 /* Only when in binary mode add an empty list item when the
13805 * last line ends in a '\n'. */
13806 if (!binary && readlen == 0 && filtd == 0)
13807 break;
13809 /* Found end-of-line or end-of-file: add a text line to the
13810 * list. */
13811 chop = 0;
13812 if (!binary)
13813 while (filtd - chop - 1 >= tolist
13814 && buf[filtd - chop - 1] == '\r')
13815 ++chop;
13816 len = filtd - tolist - chop;
13817 if (prev == NULL)
13818 s = vim_strnsave(buf + tolist, len);
13819 else
13821 s = alloc((unsigned)(prevlen + len + 1));
13822 if (s != NULL)
13824 mch_memmove(s, prev, prevlen);
13825 vim_free(prev);
13826 prev = NULL;
13827 mch_memmove(s + prevlen, buf + tolist, len);
13828 s[prevlen + len] = NUL;
13831 tolist = filtd + 1;
13833 li = listitem_alloc();
13834 if (li == NULL)
13836 vim_free(s);
13837 break;
13839 li->li_tv.v_type = VAR_STRING;
13840 li->li_tv.v_lock = 0;
13841 li->li_tv.vval.v_string = s;
13842 list_append(rettv->vval.v_list, li);
13844 if (++cnt >= maxline && maxline >= 0)
13845 break;
13846 if (readlen <= 0)
13847 break;
13849 else if (buf[filtd] == NUL)
13850 buf[filtd] = '\n';
13852 if (readlen <= 0)
13853 break;
13855 if (tolist == 0)
13857 /* "buf" is full, need to move text to an allocated buffer */
13858 if (prev == NULL)
13860 prev = vim_strnsave(buf, buflen);
13861 prevlen = buflen;
13863 else
13865 s = alloc((unsigned)(prevlen + buflen));
13866 if (s != NULL)
13868 mch_memmove(s, prev, prevlen);
13869 mch_memmove(s + prevlen, buf, buflen);
13870 vim_free(prev);
13871 prev = s;
13872 prevlen += buflen;
13875 filtd = 0;
13877 else
13879 mch_memmove(buf, buf + tolist, buflen - tolist);
13880 filtd -= tolist;
13885 * For a negative line count use only the lines at the end of the file,
13886 * free the rest.
13888 if (maxline < 0)
13889 while (cnt > -maxline)
13891 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13892 --cnt;
13895 vim_free(prev);
13896 fclose(fd);
13899 #if defined(FEAT_RELTIME)
13900 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13903 * Convert a List to proftime_T.
13904 * Return FAIL when there is something wrong.
13906 static int
13907 list2proftime(arg, tm)
13908 typval_T *arg;
13909 proftime_T *tm;
13911 long n1, n2;
13912 int error = FALSE;
13914 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13915 || arg->vval.v_list->lv_len != 2)
13916 return FAIL;
13917 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13918 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13919 # ifdef WIN3264
13920 tm->HighPart = n1;
13921 tm->LowPart = n2;
13922 # else
13923 tm->tv_sec = n1;
13924 tm->tv_usec = n2;
13925 # endif
13926 return error ? FAIL : OK;
13928 #endif /* FEAT_RELTIME */
13931 * "reltime()" function
13933 static void
13934 f_reltime(argvars, rettv)
13935 typval_T *argvars;
13936 typval_T *rettv;
13938 #ifdef FEAT_RELTIME
13939 proftime_T res;
13940 proftime_T start;
13942 if (argvars[0].v_type == VAR_UNKNOWN)
13944 /* No arguments: get current time. */
13945 profile_start(&res);
13947 else if (argvars[1].v_type == VAR_UNKNOWN)
13949 if (list2proftime(&argvars[0], &res) == FAIL)
13950 return;
13951 profile_end(&res);
13953 else
13955 /* Two arguments: compute the difference. */
13956 if (list2proftime(&argvars[0], &start) == FAIL
13957 || list2proftime(&argvars[1], &res) == FAIL)
13958 return;
13959 profile_sub(&res, &start);
13962 if (rettv_list_alloc(rettv) == OK)
13964 long n1, n2;
13966 # ifdef WIN3264
13967 n1 = res.HighPart;
13968 n2 = res.LowPart;
13969 # else
13970 n1 = res.tv_sec;
13971 n2 = res.tv_usec;
13972 # endif
13973 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
13974 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
13976 #endif
13980 * "reltimestr()" function
13982 static void
13983 f_reltimestr(argvars, rettv)
13984 typval_T *argvars;
13985 typval_T *rettv;
13987 #ifdef FEAT_RELTIME
13988 proftime_T tm;
13989 #endif
13991 rettv->v_type = VAR_STRING;
13992 rettv->vval.v_string = NULL;
13993 #ifdef FEAT_RELTIME
13994 if (list2proftime(&argvars[0], &tm) == OK)
13995 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
13996 #endif
13999 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14000 static void make_connection __ARGS((void));
14001 static int check_connection __ARGS((void));
14003 static void
14004 make_connection()
14006 if (X_DISPLAY == NULL
14007 # ifdef FEAT_GUI
14008 && !gui.in_use
14009 # endif
14012 x_force_connect = TRUE;
14013 setup_term_clip();
14014 x_force_connect = FALSE;
14018 static int
14019 check_connection()
14021 make_connection();
14022 if (X_DISPLAY == NULL)
14024 EMSG(_("E240: No connection to Vim server"));
14025 return FAIL;
14027 return OK;
14029 #endif
14031 #ifdef FEAT_CLIENTSERVER
14032 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14034 static void
14035 remote_common(argvars, rettv, expr)
14036 typval_T *argvars;
14037 typval_T *rettv;
14038 int expr;
14040 char_u *server_name;
14041 char_u *keys;
14042 char_u *r = NULL;
14043 char_u buf[NUMBUFLEN];
14044 # ifdef WIN32
14045 HWND w;
14046 # elif defined(FEAT_X11)
14047 Window w;
14048 # elif defined(MAC_CLIENTSERVER)
14049 int w; // This is the port number ('w' is a bit confusing)
14050 # endif
14052 if (check_restricted() || check_secure())
14053 return;
14055 # ifdef FEAT_X11
14056 if (check_connection() == FAIL)
14057 return;
14058 # endif
14060 server_name = get_tv_string_chk(&argvars[0]);
14061 if (server_name == NULL)
14062 return; /* type error; errmsg already given */
14063 keys = get_tv_string_buf(&argvars[1], buf);
14064 # ifdef WIN32
14065 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14066 # elif defined(FEAT_X11)
14067 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14068 < 0)
14069 # elif defined(MAC_CLIENTSERVER)
14070 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14071 # endif
14073 if (r != NULL)
14074 EMSG(r); /* sending worked but evaluation failed */
14075 else
14076 EMSG2(_("E241: Unable to send to %s"), server_name);
14077 return;
14080 rettv->vval.v_string = r;
14082 if (argvars[2].v_type != VAR_UNKNOWN)
14084 dictitem_T v;
14085 char_u str[30];
14086 char_u *idvar;
14088 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14089 v.di_tv.v_type = VAR_STRING;
14090 v.di_tv.vval.v_string = vim_strsave(str);
14091 idvar = get_tv_string_chk(&argvars[2]);
14092 if (idvar != NULL)
14093 set_var(idvar, &v.di_tv, FALSE);
14094 vim_free(v.di_tv.vval.v_string);
14097 #endif
14100 * "remote_expr()" function
14102 /*ARGSUSED*/
14103 static void
14104 f_remote_expr(argvars, rettv)
14105 typval_T *argvars;
14106 typval_T *rettv;
14108 rettv->v_type = VAR_STRING;
14109 rettv->vval.v_string = NULL;
14110 #ifdef FEAT_CLIENTSERVER
14111 remote_common(argvars, rettv, TRUE);
14112 #endif
14116 * "remote_foreground()" function
14118 /*ARGSUSED*/
14119 static void
14120 f_remote_foreground(argvars, rettv)
14121 typval_T *argvars;
14122 typval_T *rettv;
14124 rettv->vval.v_number = 0;
14125 #ifdef FEAT_CLIENTSERVER
14126 # ifdef WIN32
14127 /* On Win32 it's done in this application. */
14129 char_u *server_name = get_tv_string_chk(&argvars[0]);
14131 if (server_name != NULL)
14132 serverForeground(server_name);
14134 # elif defined(FEAT_X11) || defined(MAC_CLIENTSERVER)
14135 /* Send a foreground() expression to the server. */
14136 argvars[1].v_type = VAR_STRING;
14137 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14138 argvars[2].v_type = VAR_UNKNOWN;
14139 remote_common(argvars, rettv, TRUE);
14140 vim_free(argvars[1].vval.v_string);
14141 # endif
14142 #endif
14145 /*ARGSUSED*/
14146 static void
14147 f_remote_peek(argvars, rettv)
14148 typval_T *argvars;
14149 typval_T *rettv;
14151 #ifdef FEAT_CLIENTSERVER
14152 dictitem_T v;
14153 char_u *s = NULL;
14154 # ifdef WIN32
14155 long_u n = 0;
14156 # endif
14157 char_u *serverid;
14159 if (check_restricted() || check_secure())
14161 rettv->vval.v_number = -1;
14162 return;
14164 serverid = get_tv_string_chk(&argvars[0]);
14165 if (serverid == NULL)
14167 rettv->vval.v_number = -1;
14168 return; /* type error; errmsg already given */
14170 # ifdef WIN32
14171 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14172 if (n == 0)
14173 rettv->vval.v_number = -1;
14174 else
14176 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14177 rettv->vval.v_number = (s != NULL);
14179 # elif defined(FEAT_X11)
14180 rettv->vval.v_number = 0;
14181 if (check_connection() == FAIL)
14182 return;
14184 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14185 serverStrToWin(serverid), &s);
14186 # elif defined(MAC_CLIENTSERVER)
14187 rettv->vval.v_number = serverPeekReply(serverStrToPort(serverid), &s);
14188 # endif
14190 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14192 char_u *retvar;
14194 v.di_tv.v_type = VAR_STRING;
14195 v.di_tv.vval.v_string = vim_strsave(s);
14196 retvar = get_tv_string_chk(&argvars[1]);
14197 if (retvar != NULL)
14198 set_var(retvar, &v.di_tv, FALSE);
14199 vim_free(v.di_tv.vval.v_string);
14201 #else
14202 rettv->vval.v_number = -1;
14203 #endif
14206 /*ARGSUSED*/
14207 static void
14208 f_remote_read(argvars, rettv)
14209 typval_T *argvars;
14210 typval_T *rettv;
14212 char_u *r = NULL;
14214 #ifdef FEAT_CLIENTSERVER
14215 char_u *serverid = get_tv_string_chk(&argvars[0]);
14217 if (serverid != NULL && !check_restricted() && !check_secure())
14219 # ifdef WIN32
14220 /* The server's HWND is encoded in the 'id' parameter */
14221 long_u n = 0;
14223 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14224 if (n != 0)
14225 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14226 if (r == NULL)
14227 # elif defined(FEAT_X11)
14228 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14229 serverStrToWin(serverid), &r, FALSE) < 0)
14230 # elif defined(MAC_CLIENTSERVER)
14231 if (serverReadReply(serverStrToPort(serverid), &r) < 0)
14232 # endif
14233 EMSG(_("E277: Unable to read a server reply"));
14235 #endif
14236 rettv->v_type = VAR_STRING;
14237 rettv->vval.v_string = r;
14241 * "remote_send()" function
14243 /*ARGSUSED*/
14244 static void
14245 f_remote_send(argvars, rettv)
14246 typval_T *argvars;
14247 typval_T *rettv;
14249 rettv->v_type = VAR_STRING;
14250 rettv->vval.v_string = NULL;
14251 #ifdef FEAT_CLIENTSERVER
14252 remote_common(argvars, rettv, FALSE);
14253 #endif
14257 * "remove()" function
14259 static void
14260 f_remove(argvars, rettv)
14261 typval_T *argvars;
14262 typval_T *rettv;
14264 list_T *l;
14265 listitem_T *item, *item2;
14266 listitem_T *li;
14267 long idx;
14268 long end;
14269 char_u *key;
14270 dict_T *d;
14271 dictitem_T *di;
14273 rettv->vval.v_number = 0;
14274 if (argvars[0].v_type == VAR_DICT)
14276 if (argvars[2].v_type != VAR_UNKNOWN)
14277 EMSG2(_(e_toomanyarg), "remove()");
14278 else if ((d = argvars[0].vval.v_dict) != NULL
14279 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14281 key = get_tv_string_chk(&argvars[1]);
14282 if (key != NULL)
14284 di = dict_find(d, key, -1);
14285 if (di == NULL)
14286 EMSG2(_(e_dictkey), key);
14287 else
14289 *rettv = di->di_tv;
14290 init_tv(&di->di_tv);
14291 dictitem_remove(d, di);
14296 else if (argvars[0].v_type != VAR_LIST)
14297 EMSG2(_(e_listdictarg), "remove()");
14298 else if ((l = argvars[0].vval.v_list) != NULL
14299 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14301 int error = FALSE;
14303 idx = get_tv_number_chk(&argvars[1], &error);
14304 if (error)
14305 ; /* type error: do nothing, errmsg already given */
14306 else if ((item = list_find(l, idx)) == NULL)
14307 EMSGN(_(e_listidx), idx);
14308 else
14310 if (argvars[2].v_type == VAR_UNKNOWN)
14312 /* Remove one item, return its value. */
14313 list_remove(l, item, item);
14314 *rettv = item->li_tv;
14315 vim_free(item);
14317 else
14319 /* Remove range of items, return list with values. */
14320 end = get_tv_number_chk(&argvars[2], &error);
14321 if (error)
14322 ; /* type error: do nothing */
14323 else if ((item2 = list_find(l, end)) == NULL)
14324 EMSGN(_(e_listidx), end);
14325 else
14327 int cnt = 0;
14329 for (li = item; li != NULL; li = li->li_next)
14331 ++cnt;
14332 if (li == item2)
14333 break;
14335 if (li == NULL) /* didn't find "item2" after "item" */
14336 EMSG(_(e_invrange));
14337 else
14339 list_remove(l, item, item2);
14340 if (rettv_list_alloc(rettv) == OK)
14342 l = rettv->vval.v_list;
14343 l->lv_first = item;
14344 l->lv_last = item2;
14345 item->li_prev = NULL;
14346 item2->li_next = NULL;
14347 l->lv_len = cnt;
14357 * "rename({from}, {to})" function
14359 static void
14360 f_rename(argvars, rettv)
14361 typval_T *argvars;
14362 typval_T *rettv;
14364 char_u buf[NUMBUFLEN];
14366 if (check_restricted() || check_secure())
14367 rettv->vval.v_number = -1;
14368 else
14369 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14370 get_tv_string_buf(&argvars[1], buf));
14374 * "repeat()" function
14376 /*ARGSUSED*/
14377 static void
14378 f_repeat(argvars, rettv)
14379 typval_T *argvars;
14380 typval_T *rettv;
14382 char_u *p;
14383 int n;
14384 int slen;
14385 int len;
14386 char_u *r;
14387 int i;
14389 n = get_tv_number(&argvars[1]);
14390 if (argvars[0].v_type == VAR_LIST)
14392 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14393 while (n-- > 0)
14394 if (list_extend(rettv->vval.v_list,
14395 argvars[0].vval.v_list, NULL) == FAIL)
14396 break;
14398 else
14400 p = get_tv_string(&argvars[0]);
14401 rettv->v_type = VAR_STRING;
14402 rettv->vval.v_string = NULL;
14404 slen = (int)STRLEN(p);
14405 len = slen * n;
14406 if (len <= 0)
14407 return;
14409 r = alloc(len + 1);
14410 if (r != NULL)
14412 for (i = 0; i < n; i++)
14413 mch_memmove(r + i * slen, p, (size_t)slen);
14414 r[len] = NUL;
14417 rettv->vval.v_string = r;
14422 * "resolve()" function
14424 static void
14425 f_resolve(argvars, rettv)
14426 typval_T *argvars;
14427 typval_T *rettv;
14429 char_u *p;
14431 p = get_tv_string(&argvars[0]);
14432 #ifdef FEAT_SHORTCUT
14434 char_u *v = NULL;
14436 v = mch_resolve_shortcut(p);
14437 if (v != NULL)
14438 rettv->vval.v_string = v;
14439 else
14440 rettv->vval.v_string = vim_strsave(p);
14442 #else
14443 # ifdef HAVE_READLINK
14445 char_u buf[MAXPATHL + 1];
14446 char_u *cpy;
14447 int len;
14448 char_u *remain = NULL;
14449 char_u *q;
14450 int is_relative_to_current = FALSE;
14451 int has_trailing_pathsep = FALSE;
14452 int limit = 100;
14454 p = vim_strsave(p);
14456 if (p[0] == '.' && (vim_ispathsep(p[1])
14457 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14458 is_relative_to_current = TRUE;
14460 len = STRLEN(p);
14461 if (len > 0 && after_pathsep(p, p + len))
14462 has_trailing_pathsep = TRUE;
14464 q = getnextcomp(p);
14465 if (*q != NUL)
14467 /* Separate the first path component in "p", and keep the
14468 * remainder (beginning with the path separator). */
14469 remain = vim_strsave(q - 1);
14470 q[-1] = NUL;
14473 for (;;)
14475 for (;;)
14477 len = readlink((char *)p, (char *)buf, MAXPATHL);
14478 if (len <= 0)
14479 break;
14480 buf[len] = NUL;
14482 if (limit-- == 0)
14484 vim_free(p);
14485 vim_free(remain);
14486 EMSG(_("E655: Too many symbolic links (cycle?)"));
14487 rettv->vval.v_string = NULL;
14488 goto fail;
14491 /* Ensure that the result will have a trailing path separator
14492 * if the argument has one. */
14493 if (remain == NULL && has_trailing_pathsep)
14494 add_pathsep(buf);
14496 /* Separate the first path component in the link value and
14497 * concatenate the remainders. */
14498 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14499 if (*q != NUL)
14501 if (remain == NULL)
14502 remain = vim_strsave(q - 1);
14503 else
14505 cpy = concat_str(q - 1, remain);
14506 if (cpy != NULL)
14508 vim_free(remain);
14509 remain = cpy;
14512 q[-1] = NUL;
14515 q = gettail(p);
14516 if (q > p && *q == NUL)
14518 /* Ignore trailing path separator. */
14519 q[-1] = NUL;
14520 q = gettail(p);
14522 if (q > p && !mch_isFullName(buf))
14524 /* symlink is relative to directory of argument */
14525 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14526 if (cpy != NULL)
14528 STRCPY(cpy, p);
14529 STRCPY(gettail(cpy), buf);
14530 vim_free(p);
14531 p = cpy;
14534 else
14536 vim_free(p);
14537 p = vim_strsave(buf);
14541 if (remain == NULL)
14542 break;
14544 /* Append the first path component of "remain" to "p". */
14545 q = getnextcomp(remain + 1);
14546 len = q - remain - (*q != NUL);
14547 cpy = vim_strnsave(p, STRLEN(p) + len);
14548 if (cpy != NULL)
14550 STRNCAT(cpy, remain, len);
14551 vim_free(p);
14552 p = cpy;
14554 /* Shorten "remain". */
14555 if (*q != NUL)
14556 STRMOVE(remain, q - 1);
14557 else
14559 vim_free(remain);
14560 remain = NULL;
14564 /* If the result is a relative path name, make it explicitly relative to
14565 * the current directory if and only if the argument had this form. */
14566 if (!vim_ispathsep(*p))
14568 if (is_relative_to_current
14569 && *p != NUL
14570 && !(p[0] == '.'
14571 && (p[1] == NUL
14572 || vim_ispathsep(p[1])
14573 || (p[1] == '.'
14574 && (p[2] == NUL
14575 || vim_ispathsep(p[2]))))))
14577 /* Prepend "./". */
14578 cpy = concat_str((char_u *)"./", p);
14579 if (cpy != NULL)
14581 vim_free(p);
14582 p = cpy;
14585 else if (!is_relative_to_current)
14587 /* Strip leading "./". */
14588 q = p;
14589 while (q[0] == '.' && vim_ispathsep(q[1]))
14590 q += 2;
14591 if (q > p)
14592 STRMOVE(p, p + 2);
14596 /* Ensure that the result will have no trailing path separator
14597 * if the argument had none. But keep "/" or "//". */
14598 if (!has_trailing_pathsep)
14600 q = p + STRLEN(p);
14601 if (after_pathsep(p, q))
14602 *gettail_sep(p) = NUL;
14605 rettv->vval.v_string = p;
14607 # else
14608 rettv->vval.v_string = vim_strsave(p);
14609 # endif
14610 #endif
14612 simplify_filename(rettv->vval.v_string);
14614 #ifdef HAVE_READLINK
14615 fail:
14616 #endif
14617 rettv->v_type = VAR_STRING;
14621 * "reverse({list})" function
14623 static void
14624 f_reverse(argvars, rettv)
14625 typval_T *argvars;
14626 typval_T *rettv;
14628 list_T *l;
14629 listitem_T *li, *ni;
14631 rettv->vval.v_number = 0;
14632 if (argvars[0].v_type != VAR_LIST)
14633 EMSG2(_(e_listarg), "reverse()");
14634 else if ((l = argvars[0].vval.v_list) != NULL
14635 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14637 li = l->lv_last;
14638 l->lv_first = l->lv_last = NULL;
14639 l->lv_len = 0;
14640 while (li != NULL)
14642 ni = li->li_prev;
14643 list_append(l, li);
14644 li = ni;
14646 rettv->vval.v_list = l;
14647 rettv->v_type = VAR_LIST;
14648 ++l->lv_refcount;
14649 l->lv_idx = l->lv_len - l->lv_idx - 1;
14653 #define SP_NOMOVE 0x01 /* don't move cursor */
14654 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14655 #define SP_RETCOUNT 0x04 /* return matchcount */
14656 #define SP_SETPCMARK 0x08 /* set previous context mark */
14657 #define SP_START 0x10 /* accept match at start position */
14658 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14659 #define SP_END 0x40 /* leave cursor at end of match */
14661 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14664 * Get flags for a search function.
14665 * Possibly sets "p_ws".
14666 * Returns BACKWARD, FORWARD or zero (for an error).
14668 static int
14669 get_search_arg(varp, flagsp)
14670 typval_T *varp;
14671 int *flagsp;
14673 int dir = FORWARD;
14674 char_u *flags;
14675 char_u nbuf[NUMBUFLEN];
14676 int mask;
14678 if (varp->v_type != VAR_UNKNOWN)
14680 flags = get_tv_string_buf_chk(varp, nbuf);
14681 if (flags == NULL)
14682 return 0; /* type error; errmsg already given */
14683 while (*flags != NUL)
14685 switch (*flags)
14687 case 'b': dir = BACKWARD; break;
14688 case 'w': p_ws = TRUE; break;
14689 case 'W': p_ws = FALSE; break;
14690 default: mask = 0;
14691 if (flagsp != NULL)
14692 switch (*flags)
14694 case 'c': mask = SP_START; break;
14695 case 'e': mask = SP_END; break;
14696 case 'm': mask = SP_RETCOUNT; break;
14697 case 'n': mask = SP_NOMOVE; break;
14698 case 'p': mask = SP_SUBPAT; break;
14699 case 'r': mask = SP_REPEAT; break;
14700 case 's': mask = SP_SETPCMARK; break;
14702 if (mask == 0)
14704 EMSG2(_(e_invarg2), flags);
14705 dir = 0;
14707 else
14708 *flagsp |= mask;
14710 if (dir == 0)
14711 break;
14712 ++flags;
14715 return dir;
14719 * Shared by search() and searchpos() functions
14721 static int
14722 search_cmn(argvars, match_pos, flagsp)
14723 typval_T *argvars;
14724 pos_T *match_pos;
14725 int *flagsp;
14727 int flags;
14728 char_u *pat;
14729 pos_T pos;
14730 pos_T save_cursor;
14731 int save_p_ws = p_ws;
14732 int dir;
14733 int retval = 0; /* default: FAIL */
14734 long lnum_stop = 0;
14735 proftime_T tm;
14736 #ifdef FEAT_RELTIME
14737 long time_limit = 0;
14738 #endif
14739 int options = SEARCH_KEEP;
14740 int subpatnum;
14742 pat = get_tv_string(&argvars[0]);
14743 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14744 if (dir == 0)
14745 goto theend;
14746 flags = *flagsp;
14747 if (flags & SP_START)
14748 options |= SEARCH_START;
14749 if (flags & SP_END)
14750 options |= SEARCH_END;
14752 /* Optional arguments: line number to stop searching and timeout. */
14753 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14755 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14756 if (lnum_stop < 0)
14757 goto theend;
14758 #ifdef FEAT_RELTIME
14759 if (argvars[3].v_type != VAR_UNKNOWN)
14761 time_limit = get_tv_number_chk(&argvars[3], NULL);
14762 if (time_limit < 0)
14763 goto theend;
14765 #endif
14768 #ifdef FEAT_RELTIME
14769 /* Set the time limit, if there is one. */
14770 profile_setlimit(time_limit, &tm);
14771 #endif
14774 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14775 * Check to make sure only those flags are set.
14776 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14777 * flags cannot be set. Check for that condition also.
14779 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14780 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14782 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14783 goto theend;
14786 pos = save_cursor = curwin->w_cursor;
14787 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14788 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14789 if (subpatnum != FAIL)
14791 if (flags & SP_SUBPAT)
14792 retval = subpatnum;
14793 else
14794 retval = pos.lnum;
14795 if (flags & SP_SETPCMARK)
14796 setpcmark();
14797 curwin->w_cursor = pos;
14798 if (match_pos != NULL)
14800 /* Store the match cursor position */
14801 match_pos->lnum = pos.lnum;
14802 match_pos->col = pos.col + 1;
14804 /* "/$" will put the cursor after the end of the line, may need to
14805 * correct that here */
14806 check_cursor();
14809 /* If 'n' flag is used: restore cursor position. */
14810 if (flags & SP_NOMOVE)
14811 curwin->w_cursor = save_cursor;
14812 else
14813 curwin->w_set_curswant = TRUE;
14814 theend:
14815 p_ws = save_p_ws;
14817 return retval;
14820 #ifdef FEAT_FLOAT
14822 * "round({float})" function
14824 static void
14825 f_round(argvars, rettv)
14826 typval_T *argvars;
14827 typval_T *rettv;
14829 float_T f;
14831 rettv->v_type = VAR_FLOAT;
14832 if (get_float_arg(argvars, &f) == OK)
14833 /* round() is not in C90, use ceil() or floor() instead. */
14834 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14835 else
14836 rettv->vval.v_float = 0.0;
14838 #endif
14841 * "search()" function
14843 static void
14844 f_search(argvars, rettv)
14845 typval_T *argvars;
14846 typval_T *rettv;
14848 int flags = 0;
14850 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14854 * "searchdecl()" function
14856 static void
14857 f_searchdecl(argvars, rettv)
14858 typval_T *argvars;
14859 typval_T *rettv;
14861 int locally = 1;
14862 int thisblock = 0;
14863 int error = FALSE;
14864 char_u *name;
14866 rettv->vval.v_number = 1; /* default: FAIL */
14868 name = get_tv_string_chk(&argvars[0]);
14869 if (argvars[1].v_type != VAR_UNKNOWN)
14871 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14872 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14873 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14875 if (!error && name != NULL)
14876 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14877 locally, thisblock, SEARCH_KEEP) == FAIL;
14881 * Used by searchpair() and searchpairpos()
14883 static int
14884 searchpair_cmn(argvars, match_pos)
14885 typval_T *argvars;
14886 pos_T *match_pos;
14888 char_u *spat, *mpat, *epat;
14889 char_u *skip;
14890 int save_p_ws = p_ws;
14891 int dir;
14892 int flags = 0;
14893 char_u nbuf1[NUMBUFLEN];
14894 char_u nbuf2[NUMBUFLEN];
14895 char_u nbuf3[NUMBUFLEN];
14896 int retval = 0; /* default: FAIL */
14897 long lnum_stop = 0;
14898 long time_limit = 0;
14900 /* Get the three pattern arguments: start, middle, end. */
14901 spat = get_tv_string_chk(&argvars[0]);
14902 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14903 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14904 if (spat == NULL || mpat == NULL || epat == NULL)
14905 goto theend; /* type error */
14907 /* Handle the optional fourth argument: flags */
14908 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14909 if (dir == 0)
14910 goto theend;
14912 /* Don't accept SP_END or SP_SUBPAT.
14913 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14915 if ((flags & (SP_END | SP_SUBPAT)) != 0
14916 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14918 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14919 goto theend;
14922 /* Using 'r' implies 'W', otherwise it doesn't work. */
14923 if (flags & SP_REPEAT)
14924 p_ws = FALSE;
14926 /* Optional fifth argument: skip expression */
14927 if (argvars[3].v_type == VAR_UNKNOWN
14928 || argvars[4].v_type == VAR_UNKNOWN)
14929 skip = (char_u *)"";
14930 else
14932 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14933 if (argvars[5].v_type != VAR_UNKNOWN)
14935 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
14936 if (lnum_stop < 0)
14937 goto theend;
14938 #ifdef FEAT_RELTIME
14939 if (argvars[6].v_type != VAR_UNKNOWN)
14941 time_limit = get_tv_number_chk(&argvars[6], NULL);
14942 if (time_limit < 0)
14943 goto theend;
14945 #endif
14948 if (skip == NULL)
14949 goto theend; /* type error */
14951 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
14952 match_pos, lnum_stop, time_limit);
14954 theend:
14955 p_ws = save_p_ws;
14957 return retval;
14961 * "searchpair()" function
14963 static void
14964 f_searchpair(argvars, rettv)
14965 typval_T *argvars;
14966 typval_T *rettv;
14968 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
14972 * "searchpairpos()" function
14974 static void
14975 f_searchpairpos(argvars, rettv)
14976 typval_T *argvars;
14977 typval_T *rettv;
14979 pos_T match_pos;
14980 int lnum = 0;
14981 int col = 0;
14983 rettv->vval.v_number = 0;
14985 if (rettv_list_alloc(rettv) == FAIL)
14986 return;
14988 if (searchpair_cmn(argvars, &match_pos) > 0)
14990 lnum = match_pos.lnum;
14991 col = match_pos.col;
14994 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
14995 list_append_number(rettv->vval.v_list, (varnumber_T)col);
14999 * Search for a start/middle/end thing.
15000 * Used by searchpair(), see its documentation for the details.
15001 * Returns 0 or -1 for no match,
15003 long
15004 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15005 lnum_stop, time_limit)
15006 char_u *spat; /* start pattern */
15007 char_u *mpat; /* middle pattern */
15008 char_u *epat; /* end pattern */
15009 int dir; /* BACKWARD or FORWARD */
15010 char_u *skip; /* skip expression */
15011 int flags; /* SP_SETPCMARK and other SP_ values */
15012 pos_T *match_pos;
15013 linenr_T lnum_stop; /* stop at this line if not zero */
15014 long time_limit; /* stop after this many msec */
15016 char_u *save_cpo;
15017 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15018 long retval = 0;
15019 pos_T pos;
15020 pos_T firstpos;
15021 pos_T foundpos;
15022 pos_T save_cursor;
15023 pos_T save_pos;
15024 int n;
15025 int r;
15026 int nest = 1;
15027 int err;
15028 int options = SEARCH_KEEP;
15029 proftime_T tm;
15031 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15032 save_cpo = p_cpo;
15033 p_cpo = empty_option;
15035 #ifdef FEAT_RELTIME
15036 /* Set the time limit, if there is one. */
15037 profile_setlimit(time_limit, &tm);
15038 #endif
15040 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15041 * start/middle/end (pat3, for the top pair). */
15042 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15043 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15044 if (pat2 == NULL || pat3 == NULL)
15045 goto theend;
15046 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15047 if (*mpat == NUL)
15048 STRCPY(pat3, pat2);
15049 else
15050 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15051 spat, epat, mpat);
15052 if (flags & SP_START)
15053 options |= SEARCH_START;
15055 save_cursor = curwin->w_cursor;
15056 pos = curwin->w_cursor;
15057 clearpos(&firstpos);
15058 clearpos(&foundpos);
15059 pat = pat3;
15060 for (;;)
15062 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15063 options, RE_SEARCH, lnum_stop, &tm);
15064 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15065 /* didn't find it or found the first match again: FAIL */
15066 break;
15068 if (firstpos.lnum == 0)
15069 firstpos = pos;
15070 if (equalpos(pos, foundpos))
15072 /* Found the same position again. Can happen with a pattern that
15073 * has "\zs" at the end and searching backwards. Advance one
15074 * character and try again. */
15075 if (dir == BACKWARD)
15076 decl(&pos);
15077 else
15078 incl(&pos);
15080 foundpos = pos;
15082 /* clear the start flag to avoid getting stuck here */
15083 options &= ~SEARCH_START;
15085 /* If the skip pattern matches, ignore this match. */
15086 if (*skip != NUL)
15088 save_pos = curwin->w_cursor;
15089 curwin->w_cursor = pos;
15090 r = eval_to_bool(skip, &err, NULL, FALSE);
15091 curwin->w_cursor = save_pos;
15092 if (err)
15094 /* Evaluating {skip} caused an error, break here. */
15095 curwin->w_cursor = save_cursor;
15096 retval = -1;
15097 break;
15099 if (r)
15100 continue;
15103 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15105 /* Found end when searching backwards or start when searching
15106 * forward: nested pair. */
15107 ++nest;
15108 pat = pat2; /* nested, don't search for middle */
15110 else
15112 /* Found end when searching forward or start when searching
15113 * backward: end of (nested) pair; or found middle in outer pair. */
15114 if (--nest == 1)
15115 pat = pat3; /* outer level, search for middle */
15118 if (nest == 0)
15120 /* Found the match: return matchcount or line number. */
15121 if (flags & SP_RETCOUNT)
15122 ++retval;
15123 else
15124 retval = pos.lnum;
15125 if (flags & SP_SETPCMARK)
15126 setpcmark();
15127 curwin->w_cursor = pos;
15128 if (!(flags & SP_REPEAT))
15129 break;
15130 nest = 1; /* search for next unmatched */
15134 if (match_pos != NULL)
15136 /* Store the match cursor position */
15137 match_pos->lnum = curwin->w_cursor.lnum;
15138 match_pos->col = curwin->w_cursor.col + 1;
15141 /* If 'n' flag is used or search failed: restore cursor position. */
15142 if ((flags & SP_NOMOVE) || retval == 0)
15143 curwin->w_cursor = save_cursor;
15145 theend:
15146 vim_free(pat2);
15147 vim_free(pat3);
15148 if (p_cpo == empty_option)
15149 p_cpo = save_cpo;
15150 else
15151 /* Darn, evaluating the {skip} expression changed the value. */
15152 free_string_option(save_cpo);
15154 return retval;
15158 * "searchpos()" function
15160 static void
15161 f_searchpos(argvars, rettv)
15162 typval_T *argvars;
15163 typval_T *rettv;
15165 pos_T match_pos;
15166 int lnum = 0;
15167 int col = 0;
15168 int n;
15169 int flags = 0;
15171 rettv->vval.v_number = 0;
15173 if (rettv_list_alloc(rettv) == FAIL)
15174 return;
15176 n = search_cmn(argvars, &match_pos, &flags);
15177 if (n > 0)
15179 lnum = match_pos.lnum;
15180 col = match_pos.col;
15183 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15184 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15185 if (flags & SP_SUBPAT)
15186 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15190 /*ARGSUSED*/
15191 static void
15192 f_server2client(argvars, rettv)
15193 typval_T *argvars;
15194 typval_T *rettv;
15196 #ifdef FEAT_CLIENTSERVER
15197 char_u buf[NUMBUFLEN];
15198 char_u *server = get_tv_string_chk(&argvars[0]);
15199 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15201 rettv->vval.v_number = -1;
15202 if (server == NULL || reply == NULL)
15203 return;
15204 if (check_restricted() || check_secure())
15205 return;
15206 # ifdef FEAT_X11
15207 if (check_connection() == FAIL)
15208 return;
15209 # endif
15211 if (serverSendReply(server, reply) < 0)
15213 EMSG(_("E258: Unable to send to client"));
15214 return;
15216 rettv->vval.v_number = 0;
15217 #else
15218 rettv->vval.v_number = -1;
15219 #endif
15222 /*ARGSUSED*/
15223 static void
15224 f_serverlist(argvars, rettv)
15225 typval_T *argvars;
15226 typval_T *rettv;
15228 char_u *r = NULL;
15230 #ifdef FEAT_CLIENTSERVER
15231 # if defined(WIN32) || defined(MAC_CLIENTSERVER)
15232 r = serverGetVimNames();
15233 # elif defined(FEAT_X11)
15234 make_connection();
15235 if (X_DISPLAY != NULL)
15236 r = serverGetVimNames(X_DISPLAY);
15237 # endif
15238 #endif
15239 rettv->v_type = VAR_STRING;
15240 rettv->vval.v_string = r;
15244 * "setbufvar()" function
15246 /*ARGSUSED*/
15247 static void
15248 f_setbufvar(argvars, rettv)
15249 typval_T *argvars;
15250 typval_T *rettv;
15252 buf_T *buf;
15253 aco_save_T aco;
15254 char_u *varname, *bufvarname;
15255 typval_T *varp;
15256 char_u nbuf[NUMBUFLEN];
15258 rettv->vval.v_number = 0;
15260 if (check_restricted() || check_secure())
15261 return;
15262 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15263 varname = get_tv_string_chk(&argvars[1]);
15264 buf = get_buf_tv(&argvars[0]);
15265 varp = &argvars[2];
15267 if (buf != NULL && varname != NULL && varp != NULL)
15269 /* set curbuf to be our buf, temporarily */
15270 aucmd_prepbuf(&aco, buf);
15272 if (*varname == '&')
15274 long numval;
15275 char_u *strval;
15276 int error = FALSE;
15278 ++varname;
15279 numval = get_tv_number_chk(varp, &error);
15280 strval = get_tv_string_buf_chk(varp, nbuf);
15281 if (!error && strval != NULL)
15282 set_option_value(varname, numval, strval, OPT_LOCAL);
15284 else
15286 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15287 if (bufvarname != NULL)
15289 STRCPY(bufvarname, "b:");
15290 STRCPY(bufvarname + 2, varname);
15291 set_var(bufvarname, varp, TRUE);
15292 vim_free(bufvarname);
15296 /* reset notion of buffer */
15297 aucmd_restbuf(&aco);
15302 * "setcmdpos()" function
15304 static void
15305 f_setcmdpos(argvars, rettv)
15306 typval_T *argvars;
15307 typval_T *rettv;
15309 int pos = (int)get_tv_number(&argvars[0]) - 1;
15311 if (pos >= 0)
15312 rettv->vval.v_number = set_cmdline_pos(pos);
15316 * "setline()" function
15318 static void
15319 f_setline(argvars, rettv)
15320 typval_T *argvars;
15321 typval_T *rettv;
15323 linenr_T lnum;
15324 char_u *line = NULL;
15325 list_T *l = NULL;
15326 listitem_T *li = NULL;
15327 long added = 0;
15328 linenr_T lcount = curbuf->b_ml.ml_line_count;
15330 lnum = get_tv_lnum(&argvars[0]);
15331 if (argvars[1].v_type == VAR_LIST)
15333 l = argvars[1].vval.v_list;
15334 li = l->lv_first;
15336 else
15337 line = get_tv_string_chk(&argvars[1]);
15339 rettv->vval.v_number = 0; /* OK */
15340 for (;;)
15342 if (l != NULL)
15344 /* list argument, get next string */
15345 if (li == NULL)
15346 break;
15347 line = get_tv_string_chk(&li->li_tv);
15348 li = li->li_next;
15351 rettv->vval.v_number = 1; /* FAIL */
15352 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15353 break;
15354 if (lnum <= curbuf->b_ml.ml_line_count)
15356 /* existing line, replace it */
15357 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15359 changed_bytes(lnum, 0);
15360 if (lnum == curwin->w_cursor.lnum)
15361 check_cursor_col();
15362 rettv->vval.v_number = 0; /* OK */
15365 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15367 /* lnum is one past the last line, append the line */
15368 ++added;
15369 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15370 rettv->vval.v_number = 0; /* OK */
15373 if (l == NULL) /* only one string argument */
15374 break;
15375 ++lnum;
15378 if (added > 0)
15379 appended_lines_mark(lcount, added);
15382 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15385 * Used by "setqflist()" and "setloclist()" functions
15387 /*ARGSUSED*/
15388 static void
15389 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15390 win_T *wp;
15391 typval_T *list_arg;
15392 typval_T *action_arg;
15393 typval_T *rettv;
15395 #ifdef FEAT_QUICKFIX
15396 char_u *act;
15397 int action = ' ';
15398 #endif
15400 rettv->vval.v_number = -1;
15402 #ifdef FEAT_QUICKFIX
15403 if (list_arg->v_type != VAR_LIST)
15404 EMSG(_(e_listreq));
15405 else
15407 list_T *l = list_arg->vval.v_list;
15409 if (action_arg->v_type == VAR_STRING)
15411 act = get_tv_string_chk(action_arg);
15412 if (act == NULL)
15413 return; /* type error; errmsg already given */
15414 if (*act == 'a' || *act == 'r')
15415 action = *act;
15418 if (l != NULL && set_errorlist(wp, l, action) == OK)
15419 rettv->vval.v_number = 0;
15421 #endif
15425 * "setloclist()" function
15427 /*ARGSUSED*/
15428 static void
15429 f_setloclist(argvars, rettv)
15430 typval_T *argvars;
15431 typval_T *rettv;
15433 win_T *win;
15435 rettv->vval.v_number = -1;
15437 win = find_win_by_nr(&argvars[0], NULL);
15438 if (win != NULL)
15439 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15443 * "setmatches()" function
15445 static void
15446 f_setmatches(argvars, rettv)
15447 typval_T *argvars;
15448 typval_T *rettv;
15450 #ifdef FEAT_SEARCH_EXTRA
15451 list_T *l;
15452 listitem_T *li;
15453 dict_T *d;
15455 rettv->vval.v_number = -1;
15456 if (argvars[0].v_type != VAR_LIST)
15458 EMSG(_(e_listreq));
15459 return;
15461 if ((l = argvars[0].vval.v_list) != NULL)
15464 /* To some extent make sure that we are dealing with a list from
15465 * "getmatches()". */
15466 li = l->lv_first;
15467 while (li != NULL)
15469 if (li->li_tv.v_type != VAR_DICT
15470 || (d = li->li_tv.vval.v_dict) == NULL)
15472 EMSG(_(e_invarg));
15473 return;
15475 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15476 && dict_find(d, (char_u *)"pattern", -1) != NULL
15477 && dict_find(d, (char_u *)"priority", -1) != NULL
15478 && dict_find(d, (char_u *)"id", -1) != NULL))
15480 EMSG(_(e_invarg));
15481 return;
15483 li = li->li_next;
15486 clear_matches(curwin);
15487 li = l->lv_first;
15488 while (li != NULL)
15490 d = li->li_tv.vval.v_dict;
15491 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15492 get_dict_string(d, (char_u *)"pattern", FALSE),
15493 (int)get_dict_number(d, (char_u *)"priority"),
15494 (int)get_dict_number(d, (char_u *)"id"));
15495 li = li->li_next;
15497 rettv->vval.v_number = 0;
15499 #endif
15503 * "setpos()" function
15505 /*ARGSUSED*/
15506 static void
15507 f_setpos(argvars, rettv)
15508 typval_T *argvars;
15509 typval_T *rettv;
15511 pos_T pos;
15512 int fnum;
15513 char_u *name;
15515 rettv->vval.v_number = -1;
15516 name = get_tv_string_chk(argvars);
15517 if (name != NULL)
15519 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15521 --pos.col;
15522 if (name[0] == '.' && name[1] == NUL)
15524 /* set cursor */
15525 if (fnum == curbuf->b_fnum)
15527 curwin->w_cursor = pos;
15528 check_cursor();
15529 rettv->vval.v_number = 0;
15531 else
15532 EMSG(_(e_invarg));
15534 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15536 /* set mark */
15537 if (setmark_pos(name[1], &pos, fnum) == OK)
15538 rettv->vval.v_number = 0;
15540 else
15541 EMSG(_(e_invarg));
15547 * "setqflist()" function
15549 /*ARGSUSED*/
15550 static void
15551 f_setqflist(argvars, rettv)
15552 typval_T *argvars;
15553 typval_T *rettv;
15555 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15559 * "setreg()" function
15561 static void
15562 f_setreg(argvars, rettv)
15563 typval_T *argvars;
15564 typval_T *rettv;
15566 int regname;
15567 char_u *strregname;
15568 char_u *stropt;
15569 char_u *strval;
15570 int append;
15571 char_u yank_type;
15572 long block_len;
15574 block_len = -1;
15575 yank_type = MAUTO;
15576 append = FALSE;
15578 strregname = get_tv_string_chk(argvars);
15579 rettv->vval.v_number = 1; /* FAIL is default */
15581 if (strregname == NULL)
15582 return; /* type error; errmsg already given */
15583 regname = *strregname;
15584 if (regname == 0 || regname == '@')
15585 regname = '"';
15586 else if (regname == '=')
15587 return;
15589 if (argvars[2].v_type != VAR_UNKNOWN)
15591 stropt = get_tv_string_chk(&argvars[2]);
15592 if (stropt == NULL)
15593 return; /* type error */
15594 for (; *stropt != NUL; ++stropt)
15595 switch (*stropt)
15597 case 'a': case 'A': /* append */
15598 append = TRUE;
15599 break;
15600 case 'v': case 'c': /* character-wise selection */
15601 yank_type = MCHAR;
15602 break;
15603 case 'V': case 'l': /* line-wise selection */
15604 yank_type = MLINE;
15605 break;
15606 #ifdef FEAT_VISUAL
15607 case 'b': case Ctrl_V: /* block-wise selection */
15608 yank_type = MBLOCK;
15609 if (VIM_ISDIGIT(stropt[1]))
15611 ++stropt;
15612 block_len = getdigits(&stropt) - 1;
15613 --stropt;
15615 break;
15616 #endif
15620 strval = get_tv_string_chk(&argvars[1]);
15621 if (strval != NULL)
15622 write_reg_contents_ex(regname, strval, -1,
15623 append, yank_type, block_len);
15624 rettv->vval.v_number = 0;
15628 * "settabwinvar()" function
15630 static void
15631 f_settabwinvar(argvars, rettv)
15632 typval_T *argvars;
15633 typval_T *rettv;
15635 setwinvar(argvars, rettv, 1);
15639 * "setwinvar()" function
15641 static void
15642 f_setwinvar(argvars, rettv)
15643 typval_T *argvars;
15644 typval_T *rettv;
15646 setwinvar(argvars, rettv, 0);
15650 * "setwinvar()" and "settabwinvar()" functions
15652 static void
15653 setwinvar(argvars, rettv, off)
15654 typval_T *argvars;
15655 typval_T *rettv;
15656 int off;
15658 win_T *win;
15659 #ifdef FEAT_WINDOWS
15660 win_T *save_curwin;
15661 tabpage_T *save_curtab;
15662 #endif
15663 char_u *varname, *winvarname;
15664 typval_T *varp;
15665 char_u nbuf[NUMBUFLEN];
15666 tabpage_T *tp;
15668 rettv->vval.v_number = 0;
15670 if (check_restricted() || check_secure())
15671 return;
15673 #ifdef FEAT_WINDOWS
15674 if (off == 1)
15675 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15676 else
15677 tp = curtab;
15678 #endif
15679 win = find_win_by_nr(&argvars[off], tp);
15680 varname = get_tv_string_chk(&argvars[off + 1]);
15681 varp = &argvars[off + 2];
15683 if (win != NULL && varname != NULL && varp != NULL)
15685 #ifdef FEAT_WINDOWS
15686 /* set curwin to be our win, temporarily */
15687 save_curwin = curwin;
15688 save_curtab = curtab;
15689 goto_tabpage_tp(tp);
15690 if (!win_valid(win))
15691 return;
15692 curwin = win;
15693 curbuf = curwin->w_buffer;
15694 #endif
15696 if (*varname == '&')
15698 long numval;
15699 char_u *strval;
15700 int error = FALSE;
15702 ++varname;
15703 numval = get_tv_number_chk(varp, &error);
15704 strval = get_tv_string_buf_chk(varp, nbuf);
15705 if (!error && strval != NULL)
15706 set_option_value(varname, numval, strval, OPT_LOCAL);
15708 else
15710 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15711 if (winvarname != NULL)
15713 STRCPY(winvarname, "w:");
15714 STRCPY(winvarname + 2, varname);
15715 set_var(winvarname, varp, TRUE);
15716 vim_free(winvarname);
15720 #ifdef FEAT_WINDOWS
15721 /* Restore current tabpage and window, if still valid (autocomands can
15722 * make them invalid). */
15723 if (valid_tabpage(save_curtab))
15724 goto_tabpage_tp(save_curtab);
15725 if (win_valid(save_curwin))
15727 curwin = save_curwin;
15728 curbuf = curwin->w_buffer;
15730 #endif
15735 * "shellescape({string})" function
15737 static void
15738 f_shellescape(argvars, rettv)
15739 typval_T *argvars;
15740 typval_T *rettv;
15742 rettv->vval.v_string = vim_strsave_shellescape(
15743 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15744 rettv->v_type = VAR_STRING;
15748 * "simplify()" function
15750 static void
15751 f_simplify(argvars, rettv)
15752 typval_T *argvars;
15753 typval_T *rettv;
15755 char_u *p;
15757 p = get_tv_string(&argvars[0]);
15758 rettv->vval.v_string = vim_strsave(p);
15759 simplify_filename(rettv->vval.v_string); /* simplify in place */
15760 rettv->v_type = VAR_STRING;
15763 #ifdef FEAT_FLOAT
15765 * "sin()" function
15767 static void
15768 f_sin(argvars, rettv)
15769 typval_T *argvars;
15770 typval_T *rettv;
15772 float_T f;
15774 rettv->v_type = VAR_FLOAT;
15775 if (get_float_arg(argvars, &f) == OK)
15776 rettv->vval.v_float = sin(f);
15777 else
15778 rettv->vval.v_float = 0.0;
15780 #endif
15782 static int
15783 #ifdef __BORLANDC__
15784 _RTLENTRYF
15785 #endif
15786 item_compare __ARGS((const void *s1, const void *s2));
15787 static int
15788 #ifdef __BORLANDC__
15789 _RTLENTRYF
15790 #endif
15791 item_compare2 __ARGS((const void *s1, const void *s2));
15793 static int item_compare_ic;
15794 static char_u *item_compare_func;
15795 static int item_compare_func_err;
15796 #define ITEM_COMPARE_FAIL 999
15799 * Compare functions for f_sort() below.
15801 static int
15802 #ifdef __BORLANDC__
15803 _RTLENTRYF
15804 #endif
15805 item_compare(s1, s2)
15806 const void *s1;
15807 const void *s2;
15809 char_u *p1, *p2;
15810 char_u *tofree1, *tofree2;
15811 int res;
15812 char_u numbuf1[NUMBUFLEN];
15813 char_u numbuf2[NUMBUFLEN];
15815 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15816 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15817 if (p1 == NULL)
15818 p1 = (char_u *)"";
15819 if (p2 == NULL)
15820 p2 = (char_u *)"";
15821 if (item_compare_ic)
15822 res = STRICMP(p1, p2);
15823 else
15824 res = STRCMP(p1, p2);
15825 vim_free(tofree1);
15826 vim_free(tofree2);
15827 return res;
15830 static int
15831 #ifdef __BORLANDC__
15832 _RTLENTRYF
15833 #endif
15834 item_compare2(s1, s2)
15835 const void *s1;
15836 const void *s2;
15838 int res;
15839 typval_T rettv;
15840 typval_T argv[3];
15841 int dummy;
15843 /* shortcut after failure in previous call; compare all items equal */
15844 if (item_compare_func_err)
15845 return 0;
15847 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15848 * in the copy without changing the original list items. */
15849 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15850 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15852 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15853 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15854 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15855 clear_tv(&argv[0]);
15856 clear_tv(&argv[1]);
15858 if (res == FAIL)
15859 res = ITEM_COMPARE_FAIL;
15860 else
15861 /* return value has wrong type */
15862 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15863 if (item_compare_func_err)
15864 res = ITEM_COMPARE_FAIL;
15865 clear_tv(&rettv);
15866 return res;
15870 * "sort({list})" function
15872 static void
15873 f_sort(argvars, rettv)
15874 typval_T *argvars;
15875 typval_T *rettv;
15877 list_T *l;
15878 listitem_T *li;
15879 listitem_T **ptrs;
15880 long len;
15881 long i;
15883 rettv->vval.v_number = 0;
15884 if (argvars[0].v_type != VAR_LIST)
15885 EMSG2(_(e_listarg), "sort()");
15886 else
15888 l = argvars[0].vval.v_list;
15889 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15890 return;
15891 rettv->vval.v_list = l;
15892 rettv->v_type = VAR_LIST;
15893 ++l->lv_refcount;
15895 len = list_len(l);
15896 if (len <= 1)
15897 return; /* short list sorts pretty quickly */
15899 item_compare_ic = FALSE;
15900 item_compare_func = NULL;
15901 if (argvars[1].v_type != VAR_UNKNOWN)
15903 if (argvars[1].v_type == VAR_FUNC)
15904 item_compare_func = argvars[1].vval.v_string;
15905 else
15907 int error = FALSE;
15909 i = get_tv_number_chk(&argvars[1], &error);
15910 if (error)
15911 return; /* type error; errmsg already given */
15912 if (i == 1)
15913 item_compare_ic = TRUE;
15914 else
15915 item_compare_func = get_tv_string(&argvars[1]);
15919 /* Make an array with each entry pointing to an item in the List. */
15920 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15921 if (ptrs == NULL)
15922 return;
15923 i = 0;
15924 for (li = l->lv_first; li != NULL; li = li->li_next)
15925 ptrs[i++] = li;
15927 item_compare_func_err = FALSE;
15928 /* test the compare function */
15929 if (item_compare_func != NULL
15930 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15931 == ITEM_COMPARE_FAIL)
15932 EMSG(_("E702: Sort compare function failed"));
15933 else
15935 /* Sort the array with item pointers. */
15936 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15937 item_compare_func == NULL ? item_compare : item_compare2);
15939 if (!item_compare_func_err)
15941 /* Clear the List and append the items in the sorted order. */
15942 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15943 l->lv_len = 0;
15944 for (i = 0; i < len; ++i)
15945 list_append(l, ptrs[i]);
15949 vim_free(ptrs);
15954 * "soundfold({word})" function
15956 static void
15957 f_soundfold(argvars, rettv)
15958 typval_T *argvars;
15959 typval_T *rettv;
15961 char_u *s;
15963 rettv->v_type = VAR_STRING;
15964 s = get_tv_string(&argvars[0]);
15965 #ifdef FEAT_SPELL
15966 rettv->vval.v_string = eval_soundfold(s);
15967 #else
15968 rettv->vval.v_string = vim_strsave(s);
15969 #endif
15973 * "spellbadword()" function
15975 /* ARGSUSED */
15976 static void
15977 f_spellbadword(argvars, rettv)
15978 typval_T *argvars;
15979 typval_T *rettv;
15981 char_u *word = (char_u *)"";
15982 hlf_T attr = HLF_COUNT;
15983 int len = 0;
15985 if (rettv_list_alloc(rettv) == FAIL)
15986 return;
15988 #ifdef FEAT_SPELL
15989 if (argvars[0].v_type == VAR_UNKNOWN)
15991 /* Find the start and length of the badly spelled word. */
15992 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
15993 if (len != 0)
15994 word = ml_get_cursor();
15996 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
15998 char_u *str = get_tv_string_chk(&argvars[0]);
15999 int capcol = -1;
16001 if (str != NULL)
16003 /* Check the argument for spelling. */
16004 while (*str != NUL)
16006 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16007 if (attr != HLF_COUNT)
16009 word = str;
16010 break;
16012 str += len;
16016 #endif
16018 list_append_string(rettv->vval.v_list, word, len);
16019 list_append_string(rettv->vval.v_list, (char_u *)(
16020 attr == HLF_SPB ? "bad" :
16021 attr == HLF_SPR ? "rare" :
16022 attr == HLF_SPL ? "local" :
16023 attr == HLF_SPC ? "caps" :
16024 ""), -1);
16028 * "spellsuggest()" function
16030 /*ARGSUSED*/
16031 static void
16032 f_spellsuggest(argvars, rettv)
16033 typval_T *argvars;
16034 typval_T *rettv;
16036 #ifdef FEAT_SPELL
16037 char_u *str;
16038 int typeerr = FALSE;
16039 int maxcount;
16040 garray_T ga;
16041 int i;
16042 listitem_T *li;
16043 int need_capital = FALSE;
16044 #endif
16046 if (rettv_list_alloc(rettv) == FAIL)
16047 return;
16049 #ifdef FEAT_SPELL
16050 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16052 str = get_tv_string(&argvars[0]);
16053 if (argvars[1].v_type != VAR_UNKNOWN)
16055 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16056 if (maxcount <= 0)
16057 return;
16058 if (argvars[2].v_type != VAR_UNKNOWN)
16060 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16061 if (typeerr)
16062 return;
16065 else
16066 maxcount = 25;
16068 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16070 for (i = 0; i < ga.ga_len; ++i)
16072 str = ((char_u **)ga.ga_data)[i];
16074 li = listitem_alloc();
16075 if (li == NULL)
16076 vim_free(str);
16077 else
16079 li->li_tv.v_type = VAR_STRING;
16080 li->li_tv.v_lock = 0;
16081 li->li_tv.vval.v_string = str;
16082 list_append(rettv->vval.v_list, li);
16085 ga_clear(&ga);
16087 #endif
16090 static void
16091 f_split(argvars, rettv)
16092 typval_T *argvars;
16093 typval_T *rettv;
16095 char_u *str;
16096 char_u *end;
16097 char_u *pat = NULL;
16098 regmatch_T regmatch;
16099 char_u patbuf[NUMBUFLEN];
16100 char_u *save_cpo;
16101 int match;
16102 colnr_T col = 0;
16103 int keepempty = FALSE;
16104 int typeerr = FALSE;
16106 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16107 save_cpo = p_cpo;
16108 p_cpo = (char_u *)"";
16110 str = get_tv_string(&argvars[0]);
16111 if (argvars[1].v_type != VAR_UNKNOWN)
16113 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16114 if (pat == NULL)
16115 typeerr = TRUE;
16116 if (argvars[2].v_type != VAR_UNKNOWN)
16117 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16119 if (pat == NULL || *pat == NUL)
16120 pat = (char_u *)"[\\x01- ]\\+";
16122 if (rettv_list_alloc(rettv) == FAIL)
16123 return;
16124 if (typeerr)
16125 return;
16127 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16128 if (regmatch.regprog != NULL)
16130 regmatch.rm_ic = FALSE;
16131 while (*str != NUL || keepempty)
16133 if (*str == NUL)
16134 match = FALSE; /* empty item at the end */
16135 else
16136 match = vim_regexec_nl(&regmatch, str, col);
16137 if (match)
16138 end = regmatch.startp[0];
16139 else
16140 end = str + STRLEN(str);
16141 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16142 && *str != NUL && match && end < regmatch.endp[0]))
16144 if (list_append_string(rettv->vval.v_list, str,
16145 (int)(end - str)) == FAIL)
16146 break;
16148 if (!match)
16149 break;
16150 /* Advance to just after the match. */
16151 if (regmatch.endp[0] > str)
16152 col = 0;
16153 else
16155 /* Don't get stuck at the same match. */
16156 #ifdef FEAT_MBYTE
16157 col = (*mb_ptr2len)(regmatch.endp[0]);
16158 #else
16159 col = 1;
16160 #endif
16162 str = regmatch.endp[0];
16165 vim_free(regmatch.regprog);
16168 p_cpo = save_cpo;
16171 #ifdef FEAT_FLOAT
16173 * "sqrt()" function
16175 static void
16176 f_sqrt(argvars, rettv)
16177 typval_T *argvars;
16178 typval_T *rettv;
16180 float_T f;
16182 rettv->v_type = VAR_FLOAT;
16183 if (get_float_arg(argvars, &f) == OK)
16184 rettv->vval.v_float = sqrt(f);
16185 else
16186 rettv->vval.v_float = 0.0;
16190 * "str2float()" function
16192 static void
16193 f_str2float(argvars, rettv)
16194 typval_T *argvars;
16195 typval_T *rettv;
16197 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16199 if (*p == '+')
16200 p = skipwhite(p + 1);
16201 (void)string2float(p, &rettv->vval.v_float);
16202 rettv->v_type = VAR_FLOAT;
16204 #endif
16207 * "str2nr()" function
16209 static void
16210 f_str2nr(argvars, rettv)
16211 typval_T *argvars;
16212 typval_T *rettv;
16214 int base = 10;
16215 char_u *p;
16216 long n;
16218 if (argvars[1].v_type != VAR_UNKNOWN)
16220 base = get_tv_number(&argvars[1]);
16221 if (base != 8 && base != 10 && base != 16)
16223 EMSG(_(e_invarg));
16224 return;
16228 p = skipwhite(get_tv_string(&argvars[0]));
16229 if (*p == '+')
16230 p = skipwhite(p + 1);
16231 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16232 rettv->vval.v_number = n;
16235 #ifdef HAVE_STRFTIME
16237 * "strftime({format}[, {time}])" function
16239 static void
16240 f_strftime(argvars, rettv)
16241 typval_T *argvars;
16242 typval_T *rettv;
16244 char_u result_buf[256];
16245 struct tm *curtime;
16246 time_t seconds;
16247 char_u *p;
16249 rettv->v_type = VAR_STRING;
16251 p = get_tv_string(&argvars[0]);
16252 if (argvars[1].v_type == VAR_UNKNOWN)
16253 seconds = time(NULL);
16254 else
16255 seconds = (time_t)get_tv_number(&argvars[1]);
16256 curtime = localtime(&seconds);
16257 /* MSVC returns NULL for an invalid value of seconds. */
16258 if (curtime == NULL)
16259 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16260 else
16262 # ifdef FEAT_MBYTE
16263 vimconv_T conv;
16264 char_u *enc;
16266 conv.vc_type = CONV_NONE;
16267 enc = enc_locale();
16268 convert_setup(&conv, p_enc, enc);
16269 if (conv.vc_type != CONV_NONE)
16270 p = string_convert(&conv, p, NULL);
16271 # endif
16272 if (p != NULL)
16273 (void)strftime((char *)result_buf, sizeof(result_buf),
16274 (char *)p, curtime);
16275 else
16276 result_buf[0] = NUL;
16278 # ifdef FEAT_MBYTE
16279 if (conv.vc_type != CONV_NONE)
16280 vim_free(p);
16281 convert_setup(&conv, enc, p_enc);
16282 if (conv.vc_type != CONV_NONE)
16283 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16284 else
16285 # endif
16286 rettv->vval.v_string = vim_strsave(result_buf);
16288 # ifdef FEAT_MBYTE
16289 /* Release conversion descriptors */
16290 convert_setup(&conv, NULL, NULL);
16291 vim_free(enc);
16292 # endif
16295 #endif
16298 * "stridx()" function
16300 static void
16301 f_stridx(argvars, rettv)
16302 typval_T *argvars;
16303 typval_T *rettv;
16305 char_u buf[NUMBUFLEN];
16306 char_u *needle;
16307 char_u *haystack;
16308 char_u *save_haystack;
16309 char_u *pos;
16310 int start_idx;
16312 needle = get_tv_string_chk(&argvars[1]);
16313 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16314 rettv->vval.v_number = -1;
16315 if (needle == NULL || haystack == NULL)
16316 return; /* type error; errmsg already given */
16318 if (argvars[2].v_type != VAR_UNKNOWN)
16320 int error = FALSE;
16322 start_idx = get_tv_number_chk(&argvars[2], &error);
16323 if (error || start_idx >= (int)STRLEN(haystack))
16324 return;
16325 if (start_idx >= 0)
16326 haystack += start_idx;
16329 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16330 if (pos != NULL)
16331 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16335 * "string()" function
16337 static void
16338 f_string(argvars, rettv)
16339 typval_T *argvars;
16340 typval_T *rettv;
16342 char_u *tofree;
16343 char_u numbuf[NUMBUFLEN];
16345 rettv->v_type = VAR_STRING;
16346 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16347 /* Make a copy if we have a value but it's not in allocated memory. */
16348 if (rettv->vval.v_string != NULL && tofree == NULL)
16349 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16353 * "strlen()" function
16355 static void
16356 f_strlen(argvars, rettv)
16357 typval_T *argvars;
16358 typval_T *rettv;
16360 rettv->vval.v_number = (varnumber_T)(STRLEN(
16361 get_tv_string(&argvars[0])));
16365 * "strpart()" function
16367 static void
16368 f_strpart(argvars, rettv)
16369 typval_T *argvars;
16370 typval_T *rettv;
16372 char_u *p;
16373 int n;
16374 int len;
16375 int slen;
16376 int error = FALSE;
16378 p = get_tv_string(&argvars[0]);
16379 slen = (int)STRLEN(p);
16381 n = get_tv_number_chk(&argvars[1], &error);
16382 if (error)
16383 len = 0;
16384 else if (argvars[2].v_type != VAR_UNKNOWN)
16385 len = get_tv_number(&argvars[2]);
16386 else
16387 len = slen - n; /* default len: all bytes that are available. */
16390 * Only return the overlap between the specified part and the actual
16391 * string.
16393 if (n < 0)
16395 len += n;
16396 n = 0;
16398 else if (n > slen)
16399 n = slen;
16400 if (len < 0)
16401 len = 0;
16402 else if (n + len > slen)
16403 len = slen - n;
16405 rettv->v_type = VAR_STRING;
16406 rettv->vval.v_string = vim_strnsave(p + n, len);
16410 * "strridx()" function
16412 static void
16413 f_strridx(argvars, rettv)
16414 typval_T *argvars;
16415 typval_T *rettv;
16417 char_u buf[NUMBUFLEN];
16418 char_u *needle;
16419 char_u *haystack;
16420 char_u *rest;
16421 char_u *lastmatch = NULL;
16422 int haystack_len, end_idx;
16424 needle = get_tv_string_chk(&argvars[1]);
16425 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16427 rettv->vval.v_number = -1;
16428 if (needle == NULL || haystack == NULL)
16429 return; /* type error; errmsg already given */
16431 haystack_len = (int)STRLEN(haystack);
16432 if (argvars[2].v_type != VAR_UNKNOWN)
16434 /* Third argument: upper limit for index */
16435 end_idx = get_tv_number_chk(&argvars[2], NULL);
16436 if (end_idx < 0)
16437 return; /* can never find a match */
16439 else
16440 end_idx = haystack_len;
16442 if (*needle == NUL)
16444 /* Empty string matches past the end. */
16445 lastmatch = haystack + end_idx;
16447 else
16449 for (rest = haystack; *rest != '\0'; ++rest)
16451 rest = (char_u *)strstr((char *)rest, (char *)needle);
16452 if (rest == NULL || rest > haystack + end_idx)
16453 break;
16454 lastmatch = rest;
16458 if (lastmatch == NULL)
16459 rettv->vval.v_number = -1;
16460 else
16461 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16465 * "strtrans()" function
16467 static void
16468 f_strtrans(argvars, rettv)
16469 typval_T *argvars;
16470 typval_T *rettv;
16472 rettv->v_type = VAR_STRING;
16473 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16477 * "submatch()" function
16479 static void
16480 f_submatch(argvars, rettv)
16481 typval_T *argvars;
16482 typval_T *rettv;
16484 rettv->v_type = VAR_STRING;
16485 rettv->vval.v_string =
16486 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16490 * "substitute()" function
16492 static void
16493 f_substitute(argvars, rettv)
16494 typval_T *argvars;
16495 typval_T *rettv;
16497 char_u patbuf[NUMBUFLEN];
16498 char_u subbuf[NUMBUFLEN];
16499 char_u flagsbuf[NUMBUFLEN];
16501 char_u *str = get_tv_string_chk(&argvars[0]);
16502 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16503 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16504 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16506 rettv->v_type = VAR_STRING;
16507 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16508 rettv->vval.v_string = NULL;
16509 else
16510 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16514 * "synID(lnum, col, trans)" function
16516 /*ARGSUSED*/
16517 static void
16518 f_synID(argvars, rettv)
16519 typval_T *argvars;
16520 typval_T *rettv;
16522 int id = 0;
16523 #ifdef FEAT_SYN_HL
16524 long lnum;
16525 long col;
16526 int trans;
16527 int transerr = FALSE;
16529 lnum = get_tv_lnum(argvars); /* -1 on type error */
16530 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16531 trans = get_tv_number_chk(&argvars[2], &transerr);
16533 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16534 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16535 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16536 #endif
16538 rettv->vval.v_number = id;
16542 * "synIDattr(id, what [, mode])" function
16544 /*ARGSUSED*/
16545 static void
16546 f_synIDattr(argvars, rettv)
16547 typval_T *argvars;
16548 typval_T *rettv;
16550 char_u *p = NULL;
16551 #ifdef FEAT_SYN_HL
16552 int id;
16553 char_u *what;
16554 char_u *mode;
16555 char_u modebuf[NUMBUFLEN];
16556 int modec;
16558 id = get_tv_number(&argvars[0]);
16559 what = get_tv_string(&argvars[1]);
16560 if (argvars[2].v_type != VAR_UNKNOWN)
16562 mode = get_tv_string_buf(&argvars[2], modebuf);
16563 modec = TOLOWER_ASC(mode[0]);
16564 if (modec != 't' && modec != 'c'
16565 #ifdef FEAT_GUI
16566 && modec != 'g'
16567 #endif
16569 modec = 0; /* replace invalid with current */
16571 else
16573 #ifdef FEAT_GUI
16574 if (gui.in_use)
16575 modec = 'g';
16576 else
16577 #endif
16578 if (t_colors > 1)
16579 modec = 'c';
16580 else
16581 modec = 't';
16585 switch (TOLOWER_ASC(what[0]))
16587 case 'b':
16588 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16589 p = highlight_color(id, what, modec);
16590 else /* bold */
16591 p = highlight_has_attr(id, HL_BOLD, modec);
16592 break;
16594 case 'f': /* fg[#] */
16595 p = highlight_color(id, what, modec);
16596 break;
16598 case 'i':
16599 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16600 p = highlight_has_attr(id, HL_INVERSE, modec);
16601 else /* italic */
16602 p = highlight_has_attr(id, HL_ITALIC, modec);
16603 break;
16605 case 'n': /* name */
16606 p = get_highlight_name(NULL, id - 1);
16607 break;
16609 case 'r': /* reverse */
16610 p = highlight_has_attr(id, HL_INVERSE, modec);
16611 break;
16613 case 's': /* standout */
16614 p = highlight_has_attr(id, HL_STANDOUT, modec);
16615 break;
16617 case 'u':
16618 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16619 /* underline */
16620 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16621 else
16622 /* undercurl */
16623 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16624 break;
16627 if (p != NULL)
16628 p = vim_strsave(p);
16629 #endif
16630 rettv->v_type = VAR_STRING;
16631 rettv->vval.v_string = p;
16635 * "synIDtrans(id)" function
16637 /*ARGSUSED*/
16638 static void
16639 f_synIDtrans(argvars, rettv)
16640 typval_T *argvars;
16641 typval_T *rettv;
16643 int id;
16645 #ifdef FEAT_SYN_HL
16646 id = get_tv_number(&argvars[0]);
16648 if (id > 0)
16649 id = syn_get_final_id(id);
16650 else
16651 #endif
16652 id = 0;
16654 rettv->vval.v_number = id;
16658 * "synstack(lnum, col)" function
16660 /*ARGSUSED*/
16661 static void
16662 f_synstack(argvars, rettv)
16663 typval_T *argvars;
16664 typval_T *rettv;
16666 #ifdef FEAT_SYN_HL
16667 long lnum;
16668 long col;
16669 int i;
16670 int id;
16671 #endif
16673 rettv->v_type = VAR_LIST;
16674 rettv->vval.v_list = NULL;
16676 #ifdef FEAT_SYN_HL
16677 lnum = get_tv_lnum(argvars); /* -1 on type error */
16678 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16680 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16681 && col >= 0 && col < (long)STRLEN(ml_get(lnum))
16682 && rettv_list_alloc(rettv) != FAIL)
16684 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16685 for (i = 0; ; ++i)
16687 id = syn_get_stack_item(i);
16688 if (id < 0)
16689 break;
16690 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16691 break;
16694 #endif
16698 * "system()" function
16700 static void
16701 f_system(argvars, rettv)
16702 typval_T *argvars;
16703 typval_T *rettv;
16705 char_u *res = NULL;
16706 char_u *p;
16707 char_u *infile = NULL;
16708 char_u buf[NUMBUFLEN];
16709 int err = FALSE;
16710 FILE *fd;
16712 if (check_restricted() || check_secure())
16713 goto done;
16715 if (argvars[1].v_type != VAR_UNKNOWN)
16718 * Write the string to a temp file, to be used for input of the shell
16719 * command.
16721 if ((infile = vim_tempname('i')) == NULL)
16723 EMSG(_(e_notmp));
16724 goto done;
16727 fd = mch_fopen((char *)infile, WRITEBIN);
16728 if (fd == NULL)
16730 EMSG2(_(e_notopen), infile);
16731 goto done;
16733 p = get_tv_string_buf_chk(&argvars[1], buf);
16734 if (p == NULL)
16736 fclose(fd);
16737 goto done; /* type error; errmsg already given */
16739 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16740 err = TRUE;
16741 if (fclose(fd) != 0)
16742 err = TRUE;
16743 if (err)
16745 EMSG(_("E677: Error writing temp file"));
16746 goto done;
16750 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16751 SHELL_SILENT | SHELL_COOKED);
16753 #ifdef USE_CR
16754 /* translate <CR> into <NL> */
16755 if (res != NULL)
16757 char_u *s;
16759 for (s = res; *s; ++s)
16761 if (*s == CAR)
16762 *s = NL;
16765 #else
16766 # ifdef USE_CRNL
16767 /* translate <CR><NL> into <NL> */
16768 if (res != NULL)
16770 char_u *s, *d;
16772 d = res;
16773 for (s = res; *s; ++s)
16775 if (s[0] == CAR && s[1] == NL)
16776 ++s;
16777 *d++ = *s;
16779 *d = NUL;
16781 # endif
16782 #endif
16784 done:
16785 if (infile != NULL)
16787 mch_remove(infile);
16788 vim_free(infile);
16790 rettv->v_type = VAR_STRING;
16791 rettv->vval.v_string = res;
16795 * "tabpagebuflist()" function
16797 /* ARGSUSED */
16798 static void
16799 f_tabpagebuflist(argvars, rettv)
16800 typval_T *argvars;
16801 typval_T *rettv;
16803 #ifndef FEAT_WINDOWS
16804 rettv->vval.v_number = 0;
16805 #else
16806 tabpage_T *tp;
16807 win_T *wp = NULL;
16809 if (argvars[0].v_type == VAR_UNKNOWN)
16810 wp = firstwin;
16811 else
16813 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16814 if (tp != NULL)
16815 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16817 if (wp == NULL)
16818 rettv->vval.v_number = 0;
16819 else
16821 if (rettv_list_alloc(rettv) == FAIL)
16822 rettv->vval.v_number = 0;
16823 else
16825 for (; wp != NULL; wp = wp->w_next)
16826 if (list_append_number(rettv->vval.v_list,
16827 wp->w_buffer->b_fnum) == FAIL)
16828 break;
16831 #endif
16836 * "tabpagenr()" function
16838 /* ARGSUSED */
16839 static void
16840 f_tabpagenr(argvars, rettv)
16841 typval_T *argvars;
16842 typval_T *rettv;
16844 int nr = 1;
16845 #ifdef FEAT_WINDOWS
16846 char_u *arg;
16848 if (argvars[0].v_type != VAR_UNKNOWN)
16850 arg = get_tv_string_chk(&argvars[0]);
16851 nr = 0;
16852 if (arg != NULL)
16854 if (STRCMP(arg, "$") == 0)
16855 nr = tabpage_index(NULL) - 1;
16856 else
16857 EMSG2(_(e_invexpr2), arg);
16860 else
16861 nr = tabpage_index(curtab);
16862 #endif
16863 rettv->vval.v_number = nr;
16867 #ifdef FEAT_WINDOWS
16868 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16871 * Common code for tabpagewinnr() and winnr().
16873 static int
16874 get_winnr(tp, argvar)
16875 tabpage_T *tp;
16876 typval_T *argvar;
16878 win_T *twin;
16879 int nr = 1;
16880 win_T *wp;
16881 char_u *arg;
16883 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16884 if (argvar->v_type != VAR_UNKNOWN)
16886 arg = get_tv_string_chk(argvar);
16887 if (arg == NULL)
16888 nr = 0; /* type error; errmsg already given */
16889 else if (STRCMP(arg, "$") == 0)
16890 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16891 else if (STRCMP(arg, "#") == 0)
16893 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16894 if (twin == NULL)
16895 nr = 0;
16897 else
16899 EMSG2(_(e_invexpr2), arg);
16900 nr = 0;
16904 if (nr > 0)
16905 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16906 wp != twin; wp = wp->w_next)
16908 if (wp == NULL)
16910 /* didn't find it in this tabpage */
16911 nr = 0;
16912 break;
16914 ++nr;
16916 return nr;
16918 #endif
16921 * "tabpagewinnr()" function
16923 /* ARGSUSED */
16924 static void
16925 f_tabpagewinnr(argvars, rettv)
16926 typval_T *argvars;
16927 typval_T *rettv;
16929 int nr = 1;
16930 #ifdef FEAT_WINDOWS
16931 tabpage_T *tp;
16933 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16934 if (tp == NULL)
16935 nr = 0;
16936 else
16937 nr = get_winnr(tp, &argvars[1]);
16938 #endif
16939 rettv->vval.v_number = nr;
16944 * "tagfiles()" function
16946 /*ARGSUSED*/
16947 static void
16948 f_tagfiles(argvars, rettv)
16949 typval_T *argvars;
16950 typval_T *rettv;
16952 char_u fname[MAXPATHL + 1];
16953 tagname_T tn;
16954 int first;
16956 if (rettv_list_alloc(rettv) == FAIL)
16958 rettv->vval.v_number = 0;
16959 return;
16962 for (first = TRUE; ; first = FALSE)
16963 if (get_tagfname(&tn, first, fname) == FAIL
16964 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
16965 break;
16966 tagname_free(&tn);
16970 * "taglist()" function
16972 static void
16973 f_taglist(argvars, rettv)
16974 typval_T *argvars;
16975 typval_T *rettv;
16977 char_u *tag_pattern;
16979 tag_pattern = get_tv_string(&argvars[0]);
16981 rettv->vval.v_number = FALSE;
16982 if (*tag_pattern == NUL)
16983 return;
16985 if (rettv_list_alloc(rettv) == OK)
16986 (void)get_tags(rettv->vval.v_list, tag_pattern);
16990 * "tempname()" function
16992 /*ARGSUSED*/
16993 static void
16994 f_tempname(argvars, rettv)
16995 typval_T *argvars;
16996 typval_T *rettv;
16998 static int x = 'A';
17000 rettv->v_type = VAR_STRING;
17001 rettv->vval.v_string = vim_tempname(x);
17003 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17004 * names. Skip 'I' and 'O', they are used for shell redirection. */
17007 if (x == 'Z')
17008 x = '0';
17009 else if (x == '9')
17010 x = 'A';
17011 else
17013 #ifdef EBCDIC
17014 if (x == 'I')
17015 x = 'J';
17016 else if (x == 'R')
17017 x = 'S';
17018 else
17019 #endif
17020 ++x;
17022 } while (x == 'I' || x == 'O');
17026 * "test(list)" function: Just checking the walls...
17028 /*ARGSUSED*/
17029 static void
17030 f_test(argvars, rettv)
17031 typval_T *argvars;
17032 typval_T *rettv;
17034 /* Used for unit testing. Change the code below to your liking. */
17035 #if 0
17036 listitem_T *li;
17037 list_T *l;
17038 char_u *bad, *good;
17040 if (argvars[0].v_type != VAR_LIST)
17041 return;
17042 l = argvars[0].vval.v_list;
17043 if (l == NULL)
17044 return;
17045 li = l->lv_first;
17046 if (li == NULL)
17047 return;
17048 bad = get_tv_string(&li->li_tv);
17049 li = li->li_next;
17050 if (li == NULL)
17051 return;
17052 good = get_tv_string(&li->li_tv);
17053 rettv->vval.v_number = test_edit_score(bad, good);
17054 #endif
17058 * "tolower(string)" function
17060 static void
17061 f_tolower(argvars, rettv)
17062 typval_T *argvars;
17063 typval_T *rettv;
17065 char_u *p;
17067 p = vim_strsave(get_tv_string(&argvars[0]));
17068 rettv->v_type = VAR_STRING;
17069 rettv->vval.v_string = p;
17071 if (p != NULL)
17072 while (*p != NUL)
17074 #ifdef FEAT_MBYTE
17075 int l;
17077 if (enc_utf8)
17079 int c, lc;
17081 c = utf_ptr2char(p);
17082 lc = utf_tolower(c);
17083 l = utf_ptr2len(p);
17084 /* TODO: reallocate string when byte count changes. */
17085 if (utf_char2len(lc) == l)
17086 utf_char2bytes(lc, p);
17087 p += l;
17089 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17090 p += l; /* skip multi-byte character */
17091 else
17092 #endif
17094 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17095 ++p;
17101 * "toupper(string)" function
17103 static void
17104 f_toupper(argvars, rettv)
17105 typval_T *argvars;
17106 typval_T *rettv;
17108 rettv->v_type = VAR_STRING;
17109 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17113 * "tr(string, fromstr, tostr)" function
17115 static void
17116 f_tr(argvars, rettv)
17117 typval_T *argvars;
17118 typval_T *rettv;
17120 char_u *instr;
17121 char_u *fromstr;
17122 char_u *tostr;
17123 char_u *p;
17124 #ifdef FEAT_MBYTE
17125 int inlen;
17126 int fromlen;
17127 int tolen;
17128 int idx;
17129 char_u *cpstr;
17130 int cplen;
17131 int first = TRUE;
17132 #endif
17133 char_u buf[NUMBUFLEN];
17134 char_u buf2[NUMBUFLEN];
17135 garray_T ga;
17137 instr = get_tv_string(&argvars[0]);
17138 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17139 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17141 /* Default return value: empty string. */
17142 rettv->v_type = VAR_STRING;
17143 rettv->vval.v_string = NULL;
17144 if (fromstr == NULL || tostr == NULL)
17145 return; /* type error; errmsg already given */
17146 ga_init2(&ga, (int)sizeof(char), 80);
17148 #ifdef FEAT_MBYTE
17149 if (!has_mbyte)
17150 #endif
17151 /* not multi-byte: fromstr and tostr must be the same length */
17152 if (STRLEN(fromstr) != STRLEN(tostr))
17154 #ifdef FEAT_MBYTE
17155 error:
17156 #endif
17157 EMSG2(_(e_invarg2), fromstr);
17158 ga_clear(&ga);
17159 return;
17162 /* fromstr and tostr have to contain the same number of chars */
17163 while (*instr != NUL)
17165 #ifdef FEAT_MBYTE
17166 if (has_mbyte)
17168 inlen = (*mb_ptr2len)(instr);
17169 cpstr = instr;
17170 cplen = inlen;
17171 idx = 0;
17172 for (p = fromstr; *p != NUL; p += fromlen)
17174 fromlen = (*mb_ptr2len)(p);
17175 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17177 for (p = tostr; *p != NUL; p += tolen)
17179 tolen = (*mb_ptr2len)(p);
17180 if (idx-- == 0)
17182 cplen = tolen;
17183 cpstr = p;
17184 break;
17187 if (*p == NUL) /* tostr is shorter than fromstr */
17188 goto error;
17189 break;
17191 ++idx;
17194 if (first && cpstr == instr)
17196 /* Check that fromstr and tostr have the same number of
17197 * (multi-byte) characters. Done only once when a character
17198 * of instr doesn't appear in fromstr. */
17199 first = FALSE;
17200 for (p = tostr; *p != NUL; p += tolen)
17202 tolen = (*mb_ptr2len)(p);
17203 --idx;
17205 if (idx != 0)
17206 goto error;
17209 ga_grow(&ga, cplen);
17210 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17211 ga.ga_len += cplen;
17213 instr += inlen;
17215 else
17216 #endif
17218 /* When not using multi-byte chars we can do it faster. */
17219 p = vim_strchr(fromstr, *instr);
17220 if (p != NULL)
17221 ga_append(&ga, tostr[p - fromstr]);
17222 else
17223 ga_append(&ga, *instr);
17224 ++instr;
17228 /* add a terminating NUL */
17229 ga_grow(&ga, 1);
17230 ga_append(&ga, NUL);
17232 rettv->vval.v_string = ga.ga_data;
17235 #ifdef FEAT_FLOAT
17237 * "trunc({float})" function
17239 static void
17240 f_trunc(argvars, rettv)
17241 typval_T *argvars;
17242 typval_T *rettv;
17244 float_T f;
17246 rettv->v_type = VAR_FLOAT;
17247 if (get_float_arg(argvars, &f) == OK)
17248 /* trunc() is not in C90, use floor() or ceil() instead. */
17249 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17250 else
17251 rettv->vval.v_float = 0.0;
17253 #endif
17256 * "type(expr)" function
17258 static void
17259 f_type(argvars, rettv)
17260 typval_T *argvars;
17261 typval_T *rettv;
17263 int n;
17265 switch (argvars[0].v_type)
17267 case VAR_NUMBER: n = 0; break;
17268 case VAR_STRING: n = 1; break;
17269 case VAR_FUNC: n = 2; break;
17270 case VAR_LIST: n = 3; break;
17271 case VAR_DICT: n = 4; break;
17272 #ifdef FEAT_FLOAT
17273 case VAR_FLOAT: n = 5; break;
17274 #endif
17275 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17277 rettv->vval.v_number = n;
17281 * "values(dict)" function
17283 static void
17284 f_values(argvars, rettv)
17285 typval_T *argvars;
17286 typval_T *rettv;
17288 dict_list(argvars, rettv, 1);
17292 * "virtcol(string)" function
17294 static void
17295 f_virtcol(argvars, rettv)
17296 typval_T *argvars;
17297 typval_T *rettv;
17299 colnr_T vcol = 0;
17300 pos_T *fp;
17301 int fnum = curbuf->b_fnum;
17303 fp = var2fpos(&argvars[0], FALSE, &fnum);
17304 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17305 && fnum == curbuf->b_fnum)
17307 getvvcol(curwin, fp, NULL, NULL, &vcol);
17308 ++vcol;
17311 rettv->vval.v_number = vcol;
17315 * "visualmode()" function
17317 /*ARGSUSED*/
17318 static void
17319 f_visualmode(argvars, rettv)
17320 typval_T *argvars;
17321 typval_T *rettv;
17323 #ifdef FEAT_VISUAL
17324 char_u str[2];
17326 rettv->v_type = VAR_STRING;
17327 str[0] = curbuf->b_visual_mode_eval;
17328 str[1] = NUL;
17329 rettv->vval.v_string = vim_strsave(str);
17331 /* A non-zero number or non-empty string argument: reset mode. */
17332 if (non_zero_arg(&argvars[0]))
17333 curbuf->b_visual_mode_eval = NUL;
17334 #else
17335 rettv->vval.v_number = 0; /* return anything, it won't work anyway */
17336 #endif
17340 * "winbufnr(nr)" function
17342 static void
17343 f_winbufnr(argvars, rettv)
17344 typval_T *argvars;
17345 typval_T *rettv;
17347 win_T *wp;
17349 wp = find_win_by_nr(&argvars[0], NULL);
17350 if (wp == NULL)
17351 rettv->vval.v_number = -1;
17352 else
17353 rettv->vval.v_number = wp->w_buffer->b_fnum;
17357 * "wincol()" function
17359 /*ARGSUSED*/
17360 static void
17361 f_wincol(argvars, rettv)
17362 typval_T *argvars;
17363 typval_T *rettv;
17365 validate_cursor();
17366 rettv->vval.v_number = curwin->w_wcol + 1;
17370 * "winheight(nr)" function
17372 static void
17373 f_winheight(argvars, rettv)
17374 typval_T *argvars;
17375 typval_T *rettv;
17377 win_T *wp;
17379 wp = find_win_by_nr(&argvars[0], NULL);
17380 if (wp == NULL)
17381 rettv->vval.v_number = -1;
17382 else
17383 rettv->vval.v_number = wp->w_height;
17387 * "winline()" function
17389 /*ARGSUSED*/
17390 static void
17391 f_winline(argvars, rettv)
17392 typval_T *argvars;
17393 typval_T *rettv;
17395 validate_cursor();
17396 rettv->vval.v_number = curwin->w_wrow + 1;
17400 * "winnr()" function
17402 /* ARGSUSED */
17403 static void
17404 f_winnr(argvars, rettv)
17405 typval_T *argvars;
17406 typval_T *rettv;
17408 int nr = 1;
17410 #ifdef FEAT_WINDOWS
17411 nr = get_winnr(curtab, &argvars[0]);
17412 #endif
17413 rettv->vval.v_number = nr;
17417 * "winrestcmd()" function
17419 /* ARGSUSED */
17420 static void
17421 f_winrestcmd(argvars, rettv)
17422 typval_T *argvars;
17423 typval_T *rettv;
17425 #ifdef FEAT_WINDOWS
17426 win_T *wp;
17427 int winnr = 1;
17428 garray_T ga;
17429 char_u buf[50];
17431 ga_init2(&ga, (int)sizeof(char), 70);
17432 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17434 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17435 ga_concat(&ga, buf);
17436 # ifdef FEAT_VERTSPLIT
17437 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17438 ga_concat(&ga, buf);
17439 # endif
17440 ++winnr;
17442 ga_append(&ga, NUL);
17444 rettv->vval.v_string = ga.ga_data;
17445 #else
17446 rettv->vval.v_string = NULL;
17447 #endif
17448 rettv->v_type = VAR_STRING;
17452 * "winrestview()" function
17454 /* ARGSUSED */
17455 static void
17456 f_winrestview(argvars, rettv)
17457 typval_T *argvars;
17458 typval_T *rettv;
17460 dict_T *dict;
17462 if (argvars[0].v_type != VAR_DICT
17463 || (dict = argvars[0].vval.v_dict) == NULL)
17464 EMSG(_(e_invarg));
17465 else
17467 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17468 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17469 #ifdef FEAT_VIRTUALEDIT
17470 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17471 #endif
17472 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17473 curwin->w_set_curswant = FALSE;
17475 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17476 #ifdef FEAT_DIFF
17477 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17478 #endif
17479 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17480 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17482 check_cursor();
17483 changed_cline_bef_curs();
17484 invalidate_botline();
17485 redraw_later(VALID);
17487 if (curwin->w_topline == 0)
17488 curwin->w_topline = 1;
17489 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17490 curwin->w_topline = curbuf->b_ml.ml_line_count;
17491 #ifdef FEAT_DIFF
17492 check_topfill(curwin, TRUE);
17493 #endif
17498 * "winsaveview()" function
17500 /* ARGSUSED */
17501 static void
17502 f_winsaveview(argvars, rettv)
17503 typval_T *argvars;
17504 typval_T *rettv;
17506 dict_T *dict;
17508 dict = dict_alloc();
17509 if (dict == NULL)
17510 return;
17511 rettv->v_type = VAR_DICT;
17512 rettv->vval.v_dict = dict;
17513 ++dict->dv_refcount;
17515 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17516 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17517 #ifdef FEAT_VIRTUALEDIT
17518 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17519 #endif
17520 update_curswant();
17521 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17523 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17524 #ifdef FEAT_DIFF
17525 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17526 #endif
17527 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17528 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17532 * "winwidth(nr)" function
17534 static void
17535 f_winwidth(argvars, rettv)
17536 typval_T *argvars;
17537 typval_T *rettv;
17539 win_T *wp;
17541 wp = find_win_by_nr(&argvars[0], NULL);
17542 if (wp == NULL)
17543 rettv->vval.v_number = -1;
17544 else
17545 #ifdef FEAT_VERTSPLIT
17546 rettv->vval.v_number = wp->w_width;
17547 #else
17548 rettv->vval.v_number = Columns;
17549 #endif
17553 * "writefile()" function
17555 static void
17556 f_writefile(argvars, rettv)
17557 typval_T *argvars;
17558 typval_T *rettv;
17560 int binary = FALSE;
17561 char_u *fname;
17562 FILE *fd;
17563 listitem_T *li;
17564 char_u *s;
17565 int ret = 0;
17566 int c;
17568 if (check_restricted() || check_secure())
17569 return;
17571 if (argvars[0].v_type != VAR_LIST)
17573 EMSG2(_(e_listarg), "writefile()");
17574 return;
17576 if (argvars[0].vval.v_list == NULL)
17577 return;
17579 if (argvars[2].v_type != VAR_UNKNOWN
17580 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17581 binary = TRUE;
17583 /* Always open the file in binary mode, library functions have a mind of
17584 * their own about CR-LF conversion. */
17585 fname = get_tv_string(&argvars[1]);
17586 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17588 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17589 ret = -1;
17591 else
17593 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17594 li = li->li_next)
17596 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17598 if (*s == '\n')
17599 c = putc(NUL, fd);
17600 else
17601 c = putc(*s, fd);
17602 if (c == EOF)
17604 ret = -1;
17605 break;
17608 if (!binary || li->li_next != NULL)
17609 if (putc('\n', fd) == EOF)
17611 ret = -1;
17612 break;
17614 if (ret < 0)
17616 EMSG(_(e_write));
17617 break;
17620 fclose(fd);
17623 rettv->vval.v_number = ret;
17627 * Translate a String variable into a position.
17628 * Returns NULL when there is an error.
17630 static pos_T *
17631 var2fpos(varp, dollar_lnum, fnum)
17632 typval_T *varp;
17633 int dollar_lnum; /* TRUE when $ is last line */
17634 int *fnum; /* set to fnum for '0, 'A, etc. */
17636 char_u *name;
17637 static pos_T pos;
17638 pos_T *pp;
17640 /* Argument can be [lnum, col, coladd]. */
17641 if (varp->v_type == VAR_LIST)
17643 list_T *l;
17644 int len;
17645 int error = FALSE;
17646 listitem_T *li;
17648 l = varp->vval.v_list;
17649 if (l == NULL)
17650 return NULL;
17652 /* Get the line number */
17653 pos.lnum = list_find_nr(l, 0L, &error);
17654 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17655 return NULL; /* invalid line number */
17657 /* Get the column number */
17658 pos.col = list_find_nr(l, 1L, &error);
17659 if (error)
17660 return NULL;
17661 len = (long)STRLEN(ml_get(pos.lnum));
17663 /* We accept "$" for the column number: last column. */
17664 li = list_find(l, 1L);
17665 if (li != NULL && li->li_tv.v_type == VAR_STRING
17666 && li->li_tv.vval.v_string != NULL
17667 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17668 pos.col = len + 1;
17670 /* Accept a position up to the NUL after the line. */
17671 if (pos.col == 0 || (int)pos.col > len + 1)
17672 return NULL; /* invalid column number */
17673 --pos.col;
17675 #ifdef FEAT_VIRTUALEDIT
17676 /* Get the virtual offset. Defaults to zero. */
17677 pos.coladd = list_find_nr(l, 2L, &error);
17678 if (error)
17679 pos.coladd = 0;
17680 #endif
17682 return &pos;
17685 name = get_tv_string_chk(varp);
17686 if (name == NULL)
17687 return NULL;
17688 if (name[0] == '.') /* cursor */
17689 return &curwin->w_cursor;
17690 #ifdef FEAT_VISUAL
17691 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17693 if (VIsual_active)
17694 return &VIsual;
17695 return &curwin->w_cursor;
17697 #endif
17698 if (name[0] == '\'') /* mark */
17700 pp = getmark_fnum(name[1], FALSE, fnum);
17701 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17702 return NULL;
17703 return pp;
17706 #ifdef FEAT_VIRTUALEDIT
17707 pos.coladd = 0;
17708 #endif
17710 if (name[0] == 'w' && dollar_lnum)
17712 pos.col = 0;
17713 if (name[1] == '0') /* "w0": first visible line */
17715 update_topline();
17716 pos.lnum = curwin->w_topline;
17717 return &pos;
17719 else if (name[1] == '$') /* "w$": last visible line */
17721 validate_botline();
17722 pos.lnum = curwin->w_botline - 1;
17723 return &pos;
17726 else if (name[0] == '$') /* last column or line */
17728 if (dollar_lnum)
17730 pos.lnum = curbuf->b_ml.ml_line_count;
17731 pos.col = 0;
17733 else
17735 pos.lnum = curwin->w_cursor.lnum;
17736 pos.col = (colnr_T)STRLEN(ml_get_curline());
17738 return &pos;
17740 return NULL;
17744 * Convert list in "arg" into a position and optional file number.
17745 * When "fnump" is NULL there is no file number, only 3 items.
17746 * Note that the column is passed on as-is, the caller may want to decrement
17747 * it to use 1 for the first column.
17748 * Return FAIL when conversion is not possible, doesn't check the position for
17749 * validity.
17751 static int
17752 list2fpos(arg, posp, fnump)
17753 typval_T *arg;
17754 pos_T *posp;
17755 int *fnump;
17757 list_T *l = arg->vval.v_list;
17758 long i = 0;
17759 long n;
17761 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17762 * when "fnump" isn't NULL and "coladd" is optional. */
17763 if (arg->v_type != VAR_LIST
17764 || l == NULL
17765 || l->lv_len < (fnump == NULL ? 2 : 3)
17766 || l->lv_len > (fnump == NULL ? 3 : 4))
17767 return FAIL;
17769 if (fnump != NULL)
17771 n = list_find_nr(l, i++, NULL); /* fnum */
17772 if (n < 0)
17773 return FAIL;
17774 if (n == 0)
17775 n = curbuf->b_fnum; /* current buffer */
17776 *fnump = n;
17779 n = list_find_nr(l, i++, NULL); /* lnum */
17780 if (n < 0)
17781 return FAIL;
17782 posp->lnum = n;
17784 n = list_find_nr(l, i++, NULL); /* col */
17785 if (n < 0)
17786 return FAIL;
17787 posp->col = n;
17789 #ifdef FEAT_VIRTUALEDIT
17790 n = list_find_nr(l, i, NULL);
17791 if (n < 0)
17792 posp->coladd = 0;
17793 else
17794 posp->coladd = n;
17795 #endif
17797 return OK;
17801 * Get the length of an environment variable name.
17802 * Advance "arg" to the first character after the name.
17803 * Return 0 for error.
17805 static int
17806 get_env_len(arg)
17807 char_u **arg;
17809 char_u *p;
17810 int len;
17812 for (p = *arg; vim_isIDc(*p); ++p)
17814 if (p == *arg) /* no name found */
17815 return 0;
17817 len = (int)(p - *arg);
17818 *arg = p;
17819 return len;
17823 * Get the length of the name of a function or internal variable.
17824 * "arg" is advanced to the first non-white character after the name.
17825 * Return 0 if something is wrong.
17827 static int
17828 get_id_len(arg)
17829 char_u **arg;
17831 char_u *p;
17832 int len;
17834 /* Find the end of the name. */
17835 for (p = *arg; eval_isnamec(*p); ++p)
17837 if (p == *arg) /* no name found */
17838 return 0;
17840 len = (int)(p - *arg);
17841 *arg = skipwhite(p);
17843 return len;
17847 * Get the length of the name of a variable or function.
17848 * Only the name is recognized, does not handle ".key" or "[idx]".
17849 * "arg" is advanced to the first non-white character after the name.
17850 * Return -1 if curly braces expansion failed.
17851 * Return 0 if something else is wrong.
17852 * If the name contains 'magic' {}'s, expand them and return the
17853 * expanded name in an allocated string via 'alias' - caller must free.
17855 static int
17856 get_name_len(arg, alias, evaluate, verbose)
17857 char_u **arg;
17858 char_u **alias;
17859 int evaluate;
17860 int verbose;
17862 int len;
17863 char_u *p;
17864 char_u *expr_start;
17865 char_u *expr_end;
17867 *alias = NULL; /* default to no alias */
17869 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17870 && (*arg)[2] == (int)KE_SNR)
17872 /* hard coded <SNR>, already translated */
17873 *arg += 3;
17874 return get_id_len(arg) + 3;
17876 len = eval_fname_script(*arg);
17877 if (len > 0)
17879 /* literal "<SID>", "s:" or "<SNR>" */
17880 *arg += len;
17884 * Find the end of the name; check for {} construction.
17886 p = find_name_end(*arg, &expr_start, &expr_end,
17887 len > 0 ? 0 : FNE_CHECK_START);
17888 if (expr_start != NULL)
17890 char_u *temp_string;
17892 if (!evaluate)
17894 len += (int)(p - *arg);
17895 *arg = skipwhite(p);
17896 return len;
17900 * Include any <SID> etc in the expanded string:
17901 * Thus the -len here.
17903 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17904 if (temp_string == NULL)
17905 return -1;
17906 *alias = temp_string;
17907 *arg = skipwhite(p);
17908 return (int)STRLEN(temp_string);
17911 len += get_id_len(arg);
17912 if (len == 0 && verbose)
17913 EMSG2(_(e_invexpr2), *arg);
17915 return len;
17919 * Find the end of a variable or function name, taking care of magic braces.
17920 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17921 * start and end of the first magic braces item.
17922 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17923 * Return a pointer to just after the name. Equal to "arg" if there is no
17924 * valid name.
17926 static char_u *
17927 find_name_end(arg, expr_start, expr_end, flags)
17928 char_u *arg;
17929 char_u **expr_start;
17930 char_u **expr_end;
17931 int flags;
17933 int mb_nest = 0;
17934 int br_nest = 0;
17935 char_u *p;
17937 if (expr_start != NULL)
17939 *expr_start = NULL;
17940 *expr_end = NULL;
17943 /* Quick check for valid starting character. */
17944 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17945 return arg;
17947 for (p = arg; *p != NUL
17948 && (eval_isnamec(*p)
17949 || *p == '{'
17950 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17951 || mb_nest != 0
17952 || br_nest != 0); mb_ptr_adv(p))
17954 if (*p == '\'')
17956 /* skip over 'string' to avoid counting [ and ] inside it. */
17957 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17959 if (*p == NUL)
17960 break;
17962 else if (*p == '"')
17964 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17965 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17966 if (*p == '\\' && p[1] != NUL)
17967 ++p;
17968 if (*p == NUL)
17969 break;
17972 if (mb_nest == 0)
17974 if (*p == '[')
17975 ++br_nest;
17976 else if (*p == ']')
17977 --br_nest;
17980 if (br_nest == 0)
17982 if (*p == '{')
17984 mb_nest++;
17985 if (expr_start != NULL && *expr_start == NULL)
17986 *expr_start = p;
17988 else if (*p == '}')
17990 mb_nest--;
17991 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
17992 *expr_end = p;
17997 return p;
18001 * Expands out the 'magic' {}'s in a variable/function name.
18002 * Note that this can call itself recursively, to deal with
18003 * constructs like foo{bar}{baz}{bam}
18004 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18005 * "in_start" ^
18006 * "expr_start" ^
18007 * "expr_end" ^
18008 * "in_end" ^
18010 * Returns a new allocated string, which the caller must free.
18011 * Returns NULL for failure.
18013 static char_u *
18014 make_expanded_name(in_start, expr_start, expr_end, in_end)
18015 char_u *in_start;
18016 char_u *expr_start;
18017 char_u *expr_end;
18018 char_u *in_end;
18020 char_u c1;
18021 char_u *retval = NULL;
18022 char_u *temp_result;
18023 char_u *nextcmd = NULL;
18025 if (expr_end == NULL || in_end == NULL)
18026 return NULL;
18027 *expr_start = NUL;
18028 *expr_end = NUL;
18029 c1 = *in_end;
18030 *in_end = NUL;
18032 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18033 if (temp_result != NULL && nextcmd == NULL)
18035 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18036 + (in_end - expr_end) + 1));
18037 if (retval != NULL)
18039 STRCPY(retval, in_start);
18040 STRCAT(retval, temp_result);
18041 STRCAT(retval, expr_end + 1);
18044 vim_free(temp_result);
18046 *in_end = c1; /* put char back for error messages */
18047 *expr_start = '{';
18048 *expr_end = '}';
18050 if (retval != NULL)
18052 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18053 if (expr_start != NULL)
18055 /* Further expansion! */
18056 temp_result = make_expanded_name(retval, expr_start,
18057 expr_end, temp_result);
18058 vim_free(retval);
18059 retval = temp_result;
18063 return retval;
18067 * Return TRUE if character "c" can be used in a variable or function name.
18068 * Does not include '{' or '}' for magic braces.
18070 static int
18071 eval_isnamec(c)
18072 int c;
18074 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18078 * Return TRUE if character "c" can be used as the first character in a
18079 * variable or function name (excluding '{' and '}').
18081 static int
18082 eval_isnamec1(c)
18083 int c;
18085 return (ASCII_ISALPHA(c) || c == '_');
18089 * Set number v: variable to "val".
18091 void
18092 set_vim_var_nr(idx, val)
18093 int idx;
18094 long val;
18096 vimvars[idx].vv_nr = val;
18100 * Get number v: variable value.
18102 long
18103 get_vim_var_nr(idx)
18104 int idx;
18106 return vimvars[idx].vv_nr;
18110 * Get string v: variable value. Uses a static buffer, can only be used once.
18112 char_u *
18113 get_vim_var_str(idx)
18114 int idx;
18116 return get_tv_string(&vimvars[idx].vv_tv);
18120 * Set v:count, v:count1 and v:prevcount.
18122 void
18123 set_vcount(count, count1)
18124 long count;
18125 long count1;
18127 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18128 vimvars[VV_COUNT].vv_nr = count;
18129 vimvars[VV_COUNT1].vv_nr = count1;
18133 * Set string v: variable to a copy of "val".
18135 void
18136 set_vim_var_string(idx, val, len)
18137 int idx;
18138 char_u *val;
18139 int len; /* length of "val" to use or -1 (whole string) */
18141 /* Need to do this (at least) once, since we can't initialize a union.
18142 * Will always be invoked when "v:progname" is set. */
18143 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18145 vim_free(vimvars[idx].vv_str);
18146 if (val == NULL)
18147 vimvars[idx].vv_str = NULL;
18148 else if (len == -1)
18149 vimvars[idx].vv_str = vim_strsave(val);
18150 else
18151 vimvars[idx].vv_str = vim_strnsave(val, len);
18155 * Set v:register if needed.
18157 void
18158 set_reg_var(c)
18159 int c;
18161 char_u regname;
18163 if (c == 0 || c == ' ')
18164 regname = '"';
18165 else
18166 regname = c;
18167 /* Avoid free/alloc when the value is already right. */
18168 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18169 set_vim_var_string(VV_REG, &regname, 1);
18173 * Get or set v:exception. If "oldval" == NULL, return the current value.
18174 * Otherwise, restore the value to "oldval" and return NULL.
18175 * Must always be called in pairs to save and restore v:exception! Does not
18176 * take care of memory allocations.
18178 char_u *
18179 v_exception(oldval)
18180 char_u *oldval;
18182 if (oldval == NULL)
18183 return vimvars[VV_EXCEPTION].vv_str;
18185 vimvars[VV_EXCEPTION].vv_str = oldval;
18186 return NULL;
18190 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18191 * Otherwise, restore the value to "oldval" and return NULL.
18192 * Must always be called in pairs to save and restore v:throwpoint! Does not
18193 * take care of memory allocations.
18195 char_u *
18196 v_throwpoint(oldval)
18197 char_u *oldval;
18199 if (oldval == NULL)
18200 return vimvars[VV_THROWPOINT].vv_str;
18202 vimvars[VV_THROWPOINT].vv_str = oldval;
18203 return NULL;
18206 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18208 * Set v:cmdarg.
18209 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18210 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18211 * Must always be called in pairs!
18213 char_u *
18214 set_cmdarg(eap, oldarg)
18215 exarg_T *eap;
18216 char_u *oldarg;
18218 char_u *oldval;
18219 char_u *newval;
18220 unsigned len;
18222 oldval = vimvars[VV_CMDARG].vv_str;
18223 if (eap == NULL)
18225 vim_free(oldval);
18226 vimvars[VV_CMDARG].vv_str = oldarg;
18227 return NULL;
18230 if (eap->force_bin == FORCE_BIN)
18231 len = 6;
18232 else if (eap->force_bin == FORCE_NOBIN)
18233 len = 8;
18234 else
18235 len = 0;
18237 if (eap->read_edit)
18238 len += 7;
18240 if (eap->force_ff != 0)
18241 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18242 # ifdef FEAT_MBYTE
18243 if (eap->force_enc != 0)
18244 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18245 if (eap->bad_char != 0)
18246 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18247 # endif
18249 newval = alloc(len + 1);
18250 if (newval == NULL)
18251 return NULL;
18253 if (eap->force_bin == FORCE_BIN)
18254 sprintf((char *)newval, " ++bin");
18255 else if (eap->force_bin == FORCE_NOBIN)
18256 sprintf((char *)newval, " ++nobin");
18257 else
18258 *newval = NUL;
18260 if (eap->read_edit)
18261 STRCAT(newval, " ++edit");
18263 if (eap->force_ff != 0)
18264 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18265 eap->cmd + eap->force_ff);
18266 # ifdef FEAT_MBYTE
18267 if (eap->force_enc != 0)
18268 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18269 eap->cmd + eap->force_enc);
18270 if (eap->bad_char != 0)
18271 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18272 eap->cmd + eap->bad_char);
18273 # endif
18274 vimvars[VV_CMDARG].vv_str = newval;
18275 return oldval;
18277 #endif
18280 * Get the value of internal variable "name".
18281 * Return OK or FAIL.
18283 static int
18284 get_var_tv(name, len, rettv, verbose)
18285 char_u *name;
18286 int len; /* length of "name" */
18287 typval_T *rettv; /* NULL when only checking existence */
18288 int verbose; /* may give error message */
18290 int ret = OK;
18291 typval_T *tv = NULL;
18292 typval_T atv;
18293 dictitem_T *v;
18294 int cc;
18296 /* truncate the name, so that we can use strcmp() */
18297 cc = name[len];
18298 name[len] = NUL;
18301 * Check for "b:changedtick".
18303 if (STRCMP(name, "b:changedtick") == 0)
18305 atv.v_type = VAR_NUMBER;
18306 atv.vval.v_number = curbuf->b_changedtick;
18307 tv = &atv;
18311 * Check for user-defined variables.
18313 else
18315 v = find_var(name, NULL);
18316 if (v != NULL)
18317 tv = &v->di_tv;
18320 if (tv == NULL)
18322 if (rettv != NULL && verbose)
18323 EMSG2(_(e_undefvar), name);
18324 ret = FAIL;
18326 else if (rettv != NULL)
18327 copy_tv(tv, rettv);
18329 name[len] = cc;
18331 return ret;
18335 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18336 * Also handle function call with Funcref variable: func(expr)
18337 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18339 static int
18340 handle_subscript(arg, rettv, evaluate, verbose)
18341 char_u **arg;
18342 typval_T *rettv;
18343 int evaluate; /* do more than finding the end */
18344 int verbose; /* give error messages */
18346 int ret = OK;
18347 dict_T *selfdict = NULL;
18348 char_u *s;
18349 int len;
18350 typval_T functv;
18352 while (ret == OK
18353 && (**arg == '['
18354 || (**arg == '.' && rettv->v_type == VAR_DICT)
18355 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18356 && !vim_iswhite(*(*arg - 1)))
18358 if (**arg == '(')
18360 /* need to copy the funcref so that we can clear rettv */
18361 functv = *rettv;
18362 rettv->v_type = VAR_UNKNOWN;
18364 /* Invoke the function. Recursive! */
18365 s = functv.vval.v_string;
18366 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18367 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18368 &len, evaluate, selfdict);
18370 /* Clear the funcref afterwards, so that deleting it while
18371 * evaluating the arguments is possible (see test55). */
18372 clear_tv(&functv);
18374 /* Stop the expression evaluation when immediately aborting on
18375 * error, or when an interrupt occurred or an exception was thrown
18376 * but not caught. */
18377 if (aborting())
18379 if (ret == OK)
18380 clear_tv(rettv);
18381 ret = FAIL;
18383 dict_unref(selfdict);
18384 selfdict = NULL;
18386 else /* **arg == '[' || **arg == '.' */
18388 dict_unref(selfdict);
18389 if (rettv->v_type == VAR_DICT)
18391 selfdict = rettv->vval.v_dict;
18392 if (selfdict != NULL)
18393 ++selfdict->dv_refcount;
18395 else
18396 selfdict = NULL;
18397 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18399 clear_tv(rettv);
18400 ret = FAIL;
18404 dict_unref(selfdict);
18405 return ret;
18409 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18410 * value).
18412 static typval_T *
18413 alloc_tv()
18415 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18419 * Allocate memory for a variable type-value, and assign a string to it.
18420 * The string "s" must have been allocated, it is consumed.
18421 * Return NULL for out of memory, the variable otherwise.
18423 static typval_T *
18424 alloc_string_tv(s)
18425 char_u *s;
18427 typval_T *rettv;
18429 rettv = alloc_tv();
18430 if (rettv != NULL)
18432 rettv->v_type = VAR_STRING;
18433 rettv->vval.v_string = s;
18435 else
18436 vim_free(s);
18437 return rettv;
18441 * Free the memory for a variable type-value.
18443 void
18444 free_tv(varp)
18445 typval_T *varp;
18447 if (varp != NULL)
18449 switch (varp->v_type)
18451 case VAR_FUNC:
18452 func_unref(varp->vval.v_string);
18453 /*FALLTHROUGH*/
18454 case VAR_STRING:
18455 vim_free(varp->vval.v_string);
18456 break;
18457 case VAR_LIST:
18458 list_unref(varp->vval.v_list);
18459 break;
18460 case VAR_DICT:
18461 dict_unref(varp->vval.v_dict);
18462 break;
18463 case VAR_NUMBER:
18464 #ifdef FEAT_FLOAT
18465 case VAR_FLOAT:
18466 #endif
18467 case VAR_UNKNOWN:
18468 break;
18469 default:
18470 EMSG2(_(e_intern2), "free_tv()");
18471 break;
18473 vim_free(varp);
18478 * Free the memory for a variable value and set the value to NULL or 0.
18480 void
18481 clear_tv(varp)
18482 typval_T *varp;
18484 if (varp != NULL)
18486 switch (varp->v_type)
18488 case VAR_FUNC:
18489 func_unref(varp->vval.v_string);
18490 /*FALLTHROUGH*/
18491 case VAR_STRING:
18492 vim_free(varp->vval.v_string);
18493 varp->vval.v_string = NULL;
18494 break;
18495 case VAR_LIST:
18496 list_unref(varp->vval.v_list);
18497 varp->vval.v_list = NULL;
18498 break;
18499 case VAR_DICT:
18500 dict_unref(varp->vval.v_dict);
18501 varp->vval.v_dict = NULL;
18502 break;
18503 case VAR_NUMBER:
18504 varp->vval.v_number = 0;
18505 break;
18506 #ifdef FEAT_FLOAT
18507 case VAR_FLOAT:
18508 varp->vval.v_float = 0.0;
18509 break;
18510 #endif
18511 case VAR_UNKNOWN:
18512 break;
18513 default:
18514 EMSG2(_(e_intern2), "clear_tv()");
18516 varp->v_lock = 0;
18521 * Set the value of a variable to NULL without freeing items.
18523 static void
18524 init_tv(varp)
18525 typval_T *varp;
18527 if (varp != NULL)
18528 vim_memset(varp, 0, sizeof(typval_T));
18532 * Get the number value of a variable.
18533 * If it is a String variable, uses vim_str2nr().
18534 * For incompatible types, return 0.
18535 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18536 * caller of incompatible types: it sets *denote to TRUE if "denote"
18537 * is not NULL or returns -1 otherwise.
18539 static long
18540 get_tv_number(varp)
18541 typval_T *varp;
18543 int error = FALSE;
18545 return get_tv_number_chk(varp, &error); /* return 0L on error */
18548 long
18549 get_tv_number_chk(varp, denote)
18550 typval_T *varp;
18551 int *denote;
18553 long n = 0L;
18555 switch (varp->v_type)
18557 case VAR_NUMBER:
18558 return (long)(varp->vval.v_number);
18559 #ifdef FEAT_FLOAT
18560 case VAR_FLOAT:
18561 EMSG(_("E805: Using a Float as a Number"));
18562 break;
18563 #endif
18564 case VAR_FUNC:
18565 EMSG(_("E703: Using a Funcref as a Number"));
18566 break;
18567 case VAR_STRING:
18568 if (varp->vval.v_string != NULL)
18569 vim_str2nr(varp->vval.v_string, NULL, NULL,
18570 TRUE, TRUE, &n, NULL);
18571 return n;
18572 case VAR_LIST:
18573 EMSG(_("E745: Using a List as a Number"));
18574 break;
18575 case VAR_DICT:
18576 EMSG(_("E728: Using a Dictionary as a Number"));
18577 break;
18578 default:
18579 EMSG2(_(e_intern2), "get_tv_number()");
18580 break;
18582 if (denote == NULL) /* useful for values that must be unsigned */
18583 n = -1;
18584 else
18585 *denote = TRUE;
18586 return n;
18590 * Get the lnum from the first argument.
18591 * Also accepts ".", "$", etc., but that only works for the current buffer.
18592 * Returns -1 on error.
18594 static linenr_T
18595 get_tv_lnum(argvars)
18596 typval_T *argvars;
18598 typval_T rettv;
18599 linenr_T lnum;
18601 lnum = get_tv_number_chk(&argvars[0], NULL);
18602 if (lnum == 0) /* no valid number, try using line() */
18604 rettv.v_type = VAR_NUMBER;
18605 f_line(argvars, &rettv);
18606 lnum = rettv.vval.v_number;
18607 clear_tv(&rettv);
18609 return lnum;
18613 * Get the lnum from the first argument.
18614 * Also accepts "$", then "buf" is used.
18615 * Returns 0 on error.
18617 static linenr_T
18618 get_tv_lnum_buf(argvars, buf)
18619 typval_T *argvars;
18620 buf_T *buf;
18622 if (argvars[0].v_type == VAR_STRING
18623 && argvars[0].vval.v_string != NULL
18624 && argvars[0].vval.v_string[0] == '$'
18625 && buf != NULL)
18626 return buf->b_ml.ml_line_count;
18627 return get_tv_number_chk(&argvars[0], NULL);
18631 * Get the string value of a variable.
18632 * If it is a Number variable, the number is converted into a string.
18633 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18634 * get_tv_string_buf() uses a given buffer.
18635 * If the String variable has never been set, return an empty string.
18636 * Never returns NULL;
18637 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18638 * NULL on error.
18640 static char_u *
18641 get_tv_string(varp)
18642 typval_T *varp;
18644 static char_u mybuf[NUMBUFLEN];
18646 return get_tv_string_buf(varp, mybuf);
18649 static char_u *
18650 get_tv_string_buf(varp, buf)
18651 typval_T *varp;
18652 char_u *buf;
18654 char_u *res = get_tv_string_buf_chk(varp, buf);
18656 return res != NULL ? res : (char_u *)"";
18659 char_u *
18660 get_tv_string_chk(varp)
18661 typval_T *varp;
18663 static char_u mybuf[NUMBUFLEN];
18665 return get_tv_string_buf_chk(varp, mybuf);
18668 static char_u *
18669 get_tv_string_buf_chk(varp, buf)
18670 typval_T *varp;
18671 char_u *buf;
18673 switch (varp->v_type)
18675 case VAR_NUMBER:
18676 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18677 return buf;
18678 case VAR_FUNC:
18679 EMSG(_("E729: using Funcref as a String"));
18680 break;
18681 case VAR_LIST:
18682 EMSG(_("E730: using List as a String"));
18683 break;
18684 case VAR_DICT:
18685 EMSG(_("E731: using Dictionary as a String"));
18686 break;
18687 #ifdef FEAT_FLOAT
18688 case VAR_FLOAT:
18689 EMSG(_("E806: using Float as a String"));
18690 break;
18691 #endif
18692 case VAR_STRING:
18693 if (varp->vval.v_string != NULL)
18694 return varp->vval.v_string;
18695 return (char_u *)"";
18696 default:
18697 EMSG2(_(e_intern2), "get_tv_string_buf()");
18698 break;
18700 return NULL;
18704 * Find variable "name" in the list of variables.
18705 * Return a pointer to it if found, NULL if not found.
18706 * Careful: "a:0" variables don't have a name.
18707 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18708 * hashtab_T used.
18710 static dictitem_T *
18711 find_var(name, htp)
18712 char_u *name;
18713 hashtab_T **htp;
18715 char_u *varname;
18716 hashtab_T *ht;
18718 ht = find_var_ht(name, &varname);
18719 if (htp != NULL)
18720 *htp = ht;
18721 if (ht == NULL)
18722 return NULL;
18723 return find_var_in_ht(ht, varname, htp != NULL);
18727 * Find variable "varname" in hashtab "ht".
18728 * Returns NULL if not found.
18730 static dictitem_T *
18731 find_var_in_ht(ht, varname, writing)
18732 hashtab_T *ht;
18733 char_u *varname;
18734 int writing;
18736 hashitem_T *hi;
18738 if (*varname == NUL)
18740 /* Must be something like "s:", otherwise "ht" would be NULL. */
18741 switch (varname[-2])
18743 case 's': return &SCRIPT_SV(current_SID).sv_var;
18744 case 'g': return &globvars_var;
18745 case 'v': return &vimvars_var;
18746 case 'b': return &curbuf->b_bufvar;
18747 case 'w': return &curwin->w_winvar;
18748 #ifdef FEAT_WINDOWS
18749 case 't': return &curtab->tp_winvar;
18750 #endif
18751 case 'l': return current_funccal == NULL
18752 ? NULL : &current_funccal->l_vars_var;
18753 case 'a': return current_funccal == NULL
18754 ? NULL : &current_funccal->l_avars_var;
18756 return NULL;
18759 hi = hash_find(ht, varname);
18760 if (HASHITEM_EMPTY(hi))
18762 /* For global variables we may try auto-loading the script. If it
18763 * worked find the variable again. Don't auto-load a script if it was
18764 * loaded already, otherwise it would be loaded every time when
18765 * checking if a function name is a Funcref variable. */
18766 if (ht == &globvarht && !writing
18767 && script_autoload(varname, FALSE) && !aborting())
18768 hi = hash_find(ht, varname);
18769 if (HASHITEM_EMPTY(hi))
18770 return NULL;
18772 return HI2DI(hi);
18776 * Find the hashtab used for a variable name.
18777 * Set "varname" to the start of name without ':'.
18779 static hashtab_T *
18780 find_var_ht(name, varname)
18781 char_u *name;
18782 char_u **varname;
18784 hashitem_T *hi;
18786 if (name[1] != ':')
18788 /* The name must not start with a colon or #. */
18789 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18790 return NULL;
18791 *varname = name;
18793 /* "version" is "v:version" in all scopes */
18794 hi = hash_find(&compat_hashtab, name);
18795 if (!HASHITEM_EMPTY(hi))
18796 return &compat_hashtab;
18798 if (current_funccal == NULL)
18799 return &globvarht; /* global variable */
18800 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18802 *varname = name + 2;
18803 if (*name == 'g') /* global variable */
18804 return &globvarht;
18805 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18807 if (vim_strchr(name + 2, ':') != NULL
18808 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18809 return NULL;
18810 if (*name == 'b') /* buffer variable */
18811 return &curbuf->b_vars.dv_hashtab;
18812 if (*name == 'w') /* window variable */
18813 return &curwin->w_vars.dv_hashtab;
18814 #ifdef FEAT_WINDOWS
18815 if (*name == 't') /* tab page variable */
18816 return &curtab->tp_vars.dv_hashtab;
18817 #endif
18818 if (*name == 'v') /* v: variable */
18819 return &vimvarht;
18820 if (*name == 'a' && current_funccal != NULL) /* function argument */
18821 return &current_funccal->l_avars.dv_hashtab;
18822 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18823 return &current_funccal->l_vars.dv_hashtab;
18824 if (*name == 's' /* script variable */
18825 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18826 return &SCRIPT_VARS(current_SID);
18827 return NULL;
18831 * Get the string value of a (global/local) variable.
18832 * Returns NULL when it doesn't exist.
18834 char_u *
18835 get_var_value(name)
18836 char_u *name;
18838 dictitem_T *v;
18840 v = find_var(name, NULL);
18841 if (v == NULL)
18842 return NULL;
18843 return get_tv_string(&v->di_tv);
18847 * Allocate a new hashtab for a sourced script. It will be used while
18848 * sourcing this script and when executing functions defined in the script.
18850 void
18851 new_script_vars(id)
18852 scid_T id;
18854 int i;
18855 hashtab_T *ht;
18856 scriptvar_T *sv;
18858 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18860 /* Re-allocating ga_data means that an ht_array pointing to
18861 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18862 * at its init value. Also reset "v_dict", it's always the same. */
18863 for (i = 1; i <= ga_scripts.ga_len; ++i)
18865 ht = &SCRIPT_VARS(i);
18866 if (ht->ht_mask == HT_INIT_SIZE - 1)
18867 ht->ht_array = ht->ht_smallarray;
18868 sv = &SCRIPT_SV(i);
18869 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18872 while (ga_scripts.ga_len < id)
18874 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18875 init_var_dict(&sv->sv_dict, &sv->sv_var);
18876 ++ga_scripts.ga_len;
18882 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18883 * point to it.
18885 void
18886 init_var_dict(dict, dict_var)
18887 dict_T *dict;
18888 dictitem_T *dict_var;
18890 hash_init(&dict->dv_hashtab);
18891 dict->dv_refcount = 99999;
18892 dict_var->di_tv.vval.v_dict = dict;
18893 dict_var->di_tv.v_type = VAR_DICT;
18894 dict_var->di_tv.v_lock = VAR_FIXED;
18895 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18896 dict_var->di_key[0] = NUL;
18900 * Clean up a list of internal variables.
18901 * Frees all allocated variables and the value they contain.
18902 * Clears hashtab "ht", does not free it.
18904 void
18905 vars_clear(ht)
18906 hashtab_T *ht;
18908 vars_clear_ext(ht, TRUE);
18912 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18914 static void
18915 vars_clear_ext(ht, free_val)
18916 hashtab_T *ht;
18917 int free_val;
18919 int todo;
18920 hashitem_T *hi;
18921 dictitem_T *v;
18923 hash_lock(ht);
18924 todo = (int)ht->ht_used;
18925 for (hi = ht->ht_array; todo > 0; ++hi)
18927 if (!HASHITEM_EMPTY(hi))
18929 --todo;
18931 /* Free the variable. Don't remove it from the hashtab,
18932 * ht_array might change then. hash_clear() takes care of it
18933 * later. */
18934 v = HI2DI(hi);
18935 if (free_val)
18936 clear_tv(&v->di_tv);
18937 if ((v->di_flags & DI_FLAGS_FIX) == 0)
18938 vim_free(v);
18941 hash_clear(ht);
18942 ht->ht_used = 0;
18946 * Delete a variable from hashtab "ht" at item "hi".
18947 * Clear the variable value and free the dictitem.
18949 static void
18950 delete_var(ht, hi)
18951 hashtab_T *ht;
18952 hashitem_T *hi;
18954 dictitem_T *di = HI2DI(hi);
18956 hash_remove(ht, hi);
18957 clear_tv(&di->di_tv);
18958 vim_free(di);
18962 * List the value of one internal variable.
18964 static void
18965 list_one_var(v, prefix, first)
18966 dictitem_T *v;
18967 char_u *prefix;
18968 int *first;
18970 char_u *tofree;
18971 char_u *s;
18972 char_u numbuf[NUMBUFLEN];
18974 s = echo_string(&v->di_tv, &tofree, numbuf, ++current_copyID);
18975 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
18976 s == NULL ? (char_u *)"" : s, first);
18977 vim_free(tofree);
18980 static void
18981 list_one_var_a(prefix, name, type, string, first)
18982 char_u *prefix;
18983 char_u *name;
18984 int type;
18985 char_u *string;
18986 int *first; /* when TRUE clear rest of screen and set to FALSE */
18988 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
18989 msg_start();
18990 msg_puts(prefix);
18991 if (name != NULL) /* "a:" vars don't have a name stored */
18992 msg_puts(name);
18993 msg_putchar(' ');
18994 msg_advance(22);
18995 if (type == VAR_NUMBER)
18996 msg_putchar('#');
18997 else if (type == VAR_FUNC)
18998 msg_putchar('*');
18999 else if (type == VAR_LIST)
19001 msg_putchar('[');
19002 if (*string == '[')
19003 ++string;
19005 else if (type == VAR_DICT)
19007 msg_putchar('{');
19008 if (*string == '{')
19009 ++string;
19011 else
19012 msg_putchar(' ');
19014 msg_outtrans(string);
19016 if (type == VAR_FUNC)
19017 msg_puts((char_u *)"()");
19018 if (*first)
19020 msg_clr_eos();
19021 *first = FALSE;
19026 * Set variable "name" to value in "tv".
19027 * If the variable already exists, the value is updated.
19028 * Otherwise the variable is created.
19030 static void
19031 set_var(name, tv, copy)
19032 char_u *name;
19033 typval_T *tv;
19034 int copy; /* make copy of value in "tv" */
19036 dictitem_T *v;
19037 char_u *varname;
19038 hashtab_T *ht;
19039 char_u *p;
19041 if (tv->v_type == VAR_FUNC)
19043 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19044 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19045 ? name[2] : name[0]))
19047 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19048 return;
19050 if (function_exists(name))
19052 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19053 name);
19054 return;
19058 ht = find_var_ht(name, &varname);
19059 if (ht == NULL || *varname == NUL)
19061 EMSG2(_(e_illvar), name);
19062 return;
19065 v = find_var_in_ht(ht, varname, TRUE);
19066 if (v != NULL)
19068 /* existing variable, need to clear the value */
19069 if (var_check_ro(v->di_flags, name)
19070 || tv_check_lock(v->di_tv.v_lock, name))
19071 return;
19072 if (v->di_tv.v_type != tv->v_type
19073 && !((v->di_tv.v_type == VAR_STRING
19074 || v->di_tv.v_type == VAR_NUMBER)
19075 && (tv->v_type == VAR_STRING
19076 || tv->v_type == VAR_NUMBER))
19077 #ifdef FEAT_FLOAT
19078 && !((v->di_tv.v_type == VAR_NUMBER
19079 || v->di_tv.v_type == VAR_FLOAT)
19080 && (tv->v_type == VAR_NUMBER
19081 || tv->v_type == VAR_FLOAT))
19082 #endif
19085 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19086 return;
19090 * Handle setting internal v: variables separately: we don't change
19091 * the type.
19093 if (ht == &vimvarht)
19095 if (v->di_tv.v_type == VAR_STRING)
19097 vim_free(v->di_tv.vval.v_string);
19098 if (copy || tv->v_type != VAR_STRING)
19099 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19100 else
19102 /* Take over the string to avoid an extra alloc/free. */
19103 v->di_tv.vval.v_string = tv->vval.v_string;
19104 tv->vval.v_string = NULL;
19107 else if (v->di_tv.v_type != VAR_NUMBER)
19108 EMSG2(_(e_intern2), "set_var()");
19109 else
19111 v->di_tv.vval.v_number = get_tv_number(tv);
19112 if (STRCMP(varname, "searchforward") == 0)
19113 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19115 return;
19118 clear_tv(&v->di_tv);
19120 else /* add a new variable */
19122 /* Can't add "v:" variable. */
19123 if (ht == &vimvarht)
19125 EMSG2(_(e_illvar), name);
19126 return;
19129 /* Make sure the variable name is valid. */
19130 for (p = varname; *p != NUL; ++p)
19131 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19132 && *p != AUTOLOAD_CHAR)
19134 EMSG2(_(e_illvar), varname);
19135 return;
19138 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19139 + STRLEN(varname)));
19140 if (v == NULL)
19141 return;
19142 STRCPY(v->di_key, varname);
19143 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19145 vim_free(v);
19146 return;
19148 v->di_flags = 0;
19151 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19152 copy_tv(tv, &v->di_tv);
19153 else
19155 v->di_tv = *tv;
19156 v->di_tv.v_lock = 0;
19157 init_tv(tv);
19162 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19163 * Also give an error message.
19165 static int
19166 var_check_ro(flags, name)
19167 int flags;
19168 char_u *name;
19170 if (flags & DI_FLAGS_RO)
19172 EMSG2(_(e_readonlyvar), name);
19173 return TRUE;
19175 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19177 EMSG2(_(e_readonlysbx), name);
19178 return TRUE;
19180 return FALSE;
19184 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19185 * Also give an error message.
19187 static int
19188 var_check_fixed(flags, name)
19189 int flags;
19190 char_u *name;
19192 if (flags & DI_FLAGS_FIX)
19194 EMSG2(_("E795: Cannot delete variable %s"), name);
19195 return TRUE;
19197 return FALSE;
19201 * Return TRUE if typeval "tv" is set to be locked (immutable).
19202 * Also give an error message, using "name".
19204 static int
19205 tv_check_lock(lock, name)
19206 int lock;
19207 char_u *name;
19209 if (lock & VAR_LOCKED)
19211 EMSG2(_("E741: Value is locked: %s"),
19212 name == NULL ? (char_u *)_("Unknown") : name);
19213 return TRUE;
19215 if (lock & VAR_FIXED)
19217 EMSG2(_("E742: Cannot change value of %s"),
19218 name == NULL ? (char_u *)_("Unknown") : name);
19219 return TRUE;
19221 return FALSE;
19225 * Copy the values from typval_T "from" to typval_T "to".
19226 * When needed allocates string or increases reference count.
19227 * Does not make a copy of a list or dict but copies the reference!
19229 static void
19230 copy_tv(from, to)
19231 typval_T *from;
19232 typval_T *to;
19234 to->v_type = from->v_type;
19235 to->v_lock = 0;
19236 switch (from->v_type)
19238 case VAR_NUMBER:
19239 to->vval.v_number = from->vval.v_number;
19240 break;
19241 #ifdef FEAT_FLOAT
19242 case VAR_FLOAT:
19243 to->vval.v_float = from->vval.v_float;
19244 break;
19245 #endif
19246 case VAR_STRING:
19247 case VAR_FUNC:
19248 if (from->vval.v_string == NULL)
19249 to->vval.v_string = NULL;
19250 else
19252 to->vval.v_string = vim_strsave(from->vval.v_string);
19253 if (from->v_type == VAR_FUNC)
19254 func_ref(to->vval.v_string);
19256 break;
19257 case VAR_LIST:
19258 if (from->vval.v_list == NULL)
19259 to->vval.v_list = NULL;
19260 else
19262 to->vval.v_list = from->vval.v_list;
19263 ++to->vval.v_list->lv_refcount;
19265 break;
19266 case VAR_DICT:
19267 if (from->vval.v_dict == NULL)
19268 to->vval.v_dict = NULL;
19269 else
19271 to->vval.v_dict = from->vval.v_dict;
19272 ++to->vval.v_dict->dv_refcount;
19274 break;
19275 default:
19276 EMSG2(_(e_intern2), "copy_tv()");
19277 break;
19282 * Make a copy of an item.
19283 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19284 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19285 * reference to an already copied list/dict can be used.
19286 * Returns FAIL or OK.
19288 static int
19289 item_copy(from, to, deep, copyID)
19290 typval_T *from;
19291 typval_T *to;
19292 int deep;
19293 int copyID;
19295 static int recurse = 0;
19296 int ret = OK;
19298 if (recurse >= DICT_MAXNEST)
19300 EMSG(_("E698: variable nested too deep for making a copy"));
19301 return FAIL;
19303 ++recurse;
19305 switch (from->v_type)
19307 case VAR_NUMBER:
19308 #ifdef FEAT_FLOAT
19309 case VAR_FLOAT:
19310 #endif
19311 case VAR_STRING:
19312 case VAR_FUNC:
19313 copy_tv(from, to);
19314 break;
19315 case VAR_LIST:
19316 to->v_type = VAR_LIST;
19317 to->v_lock = 0;
19318 if (from->vval.v_list == NULL)
19319 to->vval.v_list = NULL;
19320 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19322 /* use the copy made earlier */
19323 to->vval.v_list = from->vval.v_list->lv_copylist;
19324 ++to->vval.v_list->lv_refcount;
19326 else
19327 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19328 if (to->vval.v_list == NULL)
19329 ret = FAIL;
19330 break;
19331 case VAR_DICT:
19332 to->v_type = VAR_DICT;
19333 to->v_lock = 0;
19334 if (from->vval.v_dict == NULL)
19335 to->vval.v_dict = NULL;
19336 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19338 /* use the copy made earlier */
19339 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19340 ++to->vval.v_dict->dv_refcount;
19342 else
19343 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19344 if (to->vval.v_dict == NULL)
19345 ret = FAIL;
19346 break;
19347 default:
19348 EMSG2(_(e_intern2), "item_copy()");
19349 ret = FAIL;
19351 --recurse;
19352 return ret;
19356 * ":echo expr1 ..." print each argument separated with a space, add a
19357 * newline at the end.
19358 * ":echon expr1 ..." print each argument plain.
19360 void
19361 ex_echo(eap)
19362 exarg_T *eap;
19364 char_u *arg = eap->arg;
19365 typval_T rettv;
19366 char_u *tofree;
19367 char_u *p;
19368 int needclr = TRUE;
19369 int atstart = TRUE;
19370 char_u numbuf[NUMBUFLEN];
19372 if (eap->skip)
19373 ++emsg_skip;
19374 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19376 /* If eval1() causes an error message the text from the command may
19377 * still need to be cleared. E.g., "echo 22,44". */
19378 need_clr_eos = needclr;
19380 p = arg;
19381 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19384 * Report the invalid expression unless the expression evaluation
19385 * has been cancelled due to an aborting error, an interrupt, or an
19386 * exception.
19388 if (!aborting())
19389 EMSG2(_(e_invexpr2), p);
19390 need_clr_eos = FALSE;
19391 break;
19393 need_clr_eos = FALSE;
19395 if (!eap->skip)
19397 if (atstart)
19399 atstart = FALSE;
19400 /* Call msg_start() after eval1(), evaluating the expression
19401 * may cause a message to appear. */
19402 if (eap->cmdidx == CMD_echo)
19403 msg_start();
19405 else if (eap->cmdidx == CMD_echo)
19406 msg_puts_attr((char_u *)" ", echo_attr);
19407 p = echo_string(&rettv, &tofree, numbuf, ++current_copyID);
19408 if (p != NULL)
19409 for ( ; *p != NUL && !got_int; ++p)
19411 if (*p == '\n' || *p == '\r' || *p == TAB)
19413 if (*p != TAB && needclr)
19415 /* remove any text still there from the command */
19416 msg_clr_eos();
19417 needclr = FALSE;
19419 msg_putchar_attr(*p, echo_attr);
19421 else
19423 #ifdef FEAT_MBYTE
19424 if (has_mbyte)
19426 int i = (*mb_ptr2len)(p);
19428 (void)msg_outtrans_len_attr(p, i, echo_attr);
19429 p += i - 1;
19431 else
19432 #endif
19433 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19436 vim_free(tofree);
19438 clear_tv(&rettv);
19439 arg = skipwhite(arg);
19441 eap->nextcmd = check_nextcmd(arg);
19443 if (eap->skip)
19444 --emsg_skip;
19445 else
19447 /* remove text that may still be there from the command */
19448 if (needclr)
19449 msg_clr_eos();
19450 if (eap->cmdidx == CMD_echo)
19451 msg_end();
19456 * ":echohl {name}".
19458 void
19459 ex_echohl(eap)
19460 exarg_T *eap;
19462 int id;
19464 id = syn_name2id(eap->arg);
19465 if (id == 0)
19466 echo_attr = 0;
19467 else
19468 echo_attr = syn_id2attr(id);
19472 * ":execute expr1 ..." execute the result of an expression.
19473 * ":echomsg expr1 ..." Print a message
19474 * ":echoerr expr1 ..." Print an error
19475 * Each gets spaces around each argument and a newline at the end for
19476 * echo commands
19478 void
19479 ex_execute(eap)
19480 exarg_T *eap;
19482 char_u *arg = eap->arg;
19483 typval_T rettv;
19484 int ret = OK;
19485 char_u *p;
19486 garray_T ga;
19487 int len;
19488 int save_did_emsg;
19490 ga_init2(&ga, 1, 80);
19492 if (eap->skip)
19493 ++emsg_skip;
19494 while (*arg != NUL && *arg != '|' && *arg != '\n')
19496 p = arg;
19497 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19500 * Report the invalid expression unless the expression evaluation
19501 * has been cancelled due to an aborting error, an interrupt, or an
19502 * exception.
19504 if (!aborting())
19505 EMSG2(_(e_invexpr2), p);
19506 ret = FAIL;
19507 break;
19510 if (!eap->skip)
19512 p = get_tv_string(&rettv);
19513 len = (int)STRLEN(p);
19514 if (ga_grow(&ga, len + 2) == FAIL)
19516 clear_tv(&rettv);
19517 ret = FAIL;
19518 break;
19520 if (ga.ga_len)
19521 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19522 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19523 ga.ga_len += len;
19526 clear_tv(&rettv);
19527 arg = skipwhite(arg);
19530 if (ret != FAIL && ga.ga_data != NULL)
19532 if (eap->cmdidx == CMD_echomsg)
19534 MSG_ATTR(ga.ga_data, echo_attr);
19535 out_flush();
19537 else if (eap->cmdidx == CMD_echoerr)
19539 /* We don't want to abort following commands, restore did_emsg. */
19540 save_did_emsg = did_emsg;
19541 EMSG((char_u *)ga.ga_data);
19542 if (!force_abort)
19543 did_emsg = save_did_emsg;
19545 else if (eap->cmdidx == CMD_execute)
19546 do_cmdline((char_u *)ga.ga_data,
19547 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19550 ga_clear(&ga);
19552 if (eap->skip)
19553 --emsg_skip;
19555 eap->nextcmd = check_nextcmd(arg);
19559 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19560 * "arg" points to the "&" or '+' when called, to "option" when returning.
19561 * Returns NULL when no option name found. Otherwise pointer to the char
19562 * after the option name.
19564 static char_u *
19565 find_option_end(arg, opt_flags)
19566 char_u **arg;
19567 int *opt_flags;
19569 char_u *p = *arg;
19571 ++p;
19572 if (*p == 'g' && p[1] == ':')
19574 *opt_flags = OPT_GLOBAL;
19575 p += 2;
19577 else if (*p == 'l' && p[1] == ':')
19579 *opt_flags = OPT_LOCAL;
19580 p += 2;
19582 else
19583 *opt_flags = 0;
19585 if (!ASCII_ISALPHA(*p))
19586 return NULL;
19587 *arg = p;
19589 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19590 p += 4; /* termcap option */
19591 else
19592 while (ASCII_ISALPHA(*p))
19593 ++p;
19594 return p;
19598 * ":function"
19600 void
19601 ex_function(eap)
19602 exarg_T *eap;
19604 char_u *theline;
19605 int j;
19606 int c;
19607 int saved_did_emsg;
19608 char_u *name = NULL;
19609 char_u *p;
19610 char_u *arg;
19611 char_u *line_arg = NULL;
19612 garray_T newargs;
19613 garray_T newlines;
19614 int varargs = FALSE;
19615 int mustend = FALSE;
19616 int flags = 0;
19617 ufunc_T *fp;
19618 int indent;
19619 int nesting;
19620 char_u *skip_until = NULL;
19621 dictitem_T *v;
19622 funcdict_T fudi;
19623 static int func_nr = 0; /* number for nameless function */
19624 int paren;
19625 hashtab_T *ht;
19626 int todo;
19627 hashitem_T *hi;
19628 int sourcing_lnum_off;
19631 * ":function" without argument: list functions.
19633 if (ends_excmd(*eap->arg))
19635 if (!eap->skip)
19637 todo = (int)func_hashtab.ht_used;
19638 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19640 if (!HASHITEM_EMPTY(hi))
19642 --todo;
19643 fp = HI2UF(hi);
19644 if (!isdigit(*fp->uf_name))
19645 list_func_head(fp, FALSE);
19649 eap->nextcmd = check_nextcmd(eap->arg);
19650 return;
19654 * ":function /pat": list functions matching pattern.
19656 if (*eap->arg == '/')
19658 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19659 if (!eap->skip)
19661 regmatch_T regmatch;
19663 c = *p;
19664 *p = NUL;
19665 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19666 *p = c;
19667 if (regmatch.regprog != NULL)
19669 regmatch.rm_ic = p_ic;
19671 todo = (int)func_hashtab.ht_used;
19672 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19674 if (!HASHITEM_EMPTY(hi))
19676 --todo;
19677 fp = HI2UF(hi);
19678 if (!isdigit(*fp->uf_name)
19679 && vim_regexec(&regmatch, fp->uf_name, 0))
19680 list_func_head(fp, FALSE);
19685 if (*p == '/')
19686 ++p;
19687 eap->nextcmd = check_nextcmd(p);
19688 return;
19692 * Get the function name. There are these situations:
19693 * func normal function name
19694 * "name" == func, "fudi.fd_dict" == NULL
19695 * dict.func new dictionary entry
19696 * "name" == NULL, "fudi.fd_dict" set,
19697 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19698 * dict.func existing dict entry with a Funcref
19699 * "name" == func, "fudi.fd_dict" set,
19700 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19701 * dict.func existing dict entry that's not a Funcref
19702 * "name" == NULL, "fudi.fd_dict" set,
19703 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19705 p = eap->arg;
19706 name = trans_function_name(&p, eap->skip, 0, &fudi);
19707 paren = (vim_strchr(p, '(') != NULL);
19708 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19711 * Return on an invalid expression in braces, unless the expression
19712 * evaluation has been cancelled due to an aborting error, an
19713 * interrupt, or an exception.
19715 if (!aborting())
19717 if (!eap->skip && fudi.fd_newkey != NULL)
19718 EMSG2(_(e_dictkey), fudi.fd_newkey);
19719 vim_free(fudi.fd_newkey);
19720 return;
19722 else
19723 eap->skip = TRUE;
19726 /* An error in a function call during evaluation of an expression in magic
19727 * braces should not cause the function not to be defined. */
19728 saved_did_emsg = did_emsg;
19729 did_emsg = FALSE;
19732 * ":function func" with only function name: list function.
19734 if (!paren)
19736 if (!ends_excmd(*skipwhite(p)))
19738 EMSG(_(e_trailing));
19739 goto ret_free;
19741 eap->nextcmd = check_nextcmd(p);
19742 if (eap->nextcmd != NULL)
19743 *p = NUL;
19744 if (!eap->skip && !got_int)
19746 fp = find_func(name);
19747 if (fp != NULL)
19749 list_func_head(fp, TRUE);
19750 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19752 if (FUNCLINE(fp, j) == NULL)
19753 continue;
19754 msg_putchar('\n');
19755 msg_outnum((long)(j + 1));
19756 if (j < 9)
19757 msg_putchar(' ');
19758 if (j < 99)
19759 msg_putchar(' ');
19760 msg_prt_line(FUNCLINE(fp, j), FALSE);
19761 out_flush(); /* show a line at a time */
19762 ui_breakcheck();
19764 if (!got_int)
19766 msg_putchar('\n');
19767 msg_puts((char_u *)" endfunction");
19770 else
19771 emsg_funcname("E123: Undefined function: %s", name);
19773 goto ret_free;
19777 * ":function name(arg1, arg2)" Define function.
19779 p = skipwhite(p);
19780 if (*p != '(')
19782 if (!eap->skip)
19784 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19785 goto ret_free;
19787 /* attempt to continue by skipping some text */
19788 if (vim_strchr(p, '(') != NULL)
19789 p = vim_strchr(p, '(');
19791 p = skipwhite(p + 1);
19793 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19794 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19796 if (!eap->skip)
19798 /* Check the name of the function. Unless it's a dictionary function
19799 * (that we are overwriting). */
19800 if (name != NULL)
19801 arg = name;
19802 else
19803 arg = fudi.fd_newkey;
19804 if (arg != NULL && (fudi.fd_di == NULL
19805 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19807 if (*arg == K_SPECIAL)
19808 j = 3;
19809 else
19810 j = 0;
19811 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19812 : eval_isnamec(arg[j])))
19813 ++j;
19814 if (arg[j] != NUL)
19815 emsg_funcname(_(e_invarg2), arg);
19820 * Isolate the arguments: "arg1, arg2, ...)"
19822 while (*p != ')')
19824 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19826 varargs = TRUE;
19827 p += 3;
19828 mustend = TRUE;
19830 else
19832 arg = p;
19833 while (ASCII_ISALNUM(*p) || *p == '_')
19834 ++p;
19835 if (arg == p || isdigit(*arg)
19836 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19837 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19839 if (!eap->skip)
19840 EMSG2(_("E125: Illegal argument: %s"), arg);
19841 break;
19843 if (ga_grow(&newargs, 1) == FAIL)
19844 goto erret;
19845 c = *p;
19846 *p = NUL;
19847 arg = vim_strsave(arg);
19848 if (arg == NULL)
19849 goto erret;
19850 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19851 *p = c;
19852 newargs.ga_len++;
19853 if (*p == ',')
19854 ++p;
19855 else
19856 mustend = TRUE;
19858 p = skipwhite(p);
19859 if (mustend && *p != ')')
19861 if (!eap->skip)
19862 EMSG2(_(e_invarg2), eap->arg);
19863 break;
19866 ++p; /* skip the ')' */
19868 /* find extra arguments "range", "dict" and "abort" */
19869 for (;;)
19871 p = skipwhite(p);
19872 if (STRNCMP(p, "range", 5) == 0)
19874 flags |= FC_RANGE;
19875 p += 5;
19877 else if (STRNCMP(p, "dict", 4) == 0)
19879 flags |= FC_DICT;
19880 p += 4;
19882 else if (STRNCMP(p, "abort", 5) == 0)
19884 flags |= FC_ABORT;
19885 p += 5;
19887 else
19888 break;
19891 /* When there is a line break use what follows for the function body.
19892 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19893 if (*p == '\n')
19894 line_arg = p + 1;
19895 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19896 EMSG(_(e_trailing));
19899 * Read the body of the function, until ":endfunction" is found.
19901 if (KeyTyped)
19903 /* Check if the function already exists, don't let the user type the
19904 * whole function before telling him it doesn't work! For a script we
19905 * need to skip the body to be able to find what follows. */
19906 if (!eap->skip && !eap->forceit)
19908 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19909 EMSG(_(e_funcdict));
19910 else if (name != NULL && find_func(name) != NULL)
19911 emsg_funcname(e_funcexts, name);
19914 if (!eap->skip && did_emsg)
19915 goto erret;
19917 msg_putchar('\n'); /* don't overwrite the function name */
19918 cmdline_row = msg_row;
19921 indent = 2;
19922 nesting = 0;
19923 for (;;)
19925 msg_scroll = TRUE;
19926 need_wait_return = FALSE;
19927 sourcing_lnum_off = sourcing_lnum;
19929 if (line_arg != NULL)
19931 /* Use eap->arg, split up in parts by line breaks. */
19932 theline = line_arg;
19933 p = vim_strchr(theline, '\n');
19934 if (p == NULL)
19935 line_arg += STRLEN(line_arg);
19936 else
19938 *p = NUL;
19939 line_arg = p + 1;
19942 else if (eap->getline == NULL)
19943 theline = getcmdline(':', 0L, indent);
19944 else
19945 theline = eap->getline(':', eap->cookie, indent);
19946 if (KeyTyped)
19947 lines_left = Rows - 1;
19948 if (theline == NULL)
19950 EMSG(_("E126: Missing :endfunction"));
19951 goto erret;
19954 /* Detect line continuation: sourcing_lnum increased more than one. */
19955 if (sourcing_lnum > sourcing_lnum_off + 1)
19956 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
19957 else
19958 sourcing_lnum_off = 0;
19960 if (skip_until != NULL)
19962 /* between ":append" and "." and between ":python <<EOF" and "EOF"
19963 * don't check for ":endfunc". */
19964 if (STRCMP(theline, skip_until) == 0)
19966 vim_free(skip_until);
19967 skip_until = NULL;
19970 else
19972 /* skip ':' and blanks*/
19973 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
19976 /* Check for "endfunction". */
19977 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
19979 if (line_arg == NULL)
19980 vim_free(theline);
19981 break;
19984 /* Increase indent inside "if", "while", "for" and "try", decrease
19985 * at "end". */
19986 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
19987 indent -= 2;
19988 else if (STRNCMP(p, "if", 2) == 0
19989 || STRNCMP(p, "wh", 2) == 0
19990 || STRNCMP(p, "for", 3) == 0
19991 || STRNCMP(p, "try", 3) == 0)
19992 indent += 2;
19994 /* Check for defining a function inside this function. */
19995 if (checkforcmd(&p, "function", 2))
19997 if (*p == '!')
19998 p = skipwhite(p + 1);
19999 p += eval_fname_script(p);
20000 if (ASCII_ISALPHA(*p))
20002 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20003 if (*skipwhite(p) == '(')
20005 ++nesting;
20006 indent += 2;
20011 /* Check for ":append" or ":insert". */
20012 p = skip_range(p, NULL);
20013 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20014 || (p[0] == 'i'
20015 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20016 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20017 skip_until = vim_strsave((char_u *)".");
20019 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20020 arg = skipwhite(skiptowhite(p));
20021 if (arg[0] == '<' && arg[1] =='<'
20022 && ((p[0] == 'p' && p[1] == 'y'
20023 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20024 || (p[0] == 'p' && p[1] == 'e'
20025 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20026 || (p[0] == 't' && p[1] == 'c'
20027 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20028 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20029 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20030 || (p[0] == 'm' && p[1] == 'z'
20031 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20034 /* ":python <<" continues until a dot, like ":append" */
20035 p = skipwhite(arg + 2);
20036 if (*p == NUL)
20037 skip_until = vim_strsave((char_u *)".");
20038 else
20039 skip_until = vim_strsave(p);
20043 /* Add the line to the function. */
20044 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20046 if (line_arg == NULL)
20047 vim_free(theline);
20048 goto erret;
20051 /* Copy the line to newly allocated memory. get_one_sourceline()
20052 * allocates 250 bytes per line, this saves 80% on average. The cost
20053 * is an extra alloc/free. */
20054 p = vim_strsave(theline);
20055 if (p != NULL)
20057 if (line_arg == NULL)
20058 vim_free(theline);
20059 theline = p;
20062 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20064 /* Add NULL lines for continuation lines, so that the line count is
20065 * equal to the index in the growarray. */
20066 while (sourcing_lnum_off-- > 0)
20067 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20069 /* Check for end of eap->arg. */
20070 if (line_arg != NULL && *line_arg == NUL)
20071 line_arg = NULL;
20074 /* Don't define the function when skipping commands or when an error was
20075 * detected. */
20076 if (eap->skip || did_emsg)
20077 goto erret;
20080 * If there are no errors, add the function
20082 if (fudi.fd_dict == NULL)
20084 v = find_var(name, &ht);
20085 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20087 emsg_funcname("E707: Function name conflicts with variable: %s",
20088 name);
20089 goto erret;
20092 fp = find_func(name);
20093 if (fp != NULL)
20095 if (!eap->forceit)
20097 emsg_funcname(e_funcexts, name);
20098 goto erret;
20100 if (fp->uf_calls > 0)
20102 emsg_funcname("E127: Cannot redefine function %s: It is in use",
20103 name);
20104 goto erret;
20106 /* redefine existing function */
20107 ga_clear_strings(&(fp->uf_args));
20108 ga_clear_strings(&(fp->uf_lines));
20109 vim_free(name);
20110 name = NULL;
20113 else
20115 char numbuf[20];
20117 fp = NULL;
20118 if (fudi.fd_newkey == NULL && !eap->forceit)
20120 EMSG(_(e_funcdict));
20121 goto erret;
20123 if (fudi.fd_di == NULL)
20125 /* Can't add a function to a locked dictionary */
20126 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20127 goto erret;
20129 /* Can't change an existing function if it is locked */
20130 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20131 goto erret;
20133 /* Give the function a sequential number. Can only be used with a
20134 * Funcref! */
20135 vim_free(name);
20136 sprintf(numbuf, "%d", ++func_nr);
20137 name = vim_strsave((char_u *)numbuf);
20138 if (name == NULL)
20139 goto erret;
20142 if (fp == NULL)
20144 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20146 int slen, plen;
20147 char_u *scriptname;
20149 /* Check that the autoload name matches the script name. */
20150 j = FAIL;
20151 if (sourcing_name != NULL)
20153 scriptname = autoload_name(name);
20154 if (scriptname != NULL)
20156 p = vim_strchr(scriptname, '/');
20157 plen = (int)STRLEN(p);
20158 slen = (int)STRLEN(sourcing_name);
20159 if (slen > plen && fnamecmp(p,
20160 sourcing_name + slen - plen) == 0)
20161 j = OK;
20162 vim_free(scriptname);
20165 if (j == FAIL)
20167 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20168 goto erret;
20172 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20173 if (fp == NULL)
20174 goto erret;
20176 if (fudi.fd_dict != NULL)
20178 if (fudi.fd_di == NULL)
20180 /* add new dict entry */
20181 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20182 if (fudi.fd_di == NULL)
20184 vim_free(fp);
20185 goto erret;
20187 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20189 vim_free(fudi.fd_di);
20190 vim_free(fp);
20191 goto erret;
20194 else
20195 /* overwrite existing dict entry */
20196 clear_tv(&fudi.fd_di->di_tv);
20197 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20198 fudi.fd_di->di_tv.v_lock = 0;
20199 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20200 fp->uf_refcount = 1;
20202 /* behave like "dict" was used */
20203 flags |= FC_DICT;
20206 /* insert the new function in the function list */
20207 STRCPY(fp->uf_name, name);
20208 hash_add(&func_hashtab, UF2HIKEY(fp));
20210 fp->uf_args = newargs;
20211 fp->uf_lines = newlines;
20212 #ifdef FEAT_PROFILE
20213 fp->uf_tml_count = NULL;
20214 fp->uf_tml_total = NULL;
20215 fp->uf_tml_self = NULL;
20216 fp->uf_profiling = FALSE;
20217 if (prof_def_func())
20218 func_do_profile(fp);
20219 #endif
20220 fp->uf_varargs = varargs;
20221 fp->uf_flags = flags;
20222 fp->uf_calls = 0;
20223 fp->uf_script_ID = current_SID;
20224 goto ret_free;
20226 erret:
20227 ga_clear_strings(&newargs);
20228 ga_clear_strings(&newlines);
20229 ret_free:
20230 vim_free(skip_until);
20231 vim_free(fudi.fd_newkey);
20232 vim_free(name);
20233 did_emsg |= saved_did_emsg;
20237 * Get a function name, translating "<SID>" and "<SNR>".
20238 * Also handles a Funcref in a List or Dictionary.
20239 * Returns the function name in allocated memory, or NULL for failure.
20240 * flags:
20241 * TFN_INT: internal function name OK
20242 * TFN_QUIET: be quiet
20243 * Advances "pp" to just after the function name (if no error).
20245 static char_u *
20246 trans_function_name(pp, skip, flags, fdp)
20247 char_u **pp;
20248 int skip; /* only find the end, don't evaluate */
20249 int flags;
20250 funcdict_T *fdp; /* return: info about dictionary used */
20252 char_u *name = NULL;
20253 char_u *start;
20254 char_u *end;
20255 int lead;
20256 char_u sid_buf[20];
20257 int len;
20258 lval_T lv;
20260 if (fdp != NULL)
20261 vim_memset(fdp, 0, sizeof(funcdict_T));
20262 start = *pp;
20264 /* Check for hard coded <SNR>: already translated function ID (from a user
20265 * command). */
20266 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20267 && (*pp)[2] == (int)KE_SNR)
20269 *pp += 3;
20270 len = get_id_len(pp) + 3;
20271 return vim_strnsave(start, len);
20274 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20275 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20276 lead = eval_fname_script(start);
20277 if (lead > 2)
20278 start += lead;
20280 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20281 lead > 2 ? 0 : FNE_CHECK_START);
20282 if (end == start)
20284 if (!skip)
20285 EMSG(_("E129: Function name required"));
20286 goto theend;
20288 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20291 * Report an invalid expression in braces, unless the expression
20292 * evaluation has been cancelled due to an aborting error, an
20293 * interrupt, or an exception.
20295 if (!aborting())
20297 if (end != NULL)
20298 EMSG2(_(e_invarg2), start);
20300 else
20301 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20302 goto theend;
20305 if (lv.ll_tv != NULL)
20307 if (fdp != NULL)
20309 fdp->fd_dict = lv.ll_dict;
20310 fdp->fd_newkey = lv.ll_newkey;
20311 lv.ll_newkey = NULL;
20312 fdp->fd_di = lv.ll_di;
20314 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20316 name = vim_strsave(lv.ll_tv->vval.v_string);
20317 *pp = end;
20319 else
20321 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20322 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20323 EMSG(_(e_funcref));
20324 else
20325 *pp = end;
20326 name = NULL;
20328 goto theend;
20331 if (lv.ll_name == NULL)
20333 /* Error found, but continue after the function name. */
20334 *pp = end;
20335 goto theend;
20338 /* Check if the name is a Funcref. If so, use the value. */
20339 if (lv.ll_exp_name != NULL)
20341 len = (int)STRLEN(lv.ll_exp_name);
20342 name = deref_func_name(lv.ll_exp_name, &len);
20343 if (name == lv.ll_exp_name)
20344 name = NULL;
20346 else
20348 len = (int)(end - *pp);
20349 name = deref_func_name(*pp, &len);
20350 if (name == *pp)
20351 name = NULL;
20353 if (name != NULL)
20355 name = vim_strsave(name);
20356 *pp = end;
20357 goto theend;
20360 if (lv.ll_exp_name != NULL)
20362 len = (int)STRLEN(lv.ll_exp_name);
20363 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20364 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20366 /* When there was "s:" already or the name expanded to get a
20367 * leading "s:" then remove it. */
20368 lv.ll_name += 2;
20369 len -= 2;
20370 lead = 2;
20373 else
20375 if (lead == 2) /* skip over "s:" */
20376 lv.ll_name += 2;
20377 len = (int)(end - lv.ll_name);
20381 * Copy the function name to allocated memory.
20382 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20383 * Accept <SNR>123_name() outside a script.
20385 if (skip)
20386 lead = 0; /* do nothing */
20387 else if (lead > 0)
20389 lead = 3;
20390 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20391 || eval_fname_sid(*pp))
20393 /* It's "s:" or "<SID>" */
20394 if (current_SID <= 0)
20396 EMSG(_(e_usingsid));
20397 goto theend;
20399 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20400 lead += (int)STRLEN(sid_buf);
20403 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20405 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20406 goto theend;
20408 name = alloc((unsigned)(len + lead + 1));
20409 if (name != NULL)
20411 if (lead > 0)
20413 name[0] = K_SPECIAL;
20414 name[1] = KS_EXTRA;
20415 name[2] = (int)KE_SNR;
20416 if (lead > 3) /* If it's "<SID>" */
20417 STRCPY(name + 3, sid_buf);
20419 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20420 name[len + lead] = NUL;
20422 *pp = end;
20424 theend:
20425 clear_lval(&lv);
20426 return name;
20430 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20431 * Return 2 if "p" starts with "s:".
20432 * Return 0 otherwise.
20434 static int
20435 eval_fname_script(p)
20436 char_u *p;
20438 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20439 || STRNICMP(p + 1, "SNR>", 4) == 0))
20440 return 5;
20441 if (p[0] == 's' && p[1] == ':')
20442 return 2;
20443 return 0;
20447 * Return TRUE if "p" starts with "<SID>" or "s:".
20448 * Only works if eval_fname_script() returned non-zero for "p"!
20450 static int
20451 eval_fname_sid(p)
20452 char_u *p;
20454 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20458 * List the head of the function: "name(arg1, arg2)".
20460 static void
20461 list_func_head(fp, indent)
20462 ufunc_T *fp;
20463 int indent;
20465 int j;
20467 msg_start();
20468 if (indent)
20469 MSG_PUTS(" ");
20470 MSG_PUTS("function ");
20471 if (fp->uf_name[0] == K_SPECIAL)
20473 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20474 msg_puts(fp->uf_name + 3);
20476 else
20477 msg_puts(fp->uf_name);
20478 msg_putchar('(');
20479 for (j = 0; j < fp->uf_args.ga_len; ++j)
20481 if (j)
20482 MSG_PUTS(", ");
20483 msg_puts(FUNCARG(fp, j));
20485 if (fp->uf_varargs)
20487 if (j)
20488 MSG_PUTS(", ");
20489 MSG_PUTS("...");
20491 msg_putchar(')');
20492 msg_clr_eos();
20493 if (p_verbose > 0)
20494 last_set_msg(fp->uf_script_ID);
20498 * Find a function by name, return pointer to it in ufuncs.
20499 * Return NULL for unknown function.
20501 static ufunc_T *
20502 find_func(name)
20503 char_u *name;
20505 hashitem_T *hi;
20507 hi = hash_find(&func_hashtab, name);
20508 if (!HASHITEM_EMPTY(hi))
20509 return HI2UF(hi);
20510 return NULL;
20513 #if defined(EXITFREE) || defined(PROTO)
20514 void
20515 free_all_functions()
20517 hashitem_T *hi;
20519 /* Need to start all over every time, because func_free() may change the
20520 * hash table. */
20521 while (func_hashtab.ht_used > 0)
20522 for (hi = func_hashtab.ht_array; ; ++hi)
20523 if (!HASHITEM_EMPTY(hi))
20525 func_free(HI2UF(hi));
20526 break;
20529 #endif
20532 * Return TRUE if a function "name" exists.
20534 static int
20535 function_exists(name)
20536 char_u *name;
20538 char_u *nm = name;
20539 char_u *p;
20540 int n = FALSE;
20542 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20543 nm = skipwhite(nm);
20545 /* Only accept "funcname", "funcname ", "funcname (..." and
20546 * "funcname(...", not "funcname!...". */
20547 if (p != NULL && (*nm == NUL || *nm == '('))
20549 if (builtin_function(p))
20550 n = (find_internal_func(p) >= 0);
20551 else
20552 n = (find_func(p) != NULL);
20554 vim_free(p);
20555 return n;
20559 * Return TRUE if "name" looks like a builtin function name: starts with a
20560 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20562 static int
20563 builtin_function(name)
20564 char_u *name;
20566 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20567 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20570 #if defined(FEAT_PROFILE) || defined(PROTO)
20572 * Start profiling function "fp".
20574 static void
20575 func_do_profile(fp)
20576 ufunc_T *fp;
20578 fp->uf_tm_count = 0;
20579 profile_zero(&fp->uf_tm_self);
20580 profile_zero(&fp->uf_tm_total);
20581 if (fp->uf_tml_count == NULL)
20582 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20583 (sizeof(int) * fp->uf_lines.ga_len));
20584 if (fp->uf_tml_total == NULL)
20585 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20586 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20587 if (fp->uf_tml_self == NULL)
20588 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20589 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20590 fp->uf_tml_idx = -1;
20591 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20592 || fp->uf_tml_self == NULL)
20593 return; /* out of memory */
20595 fp->uf_profiling = TRUE;
20599 * Dump the profiling results for all functions in file "fd".
20601 void
20602 func_dump_profile(fd)
20603 FILE *fd;
20605 hashitem_T *hi;
20606 int todo;
20607 ufunc_T *fp;
20608 int i;
20609 ufunc_T **sorttab;
20610 int st_len = 0;
20612 todo = (int)func_hashtab.ht_used;
20613 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20615 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20617 if (!HASHITEM_EMPTY(hi))
20619 --todo;
20620 fp = HI2UF(hi);
20621 if (fp->uf_profiling)
20623 if (sorttab != NULL)
20624 sorttab[st_len++] = fp;
20626 if (fp->uf_name[0] == K_SPECIAL)
20627 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20628 else
20629 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20630 if (fp->uf_tm_count == 1)
20631 fprintf(fd, "Called 1 time\n");
20632 else
20633 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20634 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20635 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20636 fprintf(fd, "\n");
20637 fprintf(fd, "count total (s) self (s)\n");
20639 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20641 if (FUNCLINE(fp, i) == NULL)
20642 continue;
20643 prof_func_line(fd, fp->uf_tml_count[i],
20644 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20645 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20647 fprintf(fd, "\n");
20652 if (sorttab != NULL && st_len > 0)
20654 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20655 prof_total_cmp);
20656 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20657 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20658 prof_self_cmp);
20659 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20663 static void
20664 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20665 FILE *fd;
20666 ufunc_T **sorttab;
20667 int st_len;
20668 char *title;
20669 int prefer_self; /* when equal print only self time */
20671 int i;
20672 ufunc_T *fp;
20674 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20675 fprintf(fd, "count total (s) self (s) function\n");
20676 for (i = 0; i < 20 && i < st_len; ++i)
20678 fp = sorttab[i];
20679 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20680 prefer_self);
20681 if (fp->uf_name[0] == K_SPECIAL)
20682 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20683 else
20684 fprintf(fd, " %s()\n", fp->uf_name);
20686 fprintf(fd, "\n");
20690 * Print the count and times for one function or function line.
20692 static void
20693 prof_func_line(fd, count, total, self, prefer_self)
20694 FILE *fd;
20695 int count;
20696 proftime_T *total;
20697 proftime_T *self;
20698 int prefer_self; /* when equal print only self time */
20700 if (count > 0)
20702 fprintf(fd, "%5d ", count);
20703 if (prefer_self && profile_equal(total, self))
20704 fprintf(fd, " ");
20705 else
20706 fprintf(fd, "%s ", profile_msg(total));
20707 if (!prefer_self && profile_equal(total, self))
20708 fprintf(fd, " ");
20709 else
20710 fprintf(fd, "%s ", profile_msg(self));
20712 else
20713 fprintf(fd, " ");
20717 * Compare function for total time sorting.
20719 static int
20720 #ifdef __BORLANDC__
20721 _RTLENTRYF
20722 #endif
20723 prof_total_cmp(s1, s2)
20724 const void *s1;
20725 const void *s2;
20727 ufunc_T *p1, *p2;
20729 p1 = *(ufunc_T **)s1;
20730 p2 = *(ufunc_T **)s2;
20731 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20735 * Compare function for self time sorting.
20737 static int
20738 #ifdef __BORLANDC__
20739 _RTLENTRYF
20740 #endif
20741 prof_self_cmp(s1, s2)
20742 const void *s1;
20743 const void *s2;
20745 ufunc_T *p1, *p2;
20747 p1 = *(ufunc_T **)s1;
20748 p2 = *(ufunc_T **)s2;
20749 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20752 #endif
20755 * If "name" has a package name try autoloading the script for it.
20756 * Return TRUE if a package was loaded.
20758 static int
20759 script_autoload(name, reload)
20760 char_u *name;
20761 int reload; /* load script again when already loaded */
20763 char_u *p;
20764 char_u *scriptname, *tofree;
20765 int ret = FALSE;
20766 int i;
20768 /* If there is no '#' after name[0] there is no package name. */
20769 p = vim_strchr(name, AUTOLOAD_CHAR);
20770 if (p == NULL || p == name)
20771 return FALSE;
20773 tofree = scriptname = autoload_name(name);
20775 /* Find the name in the list of previously loaded package names. Skip
20776 * "autoload/", it's always the same. */
20777 for (i = 0; i < ga_loaded.ga_len; ++i)
20778 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20779 break;
20780 if (!reload && i < ga_loaded.ga_len)
20781 ret = FALSE; /* was loaded already */
20782 else
20784 /* Remember the name if it wasn't loaded already. */
20785 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20787 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20788 tofree = NULL;
20791 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20792 if (source_runtime(scriptname, FALSE) == OK)
20793 ret = TRUE;
20796 vim_free(tofree);
20797 return ret;
20801 * Return the autoload script name for a function or variable name.
20802 * Returns NULL when out of memory.
20804 static char_u *
20805 autoload_name(name)
20806 char_u *name;
20808 char_u *p;
20809 char_u *scriptname;
20811 /* Get the script file name: replace '#' with '/', append ".vim". */
20812 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20813 if (scriptname == NULL)
20814 return FALSE;
20815 STRCPY(scriptname, "autoload/");
20816 STRCAT(scriptname, name);
20817 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20818 STRCAT(scriptname, ".vim");
20819 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20820 *p = '/';
20821 return scriptname;
20824 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20827 * Function given to ExpandGeneric() to obtain the list of user defined
20828 * function names.
20830 char_u *
20831 get_user_func_name(xp, idx)
20832 expand_T *xp;
20833 int idx;
20835 static long_u done;
20836 static hashitem_T *hi;
20837 ufunc_T *fp;
20839 if (idx == 0)
20841 done = 0;
20842 hi = func_hashtab.ht_array;
20844 if (done < func_hashtab.ht_used)
20846 if (done++ > 0)
20847 ++hi;
20848 while (HASHITEM_EMPTY(hi))
20849 ++hi;
20850 fp = HI2UF(hi);
20852 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20853 return fp->uf_name; /* prevents overflow */
20855 cat_func_name(IObuff, fp);
20856 if (xp->xp_context != EXPAND_USER_FUNC)
20858 STRCAT(IObuff, "(");
20859 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20860 STRCAT(IObuff, ")");
20862 return IObuff;
20864 return NULL;
20867 #endif /* FEAT_CMDL_COMPL */
20870 * Copy the function name of "fp" to buffer "buf".
20871 * "buf" must be able to hold the function name plus three bytes.
20872 * Takes care of script-local function names.
20874 static void
20875 cat_func_name(buf, fp)
20876 char_u *buf;
20877 ufunc_T *fp;
20879 if (fp->uf_name[0] == K_SPECIAL)
20881 STRCPY(buf, "<SNR>");
20882 STRCAT(buf, fp->uf_name + 3);
20884 else
20885 STRCPY(buf, fp->uf_name);
20889 * ":delfunction {name}"
20891 void
20892 ex_delfunction(eap)
20893 exarg_T *eap;
20895 ufunc_T *fp = NULL;
20896 char_u *p;
20897 char_u *name;
20898 funcdict_T fudi;
20900 p = eap->arg;
20901 name = trans_function_name(&p, eap->skip, 0, &fudi);
20902 vim_free(fudi.fd_newkey);
20903 if (name == NULL)
20905 if (fudi.fd_dict != NULL && !eap->skip)
20906 EMSG(_(e_funcref));
20907 return;
20909 if (!ends_excmd(*skipwhite(p)))
20911 vim_free(name);
20912 EMSG(_(e_trailing));
20913 return;
20915 eap->nextcmd = check_nextcmd(p);
20916 if (eap->nextcmd != NULL)
20917 *p = NUL;
20919 if (!eap->skip)
20920 fp = find_func(name);
20921 vim_free(name);
20923 if (!eap->skip)
20925 if (fp == NULL)
20927 EMSG2(_(e_nofunc), eap->arg);
20928 return;
20930 if (fp->uf_calls > 0)
20932 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
20933 return;
20936 if (fudi.fd_dict != NULL)
20938 /* Delete the dict item that refers to the function, it will
20939 * invoke func_unref() and possibly delete the function. */
20940 dictitem_remove(fudi.fd_dict, fudi.fd_di);
20942 else
20943 func_free(fp);
20948 * Free a function and remove it from the list of functions.
20950 static void
20951 func_free(fp)
20952 ufunc_T *fp;
20954 hashitem_T *hi;
20956 /* clear this function */
20957 ga_clear_strings(&(fp->uf_args));
20958 ga_clear_strings(&(fp->uf_lines));
20959 #ifdef FEAT_PROFILE
20960 vim_free(fp->uf_tml_count);
20961 vim_free(fp->uf_tml_total);
20962 vim_free(fp->uf_tml_self);
20963 #endif
20965 /* remove the function from the function hashtable */
20966 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
20967 if (HASHITEM_EMPTY(hi))
20968 EMSG2(_(e_intern2), "func_free()");
20969 else
20970 hash_remove(&func_hashtab, hi);
20972 vim_free(fp);
20976 * Unreference a Function: decrement the reference count and free it when it
20977 * becomes zero. Only for numbered functions.
20979 static void
20980 func_unref(name)
20981 char_u *name;
20983 ufunc_T *fp;
20985 if (name != NULL && isdigit(*name))
20987 fp = find_func(name);
20988 if (fp == NULL)
20989 EMSG2(_(e_intern2), "func_unref()");
20990 else if (--fp->uf_refcount <= 0)
20992 /* Only delete it when it's not being used. Otherwise it's done
20993 * when "uf_calls" becomes zero. */
20994 if (fp->uf_calls == 0)
20995 func_free(fp);
21001 * Count a reference to a Function.
21003 static void
21004 func_ref(name)
21005 char_u *name;
21007 ufunc_T *fp;
21009 if (name != NULL && isdigit(*name))
21011 fp = find_func(name);
21012 if (fp == NULL)
21013 EMSG2(_(e_intern2), "func_ref()");
21014 else
21015 ++fp->uf_refcount;
21020 * Call a user function.
21022 static void
21023 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21024 ufunc_T *fp; /* pointer to function */
21025 int argcount; /* nr of args */
21026 typval_T *argvars; /* arguments */
21027 typval_T *rettv; /* return value */
21028 linenr_T firstline; /* first line of range */
21029 linenr_T lastline; /* last line of range */
21030 dict_T *selfdict; /* Dictionary for "self" */
21032 char_u *save_sourcing_name;
21033 linenr_T save_sourcing_lnum;
21034 scid_T save_current_SID;
21035 funccall_T fc;
21036 int save_did_emsg;
21037 static int depth = 0;
21038 dictitem_T *v;
21039 int fixvar_idx = 0; /* index in fixvar[] */
21040 int i;
21041 int ai;
21042 char_u numbuf[NUMBUFLEN];
21043 char_u *name;
21044 #ifdef FEAT_PROFILE
21045 proftime_T wait_start;
21046 proftime_T call_start;
21047 #endif
21049 /* If depth of calling is getting too high, don't execute the function */
21050 if (depth >= p_mfd)
21052 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21053 rettv->v_type = VAR_NUMBER;
21054 rettv->vval.v_number = -1;
21055 return;
21057 ++depth;
21059 line_breakcheck(); /* check for CTRL-C hit */
21061 fc.caller = current_funccal;
21062 current_funccal = &fc;
21063 fc.func = fp;
21064 fc.rettv = rettv;
21065 rettv->vval.v_number = 0;
21066 fc.linenr = 0;
21067 fc.returned = FALSE;
21068 fc.level = ex_nesting_level;
21069 /* Check if this function has a breakpoint. */
21070 fc.breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21071 fc.dbg_tick = debug_tick;
21074 * Note about using fc.fixvar[]: This is an array of FIXVAR_CNT variables
21075 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21076 * each argument variable and saves a lot of time.
21079 * Init l: variables.
21081 init_var_dict(&fc.l_vars, &fc.l_vars_var);
21082 if (selfdict != NULL)
21084 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21085 * some compiler that checks the destination size. */
21086 v = &fc.fixvar[fixvar_idx++].var;
21087 name = v->di_key;
21088 STRCPY(name, "self");
21089 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21090 hash_add(&fc.l_vars.dv_hashtab, DI2HIKEY(v));
21091 v->di_tv.v_type = VAR_DICT;
21092 v->di_tv.v_lock = 0;
21093 v->di_tv.vval.v_dict = selfdict;
21094 ++selfdict->dv_refcount;
21098 * Init a: variables.
21099 * Set a:0 to "argcount".
21100 * Set a:000 to a list with room for the "..." arguments.
21102 init_var_dict(&fc.l_avars, &fc.l_avars_var);
21103 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "0",
21104 (varnumber_T)(argcount - fp->uf_args.ga_len));
21105 v = &fc.fixvar[fixvar_idx++].var;
21106 STRCPY(v->di_key, "000");
21107 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21108 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21109 v->di_tv.v_type = VAR_LIST;
21110 v->di_tv.v_lock = VAR_FIXED;
21111 v->di_tv.vval.v_list = &fc.l_varlist;
21112 vim_memset(&fc.l_varlist, 0, sizeof(list_T));
21113 fc.l_varlist.lv_refcount = 99999;
21114 fc.l_varlist.lv_lock = VAR_FIXED;
21117 * Set a:firstline to "firstline" and a:lastline to "lastline".
21118 * Set a:name to named arguments.
21119 * Set a:N to the "..." arguments.
21121 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "firstline",
21122 (varnumber_T)firstline);
21123 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "lastline",
21124 (varnumber_T)lastline);
21125 for (i = 0; i < argcount; ++i)
21127 ai = i - fp->uf_args.ga_len;
21128 if (ai < 0)
21129 /* named argument a:name */
21130 name = FUNCARG(fp, i);
21131 else
21133 /* "..." argument a:1, a:2, etc. */
21134 sprintf((char *)numbuf, "%d", ai + 1);
21135 name = numbuf;
21137 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21139 v = &fc.fixvar[fixvar_idx++].var;
21140 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21142 else
21144 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21145 + STRLEN(name)));
21146 if (v == NULL)
21147 break;
21148 v->di_flags = DI_FLAGS_RO;
21150 STRCPY(v->di_key, name);
21151 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21153 /* Note: the values are copied directly to avoid alloc/free.
21154 * "argvars" must have VAR_FIXED for v_lock. */
21155 v->di_tv = argvars[i];
21156 v->di_tv.v_lock = VAR_FIXED;
21158 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21160 list_append(&fc.l_varlist, &fc.l_listitems[ai]);
21161 fc.l_listitems[ai].li_tv = argvars[i];
21162 fc.l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21166 /* Don't redraw while executing the function. */
21167 ++RedrawingDisabled;
21168 save_sourcing_name = sourcing_name;
21169 save_sourcing_lnum = sourcing_lnum;
21170 sourcing_lnum = 1;
21171 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21172 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21173 if (sourcing_name != NULL)
21175 if (save_sourcing_name != NULL
21176 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21177 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21178 else
21179 STRCPY(sourcing_name, "function ");
21180 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21182 if (p_verbose >= 12)
21184 ++no_wait_return;
21185 verbose_enter_scroll();
21187 smsg((char_u *)_("calling %s"), sourcing_name);
21188 if (p_verbose >= 14)
21190 char_u buf[MSG_BUF_LEN];
21191 char_u numbuf2[NUMBUFLEN];
21192 char_u *tofree;
21193 char_u *s;
21195 msg_puts((char_u *)"(");
21196 for (i = 0; i < argcount; ++i)
21198 if (i > 0)
21199 msg_puts((char_u *)", ");
21200 if (argvars[i].v_type == VAR_NUMBER)
21201 msg_outnum((long)argvars[i].vval.v_number);
21202 else
21204 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21205 if (s != NULL)
21207 trunc_string(s, buf, MSG_BUF_CLEN);
21208 msg_puts(buf);
21209 vim_free(tofree);
21213 msg_puts((char_u *)")");
21215 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21217 verbose_leave_scroll();
21218 --no_wait_return;
21221 #ifdef FEAT_PROFILE
21222 if (do_profiling == PROF_YES)
21224 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21225 func_do_profile(fp);
21226 if (fp->uf_profiling
21227 || (fc.caller != NULL && &fc.caller->func->uf_profiling))
21229 ++fp->uf_tm_count;
21230 profile_start(&call_start);
21231 profile_zero(&fp->uf_tm_children);
21233 script_prof_save(&wait_start);
21235 #endif
21237 save_current_SID = current_SID;
21238 current_SID = fp->uf_script_ID;
21239 save_did_emsg = did_emsg;
21240 did_emsg = FALSE;
21242 /* call do_cmdline() to execute the lines */
21243 do_cmdline(NULL, get_func_line, (void *)&fc,
21244 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21246 --RedrawingDisabled;
21248 /* when the function was aborted because of an error, return -1 */
21249 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21251 clear_tv(rettv);
21252 rettv->v_type = VAR_NUMBER;
21253 rettv->vval.v_number = -1;
21256 #ifdef FEAT_PROFILE
21257 if (do_profiling == PROF_YES && (fp->uf_profiling
21258 || (fc.caller != NULL && &fc.caller->func->uf_profiling)))
21260 profile_end(&call_start);
21261 profile_sub_wait(&wait_start, &call_start);
21262 profile_add(&fp->uf_tm_total, &call_start);
21263 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21264 if (fc.caller != NULL && &fc.caller->func->uf_profiling)
21266 profile_add(&fc.caller->func->uf_tm_children, &call_start);
21267 profile_add(&fc.caller->func->uf_tml_children, &call_start);
21270 #endif
21272 /* when being verbose, mention the return value */
21273 if (p_verbose >= 12)
21275 ++no_wait_return;
21276 verbose_enter_scroll();
21278 if (aborting())
21279 smsg((char_u *)_("%s aborted"), sourcing_name);
21280 else if (fc.rettv->v_type == VAR_NUMBER)
21281 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21282 (long)fc.rettv->vval.v_number);
21283 else
21285 char_u buf[MSG_BUF_LEN];
21286 char_u numbuf2[NUMBUFLEN];
21287 char_u *tofree;
21288 char_u *s;
21290 /* The value may be very long. Skip the middle part, so that we
21291 * have some idea how it starts and ends. smsg() would always
21292 * truncate it at the end. */
21293 s = tv2string(fc.rettv, &tofree, numbuf2, 0);
21294 if (s != NULL)
21296 trunc_string(s, buf, MSG_BUF_CLEN);
21297 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21298 vim_free(tofree);
21301 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21303 verbose_leave_scroll();
21304 --no_wait_return;
21307 vim_free(sourcing_name);
21308 sourcing_name = save_sourcing_name;
21309 sourcing_lnum = save_sourcing_lnum;
21310 current_SID = save_current_SID;
21311 #ifdef FEAT_PROFILE
21312 if (do_profiling == PROF_YES)
21313 script_prof_restore(&wait_start);
21314 #endif
21316 if (p_verbose >= 12 && sourcing_name != NULL)
21318 ++no_wait_return;
21319 verbose_enter_scroll();
21321 smsg((char_u *)_("continuing in %s"), sourcing_name);
21322 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21324 verbose_leave_scroll();
21325 --no_wait_return;
21328 did_emsg |= save_did_emsg;
21329 current_funccal = fc.caller;
21331 /* The a: variables typevals were not allocated, only free the allocated
21332 * variables. */
21333 vars_clear_ext(&fc.l_avars.dv_hashtab, FALSE);
21335 vars_clear(&fc.l_vars.dv_hashtab); /* free all l: variables */
21336 --depth;
21340 * Add a number variable "name" to dict "dp" with value "nr".
21342 static void
21343 add_nr_var(dp, v, name, nr)
21344 dict_T *dp;
21345 dictitem_T *v;
21346 char *name;
21347 varnumber_T nr;
21349 STRCPY(v->di_key, name);
21350 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21351 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21352 v->di_tv.v_type = VAR_NUMBER;
21353 v->di_tv.v_lock = VAR_FIXED;
21354 v->di_tv.vval.v_number = nr;
21358 * ":return [expr]"
21360 void
21361 ex_return(eap)
21362 exarg_T *eap;
21364 char_u *arg = eap->arg;
21365 typval_T rettv;
21366 int returning = FALSE;
21368 if (current_funccal == NULL)
21370 EMSG(_("E133: :return not inside a function"));
21371 return;
21374 if (eap->skip)
21375 ++emsg_skip;
21377 eap->nextcmd = NULL;
21378 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21379 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21381 if (!eap->skip)
21382 returning = do_return(eap, FALSE, TRUE, &rettv);
21383 else
21384 clear_tv(&rettv);
21386 /* It's safer to return also on error. */
21387 else if (!eap->skip)
21390 * Return unless the expression evaluation has been cancelled due to an
21391 * aborting error, an interrupt, or an exception.
21393 if (!aborting())
21394 returning = do_return(eap, FALSE, TRUE, NULL);
21397 /* When skipping or the return gets pending, advance to the next command
21398 * in this line (!returning). Otherwise, ignore the rest of the line.
21399 * Following lines will be ignored by get_func_line(). */
21400 if (returning)
21401 eap->nextcmd = NULL;
21402 else if (eap->nextcmd == NULL) /* no argument */
21403 eap->nextcmd = check_nextcmd(arg);
21405 if (eap->skip)
21406 --emsg_skip;
21410 * Return from a function. Possibly makes the return pending. Also called
21411 * for a pending return at the ":endtry" or after returning from an extra
21412 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21413 * when called due to a ":return" command. "rettv" may point to a typval_T
21414 * with the return rettv. Returns TRUE when the return can be carried out,
21415 * FALSE when the return gets pending.
21418 do_return(eap, reanimate, is_cmd, rettv)
21419 exarg_T *eap;
21420 int reanimate;
21421 int is_cmd;
21422 void *rettv;
21424 int idx;
21425 struct condstack *cstack = eap->cstack;
21427 if (reanimate)
21428 /* Undo the return. */
21429 current_funccal->returned = FALSE;
21432 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21433 * not in its finally clause (which then is to be executed next) is found.
21434 * In this case, make the ":return" pending for execution at the ":endtry".
21435 * Otherwise, return normally.
21437 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21438 if (idx >= 0)
21440 cstack->cs_pending[idx] = CSTP_RETURN;
21442 if (!is_cmd && !reanimate)
21443 /* A pending return again gets pending. "rettv" points to an
21444 * allocated variable with the rettv of the original ":return"'s
21445 * argument if present or is NULL else. */
21446 cstack->cs_rettv[idx] = rettv;
21447 else
21449 /* When undoing a return in order to make it pending, get the stored
21450 * return rettv. */
21451 if (reanimate)
21452 rettv = current_funccal->rettv;
21454 if (rettv != NULL)
21456 /* Store the value of the pending return. */
21457 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21458 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21459 else
21460 EMSG(_(e_outofmem));
21462 else
21463 cstack->cs_rettv[idx] = NULL;
21465 if (reanimate)
21467 /* The pending return value could be overwritten by a ":return"
21468 * without argument in a finally clause; reset the default
21469 * return value. */
21470 current_funccal->rettv->v_type = VAR_NUMBER;
21471 current_funccal->rettv->vval.v_number = 0;
21474 report_make_pending(CSTP_RETURN, rettv);
21476 else
21478 current_funccal->returned = TRUE;
21480 /* If the return is carried out now, store the return value. For
21481 * a return immediately after reanimation, the value is already
21482 * there. */
21483 if (!reanimate && rettv != NULL)
21485 clear_tv(current_funccal->rettv);
21486 *current_funccal->rettv = *(typval_T *)rettv;
21487 if (!is_cmd)
21488 vim_free(rettv);
21492 return idx < 0;
21496 * Free the variable with a pending return value.
21498 void
21499 discard_pending_return(rettv)
21500 void *rettv;
21502 free_tv((typval_T *)rettv);
21506 * Generate a return command for producing the value of "rettv". The result
21507 * is an allocated string. Used by report_pending() for verbose messages.
21509 char_u *
21510 get_return_cmd(rettv)
21511 void *rettv;
21513 char_u *s = NULL;
21514 char_u *tofree = NULL;
21515 char_u numbuf[NUMBUFLEN];
21517 if (rettv != NULL)
21518 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21519 if (s == NULL)
21520 s = (char_u *)"";
21522 STRCPY(IObuff, ":return ");
21523 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21524 if (STRLEN(s) + 8 >= IOSIZE)
21525 STRCPY(IObuff + IOSIZE - 4, "...");
21526 vim_free(tofree);
21527 return vim_strsave(IObuff);
21531 * Get next function line.
21532 * Called by do_cmdline() to get the next line.
21533 * Returns allocated string, or NULL for end of function.
21535 /* ARGSUSED */
21536 char_u *
21537 get_func_line(c, cookie, indent)
21538 int c; /* not used */
21539 void *cookie;
21540 int indent; /* not used */
21542 funccall_T *fcp = (funccall_T *)cookie;
21543 ufunc_T *fp = fcp->func;
21544 char_u *retval;
21545 garray_T *gap; /* growarray with function lines */
21547 /* If breakpoints have been added/deleted need to check for it. */
21548 if (fcp->dbg_tick != debug_tick)
21550 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21551 sourcing_lnum);
21552 fcp->dbg_tick = debug_tick;
21554 #ifdef FEAT_PROFILE
21555 if (do_profiling == PROF_YES)
21556 func_line_end(cookie);
21557 #endif
21559 gap = &fp->uf_lines;
21560 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21561 || fcp->returned)
21562 retval = NULL;
21563 else
21565 /* Skip NULL lines (continuation lines). */
21566 while (fcp->linenr < gap->ga_len
21567 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21568 ++fcp->linenr;
21569 if (fcp->linenr >= gap->ga_len)
21570 retval = NULL;
21571 else
21573 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21574 sourcing_lnum = fcp->linenr;
21575 #ifdef FEAT_PROFILE
21576 if (do_profiling == PROF_YES)
21577 func_line_start(cookie);
21578 #endif
21582 /* Did we encounter a breakpoint? */
21583 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21585 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21586 /* Find next breakpoint. */
21587 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21588 sourcing_lnum);
21589 fcp->dbg_tick = debug_tick;
21592 return retval;
21595 #if defined(FEAT_PROFILE) || defined(PROTO)
21597 * Called when starting to read a function line.
21598 * "sourcing_lnum" must be correct!
21599 * When skipping lines it may not actually be executed, but we won't find out
21600 * until later and we need to store the time now.
21602 void
21603 func_line_start(cookie)
21604 void *cookie;
21606 funccall_T *fcp = (funccall_T *)cookie;
21607 ufunc_T *fp = fcp->func;
21609 if (fp->uf_profiling && sourcing_lnum >= 1
21610 && sourcing_lnum <= fp->uf_lines.ga_len)
21612 fp->uf_tml_idx = sourcing_lnum - 1;
21613 /* Skip continuation lines. */
21614 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21615 --fp->uf_tml_idx;
21616 fp->uf_tml_execed = FALSE;
21617 profile_start(&fp->uf_tml_start);
21618 profile_zero(&fp->uf_tml_children);
21619 profile_get_wait(&fp->uf_tml_wait);
21624 * Called when actually executing a function line.
21626 void
21627 func_line_exec(cookie)
21628 void *cookie;
21630 funccall_T *fcp = (funccall_T *)cookie;
21631 ufunc_T *fp = fcp->func;
21633 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21634 fp->uf_tml_execed = TRUE;
21638 * Called when done with a function line.
21640 void
21641 func_line_end(cookie)
21642 void *cookie;
21644 funccall_T *fcp = (funccall_T *)cookie;
21645 ufunc_T *fp = fcp->func;
21647 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21649 if (fp->uf_tml_execed)
21651 ++fp->uf_tml_count[fp->uf_tml_idx];
21652 profile_end(&fp->uf_tml_start);
21653 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21654 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21655 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21656 &fp->uf_tml_children);
21658 fp->uf_tml_idx = -1;
21661 #endif
21664 * Return TRUE if the currently active function should be ended, because a
21665 * return was encountered or an error occurred. Used inside a ":while".
21668 func_has_ended(cookie)
21669 void *cookie;
21671 funccall_T *fcp = (funccall_T *)cookie;
21673 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21674 * an error inside a try conditional. */
21675 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21676 || fcp->returned);
21680 * return TRUE if cookie indicates a function which "abort"s on errors.
21683 func_has_abort(cookie)
21684 void *cookie;
21686 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21689 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21690 typedef enum
21692 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21693 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21694 VAR_FLAVOUR_VIMINFO /* all uppercase */
21695 } var_flavour_T;
21697 static var_flavour_T var_flavour __ARGS((char_u *varname));
21699 static var_flavour_T
21700 var_flavour(varname)
21701 char_u *varname;
21703 char_u *p = varname;
21705 if (ASCII_ISUPPER(*p))
21707 while (*(++p))
21708 if (ASCII_ISLOWER(*p))
21709 return VAR_FLAVOUR_SESSION;
21710 return VAR_FLAVOUR_VIMINFO;
21712 else
21713 return VAR_FLAVOUR_DEFAULT;
21715 #endif
21717 #if defined(FEAT_VIMINFO) || defined(PROTO)
21719 * Restore global vars that start with a capital from the viminfo file
21722 read_viminfo_varlist(virp, writing)
21723 vir_T *virp;
21724 int writing;
21726 char_u *tab;
21727 int type = VAR_NUMBER;
21728 typval_T tv;
21730 if (!writing && (find_viminfo_parameter('!') != NULL))
21732 tab = vim_strchr(virp->vir_line + 1, '\t');
21733 if (tab != NULL)
21735 *tab++ = '\0'; /* isolate the variable name */
21736 if (*tab == 'S') /* string var */
21737 type = VAR_STRING;
21738 #ifdef FEAT_FLOAT
21739 else if (*tab == 'F')
21740 type = VAR_FLOAT;
21741 #endif
21743 tab = vim_strchr(tab, '\t');
21744 if (tab != NULL)
21746 tv.v_type = type;
21747 if (type == VAR_STRING)
21748 tv.vval.v_string = viminfo_readstring(virp,
21749 (int)(tab - virp->vir_line + 1), TRUE);
21750 #ifdef FEAT_FLOAT
21751 else if (type == VAR_FLOAT)
21752 (void)string2float(tab + 1, &tv.vval.v_float);
21753 #endif
21754 else
21755 tv.vval.v_number = atol((char *)tab + 1);
21756 set_var(virp->vir_line + 1, &tv, FALSE);
21757 if (type == VAR_STRING)
21758 vim_free(tv.vval.v_string);
21763 return viminfo_readline(virp);
21767 * Write global vars that start with a capital to the viminfo file
21769 void
21770 write_viminfo_varlist(fp)
21771 FILE *fp;
21773 hashitem_T *hi;
21774 dictitem_T *this_var;
21775 int todo;
21776 char *s;
21777 char_u *p;
21778 char_u *tofree;
21779 char_u numbuf[NUMBUFLEN];
21781 if (find_viminfo_parameter('!') == NULL)
21782 return;
21784 fprintf(fp, _("\n# global variables:\n"));
21786 todo = (int)globvarht.ht_used;
21787 for (hi = globvarht.ht_array; todo > 0; ++hi)
21789 if (!HASHITEM_EMPTY(hi))
21791 --todo;
21792 this_var = HI2DI(hi);
21793 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21795 switch (this_var->di_tv.v_type)
21797 case VAR_STRING: s = "STR"; break;
21798 case VAR_NUMBER: s = "NUM"; break;
21799 #ifdef FEAT_FLOAT
21800 case VAR_FLOAT: s = "FLO"; break;
21801 #endif
21802 default: continue;
21804 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21805 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21806 if (p != NULL)
21807 viminfo_writestring(fp, p);
21808 vim_free(tofree);
21813 #endif
21815 #if defined(FEAT_SESSION) || defined(PROTO)
21817 store_session_globals(fd)
21818 FILE *fd;
21820 hashitem_T *hi;
21821 dictitem_T *this_var;
21822 int todo;
21823 char_u *p, *t;
21825 todo = (int)globvarht.ht_used;
21826 for (hi = globvarht.ht_array; todo > 0; ++hi)
21828 if (!HASHITEM_EMPTY(hi))
21830 --todo;
21831 this_var = HI2DI(hi);
21832 if ((this_var->di_tv.v_type == VAR_NUMBER
21833 || this_var->di_tv.v_type == VAR_STRING)
21834 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21836 /* Escape special characters with a backslash. Turn a LF and
21837 * CR into \n and \r. */
21838 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
21839 (char_u *)"\\\"\n\r");
21840 if (p == NULL) /* out of memory */
21841 break;
21842 for (t = p; *t != NUL; ++t)
21843 if (*t == '\n')
21844 *t = 'n';
21845 else if (*t == '\r')
21846 *t = 'r';
21847 if ((fprintf(fd, "let %s = %c%s%c",
21848 this_var->di_key,
21849 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21850 : ' ',
21852 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21853 : ' ') < 0)
21854 || put_eol(fd) == FAIL)
21856 vim_free(p);
21857 return FAIL;
21859 vim_free(p);
21861 #ifdef FEAT_FLOAT
21862 else if (this_var->di_tv.v_type == VAR_FLOAT
21863 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21865 float_T f = this_var->di_tv.vval.v_float;
21866 int sign = ' ';
21868 if (f < 0)
21870 f = -f;
21871 sign = '-';
21873 if ((fprintf(fd, "let %s = %c&%f",
21874 this_var->di_key, sign, f) < 0)
21875 || put_eol(fd) == FAIL)
21876 return FAIL;
21878 #endif
21881 return OK;
21883 #endif
21886 * Display script name where an item was last set.
21887 * Should only be invoked when 'verbose' is non-zero.
21889 void
21890 last_set_msg(scriptID)
21891 scid_T scriptID;
21893 char_u *p;
21895 if (scriptID != 0)
21897 p = home_replace_save(NULL, get_scriptname(scriptID));
21898 if (p != NULL)
21900 verbose_enter();
21901 MSG_PUTS(_("\n\tLast set from "));
21902 MSG_PUTS(p);
21903 vim_free(p);
21904 verbose_leave();
21909 #endif /* FEAT_EVAL */
21912 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
21914 #ifdef WIN3264
21916 * Functions for ":8" filename modifier: get 8.3 version of a filename.
21918 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
21919 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
21920 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
21923 * Get the short path (8.3) for the filename in "fnamep".
21924 * Only works for a valid file name.
21925 * When the path gets longer "fnamep" is changed and the allocated buffer
21926 * is put in "bufp".
21927 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
21928 * Returns OK on success, FAIL on failure.
21930 static int
21931 get_short_pathname(fnamep, bufp, fnamelen)
21932 char_u **fnamep;
21933 char_u **bufp;
21934 int *fnamelen;
21936 int l, len;
21937 char_u *newbuf;
21939 len = *fnamelen;
21940 l = GetShortPathName(*fnamep, *fnamep, len);
21941 if (l > len - 1)
21943 /* If that doesn't work (not enough space), then save the string
21944 * and try again with a new buffer big enough. */
21945 newbuf = vim_strnsave(*fnamep, l);
21946 if (newbuf == NULL)
21947 return FAIL;
21949 vim_free(*bufp);
21950 *fnamep = *bufp = newbuf;
21952 /* Really should always succeed, as the buffer is big enough. */
21953 l = GetShortPathName(*fnamep, *fnamep, l+1);
21956 *fnamelen = l;
21957 return OK;
21961 * Get the short path (8.3) for the filename in "fname". The converted
21962 * path is returned in "bufp".
21964 * Some of the directories specified in "fname" may not exist. This function
21965 * will shorten the existing directories at the beginning of the path and then
21966 * append the remaining non-existing path.
21968 * fname - Pointer to the filename to shorten. On return, contains the
21969 * pointer to the shortened pathname
21970 * bufp - Pointer to an allocated buffer for the filename.
21971 * fnamelen - Length of the filename pointed to by fname
21973 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
21975 static int
21976 shortpath_for_invalid_fname(fname, bufp, fnamelen)
21977 char_u **fname;
21978 char_u **bufp;
21979 int *fnamelen;
21981 char_u *short_fname, *save_fname, *pbuf_unused;
21982 char_u *endp, *save_endp;
21983 char_u ch;
21984 int old_len, len;
21985 int new_len, sfx_len;
21986 int retval = OK;
21988 /* Make a copy */
21989 old_len = *fnamelen;
21990 save_fname = vim_strnsave(*fname, old_len);
21991 pbuf_unused = NULL;
21992 short_fname = NULL;
21994 endp = save_fname + old_len - 1; /* Find the end of the copy */
21995 save_endp = endp;
21998 * Try shortening the supplied path till it succeeds by removing one
21999 * directory at a time from the tail of the path.
22001 len = 0;
22002 for (;;)
22004 /* go back one path-separator */
22005 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22006 --endp;
22007 if (endp <= save_fname)
22008 break; /* processed the complete path */
22011 * Replace the path separator with a NUL and try to shorten the
22012 * resulting path.
22014 ch = *endp;
22015 *endp = 0;
22016 short_fname = save_fname;
22017 len = (int)STRLEN(short_fname) + 1;
22018 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22020 retval = FAIL;
22021 goto theend;
22023 *endp = ch; /* preserve the string */
22025 if (len > 0)
22026 break; /* successfully shortened the path */
22028 /* failed to shorten the path. Skip the path separator */
22029 --endp;
22032 if (len > 0)
22035 * Succeeded in shortening the path. Now concatenate the shortened
22036 * path with the remaining path at the tail.
22039 /* Compute the length of the new path. */
22040 sfx_len = (int)(save_endp - endp) + 1;
22041 new_len = len + sfx_len;
22043 *fnamelen = new_len;
22044 vim_free(*bufp);
22045 if (new_len > old_len)
22047 /* There is not enough space in the currently allocated string,
22048 * copy it to a buffer big enough. */
22049 *fname = *bufp = vim_strnsave(short_fname, new_len);
22050 if (*fname == NULL)
22052 retval = FAIL;
22053 goto theend;
22056 else
22058 /* Transfer short_fname to the main buffer (it's big enough),
22059 * unless get_short_pathname() did its work in-place. */
22060 *fname = *bufp = save_fname;
22061 if (short_fname != save_fname)
22062 vim_strncpy(save_fname, short_fname, len);
22063 save_fname = NULL;
22066 /* concat the not-shortened part of the path */
22067 vim_strncpy(*fname + len, endp, sfx_len);
22068 (*fname)[new_len] = NUL;
22071 theend:
22072 vim_free(pbuf_unused);
22073 vim_free(save_fname);
22075 return retval;
22079 * Get a pathname for a partial path.
22080 * Returns OK for success, FAIL for failure.
22082 static int
22083 shortpath_for_partial(fnamep, bufp, fnamelen)
22084 char_u **fnamep;
22085 char_u **bufp;
22086 int *fnamelen;
22088 int sepcount, len, tflen;
22089 char_u *p;
22090 char_u *pbuf, *tfname;
22091 int hasTilde;
22093 /* Count up the path separators from the RHS.. so we know which part
22094 * of the path to return. */
22095 sepcount = 0;
22096 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22097 if (vim_ispathsep(*p))
22098 ++sepcount;
22100 /* Need full path first (use expand_env() to remove a "~/") */
22101 hasTilde = (**fnamep == '~');
22102 if (hasTilde)
22103 pbuf = tfname = expand_env_save(*fnamep);
22104 else
22105 pbuf = tfname = FullName_save(*fnamep, FALSE);
22107 len = tflen = (int)STRLEN(tfname);
22109 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22110 return FAIL;
22112 if (len == 0)
22114 /* Don't have a valid filename, so shorten the rest of the
22115 * path if we can. This CAN give us invalid 8.3 filenames, but
22116 * there's not a lot of point in guessing what it might be.
22118 len = tflen;
22119 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22120 return FAIL;
22123 /* Count the paths backward to find the beginning of the desired string. */
22124 for (p = tfname + len - 1; p >= tfname; --p)
22126 #ifdef FEAT_MBYTE
22127 if (has_mbyte)
22128 p -= mb_head_off(tfname, p);
22129 #endif
22130 if (vim_ispathsep(*p))
22132 if (sepcount == 0 || (hasTilde && sepcount == 1))
22133 break;
22134 else
22135 sepcount --;
22138 if (hasTilde)
22140 --p;
22141 if (p >= tfname)
22142 *p = '~';
22143 else
22144 return FAIL;
22146 else
22147 ++p;
22149 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22150 vim_free(*bufp);
22151 *fnamelen = (int)STRLEN(p);
22152 *bufp = pbuf;
22153 *fnamep = p;
22155 return OK;
22157 #endif /* WIN3264 */
22160 * Adjust a filename, according to a string of modifiers.
22161 * *fnamep must be NUL terminated when called. When returning, the length is
22162 * determined by *fnamelen.
22163 * Returns VALID_ flags or -1 for failure.
22164 * When there is an error, *fnamep is set to NULL.
22167 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22168 char_u *src; /* string with modifiers */
22169 int *usedlen; /* characters after src that are used */
22170 char_u **fnamep; /* file name so far */
22171 char_u **bufp; /* buffer for allocated file name or NULL */
22172 int *fnamelen; /* length of fnamep */
22174 int valid = 0;
22175 char_u *tail;
22176 char_u *s, *p, *pbuf;
22177 char_u dirname[MAXPATHL];
22178 int c;
22179 int has_fullname = 0;
22180 #ifdef WIN3264
22181 int has_shortname = 0;
22182 #endif
22184 repeat:
22185 /* ":p" - full path/file_name */
22186 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22188 has_fullname = 1;
22190 valid |= VALID_PATH;
22191 *usedlen += 2;
22193 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22194 if ((*fnamep)[0] == '~'
22195 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22196 && ((*fnamep)[1] == '/'
22197 # ifdef BACKSLASH_IN_FILENAME
22198 || (*fnamep)[1] == '\\'
22199 # endif
22200 || (*fnamep)[1] == NUL)
22202 #endif
22205 *fnamep = expand_env_save(*fnamep);
22206 vim_free(*bufp); /* free any allocated file name */
22207 *bufp = *fnamep;
22208 if (*fnamep == NULL)
22209 return -1;
22212 /* When "/." or "/.." is used: force expansion to get rid of it. */
22213 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22215 if (vim_ispathsep(*p)
22216 && p[1] == '.'
22217 && (p[2] == NUL
22218 || vim_ispathsep(p[2])
22219 || (p[2] == '.'
22220 && (p[3] == NUL || vim_ispathsep(p[3])))))
22221 break;
22224 /* FullName_save() is slow, don't use it when not needed. */
22225 if (*p != NUL || !vim_isAbsName(*fnamep))
22227 *fnamep = FullName_save(*fnamep, *p != NUL);
22228 vim_free(*bufp); /* free any allocated file name */
22229 *bufp = *fnamep;
22230 if (*fnamep == NULL)
22231 return -1;
22234 /* Append a path separator to a directory. */
22235 if (mch_isdir(*fnamep))
22237 /* Make room for one or two extra characters. */
22238 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22239 vim_free(*bufp); /* free any allocated file name */
22240 *bufp = *fnamep;
22241 if (*fnamep == NULL)
22242 return -1;
22243 add_pathsep(*fnamep);
22247 /* ":." - path relative to the current directory */
22248 /* ":~" - path relative to the home directory */
22249 /* ":8" - shortname path - postponed till after */
22250 while (src[*usedlen] == ':'
22251 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22253 *usedlen += 2;
22254 if (c == '8')
22256 #ifdef WIN3264
22257 has_shortname = 1; /* Postpone this. */
22258 #endif
22259 continue;
22261 pbuf = NULL;
22262 /* Need full path first (use expand_env() to remove a "~/") */
22263 if (!has_fullname)
22265 if (c == '.' && **fnamep == '~')
22266 p = pbuf = expand_env_save(*fnamep);
22267 else
22268 p = pbuf = FullName_save(*fnamep, FALSE);
22270 else
22271 p = *fnamep;
22273 has_fullname = 0;
22275 if (p != NULL)
22277 if (c == '.')
22279 mch_dirname(dirname, MAXPATHL);
22280 s = shorten_fname(p, dirname);
22281 if (s != NULL)
22283 *fnamep = s;
22284 if (pbuf != NULL)
22286 vim_free(*bufp); /* free any allocated file name */
22287 *bufp = pbuf;
22288 pbuf = NULL;
22292 else
22294 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22295 /* Only replace it when it starts with '~' */
22296 if (*dirname == '~')
22298 s = vim_strsave(dirname);
22299 if (s != NULL)
22301 *fnamep = s;
22302 vim_free(*bufp);
22303 *bufp = s;
22307 vim_free(pbuf);
22311 tail = gettail(*fnamep);
22312 *fnamelen = (int)STRLEN(*fnamep);
22314 /* ":h" - head, remove "/file_name", can be repeated */
22315 /* Don't remove the first "/" or "c:\" */
22316 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22318 valid |= VALID_HEAD;
22319 *usedlen += 2;
22320 s = get_past_head(*fnamep);
22321 while (tail > s && after_pathsep(s, tail))
22322 mb_ptr_back(*fnamep, tail);
22323 *fnamelen = (int)(tail - *fnamep);
22324 #ifdef VMS
22325 if (*fnamelen > 0)
22326 *fnamelen += 1; /* the path separator is part of the path */
22327 #endif
22328 if (*fnamelen == 0)
22330 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22331 p = vim_strsave((char_u *)".");
22332 if (p == NULL)
22333 return -1;
22334 vim_free(*bufp);
22335 *bufp = *fnamep = tail = p;
22336 *fnamelen = 1;
22338 else
22340 while (tail > s && !after_pathsep(s, tail))
22341 mb_ptr_back(*fnamep, tail);
22345 /* ":8" - shortname */
22346 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22348 *usedlen += 2;
22349 #ifdef WIN3264
22350 has_shortname = 1;
22351 #endif
22354 #ifdef WIN3264
22355 /* Check shortname after we have done 'heads' and before we do 'tails'
22357 if (has_shortname)
22359 pbuf = NULL;
22360 /* Copy the string if it is shortened by :h */
22361 if (*fnamelen < (int)STRLEN(*fnamep))
22363 p = vim_strnsave(*fnamep, *fnamelen);
22364 if (p == 0)
22365 return -1;
22366 vim_free(*bufp);
22367 *bufp = *fnamep = p;
22370 /* Split into two implementations - makes it easier. First is where
22371 * there isn't a full name already, second is where there is.
22373 if (!has_fullname && !vim_isAbsName(*fnamep))
22375 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22376 return -1;
22378 else
22380 int l;
22382 /* Simple case, already have the full-name
22383 * Nearly always shorter, so try first time. */
22384 l = *fnamelen;
22385 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22386 return -1;
22388 if (l == 0)
22390 /* Couldn't find the filename.. search the paths.
22392 l = *fnamelen;
22393 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22394 return -1;
22396 *fnamelen = l;
22399 #endif /* WIN3264 */
22401 /* ":t" - tail, just the basename */
22402 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22404 *usedlen += 2;
22405 *fnamelen -= (int)(tail - *fnamep);
22406 *fnamep = tail;
22409 /* ":e" - extension, can be repeated */
22410 /* ":r" - root, without extension, can be repeated */
22411 while (src[*usedlen] == ':'
22412 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22414 /* find a '.' in the tail:
22415 * - for second :e: before the current fname
22416 * - otherwise: The last '.'
22418 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22419 s = *fnamep - 2;
22420 else
22421 s = *fnamep + *fnamelen - 1;
22422 for ( ; s > tail; --s)
22423 if (s[0] == '.')
22424 break;
22425 if (src[*usedlen + 1] == 'e') /* :e */
22427 if (s > tail)
22429 *fnamelen += (int)(*fnamep - (s + 1));
22430 *fnamep = s + 1;
22431 #ifdef VMS
22432 /* cut version from the extension */
22433 s = *fnamep + *fnamelen - 1;
22434 for ( ; s > *fnamep; --s)
22435 if (s[0] == ';')
22436 break;
22437 if (s > *fnamep)
22438 *fnamelen = s - *fnamep;
22439 #endif
22441 else if (*fnamep <= tail)
22442 *fnamelen = 0;
22444 else /* :r */
22446 if (s > tail) /* remove one extension */
22447 *fnamelen = (int)(s - *fnamep);
22449 *usedlen += 2;
22452 /* ":s?pat?foo?" - substitute */
22453 /* ":gs?pat?foo?" - global substitute */
22454 if (src[*usedlen] == ':'
22455 && (src[*usedlen + 1] == 's'
22456 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22458 char_u *str;
22459 char_u *pat;
22460 char_u *sub;
22461 int sep;
22462 char_u *flags;
22463 int didit = FALSE;
22465 flags = (char_u *)"";
22466 s = src + *usedlen + 2;
22467 if (src[*usedlen + 1] == 'g')
22469 flags = (char_u *)"g";
22470 ++s;
22473 sep = *s++;
22474 if (sep)
22476 /* find end of pattern */
22477 p = vim_strchr(s, sep);
22478 if (p != NULL)
22480 pat = vim_strnsave(s, (int)(p - s));
22481 if (pat != NULL)
22483 s = p + 1;
22484 /* find end of substitution */
22485 p = vim_strchr(s, sep);
22486 if (p != NULL)
22488 sub = vim_strnsave(s, (int)(p - s));
22489 str = vim_strnsave(*fnamep, *fnamelen);
22490 if (sub != NULL && str != NULL)
22492 *usedlen = (int)(p + 1 - src);
22493 s = do_string_sub(str, pat, sub, flags);
22494 if (s != NULL)
22496 *fnamep = s;
22497 *fnamelen = (int)STRLEN(s);
22498 vim_free(*bufp);
22499 *bufp = s;
22500 didit = TRUE;
22503 vim_free(sub);
22504 vim_free(str);
22506 vim_free(pat);
22509 /* after using ":s", repeat all the modifiers */
22510 if (didit)
22511 goto repeat;
22515 return valid;
22519 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22520 * "flags" can be "g" to do a global substitute.
22521 * Returns an allocated string, NULL for error.
22523 char_u *
22524 do_string_sub(str, pat, sub, flags)
22525 char_u *str;
22526 char_u *pat;
22527 char_u *sub;
22528 char_u *flags;
22530 int sublen;
22531 regmatch_T regmatch;
22532 int i;
22533 int do_all;
22534 char_u *tail;
22535 garray_T ga;
22536 char_u *ret;
22537 char_u *save_cpo;
22539 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22540 save_cpo = p_cpo;
22541 p_cpo = empty_option;
22543 ga_init2(&ga, 1, 200);
22545 do_all = (flags[0] == 'g');
22547 regmatch.rm_ic = p_ic;
22548 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22549 if (regmatch.regprog != NULL)
22551 tail = str;
22552 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22555 * Get some space for a temporary buffer to do the substitution
22556 * into. It will contain:
22557 * - The text up to where the match is.
22558 * - The substituted text.
22559 * - The text after the match.
22561 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22562 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22563 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22565 ga_clear(&ga);
22566 break;
22569 /* copy the text up to where the match is */
22570 i = (int)(regmatch.startp[0] - tail);
22571 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22572 /* add the substituted text */
22573 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22574 + ga.ga_len + i, TRUE, TRUE, FALSE);
22575 ga.ga_len += i + sublen - 1;
22576 /* avoid getting stuck on a match with an empty string */
22577 if (tail == regmatch.endp[0])
22579 if (*tail == NUL)
22580 break;
22581 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22582 ++ga.ga_len;
22584 else
22586 tail = regmatch.endp[0];
22587 if (*tail == NUL)
22588 break;
22590 if (!do_all)
22591 break;
22594 if (ga.ga_data != NULL)
22595 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22597 vim_free(regmatch.regprog);
22600 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22601 ga_clear(&ga);
22602 if (p_cpo == empty_option)
22603 p_cpo = save_cpo;
22604 else
22605 /* Darn, evaluating {sub} expression changed the value. */
22606 free_string_option(save_cpo);
22608 return ret;
22611 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */