Use 7.2a "spell" folder (and remove all extra spell files)
[MacVim.git] / src / eval.c
blob7ebaa08f12a349555ed67c07d7a191f2727da654
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(MSWIN)
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 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1279 ga_append(&ga, NUL);
1280 retval = (char_u *)ga.ga_data;
1282 else
1283 retval = vim_strsave(get_tv_string(&tv));
1284 clear_tv(&tv);
1287 return retval;
1291 * Call eval_to_string() without using current local variables and using
1292 * textlock. When "use_sandbox" is TRUE use the sandbox.
1294 char_u *
1295 eval_to_string_safe(arg, nextcmd, use_sandbox)
1296 char_u *arg;
1297 char_u **nextcmd;
1298 int use_sandbox;
1300 char_u *retval;
1301 void *save_funccalp;
1303 save_funccalp = save_funccal();
1304 if (use_sandbox)
1305 ++sandbox;
1306 ++textlock;
1307 retval = eval_to_string(arg, nextcmd, FALSE);
1308 if (use_sandbox)
1309 --sandbox;
1310 --textlock;
1311 restore_funccal(save_funccalp);
1312 return retval;
1316 * Top level evaluation function, returning a number.
1317 * Evaluates "expr" silently.
1318 * Returns -1 for an error.
1321 eval_to_number(expr)
1322 char_u *expr;
1324 typval_T rettv;
1325 int retval;
1326 char_u *p = skipwhite(expr);
1328 ++emsg_off;
1330 if (eval1(&p, &rettv, TRUE) == FAIL)
1331 retval = -1;
1332 else
1334 retval = get_tv_number_chk(&rettv, NULL);
1335 clear_tv(&rettv);
1337 --emsg_off;
1339 return retval;
1343 * Prepare v: variable "idx" to be used.
1344 * Save the current typeval in "save_tv".
1345 * When not used yet add the variable to the v: hashtable.
1347 static void
1348 prepare_vimvar(idx, save_tv)
1349 int idx;
1350 typval_T *save_tv;
1352 *save_tv = vimvars[idx].vv_tv;
1353 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1354 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1358 * Restore v: variable "idx" to typeval "save_tv".
1359 * When no longer defined, remove the variable from the v: hashtable.
1361 static void
1362 restore_vimvar(idx, save_tv)
1363 int idx;
1364 typval_T *save_tv;
1366 hashitem_T *hi;
1368 vimvars[idx].vv_tv = *save_tv;
1369 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1371 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1372 if (HASHITEM_EMPTY(hi))
1373 EMSG2(_(e_intern2), "restore_vimvar()");
1374 else
1375 hash_remove(&vimvarht, hi);
1379 #if defined(FEAT_SPELL) || defined(PROTO)
1381 * Evaluate an expression to a list with suggestions.
1382 * For the "expr:" part of 'spellsuggest'.
1384 list_T *
1385 eval_spell_expr(badword, expr)
1386 char_u *badword;
1387 char_u *expr;
1389 typval_T save_val;
1390 typval_T rettv;
1391 list_T *list = NULL;
1392 char_u *p = skipwhite(expr);
1394 /* Set "v:val" to the bad word. */
1395 prepare_vimvar(VV_VAL, &save_val);
1396 vimvars[VV_VAL].vv_type = VAR_STRING;
1397 vimvars[VV_VAL].vv_str = badword;
1398 if (p_verbose == 0)
1399 ++emsg_off;
1401 if (eval1(&p, &rettv, TRUE) == OK)
1403 if (rettv.v_type != VAR_LIST)
1404 clear_tv(&rettv);
1405 else
1406 list = rettv.vval.v_list;
1409 if (p_verbose == 0)
1410 --emsg_off;
1411 restore_vimvar(VV_VAL, &save_val);
1413 return list;
1417 * "list" is supposed to contain two items: a word and a number. Return the
1418 * word in "pp" and the number as the return value.
1419 * Return -1 if anything isn't right.
1420 * Used to get the good word and score from the eval_spell_expr() result.
1423 get_spellword(list, pp)
1424 list_T *list;
1425 char_u **pp;
1427 listitem_T *li;
1429 li = list->lv_first;
1430 if (li == NULL)
1431 return -1;
1432 *pp = get_tv_string(&li->li_tv);
1434 li = li->li_next;
1435 if (li == NULL)
1436 return -1;
1437 return get_tv_number(&li->li_tv);
1439 #endif
1442 * Top level evaluation function.
1443 * Returns an allocated typval_T with the result.
1444 * Returns NULL when there is an error.
1446 typval_T *
1447 eval_expr(arg, nextcmd)
1448 char_u *arg;
1449 char_u **nextcmd;
1451 typval_T *tv;
1453 tv = (typval_T *)alloc(sizeof(typval_T));
1454 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1456 vim_free(tv);
1457 tv = NULL;
1460 return tv;
1464 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1465 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1467 * Call some vimL function and return the result in "*rettv".
1468 * Uses argv[argc] for the function arguments. Only Number and String
1469 * arguments are currently supported.
1470 * Returns OK or FAIL.
1472 static int
1473 call_vim_function(func, argc, argv, safe, rettv)
1474 char_u *func;
1475 int argc;
1476 char_u **argv;
1477 int safe; /* use the sandbox */
1478 typval_T *rettv;
1480 typval_T *argvars;
1481 long n;
1482 int len;
1483 int i;
1484 int doesrange;
1485 void *save_funccalp = NULL;
1486 int ret;
1488 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1489 if (argvars == NULL)
1490 return FAIL;
1492 for (i = 0; i < argc; i++)
1494 /* Pass a NULL or empty argument as an empty string */
1495 if (argv[i] == NULL || *argv[i] == NUL)
1497 argvars[i].v_type = VAR_STRING;
1498 argvars[i].vval.v_string = (char_u *)"";
1499 continue;
1502 /* Recognize a number argument, the others must be strings. */
1503 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1504 if (len != 0 && len == (int)STRLEN(argv[i]))
1506 argvars[i].v_type = VAR_NUMBER;
1507 argvars[i].vval.v_number = n;
1509 else
1511 argvars[i].v_type = VAR_STRING;
1512 argvars[i].vval.v_string = argv[i];
1516 if (safe)
1518 save_funccalp = save_funccal();
1519 ++sandbox;
1522 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1523 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1524 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1525 &doesrange, TRUE, NULL);
1526 if (safe)
1528 --sandbox;
1529 restore_funccal(save_funccalp);
1531 vim_free(argvars);
1533 if (ret == FAIL)
1534 clear_tv(rettv);
1536 return ret;
1539 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1541 * Call vimL function "func" and return the result as a string.
1542 * Returns NULL when calling the function fails.
1543 * Uses argv[argc] for the function arguments.
1545 void *
1546 call_func_retstr(func, argc, argv, safe)
1547 char_u *func;
1548 int argc;
1549 char_u **argv;
1550 int safe; /* use the sandbox */
1552 typval_T rettv;
1553 char_u *retval;
1555 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1556 return NULL;
1558 retval = vim_strsave(get_tv_string(&rettv));
1559 clear_tv(&rettv);
1560 return retval;
1562 # endif
1564 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1566 * Call vimL function "func" and return the result as a number.
1567 * Returns -1 when calling the function fails.
1568 * Uses argv[argc] for the function arguments.
1570 long
1571 call_func_retnr(func, argc, argv, safe)
1572 char_u *func;
1573 int argc;
1574 char_u **argv;
1575 int safe; /* use the sandbox */
1577 typval_T rettv;
1578 long retval;
1580 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1581 return -1;
1583 retval = get_tv_number_chk(&rettv, NULL);
1584 clear_tv(&rettv);
1585 return retval;
1587 # endif
1590 * Call vimL function "func" and return the result as a list
1591 * Uses argv[argc] for the function arguments.
1593 void *
1594 call_func_retlist(func, argc, argv, safe)
1595 char_u *func;
1596 int argc;
1597 char_u **argv;
1598 int safe; /* use the sandbox */
1600 typval_T rettv;
1602 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1603 return NULL;
1605 if (rettv.v_type != VAR_LIST)
1607 clear_tv(&rettv);
1608 return NULL;
1611 return rettv.vval.v_list;
1613 #endif
1617 * Save the current function call pointer, and set it to NULL.
1618 * Used when executing autocommands and for ":source".
1620 void *
1621 save_funccal()
1623 funccall_T *fc = current_funccal;
1625 current_funccal = NULL;
1626 return (void *)fc;
1629 void
1630 restore_funccal(vfc)
1631 void *vfc;
1633 funccall_T *fc = (funccall_T *)vfc;
1635 current_funccal = fc;
1638 #if defined(FEAT_PROFILE) || defined(PROTO)
1640 * Prepare profiling for entering a child or something else that is not
1641 * counted for the script/function itself.
1642 * Should always be called in pair with prof_child_exit().
1644 void
1645 prof_child_enter(tm)
1646 proftime_T *tm; /* place to store waittime */
1648 funccall_T *fc = current_funccal;
1650 if (fc != NULL && fc->func->uf_profiling)
1651 profile_start(&fc->prof_child);
1652 script_prof_save(tm);
1656 * Take care of time spent in a child.
1657 * Should always be called after prof_child_enter().
1659 void
1660 prof_child_exit(tm)
1661 proftime_T *tm; /* where waittime was stored */
1663 funccall_T *fc = current_funccal;
1665 if (fc != NULL && fc->func->uf_profiling)
1667 profile_end(&fc->prof_child);
1668 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1669 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1670 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1672 script_prof_restore(tm);
1674 #endif
1677 #ifdef FEAT_FOLDING
1679 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1680 * it in "*cp". Doesn't give error messages.
1683 eval_foldexpr(arg, cp)
1684 char_u *arg;
1685 int *cp;
1687 typval_T tv;
1688 int retval;
1689 char_u *s;
1690 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1691 OPT_LOCAL);
1693 ++emsg_off;
1694 if (use_sandbox)
1695 ++sandbox;
1696 ++textlock;
1697 *cp = NUL;
1698 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1699 retval = 0;
1700 else
1702 /* If the result is a number, just return the number. */
1703 if (tv.v_type == VAR_NUMBER)
1704 retval = tv.vval.v_number;
1705 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1706 retval = 0;
1707 else
1709 /* If the result is a string, check if there is a non-digit before
1710 * the number. */
1711 s = tv.vval.v_string;
1712 if (!VIM_ISDIGIT(*s) && *s != '-')
1713 *cp = *s++;
1714 retval = atol((char *)s);
1716 clear_tv(&tv);
1718 --emsg_off;
1719 if (use_sandbox)
1720 --sandbox;
1721 --textlock;
1723 return retval;
1725 #endif
1728 * ":let" list all variable values
1729 * ":let var1 var2" list variable values
1730 * ":let var = expr" assignment command.
1731 * ":let var += expr" assignment command.
1732 * ":let var -= expr" assignment command.
1733 * ":let var .= expr" assignment command.
1734 * ":let [var1, var2] = expr" unpack list.
1736 void
1737 ex_let(eap)
1738 exarg_T *eap;
1740 char_u *arg = eap->arg;
1741 char_u *expr = NULL;
1742 typval_T rettv;
1743 int i;
1744 int var_count = 0;
1745 int semicolon = 0;
1746 char_u op[2];
1747 char_u *argend;
1748 int first = TRUE;
1750 argend = skip_var_list(arg, &var_count, &semicolon);
1751 if (argend == NULL)
1752 return;
1753 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1754 --argend;
1755 expr = vim_strchr(argend, '=');
1756 if (expr == NULL)
1759 * ":let" without "=": list variables
1761 if (*arg == '[')
1762 EMSG(_(e_invarg));
1763 else if (!ends_excmd(*arg))
1764 /* ":let var1 var2" */
1765 arg = list_arg_vars(eap, arg, &first);
1766 else if (!eap->skip)
1768 /* ":let" */
1769 list_glob_vars(&first);
1770 list_buf_vars(&first);
1771 list_win_vars(&first);
1772 #ifdef FEAT_WINDOWS
1773 list_tab_vars(&first);
1774 #endif
1775 list_script_vars(&first);
1776 list_func_vars(&first);
1777 list_vim_vars(&first);
1779 eap->nextcmd = check_nextcmd(arg);
1781 else
1783 op[0] = '=';
1784 op[1] = NUL;
1785 if (expr > argend)
1787 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1788 op[0] = expr[-1]; /* +=, -= or .= */
1790 expr = skipwhite(expr + 1);
1792 if (eap->skip)
1793 ++emsg_skip;
1794 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1795 if (eap->skip)
1797 if (i != FAIL)
1798 clear_tv(&rettv);
1799 --emsg_skip;
1801 else if (i != FAIL)
1803 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1804 op);
1805 clear_tv(&rettv);
1811 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1812 * Handles both "var" with any type and "[var, var; var]" with a list type.
1813 * When "nextchars" is not NULL it points to a string with characters that
1814 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1815 * or concatenate.
1816 * Returns OK or FAIL;
1818 static int
1819 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1820 char_u *arg_start;
1821 typval_T *tv;
1822 int copy; /* copy values from "tv", don't move */
1823 int semicolon; /* from skip_var_list() */
1824 int var_count; /* from skip_var_list() */
1825 char_u *nextchars;
1827 char_u *arg = arg_start;
1828 list_T *l;
1829 int i;
1830 listitem_T *item;
1831 typval_T ltv;
1833 if (*arg != '[')
1836 * ":let var = expr" or ":for var in list"
1838 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1839 return FAIL;
1840 return OK;
1844 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1846 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1848 EMSG(_(e_listreq));
1849 return FAIL;
1852 i = list_len(l);
1853 if (semicolon == 0 && var_count < i)
1855 EMSG(_("E687: Less targets than List items"));
1856 return FAIL;
1858 if (var_count - semicolon > i)
1860 EMSG(_("E688: More targets than List items"));
1861 return FAIL;
1864 item = l->lv_first;
1865 while (*arg != ']')
1867 arg = skipwhite(arg + 1);
1868 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1869 item = item->li_next;
1870 if (arg == NULL)
1871 return FAIL;
1873 arg = skipwhite(arg);
1874 if (*arg == ';')
1876 /* Put the rest of the list (may be empty) in the var after ';'.
1877 * Create a new list for this. */
1878 l = list_alloc();
1879 if (l == NULL)
1880 return FAIL;
1881 while (item != NULL)
1883 list_append_tv(l, &item->li_tv);
1884 item = item->li_next;
1887 ltv.v_type = VAR_LIST;
1888 ltv.v_lock = 0;
1889 ltv.vval.v_list = l;
1890 l->lv_refcount = 1;
1892 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1893 (char_u *)"]", nextchars);
1894 clear_tv(&ltv);
1895 if (arg == NULL)
1896 return FAIL;
1897 break;
1899 else if (*arg != ',' && *arg != ']')
1901 EMSG2(_(e_intern2), "ex_let_vars()");
1902 return FAIL;
1906 return OK;
1910 * Skip over assignable variable "var" or list of variables "[var, var]".
1911 * Used for ":let varvar = expr" and ":for varvar in expr".
1912 * For "[var, var]" increment "*var_count" for each variable.
1913 * for "[var, var; var]" set "semicolon".
1914 * Return NULL for an error.
1916 static char_u *
1917 skip_var_list(arg, var_count, semicolon)
1918 char_u *arg;
1919 int *var_count;
1920 int *semicolon;
1922 char_u *p, *s;
1924 if (*arg == '[')
1926 /* "[var, var]": find the matching ']'. */
1927 p = arg;
1928 for (;;)
1930 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1931 s = skip_var_one(p);
1932 if (s == p)
1934 EMSG2(_(e_invarg2), p);
1935 return NULL;
1937 ++*var_count;
1939 p = skipwhite(s);
1940 if (*p == ']')
1941 break;
1942 else if (*p == ';')
1944 if (*semicolon == 1)
1946 EMSG(_("Double ; in list of variables"));
1947 return NULL;
1949 *semicolon = 1;
1951 else if (*p != ',')
1953 EMSG2(_(e_invarg2), p);
1954 return NULL;
1957 return p + 1;
1959 else
1960 return skip_var_one(arg);
1964 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1965 * l[idx].
1967 static char_u *
1968 skip_var_one(arg)
1969 char_u *arg;
1971 if (*arg == '@' && arg[1] != NUL)
1972 return arg + 2;
1973 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
1974 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1978 * List variables for hashtab "ht" with prefix "prefix".
1979 * If "empty" is TRUE also list NULL strings as empty strings.
1981 static void
1982 list_hashtable_vars(ht, prefix, empty, first)
1983 hashtab_T *ht;
1984 char_u *prefix;
1985 int empty;
1986 int *first;
1988 hashitem_T *hi;
1989 dictitem_T *di;
1990 int todo;
1992 todo = (int)ht->ht_used;
1993 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1995 if (!HASHITEM_EMPTY(hi))
1997 --todo;
1998 di = HI2DI(hi);
1999 if (empty || di->di_tv.v_type != VAR_STRING
2000 || di->di_tv.vval.v_string != NULL)
2001 list_one_var(di, prefix, first);
2007 * List global variables.
2009 static void
2010 list_glob_vars(first)
2011 int *first;
2013 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2017 * List buffer variables.
2019 static void
2020 list_buf_vars(first)
2021 int *first;
2023 char_u numbuf[NUMBUFLEN];
2025 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2026 TRUE, first);
2028 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2029 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2030 numbuf, first);
2034 * List window variables.
2036 static void
2037 list_win_vars(first)
2038 int *first;
2040 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2041 (char_u *)"w:", TRUE, first);
2044 #ifdef FEAT_WINDOWS
2046 * List tab page variables.
2048 static void
2049 list_tab_vars(first)
2050 int *first;
2052 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2053 (char_u *)"t:", TRUE, first);
2055 #endif
2058 * List Vim variables.
2060 static void
2061 list_vim_vars(first)
2062 int *first;
2064 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2068 * List script-local variables, if there is a script.
2070 static void
2071 list_script_vars(first)
2072 int *first;
2074 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2075 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2076 (char_u *)"s:", FALSE, first);
2080 * List function variables, if there is a function.
2082 static void
2083 list_func_vars(first)
2084 int *first;
2086 if (current_funccal != NULL)
2087 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2088 (char_u *)"l:", FALSE, first);
2092 * List variables in "arg".
2094 static char_u *
2095 list_arg_vars(eap, arg, first)
2096 exarg_T *eap;
2097 char_u *arg;
2098 int *first;
2100 int error = FALSE;
2101 int len;
2102 char_u *name;
2103 char_u *name_start;
2104 char_u *arg_subsc;
2105 char_u *tofree;
2106 typval_T tv;
2108 while (!ends_excmd(*arg) && !got_int)
2110 if (error || eap->skip)
2112 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2113 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2115 emsg_severe = TRUE;
2116 EMSG(_(e_trailing));
2117 break;
2120 else
2122 /* get_name_len() takes care of expanding curly braces */
2123 name_start = name = arg;
2124 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2125 if (len <= 0)
2127 /* This is mainly to keep test 49 working: when expanding
2128 * curly braces fails overrule the exception error message. */
2129 if (len < 0 && !aborting())
2131 emsg_severe = TRUE;
2132 EMSG2(_(e_invarg2), arg);
2133 break;
2135 error = TRUE;
2137 else
2139 if (tofree != NULL)
2140 name = tofree;
2141 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2142 error = TRUE;
2143 else
2145 /* handle d.key, l[idx], f(expr) */
2146 arg_subsc = arg;
2147 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2148 error = TRUE;
2149 else
2151 if (arg == arg_subsc && len == 2 && name[1] == ':')
2153 switch (*name)
2155 case 'g': list_glob_vars(first); break;
2156 case 'b': list_buf_vars(first); break;
2157 case 'w': list_win_vars(first); break;
2158 #ifdef FEAT_WINDOWS
2159 case 't': list_tab_vars(first); break;
2160 #endif
2161 case 'v': list_vim_vars(first); break;
2162 case 's': list_script_vars(first); break;
2163 case 'l': list_func_vars(first); break;
2164 default:
2165 EMSG2(_("E738: Can't list variables for %s"), name);
2168 else
2170 char_u numbuf[NUMBUFLEN];
2171 char_u *tf;
2172 int c;
2173 char_u *s;
2175 s = echo_string(&tv, &tf, numbuf, 0);
2176 c = *arg;
2177 *arg = NUL;
2178 list_one_var_a((char_u *)"",
2179 arg == arg_subsc ? name : name_start,
2180 tv.v_type,
2181 s == NULL ? (char_u *)"" : s,
2182 first);
2183 *arg = c;
2184 vim_free(tf);
2186 clear_tv(&tv);
2191 vim_free(tofree);
2194 arg = skipwhite(arg);
2197 return arg;
2201 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2202 * Returns a pointer to the char just after the var name.
2203 * Returns NULL if there is an error.
2205 static char_u *
2206 ex_let_one(arg, tv, copy, endchars, op)
2207 char_u *arg; /* points to variable name */
2208 typval_T *tv; /* value to assign to variable */
2209 int copy; /* copy value from "tv" */
2210 char_u *endchars; /* valid chars after variable name or NULL */
2211 char_u *op; /* "+", "-", "." or NULL*/
2213 int c1;
2214 char_u *name;
2215 char_u *p;
2216 char_u *arg_end = NULL;
2217 int len;
2218 int opt_flags;
2219 char_u *tofree = NULL;
2222 * ":let $VAR = expr": Set environment variable.
2224 if (*arg == '$')
2226 /* Find the end of the name. */
2227 ++arg;
2228 name = arg;
2229 len = get_env_len(&arg);
2230 if (len == 0)
2231 EMSG2(_(e_invarg2), name - 1);
2232 else
2234 if (op != NULL && (*op == '+' || *op == '-'))
2235 EMSG2(_(e_letwrong), op);
2236 else if (endchars != NULL
2237 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2238 EMSG(_(e_letunexp));
2239 else
2241 c1 = name[len];
2242 name[len] = NUL;
2243 p = get_tv_string_chk(tv);
2244 if (p != NULL && op != NULL && *op == '.')
2246 int mustfree = FALSE;
2247 char_u *s = vim_getenv(name, &mustfree);
2249 if (s != NULL)
2251 p = tofree = concat_str(s, p);
2252 if (mustfree)
2253 vim_free(s);
2256 if (p != NULL)
2258 vim_setenv(name, p);
2259 if (STRICMP(name, "HOME") == 0)
2260 init_homedir();
2261 else if (didset_vim && STRICMP(name, "VIM") == 0)
2262 didset_vim = FALSE;
2263 else if (didset_vimruntime
2264 && STRICMP(name, "VIMRUNTIME") == 0)
2265 didset_vimruntime = FALSE;
2266 arg_end = arg;
2268 name[len] = c1;
2269 vim_free(tofree);
2275 * ":let &option = expr": Set option value.
2276 * ":let &l:option = expr": Set local option value.
2277 * ":let &g:option = expr": Set global option value.
2279 else if (*arg == '&')
2281 /* Find the end of the name. */
2282 p = find_option_end(&arg, &opt_flags);
2283 if (p == NULL || (endchars != NULL
2284 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2285 EMSG(_(e_letunexp));
2286 else
2288 long n;
2289 int opt_type;
2290 long numval;
2291 char_u *stringval = NULL;
2292 char_u *s;
2294 c1 = *p;
2295 *p = NUL;
2297 n = get_tv_number(tv);
2298 s = get_tv_string_chk(tv); /* != NULL if number or string */
2299 if (s != NULL && op != NULL && *op != '=')
2301 opt_type = get_option_value(arg, &numval,
2302 &stringval, opt_flags);
2303 if ((opt_type == 1 && *op == '.')
2304 || (opt_type == 0 && *op != '.'))
2305 EMSG2(_(e_letwrong), op);
2306 else
2308 if (opt_type == 1) /* number */
2310 if (*op == '+')
2311 n = numval + n;
2312 else
2313 n = numval - n;
2315 else if (opt_type == 0 && stringval != NULL) /* string */
2317 s = concat_str(stringval, s);
2318 vim_free(stringval);
2319 stringval = s;
2323 if (s != NULL)
2325 set_option_value(arg, n, s, opt_flags);
2326 arg_end = p;
2328 *p = c1;
2329 vim_free(stringval);
2334 * ":let @r = expr": Set register contents.
2336 else if (*arg == '@')
2338 ++arg;
2339 if (op != NULL && (*op == '+' || *op == '-'))
2340 EMSG2(_(e_letwrong), op);
2341 else if (endchars != NULL
2342 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2343 EMSG(_(e_letunexp));
2344 else
2346 char_u *ptofree = NULL;
2347 char_u *s;
2349 p = get_tv_string_chk(tv);
2350 if (p != NULL && op != NULL && *op == '.')
2352 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2353 if (s != NULL)
2355 p = ptofree = concat_str(s, p);
2356 vim_free(s);
2359 if (p != NULL)
2361 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2362 arg_end = arg + 1;
2364 vim_free(ptofree);
2369 * ":let var = expr": Set internal variable.
2370 * ":let {expr} = expr": Idem, name made with curly braces
2372 else if (eval_isnamec1(*arg) || *arg == '{')
2374 lval_T lv;
2376 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2377 if (p != NULL && lv.ll_name != NULL)
2379 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2380 EMSG(_(e_letunexp));
2381 else
2383 set_var_lval(&lv, p, tv, copy, op);
2384 arg_end = p;
2387 clear_lval(&lv);
2390 else
2391 EMSG2(_(e_invarg2), arg);
2393 return arg_end;
2397 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2399 static int
2400 check_changedtick(arg)
2401 char_u *arg;
2403 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2405 EMSG2(_(e_readonlyvar), arg);
2406 return TRUE;
2408 return FALSE;
2412 * Get an lval: variable, Dict item or List item that can be assigned a value
2413 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2414 * "name.key", "name.key[expr]" etc.
2415 * Indexing only works if "name" is an existing List or Dictionary.
2416 * "name" points to the start of the name.
2417 * If "rettv" is not NULL it points to the value to be assigned.
2418 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2419 * wrong; must end in space or cmd separator.
2421 * Returns a pointer to just after the name, including indexes.
2422 * When an evaluation error occurs "lp->ll_name" is NULL;
2423 * Returns NULL for a parsing error. Still need to free items in "lp"!
2425 static char_u *
2426 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2427 char_u *name;
2428 typval_T *rettv;
2429 lval_T *lp;
2430 int unlet;
2431 int skip;
2432 int quiet; /* don't give error messages */
2433 int fne_flags; /* flags for find_name_end() */
2435 char_u *p;
2436 char_u *expr_start, *expr_end;
2437 int cc;
2438 dictitem_T *v;
2439 typval_T var1;
2440 typval_T var2;
2441 int empty1 = FALSE;
2442 listitem_T *ni;
2443 char_u *key = NULL;
2444 int len;
2445 hashtab_T *ht;
2447 /* Clear everything in "lp". */
2448 vim_memset(lp, 0, sizeof(lval_T));
2450 if (skip)
2452 /* When skipping just find the end of the name. */
2453 lp->ll_name = name;
2454 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2457 /* Find the end of the name. */
2458 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2459 if (expr_start != NULL)
2461 /* Don't expand the name when we already know there is an error. */
2462 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2463 && *p != '[' && *p != '.')
2465 EMSG(_(e_trailing));
2466 return NULL;
2469 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2470 if (lp->ll_exp_name == NULL)
2472 /* Report an invalid expression in braces, unless the
2473 * expression evaluation has been cancelled due to an
2474 * aborting error, an interrupt, or an exception. */
2475 if (!aborting() && !quiet)
2477 emsg_severe = TRUE;
2478 EMSG2(_(e_invarg2), name);
2479 return NULL;
2482 lp->ll_name = lp->ll_exp_name;
2484 else
2485 lp->ll_name = name;
2487 /* Without [idx] or .key we are done. */
2488 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2489 return p;
2491 cc = *p;
2492 *p = NUL;
2493 v = find_var(lp->ll_name, &ht);
2494 if (v == NULL && !quiet)
2495 EMSG2(_(e_undefvar), lp->ll_name);
2496 *p = cc;
2497 if (v == NULL)
2498 return NULL;
2501 * Loop until no more [idx] or .key is following.
2503 lp->ll_tv = &v->di_tv;
2504 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2506 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2507 && !(lp->ll_tv->v_type == VAR_DICT
2508 && lp->ll_tv->vval.v_dict != NULL))
2510 if (!quiet)
2511 EMSG(_("E689: Can only index a List or Dictionary"));
2512 return NULL;
2514 if (lp->ll_range)
2516 if (!quiet)
2517 EMSG(_("E708: [:] must come last"));
2518 return NULL;
2521 len = -1;
2522 if (*p == '.')
2524 key = p + 1;
2525 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2527 if (len == 0)
2529 if (!quiet)
2530 EMSG(_(e_emptykey));
2531 return NULL;
2533 p = key + len;
2535 else
2537 /* Get the index [expr] or the first index [expr: ]. */
2538 p = skipwhite(p + 1);
2539 if (*p == ':')
2540 empty1 = TRUE;
2541 else
2543 empty1 = FALSE;
2544 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2545 return NULL;
2546 if (get_tv_string_chk(&var1) == NULL)
2548 /* not a number or string */
2549 clear_tv(&var1);
2550 return NULL;
2554 /* Optionally get the second index [ :expr]. */
2555 if (*p == ':')
2557 if (lp->ll_tv->v_type == VAR_DICT)
2559 if (!quiet)
2560 EMSG(_(e_dictrange));
2561 if (!empty1)
2562 clear_tv(&var1);
2563 return NULL;
2565 if (rettv != NULL && (rettv->v_type != VAR_LIST
2566 || rettv->vval.v_list == NULL))
2568 if (!quiet)
2569 EMSG(_("E709: [:] requires a List value"));
2570 if (!empty1)
2571 clear_tv(&var1);
2572 return NULL;
2574 p = skipwhite(p + 1);
2575 if (*p == ']')
2576 lp->ll_empty2 = TRUE;
2577 else
2579 lp->ll_empty2 = FALSE;
2580 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2582 if (!empty1)
2583 clear_tv(&var1);
2584 return NULL;
2586 if (get_tv_string_chk(&var2) == NULL)
2588 /* not a number or string */
2589 if (!empty1)
2590 clear_tv(&var1);
2591 clear_tv(&var2);
2592 return NULL;
2595 lp->ll_range = TRUE;
2597 else
2598 lp->ll_range = FALSE;
2600 if (*p != ']')
2602 if (!quiet)
2603 EMSG(_(e_missbrac));
2604 if (!empty1)
2605 clear_tv(&var1);
2606 if (lp->ll_range && !lp->ll_empty2)
2607 clear_tv(&var2);
2608 return NULL;
2611 /* Skip to past ']'. */
2612 ++p;
2615 if (lp->ll_tv->v_type == VAR_DICT)
2617 if (len == -1)
2619 /* "[key]": get key from "var1" */
2620 key = get_tv_string(&var1); /* is number or string */
2621 if (*key == NUL)
2623 if (!quiet)
2624 EMSG(_(e_emptykey));
2625 clear_tv(&var1);
2626 return NULL;
2629 lp->ll_list = NULL;
2630 lp->ll_dict = lp->ll_tv->vval.v_dict;
2631 lp->ll_di = dict_find(lp->ll_dict, key, len);
2632 if (lp->ll_di == NULL)
2634 /* Key does not exist in dict: may need to add it. */
2635 if (*p == '[' || *p == '.' || unlet)
2637 if (!quiet)
2638 EMSG2(_(e_dictkey), key);
2639 if (len == -1)
2640 clear_tv(&var1);
2641 return NULL;
2643 if (len == -1)
2644 lp->ll_newkey = vim_strsave(key);
2645 else
2646 lp->ll_newkey = vim_strnsave(key, len);
2647 if (len == -1)
2648 clear_tv(&var1);
2649 if (lp->ll_newkey == NULL)
2650 p = NULL;
2651 break;
2653 if (len == -1)
2654 clear_tv(&var1);
2655 lp->ll_tv = &lp->ll_di->di_tv;
2657 else
2660 * Get the number and item for the only or first index of the List.
2662 if (empty1)
2663 lp->ll_n1 = 0;
2664 else
2666 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2667 clear_tv(&var1);
2669 lp->ll_dict = NULL;
2670 lp->ll_list = lp->ll_tv->vval.v_list;
2671 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2672 if (lp->ll_li == NULL)
2674 if (lp->ll_n1 < 0)
2676 lp->ll_n1 = 0;
2677 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2680 if (lp->ll_li == NULL)
2682 if (lp->ll_range && !lp->ll_empty2)
2683 clear_tv(&var2);
2684 return NULL;
2688 * May need to find the item or absolute index for the second
2689 * index of a range.
2690 * When no index given: "lp->ll_empty2" is TRUE.
2691 * Otherwise "lp->ll_n2" is set to the second index.
2693 if (lp->ll_range && !lp->ll_empty2)
2695 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2696 clear_tv(&var2);
2697 if (lp->ll_n2 < 0)
2699 ni = list_find(lp->ll_list, lp->ll_n2);
2700 if (ni == NULL)
2701 return NULL;
2702 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2705 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2706 if (lp->ll_n1 < 0)
2707 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2708 if (lp->ll_n2 < lp->ll_n1)
2709 return NULL;
2712 lp->ll_tv = &lp->ll_li->li_tv;
2716 return p;
2720 * Clear lval "lp" that was filled by get_lval().
2722 static void
2723 clear_lval(lp)
2724 lval_T *lp;
2726 vim_free(lp->ll_exp_name);
2727 vim_free(lp->ll_newkey);
2731 * Set a variable that was parsed by get_lval() to "rettv".
2732 * "endp" points to just after the parsed name.
2733 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2735 static void
2736 set_var_lval(lp, endp, rettv, copy, op)
2737 lval_T *lp;
2738 char_u *endp;
2739 typval_T *rettv;
2740 int copy;
2741 char_u *op;
2743 int cc;
2744 listitem_T *ri;
2745 dictitem_T *di;
2747 if (lp->ll_tv == NULL)
2749 if (!check_changedtick(lp->ll_name))
2751 cc = *endp;
2752 *endp = NUL;
2753 if (op != NULL && *op != '=')
2755 typval_T tv;
2757 /* handle +=, -= and .= */
2758 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2759 &tv, TRUE) == OK)
2761 if (tv_op(&tv, rettv, op) == OK)
2762 set_var(lp->ll_name, &tv, FALSE);
2763 clear_tv(&tv);
2766 else
2767 set_var(lp->ll_name, rettv, copy);
2768 *endp = cc;
2771 else if (tv_check_lock(lp->ll_newkey == NULL
2772 ? lp->ll_tv->v_lock
2773 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2775 else if (lp->ll_range)
2778 * Assign the List values to the list items.
2780 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2782 if (op != NULL && *op != '=')
2783 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2784 else
2786 clear_tv(&lp->ll_li->li_tv);
2787 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2789 ri = ri->li_next;
2790 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2791 break;
2792 if (lp->ll_li->li_next == NULL)
2794 /* Need to add an empty item. */
2795 if (list_append_number(lp->ll_list, 0) == FAIL)
2797 ri = NULL;
2798 break;
2801 lp->ll_li = lp->ll_li->li_next;
2802 ++lp->ll_n1;
2804 if (ri != NULL)
2805 EMSG(_("E710: List value has more items than target"));
2806 else if (lp->ll_empty2
2807 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2808 : lp->ll_n1 != lp->ll_n2)
2809 EMSG(_("E711: List value has not enough items"));
2811 else
2814 * Assign to a List or Dictionary item.
2816 if (lp->ll_newkey != NULL)
2818 if (op != NULL && *op != '=')
2820 EMSG2(_(e_letwrong), op);
2821 return;
2824 /* Need to add an item to the Dictionary. */
2825 di = dictitem_alloc(lp->ll_newkey);
2826 if (di == NULL)
2827 return;
2828 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2830 vim_free(di);
2831 return;
2833 lp->ll_tv = &di->di_tv;
2835 else if (op != NULL && *op != '=')
2837 tv_op(lp->ll_tv, rettv, op);
2838 return;
2840 else
2841 clear_tv(lp->ll_tv);
2844 * Assign the value to the variable or list item.
2846 if (copy)
2847 copy_tv(rettv, lp->ll_tv);
2848 else
2850 *lp->ll_tv = *rettv;
2851 lp->ll_tv->v_lock = 0;
2852 init_tv(rettv);
2858 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2859 * Returns OK or FAIL.
2861 static int
2862 tv_op(tv1, tv2, op)
2863 typval_T *tv1;
2864 typval_T *tv2;
2865 char_u *op;
2867 long n;
2868 char_u numbuf[NUMBUFLEN];
2869 char_u *s;
2871 /* Can't do anything with a Funcref or a Dict on the right. */
2872 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2874 switch (tv1->v_type)
2876 case VAR_DICT:
2877 case VAR_FUNC:
2878 break;
2880 case VAR_LIST:
2881 if (*op != '+' || tv2->v_type != VAR_LIST)
2882 break;
2883 /* List += List */
2884 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2885 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2886 return OK;
2888 case VAR_NUMBER:
2889 case VAR_STRING:
2890 if (tv2->v_type == VAR_LIST)
2891 break;
2892 if (*op == '+' || *op == '-')
2894 /* nr += nr or nr -= nr*/
2895 n = get_tv_number(tv1);
2896 #ifdef FEAT_FLOAT
2897 if (tv2->v_type == VAR_FLOAT)
2899 float_T f = n;
2901 if (*op == '+')
2902 f += tv2->vval.v_float;
2903 else
2904 f -= tv2->vval.v_float;
2905 clear_tv(tv1);
2906 tv1->v_type = VAR_FLOAT;
2907 tv1->vval.v_float = f;
2909 else
2910 #endif
2912 if (*op == '+')
2913 n += get_tv_number(tv2);
2914 else
2915 n -= get_tv_number(tv2);
2916 clear_tv(tv1);
2917 tv1->v_type = VAR_NUMBER;
2918 tv1->vval.v_number = n;
2921 else
2923 if (tv2->v_type == VAR_FLOAT)
2924 break;
2926 /* str .= str */
2927 s = get_tv_string(tv1);
2928 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2929 clear_tv(tv1);
2930 tv1->v_type = VAR_STRING;
2931 tv1->vval.v_string = s;
2933 return OK;
2935 #ifdef FEAT_FLOAT
2936 case VAR_FLOAT:
2938 float_T f;
2940 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2941 && tv2->v_type != VAR_NUMBER
2942 && tv2->v_type != VAR_STRING))
2943 break;
2944 if (tv2->v_type == VAR_FLOAT)
2945 f = tv2->vval.v_float;
2946 else
2947 f = get_tv_number(tv2);
2948 if (*op == '+')
2949 tv1->vval.v_float += f;
2950 else
2951 tv1->vval.v_float -= f;
2953 return OK;
2954 #endif
2958 EMSG2(_(e_letwrong), op);
2959 return FAIL;
2963 * Add a watcher to a list.
2965 static void
2966 list_add_watch(l, lw)
2967 list_T *l;
2968 listwatch_T *lw;
2970 lw->lw_next = l->lv_watch;
2971 l->lv_watch = lw;
2975 * Remove a watcher from a list.
2976 * No warning when it isn't found...
2978 static void
2979 list_rem_watch(l, lwrem)
2980 list_T *l;
2981 listwatch_T *lwrem;
2983 listwatch_T *lw, **lwp;
2985 lwp = &l->lv_watch;
2986 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
2988 if (lw == lwrem)
2990 *lwp = lw->lw_next;
2991 break;
2993 lwp = &lw->lw_next;
2998 * Just before removing an item from a list: advance watchers to the next
2999 * item.
3001 static void
3002 list_fix_watch(l, item)
3003 list_T *l;
3004 listitem_T *item;
3006 listwatch_T *lw;
3008 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3009 if (lw->lw_item == item)
3010 lw->lw_item = item->li_next;
3014 * Evaluate the expression used in a ":for var in expr" command.
3015 * "arg" points to "var".
3016 * Set "*errp" to TRUE for an error, FALSE otherwise;
3017 * Return a pointer that holds the info. Null when there is an error.
3019 void *
3020 eval_for_line(arg, errp, nextcmdp, skip)
3021 char_u *arg;
3022 int *errp;
3023 char_u **nextcmdp;
3024 int skip;
3026 forinfo_T *fi;
3027 char_u *expr;
3028 typval_T tv;
3029 list_T *l;
3031 *errp = TRUE; /* default: there is an error */
3033 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3034 if (fi == NULL)
3035 return NULL;
3037 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3038 if (expr == NULL)
3039 return fi;
3041 expr = skipwhite(expr);
3042 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3044 EMSG(_("E690: Missing \"in\" after :for"));
3045 return fi;
3048 if (skip)
3049 ++emsg_skip;
3050 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3052 *errp = FALSE;
3053 if (!skip)
3055 l = tv.vval.v_list;
3056 if (tv.v_type != VAR_LIST || l == NULL)
3058 EMSG(_(e_listreq));
3059 clear_tv(&tv);
3061 else
3063 /* No need to increment the refcount, it's already set for the
3064 * list being used in "tv". */
3065 fi->fi_list = l;
3066 list_add_watch(l, &fi->fi_lw);
3067 fi->fi_lw.lw_item = l->lv_first;
3071 if (skip)
3072 --emsg_skip;
3074 return fi;
3078 * Use the first item in a ":for" list. Advance to the next.
3079 * Assign the values to the variable (list). "arg" points to the first one.
3080 * Return TRUE when a valid item was found, FALSE when at end of list or
3081 * something wrong.
3084 next_for_item(fi_void, arg)
3085 void *fi_void;
3086 char_u *arg;
3088 forinfo_T *fi = (forinfo_T *)fi_void;
3089 int result;
3090 listitem_T *item;
3092 item = fi->fi_lw.lw_item;
3093 if (item == NULL)
3094 result = FALSE;
3095 else
3097 fi->fi_lw.lw_item = item->li_next;
3098 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3099 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3101 return result;
3105 * Free the structure used to store info used by ":for".
3107 void
3108 free_for_info(fi_void)
3109 void *fi_void;
3111 forinfo_T *fi = (forinfo_T *)fi_void;
3113 if (fi != NULL && fi->fi_list != NULL)
3115 list_rem_watch(fi->fi_list, &fi->fi_lw);
3116 list_unref(fi->fi_list);
3118 vim_free(fi);
3121 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3123 void
3124 set_context_for_expression(xp, arg, cmdidx)
3125 expand_T *xp;
3126 char_u *arg;
3127 cmdidx_T cmdidx;
3129 int got_eq = FALSE;
3130 int c;
3131 char_u *p;
3133 if (cmdidx == CMD_let)
3135 xp->xp_context = EXPAND_USER_VARS;
3136 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3138 /* ":let var1 var2 ...": find last space. */
3139 for (p = arg + STRLEN(arg); p >= arg; )
3141 xp->xp_pattern = p;
3142 mb_ptr_back(arg, p);
3143 if (vim_iswhite(*p))
3144 break;
3146 return;
3149 else
3150 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3151 : EXPAND_EXPRESSION;
3152 while ((xp->xp_pattern = vim_strpbrk(arg,
3153 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3155 c = *xp->xp_pattern;
3156 if (c == '&')
3158 c = xp->xp_pattern[1];
3159 if (c == '&')
3161 ++xp->xp_pattern;
3162 xp->xp_context = cmdidx != CMD_let || got_eq
3163 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3165 else if (c != ' ')
3167 xp->xp_context = EXPAND_SETTINGS;
3168 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3169 xp->xp_pattern += 2;
3173 else if (c == '$')
3175 /* environment variable */
3176 xp->xp_context = EXPAND_ENV_VARS;
3178 else if (c == '=')
3180 got_eq = TRUE;
3181 xp->xp_context = EXPAND_EXPRESSION;
3183 else if (c == '<'
3184 && xp->xp_context == EXPAND_FUNCTIONS
3185 && vim_strchr(xp->xp_pattern, '(') == NULL)
3187 /* Function name can start with "<SNR>" */
3188 break;
3190 else if (cmdidx != CMD_let || got_eq)
3192 if (c == '"') /* string */
3194 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3195 if (c == '\\' && xp->xp_pattern[1] != NUL)
3196 ++xp->xp_pattern;
3197 xp->xp_context = EXPAND_NOTHING;
3199 else if (c == '\'') /* literal string */
3201 /* Trick: '' is like stopping and starting a literal string. */
3202 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3203 /* skip */ ;
3204 xp->xp_context = EXPAND_NOTHING;
3206 else if (c == '|')
3208 if (xp->xp_pattern[1] == '|')
3210 ++xp->xp_pattern;
3211 xp->xp_context = EXPAND_EXPRESSION;
3213 else
3214 xp->xp_context = EXPAND_COMMANDS;
3216 else
3217 xp->xp_context = EXPAND_EXPRESSION;
3219 else
3220 /* Doesn't look like something valid, expand as an expression
3221 * anyway. */
3222 xp->xp_context = EXPAND_EXPRESSION;
3223 arg = xp->xp_pattern;
3224 if (*arg != NUL)
3225 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3226 /* skip */ ;
3228 xp->xp_pattern = arg;
3231 #endif /* FEAT_CMDL_COMPL */
3234 * ":1,25call func(arg1, arg2)" function call.
3236 void
3237 ex_call(eap)
3238 exarg_T *eap;
3240 char_u *arg = eap->arg;
3241 char_u *startarg;
3242 char_u *name;
3243 char_u *tofree;
3244 int len;
3245 typval_T rettv;
3246 linenr_T lnum;
3247 int doesrange;
3248 int failed = FALSE;
3249 funcdict_T fudi;
3251 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3252 if (fudi.fd_newkey != NULL)
3254 /* Still need to give an error message for missing key. */
3255 EMSG2(_(e_dictkey), fudi.fd_newkey);
3256 vim_free(fudi.fd_newkey);
3258 if (tofree == NULL)
3259 return;
3261 /* Increase refcount on dictionary, it could get deleted when evaluating
3262 * the arguments. */
3263 if (fudi.fd_dict != NULL)
3264 ++fudi.fd_dict->dv_refcount;
3266 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3267 len = (int)STRLEN(tofree);
3268 name = deref_func_name(tofree, &len);
3270 /* Skip white space to allow ":call func ()". Not good, but required for
3271 * backward compatibility. */
3272 startarg = skipwhite(arg);
3273 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3275 if (*startarg != '(')
3277 EMSG2(_("E107: Missing braces: %s"), eap->arg);
3278 goto end;
3282 * When skipping, evaluate the function once, to find the end of the
3283 * arguments.
3284 * When the function takes a range, this is discovered after the first
3285 * call, and the loop is broken.
3287 if (eap->skip)
3289 ++emsg_skip;
3290 lnum = eap->line2; /* do it once, also with an invalid range */
3292 else
3293 lnum = eap->line1;
3294 for ( ; lnum <= eap->line2; ++lnum)
3296 if (!eap->skip && eap->addr_count > 0)
3298 curwin->w_cursor.lnum = lnum;
3299 curwin->w_cursor.col = 0;
3301 arg = startarg;
3302 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3303 eap->line1, eap->line2, &doesrange,
3304 !eap->skip, fudi.fd_dict) == FAIL)
3306 failed = TRUE;
3307 break;
3310 /* Handle a function returning a Funcref, Dictionary or List. */
3311 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3313 failed = TRUE;
3314 break;
3317 clear_tv(&rettv);
3318 if (doesrange || eap->skip)
3319 break;
3321 /* Stop when immediately aborting on error, or when an interrupt
3322 * occurred or an exception was thrown but not caught.
3323 * get_func_tv() returned OK, so that the check for trailing
3324 * characters below is executed. */
3325 if (aborting())
3326 break;
3328 if (eap->skip)
3329 --emsg_skip;
3331 if (!failed)
3333 /* Check for trailing illegal characters and a following command. */
3334 if (!ends_excmd(*arg))
3336 emsg_severe = TRUE;
3337 EMSG(_(e_trailing));
3339 else
3340 eap->nextcmd = check_nextcmd(arg);
3343 end:
3344 dict_unref(fudi.fd_dict);
3345 vim_free(tofree);
3349 * ":unlet[!] var1 ... " command.
3351 void
3352 ex_unlet(eap)
3353 exarg_T *eap;
3355 ex_unletlock(eap, eap->arg, 0);
3359 * ":lockvar" and ":unlockvar" commands
3361 void
3362 ex_lockvar(eap)
3363 exarg_T *eap;
3365 char_u *arg = eap->arg;
3366 int deep = 2;
3368 if (eap->forceit)
3369 deep = -1;
3370 else if (vim_isdigit(*arg))
3372 deep = getdigits(&arg);
3373 arg = skipwhite(arg);
3376 ex_unletlock(eap, arg, deep);
3380 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3382 static void
3383 ex_unletlock(eap, argstart, deep)
3384 exarg_T *eap;
3385 char_u *argstart;
3386 int deep;
3388 char_u *arg = argstart;
3389 char_u *name_end;
3390 int error = FALSE;
3391 lval_T lv;
3395 /* Parse the name and find the end. */
3396 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3397 FNE_CHECK_START);
3398 if (lv.ll_name == NULL)
3399 error = TRUE; /* error but continue parsing */
3400 if (name_end == NULL || (!vim_iswhite(*name_end)
3401 && !ends_excmd(*name_end)))
3403 if (name_end != NULL)
3405 emsg_severe = TRUE;
3406 EMSG(_(e_trailing));
3408 if (!(eap->skip || error))
3409 clear_lval(&lv);
3410 break;
3413 if (!error && !eap->skip)
3415 if (eap->cmdidx == CMD_unlet)
3417 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3418 error = TRUE;
3420 else
3422 if (do_lock_var(&lv, name_end, deep,
3423 eap->cmdidx == CMD_lockvar) == FAIL)
3424 error = TRUE;
3428 if (!eap->skip)
3429 clear_lval(&lv);
3431 arg = skipwhite(name_end);
3432 } while (!ends_excmd(*arg));
3434 eap->nextcmd = check_nextcmd(arg);
3437 static int
3438 do_unlet_var(lp, name_end, forceit)
3439 lval_T *lp;
3440 char_u *name_end;
3441 int forceit;
3443 int ret = OK;
3444 int cc;
3446 if (lp->ll_tv == NULL)
3448 cc = *name_end;
3449 *name_end = NUL;
3451 /* Normal name or expanded name. */
3452 if (check_changedtick(lp->ll_name))
3453 ret = FAIL;
3454 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3455 ret = FAIL;
3456 *name_end = cc;
3458 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3459 return FAIL;
3460 else if (lp->ll_range)
3462 listitem_T *li;
3464 /* Delete a range of List items. */
3465 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3467 li = lp->ll_li->li_next;
3468 listitem_remove(lp->ll_list, lp->ll_li);
3469 lp->ll_li = li;
3470 ++lp->ll_n1;
3473 else
3475 if (lp->ll_list != NULL)
3476 /* unlet a List item. */
3477 listitem_remove(lp->ll_list, lp->ll_li);
3478 else
3479 /* unlet a Dictionary item. */
3480 dictitem_remove(lp->ll_dict, lp->ll_di);
3483 return ret;
3487 * "unlet" a variable. Return OK if it existed, FAIL if not.
3488 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3491 do_unlet(name, forceit)
3492 char_u *name;
3493 int forceit;
3495 hashtab_T *ht;
3496 hashitem_T *hi;
3497 char_u *varname;
3498 dictitem_T *di;
3500 ht = find_var_ht(name, &varname);
3501 if (ht != NULL && *varname != NUL)
3503 hi = hash_find(ht, varname);
3504 if (!HASHITEM_EMPTY(hi))
3506 di = HI2DI(hi);
3507 if (var_check_fixed(di->di_flags, name)
3508 || var_check_ro(di->di_flags, name))
3509 return FAIL;
3510 delete_var(ht, hi);
3511 return OK;
3514 if (forceit)
3515 return OK;
3516 EMSG2(_("E108: No such variable: \"%s\""), name);
3517 return FAIL;
3521 * Lock or unlock variable indicated by "lp".
3522 * "deep" is the levels to go (-1 for unlimited);
3523 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3525 static int
3526 do_lock_var(lp, name_end, deep, lock)
3527 lval_T *lp;
3528 char_u *name_end;
3529 int deep;
3530 int lock;
3532 int ret = OK;
3533 int cc;
3534 dictitem_T *di;
3536 if (deep == 0) /* nothing to do */
3537 return OK;
3539 if (lp->ll_tv == NULL)
3541 cc = *name_end;
3542 *name_end = NUL;
3544 /* Normal name or expanded name. */
3545 if (check_changedtick(lp->ll_name))
3546 ret = FAIL;
3547 else
3549 di = find_var(lp->ll_name, NULL);
3550 if (di == NULL)
3551 ret = FAIL;
3552 else
3554 if (lock)
3555 di->di_flags |= DI_FLAGS_LOCK;
3556 else
3557 di->di_flags &= ~DI_FLAGS_LOCK;
3558 item_lock(&di->di_tv, deep, lock);
3561 *name_end = cc;
3563 else if (lp->ll_range)
3565 listitem_T *li = lp->ll_li;
3567 /* (un)lock a range of List items. */
3568 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3570 item_lock(&li->li_tv, deep, lock);
3571 li = li->li_next;
3572 ++lp->ll_n1;
3575 else if (lp->ll_list != NULL)
3576 /* (un)lock a List item. */
3577 item_lock(&lp->ll_li->li_tv, deep, lock);
3578 else
3579 /* un(lock) a Dictionary item. */
3580 item_lock(&lp->ll_di->di_tv, deep, lock);
3582 return ret;
3586 * Lock or unlock an item. "deep" is nr of levels to go.
3588 static void
3589 item_lock(tv, deep, lock)
3590 typval_T *tv;
3591 int deep;
3592 int lock;
3594 static int recurse = 0;
3595 list_T *l;
3596 listitem_T *li;
3597 dict_T *d;
3598 hashitem_T *hi;
3599 int todo;
3601 if (recurse >= DICT_MAXNEST)
3603 EMSG(_("E743: variable nested too deep for (un)lock"));
3604 return;
3606 if (deep == 0)
3607 return;
3608 ++recurse;
3610 /* lock/unlock the item itself */
3611 if (lock)
3612 tv->v_lock |= VAR_LOCKED;
3613 else
3614 tv->v_lock &= ~VAR_LOCKED;
3616 switch (tv->v_type)
3618 case VAR_LIST:
3619 if ((l = tv->vval.v_list) != NULL)
3621 if (lock)
3622 l->lv_lock |= VAR_LOCKED;
3623 else
3624 l->lv_lock &= ~VAR_LOCKED;
3625 if (deep < 0 || deep > 1)
3626 /* recursive: lock/unlock the items the List contains */
3627 for (li = l->lv_first; li != NULL; li = li->li_next)
3628 item_lock(&li->li_tv, deep - 1, lock);
3630 break;
3631 case VAR_DICT:
3632 if ((d = tv->vval.v_dict) != NULL)
3634 if (lock)
3635 d->dv_lock |= VAR_LOCKED;
3636 else
3637 d->dv_lock &= ~VAR_LOCKED;
3638 if (deep < 0 || deep > 1)
3640 /* recursive: lock/unlock the items the List contains */
3641 todo = (int)d->dv_hashtab.ht_used;
3642 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3644 if (!HASHITEM_EMPTY(hi))
3646 --todo;
3647 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3653 --recurse;
3657 * Return TRUE if typeval "tv" is locked: Either tha value is locked itself or
3658 * it refers to a List or Dictionary that is locked.
3660 static int
3661 tv_islocked(tv)
3662 typval_T *tv;
3664 return (tv->v_lock & VAR_LOCKED)
3665 || (tv->v_type == VAR_LIST
3666 && tv->vval.v_list != NULL
3667 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3668 || (tv->v_type == VAR_DICT
3669 && tv->vval.v_dict != NULL
3670 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3673 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3675 * Delete all "menutrans_" variables.
3677 void
3678 del_menutrans_vars()
3680 hashitem_T *hi;
3681 int todo;
3683 hash_lock(&globvarht);
3684 todo = (int)globvarht.ht_used;
3685 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3687 if (!HASHITEM_EMPTY(hi))
3689 --todo;
3690 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3691 delete_var(&globvarht, hi);
3694 hash_unlock(&globvarht);
3696 #endif
3698 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3701 * Local string buffer for the next two functions to store a variable name
3702 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3703 * get_user_var_name().
3706 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3708 static char_u *varnamebuf = NULL;
3709 static int varnamebuflen = 0;
3712 * Function to concatenate a prefix and a variable name.
3714 static char_u *
3715 cat_prefix_varname(prefix, name)
3716 int prefix;
3717 char_u *name;
3719 int len;
3721 len = (int)STRLEN(name) + 3;
3722 if (len > varnamebuflen)
3724 vim_free(varnamebuf);
3725 len += 10; /* some additional space */
3726 varnamebuf = alloc(len);
3727 if (varnamebuf == NULL)
3729 varnamebuflen = 0;
3730 return NULL;
3732 varnamebuflen = len;
3734 *varnamebuf = prefix;
3735 varnamebuf[1] = ':';
3736 STRCPY(varnamebuf + 2, name);
3737 return varnamebuf;
3741 * Function given to ExpandGeneric() to obtain the list of user defined
3742 * (global/buffer/window/built-in) variable names.
3744 /*ARGSUSED*/
3745 char_u *
3746 get_user_var_name(xp, idx)
3747 expand_T *xp;
3748 int idx;
3750 static long_u gdone;
3751 static long_u bdone;
3752 static long_u wdone;
3753 #ifdef FEAT_WINDOWS
3754 static long_u tdone;
3755 #endif
3756 static int vidx;
3757 static hashitem_T *hi;
3758 hashtab_T *ht;
3760 if (idx == 0)
3762 gdone = bdone = wdone = vidx = 0;
3763 #ifdef FEAT_WINDOWS
3764 tdone = 0;
3765 #endif
3768 /* Global variables */
3769 if (gdone < globvarht.ht_used)
3771 if (gdone++ == 0)
3772 hi = globvarht.ht_array;
3773 else
3774 ++hi;
3775 while (HASHITEM_EMPTY(hi))
3776 ++hi;
3777 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3778 return cat_prefix_varname('g', hi->hi_key);
3779 return hi->hi_key;
3782 /* b: variables */
3783 ht = &curbuf->b_vars.dv_hashtab;
3784 if (bdone < ht->ht_used)
3786 if (bdone++ == 0)
3787 hi = ht->ht_array;
3788 else
3789 ++hi;
3790 while (HASHITEM_EMPTY(hi))
3791 ++hi;
3792 return cat_prefix_varname('b', hi->hi_key);
3794 if (bdone == ht->ht_used)
3796 ++bdone;
3797 return (char_u *)"b:changedtick";
3800 /* w: variables */
3801 ht = &curwin->w_vars.dv_hashtab;
3802 if (wdone < ht->ht_used)
3804 if (wdone++ == 0)
3805 hi = ht->ht_array;
3806 else
3807 ++hi;
3808 while (HASHITEM_EMPTY(hi))
3809 ++hi;
3810 return cat_prefix_varname('w', hi->hi_key);
3813 #ifdef FEAT_WINDOWS
3814 /* t: variables */
3815 ht = &curtab->tp_vars.dv_hashtab;
3816 if (tdone < ht->ht_used)
3818 if (tdone++ == 0)
3819 hi = ht->ht_array;
3820 else
3821 ++hi;
3822 while (HASHITEM_EMPTY(hi))
3823 ++hi;
3824 return cat_prefix_varname('t', hi->hi_key);
3826 #endif
3828 /* v: variables */
3829 if (vidx < VV_LEN)
3830 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3832 vim_free(varnamebuf);
3833 varnamebuf = NULL;
3834 varnamebuflen = 0;
3835 return NULL;
3838 #endif /* FEAT_CMDL_COMPL */
3841 * types for expressions.
3843 typedef enum
3845 TYPE_UNKNOWN = 0
3846 , TYPE_EQUAL /* == */
3847 , TYPE_NEQUAL /* != */
3848 , TYPE_GREATER /* > */
3849 , TYPE_GEQUAL /* >= */
3850 , TYPE_SMALLER /* < */
3851 , TYPE_SEQUAL /* <= */
3852 , TYPE_MATCH /* =~ */
3853 , TYPE_NOMATCH /* !~ */
3854 } exptype_T;
3857 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3858 * executed. The function may return OK, but the rettv will be of type
3859 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3863 * Handle zero level expression.
3864 * This calls eval1() and handles error message and nextcmd.
3865 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3866 * Note: "rettv.v_lock" is not set.
3867 * Return OK or FAIL.
3869 static int
3870 eval0(arg, rettv, nextcmd, evaluate)
3871 char_u *arg;
3872 typval_T *rettv;
3873 char_u **nextcmd;
3874 int evaluate;
3876 int ret;
3877 char_u *p;
3879 p = skipwhite(arg);
3880 ret = eval1(&p, rettv, evaluate);
3881 if (ret == FAIL || !ends_excmd(*p))
3883 if (ret != FAIL)
3884 clear_tv(rettv);
3886 * Report the invalid expression unless the expression evaluation has
3887 * been cancelled due to an aborting error, an interrupt, or an
3888 * exception.
3890 if (!aborting())
3891 EMSG2(_(e_invexpr2), arg);
3892 ret = FAIL;
3894 if (nextcmd != NULL)
3895 *nextcmd = check_nextcmd(p);
3897 return ret;
3901 * Handle top level expression:
3902 * expr1 ? expr0 : expr0
3904 * "arg" must point to the first non-white of the expression.
3905 * "arg" is advanced to the next non-white after the recognized expression.
3907 * Note: "rettv.v_lock" is not set.
3909 * Return OK or FAIL.
3911 static int
3912 eval1(arg, rettv, evaluate)
3913 char_u **arg;
3914 typval_T *rettv;
3915 int evaluate;
3917 int result;
3918 typval_T var2;
3921 * Get the first variable.
3923 if (eval2(arg, rettv, evaluate) == FAIL)
3924 return FAIL;
3926 if ((*arg)[0] == '?')
3928 result = FALSE;
3929 if (evaluate)
3931 int error = FALSE;
3933 if (get_tv_number_chk(rettv, &error) != 0)
3934 result = TRUE;
3935 clear_tv(rettv);
3936 if (error)
3937 return FAIL;
3941 * Get the second variable.
3943 *arg = skipwhite(*arg + 1);
3944 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3945 return FAIL;
3948 * Check for the ":".
3950 if ((*arg)[0] != ':')
3952 EMSG(_("E109: Missing ':' after '?'"));
3953 if (evaluate && result)
3954 clear_tv(rettv);
3955 return FAIL;
3959 * Get the third variable.
3961 *arg = skipwhite(*arg + 1);
3962 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
3964 if (evaluate && result)
3965 clear_tv(rettv);
3966 return FAIL;
3968 if (evaluate && !result)
3969 *rettv = var2;
3972 return OK;
3976 * Handle first level expression:
3977 * expr2 || expr2 || expr2 logical OR
3979 * "arg" must point to the first non-white of the expression.
3980 * "arg" is advanced to the next non-white after the recognized expression.
3982 * Return OK or FAIL.
3984 static int
3985 eval2(arg, rettv, evaluate)
3986 char_u **arg;
3987 typval_T *rettv;
3988 int evaluate;
3990 typval_T var2;
3991 long result;
3992 int first;
3993 int error = FALSE;
3996 * Get the first variable.
3998 if (eval3(arg, rettv, evaluate) == FAIL)
3999 return FAIL;
4002 * Repeat until there is no following "||".
4004 first = TRUE;
4005 result = FALSE;
4006 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4008 if (evaluate && first)
4010 if (get_tv_number_chk(rettv, &error) != 0)
4011 result = TRUE;
4012 clear_tv(rettv);
4013 if (error)
4014 return FAIL;
4015 first = FALSE;
4019 * Get the second variable.
4021 *arg = skipwhite(*arg + 2);
4022 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4023 return FAIL;
4026 * Compute the result.
4028 if (evaluate && !result)
4030 if (get_tv_number_chk(&var2, &error) != 0)
4031 result = TRUE;
4032 clear_tv(&var2);
4033 if (error)
4034 return FAIL;
4036 if (evaluate)
4038 rettv->v_type = VAR_NUMBER;
4039 rettv->vval.v_number = result;
4043 return OK;
4047 * Handle second level expression:
4048 * expr3 && expr3 && expr3 logical AND
4050 * "arg" must point to the first non-white of the expression.
4051 * "arg" is advanced to the next non-white after the recognized expression.
4053 * Return OK or FAIL.
4055 static int
4056 eval3(arg, rettv, evaluate)
4057 char_u **arg;
4058 typval_T *rettv;
4059 int evaluate;
4061 typval_T var2;
4062 long result;
4063 int first;
4064 int error = FALSE;
4067 * Get the first variable.
4069 if (eval4(arg, rettv, evaluate) == FAIL)
4070 return FAIL;
4073 * Repeat until there is no following "&&".
4075 first = TRUE;
4076 result = TRUE;
4077 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4079 if (evaluate && first)
4081 if (get_tv_number_chk(rettv, &error) == 0)
4082 result = FALSE;
4083 clear_tv(rettv);
4084 if (error)
4085 return FAIL;
4086 first = FALSE;
4090 * Get the second variable.
4092 *arg = skipwhite(*arg + 2);
4093 if (eval4(arg, &var2, evaluate && result) == FAIL)
4094 return FAIL;
4097 * Compute the result.
4099 if (evaluate && result)
4101 if (get_tv_number_chk(&var2, &error) == 0)
4102 result = FALSE;
4103 clear_tv(&var2);
4104 if (error)
4105 return FAIL;
4107 if (evaluate)
4109 rettv->v_type = VAR_NUMBER;
4110 rettv->vval.v_number = result;
4114 return OK;
4118 * Handle third level expression:
4119 * var1 == var2
4120 * var1 =~ var2
4121 * var1 != var2
4122 * var1 !~ var2
4123 * var1 > var2
4124 * var1 >= var2
4125 * var1 < var2
4126 * var1 <= var2
4127 * var1 is var2
4128 * var1 isnot var2
4130 * "arg" must point to the first non-white of the expression.
4131 * "arg" is advanced to the next non-white after the recognized expression.
4133 * Return OK or FAIL.
4135 static int
4136 eval4(arg, rettv, evaluate)
4137 char_u **arg;
4138 typval_T *rettv;
4139 int evaluate;
4141 typval_T var2;
4142 char_u *p;
4143 int i;
4144 exptype_T type = TYPE_UNKNOWN;
4145 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4146 int len = 2;
4147 long n1, n2;
4148 char_u *s1, *s2;
4149 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4150 regmatch_T regmatch;
4151 int ic;
4152 char_u *save_cpo;
4155 * Get the first variable.
4157 if (eval5(arg, rettv, evaluate) == FAIL)
4158 return FAIL;
4160 p = *arg;
4161 switch (p[0])
4163 case '=': if (p[1] == '=')
4164 type = TYPE_EQUAL;
4165 else if (p[1] == '~')
4166 type = TYPE_MATCH;
4167 break;
4168 case '!': if (p[1] == '=')
4169 type = TYPE_NEQUAL;
4170 else if (p[1] == '~')
4171 type = TYPE_NOMATCH;
4172 break;
4173 case '>': if (p[1] != '=')
4175 type = TYPE_GREATER;
4176 len = 1;
4178 else
4179 type = TYPE_GEQUAL;
4180 break;
4181 case '<': if (p[1] != '=')
4183 type = TYPE_SMALLER;
4184 len = 1;
4186 else
4187 type = TYPE_SEQUAL;
4188 break;
4189 case 'i': if (p[1] == 's')
4191 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4192 len = 5;
4193 if (!vim_isIDc(p[len]))
4195 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4196 type_is = TRUE;
4199 break;
4203 * If there is a comparative operator, use it.
4205 if (type != TYPE_UNKNOWN)
4207 /* extra question mark appended: ignore case */
4208 if (p[len] == '?')
4210 ic = TRUE;
4211 ++len;
4213 /* extra '#' appended: match case */
4214 else if (p[len] == '#')
4216 ic = FALSE;
4217 ++len;
4219 /* nothing appended: use 'ignorecase' */
4220 else
4221 ic = p_ic;
4224 * Get the second variable.
4226 *arg = skipwhite(p + len);
4227 if (eval5(arg, &var2, evaluate) == FAIL)
4229 clear_tv(rettv);
4230 return FAIL;
4233 if (evaluate)
4235 if (type_is && rettv->v_type != var2.v_type)
4237 /* For "is" a different type always means FALSE, for "notis"
4238 * it means TRUE. */
4239 n1 = (type == TYPE_NEQUAL);
4241 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4243 if (type_is)
4245 n1 = (rettv->v_type == var2.v_type
4246 && rettv->vval.v_list == var2.vval.v_list);
4247 if (type == TYPE_NEQUAL)
4248 n1 = !n1;
4250 else if (rettv->v_type != var2.v_type
4251 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4253 if (rettv->v_type != var2.v_type)
4254 EMSG(_("E691: Can only compare List with List"));
4255 else
4256 EMSG(_("E692: Invalid operation for Lists"));
4257 clear_tv(rettv);
4258 clear_tv(&var2);
4259 return FAIL;
4261 else
4263 /* Compare two Lists for being equal or unequal. */
4264 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4265 if (type == TYPE_NEQUAL)
4266 n1 = !n1;
4270 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4272 if (type_is)
4274 n1 = (rettv->v_type == var2.v_type
4275 && rettv->vval.v_dict == var2.vval.v_dict);
4276 if (type == TYPE_NEQUAL)
4277 n1 = !n1;
4279 else if (rettv->v_type != var2.v_type
4280 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4282 if (rettv->v_type != var2.v_type)
4283 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4284 else
4285 EMSG(_("E736: Invalid operation for Dictionary"));
4286 clear_tv(rettv);
4287 clear_tv(&var2);
4288 return FAIL;
4290 else
4292 /* Compare two Dictionaries for being equal or unequal. */
4293 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4294 if (type == TYPE_NEQUAL)
4295 n1 = !n1;
4299 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4301 if (rettv->v_type != var2.v_type
4302 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4304 if (rettv->v_type != var2.v_type)
4305 EMSG(_("E693: Can only compare Funcref with Funcref"));
4306 else
4307 EMSG(_("E694: Invalid operation for Funcrefs"));
4308 clear_tv(rettv);
4309 clear_tv(&var2);
4310 return FAIL;
4312 else
4314 /* Compare two Funcrefs for being equal or unequal. */
4315 if (rettv->vval.v_string == NULL
4316 || var2.vval.v_string == NULL)
4317 n1 = FALSE;
4318 else
4319 n1 = STRCMP(rettv->vval.v_string,
4320 var2.vval.v_string) == 0;
4321 if (type == TYPE_NEQUAL)
4322 n1 = !n1;
4326 #ifdef FEAT_FLOAT
4328 * If one of the two variables is a float, compare as a float.
4329 * When using "=~" or "!~", always compare as string.
4331 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4332 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4334 float_T f1, f2;
4336 if (rettv->v_type == VAR_FLOAT)
4337 f1 = rettv->vval.v_float;
4338 else
4339 f1 = get_tv_number(rettv);
4340 if (var2.v_type == VAR_FLOAT)
4341 f2 = var2.vval.v_float;
4342 else
4343 f2 = get_tv_number(&var2);
4344 n1 = FALSE;
4345 switch (type)
4347 case TYPE_EQUAL: n1 = (f1 == f2); break;
4348 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4349 case TYPE_GREATER: n1 = (f1 > f2); break;
4350 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4351 case TYPE_SMALLER: n1 = (f1 < f2); break;
4352 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4353 case TYPE_UNKNOWN:
4354 case TYPE_MATCH:
4355 case TYPE_NOMATCH: break; /* avoid gcc warning */
4358 #endif
4361 * If one of the two variables is a number, compare as a number.
4362 * When using "=~" or "!~", always compare as string.
4364 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4365 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4367 n1 = get_tv_number(rettv);
4368 n2 = get_tv_number(&var2);
4369 switch (type)
4371 case TYPE_EQUAL: n1 = (n1 == n2); break;
4372 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4373 case TYPE_GREATER: n1 = (n1 > n2); break;
4374 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4375 case TYPE_SMALLER: n1 = (n1 < n2); break;
4376 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4377 case TYPE_UNKNOWN:
4378 case TYPE_MATCH:
4379 case TYPE_NOMATCH: break; /* avoid gcc warning */
4382 else
4384 s1 = get_tv_string_buf(rettv, buf1);
4385 s2 = get_tv_string_buf(&var2, buf2);
4386 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4387 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4388 else
4389 i = 0;
4390 n1 = FALSE;
4391 switch (type)
4393 case TYPE_EQUAL: n1 = (i == 0); break;
4394 case TYPE_NEQUAL: n1 = (i != 0); break;
4395 case TYPE_GREATER: n1 = (i > 0); break;
4396 case TYPE_GEQUAL: n1 = (i >= 0); break;
4397 case TYPE_SMALLER: n1 = (i < 0); break;
4398 case TYPE_SEQUAL: n1 = (i <= 0); break;
4400 case TYPE_MATCH:
4401 case TYPE_NOMATCH:
4402 /* avoid 'l' flag in 'cpoptions' */
4403 save_cpo = p_cpo;
4404 p_cpo = (char_u *)"";
4405 regmatch.regprog = vim_regcomp(s2,
4406 RE_MAGIC + RE_STRING);
4407 regmatch.rm_ic = ic;
4408 if (regmatch.regprog != NULL)
4410 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4411 vim_free(regmatch.regprog);
4412 if (type == TYPE_NOMATCH)
4413 n1 = !n1;
4415 p_cpo = save_cpo;
4416 break;
4418 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4421 clear_tv(rettv);
4422 clear_tv(&var2);
4423 rettv->v_type = VAR_NUMBER;
4424 rettv->vval.v_number = n1;
4428 return OK;
4432 * Handle fourth level expression:
4433 * + number addition
4434 * - number subtraction
4435 * . string concatenation
4437 * "arg" must point to the first non-white of the expression.
4438 * "arg" is advanced to the next non-white after the recognized expression.
4440 * Return OK or FAIL.
4442 static int
4443 eval5(arg, rettv, evaluate)
4444 char_u **arg;
4445 typval_T *rettv;
4446 int evaluate;
4448 typval_T var2;
4449 typval_T var3;
4450 int op;
4451 long n1, n2;
4452 #ifdef FEAT_FLOAT
4453 float_T f1 = 0, f2 = 0;
4454 #endif
4455 char_u *s1, *s2;
4456 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4457 char_u *p;
4460 * Get the first variable.
4462 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4463 return FAIL;
4466 * Repeat computing, until no '+', '-' or '.' is following.
4468 for (;;)
4470 op = **arg;
4471 if (op != '+' && op != '-' && op != '.')
4472 break;
4474 if ((op != '+' || rettv->v_type != VAR_LIST)
4475 #ifdef FEAT_FLOAT
4476 && (op == '.' || rettv->v_type != VAR_FLOAT)
4477 #endif
4480 /* For "list + ...", an illegal use of the first operand as
4481 * a number cannot be determined before evaluating the 2nd
4482 * operand: if this is also a list, all is ok.
4483 * For "something . ...", "something - ..." or "non-list + ...",
4484 * we know that the first operand needs to be a string or number
4485 * without evaluating the 2nd operand. So check before to avoid
4486 * side effects after an error. */
4487 if (evaluate && get_tv_string_chk(rettv) == NULL)
4489 clear_tv(rettv);
4490 return FAIL;
4495 * Get the second variable.
4497 *arg = skipwhite(*arg + 1);
4498 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4500 clear_tv(rettv);
4501 return FAIL;
4504 if (evaluate)
4507 * Compute the result.
4509 if (op == '.')
4511 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4512 s2 = get_tv_string_buf_chk(&var2, buf2);
4513 if (s2 == NULL) /* type error ? */
4515 clear_tv(rettv);
4516 clear_tv(&var2);
4517 return FAIL;
4519 p = concat_str(s1, s2);
4520 clear_tv(rettv);
4521 rettv->v_type = VAR_STRING;
4522 rettv->vval.v_string = p;
4524 else if (op == '+' && rettv->v_type == VAR_LIST
4525 && var2.v_type == VAR_LIST)
4527 /* concatenate Lists */
4528 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4529 &var3) == FAIL)
4531 clear_tv(rettv);
4532 clear_tv(&var2);
4533 return FAIL;
4535 clear_tv(rettv);
4536 *rettv = var3;
4538 else
4540 int error = FALSE;
4542 #ifdef FEAT_FLOAT
4543 if (rettv->v_type == VAR_FLOAT)
4545 f1 = rettv->vval.v_float;
4546 n1 = 0;
4548 else
4549 #endif
4551 n1 = get_tv_number_chk(rettv, &error);
4552 if (error)
4554 /* This can only happen for "list + non-list". For
4555 * "non-list + ..." or "something - ...", we returned
4556 * before evaluating the 2nd operand. */
4557 clear_tv(rettv);
4558 return FAIL;
4560 #ifdef FEAT_FLOAT
4561 if (var2.v_type == VAR_FLOAT)
4562 f1 = n1;
4563 #endif
4565 #ifdef FEAT_FLOAT
4566 if (var2.v_type == VAR_FLOAT)
4568 f2 = var2.vval.v_float;
4569 n2 = 0;
4571 else
4572 #endif
4574 n2 = get_tv_number_chk(&var2, &error);
4575 if (error)
4577 clear_tv(rettv);
4578 clear_tv(&var2);
4579 return FAIL;
4581 #ifdef FEAT_FLOAT
4582 if (rettv->v_type == VAR_FLOAT)
4583 f2 = n2;
4584 #endif
4586 clear_tv(rettv);
4588 #ifdef FEAT_FLOAT
4589 /* If there is a float on either side the result is a float. */
4590 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4592 if (op == '+')
4593 f1 = f1 + f2;
4594 else
4595 f1 = f1 - f2;
4596 rettv->v_type = VAR_FLOAT;
4597 rettv->vval.v_float = f1;
4599 else
4600 #endif
4602 if (op == '+')
4603 n1 = n1 + n2;
4604 else
4605 n1 = n1 - n2;
4606 rettv->v_type = VAR_NUMBER;
4607 rettv->vval.v_number = n1;
4610 clear_tv(&var2);
4613 return OK;
4617 * Handle fifth level expression:
4618 * * number multiplication
4619 * / number division
4620 * % number modulo
4622 * "arg" must point to the first non-white of the expression.
4623 * "arg" is advanced to the next non-white after the recognized expression.
4625 * Return OK or FAIL.
4627 static int
4628 eval6(arg, rettv, evaluate, want_string)
4629 char_u **arg;
4630 typval_T *rettv;
4631 int evaluate;
4632 int want_string; /* after "." operator */
4634 typval_T var2;
4635 int op;
4636 long n1, n2;
4637 #ifdef FEAT_FLOAT
4638 int use_float = FALSE;
4639 float_T f1 = 0, f2;
4640 #endif
4641 int error = FALSE;
4644 * Get the first variable.
4646 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4647 return FAIL;
4650 * Repeat computing, until no '*', '/' or '%' is following.
4652 for (;;)
4654 op = **arg;
4655 if (op != '*' && op != '/' && op != '%')
4656 break;
4658 if (evaluate)
4660 #ifdef FEAT_FLOAT
4661 if (rettv->v_type == VAR_FLOAT)
4663 f1 = rettv->vval.v_float;
4664 use_float = TRUE;
4665 n1 = 0;
4667 else
4668 #endif
4669 n1 = get_tv_number_chk(rettv, &error);
4670 clear_tv(rettv);
4671 if (error)
4672 return FAIL;
4674 else
4675 n1 = 0;
4678 * Get the second variable.
4680 *arg = skipwhite(*arg + 1);
4681 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4682 return FAIL;
4684 if (evaluate)
4686 #ifdef FEAT_FLOAT
4687 if (var2.v_type == VAR_FLOAT)
4689 if (!use_float)
4691 f1 = n1;
4692 use_float = TRUE;
4694 f2 = var2.vval.v_float;
4695 n2 = 0;
4697 else
4698 #endif
4700 n2 = get_tv_number_chk(&var2, &error);
4701 clear_tv(&var2);
4702 if (error)
4703 return FAIL;
4704 #ifdef FEAT_FLOAT
4705 if (use_float)
4706 f2 = n2;
4707 #endif
4711 * Compute the result.
4712 * When either side is a float the result is a float.
4714 #ifdef FEAT_FLOAT
4715 if (use_float)
4717 if (op == '*')
4718 f1 = f1 * f2;
4719 else if (op == '/')
4721 /* We rely on the floating point library to handle divide
4722 * by zero to result in "inf" and not a crash. */
4723 f1 = f1 / f2;
4725 else
4727 EMSG(_("E804: Cannot use '%' with Float"));
4728 return FAIL;
4730 rettv->v_type = VAR_FLOAT;
4731 rettv->vval.v_float = f1;
4733 else
4734 #endif
4736 if (op == '*')
4737 n1 = n1 * n2;
4738 else if (op == '/')
4740 if (n2 == 0) /* give an error message? */
4742 if (n1 == 0)
4743 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4744 else if (n1 < 0)
4745 n1 = -0x7fffffffL;
4746 else
4747 n1 = 0x7fffffffL;
4749 else
4750 n1 = n1 / n2;
4752 else
4754 if (n2 == 0) /* give an error message? */
4755 n1 = 0;
4756 else
4757 n1 = n1 % n2;
4759 rettv->v_type = VAR_NUMBER;
4760 rettv->vval.v_number = n1;
4765 return OK;
4769 * Handle sixth level expression:
4770 * number number constant
4771 * "string" string constant
4772 * 'string' literal string constant
4773 * &option-name option value
4774 * @r register contents
4775 * identifier variable value
4776 * function() function call
4777 * $VAR environment variable
4778 * (expression) nested expression
4779 * [expr, expr] List
4780 * {key: val, key: val} Dictionary
4782 * Also handle:
4783 * ! in front logical NOT
4784 * - in front unary minus
4785 * + in front unary plus (ignored)
4786 * trailing [] subscript in String or List
4787 * trailing .name entry in Dictionary
4789 * "arg" must point to the first non-white of the expression.
4790 * "arg" is advanced to the next non-white after the recognized expression.
4792 * Return OK or FAIL.
4794 static int
4795 eval7(arg, rettv, evaluate, want_string)
4796 char_u **arg;
4797 typval_T *rettv;
4798 int evaluate;
4799 int want_string; /* after "." operator */
4801 long n;
4802 int len;
4803 char_u *s;
4804 char_u *start_leader, *end_leader;
4805 int ret = OK;
4806 char_u *alias;
4809 * Initialise variable so that clear_tv() can't mistake this for a
4810 * string and free a string that isn't there.
4812 rettv->v_type = VAR_UNKNOWN;
4815 * Skip '!' and '-' characters. They are handled later.
4817 start_leader = *arg;
4818 while (**arg == '!' || **arg == '-' || **arg == '+')
4819 *arg = skipwhite(*arg + 1);
4820 end_leader = *arg;
4822 switch (**arg)
4825 * Number constant.
4827 case '0':
4828 case '1':
4829 case '2':
4830 case '3':
4831 case '4':
4832 case '5':
4833 case '6':
4834 case '7':
4835 case '8':
4836 case '9':
4838 #ifdef FEAT_FLOAT
4839 char_u *p = skipdigits(*arg + 1);
4840 int get_float = FALSE;
4842 /* We accept a float when the format matches
4843 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4844 * strict to avoid backwards compatibility problems.
4845 * Don't look for a float after the "." operator, so that
4846 * ":let vers = 1.2.3" doesn't fail. */
4847 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4849 get_float = TRUE;
4850 p = skipdigits(p + 2);
4851 if (*p == 'e' || *p == 'E')
4853 ++p;
4854 if (*p == '-' || *p == '+')
4855 ++p;
4856 if (!vim_isdigit(*p))
4857 get_float = FALSE;
4858 else
4859 p = skipdigits(p + 1);
4861 if (ASCII_ISALPHA(*p) || *p == '.')
4862 get_float = FALSE;
4864 if (get_float)
4866 float_T f;
4868 *arg += string2float(*arg, &f);
4869 if (evaluate)
4871 rettv->v_type = VAR_FLOAT;
4872 rettv->vval.v_float = f;
4875 else
4876 #endif
4878 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4879 *arg += len;
4880 if (evaluate)
4882 rettv->v_type = VAR_NUMBER;
4883 rettv->vval.v_number = n;
4886 break;
4890 * String constant: "string".
4892 case '"': ret = get_string_tv(arg, rettv, evaluate);
4893 break;
4896 * Literal string constant: 'str''ing'.
4898 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4899 break;
4902 * List: [expr, expr]
4904 case '[': ret = get_list_tv(arg, rettv, evaluate);
4905 break;
4908 * Dictionary: {key: val, key: val}
4910 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4911 break;
4914 * Option value: &name
4916 case '&': ret = get_option_tv(arg, rettv, evaluate);
4917 break;
4920 * Environment variable: $VAR.
4922 case '$': ret = get_env_tv(arg, rettv, evaluate);
4923 break;
4926 * Register contents: @r.
4928 case '@': ++*arg;
4929 if (evaluate)
4931 rettv->v_type = VAR_STRING;
4932 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4934 if (**arg != NUL)
4935 ++*arg;
4936 break;
4939 * nested expression: (expression).
4941 case '(': *arg = skipwhite(*arg + 1);
4942 ret = eval1(arg, rettv, evaluate); /* recursive! */
4943 if (**arg == ')')
4944 ++*arg;
4945 else if (ret == OK)
4947 EMSG(_("E110: Missing ')'"));
4948 clear_tv(rettv);
4949 ret = FAIL;
4951 break;
4953 default: ret = NOTDONE;
4954 break;
4957 if (ret == NOTDONE)
4960 * Must be a variable or function name.
4961 * Can also be a curly-braces kind of name: {expr}.
4963 s = *arg;
4964 len = get_name_len(arg, &alias, evaluate, TRUE);
4965 if (alias != NULL)
4966 s = alias;
4968 if (len <= 0)
4969 ret = FAIL;
4970 else
4972 if (**arg == '(') /* recursive! */
4974 /* If "s" is the name of a variable of type VAR_FUNC
4975 * use its contents. */
4976 s = deref_func_name(s, &len);
4978 /* Invoke the function. */
4979 ret = get_func_tv(s, len, rettv, arg,
4980 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
4981 &len, evaluate, NULL);
4982 /* Stop the expression evaluation when immediately
4983 * aborting on error, or when an interrupt occurred or
4984 * an exception was thrown but not caught. */
4985 if (aborting())
4987 if (ret == OK)
4988 clear_tv(rettv);
4989 ret = FAIL;
4992 else if (evaluate)
4993 ret = get_var_tv(s, len, rettv, TRUE);
4994 else
4995 ret = OK;
4998 if (alias != NULL)
4999 vim_free(alias);
5002 *arg = skipwhite(*arg);
5004 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5005 * expr(expr). */
5006 if (ret == OK)
5007 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5010 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5012 if (ret == OK && evaluate && end_leader > start_leader)
5014 int error = FALSE;
5015 int val = 0;
5016 #ifdef FEAT_FLOAT
5017 float_T f = 0.0;
5019 if (rettv->v_type == VAR_FLOAT)
5020 f = rettv->vval.v_float;
5021 else
5022 #endif
5023 val = get_tv_number_chk(rettv, &error);
5024 if (error)
5026 clear_tv(rettv);
5027 ret = FAIL;
5029 else
5031 while (end_leader > start_leader)
5033 --end_leader;
5034 if (*end_leader == '!')
5036 #ifdef FEAT_FLOAT
5037 if (rettv->v_type == VAR_FLOAT)
5038 f = !f;
5039 else
5040 #endif
5041 val = !val;
5043 else if (*end_leader == '-')
5045 #ifdef FEAT_FLOAT
5046 if (rettv->v_type == VAR_FLOAT)
5047 f = -f;
5048 else
5049 #endif
5050 val = -val;
5053 #ifdef FEAT_FLOAT
5054 if (rettv->v_type == VAR_FLOAT)
5056 clear_tv(rettv);
5057 rettv->vval.v_float = f;
5059 else
5060 #endif
5062 clear_tv(rettv);
5063 rettv->v_type = VAR_NUMBER;
5064 rettv->vval.v_number = val;
5069 return ret;
5073 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5074 * "*arg" points to the '[' or '.'.
5075 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5077 static int
5078 eval_index(arg, rettv, evaluate, verbose)
5079 char_u **arg;
5080 typval_T *rettv;
5081 int evaluate;
5082 int verbose; /* give error messages */
5084 int empty1 = FALSE, empty2 = FALSE;
5085 typval_T var1, var2;
5086 long n1, n2 = 0;
5087 long len = -1;
5088 int range = FALSE;
5089 char_u *s;
5090 char_u *key = NULL;
5092 if (rettv->v_type == VAR_FUNC
5093 #ifdef FEAT_FLOAT
5094 || rettv->v_type == VAR_FLOAT
5095 #endif
5098 if (verbose)
5099 EMSG(_("E695: Cannot index a Funcref"));
5100 return FAIL;
5103 if (**arg == '.')
5106 * dict.name
5108 key = *arg + 1;
5109 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5111 if (len == 0)
5112 return FAIL;
5113 *arg = skipwhite(key + len);
5115 else
5118 * something[idx]
5120 * Get the (first) variable from inside the [].
5122 *arg = skipwhite(*arg + 1);
5123 if (**arg == ':')
5124 empty1 = TRUE;
5125 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5126 return FAIL;
5127 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5129 /* not a number or string */
5130 clear_tv(&var1);
5131 return FAIL;
5135 * Get the second variable from inside the [:].
5137 if (**arg == ':')
5139 range = TRUE;
5140 *arg = skipwhite(*arg + 1);
5141 if (**arg == ']')
5142 empty2 = TRUE;
5143 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5145 if (!empty1)
5146 clear_tv(&var1);
5147 return FAIL;
5149 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5151 /* not a number or string */
5152 if (!empty1)
5153 clear_tv(&var1);
5154 clear_tv(&var2);
5155 return FAIL;
5159 /* Check for the ']'. */
5160 if (**arg != ']')
5162 if (verbose)
5163 EMSG(_(e_missbrac));
5164 clear_tv(&var1);
5165 if (range)
5166 clear_tv(&var2);
5167 return FAIL;
5169 *arg = skipwhite(*arg + 1); /* skip the ']' */
5172 if (evaluate)
5174 n1 = 0;
5175 if (!empty1 && rettv->v_type != VAR_DICT)
5177 n1 = get_tv_number(&var1);
5178 clear_tv(&var1);
5180 if (range)
5182 if (empty2)
5183 n2 = -1;
5184 else
5186 n2 = get_tv_number(&var2);
5187 clear_tv(&var2);
5191 switch (rettv->v_type)
5193 case VAR_NUMBER:
5194 case VAR_STRING:
5195 s = get_tv_string(rettv);
5196 len = (long)STRLEN(s);
5197 if (range)
5199 /* The resulting variable is a substring. If the indexes
5200 * are out of range the result is empty. */
5201 if (n1 < 0)
5203 n1 = len + n1;
5204 if (n1 < 0)
5205 n1 = 0;
5207 if (n2 < 0)
5208 n2 = len + n2;
5209 else if (n2 >= len)
5210 n2 = len;
5211 if (n1 >= len || n2 < 0 || n1 > n2)
5212 s = NULL;
5213 else
5214 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5216 else
5218 /* The resulting variable is a string of a single
5219 * character. If the index is too big or negative the
5220 * result is empty. */
5221 if (n1 >= len || n1 < 0)
5222 s = NULL;
5223 else
5224 s = vim_strnsave(s + n1, 1);
5226 clear_tv(rettv);
5227 rettv->v_type = VAR_STRING;
5228 rettv->vval.v_string = s;
5229 break;
5231 case VAR_LIST:
5232 len = list_len(rettv->vval.v_list);
5233 if (n1 < 0)
5234 n1 = len + n1;
5235 if (!empty1 && (n1 < 0 || n1 >= len))
5237 /* For a range we allow invalid values and return an empty
5238 * list. A list index out of range is an error. */
5239 if (!range)
5241 if (verbose)
5242 EMSGN(_(e_listidx), n1);
5243 return FAIL;
5245 n1 = len;
5247 if (range)
5249 list_T *l;
5250 listitem_T *item;
5252 if (n2 < 0)
5253 n2 = len + n2;
5254 else if (n2 >= len)
5255 n2 = len - 1;
5256 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5257 n2 = -1;
5258 l = list_alloc();
5259 if (l == NULL)
5260 return FAIL;
5261 for (item = list_find(rettv->vval.v_list, n1);
5262 n1 <= n2; ++n1)
5264 if (list_append_tv(l, &item->li_tv) == FAIL)
5266 list_free(l, TRUE);
5267 return FAIL;
5269 item = item->li_next;
5271 clear_tv(rettv);
5272 rettv->v_type = VAR_LIST;
5273 rettv->vval.v_list = l;
5274 ++l->lv_refcount;
5276 else
5278 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5279 clear_tv(rettv);
5280 *rettv = var1;
5282 break;
5284 case VAR_DICT:
5285 if (range)
5287 if (verbose)
5288 EMSG(_(e_dictrange));
5289 if (len == -1)
5290 clear_tv(&var1);
5291 return FAIL;
5294 dictitem_T *item;
5296 if (len == -1)
5298 key = get_tv_string(&var1);
5299 if (*key == NUL)
5301 if (verbose)
5302 EMSG(_(e_emptykey));
5303 clear_tv(&var1);
5304 return FAIL;
5308 item = dict_find(rettv->vval.v_dict, key, (int)len);
5310 if (item == NULL && verbose)
5311 EMSG2(_(e_dictkey), key);
5312 if (len == -1)
5313 clear_tv(&var1);
5314 if (item == NULL)
5315 return FAIL;
5317 copy_tv(&item->di_tv, &var1);
5318 clear_tv(rettv);
5319 *rettv = var1;
5321 break;
5325 return OK;
5329 * Get an option value.
5330 * "arg" points to the '&' or '+' before the option name.
5331 * "arg" is advanced to character after the option name.
5332 * Return OK or FAIL.
5334 static int
5335 get_option_tv(arg, rettv, evaluate)
5336 char_u **arg;
5337 typval_T *rettv; /* when NULL, only check if option exists */
5338 int evaluate;
5340 char_u *option_end;
5341 long numval;
5342 char_u *stringval;
5343 int opt_type;
5344 int c;
5345 int working = (**arg == '+'); /* has("+option") */
5346 int ret = OK;
5347 int opt_flags;
5350 * Isolate the option name and find its value.
5352 option_end = find_option_end(arg, &opt_flags);
5353 if (option_end == NULL)
5355 if (rettv != NULL)
5356 EMSG2(_("E112: Option name missing: %s"), *arg);
5357 return FAIL;
5360 if (!evaluate)
5362 *arg = option_end;
5363 return OK;
5366 c = *option_end;
5367 *option_end = NUL;
5368 opt_type = get_option_value(*arg, &numval,
5369 rettv == NULL ? NULL : &stringval, opt_flags);
5371 if (opt_type == -3) /* invalid name */
5373 if (rettv != NULL)
5374 EMSG2(_("E113: Unknown option: %s"), *arg);
5375 ret = FAIL;
5377 else if (rettv != NULL)
5379 if (opt_type == -2) /* hidden string option */
5381 rettv->v_type = VAR_STRING;
5382 rettv->vval.v_string = NULL;
5384 else if (opt_type == -1) /* hidden number option */
5386 rettv->v_type = VAR_NUMBER;
5387 rettv->vval.v_number = 0;
5389 else if (opt_type == 1) /* number option */
5391 rettv->v_type = VAR_NUMBER;
5392 rettv->vval.v_number = numval;
5394 else /* string option */
5396 rettv->v_type = VAR_STRING;
5397 rettv->vval.v_string = stringval;
5400 else if (working && (opt_type == -2 || opt_type == -1))
5401 ret = FAIL;
5403 *option_end = c; /* put back for error messages */
5404 *arg = option_end;
5406 return ret;
5410 * Allocate a variable for a string constant.
5411 * Return OK or FAIL.
5413 static int
5414 get_string_tv(arg, rettv, evaluate)
5415 char_u **arg;
5416 typval_T *rettv;
5417 int evaluate;
5419 char_u *p;
5420 char_u *name;
5421 int extra = 0;
5424 * Find the end of the string, skipping backslashed characters.
5426 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5428 if (*p == '\\' && p[1] != NUL)
5430 ++p;
5431 /* A "\<x>" form occupies at least 4 characters, and produces up
5432 * to 6 characters: reserve space for 2 extra */
5433 if (*p == '<')
5434 extra += 2;
5438 if (*p != '"')
5440 EMSG2(_("E114: Missing quote: %s"), *arg);
5441 return FAIL;
5444 /* If only parsing, set *arg and return here */
5445 if (!evaluate)
5447 *arg = p + 1;
5448 return OK;
5452 * Copy the string into allocated memory, handling backslashed
5453 * characters.
5455 name = alloc((unsigned)(p - *arg + extra));
5456 if (name == NULL)
5457 return FAIL;
5458 rettv->v_type = VAR_STRING;
5459 rettv->vval.v_string = name;
5461 for (p = *arg + 1; *p != NUL && *p != '"'; )
5463 if (*p == '\\')
5465 switch (*++p)
5467 case 'b': *name++ = BS; ++p; break;
5468 case 'e': *name++ = ESC; ++p; break;
5469 case 'f': *name++ = FF; ++p; break;
5470 case 'n': *name++ = NL; ++p; break;
5471 case 'r': *name++ = CAR; ++p; break;
5472 case 't': *name++ = TAB; ++p; break;
5474 case 'X': /* hex: "\x1", "\x12" */
5475 case 'x':
5476 case 'u': /* Unicode: "\u0023" */
5477 case 'U':
5478 if (vim_isxdigit(p[1]))
5480 int n, nr;
5481 int c = toupper(*p);
5483 if (c == 'X')
5484 n = 2;
5485 else
5486 n = 4;
5487 nr = 0;
5488 while (--n >= 0 && vim_isxdigit(p[1]))
5490 ++p;
5491 nr = (nr << 4) + hex2nr(*p);
5493 ++p;
5494 #ifdef FEAT_MBYTE
5495 /* For "\u" store the number according to
5496 * 'encoding'. */
5497 if (c != 'X')
5498 name += (*mb_char2bytes)(nr, name);
5499 else
5500 #endif
5501 *name++ = nr;
5503 break;
5505 /* octal: "\1", "\12", "\123" */
5506 case '0':
5507 case '1':
5508 case '2':
5509 case '3':
5510 case '4':
5511 case '5':
5512 case '6':
5513 case '7': *name = *p++ - '0';
5514 if (*p >= '0' && *p <= '7')
5516 *name = (*name << 3) + *p++ - '0';
5517 if (*p >= '0' && *p <= '7')
5518 *name = (*name << 3) + *p++ - '0';
5520 ++name;
5521 break;
5523 /* Special key, e.g.: "\<C-W>" */
5524 case '<': extra = trans_special(&p, name, TRUE);
5525 if (extra != 0)
5527 name += extra;
5528 break;
5530 /* FALLTHROUGH */
5532 default: MB_COPY_CHAR(p, name);
5533 break;
5536 else
5537 MB_COPY_CHAR(p, name);
5540 *name = NUL;
5541 *arg = p + 1;
5543 return OK;
5547 * Allocate a variable for a 'str''ing' constant.
5548 * Return OK or FAIL.
5550 static int
5551 get_lit_string_tv(arg, rettv, evaluate)
5552 char_u **arg;
5553 typval_T *rettv;
5554 int evaluate;
5556 char_u *p;
5557 char_u *str;
5558 int reduce = 0;
5561 * Find the end of the string, skipping ''.
5563 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5565 if (*p == '\'')
5567 if (p[1] != '\'')
5568 break;
5569 ++reduce;
5570 ++p;
5574 if (*p != '\'')
5576 EMSG2(_("E115: Missing quote: %s"), *arg);
5577 return FAIL;
5580 /* If only parsing return after setting "*arg" */
5581 if (!evaluate)
5583 *arg = p + 1;
5584 return OK;
5588 * Copy the string into allocated memory, handling '' to ' reduction.
5590 str = alloc((unsigned)((p - *arg) - reduce));
5591 if (str == NULL)
5592 return FAIL;
5593 rettv->v_type = VAR_STRING;
5594 rettv->vval.v_string = str;
5596 for (p = *arg + 1; *p != NUL; )
5598 if (*p == '\'')
5600 if (p[1] != '\'')
5601 break;
5602 ++p;
5604 MB_COPY_CHAR(p, str);
5606 *str = NUL;
5607 *arg = p + 1;
5609 return OK;
5613 * Allocate a variable for a List and fill it from "*arg".
5614 * Return OK or FAIL.
5616 static int
5617 get_list_tv(arg, rettv, evaluate)
5618 char_u **arg;
5619 typval_T *rettv;
5620 int evaluate;
5622 list_T *l = NULL;
5623 typval_T tv;
5624 listitem_T *item;
5626 if (evaluate)
5628 l = list_alloc();
5629 if (l == NULL)
5630 return FAIL;
5633 *arg = skipwhite(*arg + 1);
5634 while (**arg != ']' && **arg != NUL)
5636 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5637 goto failret;
5638 if (evaluate)
5640 item = listitem_alloc();
5641 if (item != NULL)
5643 item->li_tv = tv;
5644 item->li_tv.v_lock = 0;
5645 list_append(l, item);
5647 else
5648 clear_tv(&tv);
5651 if (**arg == ']')
5652 break;
5653 if (**arg != ',')
5655 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5656 goto failret;
5658 *arg = skipwhite(*arg + 1);
5661 if (**arg != ']')
5663 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5664 failret:
5665 if (evaluate)
5666 list_free(l, TRUE);
5667 return FAIL;
5670 *arg = skipwhite(*arg + 1);
5671 if (evaluate)
5673 rettv->v_type = VAR_LIST;
5674 rettv->vval.v_list = l;
5675 ++l->lv_refcount;
5678 return OK;
5682 * Allocate an empty header for a list.
5683 * Caller should take care of the reference count.
5685 list_T *
5686 list_alloc()
5688 list_T *l;
5690 l = (list_T *)alloc_clear(sizeof(list_T));
5691 if (l != NULL)
5693 /* Prepend the list to the list of lists for garbage collection. */
5694 if (first_list != NULL)
5695 first_list->lv_used_prev = l;
5696 l->lv_used_prev = NULL;
5697 l->lv_used_next = first_list;
5698 first_list = l;
5700 return l;
5704 * Allocate an empty list for a return value.
5705 * Returns OK or FAIL.
5707 static int
5708 rettv_list_alloc(rettv)
5709 typval_T *rettv;
5711 list_T *l = list_alloc();
5713 if (l == NULL)
5714 return FAIL;
5716 rettv->vval.v_list = l;
5717 rettv->v_type = VAR_LIST;
5718 ++l->lv_refcount;
5719 return OK;
5723 * Unreference a list: decrement the reference count and free it when it
5724 * becomes zero.
5726 void
5727 list_unref(l)
5728 list_T *l;
5730 if (l != NULL && --l->lv_refcount <= 0)
5731 list_free(l, TRUE);
5735 * Free a list, including all items it points to.
5736 * Ignores the reference count.
5738 void
5739 list_free(l, recurse)
5740 list_T *l;
5741 int recurse; /* Free Lists and Dictionaries recursively. */
5743 listitem_T *item;
5745 /* Remove the list from the list of lists for garbage collection. */
5746 if (l->lv_used_prev == NULL)
5747 first_list = l->lv_used_next;
5748 else
5749 l->lv_used_prev->lv_used_next = l->lv_used_next;
5750 if (l->lv_used_next != NULL)
5751 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5753 for (item = l->lv_first; item != NULL; item = l->lv_first)
5755 /* Remove the item before deleting it. */
5756 l->lv_first = item->li_next;
5757 if (recurse || (item->li_tv.v_type != VAR_LIST
5758 && item->li_tv.v_type != VAR_DICT))
5759 clear_tv(&item->li_tv);
5760 vim_free(item);
5762 vim_free(l);
5766 * Allocate a list item.
5768 static listitem_T *
5769 listitem_alloc()
5771 return (listitem_T *)alloc(sizeof(listitem_T));
5775 * Free a list item. Also clears the value. Does not notify watchers.
5777 static void
5778 listitem_free(item)
5779 listitem_T *item;
5781 clear_tv(&item->li_tv);
5782 vim_free(item);
5786 * Remove a list item from a List and free it. Also clears the value.
5788 static void
5789 listitem_remove(l, item)
5790 list_T *l;
5791 listitem_T *item;
5793 list_remove(l, item, item);
5794 listitem_free(item);
5798 * Get the number of items in a list.
5800 static long
5801 list_len(l)
5802 list_T *l;
5804 if (l == NULL)
5805 return 0L;
5806 return l->lv_len;
5810 * Return TRUE when two lists have exactly the same values.
5812 static int
5813 list_equal(l1, l2, ic)
5814 list_T *l1;
5815 list_T *l2;
5816 int ic; /* ignore case for strings */
5818 listitem_T *item1, *item2;
5820 if (l1 == l2)
5821 return TRUE;
5822 if (list_len(l1) != list_len(l2))
5823 return FALSE;
5825 for (item1 = l1->lv_first, item2 = l2->lv_first;
5826 item1 != NULL && item2 != NULL;
5827 item1 = item1->li_next, item2 = item2->li_next)
5828 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5829 return FALSE;
5830 return item1 == NULL && item2 == NULL;
5833 #if defined(FEAT_PYTHON) || defined(PROTO)
5835 * Return the dictitem that an entry in a hashtable points to.
5837 dictitem_T *
5838 dict_lookup(hi)
5839 hashitem_T *hi;
5841 return HI2DI(hi);
5843 #endif
5846 * Return TRUE when two dictionaries have exactly the same key/values.
5848 static int
5849 dict_equal(d1, d2, ic)
5850 dict_T *d1;
5851 dict_T *d2;
5852 int ic; /* ignore case for strings */
5854 hashitem_T *hi;
5855 dictitem_T *item2;
5856 int todo;
5858 if (d1 == d2)
5859 return TRUE;
5860 if (dict_len(d1) != dict_len(d2))
5861 return FALSE;
5863 todo = (int)d1->dv_hashtab.ht_used;
5864 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5866 if (!HASHITEM_EMPTY(hi))
5868 item2 = dict_find(d2, hi->hi_key, -1);
5869 if (item2 == NULL)
5870 return FALSE;
5871 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5872 return FALSE;
5873 --todo;
5876 return TRUE;
5880 * Return TRUE if "tv1" and "tv2" have the same value.
5881 * Compares the items just like "==" would compare them, but strings and
5882 * numbers are different. Floats and numbers are also different.
5884 static int
5885 tv_equal(tv1, tv2, ic)
5886 typval_T *tv1;
5887 typval_T *tv2;
5888 int ic; /* ignore case */
5890 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5891 char_u *s1, *s2;
5892 static int recursive = 0; /* cach recursive loops */
5893 int r;
5895 if (tv1->v_type != tv2->v_type)
5896 return FALSE;
5897 /* Catch lists and dicts that have an endless loop by limiting
5898 * recursiveness to 1000. We guess they are equal then. */
5899 if (recursive >= 1000)
5900 return TRUE;
5902 switch (tv1->v_type)
5904 case VAR_LIST:
5905 ++recursive;
5906 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5907 --recursive;
5908 return r;
5910 case VAR_DICT:
5911 ++recursive;
5912 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5913 --recursive;
5914 return r;
5916 case VAR_FUNC:
5917 return (tv1->vval.v_string != NULL
5918 && tv2->vval.v_string != NULL
5919 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5921 case VAR_NUMBER:
5922 return tv1->vval.v_number == tv2->vval.v_number;
5924 #ifdef FEAT_FLOAT
5925 case VAR_FLOAT:
5926 return tv1->vval.v_float == tv2->vval.v_float;
5927 #endif
5929 case VAR_STRING:
5930 s1 = get_tv_string_buf(tv1, buf1);
5931 s2 = get_tv_string_buf(tv2, buf2);
5932 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5935 EMSG2(_(e_intern2), "tv_equal()");
5936 return TRUE;
5940 * Locate item with index "n" in list "l" and return it.
5941 * A negative index is counted from the end; -1 is the last item.
5942 * Returns NULL when "n" is out of range.
5944 static listitem_T *
5945 list_find(l, n)
5946 list_T *l;
5947 long n;
5949 listitem_T *item;
5950 long idx;
5952 if (l == NULL)
5953 return NULL;
5955 /* Negative index is relative to the end. */
5956 if (n < 0)
5957 n = l->lv_len + n;
5959 /* Check for index out of range. */
5960 if (n < 0 || n >= l->lv_len)
5961 return NULL;
5963 /* When there is a cached index may start search from there. */
5964 if (l->lv_idx_item != NULL)
5966 if (n < l->lv_idx / 2)
5968 /* closest to the start of the list */
5969 item = l->lv_first;
5970 idx = 0;
5972 else if (n > (l->lv_idx + l->lv_len) / 2)
5974 /* closest to the end of the list */
5975 item = l->lv_last;
5976 idx = l->lv_len - 1;
5978 else
5980 /* closest to the cached index */
5981 item = l->lv_idx_item;
5982 idx = l->lv_idx;
5985 else
5987 if (n < l->lv_len / 2)
5989 /* closest to the start of the list */
5990 item = l->lv_first;
5991 idx = 0;
5993 else
5995 /* closest to the end of the list */
5996 item = l->lv_last;
5997 idx = l->lv_len - 1;
6001 while (n > idx)
6003 /* search forward */
6004 item = item->li_next;
6005 ++idx;
6007 while (n < idx)
6009 /* search backward */
6010 item = item->li_prev;
6011 --idx;
6014 /* cache the used index */
6015 l->lv_idx = idx;
6016 l->lv_idx_item = item;
6018 return item;
6022 * Get list item "l[idx]" as a number.
6024 static long
6025 list_find_nr(l, idx, errorp)
6026 list_T *l;
6027 long idx;
6028 int *errorp; /* set to TRUE when something wrong */
6030 listitem_T *li;
6032 li = list_find(l, idx);
6033 if (li == NULL)
6035 if (errorp != NULL)
6036 *errorp = TRUE;
6037 return -1L;
6039 return get_tv_number_chk(&li->li_tv, errorp);
6043 * Locate "item" list "l" and return its index.
6044 * Returns -1 when "item" is not in the list.
6046 static long
6047 list_idx_of_item(l, item)
6048 list_T *l;
6049 listitem_T *item;
6051 long idx = 0;
6052 listitem_T *li;
6054 if (l == NULL)
6055 return -1;
6056 idx = 0;
6057 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6058 ++idx;
6059 if (li == NULL)
6060 return -1;
6061 return idx;
6065 * Append item "item" to the end of list "l".
6067 static void
6068 list_append(l, item)
6069 list_T *l;
6070 listitem_T *item;
6072 if (l->lv_last == NULL)
6074 /* empty list */
6075 l->lv_first = item;
6076 l->lv_last = item;
6077 item->li_prev = NULL;
6079 else
6081 l->lv_last->li_next = item;
6082 item->li_prev = l->lv_last;
6083 l->lv_last = item;
6085 ++l->lv_len;
6086 item->li_next = NULL;
6090 * Append typval_T "tv" to the end of list "l".
6091 * Return FAIL when out of memory.
6093 static int
6094 list_append_tv(l, tv)
6095 list_T *l;
6096 typval_T *tv;
6098 listitem_T *li = listitem_alloc();
6100 if (li == NULL)
6101 return FAIL;
6102 copy_tv(tv, &li->li_tv);
6103 list_append(l, li);
6104 return OK;
6108 * Add a dictionary to a list. Used by getqflist().
6109 * Return FAIL when out of memory.
6112 list_append_dict(list, dict)
6113 list_T *list;
6114 dict_T *dict;
6116 listitem_T *li = listitem_alloc();
6118 if (li == NULL)
6119 return FAIL;
6120 li->li_tv.v_type = VAR_DICT;
6121 li->li_tv.v_lock = 0;
6122 li->li_tv.vval.v_dict = dict;
6123 list_append(list, li);
6124 ++dict->dv_refcount;
6125 return OK;
6129 * Make a copy of "str" and append it as an item to list "l".
6130 * When "len" >= 0 use "str[len]".
6131 * Returns FAIL when out of memory.
6133 static int
6134 list_append_string(l, str, len)
6135 list_T *l;
6136 char_u *str;
6137 int len;
6139 listitem_T *li = listitem_alloc();
6141 if (li == NULL)
6142 return FAIL;
6143 list_append(l, li);
6144 li->li_tv.v_type = VAR_STRING;
6145 li->li_tv.v_lock = 0;
6146 if (str == NULL)
6147 li->li_tv.vval.v_string = NULL;
6148 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6149 : vim_strsave(str))) == NULL)
6150 return FAIL;
6151 return OK;
6155 * Append "n" to list "l".
6156 * Returns FAIL when out of memory.
6158 static int
6159 list_append_number(l, n)
6160 list_T *l;
6161 varnumber_T n;
6163 listitem_T *li;
6165 li = listitem_alloc();
6166 if (li == NULL)
6167 return FAIL;
6168 li->li_tv.v_type = VAR_NUMBER;
6169 li->li_tv.v_lock = 0;
6170 li->li_tv.vval.v_number = n;
6171 list_append(l, li);
6172 return OK;
6176 * Insert typval_T "tv" in list "l" before "item".
6177 * If "item" is NULL append at the end.
6178 * Return FAIL when out of memory.
6180 static int
6181 list_insert_tv(l, tv, item)
6182 list_T *l;
6183 typval_T *tv;
6184 listitem_T *item;
6186 listitem_T *ni = listitem_alloc();
6188 if (ni == NULL)
6189 return FAIL;
6190 copy_tv(tv, &ni->li_tv);
6191 if (item == NULL)
6192 /* Append new item at end of list. */
6193 list_append(l, ni);
6194 else
6196 /* Insert new item before existing item. */
6197 ni->li_prev = item->li_prev;
6198 ni->li_next = item;
6199 if (item->li_prev == NULL)
6201 l->lv_first = ni;
6202 ++l->lv_idx;
6204 else
6206 item->li_prev->li_next = ni;
6207 l->lv_idx_item = NULL;
6209 item->li_prev = ni;
6210 ++l->lv_len;
6212 return OK;
6216 * Extend "l1" with "l2".
6217 * If "bef" is NULL append at the end, otherwise insert before this item.
6218 * Returns FAIL when out of memory.
6220 static int
6221 list_extend(l1, l2, bef)
6222 list_T *l1;
6223 list_T *l2;
6224 listitem_T *bef;
6226 listitem_T *item;
6228 for (item = l2->lv_first; item != NULL; item = item->li_next)
6229 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6230 return FAIL;
6231 return OK;
6235 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6236 * Return FAIL when out of memory.
6238 static int
6239 list_concat(l1, l2, tv)
6240 list_T *l1;
6241 list_T *l2;
6242 typval_T *tv;
6244 list_T *l;
6246 /* make a copy of the first list. */
6247 l = list_copy(l1, FALSE, 0);
6248 if (l == NULL)
6249 return FAIL;
6250 tv->v_type = VAR_LIST;
6251 tv->vval.v_list = l;
6253 /* append all items from the second list */
6254 return list_extend(l, l2, NULL);
6258 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6259 * The refcount of the new list is set to 1.
6260 * See item_copy() for "copyID".
6261 * Returns NULL when out of memory.
6263 static list_T *
6264 list_copy(orig, deep, copyID)
6265 list_T *orig;
6266 int deep;
6267 int copyID;
6269 list_T *copy;
6270 listitem_T *item;
6271 listitem_T *ni;
6273 if (orig == NULL)
6274 return NULL;
6276 copy = list_alloc();
6277 if (copy != NULL)
6279 if (copyID != 0)
6281 /* Do this before adding the items, because one of the items may
6282 * refer back to this list. */
6283 orig->lv_copyID = copyID;
6284 orig->lv_copylist = copy;
6286 for (item = orig->lv_first; item != NULL && !got_int;
6287 item = item->li_next)
6289 ni = listitem_alloc();
6290 if (ni == NULL)
6291 break;
6292 if (deep)
6294 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6296 vim_free(ni);
6297 break;
6300 else
6301 copy_tv(&item->li_tv, &ni->li_tv);
6302 list_append(copy, ni);
6304 ++copy->lv_refcount;
6305 if (item != NULL)
6307 list_unref(copy);
6308 copy = NULL;
6312 return copy;
6316 * Remove items "item" to "item2" from list "l".
6317 * Does not free the listitem or the value!
6319 static void
6320 list_remove(l, item, item2)
6321 list_T *l;
6322 listitem_T *item;
6323 listitem_T *item2;
6325 listitem_T *ip;
6327 /* notify watchers */
6328 for (ip = item; ip != NULL; ip = ip->li_next)
6330 --l->lv_len;
6331 list_fix_watch(l, ip);
6332 if (ip == item2)
6333 break;
6336 if (item2->li_next == NULL)
6337 l->lv_last = item->li_prev;
6338 else
6339 item2->li_next->li_prev = item->li_prev;
6340 if (item->li_prev == NULL)
6341 l->lv_first = item2->li_next;
6342 else
6343 item->li_prev->li_next = item2->li_next;
6344 l->lv_idx_item = NULL;
6348 * Return an allocated string with the string representation of a list.
6349 * May return NULL.
6351 static char_u *
6352 list2string(tv, copyID)
6353 typval_T *tv;
6354 int copyID;
6356 garray_T ga;
6358 if (tv->vval.v_list == NULL)
6359 return NULL;
6360 ga_init2(&ga, (int)sizeof(char), 80);
6361 ga_append(&ga, '[');
6362 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6364 vim_free(ga.ga_data);
6365 return NULL;
6367 ga_append(&ga, ']');
6368 ga_append(&ga, NUL);
6369 return (char_u *)ga.ga_data;
6373 * Join list "l" into a string in "*gap", using separator "sep".
6374 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6375 * Return FAIL or OK.
6377 static int
6378 list_join(gap, l, sep, echo, copyID)
6379 garray_T *gap;
6380 list_T *l;
6381 char_u *sep;
6382 int echo;
6383 int copyID;
6385 int first = TRUE;
6386 char_u *tofree;
6387 char_u numbuf[NUMBUFLEN];
6388 listitem_T *item;
6389 char_u *s;
6391 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6393 if (first)
6394 first = FALSE;
6395 else
6396 ga_concat(gap, sep);
6398 if (echo)
6399 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6400 else
6401 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6402 if (s != NULL)
6403 ga_concat(gap, s);
6404 vim_free(tofree);
6405 if (s == NULL)
6406 return FAIL;
6408 return OK;
6412 * Garbage collection for lists and dictionaries.
6414 * We use reference counts to be able to free most items right away when they
6415 * are no longer used. But for composite items it's possible that it becomes
6416 * unused while the reference count is > 0: When there is a recursive
6417 * reference. Example:
6418 * :let l = [1, 2, 3]
6419 * :let d = {9: l}
6420 * :let l[1] = d
6422 * Since this is quite unusual we handle this with garbage collection: every
6423 * once in a while find out which lists and dicts are not referenced from any
6424 * variable.
6426 * Here is a good reference text about garbage collection (refers to Python
6427 * but it applies to all reference-counting mechanisms):
6428 * http://python.ca/nas/python/gc/
6432 * Do garbage collection for lists and dicts.
6433 * Return TRUE if some memory was freed.
6436 garbage_collect()
6438 dict_T *dd;
6439 list_T *ll;
6440 int copyID = ++current_copyID;
6441 buf_T *buf;
6442 win_T *wp;
6443 int i;
6444 funccall_T *fc;
6445 int did_free = FALSE;
6446 #ifdef FEAT_WINDOWS
6447 tabpage_T *tp;
6448 #endif
6450 /* Only do this once. */
6451 want_garbage_collect = FALSE;
6452 may_garbage_collect = FALSE;
6453 garbage_collect_at_exit = FALSE;
6456 * 1. Go through all accessible variables and mark all lists and dicts
6457 * with copyID.
6459 /* script-local variables */
6460 for (i = 1; i <= ga_scripts.ga_len; ++i)
6461 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6463 /* buffer-local variables */
6464 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6465 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6467 /* window-local variables */
6468 FOR_ALL_TAB_WINDOWS(tp, wp)
6469 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6471 #ifdef FEAT_WINDOWS
6472 /* tabpage-local variables */
6473 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6474 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6475 #endif
6477 /* global variables */
6478 set_ref_in_ht(&globvarht, copyID);
6480 /* function-local variables */
6481 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6483 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6484 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6488 * 2. Go through the list of dicts and free items without the copyID.
6490 for (dd = first_dict; dd != NULL; )
6491 if (dd->dv_copyID != copyID)
6493 /* Free the Dictionary and ordinary items it contains, but don't
6494 * recurse into Lists and Dictionaries, they will be in the list
6495 * of dicts or list of lists. */
6496 dict_free(dd, FALSE);
6497 did_free = TRUE;
6499 /* restart, next dict may also have been freed */
6500 dd = first_dict;
6502 else
6503 dd = dd->dv_used_next;
6506 * 3. Go through the list of lists and free items without the copyID.
6507 * But don't free a list that has a watcher (used in a for loop), these
6508 * are not referenced anywhere.
6510 for (ll = first_list; ll != NULL; )
6511 if (ll->lv_copyID != copyID && ll->lv_watch == NULL)
6513 /* Free the List and ordinary items it contains, but don't recurse
6514 * into Lists and Dictionaries, they will be in the list of dicts
6515 * or list of lists. */
6516 list_free(ll, FALSE);
6517 did_free = TRUE;
6519 /* restart, next list may also have been freed */
6520 ll = first_list;
6522 else
6523 ll = ll->lv_used_next;
6525 return did_free;
6529 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6531 static void
6532 set_ref_in_ht(ht, copyID)
6533 hashtab_T *ht;
6534 int copyID;
6536 int todo;
6537 hashitem_T *hi;
6539 todo = (int)ht->ht_used;
6540 for (hi = ht->ht_array; todo > 0; ++hi)
6541 if (!HASHITEM_EMPTY(hi))
6543 --todo;
6544 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6549 * Mark all lists and dicts referenced through list "l" with "copyID".
6551 static void
6552 set_ref_in_list(l, copyID)
6553 list_T *l;
6554 int copyID;
6556 listitem_T *li;
6558 for (li = l->lv_first; li != NULL; li = li->li_next)
6559 set_ref_in_item(&li->li_tv, copyID);
6563 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6565 static void
6566 set_ref_in_item(tv, copyID)
6567 typval_T *tv;
6568 int copyID;
6570 dict_T *dd;
6571 list_T *ll;
6573 switch (tv->v_type)
6575 case VAR_DICT:
6576 dd = tv->vval.v_dict;
6577 if (dd->dv_copyID != copyID)
6579 /* Didn't see this dict yet. */
6580 dd->dv_copyID = copyID;
6581 set_ref_in_ht(&dd->dv_hashtab, copyID);
6583 break;
6585 case VAR_LIST:
6586 ll = tv->vval.v_list;
6587 if (ll->lv_copyID != copyID)
6589 /* Didn't see this list yet. */
6590 ll->lv_copyID = copyID;
6591 set_ref_in_list(ll, copyID);
6593 break;
6595 return;
6599 * Allocate an empty header for a dictionary.
6601 dict_T *
6602 dict_alloc()
6604 dict_T *d;
6606 d = (dict_T *)alloc(sizeof(dict_T));
6607 if (d != NULL)
6609 /* Add the list to the list of dicts for garbage collection. */
6610 if (first_dict != NULL)
6611 first_dict->dv_used_prev = d;
6612 d->dv_used_next = first_dict;
6613 d->dv_used_prev = NULL;
6614 first_dict = d;
6616 hash_init(&d->dv_hashtab);
6617 d->dv_lock = 0;
6618 d->dv_refcount = 0;
6619 d->dv_copyID = 0;
6621 return d;
6625 * Unreference a Dictionary: decrement the reference count and free it when it
6626 * becomes zero.
6628 static void
6629 dict_unref(d)
6630 dict_T *d;
6632 if (d != NULL && --d->dv_refcount <= 0)
6633 dict_free(d, TRUE);
6637 * Free a Dictionary, including all items it contains.
6638 * Ignores the reference count.
6640 static void
6641 dict_free(d, recurse)
6642 dict_T *d;
6643 int recurse; /* Free Lists and Dictionaries recursively. */
6645 int todo;
6646 hashitem_T *hi;
6647 dictitem_T *di;
6649 /* Remove the dict from the list of dicts for garbage collection. */
6650 if (d->dv_used_prev == NULL)
6651 first_dict = d->dv_used_next;
6652 else
6653 d->dv_used_prev->dv_used_next = d->dv_used_next;
6654 if (d->dv_used_next != NULL)
6655 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6657 /* Lock the hashtab, we don't want it to resize while freeing items. */
6658 hash_lock(&d->dv_hashtab);
6659 todo = (int)d->dv_hashtab.ht_used;
6660 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6662 if (!HASHITEM_EMPTY(hi))
6664 /* Remove the item before deleting it, just in case there is
6665 * something recursive causing trouble. */
6666 di = HI2DI(hi);
6667 hash_remove(&d->dv_hashtab, hi);
6668 if (recurse || (di->di_tv.v_type != VAR_LIST
6669 && di->di_tv.v_type != VAR_DICT))
6670 clear_tv(&di->di_tv);
6671 vim_free(di);
6672 --todo;
6675 hash_clear(&d->dv_hashtab);
6676 vim_free(d);
6680 * Allocate a Dictionary item.
6681 * The "key" is copied to the new item.
6682 * Note that the value of the item "di_tv" still needs to be initialized!
6683 * Returns NULL when out of memory.
6685 static dictitem_T *
6686 dictitem_alloc(key)
6687 char_u *key;
6689 dictitem_T *di;
6691 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6692 if (di != NULL)
6694 STRCPY(di->di_key, key);
6695 di->di_flags = 0;
6697 return di;
6701 * Make a copy of a Dictionary item.
6703 static dictitem_T *
6704 dictitem_copy(org)
6705 dictitem_T *org;
6707 dictitem_T *di;
6709 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6710 + STRLEN(org->di_key)));
6711 if (di != NULL)
6713 STRCPY(di->di_key, org->di_key);
6714 di->di_flags = 0;
6715 copy_tv(&org->di_tv, &di->di_tv);
6717 return di;
6721 * Remove item "item" from Dictionary "dict" and free it.
6723 static void
6724 dictitem_remove(dict, item)
6725 dict_T *dict;
6726 dictitem_T *item;
6728 hashitem_T *hi;
6730 hi = hash_find(&dict->dv_hashtab, item->di_key);
6731 if (HASHITEM_EMPTY(hi))
6732 EMSG2(_(e_intern2), "dictitem_remove()");
6733 else
6734 hash_remove(&dict->dv_hashtab, hi);
6735 dictitem_free(item);
6739 * Free a dict item. Also clears the value.
6741 static void
6742 dictitem_free(item)
6743 dictitem_T *item;
6745 clear_tv(&item->di_tv);
6746 vim_free(item);
6750 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6751 * The refcount of the new dict is set to 1.
6752 * See item_copy() for "copyID".
6753 * Returns NULL when out of memory.
6755 static dict_T *
6756 dict_copy(orig, deep, copyID)
6757 dict_T *orig;
6758 int deep;
6759 int copyID;
6761 dict_T *copy;
6762 dictitem_T *di;
6763 int todo;
6764 hashitem_T *hi;
6766 if (orig == NULL)
6767 return NULL;
6769 copy = dict_alloc();
6770 if (copy != NULL)
6772 if (copyID != 0)
6774 orig->dv_copyID = copyID;
6775 orig->dv_copydict = copy;
6777 todo = (int)orig->dv_hashtab.ht_used;
6778 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6780 if (!HASHITEM_EMPTY(hi))
6782 --todo;
6784 di = dictitem_alloc(hi->hi_key);
6785 if (di == NULL)
6786 break;
6787 if (deep)
6789 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6790 copyID) == FAIL)
6792 vim_free(di);
6793 break;
6796 else
6797 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6798 if (dict_add(copy, di) == FAIL)
6800 dictitem_free(di);
6801 break;
6806 ++copy->dv_refcount;
6807 if (todo > 0)
6809 dict_unref(copy);
6810 copy = NULL;
6814 return copy;
6818 * Add item "item" to Dictionary "d".
6819 * Returns FAIL when out of memory and when key already existed.
6821 static int
6822 dict_add(d, item)
6823 dict_T *d;
6824 dictitem_T *item;
6826 return hash_add(&d->dv_hashtab, item->di_key);
6830 * Add a number or string entry to dictionary "d".
6831 * When "str" is NULL use number "nr", otherwise use "str".
6832 * Returns FAIL when out of memory and when key already exists.
6835 dict_add_nr_str(d, key, nr, str)
6836 dict_T *d;
6837 char *key;
6838 long nr;
6839 char_u *str;
6841 dictitem_T *item;
6843 item = dictitem_alloc((char_u *)key);
6844 if (item == NULL)
6845 return FAIL;
6846 item->di_tv.v_lock = 0;
6847 if (str == NULL)
6849 item->di_tv.v_type = VAR_NUMBER;
6850 item->di_tv.vval.v_number = nr;
6852 else
6854 item->di_tv.v_type = VAR_STRING;
6855 item->di_tv.vval.v_string = vim_strsave(str);
6857 if (dict_add(d, item) == FAIL)
6859 dictitem_free(item);
6860 return FAIL;
6862 return OK;
6866 * Get the number of items in a Dictionary.
6868 static long
6869 dict_len(d)
6870 dict_T *d;
6872 if (d == NULL)
6873 return 0L;
6874 return (long)d->dv_hashtab.ht_used;
6878 * Find item "key[len]" in Dictionary "d".
6879 * If "len" is negative use strlen(key).
6880 * Returns NULL when not found.
6882 static dictitem_T *
6883 dict_find(d, key, len)
6884 dict_T *d;
6885 char_u *key;
6886 int len;
6888 #define AKEYLEN 200
6889 char_u buf[AKEYLEN];
6890 char_u *akey;
6891 char_u *tofree = NULL;
6892 hashitem_T *hi;
6894 if (len < 0)
6895 akey = key;
6896 else if (len >= AKEYLEN)
6898 tofree = akey = vim_strnsave(key, len);
6899 if (akey == NULL)
6900 return NULL;
6902 else
6904 /* Avoid a malloc/free by using buf[]. */
6905 vim_strncpy(buf, key, len);
6906 akey = buf;
6909 hi = hash_find(&d->dv_hashtab, akey);
6910 vim_free(tofree);
6911 if (HASHITEM_EMPTY(hi))
6912 return NULL;
6913 return HI2DI(hi);
6917 * Get a string item from a dictionary.
6918 * When "save" is TRUE allocate memory for it.
6919 * Returns NULL if the entry doesn't exist or out of memory.
6921 char_u *
6922 get_dict_string(d, key, save)
6923 dict_T *d;
6924 char_u *key;
6925 int save;
6927 dictitem_T *di;
6928 char_u *s;
6930 di = dict_find(d, key, -1);
6931 if (di == NULL)
6932 return NULL;
6933 s = get_tv_string(&di->di_tv);
6934 if (save && s != NULL)
6935 s = vim_strsave(s);
6936 return s;
6940 * Get a number item from a dictionary.
6941 * Returns 0 if the entry doesn't exist or out of memory.
6943 long
6944 get_dict_number(d, key)
6945 dict_T *d;
6946 char_u *key;
6948 dictitem_T *di;
6950 di = dict_find(d, key, -1);
6951 if (di == NULL)
6952 return 0;
6953 return get_tv_number(&di->di_tv);
6957 * Return an allocated string with the string representation of a Dictionary.
6958 * May return NULL.
6960 static char_u *
6961 dict2string(tv, copyID)
6962 typval_T *tv;
6963 int copyID;
6965 garray_T ga;
6966 int first = TRUE;
6967 char_u *tofree;
6968 char_u numbuf[NUMBUFLEN];
6969 hashitem_T *hi;
6970 char_u *s;
6971 dict_T *d;
6972 int todo;
6974 if ((d = tv->vval.v_dict) == NULL)
6975 return NULL;
6976 ga_init2(&ga, (int)sizeof(char), 80);
6977 ga_append(&ga, '{');
6979 todo = (int)d->dv_hashtab.ht_used;
6980 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6982 if (!HASHITEM_EMPTY(hi))
6984 --todo;
6986 if (first)
6987 first = FALSE;
6988 else
6989 ga_concat(&ga, (char_u *)", ");
6991 tofree = string_quote(hi->hi_key, FALSE);
6992 if (tofree != NULL)
6994 ga_concat(&ga, tofree);
6995 vim_free(tofree);
6997 ga_concat(&ga, (char_u *)": ");
6998 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
6999 if (s != NULL)
7000 ga_concat(&ga, s);
7001 vim_free(tofree);
7002 if (s == NULL)
7003 break;
7006 if (todo > 0)
7008 vim_free(ga.ga_data);
7009 return NULL;
7012 ga_append(&ga, '}');
7013 ga_append(&ga, NUL);
7014 return (char_u *)ga.ga_data;
7018 * Allocate a variable for a Dictionary and fill it from "*arg".
7019 * Return OK or FAIL. Returns NOTDONE for {expr}.
7021 static int
7022 get_dict_tv(arg, rettv, evaluate)
7023 char_u **arg;
7024 typval_T *rettv;
7025 int evaluate;
7027 dict_T *d = NULL;
7028 typval_T tvkey;
7029 typval_T tv;
7030 char_u *key = NULL;
7031 dictitem_T *item;
7032 char_u *start = skipwhite(*arg + 1);
7033 char_u buf[NUMBUFLEN];
7036 * First check if it's not a curly-braces thing: {expr}.
7037 * Must do this without evaluating, otherwise a function may be called
7038 * twice. Unfortunately this means we need to call eval1() twice for the
7039 * first item.
7040 * But {} is an empty Dictionary.
7042 if (*start != '}')
7044 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7045 return FAIL;
7046 if (*start == '}')
7047 return NOTDONE;
7050 if (evaluate)
7052 d = dict_alloc();
7053 if (d == NULL)
7054 return FAIL;
7056 tvkey.v_type = VAR_UNKNOWN;
7057 tv.v_type = VAR_UNKNOWN;
7059 *arg = skipwhite(*arg + 1);
7060 while (**arg != '}' && **arg != NUL)
7062 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7063 goto failret;
7064 if (**arg != ':')
7066 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7067 clear_tv(&tvkey);
7068 goto failret;
7070 if (evaluate)
7072 key = get_tv_string_buf_chk(&tvkey, buf);
7073 if (key == NULL || *key == NUL)
7075 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7076 if (key != NULL)
7077 EMSG(_(e_emptykey));
7078 clear_tv(&tvkey);
7079 goto failret;
7083 *arg = skipwhite(*arg + 1);
7084 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7086 if (evaluate)
7087 clear_tv(&tvkey);
7088 goto failret;
7090 if (evaluate)
7092 item = dict_find(d, key, -1);
7093 if (item != NULL)
7095 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7096 clear_tv(&tvkey);
7097 clear_tv(&tv);
7098 goto failret;
7100 item = dictitem_alloc(key);
7101 clear_tv(&tvkey);
7102 if (item != NULL)
7104 item->di_tv = tv;
7105 item->di_tv.v_lock = 0;
7106 if (dict_add(d, item) == FAIL)
7107 dictitem_free(item);
7111 if (**arg == '}')
7112 break;
7113 if (**arg != ',')
7115 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7116 goto failret;
7118 *arg = skipwhite(*arg + 1);
7121 if (**arg != '}')
7123 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7124 failret:
7125 if (evaluate)
7126 dict_free(d, TRUE);
7127 return FAIL;
7130 *arg = skipwhite(*arg + 1);
7131 if (evaluate)
7133 rettv->v_type = VAR_DICT;
7134 rettv->vval.v_dict = d;
7135 ++d->dv_refcount;
7138 return OK;
7142 * Return a string with the string representation of a variable.
7143 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7144 * "numbuf" is used for a number.
7145 * Does not put quotes around strings, as ":echo" displays values.
7146 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7147 * May return NULL.
7149 static char_u *
7150 echo_string(tv, tofree, numbuf, copyID)
7151 typval_T *tv;
7152 char_u **tofree;
7153 char_u *numbuf;
7154 int copyID;
7156 static int recurse = 0;
7157 char_u *r = NULL;
7159 if (recurse >= DICT_MAXNEST)
7161 EMSG(_("E724: variable nested too deep for displaying"));
7162 *tofree = NULL;
7163 return NULL;
7165 ++recurse;
7167 switch (tv->v_type)
7169 case VAR_FUNC:
7170 *tofree = NULL;
7171 r = tv->vval.v_string;
7172 break;
7174 case VAR_LIST:
7175 if (tv->vval.v_list == NULL)
7177 *tofree = NULL;
7178 r = NULL;
7180 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7182 *tofree = NULL;
7183 r = (char_u *)"[...]";
7185 else
7187 tv->vval.v_list->lv_copyID = copyID;
7188 *tofree = list2string(tv, copyID);
7189 r = *tofree;
7191 break;
7193 case VAR_DICT:
7194 if (tv->vval.v_dict == NULL)
7196 *tofree = NULL;
7197 r = NULL;
7199 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7201 *tofree = NULL;
7202 r = (char_u *)"{...}";
7204 else
7206 tv->vval.v_dict->dv_copyID = copyID;
7207 *tofree = dict2string(tv, copyID);
7208 r = *tofree;
7210 break;
7212 case VAR_STRING:
7213 case VAR_NUMBER:
7214 *tofree = NULL;
7215 r = get_tv_string_buf(tv, numbuf);
7216 break;
7218 #ifdef FEAT_FLOAT
7219 case VAR_FLOAT:
7220 *tofree = NULL;
7221 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7222 r = numbuf;
7223 break;
7224 #endif
7226 default:
7227 EMSG2(_(e_intern2), "echo_string()");
7228 *tofree = NULL;
7231 --recurse;
7232 return r;
7236 * Return a string with the string representation of a variable.
7237 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7238 * "numbuf" is used for a number.
7239 * Puts quotes around strings, so that they can be parsed back by eval().
7240 * May return NULL.
7242 static char_u *
7243 tv2string(tv, tofree, numbuf, copyID)
7244 typval_T *tv;
7245 char_u **tofree;
7246 char_u *numbuf;
7247 int copyID;
7249 switch (tv->v_type)
7251 case VAR_FUNC:
7252 *tofree = string_quote(tv->vval.v_string, TRUE);
7253 return *tofree;
7254 case VAR_STRING:
7255 *tofree = string_quote(tv->vval.v_string, FALSE);
7256 return *tofree;
7257 #ifdef FEAT_FLOAT
7258 case VAR_FLOAT:
7259 *tofree = NULL;
7260 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7261 return numbuf;
7262 #endif
7263 case VAR_NUMBER:
7264 case VAR_LIST:
7265 case VAR_DICT:
7266 break;
7267 default:
7268 EMSG2(_(e_intern2), "tv2string()");
7270 return echo_string(tv, tofree, numbuf, copyID);
7274 * Return string "str" in ' quotes, doubling ' characters.
7275 * If "str" is NULL an empty string is assumed.
7276 * If "function" is TRUE make it function('string').
7278 static char_u *
7279 string_quote(str, function)
7280 char_u *str;
7281 int function;
7283 unsigned len;
7284 char_u *p, *r, *s;
7286 len = (function ? 13 : 3);
7287 if (str != NULL)
7289 len += (unsigned)STRLEN(str);
7290 for (p = str; *p != NUL; mb_ptr_adv(p))
7291 if (*p == '\'')
7292 ++len;
7294 s = r = alloc(len);
7295 if (r != NULL)
7297 if (function)
7299 STRCPY(r, "function('");
7300 r += 10;
7302 else
7303 *r++ = '\'';
7304 if (str != NULL)
7305 for (p = str; *p != NUL; )
7307 if (*p == '\'')
7308 *r++ = '\'';
7309 MB_COPY_CHAR(p, r);
7311 *r++ = '\'';
7312 if (function)
7313 *r++ = ')';
7314 *r++ = NUL;
7316 return s;
7319 #ifdef FEAT_FLOAT
7321 * Convert the string "text" to a floating point number.
7322 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7323 * this always uses a decimal point.
7324 * Returns the length of the text that was consumed.
7326 static int
7327 string2float(text, value)
7328 char_u *text;
7329 float_T *value; /* result stored here */
7331 char *s = (char *)text;
7332 float_T f;
7334 f = strtod(s, &s);
7335 *value = f;
7336 return (int)((char_u *)s - text);
7338 #endif
7341 * Get the value of an environment variable.
7342 * "arg" is pointing to the '$'. It is advanced to after the name.
7343 * If the environment variable was not set, silently assume it is empty.
7344 * Always return OK.
7346 static int
7347 get_env_tv(arg, rettv, evaluate)
7348 char_u **arg;
7349 typval_T *rettv;
7350 int evaluate;
7352 char_u *string = NULL;
7353 int len;
7354 int cc;
7355 char_u *name;
7356 int mustfree = FALSE;
7358 ++*arg;
7359 name = *arg;
7360 len = get_env_len(arg);
7361 if (evaluate)
7363 if (len != 0)
7365 cc = name[len];
7366 name[len] = NUL;
7367 /* first try vim_getenv(), fast for normal environment vars */
7368 string = vim_getenv(name, &mustfree);
7369 if (string != NULL && *string != NUL)
7371 if (!mustfree)
7372 string = vim_strsave(string);
7374 else
7376 if (mustfree)
7377 vim_free(string);
7379 /* next try expanding things like $VIM and ${HOME} */
7380 string = expand_env_save(name - 1);
7381 if (string != NULL && *string == '$')
7383 vim_free(string);
7384 string = NULL;
7387 name[len] = cc;
7389 rettv->v_type = VAR_STRING;
7390 rettv->vval.v_string = string;
7393 return OK;
7397 * Array with names and number of arguments of all internal functions
7398 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7400 static struct fst
7402 char *f_name; /* function name */
7403 char f_min_argc; /* minimal number of arguments */
7404 char f_max_argc; /* maximal number of arguments */
7405 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7406 /* implementation of function */
7407 } functions[] =
7409 #ifdef FEAT_FLOAT
7410 {"abs", 1, 1, f_abs},
7411 #endif
7412 {"add", 2, 2, f_add},
7413 {"append", 2, 2, f_append},
7414 {"argc", 0, 0, f_argc},
7415 {"argidx", 0, 0, f_argidx},
7416 {"argv", 0, 1, f_argv},
7417 #ifdef FEAT_FLOAT
7418 {"atan", 1, 1, f_atan},
7419 #endif
7420 {"browse", 4, 4, f_browse},
7421 {"browsedir", 2, 2, f_browsedir},
7422 {"bufexists", 1, 1, f_bufexists},
7423 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7424 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7425 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7426 {"buflisted", 1, 1, f_buflisted},
7427 {"bufloaded", 1, 1, f_bufloaded},
7428 {"bufname", 1, 1, f_bufname},
7429 {"bufnr", 1, 2, f_bufnr},
7430 {"bufwinnr", 1, 1, f_bufwinnr},
7431 {"byte2line", 1, 1, f_byte2line},
7432 {"byteidx", 2, 2, f_byteidx},
7433 {"call", 2, 3, f_call},
7434 #ifdef FEAT_FLOAT
7435 {"ceil", 1, 1, f_ceil},
7436 #endif
7437 {"changenr", 0, 0, f_changenr},
7438 {"char2nr", 1, 1, f_char2nr},
7439 {"cindent", 1, 1, f_cindent},
7440 {"clearmatches", 0, 0, f_clearmatches},
7441 {"col", 1, 1, f_col},
7442 #if defined(FEAT_INS_EXPAND)
7443 {"complete", 2, 2, f_complete},
7444 {"complete_add", 1, 1, f_complete_add},
7445 {"complete_check", 0, 0, f_complete_check},
7446 #endif
7447 {"confirm", 1, 4, f_confirm},
7448 {"copy", 1, 1, f_copy},
7449 #ifdef FEAT_FLOAT
7450 {"cos", 1, 1, f_cos},
7451 #endif
7452 {"count", 2, 4, f_count},
7453 {"cscope_connection",0,3, f_cscope_connection},
7454 {"cursor", 1, 3, f_cursor},
7455 {"deepcopy", 1, 2, f_deepcopy},
7456 {"delete", 1, 1, f_delete},
7457 {"did_filetype", 0, 0, f_did_filetype},
7458 {"diff_filler", 1, 1, f_diff_filler},
7459 {"diff_hlID", 2, 2, f_diff_hlID},
7460 {"empty", 1, 1, f_empty},
7461 {"escape", 2, 2, f_escape},
7462 {"eval", 1, 1, f_eval},
7463 {"eventhandler", 0, 0, f_eventhandler},
7464 {"executable", 1, 1, f_executable},
7465 {"exists", 1, 1, f_exists},
7466 {"expand", 1, 2, f_expand},
7467 {"extend", 2, 3, f_extend},
7468 {"feedkeys", 1, 2, f_feedkeys},
7469 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7470 {"filereadable", 1, 1, f_filereadable},
7471 {"filewritable", 1, 1, f_filewritable},
7472 {"filter", 2, 2, f_filter},
7473 {"finddir", 1, 3, f_finddir},
7474 {"findfile", 1, 3, f_findfile},
7475 #ifdef FEAT_FLOAT
7476 {"float2nr", 1, 1, f_float2nr},
7477 {"floor", 1, 1, f_floor},
7478 #endif
7479 {"fnameescape", 1, 1, f_fnameescape},
7480 {"fnamemodify", 2, 2, f_fnamemodify},
7481 {"foldclosed", 1, 1, f_foldclosed},
7482 {"foldclosedend", 1, 1, f_foldclosedend},
7483 {"foldlevel", 1, 1, f_foldlevel},
7484 {"foldtext", 0, 0, f_foldtext},
7485 {"foldtextresult", 1, 1, f_foldtextresult},
7486 {"foreground", 0, 0, f_foreground},
7487 {"function", 1, 1, f_function},
7488 {"garbagecollect", 0, 1, f_garbagecollect},
7489 {"get", 2, 3, f_get},
7490 {"getbufline", 2, 3, f_getbufline},
7491 {"getbufvar", 2, 2, f_getbufvar},
7492 {"getchar", 0, 1, f_getchar},
7493 {"getcharmod", 0, 0, f_getcharmod},
7494 {"getcmdline", 0, 0, f_getcmdline},
7495 {"getcmdpos", 0, 0, f_getcmdpos},
7496 {"getcmdtype", 0, 0, f_getcmdtype},
7497 {"getcwd", 0, 0, f_getcwd},
7498 {"getfontname", 0, 1, f_getfontname},
7499 {"getfperm", 1, 1, f_getfperm},
7500 {"getfsize", 1, 1, f_getfsize},
7501 {"getftime", 1, 1, f_getftime},
7502 {"getftype", 1, 1, f_getftype},
7503 {"getline", 1, 2, f_getline},
7504 {"getloclist", 1, 1, f_getqflist},
7505 {"getmatches", 0, 0, f_getmatches},
7506 {"getpid", 0, 0, f_getpid},
7507 {"getpos", 1, 1, f_getpos},
7508 {"getqflist", 0, 0, f_getqflist},
7509 {"getreg", 0, 2, f_getreg},
7510 {"getregtype", 0, 1, f_getregtype},
7511 {"gettabwinvar", 3, 3, f_gettabwinvar},
7512 {"getwinposx", 0, 0, f_getwinposx},
7513 {"getwinposy", 0, 0, f_getwinposy},
7514 {"getwinvar", 2, 2, f_getwinvar},
7515 {"glob", 1, 1, f_glob},
7516 {"globpath", 2, 2, f_globpath},
7517 {"has", 1, 1, f_has},
7518 {"has_key", 2, 2, f_has_key},
7519 {"haslocaldir", 0, 0, f_haslocaldir},
7520 {"hasmapto", 1, 3, f_hasmapto},
7521 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7522 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7523 {"histadd", 2, 2, f_histadd},
7524 {"histdel", 1, 2, f_histdel},
7525 {"histget", 1, 2, f_histget},
7526 {"histnr", 1, 1, f_histnr},
7527 {"hlID", 1, 1, f_hlID},
7528 {"hlexists", 1, 1, f_hlexists},
7529 {"hostname", 0, 0, f_hostname},
7530 {"iconv", 3, 3, f_iconv},
7531 {"indent", 1, 1, f_indent},
7532 {"index", 2, 4, f_index},
7533 {"input", 1, 3, f_input},
7534 {"inputdialog", 1, 3, f_inputdialog},
7535 {"inputlist", 1, 1, f_inputlist},
7536 {"inputrestore", 0, 0, f_inputrestore},
7537 {"inputsave", 0, 0, f_inputsave},
7538 {"inputsecret", 1, 2, f_inputsecret},
7539 {"insert", 2, 3, f_insert},
7540 {"isdirectory", 1, 1, f_isdirectory},
7541 {"islocked", 1, 1, f_islocked},
7542 {"items", 1, 1, f_items},
7543 {"join", 1, 2, f_join},
7544 {"keys", 1, 1, f_keys},
7545 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7546 {"len", 1, 1, f_len},
7547 {"libcall", 3, 3, f_libcall},
7548 {"libcallnr", 3, 3, f_libcallnr},
7549 {"line", 1, 1, f_line},
7550 {"line2byte", 1, 1, f_line2byte},
7551 {"lispindent", 1, 1, f_lispindent},
7552 {"localtime", 0, 0, f_localtime},
7553 #ifdef FEAT_FLOAT
7554 {"log10", 1, 1, f_log10},
7555 #endif
7556 {"map", 2, 2, f_map},
7557 {"maparg", 1, 3, f_maparg},
7558 {"mapcheck", 1, 3, f_mapcheck},
7559 {"match", 2, 4, f_match},
7560 {"matchadd", 2, 4, f_matchadd},
7561 {"matcharg", 1, 1, f_matcharg},
7562 {"matchdelete", 1, 1, f_matchdelete},
7563 {"matchend", 2, 4, f_matchend},
7564 {"matchlist", 2, 4, f_matchlist},
7565 {"matchstr", 2, 4, f_matchstr},
7566 {"max", 1, 1, f_max},
7567 {"min", 1, 1, f_min},
7568 #ifdef vim_mkdir
7569 {"mkdir", 1, 3, f_mkdir},
7570 #endif
7571 {"mode", 0, 1, f_mode},
7572 {"nextnonblank", 1, 1, f_nextnonblank},
7573 {"nr2char", 1, 1, f_nr2char},
7574 {"pathshorten", 1, 1, f_pathshorten},
7575 #ifdef FEAT_FLOAT
7576 {"pow", 2, 2, f_pow},
7577 #endif
7578 {"prevnonblank", 1, 1, f_prevnonblank},
7579 {"printf", 2, 19, f_printf},
7580 {"pumvisible", 0, 0, f_pumvisible},
7581 {"range", 1, 3, f_range},
7582 {"readfile", 1, 3, f_readfile},
7583 {"reltime", 0, 2, f_reltime},
7584 {"reltimestr", 1, 1, f_reltimestr},
7585 {"remote_expr", 2, 3, f_remote_expr},
7586 {"remote_foreground", 1, 1, f_remote_foreground},
7587 {"remote_peek", 1, 2, f_remote_peek},
7588 {"remote_read", 1, 1, f_remote_read},
7589 {"remote_send", 2, 3, f_remote_send},
7590 {"remove", 2, 3, f_remove},
7591 {"rename", 2, 2, f_rename},
7592 {"repeat", 2, 2, f_repeat},
7593 {"resolve", 1, 1, f_resolve},
7594 {"reverse", 1, 1, f_reverse},
7595 #ifdef FEAT_FLOAT
7596 {"round", 1, 1, f_round},
7597 #endif
7598 {"search", 1, 4, f_search},
7599 {"searchdecl", 1, 3, f_searchdecl},
7600 {"searchpair", 3, 7, f_searchpair},
7601 {"searchpairpos", 3, 7, f_searchpairpos},
7602 {"searchpos", 1, 4, f_searchpos},
7603 {"server2client", 2, 2, f_server2client},
7604 {"serverlist", 0, 0, f_serverlist},
7605 {"setbufvar", 3, 3, f_setbufvar},
7606 {"setcmdpos", 1, 1, f_setcmdpos},
7607 {"setline", 2, 2, f_setline},
7608 {"setloclist", 2, 3, f_setloclist},
7609 {"setmatches", 1, 1, f_setmatches},
7610 {"setpos", 2, 2, f_setpos},
7611 {"setqflist", 1, 2, f_setqflist},
7612 {"setreg", 2, 3, f_setreg},
7613 {"settabwinvar", 4, 4, f_settabwinvar},
7614 {"setwinvar", 3, 3, f_setwinvar},
7615 {"shellescape", 1, 2, f_shellescape},
7616 {"simplify", 1, 1, f_simplify},
7617 #ifdef FEAT_FLOAT
7618 {"sin", 1, 1, f_sin},
7619 #endif
7620 {"sort", 1, 2, f_sort},
7621 {"soundfold", 1, 1, f_soundfold},
7622 {"spellbadword", 0, 1, f_spellbadword},
7623 {"spellsuggest", 1, 3, f_spellsuggest},
7624 {"split", 1, 3, f_split},
7625 #ifdef FEAT_FLOAT
7626 {"sqrt", 1, 1, f_sqrt},
7627 {"str2float", 1, 1, f_str2float},
7628 #endif
7629 {"str2nr", 1, 2, f_str2nr},
7630 #ifdef HAVE_STRFTIME
7631 {"strftime", 1, 2, f_strftime},
7632 #endif
7633 {"stridx", 2, 3, f_stridx},
7634 {"string", 1, 1, f_string},
7635 {"strlen", 1, 1, f_strlen},
7636 {"strpart", 2, 3, f_strpart},
7637 {"strridx", 2, 3, f_strridx},
7638 {"strtrans", 1, 1, f_strtrans},
7639 {"submatch", 1, 1, f_submatch},
7640 {"substitute", 4, 4, f_substitute},
7641 {"synID", 3, 3, f_synID},
7642 {"synIDattr", 2, 3, f_synIDattr},
7643 {"synIDtrans", 1, 1, f_synIDtrans},
7644 {"synstack", 2, 2, f_synstack},
7645 {"system", 1, 2, f_system},
7646 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7647 {"tabpagenr", 0, 1, f_tabpagenr},
7648 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7649 {"tagfiles", 0, 0, f_tagfiles},
7650 {"taglist", 1, 1, f_taglist},
7651 {"tempname", 0, 0, f_tempname},
7652 {"test", 1, 1, f_test},
7653 {"tolower", 1, 1, f_tolower},
7654 {"toupper", 1, 1, f_toupper},
7655 {"tr", 3, 3, f_tr},
7656 #ifdef FEAT_FLOAT
7657 {"trunc", 1, 1, f_trunc},
7658 #endif
7659 {"type", 1, 1, f_type},
7660 {"values", 1, 1, f_values},
7661 {"virtcol", 1, 1, f_virtcol},
7662 {"visualmode", 0, 1, f_visualmode},
7663 {"winbufnr", 1, 1, f_winbufnr},
7664 {"wincol", 0, 0, f_wincol},
7665 {"winheight", 1, 1, f_winheight},
7666 {"winline", 0, 0, f_winline},
7667 {"winnr", 0, 1, f_winnr},
7668 {"winrestcmd", 0, 0, f_winrestcmd},
7669 {"winrestview", 1, 1, f_winrestview},
7670 {"winsaveview", 0, 0, f_winsaveview},
7671 {"winwidth", 1, 1, f_winwidth},
7672 {"writefile", 2, 3, f_writefile},
7675 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7678 * Function given to ExpandGeneric() to obtain the list of internal
7679 * or user defined function names.
7681 char_u *
7682 get_function_name(xp, idx)
7683 expand_T *xp;
7684 int idx;
7686 static int intidx = -1;
7687 char_u *name;
7689 if (idx == 0)
7690 intidx = -1;
7691 if (intidx < 0)
7693 name = get_user_func_name(xp, idx);
7694 if (name != NULL)
7695 return name;
7697 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7699 STRCPY(IObuff, functions[intidx].f_name);
7700 STRCAT(IObuff, "(");
7701 if (functions[intidx].f_max_argc == 0)
7702 STRCAT(IObuff, ")");
7703 return IObuff;
7706 return NULL;
7710 * Function given to ExpandGeneric() to obtain the list of internal or
7711 * user defined variable or function names.
7713 /*ARGSUSED*/
7714 char_u *
7715 get_expr_name(xp, idx)
7716 expand_T *xp;
7717 int idx;
7719 static int intidx = -1;
7720 char_u *name;
7722 if (idx == 0)
7723 intidx = -1;
7724 if (intidx < 0)
7726 name = get_function_name(xp, idx);
7727 if (name != NULL)
7728 return name;
7730 return get_user_var_name(xp, ++intidx);
7733 #endif /* FEAT_CMDL_COMPL */
7736 * Find internal function in table above.
7737 * Return index, or -1 if not found
7739 static int
7740 find_internal_func(name)
7741 char_u *name; /* name of the function */
7743 int first = 0;
7744 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7745 int cmp;
7746 int x;
7749 * Find the function name in the table. Binary search.
7751 while (first <= last)
7753 x = first + ((unsigned)(last - first) >> 1);
7754 cmp = STRCMP(name, functions[x].f_name);
7755 if (cmp < 0)
7756 last = x - 1;
7757 else if (cmp > 0)
7758 first = x + 1;
7759 else
7760 return x;
7762 return -1;
7766 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7767 * name it contains, otherwise return "name".
7769 static char_u *
7770 deref_func_name(name, lenp)
7771 char_u *name;
7772 int *lenp;
7774 dictitem_T *v;
7775 int cc;
7777 cc = name[*lenp];
7778 name[*lenp] = NUL;
7779 v = find_var(name, NULL);
7780 name[*lenp] = cc;
7781 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7783 if (v->di_tv.vval.v_string == NULL)
7785 *lenp = 0;
7786 return (char_u *)""; /* just in case */
7788 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7789 return v->di_tv.vval.v_string;
7792 return name;
7796 * Allocate a variable for the result of a function.
7797 * Return OK or FAIL.
7799 static int
7800 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7801 evaluate, selfdict)
7802 char_u *name; /* name of the function */
7803 int len; /* length of "name" */
7804 typval_T *rettv;
7805 char_u **arg; /* argument, pointing to the '(' */
7806 linenr_T firstline; /* first line of range */
7807 linenr_T lastline; /* last line of range */
7808 int *doesrange; /* return: function handled range */
7809 int evaluate;
7810 dict_T *selfdict; /* Dictionary for "self" */
7812 char_u *argp;
7813 int ret = OK;
7814 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7815 int argcount = 0; /* number of arguments found */
7818 * Get the arguments.
7820 argp = *arg;
7821 while (argcount < MAX_FUNC_ARGS)
7823 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7824 if (*argp == ')' || *argp == ',' || *argp == NUL)
7825 break;
7826 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7828 ret = FAIL;
7829 break;
7831 ++argcount;
7832 if (*argp != ',')
7833 break;
7835 if (*argp == ')')
7836 ++argp;
7837 else
7838 ret = FAIL;
7840 if (ret == OK)
7841 ret = call_func(name, len, rettv, argcount, argvars,
7842 firstline, lastline, doesrange, evaluate, selfdict);
7843 else if (!aborting())
7845 if (argcount == MAX_FUNC_ARGS)
7846 emsg_funcname("E740: Too many arguments for function %s", name);
7847 else
7848 emsg_funcname("E116: Invalid arguments for function %s", name);
7851 while (--argcount >= 0)
7852 clear_tv(&argvars[argcount]);
7854 *arg = skipwhite(argp);
7855 return ret;
7860 * Call a function with its resolved parameters
7861 * Return OK when the function can't be called, FAIL otherwise.
7862 * Also returns OK when an error was encountered while executing the function.
7864 static int
7865 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7866 doesrange, evaluate, selfdict)
7867 char_u *name; /* name of the function */
7868 int len; /* length of "name" */
7869 typval_T *rettv; /* return value goes here */
7870 int argcount; /* number of "argvars" */
7871 typval_T *argvars; /* vars for arguments, must have "argcount"
7872 PLUS ONE elements! */
7873 linenr_T firstline; /* first line of range */
7874 linenr_T lastline; /* last line of range */
7875 int *doesrange; /* return: function handled range */
7876 int evaluate;
7877 dict_T *selfdict; /* Dictionary for "self" */
7879 int ret = FAIL;
7880 #define ERROR_UNKNOWN 0
7881 #define ERROR_TOOMANY 1
7882 #define ERROR_TOOFEW 2
7883 #define ERROR_SCRIPT 3
7884 #define ERROR_DICT 4
7885 #define ERROR_NONE 5
7886 #define ERROR_OTHER 6
7887 int error = ERROR_NONE;
7888 int i;
7889 int llen;
7890 ufunc_T *fp;
7891 int cc;
7892 #define FLEN_FIXED 40
7893 char_u fname_buf[FLEN_FIXED + 1];
7894 char_u *fname;
7897 * In a script change <SID>name() and s:name() to K_SNR 123_name().
7898 * Change <SNR>123_name() to K_SNR 123_name().
7899 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
7901 cc = name[len];
7902 name[len] = NUL;
7903 llen = eval_fname_script(name);
7904 if (llen > 0)
7906 fname_buf[0] = K_SPECIAL;
7907 fname_buf[1] = KS_EXTRA;
7908 fname_buf[2] = (int)KE_SNR;
7909 i = 3;
7910 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
7912 if (current_SID <= 0)
7913 error = ERROR_SCRIPT;
7914 else
7916 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
7917 i = (int)STRLEN(fname_buf);
7920 if (i + STRLEN(name + llen) < FLEN_FIXED)
7922 STRCPY(fname_buf + i, name + llen);
7923 fname = fname_buf;
7925 else
7927 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
7928 if (fname == NULL)
7929 error = ERROR_OTHER;
7930 else
7932 mch_memmove(fname, fname_buf, (size_t)i);
7933 STRCPY(fname + i, name + llen);
7937 else
7938 fname = name;
7940 *doesrange = FALSE;
7943 /* execute the function if no errors detected and executing */
7944 if (evaluate && error == ERROR_NONE)
7946 rettv->v_type = VAR_NUMBER; /* default is number rettv */
7947 error = ERROR_UNKNOWN;
7949 if (!builtin_function(fname))
7952 * User defined function.
7954 fp = find_func(fname);
7956 #ifdef FEAT_AUTOCMD
7957 /* Trigger FuncUndefined event, may load the function. */
7958 if (fp == NULL
7959 && apply_autocmds(EVENT_FUNCUNDEFINED,
7960 fname, fname, TRUE, NULL)
7961 && !aborting())
7963 /* executed an autocommand, search for the function again */
7964 fp = find_func(fname);
7966 #endif
7967 /* Try loading a package. */
7968 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
7970 /* loaded a package, search for the function again */
7971 fp = find_func(fname);
7974 if (fp != NULL)
7976 if (fp->uf_flags & FC_RANGE)
7977 *doesrange = TRUE;
7978 if (argcount < fp->uf_args.ga_len)
7979 error = ERROR_TOOFEW;
7980 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
7981 error = ERROR_TOOMANY;
7982 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
7983 error = ERROR_DICT;
7984 else
7987 * Call the user function.
7988 * Save and restore search patterns, script variables and
7989 * redo buffer.
7991 save_search_patterns();
7992 saveRedobuff();
7993 ++fp->uf_calls;
7994 call_user_func(fp, argcount, argvars, rettv,
7995 firstline, lastline,
7996 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
7997 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
7998 && fp->uf_refcount <= 0)
7999 /* Function was unreferenced while being used, free it
8000 * now. */
8001 func_free(fp);
8002 restoreRedobuff();
8003 restore_search_patterns();
8004 error = ERROR_NONE;
8008 else
8011 * Find the function name in the table, call its implementation.
8013 i = find_internal_func(fname);
8014 if (i >= 0)
8016 if (argcount < functions[i].f_min_argc)
8017 error = ERROR_TOOFEW;
8018 else if (argcount > functions[i].f_max_argc)
8019 error = ERROR_TOOMANY;
8020 else
8022 argvars[argcount].v_type = VAR_UNKNOWN;
8023 functions[i].f_func(argvars, rettv);
8024 error = ERROR_NONE;
8029 * The function call (or "FuncUndefined" autocommand sequence) might
8030 * have been aborted by an error, an interrupt, or an explicitly thrown
8031 * exception that has not been caught so far. This situation can be
8032 * tested for by calling aborting(). For an error in an internal
8033 * function or for the "E132" error in call_user_func(), however, the
8034 * throw point at which the "force_abort" flag (temporarily reset by
8035 * emsg()) is normally updated has not been reached yet. We need to
8036 * update that flag first to make aborting() reliable.
8038 update_force_abort();
8040 if (error == ERROR_NONE)
8041 ret = OK;
8044 * Report an error unless the argument evaluation or function call has been
8045 * cancelled due to an aborting error, an interrupt, or an exception.
8047 if (!aborting())
8049 switch (error)
8051 case ERROR_UNKNOWN:
8052 emsg_funcname(N_("E117: Unknown function: %s"), name);
8053 break;
8054 case ERROR_TOOMANY:
8055 emsg_funcname(e_toomanyarg, name);
8056 break;
8057 case ERROR_TOOFEW:
8058 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8059 name);
8060 break;
8061 case ERROR_SCRIPT:
8062 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8063 name);
8064 break;
8065 case ERROR_DICT:
8066 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8067 name);
8068 break;
8072 name[len] = cc;
8073 if (fname != name && fname != fname_buf)
8074 vim_free(fname);
8076 return ret;
8080 * Give an error message with a function name. Handle <SNR> things.
8082 static void
8083 emsg_funcname(ermsg, name)
8084 char *ermsg;
8085 char_u *name;
8087 char_u *p;
8089 if (*name == K_SPECIAL)
8090 p = concat_str((char_u *)"<SNR>", name + 3);
8091 else
8092 p = name;
8093 EMSG2(_(ermsg), p);
8094 if (p != name)
8095 vim_free(p);
8099 * Return TRUE for a non-zero Number and a non-empty String.
8101 static int
8102 non_zero_arg(argvars)
8103 typval_T *argvars;
8105 return ((argvars[0].v_type == VAR_NUMBER
8106 && argvars[0].vval.v_number != 0)
8107 || (argvars[0].v_type == VAR_STRING
8108 && argvars[0].vval.v_string != NULL
8109 && *argvars[0].vval.v_string != NUL));
8112 /*********************************************
8113 * Implementation of the built-in functions
8116 #ifdef FEAT_FLOAT
8118 * "abs(expr)" function
8120 static void
8121 f_abs(argvars, rettv)
8122 typval_T *argvars;
8123 typval_T *rettv;
8125 if (argvars[0].v_type == VAR_FLOAT)
8127 rettv->v_type = VAR_FLOAT;
8128 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8130 else
8132 varnumber_T n;
8133 int error = FALSE;
8135 n = get_tv_number_chk(&argvars[0], &error);
8136 if (error)
8137 rettv->vval.v_number = -1;
8138 else if (n > 0)
8139 rettv->vval.v_number = n;
8140 else
8141 rettv->vval.v_number = -n;
8144 #endif
8147 * "add(list, item)" function
8149 static void
8150 f_add(argvars, rettv)
8151 typval_T *argvars;
8152 typval_T *rettv;
8154 list_T *l;
8156 rettv->vval.v_number = 1; /* Default: Failed */
8157 if (argvars[0].v_type == VAR_LIST)
8159 if ((l = argvars[0].vval.v_list) != NULL
8160 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8161 && list_append_tv(l, &argvars[1]) == OK)
8162 copy_tv(&argvars[0], rettv);
8164 else
8165 EMSG(_(e_listreq));
8169 * "append(lnum, string/list)" function
8171 static void
8172 f_append(argvars, rettv)
8173 typval_T *argvars;
8174 typval_T *rettv;
8176 long lnum;
8177 char_u *line;
8178 list_T *l = NULL;
8179 listitem_T *li = NULL;
8180 typval_T *tv;
8181 long added = 0;
8183 lnum = get_tv_lnum(argvars);
8184 if (lnum >= 0
8185 && lnum <= curbuf->b_ml.ml_line_count
8186 && u_save(lnum, lnum + 1) == OK)
8188 if (argvars[1].v_type == VAR_LIST)
8190 l = argvars[1].vval.v_list;
8191 if (l == NULL)
8192 return;
8193 li = l->lv_first;
8195 rettv->vval.v_number = 0; /* Default: Success */
8196 for (;;)
8198 if (l == NULL)
8199 tv = &argvars[1]; /* append a string */
8200 else if (li == NULL)
8201 break; /* end of list */
8202 else
8203 tv = &li->li_tv; /* append item from list */
8204 line = get_tv_string_chk(tv);
8205 if (line == NULL) /* type error */
8207 rettv->vval.v_number = 1; /* Failed */
8208 break;
8210 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8211 ++added;
8212 if (l == NULL)
8213 break;
8214 li = li->li_next;
8217 appended_lines_mark(lnum, added);
8218 if (curwin->w_cursor.lnum > lnum)
8219 curwin->w_cursor.lnum += added;
8221 else
8222 rettv->vval.v_number = 1; /* Failed */
8226 * "argc()" function
8228 /* ARGSUSED */
8229 static void
8230 f_argc(argvars, rettv)
8231 typval_T *argvars;
8232 typval_T *rettv;
8234 rettv->vval.v_number = ARGCOUNT;
8238 * "argidx()" function
8240 /* ARGSUSED */
8241 static void
8242 f_argidx(argvars, rettv)
8243 typval_T *argvars;
8244 typval_T *rettv;
8246 rettv->vval.v_number = curwin->w_arg_idx;
8250 * "argv(nr)" function
8252 static void
8253 f_argv(argvars, rettv)
8254 typval_T *argvars;
8255 typval_T *rettv;
8257 int idx;
8259 if (argvars[0].v_type != VAR_UNKNOWN)
8261 idx = get_tv_number_chk(&argvars[0], NULL);
8262 if (idx >= 0 && idx < ARGCOUNT)
8263 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8264 else
8265 rettv->vval.v_string = NULL;
8266 rettv->v_type = VAR_STRING;
8268 else if (rettv_list_alloc(rettv) == OK)
8269 for (idx = 0; idx < ARGCOUNT; ++idx)
8270 list_append_string(rettv->vval.v_list,
8271 alist_name(&ARGLIST[idx]), -1);
8274 #ifdef FEAT_FLOAT
8275 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8278 * Get the float value of "argvars[0]" into "f".
8279 * Returns FAIL when the argument is not a Number or Float.
8281 static int
8282 get_float_arg(argvars, f)
8283 typval_T *argvars;
8284 float_T *f;
8286 if (argvars[0].v_type == VAR_FLOAT)
8288 *f = argvars[0].vval.v_float;
8289 return OK;
8291 if (argvars[0].v_type == VAR_NUMBER)
8293 *f = (float_T)argvars[0].vval.v_number;
8294 return OK;
8296 EMSG(_("E808: Number or Float required"));
8297 return FAIL;
8301 * "atan()" function
8303 static void
8304 f_atan(argvars, rettv)
8305 typval_T *argvars;
8306 typval_T *rettv;
8308 float_T f;
8310 rettv->v_type = VAR_FLOAT;
8311 if (get_float_arg(argvars, &f) == OK)
8312 rettv->vval.v_float = atan(f);
8313 else
8314 rettv->vval.v_float = 0.0;
8316 #endif
8319 * "browse(save, title, initdir, default)" function
8321 /* ARGSUSED */
8322 static void
8323 f_browse(argvars, rettv)
8324 typval_T *argvars;
8325 typval_T *rettv;
8327 #ifdef FEAT_BROWSE
8328 int save;
8329 char_u *title;
8330 char_u *initdir;
8331 char_u *defname;
8332 char_u buf[NUMBUFLEN];
8333 char_u buf2[NUMBUFLEN];
8334 int error = FALSE;
8336 save = get_tv_number_chk(&argvars[0], &error);
8337 title = get_tv_string_chk(&argvars[1]);
8338 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8339 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8341 if (error || title == NULL || initdir == NULL || defname == NULL)
8342 rettv->vval.v_string = NULL;
8343 else
8344 rettv->vval.v_string =
8345 do_browse(save ? BROWSE_SAVE : 0,
8346 title, defname, NULL, initdir, NULL, curbuf);
8347 #else
8348 rettv->vval.v_string = NULL;
8349 #endif
8350 rettv->v_type = VAR_STRING;
8354 * "browsedir(title, initdir)" function
8356 /* ARGSUSED */
8357 static void
8358 f_browsedir(argvars, rettv)
8359 typval_T *argvars;
8360 typval_T *rettv;
8362 #ifdef FEAT_BROWSE
8363 char_u *title;
8364 char_u *initdir;
8365 char_u buf[NUMBUFLEN];
8367 title = get_tv_string_chk(&argvars[0]);
8368 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8370 if (title == NULL || initdir == NULL)
8371 rettv->vval.v_string = NULL;
8372 else
8373 rettv->vval.v_string = do_browse(BROWSE_DIR,
8374 title, NULL, NULL, initdir, NULL, curbuf);
8375 #else
8376 rettv->vval.v_string = NULL;
8377 #endif
8378 rettv->v_type = VAR_STRING;
8381 static buf_T *find_buffer __ARGS((typval_T *avar));
8384 * Find a buffer by number or exact name.
8386 static buf_T *
8387 find_buffer(avar)
8388 typval_T *avar;
8390 buf_T *buf = NULL;
8392 if (avar->v_type == VAR_NUMBER)
8393 buf = buflist_findnr((int)avar->vval.v_number);
8394 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8396 buf = buflist_findname_exp(avar->vval.v_string);
8397 if (buf == NULL)
8399 /* No full path name match, try a match with a URL or a "nofile"
8400 * buffer, these don't use the full path. */
8401 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8402 if (buf->b_fname != NULL
8403 && (path_with_url(buf->b_fname)
8404 #ifdef FEAT_QUICKFIX
8405 || bt_nofile(buf)
8406 #endif
8408 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8409 break;
8412 return buf;
8416 * "bufexists(expr)" function
8418 static void
8419 f_bufexists(argvars, rettv)
8420 typval_T *argvars;
8421 typval_T *rettv;
8423 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8427 * "buflisted(expr)" function
8429 static void
8430 f_buflisted(argvars, rettv)
8431 typval_T *argvars;
8432 typval_T *rettv;
8434 buf_T *buf;
8436 buf = find_buffer(&argvars[0]);
8437 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8441 * "bufloaded(expr)" function
8443 static void
8444 f_bufloaded(argvars, rettv)
8445 typval_T *argvars;
8446 typval_T *rettv;
8448 buf_T *buf;
8450 buf = find_buffer(&argvars[0]);
8451 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8454 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8457 * Get buffer by number or pattern.
8459 static buf_T *
8460 get_buf_tv(tv)
8461 typval_T *tv;
8463 char_u *name = tv->vval.v_string;
8464 int save_magic;
8465 char_u *save_cpo;
8466 buf_T *buf;
8468 if (tv->v_type == VAR_NUMBER)
8469 return buflist_findnr((int)tv->vval.v_number);
8470 if (tv->v_type != VAR_STRING)
8471 return NULL;
8472 if (name == NULL || *name == NUL)
8473 return curbuf;
8474 if (name[0] == '$' && name[1] == NUL)
8475 return lastbuf;
8477 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8478 save_magic = p_magic;
8479 p_magic = TRUE;
8480 save_cpo = p_cpo;
8481 p_cpo = (char_u *)"";
8483 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8484 TRUE, FALSE));
8486 p_magic = save_magic;
8487 p_cpo = save_cpo;
8489 /* If not found, try expanding the name, like done for bufexists(). */
8490 if (buf == NULL)
8491 buf = find_buffer(tv);
8493 return buf;
8497 * "bufname(expr)" function
8499 static void
8500 f_bufname(argvars, rettv)
8501 typval_T *argvars;
8502 typval_T *rettv;
8504 buf_T *buf;
8506 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8507 ++emsg_off;
8508 buf = get_buf_tv(&argvars[0]);
8509 rettv->v_type = VAR_STRING;
8510 if (buf != NULL && buf->b_fname != NULL)
8511 rettv->vval.v_string = vim_strsave(buf->b_fname);
8512 else
8513 rettv->vval.v_string = NULL;
8514 --emsg_off;
8518 * "bufnr(expr)" function
8520 static void
8521 f_bufnr(argvars, rettv)
8522 typval_T *argvars;
8523 typval_T *rettv;
8525 buf_T *buf;
8526 int error = FALSE;
8527 char_u *name;
8529 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8530 ++emsg_off;
8531 buf = get_buf_tv(&argvars[0]);
8532 --emsg_off;
8534 /* If the buffer isn't found and the second argument is not zero create a
8535 * new buffer. */
8536 if (buf == NULL
8537 && argvars[1].v_type != VAR_UNKNOWN
8538 && get_tv_number_chk(&argvars[1], &error) != 0
8539 && !error
8540 && (name = get_tv_string_chk(&argvars[0])) != NULL
8541 && !error)
8542 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8544 if (buf != NULL)
8545 rettv->vval.v_number = buf->b_fnum;
8546 else
8547 rettv->vval.v_number = -1;
8551 * "bufwinnr(nr)" function
8553 static void
8554 f_bufwinnr(argvars, rettv)
8555 typval_T *argvars;
8556 typval_T *rettv;
8558 #ifdef FEAT_WINDOWS
8559 win_T *wp;
8560 int winnr = 0;
8561 #endif
8562 buf_T *buf;
8564 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8565 ++emsg_off;
8566 buf = get_buf_tv(&argvars[0]);
8567 #ifdef FEAT_WINDOWS
8568 for (wp = firstwin; wp; wp = wp->w_next)
8570 ++winnr;
8571 if (wp->w_buffer == buf)
8572 break;
8574 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8575 #else
8576 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8577 #endif
8578 --emsg_off;
8582 * "byte2line(byte)" function
8584 /*ARGSUSED*/
8585 static void
8586 f_byte2line(argvars, rettv)
8587 typval_T *argvars;
8588 typval_T *rettv;
8590 #ifndef FEAT_BYTEOFF
8591 rettv->vval.v_number = -1;
8592 #else
8593 long boff = 0;
8595 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8596 if (boff < 0)
8597 rettv->vval.v_number = -1;
8598 else
8599 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8600 (linenr_T)0, &boff);
8601 #endif
8605 * "byteidx()" function
8607 /*ARGSUSED*/
8608 static void
8609 f_byteidx(argvars, rettv)
8610 typval_T *argvars;
8611 typval_T *rettv;
8613 #ifdef FEAT_MBYTE
8614 char_u *t;
8615 #endif
8616 char_u *str;
8617 long idx;
8619 str = get_tv_string_chk(&argvars[0]);
8620 idx = get_tv_number_chk(&argvars[1], NULL);
8621 rettv->vval.v_number = -1;
8622 if (str == NULL || idx < 0)
8623 return;
8625 #ifdef FEAT_MBYTE
8626 t = str;
8627 for ( ; idx > 0; idx--)
8629 if (*t == NUL) /* EOL reached */
8630 return;
8631 t += (*mb_ptr2len)(t);
8633 rettv->vval.v_number = (varnumber_T)(t - str);
8634 #else
8635 if ((size_t)idx <= STRLEN(str))
8636 rettv->vval.v_number = idx;
8637 #endif
8641 * "call(func, arglist)" function
8643 static void
8644 f_call(argvars, rettv)
8645 typval_T *argvars;
8646 typval_T *rettv;
8648 char_u *func;
8649 typval_T argv[MAX_FUNC_ARGS + 1];
8650 int argc = 0;
8651 listitem_T *item;
8652 int dummy;
8653 dict_T *selfdict = NULL;
8655 rettv->vval.v_number = 0;
8656 if (argvars[1].v_type != VAR_LIST)
8658 EMSG(_(e_listreq));
8659 return;
8661 if (argvars[1].vval.v_list == NULL)
8662 return;
8664 if (argvars[0].v_type == VAR_FUNC)
8665 func = argvars[0].vval.v_string;
8666 else
8667 func = get_tv_string(&argvars[0]);
8668 if (*func == NUL)
8669 return; /* type error or empty name */
8671 if (argvars[2].v_type != VAR_UNKNOWN)
8673 if (argvars[2].v_type != VAR_DICT)
8675 EMSG(_(e_dictreq));
8676 return;
8678 selfdict = argvars[2].vval.v_dict;
8681 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8682 item = item->li_next)
8684 if (argc == MAX_FUNC_ARGS)
8686 EMSG(_("E699: Too many arguments"));
8687 break;
8689 /* Make a copy of each argument. This is needed to be able to set
8690 * v_lock to VAR_FIXED in the copy without changing the original list.
8692 copy_tv(&item->li_tv, &argv[argc++]);
8695 if (item == NULL)
8696 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8697 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8698 &dummy, TRUE, selfdict);
8700 /* Free the arguments. */
8701 while (argc > 0)
8702 clear_tv(&argv[--argc]);
8705 #ifdef FEAT_FLOAT
8707 * "ceil({float})" function
8709 static void
8710 f_ceil(argvars, rettv)
8711 typval_T *argvars;
8712 typval_T *rettv;
8714 float_T f;
8716 rettv->v_type = VAR_FLOAT;
8717 if (get_float_arg(argvars, &f) == OK)
8718 rettv->vval.v_float = ceil(f);
8719 else
8720 rettv->vval.v_float = 0.0;
8722 #endif
8725 * "changenr()" function
8727 /*ARGSUSED*/
8728 static void
8729 f_changenr(argvars, rettv)
8730 typval_T *argvars;
8731 typval_T *rettv;
8733 rettv->vval.v_number = curbuf->b_u_seq_cur;
8737 * "char2nr(string)" function
8739 static void
8740 f_char2nr(argvars, rettv)
8741 typval_T *argvars;
8742 typval_T *rettv;
8744 #ifdef FEAT_MBYTE
8745 if (has_mbyte)
8746 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8747 else
8748 #endif
8749 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8753 * "cindent(lnum)" function
8755 static void
8756 f_cindent(argvars, rettv)
8757 typval_T *argvars;
8758 typval_T *rettv;
8760 #ifdef FEAT_CINDENT
8761 pos_T pos;
8762 linenr_T lnum;
8764 pos = curwin->w_cursor;
8765 lnum = get_tv_lnum(argvars);
8766 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8768 curwin->w_cursor.lnum = lnum;
8769 rettv->vval.v_number = get_c_indent();
8770 curwin->w_cursor = pos;
8772 else
8773 #endif
8774 rettv->vval.v_number = -1;
8778 * "clearmatches()" function
8780 /*ARGSUSED*/
8781 static void
8782 f_clearmatches(argvars, rettv)
8783 typval_T *argvars;
8784 typval_T *rettv;
8786 #ifdef FEAT_SEARCH_EXTRA
8787 clear_matches(curwin);
8788 #endif
8792 * "col(string)" function
8794 static void
8795 f_col(argvars, rettv)
8796 typval_T *argvars;
8797 typval_T *rettv;
8799 colnr_T col = 0;
8800 pos_T *fp;
8801 int fnum = curbuf->b_fnum;
8803 fp = var2fpos(&argvars[0], FALSE, &fnum);
8804 if (fp != NULL && fnum == curbuf->b_fnum)
8806 if (fp->col == MAXCOL)
8808 /* '> can be MAXCOL, get the length of the line then */
8809 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8810 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8811 else
8812 col = MAXCOL;
8814 else
8816 col = fp->col + 1;
8817 #ifdef FEAT_VIRTUALEDIT
8818 /* col(".") when the cursor is on the NUL at the end of the line
8819 * because of "coladd" can be seen as an extra column. */
8820 if (virtual_active() && fp == &curwin->w_cursor)
8822 char_u *p = ml_get_cursor();
8824 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8825 curwin->w_virtcol - curwin->w_cursor.coladd))
8827 # ifdef FEAT_MBYTE
8828 int l;
8830 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8831 col += l;
8832 # else
8833 if (*p != NUL && p[1] == NUL)
8834 ++col;
8835 # endif
8838 #endif
8841 rettv->vval.v_number = col;
8844 #if defined(FEAT_INS_EXPAND)
8846 * "complete()" function
8848 /*ARGSUSED*/
8849 static void
8850 f_complete(argvars, rettv)
8851 typval_T *argvars;
8852 typval_T *rettv;
8854 int startcol;
8856 if ((State & INSERT) == 0)
8858 EMSG(_("E785: complete() can only be used in Insert mode"));
8859 return;
8862 /* Check for undo allowed here, because if something was already inserted
8863 * the line was already saved for undo and this check isn't done. */
8864 if (!undo_allowed())
8865 return;
8867 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8869 EMSG(_(e_invarg));
8870 return;
8873 startcol = get_tv_number_chk(&argvars[0], NULL);
8874 if (startcol <= 0)
8875 return;
8877 set_completion(startcol - 1, argvars[1].vval.v_list);
8881 * "complete_add()" function
8883 /*ARGSUSED*/
8884 static void
8885 f_complete_add(argvars, rettv)
8886 typval_T *argvars;
8887 typval_T *rettv;
8889 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
8893 * "complete_check()" function
8895 /*ARGSUSED*/
8896 static void
8897 f_complete_check(argvars, rettv)
8898 typval_T *argvars;
8899 typval_T *rettv;
8901 int saved = RedrawingDisabled;
8903 RedrawingDisabled = 0;
8904 ins_compl_check_keys(0);
8905 rettv->vval.v_number = compl_interrupted;
8906 RedrawingDisabled = saved;
8908 #endif
8911 * "confirm(message, buttons[, default [, type]])" function
8913 /*ARGSUSED*/
8914 static void
8915 f_confirm(argvars, rettv)
8916 typval_T *argvars;
8917 typval_T *rettv;
8919 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
8920 char_u *message;
8921 char_u *buttons = NULL;
8922 char_u buf[NUMBUFLEN];
8923 char_u buf2[NUMBUFLEN];
8924 int def = 1;
8925 int type = VIM_GENERIC;
8926 char_u *typestr;
8927 int error = FALSE;
8929 message = get_tv_string_chk(&argvars[0]);
8930 if (message == NULL)
8931 error = TRUE;
8932 if (argvars[1].v_type != VAR_UNKNOWN)
8934 buttons = get_tv_string_buf_chk(&argvars[1], buf);
8935 if (buttons == NULL)
8936 error = TRUE;
8937 if (argvars[2].v_type != VAR_UNKNOWN)
8939 def = get_tv_number_chk(&argvars[2], &error);
8940 if (argvars[3].v_type != VAR_UNKNOWN)
8942 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
8943 if (typestr == NULL)
8944 error = TRUE;
8945 else
8947 switch (TOUPPER_ASC(*typestr))
8949 case 'E': type = VIM_ERROR; break;
8950 case 'Q': type = VIM_QUESTION; break;
8951 case 'I': type = VIM_INFO; break;
8952 case 'W': type = VIM_WARNING; break;
8953 case 'G': type = VIM_GENERIC; break;
8960 if (buttons == NULL || *buttons == NUL)
8961 buttons = (char_u *)_("&Ok");
8963 if (error)
8964 rettv->vval.v_number = 0;
8965 else
8966 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
8967 def, NULL);
8968 #else
8969 rettv->vval.v_number = 0;
8970 #endif
8974 * "copy()" function
8976 static void
8977 f_copy(argvars, rettv)
8978 typval_T *argvars;
8979 typval_T *rettv;
8981 item_copy(&argvars[0], rettv, FALSE, 0);
8984 #ifdef FEAT_FLOAT
8986 * "cos()" function
8988 static void
8989 f_cos(argvars, rettv)
8990 typval_T *argvars;
8991 typval_T *rettv;
8993 float_T f;
8995 rettv->v_type = VAR_FLOAT;
8996 if (get_float_arg(argvars, &f) == OK)
8997 rettv->vval.v_float = cos(f);
8998 else
8999 rettv->vval.v_float = 0.0;
9001 #endif
9004 * "count()" function
9006 static void
9007 f_count(argvars, rettv)
9008 typval_T *argvars;
9009 typval_T *rettv;
9011 long n = 0;
9012 int ic = FALSE;
9014 if (argvars[0].v_type == VAR_LIST)
9016 listitem_T *li;
9017 list_T *l;
9018 long idx;
9020 if ((l = argvars[0].vval.v_list) != NULL)
9022 li = l->lv_first;
9023 if (argvars[2].v_type != VAR_UNKNOWN)
9025 int error = FALSE;
9027 ic = get_tv_number_chk(&argvars[2], &error);
9028 if (argvars[3].v_type != VAR_UNKNOWN)
9030 idx = get_tv_number_chk(&argvars[3], &error);
9031 if (!error)
9033 li = list_find(l, idx);
9034 if (li == NULL)
9035 EMSGN(_(e_listidx), idx);
9038 if (error)
9039 li = NULL;
9042 for ( ; li != NULL; li = li->li_next)
9043 if (tv_equal(&li->li_tv, &argvars[1], ic))
9044 ++n;
9047 else if (argvars[0].v_type == VAR_DICT)
9049 int todo;
9050 dict_T *d;
9051 hashitem_T *hi;
9053 if ((d = argvars[0].vval.v_dict) != NULL)
9055 int error = FALSE;
9057 if (argvars[2].v_type != VAR_UNKNOWN)
9059 ic = get_tv_number_chk(&argvars[2], &error);
9060 if (argvars[3].v_type != VAR_UNKNOWN)
9061 EMSG(_(e_invarg));
9064 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9065 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9067 if (!HASHITEM_EMPTY(hi))
9069 --todo;
9070 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9071 ++n;
9076 else
9077 EMSG2(_(e_listdictarg), "count()");
9078 rettv->vval.v_number = n;
9082 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9084 * Checks the existence of a cscope connection.
9086 /*ARGSUSED*/
9087 static void
9088 f_cscope_connection(argvars, rettv)
9089 typval_T *argvars;
9090 typval_T *rettv;
9092 #ifdef FEAT_CSCOPE
9093 int num = 0;
9094 char_u *dbpath = NULL;
9095 char_u *prepend = NULL;
9096 char_u buf[NUMBUFLEN];
9098 if (argvars[0].v_type != VAR_UNKNOWN
9099 && argvars[1].v_type != VAR_UNKNOWN)
9101 num = (int)get_tv_number(&argvars[0]);
9102 dbpath = get_tv_string(&argvars[1]);
9103 if (argvars[2].v_type != VAR_UNKNOWN)
9104 prepend = get_tv_string_buf(&argvars[2], buf);
9107 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9108 #else
9109 rettv->vval.v_number = 0;
9110 #endif
9114 * "cursor(lnum, col)" function
9116 * Moves the cursor to the specified line and column
9118 /*ARGSUSED*/
9119 static void
9120 f_cursor(argvars, rettv)
9121 typval_T *argvars;
9122 typval_T *rettv;
9124 long line, col;
9125 #ifdef FEAT_VIRTUALEDIT
9126 long coladd = 0;
9127 #endif
9129 if (argvars[1].v_type == VAR_UNKNOWN)
9131 pos_T pos;
9133 if (list2fpos(argvars, &pos, NULL) == FAIL)
9134 return;
9135 line = pos.lnum;
9136 col = pos.col;
9137 #ifdef FEAT_VIRTUALEDIT
9138 coladd = pos.coladd;
9139 #endif
9141 else
9143 line = get_tv_lnum(argvars);
9144 col = get_tv_number_chk(&argvars[1], NULL);
9145 #ifdef FEAT_VIRTUALEDIT
9146 if (argvars[2].v_type != VAR_UNKNOWN)
9147 coladd = get_tv_number_chk(&argvars[2], NULL);
9148 #endif
9150 if (line < 0 || col < 0
9151 #ifdef FEAT_VIRTUALEDIT
9152 || coladd < 0
9153 #endif
9155 return; /* type error; errmsg already given */
9156 if (line > 0)
9157 curwin->w_cursor.lnum = line;
9158 if (col > 0)
9159 curwin->w_cursor.col = col - 1;
9160 #ifdef FEAT_VIRTUALEDIT
9161 curwin->w_cursor.coladd = coladd;
9162 #endif
9164 /* Make sure the cursor is in a valid position. */
9165 check_cursor();
9166 #ifdef FEAT_MBYTE
9167 /* Correct cursor for multi-byte character. */
9168 if (has_mbyte)
9169 mb_adjust_cursor();
9170 #endif
9172 curwin->w_set_curswant = TRUE;
9176 * "deepcopy()" function
9178 static void
9179 f_deepcopy(argvars, rettv)
9180 typval_T *argvars;
9181 typval_T *rettv;
9183 int noref = 0;
9185 if (argvars[1].v_type != VAR_UNKNOWN)
9186 noref = get_tv_number_chk(&argvars[1], NULL);
9187 if (noref < 0 || noref > 1)
9188 EMSG(_(e_invarg));
9189 else
9190 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? ++current_copyID : 0);
9194 * "delete()" function
9196 static void
9197 f_delete(argvars, rettv)
9198 typval_T *argvars;
9199 typval_T *rettv;
9201 if (check_restricted() || check_secure())
9202 rettv->vval.v_number = -1;
9203 else
9204 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9208 * "did_filetype()" function
9210 /*ARGSUSED*/
9211 static void
9212 f_did_filetype(argvars, rettv)
9213 typval_T *argvars;
9214 typval_T *rettv;
9216 #ifdef FEAT_AUTOCMD
9217 rettv->vval.v_number = did_filetype;
9218 #else
9219 rettv->vval.v_number = 0;
9220 #endif
9224 * "diff_filler()" function
9226 /*ARGSUSED*/
9227 static void
9228 f_diff_filler(argvars, rettv)
9229 typval_T *argvars;
9230 typval_T *rettv;
9232 #ifdef FEAT_DIFF
9233 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9234 #endif
9238 * "diff_hlID()" function
9240 /*ARGSUSED*/
9241 static void
9242 f_diff_hlID(argvars, rettv)
9243 typval_T *argvars;
9244 typval_T *rettv;
9246 #ifdef FEAT_DIFF
9247 linenr_T lnum = get_tv_lnum(argvars);
9248 static linenr_T prev_lnum = 0;
9249 static int changedtick = 0;
9250 static int fnum = 0;
9251 static int change_start = 0;
9252 static int change_end = 0;
9253 static hlf_T hlID = (hlf_T)0;
9254 int filler_lines;
9255 int col;
9257 if (lnum < 0) /* ignore type error in {lnum} arg */
9258 lnum = 0;
9259 if (lnum != prev_lnum
9260 || changedtick != curbuf->b_changedtick
9261 || fnum != curbuf->b_fnum)
9263 /* New line, buffer, change: need to get the values. */
9264 filler_lines = diff_check(curwin, lnum);
9265 if (filler_lines < 0)
9267 if (filler_lines == -1)
9269 change_start = MAXCOL;
9270 change_end = -1;
9271 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9272 hlID = HLF_ADD; /* added line */
9273 else
9274 hlID = HLF_CHD; /* changed line */
9276 else
9277 hlID = HLF_ADD; /* added line */
9279 else
9280 hlID = (hlf_T)0;
9281 prev_lnum = lnum;
9282 changedtick = curbuf->b_changedtick;
9283 fnum = curbuf->b_fnum;
9286 if (hlID == HLF_CHD || hlID == HLF_TXD)
9288 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9289 if (col >= change_start && col <= change_end)
9290 hlID = HLF_TXD; /* changed text */
9291 else
9292 hlID = HLF_CHD; /* changed line */
9294 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9295 #endif
9299 * "empty({expr})" function
9301 static void
9302 f_empty(argvars, rettv)
9303 typval_T *argvars;
9304 typval_T *rettv;
9306 int n;
9308 switch (argvars[0].v_type)
9310 case VAR_STRING:
9311 case VAR_FUNC:
9312 n = argvars[0].vval.v_string == NULL
9313 || *argvars[0].vval.v_string == NUL;
9314 break;
9315 case VAR_NUMBER:
9316 n = argvars[0].vval.v_number == 0;
9317 break;
9318 #ifdef FEAT_FLOAT
9319 case VAR_FLOAT:
9320 n = argvars[0].vval.v_float == 0.0;
9321 break;
9322 #endif
9323 case VAR_LIST:
9324 n = argvars[0].vval.v_list == NULL
9325 || argvars[0].vval.v_list->lv_first == NULL;
9326 break;
9327 case VAR_DICT:
9328 n = argvars[0].vval.v_dict == NULL
9329 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9330 break;
9331 default:
9332 EMSG2(_(e_intern2), "f_empty()");
9333 n = 0;
9336 rettv->vval.v_number = n;
9340 * "escape({string}, {chars})" function
9342 static void
9343 f_escape(argvars, rettv)
9344 typval_T *argvars;
9345 typval_T *rettv;
9347 char_u buf[NUMBUFLEN];
9349 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9350 get_tv_string_buf(&argvars[1], buf));
9351 rettv->v_type = VAR_STRING;
9355 * "eval()" function
9357 /*ARGSUSED*/
9358 static void
9359 f_eval(argvars, rettv)
9360 typval_T *argvars;
9361 typval_T *rettv;
9363 char_u *s;
9365 s = get_tv_string_chk(&argvars[0]);
9366 if (s != NULL)
9367 s = skipwhite(s);
9369 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9371 rettv->v_type = VAR_NUMBER;
9372 rettv->vval.v_number = 0;
9374 else if (*s != NUL)
9375 EMSG(_(e_trailing));
9379 * "eventhandler()" function
9381 /*ARGSUSED*/
9382 static void
9383 f_eventhandler(argvars, rettv)
9384 typval_T *argvars;
9385 typval_T *rettv;
9387 rettv->vval.v_number = vgetc_busy;
9391 * "executable()" function
9393 static void
9394 f_executable(argvars, rettv)
9395 typval_T *argvars;
9396 typval_T *rettv;
9398 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9402 * "exists()" function
9404 static void
9405 f_exists(argvars, rettv)
9406 typval_T *argvars;
9407 typval_T *rettv;
9409 char_u *p;
9410 char_u *name;
9411 int n = FALSE;
9412 int len = 0;
9414 p = get_tv_string(&argvars[0]);
9415 if (*p == '$') /* environment variable */
9417 /* first try "normal" environment variables (fast) */
9418 if (mch_getenv(p + 1) != NULL)
9419 n = TRUE;
9420 else
9422 /* try expanding things like $VIM and ${HOME} */
9423 p = expand_env_save(p);
9424 if (p != NULL && *p != '$')
9425 n = TRUE;
9426 vim_free(p);
9429 else if (*p == '&' || *p == '+') /* option */
9431 n = (get_option_tv(&p, NULL, TRUE) == OK);
9432 if (*skipwhite(p) != NUL)
9433 n = FALSE; /* trailing garbage */
9435 else if (*p == '*') /* internal or user defined function */
9437 n = function_exists(p + 1);
9439 else if (*p == ':')
9441 n = cmd_exists(p + 1);
9443 else if (*p == '#')
9445 #ifdef FEAT_AUTOCMD
9446 if (p[1] == '#')
9447 n = autocmd_supported(p + 2);
9448 else
9449 n = au_exists(p + 1);
9450 #endif
9452 else /* internal variable */
9454 char_u *tofree;
9455 typval_T tv;
9457 /* get_name_len() takes care of expanding curly braces */
9458 name = p;
9459 len = get_name_len(&p, &tofree, TRUE, FALSE);
9460 if (len > 0)
9462 if (tofree != NULL)
9463 name = tofree;
9464 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9465 if (n)
9467 /* handle d.key, l[idx], f(expr) */
9468 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9469 if (n)
9470 clear_tv(&tv);
9473 if (*p != NUL)
9474 n = FALSE;
9476 vim_free(tofree);
9479 rettv->vval.v_number = n;
9483 * "expand()" function
9485 static void
9486 f_expand(argvars, rettv)
9487 typval_T *argvars;
9488 typval_T *rettv;
9490 char_u *s;
9491 int len;
9492 char_u *errormsg;
9493 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9494 expand_T xpc;
9495 int error = FALSE;
9497 rettv->v_type = VAR_STRING;
9498 s = get_tv_string(&argvars[0]);
9499 if (*s == '%' || *s == '#' || *s == '<')
9501 ++emsg_off;
9502 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9503 --emsg_off;
9505 else
9507 /* When the optional second argument is non-zero, don't remove matches
9508 * for 'suffixes' and 'wildignore' */
9509 if (argvars[1].v_type != VAR_UNKNOWN
9510 && get_tv_number_chk(&argvars[1], &error))
9511 flags |= WILD_KEEP_ALL;
9512 if (!error)
9514 ExpandInit(&xpc);
9515 xpc.xp_context = EXPAND_FILES;
9516 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9518 else
9519 rettv->vval.v_string = NULL;
9524 * "extend(list, list [, idx])" function
9525 * "extend(dict, dict [, action])" function
9527 static void
9528 f_extend(argvars, rettv)
9529 typval_T *argvars;
9530 typval_T *rettv;
9532 rettv->vval.v_number = 0;
9533 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9535 list_T *l1, *l2;
9536 listitem_T *item;
9537 long before;
9538 int error = FALSE;
9540 l1 = argvars[0].vval.v_list;
9541 l2 = argvars[1].vval.v_list;
9542 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9543 && l2 != NULL)
9545 if (argvars[2].v_type != VAR_UNKNOWN)
9547 before = get_tv_number_chk(&argvars[2], &error);
9548 if (error)
9549 return; /* type error; errmsg already given */
9551 if (before == l1->lv_len)
9552 item = NULL;
9553 else
9555 item = list_find(l1, before);
9556 if (item == NULL)
9558 EMSGN(_(e_listidx), before);
9559 return;
9563 else
9564 item = NULL;
9565 list_extend(l1, l2, item);
9567 copy_tv(&argvars[0], rettv);
9570 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9572 dict_T *d1, *d2;
9573 dictitem_T *di1;
9574 char_u *action;
9575 int i;
9576 hashitem_T *hi2;
9577 int todo;
9579 d1 = argvars[0].vval.v_dict;
9580 d2 = argvars[1].vval.v_dict;
9581 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9582 && d2 != NULL)
9584 /* Check the third argument. */
9585 if (argvars[2].v_type != VAR_UNKNOWN)
9587 static char *(av[]) = {"keep", "force", "error"};
9589 action = get_tv_string_chk(&argvars[2]);
9590 if (action == NULL)
9591 return; /* type error; errmsg already given */
9592 for (i = 0; i < 3; ++i)
9593 if (STRCMP(action, av[i]) == 0)
9594 break;
9595 if (i == 3)
9597 EMSG2(_(e_invarg2), action);
9598 return;
9601 else
9602 action = (char_u *)"force";
9604 /* Go over all entries in the second dict and add them to the
9605 * first dict. */
9606 todo = (int)d2->dv_hashtab.ht_used;
9607 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9609 if (!HASHITEM_EMPTY(hi2))
9611 --todo;
9612 di1 = dict_find(d1, hi2->hi_key, -1);
9613 if (di1 == NULL)
9615 di1 = dictitem_copy(HI2DI(hi2));
9616 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9617 dictitem_free(di1);
9619 else if (*action == 'e')
9621 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9622 break;
9624 else if (*action == 'f')
9626 clear_tv(&di1->di_tv);
9627 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9632 copy_tv(&argvars[0], rettv);
9635 else
9636 EMSG2(_(e_listdictarg), "extend()");
9640 * "feedkeys()" function
9642 /*ARGSUSED*/
9643 static void
9644 f_feedkeys(argvars, rettv)
9645 typval_T *argvars;
9646 typval_T *rettv;
9648 int remap = TRUE;
9649 char_u *keys, *flags;
9650 char_u nbuf[NUMBUFLEN];
9651 int typed = FALSE;
9652 char_u *keys_esc;
9654 /* This is not allowed in the sandbox. If the commands would still be
9655 * executed in the sandbox it would be OK, but it probably happens later,
9656 * when "sandbox" is no longer set. */
9657 if (check_secure())
9658 return;
9660 rettv->vval.v_number = 0;
9661 keys = get_tv_string(&argvars[0]);
9662 if (*keys != NUL)
9664 if (argvars[1].v_type != VAR_UNKNOWN)
9666 flags = get_tv_string_buf(&argvars[1], nbuf);
9667 for ( ; *flags != NUL; ++flags)
9669 switch (*flags)
9671 case 'n': remap = FALSE; break;
9672 case 'm': remap = TRUE; break;
9673 case 't': typed = TRUE; break;
9678 /* Need to escape K_SPECIAL and CSI before putting the string in the
9679 * typeahead buffer. */
9680 keys_esc = vim_strsave_escape_csi(keys);
9681 if (keys_esc != NULL)
9683 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9684 typebuf.tb_len, !typed, FALSE);
9685 vim_free(keys_esc);
9686 if (vgetc_busy)
9687 typebuf_was_filled = TRUE;
9693 * "filereadable()" function
9695 static void
9696 f_filereadable(argvars, rettv)
9697 typval_T *argvars;
9698 typval_T *rettv;
9700 FILE *fd;
9701 char_u *p;
9702 int n;
9704 p = get_tv_string(&argvars[0]);
9705 if (*p && !mch_isdir(p) && (fd = mch_fopen((char *)p, "r")) != NULL)
9707 n = TRUE;
9708 fclose(fd);
9710 else
9711 n = FALSE;
9713 rettv->vval.v_number = n;
9717 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9718 * rights to write into.
9720 static void
9721 f_filewritable(argvars, rettv)
9722 typval_T *argvars;
9723 typval_T *rettv;
9725 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9728 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9730 static void
9731 findfilendir(argvars, rettv, find_what)
9732 typval_T *argvars;
9733 typval_T *rettv;
9734 int find_what;
9736 #ifdef FEAT_SEARCHPATH
9737 char_u *fname;
9738 char_u *fresult = NULL;
9739 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9740 char_u *p;
9741 char_u pathbuf[NUMBUFLEN];
9742 int count = 1;
9743 int first = TRUE;
9744 int error = FALSE;
9745 #endif
9747 rettv->vval.v_string = NULL;
9748 rettv->v_type = VAR_STRING;
9750 #ifdef FEAT_SEARCHPATH
9751 fname = get_tv_string(&argvars[0]);
9753 if (argvars[1].v_type != VAR_UNKNOWN)
9755 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9756 if (p == NULL)
9757 error = TRUE;
9758 else
9760 if (*p != NUL)
9761 path = p;
9763 if (argvars[2].v_type != VAR_UNKNOWN)
9764 count = get_tv_number_chk(&argvars[2], &error);
9768 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9769 error = TRUE;
9771 if (*fname != NUL && !error)
9775 if (rettv->v_type == VAR_STRING)
9776 vim_free(fresult);
9777 fresult = find_file_in_path_option(first ? fname : NULL,
9778 first ? (int)STRLEN(fname) : 0,
9779 0, first, path,
9780 find_what,
9781 curbuf->b_ffname,
9782 find_what == FINDFILE_DIR
9783 ? (char_u *)"" : curbuf->b_p_sua);
9784 first = FALSE;
9786 if (fresult != NULL && rettv->v_type == VAR_LIST)
9787 list_append_string(rettv->vval.v_list, fresult, -1);
9789 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9792 if (rettv->v_type == VAR_STRING)
9793 rettv->vval.v_string = fresult;
9794 #endif
9797 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9798 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9801 * Implementation of map() and filter().
9803 static void
9804 filter_map(argvars, rettv, map)
9805 typval_T *argvars;
9806 typval_T *rettv;
9807 int map;
9809 char_u buf[NUMBUFLEN];
9810 char_u *expr;
9811 listitem_T *li, *nli;
9812 list_T *l = NULL;
9813 dictitem_T *di;
9814 hashtab_T *ht;
9815 hashitem_T *hi;
9816 dict_T *d = NULL;
9817 typval_T save_val;
9818 typval_T save_key;
9819 int rem;
9820 int todo;
9821 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9822 int save_did_emsg;
9824 rettv->vval.v_number = 0;
9825 if (argvars[0].v_type == VAR_LIST)
9827 if ((l = argvars[0].vval.v_list) == NULL
9828 || (map && tv_check_lock(l->lv_lock, ermsg)))
9829 return;
9831 else if (argvars[0].v_type == VAR_DICT)
9833 if ((d = argvars[0].vval.v_dict) == NULL
9834 || (map && tv_check_lock(d->dv_lock, ermsg)))
9835 return;
9837 else
9839 EMSG2(_(e_listdictarg), ermsg);
9840 return;
9843 expr = get_tv_string_buf_chk(&argvars[1], buf);
9844 /* On type errors, the preceding call has already displayed an error
9845 * message. Avoid a misleading error message for an empty string that
9846 * was not passed as argument. */
9847 if (expr != NULL)
9849 prepare_vimvar(VV_VAL, &save_val);
9850 expr = skipwhite(expr);
9852 /* We reset "did_emsg" to be able to detect whether an error
9853 * occurred during evaluation of the expression. */
9854 save_did_emsg = did_emsg;
9855 did_emsg = FALSE;
9857 if (argvars[0].v_type == VAR_DICT)
9859 prepare_vimvar(VV_KEY, &save_key);
9860 vimvars[VV_KEY].vv_type = VAR_STRING;
9862 ht = &d->dv_hashtab;
9863 hash_lock(ht);
9864 todo = (int)ht->ht_used;
9865 for (hi = ht->ht_array; todo > 0; ++hi)
9867 if (!HASHITEM_EMPTY(hi))
9869 --todo;
9870 di = HI2DI(hi);
9871 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9872 break;
9873 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9874 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9875 || did_emsg)
9876 break;
9877 if (!map && rem)
9878 dictitem_remove(d, di);
9879 clear_tv(&vimvars[VV_KEY].vv_tv);
9882 hash_unlock(ht);
9884 restore_vimvar(VV_KEY, &save_key);
9886 else
9888 for (li = l->lv_first; li != NULL; li = nli)
9890 if (tv_check_lock(li->li_tv.v_lock, ermsg))
9891 break;
9892 nli = li->li_next;
9893 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
9894 || did_emsg)
9895 break;
9896 if (!map && rem)
9897 listitem_remove(l, li);
9901 restore_vimvar(VV_VAL, &save_val);
9903 did_emsg |= save_did_emsg;
9906 copy_tv(&argvars[0], rettv);
9909 static int
9910 filter_map_one(tv, expr, map, remp)
9911 typval_T *tv;
9912 char_u *expr;
9913 int map;
9914 int *remp;
9916 typval_T rettv;
9917 char_u *s;
9918 int retval = FAIL;
9920 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
9921 s = expr;
9922 if (eval1(&s, &rettv, TRUE) == FAIL)
9923 goto theend;
9924 if (*s != NUL) /* check for trailing chars after expr */
9926 EMSG2(_(e_invexpr2), s);
9927 goto theend;
9929 if (map)
9931 /* map(): replace the list item value */
9932 clear_tv(tv);
9933 rettv.v_lock = 0;
9934 *tv = rettv;
9936 else
9938 int error = FALSE;
9940 /* filter(): when expr is zero remove the item */
9941 *remp = (get_tv_number_chk(&rettv, &error) == 0);
9942 clear_tv(&rettv);
9943 /* On type error, nothing has been removed; return FAIL to stop the
9944 * loop. The error message was given by get_tv_number_chk(). */
9945 if (error)
9946 goto theend;
9948 retval = OK;
9949 theend:
9950 clear_tv(&vimvars[VV_VAL].vv_tv);
9951 return retval;
9955 * "filter()" function
9957 static void
9958 f_filter(argvars, rettv)
9959 typval_T *argvars;
9960 typval_T *rettv;
9962 filter_map(argvars, rettv, FALSE);
9966 * "finddir({fname}[, {path}[, {count}]])" function
9968 static void
9969 f_finddir(argvars, rettv)
9970 typval_T *argvars;
9971 typval_T *rettv;
9973 findfilendir(argvars, rettv, FINDFILE_DIR);
9977 * "findfile({fname}[, {path}[, {count}]])" function
9979 static void
9980 f_findfile(argvars, rettv)
9981 typval_T *argvars;
9982 typval_T *rettv;
9984 findfilendir(argvars, rettv, FINDFILE_FILE);
9987 #ifdef FEAT_FLOAT
9989 * "float2nr({float})" function
9991 static void
9992 f_float2nr(argvars, rettv)
9993 typval_T *argvars;
9994 typval_T *rettv;
9996 float_T f;
9998 if (get_float_arg(argvars, &f) == OK)
10000 if (f < -0x7fffffff)
10001 rettv->vval.v_number = -0x7fffffff;
10002 else if (f > 0x7fffffff)
10003 rettv->vval.v_number = 0x7fffffff;
10004 else
10005 rettv->vval.v_number = (varnumber_T)f;
10007 else
10008 rettv->vval.v_number = 0;
10012 * "floor({float})" function
10014 static void
10015 f_floor(argvars, rettv)
10016 typval_T *argvars;
10017 typval_T *rettv;
10019 float_T f;
10021 rettv->v_type = VAR_FLOAT;
10022 if (get_float_arg(argvars, &f) == OK)
10023 rettv->vval.v_float = floor(f);
10024 else
10025 rettv->vval.v_float = 0.0;
10027 #endif
10030 * "fnameescape({string})" function
10032 static void
10033 f_fnameescape(argvars, rettv)
10034 typval_T *argvars;
10035 typval_T *rettv;
10037 rettv->vval.v_string = vim_strsave_fnameescape(
10038 get_tv_string(&argvars[0]), FALSE);
10039 rettv->v_type = VAR_STRING;
10043 * "fnamemodify({fname}, {mods})" function
10045 static void
10046 f_fnamemodify(argvars, rettv)
10047 typval_T *argvars;
10048 typval_T *rettv;
10050 char_u *fname;
10051 char_u *mods;
10052 int usedlen = 0;
10053 int len;
10054 char_u *fbuf = NULL;
10055 char_u buf[NUMBUFLEN];
10057 fname = get_tv_string_chk(&argvars[0]);
10058 mods = get_tv_string_buf_chk(&argvars[1], buf);
10059 if (fname == NULL || mods == NULL)
10060 fname = NULL;
10061 else
10063 len = (int)STRLEN(fname);
10064 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10067 rettv->v_type = VAR_STRING;
10068 if (fname == NULL)
10069 rettv->vval.v_string = NULL;
10070 else
10071 rettv->vval.v_string = vim_strnsave(fname, len);
10072 vim_free(fbuf);
10075 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10078 * "foldclosed()" function
10080 static void
10081 foldclosed_both(argvars, rettv, end)
10082 typval_T *argvars;
10083 typval_T *rettv;
10084 int end;
10086 #ifdef FEAT_FOLDING
10087 linenr_T lnum;
10088 linenr_T first, last;
10090 lnum = get_tv_lnum(argvars);
10091 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10093 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10095 if (end)
10096 rettv->vval.v_number = (varnumber_T)last;
10097 else
10098 rettv->vval.v_number = (varnumber_T)first;
10099 return;
10102 #endif
10103 rettv->vval.v_number = -1;
10107 * "foldclosed()" function
10109 static void
10110 f_foldclosed(argvars, rettv)
10111 typval_T *argvars;
10112 typval_T *rettv;
10114 foldclosed_both(argvars, rettv, FALSE);
10118 * "foldclosedend()" function
10120 static void
10121 f_foldclosedend(argvars, rettv)
10122 typval_T *argvars;
10123 typval_T *rettv;
10125 foldclosed_both(argvars, rettv, TRUE);
10129 * "foldlevel()" function
10131 static void
10132 f_foldlevel(argvars, rettv)
10133 typval_T *argvars;
10134 typval_T *rettv;
10136 #ifdef FEAT_FOLDING
10137 linenr_T lnum;
10139 lnum = get_tv_lnum(argvars);
10140 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10141 rettv->vval.v_number = foldLevel(lnum);
10142 else
10143 #endif
10144 rettv->vval.v_number = 0;
10148 * "foldtext()" function
10150 /*ARGSUSED*/
10151 static void
10152 f_foldtext(argvars, rettv)
10153 typval_T *argvars;
10154 typval_T *rettv;
10156 #ifdef FEAT_FOLDING
10157 linenr_T lnum;
10158 char_u *s;
10159 char_u *r;
10160 int len;
10161 char *txt;
10162 #endif
10164 rettv->v_type = VAR_STRING;
10165 rettv->vval.v_string = NULL;
10166 #ifdef FEAT_FOLDING
10167 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10168 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10169 <= curbuf->b_ml.ml_line_count
10170 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10172 /* Find first non-empty line in the fold. */
10173 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10174 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10176 if (!linewhite(lnum))
10177 break;
10178 ++lnum;
10181 /* Find interesting text in this line. */
10182 s = skipwhite(ml_get(lnum));
10183 /* skip C comment-start */
10184 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10186 s = skipwhite(s + 2);
10187 if (*skipwhite(s) == NUL
10188 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10190 s = skipwhite(ml_get(lnum + 1));
10191 if (*s == '*')
10192 s = skipwhite(s + 1);
10195 txt = _("+-%s%3ld lines: ");
10196 r = alloc((unsigned)(STRLEN(txt)
10197 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10198 + 20 /* for %3ld */
10199 + STRLEN(s))); /* concatenated */
10200 if (r != NULL)
10202 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10203 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10204 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10205 len = (int)STRLEN(r);
10206 STRCAT(r, s);
10207 /* remove 'foldmarker' and 'commentstring' */
10208 foldtext_cleanup(r + len);
10209 rettv->vval.v_string = r;
10212 #endif
10216 * "foldtextresult(lnum)" function
10218 /*ARGSUSED*/
10219 static void
10220 f_foldtextresult(argvars, rettv)
10221 typval_T *argvars;
10222 typval_T *rettv;
10224 #ifdef FEAT_FOLDING
10225 linenr_T lnum;
10226 char_u *text;
10227 char_u buf[51];
10228 foldinfo_T foldinfo;
10229 int fold_count;
10230 #endif
10232 rettv->v_type = VAR_STRING;
10233 rettv->vval.v_string = NULL;
10234 #ifdef FEAT_FOLDING
10235 lnum = get_tv_lnum(argvars);
10236 /* treat illegal types and illegal string values for {lnum} the same */
10237 if (lnum < 0)
10238 lnum = 0;
10239 fold_count = foldedCount(curwin, lnum, &foldinfo);
10240 if (fold_count > 0)
10242 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10243 &foldinfo, buf);
10244 if (text == buf)
10245 text = vim_strsave(text);
10246 rettv->vval.v_string = text;
10248 #endif
10252 * "foreground()" function
10254 /*ARGSUSED*/
10255 static void
10256 f_foreground(argvars, rettv)
10257 typval_T *argvars;
10258 typval_T *rettv;
10260 rettv->vval.v_number = 0;
10261 #ifdef FEAT_GUI
10262 if (gui.in_use)
10263 gui_mch_set_foreground();
10264 #else
10265 # ifdef WIN32
10266 win32_set_foreground();
10267 # endif
10268 #endif
10272 * "function()" function
10274 /*ARGSUSED*/
10275 static void
10276 f_function(argvars, rettv)
10277 typval_T *argvars;
10278 typval_T *rettv;
10280 char_u *s;
10282 rettv->vval.v_number = 0;
10283 s = get_tv_string(&argvars[0]);
10284 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10285 EMSG2(_(e_invarg2), s);
10286 else if (!function_exists(s))
10287 EMSG2(_("E700: Unknown function: %s"), s);
10288 else
10290 rettv->vval.v_string = vim_strsave(s);
10291 rettv->v_type = VAR_FUNC;
10296 * "garbagecollect()" function
10298 /*ARGSUSED*/
10299 static void
10300 f_garbagecollect(argvars, rettv)
10301 typval_T *argvars;
10302 typval_T *rettv;
10304 /* This is postponed until we are back at the toplevel, because we may be
10305 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10306 want_garbage_collect = TRUE;
10308 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10309 garbage_collect_at_exit = TRUE;
10313 * "get()" function
10315 static void
10316 f_get(argvars, rettv)
10317 typval_T *argvars;
10318 typval_T *rettv;
10320 listitem_T *li;
10321 list_T *l;
10322 dictitem_T *di;
10323 dict_T *d;
10324 typval_T *tv = NULL;
10326 if (argvars[0].v_type == VAR_LIST)
10328 if ((l = argvars[0].vval.v_list) != NULL)
10330 int error = FALSE;
10332 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10333 if (!error && li != NULL)
10334 tv = &li->li_tv;
10337 else if (argvars[0].v_type == VAR_DICT)
10339 if ((d = argvars[0].vval.v_dict) != NULL)
10341 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10342 if (di != NULL)
10343 tv = &di->di_tv;
10346 else
10347 EMSG2(_(e_listdictarg), "get()");
10349 if (tv == NULL)
10351 if (argvars[2].v_type == VAR_UNKNOWN)
10352 rettv->vval.v_number = 0;
10353 else
10354 copy_tv(&argvars[2], rettv);
10356 else
10357 copy_tv(tv, rettv);
10360 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10363 * Get line or list of lines from buffer "buf" into "rettv".
10364 * Return a range (from start to end) of lines in rettv from the specified
10365 * buffer.
10366 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10368 static void
10369 get_buffer_lines(buf, start, end, retlist, rettv)
10370 buf_T *buf;
10371 linenr_T start;
10372 linenr_T end;
10373 int retlist;
10374 typval_T *rettv;
10376 char_u *p;
10378 if (retlist)
10380 if (rettv_list_alloc(rettv) == FAIL)
10381 return;
10383 else
10384 rettv->vval.v_number = 0;
10386 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10387 return;
10389 if (!retlist)
10391 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10392 p = ml_get_buf(buf, start, FALSE);
10393 else
10394 p = (char_u *)"";
10396 rettv->v_type = VAR_STRING;
10397 rettv->vval.v_string = vim_strsave(p);
10399 else
10401 if (end < start)
10402 return;
10404 if (start < 1)
10405 start = 1;
10406 if (end > buf->b_ml.ml_line_count)
10407 end = buf->b_ml.ml_line_count;
10408 while (start <= end)
10409 if (list_append_string(rettv->vval.v_list,
10410 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10411 break;
10416 * "getbufline()" function
10418 static void
10419 f_getbufline(argvars, rettv)
10420 typval_T *argvars;
10421 typval_T *rettv;
10423 linenr_T lnum;
10424 linenr_T end;
10425 buf_T *buf;
10427 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10428 ++emsg_off;
10429 buf = get_buf_tv(&argvars[0]);
10430 --emsg_off;
10432 lnum = get_tv_lnum_buf(&argvars[1], buf);
10433 if (argvars[2].v_type == VAR_UNKNOWN)
10434 end = lnum;
10435 else
10436 end = get_tv_lnum_buf(&argvars[2], buf);
10438 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10442 * "getbufvar()" function
10444 static void
10445 f_getbufvar(argvars, rettv)
10446 typval_T *argvars;
10447 typval_T *rettv;
10449 buf_T *buf;
10450 buf_T *save_curbuf;
10451 char_u *varname;
10452 dictitem_T *v;
10454 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10455 varname = get_tv_string_chk(&argvars[1]);
10456 ++emsg_off;
10457 buf = get_buf_tv(&argvars[0]);
10459 rettv->v_type = VAR_STRING;
10460 rettv->vval.v_string = NULL;
10462 if (buf != NULL && varname != NULL)
10464 /* set curbuf to be our buf, temporarily */
10465 save_curbuf = curbuf;
10466 curbuf = buf;
10468 if (*varname == '&') /* buffer-local-option */
10469 get_option_tv(&varname, rettv, TRUE);
10470 else
10472 if (*varname == NUL)
10473 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10474 * scope prefix before the NUL byte is required by
10475 * find_var_in_ht(). */
10476 varname = (char_u *)"b:" + 2;
10477 /* look up the variable */
10478 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10479 if (v != NULL)
10480 copy_tv(&v->di_tv, rettv);
10483 /* restore previous notion of curbuf */
10484 curbuf = save_curbuf;
10487 --emsg_off;
10491 * "getchar()" function
10493 static void
10494 f_getchar(argvars, rettv)
10495 typval_T *argvars;
10496 typval_T *rettv;
10498 varnumber_T n;
10499 int error = FALSE;
10501 /* Position the cursor. Needed after a message that ends in a space. */
10502 windgoto(msg_row, msg_col);
10504 ++no_mapping;
10505 ++allow_keys;
10506 for (;;)
10508 if (argvars[0].v_type == VAR_UNKNOWN)
10509 /* getchar(): blocking wait. */
10510 n = safe_vgetc();
10511 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10512 /* getchar(1): only check if char avail */
10513 n = vpeekc();
10514 else if (error || vpeekc() == NUL)
10515 /* illegal argument or getchar(0) and no char avail: return zero */
10516 n = 0;
10517 else
10518 /* getchar(0) and char avail: return char */
10519 n = safe_vgetc();
10520 if (n == K_IGNORE)
10521 continue;
10522 break;
10524 --no_mapping;
10525 --allow_keys;
10527 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10528 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10529 vimvars[VV_MOUSE_COL].vv_nr = 0;
10531 rettv->vval.v_number = n;
10532 if (IS_SPECIAL(n) || mod_mask != 0)
10534 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10535 int i = 0;
10537 /* Turn a special key into three bytes, plus modifier. */
10538 if (mod_mask != 0)
10540 temp[i++] = K_SPECIAL;
10541 temp[i++] = KS_MODIFIER;
10542 temp[i++] = mod_mask;
10544 if (IS_SPECIAL(n))
10546 temp[i++] = K_SPECIAL;
10547 temp[i++] = K_SECOND(n);
10548 temp[i++] = K_THIRD(n);
10550 #ifdef FEAT_MBYTE
10551 else if (has_mbyte)
10552 i += (*mb_char2bytes)(n, temp + i);
10553 #endif
10554 else
10555 temp[i++] = n;
10556 temp[i++] = NUL;
10557 rettv->v_type = VAR_STRING;
10558 rettv->vval.v_string = vim_strsave(temp);
10560 #ifdef FEAT_MOUSE
10561 if (n == K_LEFTMOUSE
10562 || n == K_LEFTMOUSE_NM
10563 || n == K_LEFTDRAG
10564 || n == K_LEFTRELEASE
10565 || n == K_LEFTRELEASE_NM
10566 || n == K_MIDDLEMOUSE
10567 || n == K_MIDDLEDRAG
10568 || n == K_MIDDLERELEASE
10569 || n == K_RIGHTMOUSE
10570 || n == K_RIGHTDRAG
10571 || n == K_RIGHTRELEASE
10572 || n == K_X1MOUSE
10573 || n == K_X1DRAG
10574 || n == K_X1RELEASE
10575 || n == K_X2MOUSE
10576 || n == K_X2DRAG
10577 || n == K_X2RELEASE
10578 || n == K_MOUSEDOWN
10579 || n == K_MOUSEUP)
10581 int row = mouse_row;
10582 int col = mouse_col;
10583 win_T *win;
10584 linenr_T lnum;
10585 # ifdef FEAT_WINDOWS
10586 win_T *wp;
10587 # endif
10588 int n = 1;
10590 if (row >= 0 && col >= 0)
10592 /* Find the window at the mouse coordinates and compute the
10593 * text position. */
10594 win = mouse_find_win(&row, &col);
10595 (void)mouse_comp_pos(win, &row, &col, &lnum);
10596 # ifdef FEAT_WINDOWS
10597 for (wp = firstwin; wp != win; wp = wp->w_next)
10598 ++n;
10599 # endif
10600 vimvars[VV_MOUSE_WIN].vv_nr = n;
10601 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10602 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10605 #endif
10610 * "getcharmod()" function
10612 /*ARGSUSED*/
10613 static void
10614 f_getcharmod(argvars, rettv)
10615 typval_T *argvars;
10616 typval_T *rettv;
10618 rettv->vval.v_number = mod_mask;
10622 * "getcmdline()" function
10624 /*ARGSUSED*/
10625 static void
10626 f_getcmdline(argvars, rettv)
10627 typval_T *argvars;
10628 typval_T *rettv;
10630 rettv->v_type = VAR_STRING;
10631 rettv->vval.v_string = get_cmdline_str();
10635 * "getcmdpos()" function
10637 /*ARGSUSED*/
10638 static void
10639 f_getcmdpos(argvars, rettv)
10640 typval_T *argvars;
10641 typval_T *rettv;
10643 rettv->vval.v_number = get_cmdline_pos() + 1;
10647 * "getcmdtype()" function
10649 /*ARGSUSED*/
10650 static void
10651 f_getcmdtype(argvars, rettv)
10652 typval_T *argvars;
10653 typval_T *rettv;
10655 rettv->v_type = VAR_STRING;
10656 rettv->vval.v_string = alloc(2);
10657 if (rettv->vval.v_string != NULL)
10659 rettv->vval.v_string[0] = get_cmdline_type();
10660 rettv->vval.v_string[1] = NUL;
10665 * "getcwd()" function
10667 /*ARGSUSED*/
10668 static void
10669 f_getcwd(argvars, rettv)
10670 typval_T *argvars;
10671 typval_T *rettv;
10673 char_u cwd[MAXPATHL];
10675 rettv->v_type = VAR_STRING;
10676 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10677 rettv->vval.v_string = NULL;
10678 else
10680 rettv->vval.v_string = vim_strsave(cwd);
10681 #ifdef BACKSLASH_IN_FILENAME
10682 if (rettv->vval.v_string != NULL)
10683 slash_adjust(rettv->vval.v_string);
10684 #endif
10689 * "getfontname()" function
10691 /*ARGSUSED*/
10692 static void
10693 f_getfontname(argvars, rettv)
10694 typval_T *argvars;
10695 typval_T *rettv;
10697 rettv->v_type = VAR_STRING;
10698 rettv->vval.v_string = NULL;
10699 #ifdef FEAT_GUI
10700 if (gui.in_use)
10702 GuiFont font;
10703 char_u *name = NULL;
10705 if (argvars[0].v_type == VAR_UNKNOWN)
10707 /* Get the "Normal" font. Either the name saved by
10708 * hl_set_font_name() or from the font ID. */
10709 font = gui.norm_font;
10710 name = hl_get_font_name();
10712 else
10714 name = get_tv_string(&argvars[0]);
10715 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10716 return;
10717 font = gui_mch_get_font(name, FALSE);
10718 if (font == NOFONT)
10719 return; /* Invalid font name, return empty string. */
10721 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10722 if (argvars[0].v_type != VAR_UNKNOWN)
10723 gui_mch_free_font(font);
10725 #endif
10729 * "getfperm({fname})" function
10731 static void
10732 f_getfperm(argvars, rettv)
10733 typval_T *argvars;
10734 typval_T *rettv;
10736 char_u *fname;
10737 struct stat st;
10738 char_u *perm = NULL;
10739 char_u flags[] = "rwx";
10740 int i;
10742 fname = get_tv_string(&argvars[0]);
10744 rettv->v_type = VAR_STRING;
10745 if (mch_stat((char *)fname, &st) >= 0)
10747 perm = vim_strsave((char_u *)"---------");
10748 if (perm != NULL)
10750 for (i = 0; i < 9; i++)
10752 if (st.st_mode & (1 << (8 - i)))
10753 perm[i] = flags[i % 3];
10757 rettv->vval.v_string = perm;
10761 * "getfsize({fname})" function
10763 static void
10764 f_getfsize(argvars, rettv)
10765 typval_T *argvars;
10766 typval_T *rettv;
10768 char_u *fname;
10769 struct stat st;
10771 fname = get_tv_string(&argvars[0]);
10773 rettv->v_type = VAR_NUMBER;
10775 if (mch_stat((char *)fname, &st) >= 0)
10777 if (mch_isdir(fname))
10778 rettv->vval.v_number = 0;
10779 else
10781 rettv->vval.v_number = (varnumber_T)st.st_size;
10783 /* non-perfect check for overflow */
10784 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10785 rettv->vval.v_number = -2;
10788 else
10789 rettv->vval.v_number = -1;
10793 * "getftime({fname})" function
10795 static void
10796 f_getftime(argvars, rettv)
10797 typval_T *argvars;
10798 typval_T *rettv;
10800 char_u *fname;
10801 struct stat st;
10803 fname = get_tv_string(&argvars[0]);
10805 if (mch_stat((char *)fname, &st) >= 0)
10806 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10807 else
10808 rettv->vval.v_number = -1;
10812 * "getftype({fname})" function
10814 static void
10815 f_getftype(argvars, rettv)
10816 typval_T *argvars;
10817 typval_T *rettv;
10819 char_u *fname;
10820 struct stat st;
10821 char_u *type = NULL;
10822 char *t;
10824 fname = get_tv_string(&argvars[0]);
10826 rettv->v_type = VAR_STRING;
10827 if (mch_lstat((char *)fname, &st) >= 0)
10829 #ifdef S_ISREG
10830 if (S_ISREG(st.st_mode))
10831 t = "file";
10832 else if (S_ISDIR(st.st_mode))
10833 t = "dir";
10834 # ifdef S_ISLNK
10835 else if (S_ISLNK(st.st_mode))
10836 t = "link";
10837 # endif
10838 # ifdef S_ISBLK
10839 else if (S_ISBLK(st.st_mode))
10840 t = "bdev";
10841 # endif
10842 # ifdef S_ISCHR
10843 else if (S_ISCHR(st.st_mode))
10844 t = "cdev";
10845 # endif
10846 # ifdef S_ISFIFO
10847 else if (S_ISFIFO(st.st_mode))
10848 t = "fifo";
10849 # endif
10850 # ifdef S_ISSOCK
10851 else if (S_ISSOCK(st.st_mode))
10852 t = "fifo";
10853 # endif
10854 else
10855 t = "other";
10856 #else
10857 # ifdef S_IFMT
10858 switch (st.st_mode & S_IFMT)
10860 case S_IFREG: t = "file"; break;
10861 case S_IFDIR: t = "dir"; break;
10862 # ifdef S_IFLNK
10863 case S_IFLNK: t = "link"; break;
10864 # endif
10865 # ifdef S_IFBLK
10866 case S_IFBLK: t = "bdev"; break;
10867 # endif
10868 # ifdef S_IFCHR
10869 case S_IFCHR: t = "cdev"; break;
10870 # endif
10871 # ifdef S_IFIFO
10872 case S_IFIFO: t = "fifo"; break;
10873 # endif
10874 # ifdef S_IFSOCK
10875 case S_IFSOCK: t = "socket"; break;
10876 # endif
10877 default: t = "other";
10879 # else
10880 if (mch_isdir(fname))
10881 t = "dir";
10882 else
10883 t = "file";
10884 # endif
10885 #endif
10886 type = vim_strsave((char_u *)t);
10888 rettv->vval.v_string = type;
10892 * "getline(lnum, [end])" function
10894 static void
10895 f_getline(argvars, rettv)
10896 typval_T *argvars;
10897 typval_T *rettv;
10899 linenr_T lnum;
10900 linenr_T end;
10901 int retlist;
10903 lnum = get_tv_lnum(argvars);
10904 if (argvars[1].v_type == VAR_UNKNOWN)
10906 end = 0;
10907 retlist = FALSE;
10909 else
10911 end = get_tv_lnum(&argvars[1]);
10912 retlist = TRUE;
10915 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
10919 * "getmatches()" function
10921 /*ARGSUSED*/
10922 static void
10923 f_getmatches(argvars, rettv)
10924 typval_T *argvars;
10925 typval_T *rettv;
10927 #ifdef FEAT_SEARCH_EXTRA
10928 dict_T *dict;
10929 matchitem_T *cur = curwin->w_match_head;
10931 rettv->vval.v_number = 0;
10933 if (rettv_list_alloc(rettv) == OK)
10935 while (cur != NULL)
10937 dict = dict_alloc();
10938 if (dict == NULL)
10939 return;
10940 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
10941 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
10942 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
10943 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
10944 list_append_dict(rettv->vval.v_list, dict);
10945 cur = cur->next;
10948 #endif
10952 * "getpid()" function
10954 /*ARGSUSED*/
10955 static void
10956 f_getpid(argvars, rettv)
10957 typval_T *argvars;
10958 typval_T *rettv;
10960 rettv->vval.v_number = mch_get_pid();
10964 * "getpos(string)" function
10966 static void
10967 f_getpos(argvars, rettv)
10968 typval_T *argvars;
10969 typval_T *rettv;
10971 pos_T *fp;
10972 list_T *l;
10973 int fnum = -1;
10975 if (rettv_list_alloc(rettv) == OK)
10977 l = rettv->vval.v_list;
10978 fp = var2fpos(&argvars[0], TRUE, &fnum);
10979 if (fnum != -1)
10980 list_append_number(l, (varnumber_T)fnum);
10981 else
10982 list_append_number(l, (varnumber_T)0);
10983 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
10984 : (varnumber_T)0);
10985 list_append_number(l, (fp != NULL)
10986 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
10987 : (varnumber_T)0);
10988 list_append_number(l,
10989 #ifdef FEAT_VIRTUALEDIT
10990 (fp != NULL) ? (varnumber_T)fp->coladd :
10991 #endif
10992 (varnumber_T)0);
10994 else
10995 rettv->vval.v_number = FALSE;
10999 * "getqflist()" and "getloclist()" functions
11001 /*ARGSUSED*/
11002 static void
11003 f_getqflist(argvars, rettv)
11004 typval_T *argvars;
11005 typval_T *rettv;
11007 #ifdef FEAT_QUICKFIX
11008 win_T *wp;
11009 #endif
11011 rettv->vval.v_number = 0;
11012 #ifdef FEAT_QUICKFIX
11013 if (rettv_list_alloc(rettv) == OK)
11015 wp = NULL;
11016 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11018 wp = find_win_by_nr(&argvars[0], NULL);
11019 if (wp == NULL)
11020 return;
11023 (void)get_errorlist(wp, rettv->vval.v_list);
11025 #endif
11029 * "getreg()" function
11031 static void
11032 f_getreg(argvars, rettv)
11033 typval_T *argvars;
11034 typval_T *rettv;
11036 char_u *strregname;
11037 int regname;
11038 int arg2 = FALSE;
11039 int error = FALSE;
11041 if (argvars[0].v_type != VAR_UNKNOWN)
11043 strregname = get_tv_string_chk(&argvars[0]);
11044 error = strregname == NULL;
11045 if (argvars[1].v_type != VAR_UNKNOWN)
11046 arg2 = get_tv_number_chk(&argvars[1], &error);
11048 else
11049 strregname = vimvars[VV_REG].vv_str;
11050 regname = (strregname == NULL ? '"' : *strregname);
11051 if (regname == 0)
11052 regname = '"';
11054 rettv->v_type = VAR_STRING;
11055 rettv->vval.v_string = error ? NULL :
11056 get_reg_contents(regname, TRUE, arg2);
11060 * "getregtype()" function
11062 static void
11063 f_getregtype(argvars, rettv)
11064 typval_T *argvars;
11065 typval_T *rettv;
11067 char_u *strregname;
11068 int regname;
11069 char_u buf[NUMBUFLEN + 2];
11070 long reglen = 0;
11072 if (argvars[0].v_type != VAR_UNKNOWN)
11074 strregname = get_tv_string_chk(&argvars[0]);
11075 if (strregname == NULL) /* type error; errmsg already given */
11077 rettv->v_type = VAR_STRING;
11078 rettv->vval.v_string = NULL;
11079 return;
11082 else
11083 /* Default to v:register */
11084 strregname = vimvars[VV_REG].vv_str;
11086 regname = (strregname == NULL ? '"' : *strregname);
11087 if (regname == 0)
11088 regname = '"';
11090 buf[0] = NUL;
11091 buf[1] = NUL;
11092 switch (get_reg_type(regname, &reglen))
11094 case MLINE: buf[0] = 'V'; break;
11095 case MCHAR: buf[0] = 'v'; break;
11096 #ifdef FEAT_VISUAL
11097 case MBLOCK:
11098 buf[0] = Ctrl_V;
11099 sprintf((char *)buf + 1, "%ld", reglen + 1);
11100 break;
11101 #endif
11103 rettv->v_type = VAR_STRING;
11104 rettv->vval.v_string = vim_strsave(buf);
11108 * "gettabwinvar()" function
11110 static void
11111 f_gettabwinvar(argvars, rettv)
11112 typval_T *argvars;
11113 typval_T *rettv;
11115 getwinvar(argvars, rettv, 1);
11119 * "getwinposx()" function
11121 /*ARGSUSED*/
11122 static void
11123 f_getwinposx(argvars, rettv)
11124 typval_T *argvars;
11125 typval_T *rettv;
11127 rettv->vval.v_number = -1;
11128 #ifdef FEAT_GUI
11129 if (gui.in_use)
11131 int x, y;
11133 if (gui_mch_get_winpos(&x, &y) == OK)
11134 rettv->vval.v_number = x;
11136 #endif
11140 * "getwinposy()" function
11142 /*ARGSUSED*/
11143 static void
11144 f_getwinposy(argvars, rettv)
11145 typval_T *argvars;
11146 typval_T *rettv;
11148 rettv->vval.v_number = -1;
11149 #ifdef FEAT_GUI
11150 if (gui.in_use)
11152 int x, y;
11154 if (gui_mch_get_winpos(&x, &y) == OK)
11155 rettv->vval.v_number = y;
11157 #endif
11161 * Find window specified by "vp" in tabpage "tp".
11163 static win_T *
11164 find_win_by_nr(vp, tp)
11165 typval_T *vp;
11166 tabpage_T *tp; /* NULL for current tab page */
11168 #ifdef FEAT_WINDOWS
11169 win_T *wp;
11170 #endif
11171 int nr;
11173 nr = get_tv_number_chk(vp, NULL);
11175 #ifdef FEAT_WINDOWS
11176 if (nr < 0)
11177 return NULL;
11178 if (nr == 0)
11179 return curwin;
11181 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11182 wp != NULL; wp = wp->w_next)
11183 if (--nr <= 0)
11184 break;
11185 return wp;
11186 #else
11187 if (nr == 0 || nr == 1)
11188 return curwin;
11189 return NULL;
11190 #endif
11194 * "getwinvar()" function
11196 static void
11197 f_getwinvar(argvars, rettv)
11198 typval_T *argvars;
11199 typval_T *rettv;
11201 getwinvar(argvars, rettv, 0);
11205 * getwinvar() and gettabwinvar()
11207 static void
11208 getwinvar(argvars, rettv, off)
11209 typval_T *argvars;
11210 typval_T *rettv;
11211 int off; /* 1 for gettabwinvar() */
11213 win_T *win, *oldcurwin;
11214 char_u *varname;
11215 dictitem_T *v;
11216 tabpage_T *tp;
11218 #ifdef FEAT_WINDOWS
11219 if (off == 1)
11220 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11221 else
11222 tp = curtab;
11223 #endif
11224 win = find_win_by_nr(&argvars[off], tp);
11225 varname = get_tv_string_chk(&argvars[off + 1]);
11226 ++emsg_off;
11228 rettv->v_type = VAR_STRING;
11229 rettv->vval.v_string = NULL;
11231 if (win != NULL && varname != NULL)
11233 /* Set curwin to be our win, temporarily. Also set curbuf, so
11234 * that we can get buffer-local options. */
11235 oldcurwin = curwin;
11236 curwin = win;
11237 curbuf = win->w_buffer;
11239 if (*varname == '&') /* window-local-option */
11240 get_option_tv(&varname, rettv, 1);
11241 else
11243 if (*varname == NUL)
11244 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11245 * scope prefix before the NUL byte is required by
11246 * find_var_in_ht(). */
11247 varname = (char_u *)"w:" + 2;
11248 /* look up the variable */
11249 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11250 if (v != NULL)
11251 copy_tv(&v->di_tv, rettv);
11254 /* restore previous notion of curwin */
11255 curwin = oldcurwin;
11256 curbuf = curwin->w_buffer;
11259 --emsg_off;
11263 * "glob()" function
11265 static void
11266 f_glob(argvars, rettv)
11267 typval_T *argvars;
11268 typval_T *rettv;
11270 expand_T xpc;
11272 ExpandInit(&xpc);
11273 xpc.xp_context = EXPAND_FILES;
11274 rettv->v_type = VAR_STRING;
11275 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11276 NULL, WILD_USE_NL|WILD_SILENT, WILD_ALL);
11280 * "globpath()" function
11282 static void
11283 f_globpath(argvars, rettv)
11284 typval_T *argvars;
11285 typval_T *rettv;
11287 char_u buf1[NUMBUFLEN];
11288 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11290 rettv->v_type = VAR_STRING;
11291 if (file == NULL)
11292 rettv->vval.v_string = NULL;
11293 else
11294 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file);
11298 * "has()" function
11300 static void
11301 f_has(argvars, rettv)
11302 typval_T *argvars;
11303 typval_T *rettv;
11305 int i;
11306 char_u *name;
11307 int n = FALSE;
11308 static char *(has_list[]) =
11310 #ifdef AMIGA
11311 "amiga",
11312 # ifdef FEAT_ARP
11313 "arp",
11314 # endif
11315 #endif
11316 #ifdef __BEOS__
11317 "beos",
11318 #endif
11319 #ifdef MSDOS
11320 # ifdef DJGPP
11321 "dos32",
11322 # else
11323 "dos16",
11324 # endif
11325 #endif
11326 #ifdef MACOS
11327 "mac",
11328 #endif
11329 #if defined(MACOS_X_UNIX)
11330 "macunix",
11331 #endif
11332 #ifdef OS2
11333 "os2",
11334 #endif
11335 #ifdef __QNX__
11336 "qnx",
11337 #endif
11338 #ifdef RISCOS
11339 "riscos",
11340 #endif
11341 #ifdef UNIX
11342 "unix",
11343 #endif
11344 #ifdef VMS
11345 "vms",
11346 #endif
11347 #ifdef WIN16
11348 "win16",
11349 #endif
11350 #ifdef WIN32
11351 "win32",
11352 #endif
11353 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11354 "win32unix",
11355 #endif
11356 #ifdef WIN64
11357 "win64",
11358 #endif
11359 #ifdef EBCDIC
11360 "ebcdic",
11361 #endif
11362 #ifndef CASE_INSENSITIVE_FILENAME
11363 "fname_case",
11364 #endif
11365 #ifdef FEAT_ARABIC
11366 "arabic",
11367 #endif
11368 #ifdef FEAT_AUTOCMD
11369 "autocmd",
11370 #endif
11371 #ifdef FEAT_BEVAL
11372 "balloon_eval",
11373 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11374 "balloon_multiline",
11375 # endif
11376 #endif
11377 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11378 "builtin_terms",
11379 # ifdef ALL_BUILTIN_TCAPS
11380 "all_builtin_terms",
11381 # endif
11382 #endif
11383 #ifdef FEAT_BYTEOFF
11384 "byte_offset",
11385 #endif
11386 #ifdef FEAT_CINDENT
11387 "cindent",
11388 #endif
11389 #ifdef FEAT_CLIENTSERVER
11390 "clientserver",
11391 #endif
11392 #ifdef FEAT_CLIPBOARD
11393 "clipboard",
11394 #endif
11395 #ifdef FEAT_CMDL_COMPL
11396 "cmdline_compl",
11397 #endif
11398 #ifdef FEAT_CMDHIST
11399 "cmdline_hist",
11400 #endif
11401 #ifdef FEAT_COMMENTS
11402 "comments",
11403 #endif
11404 #ifdef FEAT_CRYPT
11405 "cryptv",
11406 #endif
11407 #ifdef FEAT_CSCOPE
11408 "cscope",
11409 #endif
11410 #ifdef CURSOR_SHAPE
11411 "cursorshape",
11412 #endif
11413 #ifdef DEBUG
11414 "debug",
11415 #endif
11416 #ifdef FEAT_CON_DIALOG
11417 "dialog_con",
11418 #endif
11419 #ifdef FEAT_GUI_DIALOG
11420 "dialog_gui",
11421 #endif
11422 #ifdef FEAT_DIFF
11423 "diff",
11424 #endif
11425 #ifdef FEAT_DIGRAPHS
11426 "digraphs",
11427 #endif
11428 #ifdef FEAT_DND
11429 "dnd",
11430 #endif
11431 #ifdef FEAT_EMACS_TAGS
11432 "emacs_tags",
11433 #endif
11434 "eval", /* always present, of course! */
11435 #ifdef FEAT_EX_EXTRA
11436 "ex_extra",
11437 #endif
11438 #ifdef FEAT_SEARCH_EXTRA
11439 "extra_search",
11440 #endif
11441 #ifdef FEAT_FKMAP
11442 "farsi",
11443 #endif
11444 #ifdef FEAT_SEARCHPATH
11445 "file_in_path",
11446 #endif
11447 #if defined(UNIX) && !defined(USE_SYSTEM)
11448 "filterpipe",
11449 #endif
11450 #ifdef FEAT_FIND_ID
11451 "find_in_path",
11452 #endif
11453 #ifdef FEAT_FLOAT
11454 "float",
11455 #endif
11456 #ifdef FEAT_FOLDING
11457 "folding",
11458 #endif
11459 #ifdef FEAT_FOOTER
11460 "footer",
11461 #endif
11462 #if !defined(USE_SYSTEM) && defined(UNIX)
11463 "fork",
11464 #endif
11465 #ifdef FEAT_GETTEXT
11466 "gettext",
11467 #endif
11468 #ifdef FEAT_GUI
11469 "gui",
11470 #endif
11471 #ifdef FEAT_GUI_ATHENA
11472 # ifdef FEAT_GUI_NEXTAW
11473 "gui_neXtaw",
11474 # else
11475 "gui_athena",
11476 # endif
11477 #endif
11478 #ifdef FEAT_GUI_GTK
11479 "gui_gtk",
11480 # ifdef HAVE_GTK2
11481 "gui_gtk2",
11482 # endif
11483 #endif
11484 #ifdef FEAT_GUI_GNOME
11485 "gui_gnome",
11486 #endif
11487 #ifdef FEAT_GUI_MAC
11488 "gui_mac",
11489 #endif
11490 #ifdef FEAT_GUI_MOTIF
11491 "gui_motif",
11492 #endif
11493 #ifdef FEAT_GUI_PHOTON
11494 "gui_photon",
11495 #endif
11496 #ifdef FEAT_GUI_W16
11497 "gui_win16",
11498 #endif
11499 #ifdef FEAT_GUI_W32
11500 "gui_win32",
11501 #endif
11502 #ifdef FEAT_HANGULIN
11503 "hangul_input",
11504 #endif
11505 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11506 "iconv",
11507 #endif
11508 #ifdef FEAT_INS_EXPAND
11509 "insert_expand",
11510 #endif
11511 #ifdef FEAT_JUMPLIST
11512 "jumplist",
11513 #endif
11514 #ifdef FEAT_KEYMAP
11515 "keymap",
11516 #endif
11517 #ifdef FEAT_LANGMAP
11518 "langmap",
11519 #endif
11520 #ifdef FEAT_LIBCALL
11521 "libcall",
11522 #endif
11523 #ifdef FEAT_LINEBREAK
11524 "linebreak",
11525 #endif
11526 #ifdef FEAT_LISP
11527 "lispindent",
11528 #endif
11529 #ifdef FEAT_LISTCMDS
11530 "listcmds",
11531 #endif
11532 #ifdef FEAT_LOCALMAP
11533 "localmap",
11534 #endif
11535 #ifdef FEAT_MENU
11536 "menu",
11537 #endif
11538 #ifdef FEAT_SESSION
11539 "mksession",
11540 #endif
11541 #ifdef FEAT_MODIFY_FNAME
11542 "modify_fname",
11543 #endif
11544 #ifdef FEAT_MOUSE
11545 "mouse",
11546 #endif
11547 #ifdef FEAT_MOUSESHAPE
11548 "mouseshape",
11549 #endif
11550 #if defined(UNIX) || defined(VMS)
11551 # ifdef FEAT_MOUSE_DEC
11552 "mouse_dec",
11553 # endif
11554 # ifdef FEAT_MOUSE_GPM
11555 "mouse_gpm",
11556 # endif
11557 # ifdef FEAT_MOUSE_JSB
11558 "mouse_jsbterm",
11559 # endif
11560 # ifdef FEAT_MOUSE_NET
11561 "mouse_netterm",
11562 # endif
11563 # ifdef FEAT_MOUSE_PTERM
11564 "mouse_pterm",
11565 # endif
11566 # ifdef FEAT_SYSMOUSE
11567 "mouse_sysmouse",
11568 # endif
11569 # ifdef FEAT_MOUSE_XTERM
11570 "mouse_xterm",
11571 # endif
11572 #endif
11573 #ifdef FEAT_MBYTE
11574 "multi_byte",
11575 #endif
11576 #ifdef FEAT_MBYTE_IME
11577 "multi_byte_ime",
11578 #endif
11579 #ifdef FEAT_MULTI_LANG
11580 "multi_lang",
11581 #endif
11582 #ifdef FEAT_MZSCHEME
11583 #ifndef DYNAMIC_MZSCHEME
11584 "mzscheme",
11585 #endif
11586 #endif
11587 #ifdef FEAT_OLE
11588 "ole",
11589 #endif
11590 #ifdef FEAT_OSFILETYPE
11591 "osfiletype",
11592 #endif
11593 #ifdef FEAT_PATH_EXTRA
11594 "path_extra",
11595 #endif
11596 #ifdef FEAT_PERL
11597 #ifndef DYNAMIC_PERL
11598 "perl",
11599 #endif
11600 #endif
11601 #ifdef FEAT_PYTHON
11602 #ifndef DYNAMIC_PYTHON
11603 "python",
11604 #endif
11605 #endif
11606 #ifdef FEAT_POSTSCRIPT
11607 "postscript",
11608 #endif
11609 #ifdef FEAT_PRINTER
11610 "printer",
11611 #endif
11612 #ifdef FEAT_PROFILE
11613 "profile",
11614 #endif
11615 #ifdef FEAT_RELTIME
11616 "reltime",
11617 #endif
11618 #ifdef FEAT_QUICKFIX
11619 "quickfix",
11620 #endif
11621 #ifdef FEAT_RIGHTLEFT
11622 "rightleft",
11623 #endif
11624 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11625 "ruby",
11626 #endif
11627 #ifdef FEAT_SCROLLBIND
11628 "scrollbind",
11629 #endif
11630 #ifdef FEAT_CMDL_INFO
11631 "showcmd",
11632 "cmdline_info",
11633 #endif
11634 #ifdef FEAT_SIGNS
11635 "signs",
11636 #endif
11637 #ifdef FEAT_SMARTINDENT
11638 "smartindent",
11639 #endif
11640 #ifdef FEAT_SNIFF
11641 "sniff",
11642 #endif
11643 #ifdef FEAT_STL_OPT
11644 "statusline",
11645 #endif
11646 #ifdef FEAT_SUN_WORKSHOP
11647 "sun_workshop",
11648 #endif
11649 #ifdef FEAT_NETBEANS_INTG
11650 "netbeans_intg",
11651 #endif
11652 #ifdef FEAT_SPELL
11653 "spell",
11654 #endif
11655 #ifdef FEAT_SYN_HL
11656 "syntax",
11657 #endif
11658 #if defined(USE_SYSTEM) || !defined(UNIX)
11659 "system",
11660 #endif
11661 #ifdef FEAT_TAG_BINS
11662 "tag_binary",
11663 #endif
11664 #ifdef FEAT_TAG_OLDSTATIC
11665 "tag_old_static",
11666 #endif
11667 #ifdef FEAT_TAG_ANYWHITE
11668 "tag_any_white",
11669 #endif
11670 #ifdef FEAT_TCL
11671 # ifndef DYNAMIC_TCL
11672 "tcl",
11673 # endif
11674 #endif
11675 #ifdef TERMINFO
11676 "terminfo",
11677 #endif
11678 #ifdef FEAT_TERMRESPONSE
11679 "termresponse",
11680 #endif
11681 #ifdef FEAT_TEXTOBJ
11682 "textobjects",
11683 #endif
11684 #ifdef HAVE_TGETENT
11685 "tgetent",
11686 #endif
11687 #ifdef FEAT_TITLE
11688 "title",
11689 #endif
11690 #ifdef FEAT_TOOLBAR
11691 "toolbar",
11692 #endif
11693 #ifdef FEAT_USR_CMDS
11694 "user-commands", /* was accidentally included in 5.4 */
11695 "user_commands",
11696 #endif
11697 #ifdef FEAT_VIMINFO
11698 "viminfo",
11699 #endif
11700 #ifdef FEAT_VERTSPLIT
11701 "vertsplit",
11702 #endif
11703 #ifdef FEAT_VIRTUALEDIT
11704 "virtualedit",
11705 #endif
11706 #ifdef FEAT_VISUAL
11707 "visual",
11708 #endif
11709 #ifdef FEAT_VISUALEXTRA
11710 "visualextra",
11711 #endif
11712 #ifdef FEAT_VREPLACE
11713 "vreplace",
11714 #endif
11715 #ifdef FEAT_WILDIGN
11716 "wildignore",
11717 #endif
11718 #ifdef FEAT_WILDMENU
11719 "wildmenu",
11720 #endif
11721 #ifdef FEAT_WINDOWS
11722 "windows",
11723 #endif
11724 #ifdef FEAT_WAK
11725 "winaltkeys",
11726 #endif
11727 #ifdef FEAT_WRITEBACKUP
11728 "writebackup",
11729 #endif
11730 #ifdef FEAT_XIM
11731 "xim",
11732 #endif
11733 #ifdef FEAT_XFONTSET
11734 "xfontset",
11735 #endif
11736 #ifdef USE_XSMP
11737 "xsmp",
11738 #endif
11739 #ifdef USE_XSMP_INTERACT
11740 "xsmp_interact",
11741 #endif
11742 #ifdef FEAT_XCLIPBOARD
11743 "xterm_clipboard",
11744 #endif
11745 #ifdef FEAT_XTERM_SAVE
11746 "xterm_save",
11747 #endif
11748 #if defined(UNIX) && defined(FEAT_X11)
11749 "X11",
11750 #endif
11751 NULL
11754 name = get_tv_string(&argvars[0]);
11755 for (i = 0; has_list[i] != NULL; ++i)
11756 if (STRICMP(name, has_list[i]) == 0)
11758 n = TRUE;
11759 break;
11762 if (n == FALSE)
11764 if (STRNICMP(name, "patch", 5) == 0)
11765 n = has_patch(atoi((char *)name + 5));
11766 else if (STRICMP(name, "vim_starting") == 0)
11767 n = (starting != 0);
11768 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11769 else if (STRICMP(name, "balloon_multiline") == 0)
11770 n = multiline_balloon_available();
11771 #endif
11772 #ifdef DYNAMIC_TCL
11773 else if (STRICMP(name, "tcl") == 0)
11774 n = tcl_enabled(FALSE);
11775 #endif
11776 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11777 else if (STRICMP(name, "iconv") == 0)
11778 n = iconv_enabled(FALSE);
11779 #endif
11780 #ifdef DYNAMIC_MZSCHEME
11781 else if (STRICMP(name, "mzscheme") == 0)
11782 n = mzscheme_enabled(FALSE);
11783 #endif
11784 #ifdef DYNAMIC_RUBY
11785 else if (STRICMP(name, "ruby") == 0)
11786 n = ruby_enabled(FALSE);
11787 #endif
11788 #ifdef DYNAMIC_PYTHON
11789 else if (STRICMP(name, "python") == 0)
11790 n = python_enabled(FALSE);
11791 #endif
11792 #ifdef DYNAMIC_PERL
11793 else if (STRICMP(name, "perl") == 0)
11794 n = perl_enabled(FALSE);
11795 #endif
11796 #ifdef FEAT_GUI
11797 else if (STRICMP(name, "gui_running") == 0)
11798 n = (gui.in_use || gui.starting);
11799 # ifdef FEAT_GUI_W32
11800 else if (STRICMP(name, "gui_win32s") == 0)
11801 n = gui_is_win32s();
11802 # endif
11803 # ifdef FEAT_BROWSE
11804 else if (STRICMP(name, "browse") == 0)
11805 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11806 # endif
11807 #endif
11808 #ifdef FEAT_SYN_HL
11809 else if (STRICMP(name, "syntax_items") == 0)
11810 n = syntax_present(curbuf);
11811 #endif
11812 #if defined(WIN3264)
11813 else if (STRICMP(name, "win95") == 0)
11814 n = mch_windows95();
11815 #endif
11816 #ifdef FEAT_NETBEANS_INTG
11817 else if (STRICMP(name, "netbeans_enabled") == 0)
11818 n = usingNetbeans;
11819 #endif
11822 rettv->vval.v_number = n;
11826 * "has_key()" function
11828 static void
11829 f_has_key(argvars, rettv)
11830 typval_T *argvars;
11831 typval_T *rettv;
11833 rettv->vval.v_number = 0;
11834 if (argvars[0].v_type != VAR_DICT)
11836 EMSG(_(e_dictreq));
11837 return;
11839 if (argvars[0].vval.v_dict == NULL)
11840 return;
11842 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11843 get_tv_string(&argvars[1]), -1) != NULL;
11847 * "haslocaldir()" function
11849 /*ARGSUSED*/
11850 static void
11851 f_haslocaldir(argvars, rettv)
11852 typval_T *argvars;
11853 typval_T *rettv;
11855 rettv->vval.v_number = (curwin->w_localdir != NULL);
11859 * "hasmapto()" function
11861 static void
11862 f_hasmapto(argvars, rettv)
11863 typval_T *argvars;
11864 typval_T *rettv;
11866 char_u *name;
11867 char_u *mode;
11868 char_u buf[NUMBUFLEN];
11869 int abbr = FALSE;
11871 name = get_tv_string(&argvars[0]);
11872 if (argvars[1].v_type == VAR_UNKNOWN)
11873 mode = (char_u *)"nvo";
11874 else
11876 mode = get_tv_string_buf(&argvars[1], buf);
11877 if (argvars[2].v_type != VAR_UNKNOWN)
11878 abbr = get_tv_number(&argvars[2]);
11881 if (map_to_exists(name, mode, abbr))
11882 rettv->vval.v_number = TRUE;
11883 else
11884 rettv->vval.v_number = FALSE;
11888 * "histadd()" function
11890 /*ARGSUSED*/
11891 static void
11892 f_histadd(argvars, rettv)
11893 typval_T *argvars;
11894 typval_T *rettv;
11896 #ifdef FEAT_CMDHIST
11897 int histype;
11898 char_u *str;
11899 char_u buf[NUMBUFLEN];
11900 #endif
11902 rettv->vval.v_number = FALSE;
11903 if (check_restricted() || check_secure())
11904 return;
11905 #ifdef FEAT_CMDHIST
11906 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11907 histype = str != NULL ? get_histtype(str) : -1;
11908 if (histype >= 0)
11910 str = get_tv_string_buf(&argvars[1], buf);
11911 if (*str != NUL)
11913 add_to_history(histype, str, FALSE, NUL);
11914 rettv->vval.v_number = TRUE;
11915 return;
11918 #endif
11922 * "histdel()" function
11924 /*ARGSUSED*/
11925 static void
11926 f_histdel(argvars, rettv)
11927 typval_T *argvars;
11928 typval_T *rettv;
11930 #ifdef FEAT_CMDHIST
11931 int n;
11932 char_u buf[NUMBUFLEN];
11933 char_u *str;
11935 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11936 if (str == NULL)
11937 n = 0;
11938 else if (argvars[1].v_type == VAR_UNKNOWN)
11939 /* only one argument: clear entire history */
11940 n = clr_history(get_histtype(str));
11941 else if (argvars[1].v_type == VAR_NUMBER)
11942 /* index given: remove that entry */
11943 n = del_history_idx(get_histtype(str),
11944 (int)get_tv_number(&argvars[1]));
11945 else
11946 /* string given: remove all matching entries */
11947 n = del_history_entry(get_histtype(str),
11948 get_tv_string_buf(&argvars[1], buf));
11949 rettv->vval.v_number = n;
11950 #else
11951 rettv->vval.v_number = 0;
11952 #endif
11956 * "histget()" function
11958 /*ARGSUSED*/
11959 static void
11960 f_histget(argvars, rettv)
11961 typval_T *argvars;
11962 typval_T *rettv;
11964 #ifdef FEAT_CMDHIST
11965 int type;
11966 int idx;
11967 char_u *str;
11969 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11970 if (str == NULL)
11971 rettv->vval.v_string = NULL;
11972 else
11974 type = get_histtype(str);
11975 if (argvars[1].v_type == VAR_UNKNOWN)
11976 idx = get_history_idx(type);
11977 else
11978 idx = (int)get_tv_number_chk(&argvars[1], NULL);
11979 /* -1 on type error */
11980 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
11982 #else
11983 rettv->vval.v_string = NULL;
11984 #endif
11985 rettv->v_type = VAR_STRING;
11989 * "histnr()" function
11991 /*ARGSUSED*/
11992 static void
11993 f_histnr(argvars, rettv)
11994 typval_T *argvars;
11995 typval_T *rettv;
11997 int i;
11999 #ifdef FEAT_CMDHIST
12000 char_u *history = get_tv_string_chk(&argvars[0]);
12002 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12003 if (i >= HIST_CMD && i < HIST_COUNT)
12004 i = get_history_idx(i);
12005 else
12006 #endif
12007 i = -1;
12008 rettv->vval.v_number = i;
12012 * "highlightID(name)" function
12014 static void
12015 f_hlID(argvars, rettv)
12016 typval_T *argvars;
12017 typval_T *rettv;
12019 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12023 * "highlight_exists()" function
12025 static void
12026 f_hlexists(argvars, rettv)
12027 typval_T *argvars;
12028 typval_T *rettv;
12030 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12034 * "hostname()" function
12036 /*ARGSUSED*/
12037 static void
12038 f_hostname(argvars, rettv)
12039 typval_T *argvars;
12040 typval_T *rettv;
12042 char_u hostname[256];
12044 mch_get_host_name(hostname, 256);
12045 rettv->v_type = VAR_STRING;
12046 rettv->vval.v_string = vim_strsave(hostname);
12050 * iconv() function
12052 /*ARGSUSED*/
12053 static void
12054 f_iconv(argvars, rettv)
12055 typval_T *argvars;
12056 typval_T *rettv;
12058 #ifdef FEAT_MBYTE
12059 char_u buf1[NUMBUFLEN];
12060 char_u buf2[NUMBUFLEN];
12061 char_u *from, *to, *str;
12062 vimconv_T vimconv;
12063 #endif
12065 rettv->v_type = VAR_STRING;
12066 rettv->vval.v_string = NULL;
12068 #ifdef FEAT_MBYTE
12069 str = get_tv_string(&argvars[0]);
12070 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12071 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12072 vimconv.vc_type = CONV_NONE;
12073 convert_setup(&vimconv, from, to);
12075 /* If the encodings are equal, no conversion needed. */
12076 if (vimconv.vc_type == CONV_NONE)
12077 rettv->vval.v_string = vim_strsave(str);
12078 else
12079 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12081 convert_setup(&vimconv, NULL, NULL);
12082 vim_free(from);
12083 vim_free(to);
12084 #endif
12088 * "indent()" function
12090 static void
12091 f_indent(argvars, rettv)
12092 typval_T *argvars;
12093 typval_T *rettv;
12095 linenr_T lnum;
12097 lnum = get_tv_lnum(argvars);
12098 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12099 rettv->vval.v_number = get_indent_lnum(lnum);
12100 else
12101 rettv->vval.v_number = -1;
12105 * "index()" function
12107 static void
12108 f_index(argvars, rettv)
12109 typval_T *argvars;
12110 typval_T *rettv;
12112 list_T *l;
12113 listitem_T *item;
12114 long idx = 0;
12115 int ic = FALSE;
12117 rettv->vval.v_number = -1;
12118 if (argvars[0].v_type != VAR_LIST)
12120 EMSG(_(e_listreq));
12121 return;
12123 l = argvars[0].vval.v_list;
12124 if (l != NULL)
12126 item = l->lv_first;
12127 if (argvars[2].v_type != VAR_UNKNOWN)
12129 int error = FALSE;
12131 /* Start at specified item. Use the cached index that list_find()
12132 * sets, so that a negative number also works. */
12133 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12134 idx = l->lv_idx;
12135 if (argvars[3].v_type != VAR_UNKNOWN)
12136 ic = get_tv_number_chk(&argvars[3], &error);
12137 if (error)
12138 item = NULL;
12141 for ( ; item != NULL; item = item->li_next, ++idx)
12142 if (tv_equal(&item->li_tv, &argvars[1], ic))
12144 rettv->vval.v_number = idx;
12145 break;
12150 static int inputsecret_flag = 0;
12152 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12155 * This function is used by f_input() and f_inputdialog() functions. The third
12156 * argument to f_input() specifies the type of completion to use at the
12157 * prompt. The third argument to f_inputdialog() specifies the value to return
12158 * when the user cancels the prompt.
12160 static void
12161 get_user_input(argvars, rettv, inputdialog)
12162 typval_T *argvars;
12163 typval_T *rettv;
12164 int inputdialog;
12166 char_u *prompt = get_tv_string_chk(&argvars[0]);
12167 char_u *p = NULL;
12168 int c;
12169 char_u buf[NUMBUFLEN];
12170 int cmd_silent_save = cmd_silent;
12171 char_u *defstr = (char_u *)"";
12172 int xp_type = EXPAND_NOTHING;
12173 char_u *xp_arg = NULL;
12175 rettv->v_type = VAR_STRING;
12176 rettv->vval.v_string = NULL;
12178 #ifdef NO_CONSOLE_INPUT
12179 /* While starting up, there is no place to enter text. */
12180 if (no_console_input())
12181 return;
12182 #endif
12184 cmd_silent = FALSE; /* Want to see the prompt. */
12185 if (prompt != NULL)
12187 /* Only the part of the message after the last NL is considered as
12188 * prompt for the command line */
12189 p = vim_strrchr(prompt, '\n');
12190 if (p == NULL)
12191 p = prompt;
12192 else
12194 ++p;
12195 c = *p;
12196 *p = NUL;
12197 msg_start();
12198 msg_clr_eos();
12199 msg_puts_attr(prompt, echo_attr);
12200 msg_didout = FALSE;
12201 msg_starthere();
12202 *p = c;
12204 cmdline_row = msg_row;
12206 if (argvars[1].v_type != VAR_UNKNOWN)
12208 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12209 if (defstr != NULL)
12210 stuffReadbuffSpec(defstr);
12212 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12214 char_u *xp_name;
12215 int xp_namelen;
12216 long argt;
12218 rettv->vval.v_string = NULL;
12220 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12221 if (xp_name == NULL)
12222 return;
12224 xp_namelen = (int)STRLEN(xp_name);
12226 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12227 &xp_arg) == FAIL)
12228 return;
12232 if (defstr != NULL)
12233 rettv->vval.v_string =
12234 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12235 xp_type, xp_arg);
12237 vim_free(xp_arg);
12239 /* since the user typed this, no need to wait for return */
12240 need_wait_return = FALSE;
12241 msg_didout = FALSE;
12243 cmd_silent = cmd_silent_save;
12247 * "input()" function
12248 * Also handles inputsecret() when inputsecret is set.
12250 static void
12251 f_input(argvars, rettv)
12252 typval_T *argvars;
12253 typval_T *rettv;
12255 get_user_input(argvars, rettv, FALSE);
12259 * "inputdialog()" function
12261 static void
12262 f_inputdialog(argvars, rettv)
12263 typval_T *argvars;
12264 typval_T *rettv;
12266 #if defined(FEAT_GUI_TEXTDIALOG)
12267 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12268 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12270 char_u *message;
12271 char_u buf[NUMBUFLEN];
12272 char_u *defstr = (char_u *)"";
12274 message = get_tv_string_chk(&argvars[0]);
12275 if (argvars[1].v_type != VAR_UNKNOWN
12276 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12277 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12278 else
12279 IObuff[0] = NUL;
12280 if (message != NULL && defstr != NULL
12281 && do_dialog(VIM_QUESTION, NULL, message,
12282 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12283 rettv->vval.v_string = vim_strsave(IObuff);
12284 else
12286 if (message != NULL && defstr != NULL
12287 && argvars[1].v_type != VAR_UNKNOWN
12288 && argvars[2].v_type != VAR_UNKNOWN)
12289 rettv->vval.v_string = vim_strsave(
12290 get_tv_string_buf(&argvars[2], buf));
12291 else
12292 rettv->vval.v_string = NULL;
12294 rettv->v_type = VAR_STRING;
12296 else
12297 #endif
12298 get_user_input(argvars, rettv, TRUE);
12302 * "inputlist()" function
12304 static void
12305 f_inputlist(argvars, rettv)
12306 typval_T *argvars;
12307 typval_T *rettv;
12309 listitem_T *li;
12310 int selected;
12311 int mouse_used;
12313 rettv->vval.v_number = 0;
12314 #ifdef NO_CONSOLE_INPUT
12315 /* While starting up, there is no place to enter text. */
12316 if (no_console_input())
12317 return;
12318 #endif
12319 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12321 EMSG2(_(e_listarg), "inputlist()");
12322 return;
12325 msg_start();
12326 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12327 lines_left = Rows; /* avoid more prompt */
12328 msg_scroll = TRUE;
12329 msg_clr_eos();
12331 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12333 msg_puts(get_tv_string(&li->li_tv));
12334 msg_putchar('\n');
12337 /* Ask for choice. */
12338 selected = prompt_for_number(&mouse_used);
12339 if (mouse_used)
12340 selected -= lines_left;
12342 rettv->vval.v_number = selected;
12346 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12349 * "inputrestore()" function
12351 /*ARGSUSED*/
12352 static void
12353 f_inputrestore(argvars, rettv)
12354 typval_T *argvars;
12355 typval_T *rettv;
12357 if (ga_userinput.ga_len > 0)
12359 --ga_userinput.ga_len;
12360 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12361 + ga_userinput.ga_len);
12362 rettv->vval.v_number = 0; /* OK */
12364 else if (p_verbose > 1)
12366 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12367 rettv->vval.v_number = 1; /* Failed */
12372 * "inputsave()" function
12374 /*ARGSUSED*/
12375 static void
12376 f_inputsave(argvars, rettv)
12377 typval_T *argvars;
12378 typval_T *rettv;
12380 /* Add an entry to the stack of typeahead storage. */
12381 if (ga_grow(&ga_userinput, 1) == OK)
12383 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12384 + ga_userinput.ga_len);
12385 ++ga_userinput.ga_len;
12386 rettv->vval.v_number = 0; /* OK */
12388 else
12389 rettv->vval.v_number = 1; /* Failed */
12393 * "inputsecret()" function
12395 static void
12396 f_inputsecret(argvars, rettv)
12397 typval_T *argvars;
12398 typval_T *rettv;
12400 ++cmdline_star;
12401 ++inputsecret_flag;
12402 f_input(argvars, rettv);
12403 --cmdline_star;
12404 --inputsecret_flag;
12408 * "insert()" function
12410 static void
12411 f_insert(argvars, rettv)
12412 typval_T *argvars;
12413 typval_T *rettv;
12415 long before = 0;
12416 listitem_T *item;
12417 list_T *l;
12418 int error = FALSE;
12420 rettv->vval.v_number = 0;
12421 if (argvars[0].v_type != VAR_LIST)
12422 EMSG2(_(e_listarg), "insert()");
12423 else if ((l = argvars[0].vval.v_list) != NULL
12424 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12426 if (argvars[2].v_type != VAR_UNKNOWN)
12427 before = get_tv_number_chk(&argvars[2], &error);
12428 if (error)
12429 return; /* type error; errmsg already given */
12431 if (before == l->lv_len)
12432 item = NULL;
12433 else
12435 item = list_find(l, before);
12436 if (item == NULL)
12438 EMSGN(_(e_listidx), before);
12439 l = NULL;
12442 if (l != NULL)
12444 list_insert_tv(l, &argvars[1], item);
12445 copy_tv(&argvars[0], rettv);
12451 * "isdirectory()" function
12453 static void
12454 f_isdirectory(argvars, rettv)
12455 typval_T *argvars;
12456 typval_T *rettv;
12458 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12462 * "islocked()" function
12464 static void
12465 f_islocked(argvars, rettv)
12466 typval_T *argvars;
12467 typval_T *rettv;
12469 lval_T lv;
12470 char_u *end;
12471 dictitem_T *di;
12473 rettv->vval.v_number = -1;
12474 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12475 FNE_CHECK_START);
12476 if (end != NULL && lv.ll_name != NULL)
12478 if (*end != NUL)
12479 EMSG(_(e_trailing));
12480 else
12482 if (lv.ll_tv == NULL)
12484 if (check_changedtick(lv.ll_name))
12485 rettv->vval.v_number = 1; /* always locked */
12486 else
12488 di = find_var(lv.ll_name, NULL);
12489 if (di != NULL)
12491 /* Consider a variable locked when:
12492 * 1. the variable itself is locked
12493 * 2. the value of the variable is locked.
12494 * 3. the List or Dict value is locked.
12496 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12497 || tv_islocked(&di->di_tv));
12501 else if (lv.ll_range)
12502 EMSG(_("E786: Range not allowed"));
12503 else if (lv.ll_newkey != NULL)
12504 EMSG2(_(e_dictkey), lv.ll_newkey);
12505 else if (lv.ll_list != NULL)
12506 /* List item. */
12507 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12508 else
12509 /* Dictionary item. */
12510 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12514 clear_lval(&lv);
12517 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12520 * Turn a dict into a list:
12521 * "what" == 0: list of keys
12522 * "what" == 1: list of values
12523 * "what" == 2: list of items
12525 static void
12526 dict_list(argvars, rettv, what)
12527 typval_T *argvars;
12528 typval_T *rettv;
12529 int what;
12531 list_T *l2;
12532 dictitem_T *di;
12533 hashitem_T *hi;
12534 listitem_T *li;
12535 listitem_T *li2;
12536 dict_T *d;
12537 int todo;
12539 rettv->vval.v_number = 0;
12540 if (argvars[0].v_type != VAR_DICT)
12542 EMSG(_(e_dictreq));
12543 return;
12545 if ((d = argvars[0].vval.v_dict) == NULL)
12546 return;
12548 if (rettv_list_alloc(rettv) == FAIL)
12549 return;
12551 todo = (int)d->dv_hashtab.ht_used;
12552 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12554 if (!HASHITEM_EMPTY(hi))
12556 --todo;
12557 di = HI2DI(hi);
12559 li = listitem_alloc();
12560 if (li == NULL)
12561 break;
12562 list_append(rettv->vval.v_list, li);
12564 if (what == 0)
12566 /* keys() */
12567 li->li_tv.v_type = VAR_STRING;
12568 li->li_tv.v_lock = 0;
12569 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12571 else if (what == 1)
12573 /* values() */
12574 copy_tv(&di->di_tv, &li->li_tv);
12576 else
12578 /* items() */
12579 l2 = list_alloc();
12580 li->li_tv.v_type = VAR_LIST;
12581 li->li_tv.v_lock = 0;
12582 li->li_tv.vval.v_list = l2;
12583 if (l2 == NULL)
12584 break;
12585 ++l2->lv_refcount;
12587 li2 = listitem_alloc();
12588 if (li2 == NULL)
12589 break;
12590 list_append(l2, li2);
12591 li2->li_tv.v_type = VAR_STRING;
12592 li2->li_tv.v_lock = 0;
12593 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12595 li2 = listitem_alloc();
12596 if (li2 == NULL)
12597 break;
12598 list_append(l2, li2);
12599 copy_tv(&di->di_tv, &li2->li_tv);
12606 * "items(dict)" function
12608 static void
12609 f_items(argvars, rettv)
12610 typval_T *argvars;
12611 typval_T *rettv;
12613 dict_list(argvars, rettv, 2);
12617 * "join()" function
12619 static void
12620 f_join(argvars, rettv)
12621 typval_T *argvars;
12622 typval_T *rettv;
12624 garray_T ga;
12625 char_u *sep;
12627 rettv->vval.v_number = 0;
12628 if (argvars[0].v_type != VAR_LIST)
12630 EMSG(_(e_listreq));
12631 return;
12633 if (argvars[0].vval.v_list == NULL)
12634 return;
12635 if (argvars[1].v_type == VAR_UNKNOWN)
12636 sep = (char_u *)" ";
12637 else
12638 sep = get_tv_string_chk(&argvars[1]);
12640 rettv->v_type = VAR_STRING;
12642 if (sep != NULL)
12644 ga_init2(&ga, (int)sizeof(char), 80);
12645 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12646 ga_append(&ga, NUL);
12647 rettv->vval.v_string = (char_u *)ga.ga_data;
12649 else
12650 rettv->vval.v_string = NULL;
12654 * "keys()" function
12656 static void
12657 f_keys(argvars, rettv)
12658 typval_T *argvars;
12659 typval_T *rettv;
12661 dict_list(argvars, rettv, 0);
12665 * "last_buffer_nr()" function.
12667 /*ARGSUSED*/
12668 static void
12669 f_last_buffer_nr(argvars, rettv)
12670 typval_T *argvars;
12671 typval_T *rettv;
12673 int n = 0;
12674 buf_T *buf;
12676 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12677 if (n < buf->b_fnum)
12678 n = buf->b_fnum;
12680 rettv->vval.v_number = n;
12684 * "len()" function
12686 static void
12687 f_len(argvars, rettv)
12688 typval_T *argvars;
12689 typval_T *rettv;
12691 switch (argvars[0].v_type)
12693 case VAR_STRING:
12694 case VAR_NUMBER:
12695 rettv->vval.v_number = (varnumber_T)STRLEN(
12696 get_tv_string(&argvars[0]));
12697 break;
12698 case VAR_LIST:
12699 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12700 break;
12701 case VAR_DICT:
12702 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12703 break;
12704 default:
12705 EMSG(_("E701: Invalid type for len()"));
12706 break;
12710 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12712 static void
12713 libcall_common(argvars, rettv, type)
12714 typval_T *argvars;
12715 typval_T *rettv;
12716 int type;
12718 #ifdef FEAT_LIBCALL
12719 char_u *string_in;
12720 char_u **string_result;
12721 int nr_result;
12722 #endif
12724 rettv->v_type = type;
12725 if (type == VAR_NUMBER)
12726 rettv->vval.v_number = 0;
12727 else
12728 rettv->vval.v_string = NULL;
12730 if (check_restricted() || check_secure())
12731 return;
12733 #ifdef FEAT_LIBCALL
12734 /* The first two args must be strings, otherwise its meaningless */
12735 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12737 string_in = NULL;
12738 if (argvars[2].v_type == VAR_STRING)
12739 string_in = argvars[2].vval.v_string;
12740 if (type == VAR_NUMBER)
12741 string_result = NULL;
12742 else
12743 string_result = &rettv->vval.v_string;
12744 if (mch_libcall(argvars[0].vval.v_string,
12745 argvars[1].vval.v_string,
12746 string_in,
12747 argvars[2].vval.v_number,
12748 string_result,
12749 &nr_result) == OK
12750 && type == VAR_NUMBER)
12751 rettv->vval.v_number = nr_result;
12753 #endif
12757 * "libcall()" function
12759 static void
12760 f_libcall(argvars, rettv)
12761 typval_T *argvars;
12762 typval_T *rettv;
12764 libcall_common(argvars, rettv, VAR_STRING);
12768 * "libcallnr()" function
12770 static void
12771 f_libcallnr(argvars, rettv)
12772 typval_T *argvars;
12773 typval_T *rettv;
12775 libcall_common(argvars, rettv, VAR_NUMBER);
12779 * "line(string)" function
12781 static void
12782 f_line(argvars, rettv)
12783 typval_T *argvars;
12784 typval_T *rettv;
12786 linenr_T lnum = 0;
12787 pos_T *fp;
12788 int fnum;
12790 fp = var2fpos(&argvars[0], TRUE, &fnum);
12791 if (fp != NULL)
12792 lnum = fp->lnum;
12793 rettv->vval.v_number = lnum;
12797 * "line2byte(lnum)" function
12799 /*ARGSUSED*/
12800 static void
12801 f_line2byte(argvars, rettv)
12802 typval_T *argvars;
12803 typval_T *rettv;
12805 #ifndef FEAT_BYTEOFF
12806 rettv->vval.v_number = -1;
12807 #else
12808 linenr_T lnum;
12810 lnum = get_tv_lnum(argvars);
12811 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12812 rettv->vval.v_number = -1;
12813 else
12814 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12815 if (rettv->vval.v_number >= 0)
12816 ++rettv->vval.v_number;
12817 #endif
12821 * "lispindent(lnum)" function
12823 static void
12824 f_lispindent(argvars, rettv)
12825 typval_T *argvars;
12826 typval_T *rettv;
12828 #ifdef FEAT_LISP
12829 pos_T pos;
12830 linenr_T lnum;
12832 pos = curwin->w_cursor;
12833 lnum = get_tv_lnum(argvars);
12834 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12836 curwin->w_cursor.lnum = lnum;
12837 rettv->vval.v_number = get_lisp_indent();
12838 curwin->w_cursor = pos;
12840 else
12841 #endif
12842 rettv->vval.v_number = -1;
12846 * "localtime()" function
12848 /*ARGSUSED*/
12849 static void
12850 f_localtime(argvars, rettv)
12851 typval_T *argvars;
12852 typval_T *rettv;
12854 rettv->vval.v_number = (varnumber_T)time(NULL);
12857 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12859 static void
12860 get_maparg(argvars, rettv, exact)
12861 typval_T *argvars;
12862 typval_T *rettv;
12863 int exact;
12865 char_u *keys;
12866 char_u *which;
12867 char_u buf[NUMBUFLEN];
12868 char_u *keys_buf = NULL;
12869 char_u *rhs;
12870 int mode;
12871 garray_T ga;
12872 int abbr = FALSE;
12874 /* return empty string for failure */
12875 rettv->v_type = VAR_STRING;
12876 rettv->vval.v_string = NULL;
12878 keys = get_tv_string(&argvars[0]);
12879 if (*keys == NUL)
12880 return;
12882 if (argvars[1].v_type != VAR_UNKNOWN)
12884 which = get_tv_string_buf_chk(&argvars[1], buf);
12885 if (argvars[2].v_type != VAR_UNKNOWN)
12886 abbr = get_tv_number(&argvars[2]);
12888 else
12889 which = (char_u *)"";
12890 if (which == NULL)
12891 return;
12893 mode = get_map_mode(&which, 0);
12895 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12896 rhs = check_map(keys, mode, exact, FALSE, abbr);
12897 vim_free(keys_buf);
12898 if (rhs != NULL)
12900 ga_init(&ga);
12901 ga.ga_itemsize = 1;
12902 ga.ga_growsize = 40;
12904 while (*rhs != NUL)
12905 ga_concat(&ga, str2special(&rhs, FALSE));
12907 ga_append(&ga, NUL);
12908 rettv->vval.v_string = (char_u *)ga.ga_data;
12912 #ifdef FEAT_FLOAT
12914 * "log10()" function
12916 static void
12917 f_log10(argvars, rettv)
12918 typval_T *argvars;
12919 typval_T *rettv;
12921 float_T f;
12923 rettv->v_type = VAR_FLOAT;
12924 if (get_float_arg(argvars, &f) == OK)
12925 rettv->vval.v_float = log10(f);
12926 else
12927 rettv->vval.v_float = 0.0;
12929 #endif
12932 * "map()" function
12934 static void
12935 f_map(argvars, rettv)
12936 typval_T *argvars;
12937 typval_T *rettv;
12939 filter_map(argvars, rettv, TRUE);
12943 * "maparg()" function
12945 static void
12946 f_maparg(argvars, rettv)
12947 typval_T *argvars;
12948 typval_T *rettv;
12950 get_maparg(argvars, rettv, TRUE);
12954 * "mapcheck()" function
12956 static void
12957 f_mapcheck(argvars, rettv)
12958 typval_T *argvars;
12959 typval_T *rettv;
12961 get_maparg(argvars, rettv, FALSE);
12964 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
12966 static void
12967 find_some_match(argvars, rettv, type)
12968 typval_T *argvars;
12969 typval_T *rettv;
12970 int type;
12972 char_u *str = NULL;
12973 char_u *expr = NULL;
12974 char_u *pat;
12975 regmatch_T regmatch;
12976 char_u patbuf[NUMBUFLEN];
12977 char_u strbuf[NUMBUFLEN];
12978 char_u *save_cpo;
12979 long start = 0;
12980 long nth = 1;
12981 colnr_T startcol = 0;
12982 int match = 0;
12983 list_T *l = NULL;
12984 listitem_T *li = NULL;
12985 long idx = 0;
12986 char_u *tofree = NULL;
12988 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
12989 save_cpo = p_cpo;
12990 p_cpo = (char_u *)"";
12992 rettv->vval.v_number = -1;
12993 if (type == 3)
12995 /* return empty list when there are no matches */
12996 if (rettv_list_alloc(rettv) == FAIL)
12997 goto theend;
12999 else if (type == 2)
13001 rettv->v_type = VAR_STRING;
13002 rettv->vval.v_string = NULL;
13005 if (argvars[0].v_type == VAR_LIST)
13007 if ((l = argvars[0].vval.v_list) == NULL)
13008 goto theend;
13009 li = l->lv_first;
13011 else
13012 expr = str = get_tv_string(&argvars[0]);
13014 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13015 if (pat == NULL)
13016 goto theend;
13018 if (argvars[2].v_type != VAR_UNKNOWN)
13020 int error = FALSE;
13022 start = get_tv_number_chk(&argvars[2], &error);
13023 if (error)
13024 goto theend;
13025 if (l != NULL)
13027 li = list_find(l, start);
13028 if (li == NULL)
13029 goto theend;
13030 idx = l->lv_idx; /* use the cached index */
13032 else
13034 if (start < 0)
13035 start = 0;
13036 if (start > (long)STRLEN(str))
13037 goto theend;
13038 /* When "count" argument is there ignore matches before "start",
13039 * otherwise skip part of the string. Differs when pattern is "^"
13040 * or "\<". */
13041 if (argvars[3].v_type != VAR_UNKNOWN)
13042 startcol = start;
13043 else
13044 str += start;
13047 if (argvars[3].v_type != VAR_UNKNOWN)
13048 nth = get_tv_number_chk(&argvars[3], &error);
13049 if (error)
13050 goto theend;
13053 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13054 if (regmatch.regprog != NULL)
13056 regmatch.rm_ic = p_ic;
13058 for (;;)
13060 if (l != NULL)
13062 if (li == NULL)
13064 match = FALSE;
13065 break;
13067 vim_free(tofree);
13068 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13069 if (str == NULL)
13070 break;
13073 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13075 if (match && --nth <= 0)
13076 break;
13077 if (l == NULL && !match)
13078 break;
13080 /* Advance to just after the match. */
13081 if (l != NULL)
13083 li = li->li_next;
13084 ++idx;
13086 else
13088 #ifdef FEAT_MBYTE
13089 startcol = (colnr_T)(regmatch.startp[0]
13090 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13091 #else
13092 startcol = regmatch.startp[0] + 1 - str;
13093 #endif
13097 if (match)
13099 if (type == 3)
13101 int i;
13103 /* return list with matched string and submatches */
13104 for (i = 0; i < NSUBEXP; ++i)
13106 if (regmatch.endp[i] == NULL)
13108 if (list_append_string(rettv->vval.v_list,
13109 (char_u *)"", 0) == FAIL)
13110 break;
13112 else if (list_append_string(rettv->vval.v_list,
13113 regmatch.startp[i],
13114 (int)(regmatch.endp[i] - regmatch.startp[i]))
13115 == FAIL)
13116 break;
13119 else if (type == 2)
13121 /* return matched string */
13122 if (l != NULL)
13123 copy_tv(&li->li_tv, rettv);
13124 else
13125 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13126 (int)(regmatch.endp[0] - regmatch.startp[0]));
13128 else if (l != NULL)
13129 rettv->vval.v_number = idx;
13130 else
13132 if (type != 0)
13133 rettv->vval.v_number =
13134 (varnumber_T)(regmatch.startp[0] - str);
13135 else
13136 rettv->vval.v_number =
13137 (varnumber_T)(regmatch.endp[0] - str);
13138 rettv->vval.v_number += (varnumber_T)(str - expr);
13141 vim_free(regmatch.regprog);
13144 theend:
13145 vim_free(tofree);
13146 p_cpo = save_cpo;
13150 * "match()" function
13152 static void
13153 f_match(argvars, rettv)
13154 typval_T *argvars;
13155 typval_T *rettv;
13157 find_some_match(argvars, rettv, 1);
13161 * "matchadd()" function
13163 static void
13164 f_matchadd(argvars, rettv)
13165 typval_T *argvars;
13166 typval_T *rettv;
13168 #ifdef FEAT_SEARCH_EXTRA
13169 char_u buf[NUMBUFLEN];
13170 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13171 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13172 int prio = 10; /* default priority */
13173 int id = -1;
13174 int error = FALSE;
13176 rettv->vval.v_number = -1;
13178 if (grp == NULL || pat == NULL)
13179 return;
13180 if (argvars[2].v_type != VAR_UNKNOWN)
13182 prio = get_tv_number_chk(&argvars[2], &error);
13183 if (argvars[3].v_type != VAR_UNKNOWN)
13184 id = get_tv_number_chk(&argvars[3], &error);
13186 if (error == TRUE)
13187 return;
13188 if (id >= 1 && id <= 3)
13190 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13191 return;
13194 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13195 #endif
13199 * "matcharg()" function
13201 static void
13202 f_matcharg(argvars, rettv)
13203 typval_T *argvars;
13204 typval_T *rettv;
13206 if (rettv_list_alloc(rettv) == OK)
13208 #ifdef FEAT_SEARCH_EXTRA
13209 int id = get_tv_number(&argvars[0]);
13210 matchitem_T *m;
13212 if (id >= 1 && id <= 3)
13214 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13216 list_append_string(rettv->vval.v_list,
13217 syn_id2name(m->hlg_id), -1);
13218 list_append_string(rettv->vval.v_list, m->pattern, -1);
13220 else
13222 list_append_string(rettv->vval.v_list, NUL, -1);
13223 list_append_string(rettv->vval.v_list, NUL, -1);
13226 #endif
13231 * "matchdelete()" function
13233 static void
13234 f_matchdelete(argvars, rettv)
13235 typval_T *argvars;
13236 typval_T *rettv;
13238 #ifdef FEAT_SEARCH_EXTRA
13239 rettv->vval.v_number = match_delete(curwin,
13240 (int)get_tv_number(&argvars[0]), TRUE);
13241 #endif
13245 * "matchend()" function
13247 static void
13248 f_matchend(argvars, rettv)
13249 typval_T *argvars;
13250 typval_T *rettv;
13252 find_some_match(argvars, rettv, 0);
13256 * "matchlist()" function
13258 static void
13259 f_matchlist(argvars, rettv)
13260 typval_T *argvars;
13261 typval_T *rettv;
13263 find_some_match(argvars, rettv, 3);
13267 * "matchstr()" function
13269 static void
13270 f_matchstr(argvars, rettv)
13271 typval_T *argvars;
13272 typval_T *rettv;
13274 find_some_match(argvars, rettv, 2);
13277 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13279 static void
13280 max_min(argvars, rettv, domax)
13281 typval_T *argvars;
13282 typval_T *rettv;
13283 int domax;
13285 long n = 0;
13286 long i;
13287 int error = FALSE;
13289 if (argvars[0].v_type == VAR_LIST)
13291 list_T *l;
13292 listitem_T *li;
13294 l = argvars[0].vval.v_list;
13295 if (l != NULL)
13297 li = l->lv_first;
13298 if (li != NULL)
13300 n = get_tv_number_chk(&li->li_tv, &error);
13301 for (;;)
13303 li = li->li_next;
13304 if (li == NULL)
13305 break;
13306 i = get_tv_number_chk(&li->li_tv, &error);
13307 if (domax ? i > n : i < n)
13308 n = i;
13313 else if (argvars[0].v_type == VAR_DICT)
13315 dict_T *d;
13316 int first = TRUE;
13317 hashitem_T *hi;
13318 int todo;
13320 d = argvars[0].vval.v_dict;
13321 if (d != NULL)
13323 todo = (int)d->dv_hashtab.ht_used;
13324 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13326 if (!HASHITEM_EMPTY(hi))
13328 --todo;
13329 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13330 if (first)
13332 n = i;
13333 first = FALSE;
13335 else if (domax ? i > n : i < n)
13336 n = i;
13341 else
13342 EMSG(_(e_listdictarg));
13343 rettv->vval.v_number = error ? 0 : n;
13347 * "max()" function
13349 static void
13350 f_max(argvars, rettv)
13351 typval_T *argvars;
13352 typval_T *rettv;
13354 max_min(argvars, rettv, TRUE);
13358 * "min()" function
13360 static void
13361 f_min(argvars, rettv)
13362 typval_T *argvars;
13363 typval_T *rettv;
13365 max_min(argvars, rettv, FALSE);
13368 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13371 * Create the directory in which "dir" is located, and higher levels when
13372 * needed.
13374 static int
13375 mkdir_recurse(dir, prot)
13376 char_u *dir;
13377 int prot;
13379 char_u *p;
13380 char_u *updir;
13381 int r = FAIL;
13383 /* Get end of directory name in "dir".
13384 * We're done when it's "/" or "c:/". */
13385 p = gettail_sep(dir);
13386 if (p <= get_past_head(dir))
13387 return OK;
13389 /* If the directory exists we're done. Otherwise: create it.*/
13390 updir = vim_strnsave(dir, (int)(p - dir));
13391 if (updir == NULL)
13392 return FAIL;
13393 if (mch_isdir(updir))
13394 r = OK;
13395 else if (mkdir_recurse(updir, prot) == OK)
13396 r = vim_mkdir_emsg(updir, prot);
13397 vim_free(updir);
13398 return r;
13401 #ifdef vim_mkdir
13403 * "mkdir()" function
13405 static void
13406 f_mkdir(argvars, rettv)
13407 typval_T *argvars;
13408 typval_T *rettv;
13410 char_u *dir;
13411 char_u buf[NUMBUFLEN];
13412 int prot = 0755;
13414 rettv->vval.v_number = FAIL;
13415 if (check_restricted() || check_secure())
13416 return;
13418 dir = get_tv_string_buf(&argvars[0], buf);
13419 if (argvars[1].v_type != VAR_UNKNOWN)
13421 if (argvars[2].v_type != VAR_UNKNOWN)
13422 prot = get_tv_number_chk(&argvars[2], NULL);
13423 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13424 mkdir_recurse(dir, prot);
13426 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13428 #endif
13431 * "mode()" function
13433 /*ARGSUSED*/
13434 static void
13435 f_mode(argvars, rettv)
13436 typval_T *argvars;
13437 typval_T *rettv;
13439 char_u buf[3];
13441 buf[1] = NUL;
13442 buf[2] = NUL;
13444 #ifdef FEAT_VISUAL
13445 if (VIsual_active)
13447 if (VIsual_select)
13448 buf[0] = VIsual_mode + 's' - 'v';
13449 else
13450 buf[0] = VIsual_mode;
13452 else
13453 #endif
13454 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13455 || State == CONFIRM)
13457 buf[0] = 'r';
13458 if (State == ASKMORE)
13459 buf[1] = 'm';
13460 else if (State == CONFIRM)
13461 buf[1] = '?';
13463 else if (State == EXTERNCMD)
13464 buf[0] = '!';
13465 else if (State & INSERT)
13467 #ifdef FEAT_VREPLACE
13468 if (State & VREPLACE_FLAG)
13470 buf[0] = 'R';
13471 buf[1] = 'v';
13473 else
13474 #endif
13475 if (State & REPLACE_FLAG)
13476 buf[0] = 'R';
13477 else
13478 buf[0] = 'i';
13480 else if (State & CMDLINE)
13482 buf[0] = 'c';
13483 if (exmode_active)
13484 buf[1] = 'v';
13486 else if (exmode_active)
13488 buf[0] = 'c';
13489 buf[1] = 'e';
13491 else
13493 buf[0] = 'n';
13494 if (finish_op)
13495 buf[1] = 'o';
13498 /* Clear out the minor mode when the argument is not a non-zero number or
13499 * non-empty string. */
13500 if (!non_zero_arg(&argvars[0]))
13501 buf[1] = NUL;
13503 rettv->vval.v_string = vim_strsave(buf);
13504 rettv->v_type = VAR_STRING;
13508 * "nextnonblank()" function
13510 static void
13511 f_nextnonblank(argvars, rettv)
13512 typval_T *argvars;
13513 typval_T *rettv;
13515 linenr_T lnum;
13517 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13519 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13521 lnum = 0;
13522 break;
13524 if (*skipwhite(ml_get(lnum)) != NUL)
13525 break;
13527 rettv->vval.v_number = lnum;
13531 * "nr2char()" function
13533 static void
13534 f_nr2char(argvars, rettv)
13535 typval_T *argvars;
13536 typval_T *rettv;
13538 char_u buf[NUMBUFLEN];
13540 #ifdef FEAT_MBYTE
13541 if (has_mbyte)
13542 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13543 else
13544 #endif
13546 buf[0] = (char_u)get_tv_number(&argvars[0]);
13547 buf[1] = NUL;
13549 rettv->v_type = VAR_STRING;
13550 rettv->vval.v_string = vim_strsave(buf);
13554 * "pathshorten()" function
13556 static void
13557 f_pathshorten(argvars, rettv)
13558 typval_T *argvars;
13559 typval_T *rettv;
13561 char_u *p;
13563 rettv->v_type = VAR_STRING;
13564 p = get_tv_string_chk(&argvars[0]);
13565 if (p == NULL)
13566 rettv->vval.v_string = NULL;
13567 else
13569 p = vim_strsave(p);
13570 rettv->vval.v_string = p;
13571 if (p != NULL)
13572 shorten_dir(p);
13576 #ifdef FEAT_FLOAT
13578 * "pow()" function
13580 static void
13581 f_pow(argvars, rettv)
13582 typval_T *argvars;
13583 typval_T *rettv;
13585 float_T fx, fy;
13587 rettv->v_type = VAR_FLOAT;
13588 if (get_float_arg(argvars, &fx) == OK
13589 && get_float_arg(&argvars[1], &fy) == OK)
13590 rettv->vval.v_float = pow(fx, fy);
13591 else
13592 rettv->vval.v_float = 0.0;
13594 #endif
13597 * "prevnonblank()" function
13599 static void
13600 f_prevnonblank(argvars, rettv)
13601 typval_T *argvars;
13602 typval_T *rettv;
13604 linenr_T lnum;
13606 lnum = get_tv_lnum(argvars);
13607 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13608 lnum = 0;
13609 else
13610 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13611 --lnum;
13612 rettv->vval.v_number = lnum;
13615 #ifdef HAVE_STDARG_H
13616 /* This dummy va_list is here because:
13617 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13618 * - locally in the function results in a "used before set" warning
13619 * - using va_start() to initialize it gives "function with fixed args" error */
13620 static va_list ap;
13621 #endif
13624 * "printf()" function
13626 static void
13627 f_printf(argvars, rettv)
13628 typval_T *argvars;
13629 typval_T *rettv;
13631 rettv->v_type = VAR_STRING;
13632 rettv->vval.v_string = NULL;
13633 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13635 char_u buf[NUMBUFLEN];
13636 int len;
13637 char_u *s;
13638 int saved_did_emsg = did_emsg;
13639 char *fmt;
13641 /* Get the required length, allocate the buffer and do it for real. */
13642 did_emsg = FALSE;
13643 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13644 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13645 if (!did_emsg)
13647 s = alloc(len + 1);
13648 if (s != NULL)
13650 rettv->vval.v_string = s;
13651 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13654 did_emsg |= saved_did_emsg;
13656 #endif
13660 * "pumvisible()" function
13662 /*ARGSUSED*/
13663 static void
13664 f_pumvisible(argvars, rettv)
13665 typval_T *argvars;
13666 typval_T *rettv;
13668 rettv->vval.v_number = 0;
13669 #ifdef FEAT_INS_EXPAND
13670 if (pum_visible())
13671 rettv->vval.v_number = 1;
13672 #endif
13676 * "range()" function
13678 static void
13679 f_range(argvars, rettv)
13680 typval_T *argvars;
13681 typval_T *rettv;
13683 long start;
13684 long end;
13685 long stride = 1;
13686 long i;
13687 int error = FALSE;
13689 start = get_tv_number_chk(&argvars[0], &error);
13690 if (argvars[1].v_type == VAR_UNKNOWN)
13692 end = start - 1;
13693 start = 0;
13695 else
13697 end = get_tv_number_chk(&argvars[1], &error);
13698 if (argvars[2].v_type != VAR_UNKNOWN)
13699 stride = get_tv_number_chk(&argvars[2], &error);
13702 rettv->vval.v_number = 0;
13703 if (error)
13704 return; /* type error; errmsg already given */
13705 if (stride == 0)
13706 EMSG(_("E726: Stride is zero"));
13707 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13708 EMSG(_("E727: Start past end"));
13709 else
13711 if (rettv_list_alloc(rettv) == OK)
13712 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13713 if (list_append_number(rettv->vval.v_list,
13714 (varnumber_T)i) == FAIL)
13715 break;
13720 * "readfile()" function
13722 static void
13723 f_readfile(argvars, rettv)
13724 typval_T *argvars;
13725 typval_T *rettv;
13727 int binary = FALSE;
13728 char_u *fname;
13729 FILE *fd;
13730 listitem_T *li;
13731 #define FREAD_SIZE 200 /* optimized for text lines */
13732 char_u buf[FREAD_SIZE];
13733 int readlen; /* size of last fread() */
13734 int buflen; /* nr of valid chars in buf[] */
13735 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13736 int tolist; /* first byte in buf[] still to be put in list */
13737 int chop; /* how many CR to chop off */
13738 char_u *prev = NULL; /* previously read bytes, if any */
13739 int prevlen = 0; /* length of "prev" if not NULL */
13740 char_u *s;
13741 int len;
13742 long maxline = MAXLNUM;
13743 long cnt = 0;
13745 if (argvars[1].v_type != VAR_UNKNOWN)
13747 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13748 binary = TRUE;
13749 if (argvars[2].v_type != VAR_UNKNOWN)
13750 maxline = get_tv_number(&argvars[2]);
13753 if (rettv_list_alloc(rettv) == FAIL)
13754 return;
13756 /* Always open the file in binary mode, library functions have a mind of
13757 * their own about CR-LF conversion. */
13758 fname = get_tv_string(&argvars[0]);
13759 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13761 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13762 return;
13765 filtd = 0;
13766 while (cnt < maxline || maxline < 0)
13768 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13769 buflen = filtd + readlen;
13770 tolist = 0;
13771 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13773 if (buf[filtd] == '\n' || readlen <= 0)
13775 /* Only when in binary mode add an empty list item when the
13776 * last line ends in a '\n'. */
13777 if (!binary && readlen == 0 && filtd == 0)
13778 break;
13780 /* Found end-of-line or end-of-file: add a text line to the
13781 * list. */
13782 chop = 0;
13783 if (!binary)
13784 while (filtd - chop - 1 >= tolist
13785 && buf[filtd - chop - 1] == '\r')
13786 ++chop;
13787 len = filtd - tolist - chop;
13788 if (prev == NULL)
13789 s = vim_strnsave(buf + tolist, len);
13790 else
13792 s = alloc((unsigned)(prevlen + len + 1));
13793 if (s != NULL)
13795 mch_memmove(s, prev, prevlen);
13796 vim_free(prev);
13797 prev = NULL;
13798 mch_memmove(s + prevlen, buf + tolist, len);
13799 s[prevlen + len] = NUL;
13802 tolist = filtd + 1;
13804 li = listitem_alloc();
13805 if (li == NULL)
13807 vim_free(s);
13808 break;
13810 li->li_tv.v_type = VAR_STRING;
13811 li->li_tv.v_lock = 0;
13812 li->li_tv.vval.v_string = s;
13813 list_append(rettv->vval.v_list, li);
13815 if (++cnt >= maxline && maxline >= 0)
13816 break;
13817 if (readlen <= 0)
13818 break;
13820 else if (buf[filtd] == NUL)
13821 buf[filtd] = '\n';
13823 if (readlen <= 0)
13824 break;
13826 if (tolist == 0)
13828 /* "buf" is full, need to move text to an allocated buffer */
13829 if (prev == NULL)
13831 prev = vim_strnsave(buf, buflen);
13832 prevlen = buflen;
13834 else
13836 s = alloc((unsigned)(prevlen + buflen));
13837 if (s != NULL)
13839 mch_memmove(s, prev, prevlen);
13840 mch_memmove(s + prevlen, buf, buflen);
13841 vim_free(prev);
13842 prev = s;
13843 prevlen += buflen;
13846 filtd = 0;
13848 else
13850 mch_memmove(buf, buf + tolist, buflen - tolist);
13851 filtd -= tolist;
13856 * For a negative line count use only the lines at the end of the file,
13857 * free the rest.
13859 if (maxline < 0)
13860 while (cnt > -maxline)
13862 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13863 --cnt;
13866 vim_free(prev);
13867 fclose(fd);
13870 #if defined(FEAT_RELTIME)
13871 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13874 * Convert a List to proftime_T.
13875 * Return FAIL when there is something wrong.
13877 static int
13878 list2proftime(arg, tm)
13879 typval_T *arg;
13880 proftime_T *tm;
13882 long n1, n2;
13883 int error = FALSE;
13885 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13886 || arg->vval.v_list->lv_len != 2)
13887 return FAIL;
13888 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13889 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13890 # ifdef WIN3264
13891 tm->HighPart = n1;
13892 tm->LowPart = n2;
13893 # else
13894 tm->tv_sec = n1;
13895 tm->tv_usec = n2;
13896 # endif
13897 return error ? FAIL : OK;
13899 #endif /* FEAT_RELTIME */
13902 * "reltime()" function
13904 static void
13905 f_reltime(argvars, rettv)
13906 typval_T *argvars;
13907 typval_T *rettv;
13909 #ifdef FEAT_RELTIME
13910 proftime_T res;
13911 proftime_T start;
13913 if (argvars[0].v_type == VAR_UNKNOWN)
13915 /* No arguments: get current time. */
13916 profile_start(&res);
13918 else if (argvars[1].v_type == VAR_UNKNOWN)
13920 if (list2proftime(&argvars[0], &res) == FAIL)
13921 return;
13922 profile_end(&res);
13924 else
13926 /* Two arguments: compute the difference. */
13927 if (list2proftime(&argvars[0], &start) == FAIL
13928 || list2proftime(&argvars[1], &res) == FAIL)
13929 return;
13930 profile_sub(&res, &start);
13933 if (rettv_list_alloc(rettv) == OK)
13935 long n1, n2;
13937 # ifdef WIN3264
13938 n1 = res.HighPart;
13939 n2 = res.LowPart;
13940 # else
13941 n1 = res.tv_sec;
13942 n2 = res.tv_usec;
13943 # endif
13944 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
13945 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
13947 #endif
13951 * "reltimestr()" function
13953 static void
13954 f_reltimestr(argvars, rettv)
13955 typval_T *argvars;
13956 typval_T *rettv;
13958 #ifdef FEAT_RELTIME
13959 proftime_T tm;
13960 #endif
13962 rettv->v_type = VAR_STRING;
13963 rettv->vval.v_string = NULL;
13964 #ifdef FEAT_RELTIME
13965 if (list2proftime(&argvars[0], &tm) == OK)
13966 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
13967 #endif
13970 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
13971 static void make_connection __ARGS((void));
13972 static int check_connection __ARGS((void));
13974 static void
13975 make_connection()
13977 if (X_DISPLAY == NULL
13978 # ifdef FEAT_GUI
13979 && !gui.in_use
13980 # endif
13983 x_force_connect = TRUE;
13984 setup_term_clip();
13985 x_force_connect = FALSE;
13989 static int
13990 check_connection()
13992 make_connection();
13993 if (X_DISPLAY == NULL)
13995 EMSG(_("E240: No connection to Vim server"));
13996 return FAIL;
13998 return OK;
14000 #endif
14002 #ifdef FEAT_CLIENTSERVER
14003 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14005 static void
14006 remote_common(argvars, rettv, expr)
14007 typval_T *argvars;
14008 typval_T *rettv;
14009 int expr;
14011 char_u *server_name;
14012 char_u *keys;
14013 char_u *r = NULL;
14014 char_u buf[NUMBUFLEN];
14015 # ifdef WIN32
14016 HWND w;
14017 # else
14018 Window w;
14019 # endif
14021 if (check_restricted() || check_secure())
14022 return;
14024 # ifdef FEAT_X11
14025 if (check_connection() == FAIL)
14026 return;
14027 # endif
14029 server_name = get_tv_string_chk(&argvars[0]);
14030 if (server_name == NULL)
14031 return; /* type error; errmsg already given */
14032 keys = get_tv_string_buf(&argvars[1], buf);
14033 # ifdef WIN32
14034 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14035 # else
14036 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14037 < 0)
14038 # endif
14040 if (r != NULL)
14041 EMSG(r); /* sending worked but evaluation failed */
14042 else
14043 EMSG2(_("E241: Unable to send to %s"), server_name);
14044 return;
14047 rettv->vval.v_string = r;
14049 if (argvars[2].v_type != VAR_UNKNOWN)
14051 dictitem_T v;
14052 char_u str[30];
14053 char_u *idvar;
14055 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14056 v.di_tv.v_type = VAR_STRING;
14057 v.di_tv.vval.v_string = vim_strsave(str);
14058 idvar = get_tv_string_chk(&argvars[2]);
14059 if (idvar != NULL)
14060 set_var(idvar, &v.di_tv, FALSE);
14061 vim_free(v.di_tv.vval.v_string);
14064 #endif
14067 * "remote_expr()" function
14069 /*ARGSUSED*/
14070 static void
14071 f_remote_expr(argvars, rettv)
14072 typval_T *argvars;
14073 typval_T *rettv;
14075 rettv->v_type = VAR_STRING;
14076 rettv->vval.v_string = NULL;
14077 #ifdef FEAT_CLIENTSERVER
14078 remote_common(argvars, rettv, TRUE);
14079 #endif
14083 * "remote_foreground()" function
14085 /*ARGSUSED*/
14086 static void
14087 f_remote_foreground(argvars, rettv)
14088 typval_T *argvars;
14089 typval_T *rettv;
14091 rettv->vval.v_number = 0;
14092 #ifdef FEAT_CLIENTSERVER
14093 # ifdef WIN32
14094 /* On Win32 it's done in this application. */
14096 char_u *server_name = get_tv_string_chk(&argvars[0]);
14098 if (server_name != NULL)
14099 serverForeground(server_name);
14101 # else
14102 /* Send a foreground() expression to the server. */
14103 argvars[1].v_type = VAR_STRING;
14104 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14105 argvars[2].v_type = VAR_UNKNOWN;
14106 remote_common(argvars, rettv, TRUE);
14107 vim_free(argvars[1].vval.v_string);
14108 # endif
14109 #endif
14112 /*ARGSUSED*/
14113 static void
14114 f_remote_peek(argvars, rettv)
14115 typval_T *argvars;
14116 typval_T *rettv;
14118 #ifdef FEAT_CLIENTSERVER
14119 dictitem_T v;
14120 char_u *s = NULL;
14121 # ifdef WIN32
14122 long_u n = 0;
14123 # endif
14124 char_u *serverid;
14126 if (check_restricted() || check_secure())
14128 rettv->vval.v_number = -1;
14129 return;
14131 serverid = get_tv_string_chk(&argvars[0]);
14132 if (serverid == NULL)
14134 rettv->vval.v_number = -1;
14135 return; /* type error; errmsg already given */
14137 # ifdef WIN32
14138 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14139 if (n == 0)
14140 rettv->vval.v_number = -1;
14141 else
14143 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14144 rettv->vval.v_number = (s != NULL);
14146 # else
14147 rettv->vval.v_number = 0;
14148 if (check_connection() == FAIL)
14149 return;
14151 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14152 serverStrToWin(serverid), &s);
14153 # endif
14155 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14157 char_u *retvar;
14159 v.di_tv.v_type = VAR_STRING;
14160 v.di_tv.vval.v_string = vim_strsave(s);
14161 retvar = get_tv_string_chk(&argvars[1]);
14162 if (retvar != NULL)
14163 set_var(retvar, &v.di_tv, FALSE);
14164 vim_free(v.di_tv.vval.v_string);
14166 #else
14167 rettv->vval.v_number = -1;
14168 #endif
14171 /*ARGSUSED*/
14172 static void
14173 f_remote_read(argvars, rettv)
14174 typval_T *argvars;
14175 typval_T *rettv;
14177 char_u *r = NULL;
14179 #ifdef FEAT_CLIENTSERVER
14180 char_u *serverid = get_tv_string_chk(&argvars[0]);
14182 if (serverid != NULL && !check_restricted() && !check_secure())
14184 # ifdef WIN32
14185 /* The server's HWND is encoded in the 'id' parameter */
14186 long_u n = 0;
14188 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14189 if (n != 0)
14190 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14191 if (r == NULL)
14192 # else
14193 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14194 serverStrToWin(serverid), &r, FALSE) < 0)
14195 # endif
14196 EMSG(_("E277: Unable to read a server reply"));
14198 #endif
14199 rettv->v_type = VAR_STRING;
14200 rettv->vval.v_string = r;
14204 * "remote_send()" function
14206 /*ARGSUSED*/
14207 static void
14208 f_remote_send(argvars, rettv)
14209 typval_T *argvars;
14210 typval_T *rettv;
14212 rettv->v_type = VAR_STRING;
14213 rettv->vval.v_string = NULL;
14214 #ifdef FEAT_CLIENTSERVER
14215 remote_common(argvars, rettv, FALSE);
14216 #endif
14220 * "remove()" function
14222 static void
14223 f_remove(argvars, rettv)
14224 typval_T *argvars;
14225 typval_T *rettv;
14227 list_T *l;
14228 listitem_T *item, *item2;
14229 listitem_T *li;
14230 long idx;
14231 long end;
14232 char_u *key;
14233 dict_T *d;
14234 dictitem_T *di;
14236 rettv->vval.v_number = 0;
14237 if (argvars[0].v_type == VAR_DICT)
14239 if (argvars[2].v_type != VAR_UNKNOWN)
14240 EMSG2(_(e_toomanyarg), "remove()");
14241 else if ((d = argvars[0].vval.v_dict) != NULL
14242 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14244 key = get_tv_string_chk(&argvars[1]);
14245 if (key != NULL)
14247 di = dict_find(d, key, -1);
14248 if (di == NULL)
14249 EMSG2(_(e_dictkey), key);
14250 else
14252 *rettv = di->di_tv;
14253 init_tv(&di->di_tv);
14254 dictitem_remove(d, di);
14259 else if (argvars[0].v_type != VAR_LIST)
14260 EMSG2(_(e_listdictarg), "remove()");
14261 else if ((l = argvars[0].vval.v_list) != NULL
14262 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14264 int error = FALSE;
14266 idx = get_tv_number_chk(&argvars[1], &error);
14267 if (error)
14268 ; /* type error: do nothing, errmsg already given */
14269 else if ((item = list_find(l, idx)) == NULL)
14270 EMSGN(_(e_listidx), idx);
14271 else
14273 if (argvars[2].v_type == VAR_UNKNOWN)
14275 /* Remove one item, return its value. */
14276 list_remove(l, item, item);
14277 *rettv = item->li_tv;
14278 vim_free(item);
14280 else
14282 /* Remove range of items, return list with values. */
14283 end = get_tv_number_chk(&argvars[2], &error);
14284 if (error)
14285 ; /* type error: do nothing */
14286 else if ((item2 = list_find(l, end)) == NULL)
14287 EMSGN(_(e_listidx), end);
14288 else
14290 int cnt = 0;
14292 for (li = item; li != NULL; li = li->li_next)
14294 ++cnt;
14295 if (li == item2)
14296 break;
14298 if (li == NULL) /* didn't find "item2" after "item" */
14299 EMSG(_(e_invrange));
14300 else
14302 list_remove(l, item, item2);
14303 if (rettv_list_alloc(rettv) == OK)
14305 l = rettv->vval.v_list;
14306 l->lv_first = item;
14307 l->lv_last = item2;
14308 item->li_prev = NULL;
14309 item2->li_next = NULL;
14310 l->lv_len = cnt;
14320 * "rename({from}, {to})" function
14322 static void
14323 f_rename(argvars, rettv)
14324 typval_T *argvars;
14325 typval_T *rettv;
14327 char_u buf[NUMBUFLEN];
14329 if (check_restricted() || check_secure())
14330 rettv->vval.v_number = -1;
14331 else
14332 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14333 get_tv_string_buf(&argvars[1], buf));
14337 * "repeat()" function
14339 /*ARGSUSED*/
14340 static void
14341 f_repeat(argvars, rettv)
14342 typval_T *argvars;
14343 typval_T *rettv;
14345 char_u *p;
14346 int n;
14347 int slen;
14348 int len;
14349 char_u *r;
14350 int i;
14352 n = get_tv_number(&argvars[1]);
14353 if (argvars[0].v_type == VAR_LIST)
14355 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14356 while (n-- > 0)
14357 if (list_extend(rettv->vval.v_list,
14358 argvars[0].vval.v_list, NULL) == FAIL)
14359 break;
14361 else
14363 p = get_tv_string(&argvars[0]);
14364 rettv->v_type = VAR_STRING;
14365 rettv->vval.v_string = NULL;
14367 slen = (int)STRLEN(p);
14368 len = slen * n;
14369 if (len <= 0)
14370 return;
14372 r = alloc(len + 1);
14373 if (r != NULL)
14375 for (i = 0; i < n; i++)
14376 mch_memmove(r + i * slen, p, (size_t)slen);
14377 r[len] = NUL;
14380 rettv->vval.v_string = r;
14385 * "resolve()" function
14387 static void
14388 f_resolve(argvars, rettv)
14389 typval_T *argvars;
14390 typval_T *rettv;
14392 char_u *p;
14394 p = get_tv_string(&argvars[0]);
14395 #ifdef FEAT_SHORTCUT
14397 char_u *v = NULL;
14399 v = mch_resolve_shortcut(p);
14400 if (v != NULL)
14401 rettv->vval.v_string = v;
14402 else
14403 rettv->vval.v_string = vim_strsave(p);
14405 #else
14406 # ifdef HAVE_READLINK
14408 char_u buf[MAXPATHL + 1];
14409 char_u *cpy;
14410 int len;
14411 char_u *remain = NULL;
14412 char_u *q;
14413 int is_relative_to_current = FALSE;
14414 int has_trailing_pathsep = FALSE;
14415 int limit = 100;
14417 p = vim_strsave(p);
14419 if (p[0] == '.' && (vim_ispathsep(p[1])
14420 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14421 is_relative_to_current = TRUE;
14423 len = STRLEN(p);
14424 if (len > 0 && after_pathsep(p, p + len))
14425 has_trailing_pathsep = TRUE;
14427 q = getnextcomp(p);
14428 if (*q != NUL)
14430 /* Separate the first path component in "p", and keep the
14431 * remainder (beginning with the path separator). */
14432 remain = vim_strsave(q - 1);
14433 q[-1] = NUL;
14436 for (;;)
14438 for (;;)
14440 len = readlink((char *)p, (char *)buf, MAXPATHL);
14441 if (len <= 0)
14442 break;
14443 buf[len] = NUL;
14445 if (limit-- == 0)
14447 vim_free(p);
14448 vim_free(remain);
14449 EMSG(_("E655: Too many symbolic links (cycle?)"));
14450 rettv->vval.v_string = NULL;
14451 goto fail;
14454 /* Ensure that the result will have a trailing path separator
14455 * if the argument has one. */
14456 if (remain == NULL && has_trailing_pathsep)
14457 add_pathsep(buf);
14459 /* Separate the first path component in the link value and
14460 * concatenate the remainders. */
14461 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14462 if (*q != NUL)
14464 if (remain == NULL)
14465 remain = vim_strsave(q - 1);
14466 else
14468 cpy = concat_str(q - 1, remain);
14469 if (cpy != NULL)
14471 vim_free(remain);
14472 remain = cpy;
14475 q[-1] = NUL;
14478 q = gettail(p);
14479 if (q > p && *q == NUL)
14481 /* Ignore trailing path separator. */
14482 q[-1] = NUL;
14483 q = gettail(p);
14485 if (q > p && !mch_isFullName(buf))
14487 /* symlink is relative to directory of argument */
14488 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14489 if (cpy != NULL)
14491 STRCPY(cpy, p);
14492 STRCPY(gettail(cpy), buf);
14493 vim_free(p);
14494 p = cpy;
14497 else
14499 vim_free(p);
14500 p = vim_strsave(buf);
14504 if (remain == NULL)
14505 break;
14507 /* Append the first path component of "remain" to "p". */
14508 q = getnextcomp(remain + 1);
14509 len = q - remain - (*q != NUL);
14510 cpy = vim_strnsave(p, STRLEN(p) + len);
14511 if (cpy != NULL)
14513 STRNCAT(cpy, remain, len);
14514 vim_free(p);
14515 p = cpy;
14517 /* Shorten "remain". */
14518 if (*q != NUL)
14519 STRMOVE(remain, q - 1);
14520 else
14522 vim_free(remain);
14523 remain = NULL;
14527 /* If the result is a relative path name, make it explicitly relative to
14528 * the current directory if and only if the argument had this form. */
14529 if (!vim_ispathsep(*p))
14531 if (is_relative_to_current
14532 && *p != NUL
14533 && !(p[0] == '.'
14534 && (p[1] == NUL
14535 || vim_ispathsep(p[1])
14536 || (p[1] == '.'
14537 && (p[2] == NUL
14538 || vim_ispathsep(p[2]))))))
14540 /* Prepend "./". */
14541 cpy = concat_str((char_u *)"./", p);
14542 if (cpy != NULL)
14544 vim_free(p);
14545 p = cpy;
14548 else if (!is_relative_to_current)
14550 /* Strip leading "./". */
14551 q = p;
14552 while (q[0] == '.' && vim_ispathsep(q[1]))
14553 q += 2;
14554 if (q > p)
14555 STRMOVE(p, p + 2);
14559 /* Ensure that the result will have no trailing path separator
14560 * if the argument had none. But keep "/" or "//". */
14561 if (!has_trailing_pathsep)
14563 q = p + STRLEN(p);
14564 if (after_pathsep(p, q))
14565 *gettail_sep(p) = NUL;
14568 rettv->vval.v_string = p;
14570 # else
14571 rettv->vval.v_string = vim_strsave(p);
14572 # endif
14573 #endif
14575 simplify_filename(rettv->vval.v_string);
14577 #ifdef HAVE_READLINK
14578 fail:
14579 #endif
14580 rettv->v_type = VAR_STRING;
14584 * "reverse({list})" function
14586 static void
14587 f_reverse(argvars, rettv)
14588 typval_T *argvars;
14589 typval_T *rettv;
14591 list_T *l;
14592 listitem_T *li, *ni;
14594 rettv->vval.v_number = 0;
14595 if (argvars[0].v_type != VAR_LIST)
14596 EMSG2(_(e_listarg), "reverse()");
14597 else if ((l = argvars[0].vval.v_list) != NULL
14598 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14600 li = l->lv_last;
14601 l->lv_first = l->lv_last = NULL;
14602 l->lv_len = 0;
14603 while (li != NULL)
14605 ni = li->li_prev;
14606 list_append(l, li);
14607 li = ni;
14609 rettv->vval.v_list = l;
14610 rettv->v_type = VAR_LIST;
14611 ++l->lv_refcount;
14612 l->lv_idx = l->lv_len - l->lv_idx - 1;
14616 #define SP_NOMOVE 0x01 /* don't move cursor */
14617 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14618 #define SP_RETCOUNT 0x04 /* return matchcount */
14619 #define SP_SETPCMARK 0x08 /* set previous context mark */
14620 #define SP_START 0x10 /* accept match at start position */
14621 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14622 #define SP_END 0x40 /* leave cursor at end of match */
14624 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14627 * Get flags for a search function.
14628 * Possibly sets "p_ws".
14629 * Returns BACKWARD, FORWARD or zero (for an error).
14631 static int
14632 get_search_arg(varp, flagsp)
14633 typval_T *varp;
14634 int *flagsp;
14636 int dir = FORWARD;
14637 char_u *flags;
14638 char_u nbuf[NUMBUFLEN];
14639 int mask;
14641 if (varp->v_type != VAR_UNKNOWN)
14643 flags = get_tv_string_buf_chk(varp, nbuf);
14644 if (flags == NULL)
14645 return 0; /* type error; errmsg already given */
14646 while (*flags != NUL)
14648 switch (*flags)
14650 case 'b': dir = BACKWARD; break;
14651 case 'w': p_ws = TRUE; break;
14652 case 'W': p_ws = FALSE; break;
14653 default: mask = 0;
14654 if (flagsp != NULL)
14655 switch (*flags)
14657 case 'c': mask = SP_START; break;
14658 case 'e': mask = SP_END; break;
14659 case 'm': mask = SP_RETCOUNT; break;
14660 case 'n': mask = SP_NOMOVE; break;
14661 case 'p': mask = SP_SUBPAT; break;
14662 case 'r': mask = SP_REPEAT; break;
14663 case 's': mask = SP_SETPCMARK; break;
14665 if (mask == 0)
14667 EMSG2(_(e_invarg2), flags);
14668 dir = 0;
14670 else
14671 *flagsp |= mask;
14673 if (dir == 0)
14674 break;
14675 ++flags;
14678 return dir;
14682 * Shared by search() and searchpos() functions
14684 static int
14685 search_cmn(argvars, match_pos, flagsp)
14686 typval_T *argvars;
14687 pos_T *match_pos;
14688 int *flagsp;
14690 int flags;
14691 char_u *pat;
14692 pos_T pos;
14693 pos_T save_cursor;
14694 int save_p_ws = p_ws;
14695 int dir;
14696 int retval = 0; /* default: FAIL */
14697 long lnum_stop = 0;
14698 proftime_T tm;
14699 #ifdef FEAT_RELTIME
14700 long time_limit = 0;
14701 #endif
14702 int options = SEARCH_KEEP;
14703 int subpatnum;
14705 pat = get_tv_string(&argvars[0]);
14706 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14707 if (dir == 0)
14708 goto theend;
14709 flags = *flagsp;
14710 if (flags & SP_START)
14711 options |= SEARCH_START;
14712 if (flags & SP_END)
14713 options |= SEARCH_END;
14715 /* Optional arguments: line number to stop searching and timeout. */
14716 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14718 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14719 if (lnum_stop < 0)
14720 goto theend;
14721 #ifdef FEAT_RELTIME
14722 if (argvars[3].v_type != VAR_UNKNOWN)
14724 time_limit = get_tv_number_chk(&argvars[3], NULL);
14725 if (time_limit < 0)
14726 goto theend;
14728 #endif
14731 #ifdef FEAT_RELTIME
14732 /* Set the time limit, if there is one. */
14733 profile_setlimit(time_limit, &tm);
14734 #endif
14737 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14738 * Check to make sure only those flags are set.
14739 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14740 * flags cannot be set. Check for that condition also.
14742 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14743 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14745 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14746 goto theend;
14749 pos = save_cursor = curwin->w_cursor;
14750 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14751 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14752 if (subpatnum != FAIL)
14754 if (flags & SP_SUBPAT)
14755 retval = subpatnum;
14756 else
14757 retval = pos.lnum;
14758 if (flags & SP_SETPCMARK)
14759 setpcmark();
14760 curwin->w_cursor = pos;
14761 if (match_pos != NULL)
14763 /* Store the match cursor position */
14764 match_pos->lnum = pos.lnum;
14765 match_pos->col = pos.col + 1;
14767 /* "/$" will put the cursor after the end of the line, may need to
14768 * correct that here */
14769 check_cursor();
14772 /* If 'n' flag is used: restore cursor position. */
14773 if (flags & SP_NOMOVE)
14774 curwin->w_cursor = save_cursor;
14775 else
14776 curwin->w_set_curswant = TRUE;
14777 theend:
14778 p_ws = save_p_ws;
14780 return retval;
14783 #ifdef FEAT_FLOAT
14785 * "round({float})" function
14787 static void
14788 f_round(argvars, rettv)
14789 typval_T *argvars;
14790 typval_T *rettv;
14792 float_T f;
14794 rettv->v_type = VAR_FLOAT;
14795 if (get_float_arg(argvars, &f) == OK)
14796 /* round() is not in C90, use ceil() or floor() instead. */
14797 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14798 else
14799 rettv->vval.v_float = 0.0;
14801 #endif
14804 * "search()" function
14806 static void
14807 f_search(argvars, rettv)
14808 typval_T *argvars;
14809 typval_T *rettv;
14811 int flags = 0;
14813 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14817 * "searchdecl()" function
14819 static void
14820 f_searchdecl(argvars, rettv)
14821 typval_T *argvars;
14822 typval_T *rettv;
14824 int locally = 1;
14825 int thisblock = 0;
14826 int error = FALSE;
14827 char_u *name;
14829 rettv->vval.v_number = 1; /* default: FAIL */
14831 name = get_tv_string_chk(&argvars[0]);
14832 if (argvars[1].v_type != VAR_UNKNOWN)
14834 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14835 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14836 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14838 if (!error && name != NULL)
14839 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14840 locally, thisblock, SEARCH_KEEP) == FAIL;
14844 * Used by searchpair() and searchpairpos()
14846 static int
14847 searchpair_cmn(argvars, match_pos)
14848 typval_T *argvars;
14849 pos_T *match_pos;
14851 char_u *spat, *mpat, *epat;
14852 char_u *skip;
14853 int save_p_ws = p_ws;
14854 int dir;
14855 int flags = 0;
14856 char_u nbuf1[NUMBUFLEN];
14857 char_u nbuf2[NUMBUFLEN];
14858 char_u nbuf3[NUMBUFLEN];
14859 int retval = 0; /* default: FAIL */
14860 long lnum_stop = 0;
14861 long time_limit = 0;
14863 /* Get the three pattern arguments: start, middle, end. */
14864 spat = get_tv_string_chk(&argvars[0]);
14865 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14866 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14867 if (spat == NULL || mpat == NULL || epat == NULL)
14868 goto theend; /* type error */
14870 /* Handle the optional fourth argument: flags */
14871 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14872 if (dir == 0)
14873 goto theend;
14875 /* Don't accept SP_END or SP_SUBPAT.
14876 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14878 if ((flags & (SP_END | SP_SUBPAT)) != 0
14879 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14881 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14882 goto theend;
14885 /* Using 'r' implies 'W', otherwise it doesn't work. */
14886 if (flags & SP_REPEAT)
14887 p_ws = FALSE;
14889 /* Optional fifth argument: skip expression */
14890 if (argvars[3].v_type == VAR_UNKNOWN
14891 || argvars[4].v_type == VAR_UNKNOWN)
14892 skip = (char_u *)"";
14893 else
14895 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14896 if (argvars[5].v_type != VAR_UNKNOWN)
14898 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
14899 if (lnum_stop < 0)
14900 goto theend;
14901 #ifdef FEAT_RELTIME
14902 if (argvars[6].v_type != VAR_UNKNOWN)
14904 time_limit = get_tv_number_chk(&argvars[6], NULL);
14905 if (time_limit < 0)
14906 goto theend;
14908 #endif
14911 if (skip == NULL)
14912 goto theend; /* type error */
14914 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
14915 match_pos, lnum_stop, time_limit);
14917 theend:
14918 p_ws = save_p_ws;
14920 return retval;
14924 * "searchpair()" function
14926 static void
14927 f_searchpair(argvars, rettv)
14928 typval_T *argvars;
14929 typval_T *rettv;
14931 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
14935 * "searchpairpos()" function
14937 static void
14938 f_searchpairpos(argvars, rettv)
14939 typval_T *argvars;
14940 typval_T *rettv;
14942 pos_T match_pos;
14943 int lnum = 0;
14944 int col = 0;
14946 rettv->vval.v_number = 0;
14948 if (rettv_list_alloc(rettv) == FAIL)
14949 return;
14951 if (searchpair_cmn(argvars, &match_pos) > 0)
14953 lnum = match_pos.lnum;
14954 col = match_pos.col;
14957 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
14958 list_append_number(rettv->vval.v_list, (varnumber_T)col);
14962 * Search for a start/middle/end thing.
14963 * Used by searchpair(), see its documentation for the details.
14964 * Returns 0 or -1 for no match,
14966 long
14967 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
14968 lnum_stop, time_limit)
14969 char_u *spat; /* start pattern */
14970 char_u *mpat; /* middle pattern */
14971 char_u *epat; /* end pattern */
14972 int dir; /* BACKWARD or FORWARD */
14973 char_u *skip; /* skip expression */
14974 int flags; /* SP_SETPCMARK and other SP_ values */
14975 pos_T *match_pos;
14976 linenr_T lnum_stop; /* stop at this line if not zero */
14977 long time_limit; /* stop after this many msec */
14979 char_u *save_cpo;
14980 char_u *pat, *pat2 = NULL, *pat3 = NULL;
14981 long retval = 0;
14982 pos_T pos;
14983 pos_T firstpos;
14984 pos_T foundpos;
14985 pos_T save_cursor;
14986 pos_T save_pos;
14987 int n;
14988 int r;
14989 int nest = 1;
14990 int err;
14991 int options = SEARCH_KEEP;
14992 proftime_T tm;
14994 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
14995 save_cpo = p_cpo;
14996 p_cpo = (char_u *)"";
14998 #ifdef FEAT_RELTIME
14999 /* Set the time limit, if there is one. */
15000 profile_setlimit(time_limit, &tm);
15001 #endif
15003 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15004 * start/middle/end (pat3, for the top pair). */
15005 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15006 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15007 if (pat2 == NULL || pat3 == NULL)
15008 goto theend;
15009 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15010 if (*mpat == NUL)
15011 STRCPY(pat3, pat2);
15012 else
15013 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15014 spat, epat, mpat);
15015 if (flags & SP_START)
15016 options |= SEARCH_START;
15018 save_cursor = curwin->w_cursor;
15019 pos = curwin->w_cursor;
15020 clearpos(&firstpos);
15021 clearpos(&foundpos);
15022 pat = pat3;
15023 for (;;)
15025 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15026 options, RE_SEARCH, lnum_stop, &tm);
15027 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15028 /* didn't find it or found the first match again: FAIL */
15029 break;
15031 if (firstpos.lnum == 0)
15032 firstpos = pos;
15033 if (equalpos(pos, foundpos))
15035 /* Found the same position again. Can happen with a pattern that
15036 * has "\zs" at the end and searching backwards. Advance one
15037 * character and try again. */
15038 if (dir == BACKWARD)
15039 decl(&pos);
15040 else
15041 incl(&pos);
15043 foundpos = pos;
15045 /* clear the start flag to avoid getting stuck here */
15046 options &= ~SEARCH_START;
15048 /* If the skip pattern matches, ignore this match. */
15049 if (*skip != NUL)
15051 save_pos = curwin->w_cursor;
15052 curwin->w_cursor = pos;
15053 r = eval_to_bool(skip, &err, NULL, FALSE);
15054 curwin->w_cursor = save_pos;
15055 if (err)
15057 /* Evaluating {skip} caused an error, break here. */
15058 curwin->w_cursor = save_cursor;
15059 retval = -1;
15060 break;
15062 if (r)
15063 continue;
15066 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15068 /* Found end when searching backwards or start when searching
15069 * forward: nested pair. */
15070 ++nest;
15071 pat = pat2; /* nested, don't search for middle */
15073 else
15075 /* Found end when searching forward or start when searching
15076 * backward: end of (nested) pair; or found middle in outer pair. */
15077 if (--nest == 1)
15078 pat = pat3; /* outer level, search for middle */
15081 if (nest == 0)
15083 /* Found the match: return matchcount or line number. */
15084 if (flags & SP_RETCOUNT)
15085 ++retval;
15086 else
15087 retval = pos.lnum;
15088 if (flags & SP_SETPCMARK)
15089 setpcmark();
15090 curwin->w_cursor = pos;
15091 if (!(flags & SP_REPEAT))
15092 break;
15093 nest = 1; /* search for next unmatched */
15097 if (match_pos != NULL)
15099 /* Store the match cursor position */
15100 match_pos->lnum = curwin->w_cursor.lnum;
15101 match_pos->col = curwin->w_cursor.col + 1;
15104 /* If 'n' flag is used or search failed: restore cursor position. */
15105 if ((flags & SP_NOMOVE) || retval == 0)
15106 curwin->w_cursor = save_cursor;
15108 theend:
15109 vim_free(pat2);
15110 vim_free(pat3);
15111 p_cpo = save_cpo;
15113 return retval;
15117 * "searchpos()" function
15119 static void
15120 f_searchpos(argvars, rettv)
15121 typval_T *argvars;
15122 typval_T *rettv;
15124 pos_T match_pos;
15125 int lnum = 0;
15126 int col = 0;
15127 int n;
15128 int flags = 0;
15130 rettv->vval.v_number = 0;
15132 if (rettv_list_alloc(rettv) == FAIL)
15133 return;
15135 n = search_cmn(argvars, &match_pos, &flags);
15136 if (n > 0)
15138 lnum = match_pos.lnum;
15139 col = match_pos.col;
15142 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15143 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15144 if (flags & SP_SUBPAT)
15145 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15149 /*ARGSUSED*/
15150 static void
15151 f_server2client(argvars, rettv)
15152 typval_T *argvars;
15153 typval_T *rettv;
15155 #ifdef FEAT_CLIENTSERVER
15156 char_u buf[NUMBUFLEN];
15157 char_u *server = get_tv_string_chk(&argvars[0]);
15158 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15160 rettv->vval.v_number = -1;
15161 if (server == NULL || reply == NULL)
15162 return;
15163 if (check_restricted() || check_secure())
15164 return;
15165 # ifdef FEAT_X11
15166 if (check_connection() == FAIL)
15167 return;
15168 # endif
15170 if (serverSendReply(server, reply) < 0)
15172 EMSG(_("E258: Unable to send to client"));
15173 return;
15175 rettv->vval.v_number = 0;
15176 #else
15177 rettv->vval.v_number = -1;
15178 #endif
15181 /*ARGSUSED*/
15182 static void
15183 f_serverlist(argvars, rettv)
15184 typval_T *argvars;
15185 typval_T *rettv;
15187 char_u *r = NULL;
15189 #ifdef FEAT_CLIENTSERVER
15190 # ifdef WIN32
15191 r = serverGetVimNames();
15192 # else
15193 make_connection();
15194 if (X_DISPLAY != NULL)
15195 r = serverGetVimNames(X_DISPLAY);
15196 # endif
15197 #endif
15198 rettv->v_type = VAR_STRING;
15199 rettv->vval.v_string = r;
15203 * "setbufvar()" function
15205 /*ARGSUSED*/
15206 static void
15207 f_setbufvar(argvars, rettv)
15208 typval_T *argvars;
15209 typval_T *rettv;
15211 buf_T *buf;
15212 aco_save_T aco;
15213 char_u *varname, *bufvarname;
15214 typval_T *varp;
15215 char_u nbuf[NUMBUFLEN];
15217 rettv->vval.v_number = 0;
15219 if (check_restricted() || check_secure())
15220 return;
15221 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15222 varname = get_tv_string_chk(&argvars[1]);
15223 buf = get_buf_tv(&argvars[0]);
15224 varp = &argvars[2];
15226 if (buf != NULL && varname != NULL && varp != NULL)
15228 /* set curbuf to be our buf, temporarily */
15229 aucmd_prepbuf(&aco, buf);
15231 if (*varname == '&')
15233 long numval;
15234 char_u *strval;
15235 int error = FALSE;
15237 ++varname;
15238 numval = get_tv_number_chk(varp, &error);
15239 strval = get_tv_string_buf_chk(varp, nbuf);
15240 if (!error && strval != NULL)
15241 set_option_value(varname, numval, strval, OPT_LOCAL);
15243 else
15245 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15246 if (bufvarname != NULL)
15248 STRCPY(bufvarname, "b:");
15249 STRCPY(bufvarname + 2, varname);
15250 set_var(bufvarname, varp, TRUE);
15251 vim_free(bufvarname);
15255 /* reset notion of buffer */
15256 aucmd_restbuf(&aco);
15261 * "setcmdpos()" function
15263 static void
15264 f_setcmdpos(argvars, rettv)
15265 typval_T *argvars;
15266 typval_T *rettv;
15268 int pos = (int)get_tv_number(&argvars[0]) - 1;
15270 if (pos >= 0)
15271 rettv->vval.v_number = set_cmdline_pos(pos);
15275 * "setline()" function
15277 static void
15278 f_setline(argvars, rettv)
15279 typval_T *argvars;
15280 typval_T *rettv;
15282 linenr_T lnum;
15283 char_u *line = NULL;
15284 list_T *l = NULL;
15285 listitem_T *li = NULL;
15286 long added = 0;
15287 linenr_T lcount = curbuf->b_ml.ml_line_count;
15289 lnum = get_tv_lnum(&argvars[0]);
15290 if (argvars[1].v_type == VAR_LIST)
15292 l = argvars[1].vval.v_list;
15293 li = l->lv_first;
15295 else
15296 line = get_tv_string_chk(&argvars[1]);
15298 rettv->vval.v_number = 0; /* OK */
15299 for (;;)
15301 if (l != NULL)
15303 /* list argument, get next string */
15304 if (li == NULL)
15305 break;
15306 line = get_tv_string_chk(&li->li_tv);
15307 li = li->li_next;
15310 rettv->vval.v_number = 1; /* FAIL */
15311 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15312 break;
15313 if (lnum <= curbuf->b_ml.ml_line_count)
15315 /* existing line, replace it */
15316 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15318 changed_bytes(lnum, 0);
15319 if (lnum == curwin->w_cursor.lnum)
15320 check_cursor_col();
15321 rettv->vval.v_number = 0; /* OK */
15324 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15326 /* lnum is one past the last line, append the line */
15327 ++added;
15328 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15329 rettv->vval.v_number = 0; /* OK */
15332 if (l == NULL) /* only one string argument */
15333 break;
15334 ++lnum;
15337 if (added > 0)
15338 appended_lines_mark(lcount, added);
15341 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15344 * Used by "setqflist()" and "setloclist()" functions
15346 /*ARGSUSED*/
15347 static void
15348 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15349 win_T *wp;
15350 typval_T *list_arg;
15351 typval_T *action_arg;
15352 typval_T *rettv;
15354 #ifdef FEAT_QUICKFIX
15355 char_u *act;
15356 int action = ' ';
15357 #endif
15359 rettv->vval.v_number = -1;
15361 #ifdef FEAT_QUICKFIX
15362 if (list_arg->v_type != VAR_LIST)
15363 EMSG(_(e_listreq));
15364 else
15366 list_T *l = list_arg->vval.v_list;
15368 if (action_arg->v_type == VAR_STRING)
15370 act = get_tv_string_chk(action_arg);
15371 if (act == NULL)
15372 return; /* type error; errmsg already given */
15373 if (*act == 'a' || *act == 'r')
15374 action = *act;
15377 if (l != NULL && set_errorlist(wp, l, action) == OK)
15378 rettv->vval.v_number = 0;
15380 #endif
15384 * "setloclist()" function
15386 /*ARGSUSED*/
15387 static void
15388 f_setloclist(argvars, rettv)
15389 typval_T *argvars;
15390 typval_T *rettv;
15392 win_T *win;
15394 rettv->vval.v_number = -1;
15396 win = find_win_by_nr(&argvars[0], NULL);
15397 if (win != NULL)
15398 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15402 * "setmatches()" function
15404 static void
15405 f_setmatches(argvars, rettv)
15406 typval_T *argvars;
15407 typval_T *rettv;
15409 #ifdef FEAT_SEARCH_EXTRA
15410 list_T *l;
15411 listitem_T *li;
15412 dict_T *d;
15414 rettv->vval.v_number = -1;
15415 if (argvars[0].v_type != VAR_LIST)
15417 EMSG(_(e_listreq));
15418 return;
15420 if ((l = argvars[0].vval.v_list) != NULL)
15423 /* To some extent make sure that we are dealing with a list from
15424 * "getmatches()". */
15425 li = l->lv_first;
15426 while (li != NULL)
15428 if (li->li_tv.v_type != VAR_DICT
15429 || (d = li->li_tv.vval.v_dict) == NULL)
15431 EMSG(_(e_invarg));
15432 return;
15434 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15435 && dict_find(d, (char_u *)"pattern", -1) != NULL
15436 && dict_find(d, (char_u *)"priority", -1) != NULL
15437 && dict_find(d, (char_u *)"id", -1) != NULL))
15439 EMSG(_(e_invarg));
15440 return;
15442 li = li->li_next;
15445 clear_matches(curwin);
15446 li = l->lv_first;
15447 while (li != NULL)
15449 d = li->li_tv.vval.v_dict;
15450 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15451 get_dict_string(d, (char_u *)"pattern", FALSE),
15452 (int)get_dict_number(d, (char_u *)"priority"),
15453 (int)get_dict_number(d, (char_u *)"id"));
15454 li = li->li_next;
15456 rettv->vval.v_number = 0;
15458 #endif
15462 * "setpos()" function
15464 /*ARGSUSED*/
15465 static void
15466 f_setpos(argvars, rettv)
15467 typval_T *argvars;
15468 typval_T *rettv;
15470 pos_T pos;
15471 int fnum;
15472 char_u *name;
15474 rettv->vval.v_number = -1;
15475 name = get_tv_string_chk(argvars);
15476 if (name != NULL)
15478 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15480 --pos.col;
15481 if (name[0] == '.' && name[1] == NUL)
15483 /* set cursor */
15484 if (fnum == curbuf->b_fnum)
15486 curwin->w_cursor = pos;
15487 check_cursor();
15488 rettv->vval.v_number = 0;
15490 else
15491 EMSG(_(e_invarg));
15493 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15495 /* set mark */
15496 if (setmark_pos(name[1], &pos, fnum) == OK)
15497 rettv->vval.v_number = 0;
15499 else
15500 EMSG(_(e_invarg));
15506 * "setqflist()" function
15508 /*ARGSUSED*/
15509 static void
15510 f_setqflist(argvars, rettv)
15511 typval_T *argvars;
15512 typval_T *rettv;
15514 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15518 * "setreg()" function
15520 static void
15521 f_setreg(argvars, rettv)
15522 typval_T *argvars;
15523 typval_T *rettv;
15525 int regname;
15526 char_u *strregname;
15527 char_u *stropt;
15528 char_u *strval;
15529 int append;
15530 char_u yank_type;
15531 long block_len;
15533 block_len = -1;
15534 yank_type = MAUTO;
15535 append = FALSE;
15537 strregname = get_tv_string_chk(argvars);
15538 rettv->vval.v_number = 1; /* FAIL is default */
15540 if (strregname == NULL)
15541 return; /* type error; errmsg already given */
15542 regname = *strregname;
15543 if (regname == 0 || regname == '@')
15544 regname = '"';
15545 else if (regname == '=')
15546 return;
15548 if (argvars[2].v_type != VAR_UNKNOWN)
15550 stropt = get_tv_string_chk(&argvars[2]);
15551 if (stropt == NULL)
15552 return; /* type error */
15553 for (; *stropt != NUL; ++stropt)
15554 switch (*stropt)
15556 case 'a': case 'A': /* append */
15557 append = TRUE;
15558 break;
15559 case 'v': case 'c': /* character-wise selection */
15560 yank_type = MCHAR;
15561 break;
15562 case 'V': case 'l': /* line-wise selection */
15563 yank_type = MLINE;
15564 break;
15565 #ifdef FEAT_VISUAL
15566 case 'b': case Ctrl_V: /* block-wise selection */
15567 yank_type = MBLOCK;
15568 if (VIM_ISDIGIT(stropt[1]))
15570 ++stropt;
15571 block_len = getdigits(&stropt) - 1;
15572 --stropt;
15574 break;
15575 #endif
15579 strval = get_tv_string_chk(&argvars[1]);
15580 if (strval != NULL)
15581 write_reg_contents_ex(regname, strval, -1,
15582 append, yank_type, block_len);
15583 rettv->vval.v_number = 0;
15587 * "settabwinvar()" function
15589 static void
15590 f_settabwinvar(argvars, rettv)
15591 typval_T *argvars;
15592 typval_T *rettv;
15594 setwinvar(argvars, rettv, 1);
15598 * "setwinvar()" function
15600 static void
15601 f_setwinvar(argvars, rettv)
15602 typval_T *argvars;
15603 typval_T *rettv;
15605 setwinvar(argvars, rettv, 0);
15609 * "setwinvar()" and "settabwinvar()" functions
15611 static void
15612 setwinvar(argvars, rettv, off)
15613 typval_T *argvars;
15614 typval_T *rettv;
15615 int off;
15617 win_T *win;
15618 #ifdef FEAT_WINDOWS
15619 win_T *save_curwin;
15620 tabpage_T *save_curtab;
15621 #endif
15622 char_u *varname, *winvarname;
15623 typval_T *varp;
15624 char_u nbuf[NUMBUFLEN];
15625 tabpage_T *tp;
15627 rettv->vval.v_number = 0;
15629 if (check_restricted() || check_secure())
15630 return;
15632 #ifdef FEAT_WINDOWS
15633 if (off == 1)
15634 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15635 else
15636 tp = curtab;
15637 #endif
15638 win = find_win_by_nr(&argvars[off], tp);
15639 varname = get_tv_string_chk(&argvars[off + 1]);
15640 varp = &argvars[off + 2];
15642 if (win != NULL && varname != NULL && varp != NULL)
15644 #ifdef FEAT_WINDOWS
15645 /* set curwin to be our win, temporarily */
15646 save_curwin = curwin;
15647 save_curtab = curtab;
15648 goto_tabpage_tp(tp);
15649 if (!win_valid(win))
15650 return;
15651 curwin = win;
15652 curbuf = curwin->w_buffer;
15653 #endif
15655 if (*varname == '&')
15657 long numval;
15658 char_u *strval;
15659 int error = FALSE;
15661 ++varname;
15662 numval = get_tv_number_chk(varp, &error);
15663 strval = get_tv_string_buf_chk(varp, nbuf);
15664 if (!error && strval != NULL)
15665 set_option_value(varname, numval, strval, OPT_LOCAL);
15667 else
15669 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15670 if (winvarname != NULL)
15672 STRCPY(winvarname, "w:");
15673 STRCPY(winvarname + 2, varname);
15674 set_var(winvarname, varp, TRUE);
15675 vim_free(winvarname);
15679 #ifdef FEAT_WINDOWS
15680 /* Restore current tabpage and window, if still valid (autocomands can
15681 * make them invalid). */
15682 if (valid_tabpage(save_curtab))
15683 goto_tabpage_tp(save_curtab);
15684 if (win_valid(save_curwin))
15686 curwin = save_curwin;
15687 curbuf = curwin->w_buffer;
15689 #endif
15694 * "shellescape({string})" function
15696 static void
15697 f_shellescape(argvars, rettv)
15698 typval_T *argvars;
15699 typval_T *rettv;
15701 rettv->vval.v_string = vim_strsave_shellescape(
15702 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15703 rettv->v_type = VAR_STRING;
15707 * "simplify()" function
15709 static void
15710 f_simplify(argvars, rettv)
15711 typval_T *argvars;
15712 typval_T *rettv;
15714 char_u *p;
15716 p = get_tv_string(&argvars[0]);
15717 rettv->vval.v_string = vim_strsave(p);
15718 simplify_filename(rettv->vval.v_string); /* simplify in place */
15719 rettv->v_type = VAR_STRING;
15722 #ifdef FEAT_FLOAT
15724 * "sin()" function
15726 static void
15727 f_sin(argvars, rettv)
15728 typval_T *argvars;
15729 typval_T *rettv;
15731 float_T f;
15733 rettv->v_type = VAR_FLOAT;
15734 if (get_float_arg(argvars, &f) == OK)
15735 rettv->vval.v_float = sin(f);
15736 else
15737 rettv->vval.v_float = 0.0;
15739 #endif
15741 static int
15742 #ifdef __BORLANDC__
15743 _RTLENTRYF
15744 #endif
15745 item_compare __ARGS((const void *s1, const void *s2));
15746 static int
15747 #ifdef __BORLANDC__
15748 _RTLENTRYF
15749 #endif
15750 item_compare2 __ARGS((const void *s1, const void *s2));
15752 static int item_compare_ic;
15753 static char_u *item_compare_func;
15754 static int item_compare_func_err;
15755 #define ITEM_COMPARE_FAIL 999
15758 * Compare functions for f_sort() below.
15760 static int
15761 #ifdef __BORLANDC__
15762 _RTLENTRYF
15763 #endif
15764 item_compare(s1, s2)
15765 const void *s1;
15766 const void *s2;
15768 char_u *p1, *p2;
15769 char_u *tofree1, *tofree2;
15770 int res;
15771 char_u numbuf1[NUMBUFLEN];
15772 char_u numbuf2[NUMBUFLEN];
15774 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15775 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15776 if (p1 == NULL)
15777 p1 = (char_u *)"";
15778 if (p2 == NULL)
15779 p2 = (char_u *)"";
15780 if (item_compare_ic)
15781 res = STRICMP(p1, p2);
15782 else
15783 res = STRCMP(p1, p2);
15784 vim_free(tofree1);
15785 vim_free(tofree2);
15786 return res;
15789 static int
15790 #ifdef __BORLANDC__
15791 _RTLENTRYF
15792 #endif
15793 item_compare2(s1, s2)
15794 const void *s1;
15795 const void *s2;
15797 int res;
15798 typval_T rettv;
15799 typval_T argv[3];
15800 int dummy;
15802 /* shortcut after failure in previous call; compare all items equal */
15803 if (item_compare_func_err)
15804 return 0;
15806 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15807 * in the copy without changing the original list items. */
15808 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15809 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15811 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15812 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15813 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15814 clear_tv(&argv[0]);
15815 clear_tv(&argv[1]);
15817 if (res == FAIL)
15818 res = ITEM_COMPARE_FAIL;
15819 else
15820 /* return value has wrong type */
15821 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15822 if (item_compare_func_err)
15823 res = ITEM_COMPARE_FAIL;
15824 clear_tv(&rettv);
15825 return res;
15829 * "sort({list})" function
15831 static void
15832 f_sort(argvars, rettv)
15833 typval_T *argvars;
15834 typval_T *rettv;
15836 list_T *l;
15837 listitem_T *li;
15838 listitem_T **ptrs;
15839 long len;
15840 long i;
15842 rettv->vval.v_number = 0;
15843 if (argvars[0].v_type != VAR_LIST)
15844 EMSG2(_(e_listarg), "sort()");
15845 else
15847 l = argvars[0].vval.v_list;
15848 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15849 return;
15850 rettv->vval.v_list = l;
15851 rettv->v_type = VAR_LIST;
15852 ++l->lv_refcount;
15854 len = list_len(l);
15855 if (len <= 1)
15856 return; /* short list sorts pretty quickly */
15858 item_compare_ic = FALSE;
15859 item_compare_func = NULL;
15860 if (argvars[1].v_type != VAR_UNKNOWN)
15862 if (argvars[1].v_type == VAR_FUNC)
15863 item_compare_func = argvars[1].vval.v_string;
15864 else
15866 int error = FALSE;
15868 i = get_tv_number_chk(&argvars[1], &error);
15869 if (error)
15870 return; /* type error; errmsg already given */
15871 if (i == 1)
15872 item_compare_ic = TRUE;
15873 else
15874 item_compare_func = get_tv_string(&argvars[1]);
15878 /* Make an array with each entry pointing to an item in the List. */
15879 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15880 if (ptrs == NULL)
15881 return;
15882 i = 0;
15883 for (li = l->lv_first; li != NULL; li = li->li_next)
15884 ptrs[i++] = li;
15886 item_compare_func_err = FALSE;
15887 /* test the compare function */
15888 if (item_compare_func != NULL
15889 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15890 == ITEM_COMPARE_FAIL)
15891 EMSG(_("E702: Sort compare function failed"));
15892 else
15894 /* Sort the array with item pointers. */
15895 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15896 item_compare_func == NULL ? item_compare : item_compare2);
15898 if (!item_compare_func_err)
15900 /* Clear the List and append the items in the sorted order. */
15901 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15902 l->lv_len = 0;
15903 for (i = 0; i < len; ++i)
15904 list_append(l, ptrs[i]);
15908 vim_free(ptrs);
15913 * "soundfold({word})" function
15915 static void
15916 f_soundfold(argvars, rettv)
15917 typval_T *argvars;
15918 typval_T *rettv;
15920 char_u *s;
15922 rettv->v_type = VAR_STRING;
15923 s = get_tv_string(&argvars[0]);
15924 #ifdef FEAT_SPELL
15925 rettv->vval.v_string = eval_soundfold(s);
15926 #else
15927 rettv->vval.v_string = vim_strsave(s);
15928 #endif
15932 * "spellbadword()" function
15934 /* ARGSUSED */
15935 static void
15936 f_spellbadword(argvars, rettv)
15937 typval_T *argvars;
15938 typval_T *rettv;
15940 char_u *word = (char_u *)"";
15941 hlf_T attr = HLF_COUNT;
15942 int len = 0;
15944 if (rettv_list_alloc(rettv) == FAIL)
15945 return;
15947 #ifdef FEAT_SPELL
15948 if (argvars[0].v_type == VAR_UNKNOWN)
15950 /* Find the start and length of the badly spelled word. */
15951 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
15952 if (len != 0)
15953 word = ml_get_cursor();
15955 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
15957 char_u *str = get_tv_string_chk(&argvars[0]);
15958 int capcol = -1;
15960 if (str != NULL)
15962 /* Check the argument for spelling. */
15963 while (*str != NUL)
15965 len = spell_check(curwin, str, &attr, &capcol, FALSE);
15966 if (attr != HLF_COUNT)
15968 word = str;
15969 break;
15971 str += len;
15975 #endif
15977 list_append_string(rettv->vval.v_list, word, len);
15978 list_append_string(rettv->vval.v_list, (char_u *)(
15979 attr == HLF_SPB ? "bad" :
15980 attr == HLF_SPR ? "rare" :
15981 attr == HLF_SPL ? "local" :
15982 attr == HLF_SPC ? "caps" :
15983 ""), -1);
15987 * "spellsuggest()" function
15989 /*ARGSUSED*/
15990 static void
15991 f_spellsuggest(argvars, rettv)
15992 typval_T *argvars;
15993 typval_T *rettv;
15995 #ifdef FEAT_SPELL
15996 char_u *str;
15997 int typeerr = FALSE;
15998 int maxcount;
15999 garray_T ga;
16000 int i;
16001 listitem_T *li;
16002 int need_capital = FALSE;
16003 #endif
16005 if (rettv_list_alloc(rettv) == FAIL)
16006 return;
16008 #ifdef FEAT_SPELL
16009 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16011 str = get_tv_string(&argvars[0]);
16012 if (argvars[1].v_type != VAR_UNKNOWN)
16014 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16015 if (maxcount <= 0)
16016 return;
16017 if (argvars[2].v_type != VAR_UNKNOWN)
16019 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16020 if (typeerr)
16021 return;
16024 else
16025 maxcount = 25;
16027 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16029 for (i = 0; i < ga.ga_len; ++i)
16031 str = ((char_u **)ga.ga_data)[i];
16033 li = listitem_alloc();
16034 if (li == NULL)
16035 vim_free(str);
16036 else
16038 li->li_tv.v_type = VAR_STRING;
16039 li->li_tv.v_lock = 0;
16040 li->li_tv.vval.v_string = str;
16041 list_append(rettv->vval.v_list, li);
16044 ga_clear(&ga);
16046 #endif
16049 static void
16050 f_split(argvars, rettv)
16051 typval_T *argvars;
16052 typval_T *rettv;
16054 char_u *str;
16055 char_u *end;
16056 char_u *pat = NULL;
16057 regmatch_T regmatch;
16058 char_u patbuf[NUMBUFLEN];
16059 char_u *save_cpo;
16060 int match;
16061 colnr_T col = 0;
16062 int keepempty = FALSE;
16063 int typeerr = FALSE;
16065 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16066 save_cpo = p_cpo;
16067 p_cpo = (char_u *)"";
16069 str = get_tv_string(&argvars[0]);
16070 if (argvars[1].v_type != VAR_UNKNOWN)
16072 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16073 if (pat == NULL)
16074 typeerr = TRUE;
16075 if (argvars[2].v_type != VAR_UNKNOWN)
16076 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16078 if (pat == NULL || *pat == NUL)
16079 pat = (char_u *)"[\\x01- ]\\+";
16081 if (rettv_list_alloc(rettv) == FAIL)
16082 return;
16083 if (typeerr)
16084 return;
16086 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16087 if (regmatch.regprog != NULL)
16089 regmatch.rm_ic = FALSE;
16090 while (*str != NUL || keepempty)
16092 if (*str == NUL)
16093 match = FALSE; /* empty item at the end */
16094 else
16095 match = vim_regexec_nl(&regmatch, str, col);
16096 if (match)
16097 end = regmatch.startp[0];
16098 else
16099 end = str + STRLEN(str);
16100 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16101 && *str != NUL && match && end < regmatch.endp[0]))
16103 if (list_append_string(rettv->vval.v_list, str,
16104 (int)(end - str)) == FAIL)
16105 break;
16107 if (!match)
16108 break;
16109 /* Advance to just after the match. */
16110 if (regmatch.endp[0] > str)
16111 col = 0;
16112 else
16114 /* Don't get stuck at the same match. */
16115 #ifdef FEAT_MBYTE
16116 col = (*mb_ptr2len)(regmatch.endp[0]);
16117 #else
16118 col = 1;
16119 #endif
16121 str = regmatch.endp[0];
16124 vim_free(regmatch.regprog);
16127 p_cpo = save_cpo;
16130 #ifdef FEAT_FLOAT
16132 * "sqrt()" function
16134 static void
16135 f_sqrt(argvars, rettv)
16136 typval_T *argvars;
16137 typval_T *rettv;
16139 float_T f;
16141 rettv->v_type = VAR_FLOAT;
16142 if (get_float_arg(argvars, &f) == OK)
16143 rettv->vval.v_float = sqrt(f);
16144 else
16145 rettv->vval.v_float = 0.0;
16149 * "str2float()" function
16151 static void
16152 f_str2float(argvars, rettv)
16153 typval_T *argvars;
16154 typval_T *rettv;
16156 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16158 if (*p == '+')
16159 p = skipwhite(p + 1);
16160 (void)string2float(p, &rettv->vval.v_float);
16161 rettv->v_type = VAR_FLOAT;
16163 #endif
16166 * "str2nr()" function
16168 static void
16169 f_str2nr(argvars, rettv)
16170 typval_T *argvars;
16171 typval_T *rettv;
16173 int base = 10;
16174 char_u *p;
16175 long n;
16177 if (argvars[1].v_type != VAR_UNKNOWN)
16179 base = get_tv_number(&argvars[1]);
16180 if (base != 8 && base != 10 && base != 16)
16182 EMSG(_(e_invarg));
16183 return;
16187 p = skipwhite(get_tv_string(&argvars[0]));
16188 if (*p == '+')
16189 p = skipwhite(p + 1);
16190 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16191 rettv->vval.v_number = n;
16194 #ifdef HAVE_STRFTIME
16196 * "strftime({format}[, {time}])" function
16198 static void
16199 f_strftime(argvars, rettv)
16200 typval_T *argvars;
16201 typval_T *rettv;
16203 char_u result_buf[256];
16204 struct tm *curtime;
16205 time_t seconds;
16206 char_u *p;
16208 rettv->v_type = VAR_STRING;
16210 p = get_tv_string(&argvars[0]);
16211 if (argvars[1].v_type == VAR_UNKNOWN)
16212 seconds = time(NULL);
16213 else
16214 seconds = (time_t)get_tv_number(&argvars[1]);
16215 curtime = localtime(&seconds);
16216 /* MSVC returns NULL for an invalid value of seconds. */
16217 if (curtime == NULL)
16218 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16219 else
16221 # ifdef FEAT_MBYTE
16222 vimconv_T conv;
16223 char_u *enc;
16225 conv.vc_type = CONV_NONE;
16226 enc = enc_locale();
16227 convert_setup(&conv, p_enc, enc);
16228 if (conv.vc_type != CONV_NONE)
16229 p = string_convert(&conv, p, NULL);
16230 # endif
16231 if (p != NULL)
16232 (void)strftime((char *)result_buf, sizeof(result_buf),
16233 (char *)p, curtime);
16234 else
16235 result_buf[0] = NUL;
16237 # ifdef FEAT_MBYTE
16238 if (conv.vc_type != CONV_NONE)
16239 vim_free(p);
16240 convert_setup(&conv, enc, p_enc);
16241 if (conv.vc_type != CONV_NONE)
16242 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16243 else
16244 # endif
16245 rettv->vval.v_string = vim_strsave(result_buf);
16247 # ifdef FEAT_MBYTE
16248 /* Release conversion descriptors */
16249 convert_setup(&conv, NULL, NULL);
16250 vim_free(enc);
16251 # endif
16254 #endif
16257 * "stridx()" function
16259 static void
16260 f_stridx(argvars, rettv)
16261 typval_T *argvars;
16262 typval_T *rettv;
16264 char_u buf[NUMBUFLEN];
16265 char_u *needle;
16266 char_u *haystack;
16267 char_u *save_haystack;
16268 char_u *pos;
16269 int start_idx;
16271 needle = get_tv_string_chk(&argvars[1]);
16272 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16273 rettv->vval.v_number = -1;
16274 if (needle == NULL || haystack == NULL)
16275 return; /* type error; errmsg already given */
16277 if (argvars[2].v_type != VAR_UNKNOWN)
16279 int error = FALSE;
16281 start_idx = get_tv_number_chk(&argvars[2], &error);
16282 if (error || start_idx >= (int)STRLEN(haystack))
16283 return;
16284 if (start_idx >= 0)
16285 haystack += start_idx;
16288 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16289 if (pos != NULL)
16290 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16294 * "string()" function
16296 static void
16297 f_string(argvars, rettv)
16298 typval_T *argvars;
16299 typval_T *rettv;
16301 char_u *tofree;
16302 char_u numbuf[NUMBUFLEN];
16304 rettv->v_type = VAR_STRING;
16305 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16306 /* Make a copy if we have a value but it's not in allocated memory. */
16307 if (rettv->vval.v_string != NULL && tofree == NULL)
16308 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16312 * "strlen()" function
16314 static void
16315 f_strlen(argvars, rettv)
16316 typval_T *argvars;
16317 typval_T *rettv;
16319 rettv->vval.v_number = (varnumber_T)(STRLEN(
16320 get_tv_string(&argvars[0])));
16324 * "strpart()" function
16326 static void
16327 f_strpart(argvars, rettv)
16328 typval_T *argvars;
16329 typval_T *rettv;
16331 char_u *p;
16332 int n;
16333 int len;
16334 int slen;
16335 int error = FALSE;
16337 p = get_tv_string(&argvars[0]);
16338 slen = (int)STRLEN(p);
16340 n = get_tv_number_chk(&argvars[1], &error);
16341 if (error)
16342 len = 0;
16343 else if (argvars[2].v_type != VAR_UNKNOWN)
16344 len = get_tv_number(&argvars[2]);
16345 else
16346 len = slen - n; /* default len: all bytes that are available. */
16349 * Only return the overlap between the specified part and the actual
16350 * string.
16352 if (n < 0)
16354 len += n;
16355 n = 0;
16357 else if (n > slen)
16358 n = slen;
16359 if (len < 0)
16360 len = 0;
16361 else if (n + len > slen)
16362 len = slen - n;
16364 rettv->v_type = VAR_STRING;
16365 rettv->vval.v_string = vim_strnsave(p + n, len);
16369 * "strridx()" function
16371 static void
16372 f_strridx(argvars, rettv)
16373 typval_T *argvars;
16374 typval_T *rettv;
16376 char_u buf[NUMBUFLEN];
16377 char_u *needle;
16378 char_u *haystack;
16379 char_u *rest;
16380 char_u *lastmatch = NULL;
16381 int haystack_len, end_idx;
16383 needle = get_tv_string_chk(&argvars[1]);
16384 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16386 rettv->vval.v_number = -1;
16387 if (needle == NULL || haystack == NULL)
16388 return; /* type error; errmsg already given */
16390 haystack_len = (int)STRLEN(haystack);
16391 if (argvars[2].v_type != VAR_UNKNOWN)
16393 /* Third argument: upper limit for index */
16394 end_idx = get_tv_number_chk(&argvars[2], NULL);
16395 if (end_idx < 0)
16396 return; /* can never find a match */
16398 else
16399 end_idx = haystack_len;
16401 if (*needle == NUL)
16403 /* Empty string matches past the end. */
16404 lastmatch = haystack + end_idx;
16406 else
16408 for (rest = haystack; *rest != '\0'; ++rest)
16410 rest = (char_u *)strstr((char *)rest, (char *)needle);
16411 if (rest == NULL || rest > haystack + end_idx)
16412 break;
16413 lastmatch = rest;
16417 if (lastmatch == NULL)
16418 rettv->vval.v_number = -1;
16419 else
16420 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16424 * "strtrans()" function
16426 static void
16427 f_strtrans(argvars, rettv)
16428 typval_T *argvars;
16429 typval_T *rettv;
16431 rettv->v_type = VAR_STRING;
16432 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16436 * "submatch()" function
16438 static void
16439 f_submatch(argvars, rettv)
16440 typval_T *argvars;
16441 typval_T *rettv;
16443 rettv->v_type = VAR_STRING;
16444 rettv->vval.v_string =
16445 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16449 * "substitute()" function
16451 static void
16452 f_substitute(argvars, rettv)
16453 typval_T *argvars;
16454 typval_T *rettv;
16456 char_u patbuf[NUMBUFLEN];
16457 char_u subbuf[NUMBUFLEN];
16458 char_u flagsbuf[NUMBUFLEN];
16460 char_u *str = get_tv_string_chk(&argvars[0]);
16461 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16462 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16463 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16465 rettv->v_type = VAR_STRING;
16466 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16467 rettv->vval.v_string = NULL;
16468 else
16469 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16473 * "synID(lnum, col, trans)" function
16475 /*ARGSUSED*/
16476 static void
16477 f_synID(argvars, rettv)
16478 typval_T *argvars;
16479 typval_T *rettv;
16481 int id = 0;
16482 #ifdef FEAT_SYN_HL
16483 long lnum;
16484 long col;
16485 int trans;
16486 int transerr = FALSE;
16488 lnum = get_tv_lnum(argvars); /* -1 on type error */
16489 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16490 trans = get_tv_number_chk(&argvars[2], &transerr);
16492 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16493 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16494 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16495 #endif
16497 rettv->vval.v_number = id;
16501 * "synIDattr(id, what [, mode])" function
16503 /*ARGSUSED*/
16504 static void
16505 f_synIDattr(argvars, rettv)
16506 typval_T *argvars;
16507 typval_T *rettv;
16509 char_u *p = NULL;
16510 #ifdef FEAT_SYN_HL
16511 int id;
16512 char_u *what;
16513 char_u *mode;
16514 char_u modebuf[NUMBUFLEN];
16515 int modec;
16517 id = get_tv_number(&argvars[0]);
16518 what = get_tv_string(&argvars[1]);
16519 if (argvars[2].v_type != VAR_UNKNOWN)
16521 mode = get_tv_string_buf(&argvars[2], modebuf);
16522 modec = TOLOWER_ASC(mode[0]);
16523 if (modec != 't' && modec != 'c'
16524 #ifdef FEAT_GUI
16525 && modec != 'g'
16526 #endif
16528 modec = 0; /* replace invalid with current */
16530 else
16532 #ifdef FEAT_GUI
16533 if (gui.in_use)
16534 modec = 'g';
16535 else
16536 #endif
16537 if (t_colors > 1)
16538 modec = 'c';
16539 else
16540 modec = 't';
16544 switch (TOLOWER_ASC(what[0]))
16546 case 'b':
16547 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16548 p = highlight_color(id, what, modec);
16549 else /* bold */
16550 p = highlight_has_attr(id, HL_BOLD, modec);
16551 break;
16553 case 'f': /* fg[#] */
16554 p = highlight_color(id, what, modec);
16555 break;
16557 case 'i':
16558 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16559 p = highlight_has_attr(id, HL_INVERSE, modec);
16560 else /* italic */
16561 p = highlight_has_attr(id, HL_ITALIC, modec);
16562 break;
16564 case 'n': /* name */
16565 p = get_highlight_name(NULL, id - 1);
16566 break;
16568 case 'r': /* reverse */
16569 p = highlight_has_attr(id, HL_INVERSE, modec);
16570 break;
16572 case 's': /* standout */
16573 p = highlight_has_attr(id, HL_STANDOUT, modec);
16574 break;
16576 case 'u':
16577 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16578 /* underline */
16579 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16580 else
16581 /* undercurl */
16582 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16583 break;
16586 if (p != NULL)
16587 p = vim_strsave(p);
16588 #endif
16589 rettv->v_type = VAR_STRING;
16590 rettv->vval.v_string = p;
16594 * "synIDtrans(id)" function
16596 /*ARGSUSED*/
16597 static void
16598 f_synIDtrans(argvars, rettv)
16599 typval_T *argvars;
16600 typval_T *rettv;
16602 int id;
16604 #ifdef FEAT_SYN_HL
16605 id = get_tv_number(&argvars[0]);
16607 if (id > 0)
16608 id = syn_get_final_id(id);
16609 else
16610 #endif
16611 id = 0;
16613 rettv->vval.v_number = id;
16617 * "synstack(lnum, col)" function
16619 /*ARGSUSED*/
16620 static void
16621 f_synstack(argvars, rettv)
16622 typval_T *argvars;
16623 typval_T *rettv;
16625 #ifdef FEAT_SYN_HL
16626 long lnum;
16627 long col;
16628 int i;
16629 int id;
16630 #endif
16632 rettv->v_type = VAR_LIST;
16633 rettv->vval.v_list = NULL;
16635 #ifdef FEAT_SYN_HL
16636 lnum = get_tv_lnum(argvars); /* -1 on type error */
16637 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16639 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16640 && col >= 0 && col < (long)STRLEN(ml_get(lnum))
16641 && rettv_list_alloc(rettv) != FAIL)
16643 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16644 for (i = 0; ; ++i)
16646 id = syn_get_stack_item(i);
16647 if (id < 0)
16648 break;
16649 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16650 break;
16653 #endif
16657 * "system()" function
16659 static void
16660 f_system(argvars, rettv)
16661 typval_T *argvars;
16662 typval_T *rettv;
16664 char_u *res = NULL;
16665 char_u *p;
16666 char_u *infile = NULL;
16667 char_u buf[NUMBUFLEN];
16668 int err = FALSE;
16669 FILE *fd;
16671 if (check_restricted() || check_secure())
16672 goto done;
16674 if (argvars[1].v_type != VAR_UNKNOWN)
16677 * Write the string to a temp file, to be used for input of the shell
16678 * command.
16680 if ((infile = vim_tempname('i')) == NULL)
16682 EMSG(_(e_notmp));
16683 goto done;
16686 fd = mch_fopen((char *)infile, WRITEBIN);
16687 if (fd == NULL)
16689 EMSG2(_(e_notopen), infile);
16690 goto done;
16692 p = get_tv_string_buf_chk(&argvars[1], buf);
16693 if (p == NULL)
16695 fclose(fd);
16696 goto done; /* type error; errmsg already given */
16698 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16699 err = TRUE;
16700 if (fclose(fd) != 0)
16701 err = TRUE;
16702 if (err)
16704 EMSG(_("E677: Error writing temp file"));
16705 goto done;
16709 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16710 SHELL_SILENT | SHELL_COOKED);
16712 #ifdef USE_CR
16713 /* translate <CR> into <NL> */
16714 if (res != NULL)
16716 char_u *s;
16718 for (s = res; *s; ++s)
16720 if (*s == CAR)
16721 *s = NL;
16724 #else
16725 # ifdef USE_CRNL
16726 /* translate <CR><NL> into <NL> */
16727 if (res != NULL)
16729 char_u *s, *d;
16731 d = res;
16732 for (s = res; *s; ++s)
16734 if (s[0] == CAR && s[1] == NL)
16735 ++s;
16736 *d++ = *s;
16738 *d = NUL;
16740 # endif
16741 #endif
16743 done:
16744 if (infile != NULL)
16746 mch_remove(infile);
16747 vim_free(infile);
16749 rettv->v_type = VAR_STRING;
16750 rettv->vval.v_string = res;
16754 * "tabpagebuflist()" function
16756 /* ARGSUSED */
16757 static void
16758 f_tabpagebuflist(argvars, rettv)
16759 typval_T *argvars;
16760 typval_T *rettv;
16762 #ifndef FEAT_WINDOWS
16763 rettv->vval.v_number = 0;
16764 #else
16765 tabpage_T *tp;
16766 win_T *wp = NULL;
16768 if (argvars[0].v_type == VAR_UNKNOWN)
16769 wp = firstwin;
16770 else
16772 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16773 if (tp != NULL)
16774 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16776 if (wp == NULL)
16777 rettv->vval.v_number = 0;
16778 else
16780 if (rettv_list_alloc(rettv) == FAIL)
16781 rettv->vval.v_number = 0;
16782 else
16784 for (; wp != NULL; wp = wp->w_next)
16785 if (list_append_number(rettv->vval.v_list,
16786 wp->w_buffer->b_fnum) == FAIL)
16787 break;
16790 #endif
16795 * "tabpagenr()" function
16797 /* ARGSUSED */
16798 static void
16799 f_tabpagenr(argvars, rettv)
16800 typval_T *argvars;
16801 typval_T *rettv;
16803 int nr = 1;
16804 #ifdef FEAT_WINDOWS
16805 char_u *arg;
16807 if (argvars[0].v_type != VAR_UNKNOWN)
16809 arg = get_tv_string_chk(&argvars[0]);
16810 nr = 0;
16811 if (arg != NULL)
16813 if (STRCMP(arg, "$") == 0)
16814 nr = tabpage_index(NULL) - 1;
16815 else
16816 EMSG2(_(e_invexpr2), arg);
16819 else
16820 nr = tabpage_index(curtab);
16821 #endif
16822 rettv->vval.v_number = nr;
16826 #ifdef FEAT_WINDOWS
16827 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16830 * Common code for tabpagewinnr() and winnr().
16832 static int
16833 get_winnr(tp, argvar)
16834 tabpage_T *tp;
16835 typval_T *argvar;
16837 win_T *twin;
16838 int nr = 1;
16839 win_T *wp;
16840 char_u *arg;
16842 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16843 if (argvar->v_type != VAR_UNKNOWN)
16845 arg = get_tv_string_chk(argvar);
16846 if (arg == NULL)
16847 nr = 0; /* type error; errmsg already given */
16848 else if (STRCMP(arg, "$") == 0)
16849 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16850 else if (STRCMP(arg, "#") == 0)
16852 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16853 if (twin == NULL)
16854 nr = 0;
16856 else
16858 EMSG2(_(e_invexpr2), arg);
16859 nr = 0;
16863 if (nr > 0)
16864 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16865 wp != twin; wp = wp->w_next)
16867 if (wp == NULL)
16869 /* didn't find it in this tabpage */
16870 nr = 0;
16871 break;
16873 ++nr;
16875 return nr;
16877 #endif
16880 * "tabpagewinnr()" function
16882 /* ARGSUSED */
16883 static void
16884 f_tabpagewinnr(argvars, rettv)
16885 typval_T *argvars;
16886 typval_T *rettv;
16888 int nr = 1;
16889 #ifdef FEAT_WINDOWS
16890 tabpage_T *tp;
16892 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16893 if (tp == NULL)
16894 nr = 0;
16895 else
16896 nr = get_winnr(tp, &argvars[1]);
16897 #endif
16898 rettv->vval.v_number = nr;
16903 * "tagfiles()" function
16905 /*ARGSUSED*/
16906 static void
16907 f_tagfiles(argvars, rettv)
16908 typval_T *argvars;
16909 typval_T *rettv;
16911 char_u fname[MAXPATHL + 1];
16912 tagname_T tn;
16913 int first;
16915 if (rettv_list_alloc(rettv) == FAIL)
16917 rettv->vval.v_number = 0;
16918 return;
16921 for (first = TRUE; ; first = FALSE)
16922 if (get_tagfname(&tn, first, fname) == FAIL
16923 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
16924 break;
16925 tagname_free(&tn);
16929 * "taglist()" function
16931 static void
16932 f_taglist(argvars, rettv)
16933 typval_T *argvars;
16934 typval_T *rettv;
16936 char_u *tag_pattern;
16938 tag_pattern = get_tv_string(&argvars[0]);
16940 rettv->vval.v_number = FALSE;
16941 if (*tag_pattern == NUL)
16942 return;
16944 if (rettv_list_alloc(rettv) == OK)
16945 (void)get_tags(rettv->vval.v_list, tag_pattern);
16949 * "tempname()" function
16951 /*ARGSUSED*/
16952 static void
16953 f_tempname(argvars, rettv)
16954 typval_T *argvars;
16955 typval_T *rettv;
16957 static int x = 'A';
16959 rettv->v_type = VAR_STRING;
16960 rettv->vval.v_string = vim_tempname(x);
16962 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
16963 * names. Skip 'I' and 'O', they are used for shell redirection. */
16966 if (x == 'Z')
16967 x = '0';
16968 else if (x == '9')
16969 x = 'A';
16970 else
16972 #ifdef EBCDIC
16973 if (x == 'I')
16974 x = 'J';
16975 else if (x == 'R')
16976 x = 'S';
16977 else
16978 #endif
16979 ++x;
16981 } while (x == 'I' || x == 'O');
16985 * "test(list)" function: Just checking the walls...
16987 /*ARGSUSED*/
16988 static void
16989 f_test(argvars, rettv)
16990 typval_T *argvars;
16991 typval_T *rettv;
16993 /* Used for unit testing. Change the code below to your liking. */
16994 #if 0
16995 listitem_T *li;
16996 list_T *l;
16997 char_u *bad, *good;
16999 if (argvars[0].v_type != VAR_LIST)
17000 return;
17001 l = argvars[0].vval.v_list;
17002 if (l == NULL)
17003 return;
17004 li = l->lv_first;
17005 if (li == NULL)
17006 return;
17007 bad = get_tv_string(&li->li_tv);
17008 li = li->li_next;
17009 if (li == NULL)
17010 return;
17011 good = get_tv_string(&li->li_tv);
17012 rettv->vval.v_number = test_edit_score(bad, good);
17013 #endif
17017 * "tolower(string)" function
17019 static void
17020 f_tolower(argvars, rettv)
17021 typval_T *argvars;
17022 typval_T *rettv;
17024 char_u *p;
17026 p = vim_strsave(get_tv_string(&argvars[0]));
17027 rettv->v_type = VAR_STRING;
17028 rettv->vval.v_string = p;
17030 if (p != NULL)
17031 while (*p != NUL)
17033 #ifdef FEAT_MBYTE
17034 int l;
17036 if (enc_utf8)
17038 int c, lc;
17040 c = utf_ptr2char(p);
17041 lc = utf_tolower(c);
17042 l = utf_ptr2len(p);
17043 /* TODO: reallocate string when byte count changes. */
17044 if (utf_char2len(lc) == l)
17045 utf_char2bytes(lc, p);
17046 p += l;
17048 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17049 p += l; /* skip multi-byte character */
17050 else
17051 #endif
17053 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17054 ++p;
17060 * "toupper(string)" function
17062 static void
17063 f_toupper(argvars, rettv)
17064 typval_T *argvars;
17065 typval_T *rettv;
17067 rettv->v_type = VAR_STRING;
17068 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17072 * "tr(string, fromstr, tostr)" function
17074 static void
17075 f_tr(argvars, rettv)
17076 typval_T *argvars;
17077 typval_T *rettv;
17079 char_u *instr;
17080 char_u *fromstr;
17081 char_u *tostr;
17082 char_u *p;
17083 #ifdef FEAT_MBYTE
17084 int inlen;
17085 int fromlen;
17086 int tolen;
17087 int idx;
17088 char_u *cpstr;
17089 int cplen;
17090 int first = TRUE;
17091 #endif
17092 char_u buf[NUMBUFLEN];
17093 char_u buf2[NUMBUFLEN];
17094 garray_T ga;
17096 instr = get_tv_string(&argvars[0]);
17097 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17098 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17100 /* Default return value: empty string. */
17101 rettv->v_type = VAR_STRING;
17102 rettv->vval.v_string = NULL;
17103 if (fromstr == NULL || tostr == NULL)
17104 return; /* type error; errmsg already given */
17105 ga_init2(&ga, (int)sizeof(char), 80);
17107 #ifdef FEAT_MBYTE
17108 if (!has_mbyte)
17109 #endif
17110 /* not multi-byte: fromstr and tostr must be the same length */
17111 if (STRLEN(fromstr) != STRLEN(tostr))
17113 #ifdef FEAT_MBYTE
17114 error:
17115 #endif
17116 EMSG2(_(e_invarg2), fromstr);
17117 ga_clear(&ga);
17118 return;
17121 /* fromstr and tostr have to contain the same number of chars */
17122 while (*instr != NUL)
17124 #ifdef FEAT_MBYTE
17125 if (has_mbyte)
17127 inlen = (*mb_ptr2len)(instr);
17128 cpstr = instr;
17129 cplen = inlen;
17130 idx = 0;
17131 for (p = fromstr; *p != NUL; p += fromlen)
17133 fromlen = (*mb_ptr2len)(p);
17134 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17136 for (p = tostr; *p != NUL; p += tolen)
17138 tolen = (*mb_ptr2len)(p);
17139 if (idx-- == 0)
17141 cplen = tolen;
17142 cpstr = p;
17143 break;
17146 if (*p == NUL) /* tostr is shorter than fromstr */
17147 goto error;
17148 break;
17150 ++idx;
17153 if (first && cpstr == instr)
17155 /* Check that fromstr and tostr have the same number of
17156 * (multi-byte) characters. Done only once when a character
17157 * of instr doesn't appear in fromstr. */
17158 first = FALSE;
17159 for (p = tostr; *p != NUL; p += tolen)
17161 tolen = (*mb_ptr2len)(p);
17162 --idx;
17164 if (idx != 0)
17165 goto error;
17168 ga_grow(&ga, cplen);
17169 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17170 ga.ga_len += cplen;
17172 instr += inlen;
17174 else
17175 #endif
17177 /* When not using multi-byte chars we can do it faster. */
17178 p = vim_strchr(fromstr, *instr);
17179 if (p != NULL)
17180 ga_append(&ga, tostr[p - fromstr]);
17181 else
17182 ga_append(&ga, *instr);
17183 ++instr;
17187 /* add a terminating NUL */
17188 ga_grow(&ga, 1);
17189 ga_append(&ga, NUL);
17191 rettv->vval.v_string = ga.ga_data;
17194 #ifdef FEAT_FLOAT
17196 * "trunc({float})" function
17198 static void
17199 f_trunc(argvars, rettv)
17200 typval_T *argvars;
17201 typval_T *rettv;
17203 float_T f;
17205 rettv->v_type = VAR_FLOAT;
17206 if (get_float_arg(argvars, &f) == OK)
17207 /* trunc() is not in C90, use floor() or ceil() instead. */
17208 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17209 else
17210 rettv->vval.v_float = 0.0;
17212 #endif
17215 * "type(expr)" function
17217 static void
17218 f_type(argvars, rettv)
17219 typval_T *argvars;
17220 typval_T *rettv;
17222 int n;
17224 switch (argvars[0].v_type)
17226 case VAR_NUMBER: n = 0; break;
17227 case VAR_STRING: n = 1; break;
17228 case VAR_FUNC: n = 2; break;
17229 case VAR_LIST: n = 3; break;
17230 case VAR_DICT: n = 4; break;
17231 #ifdef FEAT_FLOAT
17232 case VAR_FLOAT: n = 5; break;
17233 #endif
17234 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17236 rettv->vval.v_number = n;
17240 * "values(dict)" function
17242 static void
17243 f_values(argvars, rettv)
17244 typval_T *argvars;
17245 typval_T *rettv;
17247 dict_list(argvars, rettv, 1);
17251 * "virtcol(string)" function
17253 static void
17254 f_virtcol(argvars, rettv)
17255 typval_T *argvars;
17256 typval_T *rettv;
17258 colnr_T vcol = 0;
17259 pos_T *fp;
17260 int fnum = curbuf->b_fnum;
17262 fp = var2fpos(&argvars[0], FALSE, &fnum);
17263 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17264 && fnum == curbuf->b_fnum)
17266 getvvcol(curwin, fp, NULL, NULL, &vcol);
17267 ++vcol;
17270 rettv->vval.v_number = vcol;
17274 * "visualmode()" function
17276 /*ARGSUSED*/
17277 static void
17278 f_visualmode(argvars, rettv)
17279 typval_T *argvars;
17280 typval_T *rettv;
17282 #ifdef FEAT_VISUAL
17283 char_u str[2];
17285 rettv->v_type = VAR_STRING;
17286 str[0] = curbuf->b_visual_mode_eval;
17287 str[1] = NUL;
17288 rettv->vval.v_string = vim_strsave(str);
17290 /* A non-zero number or non-empty string argument: reset mode. */
17291 if (non_zero_arg(&argvars[0]))
17292 curbuf->b_visual_mode_eval = NUL;
17293 #else
17294 rettv->vval.v_number = 0; /* return anything, it won't work anyway */
17295 #endif
17299 * "winbufnr(nr)" function
17301 static void
17302 f_winbufnr(argvars, rettv)
17303 typval_T *argvars;
17304 typval_T *rettv;
17306 win_T *wp;
17308 wp = find_win_by_nr(&argvars[0], NULL);
17309 if (wp == NULL)
17310 rettv->vval.v_number = -1;
17311 else
17312 rettv->vval.v_number = wp->w_buffer->b_fnum;
17316 * "wincol()" function
17318 /*ARGSUSED*/
17319 static void
17320 f_wincol(argvars, rettv)
17321 typval_T *argvars;
17322 typval_T *rettv;
17324 validate_cursor();
17325 rettv->vval.v_number = curwin->w_wcol + 1;
17329 * "winheight(nr)" function
17331 static void
17332 f_winheight(argvars, rettv)
17333 typval_T *argvars;
17334 typval_T *rettv;
17336 win_T *wp;
17338 wp = find_win_by_nr(&argvars[0], NULL);
17339 if (wp == NULL)
17340 rettv->vval.v_number = -1;
17341 else
17342 rettv->vval.v_number = wp->w_height;
17346 * "winline()" function
17348 /*ARGSUSED*/
17349 static void
17350 f_winline(argvars, rettv)
17351 typval_T *argvars;
17352 typval_T *rettv;
17354 validate_cursor();
17355 rettv->vval.v_number = curwin->w_wrow + 1;
17359 * "winnr()" function
17361 /* ARGSUSED */
17362 static void
17363 f_winnr(argvars, rettv)
17364 typval_T *argvars;
17365 typval_T *rettv;
17367 int nr = 1;
17369 #ifdef FEAT_WINDOWS
17370 nr = get_winnr(curtab, &argvars[0]);
17371 #endif
17372 rettv->vval.v_number = nr;
17376 * "winrestcmd()" function
17378 /* ARGSUSED */
17379 static void
17380 f_winrestcmd(argvars, rettv)
17381 typval_T *argvars;
17382 typval_T *rettv;
17384 #ifdef FEAT_WINDOWS
17385 win_T *wp;
17386 int winnr = 1;
17387 garray_T ga;
17388 char_u buf[50];
17390 ga_init2(&ga, (int)sizeof(char), 70);
17391 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17393 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17394 ga_concat(&ga, buf);
17395 # ifdef FEAT_VERTSPLIT
17396 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17397 ga_concat(&ga, buf);
17398 # endif
17399 ++winnr;
17401 ga_append(&ga, NUL);
17403 rettv->vval.v_string = ga.ga_data;
17404 #else
17405 rettv->vval.v_string = NULL;
17406 #endif
17407 rettv->v_type = VAR_STRING;
17411 * "winrestview()" function
17413 /* ARGSUSED */
17414 static void
17415 f_winrestview(argvars, rettv)
17416 typval_T *argvars;
17417 typval_T *rettv;
17419 dict_T *dict;
17421 if (argvars[0].v_type != VAR_DICT
17422 || (dict = argvars[0].vval.v_dict) == NULL)
17423 EMSG(_(e_invarg));
17424 else
17426 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17427 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17428 #ifdef FEAT_VIRTUALEDIT
17429 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17430 #endif
17431 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17432 curwin->w_set_curswant = FALSE;
17434 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17435 #ifdef FEAT_DIFF
17436 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17437 #endif
17438 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17439 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17441 check_cursor();
17442 changed_cline_bef_curs();
17443 invalidate_botline();
17444 redraw_later(VALID);
17446 if (curwin->w_topline == 0)
17447 curwin->w_topline = 1;
17448 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17449 curwin->w_topline = curbuf->b_ml.ml_line_count;
17450 #ifdef FEAT_DIFF
17451 check_topfill(curwin, TRUE);
17452 #endif
17457 * "winsaveview()" function
17459 /* ARGSUSED */
17460 static void
17461 f_winsaveview(argvars, rettv)
17462 typval_T *argvars;
17463 typval_T *rettv;
17465 dict_T *dict;
17467 dict = dict_alloc();
17468 if (dict == NULL)
17469 return;
17470 rettv->v_type = VAR_DICT;
17471 rettv->vval.v_dict = dict;
17472 ++dict->dv_refcount;
17474 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17475 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17476 #ifdef FEAT_VIRTUALEDIT
17477 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17478 #endif
17479 update_curswant();
17480 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17482 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17483 #ifdef FEAT_DIFF
17484 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17485 #endif
17486 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17487 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17491 * "winwidth(nr)" function
17493 static void
17494 f_winwidth(argvars, rettv)
17495 typval_T *argvars;
17496 typval_T *rettv;
17498 win_T *wp;
17500 wp = find_win_by_nr(&argvars[0], NULL);
17501 if (wp == NULL)
17502 rettv->vval.v_number = -1;
17503 else
17504 #ifdef FEAT_VERTSPLIT
17505 rettv->vval.v_number = wp->w_width;
17506 #else
17507 rettv->vval.v_number = Columns;
17508 #endif
17512 * "writefile()" function
17514 static void
17515 f_writefile(argvars, rettv)
17516 typval_T *argvars;
17517 typval_T *rettv;
17519 int binary = FALSE;
17520 char_u *fname;
17521 FILE *fd;
17522 listitem_T *li;
17523 char_u *s;
17524 int ret = 0;
17525 int c;
17527 if (check_restricted() || check_secure())
17528 return;
17530 if (argvars[0].v_type != VAR_LIST)
17532 EMSG2(_(e_listarg), "writefile()");
17533 return;
17535 if (argvars[0].vval.v_list == NULL)
17536 return;
17538 if (argvars[2].v_type != VAR_UNKNOWN
17539 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17540 binary = TRUE;
17542 /* Always open the file in binary mode, library functions have a mind of
17543 * their own about CR-LF conversion. */
17544 fname = get_tv_string(&argvars[1]);
17545 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17547 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17548 ret = -1;
17550 else
17552 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17553 li = li->li_next)
17555 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17557 if (*s == '\n')
17558 c = putc(NUL, fd);
17559 else
17560 c = putc(*s, fd);
17561 if (c == EOF)
17563 ret = -1;
17564 break;
17567 if (!binary || li->li_next != NULL)
17568 if (putc('\n', fd) == EOF)
17570 ret = -1;
17571 break;
17573 if (ret < 0)
17575 EMSG(_(e_write));
17576 break;
17579 fclose(fd);
17582 rettv->vval.v_number = ret;
17586 * Translate a String variable into a position.
17587 * Returns NULL when there is an error.
17589 static pos_T *
17590 var2fpos(varp, dollar_lnum, fnum)
17591 typval_T *varp;
17592 int dollar_lnum; /* TRUE when $ is last line */
17593 int *fnum; /* set to fnum for '0, 'A, etc. */
17595 char_u *name;
17596 static pos_T pos;
17597 pos_T *pp;
17599 /* Argument can be [lnum, col, coladd]. */
17600 if (varp->v_type == VAR_LIST)
17602 list_T *l;
17603 int len;
17604 int error = FALSE;
17605 listitem_T *li;
17607 l = varp->vval.v_list;
17608 if (l == NULL)
17609 return NULL;
17611 /* Get the line number */
17612 pos.lnum = list_find_nr(l, 0L, &error);
17613 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17614 return NULL; /* invalid line number */
17616 /* Get the column number */
17617 pos.col = list_find_nr(l, 1L, &error);
17618 if (error)
17619 return NULL;
17620 len = (long)STRLEN(ml_get(pos.lnum));
17622 /* We accept "$" for the column number: last column. */
17623 li = list_find(l, 1L);
17624 if (li != NULL && li->li_tv.v_type == VAR_STRING
17625 && li->li_tv.vval.v_string != NULL
17626 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17627 pos.col = len + 1;
17629 /* Accept a position up to the NUL after the line. */
17630 if (pos.col == 0 || (int)pos.col > len + 1)
17631 return NULL; /* invalid column number */
17632 --pos.col;
17634 #ifdef FEAT_VIRTUALEDIT
17635 /* Get the virtual offset. Defaults to zero. */
17636 pos.coladd = list_find_nr(l, 2L, &error);
17637 if (error)
17638 pos.coladd = 0;
17639 #endif
17641 return &pos;
17644 name = get_tv_string_chk(varp);
17645 if (name == NULL)
17646 return NULL;
17647 if (name[0] == '.') /* cursor */
17648 return &curwin->w_cursor;
17649 #ifdef FEAT_VISUAL
17650 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17652 if (VIsual_active)
17653 return &VIsual;
17654 return &curwin->w_cursor;
17656 #endif
17657 if (name[0] == '\'') /* mark */
17659 pp = getmark_fnum(name[1], FALSE, fnum);
17660 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17661 return NULL;
17662 return pp;
17665 #ifdef FEAT_VIRTUALEDIT
17666 pos.coladd = 0;
17667 #endif
17669 if (name[0] == 'w' && dollar_lnum)
17671 pos.col = 0;
17672 if (name[1] == '0') /* "w0": first visible line */
17674 update_topline();
17675 pos.lnum = curwin->w_topline;
17676 return &pos;
17678 else if (name[1] == '$') /* "w$": last visible line */
17680 validate_botline();
17681 pos.lnum = curwin->w_botline - 1;
17682 return &pos;
17685 else if (name[0] == '$') /* last column or line */
17687 if (dollar_lnum)
17689 pos.lnum = curbuf->b_ml.ml_line_count;
17690 pos.col = 0;
17692 else
17694 pos.lnum = curwin->w_cursor.lnum;
17695 pos.col = (colnr_T)STRLEN(ml_get_curline());
17697 return &pos;
17699 return NULL;
17703 * Convert list in "arg" into a position and optional file number.
17704 * When "fnump" is NULL there is no file number, only 3 items.
17705 * Note that the column is passed on as-is, the caller may want to decrement
17706 * it to use 1 for the first column.
17707 * Return FAIL when conversion is not possible, doesn't check the position for
17708 * validity.
17710 static int
17711 list2fpos(arg, posp, fnump)
17712 typval_T *arg;
17713 pos_T *posp;
17714 int *fnump;
17716 list_T *l = arg->vval.v_list;
17717 long i = 0;
17718 long n;
17720 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17721 * when "fnump" isn't NULL and "coladd" is optional. */
17722 if (arg->v_type != VAR_LIST
17723 || l == NULL
17724 || l->lv_len < (fnump == NULL ? 2 : 3)
17725 || l->lv_len > (fnump == NULL ? 3 : 4))
17726 return FAIL;
17728 if (fnump != NULL)
17730 n = list_find_nr(l, i++, NULL); /* fnum */
17731 if (n < 0)
17732 return FAIL;
17733 if (n == 0)
17734 n = curbuf->b_fnum; /* current buffer */
17735 *fnump = n;
17738 n = list_find_nr(l, i++, NULL); /* lnum */
17739 if (n < 0)
17740 return FAIL;
17741 posp->lnum = n;
17743 n = list_find_nr(l, i++, NULL); /* col */
17744 if (n < 0)
17745 return FAIL;
17746 posp->col = n;
17748 #ifdef FEAT_VIRTUALEDIT
17749 n = list_find_nr(l, i, NULL);
17750 if (n < 0)
17751 posp->coladd = 0;
17752 else
17753 posp->coladd = n;
17754 #endif
17756 return OK;
17760 * Get the length of an environment variable name.
17761 * Advance "arg" to the first character after the name.
17762 * Return 0 for error.
17764 static int
17765 get_env_len(arg)
17766 char_u **arg;
17768 char_u *p;
17769 int len;
17771 for (p = *arg; vim_isIDc(*p); ++p)
17773 if (p == *arg) /* no name found */
17774 return 0;
17776 len = (int)(p - *arg);
17777 *arg = p;
17778 return len;
17782 * Get the length of the name of a function or internal variable.
17783 * "arg" is advanced to the first non-white character after the name.
17784 * Return 0 if something is wrong.
17786 static int
17787 get_id_len(arg)
17788 char_u **arg;
17790 char_u *p;
17791 int len;
17793 /* Find the end of the name. */
17794 for (p = *arg; eval_isnamec(*p); ++p)
17796 if (p == *arg) /* no name found */
17797 return 0;
17799 len = (int)(p - *arg);
17800 *arg = skipwhite(p);
17802 return len;
17806 * Get the length of the name of a variable or function.
17807 * Only the name is recognized, does not handle ".key" or "[idx]".
17808 * "arg" is advanced to the first non-white character after the name.
17809 * Return -1 if curly braces expansion failed.
17810 * Return 0 if something else is wrong.
17811 * If the name contains 'magic' {}'s, expand them and return the
17812 * expanded name in an allocated string via 'alias' - caller must free.
17814 static int
17815 get_name_len(arg, alias, evaluate, verbose)
17816 char_u **arg;
17817 char_u **alias;
17818 int evaluate;
17819 int verbose;
17821 int len;
17822 char_u *p;
17823 char_u *expr_start;
17824 char_u *expr_end;
17826 *alias = NULL; /* default to no alias */
17828 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17829 && (*arg)[2] == (int)KE_SNR)
17831 /* hard coded <SNR>, already translated */
17832 *arg += 3;
17833 return get_id_len(arg) + 3;
17835 len = eval_fname_script(*arg);
17836 if (len > 0)
17838 /* literal "<SID>", "s:" or "<SNR>" */
17839 *arg += len;
17843 * Find the end of the name; check for {} construction.
17845 p = find_name_end(*arg, &expr_start, &expr_end,
17846 len > 0 ? 0 : FNE_CHECK_START);
17847 if (expr_start != NULL)
17849 char_u *temp_string;
17851 if (!evaluate)
17853 len += (int)(p - *arg);
17854 *arg = skipwhite(p);
17855 return len;
17859 * Include any <SID> etc in the expanded string:
17860 * Thus the -len here.
17862 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17863 if (temp_string == NULL)
17864 return -1;
17865 *alias = temp_string;
17866 *arg = skipwhite(p);
17867 return (int)STRLEN(temp_string);
17870 len += get_id_len(arg);
17871 if (len == 0 && verbose)
17872 EMSG2(_(e_invexpr2), *arg);
17874 return len;
17878 * Find the end of a variable or function name, taking care of magic braces.
17879 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17880 * start and end of the first magic braces item.
17881 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17882 * Return a pointer to just after the name. Equal to "arg" if there is no
17883 * valid name.
17885 static char_u *
17886 find_name_end(arg, expr_start, expr_end, flags)
17887 char_u *arg;
17888 char_u **expr_start;
17889 char_u **expr_end;
17890 int flags;
17892 int mb_nest = 0;
17893 int br_nest = 0;
17894 char_u *p;
17896 if (expr_start != NULL)
17898 *expr_start = NULL;
17899 *expr_end = NULL;
17902 /* Quick check for valid starting character. */
17903 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17904 return arg;
17906 for (p = arg; *p != NUL
17907 && (eval_isnamec(*p)
17908 || *p == '{'
17909 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17910 || mb_nest != 0
17911 || br_nest != 0); mb_ptr_adv(p))
17913 if (*p == '\'')
17915 /* skip over 'string' to avoid counting [ and ] inside it. */
17916 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17918 if (*p == NUL)
17919 break;
17921 else if (*p == '"')
17923 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17924 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17925 if (*p == '\\' && p[1] != NUL)
17926 ++p;
17927 if (*p == NUL)
17928 break;
17931 if (mb_nest == 0)
17933 if (*p == '[')
17934 ++br_nest;
17935 else if (*p == ']')
17936 --br_nest;
17939 if (br_nest == 0)
17941 if (*p == '{')
17943 mb_nest++;
17944 if (expr_start != NULL && *expr_start == NULL)
17945 *expr_start = p;
17947 else if (*p == '}')
17949 mb_nest--;
17950 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
17951 *expr_end = p;
17956 return p;
17960 * Expands out the 'magic' {}'s in a variable/function name.
17961 * Note that this can call itself recursively, to deal with
17962 * constructs like foo{bar}{baz}{bam}
17963 * The four pointer arguments point to "foo{expre}ss{ion}bar"
17964 * "in_start" ^
17965 * "expr_start" ^
17966 * "expr_end" ^
17967 * "in_end" ^
17969 * Returns a new allocated string, which the caller must free.
17970 * Returns NULL for failure.
17972 static char_u *
17973 make_expanded_name(in_start, expr_start, expr_end, in_end)
17974 char_u *in_start;
17975 char_u *expr_start;
17976 char_u *expr_end;
17977 char_u *in_end;
17979 char_u c1;
17980 char_u *retval = NULL;
17981 char_u *temp_result;
17982 char_u *nextcmd = NULL;
17984 if (expr_end == NULL || in_end == NULL)
17985 return NULL;
17986 *expr_start = NUL;
17987 *expr_end = NUL;
17988 c1 = *in_end;
17989 *in_end = NUL;
17991 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
17992 if (temp_result != NULL && nextcmd == NULL)
17994 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
17995 + (in_end - expr_end) + 1));
17996 if (retval != NULL)
17998 STRCPY(retval, in_start);
17999 STRCAT(retval, temp_result);
18000 STRCAT(retval, expr_end + 1);
18003 vim_free(temp_result);
18005 *in_end = c1; /* put char back for error messages */
18006 *expr_start = '{';
18007 *expr_end = '}';
18009 if (retval != NULL)
18011 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18012 if (expr_start != NULL)
18014 /* Further expansion! */
18015 temp_result = make_expanded_name(retval, expr_start,
18016 expr_end, temp_result);
18017 vim_free(retval);
18018 retval = temp_result;
18022 return retval;
18026 * Return TRUE if character "c" can be used in a variable or function name.
18027 * Does not include '{' or '}' for magic braces.
18029 static int
18030 eval_isnamec(c)
18031 int c;
18033 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18037 * Return TRUE if character "c" can be used as the first character in a
18038 * variable or function name (excluding '{' and '}').
18040 static int
18041 eval_isnamec1(c)
18042 int c;
18044 return (ASCII_ISALPHA(c) || c == '_');
18048 * Set number v: variable to "val".
18050 void
18051 set_vim_var_nr(idx, val)
18052 int idx;
18053 long val;
18055 vimvars[idx].vv_nr = val;
18059 * Get number v: variable value.
18061 long
18062 get_vim_var_nr(idx)
18063 int idx;
18065 return vimvars[idx].vv_nr;
18068 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18070 * Get string v: variable value. Uses a static buffer, can only be used once.
18072 char_u *
18073 get_vim_var_str(idx)
18074 int idx;
18076 return get_tv_string(&vimvars[idx].vv_tv);
18078 #endif
18081 * Set v:count, v:count1 and v:prevcount.
18083 void
18084 set_vcount(count, count1)
18085 long count;
18086 long count1;
18088 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18089 vimvars[VV_COUNT].vv_nr = count;
18090 vimvars[VV_COUNT1].vv_nr = count1;
18094 * Set string v: variable to a copy of "val".
18096 void
18097 set_vim_var_string(idx, val, len)
18098 int idx;
18099 char_u *val;
18100 int len; /* length of "val" to use or -1 (whole string) */
18102 /* Need to do this (at least) once, since we can't initialize a union.
18103 * Will always be invoked when "v:progname" is set. */
18104 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18106 vim_free(vimvars[idx].vv_str);
18107 if (val == NULL)
18108 vimvars[idx].vv_str = NULL;
18109 else if (len == -1)
18110 vimvars[idx].vv_str = vim_strsave(val);
18111 else
18112 vimvars[idx].vv_str = vim_strnsave(val, len);
18116 * Set v:register if needed.
18118 void
18119 set_reg_var(c)
18120 int c;
18122 char_u regname;
18124 if (c == 0 || c == ' ')
18125 regname = '"';
18126 else
18127 regname = c;
18128 /* Avoid free/alloc when the value is already right. */
18129 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18130 set_vim_var_string(VV_REG, &regname, 1);
18134 * Get or set v:exception. If "oldval" == NULL, return the current value.
18135 * Otherwise, restore the value to "oldval" and return NULL.
18136 * Must always be called in pairs to save and restore v:exception! Does not
18137 * take care of memory allocations.
18139 char_u *
18140 v_exception(oldval)
18141 char_u *oldval;
18143 if (oldval == NULL)
18144 return vimvars[VV_EXCEPTION].vv_str;
18146 vimvars[VV_EXCEPTION].vv_str = oldval;
18147 return NULL;
18151 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18152 * Otherwise, restore the value to "oldval" and return NULL.
18153 * Must always be called in pairs to save and restore v:throwpoint! Does not
18154 * take care of memory allocations.
18156 char_u *
18157 v_throwpoint(oldval)
18158 char_u *oldval;
18160 if (oldval == NULL)
18161 return vimvars[VV_THROWPOINT].vv_str;
18163 vimvars[VV_THROWPOINT].vv_str = oldval;
18164 return NULL;
18167 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18169 * Set v:cmdarg.
18170 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18171 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18172 * Must always be called in pairs!
18174 char_u *
18175 set_cmdarg(eap, oldarg)
18176 exarg_T *eap;
18177 char_u *oldarg;
18179 char_u *oldval;
18180 char_u *newval;
18181 unsigned len;
18183 oldval = vimvars[VV_CMDARG].vv_str;
18184 if (eap == NULL)
18186 vim_free(oldval);
18187 vimvars[VV_CMDARG].vv_str = oldarg;
18188 return NULL;
18191 if (eap->force_bin == FORCE_BIN)
18192 len = 6;
18193 else if (eap->force_bin == FORCE_NOBIN)
18194 len = 8;
18195 else
18196 len = 0;
18198 if (eap->read_edit)
18199 len += 7;
18201 if (eap->force_ff != 0)
18202 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18203 # ifdef FEAT_MBYTE
18204 if (eap->force_enc != 0)
18205 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18206 if (eap->bad_char != 0)
18207 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18208 # endif
18210 newval = alloc(len + 1);
18211 if (newval == NULL)
18212 return NULL;
18214 if (eap->force_bin == FORCE_BIN)
18215 sprintf((char *)newval, " ++bin");
18216 else if (eap->force_bin == FORCE_NOBIN)
18217 sprintf((char *)newval, " ++nobin");
18218 else
18219 *newval = NUL;
18221 if (eap->read_edit)
18222 STRCAT(newval, " ++edit");
18224 if (eap->force_ff != 0)
18225 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18226 eap->cmd + eap->force_ff);
18227 # ifdef FEAT_MBYTE
18228 if (eap->force_enc != 0)
18229 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18230 eap->cmd + eap->force_enc);
18231 if (eap->bad_char != 0)
18232 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18233 eap->cmd + eap->bad_char);
18234 # endif
18235 vimvars[VV_CMDARG].vv_str = newval;
18236 return oldval;
18238 #endif
18241 * Get the value of internal variable "name".
18242 * Return OK or FAIL.
18244 static int
18245 get_var_tv(name, len, rettv, verbose)
18246 char_u *name;
18247 int len; /* length of "name" */
18248 typval_T *rettv; /* NULL when only checking existence */
18249 int verbose; /* may give error message */
18251 int ret = OK;
18252 typval_T *tv = NULL;
18253 typval_T atv;
18254 dictitem_T *v;
18255 int cc;
18257 /* truncate the name, so that we can use strcmp() */
18258 cc = name[len];
18259 name[len] = NUL;
18262 * Check for "b:changedtick".
18264 if (STRCMP(name, "b:changedtick") == 0)
18266 atv.v_type = VAR_NUMBER;
18267 atv.vval.v_number = curbuf->b_changedtick;
18268 tv = &atv;
18272 * Check for user-defined variables.
18274 else
18276 v = find_var(name, NULL);
18277 if (v != NULL)
18278 tv = &v->di_tv;
18281 if (tv == NULL)
18283 if (rettv != NULL && verbose)
18284 EMSG2(_(e_undefvar), name);
18285 ret = FAIL;
18287 else if (rettv != NULL)
18288 copy_tv(tv, rettv);
18290 name[len] = cc;
18292 return ret;
18296 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18297 * Also handle function call with Funcref variable: func(expr)
18298 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18300 static int
18301 handle_subscript(arg, rettv, evaluate, verbose)
18302 char_u **arg;
18303 typval_T *rettv;
18304 int evaluate; /* do more than finding the end */
18305 int verbose; /* give error messages */
18307 int ret = OK;
18308 dict_T *selfdict = NULL;
18309 char_u *s;
18310 int len;
18311 typval_T functv;
18313 while (ret == OK
18314 && (**arg == '['
18315 || (**arg == '.' && rettv->v_type == VAR_DICT)
18316 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18317 && !vim_iswhite(*(*arg - 1)))
18319 if (**arg == '(')
18321 /* need to copy the funcref so that we can clear rettv */
18322 functv = *rettv;
18323 rettv->v_type = VAR_UNKNOWN;
18325 /* Invoke the function. Recursive! */
18326 s = functv.vval.v_string;
18327 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18328 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18329 &len, evaluate, selfdict);
18331 /* Clear the funcref afterwards, so that deleting it while
18332 * evaluating the arguments is possible (see test55). */
18333 clear_tv(&functv);
18335 /* Stop the expression evaluation when immediately aborting on
18336 * error, or when an interrupt occurred or an exception was thrown
18337 * but not caught. */
18338 if (aborting())
18340 if (ret == OK)
18341 clear_tv(rettv);
18342 ret = FAIL;
18344 dict_unref(selfdict);
18345 selfdict = NULL;
18347 else /* **arg == '[' || **arg == '.' */
18349 dict_unref(selfdict);
18350 if (rettv->v_type == VAR_DICT)
18352 selfdict = rettv->vval.v_dict;
18353 if (selfdict != NULL)
18354 ++selfdict->dv_refcount;
18356 else
18357 selfdict = NULL;
18358 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18360 clear_tv(rettv);
18361 ret = FAIL;
18365 dict_unref(selfdict);
18366 return ret;
18370 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18371 * value).
18373 static typval_T *
18374 alloc_tv()
18376 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18380 * Allocate memory for a variable type-value, and assign a string to it.
18381 * The string "s" must have been allocated, it is consumed.
18382 * Return NULL for out of memory, the variable otherwise.
18384 static typval_T *
18385 alloc_string_tv(s)
18386 char_u *s;
18388 typval_T *rettv;
18390 rettv = alloc_tv();
18391 if (rettv != NULL)
18393 rettv->v_type = VAR_STRING;
18394 rettv->vval.v_string = s;
18396 else
18397 vim_free(s);
18398 return rettv;
18402 * Free the memory for a variable type-value.
18404 void
18405 free_tv(varp)
18406 typval_T *varp;
18408 if (varp != NULL)
18410 switch (varp->v_type)
18412 case VAR_FUNC:
18413 func_unref(varp->vval.v_string);
18414 /*FALLTHROUGH*/
18415 case VAR_STRING:
18416 vim_free(varp->vval.v_string);
18417 break;
18418 case VAR_LIST:
18419 list_unref(varp->vval.v_list);
18420 break;
18421 case VAR_DICT:
18422 dict_unref(varp->vval.v_dict);
18423 break;
18424 case VAR_NUMBER:
18425 #ifdef FEAT_FLOAT
18426 case VAR_FLOAT:
18427 #endif
18428 case VAR_UNKNOWN:
18429 break;
18430 default:
18431 EMSG2(_(e_intern2), "free_tv()");
18432 break;
18434 vim_free(varp);
18439 * Free the memory for a variable value and set the value to NULL or 0.
18441 void
18442 clear_tv(varp)
18443 typval_T *varp;
18445 if (varp != NULL)
18447 switch (varp->v_type)
18449 case VAR_FUNC:
18450 func_unref(varp->vval.v_string);
18451 /*FALLTHROUGH*/
18452 case VAR_STRING:
18453 vim_free(varp->vval.v_string);
18454 varp->vval.v_string = NULL;
18455 break;
18456 case VAR_LIST:
18457 list_unref(varp->vval.v_list);
18458 varp->vval.v_list = NULL;
18459 break;
18460 case VAR_DICT:
18461 dict_unref(varp->vval.v_dict);
18462 varp->vval.v_dict = NULL;
18463 break;
18464 case VAR_NUMBER:
18465 varp->vval.v_number = 0;
18466 break;
18467 #ifdef FEAT_FLOAT
18468 case VAR_FLOAT:
18469 varp->vval.v_float = 0.0;
18470 break;
18471 #endif
18472 case VAR_UNKNOWN:
18473 break;
18474 default:
18475 EMSG2(_(e_intern2), "clear_tv()");
18477 varp->v_lock = 0;
18482 * Set the value of a variable to NULL without freeing items.
18484 static void
18485 init_tv(varp)
18486 typval_T *varp;
18488 if (varp != NULL)
18489 vim_memset(varp, 0, sizeof(typval_T));
18493 * Get the number value of a variable.
18494 * If it is a String variable, uses vim_str2nr().
18495 * For incompatible types, return 0.
18496 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18497 * caller of incompatible types: it sets *denote to TRUE if "denote"
18498 * is not NULL or returns -1 otherwise.
18500 static long
18501 get_tv_number(varp)
18502 typval_T *varp;
18504 int error = FALSE;
18506 return get_tv_number_chk(varp, &error); /* return 0L on error */
18509 long
18510 get_tv_number_chk(varp, denote)
18511 typval_T *varp;
18512 int *denote;
18514 long n = 0L;
18516 switch (varp->v_type)
18518 case VAR_NUMBER:
18519 return (long)(varp->vval.v_number);
18520 #ifdef FEAT_FLOAT
18521 case VAR_FLOAT:
18522 EMSG(_("E805: Using a Float as a Number"));
18523 break;
18524 #endif
18525 case VAR_FUNC:
18526 EMSG(_("E703: Using a Funcref as a Number"));
18527 break;
18528 case VAR_STRING:
18529 if (varp->vval.v_string != NULL)
18530 vim_str2nr(varp->vval.v_string, NULL, NULL,
18531 TRUE, TRUE, &n, NULL);
18532 return n;
18533 case VAR_LIST:
18534 EMSG(_("E745: Using a List as a Number"));
18535 break;
18536 case VAR_DICT:
18537 EMSG(_("E728: Using a Dictionary as a Number"));
18538 break;
18539 default:
18540 EMSG2(_(e_intern2), "get_tv_number()");
18541 break;
18543 if (denote == NULL) /* useful for values that must be unsigned */
18544 n = -1;
18545 else
18546 *denote = TRUE;
18547 return n;
18551 * Get the lnum from the first argument.
18552 * Also accepts ".", "$", etc., but that only works for the current buffer.
18553 * Returns -1 on error.
18555 static linenr_T
18556 get_tv_lnum(argvars)
18557 typval_T *argvars;
18559 typval_T rettv;
18560 linenr_T lnum;
18562 lnum = get_tv_number_chk(&argvars[0], NULL);
18563 if (lnum == 0) /* no valid number, try using line() */
18565 rettv.v_type = VAR_NUMBER;
18566 f_line(argvars, &rettv);
18567 lnum = rettv.vval.v_number;
18568 clear_tv(&rettv);
18570 return lnum;
18574 * Get the lnum from the first argument.
18575 * Also accepts "$", then "buf" is used.
18576 * Returns 0 on error.
18578 static linenr_T
18579 get_tv_lnum_buf(argvars, buf)
18580 typval_T *argvars;
18581 buf_T *buf;
18583 if (argvars[0].v_type == VAR_STRING
18584 && argvars[0].vval.v_string != NULL
18585 && argvars[0].vval.v_string[0] == '$'
18586 && buf != NULL)
18587 return buf->b_ml.ml_line_count;
18588 return get_tv_number_chk(&argvars[0], NULL);
18592 * Get the string value of a variable.
18593 * If it is a Number variable, the number is converted into a string.
18594 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18595 * get_tv_string_buf() uses a given buffer.
18596 * If the String variable has never been set, return an empty string.
18597 * Never returns NULL;
18598 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18599 * NULL on error.
18601 static char_u *
18602 get_tv_string(varp)
18603 typval_T *varp;
18605 static char_u mybuf[NUMBUFLEN];
18607 return get_tv_string_buf(varp, mybuf);
18610 static char_u *
18611 get_tv_string_buf(varp, buf)
18612 typval_T *varp;
18613 char_u *buf;
18615 char_u *res = get_tv_string_buf_chk(varp, buf);
18617 return res != NULL ? res : (char_u *)"";
18620 char_u *
18621 get_tv_string_chk(varp)
18622 typval_T *varp;
18624 static char_u mybuf[NUMBUFLEN];
18626 return get_tv_string_buf_chk(varp, mybuf);
18629 static char_u *
18630 get_tv_string_buf_chk(varp, buf)
18631 typval_T *varp;
18632 char_u *buf;
18634 switch (varp->v_type)
18636 case VAR_NUMBER:
18637 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18638 return buf;
18639 case VAR_FUNC:
18640 EMSG(_("E729: using Funcref as a String"));
18641 break;
18642 case VAR_LIST:
18643 EMSG(_("E730: using List as a String"));
18644 break;
18645 case VAR_DICT:
18646 EMSG(_("E731: using Dictionary as a String"));
18647 break;
18648 #ifdef FEAT_FLOAT
18649 case VAR_FLOAT:
18650 EMSG(_("E806: using Float as a String"));
18651 break;
18652 #endif
18653 case VAR_STRING:
18654 if (varp->vval.v_string != NULL)
18655 return varp->vval.v_string;
18656 return (char_u *)"";
18657 default:
18658 EMSG2(_(e_intern2), "get_tv_string_buf()");
18659 break;
18661 return NULL;
18665 * Find variable "name" in the list of variables.
18666 * Return a pointer to it if found, NULL if not found.
18667 * Careful: "a:0" variables don't have a name.
18668 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18669 * hashtab_T used.
18671 static dictitem_T *
18672 find_var(name, htp)
18673 char_u *name;
18674 hashtab_T **htp;
18676 char_u *varname;
18677 hashtab_T *ht;
18679 ht = find_var_ht(name, &varname);
18680 if (htp != NULL)
18681 *htp = ht;
18682 if (ht == NULL)
18683 return NULL;
18684 return find_var_in_ht(ht, varname, htp != NULL);
18688 * Find variable "varname" in hashtab "ht".
18689 * Returns NULL if not found.
18691 static dictitem_T *
18692 find_var_in_ht(ht, varname, writing)
18693 hashtab_T *ht;
18694 char_u *varname;
18695 int writing;
18697 hashitem_T *hi;
18699 if (*varname == NUL)
18701 /* Must be something like "s:", otherwise "ht" would be NULL. */
18702 switch (varname[-2])
18704 case 's': return &SCRIPT_SV(current_SID).sv_var;
18705 case 'g': return &globvars_var;
18706 case 'v': return &vimvars_var;
18707 case 'b': return &curbuf->b_bufvar;
18708 case 'w': return &curwin->w_winvar;
18709 #ifdef FEAT_WINDOWS
18710 case 't': return &curtab->tp_winvar;
18711 #endif
18712 case 'l': return current_funccal == NULL
18713 ? NULL : &current_funccal->l_vars_var;
18714 case 'a': return current_funccal == NULL
18715 ? NULL : &current_funccal->l_avars_var;
18717 return NULL;
18720 hi = hash_find(ht, varname);
18721 if (HASHITEM_EMPTY(hi))
18723 /* For global variables we may try auto-loading the script. If it
18724 * worked find the variable again. Don't auto-load a script if it was
18725 * loaded already, otherwise it would be loaded every time when
18726 * checking if a function name is a Funcref variable. */
18727 if (ht == &globvarht && !writing
18728 && script_autoload(varname, FALSE) && !aborting())
18729 hi = hash_find(ht, varname);
18730 if (HASHITEM_EMPTY(hi))
18731 return NULL;
18733 return HI2DI(hi);
18737 * Find the hashtab used for a variable name.
18738 * Set "varname" to the start of name without ':'.
18740 static hashtab_T *
18741 find_var_ht(name, varname)
18742 char_u *name;
18743 char_u **varname;
18745 hashitem_T *hi;
18747 if (name[1] != ':')
18749 /* The name must not start with a colon or #. */
18750 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18751 return NULL;
18752 *varname = name;
18754 /* "version" is "v:version" in all scopes */
18755 hi = hash_find(&compat_hashtab, name);
18756 if (!HASHITEM_EMPTY(hi))
18757 return &compat_hashtab;
18759 if (current_funccal == NULL)
18760 return &globvarht; /* global variable */
18761 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18763 *varname = name + 2;
18764 if (*name == 'g') /* global variable */
18765 return &globvarht;
18766 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18768 if (vim_strchr(name + 2, ':') != NULL
18769 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18770 return NULL;
18771 if (*name == 'b') /* buffer variable */
18772 return &curbuf->b_vars.dv_hashtab;
18773 if (*name == 'w') /* window variable */
18774 return &curwin->w_vars.dv_hashtab;
18775 #ifdef FEAT_WINDOWS
18776 if (*name == 't') /* tab page variable */
18777 return &curtab->tp_vars.dv_hashtab;
18778 #endif
18779 if (*name == 'v') /* v: variable */
18780 return &vimvarht;
18781 if (*name == 'a' && current_funccal != NULL) /* function argument */
18782 return &current_funccal->l_avars.dv_hashtab;
18783 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18784 return &current_funccal->l_vars.dv_hashtab;
18785 if (*name == 's' /* script variable */
18786 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18787 return &SCRIPT_VARS(current_SID);
18788 return NULL;
18792 * Get the string value of a (global/local) variable.
18793 * Returns NULL when it doesn't exist.
18795 char_u *
18796 get_var_value(name)
18797 char_u *name;
18799 dictitem_T *v;
18801 v = find_var(name, NULL);
18802 if (v == NULL)
18803 return NULL;
18804 return get_tv_string(&v->di_tv);
18808 * Allocate a new hashtab for a sourced script. It will be used while
18809 * sourcing this script and when executing functions defined in the script.
18811 void
18812 new_script_vars(id)
18813 scid_T id;
18815 int i;
18816 hashtab_T *ht;
18817 scriptvar_T *sv;
18819 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18821 /* Re-allocating ga_data means that an ht_array pointing to
18822 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18823 * at its init value. Also reset "v_dict", it's always the same. */
18824 for (i = 1; i <= ga_scripts.ga_len; ++i)
18826 ht = &SCRIPT_VARS(i);
18827 if (ht->ht_mask == HT_INIT_SIZE - 1)
18828 ht->ht_array = ht->ht_smallarray;
18829 sv = &SCRIPT_SV(i);
18830 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18833 while (ga_scripts.ga_len < id)
18835 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18836 init_var_dict(&sv->sv_dict, &sv->sv_var);
18837 ++ga_scripts.ga_len;
18843 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18844 * point to it.
18846 void
18847 init_var_dict(dict, dict_var)
18848 dict_T *dict;
18849 dictitem_T *dict_var;
18851 hash_init(&dict->dv_hashtab);
18852 dict->dv_refcount = 99999;
18853 dict_var->di_tv.vval.v_dict = dict;
18854 dict_var->di_tv.v_type = VAR_DICT;
18855 dict_var->di_tv.v_lock = VAR_FIXED;
18856 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18857 dict_var->di_key[0] = NUL;
18861 * Clean up a list of internal variables.
18862 * Frees all allocated variables and the value they contain.
18863 * Clears hashtab "ht", does not free it.
18865 void
18866 vars_clear(ht)
18867 hashtab_T *ht;
18869 vars_clear_ext(ht, TRUE);
18873 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18875 static void
18876 vars_clear_ext(ht, free_val)
18877 hashtab_T *ht;
18878 int free_val;
18880 int todo;
18881 hashitem_T *hi;
18882 dictitem_T *v;
18884 hash_lock(ht);
18885 todo = (int)ht->ht_used;
18886 for (hi = ht->ht_array; todo > 0; ++hi)
18888 if (!HASHITEM_EMPTY(hi))
18890 --todo;
18892 /* Free the variable. Don't remove it from the hashtab,
18893 * ht_array might change then. hash_clear() takes care of it
18894 * later. */
18895 v = HI2DI(hi);
18896 if (free_val)
18897 clear_tv(&v->di_tv);
18898 if ((v->di_flags & DI_FLAGS_FIX) == 0)
18899 vim_free(v);
18902 hash_clear(ht);
18903 ht->ht_used = 0;
18907 * Delete a variable from hashtab "ht" at item "hi".
18908 * Clear the variable value and free the dictitem.
18910 static void
18911 delete_var(ht, hi)
18912 hashtab_T *ht;
18913 hashitem_T *hi;
18915 dictitem_T *di = HI2DI(hi);
18917 hash_remove(ht, hi);
18918 clear_tv(&di->di_tv);
18919 vim_free(di);
18923 * List the value of one internal variable.
18925 static void
18926 list_one_var(v, prefix, first)
18927 dictitem_T *v;
18928 char_u *prefix;
18929 int *first;
18931 char_u *tofree;
18932 char_u *s;
18933 char_u numbuf[NUMBUFLEN];
18935 s = echo_string(&v->di_tv, &tofree, numbuf, ++current_copyID);
18936 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
18937 s == NULL ? (char_u *)"" : s, first);
18938 vim_free(tofree);
18941 static void
18942 list_one_var_a(prefix, name, type, string, first)
18943 char_u *prefix;
18944 char_u *name;
18945 int type;
18946 char_u *string;
18947 int *first; /* when TRUE clear rest of screen and set to FALSE */
18949 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
18950 msg_start();
18951 msg_puts(prefix);
18952 if (name != NULL) /* "a:" vars don't have a name stored */
18953 msg_puts(name);
18954 msg_putchar(' ');
18955 msg_advance(22);
18956 if (type == VAR_NUMBER)
18957 msg_putchar('#');
18958 else if (type == VAR_FUNC)
18959 msg_putchar('*');
18960 else if (type == VAR_LIST)
18962 msg_putchar('[');
18963 if (*string == '[')
18964 ++string;
18966 else if (type == VAR_DICT)
18968 msg_putchar('{');
18969 if (*string == '{')
18970 ++string;
18972 else
18973 msg_putchar(' ');
18975 msg_outtrans(string);
18977 if (type == VAR_FUNC)
18978 msg_puts((char_u *)"()");
18979 if (*first)
18981 msg_clr_eos();
18982 *first = FALSE;
18987 * Set variable "name" to value in "tv".
18988 * If the variable already exists, the value is updated.
18989 * Otherwise the variable is created.
18991 static void
18992 set_var(name, tv, copy)
18993 char_u *name;
18994 typval_T *tv;
18995 int copy; /* make copy of value in "tv" */
18997 dictitem_T *v;
18998 char_u *varname;
18999 hashtab_T *ht;
19000 char_u *p;
19002 if (tv->v_type == VAR_FUNC)
19004 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19005 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19006 ? name[2] : name[0]))
19008 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19009 return;
19011 if (function_exists(name))
19013 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19014 name);
19015 return;
19019 ht = find_var_ht(name, &varname);
19020 if (ht == NULL || *varname == NUL)
19022 EMSG2(_(e_illvar), name);
19023 return;
19026 v = find_var_in_ht(ht, varname, TRUE);
19027 if (v != NULL)
19029 /* existing variable, need to clear the value */
19030 if (var_check_ro(v->di_flags, name)
19031 || tv_check_lock(v->di_tv.v_lock, name))
19032 return;
19033 if (v->di_tv.v_type != tv->v_type
19034 && !((v->di_tv.v_type == VAR_STRING
19035 || v->di_tv.v_type == VAR_NUMBER)
19036 && (tv->v_type == VAR_STRING
19037 || tv->v_type == VAR_NUMBER))
19038 #ifdef FEAT_FLOAT
19039 && !((v->di_tv.v_type == VAR_NUMBER
19040 || v->di_tv.v_type == VAR_FLOAT)
19041 && (tv->v_type == VAR_NUMBER
19042 || tv->v_type == VAR_FLOAT))
19043 #endif
19046 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19047 return;
19051 * Handle setting internal v: variables separately: we don't change
19052 * the type.
19054 if (ht == &vimvarht)
19056 if (v->di_tv.v_type == VAR_STRING)
19058 vim_free(v->di_tv.vval.v_string);
19059 if (copy || tv->v_type != VAR_STRING)
19060 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19061 else
19063 /* Take over the string to avoid an extra alloc/free. */
19064 v->di_tv.vval.v_string = tv->vval.v_string;
19065 tv->vval.v_string = NULL;
19068 else if (v->di_tv.v_type != VAR_NUMBER)
19069 EMSG2(_(e_intern2), "set_var()");
19070 else
19072 v->di_tv.vval.v_number = get_tv_number(tv);
19073 if (STRCMP(varname, "searchforward") == 0)
19074 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19076 return;
19079 clear_tv(&v->di_tv);
19081 else /* add a new variable */
19083 /* Can't add "v:" variable. */
19084 if (ht == &vimvarht)
19086 EMSG2(_(e_illvar), name);
19087 return;
19090 /* Make sure the variable name is valid. */
19091 for (p = varname; *p != NUL; ++p)
19092 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19093 && *p != AUTOLOAD_CHAR)
19095 EMSG2(_(e_illvar), varname);
19096 return;
19099 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19100 + STRLEN(varname)));
19101 if (v == NULL)
19102 return;
19103 STRCPY(v->di_key, varname);
19104 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19106 vim_free(v);
19107 return;
19109 v->di_flags = 0;
19112 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19113 copy_tv(tv, &v->di_tv);
19114 else
19116 v->di_tv = *tv;
19117 v->di_tv.v_lock = 0;
19118 init_tv(tv);
19123 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19124 * Also give an error message.
19126 static int
19127 var_check_ro(flags, name)
19128 int flags;
19129 char_u *name;
19131 if (flags & DI_FLAGS_RO)
19133 EMSG2(_(e_readonlyvar), name);
19134 return TRUE;
19136 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19138 EMSG2(_(e_readonlysbx), name);
19139 return TRUE;
19141 return FALSE;
19145 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19146 * Also give an error message.
19148 static int
19149 var_check_fixed(flags, name)
19150 int flags;
19151 char_u *name;
19153 if (flags & DI_FLAGS_FIX)
19155 EMSG2(_("E795: Cannot delete variable %s"), name);
19156 return TRUE;
19158 return FALSE;
19162 * Return TRUE if typeval "tv" is set to be locked (immutable).
19163 * Also give an error message, using "name".
19165 static int
19166 tv_check_lock(lock, name)
19167 int lock;
19168 char_u *name;
19170 if (lock & VAR_LOCKED)
19172 EMSG2(_("E741: Value is locked: %s"),
19173 name == NULL ? (char_u *)_("Unknown") : name);
19174 return TRUE;
19176 if (lock & VAR_FIXED)
19178 EMSG2(_("E742: Cannot change value of %s"),
19179 name == NULL ? (char_u *)_("Unknown") : name);
19180 return TRUE;
19182 return FALSE;
19186 * Copy the values from typval_T "from" to typval_T "to".
19187 * When needed allocates string or increases reference count.
19188 * Does not make a copy of a list or dict but copies the reference!
19190 static void
19191 copy_tv(from, to)
19192 typval_T *from;
19193 typval_T *to;
19195 to->v_type = from->v_type;
19196 to->v_lock = 0;
19197 switch (from->v_type)
19199 case VAR_NUMBER:
19200 to->vval.v_number = from->vval.v_number;
19201 break;
19202 #ifdef FEAT_FLOAT
19203 case VAR_FLOAT:
19204 to->vval.v_float = from->vval.v_float;
19205 break;
19206 #endif
19207 case VAR_STRING:
19208 case VAR_FUNC:
19209 if (from->vval.v_string == NULL)
19210 to->vval.v_string = NULL;
19211 else
19213 to->vval.v_string = vim_strsave(from->vval.v_string);
19214 if (from->v_type == VAR_FUNC)
19215 func_ref(to->vval.v_string);
19217 break;
19218 case VAR_LIST:
19219 if (from->vval.v_list == NULL)
19220 to->vval.v_list = NULL;
19221 else
19223 to->vval.v_list = from->vval.v_list;
19224 ++to->vval.v_list->lv_refcount;
19226 break;
19227 case VAR_DICT:
19228 if (from->vval.v_dict == NULL)
19229 to->vval.v_dict = NULL;
19230 else
19232 to->vval.v_dict = from->vval.v_dict;
19233 ++to->vval.v_dict->dv_refcount;
19235 break;
19236 default:
19237 EMSG2(_(e_intern2), "copy_tv()");
19238 break;
19243 * Make a copy of an item.
19244 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19245 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19246 * reference to an already copied list/dict can be used.
19247 * Returns FAIL or OK.
19249 static int
19250 item_copy(from, to, deep, copyID)
19251 typval_T *from;
19252 typval_T *to;
19253 int deep;
19254 int copyID;
19256 static int recurse = 0;
19257 int ret = OK;
19259 if (recurse >= DICT_MAXNEST)
19261 EMSG(_("E698: variable nested too deep for making a copy"));
19262 return FAIL;
19264 ++recurse;
19266 switch (from->v_type)
19268 case VAR_NUMBER:
19269 #ifdef FEAT_FLOAT
19270 case VAR_FLOAT:
19271 #endif
19272 case VAR_STRING:
19273 case VAR_FUNC:
19274 copy_tv(from, to);
19275 break;
19276 case VAR_LIST:
19277 to->v_type = VAR_LIST;
19278 to->v_lock = 0;
19279 if (from->vval.v_list == NULL)
19280 to->vval.v_list = NULL;
19281 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19283 /* use the copy made earlier */
19284 to->vval.v_list = from->vval.v_list->lv_copylist;
19285 ++to->vval.v_list->lv_refcount;
19287 else
19288 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19289 if (to->vval.v_list == NULL)
19290 ret = FAIL;
19291 break;
19292 case VAR_DICT:
19293 to->v_type = VAR_DICT;
19294 to->v_lock = 0;
19295 if (from->vval.v_dict == NULL)
19296 to->vval.v_dict = NULL;
19297 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19299 /* use the copy made earlier */
19300 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19301 ++to->vval.v_dict->dv_refcount;
19303 else
19304 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19305 if (to->vval.v_dict == NULL)
19306 ret = FAIL;
19307 break;
19308 default:
19309 EMSG2(_(e_intern2), "item_copy()");
19310 ret = FAIL;
19312 --recurse;
19313 return ret;
19317 * ":echo expr1 ..." print each argument separated with a space, add a
19318 * newline at the end.
19319 * ":echon expr1 ..." print each argument plain.
19321 void
19322 ex_echo(eap)
19323 exarg_T *eap;
19325 char_u *arg = eap->arg;
19326 typval_T rettv;
19327 char_u *tofree;
19328 char_u *p;
19329 int needclr = TRUE;
19330 int atstart = TRUE;
19331 char_u numbuf[NUMBUFLEN];
19333 if (eap->skip)
19334 ++emsg_skip;
19335 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19337 /* If eval1() causes an error message the text from the command may
19338 * still need to be cleared. E.g., "echo 22,44". */
19339 need_clr_eos = needclr;
19341 p = arg;
19342 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19345 * Report the invalid expression unless the expression evaluation
19346 * has been cancelled due to an aborting error, an interrupt, or an
19347 * exception.
19349 if (!aborting())
19350 EMSG2(_(e_invexpr2), p);
19351 need_clr_eos = FALSE;
19352 break;
19354 need_clr_eos = FALSE;
19356 if (!eap->skip)
19358 if (atstart)
19360 atstart = FALSE;
19361 /* Call msg_start() after eval1(), evaluating the expression
19362 * may cause a message to appear. */
19363 if (eap->cmdidx == CMD_echo)
19364 msg_start();
19366 else if (eap->cmdidx == CMD_echo)
19367 msg_puts_attr((char_u *)" ", echo_attr);
19368 p = echo_string(&rettv, &tofree, numbuf, ++current_copyID);
19369 if (p != NULL)
19370 for ( ; *p != NUL && !got_int; ++p)
19372 if (*p == '\n' || *p == '\r' || *p == TAB)
19374 if (*p != TAB && needclr)
19376 /* remove any text still there from the command */
19377 msg_clr_eos();
19378 needclr = FALSE;
19380 msg_putchar_attr(*p, echo_attr);
19382 else
19384 #ifdef FEAT_MBYTE
19385 if (has_mbyte)
19387 int i = (*mb_ptr2len)(p);
19389 (void)msg_outtrans_len_attr(p, i, echo_attr);
19390 p += i - 1;
19392 else
19393 #endif
19394 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19397 vim_free(tofree);
19399 clear_tv(&rettv);
19400 arg = skipwhite(arg);
19402 eap->nextcmd = check_nextcmd(arg);
19404 if (eap->skip)
19405 --emsg_skip;
19406 else
19408 /* remove text that may still be there from the command */
19409 if (needclr)
19410 msg_clr_eos();
19411 if (eap->cmdidx == CMD_echo)
19412 msg_end();
19417 * ":echohl {name}".
19419 void
19420 ex_echohl(eap)
19421 exarg_T *eap;
19423 int id;
19425 id = syn_name2id(eap->arg);
19426 if (id == 0)
19427 echo_attr = 0;
19428 else
19429 echo_attr = syn_id2attr(id);
19433 * ":execute expr1 ..." execute the result of an expression.
19434 * ":echomsg expr1 ..." Print a message
19435 * ":echoerr expr1 ..." Print an error
19436 * Each gets spaces around each argument and a newline at the end for
19437 * echo commands
19439 void
19440 ex_execute(eap)
19441 exarg_T *eap;
19443 char_u *arg = eap->arg;
19444 typval_T rettv;
19445 int ret = OK;
19446 char_u *p;
19447 garray_T ga;
19448 int len;
19449 int save_did_emsg;
19451 ga_init2(&ga, 1, 80);
19453 if (eap->skip)
19454 ++emsg_skip;
19455 while (*arg != NUL && *arg != '|' && *arg != '\n')
19457 p = arg;
19458 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19461 * Report the invalid expression unless the expression evaluation
19462 * has been cancelled due to an aborting error, an interrupt, or an
19463 * exception.
19465 if (!aborting())
19466 EMSG2(_(e_invexpr2), p);
19467 ret = FAIL;
19468 break;
19471 if (!eap->skip)
19473 p = get_tv_string(&rettv);
19474 len = (int)STRLEN(p);
19475 if (ga_grow(&ga, len + 2) == FAIL)
19477 clear_tv(&rettv);
19478 ret = FAIL;
19479 break;
19481 if (ga.ga_len)
19482 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19483 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19484 ga.ga_len += len;
19487 clear_tv(&rettv);
19488 arg = skipwhite(arg);
19491 if (ret != FAIL && ga.ga_data != NULL)
19493 if (eap->cmdidx == CMD_echomsg)
19495 MSG_ATTR(ga.ga_data, echo_attr);
19496 out_flush();
19498 else if (eap->cmdidx == CMD_echoerr)
19500 /* We don't want to abort following commands, restore did_emsg. */
19501 save_did_emsg = did_emsg;
19502 EMSG((char_u *)ga.ga_data);
19503 if (!force_abort)
19504 did_emsg = save_did_emsg;
19506 else if (eap->cmdidx == CMD_execute)
19507 do_cmdline((char_u *)ga.ga_data,
19508 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19511 ga_clear(&ga);
19513 if (eap->skip)
19514 --emsg_skip;
19516 eap->nextcmd = check_nextcmd(arg);
19520 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19521 * "arg" points to the "&" or '+' when called, to "option" when returning.
19522 * Returns NULL when no option name found. Otherwise pointer to the char
19523 * after the option name.
19525 static char_u *
19526 find_option_end(arg, opt_flags)
19527 char_u **arg;
19528 int *opt_flags;
19530 char_u *p = *arg;
19532 ++p;
19533 if (*p == 'g' && p[1] == ':')
19535 *opt_flags = OPT_GLOBAL;
19536 p += 2;
19538 else if (*p == 'l' && p[1] == ':')
19540 *opt_flags = OPT_LOCAL;
19541 p += 2;
19543 else
19544 *opt_flags = 0;
19546 if (!ASCII_ISALPHA(*p))
19547 return NULL;
19548 *arg = p;
19550 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19551 p += 4; /* termcap option */
19552 else
19553 while (ASCII_ISALPHA(*p))
19554 ++p;
19555 return p;
19559 * ":function"
19561 void
19562 ex_function(eap)
19563 exarg_T *eap;
19565 char_u *theline;
19566 int j;
19567 int c;
19568 int saved_did_emsg;
19569 char_u *name = NULL;
19570 char_u *p;
19571 char_u *arg;
19572 char_u *line_arg = NULL;
19573 garray_T newargs;
19574 garray_T newlines;
19575 int varargs = FALSE;
19576 int mustend = FALSE;
19577 int flags = 0;
19578 ufunc_T *fp;
19579 int indent;
19580 int nesting;
19581 char_u *skip_until = NULL;
19582 dictitem_T *v;
19583 funcdict_T fudi;
19584 static int func_nr = 0; /* number for nameless function */
19585 int paren;
19586 hashtab_T *ht;
19587 int todo;
19588 hashitem_T *hi;
19589 int sourcing_lnum_off;
19592 * ":function" without argument: list functions.
19594 if (ends_excmd(*eap->arg))
19596 if (!eap->skip)
19598 todo = (int)func_hashtab.ht_used;
19599 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19601 if (!HASHITEM_EMPTY(hi))
19603 --todo;
19604 fp = HI2UF(hi);
19605 if (!isdigit(*fp->uf_name))
19606 list_func_head(fp, FALSE);
19610 eap->nextcmd = check_nextcmd(eap->arg);
19611 return;
19615 * ":function /pat": list functions matching pattern.
19617 if (*eap->arg == '/')
19619 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19620 if (!eap->skip)
19622 regmatch_T regmatch;
19624 c = *p;
19625 *p = NUL;
19626 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19627 *p = c;
19628 if (regmatch.regprog != NULL)
19630 regmatch.rm_ic = p_ic;
19632 todo = (int)func_hashtab.ht_used;
19633 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19635 if (!HASHITEM_EMPTY(hi))
19637 --todo;
19638 fp = HI2UF(hi);
19639 if (!isdigit(*fp->uf_name)
19640 && vim_regexec(&regmatch, fp->uf_name, 0))
19641 list_func_head(fp, FALSE);
19646 if (*p == '/')
19647 ++p;
19648 eap->nextcmd = check_nextcmd(p);
19649 return;
19653 * Get the function name. There are these situations:
19654 * func normal function name
19655 * "name" == func, "fudi.fd_dict" == NULL
19656 * dict.func new dictionary entry
19657 * "name" == NULL, "fudi.fd_dict" set,
19658 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19659 * dict.func existing dict entry with a Funcref
19660 * "name" == func, "fudi.fd_dict" set,
19661 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19662 * dict.func existing dict entry that's not a Funcref
19663 * "name" == NULL, "fudi.fd_dict" set,
19664 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19666 p = eap->arg;
19667 name = trans_function_name(&p, eap->skip, 0, &fudi);
19668 paren = (vim_strchr(p, '(') != NULL);
19669 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19672 * Return on an invalid expression in braces, unless the expression
19673 * evaluation has been cancelled due to an aborting error, an
19674 * interrupt, or an exception.
19676 if (!aborting())
19678 if (!eap->skip && fudi.fd_newkey != NULL)
19679 EMSG2(_(e_dictkey), fudi.fd_newkey);
19680 vim_free(fudi.fd_newkey);
19681 return;
19683 else
19684 eap->skip = TRUE;
19687 /* An error in a function call during evaluation of an expression in magic
19688 * braces should not cause the function not to be defined. */
19689 saved_did_emsg = did_emsg;
19690 did_emsg = FALSE;
19693 * ":function func" with only function name: list function.
19695 if (!paren)
19697 if (!ends_excmd(*skipwhite(p)))
19699 EMSG(_(e_trailing));
19700 goto ret_free;
19702 eap->nextcmd = check_nextcmd(p);
19703 if (eap->nextcmd != NULL)
19704 *p = NUL;
19705 if (!eap->skip && !got_int)
19707 fp = find_func(name);
19708 if (fp != NULL)
19710 list_func_head(fp, TRUE);
19711 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19713 if (FUNCLINE(fp, j) == NULL)
19714 continue;
19715 msg_putchar('\n');
19716 msg_outnum((long)(j + 1));
19717 if (j < 9)
19718 msg_putchar(' ');
19719 if (j < 99)
19720 msg_putchar(' ');
19721 msg_prt_line(FUNCLINE(fp, j), FALSE);
19722 out_flush(); /* show a line at a time */
19723 ui_breakcheck();
19725 if (!got_int)
19727 msg_putchar('\n');
19728 msg_puts((char_u *)" endfunction");
19731 else
19732 emsg_funcname("E123: Undefined function: %s", name);
19734 goto ret_free;
19738 * ":function name(arg1, arg2)" Define function.
19740 p = skipwhite(p);
19741 if (*p != '(')
19743 if (!eap->skip)
19745 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19746 goto ret_free;
19748 /* attempt to continue by skipping some text */
19749 if (vim_strchr(p, '(') != NULL)
19750 p = vim_strchr(p, '(');
19752 p = skipwhite(p + 1);
19754 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19755 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19757 if (!eap->skip)
19759 /* Check the name of the function. Unless it's a dictionary function
19760 * (that we are overwriting). */
19761 if (name != NULL)
19762 arg = name;
19763 else
19764 arg = fudi.fd_newkey;
19765 if (arg != NULL && (fudi.fd_di == NULL
19766 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19768 if (*arg == K_SPECIAL)
19769 j = 3;
19770 else
19771 j = 0;
19772 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19773 : eval_isnamec(arg[j])))
19774 ++j;
19775 if (arg[j] != NUL)
19776 emsg_funcname(_(e_invarg2), arg);
19781 * Isolate the arguments: "arg1, arg2, ...)"
19783 while (*p != ')')
19785 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19787 varargs = TRUE;
19788 p += 3;
19789 mustend = TRUE;
19791 else
19793 arg = p;
19794 while (ASCII_ISALNUM(*p) || *p == '_')
19795 ++p;
19796 if (arg == p || isdigit(*arg)
19797 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19798 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19800 if (!eap->skip)
19801 EMSG2(_("E125: Illegal argument: %s"), arg);
19802 break;
19804 if (ga_grow(&newargs, 1) == FAIL)
19805 goto erret;
19806 c = *p;
19807 *p = NUL;
19808 arg = vim_strsave(arg);
19809 if (arg == NULL)
19810 goto erret;
19811 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19812 *p = c;
19813 newargs.ga_len++;
19814 if (*p == ',')
19815 ++p;
19816 else
19817 mustend = TRUE;
19819 p = skipwhite(p);
19820 if (mustend && *p != ')')
19822 if (!eap->skip)
19823 EMSG2(_(e_invarg2), eap->arg);
19824 break;
19827 ++p; /* skip the ')' */
19829 /* find extra arguments "range", "dict" and "abort" */
19830 for (;;)
19832 p = skipwhite(p);
19833 if (STRNCMP(p, "range", 5) == 0)
19835 flags |= FC_RANGE;
19836 p += 5;
19838 else if (STRNCMP(p, "dict", 4) == 0)
19840 flags |= FC_DICT;
19841 p += 4;
19843 else if (STRNCMP(p, "abort", 5) == 0)
19845 flags |= FC_ABORT;
19846 p += 5;
19848 else
19849 break;
19852 /* When there is a line break use what follows for the function body.
19853 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19854 if (*p == '\n')
19855 line_arg = p + 1;
19856 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19857 EMSG(_(e_trailing));
19860 * Read the body of the function, until ":endfunction" is found.
19862 if (KeyTyped)
19864 /* Check if the function already exists, don't let the user type the
19865 * whole function before telling him it doesn't work! For a script we
19866 * need to skip the body to be able to find what follows. */
19867 if (!eap->skip && !eap->forceit)
19869 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19870 EMSG(_(e_funcdict));
19871 else if (name != NULL && find_func(name) != NULL)
19872 emsg_funcname(e_funcexts, name);
19875 if (!eap->skip && did_emsg)
19876 goto erret;
19878 msg_putchar('\n'); /* don't overwrite the function name */
19879 cmdline_row = msg_row;
19882 indent = 2;
19883 nesting = 0;
19884 for (;;)
19886 msg_scroll = TRUE;
19887 need_wait_return = FALSE;
19888 sourcing_lnum_off = sourcing_lnum;
19890 if (line_arg != NULL)
19892 /* Use eap->arg, split up in parts by line breaks. */
19893 theline = line_arg;
19894 p = vim_strchr(theline, '\n');
19895 if (p == NULL)
19896 line_arg += STRLEN(line_arg);
19897 else
19899 *p = NUL;
19900 line_arg = p + 1;
19903 else if (eap->getline == NULL)
19904 theline = getcmdline(':', 0L, indent);
19905 else
19906 theline = eap->getline(':', eap->cookie, indent);
19907 if (KeyTyped)
19908 lines_left = Rows - 1;
19909 if (theline == NULL)
19911 EMSG(_("E126: Missing :endfunction"));
19912 goto erret;
19915 /* Detect line continuation: sourcing_lnum increased more than one. */
19916 if (sourcing_lnum > sourcing_lnum_off + 1)
19917 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
19918 else
19919 sourcing_lnum_off = 0;
19921 if (skip_until != NULL)
19923 /* between ":append" and "." and between ":python <<EOF" and "EOF"
19924 * don't check for ":endfunc". */
19925 if (STRCMP(theline, skip_until) == 0)
19927 vim_free(skip_until);
19928 skip_until = NULL;
19931 else
19933 /* skip ':' and blanks*/
19934 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
19937 /* Check for "endfunction". */
19938 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
19940 if (line_arg == NULL)
19941 vim_free(theline);
19942 break;
19945 /* Increase indent inside "if", "while", "for" and "try", decrease
19946 * at "end". */
19947 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
19948 indent -= 2;
19949 else if (STRNCMP(p, "if", 2) == 0
19950 || STRNCMP(p, "wh", 2) == 0
19951 || STRNCMP(p, "for", 3) == 0
19952 || STRNCMP(p, "try", 3) == 0)
19953 indent += 2;
19955 /* Check for defining a function inside this function. */
19956 if (checkforcmd(&p, "function", 2))
19958 if (*p == '!')
19959 p = skipwhite(p + 1);
19960 p += eval_fname_script(p);
19961 if (ASCII_ISALPHA(*p))
19963 vim_free(trans_function_name(&p, TRUE, 0, NULL));
19964 if (*skipwhite(p) == '(')
19966 ++nesting;
19967 indent += 2;
19972 /* Check for ":append" or ":insert". */
19973 p = skip_range(p, NULL);
19974 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
19975 || (p[0] == 'i'
19976 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
19977 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
19978 skip_until = vim_strsave((char_u *)".");
19980 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
19981 arg = skipwhite(skiptowhite(p));
19982 if (arg[0] == '<' && arg[1] =='<'
19983 && ((p[0] == 'p' && p[1] == 'y'
19984 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
19985 || (p[0] == 'p' && p[1] == 'e'
19986 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
19987 || (p[0] == 't' && p[1] == 'c'
19988 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
19989 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
19990 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
19991 || (p[0] == 'm' && p[1] == 'z'
19992 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
19995 /* ":python <<" continues until a dot, like ":append" */
19996 p = skipwhite(arg + 2);
19997 if (*p == NUL)
19998 skip_until = vim_strsave((char_u *)".");
19999 else
20000 skip_until = vim_strsave(p);
20004 /* Add the line to the function. */
20005 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20007 if (line_arg == NULL)
20008 vim_free(theline);
20009 goto erret;
20012 /* Copy the line to newly allocated memory. get_one_sourceline()
20013 * allocates 250 bytes per line, this saves 80% on average. The cost
20014 * is an extra alloc/free. */
20015 p = vim_strsave(theline);
20016 if (p != NULL)
20018 if (line_arg == NULL)
20019 vim_free(theline);
20020 theline = p;
20023 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20025 /* Add NULL lines for continuation lines, so that the line count is
20026 * equal to the index in the growarray. */
20027 while (sourcing_lnum_off-- > 0)
20028 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20030 /* Check for end of eap->arg. */
20031 if (line_arg != NULL && *line_arg == NUL)
20032 line_arg = NULL;
20035 /* Don't define the function when skipping commands or when an error was
20036 * detected. */
20037 if (eap->skip || did_emsg)
20038 goto erret;
20041 * If there are no errors, add the function
20043 if (fudi.fd_dict == NULL)
20045 v = find_var(name, &ht);
20046 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20048 emsg_funcname("E707: Function name conflicts with variable: %s",
20049 name);
20050 goto erret;
20053 fp = find_func(name);
20054 if (fp != NULL)
20056 if (!eap->forceit)
20058 emsg_funcname(e_funcexts, name);
20059 goto erret;
20061 if (fp->uf_calls > 0)
20063 emsg_funcname("E127: Cannot redefine function %s: It is in use",
20064 name);
20065 goto erret;
20067 /* redefine existing function */
20068 ga_clear_strings(&(fp->uf_args));
20069 ga_clear_strings(&(fp->uf_lines));
20070 vim_free(name);
20071 name = NULL;
20074 else
20076 char numbuf[20];
20078 fp = NULL;
20079 if (fudi.fd_newkey == NULL && !eap->forceit)
20081 EMSG(_(e_funcdict));
20082 goto erret;
20084 if (fudi.fd_di == NULL)
20086 /* Can't add a function to a locked dictionary */
20087 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20088 goto erret;
20090 /* Can't change an existing function if it is locked */
20091 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20092 goto erret;
20094 /* Give the function a sequential number. Can only be used with a
20095 * Funcref! */
20096 vim_free(name);
20097 sprintf(numbuf, "%d", ++func_nr);
20098 name = vim_strsave((char_u *)numbuf);
20099 if (name == NULL)
20100 goto erret;
20103 if (fp == NULL)
20105 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20107 int slen, plen;
20108 char_u *scriptname;
20110 /* Check that the autoload name matches the script name. */
20111 j = FAIL;
20112 if (sourcing_name != NULL)
20114 scriptname = autoload_name(name);
20115 if (scriptname != NULL)
20117 p = vim_strchr(scriptname, '/');
20118 plen = (int)STRLEN(p);
20119 slen = (int)STRLEN(sourcing_name);
20120 if (slen > plen && fnamecmp(p,
20121 sourcing_name + slen - plen) == 0)
20122 j = OK;
20123 vim_free(scriptname);
20126 if (j == FAIL)
20128 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20129 goto erret;
20133 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20134 if (fp == NULL)
20135 goto erret;
20137 if (fudi.fd_dict != NULL)
20139 if (fudi.fd_di == NULL)
20141 /* add new dict entry */
20142 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20143 if (fudi.fd_di == NULL)
20145 vim_free(fp);
20146 goto erret;
20148 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20150 vim_free(fudi.fd_di);
20151 vim_free(fp);
20152 goto erret;
20155 else
20156 /* overwrite existing dict entry */
20157 clear_tv(&fudi.fd_di->di_tv);
20158 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20159 fudi.fd_di->di_tv.v_lock = 0;
20160 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20161 fp->uf_refcount = 1;
20163 /* behave like "dict" was used */
20164 flags |= FC_DICT;
20167 /* insert the new function in the function list */
20168 STRCPY(fp->uf_name, name);
20169 hash_add(&func_hashtab, UF2HIKEY(fp));
20171 fp->uf_args = newargs;
20172 fp->uf_lines = newlines;
20173 #ifdef FEAT_PROFILE
20174 fp->uf_tml_count = NULL;
20175 fp->uf_tml_total = NULL;
20176 fp->uf_tml_self = NULL;
20177 fp->uf_profiling = FALSE;
20178 if (prof_def_func())
20179 func_do_profile(fp);
20180 #endif
20181 fp->uf_varargs = varargs;
20182 fp->uf_flags = flags;
20183 fp->uf_calls = 0;
20184 fp->uf_script_ID = current_SID;
20185 goto ret_free;
20187 erret:
20188 ga_clear_strings(&newargs);
20189 ga_clear_strings(&newlines);
20190 ret_free:
20191 vim_free(skip_until);
20192 vim_free(fudi.fd_newkey);
20193 vim_free(name);
20194 did_emsg |= saved_did_emsg;
20198 * Get a function name, translating "<SID>" and "<SNR>".
20199 * Also handles a Funcref in a List or Dictionary.
20200 * Returns the function name in allocated memory, or NULL for failure.
20201 * flags:
20202 * TFN_INT: internal function name OK
20203 * TFN_QUIET: be quiet
20204 * Advances "pp" to just after the function name (if no error).
20206 static char_u *
20207 trans_function_name(pp, skip, flags, fdp)
20208 char_u **pp;
20209 int skip; /* only find the end, don't evaluate */
20210 int flags;
20211 funcdict_T *fdp; /* return: info about dictionary used */
20213 char_u *name = NULL;
20214 char_u *start;
20215 char_u *end;
20216 int lead;
20217 char_u sid_buf[20];
20218 int len;
20219 lval_T lv;
20221 if (fdp != NULL)
20222 vim_memset(fdp, 0, sizeof(funcdict_T));
20223 start = *pp;
20225 /* Check for hard coded <SNR>: already translated function ID (from a user
20226 * command). */
20227 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20228 && (*pp)[2] == (int)KE_SNR)
20230 *pp += 3;
20231 len = get_id_len(pp) + 3;
20232 return vim_strnsave(start, len);
20235 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20236 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20237 lead = eval_fname_script(start);
20238 if (lead > 2)
20239 start += lead;
20241 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20242 lead > 2 ? 0 : FNE_CHECK_START);
20243 if (end == start)
20245 if (!skip)
20246 EMSG(_("E129: Function name required"));
20247 goto theend;
20249 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20252 * Report an invalid expression in braces, unless the expression
20253 * evaluation has been cancelled due to an aborting error, an
20254 * interrupt, or an exception.
20256 if (!aborting())
20258 if (end != NULL)
20259 EMSG2(_(e_invarg2), start);
20261 else
20262 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20263 goto theend;
20266 if (lv.ll_tv != NULL)
20268 if (fdp != NULL)
20270 fdp->fd_dict = lv.ll_dict;
20271 fdp->fd_newkey = lv.ll_newkey;
20272 lv.ll_newkey = NULL;
20273 fdp->fd_di = lv.ll_di;
20275 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20277 name = vim_strsave(lv.ll_tv->vval.v_string);
20278 *pp = end;
20280 else
20282 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20283 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20284 EMSG(_(e_funcref));
20285 else
20286 *pp = end;
20287 name = NULL;
20289 goto theend;
20292 if (lv.ll_name == NULL)
20294 /* Error found, but continue after the function name. */
20295 *pp = end;
20296 goto theend;
20299 /* Check if the name is a Funcref. If so, use the value. */
20300 if (lv.ll_exp_name != NULL)
20302 len = (int)STRLEN(lv.ll_exp_name);
20303 name = deref_func_name(lv.ll_exp_name, &len);
20304 if (name == lv.ll_exp_name)
20305 name = NULL;
20307 else
20309 len = (int)(end - *pp);
20310 name = deref_func_name(*pp, &len);
20311 if (name == *pp)
20312 name = NULL;
20314 if (name != NULL)
20316 name = vim_strsave(name);
20317 *pp = end;
20318 goto theend;
20321 if (lv.ll_exp_name != NULL)
20323 len = (int)STRLEN(lv.ll_exp_name);
20324 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20325 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20327 /* When there was "s:" already or the name expanded to get a
20328 * leading "s:" then remove it. */
20329 lv.ll_name += 2;
20330 len -= 2;
20331 lead = 2;
20334 else
20336 if (lead == 2) /* skip over "s:" */
20337 lv.ll_name += 2;
20338 len = (int)(end - lv.ll_name);
20342 * Copy the function name to allocated memory.
20343 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20344 * Accept <SNR>123_name() outside a script.
20346 if (skip)
20347 lead = 0; /* do nothing */
20348 else if (lead > 0)
20350 lead = 3;
20351 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20352 || eval_fname_sid(*pp))
20354 /* It's "s:" or "<SID>" */
20355 if (current_SID <= 0)
20357 EMSG(_(e_usingsid));
20358 goto theend;
20360 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20361 lead += (int)STRLEN(sid_buf);
20364 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20366 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20367 goto theend;
20369 name = alloc((unsigned)(len + lead + 1));
20370 if (name != NULL)
20372 if (lead > 0)
20374 name[0] = K_SPECIAL;
20375 name[1] = KS_EXTRA;
20376 name[2] = (int)KE_SNR;
20377 if (lead > 3) /* If it's "<SID>" */
20378 STRCPY(name + 3, sid_buf);
20380 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20381 name[len + lead] = NUL;
20383 *pp = end;
20385 theend:
20386 clear_lval(&lv);
20387 return name;
20391 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20392 * Return 2 if "p" starts with "s:".
20393 * Return 0 otherwise.
20395 static int
20396 eval_fname_script(p)
20397 char_u *p;
20399 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20400 || STRNICMP(p + 1, "SNR>", 4) == 0))
20401 return 5;
20402 if (p[0] == 's' && p[1] == ':')
20403 return 2;
20404 return 0;
20408 * Return TRUE if "p" starts with "<SID>" or "s:".
20409 * Only works if eval_fname_script() returned non-zero for "p"!
20411 static int
20412 eval_fname_sid(p)
20413 char_u *p;
20415 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20419 * List the head of the function: "name(arg1, arg2)".
20421 static void
20422 list_func_head(fp, indent)
20423 ufunc_T *fp;
20424 int indent;
20426 int j;
20428 msg_start();
20429 if (indent)
20430 MSG_PUTS(" ");
20431 MSG_PUTS("function ");
20432 if (fp->uf_name[0] == K_SPECIAL)
20434 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20435 msg_puts(fp->uf_name + 3);
20437 else
20438 msg_puts(fp->uf_name);
20439 msg_putchar('(');
20440 for (j = 0; j < fp->uf_args.ga_len; ++j)
20442 if (j)
20443 MSG_PUTS(", ");
20444 msg_puts(FUNCARG(fp, j));
20446 if (fp->uf_varargs)
20448 if (j)
20449 MSG_PUTS(", ");
20450 MSG_PUTS("...");
20452 msg_putchar(')');
20453 msg_clr_eos();
20454 if (p_verbose > 0)
20455 last_set_msg(fp->uf_script_ID);
20459 * Find a function by name, return pointer to it in ufuncs.
20460 * Return NULL for unknown function.
20462 static ufunc_T *
20463 find_func(name)
20464 char_u *name;
20466 hashitem_T *hi;
20468 hi = hash_find(&func_hashtab, name);
20469 if (!HASHITEM_EMPTY(hi))
20470 return HI2UF(hi);
20471 return NULL;
20474 #if defined(EXITFREE) || defined(PROTO)
20475 void
20476 free_all_functions()
20478 hashitem_T *hi;
20480 /* Need to start all over every time, because func_free() may change the
20481 * hash table. */
20482 while (func_hashtab.ht_used > 0)
20483 for (hi = func_hashtab.ht_array; ; ++hi)
20484 if (!HASHITEM_EMPTY(hi))
20486 func_free(HI2UF(hi));
20487 break;
20490 #endif
20493 * Return TRUE if a function "name" exists.
20495 static int
20496 function_exists(name)
20497 char_u *name;
20499 char_u *nm = name;
20500 char_u *p;
20501 int n = FALSE;
20503 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20504 nm = skipwhite(nm);
20506 /* Only accept "funcname", "funcname ", "funcname (..." and
20507 * "funcname(...", not "funcname!...". */
20508 if (p != NULL && (*nm == NUL || *nm == '('))
20510 if (builtin_function(p))
20511 n = (find_internal_func(p) >= 0);
20512 else
20513 n = (find_func(p) != NULL);
20515 vim_free(p);
20516 return n;
20520 * Return TRUE if "name" looks like a builtin function name: starts with a
20521 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20523 static int
20524 builtin_function(name)
20525 char_u *name;
20527 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20528 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20531 #if defined(FEAT_PROFILE) || defined(PROTO)
20533 * Start profiling function "fp".
20535 static void
20536 func_do_profile(fp)
20537 ufunc_T *fp;
20539 fp->uf_tm_count = 0;
20540 profile_zero(&fp->uf_tm_self);
20541 profile_zero(&fp->uf_tm_total);
20542 if (fp->uf_tml_count == NULL)
20543 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20544 (sizeof(int) * fp->uf_lines.ga_len));
20545 if (fp->uf_tml_total == NULL)
20546 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20547 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20548 if (fp->uf_tml_self == NULL)
20549 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20550 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20551 fp->uf_tml_idx = -1;
20552 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20553 || fp->uf_tml_self == NULL)
20554 return; /* out of memory */
20556 fp->uf_profiling = TRUE;
20560 * Dump the profiling results for all functions in file "fd".
20562 void
20563 func_dump_profile(fd)
20564 FILE *fd;
20566 hashitem_T *hi;
20567 int todo;
20568 ufunc_T *fp;
20569 int i;
20570 ufunc_T **sorttab;
20571 int st_len = 0;
20573 todo = (int)func_hashtab.ht_used;
20574 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20576 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20578 if (!HASHITEM_EMPTY(hi))
20580 --todo;
20581 fp = HI2UF(hi);
20582 if (fp->uf_profiling)
20584 if (sorttab != NULL)
20585 sorttab[st_len++] = fp;
20587 if (fp->uf_name[0] == K_SPECIAL)
20588 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20589 else
20590 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20591 if (fp->uf_tm_count == 1)
20592 fprintf(fd, "Called 1 time\n");
20593 else
20594 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20595 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20596 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20597 fprintf(fd, "\n");
20598 fprintf(fd, "count total (s) self (s)\n");
20600 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20602 if (FUNCLINE(fp, i) == NULL)
20603 continue;
20604 prof_func_line(fd, fp->uf_tml_count[i],
20605 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20606 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20608 fprintf(fd, "\n");
20613 if (sorttab != NULL && st_len > 0)
20615 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20616 prof_total_cmp);
20617 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20618 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20619 prof_self_cmp);
20620 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20624 static void
20625 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20626 FILE *fd;
20627 ufunc_T **sorttab;
20628 int st_len;
20629 char *title;
20630 int prefer_self; /* when equal print only self time */
20632 int i;
20633 ufunc_T *fp;
20635 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20636 fprintf(fd, "count total (s) self (s) function\n");
20637 for (i = 0; i < 20 && i < st_len; ++i)
20639 fp = sorttab[i];
20640 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20641 prefer_self);
20642 if (fp->uf_name[0] == K_SPECIAL)
20643 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20644 else
20645 fprintf(fd, " %s()\n", fp->uf_name);
20647 fprintf(fd, "\n");
20651 * Print the count and times for one function or function line.
20653 static void
20654 prof_func_line(fd, count, total, self, prefer_self)
20655 FILE *fd;
20656 int count;
20657 proftime_T *total;
20658 proftime_T *self;
20659 int prefer_self; /* when equal print only self time */
20661 if (count > 0)
20663 fprintf(fd, "%5d ", count);
20664 if (prefer_self && profile_equal(total, self))
20665 fprintf(fd, " ");
20666 else
20667 fprintf(fd, "%s ", profile_msg(total));
20668 if (!prefer_self && profile_equal(total, self))
20669 fprintf(fd, " ");
20670 else
20671 fprintf(fd, "%s ", profile_msg(self));
20673 else
20674 fprintf(fd, " ");
20678 * Compare function for total time sorting.
20680 static int
20681 #ifdef __BORLANDC__
20682 _RTLENTRYF
20683 #endif
20684 prof_total_cmp(s1, s2)
20685 const void *s1;
20686 const void *s2;
20688 ufunc_T *p1, *p2;
20690 p1 = *(ufunc_T **)s1;
20691 p2 = *(ufunc_T **)s2;
20692 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20696 * Compare function for self time sorting.
20698 static int
20699 #ifdef __BORLANDC__
20700 _RTLENTRYF
20701 #endif
20702 prof_self_cmp(s1, s2)
20703 const void *s1;
20704 const void *s2;
20706 ufunc_T *p1, *p2;
20708 p1 = *(ufunc_T **)s1;
20709 p2 = *(ufunc_T **)s2;
20710 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20713 #endif
20716 * If "name" has a package name try autoloading the script for it.
20717 * Return TRUE if a package was loaded.
20719 static int
20720 script_autoload(name, reload)
20721 char_u *name;
20722 int reload; /* load script again when already loaded */
20724 char_u *p;
20725 char_u *scriptname, *tofree;
20726 int ret = FALSE;
20727 int i;
20729 /* If there is no '#' after name[0] there is no package name. */
20730 p = vim_strchr(name, AUTOLOAD_CHAR);
20731 if (p == NULL || p == name)
20732 return FALSE;
20734 tofree = scriptname = autoload_name(name);
20736 /* Find the name in the list of previously loaded package names. Skip
20737 * "autoload/", it's always the same. */
20738 for (i = 0; i < ga_loaded.ga_len; ++i)
20739 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20740 break;
20741 if (!reload && i < ga_loaded.ga_len)
20742 ret = FALSE; /* was loaded already */
20743 else
20745 /* Remember the name if it wasn't loaded already. */
20746 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20748 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20749 tofree = NULL;
20752 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20753 if (source_runtime(scriptname, FALSE) == OK)
20754 ret = TRUE;
20757 vim_free(tofree);
20758 return ret;
20762 * Return the autoload script name for a function or variable name.
20763 * Returns NULL when out of memory.
20765 static char_u *
20766 autoload_name(name)
20767 char_u *name;
20769 char_u *p;
20770 char_u *scriptname;
20772 /* Get the script file name: replace '#' with '/', append ".vim". */
20773 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20774 if (scriptname == NULL)
20775 return FALSE;
20776 STRCPY(scriptname, "autoload/");
20777 STRCAT(scriptname, name);
20778 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20779 STRCAT(scriptname, ".vim");
20780 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20781 *p = '/';
20782 return scriptname;
20785 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20788 * Function given to ExpandGeneric() to obtain the list of user defined
20789 * function names.
20791 char_u *
20792 get_user_func_name(xp, idx)
20793 expand_T *xp;
20794 int idx;
20796 static long_u done;
20797 static hashitem_T *hi;
20798 ufunc_T *fp;
20800 if (idx == 0)
20802 done = 0;
20803 hi = func_hashtab.ht_array;
20805 if (done < func_hashtab.ht_used)
20807 if (done++ > 0)
20808 ++hi;
20809 while (HASHITEM_EMPTY(hi))
20810 ++hi;
20811 fp = HI2UF(hi);
20813 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20814 return fp->uf_name; /* prevents overflow */
20816 cat_func_name(IObuff, fp);
20817 if (xp->xp_context != EXPAND_USER_FUNC)
20819 STRCAT(IObuff, "(");
20820 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20821 STRCAT(IObuff, ")");
20823 return IObuff;
20825 return NULL;
20828 #endif /* FEAT_CMDL_COMPL */
20831 * Copy the function name of "fp" to buffer "buf".
20832 * "buf" must be able to hold the function name plus three bytes.
20833 * Takes care of script-local function names.
20835 static void
20836 cat_func_name(buf, fp)
20837 char_u *buf;
20838 ufunc_T *fp;
20840 if (fp->uf_name[0] == K_SPECIAL)
20842 STRCPY(buf, "<SNR>");
20843 STRCAT(buf, fp->uf_name + 3);
20845 else
20846 STRCPY(buf, fp->uf_name);
20850 * ":delfunction {name}"
20852 void
20853 ex_delfunction(eap)
20854 exarg_T *eap;
20856 ufunc_T *fp = NULL;
20857 char_u *p;
20858 char_u *name;
20859 funcdict_T fudi;
20861 p = eap->arg;
20862 name = trans_function_name(&p, eap->skip, 0, &fudi);
20863 vim_free(fudi.fd_newkey);
20864 if (name == NULL)
20866 if (fudi.fd_dict != NULL && !eap->skip)
20867 EMSG(_(e_funcref));
20868 return;
20870 if (!ends_excmd(*skipwhite(p)))
20872 vim_free(name);
20873 EMSG(_(e_trailing));
20874 return;
20876 eap->nextcmd = check_nextcmd(p);
20877 if (eap->nextcmd != NULL)
20878 *p = NUL;
20880 if (!eap->skip)
20881 fp = find_func(name);
20882 vim_free(name);
20884 if (!eap->skip)
20886 if (fp == NULL)
20888 EMSG2(_(e_nofunc), eap->arg);
20889 return;
20891 if (fp->uf_calls > 0)
20893 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
20894 return;
20897 if (fudi.fd_dict != NULL)
20899 /* Delete the dict item that refers to the function, it will
20900 * invoke func_unref() and possibly delete the function. */
20901 dictitem_remove(fudi.fd_dict, fudi.fd_di);
20903 else
20904 func_free(fp);
20909 * Free a function and remove it from the list of functions.
20911 static void
20912 func_free(fp)
20913 ufunc_T *fp;
20915 hashitem_T *hi;
20917 /* clear this function */
20918 ga_clear_strings(&(fp->uf_args));
20919 ga_clear_strings(&(fp->uf_lines));
20920 #ifdef FEAT_PROFILE
20921 vim_free(fp->uf_tml_count);
20922 vim_free(fp->uf_tml_total);
20923 vim_free(fp->uf_tml_self);
20924 #endif
20926 /* remove the function from the function hashtable */
20927 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
20928 if (HASHITEM_EMPTY(hi))
20929 EMSG2(_(e_intern2), "func_free()");
20930 else
20931 hash_remove(&func_hashtab, hi);
20933 vim_free(fp);
20937 * Unreference a Function: decrement the reference count and free it when it
20938 * becomes zero. Only for numbered functions.
20940 static void
20941 func_unref(name)
20942 char_u *name;
20944 ufunc_T *fp;
20946 if (name != NULL && isdigit(*name))
20948 fp = find_func(name);
20949 if (fp == NULL)
20950 EMSG2(_(e_intern2), "func_unref()");
20951 else if (--fp->uf_refcount <= 0)
20953 /* Only delete it when it's not being used. Otherwise it's done
20954 * when "uf_calls" becomes zero. */
20955 if (fp->uf_calls == 0)
20956 func_free(fp);
20962 * Count a reference to a Function.
20964 static void
20965 func_ref(name)
20966 char_u *name;
20968 ufunc_T *fp;
20970 if (name != NULL && isdigit(*name))
20972 fp = find_func(name);
20973 if (fp == NULL)
20974 EMSG2(_(e_intern2), "func_ref()");
20975 else
20976 ++fp->uf_refcount;
20981 * Call a user function.
20983 static void
20984 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
20985 ufunc_T *fp; /* pointer to function */
20986 int argcount; /* nr of args */
20987 typval_T *argvars; /* arguments */
20988 typval_T *rettv; /* return value */
20989 linenr_T firstline; /* first line of range */
20990 linenr_T lastline; /* last line of range */
20991 dict_T *selfdict; /* Dictionary for "self" */
20993 char_u *save_sourcing_name;
20994 linenr_T save_sourcing_lnum;
20995 scid_T save_current_SID;
20996 funccall_T fc;
20997 int save_did_emsg;
20998 static int depth = 0;
20999 dictitem_T *v;
21000 int fixvar_idx = 0; /* index in fixvar[] */
21001 int i;
21002 int ai;
21003 char_u numbuf[NUMBUFLEN];
21004 char_u *name;
21005 #ifdef FEAT_PROFILE
21006 proftime_T wait_start;
21007 proftime_T call_start;
21008 #endif
21010 /* If depth of calling is getting too high, don't execute the function */
21011 if (depth >= p_mfd)
21013 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21014 rettv->v_type = VAR_NUMBER;
21015 rettv->vval.v_number = -1;
21016 return;
21018 ++depth;
21020 line_breakcheck(); /* check for CTRL-C hit */
21022 fc.caller = current_funccal;
21023 current_funccal = &fc;
21024 fc.func = fp;
21025 fc.rettv = rettv;
21026 rettv->vval.v_number = 0;
21027 fc.linenr = 0;
21028 fc.returned = FALSE;
21029 fc.level = ex_nesting_level;
21030 /* Check if this function has a breakpoint. */
21031 fc.breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21032 fc.dbg_tick = debug_tick;
21035 * Note about using fc.fixvar[]: This is an array of FIXVAR_CNT variables
21036 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21037 * each argument variable and saves a lot of time.
21040 * Init l: variables.
21042 init_var_dict(&fc.l_vars, &fc.l_vars_var);
21043 if (selfdict != NULL)
21045 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21046 * some compiler that checks the destination size. */
21047 v = &fc.fixvar[fixvar_idx++].var;
21048 name = v->di_key;
21049 STRCPY(name, "self");
21050 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21051 hash_add(&fc.l_vars.dv_hashtab, DI2HIKEY(v));
21052 v->di_tv.v_type = VAR_DICT;
21053 v->di_tv.v_lock = 0;
21054 v->di_tv.vval.v_dict = selfdict;
21055 ++selfdict->dv_refcount;
21059 * Init a: variables.
21060 * Set a:0 to "argcount".
21061 * Set a:000 to a list with room for the "..." arguments.
21063 init_var_dict(&fc.l_avars, &fc.l_avars_var);
21064 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "0",
21065 (varnumber_T)(argcount - fp->uf_args.ga_len));
21066 v = &fc.fixvar[fixvar_idx++].var;
21067 STRCPY(v->di_key, "000");
21068 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21069 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21070 v->di_tv.v_type = VAR_LIST;
21071 v->di_tv.v_lock = VAR_FIXED;
21072 v->di_tv.vval.v_list = &fc.l_varlist;
21073 vim_memset(&fc.l_varlist, 0, sizeof(list_T));
21074 fc.l_varlist.lv_refcount = 99999;
21075 fc.l_varlist.lv_lock = VAR_FIXED;
21078 * Set a:firstline to "firstline" and a:lastline to "lastline".
21079 * Set a:name to named arguments.
21080 * Set a:N to the "..." arguments.
21082 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "firstline",
21083 (varnumber_T)firstline);
21084 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "lastline",
21085 (varnumber_T)lastline);
21086 for (i = 0; i < argcount; ++i)
21088 ai = i - fp->uf_args.ga_len;
21089 if (ai < 0)
21090 /* named argument a:name */
21091 name = FUNCARG(fp, i);
21092 else
21094 /* "..." argument a:1, a:2, etc. */
21095 sprintf((char *)numbuf, "%d", ai + 1);
21096 name = numbuf;
21098 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21100 v = &fc.fixvar[fixvar_idx++].var;
21101 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21103 else
21105 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21106 + STRLEN(name)));
21107 if (v == NULL)
21108 break;
21109 v->di_flags = DI_FLAGS_RO;
21111 STRCPY(v->di_key, name);
21112 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21114 /* Note: the values are copied directly to avoid alloc/free.
21115 * "argvars" must have VAR_FIXED for v_lock. */
21116 v->di_tv = argvars[i];
21117 v->di_tv.v_lock = VAR_FIXED;
21119 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21121 list_append(&fc.l_varlist, &fc.l_listitems[ai]);
21122 fc.l_listitems[ai].li_tv = argvars[i];
21123 fc.l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21127 /* Don't redraw while executing the function. */
21128 ++RedrawingDisabled;
21129 save_sourcing_name = sourcing_name;
21130 save_sourcing_lnum = sourcing_lnum;
21131 sourcing_lnum = 1;
21132 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21133 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21134 if (sourcing_name != NULL)
21136 if (save_sourcing_name != NULL
21137 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21138 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21139 else
21140 STRCPY(sourcing_name, "function ");
21141 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21143 if (p_verbose >= 12)
21145 ++no_wait_return;
21146 verbose_enter_scroll();
21148 smsg((char_u *)_("calling %s"), sourcing_name);
21149 if (p_verbose >= 14)
21151 char_u buf[MSG_BUF_LEN];
21152 char_u numbuf2[NUMBUFLEN];
21153 char_u *tofree;
21154 char_u *s;
21156 msg_puts((char_u *)"(");
21157 for (i = 0; i < argcount; ++i)
21159 if (i > 0)
21160 msg_puts((char_u *)", ");
21161 if (argvars[i].v_type == VAR_NUMBER)
21162 msg_outnum((long)argvars[i].vval.v_number);
21163 else
21165 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21166 if (s != NULL)
21168 trunc_string(s, buf, MSG_BUF_CLEN);
21169 msg_puts(buf);
21170 vim_free(tofree);
21174 msg_puts((char_u *)")");
21176 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21178 verbose_leave_scroll();
21179 --no_wait_return;
21182 #ifdef FEAT_PROFILE
21183 if (do_profiling == PROF_YES)
21185 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21186 func_do_profile(fp);
21187 if (fp->uf_profiling
21188 || (fc.caller != NULL && &fc.caller->func->uf_profiling))
21190 ++fp->uf_tm_count;
21191 profile_start(&call_start);
21192 profile_zero(&fp->uf_tm_children);
21194 script_prof_save(&wait_start);
21196 #endif
21198 save_current_SID = current_SID;
21199 current_SID = fp->uf_script_ID;
21200 save_did_emsg = did_emsg;
21201 did_emsg = FALSE;
21203 /* call do_cmdline() to execute the lines */
21204 do_cmdline(NULL, get_func_line, (void *)&fc,
21205 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21207 --RedrawingDisabled;
21209 /* when the function was aborted because of an error, return -1 */
21210 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21212 clear_tv(rettv);
21213 rettv->v_type = VAR_NUMBER;
21214 rettv->vval.v_number = -1;
21217 #ifdef FEAT_PROFILE
21218 if (do_profiling == PROF_YES && (fp->uf_profiling
21219 || (fc.caller != NULL && &fc.caller->func->uf_profiling)))
21221 profile_end(&call_start);
21222 profile_sub_wait(&wait_start, &call_start);
21223 profile_add(&fp->uf_tm_total, &call_start);
21224 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21225 if (fc.caller != NULL && &fc.caller->func->uf_profiling)
21227 profile_add(&fc.caller->func->uf_tm_children, &call_start);
21228 profile_add(&fc.caller->func->uf_tml_children, &call_start);
21231 #endif
21233 /* when being verbose, mention the return value */
21234 if (p_verbose >= 12)
21236 ++no_wait_return;
21237 verbose_enter_scroll();
21239 if (aborting())
21240 smsg((char_u *)_("%s aborted"), sourcing_name);
21241 else if (fc.rettv->v_type == VAR_NUMBER)
21242 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21243 (long)fc.rettv->vval.v_number);
21244 else
21246 char_u buf[MSG_BUF_LEN];
21247 char_u numbuf2[NUMBUFLEN];
21248 char_u *tofree;
21249 char_u *s;
21251 /* The value may be very long. Skip the middle part, so that we
21252 * have some idea how it starts and ends. smsg() would always
21253 * truncate it at the end. */
21254 s = tv2string(fc.rettv, &tofree, numbuf2, 0);
21255 if (s != NULL)
21257 trunc_string(s, buf, MSG_BUF_CLEN);
21258 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21259 vim_free(tofree);
21262 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21264 verbose_leave_scroll();
21265 --no_wait_return;
21268 vim_free(sourcing_name);
21269 sourcing_name = save_sourcing_name;
21270 sourcing_lnum = save_sourcing_lnum;
21271 current_SID = save_current_SID;
21272 #ifdef FEAT_PROFILE
21273 if (do_profiling == PROF_YES)
21274 script_prof_restore(&wait_start);
21275 #endif
21277 if (p_verbose >= 12 && sourcing_name != NULL)
21279 ++no_wait_return;
21280 verbose_enter_scroll();
21282 smsg((char_u *)_("continuing in %s"), sourcing_name);
21283 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21285 verbose_leave_scroll();
21286 --no_wait_return;
21289 did_emsg |= save_did_emsg;
21290 current_funccal = fc.caller;
21292 /* The a: variables typevals were not allocated, only free the allocated
21293 * variables. */
21294 vars_clear_ext(&fc.l_avars.dv_hashtab, FALSE);
21296 vars_clear(&fc.l_vars.dv_hashtab); /* free all l: variables */
21297 --depth;
21301 * Add a number variable "name" to dict "dp" with value "nr".
21303 static void
21304 add_nr_var(dp, v, name, nr)
21305 dict_T *dp;
21306 dictitem_T *v;
21307 char *name;
21308 varnumber_T nr;
21310 STRCPY(v->di_key, name);
21311 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21312 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21313 v->di_tv.v_type = VAR_NUMBER;
21314 v->di_tv.v_lock = VAR_FIXED;
21315 v->di_tv.vval.v_number = nr;
21319 * ":return [expr]"
21321 void
21322 ex_return(eap)
21323 exarg_T *eap;
21325 char_u *arg = eap->arg;
21326 typval_T rettv;
21327 int returning = FALSE;
21329 if (current_funccal == NULL)
21331 EMSG(_("E133: :return not inside a function"));
21332 return;
21335 if (eap->skip)
21336 ++emsg_skip;
21338 eap->nextcmd = NULL;
21339 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21340 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21342 if (!eap->skip)
21343 returning = do_return(eap, FALSE, TRUE, &rettv);
21344 else
21345 clear_tv(&rettv);
21347 /* It's safer to return also on error. */
21348 else if (!eap->skip)
21351 * Return unless the expression evaluation has been cancelled due to an
21352 * aborting error, an interrupt, or an exception.
21354 if (!aborting())
21355 returning = do_return(eap, FALSE, TRUE, NULL);
21358 /* When skipping or the return gets pending, advance to the next command
21359 * in this line (!returning). Otherwise, ignore the rest of the line.
21360 * Following lines will be ignored by get_func_line(). */
21361 if (returning)
21362 eap->nextcmd = NULL;
21363 else if (eap->nextcmd == NULL) /* no argument */
21364 eap->nextcmd = check_nextcmd(arg);
21366 if (eap->skip)
21367 --emsg_skip;
21371 * Return from a function. Possibly makes the return pending. Also called
21372 * for a pending return at the ":endtry" or after returning from an extra
21373 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21374 * when called due to a ":return" command. "rettv" may point to a typval_T
21375 * with the return rettv. Returns TRUE when the return can be carried out,
21376 * FALSE when the return gets pending.
21379 do_return(eap, reanimate, is_cmd, rettv)
21380 exarg_T *eap;
21381 int reanimate;
21382 int is_cmd;
21383 void *rettv;
21385 int idx;
21386 struct condstack *cstack = eap->cstack;
21388 if (reanimate)
21389 /* Undo the return. */
21390 current_funccal->returned = FALSE;
21393 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21394 * not in its finally clause (which then is to be executed next) is found.
21395 * In this case, make the ":return" pending for execution at the ":endtry".
21396 * Otherwise, return normally.
21398 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21399 if (idx >= 0)
21401 cstack->cs_pending[idx] = CSTP_RETURN;
21403 if (!is_cmd && !reanimate)
21404 /* A pending return again gets pending. "rettv" points to an
21405 * allocated variable with the rettv of the original ":return"'s
21406 * argument if present or is NULL else. */
21407 cstack->cs_rettv[idx] = rettv;
21408 else
21410 /* When undoing a return in order to make it pending, get the stored
21411 * return rettv. */
21412 if (reanimate)
21413 rettv = current_funccal->rettv;
21415 if (rettv != NULL)
21417 /* Store the value of the pending return. */
21418 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21419 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21420 else
21421 EMSG(_(e_outofmem));
21423 else
21424 cstack->cs_rettv[idx] = NULL;
21426 if (reanimate)
21428 /* The pending return value could be overwritten by a ":return"
21429 * without argument in a finally clause; reset the default
21430 * return value. */
21431 current_funccal->rettv->v_type = VAR_NUMBER;
21432 current_funccal->rettv->vval.v_number = 0;
21435 report_make_pending(CSTP_RETURN, rettv);
21437 else
21439 current_funccal->returned = TRUE;
21441 /* If the return is carried out now, store the return value. For
21442 * a return immediately after reanimation, the value is already
21443 * there. */
21444 if (!reanimate && rettv != NULL)
21446 clear_tv(current_funccal->rettv);
21447 *current_funccal->rettv = *(typval_T *)rettv;
21448 if (!is_cmd)
21449 vim_free(rettv);
21453 return idx < 0;
21457 * Free the variable with a pending return value.
21459 void
21460 discard_pending_return(rettv)
21461 void *rettv;
21463 free_tv((typval_T *)rettv);
21467 * Generate a return command for producing the value of "rettv". The result
21468 * is an allocated string. Used by report_pending() for verbose messages.
21470 char_u *
21471 get_return_cmd(rettv)
21472 void *rettv;
21474 char_u *s = NULL;
21475 char_u *tofree = NULL;
21476 char_u numbuf[NUMBUFLEN];
21478 if (rettv != NULL)
21479 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21480 if (s == NULL)
21481 s = (char_u *)"";
21483 STRCPY(IObuff, ":return ");
21484 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21485 if (STRLEN(s) + 8 >= IOSIZE)
21486 STRCPY(IObuff + IOSIZE - 4, "...");
21487 vim_free(tofree);
21488 return vim_strsave(IObuff);
21492 * Get next function line.
21493 * Called by do_cmdline() to get the next line.
21494 * Returns allocated string, or NULL for end of function.
21496 /* ARGSUSED */
21497 char_u *
21498 get_func_line(c, cookie, indent)
21499 int c; /* not used */
21500 void *cookie;
21501 int indent; /* not used */
21503 funccall_T *fcp = (funccall_T *)cookie;
21504 ufunc_T *fp = fcp->func;
21505 char_u *retval;
21506 garray_T *gap; /* growarray with function lines */
21508 /* If breakpoints have been added/deleted need to check for it. */
21509 if (fcp->dbg_tick != debug_tick)
21511 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21512 sourcing_lnum);
21513 fcp->dbg_tick = debug_tick;
21515 #ifdef FEAT_PROFILE
21516 if (do_profiling == PROF_YES)
21517 func_line_end(cookie);
21518 #endif
21520 gap = &fp->uf_lines;
21521 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21522 || fcp->returned)
21523 retval = NULL;
21524 else
21526 /* Skip NULL lines (continuation lines). */
21527 while (fcp->linenr < gap->ga_len
21528 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21529 ++fcp->linenr;
21530 if (fcp->linenr >= gap->ga_len)
21531 retval = NULL;
21532 else
21534 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21535 sourcing_lnum = fcp->linenr;
21536 #ifdef FEAT_PROFILE
21537 if (do_profiling == PROF_YES)
21538 func_line_start(cookie);
21539 #endif
21543 /* Did we encounter a breakpoint? */
21544 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21546 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21547 /* Find next breakpoint. */
21548 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21549 sourcing_lnum);
21550 fcp->dbg_tick = debug_tick;
21553 return retval;
21556 #if defined(FEAT_PROFILE) || defined(PROTO)
21558 * Called when starting to read a function line.
21559 * "sourcing_lnum" must be correct!
21560 * When skipping lines it may not actually be executed, but we won't find out
21561 * until later and we need to store the time now.
21563 void
21564 func_line_start(cookie)
21565 void *cookie;
21567 funccall_T *fcp = (funccall_T *)cookie;
21568 ufunc_T *fp = fcp->func;
21570 if (fp->uf_profiling && sourcing_lnum >= 1
21571 && sourcing_lnum <= fp->uf_lines.ga_len)
21573 fp->uf_tml_idx = sourcing_lnum - 1;
21574 /* Skip continuation lines. */
21575 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21576 --fp->uf_tml_idx;
21577 fp->uf_tml_execed = FALSE;
21578 profile_start(&fp->uf_tml_start);
21579 profile_zero(&fp->uf_tml_children);
21580 profile_get_wait(&fp->uf_tml_wait);
21585 * Called when actually executing a function line.
21587 void
21588 func_line_exec(cookie)
21589 void *cookie;
21591 funccall_T *fcp = (funccall_T *)cookie;
21592 ufunc_T *fp = fcp->func;
21594 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21595 fp->uf_tml_execed = TRUE;
21599 * Called when done with a function line.
21601 void
21602 func_line_end(cookie)
21603 void *cookie;
21605 funccall_T *fcp = (funccall_T *)cookie;
21606 ufunc_T *fp = fcp->func;
21608 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21610 if (fp->uf_tml_execed)
21612 ++fp->uf_tml_count[fp->uf_tml_idx];
21613 profile_end(&fp->uf_tml_start);
21614 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21615 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21616 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21617 &fp->uf_tml_children);
21619 fp->uf_tml_idx = -1;
21622 #endif
21625 * Return TRUE if the currently active function should be ended, because a
21626 * return was encountered or an error occurred. Used inside a ":while".
21629 func_has_ended(cookie)
21630 void *cookie;
21632 funccall_T *fcp = (funccall_T *)cookie;
21634 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21635 * an error inside a try conditional. */
21636 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21637 || fcp->returned);
21641 * return TRUE if cookie indicates a function which "abort"s on errors.
21644 func_has_abort(cookie)
21645 void *cookie;
21647 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21650 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21651 typedef enum
21653 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21654 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21655 VAR_FLAVOUR_VIMINFO /* all uppercase */
21656 } var_flavour_T;
21658 static var_flavour_T var_flavour __ARGS((char_u *varname));
21660 static var_flavour_T
21661 var_flavour(varname)
21662 char_u *varname;
21664 char_u *p = varname;
21666 if (ASCII_ISUPPER(*p))
21668 while (*(++p))
21669 if (ASCII_ISLOWER(*p))
21670 return VAR_FLAVOUR_SESSION;
21671 return VAR_FLAVOUR_VIMINFO;
21673 else
21674 return VAR_FLAVOUR_DEFAULT;
21676 #endif
21678 #if defined(FEAT_VIMINFO) || defined(PROTO)
21680 * Restore global vars that start with a capital from the viminfo file
21683 read_viminfo_varlist(virp, writing)
21684 vir_T *virp;
21685 int writing;
21687 char_u *tab;
21688 int type = VAR_NUMBER;
21689 typval_T tv;
21691 if (!writing && (find_viminfo_parameter('!') != NULL))
21693 tab = vim_strchr(virp->vir_line + 1, '\t');
21694 if (tab != NULL)
21696 *tab++ = '\0'; /* isolate the variable name */
21697 if (*tab == 'S') /* string var */
21698 type = VAR_STRING;
21699 #ifdef FEAT_FLOAT
21700 else if (*tab == 'F')
21701 type = VAR_FLOAT;
21702 #endif
21704 tab = vim_strchr(tab, '\t');
21705 if (tab != NULL)
21707 tv.v_type = type;
21708 if (type == VAR_STRING)
21709 tv.vval.v_string = viminfo_readstring(virp,
21710 (int)(tab - virp->vir_line + 1), TRUE);
21711 #ifdef FEAT_FLOAT
21712 else if (type == VAR_FLOAT)
21713 (void)string2float(tab + 1, &tv.vval.v_float);
21714 #endif
21715 else
21716 tv.vval.v_number = atol((char *)tab + 1);
21717 set_var(virp->vir_line + 1, &tv, FALSE);
21718 if (type == VAR_STRING)
21719 vim_free(tv.vval.v_string);
21724 return viminfo_readline(virp);
21728 * Write global vars that start with a capital to the viminfo file
21730 void
21731 write_viminfo_varlist(fp)
21732 FILE *fp;
21734 hashitem_T *hi;
21735 dictitem_T *this_var;
21736 int todo;
21737 char *s;
21738 char_u *p;
21739 char_u *tofree;
21740 char_u numbuf[NUMBUFLEN];
21742 if (find_viminfo_parameter('!') == NULL)
21743 return;
21745 fprintf(fp, _("\n# global variables:\n"));
21747 todo = (int)globvarht.ht_used;
21748 for (hi = globvarht.ht_array; todo > 0; ++hi)
21750 if (!HASHITEM_EMPTY(hi))
21752 --todo;
21753 this_var = HI2DI(hi);
21754 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21756 switch (this_var->di_tv.v_type)
21758 case VAR_STRING: s = "STR"; break;
21759 case VAR_NUMBER: s = "NUM"; break;
21760 #ifdef FEAT_FLOAT
21761 case VAR_FLOAT: s = "FLO"; break;
21762 #endif
21763 default: continue;
21765 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21766 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21767 if (p != NULL)
21768 viminfo_writestring(fp, p);
21769 vim_free(tofree);
21774 #endif
21776 #if defined(FEAT_SESSION) || defined(PROTO)
21778 store_session_globals(fd)
21779 FILE *fd;
21781 hashitem_T *hi;
21782 dictitem_T *this_var;
21783 int todo;
21784 char_u *p, *t;
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 ((this_var->di_tv.v_type == VAR_NUMBER
21794 || this_var->di_tv.v_type == VAR_STRING)
21795 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21797 /* Escape special characters with a backslash. Turn a LF and
21798 * CR into \n and \r. */
21799 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
21800 (char_u *)"\\\"\n\r");
21801 if (p == NULL) /* out of memory */
21802 break;
21803 for (t = p; *t != NUL; ++t)
21804 if (*t == '\n')
21805 *t = 'n';
21806 else if (*t == '\r')
21807 *t = 'r';
21808 if ((fprintf(fd, "let %s = %c%s%c",
21809 this_var->di_key,
21810 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21811 : ' ',
21813 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21814 : ' ') < 0)
21815 || put_eol(fd) == FAIL)
21817 vim_free(p);
21818 return FAIL;
21820 vim_free(p);
21822 #ifdef FEAT_FLOAT
21823 else if (this_var->di_tv.v_type == VAR_FLOAT
21824 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21826 float_T f = this_var->di_tv.vval.v_float;
21827 int sign = ' ';
21829 if (f < 0)
21831 f = -f;
21832 sign = '-';
21834 if ((fprintf(fd, "let %s = %c&%f",
21835 this_var->di_key, sign, f) < 0)
21836 || put_eol(fd) == FAIL)
21837 return FAIL;
21839 #endif
21842 return OK;
21844 #endif
21847 * Display script name where an item was last set.
21848 * Should only be invoked when 'verbose' is non-zero.
21850 void
21851 last_set_msg(scriptID)
21852 scid_T scriptID;
21854 char_u *p;
21856 if (scriptID != 0)
21858 p = home_replace_save(NULL, get_scriptname(scriptID));
21859 if (p != NULL)
21861 verbose_enter();
21862 MSG_PUTS(_("\n\tLast set from "));
21863 MSG_PUTS(p);
21864 vim_free(p);
21865 verbose_leave();
21870 #endif /* FEAT_EVAL */
21873 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
21875 #ifdef WIN3264
21877 * Functions for ":8" filename modifier: get 8.3 version of a filename.
21879 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
21880 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
21881 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
21884 * Get the short path (8.3) for the filename in "fnamep".
21885 * Only works for a valid file name.
21886 * When the path gets longer "fnamep" is changed and the allocated buffer
21887 * is put in "bufp".
21888 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
21889 * Returns OK on success, FAIL on failure.
21891 static int
21892 get_short_pathname(fnamep, bufp, fnamelen)
21893 char_u **fnamep;
21894 char_u **bufp;
21895 int *fnamelen;
21897 int l, len;
21898 char_u *newbuf;
21900 len = *fnamelen;
21901 l = GetShortPathName(*fnamep, *fnamep, len);
21902 if (l > len - 1)
21904 /* If that doesn't work (not enough space), then save the string
21905 * and try again with a new buffer big enough. */
21906 newbuf = vim_strnsave(*fnamep, l);
21907 if (newbuf == NULL)
21908 return FAIL;
21910 vim_free(*bufp);
21911 *fnamep = *bufp = newbuf;
21913 /* Really should always succeed, as the buffer is big enough. */
21914 l = GetShortPathName(*fnamep, *fnamep, l+1);
21917 *fnamelen = l;
21918 return OK;
21922 * Get the short path (8.3) for the filename in "fname". The converted
21923 * path is returned in "bufp".
21925 * Some of the directories specified in "fname" may not exist. This function
21926 * will shorten the existing directories at the beginning of the path and then
21927 * append the remaining non-existing path.
21929 * fname - Pointer to the filename to shorten. On return, contains the
21930 * pointer to the shortened pathname
21931 * bufp - Pointer to an allocated buffer for the filename.
21932 * fnamelen - Length of the filename pointed to by fname
21934 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
21936 static int
21937 shortpath_for_invalid_fname(fname, bufp, fnamelen)
21938 char_u **fname;
21939 char_u **bufp;
21940 int *fnamelen;
21942 char_u *short_fname, *save_fname, *pbuf_unused;
21943 char_u *endp, *save_endp;
21944 char_u ch;
21945 int old_len, len;
21946 int new_len, sfx_len;
21947 int retval = OK;
21949 /* Make a copy */
21950 old_len = *fnamelen;
21951 save_fname = vim_strnsave(*fname, old_len);
21952 pbuf_unused = NULL;
21953 short_fname = NULL;
21955 endp = save_fname + old_len - 1; /* Find the end of the copy */
21956 save_endp = endp;
21959 * Try shortening the supplied path till it succeeds by removing one
21960 * directory at a time from the tail of the path.
21962 len = 0;
21963 for (;;)
21965 /* go back one path-separator */
21966 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
21967 --endp;
21968 if (endp <= save_fname)
21969 break; /* processed the complete path */
21972 * Replace the path separator with a NUL and try to shorten the
21973 * resulting path.
21975 ch = *endp;
21976 *endp = 0;
21977 short_fname = save_fname;
21978 len = STRLEN(short_fname) + 1;
21979 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
21981 retval = FAIL;
21982 goto theend;
21984 *endp = ch; /* preserve the string */
21986 if (len > 0)
21987 break; /* successfully shortened the path */
21989 /* failed to shorten the path. Skip the path separator */
21990 --endp;
21993 if (len > 0)
21996 * Succeeded in shortening the path. Now concatenate the shortened
21997 * path with the remaining path at the tail.
22000 /* Compute the length of the new path. */
22001 sfx_len = (int)(save_endp - endp) + 1;
22002 new_len = len + sfx_len;
22004 *fnamelen = new_len;
22005 vim_free(*bufp);
22006 if (new_len > old_len)
22008 /* There is not enough space in the currently allocated string,
22009 * copy it to a buffer big enough. */
22010 *fname = *bufp = vim_strnsave(short_fname, new_len);
22011 if (*fname == NULL)
22013 retval = FAIL;
22014 goto theend;
22017 else
22019 /* Transfer short_fname to the main buffer (it's big enough),
22020 * unless get_short_pathname() did its work in-place. */
22021 *fname = *bufp = save_fname;
22022 if (short_fname != save_fname)
22023 vim_strncpy(save_fname, short_fname, len);
22024 save_fname = NULL;
22027 /* concat the not-shortened part of the path */
22028 vim_strncpy(*fname + len, endp, sfx_len);
22029 (*fname)[new_len] = NUL;
22032 theend:
22033 vim_free(pbuf_unused);
22034 vim_free(save_fname);
22036 return retval;
22040 * Get a pathname for a partial path.
22041 * Returns OK for success, FAIL for failure.
22043 static int
22044 shortpath_for_partial(fnamep, bufp, fnamelen)
22045 char_u **fnamep;
22046 char_u **bufp;
22047 int *fnamelen;
22049 int sepcount, len, tflen;
22050 char_u *p;
22051 char_u *pbuf, *tfname;
22052 int hasTilde;
22054 /* Count up the path separators from the RHS.. so we know which part
22055 * of the path to return. */
22056 sepcount = 0;
22057 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22058 if (vim_ispathsep(*p))
22059 ++sepcount;
22061 /* Need full path first (use expand_env() to remove a "~/") */
22062 hasTilde = (**fnamep == '~');
22063 if (hasTilde)
22064 pbuf = tfname = expand_env_save(*fnamep);
22065 else
22066 pbuf = tfname = FullName_save(*fnamep, FALSE);
22068 len = tflen = (int)STRLEN(tfname);
22070 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22071 return FAIL;
22073 if (len == 0)
22075 /* Don't have a valid filename, so shorten the rest of the
22076 * path if we can. This CAN give us invalid 8.3 filenames, but
22077 * there's not a lot of point in guessing what it might be.
22079 len = tflen;
22080 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22081 return FAIL;
22084 /* Count the paths backward to find the beginning of the desired string. */
22085 for (p = tfname + len - 1; p >= tfname; --p)
22087 #ifdef FEAT_MBYTE
22088 if (has_mbyte)
22089 p -= mb_head_off(tfname, p);
22090 #endif
22091 if (vim_ispathsep(*p))
22093 if (sepcount == 0 || (hasTilde && sepcount == 1))
22094 break;
22095 else
22096 sepcount --;
22099 if (hasTilde)
22101 --p;
22102 if (p >= tfname)
22103 *p = '~';
22104 else
22105 return FAIL;
22107 else
22108 ++p;
22110 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22111 vim_free(*bufp);
22112 *fnamelen = (int)STRLEN(p);
22113 *bufp = pbuf;
22114 *fnamep = p;
22116 return OK;
22118 #endif /* WIN3264 */
22121 * Adjust a filename, according to a string of modifiers.
22122 * *fnamep must be NUL terminated when called. When returning, the length is
22123 * determined by *fnamelen.
22124 * Returns VALID_ flags or -1 for failure.
22125 * When there is an error, *fnamep is set to NULL.
22128 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22129 char_u *src; /* string with modifiers */
22130 int *usedlen; /* characters after src that are used */
22131 char_u **fnamep; /* file name so far */
22132 char_u **bufp; /* buffer for allocated file name or NULL */
22133 int *fnamelen; /* length of fnamep */
22135 int valid = 0;
22136 char_u *tail;
22137 char_u *s, *p, *pbuf;
22138 char_u dirname[MAXPATHL];
22139 int c;
22140 int has_fullname = 0;
22141 #ifdef WIN3264
22142 int has_shortname = 0;
22143 #endif
22145 repeat:
22146 /* ":p" - full path/file_name */
22147 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22149 has_fullname = 1;
22151 valid |= VALID_PATH;
22152 *usedlen += 2;
22154 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22155 if ((*fnamep)[0] == '~'
22156 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22157 && ((*fnamep)[1] == '/'
22158 # ifdef BACKSLASH_IN_FILENAME
22159 || (*fnamep)[1] == '\\'
22160 # endif
22161 || (*fnamep)[1] == NUL)
22163 #endif
22166 *fnamep = expand_env_save(*fnamep);
22167 vim_free(*bufp); /* free any allocated file name */
22168 *bufp = *fnamep;
22169 if (*fnamep == NULL)
22170 return -1;
22173 /* When "/." or "/.." is used: force expansion to get rid of it. */
22174 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22176 if (vim_ispathsep(*p)
22177 && p[1] == '.'
22178 && (p[2] == NUL
22179 || vim_ispathsep(p[2])
22180 || (p[2] == '.'
22181 && (p[3] == NUL || vim_ispathsep(p[3])))))
22182 break;
22185 /* FullName_save() is slow, don't use it when not needed. */
22186 if (*p != NUL || !vim_isAbsName(*fnamep))
22188 *fnamep = FullName_save(*fnamep, *p != NUL);
22189 vim_free(*bufp); /* free any allocated file name */
22190 *bufp = *fnamep;
22191 if (*fnamep == NULL)
22192 return -1;
22195 /* Append a path separator to a directory. */
22196 if (mch_isdir(*fnamep))
22198 /* Make room for one or two extra characters. */
22199 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22200 vim_free(*bufp); /* free any allocated file name */
22201 *bufp = *fnamep;
22202 if (*fnamep == NULL)
22203 return -1;
22204 add_pathsep(*fnamep);
22208 /* ":." - path relative to the current directory */
22209 /* ":~" - path relative to the home directory */
22210 /* ":8" - shortname path - postponed till after */
22211 while (src[*usedlen] == ':'
22212 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22214 *usedlen += 2;
22215 if (c == '8')
22217 #ifdef WIN3264
22218 has_shortname = 1; /* Postpone this. */
22219 #endif
22220 continue;
22222 pbuf = NULL;
22223 /* Need full path first (use expand_env() to remove a "~/") */
22224 if (!has_fullname)
22226 if (c == '.' && **fnamep == '~')
22227 p = pbuf = expand_env_save(*fnamep);
22228 else
22229 p = pbuf = FullName_save(*fnamep, FALSE);
22231 else
22232 p = *fnamep;
22234 has_fullname = 0;
22236 if (p != NULL)
22238 if (c == '.')
22240 mch_dirname(dirname, MAXPATHL);
22241 s = shorten_fname(p, dirname);
22242 if (s != NULL)
22244 *fnamep = s;
22245 if (pbuf != NULL)
22247 vim_free(*bufp); /* free any allocated file name */
22248 *bufp = pbuf;
22249 pbuf = NULL;
22253 else
22255 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22256 /* Only replace it when it starts with '~' */
22257 if (*dirname == '~')
22259 s = vim_strsave(dirname);
22260 if (s != NULL)
22262 *fnamep = s;
22263 vim_free(*bufp);
22264 *bufp = s;
22268 vim_free(pbuf);
22272 tail = gettail(*fnamep);
22273 *fnamelen = (int)STRLEN(*fnamep);
22275 /* ":h" - head, remove "/file_name", can be repeated */
22276 /* Don't remove the first "/" or "c:\" */
22277 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22279 valid |= VALID_HEAD;
22280 *usedlen += 2;
22281 s = get_past_head(*fnamep);
22282 while (tail > s && after_pathsep(s, tail))
22283 mb_ptr_back(*fnamep, tail);
22284 *fnamelen = (int)(tail - *fnamep);
22285 #ifdef VMS
22286 if (*fnamelen > 0)
22287 *fnamelen += 1; /* the path separator is part of the path */
22288 #endif
22289 if (*fnamelen == 0)
22291 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22292 p = vim_strsave((char_u *)".");
22293 if (p == NULL)
22294 return -1;
22295 vim_free(*bufp);
22296 *bufp = *fnamep = tail = p;
22297 *fnamelen = 1;
22299 else
22301 while (tail > s && !after_pathsep(s, tail))
22302 mb_ptr_back(*fnamep, tail);
22306 /* ":8" - shortname */
22307 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22309 *usedlen += 2;
22310 #ifdef WIN3264
22311 has_shortname = 1;
22312 #endif
22315 #ifdef WIN3264
22316 /* Check shortname after we have done 'heads' and before we do 'tails'
22318 if (has_shortname)
22320 pbuf = NULL;
22321 /* Copy the string if it is shortened by :h */
22322 if (*fnamelen < (int)STRLEN(*fnamep))
22324 p = vim_strnsave(*fnamep, *fnamelen);
22325 if (p == 0)
22326 return -1;
22327 vim_free(*bufp);
22328 *bufp = *fnamep = p;
22331 /* Split into two implementations - makes it easier. First is where
22332 * there isn't a full name already, second is where there is.
22334 if (!has_fullname && !vim_isAbsName(*fnamep))
22336 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22337 return -1;
22339 else
22341 int l;
22343 /* Simple case, already have the full-name
22344 * Nearly always shorter, so try first time. */
22345 l = *fnamelen;
22346 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22347 return -1;
22349 if (l == 0)
22351 /* Couldn't find the filename.. search the paths.
22353 l = *fnamelen;
22354 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22355 return -1;
22357 *fnamelen = l;
22360 #endif /* WIN3264 */
22362 /* ":t" - tail, just the basename */
22363 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22365 *usedlen += 2;
22366 *fnamelen -= (int)(tail - *fnamep);
22367 *fnamep = tail;
22370 /* ":e" - extension, can be repeated */
22371 /* ":r" - root, without extension, can be repeated */
22372 while (src[*usedlen] == ':'
22373 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22375 /* find a '.' in the tail:
22376 * - for second :e: before the current fname
22377 * - otherwise: The last '.'
22379 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22380 s = *fnamep - 2;
22381 else
22382 s = *fnamep + *fnamelen - 1;
22383 for ( ; s > tail; --s)
22384 if (s[0] == '.')
22385 break;
22386 if (src[*usedlen + 1] == 'e') /* :e */
22388 if (s > tail)
22390 *fnamelen += (int)(*fnamep - (s + 1));
22391 *fnamep = s + 1;
22392 #ifdef VMS
22393 /* cut version from the extension */
22394 s = *fnamep + *fnamelen - 1;
22395 for ( ; s > *fnamep; --s)
22396 if (s[0] == ';')
22397 break;
22398 if (s > *fnamep)
22399 *fnamelen = s - *fnamep;
22400 #endif
22402 else if (*fnamep <= tail)
22403 *fnamelen = 0;
22405 else /* :r */
22407 if (s > tail) /* remove one extension */
22408 *fnamelen = (int)(s - *fnamep);
22410 *usedlen += 2;
22413 /* ":s?pat?foo?" - substitute */
22414 /* ":gs?pat?foo?" - global substitute */
22415 if (src[*usedlen] == ':'
22416 && (src[*usedlen + 1] == 's'
22417 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22419 char_u *str;
22420 char_u *pat;
22421 char_u *sub;
22422 int sep;
22423 char_u *flags;
22424 int didit = FALSE;
22426 flags = (char_u *)"";
22427 s = src + *usedlen + 2;
22428 if (src[*usedlen + 1] == 'g')
22430 flags = (char_u *)"g";
22431 ++s;
22434 sep = *s++;
22435 if (sep)
22437 /* find end of pattern */
22438 p = vim_strchr(s, sep);
22439 if (p != NULL)
22441 pat = vim_strnsave(s, (int)(p - s));
22442 if (pat != NULL)
22444 s = p + 1;
22445 /* find end of substitution */
22446 p = vim_strchr(s, sep);
22447 if (p != NULL)
22449 sub = vim_strnsave(s, (int)(p - s));
22450 str = vim_strnsave(*fnamep, *fnamelen);
22451 if (sub != NULL && str != NULL)
22453 *usedlen = (int)(p + 1 - src);
22454 s = do_string_sub(str, pat, sub, flags);
22455 if (s != NULL)
22457 *fnamep = s;
22458 *fnamelen = (int)STRLEN(s);
22459 vim_free(*bufp);
22460 *bufp = s;
22461 didit = TRUE;
22464 vim_free(sub);
22465 vim_free(str);
22467 vim_free(pat);
22470 /* after using ":s", repeat all the modifiers */
22471 if (didit)
22472 goto repeat;
22476 return valid;
22480 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22481 * "flags" can be "g" to do a global substitute.
22482 * Returns an allocated string, NULL for error.
22484 char_u *
22485 do_string_sub(str, pat, sub, flags)
22486 char_u *str;
22487 char_u *pat;
22488 char_u *sub;
22489 char_u *flags;
22491 int sublen;
22492 regmatch_T regmatch;
22493 int i;
22494 int do_all;
22495 char_u *tail;
22496 garray_T ga;
22497 char_u *ret;
22498 char_u *save_cpo;
22500 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22501 save_cpo = p_cpo;
22502 p_cpo = (char_u *)"";
22504 ga_init2(&ga, 1, 200);
22506 do_all = (flags[0] == 'g');
22508 regmatch.rm_ic = p_ic;
22509 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22510 if (regmatch.regprog != NULL)
22512 tail = str;
22513 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22516 * Get some space for a temporary buffer to do the substitution
22517 * into. It will contain:
22518 * - The text up to where the match is.
22519 * - The substituted text.
22520 * - The text after the match.
22522 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22523 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22524 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22526 ga_clear(&ga);
22527 break;
22530 /* copy the text up to where the match is */
22531 i = (int)(regmatch.startp[0] - tail);
22532 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22533 /* add the substituted text */
22534 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22535 + ga.ga_len + i, TRUE, TRUE, FALSE);
22536 ga.ga_len += i + sublen - 1;
22537 /* avoid getting stuck on a match with an empty string */
22538 if (tail == regmatch.endp[0])
22540 if (*tail == NUL)
22541 break;
22542 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22543 ++ga.ga_len;
22545 else
22547 tail = regmatch.endp[0];
22548 if (*tail == NUL)
22549 break;
22551 if (!do_all)
22552 break;
22555 if (ga.ga_data != NULL)
22556 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22558 vim_free(regmatch.regprog);
22561 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22562 ga_clear(&ga);
22563 p_cpo = save_cpo;
22565 return ret;
22568 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */