Merge branch 'vim'
[MacVim.git] / src / eval.c
blobc06b363d2464eb93138bce82f6a0420201b37f92
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
11 * eval.c: Expression evaluation.
13 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
14 # include "vimio.h" /* for mch_open(), must be before vim.h */
15 #endif
17 #include "vim.h"
19 #if defined(FEAT_EVAL) || defined(PROTO)
21 #ifdef AMIGA
22 # include <time.h> /* for strftime() */
23 #endif
25 #ifdef MACOS
26 # include <time.h> /* for time_t */
27 #endif
29 #if defined(FEAT_FLOAT) && defined(HAVE_MATH_H)
30 # include <math.h>
31 #endif
33 #define DICT_MAXNEST 100 /* maximum nesting of lists and dicts */
36 * In a hashtab item "hi_key" points to "di_key" in a dictitem.
37 * This avoids adding a pointer to the hashtab item.
38 * DI2HIKEY() converts a dictitem pointer to a hashitem key pointer.
39 * HIKEY2DI() converts a hashitem key pointer to a dictitem pointer.
40 * HI2DI() converts a hashitem pointer to a dictitem pointer.
42 static dictitem_T dumdi;
43 #define DI2HIKEY(di) ((di)->di_key)
44 #define HIKEY2DI(p) ((dictitem_T *)(p - (dumdi.di_key - (char_u *)&dumdi)))
45 #define HI2DI(hi) HIKEY2DI((hi)->hi_key)
48 * Structure returned by get_lval() and used by set_var_lval().
49 * For a plain name:
50 * "name" points to the variable name.
51 * "exp_name" is NULL.
52 * "tv" is NULL
53 * For a magic braces name:
54 * "name" points to the expanded variable name.
55 * "exp_name" is non-NULL, to be freed later.
56 * "tv" is NULL
57 * For an index in a list:
58 * "name" points to the (expanded) variable name.
59 * "exp_name" NULL or non-NULL, to be freed later.
60 * "tv" points to the (first) list item value
61 * "li" points to the (first) list item
62 * "range", "n1", "n2" and "empty2" indicate what items are used.
63 * For an existing Dict item:
64 * "name" points to the (expanded) variable name.
65 * "exp_name" NULL or non-NULL, to be freed later.
66 * "tv" points to the dict item value
67 * "newkey" is NULL
68 * For a non-existing Dict item:
69 * "name" points to the (expanded) variable name.
70 * "exp_name" NULL or non-NULL, to be freed later.
71 * "tv" points to the Dictionary typval_T
72 * "newkey" is the key for the new item.
74 typedef struct lval_S
76 char_u *ll_name; /* start of variable name (can be NULL) */
77 char_u *ll_exp_name; /* NULL or expanded name in allocated memory. */
78 typval_T *ll_tv; /* Typeval of item being used. If "newkey"
79 isn't NULL it's the Dict to which to add
80 the item. */
81 listitem_T *ll_li; /* The list item or NULL. */
82 list_T *ll_list; /* The list or NULL. */
83 int ll_range; /* TRUE when a [i:j] range was used */
84 long ll_n1; /* First index for list */
85 long ll_n2; /* Second index for list range */
86 int ll_empty2; /* Second index is empty: [i:] */
87 dict_T *ll_dict; /* The Dictionary or NULL */
88 dictitem_T *ll_di; /* The dictitem or NULL */
89 char_u *ll_newkey; /* New key for Dict in alloc. mem or NULL. */
90 } lval_T;
93 static char *e_letunexp = N_("E18: Unexpected characters in :let");
94 static char *e_listidx = N_("E684: list index out of range: %ld");
95 static char *e_undefvar = N_("E121: Undefined variable: %s");
96 static char *e_missbrac = N_("E111: Missing ']'");
97 static char *e_listarg = N_("E686: Argument of %s must be a List");
98 static char *e_listdictarg = N_("E712: Argument of %s must be a List or Dictionary");
99 static char *e_emptykey = N_("E713: Cannot use empty key for Dictionary");
100 static char *e_listreq = N_("E714: List required");
101 static char *e_dictreq = N_("E715: Dictionary required");
102 static char *e_toomanyarg = N_("E118: Too many arguments for function: %s");
103 static char *e_dictkey = N_("E716: Key not present in Dictionary: %s");
104 static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
105 static char *e_funcdict = N_("E717: Dictionary entry already exists");
106 static char *e_funcref = N_("E718: Funcref required");
107 static char *e_dictrange = N_("E719: Cannot use [:] with a Dictionary");
108 static char *e_letwrong = N_("E734: Wrong variable type for %s=");
109 static char *e_nofunc = N_("E130: Unknown function: %s");
110 static char *e_illvar = N_("E461: Illegal variable name: %s");
113 * All user-defined global variables are stored in dictionary "globvardict".
114 * "globvars_var" is the variable that is used for "g:".
116 static dict_T globvardict;
117 static dictitem_T globvars_var;
118 #define globvarht globvardict.dv_hashtab
121 * Old Vim variables such as "v:version" are also available without the "v:".
122 * Also in functions. We need a special hashtable for them.
124 static hashtab_T compat_hashtab;
127 * When recursively copying lists and dicts we need to remember which ones we
128 * have done to avoid endless recursiveness. This unique ID is used for that.
130 static int current_copyID = 0;
133 * Array to hold the hashtab with variables local to each sourced script.
134 * Each item holds a variable (nameless) that points to the dict_T.
136 typedef struct
138 dictitem_T sv_var;
139 dict_T sv_dict;
140 } scriptvar_T;
142 static garray_T ga_scripts = {0, 0, sizeof(scriptvar_T), 4, NULL};
143 #define SCRIPT_SV(id) (((scriptvar_T *)ga_scripts.ga_data)[(id) - 1])
144 #define SCRIPT_VARS(id) (SCRIPT_SV(id).sv_dict.dv_hashtab)
146 static int echo_attr = 0; /* attributes used for ":echo" */
148 /* Values for trans_function_name() argument: */
149 #define TFN_INT 1 /* internal function name OK */
150 #define TFN_QUIET 2 /* no error messages */
153 * Structure to hold info for a user function.
155 typedef struct ufunc ufunc_T;
157 struct ufunc
159 int uf_varargs; /* variable nr of arguments */
160 int uf_flags;
161 int uf_calls; /* nr of active calls */
162 garray_T uf_args; /* arguments */
163 garray_T uf_lines; /* function lines */
164 #ifdef FEAT_PROFILE
165 int uf_profiling; /* TRUE when func is being profiled */
166 /* profiling the function as a whole */
167 int uf_tm_count; /* nr of calls */
168 proftime_T uf_tm_total; /* time spent in function + children */
169 proftime_T uf_tm_self; /* time spent in function itself */
170 proftime_T uf_tm_children; /* time spent in children this call */
171 /* profiling the function per line */
172 int *uf_tml_count; /* nr of times line was executed */
173 proftime_T *uf_tml_total; /* time spent in a line + children */
174 proftime_T *uf_tml_self; /* time spent in a line itself */
175 proftime_T uf_tml_start; /* start time for current line */
176 proftime_T uf_tml_children; /* time spent in children for this line */
177 proftime_T uf_tml_wait; /* start wait time for current line */
178 int uf_tml_idx; /* index of line being timed; -1 if none */
179 int uf_tml_execed; /* line being timed was executed */
180 #endif
181 scid_T uf_script_ID; /* ID of script where function was defined,
182 used for s: variables */
183 int uf_refcount; /* for numbered function: reference count */
184 char_u uf_name[1]; /* name of function (actually longer); can
185 start with <SNR>123_ (<SNR> is K_SPECIAL
186 KS_EXTRA KE_SNR) */
189 /* function flags */
190 #define FC_ABORT 1 /* abort function on error */
191 #define FC_RANGE 2 /* function accepts range */
192 #define FC_DICT 4 /* Dict function, uses "self" */
195 * All user-defined functions are found in this hashtable.
197 static hashtab_T func_hashtab;
199 /* The names of packages that once were loaded are remembered. */
200 static garray_T ga_loaded = {0, 0, sizeof(char_u *), 4, NULL};
202 /* list heads for garbage collection */
203 static dict_T *first_dict = NULL; /* list of all dicts */
204 static list_T *first_list = NULL; /* list of all lists */
206 /* From user function to hashitem and back. */
207 static ufunc_T dumuf;
208 #define UF2HIKEY(fp) ((fp)->uf_name)
209 #define HIKEY2UF(p) ((ufunc_T *)(p - (dumuf.uf_name - (char_u *)&dumuf)))
210 #define HI2UF(hi) HIKEY2UF((hi)->hi_key)
212 #define FUNCARG(fp, j) ((char_u **)(fp->uf_args.ga_data))[j]
213 #define FUNCLINE(fp, j) ((char_u **)(fp->uf_lines.ga_data))[j]
215 #define MAX_FUNC_ARGS 20 /* maximum number of function arguments */
216 #define VAR_SHORT_LEN 20 /* short variable name length */
217 #define FIXVAR_CNT 12 /* number of fixed variables */
219 /* structure to hold info for a function that is currently being executed. */
220 typedef struct funccall_S funccall_T;
222 struct funccall_S
224 ufunc_T *func; /* function being called */
225 int linenr; /* next line to be executed */
226 int returned; /* ":return" used */
227 struct /* fixed variables for arguments */
229 dictitem_T var; /* variable (without room for name) */
230 char_u room[VAR_SHORT_LEN]; /* room for the name */
231 } fixvar[FIXVAR_CNT];
232 dict_T l_vars; /* l: local function variables */
233 dictitem_T l_vars_var; /* variable for l: scope */
234 dict_T l_avars; /* a: argument variables */
235 dictitem_T l_avars_var; /* variable for a: scope */
236 list_T l_varlist; /* list for a:000 */
237 listitem_T l_listitems[MAX_FUNC_ARGS]; /* listitems for a:000 */
238 typval_T *rettv; /* return value */
239 linenr_T breakpoint; /* next line with breakpoint or zero */
240 int dbg_tick; /* debug_tick when breakpoint was set */
241 int level; /* top nesting level of executed function */
242 #ifdef FEAT_PROFILE
243 proftime_T prof_child; /* time spent in a child */
244 #endif
245 funccall_T *caller; /* calling function or NULL */
249 * Info used by a ":for" loop.
251 typedef struct
253 int fi_semicolon; /* TRUE if ending in '; var]' */
254 int fi_varcount; /* nr of variables in the list */
255 listwatch_T fi_lw; /* keep an eye on the item used. */
256 list_T *fi_list; /* list being used */
257 } forinfo_T;
260 * Struct used by trans_function_name()
262 typedef struct
264 dict_T *fd_dict; /* Dictionary used */
265 char_u *fd_newkey; /* new key in "dict" in allocated memory */
266 dictitem_T *fd_di; /* Dictionary item used */
267 } funcdict_T;
271 * Array to hold the value of v: variables.
272 * The value is in a dictitem, so that it can also be used in the v: scope.
273 * The reason to use this table anyway is for very quick access to the
274 * variables with the VV_ defines.
276 #include "version.h"
278 /* values for vv_flags: */
279 #define VV_COMPAT 1 /* compatible, also used without "v:" */
280 #define VV_RO 2 /* read-only */
281 #define VV_RO_SBX 4 /* read-only in the sandbox */
283 #define VV_NAME(s, t) s, {{t}}, {0}
285 static struct vimvar
287 char *vv_name; /* name of variable, without v: */
288 dictitem_T vv_di; /* value and name for key */
289 char vv_filler[16]; /* space for LONGEST name below!!! */
290 char vv_flags; /* VV_COMPAT, VV_RO, VV_RO_SBX */
291 } vimvars[VV_LEN] =
294 * The order here must match the VV_ defines in vim.h!
295 * Initializing a union does not work, leave tv.vval empty to get zero's.
297 {VV_NAME("count", VAR_NUMBER), VV_COMPAT+VV_RO},
298 {VV_NAME("count1", VAR_NUMBER), VV_RO},
299 {VV_NAME("prevcount", VAR_NUMBER), VV_RO},
300 {VV_NAME("errmsg", VAR_STRING), VV_COMPAT},
301 {VV_NAME("warningmsg", VAR_STRING), 0},
302 {VV_NAME("statusmsg", VAR_STRING), 0},
303 {VV_NAME("shell_error", VAR_NUMBER), VV_COMPAT+VV_RO},
304 {VV_NAME("this_session", VAR_STRING), VV_COMPAT},
305 {VV_NAME("version", VAR_NUMBER), VV_COMPAT+VV_RO},
306 {VV_NAME("lnum", VAR_NUMBER), VV_RO_SBX},
307 {VV_NAME("termresponse", VAR_STRING), VV_RO},
308 {VV_NAME("fname", VAR_STRING), VV_RO},
309 {VV_NAME("lang", VAR_STRING), VV_RO},
310 {VV_NAME("lc_time", VAR_STRING), VV_RO},
311 {VV_NAME("ctype", VAR_STRING), VV_RO},
312 {VV_NAME("charconvert_from", VAR_STRING), VV_RO},
313 {VV_NAME("charconvert_to", VAR_STRING), VV_RO},
314 {VV_NAME("fname_in", VAR_STRING), VV_RO},
315 {VV_NAME("fname_out", VAR_STRING), VV_RO},
316 {VV_NAME("fname_new", VAR_STRING), VV_RO},
317 {VV_NAME("fname_diff", VAR_STRING), VV_RO},
318 {VV_NAME("cmdarg", VAR_STRING), VV_RO},
319 {VV_NAME("foldstart", VAR_NUMBER), VV_RO_SBX},
320 {VV_NAME("foldend", VAR_NUMBER), VV_RO_SBX},
321 {VV_NAME("folddashes", VAR_STRING), VV_RO_SBX},
322 {VV_NAME("foldlevel", VAR_NUMBER), VV_RO_SBX},
323 {VV_NAME("progname", VAR_STRING), VV_RO},
324 {VV_NAME("servername", VAR_STRING), VV_RO},
325 {VV_NAME("dying", VAR_NUMBER), VV_RO},
326 {VV_NAME("exception", VAR_STRING), VV_RO},
327 {VV_NAME("throwpoint", VAR_STRING), VV_RO},
328 {VV_NAME("register", VAR_STRING), VV_RO},
329 {VV_NAME("cmdbang", VAR_NUMBER), VV_RO},
330 {VV_NAME("insertmode", VAR_STRING), VV_RO},
331 {VV_NAME("val", VAR_UNKNOWN), VV_RO},
332 {VV_NAME("key", VAR_UNKNOWN), VV_RO},
333 {VV_NAME("profiling", VAR_NUMBER), VV_RO},
334 {VV_NAME("fcs_reason", VAR_STRING), VV_RO},
335 {VV_NAME("fcs_choice", VAR_STRING), 0},
336 {VV_NAME("beval_bufnr", VAR_NUMBER), VV_RO},
337 {VV_NAME("beval_winnr", VAR_NUMBER), VV_RO},
338 {VV_NAME("beval_lnum", VAR_NUMBER), VV_RO},
339 {VV_NAME("beval_col", VAR_NUMBER), VV_RO},
340 {VV_NAME("beval_text", VAR_STRING), VV_RO},
341 {VV_NAME("scrollstart", VAR_STRING), 0},
342 {VV_NAME("swapname", VAR_STRING), VV_RO},
343 {VV_NAME("swapchoice", VAR_STRING), 0},
344 {VV_NAME("swapcommand", VAR_STRING), VV_RO},
345 {VV_NAME("char", VAR_STRING), VV_RO},
346 {VV_NAME("mouse_win", VAR_NUMBER), 0},
347 {VV_NAME("mouse_lnum", VAR_NUMBER), 0},
348 {VV_NAME("mouse_col", VAR_NUMBER), 0},
349 {VV_NAME("operator", VAR_STRING), VV_RO},
350 {VV_NAME("searchforward", VAR_NUMBER), 0},
353 /* shorthand */
354 #define vv_type vv_di.di_tv.v_type
355 #define vv_nr vv_di.di_tv.vval.v_number
356 #define vv_float vv_di.di_tv.vval.v_float
357 #define vv_str vv_di.di_tv.vval.v_string
358 #define vv_tv vv_di.di_tv
361 * The v: variables are stored in dictionary "vimvardict".
362 * "vimvars_var" is the variable that is used for the "l:" scope.
364 static dict_T vimvardict;
365 static dictitem_T vimvars_var;
366 #define vimvarht vimvardict.dv_hashtab
368 static void prepare_vimvar __ARGS((int idx, typval_T *save_tv));
369 static void restore_vimvar __ARGS((int idx, typval_T *save_tv));
370 #if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
371 static int call_vim_function __ARGS((char_u *func, int argc, char_u **argv, int safe, typval_T *rettv));
372 #endif
373 static int ex_let_vars __ARGS((char_u *arg, typval_T *tv, int copy, int semicolon, int var_count, char_u *nextchars));
374 static char_u *skip_var_list __ARGS((char_u *arg, int *var_count, int *semicolon));
375 static char_u *skip_var_one __ARGS((char_u *arg));
376 static void list_hashtable_vars __ARGS((hashtab_T *ht, char_u *prefix, int empty, int *first));
377 static void list_glob_vars __ARGS((int *first));
378 static void list_buf_vars __ARGS((int *first));
379 static void list_win_vars __ARGS((int *first));
380 #ifdef FEAT_WINDOWS
381 static void list_tab_vars __ARGS((int *first));
382 #endif
383 static void list_vim_vars __ARGS((int *first));
384 static void list_script_vars __ARGS((int *first));
385 static void list_func_vars __ARGS((int *first));
386 static char_u *list_arg_vars __ARGS((exarg_T *eap, char_u *arg, int *first));
387 static char_u *ex_let_one __ARGS((char_u *arg, typval_T *tv, int copy, char_u *endchars, char_u *op));
388 static int check_changedtick __ARGS((char_u *arg));
389 static char_u *get_lval __ARGS((char_u *name, typval_T *rettv, lval_T *lp, int unlet, int skip, int quiet, int fne_flags));
390 static void clear_lval __ARGS((lval_T *lp));
391 static void set_var_lval __ARGS((lval_T *lp, char_u *endp, typval_T *rettv, int copy, char_u *op));
392 static int tv_op __ARGS((typval_T *tv1, typval_T *tv2, char_u *op));
393 static void list_add_watch __ARGS((list_T *l, listwatch_T *lw));
394 static void list_rem_watch __ARGS((list_T *l, listwatch_T *lwrem));
395 static void list_fix_watch __ARGS((list_T *l, listitem_T *item));
396 static void ex_unletlock __ARGS((exarg_T *eap, char_u *argstart, int deep));
397 static int do_unlet_var __ARGS((lval_T *lp, char_u *name_end, int forceit));
398 static int do_lock_var __ARGS((lval_T *lp, char_u *name_end, int deep, int lock));
399 static void item_lock __ARGS((typval_T *tv, int deep, int lock));
400 static int tv_islocked __ARGS((typval_T *tv));
402 static int eval0 __ARGS((char_u *arg, typval_T *rettv, char_u **nextcmd, int evaluate));
403 static int eval1 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
404 static int eval2 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
405 static int eval3 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
406 static int eval4 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
407 static int eval5 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
408 static int eval6 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
409 static int eval7 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
411 static int eval_index __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
412 static int get_option_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
413 static int get_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
414 static int get_lit_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
415 static int get_list_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
416 static int rettv_list_alloc __ARGS((typval_T *rettv));
417 static listitem_T *listitem_alloc __ARGS((void));
418 static void listitem_free __ARGS((listitem_T *item));
419 static void listitem_remove __ARGS((list_T *l, listitem_T *item));
420 static long list_len __ARGS((list_T *l));
421 static int list_equal __ARGS((list_T *l1, list_T *l2, int ic));
422 static int dict_equal __ARGS((dict_T *d1, dict_T *d2, int ic));
423 static int tv_equal __ARGS((typval_T *tv1, typval_T *tv2, int ic));
424 static listitem_T *list_find __ARGS((list_T *l, long n));
425 static long list_find_nr __ARGS((list_T *l, long idx, int *errorp));
426 static long list_idx_of_item __ARGS((list_T *l, listitem_T *item));
427 static void list_append __ARGS((list_T *l, listitem_T *item));
428 static int list_append_tv __ARGS((list_T *l, typval_T *tv));
429 static int list_append_string __ARGS((list_T *l, char_u *str, int len));
430 static int list_append_number __ARGS((list_T *l, varnumber_T n));
431 static int list_insert_tv __ARGS((list_T *l, typval_T *tv, listitem_T *item));
432 static int list_extend __ARGS((list_T *l1, list_T *l2, listitem_T *bef));
433 static int list_concat __ARGS((list_T *l1, list_T *l2, typval_T *tv));
434 static list_T *list_copy __ARGS((list_T *orig, int deep, int copyID));
435 static void list_remove __ARGS((list_T *l, listitem_T *item, listitem_T *item2));
436 static char_u *list2string __ARGS((typval_T *tv, int copyID));
437 static int list_join __ARGS((garray_T *gap, list_T *l, char_u *sep, int echo, int copyID));
438 static void set_ref_in_ht __ARGS((hashtab_T *ht, int copyID));
439 static void set_ref_in_list __ARGS((list_T *l, int copyID));
440 static void set_ref_in_item __ARGS((typval_T *tv, int copyID));
441 static void dict_unref __ARGS((dict_T *d));
442 static void dict_free __ARGS((dict_T *d, int recurse));
443 static dictitem_T *dictitem_alloc __ARGS((char_u *key));
444 static dictitem_T *dictitem_copy __ARGS((dictitem_T *org));
445 static void dictitem_remove __ARGS((dict_T *dict, dictitem_T *item));
446 static void dictitem_free __ARGS((dictitem_T *item));
447 static dict_T *dict_copy __ARGS((dict_T *orig, int deep, int copyID));
448 static int dict_add __ARGS((dict_T *d, dictitem_T *item));
449 static long dict_len __ARGS((dict_T *d));
450 static dictitem_T *dict_find __ARGS((dict_T *d, char_u *key, int len));
451 static char_u *dict2string __ARGS((typval_T *tv, int copyID));
452 static int get_dict_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
453 static char_u *echo_string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
454 static char_u *tv2string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
455 static char_u *string_quote __ARGS((char_u *str, int function));
456 #ifdef FEAT_FLOAT
457 static int string2float __ARGS((char_u *text, float_T *value));
458 #endif
459 static int get_env_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
460 static int find_internal_func __ARGS((char_u *name));
461 static char_u *deref_func_name __ARGS((char_u *name, int *lenp));
462 static int get_func_tv __ARGS((char_u *name, int len, typval_T *rettv, char_u **arg, linenr_T firstline, linenr_T lastline, int *doesrange, int evaluate, dict_T *selfdict));
463 static int call_func __ARGS((char_u *name, int len, typval_T *rettv, int argcount, typval_T *argvars, linenr_T firstline, linenr_T lastline, int *doesrange, int evaluate, dict_T *selfdict));
464 static void emsg_funcname __ARGS((char *ermsg, char_u *name));
465 static int non_zero_arg __ARGS((typval_T *argvars));
467 #ifdef FEAT_FLOAT
468 static void f_abs __ARGS((typval_T *argvars, typval_T *rettv));
469 #endif
470 static void f_add __ARGS((typval_T *argvars, typval_T *rettv));
471 static void f_append __ARGS((typval_T *argvars, typval_T *rettv));
472 static void f_argc __ARGS((typval_T *argvars, typval_T *rettv));
473 static void f_argidx __ARGS((typval_T *argvars, typval_T *rettv));
474 static void f_argv __ARGS((typval_T *argvars, typval_T *rettv));
475 #ifdef FEAT_FLOAT
476 static void f_atan __ARGS((typval_T *argvars, typval_T *rettv));
477 #endif
478 static void f_browse __ARGS((typval_T *argvars, typval_T *rettv));
479 static void f_browsedir __ARGS((typval_T *argvars, typval_T *rettv));
480 static void f_bufexists __ARGS((typval_T *argvars, typval_T *rettv));
481 static void f_buflisted __ARGS((typval_T *argvars, typval_T *rettv));
482 static void f_bufloaded __ARGS((typval_T *argvars, typval_T *rettv));
483 static void f_bufname __ARGS((typval_T *argvars, typval_T *rettv));
484 static void f_bufnr __ARGS((typval_T *argvars, typval_T *rettv));
485 static void f_bufwinnr __ARGS((typval_T *argvars, typval_T *rettv));
486 static void f_byte2line __ARGS((typval_T *argvars, typval_T *rettv));
487 static void f_byteidx __ARGS((typval_T *argvars, typval_T *rettv));
488 static void f_call __ARGS((typval_T *argvars, typval_T *rettv));
489 #ifdef FEAT_FLOAT
490 static void f_ceil __ARGS((typval_T *argvars, typval_T *rettv));
491 #endif
492 static void f_changenr __ARGS((typval_T *argvars, typval_T *rettv));
493 static void f_char2nr __ARGS((typval_T *argvars, typval_T *rettv));
494 static void f_cindent __ARGS((typval_T *argvars, typval_T *rettv));
495 static void f_clearmatches __ARGS((typval_T *argvars, typval_T *rettv));
496 static void f_col __ARGS((typval_T *argvars, typval_T *rettv));
497 #if defined(FEAT_INS_EXPAND)
498 static void f_complete __ARGS((typval_T *argvars, typval_T *rettv));
499 static void f_complete_add __ARGS((typval_T *argvars, typval_T *rettv));
500 static void f_complete_check __ARGS((typval_T *argvars, typval_T *rettv));
501 #endif
502 static void f_confirm __ARGS((typval_T *argvars, typval_T *rettv));
503 static void f_copy __ARGS((typval_T *argvars, typval_T *rettv));
504 #ifdef FEAT_FLOAT
505 static void f_cos __ARGS((typval_T *argvars, typval_T *rettv));
506 #endif
507 static void f_count __ARGS((typval_T *argvars, typval_T *rettv));
508 static void f_cscope_connection __ARGS((typval_T *argvars, typval_T *rettv));
509 static void f_cursor __ARGS((typval_T *argsvars, typval_T *rettv));
510 static void f_deepcopy __ARGS((typval_T *argvars, typval_T *rettv));
511 static void f_delete __ARGS((typval_T *argvars, typval_T *rettv));
512 static void f_did_filetype __ARGS((typval_T *argvars, typval_T *rettv));
513 static void f_diff_filler __ARGS((typval_T *argvars, typval_T *rettv));
514 static void f_diff_hlID __ARGS((typval_T *argvars, typval_T *rettv));
515 static void f_empty __ARGS((typval_T *argvars, typval_T *rettv));
516 static void f_escape __ARGS((typval_T *argvars, typval_T *rettv));
517 static void f_eval __ARGS((typval_T *argvars, typval_T *rettv));
518 static void f_eventhandler __ARGS((typval_T *argvars, typval_T *rettv));
519 static void f_executable __ARGS((typval_T *argvars, typval_T *rettv));
520 static void f_exists __ARGS((typval_T *argvars, typval_T *rettv));
521 static void f_expand __ARGS((typval_T *argvars, typval_T *rettv));
522 static void f_extend __ARGS((typval_T *argvars, typval_T *rettv));
523 static void f_feedkeys __ARGS((typval_T *argvars, typval_T *rettv));
524 static void f_filereadable __ARGS((typval_T *argvars, typval_T *rettv));
525 static void f_filewritable __ARGS((typval_T *argvars, typval_T *rettv));
526 static void f_filter __ARGS((typval_T *argvars, typval_T *rettv));
527 static void f_finddir __ARGS((typval_T *argvars, typval_T *rettv));
528 static void f_findfile __ARGS((typval_T *argvars, typval_T *rettv));
529 #ifdef FEAT_FLOAT
530 static void f_float2nr __ARGS((typval_T *argvars, typval_T *rettv));
531 static void f_floor __ARGS((typval_T *argvars, typval_T *rettv));
532 #endif
533 static void f_fnameescape __ARGS((typval_T *argvars, typval_T *rettv));
534 static void f_fnamemodify __ARGS((typval_T *argvars, typval_T *rettv));
535 static void f_foldclosed __ARGS((typval_T *argvars, typval_T *rettv));
536 static void f_foldclosedend __ARGS((typval_T *argvars, typval_T *rettv));
537 static void f_foldlevel __ARGS((typval_T *argvars, typval_T *rettv));
538 static void f_foldtext __ARGS((typval_T *argvars, typval_T *rettv));
539 static void f_foldtextresult __ARGS((typval_T *argvars, typval_T *rettv));
540 static void f_foreground __ARGS((typval_T *argvars, typval_T *rettv));
541 static void f_function __ARGS((typval_T *argvars, typval_T *rettv));
542 static void f_garbagecollect __ARGS((typval_T *argvars, typval_T *rettv));
543 static void f_get __ARGS((typval_T *argvars, typval_T *rettv));
544 static void f_getbufline __ARGS((typval_T *argvars, typval_T *rettv));
545 static void f_getbufvar __ARGS((typval_T *argvars, typval_T *rettv));
546 static void f_getchar __ARGS((typval_T *argvars, typval_T *rettv));
547 static void f_getcharmod __ARGS((typval_T *argvars, typval_T *rettv));
548 static void f_getcmdline __ARGS((typval_T *argvars, typval_T *rettv));
549 static void f_getcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
550 static void f_getcmdtype __ARGS((typval_T *argvars, typval_T *rettv));
551 static void f_getcwd __ARGS((typval_T *argvars, typval_T *rettv));
552 static void f_getfontname __ARGS((typval_T *argvars, typval_T *rettv));
553 static void f_getfperm __ARGS((typval_T *argvars, typval_T *rettv));
554 static void f_getfsize __ARGS((typval_T *argvars, typval_T *rettv));
555 static void f_getftime __ARGS((typval_T *argvars, typval_T *rettv));
556 static void f_getftype __ARGS((typval_T *argvars, typval_T *rettv));
557 static void f_getline __ARGS((typval_T *argvars, typval_T *rettv));
558 static void f_getmatches __ARGS((typval_T *argvars, typval_T *rettv));
559 static void f_getpid __ARGS((typval_T *argvars, typval_T *rettv));
560 static void f_getpos __ARGS((typval_T *argvars, typval_T *rettv));
561 static void f_getqflist __ARGS((typval_T *argvars, typval_T *rettv));
562 static void f_getreg __ARGS((typval_T *argvars, typval_T *rettv));
563 static void f_getregtype __ARGS((typval_T *argvars, typval_T *rettv));
564 static void f_gettabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
565 static void f_getwinposx __ARGS((typval_T *argvars, typval_T *rettv));
566 static void f_getwinposy __ARGS((typval_T *argvars, typval_T *rettv));
567 static void f_getwinvar __ARGS((typval_T *argvars, typval_T *rettv));
568 static void f_glob __ARGS((typval_T *argvars, typval_T *rettv));
569 static void f_globpath __ARGS((typval_T *argvars, typval_T *rettv));
570 static void f_has __ARGS((typval_T *argvars, typval_T *rettv));
571 static void f_has_key __ARGS((typval_T *argvars, typval_T *rettv));
572 static void f_haslocaldir __ARGS((typval_T *argvars, typval_T *rettv));
573 static void f_hasmapto __ARGS((typval_T *argvars, typval_T *rettv));
574 static void f_histadd __ARGS((typval_T *argvars, typval_T *rettv));
575 static void f_histdel __ARGS((typval_T *argvars, typval_T *rettv));
576 static void f_histget __ARGS((typval_T *argvars, typval_T *rettv));
577 static void f_histnr __ARGS((typval_T *argvars, typval_T *rettv));
578 static void f_hlID __ARGS((typval_T *argvars, typval_T *rettv));
579 static void f_hlexists __ARGS((typval_T *argvars, typval_T *rettv));
580 static void f_hostname __ARGS((typval_T *argvars, typval_T *rettv));
581 static void f_iconv __ARGS((typval_T *argvars, typval_T *rettv));
582 static void f_indent __ARGS((typval_T *argvars, typval_T *rettv));
583 static void f_index __ARGS((typval_T *argvars, typval_T *rettv));
584 static void f_input __ARGS((typval_T *argvars, typval_T *rettv));
585 static void f_inputdialog __ARGS((typval_T *argvars, typval_T *rettv));
586 static void f_inputlist __ARGS((typval_T *argvars, typval_T *rettv));
587 static void f_inputrestore __ARGS((typval_T *argvars, typval_T *rettv));
588 static void f_inputsave __ARGS((typval_T *argvars, typval_T *rettv));
589 static void f_inputsecret __ARGS((typval_T *argvars, typval_T *rettv));
590 static void f_insert __ARGS((typval_T *argvars, typval_T *rettv));
591 static void f_isdirectory __ARGS((typval_T *argvars, typval_T *rettv));
592 static void f_islocked __ARGS((typval_T *argvars, typval_T *rettv));
593 static void f_items __ARGS((typval_T *argvars, typval_T *rettv));
594 static void f_join __ARGS((typval_T *argvars, typval_T *rettv));
595 static void f_keys __ARGS((typval_T *argvars, typval_T *rettv));
596 static void f_last_buffer_nr __ARGS((typval_T *argvars, typval_T *rettv));
597 static void f_len __ARGS((typval_T *argvars, typval_T *rettv));
598 static void f_libcall __ARGS((typval_T *argvars, typval_T *rettv));
599 static void f_libcallnr __ARGS((typval_T *argvars, typval_T *rettv));
600 static void f_line __ARGS((typval_T *argvars, typval_T *rettv));
601 static void f_line2byte __ARGS((typval_T *argvars, typval_T *rettv));
602 static void f_lispindent __ARGS((typval_T *argvars, typval_T *rettv));
603 static void f_localtime __ARGS((typval_T *argvars, typval_T *rettv));
604 #ifdef FEAT_FLOAT
605 static void f_log10 __ARGS((typval_T *argvars, typval_T *rettv));
606 #endif
607 static void f_map __ARGS((typval_T *argvars, typval_T *rettv));
608 static void f_maparg __ARGS((typval_T *argvars, typval_T *rettv));
609 static void f_mapcheck __ARGS((typval_T *argvars, typval_T *rettv));
610 static void f_match __ARGS((typval_T *argvars, typval_T *rettv));
611 static void f_matchadd __ARGS((typval_T *argvars, typval_T *rettv));
612 static void f_matcharg __ARGS((typval_T *argvars, typval_T *rettv));
613 static void f_matchdelete __ARGS((typval_T *argvars, typval_T *rettv));
614 static void f_matchend __ARGS((typval_T *argvars, typval_T *rettv));
615 static void f_matchlist __ARGS((typval_T *argvars, typval_T *rettv));
616 static void f_matchstr __ARGS((typval_T *argvars, typval_T *rettv));
617 static void f_max __ARGS((typval_T *argvars, typval_T *rettv));
618 static void f_min __ARGS((typval_T *argvars, typval_T *rettv));
619 #ifdef vim_mkdir
620 static void f_mkdir __ARGS((typval_T *argvars, typval_T *rettv));
621 #endif
622 static void f_mode __ARGS((typval_T *argvars, typval_T *rettv));
623 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
624 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
625 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
626 #ifdef FEAT_FLOAT
627 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
628 #endif
629 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
630 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
631 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
632 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
633 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
634 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
635 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
636 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
637 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
642 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
643 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
644 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
645 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
646 #ifdef FEAT_FLOAT
647 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
648 #endif
649 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
650 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
651 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
652 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
653 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
654 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
655 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
656 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
657 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
668 #ifdef FEAT_FLOAT
669 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
670 #endif
671 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
672 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
673 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
674 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
675 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
676 #ifdef FEAT_FLOAT
677 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
678 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
679 #endif
680 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
681 #ifdef HAVE_STRFTIME
682 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
683 #endif
684 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
685 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
686 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
687 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
688 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
689 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
690 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
691 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
692 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
693 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
699 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
700 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
707 #ifdef FEAT_FLOAT
708 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
709 #endif
710 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
711 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
712 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
713 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
714 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
715 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
716 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
717 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
718 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
725 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
726 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
727 static int get_env_len __ARGS((char_u **arg));
728 static int get_id_len __ARGS((char_u **arg));
729 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
730 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
731 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
732 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
733 valid character */
734 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
735 static int eval_isnamec __ARGS((int c));
736 static int eval_isnamec1 __ARGS((int c));
737 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
738 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
739 static typval_T *alloc_tv __ARGS((void));
740 static typval_T *alloc_string_tv __ARGS((char_u *string));
741 static void init_tv __ARGS((typval_T *varp));
742 static long get_tv_number __ARGS((typval_T *varp));
743 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
744 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
745 static char_u *get_tv_string __ARGS((typval_T *varp));
746 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
747 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
748 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
749 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
750 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
751 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
752 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
753 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
754 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
755 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
756 static int var_check_ro __ARGS((int flags, char_u *name));
757 static int var_check_fixed __ARGS((int flags, char_u *name));
758 static int tv_check_lock __ARGS((int lock, char_u *name));
759 static void copy_tv __ARGS((typval_T *from, typval_T *to));
760 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
761 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
762 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
763 static int eval_fname_script __ARGS((char_u *p));
764 static int eval_fname_sid __ARGS((char_u *p));
765 static void list_func_head __ARGS((ufunc_T *fp, int indent));
766 static ufunc_T *find_func __ARGS((char_u *name));
767 static int function_exists __ARGS((char_u *name));
768 static int builtin_function __ARGS((char_u *name));
769 #ifdef FEAT_PROFILE
770 static void func_do_profile __ARGS((ufunc_T *fp));
771 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
772 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
773 static int
774 # ifdef __BORLANDC__
775 _RTLENTRYF
776 # endif
777 prof_total_cmp __ARGS((const void *s1, const void *s2));
778 static int
779 # ifdef __BORLANDC__
780 _RTLENTRYF
781 # endif
782 prof_self_cmp __ARGS((const void *s1, const void *s2));
783 #endif
784 static int script_autoload __ARGS((char_u *name, int reload));
785 static char_u *autoload_name __ARGS((char_u *name));
786 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
787 static void func_free __ARGS((ufunc_T *fp));
788 static void func_unref __ARGS((char_u *name));
789 static void func_ref __ARGS((char_u *name));
790 static void call_user_func __ARGS((ufunc_T *fp, int argcount, typval_T *argvars, typval_T *rettv, linenr_T firstline, linenr_T lastline, dict_T *selfdict));
791 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
792 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
793 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
794 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
795 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
796 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
798 /* Character used as separated in autoload function/variable names. */
799 #define AUTOLOAD_CHAR '#'
802 * Initialize the global and v: variables.
804 void
805 eval_init()
807 int i;
808 struct vimvar *p;
810 init_var_dict(&globvardict, &globvars_var);
811 init_var_dict(&vimvardict, &vimvars_var);
812 hash_init(&compat_hashtab);
813 hash_init(&func_hashtab);
815 for (i = 0; i < VV_LEN; ++i)
817 p = &vimvars[i];
818 STRCPY(p->vv_di.di_key, p->vv_name);
819 if (p->vv_flags & VV_RO)
820 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
821 else if (p->vv_flags & VV_RO_SBX)
822 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
823 else
824 p->vv_di.di_flags = DI_FLAGS_FIX;
826 /* add to v: scope dict, unless the value is not always available */
827 if (p->vv_type != VAR_UNKNOWN)
828 hash_add(&vimvarht, p->vv_di.di_key);
829 if (p->vv_flags & VV_COMPAT)
830 /* add to compat scope dict */
831 hash_add(&compat_hashtab, p->vv_di.di_key);
833 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
836 #if defined(EXITFREE) || defined(PROTO)
837 void
838 eval_clear()
840 int i;
841 struct vimvar *p;
843 for (i = 0; i < VV_LEN; ++i)
845 p = &vimvars[i];
846 if (p->vv_di.di_tv.v_type == VAR_STRING)
848 vim_free(p->vv_di.di_tv.vval.v_string);
849 p->vv_di.di_tv.vval.v_string = NULL;
852 hash_clear(&vimvarht);
853 hash_clear(&compat_hashtab);
855 /* script-local variables */
856 for (i = 1; i <= ga_scripts.ga_len; ++i)
857 vars_clear(&SCRIPT_VARS(i));
858 ga_clear(&ga_scripts);
859 free_scriptnames();
861 /* global variables */
862 vars_clear(&globvarht);
864 /* autoloaded script names */
865 ga_clear_strings(&ga_loaded);
867 /* unreferenced lists and dicts */
868 (void)garbage_collect();
870 /* functions */
871 free_all_functions();
872 hash_clear(&func_hashtab);
874 #endif
877 * Return the name of the executed function.
879 char_u *
880 func_name(cookie)
881 void *cookie;
883 return ((funccall_T *)cookie)->func->uf_name;
887 * Return the address holding the next breakpoint line for a funccall cookie.
889 linenr_T *
890 func_breakpoint(cookie)
891 void *cookie;
893 return &((funccall_T *)cookie)->breakpoint;
897 * Return the address holding the debug tick for a funccall cookie.
899 int *
900 func_dbg_tick(cookie)
901 void *cookie;
903 return &((funccall_T *)cookie)->dbg_tick;
907 * Return the nesting level for a funccall cookie.
910 func_level(cookie)
911 void *cookie;
913 return ((funccall_T *)cookie)->level;
916 /* pointer to funccal for currently active function */
917 funccall_T *current_funccal = NULL;
920 * Return TRUE when a function was ended by a ":return" command.
923 current_func_returned()
925 return current_funccal->returned;
930 * Set an internal variable to a string value. Creates the variable if it does
931 * not already exist.
933 void
934 set_internal_string_var(name, value)
935 char_u *name;
936 char_u *value;
938 char_u *val;
939 typval_T *tvp;
941 val = vim_strsave(value);
942 if (val != NULL)
944 tvp = alloc_string_tv(val);
945 if (tvp != NULL)
947 set_var(name, tvp, FALSE);
948 free_tv(tvp);
953 static lval_T *redir_lval = NULL;
954 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
955 static char_u *redir_endp = NULL;
956 static char_u *redir_varname = NULL;
959 * Start recording command output to a variable
960 * Returns OK if successfully completed the setup. FAIL otherwise.
963 var_redir_start(name, append)
964 char_u *name;
965 int append; /* append to an existing variable */
967 int save_emsg;
968 int err;
969 typval_T tv;
971 /* Make sure a valid variable name is specified */
972 if (!eval_isnamec1(*name))
974 EMSG(_(e_invarg));
975 return FAIL;
978 redir_varname = vim_strsave(name);
979 if (redir_varname == NULL)
980 return FAIL;
982 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
983 if (redir_lval == NULL)
985 var_redir_stop();
986 return FAIL;
989 /* The output is stored in growarray "redir_ga" until redirection ends. */
990 ga_init2(&redir_ga, (int)sizeof(char), 500);
992 /* Parse the variable name (can be a dict or list entry). */
993 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
994 FNE_CHECK_START);
995 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
997 if (redir_endp != NULL && *redir_endp != NUL)
998 /* Trailing characters are present after the variable name */
999 EMSG(_(e_trailing));
1000 else
1001 EMSG(_(e_invarg));
1002 var_redir_stop();
1003 return FAIL;
1006 /* check if we can write to the variable: set it to or append an empty
1007 * string */
1008 save_emsg = did_emsg;
1009 did_emsg = FALSE;
1010 tv.v_type = VAR_STRING;
1011 tv.vval.v_string = (char_u *)"";
1012 if (append)
1013 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1014 else
1015 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1016 err = did_emsg;
1017 did_emsg |= save_emsg;
1018 if (err)
1020 var_redir_stop();
1021 return FAIL;
1023 if (redir_lval->ll_newkey != NULL)
1025 /* Dictionary item was created, don't do it again. */
1026 vim_free(redir_lval->ll_newkey);
1027 redir_lval->ll_newkey = NULL;
1030 return OK;
1034 * Append "value[value_len]" to the variable set by var_redir_start().
1035 * The actual appending is postponed until redirection ends, because the value
1036 * appended may in fact be the string we write to, changing it may cause freed
1037 * memory to be used:
1038 * :redir => foo
1039 * :let foo
1040 * :redir END
1042 void
1043 var_redir_str(value, value_len)
1044 char_u *value;
1045 int value_len;
1047 int len;
1049 if (redir_lval == NULL)
1050 return;
1052 if (value_len == -1)
1053 len = (int)STRLEN(value); /* Append the entire string */
1054 else
1055 len = value_len; /* Append only "value_len" characters */
1057 if (ga_grow(&redir_ga, len) == OK)
1059 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1060 redir_ga.ga_len += len;
1062 else
1063 var_redir_stop();
1067 * Stop redirecting command output to a variable.
1069 void
1070 var_redir_stop()
1072 typval_T tv;
1074 if (redir_lval != NULL)
1076 /* Append the trailing NUL. */
1077 ga_append(&redir_ga, NUL);
1079 /* Assign the text to the variable. */
1080 tv.v_type = VAR_STRING;
1081 tv.vval.v_string = redir_ga.ga_data;
1082 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1083 vim_free(tv.vval.v_string);
1085 clear_lval(redir_lval);
1086 vim_free(redir_lval);
1087 redir_lval = NULL;
1089 vim_free(redir_varname);
1090 redir_varname = NULL;
1093 # if defined(FEAT_MBYTE) || defined(PROTO)
1095 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1096 char_u *enc_from;
1097 char_u *enc_to;
1098 char_u *fname_from;
1099 char_u *fname_to;
1101 int err = FALSE;
1103 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1104 set_vim_var_string(VV_CC_TO, enc_to, -1);
1105 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1106 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1107 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1108 err = TRUE;
1109 set_vim_var_string(VV_CC_FROM, NULL, -1);
1110 set_vim_var_string(VV_CC_TO, NULL, -1);
1111 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1112 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1114 if (err)
1115 return FAIL;
1116 return OK;
1118 # endif
1120 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1122 eval_printexpr(fname, args)
1123 char_u *fname;
1124 char_u *args;
1126 int err = FALSE;
1128 set_vim_var_string(VV_FNAME_IN, fname, -1);
1129 set_vim_var_string(VV_CMDARG, args, -1);
1130 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1131 err = TRUE;
1132 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1133 set_vim_var_string(VV_CMDARG, NULL, -1);
1135 if (err)
1137 mch_remove(fname);
1138 return FAIL;
1140 return OK;
1142 # endif
1144 # if defined(FEAT_DIFF) || defined(PROTO)
1145 void
1146 eval_diff(origfile, newfile, outfile)
1147 char_u *origfile;
1148 char_u *newfile;
1149 char_u *outfile;
1151 int err = FALSE;
1153 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1154 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1155 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1156 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1157 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1158 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1159 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1162 void
1163 eval_patch(origfile, difffile, outfile)
1164 char_u *origfile;
1165 char_u *difffile;
1166 char_u *outfile;
1168 int err;
1170 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1171 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1172 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1173 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1174 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1175 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1176 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1178 # endif
1181 * Top level evaluation function, returning a boolean.
1182 * Sets "error" to TRUE if there was an error.
1183 * Return TRUE or FALSE.
1186 eval_to_bool(arg, error, nextcmd, skip)
1187 char_u *arg;
1188 int *error;
1189 char_u **nextcmd;
1190 int skip; /* only parse, don't execute */
1192 typval_T tv;
1193 int retval = FALSE;
1195 if (skip)
1196 ++emsg_skip;
1197 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1198 *error = TRUE;
1199 else
1201 *error = FALSE;
1202 if (!skip)
1204 retval = (get_tv_number_chk(&tv, error) != 0);
1205 clear_tv(&tv);
1208 if (skip)
1209 --emsg_skip;
1211 return retval;
1215 * Top level evaluation function, returning a string. If "skip" is TRUE,
1216 * only parsing to "nextcmd" is done, without reporting errors. Return
1217 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1219 char_u *
1220 eval_to_string_skip(arg, nextcmd, skip)
1221 char_u *arg;
1222 char_u **nextcmd;
1223 int skip; /* only parse, don't execute */
1225 typval_T tv;
1226 char_u *retval;
1228 if (skip)
1229 ++emsg_skip;
1230 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1231 retval = NULL;
1232 else
1234 retval = vim_strsave(get_tv_string(&tv));
1235 clear_tv(&tv);
1237 if (skip)
1238 --emsg_skip;
1240 return retval;
1244 * Skip over an expression at "*pp".
1245 * Return FAIL for an error, OK otherwise.
1248 skip_expr(pp)
1249 char_u **pp;
1251 typval_T rettv;
1253 *pp = skipwhite(*pp);
1254 return eval1(pp, &rettv, FALSE);
1258 * Top level evaluation function, returning a string.
1259 * Return pointer to allocated memory, or NULL for failure.
1261 char_u *
1262 eval_to_string(arg, nextcmd, dolist)
1263 char_u *arg;
1264 char_u **nextcmd;
1265 int dolist; /* turn List into sequence of lines */
1267 typval_T tv;
1268 char_u *retval;
1269 garray_T ga;
1271 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1272 retval = NULL;
1273 else
1275 if (dolist && tv.v_type == VAR_LIST)
1277 ga_init2(&ga, (int)sizeof(char), 80);
1278 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) || defined(FEAT_GUI_MACVIM)
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 int fd;
9701 char_u *p;
9702 int n;
9704 #ifndef O_NONBLOCK
9705 # define O_NONBLOCK 0
9706 #endif
9707 p = get_tv_string(&argvars[0]);
9708 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9709 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9711 n = TRUE;
9712 close(fd);
9714 else
9715 n = FALSE;
9717 rettv->vval.v_number = n;
9721 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9722 * rights to write into.
9724 static void
9725 f_filewritable(argvars, rettv)
9726 typval_T *argvars;
9727 typval_T *rettv;
9729 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9732 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9734 static void
9735 findfilendir(argvars, rettv, find_what)
9736 typval_T *argvars;
9737 typval_T *rettv;
9738 int find_what;
9740 #ifdef FEAT_SEARCHPATH
9741 char_u *fname;
9742 char_u *fresult = NULL;
9743 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9744 char_u *p;
9745 char_u pathbuf[NUMBUFLEN];
9746 int count = 1;
9747 int first = TRUE;
9748 int error = FALSE;
9749 #endif
9751 rettv->vval.v_string = NULL;
9752 rettv->v_type = VAR_STRING;
9754 #ifdef FEAT_SEARCHPATH
9755 fname = get_tv_string(&argvars[0]);
9757 if (argvars[1].v_type != VAR_UNKNOWN)
9759 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9760 if (p == NULL)
9761 error = TRUE;
9762 else
9764 if (*p != NUL)
9765 path = p;
9767 if (argvars[2].v_type != VAR_UNKNOWN)
9768 count = get_tv_number_chk(&argvars[2], &error);
9772 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9773 error = TRUE;
9775 if (*fname != NUL && !error)
9779 if (rettv->v_type == VAR_STRING)
9780 vim_free(fresult);
9781 fresult = find_file_in_path_option(first ? fname : NULL,
9782 first ? (int)STRLEN(fname) : 0,
9783 0, first, path,
9784 find_what,
9785 curbuf->b_ffname,
9786 find_what == FINDFILE_DIR
9787 ? (char_u *)"" : curbuf->b_p_sua);
9788 first = FALSE;
9790 if (fresult != NULL && rettv->v_type == VAR_LIST)
9791 list_append_string(rettv->vval.v_list, fresult, -1);
9793 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9796 if (rettv->v_type == VAR_STRING)
9797 rettv->vval.v_string = fresult;
9798 #endif
9801 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9802 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9805 * Implementation of map() and filter().
9807 static void
9808 filter_map(argvars, rettv, map)
9809 typval_T *argvars;
9810 typval_T *rettv;
9811 int map;
9813 char_u buf[NUMBUFLEN];
9814 char_u *expr;
9815 listitem_T *li, *nli;
9816 list_T *l = NULL;
9817 dictitem_T *di;
9818 hashtab_T *ht;
9819 hashitem_T *hi;
9820 dict_T *d = NULL;
9821 typval_T save_val;
9822 typval_T save_key;
9823 int rem;
9824 int todo;
9825 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9826 int save_did_emsg;
9828 rettv->vval.v_number = 0;
9829 if (argvars[0].v_type == VAR_LIST)
9831 if ((l = argvars[0].vval.v_list) == NULL
9832 || (map && tv_check_lock(l->lv_lock, ermsg)))
9833 return;
9835 else if (argvars[0].v_type == VAR_DICT)
9837 if ((d = argvars[0].vval.v_dict) == NULL
9838 || (map && tv_check_lock(d->dv_lock, ermsg)))
9839 return;
9841 else
9843 EMSG2(_(e_listdictarg), ermsg);
9844 return;
9847 expr = get_tv_string_buf_chk(&argvars[1], buf);
9848 /* On type errors, the preceding call has already displayed an error
9849 * message. Avoid a misleading error message for an empty string that
9850 * was not passed as argument. */
9851 if (expr != NULL)
9853 prepare_vimvar(VV_VAL, &save_val);
9854 expr = skipwhite(expr);
9856 /* We reset "did_emsg" to be able to detect whether an error
9857 * occurred during evaluation of the expression. */
9858 save_did_emsg = did_emsg;
9859 did_emsg = FALSE;
9861 if (argvars[0].v_type == VAR_DICT)
9863 prepare_vimvar(VV_KEY, &save_key);
9864 vimvars[VV_KEY].vv_type = VAR_STRING;
9866 ht = &d->dv_hashtab;
9867 hash_lock(ht);
9868 todo = (int)ht->ht_used;
9869 for (hi = ht->ht_array; todo > 0; ++hi)
9871 if (!HASHITEM_EMPTY(hi))
9873 --todo;
9874 di = HI2DI(hi);
9875 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9876 break;
9877 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9878 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9879 || did_emsg)
9880 break;
9881 if (!map && rem)
9882 dictitem_remove(d, di);
9883 clear_tv(&vimvars[VV_KEY].vv_tv);
9886 hash_unlock(ht);
9888 restore_vimvar(VV_KEY, &save_key);
9890 else
9892 for (li = l->lv_first; li != NULL; li = nli)
9894 if (tv_check_lock(li->li_tv.v_lock, ermsg))
9895 break;
9896 nli = li->li_next;
9897 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
9898 || did_emsg)
9899 break;
9900 if (!map && rem)
9901 listitem_remove(l, li);
9905 restore_vimvar(VV_VAL, &save_val);
9907 did_emsg |= save_did_emsg;
9910 copy_tv(&argvars[0], rettv);
9913 static int
9914 filter_map_one(tv, expr, map, remp)
9915 typval_T *tv;
9916 char_u *expr;
9917 int map;
9918 int *remp;
9920 typval_T rettv;
9921 char_u *s;
9922 int retval = FAIL;
9924 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
9925 s = expr;
9926 if (eval1(&s, &rettv, TRUE) == FAIL)
9927 goto theend;
9928 if (*s != NUL) /* check for trailing chars after expr */
9930 EMSG2(_(e_invexpr2), s);
9931 goto theend;
9933 if (map)
9935 /* map(): replace the list item value */
9936 clear_tv(tv);
9937 rettv.v_lock = 0;
9938 *tv = rettv;
9940 else
9942 int error = FALSE;
9944 /* filter(): when expr is zero remove the item */
9945 *remp = (get_tv_number_chk(&rettv, &error) == 0);
9946 clear_tv(&rettv);
9947 /* On type error, nothing has been removed; return FAIL to stop the
9948 * loop. The error message was given by get_tv_number_chk(). */
9949 if (error)
9950 goto theend;
9952 retval = OK;
9953 theend:
9954 clear_tv(&vimvars[VV_VAL].vv_tv);
9955 return retval;
9959 * "filter()" function
9961 static void
9962 f_filter(argvars, rettv)
9963 typval_T *argvars;
9964 typval_T *rettv;
9966 filter_map(argvars, rettv, FALSE);
9970 * "finddir({fname}[, {path}[, {count}]])" function
9972 static void
9973 f_finddir(argvars, rettv)
9974 typval_T *argvars;
9975 typval_T *rettv;
9977 findfilendir(argvars, rettv, FINDFILE_DIR);
9981 * "findfile({fname}[, {path}[, {count}]])" function
9983 static void
9984 f_findfile(argvars, rettv)
9985 typval_T *argvars;
9986 typval_T *rettv;
9988 findfilendir(argvars, rettv, FINDFILE_FILE);
9991 #ifdef FEAT_FLOAT
9993 * "float2nr({float})" function
9995 static void
9996 f_float2nr(argvars, rettv)
9997 typval_T *argvars;
9998 typval_T *rettv;
10000 float_T f;
10002 if (get_float_arg(argvars, &f) == OK)
10004 if (f < -0x7fffffff)
10005 rettv->vval.v_number = -0x7fffffff;
10006 else if (f > 0x7fffffff)
10007 rettv->vval.v_number = 0x7fffffff;
10008 else
10009 rettv->vval.v_number = (varnumber_T)f;
10011 else
10012 rettv->vval.v_number = 0;
10016 * "floor({float})" function
10018 static void
10019 f_floor(argvars, rettv)
10020 typval_T *argvars;
10021 typval_T *rettv;
10023 float_T f;
10025 rettv->v_type = VAR_FLOAT;
10026 if (get_float_arg(argvars, &f) == OK)
10027 rettv->vval.v_float = floor(f);
10028 else
10029 rettv->vval.v_float = 0.0;
10031 #endif
10034 * "fnameescape({string})" function
10036 static void
10037 f_fnameescape(argvars, rettv)
10038 typval_T *argvars;
10039 typval_T *rettv;
10041 rettv->vval.v_string = vim_strsave_fnameescape(
10042 get_tv_string(&argvars[0]), FALSE);
10043 rettv->v_type = VAR_STRING;
10047 * "fnamemodify({fname}, {mods})" function
10049 static void
10050 f_fnamemodify(argvars, rettv)
10051 typval_T *argvars;
10052 typval_T *rettv;
10054 char_u *fname;
10055 char_u *mods;
10056 int usedlen = 0;
10057 int len;
10058 char_u *fbuf = NULL;
10059 char_u buf[NUMBUFLEN];
10061 fname = get_tv_string_chk(&argvars[0]);
10062 mods = get_tv_string_buf_chk(&argvars[1], buf);
10063 if (fname == NULL || mods == NULL)
10064 fname = NULL;
10065 else
10067 len = (int)STRLEN(fname);
10068 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10071 rettv->v_type = VAR_STRING;
10072 if (fname == NULL)
10073 rettv->vval.v_string = NULL;
10074 else
10075 rettv->vval.v_string = vim_strnsave(fname, len);
10076 vim_free(fbuf);
10079 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10082 * "foldclosed()" function
10084 static void
10085 foldclosed_both(argvars, rettv, end)
10086 typval_T *argvars;
10087 typval_T *rettv;
10088 int end;
10090 #ifdef FEAT_FOLDING
10091 linenr_T lnum;
10092 linenr_T first, last;
10094 lnum = get_tv_lnum(argvars);
10095 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10097 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10099 if (end)
10100 rettv->vval.v_number = (varnumber_T)last;
10101 else
10102 rettv->vval.v_number = (varnumber_T)first;
10103 return;
10106 #endif
10107 rettv->vval.v_number = -1;
10111 * "foldclosed()" function
10113 static void
10114 f_foldclosed(argvars, rettv)
10115 typval_T *argvars;
10116 typval_T *rettv;
10118 foldclosed_both(argvars, rettv, FALSE);
10122 * "foldclosedend()" function
10124 static void
10125 f_foldclosedend(argvars, rettv)
10126 typval_T *argvars;
10127 typval_T *rettv;
10129 foldclosed_both(argvars, rettv, TRUE);
10133 * "foldlevel()" function
10135 static void
10136 f_foldlevel(argvars, rettv)
10137 typval_T *argvars;
10138 typval_T *rettv;
10140 #ifdef FEAT_FOLDING
10141 linenr_T lnum;
10143 lnum = get_tv_lnum(argvars);
10144 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10145 rettv->vval.v_number = foldLevel(lnum);
10146 else
10147 #endif
10148 rettv->vval.v_number = 0;
10152 * "foldtext()" function
10154 /*ARGSUSED*/
10155 static void
10156 f_foldtext(argvars, rettv)
10157 typval_T *argvars;
10158 typval_T *rettv;
10160 #ifdef FEAT_FOLDING
10161 linenr_T lnum;
10162 char_u *s;
10163 char_u *r;
10164 int len;
10165 char *txt;
10166 #endif
10168 rettv->v_type = VAR_STRING;
10169 rettv->vval.v_string = NULL;
10170 #ifdef FEAT_FOLDING
10171 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10172 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10173 <= curbuf->b_ml.ml_line_count
10174 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10176 /* Find first non-empty line in the fold. */
10177 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10178 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10180 if (!linewhite(lnum))
10181 break;
10182 ++lnum;
10185 /* Find interesting text in this line. */
10186 s = skipwhite(ml_get(lnum));
10187 /* skip C comment-start */
10188 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10190 s = skipwhite(s + 2);
10191 if (*skipwhite(s) == NUL
10192 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10194 s = skipwhite(ml_get(lnum + 1));
10195 if (*s == '*')
10196 s = skipwhite(s + 1);
10199 txt = _("+-%s%3ld lines: ");
10200 r = alloc((unsigned)(STRLEN(txt)
10201 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10202 + 20 /* for %3ld */
10203 + STRLEN(s))); /* concatenated */
10204 if (r != NULL)
10206 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10207 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10208 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10209 len = (int)STRLEN(r);
10210 STRCAT(r, s);
10211 /* remove 'foldmarker' and 'commentstring' */
10212 foldtext_cleanup(r + len);
10213 rettv->vval.v_string = r;
10216 #endif
10220 * "foldtextresult(lnum)" function
10222 /*ARGSUSED*/
10223 static void
10224 f_foldtextresult(argvars, rettv)
10225 typval_T *argvars;
10226 typval_T *rettv;
10228 #ifdef FEAT_FOLDING
10229 linenr_T lnum;
10230 char_u *text;
10231 char_u buf[51];
10232 foldinfo_T foldinfo;
10233 int fold_count;
10234 #endif
10236 rettv->v_type = VAR_STRING;
10237 rettv->vval.v_string = NULL;
10238 #ifdef FEAT_FOLDING
10239 lnum = get_tv_lnum(argvars);
10240 /* treat illegal types and illegal string values for {lnum} the same */
10241 if (lnum < 0)
10242 lnum = 0;
10243 fold_count = foldedCount(curwin, lnum, &foldinfo);
10244 if (fold_count > 0)
10246 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10247 &foldinfo, buf);
10248 if (text == buf)
10249 text = vim_strsave(text);
10250 rettv->vval.v_string = text;
10252 #endif
10256 * "foreground()" function
10258 /*ARGSUSED*/
10259 static void
10260 f_foreground(argvars, rettv)
10261 typval_T *argvars;
10262 typval_T *rettv;
10264 rettv->vval.v_number = 0;
10265 #ifdef FEAT_GUI
10266 if (gui.in_use)
10267 gui_mch_set_foreground();
10268 #else
10269 # ifdef WIN32
10270 win32_set_foreground();
10271 # endif
10272 #endif
10276 * "function()" function
10278 /*ARGSUSED*/
10279 static void
10280 f_function(argvars, rettv)
10281 typval_T *argvars;
10282 typval_T *rettv;
10284 char_u *s;
10286 rettv->vval.v_number = 0;
10287 s = get_tv_string(&argvars[0]);
10288 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10289 EMSG2(_(e_invarg2), s);
10290 else if (!function_exists(s))
10291 EMSG2(_("E700: Unknown function: %s"), s);
10292 else
10294 rettv->vval.v_string = vim_strsave(s);
10295 rettv->v_type = VAR_FUNC;
10300 * "garbagecollect()" function
10302 /*ARGSUSED*/
10303 static void
10304 f_garbagecollect(argvars, rettv)
10305 typval_T *argvars;
10306 typval_T *rettv;
10308 /* This is postponed until we are back at the toplevel, because we may be
10309 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10310 want_garbage_collect = TRUE;
10312 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10313 garbage_collect_at_exit = TRUE;
10317 * "get()" function
10319 static void
10320 f_get(argvars, rettv)
10321 typval_T *argvars;
10322 typval_T *rettv;
10324 listitem_T *li;
10325 list_T *l;
10326 dictitem_T *di;
10327 dict_T *d;
10328 typval_T *tv = NULL;
10330 if (argvars[0].v_type == VAR_LIST)
10332 if ((l = argvars[0].vval.v_list) != NULL)
10334 int error = FALSE;
10336 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10337 if (!error && li != NULL)
10338 tv = &li->li_tv;
10341 else if (argvars[0].v_type == VAR_DICT)
10343 if ((d = argvars[0].vval.v_dict) != NULL)
10345 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10346 if (di != NULL)
10347 tv = &di->di_tv;
10350 else
10351 EMSG2(_(e_listdictarg), "get()");
10353 if (tv == NULL)
10355 if (argvars[2].v_type == VAR_UNKNOWN)
10356 rettv->vval.v_number = 0;
10357 else
10358 copy_tv(&argvars[2], rettv);
10360 else
10361 copy_tv(tv, rettv);
10364 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10367 * Get line or list of lines from buffer "buf" into "rettv".
10368 * Return a range (from start to end) of lines in rettv from the specified
10369 * buffer.
10370 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10372 static void
10373 get_buffer_lines(buf, start, end, retlist, rettv)
10374 buf_T *buf;
10375 linenr_T start;
10376 linenr_T end;
10377 int retlist;
10378 typval_T *rettv;
10380 char_u *p;
10382 if (retlist)
10384 if (rettv_list_alloc(rettv) == FAIL)
10385 return;
10387 else
10388 rettv->vval.v_number = 0;
10390 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10391 return;
10393 if (!retlist)
10395 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10396 p = ml_get_buf(buf, start, FALSE);
10397 else
10398 p = (char_u *)"";
10400 rettv->v_type = VAR_STRING;
10401 rettv->vval.v_string = vim_strsave(p);
10403 else
10405 if (end < start)
10406 return;
10408 if (start < 1)
10409 start = 1;
10410 if (end > buf->b_ml.ml_line_count)
10411 end = buf->b_ml.ml_line_count;
10412 while (start <= end)
10413 if (list_append_string(rettv->vval.v_list,
10414 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10415 break;
10420 * "getbufline()" function
10422 static void
10423 f_getbufline(argvars, rettv)
10424 typval_T *argvars;
10425 typval_T *rettv;
10427 linenr_T lnum;
10428 linenr_T end;
10429 buf_T *buf;
10431 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10432 ++emsg_off;
10433 buf = get_buf_tv(&argvars[0]);
10434 --emsg_off;
10436 lnum = get_tv_lnum_buf(&argvars[1], buf);
10437 if (argvars[2].v_type == VAR_UNKNOWN)
10438 end = lnum;
10439 else
10440 end = get_tv_lnum_buf(&argvars[2], buf);
10442 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10446 * "getbufvar()" function
10448 static void
10449 f_getbufvar(argvars, rettv)
10450 typval_T *argvars;
10451 typval_T *rettv;
10453 buf_T *buf;
10454 buf_T *save_curbuf;
10455 char_u *varname;
10456 dictitem_T *v;
10458 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10459 varname = get_tv_string_chk(&argvars[1]);
10460 ++emsg_off;
10461 buf = get_buf_tv(&argvars[0]);
10463 rettv->v_type = VAR_STRING;
10464 rettv->vval.v_string = NULL;
10466 if (buf != NULL && varname != NULL)
10468 /* set curbuf to be our buf, temporarily */
10469 save_curbuf = curbuf;
10470 curbuf = buf;
10472 if (*varname == '&') /* buffer-local-option */
10473 get_option_tv(&varname, rettv, TRUE);
10474 else
10476 if (*varname == NUL)
10477 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10478 * scope prefix before the NUL byte is required by
10479 * find_var_in_ht(). */
10480 varname = (char_u *)"b:" + 2;
10481 /* look up the variable */
10482 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10483 if (v != NULL)
10484 copy_tv(&v->di_tv, rettv);
10487 /* restore previous notion of curbuf */
10488 curbuf = save_curbuf;
10491 --emsg_off;
10495 * "getchar()" function
10497 static void
10498 f_getchar(argvars, rettv)
10499 typval_T *argvars;
10500 typval_T *rettv;
10502 varnumber_T n;
10503 int error = FALSE;
10505 /* Position the cursor. Needed after a message that ends in a space. */
10506 windgoto(msg_row, msg_col);
10508 ++no_mapping;
10509 ++allow_keys;
10510 for (;;)
10512 if (argvars[0].v_type == VAR_UNKNOWN)
10513 /* getchar(): blocking wait. */
10514 n = safe_vgetc();
10515 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10516 /* getchar(1): only check if char avail */
10517 n = vpeekc();
10518 else if (error || vpeekc() == NUL)
10519 /* illegal argument or getchar(0) and no char avail: return zero */
10520 n = 0;
10521 else
10522 /* getchar(0) and char avail: return char */
10523 n = safe_vgetc();
10524 if (n == K_IGNORE)
10525 continue;
10526 break;
10528 --no_mapping;
10529 --allow_keys;
10531 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10532 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10533 vimvars[VV_MOUSE_COL].vv_nr = 0;
10535 rettv->vval.v_number = n;
10536 if (IS_SPECIAL(n) || mod_mask != 0)
10538 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10539 int i = 0;
10541 /* Turn a special key into three bytes, plus modifier. */
10542 if (mod_mask != 0)
10544 temp[i++] = K_SPECIAL;
10545 temp[i++] = KS_MODIFIER;
10546 temp[i++] = mod_mask;
10548 if (IS_SPECIAL(n))
10550 temp[i++] = K_SPECIAL;
10551 temp[i++] = K_SECOND(n);
10552 temp[i++] = K_THIRD(n);
10554 #ifdef FEAT_MBYTE
10555 else if (has_mbyte)
10556 i += (*mb_char2bytes)(n, temp + i);
10557 #endif
10558 else
10559 temp[i++] = n;
10560 temp[i++] = NUL;
10561 rettv->v_type = VAR_STRING;
10562 rettv->vval.v_string = vim_strsave(temp);
10564 #ifdef FEAT_MOUSE
10565 if (n == K_LEFTMOUSE
10566 || n == K_LEFTMOUSE_NM
10567 || n == K_LEFTDRAG
10568 || n == K_LEFTRELEASE
10569 || n == K_LEFTRELEASE_NM
10570 || n == K_MIDDLEMOUSE
10571 || n == K_MIDDLEDRAG
10572 || n == K_MIDDLERELEASE
10573 || n == K_RIGHTMOUSE
10574 || n == K_RIGHTDRAG
10575 || n == K_RIGHTRELEASE
10576 || n == K_X1MOUSE
10577 || n == K_X1DRAG
10578 || n == K_X1RELEASE
10579 || n == K_X2MOUSE
10580 || n == K_X2DRAG
10581 || n == K_X2RELEASE
10582 || n == K_MOUSEDOWN
10583 || n == K_MOUSEUP)
10585 int row = mouse_row;
10586 int col = mouse_col;
10587 win_T *win;
10588 linenr_T lnum;
10589 # ifdef FEAT_WINDOWS
10590 win_T *wp;
10591 # endif
10592 int n = 1;
10594 if (row >= 0 && col >= 0)
10596 /* Find the window at the mouse coordinates and compute the
10597 * text position. */
10598 win = mouse_find_win(&row, &col);
10599 (void)mouse_comp_pos(win, &row, &col, &lnum);
10600 # ifdef FEAT_WINDOWS
10601 for (wp = firstwin; wp != win; wp = wp->w_next)
10602 ++n;
10603 # endif
10604 vimvars[VV_MOUSE_WIN].vv_nr = n;
10605 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10606 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10609 #endif
10614 * "getcharmod()" function
10616 /*ARGSUSED*/
10617 static void
10618 f_getcharmod(argvars, rettv)
10619 typval_T *argvars;
10620 typval_T *rettv;
10622 rettv->vval.v_number = mod_mask;
10626 * "getcmdline()" function
10628 /*ARGSUSED*/
10629 static void
10630 f_getcmdline(argvars, rettv)
10631 typval_T *argvars;
10632 typval_T *rettv;
10634 rettv->v_type = VAR_STRING;
10635 rettv->vval.v_string = get_cmdline_str();
10639 * "getcmdpos()" function
10641 /*ARGSUSED*/
10642 static void
10643 f_getcmdpos(argvars, rettv)
10644 typval_T *argvars;
10645 typval_T *rettv;
10647 rettv->vval.v_number = get_cmdline_pos() + 1;
10651 * "getcmdtype()" function
10653 /*ARGSUSED*/
10654 static void
10655 f_getcmdtype(argvars, rettv)
10656 typval_T *argvars;
10657 typval_T *rettv;
10659 rettv->v_type = VAR_STRING;
10660 rettv->vval.v_string = alloc(2);
10661 if (rettv->vval.v_string != NULL)
10663 rettv->vval.v_string[0] = get_cmdline_type();
10664 rettv->vval.v_string[1] = NUL;
10669 * "getcwd()" function
10671 /*ARGSUSED*/
10672 static void
10673 f_getcwd(argvars, rettv)
10674 typval_T *argvars;
10675 typval_T *rettv;
10677 char_u cwd[MAXPATHL];
10679 rettv->v_type = VAR_STRING;
10680 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10681 rettv->vval.v_string = NULL;
10682 else
10684 rettv->vval.v_string = vim_strsave(cwd);
10685 #ifdef BACKSLASH_IN_FILENAME
10686 if (rettv->vval.v_string != NULL)
10687 slash_adjust(rettv->vval.v_string);
10688 #endif
10693 * "getfontname()" function
10695 /*ARGSUSED*/
10696 static void
10697 f_getfontname(argvars, rettv)
10698 typval_T *argvars;
10699 typval_T *rettv;
10701 rettv->v_type = VAR_STRING;
10702 rettv->vval.v_string = NULL;
10703 #ifdef FEAT_GUI
10704 if (gui.in_use)
10706 GuiFont font;
10707 char_u *name = NULL;
10709 if (argvars[0].v_type == VAR_UNKNOWN)
10711 /* Get the "Normal" font. Either the name saved by
10712 * hl_set_font_name() or from the font ID. */
10713 font = gui.norm_font;
10714 name = hl_get_font_name();
10716 else
10718 name = get_tv_string(&argvars[0]);
10719 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10720 return;
10721 font = gui_mch_get_font(name, FALSE);
10722 if (font == NOFONT)
10723 return; /* Invalid font name, return empty string. */
10725 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10726 if (argvars[0].v_type != VAR_UNKNOWN)
10727 gui_mch_free_font(font);
10729 #endif
10733 * "getfperm({fname})" function
10735 static void
10736 f_getfperm(argvars, rettv)
10737 typval_T *argvars;
10738 typval_T *rettv;
10740 char_u *fname;
10741 struct stat st;
10742 char_u *perm = NULL;
10743 char_u flags[] = "rwx";
10744 int i;
10746 fname = get_tv_string(&argvars[0]);
10748 rettv->v_type = VAR_STRING;
10749 if (mch_stat((char *)fname, &st) >= 0)
10751 perm = vim_strsave((char_u *)"---------");
10752 if (perm != NULL)
10754 for (i = 0; i < 9; i++)
10756 if (st.st_mode & (1 << (8 - i)))
10757 perm[i] = flags[i % 3];
10761 rettv->vval.v_string = perm;
10765 * "getfsize({fname})" function
10767 static void
10768 f_getfsize(argvars, rettv)
10769 typval_T *argvars;
10770 typval_T *rettv;
10772 char_u *fname;
10773 struct stat st;
10775 fname = get_tv_string(&argvars[0]);
10777 rettv->v_type = VAR_NUMBER;
10779 if (mch_stat((char *)fname, &st) >= 0)
10781 if (mch_isdir(fname))
10782 rettv->vval.v_number = 0;
10783 else
10785 rettv->vval.v_number = (varnumber_T)st.st_size;
10787 /* non-perfect check for overflow */
10788 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10789 rettv->vval.v_number = -2;
10792 else
10793 rettv->vval.v_number = -1;
10797 * "getftime({fname})" function
10799 static void
10800 f_getftime(argvars, rettv)
10801 typval_T *argvars;
10802 typval_T *rettv;
10804 char_u *fname;
10805 struct stat st;
10807 fname = get_tv_string(&argvars[0]);
10809 if (mch_stat((char *)fname, &st) >= 0)
10810 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10811 else
10812 rettv->vval.v_number = -1;
10816 * "getftype({fname})" function
10818 static void
10819 f_getftype(argvars, rettv)
10820 typval_T *argvars;
10821 typval_T *rettv;
10823 char_u *fname;
10824 struct stat st;
10825 char_u *type = NULL;
10826 char *t;
10828 fname = get_tv_string(&argvars[0]);
10830 rettv->v_type = VAR_STRING;
10831 if (mch_lstat((char *)fname, &st) >= 0)
10833 #ifdef S_ISREG
10834 if (S_ISREG(st.st_mode))
10835 t = "file";
10836 else if (S_ISDIR(st.st_mode))
10837 t = "dir";
10838 # ifdef S_ISLNK
10839 else if (S_ISLNK(st.st_mode))
10840 t = "link";
10841 # endif
10842 # ifdef S_ISBLK
10843 else if (S_ISBLK(st.st_mode))
10844 t = "bdev";
10845 # endif
10846 # ifdef S_ISCHR
10847 else if (S_ISCHR(st.st_mode))
10848 t = "cdev";
10849 # endif
10850 # ifdef S_ISFIFO
10851 else if (S_ISFIFO(st.st_mode))
10852 t = "fifo";
10853 # endif
10854 # ifdef S_ISSOCK
10855 else if (S_ISSOCK(st.st_mode))
10856 t = "fifo";
10857 # endif
10858 else
10859 t = "other";
10860 #else
10861 # ifdef S_IFMT
10862 switch (st.st_mode & S_IFMT)
10864 case S_IFREG: t = "file"; break;
10865 case S_IFDIR: t = "dir"; break;
10866 # ifdef S_IFLNK
10867 case S_IFLNK: t = "link"; break;
10868 # endif
10869 # ifdef S_IFBLK
10870 case S_IFBLK: t = "bdev"; break;
10871 # endif
10872 # ifdef S_IFCHR
10873 case S_IFCHR: t = "cdev"; break;
10874 # endif
10875 # ifdef S_IFIFO
10876 case S_IFIFO: t = "fifo"; break;
10877 # endif
10878 # ifdef S_IFSOCK
10879 case S_IFSOCK: t = "socket"; break;
10880 # endif
10881 default: t = "other";
10883 # else
10884 if (mch_isdir(fname))
10885 t = "dir";
10886 else
10887 t = "file";
10888 # endif
10889 #endif
10890 type = vim_strsave((char_u *)t);
10892 rettv->vval.v_string = type;
10896 * "getline(lnum, [end])" function
10898 static void
10899 f_getline(argvars, rettv)
10900 typval_T *argvars;
10901 typval_T *rettv;
10903 linenr_T lnum;
10904 linenr_T end;
10905 int retlist;
10907 lnum = get_tv_lnum(argvars);
10908 if (argvars[1].v_type == VAR_UNKNOWN)
10910 end = 0;
10911 retlist = FALSE;
10913 else
10915 end = get_tv_lnum(&argvars[1]);
10916 retlist = TRUE;
10919 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
10923 * "getmatches()" function
10925 /*ARGSUSED*/
10926 static void
10927 f_getmatches(argvars, rettv)
10928 typval_T *argvars;
10929 typval_T *rettv;
10931 #ifdef FEAT_SEARCH_EXTRA
10932 dict_T *dict;
10933 matchitem_T *cur = curwin->w_match_head;
10935 rettv->vval.v_number = 0;
10937 if (rettv_list_alloc(rettv) == OK)
10939 while (cur != NULL)
10941 dict = dict_alloc();
10942 if (dict == NULL)
10943 return;
10944 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
10945 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
10946 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
10947 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
10948 list_append_dict(rettv->vval.v_list, dict);
10949 cur = cur->next;
10952 #endif
10956 * "getpid()" function
10958 /*ARGSUSED*/
10959 static void
10960 f_getpid(argvars, rettv)
10961 typval_T *argvars;
10962 typval_T *rettv;
10964 rettv->vval.v_number = mch_get_pid();
10968 * "getpos(string)" function
10970 static void
10971 f_getpos(argvars, rettv)
10972 typval_T *argvars;
10973 typval_T *rettv;
10975 pos_T *fp;
10976 list_T *l;
10977 int fnum = -1;
10979 if (rettv_list_alloc(rettv) == OK)
10981 l = rettv->vval.v_list;
10982 fp = var2fpos(&argvars[0], TRUE, &fnum);
10983 if (fnum != -1)
10984 list_append_number(l, (varnumber_T)fnum);
10985 else
10986 list_append_number(l, (varnumber_T)0);
10987 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
10988 : (varnumber_T)0);
10989 list_append_number(l, (fp != NULL)
10990 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
10991 : (varnumber_T)0);
10992 list_append_number(l,
10993 #ifdef FEAT_VIRTUALEDIT
10994 (fp != NULL) ? (varnumber_T)fp->coladd :
10995 #endif
10996 (varnumber_T)0);
10998 else
10999 rettv->vval.v_number = FALSE;
11003 * "getqflist()" and "getloclist()" functions
11005 /*ARGSUSED*/
11006 static void
11007 f_getqflist(argvars, rettv)
11008 typval_T *argvars;
11009 typval_T *rettv;
11011 #ifdef FEAT_QUICKFIX
11012 win_T *wp;
11013 #endif
11015 rettv->vval.v_number = 0;
11016 #ifdef FEAT_QUICKFIX
11017 if (rettv_list_alloc(rettv) == OK)
11019 wp = NULL;
11020 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11022 wp = find_win_by_nr(&argvars[0], NULL);
11023 if (wp == NULL)
11024 return;
11027 (void)get_errorlist(wp, rettv->vval.v_list);
11029 #endif
11033 * "getreg()" function
11035 static void
11036 f_getreg(argvars, rettv)
11037 typval_T *argvars;
11038 typval_T *rettv;
11040 char_u *strregname;
11041 int regname;
11042 int arg2 = FALSE;
11043 int error = FALSE;
11045 if (argvars[0].v_type != VAR_UNKNOWN)
11047 strregname = get_tv_string_chk(&argvars[0]);
11048 error = strregname == NULL;
11049 if (argvars[1].v_type != VAR_UNKNOWN)
11050 arg2 = get_tv_number_chk(&argvars[1], &error);
11052 else
11053 strregname = vimvars[VV_REG].vv_str;
11054 regname = (strregname == NULL ? '"' : *strregname);
11055 if (regname == 0)
11056 regname = '"';
11058 rettv->v_type = VAR_STRING;
11059 rettv->vval.v_string = error ? NULL :
11060 get_reg_contents(regname, TRUE, arg2);
11064 * "getregtype()" function
11066 static void
11067 f_getregtype(argvars, rettv)
11068 typval_T *argvars;
11069 typval_T *rettv;
11071 char_u *strregname;
11072 int regname;
11073 char_u buf[NUMBUFLEN + 2];
11074 long reglen = 0;
11076 if (argvars[0].v_type != VAR_UNKNOWN)
11078 strregname = get_tv_string_chk(&argvars[0]);
11079 if (strregname == NULL) /* type error; errmsg already given */
11081 rettv->v_type = VAR_STRING;
11082 rettv->vval.v_string = NULL;
11083 return;
11086 else
11087 /* Default to v:register */
11088 strregname = vimvars[VV_REG].vv_str;
11090 regname = (strregname == NULL ? '"' : *strregname);
11091 if (regname == 0)
11092 regname = '"';
11094 buf[0] = NUL;
11095 buf[1] = NUL;
11096 switch (get_reg_type(regname, &reglen))
11098 case MLINE: buf[0] = 'V'; break;
11099 case MCHAR: buf[0] = 'v'; break;
11100 #ifdef FEAT_VISUAL
11101 case MBLOCK:
11102 buf[0] = Ctrl_V;
11103 sprintf((char *)buf + 1, "%ld", reglen + 1);
11104 break;
11105 #endif
11107 rettv->v_type = VAR_STRING;
11108 rettv->vval.v_string = vim_strsave(buf);
11112 * "gettabwinvar()" function
11114 static void
11115 f_gettabwinvar(argvars, rettv)
11116 typval_T *argvars;
11117 typval_T *rettv;
11119 getwinvar(argvars, rettv, 1);
11123 * "getwinposx()" function
11125 /*ARGSUSED*/
11126 static void
11127 f_getwinposx(argvars, rettv)
11128 typval_T *argvars;
11129 typval_T *rettv;
11131 rettv->vval.v_number = -1;
11132 #ifdef FEAT_GUI
11133 if (gui.in_use)
11135 int x, y;
11137 if (gui_mch_get_winpos(&x, &y) == OK)
11138 rettv->vval.v_number = x;
11140 #endif
11144 * "getwinposy()" function
11146 /*ARGSUSED*/
11147 static void
11148 f_getwinposy(argvars, rettv)
11149 typval_T *argvars;
11150 typval_T *rettv;
11152 rettv->vval.v_number = -1;
11153 #ifdef FEAT_GUI
11154 if (gui.in_use)
11156 int x, y;
11158 if (gui_mch_get_winpos(&x, &y) == OK)
11159 rettv->vval.v_number = y;
11161 #endif
11165 * Find window specified by "vp" in tabpage "tp".
11167 static win_T *
11168 find_win_by_nr(vp, tp)
11169 typval_T *vp;
11170 tabpage_T *tp; /* NULL for current tab page */
11172 #ifdef FEAT_WINDOWS
11173 win_T *wp;
11174 #endif
11175 int nr;
11177 nr = get_tv_number_chk(vp, NULL);
11179 #ifdef FEAT_WINDOWS
11180 if (nr < 0)
11181 return NULL;
11182 if (nr == 0)
11183 return curwin;
11185 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11186 wp != NULL; wp = wp->w_next)
11187 if (--nr <= 0)
11188 break;
11189 return wp;
11190 #else
11191 if (nr == 0 || nr == 1)
11192 return curwin;
11193 return NULL;
11194 #endif
11198 * "getwinvar()" function
11200 static void
11201 f_getwinvar(argvars, rettv)
11202 typval_T *argvars;
11203 typval_T *rettv;
11205 getwinvar(argvars, rettv, 0);
11209 * getwinvar() and gettabwinvar()
11211 static void
11212 getwinvar(argvars, rettv, off)
11213 typval_T *argvars;
11214 typval_T *rettv;
11215 int off; /* 1 for gettabwinvar() */
11217 win_T *win, *oldcurwin;
11218 char_u *varname;
11219 dictitem_T *v;
11220 tabpage_T *tp;
11222 #ifdef FEAT_WINDOWS
11223 if (off == 1)
11224 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11225 else
11226 tp = curtab;
11227 #endif
11228 win = find_win_by_nr(&argvars[off], tp);
11229 varname = get_tv_string_chk(&argvars[off + 1]);
11230 ++emsg_off;
11232 rettv->v_type = VAR_STRING;
11233 rettv->vval.v_string = NULL;
11235 if (win != NULL && varname != NULL)
11237 /* Set curwin to be our win, temporarily. Also set curbuf, so
11238 * that we can get buffer-local options. */
11239 oldcurwin = curwin;
11240 curwin = win;
11241 curbuf = win->w_buffer;
11243 if (*varname == '&') /* window-local-option */
11244 get_option_tv(&varname, rettv, 1);
11245 else
11247 if (*varname == NUL)
11248 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11249 * scope prefix before the NUL byte is required by
11250 * find_var_in_ht(). */
11251 varname = (char_u *)"w:" + 2;
11252 /* look up the variable */
11253 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11254 if (v != NULL)
11255 copy_tv(&v->di_tv, rettv);
11258 /* restore previous notion of curwin */
11259 curwin = oldcurwin;
11260 curbuf = curwin->w_buffer;
11263 --emsg_off;
11267 * "glob()" function
11269 static void
11270 f_glob(argvars, rettv)
11271 typval_T *argvars;
11272 typval_T *rettv;
11274 expand_T xpc;
11276 ExpandInit(&xpc);
11277 xpc.xp_context = EXPAND_FILES;
11278 rettv->v_type = VAR_STRING;
11279 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11280 NULL, WILD_USE_NL|WILD_SILENT, WILD_ALL);
11284 * "globpath()" function
11286 static void
11287 f_globpath(argvars, rettv)
11288 typval_T *argvars;
11289 typval_T *rettv;
11291 char_u buf1[NUMBUFLEN];
11292 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11294 rettv->v_type = VAR_STRING;
11295 if (file == NULL)
11296 rettv->vval.v_string = NULL;
11297 else
11298 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file);
11302 * "has()" function
11304 static void
11305 f_has(argvars, rettv)
11306 typval_T *argvars;
11307 typval_T *rettv;
11309 int i;
11310 char_u *name;
11311 int n = FALSE;
11312 static char *(has_list[]) =
11314 #ifdef AMIGA
11315 "amiga",
11316 # ifdef FEAT_ARP
11317 "arp",
11318 # endif
11319 #endif
11320 #ifdef __BEOS__
11321 "beos",
11322 #endif
11323 #ifdef MSDOS
11324 # ifdef DJGPP
11325 "dos32",
11326 # else
11327 "dos16",
11328 # endif
11329 #endif
11330 #ifdef MACOS
11331 "mac",
11332 #endif
11333 #if defined(MACOS_X_UNIX)
11334 "macunix",
11335 #endif
11336 #ifdef OS2
11337 "os2",
11338 #endif
11339 #ifdef __QNX__
11340 "qnx",
11341 #endif
11342 #ifdef RISCOS
11343 "riscos",
11344 #endif
11345 #ifdef UNIX
11346 "unix",
11347 #endif
11348 #ifdef VMS
11349 "vms",
11350 #endif
11351 #ifdef WIN16
11352 "win16",
11353 #endif
11354 #ifdef WIN32
11355 "win32",
11356 #endif
11357 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11358 "win32unix",
11359 #endif
11360 #ifdef WIN64
11361 "win64",
11362 #endif
11363 #ifdef EBCDIC
11364 "ebcdic",
11365 #endif
11366 #ifndef CASE_INSENSITIVE_FILENAME
11367 "fname_case",
11368 #endif
11369 #ifdef FEAT_ARABIC
11370 "arabic",
11371 #endif
11372 #ifdef FEAT_AUTOCMD
11373 "autocmd",
11374 #endif
11375 #ifdef FEAT_BEVAL
11376 "balloon_eval",
11377 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11378 "balloon_multiline",
11379 # endif
11380 #endif
11381 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11382 "builtin_terms",
11383 # ifdef ALL_BUILTIN_TCAPS
11384 "all_builtin_terms",
11385 # endif
11386 #endif
11387 #ifdef FEAT_BYTEOFF
11388 "byte_offset",
11389 #endif
11390 #ifdef FEAT_CINDENT
11391 "cindent",
11392 #endif
11393 #ifdef FEAT_CLIENTSERVER
11394 "clientserver",
11395 #endif
11396 #ifdef FEAT_CLIPBOARD
11397 "clipboard",
11398 #endif
11399 #ifdef FEAT_CMDL_COMPL
11400 "cmdline_compl",
11401 #endif
11402 #ifdef FEAT_CMDHIST
11403 "cmdline_hist",
11404 #endif
11405 #ifdef FEAT_COMMENTS
11406 "comments",
11407 #endif
11408 #ifdef FEAT_CRYPT
11409 "cryptv",
11410 #endif
11411 #ifdef FEAT_CSCOPE
11412 "cscope",
11413 #endif
11414 #ifdef CURSOR_SHAPE
11415 "cursorshape",
11416 #endif
11417 #ifdef DEBUG
11418 "debug",
11419 #endif
11420 #ifdef FEAT_CON_DIALOG
11421 "dialog_con",
11422 #endif
11423 #ifdef FEAT_GUI_DIALOG
11424 "dialog_gui",
11425 #endif
11426 #ifdef FEAT_DIFF
11427 "diff",
11428 #endif
11429 #ifdef FEAT_DIGRAPHS
11430 "digraphs",
11431 #endif
11432 #ifdef FEAT_DND
11433 "dnd",
11434 #endif
11435 #ifdef FEAT_EMACS_TAGS
11436 "emacs_tags",
11437 #endif
11438 "eval", /* always present, of course! */
11439 #ifdef FEAT_EX_EXTRA
11440 "ex_extra",
11441 #endif
11442 #ifdef FEAT_SEARCH_EXTRA
11443 "extra_search",
11444 #endif
11445 #ifdef FEAT_FKMAP
11446 "farsi",
11447 #endif
11448 #ifdef FEAT_SEARCHPATH
11449 "file_in_path",
11450 #endif
11451 #if defined(UNIX) && !defined(USE_SYSTEM)
11452 "filterpipe",
11453 #endif
11454 #ifdef FEAT_FIND_ID
11455 "find_in_path",
11456 #endif
11457 #ifdef FEAT_FLOAT
11458 "float",
11459 #endif
11460 #ifdef FEAT_FOLDING
11461 "folding",
11462 #endif
11463 #ifdef FEAT_FOOTER
11464 "footer",
11465 #endif
11466 #if !defined(USE_SYSTEM) && defined(UNIX)
11467 "fork",
11468 #endif
11469 #ifdef FEAT_FULLSCREEN
11470 "fullscreen",
11471 #endif
11472 #ifdef FEAT_GETTEXT
11473 "gettext",
11474 #endif
11475 #ifdef FEAT_GUI
11476 "gui",
11477 #endif
11478 #ifdef FEAT_GUI_ATHENA
11479 # ifdef FEAT_GUI_NEXTAW
11480 "gui_neXtaw",
11481 # else
11482 "gui_athena",
11483 # endif
11484 #endif
11485 #ifdef FEAT_GUI_GTK
11486 "gui_gtk",
11487 # ifdef HAVE_GTK2
11488 "gui_gtk2",
11489 # endif
11490 #endif
11491 #ifdef FEAT_GUI_GNOME
11492 "gui_gnome",
11493 #endif
11494 #ifdef FEAT_GUI_MAC
11495 "gui_mac",
11496 #endif
11497 #ifdef FEAT_GUI_MACVIM
11498 "gui_macvim",
11499 #endif
11500 #ifdef FEAT_GUI_MOTIF
11501 "gui_motif",
11502 #endif
11503 #ifdef FEAT_GUI_PHOTON
11504 "gui_photon",
11505 #endif
11506 #ifdef FEAT_GUI_W16
11507 "gui_win16",
11508 #endif
11509 #ifdef FEAT_GUI_W32
11510 "gui_win32",
11511 #endif
11512 #ifdef FEAT_HANGULIN
11513 "hangul_input",
11514 #endif
11515 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11516 "iconv",
11517 #endif
11518 #ifdef FEAT_INS_EXPAND
11519 "insert_expand",
11520 #endif
11521 #ifdef FEAT_JUMPLIST
11522 "jumplist",
11523 #endif
11524 #ifdef FEAT_KEYMAP
11525 "keymap",
11526 #endif
11527 #ifdef FEAT_LANGMAP
11528 "langmap",
11529 #endif
11530 #ifdef FEAT_LIBCALL
11531 "libcall",
11532 #endif
11533 #ifdef FEAT_LINEBREAK
11534 "linebreak",
11535 #endif
11536 #ifdef FEAT_LISP
11537 "lispindent",
11538 #endif
11539 #ifdef FEAT_LISTCMDS
11540 "listcmds",
11541 #endif
11542 #ifdef FEAT_LOCALMAP
11543 "localmap",
11544 #endif
11545 #ifdef FEAT_MENU
11546 "menu",
11547 #endif
11548 #ifdef FEAT_SESSION
11549 "mksession",
11550 #endif
11551 #ifdef FEAT_MODIFY_FNAME
11552 "modify_fname",
11553 #endif
11554 #ifdef FEAT_MOUSE
11555 "mouse",
11556 #endif
11557 #ifdef FEAT_MOUSESHAPE
11558 "mouseshape",
11559 #endif
11560 #if defined(UNIX) || defined(VMS)
11561 # ifdef FEAT_MOUSE_DEC
11562 "mouse_dec",
11563 # endif
11564 # ifdef FEAT_MOUSE_GPM
11565 "mouse_gpm",
11566 # endif
11567 # ifdef FEAT_MOUSE_JSB
11568 "mouse_jsbterm",
11569 # endif
11570 # ifdef FEAT_MOUSE_NET
11571 "mouse_netterm",
11572 # endif
11573 # ifdef FEAT_MOUSE_PTERM
11574 "mouse_pterm",
11575 # endif
11576 # ifdef FEAT_SYSMOUSE
11577 "mouse_sysmouse",
11578 # endif
11579 # ifdef FEAT_MOUSE_XTERM
11580 "mouse_xterm",
11581 # endif
11582 #endif
11583 #ifdef FEAT_MBYTE
11584 "multi_byte",
11585 #endif
11586 #ifdef FEAT_MBYTE_IME
11587 "multi_byte_ime",
11588 #endif
11589 #ifdef FEAT_MULTI_LANG
11590 "multi_lang",
11591 #endif
11592 #ifdef FEAT_MZSCHEME
11593 #ifndef DYNAMIC_MZSCHEME
11594 "mzscheme",
11595 #endif
11596 #endif
11597 #ifdef FEAT_OLE
11598 "ole",
11599 #endif
11600 #ifdef FEAT_OSFILETYPE
11601 "osfiletype",
11602 #endif
11603 #ifdef FEAT_PATH_EXTRA
11604 "path_extra",
11605 #endif
11606 #ifdef FEAT_PERL
11607 #ifndef DYNAMIC_PERL
11608 "perl",
11609 #endif
11610 #endif
11611 #ifdef FEAT_PYTHON
11612 #ifndef DYNAMIC_PYTHON
11613 "python",
11614 #endif
11615 #endif
11616 #ifdef FEAT_POSTSCRIPT
11617 "postscript",
11618 #endif
11619 #ifdef FEAT_PRINTER
11620 "printer",
11621 #endif
11622 #ifdef FEAT_PROFILE
11623 "profile",
11624 #endif
11625 #ifdef FEAT_RELTIME
11626 "reltime",
11627 #endif
11628 #ifdef FEAT_QUICKFIX
11629 "quickfix",
11630 #endif
11631 #ifdef FEAT_RIGHTLEFT
11632 "rightleft",
11633 #endif
11634 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11635 "ruby",
11636 #endif
11637 #ifdef FEAT_SCROLLBIND
11638 "scrollbind",
11639 #endif
11640 #ifdef FEAT_CMDL_INFO
11641 "showcmd",
11642 "cmdline_info",
11643 #endif
11644 #ifdef FEAT_SIGNS
11645 "signs",
11646 #endif
11647 #ifdef FEAT_SMARTINDENT
11648 "smartindent",
11649 #endif
11650 #ifdef FEAT_SNIFF
11651 "sniff",
11652 #endif
11653 #ifdef FEAT_STL_OPT
11654 "statusline",
11655 #endif
11656 #ifdef FEAT_SUN_WORKSHOP
11657 "sun_workshop",
11658 #endif
11659 #ifdef FEAT_NETBEANS_INTG
11660 "netbeans_intg",
11661 #endif
11662 #ifdef FEAT_ODB_EDITOR
11663 "odbeditor",
11664 #endif
11665 #ifdef FEAT_SPELL
11666 "spell",
11667 #endif
11668 #ifdef FEAT_SYN_HL
11669 "syntax",
11670 #endif
11671 #if defined(USE_SYSTEM) || !defined(UNIX)
11672 "system",
11673 #endif
11674 #ifdef FEAT_TAG_BINS
11675 "tag_binary",
11676 #endif
11677 #ifdef FEAT_TAG_OLDSTATIC
11678 "tag_old_static",
11679 #endif
11680 #ifdef FEAT_TAG_ANYWHITE
11681 "tag_any_white",
11682 #endif
11683 #ifdef FEAT_TCL
11684 # ifndef DYNAMIC_TCL
11685 "tcl",
11686 # endif
11687 #endif
11688 #ifdef TERMINFO
11689 "terminfo",
11690 #endif
11691 #ifdef FEAT_TERMRESPONSE
11692 "termresponse",
11693 #endif
11694 #ifdef FEAT_TEXTOBJ
11695 "textobjects",
11696 #endif
11697 #ifdef HAVE_TGETENT
11698 "tgetent",
11699 #endif
11700 #ifdef FEAT_TITLE
11701 "title",
11702 #endif
11703 #ifdef FEAT_TOOLBAR
11704 "toolbar",
11705 #endif
11706 #ifdef FEAT_TRANSPARENCY
11707 "transparency",
11708 #endif
11709 #ifdef FEAT_USR_CMDS
11710 "user-commands", /* was accidentally included in 5.4 */
11711 "user_commands",
11712 #endif
11713 #ifdef FEAT_VIMINFO
11714 "viminfo",
11715 #endif
11716 #ifdef FEAT_VERTSPLIT
11717 "vertsplit",
11718 #endif
11719 #ifdef FEAT_VIRTUALEDIT
11720 "virtualedit",
11721 #endif
11722 #ifdef FEAT_VISUAL
11723 "visual",
11724 #endif
11725 #ifdef FEAT_VISUALEXTRA
11726 "visualextra",
11727 #endif
11728 #ifdef FEAT_VREPLACE
11729 "vreplace",
11730 #endif
11731 #ifdef FEAT_WILDIGN
11732 "wildignore",
11733 #endif
11734 #ifdef FEAT_WILDMENU
11735 "wildmenu",
11736 #endif
11737 #ifdef FEAT_WINDOWS
11738 "windows",
11739 #endif
11740 #ifdef FEAT_WAK
11741 "winaltkeys",
11742 #endif
11743 #ifdef FEAT_WRITEBACKUP
11744 "writebackup",
11745 #endif
11746 #ifdef FEAT_XIM
11747 "xim",
11748 #endif
11749 #ifdef FEAT_XFONTSET
11750 "xfontset",
11751 #endif
11752 #ifdef USE_XSMP
11753 "xsmp",
11754 #endif
11755 #ifdef USE_XSMP_INTERACT
11756 "xsmp_interact",
11757 #endif
11758 #ifdef FEAT_XCLIPBOARD
11759 "xterm_clipboard",
11760 #endif
11761 #ifdef FEAT_XTERM_SAVE
11762 "xterm_save",
11763 #endif
11764 #if defined(UNIX) && defined(FEAT_X11)
11765 "X11",
11766 #endif
11767 NULL
11770 name = get_tv_string(&argvars[0]);
11771 for (i = 0; has_list[i] != NULL; ++i)
11772 if (STRICMP(name, has_list[i]) == 0)
11774 n = TRUE;
11775 break;
11778 if (n == FALSE)
11780 if (STRNICMP(name, "patch", 5) == 0)
11781 n = has_patch(atoi((char *)name + 5));
11782 else if (STRICMP(name, "vim_starting") == 0)
11783 n = (starting != 0);
11784 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11785 else if (STRICMP(name, "balloon_multiline") == 0)
11786 n = multiline_balloon_available();
11787 #endif
11788 #ifdef DYNAMIC_TCL
11789 else if (STRICMP(name, "tcl") == 0)
11790 n = tcl_enabled(FALSE);
11791 #endif
11792 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11793 else if (STRICMP(name, "iconv") == 0)
11794 n = iconv_enabled(FALSE);
11795 #endif
11796 #ifdef DYNAMIC_MZSCHEME
11797 else if (STRICMP(name, "mzscheme") == 0)
11798 n = mzscheme_enabled(FALSE);
11799 #endif
11800 #ifdef DYNAMIC_RUBY
11801 else if (STRICMP(name, "ruby") == 0)
11802 n = ruby_enabled(FALSE);
11803 #endif
11804 #ifdef DYNAMIC_PYTHON
11805 else if (STRICMP(name, "python") == 0)
11806 n = python_enabled(FALSE);
11807 #endif
11808 #ifdef DYNAMIC_PERL
11809 else if (STRICMP(name, "perl") == 0)
11810 n = perl_enabled(FALSE);
11811 #endif
11812 #ifdef FEAT_GUI
11813 else if (STRICMP(name, "gui_running") == 0)
11814 n = (gui.in_use || gui.starting);
11815 # ifdef FEAT_GUI_W32
11816 else if (STRICMP(name, "gui_win32s") == 0)
11817 n = gui_is_win32s();
11818 # endif
11819 # ifdef FEAT_BROWSE
11820 else if (STRICMP(name, "browse") == 0)
11821 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11822 # endif
11823 #endif
11824 #ifdef FEAT_SYN_HL
11825 else if (STRICMP(name, "syntax_items") == 0)
11826 n = syntax_present(curbuf);
11827 #endif
11828 #if defined(WIN3264)
11829 else if (STRICMP(name, "win95") == 0)
11830 n = mch_windows95();
11831 #endif
11832 #ifdef FEAT_NETBEANS_INTG
11833 else if (STRICMP(name, "netbeans_enabled") == 0)
11834 n = usingNetbeans;
11835 #endif
11838 rettv->vval.v_number = n;
11842 * "has_key()" function
11844 static void
11845 f_has_key(argvars, rettv)
11846 typval_T *argvars;
11847 typval_T *rettv;
11849 rettv->vval.v_number = 0;
11850 if (argvars[0].v_type != VAR_DICT)
11852 EMSG(_(e_dictreq));
11853 return;
11855 if (argvars[0].vval.v_dict == NULL)
11856 return;
11858 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11859 get_tv_string(&argvars[1]), -1) != NULL;
11863 * "haslocaldir()" function
11865 /*ARGSUSED*/
11866 static void
11867 f_haslocaldir(argvars, rettv)
11868 typval_T *argvars;
11869 typval_T *rettv;
11871 rettv->vval.v_number = (curwin->w_localdir != NULL);
11875 * "hasmapto()" function
11877 static void
11878 f_hasmapto(argvars, rettv)
11879 typval_T *argvars;
11880 typval_T *rettv;
11882 char_u *name;
11883 char_u *mode;
11884 char_u buf[NUMBUFLEN];
11885 int abbr = FALSE;
11887 name = get_tv_string(&argvars[0]);
11888 if (argvars[1].v_type == VAR_UNKNOWN)
11889 mode = (char_u *)"nvo";
11890 else
11892 mode = get_tv_string_buf(&argvars[1], buf);
11893 if (argvars[2].v_type != VAR_UNKNOWN)
11894 abbr = get_tv_number(&argvars[2]);
11897 if (map_to_exists(name, mode, abbr))
11898 rettv->vval.v_number = TRUE;
11899 else
11900 rettv->vval.v_number = FALSE;
11904 * "histadd()" function
11906 /*ARGSUSED*/
11907 static void
11908 f_histadd(argvars, rettv)
11909 typval_T *argvars;
11910 typval_T *rettv;
11912 #ifdef FEAT_CMDHIST
11913 int histype;
11914 char_u *str;
11915 char_u buf[NUMBUFLEN];
11916 #endif
11918 rettv->vval.v_number = FALSE;
11919 if (check_restricted() || check_secure())
11920 return;
11921 #ifdef FEAT_CMDHIST
11922 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11923 histype = str != NULL ? get_histtype(str) : -1;
11924 if (histype >= 0)
11926 str = get_tv_string_buf(&argvars[1], buf);
11927 if (*str != NUL)
11929 add_to_history(histype, str, FALSE, NUL);
11930 rettv->vval.v_number = TRUE;
11931 return;
11934 #endif
11938 * "histdel()" function
11940 /*ARGSUSED*/
11941 static void
11942 f_histdel(argvars, rettv)
11943 typval_T *argvars;
11944 typval_T *rettv;
11946 #ifdef FEAT_CMDHIST
11947 int n;
11948 char_u buf[NUMBUFLEN];
11949 char_u *str;
11951 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11952 if (str == NULL)
11953 n = 0;
11954 else if (argvars[1].v_type == VAR_UNKNOWN)
11955 /* only one argument: clear entire history */
11956 n = clr_history(get_histtype(str));
11957 else if (argvars[1].v_type == VAR_NUMBER)
11958 /* index given: remove that entry */
11959 n = del_history_idx(get_histtype(str),
11960 (int)get_tv_number(&argvars[1]));
11961 else
11962 /* string given: remove all matching entries */
11963 n = del_history_entry(get_histtype(str),
11964 get_tv_string_buf(&argvars[1], buf));
11965 rettv->vval.v_number = n;
11966 #else
11967 rettv->vval.v_number = 0;
11968 #endif
11972 * "histget()" function
11974 /*ARGSUSED*/
11975 static void
11976 f_histget(argvars, rettv)
11977 typval_T *argvars;
11978 typval_T *rettv;
11980 #ifdef FEAT_CMDHIST
11981 int type;
11982 int idx;
11983 char_u *str;
11985 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11986 if (str == NULL)
11987 rettv->vval.v_string = NULL;
11988 else
11990 type = get_histtype(str);
11991 if (argvars[1].v_type == VAR_UNKNOWN)
11992 idx = get_history_idx(type);
11993 else
11994 idx = (int)get_tv_number_chk(&argvars[1], NULL);
11995 /* -1 on type error */
11996 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
11998 #else
11999 rettv->vval.v_string = NULL;
12000 #endif
12001 rettv->v_type = VAR_STRING;
12005 * "histnr()" function
12007 /*ARGSUSED*/
12008 static void
12009 f_histnr(argvars, rettv)
12010 typval_T *argvars;
12011 typval_T *rettv;
12013 int i;
12015 #ifdef FEAT_CMDHIST
12016 char_u *history = get_tv_string_chk(&argvars[0]);
12018 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12019 if (i >= HIST_CMD && i < HIST_COUNT)
12020 i = get_history_idx(i);
12021 else
12022 #endif
12023 i = -1;
12024 rettv->vval.v_number = i;
12028 * "highlightID(name)" function
12030 static void
12031 f_hlID(argvars, rettv)
12032 typval_T *argvars;
12033 typval_T *rettv;
12035 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12039 * "highlight_exists()" function
12041 static void
12042 f_hlexists(argvars, rettv)
12043 typval_T *argvars;
12044 typval_T *rettv;
12046 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12050 * "hostname()" function
12052 /*ARGSUSED*/
12053 static void
12054 f_hostname(argvars, rettv)
12055 typval_T *argvars;
12056 typval_T *rettv;
12058 char_u hostname[256];
12060 mch_get_host_name(hostname, 256);
12061 rettv->v_type = VAR_STRING;
12062 rettv->vval.v_string = vim_strsave(hostname);
12066 * iconv() function
12068 /*ARGSUSED*/
12069 static void
12070 f_iconv(argvars, rettv)
12071 typval_T *argvars;
12072 typval_T *rettv;
12074 #ifdef FEAT_MBYTE
12075 char_u buf1[NUMBUFLEN];
12076 char_u buf2[NUMBUFLEN];
12077 char_u *from, *to, *str;
12078 vimconv_T vimconv;
12079 #endif
12081 rettv->v_type = VAR_STRING;
12082 rettv->vval.v_string = NULL;
12084 #ifdef FEAT_MBYTE
12085 str = get_tv_string(&argvars[0]);
12086 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12087 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12088 vimconv.vc_type = CONV_NONE;
12089 convert_setup(&vimconv, from, to);
12091 /* If the encodings are equal, no conversion needed. */
12092 if (vimconv.vc_type == CONV_NONE)
12093 rettv->vval.v_string = vim_strsave(str);
12094 else
12095 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12097 convert_setup(&vimconv, NULL, NULL);
12098 vim_free(from);
12099 vim_free(to);
12100 #endif
12104 * "indent()" function
12106 static void
12107 f_indent(argvars, rettv)
12108 typval_T *argvars;
12109 typval_T *rettv;
12111 linenr_T lnum;
12113 lnum = get_tv_lnum(argvars);
12114 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12115 rettv->vval.v_number = get_indent_lnum(lnum);
12116 else
12117 rettv->vval.v_number = -1;
12121 * "index()" function
12123 static void
12124 f_index(argvars, rettv)
12125 typval_T *argvars;
12126 typval_T *rettv;
12128 list_T *l;
12129 listitem_T *item;
12130 long idx = 0;
12131 int ic = FALSE;
12133 rettv->vval.v_number = -1;
12134 if (argvars[0].v_type != VAR_LIST)
12136 EMSG(_(e_listreq));
12137 return;
12139 l = argvars[0].vval.v_list;
12140 if (l != NULL)
12142 item = l->lv_first;
12143 if (argvars[2].v_type != VAR_UNKNOWN)
12145 int error = FALSE;
12147 /* Start at specified item. Use the cached index that list_find()
12148 * sets, so that a negative number also works. */
12149 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12150 idx = l->lv_idx;
12151 if (argvars[3].v_type != VAR_UNKNOWN)
12152 ic = get_tv_number_chk(&argvars[3], &error);
12153 if (error)
12154 item = NULL;
12157 for ( ; item != NULL; item = item->li_next, ++idx)
12158 if (tv_equal(&item->li_tv, &argvars[1], ic))
12160 rettv->vval.v_number = idx;
12161 break;
12166 static int inputsecret_flag = 0;
12168 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12171 * This function is used by f_input() and f_inputdialog() functions. The third
12172 * argument to f_input() specifies the type of completion to use at the
12173 * prompt. The third argument to f_inputdialog() specifies the value to return
12174 * when the user cancels the prompt.
12176 static void
12177 get_user_input(argvars, rettv, inputdialog)
12178 typval_T *argvars;
12179 typval_T *rettv;
12180 int inputdialog;
12182 char_u *prompt = get_tv_string_chk(&argvars[0]);
12183 char_u *p = NULL;
12184 int c;
12185 char_u buf[NUMBUFLEN];
12186 int cmd_silent_save = cmd_silent;
12187 char_u *defstr = (char_u *)"";
12188 int xp_type = EXPAND_NOTHING;
12189 char_u *xp_arg = NULL;
12191 rettv->v_type = VAR_STRING;
12192 rettv->vval.v_string = NULL;
12194 #ifdef NO_CONSOLE_INPUT
12195 /* While starting up, there is no place to enter text. */
12196 if (no_console_input())
12197 return;
12198 #endif
12200 cmd_silent = FALSE; /* Want to see the prompt. */
12201 if (prompt != NULL)
12203 /* Only the part of the message after the last NL is considered as
12204 * prompt for the command line */
12205 p = vim_strrchr(prompt, '\n');
12206 if (p == NULL)
12207 p = prompt;
12208 else
12210 ++p;
12211 c = *p;
12212 *p = NUL;
12213 msg_start();
12214 msg_clr_eos();
12215 msg_puts_attr(prompt, echo_attr);
12216 msg_didout = FALSE;
12217 msg_starthere();
12218 *p = c;
12220 cmdline_row = msg_row;
12222 if (argvars[1].v_type != VAR_UNKNOWN)
12224 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12225 if (defstr != NULL)
12226 stuffReadbuffSpec(defstr);
12228 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12230 char_u *xp_name;
12231 int xp_namelen;
12232 long argt;
12234 rettv->vval.v_string = NULL;
12236 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12237 if (xp_name == NULL)
12238 return;
12240 xp_namelen = (int)STRLEN(xp_name);
12242 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12243 &xp_arg) == FAIL)
12244 return;
12248 if (defstr != NULL)
12249 rettv->vval.v_string =
12250 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12251 xp_type, xp_arg);
12253 vim_free(xp_arg);
12255 /* since the user typed this, no need to wait for return */
12256 need_wait_return = FALSE;
12257 msg_didout = FALSE;
12259 cmd_silent = cmd_silent_save;
12263 * "input()" function
12264 * Also handles inputsecret() when inputsecret is set.
12266 static void
12267 f_input(argvars, rettv)
12268 typval_T *argvars;
12269 typval_T *rettv;
12271 get_user_input(argvars, rettv, FALSE);
12275 * "inputdialog()" function
12277 static void
12278 f_inputdialog(argvars, rettv)
12279 typval_T *argvars;
12280 typval_T *rettv;
12282 #if defined(FEAT_GUI_TEXTDIALOG)
12283 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12284 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12286 char_u *message;
12287 char_u buf[NUMBUFLEN];
12288 char_u *defstr = (char_u *)"";
12290 message = get_tv_string_chk(&argvars[0]);
12291 if (argvars[1].v_type != VAR_UNKNOWN
12292 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12293 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12294 else
12295 IObuff[0] = NUL;
12296 if (message != NULL && defstr != NULL
12297 && do_dialog(VIM_QUESTION, NULL, message,
12298 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12299 rettv->vval.v_string = vim_strsave(IObuff);
12300 else
12302 if (message != NULL && defstr != NULL
12303 && argvars[1].v_type != VAR_UNKNOWN
12304 && argvars[2].v_type != VAR_UNKNOWN)
12305 rettv->vval.v_string = vim_strsave(
12306 get_tv_string_buf(&argvars[2], buf));
12307 else
12308 rettv->vval.v_string = NULL;
12310 rettv->v_type = VAR_STRING;
12312 else
12313 #endif
12314 get_user_input(argvars, rettv, TRUE);
12318 * "inputlist()" function
12320 static void
12321 f_inputlist(argvars, rettv)
12322 typval_T *argvars;
12323 typval_T *rettv;
12325 listitem_T *li;
12326 int selected;
12327 int mouse_used;
12329 rettv->vval.v_number = 0;
12330 #ifdef NO_CONSOLE_INPUT
12331 /* While starting up, there is no place to enter text. */
12332 if (no_console_input())
12333 return;
12334 #endif
12335 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12337 EMSG2(_(e_listarg), "inputlist()");
12338 return;
12341 msg_start();
12342 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12343 lines_left = Rows; /* avoid more prompt */
12344 msg_scroll = TRUE;
12345 msg_clr_eos();
12347 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12349 msg_puts(get_tv_string(&li->li_tv));
12350 msg_putchar('\n');
12353 /* Ask for choice. */
12354 selected = prompt_for_number(&mouse_used);
12355 if (mouse_used)
12356 selected -= lines_left;
12358 rettv->vval.v_number = selected;
12362 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12365 * "inputrestore()" function
12367 /*ARGSUSED*/
12368 static void
12369 f_inputrestore(argvars, rettv)
12370 typval_T *argvars;
12371 typval_T *rettv;
12373 if (ga_userinput.ga_len > 0)
12375 --ga_userinput.ga_len;
12376 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12377 + ga_userinput.ga_len);
12378 rettv->vval.v_number = 0; /* OK */
12380 else if (p_verbose > 1)
12382 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12383 rettv->vval.v_number = 1; /* Failed */
12388 * "inputsave()" function
12390 /*ARGSUSED*/
12391 static void
12392 f_inputsave(argvars, rettv)
12393 typval_T *argvars;
12394 typval_T *rettv;
12396 /* Add an entry to the stack of typeahead storage. */
12397 if (ga_grow(&ga_userinput, 1) == OK)
12399 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12400 + ga_userinput.ga_len);
12401 ++ga_userinput.ga_len;
12402 rettv->vval.v_number = 0; /* OK */
12404 else
12405 rettv->vval.v_number = 1; /* Failed */
12409 * "inputsecret()" function
12411 static void
12412 f_inputsecret(argvars, rettv)
12413 typval_T *argvars;
12414 typval_T *rettv;
12416 ++cmdline_star;
12417 ++inputsecret_flag;
12418 f_input(argvars, rettv);
12419 --cmdline_star;
12420 --inputsecret_flag;
12424 * "insert()" function
12426 static void
12427 f_insert(argvars, rettv)
12428 typval_T *argvars;
12429 typval_T *rettv;
12431 long before = 0;
12432 listitem_T *item;
12433 list_T *l;
12434 int error = FALSE;
12436 rettv->vval.v_number = 0;
12437 if (argvars[0].v_type != VAR_LIST)
12438 EMSG2(_(e_listarg), "insert()");
12439 else if ((l = argvars[0].vval.v_list) != NULL
12440 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12442 if (argvars[2].v_type != VAR_UNKNOWN)
12443 before = get_tv_number_chk(&argvars[2], &error);
12444 if (error)
12445 return; /* type error; errmsg already given */
12447 if (before == l->lv_len)
12448 item = NULL;
12449 else
12451 item = list_find(l, before);
12452 if (item == NULL)
12454 EMSGN(_(e_listidx), before);
12455 l = NULL;
12458 if (l != NULL)
12460 list_insert_tv(l, &argvars[1], item);
12461 copy_tv(&argvars[0], rettv);
12467 * "isdirectory()" function
12469 static void
12470 f_isdirectory(argvars, rettv)
12471 typval_T *argvars;
12472 typval_T *rettv;
12474 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12478 * "islocked()" function
12480 static void
12481 f_islocked(argvars, rettv)
12482 typval_T *argvars;
12483 typval_T *rettv;
12485 lval_T lv;
12486 char_u *end;
12487 dictitem_T *di;
12489 rettv->vval.v_number = -1;
12490 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12491 FNE_CHECK_START);
12492 if (end != NULL && lv.ll_name != NULL)
12494 if (*end != NUL)
12495 EMSG(_(e_trailing));
12496 else
12498 if (lv.ll_tv == NULL)
12500 if (check_changedtick(lv.ll_name))
12501 rettv->vval.v_number = 1; /* always locked */
12502 else
12504 di = find_var(lv.ll_name, NULL);
12505 if (di != NULL)
12507 /* Consider a variable locked when:
12508 * 1. the variable itself is locked
12509 * 2. the value of the variable is locked.
12510 * 3. the List or Dict value is locked.
12512 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12513 || tv_islocked(&di->di_tv));
12517 else if (lv.ll_range)
12518 EMSG(_("E786: Range not allowed"));
12519 else if (lv.ll_newkey != NULL)
12520 EMSG2(_(e_dictkey), lv.ll_newkey);
12521 else if (lv.ll_list != NULL)
12522 /* List item. */
12523 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12524 else
12525 /* Dictionary item. */
12526 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12530 clear_lval(&lv);
12533 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12536 * Turn a dict into a list:
12537 * "what" == 0: list of keys
12538 * "what" == 1: list of values
12539 * "what" == 2: list of items
12541 static void
12542 dict_list(argvars, rettv, what)
12543 typval_T *argvars;
12544 typval_T *rettv;
12545 int what;
12547 list_T *l2;
12548 dictitem_T *di;
12549 hashitem_T *hi;
12550 listitem_T *li;
12551 listitem_T *li2;
12552 dict_T *d;
12553 int todo;
12555 rettv->vval.v_number = 0;
12556 if (argvars[0].v_type != VAR_DICT)
12558 EMSG(_(e_dictreq));
12559 return;
12561 if ((d = argvars[0].vval.v_dict) == NULL)
12562 return;
12564 if (rettv_list_alloc(rettv) == FAIL)
12565 return;
12567 todo = (int)d->dv_hashtab.ht_used;
12568 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12570 if (!HASHITEM_EMPTY(hi))
12572 --todo;
12573 di = HI2DI(hi);
12575 li = listitem_alloc();
12576 if (li == NULL)
12577 break;
12578 list_append(rettv->vval.v_list, li);
12580 if (what == 0)
12582 /* keys() */
12583 li->li_tv.v_type = VAR_STRING;
12584 li->li_tv.v_lock = 0;
12585 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12587 else if (what == 1)
12589 /* values() */
12590 copy_tv(&di->di_tv, &li->li_tv);
12592 else
12594 /* items() */
12595 l2 = list_alloc();
12596 li->li_tv.v_type = VAR_LIST;
12597 li->li_tv.v_lock = 0;
12598 li->li_tv.vval.v_list = l2;
12599 if (l2 == NULL)
12600 break;
12601 ++l2->lv_refcount;
12603 li2 = listitem_alloc();
12604 if (li2 == NULL)
12605 break;
12606 list_append(l2, li2);
12607 li2->li_tv.v_type = VAR_STRING;
12608 li2->li_tv.v_lock = 0;
12609 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12611 li2 = listitem_alloc();
12612 if (li2 == NULL)
12613 break;
12614 list_append(l2, li2);
12615 copy_tv(&di->di_tv, &li2->li_tv);
12622 * "items(dict)" function
12624 static void
12625 f_items(argvars, rettv)
12626 typval_T *argvars;
12627 typval_T *rettv;
12629 dict_list(argvars, rettv, 2);
12633 * "join()" function
12635 static void
12636 f_join(argvars, rettv)
12637 typval_T *argvars;
12638 typval_T *rettv;
12640 garray_T ga;
12641 char_u *sep;
12643 rettv->vval.v_number = 0;
12644 if (argvars[0].v_type != VAR_LIST)
12646 EMSG(_(e_listreq));
12647 return;
12649 if (argvars[0].vval.v_list == NULL)
12650 return;
12651 if (argvars[1].v_type == VAR_UNKNOWN)
12652 sep = (char_u *)" ";
12653 else
12654 sep = get_tv_string_chk(&argvars[1]);
12656 rettv->v_type = VAR_STRING;
12658 if (sep != NULL)
12660 ga_init2(&ga, (int)sizeof(char), 80);
12661 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12662 ga_append(&ga, NUL);
12663 rettv->vval.v_string = (char_u *)ga.ga_data;
12665 else
12666 rettv->vval.v_string = NULL;
12670 * "keys()" function
12672 static void
12673 f_keys(argvars, rettv)
12674 typval_T *argvars;
12675 typval_T *rettv;
12677 dict_list(argvars, rettv, 0);
12681 * "last_buffer_nr()" function.
12683 /*ARGSUSED*/
12684 static void
12685 f_last_buffer_nr(argvars, rettv)
12686 typval_T *argvars;
12687 typval_T *rettv;
12689 int n = 0;
12690 buf_T *buf;
12692 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12693 if (n < buf->b_fnum)
12694 n = buf->b_fnum;
12696 rettv->vval.v_number = n;
12700 * "len()" function
12702 static void
12703 f_len(argvars, rettv)
12704 typval_T *argvars;
12705 typval_T *rettv;
12707 switch (argvars[0].v_type)
12709 case VAR_STRING:
12710 case VAR_NUMBER:
12711 rettv->vval.v_number = (varnumber_T)STRLEN(
12712 get_tv_string(&argvars[0]));
12713 break;
12714 case VAR_LIST:
12715 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12716 break;
12717 case VAR_DICT:
12718 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12719 break;
12720 default:
12721 EMSG(_("E701: Invalid type for len()"));
12722 break;
12726 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12728 static void
12729 libcall_common(argvars, rettv, type)
12730 typval_T *argvars;
12731 typval_T *rettv;
12732 int type;
12734 #ifdef FEAT_LIBCALL
12735 char_u *string_in;
12736 char_u **string_result;
12737 int nr_result;
12738 #endif
12740 rettv->v_type = type;
12741 if (type == VAR_NUMBER)
12742 rettv->vval.v_number = 0;
12743 else
12744 rettv->vval.v_string = NULL;
12746 if (check_restricted() || check_secure())
12747 return;
12749 #ifdef FEAT_LIBCALL
12750 /* The first two args must be strings, otherwise its meaningless */
12751 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12753 string_in = NULL;
12754 if (argvars[2].v_type == VAR_STRING)
12755 string_in = argvars[2].vval.v_string;
12756 if (type == VAR_NUMBER)
12757 string_result = NULL;
12758 else
12759 string_result = &rettv->vval.v_string;
12760 if (mch_libcall(argvars[0].vval.v_string,
12761 argvars[1].vval.v_string,
12762 string_in,
12763 argvars[2].vval.v_number,
12764 string_result,
12765 &nr_result) == OK
12766 && type == VAR_NUMBER)
12767 rettv->vval.v_number = nr_result;
12769 #endif
12773 * "libcall()" function
12775 static void
12776 f_libcall(argvars, rettv)
12777 typval_T *argvars;
12778 typval_T *rettv;
12780 libcall_common(argvars, rettv, VAR_STRING);
12784 * "libcallnr()" function
12786 static void
12787 f_libcallnr(argvars, rettv)
12788 typval_T *argvars;
12789 typval_T *rettv;
12791 libcall_common(argvars, rettv, VAR_NUMBER);
12795 * "line(string)" function
12797 static void
12798 f_line(argvars, rettv)
12799 typval_T *argvars;
12800 typval_T *rettv;
12802 linenr_T lnum = 0;
12803 pos_T *fp;
12804 int fnum;
12806 fp = var2fpos(&argvars[0], TRUE, &fnum);
12807 if (fp != NULL)
12808 lnum = fp->lnum;
12809 rettv->vval.v_number = lnum;
12813 * "line2byte(lnum)" function
12815 /*ARGSUSED*/
12816 static void
12817 f_line2byte(argvars, rettv)
12818 typval_T *argvars;
12819 typval_T *rettv;
12821 #ifndef FEAT_BYTEOFF
12822 rettv->vval.v_number = -1;
12823 #else
12824 linenr_T lnum;
12826 lnum = get_tv_lnum(argvars);
12827 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12828 rettv->vval.v_number = -1;
12829 else
12830 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12831 if (rettv->vval.v_number >= 0)
12832 ++rettv->vval.v_number;
12833 #endif
12837 * "lispindent(lnum)" function
12839 static void
12840 f_lispindent(argvars, rettv)
12841 typval_T *argvars;
12842 typval_T *rettv;
12844 #ifdef FEAT_LISP
12845 pos_T pos;
12846 linenr_T lnum;
12848 pos = curwin->w_cursor;
12849 lnum = get_tv_lnum(argvars);
12850 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12852 curwin->w_cursor.lnum = lnum;
12853 rettv->vval.v_number = get_lisp_indent();
12854 curwin->w_cursor = pos;
12856 else
12857 #endif
12858 rettv->vval.v_number = -1;
12862 * "localtime()" function
12864 /*ARGSUSED*/
12865 static void
12866 f_localtime(argvars, rettv)
12867 typval_T *argvars;
12868 typval_T *rettv;
12870 rettv->vval.v_number = (varnumber_T)time(NULL);
12873 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12875 static void
12876 get_maparg(argvars, rettv, exact)
12877 typval_T *argvars;
12878 typval_T *rettv;
12879 int exact;
12881 char_u *keys;
12882 char_u *which;
12883 char_u buf[NUMBUFLEN];
12884 char_u *keys_buf = NULL;
12885 char_u *rhs;
12886 int mode;
12887 garray_T ga;
12888 int abbr = FALSE;
12890 /* return empty string for failure */
12891 rettv->v_type = VAR_STRING;
12892 rettv->vval.v_string = NULL;
12894 keys = get_tv_string(&argvars[0]);
12895 if (*keys == NUL)
12896 return;
12898 if (argvars[1].v_type != VAR_UNKNOWN)
12900 which = get_tv_string_buf_chk(&argvars[1], buf);
12901 if (argvars[2].v_type != VAR_UNKNOWN)
12902 abbr = get_tv_number(&argvars[2]);
12904 else
12905 which = (char_u *)"";
12906 if (which == NULL)
12907 return;
12909 mode = get_map_mode(&which, 0);
12911 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12912 rhs = check_map(keys, mode, exact, FALSE, abbr);
12913 vim_free(keys_buf);
12914 if (rhs != NULL)
12916 ga_init(&ga);
12917 ga.ga_itemsize = 1;
12918 ga.ga_growsize = 40;
12920 while (*rhs != NUL)
12921 ga_concat(&ga, str2special(&rhs, FALSE));
12923 ga_append(&ga, NUL);
12924 rettv->vval.v_string = (char_u *)ga.ga_data;
12928 #ifdef FEAT_FLOAT
12930 * "log10()" function
12932 static void
12933 f_log10(argvars, rettv)
12934 typval_T *argvars;
12935 typval_T *rettv;
12937 float_T f;
12939 rettv->v_type = VAR_FLOAT;
12940 if (get_float_arg(argvars, &f) == OK)
12941 rettv->vval.v_float = log10(f);
12942 else
12943 rettv->vval.v_float = 0.0;
12945 #endif
12948 * "map()" function
12950 static void
12951 f_map(argvars, rettv)
12952 typval_T *argvars;
12953 typval_T *rettv;
12955 filter_map(argvars, rettv, TRUE);
12959 * "maparg()" function
12961 static void
12962 f_maparg(argvars, rettv)
12963 typval_T *argvars;
12964 typval_T *rettv;
12966 get_maparg(argvars, rettv, TRUE);
12970 * "mapcheck()" function
12972 static void
12973 f_mapcheck(argvars, rettv)
12974 typval_T *argvars;
12975 typval_T *rettv;
12977 get_maparg(argvars, rettv, FALSE);
12980 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
12982 static void
12983 find_some_match(argvars, rettv, type)
12984 typval_T *argvars;
12985 typval_T *rettv;
12986 int type;
12988 char_u *str = NULL;
12989 char_u *expr = NULL;
12990 char_u *pat;
12991 regmatch_T regmatch;
12992 char_u patbuf[NUMBUFLEN];
12993 char_u strbuf[NUMBUFLEN];
12994 char_u *save_cpo;
12995 long start = 0;
12996 long nth = 1;
12997 colnr_T startcol = 0;
12998 int match = 0;
12999 list_T *l = NULL;
13000 listitem_T *li = NULL;
13001 long idx = 0;
13002 char_u *tofree = NULL;
13004 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13005 save_cpo = p_cpo;
13006 p_cpo = (char_u *)"";
13008 rettv->vval.v_number = -1;
13009 if (type == 3)
13011 /* return empty list when there are no matches */
13012 if (rettv_list_alloc(rettv) == FAIL)
13013 goto theend;
13015 else if (type == 2)
13017 rettv->v_type = VAR_STRING;
13018 rettv->vval.v_string = NULL;
13021 if (argvars[0].v_type == VAR_LIST)
13023 if ((l = argvars[0].vval.v_list) == NULL)
13024 goto theend;
13025 li = l->lv_first;
13027 else
13028 expr = str = get_tv_string(&argvars[0]);
13030 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13031 if (pat == NULL)
13032 goto theend;
13034 if (argvars[2].v_type != VAR_UNKNOWN)
13036 int error = FALSE;
13038 start = get_tv_number_chk(&argvars[2], &error);
13039 if (error)
13040 goto theend;
13041 if (l != NULL)
13043 li = list_find(l, start);
13044 if (li == NULL)
13045 goto theend;
13046 idx = l->lv_idx; /* use the cached index */
13048 else
13050 if (start < 0)
13051 start = 0;
13052 if (start > (long)STRLEN(str))
13053 goto theend;
13054 /* When "count" argument is there ignore matches before "start",
13055 * otherwise skip part of the string. Differs when pattern is "^"
13056 * or "\<". */
13057 if (argvars[3].v_type != VAR_UNKNOWN)
13058 startcol = start;
13059 else
13060 str += start;
13063 if (argvars[3].v_type != VAR_UNKNOWN)
13064 nth = get_tv_number_chk(&argvars[3], &error);
13065 if (error)
13066 goto theend;
13069 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13070 if (regmatch.regprog != NULL)
13072 regmatch.rm_ic = p_ic;
13074 for (;;)
13076 if (l != NULL)
13078 if (li == NULL)
13080 match = FALSE;
13081 break;
13083 vim_free(tofree);
13084 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13085 if (str == NULL)
13086 break;
13089 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13091 if (match && --nth <= 0)
13092 break;
13093 if (l == NULL && !match)
13094 break;
13096 /* Advance to just after the match. */
13097 if (l != NULL)
13099 li = li->li_next;
13100 ++idx;
13102 else
13104 #ifdef FEAT_MBYTE
13105 startcol = (colnr_T)(regmatch.startp[0]
13106 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13107 #else
13108 startcol = regmatch.startp[0] + 1 - str;
13109 #endif
13113 if (match)
13115 if (type == 3)
13117 int i;
13119 /* return list with matched string and submatches */
13120 for (i = 0; i < NSUBEXP; ++i)
13122 if (regmatch.endp[i] == NULL)
13124 if (list_append_string(rettv->vval.v_list,
13125 (char_u *)"", 0) == FAIL)
13126 break;
13128 else if (list_append_string(rettv->vval.v_list,
13129 regmatch.startp[i],
13130 (int)(regmatch.endp[i] - regmatch.startp[i]))
13131 == FAIL)
13132 break;
13135 else if (type == 2)
13137 /* return matched string */
13138 if (l != NULL)
13139 copy_tv(&li->li_tv, rettv);
13140 else
13141 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13142 (int)(regmatch.endp[0] - regmatch.startp[0]));
13144 else if (l != NULL)
13145 rettv->vval.v_number = idx;
13146 else
13148 if (type != 0)
13149 rettv->vval.v_number =
13150 (varnumber_T)(regmatch.startp[0] - str);
13151 else
13152 rettv->vval.v_number =
13153 (varnumber_T)(regmatch.endp[0] - str);
13154 rettv->vval.v_number += (varnumber_T)(str - expr);
13157 vim_free(regmatch.regprog);
13160 theend:
13161 vim_free(tofree);
13162 p_cpo = save_cpo;
13166 * "match()" function
13168 static void
13169 f_match(argvars, rettv)
13170 typval_T *argvars;
13171 typval_T *rettv;
13173 find_some_match(argvars, rettv, 1);
13177 * "matchadd()" function
13179 static void
13180 f_matchadd(argvars, rettv)
13181 typval_T *argvars;
13182 typval_T *rettv;
13184 #ifdef FEAT_SEARCH_EXTRA
13185 char_u buf[NUMBUFLEN];
13186 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13187 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13188 int prio = 10; /* default priority */
13189 int id = -1;
13190 int error = FALSE;
13192 rettv->vval.v_number = -1;
13194 if (grp == NULL || pat == NULL)
13195 return;
13196 if (argvars[2].v_type != VAR_UNKNOWN)
13198 prio = get_tv_number_chk(&argvars[2], &error);
13199 if (argvars[3].v_type != VAR_UNKNOWN)
13200 id = get_tv_number_chk(&argvars[3], &error);
13202 if (error == TRUE)
13203 return;
13204 if (id >= 1 && id <= 3)
13206 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13207 return;
13210 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13211 #endif
13215 * "matcharg()" function
13217 static void
13218 f_matcharg(argvars, rettv)
13219 typval_T *argvars;
13220 typval_T *rettv;
13222 if (rettv_list_alloc(rettv) == OK)
13224 #ifdef FEAT_SEARCH_EXTRA
13225 int id = get_tv_number(&argvars[0]);
13226 matchitem_T *m;
13228 if (id >= 1 && id <= 3)
13230 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13232 list_append_string(rettv->vval.v_list,
13233 syn_id2name(m->hlg_id), -1);
13234 list_append_string(rettv->vval.v_list, m->pattern, -1);
13236 else
13238 list_append_string(rettv->vval.v_list, NUL, -1);
13239 list_append_string(rettv->vval.v_list, NUL, -1);
13242 #endif
13247 * "matchdelete()" function
13249 static void
13250 f_matchdelete(argvars, rettv)
13251 typval_T *argvars;
13252 typval_T *rettv;
13254 #ifdef FEAT_SEARCH_EXTRA
13255 rettv->vval.v_number = match_delete(curwin,
13256 (int)get_tv_number(&argvars[0]), TRUE);
13257 #endif
13261 * "matchend()" function
13263 static void
13264 f_matchend(argvars, rettv)
13265 typval_T *argvars;
13266 typval_T *rettv;
13268 find_some_match(argvars, rettv, 0);
13272 * "matchlist()" function
13274 static void
13275 f_matchlist(argvars, rettv)
13276 typval_T *argvars;
13277 typval_T *rettv;
13279 find_some_match(argvars, rettv, 3);
13283 * "matchstr()" function
13285 static void
13286 f_matchstr(argvars, rettv)
13287 typval_T *argvars;
13288 typval_T *rettv;
13290 find_some_match(argvars, rettv, 2);
13293 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13295 static void
13296 max_min(argvars, rettv, domax)
13297 typval_T *argvars;
13298 typval_T *rettv;
13299 int domax;
13301 long n = 0;
13302 long i;
13303 int error = FALSE;
13305 if (argvars[0].v_type == VAR_LIST)
13307 list_T *l;
13308 listitem_T *li;
13310 l = argvars[0].vval.v_list;
13311 if (l != NULL)
13313 li = l->lv_first;
13314 if (li != NULL)
13316 n = get_tv_number_chk(&li->li_tv, &error);
13317 for (;;)
13319 li = li->li_next;
13320 if (li == NULL)
13321 break;
13322 i = get_tv_number_chk(&li->li_tv, &error);
13323 if (domax ? i > n : i < n)
13324 n = i;
13329 else if (argvars[0].v_type == VAR_DICT)
13331 dict_T *d;
13332 int first = TRUE;
13333 hashitem_T *hi;
13334 int todo;
13336 d = argvars[0].vval.v_dict;
13337 if (d != NULL)
13339 todo = (int)d->dv_hashtab.ht_used;
13340 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13342 if (!HASHITEM_EMPTY(hi))
13344 --todo;
13345 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13346 if (first)
13348 n = i;
13349 first = FALSE;
13351 else if (domax ? i > n : i < n)
13352 n = i;
13357 else
13358 EMSG(_(e_listdictarg));
13359 rettv->vval.v_number = error ? 0 : n;
13363 * "max()" function
13365 static void
13366 f_max(argvars, rettv)
13367 typval_T *argvars;
13368 typval_T *rettv;
13370 max_min(argvars, rettv, TRUE);
13374 * "min()" function
13376 static void
13377 f_min(argvars, rettv)
13378 typval_T *argvars;
13379 typval_T *rettv;
13381 max_min(argvars, rettv, FALSE);
13384 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13387 * Create the directory in which "dir" is located, and higher levels when
13388 * needed.
13390 static int
13391 mkdir_recurse(dir, prot)
13392 char_u *dir;
13393 int prot;
13395 char_u *p;
13396 char_u *updir;
13397 int r = FAIL;
13399 /* Get end of directory name in "dir".
13400 * We're done when it's "/" or "c:/". */
13401 p = gettail_sep(dir);
13402 if (p <= get_past_head(dir))
13403 return OK;
13405 /* If the directory exists we're done. Otherwise: create it.*/
13406 updir = vim_strnsave(dir, (int)(p - dir));
13407 if (updir == NULL)
13408 return FAIL;
13409 if (mch_isdir(updir))
13410 r = OK;
13411 else if (mkdir_recurse(updir, prot) == OK)
13412 r = vim_mkdir_emsg(updir, prot);
13413 vim_free(updir);
13414 return r;
13417 #ifdef vim_mkdir
13419 * "mkdir()" function
13421 static void
13422 f_mkdir(argvars, rettv)
13423 typval_T *argvars;
13424 typval_T *rettv;
13426 char_u *dir;
13427 char_u buf[NUMBUFLEN];
13428 int prot = 0755;
13430 rettv->vval.v_number = FAIL;
13431 if (check_restricted() || check_secure())
13432 return;
13434 dir = get_tv_string_buf(&argvars[0], buf);
13435 if (argvars[1].v_type != VAR_UNKNOWN)
13437 if (argvars[2].v_type != VAR_UNKNOWN)
13438 prot = get_tv_number_chk(&argvars[2], NULL);
13439 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13440 mkdir_recurse(dir, prot);
13442 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13444 #endif
13447 * "mode()" function
13449 /*ARGSUSED*/
13450 static void
13451 f_mode(argvars, rettv)
13452 typval_T *argvars;
13453 typval_T *rettv;
13455 char_u buf[3];
13457 buf[1] = NUL;
13458 buf[2] = NUL;
13460 #ifdef FEAT_VISUAL
13461 if (VIsual_active)
13463 if (VIsual_select)
13464 buf[0] = VIsual_mode + 's' - 'v';
13465 else
13466 buf[0] = VIsual_mode;
13468 else
13469 #endif
13470 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13471 || State == CONFIRM)
13473 buf[0] = 'r';
13474 if (State == ASKMORE)
13475 buf[1] = 'm';
13476 else if (State == CONFIRM)
13477 buf[1] = '?';
13479 else if (State == EXTERNCMD)
13480 buf[0] = '!';
13481 else if (State & INSERT)
13483 #ifdef FEAT_VREPLACE
13484 if (State & VREPLACE_FLAG)
13486 buf[0] = 'R';
13487 buf[1] = 'v';
13489 else
13490 #endif
13491 if (State & REPLACE_FLAG)
13492 buf[0] = 'R';
13493 else
13494 buf[0] = 'i';
13496 else if (State & CMDLINE)
13498 buf[0] = 'c';
13499 if (exmode_active)
13500 buf[1] = 'v';
13502 else if (exmode_active)
13504 buf[0] = 'c';
13505 buf[1] = 'e';
13507 else
13509 buf[0] = 'n';
13510 if (finish_op)
13511 buf[1] = 'o';
13514 /* Clear out the minor mode when the argument is not a non-zero number or
13515 * non-empty string. */
13516 if (!non_zero_arg(&argvars[0]))
13517 buf[1] = NUL;
13519 rettv->vval.v_string = vim_strsave(buf);
13520 rettv->v_type = VAR_STRING;
13524 * "nextnonblank()" function
13526 static void
13527 f_nextnonblank(argvars, rettv)
13528 typval_T *argvars;
13529 typval_T *rettv;
13531 linenr_T lnum;
13533 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13535 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13537 lnum = 0;
13538 break;
13540 if (*skipwhite(ml_get(lnum)) != NUL)
13541 break;
13543 rettv->vval.v_number = lnum;
13547 * "nr2char()" function
13549 static void
13550 f_nr2char(argvars, rettv)
13551 typval_T *argvars;
13552 typval_T *rettv;
13554 char_u buf[NUMBUFLEN];
13556 #ifdef FEAT_MBYTE
13557 if (has_mbyte)
13558 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13559 else
13560 #endif
13562 buf[0] = (char_u)get_tv_number(&argvars[0]);
13563 buf[1] = NUL;
13565 rettv->v_type = VAR_STRING;
13566 rettv->vval.v_string = vim_strsave(buf);
13570 * "pathshorten()" function
13572 static void
13573 f_pathshorten(argvars, rettv)
13574 typval_T *argvars;
13575 typval_T *rettv;
13577 char_u *p;
13579 rettv->v_type = VAR_STRING;
13580 p = get_tv_string_chk(&argvars[0]);
13581 if (p == NULL)
13582 rettv->vval.v_string = NULL;
13583 else
13585 p = vim_strsave(p);
13586 rettv->vval.v_string = p;
13587 if (p != NULL)
13588 shorten_dir(p);
13592 #ifdef FEAT_FLOAT
13594 * "pow()" function
13596 static void
13597 f_pow(argvars, rettv)
13598 typval_T *argvars;
13599 typval_T *rettv;
13601 float_T fx, fy;
13603 rettv->v_type = VAR_FLOAT;
13604 if (get_float_arg(argvars, &fx) == OK
13605 && get_float_arg(&argvars[1], &fy) == OK)
13606 rettv->vval.v_float = pow(fx, fy);
13607 else
13608 rettv->vval.v_float = 0.0;
13610 #endif
13613 * "prevnonblank()" function
13615 static void
13616 f_prevnonblank(argvars, rettv)
13617 typval_T *argvars;
13618 typval_T *rettv;
13620 linenr_T lnum;
13622 lnum = get_tv_lnum(argvars);
13623 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13624 lnum = 0;
13625 else
13626 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13627 --lnum;
13628 rettv->vval.v_number = lnum;
13631 #ifdef HAVE_STDARG_H
13632 /* This dummy va_list is here because:
13633 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13634 * - locally in the function results in a "used before set" warning
13635 * - using va_start() to initialize it gives "function with fixed args" error */
13636 static va_list ap;
13637 #endif
13640 * "printf()" function
13642 static void
13643 f_printf(argvars, rettv)
13644 typval_T *argvars;
13645 typval_T *rettv;
13647 rettv->v_type = VAR_STRING;
13648 rettv->vval.v_string = NULL;
13649 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13651 char_u buf[NUMBUFLEN];
13652 int len;
13653 char_u *s;
13654 int saved_did_emsg = did_emsg;
13655 char *fmt;
13657 /* Get the required length, allocate the buffer and do it for real. */
13658 did_emsg = FALSE;
13659 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13660 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13661 if (!did_emsg)
13663 s = alloc(len + 1);
13664 if (s != NULL)
13666 rettv->vval.v_string = s;
13667 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13670 did_emsg |= saved_did_emsg;
13672 #endif
13676 * "pumvisible()" function
13678 /*ARGSUSED*/
13679 static void
13680 f_pumvisible(argvars, rettv)
13681 typval_T *argvars;
13682 typval_T *rettv;
13684 rettv->vval.v_number = 0;
13685 #ifdef FEAT_INS_EXPAND
13686 if (pum_visible())
13687 rettv->vval.v_number = 1;
13688 #endif
13692 * "range()" function
13694 static void
13695 f_range(argvars, rettv)
13696 typval_T *argvars;
13697 typval_T *rettv;
13699 long start;
13700 long end;
13701 long stride = 1;
13702 long i;
13703 int error = FALSE;
13705 start = get_tv_number_chk(&argvars[0], &error);
13706 if (argvars[1].v_type == VAR_UNKNOWN)
13708 end = start - 1;
13709 start = 0;
13711 else
13713 end = get_tv_number_chk(&argvars[1], &error);
13714 if (argvars[2].v_type != VAR_UNKNOWN)
13715 stride = get_tv_number_chk(&argvars[2], &error);
13718 rettv->vval.v_number = 0;
13719 if (error)
13720 return; /* type error; errmsg already given */
13721 if (stride == 0)
13722 EMSG(_("E726: Stride is zero"));
13723 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13724 EMSG(_("E727: Start past end"));
13725 else
13727 if (rettv_list_alloc(rettv) == OK)
13728 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13729 if (list_append_number(rettv->vval.v_list,
13730 (varnumber_T)i) == FAIL)
13731 break;
13736 * "readfile()" function
13738 static void
13739 f_readfile(argvars, rettv)
13740 typval_T *argvars;
13741 typval_T *rettv;
13743 int binary = FALSE;
13744 char_u *fname;
13745 FILE *fd;
13746 listitem_T *li;
13747 #define FREAD_SIZE 200 /* optimized for text lines */
13748 char_u buf[FREAD_SIZE];
13749 int readlen; /* size of last fread() */
13750 int buflen; /* nr of valid chars in buf[] */
13751 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13752 int tolist; /* first byte in buf[] still to be put in list */
13753 int chop; /* how many CR to chop off */
13754 char_u *prev = NULL; /* previously read bytes, if any */
13755 int prevlen = 0; /* length of "prev" if not NULL */
13756 char_u *s;
13757 int len;
13758 long maxline = MAXLNUM;
13759 long cnt = 0;
13761 if (argvars[1].v_type != VAR_UNKNOWN)
13763 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13764 binary = TRUE;
13765 if (argvars[2].v_type != VAR_UNKNOWN)
13766 maxline = get_tv_number(&argvars[2]);
13769 if (rettv_list_alloc(rettv) == FAIL)
13770 return;
13772 /* Always open the file in binary mode, library functions have a mind of
13773 * their own about CR-LF conversion. */
13774 fname = get_tv_string(&argvars[0]);
13775 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13777 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13778 return;
13781 filtd = 0;
13782 while (cnt < maxline || maxline < 0)
13784 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13785 buflen = filtd + readlen;
13786 tolist = 0;
13787 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13789 if (buf[filtd] == '\n' || readlen <= 0)
13791 /* Only when in binary mode add an empty list item when the
13792 * last line ends in a '\n'. */
13793 if (!binary && readlen == 0 && filtd == 0)
13794 break;
13796 /* Found end-of-line or end-of-file: add a text line to the
13797 * list. */
13798 chop = 0;
13799 if (!binary)
13800 while (filtd - chop - 1 >= tolist
13801 && buf[filtd - chop - 1] == '\r')
13802 ++chop;
13803 len = filtd - tolist - chop;
13804 if (prev == NULL)
13805 s = vim_strnsave(buf + tolist, len);
13806 else
13808 s = alloc((unsigned)(prevlen + len + 1));
13809 if (s != NULL)
13811 mch_memmove(s, prev, prevlen);
13812 vim_free(prev);
13813 prev = NULL;
13814 mch_memmove(s + prevlen, buf + tolist, len);
13815 s[prevlen + len] = NUL;
13818 tolist = filtd + 1;
13820 li = listitem_alloc();
13821 if (li == NULL)
13823 vim_free(s);
13824 break;
13826 li->li_tv.v_type = VAR_STRING;
13827 li->li_tv.v_lock = 0;
13828 li->li_tv.vval.v_string = s;
13829 list_append(rettv->vval.v_list, li);
13831 if (++cnt >= maxline && maxline >= 0)
13832 break;
13833 if (readlen <= 0)
13834 break;
13836 else if (buf[filtd] == NUL)
13837 buf[filtd] = '\n';
13839 if (readlen <= 0)
13840 break;
13842 if (tolist == 0)
13844 /* "buf" is full, need to move text to an allocated buffer */
13845 if (prev == NULL)
13847 prev = vim_strnsave(buf, buflen);
13848 prevlen = buflen;
13850 else
13852 s = alloc((unsigned)(prevlen + buflen));
13853 if (s != NULL)
13855 mch_memmove(s, prev, prevlen);
13856 mch_memmove(s + prevlen, buf, buflen);
13857 vim_free(prev);
13858 prev = s;
13859 prevlen += buflen;
13862 filtd = 0;
13864 else
13866 mch_memmove(buf, buf + tolist, buflen - tolist);
13867 filtd -= tolist;
13872 * For a negative line count use only the lines at the end of the file,
13873 * free the rest.
13875 if (maxline < 0)
13876 while (cnt > -maxline)
13878 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13879 --cnt;
13882 vim_free(prev);
13883 fclose(fd);
13886 #if defined(FEAT_RELTIME)
13887 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13890 * Convert a List to proftime_T.
13891 * Return FAIL when there is something wrong.
13893 static int
13894 list2proftime(arg, tm)
13895 typval_T *arg;
13896 proftime_T *tm;
13898 long n1, n2;
13899 int error = FALSE;
13901 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13902 || arg->vval.v_list->lv_len != 2)
13903 return FAIL;
13904 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13905 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13906 # ifdef WIN3264
13907 tm->HighPart = n1;
13908 tm->LowPart = n2;
13909 # else
13910 tm->tv_sec = n1;
13911 tm->tv_usec = n2;
13912 # endif
13913 return error ? FAIL : OK;
13915 #endif /* FEAT_RELTIME */
13918 * "reltime()" function
13920 static void
13921 f_reltime(argvars, rettv)
13922 typval_T *argvars;
13923 typval_T *rettv;
13925 #ifdef FEAT_RELTIME
13926 proftime_T res;
13927 proftime_T start;
13929 if (argvars[0].v_type == VAR_UNKNOWN)
13931 /* No arguments: get current time. */
13932 profile_start(&res);
13934 else if (argvars[1].v_type == VAR_UNKNOWN)
13936 if (list2proftime(&argvars[0], &res) == FAIL)
13937 return;
13938 profile_end(&res);
13940 else
13942 /* Two arguments: compute the difference. */
13943 if (list2proftime(&argvars[0], &start) == FAIL
13944 || list2proftime(&argvars[1], &res) == FAIL)
13945 return;
13946 profile_sub(&res, &start);
13949 if (rettv_list_alloc(rettv) == OK)
13951 long n1, n2;
13953 # ifdef WIN3264
13954 n1 = res.HighPart;
13955 n2 = res.LowPart;
13956 # else
13957 n1 = res.tv_sec;
13958 n2 = res.tv_usec;
13959 # endif
13960 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
13961 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
13963 #endif
13967 * "reltimestr()" function
13969 static void
13970 f_reltimestr(argvars, rettv)
13971 typval_T *argvars;
13972 typval_T *rettv;
13974 #ifdef FEAT_RELTIME
13975 proftime_T tm;
13976 #endif
13978 rettv->v_type = VAR_STRING;
13979 rettv->vval.v_string = NULL;
13980 #ifdef FEAT_RELTIME
13981 if (list2proftime(&argvars[0], &tm) == OK)
13982 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
13983 #endif
13986 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
13987 static void make_connection __ARGS((void));
13988 static int check_connection __ARGS((void));
13990 static void
13991 make_connection()
13993 if (X_DISPLAY == NULL
13994 # ifdef FEAT_GUI
13995 && !gui.in_use
13996 # endif
13999 x_force_connect = TRUE;
14000 setup_term_clip();
14001 x_force_connect = FALSE;
14005 static int
14006 check_connection()
14008 make_connection();
14009 if (X_DISPLAY == NULL)
14011 EMSG(_("E240: No connection to Vim server"));
14012 return FAIL;
14014 return OK;
14016 #endif
14018 #ifdef FEAT_CLIENTSERVER
14019 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14021 static void
14022 remote_common(argvars, rettv, expr)
14023 typval_T *argvars;
14024 typval_T *rettv;
14025 int expr;
14027 char_u *server_name;
14028 char_u *keys;
14029 char_u *r = NULL;
14030 char_u buf[NUMBUFLEN];
14031 # ifdef WIN32
14032 HWND w;
14033 # elif defined(FEAT_X11)
14034 Window w;
14035 # elif defined(MAC_CLIENTSERVER)
14036 int w; // This is the port number ('w' is a bit confusing)
14037 # endif
14039 if (check_restricted() || check_secure())
14040 return;
14042 # ifdef FEAT_X11
14043 if (check_connection() == FAIL)
14044 return;
14045 # endif
14047 server_name = get_tv_string_chk(&argvars[0]);
14048 if (server_name == NULL)
14049 return; /* type error; errmsg already given */
14050 keys = get_tv_string_buf(&argvars[1], buf);
14051 # ifdef WIN32
14052 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14053 # elif defined(FEAT_X11)
14054 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14055 < 0)
14056 # elif defined(MAC_CLIENTSERVER)
14057 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14058 # endif
14060 if (r != NULL)
14061 EMSG(r); /* sending worked but evaluation failed */
14062 else
14063 EMSG2(_("E241: Unable to send to %s"), server_name);
14064 return;
14067 rettv->vval.v_string = r;
14069 if (argvars[2].v_type != VAR_UNKNOWN)
14071 dictitem_T v;
14072 char_u str[30];
14073 char_u *idvar;
14075 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14076 v.di_tv.v_type = VAR_STRING;
14077 v.di_tv.vval.v_string = vim_strsave(str);
14078 idvar = get_tv_string_chk(&argvars[2]);
14079 if (idvar != NULL)
14080 set_var(idvar, &v.di_tv, FALSE);
14081 vim_free(v.di_tv.vval.v_string);
14084 #endif
14087 * "remote_expr()" function
14089 /*ARGSUSED*/
14090 static void
14091 f_remote_expr(argvars, rettv)
14092 typval_T *argvars;
14093 typval_T *rettv;
14095 rettv->v_type = VAR_STRING;
14096 rettv->vval.v_string = NULL;
14097 #ifdef FEAT_CLIENTSERVER
14098 remote_common(argvars, rettv, TRUE);
14099 #endif
14103 * "remote_foreground()" function
14105 /*ARGSUSED*/
14106 static void
14107 f_remote_foreground(argvars, rettv)
14108 typval_T *argvars;
14109 typval_T *rettv;
14111 rettv->vval.v_number = 0;
14112 #ifdef FEAT_CLIENTSERVER
14113 # ifdef WIN32
14114 /* On Win32 it's done in this application. */
14116 char_u *server_name = get_tv_string_chk(&argvars[0]);
14118 if (server_name != NULL)
14119 serverForeground(server_name);
14121 # elif defined(FEAT_X11) || defined(MAC_CLIENTSERVER)
14122 /* Send a foreground() expression to the server. */
14123 argvars[1].v_type = VAR_STRING;
14124 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14125 argvars[2].v_type = VAR_UNKNOWN;
14126 remote_common(argvars, rettv, TRUE);
14127 vim_free(argvars[1].vval.v_string);
14128 # endif
14129 #endif
14132 /*ARGSUSED*/
14133 static void
14134 f_remote_peek(argvars, rettv)
14135 typval_T *argvars;
14136 typval_T *rettv;
14138 #ifdef FEAT_CLIENTSERVER
14139 dictitem_T v;
14140 char_u *s = NULL;
14141 # ifdef WIN32
14142 long_u n = 0;
14143 # endif
14144 char_u *serverid;
14146 if (check_restricted() || check_secure())
14148 rettv->vval.v_number = -1;
14149 return;
14151 serverid = get_tv_string_chk(&argvars[0]);
14152 if (serverid == NULL)
14154 rettv->vval.v_number = -1;
14155 return; /* type error; errmsg already given */
14157 # ifdef WIN32
14158 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14159 if (n == 0)
14160 rettv->vval.v_number = -1;
14161 else
14163 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14164 rettv->vval.v_number = (s != NULL);
14166 # elif defined(FEAT_X11)
14167 rettv->vval.v_number = 0;
14168 if (check_connection() == FAIL)
14169 return;
14171 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14172 serverStrToWin(serverid), &s);
14173 # elif defined(MAC_CLIENTSERVER)
14174 rettv->vval.v_number = serverPeekReply(serverStrToPort(serverid), &s);
14175 # endif
14177 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14179 char_u *retvar;
14181 v.di_tv.v_type = VAR_STRING;
14182 v.di_tv.vval.v_string = vim_strsave(s);
14183 retvar = get_tv_string_chk(&argvars[1]);
14184 if (retvar != NULL)
14185 set_var(retvar, &v.di_tv, FALSE);
14186 vim_free(v.di_tv.vval.v_string);
14188 #else
14189 rettv->vval.v_number = -1;
14190 #endif
14193 /*ARGSUSED*/
14194 static void
14195 f_remote_read(argvars, rettv)
14196 typval_T *argvars;
14197 typval_T *rettv;
14199 char_u *r = NULL;
14201 #ifdef FEAT_CLIENTSERVER
14202 char_u *serverid = get_tv_string_chk(&argvars[0]);
14204 if (serverid != NULL && !check_restricted() && !check_secure())
14206 # ifdef WIN32
14207 /* The server's HWND is encoded in the 'id' parameter */
14208 long_u n = 0;
14210 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14211 if (n != 0)
14212 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14213 if (r == NULL)
14214 # elif defined(FEAT_X11)
14215 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14216 serverStrToWin(serverid), &r, FALSE) < 0)
14217 # elif defined(MAC_CLIENTSERVER)
14218 if (serverReadReply(serverStrToPort(serverid), &r) < 0)
14219 # endif
14220 EMSG(_("E277: Unable to read a server reply"));
14222 #endif
14223 rettv->v_type = VAR_STRING;
14224 rettv->vval.v_string = r;
14228 * "remote_send()" function
14230 /*ARGSUSED*/
14231 static void
14232 f_remote_send(argvars, rettv)
14233 typval_T *argvars;
14234 typval_T *rettv;
14236 rettv->v_type = VAR_STRING;
14237 rettv->vval.v_string = NULL;
14238 #ifdef FEAT_CLIENTSERVER
14239 remote_common(argvars, rettv, FALSE);
14240 #endif
14244 * "remove()" function
14246 static void
14247 f_remove(argvars, rettv)
14248 typval_T *argvars;
14249 typval_T *rettv;
14251 list_T *l;
14252 listitem_T *item, *item2;
14253 listitem_T *li;
14254 long idx;
14255 long end;
14256 char_u *key;
14257 dict_T *d;
14258 dictitem_T *di;
14260 rettv->vval.v_number = 0;
14261 if (argvars[0].v_type == VAR_DICT)
14263 if (argvars[2].v_type != VAR_UNKNOWN)
14264 EMSG2(_(e_toomanyarg), "remove()");
14265 else if ((d = argvars[0].vval.v_dict) != NULL
14266 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14268 key = get_tv_string_chk(&argvars[1]);
14269 if (key != NULL)
14271 di = dict_find(d, key, -1);
14272 if (di == NULL)
14273 EMSG2(_(e_dictkey), key);
14274 else
14276 *rettv = di->di_tv;
14277 init_tv(&di->di_tv);
14278 dictitem_remove(d, di);
14283 else if (argvars[0].v_type != VAR_LIST)
14284 EMSG2(_(e_listdictarg), "remove()");
14285 else if ((l = argvars[0].vval.v_list) != NULL
14286 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14288 int error = FALSE;
14290 idx = get_tv_number_chk(&argvars[1], &error);
14291 if (error)
14292 ; /* type error: do nothing, errmsg already given */
14293 else if ((item = list_find(l, idx)) == NULL)
14294 EMSGN(_(e_listidx), idx);
14295 else
14297 if (argvars[2].v_type == VAR_UNKNOWN)
14299 /* Remove one item, return its value. */
14300 list_remove(l, item, item);
14301 *rettv = item->li_tv;
14302 vim_free(item);
14304 else
14306 /* Remove range of items, return list with values. */
14307 end = get_tv_number_chk(&argvars[2], &error);
14308 if (error)
14309 ; /* type error: do nothing */
14310 else if ((item2 = list_find(l, end)) == NULL)
14311 EMSGN(_(e_listidx), end);
14312 else
14314 int cnt = 0;
14316 for (li = item; li != NULL; li = li->li_next)
14318 ++cnt;
14319 if (li == item2)
14320 break;
14322 if (li == NULL) /* didn't find "item2" after "item" */
14323 EMSG(_(e_invrange));
14324 else
14326 list_remove(l, item, item2);
14327 if (rettv_list_alloc(rettv) == OK)
14329 l = rettv->vval.v_list;
14330 l->lv_first = item;
14331 l->lv_last = item2;
14332 item->li_prev = NULL;
14333 item2->li_next = NULL;
14334 l->lv_len = cnt;
14344 * "rename({from}, {to})" function
14346 static void
14347 f_rename(argvars, rettv)
14348 typval_T *argvars;
14349 typval_T *rettv;
14351 char_u buf[NUMBUFLEN];
14353 if (check_restricted() || check_secure())
14354 rettv->vval.v_number = -1;
14355 else
14356 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14357 get_tv_string_buf(&argvars[1], buf));
14361 * "repeat()" function
14363 /*ARGSUSED*/
14364 static void
14365 f_repeat(argvars, rettv)
14366 typval_T *argvars;
14367 typval_T *rettv;
14369 char_u *p;
14370 int n;
14371 int slen;
14372 int len;
14373 char_u *r;
14374 int i;
14376 n = get_tv_number(&argvars[1]);
14377 if (argvars[0].v_type == VAR_LIST)
14379 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14380 while (n-- > 0)
14381 if (list_extend(rettv->vval.v_list,
14382 argvars[0].vval.v_list, NULL) == FAIL)
14383 break;
14385 else
14387 p = get_tv_string(&argvars[0]);
14388 rettv->v_type = VAR_STRING;
14389 rettv->vval.v_string = NULL;
14391 slen = (int)STRLEN(p);
14392 len = slen * n;
14393 if (len <= 0)
14394 return;
14396 r = alloc(len + 1);
14397 if (r != NULL)
14399 for (i = 0; i < n; i++)
14400 mch_memmove(r + i * slen, p, (size_t)slen);
14401 r[len] = NUL;
14404 rettv->vval.v_string = r;
14409 * "resolve()" function
14411 static void
14412 f_resolve(argvars, rettv)
14413 typval_T *argvars;
14414 typval_T *rettv;
14416 char_u *p;
14418 p = get_tv_string(&argvars[0]);
14419 #ifdef FEAT_SHORTCUT
14421 char_u *v = NULL;
14423 v = mch_resolve_shortcut(p);
14424 if (v != NULL)
14425 rettv->vval.v_string = v;
14426 else
14427 rettv->vval.v_string = vim_strsave(p);
14429 #else
14430 # ifdef HAVE_READLINK
14432 char_u buf[MAXPATHL + 1];
14433 char_u *cpy;
14434 int len;
14435 char_u *remain = NULL;
14436 char_u *q;
14437 int is_relative_to_current = FALSE;
14438 int has_trailing_pathsep = FALSE;
14439 int limit = 100;
14441 p = vim_strsave(p);
14443 if (p[0] == '.' && (vim_ispathsep(p[1])
14444 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14445 is_relative_to_current = TRUE;
14447 len = STRLEN(p);
14448 if (len > 0 && after_pathsep(p, p + len))
14449 has_trailing_pathsep = TRUE;
14451 q = getnextcomp(p);
14452 if (*q != NUL)
14454 /* Separate the first path component in "p", and keep the
14455 * remainder (beginning with the path separator). */
14456 remain = vim_strsave(q - 1);
14457 q[-1] = NUL;
14460 for (;;)
14462 for (;;)
14464 len = readlink((char *)p, (char *)buf, MAXPATHL);
14465 if (len <= 0)
14466 break;
14467 buf[len] = NUL;
14469 if (limit-- == 0)
14471 vim_free(p);
14472 vim_free(remain);
14473 EMSG(_("E655: Too many symbolic links (cycle?)"));
14474 rettv->vval.v_string = NULL;
14475 goto fail;
14478 /* Ensure that the result will have a trailing path separator
14479 * if the argument has one. */
14480 if (remain == NULL && has_trailing_pathsep)
14481 add_pathsep(buf);
14483 /* Separate the first path component in the link value and
14484 * concatenate the remainders. */
14485 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14486 if (*q != NUL)
14488 if (remain == NULL)
14489 remain = vim_strsave(q - 1);
14490 else
14492 cpy = concat_str(q - 1, remain);
14493 if (cpy != NULL)
14495 vim_free(remain);
14496 remain = cpy;
14499 q[-1] = NUL;
14502 q = gettail(p);
14503 if (q > p && *q == NUL)
14505 /* Ignore trailing path separator. */
14506 q[-1] = NUL;
14507 q = gettail(p);
14509 if (q > p && !mch_isFullName(buf))
14511 /* symlink is relative to directory of argument */
14512 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14513 if (cpy != NULL)
14515 STRCPY(cpy, p);
14516 STRCPY(gettail(cpy), buf);
14517 vim_free(p);
14518 p = cpy;
14521 else
14523 vim_free(p);
14524 p = vim_strsave(buf);
14528 if (remain == NULL)
14529 break;
14531 /* Append the first path component of "remain" to "p". */
14532 q = getnextcomp(remain + 1);
14533 len = q - remain - (*q != NUL);
14534 cpy = vim_strnsave(p, STRLEN(p) + len);
14535 if (cpy != NULL)
14537 STRNCAT(cpy, remain, len);
14538 vim_free(p);
14539 p = cpy;
14541 /* Shorten "remain". */
14542 if (*q != NUL)
14543 STRMOVE(remain, q - 1);
14544 else
14546 vim_free(remain);
14547 remain = NULL;
14551 /* If the result is a relative path name, make it explicitly relative to
14552 * the current directory if and only if the argument had this form. */
14553 if (!vim_ispathsep(*p))
14555 if (is_relative_to_current
14556 && *p != NUL
14557 && !(p[0] == '.'
14558 && (p[1] == NUL
14559 || vim_ispathsep(p[1])
14560 || (p[1] == '.'
14561 && (p[2] == NUL
14562 || vim_ispathsep(p[2]))))))
14564 /* Prepend "./". */
14565 cpy = concat_str((char_u *)"./", p);
14566 if (cpy != NULL)
14568 vim_free(p);
14569 p = cpy;
14572 else if (!is_relative_to_current)
14574 /* Strip leading "./". */
14575 q = p;
14576 while (q[0] == '.' && vim_ispathsep(q[1]))
14577 q += 2;
14578 if (q > p)
14579 STRMOVE(p, p + 2);
14583 /* Ensure that the result will have no trailing path separator
14584 * if the argument had none. But keep "/" or "//". */
14585 if (!has_trailing_pathsep)
14587 q = p + STRLEN(p);
14588 if (after_pathsep(p, q))
14589 *gettail_sep(p) = NUL;
14592 rettv->vval.v_string = p;
14594 # else
14595 rettv->vval.v_string = vim_strsave(p);
14596 # endif
14597 #endif
14599 simplify_filename(rettv->vval.v_string);
14601 #ifdef HAVE_READLINK
14602 fail:
14603 #endif
14604 rettv->v_type = VAR_STRING;
14608 * "reverse({list})" function
14610 static void
14611 f_reverse(argvars, rettv)
14612 typval_T *argvars;
14613 typval_T *rettv;
14615 list_T *l;
14616 listitem_T *li, *ni;
14618 rettv->vval.v_number = 0;
14619 if (argvars[0].v_type != VAR_LIST)
14620 EMSG2(_(e_listarg), "reverse()");
14621 else if ((l = argvars[0].vval.v_list) != NULL
14622 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14624 li = l->lv_last;
14625 l->lv_first = l->lv_last = NULL;
14626 l->lv_len = 0;
14627 while (li != NULL)
14629 ni = li->li_prev;
14630 list_append(l, li);
14631 li = ni;
14633 rettv->vval.v_list = l;
14634 rettv->v_type = VAR_LIST;
14635 ++l->lv_refcount;
14636 l->lv_idx = l->lv_len - l->lv_idx - 1;
14640 #define SP_NOMOVE 0x01 /* don't move cursor */
14641 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14642 #define SP_RETCOUNT 0x04 /* return matchcount */
14643 #define SP_SETPCMARK 0x08 /* set previous context mark */
14644 #define SP_START 0x10 /* accept match at start position */
14645 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14646 #define SP_END 0x40 /* leave cursor at end of match */
14648 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14651 * Get flags for a search function.
14652 * Possibly sets "p_ws".
14653 * Returns BACKWARD, FORWARD or zero (for an error).
14655 static int
14656 get_search_arg(varp, flagsp)
14657 typval_T *varp;
14658 int *flagsp;
14660 int dir = FORWARD;
14661 char_u *flags;
14662 char_u nbuf[NUMBUFLEN];
14663 int mask;
14665 if (varp->v_type != VAR_UNKNOWN)
14667 flags = get_tv_string_buf_chk(varp, nbuf);
14668 if (flags == NULL)
14669 return 0; /* type error; errmsg already given */
14670 while (*flags != NUL)
14672 switch (*flags)
14674 case 'b': dir = BACKWARD; break;
14675 case 'w': p_ws = TRUE; break;
14676 case 'W': p_ws = FALSE; break;
14677 default: mask = 0;
14678 if (flagsp != NULL)
14679 switch (*flags)
14681 case 'c': mask = SP_START; break;
14682 case 'e': mask = SP_END; break;
14683 case 'm': mask = SP_RETCOUNT; break;
14684 case 'n': mask = SP_NOMOVE; break;
14685 case 'p': mask = SP_SUBPAT; break;
14686 case 'r': mask = SP_REPEAT; break;
14687 case 's': mask = SP_SETPCMARK; break;
14689 if (mask == 0)
14691 EMSG2(_(e_invarg2), flags);
14692 dir = 0;
14694 else
14695 *flagsp |= mask;
14697 if (dir == 0)
14698 break;
14699 ++flags;
14702 return dir;
14706 * Shared by search() and searchpos() functions
14708 static int
14709 search_cmn(argvars, match_pos, flagsp)
14710 typval_T *argvars;
14711 pos_T *match_pos;
14712 int *flagsp;
14714 int flags;
14715 char_u *pat;
14716 pos_T pos;
14717 pos_T save_cursor;
14718 int save_p_ws = p_ws;
14719 int dir;
14720 int retval = 0; /* default: FAIL */
14721 long lnum_stop = 0;
14722 proftime_T tm;
14723 #ifdef FEAT_RELTIME
14724 long time_limit = 0;
14725 #endif
14726 int options = SEARCH_KEEP;
14727 int subpatnum;
14729 pat = get_tv_string(&argvars[0]);
14730 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14731 if (dir == 0)
14732 goto theend;
14733 flags = *flagsp;
14734 if (flags & SP_START)
14735 options |= SEARCH_START;
14736 if (flags & SP_END)
14737 options |= SEARCH_END;
14739 /* Optional arguments: line number to stop searching and timeout. */
14740 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14742 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14743 if (lnum_stop < 0)
14744 goto theend;
14745 #ifdef FEAT_RELTIME
14746 if (argvars[3].v_type != VAR_UNKNOWN)
14748 time_limit = get_tv_number_chk(&argvars[3], NULL);
14749 if (time_limit < 0)
14750 goto theend;
14752 #endif
14755 #ifdef FEAT_RELTIME
14756 /* Set the time limit, if there is one. */
14757 profile_setlimit(time_limit, &tm);
14758 #endif
14761 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14762 * Check to make sure only those flags are set.
14763 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14764 * flags cannot be set. Check for that condition also.
14766 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14767 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14769 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14770 goto theend;
14773 pos = save_cursor = curwin->w_cursor;
14774 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14775 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14776 if (subpatnum != FAIL)
14778 if (flags & SP_SUBPAT)
14779 retval = subpatnum;
14780 else
14781 retval = pos.lnum;
14782 if (flags & SP_SETPCMARK)
14783 setpcmark();
14784 curwin->w_cursor = pos;
14785 if (match_pos != NULL)
14787 /* Store the match cursor position */
14788 match_pos->lnum = pos.lnum;
14789 match_pos->col = pos.col + 1;
14791 /* "/$" will put the cursor after the end of the line, may need to
14792 * correct that here */
14793 check_cursor();
14796 /* If 'n' flag is used: restore cursor position. */
14797 if (flags & SP_NOMOVE)
14798 curwin->w_cursor = save_cursor;
14799 else
14800 curwin->w_set_curswant = TRUE;
14801 theend:
14802 p_ws = save_p_ws;
14804 return retval;
14807 #ifdef FEAT_FLOAT
14809 * "round({float})" function
14811 static void
14812 f_round(argvars, rettv)
14813 typval_T *argvars;
14814 typval_T *rettv;
14816 float_T f;
14818 rettv->v_type = VAR_FLOAT;
14819 if (get_float_arg(argvars, &f) == OK)
14820 /* round() is not in C90, use ceil() or floor() instead. */
14821 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14822 else
14823 rettv->vval.v_float = 0.0;
14825 #endif
14828 * "search()" function
14830 static void
14831 f_search(argvars, rettv)
14832 typval_T *argvars;
14833 typval_T *rettv;
14835 int flags = 0;
14837 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14841 * "searchdecl()" function
14843 static void
14844 f_searchdecl(argvars, rettv)
14845 typval_T *argvars;
14846 typval_T *rettv;
14848 int locally = 1;
14849 int thisblock = 0;
14850 int error = FALSE;
14851 char_u *name;
14853 rettv->vval.v_number = 1; /* default: FAIL */
14855 name = get_tv_string_chk(&argvars[0]);
14856 if (argvars[1].v_type != VAR_UNKNOWN)
14858 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14859 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14860 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14862 if (!error && name != NULL)
14863 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14864 locally, thisblock, SEARCH_KEEP) == FAIL;
14868 * Used by searchpair() and searchpairpos()
14870 static int
14871 searchpair_cmn(argvars, match_pos)
14872 typval_T *argvars;
14873 pos_T *match_pos;
14875 char_u *spat, *mpat, *epat;
14876 char_u *skip;
14877 int save_p_ws = p_ws;
14878 int dir;
14879 int flags = 0;
14880 char_u nbuf1[NUMBUFLEN];
14881 char_u nbuf2[NUMBUFLEN];
14882 char_u nbuf3[NUMBUFLEN];
14883 int retval = 0; /* default: FAIL */
14884 long lnum_stop = 0;
14885 long time_limit = 0;
14887 /* Get the three pattern arguments: start, middle, end. */
14888 spat = get_tv_string_chk(&argvars[0]);
14889 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14890 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14891 if (spat == NULL || mpat == NULL || epat == NULL)
14892 goto theend; /* type error */
14894 /* Handle the optional fourth argument: flags */
14895 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14896 if (dir == 0)
14897 goto theend;
14899 /* Don't accept SP_END or SP_SUBPAT.
14900 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14902 if ((flags & (SP_END | SP_SUBPAT)) != 0
14903 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14905 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14906 goto theend;
14909 /* Using 'r' implies 'W', otherwise it doesn't work. */
14910 if (flags & SP_REPEAT)
14911 p_ws = FALSE;
14913 /* Optional fifth argument: skip expression */
14914 if (argvars[3].v_type == VAR_UNKNOWN
14915 || argvars[4].v_type == VAR_UNKNOWN)
14916 skip = (char_u *)"";
14917 else
14919 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14920 if (argvars[5].v_type != VAR_UNKNOWN)
14922 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
14923 if (lnum_stop < 0)
14924 goto theend;
14925 #ifdef FEAT_RELTIME
14926 if (argvars[6].v_type != VAR_UNKNOWN)
14928 time_limit = get_tv_number_chk(&argvars[6], NULL);
14929 if (time_limit < 0)
14930 goto theend;
14932 #endif
14935 if (skip == NULL)
14936 goto theend; /* type error */
14938 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
14939 match_pos, lnum_stop, time_limit);
14941 theend:
14942 p_ws = save_p_ws;
14944 return retval;
14948 * "searchpair()" function
14950 static void
14951 f_searchpair(argvars, rettv)
14952 typval_T *argvars;
14953 typval_T *rettv;
14955 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
14959 * "searchpairpos()" function
14961 static void
14962 f_searchpairpos(argvars, rettv)
14963 typval_T *argvars;
14964 typval_T *rettv;
14966 pos_T match_pos;
14967 int lnum = 0;
14968 int col = 0;
14970 rettv->vval.v_number = 0;
14972 if (rettv_list_alloc(rettv) == FAIL)
14973 return;
14975 if (searchpair_cmn(argvars, &match_pos) > 0)
14977 lnum = match_pos.lnum;
14978 col = match_pos.col;
14981 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
14982 list_append_number(rettv->vval.v_list, (varnumber_T)col);
14986 * Search for a start/middle/end thing.
14987 * Used by searchpair(), see its documentation for the details.
14988 * Returns 0 or -1 for no match,
14990 long
14991 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
14992 lnum_stop, time_limit)
14993 char_u *spat; /* start pattern */
14994 char_u *mpat; /* middle pattern */
14995 char_u *epat; /* end pattern */
14996 int dir; /* BACKWARD or FORWARD */
14997 char_u *skip; /* skip expression */
14998 int flags; /* SP_SETPCMARK and other SP_ values */
14999 pos_T *match_pos;
15000 linenr_T lnum_stop; /* stop at this line if not zero */
15001 long time_limit; /* stop after this many msec */
15003 char_u *save_cpo;
15004 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15005 long retval = 0;
15006 pos_T pos;
15007 pos_T firstpos;
15008 pos_T foundpos;
15009 pos_T save_cursor;
15010 pos_T save_pos;
15011 int n;
15012 int r;
15013 int nest = 1;
15014 int err;
15015 int options = SEARCH_KEEP;
15016 proftime_T tm;
15018 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15019 save_cpo = p_cpo;
15020 p_cpo = empty_option;
15022 #ifdef FEAT_RELTIME
15023 /* Set the time limit, if there is one. */
15024 profile_setlimit(time_limit, &tm);
15025 #endif
15027 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15028 * start/middle/end (pat3, for the top pair). */
15029 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15030 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15031 if (pat2 == NULL || pat3 == NULL)
15032 goto theend;
15033 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15034 if (*mpat == NUL)
15035 STRCPY(pat3, pat2);
15036 else
15037 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15038 spat, epat, mpat);
15039 if (flags & SP_START)
15040 options |= SEARCH_START;
15042 save_cursor = curwin->w_cursor;
15043 pos = curwin->w_cursor;
15044 clearpos(&firstpos);
15045 clearpos(&foundpos);
15046 pat = pat3;
15047 for (;;)
15049 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15050 options, RE_SEARCH, lnum_stop, &tm);
15051 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15052 /* didn't find it or found the first match again: FAIL */
15053 break;
15055 if (firstpos.lnum == 0)
15056 firstpos = pos;
15057 if (equalpos(pos, foundpos))
15059 /* Found the same position again. Can happen with a pattern that
15060 * has "\zs" at the end and searching backwards. Advance one
15061 * character and try again. */
15062 if (dir == BACKWARD)
15063 decl(&pos);
15064 else
15065 incl(&pos);
15067 foundpos = pos;
15069 /* clear the start flag to avoid getting stuck here */
15070 options &= ~SEARCH_START;
15072 /* If the skip pattern matches, ignore this match. */
15073 if (*skip != NUL)
15075 save_pos = curwin->w_cursor;
15076 curwin->w_cursor = pos;
15077 r = eval_to_bool(skip, &err, NULL, FALSE);
15078 curwin->w_cursor = save_pos;
15079 if (err)
15081 /* Evaluating {skip} caused an error, break here. */
15082 curwin->w_cursor = save_cursor;
15083 retval = -1;
15084 break;
15086 if (r)
15087 continue;
15090 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15092 /* Found end when searching backwards or start when searching
15093 * forward: nested pair. */
15094 ++nest;
15095 pat = pat2; /* nested, don't search for middle */
15097 else
15099 /* Found end when searching forward or start when searching
15100 * backward: end of (nested) pair; or found middle in outer pair. */
15101 if (--nest == 1)
15102 pat = pat3; /* outer level, search for middle */
15105 if (nest == 0)
15107 /* Found the match: return matchcount or line number. */
15108 if (flags & SP_RETCOUNT)
15109 ++retval;
15110 else
15111 retval = pos.lnum;
15112 if (flags & SP_SETPCMARK)
15113 setpcmark();
15114 curwin->w_cursor = pos;
15115 if (!(flags & SP_REPEAT))
15116 break;
15117 nest = 1; /* search for next unmatched */
15121 if (match_pos != NULL)
15123 /* Store the match cursor position */
15124 match_pos->lnum = curwin->w_cursor.lnum;
15125 match_pos->col = curwin->w_cursor.col + 1;
15128 /* If 'n' flag is used or search failed: restore cursor position. */
15129 if ((flags & SP_NOMOVE) || retval == 0)
15130 curwin->w_cursor = save_cursor;
15132 theend:
15133 vim_free(pat2);
15134 vim_free(pat3);
15135 if (p_cpo == empty_option)
15136 p_cpo = save_cpo;
15137 else
15138 /* Darn, evaluating the {skip} expression changed the value. */
15139 free_string_option(save_cpo);
15141 return retval;
15145 * "searchpos()" function
15147 static void
15148 f_searchpos(argvars, rettv)
15149 typval_T *argvars;
15150 typval_T *rettv;
15152 pos_T match_pos;
15153 int lnum = 0;
15154 int col = 0;
15155 int n;
15156 int flags = 0;
15158 rettv->vval.v_number = 0;
15160 if (rettv_list_alloc(rettv) == FAIL)
15161 return;
15163 n = search_cmn(argvars, &match_pos, &flags);
15164 if (n > 0)
15166 lnum = match_pos.lnum;
15167 col = match_pos.col;
15170 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15171 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15172 if (flags & SP_SUBPAT)
15173 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15177 /*ARGSUSED*/
15178 static void
15179 f_server2client(argvars, rettv)
15180 typval_T *argvars;
15181 typval_T *rettv;
15183 #ifdef FEAT_CLIENTSERVER
15184 char_u buf[NUMBUFLEN];
15185 char_u *server = get_tv_string_chk(&argvars[0]);
15186 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15188 rettv->vval.v_number = -1;
15189 if (server == NULL || reply == NULL)
15190 return;
15191 if (check_restricted() || check_secure())
15192 return;
15193 # ifdef FEAT_X11
15194 if (check_connection() == FAIL)
15195 return;
15196 # endif
15198 if (serverSendReply(server, reply) < 0)
15200 EMSG(_("E258: Unable to send to client"));
15201 return;
15203 rettv->vval.v_number = 0;
15204 #else
15205 rettv->vval.v_number = -1;
15206 #endif
15209 /*ARGSUSED*/
15210 static void
15211 f_serverlist(argvars, rettv)
15212 typval_T *argvars;
15213 typval_T *rettv;
15215 char_u *r = NULL;
15217 #ifdef FEAT_CLIENTSERVER
15218 # if defined(WIN32) || defined(MAC_CLIENTSERVER)
15219 r = serverGetVimNames();
15220 # elif defined(FEAT_X11)
15221 make_connection();
15222 if (X_DISPLAY != NULL)
15223 r = serverGetVimNames(X_DISPLAY);
15224 # endif
15225 #endif
15226 rettv->v_type = VAR_STRING;
15227 rettv->vval.v_string = r;
15231 * "setbufvar()" function
15233 /*ARGSUSED*/
15234 static void
15235 f_setbufvar(argvars, rettv)
15236 typval_T *argvars;
15237 typval_T *rettv;
15239 buf_T *buf;
15240 aco_save_T aco;
15241 char_u *varname, *bufvarname;
15242 typval_T *varp;
15243 char_u nbuf[NUMBUFLEN];
15245 rettv->vval.v_number = 0;
15247 if (check_restricted() || check_secure())
15248 return;
15249 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15250 varname = get_tv_string_chk(&argvars[1]);
15251 buf = get_buf_tv(&argvars[0]);
15252 varp = &argvars[2];
15254 if (buf != NULL && varname != NULL && varp != NULL)
15256 /* set curbuf to be our buf, temporarily */
15257 aucmd_prepbuf(&aco, buf);
15259 if (*varname == '&')
15261 long numval;
15262 char_u *strval;
15263 int error = FALSE;
15265 ++varname;
15266 numval = get_tv_number_chk(varp, &error);
15267 strval = get_tv_string_buf_chk(varp, nbuf);
15268 if (!error && strval != NULL)
15269 set_option_value(varname, numval, strval, OPT_LOCAL);
15271 else
15273 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15274 if (bufvarname != NULL)
15276 STRCPY(bufvarname, "b:");
15277 STRCPY(bufvarname + 2, varname);
15278 set_var(bufvarname, varp, TRUE);
15279 vim_free(bufvarname);
15283 /* reset notion of buffer */
15284 aucmd_restbuf(&aco);
15289 * "setcmdpos()" function
15291 static void
15292 f_setcmdpos(argvars, rettv)
15293 typval_T *argvars;
15294 typval_T *rettv;
15296 int pos = (int)get_tv_number(&argvars[0]) - 1;
15298 if (pos >= 0)
15299 rettv->vval.v_number = set_cmdline_pos(pos);
15303 * "setline()" function
15305 static void
15306 f_setline(argvars, rettv)
15307 typval_T *argvars;
15308 typval_T *rettv;
15310 linenr_T lnum;
15311 char_u *line = NULL;
15312 list_T *l = NULL;
15313 listitem_T *li = NULL;
15314 long added = 0;
15315 linenr_T lcount = curbuf->b_ml.ml_line_count;
15317 lnum = get_tv_lnum(&argvars[0]);
15318 if (argvars[1].v_type == VAR_LIST)
15320 l = argvars[1].vval.v_list;
15321 li = l->lv_first;
15323 else
15324 line = get_tv_string_chk(&argvars[1]);
15326 rettv->vval.v_number = 0; /* OK */
15327 for (;;)
15329 if (l != NULL)
15331 /* list argument, get next string */
15332 if (li == NULL)
15333 break;
15334 line = get_tv_string_chk(&li->li_tv);
15335 li = li->li_next;
15338 rettv->vval.v_number = 1; /* FAIL */
15339 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15340 break;
15341 if (lnum <= curbuf->b_ml.ml_line_count)
15343 /* existing line, replace it */
15344 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15346 changed_bytes(lnum, 0);
15347 if (lnum == curwin->w_cursor.lnum)
15348 check_cursor_col();
15349 rettv->vval.v_number = 0; /* OK */
15352 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15354 /* lnum is one past the last line, append the line */
15355 ++added;
15356 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15357 rettv->vval.v_number = 0; /* OK */
15360 if (l == NULL) /* only one string argument */
15361 break;
15362 ++lnum;
15365 if (added > 0)
15366 appended_lines_mark(lcount, added);
15369 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15372 * Used by "setqflist()" and "setloclist()" functions
15374 /*ARGSUSED*/
15375 static void
15376 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15377 win_T *wp;
15378 typval_T *list_arg;
15379 typval_T *action_arg;
15380 typval_T *rettv;
15382 #ifdef FEAT_QUICKFIX
15383 char_u *act;
15384 int action = ' ';
15385 #endif
15387 rettv->vval.v_number = -1;
15389 #ifdef FEAT_QUICKFIX
15390 if (list_arg->v_type != VAR_LIST)
15391 EMSG(_(e_listreq));
15392 else
15394 list_T *l = list_arg->vval.v_list;
15396 if (action_arg->v_type == VAR_STRING)
15398 act = get_tv_string_chk(action_arg);
15399 if (act == NULL)
15400 return; /* type error; errmsg already given */
15401 if (*act == 'a' || *act == 'r')
15402 action = *act;
15405 if (l != NULL && set_errorlist(wp, l, action) == OK)
15406 rettv->vval.v_number = 0;
15408 #endif
15412 * "setloclist()" function
15414 /*ARGSUSED*/
15415 static void
15416 f_setloclist(argvars, rettv)
15417 typval_T *argvars;
15418 typval_T *rettv;
15420 win_T *win;
15422 rettv->vval.v_number = -1;
15424 win = find_win_by_nr(&argvars[0], NULL);
15425 if (win != NULL)
15426 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15430 * "setmatches()" function
15432 static void
15433 f_setmatches(argvars, rettv)
15434 typval_T *argvars;
15435 typval_T *rettv;
15437 #ifdef FEAT_SEARCH_EXTRA
15438 list_T *l;
15439 listitem_T *li;
15440 dict_T *d;
15442 rettv->vval.v_number = -1;
15443 if (argvars[0].v_type != VAR_LIST)
15445 EMSG(_(e_listreq));
15446 return;
15448 if ((l = argvars[0].vval.v_list) != NULL)
15451 /* To some extent make sure that we are dealing with a list from
15452 * "getmatches()". */
15453 li = l->lv_first;
15454 while (li != NULL)
15456 if (li->li_tv.v_type != VAR_DICT
15457 || (d = li->li_tv.vval.v_dict) == NULL)
15459 EMSG(_(e_invarg));
15460 return;
15462 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15463 && dict_find(d, (char_u *)"pattern", -1) != NULL
15464 && dict_find(d, (char_u *)"priority", -1) != NULL
15465 && dict_find(d, (char_u *)"id", -1) != NULL))
15467 EMSG(_(e_invarg));
15468 return;
15470 li = li->li_next;
15473 clear_matches(curwin);
15474 li = l->lv_first;
15475 while (li != NULL)
15477 d = li->li_tv.vval.v_dict;
15478 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15479 get_dict_string(d, (char_u *)"pattern", FALSE),
15480 (int)get_dict_number(d, (char_u *)"priority"),
15481 (int)get_dict_number(d, (char_u *)"id"));
15482 li = li->li_next;
15484 rettv->vval.v_number = 0;
15486 #endif
15490 * "setpos()" function
15492 /*ARGSUSED*/
15493 static void
15494 f_setpos(argvars, rettv)
15495 typval_T *argvars;
15496 typval_T *rettv;
15498 pos_T pos;
15499 int fnum;
15500 char_u *name;
15502 rettv->vval.v_number = -1;
15503 name = get_tv_string_chk(argvars);
15504 if (name != NULL)
15506 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15508 --pos.col;
15509 if (name[0] == '.' && name[1] == NUL)
15511 /* set cursor */
15512 if (fnum == curbuf->b_fnum)
15514 curwin->w_cursor = pos;
15515 check_cursor();
15516 rettv->vval.v_number = 0;
15518 else
15519 EMSG(_(e_invarg));
15521 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15523 /* set mark */
15524 if (setmark_pos(name[1], &pos, fnum) == OK)
15525 rettv->vval.v_number = 0;
15527 else
15528 EMSG(_(e_invarg));
15534 * "setqflist()" function
15536 /*ARGSUSED*/
15537 static void
15538 f_setqflist(argvars, rettv)
15539 typval_T *argvars;
15540 typval_T *rettv;
15542 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15546 * "setreg()" function
15548 static void
15549 f_setreg(argvars, rettv)
15550 typval_T *argvars;
15551 typval_T *rettv;
15553 int regname;
15554 char_u *strregname;
15555 char_u *stropt;
15556 char_u *strval;
15557 int append;
15558 char_u yank_type;
15559 long block_len;
15561 block_len = -1;
15562 yank_type = MAUTO;
15563 append = FALSE;
15565 strregname = get_tv_string_chk(argvars);
15566 rettv->vval.v_number = 1; /* FAIL is default */
15568 if (strregname == NULL)
15569 return; /* type error; errmsg already given */
15570 regname = *strregname;
15571 if (regname == 0 || regname == '@')
15572 regname = '"';
15573 else if (regname == '=')
15574 return;
15576 if (argvars[2].v_type != VAR_UNKNOWN)
15578 stropt = get_tv_string_chk(&argvars[2]);
15579 if (stropt == NULL)
15580 return; /* type error */
15581 for (; *stropt != NUL; ++stropt)
15582 switch (*stropt)
15584 case 'a': case 'A': /* append */
15585 append = TRUE;
15586 break;
15587 case 'v': case 'c': /* character-wise selection */
15588 yank_type = MCHAR;
15589 break;
15590 case 'V': case 'l': /* line-wise selection */
15591 yank_type = MLINE;
15592 break;
15593 #ifdef FEAT_VISUAL
15594 case 'b': case Ctrl_V: /* block-wise selection */
15595 yank_type = MBLOCK;
15596 if (VIM_ISDIGIT(stropt[1]))
15598 ++stropt;
15599 block_len = getdigits(&stropt) - 1;
15600 --stropt;
15602 break;
15603 #endif
15607 strval = get_tv_string_chk(&argvars[1]);
15608 if (strval != NULL)
15609 write_reg_contents_ex(regname, strval, -1,
15610 append, yank_type, block_len);
15611 rettv->vval.v_number = 0;
15615 * "settabwinvar()" function
15617 static void
15618 f_settabwinvar(argvars, rettv)
15619 typval_T *argvars;
15620 typval_T *rettv;
15622 setwinvar(argvars, rettv, 1);
15626 * "setwinvar()" function
15628 static void
15629 f_setwinvar(argvars, rettv)
15630 typval_T *argvars;
15631 typval_T *rettv;
15633 setwinvar(argvars, rettv, 0);
15637 * "setwinvar()" and "settabwinvar()" functions
15639 static void
15640 setwinvar(argvars, rettv, off)
15641 typval_T *argvars;
15642 typval_T *rettv;
15643 int off;
15645 win_T *win;
15646 #ifdef FEAT_WINDOWS
15647 win_T *save_curwin;
15648 tabpage_T *save_curtab;
15649 #endif
15650 char_u *varname, *winvarname;
15651 typval_T *varp;
15652 char_u nbuf[NUMBUFLEN];
15653 tabpage_T *tp;
15655 rettv->vval.v_number = 0;
15657 if (check_restricted() || check_secure())
15658 return;
15660 #ifdef FEAT_WINDOWS
15661 if (off == 1)
15662 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15663 else
15664 tp = curtab;
15665 #endif
15666 win = find_win_by_nr(&argvars[off], tp);
15667 varname = get_tv_string_chk(&argvars[off + 1]);
15668 varp = &argvars[off + 2];
15670 if (win != NULL && varname != NULL && varp != NULL)
15672 #ifdef FEAT_WINDOWS
15673 /* set curwin to be our win, temporarily */
15674 save_curwin = curwin;
15675 save_curtab = curtab;
15676 goto_tabpage_tp(tp);
15677 if (!win_valid(win))
15678 return;
15679 curwin = win;
15680 curbuf = curwin->w_buffer;
15681 #endif
15683 if (*varname == '&')
15685 long numval;
15686 char_u *strval;
15687 int error = FALSE;
15689 ++varname;
15690 numval = get_tv_number_chk(varp, &error);
15691 strval = get_tv_string_buf_chk(varp, nbuf);
15692 if (!error && strval != NULL)
15693 set_option_value(varname, numval, strval, OPT_LOCAL);
15695 else
15697 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15698 if (winvarname != NULL)
15700 STRCPY(winvarname, "w:");
15701 STRCPY(winvarname + 2, varname);
15702 set_var(winvarname, varp, TRUE);
15703 vim_free(winvarname);
15707 #ifdef FEAT_WINDOWS
15708 /* Restore current tabpage and window, if still valid (autocomands can
15709 * make them invalid). */
15710 if (valid_tabpage(save_curtab))
15711 goto_tabpage_tp(save_curtab);
15712 if (win_valid(save_curwin))
15714 curwin = save_curwin;
15715 curbuf = curwin->w_buffer;
15717 #endif
15722 * "shellescape({string})" function
15724 static void
15725 f_shellescape(argvars, rettv)
15726 typval_T *argvars;
15727 typval_T *rettv;
15729 rettv->vval.v_string = vim_strsave_shellescape(
15730 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15731 rettv->v_type = VAR_STRING;
15735 * "simplify()" function
15737 static void
15738 f_simplify(argvars, rettv)
15739 typval_T *argvars;
15740 typval_T *rettv;
15742 char_u *p;
15744 p = get_tv_string(&argvars[0]);
15745 rettv->vval.v_string = vim_strsave(p);
15746 simplify_filename(rettv->vval.v_string); /* simplify in place */
15747 rettv->v_type = VAR_STRING;
15750 #ifdef FEAT_FLOAT
15752 * "sin()" function
15754 static void
15755 f_sin(argvars, rettv)
15756 typval_T *argvars;
15757 typval_T *rettv;
15759 float_T f;
15761 rettv->v_type = VAR_FLOAT;
15762 if (get_float_arg(argvars, &f) == OK)
15763 rettv->vval.v_float = sin(f);
15764 else
15765 rettv->vval.v_float = 0.0;
15767 #endif
15769 static int
15770 #ifdef __BORLANDC__
15771 _RTLENTRYF
15772 #endif
15773 item_compare __ARGS((const void *s1, const void *s2));
15774 static int
15775 #ifdef __BORLANDC__
15776 _RTLENTRYF
15777 #endif
15778 item_compare2 __ARGS((const void *s1, const void *s2));
15780 static int item_compare_ic;
15781 static char_u *item_compare_func;
15782 static int item_compare_func_err;
15783 #define ITEM_COMPARE_FAIL 999
15786 * Compare functions for f_sort() below.
15788 static int
15789 #ifdef __BORLANDC__
15790 _RTLENTRYF
15791 #endif
15792 item_compare(s1, s2)
15793 const void *s1;
15794 const void *s2;
15796 char_u *p1, *p2;
15797 char_u *tofree1, *tofree2;
15798 int res;
15799 char_u numbuf1[NUMBUFLEN];
15800 char_u numbuf2[NUMBUFLEN];
15802 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15803 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15804 if (p1 == NULL)
15805 p1 = (char_u *)"";
15806 if (p2 == NULL)
15807 p2 = (char_u *)"";
15808 if (item_compare_ic)
15809 res = STRICMP(p1, p2);
15810 else
15811 res = STRCMP(p1, p2);
15812 vim_free(tofree1);
15813 vim_free(tofree2);
15814 return res;
15817 static int
15818 #ifdef __BORLANDC__
15819 _RTLENTRYF
15820 #endif
15821 item_compare2(s1, s2)
15822 const void *s1;
15823 const void *s2;
15825 int res;
15826 typval_T rettv;
15827 typval_T argv[3];
15828 int dummy;
15830 /* shortcut after failure in previous call; compare all items equal */
15831 if (item_compare_func_err)
15832 return 0;
15834 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15835 * in the copy without changing the original list items. */
15836 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15837 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15839 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15840 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15841 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15842 clear_tv(&argv[0]);
15843 clear_tv(&argv[1]);
15845 if (res == FAIL)
15846 res = ITEM_COMPARE_FAIL;
15847 else
15848 /* return value has wrong type */
15849 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15850 if (item_compare_func_err)
15851 res = ITEM_COMPARE_FAIL;
15852 clear_tv(&rettv);
15853 return res;
15857 * "sort({list})" function
15859 static void
15860 f_sort(argvars, rettv)
15861 typval_T *argvars;
15862 typval_T *rettv;
15864 list_T *l;
15865 listitem_T *li;
15866 listitem_T **ptrs;
15867 long len;
15868 long i;
15870 rettv->vval.v_number = 0;
15871 if (argvars[0].v_type != VAR_LIST)
15872 EMSG2(_(e_listarg), "sort()");
15873 else
15875 l = argvars[0].vval.v_list;
15876 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15877 return;
15878 rettv->vval.v_list = l;
15879 rettv->v_type = VAR_LIST;
15880 ++l->lv_refcount;
15882 len = list_len(l);
15883 if (len <= 1)
15884 return; /* short list sorts pretty quickly */
15886 item_compare_ic = FALSE;
15887 item_compare_func = NULL;
15888 if (argvars[1].v_type != VAR_UNKNOWN)
15890 if (argvars[1].v_type == VAR_FUNC)
15891 item_compare_func = argvars[1].vval.v_string;
15892 else
15894 int error = FALSE;
15896 i = get_tv_number_chk(&argvars[1], &error);
15897 if (error)
15898 return; /* type error; errmsg already given */
15899 if (i == 1)
15900 item_compare_ic = TRUE;
15901 else
15902 item_compare_func = get_tv_string(&argvars[1]);
15906 /* Make an array with each entry pointing to an item in the List. */
15907 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15908 if (ptrs == NULL)
15909 return;
15910 i = 0;
15911 for (li = l->lv_first; li != NULL; li = li->li_next)
15912 ptrs[i++] = li;
15914 item_compare_func_err = FALSE;
15915 /* test the compare function */
15916 if (item_compare_func != NULL
15917 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15918 == ITEM_COMPARE_FAIL)
15919 EMSG(_("E702: Sort compare function failed"));
15920 else
15922 /* Sort the array with item pointers. */
15923 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15924 item_compare_func == NULL ? item_compare : item_compare2);
15926 if (!item_compare_func_err)
15928 /* Clear the List and append the items in the sorted order. */
15929 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15930 l->lv_len = 0;
15931 for (i = 0; i < len; ++i)
15932 list_append(l, ptrs[i]);
15936 vim_free(ptrs);
15941 * "soundfold({word})" function
15943 static void
15944 f_soundfold(argvars, rettv)
15945 typval_T *argvars;
15946 typval_T *rettv;
15948 char_u *s;
15950 rettv->v_type = VAR_STRING;
15951 s = get_tv_string(&argvars[0]);
15952 #ifdef FEAT_SPELL
15953 rettv->vval.v_string = eval_soundfold(s);
15954 #else
15955 rettv->vval.v_string = vim_strsave(s);
15956 #endif
15960 * "spellbadword()" function
15962 /* ARGSUSED */
15963 static void
15964 f_spellbadword(argvars, rettv)
15965 typval_T *argvars;
15966 typval_T *rettv;
15968 char_u *word = (char_u *)"";
15969 hlf_T attr = HLF_COUNT;
15970 int len = 0;
15972 if (rettv_list_alloc(rettv) == FAIL)
15973 return;
15975 #ifdef FEAT_SPELL
15976 if (argvars[0].v_type == VAR_UNKNOWN)
15978 /* Find the start and length of the badly spelled word. */
15979 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
15980 if (len != 0)
15981 word = ml_get_cursor();
15983 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
15985 char_u *str = get_tv_string_chk(&argvars[0]);
15986 int capcol = -1;
15988 if (str != NULL)
15990 /* Check the argument for spelling. */
15991 while (*str != NUL)
15993 len = spell_check(curwin, str, &attr, &capcol, FALSE);
15994 if (attr != HLF_COUNT)
15996 word = str;
15997 break;
15999 str += len;
16003 #endif
16005 list_append_string(rettv->vval.v_list, word, len);
16006 list_append_string(rettv->vval.v_list, (char_u *)(
16007 attr == HLF_SPB ? "bad" :
16008 attr == HLF_SPR ? "rare" :
16009 attr == HLF_SPL ? "local" :
16010 attr == HLF_SPC ? "caps" :
16011 ""), -1);
16015 * "spellsuggest()" function
16017 /*ARGSUSED*/
16018 static void
16019 f_spellsuggest(argvars, rettv)
16020 typval_T *argvars;
16021 typval_T *rettv;
16023 #ifdef FEAT_SPELL
16024 char_u *str;
16025 int typeerr = FALSE;
16026 int maxcount;
16027 garray_T ga;
16028 int i;
16029 listitem_T *li;
16030 int need_capital = FALSE;
16031 #endif
16033 if (rettv_list_alloc(rettv) == FAIL)
16034 return;
16036 #ifdef FEAT_SPELL
16037 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16039 str = get_tv_string(&argvars[0]);
16040 if (argvars[1].v_type != VAR_UNKNOWN)
16042 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16043 if (maxcount <= 0)
16044 return;
16045 if (argvars[2].v_type != VAR_UNKNOWN)
16047 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16048 if (typeerr)
16049 return;
16052 else
16053 maxcount = 25;
16055 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16057 for (i = 0; i < ga.ga_len; ++i)
16059 str = ((char_u **)ga.ga_data)[i];
16061 li = listitem_alloc();
16062 if (li == NULL)
16063 vim_free(str);
16064 else
16066 li->li_tv.v_type = VAR_STRING;
16067 li->li_tv.v_lock = 0;
16068 li->li_tv.vval.v_string = str;
16069 list_append(rettv->vval.v_list, li);
16072 ga_clear(&ga);
16074 #endif
16077 static void
16078 f_split(argvars, rettv)
16079 typval_T *argvars;
16080 typval_T *rettv;
16082 char_u *str;
16083 char_u *end;
16084 char_u *pat = NULL;
16085 regmatch_T regmatch;
16086 char_u patbuf[NUMBUFLEN];
16087 char_u *save_cpo;
16088 int match;
16089 colnr_T col = 0;
16090 int keepempty = FALSE;
16091 int typeerr = FALSE;
16093 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16094 save_cpo = p_cpo;
16095 p_cpo = (char_u *)"";
16097 str = get_tv_string(&argvars[0]);
16098 if (argvars[1].v_type != VAR_UNKNOWN)
16100 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16101 if (pat == NULL)
16102 typeerr = TRUE;
16103 if (argvars[2].v_type != VAR_UNKNOWN)
16104 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16106 if (pat == NULL || *pat == NUL)
16107 pat = (char_u *)"[\\x01- ]\\+";
16109 if (rettv_list_alloc(rettv) == FAIL)
16110 return;
16111 if (typeerr)
16112 return;
16114 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16115 if (regmatch.regprog != NULL)
16117 regmatch.rm_ic = FALSE;
16118 while (*str != NUL || keepempty)
16120 if (*str == NUL)
16121 match = FALSE; /* empty item at the end */
16122 else
16123 match = vim_regexec_nl(&regmatch, str, col);
16124 if (match)
16125 end = regmatch.startp[0];
16126 else
16127 end = str + STRLEN(str);
16128 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16129 && *str != NUL && match && end < regmatch.endp[0]))
16131 if (list_append_string(rettv->vval.v_list, str,
16132 (int)(end - str)) == FAIL)
16133 break;
16135 if (!match)
16136 break;
16137 /* Advance to just after the match. */
16138 if (regmatch.endp[0] > str)
16139 col = 0;
16140 else
16142 /* Don't get stuck at the same match. */
16143 #ifdef FEAT_MBYTE
16144 col = (*mb_ptr2len)(regmatch.endp[0]);
16145 #else
16146 col = 1;
16147 #endif
16149 str = regmatch.endp[0];
16152 vim_free(regmatch.regprog);
16155 p_cpo = save_cpo;
16158 #ifdef FEAT_FLOAT
16160 * "sqrt()" function
16162 static void
16163 f_sqrt(argvars, rettv)
16164 typval_T *argvars;
16165 typval_T *rettv;
16167 float_T f;
16169 rettv->v_type = VAR_FLOAT;
16170 if (get_float_arg(argvars, &f) == OK)
16171 rettv->vval.v_float = sqrt(f);
16172 else
16173 rettv->vval.v_float = 0.0;
16177 * "str2float()" function
16179 static void
16180 f_str2float(argvars, rettv)
16181 typval_T *argvars;
16182 typval_T *rettv;
16184 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16186 if (*p == '+')
16187 p = skipwhite(p + 1);
16188 (void)string2float(p, &rettv->vval.v_float);
16189 rettv->v_type = VAR_FLOAT;
16191 #endif
16194 * "str2nr()" function
16196 static void
16197 f_str2nr(argvars, rettv)
16198 typval_T *argvars;
16199 typval_T *rettv;
16201 int base = 10;
16202 char_u *p;
16203 long n;
16205 if (argvars[1].v_type != VAR_UNKNOWN)
16207 base = get_tv_number(&argvars[1]);
16208 if (base != 8 && base != 10 && base != 16)
16210 EMSG(_(e_invarg));
16211 return;
16215 p = skipwhite(get_tv_string(&argvars[0]));
16216 if (*p == '+')
16217 p = skipwhite(p + 1);
16218 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16219 rettv->vval.v_number = n;
16222 #ifdef HAVE_STRFTIME
16224 * "strftime({format}[, {time}])" function
16226 static void
16227 f_strftime(argvars, rettv)
16228 typval_T *argvars;
16229 typval_T *rettv;
16231 char_u result_buf[256];
16232 struct tm *curtime;
16233 time_t seconds;
16234 char_u *p;
16236 rettv->v_type = VAR_STRING;
16238 p = get_tv_string(&argvars[0]);
16239 if (argvars[1].v_type == VAR_UNKNOWN)
16240 seconds = time(NULL);
16241 else
16242 seconds = (time_t)get_tv_number(&argvars[1]);
16243 curtime = localtime(&seconds);
16244 /* MSVC returns NULL for an invalid value of seconds. */
16245 if (curtime == NULL)
16246 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16247 else
16249 # ifdef FEAT_MBYTE
16250 vimconv_T conv;
16251 char_u *enc;
16253 conv.vc_type = CONV_NONE;
16254 enc = enc_locale();
16255 convert_setup(&conv, p_enc, enc);
16256 if (conv.vc_type != CONV_NONE)
16257 p = string_convert(&conv, p, NULL);
16258 # endif
16259 if (p != NULL)
16260 (void)strftime((char *)result_buf, sizeof(result_buf),
16261 (char *)p, curtime);
16262 else
16263 result_buf[0] = NUL;
16265 # ifdef FEAT_MBYTE
16266 if (conv.vc_type != CONV_NONE)
16267 vim_free(p);
16268 convert_setup(&conv, enc, p_enc);
16269 if (conv.vc_type != CONV_NONE)
16270 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16271 else
16272 # endif
16273 rettv->vval.v_string = vim_strsave(result_buf);
16275 # ifdef FEAT_MBYTE
16276 /* Release conversion descriptors */
16277 convert_setup(&conv, NULL, NULL);
16278 vim_free(enc);
16279 # endif
16282 #endif
16285 * "stridx()" function
16287 static void
16288 f_stridx(argvars, rettv)
16289 typval_T *argvars;
16290 typval_T *rettv;
16292 char_u buf[NUMBUFLEN];
16293 char_u *needle;
16294 char_u *haystack;
16295 char_u *save_haystack;
16296 char_u *pos;
16297 int start_idx;
16299 needle = get_tv_string_chk(&argvars[1]);
16300 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16301 rettv->vval.v_number = -1;
16302 if (needle == NULL || haystack == NULL)
16303 return; /* type error; errmsg already given */
16305 if (argvars[2].v_type != VAR_UNKNOWN)
16307 int error = FALSE;
16309 start_idx = get_tv_number_chk(&argvars[2], &error);
16310 if (error || start_idx >= (int)STRLEN(haystack))
16311 return;
16312 if (start_idx >= 0)
16313 haystack += start_idx;
16316 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16317 if (pos != NULL)
16318 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16322 * "string()" function
16324 static void
16325 f_string(argvars, rettv)
16326 typval_T *argvars;
16327 typval_T *rettv;
16329 char_u *tofree;
16330 char_u numbuf[NUMBUFLEN];
16332 rettv->v_type = VAR_STRING;
16333 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16334 /* Make a copy if we have a value but it's not in allocated memory. */
16335 if (rettv->vval.v_string != NULL && tofree == NULL)
16336 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16340 * "strlen()" function
16342 static void
16343 f_strlen(argvars, rettv)
16344 typval_T *argvars;
16345 typval_T *rettv;
16347 rettv->vval.v_number = (varnumber_T)(STRLEN(
16348 get_tv_string(&argvars[0])));
16352 * "strpart()" function
16354 static void
16355 f_strpart(argvars, rettv)
16356 typval_T *argvars;
16357 typval_T *rettv;
16359 char_u *p;
16360 int n;
16361 int len;
16362 int slen;
16363 int error = FALSE;
16365 p = get_tv_string(&argvars[0]);
16366 slen = (int)STRLEN(p);
16368 n = get_tv_number_chk(&argvars[1], &error);
16369 if (error)
16370 len = 0;
16371 else if (argvars[2].v_type != VAR_UNKNOWN)
16372 len = get_tv_number(&argvars[2]);
16373 else
16374 len = slen - n; /* default len: all bytes that are available. */
16377 * Only return the overlap between the specified part and the actual
16378 * string.
16380 if (n < 0)
16382 len += n;
16383 n = 0;
16385 else if (n > slen)
16386 n = slen;
16387 if (len < 0)
16388 len = 0;
16389 else if (n + len > slen)
16390 len = slen - n;
16392 rettv->v_type = VAR_STRING;
16393 rettv->vval.v_string = vim_strnsave(p + n, len);
16397 * "strridx()" function
16399 static void
16400 f_strridx(argvars, rettv)
16401 typval_T *argvars;
16402 typval_T *rettv;
16404 char_u buf[NUMBUFLEN];
16405 char_u *needle;
16406 char_u *haystack;
16407 char_u *rest;
16408 char_u *lastmatch = NULL;
16409 int haystack_len, end_idx;
16411 needle = get_tv_string_chk(&argvars[1]);
16412 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16414 rettv->vval.v_number = -1;
16415 if (needle == NULL || haystack == NULL)
16416 return; /* type error; errmsg already given */
16418 haystack_len = (int)STRLEN(haystack);
16419 if (argvars[2].v_type != VAR_UNKNOWN)
16421 /* Third argument: upper limit for index */
16422 end_idx = get_tv_number_chk(&argvars[2], NULL);
16423 if (end_idx < 0)
16424 return; /* can never find a match */
16426 else
16427 end_idx = haystack_len;
16429 if (*needle == NUL)
16431 /* Empty string matches past the end. */
16432 lastmatch = haystack + end_idx;
16434 else
16436 for (rest = haystack; *rest != '\0'; ++rest)
16438 rest = (char_u *)strstr((char *)rest, (char *)needle);
16439 if (rest == NULL || rest > haystack + end_idx)
16440 break;
16441 lastmatch = rest;
16445 if (lastmatch == NULL)
16446 rettv->vval.v_number = -1;
16447 else
16448 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16452 * "strtrans()" function
16454 static void
16455 f_strtrans(argvars, rettv)
16456 typval_T *argvars;
16457 typval_T *rettv;
16459 rettv->v_type = VAR_STRING;
16460 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16464 * "submatch()" function
16466 static void
16467 f_submatch(argvars, rettv)
16468 typval_T *argvars;
16469 typval_T *rettv;
16471 rettv->v_type = VAR_STRING;
16472 rettv->vval.v_string =
16473 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16477 * "substitute()" function
16479 static void
16480 f_substitute(argvars, rettv)
16481 typval_T *argvars;
16482 typval_T *rettv;
16484 char_u patbuf[NUMBUFLEN];
16485 char_u subbuf[NUMBUFLEN];
16486 char_u flagsbuf[NUMBUFLEN];
16488 char_u *str = get_tv_string_chk(&argvars[0]);
16489 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16490 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16491 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16493 rettv->v_type = VAR_STRING;
16494 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16495 rettv->vval.v_string = NULL;
16496 else
16497 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16501 * "synID(lnum, col, trans)" function
16503 /*ARGSUSED*/
16504 static void
16505 f_synID(argvars, rettv)
16506 typval_T *argvars;
16507 typval_T *rettv;
16509 int id = 0;
16510 #ifdef FEAT_SYN_HL
16511 long lnum;
16512 long col;
16513 int trans;
16514 int transerr = FALSE;
16516 lnum = get_tv_lnum(argvars); /* -1 on type error */
16517 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16518 trans = get_tv_number_chk(&argvars[2], &transerr);
16520 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16521 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16522 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16523 #endif
16525 rettv->vval.v_number = id;
16529 * "synIDattr(id, what [, mode])" function
16531 /*ARGSUSED*/
16532 static void
16533 f_synIDattr(argvars, rettv)
16534 typval_T *argvars;
16535 typval_T *rettv;
16537 char_u *p = NULL;
16538 #ifdef FEAT_SYN_HL
16539 int id;
16540 char_u *what;
16541 char_u *mode;
16542 char_u modebuf[NUMBUFLEN];
16543 int modec;
16545 id = get_tv_number(&argvars[0]);
16546 what = get_tv_string(&argvars[1]);
16547 if (argvars[2].v_type != VAR_UNKNOWN)
16549 mode = get_tv_string_buf(&argvars[2], modebuf);
16550 modec = TOLOWER_ASC(mode[0]);
16551 if (modec != 't' && modec != 'c'
16552 #ifdef FEAT_GUI
16553 && modec != 'g'
16554 #endif
16556 modec = 0; /* replace invalid with current */
16558 else
16560 #ifdef FEAT_GUI
16561 if (gui.in_use)
16562 modec = 'g';
16563 else
16564 #endif
16565 if (t_colors > 1)
16566 modec = 'c';
16567 else
16568 modec = 't';
16572 switch (TOLOWER_ASC(what[0]))
16574 case 'b':
16575 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16576 p = highlight_color(id, what, modec);
16577 else /* bold */
16578 p = highlight_has_attr(id, HL_BOLD, modec);
16579 break;
16581 case 'f': /* fg[#] */
16582 p = highlight_color(id, what, modec);
16583 break;
16585 case 'i':
16586 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16587 p = highlight_has_attr(id, HL_INVERSE, modec);
16588 else /* italic */
16589 p = highlight_has_attr(id, HL_ITALIC, modec);
16590 break;
16592 case 'n': /* name */
16593 p = get_highlight_name(NULL, id - 1);
16594 break;
16596 case 'r': /* reverse */
16597 p = highlight_has_attr(id, HL_INVERSE, modec);
16598 break;
16600 case 's': /* standout */
16601 p = highlight_has_attr(id, HL_STANDOUT, modec);
16602 break;
16604 case 'u':
16605 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16606 /* underline */
16607 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16608 else
16609 /* undercurl */
16610 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16611 break;
16614 if (p != NULL)
16615 p = vim_strsave(p);
16616 #endif
16617 rettv->v_type = VAR_STRING;
16618 rettv->vval.v_string = p;
16622 * "synIDtrans(id)" function
16624 /*ARGSUSED*/
16625 static void
16626 f_synIDtrans(argvars, rettv)
16627 typval_T *argvars;
16628 typval_T *rettv;
16630 int id;
16632 #ifdef FEAT_SYN_HL
16633 id = get_tv_number(&argvars[0]);
16635 if (id > 0)
16636 id = syn_get_final_id(id);
16637 else
16638 #endif
16639 id = 0;
16641 rettv->vval.v_number = id;
16645 * "synstack(lnum, col)" function
16647 /*ARGSUSED*/
16648 static void
16649 f_synstack(argvars, rettv)
16650 typval_T *argvars;
16651 typval_T *rettv;
16653 #ifdef FEAT_SYN_HL
16654 long lnum;
16655 long col;
16656 int i;
16657 int id;
16658 #endif
16660 rettv->v_type = VAR_LIST;
16661 rettv->vval.v_list = NULL;
16663 #ifdef FEAT_SYN_HL
16664 lnum = get_tv_lnum(argvars); /* -1 on type error */
16665 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16667 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16668 && col >= 0 && col < (long)STRLEN(ml_get(lnum))
16669 && rettv_list_alloc(rettv) != FAIL)
16671 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16672 for (i = 0; ; ++i)
16674 id = syn_get_stack_item(i);
16675 if (id < 0)
16676 break;
16677 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16678 break;
16681 #endif
16685 * "system()" function
16687 static void
16688 f_system(argvars, rettv)
16689 typval_T *argvars;
16690 typval_T *rettv;
16692 char_u *res = NULL;
16693 char_u *p;
16694 char_u *infile = NULL;
16695 char_u buf[NUMBUFLEN];
16696 int err = FALSE;
16697 FILE *fd;
16699 if (check_restricted() || check_secure())
16700 goto done;
16702 if (argvars[1].v_type != VAR_UNKNOWN)
16705 * Write the string to a temp file, to be used for input of the shell
16706 * command.
16708 if ((infile = vim_tempname('i')) == NULL)
16710 EMSG(_(e_notmp));
16711 goto done;
16714 fd = mch_fopen((char *)infile, WRITEBIN);
16715 if (fd == NULL)
16717 EMSG2(_(e_notopen), infile);
16718 goto done;
16720 p = get_tv_string_buf_chk(&argvars[1], buf);
16721 if (p == NULL)
16723 fclose(fd);
16724 goto done; /* type error; errmsg already given */
16726 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16727 err = TRUE;
16728 if (fclose(fd) != 0)
16729 err = TRUE;
16730 if (err)
16732 EMSG(_("E677: Error writing temp file"));
16733 goto done;
16737 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16738 SHELL_SILENT | SHELL_COOKED);
16740 #ifdef USE_CR
16741 /* translate <CR> into <NL> */
16742 if (res != NULL)
16744 char_u *s;
16746 for (s = res; *s; ++s)
16748 if (*s == CAR)
16749 *s = NL;
16752 #else
16753 # ifdef USE_CRNL
16754 /* translate <CR><NL> into <NL> */
16755 if (res != NULL)
16757 char_u *s, *d;
16759 d = res;
16760 for (s = res; *s; ++s)
16762 if (s[0] == CAR && s[1] == NL)
16763 ++s;
16764 *d++ = *s;
16766 *d = NUL;
16768 # endif
16769 #endif
16771 done:
16772 if (infile != NULL)
16774 mch_remove(infile);
16775 vim_free(infile);
16777 rettv->v_type = VAR_STRING;
16778 rettv->vval.v_string = res;
16782 * "tabpagebuflist()" function
16784 /* ARGSUSED */
16785 static void
16786 f_tabpagebuflist(argvars, rettv)
16787 typval_T *argvars;
16788 typval_T *rettv;
16790 #ifndef FEAT_WINDOWS
16791 rettv->vval.v_number = 0;
16792 #else
16793 tabpage_T *tp;
16794 win_T *wp = NULL;
16796 if (argvars[0].v_type == VAR_UNKNOWN)
16797 wp = firstwin;
16798 else
16800 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16801 if (tp != NULL)
16802 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16804 if (wp == NULL)
16805 rettv->vval.v_number = 0;
16806 else
16808 if (rettv_list_alloc(rettv) == FAIL)
16809 rettv->vval.v_number = 0;
16810 else
16812 for (; wp != NULL; wp = wp->w_next)
16813 if (list_append_number(rettv->vval.v_list,
16814 wp->w_buffer->b_fnum) == FAIL)
16815 break;
16818 #endif
16823 * "tabpagenr()" function
16825 /* ARGSUSED */
16826 static void
16827 f_tabpagenr(argvars, rettv)
16828 typval_T *argvars;
16829 typval_T *rettv;
16831 int nr = 1;
16832 #ifdef FEAT_WINDOWS
16833 char_u *arg;
16835 if (argvars[0].v_type != VAR_UNKNOWN)
16837 arg = get_tv_string_chk(&argvars[0]);
16838 nr = 0;
16839 if (arg != NULL)
16841 if (STRCMP(arg, "$") == 0)
16842 nr = tabpage_index(NULL) - 1;
16843 else
16844 EMSG2(_(e_invexpr2), arg);
16847 else
16848 nr = tabpage_index(curtab);
16849 #endif
16850 rettv->vval.v_number = nr;
16854 #ifdef FEAT_WINDOWS
16855 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16858 * Common code for tabpagewinnr() and winnr().
16860 static int
16861 get_winnr(tp, argvar)
16862 tabpage_T *tp;
16863 typval_T *argvar;
16865 win_T *twin;
16866 int nr = 1;
16867 win_T *wp;
16868 char_u *arg;
16870 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16871 if (argvar->v_type != VAR_UNKNOWN)
16873 arg = get_tv_string_chk(argvar);
16874 if (arg == NULL)
16875 nr = 0; /* type error; errmsg already given */
16876 else if (STRCMP(arg, "$") == 0)
16877 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16878 else if (STRCMP(arg, "#") == 0)
16880 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16881 if (twin == NULL)
16882 nr = 0;
16884 else
16886 EMSG2(_(e_invexpr2), arg);
16887 nr = 0;
16891 if (nr > 0)
16892 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16893 wp != twin; wp = wp->w_next)
16895 if (wp == NULL)
16897 /* didn't find it in this tabpage */
16898 nr = 0;
16899 break;
16901 ++nr;
16903 return nr;
16905 #endif
16908 * "tabpagewinnr()" function
16910 /* ARGSUSED */
16911 static void
16912 f_tabpagewinnr(argvars, rettv)
16913 typval_T *argvars;
16914 typval_T *rettv;
16916 int nr = 1;
16917 #ifdef FEAT_WINDOWS
16918 tabpage_T *tp;
16920 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16921 if (tp == NULL)
16922 nr = 0;
16923 else
16924 nr = get_winnr(tp, &argvars[1]);
16925 #endif
16926 rettv->vval.v_number = nr;
16931 * "tagfiles()" function
16933 /*ARGSUSED*/
16934 static void
16935 f_tagfiles(argvars, rettv)
16936 typval_T *argvars;
16937 typval_T *rettv;
16939 char_u fname[MAXPATHL + 1];
16940 tagname_T tn;
16941 int first;
16943 if (rettv_list_alloc(rettv) == FAIL)
16945 rettv->vval.v_number = 0;
16946 return;
16949 for (first = TRUE; ; first = FALSE)
16950 if (get_tagfname(&tn, first, fname) == FAIL
16951 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
16952 break;
16953 tagname_free(&tn);
16957 * "taglist()" function
16959 static void
16960 f_taglist(argvars, rettv)
16961 typval_T *argvars;
16962 typval_T *rettv;
16964 char_u *tag_pattern;
16966 tag_pattern = get_tv_string(&argvars[0]);
16968 rettv->vval.v_number = FALSE;
16969 if (*tag_pattern == NUL)
16970 return;
16972 if (rettv_list_alloc(rettv) == OK)
16973 (void)get_tags(rettv->vval.v_list, tag_pattern);
16977 * "tempname()" function
16979 /*ARGSUSED*/
16980 static void
16981 f_tempname(argvars, rettv)
16982 typval_T *argvars;
16983 typval_T *rettv;
16985 static int x = 'A';
16987 rettv->v_type = VAR_STRING;
16988 rettv->vval.v_string = vim_tempname(x);
16990 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
16991 * names. Skip 'I' and 'O', they are used for shell redirection. */
16994 if (x == 'Z')
16995 x = '0';
16996 else if (x == '9')
16997 x = 'A';
16998 else
17000 #ifdef EBCDIC
17001 if (x == 'I')
17002 x = 'J';
17003 else if (x == 'R')
17004 x = 'S';
17005 else
17006 #endif
17007 ++x;
17009 } while (x == 'I' || x == 'O');
17013 * "test(list)" function: Just checking the walls...
17015 /*ARGSUSED*/
17016 static void
17017 f_test(argvars, rettv)
17018 typval_T *argvars;
17019 typval_T *rettv;
17021 /* Used for unit testing. Change the code below to your liking. */
17022 #if 0
17023 listitem_T *li;
17024 list_T *l;
17025 char_u *bad, *good;
17027 if (argvars[0].v_type != VAR_LIST)
17028 return;
17029 l = argvars[0].vval.v_list;
17030 if (l == NULL)
17031 return;
17032 li = l->lv_first;
17033 if (li == NULL)
17034 return;
17035 bad = get_tv_string(&li->li_tv);
17036 li = li->li_next;
17037 if (li == NULL)
17038 return;
17039 good = get_tv_string(&li->li_tv);
17040 rettv->vval.v_number = test_edit_score(bad, good);
17041 #endif
17045 * "tolower(string)" function
17047 static void
17048 f_tolower(argvars, rettv)
17049 typval_T *argvars;
17050 typval_T *rettv;
17052 char_u *p;
17054 p = vim_strsave(get_tv_string(&argvars[0]));
17055 rettv->v_type = VAR_STRING;
17056 rettv->vval.v_string = p;
17058 if (p != NULL)
17059 while (*p != NUL)
17061 #ifdef FEAT_MBYTE
17062 int l;
17064 if (enc_utf8)
17066 int c, lc;
17068 c = utf_ptr2char(p);
17069 lc = utf_tolower(c);
17070 l = utf_ptr2len(p);
17071 /* TODO: reallocate string when byte count changes. */
17072 if (utf_char2len(lc) == l)
17073 utf_char2bytes(lc, p);
17074 p += l;
17076 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17077 p += l; /* skip multi-byte character */
17078 else
17079 #endif
17081 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17082 ++p;
17088 * "toupper(string)" function
17090 static void
17091 f_toupper(argvars, rettv)
17092 typval_T *argvars;
17093 typval_T *rettv;
17095 rettv->v_type = VAR_STRING;
17096 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17100 * "tr(string, fromstr, tostr)" function
17102 static void
17103 f_tr(argvars, rettv)
17104 typval_T *argvars;
17105 typval_T *rettv;
17107 char_u *instr;
17108 char_u *fromstr;
17109 char_u *tostr;
17110 char_u *p;
17111 #ifdef FEAT_MBYTE
17112 int inlen;
17113 int fromlen;
17114 int tolen;
17115 int idx;
17116 char_u *cpstr;
17117 int cplen;
17118 int first = TRUE;
17119 #endif
17120 char_u buf[NUMBUFLEN];
17121 char_u buf2[NUMBUFLEN];
17122 garray_T ga;
17124 instr = get_tv_string(&argvars[0]);
17125 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17126 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17128 /* Default return value: empty string. */
17129 rettv->v_type = VAR_STRING;
17130 rettv->vval.v_string = NULL;
17131 if (fromstr == NULL || tostr == NULL)
17132 return; /* type error; errmsg already given */
17133 ga_init2(&ga, (int)sizeof(char), 80);
17135 #ifdef FEAT_MBYTE
17136 if (!has_mbyte)
17137 #endif
17138 /* not multi-byte: fromstr and tostr must be the same length */
17139 if (STRLEN(fromstr) != STRLEN(tostr))
17141 #ifdef FEAT_MBYTE
17142 error:
17143 #endif
17144 EMSG2(_(e_invarg2), fromstr);
17145 ga_clear(&ga);
17146 return;
17149 /* fromstr and tostr have to contain the same number of chars */
17150 while (*instr != NUL)
17152 #ifdef FEAT_MBYTE
17153 if (has_mbyte)
17155 inlen = (*mb_ptr2len)(instr);
17156 cpstr = instr;
17157 cplen = inlen;
17158 idx = 0;
17159 for (p = fromstr; *p != NUL; p += fromlen)
17161 fromlen = (*mb_ptr2len)(p);
17162 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17164 for (p = tostr; *p != NUL; p += tolen)
17166 tolen = (*mb_ptr2len)(p);
17167 if (idx-- == 0)
17169 cplen = tolen;
17170 cpstr = p;
17171 break;
17174 if (*p == NUL) /* tostr is shorter than fromstr */
17175 goto error;
17176 break;
17178 ++idx;
17181 if (first && cpstr == instr)
17183 /* Check that fromstr and tostr have the same number of
17184 * (multi-byte) characters. Done only once when a character
17185 * of instr doesn't appear in fromstr. */
17186 first = FALSE;
17187 for (p = tostr; *p != NUL; p += tolen)
17189 tolen = (*mb_ptr2len)(p);
17190 --idx;
17192 if (idx != 0)
17193 goto error;
17196 ga_grow(&ga, cplen);
17197 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17198 ga.ga_len += cplen;
17200 instr += inlen;
17202 else
17203 #endif
17205 /* When not using multi-byte chars we can do it faster. */
17206 p = vim_strchr(fromstr, *instr);
17207 if (p != NULL)
17208 ga_append(&ga, tostr[p - fromstr]);
17209 else
17210 ga_append(&ga, *instr);
17211 ++instr;
17215 /* add a terminating NUL */
17216 ga_grow(&ga, 1);
17217 ga_append(&ga, NUL);
17219 rettv->vval.v_string = ga.ga_data;
17222 #ifdef FEAT_FLOAT
17224 * "trunc({float})" function
17226 static void
17227 f_trunc(argvars, rettv)
17228 typval_T *argvars;
17229 typval_T *rettv;
17231 float_T f;
17233 rettv->v_type = VAR_FLOAT;
17234 if (get_float_arg(argvars, &f) == OK)
17235 /* trunc() is not in C90, use floor() or ceil() instead. */
17236 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17237 else
17238 rettv->vval.v_float = 0.0;
17240 #endif
17243 * "type(expr)" function
17245 static void
17246 f_type(argvars, rettv)
17247 typval_T *argvars;
17248 typval_T *rettv;
17250 int n;
17252 switch (argvars[0].v_type)
17254 case VAR_NUMBER: n = 0; break;
17255 case VAR_STRING: n = 1; break;
17256 case VAR_FUNC: n = 2; break;
17257 case VAR_LIST: n = 3; break;
17258 case VAR_DICT: n = 4; break;
17259 #ifdef FEAT_FLOAT
17260 case VAR_FLOAT: n = 5; break;
17261 #endif
17262 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17264 rettv->vval.v_number = n;
17268 * "values(dict)" function
17270 static void
17271 f_values(argvars, rettv)
17272 typval_T *argvars;
17273 typval_T *rettv;
17275 dict_list(argvars, rettv, 1);
17279 * "virtcol(string)" function
17281 static void
17282 f_virtcol(argvars, rettv)
17283 typval_T *argvars;
17284 typval_T *rettv;
17286 colnr_T vcol = 0;
17287 pos_T *fp;
17288 int fnum = curbuf->b_fnum;
17290 fp = var2fpos(&argvars[0], FALSE, &fnum);
17291 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17292 && fnum == curbuf->b_fnum)
17294 getvvcol(curwin, fp, NULL, NULL, &vcol);
17295 ++vcol;
17298 rettv->vval.v_number = vcol;
17302 * "visualmode()" function
17304 /*ARGSUSED*/
17305 static void
17306 f_visualmode(argvars, rettv)
17307 typval_T *argvars;
17308 typval_T *rettv;
17310 #ifdef FEAT_VISUAL
17311 char_u str[2];
17313 rettv->v_type = VAR_STRING;
17314 str[0] = curbuf->b_visual_mode_eval;
17315 str[1] = NUL;
17316 rettv->vval.v_string = vim_strsave(str);
17318 /* A non-zero number or non-empty string argument: reset mode. */
17319 if (non_zero_arg(&argvars[0]))
17320 curbuf->b_visual_mode_eval = NUL;
17321 #else
17322 rettv->vval.v_number = 0; /* return anything, it won't work anyway */
17323 #endif
17327 * "winbufnr(nr)" function
17329 static void
17330 f_winbufnr(argvars, rettv)
17331 typval_T *argvars;
17332 typval_T *rettv;
17334 win_T *wp;
17336 wp = find_win_by_nr(&argvars[0], NULL);
17337 if (wp == NULL)
17338 rettv->vval.v_number = -1;
17339 else
17340 rettv->vval.v_number = wp->w_buffer->b_fnum;
17344 * "wincol()" function
17346 /*ARGSUSED*/
17347 static void
17348 f_wincol(argvars, rettv)
17349 typval_T *argvars;
17350 typval_T *rettv;
17352 validate_cursor();
17353 rettv->vval.v_number = curwin->w_wcol + 1;
17357 * "winheight(nr)" function
17359 static void
17360 f_winheight(argvars, rettv)
17361 typval_T *argvars;
17362 typval_T *rettv;
17364 win_T *wp;
17366 wp = find_win_by_nr(&argvars[0], NULL);
17367 if (wp == NULL)
17368 rettv->vval.v_number = -1;
17369 else
17370 rettv->vval.v_number = wp->w_height;
17374 * "winline()" function
17376 /*ARGSUSED*/
17377 static void
17378 f_winline(argvars, rettv)
17379 typval_T *argvars;
17380 typval_T *rettv;
17382 validate_cursor();
17383 rettv->vval.v_number = curwin->w_wrow + 1;
17387 * "winnr()" function
17389 /* ARGSUSED */
17390 static void
17391 f_winnr(argvars, rettv)
17392 typval_T *argvars;
17393 typval_T *rettv;
17395 int nr = 1;
17397 #ifdef FEAT_WINDOWS
17398 nr = get_winnr(curtab, &argvars[0]);
17399 #endif
17400 rettv->vval.v_number = nr;
17404 * "winrestcmd()" function
17406 /* ARGSUSED */
17407 static void
17408 f_winrestcmd(argvars, rettv)
17409 typval_T *argvars;
17410 typval_T *rettv;
17412 #ifdef FEAT_WINDOWS
17413 win_T *wp;
17414 int winnr = 1;
17415 garray_T ga;
17416 char_u buf[50];
17418 ga_init2(&ga, (int)sizeof(char), 70);
17419 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17421 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17422 ga_concat(&ga, buf);
17423 # ifdef FEAT_VERTSPLIT
17424 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17425 ga_concat(&ga, buf);
17426 # endif
17427 ++winnr;
17429 ga_append(&ga, NUL);
17431 rettv->vval.v_string = ga.ga_data;
17432 #else
17433 rettv->vval.v_string = NULL;
17434 #endif
17435 rettv->v_type = VAR_STRING;
17439 * "winrestview()" function
17441 /* ARGSUSED */
17442 static void
17443 f_winrestview(argvars, rettv)
17444 typval_T *argvars;
17445 typval_T *rettv;
17447 dict_T *dict;
17449 if (argvars[0].v_type != VAR_DICT
17450 || (dict = argvars[0].vval.v_dict) == NULL)
17451 EMSG(_(e_invarg));
17452 else
17454 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17455 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17456 #ifdef FEAT_VIRTUALEDIT
17457 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17458 #endif
17459 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17460 curwin->w_set_curswant = FALSE;
17462 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17463 #ifdef FEAT_DIFF
17464 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17465 #endif
17466 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17467 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17469 check_cursor();
17470 changed_cline_bef_curs();
17471 invalidate_botline();
17472 redraw_later(VALID);
17474 if (curwin->w_topline == 0)
17475 curwin->w_topline = 1;
17476 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17477 curwin->w_topline = curbuf->b_ml.ml_line_count;
17478 #ifdef FEAT_DIFF
17479 check_topfill(curwin, TRUE);
17480 #endif
17485 * "winsaveview()" function
17487 /* ARGSUSED */
17488 static void
17489 f_winsaveview(argvars, rettv)
17490 typval_T *argvars;
17491 typval_T *rettv;
17493 dict_T *dict;
17495 dict = dict_alloc();
17496 if (dict == NULL)
17497 return;
17498 rettv->v_type = VAR_DICT;
17499 rettv->vval.v_dict = dict;
17500 ++dict->dv_refcount;
17502 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17503 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17504 #ifdef FEAT_VIRTUALEDIT
17505 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17506 #endif
17507 update_curswant();
17508 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17510 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17511 #ifdef FEAT_DIFF
17512 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17513 #endif
17514 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17515 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17519 * "winwidth(nr)" function
17521 static void
17522 f_winwidth(argvars, rettv)
17523 typval_T *argvars;
17524 typval_T *rettv;
17526 win_T *wp;
17528 wp = find_win_by_nr(&argvars[0], NULL);
17529 if (wp == NULL)
17530 rettv->vval.v_number = -1;
17531 else
17532 #ifdef FEAT_VERTSPLIT
17533 rettv->vval.v_number = wp->w_width;
17534 #else
17535 rettv->vval.v_number = Columns;
17536 #endif
17540 * "writefile()" function
17542 static void
17543 f_writefile(argvars, rettv)
17544 typval_T *argvars;
17545 typval_T *rettv;
17547 int binary = FALSE;
17548 char_u *fname;
17549 FILE *fd;
17550 listitem_T *li;
17551 char_u *s;
17552 int ret = 0;
17553 int c;
17555 if (check_restricted() || check_secure())
17556 return;
17558 if (argvars[0].v_type != VAR_LIST)
17560 EMSG2(_(e_listarg), "writefile()");
17561 return;
17563 if (argvars[0].vval.v_list == NULL)
17564 return;
17566 if (argvars[2].v_type != VAR_UNKNOWN
17567 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17568 binary = TRUE;
17570 /* Always open the file in binary mode, library functions have a mind of
17571 * their own about CR-LF conversion. */
17572 fname = get_tv_string(&argvars[1]);
17573 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17575 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17576 ret = -1;
17578 else
17580 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17581 li = li->li_next)
17583 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17585 if (*s == '\n')
17586 c = putc(NUL, fd);
17587 else
17588 c = putc(*s, fd);
17589 if (c == EOF)
17591 ret = -1;
17592 break;
17595 if (!binary || li->li_next != NULL)
17596 if (putc('\n', fd) == EOF)
17598 ret = -1;
17599 break;
17601 if (ret < 0)
17603 EMSG(_(e_write));
17604 break;
17607 fclose(fd);
17610 rettv->vval.v_number = ret;
17614 * Translate a String variable into a position.
17615 * Returns NULL when there is an error.
17617 static pos_T *
17618 var2fpos(varp, dollar_lnum, fnum)
17619 typval_T *varp;
17620 int dollar_lnum; /* TRUE when $ is last line */
17621 int *fnum; /* set to fnum for '0, 'A, etc. */
17623 char_u *name;
17624 static pos_T pos;
17625 pos_T *pp;
17627 /* Argument can be [lnum, col, coladd]. */
17628 if (varp->v_type == VAR_LIST)
17630 list_T *l;
17631 int len;
17632 int error = FALSE;
17633 listitem_T *li;
17635 l = varp->vval.v_list;
17636 if (l == NULL)
17637 return NULL;
17639 /* Get the line number */
17640 pos.lnum = list_find_nr(l, 0L, &error);
17641 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17642 return NULL; /* invalid line number */
17644 /* Get the column number */
17645 pos.col = list_find_nr(l, 1L, &error);
17646 if (error)
17647 return NULL;
17648 len = (long)STRLEN(ml_get(pos.lnum));
17650 /* We accept "$" for the column number: last column. */
17651 li = list_find(l, 1L);
17652 if (li != NULL && li->li_tv.v_type == VAR_STRING
17653 && li->li_tv.vval.v_string != NULL
17654 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17655 pos.col = len + 1;
17657 /* Accept a position up to the NUL after the line. */
17658 if (pos.col == 0 || (int)pos.col > len + 1)
17659 return NULL; /* invalid column number */
17660 --pos.col;
17662 #ifdef FEAT_VIRTUALEDIT
17663 /* Get the virtual offset. Defaults to zero. */
17664 pos.coladd = list_find_nr(l, 2L, &error);
17665 if (error)
17666 pos.coladd = 0;
17667 #endif
17669 return &pos;
17672 name = get_tv_string_chk(varp);
17673 if (name == NULL)
17674 return NULL;
17675 if (name[0] == '.') /* cursor */
17676 return &curwin->w_cursor;
17677 #ifdef FEAT_VISUAL
17678 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17680 if (VIsual_active)
17681 return &VIsual;
17682 return &curwin->w_cursor;
17684 #endif
17685 if (name[0] == '\'') /* mark */
17687 pp = getmark_fnum(name[1], FALSE, fnum);
17688 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17689 return NULL;
17690 return pp;
17693 #ifdef FEAT_VIRTUALEDIT
17694 pos.coladd = 0;
17695 #endif
17697 if (name[0] == 'w' && dollar_lnum)
17699 pos.col = 0;
17700 if (name[1] == '0') /* "w0": first visible line */
17702 update_topline();
17703 pos.lnum = curwin->w_topline;
17704 return &pos;
17706 else if (name[1] == '$') /* "w$": last visible line */
17708 validate_botline();
17709 pos.lnum = curwin->w_botline - 1;
17710 return &pos;
17713 else if (name[0] == '$') /* last column or line */
17715 if (dollar_lnum)
17717 pos.lnum = curbuf->b_ml.ml_line_count;
17718 pos.col = 0;
17720 else
17722 pos.lnum = curwin->w_cursor.lnum;
17723 pos.col = (colnr_T)STRLEN(ml_get_curline());
17725 return &pos;
17727 return NULL;
17731 * Convert list in "arg" into a position and optional file number.
17732 * When "fnump" is NULL there is no file number, only 3 items.
17733 * Note that the column is passed on as-is, the caller may want to decrement
17734 * it to use 1 for the first column.
17735 * Return FAIL when conversion is not possible, doesn't check the position for
17736 * validity.
17738 static int
17739 list2fpos(arg, posp, fnump)
17740 typval_T *arg;
17741 pos_T *posp;
17742 int *fnump;
17744 list_T *l = arg->vval.v_list;
17745 long i = 0;
17746 long n;
17748 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17749 * when "fnump" isn't NULL and "coladd" is optional. */
17750 if (arg->v_type != VAR_LIST
17751 || l == NULL
17752 || l->lv_len < (fnump == NULL ? 2 : 3)
17753 || l->lv_len > (fnump == NULL ? 3 : 4))
17754 return FAIL;
17756 if (fnump != NULL)
17758 n = list_find_nr(l, i++, NULL); /* fnum */
17759 if (n < 0)
17760 return FAIL;
17761 if (n == 0)
17762 n = curbuf->b_fnum; /* current buffer */
17763 *fnump = n;
17766 n = list_find_nr(l, i++, NULL); /* lnum */
17767 if (n < 0)
17768 return FAIL;
17769 posp->lnum = n;
17771 n = list_find_nr(l, i++, NULL); /* col */
17772 if (n < 0)
17773 return FAIL;
17774 posp->col = n;
17776 #ifdef FEAT_VIRTUALEDIT
17777 n = list_find_nr(l, i, NULL);
17778 if (n < 0)
17779 posp->coladd = 0;
17780 else
17781 posp->coladd = n;
17782 #endif
17784 return OK;
17788 * Get the length of an environment variable name.
17789 * Advance "arg" to the first character after the name.
17790 * Return 0 for error.
17792 static int
17793 get_env_len(arg)
17794 char_u **arg;
17796 char_u *p;
17797 int len;
17799 for (p = *arg; vim_isIDc(*p); ++p)
17801 if (p == *arg) /* no name found */
17802 return 0;
17804 len = (int)(p - *arg);
17805 *arg = p;
17806 return len;
17810 * Get the length of the name of a function or internal variable.
17811 * "arg" is advanced to the first non-white character after the name.
17812 * Return 0 if something is wrong.
17814 static int
17815 get_id_len(arg)
17816 char_u **arg;
17818 char_u *p;
17819 int len;
17821 /* Find the end of the name. */
17822 for (p = *arg; eval_isnamec(*p); ++p)
17824 if (p == *arg) /* no name found */
17825 return 0;
17827 len = (int)(p - *arg);
17828 *arg = skipwhite(p);
17830 return len;
17834 * Get the length of the name of a variable or function.
17835 * Only the name is recognized, does not handle ".key" or "[idx]".
17836 * "arg" is advanced to the first non-white character after the name.
17837 * Return -1 if curly braces expansion failed.
17838 * Return 0 if something else is wrong.
17839 * If the name contains 'magic' {}'s, expand them and return the
17840 * expanded name in an allocated string via 'alias' - caller must free.
17842 static int
17843 get_name_len(arg, alias, evaluate, verbose)
17844 char_u **arg;
17845 char_u **alias;
17846 int evaluate;
17847 int verbose;
17849 int len;
17850 char_u *p;
17851 char_u *expr_start;
17852 char_u *expr_end;
17854 *alias = NULL; /* default to no alias */
17856 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17857 && (*arg)[2] == (int)KE_SNR)
17859 /* hard coded <SNR>, already translated */
17860 *arg += 3;
17861 return get_id_len(arg) + 3;
17863 len = eval_fname_script(*arg);
17864 if (len > 0)
17866 /* literal "<SID>", "s:" or "<SNR>" */
17867 *arg += len;
17871 * Find the end of the name; check for {} construction.
17873 p = find_name_end(*arg, &expr_start, &expr_end,
17874 len > 0 ? 0 : FNE_CHECK_START);
17875 if (expr_start != NULL)
17877 char_u *temp_string;
17879 if (!evaluate)
17881 len += (int)(p - *arg);
17882 *arg = skipwhite(p);
17883 return len;
17887 * Include any <SID> etc in the expanded string:
17888 * Thus the -len here.
17890 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17891 if (temp_string == NULL)
17892 return -1;
17893 *alias = temp_string;
17894 *arg = skipwhite(p);
17895 return (int)STRLEN(temp_string);
17898 len += get_id_len(arg);
17899 if (len == 0 && verbose)
17900 EMSG2(_(e_invexpr2), *arg);
17902 return len;
17906 * Find the end of a variable or function name, taking care of magic braces.
17907 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17908 * start and end of the first magic braces item.
17909 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17910 * Return a pointer to just after the name. Equal to "arg" if there is no
17911 * valid name.
17913 static char_u *
17914 find_name_end(arg, expr_start, expr_end, flags)
17915 char_u *arg;
17916 char_u **expr_start;
17917 char_u **expr_end;
17918 int flags;
17920 int mb_nest = 0;
17921 int br_nest = 0;
17922 char_u *p;
17924 if (expr_start != NULL)
17926 *expr_start = NULL;
17927 *expr_end = NULL;
17930 /* Quick check for valid starting character. */
17931 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17932 return arg;
17934 for (p = arg; *p != NUL
17935 && (eval_isnamec(*p)
17936 || *p == '{'
17937 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17938 || mb_nest != 0
17939 || br_nest != 0); mb_ptr_adv(p))
17941 if (*p == '\'')
17943 /* skip over 'string' to avoid counting [ and ] inside it. */
17944 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17946 if (*p == NUL)
17947 break;
17949 else if (*p == '"')
17951 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17952 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17953 if (*p == '\\' && p[1] != NUL)
17954 ++p;
17955 if (*p == NUL)
17956 break;
17959 if (mb_nest == 0)
17961 if (*p == '[')
17962 ++br_nest;
17963 else if (*p == ']')
17964 --br_nest;
17967 if (br_nest == 0)
17969 if (*p == '{')
17971 mb_nest++;
17972 if (expr_start != NULL && *expr_start == NULL)
17973 *expr_start = p;
17975 else if (*p == '}')
17977 mb_nest--;
17978 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
17979 *expr_end = p;
17984 return p;
17988 * Expands out the 'magic' {}'s in a variable/function name.
17989 * Note that this can call itself recursively, to deal with
17990 * constructs like foo{bar}{baz}{bam}
17991 * The four pointer arguments point to "foo{expre}ss{ion}bar"
17992 * "in_start" ^
17993 * "expr_start" ^
17994 * "expr_end" ^
17995 * "in_end" ^
17997 * Returns a new allocated string, which the caller must free.
17998 * Returns NULL for failure.
18000 static char_u *
18001 make_expanded_name(in_start, expr_start, expr_end, in_end)
18002 char_u *in_start;
18003 char_u *expr_start;
18004 char_u *expr_end;
18005 char_u *in_end;
18007 char_u c1;
18008 char_u *retval = NULL;
18009 char_u *temp_result;
18010 char_u *nextcmd = NULL;
18012 if (expr_end == NULL || in_end == NULL)
18013 return NULL;
18014 *expr_start = NUL;
18015 *expr_end = NUL;
18016 c1 = *in_end;
18017 *in_end = NUL;
18019 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18020 if (temp_result != NULL && nextcmd == NULL)
18022 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18023 + (in_end - expr_end) + 1));
18024 if (retval != NULL)
18026 STRCPY(retval, in_start);
18027 STRCAT(retval, temp_result);
18028 STRCAT(retval, expr_end + 1);
18031 vim_free(temp_result);
18033 *in_end = c1; /* put char back for error messages */
18034 *expr_start = '{';
18035 *expr_end = '}';
18037 if (retval != NULL)
18039 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18040 if (expr_start != NULL)
18042 /* Further expansion! */
18043 temp_result = make_expanded_name(retval, expr_start,
18044 expr_end, temp_result);
18045 vim_free(retval);
18046 retval = temp_result;
18050 return retval;
18054 * Return TRUE if character "c" can be used in a variable or function name.
18055 * Does not include '{' or '}' for magic braces.
18057 static int
18058 eval_isnamec(c)
18059 int c;
18061 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18065 * Return TRUE if character "c" can be used as the first character in a
18066 * variable or function name (excluding '{' and '}').
18068 static int
18069 eval_isnamec1(c)
18070 int c;
18072 return (ASCII_ISALPHA(c) || c == '_');
18076 * Set number v: variable to "val".
18078 void
18079 set_vim_var_nr(idx, val)
18080 int idx;
18081 long val;
18083 vimvars[idx].vv_nr = val;
18087 * Get number v: variable value.
18089 long
18090 get_vim_var_nr(idx)
18091 int idx;
18093 return vimvars[idx].vv_nr;
18097 * Get string v: variable value. Uses a static buffer, can only be used once.
18099 char_u *
18100 get_vim_var_str(idx)
18101 int idx;
18103 return get_tv_string(&vimvars[idx].vv_tv);
18107 * Set v:count, v:count1 and v:prevcount.
18109 void
18110 set_vcount(count, count1)
18111 long count;
18112 long count1;
18114 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18115 vimvars[VV_COUNT].vv_nr = count;
18116 vimvars[VV_COUNT1].vv_nr = count1;
18120 * Set string v: variable to a copy of "val".
18122 void
18123 set_vim_var_string(idx, val, len)
18124 int idx;
18125 char_u *val;
18126 int len; /* length of "val" to use or -1 (whole string) */
18128 /* Need to do this (at least) once, since we can't initialize a union.
18129 * Will always be invoked when "v:progname" is set. */
18130 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18132 vim_free(vimvars[idx].vv_str);
18133 if (val == NULL)
18134 vimvars[idx].vv_str = NULL;
18135 else if (len == -1)
18136 vimvars[idx].vv_str = vim_strsave(val);
18137 else
18138 vimvars[idx].vv_str = vim_strnsave(val, len);
18142 * Set v:register if needed.
18144 void
18145 set_reg_var(c)
18146 int c;
18148 char_u regname;
18150 if (c == 0 || c == ' ')
18151 regname = '"';
18152 else
18153 regname = c;
18154 /* Avoid free/alloc when the value is already right. */
18155 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18156 set_vim_var_string(VV_REG, &regname, 1);
18160 * Get or set v:exception. If "oldval" == NULL, return the current value.
18161 * Otherwise, restore the value to "oldval" and return NULL.
18162 * Must always be called in pairs to save and restore v:exception! Does not
18163 * take care of memory allocations.
18165 char_u *
18166 v_exception(oldval)
18167 char_u *oldval;
18169 if (oldval == NULL)
18170 return vimvars[VV_EXCEPTION].vv_str;
18172 vimvars[VV_EXCEPTION].vv_str = oldval;
18173 return NULL;
18177 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18178 * Otherwise, restore the value to "oldval" and return NULL.
18179 * Must always be called in pairs to save and restore v:throwpoint! Does not
18180 * take care of memory allocations.
18182 char_u *
18183 v_throwpoint(oldval)
18184 char_u *oldval;
18186 if (oldval == NULL)
18187 return vimvars[VV_THROWPOINT].vv_str;
18189 vimvars[VV_THROWPOINT].vv_str = oldval;
18190 return NULL;
18193 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18195 * Set v:cmdarg.
18196 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18197 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18198 * Must always be called in pairs!
18200 char_u *
18201 set_cmdarg(eap, oldarg)
18202 exarg_T *eap;
18203 char_u *oldarg;
18205 char_u *oldval;
18206 char_u *newval;
18207 unsigned len;
18209 oldval = vimvars[VV_CMDARG].vv_str;
18210 if (eap == NULL)
18212 vim_free(oldval);
18213 vimvars[VV_CMDARG].vv_str = oldarg;
18214 return NULL;
18217 if (eap->force_bin == FORCE_BIN)
18218 len = 6;
18219 else if (eap->force_bin == FORCE_NOBIN)
18220 len = 8;
18221 else
18222 len = 0;
18224 if (eap->read_edit)
18225 len += 7;
18227 if (eap->force_ff != 0)
18228 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18229 # ifdef FEAT_MBYTE
18230 if (eap->force_enc != 0)
18231 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18232 if (eap->bad_char != 0)
18233 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18234 # endif
18236 newval = alloc(len + 1);
18237 if (newval == NULL)
18238 return NULL;
18240 if (eap->force_bin == FORCE_BIN)
18241 sprintf((char *)newval, " ++bin");
18242 else if (eap->force_bin == FORCE_NOBIN)
18243 sprintf((char *)newval, " ++nobin");
18244 else
18245 *newval = NUL;
18247 if (eap->read_edit)
18248 STRCAT(newval, " ++edit");
18250 if (eap->force_ff != 0)
18251 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18252 eap->cmd + eap->force_ff);
18253 # ifdef FEAT_MBYTE
18254 if (eap->force_enc != 0)
18255 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18256 eap->cmd + eap->force_enc);
18257 if (eap->bad_char != 0)
18258 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18259 eap->cmd + eap->bad_char);
18260 # endif
18261 vimvars[VV_CMDARG].vv_str = newval;
18262 return oldval;
18264 #endif
18267 * Get the value of internal variable "name".
18268 * Return OK or FAIL.
18270 static int
18271 get_var_tv(name, len, rettv, verbose)
18272 char_u *name;
18273 int len; /* length of "name" */
18274 typval_T *rettv; /* NULL when only checking existence */
18275 int verbose; /* may give error message */
18277 int ret = OK;
18278 typval_T *tv = NULL;
18279 typval_T atv;
18280 dictitem_T *v;
18281 int cc;
18283 /* truncate the name, so that we can use strcmp() */
18284 cc = name[len];
18285 name[len] = NUL;
18288 * Check for "b:changedtick".
18290 if (STRCMP(name, "b:changedtick") == 0)
18292 atv.v_type = VAR_NUMBER;
18293 atv.vval.v_number = curbuf->b_changedtick;
18294 tv = &atv;
18298 * Check for user-defined variables.
18300 else
18302 v = find_var(name, NULL);
18303 if (v != NULL)
18304 tv = &v->di_tv;
18307 if (tv == NULL)
18309 if (rettv != NULL && verbose)
18310 EMSG2(_(e_undefvar), name);
18311 ret = FAIL;
18313 else if (rettv != NULL)
18314 copy_tv(tv, rettv);
18316 name[len] = cc;
18318 return ret;
18322 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18323 * Also handle function call with Funcref variable: func(expr)
18324 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18326 static int
18327 handle_subscript(arg, rettv, evaluate, verbose)
18328 char_u **arg;
18329 typval_T *rettv;
18330 int evaluate; /* do more than finding the end */
18331 int verbose; /* give error messages */
18333 int ret = OK;
18334 dict_T *selfdict = NULL;
18335 char_u *s;
18336 int len;
18337 typval_T functv;
18339 while (ret == OK
18340 && (**arg == '['
18341 || (**arg == '.' && rettv->v_type == VAR_DICT)
18342 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18343 && !vim_iswhite(*(*arg - 1)))
18345 if (**arg == '(')
18347 /* need to copy the funcref so that we can clear rettv */
18348 functv = *rettv;
18349 rettv->v_type = VAR_UNKNOWN;
18351 /* Invoke the function. Recursive! */
18352 s = functv.vval.v_string;
18353 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18354 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18355 &len, evaluate, selfdict);
18357 /* Clear the funcref afterwards, so that deleting it while
18358 * evaluating the arguments is possible (see test55). */
18359 clear_tv(&functv);
18361 /* Stop the expression evaluation when immediately aborting on
18362 * error, or when an interrupt occurred or an exception was thrown
18363 * but not caught. */
18364 if (aborting())
18366 if (ret == OK)
18367 clear_tv(rettv);
18368 ret = FAIL;
18370 dict_unref(selfdict);
18371 selfdict = NULL;
18373 else /* **arg == '[' || **arg == '.' */
18375 dict_unref(selfdict);
18376 if (rettv->v_type == VAR_DICT)
18378 selfdict = rettv->vval.v_dict;
18379 if (selfdict != NULL)
18380 ++selfdict->dv_refcount;
18382 else
18383 selfdict = NULL;
18384 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18386 clear_tv(rettv);
18387 ret = FAIL;
18391 dict_unref(selfdict);
18392 return ret;
18396 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18397 * value).
18399 static typval_T *
18400 alloc_tv()
18402 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18406 * Allocate memory for a variable type-value, and assign a string to it.
18407 * The string "s" must have been allocated, it is consumed.
18408 * Return NULL for out of memory, the variable otherwise.
18410 static typval_T *
18411 alloc_string_tv(s)
18412 char_u *s;
18414 typval_T *rettv;
18416 rettv = alloc_tv();
18417 if (rettv != NULL)
18419 rettv->v_type = VAR_STRING;
18420 rettv->vval.v_string = s;
18422 else
18423 vim_free(s);
18424 return rettv;
18428 * Free the memory for a variable type-value.
18430 void
18431 free_tv(varp)
18432 typval_T *varp;
18434 if (varp != NULL)
18436 switch (varp->v_type)
18438 case VAR_FUNC:
18439 func_unref(varp->vval.v_string);
18440 /*FALLTHROUGH*/
18441 case VAR_STRING:
18442 vim_free(varp->vval.v_string);
18443 break;
18444 case VAR_LIST:
18445 list_unref(varp->vval.v_list);
18446 break;
18447 case VAR_DICT:
18448 dict_unref(varp->vval.v_dict);
18449 break;
18450 case VAR_NUMBER:
18451 #ifdef FEAT_FLOAT
18452 case VAR_FLOAT:
18453 #endif
18454 case VAR_UNKNOWN:
18455 break;
18456 default:
18457 EMSG2(_(e_intern2), "free_tv()");
18458 break;
18460 vim_free(varp);
18465 * Free the memory for a variable value and set the value to NULL or 0.
18467 void
18468 clear_tv(varp)
18469 typval_T *varp;
18471 if (varp != NULL)
18473 switch (varp->v_type)
18475 case VAR_FUNC:
18476 func_unref(varp->vval.v_string);
18477 /*FALLTHROUGH*/
18478 case VAR_STRING:
18479 vim_free(varp->vval.v_string);
18480 varp->vval.v_string = NULL;
18481 break;
18482 case VAR_LIST:
18483 list_unref(varp->vval.v_list);
18484 varp->vval.v_list = NULL;
18485 break;
18486 case VAR_DICT:
18487 dict_unref(varp->vval.v_dict);
18488 varp->vval.v_dict = NULL;
18489 break;
18490 case VAR_NUMBER:
18491 varp->vval.v_number = 0;
18492 break;
18493 #ifdef FEAT_FLOAT
18494 case VAR_FLOAT:
18495 varp->vval.v_float = 0.0;
18496 break;
18497 #endif
18498 case VAR_UNKNOWN:
18499 break;
18500 default:
18501 EMSG2(_(e_intern2), "clear_tv()");
18503 varp->v_lock = 0;
18508 * Set the value of a variable to NULL without freeing items.
18510 static void
18511 init_tv(varp)
18512 typval_T *varp;
18514 if (varp != NULL)
18515 vim_memset(varp, 0, sizeof(typval_T));
18519 * Get the number value of a variable.
18520 * If it is a String variable, uses vim_str2nr().
18521 * For incompatible types, return 0.
18522 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18523 * caller of incompatible types: it sets *denote to TRUE if "denote"
18524 * is not NULL or returns -1 otherwise.
18526 static long
18527 get_tv_number(varp)
18528 typval_T *varp;
18530 int error = FALSE;
18532 return get_tv_number_chk(varp, &error); /* return 0L on error */
18535 long
18536 get_tv_number_chk(varp, denote)
18537 typval_T *varp;
18538 int *denote;
18540 long n = 0L;
18542 switch (varp->v_type)
18544 case VAR_NUMBER:
18545 return (long)(varp->vval.v_number);
18546 #ifdef FEAT_FLOAT
18547 case VAR_FLOAT:
18548 EMSG(_("E805: Using a Float as a Number"));
18549 break;
18550 #endif
18551 case VAR_FUNC:
18552 EMSG(_("E703: Using a Funcref as a Number"));
18553 break;
18554 case VAR_STRING:
18555 if (varp->vval.v_string != NULL)
18556 vim_str2nr(varp->vval.v_string, NULL, NULL,
18557 TRUE, TRUE, &n, NULL);
18558 return n;
18559 case VAR_LIST:
18560 EMSG(_("E745: Using a List as a Number"));
18561 break;
18562 case VAR_DICT:
18563 EMSG(_("E728: Using a Dictionary as a Number"));
18564 break;
18565 default:
18566 EMSG2(_(e_intern2), "get_tv_number()");
18567 break;
18569 if (denote == NULL) /* useful for values that must be unsigned */
18570 n = -1;
18571 else
18572 *denote = TRUE;
18573 return n;
18577 * Get the lnum from the first argument.
18578 * Also accepts ".", "$", etc., but that only works for the current buffer.
18579 * Returns -1 on error.
18581 static linenr_T
18582 get_tv_lnum(argvars)
18583 typval_T *argvars;
18585 typval_T rettv;
18586 linenr_T lnum;
18588 lnum = get_tv_number_chk(&argvars[0], NULL);
18589 if (lnum == 0) /* no valid number, try using line() */
18591 rettv.v_type = VAR_NUMBER;
18592 f_line(argvars, &rettv);
18593 lnum = rettv.vval.v_number;
18594 clear_tv(&rettv);
18596 return lnum;
18600 * Get the lnum from the first argument.
18601 * Also accepts "$", then "buf" is used.
18602 * Returns 0 on error.
18604 static linenr_T
18605 get_tv_lnum_buf(argvars, buf)
18606 typval_T *argvars;
18607 buf_T *buf;
18609 if (argvars[0].v_type == VAR_STRING
18610 && argvars[0].vval.v_string != NULL
18611 && argvars[0].vval.v_string[0] == '$'
18612 && buf != NULL)
18613 return buf->b_ml.ml_line_count;
18614 return get_tv_number_chk(&argvars[0], NULL);
18618 * Get the string value of a variable.
18619 * If it is a Number variable, the number is converted into a string.
18620 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18621 * get_tv_string_buf() uses a given buffer.
18622 * If the String variable has never been set, return an empty string.
18623 * Never returns NULL;
18624 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18625 * NULL on error.
18627 static char_u *
18628 get_tv_string(varp)
18629 typval_T *varp;
18631 static char_u mybuf[NUMBUFLEN];
18633 return get_tv_string_buf(varp, mybuf);
18636 static char_u *
18637 get_tv_string_buf(varp, buf)
18638 typval_T *varp;
18639 char_u *buf;
18641 char_u *res = get_tv_string_buf_chk(varp, buf);
18643 return res != NULL ? res : (char_u *)"";
18646 char_u *
18647 get_tv_string_chk(varp)
18648 typval_T *varp;
18650 static char_u mybuf[NUMBUFLEN];
18652 return get_tv_string_buf_chk(varp, mybuf);
18655 static char_u *
18656 get_tv_string_buf_chk(varp, buf)
18657 typval_T *varp;
18658 char_u *buf;
18660 switch (varp->v_type)
18662 case VAR_NUMBER:
18663 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18664 return buf;
18665 case VAR_FUNC:
18666 EMSG(_("E729: using Funcref as a String"));
18667 break;
18668 case VAR_LIST:
18669 EMSG(_("E730: using List as a String"));
18670 break;
18671 case VAR_DICT:
18672 EMSG(_("E731: using Dictionary as a String"));
18673 break;
18674 #ifdef FEAT_FLOAT
18675 case VAR_FLOAT:
18676 EMSG(_("E806: using Float as a String"));
18677 break;
18678 #endif
18679 case VAR_STRING:
18680 if (varp->vval.v_string != NULL)
18681 return varp->vval.v_string;
18682 return (char_u *)"";
18683 default:
18684 EMSG2(_(e_intern2), "get_tv_string_buf()");
18685 break;
18687 return NULL;
18691 * Find variable "name" in the list of variables.
18692 * Return a pointer to it if found, NULL if not found.
18693 * Careful: "a:0" variables don't have a name.
18694 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18695 * hashtab_T used.
18697 static dictitem_T *
18698 find_var(name, htp)
18699 char_u *name;
18700 hashtab_T **htp;
18702 char_u *varname;
18703 hashtab_T *ht;
18705 ht = find_var_ht(name, &varname);
18706 if (htp != NULL)
18707 *htp = ht;
18708 if (ht == NULL)
18709 return NULL;
18710 return find_var_in_ht(ht, varname, htp != NULL);
18714 * Find variable "varname" in hashtab "ht".
18715 * Returns NULL if not found.
18717 static dictitem_T *
18718 find_var_in_ht(ht, varname, writing)
18719 hashtab_T *ht;
18720 char_u *varname;
18721 int writing;
18723 hashitem_T *hi;
18725 if (*varname == NUL)
18727 /* Must be something like "s:", otherwise "ht" would be NULL. */
18728 switch (varname[-2])
18730 case 's': return &SCRIPT_SV(current_SID).sv_var;
18731 case 'g': return &globvars_var;
18732 case 'v': return &vimvars_var;
18733 case 'b': return &curbuf->b_bufvar;
18734 case 'w': return &curwin->w_winvar;
18735 #ifdef FEAT_WINDOWS
18736 case 't': return &curtab->tp_winvar;
18737 #endif
18738 case 'l': return current_funccal == NULL
18739 ? NULL : &current_funccal->l_vars_var;
18740 case 'a': return current_funccal == NULL
18741 ? NULL : &current_funccal->l_avars_var;
18743 return NULL;
18746 hi = hash_find(ht, varname);
18747 if (HASHITEM_EMPTY(hi))
18749 /* For global variables we may try auto-loading the script. If it
18750 * worked find the variable again. Don't auto-load a script if it was
18751 * loaded already, otherwise it would be loaded every time when
18752 * checking if a function name is a Funcref variable. */
18753 if (ht == &globvarht && !writing
18754 && script_autoload(varname, FALSE) && !aborting())
18755 hi = hash_find(ht, varname);
18756 if (HASHITEM_EMPTY(hi))
18757 return NULL;
18759 return HI2DI(hi);
18763 * Find the hashtab used for a variable name.
18764 * Set "varname" to the start of name without ':'.
18766 static hashtab_T *
18767 find_var_ht(name, varname)
18768 char_u *name;
18769 char_u **varname;
18771 hashitem_T *hi;
18773 if (name[1] != ':')
18775 /* The name must not start with a colon or #. */
18776 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18777 return NULL;
18778 *varname = name;
18780 /* "version" is "v:version" in all scopes */
18781 hi = hash_find(&compat_hashtab, name);
18782 if (!HASHITEM_EMPTY(hi))
18783 return &compat_hashtab;
18785 if (current_funccal == NULL)
18786 return &globvarht; /* global variable */
18787 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18789 *varname = name + 2;
18790 if (*name == 'g') /* global variable */
18791 return &globvarht;
18792 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18794 if (vim_strchr(name + 2, ':') != NULL
18795 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18796 return NULL;
18797 if (*name == 'b') /* buffer variable */
18798 return &curbuf->b_vars.dv_hashtab;
18799 if (*name == 'w') /* window variable */
18800 return &curwin->w_vars.dv_hashtab;
18801 #ifdef FEAT_WINDOWS
18802 if (*name == 't') /* tab page variable */
18803 return &curtab->tp_vars.dv_hashtab;
18804 #endif
18805 if (*name == 'v') /* v: variable */
18806 return &vimvarht;
18807 if (*name == 'a' && current_funccal != NULL) /* function argument */
18808 return &current_funccal->l_avars.dv_hashtab;
18809 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18810 return &current_funccal->l_vars.dv_hashtab;
18811 if (*name == 's' /* script variable */
18812 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18813 return &SCRIPT_VARS(current_SID);
18814 return NULL;
18818 * Get the string value of a (global/local) variable.
18819 * Returns NULL when it doesn't exist.
18821 char_u *
18822 get_var_value(name)
18823 char_u *name;
18825 dictitem_T *v;
18827 v = find_var(name, NULL);
18828 if (v == NULL)
18829 return NULL;
18830 return get_tv_string(&v->di_tv);
18834 * Allocate a new hashtab for a sourced script. It will be used while
18835 * sourcing this script and when executing functions defined in the script.
18837 void
18838 new_script_vars(id)
18839 scid_T id;
18841 int i;
18842 hashtab_T *ht;
18843 scriptvar_T *sv;
18845 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18847 /* Re-allocating ga_data means that an ht_array pointing to
18848 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18849 * at its init value. Also reset "v_dict", it's always the same. */
18850 for (i = 1; i <= ga_scripts.ga_len; ++i)
18852 ht = &SCRIPT_VARS(i);
18853 if (ht->ht_mask == HT_INIT_SIZE - 1)
18854 ht->ht_array = ht->ht_smallarray;
18855 sv = &SCRIPT_SV(i);
18856 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18859 while (ga_scripts.ga_len < id)
18861 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18862 init_var_dict(&sv->sv_dict, &sv->sv_var);
18863 ++ga_scripts.ga_len;
18869 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18870 * point to it.
18872 void
18873 init_var_dict(dict, dict_var)
18874 dict_T *dict;
18875 dictitem_T *dict_var;
18877 hash_init(&dict->dv_hashtab);
18878 dict->dv_refcount = 99999;
18879 dict_var->di_tv.vval.v_dict = dict;
18880 dict_var->di_tv.v_type = VAR_DICT;
18881 dict_var->di_tv.v_lock = VAR_FIXED;
18882 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18883 dict_var->di_key[0] = NUL;
18887 * Clean up a list of internal variables.
18888 * Frees all allocated variables and the value they contain.
18889 * Clears hashtab "ht", does not free it.
18891 void
18892 vars_clear(ht)
18893 hashtab_T *ht;
18895 vars_clear_ext(ht, TRUE);
18899 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18901 static void
18902 vars_clear_ext(ht, free_val)
18903 hashtab_T *ht;
18904 int free_val;
18906 int todo;
18907 hashitem_T *hi;
18908 dictitem_T *v;
18910 hash_lock(ht);
18911 todo = (int)ht->ht_used;
18912 for (hi = ht->ht_array; todo > 0; ++hi)
18914 if (!HASHITEM_EMPTY(hi))
18916 --todo;
18918 /* Free the variable. Don't remove it from the hashtab,
18919 * ht_array might change then. hash_clear() takes care of it
18920 * later. */
18921 v = HI2DI(hi);
18922 if (free_val)
18923 clear_tv(&v->di_tv);
18924 if ((v->di_flags & DI_FLAGS_FIX) == 0)
18925 vim_free(v);
18928 hash_clear(ht);
18929 ht->ht_used = 0;
18933 * Delete a variable from hashtab "ht" at item "hi".
18934 * Clear the variable value and free the dictitem.
18936 static void
18937 delete_var(ht, hi)
18938 hashtab_T *ht;
18939 hashitem_T *hi;
18941 dictitem_T *di = HI2DI(hi);
18943 hash_remove(ht, hi);
18944 clear_tv(&di->di_tv);
18945 vim_free(di);
18949 * List the value of one internal variable.
18951 static void
18952 list_one_var(v, prefix, first)
18953 dictitem_T *v;
18954 char_u *prefix;
18955 int *first;
18957 char_u *tofree;
18958 char_u *s;
18959 char_u numbuf[NUMBUFLEN];
18961 s = echo_string(&v->di_tv, &tofree, numbuf, ++current_copyID);
18962 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
18963 s == NULL ? (char_u *)"" : s, first);
18964 vim_free(tofree);
18967 static void
18968 list_one_var_a(prefix, name, type, string, first)
18969 char_u *prefix;
18970 char_u *name;
18971 int type;
18972 char_u *string;
18973 int *first; /* when TRUE clear rest of screen and set to FALSE */
18975 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
18976 msg_start();
18977 msg_puts(prefix);
18978 if (name != NULL) /* "a:" vars don't have a name stored */
18979 msg_puts(name);
18980 msg_putchar(' ');
18981 msg_advance(22);
18982 if (type == VAR_NUMBER)
18983 msg_putchar('#');
18984 else if (type == VAR_FUNC)
18985 msg_putchar('*');
18986 else if (type == VAR_LIST)
18988 msg_putchar('[');
18989 if (*string == '[')
18990 ++string;
18992 else if (type == VAR_DICT)
18994 msg_putchar('{');
18995 if (*string == '{')
18996 ++string;
18998 else
18999 msg_putchar(' ');
19001 msg_outtrans(string);
19003 if (type == VAR_FUNC)
19004 msg_puts((char_u *)"()");
19005 if (*first)
19007 msg_clr_eos();
19008 *first = FALSE;
19013 * Set variable "name" to value in "tv".
19014 * If the variable already exists, the value is updated.
19015 * Otherwise the variable is created.
19017 static void
19018 set_var(name, tv, copy)
19019 char_u *name;
19020 typval_T *tv;
19021 int copy; /* make copy of value in "tv" */
19023 dictitem_T *v;
19024 char_u *varname;
19025 hashtab_T *ht;
19026 char_u *p;
19028 if (tv->v_type == VAR_FUNC)
19030 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19031 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19032 ? name[2] : name[0]))
19034 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19035 return;
19037 if (function_exists(name))
19039 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19040 name);
19041 return;
19045 ht = find_var_ht(name, &varname);
19046 if (ht == NULL || *varname == NUL)
19048 EMSG2(_(e_illvar), name);
19049 return;
19052 v = find_var_in_ht(ht, varname, TRUE);
19053 if (v != NULL)
19055 /* existing variable, need to clear the value */
19056 if (var_check_ro(v->di_flags, name)
19057 || tv_check_lock(v->di_tv.v_lock, name))
19058 return;
19059 if (v->di_tv.v_type != tv->v_type
19060 && !((v->di_tv.v_type == VAR_STRING
19061 || v->di_tv.v_type == VAR_NUMBER)
19062 && (tv->v_type == VAR_STRING
19063 || tv->v_type == VAR_NUMBER))
19064 #ifdef FEAT_FLOAT
19065 && !((v->di_tv.v_type == VAR_NUMBER
19066 || v->di_tv.v_type == VAR_FLOAT)
19067 && (tv->v_type == VAR_NUMBER
19068 || tv->v_type == VAR_FLOAT))
19069 #endif
19072 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19073 return;
19077 * Handle setting internal v: variables separately: we don't change
19078 * the type.
19080 if (ht == &vimvarht)
19082 if (v->di_tv.v_type == VAR_STRING)
19084 vim_free(v->di_tv.vval.v_string);
19085 if (copy || tv->v_type != VAR_STRING)
19086 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19087 else
19089 /* Take over the string to avoid an extra alloc/free. */
19090 v->di_tv.vval.v_string = tv->vval.v_string;
19091 tv->vval.v_string = NULL;
19094 else if (v->di_tv.v_type != VAR_NUMBER)
19095 EMSG2(_(e_intern2), "set_var()");
19096 else
19098 v->di_tv.vval.v_number = get_tv_number(tv);
19099 if (STRCMP(varname, "searchforward") == 0)
19100 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19102 return;
19105 clear_tv(&v->di_tv);
19107 else /* add a new variable */
19109 /* Can't add "v:" variable. */
19110 if (ht == &vimvarht)
19112 EMSG2(_(e_illvar), name);
19113 return;
19116 /* Make sure the variable name is valid. */
19117 for (p = varname; *p != NUL; ++p)
19118 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19119 && *p != AUTOLOAD_CHAR)
19121 EMSG2(_(e_illvar), varname);
19122 return;
19125 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19126 + STRLEN(varname)));
19127 if (v == NULL)
19128 return;
19129 STRCPY(v->di_key, varname);
19130 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19132 vim_free(v);
19133 return;
19135 v->di_flags = 0;
19138 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19139 copy_tv(tv, &v->di_tv);
19140 else
19142 v->di_tv = *tv;
19143 v->di_tv.v_lock = 0;
19144 init_tv(tv);
19149 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19150 * Also give an error message.
19152 static int
19153 var_check_ro(flags, name)
19154 int flags;
19155 char_u *name;
19157 if (flags & DI_FLAGS_RO)
19159 EMSG2(_(e_readonlyvar), name);
19160 return TRUE;
19162 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19164 EMSG2(_(e_readonlysbx), name);
19165 return TRUE;
19167 return FALSE;
19171 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19172 * Also give an error message.
19174 static int
19175 var_check_fixed(flags, name)
19176 int flags;
19177 char_u *name;
19179 if (flags & DI_FLAGS_FIX)
19181 EMSG2(_("E795: Cannot delete variable %s"), name);
19182 return TRUE;
19184 return FALSE;
19188 * Return TRUE if typeval "tv" is set to be locked (immutable).
19189 * Also give an error message, using "name".
19191 static int
19192 tv_check_lock(lock, name)
19193 int lock;
19194 char_u *name;
19196 if (lock & VAR_LOCKED)
19198 EMSG2(_("E741: Value is locked: %s"),
19199 name == NULL ? (char_u *)_("Unknown") : name);
19200 return TRUE;
19202 if (lock & VAR_FIXED)
19204 EMSG2(_("E742: Cannot change value of %s"),
19205 name == NULL ? (char_u *)_("Unknown") : name);
19206 return TRUE;
19208 return FALSE;
19212 * Copy the values from typval_T "from" to typval_T "to".
19213 * When needed allocates string or increases reference count.
19214 * Does not make a copy of a list or dict but copies the reference!
19216 static void
19217 copy_tv(from, to)
19218 typval_T *from;
19219 typval_T *to;
19221 to->v_type = from->v_type;
19222 to->v_lock = 0;
19223 switch (from->v_type)
19225 case VAR_NUMBER:
19226 to->vval.v_number = from->vval.v_number;
19227 break;
19228 #ifdef FEAT_FLOAT
19229 case VAR_FLOAT:
19230 to->vval.v_float = from->vval.v_float;
19231 break;
19232 #endif
19233 case VAR_STRING:
19234 case VAR_FUNC:
19235 if (from->vval.v_string == NULL)
19236 to->vval.v_string = NULL;
19237 else
19239 to->vval.v_string = vim_strsave(from->vval.v_string);
19240 if (from->v_type == VAR_FUNC)
19241 func_ref(to->vval.v_string);
19243 break;
19244 case VAR_LIST:
19245 if (from->vval.v_list == NULL)
19246 to->vval.v_list = NULL;
19247 else
19249 to->vval.v_list = from->vval.v_list;
19250 ++to->vval.v_list->lv_refcount;
19252 break;
19253 case VAR_DICT:
19254 if (from->vval.v_dict == NULL)
19255 to->vval.v_dict = NULL;
19256 else
19258 to->vval.v_dict = from->vval.v_dict;
19259 ++to->vval.v_dict->dv_refcount;
19261 break;
19262 default:
19263 EMSG2(_(e_intern2), "copy_tv()");
19264 break;
19269 * Make a copy of an item.
19270 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19271 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19272 * reference to an already copied list/dict can be used.
19273 * Returns FAIL or OK.
19275 static int
19276 item_copy(from, to, deep, copyID)
19277 typval_T *from;
19278 typval_T *to;
19279 int deep;
19280 int copyID;
19282 static int recurse = 0;
19283 int ret = OK;
19285 if (recurse >= DICT_MAXNEST)
19287 EMSG(_("E698: variable nested too deep for making a copy"));
19288 return FAIL;
19290 ++recurse;
19292 switch (from->v_type)
19294 case VAR_NUMBER:
19295 #ifdef FEAT_FLOAT
19296 case VAR_FLOAT:
19297 #endif
19298 case VAR_STRING:
19299 case VAR_FUNC:
19300 copy_tv(from, to);
19301 break;
19302 case VAR_LIST:
19303 to->v_type = VAR_LIST;
19304 to->v_lock = 0;
19305 if (from->vval.v_list == NULL)
19306 to->vval.v_list = NULL;
19307 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19309 /* use the copy made earlier */
19310 to->vval.v_list = from->vval.v_list->lv_copylist;
19311 ++to->vval.v_list->lv_refcount;
19313 else
19314 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19315 if (to->vval.v_list == NULL)
19316 ret = FAIL;
19317 break;
19318 case VAR_DICT:
19319 to->v_type = VAR_DICT;
19320 to->v_lock = 0;
19321 if (from->vval.v_dict == NULL)
19322 to->vval.v_dict = NULL;
19323 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19325 /* use the copy made earlier */
19326 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19327 ++to->vval.v_dict->dv_refcount;
19329 else
19330 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19331 if (to->vval.v_dict == NULL)
19332 ret = FAIL;
19333 break;
19334 default:
19335 EMSG2(_(e_intern2), "item_copy()");
19336 ret = FAIL;
19338 --recurse;
19339 return ret;
19343 * ":echo expr1 ..." print each argument separated with a space, add a
19344 * newline at the end.
19345 * ":echon expr1 ..." print each argument plain.
19347 void
19348 ex_echo(eap)
19349 exarg_T *eap;
19351 char_u *arg = eap->arg;
19352 typval_T rettv;
19353 char_u *tofree;
19354 char_u *p;
19355 int needclr = TRUE;
19356 int atstart = TRUE;
19357 char_u numbuf[NUMBUFLEN];
19359 if (eap->skip)
19360 ++emsg_skip;
19361 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19363 /* If eval1() causes an error message the text from the command may
19364 * still need to be cleared. E.g., "echo 22,44". */
19365 need_clr_eos = needclr;
19367 p = arg;
19368 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19371 * Report the invalid expression unless the expression evaluation
19372 * has been cancelled due to an aborting error, an interrupt, or an
19373 * exception.
19375 if (!aborting())
19376 EMSG2(_(e_invexpr2), p);
19377 need_clr_eos = FALSE;
19378 break;
19380 need_clr_eos = FALSE;
19382 if (!eap->skip)
19384 if (atstart)
19386 atstart = FALSE;
19387 /* Call msg_start() after eval1(), evaluating the expression
19388 * may cause a message to appear. */
19389 if (eap->cmdidx == CMD_echo)
19390 msg_start();
19392 else if (eap->cmdidx == CMD_echo)
19393 msg_puts_attr((char_u *)" ", echo_attr);
19394 p = echo_string(&rettv, &tofree, numbuf, ++current_copyID);
19395 if (p != NULL)
19396 for ( ; *p != NUL && !got_int; ++p)
19398 if (*p == '\n' || *p == '\r' || *p == TAB)
19400 if (*p != TAB && needclr)
19402 /* remove any text still there from the command */
19403 msg_clr_eos();
19404 needclr = FALSE;
19406 msg_putchar_attr(*p, echo_attr);
19408 else
19410 #ifdef FEAT_MBYTE
19411 if (has_mbyte)
19413 int i = (*mb_ptr2len)(p);
19415 (void)msg_outtrans_len_attr(p, i, echo_attr);
19416 p += i - 1;
19418 else
19419 #endif
19420 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19423 vim_free(tofree);
19425 clear_tv(&rettv);
19426 arg = skipwhite(arg);
19428 eap->nextcmd = check_nextcmd(arg);
19430 if (eap->skip)
19431 --emsg_skip;
19432 else
19434 /* remove text that may still be there from the command */
19435 if (needclr)
19436 msg_clr_eos();
19437 if (eap->cmdidx == CMD_echo)
19438 msg_end();
19443 * ":echohl {name}".
19445 void
19446 ex_echohl(eap)
19447 exarg_T *eap;
19449 int id;
19451 id = syn_name2id(eap->arg);
19452 if (id == 0)
19453 echo_attr = 0;
19454 else
19455 echo_attr = syn_id2attr(id);
19459 * ":execute expr1 ..." execute the result of an expression.
19460 * ":echomsg expr1 ..." Print a message
19461 * ":echoerr expr1 ..." Print an error
19462 * Each gets spaces around each argument and a newline at the end for
19463 * echo commands
19465 void
19466 ex_execute(eap)
19467 exarg_T *eap;
19469 char_u *arg = eap->arg;
19470 typval_T rettv;
19471 int ret = OK;
19472 char_u *p;
19473 garray_T ga;
19474 int len;
19475 int save_did_emsg;
19477 ga_init2(&ga, 1, 80);
19479 if (eap->skip)
19480 ++emsg_skip;
19481 while (*arg != NUL && *arg != '|' && *arg != '\n')
19483 p = arg;
19484 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19487 * Report the invalid expression unless the expression evaluation
19488 * has been cancelled due to an aborting error, an interrupt, or an
19489 * exception.
19491 if (!aborting())
19492 EMSG2(_(e_invexpr2), p);
19493 ret = FAIL;
19494 break;
19497 if (!eap->skip)
19499 p = get_tv_string(&rettv);
19500 len = (int)STRLEN(p);
19501 if (ga_grow(&ga, len + 2) == FAIL)
19503 clear_tv(&rettv);
19504 ret = FAIL;
19505 break;
19507 if (ga.ga_len)
19508 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19509 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19510 ga.ga_len += len;
19513 clear_tv(&rettv);
19514 arg = skipwhite(arg);
19517 if (ret != FAIL && ga.ga_data != NULL)
19519 if (eap->cmdidx == CMD_echomsg)
19521 MSG_ATTR(ga.ga_data, echo_attr);
19522 out_flush();
19524 else if (eap->cmdidx == CMD_echoerr)
19526 /* We don't want to abort following commands, restore did_emsg. */
19527 save_did_emsg = did_emsg;
19528 EMSG((char_u *)ga.ga_data);
19529 if (!force_abort)
19530 did_emsg = save_did_emsg;
19532 else if (eap->cmdidx == CMD_execute)
19533 do_cmdline((char_u *)ga.ga_data,
19534 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19537 ga_clear(&ga);
19539 if (eap->skip)
19540 --emsg_skip;
19542 eap->nextcmd = check_nextcmd(arg);
19546 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19547 * "arg" points to the "&" or '+' when called, to "option" when returning.
19548 * Returns NULL when no option name found. Otherwise pointer to the char
19549 * after the option name.
19551 static char_u *
19552 find_option_end(arg, opt_flags)
19553 char_u **arg;
19554 int *opt_flags;
19556 char_u *p = *arg;
19558 ++p;
19559 if (*p == 'g' && p[1] == ':')
19561 *opt_flags = OPT_GLOBAL;
19562 p += 2;
19564 else if (*p == 'l' && p[1] == ':')
19566 *opt_flags = OPT_LOCAL;
19567 p += 2;
19569 else
19570 *opt_flags = 0;
19572 if (!ASCII_ISALPHA(*p))
19573 return NULL;
19574 *arg = p;
19576 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19577 p += 4; /* termcap option */
19578 else
19579 while (ASCII_ISALPHA(*p))
19580 ++p;
19581 return p;
19585 * ":function"
19587 void
19588 ex_function(eap)
19589 exarg_T *eap;
19591 char_u *theline;
19592 int j;
19593 int c;
19594 int saved_did_emsg;
19595 char_u *name = NULL;
19596 char_u *p;
19597 char_u *arg;
19598 char_u *line_arg = NULL;
19599 garray_T newargs;
19600 garray_T newlines;
19601 int varargs = FALSE;
19602 int mustend = FALSE;
19603 int flags = 0;
19604 ufunc_T *fp;
19605 int indent;
19606 int nesting;
19607 char_u *skip_until = NULL;
19608 dictitem_T *v;
19609 funcdict_T fudi;
19610 static int func_nr = 0; /* number for nameless function */
19611 int paren;
19612 hashtab_T *ht;
19613 int todo;
19614 hashitem_T *hi;
19615 int sourcing_lnum_off;
19618 * ":function" without argument: list functions.
19620 if (ends_excmd(*eap->arg))
19622 if (!eap->skip)
19624 todo = (int)func_hashtab.ht_used;
19625 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19627 if (!HASHITEM_EMPTY(hi))
19629 --todo;
19630 fp = HI2UF(hi);
19631 if (!isdigit(*fp->uf_name))
19632 list_func_head(fp, FALSE);
19636 eap->nextcmd = check_nextcmd(eap->arg);
19637 return;
19641 * ":function /pat": list functions matching pattern.
19643 if (*eap->arg == '/')
19645 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19646 if (!eap->skip)
19648 regmatch_T regmatch;
19650 c = *p;
19651 *p = NUL;
19652 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19653 *p = c;
19654 if (regmatch.regprog != NULL)
19656 regmatch.rm_ic = p_ic;
19658 todo = (int)func_hashtab.ht_used;
19659 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19661 if (!HASHITEM_EMPTY(hi))
19663 --todo;
19664 fp = HI2UF(hi);
19665 if (!isdigit(*fp->uf_name)
19666 && vim_regexec(&regmatch, fp->uf_name, 0))
19667 list_func_head(fp, FALSE);
19672 if (*p == '/')
19673 ++p;
19674 eap->nextcmd = check_nextcmd(p);
19675 return;
19679 * Get the function name. There are these situations:
19680 * func normal function name
19681 * "name" == func, "fudi.fd_dict" == NULL
19682 * dict.func new dictionary entry
19683 * "name" == NULL, "fudi.fd_dict" set,
19684 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19685 * dict.func existing dict entry with a Funcref
19686 * "name" == func, "fudi.fd_dict" set,
19687 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19688 * dict.func existing dict entry that's not a Funcref
19689 * "name" == NULL, "fudi.fd_dict" set,
19690 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19692 p = eap->arg;
19693 name = trans_function_name(&p, eap->skip, 0, &fudi);
19694 paren = (vim_strchr(p, '(') != NULL);
19695 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19698 * Return on an invalid expression in braces, unless the expression
19699 * evaluation has been cancelled due to an aborting error, an
19700 * interrupt, or an exception.
19702 if (!aborting())
19704 if (!eap->skip && fudi.fd_newkey != NULL)
19705 EMSG2(_(e_dictkey), fudi.fd_newkey);
19706 vim_free(fudi.fd_newkey);
19707 return;
19709 else
19710 eap->skip = TRUE;
19713 /* An error in a function call during evaluation of an expression in magic
19714 * braces should not cause the function not to be defined. */
19715 saved_did_emsg = did_emsg;
19716 did_emsg = FALSE;
19719 * ":function func" with only function name: list function.
19721 if (!paren)
19723 if (!ends_excmd(*skipwhite(p)))
19725 EMSG(_(e_trailing));
19726 goto ret_free;
19728 eap->nextcmd = check_nextcmd(p);
19729 if (eap->nextcmd != NULL)
19730 *p = NUL;
19731 if (!eap->skip && !got_int)
19733 fp = find_func(name);
19734 if (fp != NULL)
19736 list_func_head(fp, TRUE);
19737 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19739 if (FUNCLINE(fp, j) == NULL)
19740 continue;
19741 msg_putchar('\n');
19742 msg_outnum((long)(j + 1));
19743 if (j < 9)
19744 msg_putchar(' ');
19745 if (j < 99)
19746 msg_putchar(' ');
19747 msg_prt_line(FUNCLINE(fp, j), FALSE);
19748 out_flush(); /* show a line at a time */
19749 ui_breakcheck();
19751 if (!got_int)
19753 msg_putchar('\n');
19754 msg_puts((char_u *)" endfunction");
19757 else
19758 emsg_funcname("E123: Undefined function: %s", name);
19760 goto ret_free;
19764 * ":function name(arg1, arg2)" Define function.
19766 p = skipwhite(p);
19767 if (*p != '(')
19769 if (!eap->skip)
19771 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19772 goto ret_free;
19774 /* attempt to continue by skipping some text */
19775 if (vim_strchr(p, '(') != NULL)
19776 p = vim_strchr(p, '(');
19778 p = skipwhite(p + 1);
19780 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19781 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19783 if (!eap->skip)
19785 /* Check the name of the function. Unless it's a dictionary function
19786 * (that we are overwriting). */
19787 if (name != NULL)
19788 arg = name;
19789 else
19790 arg = fudi.fd_newkey;
19791 if (arg != NULL && (fudi.fd_di == NULL
19792 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19794 if (*arg == K_SPECIAL)
19795 j = 3;
19796 else
19797 j = 0;
19798 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19799 : eval_isnamec(arg[j])))
19800 ++j;
19801 if (arg[j] != NUL)
19802 emsg_funcname(_(e_invarg2), arg);
19807 * Isolate the arguments: "arg1, arg2, ...)"
19809 while (*p != ')')
19811 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19813 varargs = TRUE;
19814 p += 3;
19815 mustend = TRUE;
19817 else
19819 arg = p;
19820 while (ASCII_ISALNUM(*p) || *p == '_')
19821 ++p;
19822 if (arg == p || isdigit(*arg)
19823 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19824 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19826 if (!eap->skip)
19827 EMSG2(_("E125: Illegal argument: %s"), arg);
19828 break;
19830 if (ga_grow(&newargs, 1) == FAIL)
19831 goto erret;
19832 c = *p;
19833 *p = NUL;
19834 arg = vim_strsave(arg);
19835 if (arg == NULL)
19836 goto erret;
19837 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19838 *p = c;
19839 newargs.ga_len++;
19840 if (*p == ',')
19841 ++p;
19842 else
19843 mustend = TRUE;
19845 p = skipwhite(p);
19846 if (mustend && *p != ')')
19848 if (!eap->skip)
19849 EMSG2(_(e_invarg2), eap->arg);
19850 break;
19853 ++p; /* skip the ')' */
19855 /* find extra arguments "range", "dict" and "abort" */
19856 for (;;)
19858 p = skipwhite(p);
19859 if (STRNCMP(p, "range", 5) == 0)
19861 flags |= FC_RANGE;
19862 p += 5;
19864 else if (STRNCMP(p, "dict", 4) == 0)
19866 flags |= FC_DICT;
19867 p += 4;
19869 else if (STRNCMP(p, "abort", 5) == 0)
19871 flags |= FC_ABORT;
19872 p += 5;
19874 else
19875 break;
19878 /* When there is a line break use what follows for the function body.
19879 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19880 if (*p == '\n')
19881 line_arg = p + 1;
19882 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19883 EMSG(_(e_trailing));
19886 * Read the body of the function, until ":endfunction" is found.
19888 if (KeyTyped)
19890 /* Check if the function already exists, don't let the user type the
19891 * whole function before telling him it doesn't work! For a script we
19892 * need to skip the body to be able to find what follows. */
19893 if (!eap->skip && !eap->forceit)
19895 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19896 EMSG(_(e_funcdict));
19897 else if (name != NULL && find_func(name) != NULL)
19898 emsg_funcname(e_funcexts, name);
19901 if (!eap->skip && did_emsg)
19902 goto erret;
19904 msg_putchar('\n'); /* don't overwrite the function name */
19905 cmdline_row = msg_row;
19908 indent = 2;
19909 nesting = 0;
19910 for (;;)
19912 msg_scroll = TRUE;
19913 need_wait_return = FALSE;
19914 sourcing_lnum_off = sourcing_lnum;
19916 if (line_arg != NULL)
19918 /* Use eap->arg, split up in parts by line breaks. */
19919 theline = line_arg;
19920 p = vim_strchr(theline, '\n');
19921 if (p == NULL)
19922 line_arg += STRLEN(line_arg);
19923 else
19925 *p = NUL;
19926 line_arg = p + 1;
19929 else if (eap->getline == NULL)
19930 theline = getcmdline(':', 0L, indent);
19931 else
19932 theline = eap->getline(':', eap->cookie, indent);
19933 if (KeyTyped)
19934 lines_left = Rows - 1;
19935 if (theline == NULL)
19937 EMSG(_("E126: Missing :endfunction"));
19938 goto erret;
19941 /* Detect line continuation: sourcing_lnum increased more than one. */
19942 if (sourcing_lnum > sourcing_lnum_off + 1)
19943 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
19944 else
19945 sourcing_lnum_off = 0;
19947 if (skip_until != NULL)
19949 /* between ":append" and "." and between ":python <<EOF" and "EOF"
19950 * don't check for ":endfunc". */
19951 if (STRCMP(theline, skip_until) == 0)
19953 vim_free(skip_until);
19954 skip_until = NULL;
19957 else
19959 /* skip ':' and blanks*/
19960 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
19963 /* Check for "endfunction". */
19964 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
19966 if (line_arg == NULL)
19967 vim_free(theline);
19968 break;
19971 /* Increase indent inside "if", "while", "for" and "try", decrease
19972 * at "end". */
19973 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
19974 indent -= 2;
19975 else if (STRNCMP(p, "if", 2) == 0
19976 || STRNCMP(p, "wh", 2) == 0
19977 || STRNCMP(p, "for", 3) == 0
19978 || STRNCMP(p, "try", 3) == 0)
19979 indent += 2;
19981 /* Check for defining a function inside this function. */
19982 if (checkforcmd(&p, "function", 2))
19984 if (*p == '!')
19985 p = skipwhite(p + 1);
19986 p += eval_fname_script(p);
19987 if (ASCII_ISALPHA(*p))
19989 vim_free(trans_function_name(&p, TRUE, 0, NULL));
19990 if (*skipwhite(p) == '(')
19992 ++nesting;
19993 indent += 2;
19998 /* Check for ":append" or ":insert". */
19999 p = skip_range(p, NULL);
20000 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20001 || (p[0] == 'i'
20002 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20003 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20004 skip_until = vim_strsave((char_u *)".");
20006 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20007 arg = skipwhite(skiptowhite(p));
20008 if (arg[0] == '<' && arg[1] =='<'
20009 && ((p[0] == 'p' && p[1] == 'y'
20010 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20011 || (p[0] == 'p' && p[1] == 'e'
20012 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20013 || (p[0] == 't' && p[1] == 'c'
20014 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20015 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20016 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20017 || (p[0] == 'm' && p[1] == 'z'
20018 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20021 /* ":python <<" continues until a dot, like ":append" */
20022 p = skipwhite(arg + 2);
20023 if (*p == NUL)
20024 skip_until = vim_strsave((char_u *)".");
20025 else
20026 skip_until = vim_strsave(p);
20030 /* Add the line to the function. */
20031 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20033 if (line_arg == NULL)
20034 vim_free(theline);
20035 goto erret;
20038 /* Copy the line to newly allocated memory. get_one_sourceline()
20039 * allocates 250 bytes per line, this saves 80% on average. The cost
20040 * is an extra alloc/free. */
20041 p = vim_strsave(theline);
20042 if (p != NULL)
20044 if (line_arg == NULL)
20045 vim_free(theline);
20046 theline = p;
20049 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20051 /* Add NULL lines for continuation lines, so that the line count is
20052 * equal to the index in the growarray. */
20053 while (sourcing_lnum_off-- > 0)
20054 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20056 /* Check for end of eap->arg. */
20057 if (line_arg != NULL && *line_arg == NUL)
20058 line_arg = NULL;
20061 /* Don't define the function when skipping commands or when an error was
20062 * detected. */
20063 if (eap->skip || did_emsg)
20064 goto erret;
20067 * If there are no errors, add the function
20069 if (fudi.fd_dict == NULL)
20071 v = find_var(name, &ht);
20072 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20074 emsg_funcname("E707: Function name conflicts with variable: %s",
20075 name);
20076 goto erret;
20079 fp = find_func(name);
20080 if (fp != NULL)
20082 if (!eap->forceit)
20084 emsg_funcname(e_funcexts, name);
20085 goto erret;
20087 if (fp->uf_calls > 0)
20089 emsg_funcname("E127: Cannot redefine function %s: It is in use",
20090 name);
20091 goto erret;
20093 /* redefine existing function */
20094 ga_clear_strings(&(fp->uf_args));
20095 ga_clear_strings(&(fp->uf_lines));
20096 vim_free(name);
20097 name = NULL;
20100 else
20102 char numbuf[20];
20104 fp = NULL;
20105 if (fudi.fd_newkey == NULL && !eap->forceit)
20107 EMSG(_(e_funcdict));
20108 goto erret;
20110 if (fudi.fd_di == NULL)
20112 /* Can't add a function to a locked dictionary */
20113 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20114 goto erret;
20116 /* Can't change an existing function if it is locked */
20117 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20118 goto erret;
20120 /* Give the function a sequential number. Can only be used with a
20121 * Funcref! */
20122 vim_free(name);
20123 sprintf(numbuf, "%d", ++func_nr);
20124 name = vim_strsave((char_u *)numbuf);
20125 if (name == NULL)
20126 goto erret;
20129 if (fp == NULL)
20131 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20133 int slen, plen;
20134 char_u *scriptname;
20136 /* Check that the autoload name matches the script name. */
20137 j = FAIL;
20138 if (sourcing_name != NULL)
20140 scriptname = autoload_name(name);
20141 if (scriptname != NULL)
20143 p = vim_strchr(scriptname, '/');
20144 plen = (int)STRLEN(p);
20145 slen = (int)STRLEN(sourcing_name);
20146 if (slen > plen && fnamecmp(p,
20147 sourcing_name + slen - plen) == 0)
20148 j = OK;
20149 vim_free(scriptname);
20152 if (j == FAIL)
20154 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20155 goto erret;
20159 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20160 if (fp == NULL)
20161 goto erret;
20163 if (fudi.fd_dict != NULL)
20165 if (fudi.fd_di == NULL)
20167 /* add new dict entry */
20168 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20169 if (fudi.fd_di == NULL)
20171 vim_free(fp);
20172 goto erret;
20174 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20176 vim_free(fudi.fd_di);
20177 vim_free(fp);
20178 goto erret;
20181 else
20182 /* overwrite existing dict entry */
20183 clear_tv(&fudi.fd_di->di_tv);
20184 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20185 fudi.fd_di->di_tv.v_lock = 0;
20186 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20187 fp->uf_refcount = 1;
20189 /* behave like "dict" was used */
20190 flags |= FC_DICT;
20193 /* insert the new function in the function list */
20194 STRCPY(fp->uf_name, name);
20195 hash_add(&func_hashtab, UF2HIKEY(fp));
20197 fp->uf_args = newargs;
20198 fp->uf_lines = newlines;
20199 #ifdef FEAT_PROFILE
20200 fp->uf_tml_count = NULL;
20201 fp->uf_tml_total = NULL;
20202 fp->uf_tml_self = NULL;
20203 fp->uf_profiling = FALSE;
20204 if (prof_def_func())
20205 func_do_profile(fp);
20206 #endif
20207 fp->uf_varargs = varargs;
20208 fp->uf_flags = flags;
20209 fp->uf_calls = 0;
20210 fp->uf_script_ID = current_SID;
20211 goto ret_free;
20213 erret:
20214 ga_clear_strings(&newargs);
20215 ga_clear_strings(&newlines);
20216 ret_free:
20217 vim_free(skip_until);
20218 vim_free(fudi.fd_newkey);
20219 vim_free(name);
20220 did_emsg |= saved_did_emsg;
20224 * Get a function name, translating "<SID>" and "<SNR>".
20225 * Also handles a Funcref in a List or Dictionary.
20226 * Returns the function name in allocated memory, or NULL for failure.
20227 * flags:
20228 * TFN_INT: internal function name OK
20229 * TFN_QUIET: be quiet
20230 * Advances "pp" to just after the function name (if no error).
20232 static char_u *
20233 trans_function_name(pp, skip, flags, fdp)
20234 char_u **pp;
20235 int skip; /* only find the end, don't evaluate */
20236 int flags;
20237 funcdict_T *fdp; /* return: info about dictionary used */
20239 char_u *name = NULL;
20240 char_u *start;
20241 char_u *end;
20242 int lead;
20243 char_u sid_buf[20];
20244 int len;
20245 lval_T lv;
20247 if (fdp != NULL)
20248 vim_memset(fdp, 0, sizeof(funcdict_T));
20249 start = *pp;
20251 /* Check for hard coded <SNR>: already translated function ID (from a user
20252 * command). */
20253 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20254 && (*pp)[2] == (int)KE_SNR)
20256 *pp += 3;
20257 len = get_id_len(pp) + 3;
20258 return vim_strnsave(start, len);
20261 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20262 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20263 lead = eval_fname_script(start);
20264 if (lead > 2)
20265 start += lead;
20267 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20268 lead > 2 ? 0 : FNE_CHECK_START);
20269 if (end == start)
20271 if (!skip)
20272 EMSG(_("E129: Function name required"));
20273 goto theend;
20275 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20278 * Report an invalid expression in braces, unless the expression
20279 * evaluation has been cancelled due to an aborting error, an
20280 * interrupt, or an exception.
20282 if (!aborting())
20284 if (end != NULL)
20285 EMSG2(_(e_invarg2), start);
20287 else
20288 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20289 goto theend;
20292 if (lv.ll_tv != NULL)
20294 if (fdp != NULL)
20296 fdp->fd_dict = lv.ll_dict;
20297 fdp->fd_newkey = lv.ll_newkey;
20298 lv.ll_newkey = NULL;
20299 fdp->fd_di = lv.ll_di;
20301 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20303 name = vim_strsave(lv.ll_tv->vval.v_string);
20304 *pp = end;
20306 else
20308 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20309 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20310 EMSG(_(e_funcref));
20311 else
20312 *pp = end;
20313 name = NULL;
20315 goto theend;
20318 if (lv.ll_name == NULL)
20320 /* Error found, but continue after the function name. */
20321 *pp = end;
20322 goto theend;
20325 /* Check if the name is a Funcref. If so, use the value. */
20326 if (lv.ll_exp_name != NULL)
20328 len = (int)STRLEN(lv.ll_exp_name);
20329 name = deref_func_name(lv.ll_exp_name, &len);
20330 if (name == lv.ll_exp_name)
20331 name = NULL;
20333 else
20335 len = (int)(end - *pp);
20336 name = deref_func_name(*pp, &len);
20337 if (name == *pp)
20338 name = NULL;
20340 if (name != NULL)
20342 name = vim_strsave(name);
20343 *pp = end;
20344 goto theend;
20347 if (lv.ll_exp_name != NULL)
20349 len = (int)STRLEN(lv.ll_exp_name);
20350 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20351 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20353 /* When there was "s:" already or the name expanded to get a
20354 * leading "s:" then remove it. */
20355 lv.ll_name += 2;
20356 len -= 2;
20357 lead = 2;
20360 else
20362 if (lead == 2) /* skip over "s:" */
20363 lv.ll_name += 2;
20364 len = (int)(end - lv.ll_name);
20368 * Copy the function name to allocated memory.
20369 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20370 * Accept <SNR>123_name() outside a script.
20372 if (skip)
20373 lead = 0; /* do nothing */
20374 else if (lead > 0)
20376 lead = 3;
20377 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20378 || eval_fname_sid(*pp))
20380 /* It's "s:" or "<SID>" */
20381 if (current_SID <= 0)
20383 EMSG(_(e_usingsid));
20384 goto theend;
20386 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20387 lead += (int)STRLEN(sid_buf);
20390 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20392 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20393 goto theend;
20395 name = alloc((unsigned)(len + lead + 1));
20396 if (name != NULL)
20398 if (lead > 0)
20400 name[0] = K_SPECIAL;
20401 name[1] = KS_EXTRA;
20402 name[2] = (int)KE_SNR;
20403 if (lead > 3) /* If it's "<SID>" */
20404 STRCPY(name + 3, sid_buf);
20406 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20407 name[len + lead] = NUL;
20409 *pp = end;
20411 theend:
20412 clear_lval(&lv);
20413 return name;
20417 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20418 * Return 2 if "p" starts with "s:".
20419 * Return 0 otherwise.
20421 static int
20422 eval_fname_script(p)
20423 char_u *p;
20425 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20426 || STRNICMP(p + 1, "SNR>", 4) == 0))
20427 return 5;
20428 if (p[0] == 's' && p[1] == ':')
20429 return 2;
20430 return 0;
20434 * Return TRUE if "p" starts with "<SID>" or "s:".
20435 * Only works if eval_fname_script() returned non-zero for "p"!
20437 static int
20438 eval_fname_sid(p)
20439 char_u *p;
20441 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20445 * List the head of the function: "name(arg1, arg2)".
20447 static void
20448 list_func_head(fp, indent)
20449 ufunc_T *fp;
20450 int indent;
20452 int j;
20454 msg_start();
20455 if (indent)
20456 MSG_PUTS(" ");
20457 MSG_PUTS("function ");
20458 if (fp->uf_name[0] == K_SPECIAL)
20460 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20461 msg_puts(fp->uf_name + 3);
20463 else
20464 msg_puts(fp->uf_name);
20465 msg_putchar('(');
20466 for (j = 0; j < fp->uf_args.ga_len; ++j)
20468 if (j)
20469 MSG_PUTS(", ");
20470 msg_puts(FUNCARG(fp, j));
20472 if (fp->uf_varargs)
20474 if (j)
20475 MSG_PUTS(", ");
20476 MSG_PUTS("...");
20478 msg_putchar(')');
20479 msg_clr_eos();
20480 if (p_verbose > 0)
20481 last_set_msg(fp->uf_script_ID);
20485 * Find a function by name, return pointer to it in ufuncs.
20486 * Return NULL for unknown function.
20488 static ufunc_T *
20489 find_func(name)
20490 char_u *name;
20492 hashitem_T *hi;
20494 hi = hash_find(&func_hashtab, name);
20495 if (!HASHITEM_EMPTY(hi))
20496 return HI2UF(hi);
20497 return NULL;
20500 #if defined(EXITFREE) || defined(PROTO)
20501 void
20502 free_all_functions()
20504 hashitem_T *hi;
20506 /* Need to start all over every time, because func_free() may change the
20507 * hash table. */
20508 while (func_hashtab.ht_used > 0)
20509 for (hi = func_hashtab.ht_array; ; ++hi)
20510 if (!HASHITEM_EMPTY(hi))
20512 func_free(HI2UF(hi));
20513 break;
20516 #endif
20519 * Return TRUE if a function "name" exists.
20521 static int
20522 function_exists(name)
20523 char_u *name;
20525 char_u *nm = name;
20526 char_u *p;
20527 int n = FALSE;
20529 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20530 nm = skipwhite(nm);
20532 /* Only accept "funcname", "funcname ", "funcname (..." and
20533 * "funcname(...", not "funcname!...". */
20534 if (p != NULL && (*nm == NUL || *nm == '('))
20536 if (builtin_function(p))
20537 n = (find_internal_func(p) >= 0);
20538 else
20539 n = (find_func(p) != NULL);
20541 vim_free(p);
20542 return n;
20546 * Return TRUE if "name" looks like a builtin function name: starts with a
20547 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20549 static int
20550 builtin_function(name)
20551 char_u *name;
20553 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20554 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20557 #if defined(FEAT_PROFILE) || defined(PROTO)
20559 * Start profiling function "fp".
20561 static void
20562 func_do_profile(fp)
20563 ufunc_T *fp;
20565 fp->uf_tm_count = 0;
20566 profile_zero(&fp->uf_tm_self);
20567 profile_zero(&fp->uf_tm_total);
20568 if (fp->uf_tml_count == NULL)
20569 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20570 (sizeof(int) * fp->uf_lines.ga_len));
20571 if (fp->uf_tml_total == NULL)
20572 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20573 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20574 if (fp->uf_tml_self == NULL)
20575 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20576 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20577 fp->uf_tml_idx = -1;
20578 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20579 || fp->uf_tml_self == NULL)
20580 return; /* out of memory */
20582 fp->uf_profiling = TRUE;
20586 * Dump the profiling results for all functions in file "fd".
20588 void
20589 func_dump_profile(fd)
20590 FILE *fd;
20592 hashitem_T *hi;
20593 int todo;
20594 ufunc_T *fp;
20595 int i;
20596 ufunc_T **sorttab;
20597 int st_len = 0;
20599 todo = (int)func_hashtab.ht_used;
20600 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20602 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20604 if (!HASHITEM_EMPTY(hi))
20606 --todo;
20607 fp = HI2UF(hi);
20608 if (fp->uf_profiling)
20610 if (sorttab != NULL)
20611 sorttab[st_len++] = fp;
20613 if (fp->uf_name[0] == K_SPECIAL)
20614 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20615 else
20616 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20617 if (fp->uf_tm_count == 1)
20618 fprintf(fd, "Called 1 time\n");
20619 else
20620 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20621 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20622 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20623 fprintf(fd, "\n");
20624 fprintf(fd, "count total (s) self (s)\n");
20626 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20628 if (FUNCLINE(fp, i) == NULL)
20629 continue;
20630 prof_func_line(fd, fp->uf_tml_count[i],
20631 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20632 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20634 fprintf(fd, "\n");
20639 if (sorttab != NULL && st_len > 0)
20641 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20642 prof_total_cmp);
20643 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20644 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20645 prof_self_cmp);
20646 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20650 static void
20651 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20652 FILE *fd;
20653 ufunc_T **sorttab;
20654 int st_len;
20655 char *title;
20656 int prefer_self; /* when equal print only self time */
20658 int i;
20659 ufunc_T *fp;
20661 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20662 fprintf(fd, "count total (s) self (s) function\n");
20663 for (i = 0; i < 20 && i < st_len; ++i)
20665 fp = sorttab[i];
20666 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20667 prefer_self);
20668 if (fp->uf_name[0] == K_SPECIAL)
20669 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20670 else
20671 fprintf(fd, " %s()\n", fp->uf_name);
20673 fprintf(fd, "\n");
20677 * Print the count and times for one function or function line.
20679 static void
20680 prof_func_line(fd, count, total, self, prefer_self)
20681 FILE *fd;
20682 int count;
20683 proftime_T *total;
20684 proftime_T *self;
20685 int prefer_self; /* when equal print only self time */
20687 if (count > 0)
20689 fprintf(fd, "%5d ", count);
20690 if (prefer_self && profile_equal(total, self))
20691 fprintf(fd, " ");
20692 else
20693 fprintf(fd, "%s ", profile_msg(total));
20694 if (!prefer_self && profile_equal(total, self))
20695 fprintf(fd, " ");
20696 else
20697 fprintf(fd, "%s ", profile_msg(self));
20699 else
20700 fprintf(fd, " ");
20704 * Compare function for total time sorting.
20706 static int
20707 #ifdef __BORLANDC__
20708 _RTLENTRYF
20709 #endif
20710 prof_total_cmp(s1, s2)
20711 const void *s1;
20712 const void *s2;
20714 ufunc_T *p1, *p2;
20716 p1 = *(ufunc_T **)s1;
20717 p2 = *(ufunc_T **)s2;
20718 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20722 * Compare function for self time sorting.
20724 static int
20725 #ifdef __BORLANDC__
20726 _RTLENTRYF
20727 #endif
20728 prof_self_cmp(s1, s2)
20729 const void *s1;
20730 const void *s2;
20732 ufunc_T *p1, *p2;
20734 p1 = *(ufunc_T **)s1;
20735 p2 = *(ufunc_T **)s2;
20736 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20739 #endif
20742 * If "name" has a package name try autoloading the script for it.
20743 * Return TRUE if a package was loaded.
20745 static int
20746 script_autoload(name, reload)
20747 char_u *name;
20748 int reload; /* load script again when already loaded */
20750 char_u *p;
20751 char_u *scriptname, *tofree;
20752 int ret = FALSE;
20753 int i;
20755 /* If there is no '#' after name[0] there is no package name. */
20756 p = vim_strchr(name, AUTOLOAD_CHAR);
20757 if (p == NULL || p == name)
20758 return FALSE;
20760 tofree = scriptname = autoload_name(name);
20762 /* Find the name in the list of previously loaded package names. Skip
20763 * "autoload/", it's always the same. */
20764 for (i = 0; i < ga_loaded.ga_len; ++i)
20765 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20766 break;
20767 if (!reload && i < ga_loaded.ga_len)
20768 ret = FALSE; /* was loaded already */
20769 else
20771 /* Remember the name if it wasn't loaded already. */
20772 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20774 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20775 tofree = NULL;
20778 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20779 if (source_runtime(scriptname, FALSE) == OK)
20780 ret = TRUE;
20783 vim_free(tofree);
20784 return ret;
20788 * Return the autoload script name for a function or variable name.
20789 * Returns NULL when out of memory.
20791 static char_u *
20792 autoload_name(name)
20793 char_u *name;
20795 char_u *p;
20796 char_u *scriptname;
20798 /* Get the script file name: replace '#' with '/', append ".vim". */
20799 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20800 if (scriptname == NULL)
20801 return FALSE;
20802 STRCPY(scriptname, "autoload/");
20803 STRCAT(scriptname, name);
20804 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20805 STRCAT(scriptname, ".vim");
20806 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20807 *p = '/';
20808 return scriptname;
20811 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20814 * Function given to ExpandGeneric() to obtain the list of user defined
20815 * function names.
20817 char_u *
20818 get_user_func_name(xp, idx)
20819 expand_T *xp;
20820 int idx;
20822 static long_u done;
20823 static hashitem_T *hi;
20824 ufunc_T *fp;
20826 if (idx == 0)
20828 done = 0;
20829 hi = func_hashtab.ht_array;
20831 if (done < func_hashtab.ht_used)
20833 if (done++ > 0)
20834 ++hi;
20835 while (HASHITEM_EMPTY(hi))
20836 ++hi;
20837 fp = HI2UF(hi);
20839 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20840 return fp->uf_name; /* prevents overflow */
20842 cat_func_name(IObuff, fp);
20843 if (xp->xp_context != EXPAND_USER_FUNC)
20845 STRCAT(IObuff, "(");
20846 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20847 STRCAT(IObuff, ")");
20849 return IObuff;
20851 return NULL;
20854 #endif /* FEAT_CMDL_COMPL */
20857 * Copy the function name of "fp" to buffer "buf".
20858 * "buf" must be able to hold the function name plus three bytes.
20859 * Takes care of script-local function names.
20861 static void
20862 cat_func_name(buf, fp)
20863 char_u *buf;
20864 ufunc_T *fp;
20866 if (fp->uf_name[0] == K_SPECIAL)
20868 STRCPY(buf, "<SNR>");
20869 STRCAT(buf, fp->uf_name + 3);
20871 else
20872 STRCPY(buf, fp->uf_name);
20876 * ":delfunction {name}"
20878 void
20879 ex_delfunction(eap)
20880 exarg_T *eap;
20882 ufunc_T *fp = NULL;
20883 char_u *p;
20884 char_u *name;
20885 funcdict_T fudi;
20887 p = eap->arg;
20888 name = trans_function_name(&p, eap->skip, 0, &fudi);
20889 vim_free(fudi.fd_newkey);
20890 if (name == NULL)
20892 if (fudi.fd_dict != NULL && !eap->skip)
20893 EMSG(_(e_funcref));
20894 return;
20896 if (!ends_excmd(*skipwhite(p)))
20898 vim_free(name);
20899 EMSG(_(e_trailing));
20900 return;
20902 eap->nextcmd = check_nextcmd(p);
20903 if (eap->nextcmd != NULL)
20904 *p = NUL;
20906 if (!eap->skip)
20907 fp = find_func(name);
20908 vim_free(name);
20910 if (!eap->skip)
20912 if (fp == NULL)
20914 EMSG2(_(e_nofunc), eap->arg);
20915 return;
20917 if (fp->uf_calls > 0)
20919 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
20920 return;
20923 if (fudi.fd_dict != NULL)
20925 /* Delete the dict item that refers to the function, it will
20926 * invoke func_unref() and possibly delete the function. */
20927 dictitem_remove(fudi.fd_dict, fudi.fd_di);
20929 else
20930 func_free(fp);
20935 * Free a function and remove it from the list of functions.
20937 static void
20938 func_free(fp)
20939 ufunc_T *fp;
20941 hashitem_T *hi;
20943 /* clear this function */
20944 ga_clear_strings(&(fp->uf_args));
20945 ga_clear_strings(&(fp->uf_lines));
20946 #ifdef FEAT_PROFILE
20947 vim_free(fp->uf_tml_count);
20948 vim_free(fp->uf_tml_total);
20949 vim_free(fp->uf_tml_self);
20950 #endif
20952 /* remove the function from the function hashtable */
20953 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
20954 if (HASHITEM_EMPTY(hi))
20955 EMSG2(_(e_intern2), "func_free()");
20956 else
20957 hash_remove(&func_hashtab, hi);
20959 vim_free(fp);
20963 * Unreference a Function: decrement the reference count and free it when it
20964 * becomes zero. Only for numbered functions.
20966 static void
20967 func_unref(name)
20968 char_u *name;
20970 ufunc_T *fp;
20972 if (name != NULL && isdigit(*name))
20974 fp = find_func(name);
20975 if (fp == NULL)
20976 EMSG2(_(e_intern2), "func_unref()");
20977 else if (--fp->uf_refcount <= 0)
20979 /* Only delete it when it's not being used. Otherwise it's done
20980 * when "uf_calls" becomes zero. */
20981 if (fp->uf_calls == 0)
20982 func_free(fp);
20988 * Count a reference to a Function.
20990 static void
20991 func_ref(name)
20992 char_u *name;
20994 ufunc_T *fp;
20996 if (name != NULL && isdigit(*name))
20998 fp = find_func(name);
20999 if (fp == NULL)
21000 EMSG2(_(e_intern2), "func_ref()");
21001 else
21002 ++fp->uf_refcount;
21007 * Call a user function.
21009 static void
21010 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21011 ufunc_T *fp; /* pointer to function */
21012 int argcount; /* nr of args */
21013 typval_T *argvars; /* arguments */
21014 typval_T *rettv; /* return value */
21015 linenr_T firstline; /* first line of range */
21016 linenr_T lastline; /* last line of range */
21017 dict_T *selfdict; /* Dictionary for "self" */
21019 char_u *save_sourcing_name;
21020 linenr_T save_sourcing_lnum;
21021 scid_T save_current_SID;
21022 funccall_T fc;
21023 int save_did_emsg;
21024 static int depth = 0;
21025 dictitem_T *v;
21026 int fixvar_idx = 0; /* index in fixvar[] */
21027 int i;
21028 int ai;
21029 char_u numbuf[NUMBUFLEN];
21030 char_u *name;
21031 #ifdef FEAT_PROFILE
21032 proftime_T wait_start;
21033 proftime_T call_start;
21034 #endif
21036 /* If depth of calling is getting too high, don't execute the function */
21037 if (depth >= p_mfd)
21039 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21040 rettv->v_type = VAR_NUMBER;
21041 rettv->vval.v_number = -1;
21042 return;
21044 ++depth;
21046 line_breakcheck(); /* check for CTRL-C hit */
21048 fc.caller = current_funccal;
21049 current_funccal = &fc;
21050 fc.func = fp;
21051 fc.rettv = rettv;
21052 rettv->vval.v_number = 0;
21053 fc.linenr = 0;
21054 fc.returned = FALSE;
21055 fc.level = ex_nesting_level;
21056 /* Check if this function has a breakpoint. */
21057 fc.breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21058 fc.dbg_tick = debug_tick;
21061 * Note about using fc.fixvar[]: This is an array of FIXVAR_CNT variables
21062 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21063 * each argument variable and saves a lot of time.
21066 * Init l: variables.
21068 init_var_dict(&fc.l_vars, &fc.l_vars_var);
21069 if (selfdict != NULL)
21071 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21072 * some compiler that checks the destination size. */
21073 v = &fc.fixvar[fixvar_idx++].var;
21074 name = v->di_key;
21075 STRCPY(name, "self");
21076 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21077 hash_add(&fc.l_vars.dv_hashtab, DI2HIKEY(v));
21078 v->di_tv.v_type = VAR_DICT;
21079 v->di_tv.v_lock = 0;
21080 v->di_tv.vval.v_dict = selfdict;
21081 ++selfdict->dv_refcount;
21085 * Init a: variables.
21086 * Set a:0 to "argcount".
21087 * Set a:000 to a list with room for the "..." arguments.
21089 init_var_dict(&fc.l_avars, &fc.l_avars_var);
21090 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "0",
21091 (varnumber_T)(argcount - fp->uf_args.ga_len));
21092 v = &fc.fixvar[fixvar_idx++].var;
21093 STRCPY(v->di_key, "000");
21094 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21095 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21096 v->di_tv.v_type = VAR_LIST;
21097 v->di_tv.v_lock = VAR_FIXED;
21098 v->di_tv.vval.v_list = &fc.l_varlist;
21099 vim_memset(&fc.l_varlist, 0, sizeof(list_T));
21100 fc.l_varlist.lv_refcount = 99999;
21101 fc.l_varlist.lv_lock = VAR_FIXED;
21104 * Set a:firstline to "firstline" and a:lastline to "lastline".
21105 * Set a:name to named arguments.
21106 * Set a:N to the "..." arguments.
21108 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "firstline",
21109 (varnumber_T)firstline);
21110 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "lastline",
21111 (varnumber_T)lastline);
21112 for (i = 0; i < argcount; ++i)
21114 ai = i - fp->uf_args.ga_len;
21115 if (ai < 0)
21116 /* named argument a:name */
21117 name = FUNCARG(fp, i);
21118 else
21120 /* "..." argument a:1, a:2, etc. */
21121 sprintf((char *)numbuf, "%d", ai + 1);
21122 name = numbuf;
21124 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21126 v = &fc.fixvar[fixvar_idx++].var;
21127 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21129 else
21131 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21132 + STRLEN(name)));
21133 if (v == NULL)
21134 break;
21135 v->di_flags = DI_FLAGS_RO;
21137 STRCPY(v->di_key, name);
21138 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21140 /* Note: the values are copied directly to avoid alloc/free.
21141 * "argvars" must have VAR_FIXED for v_lock. */
21142 v->di_tv = argvars[i];
21143 v->di_tv.v_lock = VAR_FIXED;
21145 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21147 list_append(&fc.l_varlist, &fc.l_listitems[ai]);
21148 fc.l_listitems[ai].li_tv = argvars[i];
21149 fc.l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21153 /* Don't redraw while executing the function. */
21154 ++RedrawingDisabled;
21155 save_sourcing_name = sourcing_name;
21156 save_sourcing_lnum = sourcing_lnum;
21157 sourcing_lnum = 1;
21158 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21159 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21160 if (sourcing_name != NULL)
21162 if (save_sourcing_name != NULL
21163 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21164 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21165 else
21166 STRCPY(sourcing_name, "function ");
21167 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21169 if (p_verbose >= 12)
21171 ++no_wait_return;
21172 verbose_enter_scroll();
21174 smsg((char_u *)_("calling %s"), sourcing_name);
21175 if (p_verbose >= 14)
21177 char_u buf[MSG_BUF_LEN];
21178 char_u numbuf2[NUMBUFLEN];
21179 char_u *tofree;
21180 char_u *s;
21182 msg_puts((char_u *)"(");
21183 for (i = 0; i < argcount; ++i)
21185 if (i > 0)
21186 msg_puts((char_u *)", ");
21187 if (argvars[i].v_type == VAR_NUMBER)
21188 msg_outnum((long)argvars[i].vval.v_number);
21189 else
21191 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21192 if (s != NULL)
21194 trunc_string(s, buf, MSG_BUF_CLEN);
21195 msg_puts(buf);
21196 vim_free(tofree);
21200 msg_puts((char_u *)")");
21202 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21204 verbose_leave_scroll();
21205 --no_wait_return;
21208 #ifdef FEAT_PROFILE
21209 if (do_profiling == PROF_YES)
21211 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21212 func_do_profile(fp);
21213 if (fp->uf_profiling
21214 || (fc.caller != NULL && &fc.caller->func->uf_profiling))
21216 ++fp->uf_tm_count;
21217 profile_start(&call_start);
21218 profile_zero(&fp->uf_tm_children);
21220 script_prof_save(&wait_start);
21222 #endif
21224 save_current_SID = current_SID;
21225 current_SID = fp->uf_script_ID;
21226 save_did_emsg = did_emsg;
21227 did_emsg = FALSE;
21229 /* call do_cmdline() to execute the lines */
21230 do_cmdline(NULL, get_func_line, (void *)&fc,
21231 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21233 --RedrawingDisabled;
21235 /* when the function was aborted because of an error, return -1 */
21236 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21238 clear_tv(rettv);
21239 rettv->v_type = VAR_NUMBER;
21240 rettv->vval.v_number = -1;
21243 #ifdef FEAT_PROFILE
21244 if (do_profiling == PROF_YES && (fp->uf_profiling
21245 || (fc.caller != NULL && &fc.caller->func->uf_profiling)))
21247 profile_end(&call_start);
21248 profile_sub_wait(&wait_start, &call_start);
21249 profile_add(&fp->uf_tm_total, &call_start);
21250 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21251 if (fc.caller != NULL && &fc.caller->func->uf_profiling)
21253 profile_add(&fc.caller->func->uf_tm_children, &call_start);
21254 profile_add(&fc.caller->func->uf_tml_children, &call_start);
21257 #endif
21259 /* when being verbose, mention the return value */
21260 if (p_verbose >= 12)
21262 ++no_wait_return;
21263 verbose_enter_scroll();
21265 if (aborting())
21266 smsg((char_u *)_("%s aborted"), sourcing_name);
21267 else if (fc.rettv->v_type == VAR_NUMBER)
21268 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21269 (long)fc.rettv->vval.v_number);
21270 else
21272 char_u buf[MSG_BUF_LEN];
21273 char_u numbuf2[NUMBUFLEN];
21274 char_u *tofree;
21275 char_u *s;
21277 /* The value may be very long. Skip the middle part, so that we
21278 * have some idea how it starts and ends. smsg() would always
21279 * truncate it at the end. */
21280 s = tv2string(fc.rettv, &tofree, numbuf2, 0);
21281 if (s != NULL)
21283 trunc_string(s, buf, MSG_BUF_CLEN);
21284 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21285 vim_free(tofree);
21288 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21290 verbose_leave_scroll();
21291 --no_wait_return;
21294 vim_free(sourcing_name);
21295 sourcing_name = save_sourcing_name;
21296 sourcing_lnum = save_sourcing_lnum;
21297 current_SID = save_current_SID;
21298 #ifdef FEAT_PROFILE
21299 if (do_profiling == PROF_YES)
21300 script_prof_restore(&wait_start);
21301 #endif
21303 if (p_verbose >= 12 && sourcing_name != NULL)
21305 ++no_wait_return;
21306 verbose_enter_scroll();
21308 smsg((char_u *)_("continuing in %s"), sourcing_name);
21309 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21311 verbose_leave_scroll();
21312 --no_wait_return;
21315 did_emsg |= save_did_emsg;
21316 current_funccal = fc.caller;
21318 /* The a: variables typevals were not allocated, only free the allocated
21319 * variables. */
21320 vars_clear_ext(&fc.l_avars.dv_hashtab, FALSE);
21322 vars_clear(&fc.l_vars.dv_hashtab); /* free all l: variables */
21323 --depth;
21327 * Add a number variable "name" to dict "dp" with value "nr".
21329 static void
21330 add_nr_var(dp, v, name, nr)
21331 dict_T *dp;
21332 dictitem_T *v;
21333 char *name;
21334 varnumber_T nr;
21336 STRCPY(v->di_key, name);
21337 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21338 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21339 v->di_tv.v_type = VAR_NUMBER;
21340 v->di_tv.v_lock = VAR_FIXED;
21341 v->di_tv.vval.v_number = nr;
21345 * ":return [expr]"
21347 void
21348 ex_return(eap)
21349 exarg_T *eap;
21351 char_u *arg = eap->arg;
21352 typval_T rettv;
21353 int returning = FALSE;
21355 if (current_funccal == NULL)
21357 EMSG(_("E133: :return not inside a function"));
21358 return;
21361 if (eap->skip)
21362 ++emsg_skip;
21364 eap->nextcmd = NULL;
21365 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21366 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21368 if (!eap->skip)
21369 returning = do_return(eap, FALSE, TRUE, &rettv);
21370 else
21371 clear_tv(&rettv);
21373 /* It's safer to return also on error. */
21374 else if (!eap->skip)
21377 * Return unless the expression evaluation has been cancelled due to an
21378 * aborting error, an interrupt, or an exception.
21380 if (!aborting())
21381 returning = do_return(eap, FALSE, TRUE, NULL);
21384 /* When skipping or the return gets pending, advance to the next command
21385 * in this line (!returning). Otherwise, ignore the rest of the line.
21386 * Following lines will be ignored by get_func_line(). */
21387 if (returning)
21388 eap->nextcmd = NULL;
21389 else if (eap->nextcmd == NULL) /* no argument */
21390 eap->nextcmd = check_nextcmd(arg);
21392 if (eap->skip)
21393 --emsg_skip;
21397 * Return from a function. Possibly makes the return pending. Also called
21398 * for a pending return at the ":endtry" or after returning from an extra
21399 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21400 * when called due to a ":return" command. "rettv" may point to a typval_T
21401 * with the return rettv. Returns TRUE when the return can be carried out,
21402 * FALSE when the return gets pending.
21405 do_return(eap, reanimate, is_cmd, rettv)
21406 exarg_T *eap;
21407 int reanimate;
21408 int is_cmd;
21409 void *rettv;
21411 int idx;
21412 struct condstack *cstack = eap->cstack;
21414 if (reanimate)
21415 /* Undo the return. */
21416 current_funccal->returned = FALSE;
21419 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21420 * not in its finally clause (which then is to be executed next) is found.
21421 * In this case, make the ":return" pending for execution at the ":endtry".
21422 * Otherwise, return normally.
21424 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21425 if (idx >= 0)
21427 cstack->cs_pending[idx] = CSTP_RETURN;
21429 if (!is_cmd && !reanimate)
21430 /* A pending return again gets pending. "rettv" points to an
21431 * allocated variable with the rettv of the original ":return"'s
21432 * argument if present or is NULL else. */
21433 cstack->cs_rettv[idx] = rettv;
21434 else
21436 /* When undoing a return in order to make it pending, get the stored
21437 * return rettv. */
21438 if (reanimate)
21439 rettv = current_funccal->rettv;
21441 if (rettv != NULL)
21443 /* Store the value of the pending return. */
21444 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21445 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21446 else
21447 EMSG(_(e_outofmem));
21449 else
21450 cstack->cs_rettv[idx] = NULL;
21452 if (reanimate)
21454 /* The pending return value could be overwritten by a ":return"
21455 * without argument in a finally clause; reset the default
21456 * return value. */
21457 current_funccal->rettv->v_type = VAR_NUMBER;
21458 current_funccal->rettv->vval.v_number = 0;
21461 report_make_pending(CSTP_RETURN, rettv);
21463 else
21465 current_funccal->returned = TRUE;
21467 /* If the return is carried out now, store the return value. For
21468 * a return immediately after reanimation, the value is already
21469 * there. */
21470 if (!reanimate && rettv != NULL)
21472 clear_tv(current_funccal->rettv);
21473 *current_funccal->rettv = *(typval_T *)rettv;
21474 if (!is_cmd)
21475 vim_free(rettv);
21479 return idx < 0;
21483 * Free the variable with a pending return value.
21485 void
21486 discard_pending_return(rettv)
21487 void *rettv;
21489 free_tv((typval_T *)rettv);
21493 * Generate a return command for producing the value of "rettv". The result
21494 * is an allocated string. Used by report_pending() for verbose messages.
21496 char_u *
21497 get_return_cmd(rettv)
21498 void *rettv;
21500 char_u *s = NULL;
21501 char_u *tofree = NULL;
21502 char_u numbuf[NUMBUFLEN];
21504 if (rettv != NULL)
21505 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21506 if (s == NULL)
21507 s = (char_u *)"";
21509 STRCPY(IObuff, ":return ");
21510 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21511 if (STRLEN(s) + 8 >= IOSIZE)
21512 STRCPY(IObuff + IOSIZE - 4, "...");
21513 vim_free(tofree);
21514 return vim_strsave(IObuff);
21518 * Get next function line.
21519 * Called by do_cmdline() to get the next line.
21520 * Returns allocated string, or NULL for end of function.
21522 /* ARGSUSED */
21523 char_u *
21524 get_func_line(c, cookie, indent)
21525 int c; /* not used */
21526 void *cookie;
21527 int indent; /* not used */
21529 funccall_T *fcp = (funccall_T *)cookie;
21530 ufunc_T *fp = fcp->func;
21531 char_u *retval;
21532 garray_T *gap; /* growarray with function lines */
21534 /* If breakpoints have been added/deleted need to check for it. */
21535 if (fcp->dbg_tick != debug_tick)
21537 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21538 sourcing_lnum);
21539 fcp->dbg_tick = debug_tick;
21541 #ifdef FEAT_PROFILE
21542 if (do_profiling == PROF_YES)
21543 func_line_end(cookie);
21544 #endif
21546 gap = &fp->uf_lines;
21547 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21548 || fcp->returned)
21549 retval = NULL;
21550 else
21552 /* Skip NULL lines (continuation lines). */
21553 while (fcp->linenr < gap->ga_len
21554 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21555 ++fcp->linenr;
21556 if (fcp->linenr >= gap->ga_len)
21557 retval = NULL;
21558 else
21560 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21561 sourcing_lnum = fcp->linenr;
21562 #ifdef FEAT_PROFILE
21563 if (do_profiling == PROF_YES)
21564 func_line_start(cookie);
21565 #endif
21569 /* Did we encounter a breakpoint? */
21570 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21572 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21573 /* Find next breakpoint. */
21574 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21575 sourcing_lnum);
21576 fcp->dbg_tick = debug_tick;
21579 return retval;
21582 #if defined(FEAT_PROFILE) || defined(PROTO)
21584 * Called when starting to read a function line.
21585 * "sourcing_lnum" must be correct!
21586 * When skipping lines it may not actually be executed, but we won't find out
21587 * until later and we need to store the time now.
21589 void
21590 func_line_start(cookie)
21591 void *cookie;
21593 funccall_T *fcp = (funccall_T *)cookie;
21594 ufunc_T *fp = fcp->func;
21596 if (fp->uf_profiling && sourcing_lnum >= 1
21597 && sourcing_lnum <= fp->uf_lines.ga_len)
21599 fp->uf_tml_idx = sourcing_lnum - 1;
21600 /* Skip continuation lines. */
21601 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21602 --fp->uf_tml_idx;
21603 fp->uf_tml_execed = FALSE;
21604 profile_start(&fp->uf_tml_start);
21605 profile_zero(&fp->uf_tml_children);
21606 profile_get_wait(&fp->uf_tml_wait);
21611 * Called when actually executing a function line.
21613 void
21614 func_line_exec(cookie)
21615 void *cookie;
21617 funccall_T *fcp = (funccall_T *)cookie;
21618 ufunc_T *fp = fcp->func;
21620 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21621 fp->uf_tml_execed = TRUE;
21625 * Called when done with a function line.
21627 void
21628 func_line_end(cookie)
21629 void *cookie;
21631 funccall_T *fcp = (funccall_T *)cookie;
21632 ufunc_T *fp = fcp->func;
21634 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21636 if (fp->uf_tml_execed)
21638 ++fp->uf_tml_count[fp->uf_tml_idx];
21639 profile_end(&fp->uf_tml_start);
21640 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21641 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21642 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21643 &fp->uf_tml_children);
21645 fp->uf_tml_idx = -1;
21648 #endif
21651 * Return TRUE if the currently active function should be ended, because a
21652 * return was encountered or an error occurred. Used inside a ":while".
21655 func_has_ended(cookie)
21656 void *cookie;
21658 funccall_T *fcp = (funccall_T *)cookie;
21660 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21661 * an error inside a try conditional. */
21662 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21663 || fcp->returned);
21667 * return TRUE if cookie indicates a function which "abort"s on errors.
21670 func_has_abort(cookie)
21671 void *cookie;
21673 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21676 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21677 typedef enum
21679 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21680 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21681 VAR_FLAVOUR_VIMINFO /* all uppercase */
21682 } var_flavour_T;
21684 static var_flavour_T var_flavour __ARGS((char_u *varname));
21686 static var_flavour_T
21687 var_flavour(varname)
21688 char_u *varname;
21690 char_u *p = varname;
21692 if (ASCII_ISUPPER(*p))
21694 while (*(++p))
21695 if (ASCII_ISLOWER(*p))
21696 return VAR_FLAVOUR_SESSION;
21697 return VAR_FLAVOUR_VIMINFO;
21699 else
21700 return VAR_FLAVOUR_DEFAULT;
21702 #endif
21704 #if defined(FEAT_VIMINFO) || defined(PROTO)
21706 * Restore global vars that start with a capital from the viminfo file
21709 read_viminfo_varlist(virp, writing)
21710 vir_T *virp;
21711 int writing;
21713 char_u *tab;
21714 int type = VAR_NUMBER;
21715 typval_T tv;
21717 if (!writing && (find_viminfo_parameter('!') != NULL))
21719 tab = vim_strchr(virp->vir_line + 1, '\t');
21720 if (tab != NULL)
21722 *tab++ = '\0'; /* isolate the variable name */
21723 if (*tab == 'S') /* string var */
21724 type = VAR_STRING;
21725 #ifdef FEAT_FLOAT
21726 else if (*tab == 'F')
21727 type = VAR_FLOAT;
21728 #endif
21730 tab = vim_strchr(tab, '\t');
21731 if (tab != NULL)
21733 tv.v_type = type;
21734 if (type == VAR_STRING)
21735 tv.vval.v_string = viminfo_readstring(virp,
21736 (int)(tab - virp->vir_line + 1), TRUE);
21737 #ifdef FEAT_FLOAT
21738 else if (type == VAR_FLOAT)
21739 (void)string2float(tab + 1, &tv.vval.v_float);
21740 #endif
21741 else
21742 tv.vval.v_number = atol((char *)tab + 1);
21743 set_var(virp->vir_line + 1, &tv, FALSE);
21744 if (type == VAR_STRING)
21745 vim_free(tv.vval.v_string);
21750 return viminfo_readline(virp);
21754 * Write global vars that start with a capital to the viminfo file
21756 void
21757 write_viminfo_varlist(fp)
21758 FILE *fp;
21760 hashitem_T *hi;
21761 dictitem_T *this_var;
21762 int todo;
21763 char *s;
21764 char_u *p;
21765 char_u *tofree;
21766 char_u numbuf[NUMBUFLEN];
21768 if (find_viminfo_parameter('!') == NULL)
21769 return;
21771 fprintf(fp, _("\n# global variables:\n"));
21773 todo = (int)globvarht.ht_used;
21774 for (hi = globvarht.ht_array; todo > 0; ++hi)
21776 if (!HASHITEM_EMPTY(hi))
21778 --todo;
21779 this_var = HI2DI(hi);
21780 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21782 switch (this_var->di_tv.v_type)
21784 case VAR_STRING: s = "STR"; break;
21785 case VAR_NUMBER: s = "NUM"; break;
21786 #ifdef FEAT_FLOAT
21787 case VAR_FLOAT: s = "FLO"; break;
21788 #endif
21789 default: continue;
21791 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21792 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21793 if (p != NULL)
21794 viminfo_writestring(fp, p);
21795 vim_free(tofree);
21800 #endif
21802 #if defined(FEAT_SESSION) || defined(PROTO)
21804 store_session_globals(fd)
21805 FILE *fd;
21807 hashitem_T *hi;
21808 dictitem_T *this_var;
21809 int todo;
21810 char_u *p, *t;
21812 todo = (int)globvarht.ht_used;
21813 for (hi = globvarht.ht_array; todo > 0; ++hi)
21815 if (!HASHITEM_EMPTY(hi))
21817 --todo;
21818 this_var = HI2DI(hi);
21819 if ((this_var->di_tv.v_type == VAR_NUMBER
21820 || this_var->di_tv.v_type == VAR_STRING)
21821 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21823 /* Escape special characters with a backslash. Turn a LF and
21824 * CR into \n and \r. */
21825 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
21826 (char_u *)"\\\"\n\r");
21827 if (p == NULL) /* out of memory */
21828 break;
21829 for (t = p; *t != NUL; ++t)
21830 if (*t == '\n')
21831 *t = 'n';
21832 else if (*t == '\r')
21833 *t = 'r';
21834 if ((fprintf(fd, "let %s = %c%s%c",
21835 this_var->di_key,
21836 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21837 : ' ',
21839 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21840 : ' ') < 0)
21841 || put_eol(fd) == FAIL)
21843 vim_free(p);
21844 return FAIL;
21846 vim_free(p);
21848 #ifdef FEAT_FLOAT
21849 else if (this_var->di_tv.v_type == VAR_FLOAT
21850 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21852 float_T f = this_var->di_tv.vval.v_float;
21853 int sign = ' ';
21855 if (f < 0)
21857 f = -f;
21858 sign = '-';
21860 if ((fprintf(fd, "let %s = %c&%f",
21861 this_var->di_key, sign, f) < 0)
21862 || put_eol(fd) == FAIL)
21863 return FAIL;
21865 #endif
21868 return OK;
21870 #endif
21873 * Display script name where an item was last set.
21874 * Should only be invoked when 'verbose' is non-zero.
21876 void
21877 last_set_msg(scriptID)
21878 scid_T scriptID;
21880 char_u *p;
21882 if (scriptID != 0)
21884 p = home_replace_save(NULL, get_scriptname(scriptID));
21885 if (p != NULL)
21887 verbose_enter();
21888 MSG_PUTS(_("\n\tLast set from "));
21889 MSG_PUTS(p);
21890 vim_free(p);
21891 verbose_leave();
21896 #endif /* FEAT_EVAL */
21899 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
21901 #ifdef WIN3264
21903 * Functions for ":8" filename modifier: get 8.3 version of a filename.
21905 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
21906 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
21907 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
21910 * Get the short path (8.3) for the filename in "fnamep".
21911 * Only works for a valid file name.
21912 * When the path gets longer "fnamep" is changed and the allocated buffer
21913 * is put in "bufp".
21914 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
21915 * Returns OK on success, FAIL on failure.
21917 static int
21918 get_short_pathname(fnamep, bufp, fnamelen)
21919 char_u **fnamep;
21920 char_u **bufp;
21921 int *fnamelen;
21923 int l, len;
21924 char_u *newbuf;
21926 len = *fnamelen;
21927 l = GetShortPathName(*fnamep, *fnamep, len);
21928 if (l > len - 1)
21930 /* If that doesn't work (not enough space), then save the string
21931 * and try again with a new buffer big enough. */
21932 newbuf = vim_strnsave(*fnamep, l);
21933 if (newbuf == NULL)
21934 return FAIL;
21936 vim_free(*bufp);
21937 *fnamep = *bufp = newbuf;
21939 /* Really should always succeed, as the buffer is big enough. */
21940 l = GetShortPathName(*fnamep, *fnamep, l+1);
21943 *fnamelen = l;
21944 return OK;
21948 * Get the short path (8.3) for the filename in "fname". The converted
21949 * path is returned in "bufp".
21951 * Some of the directories specified in "fname" may not exist. This function
21952 * will shorten the existing directories at the beginning of the path and then
21953 * append the remaining non-existing path.
21955 * fname - Pointer to the filename to shorten. On return, contains the
21956 * pointer to the shortened pathname
21957 * bufp - Pointer to an allocated buffer for the filename.
21958 * fnamelen - Length of the filename pointed to by fname
21960 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
21962 static int
21963 shortpath_for_invalid_fname(fname, bufp, fnamelen)
21964 char_u **fname;
21965 char_u **bufp;
21966 int *fnamelen;
21968 char_u *short_fname, *save_fname, *pbuf_unused;
21969 char_u *endp, *save_endp;
21970 char_u ch;
21971 int old_len, len;
21972 int new_len, sfx_len;
21973 int retval = OK;
21975 /* Make a copy */
21976 old_len = *fnamelen;
21977 save_fname = vim_strnsave(*fname, old_len);
21978 pbuf_unused = NULL;
21979 short_fname = NULL;
21981 endp = save_fname + old_len - 1; /* Find the end of the copy */
21982 save_endp = endp;
21985 * Try shortening the supplied path till it succeeds by removing one
21986 * directory at a time from the tail of the path.
21988 len = 0;
21989 for (;;)
21991 /* go back one path-separator */
21992 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
21993 --endp;
21994 if (endp <= save_fname)
21995 break; /* processed the complete path */
21998 * Replace the path separator with a NUL and try to shorten the
21999 * resulting path.
22001 ch = *endp;
22002 *endp = 0;
22003 short_fname = save_fname;
22004 len = (int)STRLEN(short_fname) + 1;
22005 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22007 retval = FAIL;
22008 goto theend;
22010 *endp = ch; /* preserve the string */
22012 if (len > 0)
22013 break; /* successfully shortened the path */
22015 /* failed to shorten the path. Skip the path separator */
22016 --endp;
22019 if (len > 0)
22022 * Succeeded in shortening the path. Now concatenate the shortened
22023 * path with the remaining path at the tail.
22026 /* Compute the length of the new path. */
22027 sfx_len = (int)(save_endp - endp) + 1;
22028 new_len = len + sfx_len;
22030 *fnamelen = new_len;
22031 vim_free(*bufp);
22032 if (new_len > old_len)
22034 /* There is not enough space in the currently allocated string,
22035 * copy it to a buffer big enough. */
22036 *fname = *bufp = vim_strnsave(short_fname, new_len);
22037 if (*fname == NULL)
22039 retval = FAIL;
22040 goto theend;
22043 else
22045 /* Transfer short_fname to the main buffer (it's big enough),
22046 * unless get_short_pathname() did its work in-place. */
22047 *fname = *bufp = save_fname;
22048 if (short_fname != save_fname)
22049 vim_strncpy(save_fname, short_fname, len);
22050 save_fname = NULL;
22053 /* concat the not-shortened part of the path */
22054 vim_strncpy(*fname + len, endp, sfx_len);
22055 (*fname)[new_len] = NUL;
22058 theend:
22059 vim_free(pbuf_unused);
22060 vim_free(save_fname);
22062 return retval;
22066 * Get a pathname for a partial path.
22067 * Returns OK for success, FAIL for failure.
22069 static int
22070 shortpath_for_partial(fnamep, bufp, fnamelen)
22071 char_u **fnamep;
22072 char_u **bufp;
22073 int *fnamelen;
22075 int sepcount, len, tflen;
22076 char_u *p;
22077 char_u *pbuf, *tfname;
22078 int hasTilde;
22080 /* Count up the path separators from the RHS.. so we know which part
22081 * of the path to return. */
22082 sepcount = 0;
22083 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22084 if (vim_ispathsep(*p))
22085 ++sepcount;
22087 /* Need full path first (use expand_env() to remove a "~/") */
22088 hasTilde = (**fnamep == '~');
22089 if (hasTilde)
22090 pbuf = tfname = expand_env_save(*fnamep);
22091 else
22092 pbuf = tfname = FullName_save(*fnamep, FALSE);
22094 len = tflen = (int)STRLEN(tfname);
22096 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22097 return FAIL;
22099 if (len == 0)
22101 /* Don't have a valid filename, so shorten the rest of the
22102 * path if we can. This CAN give us invalid 8.3 filenames, but
22103 * there's not a lot of point in guessing what it might be.
22105 len = tflen;
22106 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22107 return FAIL;
22110 /* Count the paths backward to find the beginning of the desired string. */
22111 for (p = tfname + len - 1; p >= tfname; --p)
22113 #ifdef FEAT_MBYTE
22114 if (has_mbyte)
22115 p -= mb_head_off(tfname, p);
22116 #endif
22117 if (vim_ispathsep(*p))
22119 if (sepcount == 0 || (hasTilde && sepcount == 1))
22120 break;
22121 else
22122 sepcount --;
22125 if (hasTilde)
22127 --p;
22128 if (p >= tfname)
22129 *p = '~';
22130 else
22131 return FAIL;
22133 else
22134 ++p;
22136 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22137 vim_free(*bufp);
22138 *fnamelen = (int)STRLEN(p);
22139 *bufp = pbuf;
22140 *fnamep = p;
22142 return OK;
22144 #endif /* WIN3264 */
22147 * Adjust a filename, according to a string of modifiers.
22148 * *fnamep must be NUL terminated when called. When returning, the length is
22149 * determined by *fnamelen.
22150 * Returns VALID_ flags or -1 for failure.
22151 * When there is an error, *fnamep is set to NULL.
22154 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22155 char_u *src; /* string with modifiers */
22156 int *usedlen; /* characters after src that are used */
22157 char_u **fnamep; /* file name so far */
22158 char_u **bufp; /* buffer for allocated file name or NULL */
22159 int *fnamelen; /* length of fnamep */
22161 int valid = 0;
22162 char_u *tail;
22163 char_u *s, *p, *pbuf;
22164 char_u dirname[MAXPATHL];
22165 int c;
22166 int has_fullname = 0;
22167 #ifdef WIN3264
22168 int has_shortname = 0;
22169 #endif
22171 repeat:
22172 /* ":p" - full path/file_name */
22173 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22175 has_fullname = 1;
22177 valid |= VALID_PATH;
22178 *usedlen += 2;
22180 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22181 if ((*fnamep)[0] == '~'
22182 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22183 && ((*fnamep)[1] == '/'
22184 # ifdef BACKSLASH_IN_FILENAME
22185 || (*fnamep)[1] == '\\'
22186 # endif
22187 || (*fnamep)[1] == NUL)
22189 #endif
22192 *fnamep = expand_env_save(*fnamep);
22193 vim_free(*bufp); /* free any allocated file name */
22194 *bufp = *fnamep;
22195 if (*fnamep == NULL)
22196 return -1;
22199 /* When "/." or "/.." is used: force expansion to get rid of it. */
22200 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22202 if (vim_ispathsep(*p)
22203 && p[1] == '.'
22204 && (p[2] == NUL
22205 || vim_ispathsep(p[2])
22206 || (p[2] == '.'
22207 && (p[3] == NUL || vim_ispathsep(p[3])))))
22208 break;
22211 /* FullName_save() is slow, don't use it when not needed. */
22212 if (*p != NUL || !vim_isAbsName(*fnamep))
22214 *fnamep = FullName_save(*fnamep, *p != NUL);
22215 vim_free(*bufp); /* free any allocated file name */
22216 *bufp = *fnamep;
22217 if (*fnamep == NULL)
22218 return -1;
22221 /* Append a path separator to a directory. */
22222 if (mch_isdir(*fnamep))
22224 /* Make room for one or two extra characters. */
22225 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22226 vim_free(*bufp); /* free any allocated file name */
22227 *bufp = *fnamep;
22228 if (*fnamep == NULL)
22229 return -1;
22230 add_pathsep(*fnamep);
22234 /* ":." - path relative to the current directory */
22235 /* ":~" - path relative to the home directory */
22236 /* ":8" - shortname path - postponed till after */
22237 while (src[*usedlen] == ':'
22238 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22240 *usedlen += 2;
22241 if (c == '8')
22243 #ifdef WIN3264
22244 has_shortname = 1; /* Postpone this. */
22245 #endif
22246 continue;
22248 pbuf = NULL;
22249 /* Need full path first (use expand_env() to remove a "~/") */
22250 if (!has_fullname)
22252 if (c == '.' && **fnamep == '~')
22253 p = pbuf = expand_env_save(*fnamep);
22254 else
22255 p = pbuf = FullName_save(*fnamep, FALSE);
22257 else
22258 p = *fnamep;
22260 has_fullname = 0;
22262 if (p != NULL)
22264 if (c == '.')
22266 mch_dirname(dirname, MAXPATHL);
22267 s = shorten_fname(p, dirname);
22268 if (s != NULL)
22270 *fnamep = s;
22271 if (pbuf != NULL)
22273 vim_free(*bufp); /* free any allocated file name */
22274 *bufp = pbuf;
22275 pbuf = NULL;
22279 else
22281 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22282 /* Only replace it when it starts with '~' */
22283 if (*dirname == '~')
22285 s = vim_strsave(dirname);
22286 if (s != NULL)
22288 *fnamep = s;
22289 vim_free(*bufp);
22290 *bufp = s;
22294 vim_free(pbuf);
22298 tail = gettail(*fnamep);
22299 *fnamelen = (int)STRLEN(*fnamep);
22301 /* ":h" - head, remove "/file_name", can be repeated */
22302 /* Don't remove the first "/" or "c:\" */
22303 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22305 valid |= VALID_HEAD;
22306 *usedlen += 2;
22307 s = get_past_head(*fnamep);
22308 while (tail > s && after_pathsep(s, tail))
22309 mb_ptr_back(*fnamep, tail);
22310 *fnamelen = (int)(tail - *fnamep);
22311 #ifdef VMS
22312 if (*fnamelen > 0)
22313 *fnamelen += 1; /* the path separator is part of the path */
22314 #endif
22315 if (*fnamelen == 0)
22317 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22318 p = vim_strsave((char_u *)".");
22319 if (p == NULL)
22320 return -1;
22321 vim_free(*bufp);
22322 *bufp = *fnamep = tail = p;
22323 *fnamelen = 1;
22325 else
22327 while (tail > s && !after_pathsep(s, tail))
22328 mb_ptr_back(*fnamep, tail);
22332 /* ":8" - shortname */
22333 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22335 *usedlen += 2;
22336 #ifdef WIN3264
22337 has_shortname = 1;
22338 #endif
22341 #ifdef WIN3264
22342 /* Check shortname after we have done 'heads' and before we do 'tails'
22344 if (has_shortname)
22346 pbuf = NULL;
22347 /* Copy the string if it is shortened by :h */
22348 if (*fnamelen < (int)STRLEN(*fnamep))
22350 p = vim_strnsave(*fnamep, *fnamelen);
22351 if (p == 0)
22352 return -1;
22353 vim_free(*bufp);
22354 *bufp = *fnamep = p;
22357 /* Split into two implementations - makes it easier. First is where
22358 * there isn't a full name already, second is where there is.
22360 if (!has_fullname && !vim_isAbsName(*fnamep))
22362 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22363 return -1;
22365 else
22367 int l;
22369 /* Simple case, already have the full-name
22370 * Nearly always shorter, so try first time. */
22371 l = *fnamelen;
22372 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22373 return -1;
22375 if (l == 0)
22377 /* Couldn't find the filename.. search the paths.
22379 l = *fnamelen;
22380 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22381 return -1;
22383 *fnamelen = l;
22386 #endif /* WIN3264 */
22388 /* ":t" - tail, just the basename */
22389 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22391 *usedlen += 2;
22392 *fnamelen -= (int)(tail - *fnamep);
22393 *fnamep = tail;
22396 /* ":e" - extension, can be repeated */
22397 /* ":r" - root, without extension, can be repeated */
22398 while (src[*usedlen] == ':'
22399 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22401 /* find a '.' in the tail:
22402 * - for second :e: before the current fname
22403 * - otherwise: The last '.'
22405 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22406 s = *fnamep - 2;
22407 else
22408 s = *fnamep + *fnamelen - 1;
22409 for ( ; s > tail; --s)
22410 if (s[0] == '.')
22411 break;
22412 if (src[*usedlen + 1] == 'e') /* :e */
22414 if (s > tail)
22416 *fnamelen += (int)(*fnamep - (s + 1));
22417 *fnamep = s + 1;
22418 #ifdef VMS
22419 /* cut version from the extension */
22420 s = *fnamep + *fnamelen - 1;
22421 for ( ; s > *fnamep; --s)
22422 if (s[0] == ';')
22423 break;
22424 if (s > *fnamep)
22425 *fnamelen = s - *fnamep;
22426 #endif
22428 else if (*fnamep <= tail)
22429 *fnamelen = 0;
22431 else /* :r */
22433 if (s > tail) /* remove one extension */
22434 *fnamelen = (int)(s - *fnamep);
22436 *usedlen += 2;
22439 /* ":s?pat?foo?" - substitute */
22440 /* ":gs?pat?foo?" - global substitute */
22441 if (src[*usedlen] == ':'
22442 && (src[*usedlen + 1] == 's'
22443 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22445 char_u *str;
22446 char_u *pat;
22447 char_u *sub;
22448 int sep;
22449 char_u *flags;
22450 int didit = FALSE;
22452 flags = (char_u *)"";
22453 s = src + *usedlen + 2;
22454 if (src[*usedlen + 1] == 'g')
22456 flags = (char_u *)"g";
22457 ++s;
22460 sep = *s++;
22461 if (sep)
22463 /* find end of pattern */
22464 p = vim_strchr(s, sep);
22465 if (p != NULL)
22467 pat = vim_strnsave(s, (int)(p - s));
22468 if (pat != NULL)
22470 s = p + 1;
22471 /* find end of substitution */
22472 p = vim_strchr(s, sep);
22473 if (p != NULL)
22475 sub = vim_strnsave(s, (int)(p - s));
22476 str = vim_strnsave(*fnamep, *fnamelen);
22477 if (sub != NULL && str != NULL)
22479 *usedlen = (int)(p + 1 - src);
22480 s = do_string_sub(str, pat, sub, flags);
22481 if (s != NULL)
22483 *fnamep = s;
22484 *fnamelen = (int)STRLEN(s);
22485 vim_free(*bufp);
22486 *bufp = s;
22487 didit = TRUE;
22490 vim_free(sub);
22491 vim_free(str);
22493 vim_free(pat);
22496 /* after using ":s", repeat all the modifiers */
22497 if (didit)
22498 goto repeat;
22502 return valid;
22506 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22507 * "flags" can be "g" to do a global substitute.
22508 * Returns an allocated string, NULL for error.
22510 char_u *
22511 do_string_sub(str, pat, sub, flags)
22512 char_u *str;
22513 char_u *pat;
22514 char_u *sub;
22515 char_u *flags;
22517 int sublen;
22518 regmatch_T regmatch;
22519 int i;
22520 int do_all;
22521 char_u *tail;
22522 garray_T ga;
22523 char_u *ret;
22524 char_u *save_cpo;
22526 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22527 save_cpo = p_cpo;
22528 p_cpo = empty_option;
22530 ga_init2(&ga, 1, 200);
22532 do_all = (flags[0] == 'g');
22534 regmatch.rm_ic = p_ic;
22535 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22536 if (regmatch.regprog != NULL)
22538 tail = str;
22539 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22542 * Get some space for a temporary buffer to do the substitution
22543 * into. It will contain:
22544 * - The text up to where the match is.
22545 * - The substituted text.
22546 * - The text after the match.
22548 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22549 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22550 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22552 ga_clear(&ga);
22553 break;
22556 /* copy the text up to where the match is */
22557 i = (int)(regmatch.startp[0] - tail);
22558 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22559 /* add the substituted text */
22560 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22561 + ga.ga_len + i, TRUE, TRUE, FALSE);
22562 ga.ga_len += i + sublen - 1;
22563 /* avoid getting stuck on a match with an empty string */
22564 if (tail == regmatch.endp[0])
22566 if (*tail == NUL)
22567 break;
22568 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22569 ++ga.ga_len;
22571 else
22573 tail = regmatch.endp[0];
22574 if (*tail == NUL)
22575 break;
22577 if (!do_all)
22578 break;
22581 if (ga.ga_data != NULL)
22582 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22584 vim_free(regmatch.regprog);
22587 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22588 ga_clear(&ga);
22589 if (p_cpo == empty_option)
22590 p_cpo = save_cpo;
22591 else
22592 /* Darn, evaluating {sub} expression changed the value. */
22593 free_string_option(save_cpo);
22595 return ret;
22598 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */